sqlite3-binding.c 6.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997155998155999156000156001156002156003156004156005156006156007156008156009156010156011156012156013156014156015156016156017156018156019156020156021156022156023156024156025156026156027156028156029156030156031156032156033156034156035156036156037156038156039156040156041156042156043156044156045156046156047156048156049156050156051156052156053156054156055156056156057156058156059156060156061156062156063156064156065156066156067156068156069156070156071156072156073156074156075156076156077156078156079156080156081156082156083156084156085156086156087156088156089156090156091156092156093156094156095156096156097156098156099156100156101156102156103156104156105156106156107156108156109156110156111156112156113156114156115156116156117156118156119156120156121156122156123156124156125156126156127156128156129156130156131156132156133156134156135156136156137156138156139156140156141156142156143156144156145156146156147156148156149156150156151156152156153156154156155156156156157156158156159156160156161156162156163156164156165156166156167156168156169156170156171156172156173156174156175156176156177156178156179156180156181156182156183156184156185156186156187156188156189156190156191156192156193156194156195156196156197156198156199156200156201156202156203156204156205156206156207156208156209156210156211156212156213156214156215156216156217156218156219156220156221156222156223156224156225156226156227156228156229156230156231156232156233156234156235156236156237156238156239156240156241156242156243156244156245156246156247156248156249156250156251156252156253156254156255156256156257156258156259156260156261156262156263156264156265156266156267156268156269156270156271156272156273156274156275156276156277156278156279156280156281156282156283156284156285156286156287156288156289156290156291156292156293156294156295156296156297156298156299156300156301156302156303156304156305156306156307156308156309156310156311156312156313156314156315156316156317156318156319156320156321156322156323156324156325156326156327156328156329156330156331156332156333156334156335156336156337156338156339156340156341156342156343156344156345156346156347156348156349156350156351156352156353156354156355156356156357156358156359156360156361156362156363156364156365156366156367156368156369156370156371156372156373156374156375156376156377156378156379156380156381156382156383156384156385156386156387156388156389156390156391156392156393156394156395156396156397156398156399156400156401156402156403156404156405156406156407156408156409156410156411156412156413156414156415156416156417156418156419156420156421156422156423156424156425156426156427156428156429156430156431156432156433156434156435156436156437156438156439156440156441156442156443156444156445156446156447156448156449156450156451156452156453156454156455156456156457156458156459156460156461156462156463156464156465156466156467156468156469156470156471156472156473156474156475156476156477156478156479156480156481156482156483156484156485156486156487156488156489156490156491156492156493156494156495156496156497156498156499156500156501156502156503156504156505156506156507156508156509156510156511156512156513156514156515156516156517156518156519156520156521156522156523156524156525156526156527156528156529156530156531156532156533156534156535156536156537156538156539156540156541156542156543156544156545156546156547156548156549156550156551156552156553156554156555156556156557156558156559156560156561156562156563156564156565156566156567156568156569156570156571156572156573156574156575156576156577156578156579156580156581156582156583156584156585156586156587156588156589156590156591156592156593156594156595156596156597156598156599156600156601156602156603156604156605156606156607156608156609156610156611156612156613156614156615156616156617156618156619156620156621156622156623156624156625156626156627156628156629156630156631156632156633156634156635156636156637156638156639156640156641156642156643156644156645156646156647156648156649156650156651156652156653156654156655156656156657156658156659156660156661156662156663156664156665156666156667156668156669156670156671156672156673156674156675156676156677156678156679156680156681156682156683156684156685156686156687156688156689156690156691156692156693156694156695156696156697156698156699156700156701156702156703156704156705156706156707156708156709156710156711156712156713156714156715156716156717156718156719156720156721156722156723156724156725156726156727156728156729156730156731156732156733156734156735156736156737156738156739156740156741156742156743156744156745156746156747156748156749156750156751156752156753156754156755156756156757156758156759156760156761156762156763156764156765156766156767156768156769156770156771156772156773156774156775156776156777156778156779156780156781156782156783156784156785156786156787156788156789156790156791156792156793156794156795156796156797156798156799156800156801156802156803156804156805156806156807156808156809156810156811156812156813156814156815156816156817156818156819156820156821156822156823156824156825156826156827156828156829156830156831156832156833156834156835156836156837156838156839156840156841156842156843156844156845156846156847156848156849156850156851156852156853156854156855156856156857156858156859156860156861156862156863156864156865156866156867156868156869156870156871156872156873156874156875156876156877156878156879156880156881156882156883156884156885156886156887156888156889156890156891156892156893156894156895156896156897156898156899156900156901156902156903156904156905156906156907156908156909156910156911156912156913156914156915156916156917156918156919156920156921156922156923156924156925156926156927156928156929156930156931156932156933156934156935156936156937156938156939156940156941156942156943156944156945156946156947156948156949156950156951156952156953156954156955156956156957156958156959156960156961156962156963156964156965156966156967156968156969156970156971156972156973156974156975156976156977156978156979156980156981156982156983156984156985156986156987156988156989156990156991156992156993156994156995156996156997156998156999157000157001157002157003157004157005157006157007157008157009157010157011157012157013157014157015157016157017157018157019157020157021157022157023157024157025157026157027157028157029157030157031157032157033157034157035157036157037157038157039157040157041157042157043157044157045157046157047157048157049157050157051157052157053157054157055157056157057157058157059157060157061157062157063157064157065157066157067157068157069157070157071157072157073157074157075157076157077157078157079157080157081157082157083157084157085157086157087157088157089157090157091157092157093157094157095157096157097157098157099157100157101157102157103157104157105157106157107157108157109157110157111157112157113157114157115157116157117157118157119157120157121157122157123157124157125157126157127157128157129157130157131157132157133157134157135157136157137157138157139157140157141157142157143157144157145157146157147157148157149157150157151157152157153157154157155157156157157157158157159157160157161157162157163157164157165157166157167157168157169157170157171157172157173157174157175157176157177157178157179157180157181157182157183157184157185157186157187157188157189157190157191157192157193157194157195157196157197157198157199157200157201157202157203157204157205157206157207157208157209157210157211157212157213157214157215157216157217157218157219157220157221157222157223157224157225157226157227157228157229157230157231157232157233157234157235157236157237157238157239157240157241157242157243157244157245157246157247157248157249157250157251157252157253157254157255157256157257157258157259157260157261157262157263157264157265157266157267157268157269157270157271157272157273157274157275157276157277157278157279157280157281157282157283157284157285157286157287157288157289157290157291157292157293157294157295157296157297157298157299157300157301157302157303157304157305157306157307157308157309157310157311157312157313157314157315157316157317157318157319157320157321157322157323157324157325157326157327157328157329157330157331157332157333157334157335157336157337157338157339157340157341157342157343157344157345157346157347157348157349157350157351157352157353157354157355157356157357157358157359157360157361157362157363157364157365157366157367157368157369157370157371157372157373157374157375157376157377157378157379157380157381157382157383157384157385157386157387157388157389157390157391157392157393157394157395157396157397157398157399157400157401157402157403157404157405157406157407157408157409157410157411157412157413157414157415157416157417157418157419157420157421157422157423157424157425157426157427157428157429157430157431157432157433157434157435157436157437157438157439157440157441157442157443157444157445157446157447157448157449157450157451157452157453157454157455157456157457157458157459157460157461157462157463157464157465157466157467157468157469157470157471157472157473157474157475157476157477157478157479157480157481157482157483157484157485157486157487157488157489157490157491157492157493157494157495157496157497157498157499157500157501157502157503157504157505157506157507157508157509157510157511157512157513157514157515157516157517157518157519157520157521157522157523157524157525157526157527157528157529157530157531157532157533157534157535157536157537157538157539157540157541157542157543157544157545157546157547157548157549157550157551157552157553157554157555157556157557157558157559157560157561157562157563157564157565157566157567157568157569157570157571157572157573157574157575157576157577157578157579157580157581157582157583157584157585157586157587157588157589157590157591157592157593157594157595157596157597157598157599157600157601157602157603157604157605157606157607157608157609157610157611157612157613157614157615157616157617157618157619157620157621157622157623157624157625157626157627157628157629157630157631157632157633157634157635157636157637157638157639157640157641157642157643157644157645157646157647157648157649157650157651157652157653157654157655157656157657157658157659157660157661157662157663157664157665157666157667157668157669157670157671157672157673157674157675157676157677157678157679157680157681157682157683157684157685157686157687157688157689157690157691157692157693157694157695157696157697157698157699157700157701157702157703157704157705157706157707157708157709157710157711157712157713157714157715157716157717157718157719157720157721157722157723157724157725157726157727157728157729157730157731157732157733157734157735157736157737157738157739157740157741157742157743157744157745157746157747157748157749157750157751157752157753157754157755157756157757157758157759157760157761157762157763157764157765157766157767157768157769157770157771157772157773157774157775157776157777157778157779157780157781157782157783157784157785157786157787157788157789157790157791157792157793157794157795157796157797157798157799157800157801157802157803157804157805157806157807157808157809157810157811157812157813157814157815157816157817157818157819157820157821157822157823157824157825157826157827157828157829157830157831157832157833157834157835157836157837157838157839157840157841157842157843157844157845157846157847157848157849157850157851157852157853157854157855157856157857157858157859157860157861157862157863157864157865157866157867157868157869157870157871157872157873157874157875157876157877157878157879157880157881157882157883157884157885157886157887157888157889157890157891157892157893157894157895157896157897157898157899157900157901157902157903157904157905157906157907157908157909157910157911157912157913157914157915157916157917157918157919157920157921157922157923157924157925157926157927157928157929157930157931157932157933157934157935157936157937157938157939157940157941157942157943157944157945157946157947157948157949157950157951157952157953157954157955157956157957157958157959157960157961157962157963157964157965157966157967157968157969157970157971157972157973157974157975157976157977157978157979157980157981157982157983157984157985157986157987157988157989157990157991157992157993157994157995157996157997157998157999158000158001158002158003158004158005158006158007158008158009158010158011158012158013158014158015158016158017158018158019158020158021158022158023158024158025158026158027158028158029158030158031158032158033158034158035158036158037158038158039158040158041158042158043158044158045158046158047158048158049158050158051158052158053158054158055158056158057158058158059158060158061158062158063158064158065158066158067158068158069158070158071158072158073158074158075158076158077158078158079158080158081158082158083158084158085158086158087158088158089158090158091158092158093158094158095158096158097158098158099158100158101158102158103158104158105158106158107158108158109158110158111158112158113158114158115158116158117158118158119158120158121158122158123158124158125158126158127158128158129158130158131158132158133158134158135158136158137158138158139158140158141158142158143158144158145158146158147158148158149158150158151158152158153158154158155158156158157158158158159158160158161158162158163158164158165158166158167158168158169158170158171158172158173158174158175158176158177158178158179158180158181158182158183158184158185158186158187158188158189158190158191158192158193158194158195158196158197158198158199158200158201158202158203158204158205158206158207158208158209158210158211158212158213158214158215158216158217158218158219158220158221158222158223158224158225158226158227158228158229158230158231158232158233158234158235158236158237158238158239158240158241158242158243158244158245158246158247158248158249158250158251158252158253158254158255158256158257158258158259158260158261158262158263158264158265158266158267158268158269158270158271158272158273158274158275158276158277158278158279158280158281158282158283158284158285158286158287158288158289158290158291158292158293158294158295158296158297158298158299158300158301158302158303158304158305158306158307158308158309158310158311158312158313158314158315158316158317158318158319158320158321158322158323158324158325158326158327158328158329158330158331158332158333158334158335158336158337158338158339158340158341158342158343158344158345158346158347158348158349158350158351158352158353158354158355158356158357158358158359158360158361158362158363158364158365158366158367158368158369158370158371158372158373158374158375158376158377158378158379158380158381158382158383158384158385158386158387158388158389158390158391158392158393158394158395158396158397158398158399158400158401158402158403158404158405158406158407158408158409158410158411158412158413158414158415158416158417158418158419158420158421158422158423158424158425158426158427158428158429158430158431158432158433158434158435158436158437158438158439158440158441158442158443158444158445158446158447158448158449158450158451158452158453158454158455158456158457158458158459158460158461158462158463158464158465158466158467158468158469158470158471158472158473158474158475158476158477158478158479158480158481158482158483158484158485158486158487158488158489158490158491158492158493158494158495158496158497158498158499158500158501158502158503158504158505158506158507158508158509158510158511158512158513158514158515158516158517158518158519158520158521158522158523158524158525158526158527158528158529158530158531158532158533158534158535158536158537158538158539158540158541158542158543158544158545158546158547158548158549158550158551158552158553158554158555158556158557158558158559158560158561158562158563158564158565158566158567158568158569158570158571158572158573158574158575158576158577158578158579158580158581158582158583158584158585158586158587158588158589158590158591158592158593158594158595158596158597158598158599158600158601158602158603158604158605158606158607158608158609158610158611158612158613158614158615158616158617158618158619158620158621158622158623158624158625158626158627158628158629158630158631158632158633158634158635158636158637158638158639158640158641158642158643158644158645158646158647158648158649158650158651158652158653158654158655158656158657158658158659158660158661158662158663158664158665158666158667158668158669158670158671158672158673158674158675158676158677158678158679158680158681158682158683158684158685158686158687158688158689158690158691158692158693158694158695158696158697158698158699158700158701158702158703158704158705158706158707158708158709158710158711158712158713158714158715158716158717158718158719158720158721158722158723158724158725158726158727158728158729158730158731158732158733158734158735158736158737158738158739158740158741158742158743158744158745158746158747158748158749158750158751158752158753158754158755158756158757158758158759158760158761158762158763158764158765158766158767158768158769158770158771158772158773158774158775158776158777158778158779158780158781158782158783158784158785158786158787158788158789158790158791158792158793158794158795158796158797158798158799158800158801158802158803158804158805158806158807158808158809158810158811158812158813158814158815158816158817158818158819158820158821158822158823158824158825158826158827158828158829158830158831158832158833158834158835158836158837158838158839158840158841158842158843158844158845158846158847158848158849158850158851158852158853158854158855158856158857158858158859158860158861158862158863158864158865158866158867158868158869158870158871158872158873158874158875158876158877158878158879158880158881158882158883158884158885158886158887158888158889158890158891158892158893158894158895158896158897158898158899158900158901158902158903158904158905158906158907158908158909158910158911158912158913158914158915158916158917158918158919158920158921158922158923158924158925158926158927158928158929158930158931158932158933158934158935158936158937158938158939158940158941158942158943158944158945158946158947158948158949158950158951158952158953158954158955158956158957158958158959158960158961158962158963158964158965158966158967158968158969158970158971158972158973158974158975158976158977158978158979158980158981158982158983158984158985158986158987158988158989158990158991158992158993158994158995158996158997158998158999159000159001159002159003159004159005159006159007159008159009159010159011159012159013159014159015159016159017159018159019159020159021159022159023159024159025159026159027159028159029159030159031159032159033159034159035159036159037159038159039159040159041159042159043159044159045159046159047159048159049159050159051159052159053159054159055159056159057159058159059159060159061159062159063159064159065159066159067159068159069159070159071159072159073159074159075159076159077159078159079159080159081159082159083159084159085159086159087159088159089159090159091159092159093159094159095159096159097159098159099159100159101159102159103159104159105159106159107159108159109159110159111159112159113159114159115159116159117159118159119159120159121159122159123159124159125159126159127159128159129159130159131159132159133159134159135159136159137159138159139159140159141159142159143159144159145159146159147159148159149159150159151159152159153159154159155159156159157159158159159159160159161159162159163159164159165159166159167159168159169159170159171159172159173159174159175159176159177159178159179159180159181159182159183159184159185159186159187159188159189159190159191159192159193159194159195159196159197159198159199159200159201159202159203159204159205159206159207159208159209159210159211159212159213159214159215159216159217159218159219159220159221159222159223159224159225159226159227159228159229159230159231159232159233159234159235159236159237159238159239159240159241159242159243159244159245159246159247159248159249159250159251159252159253159254159255159256159257159258159259159260159261159262159263159264159265159266159267159268159269159270159271159272159273159274159275159276159277159278159279159280159281159282159283159284159285159286159287159288159289159290159291159292159293159294159295159296159297159298159299159300159301159302159303159304159305159306159307159308159309159310159311159312159313159314159315159316159317159318159319159320159321159322159323159324159325159326159327159328159329159330159331159332159333159334159335159336159337159338159339159340159341159342159343159344159345159346159347159348159349159350159351159352159353159354159355159356159357159358159359159360159361159362159363159364159365159366159367159368159369159370159371159372159373159374159375159376159377159378159379159380159381159382159383159384159385159386159387159388159389159390159391159392159393159394159395159396159397159398159399159400159401159402159403159404159405159406159407159408159409159410159411159412159413159414159415159416159417159418159419159420159421159422159423159424159425159426159427159428159429159430159431159432159433159434159435159436159437159438159439159440159441159442159443159444159445159446159447159448159449159450159451159452159453159454159455159456159457159458159459159460159461159462159463159464159465159466159467159468159469159470159471159472159473159474159475159476159477159478159479159480159481159482159483159484159485159486159487159488159489159490159491159492159493159494159495159496159497159498159499159500159501159502159503159504159505159506159507159508159509159510159511159512159513159514159515159516159517159518159519159520159521159522159523159524159525159526159527159528159529159530159531159532159533159534159535159536159537159538159539159540159541159542159543159544159545159546159547159548159549159550159551159552159553159554159555159556159557159558159559159560159561159562159563159564159565159566159567159568159569159570159571159572159573159574159575159576159577159578159579159580159581159582159583159584159585159586159587159588159589159590159591159592159593159594159595159596159597159598159599159600159601159602159603159604159605159606159607159608159609159610159611159612159613159614159615159616159617159618159619159620159621159622159623159624159625159626159627159628159629159630159631159632159633159634159635159636159637159638159639159640159641159642159643159644159645159646159647159648159649159650159651159652159653159654159655159656159657159658159659159660159661159662159663159664159665159666159667159668159669159670159671159672159673159674159675159676159677159678159679159680159681159682159683159684159685159686159687159688159689159690159691159692159693159694159695159696159697159698159699159700159701159702159703159704159705159706159707159708159709159710159711159712159713159714159715159716159717159718159719159720159721159722159723159724159725159726159727159728159729159730159731159732159733159734159735159736159737159738159739159740159741159742159743159744159745159746159747159748159749159750159751159752159753159754159755159756159757159758159759159760159761159762159763159764159765159766159767159768159769159770159771159772159773159774159775159776159777159778159779159780159781159782159783159784159785159786159787159788159789159790159791159792159793159794159795159796159797159798159799159800159801159802159803159804159805159806159807159808159809159810159811159812159813159814159815159816159817159818159819159820159821159822159823159824159825159826159827159828159829159830159831159832159833159834159835159836159837159838159839159840159841159842159843159844159845159846159847159848159849159850159851159852159853159854159855159856159857159858159859159860159861159862159863159864159865159866159867159868159869159870159871159872159873159874159875159876159877159878159879159880159881159882159883159884159885159886159887159888159889159890159891159892159893159894159895159896159897159898159899159900159901159902159903159904159905159906159907159908159909159910159911159912159913159914159915159916159917159918159919159920159921159922159923159924159925159926159927159928159929159930159931159932159933159934159935159936159937159938159939159940159941159942159943159944159945159946159947159948159949159950159951159952159953159954159955159956159957159958159959159960159961159962159963159964159965159966159967159968159969159970159971159972159973159974159975159976159977159978159979159980159981159982159983159984159985159986159987159988159989159990159991159992159993159994159995159996159997159998159999160000160001160002160003160004160005160006160007160008160009160010160011160012160013160014160015160016160017160018160019160020160021160022160023160024160025160026160027160028160029160030160031160032160033160034160035160036160037160038160039160040160041160042160043160044160045160046160047160048160049160050160051160052160053160054160055160056160057160058160059160060160061160062160063160064160065160066160067160068160069160070160071160072160073160074160075160076160077160078160079160080160081160082160083160084160085160086160087160088160089160090160091160092160093160094160095160096160097160098160099160100160101160102160103160104160105160106160107160108160109160110160111160112160113160114160115160116160117160118160119160120160121160122160123160124160125160126160127160128160129160130160131160132160133160134160135160136160137160138160139160140160141160142160143160144160145160146160147160148160149160150160151160152160153160154160155160156160157160158160159160160160161160162160163160164160165160166160167160168160169160170160171160172160173160174160175160176160177160178160179160180160181160182160183160184160185160186160187160188160189160190160191160192160193160194160195160196160197160198160199160200160201160202160203160204160205160206160207160208160209160210160211160212160213160214160215160216160217160218160219160220160221160222160223160224160225160226160227160228160229160230160231160232160233160234160235160236160237160238160239160240160241160242160243160244160245160246160247160248160249160250160251160252160253160254160255160256160257160258160259160260160261160262160263160264160265160266160267160268160269160270160271160272160273160274160275160276160277160278160279160280160281160282160283160284160285160286160287160288160289160290160291160292160293160294160295160296160297160298160299160300160301160302160303160304160305160306160307160308160309160310160311160312160313160314160315160316160317160318160319160320160321160322160323160324160325160326160327160328160329160330160331160332160333160334160335160336160337160338160339160340160341160342160343160344160345160346160347160348160349160350160351160352160353160354160355160356160357160358160359160360160361160362160363160364160365160366160367160368160369160370160371160372160373160374160375160376160377160378160379160380160381160382160383160384160385160386160387160388160389160390160391160392160393160394160395160396160397160398160399160400160401160402160403160404160405160406160407160408160409160410160411160412160413160414160415160416160417160418160419160420160421160422160423160424160425160426160427160428160429160430160431160432160433160434160435160436160437160438160439160440160441160442160443160444160445160446160447160448160449160450160451160452160453160454160455160456160457160458160459160460160461160462160463160464160465160466160467160468160469160470160471160472160473160474160475160476160477160478160479160480160481160482160483160484160485160486160487160488160489160490160491160492160493160494160495160496160497160498160499160500160501160502160503160504160505160506160507160508160509160510160511160512160513160514160515160516160517160518160519160520160521160522160523160524160525160526160527160528160529160530160531160532160533160534160535160536160537160538160539160540160541160542160543160544160545160546160547160548160549160550160551160552160553160554160555160556160557160558160559160560160561160562160563160564160565160566160567160568160569160570160571160572160573160574160575160576160577160578160579160580160581160582160583160584160585160586160587160588160589160590160591160592160593160594160595160596160597160598160599160600160601160602160603160604160605160606160607160608160609160610160611160612160613160614160615160616160617160618160619160620160621160622160623160624160625160626160627160628160629160630160631160632160633160634160635160636160637160638160639160640160641160642160643160644160645160646160647160648160649160650160651160652160653160654160655160656160657160658160659160660160661160662160663160664160665160666160667160668160669160670160671160672160673160674160675160676160677160678160679160680160681160682160683160684160685160686160687160688160689160690160691160692160693160694160695160696160697160698160699160700160701160702160703160704160705160706160707160708160709160710160711160712160713160714160715160716160717160718160719160720160721160722160723160724160725160726160727160728160729160730160731160732160733160734160735160736160737160738160739160740160741160742160743160744160745160746160747160748160749160750160751160752160753160754160755160756160757160758160759160760160761160762160763160764160765160766160767160768160769160770160771160772160773160774160775160776160777160778160779160780160781160782160783160784160785160786160787160788160789160790160791160792160793160794160795160796160797160798160799160800160801160802160803160804160805160806160807160808160809160810160811160812160813160814160815160816160817160818160819160820160821160822160823160824160825160826160827160828160829160830160831160832160833160834160835160836160837160838160839160840160841160842160843160844160845160846160847160848160849160850160851160852160853160854160855160856160857160858160859160860160861160862160863160864160865160866160867160868160869160870160871160872160873160874160875160876160877160878160879160880160881160882160883160884160885160886160887160888160889160890160891160892160893160894160895160896160897160898160899160900160901160902160903160904160905160906160907160908160909160910160911160912160913160914160915160916160917160918160919160920160921160922160923160924160925160926160927160928160929160930160931160932160933160934160935160936160937160938160939160940160941160942160943160944160945160946160947160948160949160950160951160952160953160954160955160956160957160958160959160960160961160962160963160964160965160966160967160968160969160970160971160972160973160974160975160976160977160978160979160980160981160982160983160984160985160986160987160988160989160990160991160992160993160994160995160996160997160998160999161000161001161002161003161004161005161006161007161008161009161010161011161012161013161014161015161016161017161018161019161020161021161022161023161024161025161026161027161028161029161030161031161032161033161034161035161036161037161038161039161040161041161042161043161044161045161046161047161048161049161050161051161052161053161054161055161056161057161058161059161060161061161062161063161064161065161066161067161068161069161070161071161072161073161074161075161076161077161078161079161080161081161082161083161084161085161086161087161088161089161090161091161092161093161094161095161096161097161098161099161100161101161102161103161104161105161106161107161108161109161110161111161112161113161114161115161116161117161118161119161120161121161122161123161124161125161126161127161128161129161130161131161132161133161134161135161136161137161138161139161140161141161142161143161144161145161146161147161148161149161150161151161152161153161154161155161156161157161158161159161160161161161162161163161164161165161166161167161168161169161170161171161172161173161174161175161176161177161178161179161180161181161182161183161184161185161186161187161188161189161190161191161192161193161194161195161196161197161198161199161200161201161202161203161204161205161206161207161208161209161210161211161212161213161214161215161216161217161218161219161220161221161222161223161224161225161226161227161228161229161230161231161232161233161234161235161236161237161238161239161240161241161242161243161244161245161246161247161248161249161250161251161252161253161254161255161256161257161258161259161260161261161262161263161264161265161266161267161268161269161270161271161272161273161274161275161276161277161278161279161280161281161282161283161284161285161286161287161288161289161290161291161292161293161294161295161296161297161298161299161300161301161302161303161304161305161306161307161308161309161310161311161312161313161314161315161316161317161318161319161320161321161322161323161324161325161326161327161328161329161330161331161332161333161334161335161336161337161338161339161340161341161342161343161344161345161346161347161348161349161350161351161352161353161354161355161356161357161358161359161360161361161362161363161364161365161366161367161368161369161370161371161372161373161374161375161376161377161378161379161380161381161382161383161384161385161386161387161388161389161390161391161392161393161394161395161396161397161398161399161400161401161402161403161404161405161406161407161408161409161410161411161412161413161414161415161416161417161418161419161420161421161422161423161424161425161426161427161428161429161430161431161432161433161434161435161436161437161438161439161440161441161442161443161444161445161446161447161448161449161450161451161452161453161454161455161456161457161458161459161460161461161462161463161464161465161466161467161468161469161470161471161472161473161474161475161476161477161478161479161480161481161482161483161484161485161486161487161488161489161490161491161492161493161494161495161496161497161498161499161500161501161502161503161504161505161506161507161508161509161510161511161512161513161514161515161516161517161518161519161520161521161522161523161524161525161526161527161528161529161530161531161532161533161534161535161536161537161538161539161540161541161542161543161544161545161546161547161548161549161550161551161552161553161554161555161556161557161558161559161560161561161562161563161564161565161566161567161568161569161570161571161572161573161574161575161576161577161578161579161580161581161582161583161584161585161586161587161588161589161590161591161592161593161594161595161596161597161598161599161600161601161602161603161604161605161606161607161608161609161610161611161612161613161614161615161616161617161618161619161620161621161622161623161624161625161626161627161628161629161630161631161632161633161634161635161636161637161638161639161640161641161642161643161644161645161646161647161648161649161650161651161652161653161654161655161656161657161658161659161660161661161662161663161664161665161666161667161668161669161670161671161672161673161674161675161676161677161678161679161680161681161682161683161684161685161686161687161688161689161690161691161692161693161694161695161696161697161698161699161700161701161702161703161704161705161706161707161708161709161710161711161712161713161714161715161716161717161718161719161720161721161722161723161724161725161726161727161728161729161730161731161732161733161734161735161736161737161738161739161740161741161742161743161744161745161746161747161748161749161750161751161752161753161754161755161756161757161758161759161760161761161762161763161764161765161766161767161768161769161770161771161772161773161774161775161776161777161778161779161780161781161782161783161784161785161786161787161788161789161790161791161792161793161794161795161796161797161798161799161800161801161802161803161804161805161806161807161808161809161810161811161812161813161814161815161816161817161818161819161820161821161822161823161824161825161826161827161828161829161830161831161832161833161834161835161836161837161838161839161840161841161842161843161844161845161846161847161848161849161850161851161852161853161854161855161856161857161858161859161860161861161862161863161864161865161866161867161868161869161870161871161872161873161874161875161876161877161878161879161880161881161882161883161884161885161886161887161888161889161890161891161892161893161894161895161896161897161898161899161900161901161902161903161904161905161906161907161908161909161910161911161912161913161914161915161916161917161918161919161920161921161922161923161924161925161926161927161928161929161930161931161932161933161934161935161936161937161938161939161940161941161942161943161944161945161946161947161948161949161950161951161952161953161954161955161956161957161958161959161960161961161962161963161964161965161966161967161968161969161970161971161972161973161974161975161976161977161978161979161980161981161982161983161984161985161986161987161988161989161990161991161992161993161994161995161996161997161998161999162000162001162002162003162004162005162006162007162008162009162010162011162012162013162014162015162016162017162018162019162020162021162022162023162024162025162026162027162028162029162030162031162032162033162034162035162036162037162038162039162040162041162042162043162044162045162046162047162048162049162050162051162052162053162054162055162056162057162058162059162060162061162062162063162064162065162066162067162068162069162070162071162072162073162074162075162076162077162078162079162080162081162082162083162084162085162086162087162088162089162090162091162092162093162094162095162096162097162098162099162100162101162102162103162104162105162106162107162108162109162110162111162112162113162114162115162116162117162118162119162120162121162122162123162124162125162126162127162128162129162130162131162132162133162134162135162136162137162138162139162140162141162142162143162144162145162146162147162148162149162150162151162152162153162154162155162156162157162158162159162160162161162162162163162164162165162166162167162168162169162170162171162172162173162174162175162176162177162178162179162180162181162182162183162184162185162186162187162188162189162190162191162192162193162194162195162196162197162198162199162200162201162202162203162204162205162206162207162208162209162210162211162212162213162214162215162216162217162218162219162220162221162222162223162224162225162226162227162228162229162230162231162232162233162234162235162236162237162238162239162240162241162242162243162244162245162246162247162248162249162250162251162252162253162254162255162256162257162258162259162260162261162262162263162264162265162266162267162268162269162270162271162272162273162274162275162276162277162278162279162280162281162282162283162284162285162286162287162288162289162290162291162292162293162294162295162296162297162298162299162300162301162302162303162304162305162306162307162308162309162310162311162312162313162314162315162316162317162318162319162320162321162322162323162324162325162326162327162328162329162330162331162332162333162334162335162336162337162338162339162340162341162342162343162344162345162346162347162348162349162350162351162352162353162354162355162356162357162358162359162360162361162362162363162364162365162366162367162368162369162370162371162372162373162374162375162376162377162378162379162380162381162382162383162384162385162386162387162388162389162390162391162392162393162394162395162396162397162398162399162400162401162402162403162404162405162406162407162408162409162410162411162412162413162414162415162416162417162418162419162420162421162422162423162424162425162426162427162428162429162430162431162432162433162434162435162436162437162438162439162440162441162442162443162444162445162446162447162448162449162450162451162452162453162454162455162456162457162458162459162460162461162462162463162464162465162466162467162468162469162470162471162472162473162474162475162476162477162478162479162480162481162482162483162484162485162486162487162488162489162490162491162492162493162494162495162496162497162498162499162500162501162502162503162504162505162506162507162508162509162510162511162512162513162514162515162516162517162518162519162520162521162522162523162524162525162526162527162528162529162530162531162532162533162534162535162536162537162538162539162540162541162542162543162544162545162546162547162548162549162550162551162552162553162554162555162556162557162558162559162560162561162562162563162564162565162566162567162568162569162570162571162572162573162574162575162576162577162578162579162580162581162582162583162584162585162586162587162588162589162590162591162592162593162594162595162596162597162598162599162600162601162602162603162604162605162606162607162608162609162610162611162612162613162614162615162616162617162618162619162620162621162622162623162624162625162626162627162628162629162630162631162632162633162634162635162636162637162638162639162640162641162642162643162644162645162646162647162648162649162650162651162652162653162654162655162656162657162658162659162660162661162662162663162664162665162666162667162668162669162670162671162672162673162674162675162676162677162678162679162680162681162682162683162684162685162686162687162688162689162690162691162692162693162694162695162696162697162698162699162700162701162702162703162704162705162706162707162708162709162710162711162712162713162714162715162716162717162718162719162720162721162722162723162724162725162726162727162728162729162730162731162732162733162734162735162736162737162738162739162740162741162742162743162744162745162746162747162748162749162750162751162752162753162754162755162756162757162758162759162760162761162762162763162764162765162766162767162768162769162770162771162772162773162774162775162776162777162778162779162780162781162782162783162784162785162786162787162788162789162790162791162792162793162794162795162796162797162798162799162800162801162802162803162804162805162806162807162808162809162810162811162812162813162814162815162816162817162818162819162820162821162822162823162824162825162826162827162828162829162830162831162832162833162834162835162836162837162838162839162840162841162842162843162844162845162846162847162848162849162850162851162852162853162854162855162856162857162858162859162860162861162862162863162864162865162866162867162868162869162870162871162872162873162874162875162876162877162878162879162880162881162882162883162884162885162886162887162888162889162890162891162892162893162894162895162896162897162898162899162900162901162902162903162904162905162906162907162908162909162910162911162912162913162914162915162916162917162918162919162920162921162922162923162924162925162926162927162928162929162930162931162932162933162934162935162936162937162938162939162940162941162942162943162944162945162946162947162948162949162950162951162952162953162954162955162956162957162958162959162960162961162962162963162964162965162966162967162968162969162970162971162972162973162974162975162976162977162978162979162980162981162982162983162984162985162986162987162988162989162990162991162992162993162994162995162996162997162998162999163000163001163002163003163004163005163006163007163008163009163010163011163012163013163014163015163016163017163018163019163020163021163022163023163024163025163026163027163028163029163030163031163032163033163034163035163036163037163038163039163040163041163042163043163044163045163046163047163048163049163050163051163052163053163054163055163056163057163058163059163060163061163062163063163064163065163066163067163068163069163070163071163072163073163074163075163076163077163078163079163080163081163082163083163084163085163086163087163088163089163090163091163092163093163094163095163096163097163098163099163100163101163102163103163104163105163106163107163108163109163110163111163112163113163114163115163116163117163118163119163120163121163122163123163124163125163126163127163128163129163130163131163132163133163134163135163136163137163138163139163140163141163142163143163144163145163146163147163148163149163150163151163152163153163154163155163156163157163158163159163160163161163162163163163164163165163166163167163168163169163170163171163172163173163174163175163176163177163178163179163180163181163182163183163184163185163186163187163188163189163190163191163192163193163194163195163196163197163198163199163200163201163202163203163204163205163206163207163208163209163210163211163212163213163214163215163216163217163218163219163220163221163222163223163224163225163226163227163228163229163230163231163232163233163234163235163236163237163238163239163240163241163242163243163244163245163246163247163248163249163250163251163252163253163254163255163256163257163258163259163260163261163262163263163264163265163266163267163268163269163270163271163272163273163274163275163276163277163278163279163280163281163282163283163284163285163286163287163288163289163290163291163292163293163294163295163296163297163298163299163300163301163302163303163304163305163306163307163308163309163310163311163312163313163314163315163316163317163318163319163320163321163322163323163324163325163326163327163328163329163330163331163332163333163334163335163336163337163338163339163340163341163342163343163344163345163346163347163348163349163350163351163352163353163354163355163356163357163358163359163360163361163362163363163364163365163366163367163368163369163370163371163372163373163374163375163376163377163378163379163380163381163382163383163384163385163386163387163388163389163390163391163392163393163394163395163396163397163398163399163400163401163402163403163404163405163406163407163408163409163410163411163412163413163414163415163416163417163418163419163420163421163422163423163424163425163426163427163428163429163430163431163432163433163434163435163436163437163438163439163440163441163442163443163444163445163446163447163448163449163450163451163452163453163454163455163456163457163458163459163460163461163462163463163464163465163466163467163468163469163470163471163472163473163474163475163476163477163478163479163480163481163482163483163484163485163486163487163488163489163490163491163492163493163494163495163496163497163498163499163500163501163502163503163504163505163506163507163508163509163510163511163512163513163514163515163516163517163518163519163520163521163522163523163524163525163526163527163528163529163530163531163532163533163534163535163536163537163538163539163540163541163542163543163544163545163546163547163548163549163550163551163552163553163554163555163556163557163558163559163560163561163562163563163564163565163566163567163568163569163570163571163572163573163574163575163576163577163578163579163580163581163582163583163584163585163586163587163588163589163590163591163592163593163594163595163596163597163598163599163600163601163602163603163604163605163606163607163608163609163610163611163612163613163614163615163616163617163618163619163620163621163622163623163624163625163626163627163628163629163630163631163632163633163634163635163636163637163638163639163640163641163642163643163644163645163646163647163648163649163650163651163652163653163654163655163656163657163658163659163660163661163662163663163664163665163666163667163668163669163670163671163672163673163674163675163676163677163678163679163680163681163682163683163684163685163686163687163688163689163690163691163692163693163694163695163696163697163698163699163700163701163702163703163704163705163706163707163708163709163710163711163712163713163714163715163716163717163718163719163720163721163722163723163724163725163726163727163728163729163730163731163732163733163734163735163736163737163738163739163740163741163742163743163744163745163746163747163748163749163750163751163752163753163754163755163756163757163758163759163760163761163762163763163764163765163766163767163768163769163770163771163772163773163774163775163776163777163778163779163780163781163782163783163784163785163786163787163788163789163790163791163792163793163794163795163796163797163798163799163800163801163802163803163804163805163806163807163808163809163810163811163812163813163814163815163816163817163818163819163820163821163822163823163824163825163826163827163828163829163830163831163832163833163834163835163836163837163838163839163840163841163842163843163844163845163846163847163848163849163850163851163852163853163854163855163856163857163858163859163860163861163862163863163864163865163866163867163868163869163870163871163872163873163874163875163876163877163878163879163880163881163882163883163884163885163886163887163888163889163890163891163892163893163894163895163896163897163898163899163900163901163902163903163904163905163906163907163908163909163910163911163912163913163914163915163916163917163918163919163920163921163922163923163924163925163926163927163928163929163930163931163932163933163934163935163936163937163938163939163940163941163942163943163944163945163946163947163948163949163950163951163952163953163954163955163956163957163958163959163960163961163962163963163964163965163966163967163968163969163970163971163972163973163974163975163976163977163978163979163980163981163982163983163984163985163986163987163988163989163990163991163992163993163994163995163996163997163998163999164000164001164002164003164004164005164006164007164008164009164010164011164012164013164014164015164016164017164018164019164020164021164022164023164024164025164026164027164028164029164030164031164032164033164034164035164036164037164038164039164040164041164042164043164044164045164046164047164048164049164050164051164052164053164054164055164056164057164058164059164060164061164062164063164064164065164066164067164068164069164070164071164072164073164074164075164076164077164078164079164080164081164082164083164084164085164086164087164088164089164090164091164092164093164094164095164096164097164098164099164100164101164102164103164104164105164106164107164108164109164110164111164112164113164114164115164116164117164118164119164120164121164122164123164124164125164126164127164128164129164130164131164132164133164134164135164136164137164138164139164140164141164142164143164144164145164146164147164148164149164150164151164152164153164154164155164156164157164158164159164160164161164162164163164164164165164166164167164168164169164170164171164172164173164174164175164176164177164178164179164180164181164182164183164184164185164186164187164188164189164190164191164192164193164194164195164196164197164198164199164200164201164202164203164204164205164206164207164208164209164210164211164212164213164214164215164216164217164218164219164220164221164222164223164224164225164226164227164228164229164230164231164232164233164234164235164236164237164238164239164240164241164242164243164244164245164246164247164248164249164250164251164252164253164254164255164256164257164258164259164260164261164262164263164264164265164266164267164268164269164270164271164272164273164274164275164276164277164278164279164280164281164282164283164284164285164286164287164288164289164290164291164292164293164294164295164296164297164298164299164300164301164302164303164304164305164306164307164308164309164310164311164312164313164314164315164316164317164318164319164320164321164322164323164324164325164326164327164328164329164330164331164332164333164334164335164336164337164338164339164340164341164342164343164344164345164346164347164348164349164350164351164352164353164354164355164356164357164358164359164360164361164362164363164364164365164366164367164368164369164370164371164372164373164374164375164376164377164378164379164380164381164382164383164384164385164386164387164388164389164390164391164392164393164394164395164396164397164398164399164400164401164402164403164404164405164406164407164408164409164410164411164412164413164414164415164416164417164418164419164420164421164422164423164424164425164426164427164428164429164430164431164432164433164434164435164436164437164438164439164440164441164442164443164444164445164446164447164448164449164450164451164452164453164454164455164456164457164458164459164460164461164462164463164464164465164466164467164468164469164470164471164472164473164474164475164476164477164478164479164480164481164482164483164484164485164486164487164488164489164490164491164492164493164494164495164496164497164498164499164500164501164502164503164504164505164506164507164508164509164510164511164512164513164514164515164516164517164518164519164520164521164522164523164524164525164526164527164528164529164530164531164532164533164534164535164536164537164538164539164540164541164542164543164544164545164546164547164548164549164550164551164552164553164554164555164556164557164558164559164560164561164562164563164564164565164566164567164568164569164570164571164572164573164574164575164576164577164578164579164580164581164582164583164584164585164586164587164588164589164590164591164592164593164594164595164596164597164598164599164600164601164602164603164604164605164606164607164608164609164610164611164612164613164614164615164616164617164618164619164620164621164622164623164624164625164626164627164628164629164630164631164632164633164634164635164636164637164638164639164640164641164642164643164644164645164646164647164648164649164650164651164652164653164654164655164656164657164658164659164660164661164662164663164664164665164666164667164668164669164670164671164672164673164674164675164676164677164678164679164680164681164682164683164684164685164686164687164688164689164690164691164692164693164694164695164696164697164698164699164700164701164702164703164704164705164706164707164708164709164710164711164712164713164714164715164716164717164718164719164720164721164722164723164724164725164726164727164728164729164730164731164732164733164734164735164736164737164738164739164740164741164742164743164744164745164746164747164748164749164750164751164752164753164754164755164756164757164758164759164760164761164762164763164764164765164766164767164768164769164770164771164772164773164774164775164776164777164778164779164780164781164782164783164784164785164786164787164788164789164790164791164792164793164794164795164796164797164798164799164800164801164802164803164804164805164806164807164808164809164810164811164812164813164814164815164816164817164818164819164820164821164822164823164824164825164826164827164828164829164830164831164832164833164834164835164836164837164838164839164840164841164842164843164844164845164846164847164848164849164850164851164852164853164854164855164856164857164858164859164860164861164862164863164864164865164866164867164868164869164870164871164872164873164874164875164876164877164878164879164880164881164882164883164884164885164886164887164888164889164890164891164892164893164894164895164896164897164898164899164900164901164902164903164904164905164906164907164908164909164910164911164912164913164914164915164916164917164918164919164920164921164922164923164924164925164926164927164928164929164930164931164932164933164934164935164936164937164938164939164940164941164942164943164944164945164946164947164948164949164950164951164952164953164954164955164956164957164958164959164960164961164962164963164964164965164966164967164968164969164970164971164972164973164974164975164976164977164978164979164980164981164982164983164984164985164986164987164988164989164990164991164992164993164994164995164996164997164998164999165000165001165002165003165004165005165006165007165008165009165010165011165012165013165014165015165016165017165018165019165020165021165022165023165024165025165026165027165028165029165030165031165032165033165034165035165036165037165038165039165040165041165042165043165044165045165046165047165048165049165050165051165052165053165054165055165056165057165058165059165060165061165062165063165064165065165066165067165068165069165070165071165072165073165074165075165076165077165078165079165080165081165082165083165084165085165086165087165088165089165090165091165092165093165094165095165096165097165098165099165100165101165102165103165104165105165106165107165108165109165110165111165112165113165114165115165116165117165118165119165120165121165122165123165124165125165126165127165128165129165130165131165132165133165134165135165136165137165138165139165140165141165142165143165144165145165146165147165148165149165150165151165152165153165154165155165156165157165158165159165160165161165162165163165164165165165166165167165168165169165170165171165172165173165174165175165176165177165178165179165180165181165182165183165184165185165186165187165188165189165190165191165192165193165194165195165196165197165198165199165200165201165202165203165204165205165206165207165208165209165210165211165212165213165214165215165216165217165218165219165220165221165222165223165224165225165226165227165228165229165230165231165232165233165234165235165236165237165238165239165240165241165242165243165244165245165246165247165248165249165250165251165252165253165254165255165256165257165258165259165260165261165262165263165264165265165266165267165268165269165270165271165272165273165274165275165276165277165278165279165280165281165282165283165284165285165286165287165288165289165290165291165292165293165294165295165296165297165298165299165300165301165302165303165304165305165306165307165308165309165310165311165312165313165314165315165316165317165318165319165320165321165322165323165324165325165326165327165328165329165330165331165332165333165334165335165336165337165338165339165340165341165342165343165344165345165346165347165348165349165350165351165352165353165354165355165356165357165358165359165360165361165362165363165364165365165366165367165368165369165370165371165372165373165374165375165376165377165378165379165380165381165382165383165384165385165386165387165388165389165390165391165392165393165394165395165396165397165398165399165400165401165402165403165404165405165406165407165408165409165410165411165412165413165414165415165416165417165418165419165420165421165422165423165424165425165426165427165428165429165430165431165432165433165434165435165436165437165438165439165440165441165442165443165444165445165446165447165448165449165450165451165452165453165454165455165456165457165458165459165460165461165462165463165464165465165466165467165468165469165470165471165472165473165474165475165476165477165478165479165480165481165482165483165484165485165486165487165488165489165490165491165492165493165494165495165496165497165498165499165500165501165502165503165504165505165506165507165508165509165510165511165512165513165514165515165516165517165518165519165520165521165522165523165524165525165526165527165528165529165530165531165532165533165534165535165536165537165538165539165540165541165542165543165544165545165546165547165548165549165550165551165552165553165554165555165556165557165558165559165560165561165562165563165564165565165566165567165568165569165570165571165572165573165574165575165576165577165578165579165580165581165582165583165584165585165586165587165588165589165590165591165592165593165594165595165596165597165598165599165600165601165602165603165604165605165606165607165608165609165610165611165612165613165614165615165616165617165618165619165620165621165622165623165624165625165626165627165628165629165630165631165632165633165634165635165636165637165638165639165640165641165642165643165644165645165646165647165648165649165650165651165652165653165654165655165656165657165658165659165660165661165662165663165664165665165666165667165668165669165670165671165672165673165674165675165676165677165678165679165680165681165682165683165684165685165686165687165688165689165690165691165692165693165694165695165696165697165698165699165700165701165702165703165704165705165706165707165708165709165710165711165712165713165714165715165716165717165718165719165720165721165722165723165724165725165726165727165728165729165730165731165732165733165734165735165736165737165738165739165740165741165742165743165744165745165746165747165748165749165750165751165752165753165754165755165756165757165758165759165760165761165762165763165764165765165766165767165768165769165770165771165772165773165774165775165776165777165778165779165780165781165782165783165784165785165786165787165788165789165790165791165792165793165794165795165796165797165798165799165800165801165802165803165804165805165806165807165808165809165810165811165812165813165814165815165816165817165818165819165820165821165822165823165824165825165826165827165828165829165830165831165832165833165834165835165836165837165838165839165840165841165842165843165844165845165846165847165848165849165850165851165852165853165854165855165856165857165858165859165860165861165862165863165864165865165866165867165868165869165870165871165872165873165874165875165876165877165878165879165880165881165882165883165884165885165886165887165888165889165890165891165892165893165894165895165896165897165898165899165900165901165902165903165904165905165906165907165908165909165910165911165912165913165914165915165916165917165918165919165920165921165922165923165924165925165926165927165928165929165930165931165932165933165934165935165936165937165938165939165940165941165942165943165944165945165946165947165948165949165950165951165952165953165954165955165956165957165958165959165960165961165962165963165964165965165966165967165968165969165970165971165972165973165974165975165976165977165978165979165980165981165982165983165984165985165986165987165988165989165990165991165992165993165994165995165996165997165998165999166000166001166002166003166004166005166006166007166008166009166010166011166012166013166014166015166016166017166018166019166020166021166022166023166024166025166026166027166028166029166030166031166032166033166034166035166036166037166038166039166040166041166042166043166044166045166046166047166048166049166050166051166052166053166054166055166056166057166058166059166060166061166062166063166064166065166066166067166068166069166070166071166072166073166074166075166076166077166078166079166080166081166082166083166084166085166086166087166088166089166090166091166092166093166094166095166096166097166098166099166100166101166102166103166104166105166106166107166108166109166110166111166112166113166114166115166116166117166118166119166120166121166122166123166124166125166126166127166128166129166130166131166132166133166134166135166136166137166138166139166140166141166142166143166144166145166146166147166148166149166150166151166152166153166154166155166156166157166158166159166160166161166162166163166164166165166166166167166168166169166170166171166172166173166174166175166176166177166178166179166180166181166182166183166184166185166186166187166188166189166190166191166192166193166194166195166196166197166198166199166200166201166202166203166204166205166206166207166208166209166210166211166212166213166214166215166216166217166218166219166220166221166222166223166224166225166226166227166228166229166230166231166232166233166234166235166236166237166238166239166240166241166242166243166244166245166246166247166248166249166250166251166252166253166254166255166256166257166258166259166260166261166262166263166264166265166266166267166268166269166270166271166272166273166274166275166276166277166278166279166280166281166282166283166284166285166286166287166288166289166290166291166292166293166294166295166296166297166298166299166300166301166302166303166304166305166306166307166308166309166310166311166312166313166314166315166316166317166318166319166320166321166322166323166324166325166326166327166328166329166330166331166332166333166334166335166336166337166338166339166340166341166342166343166344166345166346166347166348166349166350166351166352166353166354166355166356166357166358166359166360166361166362166363166364166365166366166367166368166369166370166371166372166373166374166375166376166377166378166379166380166381166382166383166384166385166386166387166388166389166390166391166392166393166394166395166396166397166398166399166400166401166402166403166404166405166406166407166408166409166410166411166412166413166414166415166416166417166418166419166420166421166422166423166424166425166426166427166428166429166430166431166432166433166434166435166436166437166438166439166440166441166442166443166444166445166446166447166448166449166450166451166452166453166454166455166456166457166458166459166460166461166462166463166464166465166466166467166468166469166470166471166472166473166474166475166476166477166478166479166480166481166482166483166484166485166486166487166488166489166490166491166492166493166494166495166496166497166498166499166500166501166502166503166504166505166506166507166508166509166510166511166512166513166514166515166516166517166518166519166520166521166522166523166524166525166526166527166528166529166530166531166532166533166534166535166536166537166538166539166540166541166542166543166544166545166546166547166548166549166550166551166552166553166554166555166556166557166558166559166560166561166562166563166564166565166566166567166568166569166570166571166572166573166574166575166576166577166578166579166580166581166582166583166584166585166586166587166588166589166590166591166592166593166594166595166596166597166598166599166600166601166602166603166604166605166606166607166608166609166610166611166612166613166614166615166616166617166618166619166620166621166622166623166624166625166626166627166628166629166630166631166632166633166634166635166636166637166638166639166640166641166642166643166644166645166646166647166648166649166650166651166652166653166654166655166656166657166658166659166660166661166662166663166664166665166666166667166668166669166670166671166672166673166674166675166676166677166678166679166680166681166682166683166684166685166686166687166688166689166690166691166692166693166694166695166696166697166698166699166700166701166702166703166704166705166706166707166708166709166710166711166712166713166714166715166716166717166718166719166720166721166722166723166724166725166726166727166728166729166730166731166732166733166734166735166736166737166738166739166740166741166742166743166744166745166746166747166748166749166750166751166752166753166754166755166756166757166758166759166760166761166762166763166764166765166766166767166768166769166770166771166772166773166774166775166776166777166778166779166780166781166782166783166784166785166786166787166788166789166790166791166792166793166794166795166796166797166798166799166800166801166802166803166804166805166806166807166808166809166810166811166812166813166814166815166816166817166818166819166820166821166822166823166824166825166826166827166828166829166830166831166832166833166834166835166836166837166838166839166840166841166842166843166844166845166846166847166848166849166850166851166852166853166854166855166856166857166858166859166860166861166862166863166864166865166866166867166868166869166870166871166872166873166874166875166876166877166878166879166880166881166882166883166884166885166886166887166888166889166890166891166892166893166894166895166896166897166898166899166900166901166902166903166904166905166906166907166908166909166910166911166912166913166914166915166916166917166918166919166920166921166922166923166924166925166926166927166928166929166930166931166932166933166934166935166936166937166938166939166940166941166942166943166944166945166946166947166948166949166950166951166952166953166954166955166956166957166958166959166960166961166962166963166964166965166966166967166968166969166970166971166972166973166974166975166976166977166978166979166980166981166982166983166984166985166986166987166988166989166990166991166992166993166994166995166996166997166998166999167000167001167002167003167004167005167006167007167008167009167010167011167012167013167014167015167016167017167018167019167020167021167022167023167024167025167026167027167028167029167030167031167032167033167034167035167036167037167038167039167040167041167042167043167044167045167046167047167048167049167050167051167052167053167054167055167056167057167058167059167060167061167062167063167064167065167066167067167068167069167070167071167072167073167074167075167076167077167078167079167080167081167082167083167084167085167086167087167088167089167090167091167092167093167094167095167096167097167098167099167100167101167102167103167104167105167106167107167108167109167110167111167112167113167114167115167116167117167118167119167120167121167122167123167124167125167126167127167128167129167130167131167132167133167134167135167136167137167138167139167140167141167142167143167144167145167146167147167148167149167150167151167152167153167154167155167156167157167158167159167160167161167162167163167164167165167166167167167168167169167170167171167172167173167174167175167176167177167178167179167180167181167182167183167184167185167186167187167188167189167190167191167192167193167194167195167196167197167198167199167200167201167202167203167204167205167206167207167208167209167210167211167212167213167214167215167216167217167218167219167220167221167222167223167224167225167226167227167228167229167230167231167232167233167234167235167236167237167238167239167240167241167242167243167244167245167246167247167248167249167250167251167252167253167254167255167256167257167258167259167260167261167262167263167264167265167266167267167268167269167270167271167272167273167274167275167276167277167278167279167280167281167282167283167284167285167286167287167288167289167290167291167292167293167294167295167296167297167298167299167300167301167302167303167304167305167306167307167308167309167310167311167312167313167314167315167316167317167318167319167320167321167322167323167324167325167326167327167328167329167330167331167332167333167334167335167336167337167338167339167340167341167342167343167344167345167346167347167348167349167350167351167352167353167354167355167356167357167358167359167360167361167362167363167364167365167366167367167368167369167370167371167372167373167374167375167376167377167378167379167380167381167382167383167384167385167386167387167388167389167390167391167392167393167394167395167396167397167398167399167400167401167402167403167404167405167406167407167408167409167410167411167412167413167414167415167416167417167418167419167420167421167422167423167424167425167426167427167428167429167430167431167432167433167434167435167436167437167438167439167440167441167442167443167444167445167446167447167448167449167450167451167452167453167454167455167456167457167458167459167460167461167462167463167464167465167466167467167468167469167470167471167472167473167474167475167476167477167478167479167480167481167482167483167484167485167486167487167488167489167490167491167492167493167494167495167496167497167498167499167500167501167502167503167504167505167506167507167508167509167510167511167512167513167514167515167516167517167518167519167520167521167522167523167524167525167526167527167528167529167530167531167532167533167534167535167536167537167538167539167540167541167542167543167544167545167546167547167548167549167550167551167552167553167554167555167556167557167558167559167560167561167562167563167564167565167566167567167568167569167570167571167572167573167574167575167576167577167578167579167580167581167582167583167584167585167586167587167588167589167590167591167592167593167594167595167596167597167598167599167600167601167602167603167604167605167606167607167608167609167610167611167612167613167614167615167616167617167618167619167620167621167622167623167624167625167626167627167628167629167630167631167632167633167634167635167636167637167638167639167640167641167642167643167644167645167646167647167648167649167650167651167652167653167654167655167656167657167658167659167660167661167662167663167664167665167666167667167668167669167670167671167672167673167674167675167676167677167678167679167680167681167682167683167684167685167686167687167688167689167690167691167692167693167694167695167696167697167698167699167700167701167702167703167704167705167706167707167708167709167710167711167712167713167714167715167716167717167718167719167720167721167722167723167724167725167726167727167728167729167730167731167732167733167734167735167736167737167738167739167740167741167742167743167744167745167746167747167748167749167750167751167752167753167754167755167756167757167758167759167760167761167762167763167764167765167766167767167768167769167770167771167772167773167774167775167776167777167778167779167780167781167782167783167784167785167786167787167788167789167790167791167792167793167794167795167796167797167798167799167800167801167802167803167804167805167806167807167808167809167810167811167812167813167814167815167816167817167818167819167820167821167822167823167824167825167826167827167828167829167830167831167832167833167834167835167836167837167838167839167840167841167842167843167844167845167846167847167848167849167850167851167852167853167854167855167856167857167858167859167860167861167862167863167864167865167866167867167868167869167870167871167872167873167874167875167876167877167878167879167880167881167882167883167884167885167886167887167888167889167890167891167892167893167894167895167896167897167898167899167900167901167902167903167904167905167906167907167908167909167910167911167912167913167914167915167916167917167918167919167920167921167922167923167924167925167926167927167928167929167930167931167932167933167934167935167936167937167938167939167940167941167942167943167944167945167946167947167948167949167950167951167952167953167954167955167956167957167958167959167960167961167962167963167964167965167966167967167968167969167970167971167972167973167974167975167976167977167978167979167980167981167982167983167984167985167986167987167988167989167990167991167992167993167994167995167996167997167998167999168000168001168002168003168004168005168006168007168008168009168010168011168012168013168014168015168016168017168018168019168020168021168022168023168024168025168026168027168028168029168030168031168032168033168034168035168036168037168038168039168040168041168042168043168044168045168046168047168048168049168050168051168052168053168054168055168056168057168058168059168060168061168062168063168064168065168066168067168068168069168070168071168072168073168074168075168076168077168078168079168080168081168082168083168084168085168086168087168088168089168090168091168092168093168094168095168096168097168098168099168100168101168102168103168104168105168106168107168108168109168110168111168112168113168114168115168116168117168118168119168120168121168122168123168124168125168126168127168128168129168130168131168132168133168134168135168136168137168138168139168140168141168142168143168144168145168146168147168148168149168150168151168152168153168154168155168156168157168158168159168160168161168162168163168164168165168166168167168168168169168170168171168172168173168174168175168176168177168178168179168180168181168182168183168184168185168186168187168188168189168190168191168192168193168194168195168196168197168198168199168200168201168202168203168204168205168206168207168208168209168210168211168212168213168214168215168216168217168218168219168220168221168222168223168224168225168226168227168228168229168230168231168232168233168234168235168236168237168238168239168240168241168242168243168244168245168246168247168248168249168250168251168252168253168254168255168256168257168258168259168260168261168262168263168264168265168266168267168268168269168270168271168272168273168274168275168276168277168278168279168280168281168282168283168284168285168286168287168288168289168290168291168292168293168294168295168296168297168298168299168300168301168302168303168304168305168306168307168308168309168310168311168312168313168314168315168316168317168318168319168320168321168322168323168324168325168326168327168328168329168330168331168332168333168334168335168336168337168338168339168340168341168342168343168344168345168346168347168348168349168350168351168352168353168354168355168356168357168358168359168360168361168362168363168364168365168366168367168368168369168370168371168372168373168374168375168376168377168378168379168380168381168382168383168384168385168386168387168388168389168390168391168392168393168394168395168396168397168398168399168400168401168402168403168404168405168406168407168408168409168410168411168412168413168414168415168416168417168418168419168420168421168422168423168424168425168426168427168428168429168430168431168432168433168434168435168436168437168438168439168440168441168442168443168444168445168446168447168448168449168450168451168452168453168454168455168456168457168458168459168460168461168462168463168464168465168466168467168468168469168470168471168472168473168474168475168476168477168478168479168480168481168482168483168484168485168486168487168488168489168490168491168492168493168494168495168496168497168498168499168500168501168502168503168504168505168506168507168508168509168510168511168512168513168514168515168516168517168518168519168520168521168522168523168524168525168526168527168528168529168530168531168532168533168534168535168536168537168538168539168540168541168542168543168544168545168546168547168548168549168550168551168552168553168554168555168556168557168558168559168560168561168562168563168564168565168566168567168568168569168570168571168572168573168574168575168576168577168578168579168580168581168582168583168584168585168586168587168588168589168590168591168592168593168594168595168596168597168598168599168600168601168602168603168604168605168606168607168608168609168610168611168612168613168614168615168616168617168618168619168620168621168622168623168624168625168626168627168628168629168630168631168632168633168634168635168636168637168638168639168640168641168642168643168644168645168646168647168648168649168650168651168652168653168654168655168656168657168658168659168660168661168662168663168664168665168666168667168668168669168670168671168672168673168674168675168676168677168678168679168680168681168682168683168684168685168686168687168688168689168690168691168692168693168694168695168696168697168698168699168700168701168702168703168704168705168706168707168708168709168710168711168712168713168714168715168716168717168718168719168720168721168722168723168724168725168726168727168728168729168730168731168732168733168734168735168736168737168738168739168740168741168742168743168744168745168746168747168748168749168750168751168752168753168754168755168756168757168758168759168760168761168762168763168764168765168766168767168768168769168770168771168772168773168774168775168776168777168778168779168780168781168782168783168784168785168786168787168788168789168790168791168792168793168794168795168796168797168798168799168800168801168802168803168804168805168806168807168808168809168810168811168812168813168814168815168816168817168818168819168820168821168822168823168824168825168826168827168828168829168830168831168832168833168834168835168836168837168838168839168840168841168842168843168844168845168846168847168848168849168850168851168852168853168854168855168856168857168858168859168860168861168862168863168864168865168866168867168868168869168870168871168872168873168874168875168876168877168878168879168880168881168882168883168884168885168886168887168888168889168890168891168892168893168894168895168896168897168898168899168900168901168902168903168904168905168906168907168908168909168910168911168912168913168914168915168916168917168918168919168920168921168922168923168924168925168926168927168928168929168930168931168932168933168934168935168936168937168938168939168940168941168942168943168944168945168946168947168948168949168950168951168952168953168954168955168956168957168958168959168960168961168962168963168964168965168966168967168968168969168970168971168972168973168974168975168976168977168978168979168980168981168982168983168984168985168986168987168988168989168990168991168992168993168994168995168996168997168998168999169000169001169002169003169004169005169006169007169008169009169010169011169012169013169014169015169016169017169018169019169020169021169022169023169024169025169026169027169028169029169030169031169032169033169034169035169036169037169038169039169040169041169042169043169044169045169046169047169048169049169050169051169052169053169054169055169056169057169058169059169060169061169062169063169064169065169066169067169068169069169070169071169072169073169074169075169076169077169078169079169080169081169082169083169084169085169086169087169088169089169090169091169092169093169094169095169096169097169098169099169100169101169102169103169104169105169106169107169108169109169110169111169112169113169114169115169116169117169118169119169120169121169122169123169124169125169126169127169128169129169130169131169132169133169134169135169136169137169138169139169140169141169142169143169144169145169146169147169148169149169150169151169152169153169154169155169156169157169158169159169160169161169162169163169164169165169166169167169168169169169170169171169172169173169174169175169176169177169178169179169180169181169182169183169184169185169186169187169188169189169190169191169192169193169194169195169196169197169198169199169200169201169202169203169204169205169206169207169208169209169210169211169212169213169214169215169216169217169218169219169220169221169222169223169224169225169226169227169228169229169230169231169232169233169234169235169236169237169238169239169240169241169242169243169244169245169246169247169248169249169250169251169252169253169254169255169256169257169258169259169260169261169262169263169264169265169266169267169268169269169270169271169272169273169274169275169276169277169278169279169280169281169282169283169284169285169286169287169288169289169290169291169292169293169294169295169296169297169298169299169300169301169302169303169304169305169306169307169308169309169310169311169312169313169314169315169316169317169318169319169320169321169322169323169324169325169326169327169328169329169330169331169332169333169334169335169336169337169338169339169340169341169342169343169344169345169346169347169348169349169350169351169352169353169354169355169356169357169358169359169360169361169362169363169364169365169366169367169368169369169370169371169372169373169374169375169376169377169378169379169380169381169382169383169384169385169386169387169388169389169390169391169392169393169394169395169396169397169398169399169400169401169402169403169404169405169406169407169408169409169410169411169412169413169414169415169416169417169418169419169420169421169422169423169424169425169426169427169428169429169430169431169432169433169434169435169436169437169438169439169440169441169442169443169444169445169446169447169448169449169450169451169452169453169454169455169456169457169458169459169460169461169462169463169464169465169466169467169468169469169470169471169472169473169474169475169476169477169478169479169480169481169482169483169484169485169486169487169488169489169490169491169492169493169494169495169496169497169498169499169500169501169502169503169504169505169506169507169508169509169510169511169512169513169514169515169516169517169518169519169520169521169522169523169524169525169526169527169528169529169530169531169532169533169534169535169536169537169538169539169540169541169542169543169544169545169546169547169548169549169550169551169552169553169554169555169556169557169558169559169560169561169562169563169564169565169566169567169568169569169570169571169572169573169574169575169576169577169578169579169580169581169582169583169584169585169586169587169588169589169590169591169592169593169594169595169596169597169598169599169600169601169602169603169604169605169606169607169608169609169610169611169612169613169614169615169616169617169618169619169620169621169622169623169624169625169626169627169628169629169630169631169632169633169634169635169636169637169638169639169640169641169642169643169644169645169646169647169648169649169650169651169652169653169654169655169656169657169658169659169660169661169662169663169664169665169666169667169668169669169670169671169672169673169674169675169676169677169678169679169680169681169682169683169684169685169686169687169688169689169690169691169692169693169694169695169696169697169698169699169700169701169702169703169704169705169706169707169708169709169710169711169712169713169714169715169716169717169718169719169720169721169722169723169724169725169726169727169728169729169730169731169732169733169734169735169736169737169738169739169740169741169742169743169744169745169746169747169748169749169750169751169752169753169754169755169756169757169758169759169760169761169762169763169764169765169766169767169768169769169770169771169772169773169774169775169776169777169778169779169780169781169782169783169784169785169786169787169788169789169790169791169792169793169794169795169796169797169798169799169800169801169802169803169804169805169806169807169808169809169810169811169812169813169814169815169816169817169818169819169820169821169822169823169824169825169826169827169828169829169830169831169832169833169834169835169836169837169838169839169840169841169842169843169844169845169846169847169848169849169850169851169852169853169854169855169856169857169858169859169860169861169862169863169864169865169866169867169868169869169870169871169872169873169874169875169876169877169878169879169880169881169882169883169884169885169886169887169888169889169890169891169892169893169894169895169896169897169898169899169900169901169902169903169904169905169906169907169908169909169910169911169912169913169914169915169916169917169918169919169920169921169922169923169924169925169926169927169928169929169930169931169932169933169934169935169936169937169938169939169940169941169942169943169944169945169946169947169948169949169950169951169952169953169954169955169956169957169958169959169960169961169962169963169964169965169966169967169968169969169970169971169972169973169974169975169976169977169978169979169980169981169982169983169984169985169986169987169988169989169990169991169992169993169994169995169996169997169998169999170000170001170002170003170004170005170006170007170008170009170010170011170012170013170014170015170016170017170018170019170020170021170022170023170024170025170026170027170028170029170030170031170032170033170034170035170036170037170038170039170040170041170042170043170044170045170046170047170048170049170050170051170052170053170054170055170056170057170058170059170060170061170062170063170064170065170066170067170068170069170070170071170072170073170074170075170076170077170078170079170080170081170082170083170084170085170086170087170088170089170090170091170092170093170094170095170096170097170098170099170100170101170102170103170104170105170106170107170108170109170110170111170112170113170114170115170116170117170118170119170120170121170122170123170124170125170126170127170128170129170130170131170132170133170134170135170136170137170138170139170140170141170142170143170144170145170146170147170148170149170150170151170152170153170154170155170156170157170158170159170160170161170162170163170164170165170166170167170168170169170170170171170172170173170174170175170176170177170178170179170180170181170182170183170184170185170186170187170188170189170190170191170192170193170194170195170196170197170198170199170200170201170202170203170204170205170206170207170208170209170210170211170212170213170214170215170216170217170218170219170220170221170222170223170224170225170226170227170228170229170230170231170232170233170234170235170236170237170238170239170240170241170242170243170244170245170246170247170248170249170250170251170252170253170254170255170256170257170258170259170260170261170262170263170264170265170266170267170268170269170270170271170272170273170274170275170276170277170278170279170280170281170282170283170284170285170286170287170288170289170290170291170292170293170294170295170296170297170298170299170300170301170302170303170304170305170306170307170308170309170310170311170312170313170314170315170316170317170318170319170320170321170322170323170324170325170326170327170328170329170330170331170332170333170334170335170336170337170338170339170340170341170342170343170344170345170346170347170348170349170350170351170352170353170354170355170356170357170358170359170360170361170362170363170364170365170366170367170368170369170370170371170372170373170374170375170376170377170378170379170380170381170382170383170384170385170386170387170388170389170390170391170392170393170394170395170396170397170398170399170400170401170402170403170404170405170406170407170408170409170410170411170412170413170414170415170416170417170418170419170420170421170422170423170424170425170426170427170428170429170430170431170432170433170434170435170436170437170438170439170440170441170442170443170444170445170446170447170448170449170450170451170452170453170454170455170456170457170458170459170460170461170462170463170464170465170466170467170468170469170470170471170472170473170474170475170476170477170478170479170480170481170482170483170484170485170486170487170488170489170490170491170492170493170494170495170496170497170498170499170500170501170502170503170504170505170506170507170508170509170510170511170512170513170514170515170516170517170518170519170520170521170522170523170524170525170526170527170528170529170530170531170532170533170534170535170536170537170538170539170540170541170542170543170544170545170546170547170548170549170550170551170552170553170554170555170556170557170558170559170560170561170562170563170564170565170566170567170568170569170570170571170572170573170574170575170576170577170578170579170580170581170582170583170584170585170586170587170588170589170590170591170592170593170594170595170596170597170598170599170600170601170602170603170604170605170606170607170608170609170610170611170612170613170614170615170616170617170618170619170620170621170622170623170624170625170626170627170628170629170630170631170632170633170634170635170636170637170638170639170640170641170642170643170644170645170646170647170648170649170650170651170652170653170654170655170656170657170658170659170660170661170662170663170664170665170666170667170668170669170670170671170672170673170674170675170676170677170678170679170680170681170682170683170684170685170686170687170688170689170690170691170692170693170694170695170696170697170698170699170700170701170702170703170704170705170706170707170708170709170710170711170712170713170714170715170716170717170718170719170720170721170722170723170724170725170726170727170728170729170730170731170732170733170734170735170736170737170738170739170740170741170742170743170744170745170746170747170748170749170750170751170752170753170754170755170756170757170758170759170760170761170762170763170764170765170766170767170768170769170770170771170772170773170774170775170776170777170778170779170780170781170782170783170784170785170786170787170788170789170790170791170792170793170794170795170796170797170798170799170800170801170802170803170804170805170806170807170808170809170810170811170812170813170814170815170816170817170818170819170820170821170822170823170824170825170826170827170828170829170830170831170832170833170834170835170836170837170838170839170840170841170842170843170844170845170846170847170848170849170850170851170852170853170854170855170856170857170858170859170860170861170862170863170864170865170866170867170868170869170870170871170872170873170874170875170876170877170878170879170880170881170882170883170884170885170886170887170888170889170890170891170892170893170894170895170896170897170898170899170900170901170902170903170904170905170906170907170908170909170910170911170912170913170914170915170916170917170918170919170920170921170922170923170924170925170926170927170928170929170930170931170932170933170934170935170936170937170938170939170940170941170942170943170944170945170946170947170948170949170950170951170952170953170954170955170956170957170958170959170960170961170962170963170964170965170966170967170968170969170970170971170972170973170974170975170976170977170978170979170980170981170982170983170984170985170986170987170988170989170990170991170992170993170994170995170996170997170998170999171000171001171002171003171004171005171006171007171008171009171010171011171012171013171014171015171016171017171018171019171020171021171022171023171024171025171026171027171028171029171030171031171032171033171034171035171036171037171038171039171040171041171042171043171044171045171046171047171048171049171050171051171052171053171054171055171056171057171058171059171060171061171062171063171064171065171066171067171068171069171070171071171072171073171074171075171076171077171078171079171080171081171082171083171084171085171086171087171088171089171090171091171092171093171094171095171096171097171098171099171100171101171102171103171104171105171106171107171108171109171110171111171112171113171114171115171116171117171118171119171120171121171122171123171124171125171126171127171128171129171130171131171132171133171134171135171136171137171138171139171140171141171142171143171144171145171146171147171148171149171150171151171152171153171154171155171156171157171158171159171160171161171162171163171164171165171166171167171168171169171170171171171172171173171174171175171176171177171178171179171180171181171182171183171184171185171186171187171188171189171190171191171192171193171194171195171196171197171198171199171200171201171202171203171204171205171206171207171208171209171210171211171212171213171214171215171216171217171218171219171220171221171222171223171224171225171226171227171228171229171230171231171232171233171234171235171236171237171238171239171240171241171242171243171244171245171246171247171248171249171250171251171252171253171254171255171256171257171258171259171260171261171262171263171264171265171266171267171268171269171270171271171272171273171274171275171276171277171278171279171280171281171282171283171284171285171286171287171288171289171290171291171292171293171294171295171296171297171298171299171300171301171302171303171304171305171306171307171308171309171310171311171312171313171314171315171316171317171318171319171320171321171322171323171324171325171326171327171328171329171330171331171332171333171334171335171336171337171338171339171340171341171342171343171344171345171346171347171348171349171350171351171352171353171354171355171356171357171358171359171360171361171362171363171364171365171366171367171368171369171370171371171372171373171374171375171376171377171378171379171380171381171382171383171384171385171386171387171388171389171390171391171392171393171394171395171396171397171398171399171400171401171402171403171404171405171406171407171408171409171410171411171412171413171414171415171416171417171418171419171420171421171422171423171424171425171426171427171428171429171430171431171432171433171434171435171436171437171438171439171440171441171442171443171444171445171446171447171448171449171450171451171452171453171454171455171456171457171458171459171460171461171462171463171464171465171466171467171468171469171470171471171472171473171474171475171476171477171478171479171480171481171482171483171484171485171486171487171488171489171490171491171492171493171494171495171496171497171498171499171500171501171502171503171504171505171506171507171508171509171510171511171512171513171514171515171516171517171518171519171520171521171522171523171524171525171526171527171528171529171530171531171532171533171534171535171536171537171538171539171540171541171542171543171544171545171546171547171548171549171550171551171552171553171554171555171556171557171558171559171560171561171562171563171564171565171566171567171568171569171570171571171572171573171574171575171576171577171578171579171580171581171582171583171584171585171586171587171588171589171590171591171592171593171594171595171596171597171598171599171600171601171602171603171604171605171606171607171608171609171610171611171612171613171614171615171616171617171618171619171620171621171622171623171624171625171626171627171628171629171630171631171632171633171634171635171636171637171638171639171640171641171642171643171644171645171646171647171648171649171650171651171652171653171654171655171656171657171658171659171660171661171662171663171664171665171666171667171668171669171670171671171672171673171674171675171676171677171678171679171680171681171682171683171684171685171686171687171688171689171690171691171692171693171694171695171696171697171698171699171700171701171702171703171704171705171706171707171708171709171710171711171712171713171714171715171716171717171718171719171720171721171722171723171724171725171726171727171728171729171730171731171732171733171734171735171736171737171738171739171740171741171742171743171744171745171746171747171748171749171750171751171752171753171754171755171756171757171758171759171760171761171762171763171764171765171766171767171768171769171770171771171772171773171774171775171776171777171778171779171780171781171782171783171784171785171786171787171788171789171790171791171792171793171794171795171796171797171798171799171800171801171802171803171804171805171806171807171808171809171810171811171812171813171814171815171816171817171818171819171820171821171822171823171824171825171826171827171828171829171830171831171832171833171834171835171836171837171838171839171840171841171842171843171844171845171846171847171848171849171850171851171852171853171854171855171856171857171858171859171860171861171862171863171864171865171866171867171868171869171870171871171872171873171874171875171876171877171878171879171880171881171882171883171884171885171886171887171888171889171890171891171892171893171894171895171896171897171898171899171900171901171902171903171904171905171906171907171908171909171910171911171912171913171914171915171916171917171918171919171920171921171922171923171924171925171926171927171928171929171930171931171932171933171934171935171936171937171938171939171940171941171942171943171944171945171946171947171948171949171950171951171952171953171954171955171956171957171958171959171960171961171962171963171964171965171966171967171968171969171970171971171972171973171974171975171976171977171978171979171980171981171982171983171984171985171986171987171988171989171990171991171992171993171994171995171996171997171998171999172000172001172002172003172004172005172006172007172008172009172010172011172012172013172014172015172016172017172018172019172020172021172022172023172024172025172026172027172028172029172030172031172032172033172034172035172036172037172038172039172040172041172042172043172044172045172046172047172048172049172050172051172052172053172054172055172056172057172058172059172060172061172062172063172064172065172066172067172068172069172070172071172072172073172074172075172076172077172078172079172080172081172082172083172084172085172086172087172088172089172090172091172092172093172094172095172096172097172098172099172100172101172102172103172104172105172106172107172108172109172110172111172112172113172114172115172116172117172118172119172120172121172122172123172124172125172126172127172128172129172130172131172132172133172134172135172136172137172138172139172140172141172142172143172144172145172146172147172148172149172150172151172152172153172154172155172156172157172158172159172160172161172162172163172164172165172166172167172168172169172170172171172172172173172174172175172176172177172178172179172180172181172182172183172184172185172186172187172188172189172190172191172192172193172194172195172196172197172198172199172200172201172202172203172204172205172206172207172208172209172210172211172212172213172214172215172216172217172218172219172220172221172222172223172224172225172226172227172228172229172230172231172232172233172234172235172236172237172238172239172240172241172242172243172244172245172246172247172248172249172250172251172252172253172254172255172256172257172258172259172260172261172262172263172264172265172266172267172268172269172270172271172272172273172274172275172276172277172278172279172280172281172282172283172284172285172286172287172288172289172290172291172292172293172294172295172296172297172298172299172300172301172302172303172304172305172306172307172308172309172310172311172312172313172314172315172316172317172318172319172320172321172322172323172324172325172326172327172328172329172330172331172332172333172334172335172336172337172338172339172340172341172342172343172344172345172346172347172348172349172350172351172352172353172354172355172356172357172358172359172360172361172362172363172364172365172366172367172368172369172370172371172372172373172374172375172376172377172378172379172380172381172382172383172384172385172386172387172388172389172390172391172392172393172394172395172396172397172398172399172400172401172402172403172404172405172406172407172408172409172410172411172412172413172414172415172416172417172418172419172420172421172422172423172424172425172426172427172428172429172430172431172432172433172434172435172436172437172438172439172440172441172442172443172444172445172446172447172448172449172450172451172452172453172454172455172456172457172458172459172460172461172462172463172464172465172466172467172468172469172470172471172472172473172474172475172476172477172478172479172480172481172482172483172484172485172486172487172488172489172490172491172492172493172494172495172496172497172498172499172500172501172502172503172504172505172506172507172508172509172510172511172512172513172514172515172516172517172518172519172520172521172522172523172524172525172526172527172528172529172530172531172532172533172534172535172536172537172538172539172540172541172542172543172544172545172546172547172548172549172550172551172552172553172554172555172556172557172558172559172560172561172562172563172564172565172566172567172568172569172570172571172572172573172574172575172576172577172578172579172580172581172582172583172584172585172586172587172588172589172590172591172592172593172594172595172596172597172598172599172600172601172602172603172604172605172606172607172608172609172610172611172612172613172614172615172616172617172618172619172620172621172622172623172624172625172626172627172628172629172630172631172632172633172634172635172636172637172638172639172640172641172642172643172644172645172646172647172648172649172650172651172652172653172654172655172656172657172658172659172660172661172662172663172664172665172666172667172668172669172670172671172672172673172674172675172676172677172678172679172680172681172682172683172684172685172686172687172688172689172690172691172692172693172694172695172696172697172698172699172700172701172702172703172704172705172706172707172708172709172710172711172712172713172714172715172716172717172718172719172720172721172722172723172724172725172726172727172728172729172730172731172732172733172734172735172736172737172738172739172740172741172742172743172744172745172746172747172748172749172750172751172752172753172754172755172756172757172758172759172760172761172762172763172764172765172766172767172768172769172770172771172772172773172774172775172776172777172778172779172780172781172782172783172784172785172786172787172788172789172790172791172792172793172794172795172796172797172798172799172800172801172802172803172804172805172806172807172808172809172810172811172812172813172814172815172816172817172818172819172820172821172822172823172824172825172826172827172828172829172830172831172832172833172834172835172836172837172838172839172840172841172842172843172844172845172846172847172848172849172850172851172852172853172854172855172856172857172858172859172860172861172862172863172864172865172866172867172868172869172870172871172872172873172874172875172876172877172878172879172880172881172882172883172884172885172886172887172888172889172890172891172892172893172894172895172896172897172898172899172900172901172902172903172904172905172906172907172908172909172910172911172912172913172914172915172916172917172918172919172920172921172922172923172924172925172926172927172928172929172930172931172932172933172934172935172936172937172938172939172940172941172942172943172944172945172946172947172948172949172950172951172952172953172954172955172956172957172958172959172960172961172962172963172964172965172966172967172968172969172970172971172972172973172974172975172976172977172978172979172980172981172982172983172984172985172986172987172988172989172990172991172992172993172994172995172996172997172998172999173000173001173002173003173004173005173006173007173008173009173010173011173012173013173014173015173016173017173018173019173020173021173022173023173024173025173026173027173028173029173030173031173032173033173034173035173036173037173038173039173040173041173042173043173044173045173046173047173048173049173050173051173052173053173054173055173056173057173058173059173060173061173062173063173064173065173066173067173068173069173070173071173072173073173074173075173076173077173078173079173080173081173082173083173084173085173086173087173088173089173090173091173092173093173094173095173096173097173098173099173100173101173102173103173104173105173106173107173108173109173110173111173112173113173114173115173116173117173118173119173120173121173122173123173124173125173126173127173128173129173130173131173132173133173134173135173136173137173138173139173140173141173142173143173144173145173146173147173148173149173150173151173152173153173154173155173156173157173158173159173160173161173162173163173164173165173166173167173168173169173170173171173172173173173174173175173176173177173178173179173180173181173182173183173184173185173186173187173188173189173190173191173192173193173194173195173196173197173198173199173200173201173202173203173204173205173206173207173208173209173210173211173212173213173214173215173216173217173218173219173220173221173222173223173224173225173226173227173228173229173230173231173232173233173234173235173236173237173238173239173240173241173242173243173244173245173246173247173248173249173250173251173252173253173254173255173256173257173258173259173260173261173262173263173264173265173266173267173268173269173270173271173272173273173274173275173276173277173278173279173280173281173282173283173284173285173286173287173288173289173290173291173292173293173294173295173296173297173298173299173300173301173302173303173304173305173306173307173308173309173310173311173312173313173314173315173316173317173318173319173320173321173322173323173324173325173326173327173328173329173330173331173332173333173334173335173336173337173338173339173340173341173342173343173344173345173346173347173348173349173350173351173352173353173354173355173356173357173358173359173360173361173362173363173364173365173366173367173368173369173370173371173372173373173374173375173376173377173378173379173380173381173382173383173384173385173386173387173388173389173390173391173392173393173394173395173396173397173398173399173400173401173402173403173404173405173406173407173408173409173410173411173412173413173414173415173416173417173418173419173420173421173422173423173424173425173426173427173428173429173430173431173432173433173434173435173436173437173438173439173440173441173442173443173444173445173446173447173448173449173450173451173452173453173454173455173456173457173458173459173460173461173462173463173464173465173466173467173468173469173470173471173472173473173474173475173476173477173478173479173480173481173482173483173484173485173486173487173488173489173490173491173492173493173494173495173496173497173498173499173500173501173502173503173504173505173506173507173508173509173510173511173512173513173514173515173516173517173518173519173520173521173522173523173524173525173526173527173528173529173530173531173532173533173534173535173536173537173538173539173540173541173542173543173544173545173546173547173548173549173550173551173552173553173554173555173556173557173558173559173560173561173562173563173564173565173566173567173568173569173570173571173572173573173574173575173576173577173578173579173580173581173582173583173584173585173586173587173588173589173590173591173592173593173594173595173596173597173598173599173600173601173602173603173604173605173606173607173608173609173610173611173612173613173614173615173616173617173618173619173620173621173622173623173624173625173626173627173628173629173630173631173632173633173634173635173636173637173638173639173640173641173642173643173644173645173646173647173648173649173650173651173652173653173654173655173656173657173658173659173660173661173662173663173664173665173666173667173668173669173670173671173672173673173674173675173676173677173678173679173680173681173682173683173684173685173686173687173688173689173690173691173692173693173694173695173696173697173698173699173700173701173702173703173704173705173706173707173708173709173710173711173712173713173714173715173716173717173718173719173720173721173722173723173724173725173726173727173728173729173730173731173732173733173734173735173736173737173738173739173740173741173742173743173744173745173746173747173748173749173750173751173752173753173754173755173756173757173758173759173760173761173762173763173764173765173766173767173768173769173770173771173772173773173774173775173776173777173778173779173780173781173782173783173784173785173786173787173788173789173790173791173792173793173794173795173796173797173798173799173800173801173802173803173804173805173806173807173808173809173810173811173812173813173814173815173816173817173818173819173820173821173822173823173824173825173826173827173828173829173830173831173832173833173834173835173836173837173838173839173840173841173842173843173844173845173846173847173848173849173850173851173852173853173854173855173856173857173858173859173860173861173862173863173864173865173866173867173868173869173870173871173872173873173874173875173876173877173878173879173880173881173882173883173884173885173886173887173888173889173890173891173892173893173894173895173896173897173898173899173900173901173902173903173904173905173906173907173908173909173910173911173912173913173914173915173916173917173918173919173920173921173922173923173924173925173926173927173928173929173930173931173932173933173934173935173936173937173938173939173940173941173942173943173944173945173946173947173948173949173950173951173952173953173954173955173956173957173958173959173960173961173962173963173964173965173966173967173968173969173970173971173972173973173974173975173976173977173978173979173980173981173982173983173984173985173986173987173988173989173990173991173992173993173994173995173996173997173998173999174000174001174002174003174004174005174006174007174008174009174010174011174012174013174014174015174016174017174018174019174020174021174022174023174024174025174026174027174028174029174030174031174032174033174034174035174036174037174038174039174040174041174042174043174044174045174046174047174048174049174050174051174052174053174054174055174056174057174058174059174060174061174062174063174064174065174066174067174068174069174070174071174072174073174074174075174076174077174078174079174080174081174082174083174084174085174086174087174088174089174090174091174092174093174094174095174096174097174098174099174100174101174102174103174104174105174106174107174108174109174110174111174112174113174114174115174116174117174118174119174120174121174122174123174124174125174126174127174128174129174130174131174132174133174134174135174136174137174138174139174140174141174142174143174144174145174146174147174148174149174150174151174152174153174154174155174156174157174158174159174160174161174162174163174164174165174166174167174168174169174170174171174172174173174174174175174176174177174178174179174180174181174182174183174184174185174186174187174188174189174190174191174192174193174194174195174196174197174198174199174200174201174202174203174204174205174206174207174208174209174210174211174212174213174214174215174216174217174218174219174220174221174222174223174224174225174226174227174228174229174230174231174232174233174234174235174236174237174238174239174240174241174242174243174244174245174246174247174248174249174250174251174252174253174254174255174256174257174258174259174260174261174262174263174264174265174266174267174268174269174270174271174272174273174274174275174276174277174278174279174280174281174282174283174284174285174286174287174288174289174290174291174292174293174294174295174296174297174298174299174300174301174302174303174304174305174306174307174308174309174310174311174312174313174314174315174316174317174318174319174320174321174322174323174324174325174326174327174328174329174330174331174332174333174334174335174336174337174338174339174340174341174342174343174344174345174346174347174348174349174350174351174352174353174354174355174356174357174358174359174360174361174362174363174364174365174366174367174368174369174370174371174372174373174374174375174376174377174378174379174380174381174382174383174384174385174386174387174388174389174390174391174392174393174394174395174396174397174398174399174400174401174402174403174404174405174406174407174408174409174410174411174412174413174414174415174416174417174418174419174420174421174422174423174424174425174426174427174428174429174430174431174432174433174434174435174436174437174438174439174440174441174442174443174444174445174446174447174448174449174450174451174452174453174454174455174456174457174458174459174460174461174462174463174464174465174466174467174468174469174470174471174472174473174474174475174476174477174478174479174480174481174482174483174484174485174486174487174488174489174490174491174492174493174494174495174496174497174498174499174500174501174502174503174504174505174506174507174508174509174510174511174512174513174514174515174516174517174518174519174520174521174522174523174524174525174526174527174528174529174530174531174532174533174534174535174536174537174538174539174540174541174542174543174544174545174546174547174548174549174550174551174552174553174554174555174556174557174558174559174560174561174562174563174564174565174566174567174568174569174570174571174572174573174574174575174576174577174578174579174580174581174582174583174584174585174586174587174588174589174590174591174592174593174594174595174596174597174598174599174600174601174602174603174604174605174606174607174608174609174610174611174612174613174614174615174616174617174618174619174620174621174622174623174624174625174626174627174628174629174630174631174632174633174634174635174636174637174638174639174640174641174642174643174644174645174646174647174648174649174650174651174652174653174654174655174656174657174658174659174660174661174662174663174664174665174666174667174668174669174670174671174672174673174674174675174676174677174678174679174680174681174682174683174684174685174686174687174688174689174690174691174692174693174694174695174696174697174698174699174700174701174702174703174704174705174706174707174708174709174710174711174712174713174714174715174716174717174718174719174720174721174722174723174724174725174726174727174728174729174730174731174732174733174734174735174736174737174738174739174740174741174742174743174744174745174746174747174748174749174750174751174752174753174754174755174756174757174758174759174760174761174762174763174764174765174766174767174768174769174770174771174772174773174774174775174776174777174778174779174780174781174782174783174784174785174786174787174788174789174790174791174792174793174794174795174796174797174798174799174800174801174802174803174804174805174806174807174808174809174810174811174812174813174814174815174816174817174818174819174820174821174822174823174824174825174826174827174828174829174830174831174832174833174834174835174836174837174838174839174840174841174842174843174844174845174846174847174848174849174850174851174852174853174854174855174856174857174858174859174860174861174862174863174864174865174866174867174868174869174870174871174872174873174874174875174876174877174878174879174880174881174882174883174884174885174886174887174888174889174890174891174892174893174894174895174896174897174898174899174900174901174902174903174904174905174906174907174908174909174910174911174912174913174914174915174916174917174918174919174920174921174922174923174924174925174926174927174928174929174930174931174932174933174934174935174936174937174938174939174940174941174942174943174944174945174946174947174948174949174950174951174952174953174954174955174956174957174958174959174960174961174962174963174964174965174966174967174968174969174970174971174972174973174974174975174976174977174978174979174980174981174982174983174984174985174986174987174988174989174990174991174992174993174994174995174996174997174998174999175000175001175002175003175004175005175006175007175008175009175010175011175012175013175014175015175016175017175018175019175020175021175022175023175024175025175026175027175028175029175030175031175032175033175034175035175036175037175038175039175040175041175042175043175044175045175046175047175048175049175050175051175052175053175054175055175056175057175058175059175060175061175062175063175064175065175066175067175068175069175070175071175072175073175074175075175076175077175078175079175080175081175082175083175084175085175086175087175088175089175090175091175092175093175094175095175096175097175098175099175100175101175102175103175104175105175106175107175108175109175110175111175112175113175114175115175116175117175118175119175120175121175122175123175124175125175126175127175128175129175130175131175132175133175134175135175136175137175138175139175140175141175142175143175144175145175146175147175148175149175150175151175152175153175154175155175156175157175158175159175160175161175162175163175164175165175166175167175168175169175170175171175172175173175174175175175176175177175178175179175180175181175182175183175184175185175186175187175188175189175190175191175192175193175194175195175196175197175198175199175200175201175202175203175204175205175206175207175208175209175210175211175212175213175214175215175216175217175218175219175220175221175222175223175224175225175226175227175228175229175230175231175232175233175234175235175236175237175238175239175240175241175242175243175244175245175246175247175248175249175250175251175252175253175254175255175256175257175258175259175260175261175262175263175264175265175266175267175268175269175270175271175272175273175274175275175276175277175278175279175280175281175282175283175284175285175286175287175288175289175290175291175292175293175294175295175296175297175298175299175300175301175302175303175304175305175306175307175308175309175310175311175312175313175314175315175316175317175318175319175320175321175322175323175324175325175326175327175328175329175330175331175332175333175334175335175336175337175338175339175340175341175342175343175344175345175346175347175348175349175350175351175352175353175354175355175356175357175358175359175360175361175362175363175364175365175366175367175368175369175370175371175372175373175374175375175376175377175378175379175380175381175382175383175384175385175386175387175388175389175390175391175392175393175394175395175396175397175398175399175400175401175402175403175404175405175406175407175408175409175410175411175412175413175414175415175416175417175418175419175420175421175422175423175424175425175426175427175428175429175430175431175432175433175434175435175436175437175438175439175440175441175442175443175444175445175446175447175448175449175450175451175452175453175454175455175456175457175458175459175460175461175462175463175464175465175466175467175468175469175470175471175472175473175474175475175476175477175478175479175480175481175482175483175484175485175486175487175488175489175490175491175492175493175494175495175496175497175498175499175500175501175502175503175504175505175506175507175508175509175510175511175512175513175514175515175516175517175518175519175520175521175522175523175524175525175526175527175528175529175530175531175532175533175534175535175536175537175538175539175540175541175542175543175544175545175546175547175548175549175550175551175552175553175554175555175556175557175558175559175560175561175562175563175564175565175566175567175568175569175570175571175572175573175574175575175576175577175578175579175580175581175582175583175584175585175586175587175588175589175590175591175592175593175594175595175596175597175598175599175600175601175602175603175604175605175606175607175608175609175610175611175612175613175614175615175616175617175618175619175620175621175622175623175624175625175626175627175628175629175630175631175632175633175634175635175636175637175638175639175640175641175642175643175644175645175646175647175648175649175650175651175652175653175654175655175656175657175658175659175660175661175662175663175664175665175666175667175668175669175670175671175672175673175674175675175676175677175678175679175680175681175682175683175684175685175686175687175688175689175690175691175692175693175694175695175696175697175698175699175700175701175702175703175704175705175706175707175708175709175710175711175712175713175714175715175716175717175718175719175720175721175722175723175724175725175726175727175728175729175730175731175732175733175734175735175736175737175738175739175740175741175742175743175744175745175746175747175748175749175750175751175752175753175754175755175756175757175758175759175760175761175762175763175764175765175766175767175768175769175770175771175772175773175774175775175776175777175778175779175780175781175782175783175784175785175786175787175788175789175790175791175792175793175794175795175796175797175798175799175800175801175802175803175804175805175806175807175808175809175810175811175812175813175814175815175816175817175818175819175820175821175822175823175824175825175826175827175828175829175830175831175832175833175834175835175836175837175838175839175840175841175842175843175844175845175846175847175848175849175850175851175852175853175854175855175856175857175858175859175860175861175862175863175864175865175866175867175868175869175870175871175872175873175874175875175876175877175878175879175880175881175882175883175884175885175886175887175888175889175890175891175892175893175894175895175896175897175898175899175900175901175902175903175904175905175906175907175908175909175910175911175912175913175914175915175916175917175918175919175920175921175922175923175924175925175926175927175928175929175930175931175932175933175934175935175936175937175938175939175940175941175942175943175944175945175946175947175948175949175950175951175952175953175954175955175956175957175958175959175960175961175962175963175964175965175966175967175968175969175970175971175972175973175974175975175976175977175978175979175980175981175982175983175984175985175986175987175988175989175990175991175992175993175994175995175996175997175998175999176000176001176002176003176004176005176006176007176008176009176010176011176012176013176014176015176016176017176018176019176020176021176022176023176024176025176026176027176028176029176030176031176032176033176034176035176036176037176038176039176040176041176042176043176044176045176046176047176048176049176050176051176052176053176054176055176056176057176058176059176060176061176062176063176064176065176066176067176068176069176070176071176072176073176074176075176076176077176078176079176080176081176082176083176084176085176086176087176088176089176090176091176092176093176094176095176096176097176098176099176100176101176102176103176104176105176106176107176108176109176110176111176112176113176114176115176116176117176118176119176120176121176122176123176124176125176126176127176128176129176130176131176132176133176134176135176136176137176138176139176140176141176142176143176144176145176146176147176148176149176150176151176152176153176154176155176156176157176158176159176160176161176162176163176164176165176166176167176168176169176170176171176172176173176174176175176176176177176178176179176180176181176182176183176184176185176186176187176188176189176190176191176192176193176194176195176196176197176198176199176200176201176202176203176204176205176206176207176208176209176210176211176212176213176214176215176216176217176218176219176220176221176222176223176224176225176226176227176228176229176230176231176232176233176234176235176236176237176238176239176240176241176242176243176244176245176246176247176248176249176250176251176252176253176254176255176256176257176258176259176260176261176262176263176264176265176266176267176268176269176270176271176272176273176274176275176276176277176278176279176280176281176282176283176284176285176286176287176288176289176290176291176292176293176294176295176296176297176298176299176300176301176302176303176304176305176306176307176308176309176310176311176312176313176314176315176316176317176318176319176320176321176322176323176324176325176326176327176328176329176330176331176332176333176334176335176336176337176338176339176340176341176342176343176344176345176346176347176348176349176350176351176352176353176354176355176356176357176358176359176360176361176362176363176364176365176366176367176368176369176370176371176372176373176374176375176376176377176378176379176380176381176382176383176384176385176386176387176388176389176390176391176392176393176394176395176396176397176398176399176400176401176402176403176404176405176406176407176408176409176410176411176412176413176414176415176416176417176418176419176420176421176422176423176424176425176426176427176428176429176430176431176432176433176434176435176436176437176438176439176440176441176442176443176444176445176446176447176448176449176450176451176452176453176454176455176456176457176458176459176460176461176462176463176464176465176466176467176468176469176470176471176472176473176474176475176476176477176478176479176480176481176482176483176484176485176486176487176488176489176490176491176492176493176494176495176496176497176498176499176500176501176502176503176504176505176506176507176508176509176510176511176512176513176514176515176516176517176518176519176520176521176522176523176524176525176526176527176528176529176530176531176532176533176534176535176536176537176538176539176540176541176542176543176544176545176546176547176548176549176550176551176552176553176554176555176556176557176558176559176560176561176562176563176564176565176566176567176568176569176570176571176572176573176574176575176576176577176578176579176580176581176582176583176584176585176586176587176588176589176590176591176592176593176594176595176596176597176598176599176600176601176602176603176604176605176606176607176608176609176610176611176612176613176614176615176616176617176618176619176620176621176622176623176624176625176626176627176628176629176630176631176632176633176634176635176636176637176638176639176640176641176642176643176644176645176646176647176648176649176650176651176652176653176654176655176656176657176658176659176660176661176662176663176664176665176666176667176668176669176670176671176672176673176674176675176676176677176678176679176680176681176682176683176684176685176686176687176688176689176690176691176692176693176694176695176696176697176698176699176700176701176702176703176704176705176706176707176708176709176710176711176712176713176714176715176716176717176718176719176720176721176722176723176724176725176726176727176728176729176730176731176732176733176734176735176736176737176738176739176740176741176742176743176744176745176746176747176748176749176750176751176752176753176754176755176756176757176758176759176760176761176762176763176764176765176766176767176768176769176770176771176772176773176774176775176776176777176778176779176780176781176782176783176784176785176786176787176788176789176790176791176792176793176794176795176796176797176798176799176800176801176802176803176804176805176806176807176808176809176810176811176812176813176814176815176816176817176818176819176820176821176822176823176824176825176826176827176828176829176830176831176832176833176834176835176836176837176838176839176840176841176842176843176844176845176846176847176848176849176850176851176852176853176854176855176856176857176858176859176860176861176862176863176864176865176866176867176868176869176870176871176872176873176874176875176876176877176878176879176880176881176882176883176884176885176886176887176888176889176890176891176892176893176894176895176896176897176898176899176900176901176902176903176904176905176906176907176908176909176910176911176912176913176914176915176916176917176918176919176920176921176922176923176924176925176926176927176928176929176930176931176932176933176934176935176936176937176938176939176940176941176942176943176944176945176946176947176948176949176950176951176952176953176954176955176956176957176958176959176960176961176962176963176964176965176966176967176968176969176970176971176972176973176974176975176976176977176978176979176980176981176982176983176984176985176986176987176988176989176990176991176992176993176994176995176996176997176998176999177000177001177002177003177004177005177006177007177008177009177010177011177012177013177014177015177016177017177018177019177020177021177022177023177024177025177026177027177028177029177030177031177032177033177034177035177036177037177038177039177040177041177042177043177044177045177046177047177048177049177050177051177052177053177054177055177056177057177058177059177060177061177062177063177064177065177066177067177068177069177070177071177072177073177074177075177076177077177078177079177080177081177082177083177084177085177086177087177088177089177090177091177092177093177094177095177096177097177098177099177100177101177102177103177104177105177106177107177108177109177110177111177112177113177114177115177116177117177118177119177120177121177122177123177124177125177126177127177128177129177130177131177132177133177134177135177136177137177138177139177140177141177142177143177144177145177146177147177148177149177150177151177152177153177154177155177156177157177158177159177160177161177162177163177164177165177166177167177168177169177170177171177172177173177174177175177176177177177178177179177180177181177182177183177184177185177186177187177188177189177190177191177192177193177194177195177196177197177198177199177200177201177202177203177204177205177206177207177208177209177210177211177212177213177214177215177216177217177218177219177220177221177222177223177224177225177226177227177228177229177230177231177232177233177234177235177236177237177238177239177240177241177242177243177244177245177246177247177248177249177250177251177252177253177254177255177256177257177258177259177260177261177262177263177264177265177266177267177268177269177270177271177272177273177274177275177276177277177278177279177280177281177282177283177284177285177286177287177288177289177290177291177292177293177294177295177296177297177298177299177300177301177302177303177304177305177306177307177308177309177310177311177312177313177314177315177316177317177318177319177320177321177322177323177324177325177326177327177328177329177330177331177332177333177334177335177336177337177338177339177340177341177342177343177344177345177346177347177348177349177350177351177352177353177354177355177356177357177358177359177360177361177362177363177364177365177366177367177368177369177370177371177372177373177374177375177376177377177378177379177380177381177382177383177384177385177386177387177388177389177390177391177392177393177394177395177396177397177398177399177400177401177402177403177404177405177406177407177408177409177410177411177412177413177414177415177416177417177418177419177420177421177422177423177424177425177426177427177428177429177430177431177432177433177434177435177436177437177438177439177440177441177442177443177444177445177446177447177448177449177450177451177452177453177454177455177456177457177458177459177460177461177462177463177464177465177466177467177468177469177470177471177472177473177474177475177476177477177478177479177480177481177482177483177484177485177486177487177488177489177490177491177492177493177494177495177496177497177498177499177500177501177502177503177504177505177506177507177508177509177510177511177512177513177514177515177516177517177518177519177520177521177522177523177524177525177526177527177528177529177530177531177532177533177534177535177536177537177538177539177540177541177542177543177544177545177546177547177548177549177550177551177552177553177554177555177556177557177558177559177560177561177562177563177564177565177566177567177568177569177570177571177572177573177574177575177576177577177578177579177580177581177582177583177584177585177586177587177588177589177590177591177592177593177594177595177596177597177598177599177600177601177602177603177604177605177606177607177608177609177610177611177612177613177614177615177616177617177618177619177620177621177622177623177624177625177626177627177628177629177630177631177632177633177634177635177636177637177638177639177640177641177642177643177644177645177646177647177648177649177650177651177652177653177654177655177656177657177658177659177660177661177662177663177664177665177666177667177668177669177670177671177672177673177674177675177676177677177678177679177680177681177682177683177684177685177686177687177688177689177690177691177692177693177694177695177696177697177698177699177700177701177702177703177704177705177706177707177708177709177710177711177712177713177714177715177716177717177718177719177720177721177722177723177724177725177726177727177728177729177730177731177732177733177734177735177736177737177738177739177740177741177742177743177744177745177746177747177748177749177750177751177752177753177754177755177756177757177758177759177760177761177762177763177764177765177766177767177768177769177770177771177772177773177774177775177776177777177778177779177780177781177782177783177784177785177786177787177788177789177790177791177792177793177794177795177796177797177798177799177800177801177802177803177804177805177806177807177808177809177810177811177812177813177814177815177816177817177818177819177820177821177822177823177824177825177826177827177828177829177830177831177832177833177834177835177836177837177838177839177840177841177842177843177844177845177846177847177848177849177850177851177852177853177854177855177856177857177858177859177860177861177862177863177864177865177866177867177868177869177870177871177872177873177874177875177876177877177878177879177880177881177882177883177884177885177886177887177888177889177890177891177892177893177894177895177896177897177898177899177900177901177902177903177904177905177906177907177908177909177910177911177912177913177914177915177916177917177918177919177920177921177922177923177924177925177926177927177928177929177930177931177932177933177934177935177936177937177938177939177940177941177942177943177944177945177946177947177948177949177950177951177952177953177954177955177956177957177958177959177960177961177962177963177964177965177966177967177968177969177970177971177972177973177974177975177976177977177978177979177980177981177982177983177984177985177986177987177988177989177990177991177992177993177994177995177996177997177998177999178000178001178002178003178004178005178006178007178008178009178010178011178012178013178014178015178016178017178018178019178020178021178022178023178024178025178026178027178028178029178030178031178032178033178034178035178036178037178038178039178040178041178042178043178044178045178046178047178048178049178050178051178052178053178054178055178056178057178058178059178060178061178062178063178064178065178066178067178068178069178070178071178072178073178074178075178076178077178078178079178080178081178082178083178084178085178086178087178088178089178090178091178092178093178094178095178096178097178098178099178100178101178102178103178104178105178106178107178108178109178110178111178112178113178114178115178116178117178118178119178120178121178122178123178124178125178126178127178128178129178130178131178132178133178134178135178136178137178138178139178140178141178142178143178144178145178146178147178148178149178150178151178152178153178154178155178156178157178158178159178160178161178162178163178164178165178166178167178168178169178170178171178172178173178174178175178176178177178178178179178180178181178182178183178184178185178186178187178188178189178190178191178192178193178194178195178196178197178198178199178200178201178202178203178204178205178206178207178208178209178210178211178212178213178214178215178216178217178218178219178220178221178222178223178224178225178226178227178228178229178230178231178232178233178234178235178236178237178238178239178240178241178242178243178244178245178246178247178248178249178250178251178252178253178254178255178256178257178258178259178260178261178262178263178264178265178266178267178268178269178270178271178272178273178274178275178276178277178278178279178280178281178282178283178284178285178286178287178288178289178290178291178292178293178294178295178296178297178298178299178300178301178302178303178304178305178306178307178308178309178310178311178312178313178314178315178316178317178318178319178320178321178322178323178324178325178326178327178328178329178330178331178332178333178334178335178336178337178338178339178340178341178342178343178344178345178346178347178348178349178350178351178352178353178354178355178356178357178358178359178360178361178362178363178364178365178366178367178368178369178370178371178372178373178374178375178376178377178378178379178380178381178382178383178384178385178386178387178388178389178390178391178392178393178394178395178396178397178398178399178400178401178402178403178404178405178406178407178408178409178410178411178412178413178414178415178416178417178418178419178420178421178422178423178424178425178426178427178428178429178430178431178432178433178434178435178436178437178438178439178440178441178442178443178444178445178446178447178448178449178450178451178452178453178454178455178456178457178458178459178460178461178462178463178464178465178466178467178468178469178470178471178472178473178474178475178476178477178478178479178480178481178482178483178484178485178486178487178488178489178490178491178492178493178494178495178496178497178498178499178500178501178502178503178504178505178506178507178508178509178510178511178512178513178514178515178516178517178518178519178520178521178522178523178524178525178526178527178528178529178530178531178532178533178534178535178536178537178538178539178540178541178542178543178544178545178546178547178548178549178550178551178552178553178554178555178556178557178558178559178560178561178562178563178564178565178566178567178568178569178570178571178572178573178574178575178576178577178578178579178580178581178582178583178584178585178586178587178588178589178590178591178592178593178594178595178596178597178598178599178600178601178602178603178604178605178606178607178608178609178610178611178612178613178614178615178616178617178618178619178620178621178622178623178624178625178626178627178628178629178630178631178632178633178634178635178636178637178638178639178640178641178642178643178644178645178646178647178648178649178650178651178652178653178654178655178656178657178658178659178660178661178662178663178664178665178666178667178668178669178670178671178672178673178674178675178676178677178678178679178680178681178682178683178684178685178686178687178688178689178690178691178692178693178694178695178696178697178698178699178700178701178702178703178704178705178706178707178708178709178710178711178712178713178714178715178716178717178718178719178720178721178722178723178724178725178726178727178728178729178730178731178732178733178734178735178736178737178738178739178740178741178742178743178744178745178746178747178748178749178750178751178752178753178754178755178756178757178758178759178760178761178762178763178764178765178766178767178768178769178770178771178772178773178774178775178776178777178778178779178780178781178782178783178784178785178786178787178788178789178790178791178792178793178794178795178796178797178798178799178800178801178802178803178804178805178806178807178808178809178810178811178812178813178814178815178816178817178818178819178820178821178822178823178824178825178826178827178828178829178830178831178832178833178834178835178836178837178838178839178840178841178842178843178844178845178846178847178848178849178850178851178852178853178854178855178856178857178858178859178860178861178862178863178864178865178866178867178868178869178870178871178872178873178874178875178876178877178878178879178880178881178882178883178884178885178886178887178888178889178890178891178892178893178894178895178896178897178898178899178900178901178902178903178904178905178906178907178908178909178910178911178912178913178914178915178916178917178918178919178920178921178922178923178924178925178926178927178928178929178930178931178932178933178934178935178936178937178938178939178940178941178942178943178944178945178946178947178948178949178950178951178952178953178954178955178956178957178958178959178960178961178962178963178964178965178966178967178968178969178970178971178972178973178974178975178976178977178978178979178980178981178982178983178984178985178986178987178988178989178990178991178992178993178994178995178996178997178998178999179000179001179002179003179004179005179006179007179008179009179010179011179012179013179014179015179016179017179018179019179020179021179022179023179024179025179026179027179028179029179030179031179032179033179034179035179036179037179038179039179040179041179042179043179044179045179046179047179048179049179050179051179052179053179054179055179056179057179058179059179060179061179062179063179064179065179066179067179068179069179070179071179072179073179074179075179076179077179078179079179080179081179082179083179084179085179086179087179088179089179090179091179092179093179094179095179096179097179098179099179100179101179102179103179104179105179106179107179108179109179110179111179112179113179114179115179116179117179118179119179120179121179122179123179124179125179126179127179128179129179130179131179132179133179134179135179136179137179138179139179140179141179142179143179144179145179146179147179148179149179150179151179152179153179154179155179156179157179158179159179160179161179162179163179164179165179166179167179168179169179170179171179172179173179174179175179176179177179178179179179180179181179182179183179184179185179186179187179188179189179190179191179192179193179194179195179196179197179198179199179200179201179202179203179204179205179206179207179208179209179210179211179212179213179214179215179216179217179218179219179220179221179222179223179224179225179226179227179228179229179230179231179232179233179234179235179236179237179238179239179240179241179242179243179244179245179246179247179248179249179250179251179252179253179254179255179256179257179258179259179260179261179262179263179264179265179266179267179268179269179270179271179272179273179274179275179276179277179278179279179280179281179282179283179284179285179286179287179288179289179290179291179292179293179294179295179296179297179298179299179300179301179302179303179304179305179306179307179308179309179310179311179312179313179314179315179316179317179318179319179320179321179322179323179324179325179326179327179328179329179330179331179332179333179334179335179336179337179338179339179340179341179342179343179344179345179346179347179348179349179350179351179352179353179354179355179356179357179358179359179360179361179362179363179364179365179366179367179368179369179370179371179372179373179374179375179376179377179378179379179380179381179382179383179384179385179386179387179388179389179390179391179392179393179394179395179396179397179398179399179400179401179402179403179404179405179406179407179408179409179410179411179412179413179414179415179416179417179418179419179420179421179422179423179424179425179426179427179428179429179430179431179432179433179434179435179436179437179438179439179440179441179442179443179444179445179446179447179448179449179450179451179452179453179454179455179456179457179458179459179460179461179462179463179464179465179466179467179468179469179470179471179472179473179474179475179476179477179478179479179480179481179482179483179484179485179486179487179488179489179490179491179492179493179494179495179496179497179498179499179500179501179502179503179504179505179506179507179508179509179510179511179512179513179514179515179516179517179518179519179520179521179522179523179524179525179526179527179528179529179530179531179532179533179534179535179536179537179538179539179540179541179542179543179544179545179546179547179548179549179550179551179552179553179554179555179556179557179558179559179560179561179562179563179564179565179566179567179568179569179570179571179572179573179574179575179576179577179578179579179580179581179582179583179584179585179586179587179588179589179590179591179592179593179594179595179596179597179598179599179600179601179602179603179604179605179606179607179608179609179610179611179612179613179614179615179616179617179618179619179620179621179622179623179624179625179626179627179628179629179630179631179632179633179634179635179636179637179638179639179640179641179642179643179644179645179646179647179648179649179650179651179652179653179654179655179656179657179658179659179660179661179662179663179664179665179666179667179668179669179670179671179672179673179674179675179676179677179678179679179680179681179682179683179684179685179686179687179688179689179690179691179692179693179694179695179696179697179698179699179700179701179702179703179704179705179706179707179708179709179710179711179712179713179714179715179716179717179718179719179720179721179722179723179724179725179726179727179728179729179730179731179732179733179734179735179736179737179738179739179740179741179742179743179744179745179746179747179748179749179750179751179752179753179754179755179756179757179758179759179760179761179762179763179764179765179766179767179768179769179770179771179772179773179774179775179776179777179778179779179780179781179782179783179784179785179786179787179788179789179790179791179792179793179794179795179796179797179798179799179800179801179802179803179804179805179806179807179808179809179810179811179812179813179814179815179816179817179818179819179820179821179822179823179824179825179826179827179828179829179830179831179832179833179834179835179836179837179838179839179840179841179842179843179844179845179846179847179848179849179850179851179852179853179854179855179856179857179858179859179860179861179862179863179864179865179866179867179868179869179870179871179872179873179874179875179876179877179878179879179880179881179882179883179884179885179886179887179888179889179890179891179892179893179894179895179896179897179898179899179900179901179902179903179904179905179906179907179908179909179910179911179912179913179914179915179916179917179918179919179920179921179922179923179924179925179926179927179928179929179930179931179932179933179934179935179936179937179938179939179940179941179942179943179944179945179946179947179948179949179950179951179952179953179954179955179956179957179958179959179960179961179962179963179964179965179966179967179968179969179970179971179972179973179974179975179976179977179978179979179980179981179982179983179984179985179986179987179988179989179990179991179992179993179994179995179996179997179998179999180000180001180002180003180004180005180006180007180008180009180010180011180012180013180014180015180016180017180018180019180020180021180022180023180024180025180026180027180028180029180030180031180032180033180034180035180036180037180038180039180040180041180042180043180044180045180046180047180048180049180050180051180052180053180054180055180056180057180058180059180060180061180062180063180064180065180066180067180068180069180070180071180072180073180074180075180076180077180078180079180080180081180082180083180084180085180086180087180088180089180090180091180092180093180094180095180096180097180098180099180100180101180102180103180104180105180106180107180108180109180110180111180112180113180114180115180116180117180118180119180120180121180122180123180124180125180126180127180128180129180130180131180132180133180134180135180136180137180138180139180140180141180142180143180144180145180146180147180148180149180150180151180152180153180154180155180156180157180158180159180160180161180162180163180164180165180166180167180168180169180170180171180172180173180174180175180176180177180178180179180180180181180182180183180184180185180186180187180188180189180190180191180192180193180194180195180196180197180198180199180200180201180202180203180204180205180206180207180208180209180210180211180212180213180214180215180216180217180218180219180220180221180222180223180224180225180226180227180228180229180230180231180232180233180234180235180236180237180238180239180240180241180242180243180244180245180246180247180248180249180250180251180252180253180254180255180256180257180258180259180260180261180262180263180264180265180266180267180268180269180270180271180272180273180274180275180276180277180278180279180280180281180282180283180284180285180286180287180288180289180290180291180292180293180294180295180296180297180298180299180300180301180302180303180304180305180306180307180308180309180310180311180312180313180314180315180316180317180318180319180320180321180322180323180324180325180326180327180328180329180330180331180332180333180334180335180336180337180338180339180340180341180342180343180344180345180346180347180348180349180350180351180352180353180354180355180356180357180358180359180360180361180362180363180364180365180366180367180368180369180370180371180372180373180374180375180376180377180378180379180380180381180382180383180384180385180386180387180388180389180390180391180392180393180394180395180396180397180398180399180400180401180402180403180404180405180406180407180408180409180410180411180412180413180414180415180416180417180418180419180420180421180422180423180424180425180426180427180428180429180430180431180432180433180434180435180436180437180438180439180440180441180442180443180444180445180446180447180448180449180450180451180452180453180454180455180456180457180458180459180460180461180462180463180464180465180466180467180468180469180470180471180472180473180474180475180476180477180478180479180480180481180482180483180484180485180486180487180488180489180490180491180492180493180494180495180496180497180498180499180500180501180502180503180504180505180506180507180508180509180510180511180512180513180514180515180516180517180518180519180520180521180522180523180524180525180526180527180528180529180530180531180532180533180534180535180536180537180538180539180540180541180542180543180544180545180546180547180548180549180550180551180552180553180554180555180556180557180558180559180560180561180562180563180564180565180566180567180568180569180570180571180572180573180574180575180576180577180578180579180580180581180582180583180584180585180586180587180588180589180590180591180592180593180594180595180596180597180598180599180600180601180602180603180604180605180606180607180608180609180610180611180612180613180614180615180616180617180618180619180620180621180622180623180624180625180626180627180628180629180630180631180632180633180634180635180636180637180638180639180640180641180642180643180644180645180646180647180648180649180650180651180652180653180654180655180656180657180658180659180660180661180662180663180664180665180666180667180668180669180670180671180672180673180674180675180676180677180678180679180680180681180682180683180684180685180686180687180688180689180690180691180692180693180694180695180696180697180698180699180700180701180702180703180704180705180706180707180708180709180710180711180712180713180714180715180716180717180718180719180720180721180722180723180724180725180726180727180728180729180730180731180732180733180734180735180736180737180738180739180740180741180742180743180744180745180746180747180748180749180750180751180752180753180754180755180756180757180758180759180760180761180762180763180764180765180766180767180768180769180770180771180772180773180774180775180776180777180778180779180780180781180782180783180784180785180786180787180788180789180790180791180792180793180794180795180796180797180798180799180800180801180802180803180804180805180806180807180808180809180810180811180812180813180814180815180816180817180818180819180820180821180822180823180824180825180826180827180828180829180830180831180832180833180834180835180836180837180838180839180840180841180842180843180844180845180846180847180848180849180850180851180852180853180854180855180856180857180858180859180860180861180862180863180864180865180866180867180868180869180870180871180872180873180874180875180876180877180878180879180880180881180882180883180884180885180886180887180888180889180890180891180892180893180894180895180896180897180898180899180900180901180902180903180904180905180906180907180908180909180910180911180912180913180914180915180916180917180918180919180920180921180922180923180924180925180926180927180928180929180930180931180932180933180934180935180936180937180938180939180940180941180942180943180944180945180946180947180948180949180950180951180952180953180954180955180956180957180958180959180960180961180962180963180964180965180966180967180968180969180970180971180972180973180974180975180976180977180978180979180980180981180982180983180984180985180986180987180988180989180990180991180992180993180994180995180996180997180998180999181000181001181002181003181004181005181006181007181008181009181010181011181012181013181014181015181016181017181018181019181020181021181022181023181024181025181026181027181028181029181030181031181032181033181034181035181036181037181038181039181040181041181042181043181044181045181046181047181048181049181050181051181052181053181054181055181056181057181058181059181060181061181062181063181064181065181066181067181068181069181070181071181072181073181074181075181076181077181078181079181080181081181082181083181084181085181086181087181088181089181090181091181092181093181094181095181096181097181098181099181100181101181102181103181104181105181106181107181108181109181110181111181112181113181114181115181116181117181118181119181120181121181122181123181124181125181126181127181128181129181130181131181132181133181134181135181136181137181138181139181140181141181142181143181144181145181146181147181148181149181150181151181152181153181154181155181156181157181158181159181160181161181162181163181164181165181166181167181168181169181170181171181172181173181174181175181176181177181178181179181180181181181182181183181184181185181186181187181188181189181190181191181192181193181194181195181196181197181198181199181200181201181202181203181204181205181206181207181208181209181210181211181212181213181214181215181216181217181218181219181220181221181222181223181224181225181226181227181228181229181230181231181232181233181234181235181236181237181238181239181240181241181242181243181244181245181246181247181248181249181250181251181252181253181254181255181256181257181258181259181260181261181262181263181264181265181266181267181268181269181270181271181272181273181274181275181276181277181278181279181280181281181282181283181284181285181286181287181288181289181290181291181292181293181294181295181296181297181298181299181300181301181302181303181304181305181306181307181308181309181310181311181312181313181314181315181316181317181318181319181320181321181322181323181324181325181326181327181328181329181330181331181332181333181334181335181336181337181338181339181340181341181342181343181344181345181346181347181348181349181350181351181352181353181354181355181356181357181358181359181360181361181362181363181364181365181366181367181368181369181370181371181372181373181374181375181376181377181378181379181380181381181382181383181384181385181386181387181388181389181390181391181392181393181394181395181396181397181398181399181400181401181402181403181404181405181406181407181408181409181410181411181412181413181414181415181416181417181418181419181420181421181422181423181424181425181426181427181428181429181430181431181432181433181434181435181436181437181438181439181440181441181442181443181444181445181446181447181448181449181450181451181452181453181454181455181456181457181458181459181460181461181462181463181464181465181466181467181468181469181470181471181472181473181474181475181476181477181478181479181480181481181482181483181484181485181486181487181488181489181490181491181492181493181494181495181496181497181498181499181500181501181502181503181504181505181506181507181508181509181510181511181512181513181514181515181516181517181518181519181520181521181522181523181524181525181526181527181528181529181530181531181532181533181534181535181536181537181538181539181540181541181542181543181544181545181546181547181548181549181550181551181552181553181554181555181556181557181558181559181560181561181562181563181564181565181566181567181568181569181570181571181572181573181574181575181576181577181578181579181580181581181582181583181584181585181586181587181588181589181590181591181592181593181594181595181596181597181598181599181600181601181602181603181604181605181606181607181608181609181610181611181612181613181614181615181616181617181618181619181620181621181622181623181624181625181626181627181628181629181630181631181632181633181634181635181636181637181638181639181640181641181642181643181644181645181646181647181648181649181650181651181652181653181654181655181656181657181658181659181660181661181662181663181664181665181666181667181668181669181670181671181672181673181674181675181676181677181678181679181680181681181682181683181684181685181686181687181688181689181690181691181692181693181694181695181696181697181698181699181700181701181702181703181704181705181706181707181708181709181710181711181712181713181714181715181716181717181718181719181720181721181722181723181724181725181726181727181728181729181730181731181732181733181734181735181736181737181738181739181740181741181742181743181744181745181746181747181748181749181750181751181752181753181754181755181756181757181758181759181760181761181762181763181764181765181766181767181768181769181770181771181772181773181774181775181776181777181778181779181780181781181782181783181784181785181786181787181788181789181790181791181792181793181794181795181796181797181798181799181800181801181802181803181804181805181806181807181808181809181810181811181812181813181814181815181816181817181818181819181820181821181822181823181824181825181826181827181828181829181830181831181832181833181834181835181836181837181838181839181840181841181842181843181844181845181846181847181848181849181850181851181852181853181854181855181856181857181858181859181860181861181862181863181864181865181866181867181868181869181870181871181872181873181874181875181876181877181878181879181880181881181882181883181884181885181886181887181888181889181890181891181892181893181894181895181896181897181898181899181900181901181902181903181904181905181906181907181908181909181910181911181912181913181914181915181916181917181918181919181920181921181922181923181924181925181926181927181928181929181930181931181932181933181934181935181936181937181938181939181940181941181942181943181944181945181946181947181948181949181950181951181952181953181954181955181956181957181958181959181960181961181962181963181964181965181966181967181968181969181970181971181972181973181974181975181976181977181978181979181980181981181982181983181984181985181986181987181988181989181990181991181992181993181994181995181996181997181998181999182000182001182002182003182004182005182006182007182008182009182010182011182012182013182014182015182016182017182018182019182020182021182022182023182024182025182026182027182028182029182030182031182032182033182034182035182036182037182038182039182040182041182042182043182044182045182046182047182048182049182050182051182052182053182054182055182056182057182058182059182060182061182062182063182064182065182066182067182068182069182070182071182072182073182074182075182076182077182078182079182080182081182082182083182084182085182086182087182088182089182090182091182092182093182094182095182096182097182098182099182100182101182102182103182104182105182106182107182108182109182110182111182112182113182114182115182116182117182118182119182120182121182122182123182124182125182126182127182128182129182130182131182132182133182134182135182136182137182138182139182140182141182142182143182144182145182146182147182148182149182150182151182152182153182154182155182156182157182158182159182160182161182162182163182164182165182166182167182168182169182170182171182172182173182174182175182176182177182178182179182180182181182182182183182184182185182186182187182188182189182190182191182192182193182194182195182196182197182198182199182200182201182202182203182204182205182206182207182208182209182210182211182212182213182214182215182216182217182218182219182220182221182222182223182224182225182226182227182228182229182230182231182232182233182234182235182236182237182238182239182240182241182242182243182244182245182246182247182248182249182250182251182252182253182254182255182256182257182258182259182260182261182262182263182264182265182266182267182268182269182270182271182272182273182274182275182276182277182278182279182280182281182282182283182284182285182286182287182288182289182290182291182292182293182294182295182296182297182298182299182300182301182302182303182304182305182306182307182308182309182310182311182312182313182314182315182316182317182318182319182320182321182322182323182324182325182326182327182328182329182330182331182332182333182334182335182336182337182338182339182340182341182342182343182344182345182346182347182348182349182350182351182352182353182354182355182356182357182358182359182360182361182362182363182364182365182366182367182368182369182370182371182372182373182374182375182376182377182378182379182380182381182382182383182384182385182386182387182388182389182390182391182392182393182394182395182396182397182398182399182400182401182402182403182404182405182406182407182408182409182410182411182412182413182414182415182416182417182418182419182420182421182422182423182424182425182426182427182428182429182430182431182432182433182434182435182436182437182438182439182440182441182442182443182444182445182446182447182448182449182450182451182452182453182454182455182456182457182458182459182460182461182462182463182464182465182466182467182468182469182470182471182472182473182474182475182476182477182478182479182480182481182482182483182484182485182486182487182488182489182490182491182492182493182494182495182496182497182498182499182500182501182502182503182504182505182506182507182508182509182510182511182512182513182514182515182516182517182518182519182520182521182522182523182524182525182526182527182528182529182530182531182532182533182534182535182536182537182538182539182540182541182542182543182544182545182546182547182548182549182550182551182552182553182554182555182556182557182558182559182560182561182562182563182564182565182566182567182568182569182570182571182572182573182574182575182576182577182578182579182580182581182582182583182584182585182586182587182588182589182590182591182592182593182594182595182596182597182598182599182600182601182602182603182604182605182606182607182608182609182610182611182612182613182614182615182616182617182618182619182620182621182622182623182624182625182626182627182628182629182630182631182632182633182634182635182636182637182638182639182640182641182642182643182644182645182646182647182648182649182650182651182652182653182654182655182656182657182658182659182660182661182662182663182664182665182666182667182668182669182670182671182672182673182674182675182676182677182678182679182680182681182682182683182684182685182686182687182688182689182690182691182692182693182694182695182696182697182698182699182700182701182702182703182704182705182706182707182708182709182710182711182712182713182714182715182716182717182718182719182720182721182722182723182724182725182726182727182728182729182730182731182732182733182734182735182736182737182738182739182740182741182742182743182744182745182746182747182748182749182750182751182752182753182754182755182756182757182758182759182760182761182762182763182764182765182766182767182768182769182770182771182772182773182774182775182776182777182778182779182780182781182782182783182784182785182786182787182788182789182790182791182792182793182794182795182796182797182798182799182800182801182802182803182804182805182806182807182808182809182810182811182812182813182814182815182816182817182818182819182820182821182822182823182824182825182826182827182828182829182830182831182832182833182834182835182836182837182838182839182840182841182842182843182844182845182846182847182848182849182850182851182852182853182854182855182856182857182858182859182860182861182862182863182864182865182866182867182868182869182870182871182872182873182874182875182876182877182878182879182880182881182882182883182884182885182886182887182888182889182890182891182892182893182894182895182896182897182898182899182900182901182902182903182904182905182906182907182908182909182910182911182912182913182914182915182916182917182918182919182920182921182922182923182924182925182926182927182928182929182930182931182932182933182934182935182936182937182938182939182940182941182942182943182944182945182946182947182948182949182950182951182952182953182954182955182956182957182958182959182960182961182962182963182964182965182966182967182968182969182970182971182972182973182974182975182976182977182978182979182980182981182982182983182984182985182986182987182988182989182990182991182992182993182994182995182996182997182998182999183000183001183002183003183004183005183006183007183008183009183010183011183012183013183014183015183016183017183018183019183020183021183022183023183024183025183026183027183028183029183030183031183032183033183034183035183036183037183038183039183040183041183042183043183044183045183046183047183048183049183050183051183052183053183054183055183056183057183058183059183060183061183062183063183064183065183066183067183068183069183070183071183072183073183074183075183076183077183078183079183080183081183082183083183084183085183086183087183088183089183090183091183092183093183094183095183096183097183098183099183100183101183102183103183104183105183106183107183108183109183110183111183112183113183114183115183116183117183118183119183120183121183122183123183124183125183126183127183128183129183130183131183132183133183134183135183136183137183138183139183140183141183142183143183144183145183146183147183148183149183150183151183152183153183154183155183156183157183158183159183160183161183162183163183164183165183166183167183168183169183170183171183172183173183174183175183176183177183178183179183180183181183182183183183184183185183186183187183188183189183190183191183192183193183194183195183196183197183198183199183200183201183202183203183204183205183206183207183208183209183210183211183212183213183214183215183216183217183218183219183220183221183222183223183224183225183226183227183228183229183230183231183232183233183234183235183236183237183238183239183240183241183242183243183244183245183246183247183248183249183250183251183252183253183254183255183256183257183258183259183260183261183262183263183264183265183266183267183268183269183270183271183272183273183274183275183276183277183278183279183280183281183282183283183284183285183286183287183288183289183290183291183292183293183294183295183296183297183298183299183300183301183302183303183304183305183306183307183308183309183310183311183312183313183314183315183316183317183318183319183320183321183322183323183324183325183326183327183328183329183330183331183332183333183334183335183336183337183338183339183340183341183342183343183344183345183346183347183348183349183350183351183352183353183354183355183356183357183358183359183360183361183362183363183364183365183366183367183368183369183370183371183372183373183374183375183376183377183378183379183380183381183382183383183384183385183386183387183388183389183390183391183392183393183394183395183396183397183398183399183400183401183402183403183404183405183406183407183408183409183410183411183412183413183414183415183416183417183418183419183420183421183422183423183424183425183426183427183428183429183430183431183432183433183434183435183436183437183438183439183440183441183442183443183444183445183446183447183448183449183450183451183452183453183454183455183456183457183458183459183460183461183462183463183464183465183466183467183468183469183470183471183472183473183474183475183476183477183478183479183480183481183482183483183484183485183486183487183488183489183490183491183492183493183494183495183496183497183498183499183500183501183502183503183504183505183506183507183508183509183510183511183512183513183514183515183516183517183518183519183520183521183522183523183524183525183526183527183528183529183530183531183532183533183534183535183536183537183538183539183540183541183542183543183544183545183546183547183548183549183550183551183552183553183554183555183556183557183558183559183560183561183562183563183564183565183566183567183568183569183570183571183572183573183574183575183576183577183578183579183580183581183582183583183584183585183586183587183588183589183590183591183592183593183594183595183596183597183598183599183600183601183602183603183604183605183606183607183608183609183610183611183612183613183614183615183616183617183618183619183620183621183622183623183624183625183626183627183628183629183630183631183632183633183634183635183636183637183638183639183640183641183642183643183644183645183646183647183648183649183650183651183652183653183654183655183656183657183658183659183660183661183662183663183664183665183666183667183668183669183670183671183672183673183674183675183676183677183678183679183680183681183682183683183684183685183686183687183688183689183690183691183692183693183694183695183696183697183698183699183700183701183702183703183704183705183706183707183708183709183710183711183712183713183714183715183716183717183718183719183720183721183722183723183724183725183726183727183728183729183730183731183732183733183734183735183736183737183738183739183740183741183742183743183744183745183746183747183748183749183750183751183752183753183754183755183756183757183758183759183760183761183762183763183764183765183766183767183768183769183770183771183772183773183774183775183776183777183778183779183780183781183782183783183784183785183786183787183788183789183790183791183792183793183794183795183796183797183798183799183800183801183802183803183804183805183806183807183808183809183810183811183812183813183814183815183816183817183818183819183820183821183822183823183824183825183826183827183828183829183830183831183832183833183834183835183836183837183838183839183840183841183842183843183844183845183846183847183848183849183850183851183852183853183854183855183856183857183858183859183860183861183862183863183864183865183866183867183868183869183870183871183872183873183874183875183876183877183878183879183880183881183882183883183884183885183886183887183888183889183890183891183892183893183894183895183896183897183898183899183900183901183902183903183904183905183906183907183908183909183910183911183912183913183914183915183916183917183918183919183920183921183922183923183924183925183926183927183928183929183930183931183932183933183934183935183936183937183938183939183940183941183942183943183944183945183946183947183948183949183950183951183952183953183954183955183956183957183958183959183960183961183962183963183964183965183966183967183968183969183970183971183972183973183974183975183976183977183978183979183980183981183982183983183984183985183986183987183988183989183990183991183992183993183994183995183996183997183998183999184000184001184002184003184004184005184006184007184008184009184010184011184012184013184014184015184016184017184018184019184020184021184022184023184024184025184026184027184028184029184030184031184032184033184034184035184036184037184038184039184040184041184042184043184044184045184046184047184048184049184050184051184052184053184054184055184056184057184058184059184060184061184062184063184064184065184066184067184068184069184070184071184072184073184074184075184076184077184078184079184080184081184082184083184084184085184086184087184088184089184090184091184092184093184094184095184096184097184098184099184100184101184102184103184104184105184106184107184108184109184110184111184112184113184114184115184116184117184118184119184120184121184122184123184124184125184126184127184128184129184130184131184132184133184134184135184136184137184138184139184140184141184142184143184144184145184146184147184148184149184150184151184152184153184154184155184156184157184158184159184160184161184162184163184164184165184166184167184168184169184170184171184172184173184174184175184176184177184178184179184180184181184182184183184184184185184186184187184188184189184190184191184192184193184194184195184196184197184198184199184200184201184202184203184204184205184206184207184208184209184210184211184212184213184214184215184216184217184218184219184220184221184222184223184224184225184226184227184228184229184230184231184232184233184234184235184236184237184238184239184240184241184242184243184244184245184246184247184248184249184250184251184252184253184254184255184256184257184258184259184260184261184262184263184264184265184266184267184268184269184270184271184272184273184274184275184276184277184278184279184280184281184282184283184284184285184286184287184288184289184290184291184292184293184294184295184296184297184298184299184300184301184302184303184304184305184306184307184308184309184310184311184312184313184314184315184316184317184318184319184320184321184322184323184324184325184326184327184328184329184330184331184332184333184334184335184336184337184338184339184340184341184342184343184344184345184346184347184348184349184350184351184352184353184354184355184356184357184358184359184360184361184362184363184364184365184366184367184368184369184370184371184372184373184374184375184376184377184378184379184380184381184382184383184384184385184386184387184388184389184390184391184392184393184394184395184396184397184398184399184400184401184402184403184404184405184406184407184408184409184410184411184412184413184414184415184416184417184418184419184420184421184422184423184424184425184426184427184428184429184430184431184432184433184434184435184436184437184438184439184440184441184442184443184444184445184446184447184448184449184450184451184452184453184454184455184456184457184458184459184460184461184462184463184464184465184466184467184468184469184470184471184472184473184474184475184476184477184478184479184480184481184482184483184484184485184486184487184488184489184490184491184492184493184494184495184496184497184498184499184500184501184502184503184504184505184506184507184508184509184510184511184512184513184514184515184516184517184518184519184520184521184522184523184524184525184526184527184528184529184530184531184532184533184534184535184536184537184538184539184540184541184542184543184544184545184546184547184548184549184550184551184552184553184554184555184556184557184558184559184560184561184562184563184564184565184566184567184568184569184570184571184572184573184574184575184576184577184578184579184580184581184582184583184584184585184586184587184588184589184590184591184592184593184594184595184596184597184598184599184600184601184602184603184604184605184606184607184608184609184610184611184612184613184614184615184616184617184618184619184620184621184622184623184624184625184626184627184628184629184630184631184632184633184634184635184636184637184638184639184640184641184642184643184644184645184646184647184648184649184650184651184652184653184654184655184656184657184658184659184660184661184662184663184664184665184666184667184668184669184670184671184672184673184674184675184676184677184678184679184680184681184682184683184684184685184686184687184688184689184690184691184692184693184694184695184696184697184698184699184700184701184702184703184704184705184706184707184708184709184710184711184712184713184714184715184716184717184718184719184720184721184722184723184724184725184726184727184728184729184730184731184732184733184734184735184736184737184738184739184740184741184742184743184744184745184746184747184748184749184750184751184752184753184754184755184756184757184758184759184760184761184762184763184764184765184766184767184768184769184770184771184772184773184774184775184776184777184778184779184780184781184782184783184784184785184786184787184788184789184790184791184792184793184794184795184796184797184798184799184800184801184802184803184804184805184806184807184808184809184810184811184812184813184814184815184816184817184818184819184820184821184822184823184824184825184826184827184828184829184830184831184832184833184834184835184836184837184838184839184840184841184842184843184844184845184846184847184848184849184850184851184852184853184854184855184856184857184858184859184860184861184862184863184864184865184866184867184868184869184870184871184872184873184874184875184876184877184878184879184880184881184882184883184884184885184886184887184888184889184890184891184892184893184894184895184896184897184898184899184900184901184902184903184904184905184906184907184908184909184910184911184912184913184914184915184916184917184918184919184920184921184922184923184924184925184926184927184928184929184930184931184932184933184934184935184936184937184938184939184940184941184942184943184944184945184946184947184948184949184950184951184952184953184954184955184956184957184958184959184960184961184962184963184964184965184966184967184968184969184970184971184972184973184974184975184976184977184978184979184980184981184982184983184984184985184986184987184988184989184990184991184992184993184994184995184996184997184998184999185000185001185002185003185004185005185006185007185008185009185010185011185012185013185014185015185016185017185018185019185020185021185022185023185024185025185026185027185028185029185030185031185032185033185034185035185036185037185038185039185040185041185042185043185044185045185046185047185048185049185050185051185052185053185054185055185056185057185058185059185060185061185062185063185064185065185066185067185068185069185070185071185072185073185074185075185076185077185078185079185080185081185082185083185084185085185086185087185088185089185090185091185092185093185094185095185096185097185098185099185100185101185102185103185104185105185106185107185108185109185110185111185112185113185114185115185116185117185118185119185120185121185122185123185124185125185126185127185128185129185130185131185132185133185134185135185136185137185138185139185140185141185142185143185144185145185146185147185148185149185150185151185152185153185154185155185156185157185158185159185160185161185162185163185164185165185166185167185168185169185170185171185172185173185174185175185176185177185178185179185180185181185182185183185184185185185186185187185188185189185190185191185192185193185194185195185196185197185198185199185200185201185202185203185204185205185206185207185208185209185210185211185212185213185214185215185216185217185218185219185220185221185222185223185224185225185226185227185228185229185230185231185232185233185234185235185236185237185238185239185240185241185242185243185244185245185246185247185248185249185250185251185252185253185254185255185256185257185258185259185260185261185262185263185264185265185266185267185268185269185270185271185272185273185274185275185276185277185278185279185280185281185282185283185284185285185286185287185288185289185290185291185292185293185294185295185296185297185298185299185300185301185302185303185304185305185306185307185308185309185310185311185312185313185314185315185316185317185318185319185320185321185322185323185324185325185326185327185328185329185330185331185332185333185334185335185336185337185338185339185340185341185342185343185344185345185346185347185348185349185350185351185352185353185354185355185356185357185358185359185360185361185362185363185364185365185366185367185368185369185370185371185372185373185374185375185376185377185378185379185380185381185382185383185384185385185386185387185388185389185390185391185392185393185394185395185396185397185398185399185400185401185402185403185404185405185406185407185408185409185410185411185412185413185414185415185416185417185418185419185420185421185422185423185424185425185426185427185428185429185430185431185432185433185434185435185436185437185438185439185440185441185442185443185444185445185446185447185448185449185450185451185452185453185454185455185456185457185458185459185460185461185462185463185464185465185466185467185468185469185470185471185472185473185474185475185476185477185478185479185480185481185482185483185484185485185486185487185488185489185490185491185492185493185494185495185496185497185498185499185500185501185502185503185504185505185506185507185508185509185510185511185512185513185514185515185516185517185518185519185520185521185522185523185524185525185526185527185528185529185530185531185532185533185534185535185536185537185538185539185540185541185542185543185544185545185546185547185548185549185550185551185552185553185554185555185556185557185558185559185560185561185562185563185564185565185566185567185568185569185570185571185572185573185574185575185576185577185578185579185580185581185582185583185584185585185586185587185588185589185590185591185592185593185594185595185596185597185598185599185600185601185602185603185604185605185606185607185608185609185610185611185612185613185614185615185616185617185618185619185620185621185622185623185624185625185626185627185628185629185630185631185632185633185634185635185636185637185638185639185640185641185642185643185644185645185646185647185648185649185650185651185652185653185654185655185656185657185658185659185660185661185662185663185664185665185666185667185668185669185670185671185672185673185674185675185676185677185678185679185680185681185682185683185684185685185686185687185688185689185690185691185692185693185694185695185696185697185698185699185700185701185702185703185704185705185706185707185708185709185710185711185712185713185714185715185716185717185718185719185720185721185722185723185724185725185726185727185728185729185730185731185732185733185734185735185736185737185738185739185740185741185742185743185744185745185746185747185748185749185750185751185752185753185754185755185756185757185758185759185760185761185762185763185764185765185766185767185768185769185770185771185772185773185774185775185776185777185778185779185780185781185782185783185784185785185786185787185788185789185790185791185792185793185794185795185796185797185798185799185800185801185802185803185804185805185806185807185808185809185810185811185812185813185814185815185816185817185818185819185820185821185822185823185824185825185826185827185828185829185830185831185832185833185834185835185836185837185838185839185840185841185842185843185844185845185846185847185848185849185850185851185852185853185854185855185856185857185858185859185860185861185862185863185864185865185866185867185868185869185870185871185872185873185874185875185876185877185878185879185880185881185882185883185884185885185886185887185888185889185890185891185892185893185894185895185896185897185898185899185900185901185902185903185904185905185906185907185908185909185910185911185912185913185914185915185916185917185918185919185920185921185922185923185924185925185926185927185928185929185930185931185932185933185934185935185936185937185938185939185940185941185942185943185944185945185946185947185948185949185950185951185952185953185954185955185956185957185958185959185960185961185962185963185964185965185966185967185968185969185970185971185972185973185974185975185976185977185978185979185980185981185982185983185984185985185986185987185988185989185990185991185992185993185994185995185996185997185998185999186000186001186002186003186004186005186006186007186008186009186010186011186012186013186014186015186016186017186018186019186020186021186022186023186024186025186026186027186028186029186030186031186032186033186034186035186036186037186038186039186040186041186042186043186044186045186046186047186048186049186050186051186052186053186054186055186056186057186058186059186060186061186062186063186064186065186066186067186068186069186070186071186072186073186074186075186076186077186078186079186080186081186082186083186084186085186086186087186088186089186090186091186092186093186094186095186096186097186098186099186100186101186102186103186104186105186106186107186108186109186110186111186112186113186114186115186116186117186118186119186120186121186122186123186124186125186126186127186128186129186130186131186132186133186134186135186136186137186138186139186140186141186142186143186144186145186146186147186148186149186150186151186152186153186154186155186156186157186158186159186160186161186162186163186164186165186166186167186168186169186170186171186172186173186174186175186176186177186178186179186180186181186182186183186184186185186186186187186188186189186190186191186192186193186194186195186196186197186198186199186200186201186202186203186204186205186206186207186208186209186210186211186212186213186214186215186216186217186218186219186220186221186222186223186224186225186226186227186228186229186230186231186232186233186234186235186236186237186238186239186240186241186242186243186244186245186246186247186248186249186250186251186252186253186254186255186256186257186258186259186260186261186262186263186264186265186266186267186268186269186270186271186272186273186274186275186276186277186278186279186280186281186282186283186284186285186286186287186288186289186290186291186292186293186294186295186296186297186298186299186300186301186302186303186304186305186306186307186308186309186310186311186312186313186314186315186316186317186318186319186320186321186322186323186324186325186326186327186328186329186330186331186332186333186334186335186336186337186338186339186340186341186342186343186344186345186346186347186348186349186350186351186352186353186354186355186356186357186358186359186360186361186362186363186364186365186366186367186368186369186370186371186372186373186374186375186376186377186378186379186380186381186382186383186384186385186386186387186388186389186390186391186392186393186394186395186396186397186398186399186400186401186402186403186404186405186406186407186408186409186410186411186412186413186414186415186416186417186418186419186420186421186422186423186424186425186426186427186428186429186430186431186432186433186434186435186436186437186438186439186440186441186442186443186444186445186446186447186448186449186450186451186452186453186454186455186456186457186458186459186460186461186462186463186464186465186466186467186468186469186470186471186472186473186474186475186476186477186478186479186480186481186482186483186484186485186486186487186488186489186490186491186492186493186494186495186496186497186498186499186500186501186502186503186504186505186506186507186508186509186510186511186512186513186514186515186516186517186518186519186520186521186522186523186524186525186526186527186528186529186530186531186532186533186534186535186536186537186538186539186540186541186542186543186544186545186546186547186548186549186550186551186552186553186554186555186556186557186558186559186560186561186562186563186564186565186566186567186568186569186570186571186572186573186574186575186576186577186578186579186580186581186582186583186584186585186586186587186588186589186590186591186592186593186594186595186596186597186598186599186600186601186602186603186604186605186606186607186608186609186610186611186612186613186614186615186616186617186618186619186620186621186622186623186624186625186626186627186628186629186630186631186632186633186634186635186636186637186638186639186640186641186642186643186644186645186646186647186648186649186650186651186652186653186654186655186656186657186658186659186660186661186662186663186664186665186666186667186668186669186670186671186672186673186674186675186676186677186678186679186680186681186682186683186684186685186686186687186688186689186690186691186692186693186694186695186696186697186698186699186700186701186702186703186704186705186706186707186708186709186710186711186712186713186714186715186716186717186718186719186720186721186722186723186724186725186726186727186728186729186730186731186732186733186734186735186736186737186738186739186740186741186742186743186744186745186746186747186748186749186750186751186752186753186754186755186756186757186758186759186760186761186762186763186764186765186766186767186768186769186770186771186772186773186774186775186776186777186778186779186780186781186782186783186784186785186786186787186788186789186790186791186792186793186794186795186796186797186798186799186800186801186802186803186804186805186806186807186808186809186810186811186812186813186814186815186816186817186818186819186820186821186822186823186824186825186826186827186828186829186830186831186832186833186834186835186836186837186838186839186840186841186842186843186844186845186846186847186848186849186850186851186852186853186854186855186856186857186858186859186860186861186862186863186864186865186866186867186868186869186870186871186872186873186874186875186876186877186878186879186880186881186882186883186884186885186886186887186888186889186890186891186892186893186894186895186896186897186898186899186900186901186902186903186904186905186906186907186908186909186910186911186912186913186914186915186916186917186918186919186920186921186922186923186924186925186926186927186928186929186930186931186932186933186934186935186936186937186938186939186940186941186942186943186944186945186946186947186948186949186950186951186952186953186954186955186956186957186958186959186960186961186962186963186964186965186966186967186968186969186970186971186972186973186974186975186976186977186978186979186980186981186982186983186984186985186986186987186988186989186990186991186992186993186994186995186996186997186998186999187000187001187002187003187004187005187006187007187008187009187010187011187012187013187014187015187016187017187018187019187020187021187022187023187024187025187026187027187028187029187030187031187032187033187034187035187036187037187038187039187040187041187042187043187044187045187046187047187048187049187050187051187052187053187054187055187056187057187058187059187060187061187062187063187064187065187066187067187068187069187070187071187072187073187074187075187076187077187078187079187080187081187082187083187084187085187086187087187088187089187090187091187092187093187094187095187096187097187098187099187100187101187102187103187104187105187106187107187108187109187110187111187112187113187114187115187116187117187118187119187120187121187122187123187124187125187126187127187128187129187130187131187132187133187134187135187136187137187138187139187140187141187142187143187144187145187146187147187148187149187150187151187152187153187154187155187156187157187158187159187160187161187162187163187164187165187166187167187168187169187170187171187172187173187174187175187176187177187178187179187180187181187182187183187184187185187186187187187188187189187190187191187192187193187194187195187196187197187198187199187200187201187202187203187204187205187206187207187208187209187210187211187212187213187214187215187216187217187218187219187220187221187222187223187224187225187226187227187228187229187230187231187232187233187234187235187236187237187238187239187240187241187242187243187244187245187246187247187248187249187250187251187252187253187254187255187256187257187258187259187260187261187262187263187264187265187266187267187268187269187270187271187272187273187274187275187276187277187278187279187280187281187282187283187284187285187286187287187288187289187290187291187292187293187294187295187296187297187298187299187300187301187302187303187304187305187306187307187308187309187310187311187312187313187314187315187316187317187318187319187320187321187322187323187324187325187326187327187328187329187330187331187332187333187334187335187336187337187338187339187340187341187342187343187344187345187346187347187348187349187350187351187352187353187354187355187356187357187358187359187360187361187362187363187364187365187366187367187368187369187370187371187372187373187374187375187376187377187378187379187380187381187382187383187384187385187386187387187388187389187390187391187392187393187394187395187396187397187398187399187400187401187402187403187404187405187406187407187408187409187410187411187412187413187414187415187416187417187418187419187420187421187422187423187424187425187426187427187428187429187430187431187432187433187434187435187436187437187438187439187440187441187442187443187444187445187446187447187448187449187450187451187452187453187454187455187456187457187458187459187460187461187462187463187464187465187466187467187468187469187470187471187472187473187474187475187476187477187478187479187480187481187482187483187484187485187486187487187488187489187490187491187492187493187494187495187496187497187498187499187500187501187502187503187504187505187506187507187508187509187510187511187512187513187514187515187516187517187518187519187520187521187522187523187524187525187526187527187528187529187530187531187532187533187534187535187536187537187538187539187540187541187542187543187544187545187546187547187548187549187550187551187552187553187554187555187556187557187558187559187560187561187562187563187564187565187566187567187568187569187570187571187572187573187574187575187576187577187578187579187580187581187582187583187584187585187586187587187588187589187590187591187592187593187594187595187596187597187598187599187600187601187602187603187604187605187606187607187608187609187610187611187612187613187614187615187616187617187618187619187620187621187622187623187624187625187626187627187628187629187630187631187632187633187634187635187636187637187638187639187640187641187642187643187644187645187646187647187648187649187650187651187652187653187654187655187656187657187658187659187660187661187662187663187664187665187666187667187668187669187670187671187672187673187674187675187676187677187678187679187680187681187682187683187684187685187686187687187688187689187690187691187692187693187694187695187696187697187698187699187700187701187702187703187704187705187706187707187708187709187710187711187712187713187714187715187716187717187718187719187720187721187722187723187724187725187726187727187728187729187730187731187732187733187734187735187736187737187738187739187740187741187742187743187744187745187746187747187748187749187750187751187752187753187754187755187756187757187758187759187760187761187762187763187764187765187766187767187768187769187770187771187772187773187774187775187776187777187778187779187780187781187782187783187784187785187786187787187788187789187790187791187792187793187794187795187796187797187798187799187800187801187802187803187804187805187806187807187808187809187810187811187812187813187814187815187816187817187818187819187820187821187822187823187824187825187826187827187828187829187830187831187832187833187834187835187836187837187838187839187840187841187842187843187844187845187846187847187848187849187850187851187852187853187854187855187856187857187858187859187860187861187862187863187864187865187866187867187868187869187870187871187872187873187874187875187876187877187878187879187880187881187882187883187884187885187886187887187888187889187890187891187892187893187894187895187896187897187898187899187900187901187902187903187904187905187906187907187908187909187910187911187912187913187914187915187916187917187918187919187920187921187922187923187924187925187926187927187928187929187930187931187932187933187934187935187936187937187938187939187940187941187942187943187944187945187946187947187948187949187950187951187952187953187954187955187956187957187958187959187960187961187962187963187964187965187966187967187968187969187970187971187972187973187974187975187976187977187978187979187980187981187982187983187984187985187986187987187988187989187990187991187992187993187994187995187996187997187998187999188000188001188002188003188004188005188006188007188008188009188010188011188012188013188014188015188016188017188018188019188020188021188022188023188024188025188026188027188028188029188030188031188032188033188034188035188036188037188038188039188040188041188042188043188044188045188046188047188048188049188050188051188052188053188054188055188056188057188058188059188060188061188062188063188064188065188066188067188068188069188070188071188072188073188074188075188076188077188078188079188080188081188082188083188084188085188086188087188088188089188090188091188092188093188094188095188096188097188098188099188100188101188102188103188104188105188106188107188108188109188110188111188112188113188114188115188116188117188118188119188120188121188122188123188124188125188126188127188128188129188130188131188132188133188134188135188136188137188138188139188140188141188142188143188144188145188146188147188148188149188150188151188152188153188154188155188156188157188158188159188160188161188162188163188164188165188166188167188168188169188170188171188172188173188174188175188176188177188178188179188180188181188182188183188184188185188186188187188188188189188190188191188192188193188194188195188196188197188198188199188200188201188202188203188204188205188206188207188208188209188210188211188212188213188214188215188216188217188218188219188220188221188222188223188224188225188226188227188228188229188230188231188232188233188234188235188236188237188238188239188240188241188242188243188244188245188246188247188248188249188250188251188252188253188254188255188256188257188258188259188260188261188262188263188264188265188266188267188268188269188270188271188272188273188274188275188276188277188278188279188280188281188282188283188284188285188286188287188288188289188290188291188292188293188294188295188296188297188298188299188300188301188302188303188304188305188306188307188308188309188310188311188312188313188314188315188316188317188318188319188320188321188322188323188324188325188326188327188328188329188330188331188332188333188334188335188336188337188338188339188340188341188342188343188344188345188346188347188348188349188350188351188352188353188354188355188356188357188358188359188360188361188362188363188364188365188366188367188368188369188370188371188372188373188374188375188376188377188378188379188380188381188382188383188384188385188386188387188388188389188390188391188392188393188394188395188396188397188398188399188400188401188402188403188404188405188406188407188408188409188410188411188412188413188414188415188416188417188418188419188420188421188422188423188424188425188426188427188428188429188430188431188432188433188434188435188436188437188438188439188440188441188442188443188444188445188446188447188448188449188450188451188452188453188454188455188456188457188458188459188460188461188462188463188464188465188466188467188468188469188470188471188472188473188474188475188476188477188478188479188480188481188482188483188484188485188486188487188488188489188490188491188492188493188494188495188496188497188498188499188500188501188502188503188504188505188506188507188508188509188510188511188512188513188514188515188516188517188518188519188520188521188522188523188524188525188526188527188528188529188530188531188532188533188534188535188536188537188538188539188540188541188542188543188544188545188546188547188548188549188550188551188552188553188554188555188556188557188558188559188560188561188562188563188564188565188566188567188568188569188570188571188572188573188574188575188576188577188578188579188580188581188582188583188584188585188586188587188588188589188590188591188592188593188594188595188596188597188598188599188600188601188602188603188604188605188606188607188608188609188610188611188612188613188614188615188616188617188618188619188620188621188622188623188624188625188626188627188628188629188630188631188632188633188634188635188636188637188638188639188640188641188642188643188644188645188646188647188648188649188650188651188652188653188654188655188656188657188658188659188660188661188662188663188664188665188666188667188668188669188670188671188672188673188674188675188676188677188678188679188680188681188682188683188684188685188686188687188688188689188690188691188692188693188694188695188696188697188698188699188700188701188702188703188704188705188706188707188708188709188710188711188712188713188714188715188716188717188718188719188720188721188722188723188724188725188726188727188728188729188730188731188732188733188734188735188736188737188738188739188740188741188742188743188744188745188746188747188748188749188750188751188752188753188754188755188756188757188758188759188760188761188762188763188764188765188766188767188768188769188770188771188772188773188774188775188776188777188778188779188780188781188782188783188784188785188786188787188788188789188790188791188792188793188794188795188796188797188798188799188800188801188802188803188804188805188806188807188808188809188810188811188812188813188814188815188816188817188818188819188820188821188822188823188824188825188826188827188828188829188830188831188832188833188834188835188836188837188838188839188840188841188842188843188844188845188846188847188848188849188850188851188852188853188854188855188856188857188858188859188860188861188862188863188864188865188866188867188868188869188870188871188872188873188874188875188876188877188878188879188880188881188882188883188884188885188886188887188888188889188890188891188892188893188894188895188896188897188898188899188900188901188902188903188904188905188906188907188908188909188910188911188912188913188914188915188916188917188918188919188920188921188922188923188924188925188926188927188928188929188930188931188932188933188934188935188936188937188938188939188940188941188942188943188944188945188946188947188948188949188950188951188952188953188954188955188956188957188958188959188960188961188962188963188964188965188966188967188968188969188970188971188972188973188974188975188976188977188978188979188980188981188982188983188984188985188986188987188988188989188990188991188992188993188994188995188996188997188998188999189000189001189002189003189004189005189006189007189008189009189010189011189012189013189014189015189016189017189018189019189020189021189022189023189024189025189026189027189028189029189030189031189032189033189034189035189036189037189038189039189040189041189042189043189044189045189046189047189048189049189050189051189052189053189054189055189056189057189058189059189060189061189062189063189064189065189066189067189068189069189070189071189072189073189074189075189076189077189078189079189080189081189082189083189084189085189086189087189088189089189090189091189092189093189094189095189096189097189098189099189100189101189102189103189104189105189106189107189108189109189110189111189112189113189114189115189116189117189118189119189120189121189122189123189124189125189126189127189128189129189130189131189132189133189134189135189136189137189138189139189140189141189142189143189144189145189146189147189148189149189150189151189152189153189154189155189156189157189158189159189160189161189162189163189164189165189166189167189168189169189170189171189172189173189174189175189176189177189178189179189180189181189182189183189184189185189186189187189188189189189190189191189192189193189194189195189196189197189198189199189200189201189202189203189204189205189206189207189208189209189210189211189212189213189214189215189216189217189218189219189220189221189222189223189224189225189226189227189228189229189230189231189232189233189234189235189236189237189238189239189240189241189242189243189244189245189246189247189248189249189250189251189252189253189254189255189256189257189258189259189260189261189262189263189264189265189266189267189268189269189270189271189272189273189274189275189276189277189278189279189280189281189282189283189284189285189286189287189288189289189290189291189292189293189294189295189296189297189298189299189300189301189302189303189304189305189306189307189308189309189310189311189312189313189314189315189316189317189318189319189320189321189322189323189324189325189326189327189328189329189330189331189332189333189334189335189336189337189338189339189340189341189342189343189344189345189346189347189348189349189350189351189352189353189354189355189356189357189358189359189360189361189362189363189364189365189366189367189368189369189370189371189372189373189374189375189376189377189378189379189380189381189382189383189384189385189386189387189388189389189390189391189392189393189394189395189396189397189398189399189400189401189402189403189404189405189406189407189408189409189410189411189412189413189414189415189416189417189418189419189420189421189422189423189424189425189426189427189428189429189430189431189432189433189434189435189436189437189438189439189440189441189442189443189444189445189446189447189448189449189450189451189452189453189454189455189456189457189458189459189460189461189462189463189464189465189466189467189468189469189470189471189472189473189474189475189476189477189478189479189480189481189482189483189484189485189486189487189488189489189490189491189492189493189494189495189496189497189498189499189500189501189502189503189504189505189506189507189508189509189510189511189512189513189514189515189516189517189518189519189520189521189522189523189524189525189526189527189528189529189530189531189532189533189534189535189536189537189538189539189540189541189542189543189544189545189546189547189548189549189550189551189552189553189554189555189556189557189558189559189560189561189562189563189564189565189566189567189568189569189570189571189572189573189574189575189576189577189578189579189580189581189582189583189584189585189586189587189588189589189590189591189592189593189594189595189596189597189598189599189600189601189602189603189604189605189606189607189608189609189610189611189612189613189614189615189616189617189618189619189620189621189622189623189624189625189626189627189628189629189630189631189632189633189634189635189636189637189638189639189640189641189642189643189644189645189646189647189648189649189650189651189652189653189654189655189656189657189658189659189660189661189662189663189664189665189666189667189668189669189670189671189672189673189674189675189676189677189678189679189680189681189682189683189684189685189686189687189688189689189690189691189692189693189694189695189696189697189698189699189700189701189702189703189704189705189706189707189708189709189710189711189712189713189714189715189716189717189718189719189720189721189722189723189724189725189726189727189728189729189730189731189732189733189734189735189736189737189738189739189740189741189742189743189744189745189746189747189748189749189750189751189752189753189754189755189756189757189758189759189760189761189762189763189764189765189766189767189768189769189770189771189772189773189774189775189776189777189778189779189780189781189782189783189784189785189786189787189788189789189790189791189792189793189794189795189796189797189798189799189800189801189802189803189804189805189806189807189808189809189810189811189812189813189814189815189816189817189818189819189820189821189822189823189824189825189826189827189828189829189830189831189832189833189834189835189836189837189838189839189840189841189842189843189844189845189846189847189848189849189850189851189852189853189854189855189856189857189858189859189860189861189862189863189864189865189866189867189868189869189870189871189872189873189874189875189876189877189878189879189880189881189882189883189884189885189886189887189888189889189890189891189892189893189894189895189896189897189898189899189900189901189902189903189904189905189906189907189908189909189910189911189912189913189914189915189916189917189918189919189920189921189922189923189924189925189926189927189928189929189930189931189932189933189934189935189936189937189938189939189940189941189942189943189944189945189946189947189948189949189950189951189952189953189954189955189956189957189958189959189960189961189962189963189964189965189966189967189968189969189970189971189972189973189974189975189976189977189978189979189980189981189982189983189984189985189986189987189988189989189990189991189992189993189994189995189996189997189998189999190000190001190002190003190004190005190006190007190008190009190010190011190012190013190014190015190016190017190018190019190020190021190022190023190024190025190026190027190028190029190030190031190032190033190034190035190036190037190038190039190040190041190042190043190044190045190046190047190048190049190050190051190052190053190054190055190056190057190058190059190060190061190062190063190064190065190066190067190068190069190070190071190072190073190074190075190076190077190078190079190080190081190082190083190084190085190086190087190088190089190090190091190092190093190094190095190096190097190098190099190100190101190102190103190104190105190106190107190108190109190110190111190112190113190114190115190116190117190118190119190120190121190122190123190124190125190126190127190128190129190130190131190132190133190134190135190136190137190138190139190140190141190142190143190144190145190146190147190148190149190150190151190152190153190154190155190156190157190158190159190160190161190162190163190164190165190166190167190168190169190170190171190172190173190174190175190176190177190178190179190180190181190182190183190184190185190186190187190188190189190190190191190192190193190194190195190196190197190198190199190200190201190202190203190204190205190206190207190208190209190210190211190212190213190214190215190216190217190218190219190220190221190222190223190224190225190226190227190228190229190230190231190232190233190234190235190236190237190238190239190240190241190242190243190244190245190246190247190248190249190250190251190252190253190254190255190256190257190258190259190260190261190262190263190264190265190266190267190268190269190270190271190272190273190274190275190276190277190278190279190280190281190282190283190284190285190286190287190288190289190290190291190292190293190294190295190296190297190298190299190300190301190302190303190304190305190306190307190308190309190310190311190312190313190314190315190316190317190318190319190320190321190322190323190324190325190326190327190328190329190330190331190332190333190334190335190336190337190338190339190340190341190342190343190344190345190346190347190348190349190350190351190352190353190354190355190356190357190358190359190360190361190362190363190364190365190366190367190368190369190370190371190372190373190374190375190376190377190378190379190380190381190382190383190384190385190386190387190388190389190390190391190392190393190394190395190396190397190398190399190400190401190402190403190404190405190406190407190408190409190410190411190412190413190414190415190416190417190418190419190420190421190422190423190424190425190426190427190428190429190430190431190432190433190434190435190436190437190438190439190440190441190442190443190444190445190446190447190448190449190450190451190452190453190454190455190456190457190458190459190460190461190462190463190464190465190466190467190468190469190470190471190472190473190474190475190476190477190478190479190480190481190482190483190484190485190486190487190488190489190490190491190492190493190494190495190496190497190498190499190500190501190502190503190504190505190506190507190508190509190510190511190512190513190514190515190516190517190518190519190520190521190522190523190524190525190526190527190528190529190530190531190532190533190534190535190536190537190538190539190540190541190542190543190544190545190546190547190548190549190550190551190552190553190554190555190556190557190558190559190560190561190562190563190564190565190566190567190568190569190570190571190572190573190574190575190576190577190578190579190580190581190582190583190584190585190586190587190588190589190590190591190592190593190594190595190596190597190598190599190600190601190602190603190604190605190606190607190608190609190610190611190612190613190614190615190616190617190618190619190620190621190622190623190624190625190626190627190628190629190630190631190632190633190634190635190636190637190638190639190640190641190642190643190644190645190646190647190648190649190650190651190652190653190654190655190656190657190658190659190660190661190662190663190664190665190666190667190668190669190670190671190672190673190674190675190676190677190678190679190680190681190682190683190684190685190686190687190688190689190690190691190692190693190694190695190696190697190698190699190700190701190702190703190704190705190706190707190708190709190710190711190712190713190714190715190716190717190718190719190720190721190722190723190724190725190726190727190728190729190730190731190732190733190734190735190736190737190738190739190740190741190742190743190744190745190746190747190748190749190750190751190752190753190754190755190756190757190758190759190760190761190762190763190764190765190766190767190768190769190770190771190772190773190774190775190776190777190778190779190780190781190782190783190784190785190786190787190788190789190790190791190792190793190794190795190796190797190798190799190800190801190802190803190804190805190806190807190808190809190810190811190812190813190814190815190816190817190818190819190820190821190822190823190824190825190826190827190828190829190830190831190832190833190834190835190836190837190838190839190840190841190842190843190844190845190846190847190848190849190850190851190852190853190854190855190856190857190858190859190860190861190862190863190864190865190866190867190868190869190870190871190872190873190874190875190876190877190878190879190880190881190882190883190884190885190886190887190888190889190890190891190892190893190894190895190896190897190898190899190900190901190902190903190904190905190906190907190908190909190910190911190912190913190914190915190916190917190918190919190920190921190922190923190924190925190926190927190928190929190930190931190932190933190934190935190936190937190938190939190940190941190942190943190944190945190946190947190948190949190950190951190952190953190954190955190956190957190958190959190960190961190962190963190964190965190966190967190968190969190970190971190972190973190974190975190976190977190978190979190980190981190982190983190984190985190986190987190988190989190990190991190992190993190994190995190996190997190998190999191000191001191002191003191004191005191006191007191008191009191010191011191012191013191014191015191016191017191018191019191020191021191022191023191024191025191026191027191028191029191030191031191032191033191034191035191036191037191038191039191040191041191042191043191044191045191046191047191048191049191050191051191052191053191054191055191056191057191058191059191060191061191062191063191064191065191066191067191068191069191070191071191072191073191074191075191076191077191078191079191080191081191082191083191084191085191086191087191088191089191090191091191092191093191094191095191096191097191098191099191100191101191102191103191104191105191106191107191108191109191110191111191112191113191114191115191116191117191118191119191120191121191122191123191124191125191126191127191128191129191130191131191132191133191134191135191136191137191138191139191140191141191142191143191144191145191146191147191148191149191150191151191152191153191154191155191156191157191158191159191160191161191162191163191164191165191166191167191168191169191170191171191172191173191174191175191176191177191178191179191180191181191182191183191184191185191186191187191188191189191190191191191192191193191194191195191196191197191198191199191200191201191202191203191204191205191206191207191208191209191210191211191212191213191214191215191216191217191218191219191220191221191222191223191224191225191226191227191228191229191230191231191232191233191234191235191236191237191238191239191240191241191242191243191244191245191246191247191248191249191250191251191252191253191254191255191256191257191258191259191260191261191262191263191264191265191266191267191268191269191270191271191272191273191274191275191276191277191278191279191280191281191282191283191284191285191286191287191288191289191290191291191292191293191294191295191296191297191298191299191300191301191302191303191304191305191306191307191308191309191310191311191312191313191314191315191316191317191318191319191320191321191322191323191324191325191326191327191328191329191330191331191332191333191334191335191336191337191338191339191340191341191342191343191344191345191346191347191348191349191350191351191352191353191354191355191356191357191358191359191360191361191362191363191364191365191366191367191368191369191370191371191372191373191374191375191376191377191378191379191380191381191382191383191384191385191386191387191388191389191390191391191392191393191394191395191396191397191398191399191400191401191402191403191404191405191406191407191408191409191410191411191412191413191414191415191416191417191418191419191420191421191422191423191424191425191426191427191428191429191430191431191432191433191434191435191436191437191438191439191440191441191442191443191444191445191446191447191448191449191450191451191452191453191454191455191456191457191458191459191460191461191462191463191464191465191466191467191468191469191470191471191472191473191474191475191476191477191478191479191480191481191482191483191484191485191486191487191488191489191490191491191492191493191494191495191496191497191498191499191500191501191502191503191504191505191506191507191508191509191510191511191512191513191514191515191516191517191518191519191520191521191522191523191524191525191526191527191528191529191530191531191532191533191534191535191536191537191538191539191540191541191542191543191544191545191546191547191548191549191550191551191552191553191554191555191556191557191558191559191560191561191562191563191564191565191566191567191568191569191570191571191572191573191574191575191576191577191578191579191580191581191582191583191584191585191586191587191588191589191590191591191592191593191594191595191596191597191598191599191600191601191602191603191604191605191606191607191608191609191610191611191612191613191614191615191616191617191618191619191620191621191622191623191624191625191626191627191628191629191630191631191632191633191634191635191636191637191638191639191640191641191642191643191644191645191646191647191648191649191650191651191652191653191654191655191656191657191658191659191660191661191662191663191664191665191666191667191668191669191670191671191672191673191674191675191676191677191678191679191680191681191682191683191684191685191686191687191688191689191690191691191692191693191694191695191696191697191698191699191700191701191702191703191704191705191706191707191708191709191710191711191712191713191714191715191716191717191718191719191720191721191722191723191724191725191726191727191728191729191730191731191732191733191734191735191736191737191738191739191740191741191742191743191744191745191746191747191748191749191750191751191752191753191754191755191756191757191758191759191760191761191762191763191764191765191766191767191768191769191770191771191772191773191774191775191776191777191778191779191780191781191782191783191784191785191786191787191788191789191790191791191792191793191794191795191796191797191798191799191800191801191802191803191804191805191806191807191808191809191810191811191812191813191814191815191816191817191818191819191820191821191822191823191824191825191826191827191828191829191830191831191832191833191834191835191836191837191838191839191840191841191842191843191844191845191846191847191848191849191850191851191852191853191854191855191856191857191858191859191860191861191862191863191864191865191866191867191868191869191870191871191872191873191874191875191876191877191878191879191880191881191882191883191884191885191886191887191888191889191890191891191892191893191894191895191896191897191898191899191900191901191902191903191904191905191906191907191908191909191910191911191912191913191914191915191916191917191918191919191920191921191922191923191924191925191926191927191928191929191930191931191932191933191934191935191936191937191938191939191940191941191942191943191944191945191946191947191948191949191950191951191952191953191954191955191956191957191958191959191960191961191962191963191964191965191966191967191968191969191970191971191972191973191974191975191976191977191978191979191980191981191982191983191984191985191986191987191988191989191990191991191992191993191994191995191996191997191998191999192000192001192002192003192004192005192006192007192008192009192010192011192012192013192014192015192016192017192018192019192020192021192022192023192024192025192026192027192028192029192030192031192032192033192034192035192036192037192038192039192040192041192042192043192044192045192046192047192048192049192050192051192052192053192054192055192056192057192058192059192060192061192062192063192064192065192066192067192068192069192070192071192072192073192074192075192076192077192078192079192080192081192082192083192084192085192086192087192088192089192090192091192092192093192094192095192096192097192098192099192100192101192102192103192104192105192106192107192108192109192110192111192112192113192114192115192116192117192118192119192120192121192122192123192124192125192126192127192128192129192130192131192132192133192134192135192136192137192138192139192140192141192142192143192144192145192146192147192148192149192150192151192152192153192154192155192156192157192158192159192160192161192162192163192164192165192166192167192168192169192170192171192172192173192174192175192176192177192178192179192180192181192182192183192184192185192186192187192188192189192190192191192192192193192194192195192196192197192198192199192200192201192202192203192204192205192206192207192208192209192210192211192212192213192214192215192216192217192218192219192220192221192222192223192224192225192226192227192228192229192230192231192232192233192234192235192236192237192238192239192240192241192242192243192244192245192246192247192248192249192250192251192252192253192254192255192256192257192258192259192260192261192262192263192264192265192266192267192268192269192270192271192272192273192274192275192276192277192278192279192280192281192282192283192284192285192286192287192288192289192290192291192292192293192294192295192296192297192298192299192300192301192302192303192304192305192306192307192308192309192310192311192312192313192314192315192316192317192318192319192320192321192322192323192324192325192326192327192328192329192330192331192332192333192334192335192336192337192338192339192340192341192342192343192344192345192346192347192348192349192350192351192352192353192354192355192356192357192358192359192360192361192362192363192364192365192366192367192368192369192370192371192372192373192374192375192376192377192378192379192380192381192382192383192384192385192386192387192388192389192390192391192392192393192394192395192396192397192398192399192400192401192402192403192404192405192406192407192408192409192410192411192412192413192414192415192416192417192418192419192420192421192422192423192424192425192426192427192428192429192430192431192432192433192434192435192436192437192438192439192440192441192442192443192444192445192446192447192448192449192450192451192452192453192454192455192456192457192458192459192460192461192462192463192464192465192466192467192468192469192470192471192472192473192474192475192476192477192478192479192480192481192482192483192484192485192486192487192488192489192490192491192492192493192494192495192496192497192498192499192500192501192502192503192504192505192506192507192508192509192510192511192512192513192514192515192516192517192518192519192520192521192522192523192524192525192526192527192528192529192530192531192532192533192534192535192536192537192538192539192540192541192542192543192544192545192546192547192548192549192550192551192552192553192554192555192556192557192558192559192560192561192562192563192564192565192566192567192568192569192570192571192572192573192574192575192576192577192578192579192580192581192582192583192584192585192586192587192588192589192590192591192592192593192594192595192596192597192598192599192600192601192602192603192604192605192606192607192608192609192610192611192612192613192614192615192616192617192618192619192620192621192622192623192624192625192626192627192628192629192630192631192632192633192634192635192636192637192638192639192640192641192642192643192644192645192646192647192648192649192650192651192652192653192654192655192656192657192658192659192660192661192662192663192664192665192666192667192668192669192670192671192672192673192674192675192676192677192678192679192680192681192682192683192684192685192686192687192688192689192690192691192692192693192694192695192696192697192698192699192700192701192702192703192704192705192706192707192708192709192710192711192712192713192714192715192716192717192718192719192720192721192722192723192724192725192726192727192728192729192730192731192732192733192734192735192736192737192738192739192740192741192742192743192744192745192746192747192748192749192750192751192752192753192754192755192756192757192758192759192760192761192762192763192764192765192766192767192768192769192770192771192772192773192774192775192776192777192778192779192780192781192782192783192784192785192786192787192788192789192790192791192792192793192794192795192796192797192798192799192800192801192802192803192804192805192806192807192808192809192810192811192812192813192814192815192816192817192818192819192820192821192822192823192824192825192826192827192828192829192830192831192832192833192834192835192836192837192838192839192840192841192842192843192844192845192846192847192848192849192850192851192852192853192854192855192856192857192858192859192860192861192862192863192864192865192866192867192868192869192870192871192872192873192874192875192876192877192878192879192880192881192882192883192884192885192886192887192888192889192890192891192892192893192894192895192896192897192898192899192900192901192902192903192904192905192906192907192908192909192910192911192912192913192914192915192916192917192918192919192920192921192922192923192924192925192926192927192928192929192930192931192932192933192934192935192936192937192938192939192940192941192942192943192944192945192946192947192948192949192950192951192952192953192954192955192956192957192958192959192960192961192962192963192964192965192966192967192968192969192970192971192972192973192974192975192976192977192978192979192980192981192982192983192984192985192986192987192988192989192990192991192992192993192994192995192996192997192998192999193000193001193002193003193004193005193006193007193008193009193010193011193012193013193014193015193016193017193018193019193020193021193022193023193024193025193026193027193028193029193030193031193032193033193034193035193036193037193038193039193040193041193042193043193044193045193046193047193048193049193050193051193052193053193054193055193056193057193058193059193060193061193062193063193064193065193066193067193068193069193070193071193072193073193074193075193076193077193078193079193080193081193082193083193084193085193086193087193088193089193090193091193092193093193094193095193096193097193098193099193100193101193102193103193104193105193106193107193108193109193110193111193112193113193114193115193116193117193118193119193120193121193122193123193124193125193126193127193128193129193130193131193132193133193134193135193136193137193138193139193140193141193142193143193144193145193146193147193148193149193150193151193152193153193154193155193156193157193158193159193160193161193162193163193164193165193166193167193168193169193170193171193172193173193174193175193176193177193178193179193180193181193182193183193184193185193186193187193188193189193190193191193192193193193194193195193196193197193198193199193200193201193202193203193204193205193206193207193208193209193210193211193212193213193214193215193216193217193218193219193220193221193222193223193224193225193226193227193228193229193230193231193232193233193234193235193236193237193238193239193240193241193242193243193244193245193246193247193248193249193250193251193252193253193254193255193256193257193258193259193260193261193262193263193264193265193266193267193268193269193270193271193272193273193274193275193276193277193278193279193280193281193282193283193284193285193286193287193288193289193290193291193292193293193294193295193296193297193298193299193300193301193302193303193304193305193306193307193308193309193310193311193312193313193314193315193316193317193318193319193320193321193322193323193324193325193326193327193328193329193330193331193332193333193334193335193336193337193338193339193340193341193342193343193344193345193346193347193348193349193350193351193352193353193354193355193356193357193358193359193360193361193362193363193364193365193366193367193368193369193370193371193372193373193374193375193376193377193378193379193380193381193382193383193384193385193386193387193388193389193390193391193392193393193394193395193396193397193398193399193400193401193402193403193404193405193406193407193408193409193410193411193412193413193414193415193416193417193418193419193420193421193422193423193424193425193426193427193428193429193430193431193432193433193434193435193436193437193438193439193440193441193442193443193444193445193446193447193448193449193450193451193452193453193454193455193456193457193458193459193460193461193462193463193464193465193466193467193468193469193470193471193472193473193474193475193476193477193478193479193480193481193482193483193484193485193486193487193488193489193490193491193492193493193494193495193496193497193498193499193500193501193502193503193504193505193506193507193508193509193510193511193512193513193514193515193516193517193518193519193520193521193522193523193524193525193526193527193528193529193530193531193532193533193534193535193536193537193538193539193540193541193542193543193544193545193546193547193548193549193550193551193552193553193554193555193556193557193558193559193560193561193562193563193564193565193566193567193568193569193570193571193572193573193574193575193576193577193578193579193580193581193582193583193584193585193586193587193588193589193590193591193592193593193594193595193596193597193598193599193600193601193602193603193604193605193606193607193608193609193610193611193612193613193614193615193616193617193618193619193620193621193622193623193624193625193626193627193628193629193630193631193632193633193634193635193636193637193638193639193640193641193642193643193644193645193646193647193648193649193650193651193652193653193654193655193656193657193658193659193660193661193662193663193664193665193666193667193668193669193670193671193672193673193674193675193676193677193678193679193680193681193682193683193684193685193686193687193688193689193690193691193692193693193694193695193696193697193698193699193700193701193702193703193704193705193706193707193708193709193710193711193712193713193714193715193716193717193718193719193720193721193722193723193724193725193726193727193728193729193730193731193732193733193734193735193736193737193738193739193740193741193742193743193744193745193746193747193748193749193750193751193752193753193754193755193756193757193758193759193760193761193762193763193764193765193766193767193768193769193770193771193772193773193774193775193776193777193778193779193780193781193782193783193784193785193786193787193788193789193790193791193792193793193794193795193796193797193798193799193800193801193802193803193804193805193806193807193808193809193810193811193812193813193814193815193816193817193818193819193820193821193822193823193824193825193826193827193828193829193830193831193832193833193834193835193836193837193838193839193840193841193842193843193844193845193846193847193848193849193850193851193852193853193854193855193856193857193858193859193860193861193862193863193864193865193866193867193868193869193870193871193872193873193874193875193876193877193878193879193880193881193882193883193884193885193886193887193888193889193890193891193892193893193894193895193896193897193898193899193900193901193902193903193904193905193906193907193908193909193910193911193912193913193914193915193916193917193918193919193920193921193922193923193924193925193926193927193928193929193930193931193932193933193934193935193936193937193938193939193940193941193942193943193944193945193946193947193948193949193950193951193952193953193954193955193956193957193958193959193960193961193962193963193964193965193966193967193968193969193970193971193972193973193974193975193976193977193978193979193980193981193982193983193984193985193986193987193988193989193990193991193992193993193994193995193996193997193998193999194000194001194002194003194004194005194006194007194008194009194010194011194012194013194014194015194016194017194018194019194020194021194022194023194024194025194026194027194028194029194030194031194032194033194034194035194036194037194038194039194040194041194042194043194044194045194046194047194048194049194050194051194052194053194054194055194056194057194058194059194060194061194062194063194064194065194066194067194068194069194070194071194072194073194074194075194076194077194078194079194080194081194082194083194084194085194086194087194088194089194090194091194092194093194094194095194096194097194098194099194100194101194102194103194104194105194106194107194108194109194110194111194112194113194114194115194116194117194118194119194120194121194122194123194124194125194126194127194128194129194130194131194132194133194134194135194136194137194138194139194140194141194142194143194144194145194146194147194148194149194150194151194152194153194154194155194156194157194158194159194160194161194162194163194164194165194166194167194168194169194170194171194172194173194174194175194176194177194178194179194180194181194182194183194184194185194186194187194188194189194190194191194192194193194194194195194196194197194198194199194200194201194202194203194204194205194206194207194208194209194210194211194212194213194214194215194216194217194218194219194220194221194222194223194224194225194226194227194228194229194230194231194232194233194234194235194236194237194238194239194240194241194242194243194244194245194246194247194248194249194250194251194252194253194254194255194256194257194258194259194260194261194262194263194264194265194266194267194268194269194270194271194272194273194274194275194276194277194278194279194280194281194282194283194284194285194286194287194288194289194290194291194292194293194294194295194296194297194298194299194300194301194302194303194304194305194306194307194308194309194310194311194312194313194314194315194316194317194318194319194320194321194322194323194324194325194326194327194328194329194330194331194332194333194334194335194336194337194338194339194340194341194342194343194344194345194346194347194348194349194350194351194352194353194354194355194356194357194358194359194360194361194362194363194364194365194366194367194368194369194370194371194372194373194374194375194376194377194378194379194380194381194382194383194384194385194386194387194388194389194390194391194392194393194394194395194396194397194398194399194400194401194402194403194404194405194406194407194408194409194410194411194412194413194414194415194416194417194418194419194420194421194422194423194424194425194426194427194428194429194430194431194432194433194434194435194436194437194438194439194440194441194442194443194444194445194446194447194448194449194450194451194452194453194454194455194456194457194458194459194460194461194462194463194464194465194466194467194468194469194470194471194472194473194474194475194476194477194478194479194480194481194482194483194484194485194486194487194488194489194490194491194492194493194494194495194496194497194498194499194500194501194502194503194504194505194506194507194508194509194510194511194512194513194514194515194516194517194518194519194520194521194522194523194524194525194526194527194528194529194530194531194532194533194534194535194536194537194538194539194540194541194542194543194544194545194546194547194548194549194550194551194552194553194554194555194556194557194558194559194560194561194562194563194564194565194566194567194568194569194570194571194572194573194574194575194576194577194578194579194580194581194582194583194584194585194586194587194588194589194590194591194592194593194594194595194596194597194598194599194600194601194602194603194604194605194606194607194608194609194610194611194612194613194614194615194616194617194618194619194620194621194622194623194624194625194626194627194628194629194630194631194632194633194634194635194636194637194638194639194640194641194642194643194644194645194646194647194648194649194650194651194652194653194654194655194656194657194658194659194660194661194662194663194664194665194666194667194668194669194670194671194672194673194674194675194676194677194678194679194680194681194682194683194684194685194686194687194688194689194690194691194692194693194694194695194696194697194698194699194700194701194702194703194704194705194706194707194708194709194710194711194712194713194714194715194716194717194718194719194720194721194722194723194724194725194726194727194728194729194730194731194732194733194734194735194736194737194738194739194740194741194742194743194744194745194746194747194748194749194750194751194752194753194754194755194756194757194758194759194760194761194762194763194764194765194766194767194768194769194770194771194772194773194774194775194776194777194778194779194780194781194782194783194784194785194786194787194788194789194790194791194792194793194794194795194796194797194798194799194800194801194802194803194804194805194806194807194808194809194810194811194812194813194814194815194816194817194818194819194820194821194822194823194824194825194826194827194828194829194830194831194832194833194834194835194836194837194838194839194840194841194842194843194844194845194846194847194848194849194850194851194852194853194854194855194856194857194858194859194860194861194862194863194864194865194866194867194868194869194870194871194872194873194874194875194876194877194878194879194880194881194882194883194884194885194886194887194888194889194890194891194892194893194894194895194896194897194898194899194900194901194902194903194904194905194906194907194908194909194910194911194912194913194914194915194916194917194918194919194920194921194922194923194924194925194926194927194928194929194930194931194932194933194934194935194936194937194938194939194940194941194942194943194944194945194946194947194948194949194950194951194952194953194954194955194956194957194958194959194960194961194962194963194964194965194966194967194968194969194970194971194972194973194974194975194976194977194978194979194980194981194982194983194984194985194986194987194988194989194990194991194992194993194994194995194996194997194998194999195000195001195002195003195004195005195006195007195008195009195010195011195012195013195014195015195016195017195018195019195020195021195022195023195024195025195026195027195028195029195030195031195032195033195034195035195036195037195038195039195040195041195042195043195044195045195046195047195048195049195050195051195052195053195054195055195056195057195058195059195060195061195062195063195064195065195066195067195068195069195070195071195072195073195074195075195076195077195078195079195080195081195082195083195084195085195086195087195088195089195090195091195092195093195094195095195096195097195098195099195100195101195102195103195104195105195106195107195108195109195110195111195112195113195114195115195116195117195118195119195120195121195122195123195124195125195126195127195128195129195130195131195132195133195134195135195136195137195138195139195140195141195142195143195144195145195146195147195148195149195150195151195152195153195154195155195156195157195158195159195160195161195162195163195164195165195166195167195168195169195170195171195172195173195174195175195176195177195178195179195180195181195182195183195184195185195186195187195188195189195190195191195192195193195194195195195196195197195198195199195200195201195202195203195204195205195206195207195208195209195210195211195212195213195214195215195216195217195218195219195220195221195222195223195224195225195226195227195228195229195230195231195232195233195234195235195236195237195238195239195240195241195242195243195244195245195246195247195248195249195250195251195252195253195254195255195256195257195258195259195260195261195262195263195264195265195266195267195268195269195270195271195272195273195274195275195276195277195278195279195280195281195282195283195284195285195286195287195288195289195290195291195292195293195294195295195296195297195298195299195300195301195302195303195304195305195306195307195308195309195310195311195312195313195314195315195316195317195318195319195320195321195322195323195324195325195326195327195328195329195330195331195332195333195334195335195336195337195338195339195340195341195342195343195344195345195346195347195348195349195350195351195352195353195354195355195356195357195358195359195360195361195362195363195364195365195366195367195368195369195370195371195372195373195374195375195376195377195378195379195380195381195382195383195384195385195386195387195388195389195390195391195392195393195394195395195396195397195398195399195400195401195402195403195404195405195406195407195408195409195410195411195412195413195414195415195416195417195418195419195420195421195422195423195424195425195426195427195428195429195430195431195432195433195434195435195436195437195438195439195440195441195442195443195444195445195446195447195448195449195450195451195452195453195454195455195456195457195458195459195460195461195462195463195464195465195466195467195468195469195470195471195472195473195474195475195476195477195478195479195480195481195482195483195484195485195486195487195488195489195490195491195492195493195494195495195496195497195498195499195500195501195502195503195504195505195506195507195508195509195510195511195512195513195514195515195516195517195518195519195520195521195522195523195524195525195526195527195528195529195530195531195532195533195534195535195536195537195538195539195540195541195542195543195544195545195546195547195548195549195550195551195552195553195554195555195556195557195558195559195560195561195562195563195564195565195566195567195568195569195570195571195572195573195574195575195576195577195578195579195580195581195582195583195584195585195586195587195588195589195590195591195592195593195594195595195596195597195598195599195600195601195602195603195604195605195606195607195608195609195610195611195612195613195614195615195616195617195618195619195620195621195622195623195624195625195626195627195628195629195630195631195632195633195634195635195636195637195638195639195640195641195642195643195644195645195646195647195648195649195650195651195652195653195654195655195656195657195658195659195660195661195662195663195664195665195666195667195668195669195670195671195672195673195674195675195676195677195678195679195680195681195682195683195684195685195686195687195688195689195690195691195692195693195694195695195696195697195698195699195700195701195702195703195704195705195706195707195708195709195710195711195712195713195714195715195716195717195718195719195720195721195722195723195724195725195726195727195728195729195730195731195732195733195734195735195736195737195738195739195740195741195742195743195744195745195746195747195748195749195750195751195752195753195754195755195756195757195758195759195760195761195762195763195764195765195766195767195768195769195770195771195772195773195774195775195776195777195778195779195780195781195782195783195784195785195786195787195788195789195790195791195792195793195794195795195796195797195798195799195800195801195802195803195804195805195806195807195808195809195810195811195812195813195814195815195816195817195818195819195820195821195822195823195824195825195826195827195828195829195830195831195832195833195834195835195836195837195838195839195840195841195842195843195844195845195846195847195848195849195850195851195852195853195854195855195856195857195858195859195860195861195862195863195864195865195866195867195868195869195870195871195872195873195874195875195876195877195878195879195880195881195882195883195884195885195886195887195888195889195890195891195892195893195894195895195896195897195898195899195900195901195902195903195904195905195906195907195908195909195910195911195912195913195914195915195916195917195918195919195920195921195922195923195924195925195926195927195928195929195930195931195932195933195934195935195936195937195938195939195940195941195942195943195944195945195946195947195948195949195950195951195952195953195954195955195956195957195958195959195960195961195962195963195964195965195966195967195968195969195970195971195972195973195974195975195976195977195978195979195980195981195982195983195984195985195986195987195988195989195990195991195992195993195994195995195996195997195998195999196000196001196002196003196004196005196006196007196008196009196010196011196012196013196014196015196016196017196018196019196020196021196022196023196024196025196026196027196028196029196030196031196032196033196034196035196036196037196038196039196040196041196042196043196044196045196046196047196048196049196050196051196052196053196054196055196056196057196058196059196060196061196062196063196064196065196066196067196068196069196070196071196072196073196074196075196076196077196078196079196080196081196082196083196084196085196086196087196088196089196090196091196092196093196094196095196096196097196098196099196100196101196102196103196104196105196106196107196108196109196110196111196112196113196114196115196116196117196118196119196120196121196122196123196124196125196126196127196128196129196130196131196132196133196134196135196136196137196138196139196140196141196142196143196144196145196146196147196148196149196150196151196152196153196154196155196156196157196158196159196160196161196162196163196164196165196166196167196168196169196170196171196172196173196174196175196176196177196178196179196180196181196182196183196184196185196186196187196188196189196190196191196192196193196194196195196196196197196198196199196200196201196202196203196204196205196206196207196208196209196210196211196212196213196214196215196216196217196218196219196220196221196222196223196224196225196226196227196228196229196230196231196232196233196234196235196236196237196238196239196240196241196242196243196244196245196246196247196248196249196250196251196252196253196254196255196256196257196258196259196260196261196262196263196264196265196266196267196268196269196270196271196272196273196274196275196276196277196278196279196280196281196282196283196284196285196286196287196288196289196290196291196292196293196294196295196296196297196298196299196300196301196302196303196304196305196306196307196308196309196310196311196312196313196314196315196316196317196318196319196320196321196322196323196324196325196326196327196328196329196330196331196332196333196334196335196336196337196338196339196340196341196342196343196344196345196346196347196348196349196350196351196352196353196354196355196356196357196358196359196360196361196362196363196364196365196366196367196368196369196370196371196372196373196374196375196376196377196378196379196380196381196382196383196384196385196386196387196388196389196390196391196392196393196394196395196396196397196398196399196400196401196402196403196404196405196406196407196408196409196410196411196412196413196414196415196416196417196418196419196420196421196422196423196424196425196426196427196428196429196430196431196432196433196434196435196436196437196438196439196440196441196442196443196444196445196446196447196448196449196450196451196452196453196454196455196456196457196458196459196460196461196462196463196464196465196466196467196468196469196470196471196472196473196474196475196476196477196478196479196480196481196482196483196484196485196486196487196488196489196490196491196492196493196494196495196496196497196498196499196500196501196502196503196504196505196506196507196508196509196510196511196512196513196514196515196516196517196518196519196520196521196522196523196524196525196526196527196528196529196530196531196532196533196534196535196536196537196538196539196540196541196542196543196544196545196546196547196548196549196550196551196552196553196554196555196556196557196558196559196560196561196562196563196564196565196566196567196568196569196570196571196572196573196574196575196576196577196578196579196580196581196582196583196584196585196586196587196588196589196590196591196592196593196594196595196596196597196598196599196600196601196602196603196604196605196606196607196608196609196610196611196612196613196614196615196616196617196618196619196620196621196622196623196624196625196626196627196628196629196630196631196632196633196634196635196636196637196638196639196640196641196642196643196644196645196646196647196648196649196650196651196652196653196654196655196656196657196658196659196660196661196662196663196664196665196666196667196668196669196670196671196672196673196674196675196676196677196678196679196680196681196682196683196684196685196686196687196688196689196690196691196692196693196694196695196696196697196698196699196700196701196702196703196704196705196706196707196708196709196710196711196712196713196714196715196716196717196718196719196720196721196722196723196724196725196726196727196728196729196730196731196732196733196734196735196736196737196738196739196740196741196742196743196744196745196746196747196748196749196750196751196752196753196754196755196756196757196758196759196760196761196762196763196764196765196766196767196768196769196770196771196772196773196774196775196776196777196778196779196780196781196782196783196784196785196786196787196788196789196790196791196792196793196794196795196796196797196798196799196800196801196802196803196804196805196806196807196808196809196810196811196812196813196814196815196816196817196818196819196820196821196822196823196824196825196826196827196828196829196830196831196832196833196834196835196836196837196838196839196840196841196842196843196844196845196846196847196848196849196850196851196852196853196854196855196856196857196858196859196860196861196862196863196864196865196866196867196868196869196870196871196872196873196874196875196876196877196878196879196880196881196882196883196884196885196886196887196888196889196890196891196892196893196894196895196896196897196898196899196900196901196902196903196904196905196906196907196908196909196910196911196912196913196914196915196916196917196918196919196920196921196922196923196924196925196926196927196928196929196930196931196932196933196934196935196936196937196938196939196940196941196942196943196944196945196946196947196948196949196950196951196952196953196954196955196956196957196958196959196960196961196962196963196964196965196966196967196968196969196970196971196972196973196974196975196976196977196978196979196980196981196982196983196984196985196986196987196988196989196990196991196992196993196994196995196996196997196998196999197000197001197002197003197004197005197006197007197008197009197010197011197012197013197014197015197016197017197018197019197020197021197022197023197024197025197026197027197028197029197030197031197032197033197034197035197036197037197038197039197040197041197042197043197044197045197046197047197048197049197050197051197052197053197054197055197056197057197058197059197060197061197062197063197064197065197066197067197068197069197070197071197072197073197074197075197076197077197078197079197080197081197082197083197084197085197086197087197088197089197090197091197092197093197094197095197096197097197098197099197100197101197102197103197104197105197106197107197108197109197110197111197112197113197114197115197116197117197118197119197120197121197122197123197124197125197126197127197128197129197130197131197132197133197134197135197136197137197138197139197140197141197142197143197144197145197146197147197148197149197150197151197152197153197154197155197156197157197158197159197160197161197162197163197164197165197166197167197168197169197170197171197172197173197174197175197176197177197178197179197180197181197182197183197184197185197186197187197188197189197190197191197192197193197194197195197196197197197198197199197200197201197202197203197204197205197206197207197208197209197210197211197212197213197214197215197216197217197218197219197220197221197222197223197224197225197226197227197228197229197230197231197232197233197234197235197236197237197238197239197240197241197242197243197244197245197246197247197248197249197250197251197252197253197254197255197256197257197258197259197260197261197262197263197264197265197266197267197268197269197270197271197272197273197274197275197276197277197278197279197280197281197282197283197284197285197286197287197288197289197290197291197292197293197294197295197296197297197298197299197300197301197302197303197304197305197306197307197308197309197310197311197312197313197314197315197316197317197318197319197320197321197322197323197324197325197326197327197328197329197330197331197332197333197334197335197336197337197338197339197340197341197342197343197344197345197346197347197348197349197350197351197352197353197354197355197356197357197358197359197360197361197362197363197364197365197366197367197368197369197370197371197372197373197374197375197376197377197378197379197380197381197382197383197384197385197386197387197388197389197390197391197392197393197394197395197396197397197398197399197400197401197402197403197404197405197406197407197408197409197410197411197412197413197414197415197416197417197418197419197420197421197422197423197424197425197426197427197428197429197430197431197432197433197434197435197436197437197438197439197440197441197442197443197444197445197446197447197448197449197450197451197452197453197454197455197456197457197458197459197460197461197462197463197464197465197466197467197468197469197470197471197472197473197474197475197476197477197478197479197480197481197482197483197484197485197486197487197488197489197490197491197492197493197494197495197496197497197498197499197500197501197502197503197504197505197506197507197508197509197510197511197512197513197514197515197516197517197518197519197520197521197522197523197524197525197526197527197528197529197530197531197532197533197534197535197536197537197538197539197540197541197542197543197544197545197546197547197548197549197550197551197552197553197554197555197556197557197558197559197560197561197562197563197564197565197566197567197568197569197570197571197572197573197574197575197576197577197578197579197580197581197582197583197584197585197586197587197588197589197590197591197592197593197594197595197596197597197598197599197600197601197602197603197604197605197606197607197608197609197610197611197612197613197614197615197616197617197618197619197620197621197622197623197624197625197626197627197628197629197630197631197632197633197634197635197636197637197638197639197640197641197642197643197644197645197646197647197648197649197650197651197652197653197654197655197656197657197658197659197660197661197662197663197664197665197666197667197668197669197670197671197672197673197674197675197676197677197678197679197680197681197682197683197684197685197686197687197688197689197690197691197692197693197694197695197696197697197698197699197700197701197702197703197704197705197706197707197708197709197710197711197712197713197714197715197716197717197718197719197720197721197722197723197724197725197726197727197728197729197730197731197732197733197734197735197736197737197738197739197740197741197742197743197744197745197746197747197748197749197750197751197752197753197754197755197756197757197758197759197760197761197762197763197764197765197766197767197768197769197770197771197772197773197774197775197776197777197778197779197780197781197782197783197784197785197786197787197788197789197790197791197792197793197794197795197796197797197798197799197800197801197802197803197804197805197806197807197808197809197810197811197812197813197814197815197816197817197818197819197820197821197822197823197824197825197826197827197828197829197830197831197832197833197834197835197836197837197838197839197840197841197842197843197844197845197846197847197848197849197850197851197852197853197854197855197856197857197858197859197860197861197862197863197864197865197866197867197868197869197870197871197872197873197874197875197876197877197878197879197880197881197882197883197884197885197886197887197888197889197890197891197892197893197894197895197896197897197898197899197900197901197902197903197904197905197906197907197908197909197910197911197912197913197914197915197916197917197918197919197920197921197922197923197924197925197926197927197928197929197930197931197932197933197934197935197936197937197938197939197940197941197942197943197944197945197946197947197948197949197950197951197952197953197954197955197956197957197958197959197960197961197962197963197964197965197966197967197968197969197970197971197972197973197974197975197976197977197978197979197980197981197982197983197984197985197986197987197988197989197990197991197992197993197994197995197996197997197998197999198000198001198002198003198004198005198006198007198008198009198010198011198012198013198014198015198016198017198018198019198020198021198022198023198024198025198026198027198028198029198030198031198032198033198034198035198036198037198038198039198040198041198042198043198044198045198046198047198048198049198050198051198052198053198054198055198056198057198058198059198060198061198062198063198064198065198066198067198068198069198070198071198072198073198074198075198076198077198078198079198080198081198082198083198084198085198086198087198088198089198090198091198092198093198094198095198096198097198098198099198100198101198102198103198104198105198106198107198108198109198110198111198112198113198114198115198116198117198118198119198120198121198122198123198124198125198126198127198128198129198130198131198132198133198134198135198136198137198138198139198140198141198142198143198144198145198146198147198148198149198150198151198152198153198154198155198156198157198158198159198160198161198162198163198164198165198166198167198168198169198170198171198172198173198174198175198176198177198178198179198180198181198182198183198184198185198186198187198188198189198190198191198192198193198194198195198196198197198198198199198200198201198202198203198204198205198206198207198208198209198210198211198212198213198214198215198216198217198218198219198220198221198222198223198224198225198226198227198228198229198230198231198232198233198234198235198236198237198238198239198240198241198242198243198244198245198246198247198248198249198250198251198252198253198254198255198256198257198258198259198260198261198262198263198264198265198266198267198268198269198270198271198272198273198274198275198276198277198278198279198280198281198282198283198284198285198286198287198288198289198290198291198292198293198294198295198296198297198298198299198300198301198302198303198304198305198306198307198308198309198310198311198312198313198314198315198316198317198318198319198320198321198322198323198324198325198326198327198328198329198330198331198332198333198334198335198336198337198338198339198340198341198342198343198344198345198346198347198348198349198350198351198352198353198354198355198356198357198358198359198360198361198362198363198364198365198366198367198368198369198370198371198372198373198374198375198376198377198378198379198380198381198382198383198384198385198386198387198388198389198390198391198392198393198394198395198396198397198398198399198400198401198402198403198404198405198406198407198408198409198410198411198412198413198414198415198416198417198418198419198420198421198422198423198424198425198426198427198428198429198430198431198432198433198434198435198436198437198438198439198440198441198442198443198444198445198446198447198448198449198450198451198452198453198454198455198456198457198458198459198460198461198462198463198464198465198466198467198468198469198470198471198472198473198474198475198476198477198478198479198480198481198482198483198484198485198486198487198488198489198490198491198492198493198494198495198496198497198498198499198500198501198502198503198504198505198506198507198508198509198510198511198512198513198514198515198516198517198518198519198520198521198522198523198524198525198526198527198528198529198530198531198532198533198534198535198536198537198538198539198540198541198542198543198544198545198546198547198548198549198550198551198552198553198554198555198556198557198558198559198560198561198562198563198564198565198566198567198568198569198570198571198572198573198574198575198576198577198578198579198580198581198582198583198584198585198586198587198588198589198590198591198592198593198594198595198596198597198598198599198600198601198602198603198604198605198606198607198608198609198610198611198612198613198614198615198616198617198618198619198620198621198622198623198624198625198626198627198628198629198630198631198632198633198634198635198636198637198638198639198640198641198642198643198644198645198646198647198648198649198650198651198652198653198654198655198656198657198658198659198660198661198662198663198664198665198666198667198668198669198670198671198672198673198674198675198676198677198678198679198680198681198682198683198684198685198686198687198688198689198690198691198692198693198694198695198696198697198698198699198700198701198702198703198704198705198706198707198708198709198710198711198712198713198714198715198716198717198718198719198720198721198722198723198724198725198726198727198728198729198730198731198732198733198734198735198736198737198738198739198740198741198742198743198744198745198746198747198748198749198750198751198752198753198754198755198756198757198758198759198760198761198762198763198764198765198766198767198768198769198770198771198772198773198774198775198776198777198778198779198780198781198782198783198784198785198786198787198788198789198790198791198792198793198794198795198796198797198798198799198800198801198802198803198804198805198806198807198808198809198810198811198812198813198814198815198816198817198818198819198820198821198822198823198824198825198826198827198828198829198830198831198832198833198834198835198836198837198838198839198840198841198842198843198844198845198846198847198848198849198850198851198852198853198854198855198856198857198858198859198860198861198862198863198864198865198866198867198868198869198870198871198872198873198874198875198876198877198878198879198880198881198882198883198884198885198886198887198888198889198890198891198892198893198894198895198896198897198898198899198900198901198902198903198904198905198906198907198908198909198910198911198912198913198914198915198916198917198918198919198920198921198922198923198924198925198926198927198928198929198930198931198932198933198934198935198936198937198938198939198940198941198942198943198944198945198946198947198948198949198950198951198952198953198954198955198956198957198958198959198960198961198962198963198964198965198966198967198968198969198970198971198972198973198974198975198976198977198978198979198980198981198982198983198984198985198986198987198988198989198990198991198992198993198994198995198996198997198998198999199000199001199002199003199004199005199006199007199008199009199010199011199012199013199014199015199016199017199018199019199020199021199022199023199024199025199026199027199028199029199030199031199032199033199034199035199036199037199038199039199040199041199042199043199044199045199046199047199048199049199050199051199052199053199054199055199056199057199058199059199060199061199062199063199064199065199066199067199068199069199070199071199072199073199074199075199076199077199078199079199080199081199082199083199084199085199086199087199088199089199090199091199092199093199094199095199096199097199098199099199100199101199102199103199104199105199106199107199108199109199110199111199112199113199114199115199116199117199118199119199120199121199122199123199124199125199126199127199128199129199130199131199132199133199134199135199136199137199138199139199140199141199142199143199144199145199146199147199148199149199150199151199152199153199154199155199156199157199158199159199160199161199162199163199164199165199166199167199168199169199170199171199172199173199174199175199176199177199178199179199180199181199182199183199184199185199186199187199188199189199190199191199192199193199194199195199196199197199198199199199200199201199202199203199204199205199206199207199208199209199210199211199212199213199214199215199216199217199218199219199220199221199222199223199224199225199226199227199228199229199230199231199232199233199234199235199236199237199238199239199240199241199242199243199244199245199246199247199248199249199250199251199252199253199254199255199256199257199258199259199260199261199262199263199264199265199266199267199268199269199270199271199272199273199274199275199276199277199278199279199280199281199282199283199284199285199286199287199288199289199290199291199292199293199294199295199296199297199298199299199300199301199302199303199304199305199306199307199308199309199310199311199312199313199314199315199316199317199318199319199320199321199322199323199324199325199326199327199328199329199330199331199332199333199334199335199336199337199338199339199340199341199342199343199344199345199346199347199348199349199350199351199352199353199354199355199356199357199358199359199360199361199362199363199364199365199366199367199368199369199370199371199372199373199374199375199376199377199378199379199380199381199382199383199384199385199386199387199388199389199390199391199392199393199394199395199396199397199398199399199400199401199402199403199404199405199406199407199408199409199410199411199412199413199414199415199416199417199418199419199420199421199422199423199424199425199426199427199428199429199430199431199432199433199434199435199436199437199438199439199440199441199442199443199444199445199446199447199448199449199450199451199452199453199454199455199456199457199458199459199460199461199462199463199464199465199466199467199468199469199470199471199472199473199474199475199476199477199478199479199480199481199482199483199484199485199486199487199488199489
  1. #ifndef USE_LIBSQLITE3
  2. /******************************************************************************
  3. ** This file is an amalgamation of many separate C source files from SQLite
  4. ** version 3.15.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 sqliteInt.h ***************************************/
  27. /*
  28. ** 2001 September 15
  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. ** Internal interface definitions for SQLite.
  39. **
  40. */
  41. #ifndef SQLITEINT_H
  42. #define SQLITEINT_H
  43. /* Special Comments:
  44. **
  45. ** Some comments have special meaning to the tools that measure test
  46. ** coverage:
  47. **
  48. ** NO_TEST - The branches on this line are not
  49. ** measured by branch coverage. This is
  50. ** used on lines of code that actually
  51. ** implement parts of coverage testing.
  52. **
  53. ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false
  54. ** and the correct answer is still obtained,
  55. ** though perhaps more slowly.
  56. **
  57. ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true
  58. ** and the correct answer is still obtained,
  59. ** though perhaps more slowly.
  60. **
  61. ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread
  62. ** that would be harmless and undetectable
  63. ** if it did occur.
  64. **
  65. ** In all cases, the special comment must be enclosed in the usual
  66. ** slash-asterisk...asterisk-slash comment marks, with no spaces between the
  67. ** asterisks and the comment text.
  68. */
  69. /*
  70. ** Make sure the Tcl calling convention macro is defined. This macro is
  71. ** only used by test code and Tcl integration code.
  72. */
  73. #ifndef SQLITE_TCLAPI
  74. # define SQLITE_TCLAPI
  75. #endif
  76. /*
  77. ** Make sure that rand_s() is available on Windows systems with MSVC 2005
  78. ** or higher.
  79. */
  80. #if defined(_MSC_VER) && _MSC_VER>=1400
  81. # define _CRT_RAND_S
  82. #endif
  83. /*
  84. ** Include the header file used to customize the compiler options for MSVC.
  85. ** This should be done first so that it can successfully prevent spurious
  86. ** compiler warnings due to subsequent content in this file and other files
  87. ** that are included by this file.
  88. */
  89. /************** Include msvc.h in the middle of sqliteInt.h ******************/
  90. /************** Begin file msvc.h ********************************************/
  91. /*
  92. ** 2015 January 12
  93. **
  94. ** The author disclaims copyright to this source code. In place of
  95. ** a legal notice, here is a blessing:
  96. **
  97. ** May you do good and not evil.
  98. ** May you find forgiveness for yourself and forgive others.
  99. ** May you share freely, never taking more than you give.
  100. **
  101. ******************************************************************************
  102. **
  103. ** This file contains code that is specific to MSVC.
  104. */
  105. #ifndef SQLITE_MSVC_H
  106. #define SQLITE_MSVC_H
  107. #if defined(_MSC_VER)
  108. #pragma warning(disable : 4054)
  109. #pragma warning(disable : 4055)
  110. #pragma warning(disable : 4100)
  111. #pragma warning(disable : 4127)
  112. #pragma warning(disable : 4130)
  113. #pragma warning(disable : 4152)
  114. #pragma warning(disable : 4189)
  115. #pragma warning(disable : 4206)
  116. #pragma warning(disable : 4210)
  117. #pragma warning(disable : 4232)
  118. #pragma warning(disable : 4244)
  119. #pragma warning(disable : 4305)
  120. #pragma warning(disable : 4306)
  121. #pragma warning(disable : 4702)
  122. #pragma warning(disable : 4706)
  123. #endif /* defined(_MSC_VER) */
  124. #endif /* SQLITE_MSVC_H */
  125. /************** End of msvc.h ************************************************/
  126. /************** Continuing where we left off in sqliteInt.h ******************/
  127. /*
  128. ** Special setup for VxWorks
  129. */
  130. /************** Include vxworks.h in the middle of sqliteInt.h ***************/
  131. /************** Begin file vxworks.h *****************************************/
  132. /*
  133. ** 2015-03-02
  134. **
  135. ** The author disclaims copyright to this source code. In place of
  136. ** a legal notice, here is a blessing:
  137. **
  138. ** May you do good and not evil.
  139. ** May you find forgiveness for yourself and forgive others.
  140. ** May you share freely, never taking more than you give.
  141. **
  142. ******************************************************************************
  143. **
  144. ** This file contains code that is specific to Wind River's VxWorks
  145. */
  146. #if defined(__RTP__) || defined(_WRS_KERNEL)
  147. /* This is VxWorks. Set up things specially for that OS
  148. */
  149. #include <vxWorks.h>
  150. #include <pthread.h> /* amalgamator: dontcache */
  151. #define OS_VXWORKS 1
  152. #define SQLITE_OS_OTHER 0
  153. #define SQLITE_HOMEGROWN_RECURSIVE_MUTEX 1
  154. #define SQLITE_OMIT_LOAD_EXTENSION 1
  155. #define SQLITE_ENABLE_LOCKING_STYLE 0
  156. #define HAVE_UTIME 1
  157. #else
  158. /* This is not VxWorks. */
  159. #define OS_VXWORKS 0
  160. #define HAVE_FCHOWN 1
  161. #define HAVE_READLINK 1
  162. #define HAVE_LSTAT 1
  163. #endif /* defined(_WRS_KERNEL) */
  164. /************** End of vxworks.h *********************************************/
  165. /************** Continuing where we left off in sqliteInt.h ******************/
  166. /*
  167. ** These #defines should enable >2GB file support on POSIX if the
  168. ** underlying operating system supports it. If the OS lacks
  169. ** large file support, or if the OS is windows, these should be no-ops.
  170. **
  171. ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
  172. ** system #includes. Hence, this block of code must be the very first
  173. ** code in all source files.
  174. **
  175. ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
  176. ** on the compiler command line. This is necessary if you are compiling
  177. ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
  178. ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
  179. ** without this option, LFS is enable. But LFS does not exist in the kernel
  180. ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
  181. ** portability you should omit LFS.
  182. **
  183. ** The previous paragraph was written in 2005. (This paragraph is written
  184. ** on 2008-11-28.) These days, all Linux kernels support large files, so
  185. ** you should probably leave LFS enabled. But some embedded platforms might
  186. ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
  187. **
  188. ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
  189. */
  190. #ifndef SQLITE_DISABLE_LFS
  191. # define _LARGE_FILE 1
  192. # ifndef _FILE_OFFSET_BITS
  193. # define _FILE_OFFSET_BITS 64
  194. # endif
  195. # define _LARGEFILE_SOURCE 1
  196. #endif
  197. /* What version of GCC is being used. 0 means GCC is not being used */
  198. #ifdef __GNUC__
  199. # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
  200. #else
  201. # define GCC_VERSION 0
  202. #endif
  203. /* Needed for various definitions... */
  204. #if defined(__GNUC__) && !defined(_GNU_SOURCE)
  205. # define _GNU_SOURCE
  206. #endif
  207. #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
  208. # define _BSD_SOURCE
  209. #endif
  210. /*
  211. ** For MinGW, check to see if we can include the header file containing its
  212. ** version information, among other things. Normally, this internal MinGW
  213. ** header file would [only] be included automatically by other MinGW header
  214. ** files; however, the contained version information is now required by this
  215. ** header file to work around binary compatibility issues (see below) and
  216. ** this is the only known way to reliably obtain it. This entire #if block
  217. ** would be completely unnecessary if there was any other way of detecting
  218. ** MinGW via their preprocessor (e.g. if they customized their GCC to define
  219. ** some MinGW-specific macros). When compiling for MinGW, either the
  220. ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
  221. ** defined; otherwise, detection of conditions specific to MinGW will be
  222. ** disabled.
  223. */
  224. #if defined(_HAVE_MINGW_H)
  225. # include "mingw.h"
  226. #elif defined(_HAVE__MINGW_H)
  227. # include "_mingw.h"
  228. #endif
  229. /*
  230. ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
  231. ** define is required to maintain binary compatibility with the MSVC runtime
  232. ** library in use (e.g. for Windows XP).
  233. */
  234. #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
  235. defined(_WIN32) && !defined(_WIN64) && \
  236. defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
  237. defined(__MSVCRT__)
  238. # define _USE_32BIT_TIME_T
  239. #endif
  240. /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
  241. ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
  242. ** MinGW.
  243. */
  244. /************** Include sqlite3.h in the middle of sqliteInt.h ***************/
  245. /************** Begin file sqlite3.h *****************************************/
  246. /*
  247. ** 2001 September 15
  248. **
  249. ** The author disclaims copyright to this source code. In place of
  250. ** a legal notice, here is a blessing:
  251. **
  252. ** May you do good and not evil.
  253. ** May you find forgiveness for yourself and forgive others.
  254. ** May you share freely, never taking more than you give.
  255. **
  256. *************************************************************************
  257. ** This header file defines the interface that the SQLite library
  258. ** presents to client programs. If a C-function, structure, datatype,
  259. ** or constant definition does not appear in this file, then it is
  260. ** not a published API of SQLite, is subject to change without
  261. ** notice, and should not be referenced by programs that use SQLite.
  262. **
  263. ** Some of the definitions that are in this file are marked as
  264. ** "experimental". Experimental interfaces are normally new
  265. ** features recently added to SQLite. We do not anticipate changes
  266. ** to experimental interfaces but reserve the right to make minor changes
  267. ** if experience from use "in the wild" suggest such changes are prudent.
  268. **
  269. ** The official C-language API documentation for SQLite is derived
  270. ** from comments in this file. This file is the authoritative source
  271. ** on how SQLite interfaces are supposed to operate.
  272. **
  273. ** The name of this file under configuration management is "sqlite.h.in".
  274. ** The makefile makes some minor changes to this file (such as inserting
  275. ** the version number) and changes its name to "sqlite3.h" as
  276. ** part of the build process.
  277. */
  278. #ifndef SQLITE3_H
  279. #define SQLITE3_H
  280. #include <stdarg.h> /* Needed for the definition of va_list */
  281. /*
  282. ** Make sure we can call this stuff from C++.
  283. */
  284. #if 0
  285. extern "C" {
  286. #endif
  287. /*
  288. ** Provide the ability to override linkage features of the interface.
  289. */
  290. #ifndef SQLITE_EXTERN
  291. # define SQLITE_EXTERN extern
  292. #endif
  293. #ifndef SQLITE_API
  294. # define SQLITE_API
  295. #endif
  296. #ifndef SQLITE_CDECL
  297. # define SQLITE_CDECL
  298. #endif
  299. #ifndef SQLITE_APICALL
  300. # define SQLITE_APICALL
  301. #endif
  302. #ifndef SQLITE_STDCALL
  303. # define SQLITE_STDCALL SQLITE_APICALL
  304. #endif
  305. #ifndef SQLITE_CALLBACK
  306. # define SQLITE_CALLBACK
  307. #endif
  308. #ifndef SQLITE_SYSAPI
  309. # define SQLITE_SYSAPI
  310. #endif
  311. /*
  312. ** These no-op macros are used in front of interfaces to mark those
  313. ** interfaces as either deprecated or experimental. New applications
  314. ** should not use deprecated interfaces - they are supported for backwards
  315. ** compatibility only. Application writers should be aware that
  316. ** experimental interfaces are subject to change in point releases.
  317. **
  318. ** These macros used to resolve to various kinds of compiler magic that
  319. ** would generate warning messages when they were used. But that
  320. ** compiler magic ended up generating such a flurry of bug reports
  321. ** that we have taken it all out and gone back to using simple
  322. ** noop macros.
  323. */
  324. #define SQLITE_DEPRECATED
  325. #define SQLITE_EXPERIMENTAL
  326. /*
  327. ** Ensure these symbols were not defined by some previous header file.
  328. */
  329. #ifdef SQLITE_VERSION
  330. # undef SQLITE_VERSION
  331. #endif
  332. #ifdef SQLITE_VERSION_NUMBER
  333. # undef SQLITE_VERSION_NUMBER
  334. #endif
  335. /*
  336. ** CAPI3REF: Compile-Time Library Version Numbers
  337. **
  338. ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
  339. ** evaluates to a string literal that is the SQLite version in the
  340. ** format "X.Y.Z" where X is the major version number (always 3 for
  341. ** SQLite3) and Y is the minor version number and Z is the release number.)^
  342. ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
  343. ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
  344. ** numbers used in [SQLITE_VERSION].)^
  345. ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
  346. ** be larger than the release from which it is derived. Either Y will
  347. ** be held constant and Z will be incremented or else Y will be incremented
  348. ** and Z will be reset to zero.
  349. **
  350. ** Since [version 3.6.18] ([dateof:3.6.18]),
  351. ** SQLite source code has been stored in the
  352. ** <a href="http://www.fossil-scm.org/">Fossil configuration management
  353. ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
  354. ** a string which identifies a particular check-in of SQLite
  355. ** within its configuration management system. ^The SQLITE_SOURCE_ID
  356. ** string contains the date and time of the check-in (UTC) and an SHA1
  357. ** hash of the entire source tree.
  358. **
  359. ** See also: [sqlite3_libversion()],
  360. ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
  361. ** [sqlite_version()] and [sqlite_source_id()].
  362. */
  363. #define SQLITE_VERSION "3.15.1"
  364. #define SQLITE_VERSION_NUMBER 3015001
  365. #define SQLITE_SOURCE_ID "2016-11-04 12:08:49 1136863c76576110e710dd5d69ab6bf347c65e36"
  366. /*
  367. ** CAPI3REF: Run-Time Library Version Numbers
  368. ** KEYWORDS: sqlite3_version, sqlite3_sourceid
  369. **
  370. ** These interfaces provide the same information as the [SQLITE_VERSION],
  371. ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
  372. ** but are associated with the library instead of the header file. ^(Cautious
  373. ** programmers might include assert() statements in their application to
  374. ** verify that values returned by these interfaces match the macros in
  375. ** the header, and thus ensure that the application is
  376. ** compiled with matching library and header files.
  377. **
  378. ** <blockquote><pre>
  379. ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
  380. ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
  381. ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
  382. ** </pre></blockquote>)^
  383. **
  384. ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
  385. ** macro. ^The sqlite3_libversion() function returns a pointer to the
  386. ** to the sqlite3_version[] string constant. The sqlite3_libversion()
  387. ** function is provided for use in DLLs since DLL users usually do not have
  388. ** direct access to string constants within the DLL. ^The
  389. ** sqlite3_libversion_number() function returns an integer equal to
  390. ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
  391. ** a pointer to a string constant whose value is the same as the
  392. ** [SQLITE_SOURCE_ID] C preprocessor macro.
  393. **
  394. ** See also: [sqlite_version()] and [sqlite_source_id()].
  395. */
  396. SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
  397. SQLITE_API const char *sqlite3_libversion(void);
  398. SQLITE_API const char *sqlite3_sourceid(void);
  399. SQLITE_API int sqlite3_libversion_number(void);
  400. /*
  401. ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
  402. **
  403. ** ^The sqlite3_compileoption_used() function returns 0 or 1
  404. ** indicating whether the specified option was defined at
  405. ** compile time. ^The SQLITE_ prefix may be omitted from the
  406. ** option name passed to sqlite3_compileoption_used().
  407. **
  408. ** ^The sqlite3_compileoption_get() function allows iterating
  409. ** over the list of options that were defined at compile time by
  410. ** returning the N-th compile time option string. ^If N is out of range,
  411. ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
  412. ** prefix is omitted from any strings returned by
  413. ** sqlite3_compileoption_get().
  414. **
  415. ** ^Support for the diagnostic functions sqlite3_compileoption_used()
  416. ** and sqlite3_compileoption_get() may be omitted by specifying the
  417. ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
  418. **
  419. ** See also: SQL functions [sqlite_compileoption_used()] and
  420. ** [sqlite_compileoption_get()] and the [compile_options pragma].
  421. */
  422. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  423. SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
  424. SQLITE_API const char *sqlite3_compileoption_get(int N);
  425. #endif
  426. /*
  427. ** CAPI3REF: Test To See If The Library Is Threadsafe
  428. **
  429. ** ^The sqlite3_threadsafe() function returns zero if and only if
  430. ** SQLite was compiled with mutexing code omitted due to the
  431. ** [SQLITE_THREADSAFE] compile-time option being set to 0.
  432. **
  433. ** SQLite can be compiled with or without mutexes. When
  434. ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
  435. ** are enabled and SQLite is threadsafe. When the
  436. ** [SQLITE_THREADSAFE] macro is 0,
  437. ** the mutexes are omitted. Without the mutexes, it is not safe
  438. ** to use SQLite concurrently from more than one thread.
  439. **
  440. ** Enabling mutexes incurs a measurable performance penalty.
  441. ** So if speed is of utmost importance, it makes sense to disable
  442. ** the mutexes. But for maximum safety, mutexes should be enabled.
  443. ** ^The default behavior is for mutexes to be enabled.
  444. **
  445. ** This interface can be used by an application to make sure that the
  446. ** version of SQLite that it is linking against was compiled with
  447. ** the desired setting of the [SQLITE_THREADSAFE] macro.
  448. **
  449. ** This interface only reports on the compile-time mutex setting
  450. ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
  451. ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
  452. ** can be fully or partially disabled using a call to [sqlite3_config()]
  453. ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
  454. ** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
  455. ** sqlite3_threadsafe() function shows only the compile-time setting of
  456. ** thread safety, not any run-time changes to that setting made by
  457. ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
  458. ** is unchanged by calls to sqlite3_config().)^
  459. **
  460. ** See the [threading mode] documentation for additional information.
  461. */
  462. SQLITE_API int sqlite3_threadsafe(void);
  463. /*
  464. ** CAPI3REF: Database Connection Handle
  465. ** KEYWORDS: {database connection} {database connections}
  466. **
  467. ** Each open SQLite database is represented by a pointer to an instance of
  468. ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
  469. ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
  470. ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
  471. ** and [sqlite3_close_v2()] are its destructors. There are many other
  472. ** interfaces (such as
  473. ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
  474. ** [sqlite3_busy_timeout()] to name but three) that are methods on an
  475. ** sqlite3 object.
  476. */
  477. typedef struct sqlite3 sqlite3;
  478. /*
  479. ** CAPI3REF: 64-Bit Integer Types
  480. ** KEYWORDS: sqlite_int64 sqlite_uint64
  481. **
  482. ** Because there is no cross-platform way to specify 64-bit integer types
  483. ** SQLite includes typedefs for 64-bit signed and unsigned integers.
  484. **
  485. ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
  486. ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
  487. ** compatibility only.
  488. **
  489. ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
  490. ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
  491. ** sqlite3_uint64 and sqlite_uint64 types can store integer values
  492. ** between 0 and +18446744073709551615 inclusive.
  493. */
  494. #ifdef SQLITE_INT64_TYPE
  495. typedef SQLITE_INT64_TYPE sqlite_int64;
  496. typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
  497. #elif defined(_MSC_VER) || defined(__BORLANDC__)
  498. typedef __int64 sqlite_int64;
  499. typedef unsigned __int64 sqlite_uint64;
  500. #else
  501. typedef long long int sqlite_int64;
  502. typedef unsigned long long int sqlite_uint64;
  503. #endif
  504. typedef sqlite_int64 sqlite3_int64;
  505. typedef sqlite_uint64 sqlite3_uint64;
  506. /*
  507. ** If compiling for a processor that lacks floating point support,
  508. ** substitute integer for floating-point.
  509. */
  510. #ifdef SQLITE_OMIT_FLOATING_POINT
  511. # define double sqlite3_int64
  512. #endif
  513. /*
  514. ** CAPI3REF: Closing A Database Connection
  515. ** DESTRUCTOR: sqlite3
  516. **
  517. ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
  518. ** for the [sqlite3] object.
  519. ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
  520. ** the [sqlite3] object is successfully destroyed and all associated
  521. ** resources are deallocated.
  522. **
  523. ** ^If the database connection is associated with unfinalized prepared
  524. ** statements or unfinished sqlite3_backup objects then sqlite3_close()
  525. ** will leave the database connection open and return [SQLITE_BUSY].
  526. ** ^If sqlite3_close_v2() is called with unfinalized prepared statements
  527. ** and/or unfinished sqlite3_backups, then the database connection becomes
  528. ** an unusable "zombie" which will automatically be deallocated when the
  529. ** last prepared statement is finalized or the last sqlite3_backup is
  530. ** finished. The sqlite3_close_v2() interface is intended for use with
  531. ** host languages that are garbage collected, and where the order in which
  532. ** destructors are called is arbitrary.
  533. **
  534. ** Applications should [sqlite3_finalize | finalize] all [prepared statements],
  535. ** [sqlite3_blob_close | close] all [BLOB handles], and
  536. ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
  537. ** with the [sqlite3] object prior to attempting to close the object. ^If
  538. ** sqlite3_close_v2() is called on a [database connection] that still has
  539. ** outstanding [prepared statements], [BLOB handles], and/or
  540. ** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
  541. ** of resources is deferred until all [prepared statements], [BLOB handles],
  542. ** and [sqlite3_backup] objects are also destroyed.
  543. **
  544. ** ^If an [sqlite3] object is destroyed while a transaction is open,
  545. ** the transaction is automatically rolled back.
  546. **
  547. ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
  548. ** must be either a NULL
  549. ** pointer or an [sqlite3] object pointer obtained
  550. ** from [sqlite3_open()], [sqlite3_open16()], or
  551. ** [sqlite3_open_v2()], and not previously closed.
  552. ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
  553. ** argument is a harmless no-op.
  554. */
  555. SQLITE_API int sqlite3_close(sqlite3*);
  556. SQLITE_API int sqlite3_close_v2(sqlite3*);
  557. /*
  558. ** The type for a callback function.
  559. ** This is legacy and deprecated. It is included for historical
  560. ** compatibility and is not documented.
  561. */
  562. typedef int (*sqlite3_callback)(void*,int,char**, char**);
  563. /*
  564. ** CAPI3REF: One-Step Query Execution Interface
  565. ** METHOD: sqlite3
  566. **
  567. ** The sqlite3_exec() interface is a convenience wrapper around
  568. ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
  569. ** that allows an application to run multiple statements of SQL
  570. ** without having to use a lot of C code.
  571. **
  572. ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
  573. ** semicolon-separate SQL statements passed into its 2nd argument,
  574. ** in the context of the [database connection] passed in as its 1st
  575. ** argument. ^If the callback function of the 3rd argument to
  576. ** sqlite3_exec() is not NULL, then it is invoked for each result row
  577. ** coming out of the evaluated SQL statements. ^The 4th argument to
  578. ** sqlite3_exec() is relayed through to the 1st argument of each
  579. ** callback invocation. ^If the callback pointer to sqlite3_exec()
  580. ** is NULL, then no callback is ever invoked and result rows are
  581. ** ignored.
  582. **
  583. ** ^If an error occurs while evaluating the SQL statements passed into
  584. ** sqlite3_exec(), then execution of the current statement stops and
  585. ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
  586. ** is not NULL then any error message is written into memory obtained
  587. ** from [sqlite3_malloc()] and passed back through the 5th parameter.
  588. ** To avoid memory leaks, the application should invoke [sqlite3_free()]
  589. ** on error message strings returned through the 5th parameter of
  590. ** sqlite3_exec() after the error message string is no longer needed.
  591. ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
  592. ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
  593. ** NULL before returning.
  594. **
  595. ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
  596. ** routine returns SQLITE_ABORT without invoking the callback again and
  597. ** without running any subsequent SQL statements.
  598. **
  599. ** ^The 2nd argument to the sqlite3_exec() callback function is the
  600. ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
  601. ** callback is an array of pointers to strings obtained as if from
  602. ** [sqlite3_column_text()], one for each column. ^If an element of a
  603. ** result row is NULL then the corresponding string pointer for the
  604. ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
  605. ** sqlite3_exec() callback is an array of pointers to strings where each
  606. ** entry represents the name of corresponding result column as obtained
  607. ** from [sqlite3_column_name()].
  608. **
  609. ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
  610. ** to an empty string, or a pointer that contains only whitespace and/or
  611. ** SQL comments, then no SQL statements are evaluated and the database
  612. ** is not changed.
  613. **
  614. ** Restrictions:
  615. **
  616. ** <ul>
  617. ** <li> The application must ensure that the 1st parameter to sqlite3_exec()
  618. ** is a valid and open [database connection].
  619. ** <li> The application must not close the [database connection] specified by
  620. ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
  621. ** <li> The application must not modify the SQL statement text passed into
  622. ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
  623. ** </ul>
  624. */
  625. SQLITE_API int sqlite3_exec(
  626. sqlite3*, /* An open database */
  627. const char *sql, /* SQL to be evaluated */
  628. int (*callback)(void*,int,char**,char**), /* Callback function */
  629. void *, /* 1st argument to callback */
  630. char **errmsg /* Error msg written here */
  631. );
  632. /*
  633. ** CAPI3REF: Result Codes
  634. ** KEYWORDS: {result code definitions}
  635. **
  636. ** Many SQLite functions return an integer result code from the set shown
  637. ** here in order to indicate success or failure.
  638. **
  639. ** New error codes may be added in future versions of SQLite.
  640. **
  641. ** See also: [extended result code definitions]
  642. */
  643. #define SQLITE_OK 0 /* Successful result */
  644. /* beginning-of-error-codes */
  645. #define SQLITE_ERROR 1 /* SQL error or missing database */
  646. #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
  647. #define SQLITE_PERM 3 /* Access permission denied */
  648. #define SQLITE_ABORT 4 /* Callback routine requested an abort */
  649. #define SQLITE_BUSY 5 /* The database file is locked */
  650. #define SQLITE_LOCKED 6 /* A table in the database is locked */
  651. #define SQLITE_NOMEM 7 /* A malloc() failed */
  652. #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
  653. #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
  654. #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
  655. #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
  656. #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
  657. #define SQLITE_FULL 13 /* Insertion failed because database is full */
  658. #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
  659. #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
  660. #define SQLITE_EMPTY 16 /* Database is empty */
  661. #define SQLITE_SCHEMA 17 /* The database schema changed */
  662. #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
  663. #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
  664. #define SQLITE_MISMATCH 20 /* Data type mismatch */
  665. #define SQLITE_MISUSE 21 /* Library used incorrectly */
  666. #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
  667. #define SQLITE_AUTH 23 /* Authorization denied */
  668. #define SQLITE_FORMAT 24 /* Auxiliary database format error */
  669. #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
  670. #define SQLITE_NOTADB 26 /* File opened that is not a database file */
  671. #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
  672. #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
  673. #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
  674. #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
  675. /* end-of-error-codes */
  676. /*
  677. ** CAPI3REF: Extended Result Codes
  678. ** KEYWORDS: {extended result code definitions}
  679. **
  680. ** In its default configuration, SQLite API routines return one of 30 integer
  681. ** [result codes]. However, experience has shown that many of
  682. ** these result codes are too coarse-grained. They do not provide as
  683. ** much information about problems as programmers might like. In an effort to
  684. ** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
  685. ** and later) include
  686. ** support for additional result codes that provide more detailed information
  687. ** about errors. These [extended result codes] are enabled or disabled
  688. ** on a per database connection basis using the
  689. ** [sqlite3_extended_result_codes()] API. Or, the extended code for
  690. ** the most recent error can be obtained using
  691. ** [sqlite3_extended_errcode()].
  692. */
  693. #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
  694. #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
  695. #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
  696. #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
  697. #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
  698. #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
  699. #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
  700. #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
  701. #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
  702. #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
  703. #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
  704. #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
  705. #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
  706. #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
  707. #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
  708. #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
  709. #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
  710. #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
  711. #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
  712. #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
  713. #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
  714. #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
  715. #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
  716. #define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
  717. #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
  718. #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
  719. #define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
  720. #define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
  721. #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
  722. #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
  723. #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
  724. #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
  725. #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
  726. #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
  727. #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
  728. #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
  729. #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
  730. #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
  731. #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
  732. #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8))
  733. #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
  734. #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
  735. #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
  736. #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
  737. #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
  738. #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
  739. #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
  740. #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
  741. #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
  742. #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
  743. #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8))
  744. #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
  745. #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
  746. #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
  747. #define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
  748. #define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8))
  749. /*
  750. ** CAPI3REF: Flags For File Open Operations
  751. **
  752. ** These bit values are intended for use in the
  753. ** 3rd parameter to the [sqlite3_open_v2()] interface and
  754. ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
  755. */
  756. #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
  757. #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
  758. #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
  759. #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
  760. #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
  761. #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
  762. #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
  763. #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
  764. #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
  765. #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
  766. #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
  767. #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
  768. #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
  769. #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
  770. #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
  771. #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
  772. #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
  773. #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
  774. #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
  775. #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
  776. /* Reserved: 0x00F00000 */
  777. /*
  778. ** CAPI3REF: Device Characteristics
  779. **
  780. ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
  781. ** object returns an integer which is a vector of these
  782. ** bit values expressing I/O characteristics of the mass storage
  783. ** device that holds the file that the [sqlite3_io_methods]
  784. ** refers to.
  785. **
  786. ** The SQLITE_IOCAP_ATOMIC property means that all writes of
  787. ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
  788. ** mean that writes of blocks that are nnn bytes in size and
  789. ** are aligned to an address which is an integer multiple of
  790. ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
  791. ** that when data is appended to a file, the data is appended
  792. ** first then the size of the file is extended, never the other
  793. ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
  794. ** information is written to disk in the same order as calls
  795. ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
  796. ** after reboot following a crash or power loss, the only bytes in a
  797. ** file that were written at the application level might have changed
  798. ** and that adjacent bytes, even bytes within the same sector are
  799. ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
  800. ** flag indicate that a file cannot be deleted when open. The
  801. ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
  802. ** read-only media and cannot be changed even by processes with
  803. ** elevated privileges.
  804. */
  805. #define SQLITE_IOCAP_ATOMIC 0x00000001
  806. #define SQLITE_IOCAP_ATOMIC512 0x00000002
  807. #define SQLITE_IOCAP_ATOMIC1K 0x00000004
  808. #define SQLITE_IOCAP_ATOMIC2K 0x00000008
  809. #define SQLITE_IOCAP_ATOMIC4K 0x00000010
  810. #define SQLITE_IOCAP_ATOMIC8K 0x00000020
  811. #define SQLITE_IOCAP_ATOMIC16K 0x00000040
  812. #define SQLITE_IOCAP_ATOMIC32K 0x00000080
  813. #define SQLITE_IOCAP_ATOMIC64K 0x00000100
  814. #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
  815. #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
  816. #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
  817. #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
  818. #define SQLITE_IOCAP_IMMUTABLE 0x00002000
  819. /*
  820. ** CAPI3REF: File Locking Levels
  821. **
  822. ** SQLite uses one of these integer values as the second
  823. ** argument to calls it makes to the xLock() and xUnlock() methods
  824. ** of an [sqlite3_io_methods] object.
  825. */
  826. #define SQLITE_LOCK_NONE 0
  827. #define SQLITE_LOCK_SHARED 1
  828. #define SQLITE_LOCK_RESERVED 2
  829. #define SQLITE_LOCK_PENDING 3
  830. #define SQLITE_LOCK_EXCLUSIVE 4
  831. /*
  832. ** CAPI3REF: Synchronization Type Flags
  833. **
  834. ** When SQLite invokes the xSync() method of an
  835. ** [sqlite3_io_methods] object it uses a combination of
  836. ** these integer values as the second argument.
  837. **
  838. ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
  839. ** sync operation only needs to flush data to mass storage. Inode
  840. ** information need not be flushed. If the lower four bits of the flag
  841. ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
  842. ** If the lower four bits equal SQLITE_SYNC_FULL, that means
  843. ** to use Mac OS X style fullsync instead of fsync().
  844. **
  845. ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
  846. ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
  847. ** settings. The [synchronous pragma] determines when calls to the
  848. ** xSync VFS method occur and applies uniformly across all platforms.
  849. ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
  850. ** energetic or rigorous or forceful the sync operations are and
  851. ** only make a difference on Mac OSX for the default SQLite code.
  852. ** (Third-party VFS implementations might also make the distinction
  853. ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
  854. ** operating systems natively supported by SQLite, only Mac OSX
  855. ** cares about the difference.)
  856. */
  857. #define SQLITE_SYNC_NORMAL 0x00002
  858. #define SQLITE_SYNC_FULL 0x00003
  859. #define SQLITE_SYNC_DATAONLY 0x00010
  860. /*
  861. ** CAPI3REF: OS Interface Open File Handle
  862. **
  863. ** An [sqlite3_file] object represents an open file in the
  864. ** [sqlite3_vfs | OS interface layer]. Individual OS interface
  865. ** implementations will
  866. ** want to subclass this object by appending additional fields
  867. ** for their own use. The pMethods entry is a pointer to an
  868. ** [sqlite3_io_methods] object that defines methods for performing
  869. ** I/O operations on the open file.
  870. */
  871. typedef struct sqlite3_file sqlite3_file;
  872. struct sqlite3_file {
  873. const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
  874. };
  875. /*
  876. ** CAPI3REF: OS Interface File Virtual Methods Object
  877. **
  878. ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
  879. ** [sqlite3_file] object (or, more commonly, a subclass of the
  880. ** [sqlite3_file] object) with a pointer to an instance of this object.
  881. ** This object defines the methods used to perform various operations
  882. ** against the open file represented by the [sqlite3_file] object.
  883. **
  884. ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
  885. ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
  886. ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
  887. ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
  888. ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
  889. ** to NULL.
  890. **
  891. ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
  892. ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
  893. ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
  894. ** flag may be ORed in to indicate that only the data of the file
  895. ** and not its inode needs to be synced.
  896. **
  897. ** The integer values to xLock() and xUnlock() are one of
  898. ** <ul>
  899. ** <li> [SQLITE_LOCK_NONE],
  900. ** <li> [SQLITE_LOCK_SHARED],
  901. ** <li> [SQLITE_LOCK_RESERVED],
  902. ** <li> [SQLITE_LOCK_PENDING], or
  903. ** <li> [SQLITE_LOCK_EXCLUSIVE].
  904. ** </ul>
  905. ** xLock() increases the lock. xUnlock() decreases the lock.
  906. ** The xCheckReservedLock() method checks whether any database connection,
  907. ** either in this process or in some other process, is holding a RESERVED,
  908. ** PENDING, or EXCLUSIVE lock on the file. It returns true
  909. ** if such a lock exists and false otherwise.
  910. **
  911. ** The xFileControl() method is a generic interface that allows custom
  912. ** VFS implementations to directly control an open file using the
  913. ** [sqlite3_file_control()] interface. The second "op" argument is an
  914. ** integer opcode. The third argument is a generic pointer intended to
  915. ** point to a structure that may contain arguments or space in which to
  916. ** write return values. Potential uses for xFileControl() might be
  917. ** functions to enable blocking locks with timeouts, to change the
  918. ** locking strategy (for example to use dot-file locks), to inquire
  919. ** about the status of a lock, or to break stale locks. The SQLite
  920. ** core reserves all opcodes less than 100 for its own use.
  921. ** A [file control opcodes | list of opcodes] less than 100 is available.
  922. ** Applications that define a custom xFileControl method should use opcodes
  923. ** greater than 100 to avoid conflicts. VFS implementations should
  924. ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
  925. ** recognize.
  926. **
  927. ** The xSectorSize() method returns the sector size of the
  928. ** device that underlies the file. The sector size is the
  929. ** minimum write that can be performed without disturbing
  930. ** other bytes in the file. The xDeviceCharacteristics()
  931. ** method returns a bit vector describing behaviors of the
  932. ** underlying device:
  933. **
  934. ** <ul>
  935. ** <li> [SQLITE_IOCAP_ATOMIC]
  936. ** <li> [SQLITE_IOCAP_ATOMIC512]
  937. ** <li> [SQLITE_IOCAP_ATOMIC1K]
  938. ** <li> [SQLITE_IOCAP_ATOMIC2K]
  939. ** <li> [SQLITE_IOCAP_ATOMIC4K]
  940. ** <li> [SQLITE_IOCAP_ATOMIC8K]
  941. ** <li> [SQLITE_IOCAP_ATOMIC16K]
  942. ** <li> [SQLITE_IOCAP_ATOMIC32K]
  943. ** <li> [SQLITE_IOCAP_ATOMIC64K]
  944. ** <li> [SQLITE_IOCAP_SAFE_APPEND]
  945. ** <li> [SQLITE_IOCAP_SEQUENTIAL]
  946. ** </ul>
  947. **
  948. ** The SQLITE_IOCAP_ATOMIC property means that all writes of
  949. ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
  950. ** mean that writes of blocks that are nnn bytes in size and
  951. ** are aligned to an address which is an integer multiple of
  952. ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
  953. ** that when data is appended to a file, the data is appended
  954. ** first then the size of the file is extended, never the other
  955. ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
  956. ** information is written to disk in the same order as calls
  957. ** to xWrite().
  958. **
  959. ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
  960. ** in the unread portions of the buffer with zeros. A VFS that
  961. ** fails to zero-fill short reads might seem to work. However,
  962. ** failure to zero-fill short reads will eventually lead to
  963. ** database corruption.
  964. */
  965. typedef struct sqlite3_io_methods sqlite3_io_methods;
  966. struct sqlite3_io_methods {
  967. int iVersion;
  968. int (*xClose)(sqlite3_file*);
  969. int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  970. int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
  971. int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
  972. int (*xSync)(sqlite3_file*, int flags);
  973. int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
  974. int (*xLock)(sqlite3_file*, int);
  975. int (*xUnlock)(sqlite3_file*, int);
  976. int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
  977. int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  978. int (*xSectorSize)(sqlite3_file*);
  979. int (*xDeviceCharacteristics)(sqlite3_file*);
  980. /* Methods above are valid for version 1 */
  981. int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
  982. int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
  983. void (*xShmBarrier)(sqlite3_file*);
  984. int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
  985. /* Methods above are valid for version 2 */
  986. int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
  987. int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
  988. /* Methods above are valid for version 3 */
  989. /* Additional methods may be added in future releases */
  990. };
  991. /*
  992. ** CAPI3REF: Standard File Control Opcodes
  993. ** KEYWORDS: {file control opcodes} {file control opcode}
  994. **
  995. ** These integer constants are opcodes for the xFileControl method
  996. ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
  997. ** interface.
  998. **
  999. ** <ul>
  1000. ** <li>[[SQLITE_FCNTL_LOCKSTATE]]
  1001. ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
  1002. ** opcode causes the xFileControl method to write the current state of
  1003. ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
  1004. ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
  1005. ** into an integer that the pArg argument points to. This capability
  1006. ** is used during testing and is only available when the SQLITE_TEST
  1007. ** compile-time option is used.
  1008. **
  1009. ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
  1010. ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
  1011. ** layer a hint of how large the database file will grow to be during the
  1012. ** current transaction. This hint is not guaranteed to be accurate but it
  1013. ** is often close. The underlying VFS might choose to preallocate database
  1014. ** file space based on this hint in order to help writes to the database
  1015. ** file run faster.
  1016. **
  1017. ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
  1018. ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
  1019. ** extends and truncates the database file in chunks of a size specified
  1020. ** by the user. The fourth argument to [sqlite3_file_control()] should
  1021. ** point to an integer (type int) containing the new chunk-size to use
  1022. ** for the nominated database. Allocating database file space in large
  1023. ** chunks (say 1MB at a time), may reduce file-system fragmentation and
  1024. ** improve performance on some systems.
  1025. **
  1026. ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
  1027. ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
  1028. ** to the [sqlite3_file] object associated with a particular database
  1029. ** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
  1030. **
  1031. ** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
  1032. ** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
  1033. ** to the [sqlite3_file] object associated with the journal file (either
  1034. ** the [rollback journal] or the [write-ahead log]) for a particular database
  1035. ** connection. See also [SQLITE_FCNTL_FILE_POINTER].
  1036. **
  1037. ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
  1038. ** No longer in use.
  1039. **
  1040. ** <li>[[SQLITE_FCNTL_SYNC]]
  1041. ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
  1042. ** sent to the VFS immediately before the xSync method is invoked on a
  1043. ** database file descriptor. Or, if the xSync method is not invoked
  1044. ** because the user has configured SQLite with
  1045. ** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
  1046. ** of the xSync method. In most cases, the pointer argument passed with
  1047. ** this file-control is NULL. However, if the database file is being synced
  1048. ** as part of a multi-database commit, the argument points to a nul-terminated
  1049. ** string containing the transactions master-journal file name. VFSes that
  1050. ** do not need this signal should silently ignore this opcode. Applications
  1051. ** should not call [sqlite3_file_control()] with this opcode as doing so may
  1052. ** disrupt the operation of the specialized VFSes that do require it.
  1053. **
  1054. ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
  1055. ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
  1056. ** and sent to the VFS after a transaction has been committed immediately
  1057. ** but before the database is unlocked. VFSes that do not need this signal
  1058. ** should silently ignore this opcode. Applications should not call
  1059. ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
  1060. ** operation of the specialized VFSes that do require it.
  1061. **
  1062. ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
  1063. ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
  1064. ** retry counts and intervals for certain disk I/O operations for the
  1065. ** windows [VFS] in order to provide robustness in the presence of
  1066. ** anti-virus programs. By default, the windows VFS will retry file read,
  1067. ** file write, and file delete operations up to 10 times, with a delay
  1068. ** of 25 milliseconds before the first retry and with the delay increasing
  1069. ** by an additional 25 milliseconds with each subsequent retry. This
  1070. ** opcode allows these two values (10 retries and 25 milliseconds of delay)
  1071. ** to be adjusted. The values are changed for all database connections
  1072. ** within the same process. The argument is a pointer to an array of two
  1073. ** integers where the first integer i the new retry count and the second
  1074. ** integer is the delay. If either integer is negative, then the setting
  1075. ** is not changed but instead the prior value of that setting is written
  1076. ** into the array entry, allowing the current retry settings to be
  1077. ** interrogated. The zDbName parameter is ignored.
  1078. **
  1079. ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
  1080. ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
  1081. ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
  1082. ** write ahead log and shared memory files used for transaction control
  1083. ** are automatically deleted when the latest connection to the database
  1084. ** closes. Setting persistent WAL mode causes those files to persist after
  1085. ** close. Persisting the files is useful when other processes that do not
  1086. ** have write permission on the directory containing the database file want
  1087. ** to read the database file, as the WAL and shared memory files must exist
  1088. ** in order for the database to be readable. The fourth parameter to
  1089. ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  1090. ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
  1091. ** WAL mode. If the integer is -1, then it is overwritten with the current
  1092. ** WAL persistence setting.
  1093. **
  1094. ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
  1095. ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
  1096. ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
  1097. ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
  1098. ** xDeviceCharacteristics methods. The fourth parameter to
  1099. ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  1100. ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
  1101. ** mode. If the integer is -1, then it is overwritten with the current
  1102. ** zero-damage mode setting.
  1103. **
  1104. ** <li>[[SQLITE_FCNTL_OVERWRITE]]
  1105. ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
  1106. ** a write transaction to indicate that, unless it is rolled back for some
  1107. ** reason, the entire database file will be overwritten by the current
  1108. ** transaction. This is used by VACUUM operations.
  1109. **
  1110. ** <li>[[SQLITE_FCNTL_VFSNAME]]
  1111. ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
  1112. ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
  1113. ** final bottom-level VFS are written into memory obtained from
  1114. ** [sqlite3_malloc()] and the result is stored in the char* variable
  1115. ** that the fourth parameter of [sqlite3_file_control()] points to.
  1116. ** The caller is responsible for freeing the memory when done. As with
  1117. ** all file-control actions, there is no guarantee that this will actually
  1118. ** do anything. Callers should initialize the char* variable to a NULL
  1119. ** pointer in case this file-control is not implemented. This file-control
  1120. ** is intended for diagnostic use only.
  1121. **
  1122. ** <li>[[SQLITE_FCNTL_VFS_POINTER]]
  1123. ** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
  1124. ** [VFSes] currently in use. ^(The argument X in
  1125. ** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
  1126. ** of type "[sqlite3_vfs] **". This opcodes will set *X
  1127. ** to a pointer to the top-level VFS.)^
  1128. ** ^When there are multiple VFS shims in the stack, this opcode finds the
  1129. ** upper-most shim only.
  1130. **
  1131. ** <li>[[SQLITE_FCNTL_PRAGMA]]
  1132. ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
  1133. ** file control is sent to the open [sqlite3_file] object corresponding
  1134. ** to the database file to which the pragma statement refers. ^The argument
  1135. ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
  1136. ** pointers to strings (char**) in which the second element of the array
  1137. ** is the name of the pragma and the third element is the argument to the
  1138. ** pragma or NULL if the pragma has no argument. ^The handler for an
  1139. ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
  1140. ** of the char** argument point to a string obtained from [sqlite3_mprintf()]
  1141. ** or the equivalent and that string will become the result of the pragma or
  1142. ** the error message if the pragma fails. ^If the
  1143. ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
  1144. ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
  1145. ** file control returns [SQLITE_OK], then the parser assumes that the
  1146. ** VFS has handled the PRAGMA itself and the parser generates a no-op
  1147. ** prepared statement if result string is NULL, or that returns a copy
  1148. ** of the result string if the string is non-NULL.
  1149. ** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
  1150. ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
  1151. ** that the VFS encountered an error while handling the [PRAGMA] and the
  1152. ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
  1153. ** file control occurs at the beginning of pragma statement analysis and so
  1154. ** it is able to override built-in [PRAGMA] statements.
  1155. **
  1156. ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
  1157. ** ^The [SQLITE_FCNTL_BUSYHANDLER]
  1158. ** file-control may be invoked by SQLite on the database file handle
  1159. ** shortly after it is opened in order to provide a custom VFS with access
  1160. ** to the connections busy-handler callback. The argument is of type (void **)
  1161. ** - an array of two (void *) values. The first (void *) actually points
  1162. ** to a function of type (int (*)(void *)). In order to invoke the connections
  1163. ** busy-handler, this function should be invoked with the second (void *) in
  1164. ** the array as the only argument. If it returns non-zero, then the operation
  1165. ** should be retried. If it returns zero, the custom VFS should abandon the
  1166. ** current operation.
  1167. **
  1168. ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
  1169. ** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
  1170. ** to have SQLite generate a
  1171. ** temporary filename using the same algorithm that is followed to generate
  1172. ** temporary filenames for TEMP tables and other internal uses. The
  1173. ** argument should be a char** which will be filled with the filename
  1174. ** written into memory obtained from [sqlite3_malloc()]. The caller should
  1175. ** invoke [sqlite3_free()] on the result to avoid a memory leak.
  1176. **
  1177. ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
  1178. ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
  1179. ** maximum number of bytes that will be used for memory-mapped I/O.
  1180. ** The argument is a pointer to a value of type sqlite3_int64 that
  1181. ** is an advisory maximum number of bytes in the file to memory map. The
  1182. ** pointer is overwritten with the old value. The limit is not changed if
  1183. ** the value originally pointed to is negative, and so the current limit
  1184. ** can be queried by passing in a pointer to a negative number. This
  1185. ** file-control is used internally to implement [PRAGMA mmap_size].
  1186. **
  1187. ** <li>[[SQLITE_FCNTL_TRACE]]
  1188. ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
  1189. ** to the VFS about what the higher layers of the SQLite stack are doing.
  1190. ** This file control is used by some VFS activity tracing [shims].
  1191. ** The argument is a zero-terminated string. Higher layers in the
  1192. ** SQLite stack may generate instances of this file control if
  1193. ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
  1194. **
  1195. ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
  1196. ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
  1197. ** pointer to an integer and it writes a boolean into that integer depending
  1198. ** on whether or not the file has been renamed, moved, or deleted since it
  1199. ** was first opened.
  1200. **
  1201. ** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]]
  1202. ** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
  1203. ** underlying native file handle associated with a file handle. This file
  1204. ** control interprets its argument as a pointer to a native file handle and
  1205. ** writes the resulting value there.
  1206. **
  1207. ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
  1208. ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
  1209. ** opcode causes the xFileControl method to swap the file handle with the one
  1210. ** pointed to by the pArg argument. This capability is used during testing
  1211. ** and only needs to be supported when SQLITE_TEST is defined.
  1212. **
  1213. ** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
  1214. ** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
  1215. ** be advantageous to block on the next WAL lock if the lock is not immediately
  1216. ** available. The WAL subsystem issues this signal during rare
  1217. ** circumstances in order to fix a problem with priority inversion.
  1218. ** Applications should <em>not</em> use this file-control.
  1219. **
  1220. ** <li>[[SQLITE_FCNTL_ZIPVFS]]
  1221. ** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
  1222. ** VFS should return SQLITE_NOTFOUND for this opcode.
  1223. **
  1224. ** <li>[[SQLITE_FCNTL_RBU]]
  1225. ** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
  1226. ** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
  1227. ** this opcode.
  1228. ** </ul>
  1229. */
  1230. #define SQLITE_FCNTL_LOCKSTATE 1
  1231. #define SQLITE_FCNTL_GET_LOCKPROXYFILE 2
  1232. #define SQLITE_FCNTL_SET_LOCKPROXYFILE 3
  1233. #define SQLITE_FCNTL_LAST_ERRNO 4
  1234. #define SQLITE_FCNTL_SIZE_HINT 5
  1235. #define SQLITE_FCNTL_CHUNK_SIZE 6
  1236. #define SQLITE_FCNTL_FILE_POINTER 7
  1237. #define SQLITE_FCNTL_SYNC_OMITTED 8
  1238. #define SQLITE_FCNTL_WIN32_AV_RETRY 9
  1239. #define SQLITE_FCNTL_PERSIST_WAL 10
  1240. #define SQLITE_FCNTL_OVERWRITE 11
  1241. #define SQLITE_FCNTL_VFSNAME 12
  1242. #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
  1243. #define SQLITE_FCNTL_PRAGMA 14
  1244. #define SQLITE_FCNTL_BUSYHANDLER 15
  1245. #define SQLITE_FCNTL_TEMPFILENAME 16
  1246. #define SQLITE_FCNTL_MMAP_SIZE 18
  1247. #define SQLITE_FCNTL_TRACE 19
  1248. #define SQLITE_FCNTL_HAS_MOVED 20
  1249. #define SQLITE_FCNTL_SYNC 21
  1250. #define SQLITE_FCNTL_COMMIT_PHASETWO 22
  1251. #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
  1252. #define SQLITE_FCNTL_WAL_BLOCK 24
  1253. #define SQLITE_FCNTL_ZIPVFS 25
  1254. #define SQLITE_FCNTL_RBU 26
  1255. #define SQLITE_FCNTL_VFS_POINTER 27
  1256. #define SQLITE_FCNTL_JOURNAL_POINTER 28
  1257. #define SQLITE_FCNTL_WIN32_GET_HANDLE 29
  1258. /* deprecated names */
  1259. #define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
  1260. #define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE
  1261. #define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO
  1262. /*
  1263. ** CAPI3REF: Mutex Handle
  1264. **
  1265. ** The mutex module within SQLite defines [sqlite3_mutex] to be an
  1266. ** abstract type for a mutex object. The SQLite core never looks
  1267. ** at the internal representation of an [sqlite3_mutex]. It only
  1268. ** deals with pointers to the [sqlite3_mutex] object.
  1269. **
  1270. ** Mutexes are created using [sqlite3_mutex_alloc()].
  1271. */
  1272. typedef struct sqlite3_mutex sqlite3_mutex;
  1273. /*
  1274. ** CAPI3REF: Loadable Extension Thunk
  1275. **
  1276. ** A pointer to the opaque sqlite3_api_routines structure is passed as
  1277. ** the third parameter to entry points of [loadable extensions]. This
  1278. ** structure must be typedefed in order to work around compiler warnings
  1279. ** on some platforms.
  1280. */
  1281. typedef struct sqlite3_api_routines sqlite3_api_routines;
  1282. /*
  1283. ** CAPI3REF: OS Interface Object
  1284. **
  1285. ** An instance of the sqlite3_vfs object defines the interface between
  1286. ** the SQLite core and the underlying operating system. The "vfs"
  1287. ** in the name of the object stands for "virtual file system". See
  1288. ** the [VFS | VFS documentation] for further information.
  1289. **
  1290. ** The value of the iVersion field is initially 1 but may be larger in
  1291. ** future versions of SQLite. Additional fields may be appended to this
  1292. ** object when the iVersion value is increased. Note that the structure
  1293. ** of the sqlite3_vfs object changes in the transaction between
  1294. ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
  1295. ** modified.
  1296. **
  1297. ** The szOsFile field is the size of the subclassed [sqlite3_file]
  1298. ** structure used by this VFS. mxPathname is the maximum length of
  1299. ** a pathname in this VFS.
  1300. **
  1301. ** Registered sqlite3_vfs objects are kept on a linked list formed by
  1302. ** the pNext pointer. The [sqlite3_vfs_register()]
  1303. ** and [sqlite3_vfs_unregister()] interfaces manage this list
  1304. ** in a thread-safe way. The [sqlite3_vfs_find()] interface
  1305. ** searches the list. Neither the application code nor the VFS
  1306. ** implementation should use the pNext pointer.
  1307. **
  1308. ** The pNext field is the only field in the sqlite3_vfs
  1309. ** structure that SQLite will ever modify. SQLite will only access
  1310. ** or modify this field while holding a particular static mutex.
  1311. ** The application should never modify anything within the sqlite3_vfs
  1312. ** object once the object has been registered.
  1313. **
  1314. ** The zName field holds the name of the VFS module. The name must
  1315. ** be unique across all VFS modules.
  1316. **
  1317. ** [[sqlite3_vfs.xOpen]]
  1318. ** ^SQLite guarantees that the zFilename parameter to xOpen
  1319. ** is either a NULL pointer or string obtained
  1320. ** from xFullPathname() with an optional suffix added.
  1321. ** ^If a suffix is added to the zFilename parameter, it will
  1322. ** consist of a single "-" character followed by no more than
  1323. ** 11 alphanumeric and/or "-" characters.
  1324. ** ^SQLite further guarantees that
  1325. ** the string will be valid and unchanged until xClose() is
  1326. ** called. Because of the previous sentence,
  1327. ** the [sqlite3_file] can safely store a pointer to the
  1328. ** filename if it needs to remember the filename for some reason.
  1329. ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
  1330. ** must invent its own temporary name for the file. ^Whenever the
  1331. ** xFilename parameter is NULL it will also be the case that the
  1332. ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
  1333. **
  1334. ** The flags argument to xOpen() includes all bits set in
  1335. ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
  1336. ** or [sqlite3_open16()] is used, then flags includes at least
  1337. ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
  1338. ** If xOpen() opens a file read-only then it sets *pOutFlags to
  1339. ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
  1340. **
  1341. ** ^(SQLite will also add one of the following flags to the xOpen()
  1342. ** call, depending on the object being opened:
  1343. **
  1344. ** <ul>
  1345. ** <li> [SQLITE_OPEN_MAIN_DB]
  1346. ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
  1347. ** <li> [SQLITE_OPEN_TEMP_DB]
  1348. ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
  1349. ** <li> [SQLITE_OPEN_TRANSIENT_DB]
  1350. ** <li> [SQLITE_OPEN_SUBJOURNAL]
  1351. ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
  1352. ** <li> [SQLITE_OPEN_WAL]
  1353. ** </ul>)^
  1354. **
  1355. ** The file I/O implementation can use the object type flags to
  1356. ** change the way it deals with files. For example, an application
  1357. ** that does not care about crash recovery or rollback might make
  1358. ** the open of a journal file a no-op. Writes to this journal would
  1359. ** also be no-ops, and any attempt to read the journal would return
  1360. ** SQLITE_IOERR. Or the implementation might recognize that a database
  1361. ** file will be doing page-aligned sector reads and writes in a random
  1362. ** order and set up its I/O subsystem accordingly.
  1363. **
  1364. ** SQLite might also add one of the following flags to the xOpen method:
  1365. **
  1366. ** <ul>
  1367. ** <li> [SQLITE_OPEN_DELETEONCLOSE]
  1368. ** <li> [SQLITE_OPEN_EXCLUSIVE]
  1369. ** </ul>
  1370. **
  1371. ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
  1372. ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
  1373. ** will be set for TEMP databases and their journals, transient
  1374. ** databases, and subjournals.
  1375. **
  1376. ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
  1377. ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
  1378. ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
  1379. ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
  1380. ** SQLITE_OPEN_CREATE, is used to indicate that file should always
  1381. ** be created, and that it is an error if it already exists.
  1382. ** It is <i>not</i> used to indicate the file should be opened
  1383. ** for exclusive access.
  1384. **
  1385. ** ^At least szOsFile bytes of memory are allocated by SQLite
  1386. ** to hold the [sqlite3_file] structure passed as the third
  1387. ** argument to xOpen. The xOpen method does not have to
  1388. ** allocate the structure; it should just fill it in. Note that
  1389. ** the xOpen method must set the sqlite3_file.pMethods to either
  1390. ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
  1391. ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
  1392. ** element will be valid after xOpen returns regardless of the success
  1393. ** or failure of the xOpen call.
  1394. **
  1395. ** [[sqlite3_vfs.xAccess]]
  1396. ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
  1397. ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
  1398. ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
  1399. ** to test whether a file is at least readable. The file can be a
  1400. ** directory.
  1401. **
  1402. ** ^SQLite will always allocate at least mxPathname+1 bytes for the
  1403. ** output buffer xFullPathname. The exact size of the output buffer
  1404. ** is also passed as a parameter to both methods. If the output buffer
  1405. ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
  1406. ** handled as a fatal error by SQLite, vfs implementations should endeavor
  1407. ** to prevent this by setting mxPathname to a sufficiently large value.
  1408. **
  1409. ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
  1410. ** interfaces are not strictly a part of the filesystem, but they are
  1411. ** included in the VFS structure for completeness.
  1412. ** The xRandomness() function attempts to return nBytes bytes
  1413. ** of good-quality randomness into zOut. The return value is
  1414. ** the actual number of bytes of randomness obtained.
  1415. ** The xSleep() method causes the calling thread to sleep for at
  1416. ** least the number of microseconds given. ^The xCurrentTime()
  1417. ** method returns a Julian Day Number for the current date and time as
  1418. ** a floating point value.
  1419. ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
  1420. ** Day Number multiplied by 86400000 (the number of milliseconds in
  1421. ** a 24-hour day).
  1422. ** ^SQLite will use the xCurrentTimeInt64() method to get the current
  1423. ** date and time if that method is available (if iVersion is 2 or
  1424. ** greater and the function pointer is not NULL) and will fall back
  1425. ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
  1426. **
  1427. ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
  1428. ** are not used by the SQLite core. These optional interfaces are provided
  1429. ** by some VFSes to facilitate testing of the VFS code. By overriding
  1430. ** system calls with functions under its control, a test program can
  1431. ** simulate faults and error conditions that would otherwise be difficult
  1432. ** or impossible to induce. The set of system calls that can be overridden
  1433. ** varies from one VFS to another, and from one version of the same VFS to the
  1434. ** next. Applications that use these interfaces must be prepared for any
  1435. ** or all of these interfaces to be NULL or for their behavior to change
  1436. ** from one release to the next. Applications must not attempt to access
  1437. ** any of these methods if the iVersion of the VFS is less than 3.
  1438. */
  1439. typedef struct sqlite3_vfs sqlite3_vfs;
  1440. typedef void (*sqlite3_syscall_ptr)(void);
  1441. struct sqlite3_vfs {
  1442. int iVersion; /* Structure version number (currently 3) */
  1443. int szOsFile; /* Size of subclassed sqlite3_file */
  1444. int mxPathname; /* Maximum file pathname length */
  1445. sqlite3_vfs *pNext; /* Next registered VFS */
  1446. const char *zName; /* Name of this virtual file system */
  1447. void *pAppData; /* Pointer to application-specific data */
  1448. int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
  1449. int flags, int *pOutFlags);
  1450. int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
  1451. int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
  1452. int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
  1453. void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
  1454. void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
  1455. void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
  1456. void (*xDlClose)(sqlite3_vfs*, void*);
  1457. int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
  1458. int (*xSleep)(sqlite3_vfs*, int microseconds);
  1459. int (*xCurrentTime)(sqlite3_vfs*, double*);
  1460. int (*xGetLastError)(sqlite3_vfs*, int, char *);
  1461. /*
  1462. ** The methods above are in version 1 of the sqlite_vfs object
  1463. ** definition. Those that follow are added in version 2 or later
  1464. */
  1465. int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
  1466. /*
  1467. ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
  1468. ** Those below are for version 3 and greater.
  1469. */
  1470. int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
  1471. sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
  1472. const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
  1473. /*
  1474. ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
  1475. ** New fields may be appended in future versions. The iVersion
  1476. ** value will increment whenever this happens.
  1477. */
  1478. };
  1479. /*
  1480. ** CAPI3REF: Flags for the xAccess VFS method
  1481. **
  1482. ** These integer constants can be used as the third parameter to
  1483. ** the xAccess method of an [sqlite3_vfs] object. They determine
  1484. ** what kind of permissions the xAccess method is looking for.
  1485. ** With SQLITE_ACCESS_EXISTS, the xAccess method
  1486. ** simply checks whether the file exists.
  1487. ** With SQLITE_ACCESS_READWRITE, the xAccess method
  1488. ** checks whether the named directory is both readable and writable
  1489. ** (in other words, if files can be added, removed, and renamed within
  1490. ** the directory).
  1491. ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
  1492. ** [temp_store_directory pragma], though this could change in a future
  1493. ** release of SQLite.
  1494. ** With SQLITE_ACCESS_READ, the xAccess method
  1495. ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
  1496. ** currently unused, though it might be used in a future release of
  1497. ** SQLite.
  1498. */
  1499. #define SQLITE_ACCESS_EXISTS 0
  1500. #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
  1501. #define SQLITE_ACCESS_READ 2 /* Unused */
  1502. /*
  1503. ** CAPI3REF: Flags for the xShmLock VFS method
  1504. **
  1505. ** These integer constants define the various locking operations
  1506. ** allowed by the xShmLock method of [sqlite3_io_methods]. The
  1507. ** following are the only legal combinations of flags to the
  1508. ** xShmLock method:
  1509. **
  1510. ** <ul>
  1511. ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
  1512. ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
  1513. ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
  1514. ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
  1515. ** </ul>
  1516. **
  1517. ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
  1518. ** was given on the corresponding lock.
  1519. **
  1520. ** The xShmLock method can transition between unlocked and SHARED or
  1521. ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
  1522. ** and EXCLUSIVE.
  1523. */
  1524. #define SQLITE_SHM_UNLOCK 1
  1525. #define SQLITE_SHM_LOCK 2
  1526. #define SQLITE_SHM_SHARED 4
  1527. #define SQLITE_SHM_EXCLUSIVE 8
  1528. /*
  1529. ** CAPI3REF: Maximum xShmLock index
  1530. **
  1531. ** The xShmLock method on [sqlite3_io_methods] may use values
  1532. ** between 0 and this upper bound as its "offset" argument.
  1533. ** The SQLite core will never attempt to acquire or release a
  1534. ** lock outside of this range
  1535. */
  1536. #define SQLITE_SHM_NLOCK 8
  1537. /*
  1538. ** CAPI3REF: Initialize The SQLite Library
  1539. **
  1540. ** ^The sqlite3_initialize() routine initializes the
  1541. ** SQLite library. ^The sqlite3_shutdown() routine
  1542. ** deallocates any resources that were allocated by sqlite3_initialize().
  1543. ** These routines are designed to aid in process initialization and
  1544. ** shutdown on embedded systems. Workstation applications using
  1545. ** SQLite normally do not need to invoke either of these routines.
  1546. **
  1547. ** A call to sqlite3_initialize() is an "effective" call if it is
  1548. ** the first time sqlite3_initialize() is invoked during the lifetime of
  1549. ** the process, or if it is the first time sqlite3_initialize() is invoked
  1550. ** following a call to sqlite3_shutdown(). ^(Only an effective call
  1551. ** of sqlite3_initialize() does any initialization. All other calls
  1552. ** are harmless no-ops.)^
  1553. **
  1554. ** A call to sqlite3_shutdown() is an "effective" call if it is the first
  1555. ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
  1556. ** an effective call to sqlite3_shutdown() does any deinitialization.
  1557. ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
  1558. **
  1559. ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
  1560. ** is not. The sqlite3_shutdown() interface must only be called from a
  1561. ** single thread. All open [database connections] must be closed and all
  1562. ** other SQLite resources must be deallocated prior to invoking
  1563. ** sqlite3_shutdown().
  1564. **
  1565. ** Among other things, ^sqlite3_initialize() will invoke
  1566. ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
  1567. ** will invoke sqlite3_os_end().
  1568. **
  1569. ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
  1570. ** ^If for some reason, sqlite3_initialize() is unable to initialize
  1571. ** the library (perhaps it is unable to allocate a needed resource such
  1572. ** as a mutex) it returns an [error code] other than [SQLITE_OK].
  1573. **
  1574. ** ^The sqlite3_initialize() routine is called internally by many other
  1575. ** SQLite interfaces so that an application usually does not need to
  1576. ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
  1577. ** calls sqlite3_initialize() so the SQLite library will be automatically
  1578. ** initialized when [sqlite3_open()] is called if it has not be initialized
  1579. ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
  1580. ** compile-time option, then the automatic calls to sqlite3_initialize()
  1581. ** are omitted and the application must call sqlite3_initialize() directly
  1582. ** prior to using any other SQLite interface. For maximum portability,
  1583. ** it is recommended that applications always invoke sqlite3_initialize()
  1584. ** directly prior to using any other SQLite interface. Future releases
  1585. ** of SQLite may require this. In other words, the behavior exhibited
  1586. ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
  1587. ** default behavior in some future release of SQLite.
  1588. **
  1589. ** The sqlite3_os_init() routine does operating-system specific
  1590. ** initialization of the SQLite library. The sqlite3_os_end()
  1591. ** routine undoes the effect of sqlite3_os_init(). Typical tasks
  1592. ** performed by these routines include allocation or deallocation
  1593. ** of static resources, initialization of global variables,
  1594. ** setting up a default [sqlite3_vfs] module, or setting up
  1595. ** a default configuration using [sqlite3_config()].
  1596. **
  1597. ** The application should never invoke either sqlite3_os_init()
  1598. ** or sqlite3_os_end() directly. The application should only invoke
  1599. ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
  1600. ** interface is called automatically by sqlite3_initialize() and
  1601. ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
  1602. ** implementations for sqlite3_os_init() and sqlite3_os_end()
  1603. ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
  1604. ** When [custom builds | built for other platforms]
  1605. ** (using the [SQLITE_OS_OTHER=1] compile-time
  1606. ** option) the application must supply a suitable implementation for
  1607. ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
  1608. ** implementation of sqlite3_os_init() or sqlite3_os_end()
  1609. ** must return [SQLITE_OK] on success and some other [error code] upon
  1610. ** failure.
  1611. */
  1612. SQLITE_API int sqlite3_initialize(void);
  1613. SQLITE_API int sqlite3_shutdown(void);
  1614. SQLITE_API int sqlite3_os_init(void);
  1615. SQLITE_API int sqlite3_os_end(void);
  1616. /*
  1617. ** CAPI3REF: Configuring The SQLite Library
  1618. **
  1619. ** The sqlite3_config() interface is used to make global configuration
  1620. ** changes to SQLite in order to tune SQLite to the specific needs of
  1621. ** the application. The default configuration is recommended for most
  1622. ** applications and so this routine is usually not necessary. It is
  1623. ** provided to support rare applications with unusual needs.
  1624. **
  1625. ** <b>The sqlite3_config() interface is not threadsafe. The application
  1626. ** must ensure that no other SQLite interfaces are invoked by other
  1627. ** threads while sqlite3_config() is running.</b>
  1628. **
  1629. ** The sqlite3_config() interface
  1630. ** may only be invoked prior to library initialization using
  1631. ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
  1632. ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
  1633. ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
  1634. ** Note, however, that ^sqlite3_config() can be called as part of the
  1635. ** implementation of an application-defined [sqlite3_os_init()].
  1636. **
  1637. ** The first argument to sqlite3_config() is an integer
  1638. ** [configuration option] that determines
  1639. ** what property of SQLite is to be configured. Subsequent arguments
  1640. ** vary depending on the [configuration option]
  1641. ** in the first argument.
  1642. **
  1643. ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
  1644. ** ^If the option is unknown or SQLite is unable to set the option
  1645. ** then this routine returns a non-zero [error code].
  1646. */
  1647. SQLITE_API int sqlite3_config(int, ...);
  1648. /*
  1649. ** CAPI3REF: Configure database connections
  1650. ** METHOD: sqlite3
  1651. **
  1652. ** The sqlite3_db_config() interface is used to make configuration
  1653. ** changes to a [database connection]. The interface is similar to
  1654. ** [sqlite3_config()] except that the changes apply to a single
  1655. ** [database connection] (specified in the first argument).
  1656. **
  1657. ** The second argument to sqlite3_db_config(D,V,...) is the
  1658. ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
  1659. ** that indicates what aspect of the [database connection] is being configured.
  1660. ** Subsequent arguments vary depending on the configuration verb.
  1661. **
  1662. ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
  1663. ** the call is considered successful.
  1664. */
  1665. SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
  1666. /*
  1667. ** CAPI3REF: Memory Allocation Routines
  1668. **
  1669. ** An instance of this object defines the interface between SQLite
  1670. ** and low-level memory allocation routines.
  1671. **
  1672. ** This object is used in only one place in the SQLite interface.
  1673. ** A pointer to an instance of this object is the argument to
  1674. ** [sqlite3_config()] when the configuration option is
  1675. ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
  1676. ** By creating an instance of this object
  1677. ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
  1678. ** during configuration, an application can specify an alternative
  1679. ** memory allocation subsystem for SQLite to use for all of its
  1680. ** dynamic memory needs.
  1681. **
  1682. ** Note that SQLite comes with several [built-in memory allocators]
  1683. ** that are perfectly adequate for the overwhelming majority of applications
  1684. ** and that this object is only useful to a tiny minority of applications
  1685. ** with specialized memory allocation requirements. This object is
  1686. ** also used during testing of SQLite in order to specify an alternative
  1687. ** memory allocator that simulates memory out-of-memory conditions in
  1688. ** order to verify that SQLite recovers gracefully from such
  1689. ** conditions.
  1690. **
  1691. ** The xMalloc, xRealloc, and xFree methods must work like the
  1692. ** malloc(), realloc() and free() functions from the standard C library.
  1693. ** ^SQLite guarantees that the second argument to
  1694. ** xRealloc is always a value returned by a prior call to xRoundup.
  1695. **
  1696. ** xSize should return the allocated size of a memory allocation
  1697. ** previously obtained from xMalloc or xRealloc. The allocated size
  1698. ** is always at least as big as the requested size but may be larger.
  1699. **
  1700. ** The xRoundup method returns what would be the allocated size of
  1701. ** a memory allocation given a particular requested size. Most memory
  1702. ** allocators round up memory allocations at least to the next multiple
  1703. ** of 8. Some allocators round up to a larger multiple or to a power of 2.
  1704. ** Every memory allocation request coming in through [sqlite3_malloc()]
  1705. ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
  1706. ** that causes the corresponding memory allocation to fail.
  1707. **
  1708. ** The xInit method initializes the memory allocator. For example,
  1709. ** it might allocate any require mutexes or initialize internal data
  1710. ** structures. The xShutdown method is invoked (indirectly) by
  1711. ** [sqlite3_shutdown()] and should deallocate any resources acquired
  1712. ** by xInit. The pAppData pointer is used as the only parameter to
  1713. ** xInit and xShutdown.
  1714. **
  1715. ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
  1716. ** the xInit method, so the xInit method need not be threadsafe. The
  1717. ** xShutdown method is only called from [sqlite3_shutdown()] so it does
  1718. ** not need to be threadsafe either. For all other methods, SQLite
  1719. ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
  1720. ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
  1721. ** it is by default) and so the methods are automatically serialized.
  1722. ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
  1723. ** methods must be threadsafe or else make their own arrangements for
  1724. ** serialization.
  1725. **
  1726. ** SQLite will never invoke xInit() more than once without an intervening
  1727. ** call to xShutdown().
  1728. */
  1729. typedef struct sqlite3_mem_methods sqlite3_mem_methods;
  1730. struct sqlite3_mem_methods {
  1731. void *(*xMalloc)(int); /* Memory allocation function */
  1732. void (*xFree)(void*); /* Free a prior allocation */
  1733. void *(*xRealloc)(void*,int); /* Resize an allocation */
  1734. int (*xSize)(void*); /* Return the size of an allocation */
  1735. int (*xRoundup)(int); /* Round up request size to allocation size */
  1736. int (*xInit)(void*); /* Initialize the memory allocator */
  1737. void (*xShutdown)(void*); /* Deinitialize the memory allocator */
  1738. void *pAppData; /* Argument to xInit() and xShutdown() */
  1739. };
  1740. /*
  1741. ** CAPI3REF: Configuration Options
  1742. ** KEYWORDS: {configuration option}
  1743. **
  1744. ** These constants are the available integer configuration options that
  1745. ** can be passed as the first argument to the [sqlite3_config()] interface.
  1746. **
  1747. ** New configuration options may be added in future releases of SQLite.
  1748. ** Existing configuration options might be discontinued. Applications
  1749. ** should check the return code from [sqlite3_config()] to make sure that
  1750. ** the call worked. The [sqlite3_config()] interface will return a
  1751. ** non-zero [error code] if a discontinued or unsupported configuration option
  1752. ** is invoked.
  1753. **
  1754. ** <dl>
  1755. ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
  1756. ** <dd>There are no arguments to this option. ^This option sets the
  1757. ** [threading mode] to Single-thread. In other words, it disables
  1758. ** all mutexing and puts SQLite into a mode where it can only be used
  1759. ** by a single thread. ^If SQLite is compiled with
  1760. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  1761. ** it is not possible to change the [threading mode] from its default
  1762. ** value of Single-thread and so [sqlite3_config()] will return
  1763. ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
  1764. ** configuration option.</dd>
  1765. **
  1766. ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
  1767. ** <dd>There are no arguments to this option. ^This option sets the
  1768. ** [threading mode] to Multi-thread. In other words, it disables
  1769. ** mutexing on [database connection] and [prepared statement] objects.
  1770. ** The application is responsible for serializing access to
  1771. ** [database connections] and [prepared statements]. But other mutexes
  1772. ** are enabled so that SQLite will be safe to use in a multi-threaded
  1773. ** environment as long as no two threads attempt to use the same
  1774. ** [database connection] at the same time. ^If SQLite is compiled with
  1775. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  1776. ** it is not possible to set the Multi-thread [threading mode] and
  1777. ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
  1778. ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
  1779. **
  1780. ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
  1781. ** <dd>There are no arguments to this option. ^This option sets the
  1782. ** [threading mode] to Serialized. In other words, this option enables
  1783. ** all mutexes including the recursive
  1784. ** mutexes on [database connection] and [prepared statement] objects.
  1785. ** In this mode (which is the default when SQLite is compiled with
  1786. ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
  1787. ** to [database connections] and [prepared statements] so that the
  1788. ** application is free to use the same [database connection] or the
  1789. ** same [prepared statement] in different threads at the same time.
  1790. ** ^If SQLite is compiled with
  1791. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  1792. ** it is not possible to set the Serialized [threading mode] and
  1793. ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
  1794. ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
  1795. **
  1796. ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
  1797. ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
  1798. ** a pointer to an instance of the [sqlite3_mem_methods] structure.
  1799. ** The argument specifies
  1800. ** alternative low-level memory allocation routines to be used in place of
  1801. ** the memory allocation routines built into SQLite.)^ ^SQLite makes
  1802. ** its own private copy of the content of the [sqlite3_mem_methods] structure
  1803. ** before the [sqlite3_config()] call returns.</dd>
  1804. **
  1805. ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
  1806. ** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
  1807. ** is a pointer to an instance of the [sqlite3_mem_methods] structure.
  1808. ** The [sqlite3_mem_methods]
  1809. ** structure is filled with the currently defined memory allocation routines.)^
  1810. ** This option can be used to overload the default memory allocation
  1811. ** routines with a wrapper that simulations memory allocation failure or
  1812. ** tracks memory usage, for example. </dd>
  1813. **
  1814. ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
  1815. ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
  1816. ** interpreted as a boolean, which enables or disables the collection of
  1817. ** memory allocation statistics. ^(When memory allocation statistics are
  1818. ** disabled, the following SQLite interfaces become non-operational:
  1819. ** <ul>
  1820. ** <li> [sqlite3_memory_used()]
  1821. ** <li> [sqlite3_memory_highwater()]
  1822. ** <li> [sqlite3_soft_heap_limit64()]
  1823. ** <li> [sqlite3_status64()]
  1824. ** </ul>)^
  1825. ** ^Memory allocation statistics are enabled by default unless SQLite is
  1826. ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
  1827. ** allocation statistics are disabled by default.
  1828. ** </dd>
  1829. **
  1830. ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
  1831. ** <dd> ^The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer
  1832. ** that SQLite can use for scratch memory. ^(There are three arguments
  1833. ** to SQLITE_CONFIG_SCRATCH: A pointer an 8-byte
  1834. ** aligned memory buffer from which the scratch allocations will be
  1835. ** drawn, the size of each scratch allocation (sz),
  1836. ** and the maximum number of scratch allocations (N).)^
  1837. ** The first argument must be a pointer to an 8-byte aligned buffer
  1838. ** of at least sz*N bytes of memory.
  1839. ** ^SQLite will not use more than one scratch buffers per thread.
  1840. ** ^SQLite will never request a scratch buffer that is more than 6
  1841. ** times the database page size.
  1842. ** ^If SQLite needs needs additional
  1843. ** scratch memory beyond what is provided by this configuration option, then
  1844. ** [sqlite3_malloc()] will be used to obtain the memory needed.<p>
  1845. ** ^When the application provides any amount of scratch memory using
  1846. ** SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary large
  1847. ** [sqlite3_malloc|heap allocations].
  1848. ** This can help [Robson proof|prevent memory allocation failures] due to heap
  1849. ** fragmentation in low-memory embedded systems.
  1850. ** </dd>
  1851. **
  1852. ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
  1853. ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
  1854. ** that SQLite can use for the database page cache with the default page
  1855. ** cache implementation.
  1856. ** This configuration option is a no-op if an application-define page
  1857. ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
  1858. ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
  1859. ** 8-byte aligned memory (pMem), the size of each page cache line (sz),
  1860. ** and the number of cache lines (N).
  1861. ** The sz argument should be the size of the largest database page
  1862. ** (a power of two between 512 and 65536) plus some extra bytes for each
  1863. ** page header. ^The number of extra bytes needed by the page header
  1864. ** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
  1865. ** ^It is harmless, apart from the wasted memory,
  1866. ** for the sz parameter to be larger than necessary. The pMem
  1867. ** argument must be either a NULL pointer or a pointer to an 8-byte
  1868. ** aligned block of memory of at least sz*N bytes, otherwise
  1869. ** subsequent behavior is undefined.
  1870. ** ^When pMem is not NULL, SQLite will strive to use the memory provided
  1871. ** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
  1872. ** a page cache line is larger than sz bytes or if all of the pMem buffer
  1873. ** is exhausted.
  1874. ** ^If pMem is NULL and N is non-zero, then each database connection
  1875. ** does an initial bulk allocation for page cache memory
  1876. ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
  1877. ** of -1024*N bytes if N is negative, . ^If additional
  1878. ** page cache memory is needed beyond what is provided by the initial
  1879. ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
  1880. ** additional cache line. </dd>
  1881. **
  1882. ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
  1883. ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
  1884. ** that SQLite will use for all of its dynamic memory allocation needs
  1885. ** beyond those provided for by [SQLITE_CONFIG_SCRATCH] and
  1886. ** [SQLITE_CONFIG_PAGECACHE].
  1887. ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
  1888. ** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
  1889. ** [SQLITE_ERROR] if invoked otherwise.
  1890. ** ^There are three arguments to SQLITE_CONFIG_HEAP:
  1891. ** An 8-byte aligned pointer to the memory,
  1892. ** the number of bytes in the memory buffer, and the minimum allocation size.
  1893. ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
  1894. ** to using its default memory allocator (the system malloc() implementation),
  1895. ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
  1896. ** memory pointer is not NULL then the alternative memory
  1897. ** allocator is engaged to handle all of SQLites memory allocation needs.
  1898. ** The first pointer (the memory pointer) must be aligned to an 8-byte
  1899. ** boundary or subsequent behavior of SQLite will be undefined.
  1900. ** The minimum allocation size is capped at 2**12. Reasonable values
  1901. ** for the minimum allocation size are 2**5 through 2**8.</dd>
  1902. **
  1903. ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
  1904. ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
  1905. ** pointer to an instance of the [sqlite3_mutex_methods] structure.
  1906. ** The argument specifies alternative low-level mutex routines to be used
  1907. ** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
  1908. ** the content of the [sqlite3_mutex_methods] structure before the call to
  1909. ** [sqlite3_config()] returns. ^If SQLite is compiled with
  1910. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  1911. ** the entire mutexing subsystem is omitted from the build and hence calls to
  1912. ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
  1913. ** return [SQLITE_ERROR].</dd>
  1914. **
  1915. ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
  1916. ** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
  1917. ** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
  1918. ** [sqlite3_mutex_methods]
  1919. ** structure is filled with the currently defined mutex routines.)^
  1920. ** This option can be used to overload the default mutex allocation
  1921. ** routines with a wrapper used to track mutex usage for performance
  1922. ** profiling or testing, for example. ^If SQLite is compiled with
  1923. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  1924. ** the entire mutexing subsystem is omitted from the build and hence calls to
  1925. ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
  1926. ** return [SQLITE_ERROR].</dd>
  1927. **
  1928. ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
  1929. ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
  1930. ** the default size of lookaside memory on each [database connection].
  1931. ** The first argument is the
  1932. ** size of each lookaside buffer slot and the second is the number of
  1933. ** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
  1934. ** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
  1935. ** option to [sqlite3_db_config()] can be used to change the lookaside
  1936. ** configuration on individual connections.)^ </dd>
  1937. **
  1938. ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
  1939. ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
  1940. ** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
  1941. ** the interface to a custom page cache implementation.)^
  1942. ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
  1943. **
  1944. ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
  1945. ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
  1946. ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
  1947. ** the current page cache implementation into that object.)^ </dd>
  1948. **
  1949. ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
  1950. ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
  1951. ** global [error log].
  1952. ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
  1953. ** function with a call signature of void(*)(void*,int,const char*),
  1954. ** and a pointer to void. ^If the function pointer is not NULL, it is
  1955. ** invoked by [sqlite3_log()] to process each logging event. ^If the
  1956. ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
  1957. ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
  1958. ** passed through as the first parameter to the application-defined logger
  1959. ** function whenever that function is invoked. ^The second parameter to
  1960. ** the logger function is a copy of the first parameter to the corresponding
  1961. ** [sqlite3_log()] call and is intended to be a [result code] or an
  1962. ** [extended result code]. ^The third parameter passed to the logger is
  1963. ** log message after formatting via [sqlite3_snprintf()].
  1964. ** The SQLite logging interface is not reentrant; the logger function
  1965. ** supplied by the application must not invoke any SQLite interface.
  1966. ** In a multi-threaded application, the application-defined logger
  1967. ** function must be threadsafe. </dd>
  1968. **
  1969. ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
  1970. ** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
  1971. ** If non-zero, then URI handling is globally enabled. If the parameter is zero,
  1972. ** then URI handling is globally disabled.)^ ^If URI handling is globally
  1973. ** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
  1974. ** [sqlite3_open16()] or
  1975. ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
  1976. ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
  1977. ** connection is opened. ^If it is globally disabled, filenames are
  1978. ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
  1979. ** database connection is opened. ^(By default, URI handling is globally
  1980. ** disabled. The default value may be changed by compiling with the
  1981. ** [SQLITE_USE_URI] symbol defined.)^
  1982. **
  1983. ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
  1984. ** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
  1985. ** argument which is interpreted as a boolean in order to enable or disable
  1986. ** the use of covering indices for full table scans in the query optimizer.
  1987. ** ^The default setting is determined
  1988. ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
  1989. ** if that compile-time option is omitted.
  1990. ** The ability to disable the use of covering indices for full table scans
  1991. ** is because some incorrectly coded legacy applications might malfunction
  1992. ** when the optimization is enabled. Providing the ability to
  1993. ** disable the optimization allows the older, buggy application code to work
  1994. ** without change even with newer versions of SQLite.
  1995. **
  1996. ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
  1997. ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
  1998. ** <dd> These options are obsolete and should not be used by new code.
  1999. ** They are retained for backwards compatibility but are now no-ops.
  2000. ** </dd>
  2001. **
  2002. ** [[SQLITE_CONFIG_SQLLOG]]
  2003. ** <dt>SQLITE_CONFIG_SQLLOG
  2004. ** <dd>This option is only available if sqlite is compiled with the
  2005. ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
  2006. ** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
  2007. ** The second should be of type (void*). The callback is invoked by the library
  2008. ** in three separate circumstances, identified by the value passed as the
  2009. ** fourth parameter. If the fourth parameter is 0, then the database connection
  2010. ** passed as the second argument has just been opened. The third argument
  2011. ** points to a buffer containing the name of the main database file. If the
  2012. ** fourth parameter is 1, then the SQL statement that the third parameter
  2013. ** points to has just been executed. Or, if the fourth parameter is 2, then
  2014. ** the connection being passed as the second parameter is being closed. The
  2015. ** third parameter is passed NULL In this case. An example of using this
  2016. ** configuration option can be seen in the "test_sqllog.c" source file in
  2017. ** the canonical SQLite source tree.</dd>
  2018. **
  2019. ** [[SQLITE_CONFIG_MMAP_SIZE]]
  2020. ** <dt>SQLITE_CONFIG_MMAP_SIZE
  2021. ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
  2022. ** that are the default mmap size limit (the default setting for
  2023. ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
  2024. ** ^The default setting can be overridden by each database connection using
  2025. ** either the [PRAGMA mmap_size] command, or by using the
  2026. ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
  2027. ** will be silently truncated if necessary so that it does not exceed the
  2028. ** compile-time maximum mmap size set by the
  2029. ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
  2030. ** ^If either argument to this option is negative, then that argument is
  2031. ** changed to its compile-time default.
  2032. **
  2033. ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
  2034. ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
  2035. ** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
  2036. ** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
  2037. ** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
  2038. ** that specifies the maximum size of the created heap.
  2039. **
  2040. ** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
  2041. ** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
  2042. ** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
  2043. ** is a pointer to an integer and writes into that integer the number of extra
  2044. ** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
  2045. ** The amount of extra space required can change depending on the compiler,
  2046. ** target platform, and SQLite version.
  2047. **
  2048. ** [[SQLITE_CONFIG_PMASZ]]
  2049. ** <dt>SQLITE_CONFIG_PMASZ
  2050. ** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
  2051. ** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
  2052. ** sorter to that integer. The default minimum PMA Size is set by the
  2053. ** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
  2054. ** to help with sort operations when multithreaded sorting
  2055. ** is enabled (using the [PRAGMA threads] command) and the amount of content
  2056. ** to be sorted exceeds the page size times the minimum of the
  2057. ** [PRAGMA cache_size] setting and this value.
  2058. **
  2059. ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
  2060. ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
  2061. ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
  2062. ** becomes the [statement journal] spill-to-disk threshold.
  2063. ** [Statement journals] are held in memory until their size (in bytes)
  2064. ** exceeds this threshold, at which point they are written to disk.
  2065. ** Or if the threshold is -1, statement journals are always held
  2066. ** exclusively in memory.
  2067. ** Since many statement journals never become large, setting the spill
  2068. ** threshold to a value such as 64KiB can greatly reduce the amount of
  2069. ** I/O required to support statement rollback.
  2070. ** The default value for this setting is controlled by the
  2071. ** [SQLITE_STMTJRNL_SPILL] compile-time option.
  2072. ** </dl>
  2073. */
  2074. #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
  2075. #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
  2076. #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
  2077. #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
  2078. #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
  2079. #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
  2080. #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
  2081. #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
  2082. #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
  2083. #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
  2084. #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
  2085. /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
  2086. #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
  2087. #define SQLITE_CONFIG_PCACHE 14 /* no-op */
  2088. #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
  2089. #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
  2090. #define SQLITE_CONFIG_URI 17 /* int */
  2091. #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
  2092. #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
  2093. #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
  2094. #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
  2095. #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
  2096. #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
  2097. #define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
  2098. #define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
  2099. #define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
  2100. /*
  2101. ** CAPI3REF: Database Connection Configuration Options
  2102. **
  2103. ** These constants are the available integer configuration options that
  2104. ** can be passed as the second argument to the [sqlite3_db_config()] interface.
  2105. **
  2106. ** New configuration options may be added in future releases of SQLite.
  2107. ** Existing configuration options might be discontinued. Applications
  2108. ** should check the return code from [sqlite3_db_config()] to make sure that
  2109. ** the call worked. ^The [sqlite3_db_config()] interface will return a
  2110. ** non-zero [error code] if a discontinued or unsupported configuration option
  2111. ** is invoked.
  2112. **
  2113. ** <dl>
  2114. ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
  2115. ** <dd> ^This option takes three additional arguments that determine the
  2116. ** [lookaside memory allocator] configuration for the [database connection].
  2117. ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
  2118. ** pointer to a memory buffer to use for lookaside memory.
  2119. ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
  2120. ** may be NULL in which case SQLite will allocate the
  2121. ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
  2122. ** size of each lookaside buffer slot. ^The third argument is the number of
  2123. ** slots. The size of the buffer in the first argument must be greater than
  2124. ** or equal to the product of the second and third arguments. The buffer
  2125. ** must be aligned to an 8-byte boundary. ^If the second argument to
  2126. ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
  2127. ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
  2128. ** configuration for a database connection can only be changed when that
  2129. ** connection is not currently using lookaside memory, or in other words
  2130. ** when the "current value" returned by
  2131. ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
  2132. ** Any attempt to change the lookaside memory configuration when lookaside
  2133. ** memory is in use leaves the configuration unchanged and returns
  2134. ** [SQLITE_BUSY].)^</dd>
  2135. **
  2136. ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
  2137. ** <dd> ^This option is used to enable or disable the enforcement of
  2138. ** [foreign key constraints]. There should be two additional arguments.
  2139. ** The first argument is an integer which is 0 to disable FK enforcement,
  2140. ** positive to enable FK enforcement or negative to leave FK enforcement
  2141. ** unchanged. The second parameter is a pointer to an integer into which
  2142. ** is written 0 or 1 to indicate whether FK enforcement is off or on
  2143. ** following this call. The second parameter may be a NULL pointer, in
  2144. ** which case the FK enforcement setting is not reported back. </dd>
  2145. **
  2146. ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
  2147. ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
  2148. ** There should be two additional arguments.
  2149. ** The first argument is an integer which is 0 to disable triggers,
  2150. ** positive to enable triggers or negative to leave the setting unchanged.
  2151. ** The second parameter is a pointer to an integer into which
  2152. ** is written 0 or 1 to indicate whether triggers are disabled or enabled
  2153. ** following this call. The second parameter may be a NULL pointer, in
  2154. ** which case the trigger setting is not reported back. </dd>
  2155. **
  2156. ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
  2157. ** <dd> ^This option is used to enable or disable the two-argument
  2158. ** version of the [fts3_tokenizer()] function which is part of the
  2159. ** [FTS3] full-text search engine extension.
  2160. ** There should be two additional arguments.
  2161. ** The first argument is an integer which is 0 to disable fts3_tokenizer() or
  2162. ** positive to enable fts3_tokenizer() or negative to leave the setting
  2163. ** unchanged.
  2164. ** The second parameter is a pointer to an integer into which
  2165. ** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
  2166. ** following this call. The second parameter may be a NULL pointer, in
  2167. ** which case the new setting is not reported back. </dd>
  2168. **
  2169. ** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
  2170. ** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
  2171. ** interface independently of the [load_extension()] SQL function.
  2172. ** The [sqlite3_enable_load_extension()] API enables or disables both the
  2173. ** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
  2174. ** There should be two additional arguments.
  2175. ** When the first argument to this interface is 1, then only the C-API is
  2176. ** enabled and the SQL function remains disabled. If the first argument to
  2177. ** this interface is 0, then both the C-API and the SQL function are disabled.
  2178. ** If the first argument is -1, then no changes are made to state of either the
  2179. ** C-API or the SQL function.
  2180. ** The second parameter is a pointer to an integer into which
  2181. ** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
  2182. ** is disabled or enabled following this call. The second parameter may
  2183. ** be a NULL pointer, in which case the new setting is not reported back.
  2184. ** </dd>
  2185. **
  2186. ** <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
  2187. ** <dd> ^This option is used to change the name of the "main" database
  2188. ** schema. ^The sole argument is a pointer to a constant UTF8 string
  2189. ** which will become the new schema name in place of "main". ^SQLite
  2190. ** does not make a copy of the new main schema name string, so the application
  2191. ** must ensure that the argument passed into this DBCONFIG option is unchanged
  2192. ** until after the database connection closes.
  2193. ** </dd>
  2194. **
  2195. ** </dl>
  2196. */
  2197. #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
  2198. #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
  2199. #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
  2200. #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
  2201. #define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
  2202. #define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
  2203. /*
  2204. ** CAPI3REF: Enable Or Disable Extended Result Codes
  2205. ** METHOD: sqlite3
  2206. **
  2207. ** ^The sqlite3_extended_result_codes() routine enables or disables the
  2208. ** [extended result codes] feature of SQLite. ^The extended result
  2209. ** codes are disabled by default for historical compatibility.
  2210. */
  2211. SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
  2212. /*
  2213. ** CAPI3REF: Last Insert Rowid
  2214. ** METHOD: sqlite3
  2215. **
  2216. ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
  2217. ** has a unique 64-bit signed
  2218. ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
  2219. ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
  2220. ** names are not also used by explicitly declared columns. ^If
  2221. ** the table has a column of type [INTEGER PRIMARY KEY] then that column
  2222. ** is another alias for the rowid.
  2223. **
  2224. ** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the
  2225. ** most recent successful [INSERT] into a rowid table or [virtual table]
  2226. ** on database connection D.
  2227. ** ^Inserts into [WITHOUT ROWID] tables are not recorded.
  2228. ** ^If no successful [INSERT]s into rowid tables
  2229. ** have ever occurred on the database connection D,
  2230. ** then sqlite3_last_insert_rowid(D) returns zero.
  2231. **
  2232. ** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
  2233. ** method, then this routine will return the [rowid] of the inserted
  2234. ** row as long as the trigger or virtual table method is running.
  2235. ** But once the trigger or virtual table method ends, the value returned
  2236. ** by this routine reverts to what it was before the trigger or virtual
  2237. ** table method began.)^
  2238. **
  2239. ** ^An [INSERT] that fails due to a constraint violation is not a
  2240. ** successful [INSERT] and does not change the value returned by this
  2241. ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
  2242. ** and INSERT OR ABORT make no changes to the return value of this
  2243. ** routine when their insertion fails. ^(When INSERT OR REPLACE
  2244. ** encounters a constraint violation, it does not fail. The
  2245. ** INSERT continues to completion after deleting rows that caused
  2246. ** the constraint problem so INSERT OR REPLACE will always change
  2247. ** the return value of this interface.)^
  2248. **
  2249. ** ^For the purposes of this routine, an [INSERT] is considered to
  2250. ** be successful even if it is subsequently rolled back.
  2251. **
  2252. ** This function is accessible to SQL statements via the
  2253. ** [last_insert_rowid() SQL function].
  2254. **
  2255. ** If a separate thread performs a new [INSERT] on the same
  2256. ** database connection while the [sqlite3_last_insert_rowid()]
  2257. ** function is running and thus changes the last insert [rowid],
  2258. ** then the value returned by [sqlite3_last_insert_rowid()] is
  2259. ** unpredictable and might not equal either the old or the new
  2260. ** last insert [rowid].
  2261. */
  2262. SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
  2263. /*
  2264. ** CAPI3REF: Count The Number Of Rows Modified
  2265. ** METHOD: sqlite3
  2266. **
  2267. ** ^This function returns the number of rows modified, inserted or
  2268. ** deleted by the most recently completed INSERT, UPDATE or DELETE
  2269. ** statement on the database connection specified by the only parameter.
  2270. ** ^Executing any other type of SQL statement does not modify the value
  2271. ** returned by this function.
  2272. **
  2273. ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
  2274. ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
  2275. ** [foreign key actions] or [REPLACE] constraint resolution are not counted.
  2276. **
  2277. ** Changes to a view that are intercepted by
  2278. ** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
  2279. ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
  2280. ** DELETE statement run on a view is always zero. Only changes made to real
  2281. ** tables are counted.
  2282. **
  2283. ** Things are more complicated if the sqlite3_changes() function is
  2284. ** executed while a trigger program is running. This may happen if the
  2285. ** program uses the [changes() SQL function], or if some other callback
  2286. ** function invokes sqlite3_changes() directly. Essentially:
  2287. **
  2288. ** <ul>
  2289. ** <li> ^(Before entering a trigger program the value returned by
  2290. ** sqlite3_changes() function is saved. After the trigger program
  2291. ** has finished, the original value is restored.)^
  2292. **
  2293. ** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
  2294. ** statement sets the value returned by sqlite3_changes()
  2295. ** upon completion as normal. Of course, this value will not include
  2296. ** any changes performed by sub-triggers, as the sqlite3_changes()
  2297. ** value will be saved and restored after each sub-trigger has run.)^
  2298. ** </ul>
  2299. **
  2300. ** ^This means that if the changes() SQL function (or similar) is used
  2301. ** by the first INSERT, UPDATE or DELETE statement within a trigger, it
  2302. ** returns the value as set when the calling statement began executing.
  2303. ** ^If it is used by the second or subsequent such statement within a trigger
  2304. ** program, the value returned reflects the number of rows modified by the
  2305. ** previous INSERT, UPDATE or DELETE statement within the same trigger.
  2306. **
  2307. ** See also the [sqlite3_total_changes()] interface, the
  2308. ** [count_changes pragma], and the [changes() SQL function].
  2309. **
  2310. ** If a separate thread makes changes on the same database connection
  2311. ** while [sqlite3_changes()] is running then the value returned
  2312. ** is unpredictable and not meaningful.
  2313. */
  2314. SQLITE_API int sqlite3_changes(sqlite3*);
  2315. /*
  2316. ** CAPI3REF: Total Number Of Rows Modified
  2317. ** METHOD: sqlite3
  2318. **
  2319. ** ^This function returns the total number of rows inserted, modified or
  2320. ** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
  2321. ** since the database connection was opened, including those executed as
  2322. ** part of trigger programs. ^Executing any other type of SQL statement
  2323. ** does not affect the value returned by sqlite3_total_changes().
  2324. **
  2325. ** ^Changes made as part of [foreign key actions] are included in the
  2326. ** count, but those made as part of REPLACE constraint resolution are
  2327. ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
  2328. ** are not counted.
  2329. **
  2330. ** See also the [sqlite3_changes()] interface, the
  2331. ** [count_changes pragma], and the [total_changes() SQL function].
  2332. **
  2333. ** If a separate thread makes changes on the same database connection
  2334. ** while [sqlite3_total_changes()] is running then the value
  2335. ** returned is unpredictable and not meaningful.
  2336. */
  2337. SQLITE_API int sqlite3_total_changes(sqlite3*);
  2338. /*
  2339. ** CAPI3REF: Interrupt A Long-Running Query
  2340. ** METHOD: sqlite3
  2341. **
  2342. ** ^This function causes any pending database operation to abort and
  2343. ** return at its earliest opportunity. This routine is typically
  2344. ** called in response to a user action such as pressing "Cancel"
  2345. ** or Ctrl-C where the user wants a long query operation to halt
  2346. ** immediately.
  2347. **
  2348. ** ^It is safe to call this routine from a thread different from the
  2349. ** thread that is currently running the database operation. But it
  2350. ** is not safe to call this routine with a [database connection] that
  2351. ** is closed or might close before sqlite3_interrupt() returns.
  2352. **
  2353. ** ^If an SQL operation is very nearly finished at the time when
  2354. ** sqlite3_interrupt() is called, then it might not have an opportunity
  2355. ** to be interrupted and might continue to completion.
  2356. **
  2357. ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
  2358. ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
  2359. ** that is inside an explicit transaction, then the entire transaction
  2360. ** will be rolled back automatically.
  2361. **
  2362. ** ^The sqlite3_interrupt(D) call is in effect until all currently running
  2363. ** SQL statements on [database connection] D complete. ^Any new SQL statements
  2364. ** that are started after the sqlite3_interrupt() call and before the
  2365. ** running statements reaches zero are interrupted as if they had been
  2366. ** running prior to the sqlite3_interrupt() call. ^New SQL statements
  2367. ** that are started after the running statement count reaches zero are
  2368. ** not effected by the sqlite3_interrupt().
  2369. ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
  2370. ** SQL statements is a no-op and has no effect on SQL statements
  2371. ** that are started after the sqlite3_interrupt() call returns.
  2372. **
  2373. ** If the database connection closes while [sqlite3_interrupt()]
  2374. ** is running then bad things will likely happen.
  2375. */
  2376. SQLITE_API void sqlite3_interrupt(sqlite3*);
  2377. /*
  2378. ** CAPI3REF: Determine If An SQL Statement Is Complete
  2379. **
  2380. ** These routines are useful during command-line input to determine if the
  2381. ** currently entered text seems to form a complete SQL statement or
  2382. ** if additional input is needed before sending the text into
  2383. ** SQLite for parsing. ^These routines return 1 if the input string
  2384. ** appears to be a complete SQL statement. ^A statement is judged to be
  2385. ** complete if it ends with a semicolon token and is not a prefix of a
  2386. ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
  2387. ** string literals or quoted identifier names or comments are not
  2388. ** independent tokens (they are part of the token in which they are
  2389. ** embedded) and thus do not count as a statement terminator. ^Whitespace
  2390. ** and comments that follow the final semicolon are ignored.
  2391. **
  2392. ** ^These routines return 0 if the statement is incomplete. ^If a
  2393. ** memory allocation fails, then SQLITE_NOMEM is returned.
  2394. **
  2395. ** ^These routines do not parse the SQL statements thus
  2396. ** will not detect syntactically incorrect SQL.
  2397. **
  2398. ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
  2399. ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
  2400. ** automatically by sqlite3_complete16(). If that initialization fails,
  2401. ** then the return value from sqlite3_complete16() will be non-zero
  2402. ** regardless of whether or not the input SQL is complete.)^
  2403. **
  2404. ** The input to [sqlite3_complete()] must be a zero-terminated
  2405. ** UTF-8 string.
  2406. **
  2407. ** The input to [sqlite3_complete16()] must be a zero-terminated
  2408. ** UTF-16 string in native byte order.
  2409. */
  2410. SQLITE_API int sqlite3_complete(const char *sql);
  2411. SQLITE_API int sqlite3_complete16(const void *sql);
  2412. /*
  2413. ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
  2414. ** KEYWORDS: {busy-handler callback} {busy handler}
  2415. ** METHOD: sqlite3
  2416. **
  2417. ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
  2418. ** that might be invoked with argument P whenever
  2419. ** an attempt is made to access a database table associated with
  2420. ** [database connection] D when another thread
  2421. ** or process has the table locked.
  2422. ** The sqlite3_busy_handler() interface is used to implement
  2423. ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
  2424. **
  2425. ** ^If the busy callback is NULL, then [SQLITE_BUSY]
  2426. ** is returned immediately upon encountering the lock. ^If the busy callback
  2427. ** is not NULL, then the callback might be invoked with two arguments.
  2428. **
  2429. ** ^The first argument to the busy handler is a copy of the void* pointer which
  2430. ** is the third argument to sqlite3_busy_handler(). ^The second argument to
  2431. ** the busy handler callback is the number of times that the busy handler has
  2432. ** been invoked previously for the same locking event. ^If the
  2433. ** busy callback returns 0, then no additional attempts are made to
  2434. ** access the database and [SQLITE_BUSY] is returned
  2435. ** to the application.
  2436. ** ^If the callback returns non-zero, then another attempt
  2437. ** is made to access the database and the cycle repeats.
  2438. **
  2439. ** The presence of a busy handler does not guarantee that it will be invoked
  2440. ** when there is lock contention. ^If SQLite determines that invoking the busy
  2441. ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
  2442. ** to the application instead of invoking the
  2443. ** busy handler.
  2444. ** Consider a scenario where one process is holding a read lock that
  2445. ** it is trying to promote to a reserved lock and
  2446. ** a second process is holding a reserved lock that it is trying
  2447. ** to promote to an exclusive lock. The first process cannot proceed
  2448. ** because it is blocked by the second and the second process cannot
  2449. ** proceed because it is blocked by the first. If both processes
  2450. ** invoke the busy handlers, neither will make any progress. Therefore,
  2451. ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
  2452. ** will induce the first process to release its read lock and allow
  2453. ** the second process to proceed.
  2454. **
  2455. ** ^The default busy callback is NULL.
  2456. **
  2457. ** ^(There can only be a single busy handler defined for each
  2458. ** [database connection]. Setting a new busy handler clears any
  2459. ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
  2460. ** or evaluating [PRAGMA busy_timeout=N] will change the
  2461. ** busy handler and thus clear any previously set busy handler.
  2462. **
  2463. ** The busy callback should not take any actions which modify the
  2464. ** database connection that invoked the busy handler. In other words,
  2465. ** the busy handler is not reentrant. Any such actions
  2466. ** result in undefined behavior.
  2467. **
  2468. ** A busy handler must not close the database connection
  2469. ** or [prepared statement] that invoked the busy handler.
  2470. */
  2471. SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
  2472. /*
  2473. ** CAPI3REF: Set A Busy Timeout
  2474. ** METHOD: sqlite3
  2475. **
  2476. ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
  2477. ** for a specified amount of time when a table is locked. ^The handler
  2478. ** will sleep multiple times until at least "ms" milliseconds of sleeping
  2479. ** have accumulated. ^After at least "ms" milliseconds of sleeping,
  2480. ** the handler returns 0 which causes [sqlite3_step()] to return
  2481. ** [SQLITE_BUSY].
  2482. **
  2483. ** ^Calling this routine with an argument less than or equal to zero
  2484. ** turns off all busy handlers.
  2485. **
  2486. ** ^(There can only be a single busy handler for a particular
  2487. ** [database connection] at any given moment. If another busy handler
  2488. ** was defined (using [sqlite3_busy_handler()]) prior to calling
  2489. ** this routine, that other busy handler is cleared.)^
  2490. **
  2491. ** See also: [PRAGMA busy_timeout]
  2492. */
  2493. SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
  2494. /*
  2495. ** CAPI3REF: Convenience Routines For Running Queries
  2496. ** METHOD: sqlite3
  2497. **
  2498. ** This is a legacy interface that is preserved for backwards compatibility.
  2499. ** Use of this interface is not recommended.
  2500. **
  2501. ** Definition: A <b>result table</b> is memory data structure created by the
  2502. ** [sqlite3_get_table()] interface. A result table records the
  2503. ** complete query results from one or more queries.
  2504. **
  2505. ** The table conceptually has a number of rows and columns. But
  2506. ** these numbers are not part of the result table itself. These
  2507. ** numbers are obtained separately. Let N be the number of rows
  2508. ** and M be the number of columns.
  2509. **
  2510. ** A result table is an array of pointers to zero-terminated UTF-8 strings.
  2511. ** There are (N+1)*M elements in the array. The first M pointers point
  2512. ** to zero-terminated strings that contain the names of the columns.
  2513. ** The remaining entries all point to query results. NULL values result
  2514. ** in NULL pointers. All other values are in their UTF-8 zero-terminated
  2515. ** string representation as returned by [sqlite3_column_text()].
  2516. **
  2517. ** A result table might consist of one or more memory allocations.
  2518. ** It is not safe to pass a result table directly to [sqlite3_free()].
  2519. ** A result table should be deallocated using [sqlite3_free_table()].
  2520. **
  2521. ** ^(As an example of the result table format, suppose a query result
  2522. ** is as follows:
  2523. **
  2524. ** <blockquote><pre>
  2525. ** Name | Age
  2526. ** -----------------------
  2527. ** Alice | 43
  2528. ** Bob | 28
  2529. ** Cindy | 21
  2530. ** </pre></blockquote>
  2531. **
  2532. ** There are two column (M==2) and three rows (N==3). Thus the
  2533. ** result table has 8 entries. Suppose the result table is stored
  2534. ** in an array names azResult. Then azResult holds this content:
  2535. **
  2536. ** <blockquote><pre>
  2537. ** azResult&#91;0] = "Name";
  2538. ** azResult&#91;1] = "Age";
  2539. ** azResult&#91;2] = "Alice";
  2540. ** azResult&#91;3] = "43";
  2541. ** azResult&#91;4] = "Bob";
  2542. ** azResult&#91;5] = "28";
  2543. ** azResult&#91;6] = "Cindy";
  2544. ** azResult&#91;7] = "21";
  2545. ** </pre></blockquote>)^
  2546. **
  2547. ** ^The sqlite3_get_table() function evaluates one or more
  2548. ** semicolon-separated SQL statements in the zero-terminated UTF-8
  2549. ** string of its 2nd parameter and returns a result table to the
  2550. ** pointer given in its 3rd parameter.
  2551. **
  2552. ** After the application has finished with the result from sqlite3_get_table(),
  2553. ** it must pass the result table pointer to sqlite3_free_table() in order to
  2554. ** release the memory that was malloced. Because of the way the
  2555. ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
  2556. ** function must not try to call [sqlite3_free()] directly. Only
  2557. ** [sqlite3_free_table()] is able to release the memory properly and safely.
  2558. **
  2559. ** The sqlite3_get_table() interface is implemented as a wrapper around
  2560. ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
  2561. ** to any internal data structures of SQLite. It uses only the public
  2562. ** interface defined here. As a consequence, errors that occur in the
  2563. ** wrapper layer outside of the internal [sqlite3_exec()] call are not
  2564. ** reflected in subsequent calls to [sqlite3_errcode()] or
  2565. ** [sqlite3_errmsg()].
  2566. */
  2567. SQLITE_API int sqlite3_get_table(
  2568. sqlite3 *db, /* An open database */
  2569. const char *zSql, /* SQL to be evaluated */
  2570. char ***pazResult, /* Results of the query */
  2571. int *pnRow, /* Number of result rows written here */
  2572. int *pnColumn, /* Number of result columns written here */
  2573. char **pzErrmsg /* Error msg written here */
  2574. );
  2575. SQLITE_API void sqlite3_free_table(char **result);
  2576. /*
  2577. ** CAPI3REF: Formatted String Printing Functions
  2578. **
  2579. ** These routines are work-alikes of the "printf()" family of functions
  2580. ** from the standard C library.
  2581. ** These routines understand most of the common K&R formatting options,
  2582. ** plus some additional non-standard formats, detailed below.
  2583. ** Note that some of the more obscure formatting options from recent
  2584. ** C-library standards are omitted from this implementation.
  2585. **
  2586. ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
  2587. ** results into memory obtained from [sqlite3_malloc()].
  2588. ** The strings returned by these two routines should be
  2589. ** released by [sqlite3_free()]. ^Both routines return a
  2590. ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
  2591. ** memory to hold the resulting string.
  2592. **
  2593. ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
  2594. ** the standard C library. The result is written into the
  2595. ** buffer supplied as the second parameter whose size is given by
  2596. ** the first parameter. Note that the order of the
  2597. ** first two parameters is reversed from snprintf().)^ This is an
  2598. ** historical accident that cannot be fixed without breaking
  2599. ** backwards compatibility. ^(Note also that sqlite3_snprintf()
  2600. ** returns a pointer to its buffer instead of the number of
  2601. ** characters actually written into the buffer.)^ We admit that
  2602. ** the number of characters written would be a more useful return
  2603. ** value but we cannot change the implementation of sqlite3_snprintf()
  2604. ** now without breaking compatibility.
  2605. **
  2606. ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
  2607. ** guarantees that the buffer is always zero-terminated. ^The first
  2608. ** parameter "n" is the total size of the buffer, including space for
  2609. ** the zero terminator. So the longest string that can be completely
  2610. ** written will be n-1 characters.
  2611. **
  2612. ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
  2613. **
  2614. ** These routines all implement some additional formatting
  2615. ** options that are useful for constructing SQL statements.
  2616. ** All of the usual printf() formatting options apply. In addition, there
  2617. ** is are "%q", "%Q", "%w" and "%z" options.
  2618. **
  2619. ** ^(The %q option works like %s in that it substitutes a nul-terminated
  2620. ** string from the argument list. But %q also doubles every '\'' character.
  2621. ** %q is designed for use inside a string literal.)^ By doubling each '\''
  2622. ** character it escapes that character and allows it to be inserted into
  2623. ** the string.
  2624. **
  2625. ** For example, assume the string variable zText contains text as follows:
  2626. **
  2627. ** <blockquote><pre>
  2628. ** char *zText = "It's a happy day!";
  2629. ** </pre></blockquote>
  2630. **
  2631. ** One can use this text in an SQL statement as follows:
  2632. **
  2633. ** <blockquote><pre>
  2634. ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
  2635. ** sqlite3_exec(db, zSQL, 0, 0, 0);
  2636. ** sqlite3_free(zSQL);
  2637. ** </pre></blockquote>
  2638. **
  2639. ** Because the %q format string is used, the '\'' character in zText
  2640. ** is escaped and the SQL generated is as follows:
  2641. **
  2642. ** <blockquote><pre>
  2643. ** INSERT INTO table1 VALUES('It''s a happy day!')
  2644. ** </pre></blockquote>
  2645. **
  2646. ** This is correct. Had we used %s instead of %q, the generated SQL
  2647. ** would have looked like this:
  2648. **
  2649. ** <blockquote><pre>
  2650. ** INSERT INTO table1 VALUES('It's a happy day!');
  2651. ** </pre></blockquote>
  2652. **
  2653. ** This second example is an SQL syntax error. As a general rule you should
  2654. ** always use %q instead of %s when inserting text into a string literal.
  2655. **
  2656. ** ^(The %Q option works like %q except it also adds single quotes around
  2657. ** the outside of the total string. Additionally, if the parameter in the
  2658. ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
  2659. ** single quotes).)^ So, for example, one could say:
  2660. **
  2661. ** <blockquote><pre>
  2662. ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
  2663. ** sqlite3_exec(db, zSQL, 0, 0, 0);
  2664. ** sqlite3_free(zSQL);
  2665. ** </pre></blockquote>
  2666. **
  2667. ** The code above will render a correct SQL statement in the zSQL
  2668. ** variable even if the zText variable is a NULL pointer.
  2669. **
  2670. ** ^(The "%w" formatting option is like "%q" except that it expects to
  2671. ** be contained within double-quotes instead of single quotes, and it
  2672. ** escapes the double-quote character instead of the single-quote
  2673. ** character.)^ The "%w" formatting option is intended for safely inserting
  2674. ** table and column names into a constructed SQL statement.
  2675. **
  2676. ** ^(The "%z" formatting option works like "%s" but with the
  2677. ** addition that after the string has been read and copied into
  2678. ** the result, [sqlite3_free()] is called on the input string.)^
  2679. */
  2680. SQLITE_API char *sqlite3_mprintf(const char*,...);
  2681. SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
  2682. SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
  2683. SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
  2684. /*
  2685. ** CAPI3REF: Memory Allocation Subsystem
  2686. **
  2687. ** The SQLite core uses these three routines for all of its own
  2688. ** internal memory allocation needs. "Core" in the previous sentence
  2689. ** does not include operating-system specific VFS implementation. The
  2690. ** Windows VFS uses native malloc() and free() for some operations.
  2691. **
  2692. ** ^The sqlite3_malloc() routine returns a pointer to a block
  2693. ** of memory at least N bytes in length, where N is the parameter.
  2694. ** ^If sqlite3_malloc() is unable to obtain sufficient free
  2695. ** memory, it returns a NULL pointer. ^If the parameter N to
  2696. ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
  2697. ** a NULL pointer.
  2698. **
  2699. ** ^The sqlite3_malloc64(N) routine works just like
  2700. ** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
  2701. ** of a signed 32-bit integer.
  2702. **
  2703. ** ^Calling sqlite3_free() with a pointer previously returned
  2704. ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
  2705. ** that it might be reused. ^The sqlite3_free() routine is
  2706. ** a no-op if is called with a NULL pointer. Passing a NULL pointer
  2707. ** to sqlite3_free() is harmless. After being freed, memory
  2708. ** should neither be read nor written. Even reading previously freed
  2709. ** memory might result in a segmentation fault or other severe error.
  2710. ** Memory corruption, a segmentation fault, or other severe error
  2711. ** might result if sqlite3_free() is called with a non-NULL pointer that
  2712. ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
  2713. **
  2714. ** ^The sqlite3_realloc(X,N) interface attempts to resize a
  2715. ** prior memory allocation X to be at least N bytes.
  2716. ** ^If the X parameter to sqlite3_realloc(X,N)
  2717. ** is a NULL pointer then its behavior is identical to calling
  2718. ** sqlite3_malloc(N).
  2719. ** ^If the N parameter to sqlite3_realloc(X,N) is zero or
  2720. ** negative then the behavior is exactly the same as calling
  2721. ** sqlite3_free(X).
  2722. ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
  2723. ** of at least N bytes in size or NULL if insufficient memory is available.
  2724. ** ^If M is the size of the prior allocation, then min(N,M) bytes
  2725. ** of the prior allocation are copied into the beginning of buffer returned
  2726. ** by sqlite3_realloc(X,N) and the prior allocation is freed.
  2727. ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
  2728. ** prior allocation is not freed.
  2729. **
  2730. ** ^The sqlite3_realloc64(X,N) interfaces works the same as
  2731. ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
  2732. ** of a 32-bit signed integer.
  2733. **
  2734. ** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
  2735. ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
  2736. ** sqlite3_msize(X) returns the size of that memory allocation in bytes.
  2737. ** ^The value returned by sqlite3_msize(X) might be larger than the number
  2738. ** of bytes requested when X was allocated. ^If X is a NULL pointer then
  2739. ** sqlite3_msize(X) returns zero. If X points to something that is not
  2740. ** the beginning of memory allocation, or if it points to a formerly
  2741. ** valid memory allocation that has now been freed, then the behavior
  2742. ** of sqlite3_msize(X) is undefined and possibly harmful.
  2743. **
  2744. ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
  2745. ** sqlite3_malloc64(), and sqlite3_realloc64()
  2746. ** is always aligned to at least an 8 byte boundary, or to a
  2747. ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
  2748. ** option is used.
  2749. **
  2750. ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
  2751. ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
  2752. ** implementation of these routines to be omitted. That capability
  2753. ** is no longer provided. Only built-in memory allocators can be used.
  2754. **
  2755. ** Prior to SQLite version 3.7.10, the Windows OS interface layer called
  2756. ** the system malloc() and free() directly when converting
  2757. ** filenames between the UTF-8 encoding used by SQLite
  2758. ** and whatever filename encoding is used by the particular Windows
  2759. ** installation. Memory allocation errors were detected, but
  2760. ** they were reported back as [SQLITE_CANTOPEN] or
  2761. ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
  2762. **
  2763. ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
  2764. ** must be either NULL or else pointers obtained from a prior
  2765. ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
  2766. ** not yet been released.
  2767. **
  2768. ** The application must not read or write any part of
  2769. ** a block of memory after it has been released using
  2770. ** [sqlite3_free()] or [sqlite3_realloc()].
  2771. */
  2772. SQLITE_API void *sqlite3_malloc(int);
  2773. SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
  2774. SQLITE_API void *sqlite3_realloc(void*, int);
  2775. SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);
  2776. SQLITE_API void sqlite3_free(void*);
  2777. SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
  2778. /*
  2779. ** CAPI3REF: Memory Allocator Statistics
  2780. **
  2781. ** SQLite provides these two interfaces for reporting on the status
  2782. ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
  2783. ** routines, which form the built-in memory allocation subsystem.
  2784. **
  2785. ** ^The [sqlite3_memory_used()] routine returns the number of bytes
  2786. ** of memory currently outstanding (malloced but not freed).
  2787. ** ^The [sqlite3_memory_highwater()] routine returns the maximum
  2788. ** value of [sqlite3_memory_used()] since the high-water mark
  2789. ** was last reset. ^The values returned by [sqlite3_memory_used()] and
  2790. ** [sqlite3_memory_highwater()] include any overhead
  2791. ** added by SQLite in its implementation of [sqlite3_malloc()],
  2792. ** but not overhead added by the any underlying system library
  2793. ** routines that [sqlite3_malloc()] may call.
  2794. **
  2795. ** ^The memory high-water mark is reset to the current value of
  2796. ** [sqlite3_memory_used()] if and only if the parameter to
  2797. ** [sqlite3_memory_highwater()] is true. ^The value returned
  2798. ** by [sqlite3_memory_highwater(1)] is the high-water mark
  2799. ** prior to the reset.
  2800. */
  2801. SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
  2802. SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
  2803. /*
  2804. ** CAPI3REF: Pseudo-Random Number Generator
  2805. **
  2806. ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
  2807. ** select random [ROWID | ROWIDs] when inserting new records into a table that
  2808. ** already uses the largest possible [ROWID]. The PRNG is also used for
  2809. ** the build-in random() and randomblob() SQL functions. This interface allows
  2810. ** applications to access the same PRNG for other purposes.
  2811. **
  2812. ** ^A call to this routine stores N bytes of randomness into buffer P.
  2813. ** ^The P parameter can be a NULL pointer.
  2814. **
  2815. ** ^If this routine has not been previously called or if the previous
  2816. ** call had N less than one or a NULL pointer for P, then the PRNG is
  2817. ** seeded using randomness obtained from the xRandomness method of
  2818. ** the default [sqlite3_vfs] object.
  2819. ** ^If the previous call to this routine had an N of 1 or more and a
  2820. ** non-NULL P then the pseudo-randomness is generated
  2821. ** internally and without recourse to the [sqlite3_vfs] xRandomness
  2822. ** method.
  2823. */
  2824. SQLITE_API void sqlite3_randomness(int N, void *P);
  2825. /*
  2826. ** CAPI3REF: Compile-Time Authorization Callbacks
  2827. ** METHOD: sqlite3
  2828. **
  2829. ** ^This routine registers an authorizer callback with a particular
  2830. ** [database connection], supplied in the first argument.
  2831. ** ^The authorizer callback is invoked as SQL statements are being compiled
  2832. ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
  2833. ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
  2834. ** points during the compilation process, as logic is being created
  2835. ** to perform various actions, the authorizer callback is invoked to
  2836. ** see if those actions are allowed. ^The authorizer callback should
  2837. ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
  2838. ** specific action but allow the SQL statement to continue to be
  2839. ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
  2840. ** rejected with an error. ^If the authorizer callback returns
  2841. ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
  2842. ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
  2843. ** the authorizer will fail with an error message.
  2844. **
  2845. ** When the callback returns [SQLITE_OK], that means the operation
  2846. ** requested is ok. ^When the callback returns [SQLITE_DENY], the
  2847. ** [sqlite3_prepare_v2()] or equivalent call that triggered the
  2848. ** authorizer will fail with an error message explaining that
  2849. ** access is denied.
  2850. **
  2851. ** ^The first parameter to the authorizer callback is a copy of the third
  2852. ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
  2853. ** to the callback is an integer [SQLITE_COPY | action code] that specifies
  2854. ** the particular action to be authorized. ^The third through sixth parameters
  2855. ** to the callback are zero-terminated strings that contain additional
  2856. ** details about the action to be authorized.
  2857. **
  2858. ** ^If the action code is [SQLITE_READ]
  2859. ** and the callback returns [SQLITE_IGNORE] then the
  2860. ** [prepared statement] statement is constructed to substitute
  2861. ** a NULL value in place of the table column that would have
  2862. ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
  2863. ** return can be used to deny an untrusted user access to individual
  2864. ** columns of a table.
  2865. ** ^If the action code is [SQLITE_DELETE] and the callback returns
  2866. ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
  2867. ** [truncate optimization] is disabled and all rows are deleted individually.
  2868. **
  2869. ** An authorizer is used when [sqlite3_prepare | preparing]
  2870. ** SQL statements from an untrusted source, to ensure that the SQL statements
  2871. ** do not try to access data they are not allowed to see, or that they do not
  2872. ** try to execute malicious statements that damage the database. For
  2873. ** example, an application may allow a user to enter arbitrary
  2874. ** SQL queries for evaluation by a database. But the application does
  2875. ** not want the user to be able to make arbitrary changes to the
  2876. ** database. An authorizer could then be put in place while the
  2877. ** user-entered SQL is being [sqlite3_prepare | prepared] that
  2878. ** disallows everything except [SELECT] statements.
  2879. **
  2880. ** Applications that need to process SQL from untrusted sources
  2881. ** might also consider lowering resource limits using [sqlite3_limit()]
  2882. ** and limiting database size using the [max_page_count] [PRAGMA]
  2883. ** in addition to using an authorizer.
  2884. **
  2885. ** ^(Only a single authorizer can be in place on a database connection
  2886. ** at a time. Each call to sqlite3_set_authorizer overrides the
  2887. ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
  2888. ** The authorizer is disabled by default.
  2889. **
  2890. ** The authorizer callback must not do anything that will modify
  2891. ** the database connection that invoked the authorizer callback.
  2892. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  2893. ** database connections for the meaning of "modify" in this paragraph.
  2894. **
  2895. ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
  2896. ** statement might be re-prepared during [sqlite3_step()] due to a
  2897. ** schema change. Hence, the application should ensure that the
  2898. ** correct authorizer callback remains in place during the [sqlite3_step()].
  2899. **
  2900. ** ^Note that the authorizer callback is invoked only during
  2901. ** [sqlite3_prepare()] or its variants. Authorization is not
  2902. ** performed during statement evaluation in [sqlite3_step()], unless
  2903. ** as stated in the previous paragraph, sqlite3_step() invokes
  2904. ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
  2905. */
  2906. SQLITE_API int sqlite3_set_authorizer(
  2907. sqlite3*,
  2908. int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
  2909. void *pUserData
  2910. );
  2911. /*
  2912. ** CAPI3REF: Authorizer Return Codes
  2913. **
  2914. ** The [sqlite3_set_authorizer | authorizer callback function] must
  2915. ** return either [SQLITE_OK] or one of these two constants in order
  2916. ** to signal SQLite whether or not the action is permitted. See the
  2917. ** [sqlite3_set_authorizer | authorizer documentation] for additional
  2918. ** information.
  2919. **
  2920. ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
  2921. ** returned from the [sqlite3_vtab_on_conflict()] interface.
  2922. */
  2923. #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
  2924. #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
  2925. /*
  2926. ** CAPI3REF: Authorizer Action Codes
  2927. **
  2928. ** The [sqlite3_set_authorizer()] interface registers a callback function
  2929. ** that is invoked to authorize certain SQL statement actions. The
  2930. ** second parameter to the callback is an integer code that specifies
  2931. ** what action is being authorized. These are the integer action codes that
  2932. ** the authorizer callback may be passed.
  2933. **
  2934. ** These action code values signify what kind of operation is to be
  2935. ** authorized. The 3rd and 4th parameters to the authorization
  2936. ** callback function will be parameters or NULL depending on which of these
  2937. ** codes is used as the second parameter. ^(The 5th parameter to the
  2938. ** authorizer callback is the name of the database ("main", "temp",
  2939. ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
  2940. ** is the name of the inner-most trigger or view that is responsible for
  2941. ** the access attempt or NULL if this access attempt is directly from
  2942. ** top-level SQL code.
  2943. */
  2944. /******************************************* 3rd ************ 4th ***********/
  2945. #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
  2946. #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
  2947. #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
  2948. #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
  2949. #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
  2950. #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
  2951. #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
  2952. #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
  2953. #define SQLITE_DELETE 9 /* Table Name NULL */
  2954. #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
  2955. #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
  2956. #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
  2957. #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
  2958. #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
  2959. #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
  2960. #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
  2961. #define SQLITE_DROP_VIEW 17 /* View Name NULL */
  2962. #define SQLITE_INSERT 18 /* Table Name NULL */
  2963. #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
  2964. #define SQLITE_READ 20 /* Table Name Column Name */
  2965. #define SQLITE_SELECT 21 /* NULL NULL */
  2966. #define SQLITE_TRANSACTION 22 /* Operation NULL */
  2967. #define SQLITE_UPDATE 23 /* Table Name Column Name */
  2968. #define SQLITE_ATTACH 24 /* Filename NULL */
  2969. #define SQLITE_DETACH 25 /* Database Name NULL */
  2970. #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
  2971. #define SQLITE_REINDEX 27 /* Index Name NULL */
  2972. #define SQLITE_ANALYZE 28 /* Table Name NULL */
  2973. #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
  2974. #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
  2975. #define SQLITE_FUNCTION 31 /* NULL Function Name */
  2976. #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
  2977. #define SQLITE_COPY 0 /* No longer used */
  2978. #define SQLITE_RECURSIVE 33 /* NULL NULL */
  2979. /*
  2980. ** CAPI3REF: Tracing And Profiling Functions
  2981. ** METHOD: sqlite3
  2982. **
  2983. ** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
  2984. ** instead of the routines described here.
  2985. **
  2986. ** These routines register callback functions that can be used for
  2987. ** tracing and profiling the execution of SQL statements.
  2988. **
  2989. ** ^The callback function registered by sqlite3_trace() is invoked at
  2990. ** various times when an SQL statement is being run by [sqlite3_step()].
  2991. ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
  2992. ** SQL statement text as the statement first begins executing.
  2993. ** ^(Additional sqlite3_trace() callbacks might occur
  2994. ** as each triggered subprogram is entered. The callbacks for triggers
  2995. ** contain a UTF-8 SQL comment that identifies the trigger.)^
  2996. **
  2997. ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
  2998. ** the length of [bound parameter] expansion in the output of sqlite3_trace().
  2999. **
  3000. ** ^The callback function registered by sqlite3_profile() is invoked
  3001. ** as each SQL statement finishes. ^The profile callback contains
  3002. ** the original statement text and an estimate of wall-clock time
  3003. ** of how long that statement took to run. ^The profile callback
  3004. ** time is in units of nanoseconds, however the current implementation
  3005. ** is only capable of millisecond resolution so the six least significant
  3006. ** digits in the time are meaningless. Future versions of SQLite
  3007. ** might provide greater resolution on the profiler callback. The
  3008. ** sqlite3_profile() function is considered experimental and is
  3009. ** subject to change in future versions of SQLite.
  3010. */
  3011. SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
  3012. void(*xTrace)(void*,const char*), void*);
  3013. SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
  3014. void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
  3015. /*
  3016. ** CAPI3REF: SQL Trace Event Codes
  3017. ** KEYWORDS: SQLITE_TRACE
  3018. **
  3019. ** These constants identify classes of events that can be monitored
  3020. ** using the [sqlite3_trace_v2()] tracing logic. The third argument
  3021. ** to [sqlite3_trace_v2()] is an OR-ed combination of one or more of
  3022. ** the following constants. ^The first argument to the trace callback
  3023. ** is one of the following constants.
  3024. **
  3025. ** New tracing constants may be added in future releases.
  3026. **
  3027. ** ^A trace callback has four arguments: xCallback(T,C,P,X).
  3028. ** ^The T argument is one of the integer type codes above.
  3029. ** ^The C argument is a copy of the context pointer passed in as the
  3030. ** fourth argument to [sqlite3_trace_v2()].
  3031. ** The P and X arguments are pointers whose meanings depend on T.
  3032. **
  3033. ** <dl>
  3034. ** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>
  3035. ** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
  3036. ** first begins running and possibly at other times during the
  3037. ** execution of the prepared statement, such as at the start of each
  3038. ** trigger subprogram. ^The P argument is a pointer to the
  3039. ** [prepared statement]. ^The X argument is a pointer to a string which
  3040. ** is the unexpanded SQL text of the prepared statement or an SQL comment
  3041. ** that indicates the invocation of a trigger. ^The callback can compute
  3042. ** the same text that would have been returned by the legacy [sqlite3_trace()]
  3043. ** interface by using the X argument when X begins with "--" and invoking
  3044. ** [sqlite3_expanded_sql(P)] otherwise.
  3045. **
  3046. ** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>
  3047. ** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
  3048. ** information as is provided by the [sqlite3_profile()] callback.
  3049. ** ^The P argument is a pointer to the [prepared statement] and the
  3050. ** X argument points to a 64-bit integer which is the estimated of
  3051. ** the number of nanosecond that the prepared statement took to run.
  3052. ** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
  3053. **
  3054. ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
  3055. ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
  3056. ** statement generates a single row of result.
  3057. ** ^The P argument is a pointer to the [prepared statement] and the
  3058. ** X argument is unused.
  3059. **
  3060. ** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>
  3061. ** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
  3062. ** connection closes.
  3063. ** ^The P argument is a pointer to the [database connection] object
  3064. ** and the X argument is unused.
  3065. ** </dl>
  3066. */
  3067. #define SQLITE_TRACE_STMT 0x01
  3068. #define SQLITE_TRACE_PROFILE 0x02
  3069. #define SQLITE_TRACE_ROW 0x04
  3070. #define SQLITE_TRACE_CLOSE 0x08
  3071. /*
  3072. ** CAPI3REF: SQL Trace Hook
  3073. ** METHOD: sqlite3
  3074. **
  3075. ** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
  3076. ** function X against [database connection] D, using property mask M
  3077. ** and context pointer P. ^If the X callback is
  3078. ** NULL or if the M mask is zero, then tracing is disabled. The
  3079. ** M argument should be the bitwise OR-ed combination of
  3080. ** zero or more [SQLITE_TRACE] constants.
  3081. **
  3082. ** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides
  3083. ** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().
  3084. **
  3085. ** ^The X callback is invoked whenever any of the events identified by
  3086. ** mask M occur. ^The integer return value from the callback is currently
  3087. ** ignored, though this may change in future releases. Callback
  3088. ** implementations should return zero to ensure future compatibility.
  3089. **
  3090. ** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
  3091. ** ^The T argument is one of the [SQLITE_TRACE]
  3092. ** constants to indicate why the callback was invoked.
  3093. ** ^The C argument is a copy of the context pointer.
  3094. ** The P and X arguments are pointers whose meanings depend on T.
  3095. **
  3096. ** The sqlite3_trace_v2() interface is intended to replace the legacy
  3097. ** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
  3098. ** are deprecated.
  3099. */
  3100. SQLITE_API int sqlite3_trace_v2(
  3101. sqlite3*,
  3102. unsigned uMask,
  3103. int(*xCallback)(unsigned,void*,void*,void*),
  3104. void *pCtx
  3105. );
  3106. /*
  3107. ** CAPI3REF: Query Progress Callbacks
  3108. ** METHOD: sqlite3
  3109. **
  3110. ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
  3111. ** function X to be invoked periodically during long running calls to
  3112. ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
  3113. ** database connection D. An example use for this
  3114. ** interface is to keep a GUI updated during a large query.
  3115. **
  3116. ** ^The parameter P is passed through as the only parameter to the
  3117. ** callback function X. ^The parameter N is the approximate number of
  3118. ** [virtual machine instructions] that are evaluated between successive
  3119. ** invocations of the callback X. ^If N is less than one then the progress
  3120. ** handler is disabled.
  3121. **
  3122. ** ^Only a single progress handler may be defined at one time per
  3123. ** [database connection]; setting a new progress handler cancels the
  3124. ** old one. ^Setting parameter X to NULL disables the progress handler.
  3125. ** ^The progress handler is also disabled by setting N to a value less
  3126. ** than 1.
  3127. **
  3128. ** ^If the progress callback returns non-zero, the operation is
  3129. ** interrupted. This feature can be used to implement a
  3130. ** "Cancel" button on a GUI progress dialog box.
  3131. **
  3132. ** The progress handler callback must not do anything that will modify
  3133. ** the database connection that invoked the progress handler.
  3134. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  3135. ** database connections for the meaning of "modify" in this paragraph.
  3136. **
  3137. */
  3138. SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
  3139. /*
  3140. ** CAPI3REF: Opening A New Database Connection
  3141. ** CONSTRUCTOR: sqlite3
  3142. **
  3143. ** ^These routines open an SQLite database file as specified by the
  3144. ** filename argument. ^The filename argument is interpreted as UTF-8 for
  3145. ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
  3146. ** order for sqlite3_open16(). ^(A [database connection] handle is usually
  3147. ** returned in *ppDb, even if an error occurs. The only exception is that
  3148. ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
  3149. ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
  3150. ** object.)^ ^(If the database is opened (and/or created) successfully, then
  3151. ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
  3152. ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
  3153. ** an English language description of the error following a failure of any
  3154. ** of the sqlite3_open() routines.
  3155. **
  3156. ** ^The default encoding will be UTF-8 for databases created using
  3157. ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
  3158. ** created using sqlite3_open16() will be UTF-16 in the native byte order.
  3159. **
  3160. ** Whether or not an error occurs when it is opened, resources
  3161. ** associated with the [database connection] handle should be released by
  3162. ** passing it to [sqlite3_close()] when it is no longer required.
  3163. **
  3164. ** The sqlite3_open_v2() interface works like sqlite3_open()
  3165. ** except that it accepts two additional parameters for additional control
  3166. ** over the new database connection. ^(The flags parameter to
  3167. ** sqlite3_open_v2() can take one of
  3168. ** the following three values, optionally combined with the
  3169. ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
  3170. ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
  3171. **
  3172. ** <dl>
  3173. ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
  3174. ** <dd>The database is opened in read-only mode. If the database does not
  3175. ** already exist, an error is returned.</dd>)^
  3176. **
  3177. ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
  3178. ** <dd>The database is opened for reading and writing if possible, or reading
  3179. ** only if the file is write protected by the operating system. In either
  3180. ** case the database must already exist, otherwise an error is returned.</dd>)^
  3181. **
  3182. ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
  3183. ** <dd>The database is opened for reading and writing, and is created if
  3184. ** it does not already exist. This is the behavior that is always used for
  3185. ** sqlite3_open() and sqlite3_open16().</dd>)^
  3186. ** </dl>
  3187. **
  3188. ** If the 3rd parameter to sqlite3_open_v2() is not one of the
  3189. ** combinations shown above optionally combined with other
  3190. ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
  3191. ** then the behavior is undefined.
  3192. **
  3193. ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
  3194. ** opens in the multi-thread [threading mode] as long as the single-thread
  3195. ** mode has not been set at compile-time or start-time. ^If the
  3196. ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
  3197. ** in the serialized [threading mode] unless single-thread was
  3198. ** previously selected at compile-time or start-time.
  3199. ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
  3200. ** eligible to use [shared cache mode], regardless of whether or not shared
  3201. ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
  3202. ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
  3203. ** participate in [shared cache mode] even if it is enabled.
  3204. **
  3205. ** ^The fourth parameter to sqlite3_open_v2() is the name of the
  3206. ** [sqlite3_vfs] object that defines the operating system interface that
  3207. ** the new database connection should use. ^If the fourth parameter is
  3208. ** a NULL pointer then the default [sqlite3_vfs] object is used.
  3209. **
  3210. ** ^If the filename is ":memory:", then a private, temporary in-memory database
  3211. ** is created for the connection. ^This in-memory database will vanish when
  3212. ** the database connection is closed. Future versions of SQLite might
  3213. ** make use of additional special filenames that begin with the ":" character.
  3214. ** It is recommended that when a database filename actually does begin with
  3215. ** a ":" character you should prefix the filename with a pathname such as
  3216. ** "./" to avoid ambiguity.
  3217. **
  3218. ** ^If the filename is an empty string, then a private, temporary
  3219. ** on-disk database will be created. ^This private database will be
  3220. ** automatically deleted as soon as the database connection is closed.
  3221. **
  3222. ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
  3223. **
  3224. ** ^If [URI filename] interpretation is enabled, and the filename argument
  3225. ** begins with "file:", then the filename is interpreted as a URI. ^URI
  3226. ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
  3227. ** set in the fourth argument to sqlite3_open_v2(), or if it has
  3228. ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
  3229. ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
  3230. ** As of SQLite version 3.7.7, URI filename interpretation is turned off
  3231. ** by default, but future releases of SQLite might enable URI filename
  3232. ** interpretation by default. See "[URI filenames]" for additional
  3233. ** information.
  3234. **
  3235. ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
  3236. ** authority, then it must be either an empty string or the string
  3237. ** "localhost". ^If the authority is not an empty string or "localhost", an
  3238. ** error is returned to the caller. ^The fragment component of a URI, if
  3239. ** present, is ignored.
  3240. **
  3241. ** ^SQLite uses the path component of the URI as the name of the disk file
  3242. ** which contains the database. ^If the path begins with a '/' character,
  3243. ** then it is interpreted as an absolute path. ^If the path does not begin
  3244. ** with a '/' (meaning that the authority section is omitted from the URI)
  3245. ** then the path is interpreted as a relative path.
  3246. ** ^(On windows, the first component of an absolute path
  3247. ** is a drive specification (e.g. "C:").)^
  3248. **
  3249. ** [[core URI query parameters]]
  3250. ** The query component of a URI may contain parameters that are interpreted
  3251. ** either by SQLite itself, or by a [VFS | custom VFS implementation].
  3252. ** SQLite and its built-in [VFSes] interpret the
  3253. ** following query parameters:
  3254. **
  3255. ** <ul>
  3256. ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
  3257. ** a VFS object that provides the operating system interface that should
  3258. ** be used to access the database file on disk. ^If this option is set to
  3259. ** an empty string the default VFS object is used. ^Specifying an unknown
  3260. ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
  3261. ** present, then the VFS specified by the option takes precedence over
  3262. ** the value passed as the fourth parameter to sqlite3_open_v2().
  3263. **
  3264. ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
  3265. ** "rwc", or "memory". Attempting to set it to any other value is
  3266. ** an error)^.
  3267. ** ^If "ro" is specified, then the database is opened for read-only
  3268. ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
  3269. ** third argument to sqlite3_open_v2(). ^If the mode option is set to
  3270. ** "rw", then the database is opened for read-write (but not create)
  3271. ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
  3272. ** been set. ^Value "rwc" is equivalent to setting both
  3273. ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
  3274. ** set to "memory" then a pure [in-memory database] that never reads
  3275. ** or writes from disk is used. ^It is an error to specify a value for
  3276. ** the mode parameter that is less restrictive than that specified by
  3277. ** the flags passed in the third parameter to sqlite3_open_v2().
  3278. **
  3279. ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
  3280. ** "private". ^Setting it to "shared" is equivalent to setting the
  3281. ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
  3282. ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
  3283. ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
  3284. ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
  3285. ** a URI filename, its value overrides any behavior requested by setting
  3286. ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
  3287. **
  3288. ** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
  3289. ** [powersafe overwrite] property does or does not apply to the
  3290. ** storage media on which the database file resides.
  3291. **
  3292. ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
  3293. ** which if set disables file locking in rollback journal modes. This
  3294. ** is useful for accessing a database on a filesystem that does not
  3295. ** support locking. Caution: Database corruption might result if two
  3296. ** or more processes write to the same database and any one of those
  3297. ** processes uses nolock=1.
  3298. **
  3299. ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
  3300. ** parameter that indicates that the database file is stored on
  3301. ** read-only media. ^When immutable is set, SQLite assumes that the
  3302. ** database file cannot be changed, even by a process with higher
  3303. ** privilege, and so the database is opened read-only and all locking
  3304. ** and change detection is disabled. Caution: Setting the immutable
  3305. ** property on a database file that does in fact change can result
  3306. ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
  3307. ** See also: [SQLITE_IOCAP_IMMUTABLE].
  3308. **
  3309. ** </ul>
  3310. **
  3311. ** ^Specifying an unknown parameter in the query component of a URI is not an
  3312. ** error. Future versions of SQLite might understand additional query
  3313. ** parameters. See "[query parameters with special meaning to SQLite]" for
  3314. ** additional information.
  3315. **
  3316. ** [[URI filename examples]] <h3>URI filename examples</h3>
  3317. **
  3318. ** <table border="1" align=center cellpadding=5>
  3319. ** <tr><th> URI filenames <th> Results
  3320. ** <tr><td> file:data.db <td>
  3321. ** Open the file "data.db" in the current directory.
  3322. ** <tr><td> file:/home/fred/data.db<br>
  3323. ** file:///home/fred/data.db <br>
  3324. ** file://localhost/home/fred/data.db <br> <td>
  3325. ** Open the database file "/home/fred/data.db".
  3326. ** <tr><td> file://darkstar/home/fred/data.db <td>
  3327. ** An error. "darkstar" is not a recognized authority.
  3328. ** <tr><td style="white-space:nowrap">
  3329. ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
  3330. ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
  3331. ** C:. Note that the %20 escaping in this example is not strictly
  3332. ** necessary - space characters can be used literally
  3333. ** in URI filenames.
  3334. ** <tr><td> file:data.db?mode=ro&cache=private <td>
  3335. ** Open file "data.db" in the current directory for read-only access.
  3336. ** Regardless of whether or not shared-cache mode is enabled by
  3337. ** default, use a private cache.
  3338. ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
  3339. ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
  3340. ** that uses dot-files in place of posix advisory locking.
  3341. ** <tr><td> file:data.db?mode=readonly <td>
  3342. ** An error. "readonly" is not a valid option for the "mode" parameter.
  3343. ** </table>
  3344. **
  3345. ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
  3346. ** query components of a URI. A hexadecimal escape sequence consists of a
  3347. ** percent sign - "%" - followed by exactly two hexadecimal digits
  3348. ** specifying an octet value. ^Before the path or query components of a
  3349. ** URI filename are interpreted, they are encoded using UTF-8 and all
  3350. ** hexadecimal escape sequences replaced by a single byte containing the
  3351. ** corresponding octet. If this process generates an invalid UTF-8 encoding,
  3352. ** the results are undefined.
  3353. **
  3354. ** <b>Note to Windows users:</b> The encoding used for the filename argument
  3355. ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
  3356. ** codepage is currently defined. Filenames containing international
  3357. ** characters must be converted to UTF-8 prior to passing them into
  3358. ** sqlite3_open() or sqlite3_open_v2().
  3359. **
  3360. ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
  3361. ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
  3362. ** features that require the use of temporary files may fail.
  3363. **
  3364. ** See also: [sqlite3_temp_directory]
  3365. */
  3366. SQLITE_API int sqlite3_open(
  3367. const char *filename, /* Database filename (UTF-8) */
  3368. sqlite3 **ppDb /* OUT: SQLite db handle */
  3369. );
  3370. SQLITE_API int sqlite3_open16(
  3371. const void *filename, /* Database filename (UTF-16) */
  3372. sqlite3 **ppDb /* OUT: SQLite db handle */
  3373. );
  3374. SQLITE_API int sqlite3_open_v2(
  3375. const char *filename, /* Database filename (UTF-8) */
  3376. sqlite3 **ppDb, /* OUT: SQLite db handle */
  3377. int flags, /* Flags */
  3378. const char *zVfs /* Name of VFS module to use */
  3379. );
  3380. /*
  3381. ** CAPI3REF: Obtain Values For URI Parameters
  3382. **
  3383. ** These are utility routines, useful to VFS implementations, that check
  3384. ** to see if a database file was a URI that contained a specific query
  3385. ** parameter, and if so obtains the value of that query parameter.
  3386. **
  3387. ** If F is the database filename pointer passed into the xOpen() method of
  3388. ** a VFS implementation when the flags parameter to xOpen() has one or
  3389. ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
  3390. ** P is the name of the query parameter, then
  3391. ** sqlite3_uri_parameter(F,P) returns the value of the P
  3392. ** parameter if it exists or a NULL pointer if P does not appear as a
  3393. ** query parameter on F. If P is a query parameter of F
  3394. ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
  3395. ** a pointer to an empty string.
  3396. **
  3397. ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
  3398. ** parameter and returns true (1) or false (0) according to the value
  3399. ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
  3400. ** value of query parameter P is one of "yes", "true", or "on" in any
  3401. ** case or if the value begins with a non-zero number. The
  3402. ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
  3403. ** query parameter P is one of "no", "false", or "off" in any case or
  3404. ** if the value begins with a numeric zero. If P is not a query
  3405. ** parameter on F or if the value of P is does not match any of the
  3406. ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
  3407. **
  3408. ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
  3409. ** 64-bit signed integer and returns that integer, or D if P does not
  3410. ** exist. If the value of P is something other than an integer, then
  3411. ** zero is returned.
  3412. **
  3413. ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
  3414. ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
  3415. ** is not a database file pathname pointer that SQLite passed into the xOpen
  3416. ** VFS method, then the behavior of this routine is undefined and probably
  3417. ** undesirable.
  3418. */
  3419. SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
  3420. SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
  3421. SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
  3422. /*
  3423. ** CAPI3REF: Error Codes And Messages
  3424. ** METHOD: sqlite3
  3425. **
  3426. ** ^If the most recent sqlite3_* API call associated with
  3427. ** [database connection] D failed, then the sqlite3_errcode(D) interface
  3428. ** returns the numeric [result code] or [extended result code] for that
  3429. ** API call.
  3430. ** If the most recent API call was successful,
  3431. ** then the return value from sqlite3_errcode() is undefined.
  3432. ** ^The sqlite3_extended_errcode()
  3433. ** interface is the same except that it always returns the
  3434. ** [extended result code] even when extended result codes are
  3435. ** disabled.
  3436. **
  3437. ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
  3438. ** text that describes the error, as either UTF-8 or UTF-16 respectively.
  3439. ** ^(Memory to hold the error message string is managed internally.
  3440. ** The application does not need to worry about freeing the result.
  3441. ** However, the error string might be overwritten or deallocated by
  3442. ** subsequent calls to other SQLite interface functions.)^
  3443. **
  3444. ** ^The sqlite3_errstr() interface returns the English-language text
  3445. ** that describes the [result code], as UTF-8.
  3446. ** ^(Memory to hold the error message string is managed internally
  3447. ** and must not be freed by the application)^.
  3448. **
  3449. ** When the serialized [threading mode] is in use, it might be the
  3450. ** case that a second error occurs on a separate thread in between
  3451. ** the time of the first error and the call to these interfaces.
  3452. ** When that happens, the second error will be reported since these
  3453. ** interfaces always report the most recent result. To avoid
  3454. ** this, each thread can obtain exclusive use of the [database connection] D
  3455. ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
  3456. ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
  3457. ** all calls to the interfaces listed here are completed.
  3458. **
  3459. ** If an interface fails with SQLITE_MISUSE, that means the interface
  3460. ** was invoked incorrectly by the application. In that case, the
  3461. ** error code and message may or may not be set.
  3462. */
  3463. SQLITE_API int sqlite3_errcode(sqlite3 *db);
  3464. SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
  3465. SQLITE_API const char *sqlite3_errmsg(sqlite3*);
  3466. SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
  3467. SQLITE_API const char *sqlite3_errstr(int);
  3468. /*
  3469. ** CAPI3REF: Prepared Statement Object
  3470. ** KEYWORDS: {prepared statement} {prepared statements}
  3471. **
  3472. ** An instance of this object represents a single SQL statement that
  3473. ** has been compiled into binary form and is ready to be evaluated.
  3474. **
  3475. ** Think of each SQL statement as a separate computer program. The
  3476. ** original SQL text is source code. A prepared statement object
  3477. ** is the compiled object code. All SQL must be converted into a
  3478. ** prepared statement before it can be run.
  3479. **
  3480. ** The life-cycle of a prepared statement object usually goes like this:
  3481. **
  3482. ** <ol>
  3483. ** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
  3484. ** <li> Bind values to [parameters] using the sqlite3_bind_*()
  3485. ** interfaces.
  3486. ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
  3487. ** <li> Reset the prepared statement using [sqlite3_reset()] then go back
  3488. ** to step 2. Do this zero or more times.
  3489. ** <li> Destroy the object using [sqlite3_finalize()].
  3490. ** </ol>
  3491. */
  3492. typedef struct sqlite3_stmt sqlite3_stmt;
  3493. /*
  3494. ** CAPI3REF: Run-time Limits
  3495. ** METHOD: sqlite3
  3496. **
  3497. ** ^(This interface allows the size of various constructs to be limited
  3498. ** on a connection by connection basis. The first parameter is the
  3499. ** [database connection] whose limit is to be set or queried. The
  3500. ** second parameter is one of the [limit categories] that define a
  3501. ** class of constructs to be size limited. The third parameter is the
  3502. ** new limit for that construct.)^
  3503. **
  3504. ** ^If the new limit is a negative number, the limit is unchanged.
  3505. ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
  3506. ** [limits | hard upper bound]
  3507. ** set at compile-time by a C preprocessor macro called
  3508. ** [limits | SQLITE_MAX_<i>NAME</i>].
  3509. ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
  3510. ** ^Attempts to increase a limit above its hard upper bound are
  3511. ** silently truncated to the hard upper bound.
  3512. **
  3513. ** ^Regardless of whether or not the limit was changed, the
  3514. ** [sqlite3_limit()] interface returns the prior value of the limit.
  3515. ** ^Hence, to find the current value of a limit without changing it,
  3516. ** simply invoke this interface with the third parameter set to -1.
  3517. **
  3518. ** Run-time limits are intended for use in applications that manage
  3519. ** both their own internal database and also databases that are controlled
  3520. ** by untrusted external sources. An example application might be a
  3521. ** web browser that has its own databases for storing history and
  3522. ** separate databases controlled by JavaScript applications downloaded
  3523. ** off the Internet. The internal databases can be given the
  3524. ** large, default limits. Databases managed by external sources can
  3525. ** be given much smaller limits designed to prevent a denial of service
  3526. ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
  3527. ** interface to further control untrusted SQL. The size of the database
  3528. ** created by an untrusted script can be contained using the
  3529. ** [max_page_count] [PRAGMA].
  3530. **
  3531. ** New run-time limit categories may be added in future releases.
  3532. */
  3533. SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
  3534. /*
  3535. ** CAPI3REF: Run-Time Limit Categories
  3536. ** KEYWORDS: {limit category} {*limit categories}
  3537. **
  3538. ** These constants define various performance limits
  3539. ** that can be lowered at run-time using [sqlite3_limit()].
  3540. ** The synopsis of the meanings of the various limits is shown below.
  3541. ** Additional information is available at [limits | Limits in SQLite].
  3542. **
  3543. ** <dl>
  3544. ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
  3545. ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
  3546. **
  3547. ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
  3548. ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
  3549. **
  3550. ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
  3551. ** <dd>The maximum number of columns in a table definition or in the
  3552. ** result set of a [SELECT] or the maximum number of columns in an index
  3553. ** or in an ORDER BY or GROUP BY clause.</dd>)^
  3554. **
  3555. ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
  3556. ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
  3557. **
  3558. ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
  3559. ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
  3560. **
  3561. ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
  3562. ** <dd>The maximum number of instructions in a virtual machine program
  3563. ** used to implement an SQL statement. This limit is not currently
  3564. ** enforced, though that might be added in some future release of
  3565. ** SQLite.</dd>)^
  3566. **
  3567. ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
  3568. ** <dd>The maximum number of arguments on a function.</dd>)^
  3569. **
  3570. ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
  3571. ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
  3572. **
  3573. ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
  3574. ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
  3575. ** <dd>The maximum length of the pattern argument to the [LIKE] or
  3576. ** [GLOB] operators.</dd>)^
  3577. **
  3578. ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
  3579. ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
  3580. ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
  3581. **
  3582. ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
  3583. ** <dd>The maximum depth of recursion for triggers.</dd>)^
  3584. **
  3585. ** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
  3586. ** <dd>The maximum number of auxiliary worker threads that a single
  3587. ** [prepared statement] may start.</dd>)^
  3588. ** </dl>
  3589. */
  3590. #define SQLITE_LIMIT_LENGTH 0
  3591. #define SQLITE_LIMIT_SQL_LENGTH 1
  3592. #define SQLITE_LIMIT_COLUMN 2
  3593. #define SQLITE_LIMIT_EXPR_DEPTH 3
  3594. #define SQLITE_LIMIT_COMPOUND_SELECT 4
  3595. #define SQLITE_LIMIT_VDBE_OP 5
  3596. #define SQLITE_LIMIT_FUNCTION_ARG 6
  3597. #define SQLITE_LIMIT_ATTACHED 7
  3598. #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
  3599. #define SQLITE_LIMIT_VARIABLE_NUMBER 9
  3600. #define SQLITE_LIMIT_TRIGGER_DEPTH 10
  3601. #define SQLITE_LIMIT_WORKER_THREADS 11
  3602. /*
  3603. ** CAPI3REF: Compiling An SQL Statement
  3604. ** KEYWORDS: {SQL statement compiler}
  3605. ** METHOD: sqlite3
  3606. ** CONSTRUCTOR: sqlite3_stmt
  3607. **
  3608. ** To execute an SQL query, it must first be compiled into a byte-code
  3609. ** program using one of these routines.
  3610. **
  3611. ** The first argument, "db", is a [database connection] obtained from a
  3612. ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
  3613. ** [sqlite3_open16()]. The database connection must not have been closed.
  3614. **
  3615. ** The second argument, "zSql", is the statement to be compiled, encoded
  3616. ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
  3617. ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
  3618. ** use UTF-16.
  3619. **
  3620. ** ^If the nByte argument is negative, then zSql is read up to the
  3621. ** first zero terminator. ^If nByte is positive, then it is the
  3622. ** number of bytes read from zSql. ^If nByte is zero, then no prepared
  3623. ** statement is generated.
  3624. ** If the caller knows that the supplied string is nul-terminated, then
  3625. ** there is a small performance advantage to passing an nByte parameter that
  3626. ** is the number of bytes in the input string <i>including</i>
  3627. ** the nul-terminator.
  3628. **
  3629. ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
  3630. ** past the end of the first SQL statement in zSql. These routines only
  3631. ** compile the first statement in zSql, so *pzTail is left pointing to
  3632. ** what remains uncompiled.
  3633. **
  3634. ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
  3635. ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
  3636. ** to NULL. ^If the input text contains no SQL (if the input is an empty
  3637. ** string or a comment) then *ppStmt is set to NULL.
  3638. ** The calling procedure is responsible for deleting the compiled
  3639. ** SQL statement using [sqlite3_finalize()] after it has finished with it.
  3640. ** ppStmt may not be NULL.
  3641. **
  3642. ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
  3643. ** otherwise an [error code] is returned.
  3644. **
  3645. ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
  3646. ** recommended for all new programs. The two older interfaces are retained
  3647. ** for backwards compatibility, but their use is discouraged.
  3648. ** ^In the "v2" interfaces, the prepared statement
  3649. ** that is returned (the [sqlite3_stmt] object) contains a copy of the
  3650. ** original SQL text. This causes the [sqlite3_step()] interface to
  3651. ** behave differently in three ways:
  3652. **
  3653. ** <ol>
  3654. ** <li>
  3655. ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
  3656. ** always used to do, [sqlite3_step()] will automatically recompile the SQL
  3657. ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
  3658. ** retries will occur before sqlite3_step() gives up and returns an error.
  3659. ** </li>
  3660. **
  3661. ** <li>
  3662. ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
  3663. ** [error codes] or [extended error codes]. ^The legacy behavior was that
  3664. ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
  3665. ** and the application would have to make a second call to [sqlite3_reset()]
  3666. ** in order to find the underlying cause of the problem. With the "v2" prepare
  3667. ** interfaces, the underlying reason for the error is returned immediately.
  3668. ** </li>
  3669. **
  3670. ** <li>
  3671. ** ^If the specific value bound to [parameter | host parameter] in the
  3672. ** WHERE clause might influence the choice of query plan for a statement,
  3673. ** then the statement will be automatically recompiled, as if there had been
  3674. ** a schema change, on the first [sqlite3_step()] call following any change
  3675. ** to the [sqlite3_bind_text | bindings] of that [parameter].
  3676. ** ^The specific value of WHERE-clause [parameter] might influence the
  3677. ** choice of query plan if the parameter is the left-hand side of a [LIKE]
  3678. ** or [GLOB] operator or if the parameter is compared to an indexed column
  3679. ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
  3680. ** </li>
  3681. ** </ol>
  3682. */
  3683. SQLITE_API int sqlite3_prepare(
  3684. sqlite3 *db, /* Database handle */
  3685. const char *zSql, /* SQL statement, UTF-8 encoded */
  3686. int nByte, /* Maximum length of zSql in bytes. */
  3687. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  3688. const char **pzTail /* OUT: Pointer to unused portion of zSql */
  3689. );
  3690. SQLITE_API int sqlite3_prepare_v2(
  3691. sqlite3 *db, /* Database handle */
  3692. const char *zSql, /* SQL statement, UTF-8 encoded */
  3693. int nByte, /* Maximum length of zSql in bytes. */
  3694. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  3695. const char **pzTail /* OUT: Pointer to unused portion of zSql */
  3696. );
  3697. SQLITE_API int sqlite3_prepare16(
  3698. sqlite3 *db, /* Database handle */
  3699. const void *zSql, /* SQL statement, UTF-16 encoded */
  3700. int nByte, /* Maximum length of zSql in bytes. */
  3701. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  3702. const void **pzTail /* OUT: Pointer to unused portion of zSql */
  3703. );
  3704. SQLITE_API int sqlite3_prepare16_v2(
  3705. sqlite3 *db, /* Database handle */
  3706. const void *zSql, /* SQL statement, UTF-16 encoded */
  3707. int nByte, /* Maximum length of zSql in bytes. */
  3708. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  3709. const void **pzTail /* OUT: Pointer to unused portion of zSql */
  3710. );
  3711. /*
  3712. ** CAPI3REF: Retrieving Statement SQL
  3713. ** METHOD: sqlite3_stmt
  3714. **
  3715. ** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
  3716. ** SQL text used to create [prepared statement] P if P was
  3717. ** created by either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
  3718. ** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
  3719. ** string containing the SQL text of prepared statement P with
  3720. ** [bound parameters] expanded.
  3721. **
  3722. ** ^(For example, if a prepared statement is created using the SQL
  3723. ** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
  3724. ** and parameter :xyz is unbound, then sqlite3_sql() will return
  3725. ** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
  3726. ** will return "SELECT 2345,NULL".)^
  3727. **
  3728. ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
  3729. ** is available to hold the result, or if the result would exceed the
  3730. ** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
  3731. **
  3732. ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
  3733. ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
  3734. ** option causes sqlite3_expanded_sql() to always return NULL.
  3735. **
  3736. ** ^The string returned by sqlite3_sql(P) is managed by SQLite and is
  3737. ** automatically freed when the prepared statement is finalized.
  3738. ** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
  3739. ** is obtained from [sqlite3_malloc()] and must be free by the application
  3740. ** by passing it to [sqlite3_free()].
  3741. */
  3742. SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
  3743. SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
  3744. /*
  3745. ** CAPI3REF: Determine If An SQL Statement Writes The Database
  3746. ** METHOD: sqlite3_stmt
  3747. **
  3748. ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
  3749. ** and only if the [prepared statement] X makes no direct changes to
  3750. ** the content of the database file.
  3751. **
  3752. ** Note that [application-defined SQL functions] or
  3753. ** [virtual tables] might change the database indirectly as a side effect.
  3754. ** ^(For example, if an application defines a function "eval()" that
  3755. ** calls [sqlite3_exec()], then the following SQL statement would
  3756. ** change the database file through side-effects:
  3757. **
  3758. ** <blockquote><pre>
  3759. ** SELECT eval('DELETE FROM t1') FROM t2;
  3760. ** </pre></blockquote>
  3761. **
  3762. ** But because the [SELECT] statement does not change the database file
  3763. ** directly, sqlite3_stmt_readonly() would still return true.)^
  3764. **
  3765. ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
  3766. ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
  3767. ** since the statements themselves do not actually modify the database but
  3768. ** rather they control the timing of when other statements modify the
  3769. ** database. ^The [ATTACH] and [DETACH] statements also cause
  3770. ** sqlite3_stmt_readonly() to return true since, while those statements
  3771. ** change the configuration of a database connection, they do not make
  3772. ** changes to the content of the database files on disk.
  3773. */
  3774. SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
  3775. /*
  3776. ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
  3777. ** METHOD: sqlite3_stmt
  3778. **
  3779. ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
  3780. ** [prepared statement] S has been stepped at least once using
  3781. ** [sqlite3_step(S)] but has neither run to completion (returned
  3782. ** [SQLITE_DONE] from [sqlite3_step(S)]) nor
  3783. ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
  3784. ** interface returns false if S is a NULL pointer. If S is not a
  3785. ** NULL pointer and is not a pointer to a valid [prepared statement]
  3786. ** object, then the behavior is undefined and probably undesirable.
  3787. **
  3788. ** This interface can be used in combination [sqlite3_next_stmt()]
  3789. ** to locate all prepared statements associated with a database
  3790. ** connection that are in need of being reset. This can be used,
  3791. ** for example, in diagnostic routines to search for prepared
  3792. ** statements that are holding a transaction open.
  3793. */
  3794. SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
  3795. /*
  3796. ** CAPI3REF: Dynamically Typed Value Object
  3797. ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
  3798. **
  3799. ** SQLite uses the sqlite3_value object to represent all values
  3800. ** that can be stored in a database table. SQLite uses dynamic typing
  3801. ** for the values it stores. ^Values stored in sqlite3_value objects
  3802. ** can be integers, floating point values, strings, BLOBs, or NULL.
  3803. **
  3804. ** An sqlite3_value object may be either "protected" or "unprotected".
  3805. ** Some interfaces require a protected sqlite3_value. Other interfaces
  3806. ** will accept either a protected or an unprotected sqlite3_value.
  3807. ** Every interface that accepts sqlite3_value arguments specifies
  3808. ** whether or not it requires a protected sqlite3_value. The
  3809. ** [sqlite3_value_dup()] interface can be used to construct a new
  3810. ** protected sqlite3_value from an unprotected sqlite3_value.
  3811. **
  3812. ** The terms "protected" and "unprotected" refer to whether or not
  3813. ** a mutex is held. An internal mutex is held for a protected
  3814. ** sqlite3_value object but no mutex is held for an unprotected
  3815. ** sqlite3_value object. If SQLite is compiled to be single-threaded
  3816. ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
  3817. ** or if SQLite is run in one of reduced mutex modes
  3818. ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
  3819. ** then there is no distinction between protected and unprotected
  3820. ** sqlite3_value objects and they can be used interchangeably. However,
  3821. ** for maximum code portability it is recommended that applications
  3822. ** still make the distinction between protected and unprotected
  3823. ** sqlite3_value objects even when not strictly required.
  3824. **
  3825. ** ^The sqlite3_value objects that are passed as parameters into the
  3826. ** implementation of [application-defined SQL functions] are protected.
  3827. ** ^The sqlite3_value object returned by
  3828. ** [sqlite3_column_value()] is unprotected.
  3829. ** Unprotected sqlite3_value objects may only be used with
  3830. ** [sqlite3_result_value()] and [sqlite3_bind_value()].
  3831. ** The [sqlite3_value_blob | sqlite3_value_type()] family of
  3832. ** interfaces require protected sqlite3_value objects.
  3833. */
  3834. typedef struct Mem sqlite3_value;
  3835. /*
  3836. ** CAPI3REF: SQL Function Context Object
  3837. **
  3838. ** The context in which an SQL function executes is stored in an
  3839. ** sqlite3_context object. ^A pointer to an sqlite3_context object
  3840. ** is always first parameter to [application-defined SQL functions].
  3841. ** The application-defined SQL function implementation will pass this
  3842. ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
  3843. ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
  3844. ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
  3845. ** and/or [sqlite3_set_auxdata()].
  3846. */
  3847. typedef struct sqlite3_context sqlite3_context;
  3848. /*
  3849. ** CAPI3REF: Binding Values To Prepared Statements
  3850. ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
  3851. ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
  3852. ** METHOD: sqlite3_stmt
  3853. **
  3854. ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
  3855. ** literals may be replaced by a [parameter] that matches one of following
  3856. ** templates:
  3857. **
  3858. ** <ul>
  3859. ** <li> ?
  3860. ** <li> ?NNN
  3861. ** <li> :VVV
  3862. ** <li> @VVV
  3863. ** <li> $VVV
  3864. ** </ul>
  3865. **
  3866. ** In the templates above, NNN represents an integer literal,
  3867. ** and VVV represents an alphanumeric identifier.)^ ^The values of these
  3868. ** parameters (also called "host parameter names" or "SQL parameters")
  3869. ** can be set using the sqlite3_bind_*() routines defined here.
  3870. **
  3871. ** ^The first argument to the sqlite3_bind_*() routines is always
  3872. ** a pointer to the [sqlite3_stmt] object returned from
  3873. ** [sqlite3_prepare_v2()] or its variants.
  3874. **
  3875. ** ^The second argument is the index of the SQL parameter to be set.
  3876. ** ^The leftmost SQL parameter has an index of 1. ^When the same named
  3877. ** SQL parameter is used more than once, second and subsequent
  3878. ** occurrences have the same index as the first occurrence.
  3879. ** ^The index for named parameters can be looked up using the
  3880. ** [sqlite3_bind_parameter_index()] API if desired. ^The index
  3881. ** for "?NNN" parameters is the value of NNN.
  3882. ** ^The NNN value must be between 1 and the [sqlite3_limit()]
  3883. ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
  3884. **
  3885. ** ^The third argument is the value to bind to the parameter.
  3886. ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
  3887. ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
  3888. ** is ignored and the end result is the same as sqlite3_bind_null().
  3889. **
  3890. ** ^(In those routines that have a fourth argument, its value is the
  3891. ** number of bytes in the parameter. To be clear: the value is the
  3892. ** number of <u>bytes</u> in the value, not the number of characters.)^
  3893. ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
  3894. ** is negative, then the length of the string is
  3895. ** the number of bytes up to the first zero terminator.
  3896. ** If the fourth parameter to sqlite3_bind_blob() is negative, then
  3897. ** the behavior is undefined.
  3898. ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
  3899. ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
  3900. ** that parameter must be the byte offset
  3901. ** where the NUL terminator would occur assuming the string were NUL
  3902. ** terminated. If any NUL characters occur at byte offsets less than
  3903. ** the value of the fourth parameter then the resulting string value will
  3904. ** contain embedded NULs. The result of expressions involving strings
  3905. ** with embedded NULs is undefined.
  3906. **
  3907. ** ^The fifth argument to the BLOB and string binding interfaces
  3908. ** is a destructor used to dispose of the BLOB or
  3909. ** string after SQLite has finished with it. ^The destructor is called
  3910. ** to dispose of the BLOB or string even if the call to bind API fails.
  3911. ** ^If the fifth argument is
  3912. ** the special value [SQLITE_STATIC], then SQLite assumes that the
  3913. ** information is in static, unmanaged space and does not need to be freed.
  3914. ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
  3915. ** SQLite makes its own private copy of the data immediately, before
  3916. ** the sqlite3_bind_*() routine returns.
  3917. **
  3918. ** ^The sixth argument to sqlite3_bind_text64() must be one of
  3919. ** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
  3920. ** to specify the encoding of the text in the third parameter. If
  3921. ** the sixth argument to sqlite3_bind_text64() is not one of the
  3922. ** allowed values shown above, or if the text encoding is different
  3923. ** from the encoding specified by the sixth parameter, then the behavior
  3924. ** is undefined.
  3925. **
  3926. ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
  3927. ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
  3928. ** (just an integer to hold its size) while it is being processed.
  3929. ** Zeroblobs are intended to serve as placeholders for BLOBs whose
  3930. ** content is later written using
  3931. ** [sqlite3_blob_open | incremental BLOB I/O] routines.
  3932. ** ^A negative value for the zeroblob results in a zero-length BLOB.
  3933. **
  3934. ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
  3935. ** for the [prepared statement] or with a prepared statement for which
  3936. ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
  3937. ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
  3938. ** routine is passed a [prepared statement] that has been finalized, the
  3939. ** result is undefined and probably harmful.
  3940. **
  3941. ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
  3942. ** ^Unbound parameters are interpreted as NULL.
  3943. **
  3944. ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
  3945. ** [error code] if anything goes wrong.
  3946. ** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
  3947. ** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
  3948. ** [SQLITE_MAX_LENGTH].
  3949. ** ^[SQLITE_RANGE] is returned if the parameter
  3950. ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
  3951. **
  3952. ** See also: [sqlite3_bind_parameter_count()],
  3953. ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
  3954. */
  3955. SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
  3956. SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
  3957. void(*)(void*));
  3958. SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
  3959. SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
  3960. SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
  3961. SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
  3962. SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
  3963. SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
  3964. SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
  3965. void(*)(void*), unsigned char encoding);
  3966. SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
  3967. SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
  3968. SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
  3969. /*
  3970. ** CAPI3REF: Number Of SQL Parameters
  3971. ** METHOD: sqlite3_stmt
  3972. **
  3973. ** ^This routine can be used to find the number of [SQL parameters]
  3974. ** in a [prepared statement]. SQL parameters are tokens of the
  3975. ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
  3976. ** placeholders for values that are [sqlite3_bind_blob | bound]
  3977. ** to the parameters at a later time.
  3978. **
  3979. ** ^(This routine actually returns the index of the largest (rightmost)
  3980. ** parameter. For all forms except ?NNN, this will correspond to the
  3981. ** number of unique parameters. If parameters of the ?NNN form are used,
  3982. ** there may be gaps in the list.)^
  3983. **
  3984. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  3985. ** [sqlite3_bind_parameter_name()], and
  3986. ** [sqlite3_bind_parameter_index()].
  3987. */
  3988. SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
  3989. /*
  3990. ** CAPI3REF: Name Of A Host Parameter
  3991. ** METHOD: sqlite3_stmt
  3992. **
  3993. ** ^The sqlite3_bind_parameter_name(P,N) interface returns
  3994. ** the name of the N-th [SQL parameter] in the [prepared statement] P.
  3995. ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
  3996. ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
  3997. ** respectively.
  3998. ** In other words, the initial ":" or "$" or "@" or "?"
  3999. ** is included as part of the name.)^
  4000. ** ^Parameters of the form "?" without a following integer have no name
  4001. ** and are referred to as "nameless" or "anonymous parameters".
  4002. **
  4003. ** ^The first host parameter has an index of 1, not 0.
  4004. **
  4005. ** ^If the value N is out of range or if the N-th parameter is
  4006. ** nameless, then NULL is returned. ^The returned string is
  4007. ** always in UTF-8 encoding even if the named parameter was
  4008. ** originally specified as UTF-16 in [sqlite3_prepare16()] or
  4009. ** [sqlite3_prepare16_v2()].
  4010. **
  4011. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  4012. ** [sqlite3_bind_parameter_count()], and
  4013. ** [sqlite3_bind_parameter_index()].
  4014. */
  4015. SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
  4016. /*
  4017. ** CAPI3REF: Index Of A Parameter With A Given Name
  4018. ** METHOD: sqlite3_stmt
  4019. **
  4020. ** ^Return the index of an SQL parameter given its name. ^The
  4021. ** index value returned is suitable for use as the second
  4022. ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
  4023. ** is returned if no matching parameter is found. ^The parameter
  4024. ** name must be given in UTF-8 even if the original statement
  4025. ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
  4026. **
  4027. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  4028. ** [sqlite3_bind_parameter_count()], and
  4029. ** [sqlite3_bind_parameter_name()].
  4030. */
  4031. SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
  4032. /*
  4033. ** CAPI3REF: Reset All Bindings On A Prepared Statement
  4034. ** METHOD: sqlite3_stmt
  4035. **
  4036. ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
  4037. ** the [sqlite3_bind_blob | bindings] on a [prepared statement].
  4038. ** ^Use this routine to reset all host parameters to NULL.
  4039. */
  4040. SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
  4041. /*
  4042. ** CAPI3REF: Number Of Columns In A Result Set
  4043. ** METHOD: sqlite3_stmt
  4044. **
  4045. ** ^Return the number of columns in the result set returned by the
  4046. ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
  4047. ** statement that does not return data (for example an [UPDATE]).
  4048. **
  4049. ** See also: [sqlite3_data_count()]
  4050. */
  4051. SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
  4052. /*
  4053. ** CAPI3REF: Column Names In A Result Set
  4054. ** METHOD: sqlite3_stmt
  4055. **
  4056. ** ^These routines return the name assigned to a particular column
  4057. ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
  4058. ** interface returns a pointer to a zero-terminated UTF-8 string
  4059. ** and sqlite3_column_name16() returns a pointer to a zero-terminated
  4060. ** UTF-16 string. ^The first parameter is the [prepared statement]
  4061. ** that implements the [SELECT] statement. ^The second parameter is the
  4062. ** column number. ^The leftmost column is number 0.
  4063. **
  4064. ** ^The returned string pointer is valid until either the [prepared statement]
  4065. ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
  4066. ** reprepared by the first call to [sqlite3_step()] for a particular run
  4067. ** or until the next call to
  4068. ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
  4069. **
  4070. ** ^If sqlite3_malloc() fails during the processing of either routine
  4071. ** (for example during a conversion from UTF-8 to UTF-16) then a
  4072. ** NULL pointer is returned.
  4073. **
  4074. ** ^The name of a result column is the value of the "AS" clause for
  4075. ** that column, if there is an AS clause. If there is no AS clause
  4076. ** then the name of the column is unspecified and may change from
  4077. ** one release of SQLite to the next.
  4078. */
  4079. SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
  4080. SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
  4081. /*
  4082. ** CAPI3REF: Source Of Data In A Query Result
  4083. ** METHOD: sqlite3_stmt
  4084. **
  4085. ** ^These routines provide a means to determine the database, table, and
  4086. ** table column that is the origin of a particular result column in
  4087. ** [SELECT] statement.
  4088. ** ^The name of the database or table or column can be returned as
  4089. ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
  4090. ** the database name, the _table_ routines return the table name, and
  4091. ** the origin_ routines return the column name.
  4092. ** ^The returned string is valid until the [prepared statement] is destroyed
  4093. ** using [sqlite3_finalize()] or until the statement is automatically
  4094. ** reprepared by the first call to [sqlite3_step()] for a particular run
  4095. ** or until the same information is requested
  4096. ** again in a different encoding.
  4097. **
  4098. ** ^The names returned are the original un-aliased names of the
  4099. ** database, table, and column.
  4100. **
  4101. ** ^The first argument to these interfaces is a [prepared statement].
  4102. ** ^These functions return information about the Nth result column returned by
  4103. ** the statement, where N is the second function argument.
  4104. ** ^The left-most column is column 0 for these routines.
  4105. **
  4106. ** ^If the Nth column returned by the statement is an expression or
  4107. ** subquery and is not a column value, then all of these functions return
  4108. ** NULL. ^These routine might also return NULL if a memory allocation error
  4109. ** occurs. ^Otherwise, they return the name of the attached database, table,
  4110. ** or column that query result column was extracted from.
  4111. **
  4112. ** ^As with all other SQLite APIs, those whose names end with "16" return
  4113. ** UTF-16 encoded strings and the other functions return UTF-8.
  4114. **
  4115. ** ^These APIs are only available if the library was compiled with the
  4116. ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
  4117. **
  4118. ** If two or more threads call one or more of these routines against the same
  4119. ** prepared statement and column at the same time then the results are
  4120. ** undefined.
  4121. **
  4122. ** If two or more threads call one or more
  4123. ** [sqlite3_column_database_name | column metadata interfaces]
  4124. ** for the same [prepared statement] and result column
  4125. ** at the same time then the results are undefined.
  4126. */
  4127. SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
  4128. SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
  4129. SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
  4130. SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
  4131. SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
  4132. SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
  4133. /*
  4134. ** CAPI3REF: Declared Datatype Of A Query Result
  4135. ** METHOD: sqlite3_stmt
  4136. **
  4137. ** ^(The first parameter is a [prepared statement].
  4138. ** If this statement is a [SELECT] statement and the Nth column of the
  4139. ** returned result set of that [SELECT] is a table column (not an
  4140. ** expression or subquery) then the declared type of the table
  4141. ** column is returned.)^ ^If the Nth column of the result set is an
  4142. ** expression or subquery, then a NULL pointer is returned.
  4143. ** ^The returned string is always UTF-8 encoded.
  4144. **
  4145. ** ^(For example, given the database schema:
  4146. **
  4147. ** CREATE TABLE t1(c1 VARIANT);
  4148. **
  4149. ** and the following statement to be compiled:
  4150. **
  4151. ** SELECT c1 + 1, c1 FROM t1;
  4152. **
  4153. ** this routine would return the string "VARIANT" for the second result
  4154. ** column (i==1), and a NULL pointer for the first result column (i==0).)^
  4155. **
  4156. ** ^SQLite uses dynamic run-time typing. ^So just because a column
  4157. ** is declared to contain a particular type does not mean that the
  4158. ** data stored in that column is of the declared type. SQLite is
  4159. ** strongly typed, but the typing is dynamic not static. ^Type
  4160. ** is associated with individual values, not with the containers
  4161. ** used to hold those values.
  4162. */
  4163. SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
  4164. SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
  4165. /*
  4166. ** CAPI3REF: Evaluate An SQL Statement
  4167. ** METHOD: sqlite3_stmt
  4168. **
  4169. ** After a [prepared statement] has been prepared using either
  4170. ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
  4171. ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
  4172. ** must be called one or more times to evaluate the statement.
  4173. **
  4174. ** The details of the behavior of the sqlite3_step() interface depend
  4175. ** on whether the statement was prepared using the newer "v2" interface
  4176. ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
  4177. ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
  4178. ** new "v2" interface is recommended for new applications but the legacy
  4179. ** interface will continue to be supported.
  4180. **
  4181. ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
  4182. ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
  4183. ** ^With the "v2" interface, any of the other [result codes] or
  4184. ** [extended result codes] might be returned as well.
  4185. **
  4186. ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
  4187. ** database locks it needs to do its job. ^If the statement is a [COMMIT]
  4188. ** or occurs outside of an explicit transaction, then you can retry the
  4189. ** statement. If the statement is not a [COMMIT] and occurs within an
  4190. ** explicit transaction then you should rollback the transaction before
  4191. ** continuing.
  4192. **
  4193. ** ^[SQLITE_DONE] means that the statement has finished executing
  4194. ** successfully. sqlite3_step() should not be called again on this virtual
  4195. ** machine without first calling [sqlite3_reset()] to reset the virtual
  4196. ** machine back to its initial state.
  4197. **
  4198. ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
  4199. ** is returned each time a new row of data is ready for processing by the
  4200. ** caller. The values may be accessed using the [column access functions].
  4201. ** sqlite3_step() is called again to retrieve the next row of data.
  4202. **
  4203. ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
  4204. ** violation) has occurred. sqlite3_step() should not be called again on
  4205. ** the VM. More information may be found by calling [sqlite3_errmsg()].
  4206. ** ^With the legacy interface, a more specific error code (for example,
  4207. ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
  4208. ** can be obtained by calling [sqlite3_reset()] on the
  4209. ** [prepared statement]. ^In the "v2" interface,
  4210. ** the more specific error code is returned directly by sqlite3_step().
  4211. **
  4212. ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
  4213. ** Perhaps it was called on a [prepared statement] that has
  4214. ** already been [sqlite3_finalize | finalized] or on one that had
  4215. ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
  4216. ** be the case that the same database connection is being used by two or
  4217. ** more threads at the same moment in time.
  4218. **
  4219. ** For all versions of SQLite up to and including 3.6.23.1, a call to
  4220. ** [sqlite3_reset()] was required after sqlite3_step() returned anything
  4221. ** other than [SQLITE_ROW] before any subsequent invocation of
  4222. ** sqlite3_step(). Failure to reset the prepared statement using
  4223. ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
  4224. ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],
  4225. ** sqlite3_step() began
  4226. ** calling [sqlite3_reset()] automatically in this circumstance rather
  4227. ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
  4228. ** break because any application that ever receives an SQLITE_MISUSE error
  4229. ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
  4230. ** can be used to restore the legacy behavior.
  4231. **
  4232. ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
  4233. ** API always returns a generic error code, [SQLITE_ERROR], following any
  4234. ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
  4235. ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
  4236. ** specific [error codes] that better describes the error.
  4237. ** We admit that this is a goofy design. The problem has been fixed
  4238. ** with the "v2" interface. If you prepare all of your SQL statements
  4239. ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
  4240. ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
  4241. ** then the more specific [error codes] are returned directly
  4242. ** by sqlite3_step(). The use of the "v2" interface is recommended.
  4243. */
  4244. SQLITE_API int sqlite3_step(sqlite3_stmt*);
  4245. /*
  4246. ** CAPI3REF: Number of columns in a result set
  4247. ** METHOD: sqlite3_stmt
  4248. **
  4249. ** ^The sqlite3_data_count(P) interface returns the number of columns in the
  4250. ** current row of the result set of [prepared statement] P.
  4251. ** ^If prepared statement P does not have results ready to return
  4252. ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
  4253. ** interfaces) then sqlite3_data_count(P) returns 0.
  4254. ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
  4255. ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
  4256. ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
  4257. ** will return non-zero if previous call to [sqlite3_step](P) returned
  4258. ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
  4259. ** where it always returns zero since each step of that multi-step
  4260. ** pragma returns 0 columns of data.
  4261. **
  4262. ** See also: [sqlite3_column_count()]
  4263. */
  4264. SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
  4265. /*
  4266. ** CAPI3REF: Fundamental Datatypes
  4267. ** KEYWORDS: SQLITE_TEXT
  4268. **
  4269. ** ^(Every value in SQLite has one of five fundamental datatypes:
  4270. **
  4271. ** <ul>
  4272. ** <li> 64-bit signed integer
  4273. ** <li> 64-bit IEEE floating point number
  4274. ** <li> string
  4275. ** <li> BLOB
  4276. ** <li> NULL
  4277. ** </ul>)^
  4278. **
  4279. ** These constants are codes for each of those types.
  4280. **
  4281. ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
  4282. ** for a completely different meaning. Software that links against both
  4283. ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
  4284. ** SQLITE_TEXT.
  4285. */
  4286. #define SQLITE_INTEGER 1
  4287. #define SQLITE_FLOAT 2
  4288. #define SQLITE_BLOB 4
  4289. #define SQLITE_NULL 5
  4290. #ifdef SQLITE_TEXT
  4291. # undef SQLITE_TEXT
  4292. #else
  4293. # define SQLITE_TEXT 3
  4294. #endif
  4295. #define SQLITE3_TEXT 3
  4296. /*
  4297. ** CAPI3REF: Result Values From A Query
  4298. ** KEYWORDS: {column access functions}
  4299. ** METHOD: sqlite3_stmt
  4300. **
  4301. ** ^These routines return information about a single column of the current
  4302. ** result row of a query. ^In every case the first argument is a pointer
  4303. ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
  4304. ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
  4305. ** and the second argument is the index of the column for which information
  4306. ** should be returned. ^The leftmost column of the result set has the index 0.
  4307. ** ^The number of columns in the result can be determined using
  4308. ** [sqlite3_column_count()].
  4309. **
  4310. ** If the SQL statement does not currently point to a valid row, or if the
  4311. ** column index is out of range, the result is undefined.
  4312. ** These routines may only be called when the most recent call to
  4313. ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
  4314. ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
  4315. ** If any of these routines are called after [sqlite3_reset()] or
  4316. ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
  4317. ** something other than [SQLITE_ROW], the results are undefined.
  4318. ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
  4319. ** are called from a different thread while any of these routines
  4320. ** are pending, then the results are undefined.
  4321. **
  4322. ** ^The sqlite3_column_type() routine returns the
  4323. ** [SQLITE_INTEGER | datatype code] for the initial data type
  4324. ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
  4325. ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
  4326. ** returned by sqlite3_column_type() is only meaningful if no type
  4327. ** conversions have occurred as described below. After a type conversion,
  4328. ** the value returned by sqlite3_column_type() is undefined. Future
  4329. ** versions of SQLite may change the behavior of sqlite3_column_type()
  4330. ** following a type conversion.
  4331. **
  4332. ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
  4333. ** routine returns the number of bytes in that BLOB or string.
  4334. ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
  4335. ** the string to UTF-8 and then returns the number of bytes.
  4336. ** ^If the result is a numeric value then sqlite3_column_bytes() uses
  4337. ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
  4338. ** the number of bytes in that string.
  4339. ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
  4340. **
  4341. ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
  4342. ** routine returns the number of bytes in that BLOB or string.
  4343. ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
  4344. ** the string to UTF-16 and then returns the number of bytes.
  4345. ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
  4346. ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
  4347. ** the number of bytes in that string.
  4348. ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
  4349. **
  4350. ** ^The values returned by [sqlite3_column_bytes()] and
  4351. ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
  4352. ** of the string. ^For clarity: the values returned by
  4353. ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
  4354. ** bytes in the string, not the number of characters.
  4355. **
  4356. ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
  4357. ** even empty strings, are always zero-terminated. ^The return
  4358. ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
  4359. **
  4360. ** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
  4361. ** [unprotected sqlite3_value] object. In a multithreaded environment,
  4362. ** an unprotected sqlite3_value object may only be used safely with
  4363. ** [sqlite3_bind_value()] and [sqlite3_result_value()].
  4364. ** If the [unprotected sqlite3_value] object returned by
  4365. ** [sqlite3_column_value()] is used in any other way, including calls
  4366. ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
  4367. ** or [sqlite3_value_bytes()], the behavior is not threadsafe.
  4368. **
  4369. ** These routines attempt to convert the value where appropriate. ^For
  4370. ** example, if the internal representation is FLOAT and a text result
  4371. ** is requested, [sqlite3_snprintf()] is used internally to perform the
  4372. ** conversion automatically. ^(The following table details the conversions
  4373. ** that are applied:
  4374. **
  4375. ** <blockquote>
  4376. ** <table border="1">
  4377. ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
  4378. **
  4379. ** <tr><td> NULL <td> INTEGER <td> Result is 0
  4380. ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
  4381. ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
  4382. ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
  4383. ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
  4384. ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
  4385. ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
  4386. ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
  4387. ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
  4388. ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
  4389. ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
  4390. ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
  4391. ** <tr><td> TEXT <td> BLOB <td> No change
  4392. ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
  4393. ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
  4394. ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
  4395. ** </table>
  4396. ** </blockquote>)^
  4397. **
  4398. ** Note that when type conversions occur, pointers returned by prior
  4399. ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
  4400. ** sqlite3_column_text16() may be invalidated.
  4401. ** Type conversions and pointer invalidations might occur
  4402. ** in the following cases:
  4403. **
  4404. ** <ul>
  4405. ** <li> The initial content is a BLOB and sqlite3_column_text() or
  4406. ** sqlite3_column_text16() is called. A zero-terminator might
  4407. ** need to be added to the string.</li>
  4408. ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
  4409. ** sqlite3_column_text16() is called. The content must be converted
  4410. ** to UTF-16.</li>
  4411. ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
  4412. ** sqlite3_column_text() is called. The content must be converted
  4413. ** to UTF-8.</li>
  4414. ** </ul>
  4415. **
  4416. ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
  4417. ** not invalidate a prior pointer, though of course the content of the buffer
  4418. ** that the prior pointer references will have been modified. Other kinds
  4419. ** of conversion are done in place when it is possible, but sometimes they
  4420. ** are not possible and in those cases prior pointers are invalidated.
  4421. **
  4422. ** The safest policy is to invoke these routines
  4423. ** in one of the following ways:
  4424. **
  4425. ** <ul>
  4426. ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
  4427. ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
  4428. ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
  4429. ** </ul>
  4430. **
  4431. ** In other words, you should call sqlite3_column_text(),
  4432. ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
  4433. ** into the desired format, then invoke sqlite3_column_bytes() or
  4434. ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
  4435. ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
  4436. ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
  4437. ** with calls to sqlite3_column_bytes().
  4438. **
  4439. ** ^The pointers returned are valid until a type conversion occurs as
  4440. ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
  4441. ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
  4442. ** and BLOBs is freed automatically. Do <em>not</em> pass the pointers returned
  4443. ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
  4444. ** [sqlite3_free()].
  4445. **
  4446. ** ^(If a memory allocation error occurs during the evaluation of any
  4447. ** of these routines, a default value is returned. The default value
  4448. ** is either the integer 0, the floating point number 0.0, or a NULL
  4449. ** pointer. Subsequent calls to [sqlite3_errcode()] will return
  4450. ** [SQLITE_NOMEM].)^
  4451. */
  4452. SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
  4453. SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
  4454. SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
  4455. SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
  4456. SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
  4457. SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
  4458. SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
  4459. SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
  4460. SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
  4461. SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
  4462. /*
  4463. ** CAPI3REF: Destroy A Prepared Statement Object
  4464. ** DESTRUCTOR: sqlite3_stmt
  4465. **
  4466. ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
  4467. ** ^If the most recent evaluation of the statement encountered no errors
  4468. ** or if the statement is never been evaluated, then sqlite3_finalize() returns
  4469. ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
  4470. ** sqlite3_finalize(S) returns the appropriate [error code] or
  4471. ** [extended error code].
  4472. **
  4473. ** ^The sqlite3_finalize(S) routine can be called at any point during
  4474. ** the life cycle of [prepared statement] S:
  4475. ** before statement S is ever evaluated, after
  4476. ** one or more calls to [sqlite3_reset()], or after any call
  4477. ** to [sqlite3_step()] regardless of whether or not the statement has
  4478. ** completed execution.
  4479. **
  4480. ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
  4481. **
  4482. ** The application must finalize every [prepared statement] in order to avoid
  4483. ** resource leaks. It is a grievous error for the application to try to use
  4484. ** a prepared statement after it has been finalized. Any use of a prepared
  4485. ** statement after it has been finalized can result in undefined and
  4486. ** undesirable behavior such as segfaults and heap corruption.
  4487. */
  4488. SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
  4489. /*
  4490. ** CAPI3REF: Reset A Prepared Statement Object
  4491. ** METHOD: sqlite3_stmt
  4492. **
  4493. ** The sqlite3_reset() function is called to reset a [prepared statement]
  4494. ** object back to its initial state, ready to be re-executed.
  4495. ** ^Any SQL statement variables that had values bound to them using
  4496. ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
  4497. ** Use [sqlite3_clear_bindings()] to reset the bindings.
  4498. **
  4499. ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
  4500. ** back to the beginning of its program.
  4501. **
  4502. ** ^If the most recent call to [sqlite3_step(S)] for the
  4503. ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
  4504. ** or if [sqlite3_step(S)] has never before been called on S,
  4505. ** then [sqlite3_reset(S)] returns [SQLITE_OK].
  4506. **
  4507. ** ^If the most recent call to [sqlite3_step(S)] for the
  4508. ** [prepared statement] S indicated an error, then
  4509. ** [sqlite3_reset(S)] returns an appropriate [error code].
  4510. **
  4511. ** ^The [sqlite3_reset(S)] interface does not change the values
  4512. ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
  4513. */
  4514. SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
  4515. /*
  4516. ** CAPI3REF: Create Or Redefine SQL Functions
  4517. ** KEYWORDS: {function creation routines}
  4518. ** KEYWORDS: {application-defined SQL function}
  4519. ** KEYWORDS: {application-defined SQL functions}
  4520. ** METHOD: sqlite3
  4521. **
  4522. ** ^These functions (collectively known as "function creation routines")
  4523. ** are used to add SQL functions or aggregates or to redefine the behavior
  4524. ** of existing SQL functions or aggregates. The only differences between
  4525. ** these routines are the text encoding expected for
  4526. ** the second parameter (the name of the function being created)
  4527. ** and the presence or absence of a destructor callback for
  4528. ** the application data pointer.
  4529. **
  4530. ** ^The first parameter is the [database connection] to which the SQL
  4531. ** function is to be added. ^If an application uses more than one database
  4532. ** connection then application-defined SQL functions must be added
  4533. ** to each database connection separately.
  4534. **
  4535. ** ^The second parameter is the name of the SQL function to be created or
  4536. ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
  4537. ** representation, exclusive of the zero-terminator. ^Note that the name
  4538. ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
  4539. ** ^Any attempt to create a function with a longer name
  4540. ** will result in [SQLITE_MISUSE] being returned.
  4541. **
  4542. ** ^The third parameter (nArg)
  4543. ** is the number of arguments that the SQL function or
  4544. ** aggregate takes. ^If this parameter is -1, then the SQL function or
  4545. ** aggregate may take any number of arguments between 0 and the limit
  4546. ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
  4547. ** parameter is less than -1 or greater than 127 then the behavior is
  4548. ** undefined.
  4549. **
  4550. ** ^The fourth parameter, eTextRep, specifies what
  4551. ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
  4552. ** its parameters. The application should set this parameter to
  4553. ** [SQLITE_UTF16LE] if the function implementation invokes
  4554. ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
  4555. ** implementation invokes [sqlite3_value_text16be()] on an input, or
  4556. ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
  4557. ** otherwise. ^The same SQL function may be registered multiple times using
  4558. ** different preferred text encodings, with different implementations for
  4559. ** each encoding.
  4560. ** ^When multiple implementations of the same function are available, SQLite
  4561. ** will pick the one that involves the least amount of data conversion.
  4562. **
  4563. ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
  4564. ** to signal that the function will always return the same result given
  4565. ** the same inputs within a single SQL statement. Most SQL functions are
  4566. ** deterministic. The built-in [random()] SQL function is an example of a
  4567. ** function that is not deterministic. The SQLite query planner is able to
  4568. ** perform additional optimizations on deterministic functions, so use
  4569. ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
  4570. **
  4571. ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
  4572. ** function can gain access to this pointer using [sqlite3_user_data()].)^
  4573. **
  4574. ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
  4575. ** pointers to C-language functions that implement the SQL function or
  4576. ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
  4577. ** callback only; NULL pointers must be passed as the xStep and xFinal
  4578. ** parameters. ^An aggregate SQL function requires an implementation of xStep
  4579. ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
  4580. ** SQL function or aggregate, pass NULL pointers for all three function
  4581. ** callbacks.
  4582. **
  4583. ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
  4584. ** then it is destructor for the application data pointer.
  4585. ** The destructor is invoked when the function is deleted, either by being
  4586. ** overloaded or when the database connection closes.)^
  4587. ** ^The destructor is also invoked if the call to
  4588. ** sqlite3_create_function_v2() fails.
  4589. ** ^When the destructor callback of the tenth parameter is invoked, it
  4590. ** is passed a single argument which is a copy of the application data
  4591. ** pointer which was the fifth parameter to sqlite3_create_function_v2().
  4592. **
  4593. ** ^It is permitted to register multiple implementations of the same
  4594. ** functions with the same name but with either differing numbers of
  4595. ** arguments or differing preferred text encodings. ^SQLite will use
  4596. ** the implementation that most closely matches the way in which the
  4597. ** SQL function is used. ^A function implementation with a non-negative
  4598. ** nArg parameter is a better match than a function implementation with
  4599. ** a negative nArg. ^A function where the preferred text encoding
  4600. ** matches the database encoding is a better
  4601. ** match than a function where the encoding is different.
  4602. ** ^A function where the encoding difference is between UTF16le and UTF16be
  4603. ** is a closer match than a function where the encoding difference is
  4604. ** between UTF8 and UTF16.
  4605. **
  4606. ** ^Built-in functions may be overloaded by new application-defined functions.
  4607. **
  4608. ** ^An application-defined function is permitted to call other
  4609. ** SQLite interfaces. However, such calls must not
  4610. ** close the database connection nor finalize or reset the prepared
  4611. ** statement in which the function is running.
  4612. */
  4613. SQLITE_API int sqlite3_create_function(
  4614. sqlite3 *db,
  4615. const char *zFunctionName,
  4616. int nArg,
  4617. int eTextRep,
  4618. void *pApp,
  4619. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  4620. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  4621. void (*xFinal)(sqlite3_context*)
  4622. );
  4623. SQLITE_API int sqlite3_create_function16(
  4624. sqlite3 *db,
  4625. const void *zFunctionName,
  4626. int nArg,
  4627. int eTextRep,
  4628. void *pApp,
  4629. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  4630. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  4631. void (*xFinal)(sqlite3_context*)
  4632. );
  4633. SQLITE_API int sqlite3_create_function_v2(
  4634. sqlite3 *db,
  4635. const char *zFunctionName,
  4636. int nArg,
  4637. int eTextRep,
  4638. void *pApp,
  4639. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  4640. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  4641. void (*xFinal)(sqlite3_context*),
  4642. void(*xDestroy)(void*)
  4643. );
  4644. /*
  4645. ** CAPI3REF: Text Encodings
  4646. **
  4647. ** These constant define integer codes that represent the various
  4648. ** text encodings supported by SQLite.
  4649. */
  4650. #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
  4651. #define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
  4652. #define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
  4653. #define SQLITE_UTF16 4 /* Use native byte order */
  4654. #define SQLITE_ANY 5 /* Deprecated */
  4655. #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
  4656. /*
  4657. ** CAPI3REF: Function Flags
  4658. **
  4659. ** These constants may be ORed together with the
  4660. ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
  4661. ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
  4662. ** [sqlite3_create_function_v2()].
  4663. */
  4664. #define SQLITE_DETERMINISTIC 0x800
  4665. /*
  4666. ** CAPI3REF: Deprecated Functions
  4667. ** DEPRECATED
  4668. **
  4669. ** These functions are [deprecated]. In order to maintain
  4670. ** backwards compatibility with older code, these functions continue
  4671. ** to be supported. However, new applications should avoid
  4672. ** the use of these functions. To encourage programmers to avoid
  4673. ** these functions, we will not explain what they do.
  4674. */
  4675. #ifndef SQLITE_OMIT_DEPRECATED
  4676. SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
  4677. SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
  4678. SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
  4679. SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
  4680. SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
  4681. SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
  4682. void*,sqlite3_int64);
  4683. #endif
  4684. /*
  4685. ** CAPI3REF: Obtaining SQL Values
  4686. ** METHOD: sqlite3_value
  4687. **
  4688. ** The C-language implementation of SQL functions and aggregates uses
  4689. ** this set of interface routines to access the parameter values on
  4690. ** the function or aggregate.
  4691. **
  4692. ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
  4693. ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
  4694. ** define callbacks that implement the SQL functions and aggregates.
  4695. ** The 3rd parameter to these callbacks is an array of pointers to
  4696. ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
  4697. ** each parameter to the SQL function. These routines are used to
  4698. ** extract values from the [sqlite3_value] objects.
  4699. **
  4700. ** These routines work only with [protected sqlite3_value] objects.
  4701. ** Any attempt to use these routines on an [unprotected sqlite3_value]
  4702. ** object results in undefined behavior.
  4703. **
  4704. ** ^These routines work just like the corresponding [column access functions]
  4705. ** except that these routines take a single [protected sqlite3_value] object
  4706. ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
  4707. **
  4708. ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
  4709. ** in the native byte-order of the host machine. ^The
  4710. ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
  4711. ** extract UTF-16 strings as big-endian and little-endian respectively.
  4712. **
  4713. ** ^(The sqlite3_value_numeric_type() interface attempts to apply
  4714. ** numeric affinity to the value. This means that an attempt is
  4715. ** made to convert the value to an integer or floating point. If
  4716. ** such a conversion is possible without loss of information (in other
  4717. ** words, if the value is a string that looks like a number)
  4718. ** then the conversion is performed. Otherwise no conversion occurs.
  4719. ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
  4720. **
  4721. ** Please pay particular attention to the fact that the pointer returned
  4722. ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
  4723. ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
  4724. ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
  4725. ** or [sqlite3_value_text16()].
  4726. **
  4727. ** These routines must be called from the same thread as
  4728. ** the SQL function that supplied the [sqlite3_value*] parameters.
  4729. */
  4730. SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
  4731. SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
  4732. SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
  4733. SQLITE_API double sqlite3_value_double(sqlite3_value*);
  4734. SQLITE_API int sqlite3_value_int(sqlite3_value*);
  4735. SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
  4736. SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
  4737. SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
  4738. SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
  4739. SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
  4740. SQLITE_API int sqlite3_value_type(sqlite3_value*);
  4741. SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
  4742. /*
  4743. ** CAPI3REF: Finding The Subtype Of SQL Values
  4744. ** METHOD: sqlite3_value
  4745. **
  4746. ** The sqlite3_value_subtype(V) function returns the subtype for
  4747. ** an [application-defined SQL function] argument V. The subtype
  4748. ** information can be used to pass a limited amount of context from
  4749. ** one SQL function to another. Use the [sqlite3_result_subtype()]
  4750. ** routine to set the subtype for the return value of an SQL function.
  4751. **
  4752. ** SQLite makes no use of subtype itself. It merely passes the subtype
  4753. ** from the result of one [application-defined SQL function] into the
  4754. ** input of another.
  4755. */
  4756. SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
  4757. /*
  4758. ** CAPI3REF: Copy And Free SQL Values
  4759. ** METHOD: sqlite3_value
  4760. **
  4761. ** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
  4762. ** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
  4763. ** is a [protected sqlite3_value] object even if the input is not.
  4764. ** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
  4765. ** memory allocation fails.
  4766. **
  4767. ** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
  4768. ** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
  4769. ** then sqlite3_value_free(V) is a harmless no-op.
  4770. */
  4771. SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);
  4772. SQLITE_API void sqlite3_value_free(sqlite3_value*);
  4773. /*
  4774. ** CAPI3REF: Obtain Aggregate Function Context
  4775. ** METHOD: sqlite3_context
  4776. **
  4777. ** Implementations of aggregate SQL functions use this
  4778. ** routine to allocate memory for storing their state.
  4779. **
  4780. ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
  4781. ** for a particular aggregate function, SQLite
  4782. ** allocates N of memory, zeroes out that memory, and returns a pointer
  4783. ** to the new memory. ^On second and subsequent calls to
  4784. ** sqlite3_aggregate_context() for the same aggregate function instance,
  4785. ** the same buffer is returned. Sqlite3_aggregate_context() is normally
  4786. ** called once for each invocation of the xStep callback and then one
  4787. ** last time when the xFinal callback is invoked. ^(When no rows match
  4788. ** an aggregate query, the xStep() callback of the aggregate function
  4789. ** implementation is never called and xFinal() is called exactly once.
  4790. ** In those cases, sqlite3_aggregate_context() might be called for the
  4791. ** first time from within xFinal().)^
  4792. **
  4793. ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
  4794. ** when first called if N is less than or equal to zero or if a memory
  4795. ** allocate error occurs.
  4796. **
  4797. ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
  4798. ** determined by the N parameter on first successful call. Changing the
  4799. ** value of N in subsequent call to sqlite3_aggregate_context() within
  4800. ** the same aggregate function instance will not resize the memory
  4801. ** allocation.)^ Within the xFinal callback, it is customary to set
  4802. ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
  4803. ** pointless memory allocations occur.
  4804. **
  4805. ** ^SQLite automatically frees the memory allocated by
  4806. ** sqlite3_aggregate_context() when the aggregate query concludes.
  4807. **
  4808. ** The first parameter must be a copy of the
  4809. ** [sqlite3_context | SQL function context] that is the first parameter
  4810. ** to the xStep or xFinal callback routine that implements the aggregate
  4811. ** function.
  4812. **
  4813. ** This routine must be called from the same thread in which
  4814. ** the aggregate SQL function is running.
  4815. */
  4816. SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
  4817. /*
  4818. ** CAPI3REF: User Data For Functions
  4819. ** METHOD: sqlite3_context
  4820. **
  4821. ** ^The sqlite3_user_data() interface returns a copy of
  4822. ** the pointer that was the pUserData parameter (the 5th parameter)
  4823. ** of the [sqlite3_create_function()]
  4824. ** and [sqlite3_create_function16()] routines that originally
  4825. ** registered the application defined function.
  4826. **
  4827. ** This routine must be called from the same thread in which
  4828. ** the application-defined function is running.
  4829. */
  4830. SQLITE_API void *sqlite3_user_data(sqlite3_context*);
  4831. /*
  4832. ** CAPI3REF: Database Connection For Functions
  4833. ** METHOD: sqlite3_context
  4834. **
  4835. ** ^The sqlite3_context_db_handle() interface returns a copy of
  4836. ** the pointer to the [database connection] (the 1st parameter)
  4837. ** of the [sqlite3_create_function()]
  4838. ** and [sqlite3_create_function16()] routines that originally
  4839. ** registered the application defined function.
  4840. */
  4841. SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
  4842. /*
  4843. ** CAPI3REF: Function Auxiliary Data
  4844. ** METHOD: sqlite3_context
  4845. **
  4846. ** These functions may be used by (non-aggregate) SQL functions to
  4847. ** associate metadata with argument values. If the same value is passed to
  4848. ** multiple invocations of the same SQL function during query execution, under
  4849. ** some circumstances the associated metadata may be preserved. An example
  4850. ** of where this might be useful is in a regular-expression matching
  4851. ** function. The compiled version of the regular expression can be stored as
  4852. ** metadata associated with the pattern string.
  4853. ** Then as long as the pattern string remains the same,
  4854. ** the compiled regular expression can be reused on multiple
  4855. ** invocations of the same function.
  4856. **
  4857. ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
  4858. ** associated by the sqlite3_set_auxdata() function with the Nth argument
  4859. ** value to the application-defined function. ^If there is no metadata
  4860. ** associated with the function argument, this sqlite3_get_auxdata() interface
  4861. ** returns a NULL pointer.
  4862. **
  4863. ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
  4864. ** argument of the application-defined function. ^Subsequent
  4865. ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
  4866. ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
  4867. ** NULL if the metadata has been discarded.
  4868. ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
  4869. ** SQLite will invoke the destructor function X with parameter P exactly
  4870. ** once, when the metadata is discarded.
  4871. ** SQLite is free to discard the metadata at any time, including: <ul>
  4872. ** <li> ^(when the corresponding function parameter changes)^, or
  4873. ** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
  4874. ** SQL statement)^, or
  4875. ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
  4876. ** parameter)^, or
  4877. ** <li> ^(during the original sqlite3_set_auxdata() call when a memory
  4878. ** allocation error occurs.)^ </ul>
  4879. **
  4880. ** Note the last bullet in particular. The destructor X in
  4881. ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
  4882. ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
  4883. ** should be called near the end of the function implementation and the
  4884. ** function implementation should not make any use of P after
  4885. ** sqlite3_set_auxdata() has been called.
  4886. **
  4887. ** ^(In practice, metadata is preserved between function calls for
  4888. ** function parameters that are compile-time constants, including literal
  4889. ** values and [parameters] and expressions composed from the same.)^
  4890. **
  4891. ** These routines must be called from the same thread in which
  4892. ** the SQL function is running.
  4893. */
  4894. SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
  4895. SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
  4896. /*
  4897. ** CAPI3REF: Constants Defining Special Destructor Behavior
  4898. **
  4899. ** These are special values for the destructor that is passed in as the
  4900. ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
  4901. ** argument is SQLITE_STATIC, it means that the content pointer is constant
  4902. ** and will never change. It does not need to be destroyed. ^The
  4903. ** SQLITE_TRANSIENT value means that the content will likely change in
  4904. ** the near future and that SQLite should make its own private copy of
  4905. ** the content before returning.
  4906. **
  4907. ** The typedef is necessary to work around problems in certain
  4908. ** C++ compilers.
  4909. */
  4910. typedef void (*sqlite3_destructor_type)(void*);
  4911. #define SQLITE_STATIC ((sqlite3_destructor_type)0)
  4912. #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
  4913. /*
  4914. ** CAPI3REF: Setting The Result Of An SQL Function
  4915. ** METHOD: sqlite3_context
  4916. **
  4917. ** These routines are used by the xFunc or xFinal callbacks that
  4918. ** implement SQL functions and aggregates. See
  4919. ** [sqlite3_create_function()] and [sqlite3_create_function16()]
  4920. ** for additional information.
  4921. **
  4922. ** These functions work very much like the [parameter binding] family of
  4923. ** functions used to bind values to host parameters in prepared statements.
  4924. ** Refer to the [SQL parameter] documentation for additional information.
  4925. **
  4926. ** ^The sqlite3_result_blob() interface sets the result from
  4927. ** an application-defined function to be the BLOB whose content is pointed
  4928. ** to by the second parameter and which is N bytes long where N is the
  4929. ** third parameter.
  4930. **
  4931. ** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
  4932. ** interfaces set the result of the application-defined function to be
  4933. ** a BLOB containing all zero bytes and N bytes in size.
  4934. **
  4935. ** ^The sqlite3_result_double() interface sets the result from
  4936. ** an application-defined function to be a floating point value specified
  4937. ** by its 2nd argument.
  4938. **
  4939. ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
  4940. ** cause the implemented SQL function to throw an exception.
  4941. ** ^SQLite uses the string pointed to by the
  4942. ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
  4943. ** as the text of an error message. ^SQLite interprets the error
  4944. ** message string from sqlite3_result_error() as UTF-8. ^SQLite
  4945. ** interprets the string from sqlite3_result_error16() as UTF-16 in native
  4946. ** byte order. ^If the third parameter to sqlite3_result_error()
  4947. ** or sqlite3_result_error16() is negative then SQLite takes as the error
  4948. ** message all text up through the first zero character.
  4949. ** ^If the third parameter to sqlite3_result_error() or
  4950. ** sqlite3_result_error16() is non-negative then SQLite takes that many
  4951. ** bytes (not characters) from the 2nd parameter as the error message.
  4952. ** ^The sqlite3_result_error() and sqlite3_result_error16()
  4953. ** routines make a private copy of the error message text before
  4954. ** they return. Hence, the calling function can deallocate or
  4955. ** modify the text after they return without harm.
  4956. ** ^The sqlite3_result_error_code() function changes the error code
  4957. ** returned by SQLite as a result of an error in a function. ^By default,
  4958. ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
  4959. ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
  4960. **
  4961. ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
  4962. ** error indicating that a string or BLOB is too long to represent.
  4963. **
  4964. ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
  4965. ** error indicating that a memory allocation failed.
  4966. **
  4967. ** ^The sqlite3_result_int() interface sets the return value
  4968. ** of the application-defined function to be the 32-bit signed integer
  4969. ** value given in the 2nd argument.
  4970. ** ^The sqlite3_result_int64() interface sets the return value
  4971. ** of the application-defined function to be the 64-bit signed integer
  4972. ** value given in the 2nd argument.
  4973. **
  4974. ** ^The sqlite3_result_null() interface sets the return value
  4975. ** of the application-defined function to be NULL.
  4976. **
  4977. ** ^The sqlite3_result_text(), sqlite3_result_text16(),
  4978. ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
  4979. ** set the return value of the application-defined function to be
  4980. ** a text string which is represented as UTF-8, UTF-16 native byte order,
  4981. ** UTF-16 little endian, or UTF-16 big endian, respectively.
  4982. ** ^The sqlite3_result_text64() interface sets the return value of an
  4983. ** application-defined function to be a text string in an encoding
  4984. ** specified by the fifth (and last) parameter, which must be one
  4985. ** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
  4986. ** ^SQLite takes the text result from the application from
  4987. ** the 2nd parameter of the sqlite3_result_text* interfaces.
  4988. ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
  4989. ** is negative, then SQLite takes result text from the 2nd parameter
  4990. ** through the first zero character.
  4991. ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
  4992. ** is non-negative, then as many bytes (not characters) of the text
  4993. ** pointed to by the 2nd parameter are taken as the application-defined
  4994. ** function result. If the 3rd parameter is non-negative, then it
  4995. ** must be the byte offset into the string where the NUL terminator would
  4996. ** appear if the string where NUL terminated. If any NUL characters occur
  4997. ** in the string at a byte offset that is less than the value of the 3rd
  4998. ** parameter, then the resulting string will contain embedded NULs and the
  4999. ** result of expressions operating on strings with embedded NULs is undefined.
  5000. ** ^If the 4th parameter to the sqlite3_result_text* interfaces
  5001. ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
  5002. ** function as the destructor on the text or BLOB result when it has
  5003. ** finished using that result.
  5004. ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
  5005. ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
  5006. ** assumes that the text or BLOB result is in constant space and does not
  5007. ** copy the content of the parameter nor call a destructor on the content
  5008. ** when it has finished using that result.
  5009. ** ^If the 4th parameter to the sqlite3_result_text* interfaces
  5010. ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
  5011. ** then SQLite makes a copy of the result into space obtained from
  5012. ** from [sqlite3_malloc()] before it returns.
  5013. **
  5014. ** ^The sqlite3_result_value() interface sets the result of
  5015. ** the application-defined function to be a copy of the
  5016. ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
  5017. ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
  5018. ** so that the [sqlite3_value] specified in the parameter may change or
  5019. ** be deallocated after sqlite3_result_value() returns without harm.
  5020. ** ^A [protected sqlite3_value] object may always be used where an
  5021. ** [unprotected sqlite3_value] object is required, so either
  5022. ** kind of [sqlite3_value] object can be used with this interface.
  5023. **
  5024. ** If these routines are called from within the different thread
  5025. ** than the one containing the application-defined function that received
  5026. ** the [sqlite3_context] pointer, the results are undefined.
  5027. */
  5028. SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
  5029. SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,
  5030. sqlite3_uint64,void(*)(void*));
  5031. SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
  5032. SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
  5033. SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
  5034. SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
  5035. SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
  5036. SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
  5037. SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
  5038. SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
  5039. SQLITE_API void sqlite3_result_null(sqlite3_context*);
  5040. SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
  5041. SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
  5042. void(*)(void*), unsigned char encoding);
  5043. SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
  5044. SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
  5045. SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
  5046. SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
  5047. SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
  5048. SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
  5049. /*
  5050. ** CAPI3REF: Setting The Subtype Of An SQL Function
  5051. ** METHOD: sqlite3_context
  5052. **
  5053. ** The sqlite3_result_subtype(C,T) function causes the subtype of
  5054. ** the result from the [application-defined SQL function] with
  5055. ** [sqlite3_context] C to be the value T. Only the lower 8 bits
  5056. ** of the subtype T are preserved in current versions of SQLite;
  5057. ** higher order bits are discarded.
  5058. ** The number of subtype bytes preserved by SQLite might increase
  5059. ** in future releases of SQLite.
  5060. */
  5061. SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
  5062. /*
  5063. ** CAPI3REF: Define New Collating Sequences
  5064. ** METHOD: sqlite3
  5065. **
  5066. ** ^These functions add, remove, or modify a [collation] associated
  5067. ** with the [database connection] specified as the first argument.
  5068. **
  5069. ** ^The name of the collation is a UTF-8 string
  5070. ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
  5071. ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
  5072. ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
  5073. ** considered to be the same name.
  5074. **
  5075. ** ^(The third argument (eTextRep) must be one of the constants:
  5076. ** <ul>
  5077. ** <li> [SQLITE_UTF8],
  5078. ** <li> [SQLITE_UTF16LE],
  5079. ** <li> [SQLITE_UTF16BE],
  5080. ** <li> [SQLITE_UTF16], or
  5081. ** <li> [SQLITE_UTF16_ALIGNED].
  5082. ** </ul>)^
  5083. ** ^The eTextRep argument determines the encoding of strings passed
  5084. ** to the collating function callback, xCallback.
  5085. ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
  5086. ** force strings to be UTF16 with native byte order.
  5087. ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
  5088. ** on an even byte address.
  5089. **
  5090. ** ^The fourth argument, pArg, is an application data pointer that is passed
  5091. ** through as the first argument to the collating function callback.
  5092. **
  5093. ** ^The fifth argument, xCallback, is a pointer to the collating function.
  5094. ** ^Multiple collating functions can be registered using the same name but
  5095. ** with different eTextRep parameters and SQLite will use whichever
  5096. ** function requires the least amount of data transformation.
  5097. ** ^If the xCallback argument is NULL then the collating function is
  5098. ** deleted. ^When all collating functions having the same name are deleted,
  5099. ** that collation is no longer usable.
  5100. **
  5101. ** ^The collating function callback is invoked with a copy of the pArg
  5102. ** application data pointer and with two strings in the encoding specified
  5103. ** by the eTextRep argument. The collating function must return an
  5104. ** integer that is negative, zero, or positive
  5105. ** if the first string is less than, equal to, or greater than the second,
  5106. ** respectively. A collating function must always return the same answer
  5107. ** given the same inputs. If two or more collating functions are registered
  5108. ** to the same collation name (using different eTextRep values) then all
  5109. ** must give an equivalent answer when invoked with equivalent strings.
  5110. ** The collating function must obey the following properties for all
  5111. ** strings A, B, and C:
  5112. **
  5113. ** <ol>
  5114. ** <li> If A==B then B==A.
  5115. ** <li> If A==B and B==C then A==C.
  5116. ** <li> If A&lt;B THEN B&gt;A.
  5117. ** <li> If A&lt;B and B&lt;C then A&lt;C.
  5118. ** </ol>
  5119. **
  5120. ** If a collating function fails any of the above constraints and that
  5121. ** collating function is registered and used, then the behavior of SQLite
  5122. ** is undefined.
  5123. **
  5124. ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
  5125. ** with the addition that the xDestroy callback is invoked on pArg when
  5126. ** the collating function is deleted.
  5127. ** ^Collating functions are deleted when they are overridden by later
  5128. ** calls to the collation creation functions or when the
  5129. ** [database connection] is closed using [sqlite3_close()].
  5130. **
  5131. ** ^The xDestroy callback is <u>not</u> called if the
  5132. ** sqlite3_create_collation_v2() function fails. Applications that invoke
  5133. ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
  5134. ** check the return code and dispose of the application data pointer
  5135. ** themselves rather than expecting SQLite to deal with it for them.
  5136. ** This is different from every other SQLite interface. The inconsistency
  5137. ** is unfortunate but cannot be changed without breaking backwards
  5138. ** compatibility.
  5139. **
  5140. ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
  5141. */
  5142. SQLITE_API int sqlite3_create_collation(
  5143. sqlite3*,
  5144. const char *zName,
  5145. int eTextRep,
  5146. void *pArg,
  5147. int(*xCompare)(void*,int,const void*,int,const void*)
  5148. );
  5149. SQLITE_API int sqlite3_create_collation_v2(
  5150. sqlite3*,
  5151. const char *zName,
  5152. int eTextRep,
  5153. void *pArg,
  5154. int(*xCompare)(void*,int,const void*,int,const void*),
  5155. void(*xDestroy)(void*)
  5156. );
  5157. SQLITE_API int sqlite3_create_collation16(
  5158. sqlite3*,
  5159. const void *zName,
  5160. int eTextRep,
  5161. void *pArg,
  5162. int(*xCompare)(void*,int,const void*,int,const void*)
  5163. );
  5164. /*
  5165. ** CAPI3REF: Collation Needed Callbacks
  5166. ** METHOD: sqlite3
  5167. **
  5168. ** ^To avoid having to register all collation sequences before a database
  5169. ** can be used, a single callback function may be registered with the
  5170. ** [database connection] to be invoked whenever an undefined collation
  5171. ** sequence is required.
  5172. **
  5173. ** ^If the function is registered using the sqlite3_collation_needed() API,
  5174. ** then it is passed the names of undefined collation sequences as strings
  5175. ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
  5176. ** the names are passed as UTF-16 in machine native byte order.
  5177. ** ^A call to either function replaces the existing collation-needed callback.
  5178. **
  5179. ** ^(When the callback is invoked, the first argument passed is a copy
  5180. ** of the second argument to sqlite3_collation_needed() or
  5181. ** sqlite3_collation_needed16(). The second argument is the database
  5182. ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
  5183. ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
  5184. ** sequence function required. The fourth parameter is the name of the
  5185. ** required collation sequence.)^
  5186. **
  5187. ** The callback function should register the desired collation using
  5188. ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
  5189. ** [sqlite3_create_collation_v2()].
  5190. */
  5191. SQLITE_API int sqlite3_collation_needed(
  5192. sqlite3*,
  5193. void*,
  5194. void(*)(void*,sqlite3*,int eTextRep,const char*)
  5195. );
  5196. SQLITE_API int sqlite3_collation_needed16(
  5197. sqlite3*,
  5198. void*,
  5199. void(*)(void*,sqlite3*,int eTextRep,const void*)
  5200. );
  5201. #ifdef SQLITE_HAS_CODEC
  5202. /*
  5203. ** Specify the key for an encrypted database. This routine should be
  5204. ** called right after sqlite3_open().
  5205. **
  5206. ** The code to implement this API is not available in the public release
  5207. ** of SQLite.
  5208. */
  5209. SQLITE_API int sqlite3_key(
  5210. sqlite3 *db, /* Database to be rekeyed */
  5211. const void *pKey, int nKey /* The key */
  5212. );
  5213. SQLITE_API int sqlite3_key_v2(
  5214. sqlite3 *db, /* Database to be rekeyed */
  5215. const char *zDbName, /* Name of the database */
  5216. const void *pKey, int nKey /* The key */
  5217. );
  5218. /*
  5219. ** Change the key on an open database. If the current database is not
  5220. ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
  5221. ** database is decrypted.
  5222. **
  5223. ** The code to implement this API is not available in the public release
  5224. ** of SQLite.
  5225. */
  5226. SQLITE_API int sqlite3_rekey(
  5227. sqlite3 *db, /* Database to be rekeyed */
  5228. const void *pKey, int nKey /* The new key */
  5229. );
  5230. SQLITE_API int sqlite3_rekey_v2(
  5231. sqlite3 *db, /* Database to be rekeyed */
  5232. const char *zDbName, /* Name of the database */
  5233. const void *pKey, int nKey /* The new key */
  5234. );
  5235. /*
  5236. ** Specify the activation key for a SEE database. Unless
  5237. ** activated, none of the SEE routines will work.
  5238. */
  5239. SQLITE_API void sqlite3_activate_see(
  5240. const char *zPassPhrase /* Activation phrase */
  5241. );
  5242. #endif
  5243. #ifdef SQLITE_ENABLE_CEROD
  5244. /*
  5245. ** Specify the activation key for a CEROD database. Unless
  5246. ** activated, none of the CEROD routines will work.
  5247. */
  5248. SQLITE_API void sqlite3_activate_cerod(
  5249. const char *zPassPhrase /* Activation phrase */
  5250. );
  5251. #endif
  5252. /*
  5253. ** CAPI3REF: Suspend Execution For A Short Time
  5254. **
  5255. ** The sqlite3_sleep() function causes the current thread to suspend execution
  5256. ** for at least a number of milliseconds specified in its parameter.
  5257. **
  5258. ** If the operating system does not support sleep requests with
  5259. ** millisecond time resolution, then the time will be rounded up to
  5260. ** the nearest second. The number of milliseconds of sleep actually
  5261. ** requested from the operating system is returned.
  5262. **
  5263. ** ^SQLite implements this interface by calling the xSleep()
  5264. ** method of the default [sqlite3_vfs] object. If the xSleep() method
  5265. ** of the default VFS is not implemented correctly, or not implemented at
  5266. ** all, then the behavior of sqlite3_sleep() may deviate from the description
  5267. ** in the previous paragraphs.
  5268. */
  5269. SQLITE_API int sqlite3_sleep(int);
  5270. /*
  5271. ** CAPI3REF: Name Of The Folder Holding Temporary Files
  5272. **
  5273. ** ^(If this global variable is made to point to a string which is
  5274. ** the name of a folder (a.k.a. directory), then all temporary files
  5275. ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
  5276. ** will be placed in that directory.)^ ^If this variable
  5277. ** is a NULL pointer, then SQLite performs a search for an appropriate
  5278. ** temporary file directory.
  5279. **
  5280. ** Applications are strongly discouraged from using this global variable.
  5281. ** It is required to set a temporary folder on Windows Runtime (WinRT).
  5282. ** But for all other platforms, it is highly recommended that applications
  5283. ** neither read nor write this variable. This global variable is a relic
  5284. ** that exists for backwards compatibility of legacy applications and should
  5285. ** be avoided in new projects.
  5286. **
  5287. ** It is not safe to read or modify this variable in more than one
  5288. ** thread at a time. It is not safe to read or modify this variable
  5289. ** if a [database connection] is being used at the same time in a separate
  5290. ** thread.
  5291. ** It is intended that this variable be set once
  5292. ** as part of process initialization and before any SQLite interface
  5293. ** routines have been called and that this variable remain unchanged
  5294. ** thereafter.
  5295. **
  5296. ** ^The [temp_store_directory pragma] may modify this variable and cause
  5297. ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
  5298. ** the [temp_store_directory pragma] always assumes that any string
  5299. ** that this variable points to is held in memory obtained from
  5300. ** [sqlite3_malloc] and the pragma may attempt to free that memory
  5301. ** using [sqlite3_free].
  5302. ** Hence, if this variable is modified directly, either it should be
  5303. ** made NULL or made to point to memory obtained from [sqlite3_malloc]
  5304. ** or else the use of the [temp_store_directory pragma] should be avoided.
  5305. ** Except when requested by the [temp_store_directory pragma], SQLite
  5306. ** does not free the memory that sqlite3_temp_directory points to. If
  5307. ** the application wants that memory to be freed, it must do
  5308. ** so itself, taking care to only do so after all [database connection]
  5309. ** objects have been destroyed.
  5310. **
  5311. ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
  5312. ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
  5313. ** features that require the use of temporary files may fail. Here is an
  5314. ** example of how to do this using C++ with the Windows Runtime:
  5315. **
  5316. ** <blockquote><pre>
  5317. ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
  5318. ** &nbsp; TemporaryFolder->Path->Data();
  5319. ** char zPathBuf&#91;MAX_PATH + 1&#93;;
  5320. ** memset(zPathBuf, 0, sizeof(zPathBuf));
  5321. ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
  5322. ** &nbsp; NULL, NULL);
  5323. ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
  5324. ** </pre></blockquote>
  5325. */
  5326. SQLITE_API char *sqlite3_temp_directory;
  5327. /*
  5328. ** CAPI3REF: Name Of The Folder Holding Database Files
  5329. **
  5330. ** ^(If this global variable is made to point to a string which is
  5331. ** the name of a folder (a.k.a. directory), then all database files
  5332. ** specified with a relative pathname and created or accessed by
  5333. ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
  5334. ** to be relative to that directory.)^ ^If this variable is a NULL
  5335. ** pointer, then SQLite assumes that all database files specified
  5336. ** with a relative pathname are relative to the current directory
  5337. ** for the process. Only the windows VFS makes use of this global
  5338. ** variable; it is ignored by the unix VFS.
  5339. **
  5340. ** Changing the value of this variable while a database connection is
  5341. ** open can result in a corrupt database.
  5342. **
  5343. ** It is not safe to read or modify this variable in more than one
  5344. ** thread at a time. It is not safe to read or modify this variable
  5345. ** if a [database connection] is being used at the same time in a separate
  5346. ** thread.
  5347. ** It is intended that this variable be set once
  5348. ** as part of process initialization and before any SQLite interface
  5349. ** routines have been called and that this variable remain unchanged
  5350. ** thereafter.
  5351. **
  5352. ** ^The [data_store_directory pragma] may modify this variable and cause
  5353. ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
  5354. ** the [data_store_directory pragma] always assumes that any string
  5355. ** that this variable points to is held in memory obtained from
  5356. ** [sqlite3_malloc] and the pragma may attempt to free that memory
  5357. ** using [sqlite3_free].
  5358. ** Hence, if this variable is modified directly, either it should be
  5359. ** made NULL or made to point to memory obtained from [sqlite3_malloc]
  5360. ** or else the use of the [data_store_directory pragma] should be avoided.
  5361. */
  5362. SQLITE_API char *sqlite3_data_directory;
  5363. /*
  5364. ** CAPI3REF: Test For Auto-Commit Mode
  5365. ** KEYWORDS: {autocommit mode}
  5366. ** METHOD: sqlite3
  5367. **
  5368. ** ^The sqlite3_get_autocommit() interface returns non-zero or
  5369. ** zero if the given database connection is or is not in autocommit mode,
  5370. ** respectively. ^Autocommit mode is on by default.
  5371. ** ^Autocommit mode is disabled by a [BEGIN] statement.
  5372. ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
  5373. **
  5374. ** If certain kinds of errors occur on a statement within a multi-statement
  5375. ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
  5376. ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
  5377. ** transaction might be rolled back automatically. The only way to
  5378. ** find out whether SQLite automatically rolled back the transaction after
  5379. ** an error is to use this function.
  5380. **
  5381. ** If another thread changes the autocommit status of the database
  5382. ** connection while this routine is running, then the return value
  5383. ** is undefined.
  5384. */
  5385. SQLITE_API int sqlite3_get_autocommit(sqlite3*);
  5386. /*
  5387. ** CAPI3REF: Find The Database Handle Of A Prepared Statement
  5388. ** METHOD: sqlite3_stmt
  5389. **
  5390. ** ^The sqlite3_db_handle interface returns the [database connection] handle
  5391. ** to which a [prepared statement] belongs. ^The [database connection]
  5392. ** returned by sqlite3_db_handle is the same [database connection]
  5393. ** that was the first argument
  5394. ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
  5395. ** create the statement in the first place.
  5396. */
  5397. SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
  5398. /*
  5399. ** CAPI3REF: Return The Filename For A Database Connection
  5400. ** METHOD: sqlite3
  5401. **
  5402. ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
  5403. ** associated with database N of connection D. ^The main database file
  5404. ** has the name "main". If there is no attached database N on the database
  5405. ** connection D, or if database N is a temporary or in-memory database, then
  5406. ** a NULL pointer is returned.
  5407. **
  5408. ** ^The filename returned by this function is the output of the
  5409. ** xFullPathname method of the [VFS]. ^In other words, the filename
  5410. ** will be an absolute pathname, even if the filename used
  5411. ** to open the database originally was a URI or relative pathname.
  5412. */
  5413. SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
  5414. /*
  5415. ** CAPI3REF: Determine if a database is read-only
  5416. ** METHOD: sqlite3
  5417. **
  5418. ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
  5419. ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
  5420. ** the name of a database on connection D.
  5421. */
  5422. SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
  5423. /*
  5424. ** CAPI3REF: Find the next prepared statement
  5425. ** METHOD: sqlite3
  5426. **
  5427. ** ^This interface returns a pointer to the next [prepared statement] after
  5428. ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
  5429. ** then this interface returns a pointer to the first prepared statement
  5430. ** associated with the database connection pDb. ^If no prepared statement
  5431. ** satisfies the conditions of this routine, it returns NULL.
  5432. **
  5433. ** The [database connection] pointer D in a call to
  5434. ** [sqlite3_next_stmt(D,S)] must refer to an open database
  5435. ** connection and in particular must not be a NULL pointer.
  5436. */
  5437. SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
  5438. /*
  5439. ** CAPI3REF: Commit And Rollback Notification Callbacks
  5440. ** METHOD: sqlite3
  5441. **
  5442. ** ^The sqlite3_commit_hook() interface registers a callback
  5443. ** function to be invoked whenever a transaction is [COMMIT | committed].
  5444. ** ^Any callback set by a previous call to sqlite3_commit_hook()
  5445. ** for the same database connection is overridden.
  5446. ** ^The sqlite3_rollback_hook() interface registers a callback
  5447. ** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
  5448. ** ^Any callback set by a previous call to sqlite3_rollback_hook()
  5449. ** for the same database connection is overridden.
  5450. ** ^The pArg argument is passed through to the callback.
  5451. ** ^If the callback on a commit hook function returns non-zero,
  5452. ** then the commit is converted into a rollback.
  5453. **
  5454. ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
  5455. ** return the P argument from the previous call of the same function
  5456. ** on the same [database connection] D, or NULL for
  5457. ** the first call for each function on D.
  5458. **
  5459. ** The commit and rollback hook callbacks are not reentrant.
  5460. ** The callback implementation must not do anything that will modify
  5461. ** the database connection that invoked the callback. Any actions
  5462. ** to modify the database connection must be deferred until after the
  5463. ** completion of the [sqlite3_step()] call that triggered the commit
  5464. ** or rollback hook in the first place.
  5465. ** Note that running any other SQL statements, including SELECT statements,
  5466. ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
  5467. ** the database connections for the meaning of "modify" in this paragraph.
  5468. **
  5469. ** ^Registering a NULL function disables the callback.
  5470. **
  5471. ** ^When the commit hook callback routine returns zero, the [COMMIT]
  5472. ** operation is allowed to continue normally. ^If the commit hook
  5473. ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
  5474. ** ^The rollback hook is invoked on a rollback that results from a commit
  5475. ** hook returning non-zero, just as it would be with any other rollback.
  5476. **
  5477. ** ^For the purposes of this API, a transaction is said to have been
  5478. ** rolled back if an explicit "ROLLBACK" statement is executed, or
  5479. ** an error or constraint causes an implicit rollback to occur.
  5480. ** ^The rollback callback is not invoked if a transaction is
  5481. ** automatically rolled back because the database connection is closed.
  5482. **
  5483. ** See also the [sqlite3_update_hook()] interface.
  5484. */
  5485. SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
  5486. SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
  5487. /*
  5488. ** CAPI3REF: Data Change Notification Callbacks
  5489. ** METHOD: sqlite3
  5490. **
  5491. ** ^The sqlite3_update_hook() interface registers a callback function
  5492. ** with the [database connection] identified by the first argument
  5493. ** to be invoked whenever a row is updated, inserted or deleted in
  5494. ** a [rowid table].
  5495. ** ^Any callback set by a previous call to this function
  5496. ** for the same database connection is overridden.
  5497. **
  5498. ** ^The second argument is a pointer to the function to invoke when a
  5499. ** row is updated, inserted or deleted in a rowid table.
  5500. ** ^The first argument to the callback is a copy of the third argument
  5501. ** to sqlite3_update_hook().
  5502. ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
  5503. ** or [SQLITE_UPDATE], depending on the operation that caused the callback
  5504. ** to be invoked.
  5505. ** ^The third and fourth arguments to the callback contain pointers to the
  5506. ** database and table name containing the affected row.
  5507. ** ^The final callback parameter is the [rowid] of the row.
  5508. ** ^In the case of an update, this is the [rowid] after the update takes place.
  5509. **
  5510. ** ^(The update hook is not invoked when internal system tables are
  5511. ** modified (i.e. sqlite_master and sqlite_sequence).)^
  5512. ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
  5513. **
  5514. ** ^In the current implementation, the update hook
  5515. ** is not invoked when duplication rows are deleted because of an
  5516. ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
  5517. ** invoked when rows are deleted using the [truncate optimization].
  5518. ** The exceptions defined in this paragraph might change in a future
  5519. ** release of SQLite.
  5520. **
  5521. ** The update hook implementation must not do anything that will modify
  5522. ** the database connection that invoked the update hook. Any actions
  5523. ** to modify the database connection must be deferred until after the
  5524. ** completion of the [sqlite3_step()] call that triggered the update hook.
  5525. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  5526. ** database connections for the meaning of "modify" in this paragraph.
  5527. **
  5528. ** ^The sqlite3_update_hook(D,C,P) function
  5529. ** returns the P argument from the previous call
  5530. ** on the same [database connection] D, or NULL for
  5531. ** the first call on D.
  5532. **
  5533. ** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
  5534. ** and [sqlite3_preupdate_hook()] interfaces.
  5535. */
  5536. SQLITE_API void *sqlite3_update_hook(
  5537. sqlite3*,
  5538. void(*)(void *,int ,char const *,char const *,sqlite3_int64),
  5539. void*
  5540. );
  5541. /*
  5542. ** CAPI3REF: Enable Or Disable Shared Pager Cache
  5543. **
  5544. ** ^(This routine enables or disables the sharing of the database cache
  5545. ** and schema data structures between [database connection | connections]
  5546. ** to the same database. Sharing is enabled if the argument is true
  5547. ** and disabled if the argument is false.)^
  5548. **
  5549. ** ^Cache sharing is enabled and disabled for an entire process.
  5550. ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
  5551. ** In prior versions of SQLite,
  5552. ** sharing was enabled or disabled for each thread separately.
  5553. **
  5554. ** ^(The cache sharing mode set by this interface effects all subsequent
  5555. ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
  5556. ** Existing database connections continue use the sharing mode
  5557. ** that was in effect at the time they were opened.)^
  5558. **
  5559. ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
  5560. ** successfully. An [error code] is returned otherwise.)^
  5561. **
  5562. ** ^Shared cache is disabled by default. But this might change in
  5563. ** future releases of SQLite. Applications that care about shared
  5564. ** cache setting should set it explicitly.
  5565. **
  5566. ** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
  5567. ** and will always return SQLITE_MISUSE. On those systems,
  5568. ** shared cache mode should be enabled per-database connection via
  5569. ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
  5570. **
  5571. ** This interface is threadsafe on processors where writing a
  5572. ** 32-bit integer is atomic.
  5573. **
  5574. ** See Also: [SQLite Shared-Cache Mode]
  5575. */
  5576. SQLITE_API int sqlite3_enable_shared_cache(int);
  5577. /*
  5578. ** CAPI3REF: Attempt To Free Heap Memory
  5579. **
  5580. ** ^The sqlite3_release_memory() interface attempts to free N bytes
  5581. ** of heap memory by deallocating non-essential memory allocations
  5582. ** held by the database library. Memory used to cache database
  5583. ** pages to improve performance is an example of non-essential memory.
  5584. ** ^sqlite3_release_memory() returns the number of bytes actually freed,
  5585. ** which might be more or less than the amount requested.
  5586. ** ^The sqlite3_release_memory() routine is a no-op returning zero
  5587. ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
  5588. **
  5589. ** See also: [sqlite3_db_release_memory()]
  5590. */
  5591. SQLITE_API int sqlite3_release_memory(int);
  5592. /*
  5593. ** CAPI3REF: Free Memory Used By A Database Connection
  5594. ** METHOD: sqlite3
  5595. **
  5596. ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
  5597. ** memory as possible from database connection D. Unlike the
  5598. ** [sqlite3_release_memory()] interface, this interface is in effect even
  5599. ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
  5600. ** omitted.
  5601. **
  5602. ** See also: [sqlite3_release_memory()]
  5603. */
  5604. SQLITE_API int sqlite3_db_release_memory(sqlite3*);
  5605. /*
  5606. ** CAPI3REF: Impose A Limit On Heap Size
  5607. **
  5608. ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
  5609. ** soft limit on the amount of heap memory that may be allocated by SQLite.
  5610. ** ^SQLite strives to keep heap memory utilization below the soft heap
  5611. ** limit by reducing the number of pages held in the page cache
  5612. ** as heap memory usages approaches the limit.
  5613. ** ^The soft heap limit is "soft" because even though SQLite strives to stay
  5614. ** below the limit, it will exceed the limit rather than generate
  5615. ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
  5616. ** is advisory only.
  5617. **
  5618. ** ^The return value from sqlite3_soft_heap_limit64() is the size of
  5619. ** the soft heap limit prior to the call, or negative in the case of an
  5620. ** error. ^If the argument N is negative
  5621. ** then no change is made to the soft heap limit. Hence, the current
  5622. ** size of the soft heap limit can be determined by invoking
  5623. ** sqlite3_soft_heap_limit64() with a negative argument.
  5624. **
  5625. ** ^If the argument N is zero then the soft heap limit is disabled.
  5626. **
  5627. ** ^(The soft heap limit is not enforced in the current implementation
  5628. ** if one or more of following conditions are true:
  5629. **
  5630. ** <ul>
  5631. ** <li> The soft heap limit is set to zero.
  5632. ** <li> Memory accounting is disabled using a combination of the
  5633. ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
  5634. ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
  5635. ** <li> An alternative page cache implementation is specified using
  5636. ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
  5637. ** <li> The page cache allocates from its own memory pool supplied
  5638. ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
  5639. ** from the heap.
  5640. ** </ul>)^
  5641. **
  5642. ** Beginning with SQLite [version 3.7.3] ([dateof:3.7.3]),
  5643. ** the soft heap limit is enforced
  5644. ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
  5645. ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
  5646. ** the soft heap limit is enforced on every memory allocation. Without
  5647. ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
  5648. ** when memory is allocated by the page cache. Testing suggests that because
  5649. ** the page cache is the predominate memory user in SQLite, most
  5650. ** applications will achieve adequate soft heap limit enforcement without
  5651. ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
  5652. **
  5653. ** The circumstances under which SQLite will enforce the soft heap limit may
  5654. ** changes in future releases of SQLite.
  5655. */
  5656. SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
  5657. /*
  5658. ** CAPI3REF: Deprecated Soft Heap Limit Interface
  5659. ** DEPRECATED
  5660. **
  5661. ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
  5662. ** interface. This routine is provided for historical compatibility
  5663. ** only. All new applications should use the
  5664. ** [sqlite3_soft_heap_limit64()] interface rather than this one.
  5665. */
  5666. SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
  5667. /*
  5668. ** CAPI3REF: Extract Metadata About A Column Of A Table
  5669. ** METHOD: sqlite3
  5670. **
  5671. ** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
  5672. ** information about column C of table T in database D
  5673. ** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
  5674. ** interface returns SQLITE_OK and fills in the non-NULL pointers in
  5675. ** the final five arguments with appropriate values if the specified
  5676. ** column exists. ^The sqlite3_table_column_metadata() interface returns
  5677. ** SQLITE_ERROR and if the specified column does not exist.
  5678. ** ^If the column-name parameter to sqlite3_table_column_metadata() is a
  5679. ** NULL pointer, then this routine simply checks for the existence of the
  5680. ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
  5681. ** does not.
  5682. **
  5683. ** ^The column is identified by the second, third and fourth parameters to
  5684. ** this function. ^(The second parameter is either the name of the database
  5685. ** (i.e. "main", "temp", or an attached database) containing the specified
  5686. ** table or NULL.)^ ^If it is NULL, then all attached databases are searched
  5687. ** for the table using the same algorithm used by the database engine to
  5688. ** resolve unqualified table references.
  5689. **
  5690. ** ^The third and fourth parameters to this function are the table and column
  5691. ** name of the desired column, respectively.
  5692. **
  5693. ** ^Metadata is returned by writing to the memory locations passed as the 5th
  5694. ** and subsequent parameters to this function. ^Any of these arguments may be
  5695. ** NULL, in which case the corresponding element of metadata is omitted.
  5696. **
  5697. ** ^(<blockquote>
  5698. ** <table border="1">
  5699. ** <tr><th> Parameter <th> Output<br>Type <th> Description
  5700. **
  5701. ** <tr><td> 5th <td> const char* <td> Data type
  5702. ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
  5703. ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
  5704. ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
  5705. ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
  5706. ** </table>
  5707. ** </blockquote>)^
  5708. **
  5709. ** ^The memory pointed to by the character pointers returned for the
  5710. ** declaration type and collation sequence is valid until the next
  5711. ** call to any SQLite API function.
  5712. **
  5713. ** ^If the specified table is actually a view, an [error code] is returned.
  5714. **
  5715. ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
  5716. ** is not a [WITHOUT ROWID] table and an
  5717. ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
  5718. ** parameters are set for the explicitly declared column. ^(If there is no
  5719. ** [INTEGER PRIMARY KEY] column, then the outputs
  5720. ** for the [rowid] are set as follows:
  5721. **
  5722. ** <pre>
  5723. ** data type: "INTEGER"
  5724. ** collation sequence: "BINARY"
  5725. ** not null: 0
  5726. ** primary key: 1
  5727. ** auto increment: 0
  5728. ** </pre>)^
  5729. **
  5730. ** ^This function causes all database schemas to be read from disk and
  5731. ** parsed, if that has not already been done, and returns an error if
  5732. ** any errors are encountered while loading the schema.
  5733. */
  5734. SQLITE_API int sqlite3_table_column_metadata(
  5735. sqlite3 *db, /* Connection handle */
  5736. const char *zDbName, /* Database name or NULL */
  5737. const char *zTableName, /* Table name */
  5738. const char *zColumnName, /* Column name */
  5739. char const **pzDataType, /* OUTPUT: Declared data type */
  5740. char const **pzCollSeq, /* OUTPUT: Collation sequence name */
  5741. int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
  5742. int *pPrimaryKey, /* OUTPUT: True if column part of PK */
  5743. int *pAutoinc /* OUTPUT: True if column is auto-increment */
  5744. );
  5745. /*
  5746. ** CAPI3REF: Load An Extension
  5747. ** METHOD: sqlite3
  5748. **
  5749. ** ^This interface loads an SQLite extension library from the named file.
  5750. **
  5751. ** ^The sqlite3_load_extension() interface attempts to load an
  5752. ** [SQLite extension] library contained in the file zFile. If
  5753. ** the file cannot be loaded directly, attempts are made to load
  5754. ** with various operating-system specific extensions added.
  5755. ** So for example, if "samplelib" cannot be loaded, then names like
  5756. ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
  5757. ** be tried also.
  5758. **
  5759. ** ^The entry point is zProc.
  5760. ** ^(zProc may be 0, in which case SQLite will try to come up with an
  5761. ** entry point name on its own. It first tries "sqlite3_extension_init".
  5762. ** If that does not work, it constructs a name "sqlite3_X_init" where the
  5763. ** X is consists of the lower-case equivalent of all ASCII alphabetic
  5764. ** characters in the filename from the last "/" to the first following
  5765. ** "." and omitting any initial "lib".)^
  5766. ** ^The sqlite3_load_extension() interface returns
  5767. ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
  5768. ** ^If an error occurs and pzErrMsg is not 0, then the
  5769. ** [sqlite3_load_extension()] interface shall attempt to
  5770. ** fill *pzErrMsg with error message text stored in memory
  5771. ** obtained from [sqlite3_malloc()]. The calling function
  5772. ** should free this memory by calling [sqlite3_free()].
  5773. **
  5774. ** ^Extension loading must be enabled using
  5775. ** [sqlite3_enable_load_extension()] or
  5776. ** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
  5777. ** prior to calling this API,
  5778. ** otherwise an error will be returned.
  5779. **
  5780. ** <b>Security warning:</b> It is recommended that the
  5781. ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
  5782. ** interface. The use of the [sqlite3_enable_load_extension()] interface
  5783. ** should be avoided. This will keep the SQL function [load_extension()]
  5784. ** disabled and prevent SQL injections from giving attackers
  5785. ** access to extension loading capabilities.
  5786. **
  5787. ** See also the [load_extension() SQL function].
  5788. */
  5789. SQLITE_API int sqlite3_load_extension(
  5790. sqlite3 *db, /* Load the extension into this database connection */
  5791. const char *zFile, /* Name of the shared library containing extension */
  5792. const char *zProc, /* Entry point. Derived from zFile if 0 */
  5793. char **pzErrMsg /* Put error message here if not 0 */
  5794. );
  5795. /*
  5796. ** CAPI3REF: Enable Or Disable Extension Loading
  5797. ** METHOD: sqlite3
  5798. **
  5799. ** ^So as not to open security holes in older applications that are
  5800. ** unprepared to deal with [extension loading], and as a means of disabling
  5801. ** [extension loading] while evaluating user-entered SQL, the following API
  5802. ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
  5803. **
  5804. ** ^Extension loading is off by default.
  5805. ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
  5806. ** to turn extension loading on and call it with onoff==0 to turn
  5807. ** it back off again.
  5808. **
  5809. ** ^This interface enables or disables both the C-API
  5810. ** [sqlite3_load_extension()] and the SQL function [load_extension()].
  5811. ** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
  5812. ** to enable or disable only the C-API.)^
  5813. **
  5814. ** <b>Security warning:</b> It is recommended that extension loading
  5815. ** be disabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
  5816. ** rather than this interface, so the [load_extension()] SQL function
  5817. ** remains disabled. This will prevent SQL injections from giving attackers
  5818. ** access to extension loading capabilities.
  5819. */
  5820. SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
  5821. /*
  5822. ** CAPI3REF: Automatically Load Statically Linked Extensions
  5823. **
  5824. ** ^This interface causes the xEntryPoint() function to be invoked for
  5825. ** each new [database connection] that is created. The idea here is that
  5826. ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
  5827. ** that is to be automatically loaded into all new database connections.
  5828. **
  5829. ** ^(Even though the function prototype shows that xEntryPoint() takes
  5830. ** no arguments and returns void, SQLite invokes xEntryPoint() with three
  5831. ** arguments and expects an integer result as if the signature of the
  5832. ** entry point where as follows:
  5833. **
  5834. ** <blockquote><pre>
  5835. ** &nbsp; int xEntryPoint(
  5836. ** &nbsp; sqlite3 *db,
  5837. ** &nbsp; const char **pzErrMsg,
  5838. ** &nbsp; const struct sqlite3_api_routines *pThunk
  5839. ** &nbsp; );
  5840. ** </pre></blockquote>)^
  5841. **
  5842. ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
  5843. ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
  5844. ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
  5845. ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
  5846. ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
  5847. ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
  5848. ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
  5849. **
  5850. ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
  5851. ** on the list of automatic extensions is a harmless no-op. ^No entry point
  5852. ** will be called more than once for each database connection that is opened.
  5853. **
  5854. ** See also: [sqlite3_reset_auto_extension()]
  5855. ** and [sqlite3_cancel_auto_extension()]
  5856. */
  5857. SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
  5858. /*
  5859. ** CAPI3REF: Cancel Automatic Extension Loading
  5860. **
  5861. ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
  5862. ** initialization routine X that was registered using a prior call to
  5863. ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
  5864. ** routine returns 1 if initialization routine X was successfully
  5865. ** unregistered and it returns 0 if X was not on the list of initialization
  5866. ** routines.
  5867. */
  5868. SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
  5869. /*
  5870. ** CAPI3REF: Reset Automatic Extension Loading
  5871. **
  5872. ** ^This interface disables all automatic extensions previously
  5873. ** registered using [sqlite3_auto_extension()].
  5874. */
  5875. SQLITE_API void sqlite3_reset_auto_extension(void);
  5876. /*
  5877. ** The interface to the virtual-table mechanism is currently considered
  5878. ** to be experimental. The interface might change in incompatible ways.
  5879. ** If this is a problem for you, do not use the interface at this time.
  5880. **
  5881. ** When the virtual-table mechanism stabilizes, we will declare the
  5882. ** interface fixed, support it indefinitely, and remove this comment.
  5883. */
  5884. /*
  5885. ** Structures used by the virtual table interface
  5886. */
  5887. typedef struct sqlite3_vtab sqlite3_vtab;
  5888. typedef struct sqlite3_index_info sqlite3_index_info;
  5889. typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
  5890. typedef struct sqlite3_module sqlite3_module;
  5891. /*
  5892. ** CAPI3REF: Virtual Table Object
  5893. ** KEYWORDS: sqlite3_module {virtual table module}
  5894. **
  5895. ** This structure, sometimes called a "virtual table module",
  5896. ** defines the implementation of a [virtual tables].
  5897. ** This structure consists mostly of methods for the module.
  5898. **
  5899. ** ^A virtual table module is created by filling in a persistent
  5900. ** instance of this structure and passing a pointer to that instance
  5901. ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
  5902. ** ^The registration remains valid until it is replaced by a different
  5903. ** module or until the [database connection] closes. The content
  5904. ** of this structure must not change while it is registered with
  5905. ** any database connection.
  5906. */
  5907. struct sqlite3_module {
  5908. int iVersion;
  5909. int (*xCreate)(sqlite3*, void *pAux,
  5910. int argc, const char *const*argv,
  5911. sqlite3_vtab **ppVTab, char**);
  5912. int (*xConnect)(sqlite3*, void *pAux,
  5913. int argc, const char *const*argv,
  5914. sqlite3_vtab **ppVTab, char**);
  5915. int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
  5916. int (*xDisconnect)(sqlite3_vtab *pVTab);
  5917. int (*xDestroy)(sqlite3_vtab *pVTab);
  5918. int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
  5919. int (*xClose)(sqlite3_vtab_cursor*);
  5920. int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
  5921. int argc, sqlite3_value **argv);
  5922. int (*xNext)(sqlite3_vtab_cursor*);
  5923. int (*xEof)(sqlite3_vtab_cursor*);
  5924. int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
  5925. int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
  5926. int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
  5927. int (*xBegin)(sqlite3_vtab *pVTab);
  5928. int (*xSync)(sqlite3_vtab *pVTab);
  5929. int (*xCommit)(sqlite3_vtab *pVTab);
  5930. int (*xRollback)(sqlite3_vtab *pVTab);
  5931. int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
  5932. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
  5933. void **ppArg);
  5934. int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
  5935. /* The methods above are in version 1 of the sqlite_module object. Those
  5936. ** below are for version 2 and greater. */
  5937. int (*xSavepoint)(sqlite3_vtab *pVTab, int);
  5938. int (*xRelease)(sqlite3_vtab *pVTab, int);
  5939. int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
  5940. };
  5941. /*
  5942. ** CAPI3REF: Virtual Table Indexing Information
  5943. ** KEYWORDS: sqlite3_index_info
  5944. **
  5945. ** The sqlite3_index_info structure and its substructures is used as part
  5946. ** of the [virtual table] interface to
  5947. ** pass information into and receive the reply from the [xBestIndex]
  5948. ** method of a [virtual table module]. The fields under **Inputs** are the
  5949. ** inputs to xBestIndex and are read-only. xBestIndex inserts its
  5950. ** results into the **Outputs** fields.
  5951. **
  5952. ** ^(The aConstraint[] array records WHERE clause constraints of the form:
  5953. **
  5954. ** <blockquote>column OP expr</blockquote>
  5955. **
  5956. ** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^ ^(The particular operator is
  5957. ** stored in aConstraint[].op using one of the
  5958. ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
  5959. ** ^(The index of the column is stored in
  5960. ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
  5961. ** expr on the right-hand side can be evaluated (and thus the constraint
  5962. ** is usable) and false if it cannot.)^
  5963. **
  5964. ** ^The optimizer automatically inverts terms of the form "expr OP column"
  5965. ** and makes other simplifications to the WHERE clause in an attempt to
  5966. ** get as many WHERE clause terms into the form shown above as possible.
  5967. ** ^The aConstraint[] array only reports WHERE clause terms that are
  5968. ** relevant to the particular virtual table being queried.
  5969. **
  5970. ** ^Information about the ORDER BY clause is stored in aOrderBy[].
  5971. ** ^Each term of aOrderBy records a column of the ORDER BY clause.
  5972. **
  5973. ** The colUsed field indicates which columns of the virtual table may be
  5974. ** required by the current scan. Virtual table columns are numbered from
  5975. ** zero in the order in which they appear within the CREATE TABLE statement
  5976. ** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
  5977. ** the corresponding bit is set within the colUsed mask if the column may be
  5978. ** required by SQLite. If the table has at least 64 columns and any column
  5979. ** to the right of the first 63 is required, then bit 63 of colUsed is also
  5980. ** set. In other words, column iCol may be required if the expression
  5981. ** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
  5982. ** non-zero.
  5983. **
  5984. ** The [xBestIndex] method must fill aConstraintUsage[] with information
  5985. ** about what parameters to pass to xFilter. ^If argvIndex>0 then
  5986. ** the right-hand side of the corresponding aConstraint[] is evaluated
  5987. ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
  5988. ** is true, then the constraint is assumed to be fully handled by the
  5989. ** virtual table and is not checked again by SQLite.)^
  5990. **
  5991. ** ^The idxNum and idxPtr values are recorded and passed into the
  5992. ** [xFilter] method.
  5993. ** ^[sqlite3_free()] is used to free idxPtr if and only if
  5994. ** needToFreeIdxPtr is true.
  5995. **
  5996. ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
  5997. ** the correct order to satisfy the ORDER BY clause so that no separate
  5998. ** sorting step is required.
  5999. **
  6000. ** ^The estimatedCost value is an estimate of the cost of a particular
  6001. ** strategy. A cost of N indicates that the cost of the strategy is similar
  6002. ** to a linear scan of an SQLite table with N rows. A cost of log(N)
  6003. ** indicates that the expense of the operation is similar to that of a
  6004. ** binary search on a unique indexed field of an SQLite table with N rows.
  6005. **
  6006. ** ^The estimatedRows value is an estimate of the number of rows that
  6007. ** will be returned by the strategy.
  6008. **
  6009. ** The xBestIndex method may optionally populate the idxFlags field with a
  6010. ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
  6011. ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
  6012. ** assumes that the strategy may visit at most one row.
  6013. **
  6014. ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
  6015. ** SQLite also assumes that if a call to the xUpdate() method is made as
  6016. ** part of the same statement to delete or update a virtual table row and the
  6017. ** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
  6018. ** any database changes. In other words, if the xUpdate() returns
  6019. ** SQLITE_CONSTRAINT, the database contents must be exactly as they were
  6020. ** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
  6021. ** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
  6022. ** the xUpdate method are automatically rolled back by SQLite.
  6023. **
  6024. ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
  6025. ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
  6026. ** If a virtual table extension is
  6027. ** used with an SQLite version earlier than 3.8.2, the results of attempting
  6028. ** to read or write the estimatedRows field are undefined (but are likely
  6029. ** to included crashing the application). The estimatedRows field should
  6030. ** therefore only be used if [sqlite3_libversion_number()] returns a
  6031. ** value greater than or equal to 3008002. Similarly, the idxFlags field
  6032. ** was added for [version 3.9.0] ([dateof:3.9.0]).
  6033. ** It may therefore only be used if
  6034. ** sqlite3_libversion_number() returns a value greater than or equal to
  6035. ** 3009000.
  6036. */
  6037. struct sqlite3_index_info {
  6038. /* Inputs */
  6039. int nConstraint; /* Number of entries in aConstraint */
  6040. struct sqlite3_index_constraint {
  6041. int iColumn; /* Column constrained. -1 for ROWID */
  6042. unsigned char op; /* Constraint operator */
  6043. unsigned char usable; /* True if this constraint is usable */
  6044. int iTermOffset; /* Used internally - xBestIndex should ignore */
  6045. } *aConstraint; /* Table of WHERE clause constraints */
  6046. int nOrderBy; /* Number of terms in the ORDER BY clause */
  6047. struct sqlite3_index_orderby {
  6048. int iColumn; /* Column number */
  6049. unsigned char desc; /* True for DESC. False for ASC. */
  6050. } *aOrderBy; /* The ORDER BY clause */
  6051. /* Outputs */
  6052. struct sqlite3_index_constraint_usage {
  6053. int argvIndex; /* if >0, constraint is part of argv to xFilter */
  6054. unsigned char omit; /* Do not code a test for this constraint */
  6055. } *aConstraintUsage;
  6056. int idxNum; /* Number used to identify the index */
  6057. char *idxStr; /* String, possibly obtained from sqlite3_malloc */
  6058. int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
  6059. int orderByConsumed; /* True if output is already ordered */
  6060. double estimatedCost; /* Estimated cost of using this index */
  6061. /* Fields below are only available in SQLite 3.8.2 and later */
  6062. sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
  6063. /* Fields below are only available in SQLite 3.9.0 and later */
  6064. int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
  6065. /* Fields below are only available in SQLite 3.10.0 and later */
  6066. sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
  6067. };
  6068. /*
  6069. ** CAPI3REF: Virtual Table Scan Flags
  6070. */
  6071. #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
  6072. /*
  6073. ** CAPI3REF: Virtual Table Constraint Operator Codes
  6074. **
  6075. ** These macros defined the allowed values for the
  6076. ** [sqlite3_index_info].aConstraint[].op field. Each value represents
  6077. ** an operator that is part of a constraint term in the wHERE clause of
  6078. ** a query that uses a [virtual table].
  6079. */
  6080. #define SQLITE_INDEX_CONSTRAINT_EQ 2
  6081. #define SQLITE_INDEX_CONSTRAINT_GT 4
  6082. #define SQLITE_INDEX_CONSTRAINT_LE 8
  6083. #define SQLITE_INDEX_CONSTRAINT_LT 16
  6084. #define SQLITE_INDEX_CONSTRAINT_GE 32
  6085. #define SQLITE_INDEX_CONSTRAINT_MATCH 64
  6086. #define SQLITE_INDEX_CONSTRAINT_LIKE 65
  6087. #define SQLITE_INDEX_CONSTRAINT_GLOB 66
  6088. #define SQLITE_INDEX_CONSTRAINT_REGEXP 67
  6089. /*
  6090. ** CAPI3REF: Register A Virtual Table Implementation
  6091. ** METHOD: sqlite3
  6092. **
  6093. ** ^These routines are used to register a new [virtual table module] name.
  6094. ** ^Module names must be registered before
  6095. ** creating a new [virtual table] using the module and before using a
  6096. ** preexisting [virtual table] for the module.
  6097. **
  6098. ** ^The module name is registered on the [database connection] specified
  6099. ** by the first parameter. ^The name of the module is given by the
  6100. ** second parameter. ^The third parameter is a pointer to
  6101. ** the implementation of the [virtual table module]. ^The fourth
  6102. ** parameter is an arbitrary client data pointer that is passed through
  6103. ** into the [xCreate] and [xConnect] methods of the virtual table module
  6104. ** when a new virtual table is be being created or reinitialized.
  6105. **
  6106. ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
  6107. ** is a pointer to a destructor for the pClientData. ^SQLite will
  6108. ** invoke the destructor function (if it is not NULL) when SQLite
  6109. ** no longer needs the pClientData pointer. ^The destructor will also
  6110. ** be invoked if the call to sqlite3_create_module_v2() fails.
  6111. ** ^The sqlite3_create_module()
  6112. ** interface is equivalent to sqlite3_create_module_v2() with a NULL
  6113. ** destructor.
  6114. */
  6115. SQLITE_API int sqlite3_create_module(
  6116. sqlite3 *db, /* SQLite connection to register module with */
  6117. const char *zName, /* Name of the module */
  6118. const sqlite3_module *p, /* Methods for the module */
  6119. void *pClientData /* Client data for xCreate/xConnect */
  6120. );
  6121. SQLITE_API int sqlite3_create_module_v2(
  6122. sqlite3 *db, /* SQLite connection to register module with */
  6123. const char *zName, /* Name of the module */
  6124. const sqlite3_module *p, /* Methods for the module */
  6125. void *pClientData, /* Client data for xCreate/xConnect */
  6126. void(*xDestroy)(void*) /* Module destructor function */
  6127. );
  6128. /*
  6129. ** CAPI3REF: Virtual Table Instance Object
  6130. ** KEYWORDS: sqlite3_vtab
  6131. **
  6132. ** Every [virtual table module] implementation uses a subclass
  6133. ** of this object to describe a particular instance
  6134. ** of the [virtual table]. Each subclass will
  6135. ** be tailored to the specific needs of the module implementation.
  6136. ** The purpose of this superclass is to define certain fields that are
  6137. ** common to all module implementations.
  6138. **
  6139. ** ^Virtual tables methods can set an error message by assigning a
  6140. ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
  6141. ** take care that any prior string is freed by a call to [sqlite3_free()]
  6142. ** prior to assigning a new string to zErrMsg. ^After the error message
  6143. ** is delivered up to the client application, the string will be automatically
  6144. ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
  6145. */
  6146. struct sqlite3_vtab {
  6147. const sqlite3_module *pModule; /* The module for this virtual table */
  6148. int nRef; /* Number of open cursors */
  6149. char *zErrMsg; /* Error message from sqlite3_mprintf() */
  6150. /* Virtual table implementations will typically add additional fields */
  6151. };
  6152. /*
  6153. ** CAPI3REF: Virtual Table Cursor Object
  6154. ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
  6155. **
  6156. ** Every [virtual table module] implementation uses a subclass of the
  6157. ** following structure to describe cursors that point into the
  6158. ** [virtual table] and are used
  6159. ** to loop through the virtual table. Cursors are created using the
  6160. ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
  6161. ** by the [sqlite3_module.xClose | xClose] method. Cursors are used
  6162. ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
  6163. ** of the module. Each module implementation will define
  6164. ** the content of a cursor structure to suit its own needs.
  6165. **
  6166. ** This superclass exists in order to define fields of the cursor that
  6167. ** are common to all implementations.
  6168. */
  6169. struct sqlite3_vtab_cursor {
  6170. sqlite3_vtab *pVtab; /* Virtual table of this cursor */
  6171. /* Virtual table implementations will typically add additional fields */
  6172. };
  6173. /*
  6174. ** CAPI3REF: Declare The Schema Of A Virtual Table
  6175. **
  6176. ** ^The [xCreate] and [xConnect] methods of a
  6177. ** [virtual table module] call this interface
  6178. ** to declare the format (the names and datatypes of the columns) of
  6179. ** the virtual tables they implement.
  6180. */
  6181. SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
  6182. /*
  6183. ** CAPI3REF: Overload A Function For A Virtual Table
  6184. ** METHOD: sqlite3
  6185. **
  6186. ** ^(Virtual tables can provide alternative implementations of functions
  6187. ** using the [xFindFunction] method of the [virtual table module].
  6188. ** But global versions of those functions
  6189. ** must exist in order to be overloaded.)^
  6190. **
  6191. ** ^(This API makes sure a global version of a function with a particular
  6192. ** name and number of parameters exists. If no such function exists
  6193. ** before this API is called, a new function is created.)^ ^The implementation
  6194. ** of the new function always causes an exception to be thrown. So
  6195. ** the new function is not good for anything by itself. Its only
  6196. ** purpose is to be a placeholder function that can be overloaded
  6197. ** by a [virtual table].
  6198. */
  6199. SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
  6200. /*
  6201. ** The interface to the virtual-table mechanism defined above (back up
  6202. ** to a comment remarkably similar to this one) is currently considered
  6203. ** to be experimental. The interface might change in incompatible ways.
  6204. ** If this is a problem for you, do not use the interface at this time.
  6205. **
  6206. ** When the virtual-table mechanism stabilizes, we will declare the
  6207. ** interface fixed, support it indefinitely, and remove this comment.
  6208. */
  6209. /*
  6210. ** CAPI3REF: A Handle To An Open BLOB
  6211. ** KEYWORDS: {BLOB handle} {BLOB handles}
  6212. **
  6213. ** An instance of this object represents an open BLOB on which
  6214. ** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
  6215. ** ^Objects of this type are created by [sqlite3_blob_open()]
  6216. ** and destroyed by [sqlite3_blob_close()].
  6217. ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
  6218. ** can be used to read or write small subsections of the BLOB.
  6219. ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
  6220. */
  6221. typedef struct sqlite3_blob sqlite3_blob;
  6222. /*
  6223. ** CAPI3REF: Open A BLOB For Incremental I/O
  6224. ** METHOD: sqlite3
  6225. ** CONSTRUCTOR: sqlite3_blob
  6226. **
  6227. ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
  6228. ** in row iRow, column zColumn, table zTable in database zDb;
  6229. ** in other words, the same BLOB that would be selected by:
  6230. **
  6231. ** <pre>
  6232. ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
  6233. ** </pre>)^
  6234. **
  6235. ** ^(Parameter zDb is not the filename that contains the database, but
  6236. ** rather the symbolic name of the database. For attached databases, this is
  6237. ** the name that appears after the AS keyword in the [ATTACH] statement.
  6238. ** For the main database file, the database name is "main". For TEMP
  6239. ** tables, the database name is "temp".)^
  6240. **
  6241. ** ^If the flags parameter is non-zero, then the BLOB is opened for read
  6242. ** and write access. ^If the flags parameter is zero, the BLOB is opened for
  6243. ** read-only access.
  6244. **
  6245. ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
  6246. ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
  6247. ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
  6248. ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
  6249. ** on *ppBlob after this function it returns.
  6250. **
  6251. ** This function fails with SQLITE_ERROR if any of the following are true:
  6252. ** <ul>
  6253. ** <li> ^(Database zDb does not exist)^,
  6254. ** <li> ^(Table zTable does not exist within database zDb)^,
  6255. ** <li> ^(Table zTable is a WITHOUT ROWID table)^,
  6256. ** <li> ^(Column zColumn does not exist)^,
  6257. ** <li> ^(Row iRow is not present in the table)^,
  6258. ** <li> ^(The specified column of row iRow contains a value that is not
  6259. ** a TEXT or BLOB value)^,
  6260. ** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
  6261. ** constraint and the blob is being opened for read/write access)^,
  6262. ** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
  6263. ** column zColumn is part of a [child key] definition and the blob is
  6264. ** being opened for read/write access)^.
  6265. ** </ul>
  6266. **
  6267. ** ^Unless it returns SQLITE_MISUSE, this function sets the
  6268. ** [database connection] error code and message accessible via
  6269. ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
  6270. **
  6271. **
  6272. ** ^(If the row that a BLOB handle points to is modified by an
  6273. ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
  6274. ** then the BLOB handle is marked as "expired".
  6275. ** This is true if any column of the row is changed, even a column
  6276. ** other than the one the BLOB handle is open on.)^
  6277. ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
  6278. ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
  6279. ** ^(Changes written into a BLOB prior to the BLOB expiring are not
  6280. ** rolled back by the expiration of the BLOB. Such changes will eventually
  6281. ** commit if the transaction continues to completion.)^
  6282. **
  6283. ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
  6284. ** the opened blob. ^The size of a blob may not be changed by this
  6285. ** interface. Use the [UPDATE] SQL command to change the size of a
  6286. ** blob.
  6287. **
  6288. ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
  6289. ** and the built-in [zeroblob] SQL function may be used to create a
  6290. ** zero-filled blob to read or write using the incremental-blob interface.
  6291. **
  6292. ** To avoid a resource leak, every open [BLOB handle] should eventually
  6293. ** be released by a call to [sqlite3_blob_close()].
  6294. */
  6295. SQLITE_API int sqlite3_blob_open(
  6296. sqlite3*,
  6297. const char *zDb,
  6298. const char *zTable,
  6299. const char *zColumn,
  6300. sqlite3_int64 iRow,
  6301. int flags,
  6302. sqlite3_blob **ppBlob
  6303. );
  6304. /*
  6305. ** CAPI3REF: Move a BLOB Handle to a New Row
  6306. ** METHOD: sqlite3_blob
  6307. **
  6308. ** ^This function is used to move an existing blob handle so that it points
  6309. ** to a different row of the same database table. ^The new row is identified
  6310. ** by the rowid value passed as the second argument. Only the row can be
  6311. ** changed. ^The database, table and column on which the blob handle is open
  6312. ** remain the same. Moving an existing blob handle to a new row can be
  6313. ** faster than closing the existing handle and opening a new one.
  6314. **
  6315. ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
  6316. ** it must exist and there must be either a blob or text value stored in
  6317. ** the nominated column.)^ ^If the new row is not present in the table, or if
  6318. ** it does not contain a blob or text value, or if another error occurs, an
  6319. ** SQLite error code is returned and the blob handle is considered aborted.
  6320. ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
  6321. ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
  6322. ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
  6323. ** always returns zero.
  6324. **
  6325. ** ^This function sets the database handle error code and message.
  6326. */
  6327. SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
  6328. /*
  6329. ** CAPI3REF: Close A BLOB Handle
  6330. ** DESTRUCTOR: sqlite3_blob
  6331. **
  6332. ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
  6333. ** unconditionally. Even if this routine returns an error code, the
  6334. ** handle is still closed.)^
  6335. **
  6336. ** ^If the blob handle being closed was opened for read-write access, and if
  6337. ** the database is in auto-commit mode and there are no other open read-write
  6338. ** blob handles or active write statements, the current transaction is
  6339. ** committed. ^If an error occurs while committing the transaction, an error
  6340. ** code is returned and the transaction rolled back.
  6341. **
  6342. ** Calling this function with an argument that is not a NULL pointer or an
  6343. ** open blob handle results in undefined behaviour. ^Calling this routine
  6344. ** with a null pointer (such as would be returned by a failed call to
  6345. ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
  6346. ** is passed a valid open blob handle, the values returned by the
  6347. ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
  6348. */
  6349. SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
  6350. /*
  6351. ** CAPI3REF: Return The Size Of An Open BLOB
  6352. ** METHOD: sqlite3_blob
  6353. **
  6354. ** ^Returns the size in bytes of the BLOB accessible via the
  6355. ** successfully opened [BLOB handle] in its only argument. ^The
  6356. ** incremental blob I/O routines can only read or overwriting existing
  6357. ** blob content; they cannot change the size of a blob.
  6358. **
  6359. ** This routine only works on a [BLOB handle] which has been created
  6360. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  6361. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  6362. ** to this routine results in undefined and probably undesirable behavior.
  6363. */
  6364. SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
  6365. /*
  6366. ** CAPI3REF: Read Data From A BLOB Incrementally
  6367. ** METHOD: sqlite3_blob
  6368. **
  6369. ** ^(This function is used to read data from an open [BLOB handle] into a
  6370. ** caller-supplied buffer. N bytes of data are copied into buffer Z
  6371. ** from the open BLOB, starting at offset iOffset.)^
  6372. **
  6373. ** ^If offset iOffset is less than N bytes from the end of the BLOB,
  6374. ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
  6375. ** less than zero, [SQLITE_ERROR] is returned and no data is read.
  6376. ** ^The size of the blob (and hence the maximum value of N+iOffset)
  6377. ** can be determined using the [sqlite3_blob_bytes()] interface.
  6378. **
  6379. ** ^An attempt to read from an expired [BLOB handle] fails with an
  6380. ** error code of [SQLITE_ABORT].
  6381. **
  6382. ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
  6383. ** Otherwise, an [error code] or an [extended error code] is returned.)^
  6384. **
  6385. ** This routine only works on a [BLOB handle] which has been created
  6386. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  6387. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  6388. ** to this routine results in undefined and probably undesirable behavior.
  6389. **
  6390. ** See also: [sqlite3_blob_write()].
  6391. */
  6392. SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
  6393. /*
  6394. ** CAPI3REF: Write Data Into A BLOB Incrementally
  6395. ** METHOD: sqlite3_blob
  6396. **
  6397. ** ^(This function is used to write data into an open [BLOB handle] from a
  6398. ** caller-supplied buffer. N bytes of data are copied from the buffer Z
  6399. ** into the open BLOB, starting at offset iOffset.)^
  6400. **
  6401. ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
  6402. ** Otherwise, an [error code] or an [extended error code] is returned.)^
  6403. ** ^Unless SQLITE_MISUSE is returned, this function sets the
  6404. ** [database connection] error code and message accessible via
  6405. ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
  6406. **
  6407. ** ^If the [BLOB handle] passed as the first argument was not opened for
  6408. ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
  6409. ** this function returns [SQLITE_READONLY].
  6410. **
  6411. ** This function may only modify the contents of the BLOB; it is
  6412. ** not possible to increase the size of a BLOB using this API.
  6413. ** ^If offset iOffset is less than N bytes from the end of the BLOB,
  6414. ** [SQLITE_ERROR] is returned and no data is written. The size of the
  6415. ** BLOB (and hence the maximum value of N+iOffset) can be determined
  6416. ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
  6417. ** than zero [SQLITE_ERROR] is returned and no data is written.
  6418. **
  6419. ** ^An attempt to write to an expired [BLOB handle] fails with an
  6420. ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
  6421. ** before the [BLOB handle] expired are not rolled back by the
  6422. ** expiration of the handle, though of course those changes might
  6423. ** have been overwritten by the statement that expired the BLOB handle
  6424. ** or by other independent statements.
  6425. **
  6426. ** This routine only works on a [BLOB handle] which has been created
  6427. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  6428. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  6429. ** to this routine results in undefined and probably undesirable behavior.
  6430. **
  6431. ** See also: [sqlite3_blob_read()].
  6432. */
  6433. SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
  6434. /*
  6435. ** CAPI3REF: Virtual File System Objects
  6436. **
  6437. ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
  6438. ** that SQLite uses to interact
  6439. ** with the underlying operating system. Most SQLite builds come with a
  6440. ** single default VFS that is appropriate for the host computer.
  6441. ** New VFSes can be registered and existing VFSes can be unregistered.
  6442. ** The following interfaces are provided.
  6443. **
  6444. ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
  6445. ** ^Names are case sensitive.
  6446. ** ^Names are zero-terminated UTF-8 strings.
  6447. ** ^If there is no match, a NULL pointer is returned.
  6448. ** ^If zVfsName is NULL then the default VFS is returned.
  6449. **
  6450. ** ^New VFSes are registered with sqlite3_vfs_register().
  6451. ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
  6452. ** ^The same VFS can be registered multiple times without injury.
  6453. ** ^To make an existing VFS into the default VFS, register it again
  6454. ** with the makeDflt flag set. If two different VFSes with the
  6455. ** same name are registered, the behavior is undefined. If a
  6456. ** VFS is registered with a name that is NULL or an empty string,
  6457. ** then the behavior is undefined.
  6458. **
  6459. ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
  6460. ** ^(If the default VFS is unregistered, another VFS is chosen as
  6461. ** the default. The choice for the new VFS is arbitrary.)^
  6462. */
  6463. SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
  6464. SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
  6465. SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
  6466. /*
  6467. ** CAPI3REF: Mutexes
  6468. **
  6469. ** The SQLite core uses these routines for thread
  6470. ** synchronization. Though they are intended for internal
  6471. ** use by SQLite, code that links against SQLite is
  6472. ** permitted to use any of these routines.
  6473. **
  6474. ** The SQLite source code contains multiple implementations
  6475. ** of these mutex routines. An appropriate implementation
  6476. ** is selected automatically at compile-time. The following
  6477. ** implementations are available in the SQLite core:
  6478. **
  6479. ** <ul>
  6480. ** <li> SQLITE_MUTEX_PTHREADS
  6481. ** <li> SQLITE_MUTEX_W32
  6482. ** <li> SQLITE_MUTEX_NOOP
  6483. ** </ul>
  6484. **
  6485. ** The SQLITE_MUTEX_NOOP implementation is a set of routines
  6486. ** that does no real locking and is appropriate for use in
  6487. ** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
  6488. ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
  6489. ** and Windows.
  6490. **
  6491. ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
  6492. ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
  6493. ** implementation is included with the library. In this case the
  6494. ** application must supply a custom mutex implementation using the
  6495. ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
  6496. ** before calling sqlite3_initialize() or any other public sqlite3_
  6497. ** function that calls sqlite3_initialize().
  6498. **
  6499. ** ^The sqlite3_mutex_alloc() routine allocates a new
  6500. ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
  6501. ** routine returns NULL if it is unable to allocate the requested
  6502. ** mutex. The argument to sqlite3_mutex_alloc() must one of these
  6503. ** integer constants:
  6504. **
  6505. ** <ul>
  6506. ** <li> SQLITE_MUTEX_FAST
  6507. ** <li> SQLITE_MUTEX_RECURSIVE
  6508. ** <li> SQLITE_MUTEX_STATIC_MASTER
  6509. ** <li> SQLITE_MUTEX_STATIC_MEM
  6510. ** <li> SQLITE_MUTEX_STATIC_OPEN
  6511. ** <li> SQLITE_MUTEX_STATIC_PRNG
  6512. ** <li> SQLITE_MUTEX_STATIC_LRU
  6513. ** <li> SQLITE_MUTEX_STATIC_PMEM
  6514. ** <li> SQLITE_MUTEX_STATIC_APP1
  6515. ** <li> SQLITE_MUTEX_STATIC_APP2
  6516. ** <li> SQLITE_MUTEX_STATIC_APP3
  6517. ** <li> SQLITE_MUTEX_STATIC_VFS1
  6518. ** <li> SQLITE_MUTEX_STATIC_VFS2
  6519. ** <li> SQLITE_MUTEX_STATIC_VFS3
  6520. ** </ul>
  6521. **
  6522. ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
  6523. ** cause sqlite3_mutex_alloc() to create
  6524. ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  6525. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  6526. ** The mutex implementation does not need to make a distinction
  6527. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  6528. ** not want to. SQLite will only request a recursive mutex in
  6529. ** cases where it really needs one. If a faster non-recursive mutex
  6530. ** implementation is available on the host platform, the mutex subsystem
  6531. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  6532. **
  6533. ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
  6534. ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
  6535. ** a pointer to a static preexisting mutex. ^Nine static mutexes are
  6536. ** used by the current version of SQLite. Future versions of SQLite
  6537. ** may add additional static mutexes. Static mutexes are for internal
  6538. ** use by SQLite only. Applications that use SQLite mutexes should
  6539. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  6540. ** SQLITE_MUTEX_RECURSIVE.
  6541. **
  6542. ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  6543. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  6544. ** returns a different mutex on every call. ^For the static
  6545. ** mutex types, the same mutex is returned on every call that has
  6546. ** the same type number.
  6547. **
  6548. ** ^The sqlite3_mutex_free() routine deallocates a previously
  6549. ** allocated dynamic mutex. Attempting to deallocate a static
  6550. ** mutex results in undefined behavior.
  6551. **
  6552. ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  6553. ** to enter a mutex. ^If another thread is already within the mutex,
  6554. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  6555. ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
  6556. ** upon successful entry. ^(Mutexes created using
  6557. ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
  6558. ** In such cases, the
  6559. ** mutex must be exited an equal number of times before another thread
  6560. ** can enter.)^ If the same thread tries to enter any mutex other
  6561. ** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
  6562. **
  6563. ** ^(Some systems (for example, Windows 95) do not support the operation
  6564. ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
  6565. ** will always return SQLITE_BUSY. The SQLite core only ever uses
  6566. ** sqlite3_mutex_try() as an optimization so this is acceptable
  6567. ** behavior.)^
  6568. **
  6569. ** ^The sqlite3_mutex_leave() routine exits a mutex that was
  6570. ** previously entered by the same thread. The behavior
  6571. ** is undefined if the mutex is not currently entered by the
  6572. ** calling thread or is not currently allocated.
  6573. **
  6574. ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
  6575. ** sqlite3_mutex_leave() is a NULL pointer, then all three routines
  6576. ** behave as no-ops.
  6577. **
  6578. ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
  6579. */
  6580. SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
  6581. SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
  6582. SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
  6583. SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
  6584. SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
  6585. /*
  6586. ** CAPI3REF: Mutex Methods Object
  6587. **
  6588. ** An instance of this structure defines the low-level routines
  6589. ** used to allocate and use mutexes.
  6590. **
  6591. ** Usually, the default mutex implementations provided by SQLite are
  6592. ** sufficient, however the application has the option of substituting a custom
  6593. ** implementation for specialized deployments or systems for which SQLite
  6594. ** does not provide a suitable implementation. In this case, the application
  6595. ** creates and populates an instance of this structure to pass
  6596. ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
  6597. ** Additionally, an instance of this structure can be used as an
  6598. ** output variable when querying the system for the current mutex
  6599. ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
  6600. **
  6601. ** ^The xMutexInit method defined by this structure is invoked as
  6602. ** part of system initialization by the sqlite3_initialize() function.
  6603. ** ^The xMutexInit routine is called by SQLite exactly once for each
  6604. ** effective call to [sqlite3_initialize()].
  6605. **
  6606. ** ^The xMutexEnd method defined by this structure is invoked as
  6607. ** part of system shutdown by the sqlite3_shutdown() function. The
  6608. ** implementation of this method is expected to release all outstanding
  6609. ** resources obtained by the mutex methods implementation, especially
  6610. ** those obtained by the xMutexInit method. ^The xMutexEnd()
  6611. ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
  6612. **
  6613. ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
  6614. ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
  6615. ** xMutexNotheld) implement the following interfaces (respectively):
  6616. **
  6617. ** <ul>
  6618. ** <li> [sqlite3_mutex_alloc()] </li>
  6619. ** <li> [sqlite3_mutex_free()] </li>
  6620. ** <li> [sqlite3_mutex_enter()] </li>
  6621. ** <li> [sqlite3_mutex_try()] </li>
  6622. ** <li> [sqlite3_mutex_leave()] </li>
  6623. ** <li> [sqlite3_mutex_held()] </li>
  6624. ** <li> [sqlite3_mutex_notheld()] </li>
  6625. ** </ul>)^
  6626. **
  6627. ** The only difference is that the public sqlite3_XXX functions enumerated
  6628. ** above silently ignore any invocations that pass a NULL pointer instead
  6629. ** of a valid mutex handle. The implementations of the methods defined
  6630. ** by this structure are not required to handle this case, the results
  6631. ** of passing a NULL pointer instead of a valid mutex handle are undefined
  6632. ** (i.e. it is acceptable to provide an implementation that segfaults if
  6633. ** it is passed a NULL pointer).
  6634. **
  6635. ** The xMutexInit() method must be threadsafe. It must be harmless to
  6636. ** invoke xMutexInit() multiple times within the same process and without
  6637. ** intervening calls to xMutexEnd(). Second and subsequent calls to
  6638. ** xMutexInit() must be no-ops.
  6639. **
  6640. ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
  6641. ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
  6642. ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
  6643. ** memory allocation for a fast or recursive mutex.
  6644. **
  6645. ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
  6646. ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
  6647. ** If xMutexInit fails in any way, it is expected to clean up after itself
  6648. ** prior to returning.
  6649. */
  6650. typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
  6651. struct sqlite3_mutex_methods {
  6652. int (*xMutexInit)(void);
  6653. int (*xMutexEnd)(void);
  6654. sqlite3_mutex *(*xMutexAlloc)(int);
  6655. void (*xMutexFree)(sqlite3_mutex *);
  6656. void (*xMutexEnter)(sqlite3_mutex *);
  6657. int (*xMutexTry)(sqlite3_mutex *);
  6658. void (*xMutexLeave)(sqlite3_mutex *);
  6659. int (*xMutexHeld)(sqlite3_mutex *);
  6660. int (*xMutexNotheld)(sqlite3_mutex *);
  6661. };
  6662. /*
  6663. ** CAPI3REF: Mutex Verification Routines
  6664. **
  6665. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
  6666. ** are intended for use inside assert() statements. The SQLite core
  6667. ** never uses these routines except inside an assert() and applications
  6668. ** are advised to follow the lead of the core. The SQLite core only
  6669. ** provides implementations for these routines when it is compiled
  6670. ** with the SQLITE_DEBUG flag. External mutex implementations
  6671. ** are only required to provide these routines if SQLITE_DEBUG is
  6672. ** defined and if NDEBUG is not defined.
  6673. **
  6674. ** These routines should return true if the mutex in their argument
  6675. ** is held or not held, respectively, by the calling thread.
  6676. **
  6677. ** The implementation is not required to provide versions of these
  6678. ** routines that actually work. If the implementation does not provide working
  6679. ** versions of these routines, it should at least provide stubs that always
  6680. ** return true so that one does not get spurious assertion failures.
  6681. **
  6682. ** If the argument to sqlite3_mutex_held() is a NULL pointer then
  6683. ** the routine should return 1. This seems counter-intuitive since
  6684. ** clearly the mutex cannot be held if it does not exist. But
  6685. ** the reason the mutex does not exist is because the build is not
  6686. ** using mutexes. And we do not want the assert() containing the
  6687. ** call to sqlite3_mutex_held() to fail, so a non-zero return is
  6688. ** the appropriate thing to do. The sqlite3_mutex_notheld()
  6689. ** interface should also return 1 when given a NULL pointer.
  6690. */
  6691. #ifndef NDEBUG
  6692. SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
  6693. SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
  6694. #endif
  6695. /*
  6696. ** CAPI3REF: Mutex Types
  6697. **
  6698. ** The [sqlite3_mutex_alloc()] interface takes a single argument
  6699. ** which is one of these integer constants.
  6700. **
  6701. ** The set of static mutexes may change from one SQLite release to the
  6702. ** next. Applications that override the built-in mutex logic must be
  6703. ** prepared to accommodate additional static mutexes.
  6704. */
  6705. #define SQLITE_MUTEX_FAST 0
  6706. #define SQLITE_MUTEX_RECURSIVE 1
  6707. #define SQLITE_MUTEX_STATIC_MASTER 2
  6708. #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
  6709. #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
  6710. #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
  6711. #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
  6712. #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
  6713. #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
  6714. #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
  6715. #define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
  6716. #define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
  6717. #define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
  6718. #define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
  6719. #define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
  6720. #define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
  6721. /*
  6722. ** CAPI3REF: Retrieve the mutex for a database connection
  6723. ** METHOD: sqlite3
  6724. **
  6725. ** ^This interface returns a pointer the [sqlite3_mutex] object that
  6726. ** serializes access to the [database connection] given in the argument
  6727. ** when the [threading mode] is Serialized.
  6728. ** ^If the [threading mode] is Single-thread or Multi-thread then this
  6729. ** routine returns a NULL pointer.
  6730. */
  6731. SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
  6732. /*
  6733. ** CAPI3REF: Low-Level Control Of Database Files
  6734. ** METHOD: sqlite3
  6735. **
  6736. ** ^The [sqlite3_file_control()] interface makes a direct call to the
  6737. ** xFileControl method for the [sqlite3_io_methods] object associated
  6738. ** with a particular database identified by the second argument. ^The
  6739. ** name of the database is "main" for the main database or "temp" for the
  6740. ** TEMP database, or the name that appears after the AS keyword for
  6741. ** databases that are added using the [ATTACH] SQL command.
  6742. ** ^A NULL pointer can be used in place of "main" to refer to the
  6743. ** main database file.
  6744. ** ^The third and fourth parameters to this routine
  6745. ** are passed directly through to the second and third parameters of
  6746. ** the xFileControl method. ^The return value of the xFileControl
  6747. ** method becomes the return value of this routine.
  6748. **
  6749. ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
  6750. ** a pointer to the underlying [sqlite3_file] object to be written into
  6751. ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER
  6752. ** case is a short-circuit path which does not actually invoke the
  6753. ** underlying sqlite3_io_methods.xFileControl method.
  6754. **
  6755. ** ^If the second parameter (zDbName) does not match the name of any
  6756. ** open database file, then SQLITE_ERROR is returned. ^This error
  6757. ** code is not remembered and will not be recalled by [sqlite3_errcode()]
  6758. ** or [sqlite3_errmsg()]. The underlying xFileControl method might
  6759. ** also return SQLITE_ERROR. There is no way to distinguish between
  6760. ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
  6761. ** xFileControl method.
  6762. **
  6763. ** See also: [SQLITE_FCNTL_LOCKSTATE]
  6764. */
  6765. SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
  6766. /*
  6767. ** CAPI3REF: Testing Interface
  6768. **
  6769. ** ^The sqlite3_test_control() interface is used to read out internal
  6770. ** state of SQLite and to inject faults into SQLite for testing
  6771. ** purposes. ^The first parameter is an operation code that determines
  6772. ** the number, meaning, and operation of all subsequent parameters.
  6773. **
  6774. ** This interface is not for use by applications. It exists solely
  6775. ** for verifying the correct operation of the SQLite library. Depending
  6776. ** on how the SQLite library is compiled, this interface might not exist.
  6777. **
  6778. ** The details of the operation codes, their meanings, the parameters
  6779. ** they take, and what they do are all subject to change without notice.
  6780. ** Unlike most of the SQLite API, this function is not guaranteed to
  6781. ** operate consistently from one release to the next.
  6782. */
  6783. SQLITE_API int sqlite3_test_control(int op, ...);
  6784. /*
  6785. ** CAPI3REF: Testing Interface Operation Codes
  6786. **
  6787. ** These constants are the valid operation code parameters used
  6788. ** as the first argument to [sqlite3_test_control()].
  6789. **
  6790. ** These parameters and their meanings are subject to change
  6791. ** without notice. These values are for testing purposes only.
  6792. ** Applications should not use any of these parameters or the
  6793. ** [sqlite3_test_control()] interface.
  6794. */
  6795. #define SQLITE_TESTCTRL_FIRST 5
  6796. #define SQLITE_TESTCTRL_PRNG_SAVE 5
  6797. #define SQLITE_TESTCTRL_PRNG_RESTORE 6
  6798. #define SQLITE_TESTCTRL_PRNG_RESET 7
  6799. #define SQLITE_TESTCTRL_BITVEC_TEST 8
  6800. #define SQLITE_TESTCTRL_FAULT_INSTALL 9
  6801. #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
  6802. #define SQLITE_TESTCTRL_PENDING_BYTE 11
  6803. #define SQLITE_TESTCTRL_ASSERT 12
  6804. #define SQLITE_TESTCTRL_ALWAYS 13
  6805. #define SQLITE_TESTCTRL_RESERVE 14
  6806. #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
  6807. #define SQLITE_TESTCTRL_ISKEYWORD 16
  6808. #define SQLITE_TESTCTRL_SCRATCHMALLOC 17
  6809. #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
  6810. #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
  6811. #define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19
  6812. #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
  6813. #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
  6814. #define SQLITE_TESTCTRL_BYTEORDER 22
  6815. #define SQLITE_TESTCTRL_ISINIT 23
  6816. #define SQLITE_TESTCTRL_SORTER_MMAP 24
  6817. #define SQLITE_TESTCTRL_IMPOSTER 25
  6818. #define SQLITE_TESTCTRL_LAST 25
  6819. /*
  6820. ** CAPI3REF: SQLite Runtime Status
  6821. **
  6822. ** ^These interfaces are used to retrieve runtime status information
  6823. ** about the performance of SQLite, and optionally to reset various
  6824. ** highwater marks. ^The first argument is an integer code for
  6825. ** the specific parameter to measure. ^(Recognized integer codes
  6826. ** are of the form [status parameters | SQLITE_STATUS_...].)^
  6827. ** ^The current value of the parameter is returned into *pCurrent.
  6828. ** ^The highest recorded value is returned in *pHighwater. ^If the
  6829. ** resetFlag is true, then the highest record value is reset after
  6830. ** *pHighwater is written. ^(Some parameters do not record the highest
  6831. ** value. For those parameters
  6832. ** nothing is written into *pHighwater and the resetFlag is ignored.)^
  6833. ** ^(Other parameters record only the highwater mark and not the current
  6834. ** value. For these latter parameters nothing is written into *pCurrent.)^
  6835. **
  6836. ** ^The sqlite3_status() and sqlite3_status64() routines return
  6837. ** SQLITE_OK on success and a non-zero [error code] on failure.
  6838. **
  6839. ** If either the current value or the highwater mark is too large to
  6840. ** be represented by a 32-bit integer, then the values returned by
  6841. ** sqlite3_status() are undefined.
  6842. **
  6843. ** See also: [sqlite3_db_status()]
  6844. */
  6845. SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
  6846. SQLITE_API int sqlite3_status64(
  6847. int op,
  6848. sqlite3_int64 *pCurrent,
  6849. sqlite3_int64 *pHighwater,
  6850. int resetFlag
  6851. );
  6852. /*
  6853. ** CAPI3REF: Status Parameters
  6854. ** KEYWORDS: {status parameters}
  6855. **
  6856. ** These integer constants designate various run-time status parameters
  6857. ** that can be returned by [sqlite3_status()].
  6858. **
  6859. ** <dl>
  6860. ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
  6861. ** <dd>This parameter is the current amount of memory checked out
  6862. ** using [sqlite3_malloc()], either directly or indirectly. The
  6863. ** figure includes calls made to [sqlite3_malloc()] by the application
  6864. ** and internal memory usage by the SQLite library. Scratch memory
  6865. ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
  6866. ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
  6867. ** this parameter. The amount returned is the sum of the allocation
  6868. ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
  6869. **
  6870. ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
  6871. ** <dd>This parameter records the largest memory allocation request
  6872. ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
  6873. ** internal equivalents). Only the value returned in the
  6874. ** *pHighwater parameter to [sqlite3_status()] is of interest.
  6875. ** The value written into the *pCurrent parameter is undefined.</dd>)^
  6876. **
  6877. ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
  6878. ** <dd>This parameter records the number of separate memory allocations
  6879. ** currently checked out.</dd>)^
  6880. **
  6881. ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
  6882. ** <dd>This parameter returns the number of pages used out of the
  6883. ** [pagecache memory allocator] that was configured using
  6884. ** [SQLITE_CONFIG_PAGECACHE]. The
  6885. ** value returned is in pages, not in bytes.</dd>)^
  6886. **
  6887. ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
  6888. ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
  6889. ** <dd>This parameter returns the number of bytes of page cache
  6890. ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
  6891. ** buffer and where forced to overflow to [sqlite3_malloc()]. The
  6892. ** returned value includes allocations that overflowed because they
  6893. ** where too large (they were larger than the "sz" parameter to
  6894. ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
  6895. ** no space was left in the page cache.</dd>)^
  6896. **
  6897. ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
  6898. ** <dd>This parameter records the largest memory allocation request
  6899. ** handed to [pagecache memory allocator]. Only the value returned in the
  6900. ** *pHighwater parameter to [sqlite3_status()] is of interest.
  6901. ** The value written into the *pCurrent parameter is undefined.</dd>)^
  6902. **
  6903. ** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
  6904. ** <dd>This parameter returns the number of allocations used out of the
  6905. ** [scratch memory allocator] configured using
  6906. ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
  6907. ** in bytes. Since a single thread may only have one scratch allocation
  6908. ** outstanding at time, this parameter also reports the number of threads
  6909. ** using scratch memory at the same time.</dd>)^
  6910. **
  6911. ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
  6912. ** <dd>This parameter returns the number of bytes of scratch memory
  6913. ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
  6914. ** buffer and where forced to overflow to [sqlite3_malloc()]. The values
  6915. ** returned include overflows because the requested allocation was too
  6916. ** larger (that is, because the requested allocation was larger than the
  6917. ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
  6918. ** slots were available.
  6919. ** </dd>)^
  6920. **
  6921. ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
  6922. ** <dd>This parameter records the largest memory allocation request
  6923. ** handed to [scratch memory allocator]. Only the value returned in the
  6924. ** *pHighwater parameter to [sqlite3_status()] is of interest.
  6925. ** The value written into the *pCurrent parameter is undefined.</dd>)^
  6926. **
  6927. ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
  6928. ** <dd>The *pHighwater parameter records the deepest parser stack.
  6929. ** The *pCurrent value is undefined. The *pHighwater value is only
  6930. ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
  6931. ** </dl>
  6932. **
  6933. ** New status parameters may be added from time to time.
  6934. */
  6935. #define SQLITE_STATUS_MEMORY_USED 0
  6936. #define SQLITE_STATUS_PAGECACHE_USED 1
  6937. #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
  6938. #define SQLITE_STATUS_SCRATCH_USED 3
  6939. #define SQLITE_STATUS_SCRATCH_OVERFLOW 4
  6940. #define SQLITE_STATUS_MALLOC_SIZE 5
  6941. #define SQLITE_STATUS_PARSER_STACK 6
  6942. #define SQLITE_STATUS_PAGECACHE_SIZE 7
  6943. #define SQLITE_STATUS_SCRATCH_SIZE 8
  6944. #define SQLITE_STATUS_MALLOC_COUNT 9
  6945. /*
  6946. ** CAPI3REF: Database Connection Status
  6947. ** METHOD: sqlite3
  6948. **
  6949. ** ^This interface is used to retrieve runtime status information
  6950. ** about a single [database connection]. ^The first argument is the
  6951. ** database connection object to be interrogated. ^The second argument
  6952. ** is an integer constant, taken from the set of
  6953. ** [SQLITE_DBSTATUS options], that
  6954. ** determines the parameter to interrogate. The set of
  6955. ** [SQLITE_DBSTATUS options] is likely
  6956. ** to grow in future releases of SQLite.
  6957. **
  6958. ** ^The current value of the requested parameter is written into *pCur
  6959. ** and the highest instantaneous value is written into *pHiwtr. ^If
  6960. ** the resetFlg is true, then the highest instantaneous value is
  6961. ** reset back down to the current value.
  6962. **
  6963. ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
  6964. ** non-zero [error code] on failure.
  6965. **
  6966. ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
  6967. */
  6968. SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
  6969. /*
  6970. ** CAPI3REF: Status Parameters for database connections
  6971. ** KEYWORDS: {SQLITE_DBSTATUS options}
  6972. **
  6973. ** These constants are the available integer "verbs" that can be passed as
  6974. ** the second argument to the [sqlite3_db_status()] interface.
  6975. **
  6976. ** New verbs may be added in future releases of SQLite. Existing verbs
  6977. ** might be discontinued. Applications should check the return code from
  6978. ** [sqlite3_db_status()] to make sure that the call worked.
  6979. ** The [sqlite3_db_status()] interface will return a non-zero error code
  6980. ** if a discontinued or unsupported verb is invoked.
  6981. **
  6982. ** <dl>
  6983. ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
  6984. ** <dd>This parameter returns the number of lookaside memory slots currently
  6985. ** checked out.</dd>)^
  6986. **
  6987. ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
  6988. ** <dd>This parameter returns the number malloc attempts that were
  6989. ** satisfied using lookaside memory. Only the high-water value is meaningful;
  6990. ** the current value is always zero.)^
  6991. **
  6992. ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
  6993. ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
  6994. ** <dd>This parameter returns the number malloc attempts that might have
  6995. ** been satisfied using lookaside memory but failed due to the amount of
  6996. ** memory requested being larger than the lookaside slot size.
  6997. ** Only the high-water value is meaningful;
  6998. ** the current value is always zero.)^
  6999. **
  7000. ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
  7001. ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
  7002. ** <dd>This parameter returns the number malloc attempts that might have
  7003. ** been satisfied using lookaside memory but failed due to all lookaside
  7004. ** memory already being in use.
  7005. ** Only the high-water value is meaningful;
  7006. ** the current value is always zero.)^
  7007. **
  7008. ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
  7009. ** <dd>This parameter returns the approximate number of bytes of heap
  7010. ** memory used by all pager caches associated with the database connection.)^
  7011. ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
  7012. **
  7013. ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
  7014. ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
  7015. ** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
  7016. ** pager cache is shared between two or more connections the bytes of heap
  7017. ** memory used by that pager cache is divided evenly between the attached
  7018. ** connections.)^ In other words, if none of the pager caches associated
  7019. ** with the database connection are shared, this request returns the same
  7020. ** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
  7021. ** shared, the value returned by this call will be smaller than that returned
  7022. ** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
  7023. ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
  7024. **
  7025. ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
  7026. ** <dd>This parameter returns the approximate number of bytes of heap
  7027. ** memory used to store the schema for all databases associated
  7028. ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
  7029. ** ^The full amount of memory used by the schemas is reported, even if the
  7030. ** schema memory is shared with other database connections due to
  7031. ** [shared cache mode] being enabled.
  7032. ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
  7033. **
  7034. ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
  7035. ** <dd>This parameter returns the approximate number of bytes of heap
  7036. ** and lookaside memory used by all prepared statements associated with
  7037. ** the database connection.)^
  7038. ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
  7039. ** </dd>
  7040. **
  7041. ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
  7042. ** <dd>This parameter returns the number of pager cache hits that have
  7043. ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
  7044. ** is always 0.
  7045. ** </dd>
  7046. **
  7047. ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
  7048. ** <dd>This parameter returns the number of pager cache misses that have
  7049. ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
  7050. ** is always 0.
  7051. ** </dd>
  7052. **
  7053. ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
  7054. ** <dd>This parameter returns the number of dirty cache entries that have
  7055. ** been written to disk. Specifically, the number of pages written to the
  7056. ** wal file in wal mode databases, or the number of pages written to the
  7057. ** database file in rollback mode databases. Any pages written as part of
  7058. ** transaction rollback or database recovery operations are not included.
  7059. ** If an IO or other error occurs while writing a page to disk, the effect
  7060. ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
  7061. ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
  7062. ** </dd>
  7063. **
  7064. ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
  7065. ** <dd>This parameter returns zero for the current value if and only if
  7066. ** all foreign key constraints (deferred or immediate) have been
  7067. ** resolved.)^ ^The highwater mark is always 0.
  7068. ** </dd>
  7069. ** </dl>
  7070. */
  7071. #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
  7072. #define SQLITE_DBSTATUS_CACHE_USED 1
  7073. #define SQLITE_DBSTATUS_SCHEMA_USED 2
  7074. #define SQLITE_DBSTATUS_STMT_USED 3
  7075. #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
  7076. #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
  7077. #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
  7078. #define SQLITE_DBSTATUS_CACHE_HIT 7
  7079. #define SQLITE_DBSTATUS_CACHE_MISS 8
  7080. #define SQLITE_DBSTATUS_CACHE_WRITE 9
  7081. #define SQLITE_DBSTATUS_DEFERRED_FKS 10
  7082. #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
  7083. #define SQLITE_DBSTATUS_MAX 11 /* Largest defined DBSTATUS */
  7084. /*
  7085. ** CAPI3REF: Prepared Statement Status
  7086. ** METHOD: sqlite3_stmt
  7087. **
  7088. ** ^(Each prepared statement maintains various
  7089. ** [SQLITE_STMTSTATUS counters] that measure the number
  7090. ** of times it has performed specific operations.)^ These counters can
  7091. ** be used to monitor the performance characteristics of the prepared
  7092. ** statements. For example, if the number of table steps greatly exceeds
  7093. ** the number of table searches or result rows, that would tend to indicate
  7094. ** that the prepared statement is using a full table scan rather than
  7095. ** an index.
  7096. **
  7097. ** ^(This interface is used to retrieve and reset counter values from
  7098. ** a [prepared statement]. The first argument is the prepared statement
  7099. ** object to be interrogated. The second argument
  7100. ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
  7101. ** to be interrogated.)^
  7102. ** ^The current value of the requested counter is returned.
  7103. ** ^If the resetFlg is true, then the counter is reset to zero after this
  7104. ** interface call returns.
  7105. **
  7106. ** See also: [sqlite3_status()] and [sqlite3_db_status()].
  7107. */
  7108. SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
  7109. /*
  7110. ** CAPI3REF: Status Parameters for prepared statements
  7111. ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
  7112. **
  7113. ** These preprocessor macros define integer codes that name counter
  7114. ** values associated with the [sqlite3_stmt_status()] interface.
  7115. ** The meanings of the various counters are as follows:
  7116. **
  7117. ** <dl>
  7118. ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
  7119. ** <dd>^This is the number of times that SQLite has stepped forward in
  7120. ** a table as part of a full table scan. Large numbers for this counter
  7121. ** may indicate opportunities for performance improvement through
  7122. ** careful use of indices.</dd>
  7123. **
  7124. ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
  7125. ** <dd>^This is the number of sort operations that have occurred.
  7126. ** A non-zero value in this counter may indicate an opportunity to
  7127. ** improvement performance through careful use of indices.</dd>
  7128. **
  7129. ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
  7130. ** <dd>^This is the number of rows inserted into transient indices that
  7131. ** were created automatically in order to help joins run faster.
  7132. ** A non-zero value in this counter may indicate an opportunity to
  7133. ** improvement performance by adding permanent indices that do not
  7134. ** need to be reinitialized each time the statement is run.</dd>
  7135. **
  7136. ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
  7137. ** <dd>^This is the number of virtual machine operations executed
  7138. ** by the prepared statement if that number is less than or equal
  7139. ** to 2147483647. The number of virtual machine operations can be
  7140. ** used as a proxy for the total work done by the prepared statement.
  7141. ** If the number of virtual machine operations exceeds 2147483647
  7142. ** then the value returned by this statement status code is undefined.
  7143. ** </dd>
  7144. ** </dl>
  7145. */
  7146. #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
  7147. #define SQLITE_STMTSTATUS_SORT 2
  7148. #define SQLITE_STMTSTATUS_AUTOINDEX 3
  7149. #define SQLITE_STMTSTATUS_VM_STEP 4
  7150. /*
  7151. ** CAPI3REF: Custom Page Cache Object
  7152. **
  7153. ** The sqlite3_pcache type is opaque. It is implemented by
  7154. ** the pluggable module. The SQLite core has no knowledge of
  7155. ** its size or internal structure and never deals with the
  7156. ** sqlite3_pcache object except by holding and passing pointers
  7157. ** to the object.
  7158. **
  7159. ** See [sqlite3_pcache_methods2] for additional information.
  7160. */
  7161. typedef struct sqlite3_pcache sqlite3_pcache;
  7162. /*
  7163. ** CAPI3REF: Custom Page Cache Object
  7164. **
  7165. ** The sqlite3_pcache_page object represents a single page in the
  7166. ** page cache. The page cache will allocate instances of this
  7167. ** object. Various methods of the page cache use pointers to instances
  7168. ** of this object as parameters or as their return value.
  7169. **
  7170. ** See [sqlite3_pcache_methods2] for additional information.
  7171. */
  7172. typedef struct sqlite3_pcache_page sqlite3_pcache_page;
  7173. struct sqlite3_pcache_page {
  7174. void *pBuf; /* The content of the page */
  7175. void *pExtra; /* Extra information associated with the page */
  7176. };
  7177. /*
  7178. ** CAPI3REF: Application Defined Page Cache.
  7179. ** KEYWORDS: {page cache}
  7180. **
  7181. ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
  7182. ** register an alternative page cache implementation by passing in an
  7183. ** instance of the sqlite3_pcache_methods2 structure.)^
  7184. ** In many applications, most of the heap memory allocated by
  7185. ** SQLite is used for the page cache.
  7186. ** By implementing a
  7187. ** custom page cache using this API, an application can better control
  7188. ** the amount of memory consumed by SQLite, the way in which
  7189. ** that memory is allocated and released, and the policies used to
  7190. ** determine exactly which parts of a database file are cached and for
  7191. ** how long.
  7192. **
  7193. ** The alternative page cache mechanism is an
  7194. ** extreme measure that is only needed by the most demanding applications.
  7195. ** The built-in page cache is recommended for most uses.
  7196. **
  7197. ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
  7198. ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
  7199. ** the application may discard the parameter after the call to
  7200. ** [sqlite3_config()] returns.)^
  7201. **
  7202. ** [[the xInit() page cache method]]
  7203. ** ^(The xInit() method is called once for each effective
  7204. ** call to [sqlite3_initialize()])^
  7205. ** (usually only once during the lifetime of the process). ^(The xInit()
  7206. ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
  7207. ** The intent of the xInit() method is to set up global data structures
  7208. ** required by the custom page cache implementation.
  7209. ** ^(If the xInit() method is NULL, then the
  7210. ** built-in default page cache is used instead of the application defined
  7211. ** page cache.)^
  7212. **
  7213. ** [[the xShutdown() page cache method]]
  7214. ** ^The xShutdown() method is called by [sqlite3_shutdown()].
  7215. ** It can be used to clean up
  7216. ** any outstanding resources before process shutdown, if required.
  7217. ** ^The xShutdown() method may be NULL.
  7218. **
  7219. ** ^SQLite automatically serializes calls to the xInit method,
  7220. ** so the xInit method need not be threadsafe. ^The
  7221. ** xShutdown method is only called from [sqlite3_shutdown()] so it does
  7222. ** not need to be threadsafe either. All other methods must be threadsafe
  7223. ** in multithreaded applications.
  7224. **
  7225. ** ^SQLite will never invoke xInit() more than once without an intervening
  7226. ** call to xShutdown().
  7227. **
  7228. ** [[the xCreate() page cache methods]]
  7229. ** ^SQLite invokes the xCreate() method to construct a new cache instance.
  7230. ** SQLite will typically create one cache instance for each open database file,
  7231. ** though this is not guaranteed. ^The
  7232. ** first parameter, szPage, is the size in bytes of the pages that must
  7233. ** be allocated by the cache. ^szPage will always a power of two. ^The
  7234. ** second parameter szExtra is a number of bytes of extra storage
  7235. ** associated with each page cache entry. ^The szExtra parameter will
  7236. ** a number less than 250. SQLite will use the
  7237. ** extra szExtra bytes on each page to store metadata about the underlying
  7238. ** database page on disk. The value passed into szExtra depends
  7239. ** on the SQLite version, the target platform, and how SQLite was compiled.
  7240. ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
  7241. ** created will be used to cache database pages of a file stored on disk, or
  7242. ** false if it is used for an in-memory database. The cache implementation
  7243. ** does not have to do anything special based with the value of bPurgeable;
  7244. ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
  7245. ** never invoke xUnpin() except to deliberately delete a page.
  7246. ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
  7247. ** false will always have the "discard" flag set to true.
  7248. ** ^Hence, a cache created with bPurgeable false will
  7249. ** never contain any unpinned pages.
  7250. **
  7251. ** [[the xCachesize() page cache method]]
  7252. ** ^(The xCachesize() method may be called at any time by SQLite to set the
  7253. ** suggested maximum cache-size (number of pages stored by) the cache
  7254. ** instance passed as the first argument. This is the value configured using
  7255. ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
  7256. ** parameter, the implementation is not required to do anything with this
  7257. ** value; it is advisory only.
  7258. **
  7259. ** [[the xPagecount() page cache methods]]
  7260. ** The xPagecount() method must return the number of pages currently
  7261. ** stored in the cache, both pinned and unpinned.
  7262. **
  7263. ** [[the xFetch() page cache methods]]
  7264. ** The xFetch() method locates a page in the cache and returns a pointer to
  7265. ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
  7266. ** The pBuf element of the returned sqlite3_pcache_page object will be a
  7267. ** pointer to a buffer of szPage bytes used to store the content of a
  7268. ** single database page. The pExtra element of sqlite3_pcache_page will be
  7269. ** a pointer to the szExtra bytes of extra storage that SQLite has requested
  7270. ** for each entry in the page cache.
  7271. **
  7272. ** The page to be fetched is determined by the key. ^The minimum key value
  7273. ** is 1. After it has been retrieved using xFetch, the page is considered
  7274. ** to be "pinned".
  7275. **
  7276. ** If the requested page is already in the page cache, then the page cache
  7277. ** implementation must return a pointer to the page buffer with its content
  7278. ** intact. If the requested page is not already in the cache, then the
  7279. ** cache implementation should use the value of the createFlag
  7280. ** parameter to help it determined what action to take:
  7281. **
  7282. ** <table border=1 width=85% align=center>
  7283. ** <tr><th> createFlag <th> Behavior when page is not already in cache
  7284. ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
  7285. ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
  7286. ** Otherwise return NULL.
  7287. ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
  7288. ** NULL if allocating a new page is effectively impossible.
  7289. ** </table>
  7290. **
  7291. ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
  7292. ** will only use a createFlag of 2 after a prior call with a createFlag of 1
  7293. ** failed.)^ In between the to xFetch() calls, SQLite may
  7294. ** attempt to unpin one or more cache pages by spilling the content of
  7295. ** pinned pages to disk and synching the operating system disk cache.
  7296. **
  7297. ** [[the xUnpin() page cache method]]
  7298. ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
  7299. ** as its second argument. If the third parameter, discard, is non-zero,
  7300. ** then the page must be evicted from the cache.
  7301. ** ^If the discard parameter is
  7302. ** zero, then the page may be discarded or retained at the discretion of
  7303. ** page cache implementation. ^The page cache implementation
  7304. ** may choose to evict unpinned pages at any time.
  7305. **
  7306. ** The cache must not perform any reference counting. A single
  7307. ** call to xUnpin() unpins the page regardless of the number of prior calls
  7308. ** to xFetch().
  7309. **
  7310. ** [[the xRekey() page cache methods]]
  7311. ** The xRekey() method is used to change the key value associated with the
  7312. ** page passed as the second argument. If the cache
  7313. ** previously contains an entry associated with newKey, it must be
  7314. ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
  7315. ** to be pinned.
  7316. **
  7317. ** When SQLite calls the xTruncate() method, the cache must discard all
  7318. ** existing cache entries with page numbers (keys) greater than or equal
  7319. ** to the value of the iLimit parameter passed to xTruncate(). If any
  7320. ** of these pages are pinned, they are implicitly unpinned, meaning that
  7321. ** they can be safely discarded.
  7322. **
  7323. ** [[the xDestroy() page cache method]]
  7324. ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
  7325. ** All resources associated with the specified cache should be freed. ^After
  7326. ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
  7327. ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
  7328. ** functions.
  7329. **
  7330. ** [[the xShrink() page cache method]]
  7331. ** ^SQLite invokes the xShrink() method when it wants the page cache to
  7332. ** free up as much of heap memory as possible. The page cache implementation
  7333. ** is not obligated to free any memory, but well-behaved implementations should
  7334. ** do their best.
  7335. */
  7336. typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
  7337. struct sqlite3_pcache_methods2 {
  7338. int iVersion;
  7339. void *pArg;
  7340. int (*xInit)(void*);
  7341. void (*xShutdown)(void*);
  7342. sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
  7343. void (*xCachesize)(sqlite3_pcache*, int nCachesize);
  7344. int (*xPagecount)(sqlite3_pcache*);
  7345. sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
  7346. void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
  7347. void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
  7348. unsigned oldKey, unsigned newKey);
  7349. void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
  7350. void (*xDestroy)(sqlite3_pcache*);
  7351. void (*xShrink)(sqlite3_pcache*);
  7352. };
  7353. /*
  7354. ** This is the obsolete pcache_methods object that has now been replaced
  7355. ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
  7356. ** retained in the header file for backwards compatibility only.
  7357. */
  7358. typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
  7359. struct sqlite3_pcache_methods {
  7360. void *pArg;
  7361. int (*xInit)(void*);
  7362. void (*xShutdown)(void*);
  7363. sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
  7364. void (*xCachesize)(sqlite3_pcache*, int nCachesize);
  7365. int (*xPagecount)(sqlite3_pcache*);
  7366. void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
  7367. void (*xUnpin)(sqlite3_pcache*, void*, int discard);
  7368. void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
  7369. void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
  7370. void (*xDestroy)(sqlite3_pcache*);
  7371. };
  7372. /*
  7373. ** CAPI3REF: Online Backup Object
  7374. **
  7375. ** The sqlite3_backup object records state information about an ongoing
  7376. ** online backup operation. ^The sqlite3_backup object is created by
  7377. ** a call to [sqlite3_backup_init()] and is destroyed by a call to
  7378. ** [sqlite3_backup_finish()].
  7379. **
  7380. ** See Also: [Using the SQLite Online Backup API]
  7381. */
  7382. typedef struct sqlite3_backup sqlite3_backup;
  7383. /*
  7384. ** CAPI3REF: Online Backup API.
  7385. **
  7386. ** The backup API copies the content of one database into another.
  7387. ** It is useful either for creating backups of databases or
  7388. ** for copying in-memory databases to or from persistent files.
  7389. **
  7390. ** See Also: [Using the SQLite Online Backup API]
  7391. **
  7392. ** ^SQLite holds a write transaction open on the destination database file
  7393. ** for the duration of the backup operation.
  7394. ** ^The source database is read-locked only while it is being read;
  7395. ** it is not locked continuously for the entire backup operation.
  7396. ** ^Thus, the backup may be performed on a live source database without
  7397. ** preventing other database connections from
  7398. ** reading or writing to the source database while the backup is underway.
  7399. **
  7400. ** ^(To perform a backup operation:
  7401. ** <ol>
  7402. ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
  7403. ** backup,
  7404. ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
  7405. ** the data between the two databases, and finally
  7406. ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
  7407. ** associated with the backup operation.
  7408. ** </ol>)^
  7409. ** There should be exactly one call to sqlite3_backup_finish() for each
  7410. ** successful call to sqlite3_backup_init().
  7411. **
  7412. ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
  7413. **
  7414. ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
  7415. ** [database connection] associated with the destination database
  7416. ** and the database name, respectively.
  7417. ** ^The database name is "main" for the main database, "temp" for the
  7418. ** temporary database, or the name specified after the AS keyword in
  7419. ** an [ATTACH] statement for an attached database.
  7420. ** ^The S and M arguments passed to
  7421. ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
  7422. ** and database name of the source database, respectively.
  7423. ** ^The source and destination [database connections] (parameters S and D)
  7424. ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
  7425. ** an error.
  7426. **
  7427. ** ^A call to sqlite3_backup_init() will fail, returning NULL, if
  7428. ** there is already a read or read-write transaction open on the
  7429. ** destination database.
  7430. **
  7431. ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
  7432. ** returned and an error code and error message are stored in the
  7433. ** destination [database connection] D.
  7434. ** ^The error code and message for the failed call to sqlite3_backup_init()
  7435. ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
  7436. ** [sqlite3_errmsg16()] functions.
  7437. ** ^A successful call to sqlite3_backup_init() returns a pointer to an
  7438. ** [sqlite3_backup] object.
  7439. ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
  7440. ** sqlite3_backup_finish() functions to perform the specified backup
  7441. ** operation.
  7442. **
  7443. ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
  7444. **
  7445. ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
  7446. ** the source and destination databases specified by [sqlite3_backup] object B.
  7447. ** ^If N is negative, all remaining source pages are copied.
  7448. ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
  7449. ** are still more pages to be copied, then the function returns [SQLITE_OK].
  7450. ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
  7451. ** from source to destination, then it returns [SQLITE_DONE].
  7452. ** ^If an error occurs while running sqlite3_backup_step(B,N),
  7453. ** then an [error code] is returned. ^As well as [SQLITE_OK] and
  7454. ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
  7455. ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
  7456. ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
  7457. **
  7458. ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
  7459. ** <ol>
  7460. ** <li> the destination database was opened read-only, or
  7461. ** <li> the destination database is using write-ahead-log journaling
  7462. ** and the destination and source page sizes differ, or
  7463. ** <li> the destination database is an in-memory database and the
  7464. ** destination and source page sizes differ.
  7465. ** </ol>)^
  7466. **
  7467. ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
  7468. ** the [sqlite3_busy_handler | busy-handler function]
  7469. ** is invoked (if one is specified). ^If the
  7470. ** busy-handler returns non-zero before the lock is available, then
  7471. ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
  7472. ** sqlite3_backup_step() can be retried later. ^If the source
  7473. ** [database connection]
  7474. ** is being used to write to the source database when sqlite3_backup_step()
  7475. ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
  7476. ** case the call to sqlite3_backup_step() can be retried later on. ^(If
  7477. ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
  7478. ** [SQLITE_READONLY] is returned, then
  7479. ** there is no point in retrying the call to sqlite3_backup_step(). These
  7480. ** errors are considered fatal.)^ The application must accept
  7481. ** that the backup operation has failed and pass the backup operation handle
  7482. ** to the sqlite3_backup_finish() to release associated resources.
  7483. **
  7484. ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
  7485. ** on the destination file. ^The exclusive lock is not released until either
  7486. ** sqlite3_backup_finish() is called or the backup operation is complete
  7487. ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
  7488. ** sqlite3_backup_step() obtains a [shared lock] on the source database that
  7489. ** lasts for the duration of the sqlite3_backup_step() call.
  7490. ** ^Because the source database is not locked between calls to
  7491. ** sqlite3_backup_step(), the source database may be modified mid-way
  7492. ** through the backup process. ^If the source database is modified by an
  7493. ** external process or via a database connection other than the one being
  7494. ** used by the backup operation, then the backup will be automatically
  7495. ** restarted by the next call to sqlite3_backup_step(). ^If the source
  7496. ** database is modified by the using the same database connection as is used
  7497. ** by the backup operation, then the backup database is automatically
  7498. ** updated at the same time.
  7499. **
  7500. ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
  7501. **
  7502. ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
  7503. ** application wishes to abandon the backup operation, the application
  7504. ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
  7505. ** ^The sqlite3_backup_finish() interfaces releases all
  7506. ** resources associated with the [sqlite3_backup] object.
  7507. ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
  7508. ** active write-transaction on the destination database is rolled back.
  7509. ** The [sqlite3_backup] object is invalid
  7510. ** and may not be used following a call to sqlite3_backup_finish().
  7511. **
  7512. ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
  7513. ** sqlite3_backup_step() errors occurred, regardless or whether or not
  7514. ** sqlite3_backup_step() completed.
  7515. ** ^If an out-of-memory condition or IO error occurred during any prior
  7516. ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
  7517. ** sqlite3_backup_finish() returns the corresponding [error code].
  7518. **
  7519. ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
  7520. ** is not a permanent error and does not affect the return value of
  7521. ** sqlite3_backup_finish().
  7522. **
  7523. ** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
  7524. ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
  7525. **
  7526. ** ^The sqlite3_backup_remaining() routine returns the number of pages still
  7527. ** to be backed up at the conclusion of the most recent sqlite3_backup_step().
  7528. ** ^The sqlite3_backup_pagecount() routine returns the total number of pages
  7529. ** in the source database at the conclusion of the most recent
  7530. ** sqlite3_backup_step().
  7531. ** ^(The values returned by these functions are only updated by
  7532. ** sqlite3_backup_step(). If the source database is modified in a way that
  7533. ** changes the size of the source database or the number of pages remaining,
  7534. ** those changes are not reflected in the output of sqlite3_backup_pagecount()
  7535. ** and sqlite3_backup_remaining() until after the next
  7536. ** sqlite3_backup_step().)^
  7537. **
  7538. ** <b>Concurrent Usage of Database Handles</b>
  7539. **
  7540. ** ^The source [database connection] may be used by the application for other
  7541. ** purposes while a backup operation is underway or being initialized.
  7542. ** ^If SQLite is compiled and configured to support threadsafe database
  7543. ** connections, then the source database connection may be used concurrently
  7544. ** from within other threads.
  7545. **
  7546. ** However, the application must guarantee that the destination
  7547. ** [database connection] is not passed to any other API (by any thread) after
  7548. ** sqlite3_backup_init() is called and before the corresponding call to
  7549. ** sqlite3_backup_finish(). SQLite does not currently check to see
  7550. ** if the application incorrectly accesses the destination [database connection]
  7551. ** and so no error code is reported, but the operations may malfunction
  7552. ** nevertheless. Use of the destination database connection while a
  7553. ** backup is in progress might also also cause a mutex deadlock.
  7554. **
  7555. ** If running in [shared cache mode], the application must
  7556. ** guarantee that the shared cache used by the destination database
  7557. ** is not accessed while the backup is running. In practice this means
  7558. ** that the application must guarantee that the disk file being
  7559. ** backed up to is not accessed by any connection within the process,
  7560. ** not just the specific connection that was passed to sqlite3_backup_init().
  7561. **
  7562. ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
  7563. ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
  7564. ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
  7565. ** APIs are not strictly speaking threadsafe. If they are invoked at the
  7566. ** same time as another thread is invoking sqlite3_backup_step() it is
  7567. ** possible that they return invalid values.
  7568. */
  7569. SQLITE_API sqlite3_backup *sqlite3_backup_init(
  7570. sqlite3 *pDest, /* Destination database handle */
  7571. const char *zDestName, /* Destination database name */
  7572. sqlite3 *pSource, /* Source database handle */
  7573. const char *zSourceName /* Source database name */
  7574. );
  7575. SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
  7576. SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
  7577. SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
  7578. SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
  7579. /*
  7580. ** CAPI3REF: Unlock Notification
  7581. ** METHOD: sqlite3
  7582. **
  7583. ** ^When running in shared-cache mode, a database operation may fail with
  7584. ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
  7585. ** individual tables within the shared-cache cannot be obtained. See
  7586. ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
  7587. ** ^This API may be used to register a callback that SQLite will invoke
  7588. ** when the connection currently holding the required lock relinquishes it.
  7589. ** ^This API is only available if the library was compiled with the
  7590. ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
  7591. **
  7592. ** See Also: [Using the SQLite Unlock Notification Feature].
  7593. **
  7594. ** ^Shared-cache locks are released when a database connection concludes
  7595. ** its current transaction, either by committing it or rolling it back.
  7596. **
  7597. ** ^When a connection (known as the blocked connection) fails to obtain a
  7598. ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
  7599. ** identity of the database connection (the blocking connection) that
  7600. ** has locked the required resource is stored internally. ^After an
  7601. ** application receives an SQLITE_LOCKED error, it may call the
  7602. ** sqlite3_unlock_notify() method with the blocked connection handle as
  7603. ** the first argument to register for a callback that will be invoked
  7604. ** when the blocking connections current transaction is concluded. ^The
  7605. ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
  7606. ** call that concludes the blocking connections transaction.
  7607. **
  7608. ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
  7609. ** there is a chance that the blocking connection will have already
  7610. ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
  7611. ** If this happens, then the specified callback is invoked immediately,
  7612. ** from within the call to sqlite3_unlock_notify().)^
  7613. **
  7614. ** ^If the blocked connection is attempting to obtain a write-lock on a
  7615. ** shared-cache table, and more than one other connection currently holds
  7616. ** a read-lock on the same table, then SQLite arbitrarily selects one of
  7617. ** the other connections to use as the blocking connection.
  7618. **
  7619. ** ^(There may be at most one unlock-notify callback registered by a
  7620. ** blocked connection. If sqlite3_unlock_notify() is called when the
  7621. ** blocked connection already has a registered unlock-notify callback,
  7622. ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
  7623. ** called with a NULL pointer as its second argument, then any existing
  7624. ** unlock-notify callback is canceled. ^The blocked connections
  7625. ** unlock-notify callback may also be canceled by closing the blocked
  7626. ** connection using [sqlite3_close()].
  7627. **
  7628. ** The unlock-notify callback is not reentrant. If an application invokes
  7629. ** any sqlite3_xxx API functions from within an unlock-notify callback, a
  7630. ** crash or deadlock may be the result.
  7631. **
  7632. ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
  7633. ** returns SQLITE_OK.
  7634. **
  7635. ** <b>Callback Invocation Details</b>
  7636. **
  7637. ** When an unlock-notify callback is registered, the application provides a
  7638. ** single void* pointer that is passed to the callback when it is invoked.
  7639. ** However, the signature of the callback function allows SQLite to pass
  7640. ** it an array of void* context pointers. The first argument passed to
  7641. ** an unlock-notify callback is a pointer to an array of void* pointers,
  7642. ** and the second is the number of entries in the array.
  7643. **
  7644. ** When a blocking connections transaction is concluded, there may be
  7645. ** more than one blocked connection that has registered for an unlock-notify
  7646. ** callback. ^If two or more such blocked connections have specified the
  7647. ** same callback function, then instead of invoking the callback function
  7648. ** multiple times, it is invoked once with the set of void* context pointers
  7649. ** specified by the blocked connections bundled together into an array.
  7650. ** This gives the application an opportunity to prioritize any actions
  7651. ** related to the set of unblocked database connections.
  7652. **
  7653. ** <b>Deadlock Detection</b>
  7654. **
  7655. ** Assuming that after registering for an unlock-notify callback a
  7656. ** database waits for the callback to be issued before taking any further
  7657. ** action (a reasonable assumption), then using this API may cause the
  7658. ** application to deadlock. For example, if connection X is waiting for
  7659. ** connection Y's transaction to be concluded, and similarly connection
  7660. ** Y is waiting on connection X's transaction, then neither connection
  7661. ** will proceed and the system may remain deadlocked indefinitely.
  7662. **
  7663. ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
  7664. ** detection. ^If a given call to sqlite3_unlock_notify() would put the
  7665. ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
  7666. ** unlock-notify callback is registered. The system is said to be in
  7667. ** a deadlocked state if connection A has registered for an unlock-notify
  7668. ** callback on the conclusion of connection B's transaction, and connection
  7669. ** B has itself registered for an unlock-notify callback when connection
  7670. ** A's transaction is concluded. ^Indirect deadlock is also detected, so
  7671. ** the system is also considered to be deadlocked if connection B has
  7672. ** registered for an unlock-notify callback on the conclusion of connection
  7673. ** C's transaction, where connection C is waiting on connection A. ^Any
  7674. ** number of levels of indirection are allowed.
  7675. **
  7676. ** <b>The "DROP TABLE" Exception</b>
  7677. **
  7678. ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
  7679. ** always appropriate to call sqlite3_unlock_notify(). There is however,
  7680. ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
  7681. ** SQLite checks if there are any currently executing SELECT statements
  7682. ** that belong to the same connection. If there are, SQLITE_LOCKED is
  7683. ** returned. In this case there is no "blocking connection", so invoking
  7684. ** sqlite3_unlock_notify() results in the unlock-notify callback being
  7685. ** invoked immediately. If the application then re-attempts the "DROP TABLE"
  7686. ** or "DROP INDEX" query, an infinite loop might be the result.
  7687. **
  7688. ** One way around this problem is to check the extended error code returned
  7689. ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
  7690. ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
  7691. ** the special "DROP TABLE/INDEX" case, the extended error code is just
  7692. ** SQLITE_LOCKED.)^
  7693. */
  7694. SQLITE_API int sqlite3_unlock_notify(
  7695. sqlite3 *pBlocked, /* Waiting connection */
  7696. void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
  7697. void *pNotifyArg /* Argument to pass to xNotify */
  7698. );
  7699. /*
  7700. ** CAPI3REF: String Comparison
  7701. **
  7702. ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
  7703. ** and extensions to compare the contents of two buffers containing UTF-8
  7704. ** strings in a case-independent fashion, using the same definition of "case
  7705. ** independence" that SQLite uses internally when comparing identifiers.
  7706. */
  7707. SQLITE_API int sqlite3_stricmp(const char *, const char *);
  7708. SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
  7709. /*
  7710. ** CAPI3REF: String Globbing
  7711. *
  7712. ** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if
  7713. ** string X matches the [GLOB] pattern P.
  7714. ** ^The definition of [GLOB] pattern matching used in
  7715. ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
  7716. ** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function
  7717. ** is case sensitive.
  7718. **
  7719. ** Note that this routine returns zero on a match and non-zero if the strings
  7720. ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
  7721. **
  7722. ** See also: [sqlite3_strlike()].
  7723. */
  7724. SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);
  7725. /*
  7726. ** CAPI3REF: String LIKE Matching
  7727. *
  7728. ** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if
  7729. ** string X matches the [LIKE] pattern P with escape character E.
  7730. ** ^The definition of [LIKE] pattern matching used in
  7731. ** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E"
  7732. ** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without
  7733. ** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.
  7734. ** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case
  7735. ** insensitive - equivalent upper and lower case ASCII characters match
  7736. ** one another.
  7737. **
  7738. ** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though
  7739. ** only ASCII characters are case folded.
  7740. **
  7741. ** Note that this routine returns zero on a match and non-zero if the strings
  7742. ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
  7743. **
  7744. ** See also: [sqlite3_strglob()].
  7745. */
  7746. SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc);
  7747. /*
  7748. ** CAPI3REF: Error Logging Interface
  7749. **
  7750. ** ^The [sqlite3_log()] interface writes a message into the [error log]
  7751. ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
  7752. ** ^If logging is enabled, the zFormat string and subsequent arguments are
  7753. ** used with [sqlite3_snprintf()] to generate the final output string.
  7754. **
  7755. ** The sqlite3_log() interface is intended for use by extensions such as
  7756. ** virtual tables, collating functions, and SQL functions. While there is
  7757. ** nothing to prevent an application from calling sqlite3_log(), doing so
  7758. ** is considered bad form.
  7759. **
  7760. ** The zFormat string must not be NULL.
  7761. **
  7762. ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
  7763. ** will not use dynamically allocated memory. The log message is stored in
  7764. ** a fixed-length buffer on the stack. If the log message is longer than
  7765. ** a few hundred characters, it will be truncated to the length of the
  7766. ** buffer.
  7767. */
  7768. SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
  7769. /*
  7770. ** CAPI3REF: Write-Ahead Log Commit Hook
  7771. ** METHOD: sqlite3
  7772. **
  7773. ** ^The [sqlite3_wal_hook()] function is used to register a callback that
  7774. ** is invoked each time data is committed to a database in wal mode.
  7775. **
  7776. ** ^(The callback is invoked by SQLite after the commit has taken place and
  7777. ** the associated write-lock on the database released)^, so the implementation
  7778. ** may read, write or [checkpoint] the database as required.
  7779. **
  7780. ** ^The first parameter passed to the callback function when it is invoked
  7781. ** is a copy of the third parameter passed to sqlite3_wal_hook() when
  7782. ** registering the callback. ^The second is a copy of the database handle.
  7783. ** ^The third parameter is the name of the database that was written to -
  7784. ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
  7785. ** is the number of pages currently in the write-ahead log file,
  7786. ** including those that were just committed.
  7787. **
  7788. ** The callback function should normally return [SQLITE_OK]. ^If an error
  7789. ** code is returned, that error will propagate back up through the
  7790. ** SQLite code base to cause the statement that provoked the callback
  7791. ** to report an error, though the commit will have still occurred. If the
  7792. ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
  7793. ** that does not correspond to any valid SQLite error code, the results
  7794. ** are undefined.
  7795. **
  7796. ** A single database handle may have at most a single write-ahead log callback
  7797. ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
  7798. ** previously registered write-ahead log callback. ^Note that the
  7799. ** [sqlite3_wal_autocheckpoint()] interface and the
  7800. ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
  7801. ** overwrite any prior [sqlite3_wal_hook()] settings.
  7802. */
  7803. SQLITE_API void *sqlite3_wal_hook(
  7804. sqlite3*,
  7805. int(*)(void *,sqlite3*,const char*,int),
  7806. void*
  7807. );
  7808. /*
  7809. ** CAPI3REF: Configure an auto-checkpoint
  7810. ** METHOD: sqlite3
  7811. **
  7812. ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
  7813. ** [sqlite3_wal_hook()] that causes any database on [database connection] D
  7814. ** to automatically [checkpoint]
  7815. ** after committing a transaction if there are N or
  7816. ** more frames in the [write-ahead log] file. ^Passing zero or
  7817. ** a negative value as the nFrame parameter disables automatic
  7818. ** checkpoints entirely.
  7819. **
  7820. ** ^The callback registered by this function replaces any existing callback
  7821. ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
  7822. ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
  7823. ** configured by this function.
  7824. **
  7825. ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
  7826. ** from SQL.
  7827. **
  7828. ** ^Checkpoints initiated by this mechanism are
  7829. ** [sqlite3_wal_checkpoint_v2|PASSIVE].
  7830. **
  7831. ** ^Every new [database connection] defaults to having the auto-checkpoint
  7832. ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
  7833. ** pages. The use of this interface
  7834. ** is only necessary if the default setting is found to be suboptimal
  7835. ** for a particular application.
  7836. */
  7837. SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
  7838. /*
  7839. ** CAPI3REF: Checkpoint a database
  7840. ** METHOD: sqlite3
  7841. **
  7842. ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
  7843. ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
  7844. **
  7845. ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
  7846. ** [write-ahead log] for database X on [database connection] D to be
  7847. ** transferred into the database file and for the write-ahead log to
  7848. ** be reset. See the [checkpointing] documentation for addition
  7849. ** information.
  7850. **
  7851. ** This interface used to be the only way to cause a checkpoint to
  7852. ** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]
  7853. ** interface was added. This interface is retained for backwards
  7854. ** compatibility and as a convenience for applications that need to manually
  7855. ** start a callback but which do not need the full power (and corresponding
  7856. ** complication) of [sqlite3_wal_checkpoint_v2()].
  7857. */
  7858. SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
  7859. /*
  7860. ** CAPI3REF: Checkpoint a database
  7861. ** METHOD: sqlite3
  7862. **
  7863. ** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint
  7864. ** operation on database X of [database connection] D in mode M. Status
  7865. ** information is written back into integers pointed to by L and C.)^
  7866. ** ^(The M parameter must be a valid [checkpoint mode]:)^
  7867. **
  7868. ** <dl>
  7869. ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
  7870. ** ^Checkpoint as many frames as possible without waiting for any database
  7871. ** readers or writers to finish, then sync the database file if all frames
  7872. ** in the log were checkpointed. ^The [busy-handler callback]
  7873. ** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
  7874. ** ^On the other hand, passive mode might leave the checkpoint unfinished
  7875. ** if there are concurrent readers or writers.
  7876. **
  7877. ** <dt>SQLITE_CHECKPOINT_FULL<dd>
  7878. ** ^This mode blocks (it invokes the
  7879. ** [sqlite3_busy_handler|busy-handler callback]) until there is no
  7880. ** database writer and all readers are reading from the most recent database
  7881. ** snapshot. ^It then checkpoints all frames in the log file and syncs the
  7882. ** database file. ^This mode blocks new database writers while it is pending,
  7883. ** but new database readers are allowed to continue unimpeded.
  7884. **
  7885. ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
  7886. ** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
  7887. ** that after checkpointing the log file it blocks (calls the
  7888. ** [busy-handler callback])
  7889. ** until all readers are reading from the database file only. ^This ensures
  7890. ** that the next writer will restart the log file from the beginning.
  7891. ** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
  7892. ** database writer attempts while it is pending, but does not impede readers.
  7893. **
  7894. ** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>
  7895. ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
  7896. ** addition that it also truncates the log file to zero bytes just prior
  7897. ** to a successful return.
  7898. ** </dl>
  7899. **
  7900. ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
  7901. ** the log file or to -1 if the checkpoint could not run because
  7902. ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not
  7903. ** NULL,then *pnCkpt is set to the total number of checkpointed frames in the
  7904. ** log file (including any that were already checkpointed before the function
  7905. ** was called) or to -1 if the checkpoint could not run due to an error or
  7906. ** because the database is not in WAL mode. ^Note that upon successful
  7907. ** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been
  7908. ** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.
  7909. **
  7910. ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
  7911. ** any other process is running a checkpoint operation at the same time, the
  7912. ** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a
  7913. ** busy-handler configured, it will not be invoked in this case.
  7914. **
  7915. ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
  7916. ** exclusive "writer" lock on the database file. ^If the writer lock cannot be
  7917. ** obtained immediately, and a busy-handler is configured, it is invoked and
  7918. ** the writer lock retried until either the busy-handler returns 0 or the lock
  7919. ** is successfully obtained. ^The busy-handler is also invoked while waiting for
  7920. ** database readers as described above. ^If the busy-handler returns 0 before
  7921. ** the writer lock is obtained or while waiting for database readers, the
  7922. ** checkpoint operation proceeds from that point in the same way as
  7923. ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
  7924. ** without blocking any further. ^SQLITE_BUSY is returned in this case.
  7925. **
  7926. ** ^If parameter zDb is NULL or points to a zero length string, then the
  7927. ** specified operation is attempted on all WAL databases [attached] to
  7928. ** [database connection] db. In this case the
  7929. ** values written to output parameters *pnLog and *pnCkpt are undefined. ^If
  7930. ** an SQLITE_BUSY error is encountered when processing one or more of the
  7931. ** attached WAL databases, the operation is still attempted on any remaining
  7932. ** attached databases and SQLITE_BUSY is returned at the end. ^If any other
  7933. ** error occurs while processing an attached database, processing is abandoned
  7934. ** and the error code is returned to the caller immediately. ^If no error
  7935. ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
  7936. ** databases, SQLITE_OK is returned.
  7937. **
  7938. ** ^If database zDb is the name of an attached database that is not in WAL
  7939. ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If
  7940. ** zDb is not NULL (or a zero length string) and is not the name of any
  7941. ** attached database, SQLITE_ERROR is returned to the caller.
  7942. **
  7943. ** ^Unless it returns SQLITE_MISUSE,
  7944. ** the sqlite3_wal_checkpoint_v2() interface
  7945. ** sets the error information that is queried by
  7946. ** [sqlite3_errcode()] and [sqlite3_errmsg()].
  7947. **
  7948. ** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
  7949. ** from SQL.
  7950. */
  7951. SQLITE_API int sqlite3_wal_checkpoint_v2(
  7952. sqlite3 *db, /* Database handle */
  7953. const char *zDb, /* Name of attached database (or NULL) */
  7954. int eMode, /* SQLITE_CHECKPOINT_* value */
  7955. int *pnLog, /* OUT: Size of WAL log in frames */
  7956. int *pnCkpt /* OUT: Total number of frames checkpointed */
  7957. );
  7958. /*
  7959. ** CAPI3REF: Checkpoint Mode Values
  7960. ** KEYWORDS: {checkpoint mode}
  7961. **
  7962. ** These constants define all valid values for the "checkpoint mode" passed
  7963. ** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.
  7964. ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
  7965. ** meaning of each of these checkpoint modes.
  7966. */
  7967. #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
  7968. #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
  7969. #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */
  7970. #define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */
  7971. /*
  7972. ** CAPI3REF: Virtual Table Interface Configuration
  7973. **
  7974. ** This function may be called by either the [xConnect] or [xCreate] method
  7975. ** of a [virtual table] implementation to configure
  7976. ** various facets of the virtual table interface.
  7977. **
  7978. ** If this interface is invoked outside the context of an xConnect or
  7979. ** xCreate virtual table method then the behavior is undefined.
  7980. **
  7981. ** At present, there is only one option that may be configured using
  7982. ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
  7983. ** may be added in the future.
  7984. */
  7985. SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
  7986. /*
  7987. ** CAPI3REF: Virtual Table Configuration Options
  7988. **
  7989. ** These macros define the various options to the
  7990. ** [sqlite3_vtab_config()] interface that [virtual table] implementations
  7991. ** can use to customize and optimize their behavior.
  7992. **
  7993. ** <dl>
  7994. ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
  7995. ** <dd>Calls of the form
  7996. ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
  7997. ** where X is an integer. If X is zero, then the [virtual table] whose
  7998. ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
  7999. ** support constraints. In this configuration (which is the default) if
  8000. ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
  8001. ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
  8002. ** specified as part of the users SQL statement, regardless of the actual
  8003. ** ON CONFLICT mode specified.
  8004. **
  8005. ** If X is non-zero, then the virtual table implementation guarantees
  8006. ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
  8007. ** any modifications to internal or persistent data structures have been made.
  8008. ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
  8009. ** is able to roll back a statement or database transaction, and abandon
  8010. ** or continue processing the current SQL statement as appropriate.
  8011. ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
  8012. ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
  8013. ** had been ABORT.
  8014. **
  8015. ** Virtual table implementations that are required to handle OR REPLACE
  8016. ** must do so within the [xUpdate] method. If a call to the
  8017. ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
  8018. ** CONFLICT policy is REPLACE, the virtual table implementation should
  8019. ** silently replace the appropriate rows within the xUpdate callback and
  8020. ** return SQLITE_OK. Or, if this is not possible, it may return
  8021. ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
  8022. ** constraint handling.
  8023. ** </dl>
  8024. */
  8025. #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
  8026. /*
  8027. ** CAPI3REF: Determine The Virtual Table Conflict Policy
  8028. **
  8029. ** This function may only be called from within a call to the [xUpdate] method
  8030. ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
  8031. ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
  8032. ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
  8033. ** of the SQL statement that triggered the call to the [xUpdate] method of the
  8034. ** [virtual table].
  8035. */
  8036. SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
  8037. /*
  8038. ** CAPI3REF: Conflict resolution modes
  8039. ** KEYWORDS: {conflict resolution mode}
  8040. **
  8041. ** These constants are returned by [sqlite3_vtab_on_conflict()] to
  8042. ** inform a [virtual table] implementation what the [ON CONFLICT] mode
  8043. ** is for the SQL statement being evaluated.
  8044. **
  8045. ** Note that the [SQLITE_IGNORE] constant is also used as a potential
  8046. ** return value from the [sqlite3_set_authorizer()] callback and that
  8047. ** [SQLITE_ABORT] is also a [result code].
  8048. */
  8049. #define SQLITE_ROLLBACK 1
  8050. /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
  8051. #define SQLITE_FAIL 3
  8052. /* #define SQLITE_ABORT 4 // Also an error code */
  8053. #define SQLITE_REPLACE 5
  8054. /*
  8055. ** CAPI3REF: Prepared Statement Scan Status Opcodes
  8056. ** KEYWORDS: {scanstatus options}
  8057. **
  8058. ** The following constants can be used for the T parameter to the
  8059. ** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
  8060. ** different metric for sqlite3_stmt_scanstatus() to return.
  8061. **
  8062. ** When the value returned to V is a string, space to hold that string is
  8063. ** managed by the prepared statement S and will be automatically freed when
  8064. ** S is finalized.
  8065. **
  8066. ** <dl>
  8067. ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
  8068. ** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be
  8069. ** set to the total number of times that the X-th loop has run.</dd>
  8070. **
  8071. ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
  8072. ** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set
  8073. ** to the total number of rows examined by all iterations of the X-th loop.</dd>
  8074. **
  8075. ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
  8076. ** <dd>^The "double" variable pointed to by the T parameter will be set to the
  8077. ** query planner's estimate for the average number of rows output from each
  8078. ** iteration of the X-th loop. If the query planner's estimates was accurate,
  8079. ** then this value will approximate the quotient NVISIT/NLOOP and the
  8080. ** product of this value for all prior loops with the same SELECTID will
  8081. ** be the NLOOP value for the current loop.
  8082. **
  8083. ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
  8084. ** <dd>^The "const char *" variable pointed to by the T parameter will be set
  8085. ** to a zero-terminated UTF-8 string containing the name of the index or table
  8086. ** used for the X-th loop.
  8087. **
  8088. ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
  8089. ** <dd>^The "const char *" variable pointed to by the T parameter will be set
  8090. ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
  8091. ** description for the X-th loop.
  8092. **
  8093. ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt>
  8094. ** <dd>^The "int" variable pointed to by the T parameter will be set to the
  8095. ** "select-id" for the X-th loop. The select-id identifies which query or
  8096. ** subquery the loop is part of. The main query has a select-id of zero.
  8097. ** The select-id is the same value as is output in the first column
  8098. ** of an [EXPLAIN QUERY PLAN] query.
  8099. ** </dl>
  8100. */
  8101. #define SQLITE_SCANSTAT_NLOOP 0
  8102. #define SQLITE_SCANSTAT_NVISIT 1
  8103. #define SQLITE_SCANSTAT_EST 2
  8104. #define SQLITE_SCANSTAT_NAME 3
  8105. #define SQLITE_SCANSTAT_EXPLAIN 4
  8106. #define SQLITE_SCANSTAT_SELECTID 5
  8107. /*
  8108. ** CAPI3REF: Prepared Statement Scan Status
  8109. ** METHOD: sqlite3_stmt
  8110. **
  8111. ** This interface returns information about the predicted and measured
  8112. ** performance for pStmt. Advanced applications can use this
  8113. ** interface to compare the predicted and the measured performance and
  8114. ** issue warnings and/or rerun [ANALYZE] if discrepancies are found.
  8115. **
  8116. ** Since this interface is expected to be rarely used, it is only
  8117. ** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]
  8118. ** compile-time option.
  8119. **
  8120. ** The "iScanStatusOp" parameter determines which status information to return.
  8121. ** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior
  8122. ** of this interface is undefined.
  8123. ** ^The requested measurement is written into a variable pointed to by
  8124. ** the "pOut" parameter.
  8125. ** Parameter "idx" identifies the specific loop to retrieve statistics for.
  8126. ** Loops are numbered starting from zero. ^If idx is out of range - less than
  8127. ** zero or greater than or equal to the total number of loops used to implement
  8128. ** the statement - a non-zero value is returned and the variable that pOut
  8129. ** points to is unchanged.
  8130. **
  8131. ** ^Statistics might not be available for all loops in all statements. ^In cases
  8132. ** where there exist loops with no available statistics, this function behaves
  8133. ** as if the loop did not exist - it returns non-zero and leave the variable
  8134. ** that pOut points to unchanged.
  8135. **
  8136. ** See also: [sqlite3_stmt_scanstatus_reset()]
  8137. */
  8138. SQLITE_API int sqlite3_stmt_scanstatus(
  8139. sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
  8140. int idx, /* Index of loop to report on */
  8141. int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
  8142. void *pOut /* Result written here */
  8143. );
  8144. /*
  8145. ** CAPI3REF: Zero Scan-Status Counters
  8146. ** METHOD: sqlite3_stmt
  8147. **
  8148. ** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
  8149. **
  8150. ** This API is only available if the library is built with pre-processor
  8151. ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
  8152. */
  8153. SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
  8154. /*
  8155. ** CAPI3REF: Flush caches to disk mid-transaction
  8156. **
  8157. ** ^If a write-transaction is open on [database connection] D when the
  8158. ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
  8159. ** pages in the pager-cache that are not currently in use are written out
  8160. ** to disk. A dirty page may be in use if a database cursor created by an
  8161. ** active SQL statement is reading from it, or if it is page 1 of a database
  8162. ** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)]
  8163. ** interface flushes caches for all schemas - "main", "temp", and
  8164. ** any [attached] databases.
  8165. **
  8166. ** ^If this function needs to obtain extra database locks before dirty pages
  8167. ** can be flushed to disk, it does so. ^If those locks cannot be obtained
  8168. ** immediately and there is a busy-handler callback configured, it is invoked
  8169. ** in the usual manner. ^If the required lock still cannot be obtained, then
  8170. ** the database is skipped and an attempt made to flush any dirty pages
  8171. ** belonging to the next (if any) database. ^If any databases are skipped
  8172. ** because locks cannot be obtained, but no other error occurs, this
  8173. ** function returns SQLITE_BUSY.
  8174. **
  8175. ** ^If any other error occurs while flushing dirty pages to disk (for
  8176. ** example an IO error or out-of-memory condition), then processing is
  8177. ** abandoned and an SQLite [error code] is returned to the caller immediately.
  8178. **
  8179. ** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.
  8180. **
  8181. ** ^This function does not set the database handle error code or message
  8182. ** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.
  8183. */
  8184. SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
  8185. /*
  8186. ** CAPI3REF: The pre-update hook.
  8187. **
  8188. ** ^These interfaces are only available if SQLite is compiled using the
  8189. ** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.
  8190. **
  8191. ** ^The [sqlite3_preupdate_hook()] interface registers a callback function
  8192. ** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation
  8193. ** on a [rowid table].
  8194. ** ^At most one preupdate hook may be registered at a time on a single
  8195. ** [database connection]; each call to [sqlite3_preupdate_hook()] overrides
  8196. ** the previous setting.
  8197. ** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]
  8198. ** with a NULL pointer as the second parameter.
  8199. ** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as
  8200. ** the first parameter to callbacks.
  8201. **
  8202. ** ^The preupdate hook only fires for changes to [rowid tables]; the preupdate
  8203. ** hook is not invoked for changes to [virtual tables] or [WITHOUT ROWID]
  8204. ** tables.
  8205. **
  8206. ** ^The second parameter to the preupdate callback is a pointer to
  8207. ** the [database connection] that registered the preupdate hook.
  8208. ** ^The third parameter to the preupdate callback is one of the constants
  8209. ** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the
  8210. ** kind of update operation that is about to occur.
  8211. ** ^(The fourth parameter to the preupdate callback is the name of the
  8212. ** database within the database connection that is being modified. This
  8213. ** will be "main" for the main database or "temp" for TEMP tables or
  8214. ** the name given after the AS keyword in the [ATTACH] statement for attached
  8215. ** databases.)^
  8216. ** ^The fifth parameter to the preupdate callback is the name of the
  8217. ** table that is being modified.
  8218. ** ^The sixth parameter to the preupdate callback is the initial [rowid] of the
  8219. ** row being changes for SQLITE_UPDATE and SQLITE_DELETE changes and is
  8220. ** undefined for SQLITE_INSERT changes.
  8221. ** ^The seventh parameter to the preupdate callback is the final [rowid] of
  8222. ** the row being changed for SQLITE_UPDATE and SQLITE_INSERT changes and is
  8223. ** undefined for SQLITE_DELETE changes.
  8224. **
  8225. ** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],
  8226. ** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces
  8227. ** provide additional information about a preupdate event. These routines
  8228. ** may only be called from within a preupdate callback. Invoking any of
  8229. ** these routines from outside of a preupdate callback or with a
  8230. ** [database connection] pointer that is different from the one supplied
  8231. ** to the preupdate callback results in undefined and probably undesirable
  8232. ** behavior.
  8233. **
  8234. ** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns
  8235. ** in the row that is being inserted, updated, or deleted.
  8236. **
  8237. ** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to
  8238. ** a [protected sqlite3_value] that contains the value of the Nth column of
  8239. ** the table row before it is updated. The N parameter must be between 0
  8240. ** and one less than the number of columns or the behavior will be
  8241. ** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE
  8242. ** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the
  8243. ** behavior is undefined. The [sqlite3_value] that P points to
  8244. ** will be destroyed when the preupdate callback returns.
  8245. **
  8246. ** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to
  8247. ** a [protected sqlite3_value] that contains the value of the Nth column of
  8248. ** the table row after it is updated. The N parameter must be between 0
  8249. ** and one less than the number of columns or the behavior will be
  8250. ** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE
  8251. ** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the
  8252. ** behavior is undefined. The [sqlite3_value] that P points to
  8253. ** will be destroyed when the preupdate callback returns.
  8254. **
  8255. ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
  8256. ** callback was invoked as a result of a direct insert, update, or delete
  8257. ** operation; or 1 for inserts, updates, or deletes invoked by top-level
  8258. ** triggers; or 2 for changes resulting from triggers called by top-level
  8259. ** triggers; and so forth.
  8260. **
  8261. ** See also: [sqlite3_update_hook()]
  8262. */
  8263. SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_preupdate_hook(
  8264. sqlite3 *db,
  8265. void(*xPreUpdate)(
  8266. void *pCtx, /* Copy of third arg to preupdate_hook() */
  8267. sqlite3 *db, /* Database handle */
  8268. int op, /* SQLITE_UPDATE, DELETE or INSERT */
  8269. char const *zDb, /* Database name */
  8270. char const *zName, /* Table name */
  8271. sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
  8272. sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
  8273. ),
  8274. void*
  8275. );
  8276. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **);
  8277. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_count(sqlite3 *);
  8278. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_depth(sqlite3 *);
  8279. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **);
  8280. /*
  8281. ** CAPI3REF: Low-level system error code
  8282. **
  8283. ** ^Attempt to return the underlying operating system error code or error
  8284. ** number that caused the most recent I/O error or failure to open a file.
  8285. ** The return value is OS-dependent. For example, on unix systems, after
  8286. ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
  8287. ** called to get back the underlying "errno" that caused the problem, such
  8288. ** as ENOSPC, EAUTH, EISDIR, and so forth.
  8289. */
  8290. SQLITE_API int sqlite3_system_errno(sqlite3*);
  8291. /*
  8292. ** CAPI3REF: Database Snapshot
  8293. ** KEYWORDS: {snapshot}
  8294. ** EXPERIMENTAL
  8295. **
  8296. ** An instance of the snapshot object records the state of a [WAL mode]
  8297. ** database for some specific point in history.
  8298. **
  8299. ** In [WAL mode], multiple [database connections] that are open on the
  8300. ** same database file can each be reading a different historical version
  8301. ** of the database file. When a [database connection] begins a read
  8302. ** transaction, that connection sees an unchanging copy of the database
  8303. ** as it existed for the point in time when the transaction first started.
  8304. ** Subsequent changes to the database from other connections are not seen
  8305. ** by the reader until a new read transaction is started.
  8306. **
  8307. ** The sqlite3_snapshot object records state information about an historical
  8308. ** version of the database file so that it is possible to later open a new read
  8309. ** transaction that sees that historical version of the database rather than
  8310. ** the most recent version.
  8311. **
  8312. ** The constructor for this object is [sqlite3_snapshot_get()]. The
  8313. ** [sqlite3_snapshot_open()] method causes a fresh read transaction to refer
  8314. ** to an historical snapshot (if possible). The destructor for
  8315. ** sqlite3_snapshot objects is [sqlite3_snapshot_free()].
  8316. */
  8317. typedef struct sqlite3_snapshot sqlite3_snapshot;
  8318. /*
  8319. ** CAPI3REF: Record A Database Snapshot
  8320. ** EXPERIMENTAL
  8321. **
  8322. ** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a
  8323. ** new [sqlite3_snapshot] object that records the current state of
  8324. ** schema S in database connection D. ^On success, the
  8325. ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
  8326. ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
  8327. ** ^If schema S of [database connection] D is not a [WAL mode] database
  8328. ** that is in a read transaction, then [sqlite3_snapshot_get(D,S,P)]
  8329. ** leaves the *P value unchanged and returns an appropriate [error code].
  8330. **
  8331. ** The [sqlite3_snapshot] object returned from a successful call to
  8332. ** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]
  8333. ** to avoid a memory leak.
  8334. **
  8335. ** The [sqlite3_snapshot_get()] interface is only available when the
  8336. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  8337. */
  8338. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
  8339. sqlite3 *db,
  8340. const char *zSchema,
  8341. sqlite3_snapshot **ppSnapshot
  8342. );
  8343. /*
  8344. ** CAPI3REF: Start a read transaction on an historical snapshot
  8345. ** EXPERIMENTAL
  8346. **
  8347. ** ^The [sqlite3_snapshot_open(D,S,P)] interface starts a
  8348. ** read transaction for schema S of
  8349. ** [database connection] D such that the read transaction
  8350. ** refers to historical [snapshot] P, rather than the most
  8351. ** recent change to the database.
  8352. ** ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK on success
  8353. ** or an appropriate [error code] if it fails.
  8354. **
  8355. ** ^In order to succeed, a call to [sqlite3_snapshot_open(D,S,P)] must be
  8356. ** the first operation following the [BEGIN] that takes the schema S
  8357. ** out of [autocommit mode].
  8358. ** ^In other words, schema S must not currently be in
  8359. ** a transaction for [sqlite3_snapshot_open(D,S,P)] to work, but the
  8360. ** database connection D must be out of [autocommit mode].
  8361. ** ^A [snapshot] will fail to open if it has been overwritten by a
  8362. ** [checkpoint].
  8363. ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
  8364. ** database connection D does not know that the database file for
  8365. ** schema S is in [WAL mode]. A database connection might not know
  8366. ** that the database file is in [WAL mode] if there has been no prior
  8367. ** I/O on that database connection, or if the database entered [WAL mode]
  8368. ** after the most recent I/O on the database connection.)^
  8369. ** (Hint: Run "[PRAGMA application_id]" against a newly opened
  8370. ** database connection in order to make it ready to use snapshots.)
  8371. **
  8372. ** The [sqlite3_snapshot_open()] interface is only available when the
  8373. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  8374. */
  8375. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
  8376. sqlite3 *db,
  8377. const char *zSchema,
  8378. sqlite3_snapshot *pSnapshot
  8379. );
  8380. /*
  8381. ** CAPI3REF: Destroy a snapshot
  8382. ** EXPERIMENTAL
  8383. **
  8384. ** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.
  8385. ** The application must eventually free every [sqlite3_snapshot] object
  8386. ** using this routine to avoid a memory leak.
  8387. **
  8388. ** The [sqlite3_snapshot_free()] interface is only available when the
  8389. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  8390. */
  8391. SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
  8392. /*
  8393. ** CAPI3REF: Compare the ages of two snapshot handles.
  8394. ** EXPERIMENTAL
  8395. **
  8396. ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
  8397. ** of two valid snapshot handles.
  8398. **
  8399. ** If the two snapshot handles are not associated with the same database
  8400. ** file, the result of the comparison is undefined.
  8401. **
  8402. ** Additionally, the result of the comparison is only valid if both of the
  8403. ** snapshot handles were obtained by calling sqlite3_snapshot_get() since the
  8404. ** last time the wal file was deleted. The wal file is deleted when the
  8405. ** database is changed back to rollback mode or when the number of database
  8406. ** clients drops to zero. If either snapshot handle was obtained before the
  8407. ** wal file was last deleted, the value returned by this function
  8408. ** is undefined.
  8409. **
  8410. ** Otherwise, this API returns a negative value if P1 refers to an older
  8411. ** snapshot than P2, zero if the two handles refer to the same database
  8412. ** snapshot, and a positive value if P1 is a newer snapshot than P2.
  8413. */
  8414. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
  8415. sqlite3_snapshot *p1,
  8416. sqlite3_snapshot *p2
  8417. );
  8418. /*
  8419. ** Undo the hack that converts floating point types to integer for
  8420. ** builds on processors without floating point support.
  8421. */
  8422. #ifdef SQLITE_OMIT_FLOATING_POINT
  8423. # undef double
  8424. #endif
  8425. #if 0
  8426. } /* End of the 'extern "C"' block */
  8427. #endif
  8428. #endif /* SQLITE3_H */
  8429. /******** Begin file sqlite3rtree.h *********/
  8430. /*
  8431. ** 2010 August 30
  8432. **
  8433. ** The author disclaims copyright to this source code. In place of
  8434. ** a legal notice, here is a blessing:
  8435. **
  8436. ** May you do good and not evil.
  8437. ** May you find forgiveness for yourself and forgive others.
  8438. ** May you share freely, never taking more than you give.
  8439. **
  8440. *************************************************************************
  8441. */
  8442. #ifndef _SQLITE3RTREE_H_
  8443. #define _SQLITE3RTREE_H_
  8444. #if 0
  8445. extern "C" {
  8446. #endif
  8447. typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
  8448. typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
  8449. /* The double-precision datatype used by RTree depends on the
  8450. ** SQLITE_RTREE_INT_ONLY compile-time option.
  8451. */
  8452. #ifdef SQLITE_RTREE_INT_ONLY
  8453. typedef sqlite3_int64 sqlite3_rtree_dbl;
  8454. #else
  8455. typedef double sqlite3_rtree_dbl;
  8456. #endif
  8457. /*
  8458. ** Register a geometry callback named zGeom that can be used as part of an
  8459. ** R-Tree geometry query as follows:
  8460. **
  8461. ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
  8462. */
  8463. SQLITE_API int sqlite3_rtree_geometry_callback(
  8464. sqlite3 *db,
  8465. const char *zGeom,
  8466. int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*),
  8467. void *pContext
  8468. );
  8469. /*
  8470. ** A pointer to a structure of the following type is passed as the first
  8471. ** argument to callbacks registered using rtree_geometry_callback().
  8472. */
  8473. struct sqlite3_rtree_geometry {
  8474. void *pContext; /* Copy of pContext passed to s_r_g_c() */
  8475. int nParam; /* Size of array aParam[] */
  8476. sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */
  8477. void *pUser; /* Callback implementation user data */
  8478. void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
  8479. };
  8480. /*
  8481. ** Register a 2nd-generation geometry callback named zScore that can be
  8482. ** used as part of an R-Tree geometry query as follows:
  8483. **
  8484. ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
  8485. */
  8486. SQLITE_API int sqlite3_rtree_query_callback(
  8487. sqlite3 *db,
  8488. const char *zQueryFunc,
  8489. int (*xQueryFunc)(sqlite3_rtree_query_info*),
  8490. void *pContext,
  8491. void (*xDestructor)(void*)
  8492. );
  8493. /*
  8494. ** A pointer to a structure of the following type is passed as the
  8495. ** argument to scored geometry callback registered using
  8496. ** sqlite3_rtree_query_callback().
  8497. **
  8498. ** Note that the first 5 fields of this structure are identical to
  8499. ** sqlite3_rtree_geometry. This structure is a subclass of
  8500. ** sqlite3_rtree_geometry.
  8501. */
  8502. struct sqlite3_rtree_query_info {
  8503. void *pContext; /* pContext from when function registered */
  8504. int nParam; /* Number of function parameters */
  8505. sqlite3_rtree_dbl *aParam; /* value of function parameters */
  8506. void *pUser; /* callback can use this, if desired */
  8507. void (*xDelUser)(void*); /* function to free pUser */
  8508. sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */
  8509. unsigned int *anQueue; /* Number of pending entries in the queue */
  8510. int nCoord; /* Number of coordinates */
  8511. int iLevel; /* Level of current node or entry */
  8512. int mxLevel; /* The largest iLevel value in the tree */
  8513. sqlite3_int64 iRowid; /* Rowid for current entry */
  8514. sqlite3_rtree_dbl rParentScore; /* Score of parent node */
  8515. int eParentWithin; /* Visibility of parent node */
  8516. int eWithin; /* OUT: Visiblity */
  8517. sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
  8518. /* The following fields are only available in 3.8.11 and later */
  8519. sqlite3_value **apSqlParam; /* Original SQL values of parameters */
  8520. };
  8521. /*
  8522. ** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
  8523. */
  8524. #define NOT_WITHIN 0 /* Object completely outside of query region */
  8525. #define PARTLY_WITHIN 1 /* Object partially overlaps query region */
  8526. #define FULLY_WITHIN 2 /* Object fully contained within query region */
  8527. #if 0
  8528. } /* end of the 'extern "C"' block */
  8529. #endif
  8530. #endif /* ifndef _SQLITE3RTREE_H_ */
  8531. /******** End of sqlite3rtree.h *********/
  8532. /******** Begin file sqlite3session.h *********/
  8533. #if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)
  8534. #define __SQLITESESSION_H_ 1
  8535. /*
  8536. ** Make sure we can call this stuff from C++.
  8537. */
  8538. #if 0
  8539. extern "C" {
  8540. #endif
  8541. /*
  8542. ** CAPI3REF: Session Object Handle
  8543. */
  8544. typedef struct sqlite3_session sqlite3_session;
  8545. /*
  8546. ** CAPI3REF: Changeset Iterator Handle
  8547. */
  8548. typedef struct sqlite3_changeset_iter sqlite3_changeset_iter;
  8549. /*
  8550. ** CAPI3REF: Create A New Session Object
  8551. **
  8552. ** Create a new session object attached to database handle db. If successful,
  8553. ** a pointer to the new object is written to *ppSession and SQLITE_OK is
  8554. ** returned. If an error occurs, *ppSession is set to NULL and an SQLite
  8555. ** error code (e.g. SQLITE_NOMEM) is returned.
  8556. **
  8557. ** It is possible to create multiple session objects attached to a single
  8558. ** database handle.
  8559. **
  8560. ** Session objects created using this function should be deleted using the
  8561. ** [sqlite3session_delete()] function before the database handle that they
  8562. ** are attached to is itself closed. If the database handle is closed before
  8563. ** the session object is deleted, then the results of calling any session
  8564. ** module function, including [sqlite3session_delete()] on the session object
  8565. ** are undefined.
  8566. **
  8567. ** Because the session module uses the [sqlite3_preupdate_hook()] API, it
  8568. ** is not possible for an application to register a pre-update hook on a
  8569. ** database handle that has one or more session objects attached. Nor is
  8570. ** it possible to create a session object attached to a database handle for
  8571. ** which a pre-update hook is already defined. The results of attempting
  8572. ** either of these things are undefined.
  8573. **
  8574. ** The session object will be used to create changesets for tables in
  8575. ** database zDb, where zDb is either "main", or "temp", or the name of an
  8576. ** attached database. It is not an error if database zDb is not attached
  8577. ** to the database when the session object is created.
  8578. */
  8579. int sqlite3session_create(
  8580. sqlite3 *db, /* Database handle */
  8581. const char *zDb, /* Name of db (e.g. "main") */
  8582. sqlite3_session **ppSession /* OUT: New session object */
  8583. );
  8584. /*
  8585. ** CAPI3REF: Delete A Session Object
  8586. **
  8587. ** Delete a session object previously allocated using
  8588. ** [sqlite3session_create()]. Once a session object has been deleted, the
  8589. ** results of attempting to use pSession with any other session module
  8590. ** function are undefined.
  8591. **
  8592. ** Session objects must be deleted before the database handle to which they
  8593. ** are attached is closed. Refer to the documentation for
  8594. ** [sqlite3session_create()] for details.
  8595. */
  8596. void sqlite3session_delete(sqlite3_session *pSession);
  8597. /*
  8598. ** CAPI3REF: Enable Or Disable A Session Object
  8599. **
  8600. ** Enable or disable the recording of changes by a session object. When
  8601. ** enabled, a session object records changes made to the database. When
  8602. ** disabled - it does not. A newly created session object is enabled.
  8603. ** Refer to the documentation for [sqlite3session_changeset()] for further
  8604. ** details regarding how enabling and disabling a session object affects
  8605. ** the eventual changesets.
  8606. **
  8607. ** Passing zero to this function disables the session. Passing a value
  8608. ** greater than zero enables it. Passing a value less than zero is a
  8609. ** no-op, and may be used to query the current state of the session.
  8610. **
  8611. ** The return value indicates the final state of the session object: 0 if
  8612. ** the session is disabled, or 1 if it is enabled.
  8613. */
  8614. int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
  8615. /*
  8616. ** CAPI3REF: Set Or Clear the Indirect Change Flag
  8617. **
  8618. ** Each change recorded by a session object is marked as either direct or
  8619. ** indirect. A change is marked as indirect if either:
  8620. **
  8621. ** <ul>
  8622. ** <li> The session object "indirect" flag is set when the change is
  8623. ** made, or
  8624. ** <li> The change is made by an SQL trigger or foreign key action
  8625. ** instead of directly as a result of a users SQL statement.
  8626. ** </ul>
  8627. **
  8628. ** If a single row is affected by more than one operation within a session,
  8629. ** then the change is considered indirect if all operations meet the criteria
  8630. ** for an indirect change above, or direct otherwise.
  8631. **
  8632. ** This function is used to set, clear or query the session object indirect
  8633. ** flag. If the second argument passed to this function is zero, then the
  8634. ** indirect flag is cleared. If it is greater than zero, the indirect flag
  8635. ** is set. Passing a value less than zero does not modify the current value
  8636. ** of the indirect flag, and may be used to query the current state of the
  8637. ** indirect flag for the specified session object.
  8638. **
  8639. ** The return value indicates the final state of the indirect flag: 0 if
  8640. ** it is clear, or 1 if it is set.
  8641. */
  8642. int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
  8643. /*
  8644. ** CAPI3REF: Attach A Table To A Session Object
  8645. **
  8646. ** If argument zTab is not NULL, then it is the name of a table to attach
  8647. ** to the session object passed as the first argument. All subsequent changes
  8648. ** made to the table while the session object is enabled will be recorded. See
  8649. ** documentation for [sqlite3session_changeset()] for further details.
  8650. **
  8651. ** Or, if argument zTab is NULL, then changes are recorded for all tables
  8652. ** in the database. If additional tables are added to the database (by
  8653. ** executing "CREATE TABLE" statements) after this call is made, changes for
  8654. ** the new tables are also recorded.
  8655. **
  8656. ** Changes can only be recorded for tables that have a PRIMARY KEY explicitly
  8657. ** defined as part of their CREATE TABLE statement. It does not matter if the
  8658. ** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
  8659. ** KEY may consist of a single column, or may be a composite key.
  8660. **
  8661. ** It is not an error if the named table does not exist in the database. Nor
  8662. ** is it an error if the named table does not have a PRIMARY KEY. However,
  8663. ** no changes will be recorded in either of these scenarios.
  8664. **
  8665. ** Changes are not recorded for individual rows that have NULL values stored
  8666. ** in one or more of their PRIMARY KEY columns.
  8667. **
  8668. ** SQLITE_OK is returned if the call completes without error. Or, if an error
  8669. ** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
  8670. */
  8671. int sqlite3session_attach(
  8672. sqlite3_session *pSession, /* Session object */
  8673. const char *zTab /* Table name */
  8674. );
  8675. /*
  8676. ** CAPI3REF: Set a table filter on a Session Object.
  8677. **
  8678. ** The second argument (xFilter) is the "filter callback". For changes to rows
  8679. ** in tables that are not attached to the Session object, the filter is called
  8680. ** to determine whether changes to the table's rows should be tracked or not.
  8681. ** If xFilter returns 0, changes is not tracked. Note that once a table is
  8682. ** attached, xFilter will not be called again.
  8683. */
  8684. void sqlite3session_table_filter(
  8685. sqlite3_session *pSession, /* Session object */
  8686. int(*xFilter)(
  8687. void *pCtx, /* Copy of third arg to _filter_table() */
  8688. const char *zTab /* Table name */
  8689. ),
  8690. void *pCtx /* First argument passed to xFilter */
  8691. );
  8692. /*
  8693. ** CAPI3REF: Generate A Changeset From A Session Object
  8694. **
  8695. ** Obtain a changeset containing changes to the tables attached to the
  8696. ** session object passed as the first argument. If successful,
  8697. ** set *ppChangeset to point to a buffer containing the changeset
  8698. ** and *pnChangeset to the size of the changeset in bytes before returning
  8699. ** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to
  8700. ** zero and return an SQLite error code.
  8701. **
  8702. ** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,
  8703. ** each representing a change to a single row of an attached table. An INSERT
  8704. ** change contains the values of each field of a new database row. A DELETE
  8705. ** contains the original values of each field of a deleted database row. An
  8706. ** UPDATE change contains the original values of each field of an updated
  8707. ** database row along with the updated values for each updated non-primary-key
  8708. ** column. It is not possible for an UPDATE change to represent a change that
  8709. ** modifies the values of primary key columns. If such a change is made, it
  8710. ** is represented in a changeset as a DELETE followed by an INSERT.
  8711. **
  8712. ** Changes are not recorded for rows that have NULL values stored in one or
  8713. ** more of their PRIMARY KEY columns. If such a row is inserted or deleted,
  8714. ** no corresponding change is present in the changesets returned by this
  8715. ** function. If an existing row with one or more NULL values stored in
  8716. ** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,
  8717. ** only an INSERT is appears in the changeset. Similarly, if an existing row
  8718. ** with non-NULL PRIMARY KEY values is updated so that one or more of its
  8719. ** PRIMARY KEY columns are set to NULL, the resulting changeset contains a
  8720. ** DELETE change only.
  8721. **
  8722. ** The contents of a changeset may be traversed using an iterator created
  8723. ** using the [sqlite3changeset_start()] API. A changeset may be applied to
  8724. ** a database with a compatible schema using the [sqlite3changeset_apply()]
  8725. ** API.
  8726. **
  8727. ** Within a changeset generated by this function, all changes related to a
  8728. ** single table are grouped together. In other words, when iterating through
  8729. ** a changeset or when applying a changeset to a database, all changes related
  8730. ** to a single table are processed before moving on to the next table. Tables
  8731. ** are sorted in the same order in which they were attached (or auto-attached)
  8732. ** to the sqlite3_session object. The order in which the changes related to
  8733. ** a single table are stored is undefined.
  8734. **
  8735. ** Following a successful call to this function, it is the responsibility of
  8736. ** the caller to eventually free the buffer that *ppChangeset points to using
  8737. ** [sqlite3_free()].
  8738. **
  8739. ** <h3>Changeset Generation</h3>
  8740. **
  8741. ** Once a table has been attached to a session object, the session object
  8742. ** records the primary key values of all new rows inserted into the table.
  8743. ** It also records the original primary key and other column values of any
  8744. ** deleted or updated rows. For each unique primary key value, data is only
  8745. ** recorded once - the first time a row with said primary key is inserted,
  8746. ** updated or deleted in the lifetime of the session.
  8747. **
  8748. ** There is one exception to the previous paragraph: when a row is inserted,
  8749. ** updated or deleted, if one or more of its primary key columns contain a
  8750. ** NULL value, no record of the change is made.
  8751. **
  8752. ** The session object therefore accumulates two types of records - those
  8753. ** that consist of primary key values only (created when the user inserts
  8754. ** a new record) and those that consist of the primary key values and the
  8755. ** original values of other table columns (created when the users deletes
  8756. ** or updates a record).
  8757. **
  8758. ** When this function is called, the requested changeset is created using
  8759. ** both the accumulated records and the current contents of the database
  8760. ** file. Specifically:
  8761. **
  8762. ** <ul>
  8763. ** <li> For each record generated by an insert, the database is queried
  8764. ** for a row with a matching primary key. If one is found, an INSERT
  8765. ** change is added to the changeset. If no such row is found, no change
  8766. ** is added to the changeset.
  8767. **
  8768. ** <li> For each record generated by an update or delete, the database is
  8769. ** queried for a row with a matching primary key. If such a row is
  8770. ** found and one or more of the non-primary key fields have been
  8771. ** modified from their original values, an UPDATE change is added to
  8772. ** the changeset. Or, if no such row is found in the table, a DELETE
  8773. ** change is added to the changeset. If there is a row with a matching
  8774. ** primary key in the database, but all fields contain their original
  8775. ** values, no change is added to the changeset.
  8776. ** </ul>
  8777. **
  8778. ** This means, amongst other things, that if a row is inserted and then later
  8779. ** deleted while a session object is active, neither the insert nor the delete
  8780. ** will be present in the changeset. Or if a row is deleted and then later a
  8781. ** row with the same primary key values inserted while a session object is
  8782. ** active, the resulting changeset will contain an UPDATE change instead of
  8783. ** a DELETE and an INSERT.
  8784. **
  8785. ** When a session object is disabled (see the [sqlite3session_enable()] API),
  8786. ** it does not accumulate records when rows are inserted, updated or deleted.
  8787. ** This may appear to have some counter-intuitive effects if a single row
  8788. ** is written to more than once during a session. For example, if a row
  8789. ** is inserted while a session object is enabled, then later deleted while
  8790. ** the same session object is disabled, no INSERT record will appear in the
  8791. ** changeset, even though the delete took place while the session was disabled.
  8792. ** Or, if one field of a row is updated while a session is disabled, and
  8793. ** another field of the same row is updated while the session is enabled, the
  8794. ** resulting changeset will contain an UPDATE change that updates both fields.
  8795. */
  8796. int sqlite3session_changeset(
  8797. sqlite3_session *pSession, /* Session object */
  8798. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  8799. void **ppChangeset /* OUT: Buffer containing changeset */
  8800. );
  8801. /*
  8802. ** CAPI3REF: Load The Difference Between Tables Into A Session
  8803. **
  8804. ** If it is not already attached to the session object passed as the first
  8805. ** argument, this function attaches table zTbl in the same manner as the
  8806. ** [sqlite3session_attach()] function. If zTbl does not exist, or if it
  8807. ** does not have a primary key, this function is a no-op (but does not return
  8808. ** an error).
  8809. **
  8810. ** Argument zFromDb must be the name of a database ("main", "temp" etc.)
  8811. ** attached to the same database handle as the session object that contains
  8812. ** a table compatible with the table attached to the session by this function.
  8813. ** A table is considered compatible if it:
  8814. **
  8815. ** <ul>
  8816. ** <li> Has the same name,
  8817. ** <li> Has the same set of columns declared in the same order, and
  8818. ** <li> Has the same PRIMARY KEY definition.
  8819. ** </ul>
  8820. **
  8821. ** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
  8822. ** are compatible but do not have any PRIMARY KEY columns, it is not an error
  8823. ** but no changes are added to the session object. As with other session
  8824. ** APIs, tables without PRIMARY KEYs are simply ignored.
  8825. **
  8826. ** This function adds a set of changes to the session object that could be
  8827. ** used to update the table in database zFrom (call this the "from-table")
  8828. ** so that its content is the same as the table attached to the session
  8829. ** object (call this the "to-table"). Specifically:
  8830. **
  8831. ** <ul>
  8832. ** <li> For each row (primary key) that exists in the to-table but not in
  8833. ** the from-table, an INSERT record is added to the session object.
  8834. **
  8835. ** <li> For each row (primary key) that exists in the to-table but not in
  8836. ** the from-table, a DELETE record is added to the session object.
  8837. **
  8838. ** <li> For each row (primary key) that exists in both tables, but features
  8839. ** different in each, an UPDATE record is added to the session.
  8840. ** </ul>
  8841. **
  8842. ** To clarify, if this function is called and then a changeset constructed
  8843. ** using [sqlite3session_changeset()], then after applying that changeset to
  8844. ** database zFrom the contents of the two compatible tables would be
  8845. ** identical.
  8846. **
  8847. ** It an error if database zFrom does not exist or does not contain the
  8848. ** required compatible table.
  8849. **
  8850. ** If the operation successful, SQLITE_OK is returned. Otherwise, an SQLite
  8851. ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
  8852. ** may be set to point to a buffer containing an English language error
  8853. ** message. It is the responsibility of the caller to free this buffer using
  8854. ** sqlite3_free().
  8855. */
  8856. int sqlite3session_diff(
  8857. sqlite3_session *pSession,
  8858. const char *zFromDb,
  8859. const char *zTbl,
  8860. char **pzErrMsg
  8861. );
  8862. /*
  8863. ** CAPI3REF: Generate A Patchset From A Session Object
  8864. **
  8865. ** The differences between a patchset and a changeset are that:
  8866. **
  8867. ** <ul>
  8868. ** <li> DELETE records consist of the primary key fields only. The
  8869. ** original values of other fields are omitted.
  8870. ** <li> The original values of any modified fields are omitted from
  8871. ** UPDATE records.
  8872. ** </ul>
  8873. **
  8874. ** A patchset blob may be used with up to date versions of all
  8875. ** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
  8876. ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
  8877. ** attempting to use a patchset blob with old versions of the
  8878. ** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
  8879. **
  8880. ** Because the non-primary key "old.*" fields are omitted, no
  8881. ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
  8882. ** is passed to the sqlite3changeset_apply() API. Other conflict types work
  8883. ** in the same way as for changesets.
  8884. **
  8885. ** Changes within a patchset are ordered in the same way as for changesets
  8886. ** generated by the sqlite3session_changeset() function (i.e. all changes for
  8887. ** a single table are grouped together, tables appear in the order in which
  8888. ** they were attached to the session object).
  8889. */
  8890. int sqlite3session_patchset(
  8891. sqlite3_session *pSession, /* Session object */
  8892. int *pnPatchset, /* OUT: Size of buffer at *ppChangeset */
  8893. void **ppPatchset /* OUT: Buffer containing changeset */
  8894. );
  8895. /*
  8896. ** CAPI3REF: Test if a changeset has recorded any changes.
  8897. **
  8898. ** Return non-zero if no changes to attached tables have been recorded by
  8899. ** the session object passed as the first argument. Otherwise, if one or
  8900. ** more changes have been recorded, return zero.
  8901. **
  8902. ** Even if this function returns zero, it is possible that calling
  8903. ** [sqlite3session_changeset()] on the session handle may still return a
  8904. ** changeset that contains no changes. This can happen when a row in
  8905. ** an attached table is modified and then later on the original values
  8906. ** are restored. However, if this function returns non-zero, then it is
  8907. ** guaranteed that a call to sqlite3session_changeset() will return a
  8908. ** changeset containing zero changes.
  8909. */
  8910. int sqlite3session_isempty(sqlite3_session *pSession);
  8911. /*
  8912. ** CAPI3REF: Create An Iterator To Traverse A Changeset
  8913. **
  8914. ** Create an iterator used to iterate through the contents of a changeset.
  8915. ** If successful, *pp is set to point to the iterator handle and SQLITE_OK
  8916. ** is returned. Otherwise, if an error occurs, *pp is set to zero and an
  8917. ** SQLite error code is returned.
  8918. **
  8919. ** The following functions can be used to advance and query a changeset
  8920. ** iterator created by this function:
  8921. **
  8922. ** <ul>
  8923. ** <li> [sqlite3changeset_next()]
  8924. ** <li> [sqlite3changeset_op()]
  8925. ** <li> [sqlite3changeset_new()]
  8926. ** <li> [sqlite3changeset_old()]
  8927. ** </ul>
  8928. **
  8929. ** It is the responsibility of the caller to eventually destroy the iterator
  8930. ** by passing it to [sqlite3changeset_finalize()]. The buffer containing the
  8931. ** changeset (pChangeset) must remain valid until after the iterator is
  8932. ** destroyed.
  8933. **
  8934. ** Assuming the changeset blob was created by one of the
  8935. ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
  8936. ** [sqlite3changeset_invert()] functions, all changes within the changeset
  8937. ** that apply to a single table are grouped together. This means that when
  8938. ** an application iterates through a changeset using an iterator created by
  8939. ** this function, all changes that relate to a single table are visited
  8940. ** consecutively. There is no chance that the iterator will visit a change
  8941. ** the applies to table X, then one for table Y, and then later on visit
  8942. ** another change for table X.
  8943. */
  8944. int sqlite3changeset_start(
  8945. sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
  8946. int nChangeset, /* Size of changeset blob in bytes */
  8947. void *pChangeset /* Pointer to blob containing changeset */
  8948. );
  8949. /*
  8950. ** CAPI3REF: Advance A Changeset Iterator
  8951. **
  8952. ** This function may only be used with iterators created by function
  8953. ** [sqlite3changeset_start()]. If it is called on an iterator passed to
  8954. ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
  8955. ** is returned and the call has no effect.
  8956. **
  8957. ** Immediately after an iterator is created by sqlite3changeset_start(), it
  8958. ** does not point to any change in the changeset. Assuming the changeset
  8959. ** is not empty, the first call to this function advances the iterator to
  8960. ** point to the first change in the changeset. Each subsequent call advances
  8961. ** the iterator to point to the next change in the changeset (if any). If
  8962. ** no error occurs and the iterator points to a valid change after a call
  8963. ** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
  8964. ** Otherwise, if all changes in the changeset have already been visited,
  8965. ** SQLITE_DONE is returned.
  8966. **
  8967. ** If an error occurs, an SQLite error code is returned. Possible error
  8968. ** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
  8969. ** SQLITE_NOMEM.
  8970. */
  8971. int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
  8972. /*
  8973. ** CAPI3REF: Obtain The Current Operation From A Changeset Iterator
  8974. **
  8975. ** The pIter argument passed to this function may either be an iterator
  8976. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  8977. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  8978. ** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this
  8979. ** is not the case, this function returns [SQLITE_MISUSE].
  8980. **
  8981. ** If argument pzTab is not NULL, then *pzTab is set to point to a
  8982. ** nul-terminated utf-8 encoded string containing the name of the table
  8983. ** affected by the current change. The buffer remains valid until either
  8984. ** sqlite3changeset_next() is called on the iterator or until the
  8985. ** conflict-handler function returns. If pnCol is not NULL, then *pnCol is
  8986. ** set to the number of columns in the table affected by the change. If
  8987. ** pbIncorrect is not NULL, then *pbIndirect is set to true (1) if the change
  8988. ** is an indirect change, or false (0) otherwise. See the documentation for
  8989. ** [sqlite3session_indirect()] for a description of direct and indirect
  8990. ** changes. Finally, if pOp is not NULL, then *pOp is set to one of
  8991. ** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the
  8992. ** type of change that the iterator currently points to.
  8993. **
  8994. ** If no error occurs, SQLITE_OK is returned. If an error does occur, an
  8995. ** SQLite error code is returned. The values of the output variables may not
  8996. ** be trusted in this case.
  8997. */
  8998. int sqlite3changeset_op(
  8999. sqlite3_changeset_iter *pIter, /* Iterator object */
  9000. const char **pzTab, /* OUT: Pointer to table name */
  9001. int *pnCol, /* OUT: Number of columns in table */
  9002. int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
  9003. int *pbIndirect /* OUT: True for an 'indirect' change */
  9004. );
  9005. /*
  9006. ** CAPI3REF: Obtain The Primary Key Definition Of A Table
  9007. **
  9008. ** For each modified table, a changeset includes the following:
  9009. **
  9010. ** <ul>
  9011. ** <li> The number of columns in the table, and
  9012. ** <li> Which of those columns make up the tables PRIMARY KEY.
  9013. ** </ul>
  9014. **
  9015. ** This function is used to find which columns comprise the PRIMARY KEY of
  9016. ** the table modified by the change that iterator pIter currently points to.
  9017. ** If successful, *pabPK is set to point to an array of nCol entries, where
  9018. ** nCol is the number of columns in the table. Elements of *pabPK are set to
  9019. ** 0x01 if the corresponding column is part of the tables primary key, or
  9020. ** 0x00 if it is not.
  9021. **
  9022. ** If argument pnCol is not NULL, then *pnCol is set to the number of columns
  9023. ** in the table.
  9024. **
  9025. ** If this function is called when the iterator does not point to a valid
  9026. ** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,
  9027. ** SQLITE_OK is returned and the output variables populated as described
  9028. ** above.
  9029. */
  9030. int sqlite3changeset_pk(
  9031. sqlite3_changeset_iter *pIter, /* Iterator object */
  9032. unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
  9033. int *pnCol /* OUT: Number of entries in output array */
  9034. );
  9035. /*
  9036. ** CAPI3REF: Obtain old.* Values From A Changeset Iterator
  9037. **
  9038. ** The pIter argument passed to this function may either be an iterator
  9039. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  9040. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  9041. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
  9042. ** Furthermore, it may only be called if the type of change that the iterator
  9043. ** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
  9044. ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
  9045. **
  9046. ** Argument iVal must be greater than or equal to 0, and less than the number
  9047. ** of columns in the table affected by the current change. Otherwise,
  9048. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  9049. **
  9050. ** If successful, this function sets *ppValue to point to a protected
  9051. ** sqlite3_value object containing the iVal'th value from the vector of
  9052. ** original row values stored as part of the UPDATE or DELETE change and
  9053. ** returns SQLITE_OK. The name of the function comes from the fact that this
  9054. ** is similar to the "old.*" columns available to update or delete triggers.
  9055. **
  9056. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  9057. ** is returned and *ppValue is set to NULL.
  9058. */
  9059. int sqlite3changeset_old(
  9060. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  9061. int iVal, /* Column number */
  9062. sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
  9063. );
  9064. /*
  9065. ** CAPI3REF: Obtain new.* Values From A Changeset Iterator
  9066. **
  9067. ** The pIter argument passed to this function may either be an iterator
  9068. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  9069. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  9070. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
  9071. ** Furthermore, it may only be called if the type of change that the iterator
  9072. ** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
  9073. ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
  9074. **
  9075. ** Argument iVal must be greater than or equal to 0, and less than the number
  9076. ** of columns in the table affected by the current change. Otherwise,
  9077. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  9078. **
  9079. ** If successful, this function sets *ppValue to point to a protected
  9080. ** sqlite3_value object containing the iVal'th value from the vector of
  9081. ** new row values stored as part of the UPDATE or INSERT change and
  9082. ** returns SQLITE_OK. If the change is an UPDATE and does not include
  9083. ** a new value for the requested column, *ppValue is set to NULL and
  9084. ** SQLITE_OK returned. The name of the function comes from the fact that
  9085. ** this is similar to the "new.*" columns available to update or delete
  9086. ** triggers.
  9087. **
  9088. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  9089. ** is returned and *ppValue is set to NULL.
  9090. */
  9091. int sqlite3changeset_new(
  9092. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  9093. int iVal, /* Column number */
  9094. sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
  9095. );
  9096. /*
  9097. ** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator
  9098. **
  9099. ** This function should only be used with iterator objects passed to a
  9100. ** conflict-handler callback by [sqlite3changeset_apply()] with either
  9101. ** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function
  9102. ** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue
  9103. ** is set to NULL.
  9104. **
  9105. ** Argument iVal must be greater than or equal to 0, and less than the number
  9106. ** of columns in the table affected by the current change. Otherwise,
  9107. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  9108. **
  9109. ** If successful, this function sets *ppValue to point to a protected
  9110. ** sqlite3_value object containing the iVal'th value from the
  9111. ** "conflicting row" associated with the current conflict-handler callback
  9112. ** and returns SQLITE_OK.
  9113. **
  9114. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  9115. ** is returned and *ppValue is set to NULL.
  9116. */
  9117. int sqlite3changeset_conflict(
  9118. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  9119. int iVal, /* Column number */
  9120. sqlite3_value **ppValue /* OUT: Value from conflicting row */
  9121. );
  9122. /*
  9123. ** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations
  9124. **
  9125. ** This function may only be called with an iterator passed to an
  9126. ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
  9127. ** it sets the output variable to the total number of known foreign key
  9128. ** violations in the destination database and returns SQLITE_OK.
  9129. **
  9130. ** In all other cases this function returns SQLITE_MISUSE.
  9131. */
  9132. int sqlite3changeset_fk_conflicts(
  9133. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  9134. int *pnOut /* OUT: Number of FK violations */
  9135. );
  9136. /*
  9137. ** CAPI3REF: Finalize A Changeset Iterator
  9138. **
  9139. ** This function is used to finalize an iterator allocated with
  9140. ** [sqlite3changeset_start()].
  9141. **
  9142. ** This function should only be called on iterators created using the
  9143. ** [sqlite3changeset_start()] function. If an application calls this
  9144. ** function with an iterator passed to a conflict-handler by
  9145. ** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the
  9146. ** call has no effect.
  9147. **
  9148. ** If an error was encountered within a call to an sqlite3changeset_xxx()
  9149. ** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
  9150. ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
  9151. ** to that error is returned by this function. Otherwise, SQLITE_OK is
  9152. ** returned. This is to allow the following pattern (pseudo-code):
  9153. **
  9154. ** sqlite3changeset_start();
  9155. ** while( SQLITE_ROW==sqlite3changeset_next() ){
  9156. ** // Do something with change.
  9157. ** }
  9158. ** rc = sqlite3changeset_finalize();
  9159. ** if( rc!=SQLITE_OK ){
  9160. ** // An error has occurred
  9161. ** }
  9162. */
  9163. int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);
  9164. /*
  9165. ** CAPI3REF: Invert A Changeset
  9166. **
  9167. ** This function is used to "invert" a changeset object. Applying an inverted
  9168. ** changeset to a database reverses the effects of applying the uninverted
  9169. ** changeset. Specifically:
  9170. **
  9171. ** <ul>
  9172. ** <li> Each DELETE change is changed to an INSERT, and
  9173. ** <li> Each INSERT change is changed to a DELETE, and
  9174. ** <li> For each UPDATE change, the old.* and new.* values are exchanged.
  9175. ** </ul>
  9176. **
  9177. ** This function does not change the order in which changes appear within
  9178. ** the changeset. It merely reverses the sense of each individual change.
  9179. **
  9180. ** If successful, a pointer to a buffer containing the inverted changeset
  9181. ** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and
  9182. ** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are
  9183. ** zeroed and an SQLite error code returned.
  9184. **
  9185. ** It is the responsibility of the caller to eventually call sqlite3_free()
  9186. ** on the *ppOut pointer to free the buffer allocation following a successful
  9187. ** call to this function.
  9188. **
  9189. ** WARNING/TODO: This function currently assumes that the input is a valid
  9190. ** changeset. If it is not, the results are undefined.
  9191. */
  9192. int sqlite3changeset_invert(
  9193. int nIn, const void *pIn, /* Input changeset */
  9194. int *pnOut, void **ppOut /* OUT: Inverse of input */
  9195. );
  9196. /*
  9197. ** CAPI3REF: Concatenate Two Changeset Objects
  9198. **
  9199. ** This function is used to concatenate two changesets, A and B, into a
  9200. ** single changeset. The result is a changeset equivalent to applying
  9201. ** changeset A followed by changeset B.
  9202. **
  9203. ** This function combines the two input changesets using an
  9204. ** sqlite3_changegroup object. Calling it produces similar results as the
  9205. ** following code fragment:
  9206. **
  9207. ** sqlite3_changegroup *pGrp;
  9208. ** rc = sqlite3_changegroup_new(&pGrp);
  9209. ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);
  9210. ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);
  9211. ** if( rc==SQLITE_OK ){
  9212. ** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
  9213. ** }else{
  9214. ** *ppOut = 0;
  9215. ** *pnOut = 0;
  9216. ** }
  9217. **
  9218. ** Refer to the sqlite3_changegroup documentation below for details.
  9219. */
  9220. int sqlite3changeset_concat(
  9221. int nA, /* Number of bytes in buffer pA */
  9222. void *pA, /* Pointer to buffer containing changeset A */
  9223. int nB, /* Number of bytes in buffer pB */
  9224. void *pB, /* Pointer to buffer containing changeset B */
  9225. int *pnOut, /* OUT: Number of bytes in output changeset */
  9226. void **ppOut /* OUT: Buffer containing output changeset */
  9227. );
  9228. /*
  9229. ** CAPI3REF: Changegroup Handle
  9230. */
  9231. typedef struct sqlite3_changegroup sqlite3_changegroup;
  9232. /*
  9233. ** CAPI3REF: Create A New Changegroup Object
  9234. **
  9235. ** An sqlite3_changegroup object is used to combine two or more changesets
  9236. ** (or patchsets) into a single changeset (or patchset). A single changegroup
  9237. ** object may combine changesets or patchsets, but not both. The output is
  9238. ** always in the same format as the input.
  9239. **
  9240. ** If successful, this function returns SQLITE_OK and populates (*pp) with
  9241. ** a pointer to a new sqlite3_changegroup object before returning. The caller
  9242. ** should eventually free the returned object using a call to
  9243. ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
  9244. ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
  9245. **
  9246. ** The usual usage pattern for an sqlite3_changegroup object is as follows:
  9247. **
  9248. ** <ul>
  9249. ** <li> It is created using a call to sqlite3changegroup_new().
  9250. **
  9251. ** <li> Zero or more changesets (or patchsets) are added to the object
  9252. ** by calling sqlite3changegroup_add().
  9253. **
  9254. ** <li> The result of combining all input changesets together is obtained
  9255. ** by the application via a call to sqlite3changegroup_output().
  9256. **
  9257. ** <li> The object is deleted using a call to sqlite3changegroup_delete().
  9258. ** </ul>
  9259. **
  9260. ** Any number of calls to add() and output() may be made between the calls to
  9261. ** new() and delete(), and in any order.
  9262. **
  9263. ** As well as the regular sqlite3changegroup_add() and
  9264. ** sqlite3changegroup_output() functions, also available are the streaming
  9265. ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
  9266. */
  9267. int sqlite3changegroup_new(sqlite3_changegroup **pp);
  9268. /*
  9269. ** CAPI3REF: Add A Changeset To A Changegroup
  9270. **
  9271. ** Add all changes within the changeset (or patchset) in buffer pData (size
  9272. ** nData bytes) to the changegroup.
  9273. **
  9274. ** If the buffer contains a patchset, then all prior calls to this function
  9275. ** on the same changegroup object must also have specified patchsets. Or, if
  9276. ** the buffer contains a changeset, so must have the earlier calls to this
  9277. ** function. Otherwise, SQLITE_ERROR is returned and no changes are added
  9278. ** to the changegroup.
  9279. **
  9280. ** Rows within the changeset and changegroup are identified by the values in
  9281. ** their PRIMARY KEY columns. A change in the changeset is considered to
  9282. ** apply to the same row as a change already present in the changegroup if
  9283. ** the two rows have the same primary key.
  9284. **
  9285. ** Changes to rows that do not already appear in the changegroup are
  9286. ** simply copied into it. Or, if both the new changeset and the changegroup
  9287. ** contain changes that apply to a single row, the final contents of the
  9288. ** changegroup depends on the type of each change, as follows:
  9289. **
  9290. ** <table border=1 style="margin-left:8ex;margin-right:8ex">
  9291. ** <tr><th style="white-space:pre">Existing Change </th>
  9292. ** <th style="white-space:pre">New Change </th>
  9293. ** <th>Output Change
  9294. ** <tr><td>INSERT <td>INSERT <td>
  9295. ** The new change is ignored. This case does not occur if the new
  9296. ** changeset was recorded immediately after the changesets already
  9297. ** added to the changegroup.
  9298. ** <tr><td>INSERT <td>UPDATE <td>
  9299. ** The INSERT change remains in the changegroup. The values in the
  9300. ** INSERT change are modified as if the row was inserted by the
  9301. ** existing change and then updated according to the new change.
  9302. ** <tr><td>INSERT <td>DELETE <td>
  9303. ** The existing INSERT is removed from the changegroup. The DELETE is
  9304. ** not added.
  9305. ** <tr><td>UPDATE <td>INSERT <td>
  9306. ** The new change is ignored. This case does not occur if the new
  9307. ** changeset was recorded immediately after the changesets already
  9308. ** added to the changegroup.
  9309. ** <tr><td>UPDATE <td>UPDATE <td>
  9310. ** The existing UPDATE remains within the changegroup. It is amended
  9311. ** so that the accompanying values are as if the row was updated once
  9312. ** by the existing change and then again by the new change.
  9313. ** <tr><td>UPDATE <td>DELETE <td>
  9314. ** The existing UPDATE is replaced by the new DELETE within the
  9315. ** changegroup.
  9316. ** <tr><td>DELETE <td>INSERT <td>
  9317. ** If one or more of the column values in the row inserted by the
  9318. ** new change differ from those in the row deleted by the existing
  9319. ** change, the existing DELETE is replaced by an UPDATE within the
  9320. ** changegroup. Otherwise, if the inserted row is exactly the same
  9321. ** as the deleted row, the existing DELETE is simply discarded.
  9322. ** <tr><td>DELETE <td>UPDATE <td>
  9323. ** The new change is ignored. This case does not occur if the new
  9324. ** changeset was recorded immediately after the changesets already
  9325. ** added to the changegroup.
  9326. ** <tr><td>DELETE <td>DELETE <td>
  9327. ** The new change is ignored. This case does not occur if the new
  9328. ** changeset was recorded immediately after the changesets already
  9329. ** added to the changegroup.
  9330. ** </table>
  9331. **
  9332. ** If the new changeset contains changes to a table that is already present
  9333. ** in the changegroup, then the number of columns and the position of the
  9334. ** primary key columns for the table must be consistent. If this is not the
  9335. ** case, this function fails with SQLITE_SCHEMA. If the input changeset
  9336. ** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is
  9337. ** returned. Or, if an out-of-memory condition occurs during processing, this
  9338. ** function returns SQLITE_NOMEM. In all cases, if an error occurs the
  9339. ** final contents of the changegroup is undefined.
  9340. **
  9341. ** If no error occurs, SQLITE_OK is returned.
  9342. */
  9343. int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
  9344. /*
  9345. ** CAPI3REF: Obtain A Composite Changeset From A Changegroup
  9346. **
  9347. ** Obtain a buffer containing a changeset (or patchset) representing the
  9348. ** current contents of the changegroup. If the inputs to the changegroup
  9349. ** were themselves changesets, the output is a changeset. Or, if the
  9350. ** inputs were patchsets, the output is also a patchset.
  9351. **
  9352. ** As with the output of the sqlite3session_changeset() and
  9353. ** sqlite3session_patchset() functions, all changes related to a single
  9354. ** table are grouped together in the output of this function. Tables appear
  9355. ** in the same order as for the very first changeset added to the changegroup.
  9356. ** If the second or subsequent changesets added to the changegroup contain
  9357. ** changes for tables that do not appear in the first changeset, they are
  9358. ** appended onto the end of the output changeset, again in the order in
  9359. ** which they are first encountered.
  9360. **
  9361. ** If an error occurs, an SQLite error code is returned and the output
  9362. ** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK
  9363. ** is returned and the output variables are set to the size of and a
  9364. ** pointer to the output buffer, respectively. In this case it is the
  9365. ** responsibility of the caller to eventually free the buffer using a
  9366. ** call to sqlite3_free().
  9367. */
  9368. int sqlite3changegroup_output(
  9369. sqlite3_changegroup*,
  9370. int *pnData, /* OUT: Size of output buffer in bytes */
  9371. void **ppData /* OUT: Pointer to output buffer */
  9372. );
  9373. /*
  9374. ** CAPI3REF: Delete A Changegroup Object
  9375. */
  9376. void sqlite3changegroup_delete(sqlite3_changegroup*);
  9377. /*
  9378. ** CAPI3REF: Apply A Changeset To A Database
  9379. **
  9380. ** Apply a changeset to a database. This function attempts to update the
  9381. ** "main" database attached to handle db with the changes found in the
  9382. ** changeset passed via the second and third arguments.
  9383. **
  9384. ** The fourth argument (xFilter) passed to this function is the "filter
  9385. ** callback". If it is not NULL, then for each table affected by at least one
  9386. ** change in the changeset, the filter callback is invoked with
  9387. ** the table name as the second argument, and a copy of the context pointer
  9388. ** passed as the sixth argument to this function as the first. If the "filter
  9389. ** callback" returns zero, then no attempt is made to apply any changes to
  9390. ** the table. Otherwise, if the return value is non-zero or the xFilter
  9391. ** argument to this function is NULL, all changes related to the table are
  9392. ** attempted.
  9393. **
  9394. ** For each table that is not excluded by the filter callback, this function
  9395. ** tests that the target database contains a compatible table. A table is
  9396. ** considered compatible if all of the following are true:
  9397. **
  9398. ** <ul>
  9399. ** <li> The table has the same name as the name recorded in the
  9400. ** changeset, and
  9401. ** <li> The table has the same number of columns as recorded in the
  9402. ** changeset, and
  9403. ** <li> The table has primary key columns in the same position as
  9404. ** recorded in the changeset.
  9405. ** </ul>
  9406. **
  9407. ** If there is no compatible table, it is not an error, but none of the
  9408. ** changes associated with the table are applied. A warning message is issued
  9409. ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
  9410. ** one such warning is issued for each table in the changeset.
  9411. **
  9412. ** For each change for which there is a compatible table, an attempt is made
  9413. ** to modify the table contents according to the UPDATE, INSERT or DELETE
  9414. ** change. If a change cannot be applied cleanly, the conflict handler
  9415. ** function passed as the fifth argument to sqlite3changeset_apply() may be
  9416. ** invoked. A description of exactly when the conflict handler is invoked for
  9417. ** each type of change is below.
  9418. **
  9419. ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
  9420. ** of passing anything other than a valid function pointer as the xConflict
  9421. ** argument are undefined.
  9422. **
  9423. ** Each time the conflict handler function is invoked, it must return one
  9424. ** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
  9425. ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
  9426. ** if the second argument passed to the conflict handler is either
  9427. ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
  9428. ** returns an illegal value, any changes already made are rolled back and
  9429. ** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
  9430. ** actions are taken by sqlite3changeset_apply() depending on the value
  9431. ** returned by each invocation of the conflict-handler function. Refer to
  9432. ** the documentation for the three
  9433. ** [SQLITE_CHANGESET_OMIT|available return values] for details.
  9434. **
  9435. ** <dl>
  9436. ** <dt>DELETE Changes<dd>
  9437. ** For each DELETE change, this function checks if the target database
  9438. ** contains a row with the same primary key value (or values) as the
  9439. ** original row values stored in the changeset. If it does, and the values
  9440. ** stored in all non-primary key columns also match the values stored in
  9441. ** the changeset the row is deleted from the target database.
  9442. **
  9443. ** If a row with matching primary key values is found, but one or more of
  9444. ** the non-primary key fields contains a value different from the original
  9445. ** row value stored in the changeset, the conflict-handler function is
  9446. ** invoked with [SQLITE_CHANGESET_DATA] as the second argument.
  9447. **
  9448. ** If no row with matching primary key values is found in the database,
  9449. ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
  9450. ** passed as the second argument.
  9451. **
  9452. ** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT
  9453. ** (which can only happen if a foreign key constraint is violated), the
  9454. ** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]
  9455. ** passed as the second argument. This includes the case where the DELETE
  9456. ** operation is attempted because an earlier call to the conflict handler
  9457. ** function returned [SQLITE_CHANGESET_REPLACE].
  9458. **
  9459. ** <dt>INSERT Changes<dd>
  9460. ** For each INSERT change, an attempt is made to insert the new row into
  9461. ** the database.
  9462. **
  9463. ** If the attempt to insert the row fails because the database already
  9464. ** contains a row with the same primary key values, the conflict handler
  9465. ** function is invoked with the second argument set to
  9466. ** [SQLITE_CHANGESET_CONFLICT].
  9467. **
  9468. ** If the attempt to insert the row fails because of some other constraint
  9469. ** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
  9470. ** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
  9471. ** This includes the case where the INSERT operation is re-attempted because
  9472. ** an earlier call to the conflict handler function returned
  9473. ** [SQLITE_CHANGESET_REPLACE].
  9474. **
  9475. ** <dt>UPDATE Changes<dd>
  9476. ** For each UPDATE change, this function checks if the target database
  9477. ** contains a row with the same primary key value (or values) as the
  9478. ** original row values stored in the changeset. If it does, and the values
  9479. ** stored in all non-primary key columns also match the values stored in
  9480. ** the changeset the row is updated within the target database.
  9481. **
  9482. ** If a row with matching primary key values is found, but one or more of
  9483. ** the non-primary key fields contains a value different from an original
  9484. ** row value stored in the changeset, the conflict-handler function is
  9485. ** invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since
  9486. ** UPDATE changes only contain values for non-primary key fields that are
  9487. ** to be modified, only those fields need to match the original values to
  9488. ** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.
  9489. **
  9490. ** If no row with matching primary key values is found in the database,
  9491. ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
  9492. ** passed as the second argument.
  9493. **
  9494. ** If the UPDATE operation is attempted, but SQLite returns
  9495. ** SQLITE_CONSTRAINT, the conflict-handler function is invoked with
  9496. ** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
  9497. ** This includes the case where the UPDATE operation is attempted after
  9498. ** an earlier call to the conflict handler function returned
  9499. ** [SQLITE_CHANGESET_REPLACE].
  9500. ** </dl>
  9501. **
  9502. ** It is safe to execute SQL statements, including those that write to the
  9503. ** table that the callback related to, from within the xConflict callback.
  9504. ** This can be used to further customize the applications conflict
  9505. ** resolution strategy.
  9506. **
  9507. ** All changes made by this function are enclosed in a savepoint transaction.
  9508. ** If any other error (aside from a constraint failure when attempting to
  9509. ** write to the target database) occurs, then the savepoint transaction is
  9510. ** rolled back, restoring the target database to its original state, and an
  9511. ** SQLite error code returned.
  9512. */
  9513. int sqlite3changeset_apply(
  9514. sqlite3 *db, /* Apply change to "main" db of this handle */
  9515. int nChangeset, /* Size of changeset in bytes */
  9516. void *pChangeset, /* Changeset blob */
  9517. int(*xFilter)(
  9518. void *pCtx, /* Copy of sixth arg to _apply() */
  9519. const char *zTab /* Table name */
  9520. ),
  9521. int(*xConflict)(
  9522. void *pCtx, /* Copy of sixth arg to _apply() */
  9523. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  9524. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  9525. ),
  9526. void *pCtx /* First argument passed to xConflict */
  9527. );
  9528. /*
  9529. ** CAPI3REF: Constants Passed To The Conflict Handler
  9530. **
  9531. ** Values that may be passed as the second argument to a conflict-handler.
  9532. **
  9533. ** <dl>
  9534. ** <dt>SQLITE_CHANGESET_DATA<dd>
  9535. ** The conflict handler is invoked with CHANGESET_DATA as the second argument
  9536. ** when processing a DELETE or UPDATE change if a row with the required
  9537. ** PRIMARY KEY fields is present in the database, but one or more other
  9538. ** (non primary-key) fields modified by the update do not contain the
  9539. ** expected "before" values.
  9540. **
  9541. ** The conflicting row, in this case, is the database row with the matching
  9542. ** primary key.
  9543. **
  9544. ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
  9545. ** The conflict handler is invoked with CHANGESET_NOTFOUND as the second
  9546. ** argument when processing a DELETE or UPDATE change if a row with the
  9547. ** required PRIMARY KEY fields is not present in the database.
  9548. **
  9549. ** There is no conflicting row in this case. The results of invoking the
  9550. ** sqlite3changeset_conflict() API are undefined.
  9551. **
  9552. ** <dt>SQLITE_CHANGESET_CONFLICT<dd>
  9553. ** CHANGESET_CONFLICT is passed as the second argument to the conflict
  9554. ** handler while processing an INSERT change if the operation would result
  9555. ** in duplicate primary key values.
  9556. **
  9557. ** The conflicting row in this case is the database row with the matching
  9558. ** primary key.
  9559. **
  9560. ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
  9561. ** If foreign key handling is enabled, and applying a changeset leaves the
  9562. ** database in a state containing foreign key violations, the conflict
  9563. ** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
  9564. ** exactly once before the changeset is committed. If the conflict handler
  9565. ** returns CHANGESET_OMIT, the changes, including those that caused the
  9566. ** foreign key constraint violation, are committed. Or, if it returns
  9567. ** CHANGESET_ABORT, the changeset is rolled back.
  9568. **
  9569. ** No current or conflicting row information is provided. The only function
  9570. ** it is possible to call on the supplied sqlite3_changeset_iter handle
  9571. ** is sqlite3changeset_fk_conflicts().
  9572. **
  9573. ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
  9574. ** If any other constraint violation occurs while applying a change (i.e.
  9575. ** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
  9576. ** invoked with CHANGESET_CONSTRAINT as the second argument.
  9577. **
  9578. ** There is no conflicting row in this case. The results of invoking the
  9579. ** sqlite3changeset_conflict() API are undefined.
  9580. **
  9581. ** </dl>
  9582. */
  9583. #define SQLITE_CHANGESET_DATA 1
  9584. #define SQLITE_CHANGESET_NOTFOUND 2
  9585. #define SQLITE_CHANGESET_CONFLICT 3
  9586. #define SQLITE_CHANGESET_CONSTRAINT 4
  9587. #define SQLITE_CHANGESET_FOREIGN_KEY 5
  9588. /*
  9589. ** CAPI3REF: Constants Returned By The Conflict Handler
  9590. **
  9591. ** A conflict handler callback must return one of the following three values.
  9592. **
  9593. ** <dl>
  9594. ** <dt>SQLITE_CHANGESET_OMIT<dd>
  9595. ** If a conflict handler returns this value no special action is taken. The
  9596. ** change that caused the conflict is not applied. The session module
  9597. ** continues to the next change in the changeset.
  9598. **
  9599. ** <dt>SQLITE_CHANGESET_REPLACE<dd>
  9600. ** This value may only be returned if the second argument to the conflict
  9601. ** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this
  9602. ** is not the case, any changes applied so far are rolled back and the
  9603. ** call to sqlite3changeset_apply() returns SQLITE_MISUSE.
  9604. **
  9605. ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
  9606. ** handler, then the conflicting row is either updated or deleted, depending
  9607. ** on the type of change.
  9608. **
  9609. ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict
  9610. ** handler, then the conflicting row is removed from the database and a
  9611. ** second attempt to apply the change is made. If this second attempt fails,
  9612. ** the original row is restored to the database before continuing.
  9613. **
  9614. ** <dt>SQLITE_CHANGESET_ABORT<dd>
  9615. ** If this value is returned, any changes applied so far are rolled back
  9616. ** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
  9617. ** </dl>
  9618. */
  9619. #define SQLITE_CHANGESET_OMIT 0
  9620. #define SQLITE_CHANGESET_REPLACE 1
  9621. #define SQLITE_CHANGESET_ABORT 2
  9622. /*
  9623. ** CAPI3REF: Streaming Versions of API functions.
  9624. **
  9625. ** The six streaming API xxx_strm() functions serve similar purposes to the
  9626. ** corresponding non-streaming API functions:
  9627. **
  9628. ** <table border=1 style="margin-left:8ex;margin-right:8ex">
  9629. ** <tr><th>Streaming function<th>Non-streaming equivalent</th>
  9630. ** <tr><td>sqlite3changeset_apply_str<td>[sqlite3changeset_apply]
  9631. ** <tr><td>sqlite3changeset_concat_str<td>[sqlite3changeset_concat]
  9632. ** <tr><td>sqlite3changeset_invert_str<td>[sqlite3changeset_invert]
  9633. ** <tr><td>sqlite3changeset_start_str<td>[sqlite3changeset_start]
  9634. ** <tr><td>sqlite3session_changeset_str<td>[sqlite3session_changeset]
  9635. ** <tr><td>sqlite3session_patchset_str<td>[sqlite3session_patchset]
  9636. ** </table>
  9637. **
  9638. ** Non-streaming functions that accept changesets (or patchsets) as input
  9639. ** require that the entire changeset be stored in a single buffer in memory.
  9640. ** Similarly, those that return a changeset or patchset do so by returning
  9641. ** a pointer to a single large buffer allocated using sqlite3_malloc().
  9642. ** Normally this is convenient. However, if an application running in a
  9643. ** low-memory environment is required to handle very large changesets, the
  9644. ** large contiguous memory allocations required can become onerous.
  9645. **
  9646. ** In order to avoid this problem, instead of a single large buffer, input
  9647. ** is passed to a streaming API functions by way of a callback function that
  9648. ** the sessions module invokes to incrementally request input data as it is
  9649. ** required. In all cases, a pair of API function parameters such as
  9650. **
  9651. ** <pre>
  9652. ** &nbsp; int nChangeset,
  9653. ** &nbsp; void *pChangeset,
  9654. ** </pre>
  9655. **
  9656. ** Is replaced by:
  9657. **
  9658. ** <pre>
  9659. ** &nbsp; int (*xInput)(void *pIn, void *pData, int *pnData),
  9660. ** &nbsp; void *pIn,
  9661. ** </pre>
  9662. **
  9663. ** Each time the xInput callback is invoked by the sessions module, the first
  9664. ** argument passed is a copy of the supplied pIn context pointer. The second
  9665. ** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no
  9666. ** error occurs the xInput method should copy up to (*pnData) bytes of data
  9667. ** into the buffer and set (*pnData) to the actual number of bytes copied
  9668. ** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)
  9669. ** should be set to zero to indicate this. Or, if an error occurs, an SQLite
  9670. ** error code should be returned. In all cases, if an xInput callback returns
  9671. ** an error, all processing is abandoned and the streaming API function
  9672. ** returns a copy of the error code to the caller.
  9673. **
  9674. ** In the case of sqlite3changeset_start_strm(), the xInput callback may be
  9675. ** invoked by the sessions module at any point during the lifetime of the
  9676. ** iterator. If such an xInput callback returns an error, the iterator enters
  9677. ** an error state, whereby all subsequent calls to iterator functions
  9678. ** immediately fail with the same error code as returned by xInput.
  9679. **
  9680. ** Similarly, streaming API functions that return changesets (or patchsets)
  9681. ** return them in chunks by way of a callback function instead of via a
  9682. ** pointer to a single large buffer. In this case, a pair of parameters such
  9683. ** as:
  9684. **
  9685. ** <pre>
  9686. ** &nbsp; int *pnChangeset,
  9687. ** &nbsp; void **ppChangeset,
  9688. ** </pre>
  9689. **
  9690. ** Is replaced by:
  9691. **
  9692. ** <pre>
  9693. ** &nbsp; int (*xOutput)(void *pOut, const void *pData, int nData),
  9694. ** &nbsp; void *pOut
  9695. ** </pre>
  9696. **
  9697. ** The xOutput callback is invoked zero or more times to return data to
  9698. ** the application. The first parameter passed to each call is a copy of the
  9699. ** pOut pointer supplied by the application. The second parameter, pData,
  9700. ** points to a buffer nData bytes in size containing the chunk of output
  9701. ** data being returned. If the xOutput callback successfully processes the
  9702. ** supplied data, it should return SQLITE_OK to indicate success. Otherwise,
  9703. ** it should return some other SQLite error code. In this case processing
  9704. ** is immediately abandoned and the streaming API function returns a copy
  9705. ** of the xOutput error code to the application.
  9706. **
  9707. ** The sessions module never invokes an xOutput callback with the third
  9708. ** parameter set to a value less than or equal to zero. Other than this,
  9709. ** no guarantees are made as to the size of the chunks of data returned.
  9710. */
  9711. int sqlite3changeset_apply_strm(
  9712. sqlite3 *db, /* Apply change to "main" db of this handle */
  9713. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  9714. void *pIn, /* First arg for xInput */
  9715. int(*xFilter)(
  9716. void *pCtx, /* Copy of sixth arg to _apply() */
  9717. const char *zTab /* Table name */
  9718. ),
  9719. int(*xConflict)(
  9720. void *pCtx, /* Copy of sixth arg to _apply() */
  9721. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  9722. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  9723. ),
  9724. void *pCtx /* First argument passed to xConflict */
  9725. );
  9726. int sqlite3changeset_concat_strm(
  9727. int (*xInputA)(void *pIn, void *pData, int *pnData),
  9728. void *pInA,
  9729. int (*xInputB)(void *pIn, void *pData, int *pnData),
  9730. void *pInB,
  9731. int (*xOutput)(void *pOut, const void *pData, int nData),
  9732. void *pOut
  9733. );
  9734. int sqlite3changeset_invert_strm(
  9735. int (*xInput)(void *pIn, void *pData, int *pnData),
  9736. void *pIn,
  9737. int (*xOutput)(void *pOut, const void *pData, int nData),
  9738. void *pOut
  9739. );
  9740. int sqlite3changeset_start_strm(
  9741. sqlite3_changeset_iter **pp,
  9742. int (*xInput)(void *pIn, void *pData, int *pnData),
  9743. void *pIn
  9744. );
  9745. int sqlite3session_changeset_strm(
  9746. sqlite3_session *pSession,
  9747. int (*xOutput)(void *pOut, const void *pData, int nData),
  9748. void *pOut
  9749. );
  9750. int sqlite3session_patchset_strm(
  9751. sqlite3_session *pSession,
  9752. int (*xOutput)(void *pOut, const void *pData, int nData),
  9753. void *pOut
  9754. );
  9755. int sqlite3changegroup_add_strm(sqlite3_changegroup*,
  9756. int (*xInput)(void *pIn, void *pData, int *pnData),
  9757. void *pIn
  9758. );
  9759. int sqlite3changegroup_output_strm(sqlite3_changegroup*,
  9760. int (*xOutput)(void *pOut, const void *pData, int nData),
  9761. void *pOut
  9762. );
  9763. /*
  9764. ** Make sure we can call this stuff from C++.
  9765. */
  9766. #if 0
  9767. }
  9768. #endif
  9769. #endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */
  9770. /******** End of sqlite3session.h *********/
  9771. /******** Begin file fts5.h *********/
  9772. /*
  9773. ** 2014 May 31
  9774. **
  9775. ** The author disclaims copyright to this source code. In place of
  9776. ** a legal notice, here is a blessing:
  9777. **
  9778. ** May you do good and not evil.
  9779. ** May you find forgiveness for yourself and forgive others.
  9780. ** May you share freely, never taking more than you give.
  9781. **
  9782. ******************************************************************************
  9783. **
  9784. ** Interfaces to extend FTS5. Using the interfaces defined in this file,
  9785. ** FTS5 may be extended with:
  9786. **
  9787. ** * custom tokenizers, and
  9788. ** * custom auxiliary functions.
  9789. */
  9790. #ifndef _FTS5_H
  9791. #define _FTS5_H
  9792. #if 0
  9793. extern "C" {
  9794. #endif
  9795. /*************************************************************************
  9796. ** CUSTOM AUXILIARY FUNCTIONS
  9797. **
  9798. ** Virtual table implementations may overload SQL functions by implementing
  9799. ** the sqlite3_module.xFindFunction() method.
  9800. */
  9801. typedef struct Fts5ExtensionApi Fts5ExtensionApi;
  9802. typedef struct Fts5Context Fts5Context;
  9803. typedef struct Fts5PhraseIter Fts5PhraseIter;
  9804. typedef void (*fts5_extension_function)(
  9805. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  9806. Fts5Context *pFts, /* First arg to pass to pApi functions */
  9807. sqlite3_context *pCtx, /* Context for returning result/error */
  9808. int nVal, /* Number of values in apVal[] array */
  9809. sqlite3_value **apVal /* Array of trailing arguments */
  9810. );
  9811. struct Fts5PhraseIter {
  9812. const unsigned char *a;
  9813. const unsigned char *b;
  9814. };
  9815. /*
  9816. ** EXTENSION API FUNCTIONS
  9817. **
  9818. ** xUserData(pFts):
  9819. ** Return a copy of the context pointer the extension function was
  9820. ** registered with.
  9821. **
  9822. ** xColumnTotalSize(pFts, iCol, pnToken):
  9823. ** If parameter iCol is less than zero, set output variable *pnToken
  9824. ** to the total number of tokens in the FTS5 table. Or, if iCol is
  9825. ** non-negative but less than the number of columns in the table, return
  9826. ** the total number of tokens in column iCol, considering all rows in
  9827. ** the FTS5 table.
  9828. **
  9829. ** If parameter iCol is greater than or equal to the number of columns
  9830. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  9831. ** an OOM condition or IO error), an appropriate SQLite error code is
  9832. ** returned.
  9833. **
  9834. ** xColumnCount(pFts):
  9835. ** Return the number of columns in the table.
  9836. **
  9837. ** xColumnSize(pFts, iCol, pnToken):
  9838. ** If parameter iCol is less than zero, set output variable *pnToken
  9839. ** to the total number of tokens in the current row. Or, if iCol is
  9840. ** non-negative but less than the number of columns in the table, set
  9841. ** *pnToken to the number of tokens in column iCol of the current row.
  9842. **
  9843. ** If parameter iCol is greater than or equal to the number of columns
  9844. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  9845. ** an OOM condition or IO error), an appropriate SQLite error code is
  9846. ** returned.
  9847. **
  9848. ** This function may be quite inefficient if used with an FTS5 table
  9849. ** created with the "columnsize=0" option.
  9850. **
  9851. ** xColumnText:
  9852. ** This function attempts to retrieve the text of column iCol of the
  9853. ** current document. If successful, (*pz) is set to point to a buffer
  9854. ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
  9855. ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
  9856. ** if an error occurs, an SQLite error code is returned and the final values
  9857. ** of (*pz) and (*pn) are undefined.
  9858. **
  9859. ** xPhraseCount:
  9860. ** Returns the number of phrases in the current query expression.
  9861. **
  9862. ** xPhraseSize:
  9863. ** Returns the number of tokens in phrase iPhrase of the query. Phrases
  9864. ** are numbered starting from zero.
  9865. **
  9866. ** xInstCount:
  9867. ** Set *pnInst to the total number of occurrences of all phrases within
  9868. ** the query within the current row. Return SQLITE_OK if successful, or
  9869. ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
  9870. **
  9871. ** This API can be quite slow if used with an FTS5 table created with the
  9872. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  9873. ** with either "detail=none" or "detail=column" and "content=" option
  9874. ** (i.e. if it is a contentless table), then this API always returns 0.
  9875. **
  9876. ** xInst:
  9877. ** Query for the details of phrase match iIdx within the current row.
  9878. ** Phrase matches are numbered starting from zero, so the iIdx argument
  9879. ** should be greater than or equal to zero and smaller than the value
  9880. ** output by xInstCount().
  9881. **
  9882. ** Usually, output parameter *piPhrase is set to the phrase number, *piCol
  9883. ** to the column in which it occurs and *piOff the token offset of the
  9884. ** first token of the phrase. The exception is if the table was created
  9885. ** with the offsets=0 option specified. In this case *piOff is always
  9886. ** set to -1.
  9887. **
  9888. ** Returns SQLITE_OK if successful, or an error code (i.e. SQLITE_NOMEM)
  9889. ** if an error occurs.
  9890. **
  9891. ** This API can be quite slow if used with an FTS5 table created with the
  9892. ** "detail=none" or "detail=column" option.
  9893. **
  9894. ** xRowid:
  9895. ** Returns the rowid of the current row.
  9896. **
  9897. ** xTokenize:
  9898. ** Tokenize text using the tokenizer belonging to the FTS5 table.
  9899. **
  9900. ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
  9901. ** This API function is used to query the FTS table for phrase iPhrase
  9902. ** of the current query. Specifically, a query equivalent to:
  9903. **
  9904. ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
  9905. **
  9906. ** with $p set to a phrase equivalent to the phrase iPhrase of the
  9907. ** current query is executed. Any column filter that applies to
  9908. ** phrase iPhrase of the current query is included in $p. For each
  9909. ** row visited, the callback function passed as the fourth argument
  9910. ** is invoked. The context and API objects passed to the callback
  9911. ** function may be used to access the properties of each matched row.
  9912. ** Invoking Api.xUserData() returns a copy of the pointer passed as
  9913. ** the third argument to pUserData.
  9914. **
  9915. ** If the callback function returns any value other than SQLITE_OK, the
  9916. ** query is abandoned and the xQueryPhrase function returns immediately.
  9917. ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
  9918. ** Otherwise, the error code is propagated upwards.
  9919. **
  9920. ** If the query runs to completion without incident, SQLITE_OK is returned.
  9921. ** Or, if some error occurs before the query completes or is aborted by
  9922. ** the callback, an SQLite error code is returned.
  9923. **
  9924. **
  9925. ** xSetAuxdata(pFts5, pAux, xDelete)
  9926. **
  9927. ** Save the pointer passed as the second argument as the extension functions
  9928. ** "auxiliary data". The pointer may then be retrieved by the current or any
  9929. ** future invocation of the same fts5 extension function made as part of
  9930. ** of the same MATCH query using the xGetAuxdata() API.
  9931. **
  9932. ** Each extension function is allocated a single auxiliary data slot for
  9933. ** each FTS query (MATCH expression). If the extension function is invoked
  9934. ** more than once for a single FTS query, then all invocations share a
  9935. ** single auxiliary data context.
  9936. **
  9937. ** If there is already an auxiliary data pointer when this function is
  9938. ** invoked, then it is replaced by the new pointer. If an xDelete callback
  9939. ** was specified along with the original pointer, it is invoked at this
  9940. ** point.
  9941. **
  9942. ** The xDelete callback, if one is specified, is also invoked on the
  9943. ** auxiliary data pointer after the FTS5 query has finished.
  9944. **
  9945. ** If an error (e.g. an OOM condition) occurs within this function, an
  9946. ** the auxiliary data is set to NULL and an error code returned. If the
  9947. ** xDelete parameter was not NULL, it is invoked on the auxiliary data
  9948. ** pointer before returning.
  9949. **
  9950. **
  9951. ** xGetAuxdata(pFts5, bClear)
  9952. **
  9953. ** Returns the current auxiliary data pointer for the fts5 extension
  9954. ** function. See the xSetAuxdata() method for details.
  9955. **
  9956. ** If the bClear argument is non-zero, then the auxiliary data is cleared
  9957. ** (set to NULL) before this function returns. In this case the xDelete,
  9958. ** if any, is not invoked.
  9959. **
  9960. **
  9961. ** xRowCount(pFts5, pnRow)
  9962. **
  9963. ** This function is used to retrieve the total number of rows in the table.
  9964. ** In other words, the same value that would be returned by:
  9965. **
  9966. ** SELECT count(*) FROM ftstable;
  9967. **
  9968. ** xPhraseFirst()
  9969. ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
  9970. ** method, to iterate through all instances of a single query phrase within
  9971. ** the current row. This is the same information as is accessible via the
  9972. ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
  9973. ** to use, this API may be faster under some circumstances. To iterate
  9974. ** through instances of phrase iPhrase, use the following code:
  9975. **
  9976. ** Fts5PhraseIter iter;
  9977. ** int iCol, iOff;
  9978. ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
  9979. ** iCol>=0;
  9980. ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
  9981. ** ){
  9982. ** // An instance of phrase iPhrase at offset iOff of column iCol
  9983. ** }
  9984. **
  9985. ** The Fts5PhraseIter structure is defined above. Applications should not
  9986. ** modify this structure directly - it should only be used as shown above
  9987. ** with the xPhraseFirst() and xPhraseNext() API methods (and by
  9988. ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
  9989. **
  9990. ** This API can be quite slow if used with an FTS5 table created with the
  9991. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  9992. ** with either "detail=none" or "detail=column" and "content=" option
  9993. ** (i.e. if it is a contentless table), then this API always iterates
  9994. ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
  9995. **
  9996. ** xPhraseNext()
  9997. ** See xPhraseFirst above.
  9998. **
  9999. ** xPhraseFirstColumn()
  10000. ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
  10001. ** and xPhraseNext() APIs described above. The difference is that instead
  10002. ** of iterating through all instances of a phrase in the current row, these
  10003. ** APIs are used to iterate through the set of columns in the current row
  10004. ** that contain one or more instances of a specified phrase. For example:
  10005. **
  10006. ** Fts5PhraseIter iter;
  10007. ** int iCol;
  10008. ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
  10009. ** iCol>=0;
  10010. ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
  10011. ** ){
  10012. ** // Column iCol contains at least one instance of phrase iPhrase
  10013. ** }
  10014. **
  10015. ** This API can be quite slow if used with an FTS5 table created with the
  10016. ** "detail=none" option. If the FTS5 table is created with either
  10017. ** "detail=none" "content=" option (i.e. if it is a contentless table),
  10018. ** then this API always iterates through an empty set (all calls to
  10019. ** xPhraseFirstColumn() set iCol to -1).
  10020. **
  10021. ** The information accessed using this API and its companion
  10022. ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
  10023. ** (or xInst/xInstCount). The chief advantage of this API is that it is
  10024. ** significantly more efficient than those alternatives when used with
  10025. ** "detail=column" tables.
  10026. **
  10027. ** xPhraseNextColumn()
  10028. ** See xPhraseFirstColumn above.
  10029. */
  10030. struct Fts5ExtensionApi {
  10031. int iVersion; /* Currently always set to 3 */
  10032. void *(*xUserData)(Fts5Context*);
  10033. int (*xColumnCount)(Fts5Context*);
  10034. int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
  10035. int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
  10036. int (*xTokenize)(Fts5Context*,
  10037. const char *pText, int nText, /* Text to tokenize */
  10038. void *pCtx, /* Context passed to xToken() */
  10039. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  10040. );
  10041. int (*xPhraseCount)(Fts5Context*);
  10042. int (*xPhraseSize)(Fts5Context*, int iPhrase);
  10043. int (*xInstCount)(Fts5Context*, int *pnInst);
  10044. int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
  10045. sqlite3_int64 (*xRowid)(Fts5Context*);
  10046. int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
  10047. int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
  10048. int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
  10049. int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
  10050. );
  10051. int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
  10052. void *(*xGetAuxdata)(Fts5Context*, int bClear);
  10053. int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
  10054. void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
  10055. int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
  10056. void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
  10057. };
  10058. /*
  10059. ** CUSTOM AUXILIARY FUNCTIONS
  10060. *************************************************************************/
  10061. /*************************************************************************
  10062. ** CUSTOM TOKENIZERS
  10063. **
  10064. ** Applications may also register custom tokenizer types. A tokenizer
  10065. ** is registered by providing fts5 with a populated instance of the
  10066. ** following structure. All structure methods must be defined, setting
  10067. ** any member of the fts5_tokenizer struct to NULL leads to undefined
  10068. ** behaviour. The structure methods are expected to function as follows:
  10069. **
  10070. ** xCreate:
  10071. ** This function is used to allocate and initialize a tokenizer instance.
  10072. ** A tokenizer instance is required to actually tokenize text.
  10073. **
  10074. ** The first argument passed to this function is a copy of the (void*)
  10075. ** pointer provided by the application when the fts5_tokenizer object
  10076. ** was registered with FTS5 (the third argument to xCreateTokenizer()).
  10077. ** The second and third arguments are an array of nul-terminated strings
  10078. ** containing the tokenizer arguments, if any, specified following the
  10079. ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
  10080. ** to create the FTS5 table.
  10081. **
  10082. ** The final argument is an output variable. If successful, (*ppOut)
  10083. ** should be set to point to the new tokenizer handle and SQLITE_OK
  10084. ** returned. If an error occurs, some value other than SQLITE_OK should
  10085. ** be returned. In this case, fts5 assumes that the final value of *ppOut
  10086. ** is undefined.
  10087. **
  10088. ** xDelete:
  10089. ** This function is invoked to delete a tokenizer handle previously
  10090. ** allocated using xCreate(). Fts5 guarantees that this function will
  10091. ** be invoked exactly once for each successful call to xCreate().
  10092. **
  10093. ** xTokenize:
  10094. ** This function is expected to tokenize the nText byte string indicated
  10095. ** by argument pText. pText may or may not be nul-terminated. The first
  10096. ** argument passed to this function is a pointer to an Fts5Tokenizer object
  10097. ** returned by an earlier call to xCreate().
  10098. **
  10099. ** The second argument indicates the reason that FTS5 is requesting
  10100. ** tokenization of the supplied text. This is always one of the following
  10101. ** four values:
  10102. **
  10103. ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
  10104. ** or removed from the FTS table. The tokenizer is being invoked to
  10105. ** determine the set of tokens to add to (or delete from) the
  10106. ** FTS index.
  10107. **
  10108. ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
  10109. ** against the FTS index. The tokenizer is being called to tokenize
  10110. ** a bareword or quoted string specified as part of the query.
  10111. **
  10112. ** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
  10113. ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
  10114. ** followed by a "*" character, indicating that the last token
  10115. ** returned by the tokenizer will be treated as a token prefix.
  10116. **
  10117. ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
  10118. ** satisfy an fts5_api.xTokenize() request made by an auxiliary
  10119. ** function. Or an fts5_api.xColumnSize() request made by the same
  10120. ** on a columnsize=0 database.
  10121. ** </ul>
  10122. **
  10123. ** For each token in the input string, the supplied callback xToken() must
  10124. ** be invoked. The first argument to it should be a copy of the pointer
  10125. ** passed as the second argument to xTokenize(). The third and fourth
  10126. ** arguments are a pointer to a buffer containing the token text, and the
  10127. ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
  10128. ** of the first byte of and first byte immediately following the text from
  10129. ** which the token is derived within the input.
  10130. **
  10131. ** The second argument passed to the xToken() callback ("tflags") should
  10132. ** normally be set to 0. The exception is if the tokenizer supports
  10133. ** synonyms. In this case see the discussion below for details.
  10134. **
  10135. ** FTS5 assumes the xToken() callback is invoked for each token in the
  10136. ** order that they occur within the input text.
  10137. **
  10138. ** If an xToken() callback returns any value other than SQLITE_OK, then
  10139. ** the tokenization should be abandoned and the xTokenize() method should
  10140. ** immediately return a copy of the xToken() return value. Or, if the
  10141. ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
  10142. ** if an error occurs with the xTokenize() implementation itself, it
  10143. ** may abandon the tokenization and return any error code other than
  10144. ** SQLITE_OK or SQLITE_DONE.
  10145. **
  10146. ** SYNONYM SUPPORT
  10147. **
  10148. ** Custom tokenizers may also support synonyms. Consider a case in which a
  10149. ** user wishes to query for a phrase such as "first place". Using the
  10150. ** built-in tokenizers, the FTS5 query 'first + place' will match instances
  10151. ** of "first place" within the document set, but not alternative forms
  10152. ** such as "1st place". In some applications, it would be better to match
  10153. ** all instances of "first place" or "1st place" regardless of which form
  10154. ** the user specified in the MATCH query text.
  10155. **
  10156. ** There are several ways to approach this in FTS5:
  10157. **
  10158. ** <ol><li> By mapping all synonyms to a single token. In this case, the
  10159. ** In the above example, this means that the tokenizer returns the
  10160. ** same token for inputs "first" and "1st". Say that token is in
  10161. ** fact "first", so that when the user inserts the document "I won
  10162. ** 1st place" entries are added to the index for tokens "i", "won",
  10163. ** "first" and "place". If the user then queries for '1st + place',
  10164. ** the tokenizer substitutes "first" for "1st" and the query works
  10165. ** as expected.
  10166. **
  10167. ** <li> By adding multiple synonyms for a single term to the FTS index.
  10168. ** In this case, when tokenizing query text, the tokenizer may
  10169. ** provide multiple synonyms for a single term within the document.
  10170. ** FTS5 then queries the index for each synonym individually. For
  10171. ** example, faced with the query:
  10172. **
  10173. ** <codeblock>
  10174. ** ... MATCH 'first place'</codeblock>
  10175. **
  10176. ** the tokenizer offers both "1st" and "first" as synonyms for the
  10177. ** first token in the MATCH query and FTS5 effectively runs a query
  10178. ** similar to:
  10179. **
  10180. ** <codeblock>
  10181. ** ... MATCH '(first OR 1st) place'</codeblock>
  10182. **
  10183. ** except that, for the purposes of auxiliary functions, the query
  10184. ** still appears to contain just two phrases - "(first OR 1st)"
  10185. ** being treated as a single phrase.
  10186. **
  10187. ** <li> By adding multiple synonyms for a single term to the FTS index.
  10188. ** Using this method, when tokenizing document text, the tokenizer
  10189. ** provides multiple synonyms for each token. So that when a
  10190. ** document such as "I won first place" is tokenized, entries are
  10191. ** added to the FTS index for "i", "won", "first", "1st" and
  10192. ** "place".
  10193. **
  10194. ** This way, even if the tokenizer does not provide synonyms
  10195. ** when tokenizing query text (it should not - to do would be
  10196. ** inefficient), it doesn't matter if the user queries for
  10197. ** 'first + place' or '1st + place', as there are entires in the
  10198. ** FTS index corresponding to both forms of the first token.
  10199. ** </ol>
  10200. **
  10201. ** Whether it is parsing document or query text, any call to xToken that
  10202. ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
  10203. ** is considered to supply a synonym for the previous token. For example,
  10204. ** when parsing the document "I won first place", a tokenizer that supports
  10205. ** synonyms would call xToken() 5 times, as follows:
  10206. **
  10207. ** <codeblock>
  10208. ** xToken(pCtx, 0, "i", 1, 0, 1);
  10209. ** xToken(pCtx, 0, "won", 3, 2, 5);
  10210. ** xToken(pCtx, 0, "first", 5, 6, 11);
  10211. ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
  10212. ** xToken(pCtx, 0, "place", 5, 12, 17);
  10213. **</codeblock>
  10214. **
  10215. ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
  10216. ** xToken() is called. Multiple synonyms may be specified for a single token
  10217. ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
  10218. ** There is no limit to the number of synonyms that may be provided for a
  10219. ** single token.
  10220. **
  10221. ** In many cases, method (1) above is the best approach. It does not add
  10222. ** extra data to the FTS index or require FTS5 to query for multiple terms,
  10223. ** so it is efficient in terms of disk space and query speed. However, it
  10224. ** does not support prefix queries very well. If, as suggested above, the
  10225. ** token "first" is subsituted for "1st" by the tokenizer, then the query:
  10226. **
  10227. ** <codeblock>
  10228. ** ... MATCH '1s*'</codeblock>
  10229. **
  10230. ** will not match documents that contain the token "1st" (as the tokenizer
  10231. ** will probably not map "1s" to any prefix of "first").
  10232. **
  10233. ** For full prefix support, method (3) may be preferred. In this case,
  10234. ** because the index contains entries for both "first" and "1st", prefix
  10235. ** queries such as 'fi*' or '1s*' will match correctly. However, because
  10236. ** extra entries are added to the FTS index, this method uses more space
  10237. ** within the database.
  10238. **
  10239. ** Method (2) offers a midpoint between (1) and (3). Using this method,
  10240. ** a query such as '1s*' will match documents that contain the literal
  10241. ** token "1st", but not "first" (assuming the tokenizer is not able to
  10242. ** provide synonyms for prefixes). However, a non-prefix query like '1st'
  10243. ** will match against "1st" and "first". This method does not require
  10244. ** extra disk space, as no extra entries are added to the FTS index.
  10245. ** On the other hand, it may require more CPU cycles to run MATCH queries,
  10246. ** as separate queries of the FTS index are required for each synonym.
  10247. **
  10248. ** When using methods (2) or (3), it is important that the tokenizer only
  10249. ** provide synonyms when tokenizing document text (method (2)) or query
  10250. ** text (method (3)), not both. Doing so will not cause any errors, but is
  10251. ** inefficient.
  10252. */
  10253. typedef struct Fts5Tokenizer Fts5Tokenizer;
  10254. typedef struct fts5_tokenizer fts5_tokenizer;
  10255. struct fts5_tokenizer {
  10256. int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
  10257. void (*xDelete)(Fts5Tokenizer*);
  10258. int (*xTokenize)(Fts5Tokenizer*,
  10259. void *pCtx,
  10260. int flags, /* Mask of FTS5_TOKENIZE_* flags */
  10261. const char *pText, int nText,
  10262. int (*xToken)(
  10263. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  10264. int tflags, /* Mask of FTS5_TOKEN_* flags */
  10265. const char *pToken, /* Pointer to buffer containing token */
  10266. int nToken, /* Size of token in bytes */
  10267. int iStart, /* Byte offset of token within input text */
  10268. int iEnd /* Byte offset of end of token within input text */
  10269. )
  10270. );
  10271. };
  10272. /* Flags that may be passed as the third argument to xTokenize() */
  10273. #define FTS5_TOKENIZE_QUERY 0x0001
  10274. #define FTS5_TOKENIZE_PREFIX 0x0002
  10275. #define FTS5_TOKENIZE_DOCUMENT 0x0004
  10276. #define FTS5_TOKENIZE_AUX 0x0008
  10277. /* Flags that may be passed by the tokenizer implementation back to FTS5
  10278. ** as the third argument to the supplied xToken callback. */
  10279. #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
  10280. /*
  10281. ** END OF CUSTOM TOKENIZERS
  10282. *************************************************************************/
  10283. /*************************************************************************
  10284. ** FTS5 EXTENSION REGISTRATION API
  10285. */
  10286. typedef struct fts5_api fts5_api;
  10287. struct fts5_api {
  10288. int iVersion; /* Currently always set to 2 */
  10289. /* Create a new tokenizer */
  10290. int (*xCreateTokenizer)(
  10291. fts5_api *pApi,
  10292. const char *zName,
  10293. void *pContext,
  10294. fts5_tokenizer *pTokenizer,
  10295. void (*xDestroy)(void*)
  10296. );
  10297. /* Find an existing tokenizer */
  10298. int (*xFindTokenizer)(
  10299. fts5_api *pApi,
  10300. const char *zName,
  10301. void **ppContext,
  10302. fts5_tokenizer *pTokenizer
  10303. );
  10304. /* Create a new auxiliary function */
  10305. int (*xCreateFunction)(
  10306. fts5_api *pApi,
  10307. const char *zName,
  10308. void *pContext,
  10309. fts5_extension_function xFunction,
  10310. void (*xDestroy)(void*)
  10311. );
  10312. };
  10313. /*
  10314. ** END OF REGISTRATION API
  10315. *************************************************************************/
  10316. #if 0
  10317. } /* end of the 'extern "C"' block */
  10318. #endif
  10319. #endif /* _FTS5_H */
  10320. /******** End of fts5.h *********/
  10321. /************** End of sqlite3.h *********************************************/
  10322. /************** Continuing where we left off in sqliteInt.h ******************/
  10323. /*
  10324. ** Include the configuration header output by 'configure' if we're using the
  10325. ** autoconf-based build
  10326. */
  10327. #ifdef _HAVE_SQLITE_CONFIG_H
  10328. #include "config.h"
  10329. #endif
  10330. /************** Include sqliteLimit.h in the middle of sqliteInt.h ***********/
  10331. /************** Begin file sqliteLimit.h *************************************/
  10332. /*
  10333. ** 2007 May 7
  10334. **
  10335. ** The author disclaims copyright to this source code. In place of
  10336. ** a legal notice, here is a blessing:
  10337. **
  10338. ** May you do good and not evil.
  10339. ** May you find forgiveness for yourself and forgive others.
  10340. ** May you share freely, never taking more than you give.
  10341. **
  10342. *************************************************************************
  10343. **
  10344. ** This file defines various limits of what SQLite can process.
  10345. */
  10346. /*
  10347. ** The maximum length of a TEXT or BLOB in bytes. This also
  10348. ** limits the size of a row in a table or index.
  10349. **
  10350. ** The hard limit is the ability of a 32-bit signed integer
  10351. ** to count the size: 2^31-1 or 2147483647.
  10352. */
  10353. #ifndef SQLITE_MAX_LENGTH
  10354. # define SQLITE_MAX_LENGTH 1000000000
  10355. #endif
  10356. /*
  10357. ** This is the maximum number of
  10358. **
  10359. ** * Columns in a table
  10360. ** * Columns in an index
  10361. ** * Columns in a view
  10362. ** * Terms in the SET clause of an UPDATE statement
  10363. ** * Terms in the result set of a SELECT statement
  10364. ** * Terms in the GROUP BY or ORDER BY clauses of a SELECT statement.
  10365. ** * Terms in the VALUES clause of an INSERT statement
  10366. **
  10367. ** The hard upper limit here is 32676. Most database people will
  10368. ** tell you that in a well-normalized database, you usually should
  10369. ** not have more than a dozen or so columns in any table. And if
  10370. ** that is the case, there is no point in having more than a few
  10371. ** dozen values in any of the other situations described above.
  10372. */
  10373. #ifndef SQLITE_MAX_COLUMN
  10374. # define SQLITE_MAX_COLUMN 2000
  10375. #endif
  10376. /*
  10377. ** The maximum length of a single SQL statement in bytes.
  10378. **
  10379. ** It used to be the case that setting this value to zero would
  10380. ** turn the limit off. That is no longer true. It is not possible
  10381. ** to turn this limit off.
  10382. */
  10383. #ifndef SQLITE_MAX_SQL_LENGTH
  10384. # define SQLITE_MAX_SQL_LENGTH 1000000000
  10385. #endif
  10386. /*
  10387. ** The maximum depth of an expression tree. This is limited to
  10388. ** some extent by SQLITE_MAX_SQL_LENGTH. But sometime you might
  10389. ** want to place more severe limits on the complexity of an
  10390. ** expression.
  10391. **
  10392. ** A value of 0 used to mean that the limit was not enforced.
  10393. ** But that is no longer true. The limit is now strictly enforced
  10394. ** at all times.
  10395. */
  10396. #ifndef SQLITE_MAX_EXPR_DEPTH
  10397. # define SQLITE_MAX_EXPR_DEPTH 1000
  10398. #endif
  10399. /*
  10400. ** The maximum number of terms in a compound SELECT statement.
  10401. ** The code generator for compound SELECT statements does one
  10402. ** level of recursion for each term. A stack overflow can result
  10403. ** if the number of terms is too large. In practice, most SQL
  10404. ** never has more than 3 or 4 terms. Use a value of 0 to disable
  10405. ** any limit on the number of terms in a compount SELECT.
  10406. */
  10407. #ifndef SQLITE_MAX_COMPOUND_SELECT
  10408. # define SQLITE_MAX_COMPOUND_SELECT 500
  10409. #endif
  10410. /*
  10411. ** The maximum number of opcodes in a VDBE program.
  10412. ** Not currently enforced.
  10413. */
  10414. #ifndef SQLITE_MAX_VDBE_OP
  10415. # define SQLITE_MAX_VDBE_OP 25000
  10416. #endif
  10417. /*
  10418. ** The maximum number of arguments to an SQL function.
  10419. */
  10420. #ifndef SQLITE_MAX_FUNCTION_ARG
  10421. # define SQLITE_MAX_FUNCTION_ARG 127
  10422. #endif
  10423. /*
  10424. ** The suggested maximum number of in-memory pages to use for
  10425. ** the main database table and for temporary tables.
  10426. **
  10427. ** IMPLEMENTATION-OF: R-30185-15359 The default suggested cache size is -2000,
  10428. ** which means the cache size is limited to 2048000 bytes of memory.
  10429. ** IMPLEMENTATION-OF: R-48205-43578 The default suggested cache size can be
  10430. ** altered using the SQLITE_DEFAULT_CACHE_SIZE compile-time options.
  10431. */
  10432. #ifndef SQLITE_DEFAULT_CACHE_SIZE
  10433. # define SQLITE_DEFAULT_CACHE_SIZE -2000
  10434. #endif
  10435. /*
  10436. ** The default number of frames to accumulate in the log file before
  10437. ** checkpointing the database in WAL mode.
  10438. */
  10439. #ifndef SQLITE_DEFAULT_WAL_AUTOCHECKPOINT
  10440. # define SQLITE_DEFAULT_WAL_AUTOCHECKPOINT 1000
  10441. #endif
  10442. /*
  10443. ** The maximum number of attached databases. This must be between 0
  10444. ** and 125. The upper bound of 125 is because the attached databases are
  10445. ** counted using a signed 8-bit integer which has a maximum value of 127
  10446. ** and we have to allow 2 extra counts for the "main" and "temp" databases.
  10447. */
  10448. #ifndef SQLITE_MAX_ATTACHED
  10449. # define SQLITE_MAX_ATTACHED 10
  10450. #endif
  10451. /*
  10452. ** The maximum value of a ?nnn wildcard that the parser will accept.
  10453. */
  10454. #ifndef SQLITE_MAX_VARIABLE_NUMBER
  10455. # define SQLITE_MAX_VARIABLE_NUMBER 999
  10456. #endif
  10457. /* Maximum page size. The upper bound on this value is 65536. This a limit
  10458. ** imposed by the use of 16-bit offsets within each page.
  10459. **
  10460. ** Earlier versions of SQLite allowed the user to change this value at
  10461. ** compile time. This is no longer permitted, on the grounds that it creates
  10462. ** a library that is technically incompatible with an SQLite library
  10463. ** compiled with a different limit. If a process operating on a database
  10464. ** with a page-size of 65536 bytes crashes, then an instance of SQLite
  10465. ** compiled with the default page-size limit will not be able to rollback
  10466. ** the aborted transaction. This could lead to database corruption.
  10467. */
  10468. #ifdef SQLITE_MAX_PAGE_SIZE
  10469. # undef SQLITE_MAX_PAGE_SIZE
  10470. #endif
  10471. #define SQLITE_MAX_PAGE_SIZE 65536
  10472. /*
  10473. ** The default size of a database page.
  10474. */
  10475. #ifndef SQLITE_DEFAULT_PAGE_SIZE
  10476. # define SQLITE_DEFAULT_PAGE_SIZE 4096
  10477. #endif
  10478. #if SQLITE_DEFAULT_PAGE_SIZE>SQLITE_MAX_PAGE_SIZE
  10479. # undef SQLITE_DEFAULT_PAGE_SIZE
  10480. # define SQLITE_DEFAULT_PAGE_SIZE SQLITE_MAX_PAGE_SIZE
  10481. #endif
  10482. /*
  10483. ** Ordinarily, if no value is explicitly provided, SQLite creates databases
  10484. ** with page size SQLITE_DEFAULT_PAGE_SIZE. However, based on certain
  10485. ** device characteristics (sector-size and atomic write() support),
  10486. ** SQLite may choose a larger value. This constant is the maximum value
  10487. ** SQLite will choose on its own.
  10488. */
  10489. #ifndef SQLITE_MAX_DEFAULT_PAGE_SIZE
  10490. # define SQLITE_MAX_DEFAULT_PAGE_SIZE 8192
  10491. #endif
  10492. #if SQLITE_MAX_DEFAULT_PAGE_SIZE>SQLITE_MAX_PAGE_SIZE
  10493. # undef SQLITE_MAX_DEFAULT_PAGE_SIZE
  10494. # define SQLITE_MAX_DEFAULT_PAGE_SIZE SQLITE_MAX_PAGE_SIZE
  10495. #endif
  10496. /*
  10497. ** Maximum number of pages in one database file.
  10498. **
  10499. ** This is really just the default value for the max_page_count pragma.
  10500. ** This value can be lowered (or raised) at run-time using that the
  10501. ** max_page_count macro.
  10502. */
  10503. #ifndef SQLITE_MAX_PAGE_COUNT
  10504. # define SQLITE_MAX_PAGE_COUNT 1073741823
  10505. #endif
  10506. /*
  10507. ** Maximum length (in bytes) of the pattern in a LIKE or GLOB
  10508. ** operator.
  10509. */
  10510. #ifndef SQLITE_MAX_LIKE_PATTERN_LENGTH
  10511. # define SQLITE_MAX_LIKE_PATTERN_LENGTH 50000
  10512. #endif
  10513. /*
  10514. ** Maximum depth of recursion for triggers.
  10515. **
  10516. ** A value of 1 means that a trigger program will not be able to itself
  10517. ** fire any triggers. A value of 0 means that no trigger programs at all
  10518. ** may be executed.
  10519. */
  10520. #ifndef SQLITE_MAX_TRIGGER_DEPTH
  10521. # define SQLITE_MAX_TRIGGER_DEPTH 1000
  10522. #endif
  10523. /************** End of sqliteLimit.h *****************************************/
  10524. /************** Continuing where we left off in sqliteInt.h ******************/
  10525. /* Disable nuisance warnings on Borland compilers */
  10526. #if defined(__BORLANDC__)
  10527. #pragma warn -rch /* unreachable code */
  10528. #pragma warn -ccc /* Condition is always true or false */
  10529. #pragma warn -aus /* Assigned value is never used */
  10530. #pragma warn -csu /* Comparing signed and unsigned */
  10531. #pragma warn -spa /* Suspicious pointer arithmetic */
  10532. #endif
  10533. /*
  10534. ** Include standard header files as necessary
  10535. */
  10536. #ifdef HAVE_STDINT_H
  10537. #include <stdint.h>
  10538. #endif
  10539. #ifdef HAVE_INTTYPES_H
  10540. #include <inttypes.h>
  10541. #endif
  10542. /*
  10543. ** The following macros are used to cast pointers to integers and
  10544. ** integers to pointers. The way you do this varies from one compiler
  10545. ** to the next, so we have developed the following set of #if statements
  10546. ** to generate appropriate macros for a wide range of compilers.
  10547. **
  10548. ** The correct "ANSI" way to do this is to use the intptr_t type.
  10549. ** Unfortunately, that typedef is not available on all compilers, or
  10550. ** if it is available, it requires an #include of specific headers
  10551. ** that vary from one machine to the next.
  10552. **
  10553. ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on
  10554. ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)).
  10555. ** So we have to define the macros in different ways depending on the
  10556. ** compiler.
  10557. */
  10558. #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */
  10559. # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X))
  10560. # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X))
  10561. #elif !defined(__GNUC__) /* Works for compilers other than LLVM */
  10562. # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
  10563. # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
  10564. #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */
  10565. # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X))
  10566. # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X))
  10567. #else /* Generates a warning - but it always works */
  10568. # define SQLITE_INT_TO_PTR(X) ((void*)(X))
  10569. # define SQLITE_PTR_TO_INT(X) ((int)(X))
  10570. #endif
  10571. /*
  10572. ** A macro to hint to the compiler that a function should not be
  10573. ** inlined.
  10574. */
  10575. #if defined(__GNUC__)
  10576. # define SQLITE_NOINLINE __attribute__((noinline))
  10577. #elif defined(_MSC_VER) && _MSC_VER>=1310
  10578. # define SQLITE_NOINLINE __declspec(noinline)
  10579. #else
  10580. # define SQLITE_NOINLINE
  10581. #endif
  10582. /*
  10583. ** Make sure that the compiler intrinsics we desire are enabled when
  10584. ** compiling with an appropriate version of MSVC unless prevented by
  10585. ** the SQLITE_DISABLE_INTRINSIC define.
  10586. */
  10587. #if !defined(SQLITE_DISABLE_INTRINSIC)
  10588. # if defined(_MSC_VER) && _MSC_VER>=1400
  10589. # if !defined(_WIN32_WCE)
  10590. # include <intrin.h>
  10591. # pragma intrinsic(_byteswap_ushort)
  10592. # pragma intrinsic(_byteswap_ulong)
  10593. # pragma intrinsic(_ReadWriteBarrier)
  10594. # else
  10595. # include <cmnintrin.h>
  10596. # endif
  10597. # endif
  10598. #endif
  10599. /*
  10600. ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
  10601. ** 0 means mutexes are permanently disable and the library is never
  10602. ** threadsafe. 1 means the library is serialized which is the highest
  10603. ** level of threadsafety. 2 means the library is multithreaded - multiple
  10604. ** threads can use SQLite as long as no two threads try to use the same
  10605. ** database connection at the same time.
  10606. **
  10607. ** Older versions of SQLite used an optional THREADSAFE macro.
  10608. ** We support that for legacy.
  10609. */
  10610. #if !defined(SQLITE_THREADSAFE)
  10611. # if defined(THREADSAFE)
  10612. # define SQLITE_THREADSAFE THREADSAFE
  10613. # else
  10614. # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
  10615. # endif
  10616. #endif
  10617. /*
  10618. ** Powersafe overwrite is on by default. But can be turned off using
  10619. ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
  10620. */
  10621. #ifndef SQLITE_POWERSAFE_OVERWRITE
  10622. # define SQLITE_POWERSAFE_OVERWRITE 1
  10623. #endif
  10624. /*
  10625. ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
  10626. ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
  10627. ** which case memory allocation statistics are disabled by default.
  10628. */
  10629. #if !defined(SQLITE_DEFAULT_MEMSTATUS)
  10630. # define SQLITE_DEFAULT_MEMSTATUS 1
  10631. #endif
  10632. /*
  10633. ** Exactly one of the following macros must be defined in order to
  10634. ** specify which memory allocation subsystem to use.
  10635. **
  10636. ** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
  10637. ** SQLITE_WIN32_MALLOC // Use Win32 native heap API
  10638. ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails
  10639. ** SQLITE_MEMDEBUG // Debugging version of system malloc()
  10640. **
  10641. ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
  10642. ** assert() macro is enabled, each call into the Win32 native heap subsystem
  10643. ** will cause HeapValidate to be called. If heap validation should fail, an
  10644. ** assertion will be triggered.
  10645. **
  10646. ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
  10647. ** the default.
  10648. */
  10649. #if defined(SQLITE_SYSTEM_MALLOC) \
  10650. + defined(SQLITE_WIN32_MALLOC) \
  10651. + defined(SQLITE_ZERO_MALLOC) \
  10652. + defined(SQLITE_MEMDEBUG)>1
  10653. # error "Two or more of the following compile-time configuration options\
  10654. are defined but at most one is allowed:\
  10655. SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
  10656. SQLITE_ZERO_MALLOC"
  10657. #endif
  10658. #if defined(SQLITE_SYSTEM_MALLOC) \
  10659. + defined(SQLITE_WIN32_MALLOC) \
  10660. + defined(SQLITE_ZERO_MALLOC) \
  10661. + defined(SQLITE_MEMDEBUG)==0
  10662. # define SQLITE_SYSTEM_MALLOC 1
  10663. #endif
  10664. /*
  10665. ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
  10666. ** sizes of memory allocations below this value where possible.
  10667. */
  10668. #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
  10669. # define SQLITE_MALLOC_SOFT_LIMIT 1024
  10670. #endif
  10671. /*
  10672. ** We need to define _XOPEN_SOURCE as follows in order to enable
  10673. ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
  10674. ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
  10675. ** it.
  10676. */
  10677. #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
  10678. # define _XOPEN_SOURCE 600
  10679. #endif
  10680. /*
  10681. ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that
  10682. ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true,
  10683. ** make it true by defining or undefining NDEBUG.
  10684. **
  10685. ** Setting NDEBUG makes the code smaller and faster by disabling the
  10686. ** assert() statements in the code. So we want the default action
  10687. ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
  10688. ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out
  10689. ** feature.
  10690. */
  10691. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  10692. # define NDEBUG 1
  10693. #endif
  10694. #if defined(NDEBUG) && defined(SQLITE_DEBUG)
  10695. # undef NDEBUG
  10696. #endif
  10697. /*
  10698. ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
  10699. */
  10700. #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
  10701. # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
  10702. #endif
  10703. /*
  10704. ** The testcase() macro is used to aid in coverage testing. When
  10705. ** doing coverage testing, the condition inside the argument to
  10706. ** testcase() must be evaluated both true and false in order to
  10707. ** get full branch coverage. The testcase() macro is inserted
  10708. ** to help ensure adequate test coverage in places where simple
  10709. ** condition/decision coverage is inadequate. For example, testcase()
  10710. ** can be used to make sure boundary values are tested. For
  10711. ** bitmask tests, testcase() can be used to make sure each bit
  10712. ** is significant and used at least once. On switch statements
  10713. ** where multiple cases go to the same block of code, testcase()
  10714. ** can insure that all cases are evaluated.
  10715. **
  10716. */
  10717. #ifdef SQLITE_COVERAGE_TEST
  10718. SQLITE_PRIVATE void sqlite3Coverage(int);
  10719. # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
  10720. #else
  10721. # define testcase(X)
  10722. #endif
  10723. /*
  10724. ** The TESTONLY macro is used to enclose variable declarations or
  10725. ** other bits of code that are needed to support the arguments
  10726. ** within testcase() and assert() macros.
  10727. */
  10728. #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
  10729. # define TESTONLY(X) X
  10730. #else
  10731. # define TESTONLY(X)
  10732. #endif
  10733. /*
  10734. ** Sometimes we need a small amount of code such as a variable initialization
  10735. ** to setup for a later assert() statement. We do not want this code to
  10736. ** appear when assert() is disabled. The following macro is therefore
  10737. ** used to contain that setup code. The "VVA" acronym stands for
  10738. ** "Verification, Validation, and Accreditation". In other words, the
  10739. ** code within VVA_ONLY() will only run during verification processes.
  10740. */
  10741. #ifndef NDEBUG
  10742. # define VVA_ONLY(X) X
  10743. #else
  10744. # define VVA_ONLY(X)
  10745. #endif
  10746. /*
  10747. ** The ALWAYS and NEVER macros surround boolean expressions which
  10748. ** are intended to always be true or false, respectively. Such
  10749. ** expressions could be omitted from the code completely. But they
  10750. ** are included in a few cases in order to enhance the resilience
  10751. ** of SQLite to unexpected behavior - to make the code "self-healing"
  10752. ** or "ductile" rather than being "brittle" and crashing at the first
  10753. ** hint of unplanned behavior.
  10754. **
  10755. ** In other words, ALWAYS and NEVER are added for defensive code.
  10756. **
  10757. ** When doing coverage testing ALWAYS and NEVER are hard-coded to
  10758. ** be true and false so that the unreachable code they specify will
  10759. ** not be counted as untested code.
  10760. */
  10761. #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST)
  10762. # define ALWAYS(X) (1)
  10763. # define NEVER(X) (0)
  10764. #elif !defined(NDEBUG)
  10765. # define ALWAYS(X) ((X)?1:(assert(0),0))
  10766. # define NEVER(X) ((X)?(assert(0),1):0)
  10767. #else
  10768. # define ALWAYS(X) (X)
  10769. # define NEVER(X) (X)
  10770. #endif
  10771. /*
  10772. ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
  10773. ** defined. We need to defend against those failures when testing with
  10774. ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
  10775. ** during a normal build. The following macro can be used to disable tests
  10776. ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
  10777. */
  10778. #if defined(SQLITE_TEST_REALLOC_STRESS)
  10779. # define ONLY_IF_REALLOC_STRESS(X) (X)
  10780. #elif !defined(NDEBUG)
  10781. # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0)
  10782. #else
  10783. # define ONLY_IF_REALLOC_STRESS(X) (0)
  10784. #endif
  10785. /*
  10786. ** Declarations used for tracing the operating system interfaces.
  10787. */
  10788. #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
  10789. (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
  10790. extern int sqlite3OSTrace;
  10791. # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X
  10792. # define SQLITE_HAVE_OS_TRACE
  10793. #else
  10794. # define OSTRACE(X)
  10795. # undef SQLITE_HAVE_OS_TRACE
  10796. #endif
  10797. /*
  10798. ** Is the sqlite3ErrName() function needed in the build? Currently,
  10799. ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
  10800. ** OSTRACE is enabled), and by several "test*.c" files (which are
  10801. ** compiled using SQLITE_TEST).
  10802. */
  10803. #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
  10804. (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
  10805. # define SQLITE_NEED_ERR_NAME
  10806. #else
  10807. # undef SQLITE_NEED_ERR_NAME
  10808. #endif
  10809. /*
  10810. ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
  10811. */
  10812. #ifdef SQLITE_OMIT_EXPLAIN
  10813. # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
  10814. #endif
  10815. /*
  10816. ** Return true (non-zero) if the input is an integer that is too large
  10817. ** to fit in 32-bits. This macro is used inside of various testcase()
  10818. ** macros to verify that we have tested SQLite for large-file support.
  10819. */
  10820. #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0)
  10821. /*
  10822. ** The macro unlikely() is a hint that surrounds a boolean
  10823. ** expression that is usually false. Macro likely() surrounds
  10824. ** a boolean expression that is usually true. These hints could,
  10825. ** in theory, be used by the compiler to generate better code, but
  10826. ** currently they are just comments for human readers.
  10827. */
  10828. #define likely(X) (X)
  10829. #define unlikely(X) (X)
  10830. /************** Include hash.h in the middle of sqliteInt.h ******************/
  10831. /************** Begin file hash.h ********************************************/
  10832. /*
  10833. ** 2001 September 22
  10834. **
  10835. ** The author disclaims copyright to this source code. In place of
  10836. ** a legal notice, here is a blessing:
  10837. **
  10838. ** May you do good and not evil.
  10839. ** May you find forgiveness for yourself and forgive others.
  10840. ** May you share freely, never taking more than you give.
  10841. **
  10842. *************************************************************************
  10843. ** This is the header file for the generic hash-table implementation
  10844. ** used in SQLite.
  10845. */
  10846. #ifndef SQLITE_HASH_H
  10847. #define SQLITE_HASH_H
  10848. /* Forward declarations of structures. */
  10849. typedef struct Hash Hash;
  10850. typedef struct HashElem HashElem;
  10851. /* A complete hash table is an instance of the following structure.
  10852. ** The internals of this structure are intended to be opaque -- client
  10853. ** code should not attempt to access or modify the fields of this structure
  10854. ** directly. Change this structure only by using the routines below.
  10855. ** However, some of the "procedures" and "functions" for modifying and
  10856. ** accessing this structure are really macros, so we can't really make
  10857. ** this structure opaque.
  10858. **
  10859. ** All elements of the hash table are on a single doubly-linked list.
  10860. ** Hash.first points to the head of this list.
  10861. **
  10862. ** There are Hash.htsize buckets. Each bucket points to a spot in
  10863. ** the global doubly-linked list. The contents of the bucket are the
  10864. ** element pointed to plus the next _ht.count-1 elements in the list.
  10865. **
  10866. ** Hash.htsize and Hash.ht may be zero. In that case lookup is done
  10867. ** by a linear search of the global list. For small tables, the
  10868. ** Hash.ht table is never allocated because if there are few elements
  10869. ** in the table, it is faster to do a linear search than to manage
  10870. ** the hash table.
  10871. */
  10872. struct Hash {
  10873. unsigned int htsize; /* Number of buckets in the hash table */
  10874. unsigned int count; /* Number of entries in this table */
  10875. HashElem *first; /* The first element of the array */
  10876. struct _ht { /* the hash table */
  10877. int count; /* Number of entries with this hash */
  10878. HashElem *chain; /* Pointer to first entry with this hash */
  10879. } *ht;
  10880. };
  10881. /* Each element in the hash table is an instance of the following
  10882. ** structure. All elements are stored on a single doubly-linked list.
  10883. **
  10884. ** Again, this structure is intended to be opaque, but it can't really
  10885. ** be opaque because it is used by macros.
  10886. */
  10887. struct HashElem {
  10888. HashElem *next, *prev; /* Next and previous elements in the table */
  10889. void *data; /* Data associated with this element */
  10890. const char *pKey; /* Key associated with this element */
  10891. };
  10892. /*
  10893. ** Access routines. To delete, insert a NULL pointer.
  10894. */
  10895. SQLITE_PRIVATE void sqlite3HashInit(Hash*);
  10896. SQLITE_PRIVATE void *sqlite3HashInsert(Hash*, const char *pKey, void *pData);
  10897. SQLITE_PRIVATE void *sqlite3HashFind(const Hash*, const char *pKey);
  10898. SQLITE_PRIVATE void sqlite3HashClear(Hash*);
  10899. /*
  10900. ** Macros for looping over all elements of a hash table. The idiom is
  10901. ** like this:
  10902. **
  10903. ** Hash h;
  10904. ** HashElem *p;
  10905. ** ...
  10906. ** for(p=sqliteHashFirst(&h); p; p=sqliteHashNext(p)){
  10907. ** SomeStructure *pData = sqliteHashData(p);
  10908. ** // do something with pData
  10909. ** }
  10910. */
  10911. #define sqliteHashFirst(H) ((H)->first)
  10912. #define sqliteHashNext(E) ((E)->next)
  10913. #define sqliteHashData(E) ((E)->data)
  10914. /* #define sqliteHashKey(E) ((E)->pKey) // NOT USED */
  10915. /* #define sqliteHashKeysize(E) ((E)->nKey) // NOT USED */
  10916. /*
  10917. ** Number of entries in a hash table
  10918. */
  10919. /* #define sqliteHashCount(H) ((H)->count) // NOT USED */
  10920. #endif /* SQLITE_HASH_H */
  10921. /************** End of hash.h ************************************************/
  10922. /************** Continuing where we left off in sqliteInt.h ******************/
  10923. /************** Include parse.h in the middle of sqliteInt.h *****************/
  10924. /************** Begin file parse.h *******************************************/
  10925. #define TK_SEMI 1
  10926. #define TK_EXPLAIN 2
  10927. #define TK_QUERY 3
  10928. #define TK_PLAN 4
  10929. #define TK_BEGIN 5
  10930. #define TK_TRANSACTION 6
  10931. #define TK_DEFERRED 7
  10932. #define TK_IMMEDIATE 8
  10933. #define TK_EXCLUSIVE 9
  10934. #define TK_COMMIT 10
  10935. #define TK_END 11
  10936. #define TK_ROLLBACK 12
  10937. #define TK_SAVEPOINT 13
  10938. #define TK_RELEASE 14
  10939. #define TK_TO 15
  10940. #define TK_TABLE 16
  10941. #define TK_CREATE 17
  10942. #define TK_IF 18
  10943. #define TK_NOT 19
  10944. #define TK_EXISTS 20
  10945. #define TK_TEMP 21
  10946. #define TK_LP 22
  10947. #define TK_RP 23
  10948. #define TK_AS 24
  10949. #define TK_WITHOUT 25
  10950. #define TK_COMMA 26
  10951. #define TK_OR 27
  10952. #define TK_AND 28
  10953. #define TK_IS 29
  10954. #define TK_MATCH 30
  10955. #define TK_LIKE_KW 31
  10956. #define TK_BETWEEN 32
  10957. #define TK_IN 33
  10958. #define TK_ISNULL 34
  10959. #define TK_NOTNULL 35
  10960. #define TK_NE 36
  10961. #define TK_EQ 37
  10962. #define TK_GT 38
  10963. #define TK_LE 39
  10964. #define TK_LT 40
  10965. #define TK_GE 41
  10966. #define TK_ESCAPE 42
  10967. #define TK_BITAND 43
  10968. #define TK_BITOR 44
  10969. #define TK_LSHIFT 45
  10970. #define TK_RSHIFT 46
  10971. #define TK_PLUS 47
  10972. #define TK_MINUS 48
  10973. #define TK_STAR 49
  10974. #define TK_SLASH 50
  10975. #define TK_REM 51
  10976. #define TK_CONCAT 52
  10977. #define TK_COLLATE 53
  10978. #define TK_BITNOT 54
  10979. #define TK_ID 55
  10980. #define TK_INDEXED 56
  10981. #define TK_ABORT 57
  10982. #define TK_ACTION 58
  10983. #define TK_AFTER 59
  10984. #define TK_ANALYZE 60
  10985. #define TK_ASC 61
  10986. #define TK_ATTACH 62
  10987. #define TK_BEFORE 63
  10988. #define TK_BY 64
  10989. #define TK_CASCADE 65
  10990. #define TK_CAST 66
  10991. #define TK_COLUMNKW 67
  10992. #define TK_CONFLICT 68
  10993. #define TK_DATABASE 69
  10994. #define TK_DESC 70
  10995. #define TK_DETACH 71
  10996. #define TK_EACH 72
  10997. #define TK_FAIL 73
  10998. #define TK_FOR 74
  10999. #define TK_IGNORE 75
  11000. #define TK_INITIALLY 76
  11001. #define TK_INSTEAD 77
  11002. #define TK_NO 78
  11003. #define TK_KEY 79
  11004. #define TK_OF 80
  11005. #define TK_OFFSET 81
  11006. #define TK_PRAGMA 82
  11007. #define TK_RAISE 83
  11008. #define TK_RECURSIVE 84
  11009. #define TK_REPLACE 85
  11010. #define TK_RESTRICT 86
  11011. #define TK_ROW 87
  11012. #define TK_TRIGGER 88
  11013. #define TK_VACUUM 89
  11014. #define TK_VIEW 90
  11015. #define TK_VIRTUAL 91
  11016. #define TK_WITH 92
  11017. #define TK_REINDEX 93
  11018. #define TK_RENAME 94
  11019. #define TK_CTIME_KW 95
  11020. #define TK_ANY 96
  11021. #define TK_STRING 97
  11022. #define TK_JOIN_KW 98
  11023. #define TK_CONSTRAINT 99
  11024. #define TK_DEFAULT 100
  11025. #define TK_NULL 101
  11026. #define TK_PRIMARY 102
  11027. #define TK_UNIQUE 103
  11028. #define TK_CHECK 104
  11029. #define TK_REFERENCES 105
  11030. #define TK_AUTOINCR 106
  11031. #define TK_ON 107
  11032. #define TK_INSERT 108
  11033. #define TK_DELETE 109
  11034. #define TK_UPDATE 110
  11035. #define TK_SET 111
  11036. #define TK_DEFERRABLE 112
  11037. #define TK_FOREIGN 113
  11038. #define TK_DROP 114
  11039. #define TK_UNION 115
  11040. #define TK_ALL 116
  11041. #define TK_EXCEPT 117
  11042. #define TK_INTERSECT 118
  11043. #define TK_SELECT 119
  11044. #define TK_VALUES 120
  11045. #define TK_DISTINCT 121
  11046. #define TK_DOT 122
  11047. #define TK_FROM 123
  11048. #define TK_JOIN 124
  11049. #define TK_USING 125
  11050. #define TK_ORDER 126
  11051. #define TK_GROUP 127
  11052. #define TK_HAVING 128
  11053. #define TK_LIMIT 129
  11054. #define TK_WHERE 130
  11055. #define TK_INTO 131
  11056. #define TK_FLOAT 132
  11057. #define TK_BLOB 133
  11058. #define TK_INTEGER 134
  11059. #define TK_VARIABLE 135
  11060. #define TK_CASE 136
  11061. #define TK_WHEN 137
  11062. #define TK_THEN 138
  11063. #define TK_ELSE 139
  11064. #define TK_INDEX 140
  11065. #define TK_ALTER 141
  11066. #define TK_ADD 142
  11067. #define TK_TO_TEXT 143
  11068. #define TK_TO_BLOB 144
  11069. #define TK_TO_NUMERIC 145
  11070. #define TK_TO_INT 146
  11071. #define TK_TO_REAL 147
  11072. #define TK_ISNOT 148
  11073. #define TK_END_OF_FILE 149
  11074. #define TK_UNCLOSED_STRING 150
  11075. #define TK_FUNCTION 151
  11076. #define TK_COLUMN 152
  11077. #define TK_AGG_FUNCTION 153
  11078. #define TK_AGG_COLUMN 154
  11079. #define TK_UMINUS 155
  11080. #define TK_UPLUS 156
  11081. #define TK_REGISTER 157
  11082. #define TK_VECTOR 158
  11083. #define TK_SELECT_COLUMN 159
  11084. #define TK_ASTERISK 160
  11085. #define TK_SPAN 161
  11086. #define TK_SPACE 162
  11087. #define TK_ILLEGAL 163
  11088. /* The token codes above must all fit in 8 bits */
  11089. #define TKFLG_MASK 0xff
  11090. /* Flags that can be added to a token code when it is not
  11091. ** being stored in a u8: */
  11092. #define TKFLG_DONTFOLD 0x100 /* Omit constant folding optimizations */
  11093. /************** End of parse.h ***********************************************/
  11094. /************** Continuing where we left off in sqliteInt.h ******************/
  11095. #include <stdio.h>
  11096. #include <stdlib.h>
  11097. #include <string.h>
  11098. #include <assert.h>
  11099. #include <stddef.h>
  11100. /*
  11101. ** If compiling for a processor that lacks floating point support,
  11102. ** substitute integer for floating-point
  11103. */
  11104. #ifdef SQLITE_OMIT_FLOATING_POINT
  11105. # define double sqlite_int64
  11106. # define float sqlite_int64
  11107. # define LONGDOUBLE_TYPE sqlite_int64
  11108. # ifndef SQLITE_BIG_DBL
  11109. # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
  11110. # endif
  11111. # define SQLITE_OMIT_DATETIME_FUNCS 1
  11112. # define SQLITE_OMIT_TRACE 1
  11113. # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  11114. # undef SQLITE_HAVE_ISNAN
  11115. #endif
  11116. #ifndef SQLITE_BIG_DBL
  11117. # define SQLITE_BIG_DBL (1e99)
  11118. #endif
  11119. /*
  11120. ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
  11121. ** afterward. Having this macro allows us to cause the C compiler
  11122. ** to omit code used by TEMP tables without messy #ifndef statements.
  11123. */
  11124. #ifdef SQLITE_OMIT_TEMPDB
  11125. #define OMIT_TEMPDB 1
  11126. #else
  11127. #define OMIT_TEMPDB 0
  11128. #endif
  11129. /*
  11130. ** The "file format" number is an integer that is incremented whenever
  11131. ** the VDBE-level file format changes. The following macros define the
  11132. ** the default file format for new databases and the maximum file format
  11133. ** that the library can read.
  11134. */
  11135. #define SQLITE_MAX_FILE_FORMAT 4
  11136. #ifndef SQLITE_DEFAULT_FILE_FORMAT
  11137. # define SQLITE_DEFAULT_FILE_FORMAT 4
  11138. #endif
  11139. /*
  11140. ** Determine whether triggers are recursive by default. This can be
  11141. ** changed at run-time using a pragma.
  11142. */
  11143. #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
  11144. # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
  11145. #endif
  11146. /*
  11147. ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
  11148. ** on the command-line
  11149. */
  11150. #ifndef SQLITE_TEMP_STORE
  11151. # define SQLITE_TEMP_STORE 1
  11152. # define SQLITE_TEMP_STORE_xc 1 /* Exclude from ctime.c */
  11153. #endif
  11154. /*
  11155. ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
  11156. ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
  11157. ** to zero.
  11158. */
  11159. #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
  11160. # undef SQLITE_MAX_WORKER_THREADS
  11161. # define SQLITE_MAX_WORKER_THREADS 0
  11162. #endif
  11163. #ifndef SQLITE_MAX_WORKER_THREADS
  11164. # define SQLITE_MAX_WORKER_THREADS 8
  11165. #endif
  11166. #ifndef SQLITE_DEFAULT_WORKER_THREADS
  11167. # define SQLITE_DEFAULT_WORKER_THREADS 0
  11168. #endif
  11169. #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
  11170. # undef SQLITE_MAX_WORKER_THREADS
  11171. # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
  11172. #endif
  11173. /*
  11174. ** The default initial allocation for the pagecache when using separate
  11175. ** pagecaches for each database connection. A positive number is the
  11176. ** number of pages. A negative number N translations means that a buffer
  11177. ** of -1024*N bytes is allocated and used for as many pages as it will hold.
  11178. */
  11179. #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
  11180. # define SQLITE_DEFAULT_PCACHE_INITSZ 100
  11181. #endif
  11182. /*
  11183. ** GCC does not define the offsetof() macro so we'll have to do it
  11184. ** ourselves.
  11185. */
  11186. #ifndef offsetof
  11187. #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
  11188. #endif
  11189. /*
  11190. ** Macros to compute minimum and maximum of two numbers.
  11191. */
  11192. #ifndef MIN
  11193. # define MIN(A,B) ((A)<(B)?(A):(B))
  11194. #endif
  11195. #ifndef MAX
  11196. # define MAX(A,B) ((A)>(B)?(A):(B))
  11197. #endif
  11198. /*
  11199. ** Swap two objects of type TYPE.
  11200. */
  11201. #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
  11202. /*
  11203. ** Check to see if this machine uses EBCDIC. (Yes, believe it or
  11204. ** not, there are still machines out there that use EBCDIC.)
  11205. */
  11206. #if 'A' == '\301'
  11207. # define SQLITE_EBCDIC 1
  11208. #else
  11209. # define SQLITE_ASCII 1
  11210. #endif
  11211. /*
  11212. ** Integers of known sizes. These typedefs might change for architectures
  11213. ** where the sizes very. Preprocessor macros are available so that the
  11214. ** types can be conveniently redefined at compile-type. Like this:
  11215. **
  11216. ** cc '-DUINTPTR_TYPE=long long int' ...
  11217. */
  11218. #ifndef UINT32_TYPE
  11219. # ifdef HAVE_UINT32_T
  11220. # define UINT32_TYPE uint32_t
  11221. # else
  11222. # define UINT32_TYPE unsigned int
  11223. # endif
  11224. #endif
  11225. #ifndef UINT16_TYPE
  11226. # ifdef HAVE_UINT16_T
  11227. # define UINT16_TYPE uint16_t
  11228. # else
  11229. # define UINT16_TYPE unsigned short int
  11230. # endif
  11231. #endif
  11232. #ifndef INT16_TYPE
  11233. # ifdef HAVE_INT16_T
  11234. # define INT16_TYPE int16_t
  11235. # else
  11236. # define INT16_TYPE short int
  11237. # endif
  11238. #endif
  11239. #ifndef UINT8_TYPE
  11240. # ifdef HAVE_UINT8_T
  11241. # define UINT8_TYPE uint8_t
  11242. # else
  11243. # define UINT8_TYPE unsigned char
  11244. # endif
  11245. #endif
  11246. #ifndef INT8_TYPE
  11247. # ifdef HAVE_INT8_T
  11248. # define INT8_TYPE int8_t
  11249. # else
  11250. # define INT8_TYPE signed char
  11251. # endif
  11252. #endif
  11253. #ifndef LONGDOUBLE_TYPE
  11254. # define LONGDOUBLE_TYPE long double
  11255. #endif
  11256. typedef sqlite_int64 i64; /* 8-byte signed integer */
  11257. typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
  11258. typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
  11259. typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
  11260. typedef INT16_TYPE i16; /* 2-byte signed integer */
  11261. typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
  11262. typedef INT8_TYPE i8; /* 1-byte signed integer */
  11263. /*
  11264. ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
  11265. ** that can be stored in a u32 without loss of data. The value
  11266. ** is 0x00000000ffffffff. But because of quirks of some compilers, we
  11267. ** have to specify the value in the less intuitive manner shown:
  11268. */
  11269. #define SQLITE_MAX_U32 ((((u64)1)<<32)-1)
  11270. /*
  11271. ** The datatype used to store estimates of the number of rows in a
  11272. ** table or index. This is an unsigned integer type. For 99.9% of
  11273. ** the world, a 32-bit integer is sufficient. But a 64-bit integer
  11274. ** can be used at compile-time if desired.
  11275. */
  11276. #ifdef SQLITE_64BIT_STATS
  11277. typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */
  11278. #else
  11279. typedef u32 tRowcnt; /* 32-bit is the default */
  11280. #endif
  11281. /*
  11282. ** Estimated quantities used for query planning are stored as 16-bit
  11283. ** logarithms. For quantity X, the value stored is 10*log2(X). This
  11284. ** gives a possible range of values of approximately 1.0e986 to 1e-986.
  11285. ** But the allowed values are "grainy". Not every value is representable.
  11286. ** For example, quantities 16 and 17 are both represented by a LogEst
  11287. ** of 40. However, since LogEst quantities are suppose to be estimates,
  11288. ** not exact values, this imprecision is not a problem.
  11289. **
  11290. ** "LogEst" is short for "Logarithmic Estimate".
  11291. **
  11292. ** Examples:
  11293. ** 1 -> 0 20 -> 43 10000 -> 132
  11294. ** 2 -> 10 25 -> 46 25000 -> 146
  11295. ** 3 -> 16 100 -> 66 1000000 -> 199
  11296. ** 4 -> 20 1000 -> 99 1048576 -> 200
  11297. ** 10 -> 33 1024 -> 100 4294967296 -> 320
  11298. **
  11299. ** The LogEst can be negative to indicate fractional values.
  11300. ** Examples:
  11301. **
  11302. ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40
  11303. */
  11304. typedef INT16_TYPE LogEst;
  11305. /*
  11306. ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
  11307. */
  11308. #ifndef SQLITE_PTRSIZE
  11309. # if defined(__SIZEOF_POINTER__)
  11310. # define SQLITE_PTRSIZE __SIZEOF_POINTER__
  11311. # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \
  11312. defined(_M_ARM) || defined(__arm__) || defined(__x86)
  11313. # define SQLITE_PTRSIZE 4
  11314. # else
  11315. # define SQLITE_PTRSIZE 8
  11316. # endif
  11317. #endif
  11318. /* The uptr type is an unsigned integer large enough to hold a pointer
  11319. */
  11320. #if defined(HAVE_STDINT_H)
  11321. typedef uintptr_t uptr;
  11322. #elif SQLITE_PTRSIZE==4
  11323. typedef u32 uptr;
  11324. #else
  11325. typedef u64 uptr;
  11326. #endif
  11327. /*
  11328. ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
  11329. ** something between S (inclusive) and E (exclusive).
  11330. **
  11331. ** In other words, S is a buffer and E is a pointer to the first byte after
  11332. ** the end of buffer S. This macro returns true if P points to something
  11333. ** contained within the buffer S.
  11334. */
  11335. #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
  11336. /*
  11337. ** Macros to determine whether the machine is big or little endian,
  11338. ** and whether or not that determination is run-time or compile-time.
  11339. **
  11340. ** For best performance, an attempt is made to guess at the byte-order
  11341. ** using C-preprocessor macros. If that is unsuccessful, or if
  11342. ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined
  11343. ** at run-time.
  11344. */
  11345. #if (defined(i386) || defined(__i386__) || defined(_M_IX86) || \
  11346. defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \
  11347. defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \
  11348. defined(__arm__)) && !defined(SQLITE_RUNTIME_BYTEORDER)
  11349. # define SQLITE_BYTEORDER 1234
  11350. # define SQLITE_BIGENDIAN 0
  11351. # define SQLITE_LITTLEENDIAN 1
  11352. # define SQLITE_UTF16NATIVE SQLITE_UTF16LE
  11353. #endif
  11354. #if (defined(sparc) || defined(__ppc__)) \
  11355. && !defined(SQLITE_RUNTIME_BYTEORDER)
  11356. # define SQLITE_BYTEORDER 4321
  11357. # define SQLITE_BIGENDIAN 1
  11358. # define SQLITE_LITTLEENDIAN 0
  11359. # define SQLITE_UTF16NATIVE SQLITE_UTF16BE
  11360. #endif
  11361. #if !defined(SQLITE_BYTEORDER)
  11362. # ifdef SQLITE_AMALGAMATION
  11363. const int sqlite3one = 1;
  11364. # else
  11365. extern const int sqlite3one;
  11366. # endif
  11367. # define SQLITE_BYTEORDER 0 /* 0 means "unknown at compile-time" */
  11368. # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
  11369. # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
  11370. # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
  11371. #endif
  11372. /*
  11373. ** Constants for the largest and smallest possible 64-bit signed integers.
  11374. ** These macros are designed to work correctly on both 32-bit and 64-bit
  11375. ** compilers.
  11376. */
  11377. #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  11378. #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
  11379. /*
  11380. ** Round up a number to the next larger multiple of 8. This is used
  11381. ** to force 8-byte alignment on 64-bit architectures.
  11382. */
  11383. #define ROUND8(x) (((x)+7)&~7)
  11384. /*
  11385. ** Round down to the nearest multiple of 8
  11386. */
  11387. #define ROUNDDOWN8(x) ((x)&~7)
  11388. /*
  11389. ** Assert that the pointer X is aligned to an 8-byte boundary. This
  11390. ** macro is used only within assert() to verify that the code gets
  11391. ** all alignment restrictions correct.
  11392. **
  11393. ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
  11394. ** underlying malloc() implementation might return us 4-byte aligned
  11395. ** pointers. In that case, only verify 4-byte alignment.
  11396. */
  11397. #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
  11398. # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0)
  11399. #else
  11400. # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0)
  11401. #endif
  11402. /*
  11403. ** Disable MMAP on platforms where it is known to not work
  11404. */
  11405. #if defined(__OpenBSD__) || defined(__QNXNTO__)
  11406. # undef SQLITE_MAX_MMAP_SIZE
  11407. # define SQLITE_MAX_MMAP_SIZE 0
  11408. #endif
  11409. /*
  11410. ** Default maximum size of memory used by memory-mapped I/O in the VFS
  11411. */
  11412. #ifdef __APPLE__
  11413. # include <TargetConditionals.h>
  11414. #endif
  11415. #ifndef SQLITE_MAX_MMAP_SIZE
  11416. # if defined(__linux__) \
  11417. || defined(_WIN32) \
  11418. || (defined(__APPLE__) && defined(__MACH__)) \
  11419. || defined(__sun) \
  11420. || defined(__FreeBSD__) \
  11421. || defined(__DragonFly__)
  11422. # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */
  11423. # else
  11424. # define SQLITE_MAX_MMAP_SIZE 0
  11425. # endif
  11426. # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */
  11427. #endif
  11428. /*
  11429. ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger
  11430. ** default MMAP_SIZE is specified at compile-time, make sure that it does
  11431. ** not exceed the maximum mmap size.
  11432. */
  11433. #ifndef SQLITE_DEFAULT_MMAP_SIZE
  11434. # define SQLITE_DEFAULT_MMAP_SIZE 0
  11435. # define SQLITE_DEFAULT_MMAP_SIZE_xc 1 /* Exclude from ctime.c */
  11436. #endif
  11437. #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
  11438. # undef SQLITE_DEFAULT_MMAP_SIZE
  11439. # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
  11440. #endif
  11441. /*
  11442. ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
  11443. ** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also
  11444. ** define SQLITE_ENABLE_STAT3_OR_STAT4
  11445. */
  11446. #ifdef SQLITE_ENABLE_STAT4
  11447. # undef SQLITE_ENABLE_STAT3
  11448. # define SQLITE_ENABLE_STAT3_OR_STAT4 1
  11449. #elif SQLITE_ENABLE_STAT3
  11450. # define SQLITE_ENABLE_STAT3_OR_STAT4 1
  11451. #elif SQLITE_ENABLE_STAT3_OR_STAT4
  11452. # undef SQLITE_ENABLE_STAT3_OR_STAT4
  11453. #endif
  11454. /*
  11455. ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
  11456. ** the Select query generator tracing logic is turned on.
  11457. */
  11458. #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_SELECTTRACE)
  11459. # define SELECTTRACE_ENABLED 1
  11460. #else
  11461. # define SELECTTRACE_ENABLED 0
  11462. #endif
  11463. /*
  11464. ** An instance of the following structure is used to store the busy-handler
  11465. ** callback for a given sqlite handle.
  11466. **
  11467. ** The sqlite.busyHandler member of the sqlite struct contains the busy
  11468. ** callback for the database handle. Each pager opened via the sqlite
  11469. ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
  11470. ** callback is currently invoked only from within pager.c.
  11471. */
  11472. typedef struct BusyHandler BusyHandler;
  11473. struct BusyHandler {
  11474. int (*xFunc)(void *,int); /* The busy callback */
  11475. void *pArg; /* First arg to busy callback */
  11476. int nBusy; /* Incremented with each busy call */
  11477. };
  11478. /*
  11479. ** Name of the master database table. The master database table
  11480. ** is a special table that holds the names and attributes of all
  11481. ** user tables and indices.
  11482. */
  11483. #define MASTER_NAME "sqlite_master"
  11484. #define TEMP_MASTER_NAME "sqlite_temp_master"
  11485. /*
  11486. ** The root-page of the master database table.
  11487. */
  11488. #define MASTER_ROOT 1
  11489. /*
  11490. ** The name of the schema table.
  11491. */
  11492. #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
  11493. /*
  11494. ** A convenience macro that returns the number of elements in
  11495. ** an array.
  11496. */
  11497. #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
  11498. /*
  11499. ** Determine if the argument is a power of two
  11500. */
  11501. #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
  11502. /*
  11503. ** The following value as a destructor means to use sqlite3DbFree().
  11504. ** The sqlite3DbFree() routine requires two parameters instead of the
  11505. ** one parameter that destructors normally want. So we have to introduce
  11506. ** this magic value that the code knows to handle differently. Any
  11507. ** pointer will work here as long as it is distinct from SQLITE_STATIC
  11508. ** and SQLITE_TRANSIENT.
  11509. */
  11510. #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize)
  11511. /*
  11512. ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
  11513. ** not support Writable Static Data (WSD) such as global and static variables.
  11514. ** All variables must either be on the stack or dynamically allocated from
  11515. ** the heap. When WSD is unsupported, the variable declarations scattered
  11516. ** throughout the SQLite code must become constants instead. The SQLITE_WSD
  11517. ** macro is used for this purpose. And instead of referencing the variable
  11518. ** directly, we use its constant as a key to lookup the run-time allocated
  11519. ** buffer that holds real variable. The constant is also the initializer
  11520. ** for the run-time allocated buffer.
  11521. **
  11522. ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
  11523. ** macros become no-ops and have zero performance impact.
  11524. */
  11525. #ifdef SQLITE_OMIT_WSD
  11526. #define SQLITE_WSD const
  11527. #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
  11528. #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
  11529. SQLITE_API int sqlite3_wsd_init(int N, int J);
  11530. SQLITE_API void *sqlite3_wsd_find(void *K, int L);
  11531. #else
  11532. #define SQLITE_WSD
  11533. #define GLOBAL(t,v) v
  11534. #define sqlite3GlobalConfig sqlite3Config
  11535. #endif
  11536. /*
  11537. ** The following macros are used to suppress compiler warnings and to
  11538. ** make it clear to human readers when a function parameter is deliberately
  11539. ** left unused within the body of a function. This usually happens when
  11540. ** a function is called via a function pointer. For example the
  11541. ** implementation of an SQL aggregate step callback may not use the
  11542. ** parameter indicating the number of arguments passed to the aggregate,
  11543. ** if it knows that this is enforced elsewhere.
  11544. **
  11545. ** When a function parameter is not used at all within the body of a function,
  11546. ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
  11547. ** However, these macros may also be used to suppress warnings related to
  11548. ** parameters that may or may not be used depending on compilation options.
  11549. ** For example those parameters only used in assert() statements. In these
  11550. ** cases the parameters are named as per the usual conventions.
  11551. */
  11552. #define UNUSED_PARAMETER(x) (void)(x)
  11553. #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
  11554. /*
  11555. ** Forward references to structures
  11556. */
  11557. typedef struct AggInfo AggInfo;
  11558. typedef struct AuthContext AuthContext;
  11559. typedef struct AutoincInfo AutoincInfo;
  11560. typedef struct Bitvec Bitvec;
  11561. typedef struct CollSeq CollSeq;
  11562. typedef struct Column Column;
  11563. typedef struct Db Db;
  11564. typedef struct Schema Schema;
  11565. typedef struct Expr Expr;
  11566. typedef struct ExprList ExprList;
  11567. typedef struct ExprSpan ExprSpan;
  11568. typedef struct FKey FKey;
  11569. typedef struct FuncDestructor FuncDestructor;
  11570. typedef struct FuncDef FuncDef;
  11571. typedef struct FuncDefHash FuncDefHash;
  11572. typedef struct IdList IdList;
  11573. typedef struct Index Index;
  11574. typedef struct IndexSample IndexSample;
  11575. typedef struct KeyClass KeyClass;
  11576. typedef struct KeyInfo KeyInfo;
  11577. typedef struct Lookaside Lookaside;
  11578. typedef struct LookasideSlot LookasideSlot;
  11579. typedef struct Module Module;
  11580. typedef struct NameContext NameContext;
  11581. typedef struct Parse Parse;
  11582. typedef struct PreUpdate PreUpdate;
  11583. typedef struct PrintfArguments PrintfArguments;
  11584. typedef struct RowSet RowSet;
  11585. typedef struct Savepoint Savepoint;
  11586. typedef struct Select Select;
  11587. typedef struct SQLiteThread SQLiteThread;
  11588. typedef struct SelectDest SelectDest;
  11589. typedef struct SrcList SrcList;
  11590. typedef struct StrAccum StrAccum;
  11591. typedef struct Table Table;
  11592. typedef struct TableLock TableLock;
  11593. typedef struct Token Token;
  11594. typedef struct TreeView TreeView;
  11595. typedef struct Trigger Trigger;
  11596. typedef struct TriggerPrg TriggerPrg;
  11597. typedef struct TriggerStep TriggerStep;
  11598. typedef struct UnpackedRecord UnpackedRecord;
  11599. typedef struct VTable VTable;
  11600. typedef struct VtabCtx VtabCtx;
  11601. typedef struct Walker Walker;
  11602. typedef struct WhereInfo WhereInfo;
  11603. typedef struct With With;
  11604. /*
  11605. ** Defer sourcing vdbe.h and btree.h until after the "u8" and
  11606. ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
  11607. ** pointer types (i.e. FuncDef) defined above.
  11608. */
  11609. /************** Include btree.h in the middle of sqliteInt.h *****************/
  11610. /************** Begin file btree.h *******************************************/
  11611. /*
  11612. ** 2001 September 15
  11613. **
  11614. ** The author disclaims copyright to this source code. In place of
  11615. ** a legal notice, here is a blessing:
  11616. **
  11617. ** May you do good and not evil.
  11618. ** May you find forgiveness for yourself and forgive others.
  11619. ** May you share freely, never taking more than you give.
  11620. **
  11621. *************************************************************************
  11622. ** This header file defines the interface that the sqlite B-Tree file
  11623. ** subsystem. See comments in the source code for a detailed description
  11624. ** of what each interface routine does.
  11625. */
  11626. #ifndef SQLITE_BTREE_H
  11627. #define SQLITE_BTREE_H
  11628. /* TODO: This definition is just included so other modules compile. It
  11629. ** needs to be revisited.
  11630. */
  11631. #define SQLITE_N_BTREE_META 16
  11632. /*
  11633. ** If defined as non-zero, auto-vacuum is enabled by default. Otherwise
  11634. ** it must be turned on for each database using "PRAGMA auto_vacuum = 1".
  11635. */
  11636. #ifndef SQLITE_DEFAULT_AUTOVACUUM
  11637. #define SQLITE_DEFAULT_AUTOVACUUM 0
  11638. #endif
  11639. #define BTREE_AUTOVACUUM_NONE 0 /* Do not do auto-vacuum */
  11640. #define BTREE_AUTOVACUUM_FULL 1 /* Do full auto-vacuum */
  11641. #define BTREE_AUTOVACUUM_INCR 2 /* Incremental vacuum */
  11642. /*
  11643. ** Forward declarations of structure
  11644. */
  11645. typedef struct Btree Btree;
  11646. typedef struct BtCursor BtCursor;
  11647. typedef struct BtShared BtShared;
  11648. typedef struct BtreePayload BtreePayload;
  11649. SQLITE_PRIVATE int sqlite3BtreeOpen(
  11650. sqlite3_vfs *pVfs, /* VFS to use with this b-tree */
  11651. const char *zFilename, /* Name of database file to open */
  11652. sqlite3 *db, /* Associated database connection */
  11653. Btree **ppBtree, /* Return open Btree* here */
  11654. int flags, /* Flags */
  11655. int vfsFlags /* Flags passed through to VFS open */
  11656. );
  11657. /* The flags parameter to sqlite3BtreeOpen can be the bitwise or of the
  11658. ** following values.
  11659. **
  11660. ** NOTE: These values must match the corresponding PAGER_ values in
  11661. ** pager.h.
  11662. */
  11663. #define BTREE_OMIT_JOURNAL 1 /* Do not create or use a rollback journal */
  11664. #define BTREE_MEMORY 2 /* This is an in-memory DB */
  11665. #define BTREE_SINGLE 4 /* The file contains at most 1 b-tree */
  11666. #define BTREE_UNORDERED 8 /* Use of a hash implementation is OK */
  11667. SQLITE_PRIVATE int sqlite3BtreeClose(Btree*);
  11668. SQLITE_PRIVATE int sqlite3BtreeSetCacheSize(Btree*,int);
  11669. SQLITE_PRIVATE int sqlite3BtreeSetSpillSize(Btree*,int);
  11670. #if SQLITE_MAX_MMAP_SIZE>0
  11671. SQLITE_PRIVATE int sqlite3BtreeSetMmapLimit(Btree*,sqlite3_int64);
  11672. #endif
  11673. SQLITE_PRIVATE int sqlite3BtreeSetPagerFlags(Btree*,unsigned);
  11674. SQLITE_PRIVATE int sqlite3BtreeSetPageSize(Btree *p, int nPagesize, int nReserve, int eFix);
  11675. SQLITE_PRIVATE int sqlite3BtreeGetPageSize(Btree*);
  11676. SQLITE_PRIVATE int sqlite3BtreeMaxPageCount(Btree*,int);
  11677. SQLITE_PRIVATE u32 sqlite3BtreeLastPage(Btree*);
  11678. SQLITE_PRIVATE int sqlite3BtreeSecureDelete(Btree*,int);
  11679. SQLITE_PRIVATE int sqlite3BtreeGetOptimalReserve(Btree*);
  11680. SQLITE_PRIVATE int sqlite3BtreeGetReserveNoMutex(Btree *p);
  11681. SQLITE_PRIVATE int sqlite3BtreeSetAutoVacuum(Btree *, int);
  11682. SQLITE_PRIVATE int sqlite3BtreeGetAutoVacuum(Btree *);
  11683. SQLITE_PRIVATE int sqlite3BtreeBeginTrans(Btree*,int);
  11684. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseOne(Btree*, const char *zMaster);
  11685. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseTwo(Btree*, int);
  11686. SQLITE_PRIVATE int sqlite3BtreeCommit(Btree*);
  11687. SQLITE_PRIVATE int sqlite3BtreeRollback(Btree*,int,int);
  11688. SQLITE_PRIVATE int sqlite3BtreeBeginStmt(Btree*,int);
  11689. SQLITE_PRIVATE int sqlite3BtreeCreateTable(Btree*, int*, int flags);
  11690. SQLITE_PRIVATE int sqlite3BtreeIsInTrans(Btree*);
  11691. SQLITE_PRIVATE int sqlite3BtreeIsInReadTrans(Btree*);
  11692. SQLITE_PRIVATE int sqlite3BtreeIsInBackup(Btree*);
  11693. SQLITE_PRIVATE void *sqlite3BtreeSchema(Btree *, int, void(*)(void *));
  11694. SQLITE_PRIVATE int sqlite3BtreeSchemaLocked(Btree *pBtree);
  11695. #ifndef SQLITE_OMIT_SHARED_CACHE
  11696. SQLITE_PRIVATE int sqlite3BtreeLockTable(Btree *pBtree, int iTab, u8 isWriteLock);
  11697. #endif
  11698. SQLITE_PRIVATE int sqlite3BtreeSavepoint(Btree *, int, int);
  11699. SQLITE_PRIVATE const char *sqlite3BtreeGetFilename(Btree *);
  11700. SQLITE_PRIVATE const char *sqlite3BtreeGetJournalname(Btree *);
  11701. SQLITE_PRIVATE int sqlite3BtreeCopyFile(Btree *, Btree *);
  11702. SQLITE_PRIVATE int sqlite3BtreeIncrVacuum(Btree *);
  11703. /* The flags parameter to sqlite3BtreeCreateTable can be the bitwise OR
  11704. ** of the flags shown below.
  11705. **
  11706. ** Every SQLite table must have either BTREE_INTKEY or BTREE_BLOBKEY set.
  11707. ** With BTREE_INTKEY, the table key is a 64-bit integer and arbitrary data
  11708. ** is stored in the leaves. (BTREE_INTKEY is used for SQL tables.) With
  11709. ** BTREE_BLOBKEY, the key is an arbitrary BLOB and no content is stored
  11710. ** anywhere - the key is the content. (BTREE_BLOBKEY is used for SQL
  11711. ** indices.)
  11712. */
  11713. #define BTREE_INTKEY 1 /* Table has only 64-bit signed integer keys */
  11714. #define BTREE_BLOBKEY 2 /* Table has keys only - no data */
  11715. SQLITE_PRIVATE int sqlite3BtreeDropTable(Btree*, int, int*);
  11716. SQLITE_PRIVATE int sqlite3BtreeClearTable(Btree*, int, int*);
  11717. SQLITE_PRIVATE int sqlite3BtreeClearTableOfCursor(BtCursor*);
  11718. SQLITE_PRIVATE int sqlite3BtreeTripAllCursors(Btree*, int, int);
  11719. SQLITE_PRIVATE void sqlite3BtreeGetMeta(Btree *pBtree, int idx, u32 *pValue);
  11720. SQLITE_PRIVATE int sqlite3BtreeUpdateMeta(Btree*, int idx, u32 value);
  11721. SQLITE_PRIVATE int sqlite3BtreeNewDb(Btree *p);
  11722. /*
  11723. ** The second parameter to sqlite3BtreeGetMeta or sqlite3BtreeUpdateMeta
  11724. ** should be one of the following values. The integer values are assigned
  11725. ** to constants so that the offset of the corresponding field in an
  11726. ** SQLite database header may be found using the following formula:
  11727. **
  11728. ** offset = 36 + (idx * 4)
  11729. **
  11730. ** For example, the free-page-count field is located at byte offset 36 of
  11731. ** the database file header. The incr-vacuum-flag field is located at
  11732. ** byte offset 64 (== 36+4*7).
  11733. **
  11734. ** The BTREE_DATA_VERSION value is not really a value stored in the header.
  11735. ** It is a read-only number computed by the pager. But we merge it with
  11736. ** the header value access routines since its access pattern is the same.
  11737. ** Call it a "virtual meta value".
  11738. */
  11739. #define BTREE_FREE_PAGE_COUNT 0
  11740. #define BTREE_SCHEMA_VERSION 1
  11741. #define BTREE_FILE_FORMAT 2
  11742. #define BTREE_DEFAULT_CACHE_SIZE 3
  11743. #define BTREE_LARGEST_ROOT_PAGE 4
  11744. #define BTREE_TEXT_ENCODING 5
  11745. #define BTREE_USER_VERSION 6
  11746. #define BTREE_INCR_VACUUM 7
  11747. #define BTREE_APPLICATION_ID 8
  11748. #define BTREE_DATA_VERSION 15 /* A virtual meta-value */
  11749. /*
  11750. ** Kinds of hints that can be passed into the sqlite3BtreeCursorHint()
  11751. ** interface.
  11752. **
  11753. ** BTREE_HINT_RANGE (arguments: Expr*, Mem*)
  11754. **
  11755. ** The first argument is an Expr* (which is guaranteed to be constant for
  11756. ** the lifetime of the cursor) that defines constraints on which rows
  11757. ** might be fetched with this cursor. The Expr* tree may contain
  11758. ** TK_REGISTER nodes that refer to values stored in the array of registers
  11759. ** passed as the second parameter. In other words, if Expr.op==TK_REGISTER
  11760. ** then the value of the node is the value in Mem[pExpr.iTable]. Any
  11761. ** TK_COLUMN node in the expression tree refers to the Expr.iColumn-th
  11762. ** column of the b-tree of the cursor. The Expr tree will not contain
  11763. ** any function calls nor subqueries nor references to b-trees other than
  11764. ** the cursor being hinted.
  11765. **
  11766. ** The design of the _RANGE hint is aid b-tree implementations that try
  11767. ** to prefetch content from remote machines - to provide those
  11768. ** implementations with limits on what needs to be prefetched and thereby
  11769. ** reduce network bandwidth.
  11770. **
  11771. ** Note that BTREE_HINT_FLAGS with BTREE_BULKLOAD is the only hint used by
  11772. ** standard SQLite. The other hints are provided for extentions that use
  11773. ** the SQLite parser and code generator but substitute their own storage
  11774. ** engine.
  11775. */
  11776. #define BTREE_HINT_RANGE 0 /* Range constraints on queries */
  11777. /*
  11778. ** Values that may be OR'd together to form the argument to the
  11779. ** BTREE_HINT_FLAGS hint for sqlite3BtreeCursorHint():
  11780. **
  11781. ** The BTREE_BULKLOAD flag is set on index cursors when the index is going
  11782. ** to be filled with content that is already in sorted order.
  11783. **
  11784. ** The BTREE_SEEK_EQ flag is set on cursors that will get OP_SeekGE or
  11785. ** OP_SeekLE opcodes for a range search, but where the range of entries
  11786. ** selected will all have the same key. In other words, the cursor will
  11787. ** be used only for equality key searches.
  11788. **
  11789. */
  11790. #define BTREE_BULKLOAD 0x00000001 /* Used to full index in sorted order */
  11791. #define BTREE_SEEK_EQ 0x00000002 /* EQ seeks only - no range seeks */
  11792. /*
  11793. ** Flags passed as the third argument to sqlite3BtreeCursor().
  11794. **
  11795. ** For read-only cursors the wrFlag argument is always zero. For read-write
  11796. ** cursors it may be set to either (BTREE_WRCSR|BTREE_FORDELETE) or just
  11797. ** (BTREE_WRCSR). If the BTREE_FORDELETE bit is set, then the cursor will
  11798. ** only be used by SQLite for the following:
  11799. **
  11800. ** * to seek to and then delete specific entries, and/or
  11801. **
  11802. ** * to read values that will be used to create keys that other
  11803. ** BTREE_FORDELETE cursors will seek to and delete.
  11804. **
  11805. ** The BTREE_FORDELETE flag is an optimization hint. It is not used by
  11806. ** by this, the native b-tree engine of SQLite, but it is available to
  11807. ** alternative storage engines that might be substituted in place of this
  11808. ** b-tree system. For alternative storage engines in which a delete of
  11809. ** the main table row automatically deletes corresponding index rows,
  11810. ** the FORDELETE flag hint allows those alternative storage engines to
  11811. ** skip a lot of work. Namely: FORDELETE cursors may treat all SEEK
  11812. ** and DELETE operations as no-ops, and any READ operation against a
  11813. ** FORDELETE cursor may return a null row: 0x01 0x00.
  11814. */
  11815. #define BTREE_WRCSR 0x00000004 /* read-write cursor */
  11816. #define BTREE_FORDELETE 0x00000008 /* Cursor is for seek/delete only */
  11817. SQLITE_PRIVATE int sqlite3BtreeCursor(
  11818. Btree*, /* BTree containing table to open */
  11819. int iTable, /* Index of root page */
  11820. int wrFlag, /* 1 for writing. 0 for read-only */
  11821. struct KeyInfo*, /* First argument to compare function */
  11822. BtCursor *pCursor /* Space to write cursor structure */
  11823. );
  11824. SQLITE_PRIVATE int sqlite3BtreeCursorSize(void);
  11825. SQLITE_PRIVATE void sqlite3BtreeCursorZero(BtCursor*);
  11826. SQLITE_PRIVATE void sqlite3BtreeCursorHintFlags(BtCursor*, unsigned);
  11827. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  11828. SQLITE_PRIVATE void sqlite3BtreeCursorHint(BtCursor*, int, ...);
  11829. #endif
  11830. SQLITE_PRIVATE int sqlite3BtreeCloseCursor(BtCursor*);
  11831. SQLITE_PRIVATE int sqlite3BtreeMovetoUnpacked(
  11832. BtCursor*,
  11833. UnpackedRecord *pUnKey,
  11834. i64 intKey,
  11835. int bias,
  11836. int *pRes
  11837. );
  11838. SQLITE_PRIVATE int sqlite3BtreeCursorHasMoved(BtCursor*);
  11839. SQLITE_PRIVATE int sqlite3BtreeCursorRestore(BtCursor*, int*);
  11840. SQLITE_PRIVATE int sqlite3BtreeDelete(BtCursor*, u8 flags);
  11841. /* Allowed flags for the 2nd argument to sqlite3BtreeDelete() */
  11842. #define BTREE_SAVEPOSITION 0x02 /* Leave cursor pointing at NEXT or PREV */
  11843. #define BTREE_AUXDELETE 0x04 /* not the primary delete operation */
  11844. /* An instance of the BtreePayload object describes the content of a single
  11845. ** entry in either an index or table btree.
  11846. **
  11847. ** Index btrees (used for indexes and also WITHOUT ROWID tables) contain
  11848. ** an arbitrary key and no data. These btrees have pKey,nKey set to their
  11849. ** key and pData,nData,nZero set to zero.
  11850. **
  11851. ** Table btrees (used for rowid tables) contain an integer rowid used as
  11852. ** the key and passed in the nKey field. The pKey field is zero.
  11853. ** pData,nData hold the content of the new entry. nZero extra zero bytes
  11854. ** are appended to the end of the content when constructing the entry.
  11855. **
  11856. ** This object is used to pass information into sqlite3BtreeInsert(). The
  11857. ** same information used to be passed as five separate parameters. But placing
  11858. ** the information into this object helps to keep the interface more
  11859. ** organized and understandable, and it also helps the resulting code to
  11860. ** run a little faster by using fewer registers for parameter passing.
  11861. */
  11862. struct BtreePayload {
  11863. const void *pKey; /* Key content for indexes. NULL for tables */
  11864. sqlite3_int64 nKey; /* Size of pKey for indexes. PRIMARY KEY for tabs */
  11865. const void *pData; /* Data for tables. NULL for indexes */
  11866. int nData; /* Size of pData. 0 if none. */
  11867. int nZero; /* Extra zero data appended after pData,nData */
  11868. };
  11869. SQLITE_PRIVATE int sqlite3BtreeInsert(BtCursor*, const BtreePayload *pPayload,
  11870. int bias, int seekResult);
  11871. SQLITE_PRIVATE int sqlite3BtreeFirst(BtCursor*, int *pRes);
  11872. SQLITE_PRIVATE int sqlite3BtreeLast(BtCursor*, int *pRes);
  11873. SQLITE_PRIVATE int sqlite3BtreeNext(BtCursor*, int *pRes);
  11874. SQLITE_PRIVATE int sqlite3BtreeEof(BtCursor*);
  11875. SQLITE_PRIVATE int sqlite3BtreePrevious(BtCursor*, int *pRes);
  11876. SQLITE_PRIVATE i64 sqlite3BtreeIntegerKey(BtCursor*);
  11877. SQLITE_PRIVATE int sqlite3BtreeKey(BtCursor*, u32 offset, u32 amt, void*);
  11878. SQLITE_PRIVATE const void *sqlite3BtreePayloadFetch(BtCursor*, u32 *pAmt);
  11879. SQLITE_PRIVATE u32 sqlite3BtreePayloadSize(BtCursor*);
  11880. SQLITE_PRIVATE int sqlite3BtreeData(BtCursor*, u32 offset, u32 amt, void*);
  11881. SQLITE_PRIVATE char *sqlite3BtreeIntegrityCheck(Btree*, int *aRoot, int nRoot, int, int*);
  11882. SQLITE_PRIVATE struct Pager *sqlite3BtreePager(Btree*);
  11883. #ifndef SQLITE_OMIT_INCRBLOB
  11884. SQLITE_PRIVATE int sqlite3BtreePutData(BtCursor*, u32 offset, u32 amt, void*);
  11885. SQLITE_PRIVATE void sqlite3BtreeIncrblobCursor(BtCursor *);
  11886. #endif
  11887. SQLITE_PRIVATE void sqlite3BtreeClearCursor(BtCursor *);
  11888. SQLITE_PRIVATE int sqlite3BtreeSetVersion(Btree *pBt, int iVersion);
  11889. SQLITE_PRIVATE int sqlite3BtreeCursorHasHint(BtCursor*, unsigned int mask);
  11890. SQLITE_PRIVATE int sqlite3BtreeIsReadonly(Btree *pBt);
  11891. SQLITE_PRIVATE int sqlite3HeaderSizeBtree(void);
  11892. #ifndef NDEBUG
  11893. SQLITE_PRIVATE int sqlite3BtreeCursorIsValid(BtCursor*);
  11894. #endif
  11895. #ifndef SQLITE_OMIT_BTREECOUNT
  11896. SQLITE_PRIVATE int sqlite3BtreeCount(BtCursor *, i64 *);
  11897. #endif
  11898. #ifdef SQLITE_TEST
  11899. SQLITE_PRIVATE int sqlite3BtreeCursorInfo(BtCursor*, int*, int);
  11900. SQLITE_PRIVATE void sqlite3BtreeCursorList(Btree*);
  11901. #endif
  11902. #ifndef SQLITE_OMIT_WAL
  11903. SQLITE_PRIVATE int sqlite3BtreeCheckpoint(Btree*, int, int *, int *);
  11904. #endif
  11905. /*
  11906. ** If we are not using shared cache, then there is no need to
  11907. ** use mutexes to access the BtShared structures. So make the
  11908. ** Enter and Leave procedures no-ops.
  11909. */
  11910. #ifndef SQLITE_OMIT_SHARED_CACHE
  11911. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree*);
  11912. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3*);
  11913. SQLITE_PRIVATE int sqlite3BtreeSharable(Btree*);
  11914. SQLITE_PRIVATE void sqlite3BtreeEnterCursor(BtCursor*);
  11915. SQLITE_PRIVATE int sqlite3BtreeConnectionCount(Btree*);
  11916. #else
  11917. # define sqlite3BtreeEnter(X)
  11918. # define sqlite3BtreeEnterAll(X)
  11919. # define sqlite3BtreeSharable(X) 0
  11920. # define sqlite3BtreeEnterCursor(X)
  11921. # define sqlite3BtreeConnectionCount(X) 1
  11922. #endif
  11923. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE
  11924. SQLITE_PRIVATE void sqlite3BtreeLeave(Btree*);
  11925. SQLITE_PRIVATE void sqlite3BtreeLeaveCursor(BtCursor*);
  11926. SQLITE_PRIVATE void sqlite3BtreeLeaveAll(sqlite3*);
  11927. #ifndef NDEBUG
  11928. /* These routines are used inside assert() statements only. */
  11929. SQLITE_PRIVATE int sqlite3BtreeHoldsMutex(Btree*);
  11930. SQLITE_PRIVATE int sqlite3BtreeHoldsAllMutexes(sqlite3*);
  11931. SQLITE_PRIVATE int sqlite3SchemaMutexHeld(sqlite3*,int,Schema*);
  11932. #endif
  11933. #else
  11934. # define sqlite3BtreeLeave(X)
  11935. # define sqlite3BtreeLeaveCursor(X)
  11936. # define sqlite3BtreeLeaveAll(X)
  11937. # define sqlite3BtreeHoldsMutex(X) 1
  11938. # define sqlite3BtreeHoldsAllMutexes(X) 1
  11939. # define sqlite3SchemaMutexHeld(X,Y,Z) 1
  11940. #endif
  11941. #endif /* SQLITE_BTREE_H */
  11942. /************** End of btree.h ***********************************************/
  11943. /************** Continuing where we left off in sqliteInt.h ******************/
  11944. /************** Include vdbe.h in the middle of sqliteInt.h ******************/
  11945. /************** Begin file vdbe.h ********************************************/
  11946. /*
  11947. ** 2001 September 15
  11948. **
  11949. ** The author disclaims copyright to this source code. In place of
  11950. ** a legal notice, here is a blessing:
  11951. **
  11952. ** May you do good and not evil.
  11953. ** May you find forgiveness for yourself and forgive others.
  11954. ** May you share freely, never taking more than you give.
  11955. **
  11956. *************************************************************************
  11957. ** Header file for the Virtual DataBase Engine (VDBE)
  11958. **
  11959. ** This header defines the interface to the virtual database engine
  11960. ** or VDBE. The VDBE implements an abstract machine that runs a
  11961. ** simple program to access and modify the underlying database.
  11962. */
  11963. #ifndef SQLITE_VDBE_H
  11964. #define SQLITE_VDBE_H
  11965. /* #include <stdio.h> */
  11966. /*
  11967. ** A single VDBE is an opaque structure named "Vdbe". Only routines
  11968. ** in the source file sqliteVdbe.c are allowed to see the insides
  11969. ** of this structure.
  11970. */
  11971. typedef struct Vdbe Vdbe;
  11972. /*
  11973. ** The names of the following types declared in vdbeInt.h are required
  11974. ** for the VdbeOp definition.
  11975. */
  11976. typedef struct Mem Mem;
  11977. typedef struct SubProgram SubProgram;
  11978. /*
  11979. ** A single instruction of the virtual machine has an opcode
  11980. ** and as many as three operands. The instruction is recorded
  11981. ** as an instance of the following structure:
  11982. */
  11983. struct VdbeOp {
  11984. u8 opcode; /* What operation to perform */
  11985. signed char p4type; /* One of the P4_xxx constants for p4 */
  11986. u8 notUsed1;
  11987. u8 p5; /* Fifth parameter is an unsigned character */
  11988. int p1; /* First operand */
  11989. int p2; /* Second parameter (often the jump destination) */
  11990. int p3; /* The third parameter */
  11991. union p4union { /* fourth parameter */
  11992. int i; /* Integer value if p4type==P4_INT32 */
  11993. void *p; /* Generic pointer */
  11994. char *z; /* Pointer to data for string (char array) types */
  11995. i64 *pI64; /* Used when p4type is P4_INT64 */
  11996. double *pReal; /* Used when p4type is P4_REAL */
  11997. FuncDef *pFunc; /* Used when p4type is P4_FUNCDEF */
  11998. sqlite3_context *pCtx; /* Used when p4type is P4_FUNCCTX */
  11999. CollSeq *pColl; /* Used when p4type is P4_COLLSEQ */
  12000. Mem *pMem; /* Used when p4type is P4_MEM */
  12001. VTable *pVtab; /* Used when p4type is P4_VTAB */
  12002. KeyInfo *pKeyInfo; /* Used when p4type is P4_KEYINFO */
  12003. int *ai; /* Used when p4type is P4_INTARRAY */
  12004. SubProgram *pProgram; /* Used when p4type is P4_SUBPROGRAM */
  12005. Table *pTab; /* Used when p4type is P4_TABLE */
  12006. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  12007. Expr *pExpr; /* Used when p4type is P4_EXPR */
  12008. #endif
  12009. int (*xAdvance)(BtCursor *, int *);
  12010. } p4;
  12011. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  12012. char *zComment; /* Comment to improve readability */
  12013. #endif
  12014. #ifdef VDBE_PROFILE
  12015. u32 cnt; /* Number of times this instruction was executed */
  12016. u64 cycles; /* Total time spent executing this instruction */
  12017. #endif
  12018. #ifdef SQLITE_VDBE_COVERAGE
  12019. int iSrcLine; /* Source-code line that generated this opcode */
  12020. #endif
  12021. };
  12022. typedef struct VdbeOp VdbeOp;
  12023. /*
  12024. ** A sub-routine used to implement a trigger program.
  12025. */
  12026. struct SubProgram {
  12027. VdbeOp *aOp; /* Array of opcodes for sub-program */
  12028. int nOp; /* Elements in aOp[] */
  12029. int nMem; /* Number of memory cells required */
  12030. int nCsr; /* Number of cursors required */
  12031. void *token; /* id that may be used to recursive triggers */
  12032. SubProgram *pNext; /* Next sub-program already visited */
  12033. };
  12034. /*
  12035. ** A smaller version of VdbeOp used for the VdbeAddOpList() function because
  12036. ** it takes up less space.
  12037. */
  12038. struct VdbeOpList {
  12039. u8 opcode; /* What operation to perform */
  12040. signed char p1; /* First operand */
  12041. signed char p2; /* Second parameter (often the jump destination) */
  12042. signed char p3; /* Third parameter */
  12043. };
  12044. typedef struct VdbeOpList VdbeOpList;
  12045. /*
  12046. ** Allowed values of VdbeOp.p4type
  12047. */
  12048. #define P4_NOTUSED 0 /* The P4 parameter is not used */
  12049. #define P4_DYNAMIC (-1) /* Pointer to a string obtained from sqliteMalloc() */
  12050. #define P4_STATIC (-2) /* Pointer to a static string */
  12051. #define P4_COLLSEQ (-4) /* P4 is a pointer to a CollSeq structure */
  12052. #define P4_FUNCDEF (-5) /* P4 is a pointer to a FuncDef structure */
  12053. #define P4_KEYINFO (-6) /* P4 is a pointer to a KeyInfo structure */
  12054. #define P4_EXPR (-7) /* P4 is a pointer to an Expr tree */
  12055. #define P4_MEM (-8) /* P4 is a pointer to a Mem* structure */
  12056. #define P4_TRANSIENT 0 /* P4 is a pointer to a transient string */
  12057. #define P4_VTAB (-10) /* P4 is a pointer to an sqlite3_vtab structure */
  12058. #define P4_MPRINTF (-11) /* P4 is a string obtained from sqlite3_mprintf() */
  12059. #define P4_REAL (-12) /* P4 is a 64-bit floating point value */
  12060. #define P4_INT64 (-13) /* P4 is a 64-bit signed integer */
  12061. #define P4_INT32 (-14) /* P4 is a 32-bit signed integer */
  12062. #define P4_INTARRAY (-15) /* P4 is a vector of 32-bit integers */
  12063. #define P4_SUBPROGRAM (-18) /* P4 is a pointer to a SubProgram structure */
  12064. #define P4_ADVANCE (-19) /* P4 is a pointer to BtreeNext() or BtreePrev() */
  12065. #define P4_TABLE (-20) /* P4 is a pointer to a Table structure */
  12066. #define P4_FUNCCTX (-21) /* P4 is a pointer to an sqlite3_context object */
  12067. /* Error message codes for OP_Halt */
  12068. #define P5_ConstraintNotNull 1
  12069. #define P5_ConstraintUnique 2
  12070. #define P5_ConstraintCheck 3
  12071. #define P5_ConstraintFK 4
  12072. /*
  12073. ** The Vdbe.aColName array contains 5n Mem structures, where n is the
  12074. ** number of columns of data returned by the statement.
  12075. */
  12076. #define COLNAME_NAME 0
  12077. #define COLNAME_DECLTYPE 1
  12078. #define COLNAME_DATABASE 2
  12079. #define COLNAME_TABLE 3
  12080. #define COLNAME_COLUMN 4
  12081. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  12082. # define COLNAME_N 5 /* Number of COLNAME_xxx symbols */
  12083. #else
  12084. # ifdef SQLITE_OMIT_DECLTYPE
  12085. # define COLNAME_N 1 /* Store only the name */
  12086. # else
  12087. # define COLNAME_N 2 /* Store the name and decltype */
  12088. # endif
  12089. #endif
  12090. /*
  12091. ** The following macro converts a relative address in the p2 field
  12092. ** of a VdbeOp structure into a negative number so that
  12093. ** sqlite3VdbeAddOpList() knows that the address is relative. Calling
  12094. ** the macro again restores the address.
  12095. */
  12096. #define ADDR(X) (-1-(X))
  12097. /*
  12098. ** The makefile scans the vdbe.c source file and creates the "opcodes.h"
  12099. ** header file that defines a number for each opcode used by the VDBE.
  12100. */
  12101. /************** Include opcodes.h in the middle of vdbe.h ********************/
  12102. /************** Begin file opcodes.h *****************************************/
  12103. /* Automatically generated. Do not edit */
  12104. /* See the tool/mkopcodeh.tcl script for details */
  12105. #define OP_Savepoint 0
  12106. #define OP_AutoCommit 1
  12107. #define OP_Transaction 2
  12108. #define OP_SorterNext 3
  12109. #define OP_PrevIfOpen 4
  12110. #define OP_NextIfOpen 5
  12111. #define OP_Prev 6
  12112. #define OP_Next 7
  12113. #define OP_Checkpoint 8
  12114. #define OP_JournalMode 9
  12115. #define OP_Vacuum 10
  12116. #define OP_VFilter 11 /* synopsis: iplan=r[P3] zplan='P4' */
  12117. #define OP_VUpdate 12 /* synopsis: data=r[P3@P2] */
  12118. #define OP_Goto 13
  12119. #define OP_Gosub 14
  12120. #define OP_InitCoroutine 15
  12121. #define OP_Yield 16
  12122. #define OP_MustBeInt 17
  12123. #define OP_Jump 18
  12124. #define OP_Not 19 /* same as TK_NOT, synopsis: r[P2]= !r[P1] */
  12125. #define OP_Once 20
  12126. #define OP_If 21
  12127. #define OP_IfNot 22
  12128. #define OP_SeekLT 23 /* synopsis: key=r[P3@P4] */
  12129. #define OP_SeekLE 24 /* synopsis: key=r[P3@P4] */
  12130. #define OP_SeekGE 25 /* synopsis: key=r[P3@P4] */
  12131. #define OP_SeekGT 26 /* synopsis: key=r[P3@P4] */
  12132. #define OP_Or 27 /* same as TK_OR, synopsis: r[P3]=(r[P1] || r[P2]) */
  12133. #define OP_And 28 /* same as TK_AND, synopsis: r[P3]=(r[P1] && r[P2]) */
  12134. #define OP_NoConflict 29 /* synopsis: key=r[P3@P4] */
  12135. #define OP_NotFound 30 /* synopsis: key=r[P3@P4] */
  12136. #define OP_Found 31 /* synopsis: key=r[P3@P4] */
  12137. #define OP_SeekRowid 32 /* synopsis: intkey=r[P3] */
  12138. #define OP_NotExists 33 /* synopsis: intkey=r[P3] */
  12139. #define OP_IsNull 34 /* same as TK_ISNULL, synopsis: if r[P1]==NULL goto P2 */
  12140. #define OP_NotNull 35 /* same as TK_NOTNULL, synopsis: if r[P1]!=NULL goto P2 */
  12141. #define OP_Ne 36 /* same as TK_NE, synopsis: IF r[P3]!=r[P1] */
  12142. #define OP_Eq 37 /* same as TK_EQ, synopsis: IF r[P3]==r[P1] */
  12143. #define OP_Gt 38 /* same as TK_GT, synopsis: IF r[P3]>r[P1] */
  12144. #define OP_Le 39 /* same as TK_LE, synopsis: IF r[P3]<=r[P1] */
  12145. #define OP_Lt 40 /* same as TK_LT, synopsis: IF r[P3]<r[P1] */
  12146. #define OP_Ge 41 /* same as TK_GE, synopsis: IF r[P3]>=r[P1] */
  12147. #define OP_ElseNotEq 42 /* same as TK_ESCAPE */
  12148. #define OP_BitAnd 43 /* same as TK_BITAND, synopsis: r[P3]=r[P1]&r[P2] */
  12149. #define OP_BitOr 44 /* same as TK_BITOR, synopsis: r[P3]=r[P1]|r[P2] */
  12150. #define OP_ShiftLeft 45 /* same as TK_LSHIFT, synopsis: r[P3]=r[P2]<<r[P1] */
  12151. #define OP_ShiftRight 46 /* same as TK_RSHIFT, synopsis: r[P3]=r[P2]>>r[P1] */
  12152. #define OP_Add 47 /* same as TK_PLUS, synopsis: r[P3]=r[P1]+r[P2] */
  12153. #define OP_Subtract 48 /* same as TK_MINUS, synopsis: r[P3]=r[P2]-r[P1] */
  12154. #define OP_Multiply 49 /* same as TK_STAR, synopsis: r[P3]=r[P1]*r[P2] */
  12155. #define OP_Divide 50 /* same as TK_SLASH, synopsis: r[P3]=r[P2]/r[P1] */
  12156. #define OP_Remainder 51 /* same as TK_REM, synopsis: r[P3]=r[P2]%r[P1] */
  12157. #define OP_Concat 52 /* same as TK_CONCAT, synopsis: r[P3]=r[P2]+r[P1] */
  12158. #define OP_Last 53
  12159. #define OP_BitNot 54 /* same as TK_BITNOT, synopsis: r[P1]= ~r[P1] */
  12160. #define OP_SorterSort 55
  12161. #define OP_Sort 56
  12162. #define OP_Rewind 57
  12163. #define OP_IdxLE 58 /* synopsis: key=r[P3@P4] */
  12164. #define OP_IdxGT 59 /* synopsis: key=r[P3@P4] */
  12165. #define OP_IdxLT 60 /* synopsis: key=r[P3@P4] */
  12166. #define OP_IdxGE 61 /* synopsis: key=r[P3@P4] */
  12167. #define OP_RowSetRead 62 /* synopsis: r[P3]=rowset(P1) */
  12168. #define OP_RowSetTest 63 /* synopsis: if r[P3] in rowset(P1) goto P2 */
  12169. #define OP_Program 64
  12170. #define OP_FkIfZero 65 /* synopsis: if fkctr[P1]==0 goto P2 */
  12171. #define OP_IfPos 66 /* synopsis: if r[P1]>0 then r[P1]-=P3, goto P2 */
  12172. #define OP_IfNotZero 67 /* synopsis: if r[P1]!=0 then r[P1]-=P3, goto P2 */
  12173. #define OP_DecrJumpZero 68 /* synopsis: if (--r[P1])==0 goto P2 */
  12174. #define OP_IncrVacuum 69
  12175. #define OP_VNext 70
  12176. #define OP_Init 71 /* synopsis: Start at P2 */
  12177. #define OP_Return 72
  12178. #define OP_EndCoroutine 73
  12179. #define OP_HaltIfNull 74 /* synopsis: if r[P3]=null halt */
  12180. #define OP_Halt 75
  12181. #define OP_Integer 76 /* synopsis: r[P2]=P1 */
  12182. #define OP_Int64 77 /* synopsis: r[P2]=P4 */
  12183. #define OP_String 78 /* synopsis: r[P2]='P4' (len=P1) */
  12184. #define OP_Null 79 /* synopsis: r[P2..P3]=NULL */
  12185. #define OP_SoftNull 80 /* synopsis: r[P1]=NULL */
  12186. #define OP_Blob 81 /* synopsis: r[P2]=P4 (len=P1) */
  12187. #define OP_Variable 82 /* synopsis: r[P2]=parameter(P1,P4) */
  12188. #define OP_Move 83 /* synopsis: r[P2@P3]=r[P1@P3] */
  12189. #define OP_Copy 84 /* synopsis: r[P2@P3+1]=r[P1@P3+1] */
  12190. #define OP_SCopy 85 /* synopsis: r[P2]=r[P1] */
  12191. #define OP_IntCopy 86 /* synopsis: r[P2]=r[P1] */
  12192. #define OP_ResultRow 87 /* synopsis: output=r[P1@P2] */
  12193. #define OP_CollSeq 88
  12194. #define OP_Function0 89 /* synopsis: r[P3]=func(r[P2@P5]) */
  12195. #define OP_Function 90 /* synopsis: r[P3]=func(r[P2@P5]) */
  12196. #define OP_AddImm 91 /* synopsis: r[P1]=r[P1]+P2 */
  12197. #define OP_RealAffinity 92
  12198. #define OP_Cast 93 /* synopsis: affinity(r[P1]) */
  12199. #define OP_Permutation 94
  12200. #define OP_Compare 95 /* synopsis: r[P1@P3] <-> r[P2@P3] */
  12201. #define OP_Column 96 /* synopsis: r[P3]=PX */
  12202. #define OP_String8 97 /* same as TK_STRING, synopsis: r[P2]='P4' */
  12203. #define OP_Affinity 98 /* synopsis: affinity(r[P1@P2]) */
  12204. #define OP_MakeRecord 99 /* synopsis: r[P3]=mkrec(r[P1@P2]) */
  12205. #define OP_Count 100 /* synopsis: r[P2]=count() */
  12206. #define OP_ReadCookie 101
  12207. #define OP_SetCookie 102
  12208. #define OP_ReopenIdx 103 /* synopsis: root=P2 iDb=P3 */
  12209. #define OP_OpenRead 104 /* synopsis: root=P2 iDb=P3 */
  12210. #define OP_OpenWrite 105 /* synopsis: root=P2 iDb=P3 */
  12211. #define OP_OpenAutoindex 106 /* synopsis: nColumn=P2 */
  12212. #define OP_OpenEphemeral 107 /* synopsis: nColumn=P2 */
  12213. #define OP_SorterOpen 108
  12214. #define OP_SequenceTest 109 /* synopsis: if( cursor[P1].ctr++ ) pc = P2 */
  12215. #define OP_OpenPseudo 110 /* synopsis: P3 columns in r[P2] */
  12216. #define OP_Close 111
  12217. #define OP_ColumnsUsed 112
  12218. #define OP_Sequence 113 /* synopsis: r[P2]=cursor[P1].ctr++ */
  12219. #define OP_NewRowid 114 /* synopsis: r[P2]=rowid */
  12220. #define OP_Insert 115 /* synopsis: intkey=r[P3] data=r[P2] */
  12221. #define OP_InsertInt 116 /* synopsis: intkey=P3 data=r[P2] */
  12222. #define OP_Delete 117
  12223. #define OP_ResetCount 118
  12224. #define OP_SorterCompare 119 /* synopsis: if key(P1)!=trim(r[P3],P4) goto P2 */
  12225. #define OP_SorterData 120 /* synopsis: r[P2]=data */
  12226. #define OP_RowKey 121 /* synopsis: r[P2]=key */
  12227. #define OP_RowData 122 /* synopsis: r[P2]=data */
  12228. #define OP_Rowid 123 /* synopsis: r[P2]=rowid */
  12229. #define OP_NullRow 124
  12230. #define OP_SorterInsert 125
  12231. #define OP_IdxInsert 126 /* synopsis: key=r[P2] */
  12232. #define OP_IdxDelete 127 /* synopsis: key=r[P2@P3] */
  12233. #define OP_Seek 128 /* synopsis: Move P3 to P1.rowid */
  12234. #define OP_IdxRowid 129 /* synopsis: r[P2]=rowid */
  12235. #define OP_Destroy 130
  12236. #define OP_Clear 131
  12237. #define OP_Real 132 /* same as TK_FLOAT, synopsis: r[P2]=P4 */
  12238. #define OP_ResetSorter 133
  12239. #define OP_CreateIndex 134 /* synopsis: r[P2]=root iDb=P1 */
  12240. #define OP_CreateTable 135 /* synopsis: r[P2]=root iDb=P1 */
  12241. #define OP_ParseSchema 136
  12242. #define OP_LoadAnalysis 137
  12243. #define OP_DropTable 138
  12244. #define OP_DropIndex 139
  12245. #define OP_DropTrigger 140
  12246. #define OP_IntegrityCk 141
  12247. #define OP_RowSetAdd 142 /* synopsis: rowset(P1)=r[P2] */
  12248. #define OP_Param 143
  12249. #define OP_FkCounter 144 /* synopsis: fkctr[P1]+=P2 */
  12250. #define OP_MemMax 145 /* synopsis: r[P1]=max(r[P1],r[P2]) */
  12251. #define OP_OffsetLimit 146 /* synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1) */
  12252. #define OP_AggStep0 147 /* synopsis: accum=r[P3] step(r[P2@P5]) */
  12253. #define OP_AggStep 148 /* synopsis: accum=r[P3] step(r[P2@P5]) */
  12254. #define OP_AggFinal 149 /* synopsis: accum=r[P1] N=P2 */
  12255. #define OP_Expire 150
  12256. #define OP_TableLock 151 /* synopsis: iDb=P1 root=P2 write=P3 */
  12257. #define OP_VBegin 152
  12258. #define OP_VCreate 153
  12259. #define OP_VDestroy 154
  12260. #define OP_VOpen 155
  12261. #define OP_VColumn 156 /* synopsis: r[P3]=vcolumn(P2) */
  12262. #define OP_VRename 157
  12263. #define OP_Pagecount 158
  12264. #define OP_MaxPgcnt 159
  12265. #define OP_CursorHint 160
  12266. #define OP_Noop 161
  12267. #define OP_Explain 162
  12268. /* Properties such as "out2" or "jump" that are specified in
  12269. ** comments following the "case" for each opcode in the vdbe.c
  12270. ** are encoded into bitvectors as follows:
  12271. */
  12272. #define OPFLG_JUMP 0x01 /* jump: P2 holds jmp target */
  12273. #define OPFLG_IN1 0x02 /* in1: P1 is an input */
  12274. #define OPFLG_IN2 0x04 /* in2: P2 is an input */
  12275. #define OPFLG_IN3 0x08 /* in3: P3 is an input */
  12276. #define OPFLG_OUT2 0x10 /* out2: P2 is an output */
  12277. #define OPFLG_OUT3 0x20 /* out3: P3 is an output */
  12278. #define OPFLG_INITIALIZER {\
  12279. /* 0 */ 0x00, 0x00, 0x00, 0x01, 0x01, 0x01, 0x01, 0x01,\
  12280. /* 8 */ 0x00, 0x10, 0x00, 0x01, 0x00, 0x01, 0x01, 0x01,\
  12281. /* 16 */ 0x03, 0x03, 0x01, 0x12, 0x01, 0x03, 0x03, 0x09,\
  12282. /* 24 */ 0x09, 0x09, 0x09, 0x26, 0x26, 0x09, 0x09, 0x09,\
  12283. /* 32 */ 0x09, 0x09, 0x03, 0x03, 0x0b, 0x0b, 0x0b, 0x0b,\
  12284. /* 40 */ 0x0b, 0x0b, 0x01, 0x26, 0x26, 0x26, 0x26, 0x26,\
  12285. /* 48 */ 0x26, 0x26, 0x26, 0x26, 0x26, 0x01, 0x12, 0x01,\
  12286. /* 56 */ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x23, 0x0b,\
  12287. /* 64 */ 0x01, 0x01, 0x03, 0x03, 0x03, 0x01, 0x01, 0x01,\
  12288. /* 72 */ 0x02, 0x02, 0x08, 0x00, 0x10, 0x10, 0x10, 0x10,\
  12289. /* 80 */ 0x00, 0x10, 0x10, 0x00, 0x00, 0x10, 0x10, 0x00,\
  12290. /* 88 */ 0x00, 0x00, 0x00, 0x02, 0x02, 0x02, 0x00, 0x00,\
  12291. /* 96 */ 0x00, 0x10, 0x00, 0x00, 0x10, 0x10, 0x00, 0x00,\
  12292. /* 104 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
  12293. /* 112 */ 0x00, 0x10, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00,\
  12294. /* 120 */ 0x00, 0x00, 0x00, 0x10, 0x00, 0x04, 0x04, 0x00,\
  12295. /* 128 */ 0x00, 0x10, 0x10, 0x00, 0x10, 0x00, 0x10, 0x10,\
  12296. /* 136 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0x10,\
  12297. /* 144 */ 0x00, 0x04, 0x1a, 0x00, 0x00, 0x00, 0x00, 0x00,\
  12298. /* 152 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x10,\
  12299. /* 160 */ 0x00, 0x00, 0x00,}
  12300. /* The sqlite3P2Values() routine is able to run faster if it knows
  12301. ** the value of the largest JUMP opcode. The smaller the maximum
  12302. ** JUMP opcode the better, so the mkopcodeh.tcl script that
  12303. ** generated this include file strives to group all JUMP opcodes
  12304. ** together near the beginning of the list.
  12305. */
  12306. #define SQLITE_MX_JUMP_OPCODE 71 /* Maximum JUMP opcode */
  12307. /************** End of opcodes.h *********************************************/
  12308. /************** Continuing where we left off in vdbe.h ***********************/
  12309. /*
  12310. ** Prototypes for the VDBE interface. See comments on the implementation
  12311. ** for a description of what each of these routines does.
  12312. */
  12313. SQLITE_PRIVATE Vdbe *sqlite3VdbeCreate(Parse*);
  12314. SQLITE_PRIVATE int sqlite3VdbeAddOp0(Vdbe*,int);
  12315. SQLITE_PRIVATE int sqlite3VdbeAddOp1(Vdbe*,int,int);
  12316. SQLITE_PRIVATE int sqlite3VdbeAddOp2(Vdbe*,int,int,int);
  12317. SQLITE_PRIVATE int sqlite3VdbeGoto(Vdbe*,int);
  12318. SQLITE_PRIVATE int sqlite3VdbeLoadString(Vdbe*,int,const char*);
  12319. SQLITE_PRIVATE void sqlite3VdbeMultiLoad(Vdbe*,int,const char*,...);
  12320. SQLITE_PRIVATE int sqlite3VdbeAddOp3(Vdbe*,int,int,int,int);
  12321. SQLITE_PRIVATE int sqlite3VdbeAddOp4(Vdbe*,int,int,int,int,const char *zP4,int);
  12322. SQLITE_PRIVATE int sqlite3VdbeAddOp4Dup8(Vdbe*,int,int,int,int,const u8*,int);
  12323. SQLITE_PRIVATE int sqlite3VdbeAddOp4Int(Vdbe*,int,int,int,int,int);
  12324. SQLITE_PRIVATE void sqlite3VdbeEndCoroutine(Vdbe*,int);
  12325. #if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
  12326. SQLITE_PRIVATE void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N);
  12327. #else
  12328. # define sqlite3VdbeVerifyNoMallocRequired(A,B)
  12329. #endif
  12330. SQLITE_PRIVATE VdbeOp *sqlite3VdbeAddOpList(Vdbe*, int nOp, VdbeOpList const *aOp, int iLineno);
  12331. SQLITE_PRIVATE void sqlite3VdbeAddParseSchemaOp(Vdbe*,int,char*);
  12332. SQLITE_PRIVATE void sqlite3VdbeChangeOpcode(Vdbe*, u32 addr, u8);
  12333. SQLITE_PRIVATE void sqlite3VdbeChangeP1(Vdbe*, u32 addr, int P1);
  12334. SQLITE_PRIVATE void sqlite3VdbeChangeP2(Vdbe*, u32 addr, int P2);
  12335. SQLITE_PRIVATE void sqlite3VdbeChangeP3(Vdbe*, u32 addr, int P3);
  12336. SQLITE_PRIVATE void sqlite3VdbeChangeP5(Vdbe*, u8 P5);
  12337. SQLITE_PRIVATE void sqlite3VdbeJumpHere(Vdbe*, int addr);
  12338. SQLITE_PRIVATE int sqlite3VdbeChangeToNoop(Vdbe*, int addr);
  12339. SQLITE_PRIVATE int sqlite3VdbeDeletePriorOpcode(Vdbe*, u8 op);
  12340. SQLITE_PRIVATE void sqlite3VdbeChangeP4(Vdbe*, int addr, const char *zP4, int N);
  12341. SQLITE_PRIVATE void sqlite3VdbeSetP4KeyInfo(Parse*, Index*);
  12342. SQLITE_PRIVATE void sqlite3VdbeUsesBtree(Vdbe*, int);
  12343. SQLITE_PRIVATE VdbeOp *sqlite3VdbeGetOp(Vdbe*, int);
  12344. SQLITE_PRIVATE int sqlite3VdbeMakeLabel(Vdbe*);
  12345. SQLITE_PRIVATE void sqlite3VdbeRunOnlyOnce(Vdbe*);
  12346. SQLITE_PRIVATE void sqlite3VdbeReusable(Vdbe*);
  12347. SQLITE_PRIVATE void sqlite3VdbeDelete(Vdbe*);
  12348. SQLITE_PRIVATE void sqlite3VdbeClearObject(sqlite3*,Vdbe*);
  12349. SQLITE_PRIVATE void sqlite3VdbeMakeReady(Vdbe*,Parse*);
  12350. SQLITE_PRIVATE int sqlite3VdbeFinalize(Vdbe*);
  12351. SQLITE_PRIVATE void sqlite3VdbeResolveLabel(Vdbe*, int);
  12352. SQLITE_PRIVATE int sqlite3VdbeCurrentAddr(Vdbe*);
  12353. #ifdef SQLITE_DEBUG
  12354. SQLITE_PRIVATE int sqlite3VdbeAssertMayAbort(Vdbe *, int);
  12355. #endif
  12356. SQLITE_PRIVATE void sqlite3VdbeResetStepResult(Vdbe*);
  12357. SQLITE_PRIVATE void sqlite3VdbeRewind(Vdbe*);
  12358. SQLITE_PRIVATE int sqlite3VdbeReset(Vdbe*);
  12359. SQLITE_PRIVATE void sqlite3VdbeSetNumCols(Vdbe*,int);
  12360. SQLITE_PRIVATE int sqlite3VdbeSetColName(Vdbe*, int, int, const char *, void(*)(void*));
  12361. SQLITE_PRIVATE void sqlite3VdbeCountChanges(Vdbe*);
  12362. SQLITE_PRIVATE sqlite3 *sqlite3VdbeDb(Vdbe*);
  12363. SQLITE_PRIVATE void sqlite3VdbeSetSql(Vdbe*, const char *z, int n, int);
  12364. SQLITE_PRIVATE void sqlite3VdbeSwap(Vdbe*,Vdbe*);
  12365. SQLITE_PRIVATE VdbeOp *sqlite3VdbeTakeOpArray(Vdbe*, int*, int*);
  12366. SQLITE_PRIVATE sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe*, int, u8);
  12367. SQLITE_PRIVATE void sqlite3VdbeSetVarmask(Vdbe*, int);
  12368. #ifndef SQLITE_OMIT_TRACE
  12369. SQLITE_PRIVATE char *sqlite3VdbeExpandSql(Vdbe*, const char*);
  12370. #endif
  12371. SQLITE_PRIVATE int sqlite3MemCompare(const Mem*, const Mem*, const CollSeq*);
  12372. SQLITE_PRIVATE void sqlite3VdbeRecordUnpack(KeyInfo*,int,const void*,UnpackedRecord*);
  12373. SQLITE_PRIVATE int sqlite3VdbeRecordCompare(int,const void*,UnpackedRecord*);
  12374. SQLITE_PRIVATE int sqlite3VdbeRecordCompareWithSkip(int, const void *, UnpackedRecord *, int);
  12375. SQLITE_PRIVATE UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(KeyInfo *, char *, int, char **);
  12376. typedef int (*RecordCompare)(int,const void*,UnpackedRecord*);
  12377. SQLITE_PRIVATE RecordCompare sqlite3VdbeFindCompare(UnpackedRecord*);
  12378. #ifndef SQLITE_OMIT_TRIGGER
  12379. SQLITE_PRIVATE void sqlite3VdbeLinkSubProgram(Vdbe *, SubProgram *);
  12380. #endif
  12381. /* Use SQLITE_ENABLE_COMMENTS to enable generation of extra comments on
  12382. ** each VDBE opcode.
  12383. **
  12384. ** Use the SQLITE_ENABLE_MODULE_COMMENTS macro to see some extra no-op
  12385. ** comments in VDBE programs that show key decision points in the code
  12386. ** generator.
  12387. */
  12388. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  12389. SQLITE_PRIVATE void sqlite3VdbeComment(Vdbe*, const char*, ...);
  12390. # define VdbeComment(X) sqlite3VdbeComment X
  12391. SQLITE_PRIVATE void sqlite3VdbeNoopComment(Vdbe*, const char*, ...);
  12392. # define VdbeNoopComment(X) sqlite3VdbeNoopComment X
  12393. # ifdef SQLITE_ENABLE_MODULE_COMMENTS
  12394. # define VdbeModuleComment(X) sqlite3VdbeNoopComment X
  12395. # else
  12396. # define VdbeModuleComment(X)
  12397. # endif
  12398. #else
  12399. # define VdbeComment(X)
  12400. # define VdbeNoopComment(X)
  12401. # define VdbeModuleComment(X)
  12402. #endif
  12403. /*
  12404. ** The VdbeCoverage macros are used to set a coverage testing point
  12405. ** for VDBE branch instructions. The coverage testing points are line
  12406. ** numbers in the sqlite3.c source file. VDBE branch coverage testing
  12407. ** only works with an amalagmation build. That's ok since a VDBE branch
  12408. ** coverage build designed for testing the test suite only. No application
  12409. ** should ever ship with VDBE branch coverage measuring turned on.
  12410. **
  12411. ** VdbeCoverage(v) // Mark the previously coded instruction
  12412. ** // as a branch
  12413. **
  12414. ** VdbeCoverageIf(v, conditional) // Mark previous if conditional true
  12415. **
  12416. ** VdbeCoverageAlwaysTaken(v) // Previous branch is always taken
  12417. **
  12418. ** VdbeCoverageNeverTaken(v) // Previous branch is never taken
  12419. **
  12420. ** Every VDBE branch operation must be tagged with one of the macros above.
  12421. ** If not, then when "make test" is run with -DSQLITE_VDBE_COVERAGE and
  12422. ** -DSQLITE_DEBUG then an ALWAYS() will fail in the vdbeTakeBranch()
  12423. ** routine in vdbe.c, alerting the developer to the missed tag.
  12424. */
  12425. #ifdef SQLITE_VDBE_COVERAGE
  12426. SQLITE_PRIVATE void sqlite3VdbeSetLineNumber(Vdbe*,int);
  12427. # define VdbeCoverage(v) sqlite3VdbeSetLineNumber(v,__LINE__)
  12428. # define VdbeCoverageIf(v,x) if(x)sqlite3VdbeSetLineNumber(v,__LINE__)
  12429. # define VdbeCoverageAlwaysTaken(v) sqlite3VdbeSetLineNumber(v,2);
  12430. # define VdbeCoverageNeverTaken(v) sqlite3VdbeSetLineNumber(v,1);
  12431. # define VDBE_OFFSET_LINENO(x) (__LINE__+x)
  12432. #else
  12433. # define VdbeCoverage(v)
  12434. # define VdbeCoverageIf(v,x)
  12435. # define VdbeCoverageAlwaysTaken(v)
  12436. # define VdbeCoverageNeverTaken(v)
  12437. # define VDBE_OFFSET_LINENO(x) 0
  12438. #endif
  12439. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  12440. SQLITE_PRIVATE void sqlite3VdbeScanStatus(Vdbe*, int, int, int, LogEst, const char*);
  12441. #else
  12442. # define sqlite3VdbeScanStatus(a,b,c,d,e)
  12443. #endif
  12444. #endif /* SQLITE_VDBE_H */
  12445. /************** End of vdbe.h ************************************************/
  12446. /************** Continuing where we left off in sqliteInt.h ******************/
  12447. /************** Include pager.h in the middle of sqliteInt.h *****************/
  12448. /************** Begin file pager.h *******************************************/
  12449. /*
  12450. ** 2001 September 15
  12451. **
  12452. ** The author disclaims copyright to this source code. In place of
  12453. ** a legal notice, here is a blessing:
  12454. **
  12455. ** May you do good and not evil.
  12456. ** May you find forgiveness for yourself and forgive others.
  12457. ** May you share freely, never taking more than you give.
  12458. **
  12459. *************************************************************************
  12460. ** This header file defines the interface that the sqlite page cache
  12461. ** subsystem. The page cache subsystem reads and writes a file a page
  12462. ** at a time and provides a journal for rollback.
  12463. */
  12464. #ifndef SQLITE_PAGER_H
  12465. #define SQLITE_PAGER_H
  12466. /*
  12467. ** Default maximum size for persistent journal files. A negative
  12468. ** value means no limit. This value may be overridden using the
  12469. ** sqlite3PagerJournalSizeLimit() API. See also "PRAGMA journal_size_limit".
  12470. */
  12471. #ifndef SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT
  12472. #define SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT -1
  12473. #endif
  12474. /*
  12475. ** The type used to represent a page number. The first page in a file
  12476. ** is called page 1. 0 is used to represent "not a page".
  12477. */
  12478. typedef u32 Pgno;
  12479. /*
  12480. ** Each open file is managed by a separate instance of the "Pager" structure.
  12481. */
  12482. typedef struct Pager Pager;
  12483. /*
  12484. ** Handle type for pages.
  12485. */
  12486. typedef struct PgHdr DbPage;
  12487. /*
  12488. ** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
  12489. ** reserved for working around a windows/posix incompatibility). It is
  12490. ** used in the journal to signify that the remainder of the journal file
  12491. ** is devoted to storing a master journal name - there are no more pages to
  12492. ** roll back. See comments for function writeMasterJournal() in pager.c
  12493. ** for details.
  12494. */
  12495. #define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
  12496. /*
  12497. ** Allowed values for the flags parameter to sqlite3PagerOpen().
  12498. **
  12499. ** NOTE: These values must match the corresponding BTREE_ values in btree.h.
  12500. */
  12501. #define PAGER_OMIT_JOURNAL 0x0001 /* Do not use a rollback journal */
  12502. #define PAGER_MEMORY 0x0002 /* In-memory database */
  12503. /*
  12504. ** Valid values for the second argument to sqlite3PagerLockingMode().
  12505. */
  12506. #define PAGER_LOCKINGMODE_QUERY -1
  12507. #define PAGER_LOCKINGMODE_NORMAL 0
  12508. #define PAGER_LOCKINGMODE_EXCLUSIVE 1
  12509. /*
  12510. ** Numeric constants that encode the journalmode.
  12511. **
  12512. ** The numeric values encoded here (other than PAGER_JOURNALMODE_QUERY)
  12513. ** are exposed in the API via the "PRAGMA journal_mode" command and
  12514. ** therefore cannot be changed without a compatibility break.
  12515. */
  12516. #define PAGER_JOURNALMODE_QUERY (-1) /* Query the value of journalmode */
  12517. #define PAGER_JOURNALMODE_DELETE 0 /* Commit by deleting journal file */
  12518. #define PAGER_JOURNALMODE_PERSIST 1 /* Commit by zeroing journal header */
  12519. #define PAGER_JOURNALMODE_OFF 2 /* Journal omitted. */
  12520. #define PAGER_JOURNALMODE_TRUNCATE 3 /* Commit by truncating journal */
  12521. #define PAGER_JOURNALMODE_MEMORY 4 /* In-memory journal file */
  12522. #define PAGER_JOURNALMODE_WAL 5 /* Use write-ahead logging */
  12523. /*
  12524. ** Flags that make up the mask passed to sqlite3PagerGet().
  12525. */
  12526. #define PAGER_GET_NOCONTENT 0x01 /* Do not load data from disk */
  12527. #define PAGER_GET_READONLY 0x02 /* Read-only page is acceptable */
  12528. /*
  12529. ** Flags for sqlite3PagerSetFlags()
  12530. **
  12531. ** Value constraints (enforced via assert()):
  12532. ** PAGER_FULLFSYNC == SQLITE_FullFSync
  12533. ** PAGER_CKPT_FULLFSYNC == SQLITE_CkptFullFSync
  12534. ** PAGER_CACHE_SPILL == SQLITE_CacheSpill
  12535. */
  12536. #define PAGER_SYNCHRONOUS_OFF 0x01 /* PRAGMA synchronous=OFF */
  12537. #define PAGER_SYNCHRONOUS_NORMAL 0x02 /* PRAGMA synchronous=NORMAL */
  12538. #define PAGER_SYNCHRONOUS_FULL 0x03 /* PRAGMA synchronous=FULL */
  12539. #define PAGER_SYNCHRONOUS_EXTRA 0x04 /* PRAGMA synchronous=EXTRA */
  12540. #define PAGER_SYNCHRONOUS_MASK 0x07 /* Mask for four values above */
  12541. #define PAGER_FULLFSYNC 0x08 /* PRAGMA fullfsync=ON */
  12542. #define PAGER_CKPT_FULLFSYNC 0x10 /* PRAGMA checkpoint_fullfsync=ON */
  12543. #define PAGER_CACHESPILL 0x20 /* PRAGMA cache_spill=ON */
  12544. #define PAGER_FLAGS_MASK 0x38 /* All above except SYNCHRONOUS */
  12545. /*
  12546. ** The remainder of this file contains the declarations of the functions
  12547. ** that make up the Pager sub-system API. See source code comments for
  12548. ** a detailed description of each routine.
  12549. */
  12550. /* Open and close a Pager connection. */
  12551. SQLITE_PRIVATE int sqlite3PagerOpen(
  12552. sqlite3_vfs*,
  12553. Pager **ppPager,
  12554. const char*,
  12555. int,
  12556. int,
  12557. int,
  12558. void(*)(DbPage*)
  12559. );
  12560. SQLITE_PRIVATE int sqlite3PagerClose(Pager *pPager);
  12561. SQLITE_PRIVATE int sqlite3PagerReadFileheader(Pager*, int, unsigned char*);
  12562. /* Functions used to configure a Pager object. */
  12563. SQLITE_PRIVATE void sqlite3PagerSetBusyhandler(Pager*, int(*)(void *), void *);
  12564. SQLITE_PRIVATE int sqlite3PagerSetPagesize(Pager*, u32*, int);
  12565. #ifdef SQLITE_HAS_CODEC
  12566. SQLITE_PRIVATE void sqlite3PagerAlignReserve(Pager*,Pager*);
  12567. #endif
  12568. SQLITE_PRIVATE int sqlite3PagerMaxPageCount(Pager*, int);
  12569. SQLITE_PRIVATE void sqlite3PagerSetCachesize(Pager*, int);
  12570. SQLITE_PRIVATE int sqlite3PagerSetSpillsize(Pager*, int);
  12571. SQLITE_PRIVATE void sqlite3PagerSetMmapLimit(Pager *, sqlite3_int64);
  12572. SQLITE_PRIVATE void sqlite3PagerShrink(Pager*);
  12573. SQLITE_PRIVATE void sqlite3PagerSetFlags(Pager*,unsigned);
  12574. SQLITE_PRIVATE int sqlite3PagerLockingMode(Pager *, int);
  12575. SQLITE_PRIVATE int sqlite3PagerSetJournalMode(Pager *, int);
  12576. SQLITE_PRIVATE int sqlite3PagerGetJournalMode(Pager*);
  12577. SQLITE_PRIVATE int sqlite3PagerOkToChangeJournalMode(Pager*);
  12578. SQLITE_PRIVATE i64 sqlite3PagerJournalSizeLimit(Pager *, i64);
  12579. SQLITE_PRIVATE sqlite3_backup **sqlite3PagerBackupPtr(Pager*);
  12580. SQLITE_PRIVATE int sqlite3PagerFlush(Pager*);
  12581. /* Functions used to obtain and release page references. */
  12582. SQLITE_PRIVATE int sqlite3PagerGet(Pager *pPager, Pgno pgno, DbPage **ppPage, int clrFlag);
  12583. SQLITE_PRIVATE DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno);
  12584. SQLITE_PRIVATE void sqlite3PagerRef(DbPage*);
  12585. SQLITE_PRIVATE void sqlite3PagerUnref(DbPage*);
  12586. SQLITE_PRIVATE void sqlite3PagerUnrefNotNull(DbPage*);
  12587. /* Operations on page references. */
  12588. SQLITE_PRIVATE int sqlite3PagerWrite(DbPage*);
  12589. SQLITE_PRIVATE void sqlite3PagerDontWrite(DbPage*);
  12590. SQLITE_PRIVATE int sqlite3PagerMovepage(Pager*,DbPage*,Pgno,int);
  12591. SQLITE_PRIVATE int sqlite3PagerPageRefcount(DbPage*);
  12592. SQLITE_PRIVATE void *sqlite3PagerGetData(DbPage *);
  12593. SQLITE_PRIVATE void *sqlite3PagerGetExtra(DbPage *);
  12594. /* Functions used to manage pager transactions and savepoints. */
  12595. SQLITE_PRIVATE void sqlite3PagerPagecount(Pager*, int*);
  12596. SQLITE_PRIVATE int sqlite3PagerBegin(Pager*, int exFlag, int);
  12597. SQLITE_PRIVATE int sqlite3PagerCommitPhaseOne(Pager*,const char *zMaster, int);
  12598. SQLITE_PRIVATE int sqlite3PagerExclusiveLock(Pager*);
  12599. SQLITE_PRIVATE int sqlite3PagerSync(Pager *pPager, const char *zMaster);
  12600. SQLITE_PRIVATE int sqlite3PagerCommitPhaseTwo(Pager*);
  12601. SQLITE_PRIVATE int sqlite3PagerRollback(Pager*);
  12602. SQLITE_PRIVATE int sqlite3PagerOpenSavepoint(Pager *pPager, int n);
  12603. SQLITE_PRIVATE int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint);
  12604. SQLITE_PRIVATE int sqlite3PagerSharedLock(Pager *pPager);
  12605. #ifndef SQLITE_OMIT_WAL
  12606. SQLITE_PRIVATE int sqlite3PagerCheckpoint(Pager *pPager, int, int*, int*);
  12607. SQLITE_PRIVATE int sqlite3PagerWalSupported(Pager *pPager);
  12608. SQLITE_PRIVATE int sqlite3PagerWalCallback(Pager *pPager);
  12609. SQLITE_PRIVATE int sqlite3PagerOpenWal(Pager *pPager, int *pisOpen);
  12610. SQLITE_PRIVATE int sqlite3PagerCloseWal(Pager *pPager);
  12611. SQLITE_PRIVATE int sqlite3PagerUseWal(Pager *pPager);
  12612. # ifdef SQLITE_ENABLE_SNAPSHOT
  12613. SQLITE_PRIVATE int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot);
  12614. SQLITE_PRIVATE int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot);
  12615. # endif
  12616. #else
  12617. # define sqlite3PagerUseWal(x) 0
  12618. #endif
  12619. #ifdef SQLITE_ENABLE_ZIPVFS
  12620. SQLITE_PRIVATE int sqlite3PagerWalFramesize(Pager *pPager);
  12621. #endif
  12622. /* Functions used to query pager state and configuration. */
  12623. SQLITE_PRIVATE u8 sqlite3PagerIsreadonly(Pager*);
  12624. SQLITE_PRIVATE u32 sqlite3PagerDataVersion(Pager*);
  12625. #ifdef SQLITE_DEBUG
  12626. SQLITE_PRIVATE int sqlite3PagerRefcount(Pager*);
  12627. #endif
  12628. SQLITE_PRIVATE int sqlite3PagerMemUsed(Pager*);
  12629. SQLITE_PRIVATE const char *sqlite3PagerFilename(Pager*, int);
  12630. SQLITE_PRIVATE sqlite3_vfs *sqlite3PagerVfs(Pager*);
  12631. SQLITE_PRIVATE sqlite3_file *sqlite3PagerFile(Pager*);
  12632. SQLITE_PRIVATE sqlite3_file *sqlite3PagerJrnlFile(Pager*);
  12633. SQLITE_PRIVATE const char *sqlite3PagerJournalname(Pager*);
  12634. SQLITE_PRIVATE void *sqlite3PagerTempSpace(Pager*);
  12635. SQLITE_PRIVATE int sqlite3PagerIsMemdb(Pager*);
  12636. SQLITE_PRIVATE void sqlite3PagerCacheStat(Pager *, int, int, int *);
  12637. SQLITE_PRIVATE void sqlite3PagerClearCache(Pager*);
  12638. SQLITE_PRIVATE int sqlite3SectorSize(sqlite3_file *);
  12639. /* Functions used to truncate the database file. */
  12640. SQLITE_PRIVATE void sqlite3PagerTruncateImage(Pager*,Pgno);
  12641. SQLITE_PRIVATE void sqlite3PagerRekey(DbPage*, Pgno, u16);
  12642. #if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_WAL)
  12643. SQLITE_PRIVATE void *sqlite3PagerCodec(DbPage *);
  12644. #endif
  12645. /* Functions to support testing and debugging. */
  12646. #if !defined(NDEBUG) || defined(SQLITE_TEST)
  12647. SQLITE_PRIVATE Pgno sqlite3PagerPagenumber(DbPage*);
  12648. SQLITE_PRIVATE int sqlite3PagerIswriteable(DbPage*);
  12649. #endif
  12650. #ifdef SQLITE_TEST
  12651. SQLITE_PRIVATE int *sqlite3PagerStats(Pager*);
  12652. SQLITE_PRIVATE void sqlite3PagerRefdump(Pager*);
  12653. void disable_simulated_io_errors(void);
  12654. void enable_simulated_io_errors(void);
  12655. #else
  12656. # define disable_simulated_io_errors()
  12657. # define enable_simulated_io_errors()
  12658. #endif
  12659. #endif /* SQLITE_PAGER_H */
  12660. /************** End of pager.h ***********************************************/
  12661. /************** Continuing where we left off in sqliteInt.h ******************/
  12662. /************** Include pcache.h in the middle of sqliteInt.h ****************/
  12663. /************** Begin file pcache.h ******************************************/
  12664. /*
  12665. ** 2008 August 05
  12666. **
  12667. ** The author disclaims copyright to this source code. In place of
  12668. ** a legal notice, here is a blessing:
  12669. **
  12670. ** May you do good and not evil.
  12671. ** May you find forgiveness for yourself and forgive others.
  12672. ** May you share freely, never taking more than you give.
  12673. **
  12674. *************************************************************************
  12675. ** This header file defines the interface that the sqlite page cache
  12676. ** subsystem.
  12677. */
  12678. #ifndef _PCACHE_H_
  12679. typedef struct PgHdr PgHdr;
  12680. typedef struct PCache PCache;
  12681. /*
  12682. ** Every page in the cache is controlled by an instance of the following
  12683. ** structure.
  12684. */
  12685. struct PgHdr {
  12686. sqlite3_pcache_page *pPage; /* Pcache object page handle */
  12687. void *pData; /* Page data */
  12688. void *pExtra; /* Extra content */
  12689. PgHdr *pDirty; /* Transient list of dirty sorted by pgno */
  12690. Pager *pPager; /* The pager this page is part of */
  12691. Pgno pgno; /* Page number for this page */
  12692. #ifdef SQLITE_CHECK_PAGES
  12693. u32 pageHash; /* Hash of page content */
  12694. #endif
  12695. u16 flags; /* PGHDR flags defined below */
  12696. /**********************************************************************
  12697. ** Elements above are public. All that follows is private to pcache.c
  12698. ** and should not be accessed by other modules.
  12699. */
  12700. i16 nRef; /* Number of users of this page */
  12701. PCache *pCache; /* Cache that owns this page */
  12702. PgHdr *pDirtyNext; /* Next element in list of dirty pages */
  12703. PgHdr *pDirtyPrev; /* Previous element in list of dirty pages */
  12704. };
  12705. /* Bit values for PgHdr.flags */
  12706. #define PGHDR_CLEAN 0x001 /* Page not on the PCache.pDirty list */
  12707. #define PGHDR_DIRTY 0x002 /* Page is on the PCache.pDirty list */
  12708. #define PGHDR_WRITEABLE 0x004 /* Journaled and ready to modify */
  12709. #define PGHDR_NEED_SYNC 0x008 /* Fsync the rollback journal before
  12710. ** writing this page to the database */
  12711. #define PGHDR_DONT_WRITE 0x010 /* Do not write content to disk */
  12712. #define PGHDR_MMAP 0x020 /* This is an mmap page object */
  12713. #define PGHDR_WAL_APPEND 0x040 /* Appended to wal file */
  12714. /* Initialize and shutdown the page cache subsystem */
  12715. SQLITE_PRIVATE int sqlite3PcacheInitialize(void);
  12716. SQLITE_PRIVATE void sqlite3PcacheShutdown(void);
  12717. /* Page cache buffer management:
  12718. ** These routines implement SQLITE_CONFIG_PAGECACHE.
  12719. */
  12720. SQLITE_PRIVATE void sqlite3PCacheBufferSetup(void *, int sz, int n);
  12721. /* Create a new pager cache.
  12722. ** Under memory stress, invoke xStress to try to make pages clean.
  12723. ** Only clean and unpinned pages can be reclaimed.
  12724. */
  12725. SQLITE_PRIVATE int sqlite3PcacheOpen(
  12726. int szPage, /* Size of every page */
  12727. int szExtra, /* Extra space associated with each page */
  12728. int bPurgeable, /* True if pages are on backing store */
  12729. int (*xStress)(void*, PgHdr*), /* Call to try to make pages clean */
  12730. void *pStress, /* Argument to xStress */
  12731. PCache *pToInit /* Preallocated space for the PCache */
  12732. );
  12733. /* Modify the page-size after the cache has been created. */
  12734. SQLITE_PRIVATE int sqlite3PcacheSetPageSize(PCache *, int);
  12735. /* Return the size in bytes of a PCache object. Used to preallocate
  12736. ** storage space.
  12737. */
  12738. SQLITE_PRIVATE int sqlite3PcacheSize(void);
  12739. /* One release per successful fetch. Page is pinned until released.
  12740. ** Reference counted.
  12741. */
  12742. SQLITE_PRIVATE sqlite3_pcache_page *sqlite3PcacheFetch(PCache*, Pgno, int createFlag);
  12743. SQLITE_PRIVATE int sqlite3PcacheFetchStress(PCache*, Pgno, sqlite3_pcache_page**);
  12744. SQLITE_PRIVATE PgHdr *sqlite3PcacheFetchFinish(PCache*, Pgno, sqlite3_pcache_page *pPage);
  12745. SQLITE_PRIVATE void sqlite3PcacheRelease(PgHdr*);
  12746. SQLITE_PRIVATE void sqlite3PcacheDrop(PgHdr*); /* Remove page from cache */
  12747. SQLITE_PRIVATE void sqlite3PcacheMakeDirty(PgHdr*); /* Make sure page is marked dirty */
  12748. SQLITE_PRIVATE void sqlite3PcacheMakeClean(PgHdr*); /* Mark a single page as clean */
  12749. SQLITE_PRIVATE void sqlite3PcacheCleanAll(PCache*); /* Mark all dirty list pages as clean */
  12750. SQLITE_PRIVATE void sqlite3PcacheClearWritable(PCache*);
  12751. /* Change a page number. Used by incr-vacuum. */
  12752. SQLITE_PRIVATE void sqlite3PcacheMove(PgHdr*, Pgno);
  12753. /* Remove all pages with pgno>x. Reset the cache if x==0 */
  12754. SQLITE_PRIVATE void sqlite3PcacheTruncate(PCache*, Pgno x);
  12755. /* Get a list of all dirty pages in the cache, sorted by page number */
  12756. SQLITE_PRIVATE PgHdr *sqlite3PcacheDirtyList(PCache*);
  12757. /* Reset and close the cache object */
  12758. SQLITE_PRIVATE void sqlite3PcacheClose(PCache*);
  12759. /* Clear flags from pages of the page cache */
  12760. SQLITE_PRIVATE void sqlite3PcacheClearSyncFlags(PCache *);
  12761. /* Discard the contents of the cache */
  12762. SQLITE_PRIVATE void sqlite3PcacheClear(PCache*);
  12763. /* Return the total number of outstanding page references */
  12764. SQLITE_PRIVATE int sqlite3PcacheRefCount(PCache*);
  12765. /* Increment the reference count of an existing page */
  12766. SQLITE_PRIVATE void sqlite3PcacheRef(PgHdr*);
  12767. SQLITE_PRIVATE int sqlite3PcachePageRefcount(PgHdr*);
  12768. /* Return the total number of pages stored in the cache */
  12769. SQLITE_PRIVATE int sqlite3PcachePagecount(PCache*);
  12770. #if defined(SQLITE_CHECK_PAGES) || defined(SQLITE_DEBUG)
  12771. /* Iterate through all dirty pages currently stored in the cache. This
  12772. ** interface is only available if SQLITE_CHECK_PAGES is defined when the
  12773. ** library is built.
  12774. */
  12775. SQLITE_PRIVATE void sqlite3PcacheIterateDirty(PCache *pCache, void (*xIter)(PgHdr *));
  12776. #endif
  12777. #if defined(SQLITE_DEBUG)
  12778. /* Check invariants on a PgHdr object */
  12779. SQLITE_PRIVATE int sqlite3PcachePageSanity(PgHdr*);
  12780. #endif
  12781. /* Set and get the suggested cache-size for the specified pager-cache.
  12782. **
  12783. ** If no global maximum is configured, then the system attempts to limit
  12784. ** the total number of pages cached by purgeable pager-caches to the sum
  12785. ** of the suggested cache-sizes.
  12786. */
  12787. SQLITE_PRIVATE void sqlite3PcacheSetCachesize(PCache *, int);
  12788. #ifdef SQLITE_TEST
  12789. SQLITE_PRIVATE int sqlite3PcacheGetCachesize(PCache *);
  12790. #endif
  12791. /* Set or get the suggested spill-size for the specified pager-cache.
  12792. **
  12793. ** The spill-size is the minimum number of pages in cache before the cache
  12794. ** will attempt to spill dirty pages by calling xStress.
  12795. */
  12796. SQLITE_PRIVATE int sqlite3PcacheSetSpillsize(PCache *, int);
  12797. /* Free up as much memory as possible from the page cache */
  12798. SQLITE_PRIVATE void sqlite3PcacheShrink(PCache*);
  12799. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  12800. /* Try to return memory used by the pcache module to the main memory heap */
  12801. SQLITE_PRIVATE int sqlite3PcacheReleaseMemory(int);
  12802. #endif
  12803. #ifdef SQLITE_TEST
  12804. SQLITE_PRIVATE void sqlite3PcacheStats(int*,int*,int*,int*);
  12805. #endif
  12806. SQLITE_PRIVATE void sqlite3PCacheSetDefault(void);
  12807. /* Return the header size */
  12808. SQLITE_PRIVATE int sqlite3HeaderSizePcache(void);
  12809. SQLITE_PRIVATE int sqlite3HeaderSizePcache1(void);
  12810. /* Number of dirty pages as a percentage of the configured cache size */
  12811. SQLITE_PRIVATE int sqlite3PCachePercentDirty(PCache*);
  12812. #endif /* _PCACHE_H_ */
  12813. /************** End of pcache.h **********************************************/
  12814. /************** Continuing where we left off in sqliteInt.h ******************/
  12815. /************** Include os.h in the middle of sqliteInt.h ********************/
  12816. /************** Begin file os.h **********************************************/
  12817. /*
  12818. ** 2001 September 16
  12819. **
  12820. ** The author disclaims copyright to this source code. In place of
  12821. ** a legal notice, here is a blessing:
  12822. **
  12823. ** May you do good and not evil.
  12824. ** May you find forgiveness for yourself and forgive others.
  12825. ** May you share freely, never taking more than you give.
  12826. **
  12827. ******************************************************************************
  12828. **
  12829. ** This header file (together with is companion C source-code file
  12830. ** "os.c") attempt to abstract the underlying operating system so that
  12831. ** the SQLite library will work on both POSIX and windows systems.
  12832. **
  12833. ** This header file is #include-ed by sqliteInt.h and thus ends up
  12834. ** being included by every source file.
  12835. */
  12836. #ifndef _SQLITE_OS_H_
  12837. #define _SQLITE_OS_H_
  12838. /*
  12839. ** Attempt to automatically detect the operating system and setup the
  12840. ** necessary pre-processor macros for it.
  12841. */
  12842. /************** Include os_setup.h in the middle of os.h *********************/
  12843. /************** Begin file os_setup.h ****************************************/
  12844. /*
  12845. ** 2013 November 25
  12846. **
  12847. ** The author disclaims copyright to this source code. In place of
  12848. ** a legal notice, here is a blessing:
  12849. **
  12850. ** May you do good and not evil.
  12851. ** May you find forgiveness for yourself and forgive others.
  12852. ** May you share freely, never taking more than you give.
  12853. **
  12854. ******************************************************************************
  12855. **
  12856. ** This file contains pre-processor directives related to operating system
  12857. ** detection and/or setup.
  12858. */
  12859. #ifndef SQLITE_OS_SETUP_H
  12860. #define SQLITE_OS_SETUP_H
  12861. /*
  12862. ** Figure out if we are dealing with Unix, Windows, or some other operating
  12863. ** system.
  12864. **
  12865. ** After the following block of preprocess macros, all of SQLITE_OS_UNIX,
  12866. ** SQLITE_OS_WIN, and SQLITE_OS_OTHER will defined to either 1 or 0. One of
  12867. ** the three will be 1. The other two will be 0.
  12868. */
  12869. #if defined(SQLITE_OS_OTHER)
  12870. # if SQLITE_OS_OTHER==1
  12871. # undef SQLITE_OS_UNIX
  12872. # define SQLITE_OS_UNIX 0
  12873. # undef SQLITE_OS_WIN
  12874. # define SQLITE_OS_WIN 0
  12875. # else
  12876. # undef SQLITE_OS_OTHER
  12877. # endif
  12878. #endif
  12879. #if !defined(SQLITE_OS_UNIX) && !defined(SQLITE_OS_OTHER)
  12880. # define SQLITE_OS_OTHER 0
  12881. # ifndef SQLITE_OS_WIN
  12882. # if defined(_WIN32) || defined(WIN32) || defined(__CYGWIN__) || \
  12883. defined(__MINGW32__) || defined(__BORLANDC__)
  12884. # define SQLITE_OS_WIN 1
  12885. # define SQLITE_OS_UNIX 0
  12886. # else
  12887. # define SQLITE_OS_WIN 0
  12888. # define SQLITE_OS_UNIX 1
  12889. # endif
  12890. # else
  12891. # define SQLITE_OS_UNIX 0
  12892. # endif
  12893. #else
  12894. # ifndef SQLITE_OS_WIN
  12895. # define SQLITE_OS_WIN 0
  12896. # endif
  12897. #endif
  12898. #endif /* SQLITE_OS_SETUP_H */
  12899. /************** End of os_setup.h ********************************************/
  12900. /************** Continuing where we left off in os.h *************************/
  12901. /* If the SET_FULLSYNC macro is not defined above, then make it
  12902. ** a no-op
  12903. */
  12904. #ifndef SET_FULLSYNC
  12905. # define SET_FULLSYNC(x,y)
  12906. #endif
  12907. /*
  12908. ** The default size of a disk sector
  12909. */
  12910. #ifndef SQLITE_DEFAULT_SECTOR_SIZE
  12911. # define SQLITE_DEFAULT_SECTOR_SIZE 4096
  12912. #endif
  12913. /*
  12914. ** Temporary files are named starting with this prefix followed by 16 random
  12915. ** alphanumeric characters, and no file extension. They are stored in the
  12916. ** OS's standard temporary file directory, and are deleted prior to exit.
  12917. ** If sqlite is being embedded in another program, you may wish to change the
  12918. ** prefix to reflect your program's name, so that if your program exits
  12919. ** prematurely, old temporary files can be easily identified. This can be done
  12920. ** using -DSQLITE_TEMP_FILE_PREFIX=myprefix_ on the compiler command line.
  12921. **
  12922. ** 2006-10-31: The default prefix used to be "sqlite_". But then
  12923. ** Mcafee started using SQLite in their anti-virus product and it
  12924. ** started putting files with the "sqlite" name in the c:/temp folder.
  12925. ** This annoyed many windows users. Those users would then do a
  12926. ** Google search for "sqlite", find the telephone numbers of the
  12927. ** developers and call to wake them up at night and complain.
  12928. ** For this reason, the default name prefix is changed to be "sqlite"
  12929. ** spelled backwards. So the temp files are still identified, but
  12930. ** anybody smart enough to figure out the code is also likely smart
  12931. ** enough to know that calling the developer will not help get rid
  12932. ** of the file.
  12933. */
  12934. #ifndef SQLITE_TEMP_FILE_PREFIX
  12935. # define SQLITE_TEMP_FILE_PREFIX "etilqs_"
  12936. #endif
  12937. /*
  12938. ** The following values may be passed as the second argument to
  12939. ** sqlite3OsLock(). The various locks exhibit the following semantics:
  12940. **
  12941. ** SHARED: Any number of processes may hold a SHARED lock simultaneously.
  12942. ** RESERVED: A single process may hold a RESERVED lock on a file at
  12943. ** any time. Other processes may hold and obtain new SHARED locks.
  12944. ** PENDING: A single process may hold a PENDING lock on a file at
  12945. ** any one time. Existing SHARED locks may persist, but no new
  12946. ** SHARED locks may be obtained by other processes.
  12947. ** EXCLUSIVE: An EXCLUSIVE lock precludes all other locks.
  12948. **
  12949. ** PENDING_LOCK may not be passed directly to sqlite3OsLock(). Instead, a
  12950. ** process that requests an EXCLUSIVE lock may actually obtain a PENDING
  12951. ** lock. This can be upgraded to an EXCLUSIVE lock by a subsequent call to
  12952. ** sqlite3OsLock().
  12953. */
  12954. #define NO_LOCK 0
  12955. #define SHARED_LOCK 1
  12956. #define RESERVED_LOCK 2
  12957. #define PENDING_LOCK 3
  12958. #define EXCLUSIVE_LOCK 4
  12959. /*
  12960. ** File Locking Notes: (Mostly about windows but also some info for Unix)
  12961. **
  12962. ** We cannot use LockFileEx() or UnlockFileEx() on Win95/98/ME because
  12963. ** those functions are not available. So we use only LockFile() and
  12964. ** UnlockFile().
  12965. **
  12966. ** LockFile() prevents not just writing but also reading by other processes.
  12967. ** A SHARED_LOCK is obtained by locking a single randomly-chosen
  12968. ** byte out of a specific range of bytes. The lock byte is obtained at
  12969. ** random so two separate readers can probably access the file at the
  12970. ** same time, unless they are unlucky and choose the same lock byte.
  12971. ** An EXCLUSIVE_LOCK is obtained by locking all bytes in the range.
  12972. ** There can only be one writer. A RESERVED_LOCK is obtained by locking
  12973. ** a single byte of the file that is designated as the reserved lock byte.
  12974. ** A PENDING_LOCK is obtained by locking a designated byte different from
  12975. ** the RESERVED_LOCK byte.
  12976. **
  12977. ** On WinNT/2K/XP systems, LockFileEx() and UnlockFileEx() are available,
  12978. ** which means we can use reader/writer locks. When reader/writer locks
  12979. ** are used, the lock is placed on the same range of bytes that is used
  12980. ** for probabilistic locking in Win95/98/ME. Hence, the locking scheme
  12981. ** will support two or more Win95 readers or two or more WinNT readers.
  12982. ** But a single Win95 reader will lock out all WinNT readers and a single
  12983. ** WinNT reader will lock out all other Win95 readers.
  12984. **
  12985. ** The following #defines specify the range of bytes used for locking.
  12986. ** SHARED_SIZE is the number of bytes available in the pool from which
  12987. ** a random byte is selected for a shared lock. The pool of bytes for
  12988. ** shared locks begins at SHARED_FIRST.
  12989. **
  12990. ** The same locking strategy and
  12991. ** byte ranges are used for Unix. This leaves open the possibility of having
  12992. ** clients on win95, winNT, and unix all talking to the same shared file
  12993. ** and all locking correctly. To do so would require that samba (or whatever
  12994. ** tool is being used for file sharing) implements locks correctly between
  12995. ** windows and unix. I'm guessing that isn't likely to happen, but by
  12996. ** using the same locking range we are at least open to the possibility.
  12997. **
  12998. ** Locking in windows is manditory. For this reason, we cannot store
  12999. ** actual data in the bytes used for locking. The pager never allocates
  13000. ** the pages involved in locking therefore. SHARED_SIZE is selected so
  13001. ** that all locks will fit on a single page even at the minimum page size.
  13002. ** PENDING_BYTE defines the beginning of the locks. By default PENDING_BYTE
  13003. ** is set high so that we don't have to allocate an unused page except
  13004. ** for very large databases. But one should test the page skipping logic
  13005. ** by setting PENDING_BYTE low and running the entire regression suite.
  13006. **
  13007. ** Changing the value of PENDING_BYTE results in a subtly incompatible
  13008. ** file format. Depending on how it is changed, you might not notice
  13009. ** the incompatibility right away, even running a full regression test.
  13010. ** The default location of PENDING_BYTE is the first byte past the
  13011. ** 1GB boundary.
  13012. **
  13013. */
  13014. #ifdef SQLITE_OMIT_WSD
  13015. # define PENDING_BYTE (0x40000000)
  13016. #else
  13017. # define PENDING_BYTE sqlite3PendingByte
  13018. #endif
  13019. #define RESERVED_BYTE (PENDING_BYTE+1)
  13020. #define SHARED_FIRST (PENDING_BYTE+2)
  13021. #define SHARED_SIZE 510
  13022. /*
  13023. ** Wrapper around OS specific sqlite3_os_init() function.
  13024. */
  13025. SQLITE_PRIVATE int sqlite3OsInit(void);
  13026. /*
  13027. ** Functions for accessing sqlite3_file methods
  13028. */
  13029. SQLITE_PRIVATE void sqlite3OsClose(sqlite3_file*);
  13030. SQLITE_PRIVATE int sqlite3OsRead(sqlite3_file*, void*, int amt, i64 offset);
  13031. SQLITE_PRIVATE int sqlite3OsWrite(sqlite3_file*, const void*, int amt, i64 offset);
  13032. SQLITE_PRIVATE int sqlite3OsTruncate(sqlite3_file*, i64 size);
  13033. SQLITE_PRIVATE int sqlite3OsSync(sqlite3_file*, int);
  13034. SQLITE_PRIVATE int sqlite3OsFileSize(sqlite3_file*, i64 *pSize);
  13035. SQLITE_PRIVATE int sqlite3OsLock(sqlite3_file*, int);
  13036. SQLITE_PRIVATE int sqlite3OsUnlock(sqlite3_file*, int);
  13037. SQLITE_PRIVATE int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut);
  13038. SQLITE_PRIVATE int sqlite3OsFileControl(sqlite3_file*,int,void*);
  13039. SQLITE_PRIVATE void sqlite3OsFileControlHint(sqlite3_file*,int,void*);
  13040. #define SQLITE_FCNTL_DB_UNCHANGED 0xca093fa0
  13041. SQLITE_PRIVATE int sqlite3OsSectorSize(sqlite3_file *id);
  13042. SQLITE_PRIVATE int sqlite3OsDeviceCharacteristics(sqlite3_file *id);
  13043. SQLITE_PRIVATE int sqlite3OsShmMap(sqlite3_file *,int,int,int,void volatile **);
  13044. SQLITE_PRIVATE int sqlite3OsShmLock(sqlite3_file *id, int, int, int);
  13045. SQLITE_PRIVATE void sqlite3OsShmBarrier(sqlite3_file *id);
  13046. SQLITE_PRIVATE int sqlite3OsShmUnmap(sqlite3_file *id, int);
  13047. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64, int, void **);
  13048. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *, i64, void *);
  13049. /*
  13050. ** Functions for accessing sqlite3_vfs methods
  13051. */
  13052. SQLITE_PRIVATE int sqlite3OsOpen(sqlite3_vfs *, const char *, sqlite3_file*, int, int *);
  13053. SQLITE_PRIVATE int sqlite3OsDelete(sqlite3_vfs *, const char *, int);
  13054. SQLITE_PRIVATE int sqlite3OsAccess(sqlite3_vfs *, const char *, int, int *pResOut);
  13055. SQLITE_PRIVATE int sqlite3OsFullPathname(sqlite3_vfs *, const char *, int, char *);
  13056. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  13057. SQLITE_PRIVATE void *sqlite3OsDlOpen(sqlite3_vfs *, const char *);
  13058. SQLITE_PRIVATE void sqlite3OsDlError(sqlite3_vfs *, int, char *);
  13059. SQLITE_PRIVATE void (*sqlite3OsDlSym(sqlite3_vfs *, void *, const char *))(void);
  13060. SQLITE_PRIVATE void sqlite3OsDlClose(sqlite3_vfs *, void *);
  13061. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  13062. SQLITE_PRIVATE int sqlite3OsRandomness(sqlite3_vfs *, int, char *);
  13063. SQLITE_PRIVATE int sqlite3OsSleep(sqlite3_vfs *, int);
  13064. SQLITE_PRIVATE int sqlite3OsGetLastError(sqlite3_vfs*);
  13065. SQLITE_PRIVATE int sqlite3OsCurrentTimeInt64(sqlite3_vfs *, sqlite3_int64*);
  13066. /*
  13067. ** Convenience functions for opening and closing files using
  13068. ** sqlite3_malloc() to obtain space for the file-handle structure.
  13069. */
  13070. SQLITE_PRIVATE int sqlite3OsOpenMalloc(sqlite3_vfs *, const char *, sqlite3_file **, int,int*);
  13071. SQLITE_PRIVATE void sqlite3OsCloseFree(sqlite3_file *);
  13072. #endif /* _SQLITE_OS_H_ */
  13073. /************** End of os.h **************************************************/
  13074. /************** Continuing where we left off in sqliteInt.h ******************/
  13075. /************** Include mutex.h in the middle of sqliteInt.h *****************/
  13076. /************** Begin file mutex.h *******************************************/
  13077. /*
  13078. ** 2007 August 28
  13079. **
  13080. ** The author disclaims copyright to this source code. In place of
  13081. ** a legal notice, here is a blessing:
  13082. **
  13083. ** May you do good and not evil.
  13084. ** May you find forgiveness for yourself and forgive others.
  13085. ** May you share freely, never taking more than you give.
  13086. **
  13087. *************************************************************************
  13088. **
  13089. ** This file contains the common header for all mutex implementations.
  13090. ** The sqliteInt.h header #includes this file so that it is available
  13091. ** to all source files. We break it out in an effort to keep the code
  13092. ** better organized.
  13093. **
  13094. ** NOTE: source files should *not* #include this header file directly.
  13095. ** Source files should #include the sqliteInt.h file and let that file
  13096. ** include this one indirectly.
  13097. */
  13098. /*
  13099. ** Figure out what version of the code to use. The choices are
  13100. **
  13101. ** SQLITE_MUTEX_OMIT No mutex logic. Not even stubs. The
  13102. ** mutexes implementation cannot be overridden
  13103. ** at start-time.
  13104. **
  13105. ** SQLITE_MUTEX_NOOP For single-threaded applications. No
  13106. ** mutual exclusion is provided. But this
  13107. ** implementation can be overridden at
  13108. ** start-time.
  13109. **
  13110. ** SQLITE_MUTEX_PTHREADS For multi-threaded applications on Unix.
  13111. **
  13112. ** SQLITE_MUTEX_W32 For multi-threaded applications on Win32.
  13113. */
  13114. #if !SQLITE_THREADSAFE
  13115. # define SQLITE_MUTEX_OMIT
  13116. #endif
  13117. #if SQLITE_THREADSAFE && !defined(SQLITE_MUTEX_NOOP)
  13118. # if SQLITE_OS_UNIX
  13119. # define SQLITE_MUTEX_PTHREADS
  13120. # elif SQLITE_OS_WIN
  13121. # define SQLITE_MUTEX_W32
  13122. # else
  13123. # define SQLITE_MUTEX_NOOP
  13124. # endif
  13125. #endif
  13126. #ifdef SQLITE_MUTEX_OMIT
  13127. /*
  13128. ** If this is a no-op implementation, implement everything as macros.
  13129. */
  13130. #define sqlite3_mutex_alloc(X) ((sqlite3_mutex*)8)
  13131. #define sqlite3_mutex_free(X)
  13132. #define sqlite3_mutex_enter(X)
  13133. #define sqlite3_mutex_try(X) SQLITE_OK
  13134. #define sqlite3_mutex_leave(X)
  13135. #define sqlite3_mutex_held(X) ((void)(X),1)
  13136. #define sqlite3_mutex_notheld(X) ((void)(X),1)
  13137. #define sqlite3MutexAlloc(X) ((sqlite3_mutex*)8)
  13138. #define sqlite3MutexInit() SQLITE_OK
  13139. #define sqlite3MutexEnd()
  13140. #define MUTEX_LOGIC(X)
  13141. #else
  13142. #define MUTEX_LOGIC(X) X
  13143. #endif /* defined(SQLITE_MUTEX_OMIT) */
  13144. /************** End of mutex.h ***********************************************/
  13145. /************** Continuing where we left off in sqliteInt.h ******************/
  13146. /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
  13147. ** synchronous setting to EXTRA. It is no longer supported.
  13148. */
  13149. #ifdef SQLITE_EXTRA_DURABLE
  13150. # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
  13151. # define SQLITE_DEFAULT_SYNCHRONOUS 3
  13152. #endif
  13153. /*
  13154. ** Default synchronous levels.
  13155. **
  13156. ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
  13157. ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
  13158. **
  13159. ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS
  13160. ** OFF 1 0
  13161. ** NORMAL 2 1
  13162. ** FULL 3 2
  13163. ** EXTRA 4 3
  13164. **
  13165. ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
  13166. ** In other words, the zero-based numbers are used for all external interfaces
  13167. ** and the one-based values are used internally.
  13168. */
  13169. #ifndef SQLITE_DEFAULT_SYNCHRONOUS
  13170. # define SQLITE_DEFAULT_SYNCHRONOUS (PAGER_SYNCHRONOUS_FULL-1)
  13171. #endif
  13172. #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
  13173. # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
  13174. #endif
  13175. /*
  13176. ** Each database file to be accessed by the system is an instance
  13177. ** of the following structure. There are normally two of these structures
  13178. ** in the sqlite.aDb[] array. aDb[0] is the main database file and
  13179. ** aDb[1] is the database file used to hold temporary tables. Additional
  13180. ** databases may be attached.
  13181. */
  13182. struct Db {
  13183. char *zDbSName; /* Name of this database. (schema name, not filename) */
  13184. Btree *pBt; /* The B*Tree structure for this database file */
  13185. u8 safety_level; /* How aggressive at syncing data to disk */
  13186. u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */
  13187. Schema *pSchema; /* Pointer to database schema (possibly shared) */
  13188. };
  13189. /*
  13190. ** An instance of the following structure stores a database schema.
  13191. **
  13192. ** Most Schema objects are associated with a Btree. The exception is
  13193. ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
  13194. ** In shared cache mode, a single Schema object can be shared by multiple
  13195. ** Btrees that refer to the same underlying BtShared object.
  13196. **
  13197. ** Schema objects are automatically deallocated when the last Btree that
  13198. ** references them is destroyed. The TEMP Schema is manually freed by
  13199. ** sqlite3_close().
  13200. *
  13201. ** A thread must be holding a mutex on the corresponding Btree in order
  13202. ** to access Schema content. This implies that the thread must also be
  13203. ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
  13204. ** For a TEMP Schema, only the connection mutex is required.
  13205. */
  13206. struct Schema {
  13207. int schema_cookie; /* Database schema version number for this file */
  13208. int iGeneration; /* Generation counter. Incremented with each change */
  13209. Hash tblHash; /* All tables indexed by name */
  13210. Hash idxHash; /* All (named) indices indexed by name */
  13211. Hash trigHash; /* All triggers indexed by name */
  13212. Hash fkeyHash; /* All foreign keys by referenced table name */
  13213. Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
  13214. u8 file_format; /* Schema format version for this file */
  13215. u8 enc; /* Text encoding used by this database */
  13216. u16 schemaFlags; /* Flags associated with this schema */
  13217. int cache_size; /* Number of pages to use in the cache */
  13218. };
  13219. /*
  13220. ** These macros can be used to test, set, or clear bits in the
  13221. ** Db.pSchema->flags field.
  13222. */
  13223. #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
  13224. #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
  13225. #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P)
  13226. #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P)
  13227. /*
  13228. ** Allowed values for the DB.pSchema->flags field.
  13229. **
  13230. ** The DB_SchemaLoaded flag is set after the database schema has been
  13231. ** read into internal hash tables.
  13232. **
  13233. ** DB_UnresetViews means that one or more views have column names that
  13234. ** have been filled out. If the schema changes, these column names might
  13235. ** changes and so the view will need to be reset.
  13236. */
  13237. #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
  13238. #define DB_UnresetViews 0x0002 /* Some views have defined column names */
  13239. #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
  13240. /*
  13241. ** The number of different kinds of things that can be limited
  13242. ** using the sqlite3_limit() interface.
  13243. */
  13244. #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
  13245. /*
  13246. ** Lookaside malloc is a set of fixed-size buffers that can be used
  13247. ** to satisfy small transient memory allocation requests for objects
  13248. ** associated with a particular database connection. The use of
  13249. ** lookaside malloc provides a significant performance enhancement
  13250. ** (approx 10%) by avoiding numerous malloc/free requests while parsing
  13251. ** SQL statements.
  13252. **
  13253. ** The Lookaside structure holds configuration information about the
  13254. ** lookaside malloc subsystem. Each available memory allocation in
  13255. ** the lookaside subsystem is stored on a linked list of LookasideSlot
  13256. ** objects.
  13257. **
  13258. ** Lookaside allocations are only allowed for objects that are associated
  13259. ** with a particular database connection. Hence, schema information cannot
  13260. ** be stored in lookaside because in shared cache mode the schema information
  13261. ** is shared by multiple database connections. Therefore, while parsing
  13262. ** schema information, the Lookaside.bEnabled flag is cleared so that
  13263. ** lookaside allocations are not used to construct the schema objects.
  13264. */
  13265. struct Lookaside {
  13266. u32 bDisable; /* Only operate the lookaside when zero */
  13267. u16 sz; /* Size of each buffer in bytes */
  13268. u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
  13269. int nOut; /* Number of buffers currently checked out */
  13270. int mxOut; /* Highwater mark for nOut */
  13271. int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */
  13272. LookasideSlot *pFree; /* List of available buffers */
  13273. void *pStart; /* First byte of available memory space */
  13274. void *pEnd; /* First byte past end of available space */
  13275. };
  13276. struct LookasideSlot {
  13277. LookasideSlot *pNext; /* Next buffer in the list of free buffers */
  13278. };
  13279. /*
  13280. ** A hash table for built-in function definitions. (Application-defined
  13281. ** functions use a regular table table from hash.h.)
  13282. **
  13283. ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
  13284. ** Collisions are on the FuncDef.u.pHash chain.
  13285. */
  13286. #define SQLITE_FUNC_HASH_SZ 23
  13287. struct FuncDefHash {
  13288. FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */
  13289. };
  13290. #ifdef SQLITE_USER_AUTHENTICATION
  13291. /*
  13292. ** Information held in the "sqlite3" database connection object and used
  13293. ** to manage user authentication.
  13294. */
  13295. typedef struct sqlite3_userauth sqlite3_userauth;
  13296. struct sqlite3_userauth {
  13297. u8 authLevel; /* Current authentication level */
  13298. int nAuthPW; /* Size of the zAuthPW in bytes */
  13299. char *zAuthPW; /* Password used to authenticate */
  13300. char *zAuthUser; /* User name used to authenticate */
  13301. };
  13302. /* Allowed values for sqlite3_userauth.authLevel */
  13303. #define UAUTH_Unknown 0 /* Authentication not yet checked */
  13304. #define UAUTH_Fail 1 /* User authentication failed */
  13305. #define UAUTH_User 2 /* Authenticated as a normal user */
  13306. #define UAUTH_Admin 3 /* Authenticated as an administrator */
  13307. /* Functions used only by user authorization logic */
  13308. SQLITE_PRIVATE int sqlite3UserAuthTable(const char*);
  13309. SQLITE_PRIVATE int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
  13310. SQLITE_PRIVATE void sqlite3UserAuthInit(sqlite3*);
  13311. SQLITE_PRIVATE void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
  13312. #endif /* SQLITE_USER_AUTHENTICATION */
  13313. /*
  13314. ** typedef for the authorization callback function.
  13315. */
  13316. #ifdef SQLITE_USER_AUTHENTICATION
  13317. typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
  13318. const char*, const char*);
  13319. #else
  13320. typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
  13321. const char*);
  13322. #endif
  13323. #ifndef SQLITE_OMIT_DEPRECATED
  13324. /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing
  13325. ** in the style of sqlite3_trace()
  13326. */
  13327. #define SQLITE_TRACE_LEGACY 0x80
  13328. #else
  13329. #define SQLITE_TRACE_LEGACY 0
  13330. #endif /* SQLITE_OMIT_DEPRECATED */
  13331. /*
  13332. ** Each database connection is an instance of the following structure.
  13333. */
  13334. struct sqlite3 {
  13335. sqlite3_vfs *pVfs; /* OS Interface */
  13336. struct Vdbe *pVdbe; /* List of active virtual machines */
  13337. CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
  13338. sqlite3_mutex *mutex; /* Connection mutex */
  13339. Db *aDb; /* All backends */
  13340. int nDb; /* Number of backends currently in use */
  13341. int flags; /* Miscellaneous flags. See below */
  13342. i64 lastRowid; /* ROWID of most recent insert (see above) */
  13343. i64 szMmap; /* Default mmap_size setting */
  13344. unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
  13345. int errCode; /* Most recent error code (SQLITE_*) */
  13346. int errMask; /* & result codes with this before returning */
  13347. int iSysErrno; /* Errno value from last system error */
  13348. u16 dbOptFlags; /* Flags to enable/disable optimizations */
  13349. u8 enc; /* Text encoding */
  13350. u8 autoCommit; /* The auto-commit flag. */
  13351. u8 temp_store; /* 1: file 2: memory 0: default */
  13352. u8 mallocFailed; /* True if we have seen a malloc failure */
  13353. u8 bBenignMalloc; /* Do not require OOMs if true */
  13354. u8 dfltLockMode; /* Default locking-mode for attached dbs */
  13355. signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
  13356. u8 suppressErr; /* Do not issue error messages if true */
  13357. u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */
  13358. u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
  13359. u8 mTrace; /* zero or more SQLITE_TRACE flags */
  13360. int nextPagesize; /* Pagesize after VACUUM if >0 */
  13361. u32 magic; /* Magic number for detect library misuse */
  13362. int nChange; /* Value returned by sqlite3_changes() */
  13363. int nTotalChange; /* Value returned by sqlite3_total_changes() */
  13364. int aLimit[SQLITE_N_LIMIT]; /* Limits */
  13365. int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */
  13366. struct sqlite3InitInfo { /* Information used during initialization */
  13367. int newTnum; /* Rootpage of table being initialized */
  13368. u8 iDb; /* Which db file is being initialized */
  13369. u8 busy; /* TRUE if currently initializing */
  13370. u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */
  13371. u8 imposterTable; /* Building an imposter table */
  13372. } init;
  13373. int nVdbeActive; /* Number of VDBEs currently running */
  13374. int nVdbeRead; /* Number of active VDBEs that read or write */
  13375. int nVdbeWrite; /* Number of active VDBEs that read and write */
  13376. int nVdbeExec; /* Number of nested calls to VdbeExec() */
  13377. int nVDestroy; /* Number of active OP_VDestroy operations */
  13378. int nExtension; /* Number of loaded extensions */
  13379. void **aExtension; /* Array of shared library handles */
  13380. int (*xTrace)(u32,void*,void*,void*); /* Trace function */
  13381. void *pTraceArg; /* Argument to the trace function */
  13382. void (*xProfile)(void*,const char*,u64); /* Profiling function */
  13383. void *pProfileArg; /* Argument to profile function */
  13384. void *pCommitArg; /* Argument to xCommitCallback() */
  13385. int (*xCommitCallback)(void*); /* Invoked at every commit. */
  13386. void *pRollbackArg; /* Argument to xRollbackCallback() */
  13387. void (*xRollbackCallback)(void*); /* Invoked at every commit. */
  13388. void *pUpdateArg;
  13389. void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
  13390. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  13391. void *pPreUpdateArg; /* First argument to xPreUpdateCallback */
  13392. void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */
  13393. void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
  13394. );
  13395. PreUpdate *pPreUpdate; /* Context for active pre-update callback */
  13396. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  13397. #ifndef SQLITE_OMIT_WAL
  13398. int (*xWalCallback)(void *, sqlite3 *, const char *, int);
  13399. void *pWalArg;
  13400. #endif
  13401. void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
  13402. void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
  13403. void *pCollNeededArg;
  13404. sqlite3_value *pErr; /* Most recent error message */
  13405. union {
  13406. volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
  13407. double notUsed1; /* Spacer */
  13408. } u1;
  13409. Lookaside lookaside; /* Lookaside malloc configuration */
  13410. #ifndef SQLITE_OMIT_AUTHORIZATION
  13411. sqlite3_xauth xAuth; /* Access authorization function */
  13412. void *pAuthArg; /* 1st argument to the access auth function */
  13413. #endif
  13414. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  13415. int (*xProgress)(void *); /* The progress callback */
  13416. void *pProgressArg; /* Argument to the progress callback */
  13417. unsigned nProgressOps; /* Number of opcodes for progress callback */
  13418. #endif
  13419. #ifndef SQLITE_OMIT_VIRTUALTABLE
  13420. int nVTrans; /* Allocated size of aVTrans */
  13421. Hash aModule; /* populated by sqlite3_create_module() */
  13422. VtabCtx *pVtabCtx; /* Context for active vtab connect/create */
  13423. VTable **aVTrans; /* Virtual tables with open transactions */
  13424. VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */
  13425. #endif
  13426. Hash aFunc; /* Hash table of connection functions */
  13427. Hash aCollSeq; /* All collating sequences */
  13428. BusyHandler busyHandler; /* Busy callback */
  13429. Db aDbStatic[2]; /* Static space for the 2 default backends */
  13430. Savepoint *pSavepoint; /* List of active savepoints */
  13431. int busyTimeout; /* Busy handler timeout, in msec */
  13432. int nSavepoint; /* Number of non-transaction savepoints */
  13433. int nStatement; /* Number of nested statement-transactions */
  13434. i64 nDeferredCons; /* Net deferred constraints this transaction. */
  13435. i64 nDeferredImmCons; /* Net deferred immediate constraints */
  13436. int *pnBytesFreed; /* If not NULL, increment this in DbFree() */
  13437. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  13438. /* The following variables are all protected by the STATIC_MASTER
  13439. ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
  13440. **
  13441. ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
  13442. ** unlock so that it can proceed.
  13443. **
  13444. ** When X.pBlockingConnection==Y, that means that something that X tried
  13445. ** tried to do recently failed with an SQLITE_LOCKED error due to locks
  13446. ** held by Y.
  13447. */
  13448. sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
  13449. sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
  13450. void *pUnlockArg; /* Argument to xUnlockNotify */
  13451. void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
  13452. sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
  13453. #endif
  13454. #ifdef SQLITE_USER_AUTHENTICATION
  13455. sqlite3_userauth auth; /* User authentication information */
  13456. #endif
  13457. };
  13458. /*
  13459. ** A macro to discover the encoding of a database.
  13460. */
  13461. #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
  13462. #define ENC(db) ((db)->enc)
  13463. /*
  13464. ** Possible values for the sqlite3.flags.
  13465. **
  13466. ** Value constraints (enforced via assert()):
  13467. ** SQLITE_FullFSync == PAGER_FULLFSYNC
  13468. ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
  13469. ** SQLITE_CacheSpill == PAGER_CACHE_SPILL
  13470. */
  13471. #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
  13472. #define SQLITE_InternChanges 0x00000002 /* Uncommitted Hash table changes */
  13473. #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */
  13474. #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */
  13475. #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */
  13476. #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */
  13477. #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
  13478. #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
  13479. /* DELETE, or UPDATE and return */
  13480. /* the count using a callback. */
  13481. #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
  13482. /* result set is empty */
  13483. #define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
  13484. #define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
  13485. #define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
  13486. #define SQLITE_VdbeAddopTrace 0x00001000 /* Trace sqlite3VdbeAddOp() calls */
  13487. #define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
  13488. #define SQLITE_ReadUncommitted 0x0004000 /* For shared-cache mode */
  13489. #define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
  13490. #define SQLITE_RecoveryMode 0x00010000 /* Ignore schema errors */
  13491. #define SQLITE_ReverseOrder 0x00020000 /* Reverse unordered SELECTs */
  13492. #define SQLITE_RecTriggers 0x00040000 /* Enable recursive triggers */
  13493. #define SQLITE_ForeignKeys 0x00080000 /* Enforce foreign key constraints */
  13494. #define SQLITE_AutoIndex 0x00100000 /* Enable automatic indexes */
  13495. #define SQLITE_PreferBuiltin 0x00200000 /* Preference to built-in funcs */
  13496. #define SQLITE_LoadExtension 0x00400000 /* Enable load_extension */
  13497. #define SQLITE_LoadExtFunc 0x00800000 /* Enable load_extension() SQL func */
  13498. #define SQLITE_EnableTrigger 0x01000000 /* True to enable triggers */
  13499. #define SQLITE_DeferFKs 0x02000000 /* Defer all FK constraints */
  13500. #define SQLITE_QueryOnly 0x04000000 /* Disable database changes */
  13501. #define SQLITE_VdbeEQP 0x08000000 /* Debug EXPLAIN QUERY PLAN */
  13502. #define SQLITE_Vacuum 0x10000000 /* Currently in a VACUUM */
  13503. #define SQLITE_CellSizeCk 0x20000000 /* Check btree cell sizes on load */
  13504. #define SQLITE_Fts3Tokenizer 0x40000000 /* Enable fts3_tokenizer(2) */
  13505. /*
  13506. ** Bits of the sqlite3.dbOptFlags field that are used by the
  13507. ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
  13508. ** selectively disable various optimizations.
  13509. */
  13510. #define SQLITE_QueryFlattener 0x0001 /* Query flattening */
  13511. #define SQLITE_ColumnCache 0x0002 /* Column cache */
  13512. #define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */
  13513. #define SQLITE_FactorOutConst 0x0008 /* Constant factoring */
  13514. /* not used 0x0010 // Was: SQLITE_IdxRealAsInt */
  13515. #define SQLITE_DistinctOpt 0x0020 /* DISTINCT using indexes */
  13516. #define SQLITE_CoverIdxScan 0x0040 /* Covering index scans */
  13517. #define SQLITE_OrderByIdxJoin 0x0080 /* ORDER BY of joins via index */
  13518. #define SQLITE_SubqCoroutine 0x0100 /* Evaluate subqueries as coroutines */
  13519. #define SQLITE_Transitive 0x0200 /* Transitive constraints */
  13520. #define SQLITE_OmitNoopJoin 0x0400 /* Omit unused tables in joins */
  13521. #define SQLITE_Stat34 0x0800 /* Use STAT3 or STAT4 data */
  13522. #define SQLITE_CursorHints 0x2000 /* Add OP_CursorHint opcodes */
  13523. #define SQLITE_AllOpts 0xffff /* All optimizations */
  13524. /*
  13525. ** Macros for testing whether or not optimizations are enabled or disabled.
  13526. */
  13527. #ifndef SQLITE_OMIT_BUILTIN_TEST
  13528. #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0)
  13529. #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0)
  13530. #else
  13531. #define OptimizationDisabled(db, mask) 0
  13532. #define OptimizationEnabled(db, mask) 1
  13533. #endif
  13534. /*
  13535. ** Return true if it OK to factor constant expressions into the initialization
  13536. ** code. The argument is a Parse object for the code generator.
  13537. */
  13538. #define ConstFactorOk(P) ((P)->okConstFactor)
  13539. /*
  13540. ** Possible values for the sqlite.magic field.
  13541. ** The numbers are obtained at random and have no special meaning, other
  13542. ** than being distinct from one another.
  13543. */
  13544. #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
  13545. #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
  13546. #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
  13547. #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
  13548. #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
  13549. #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */
  13550. /*
  13551. ** Each SQL function is defined by an instance of the following
  13552. ** structure. For global built-in functions (ex: substr(), max(), count())
  13553. ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
  13554. ** For per-connection application-defined functions, a pointer to this
  13555. ** structure is held in the db->aHash hash table.
  13556. **
  13557. ** The u.pHash field is used by the global built-ins. The u.pDestructor
  13558. ** field is used by per-connection app-def functions.
  13559. */
  13560. struct FuncDef {
  13561. i8 nArg; /* Number of arguments. -1 means unlimited */
  13562. u16 funcFlags; /* Some combination of SQLITE_FUNC_* */
  13563. void *pUserData; /* User data parameter */
  13564. FuncDef *pNext; /* Next function with same name */
  13565. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
  13566. void (*xFinalize)(sqlite3_context*); /* Agg finalizer */
  13567. const char *zName; /* SQL name of the function. */
  13568. union {
  13569. FuncDef *pHash; /* Next with a different name but the same hash */
  13570. FuncDestructor *pDestructor; /* Reference counted destructor function */
  13571. } u;
  13572. };
  13573. /*
  13574. ** This structure encapsulates a user-function destructor callback (as
  13575. ** configured using create_function_v2()) and a reference counter. When
  13576. ** create_function_v2() is called to create a function with a destructor,
  13577. ** a single object of this type is allocated. FuncDestructor.nRef is set to
  13578. ** the number of FuncDef objects created (either 1 or 3, depending on whether
  13579. ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
  13580. ** member of each of the new FuncDef objects is set to point to the allocated
  13581. ** FuncDestructor.
  13582. **
  13583. ** Thereafter, when one of the FuncDef objects is deleted, the reference
  13584. ** count on this object is decremented. When it reaches 0, the destructor
  13585. ** is invoked and the FuncDestructor structure freed.
  13586. */
  13587. struct FuncDestructor {
  13588. int nRef;
  13589. void (*xDestroy)(void *);
  13590. void *pUserData;
  13591. };
  13592. /*
  13593. ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF
  13594. ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And
  13595. ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There
  13596. ** are assert() statements in the code to verify this.
  13597. **
  13598. ** Value constraints (enforced via assert()):
  13599. ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg
  13600. ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG
  13601. ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG
  13602. ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API
  13603. ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API
  13604. */
  13605. #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
  13606. #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */
  13607. #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */
  13608. #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */
  13609. #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
  13610. #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */
  13611. #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */
  13612. #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */
  13613. #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */
  13614. #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
  13615. #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
  13616. #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */
  13617. #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a
  13618. ** single query - might change over time */
  13619. /*
  13620. ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
  13621. ** used to create the initializers for the FuncDef structures.
  13622. **
  13623. ** FUNCTION(zName, nArg, iArg, bNC, xFunc)
  13624. ** Used to create a scalar function definition of a function zName
  13625. ** implemented by C function xFunc that accepts nArg arguments. The
  13626. ** value passed as iArg is cast to a (void*) and made available
  13627. ** as the user-data (sqlite3_user_data()) for the function. If
  13628. ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
  13629. **
  13630. ** VFUNCTION(zName, nArg, iArg, bNC, xFunc)
  13631. ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
  13632. **
  13633. ** DFUNCTION(zName, nArg, iArg, bNC, xFunc)
  13634. ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
  13635. ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions
  13636. ** and functions like sqlite_version() that can change, but not during
  13637. ** a single query.
  13638. **
  13639. ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
  13640. ** Used to create an aggregate function definition implemented by
  13641. ** the C functions xStep and xFinal. The first four parameters
  13642. ** are interpreted in the same way as the first 4 parameters to
  13643. ** FUNCTION().
  13644. **
  13645. ** LIKEFUNC(zName, nArg, pArg, flags)
  13646. ** Used to create a scalar function definition of a function zName
  13647. ** that accepts nArg arguments and is implemented by a call to C
  13648. ** function likeFunc. Argument pArg is cast to a (void *) and made
  13649. ** available as the function user-data (sqlite3_user_data()). The
  13650. ** FuncDef.flags variable is set to the value passed as the flags
  13651. ** parameter.
  13652. */
  13653. #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
  13654. {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  13655. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  13656. #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
  13657. {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  13658. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  13659. #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
  13660. {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  13661. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  13662. #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
  13663. {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
  13664. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  13665. #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
  13666. {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  13667. pArg, 0, xFunc, 0, #zName, }
  13668. #define LIKEFUNC(zName, nArg, arg, flags) \
  13669. {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
  13670. (void *)arg, 0, likeFunc, 0, #zName, {0} }
  13671. #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
  13672. {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
  13673. SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
  13674. #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
  13675. {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
  13676. SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
  13677. /*
  13678. ** All current savepoints are stored in a linked list starting at
  13679. ** sqlite3.pSavepoint. The first element in the list is the most recently
  13680. ** opened savepoint. Savepoints are added to the list by the vdbe
  13681. ** OP_Savepoint instruction.
  13682. */
  13683. struct Savepoint {
  13684. char *zName; /* Savepoint name (nul-terminated) */
  13685. i64 nDeferredCons; /* Number of deferred fk violations */
  13686. i64 nDeferredImmCons; /* Number of deferred imm fk. */
  13687. Savepoint *pNext; /* Parent savepoint (if any) */
  13688. };
  13689. /*
  13690. ** The following are used as the second parameter to sqlite3Savepoint(),
  13691. ** and as the P1 argument to the OP_Savepoint instruction.
  13692. */
  13693. #define SAVEPOINT_BEGIN 0
  13694. #define SAVEPOINT_RELEASE 1
  13695. #define SAVEPOINT_ROLLBACK 2
  13696. /*
  13697. ** Each SQLite module (virtual table definition) is defined by an
  13698. ** instance of the following structure, stored in the sqlite3.aModule
  13699. ** hash table.
  13700. */
  13701. struct Module {
  13702. const sqlite3_module *pModule; /* Callback pointers */
  13703. const char *zName; /* Name passed to create_module() */
  13704. void *pAux; /* pAux passed to create_module() */
  13705. void (*xDestroy)(void *); /* Module destructor function */
  13706. Table *pEpoTab; /* Eponymous table for this module */
  13707. };
  13708. /*
  13709. ** information about each column of an SQL table is held in an instance
  13710. ** of this structure.
  13711. */
  13712. struct Column {
  13713. char *zName; /* Name of this column, \000, then the type */
  13714. Expr *pDflt; /* Default value of this column */
  13715. char *zColl; /* Collating sequence. If NULL, use the default */
  13716. u8 notNull; /* An OE_ code for handling a NOT NULL constraint */
  13717. char affinity; /* One of the SQLITE_AFF_... values */
  13718. u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */
  13719. u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */
  13720. };
  13721. /* Allowed values for Column.colFlags:
  13722. */
  13723. #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */
  13724. #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */
  13725. #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */
  13726. /*
  13727. ** A "Collating Sequence" is defined by an instance of the following
  13728. ** structure. Conceptually, a collating sequence consists of a name and
  13729. ** a comparison routine that defines the order of that sequence.
  13730. **
  13731. ** If CollSeq.xCmp is NULL, it means that the
  13732. ** collating sequence is undefined. Indices built on an undefined
  13733. ** collating sequence may not be read or written.
  13734. */
  13735. struct CollSeq {
  13736. char *zName; /* Name of the collating sequence, UTF-8 encoded */
  13737. u8 enc; /* Text encoding handled by xCmp() */
  13738. void *pUser; /* First argument to xCmp() */
  13739. int (*xCmp)(void*,int, const void*, int, const void*);
  13740. void (*xDel)(void*); /* Destructor for pUser */
  13741. };
  13742. /*
  13743. ** A sort order can be either ASC or DESC.
  13744. */
  13745. #define SQLITE_SO_ASC 0 /* Sort in ascending order */
  13746. #define SQLITE_SO_DESC 1 /* Sort in ascending order */
  13747. #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
  13748. /*
  13749. ** Column affinity types.
  13750. **
  13751. ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
  13752. ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
  13753. ** the speed a little by numbering the values consecutively.
  13754. **
  13755. ** But rather than start with 0 or 1, we begin with 'A'. That way,
  13756. ** when multiple affinity types are concatenated into a string and
  13757. ** used as the P4 operand, they will be more readable.
  13758. **
  13759. ** Note also that the numeric types are grouped together so that testing
  13760. ** for a numeric type is a single comparison. And the BLOB type is first.
  13761. */
  13762. #define SQLITE_AFF_BLOB 'A'
  13763. #define SQLITE_AFF_TEXT 'B'
  13764. #define SQLITE_AFF_NUMERIC 'C'
  13765. #define SQLITE_AFF_INTEGER 'D'
  13766. #define SQLITE_AFF_REAL 'E'
  13767. #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
  13768. /*
  13769. ** The SQLITE_AFF_MASK values masks off the significant bits of an
  13770. ** affinity value.
  13771. */
  13772. #define SQLITE_AFF_MASK 0x47
  13773. /*
  13774. ** Additional bit values that can be ORed with an affinity without
  13775. ** changing the affinity.
  13776. **
  13777. ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
  13778. ** It causes an assert() to fire if either operand to a comparison
  13779. ** operator is NULL. It is added to certain comparison operators to
  13780. ** prove that the operands are always NOT NULL.
  13781. */
  13782. #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */
  13783. #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */
  13784. #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */
  13785. #define SQLITE_NULLEQ 0x80 /* NULL=NULL */
  13786. #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */
  13787. /*
  13788. ** An object of this type is created for each virtual table present in
  13789. ** the database schema.
  13790. **
  13791. ** If the database schema is shared, then there is one instance of this
  13792. ** structure for each database connection (sqlite3*) that uses the shared
  13793. ** schema. This is because each database connection requires its own unique
  13794. ** instance of the sqlite3_vtab* handle used to access the virtual table
  13795. ** implementation. sqlite3_vtab* handles can not be shared between
  13796. ** database connections, even when the rest of the in-memory database
  13797. ** schema is shared, as the implementation often stores the database
  13798. ** connection handle passed to it via the xConnect() or xCreate() method
  13799. ** during initialization internally. This database connection handle may
  13800. ** then be used by the virtual table implementation to access real tables
  13801. ** within the database. So that they appear as part of the callers
  13802. ** transaction, these accesses need to be made via the same database
  13803. ** connection as that used to execute SQL operations on the virtual table.
  13804. **
  13805. ** All VTable objects that correspond to a single table in a shared
  13806. ** database schema are initially stored in a linked-list pointed to by
  13807. ** the Table.pVTable member variable of the corresponding Table object.
  13808. ** When an sqlite3_prepare() operation is required to access the virtual
  13809. ** table, it searches the list for the VTable that corresponds to the
  13810. ** database connection doing the preparing so as to use the correct
  13811. ** sqlite3_vtab* handle in the compiled query.
  13812. **
  13813. ** When an in-memory Table object is deleted (for example when the
  13814. ** schema is being reloaded for some reason), the VTable objects are not
  13815. ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
  13816. ** immediately. Instead, they are moved from the Table.pVTable list to
  13817. ** another linked list headed by the sqlite3.pDisconnect member of the
  13818. ** corresponding sqlite3 structure. They are then deleted/xDisconnected
  13819. ** next time a statement is prepared using said sqlite3*. This is done
  13820. ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
  13821. ** Refer to comments above function sqlite3VtabUnlockList() for an
  13822. ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
  13823. ** list without holding the corresponding sqlite3.mutex mutex.
  13824. **
  13825. ** The memory for objects of this type is always allocated by
  13826. ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
  13827. ** the first argument.
  13828. */
  13829. struct VTable {
  13830. sqlite3 *db; /* Database connection associated with this table */
  13831. Module *pMod; /* Pointer to module implementation */
  13832. sqlite3_vtab *pVtab; /* Pointer to vtab instance */
  13833. int nRef; /* Number of pointers to this structure */
  13834. u8 bConstraint; /* True if constraints are supported */
  13835. int iSavepoint; /* Depth of the SAVEPOINT stack */
  13836. VTable *pNext; /* Next in linked list (see above) */
  13837. };
  13838. /*
  13839. ** The schema for each SQL table and view is represented in memory
  13840. ** by an instance of the following structure.
  13841. */
  13842. struct Table {
  13843. char *zName; /* Name of the table or view */
  13844. Column *aCol; /* Information about each column */
  13845. Index *pIndex; /* List of SQL indexes on this table. */
  13846. Select *pSelect; /* NULL for tables. Points to definition if a view. */
  13847. FKey *pFKey; /* Linked list of all foreign keys in this table */
  13848. char *zColAff; /* String defining the affinity of each column */
  13849. ExprList *pCheck; /* All CHECK constraints */
  13850. /* ... also used as column name list in a VIEW */
  13851. int tnum; /* Root BTree page for this table */
  13852. i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */
  13853. i16 nCol; /* Number of columns in this table */
  13854. u16 nRef; /* Number of pointers to this Table */
  13855. LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */
  13856. LogEst szTabRow; /* Estimated size of each table row in bytes */
  13857. #ifdef SQLITE_ENABLE_COSTMULT
  13858. LogEst costMult; /* Cost multiplier for using this table */
  13859. #endif
  13860. u8 tabFlags; /* Mask of TF_* values */
  13861. u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
  13862. #ifndef SQLITE_OMIT_ALTERTABLE
  13863. int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
  13864. #endif
  13865. #ifndef SQLITE_OMIT_VIRTUALTABLE
  13866. int nModuleArg; /* Number of arguments to the module */
  13867. char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */
  13868. VTable *pVTable; /* List of VTable objects. */
  13869. #endif
  13870. Trigger *pTrigger; /* List of triggers stored in pSchema */
  13871. Schema *pSchema; /* Schema that contains this table */
  13872. Table *pNextZombie; /* Next on the Parse.pZombieTab list */
  13873. };
  13874. /*
  13875. ** Allowed values for Table.tabFlags.
  13876. **
  13877. ** TF_OOOHidden applies to tables or view that have hidden columns that are
  13878. ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING
  13879. ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden,
  13880. ** the TF_OOOHidden attribute would apply in this case. Such tables require
  13881. ** special handling during INSERT processing.
  13882. */
  13883. #define TF_Readonly 0x01 /* Read-only system table */
  13884. #define TF_Ephemeral 0x02 /* An ephemeral table */
  13885. #define TF_HasPrimaryKey 0x04 /* Table has a primary key */
  13886. #define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */
  13887. #define TF_Virtual 0x10 /* Is a virtual table */
  13888. #define TF_WithoutRowid 0x20 /* No rowid. PRIMARY KEY is the key */
  13889. #define TF_NoVisibleRowid 0x40 /* No user-visible "rowid" column */
  13890. #define TF_OOOHidden 0x80 /* Out-of-Order hidden columns */
  13891. /*
  13892. ** Test to see whether or not a table is a virtual table. This is
  13893. ** done as a macro so that it will be optimized out when virtual
  13894. ** table support is omitted from the build.
  13895. */
  13896. #ifndef SQLITE_OMIT_VIRTUALTABLE
  13897. # define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0)
  13898. #else
  13899. # define IsVirtual(X) 0
  13900. #endif
  13901. /*
  13902. ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn()
  13903. ** only works for non-virtual tables (ordinary tables and views) and is
  13904. ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The
  13905. ** IsHiddenColumn() macro is general purpose.
  13906. */
  13907. #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
  13908. # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  13909. # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  13910. #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
  13911. # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  13912. # define IsOrdinaryHiddenColumn(X) 0
  13913. #else
  13914. # define IsHiddenColumn(X) 0
  13915. # define IsOrdinaryHiddenColumn(X) 0
  13916. #endif
  13917. /* Does the table have a rowid */
  13918. #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0)
  13919. #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
  13920. /*
  13921. ** Each foreign key constraint is an instance of the following structure.
  13922. **
  13923. ** A foreign key is associated with two tables. The "from" table is
  13924. ** the table that contains the REFERENCES clause that creates the foreign
  13925. ** key. The "to" table is the table that is named in the REFERENCES clause.
  13926. ** Consider this example:
  13927. **
  13928. ** CREATE TABLE ex1(
  13929. ** a INTEGER PRIMARY KEY,
  13930. ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
  13931. ** );
  13932. **
  13933. ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
  13934. ** Equivalent names:
  13935. **
  13936. ** from-table == child-table
  13937. ** to-table == parent-table
  13938. **
  13939. ** Each REFERENCES clause generates an instance of the following structure
  13940. ** which is attached to the from-table. The to-table need not exist when
  13941. ** the from-table is created. The existence of the to-table is not checked.
  13942. **
  13943. ** The list of all parents for child Table X is held at X.pFKey.
  13944. **
  13945. ** A list of all children for a table named Z (which might not even exist)
  13946. ** is held in Schema.fkeyHash with a hash key of Z.
  13947. */
  13948. struct FKey {
  13949. Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */
  13950. FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */
  13951. char *zTo; /* Name of table that the key points to (aka: Parent) */
  13952. FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */
  13953. FKey *pPrevTo; /* Previous with the same zTo */
  13954. int nCol; /* Number of columns in this key */
  13955. /* EV: R-30323-21917 */
  13956. u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
  13957. u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */
  13958. Trigger *apTrigger[2];/* Triggers for aAction[] actions */
  13959. struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
  13960. int iFrom; /* Index of column in pFrom */
  13961. char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */
  13962. } aCol[1]; /* One entry for each of nCol columns */
  13963. };
  13964. /*
  13965. ** SQLite supports many different ways to resolve a constraint
  13966. ** error. ROLLBACK processing means that a constraint violation
  13967. ** causes the operation in process to fail and for the current transaction
  13968. ** to be rolled back. ABORT processing means the operation in process
  13969. ** fails and any prior changes from that one operation are backed out,
  13970. ** but the transaction is not rolled back. FAIL processing means that
  13971. ** the operation in progress stops and returns an error code. But prior
  13972. ** changes due to the same operation are not backed out and no rollback
  13973. ** occurs. IGNORE means that the particular row that caused the constraint
  13974. ** error is not inserted or updated. Processing continues and no error
  13975. ** is returned. REPLACE means that preexisting database rows that caused
  13976. ** a UNIQUE constraint violation are removed so that the new insert or
  13977. ** update can proceed. Processing continues and no error is reported.
  13978. **
  13979. ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
  13980. ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
  13981. ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
  13982. ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
  13983. ** referenced table row is propagated into the row that holds the
  13984. ** foreign key.
  13985. **
  13986. ** The following symbolic values are used to record which type
  13987. ** of action to take.
  13988. */
  13989. #define OE_None 0 /* There is no constraint to check */
  13990. #define OE_Rollback 1 /* Fail the operation and rollback the transaction */
  13991. #define OE_Abort 2 /* Back out changes but do no rollback transaction */
  13992. #define OE_Fail 3 /* Stop the operation but leave all prior changes */
  13993. #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
  13994. #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
  13995. #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
  13996. #define OE_SetNull 7 /* Set the foreign key value to NULL */
  13997. #define OE_SetDflt 8 /* Set the foreign key value to its default */
  13998. #define OE_Cascade 9 /* Cascade the changes */
  13999. #define OE_Default 10 /* Do whatever the default action is */
  14000. /*
  14001. ** An instance of the following structure is passed as the first
  14002. ** argument to sqlite3VdbeKeyCompare and is used to control the
  14003. ** comparison of the two index keys.
  14004. **
  14005. ** Note that aSortOrder[] and aColl[] have nField+1 slots. There
  14006. ** are nField slots for the columns of an index then one extra slot
  14007. ** for the rowid at the end.
  14008. */
  14009. struct KeyInfo {
  14010. u32 nRef; /* Number of references to this KeyInfo object */
  14011. u8 enc; /* Text encoding - one of the SQLITE_UTF* values */
  14012. u16 nField; /* Number of key columns in the index */
  14013. u16 nXField; /* Number of columns beyond the key columns */
  14014. sqlite3 *db; /* The database connection */
  14015. u8 *aSortOrder; /* Sort order for each column. */
  14016. CollSeq *aColl[1]; /* Collating sequence for each term of the key */
  14017. };
  14018. /*
  14019. ** This object holds a record which has been parsed out into individual
  14020. ** fields, for the purposes of doing a comparison.
  14021. **
  14022. ** A record is an object that contains one or more fields of data.
  14023. ** Records are used to store the content of a table row and to store
  14024. ** the key of an index. A blob encoding of a record is created by
  14025. ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
  14026. ** OP_Column opcode.
  14027. **
  14028. ** An instance of this object serves as a "key" for doing a search on
  14029. ** an index b+tree. The goal of the search is to find the entry that
  14030. ** is closed to the key described by this object. This object might hold
  14031. ** just a prefix of the key. The number of fields is given by
  14032. ** pKeyInfo->nField.
  14033. **
  14034. ** The r1 and r2 fields are the values to return if this key is less than
  14035. ** or greater than a key in the btree, respectively. These are normally
  14036. ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
  14037. ** is in DESC order.
  14038. **
  14039. ** The key comparison functions actually return default_rc when they find
  14040. ** an equals comparison. default_rc can be -1, 0, or +1. If there are
  14041. ** multiple entries in the b-tree with the same key (when only looking
  14042. ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
  14043. ** cause the search to find the last match, or +1 to cause the search to
  14044. ** find the first match.
  14045. **
  14046. ** The key comparison functions will set eqSeen to true if they ever
  14047. ** get and equal results when comparing this structure to a b-tree record.
  14048. ** When default_rc!=0, the search might end up on the record immediately
  14049. ** before the first match or immediately after the last match. The
  14050. ** eqSeen field will indicate whether or not an exact match exists in the
  14051. ** b-tree.
  14052. */
  14053. struct UnpackedRecord {
  14054. KeyInfo *pKeyInfo; /* Collation and sort-order information */
  14055. Mem *aMem; /* Values */
  14056. u16 nField; /* Number of entries in apMem[] */
  14057. i8 default_rc; /* Comparison result if keys are equal */
  14058. u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
  14059. i8 r1; /* Value to return if (lhs > rhs) */
  14060. i8 r2; /* Value to return if (rhs < lhs) */
  14061. u8 eqSeen; /* True if an equality comparison has been seen */
  14062. };
  14063. /*
  14064. ** Each SQL index is represented in memory by an
  14065. ** instance of the following structure.
  14066. **
  14067. ** The columns of the table that are to be indexed are described
  14068. ** by the aiColumn[] field of this structure. For example, suppose
  14069. ** we have the following table and index:
  14070. **
  14071. ** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
  14072. ** CREATE INDEX Ex2 ON Ex1(c3,c1);
  14073. **
  14074. ** In the Table structure describing Ex1, nCol==3 because there are
  14075. ** three columns in the table. In the Index structure describing
  14076. ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
  14077. ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
  14078. ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
  14079. ** The second column to be indexed (c1) has an index of 0 in
  14080. ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
  14081. **
  14082. ** The Index.onError field determines whether or not the indexed columns
  14083. ** must be unique and what to do if they are not. When Index.onError=OE_None,
  14084. ** it means this is not a unique index. Otherwise it is a unique index
  14085. ** and the value of Index.onError indicate the which conflict resolution
  14086. ** algorithm to employ whenever an attempt is made to insert a non-unique
  14087. ** element.
  14088. **
  14089. ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
  14090. ** generate VDBE code (as opposed to parsing one read from an sqlite_master
  14091. ** table as part of parsing an existing database schema), transient instances
  14092. ** of this structure may be created. In this case the Index.tnum variable is
  14093. ** used to store the address of a VDBE instruction, not a database page
  14094. ** number (it cannot - the database page is not allocated until the VDBE
  14095. ** program is executed). See convertToWithoutRowidTable() for details.
  14096. */
  14097. struct Index {
  14098. char *zName; /* Name of this index */
  14099. i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */
  14100. LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */
  14101. Table *pTable; /* The SQL table being indexed */
  14102. char *zColAff; /* String defining the affinity of each column */
  14103. Index *pNext; /* The next index associated with the same table */
  14104. Schema *pSchema; /* Schema containing this index */
  14105. u8 *aSortOrder; /* for each column: True==DESC, False==ASC */
  14106. const char **azColl; /* Array of collation sequence names for index */
  14107. Expr *pPartIdxWhere; /* WHERE clause for partial indices */
  14108. ExprList *aColExpr; /* Column expressions */
  14109. int tnum; /* DB Page containing root of this index */
  14110. LogEst szIdxRow; /* Estimated average row size in bytes */
  14111. u16 nKeyCol; /* Number of columns forming the key */
  14112. u16 nColumn; /* Number of columns stored in the index */
  14113. u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
  14114. unsigned idxType:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
  14115. unsigned bUnordered:1; /* Use this index for == or IN queries only */
  14116. unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */
  14117. unsigned isResized:1; /* True if resizeIndexObject() has been called */
  14118. unsigned isCovering:1; /* True if this is a covering index */
  14119. unsigned noSkipScan:1; /* Do not try to use skip-scan if true */
  14120. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  14121. int nSample; /* Number of elements in aSample[] */
  14122. int nSampleCol; /* Size of IndexSample.anEq[] and so on */
  14123. tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */
  14124. IndexSample *aSample; /* Samples of the left-most key */
  14125. tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */
  14126. tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */
  14127. #endif
  14128. };
  14129. /*
  14130. ** Allowed values for Index.idxType
  14131. */
  14132. #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */
  14133. #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */
  14134. #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */
  14135. /* Return true if index X is a PRIMARY KEY index */
  14136. #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
  14137. /* Return true if index X is a UNIQUE index */
  14138. #define IsUniqueIndex(X) ((X)->onError!=OE_None)
  14139. /* The Index.aiColumn[] values are normally positive integer. But
  14140. ** there are some negative values that have special meaning:
  14141. */
  14142. #define XN_ROWID (-1) /* Indexed column is the rowid */
  14143. #define XN_EXPR (-2) /* Indexed column is an expression */
  14144. /*
  14145. ** Each sample stored in the sqlite_stat3 table is represented in memory
  14146. ** using a structure of this type. See documentation at the top of the
  14147. ** analyze.c source file for additional information.
  14148. */
  14149. struct IndexSample {
  14150. void *p; /* Pointer to sampled record */
  14151. int n; /* Size of record in bytes */
  14152. tRowcnt *anEq; /* Est. number of rows where the key equals this sample */
  14153. tRowcnt *anLt; /* Est. number of rows where key is less than this sample */
  14154. tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */
  14155. };
  14156. /*
  14157. ** Each token coming out of the lexer is an instance of
  14158. ** this structure. Tokens are also used as part of an expression.
  14159. **
  14160. ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
  14161. ** may contain random values. Do not make any assumptions about Token.dyn
  14162. ** and Token.n when Token.z==0.
  14163. */
  14164. struct Token {
  14165. const char *z; /* Text of the token. Not NULL-terminated! */
  14166. unsigned int n; /* Number of characters in this token */
  14167. };
  14168. /*
  14169. ** An instance of this structure contains information needed to generate
  14170. ** code for a SELECT that contains aggregate functions.
  14171. **
  14172. ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
  14173. ** pointer to this structure. The Expr.iColumn field is the index in
  14174. ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
  14175. ** code for that node.
  14176. **
  14177. ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
  14178. ** original Select structure that describes the SELECT statement. These
  14179. ** fields do not need to be freed when deallocating the AggInfo structure.
  14180. */
  14181. struct AggInfo {
  14182. u8 directMode; /* Direct rendering mode means take data directly
  14183. ** from source tables rather than from accumulators */
  14184. u8 useSortingIdx; /* In direct mode, reference the sorting index rather
  14185. ** than the source table */
  14186. int sortingIdx; /* Cursor number of the sorting index */
  14187. int sortingIdxPTab; /* Cursor number of pseudo-table */
  14188. int nSortingColumn; /* Number of columns in the sorting index */
  14189. int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */
  14190. ExprList *pGroupBy; /* The group by clause */
  14191. struct AggInfo_col { /* For each column used in source tables */
  14192. Table *pTab; /* Source table */
  14193. int iTable; /* Cursor number of the source table */
  14194. int iColumn; /* Column number within the source table */
  14195. int iSorterColumn; /* Column number in the sorting index */
  14196. int iMem; /* Memory location that acts as accumulator */
  14197. Expr *pExpr; /* The original expression */
  14198. } *aCol;
  14199. int nColumn; /* Number of used entries in aCol[] */
  14200. int nAccumulator; /* Number of columns that show through to the output.
  14201. ** Additional columns are used only as parameters to
  14202. ** aggregate functions */
  14203. struct AggInfo_func { /* For each aggregate function */
  14204. Expr *pExpr; /* Expression encoding the function */
  14205. FuncDef *pFunc; /* The aggregate function implementation */
  14206. int iMem; /* Memory location that acts as accumulator */
  14207. int iDistinct; /* Ephemeral table used to enforce DISTINCT */
  14208. } *aFunc;
  14209. int nFunc; /* Number of entries in aFunc[] */
  14210. };
  14211. /*
  14212. ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
  14213. ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater
  14214. ** than 32767 we have to make it 32-bit. 16-bit is preferred because
  14215. ** it uses less memory in the Expr object, which is a big memory user
  14216. ** in systems with lots of prepared statements. And few applications
  14217. ** need more than about 10 or 20 variables. But some extreme users want
  14218. ** to have prepared statements with over 32767 variables, and for them
  14219. ** the option is available (at compile-time).
  14220. */
  14221. #if SQLITE_MAX_VARIABLE_NUMBER<=32767
  14222. typedef i16 ynVar;
  14223. #else
  14224. typedef int ynVar;
  14225. #endif
  14226. /*
  14227. ** Each node of an expression in the parse tree is an instance
  14228. ** of this structure.
  14229. **
  14230. ** Expr.op is the opcode. The integer parser token codes are reused
  14231. ** as opcodes here. For example, the parser defines TK_GE to be an integer
  14232. ** code representing the ">=" operator. This same integer code is reused
  14233. ** to represent the greater-than-or-equal-to operator in the expression
  14234. ** tree.
  14235. **
  14236. ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
  14237. ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
  14238. ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
  14239. ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
  14240. ** then Expr.token contains the name of the function.
  14241. **
  14242. ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
  14243. ** binary operator. Either or both may be NULL.
  14244. **
  14245. ** Expr.x.pList is a list of arguments if the expression is an SQL function,
  14246. ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
  14247. ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
  14248. ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
  14249. ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
  14250. ** valid.
  14251. **
  14252. ** An expression of the form ID or ID.ID refers to a column in a table.
  14253. ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
  14254. ** the integer cursor number of a VDBE cursor pointing to that table and
  14255. ** Expr.iColumn is the column number for the specific column. If the
  14256. ** expression is used as a result in an aggregate SELECT, then the
  14257. ** value is also stored in the Expr.iAgg column in the aggregate so that
  14258. ** it can be accessed after all aggregates are computed.
  14259. **
  14260. ** If the expression is an unbound variable marker (a question mark
  14261. ** character '?' in the original SQL) then the Expr.iTable holds the index
  14262. ** number for that variable.
  14263. **
  14264. ** If the expression is a subquery then Expr.iColumn holds an integer
  14265. ** register number containing the result of the subquery. If the
  14266. ** subquery gives a constant result, then iTable is -1. If the subquery
  14267. ** gives a different answer at different times during statement processing
  14268. ** then iTable is the address of a subroutine that computes the subquery.
  14269. **
  14270. ** If the Expr is of type OP_Column, and the table it is selecting from
  14271. ** is a disk table or the "old.*" pseudo-table, then pTab points to the
  14272. ** corresponding table definition.
  14273. **
  14274. ** ALLOCATION NOTES:
  14275. **
  14276. ** Expr objects can use a lot of memory space in database schema. To
  14277. ** help reduce memory requirements, sometimes an Expr object will be
  14278. ** truncated. And to reduce the number of memory allocations, sometimes
  14279. ** two or more Expr objects will be stored in a single memory allocation,
  14280. ** together with Expr.zToken strings.
  14281. **
  14282. ** If the EP_Reduced and EP_TokenOnly flags are set when
  14283. ** an Expr object is truncated. When EP_Reduced is set, then all
  14284. ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
  14285. ** are contained within the same memory allocation. Note, however, that
  14286. ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
  14287. ** allocated, regardless of whether or not EP_Reduced is set.
  14288. */
  14289. struct Expr {
  14290. u8 op; /* Operation performed by this node */
  14291. char affinity; /* The affinity of the column or 0 if not a column */
  14292. u32 flags; /* Various flags. EP_* See below */
  14293. union {
  14294. char *zToken; /* Token value. Zero terminated and dequoted */
  14295. int iValue; /* Non-negative integer value if EP_IntValue */
  14296. } u;
  14297. /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
  14298. ** space is allocated for the fields below this point. An attempt to
  14299. ** access them will result in a segfault or malfunction.
  14300. *********************************************************************/
  14301. Expr *pLeft; /* Left subnode */
  14302. Expr *pRight; /* Right subnode */
  14303. union {
  14304. ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
  14305. Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */
  14306. } x;
  14307. /* If the EP_Reduced flag is set in the Expr.flags mask, then no
  14308. ** space is allocated for the fields below this point. An attempt to
  14309. ** access them will result in a segfault or malfunction.
  14310. *********************************************************************/
  14311. #if SQLITE_MAX_EXPR_DEPTH>0
  14312. int nHeight; /* Height of the tree headed by this node */
  14313. #endif
  14314. int iTable; /* TK_COLUMN: cursor number of table holding column
  14315. ** TK_REGISTER: register number
  14316. ** TK_TRIGGER: 1 -> new, 0 -> old
  14317. ** EP_Unlikely: 134217728 times likelihood
  14318. ** TK_SELECT: 1st register of result vector */
  14319. ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid.
  14320. ** TK_VARIABLE: variable number (always >= 1).
  14321. ** TK_SELECT_COLUMN: column of the result vector */
  14322. i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
  14323. i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */
  14324. u8 op2; /* TK_REGISTER: original value of Expr.op
  14325. ** TK_COLUMN: the value of p5 for OP_Column
  14326. ** TK_AGG_FUNCTION: nesting depth */
  14327. AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
  14328. Table *pTab; /* Table for TK_COLUMN expressions. */
  14329. };
  14330. /*
  14331. ** The following are the meanings of bits in the Expr.flags field.
  14332. */
  14333. #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */
  14334. #define EP_Agg 0x000002 /* Contains one or more aggregate functions */
  14335. #define EP_Resolved 0x000004 /* IDs have been resolved to COLUMNs */
  14336. #define EP_Error 0x000008 /* Expression contains one or more errors */
  14337. #define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */
  14338. #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
  14339. #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
  14340. #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
  14341. #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */
  14342. #define EP_Generic 0x000200 /* Ignore COLLATE or affinity on this tree */
  14343. #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */
  14344. #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
  14345. #define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */
  14346. #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
  14347. #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
  14348. #define EP_Static 0x008000 /* Held in memory not obtained from malloc() */
  14349. #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */
  14350. #define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
  14351. #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */
  14352. #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
  14353. #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
  14354. #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */
  14355. #define EP_Alias 0x400000 /* Is an alias for a result set column */
  14356. #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */
  14357. /*
  14358. ** Combinations of two or more EP_* flags
  14359. */
  14360. #define EP_Propagate (EP_Collate|EP_Subquery) /* Propagate these bits up tree */
  14361. /*
  14362. ** These macros can be used to test, set, or clear bits in the
  14363. ** Expr.flags field.
  14364. */
  14365. #define ExprHasProperty(E,P) (((E)->flags&(P))!=0)
  14366. #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P))
  14367. #define ExprSetProperty(E,P) (E)->flags|=(P)
  14368. #define ExprClearProperty(E,P) (E)->flags&=~(P)
  14369. /* The ExprSetVVAProperty() macro is used for Verification, Validation,
  14370. ** and Accreditation only. It works like ExprSetProperty() during VVA
  14371. ** processes but is a no-op for delivery.
  14372. */
  14373. #ifdef SQLITE_DEBUG
  14374. # define ExprSetVVAProperty(E,P) (E)->flags|=(P)
  14375. #else
  14376. # define ExprSetVVAProperty(E,P)
  14377. #endif
  14378. /*
  14379. ** Macros to determine the number of bytes required by a normal Expr
  14380. ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
  14381. ** and an Expr struct with the EP_TokenOnly flag set.
  14382. */
  14383. #define EXPR_FULLSIZE sizeof(Expr) /* Full size */
  14384. #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */
  14385. #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */
  14386. /*
  14387. ** Flags passed to the sqlite3ExprDup() function. See the header comment
  14388. ** above sqlite3ExprDup() for details.
  14389. */
  14390. #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */
  14391. /*
  14392. ** A list of expressions. Each expression may optionally have a
  14393. ** name. An expr/name combination can be used in several ways, such
  14394. ** as the list of "expr AS ID" fields following a "SELECT" or in the
  14395. ** list of "ID = expr" items in an UPDATE. A list of expressions can
  14396. ** also be used as the argument to a function, in which case the a.zName
  14397. ** field is not used.
  14398. **
  14399. ** By default the Expr.zSpan field holds a human-readable description of
  14400. ** the expression that is used in the generation of error messages and
  14401. ** column labels. In this case, Expr.zSpan is typically the text of a
  14402. ** column expression as it exists in a SELECT statement. However, if
  14403. ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
  14404. ** of the result column in the form: DATABASE.TABLE.COLUMN. This later
  14405. ** form is used for name resolution with nested FROM clauses.
  14406. */
  14407. struct ExprList {
  14408. int nExpr; /* Number of expressions on the list */
  14409. struct ExprList_item { /* For each expression in the list */
  14410. Expr *pExpr; /* The list of expressions */
  14411. char *zName; /* Token associated with this expression */
  14412. char *zSpan; /* Original text of the expression */
  14413. u8 sortOrder; /* 1 for DESC or 0 for ASC */
  14414. unsigned done :1; /* A flag to indicate when processing is finished */
  14415. unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
  14416. unsigned reusable :1; /* Constant expression is reusable */
  14417. union {
  14418. struct {
  14419. u16 iOrderByCol; /* For ORDER BY, column number in result set */
  14420. u16 iAlias; /* Index into Parse.aAlias[] for zName */
  14421. } x;
  14422. int iConstExprReg; /* Register in which Expr value is cached */
  14423. } u;
  14424. } *a; /* Alloc a power of two greater or equal to nExpr */
  14425. };
  14426. /*
  14427. ** An instance of this structure is used by the parser to record both
  14428. ** the parse tree for an expression and the span of input text for an
  14429. ** expression.
  14430. */
  14431. struct ExprSpan {
  14432. Expr *pExpr; /* The expression parse tree */
  14433. const char *zStart; /* First character of input text */
  14434. const char *zEnd; /* One character past the end of input text */
  14435. };
  14436. /*
  14437. ** An instance of this structure can hold a simple list of identifiers,
  14438. ** such as the list "a,b,c" in the following statements:
  14439. **
  14440. ** INSERT INTO t(a,b,c) VALUES ...;
  14441. ** CREATE INDEX idx ON t(a,b,c);
  14442. ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
  14443. **
  14444. ** The IdList.a.idx field is used when the IdList represents the list of
  14445. ** column names after a table name in an INSERT statement. In the statement
  14446. **
  14447. ** INSERT INTO t(a,b,c) ...
  14448. **
  14449. ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
  14450. */
  14451. struct IdList {
  14452. struct IdList_item {
  14453. char *zName; /* Name of the identifier */
  14454. int idx; /* Index in some Table.aCol[] of a column named zName */
  14455. } *a;
  14456. int nId; /* Number of identifiers on the list */
  14457. };
  14458. /*
  14459. ** The bitmask datatype defined below is used for various optimizations.
  14460. **
  14461. ** Changing this from a 64-bit to a 32-bit type limits the number of
  14462. ** tables in a join to 32 instead of 64. But it also reduces the size
  14463. ** of the library by 738 bytes on ix86.
  14464. */
  14465. #ifdef SQLITE_BITMASK_TYPE
  14466. typedef SQLITE_BITMASK_TYPE Bitmask;
  14467. #else
  14468. typedef u64 Bitmask;
  14469. #endif
  14470. /*
  14471. ** The number of bits in a Bitmask. "BMS" means "BitMask Size".
  14472. */
  14473. #define BMS ((int)(sizeof(Bitmask)*8))
  14474. /*
  14475. ** A bit in a Bitmask
  14476. */
  14477. #define MASKBIT(n) (((Bitmask)1)<<(n))
  14478. #define MASKBIT32(n) (((unsigned int)1)<<(n))
  14479. #define ALLBITS ((Bitmask)-1)
  14480. /*
  14481. ** The following structure describes the FROM clause of a SELECT statement.
  14482. ** Each table or subquery in the FROM clause is a separate element of
  14483. ** the SrcList.a[] array.
  14484. **
  14485. ** With the addition of multiple database support, the following structure
  14486. ** can also be used to describe a particular table such as the table that
  14487. ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
  14488. ** such a table must be a simple name: ID. But in SQLite, the table can
  14489. ** now be identified by a database name, a dot, then the table name: ID.ID.
  14490. **
  14491. ** The jointype starts out showing the join type between the current table
  14492. ** and the next table on the list. The parser builds the list this way.
  14493. ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
  14494. ** jointype expresses the join between the table and the previous table.
  14495. **
  14496. ** In the colUsed field, the high-order bit (bit 63) is set if the table
  14497. ** contains more than 63 columns and the 64-th or later column is used.
  14498. */
  14499. struct SrcList {
  14500. int nSrc; /* Number of tables or subqueries in the FROM clause */
  14501. u32 nAlloc; /* Number of entries allocated in a[] below */
  14502. struct SrcList_item {
  14503. Schema *pSchema; /* Schema to which this item is fixed */
  14504. char *zDatabase; /* Name of database holding this table */
  14505. char *zName; /* Name of the table */
  14506. char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
  14507. Table *pTab; /* An SQL table corresponding to zName */
  14508. Select *pSelect; /* A SELECT statement used in place of a table name */
  14509. int addrFillSub; /* Address of subroutine to manifest a subquery */
  14510. int regReturn; /* Register holding return address of addrFillSub */
  14511. int regResult; /* Registers holding results of a co-routine */
  14512. struct {
  14513. u8 jointype; /* Type of join between this table and the previous */
  14514. unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */
  14515. unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */
  14516. unsigned isTabFunc :1; /* True if table-valued-function syntax */
  14517. unsigned isCorrelated :1; /* True if sub-query is correlated */
  14518. unsigned viaCoroutine :1; /* Implemented as a co-routine */
  14519. unsigned isRecursive :1; /* True for recursive reference in WITH */
  14520. } fg;
  14521. #ifndef SQLITE_OMIT_EXPLAIN
  14522. u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */
  14523. #endif
  14524. int iCursor; /* The VDBE cursor number used to access this table */
  14525. Expr *pOn; /* The ON clause of a join */
  14526. IdList *pUsing; /* The USING clause of a join */
  14527. Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
  14528. union {
  14529. char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */
  14530. ExprList *pFuncArg; /* Arguments to table-valued-function */
  14531. } u1;
  14532. Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */
  14533. } a[1]; /* One entry for each identifier on the list */
  14534. };
  14535. /*
  14536. ** Permitted values of the SrcList.a.jointype field
  14537. */
  14538. #define JT_INNER 0x0001 /* Any kind of inner or cross join */
  14539. #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
  14540. #define JT_NATURAL 0x0004 /* True for a "natural" join */
  14541. #define JT_LEFT 0x0008 /* Left outer join */
  14542. #define JT_RIGHT 0x0010 /* Right outer join */
  14543. #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
  14544. #define JT_ERROR 0x0040 /* unknown or unsupported join type */
  14545. /*
  14546. ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
  14547. ** and the WhereInfo.wctrlFlags member.
  14548. **
  14549. ** Value constraints (enforced via assert()):
  14550. ** WHERE_USE_LIMIT == SF_FixedLimit
  14551. */
  14552. #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
  14553. #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
  14554. #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
  14555. #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
  14556. #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */
  14557. #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */
  14558. #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of
  14559. ** the OR optimization */
  14560. #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */
  14561. #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */
  14562. #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */
  14563. #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */
  14564. #define WHERE_SEEK_TABLE 0x0400 /* Do not defer seeks on main table */
  14565. #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */
  14566. /* 0x1000 not currently used */
  14567. /* 0x2000 not currently used */
  14568. #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */
  14569. /* 0x8000 not currently used */
  14570. /* Allowed return values from sqlite3WhereIsDistinct()
  14571. */
  14572. #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */
  14573. #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */
  14574. #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */
  14575. #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */
  14576. /*
  14577. ** A NameContext defines a context in which to resolve table and column
  14578. ** names. The context consists of a list of tables (the pSrcList) field and
  14579. ** a list of named expression (pEList). The named expression list may
  14580. ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
  14581. ** to the table being operated on by INSERT, UPDATE, or DELETE. The
  14582. ** pEList corresponds to the result set of a SELECT and is NULL for
  14583. ** other statements.
  14584. **
  14585. ** NameContexts can be nested. When resolving names, the inner-most
  14586. ** context is searched first. If no match is found, the next outer
  14587. ** context is checked. If there is still no match, the next context
  14588. ** is checked. This process continues until either a match is found
  14589. ** or all contexts are check. When a match is found, the nRef member of
  14590. ** the context containing the match is incremented.
  14591. **
  14592. ** Each subquery gets a new NameContext. The pNext field points to the
  14593. ** NameContext in the parent query. Thus the process of scanning the
  14594. ** NameContext list corresponds to searching through successively outer
  14595. ** subqueries looking for a match.
  14596. */
  14597. struct NameContext {
  14598. Parse *pParse; /* The parser */
  14599. SrcList *pSrcList; /* One or more tables used to resolve names */
  14600. ExprList *pEList; /* Optional list of result-set columns */
  14601. AggInfo *pAggInfo; /* Information about aggregates at this level */
  14602. NameContext *pNext; /* Next outer name context. NULL for outermost */
  14603. int nRef; /* Number of names resolved by this context */
  14604. int nErr; /* Number of errors encountered while resolving names */
  14605. u16 ncFlags; /* Zero or more NC_* flags defined below */
  14606. };
  14607. /*
  14608. ** Allowed values for the NameContext, ncFlags field.
  14609. **
  14610. ** Value constraints (all checked via assert()):
  14611. ** NC_HasAgg == SF_HasAgg
  14612. ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
  14613. **
  14614. */
  14615. #define NC_AllowAgg 0x0001 /* Aggregate functions are allowed here */
  14616. #define NC_PartIdx 0x0002 /* True if resolving a partial index WHERE */
  14617. #define NC_IsCheck 0x0004 /* True if resolving names in a CHECK constraint */
  14618. #define NC_InAggFunc 0x0008 /* True if analyzing arguments to an agg func */
  14619. #define NC_HasAgg 0x0010 /* One or more aggregate functions seen */
  14620. #define NC_IdxExpr 0x0020 /* True if resolving columns of CREATE INDEX */
  14621. #define NC_VarSelect 0x0040 /* A correlated subquery has been seen */
  14622. #define NC_MinMaxAgg 0x1000 /* min/max aggregates seen. See note above */
  14623. /*
  14624. ** An instance of the following structure contains all information
  14625. ** needed to generate code for a single SELECT statement.
  14626. **
  14627. ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
  14628. ** If there is a LIMIT clause, the parser sets nLimit to the value of the
  14629. ** limit and nOffset to the value of the offset (or 0 if there is not
  14630. ** offset). But later on, nLimit and nOffset become the memory locations
  14631. ** in the VDBE that record the limit and offset counters.
  14632. **
  14633. ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
  14634. ** These addresses must be stored so that we can go back and fill in
  14635. ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
  14636. ** the number of columns in P2 can be computed at the same time
  14637. ** as the OP_OpenEphm instruction is coded because not
  14638. ** enough information about the compound query is known at that point.
  14639. ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
  14640. ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating
  14641. ** sequences for the ORDER BY clause.
  14642. */
  14643. struct Select {
  14644. ExprList *pEList; /* The fields of the result */
  14645. u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
  14646. LogEst nSelectRow; /* Estimated number of result rows */
  14647. u32 selFlags; /* Various SF_* values */
  14648. int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
  14649. #if SELECTTRACE_ENABLED
  14650. char zSelName[12]; /* Symbolic name of this SELECT use for debugging */
  14651. #endif
  14652. int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */
  14653. SrcList *pSrc; /* The FROM clause */
  14654. Expr *pWhere; /* The WHERE clause */
  14655. ExprList *pGroupBy; /* The GROUP BY clause */
  14656. Expr *pHaving; /* The HAVING clause */
  14657. ExprList *pOrderBy; /* The ORDER BY clause */
  14658. Select *pPrior; /* Prior select in a compound select statement */
  14659. Select *pNext; /* Next select to the left in a compound */
  14660. Expr *pLimit; /* LIMIT expression. NULL means not used. */
  14661. Expr *pOffset; /* OFFSET expression. NULL means not used. */
  14662. With *pWith; /* WITH clause attached to this select. Or NULL. */
  14663. };
  14664. /*
  14665. ** Allowed values for Select.selFlags. The "SF" prefix stands for
  14666. ** "Select Flag".
  14667. **
  14668. ** Value constraints (all checked via assert())
  14669. ** SF_HasAgg == NC_HasAgg
  14670. ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX
  14671. ** SF_FixedLimit == WHERE_USE_LIMIT
  14672. */
  14673. #define SF_Distinct 0x00001 /* Output should be DISTINCT */
  14674. #define SF_All 0x00002 /* Includes the ALL keyword */
  14675. #define SF_Resolved 0x00004 /* Identifiers have been resolved */
  14676. #define SF_Aggregate 0x00008 /* Contains agg functions or a GROUP BY */
  14677. #define SF_HasAgg 0x00010 /* Contains aggregate functions */
  14678. #define SF_UsesEphemeral 0x00020 /* Uses the OpenEphemeral opcode */
  14679. #define SF_Expanded 0x00040 /* sqlite3SelectExpand() called on this */
  14680. #define SF_HasTypeInfo 0x00080 /* FROM subqueries have Table metadata */
  14681. #define SF_Compound 0x00100 /* Part of a compound query */
  14682. #define SF_Values 0x00200 /* Synthesized from VALUES clause */
  14683. #define SF_MultiValue 0x00400 /* Single VALUES term with multiple rows */
  14684. #define SF_NestedFrom 0x00800 /* Part of a parenthesized FROM clause */
  14685. #define SF_MinMaxAgg 0x01000 /* Aggregate containing min() or max() */
  14686. #define SF_Recursive 0x02000 /* The recursive part of a recursive CTE */
  14687. #define SF_FixedLimit 0x04000 /* nSelectRow set by a constant LIMIT */
  14688. #define SF_MaybeConvert 0x08000 /* Need convertCompoundSelectToSubquery() */
  14689. #define SF_Converted 0x10000 /* By convertCompoundSelectToSubquery() */
  14690. #define SF_IncludeHidden 0x20000 /* Include hidden columns in output */
  14691. /*
  14692. ** The results of a SELECT can be distributed in several ways, as defined
  14693. ** by one of the following macros. The "SRT" prefix means "SELECT Result
  14694. ** Type".
  14695. **
  14696. ** SRT_Union Store results as a key in a temporary index
  14697. ** identified by pDest->iSDParm.
  14698. **
  14699. ** SRT_Except Remove results from the temporary index pDest->iSDParm.
  14700. **
  14701. ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result
  14702. ** set is not empty.
  14703. **
  14704. ** SRT_Discard Throw the results away. This is used by SELECT
  14705. ** statements within triggers whose only purpose is
  14706. ** the side-effects of functions.
  14707. **
  14708. ** All of the above are free to ignore their ORDER BY clause. Those that
  14709. ** follow must honor the ORDER BY clause.
  14710. **
  14711. ** SRT_Output Generate a row of output (using the OP_ResultRow
  14712. ** opcode) for each row in the result set.
  14713. **
  14714. ** SRT_Mem Only valid if the result is a single column.
  14715. ** Store the first column of the first result row
  14716. ** in register pDest->iSDParm then abandon the rest
  14717. ** of the query. This destination implies "LIMIT 1".
  14718. **
  14719. ** SRT_Set The result must be a single column. Store each
  14720. ** row of result as the key in table pDest->iSDParm.
  14721. ** Apply the affinity pDest->affSdst before storing
  14722. ** results. Used to implement "IN (SELECT ...)".
  14723. **
  14724. ** SRT_EphemTab Create an temporary table pDest->iSDParm and store
  14725. ** the result there. The cursor is left open after
  14726. ** returning. This is like SRT_Table except that
  14727. ** this destination uses OP_OpenEphemeral to create
  14728. ** the table first.
  14729. **
  14730. ** SRT_Coroutine Generate a co-routine that returns a new row of
  14731. ** results each time it is invoked. The entry point
  14732. ** of the co-routine is stored in register pDest->iSDParm
  14733. ** and the result row is stored in pDest->nDest registers
  14734. ** starting with pDest->iSdst.
  14735. **
  14736. ** SRT_Table Store results in temporary table pDest->iSDParm.
  14737. ** SRT_Fifo This is like SRT_EphemTab except that the table
  14738. ** is assumed to already be open. SRT_Fifo has
  14739. ** the additional property of being able to ignore
  14740. ** the ORDER BY clause.
  14741. **
  14742. ** SRT_DistFifo Store results in a temporary table pDest->iSDParm.
  14743. ** But also use temporary table pDest->iSDParm+1 as
  14744. ** a record of all prior results and ignore any duplicate
  14745. ** rows. Name means: "Distinct Fifo".
  14746. **
  14747. ** SRT_Queue Store results in priority queue pDest->iSDParm (really
  14748. ** an index). Append a sequence number so that all entries
  14749. ** are distinct.
  14750. **
  14751. ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if
  14752. ** the same record has never been stored before. The
  14753. ** index at pDest->iSDParm+1 hold all prior stores.
  14754. */
  14755. #define SRT_Union 1 /* Store result as keys in an index */
  14756. #define SRT_Except 2 /* Remove result from a UNION index */
  14757. #define SRT_Exists 3 /* Store 1 if the result is not empty */
  14758. #define SRT_Discard 4 /* Do not save the results anywhere */
  14759. #define SRT_Fifo 5 /* Store result as data with an automatic rowid */
  14760. #define SRT_DistFifo 6 /* Like SRT_Fifo, but unique results only */
  14761. #define SRT_Queue 7 /* Store result in an queue */
  14762. #define SRT_DistQueue 8 /* Like SRT_Queue, but unique results only */
  14763. /* The ORDER BY clause is ignored for all of the above */
  14764. #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
  14765. #define SRT_Output 9 /* Output each row of result */
  14766. #define SRT_Mem 10 /* Store result in a memory cell */
  14767. #define SRT_Set 11 /* Store results as keys in an index */
  14768. #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */
  14769. #define SRT_Coroutine 13 /* Generate a single row of result */
  14770. #define SRT_Table 14 /* Store result as data with an automatic rowid */
  14771. /*
  14772. ** An instance of this object describes where to put of the results of
  14773. ** a SELECT statement.
  14774. */
  14775. struct SelectDest {
  14776. u8 eDest; /* How to dispose of the results. On of SRT_* above. */
  14777. char *zAffSdst; /* Affinity used when eDest==SRT_Set */
  14778. int iSDParm; /* A parameter used by the eDest disposal method */
  14779. int iSdst; /* Base register where results are written */
  14780. int nSdst; /* Number of registers allocated */
  14781. ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */
  14782. };
  14783. /*
  14784. ** During code generation of statements that do inserts into AUTOINCREMENT
  14785. ** tables, the following information is attached to the Table.u.autoInc.p
  14786. ** pointer of each autoincrement table to record some side information that
  14787. ** the code generator needs. We have to keep per-table autoincrement
  14788. ** information in case inserts are done within triggers. Triggers do not
  14789. ** normally coordinate their activities, but we do need to coordinate the
  14790. ** loading and saving of autoincrement information.
  14791. */
  14792. struct AutoincInfo {
  14793. AutoincInfo *pNext; /* Next info block in a list of them all */
  14794. Table *pTab; /* Table this info block refers to */
  14795. int iDb; /* Index in sqlite3.aDb[] of database holding pTab */
  14796. int regCtr; /* Memory register holding the rowid counter */
  14797. };
  14798. /*
  14799. ** Size of the column cache
  14800. */
  14801. #ifndef SQLITE_N_COLCACHE
  14802. # define SQLITE_N_COLCACHE 10
  14803. #endif
  14804. /*
  14805. ** At least one instance of the following structure is created for each
  14806. ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
  14807. ** statement. All such objects are stored in the linked list headed at
  14808. ** Parse.pTriggerPrg and deleted once statement compilation has been
  14809. ** completed.
  14810. **
  14811. ** A Vdbe sub-program that implements the body and WHEN clause of trigger
  14812. ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
  14813. ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
  14814. ** The Parse.pTriggerPrg list never contains two entries with the same
  14815. ** values for both pTrigger and orconf.
  14816. **
  14817. ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
  14818. ** accessed (or set to 0 for triggers fired as a result of INSERT
  14819. ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
  14820. ** a mask of new.* columns used by the program.
  14821. */
  14822. struct TriggerPrg {
  14823. Trigger *pTrigger; /* Trigger this program was coded from */
  14824. TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */
  14825. SubProgram *pProgram; /* Program implementing pTrigger/orconf */
  14826. int orconf; /* Default ON CONFLICT policy */
  14827. u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */
  14828. };
  14829. /*
  14830. ** The yDbMask datatype for the bitmask of all attached databases.
  14831. */
  14832. #if SQLITE_MAX_ATTACHED>30
  14833. typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
  14834. # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0)
  14835. # define DbMaskZero(M) memset((M),0,sizeof(M))
  14836. # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7))
  14837. # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M)
  14838. # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0)
  14839. #else
  14840. typedef unsigned int yDbMask;
  14841. # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0)
  14842. # define DbMaskZero(M) (M)=0
  14843. # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I))
  14844. # define DbMaskAllZero(M) (M)==0
  14845. # define DbMaskNonZero(M) (M)!=0
  14846. #endif
  14847. /*
  14848. ** An SQL parser context. A copy of this structure is passed through
  14849. ** the parser and down into all the parser action routine in order to
  14850. ** carry around information that is global to the entire parse.
  14851. **
  14852. ** The structure is divided into two parts. When the parser and code
  14853. ** generate call themselves recursively, the first part of the structure
  14854. ** is constant but the second part is reset at the beginning and end of
  14855. ** each recursion.
  14856. **
  14857. ** The nTableLock and aTableLock variables are only used if the shared-cache
  14858. ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
  14859. ** used to store the set of table-locks required by the statement being
  14860. ** compiled. Function sqlite3TableLock() is used to add entries to the
  14861. ** list.
  14862. */
  14863. struct Parse {
  14864. sqlite3 *db; /* The main database structure */
  14865. char *zErrMsg; /* An error message */
  14866. Vdbe *pVdbe; /* An engine for executing database bytecode */
  14867. int rc; /* Return code from execution */
  14868. u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
  14869. u8 checkSchema; /* Causes schema cookie check after an error */
  14870. u8 nested; /* Number of nested calls to the parser/code generator */
  14871. u8 nTempReg; /* Number of temporary registers in aTempReg[] */
  14872. u8 isMultiWrite; /* True if statement may modify/insert multiple rows */
  14873. u8 mayAbort; /* True if statement may throw an ABORT exception */
  14874. u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */
  14875. u8 okConstFactor; /* OK to factor out constants */
  14876. u8 disableLookaside; /* Number of times lookaside has been disabled */
  14877. u8 nColCache; /* Number of entries in aColCache[] */
  14878. int nRangeReg; /* Size of the temporary register block */
  14879. int iRangeReg; /* First register in temporary register block */
  14880. int nErr; /* Number of errors seen */
  14881. int nTab; /* Number of previously allocated VDBE cursors */
  14882. int nMem; /* Number of memory cells used so far */
  14883. int nOpAlloc; /* Number of slots allocated for Vdbe.aOp[] */
  14884. int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */
  14885. int ckBase; /* Base register of data during check constraints */
  14886. int iSelfTab; /* Table of an index whose exprs are being coded */
  14887. int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
  14888. int iCacheCnt; /* Counter used to generate aColCache[].lru values */
  14889. int nLabel; /* Number of labels used */
  14890. int *aLabel; /* Space to hold the labels */
  14891. ExprList *pConstExpr;/* Constant expressions */
  14892. Token constraintName;/* Name of the constraint currently being parsed */
  14893. yDbMask writeMask; /* Start a write transaction on these databases */
  14894. yDbMask cookieMask; /* Bitmask of schema verified databases */
  14895. int regRowid; /* Register holding rowid of CREATE TABLE entry */
  14896. int regRoot; /* Register holding root page number for new objects */
  14897. int nMaxArg; /* Max args passed to user function by sub-program */
  14898. #if SELECTTRACE_ENABLED
  14899. int nSelect; /* Number of SELECT statements seen */
  14900. int nSelectIndent; /* How far to indent SELECTTRACE() output */
  14901. #endif
  14902. #ifndef SQLITE_OMIT_SHARED_CACHE
  14903. int nTableLock; /* Number of locks in aTableLock */
  14904. TableLock *aTableLock; /* Required table locks for shared-cache mode */
  14905. #endif
  14906. AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */
  14907. Parse *pToplevel; /* Parse structure for main program (or NULL) */
  14908. Table *pTriggerTab; /* Table triggers are being coded for */
  14909. int addrCrTab; /* Address of OP_CreateTable opcode on CREATE TABLE */
  14910. u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */
  14911. u32 oldmask; /* Mask of old.* columns referenced */
  14912. u32 newmask; /* Mask of new.* columns referenced */
  14913. u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */
  14914. u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */
  14915. u8 disableTriggers; /* True to disable triggers */
  14916. /**************************************************************************
  14917. ** Fields above must be initialized to zero. The fields that follow,
  14918. ** down to the beginning of the recursive section, do not need to be
  14919. ** initialized as they will be set before being used. The boundary is
  14920. ** determined by offsetof(Parse,aColCache).
  14921. **************************************************************************/
  14922. struct yColCache {
  14923. int iTable; /* Table cursor number */
  14924. i16 iColumn; /* Table column number */
  14925. u8 tempReg; /* iReg is a temp register that needs to be freed */
  14926. int iLevel; /* Nesting level */
  14927. int iReg; /* Reg with value of this column. 0 means none. */
  14928. int lru; /* Least recently used entry has the smallest value */
  14929. } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */
  14930. int aTempReg[8]; /* Holding area for temporary registers */
  14931. Token sNameToken; /* Token with unqualified schema object name */
  14932. Token sLastToken; /* The last token parsed */
  14933. /************************************************************************
  14934. ** Above is constant between recursions. Below is reset before and after
  14935. ** each recursion. The boundary between these two regions is determined
  14936. ** using offsetof(Parse,nVar) so the nVar field must be the first field
  14937. ** in the recursive region.
  14938. ************************************************************************/
  14939. ynVar nVar; /* Number of '?' variables seen in the SQL so far */
  14940. int nzVar; /* Number of available slots in azVar[] */
  14941. u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */
  14942. u8 explain; /* True if the EXPLAIN flag is found on the query */
  14943. #ifndef SQLITE_OMIT_VIRTUALTABLE
  14944. u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
  14945. int nVtabLock; /* Number of virtual tables to lock */
  14946. #endif
  14947. int nHeight; /* Expression tree height of current sub-select */
  14948. #ifndef SQLITE_OMIT_EXPLAIN
  14949. int iSelectId; /* ID of current select for EXPLAIN output */
  14950. int iNextSelectId; /* Next available select ID for EXPLAIN output */
  14951. #endif
  14952. char **azVar; /* Pointers to names of parameters */
  14953. Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */
  14954. const char *zTail; /* All SQL text past the last semicolon parsed */
  14955. Table *pNewTable; /* A table being constructed by CREATE TABLE */
  14956. Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
  14957. const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
  14958. #ifndef SQLITE_OMIT_VIRTUALTABLE
  14959. Token sArg; /* Complete text of a module argument */
  14960. Table **apVtabLock; /* Pointer to virtual tables needing locking */
  14961. #endif
  14962. Table *pZombieTab; /* List of Table objects to delete after code gen */
  14963. TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */
  14964. With *pWith; /* Current WITH clause, or NULL */
  14965. With *pWithToFree; /* Free this WITH object at the end of the parse */
  14966. };
  14967. /*
  14968. ** Sizes and pointers of various parts of the Parse object.
  14969. */
  14970. #define PARSE_HDR_SZ offsetof(Parse,aColCache) /* Recursive part w/o aColCache*/
  14971. #define PARSE_RECURSE_SZ offsetof(Parse,nVar) /* Recursive part */
  14972. #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */
  14973. #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */
  14974. /*
  14975. ** Return true if currently inside an sqlite3_declare_vtab() call.
  14976. */
  14977. #ifdef SQLITE_OMIT_VIRTUALTABLE
  14978. #define IN_DECLARE_VTAB 0
  14979. #else
  14980. #define IN_DECLARE_VTAB (pParse->declareVtab)
  14981. #endif
  14982. /*
  14983. ** An instance of the following structure can be declared on a stack and used
  14984. ** to save the Parse.zAuthContext value so that it can be restored later.
  14985. */
  14986. struct AuthContext {
  14987. const char *zAuthContext; /* Put saved Parse.zAuthContext here */
  14988. Parse *pParse; /* The Parse structure */
  14989. };
  14990. /*
  14991. ** Bitfield flags for P5 value in various opcodes.
  14992. **
  14993. ** Value constraints (enforced via assert()):
  14994. ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH
  14995. ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF
  14996. ** OPFLAG_BULKCSR == BTREE_BULKLOAD
  14997. ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ
  14998. ** OPFLAG_FORDELETE == BTREE_FORDELETE
  14999. ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
  15000. ** OPFLAG_AUXDELETE == BTREE_AUXDELETE
  15001. */
  15002. #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */
  15003. /* Also used in P2 (not P5) of OP_Delete */
  15004. #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */
  15005. #define OPFLAG_LASTROWID 0x02 /* Set to update db->lastRowid */
  15006. #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */
  15007. #define OPFLAG_APPEND 0x08 /* This is likely to be an append */
  15008. #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */
  15009. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  15010. #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */
  15011. #endif
  15012. #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */
  15013. #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */
  15014. #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */
  15015. #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */
  15016. #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */
  15017. #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */
  15018. #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */
  15019. #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete: keep cursor position */
  15020. #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */
  15021. /*
  15022. * Each trigger present in the database schema is stored as an instance of
  15023. * struct Trigger.
  15024. *
  15025. * Pointers to instances of struct Trigger are stored in two ways.
  15026. * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
  15027. * database). This allows Trigger structures to be retrieved by name.
  15028. * 2. All triggers associated with a single table form a linked list, using the
  15029. * pNext member of struct Trigger. A pointer to the first element of the
  15030. * linked list is stored as the "pTrigger" member of the associated
  15031. * struct Table.
  15032. *
  15033. * The "step_list" member points to the first element of a linked list
  15034. * containing the SQL statements specified as the trigger program.
  15035. */
  15036. struct Trigger {
  15037. char *zName; /* The name of the trigger */
  15038. char *table; /* The table or view to which the trigger applies */
  15039. u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
  15040. u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
  15041. Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
  15042. IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
  15043. the <column-list> is stored here */
  15044. Schema *pSchema; /* Schema containing the trigger */
  15045. Schema *pTabSchema; /* Schema containing the table */
  15046. TriggerStep *step_list; /* Link list of trigger program steps */
  15047. Trigger *pNext; /* Next trigger associated with the table */
  15048. };
  15049. /*
  15050. ** A trigger is either a BEFORE or an AFTER trigger. The following constants
  15051. ** determine which.
  15052. **
  15053. ** If there are multiple triggers, you might of some BEFORE and some AFTER.
  15054. ** In that cases, the constants below can be ORed together.
  15055. */
  15056. #define TRIGGER_BEFORE 1
  15057. #define TRIGGER_AFTER 2
  15058. /*
  15059. * An instance of struct TriggerStep is used to store a single SQL statement
  15060. * that is a part of a trigger-program.
  15061. *
  15062. * Instances of struct TriggerStep are stored in a singly linked list (linked
  15063. * using the "pNext" member) referenced by the "step_list" member of the
  15064. * associated struct Trigger instance. The first element of the linked list is
  15065. * the first step of the trigger-program.
  15066. *
  15067. * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
  15068. * "SELECT" statement. The meanings of the other members is determined by the
  15069. * value of "op" as follows:
  15070. *
  15071. * (op == TK_INSERT)
  15072. * orconf -> stores the ON CONFLICT algorithm
  15073. * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
  15074. * this stores a pointer to the SELECT statement. Otherwise NULL.
  15075. * zTarget -> Dequoted name of the table to insert into.
  15076. * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
  15077. * this stores values to be inserted. Otherwise NULL.
  15078. * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
  15079. * statement, then this stores the column-names to be
  15080. * inserted into.
  15081. *
  15082. * (op == TK_DELETE)
  15083. * zTarget -> Dequoted name of the table to delete from.
  15084. * pWhere -> The WHERE clause of the DELETE statement if one is specified.
  15085. * Otherwise NULL.
  15086. *
  15087. * (op == TK_UPDATE)
  15088. * zTarget -> Dequoted name of the table to update.
  15089. * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
  15090. * Otherwise NULL.
  15091. * pExprList -> A list of the columns to update and the expressions to update
  15092. * them to. See sqlite3Update() documentation of "pChanges"
  15093. * argument.
  15094. *
  15095. */
  15096. struct TriggerStep {
  15097. u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
  15098. u8 orconf; /* OE_Rollback etc. */
  15099. Trigger *pTrig; /* The trigger that this step is a part of */
  15100. Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */
  15101. char *zTarget; /* Target table for DELETE, UPDATE, INSERT */
  15102. Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */
  15103. ExprList *pExprList; /* SET clause for UPDATE. */
  15104. IdList *pIdList; /* Column names for INSERT */
  15105. TriggerStep *pNext; /* Next in the link-list */
  15106. TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
  15107. };
  15108. /*
  15109. ** The following structure contains information used by the sqliteFix...
  15110. ** routines as they walk the parse tree to make database references
  15111. ** explicit.
  15112. */
  15113. typedef struct DbFixer DbFixer;
  15114. struct DbFixer {
  15115. Parse *pParse; /* The parsing context. Error messages written here */
  15116. Schema *pSchema; /* Fix items to this schema */
  15117. int bVarOnly; /* Check for variable references only */
  15118. const char *zDb; /* Make sure all objects are contained in this database */
  15119. const char *zType; /* Type of the container - used for error messages */
  15120. const Token *pName; /* Name of the container - used for error messages */
  15121. };
  15122. /*
  15123. ** An objected used to accumulate the text of a string where we
  15124. ** do not necessarily know how big the string will be in the end.
  15125. */
  15126. struct StrAccum {
  15127. sqlite3 *db; /* Optional database for lookaside. Can be NULL */
  15128. char *zBase; /* A base allocation. Not from malloc. */
  15129. char *zText; /* The string collected so far */
  15130. u32 nChar; /* Length of the string so far */
  15131. u32 nAlloc; /* Amount of space allocated in zText */
  15132. u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */
  15133. u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
  15134. u8 printfFlags; /* SQLITE_PRINTF flags below */
  15135. };
  15136. #define STRACCUM_NOMEM 1
  15137. #define STRACCUM_TOOBIG 2
  15138. #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */
  15139. #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */
  15140. #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */
  15141. #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
  15142. /*
  15143. ** A pointer to this structure is used to communicate information
  15144. ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
  15145. */
  15146. typedef struct {
  15147. sqlite3 *db; /* The database being initialized */
  15148. char **pzErrMsg; /* Error message stored here */
  15149. int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
  15150. int rc; /* Result code stored here */
  15151. } InitData;
  15152. /*
  15153. ** Structure containing global configuration data for the SQLite library.
  15154. **
  15155. ** This structure also contains some state information.
  15156. */
  15157. struct Sqlite3Config {
  15158. int bMemstat; /* True to enable memory status */
  15159. int bCoreMutex; /* True to enable core mutexing */
  15160. int bFullMutex; /* True to enable full mutexing */
  15161. int bOpenUri; /* True to interpret filenames as URIs */
  15162. int bUseCis; /* Use covering indices for full-scans */
  15163. int mxStrlen; /* Maximum string length */
  15164. int neverCorrupt; /* Database is always well-formed */
  15165. int szLookaside; /* Default lookaside buffer size */
  15166. int nLookaside; /* Default lookaside buffer count */
  15167. int nStmtSpill; /* Stmt-journal spill-to-disk threshold */
  15168. sqlite3_mem_methods m; /* Low-level memory allocation interface */
  15169. sqlite3_mutex_methods mutex; /* Low-level mutex interface */
  15170. sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */
  15171. void *pHeap; /* Heap storage space */
  15172. int nHeap; /* Size of pHeap[] */
  15173. int mnReq, mxReq; /* Min and max heap requests sizes */
  15174. sqlite3_int64 szMmap; /* mmap() space per open file */
  15175. sqlite3_int64 mxMmap; /* Maximum value for szMmap */
  15176. void *pScratch; /* Scratch memory */
  15177. int szScratch; /* Size of each scratch buffer */
  15178. int nScratch; /* Number of scratch buffers */
  15179. void *pPage; /* Page cache memory */
  15180. int szPage; /* Size of each page in pPage[] */
  15181. int nPage; /* Number of pages in pPage[] */
  15182. int mxParserStack; /* maximum depth of the parser stack */
  15183. int sharedCacheEnabled; /* true if shared-cache mode enabled */
  15184. u32 szPma; /* Maximum Sorter PMA size */
  15185. /* The above might be initialized to non-zero. The following need to always
  15186. ** initially be zero, however. */
  15187. int isInit; /* True after initialization has finished */
  15188. int inProgress; /* True while initialization in progress */
  15189. int isMutexInit; /* True after mutexes are initialized */
  15190. int isMallocInit; /* True after malloc is initialized */
  15191. int isPCacheInit; /* True after malloc is initialized */
  15192. int nRefInitMutex; /* Number of users of pInitMutex */
  15193. sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
  15194. void (*xLog)(void*,int,const char*); /* Function for logging */
  15195. void *pLogArg; /* First argument to xLog() */
  15196. #ifdef SQLITE_ENABLE_SQLLOG
  15197. void(*xSqllog)(void*,sqlite3*,const char*, int);
  15198. void *pSqllogArg;
  15199. #endif
  15200. #ifdef SQLITE_VDBE_COVERAGE
  15201. /* The following callback (if not NULL) is invoked on every VDBE branch
  15202. ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
  15203. */
  15204. void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx); /* Callback */
  15205. void *pVdbeBranchArg; /* 1st argument */
  15206. #endif
  15207. #ifndef SQLITE_OMIT_BUILTIN_TEST
  15208. int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */
  15209. #endif
  15210. int bLocaltimeFault; /* True to fail localtime() calls */
  15211. int iOnceResetThreshold; /* When to reset OP_Once counters */
  15212. };
  15213. /*
  15214. ** This macro is used inside of assert() statements to indicate that
  15215. ** the assert is only valid on a well-formed database. Instead of:
  15216. **
  15217. ** assert( X );
  15218. **
  15219. ** One writes:
  15220. **
  15221. ** assert( X || CORRUPT_DB );
  15222. **
  15223. ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate
  15224. ** that the database is definitely corrupt, only that it might be corrupt.
  15225. ** For most test cases, CORRUPT_DB is set to false using a special
  15226. ** sqlite3_test_control(). This enables assert() statements to prove
  15227. ** things that are always true for well-formed databases.
  15228. */
  15229. #define CORRUPT_DB (sqlite3Config.neverCorrupt==0)
  15230. /*
  15231. ** Context pointer passed down through the tree-walk.
  15232. */
  15233. struct Walker {
  15234. Parse *pParse; /* Parser context. */
  15235. int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
  15236. int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
  15237. void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
  15238. int walkerDepth; /* Number of subqueries */
  15239. u8 eCode; /* A small processing code */
  15240. union { /* Extra data for callback */
  15241. NameContext *pNC; /* Naming context */
  15242. int n; /* A counter */
  15243. int iCur; /* A cursor number */
  15244. SrcList *pSrcList; /* FROM clause */
  15245. struct SrcCount *pSrcCount; /* Counting column references */
  15246. struct CCurHint *pCCurHint; /* Used by codeCursorHint() */
  15247. int *aiCol; /* array of column indexes */
  15248. struct IdxCover *pIdxCover; /* Check for index coverage */
  15249. } u;
  15250. };
  15251. /* Forward declarations */
  15252. SQLITE_PRIVATE int sqlite3WalkExpr(Walker*, Expr*);
  15253. SQLITE_PRIVATE int sqlite3WalkExprList(Walker*, ExprList*);
  15254. SQLITE_PRIVATE int sqlite3WalkSelect(Walker*, Select*);
  15255. SQLITE_PRIVATE int sqlite3WalkSelectExpr(Walker*, Select*);
  15256. SQLITE_PRIVATE int sqlite3WalkSelectFrom(Walker*, Select*);
  15257. SQLITE_PRIVATE int sqlite3ExprWalkNoop(Walker*, Expr*);
  15258. /*
  15259. ** Return code from the parse-tree walking primitives and their
  15260. ** callbacks.
  15261. */
  15262. #define WRC_Continue 0 /* Continue down into children */
  15263. #define WRC_Prune 1 /* Omit children but continue walking siblings */
  15264. #define WRC_Abort 2 /* Abandon the tree walk */
  15265. /*
  15266. ** An instance of this structure represents a set of one or more CTEs
  15267. ** (common table expressions) created by a single WITH clause.
  15268. */
  15269. struct With {
  15270. int nCte; /* Number of CTEs in the WITH clause */
  15271. With *pOuter; /* Containing WITH clause, or NULL */
  15272. struct Cte { /* For each CTE in the WITH clause.... */
  15273. char *zName; /* Name of this CTE */
  15274. ExprList *pCols; /* List of explicit column names, or NULL */
  15275. Select *pSelect; /* The definition of this CTE */
  15276. const char *zCteErr; /* Error message for circular references */
  15277. } a[1];
  15278. };
  15279. #ifdef SQLITE_DEBUG
  15280. /*
  15281. ** An instance of the TreeView object is used for printing the content of
  15282. ** data structures on sqlite3DebugPrintf() using a tree-like view.
  15283. */
  15284. struct TreeView {
  15285. int iLevel; /* Which level of the tree we are on */
  15286. u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */
  15287. };
  15288. #endif /* SQLITE_DEBUG */
  15289. /*
  15290. ** Assuming zIn points to the first byte of a UTF-8 character,
  15291. ** advance zIn to point to the first byte of the next UTF-8 character.
  15292. */
  15293. #define SQLITE_SKIP_UTF8(zIn) { \
  15294. if( (*(zIn++))>=0xc0 ){ \
  15295. while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
  15296. } \
  15297. }
  15298. /*
  15299. ** The SQLITE_*_BKPT macros are substitutes for the error codes with
  15300. ** the same name but without the _BKPT suffix. These macros invoke
  15301. ** routines that report the line-number on which the error originated
  15302. ** using sqlite3_log(). The routines also provide a convenient place
  15303. ** to set a debugger breakpoint.
  15304. */
  15305. SQLITE_PRIVATE int sqlite3CorruptError(int);
  15306. SQLITE_PRIVATE int sqlite3MisuseError(int);
  15307. SQLITE_PRIVATE int sqlite3CantopenError(int);
  15308. #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
  15309. #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
  15310. #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
  15311. #ifdef SQLITE_DEBUG
  15312. SQLITE_PRIVATE int sqlite3NomemError(int);
  15313. SQLITE_PRIVATE int sqlite3IoerrnomemError(int);
  15314. # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
  15315. # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
  15316. #else
  15317. # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
  15318. # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
  15319. #endif
  15320. /*
  15321. ** FTS3 and FTS4 both require virtual table support
  15322. */
  15323. #if defined(SQLITE_OMIT_VIRTUALTABLE)
  15324. # undef SQLITE_ENABLE_FTS3
  15325. # undef SQLITE_ENABLE_FTS4
  15326. #endif
  15327. /*
  15328. ** FTS4 is really an extension for FTS3. It is enabled using the
  15329. ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call
  15330. ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
  15331. */
  15332. #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
  15333. # define SQLITE_ENABLE_FTS3 1
  15334. #endif
  15335. /*
  15336. ** The ctype.h header is needed for non-ASCII systems. It is also
  15337. ** needed by FTS3 when FTS3 is included in the amalgamation.
  15338. */
  15339. #if !defined(SQLITE_ASCII) || \
  15340. (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
  15341. # include <ctype.h>
  15342. #endif
  15343. /*
  15344. ** The following macros mimic the standard library functions toupper(),
  15345. ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
  15346. ** sqlite versions only work for ASCII characters, regardless of locale.
  15347. */
  15348. #ifdef SQLITE_ASCII
  15349. # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
  15350. # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
  15351. # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
  15352. # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
  15353. # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
  15354. # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
  15355. # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
  15356. # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
  15357. #else
  15358. # define sqlite3Toupper(x) toupper((unsigned char)(x))
  15359. # define sqlite3Isspace(x) isspace((unsigned char)(x))
  15360. # define sqlite3Isalnum(x) isalnum((unsigned char)(x))
  15361. # define sqlite3Isalpha(x) isalpha((unsigned char)(x))
  15362. # define sqlite3Isdigit(x) isdigit((unsigned char)(x))
  15363. # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
  15364. # define sqlite3Tolower(x) tolower((unsigned char)(x))
  15365. # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
  15366. #endif
  15367. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  15368. SQLITE_PRIVATE int sqlite3IsIdChar(u8);
  15369. #endif
  15370. /*
  15371. ** Internal function prototypes
  15372. */
  15373. SQLITE_PRIVATE int sqlite3StrICmp(const char*,const char*);
  15374. SQLITE_PRIVATE int sqlite3Strlen30(const char*);
  15375. SQLITE_PRIVATE char *sqlite3ColumnType(Column*,char*);
  15376. #define sqlite3StrNICmp sqlite3_strnicmp
  15377. SQLITE_PRIVATE int sqlite3MallocInit(void);
  15378. SQLITE_PRIVATE void sqlite3MallocEnd(void);
  15379. SQLITE_PRIVATE void *sqlite3Malloc(u64);
  15380. SQLITE_PRIVATE void *sqlite3MallocZero(u64);
  15381. SQLITE_PRIVATE void *sqlite3DbMallocZero(sqlite3*, u64);
  15382. SQLITE_PRIVATE void *sqlite3DbMallocRaw(sqlite3*, u64);
  15383. SQLITE_PRIVATE void *sqlite3DbMallocRawNN(sqlite3*, u64);
  15384. SQLITE_PRIVATE char *sqlite3DbStrDup(sqlite3*,const char*);
  15385. SQLITE_PRIVATE char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
  15386. SQLITE_PRIVATE void *sqlite3Realloc(void*, u64);
  15387. SQLITE_PRIVATE void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
  15388. SQLITE_PRIVATE void *sqlite3DbRealloc(sqlite3 *, void *, u64);
  15389. SQLITE_PRIVATE void sqlite3DbFree(sqlite3*, void*);
  15390. SQLITE_PRIVATE int sqlite3MallocSize(void*);
  15391. SQLITE_PRIVATE int sqlite3DbMallocSize(sqlite3*, void*);
  15392. SQLITE_PRIVATE void *sqlite3ScratchMalloc(int);
  15393. SQLITE_PRIVATE void sqlite3ScratchFree(void*);
  15394. SQLITE_PRIVATE void *sqlite3PageMalloc(int);
  15395. SQLITE_PRIVATE void sqlite3PageFree(void*);
  15396. SQLITE_PRIVATE void sqlite3MemSetDefault(void);
  15397. #ifndef SQLITE_OMIT_BUILTIN_TEST
  15398. SQLITE_PRIVATE void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
  15399. #endif
  15400. SQLITE_PRIVATE int sqlite3HeapNearlyFull(void);
  15401. /*
  15402. ** On systems with ample stack space and that support alloca(), make
  15403. ** use of alloca() to obtain space for large automatic objects. By default,
  15404. ** obtain space from malloc().
  15405. **
  15406. ** The alloca() routine never returns NULL. This will cause code paths
  15407. ** that deal with sqlite3StackAlloc() failures to be unreachable.
  15408. */
  15409. #ifdef SQLITE_USE_ALLOCA
  15410. # define sqlite3StackAllocRaw(D,N) alloca(N)
  15411. # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N)
  15412. # define sqlite3StackFree(D,P)
  15413. #else
  15414. # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N)
  15415. # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N)
  15416. # define sqlite3StackFree(D,P) sqlite3DbFree(D,P)
  15417. #endif
  15418. /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they
  15419. ** are, disable MEMSYS3
  15420. */
  15421. #ifdef SQLITE_ENABLE_MEMSYS5
  15422. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
  15423. #undef SQLITE_ENABLE_MEMSYS3
  15424. #endif
  15425. #ifdef SQLITE_ENABLE_MEMSYS3
  15426. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
  15427. #endif
  15428. #ifndef SQLITE_MUTEX_OMIT
  15429. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
  15430. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void);
  15431. SQLITE_PRIVATE sqlite3_mutex *sqlite3MutexAlloc(int);
  15432. SQLITE_PRIVATE int sqlite3MutexInit(void);
  15433. SQLITE_PRIVATE int sqlite3MutexEnd(void);
  15434. #endif
  15435. #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
  15436. SQLITE_PRIVATE void sqlite3MemoryBarrier(void);
  15437. #else
  15438. # define sqlite3MemoryBarrier()
  15439. #endif
  15440. SQLITE_PRIVATE sqlite3_int64 sqlite3StatusValue(int);
  15441. SQLITE_PRIVATE void sqlite3StatusUp(int, int);
  15442. SQLITE_PRIVATE void sqlite3StatusDown(int, int);
  15443. SQLITE_PRIVATE void sqlite3StatusHighwater(int, int);
  15444. /* Access to mutexes used by sqlite3_status() */
  15445. SQLITE_PRIVATE sqlite3_mutex *sqlite3Pcache1Mutex(void);
  15446. SQLITE_PRIVATE sqlite3_mutex *sqlite3MallocMutex(void);
  15447. #ifndef SQLITE_OMIT_FLOATING_POINT
  15448. SQLITE_PRIVATE int sqlite3IsNaN(double);
  15449. #else
  15450. # define sqlite3IsNaN(X) 0
  15451. #endif
  15452. /*
  15453. ** An instance of the following structure holds information about SQL
  15454. ** functions arguments that are the parameters to the printf() function.
  15455. */
  15456. struct PrintfArguments {
  15457. int nArg; /* Total number of arguments */
  15458. int nUsed; /* Number of arguments used so far */
  15459. sqlite3_value **apArg; /* The argument values */
  15460. };
  15461. SQLITE_PRIVATE void sqlite3VXPrintf(StrAccum*, const char*, va_list);
  15462. SQLITE_PRIVATE void sqlite3XPrintf(StrAccum*, const char*, ...);
  15463. SQLITE_PRIVATE char *sqlite3MPrintf(sqlite3*,const char*, ...);
  15464. SQLITE_PRIVATE char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
  15465. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  15466. SQLITE_PRIVATE void sqlite3DebugPrintf(const char*, ...);
  15467. #endif
  15468. #if defined(SQLITE_TEST)
  15469. SQLITE_PRIVATE void *sqlite3TestTextToPtr(const char*);
  15470. #endif
  15471. #if defined(SQLITE_DEBUG)
  15472. SQLITE_PRIVATE void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
  15473. SQLITE_PRIVATE void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*);
  15474. SQLITE_PRIVATE void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
  15475. SQLITE_PRIVATE void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
  15476. SQLITE_PRIVATE void sqlite3TreeViewWith(TreeView*, const With*, u8);
  15477. #endif
  15478. SQLITE_PRIVATE void sqlite3SetString(char **, sqlite3*, const char*);
  15479. SQLITE_PRIVATE void sqlite3ErrorMsg(Parse*, const char*, ...);
  15480. SQLITE_PRIVATE void sqlite3Dequote(char*);
  15481. SQLITE_PRIVATE void sqlite3TokenInit(Token*,char*);
  15482. SQLITE_PRIVATE int sqlite3KeywordCode(const unsigned char*, int);
  15483. SQLITE_PRIVATE int sqlite3RunParser(Parse*, const char*, char **);
  15484. SQLITE_PRIVATE void sqlite3FinishCoding(Parse*);
  15485. SQLITE_PRIVATE int sqlite3GetTempReg(Parse*);
  15486. SQLITE_PRIVATE void sqlite3ReleaseTempReg(Parse*,int);
  15487. SQLITE_PRIVATE int sqlite3GetTempRange(Parse*,int);
  15488. SQLITE_PRIVATE void sqlite3ReleaseTempRange(Parse*,int,int);
  15489. SQLITE_PRIVATE void sqlite3ClearTempRegCache(Parse*);
  15490. #ifdef SQLITE_DEBUG
  15491. SQLITE_PRIVATE int sqlite3NoTempsInRange(Parse*,int,int);
  15492. #endif
  15493. SQLITE_PRIVATE Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
  15494. SQLITE_PRIVATE Expr *sqlite3Expr(sqlite3*,int,const char*);
  15495. SQLITE_PRIVATE void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
  15496. SQLITE_PRIVATE Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
  15497. SQLITE_PRIVATE void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
  15498. SQLITE_PRIVATE Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
  15499. SQLITE_PRIVATE Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
  15500. SQLITE_PRIVATE void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32);
  15501. SQLITE_PRIVATE void sqlite3ExprDelete(sqlite3*, Expr*);
  15502. SQLITE_PRIVATE ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
  15503. SQLITE_PRIVATE ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*);
  15504. SQLITE_PRIVATE void sqlite3ExprListSetSortOrder(ExprList*,int);
  15505. SQLITE_PRIVATE void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
  15506. SQLITE_PRIVATE void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
  15507. SQLITE_PRIVATE void sqlite3ExprListDelete(sqlite3*, ExprList*);
  15508. SQLITE_PRIVATE u32 sqlite3ExprListFlags(const ExprList*);
  15509. SQLITE_PRIVATE int sqlite3Init(sqlite3*, char**);
  15510. SQLITE_PRIVATE int sqlite3InitCallback(void*, int, char**, char**);
  15511. SQLITE_PRIVATE void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
  15512. SQLITE_PRIVATE void sqlite3ResetAllSchemasOfConnection(sqlite3*);
  15513. SQLITE_PRIVATE void sqlite3ResetOneSchema(sqlite3*,int);
  15514. SQLITE_PRIVATE void sqlite3CollapseDatabaseArray(sqlite3*);
  15515. SQLITE_PRIVATE void sqlite3CommitInternalChanges(sqlite3*);
  15516. SQLITE_PRIVATE void sqlite3DeleteColumnNames(sqlite3*,Table*);
  15517. SQLITE_PRIVATE int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
  15518. SQLITE_PRIVATE void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*);
  15519. SQLITE_PRIVATE Table *sqlite3ResultSetOfSelect(Parse*,Select*);
  15520. SQLITE_PRIVATE void sqlite3OpenMasterTable(Parse *, int);
  15521. SQLITE_PRIVATE Index *sqlite3PrimaryKeyIndex(Table*);
  15522. SQLITE_PRIVATE i16 sqlite3ColumnOfIndex(Index*, i16);
  15523. SQLITE_PRIVATE void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
  15524. #if SQLITE_ENABLE_HIDDEN_COLUMNS
  15525. SQLITE_PRIVATE void sqlite3ColumnPropertiesFromName(Table*, Column*);
  15526. #else
  15527. # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
  15528. #endif
  15529. SQLITE_PRIVATE void sqlite3AddColumn(Parse*,Token*,Token*);
  15530. SQLITE_PRIVATE void sqlite3AddNotNull(Parse*, int);
  15531. SQLITE_PRIVATE void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
  15532. SQLITE_PRIVATE void sqlite3AddCheckConstraint(Parse*, Expr*);
  15533. SQLITE_PRIVATE void sqlite3AddDefaultValue(Parse*,ExprSpan*);
  15534. SQLITE_PRIVATE void sqlite3AddCollateType(Parse*, Token*);
  15535. SQLITE_PRIVATE void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
  15536. SQLITE_PRIVATE int sqlite3ParseUri(const char*,const char*,unsigned int*,
  15537. sqlite3_vfs**,char**,char **);
  15538. SQLITE_PRIVATE Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
  15539. #ifdef SQLITE_OMIT_BUILTIN_TEST
  15540. # define sqlite3FaultSim(X) SQLITE_OK
  15541. #else
  15542. SQLITE_PRIVATE int sqlite3FaultSim(int);
  15543. #endif
  15544. SQLITE_PRIVATE Bitvec *sqlite3BitvecCreate(u32);
  15545. SQLITE_PRIVATE int sqlite3BitvecTest(Bitvec*, u32);
  15546. SQLITE_PRIVATE int sqlite3BitvecTestNotNull(Bitvec*, u32);
  15547. SQLITE_PRIVATE int sqlite3BitvecSet(Bitvec*, u32);
  15548. SQLITE_PRIVATE void sqlite3BitvecClear(Bitvec*, u32, void*);
  15549. SQLITE_PRIVATE void sqlite3BitvecDestroy(Bitvec*);
  15550. SQLITE_PRIVATE u32 sqlite3BitvecSize(Bitvec*);
  15551. #ifndef SQLITE_OMIT_BUILTIN_TEST
  15552. SQLITE_PRIVATE int sqlite3BitvecBuiltinTest(int,int*);
  15553. #endif
  15554. SQLITE_PRIVATE RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
  15555. SQLITE_PRIVATE void sqlite3RowSetClear(RowSet*);
  15556. SQLITE_PRIVATE void sqlite3RowSetInsert(RowSet*, i64);
  15557. SQLITE_PRIVATE int sqlite3RowSetTest(RowSet*, int iBatch, i64);
  15558. SQLITE_PRIVATE int sqlite3RowSetNext(RowSet*, i64*);
  15559. SQLITE_PRIVATE void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
  15560. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  15561. SQLITE_PRIVATE int sqlite3ViewGetColumnNames(Parse*,Table*);
  15562. #else
  15563. # define sqlite3ViewGetColumnNames(A,B) 0
  15564. #endif
  15565. #if SQLITE_MAX_ATTACHED>30
  15566. SQLITE_PRIVATE int sqlite3DbMaskAllZero(yDbMask);
  15567. #endif
  15568. SQLITE_PRIVATE void sqlite3DropTable(Parse*, SrcList*, int, int);
  15569. SQLITE_PRIVATE void sqlite3CodeDropTable(Parse*, Table*, int, int);
  15570. SQLITE_PRIVATE void sqlite3DeleteTable(sqlite3*, Table*);
  15571. #ifndef SQLITE_OMIT_AUTOINCREMENT
  15572. SQLITE_PRIVATE void sqlite3AutoincrementBegin(Parse *pParse);
  15573. SQLITE_PRIVATE void sqlite3AutoincrementEnd(Parse *pParse);
  15574. #else
  15575. # define sqlite3AutoincrementBegin(X)
  15576. # define sqlite3AutoincrementEnd(X)
  15577. #endif
  15578. SQLITE_PRIVATE void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int);
  15579. SQLITE_PRIVATE void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
  15580. SQLITE_PRIVATE IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
  15581. SQLITE_PRIVATE int sqlite3IdListIndex(IdList*,const char*);
  15582. SQLITE_PRIVATE SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
  15583. SQLITE_PRIVATE SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
  15584. SQLITE_PRIVATE SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
  15585. Token*, Select*, Expr*, IdList*);
  15586. SQLITE_PRIVATE void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
  15587. SQLITE_PRIVATE void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
  15588. SQLITE_PRIVATE int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
  15589. SQLITE_PRIVATE void sqlite3SrcListShiftJoinType(SrcList*);
  15590. SQLITE_PRIVATE void sqlite3SrcListAssignCursors(Parse*, SrcList*);
  15591. SQLITE_PRIVATE void sqlite3IdListDelete(sqlite3*, IdList*);
  15592. SQLITE_PRIVATE void sqlite3SrcListDelete(sqlite3*, SrcList*);
  15593. SQLITE_PRIVATE Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
  15594. SQLITE_PRIVATE void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
  15595. Expr*, int, int, u8);
  15596. SQLITE_PRIVATE void sqlite3DropIndex(Parse*, SrcList*, int);
  15597. SQLITE_PRIVATE int sqlite3Select(Parse*, Select*, SelectDest*);
  15598. SQLITE_PRIVATE Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
  15599. Expr*,ExprList*,u32,Expr*,Expr*);
  15600. SQLITE_PRIVATE void sqlite3SelectDelete(sqlite3*, Select*);
  15601. SQLITE_PRIVATE Table *sqlite3SrcListLookup(Parse*, SrcList*);
  15602. SQLITE_PRIVATE int sqlite3IsReadOnly(Parse*, Table*, int);
  15603. SQLITE_PRIVATE void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
  15604. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  15605. SQLITE_PRIVATE Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*);
  15606. #endif
  15607. SQLITE_PRIVATE void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
  15608. SQLITE_PRIVATE void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
  15609. SQLITE_PRIVATE WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
  15610. SQLITE_PRIVATE void sqlite3WhereEnd(WhereInfo*);
  15611. SQLITE_PRIVATE LogEst sqlite3WhereOutputRowCount(WhereInfo*);
  15612. SQLITE_PRIVATE int sqlite3WhereIsDistinct(WhereInfo*);
  15613. SQLITE_PRIVATE int sqlite3WhereIsOrdered(WhereInfo*);
  15614. SQLITE_PRIVATE int sqlite3WhereOrderedInnerLoop(WhereInfo*);
  15615. SQLITE_PRIVATE int sqlite3WhereIsSorted(WhereInfo*);
  15616. SQLITE_PRIVATE int sqlite3WhereContinueLabel(WhereInfo*);
  15617. SQLITE_PRIVATE int sqlite3WhereBreakLabel(WhereInfo*);
  15618. SQLITE_PRIVATE int sqlite3WhereOkOnePass(WhereInfo*, int*);
  15619. #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */
  15620. #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */
  15621. #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */
  15622. SQLITE_PRIVATE void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
  15623. SQLITE_PRIVATE int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
  15624. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnToReg(Parse*, Table*, int, int, int);
  15625. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
  15626. SQLITE_PRIVATE void sqlite3ExprCodeMove(Parse*, int, int, int);
  15627. SQLITE_PRIVATE void sqlite3ExprCacheStore(Parse*, int, int, int);
  15628. SQLITE_PRIVATE void sqlite3ExprCachePush(Parse*);
  15629. SQLITE_PRIVATE void sqlite3ExprCachePop(Parse*);
  15630. SQLITE_PRIVATE void sqlite3ExprCacheRemove(Parse*, int, int);
  15631. SQLITE_PRIVATE void sqlite3ExprCacheClear(Parse*);
  15632. SQLITE_PRIVATE void sqlite3ExprCacheAffinityChange(Parse*, int, int);
  15633. SQLITE_PRIVATE void sqlite3ExprCode(Parse*, Expr*, int);
  15634. SQLITE_PRIVATE void sqlite3ExprCodeCopy(Parse*, Expr*, int);
  15635. SQLITE_PRIVATE void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
  15636. SQLITE_PRIVATE void sqlite3ExprCodeAtInit(Parse*, Expr*, int, u8);
  15637. SQLITE_PRIVATE int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
  15638. SQLITE_PRIVATE int sqlite3ExprCodeTarget(Parse*, Expr*, int);
  15639. SQLITE_PRIVATE void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
  15640. SQLITE_PRIVATE int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
  15641. #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */
  15642. #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */
  15643. #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */
  15644. SQLITE_PRIVATE void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
  15645. SQLITE_PRIVATE void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
  15646. SQLITE_PRIVATE void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
  15647. SQLITE_PRIVATE Table *sqlite3FindTable(sqlite3*,const char*, const char*);
  15648. #define LOCATE_VIEW 0x01
  15649. #define LOCATE_NOERR 0x02
  15650. SQLITE_PRIVATE Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*);
  15651. SQLITE_PRIVATE Table *sqlite3LocateTableItem(Parse*,u32 flags,struct SrcList_item *);
  15652. SQLITE_PRIVATE Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
  15653. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
  15654. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
  15655. SQLITE_PRIVATE void sqlite3Vacuum(Parse*,Token*);
  15656. SQLITE_PRIVATE int sqlite3RunVacuum(char**, sqlite3*, int);
  15657. SQLITE_PRIVATE char *sqlite3NameFromToken(sqlite3*, Token*);
  15658. SQLITE_PRIVATE int sqlite3ExprCompare(Expr*, Expr*, int);
  15659. SQLITE_PRIVATE int sqlite3ExprListCompare(ExprList*, ExprList*, int);
  15660. SQLITE_PRIVATE int sqlite3ExprImpliesExpr(Expr*, Expr*, int);
  15661. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
  15662. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
  15663. SQLITE_PRIVATE int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx);
  15664. SQLITE_PRIVATE int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
  15665. SQLITE_PRIVATE Vdbe *sqlite3GetVdbe(Parse*);
  15666. #ifndef SQLITE_OMIT_BUILTIN_TEST
  15667. SQLITE_PRIVATE void sqlite3PrngSaveState(void);
  15668. SQLITE_PRIVATE void sqlite3PrngRestoreState(void);
  15669. #endif
  15670. SQLITE_PRIVATE void sqlite3RollbackAll(sqlite3*,int);
  15671. SQLITE_PRIVATE void sqlite3CodeVerifySchema(Parse*, int);
  15672. SQLITE_PRIVATE void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
  15673. SQLITE_PRIVATE void sqlite3BeginTransaction(Parse*, int);
  15674. SQLITE_PRIVATE void sqlite3CommitTransaction(Parse*);
  15675. SQLITE_PRIVATE void sqlite3RollbackTransaction(Parse*);
  15676. SQLITE_PRIVATE void sqlite3Savepoint(Parse*, int, Token*);
  15677. SQLITE_PRIVATE void sqlite3CloseSavepoints(sqlite3 *);
  15678. SQLITE_PRIVATE void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
  15679. SQLITE_PRIVATE int sqlite3ExprIsConstant(Expr*);
  15680. SQLITE_PRIVATE int sqlite3ExprIsConstantNotJoin(Expr*);
  15681. SQLITE_PRIVATE int sqlite3ExprIsConstantOrFunction(Expr*, u8);
  15682. SQLITE_PRIVATE int sqlite3ExprIsTableConstant(Expr*,int);
  15683. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  15684. SQLITE_PRIVATE int sqlite3ExprContainsSubquery(Expr*);
  15685. #endif
  15686. SQLITE_PRIVATE int sqlite3ExprIsInteger(Expr*, int*);
  15687. SQLITE_PRIVATE int sqlite3ExprCanBeNull(const Expr*);
  15688. SQLITE_PRIVATE int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
  15689. SQLITE_PRIVATE int sqlite3IsRowid(const char*);
  15690. SQLITE_PRIVATE void sqlite3GenerateRowDelete(
  15691. Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
  15692. SQLITE_PRIVATE void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
  15693. SQLITE_PRIVATE int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
  15694. SQLITE_PRIVATE void sqlite3ResolvePartIdxLabel(Parse*,int);
  15695. SQLITE_PRIVATE void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
  15696. u8,u8,int,int*,int*);
  15697. SQLITE_PRIVATE void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
  15698. SQLITE_PRIVATE int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
  15699. SQLITE_PRIVATE void sqlite3BeginWriteOperation(Parse*, int, int);
  15700. SQLITE_PRIVATE void sqlite3MultiWrite(Parse*);
  15701. SQLITE_PRIVATE void sqlite3MayAbort(Parse*);
  15702. SQLITE_PRIVATE void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
  15703. SQLITE_PRIVATE void sqlite3UniqueConstraint(Parse*, int, Index*);
  15704. SQLITE_PRIVATE void sqlite3RowidConstraint(Parse*, int, Table*);
  15705. SQLITE_PRIVATE Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
  15706. SQLITE_PRIVATE ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
  15707. SQLITE_PRIVATE SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
  15708. SQLITE_PRIVATE IdList *sqlite3IdListDup(sqlite3*,IdList*);
  15709. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3*,Select*,int);
  15710. #if SELECTTRACE_ENABLED
  15711. SQLITE_PRIVATE void sqlite3SelectSetName(Select*,const char*);
  15712. #else
  15713. # define sqlite3SelectSetName(A,B)
  15714. #endif
  15715. SQLITE_PRIVATE void sqlite3InsertBuiltinFuncs(FuncDef*,int);
  15716. SQLITE_PRIVATE FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
  15717. SQLITE_PRIVATE void sqlite3RegisterBuiltinFunctions(void);
  15718. SQLITE_PRIVATE void sqlite3RegisterDateTimeFunctions(void);
  15719. SQLITE_PRIVATE void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
  15720. SQLITE_PRIVATE int sqlite3SafetyCheckOk(sqlite3*);
  15721. SQLITE_PRIVATE int sqlite3SafetyCheckSickOrOk(sqlite3*);
  15722. SQLITE_PRIVATE void sqlite3ChangeCookie(Parse*, int);
  15723. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  15724. SQLITE_PRIVATE void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
  15725. #endif
  15726. #ifndef SQLITE_OMIT_TRIGGER
  15727. SQLITE_PRIVATE void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
  15728. Expr*,int, int);
  15729. SQLITE_PRIVATE void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
  15730. SQLITE_PRIVATE void sqlite3DropTrigger(Parse*, SrcList*, int);
  15731. SQLITE_PRIVATE void sqlite3DropTriggerPtr(Parse*, Trigger*);
  15732. SQLITE_PRIVATE Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
  15733. SQLITE_PRIVATE Trigger *sqlite3TriggerList(Parse *, Table *);
  15734. SQLITE_PRIVATE void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
  15735. int, int, int);
  15736. SQLITE_PRIVATE void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
  15737. void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
  15738. SQLITE_PRIVATE void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
  15739. SQLITE_PRIVATE TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
  15740. SQLITE_PRIVATE TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
  15741. Select*,u8);
  15742. SQLITE_PRIVATE TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
  15743. SQLITE_PRIVATE TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
  15744. SQLITE_PRIVATE void sqlite3DeleteTrigger(sqlite3*, Trigger*);
  15745. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
  15746. SQLITE_PRIVATE u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
  15747. # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
  15748. # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
  15749. #else
  15750. # define sqlite3TriggersExist(B,C,D,E,F) 0
  15751. # define sqlite3DeleteTrigger(A,B)
  15752. # define sqlite3DropTriggerPtr(A,B)
  15753. # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
  15754. # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
  15755. # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
  15756. # define sqlite3TriggerList(X, Y) 0
  15757. # define sqlite3ParseToplevel(p) p
  15758. # define sqlite3IsToplevel(p) 1
  15759. # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
  15760. #endif
  15761. SQLITE_PRIVATE int sqlite3JoinType(Parse*, Token*, Token*, Token*);
  15762. SQLITE_PRIVATE void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
  15763. SQLITE_PRIVATE void sqlite3DeferForeignKey(Parse*, int);
  15764. #ifndef SQLITE_OMIT_AUTHORIZATION
  15765. SQLITE_PRIVATE void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
  15766. SQLITE_PRIVATE int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
  15767. SQLITE_PRIVATE void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
  15768. SQLITE_PRIVATE void sqlite3AuthContextPop(AuthContext*);
  15769. SQLITE_PRIVATE int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
  15770. #else
  15771. # define sqlite3AuthRead(a,b,c,d)
  15772. # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
  15773. # define sqlite3AuthContextPush(a,b,c)
  15774. # define sqlite3AuthContextPop(a) ((void)(a))
  15775. #endif
  15776. SQLITE_PRIVATE void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
  15777. SQLITE_PRIVATE void sqlite3Detach(Parse*, Expr*);
  15778. SQLITE_PRIVATE void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
  15779. SQLITE_PRIVATE int sqlite3FixSrcList(DbFixer*, SrcList*);
  15780. SQLITE_PRIVATE int sqlite3FixSelect(DbFixer*, Select*);
  15781. SQLITE_PRIVATE int sqlite3FixExpr(DbFixer*, Expr*);
  15782. SQLITE_PRIVATE int sqlite3FixExprList(DbFixer*, ExprList*);
  15783. SQLITE_PRIVATE int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
  15784. SQLITE_PRIVATE int sqlite3AtoF(const char *z, double*, int, u8);
  15785. SQLITE_PRIVATE int sqlite3GetInt32(const char *, int*);
  15786. SQLITE_PRIVATE int sqlite3Atoi(const char*);
  15787. SQLITE_PRIVATE int sqlite3Utf16ByteLen(const void *pData, int nChar);
  15788. SQLITE_PRIVATE int sqlite3Utf8CharLen(const char *pData, int nByte);
  15789. SQLITE_PRIVATE u32 sqlite3Utf8Read(const u8**);
  15790. SQLITE_PRIVATE LogEst sqlite3LogEst(u64);
  15791. SQLITE_PRIVATE LogEst sqlite3LogEstAdd(LogEst,LogEst);
  15792. #ifndef SQLITE_OMIT_VIRTUALTABLE
  15793. SQLITE_PRIVATE LogEst sqlite3LogEstFromDouble(double);
  15794. #endif
  15795. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  15796. defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
  15797. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  15798. SQLITE_PRIVATE u64 sqlite3LogEstToInt(LogEst);
  15799. #endif
  15800. /*
  15801. ** Routines to read and write variable-length integers. These used to
  15802. ** be defined locally, but now we use the varint routines in the util.c
  15803. ** file.
  15804. */
  15805. SQLITE_PRIVATE int sqlite3PutVarint(unsigned char*, u64);
  15806. SQLITE_PRIVATE u8 sqlite3GetVarint(const unsigned char *, u64 *);
  15807. SQLITE_PRIVATE u8 sqlite3GetVarint32(const unsigned char *, u32 *);
  15808. SQLITE_PRIVATE int sqlite3VarintLen(u64 v);
  15809. /*
  15810. ** The common case is for a varint to be a single byte. They following
  15811. ** macros handle the common case without a procedure call, but then call
  15812. ** the procedure for larger varints.
  15813. */
  15814. #define getVarint32(A,B) \
  15815. (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
  15816. #define putVarint32(A,B) \
  15817. (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
  15818. sqlite3PutVarint((A),(B)))
  15819. #define getVarint sqlite3GetVarint
  15820. #define putVarint sqlite3PutVarint
  15821. SQLITE_PRIVATE const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
  15822. SQLITE_PRIVATE void sqlite3TableAffinity(Vdbe*, Table*, int);
  15823. SQLITE_PRIVATE char sqlite3CompareAffinity(Expr *pExpr, char aff2);
  15824. SQLITE_PRIVATE int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
  15825. SQLITE_PRIVATE char sqlite3TableColumnAffinity(Table*,int);
  15826. SQLITE_PRIVATE char sqlite3ExprAffinity(Expr *pExpr);
  15827. SQLITE_PRIVATE int sqlite3Atoi64(const char*, i64*, int, u8);
  15828. SQLITE_PRIVATE int sqlite3DecOrHexToI64(const char*, i64*);
  15829. SQLITE_PRIVATE void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
  15830. SQLITE_PRIVATE void sqlite3Error(sqlite3*,int);
  15831. SQLITE_PRIVATE void sqlite3SystemError(sqlite3*,int);
  15832. SQLITE_PRIVATE void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
  15833. SQLITE_PRIVATE u8 sqlite3HexToInt(int h);
  15834. SQLITE_PRIVATE int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
  15835. #if defined(SQLITE_NEED_ERR_NAME)
  15836. SQLITE_PRIVATE const char *sqlite3ErrName(int);
  15837. #endif
  15838. SQLITE_PRIVATE const char *sqlite3ErrStr(int);
  15839. SQLITE_PRIVATE int sqlite3ReadSchema(Parse *pParse);
  15840. SQLITE_PRIVATE CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
  15841. SQLITE_PRIVATE CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
  15842. SQLITE_PRIVATE CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
  15843. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
  15844. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
  15845. SQLITE_PRIVATE Expr *sqlite3ExprSkipCollate(Expr*);
  15846. SQLITE_PRIVATE int sqlite3CheckCollSeq(Parse *, CollSeq *);
  15847. SQLITE_PRIVATE int sqlite3CheckObjectName(Parse *, const char *);
  15848. SQLITE_PRIVATE void sqlite3VdbeSetChanges(sqlite3 *, int);
  15849. SQLITE_PRIVATE int sqlite3AddInt64(i64*,i64);
  15850. SQLITE_PRIVATE int sqlite3SubInt64(i64*,i64);
  15851. SQLITE_PRIVATE int sqlite3MulInt64(i64*,i64);
  15852. SQLITE_PRIVATE int sqlite3AbsInt32(int);
  15853. #ifdef SQLITE_ENABLE_8_3_NAMES
  15854. SQLITE_PRIVATE void sqlite3FileSuffix3(const char*, char*);
  15855. #else
  15856. # define sqlite3FileSuffix3(X,Y)
  15857. #endif
  15858. SQLITE_PRIVATE u8 sqlite3GetBoolean(const char *z,u8);
  15859. SQLITE_PRIVATE const void *sqlite3ValueText(sqlite3_value*, u8);
  15860. SQLITE_PRIVATE int sqlite3ValueBytes(sqlite3_value*, u8);
  15861. SQLITE_PRIVATE void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
  15862. void(*)(void*));
  15863. SQLITE_PRIVATE void sqlite3ValueSetNull(sqlite3_value*);
  15864. SQLITE_PRIVATE void sqlite3ValueFree(sqlite3_value*);
  15865. SQLITE_PRIVATE sqlite3_value *sqlite3ValueNew(sqlite3 *);
  15866. SQLITE_PRIVATE char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
  15867. SQLITE_PRIVATE int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
  15868. SQLITE_PRIVATE void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
  15869. #ifndef SQLITE_AMALGAMATION
  15870. SQLITE_PRIVATE const unsigned char sqlite3OpcodeProperty[];
  15871. SQLITE_PRIVATE const char sqlite3StrBINARY[];
  15872. SQLITE_PRIVATE const unsigned char sqlite3UpperToLower[];
  15873. SQLITE_PRIVATE const unsigned char sqlite3CtypeMap[];
  15874. SQLITE_PRIVATE const Token sqlite3IntTokens[];
  15875. SQLITE_PRIVATE SQLITE_WSD struct Sqlite3Config sqlite3Config;
  15876. SQLITE_PRIVATE FuncDefHash sqlite3BuiltinFunctions;
  15877. #ifndef SQLITE_OMIT_WSD
  15878. SQLITE_PRIVATE int sqlite3PendingByte;
  15879. #endif
  15880. #endif
  15881. SQLITE_PRIVATE void sqlite3RootPageMoved(sqlite3*, int, int, int);
  15882. SQLITE_PRIVATE void sqlite3Reindex(Parse*, Token*, Token*);
  15883. SQLITE_PRIVATE void sqlite3AlterFunctions(void);
  15884. SQLITE_PRIVATE void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
  15885. SQLITE_PRIVATE int sqlite3GetToken(const unsigned char *, int *);
  15886. SQLITE_PRIVATE void sqlite3NestedParse(Parse*, const char*, ...);
  15887. SQLITE_PRIVATE void sqlite3ExpirePreparedStatements(sqlite3*);
  15888. SQLITE_PRIVATE int sqlite3CodeSubselect(Parse*, Expr *, int, int);
  15889. SQLITE_PRIVATE void sqlite3SelectPrep(Parse*, Select*, NameContext*);
  15890. SQLITE_PRIVATE void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
  15891. SQLITE_PRIVATE int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
  15892. SQLITE_PRIVATE int sqlite3ResolveExprNames(NameContext*, Expr*);
  15893. SQLITE_PRIVATE int sqlite3ResolveExprListNames(NameContext*, ExprList*);
  15894. SQLITE_PRIVATE void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
  15895. SQLITE_PRIVATE void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
  15896. SQLITE_PRIVATE int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
  15897. SQLITE_PRIVATE void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
  15898. SQLITE_PRIVATE void sqlite3AlterFinishAddColumn(Parse *, Token *);
  15899. SQLITE_PRIVATE void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
  15900. SQLITE_PRIVATE CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
  15901. SQLITE_PRIVATE char sqlite3AffinityType(const char*, u8*);
  15902. SQLITE_PRIVATE void sqlite3Analyze(Parse*, Token*, Token*);
  15903. SQLITE_PRIVATE int sqlite3InvokeBusyHandler(BusyHandler*);
  15904. SQLITE_PRIVATE int sqlite3FindDb(sqlite3*, Token*);
  15905. SQLITE_PRIVATE int sqlite3FindDbName(sqlite3 *, const char *);
  15906. SQLITE_PRIVATE int sqlite3AnalysisLoad(sqlite3*,int iDB);
  15907. SQLITE_PRIVATE void sqlite3DeleteIndexSamples(sqlite3*,Index*);
  15908. SQLITE_PRIVATE void sqlite3DefaultRowEst(Index*);
  15909. SQLITE_PRIVATE void sqlite3RegisterLikeFunctions(sqlite3*, int);
  15910. SQLITE_PRIVATE int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
  15911. SQLITE_PRIVATE void sqlite3SchemaClear(void *);
  15912. SQLITE_PRIVATE Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
  15913. SQLITE_PRIVATE int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
  15914. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
  15915. SQLITE_PRIVATE void sqlite3KeyInfoUnref(KeyInfo*);
  15916. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
  15917. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
  15918. #ifdef SQLITE_DEBUG
  15919. SQLITE_PRIVATE int sqlite3KeyInfoIsWriteable(KeyInfo*);
  15920. #endif
  15921. SQLITE_PRIVATE int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
  15922. void (*)(sqlite3_context*,int,sqlite3_value **),
  15923. void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
  15924. FuncDestructor *pDestructor
  15925. );
  15926. SQLITE_PRIVATE void sqlite3OomFault(sqlite3*);
  15927. SQLITE_PRIVATE void sqlite3OomClear(sqlite3*);
  15928. SQLITE_PRIVATE int sqlite3ApiExit(sqlite3 *db, int);
  15929. SQLITE_PRIVATE int sqlite3OpenTempDatabase(Parse *);
  15930. SQLITE_PRIVATE void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
  15931. SQLITE_PRIVATE void sqlite3StrAccumAppend(StrAccum*,const char*,int);
  15932. SQLITE_PRIVATE void sqlite3StrAccumAppendAll(StrAccum*,const char*);
  15933. SQLITE_PRIVATE void sqlite3AppendChar(StrAccum*,int,char);
  15934. SQLITE_PRIVATE char *sqlite3StrAccumFinish(StrAccum*);
  15935. SQLITE_PRIVATE void sqlite3StrAccumReset(StrAccum*);
  15936. SQLITE_PRIVATE void sqlite3SelectDestInit(SelectDest*,int,int);
  15937. SQLITE_PRIVATE Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
  15938. SQLITE_PRIVATE void sqlite3BackupRestart(sqlite3_backup *);
  15939. SQLITE_PRIVATE void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
  15940. #ifndef SQLITE_OMIT_SUBQUERY
  15941. SQLITE_PRIVATE int sqlite3ExprCheckIN(Parse*, Expr*);
  15942. #else
  15943. # define sqlite3ExprCheckIN(x,y) SQLITE_OK
  15944. #endif
  15945. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  15946. SQLITE_PRIVATE void sqlite3AnalyzeFunctions(void);
  15947. SQLITE_PRIVATE int sqlite3Stat4ProbeSetValue(
  15948. Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*);
  15949. SQLITE_PRIVATE int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
  15950. SQLITE_PRIVATE void sqlite3Stat4ProbeFree(UnpackedRecord*);
  15951. SQLITE_PRIVATE int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
  15952. SQLITE_PRIVATE char sqlite3IndexColumnAffinity(sqlite3*, Index*, int);
  15953. #endif
  15954. /*
  15955. ** The interface to the LEMON-generated parser
  15956. */
  15957. SQLITE_PRIVATE void *sqlite3ParserAlloc(void*(*)(u64));
  15958. SQLITE_PRIVATE void sqlite3ParserFree(void*, void(*)(void*));
  15959. SQLITE_PRIVATE void sqlite3Parser(void*, int, Token, Parse*);
  15960. #ifdef YYTRACKMAXSTACKDEPTH
  15961. SQLITE_PRIVATE int sqlite3ParserStackPeak(void*);
  15962. #endif
  15963. SQLITE_PRIVATE void sqlite3AutoLoadExtensions(sqlite3*);
  15964. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  15965. SQLITE_PRIVATE void sqlite3CloseExtensions(sqlite3*);
  15966. #else
  15967. # define sqlite3CloseExtensions(X)
  15968. #endif
  15969. #ifndef SQLITE_OMIT_SHARED_CACHE
  15970. SQLITE_PRIVATE void sqlite3TableLock(Parse *, int, int, u8, const char *);
  15971. #else
  15972. #define sqlite3TableLock(v,w,x,y,z)
  15973. #endif
  15974. #ifdef SQLITE_TEST
  15975. SQLITE_PRIVATE int sqlite3Utf8To8(unsigned char*);
  15976. #endif
  15977. #ifdef SQLITE_OMIT_VIRTUALTABLE
  15978. # define sqlite3VtabClear(Y)
  15979. # define sqlite3VtabSync(X,Y) SQLITE_OK
  15980. # define sqlite3VtabRollback(X)
  15981. # define sqlite3VtabCommit(X)
  15982. # define sqlite3VtabInSync(db) 0
  15983. # define sqlite3VtabLock(X)
  15984. # define sqlite3VtabUnlock(X)
  15985. # define sqlite3VtabUnlockList(X)
  15986. # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
  15987. # define sqlite3GetVTable(X,Y) ((VTable*)0)
  15988. #else
  15989. SQLITE_PRIVATE void sqlite3VtabClear(sqlite3 *db, Table*);
  15990. SQLITE_PRIVATE void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
  15991. SQLITE_PRIVATE int sqlite3VtabSync(sqlite3 *db, Vdbe*);
  15992. SQLITE_PRIVATE int sqlite3VtabRollback(sqlite3 *db);
  15993. SQLITE_PRIVATE int sqlite3VtabCommit(sqlite3 *db);
  15994. SQLITE_PRIVATE void sqlite3VtabLock(VTable *);
  15995. SQLITE_PRIVATE void sqlite3VtabUnlock(VTable *);
  15996. SQLITE_PRIVATE void sqlite3VtabUnlockList(sqlite3*);
  15997. SQLITE_PRIVATE int sqlite3VtabSavepoint(sqlite3 *, int, int);
  15998. SQLITE_PRIVATE void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
  15999. SQLITE_PRIVATE VTable *sqlite3GetVTable(sqlite3*, Table*);
  16000. # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
  16001. #endif
  16002. SQLITE_PRIVATE int sqlite3VtabEponymousTableInit(Parse*,Module*);
  16003. SQLITE_PRIVATE void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
  16004. SQLITE_PRIVATE void sqlite3VtabMakeWritable(Parse*,Table*);
  16005. SQLITE_PRIVATE void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
  16006. SQLITE_PRIVATE void sqlite3VtabFinishParse(Parse*, Token*);
  16007. SQLITE_PRIVATE void sqlite3VtabArgInit(Parse*);
  16008. SQLITE_PRIVATE void sqlite3VtabArgExtend(Parse*, Token*);
  16009. SQLITE_PRIVATE int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
  16010. SQLITE_PRIVATE int sqlite3VtabCallConnect(Parse*, Table*);
  16011. SQLITE_PRIVATE int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
  16012. SQLITE_PRIVATE int sqlite3VtabBegin(sqlite3 *, VTable *);
  16013. SQLITE_PRIVATE FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
  16014. SQLITE_PRIVATE void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
  16015. SQLITE_PRIVATE sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
  16016. SQLITE_PRIVATE int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
  16017. SQLITE_PRIVATE int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
  16018. SQLITE_PRIVATE void sqlite3ParserReset(Parse*);
  16019. SQLITE_PRIVATE int sqlite3Reprepare(Vdbe*);
  16020. SQLITE_PRIVATE void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
  16021. SQLITE_PRIVATE CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
  16022. SQLITE_PRIVATE int sqlite3TempInMemory(const sqlite3*);
  16023. SQLITE_PRIVATE const char *sqlite3JournalModename(int);
  16024. #ifndef SQLITE_OMIT_WAL
  16025. SQLITE_PRIVATE int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
  16026. SQLITE_PRIVATE int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
  16027. #endif
  16028. #ifndef SQLITE_OMIT_CTE
  16029. SQLITE_PRIVATE With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
  16030. SQLITE_PRIVATE void sqlite3WithDelete(sqlite3*,With*);
  16031. SQLITE_PRIVATE void sqlite3WithPush(Parse*, With*, u8);
  16032. #else
  16033. #define sqlite3WithPush(x,y,z)
  16034. #define sqlite3WithDelete(x,y)
  16035. #endif
  16036. /* Declarations for functions in fkey.c. All of these are replaced by
  16037. ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
  16038. ** key functionality is available. If OMIT_TRIGGER is defined but
  16039. ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
  16040. ** this case foreign keys are parsed, but no other functionality is
  16041. ** provided (enforcement of FK constraints requires the triggers sub-system).
  16042. */
  16043. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  16044. SQLITE_PRIVATE void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
  16045. SQLITE_PRIVATE void sqlite3FkDropTable(Parse*, SrcList *, Table*);
  16046. SQLITE_PRIVATE void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
  16047. SQLITE_PRIVATE int sqlite3FkRequired(Parse*, Table*, int*, int);
  16048. SQLITE_PRIVATE u32 sqlite3FkOldmask(Parse*, Table*);
  16049. SQLITE_PRIVATE FKey *sqlite3FkReferences(Table *);
  16050. #else
  16051. #define sqlite3FkActions(a,b,c,d,e,f)
  16052. #define sqlite3FkCheck(a,b,c,d,e,f)
  16053. #define sqlite3FkDropTable(a,b,c)
  16054. #define sqlite3FkOldmask(a,b) 0
  16055. #define sqlite3FkRequired(a,b,c,d) 0
  16056. #endif
  16057. #ifndef SQLITE_OMIT_FOREIGN_KEY
  16058. SQLITE_PRIVATE void sqlite3FkDelete(sqlite3 *, Table*);
  16059. SQLITE_PRIVATE int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
  16060. #else
  16061. #define sqlite3FkDelete(a,b)
  16062. #define sqlite3FkLocateIndex(a,b,c,d,e)
  16063. #endif
  16064. /*
  16065. ** Available fault injectors. Should be numbered beginning with 0.
  16066. */
  16067. #define SQLITE_FAULTINJECTOR_MALLOC 0
  16068. #define SQLITE_FAULTINJECTOR_COUNT 1
  16069. /*
  16070. ** The interface to the code in fault.c used for identifying "benign"
  16071. ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
  16072. ** is not defined.
  16073. */
  16074. #ifndef SQLITE_OMIT_BUILTIN_TEST
  16075. SQLITE_PRIVATE void sqlite3BeginBenignMalloc(void);
  16076. SQLITE_PRIVATE void sqlite3EndBenignMalloc(void);
  16077. #else
  16078. #define sqlite3BeginBenignMalloc()
  16079. #define sqlite3EndBenignMalloc()
  16080. #endif
  16081. /*
  16082. ** Allowed return values from sqlite3FindInIndex()
  16083. */
  16084. #define IN_INDEX_ROWID 1 /* Search the rowid of the table */
  16085. #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */
  16086. #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */
  16087. #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */
  16088. #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */
  16089. /*
  16090. ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
  16091. */
  16092. #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */
  16093. #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */
  16094. #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */
  16095. SQLITE_PRIVATE int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*);
  16096. SQLITE_PRIVATE int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
  16097. SQLITE_PRIVATE int sqlite3JournalSize(sqlite3_vfs *);
  16098. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  16099. SQLITE_PRIVATE int sqlite3JournalCreate(sqlite3_file *);
  16100. #endif
  16101. SQLITE_PRIVATE int sqlite3JournalIsInMemory(sqlite3_file *p);
  16102. SQLITE_PRIVATE void sqlite3MemJournalOpen(sqlite3_file *);
  16103. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
  16104. #if SQLITE_MAX_EXPR_DEPTH>0
  16105. SQLITE_PRIVATE int sqlite3SelectExprHeight(Select *);
  16106. SQLITE_PRIVATE int sqlite3ExprCheckHeight(Parse*, int);
  16107. #else
  16108. #define sqlite3SelectExprHeight(x) 0
  16109. #define sqlite3ExprCheckHeight(x,y)
  16110. #endif
  16111. SQLITE_PRIVATE u32 sqlite3Get4byte(const u8*);
  16112. SQLITE_PRIVATE void sqlite3Put4byte(u8*, u32);
  16113. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  16114. SQLITE_PRIVATE void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
  16115. SQLITE_PRIVATE void sqlite3ConnectionUnlocked(sqlite3 *db);
  16116. SQLITE_PRIVATE void sqlite3ConnectionClosed(sqlite3 *db);
  16117. #else
  16118. #define sqlite3ConnectionBlocked(x,y)
  16119. #define sqlite3ConnectionUnlocked(x)
  16120. #define sqlite3ConnectionClosed(x)
  16121. #endif
  16122. #ifdef SQLITE_DEBUG
  16123. SQLITE_PRIVATE void sqlite3ParserTrace(FILE*, char *);
  16124. #endif
  16125. /*
  16126. ** If the SQLITE_ENABLE IOTRACE exists then the global variable
  16127. ** sqlite3IoTrace is a pointer to a printf-like routine used to
  16128. ** print I/O tracing messages.
  16129. */
  16130. #ifdef SQLITE_ENABLE_IOTRACE
  16131. # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
  16132. SQLITE_PRIVATE void sqlite3VdbeIOTraceSql(Vdbe*);
  16133. SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
  16134. #else
  16135. # define IOTRACE(A)
  16136. # define sqlite3VdbeIOTraceSql(X)
  16137. #endif
  16138. /*
  16139. ** These routines are available for the mem2.c debugging memory allocator
  16140. ** only. They are used to verify that different "types" of memory
  16141. ** allocations are properly tracked by the system.
  16142. **
  16143. ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
  16144. ** the MEMTYPE_* macros defined below. The type must be a bitmask with
  16145. ** a single bit set.
  16146. **
  16147. ** sqlite3MemdebugHasType() returns true if any of the bits in its second
  16148. ** argument match the type set by the previous sqlite3MemdebugSetType().
  16149. ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
  16150. **
  16151. ** sqlite3MemdebugNoType() returns true if none of the bits in its second
  16152. ** argument match the type set by the previous sqlite3MemdebugSetType().
  16153. **
  16154. ** Perhaps the most important point is the difference between MEMTYPE_HEAP
  16155. ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means
  16156. ** it might have been allocated by lookaside, except the allocation was
  16157. ** too large or lookaside was already full. It is important to verify
  16158. ** that allocations that might have been satisfied by lookaside are not
  16159. ** passed back to non-lookaside free() routines. Asserts such as the
  16160. ** example above are placed on the non-lookaside free() routines to verify
  16161. ** this constraint.
  16162. **
  16163. ** All of this is no-op for a production build. It only comes into
  16164. ** play when the SQLITE_MEMDEBUG compile-time option is used.
  16165. */
  16166. #ifdef SQLITE_MEMDEBUG
  16167. SQLITE_PRIVATE void sqlite3MemdebugSetType(void*,u8);
  16168. SQLITE_PRIVATE int sqlite3MemdebugHasType(void*,u8);
  16169. SQLITE_PRIVATE int sqlite3MemdebugNoType(void*,u8);
  16170. #else
  16171. # define sqlite3MemdebugSetType(X,Y) /* no-op */
  16172. # define sqlite3MemdebugHasType(X,Y) 1
  16173. # define sqlite3MemdebugNoType(X,Y) 1
  16174. #endif
  16175. #define MEMTYPE_HEAP 0x01 /* General heap allocations */
  16176. #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */
  16177. #define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */
  16178. #define MEMTYPE_PCACHE 0x08 /* Page cache allocations */
  16179. /*
  16180. ** Threading interface
  16181. */
  16182. #if SQLITE_MAX_WORKER_THREADS>0
  16183. SQLITE_PRIVATE int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
  16184. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread*, void**);
  16185. #endif
  16186. #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
  16187. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3*);
  16188. #endif
  16189. SQLITE_PRIVATE int sqlite3ExprVectorSize(Expr *pExpr);
  16190. SQLITE_PRIVATE int sqlite3ExprIsVector(Expr *pExpr);
  16191. SQLITE_PRIVATE Expr *sqlite3VectorFieldSubexpr(Expr*, int);
  16192. SQLITE_PRIVATE Expr *sqlite3ExprForVectorField(Parse*,Expr*,int);
  16193. #endif /* SQLITEINT_H */
  16194. /************** End of sqliteInt.h *******************************************/
  16195. /************** Begin file global.c ******************************************/
  16196. /*
  16197. ** 2008 June 13
  16198. **
  16199. ** The author disclaims copyright to this source code. In place of
  16200. ** a legal notice, here is a blessing:
  16201. **
  16202. ** May you do good and not evil.
  16203. ** May you find forgiveness for yourself and forgive others.
  16204. ** May you share freely, never taking more than you give.
  16205. **
  16206. *************************************************************************
  16207. **
  16208. ** This file contains definitions of global variables and constants.
  16209. */
  16210. /* #include "sqliteInt.h" */
  16211. /* An array to map all upper-case characters into their corresponding
  16212. ** lower-case character.
  16213. **
  16214. ** SQLite only considers US-ASCII (or EBCDIC) characters. We do not
  16215. ** handle case conversions for the UTF character set since the tables
  16216. ** involved are nearly as big or bigger than SQLite itself.
  16217. */
  16218. SQLITE_PRIVATE const unsigned char sqlite3UpperToLower[] = {
  16219. #ifdef SQLITE_ASCII
  16220. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
  16221. 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35,
  16222. 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  16223. 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 97, 98, 99,100,101,102,103,
  16224. 104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,
  16225. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99,100,101,102,103,104,105,106,107,
  16226. 108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,
  16227. 126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,
  16228. 144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,
  16229. 162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,
  16230. 180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,
  16231. 198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,
  16232. 216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,
  16233. 234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,
  16234. 252,253,254,255
  16235. #endif
  16236. #ifdef SQLITE_EBCDIC
  16237. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, /* 0x */
  16238. 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, /* 1x */
  16239. 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, /* 2x */
  16240. 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, /* 3x */
  16241. 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, /* 4x */
  16242. 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, /* 5x */
  16243. 96, 97, 98, 99,100,101,102,103,104,105,106,107,108,109,110,111, /* 6x */
  16244. 112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127, /* 7x */
  16245. 128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143, /* 8x */
  16246. 144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159, /* 9x */
  16247. 160,161,162,163,164,165,166,167,168,169,170,171,140,141,142,175, /* Ax */
  16248. 176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191, /* Bx */
  16249. 192,129,130,131,132,133,134,135,136,137,202,203,204,205,206,207, /* Cx */
  16250. 208,145,146,147,148,149,150,151,152,153,218,219,220,221,222,223, /* Dx */
  16251. 224,225,162,163,164,165,166,167,168,169,234,235,236,237,238,239, /* Ex */
  16252. 240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255, /* Fx */
  16253. #endif
  16254. };
  16255. /*
  16256. ** The following 256 byte lookup table is used to support SQLites built-in
  16257. ** equivalents to the following standard library functions:
  16258. **
  16259. ** isspace() 0x01
  16260. ** isalpha() 0x02
  16261. ** isdigit() 0x04
  16262. ** isalnum() 0x06
  16263. ** isxdigit() 0x08
  16264. ** toupper() 0x20
  16265. ** SQLite identifier character 0x40
  16266. ** Quote character 0x80
  16267. **
  16268. ** Bit 0x20 is set if the mapped character requires translation to upper
  16269. ** case. i.e. if the character is a lower-case ASCII character.
  16270. ** If x is a lower-case ASCII character, then its upper-case equivalent
  16271. ** is (x - 0x20). Therefore toupper() can be implemented as:
  16272. **
  16273. ** (x & ~(map[x]&0x20))
  16274. **
  16275. ** The equivalent of tolower() is implemented using the sqlite3UpperToLower[]
  16276. ** array. tolower() is used more often than toupper() by SQLite.
  16277. **
  16278. ** Bit 0x40 is set if the character is non-alphanumeric and can be used in an
  16279. ** SQLite identifier. Identifiers are alphanumerics, "_", "$", and any
  16280. ** non-ASCII UTF character. Hence the test for whether or not a character is
  16281. ** part of an identifier is 0x46.
  16282. */
  16283. #ifdef SQLITE_ASCII
  16284. SQLITE_PRIVATE const unsigned char sqlite3CtypeMap[256] = {
  16285. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 00..07 ........ */
  16286. 0x00, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, /* 08..0f ........ */
  16287. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 10..17 ........ */
  16288. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 18..1f ........ */
  16289. 0x01, 0x00, 0x80, 0x00, 0x40, 0x00, 0x00, 0x80, /* 20..27 !"#$%&' */
  16290. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 28..2f ()*+,-./ */
  16291. 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, /* 30..37 01234567 */
  16292. 0x0c, 0x0c, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 38..3f 89:;<=>? */
  16293. 0x00, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x02, /* 40..47 @ABCDEFG */
  16294. 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 48..4f HIJKLMNO */
  16295. 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 50..57 PQRSTUVW */
  16296. 0x02, 0x02, 0x02, 0x80, 0x00, 0x00, 0x00, 0x40, /* 58..5f XYZ[\]^_ */
  16297. 0x80, 0x2a, 0x2a, 0x2a, 0x2a, 0x2a, 0x2a, 0x22, /* 60..67 `abcdefg */
  16298. 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, /* 68..6f hijklmno */
  16299. 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, /* 70..77 pqrstuvw */
  16300. 0x22, 0x22, 0x22, 0x00, 0x00, 0x00, 0x00, 0x00, /* 78..7f xyz{|}~. */
  16301. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 80..87 ........ */
  16302. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 88..8f ........ */
  16303. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 90..97 ........ */
  16304. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 98..9f ........ */
  16305. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* a0..a7 ........ */
  16306. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* a8..af ........ */
  16307. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* b0..b7 ........ */
  16308. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* b8..bf ........ */
  16309. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* c0..c7 ........ */
  16310. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* c8..cf ........ */
  16311. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* d0..d7 ........ */
  16312. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* d8..df ........ */
  16313. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* e0..e7 ........ */
  16314. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* e8..ef ........ */
  16315. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* f0..f7 ........ */
  16316. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40 /* f8..ff ........ */
  16317. };
  16318. #endif
  16319. /* EVIDENCE-OF: R-02982-34736 In order to maintain full backwards
  16320. ** compatibility for legacy applications, the URI filename capability is
  16321. ** disabled by default.
  16322. **
  16323. ** EVIDENCE-OF: R-38799-08373 URI filenames can be enabled or disabled
  16324. ** using the SQLITE_USE_URI=1 or SQLITE_USE_URI=0 compile-time options.
  16325. **
  16326. ** EVIDENCE-OF: R-43642-56306 By default, URI handling is globally
  16327. ** disabled. The default value may be changed by compiling with the
  16328. ** SQLITE_USE_URI symbol defined.
  16329. */
  16330. #ifndef SQLITE_USE_URI
  16331. # define SQLITE_USE_URI 0
  16332. #endif
  16333. /* EVIDENCE-OF: R-38720-18127 The default setting is determined by the
  16334. ** SQLITE_ALLOW_COVERING_INDEX_SCAN compile-time option, or is "on" if
  16335. ** that compile-time option is omitted.
  16336. */
  16337. #ifndef SQLITE_ALLOW_COVERING_INDEX_SCAN
  16338. # define SQLITE_ALLOW_COVERING_INDEX_SCAN 1
  16339. #endif
  16340. /* The minimum PMA size is set to this value multiplied by the database
  16341. ** page size in bytes.
  16342. */
  16343. #ifndef SQLITE_SORTER_PMASZ
  16344. # define SQLITE_SORTER_PMASZ 250
  16345. #endif
  16346. /* Statement journals spill to disk when their size exceeds the following
  16347. ** threshold (in bytes). 0 means that statement journals are created and
  16348. ** written to disk immediately (the default behavior for SQLite versions
  16349. ** before 3.12.0). -1 means always keep the entire statement journal in
  16350. ** memory. (The statement journal is also always held entirely in memory
  16351. ** if journal_mode=MEMORY or if temp_store=MEMORY, regardless of this
  16352. ** setting.)
  16353. */
  16354. #ifndef SQLITE_STMTJRNL_SPILL
  16355. # define SQLITE_STMTJRNL_SPILL (64*1024)
  16356. #endif
  16357. /*
  16358. ** The following singleton contains the global configuration for
  16359. ** the SQLite library.
  16360. */
  16361. SQLITE_PRIVATE SQLITE_WSD struct Sqlite3Config sqlite3Config = {
  16362. SQLITE_DEFAULT_MEMSTATUS, /* bMemstat */
  16363. 1, /* bCoreMutex */
  16364. SQLITE_THREADSAFE==1, /* bFullMutex */
  16365. SQLITE_USE_URI, /* bOpenUri */
  16366. SQLITE_ALLOW_COVERING_INDEX_SCAN, /* bUseCis */
  16367. 0x7ffffffe, /* mxStrlen */
  16368. 0, /* neverCorrupt */
  16369. 128, /* szLookaside */
  16370. 500, /* nLookaside */
  16371. SQLITE_STMTJRNL_SPILL, /* nStmtSpill */
  16372. {0,0,0,0,0,0,0,0}, /* m */
  16373. {0,0,0,0,0,0,0,0,0}, /* mutex */
  16374. {0,0,0,0,0,0,0,0,0,0,0,0,0},/* pcache2 */
  16375. (void*)0, /* pHeap */
  16376. 0, /* nHeap */
  16377. 0, 0, /* mnHeap, mxHeap */
  16378. SQLITE_DEFAULT_MMAP_SIZE, /* szMmap */
  16379. SQLITE_MAX_MMAP_SIZE, /* mxMmap */
  16380. (void*)0, /* pScratch */
  16381. 0, /* szScratch */
  16382. 0, /* nScratch */
  16383. (void*)0, /* pPage */
  16384. 0, /* szPage */
  16385. SQLITE_DEFAULT_PCACHE_INITSZ, /* nPage */
  16386. 0, /* mxParserStack */
  16387. 0, /* sharedCacheEnabled */
  16388. SQLITE_SORTER_PMASZ, /* szPma */
  16389. /* All the rest should always be initialized to zero */
  16390. 0, /* isInit */
  16391. 0, /* inProgress */
  16392. 0, /* isMutexInit */
  16393. 0, /* isMallocInit */
  16394. 0, /* isPCacheInit */
  16395. 0, /* nRefInitMutex */
  16396. 0, /* pInitMutex */
  16397. 0, /* xLog */
  16398. 0, /* pLogArg */
  16399. #ifdef SQLITE_ENABLE_SQLLOG
  16400. 0, /* xSqllog */
  16401. 0, /* pSqllogArg */
  16402. #endif
  16403. #ifdef SQLITE_VDBE_COVERAGE
  16404. 0, /* xVdbeBranch */
  16405. 0, /* pVbeBranchArg */
  16406. #endif
  16407. #ifndef SQLITE_OMIT_BUILTIN_TEST
  16408. 0, /* xTestCallback */
  16409. #endif
  16410. 0, /* bLocaltimeFault */
  16411. 0x7ffffffe /* iOnceResetThreshold */
  16412. };
  16413. /*
  16414. ** Hash table for global functions - functions common to all
  16415. ** database connections. After initialization, this table is
  16416. ** read-only.
  16417. */
  16418. SQLITE_PRIVATE FuncDefHash sqlite3BuiltinFunctions;
  16419. /*
  16420. ** Constant tokens for values 0 and 1.
  16421. */
  16422. SQLITE_PRIVATE const Token sqlite3IntTokens[] = {
  16423. { "0", 1 },
  16424. { "1", 1 }
  16425. };
  16426. /*
  16427. ** The value of the "pending" byte must be 0x40000000 (1 byte past the
  16428. ** 1-gibabyte boundary) in a compatible database. SQLite never uses
  16429. ** the database page that contains the pending byte. It never attempts
  16430. ** to read or write that page. The pending byte page is set aside
  16431. ** for use by the VFS layers as space for managing file locks.
  16432. **
  16433. ** During testing, it is often desirable to move the pending byte to
  16434. ** a different position in the file. This allows code that has to
  16435. ** deal with the pending byte to run on files that are much smaller
  16436. ** than 1 GiB. The sqlite3_test_control() interface can be used to
  16437. ** move the pending byte.
  16438. **
  16439. ** IMPORTANT: Changing the pending byte to any value other than
  16440. ** 0x40000000 results in an incompatible database file format!
  16441. ** Changing the pending byte during operation will result in undefined
  16442. ** and incorrect behavior.
  16443. */
  16444. #ifndef SQLITE_OMIT_WSD
  16445. SQLITE_PRIVATE int sqlite3PendingByte = 0x40000000;
  16446. #endif
  16447. /* #include "opcodes.h" */
  16448. /*
  16449. ** Properties of opcodes. The OPFLG_INITIALIZER macro is
  16450. ** created by mkopcodeh.awk during compilation. Data is obtained
  16451. ** from the comments following the "case OP_xxxx:" statements in
  16452. ** the vdbe.c file.
  16453. */
  16454. SQLITE_PRIVATE const unsigned char sqlite3OpcodeProperty[] = OPFLG_INITIALIZER;
  16455. /*
  16456. ** Name of the default collating sequence
  16457. */
  16458. SQLITE_PRIVATE const char sqlite3StrBINARY[] = "BINARY";
  16459. /************** End of global.c **********************************************/
  16460. /************** Begin file ctime.c *******************************************/
  16461. /*
  16462. ** 2010 February 23
  16463. **
  16464. ** The author disclaims copyright to this source code. In place of
  16465. ** a legal notice, here is a blessing:
  16466. **
  16467. ** May you do good and not evil.
  16468. ** May you find forgiveness for yourself and forgive others.
  16469. ** May you share freely, never taking more than you give.
  16470. **
  16471. *************************************************************************
  16472. **
  16473. ** This file implements routines used to report what compile-time options
  16474. ** SQLite was built with.
  16475. */
  16476. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  16477. /* #include "sqliteInt.h" */
  16478. /*
  16479. ** An array of names of all compile-time options. This array should
  16480. ** be sorted A-Z.
  16481. **
  16482. ** This array looks large, but in a typical installation actually uses
  16483. ** only a handful of compile-time options, so most times this array is usually
  16484. ** rather short and uses little memory space.
  16485. */
  16486. static const char * const azCompileOpt[] = {
  16487. /* These macros are provided to "stringify" the value of the define
  16488. ** for those options in which the value is meaningful. */
  16489. #define CTIMEOPT_VAL_(opt) #opt
  16490. #define CTIMEOPT_VAL(opt) CTIMEOPT_VAL_(opt)
  16491. #if SQLITE_32BIT_ROWID
  16492. "32BIT_ROWID",
  16493. #endif
  16494. #if SQLITE_4_BYTE_ALIGNED_MALLOC
  16495. "4_BYTE_ALIGNED_MALLOC",
  16496. #endif
  16497. #if SQLITE_CASE_SENSITIVE_LIKE
  16498. "CASE_SENSITIVE_LIKE",
  16499. #endif
  16500. #if SQLITE_CHECK_PAGES
  16501. "CHECK_PAGES",
  16502. #endif
  16503. #if defined(__clang__) && defined(__clang_major__)
  16504. "COMPILER=clang-" CTIMEOPT_VAL(__clang_major__) "."
  16505. CTIMEOPT_VAL(__clang_minor__) "."
  16506. CTIMEOPT_VAL(__clang_patchlevel__),
  16507. #elif defined(_MSC_VER)
  16508. "COMPILER=msvc-" CTIMEOPT_VAL(_MSC_VER),
  16509. #elif defined(__GNUC__) && defined(__VERSION__)
  16510. "COMPILER=gcc-" __VERSION__,
  16511. #endif
  16512. #if SQLITE_COVERAGE_TEST
  16513. "COVERAGE_TEST",
  16514. #endif
  16515. #if SQLITE_DEBUG
  16516. "DEBUG",
  16517. #endif
  16518. #if SQLITE_DEFAULT_LOCKING_MODE
  16519. "DEFAULT_LOCKING_MODE=" CTIMEOPT_VAL(SQLITE_DEFAULT_LOCKING_MODE),
  16520. #endif
  16521. #if defined(SQLITE_DEFAULT_MMAP_SIZE) && !defined(SQLITE_DEFAULT_MMAP_SIZE_xc)
  16522. "DEFAULT_MMAP_SIZE=" CTIMEOPT_VAL(SQLITE_DEFAULT_MMAP_SIZE),
  16523. #endif
  16524. #if SQLITE_DISABLE_DIRSYNC
  16525. "DISABLE_DIRSYNC",
  16526. #endif
  16527. #if SQLITE_DISABLE_LFS
  16528. "DISABLE_LFS",
  16529. #endif
  16530. #if SQLITE_ENABLE_8_3_NAMES
  16531. "ENABLE_8_3_NAMES=" CTIMEOPT_VAL(SQLITE_ENABLE_8_3_NAMES),
  16532. #endif
  16533. #if SQLITE_ENABLE_API_ARMOR
  16534. "ENABLE_API_ARMOR",
  16535. #endif
  16536. #if SQLITE_ENABLE_ATOMIC_WRITE
  16537. "ENABLE_ATOMIC_WRITE",
  16538. #endif
  16539. #if SQLITE_ENABLE_CEROD
  16540. "ENABLE_CEROD",
  16541. #endif
  16542. #if SQLITE_ENABLE_COLUMN_METADATA
  16543. "ENABLE_COLUMN_METADATA",
  16544. #endif
  16545. #if SQLITE_ENABLE_DBSTAT_VTAB
  16546. "ENABLE_DBSTAT_VTAB",
  16547. #endif
  16548. #if SQLITE_ENABLE_EXPENSIVE_ASSERT
  16549. "ENABLE_EXPENSIVE_ASSERT",
  16550. #endif
  16551. #if SQLITE_ENABLE_FTS1
  16552. "ENABLE_FTS1",
  16553. #endif
  16554. #if SQLITE_ENABLE_FTS2
  16555. "ENABLE_FTS2",
  16556. #endif
  16557. #if SQLITE_ENABLE_FTS3
  16558. "ENABLE_FTS3",
  16559. #endif
  16560. #if SQLITE_ENABLE_FTS3_PARENTHESIS
  16561. "ENABLE_FTS3_PARENTHESIS",
  16562. #endif
  16563. #if SQLITE_ENABLE_FTS4
  16564. "ENABLE_FTS4",
  16565. #endif
  16566. #if SQLITE_ENABLE_FTS5
  16567. "ENABLE_FTS5",
  16568. #endif
  16569. #if SQLITE_ENABLE_ICU
  16570. "ENABLE_ICU",
  16571. #endif
  16572. #if SQLITE_ENABLE_IOTRACE
  16573. "ENABLE_IOTRACE",
  16574. #endif
  16575. #if SQLITE_ENABLE_JSON1
  16576. "ENABLE_JSON1",
  16577. #endif
  16578. #if SQLITE_ENABLE_LOAD_EXTENSION
  16579. "ENABLE_LOAD_EXTENSION",
  16580. #endif
  16581. #if SQLITE_ENABLE_LOCKING_STYLE
  16582. "ENABLE_LOCKING_STYLE=" CTIMEOPT_VAL(SQLITE_ENABLE_LOCKING_STYLE),
  16583. #endif
  16584. #if SQLITE_ENABLE_MEMORY_MANAGEMENT
  16585. "ENABLE_MEMORY_MANAGEMENT",
  16586. #endif
  16587. #if SQLITE_ENABLE_MEMSYS3
  16588. "ENABLE_MEMSYS3",
  16589. #endif
  16590. #if SQLITE_ENABLE_MEMSYS5
  16591. "ENABLE_MEMSYS5",
  16592. #endif
  16593. #if SQLITE_ENABLE_OVERSIZE_CELL_CHECK
  16594. "ENABLE_OVERSIZE_CELL_CHECK",
  16595. #endif
  16596. #if SQLITE_ENABLE_RTREE
  16597. "ENABLE_RTREE",
  16598. #endif
  16599. #if defined(SQLITE_ENABLE_STAT4)
  16600. "ENABLE_STAT4",
  16601. #elif defined(SQLITE_ENABLE_STAT3)
  16602. "ENABLE_STAT3",
  16603. #endif
  16604. #if SQLITE_ENABLE_UNLOCK_NOTIFY
  16605. "ENABLE_UNLOCK_NOTIFY",
  16606. #endif
  16607. #if SQLITE_ENABLE_UPDATE_DELETE_LIMIT
  16608. "ENABLE_UPDATE_DELETE_LIMIT",
  16609. #endif
  16610. #if SQLITE_HAS_CODEC
  16611. "HAS_CODEC",
  16612. #endif
  16613. #if HAVE_ISNAN || SQLITE_HAVE_ISNAN
  16614. "HAVE_ISNAN",
  16615. #endif
  16616. #if SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  16617. "HOMEGROWN_RECURSIVE_MUTEX",
  16618. #endif
  16619. #if SQLITE_IGNORE_AFP_LOCK_ERRORS
  16620. "IGNORE_AFP_LOCK_ERRORS",
  16621. #endif
  16622. #if SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  16623. "IGNORE_FLOCK_LOCK_ERRORS",
  16624. #endif
  16625. #ifdef SQLITE_INT64_TYPE
  16626. "INT64_TYPE",
  16627. #endif
  16628. #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  16629. "LIKE_DOESNT_MATCH_BLOBS",
  16630. #endif
  16631. #if SQLITE_LOCK_TRACE
  16632. "LOCK_TRACE",
  16633. #endif
  16634. #if defined(SQLITE_MAX_MMAP_SIZE) && !defined(SQLITE_MAX_MMAP_SIZE_xc)
  16635. "MAX_MMAP_SIZE=" CTIMEOPT_VAL(SQLITE_MAX_MMAP_SIZE),
  16636. #endif
  16637. #ifdef SQLITE_MAX_SCHEMA_RETRY
  16638. "MAX_SCHEMA_RETRY=" CTIMEOPT_VAL(SQLITE_MAX_SCHEMA_RETRY),
  16639. #endif
  16640. #if SQLITE_MEMDEBUG
  16641. "MEMDEBUG",
  16642. #endif
  16643. #if SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  16644. "MIXED_ENDIAN_64BIT_FLOAT",
  16645. #endif
  16646. #if SQLITE_NO_SYNC
  16647. "NO_SYNC",
  16648. #endif
  16649. #if SQLITE_OMIT_ALTERTABLE
  16650. "OMIT_ALTERTABLE",
  16651. #endif
  16652. #if SQLITE_OMIT_ANALYZE
  16653. "OMIT_ANALYZE",
  16654. #endif
  16655. #if SQLITE_OMIT_ATTACH
  16656. "OMIT_ATTACH",
  16657. #endif
  16658. #if SQLITE_OMIT_AUTHORIZATION
  16659. "OMIT_AUTHORIZATION",
  16660. #endif
  16661. #if SQLITE_OMIT_AUTOINCREMENT
  16662. "OMIT_AUTOINCREMENT",
  16663. #endif
  16664. #if SQLITE_OMIT_AUTOINIT
  16665. "OMIT_AUTOINIT",
  16666. #endif
  16667. #if SQLITE_OMIT_AUTOMATIC_INDEX
  16668. "OMIT_AUTOMATIC_INDEX",
  16669. #endif
  16670. #if SQLITE_OMIT_AUTORESET
  16671. "OMIT_AUTORESET",
  16672. #endif
  16673. #if SQLITE_OMIT_AUTOVACUUM
  16674. "OMIT_AUTOVACUUM",
  16675. #endif
  16676. #if SQLITE_OMIT_BETWEEN_OPTIMIZATION
  16677. "OMIT_BETWEEN_OPTIMIZATION",
  16678. #endif
  16679. #if SQLITE_OMIT_BLOB_LITERAL
  16680. "OMIT_BLOB_LITERAL",
  16681. #endif
  16682. #if SQLITE_OMIT_BTREECOUNT
  16683. "OMIT_BTREECOUNT",
  16684. #endif
  16685. #if SQLITE_OMIT_BUILTIN_TEST
  16686. "OMIT_BUILTIN_TEST",
  16687. #endif
  16688. #if SQLITE_OMIT_CAST
  16689. "OMIT_CAST",
  16690. #endif
  16691. #if SQLITE_OMIT_CHECK
  16692. "OMIT_CHECK",
  16693. #endif
  16694. #if SQLITE_OMIT_COMPLETE
  16695. "OMIT_COMPLETE",
  16696. #endif
  16697. #if SQLITE_OMIT_COMPOUND_SELECT
  16698. "OMIT_COMPOUND_SELECT",
  16699. #endif
  16700. #if SQLITE_OMIT_CTE
  16701. "OMIT_CTE",
  16702. #endif
  16703. #if SQLITE_OMIT_DATETIME_FUNCS
  16704. "OMIT_DATETIME_FUNCS",
  16705. #endif
  16706. #if SQLITE_OMIT_DECLTYPE
  16707. "OMIT_DECLTYPE",
  16708. #endif
  16709. #if SQLITE_OMIT_DEPRECATED
  16710. "OMIT_DEPRECATED",
  16711. #endif
  16712. #if SQLITE_OMIT_DISKIO
  16713. "OMIT_DISKIO",
  16714. #endif
  16715. #if SQLITE_OMIT_EXPLAIN
  16716. "OMIT_EXPLAIN",
  16717. #endif
  16718. #if SQLITE_OMIT_FLAG_PRAGMAS
  16719. "OMIT_FLAG_PRAGMAS",
  16720. #endif
  16721. #if SQLITE_OMIT_FLOATING_POINT
  16722. "OMIT_FLOATING_POINT",
  16723. #endif
  16724. #if SQLITE_OMIT_FOREIGN_KEY
  16725. "OMIT_FOREIGN_KEY",
  16726. #endif
  16727. #if SQLITE_OMIT_GET_TABLE
  16728. "OMIT_GET_TABLE",
  16729. #endif
  16730. #if SQLITE_OMIT_INCRBLOB
  16731. "OMIT_INCRBLOB",
  16732. #endif
  16733. #if SQLITE_OMIT_INTEGRITY_CHECK
  16734. "OMIT_INTEGRITY_CHECK",
  16735. #endif
  16736. #if SQLITE_OMIT_LIKE_OPTIMIZATION
  16737. "OMIT_LIKE_OPTIMIZATION",
  16738. #endif
  16739. #if SQLITE_OMIT_LOAD_EXTENSION
  16740. "OMIT_LOAD_EXTENSION",
  16741. #endif
  16742. #if SQLITE_OMIT_LOCALTIME
  16743. "OMIT_LOCALTIME",
  16744. #endif
  16745. #if SQLITE_OMIT_LOOKASIDE
  16746. "OMIT_LOOKASIDE",
  16747. #endif
  16748. #if SQLITE_OMIT_MEMORYDB
  16749. "OMIT_MEMORYDB",
  16750. #endif
  16751. #if SQLITE_OMIT_OR_OPTIMIZATION
  16752. "OMIT_OR_OPTIMIZATION",
  16753. #endif
  16754. #if SQLITE_OMIT_PAGER_PRAGMAS
  16755. "OMIT_PAGER_PRAGMAS",
  16756. #endif
  16757. #if SQLITE_OMIT_PRAGMA
  16758. "OMIT_PRAGMA",
  16759. #endif
  16760. #if SQLITE_OMIT_PROGRESS_CALLBACK
  16761. "OMIT_PROGRESS_CALLBACK",
  16762. #endif
  16763. #if SQLITE_OMIT_QUICKBALANCE
  16764. "OMIT_QUICKBALANCE",
  16765. #endif
  16766. #if SQLITE_OMIT_REINDEX
  16767. "OMIT_REINDEX",
  16768. #endif
  16769. #if SQLITE_OMIT_SCHEMA_PRAGMAS
  16770. "OMIT_SCHEMA_PRAGMAS",
  16771. #endif
  16772. #if SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
  16773. "OMIT_SCHEMA_VERSION_PRAGMAS",
  16774. #endif
  16775. #if SQLITE_OMIT_SHARED_CACHE
  16776. "OMIT_SHARED_CACHE",
  16777. #endif
  16778. #if SQLITE_OMIT_SUBQUERY
  16779. "OMIT_SUBQUERY",
  16780. #endif
  16781. #if SQLITE_OMIT_TCL_VARIABLE
  16782. "OMIT_TCL_VARIABLE",
  16783. #endif
  16784. #if SQLITE_OMIT_TEMPDB
  16785. "OMIT_TEMPDB",
  16786. #endif
  16787. #if SQLITE_OMIT_TRACE
  16788. "OMIT_TRACE",
  16789. #endif
  16790. #if SQLITE_OMIT_TRIGGER
  16791. "OMIT_TRIGGER",
  16792. #endif
  16793. #if SQLITE_OMIT_TRUNCATE_OPTIMIZATION
  16794. "OMIT_TRUNCATE_OPTIMIZATION",
  16795. #endif
  16796. #if SQLITE_OMIT_UTF16
  16797. "OMIT_UTF16",
  16798. #endif
  16799. #if SQLITE_OMIT_VACUUM
  16800. "OMIT_VACUUM",
  16801. #endif
  16802. #if SQLITE_OMIT_VIEW
  16803. "OMIT_VIEW",
  16804. #endif
  16805. #if SQLITE_OMIT_VIRTUALTABLE
  16806. "OMIT_VIRTUALTABLE",
  16807. #endif
  16808. #if SQLITE_OMIT_WAL
  16809. "OMIT_WAL",
  16810. #endif
  16811. #if SQLITE_OMIT_WSD
  16812. "OMIT_WSD",
  16813. #endif
  16814. #if SQLITE_OMIT_XFER_OPT
  16815. "OMIT_XFER_OPT",
  16816. #endif
  16817. #if SQLITE_PERFORMANCE_TRACE
  16818. "PERFORMANCE_TRACE",
  16819. #endif
  16820. #if SQLITE_PROXY_DEBUG
  16821. "PROXY_DEBUG",
  16822. #endif
  16823. #if SQLITE_RTREE_INT_ONLY
  16824. "RTREE_INT_ONLY",
  16825. #endif
  16826. #if SQLITE_SECURE_DELETE
  16827. "SECURE_DELETE",
  16828. #endif
  16829. #if SQLITE_SMALL_STACK
  16830. "SMALL_STACK",
  16831. #endif
  16832. #if SQLITE_SOUNDEX
  16833. "SOUNDEX",
  16834. #endif
  16835. #if SQLITE_SYSTEM_MALLOC
  16836. "SYSTEM_MALLOC",
  16837. #endif
  16838. #if SQLITE_TCL
  16839. "TCL",
  16840. #endif
  16841. #if defined(SQLITE_TEMP_STORE) && !defined(SQLITE_TEMP_STORE_xc)
  16842. "TEMP_STORE=" CTIMEOPT_VAL(SQLITE_TEMP_STORE),
  16843. #endif
  16844. #if SQLITE_TEST
  16845. "TEST",
  16846. #endif
  16847. #if defined(SQLITE_THREADSAFE)
  16848. "THREADSAFE=" CTIMEOPT_VAL(SQLITE_THREADSAFE),
  16849. #endif
  16850. #if SQLITE_USE_ALLOCA
  16851. "USE_ALLOCA",
  16852. #endif
  16853. #if SQLITE_USER_AUTHENTICATION
  16854. "USER_AUTHENTICATION",
  16855. #endif
  16856. #if SQLITE_WIN32_MALLOC
  16857. "WIN32_MALLOC",
  16858. #endif
  16859. #if SQLITE_ZERO_MALLOC
  16860. "ZERO_MALLOC"
  16861. #endif
  16862. };
  16863. /*
  16864. ** Given the name of a compile-time option, return true if that option
  16865. ** was used and false if not.
  16866. **
  16867. ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
  16868. ** is not required for a match.
  16869. */
  16870. SQLITE_API int sqlite3_compileoption_used(const char *zOptName){
  16871. int i, n;
  16872. #if SQLITE_ENABLE_API_ARMOR
  16873. if( zOptName==0 ){
  16874. (void)SQLITE_MISUSE_BKPT;
  16875. return 0;
  16876. }
  16877. #endif
  16878. if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
  16879. n = sqlite3Strlen30(zOptName);
  16880. /* Since ArraySize(azCompileOpt) is normally in single digits, a
  16881. ** linear search is adequate. No need for a binary search. */
  16882. for(i=0; i<ArraySize(azCompileOpt); i++){
  16883. if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
  16884. && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
  16885. ){
  16886. return 1;
  16887. }
  16888. }
  16889. return 0;
  16890. }
  16891. /*
  16892. ** Return the N-th compile-time option string. If N is out of range,
  16893. ** return a NULL pointer.
  16894. */
  16895. SQLITE_API const char *sqlite3_compileoption_get(int N){
  16896. if( N>=0 && N<ArraySize(azCompileOpt) ){
  16897. return azCompileOpt[N];
  16898. }
  16899. return 0;
  16900. }
  16901. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  16902. /************** End of ctime.c ***********************************************/
  16903. /************** Begin file status.c ******************************************/
  16904. /*
  16905. ** 2008 June 18
  16906. **
  16907. ** The author disclaims copyright to this source code. In place of
  16908. ** a legal notice, here is a blessing:
  16909. **
  16910. ** May you do good and not evil.
  16911. ** May you find forgiveness for yourself and forgive others.
  16912. ** May you share freely, never taking more than you give.
  16913. **
  16914. *************************************************************************
  16915. **
  16916. ** This module implements the sqlite3_status() interface and related
  16917. ** functionality.
  16918. */
  16919. /* #include "sqliteInt.h" */
  16920. /************** Include vdbeInt.h in the middle of status.c ******************/
  16921. /************** Begin file vdbeInt.h *****************************************/
  16922. /*
  16923. ** 2003 September 6
  16924. **
  16925. ** The author disclaims copyright to this source code. In place of
  16926. ** a legal notice, here is a blessing:
  16927. **
  16928. ** May you do good and not evil.
  16929. ** May you find forgiveness for yourself and forgive others.
  16930. ** May you share freely, never taking more than you give.
  16931. **
  16932. *************************************************************************
  16933. ** This is the header file for information that is private to the
  16934. ** VDBE. This information used to all be at the top of the single
  16935. ** source code file "vdbe.c". When that file became too big (over
  16936. ** 6000 lines long) it was split up into several smaller files and
  16937. ** this header information was factored out.
  16938. */
  16939. #ifndef SQLITE_VDBEINT_H
  16940. #define SQLITE_VDBEINT_H
  16941. /*
  16942. ** The maximum number of times that a statement will try to reparse
  16943. ** itself before giving up and returning SQLITE_SCHEMA.
  16944. */
  16945. #ifndef SQLITE_MAX_SCHEMA_RETRY
  16946. # define SQLITE_MAX_SCHEMA_RETRY 50
  16947. #endif
  16948. /*
  16949. ** VDBE_DISPLAY_P4 is true or false depending on whether or not the
  16950. ** "explain" P4 display logic is enabled.
  16951. */
  16952. #if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) \
  16953. || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  16954. # define VDBE_DISPLAY_P4 1
  16955. #else
  16956. # define VDBE_DISPLAY_P4 0
  16957. #endif
  16958. /*
  16959. ** SQL is translated into a sequence of instructions to be
  16960. ** executed by a virtual machine. Each instruction is an instance
  16961. ** of the following structure.
  16962. */
  16963. typedef struct VdbeOp Op;
  16964. /*
  16965. ** Boolean values
  16966. */
  16967. typedef unsigned Bool;
  16968. /* Opaque type used by code in vdbesort.c */
  16969. typedef struct VdbeSorter VdbeSorter;
  16970. /* Elements of the linked list at Vdbe.pAuxData */
  16971. typedef struct AuxData AuxData;
  16972. /* Types of VDBE cursors */
  16973. #define CURTYPE_BTREE 0
  16974. #define CURTYPE_SORTER 1
  16975. #define CURTYPE_VTAB 2
  16976. #define CURTYPE_PSEUDO 3
  16977. /*
  16978. ** A VdbeCursor is an superclass (a wrapper) for various cursor objects:
  16979. **
  16980. ** * A b-tree cursor
  16981. ** - In the main database or in an ephemeral database
  16982. ** - On either an index or a table
  16983. ** * A sorter
  16984. ** * A virtual table
  16985. ** * A one-row "pseudotable" stored in a single register
  16986. */
  16987. typedef struct VdbeCursor VdbeCursor;
  16988. struct VdbeCursor {
  16989. u8 eCurType; /* One of the CURTYPE_* values above */
  16990. i8 iDb; /* Index of cursor database in db->aDb[] (or -1) */
  16991. u8 nullRow; /* True if pointing to a row with no data */
  16992. u8 deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */
  16993. u8 isTable; /* True for rowid tables. False for indexes */
  16994. #ifdef SQLITE_DEBUG
  16995. u8 seekOp; /* Most recent seek operation on this cursor */
  16996. u8 wrFlag; /* The wrFlag argument to sqlite3BtreeCursor() */
  16997. #endif
  16998. Bool isEphemeral:1; /* True for an ephemeral table */
  16999. Bool useRandomRowid:1;/* Generate new record numbers semi-randomly */
  17000. Bool isOrdered:1; /* True if the table is not BTREE_UNORDERED */
  17001. Pgno pgnoRoot; /* Root page of the open btree cursor */
  17002. i16 nField; /* Number of fields in the header */
  17003. u16 nHdrParsed; /* Number of header fields parsed so far */
  17004. union {
  17005. BtCursor *pCursor; /* CURTYPE_BTREE. Btree cursor */
  17006. sqlite3_vtab_cursor *pVCur; /* CURTYPE_VTAB. Vtab cursor */
  17007. int pseudoTableReg; /* CURTYPE_PSEUDO. Reg holding content. */
  17008. VdbeSorter *pSorter; /* CURTYPE_SORTER. Sorter object */
  17009. } uc;
  17010. Btree *pBt; /* Separate file holding temporary table */
  17011. KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */
  17012. int seekResult; /* Result of previous sqlite3BtreeMoveto() */
  17013. i64 seqCount; /* Sequence counter */
  17014. i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */
  17015. VdbeCursor *pAltCursor; /* Associated index cursor from which to read */
  17016. int *aAltMap; /* Mapping from table to index column numbers */
  17017. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  17018. u64 maskUsed; /* Mask of columns used by this cursor */
  17019. #endif
  17020. /* Cached information about the header for the data record that the
  17021. ** cursor is currently pointing to. Only valid if cacheStatus matches
  17022. ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of
  17023. ** CACHE_STALE and so setting cacheStatus=CACHE_STALE guarantees that
  17024. ** the cache is out of date.
  17025. **
  17026. ** aRow might point to (ephemeral) data for the current row, or it might
  17027. ** be NULL.
  17028. */
  17029. u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */
  17030. u32 payloadSize; /* Total number of bytes in the record */
  17031. u32 szRow; /* Byte available in aRow */
  17032. u32 iHdrOffset; /* Offset to next unparsed byte of the header */
  17033. const u8 *aRow; /* Data for the current row, if all on one page */
  17034. u32 *aOffset; /* Pointer to aType[nField] */
  17035. u32 aType[1]; /* Type values for all entries in the record */
  17036. /* 2*nField extra array elements allocated for aType[], beyond the one
  17037. ** static element declared in the structure. nField total array slots for
  17038. ** aType[] and nField+1 array slots for aOffset[] */
  17039. };
  17040. /*
  17041. ** A value for VdbeCursor.cacheStatus that means the cache is always invalid.
  17042. */
  17043. #define CACHE_STALE 0
  17044. /*
  17045. ** When a sub-program is executed (OP_Program), a structure of this type
  17046. ** is allocated to store the current value of the program counter, as
  17047. ** well as the current memory cell array and various other frame specific
  17048. ** values stored in the Vdbe struct. When the sub-program is finished,
  17049. ** these values are copied back to the Vdbe from the VdbeFrame structure,
  17050. ** restoring the state of the VM to as it was before the sub-program
  17051. ** began executing.
  17052. **
  17053. ** The memory for a VdbeFrame object is allocated and managed by a memory
  17054. ** cell in the parent (calling) frame. When the memory cell is deleted or
  17055. ** overwritten, the VdbeFrame object is not freed immediately. Instead, it
  17056. ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame
  17057. ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing
  17058. ** this instead of deleting the VdbeFrame immediately is to avoid recursive
  17059. ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the
  17060. ** child frame are released.
  17061. **
  17062. ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is
  17063. ** set to NULL if the currently executing frame is the main program.
  17064. */
  17065. typedef struct VdbeFrame VdbeFrame;
  17066. struct VdbeFrame {
  17067. Vdbe *v; /* VM this frame belongs to */
  17068. VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */
  17069. Op *aOp; /* Program instructions for parent frame */
  17070. i64 *anExec; /* Event counters from parent frame */
  17071. Mem *aMem; /* Array of memory cells for parent frame */
  17072. VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */
  17073. void *token; /* Copy of SubProgram.token */
  17074. i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
  17075. AuxData *pAuxData; /* Linked list of auxdata allocations */
  17076. int nCursor; /* Number of entries in apCsr */
  17077. int pc; /* Program Counter in parent (calling) frame */
  17078. int nOp; /* Size of aOp array */
  17079. int nMem; /* Number of entries in aMem */
  17080. int nChildMem; /* Number of memory cells for child frame */
  17081. int nChildCsr; /* Number of cursors for child frame */
  17082. int nChange; /* Statement changes (Vdbe.nChange) */
  17083. int nDbChange; /* Value of db->nChange */
  17084. };
  17085. #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))])
  17086. /*
  17087. ** Internally, the vdbe manipulates nearly all SQL values as Mem
  17088. ** structures. Each Mem struct may cache multiple representations (string,
  17089. ** integer etc.) of the same value.
  17090. */
  17091. struct Mem {
  17092. union MemValue {
  17093. double r; /* Real value used when MEM_Real is set in flags */
  17094. i64 i; /* Integer value used when MEM_Int is set in flags */
  17095. int nZero; /* Used when bit MEM_Zero is set in flags */
  17096. FuncDef *pDef; /* Used only when flags==MEM_Agg */
  17097. RowSet *pRowSet; /* Used only when flags==MEM_RowSet */
  17098. VdbeFrame *pFrame; /* Used when flags==MEM_Frame */
  17099. } u;
  17100. u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
  17101. u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */
  17102. u8 eSubtype; /* Subtype for this value */
  17103. int n; /* Number of characters in string value, excluding '\0' */
  17104. char *z; /* String or BLOB value */
  17105. /* ShallowCopy only needs to copy the information above */
  17106. char *zMalloc; /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */
  17107. int szMalloc; /* Size of the zMalloc allocation */
  17108. u32 uTemp; /* Transient storage for serial_type in OP_MakeRecord */
  17109. sqlite3 *db; /* The associated database connection */
  17110. void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */
  17111. #ifdef SQLITE_DEBUG
  17112. Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */
  17113. void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */
  17114. #endif
  17115. };
  17116. /*
  17117. ** Size of struct Mem not including the Mem.zMalloc member or anything that
  17118. ** follows.
  17119. */
  17120. #define MEMCELLSIZE offsetof(Mem,zMalloc)
  17121. /* One or more of the following flags are set to indicate the validOK
  17122. ** representations of the value stored in the Mem struct.
  17123. **
  17124. ** If the MEM_Null flag is set, then the value is an SQL NULL value.
  17125. ** No other flags may be set in this case.
  17126. **
  17127. ** If the MEM_Str flag is set then Mem.z points at a string representation.
  17128. ** Usually this is encoded in the same unicode encoding as the main
  17129. ** database (see below for exceptions). If the MEM_Term flag is also
  17130. ** set, then the string is nul terminated. The MEM_Int and MEM_Real
  17131. ** flags may coexist with the MEM_Str flag.
  17132. */
  17133. #define MEM_Null 0x0001 /* Value is NULL */
  17134. #define MEM_Str 0x0002 /* Value is a string */
  17135. #define MEM_Int 0x0004 /* Value is an integer */
  17136. #define MEM_Real 0x0008 /* Value is a real number */
  17137. #define MEM_Blob 0x0010 /* Value is a BLOB */
  17138. #define MEM_AffMask 0x001f /* Mask of affinity bits */
  17139. #define MEM_RowSet 0x0020 /* Value is a RowSet object */
  17140. #define MEM_Frame 0x0040 /* Value is a VdbeFrame object */
  17141. #define MEM_Undefined 0x0080 /* Value is undefined */
  17142. #define MEM_Cleared 0x0100 /* NULL set by OP_Null, not from data */
  17143. #define MEM_TypeMask 0x81ff /* Mask of type bits */
  17144. /* Whenever Mem contains a valid string or blob representation, one of
  17145. ** the following flags must be set to determine the memory management
  17146. ** policy for Mem.z. The MEM_Term flag tells us whether or not the
  17147. ** string is \000 or \u0000 terminated
  17148. */
  17149. #define MEM_Term 0x0200 /* String rep is nul terminated */
  17150. #define MEM_Dyn 0x0400 /* Need to call Mem.xDel() on Mem.z */
  17151. #define MEM_Static 0x0800 /* Mem.z points to a static string */
  17152. #define MEM_Ephem 0x1000 /* Mem.z points to an ephemeral string */
  17153. #define MEM_Agg 0x2000 /* Mem.z points to an agg function context */
  17154. #define MEM_Zero 0x4000 /* Mem.i contains count of 0s appended to blob */
  17155. #define MEM_Subtype 0x8000 /* Mem.eSubtype is valid */
  17156. #ifdef SQLITE_OMIT_INCRBLOB
  17157. #undef MEM_Zero
  17158. #define MEM_Zero 0x0000
  17159. #endif
  17160. /* Return TRUE if Mem X contains dynamically allocated content - anything
  17161. ** that needs to be deallocated to avoid a leak.
  17162. */
  17163. #define VdbeMemDynamic(X) \
  17164. (((X)->flags&(MEM_Agg|MEM_Dyn|MEM_RowSet|MEM_Frame))!=0)
  17165. /*
  17166. ** Clear any existing type flags from a Mem and replace them with f
  17167. */
  17168. #define MemSetTypeFlag(p, f) \
  17169. ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f)
  17170. /*
  17171. ** Return true if a memory cell is not marked as invalid. This macro
  17172. ** is for use inside assert() statements only.
  17173. */
  17174. #ifdef SQLITE_DEBUG
  17175. #define memIsValid(M) ((M)->flags & MEM_Undefined)==0
  17176. #endif
  17177. /*
  17178. ** Each auxiliary data pointer stored by a user defined function
  17179. ** implementation calling sqlite3_set_auxdata() is stored in an instance
  17180. ** of this structure. All such structures associated with a single VM
  17181. ** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed
  17182. ** when the VM is halted (if not before).
  17183. */
  17184. struct AuxData {
  17185. int iOp; /* Instruction number of OP_Function opcode */
  17186. int iArg; /* Index of function argument. */
  17187. void *pAux; /* Aux data pointer */
  17188. void (*xDelete)(void *); /* Destructor for the aux data */
  17189. AuxData *pNext; /* Next element in list */
  17190. };
  17191. /*
  17192. ** The "context" argument for an installable function. A pointer to an
  17193. ** instance of this structure is the first argument to the routines used
  17194. ** implement the SQL functions.
  17195. **
  17196. ** There is a typedef for this structure in sqlite.h. So all routines,
  17197. ** even the public interface to SQLite, can use a pointer to this structure.
  17198. ** But this file is the only place where the internal details of this
  17199. ** structure are known.
  17200. **
  17201. ** This structure is defined inside of vdbeInt.h because it uses substructures
  17202. ** (Mem) which are only defined there.
  17203. */
  17204. struct sqlite3_context {
  17205. Mem *pOut; /* The return value is stored here */
  17206. FuncDef *pFunc; /* Pointer to function information */
  17207. Mem *pMem; /* Memory cell used to store aggregate context */
  17208. Vdbe *pVdbe; /* The VM that owns this context */
  17209. int iOp; /* Instruction number of OP_Function */
  17210. int isError; /* Error code returned by the function. */
  17211. u8 skipFlag; /* Skip accumulator loading if true */
  17212. u8 fErrorOrAux; /* isError!=0 or pVdbe->pAuxData modified */
  17213. u8 argc; /* Number of arguments */
  17214. sqlite3_value *argv[1]; /* Argument set */
  17215. };
  17216. /* A bitfield type for use inside of structures. Always follow with :N where
  17217. ** N is the number of bits.
  17218. */
  17219. typedef unsigned bft; /* Bit Field Type */
  17220. typedef struct ScanStatus ScanStatus;
  17221. struct ScanStatus {
  17222. int addrExplain; /* OP_Explain for loop */
  17223. int addrLoop; /* Address of "loops" counter */
  17224. int addrVisit; /* Address of "rows visited" counter */
  17225. int iSelectID; /* The "Select-ID" for this loop */
  17226. LogEst nEst; /* Estimated output rows per loop */
  17227. char *zName; /* Name of table or index */
  17228. };
  17229. /*
  17230. ** An instance of the virtual machine. This structure contains the complete
  17231. ** state of the virtual machine.
  17232. **
  17233. ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare()
  17234. ** is really a pointer to an instance of this structure.
  17235. */
  17236. struct Vdbe {
  17237. sqlite3 *db; /* The database connection that owns this statement */
  17238. Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
  17239. Parse *pParse; /* Parsing context used to create this Vdbe */
  17240. ynVar nVar; /* Number of entries in aVar[] */
  17241. ynVar nzVar; /* Number of entries in azVar[] */
  17242. u32 magic; /* Magic number for sanity checking */
  17243. int nMem; /* Number of memory locations currently allocated */
  17244. int nCursor; /* Number of slots in apCsr[] */
  17245. u32 cacheCtr; /* VdbeCursor row cache generation counter */
  17246. int pc; /* The program counter */
  17247. int rc; /* Value to return */
  17248. int nChange; /* Number of db changes made since last reset */
  17249. int iStatement; /* Statement number (or 0 if has not opened stmt) */
  17250. i64 iCurrentTime; /* Value of julianday('now') for this statement */
  17251. i64 nFkConstraint; /* Number of imm. FK constraints this VM */
  17252. i64 nStmtDefCons; /* Number of def. constraints when stmt started */
  17253. i64 nStmtDefImmCons; /* Number of def. imm constraints when stmt started */
  17254. /* When allocating a new Vdbe object, all of the fields below should be
  17255. ** initialized to zero or NULL */
  17256. Op *aOp; /* Space to hold the virtual machine's program */
  17257. Mem *aMem; /* The memory locations */
  17258. Mem **apArg; /* Arguments to currently executing user function */
  17259. Mem *aColName; /* Column names to return */
  17260. Mem *pResultSet; /* Pointer to an array of results */
  17261. char *zErrMsg; /* Error message written here */
  17262. VdbeCursor **apCsr; /* One element of this array for each open cursor */
  17263. Mem *aVar; /* Values for the OP_Variable opcode. */
  17264. char **azVar; /* Name of variables */
  17265. #ifndef SQLITE_OMIT_TRACE
  17266. i64 startTime; /* Time when query started - used for profiling */
  17267. #endif
  17268. int nOp; /* Number of instructions in the program */
  17269. #ifdef SQLITE_DEBUG
  17270. int rcApp; /* errcode set by sqlite3_result_error_code() */
  17271. #endif
  17272. u16 nResColumn; /* Number of columns in one row of the result set */
  17273. u8 errorAction; /* Recovery action to do in case of an error */
  17274. u8 minWriteFileFormat; /* Minimum file format for writable database files */
  17275. bft expired:1; /* True if the VM needs to be recompiled */
  17276. bft doingRerun:1; /* True if rerunning after an auto-reprepare */
  17277. bft explain:2; /* True if EXPLAIN present on SQL command */
  17278. bft changeCntOn:1; /* True to update the change-counter */
  17279. bft runOnlyOnce:1; /* Automatically expire on reset */
  17280. bft usesStmtJournal:1; /* True if uses a statement journal */
  17281. bft readOnly:1; /* True for statements that do not write */
  17282. bft bIsReader:1; /* True for statements that read */
  17283. bft isPrepareV2:1; /* True if prepared with prepare_v2() */
  17284. yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */
  17285. yDbMask lockMask; /* Subset of btreeMask that requires a lock */
  17286. u32 aCounter[5]; /* Counters used by sqlite3_stmt_status() */
  17287. char *zSql; /* Text of the SQL statement that generated this */
  17288. void *pFree; /* Free this when deleting the vdbe */
  17289. VdbeFrame *pFrame; /* Parent frame */
  17290. VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */
  17291. int nFrame; /* Number of frames in pFrame list */
  17292. u32 expmask; /* Binding to these vars invalidates VM */
  17293. SubProgram *pProgram; /* Linked list of all sub-programs used by VM */
  17294. AuxData *pAuxData; /* Linked list of auxdata allocations */
  17295. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  17296. i64 *anExec; /* Number of times each op has been executed */
  17297. int nScan; /* Entries in aScan[] */
  17298. ScanStatus *aScan; /* Scan definitions for sqlite3_stmt_scanstatus() */
  17299. #endif
  17300. };
  17301. /*
  17302. ** The following are allowed values for Vdbe.magic
  17303. */
  17304. #define VDBE_MAGIC_INIT 0x16bceaa5 /* Building a VDBE program */
  17305. #define VDBE_MAGIC_RUN 0x2df20da3 /* VDBE is ready to execute */
  17306. #define VDBE_MAGIC_HALT 0x319c2973 /* VDBE has completed execution */
  17307. #define VDBE_MAGIC_RESET 0x48fa9f76 /* Reset and ready to run again */
  17308. #define VDBE_MAGIC_DEAD 0x5606c3c8 /* The VDBE has been deallocated */
  17309. /*
  17310. ** Structure used to store the context required by the
  17311. ** sqlite3_preupdate_*() API functions.
  17312. */
  17313. struct PreUpdate {
  17314. Vdbe *v;
  17315. VdbeCursor *pCsr; /* Cursor to read old values from */
  17316. int op; /* One of SQLITE_INSERT, UPDATE, DELETE */
  17317. u8 *aRecord; /* old.* database record */
  17318. KeyInfo keyinfo;
  17319. UnpackedRecord *pUnpacked; /* Unpacked version of aRecord[] */
  17320. UnpackedRecord *pNewUnpacked; /* Unpacked version of new.* record */
  17321. int iNewReg; /* Register for new.* values */
  17322. i64 iKey1; /* First key value passed to hook */
  17323. i64 iKey2; /* Second key value passed to hook */
  17324. Mem *aNew; /* Array of new.* values */
  17325. Table *pTab; /* Schema object being upated */
  17326. };
  17327. /*
  17328. ** Function prototypes
  17329. */
  17330. SQLITE_PRIVATE void sqlite3VdbeError(Vdbe*, const char *, ...);
  17331. SQLITE_PRIVATE void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*);
  17332. void sqliteVdbePopStack(Vdbe*,int);
  17333. SQLITE_PRIVATE int sqlite3VdbeCursorMoveto(VdbeCursor**, int*);
  17334. SQLITE_PRIVATE int sqlite3VdbeCursorRestore(VdbeCursor*);
  17335. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  17336. SQLITE_PRIVATE void sqlite3VdbePrintOp(FILE*, int, Op*);
  17337. #endif
  17338. SQLITE_PRIVATE u32 sqlite3VdbeSerialTypeLen(u32);
  17339. SQLITE_PRIVATE u8 sqlite3VdbeOneByteSerialTypeLen(u8);
  17340. SQLITE_PRIVATE u32 sqlite3VdbeSerialType(Mem*, int, u32*);
  17341. SQLITE_PRIVATE u32 sqlite3VdbeSerialPut(unsigned char*, Mem*, u32);
  17342. SQLITE_PRIVATE u32 sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
  17343. SQLITE_PRIVATE void sqlite3VdbeDeleteAuxData(sqlite3*, AuxData**, int, int);
  17344. int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
  17345. SQLITE_PRIVATE int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*);
  17346. SQLITE_PRIVATE int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*);
  17347. SQLITE_PRIVATE int sqlite3VdbeExec(Vdbe*);
  17348. SQLITE_PRIVATE int sqlite3VdbeList(Vdbe*);
  17349. SQLITE_PRIVATE int sqlite3VdbeHalt(Vdbe*);
  17350. SQLITE_PRIVATE int sqlite3VdbeChangeEncoding(Mem *, int);
  17351. SQLITE_PRIVATE int sqlite3VdbeMemTooBig(Mem*);
  17352. SQLITE_PRIVATE int sqlite3VdbeMemCopy(Mem*, const Mem*);
  17353. SQLITE_PRIVATE void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
  17354. SQLITE_PRIVATE void sqlite3VdbeMemMove(Mem*, Mem*);
  17355. SQLITE_PRIVATE int sqlite3VdbeMemNulTerminate(Mem*);
  17356. SQLITE_PRIVATE int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
  17357. SQLITE_PRIVATE void sqlite3VdbeMemSetInt64(Mem*, i64);
  17358. #ifdef SQLITE_OMIT_FLOATING_POINT
  17359. # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64
  17360. #else
  17361. SQLITE_PRIVATE void sqlite3VdbeMemSetDouble(Mem*, double);
  17362. #endif
  17363. SQLITE_PRIVATE void sqlite3VdbeMemInit(Mem*,sqlite3*,u16);
  17364. SQLITE_PRIVATE void sqlite3VdbeMemSetNull(Mem*);
  17365. SQLITE_PRIVATE void sqlite3VdbeMemSetZeroBlob(Mem*,int);
  17366. SQLITE_PRIVATE void sqlite3VdbeMemSetRowSet(Mem*);
  17367. SQLITE_PRIVATE int sqlite3VdbeMemMakeWriteable(Mem*);
  17368. SQLITE_PRIVATE int sqlite3VdbeMemStringify(Mem*, u8, u8);
  17369. SQLITE_PRIVATE i64 sqlite3VdbeIntValue(Mem*);
  17370. SQLITE_PRIVATE int sqlite3VdbeMemIntegerify(Mem*);
  17371. SQLITE_PRIVATE double sqlite3VdbeRealValue(Mem*);
  17372. SQLITE_PRIVATE void sqlite3VdbeIntegerAffinity(Mem*);
  17373. SQLITE_PRIVATE int sqlite3VdbeMemRealify(Mem*);
  17374. SQLITE_PRIVATE int sqlite3VdbeMemNumerify(Mem*);
  17375. SQLITE_PRIVATE void sqlite3VdbeMemCast(Mem*,u8,u8);
  17376. SQLITE_PRIVATE int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,int,Mem*);
  17377. SQLITE_PRIVATE void sqlite3VdbeMemRelease(Mem *p);
  17378. SQLITE_PRIVATE int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
  17379. SQLITE_PRIVATE const char *sqlite3OpcodeName(int);
  17380. SQLITE_PRIVATE int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
  17381. SQLITE_PRIVATE int sqlite3VdbeMemClearAndResize(Mem *pMem, int n);
  17382. SQLITE_PRIVATE int sqlite3VdbeCloseStatement(Vdbe *, int);
  17383. SQLITE_PRIVATE void sqlite3VdbeFrameDelete(VdbeFrame*);
  17384. SQLITE_PRIVATE int sqlite3VdbeFrameRestore(VdbeFrame *);
  17385. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  17386. SQLITE_PRIVATE void sqlite3VdbePreUpdateHook(Vdbe*,VdbeCursor*,int,const char*,Table*,i64,int);
  17387. #endif
  17388. SQLITE_PRIVATE int sqlite3VdbeTransferError(Vdbe *p);
  17389. SQLITE_PRIVATE int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *);
  17390. SQLITE_PRIVATE void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *);
  17391. SQLITE_PRIVATE void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *);
  17392. SQLITE_PRIVATE int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *);
  17393. SQLITE_PRIVATE int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *, int *);
  17394. SQLITE_PRIVATE int sqlite3VdbeSorterRewind(const VdbeCursor *, int *);
  17395. SQLITE_PRIVATE int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *);
  17396. SQLITE_PRIVATE int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *);
  17397. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  17398. SQLITE_PRIVATE void sqlite3VdbeEnter(Vdbe*);
  17399. #else
  17400. # define sqlite3VdbeEnter(X)
  17401. #endif
  17402. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
  17403. SQLITE_PRIVATE void sqlite3VdbeLeave(Vdbe*);
  17404. #else
  17405. # define sqlite3VdbeLeave(X)
  17406. #endif
  17407. #ifdef SQLITE_DEBUG
  17408. SQLITE_PRIVATE void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*);
  17409. SQLITE_PRIVATE int sqlite3VdbeCheckMemInvariants(Mem*);
  17410. #endif
  17411. #ifndef SQLITE_OMIT_FOREIGN_KEY
  17412. SQLITE_PRIVATE int sqlite3VdbeCheckFk(Vdbe *, int);
  17413. #else
  17414. # define sqlite3VdbeCheckFk(p,i) 0
  17415. #endif
  17416. SQLITE_PRIVATE int sqlite3VdbeMemTranslate(Mem*, u8);
  17417. #ifdef SQLITE_DEBUG
  17418. SQLITE_PRIVATE void sqlite3VdbePrintSql(Vdbe*);
  17419. SQLITE_PRIVATE void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf);
  17420. #endif
  17421. SQLITE_PRIVATE int sqlite3VdbeMemHandleBom(Mem *pMem);
  17422. #ifndef SQLITE_OMIT_INCRBLOB
  17423. SQLITE_PRIVATE int sqlite3VdbeMemExpandBlob(Mem *);
  17424. #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
  17425. #else
  17426. #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
  17427. #define ExpandBlob(P) SQLITE_OK
  17428. #endif
  17429. #endif /* !defined(SQLITE_VDBEINT_H) */
  17430. /************** End of vdbeInt.h *********************************************/
  17431. /************** Continuing where we left off in status.c *********************/
  17432. /*
  17433. ** Variables in which to record status information.
  17434. */
  17435. #if SQLITE_PTRSIZE>4
  17436. typedef sqlite3_int64 sqlite3StatValueType;
  17437. #else
  17438. typedef u32 sqlite3StatValueType;
  17439. #endif
  17440. typedef struct sqlite3StatType sqlite3StatType;
  17441. static SQLITE_WSD struct sqlite3StatType {
  17442. sqlite3StatValueType nowValue[10]; /* Current value */
  17443. sqlite3StatValueType mxValue[10]; /* Maximum value */
  17444. } sqlite3Stat = { {0,}, {0,} };
  17445. /*
  17446. ** Elements of sqlite3Stat[] are protected by either the memory allocator
  17447. ** mutex, or by the pcache1 mutex. The following array determines which.
  17448. */
  17449. static const char statMutex[] = {
  17450. 0, /* SQLITE_STATUS_MEMORY_USED */
  17451. 1, /* SQLITE_STATUS_PAGECACHE_USED */
  17452. 1, /* SQLITE_STATUS_PAGECACHE_OVERFLOW */
  17453. 0, /* SQLITE_STATUS_SCRATCH_USED */
  17454. 0, /* SQLITE_STATUS_SCRATCH_OVERFLOW */
  17455. 0, /* SQLITE_STATUS_MALLOC_SIZE */
  17456. 0, /* SQLITE_STATUS_PARSER_STACK */
  17457. 1, /* SQLITE_STATUS_PAGECACHE_SIZE */
  17458. 0, /* SQLITE_STATUS_SCRATCH_SIZE */
  17459. 0, /* SQLITE_STATUS_MALLOC_COUNT */
  17460. };
  17461. /* The "wsdStat" macro will resolve to the status information
  17462. ** state vector. If writable static data is unsupported on the target,
  17463. ** we have to locate the state vector at run-time. In the more common
  17464. ** case where writable static data is supported, wsdStat can refer directly
  17465. ** to the "sqlite3Stat" state vector declared above.
  17466. */
  17467. #ifdef SQLITE_OMIT_WSD
  17468. # define wsdStatInit sqlite3StatType *x = &GLOBAL(sqlite3StatType,sqlite3Stat)
  17469. # define wsdStat x[0]
  17470. #else
  17471. # define wsdStatInit
  17472. # define wsdStat sqlite3Stat
  17473. #endif
  17474. /*
  17475. ** Return the current value of a status parameter. The caller must
  17476. ** be holding the appropriate mutex.
  17477. */
  17478. SQLITE_PRIVATE sqlite3_int64 sqlite3StatusValue(int op){
  17479. wsdStatInit;
  17480. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  17481. assert( op>=0 && op<ArraySize(statMutex) );
  17482. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  17483. : sqlite3MallocMutex()) );
  17484. return wsdStat.nowValue[op];
  17485. }
  17486. /*
  17487. ** Add N to the value of a status record. The caller must hold the
  17488. ** appropriate mutex. (Locking is checked by assert()).
  17489. **
  17490. ** The StatusUp() routine can accept positive or negative values for N.
  17491. ** The value of N is added to the current status value and the high-water
  17492. ** mark is adjusted if necessary.
  17493. **
  17494. ** The StatusDown() routine lowers the current value by N. The highwater
  17495. ** mark is unchanged. N must be non-negative for StatusDown().
  17496. */
  17497. SQLITE_PRIVATE void sqlite3StatusUp(int op, int N){
  17498. wsdStatInit;
  17499. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  17500. assert( op>=0 && op<ArraySize(statMutex) );
  17501. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  17502. : sqlite3MallocMutex()) );
  17503. wsdStat.nowValue[op] += N;
  17504. if( wsdStat.nowValue[op]>wsdStat.mxValue[op] ){
  17505. wsdStat.mxValue[op] = wsdStat.nowValue[op];
  17506. }
  17507. }
  17508. SQLITE_PRIVATE void sqlite3StatusDown(int op, int N){
  17509. wsdStatInit;
  17510. assert( N>=0 );
  17511. assert( op>=0 && op<ArraySize(statMutex) );
  17512. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  17513. : sqlite3MallocMutex()) );
  17514. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  17515. wsdStat.nowValue[op] -= N;
  17516. }
  17517. /*
  17518. ** Adjust the highwater mark if necessary.
  17519. ** The caller must hold the appropriate mutex.
  17520. */
  17521. SQLITE_PRIVATE void sqlite3StatusHighwater(int op, int X){
  17522. sqlite3StatValueType newValue;
  17523. wsdStatInit;
  17524. assert( X>=0 );
  17525. newValue = (sqlite3StatValueType)X;
  17526. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  17527. assert( op>=0 && op<ArraySize(statMutex) );
  17528. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  17529. : sqlite3MallocMutex()) );
  17530. assert( op==SQLITE_STATUS_MALLOC_SIZE
  17531. || op==SQLITE_STATUS_PAGECACHE_SIZE
  17532. || op==SQLITE_STATUS_SCRATCH_SIZE
  17533. || op==SQLITE_STATUS_PARSER_STACK );
  17534. if( newValue>wsdStat.mxValue[op] ){
  17535. wsdStat.mxValue[op] = newValue;
  17536. }
  17537. }
  17538. /*
  17539. ** Query status information.
  17540. */
  17541. SQLITE_API int sqlite3_status64(
  17542. int op,
  17543. sqlite3_int64 *pCurrent,
  17544. sqlite3_int64 *pHighwater,
  17545. int resetFlag
  17546. ){
  17547. sqlite3_mutex *pMutex;
  17548. wsdStatInit;
  17549. if( op<0 || op>=ArraySize(wsdStat.nowValue) ){
  17550. return SQLITE_MISUSE_BKPT;
  17551. }
  17552. #ifdef SQLITE_ENABLE_API_ARMOR
  17553. if( pCurrent==0 || pHighwater==0 ) return SQLITE_MISUSE_BKPT;
  17554. #endif
  17555. pMutex = statMutex[op] ? sqlite3Pcache1Mutex() : sqlite3MallocMutex();
  17556. sqlite3_mutex_enter(pMutex);
  17557. *pCurrent = wsdStat.nowValue[op];
  17558. *pHighwater = wsdStat.mxValue[op];
  17559. if( resetFlag ){
  17560. wsdStat.mxValue[op] = wsdStat.nowValue[op];
  17561. }
  17562. sqlite3_mutex_leave(pMutex);
  17563. (void)pMutex; /* Prevent warning when SQLITE_THREADSAFE=0 */
  17564. return SQLITE_OK;
  17565. }
  17566. SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag){
  17567. sqlite3_int64 iCur = 0, iHwtr = 0;
  17568. int rc;
  17569. #ifdef SQLITE_ENABLE_API_ARMOR
  17570. if( pCurrent==0 || pHighwater==0 ) return SQLITE_MISUSE_BKPT;
  17571. #endif
  17572. rc = sqlite3_status64(op, &iCur, &iHwtr, resetFlag);
  17573. if( rc==0 ){
  17574. *pCurrent = (int)iCur;
  17575. *pHighwater = (int)iHwtr;
  17576. }
  17577. return rc;
  17578. }
  17579. /*
  17580. ** Query status information for a single database connection
  17581. */
  17582. SQLITE_API int sqlite3_db_status(
  17583. sqlite3 *db, /* The database connection whose status is desired */
  17584. int op, /* Status verb */
  17585. int *pCurrent, /* Write current value here */
  17586. int *pHighwater, /* Write high-water mark here */
  17587. int resetFlag /* Reset high-water mark if true */
  17588. ){
  17589. int rc = SQLITE_OK; /* Return code */
  17590. #ifdef SQLITE_ENABLE_API_ARMOR
  17591. if( !sqlite3SafetyCheckOk(db) || pCurrent==0|| pHighwater==0 ){
  17592. return SQLITE_MISUSE_BKPT;
  17593. }
  17594. #endif
  17595. sqlite3_mutex_enter(db->mutex);
  17596. switch( op ){
  17597. case SQLITE_DBSTATUS_LOOKASIDE_USED: {
  17598. *pCurrent = db->lookaside.nOut;
  17599. *pHighwater = db->lookaside.mxOut;
  17600. if( resetFlag ){
  17601. db->lookaside.mxOut = db->lookaside.nOut;
  17602. }
  17603. break;
  17604. }
  17605. case SQLITE_DBSTATUS_LOOKASIDE_HIT:
  17606. case SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE:
  17607. case SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL: {
  17608. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_HIT );
  17609. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE );
  17610. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL );
  17611. assert( (op-SQLITE_DBSTATUS_LOOKASIDE_HIT)>=0 );
  17612. assert( (op-SQLITE_DBSTATUS_LOOKASIDE_HIT)<3 );
  17613. *pCurrent = 0;
  17614. *pHighwater = db->lookaside.anStat[op - SQLITE_DBSTATUS_LOOKASIDE_HIT];
  17615. if( resetFlag ){
  17616. db->lookaside.anStat[op - SQLITE_DBSTATUS_LOOKASIDE_HIT] = 0;
  17617. }
  17618. break;
  17619. }
  17620. /*
  17621. ** Return an approximation for the amount of memory currently used
  17622. ** by all pagers associated with the given database connection. The
  17623. ** highwater mark is meaningless and is returned as zero.
  17624. */
  17625. case SQLITE_DBSTATUS_CACHE_USED_SHARED:
  17626. case SQLITE_DBSTATUS_CACHE_USED: {
  17627. int totalUsed = 0;
  17628. int i;
  17629. sqlite3BtreeEnterAll(db);
  17630. for(i=0; i<db->nDb; i++){
  17631. Btree *pBt = db->aDb[i].pBt;
  17632. if( pBt ){
  17633. Pager *pPager = sqlite3BtreePager(pBt);
  17634. int nByte = sqlite3PagerMemUsed(pPager);
  17635. if( op==SQLITE_DBSTATUS_CACHE_USED_SHARED ){
  17636. nByte = nByte / sqlite3BtreeConnectionCount(pBt);
  17637. }
  17638. totalUsed += nByte;
  17639. }
  17640. }
  17641. sqlite3BtreeLeaveAll(db);
  17642. *pCurrent = totalUsed;
  17643. *pHighwater = 0;
  17644. break;
  17645. }
  17646. /*
  17647. ** *pCurrent gets an accurate estimate of the amount of memory used
  17648. ** to store the schema for all databases (main, temp, and any ATTACHed
  17649. ** databases. *pHighwater is set to zero.
  17650. */
  17651. case SQLITE_DBSTATUS_SCHEMA_USED: {
  17652. int i; /* Used to iterate through schemas */
  17653. int nByte = 0; /* Used to accumulate return value */
  17654. sqlite3BtreeEnterAll(db);
  17655. db->pnBytesFreed = &nByte;
  17656. for(i=0; i<db->nDb; i++){
  17657. Schema *pSchema = db->aDb[i].pSchema;
  17658. if( ALWAYS(pSchema!=0) ){
  17659. HashElem *p;
  17660. nByte += sqlite3GlobalConfig.m.xRoundup(sizeof(HashElem)) * (
  17661. pSchema->tblHash.count
  17662. + pSchema->trigHash.count
  17663. + pSchema->idxHash.count
  17664. + pSchema->fkeyHash.count
  17665. );
  17666. nByte += sqlite3_msize(pSchema->tblHash.ht);
  17667. nByte += sqlite3_msize(pSchema->trigHash.ht);
  17668. nByte += sqlite3_msize(pSchema->idxHash.ht);
  17669. nByte += sqlite3_msize(pSchema->fkeyHash.ht);
  17670. for(p=sqliteHashFirst(&pSchema->trigHash); p; p=sqliteHashNext(p)){
  17671. sqlite3DeleteTrigger(db, (Trigger*)sqliteHashData(p));
  17672. }
  17673. for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
  17674. sqlite3DeleteTable(db, (Table *)sqliteHashData(p));
  17675. }
  17676. }
  17677. }
  17678. db->pnBytesFreed = 0;
  17679. sqlite3BtreeLeaveAll(db);
  17680. *pHighwater = 0;
  17681. *pCurrent = nByte;
  17682. break;
  17683. }
  17684. /*
  17685. ** *pCurrent gets an accurate estimate of the amount of memory used
  17686. ** to store all prepared statements.
  17687. ** *pHighwater is set to zero.
  17688. */
  17689. case SQLITE_DBSTATUS_STMT_USED: {
  17690. struct Vdbe *pVdbe; /* Used to iterate through VMs */
  17691. int nByte = 0; /* Used to accumulate return value */
  17692. db->pnBytesFreed = &nByte;
  17693. for(pVdbe=db->pVdbe; pVdbe; pVdbe=pVdbe->pNext){
  17694. sqlite3VdbeClearObject(db, pVdbe);
  17695. sqlite3DbFree(db, pVdbe);
  17696. }
  17697. db->pnBytesFreed = 0;
  17698. *pHighwater = 0; /* IMP: R-64479-57858 */
  17699. *pCurrent = nByte;
  17700. break;
  17701. }
  17702. /*
  17703. ** Set *pCurrent to the total cache hits or misses encountered by all
  17704. ** pagers the database handle is connected to. *pHighwater is always set
  17705. ** to zero.
  17706. */
  17707. case SQLITE_DBSTATUS_CACHE_HIT:
  17708. case SQLITE_DBSTATUS_CACHE_MISS:
  17709. case SQLITE_DBSTATUS_CACHE_WRITE:{
  17710. int i;
  17711. int nRet = 0;
  17712. assert( SQLITE_DBSTATUS_CACHE_MISS==SQLITE_DBSTATUS_CACHE_HIT+1 );
  17713. assert( SQLITE_DBSTATUS_CACHE_WRITE==SQLITE_DBSTATUS_CACHE_HIT+2 );
  17714. for(i=0; i<db->nDb; i++){
  17715. if( db->aDb[i].pBt ){
  17716. Pager *pPager = sqlite3BtreePager(db->aDb[i].pBt);
  17717. sqlite3PagerCacheStat(pPager, op, resetFlag, &nRet);
  17718. }
  17719. }
  17720. *pHighwater = 0; /* IMP: R-42420-56072 */
  17721. /* IMP: R-54100-20147 */
  17722. /* IMP: R-29431-39229 */
  17723. *pCurrent = nRet;
  17724. break;
  17725. }
  17726. /* Set *pCurrent to non-zero if there are unresolved deferred foreign
  17727. ** key constraints. Set *pCurrent to zero if all foreign key constraints
  17728. ** have been satisfied. The *pHighwater is always set to zero.
  17729. */
  17730. case SQLITE_DBSTATUS_DEFERRED_FKS: {
  17731. *pHighwater = 0; /* IMP: R-11967-56545 */
  17732. *pCurrent = db->nDeferredImmCons>0 || db->nDeferredCons>0;
  17733. break;
  17734. }
  17735. default: {
  17736. rc = SQLITE_ERROR;
  17737. }
  17738. }
  17739. sqlite3_mutex_leave(db->mutex);
  17740. return rc;
  17741. }
  17742. /************** End of status.c **********************************************/
  17743. /************** Begin file date.c ********************************************/
  17744. /*
  17745. ** 2003 October 31
  17746. **
  17747. ** The author disclaims copyright to this source code. In place of
  17748. ** a legal notice, here is a blessing:
  17749. **
  17750. ** May you do good and not evil.
  17751. ** May you find forgiveness for yourself and forgive others.
  17752. ** May you share freely, never taking more than you give.
  17753. **
  17754. *************************************************************************
  17755. ** This file contains the C functions that implement date and time
  17756. ** functions for SQLite.
  17757. **
  17758. ** There is only one exported symbol in this file - the function
  17759. ** sqlite3RegisterDateTimeFunctions() found at the bottom of the file.
  17760. ** All other code has file scope.
  17761. **
  17762. ** SQLite processes all times and dates as julian day numbers. The
  17763. ** dates and times are stored as the number of days since noon
  17764. ** in Greenwich on November 24, 4714 B.C. according to the Gregorian
  17765. ** calendar system.
  17766. **
  17767. ** 1970-01-01 00:00:00 is JD 2440587.5
  17768. ** 2000-01-01 00:00:00 is JD 2451544.5
  17769. **
  17770. ** This implementation requires years to be expressed as a 4-digit number
  17771. ** which means that only dates between 0000-01-01 and 9999-12-31 can
  17772. ** be represented, even though julian day numbers allow a much wider
  17773. ** range of dates.
  17774. **
  17775. ** The Gregorian calendar system is used for all dates and times,
  17776. ** even those that predate the Gregorian calendar. Historians usually
  17777. ** use the julian calendar for dates prior to 1582-10-15 and for some
  17778. ** dates afterwards, depending on locale. Beware of this difference.
  17779. **
  17780. ** The conversion algorithms are implemented based on descriptions
  17781. ** in the following text:
  17782. **
  17783. ** Jean Meeus
  17784. ** Astronomical Algorithms, 2nd Edition, 1998
  17785. ** ISBM 0-943396-61-1
  17786. ** Willmann-Bell, Inc
  17787. ** Richmond, Virginia (USA)
  17788. */
  17789. /* #include "sqliteInt.h" */
  17790. /* #include <stdlib.h> */
  17791. /* #include <assert.h> */
  17792. #include <time.h>
  17793. #ifndef SQLITE_OMIT_DATETIME_FUNCS
  17794. /*
  17795. ** The MSVC CRT on Windows CE may not have a localtime() function.
  17796. ** So declare a substitute. The substitute function itself is
  17797. ** defined in "os_win.c".
  17798. */
  17799. #if !defined(SQLITE_OMIT_LOCALTIME) && defined(_WIN32_WCE) && \
  17800. (!defined(SQLITE_MSVC_LOCALTIME_API) || !SQLITE_MSVC_LOCALTIME_API)
  17801. struct tm *__cdecl localtime(const time_t *);
  17802. #endif
  17803. /*
  17804. ** A structure for holding a single date and time.
  17805. */
  17806. typedef struct DateTime DateTime;
  17807. struct DateTime {
  17808. sqlite3_int64 iJD; /* The julian day number times 86400000 */
  17809. int Y, M, D; /* Year, month, and day */
  17810. int h, m; /* Hour and minutes */
  17811. int tz; /* Timezone offset in minutes */
  17812. double s; /* Seconds */
  17813. char validYMD; /* True (1) if Y,M,D are valid */
  17814. char validHMS; /* True (1) if h,m,s are valid */
  17815. char validJD; /* True (1) if iJD is valid */
  17816. char validTZ; /* True (1) if tz is valid */
  17817. char tzSet; /* Timezone was set explicitly */
  17818. };
  17819. /*
  17820. ** Convert zDate into one or more integers according to the conversion
  17821. ** specifier zFormat.
  17822. **
  17823. ** zFormat[] contains 4 characters for each integer converted, except for
  17824. ** the last integer which is specified by three characters. The meaning
  17825. ** of a four-character format specifiers ABCD is:
  17826. **
  17827. ** A: number of digits to convert. Always "2" or "4".
  17828. ** B: minimum value. Always "0" or "1".
  17829. ** C: maximum value, decoded as:
  17830. ** a: 12
  17831. ** b: 14
  17832. ** c: 24
  17833. ** d: 31
  17834. ** e: 59
  17835. ** f: 9999
  17836. ** D: the separator character, or \000 to indicate this is the
  17837. ** last number to convert.
  17838. **
  17839. ** Example: To translate an ISO-8601 date YYYY-MM-DD, the format would
  17840. ** be "40f-21a-20c". The "40f-" indicates the 4-digit year followed by "-".
  17841. ** The "21a-" indicates the 2-digit month followed by "-". The "20c" indicates
  17842. ** the 2-digit day which is the last integer in the set.
  17843. **
  17844. ** The function returns the number of successful conversions.
  17845. */
  17846. static int getDigits(const char *zDate, const char *zFormat, ...){
  17847. /* The aMx[] array translates the 3rd character of each format
  17848. ** spec into a max size: a b c d e f */
  17849. static const u16 aMx[] = { 12, 14, 24, 31, 59, 9999 };
  17850. va_list ap;
  17851. int cnt = 0;
  17852. char nextC;
  17853. va_start(ap, zFormat);
  17854. do{
  17855. char N = zFormat[0] - '0';
  17856. char min = zFormat[1] - '0';
  17857. int val = 0;
  17858. u16 max;
  17859. assert( zFormat[2]>='a' && zFormat[2]<='f' );
  17860. max = aMx[zFormat[2] - 'a'];
  17861. nextC = zFormat[3];
  17862. val = 0;
  17863. while( N-- ){
  17864. if( !sqlite3Isdigit(*zDate) ){
  17865. goto end_getDigits;
  17866. }
  17867. val = val*10 + *zDate - '0';
  17868. zDate++;
  17869. }
  17870. if( val<(int)min || val>(int)max || (nextC!=0 && nextC!=*zDate) ){
  17871. goto end_getDigits;
  17872. }
  17873. *va_arg(ap,int*) = val;
  17874. zDate++;
  17875. cnt++;
  17876. zFormat += 4;
  17877. }while( nextC );
  17878. end_getDigits:
  17879. va_end(ap);
  17880. return cnt;
  17881. }
  17882. /*
  17883. ** Parse a timezone extension on the end of a date-time.
  17884. ** The extension is of the form:
  17885. **
  17886. ** (+/-)HH:MM
  17887. **
  17888. ** Or the "zulu" notation:
  17889. **
  17890. ** Z
  17891. **
  17892. ** If the parse is successful, write the number of minutes
  17893. ** of change in p->tz and return 0. If a parser error occurs,
  17894. ** return non-zero.
  17895. **
  17896. ** A missing specifier is not considered an error.
  17897. */
  17898. static int parseTimezone(const char *zDate, DateTime *p){
  17899. int sgn = 0;
  17900. int nHr, nMn;
  17901. int c;
  17902. while( sqlite3Isspace(*zDate) ){ zDate++; }
  17903. p->tz = 0;
  17904. c = *zDate;
  17905. if( c=='-' ){
  17906. sgn = -1;
  17907. }else if( c=='+' ){
  17908. sgn = +1;
  17909. }else if( c=='Z' || c=='z' ){
  17910. zDate++;
  17911. goto zulu_time;
  17912. }else{
  17913. return c!=0;
  17914. }
  17915. zDate++;
  17916. if( getDigits(zDate, "20b:20e", &nHr, &nMn)!=2 ){
  17917. return 1;
  17918. }
  17919. zDate += 5;
  17920. p->tz = sgn*(nMn + nHr*60);
  17921. zulu_time:
  17922. while( sqlite3Isspace(*zDate) ){ zDate++; }
  17923. p->tzSet = 1;
  17924. return *zDate!=0;
  17925. }
  17926. /*
  17927. ** Parse times of the form HH:MM or HH:MM:SS or HH:MM:SS.FFFF.
  17928. ** The HH, MM, and SS must each be exactly 2 digits. The
  17929. ** fractional seconds FFFF can be one or more digits.
  17930. **
  17931. ** Return 1 if there is a parsing error and 0 on success.
  17932. */
  17933. static int parseHhMmSs(const char *zDate, DateTime *p){
  17934. int h, m, s;
  17935. double ms = 0.0;
  17936. if( getDigits(zDate, "20c:20e", &h, &m)!=2 ){
  17937. return 1;
  17938. }
  17939. zDate += 5;
  17940. if( *zDate==':' ){
  17941. zDate++;
  17942. if( getDigits(zDate, "20e", &s)!=1 ){
  17943. return 1;
  17944. }
  17945. zDate += 2;
  17946. if( *zDate=='.' && sqlite3Isdigit(zDate[1]) ){
  17947. double rScale = 1.0;
  17948. zDate++;
  17949. while( sqlite3Isdigit(*zDate) ){
  17950. ms = ms*10.0 + *zDate - '0';
  17951. rScale *= 10.0;
  17952. zDate++;
  17953. }
  17954. ms /= rScale;
  17955. }
  17956. }else{
  17957. s = 0;
  17958. }
  17959. p->validJD = 0;
  17960. p->validHMS = 1;
  17961. p->h = h;
  17962. p->m = m;
  17963. p->s = s + ms;
  17964. if( parseTimezone(zDate, p) ) return 1;
  17965. p->validTZ = (p->tz!=0)?1:0;
  17966. return 0;
  17967. }
  17968. /*
  17969. ** Convert from YYYY-MM-DD HH:MM:SS to julian day. We always assume
  17970. ** that the YYYY-MM-DD is according to the Gregorian calendar.
  17971. **
  17972. ** Reference: Meeus page 61
  17973. */
  17974. static void computeJD(DateTime *p){
  17975. int Y, M, D, A, B, X1, X2;
  17976. if( p->validJD ) return;
  17977. if( p->validYMD ){
  17978. Y = p->Y;
  17979. M = p->M;
  17980. D = p->D;
  17981. }else{
  17982. Y = 2000; /* If no YMD specified, assume 2000-Jan-01 */
  17983. M = 1;
  17984. D = 1;
  17985. }
  17986. if( M<=2 ){
  17987. Y--;
  17988. M += 12;
  17989. }
  17990. A = Y/100;
  17991. B = 2 - A + (A/4);
  17992. X1 = 36525*(Y+4716)/100;
  17993. X2 = 306001*(M+1)/10000;
  17994. p->iJD = (sqlite3_int64)((X1 + X2 + D + B - 1524.5 ) * 86400000);
  17995. p->validJD = 1;
  17996. if( p->validHMS ){
  17997. p->iJD += p->h*3600000 + p->m*60000 + (sqlite3_int64)(p->s*1000);
  17998. if( p->validTZ ){
  17999. p->iJD -= p->tz*60000;
  18000. p->validYMD = 0;
  18001. p->validHMS = 0;
  18002. p->validTZ = 0;
  18003. }
  18004. }
  18005. }
  18006. /*
  18007. ** Parse dates of the form
  18008. **
  18009. ** YYYY-MM-DD HH:MM:SS.FFF
  18010. ** YYYY-MM-DD HH:MM:SS
  18011. ** YYYY-MM-DD HH:MM
  18012. ** YYYY-MM-DD
  18013. **
  18014. ** Write the result into the DateTime structure and return 0
  18015. ** on success and 1 if the input string is not a well-formed
  18016. ** date.
  18017. */
  18018. static int parseYyyyMmDd(const char *zDate, DateTime *p){
  18019. int Y, M, D, neg;
  18020. if( zDate[0]=='-' ){
  18021. zDate++;
  18022. neg = 1;
  18023. }else{
  18024. neg = 0;
  18025. }
  18026. if( getDigits(zDate, "40f-21a-21d", &Y, &M, &D)!=3 ){
  18027. return 1;
  18028. }
  18029. zDate += 10;
  18030. while( sqlite3Isspace(*zDate) || 'T'==*(u8*)zDate ){ zDate++; }
  18031. if( parseHhMmSs(zDate, p)==0 ){
  18032. /* We got the time */
  18033. }else if( *zDate==0 ){
  18034. p->validHMS = 0;
  18035. }else{
  18036. return 1;
  18037. }
  18038. p->validJD = 0;
  18039. p->validYMD = 1;
  18040. p->Y = neg ? -Y : Y;
  18041. p->M = M;
  18042. p->D = D;
  18043. if( p->validTZ ){
  18044. computeJD(p);
  18045. }
  18046. return 0;
  18047. }
  18048. /*
  18049. ** Set the time to the current time reported by the VFS.
  18050. **
  18051. ** Return the number of errors.
  18052. */
  18053. static int setDateTimeToCurrent(sqlite3_context *context, DateTime *p){
  18054. p->iJD = sqlite3StmtCurrentTime(context);
  18055. if( p->iJD>0 ){
  18056. p->validJD = 1;
  18057. return 0;
  18058. }else{
  18059. return 1;
  18060. }
  18061. }
  18062. /*
  18063. ** Attempt to parse the given string into a julian day number. Return
  18064. ** the number of errors.
  18065. **
  18066. ** The following are acceptable forms for the input string:
  18067. **
  18068. ** YYYY-MM-DD HH:MM:SS.FFF +/-HH:MM
  18069. ** DDDD.DD
  18070. ** now
  18071. **
  18072. ** In the first form, the +/-HH:MM is always optional. The fractional
  18073. ** seconds extension (the ".FFF") is optional. The seconds portion
  18074. ** (":SS.FFF") is option. The year and date can be omitted as long
  18075. ** as there is a time string. The time string can be omitted as long
  18076. ** as there is a year and date.
  18077. */
  18078. static int parseDateOrTime(
  18079. sqlite3_context *context,
  18080. const char *zDate,
  18081. DateTime *p
  18082. ){
  18083. double r;
  18084. if( parseYyyyMmDd(zDate,p)==0 ){
  18085. return 0;
  18086. }else if( parseHhMmSs(zDate, p)==0 ){
  18087. return 0;
  18088. }else if( sqlite3StrICmp(zDate,"now")==0){
  18089. return setDateTimeToCurrent(context, p);
  18090. }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8) ){
  18091. p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
  18092. p->validJD = 1;
  18093. return 0;
  18094. }
  18095. return 1;
  18096. }
  18097. /*
  18098. ** Compute the Year, Month, and Day from the julian day number.
  18099. */
  18100. static void computeYMD(DateTime *p){
  18101. int Z, A, B, C, D, E, X1;
  18102. if( p->validYMD ) return;
  18103. if( !p->validJD ){
  18104. p->Y = 2000;
  18105. p->M = 1;
  18106. p->D = 1;
  18107. }else{
  18108. Z = (int)((p->iJD + 43200000)/86400000);
  18109. A = (int)((Z - 1867216.25)/36524.25);
  18110. A = Z + 1 + A - (A/4);
  18111. B = A + 1524;
  18112. C = (int)((B - 122.1)/365.25);
  18113. D = (36525*(C&32767))/100;
  18114. E = (int)((B-D)/30.6001);
  18115. X1 = (int)(30.6001*E);
  18116. p->D = B - D - X1;
  18117. p->M = E<14 ? E-1 : E-13;
  18118. p->Y = p->M>2 ? C - 4716 : C - 4715;
  18119. }
  18120. p->validYMD = 1;
  18121. }
  18122. /*
  18123. ** Compute the Hour, Minute, and Seconds from the julian day number.
  18124. */
  18125. static void computeHMS(DateTime *p){
  18126. int s;
  18127. if( p->validHMS ) return;
  18128. computeJD(p);
  18129. s = (int)((p->iJD + 43200000) % 86400000);
  18130. p->s = s/1000.0;
  18131. s = (int)p->s;
  18132. p->s -= s;
  18133. p->h = s/3600;
  18134. s -= p->h*3600;
  18135. p->m = s/60;
  18136. p->s += s - p->m*60;
  18137. p->validHMS = 1;
  18138. }
  18139. /*
  18140. ** Compute both YMD and HMS
  18141. */
  18142. static void computeYMD_HMS(DateTime *p){
  18143. computeYMD(p);
  18144. computeHMS(p);
  18145. }
  18146. /*
  18147. ** Clear the YMD and HMS and the TZ
  18148. */
  18149. static void clearYMD_HMS_TZ(DateTime *p){
  18150. p->validYMD = 0;
  18151. p->validHMS = 0;
  18152. p->validTZ = 0;
  18153. }
  18154. #ifndef SQLITE_OMIT_LOCALTIME
  18155. /*
  18156. ** On recent Windows platforms, the localtime_s() function is available
  18157. ** as part of the "Secure CRT". It is essentially equivalent to
  18158. ** localtime_r() available under most POSIX platforms, except that the
  18159. ** order of the parameters is reversed.
  18160. **
  18161. ** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
  18162. **
  18163. ** If the user has not indicated to use localtime_r() or localtime_s()
  18164. ** already, check for an MSVC build environment that provides
  18165. ** localtime_s().
  18166. */
  18167. #if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
  18168. && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
  18169. #undef HAVE_LOCALTIME_S
  18170. #define HAVE_LOCALTIME_S 1
  18171. #endif
  18172. /*
  18173. ** The following routine implements the rough equivalent of localtime_r()
  18174. ** using whatever operating-system specific localtime facility that
  18175. ** is available. This routine returns 0 on success and
  18176. ** non-zero on any kind of error.
  18177. **
  18178. ** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
  18179. ** routine will always fail.
  18180. **
  18181. ** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
  18182. ** library function localtime_r() is used to assist in the calculation of
  18183. ** local time.
  18184. */
  18185. static int osLocaltime(time_t *t, struct tm *pTm){
  18186. int rc;
  18187. #if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
  18188. struct tm *pX;
  18189. #if SQLITE_THREADSAFE>0
  18190. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  18191. #endif
  18192. sqlite3_mutex_enter(mutex);
  18193. pX = localtime(t);
  18194. #ifndef SQLITE_OMIT_BUILTIN_TEST
  18195. if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
  18196. #endif
  18197. if( pX ) *pTm = *pX;
  18198. sqlite3_mutex_leave(mutex);
  18199. rc = pX==0;
  18200. #else
  18201. #ifndef SQLITE_OMIT_BUILTIN_TEST
  18202. if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
  18203. #endif
  18204. #if HAVE_LOCALTIME_R
  18205. rc = localtime_r(t, pTm)==0;
  18206. #else
  18207. rc = localtime_s(pTm, t);
  18208. #endif /* HAVE_LOCALTIME_R */
  18209. #endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
  18210. return rc;
  18211. }
  18212. #endif /* SQLITE_OMIT_LOCALTIME */
  18213. #ifndef SQLITE_OMIT_LOCALTIME
  18214. /*
  18215. ** Compute the difference (in milliseconds) between localtime and UTC
  18216. ** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
  18217. ** return this value and set *pRc to SQLITE_OK.
  18218. **
  18219. ** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
  18220. ** is undefined in this case.
  18221. */
  18222. static sqlite3_int64 localtimeOffset(
  18223. DateTime *p, /* Date at which to calculate offset */
  18224. sqlite3_context *pCtx, /* Write error here if one occurs */
  18225. int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
  18226. ){
  18227. DateTime x, y;
  18228. time_t t;
  18229. struct tm sLocal;
  18230. /* Initialize the contents of sLocal to avoid a compiler warning. */
  18231. memset(&sLocal, 0, sizeof(sLocal));
  18232. x = *p;
  18233. computeYMD_HMS(&x);
  18234. if( x.Y<1971 || x.Y>=2038 ){
  18235. /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
  18236. ** works for years between 1970 and 2037. For dates outside this range,
  18237. ** SQLite attempts to map the year into an equivalent year within this
  18238. ** range, do the calculation, then map the year back.
  18239. */
  18240. x.Y = 2000;
  18241. x.M = 1;
  18242. x.D = 1;
  18243. x.h = 0;
  18244. x.m = 0;
  18245. x.s = 0.0;
  18246. } else {
  18247. int s = (int)(x.s + 0.5);
  18248. x.s = s;
  18249. }
  18250. x.tz = 0;
  18251. x.validJD = 0;
  18252. computeJD(&x);
  18253. t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
  18254. if( osLocaltime(&t, &sLocal) ){
  18255. sqlite3_result_error(pCtx, "local time unavailable", -1);
  18256. *pRc = SQLITE_ERROR;
  18257. return 0;
  18258. }
  18259. y.Y = sLocal.tm_year + 1900;
  18260. y.M = sLocal.tm_mon + 1;
  18261. y.D = sLocal.tm_mday;
  18262. y.h = sLocal.tm_hour;
  18263. y.m = sLocal.tm_min;
  18264. y.s = sLocal.tm_sec;
  18265. y.validYMD = 1;
  18266. y.validHMS = 1;
  18267. y.validJD = 0;
  18268. y.validTZ = 0;
  18269. computeJD(&y);
  18270. *pRc = SQLITE_OK;
  18271. return y.iJD - x.iJD;
  18272. }
  18273. #endif /* SQLITE_OMIT_LOCALTIME */
  18274. /*
  18275. ** Process a modifier to a date-time stamp. The modifiers are
  18276. ** as follows:
  18277. **
  18278. ** NNN days
  18279. ** NNN hours
  18280. ** NNN minutes
  18281. ** NNN.NNNN seconds
  18282. ** NNN months
  18283. ** NNN years
  18284. ** start of month
  18285. ** start of year
  18286. ** start of week
  18287. ** start of day
  18288. ** weekday N
  18289. ** unixepoch
  18290. ** localtime
  18291. ** utc
  18292. **
  18293. ** Return 0 on success and 1 if there is any kind of error. If the error
  18294. ** is in a system call (i.e. localtime()), then an error message is written
  18295. ** to context pCtx. If the error is an unrecognized modifier, no error is
  18296. ** written to pCtx.
  18297. */
  18298. static int parseModifier(sqlite3_context *pCtx, const char *zMod, DateTime *p){
  18299. int rc = 1;
  18300. int n;
  18301. double r;
  18302. char *z, zBuf[30];
  18303. z = zBuf;
  18304. for(n=0; n<ArraySize(zBuf)-1 && zMod[n]; n++){
  18305. z[n] = (char)sqlite3UpperToLower[(u8)zMod[n]];
  18306. }
  18307. z[n] = 0;
  18308. switch( z[0] ){
  18309. #ifndef SQLITE_OMIT_LOCALTIME
  18310. case 'l': {
  18311. /* localtime
  18312. **
  18313. ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
  18314. ** show local time.
  18315. */
  18316. if( strcmp(z, "localtime")==0 ){
  18317. computeJD(p);
  18318. p->iJD += localtimeOffset(p, pCtx, &rc);
  18319. clearYMD_HMS_TZ(p);
  18320. }
  18321. break;
  18322. }
  18323. #endif
  18324. case 'u': {
  18325. /*
  18326. ** unixepoch
  18327. **
  18328. ** Treat the current value of p->iJD as the number of
  18329. ** seconds since 1970. Convert to a real julian day number.
  18330. */
  18331. if( strcmp(z, "unixepoch")==0 && p->validJD ){
  18332. p->iJD = (p->iJD + 43200)/86400 + 21086676*(i64)10000000;
  18333. clearYMD_HMS_TZ(p);
  18334. rc = 0;
  18335. }
  18336. #ifndef SQLITE_OMIT_LOCALTIME
  18337. else if( strcmp(z, "utc")==0 ){
  18338. if( p->tzSet==0 ){
  18339. sqlite3_int64 c1;
  18340. computeJD(p);
  18341. c1 = localtimeOffset(p, pCtx, &rc);
  18342. if( rc==SQLITE_OK ){
  18343. p->iJD -= c1;
  18344. clearYMD_HMS_TZ(p);
  18345. p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
  18346. }
  18347. p->tzSet = 1;
  18348. }else{
  18349. rc = SQLITE_OK;
  18350. }
  18351. }
  18352. #endif
  18353. break;
  18354. }
  18355. case 'w': {
  18356. /*
  18357. ** weekday N
  18358. **
  18359. ** Move the date to the same time on the next occurrence of
  18360. ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
  18361. ** date is already on the appropriate weekday, this is a no-op.
  18362. */
  18363. if( strncmp(z, "weekday ", 8)==0
  18364. && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)
  18365. && (n=(int)r)==r && n>=0 && r<7 ){
  18366. sqlite3_int64 Z;
  18367. computeYMD_HMS(p);
  18368. p->validTZ = 0;
  18369. p->validJD = 0;
  18370. computeJD(p);
  18371. Z = ((p->iJD + 129600000)/86400000) % 7;
  18372. if( Z>n ) Z -= 7;
  18373. p->iJD += (n - Z)*86400000;
  18374. clearYMD_HMS_TZ(p);
  18375. rc = 0;
  18376. }
  18377. break;
  18378. }
  18379. case 's': {
  18380. /*
  18381. ** start of TTTTT
  18382. **
  18383. ** Move the date backwards to the beginning of the current day,
  18384. ** or month or year.
  18385. */
  18386. if( strncmp(z, "start of ", 9)!=0 ) break;
  18387. z += 9;
  18388. computeYMD(p);
  18389. p->validHMS = 1;
  18390. p->h = p->m = 0;
  18391. p->s = 0.0;
  18392. p->validTZ = 0;
  18393. p->validJD = 0;
  18394. if( strcmp(z,"month")==0 ){
  18395. p->D = 1;
  18396. rc = 0;
  18397. }else if( strcmp(z,"year")==0 ){
  18398. computeYMD(p);
  18399. p->M = 1;
  18400. p->D = 1;
  18401. rc = 0;
  18402. }else if( strcmp(z,"day")==0 ){
  18403. rc = 0;
  18404. }
  18405. break;
  18406. }
  18407. case '+':
  18408. case '-':
  18409. case '0':
  18410. case '1':
  18411. case '2':
  18412. case '3':
  18413. case '4':
  18414. case '5':
  18415. case '6':
  18416. case '7':
  18417. case '8':
  18418. case '9': {
  18419. double rRounder;
  18420. for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
  18421. if( !sqlite3AtoF(z, &r, n, SQLITE_UTF8) ){
  18422. rc = 1;
  18423. break;
  18424. }
  18425. if( z[n]==':' ){
  18426. /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
  18427. ** specified number of hours, minutes, seconds, and fractional seconds
  18428. ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
  18429. ** omitted.
  18430. */
  18431. const char *z2 = z;
  18432. DateTime tx;
  18433. sqlite3_int64 day;
  18434. if( !sqlite3Isdigit(*z2) ) z2++;
  18435. memset(&tx, 0, sizeof(tx));
  18436. if( parseHhMmSs(z2, &tx) ) break;
  18437. computeJD(&tx);
  18438. tx.iJD -= 43200000;
  18439. day = tx.iJD/86400000;
  18440. tx.iJD -= day*86400000;
  18441. if( z[0]=='-' ) tx.iJD = -tx.iJD;
  18442. computeJD(p);
  18443. clearYMD_HMS_TZ(p);
  18444. p->iJD += tx.iJD;
  18445. rc = 0;
  18446. break;
  18447. }
  18448. z += n;
  18449. while( sqlite3Isspace(*z) ) z++;
  18450. n = sqlite3Strlen30(z);
  18451. if( n>10 || n<3 ) break;
  18452. if( z[n-1]=='s' ){ z[n-1] = 0; n--; }
  18453. computeJD(p);
  18454. rc = 0;
  18455. rRounder = r<0 ? -0.5 : +0.5;
  18456. if( n==3 && strcmp(z,"day")==0 ){
  18457. p->iJD += (sqlite3_int64)(r*86400000.0 + rRounder);
  18458. }else if( n==4 && strcmp(z,"hour")==0 ){
  18459. p->iJD += (sqlite3_int64)(r*(86400000.0/24.0) + rRounder);
  18460. }else if( n==6 && strcmp(z,"minute")==0 ){
  18461. p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0)) + rRounder);
  18462. }else if( n==6 && strcmp(z,"second")==0 ){
  18463. p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0*60.0)) + rRounder);
  18464. }else if( n==5 && strcmp(z,"month")==0 ){
  18465. int x, y;
  18466. computeYMD_HMS(p);
  18467. p->M += (int)r;
  18468. x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
  18469. p->Y += x;
  18470. p->M -= x*12;
  18471. p->validJD = 0;
  18472. computeJD(p);
  18473. y = (int)r;
  18474. if( y!=r ){
  18475. p->iJD += (sqlite3_int64)((r - y)*30.0*86400000.0 + rRounder);
  18476. }
  18477. }else if( n==4 && strcmp(z,"year")==0 ){
  18478. int y = (int)r;
  18479. computeYMD_HMS(p);
  18480. p->Y += y;
  18481. p->validJD = 0;
  18482. computeJD(p);
  18483. if( y!=r ){
  18484. p->iJD += (sqlite3_int64)((r - y)*365.0*86400000.0 + rRounder);
  18485. }
  18486. }else{
  18487. rc = 1;
  18488. }
  18489. clearYMD_HMS_TZ(p);
  18490. break;
  18491. }
  18492. default: {
  18493. break;
  18494. }
  18495. }
  18496. return rc;
  18497. }
  18498. /*
  18499. ** Process time function arguments. argv[0] is a date-time stamp.
  18500. ** argv[1] and following are modifiers. Parse them all and write
  18501. ** the resulting time into the DateTime structure p. Return 0
  18502. ** on success and 1 if there are any errors.
  18503. **
  18504. ** If there are zero parameters (if even argv[0] is undefined)
  18505. ** then assume a default value of "now" for argv[0].
  18506. */
  18507. static int isDate(
  18508. sqlite3_context *context,
  18509. int argc,
  18510. sqlite3_value **argv,
  18511. DateTime *p
  18512. ){
  18513. int i;
  18514. const unsigned char *z;
  18515. int eType;
  18516. memset(p, 0, sizeof(*p));
  18517. if( argc==0 ){
  18518. return setDateTimeToCurrent(context, p);
  18519. }
  18520. if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
  18521. || eType==SQLITE_INTEGER ){
  18522. p->iJD = (sqlite3_int64)(sqlite3_value_double(argv[0])*86400000.0 + 0.5);
  18523. p->validJD = 1;
  18524. }else{
  18525. z = sqlite3_value_text(argv[0]);
  18526. if( !z || parseDateOrTime(context, (char*)z, p) ){
  18527. return 1;
  18528. }
  18529. }
  18530. for(i=1; i<argc; i++){
  18531. z = sqlite3_value_text(argv[i]);
  18532. if( z==0 || parseModifier(context, (char*)z, p) ) return 1;
  18533. }
  18534. return 0;
  18535. }
  18536. /*
  18537. ** The following routines implement the various date and time functions
  18538. ** of SQLite.
  18539. */
  18540. /*
  18541. ** julianday( TIMESTRING, MOD, MOD, ...)
  18542. **
  18543. ** Return the julian day number of the date specified in the arguments
  18544. */
  18545. static void juliandayFunc(
  18546. sqlite3_context *context,
  18547. int argc,
  18548. sqlite3_value **argv
  18549. ){
  18550. DateTime x;
  18551. if( isDate(context, argc, argv, &x)==0 ){
  18552. computeJD(&x);
  18553. sqlite3_result_double(context, x.iJD/86400000.0);
  18554. }
  18555. }
  18556. /*
  18557. ** datetime( TIMESTRING, MOD, MOD, ...)
  18558. **
  18559. ** Return YYYY-MM-DD HH:MM:SS
  18560. */
  18561. static void datetimeFunc(
  18562. sqlite3_context *context,
  18563. int argc,
  18564. sqlite3_value **argv
  18565. ){
  18566. DateTime x;
  18567. if( isDate(context, argc, argv, &x)==0 ){
  18568. char zBuf[100];
  18569. computeYMD_HMS(&x);
  18570. sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
  18571. x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
  18572. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  18573. }
  18574. }
  18575. /*
  18576. ** time( TIMESTRING, MOD, MOD, ...)
  18577. **
  18578. ** Return HH:MM:SS
  18579. */
  18580. static void timeFunc(
  18581. sqlite3_context *context,
  18582. int argc,
  18583. sqlite3_value **argv
  18584. ){
  18585. DateTime x;
  18586. if( isDate(context, argc, argv, &x)==0 ){
  18587. char zBuf[100];
  18588. computeHMS(&x);
  18589. sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
  18590. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  18591. }
  18592. }
  18593. /*
  18594. ** date( TIMESTRING, MOD, MOD, ...)
  18595. **
  18596. ** Return YYYY-MM-DD
  18597. */
  18598. static void dateFunc(
  18599. sqlite3_context *context,
  18600. int argc,
  18601. sqlite3_value **argv
  18602. ){
  18603. DateTime x;
  18604. if( isDate(context, argc, argv, &x)==0 ){
  18605. char zBuf[100];
  18606. computeYMD(&x);
  18607. sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
  18608. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  18609. }
  18610. }
  18611. /*
  18612. ** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
  18613. **
  18614. ** Return a string described by FORMAT. Conversions as follows:
  18615. **
  18616. ** %d day of month
  18617. ** %f ** fractional seconds SS.SSS
  18618. ** %H hour 00-24
  18619. ** %j day of year 000-366
  18620. ** %J ** julian day number
  18621. ** %m month 01-12
  18622. ** %M minute 00-59
  18623. ** %s seconds since 1970-01-01
  18624. ** %S seconds 00-59
  18625. ** %w day of week 0-6 sunday==0
  18626. ** %W week of year 00-53
  18627. ** %Y year 0000-9999
  18628. ** %% %
  18629. */
  18630. static void strftimeFunc(
  18631. sqlite3_context *context,
  18632. int argc,
  18633. sqlite3_value **argv
  18634. ){
  18635. DateTime x;
  18636. u64 n;
  18637. size_t i,j;
  18638. char *z;
  18639. sqlite3 *db;
  18640. const char *zFmt;
  18641. char zBuf[100];
  18642. if( argc==0 ) return;
  18643. zFmt = (const char*)sqlite3_value_text(argv[0]);
  18644. if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
  18645. db = sqlite3_context_db_handle(context);
  18646. for(i=0, n=1; zFmt[i]; i++, n++){
  18647. if( zFmt[i]=='%' ){
  18648. switch( zFmt[i+1] ){
  18649. case 'd':
  18650. case 'H':
  18651. case 'm':
  18652. case 'M':
  18653. case 'S':
  18654. case 'W':
  18655. n++;
  18656. /* fall thru */
  18657. case 'w':
  18658. case '%':
  18659. break;
  18660. case 'f':
  18661. n += 8;
  18662. break;
  18663. case 'j':
  18664. n += 3;
  18665. break;
  18666. case 'Y':
  18667. n += 8;
  18668. break;
  18669. case 's':
  18670. case 'J':
  18671. n += 50;
  18672. break;
  18673. default:
  18674. return; /* ERROR. return a NULL */
  18675. }
  18676. i++;
  18677. }
  18678. }
  18679. testcase( n==sizeof(zBuf)-1 );
  18680. testcase( n==sizeof(zBuf) );
  18681. testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
  18682. testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH] );
  18683. if( n<sizeof(zBuf) ){
  18684. z = zBuf;
  18685. }else if( n>(u64)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  18686. sqlite3_result_error_toobig(context);
  18687. return;
  18688. }else{
  18689. z = sqlite3DbMallocRawNN(db, (int)n);
  18690. if( z==0 ){
  18691. sqlite3_result_error_nomem(context);
  18692. return;
  18693. }
  18694. }
  18695. computeJD(&x);
  18696. computeYMD_HMS(&x);
  18697. for(i=j=0; zFmt[i]; i++){
  18698. if( zFmt[i]!='%' ){
  18699. z[j++] = zFmt[i];
  18700. }else{
  18701. i++;
  18702. switch( zFmt[i] ){
  18703. case 'd': sqlite3_snprintf(3, &z[j],"%02d",x.D); j+=2; break;
  18704. case 'f': {
  18705. double s = x.s;
  18706. if( s>59.999 ) s = 59.999;
  18707. sqlite3_snprintf(7, &z[j],"%06.3f", s);
  18708. j += sqlite3Strlen30(&z[j]);
  18709. break;
  18710. }
  18711. case 'H': sqlite3_snprintf(3, &z[j],"%02d",x.h); j+=2; break;
  18712. case 'W': /* Fall thru */
  18713. case 'j': {
  18714. int nDay; /* Number of days since 1st day of year */
  18715. DateTime y = x;
  18716. y.validJD = 0;
  18717. y.M = 1;
  18718. y.D = 1;
  18719. computeJD(&y);
  18720. nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
  18721. if( zFmt[i]=='W' ){
  18722. int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
  18723. wd = (int)(((x.iJD+43200000)/86400000)%7);
  18724. sqlite3_snprintf(3, &z[j],"%02d",(nDay+7-wd)/7);
  18725. j += 2;
  18726. }else{
  18727. sqlite3_snprintf(4, &z[j],"%03d",nDay+1);
  18728. j += 3;
  18729. }
  18730. break;
  18731. }
  18732. case 'J': {
  18733. sqlite3_snprintf(20, &z[j],"%.16g",x.iJD/86400000.0);
  18734. j+=sqlite3Strlen30(&z[j]);
  18735. break;
  18736. }
  18737. case 'm': sqlite3_snprintf(3, &z[j],"%02d",x.M); j+=2; break;
  18738. case 'M': sqlite3_snprintf(3, &z[j],"%02d",x.m); j+=2; break;
  18739. case 's': {
  18740. sqlite3_snprintf(30,&z[j],"%lld",
  18741. (i64)(x.iJD/1000 - 21086676*(i64)10000));
  18742. j += sqlite3Strlen30(&z[j]);
  18743. break;
  18744. }
  18745. case 'S': sqlite3_snprintf(3,&z[j],"%02d",(int)x.s); j+=2; break;
  18746. case 'w': {
  18747. z[j++] = (char)(((x.iJD+129600000)/86400000) % 7) + '0';
  18748. break;
  18749. }
  18750. case 'Y': {
  18751. sqlite3_snprintf(5,&z[j],"%04d",x.Y); j+=sqlite3Strlen30(&z[j]);
  18752. break;
  18753. }
  18754. default: z[j++] = '%'; break;
  18755. }
  18756. }
  18757. }
  18758. z[j] = 0;
  18759. sqlite3_result_text(context, z, -1,
  18760. z==zBuf ? SQLITE_TRANSIENT : SQLITE_DYNAMIC);
  18761. }
  18762. /*
  18763. ** current_time()
  18764. **
  18765. ** This function returns the same value as time('now').
  18766. */
  18767. static void ctimeFunc(
  18768. sqlite3_context *context,
  18769. int NotUsed,
  18770. sqlite3_value **NotUsed2
  18771. ){
  18772. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  18773. timeFunc(context, 0, 0);
  18774. }
  18775. /*
  18776. ** current_date()
  18777. **
  18778. ** This function returns the same value as date('now').
  18779. */
  18780. static void cdateFunc(
  18781. sqlite3_context *context,
  18782. int NotUsed,
  18783. sqlite3_value **NotUsed2
  18784. ){
  18785. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  18786. dateFunc(context, 0, 0);
  18787. }
  18788. /*
  18789. ** current_timestamp()
  18790. **
  18791. ** This function returns the same value as datetime('now').
  18792. */
  18793. static void ctimestampFunc(
  18794. sqlite3_context *context,
  18795. int NotUsed,
  18796. sqlite3_value **NotUsed2
  18797. ){
  18798. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  18799. datetimeFunc(context, 0, 0);
  18800. }
  18801. #endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
  18802. #ifdef SQLITE_OMIT_DATETIME_FUNCS
  18803. /*
  18804. ** If the library is compiled to omit the full-scale date and time
  18805. ** handling (to get a smaller binary), the following minimal version
  18806. ** of the functions current_time(), current_date() and current_timestamp()
  18807. ** are included instead. This is to support column declarations that
  18808. ** include "DEFAULT CURRENT_TIME" etc.
  18809. **
  18810. ** This function uses the C-library functions time(), gmtime()
  18811. ** and strftime(). The format string to pass to strftime() is supplied
  18812. ** as the user-data for the function.
  18813. */
  18814. static void currentTimeFunc(
  18815. sqlite3_context *context,
  18816. int argc,
  18817. sqlite3_value **argv
  18818. ){
  18819. time_t t;
  18820. char *zFormat = (char *)sqlite3_user_data(context);
  18821. sqlite3_int64 iT;
  18822. struct tm *pTm;
  18823. struct tm sNow;
  18824. char zBuf[20];
  18825. UNUSED_PARAMETER(argc);
  18826. UNUSED_PARAMETER(argv);
  18827. iT = sqlite3StmtCurrentTime(context);
  18828. if( iT<=0 ) return;
  18829. t = iT/1000 - 10000*(sqlite3_int64)21086676;
  18830. #if HAVE_GMTIME_R
  18831. pTm = gmtime_r(&t, &sNow);
  18832. #else
  18833. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  18834. pTm = gmtime(&t);
  18835. if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
  18836. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  18837. #endif
  18838. if( pTm ){
  18839. strftime(zBuf, 20, zFormat, &sNow);
  18840. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  18841. }
  18842. }
  18843. #endif
  18844. /*
  18845. ** This function registered all of the above C functions as SQL
  18846. ** functions. This should be the only routine in this file with
  18847. ** external linkage.
  18848. */
  18849. SQLITE_PRIVATE void sqlite3RegisterDateTimeFunctions(void){
  18850. static FuncDef aDateTimeFuncs[] = {
  18851. #ifndef SQLITE_OMIT_DATETIME_FUNCS
  18852. DFUNCTION(julianday, -1, 0, 0, juliandayFunc ),
  18853. DFUNCTION(date, -1, 0, 0, dateFunc ),
  18854. DFUNCTION(time, -1, 0, 0, timeFunc ),
  18855. DFUNCTION(datetime, -1, 0, 0, datetimeFunc ),
  18856. DFUNCTION(strftime, -1, 0, 0, strftimeFunc ),
  18857. DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
  18858. DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
  18859. DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
  18860. #else
  18861. STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
  18862. STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
  18863. STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
  18864. #endif
  18865. };
  18866. sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
  18867. }
  18868. /************** End of date.c ************************************************/
  18869. /************** Begin file os.c **********************************************/
  18870. /*
  18871. ** 2005 November 29
  18872. **
  18873. ** The author disclaims copyright to this source code. In place of
  18874. ** a legal notice, here is a blessing:
  18875. **
  18876. ** May you do good and not evil.
  18877. ** May you find forgiveness for yourself and forgive others.
  18878. ** May you share freely, never taking more than you give.
  18879. **
  18880. ******************************************************************************
  18881. **
  18882. ** This file contains OS interface code that is common to all
  18883. ** architectures.
  18884. */
  18885. /* #include "sqliteInt.h" */
  18886. /*
  18887. ** If we compile with the SQLITE_TEST macro set, then the following block
  18888. ** of code will give us the ability to simulate a disk I/O error. This
  18889. ** is used for testing the I/O recovery logic.
  18890. */
  18891. #if defined(SQLITE_TEST)
  18892. SQLITE_API int sqlite3_io_error_hit = 0; /* Total number of I/O Errors */
  18893. SQLITE_API int sqlite3_io_error_hardhit = 0; /* Number of non-benign errors */
  18894. SQLITE_API int sqlite3_io_error_pending = 0; /* Count down to first I/O error */
  18895. SQLITE_API int sqlite3_io_error_persist = 0; /* True if I/O errors persist */
  18896. SQLITE_API int sqlite3_io_error_benign = 0; /* True if errors are benign */
  18897. SQLITE_API int sqlite3_diskfull_pending = 0;
  18898. SQLITE_API int sqlite3_diskfull = 0;
  18899. #endif /* defined(SQLITE_TEST) */
  18900. /*
  18901. ** When testing, also keep a count of the number of open files.
  18902. */
  18903. #if defined(SQLITE_TEST)
  18904. SQLITE_API int sqlite3_open_file_count = 0;
  18905. #endif /* defined(SQLITE_TEST) */
  18906. /*
  18907. ** The default SQLite sqlite3_vfs implementations do not allocate
  18908. ** memory (actually, os_unix.c allocates a small amount of memory
  18909. ** from within OsOpen()), but some third-party implementations may.
  18910. ** So we test the effects of a malloc() failing and the sqlite3OsXXX()
  18911. ** function returning SQLITE_IOERR_NOMEM using the DO_OS_MALLOC_TEST macro.
  18912. **
  18913. ** The following functions are instrumented for malloc() failure
  18914. ** testing:
  18915. **
  18916. ** sqlite3OsRead()
  18917. ** sqlite3OsWrite()
  18918. ** sqlite3OsSync()
  18919. ** sqlite3OsFileSize()
  18920. ** sqlite3OsLock()
  18921. ** sqlite3OsCheckReservedLock()
  18922. ** sqlite3OsFileControl()
  18923. ** sqlite3OsShmMap()
  18924. ** sqlite3OsOpen()
  18925. ** sqlite3OsDelete()
  18926. ** sqlite3OsAccess()
  18927. ** sqlite3OsFullPathname()
  18928. **
  18929. */
  18930. #if defined(SQLITE_TEST)
  18931. SQLITE_API int sqlite3_memdebug_vfs_oom_test = 1;
  18932. #define DO_OS_MALLOC_TEST(x) \
  18933. if (sqlite3_memdebug_vfs_oom_test && (!x || !sqlite3JournalIsInMemory(x))) { \
  18934. void *pTstAlloc = sqlite3Malloc(10); \
  18935. if (!pTstAlloc) return SQLITE_IOERR_NOMEM_BKPT; \
  18936. sqlite3_free(pTstAlloc); \
  18937. }
  18938. #else
  18939. #define DO_OS_MALLOC_TEST(x)
  18940. #endif
  18941. /*
  18942. ** The following routines are convenience wrappers around methods
  18943. ** of the sqlite3_file object. This is mostly just syntactic sugar. All
  18944. ** of this would be completely automatic if SQLite were coded using
  18945. ** C++ instead of plain old C.
  18946. */
  18947. SQLITE_PRIVATE void sqlite3OsClose(sqlite3_file *pId){
  18948. if( pId->pMethods ){
  18949. pId->pMethods->xClose(pId);
  18950. pId->pMethods = 0;
  18951. }
  18952. }
  18953. SQLITE_PRIVATE int sqlite3OsRead(sqlite3_file *id, void *pBuf, int amt, i64 offset){
  18954. DO_OS_MALLOC_TEST(id);
  18955. return id->pMethods->xRead(id, pBuf, amt, offset);
  18956. }
  18957. SQLITE_PRIVATE int sqlite3OsWrite(sqlite3_file *id, const void *pBuf, int amt, i64 offset){
  18958. DO_OS_MALLOC_TEST(id);
  18959. return id->pMethods->xWrite(id, pBuf, amt, offset);
  18960. }
  18961. SQLITE_PRIVATE int sqlite3OsTruncate(sqlite3_file *id, i64 size){
  18962. return id->pMethods->xTruncate(id, size);
  18963. }
  18964. SQLITE_PRIVATE int sqlite3OsSync(sqlite3_file *id, int flags){
  18965. DO_OS_MALLOC_TEST(id);
  18966. return id->pMethods->xSync(id, flags);
  18967. }
  18968. SQLITE_PRIVATE int sqlite3OsFileSize(sqlite3_file *id, i64 *pSize){
  18969. DO_OS_MALLOC_TEST(id);
  18970. return id->pMethods->xFileSize(id, pSize);
  18971. }
  18972. SQLITE_PRIVATE int sqlite3OsLock(sqlite3_file *id, int lockType){
  18973. DO_OS_MALLOC_TEST(id);
  18974. return id->pMethods->xLock(id, lockType);
  18975. }
  18976. SQLITE_PRIVATE int sqlite3OsUnlock(sqlite3_file *id, int lockType){
  18977. return id->pMethods->xUnlock(id, lockType);
  18978. }
  18979. SQLITE_PRIVATE int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut){
  18980. DO_OS_MALLOC_TEST(id);
  18981. return id->pMethods->xCheckReservedLock(id, pResOut);
  18982. }
  18983. /*
  18984. ** Use sqlite3OsFileControl() when we are doing something that might fail
  18985. ** and we need to know about the failures. Use sqlite3OsFileControlHint()
  18986. ** when simply tossing information over the wall to the VFS and we do not
  18987. ** really care if the VFS receives and understands the information since it
  18988. ** is only a hint and can be safely ignored. The sqlite3OsFileControlHint()
  18989. ** routine has no return value since the return value would be meaningless.
  18990. */
  18991. SQLITE_PRIVATE int sqlite3OsFileControl(sqlite3_file *id, int op, void *pArg){
  18992. #ifdef SQLITE_TEST
  18993. if( op!=SQLITE_FCNTL_COMMIT_PHASETWO ){
  18994. /* Faults are not injected into COMMIT_PHASETWO because, assuming SQLite
  18995. ** is using a regular VFS, it is called after the corresponding
  18996. ** transaction has been committed. Injecting a fault at this point
  18997. ** confuses the test scripts - the COMMIT comand returns SQLITE_NOMEM
  18998. ** but the transaction is committed anyway.
  18999. **
  19000. ** The core must call OsFileControl() though, not OsFileControlHint(),
  19001. ** as if a custom VFS (e.g. zipvfs) returns an error here, it probably
  19002. ** means the commit really has failed and an error should be returned
  19003. ** to the user. */
  19004. DO_OS_MALLOC_TEST(id);
  19005. }
  19006. #endif
  19007. return id->pMethods->xFileControl(id, op, pArg);
  19008. }
  19009. SQLITE_PRIVATE void sqlite3OsFileControlHint(sqlite3_file *id, int op, void *pArg){
  19010. (void)id->pMethods->xFileControl(id, op, pArg);
  19011. }
  19012. SQLITE_PRIVATE int sqlite3OsSectorSize(sqlite3_file *id){
  19013. int (*xSectorSize)(sqlite3_file*) = id->pMethods->xSectorSize;
  19014. return (xSectorSize ? xSectorSize(id) : SQLITE_DEFAULT_SECTOR_SIZE);
  19015. }
  19016. SQLITE_PRIVATE int sqlite3OsDeviceCharacteristics(sqlite3_file *id){
  19017. return id->pMethods->xDeviceCharacteristics(id);
  19018. }
  19019. SQLITE_PRIVATE int sqlite3OsShmLock(sqlite3_file *id, int offset, int n, int flags){
  19020. return id->pMethods->xShmLock(id, offset, n, flags);
  19021. }
  19022. SQLITE_PRIVATE void sqlite3OsShmBarrier(sqlite3_file *id){
  19023. id->pMethods->xShmBarrier(id);
  19024. }
  19025. SQLITE_PRIVATE int sqlite3OsShmUnmap(sqlite3_file *id, int deleteFlag){
  19026. return id->pMethods->xShmUnmap(id, deleteFlag);
  19027. }
  19028. SQLITE_PRIVATE int sqlite3OsShmMap(
  19029. sqlite3_file *id, /* Database file handle */
  19030. int iPage,
  19031. int pgsz,
  19032. int bExtend, /* True to extend file if necessary */
  19033. void volatile **pp /* OUT: Pointer to mapping */
  19034. ){
  19035. DO_OS_MALLOC_TEST(id);
  19036. return id->pMethods->xShmMap(id, iPage, pgsz, bExtend, pp);
  19037. }
  19038. #if SQLITE_MAX_MMAP_SIZE>0
  19039. /* The real implementation of xFetch and xUnfetch */
  19040. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64 iOff, int iAmt, void **pp){
  19041. DO_OS_MALLOC_TEST(id);
  19042. return id->pMethods->xFetch(id, iOff, iAmt, pp);
  19043. }
  19044. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *id, i64 iOff, void *p){
  19045. return id->pMethods->xUnfetch(id, iOff, p);
  19046. }
  19047. #else
  19048. /* No-op stubs to use when memory-mapped I/O is disabled */
  19049. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64 iOff, int iAmt, void **pp){
  19050. *pp = 0;
  19051. return SQLITE_OK;
  19052. }
  19053. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *id, i64 iOff, void *p){
  19054. return SQLITE_OK;
  19055. }
  19056. #endif
  19057. /*
  19058. ** The next group of routines are convenience wrappers around the
  19059. ** VFS methods.
  19060. */
  19061. SQLITE_PRIVATE int sqlite3OsOpen(
  19062. sqlite3_vfs *pVfs,
  19063. const char *zPath,
  19064. sqlite3_file *pFile,
  19065. int flags,
  19066. int *pFlagsOut
  19067. ){
  19068. int rc;
  19069. DO_OS_MALLOC_TEST(0);
  19070. /* 0x87f7f is a mask of SQLITE_OPEN_ flags that are valid to be passed
  19071. ** down into the VFS layer. Some SQLITE_OPEN_ flags (for example,
  19072. ** SQLITE_OPEN_FULLMUTEX or SQLITE_OPEN_SHAREDCACHE) are blocked before
  19073. ** reaching the VFS. */
  19074. rc = pVfs->xOpen(pVfs, zPath, pFile, flags & 0x87f7f, pFlagsOut);
  19075. assert( rc==SQLITE_OK || pFile->pMethods==0 );
  19076. return rc;
  19077. }
  19078. SQLITE_PRIVATE int sqlite3OsDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
  19079. DO_OS_MALLOC_TEST(0);
  19080. assert( dirSync==0 || dirSync==1 );
  19081. return pVfs->xDelete(pVfs, zPath, dirSync);
  19082. }
  19083. SQLITE_PRIVATE int sqlite3OsAccess(
  19084. sqlite3_vfs *pVfs,
  19085. const char *zPath,
  19086. int flags,
  19087. int *pResOut
  19088. ){
  19089. DO_OS_MALLOC_TEST(0);
  19090. return pVfs->xAccess(pVfs, zPath, flags, pResOut);
  19091. }
  19092. SQLITE_PRIVATE int sqlite3OsFullPathname(
  19093. sqlite3_vfs *pVfs,
  19094. const char *zPath,
  19095. int nPathOut,
  19096. char *zPathOut
  19097. ){
  19098. DO_OS_MALLOC_TEST(0);
  19099. zPathOut[0] = 0;
  19100. return pVfs->xFullPathname(pVfs, zPath, nPathOut, zPathOut);
  19101. }
  19102. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  19103. SQLITE_PRIVATE void *sqlite3OsDlOpen(sqlite3_vfs *pVfs, const char *zPath){
  19104. return pVfs->xDlOpen(pVfs, zPath);
  19105. }
  19106. SQLITE_PRIVATE void sqlite3OsDlError(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  19107. pVfs->xDlError(pVfs, nByte, zBufOut);
  19108. }
  19109. SQLITE_PRIVATE void (*sqlite3OsDlSym(sqlite3_vfs *pVfs, void *pHdle, const char *zSym))(void){
  19110. return pVfs->xDlSym(pVfs, pHdle, zSym);
  19111. }
  19112. SQLITE_PRIVATE void sqlite3OsDlClose(sqlite3_vfs *pVfs, void *pHandle){
  19113. pVfs->xDlClose(pVfs, pHandle);
  19114. }
  19115. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  19116. SQLITE_PRIVATE int sqlite3OsRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  19117. return pVfs->xRandomness(pVfs, nByte, zBufOut);
  19118. }
  19119. SQLITE_PRIVATE int sqlite3OsSleep(sqlite3_vfs *pVfs, int nMicro){
  19120. return pVfs->xSleep(pVfs, nMicro);
  19121. }
  19122. SQLITE_PRIVATE int sqlite3OsGetLastError(sqlite3_vfs *pVfs){
  19123. return pVfs->xGetLastError ? pVfs->xGetLastError(pVfs, 0, 0) : 0;
  19124. }
  19125. SQLITE_PRIVATE int sqlite3OsCurrentTimeInt64(sqlite3_vfs *pVfs, sqlite3_int64 *pTimeOut){
  19126. int rc;
  19127. /* IMPLEMENTATION-OF: R-49045-42493 SQLite will use the xCurrentTimeInt64()
  19128. ** method to get the current date and time if that method is available
  19129. ** (if iVersion is 2 or greater and the function pointer is not NULL) and
  19130. ** will fall back to xCurrentTime() if xCurrentTimeInt64() is
  19131. ** unavailable.
  19132. */
  19133. if( pVfs->iVersion>=2 && pVfs->xCurrentTimeInt64 ){
  19134. rc = pVfs->xCurrentTimeInt64(pVfs, pTimeOut);
  19135. }else{
  19136. double r;
  19137. rc = pVfs->xCurrentTime(pVfs, &r);
  19138. *pTimeOut = (sqlite3_int64)(r*86400000.0);
  19139. }
  19140. return rc;
  19141. }
  19142. SQLITE_PRIVATE int sqlite3OsOpenMalloc(
  19143. sqlite3_vfs *pVfs,
  19144. const char *zFile,
  19145. sqlite3_file **ppFile,
  19146. int flags,
  19147. int *pOutFlags
  19148. ){
  19149. int rc;
  19150. sqlite3_file *pFile;
  19151. pFile = (sqlite3_file *)sqlite3MallocZero(pVfs->szOsFile);
  19152. if( pFile ){
  19153. rc = sqlite3OsOpen(pVfs, zFile, pFile, flags, pOutFlags);
  19154. if( rc!=SQLITE_OK ){
  19155. sqlite3_free(pFile);
  19156. }else{
  19157. *ppFile = pFile;
  19158. }
  19159. }else{
  19160. rc = SQLITE_NOMEM_BKPT;
  19161. }
  19162. return rc;
  19163. }
  19164. SQLITE_PRIVATE void sqlite3OsCloseFree(sqlite3_file *pFile){
  19165. assert( pFile );
  19166. sqlite3OsClose(pFile);
  19167. sqlite3_free(pFile);
  19168. }
  19169. /*
  19170. ** This function is a wrapper around the OS specific implementation of
  19171. ** sqlite3_os_init(). The purpose of the wrapper is to provide the
  19172. ** ability to simulate a malloc failure, so that the handling of an
  19173. ** error in sqlite3_os_init() by the upper layers can be tested.
  19174. */
  19175. SQLITE_PRIVATE int sqlite3OsInit(void){
  19176. void *p = sqlite3_malloc(10);
  19177. if( p==0 ) return SQLITE_NOMEM_BKPT;
  19178. sqlite3_free(p);
  19179. return sqlite3_os_init();
  19180. }
  19181. /*
  19182. ** The list of all registered VFS implementations.
  19183. */
  19184. static sqlite3_vfs * SQLITE_WSD vfsList = 0;
  19185. #define vfsList GLOBAL(sqlite3_vfs *, vfsList)
  19186. /*
  19187. ** Locate a VFS by name. If no name is given, simply return the
  19188. ** first VFS on the list.
  19189. */
  19190. SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfs){
  19191. sqlite3_vfs *pVfs = 0;
  19192. #if SQLITE_THREADSAFE
  19193. sqlite3_mutex *mutex;
  19194. #endif
  19195. #ifndef SQLITE_OMIT_AUTOINIT
  19196. int rc = sqlite3_initialize();
  19197. if( rc ) return 0;
  19198. #endif
  19199. #if SQLITE_THREADSAFE
  19200. mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  19201. #endif
  19202. sqlite3_mutex_enter(mutex);
  19203. for(pVfs = vfsList; pVfs; pVfs=pVfs->pNext){
  19204. if( zVfs==0 ) break;
  19205. if( strcmp(zVfs, pVfs->zName)==0 ) break;
  19206. }
  19207. sqlite3_mutex_leave(mutex);
  19208. return pVfs;
  19209. }
  19210. /*
  19211. ** Unlink a VFS from the linked list
  19212. */
  19213. static void vfsUnlink(sqlite3_vfs *pVfs){
  19214. assert( sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER)) );
  19215. if( pVfs==0 ){
  19216. /* No-op */
  19217. }else if( vfsList==pVfs ){
  19218. vfsList = pVfs->pNext;
  19219. }else if( vfsList ){
  19220. sqlite3_vfs *p = vfsList;
  19221. while( p->pNext && p->pNext!=pVfs ){
  19222. p = p->pNext;
  19223. }
  19224. if( p->pNext==pVfs ){
  19225. p->pNext = pVfs->pNext;
  19226. }
  19227. }
  19228. }
  19229. /*
  19230. ** Register a VFS with the system. It is harmless to register the same
  19231. ** VFS multiple times. The new VFS becomes the default if makeDflt is
  19232. ** true.
  19233. */
  19234. SQLITE_API int sqlite3_vfs_register(sqlite3_vfs *pVfs, int makeDflt){
  19235. MUTEX_LOGIC(sqlite3_mutex *mutex;)
  19236. #ifndef SQLITE_OMIT_AUTOINIT
  19237. int rc = sqlite3_initialize();
  19238. if( rc ) return rc;
  19239. #endif
  19240. #ifdef SQLITE_ENABLE_API_ARMOR
  19241. if( pVfs==0 ) return SQLITE_MISUSE_BKPT;
  19242. #endif
  19243. MUTEX_LOGIC( mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  19244. sqlite3_mutex_enter(mutex);
  19245. vfsUnlink(pVfs);
  19246. if( makeDflt || vfsList==0 ){
  19247. pVfs->pNext = vfsList;
  19248. vfsList = pVfs;
  19249. }else{
  19250. pVfs->pNext = vfsList->pNext;
  19251. vfsList->pNext = pVfs;
  19252. }
  19253. assert(vfsList);
  19254. sqlite3_mutex_leave(mutex);
  19255. return SQLITE_OK;
  19256. }
  19257. /*
  19258. ** Unregister a VFS so that it is no longer accessible.
  19259. */
  19260. SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs *pVfs){
  19261. #if SQLITE_THREADSAFE
  19262. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  19263. #endif
  19264. sqlite3_mutex_enter(mutex);
  19265. vfsUnlink(pVfs);
  19266. sqlite3_mutex_leave(mutex);
  19267. return SQLITE_OK;
  19268. }
  19269. /************** End of os.c **************************************************/
  19270. /************** Begin file fault.c *******************************************/
  19271. /*
  19272. ** 2008 Jan 22
  19273. **
  19274. ** The author disclaims copyright to this source code. In place of
  19275. ** a legal notice, here is a blessing:
  19276. **
  19277. ** May you do good and not evil.
  19278. ** May you find forgiveness for yourself and forgive others.
  19279. ** May you share freely, never taking more than you give.
  19280. **
  19281. *************************************************************************
  19282. **
  19283. ** This file contains code to support the concept of "benign"
  19284. ** malloc failures (when the xMalloc() or xRealloc() method of the
  19285. ** sqlite3_mem_methods structure fails to allocate a block of memory
  19286. ** and returns 0).
  19287. **
  19288. ** Most malloc failures are non-benign. After they occur, SQLite
  19289. ** abandons the current operation and returns an error code (usually
  19290. ** SQLITE_NOMEM) to the user. However, sometimes a fault is not necessarily
  19291. ** fatal. For example, if a malloc fails while resizing a hash table, this
  19292. ** is completely recoverable simply by not carrying out the resize. The
  19293. ** hash table will continue to function normally. So a malloc failure
  19294. ** during a hash table resize is a benign fault.
  19295. */
  19296. /* #include "sqliteInt.h" */
  19297. #ifndef SQLITE_OMIT_BUILTIN_TEST
  19298. /*
  19299. ** Global variables.
  19300. */
  19301. typedef struct BenignMallocHooks BenignMallocHooks;
  19302. static SQLITE_WSD struct BenignMallocHooks {
  19303. void (*xBenignBegin)(void);
  19304. void (*xBenignEnd)(void);
  19305. } sqlite3Hooks = { 0, 0 };
  19306. /* The "wsdHooks" macro will resolve to the appropriate BenignMallocHooks
  19307. ** structure. If writable static data is unsupported on the target,
  19308. ** we have to locate the state vector at run-time. In the more common
  19309. ** case where writable static data is supported, wsdHooks can refer directly
  19310. ** to the "sqlite3Hooks" state vector declared above.
  19311. */
  19312. #ifdef SQLITE_OMIT_WSD
  19313. # define wsdHooksInit \
  19314. BenignMallocHooks *x = &GLOBAL(BenignMallocHooks,sqlite3Hooks)
  19315. # define wsdHooks x[0]
  19316. #else
  19317. # define wsdHooksInit
  19318. # define wsdHooks sqlite3Hooks
  19319. #endif
  19320. /*
  19321. ** Register hooks to call when sqlite3BeginBenignMalloc() and
  19322. ** sqlite3EndBenignMalloc() are called, respectively.
  19323. */
  19324. SQLITE_PRIVATE void sqlite3BenignMallocHooks(
  19325. void (*xBenignBegin)(void),
  19326. void (*xBenignEnd)(void)
  19327. ){
  19328. wsdHooksInit;
  19329. wsdHooks.xBenignBegin = xBenignBegin;
  19330. wsdHooks.xBenignEnd = xBenignEnd;
  19331. }
  19332. /*
  19333. ** This (sqlite3EndBenignMalloc()) is called by SQLite code to indicate that
  19334. ** subsequent malloc failures are benign. A call to sqlite3EndBenignMalloc()
  19335. ** indicates that subsequent malloc failures are non-benign.
  19336. */
  19337. SQLITE_PRIVATE void sqlite3BeginBenignMalloc(void){
  19338. wsdHooksInit;
  19339. if( wsdHooks.xBenignBegin ){
  19340. wsdHooks.xBenignBegin();
  19341. }
  19342. }
  19343. SQLITE_PRIVATE void sqlite3EndBenignMalloc(void){
  19344. wsdHooksInit;
  19345. if( wsdHooks.xBenignEnd ){
  19346. wsdHooks.xBenignEnd();
  19347. }
  19348. }
  19349. #endif /* #ifndef SQLITE_OMIT_BUILTIN_TEST */
  19350. /************** End of fault.c ***********************************************/
  19351. /************** Begin file mem0.c ********************************************/
  19352. /*
  19353. ** 2008 October 28
  19354. **
  19355. ** The author disclaims copyright to this source code. In place of
  19356. ** a legal notice, here is a blessing:
  19357. **
  19358. ** May you do good and not evil.
  19359. ** May you find forgiveness for yourself and forgive others.
  19360. ** May you share freely, never taking more than you give.
  19361. **
  19362. *************************************************************************
  19363. **
  19364. ** This file contains a no-op memory allocation drivers for use when
  19365. ** SQLITE_ZERO_MALLOC is defined. The allocation drivers implemented
  19366. ** here always fail. SQLite will not operate with these drivers. These
  19367. ** are merely placeholders. Real drivers must be substituted using
  19368. ** sqlite3_config() before SQLite will operate.
  19369. */
  19370. /* #include "sqliteInt.h" */
  19371. /*
  19372. ** This version of the memory allocator is the default. It is
  19373. ** used when no other memory allocator is specified using compile-time
  19374. ** macros.
  19375. */
  19376. #ifdef SQLITE_ZERO_MALLOC
  19377. /*
  19378. ** No-op versions of all memory allocation routines
  19379. */
  19380. static void *sqlite3MemMalloc(int nByte){ return 0; }
  19381. static void sqlite3MemFree(void *pPrior){ return; }
  19382. static void *sqlite3MemRealloc(void *pPrior, int nByte){ return 0; }
  19383. static int sqlite3MemSize(void *pPrior){ return 0; }
  19384. static int sqlite3MemRoundup(int n){ return n; }
  19385. static int sqlite3MemInit(void *NotUsed){ return SQLITE_OK; }
  19386. static void sqlite3MemShutdown(void *NotUsed){ return; }
  19387. /*
  19388. ** This routine is the only routine in this file with external linkage.
  19389. **
  19390. ** Populate the low-level memory allocation function pointers in
  19391. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  19392. */
  19393. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  19394. static const sqlite3_mem_methods defaultMethods = {
  19395. sqlite3MemMalloc,
  19396. sqlite3MemFree,
  19397. sqlite3MemRealloc,
  19398. sqlite3MemSize,
  19399. sqlite3MemRoundup,
  19400. sqlite3MemInit,
  19401. sqlite3MemShutdown,
  19402. 0
  19403. };
  19404. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  19405. }
  19406. #endif /* SQLITE_ZERO_MALLOC */
  19407. /************** End of mem0.c ************************************************/
  19408. /************** Begin file mem1.c ********************************************/
  19409. /*
  19410. ** 2007 August 14
  19411. **
  19412. ** The author disclaims copyright to this source code. In place of
  19413. ** a legal notice, here is a blessing:
  19414. **
  19415. ** May you do good and not evil.
  19416. ** May you find forgiveness for yourself and forgive others.
  19417. ** May you share freely, never taking more than you give.
  19418. **
  19419. *************************************************************************
  19420. **
  19421. ** This file contains low-level memory allocation drivers for when
  19422. ** SQLite will use the standard C-library malloc/realloc/free interface
  19423. ** to obtain the memory it needs.
  19424. **
  19425. ** This file contains implementations of the low-level memory allocation
  19426. ** routines specified in the sqlite3_mem_methods object. The content of
  19427. ** this file is only used if SQLITE_SYSTEM_MALLOC is defined. The
  19428. ** SQLITE_SYSTEM_MALLOC macro is defined automatically if neither the
  19429. ** SQLITE_MEMDEBUG nor the SQLITE_WIN32_MALLOC macros are defined. The
  19430. ** default configuration is to use memory allocation routines in this
  19431. ** file.
  19432. **
  19433. ** C-preprocessor macro summary:
  19434. **
  19435. ** HAVE_MALLOC_USABLE_SIZE The configure script sets this symbol if
  19436. ** the malloc_usable_size() interface exists
  19437. ** on the target platform. Or, this symbol
  19438. ** can be set manually, if desired.
  19439. ** If an equivalent interface exists by
  19440. ** a different name, using a separate -D
  19441. ** option to rename it.
  19442. **
  19443. ** SQLITE_WITHOUT_ZONEMALLOC Some older macs lack support for the zone
  19444. ** memory allocator. Set this symbol to enable
  19445. ** building on older macs.
  19446. **
  19447. ** SQLITE_WITHOUT_MSIZE Set this symbol to disable the use of
  19448. ** _msize() on windows systems. This might
  19449. ** be necessary when compiling for Delphi,
  19450. ** for example.
  19451. */
  19452. /* #include "sqliteInt.h" */
  19453. /*
  19454. ** This version of the memory allocator is the default. It is
  19455. ** used when no other memory allocator is specified using compile-time
  19456. ** macros.
  19457. */
  19458. #ifdef SQLITE_SYSTEM_MALLOC
  19459. #if defined(__APPLE__) && !defined(SQLITE_WITHOUT_ZONEMALLOC)
  19460. /*
  19461. ** Use the zone allocator available on apple products unless the
  19462. ** SQLITE_WITHOUT_ZONEMALLOC symbol is defined.
  19463. */
  19464. #include <sys/sysctl.h>
  19465. #include <malloc/malloc.h>
  19466. #include <libkern/OSAtomic.h>
  19467. static malloc_zone_t* _sqliteZone_;
  19468. #define SQLITE_MALLOC(x) malloc_zone_malloc(_sqliteZone_, (x))
  19469. #define SQLITE_FREE(x) malloc_zone_free(_sqliteZone_, (x));
  19470. #define SQLITE_REALLOC(x,y) malloc_zone_realloc(_sqliteZone_, (x), (y))
  19471. #define SQLITE_MALLOCSIZE(x) \
  19472. (_sqliteZone_ ? _sqliteZone_->size(_sqliteZone_,x) : malloc_size(x))
  19473. #else /* if not __APPLE__ */
  19474. /*
  19475. ** Use standard C library malloc and free on non-Apple systems.
  19476. ** Also used by Apple systems if SQLITE_WITHOUT_ZONEMALLOC is defined.
  19477. */
  19478. #define SQLITE_MALLOC(x) malloc(x)
  19479. #define SQLITE_FREE(x) free(x)
  19480. #define SQLITE_REALLOC(x,y) realloc((x),(y))
  19481. /*
  19482. ** The malloc.h header file is needed for malloc_usable_size() function
  19483. ** on some systems (e.g. Linux).
  19484. */
  19485. #if HAVE_MALLOC_H && HAVE_MALLOC_USABLE_SIZE
  19486. # define SQLITE_USE_MALLOC_H 1
  19487. # define SQLITE_USE_MALLOC_USABLE_SIZE 1
  19488. /*
  19489. ** The MSVCRT has malloc_usable_size(), but it is called _msize(). The
  19490. ** use of _msize() is automatic, but can be disabled by compiling with
  19491. ** -DSQLITE_WITHOUT_MSIZE. Using the _msize() function also requires
  19492. ** the malloc.h header file.
  19493. */
  19494. #elif defined(_MSC_VER) && !defined(SQLITE_WITHOUT_MSIZE)
  19495. # define SQLITE_USE_MALLOC_H
  19496. # define SQLITE_USE_MSIZE
  19497. #endif
  19498. /*
  19499. ** Include the malloc.h header file, if necessary. Also set define macro
  19500. ** SQLITE_MALLOCSIZE to the appropriate function name, which is _msize()
  19501. ** for MSVC and malloc_usable_size() for most other systems (e.g. Linux).
  19502. ** The memory size function can always be overridden manually by defining
  19503. ** the macro SQLITE_MALLOCSIZE to the desired function name.
  19504. */
  19505. #if defined(SQLITE_USE_MALLOC_H)
  19506. # include <malloc.h>
  19507. # if defined(SQLITE_USE_MALLOC_USABLE_SIZE)
  19508. # if !defined(SQLITE_MALLOCSIZE)
  19509. # define SQLITE_MALLOCSIZE(x) malloc_usable_size(x)
  19510. # endif
  19511. # elif defined(SQLITE_USE_MSIZE)
  19512. # if !defined(SQLITE_MALLOCSIZE)
  19513. # define SQLITE_MALLOCSIZE _msize
  19514. # endif
  19515. # endif
  19516. #endif /* defined(SQLITE_USE_MALLOC_H) */
  19517. #endif /* __APPLE__ or not __APPLE__ */
  19518. /*
  19519. ** Like malloc(), but remember the size of the allocation
  19520. ** so that we can find it later using sqlite3MemSize().
  19521. **
  19522. ** For this low-level routine, we are guaranteed that nByte>0 because
  19523. ** cases of nByte<=0 will be intercepted and dealt with by higher level
  19524. ** routines.
  19525. */
  19526. static void *sqlite3MemMalloc(int nByte){
  19527. #ifdef SQLITE_MALLOCSIZE
  19528. void *p = SQLITE_MALLOC( nByte );
  19529. if( p==0 ){
  19530. testcase( sqlite3GlobalConfig.xLog!=0 );
  19531. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes of memory", nByte);
  19532. }
  19533. return p;
  19534. #else
  19535. sqlite3_int64 *p;
  19536. assert( nByte>0 );
  19537. nByte = ROUND8(nByte);
  19538. p = SQLITE_MALLOC( nByte+8 );
  19539. if( p ){
  19540. p[0] = nByte;
  19541. p++;
  19542. }else{
  19543. testcase( sqlite3GlobalConfig.xLog!=0 );
  19544. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes of memory", nByte);
  19545. }
  19546. return (void *)p;
  19547. #endif
  19548. }
  19549. /*
  19550. ** Like free() but works for allocations obtained from sqlite3MemMalloc()
  19551. ** or sqlite3MemRealloc().
  19552. **
  19553. ** For this low-level routine, we already know that pPrior!=0 since
  19554. ** cases where pPrior==0 will have been intecepted and dealt with
  19555. ** by higher-level routines.
  19556. */
  19557. static void sqlite3MemFree(void *pPrior){
  19558. #ifdef SQLITE_MALLOCSIZE
  19559. SQLITE_FREE(pPrior);
  19560. #else
  19561. sqlite3_int64 *p = (sqlite3_int64*)pPrior;
  19562. assert( pPrior!=0 );
  19563. p--;
  19564. SQLITE_FREE(p);
  19565. #endif
  19566. }
  19567. /*
  19568. ** Report the allocated size of a prior return from xMalloc()
  19569. ** or xRealloc().
  19570. */
  19571. static int sqlite3MemSize(void *pPrior){
  19572. #ifdef SQLITE_MALLOCSIZE
  19573. assert( pPrior!=0 );
  19574. return (int)SQLITE_MALLOCSIZE(pPrior);
  19575. #else
  19576. sqlite3_int64 *p;
  19577. assert( pPrior!=0 );
  19578. p = (sqlite3_int64*)pPrior;
  19579. p--;
  19580. return (int)p[0];
  19581. #endif
  19582. }
  19583. /*
  19584. ** Like realloc(). Resize an allocation previously obtained from
  19585. ** sqlite3MemMalloc().
  19586. **
  19587. ** For this low-level interface, we know that pPrior!=0. Cases where
  19588. ** pPrior==0 while have been intercepted by higher-level routine and
  19589. ** redirected to xMalloc. Similarly, we know that nByte>0 because
  19590. ** cases where nByte<=0 will have been intercepted by higher-level
  19591. ** routines and redirected to xFree.
  19592. */
  19593. static void *sqlite3MemRealloc(void *pPrior, int nByte){
  19594. #ifdef SQLITE_MALLOCSIZE
  19595. void *p = SQLITE_REALLOC(pPrior, nByte);
  19596. if( p==0 ){
  19597. testcase( sqlite3GlobalConfig.xLog!=0 );
  19598. sqlite3_log(SQLITE_NOMEM,
  19599. "failed memory resize %u to %u bytes",
  19600. SQLITE_MALLOCSIZE(pPrior), nByte);
  19601. }
  19602. return p;
  19603. #else
  19604. sqlite3_int64 *p = (sqlite3_int64*)pPrior;
  19605. assert( pPrior!=0 && nByte>0 );
  19606. assert( nByte==ROUND8(nByte) ); /* EV: R-46199-30249 */
  19607. p--;
  19608. p = SQLITE_REALLOC(p, nByte+8 );
  19609. if( p ){
  19610. p[0] = nByte;
  19611. p++;
  19612. }else{
  19613. testcase( sqlite3GlobalConfig.xLog!=0 );
  19614. sqlite3_log(SQLITE_NOMEM,
  19615. "failed memory resize %u to %u bytes",
  19616. sqlite3MemSize(pPrior), nByte);
  19617. }
  19618. return (void*)p;
  19619. #endif
  19620. }
  19621. /*
  19622. ** Round up a request size to the next valid allocation size.
  19623. */
  19624. static int sqlite3MemRoundup(int n){
  19625. return ROUND8(n);
  19626. }
  19627. /*
  19628. ** Initialize this module.
  19629. */
  19630. static int sqlite3MemInit(void *NotUsed){
  19631. #if defined(__APPLE__) && !defined(SQLITE_WITHOUT_ZONEMALLOC)
  19632. int cpuCount;
  19633. size_t len;
  19634. if( _sqliteZone_ ){
  19635. return SQLITE_OK;
  19636. }
  19637. len = sizeof(cpuCount);
  19638. /* One usually wants to use hw.acctivecpu for MT decisions, but not here */
  19639. sysctlbyname("hw.ncpu", &cpuCount, &len, NULL, 0);
  19640. if( cpuCount>1 ){
  19641. /* defer MT decisions to system malloc */
  19642. _sqliteZone_ = malloc_default_zone();
  19643. }else{
  19644. /* only 1 core, use our own zone to contention over global locks,
  19645. ** e.g. we have our own dedicated locks */
  19646. bool success;
  19647. malloc_zone_t* newzone = malloc_create_zone(4096, 0);
  19648. malloc_set_zone_name(newzone, "Sqlite_Heap");
  19649. do{
  19650. success = OSAtomicCompareAndSwapPtrBarrier(NULL, newzone,
  19651. (void * volatile *)&_sqliteZone_);
  19652. }while(!_sqliteZone_);
  19653. if( !success ){
  19654. /* somebody registered a zone first */
  19655. malloc_destroy_zone(newzone);
  19656. }
  19657. }
  19658. #endif
  19659. UNUSED_PARAMETER(NotUsed);
  19660. return SQLITE_OK;
  19661. }
  19662. /*
  19663. ** Deinitialize this module.
  19664. */
  19665. static void sqlite3MemShutdown(void *NotUsed){
  19666. UNUSED_PARAMETER(NotUsed);
  19667. return;
  19668. }
  19669. /*
  19670. ** This routine is the only routine in this file with external linkage.
  19671. **
  19672. ** Populate the low-level memory allocation function pointers in
  19673. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  19674. */
  19675. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  19676. static const sqlite3_mem_methods defaultMethods = {
  19677. sqlite3MemMalloc,
  19678. sqlite3MemFree,
  19679. sqlite3MemRealloc,
  19680. sqlite3MemSize,
  19681. sqlite3MemRoundup,
  19682. sqlite3MemInit,
  19683. sqlite3MemShutdown,
  19684. 0
  19685. };
  19686. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  19687. }
  19688. #endif /* SQLITE_SYSTEM_MALLOC */
  19689. /************** End of mem1.c ************************************************/
  19690. /************** Begin file mem2.c ********************************************/
  19691. /*
  19692. ** 2007 August 15
  19693. **
  19694. ** The author disclaims copyright to this source code. In place of
  19695. ** a legal notice, here is a blessing:
  19696. **
  19697. ** May you do good and not evil.
  19698. ** May you find forgiveness for yourself and forgive others.
  19699. ** May you share freely, never taking more than you give.
  19700. **
  19701. *************************************************************************
  19702. **
  19703. ** This file contains low-level memory allocation drivers for when
  19704. ** SQLite will use the standard C-library malloc/realloc/free interface
  19705. ** to obtain the memory it needs while adding lots of additional debugging
  19706. ** information to each allocation in order to help detect and fix memory
  19707. ** leaks and memory usage errors.
  19708. **
  19709. ** This file contains implementations of the low-level memory allocation
  19710. ** routines specified in the sqlite3_mem_methods object.
  19711. */
  19712. /* #include "sqliteInt.h" */
  19713. /*
  19714. ** This version of the memory allocator is used only if the
  19715. ** SQLITE_MEMDEBUG macro is defined
  19716. */
  19717. #ifdef SQLITE_MEMDEBUG
  19718. /*
  19719. ** The backtrace functionality is only available with GLIBC
  19720. */
  19721. #ifdef __GLIBC__
  19722. extern int backtrace(void**,int);
  19723. extern void backtrace_symbols_fd(void*const*,int,int);
  19724. #else
  19725. # define backtrace(A,B) 1
  19726. # define backtrace_symbols_fd(A,B,C)
  19727. #endif
  19728. /* #include <stdio.h> */
  19729. /*
  19730. ** Each memory allocation looks like this:
  19731. **
  19732. ** ------------------------------------------------------------------------
  19733. ** | Title | backtrace pointers | MemBlockHdr | allocation | EndGuard |
  19734. ** ------------------------------------------------------------------------
  19735. **
  19736. ** The application code sees only a pointer to the allocation. We have
  19737. ** to back up from the allocation pointer to find the MemBlockHdr. The
  19738. ** MemBlockHdr tells us the size of the allocation and the number of
  19739. ** backtrace pointers. There is also a guard word at the end of the
  19740. ** MemBlockHdr.
  19741. */
  19742. struct MemBlockHdr {
  19743. i64 iSize; /* Size of this allocation */
  19744. struct MemBlockHdr *pNext, *pPrev; /* Linked list of all unfreed memory */
  19745. char nBacktrace; /* Number of backtraces on this alloc */
  19746. char nBacktraceSlots; /* Available backtrace slots */
  19747. u8 nTitle; /* Bytes of title; includes '\0' */
  19748. u8 eType; /* Allocation type code */
  19749. int iForeGuard; /* Guard word for sanity */
  19750. };
  19751. /*
  19752. ** Guard words
  19753. */
  19754. #define FOREGUARD 0x80F5E153
  19755. #define REARGUARD 0xE4676B53
  19756. /*
  19757. ** Number of malloc size increments to track.
  19758. */
  19759. #define NCSIZE 1000
  19760. /*
  19761. ** All of the static variables used by this module are collected
  19762. ** into a single structure named "mem". This is to keep the
  19763. ** static variables organized and to reduce namespace pollution
  19764. ** when this module is combined with other in the amalgamation.
  19765. */
  19766. static struct {
  19767. /*
  19768. ** Mutex to control access to the memory allocation subsystem.
  19769. */
  19770. sqlite3_mutex *mutex;
  19771. /*
  19772. ** Head and tail of a linked list of all outstanding allocations
  19773. */
  19774. struct MemBlockHdr *pFirst;
  19775. struct MemBlockHdr *pLast;
  19776. /*
  19777. ** The number of levels of backtrace to save in new allocations.
  19778. */
  19779. int nBacktrace;
  19780. void (*xBacktrace)(int, int, void **);
  19781. /*
  19782. ** Title text to insert in front of each block
  19783. */
  19784. int nTitle; /* Bytes of zTitle to save. Includes '\0' and padding */
  19785. char zTitle[100]; /* The title text */
  19786. /*
  19787. ** sqlite3MallocDisallow() increments the following counter.
  19788. ** sqlite3MallocAllow() decrements it.
  19789. */
  19790. int disallow; /* Do not allow memory allocation */
  19791. /*
  19792. ** Gather statistics on the sizes of memory allocations.
  19793. ** nAlloc[i] is the number of allocation attempts of i*8
  19794. ** bytes. i==NCSIZE is the number of allocation attempts for
  19795. ** sizes more than NCSIZE*8 bytes.
  19796. */
  19797. int nAlloc[NCSIZE]; /* Total number of allocations */
  19798. int nCurrent[NCSIZE]; /* Current number of allocations */
  19799. int mxCurrent[NCSIZE]; /* Highwater mark for nCurrent */
  19800. } mem;
  19801. /*
  19802. ** Adjust memory usage statistics
  19803. */
  19804. static void adjustStats(int iSize, int increment){
  19805. int i = ROUND8(iSize)/8;
  19806. if( i>NCSIZE-1 ){
  19807. i = NCSIZE - 1;
  19808. }
  19809. if( increment>0 ){
  19810. mem.nAlloc[i]++;
  19811. mem.nCurrent[i]++;
  19812. if( mem.nCurrent[i]>mem.mxCurrent[i] ){
  19813. mem.mxCurrent[i] = mem.nCurrent[i];
  19814. }
  19815. }else{
  19816. mem.nCurrent[i]--;
  19817. assert( mem.nCurrent[i]>=0 );
  19818. }
  19819. }
  19820. /*
  19821. ** Given an allocation, find the MemBlockHdr for that allocation.
  19822. **
  19823. ** This routine checks the guards at either end of the allocation and
  19824. ** if they are incorrect it asserts.
  19825. */
  19826. static struct MemBlockHdr *sqlite3MemsysGetHeader(void *pAllocation){
  19827. struct MemBlockHdr *p;
  19828. int *pInt;
  19829. u8 *pU8;
  19830. int nReserve;
  19831. p = (struct MemBlockHdr*)pAllocation;
  19832. p--;
  19833. assert( p->iForeGuard==(int)FOREGUARD );
  19834. nReserve = ROUND8(p->iSize);
  19835. pInt = (int*)pAllocation;
  19836. pU8 = (u8*)pAllocation;
  19837. assert( pInt[nReserve/sizeof(int)]==(int)REARGUARD );
  19838. /* This checks any of the "extra" bytes allocated due
  19839. ** to rounding up to an 8 byte boundary to ensure
  19840. ** they haven't been overwritten.
  19841. */
  19842. while( nReserve-- > p->iSize ) assert( pU8[nReserve]==0x65 );
  19843. return p;
  19844. }
  19845. /*
  19846. ** Return the number of bytes currently allocated at address p.
  19847. */
  19848. static int sqlite3MemSize(void *p){
  19849. struct MemBlockHdr *pHdr;
  19850. if( !p ){
  19851. return 0;
  19852. }
  19853. pHdr = sqlite3MemsysGetHeader(p);
  19854. return (int)pHdr->iSize;
  19855. }
  19856. /*
  19857. ** Initialize the memory allocation subsystem.
  19858. */
  19859. static int sqlite3MemInit(void *NotUsed){
  19860. UNUSED_PARAMETER(NotUsed);
  19861. assert( (sizeof(struct MemBlockHdr)&7) == 0 );
  19862. if( !sqlite3GlobalConfig.bMemstat ){
  19863. /* If memory status is enabled, then the malloc.c wrapper will already
  19864. ** hold the STATIC_MEM mutex when the routines here are invoked. */
  19865. mem.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  19866. }
  19867. return SQLITE_OK;
  19868. }
  19869. /*
  19870. ** Deinitialize the memory allocation subsystem.
  19871. */
  19872. static void sqlite3MemShutdown(void *NotUsed){
  19873. UNUSED_PARAMETER(NotUsed);
  19874. mem.mutex = 0;
  19875. }
  19876. /*
  19877. ** Round up a request size to the next valid allocation size.
  19878. */
  19879. static int sqlite3MemRoundup(int n){
  19880. return ROUND8(n);
  19881. }
  19882. /*
  19883. ** Fill a buffer with pseudo-random bytes. This is used to preset
  19884. ** the content of a new memory allocation to unpredictable values and
  19885. ** to clear the content of a freed allocation to unpredictable values.
  19886. */
  19887. static void randomFill(char *pBuf, int nByte){
  19888. unsigned int x, y, r;
  19889. x = SQLITE_PTR_TO_INT(pBuf);
  19890. y = nByte | 1;
  19891. while( nByte >= 4 ){
  19892. x = (x>>1) ^ (-(int)(x&1) & 0xd0000001);
  19893. y = y*1103515245 + 12345;
  19894. r = x ^ y;
  19895. *(int*)pBuf = r;
  19896. pBuf += 4;
  19897. nByte -= 4;
  19898. }
  19899. while( nByte-- > 0 ){
  19900. x = (x>>1) ^ (-(int)(x&1) & 0xd0000001);
  19901. y = y*1103515245 + 12345;
  19902. r = x ^ y;
  19903. *(pBuf++) = r & 0xff;
  19904. }
  19905. }
  19906. /*
  19907. ** Allocate nByte bytes of memory.
  19908. */
  19909. static void *sqlite3MemMalloc(int nByte){
  19910. struct MemBlockHdr *pHdr;
  19911. void **pBt;
  19912. char *z;
  19913. int *pInt;
  19914. void *p = 0;
  19915. int totalSize;
  19916. int nReserve;
  19917. sqlite3_mutex_enter(mem.mutex);
  19918. assert( mem.disallow==0 );
  19919. nReserve = ROUND8(nByte);
  19920. totalSize = nReserve + sizeof(*pHdr) + sizeof(int) +
  19921. mem.nBacktrace*sizeof(void*) + mem.nTitle;
  19922. p = malloc(totalSize);
  19923. if( p ){
  19924. z = p;
  19925. pBt = (void**)&z[mem.nTitle];
  19926. pHdr = (struct MemBlockHdr*)&pBt[mem.nBacktrace];
  19927. pHdr->pNext = 0;
  19928. pHdr->pPrev = mem.pLast;
  19929. if( mem.pLast ){
  19930. mem.pLast->pNext = pHdr;
  19931. }else{
  19932. mem.pFirst = pHdr;
  19933. }
  19934. mem.pLast = pHdr;
  19935. pHdr->iForeGuard = FOREGUARD;
  19936. pHdr->eType = MEMTYPE_HEAP;
  19937. pHdr->nBacktraceSlots = mem.nBacktrace;
  19938. pHdr->nTitle = mem.nTitle;
  19939. if( mem.nBacktrace ){
  19940. void *aAddr[40];
  19941. pHdr->nBacktrace = backtrace(aAddr, mem.nBacktrace+1)-1;
  19942. memcpy(pBt, &aAddr[1], pHdr->nBacktrace*sizeof(void*));
  19943. assert(pBt[0]);
  19944. if( mem.xBacktrace ){
  19945. mem.xBacktrace(nByte, pHdr->nBacktrace-1, &aAddr[1]);
  19946. }
  19947. }else{
  19948. pHdr->nBacktrace = 0;
  19949. }
  19950. if( mem.nTitle ){
  19951. memcpy(z, mem.zTitle, mem.nTitle);
  19952. }
  19953. pHdr->iSize = nByte;
  19954. adjustStats(nByte, +1);
  19955. pInt = (int*)&pHdr[1];
  19956. pInt[nReserve/sizeof(int)] = REARGUARD;
  19957. randomFill((char*)pInt, nByte);
  19958. memset(((char*)pInt)+nByte, 0x65, nReserve-nByte);
  19959. p = (void*)pInt;
  19960. }
  19961. sqlite3_mutex_leave(mem.mutex);
  19962. return p;
  19963. }
  19964. /*
  19965. ** Free memory.
  19966. */
  19967. static void sqlite3MemFree(void *pPrior){
  19968. struct MemBlockHdr *pHdr;
  19969. void **pBt;
  19970. char *z;
  19971. assert( sqlite3GlobalConfig.bMemstat || sqlite3GlobalConfig.bCoreMutex==0
  19972. || mem.mutex!=0 );
  19973. pHdr = sqlite3MemsysGetHeader(pPrior);
  19974. pBt = (void**)pHdr;
  19975. pBt -= pHdr->nBacktraceSlots;
  19976. sqlite3_mutex_enter(mem.mutex);
  19977. if( pHdr->pPrev ){
  19978. assert( pHdr->pPrev->pNext==pHdr );
  19979. pHdr->pPrev->pNext = pHdr->pNext;
  19980. }else{
  19981. assert( mem.pFirst==pHdr );
  19982. mem.pFirst = pHdr->pNext;
  19983. }
  19984. if( pHdr->pNext ){
  19985. assert( pHdr->pNext->pPrev==pHdr );
  19986. pHdr->pNext->pPrev = pHdr->pPrev;
  19987. }else{
  19988. assert( mem.pLast==pHdr );
  19989. mem.pLast = pHdr->pPrev;
  19990. }
  19991. z = (char*)pBt;
  19992. z -= pHdr->nTitle;
  19993. adjustStats((int)pHdr->iSize, -1);
  19994. randomFill(z, sizeof(void*)*pHdr->nBacktraceSlots + sizeof(*pHdr) +
  19995. (int)pHdr->iSize + sizeof(int) + pHdr->nTitle);
  19996. free(z);
  19997. sqlite3_mutex_leave(mem.mutex);
  19998. }
  19999. /*
  20000. ** Change the size of an existing memory allocation.
  20001. **
  20002. ** For this debugging implementation, we *always* make a copy of the
  20003. ** allocation into a new place in memory. In this way, if the
  20004. ** higher level code is using pointer to the old allocation, it is
  20005. ** much more likely to break and we are much more liking to find
  20006. ** the error.
  20007. */
  20008. static void *sqlite3MemRealloc(void *pPrior, int nByte){
  20009. struct MemBlockHdr *pOldHdr;
  20010. void *pNew;
  20011. assert( mem.disallow==0 );
  20012. assert( (nByte & 7)==0 ); /* EV: R-46199-30249 */
  20013. pOldHdr = sqlite3MemsysGetHeader(pPrior);
  20014. pNew = sqlite3MemMalloc(nByte);
  20015. if( pNew ){
  20016. memcpy(pNew, pPrior, (int)(nByte<pOldHdr->iSize ? nByte : pOldHdr->iSize));
  20017. if( nByte>pOldHdr->iSize ){
  20018. randomFill(&((char*)pNew)[pOldHdr->iSize], nByte - (int)pOldHdr->iSize);
  20019. }
  20020. sqlite3MemFree(pPrior);
  20021. }
  20022. return pNew;
  20023. }
  20024. /*
  20025. ** Populate the low-level memory allocation function pointers in
  20026. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  20027. */
  20028. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  20029. static const sqlite3_mem_methods defaultMethods = {
  20030. sqlite3MemMalloc,
  20031. sqlite3MemFree,
  20032. sqlite3MemRealloc,
  20033. sqlite3MemSize,
  20034. sqlite3MemRoundup,
  20035. sqlite3MemInit,
  20036. sqlite3MemShutdown,
  20037. 0
  20038. };
  20039. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  20040. }
  20041. /*
  20042. ** Set the "type" of an allocation.
  20043. */
  20044. SQLITE_PRIVATE void sqlite3MemdebugSetType(void *p, u8 eType){
  20045. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  20046. struct MemBlockHdr *pHdr;
  20047. pHdr = sqlite3MemsysGetHeader(p);
  20048. assert( pHdr->iForeGuard==FOREGUARD );
  20049. pHdr->eType = eType;
  20050. }
  20051. }
  20052. /*
  20053. ** Return TRUE if the mask of type in eType matches the type of the
  20054. ** allocation p. Also return true if p==NULL.
  20055. **
  20056. ** This routine is designed for use within an assert() statement, to
  20057. ** verify the type of an allocation. For example:
  20058. **
  20059. ** assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  20060. */
  20061. SQLITE_PRIVATE int sqlite3MemdebugHasType(void *p, u8 eType){
  20062. int rc = 1;
  20063. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  20064. struct MemBlockHdr *pHdr;
  20065. pHdr = sqlite3MemsysGetHeader(p);
  20066. assert( pHdr->iForeGuard==FOREGUARD ); /* Allocation is valid */
  20067. if( (pHdr->eType&eType)==0 ){
  20068. rc = 0;
  20069. }
  20070. }
  20071. return rc;
  20072. }
  20073. /*
  20074. ** Return TRUE if the mask of type in eType matches no bits of the type of the
  20075. ** allocation p. Also return true if p==NULL.
  20076. **
  20077. ** This routine is designed for use within an assert() statement, to
  20078. ** verify the type of an allocation. For example:
  20079. **
  20080. ** assert( sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
  20081. */
  20082. SQLITE_PRIVATE int sqlite3MemdebugNoType(void *p, u8 eType){
  20083. int rc = 1;
  20084. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  20085. struct MemBlockHdr *pHdr;
  20086. pHdr = sqlite3MemsysGetHeader(p);
  20087. assert( pHdr->iForeGuard==FOREGUARD ); /* Allocation is valid */
  20088. if( (pHdr->eType&eType)!=0 ){
  20089. rc = 0;
  20090. }
  20091. }
  20092. return rc;
  20093. }
  20094. /*
  20095. ** Set the number of backtrace levels kept for each allocation.
  20096. ** A value of zero turns off backtracing. The number is always rounded
  20097. ** up to a multiple of 2.
  20098. */
  20099. SQLITE_PRIVATE void sqlite3MemdebugBacktrace(int depth){
  20100. if( depth<0 ){ depth = 0; }
  20101. if( depth>20 ){ depth = 20; }
  20102. depth = (depth+1)&0xfe;
  20103. mem.nBacktrace = depth;
  20104. }
  20105. SQLITE_PRIVATE void sqlite3MemdebugBacktraceCallback(void (*xBacktrace)(int, int, void **)){
  20106. mem.xBacktrace = xBacktrace;
  20107. }
  20108. /*
  20109. ** Set the title string for subsequent allocations.
  20110. */
  20111. SQLITE_PRIVATE void sqlite3MemdebugSettitle(const char *zTitle){
  20112. unsigned int n = sqlite3Strlen30(zTitle) + 1;
  20113. sqlite3_mutex_enter(mem.mutex);
  20114. if( n>=sizeof(mem.zTitle) ) n = sizeof(mem.zTitle)-1;
  20115. memcpy(mem.zTitle, zTitle, n);
  20116. mem.zTitle[n] = 0;
  20117. mem.nTitle = ROUND8(n);
  20118. sqlite3_mutex_leave(mem.mutex);
  20119. }
  20120. SQLITE_PRIVATE void sqlite3MemdebugSync(){
  20121. struct MemBlockHdr *pHdr;
  20122. for(pHdr=mem.pFirst; pHdr; pHdr=pHdr->pNext){
  20123. void **pBt = (void**)pHdr;
  20124. pBt -= pHdr->nBacktraceSlots;
  20125. mem.xBacktrace((int)pHdr->iSize, pHdr->nBacktrace-1, &pBt[1]);
  20126. }
  20127. }
  20128. /*
  20129. ** Open the file indicated and write a log of all unfreed memory
  20130. ** allocations into that log.
  20131. */
  20132. SQLITE_PRIVATE void sqlite3MemdebugDump(const char *zFilename){
  20133. FILE *out;
  20134. struct MemBlockHdr *pHdr;
  20135. void **pBt;
  20136. int i;
  20137. out = fopen(zFilename, "w");
  20138. if( out==0 ){
  20139. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  20140. zFilename);
  20141. return;
  20142. }
  20143. for(pHdr=mem.pFirst; pHdr; pHdr=pHdr->pNext){
  20144. char *z = (char*)pHdr;
  20145. z -= pHdr->nBacktraceSlots*sizeof(void*) + pHdr->nTitle;
  20146. fprintf(out, "**** %lld bytes at %p from %s ****\n",
  20147. pHdr->iSize, &pHdr[1], pHdr->nTitle ? z : "???");
  20148. if( pHdr->nBacktrace ){
  20149. fflush(out);
  20150. pBt = (void**)pHdr;
  20151. pBt -= pHdr->nBacktraceSlots;
  20152. backtrace_symbols_fd(pBt, pHdr->nBacktrace, fileno(out));
  20153. fprintf(out, "\n");
  20154. }
  20155. }
  20156. fprintf(out, "COUNTS:\n");
  20157. for(i=0; i<NCSIZE-1; i++){
  20158. if( mem.nAlloc[i] ){
  20159. fprintf(out, " %5d: %10d %10d %10d\n",
  20160. i*8, mem.nAlloc[i], mem.nCurrent[i], mem.mxCurrent[i]);
  20161. }
  20162. }
  20163. if( mem.nAlloc[NCSIZE-1] ){
  20164. fprintf(out, " %5d: %10d %10d %10d\n",
  20165. NCSIZE*8-8, mem.nAlloc[NCSIZE-1],
  20166. mem.nCurrent[NCSIZE-1], mem.mxCurrent[NCSIZE-1]);
  20167. }
  20168. fclose(out);
  20169. }
  20170. /*
  20171. ** Return the number of times sqlite3MemMalloc() has been called.
  20172. */
  20173. SQLITE_PRIVATE int sqlite3MemdebugMallocCount(){
  20174. int i;
  20175. int nTotal = 0;
  20176. for(i=0; i<NCSIZE; i++){
  20177. nTotal += mem.nAlloc[i];
  20178. }
  20179. return nTotal;
  20180. }
  20181. #endif /* SQLITE_MEMDEBUG */
  20182. /************** End of mem2.c ************************************************/
  20183. /************** Begin file mem3.c ********************************************/
  20184. /*
  20185. ** 2007 October 14
  20186. **
  20187. ** The author disclaims copyright to this source code. In place of
  20188. ** a legal notice, here is a blessing:
  20189. **
  20190. ** May you do good and not evil.
  20191. ** May you find forgiveness for yourself and forgive others.
  20192. ** May you share freely, never taking more than you give.
  20193. **
  20194. *************************************************************************
  20195. ** This file contains the C functions that implement a memory
  20196. ** allocation subsystem for use by SQLite.
  20197. **
  20198. ** This version of the memory allocation subsystem omits all
  20199. ** use of malloc(). The SQLite user supplies a block of memory
  20200. ** before calling sqlite3_initialize() from which allocations
  20201. ** are made and returned by the xMalloc() and xRealloc()
  20202. ** implementations. Once sqlite3_initialize() has been called,
  20203. ** the amount of memory available to SQLite is fixed and cannot
  20204. ** be changed.
  20205. **
  20206. ** This version of the memory allocation subsystem is included
  20207. ** in the build only if SQLITE_ENABLE_MEMSYS3 is defined.
  20208. */
  20209. /* #include "sqliteInt.h" */
  20210. /*
  20211. ** This version of the memory allocator is only built into the library
  20212. ** SQLITE_ENABLE_MEMSYS3 is defined. Defining this symbol does not
  20213. ** mean that the library will use a memory-pool by default, just that
  20214. ** it is available. The mempool allocator is activated by calling
  20215. ** sqlite3_config().
  20216. */
  20217. #ifdef SQLITE_ENABLE_MEMSYS3
  20218. /*
  20219. ** Maximum size (in Mem3Blocks) of a "small" chunk.
  20220. */
  20221. #define MX_SMALL 10
  20222. /*
  20223. ** Number of freelist hash slots
  20224. */
  20225. #define N_HASH 61
  20226. /*
  20227. ** A memory allocation (also called a "chunk") consists of two or
  20228. ** more blocks where each block is 8 bytes. The first 8 bytes are
  20229. ** a header that is not returned to the user.
  20230. **
  20231. ** A chunk is two or more blocks that is either checked out or
  20232. ** free. The first block has format u.hdr. u.hdr.size4x is 4 times the
  20233. ** size of the allocation in blocks if the allocation is free.
  20234. ** The u.hdr.size4x&1 bit is true if the chunk is checked out and
  20235. ** false if the chunk is on the freelist. The u.hdr.size4x&2 bit
  20236. ** is true if the previous chunk is checked out and false if the
  20237. ** previous chunk is free. The u.hdr.prevSize field is the size of
  20238. ** the previous chunk in blocks if the previous chunk is on the
  20239. ** freelist. If the previous chunk is checked out, then
  20240. ** u.hdr.prevSize can be part of the data for that chunk and should
  20241. ** not be read or written.
  20242. **
  20243. ** We often identify a chunk by its index in mem3.aPool[]. When
  20244. ** this is done, the chunk index refers to the second block of
  20245. ** the chunk. In this way, the first chunk has an index of 1.
  20246. ** A chunk index of 0 means "no such chunk" and is the equivalent
  20247. ** of a NULL pointer.
  20248. **
  20249. ** The second block of free chunks is of the form u.list. The
  20250. ** two fields form a double-linked list of chunks of related sizes.
  20251. ** Pointers to the head of the list are stored in mem3.aiSmall[]
  20252. ** for smaller chunks and mem3.aiHash[] for larger chunks.
  20253. **
  20254. ** The second block of a chunk is user data if the chunk is checked
  20255. ** out. If a chunk is checked out, the user data may extend into
  20256. ** the u.hdr.prevSize value of the following chunk.
  20257. */
  20258. typedef struct Mem3Block Mem3Block;
  20259. struct Mem3Block {
  20260. union {
  20261. struct {
  20262. u32 prevSize; /* Size of previous chunk in Mem3Block elements */
  20263. u32 size4x; /* 4x the size of current chunk in Mem3Block elements */
  20264. } hdr;
  20265. struct {
  20266. u32 next; /* Index in mem3.aPool[] of next free chunk */
  20267. u32 prev; /* Index in mem3.aPool[] of previous free chunk */
  20268. } list;
  20269. } u;
  20270. };
  20271. /*
  20272. ** All of the static variables used by this module are collected
  20273. ** into a single structure named "mem3". This is to keep the
  20274. ** static variables organized and to reduce namespace pollution
  20275. ** when this module is combined with other in the amalgamation.
  20276. */
  20277. static SQLITE_WSD struct Mem3Global {
  20278. /*
  20279. ** Memory available for allocation. nPool is the size of the array
  20280. ** (in Mem3Blocks) pointed to by aPool less 2.
  20281. */
  20282. u32 nPool;
  20283. Mem3Block *aPool;
  20284. /*
  20285. ** True if we are evaluating an out-of-memory callback.
  20286. */
  20287. int alarmBusy;
  20288. /*
  20289. ** Mutex to control access to the memory allocation subsystem.
  20290. */
  20291. sqlite3_mutex *mutex;
  20292. /*
  20293. ** The minimum amount of free space that we have seen.
  20294. */
  20295. u32 mnMaster;
  20296. /*
  20297. ** iMaster is the index of the master chunk. Most new allocations
  20298. ** occur off of this chunk. szMaster is the size (in Mem3Blocks)
  20299. ** of the current master. iMaster is 0 if there is not master chunk.
  20300. ** The master chunk is not in either the aiHash[] or aiSmall[].
  20301. */
  20302. u32 iMaster;
  20303. u32 szMaster;
  20304. /*
  20305. ** Array of lists of free blocks according to the block size
  20306. ** for smaller chunks, or a hash on the block size for larger
  20307. ** chunks.
  20308. */
  20309. u32 aiSmall[MX_SMALL-1]; /* For sizes 2 through MX_SMALL, inclusive */
  20310. u32 aiHash[N_HASH]; /* For sizes MX_SMALL+1 and larger */
  20311. } mem3 = { 97535575 };
  20312. #define mem3 GLOBAL(struct Mem3Global, mem3)
  20313. /*
  20314. ** Unlink the chunk at mem3.aPool[i] from list it is currently
  20315. ** on. *pRoot is the list that i is a member of.
  20316. */
  20317. static void memsys3UnlinkFromList(u32 i, u32 *pRoot){
  20318. u32 next = mem3.aPool[i].u.list.next;
  20319. u32 prev = mem3.aPool[i].u.list.prev;
  20320. assert( sqlite3_mutex_held(mem3.mutex) );
  20321. if( prev==0 ){
  20322. *pRoot = next;
  20323. }else{
  20324. mem3.aPool[prev].u.list.next = next;
  20325. }
  20326. if( next ){
  20327. mem3.aPool[next].u.list.prev = prev;
  20328. }
  20329. mem3.aPool[i].u.list.next = 0;
  20330. mem3.aPool[i].u.list.prev = 0;
  20331. }
  20332. /*
  20333. ** Unlink the chunk at index i from
  20334. ** whatever list is currently a member of.
  20335. */
  20336. static void memsys3Unlink(u32 i){
  20337. u32 size, hash;
  20338. assert( sqlite3_mutex_held(mem3.mutex) );
  20339. assert( (mem3.aPool[i-1].u.hdr.size4x & 1)==0 );
  20340. assert( i>=1 );
  20341. size = mem3.aPool[i-1].u.hdr.size4x/4;
  20342. assert( size==mem3.aPool[i+size-1].u.hdr.prevSize );
  20343. assert( size>=2 );
  20344. if( size <= MX_SMALL ){
  20345. memsys3UnlinkFromList(i, &mem3.aiSmall[size-2]);
  20346. }else{
  20347. hash = size % N_HASH;
  20348. memsys3UnlinkFromList(i, &mem3.aiHash[hash]);
  20349. }
  20350. }
  20351. /*
  20352. ** Link the chunk at mem3.aPool[i] so that is on the list rooted
  20353. ** at *pRoot.
  20354. */
  20355. static void memsys3LinkIntoList(u32 i, u32 *pRoot){
  20356. assert( sqlite3_mutex_held(mem3.mutex) );
  20357. mem3.aPool[i].u.list.next = *pRoot;
  20358. mem3.aPool[i].u.list.prev = 0;
  20359. if( *pRoot ){
  20360. mem3.aPool[*pRoot].u.list.prev = i;
  20361. }
  20362. *pRoot = i;
  20363. }
  20364. /*
  20365. ** Link the chunk at index i into either the appropriate
  20366. ** small chunk list, or into the large chunk hash table.
  20367. */
  20368. static void memsys3Link(u32 i){
  20369. u32 size, hash;
  20370. assert( sqlite3_mutex_held(mem3.mutex) );
  20371. assert( i>=1 );
  20372. assert( (mem3.aPool[i-1].u.hdr.size4x & 1)==0 );
  20373. size = mem3.aPool[i-1].u.hdr.size4x/4;
  20374. assert( size==mem3.aPool[i+size-1].u.hdr.prevSize );
  20375. assert( size>=2 );
  20376. if( size <= MX_SMALL ){
  20377. memsys3LinkIntoList(i, &mem3.aiSmall[size-2]);
  20378. }else{
  20379. hash = size % N_HASH;
  20380. memsys3LinkIntoList(i, &mem3.aiHash[hash]);
  20381. }
  20382. }
  20383. /*
  20384. ** If the STATIC_MEM mutex is not already held, obtain it now. The mutex
  20385. ** will already be held (obtained by code in malloc.c) if
  20386. ** sqlite3GlobalConfig.bMemStat is true.
  20387. */
  20388. static void memsys3Enter(void){
  20389. if( sqlite3GlobalConfig.bMemstat==0 && mem3.mutex==0 ){
  20390. mem3.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  20391. }
  20392. sqlite3_mutex_enter(mem3.mutex);
  20393. }
  20394. static void memsys3Leave(void){
  20395. sqlite3_mutex_leave(mem3.mutex);
  20396. }
  20397. /*
  20398. ** Called when we are unable to satisfy an allocation of nBytes.
  20399. */
  20400. static void memsys3OutOfMemory(int nByte){
  20401. if( !mem3.alarmBusy ){
  20402. mem3.alarmBusy = 1;
  20403. assert( sqlite3_mutex_held(mem3.mutex) );
  20404. sqlite3_mutex_leave(mem3.mutex);
  20405. sqlite3_release_memory(nByte);
  20406. sqlite3_mutex_enter(mem3.mutex);
  20407. mem3.alarmBusy = 0;
  20408. }
  20409. }
  20410. /*
  20411. ** Chunk i is a free chunk that has been unlinked. Adjust its
  20412. ** size parameters for check-out and return a pointer to the
  20413. ** user portion of the chunk.
  20414. */
  20415. static void *memsys3Checkout(u32 i, u32 nBlock){
  20416. u32 x;
  20417. assert( sqlite3_mutex_held(mem3.mutex) );
  20418. assert( i>=1 );
  20419. assert( mem3.aPool[i-1].u.hdr.size4x/4==nBlock );
  20420. assert( mem3.aPool[i+nBlock-1].u.hdr.prevSize==nBlock );
  20421. x = mem3.aPool[i-1].u.hdr.size4x;
  20422. mem3.aPool[i-1].u.hdr.size4x = nBlock*4 | 1 | (x&2);
  20423. mem3.aPool[i+nBlock-1].u.hdr.prevSize = nBlock;
  20424. mem3.aPool[i+nBlock-1].u.hdr.size4x |= 2;
  20425. return &mem3.aPool[i];
  20426. }
  20427. /*
  20428. ** Carve a piece off of the end of the mem3.iMaster free chunk.
  20429. ** Return a pointer to the new allocation. Or, if the master chunk
  20430. ** is not large enough, return 0.
  20431. */
  20432. static void *memsys3FromMaster(u32 nBlock){
  20433. assert( sqlite3_mutex_held(mem3.mutex) );
  20434. assert( mem3.szMaster>=nBlock );
  20435. if( nBlock>=mem3.szMaster-1 ){
  20436. /* Use the entire master */
  20437. void *p = memsys3Checkout(mem3.iMaster, mem3.szMaster);
  20438. mem3.iMaster = 0;
  20439. mem3.szMaster = 0;
  20440. mem3.mnMaster = 0;
  20441. return p;
  20442. }else{
  20443. /* Split the master block. Return the tail. */
  20444. u32 newi, x;
  20445. newi = mem3.iMaster + mem3.szMaster - nBlock;
  20446. assert( newi > mem3.iMaster+1 );
  20447. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = nBlock;
  20448. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x |= 2;
  20449. mem3.aPool[newi-1].u.hdr.size4x = nBlock*4 + 1;
  20450. mem3.szMaster -= nBlock;
  20451. mem3.aPool[newi-1].u.hdr.prevSize = mem3.szMaster;
  20452. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  20453. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  20454. if( mem3.szMaster < mem3.mnMaster ){
  20455. mem3.mnMaster = mem3.szMaster;
  20456. }
  20457. return (void*)&mem3.aPool[newi];
  20458. }
  20459. }
  20460. /*
  20461. ** *pRoot is the head of a list of free chunks of the same size
  20462. ** or same size hash. In other words, *pRoot is an entry in either
  20463. ** mem3.aiSmall[] or mem3.aiHash[].
  20464. **
  20465. ** This routine examines all entries on the given list and tries
  20466. ** to coalesce each entries with adjacent free chunks.
  20467. **
  20468. ** If it sees a chunk that is larger than mem3.iMaster, it replaces
  20469. ** the current mem3.iMaster with the new larger chunk. In order for
  20470. ** this mem3.iMaster replacement to work, the master chunk must be
  20471. ** linked into the hash tables. That is not the normal state of
  20472. ** affairs, of course. The calling routine must link the master
  20473. ** chunk before invoking this routine, then must unlink the (possibly
  20474. ** changed) master chunk once this routine has finished.
  20475. */
  20476. static void memsys3Merge(u32 *pRoot){
  20477. u32 iNext, prev, size, i, x;
  20478. assert( sqlite3_mutex_held(mem3.mutex) );
  20479. for(i=*pRoot; i>0; i=iNext){
  20480. iNext = mem3.aPool[i].u.list.next;
  20481. size = mem3.aPool[i-1].u.hdr.size4x;
  20482. assert( (size&1)==0 );
  20483. if( (size&2)==0 ){
  20484. memsys3UnlinkFromList(i, pRoot);
  20485. assert( i > mem3.aPool[i-1].u.hdr.prevSize );
  20486. prev = i - mem3.aPool[i-1].u.hdr.prevSize;
  20487. if( prev==iNext ){
  20488. iNext = mem3.aPool[prev].u.list.next;
  20489. }
  20490. memsys3Unlink(prev);
  20491. size = i + size/4 - prev;
  20492. x = mem3.aPool[prev-1].u.hdr.size4x & 2;
  20493. mem3.aPool[prev-1].u.hdr.size4x = size*4 | x;
  20494. mem3.aPool[prev+size-1].u.hdr.prevSize = size;
  20495. memsys3Link(prev);
  20496. i = prev;
  20497. }else{
  20498. size /= 4;
  20499. }
  20500. if( size>mem3.szMaster ){
  20501. mem3.iMaster = i;
  20502. mem3.szMaster = size;
  20503. }
  20504. }
  20505. }
  20506. /*
  20507. ** Return a block of memory of at least nBytes in size.
  20508. ** Return NULL if unable.
  20509. **
  20510. ** This function assumes that the necessary mutexes, if any, are
  20511. ** already held by the caller. Hence "Unsafe".
  20512. */
  20513. static void *memsys3MallocUnsafe(int nByte){
  20514. u32 i;
  20515. u32 nBlock;
  20516. u32 toFree;
  20517. assert( sqlite3_mutex_held(mem3.mutex) );
  20518. assert( sizeof(Mem3Block)==8 );
  20519. if( nByte<=12 ){
  20520. nBlock = 2;
  20521. }else{
  20522. nBlock = (nByte + 11)/8;
  20523. }
  20524. assert( nBlock>=2 );
  20525. /* STEP 1:
  20526. ** Look for an entry of the correct size in either the small
  20527. ** chunk table or in the large chunk hash table. This is
  20528. ** successful most of the time (about 9 times out of 10).
  20529. */
  20530. if( nBlock <= MX_SMALL ){
  20531. i = mem3.aiSmall[nBlock-2];
  20532. if( i>0 ){
  20533. memsys3UnlinkFromList(i, &mem3.aiSmall[nBlock-2]);
  20534. return memsys3Checkout(i, nBlock);
  20535. }
  20536. }else{
  20537. int hash = nBlock % N_HASH;
  20538. for(i=mem3.aiHash[hash]; i>0; i=mem3.aPool[i].u.list.next){
  20539. if( mem3.aPool[i-1].u.hdr.size4x/4==nBlock ){
  20540. memsys3UnlinkFromList(i, &mem3.aiHash[hash]);
  20541. return memsys3Checkout(i, nBlock);
  20542. }
  20543. }
  20544. }
  20545. /* STEP 2:
  20546. ** Try to satisfy the allocation by carving a piece off of the end
  20547. ** of the master chunk. This step usually works if step 1 fails.
  20548. */
  20549. if( mem3.szMaster>=nBlock ){
  20550. return memsys3FromMaster(nBlock);
  20551. }
  20552. /* STEP 3:
  20553. ** Loop through the entire memory pool. Coalesce adjacent free
  20554. ** chunks. Recompute the master chunk as the largest free chunk.
  20555. ** Then try again to satisfy the allocation by carving a piece off
  20556. ** of the end of the master chunk. This step happens very
  20557. ** rarely (we hope!)
  20558. */
  20559. for(toFree=nBlock*16; toFree<(mem3.nPool*16); toFree *= 2){
  20560. memsys3OutOfMemory(toFree);
  20561. if( mem3.iMaster ){
  20562. memsys3Link(mem3.iMaster);
  20563. mem3.iMaster = 0;
  20564. mem3.szMaster = 0;
  20565. }
  20566. for(i=0; i<N_HASH; i++){
  20567. memsys3Merge(&mem3.aiHash[i]);
  20568. }
  20569. for(i=0; i<MX_SMALL-1; i++){
  20570. memsys3Merge(&mem3.aiSmall[i]);
  20571. }
  20572. if( mem3.szMaster ){
  20573. memsys3Unlink(mem3.iMaster);
  20574. if( mem3.szMaster>=nBlock ){
  20575. return memsys3FromMaster(nBlock);
  20576. }
  20577. }
  20578. }
  20579. /* If none of the above worked, then we fail. */
  20580. return 0;
  20581. }
  20582. /*
  20583. ** Free an outstanding memory allocation.
  20584. **
  20585. ** This function assumes that the necessary mutexes, if any, are
  20586. ** already held by the caller. Hence "Unsafe".
  20587. */
  20588. static void memsys3FreeUnsafe(void *pOld){
  20589. Mem3Block *p = (Mem3Block*)pOld;
  20590. int i;
  20591. u32 size, x;
  20592. assert( sqlite3_mutex_held(mem3.mutex) );
  20593. assert( p>mem3.aPool && p<&mem3.aPool[mem3.nPool] );
  20594. i = p - mem3.aPool;
  20595. assert( (mem3.aPool[i-1].u.hdr.size4x&1)==1 );
  20596. size = mem3.aPool[i-1].u.hdr.size4x/4;
  20597. assert( i+size<=mem3.nPool+1 );
  20598. mem3.aPool[i-1].u.hdr.size4x &= ~1;
  20599. mem3.aPool[i+size-1].u.hdr.prevSize = size;
  20600. mem3.aPool[i+size-1].u.hdr.size4x &= ~2;
  20601. memsys3Link(i);
  20602. /* Try to expand the master using the newly freed chunk */
  20603. if( mem3.iMaster ){
  20604. while( (mem3.aPool[mem3.iMaster-1].u.hdr.size4x&2)==0 ){
  20605. size = mem3.aPool[mem3.iMaster-1].u.hdr.prevSize;
  20606. mem3.iMaster -= size;
  20607. mem3.szMaster += size;
  20608. memsys3Unlink(mem3.iMaster);
  20609. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  20610. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  20611. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = mem3.szMaster;
  20612. }
  20613. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  20614. while( (mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x&1)==0 ){
  20615. memsys3Unlink(mem3.iMaster+mem3.szMaster);
  20616. mem3.szMaster += mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x/4;
  20617. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  20618. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = mem3.szMaster;
  20619. }
  20620. }
  20621. }
  20622. /*
  20623. ** Return the size of an outstanding allocation, in bytes. The
  20624. ** size returned omits the 8-byte header overhead. This only
  20625. ** works for chunks that are currently checked out.
  20626. */
  20627. static int memsys3Size(void *p){
  20628. Mem3Block *pBlock;
  20629. assert( p!=0 );
  20630. pBlock = (Mem3Block*)p;
  20631. assert( (pBlock[-1].u.hdr.size4x&1)!=0 );
  20632. return (pBlock[-1].u.hdr.size4x&~3)*2 - 4;
  20633. }
  20634. /*
  20635. ** Round up a request size to the next valid allocation size.
  20636. */
  20637. static int memsys3Roundup(int n){
  20638. if( n<=12 ){
  20639. return 12;
  20640. }else{
  20641. return ((n+11)&~7) - 4;
  20642. }
  20643. }
  20644. /*
  20645. ** Allocate nBytes of memory.
  20646. */
  20647. static void *memsys3Malloc(int nBytes){
  20648. sqlite3_int64 *p;
  20649. assert( nBytes>0 ); /* malloc.c filters out 0 byte requests */
  20650. memsys3Enter();
  20651. p = memsys3MallocUnsafe(nBytes);
  20652. memsys3Leave();
  20653. return (void*)p;
  20654. }
  20655. /*
  20656. ** Free memory.
  20657. */
  20658. static void memsys3Free(void *pPrior){
  20659. assert( pPrior );
  20660. memsys3Enter();
  20661. memsys3FreeUnsafe(pPrior);
  20662. memsys3Leave();
  20663. }
  20664. /*
  20665. ** Change the size of an existing memory allocation
  20666. */
  20667. static void *memsys3Realloc(void *pPrior, int nBytes){
  20668. int nOld;
  20669. void *p;
  20670. if( pPrior==0 ){
  20671. return sqlite3_malloc(nBytes);
  20672. }
  20673. if( nBytes<=0 ){
  20674. sqlite3_free(pPrior);
  20675. return 0;
  20676. }
  20677. nOld = memsys3Size(pPrior);
  20678. if( nBytes<=nOld && nBytes>=nOld-128 ){
  20679. return pPrior;
  20680. }
  20681. memsys3Enter();
  20682. p = memsys3MallocUnsafe(nBytes);
  20683. if( p ){
  20684. if( nOld<nBytes ){
  20685. memcpy(p, pPrior, nOld);
  20686. }else{
  20687. memcpy(p, pPrior, nBytes);
  20688. }
  20689. memsys3FreeUnsafe(pPrior);
  20690. }
  20691. memsys3Leave();
  20692. return p;
  20693. }
  20694. /*
  20695. ** Initialize this module.
  20696. */
  20697. static int memsys3Init(void *NotUsed){
  20698. UNUSED_PARAMETER(NotUsed);
  20699. if( !sqlite3GlobalConfig.pHeap ){
  20700. return SQLITE_ERROR;
  20701. }
  20702. /* Store a pointer to the memory block in global structure mem3. */
  20703. assert( sizeof(Mem3Block)==8 );
  20704. mem3.aPool = (Mem3Block *)sqlite3GlobalConfig.pHeap;
  20705. mem3.nPool = (sqlite3GlobalConfig.nHeap / sizeof(Mem3Block)) - 2;
  20706. /* Initialize the master block. */
  20707. mem3.szMaster = mem3.nPool;
  20708. mem3.mnMaster = mem3.szMaster;
  20709. mem3.iMaster = 1;
  20710. mem3.aPool[0].u.hdr.size4x = (mem3.szMaster<<2) + 2;
  20711. mem3.aPool[mem3.nPool].u.hdr.prevSize = mem3.nPool;
  20712. mem3.aPool[mem3.nPool].u.hdr.size4x = 1;
  20713. return SQLITE_OK;
  20714. }
  20715. /*
  20716. ** Deinitialize this module.
  20717. */
  20718. static void memsys3Shutdown(void *NotUsed){
  20719. UNUSED_PARAMETER(NotUsed);
  20720. mem3.mutex = 0;
  20721. return;
  20722. }
  20723. /*
  20724. ** Open the file indicated and write a log of all unfreed memory
  20725. ** allocations into that log.
  20726. */
  20727. SQLITE_PRIVATE void sqlite3Memsys3Dump(const char *zFilename){
  20728. #ifdef SQLITE_DEBUG
  20729. FILE *out;
  20730. u32 i, j;
  20731. u32 size;
  20732. if( zFilename==0 || zFilename[0]==0 ){
  20733. out = stdout;
  20734. }else{
  20735. out = fopen(zFilename, "w");
  20736. if( out==0 ){
  20737. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  20738. zFilename);
  20739. return;
  20740. }
  20741. }
  20742. memsys3Enter();
  20743. fprintf(out, "CHUNKS:\n");
  20744. for(i=1; i<=mem3.nPool; i+=size/4){
  20745. size = mem3.aPool[i-1].u.hdr.size4x;
  20746. if( size/4<=1 ){
  20747. fprintf(out, "%p size error\n", &mem3.aPool[i]);
  20748. assert( 0 );
  20749. break;
  20750. }
  20751. if( (size&1)==0 && mem3.aPool[i+size/4-1].u.hdr.prevSize!=size/4 ){
  20752. fprintf(out, "%p tail size does not match\n", &mem3.aPool[i]);
  20753. assert( 0 );
  20754. break;
  20755. }
  20756. if( ((mem3.aPool[i+size/4-1].u.hdr.size4x&2)>>1)!=(size&1) ){
  20757. fprintf(out, "%p tail checkout bit is incorrect\n", &mem3.aPool[i]);
  20758. assert( 0 );
  20759. break;
  20760. }
  20761. if( size&1 ){
  20762. fprintf(out, "%p %6d bytes checked out\n", &mem3.aPool[i], (size/4)*8-8);
  20763. }else{
  20764. fprintf(out, "%p %6d bytes free%s\n", &mem3.aPool[i], (size/4)*8-8,
  20765. i==mem3.iMaster ? " **master**" : "");
  20766. }
  20767. }
  20768. for(i=0; i<MX_SMALL-1; i++){
  20769. if( mem3.aiSmall[i]==0 ) continue;
  20770. fprintf(out, "small(%2d):", i);
  20771. for(j = mem3.aiSmall[i]; j>0; j=mem3.aPool[j].u.list.next){
  20772. fprintf(out, " %p(%d)", &mem3.aPool[j],
  20773. (mem3.aPool[j-1].u.hdr.size4x/4)*8-8);
  20774. }
  20775. fprintf(out, "\n");
  20776. }
  20777. for(i=0; i<N_HASH; i++){
  20778. if( mem3.aiHash[i]==0 ) continue;
  20779. fprintf(out, "hash(%2d):", i);
  20780. for(j = mem3.aiHash[i]; j>0; j=mem3.aPool[j].u.list.next){
  20781. fprintf(out, " %p(%d)", &mem3.aPool[j],
  20782. (mem3.aPool[j-1].u.hdr.size4x/4)*8-8);
  20783. }
  20784. fprintf(out, "\n");
  20785. }
  20786. fprintf(out, "master=%d\n", mem3.iMaster);
  20787. fprintf(out, "nowUsed=%d\n", mem3.nPool*8 - mem3.szMaster*8);
  20788. fprintf(out, "mxUsed=%d\n", mem3.nPool*8 - mem3.mnMaster*8);
  20789. sqlite3_mutex_leave(mem3.mutex);
  20790. if( out==stdout ){
  20791. fflush(stdout);
  20792. }else{
  20793. fclose(out);
  20794. }
  20795. #else
  20796. UNUSED_PARAMETER(zFilename);
  20797. #endif
  20798. }
  20799. /*
  20800. ** This routine is the only routine in this file with external
  20801. ** linkage.
  20802. **
  20803. ** Populate the low-level memory allocation function pointers in
  20804. ** sqlite3GlobalConfig.m with pointers to the routines in this file. The
  20805. ** arguments specify the block of memory to manage.
  20806. **
  20807. ** This routine is only called by sqlite3_config(), and therefore
  20808. ** is not required to be threadsafe (it is not).
  20809. */
  20810. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys3(void){
  20811. static const sqlite3_mem_methods mempoolMethods = {
  20812. memsys3Malloc,
  20813. memsys3Free,
  20814. memsys3Realloc,
  20815. memsys3Size,
  20816. memsys3Roundup,
  20817. memsys3Init,
  20818. memsys3Shutdown,
  20819. 0
  20820. };
  20821. return &mempoolMethods;
  20822. }
  20823. #endif /* SQLITE_ENABLE_MEMSYS3 */
  20824. /************** End of mem3.c ************************************************/
  20825. /************** Begin file mem5.c ********************************************/
  20826. /*
  20827. ** 2007 October 14
  20828. **
  20829. ** The author disclaims copyright to this source code. In place of
  20830. ** a legal notice, here is a blessing:
  20831. **
  20832. ** May you do good and not evil.
  20833. ** May you find forgiveness for yourself and forgive others.
  20834. ** May you share freely, never taking more than you give.
  20835. **
  20836. *************************************************************************
  20837. ** This file contains the C functions that implement a memory
  20838. ** allocation subsystem for use by SQLite.
  20839. **
  20840. ** This version of the memory allocation subsystem omits all
  20841. ** use of malloc(). The application gives SQLite a block of memory
  20842. ** before calling sqlite3_initialize() from which allocations
  20843. ** are made and returned by the xMalloc() and xRealloc()
  20844. ** implementations. Once sqlite3_initialize() has been called,
  20845. ** the amount of memory available to SQLite is fixed and cannot
  20846. ** be changed.
  20847. **
  20848. ** This version of the memory allocation subsystem is included
  20849. ** in the build only if SQLITE_ENABLE_MEMSYS5 is defined.
  20850. **
  20851. ** This memory allocator uses the following algorithm:
  20852. **
  20853. ** 1. All memory allocation sizes are rounded up to a power of 2.
  20854. **
  20855. ** 2. If two adjacent free blocks are the halves of a larger block,
  20856. ** then the two blocks are coalesced into the single larger block.
  20857. **
  20858. ** 3. New memory is allocated from the first available free block.
  20859. **
  20860. ** This algorithm is described in: J. M. Robson. "Bounds for Some Functions
  20861. ** Concerning Dynamic Storage Allocation". Journal of the Association for
  20862. ** Computing Machinery, Volume 21, Number 8, July 1974, pages 491-499.
  20863. **
  20864. ** Let n be the size of the largest allocation divided by the minimum
  20865. ** allocation size (after rounding all sizes up to a power of 2.) Let M
  20866. ** be the maximum amount of memory ever outstanding at one time. Let
  20867. ** N be the total amount of memory available for allocation. Robson
  20868. ** proved that this memory allocator will never breakdown due to
  20869. ** fragmentation as long as the following constraint holds:
  20870. **
  20871. ** N >= M*(1 + log2(n)/2) - n + 1
  20872. **
  20873. ** The sqlite3_status() logic tracks the maximum values of n and M so
  20874. ** that an application can, at any time, verify this constraint.
  20875. */
  20876. /* #include "sqliteInt.h" */
  20877. /*
  20878. ** This version of the memory allocator is used only when
  20879. ** SQLITE_ENABLE_MEMSYS5 is defined.
  20880. */
  20881. #ifdef SQLITE_ENABLE_MEMSYS5
  20882. /*
  20883. ** A minimum allocation is an instance of the following structure.
  20884. ** Larger allocations are an array of these structures where the
  20885. ** size of the array is a power of 2.
  20886. **
  20887. ** The size of this object must be a power of two. That fact is
  20888. ** verified in memsys5Init().
  20889. */
  20890. typedef struct Mem5Link Mem5Link;
  20891. struct Mem5Link {
  20892. int next; /* Index of next free chunk */
  20893. int prev; /* Index of previous free chunk */
  20894. };
  20895. /*
  20896. ** Maximum size of any allocation is ((1<<LOGMAX)*mem5.szAtom). Since
  20897. ** mem5.szAtom is always at least 8 and 32-bit integers are used,
  20898. ** it is not actually possible to reach this limit.
  20899. */
  20900. #define LOGMAX 30
  20901. /*
  20902. ** Masks used for mem5.aCtrl[] elements.
  20903. */
  20904. #define CTRL_LOGSIZE 0x1f /* Log2 Size of this block */
  20905. #define CTRL_FREE 0x20 /* True if not checked out */
  20906. /*
  20907. ** All of the static variables used by this module are collected
  20908. ** into a single structure named "mem5". This is to keep the
  20909. ** static variables organized and to reduce namespace pollution
  20910. ** when this module is combined with other in the amalgamation.
  20911. */
  20912. static SQLITE_WSD struct Mem5Global {
  20913. /*
  20914. ** Memory available for allocation
  20915. */
  20916. int szAtom; /* Smallest possible allocation in bytes */
  20917. int nBlock; /* Number of szAtom sized blocks in zPool */
  20918. u8 *zPool; /* Memory available to be allocated */
  20919. /*
  20920. ** Mutex to control access to the memory allocation subsystem.
  20921. */
  20922. sqlite3_mutex *mutex;
  20923. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  20924. /*
  20925. ** Performance statistics
  20926. */
  20927. u64 nAlloc; /* Total number of calls to malloc */
  20928. u64 totalAlloc; /* Total of all malloc calls - includes internal frag */
  20929. u64 totalExcess; /* Total internal fragmentation */
  20930. u32 currentOut; /* Current checkout, including internal fragmentation */
  20931. u32 currentCount; /* Current number of distinct checkouts */
  20932. u32 maxOut; /* Maximum instantaneous currentOut */
  20933. u32 maxCount; /* Maximum instantaneous currentCount */
  20934. u32 maxRequest; /* Largest allocation (exclusive of internal frag) */
  20935. #endif
  20936. /*
  20937. ** Lists of free blocks. aiFreelist[0] is a list of free blocks of
  20938. ** size mem5.szAtom. aiFreelist[1] holds blocks of size szAtom*2.
  20939. ** aiFreelist[2] holds free blocks of size szAtom*4. And so forth.
  20940. */
  20941. int aiFreelist[LOGMAX+1];
  20942. /*
  20943. ** Space for tracking which blocks are checked out and the size
  20944. ** of each block. One byte per block.
  20945. */
  20946. u8 *aCtrl;
  20947. } mem5;
  20948. /*
  20949. ** Access the static variable through a macro for SQLITE_OMIT_WSD.
  20950. */
  20951. #define mem5 GLOBAL(struct Mem5Global, mem5)
  20952. /*
  20953. ** Assuming mem5.zPool is divided up into an array of Mem5Link
  20954. ** structures, return a pointer to the idx-th such link.
  20955. */
  20956. #define MEM5LINK(idx) ((Mem5Link *)(&mem5.zPool[(idx)*mem5.szAtom]))
  20957. /*
  20958. ** Unlink the chunk at mem5.aPool[i] from list it is currently
  20959. ** on. It should be found on mem5.aiFreelist[iLogsize].
  20960. */
  20961. static void memsys5Unlink(int i, int iLogsize){
  20962. int next, prev;
  20963. assert( i>=0 && i<mem5.nBlock );
  20964. assert( iLogsize>=0 && iLogsize<=LOGMAX );
  20965. assert( (mem5.aCtrl[i] & CTRL_LOGSIZE)==iLogsize );
  20966. next = MEM5LINK(i)->next;
  20967. prev = MEM5LINK(i)->prev;
  20968. if( prev<0 ){
  20969. mem5.aiFreelist[iLogsize] = next;
  20970. }else{
  20971. MEM5LINK(prev)->next = next;
  20972. }
  20973. if( next>=0 ){
  20974. MEM5LINK(next)->prev = prev;
  20975. }
  20976. }
  20977. /*
  20978. ** Link the chunk at mem5.aPool[i] so that is on the iLogsize
  20979. ** free list.
  20980. */
  20981. static void memsys5Link(int i, int iLogsize){
  20982. int x;
  20983. assert( sqlite3_mutex_held(mem5.mutex) );
  20984. assert( i>=0 && i<mem5.nBlock );
  20985. assert( iLogsize>=0 && iLogsize<=LOGMAX );
  20986. assert( (mem5.aCtrl[i] & CTRL_LOGSIZE)==iLogsize );
  20987. x = MEM5LINK(i)->next = mem5.aiFreelist[iLogsize];
  20988. MEM5LINK(i)->prev = -1;
  20989. if( x>=0 ){
  20990. assert( x<mem5.nBlock );
  20991. MEM5LINK(x)->prev = i;
  20992. }
  20993. mem5.aiFreelist[iLogsize] = i;
  20994. }
  20995. /*
  20996. ** Obtain or release the mutex needed to access global data structures.
  20997. */
  20998. static void memsys5Enter(void){
  20999. sqlite3_mutex_enter(mem5.mutex);
  21000. }
  21001. static void memsys5Leave(void){
  21002. sqlite3_mutex_leave(mem5.mutex);
  21003. }
  21004. /*
  21005. ** Return the size of an outstanding allocation, in bytes.
  21006. ** This only works for chunks that are currently checked out.
  21007. */
  21008. static int memsys5Size(void *p){
  21009. int iSize, i;
  21010. assert( p!=0 );
  21011. i = (int)(((u8 *)p-mem5.zPool)/mem5.szAtom);
  21012. assert( i>=0 && i<mem5.nBlock );
  21013. iSize = mem5.szAtom * (1 << (mem5.aCtrl[i]&CTRL_LOGSIZE));
  21014. return iSize;
  21015. }
  21016. /*
  21017. ** Return a block of memory of at least nBytes in size.
  21018. ** Return NULL if unable. Return NULL if nBytes==0.
  21019. **
  21020. ** The caller guarantees that nByte is positive.
  21021. **
  21022. ** The caller has obtained a mutex prior to invoking this
  21023. ** routine so there is never any chance that two or more
  21024. ** threads can be in this routine at the same time.
  21025. */
  21026. static void *memsys5MallocUnsafe(int nByte){
  21027. int i; /* Index of a mem5.aPool[] slot */
  21028. int iBin; /* Index into mem5.aiFreelist[] */
  21029. int iFullSz; /* Size of allocation rounded up to power of 2 */
  21030. int iLogsize; /* Log2 of iFullSz/POW2_MIN */
  21031. /* nByte must be a positive */
  21032. assert( nByte>0 );
  21033. /* No more than 1GiB per allocation */
  21034. if( nByte > 0x40000000 ) return 0;
  21035. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  21036. /* Keep track of the maximum allocation request. Even unfulfilled
  21037. ** requests are counted */
  21038. if( (u32)nByte>mem5.maxRequest ){
  21039. mem5.maxRequest = nByte;
  21040. }
  21041. #endif
  21042. /* Round nByte up to the next valid power of two */
  21043. for(iFullSz=mem5.szAtom,iLogsize=0; iFullSz<nByte; iFullSz*=2,iLogsize++){}
  21044. /* Make sure mem5.aiFreelist[iLogsize] contains at least one free
  21045. ** block. If not, then split a block of the next larger power of
  21046. ** two in order to create a new free block of size iLogsize.
  21047. */
  21048. for(iBin=iLogsize; iBin<=LOGMAX && mem5.aiFreelist[iBin]<0; iBin++){}
  21049. if( iBin>LOGMAX ){
  21050. testcase( sqlite3GlobalConfig.xLog!=0 );
  21051. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes", nByte);
  21052. return 0;
  21053. }
  21054. i = mem5.aiFreelist[iBin];
  21055. memsys5Unlink(i, iBin);
  21056. while( iBin>iLogsize ){
  21057. int newSize;
  21058. iBin--;
  21059. newSize = 1 << iBin;
  21060. mem5.aCtrl[i+newSize] = CTRL_FREE | iBin;
  21061. memsys5Link(i+newSize, iBin);
  21062. }
  21063. mem5.aCtrl[i] = iLogsize;
  21064. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  21065. /* Update allocator performance statistics. */
  21066. mem5.nAlloc++;
  21067. mem5.totalAlloc += iFullSz;
  21068. mem5.totalExcess += iFullSz - nByte;
  21069. mem5.currentCount++;
  21070. mem5.currentOut += iFullSz;
  21071. if( mem5.maxCount<mem5.currentCount ) mem5.maxCount = mem5.currentCount;
  21072. if( mem5.maxOut<mem5.currentOut ) mem5.maxOut = mem5.currentOut;
  21073. #endif
  21074. #ifdef SQLITE_DEBUG
  21075. /* Make sure the allocated memory does not assume that it is set to zero
  21076. ** or retains a value from a previous allocation */
  21077. memset(&mem5.zPool[i*mem5.szAtom], 0xAA, iFullSz);
  21078. #endif
  21079. /* Return a pointer to the allocated memory. */
  21080. return (void*)&mem5.zPool[i*mem5.szAtom];
  21081. }
  21082. /*
  21083. ** Free an outstanding memory allocation.
  21084. */
  21085. static void memsys5FreeUnsafe(void *pOld){
  21086. u32 size, iLogsize;
  21087. int iBlock;
  21088. /* Set iBlock to the index of the block pointed to by pOld in
  21089. ** the array of mem5.szAtom byte blocks pointed to by mem5.zPool.
  21090. */
  21091. iBlock = (int)(((u8 *)pOld-mem5.zPool)/mem5.szAtom);
  21092. /* Check that the pointer pOld points to a valid, non-free block. */
  21093. assert( iBlock>=0 && iBlock<mem5.nBlock );
  21094. assert( ((u8 *)pOld-mem5.zPool)%mem5.szAtom==0 );
  21095. assert( (mem5.aCtrl[iBlock] & CTRL_FREE)==0 );
  21096. iLogsize = mem5.aCtrl[iBlock] & CTRL_LOGSIZE;
  21097. size = 1<<iLogsize;
  21098. assert( iBlock+size-1<(u32)mem5.nBlock );
  21099. mem5.aCtrl[iBlock] |= CTRL_FREE;
  21100. mem5.aCtrl[iBlock+size-1] |= CTRL_FREE;
  21101. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  21102. assert( mem5.currentCount>0 );
  21103. assert( mem5.currentOut>=(size*mem5.szAtom) );
  21104. mem5.currentCount--;
  21105. mem5.currentOut -= size*mem5.szAtom;
  21106. assert( mem5.currentOut>0 || mem5.currentCount==0 );
  21107. assert( mem5.currentCount>0 || mem5.currentOut==0 );
  21108. #endif
  21109. mem5.aCtrl[iBlock] = CTRL_FREE | iLogsize;
  21110. while( ALWAYS(iLogsize<LOGMAX) ){
  21111. int iBuddy;
  21112. if( (iBlock>>iLogsize) & 1 ){
  21113. iBuddy = iBlock - size;
  21114. assert( iBuddy>=0 );
  21115. }else{
  21116. iBuddy = iBlock + size;
  21117. if( iBuddy>=mem5.nBlock ) break;
  21118. }
  21119. if( mem5.aCtrl[iBuddy]!=(CTRL_FREE | iLogsize) ) break;
  21120. memsys5Unlink(iBuddy, iLogsize);
  21121. iLogsize++;
  21122. if( iBuddy<iBlock ){
  21123. mem5.aCtrl[iBuddy] = CTRL_FREE | iLogsize;
  21124. mem5.aCtrl[iBlock] = 0;
  21125. iBlock = iBuddy;
  21126. }else{
  21127. mem5.aCtrl[iBlock] = CTRL_FREE | iLogsize;
  21128. mem5.aCtrl[iBuddy] = 0;
  21129. }
  21130. size *= 2;
  21131. }
  21132. #ifdef SQLITE_DEBUG
  21133. /* Overwrite freed memory with the 0x55 bit pattern to verify that it is
  21134. ** not used after being freed */
  21135. memset(&mem5.zPool[iBlock*mem5.szAtom], 0x55, size);
  21136. #endif
  21137. memsys5Link(iBlock, iLogsize);
  21138. }
  21139. /*
  21140. ** Allocate nBytes of memory.
  21141. */
  21142. static void *memsys5Malloc(int nBytes){
  21143. sqlite3_int64 *p = 0;
  21144. if( nBytes>0 ){
  21145. memsys5Enter();
  21146. p = memsys5MallocUnsafe(nBytes);
  21147. memsys5Leave();
  21148. }
  21149. return (void*)p;
  21150. }
  21151. /*
  21152. ** Free memory.
  21153. **
  21154. ** The outer layer memory allocator prevents this routine from
  21155. ** being called with pPrior==0.
  21156. */
  21157. static void memsys5Free(void *pPrior){
  21158. assert( pPrior!=0 );
  21159. memsys5Enter();
  21160. memsys5FreeUnsafe(pPrior);
  21161. memsys5Leave();
  21162. }
  21163. /*
  21164. ** Change the size of an existing memory allocation.
  21165. **
  21166. ** The outer layer memory allocator prevents this routine from
  21167. ** being called with pPrior==0.
  21168. **
  21169. ** nBytes is always a value obtained from a prior call to
  21170. ** memsys5Round(). Hence nBytes is always a non-negative power
  21171. ** of two. If nBytes==0 that means that an oversize allocation
  21172. ** (an allocation larger than 0x40000000) was requested and this
  21173. ** routine should return 0 without freeing pPrior.
  21174. */
  21175. static void *memsys5Realloc(void *pPrior, int nBytes){
  21176. int nOld;
  21177. void *p;
  21178. assert( pPrior!=0 );
  21179. assert( (nBytes&(nBytes-1))==0 ); /* EV: R-46199-30249 */
  21180. assert( nBytes>=0 );
  21181. if( nBytes==0 ){
  21182. return 0;
  21183. }
  21184. nOld = memsys5Size(pPrior);
  21185. if( nBytes<=nOld ){
  21186. return pPrior;
  21187. }
  21188. p = memsys5Malloc(nBytes);
  21189. if( p ){
  21190. memcpy(p, pPrior, nOld);
  21191. memsys5Free(pPrior);
  21192. }
  21193. return p;
  21194. }
  21195. /*
  21196. ** Round up a request size to the next valid allocation size. If
  21197. ** the allocation is too large to be handled by this allocation system,
  21198. ** return 0.
  21199. **
  21200. ** All allocations must be a power of two and must be expressed by a
  21201. ** 32-bit signed integer. Hence the largest allocation is 0x40000000
  21202. ** or 1073741824 bytes.
  21203. */
  21204. static int memsys5Roundup(int n){
  21205. int iFullSz;
  21206. if( n > 0x40000000 ) return 0;
  21207. for(iFullSz=mem5.szAtom; iFullSz<n; iFullSz *= 2);
  21208. return iFullSz;
  21209. }
  21210. /*
  21211. ** Return the ceiling of the logarithm base 2 of iValue.
  21212. **
  21213. ** Examples: memsys5Log(1) -> 0
  21214. ** memsys5Log(2) -> 1
  21215. ** memsys5Log(4) -> 2
  21216. ** memsys5Log(5) -> 3
  21217. ** memsys5Log(8) -> 3
  21218. ** memsys5Log(9) -> 4
  21219. */
  21220. static int memsys5Log(int iValue){
  21221. int iLog;
  21222. for(iLog=0; (iLog<(int)((sizeof(int)*8)-1)) && (1<<iLog)<iValue; iLog++);
  21223. return iLog;
  21224. }
  21225. /*
  21226. ** Initialize the memory allocator.
  21227. **
  21228. ** This routine is not threadsafe. The caller must be holding a mutex
  21229. ** to prevent multiple threads from entering at the same time.
  21230. */
  21231. static int memsys5Init(void *NotUsed){
  21232. int ii; /* Loop counter */
  21233. int nByte; /* Number of bytes of memory available to this allocator */
  21234. u8 *zByte; /* Memory usable by this allocator */
  21235. int nMinLog; /* Log base 2 of minimum allocation size in bytes */
  21236. int iOffset; /* An offset into mem5.aCtrl[] */
  21237. UNUSED_PARAMETER(NotUsed);
  21238. /* For the purposes of this routine, disable the mutex */
  21239. mem5.mutex = 0;
  21240. /* The size of a Mem5Link object must be a power of two. Verify that
  21241. ** this is case.
  21242. */
  21243. assert( (sizeof(Mem5Link)&(sizeof(Mem5Link)-1))==0 );
  21244. nByte = sqlite3GlobalConfig.nHeap;
  21245. zByte = (u8*)sqlite3GlobalConfig.pHeap;
  21246. assert( zByte!=0 ); /* sqlite3_config() does not allow otherwise */
  21247. /* boundaries on sqlite3GlobalConfig.mnReq are enforced in sqlite3_config() */
  21248. nMinLog = memsys5Log(sqlite3GlobalConfig.mnReq);
  21249. mem5.szAtom = (1<<nMinLog);
  21250. while( (int)sizeof(Mem5Link)>mem5.szAtom ){
  21251. mem5.szAtom = mem5.szAtom << 1;
  21252. }
  21253. mem5.nBlock = (nByte / (mem5.szAtom+sizeof(u8)));
  21254. mem5.zPool = zByte;
  21255. mem5.aCtrl = (u8 *)&mem5.zPool[mem5.nBlock*mem5.szAtom];
  21256. for(ii=0; ii<=LOGMAX; ii++){
  21257. mem5.aiFreelist[ii] = -1;
  21258. }
  21259. iOffset = 0;
  21260. for(ii=LOGMAX; ii>=0; ii--){
  21261. int nAlloc = (1<<ii);
  21262. if( (iOffset+nAlloc)<=mem5.nBlock ){
  21263. mem5.aCtrl[iOffset] = ii | CTRL_FREE;
  21264. memsys5Link(iOffset, ii);
  21265. iOffset += nAlloc;
  21266. }
  21267. assert((iOffset+nAlloc)>mem5.nBlock);
  21268. }
  21269. /* If a mutex is required for normal operation, allocate one */
  21270. if( sqlite3GlobalConfig.bMemstat==0 ){
  21271. mem5.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  21272. }
  21273. return SQLITE_OK;
  21274. }
  21275. /*
  21276. ** Deinitialize this module.
  21277. */
  21278. static void memsys5Shutdown(void *NotUsed){
  21279. UNUSED_PARAMETER(NotUsed);
  21280. mem5.mutex = 0;
  21281. return;
  21282. }
  21283. #ifdef SQLITE_TEST
  21284. /*
  21285. ** Open the file indicated and write a log of all unfreed memory
  21286. ** allocations into that log.
  21287. */
  21288. SQLITE_PRIVATE void sqlite3Memsys5Dump(const char *zFilename){
  21289. FILE *out;
  21290. int i, j, n;
  21291. int nMinLog;
  21292. if( zFilename==0 || zFilename[0]==0 ){
  21293. out = stdout;
  21294. }else{
  21295. out = fopen(zFilename, "w");
  21296. if( out==0 ){
  21297. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  21298. zFilename);
  21299. return;
  21300. }
  21301. }
  21302. memsys5Enter();
  21303. nMinLog = memsys5Log(mem5.szAtom);
  21304. for(i=0; i<=LOGMAX && i+nMinLog<32; i++){
  21305. for(n=0, j=mem5.aiFreelist[i]; j>=0; j = MEM5LINK(j)->next, n++){}
  21306. fprintf(out, "freelist items of size %d: %d\n", mem5.szAtom << i, n);
  21307. }
  21308. fprintf(out, "mem5.nAlloc = %llu\n", mem5.nAlloc);
  21309. fprintf(out, "mem5.totalAlloc = %llu\n", mem5.totalAlloc);
  21310. fprintf(out, "mem5.totalExcess = %llu\n", mem5.totalExcess);
  21311. fprintf(out, "mem5.currentOut = %u\n", mem5.currentOut);
  21312. fprintf(out, "mem5.currentCount = %u\n", mem5.currentCount);
  21313. fprintf(out, "mem5.maxOut = %u\n", mem5.maxOut);
  21314. fprintf(out, "mem5.maxCount = %u\n", mem5.maxCount);
  21315. fprintf(out, "mem5.maxRequest = %u\n", mem5.maxRequest);
  21316. memsys5Leave();
  21317. if( out==stdout ){
  21318. fflush(stdout);
  21319. }else{
  21320. fclose(out);
  21321. }
  21322. }
  21323. #endif
  21324. /*
  21325. ** This routine is the only routine in this file with external
  21326. ** linkage. It returns a pointer to a static sqlite3_mem_methods
  21327. ** struct populated with the memsys5 methods.
  21328. */
  21329. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys5(void){
  21330. static const sqlite3_mem_methods memsys5Methods = {
  21331. memsys5Malloc,
  21332. memsys5Free,
  21333. memsys5Realloc,
  21334. memsys5Size,
  21335. memsys5Roundup,
  21336. memsys5Init,
  21337. memsys5Shutdown,
  21338. 0
  21339. };
  21340. return &memsys5Methods;
  21341. }
  21342. #endif /* SQLITE_ENABLE_MEMSYS5 */
  21343. /************** End of mem5.c ************************************************/
  21344. /************** Begin file mutex.c *******************************************/
  21345. /*
  21346. ** 2007 August 14
  21347. **
  21348. ** The author disclaims copyright to this source code. In place of
  21349. ** a legal notice, here is a blessing:
  21350. **
  21351. ** May you do good and not evil.
  21352. ** May you find forgiveness for yourself and forgive others.
  21353. ** May you share freely, never taking more than you give.
  21354. **
  21355. *************************************************************************
  21356. ** This file contains the C functions that implement mutexes.
  21357. **
  21358. ** This file contains code that is common across all mutex implementations.
  21359. */
  21360. /* #include "sqliteInt.h" */
  21361. #if defined(SQLITE_DEBUG) && !defined(SQLITE_MUTEX_OMIT)
  21362. /*
  21363. ** For debugging purposes, record when the mutex subsystem is initialized
  21364. ** and uninitialized so that we can assert() if there is an attempt to
  21365. ** allocate a mutex while the system is uninitialized.
  21366. */
  21367. static SQLITE_WSD int mutexIsInit = 0;
  21368. #endif /* SQLITE_DEBUG && !defined(SQLITE_MUTEX_OMIT) */
  21369. #ifndef SQLITE_MUTEX_OMIT
  21370. /*
  21371. ** Initialize the mutex system.
  21372. */
  21373. SQLITE_PRIVATE int sqlite3MutexInit(void){
  21374. int rc = SQLITE_OK;
  21375. if( !sqlite3GlobalConfig.mutex.xMutexAlloc ){
  21376. /* If the xMutexAlloc method has not been set, then the user did not
  21377. ** install a mutex implementation via sqlite3_config() prior to
  21378. ** sqlite3_initialize() being called. This block copies pointers to
  21379. ** the default implementation into the sqlite3GlobalConfig structure.
  21380. */
  21381. sqlite3_mutex_methods const *pFrom;
  21382. sqlite3_mutex_methods *pTo = &sqlite3GlobalConfig.mutex;
  21383. if( sqlite3GlobalConfig.bCoreMutex ){
  21384. pFrom = sqlite3DefaultMutex();
  21385. }else{
  21386. pFrom = sqlite3NoopMutex();
  21387. }
  21388. pTo->xMutexInit = pFrom->xMutexInit;
  21389. pTo->xMutexEnd = pFrom->xMutexEnd;
  21390. pTo->xMutexFree = pFrom->xMutexFree;
  21391. pTo->xMutexEnter = pFrom->xMutexEnter;
  21392. pTo->xMutexTry = pFrom->xMutexTry;
  21393. pTo->xMutexLeave = pFrom->xMutexLeave;
  21394. pTo->xMutexHeld = pFrom->xMutexHeld;
  21395. pTo->xMutexNotheld = pFrom->xMutexNotheld;
  21396. sqlite3MemoryBarrier();
  21397. pTo->xMutexAlloc = pFrom->xMutexAlloc;
  21398. }
  21399. assert( sqlite3GlobalConfig.mutex.xMutexInit );
  21400. rc = sqlite3GlobalConfig.mutex.xMutexInit();
  21401. #ifdef SQLITE_DEBUG
  21402. GLOBAL(int, mutexIsInit) = 1;
  21403. #endif
  21404. return rc;
  21405. }
  21406. /*
  21407. ** Shutdown the mutex system. This call frees resources allocated by
  21408. ** sqlite3MutexInit().
  21409. */
  21410. SQLITE_PRIVATE int sqlite3MutexEnd(void){
  21411. int rc = SQLITE_OK;
  21412. if( sqlite3GlobalConfig.mutex.xMutexEnd ){
  21413. rc = sqlite3GlobalConfig.mutex.xMutexEnd();
  21414. }
  21415. #ifdef SQLITE_DEBUG
  21416. GLOBAL(int, mutexIsInit) = 0;
  21417. #endif
  21418. return rc;
  21419. }
  21420. /*
  21421. ** Retrieve a pointer to a static mutex or allocate a new dynamic one.
  21422. */
  21423. SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int id){
  21424. #ifndef SQLITE_OMIT_AUTOINIT
  21425. if( id<=SQLITE_MUTEX_RECURSIVE && sqlite3_initialize() ) return 0;
  21426. if( id>SQLITE_MUTEX_RECURSIVE && sqlite3MutexInit() ) return 0;
  21427. #endif
  21428. assert( sqlite3GlobalConfig.mutex.xMutexAlloc );
  21429. return sqlite3GlobalConfig.mutex.xMutexAlloc(id);
  21430. }
  21431. SQLITE_PRIVATE sqlite3_mutex *sqlite3MutexAlloc(int id){
  21432. if( !sqlite3GlobalConfig.bCoreMutex ){
  21433. return 0;
  21434. }
  21435. assert( GLOBAL(int, mutexIsInit) );
  21436. assert( sqlite3GlobalConfig.mutex.xMutexAlloc );
  21437. return sqlite3GlobalConfig.mutex.xMutexAlloc(id);
  21438. }
  21439. /*
  21440. ** Free a dynamic mutex.
  21441. */
  21442. SQLITE_API void sqlite3_mutex_free(sqlite3_mutex *p){
  21443. if( p ){
  21444. assert( sqlite3GlobalConfig.mutex.xMutexFree );
  21445. sqlite3GlobalConfig.mutex.xMutexFree(p);
  21446. }
  21447. }
  21448. /*
  21449. ** Obtain the mutex p. If some other thread already has the mutex, block
  21450. ** until it can be obtained.
  21451. */
  21452. SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex *p){
  21453. if( p ){
  21454. assert( sqlite3GlobalConfig.mutex.xMutexEnter );
  21455. sqlite3GlobalConfig.mutex.xMutexEnter(p);
  21456. }
  21457. }
  21458. /*
  21459. ** Obtain the mutex p. If successful, return SQLITE_OK. Otherwise, if another
  21460. ** thread holds the mutex and it cannot be obtained, return SQLITE_BUSY.
  21461. */
  21462. SQLITE_API int sqlite3_mutex_try(sqlite3_mutex *p){
  21463. int rc = SQLITE_OK;
  21464. if( p ){
  21465. assert( sqlite3GlobalConfig.mutex.xMutexTry );
  21466. return sqlite3GlobalConfig.mutex.xMutexTry(p);
  21467. }
  21468. return rc;
  21469. }
  21470. /*
  21471. ** The sqlite3_mutex_leave() routine exits a mutex that was previously
  21472. ** entered by the same thread. The behavior is undefined if the mutex
  21473. ** is not currently entered. If a NULL pointer is passed as an argument
  21474. ** this function is a no-op.
  21475. */
  21476. SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex *p){
  21477. if( p ){
  21478. assert( sqlite3GlobalConfig.mutex.xMutexLeave );
  21479. sqlite3GlobalConfig.mutex.xMutexLeave(p);
  21480. }
  21481. }
  21482. #ifndef NDEBUG
  21483. /*
  21484. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  21485. ** intended for use inside assert() statements.
  21486. */
  21487. SQLITE_API int sqlite3_mutex_held(sqlite3_mutex *p){
  21488. assert( p==0 || sqlite3GlobalConfig.mutex.xMutexHeld );
  21489. return p==0 || sqlite3GlobalConfig.mutex.xMutexHeld(p);
  21490. }
  21491. SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex *p){
  21492. assert( p==0 || sqlite3GlobalConfig.mutex.xMutexNotheld );
  21493. return p==0 || sqlite3GlobalConfig.mutex.xMutexNotheld(p);
  21494. }
  21495. #endif
  21496. #endif /* !defined(SQLITE_MUTEX_OMIT) */
  21497. /************** End of mutex.c ***********************************************/
  21498. /************** Begin file mutex_noop.c **************************************/
  21499. /*
  21500. ** 2008 October 07
  21501. **
  21502. ** The author disclaims copyright to this source code. In place of
  21503. ** a legal notice, here is a blessing:
  21504. **
  21505. ** May you do good and not evil.
  21506. ** May you find forgiveness for yourself and forgive others.
  21507. ** May you share freely, never taking more than you give.
  21508. **
  21509. *************************************************************************
  21510. ** This file contains the C functions that implement mutexes.
  21511. **
  21512. ** This implementation in this file does not provide any mutual
  21513. ** exclusion and is thus suitable for use only in applications
  21514. ** that use SQLite in a single thread. The routines defined
  21515. ** here are place-holders. Applications can substitute working
  21516. ** mutex routines at start-time using the
  21517. **
  21518. ** sqlite3_config(SQLITE_CONFIG_MUTEX,...)
  21519. **
  21520. ** interface.
  21521. **
  21522. ** If compiled with SQLITE_DEBUG, then additional logic is inserted
  21523. ** that does error checking on mutexes to make sure they are being
  21524. ** called correctly.
  21525. */
  21526. /* #include "sqliteInt.h" */
  21527. #ifndef SQLITE_MUTEX_OMIT
  21528. #ifndef SQLITE_DEBUG
  21529. /*
  21530. ** Stub routines for all mutex methods.
  21531. **
  21532. ** This routines provide no mutual exclusion or error checking.
  21533. */
  21534. static int noopMutexInit(void){ return SQLITE_OK; }
  21535. static int noopMutexEnd(void){ return SQLITE_OK; }
  21536. static sqlite3_mutex *noopMutexAlloc(int id){
  21537. UNUSED_PARAMETER(id);
  21538. return (sqlite3_mutex*)8;
  21539. }
  21540. static void noopMutexFree(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  21541. static void noopMutexEnter(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  21542. static int noopMutexTry(sqlite3_mutex *p){
  21543. UNUSED_PARAMETER(p);
  21544. return SQLITE_OK;
  21545. }
  21546. static void noopMutexLeave(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  21547. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void){
  21548. static const sqlite3_mutex_methods sMutex = {
  21549. noopMutexInit,
  21550. noopMutexEnd,
  21551. noopMutexAlloc,
  21552. noopMutexFree,
  21553. noopMutexEnter,
  21554. noopMutexTry,
  21555. noopMutexLeave,
  21556. 0,
  21557. 0,
  21558. };
  21559. return &sMutex;
  21560. }
  21561. #endif /* !SQLITE_DEBUG */
  21562. #ifdef SQLITE_DEBUG
  21563. /*
  21564. ** In this implementation, error checking is provided for testing
  21565. ** and debugging purposes. The mutexes still do not provide any
  21566. ** mutual exclusion.
  21567. */
  21568. /*
  21569. ** The mutex object
  21570. */
  21571. typedef struct sqlite3_debug_mutex {
  21572. int id; /* The mutex type */
  21573. int cnt; /* Number of entries without a matching leave */
  21574. } sqlite3_debug_mutex;
  21575. /*
  21576. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  21577. ** intended for use inside assert() statements.
  21578. */
  21579. static int debugMutexHeld(sqlite3_mutex *pX){
  21580. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21581. return p==0 || p->cnt>0;
  21582. }
  21583. static int debugMutexNotheld(sqlite3_mutex *pX){
  21584. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21585. return p==0 || p->cnt==0;
  21586. }
  21587. /*
  21588. ** Initialize and deinitialize the mutex subsystem.
  21589. */
  21590. static int debugMutexInit(void){ return SQLITE_OK; }
  21591. static int debugMutexEnd(void){ return SQLITE_OK; }
  21592. /*
  21593. ** The sqlite3_mutex_alloc() routine allocates a new
  21594. ** mutex and returns a pointer to it. If it returns NULL
  21595. ** that means that a mutex could not be allocated.
  21596. */
  21597. static sqlite3_mutex *debugMutexAlloc(int id){
  21598. static sqlite3_debug_mutex aStatic[SQLITE_MUTEX_STATIC_VFS3 - 1];
  21599. sqlite3_debug_mutex *pNew = 0;
  21600. switch( id ){
  21601. case SQLITE_MUTEX_FAST:
  21602. case SQLITE_MUTEX_RECURSIVE: {
  21603. pNew = sqlite3Malloc(sizeof(*pNew));
  21604. if( pNew ){
  21605. pNew->id = id;
  21606. pNew->cnt = 0;
  21607. }
  21608. break;
  21609. }
  21610. default: {
  21611. #ifdef SQLITE_ENABLE_API_ARMOR
  21612. if( id-2<0 || id-2>=ArraySize(aStatic) ){
  21613. (void)SQLITE_MISUSE_BKPT;
  21614. return 0;
  21615. }
  21616. #endif
  21617. pNew = &aStatic[id-2];
  21618. pNew->id = id;
  21619. break;
  21620. }
  21621. }
  21622. return (sqlite3_mutex*)pNew;
  21623. }
  21624. /*
  21625. ** This routine deallocates a previously allocated mutex.
  21626. */
  21627. static void debugMutexFree(sqlite3_mutex *pX){
  21628. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21629. assert( p->cnt==0 );
  21630. if( p->id==SQLITE_MUTEX_RECURSIVE || p->id==SQLITE_MUTEX_FAST ){
  21631. sqlite3_free(p);
  21632. }else{
  21633. #ifdef SQLITE_ENABLE_API_ARMOR
  21634. (void)SQLITE_MISUSE_BKPT;
  21635. #endif
  21636. }
  21637. }
  21638. /*
  21639. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  21640. ** to enter a mutex. If another thread is already within the mutex,
  21641. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  21642. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  21643. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  21644. ** be entered multiple times by the same thread. In such cases the,
  21645. ** mutex must be exited an equal number of times before another thread
  21646. ** can enter. If the same thread tries to enter any other kind of mutex
  21647. ** more than once, the behavior is undefined.
  21648. */
  21649. static void debugMutexEnter(sqlite3_mutex *pX){
  21650. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21651. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  21652. p->cnt++;
  21653. }
  21654. static int debugMutexTry(sqlite3_mutex *pX){
  21655. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21656. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  21657. p->cnt++;
  21658. return SQLITE_OK;
  21659. }
  21660. /*
  21661. ** The sqlite3_mutex_leave() routine exits a mutex that was
  21662. ** previously entered by the same thread. The behavior
  21663. ** is undefined if the mutex is not currently entered or
  21664. ** is not currently allocated. SQLite will never do either.
  21665. */
  21666. static void debugMutexLeave(sqlite3_mutex *pX){
  21667. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  21668. assert( debugMutexHeld(pX) );
  21669. p->cnt--;
  21670. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  21671. }
  21672. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void){
  21673. static const sqlite3_mutex_methods sMutex = {
  21674. debugMutexInit,
  21675. debugMutexEnd,
  21676. debugMutexAlloc,
  21677. debugMutexFree,
  21678. debugMutexEnter,
  21679. debugMutexTry,
  21680. debugMutexLeave,
  21681. debugMutexHeld,
  21682. debugMutexNotheld
  21683. };
  21684. return &sMutex;
  21685. }
  21686. #endif /* SQLITE_DEBUG */
  21687. /*
  21688. ** If compiled with SQLITE_MUTEX_NOOP, then the no-op mutex implementation
  21689. ** is used regardless of the run-time threadsafety setting.
  21690. */
  21691. #ifdef SQLITE_MUTEX_NOOP
  21692. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  21693. return sqlite3NoopMutex();
  21694. }
  21695. #endif /* defined(SQLITE_MUTEX_NOOP) */
  21696. #endif /* !defined(SQLITE_MUTEX_OMIT) */
  21697. /************** End of mutex_noop.c ******************************************/
  21698. /************** Begin file mutex_unix.c **************************************/
  21699. /*
  21700. ** 2007 August 28
  21701. **
  21702. ** The author disclaims copyright to this source code. In place of
  21703. ** a legal notice, here is a blessing:
  21704. **
  21705. ** May you do good and not evil.
  21706. ** May you find forgiveness for yourself and forgive others.
  21707. ** May you share freely, never taking more than you give.
  21708. **
  21709. *************************************************************************
  21710. ** This file contains the C functions that implement mutexes for pthreads
  21711. */
  21712. /* #include "sqliteInt.h" */
  21713. /*
  21714. ** The code in this file is only used if we are compiling threadsafe
  21715. ** under unix with pthreads.
  21716. **
  21717. ** Note that this implementation requires a version of pthreads that
  21718. ** supports recursive mutexes.
  21719. */
  21720. #ifdef SQLITE_MUTEX_PTHREADS
  21721. #include <pthread.h>
  21722. /*
  21723. ** The sqlite3_mutex.id, sqlite3_mutex.nRef, and sqlite3_mutex.owner fields
  21724. ** are necessary under two condidtions: (1) Debug builds and (2) using
  21725. ** home-grown mutexes. Encapsulate these conditions into a single #define.
  21726. */
  21727. #if defined(SQLITE_DEBUG) || defined(SQLITE_HOMEGROWN_RECURSIVE_MUTEX)
  21728. # define SQLITE_MUTEX_NREF 1
  21729. #else
  21730. # define SQLITE_MUTEX_NREF 0
  21731. #endif
  21732. /*
  21733. ** Each recursive mutex is an instance of the following structure.
  21734. */
  21735. struct sqlite3_mutex {
  21736. pthread_mutex_t mutex; /* Mutex controlling the lock */
  21737. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  21738. int id; /* Mutex type */
  21739. #endif
  21740. #if SQLITE_MUTEX_NREF
  21741. volatile int nRef; /* Number of entrances */
  21742. volatile pthread_t owner; /* Thread that is within this mutex */
  21743. int trace; /* True to trace changes */
  21744. #endif
  21745. };
  21746. #if SQLITE_MUTEX_NREF
  21747. #define SQLITE3_MUTEX_INITIALIZER {PTHREAD_MUTEX_INITIALIZER,0,0,(pthread_t)0,0}
  21748. #elif defined(SQLITE_ENABLE_API_ARMOR)
  21749. #define SQLITE3_MUTEX_INITIALIZER { PTHREAD_MUTEX_INITIALIZER, 0 }
  21750. #else
  21751. #define SQLITE3_MUTEX_INITIALIZER { PTHREAD_MUTEX_INITIALIZER }
  21752. #endif
  21753. /*
  21754. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  21755. ** intended for use only inside assert() statements. On some platforms,
  21756. ** there might be race conditions that can cause these routines to
  21757. ** deliver incorrect results. In particular, if pthread_equal() is
  21758. ** not an atomic operation, then these routines might delivery
  21759. ** incorrect results. On most platforms, pthread_equal() is a
  21760. ** comparison of two integers and is therefore atomic. But we are
  21761. ** told that HPUX is not such a platform. If so, then these routines
  21762. ** will not always work correctly on HPUX.
  21763. **
  21764. ** On those platforms where pthread_equal() is not atomic, SQLite
  21765. ** should be compiled without -DSQLITE_DEBUG and with -DNDEBUG to
  21766. ** make sure no assert() statements are evaluated and hence these
  21767. ** routines are never called.
  21768. */
  21769. #if !defined(NDEBUG) || defined(SQLITE_DEBUG)
  21770. static int pthreadMutexHeld(sqlite3_mutex *p){
  21771. return (p->nRef!=0 && pthread_equal(p->owner, pthread_self()));
  21772. }
  21773. static int pthreadMutexNotheld(sqlite3_mutex *p){
  21774. return p->nRef==0 || pthread_equal(p->owner, pthread_self())==0;
  21775. }
  21776. #endif
  21777. /*
  21778. ** Try to provide a memory barrier operation, needed for initialization
  21779. ** and also for the implementation of xShmBarrier in the VFS in cases
  21780. ** where SQLite is compiled without mutexes.
  21781. */
  21782. SQLITE_PRIVATE void sqlite3MemoryBarrier(void){
  21783. #if defined(SQLITE_MEMORY_BARRIER)
  21784. SQLITE_MEMORY_BARRIER;
  21785. #elif defined(__GNUC__) && GCC_VERSION>=4001000
  21786. __sync_synchronize();
  21787. #endif
  21788. }
  21789. /*
  21790. ** Initialize and deinitialize the mutex subsystem.
  21791. */
  21792. static int pthreadMutexInit(void){ return SQLITE_OK; }
  21793. static int pthreadMutexEnd(void){ return SQLITE_OK; }
  21794. /*
  21795. ** The sqlite3_mutex_alloc() routine allocates a new
  21796. ** mutex and returns a pointer to it. If it returns NULL
  21797. ** that means that a mutex could not be allocated. SQLite
  21798. ** will unwind its stack and return an error. The argument
  21799. ** to sqlite3_mutex_alloc() is one of these integer constants:
  21800. **
  21801. ** <ul>
  21802. ** <li> SQLITE_MUTEX_FAST
  21803. ** <li> SQLITE_MUTEX_RECURSIVE
  21804. ** <li> SQLITE_MUTEX_STATIC_MASTER
  21805. ** <li> SQLITE_MUTEX_STATIC_MEM
  21806. ** <li> SQLITE_MUTEX_STATIC_OPEN
  21807. ** <li> SQLITE_MUTEX_STATIC_PRNG
  21808. ** <li> SQLITE_MUTEX_STATIC_LRU
  21809. ** <li> SQLITE_MUTEX_STATIC_PMEM
  21810. ** <li> SQLITE_MUTEX_STATIC_APP1
  21811. ** <li> SQLITE_MUTEX_STATIC_APP2
  21812. ** <li> SQLITE_MUTEX_STATIC_APP3
  21813. ** <li> SQLITE_MUTEX_STATIC_VFS1
  21814. ** <li> SQLITE_MUTEX_STATIC_VFS2
  21815. ** <li> SQLITE_MUTEX_STATIC_VFS3
  21816. ** </ul>
  21817. **
  21818. ** The first two constants cause sqlite3_mutex_alloc() to create
  21819. ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  21820. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  21821. ** The mutex implementation does not need to make a distinction
  21822. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  21823. ** not want to. But SQLite will only request a recursive mutex in
  21824. ** cases where it really needs one. If a faster non-recursive mutex
  21825. ** implementation is available on the host platform, the mutex subsystem
  21826. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  21827. **
  21828. ** The other allowed parameters to sqlite3_mutex_alloc() each return
  21829. ** a pointer to a static preexisting mutex. Six static mutexes are
  21830. ** used by the current version of SQLite. Future versions of SQLite
  21831. ** may add additional static mutexes. Static mutexes are for internal
  21832. ** use by SQLite only. Applications that use SQLite mutexes should
  21833. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  21834. ** SQLITE_MUTEX_RECURSIVE.
  21835. **
  21836. ** Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  21837. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  21838. ** returns a different mutex on every call. But for the static
  21839. ** mutex types, the same mutex is returned on every call that has
  21840. ** the same type number.
  21841. */
  21842. static sqlite3_mutex *pthreadMutexAlloc(int iType){
  21843. static sqlite3_mutex staticMutexes[] = {
  21844. SQLITE3_MUTEX_INITIALIZER,
  21845. SQLITE3_MUTEX_INITIALIZER,
  21846. SQLITE3_MUTEX_INITIALIZER,
  21847. SQLITE3_MUTEX_INITIALIZER,
  21848. SQLITE3_MUTEX_INITIALIZER,
  21849. SQLITE3_MUTEX_INITIALIZER,
  21850. SQLITE3_MUTEX_INITIALIZER,
  21851. SQLITE3_MUTEX_INITIALIZER,
  21852. SQLITE3_MUTEX_INITIALIZER,
  21853. SQLITE3_MUTEX_INITIALIZER,
  21854. SQLITE3_MUTEX_INITIALIZER,
  21855. SQLITE3_MUTEX_INITIALIZER
  21856. };
  21857. sqlite3_mutex *p;
  21858. switch( iType ){
  21859. case SQLITE_MUTEX_RECURSIVE: {
  21860. p = sqlite3MallocZero( sizeof(*p) );
  21861. if( p ){
  21862. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  21863. /* If recursive mutexes are not available, we will have to
  21864. ** build our own. See below. */
  21865. pthread_mutex_init(&p->mutex, 0);
  21866. #else
  21867. /* Use a recursive mutex if it is available */
  21868. pthread_mutexattr_t recursiveAttr;
  21869. pthread_mutexattr_init(&recursiveAttr);
  21870. pthread_mutexattr_settype(&recursiveAttr, PTHREAD_MUTEX_RECURSIVE);
  21871. pthread_mutex_init(&p->mutex, &recursiveAttr);
  21872. pthread_mutexattr_destroy(&recursiveAttr);
  21873. #endif
  21874. }
  21875. break;
  21876. }
  21877. case SQLITE_MUTEX_FAST: {
  21878. p = sqlite3MallocZero( sizeof(*p) );
  21879. if( p ){
  21880. pthread_mutex_init(&p->mutex, 0);
  21881. }
  21882. break;
  21883. }
  21884. default: {
  21885. #ifdef SQLITE_ENABLE_API_ARMOR
  21886. if( iType-2<0 || iType-2>=ArraySize(staticMutexes) ){
  21887. (void)SQLITE_MISUSE_BKPT;
  21888. return 0;
  21889. }
  21890. #endif
  21891. p = &staticMutexes[iType-2];
  21892. break;
  21893. }
  21894. }
  21895. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  21896. if( p ) p->id = iType;
  21897. #endif
  21898. return p;
  21899. }
  21900. /*
  21901. ** This routine deallocates a previously
  21902. ** allocated mutex. SQLite is careful to deallocate every
  21903. ** mutex that it allocates.
  21904. */
  21905. static void pthreadMutexFree(sqlite3_mutex *p){
  21906. assert( p->nRef==0 );
  21907. #if SQLITE_ENABLE_API_ARMOR
  21908. if( p->id==SQLITE_MUTEX_FAST || p->id==SQLITE_MUTEX_RECURSIVE )
  21909. #endif
  21910. {
  21911. pthread_mutex_destroy(&p->mutex);
  21912. sqlite3_free(p);
  21913. }
  21914. #ifdef SQLITE_ENABLE_API_ARMOR
  21915. else{
  21916. (void)SQLITE_MISUSE_BKPT;
  21917. }
  21918. #endif
  21919. }
  21920. /*
  21921. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  21922. ** to enter a mutex. If another thread is already within the mutex,
  21923. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  21924. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  21925. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  21926. ** be entered multiple times by the same thread. In such cases the,
  21927. ** mutex must be exited an equal number of times before another thread
  21928. ** can enter. If the same thread tries to enter any other kind of mutex
  21929. ** more than once, the behavior is undefined.
  21930. */
  21931. static void pthreadMutexEnter(sqlite3_mutex *p){
  21932. assert( p->id==SQLITE_MUTEX_RECURSIVE || pthreadMutexNotheld(p) );
  21933. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  21934. /* If recursive mutexes are not available, then we have to grow
  21935. ** our own. This implementation assumes that pthread_equal()
  21936. ** is atomic - that it cannot be deceived into thinking self
  21937. ** and p->owner are equal if p->owner changes between two values
  21938. ** that are not equal to self while the comparison is taking place.
  21939. ** This implementation also assumes a coherent cache - that
  21940. ** separate processes cannot read different values from the same
  21941. ** address at the same time. If either of these two conditions
  21942. ** are not met, then the mutexes will fail and problems will result.
  21943. */
  21944. {
  21945. pthread_t self = pthread_self();
  21946. if( p->nRef>0 && pthread_equal(p->owner, self) ){
  21947. p->nRef++;
  21948. }else{
  21949. pthread_mutex_lock(&p->mutex);
  21950. assert( p->nRef==0 );
  21951. p->owner = self;
  21952. p->nRef = 1;
  21953. }
  21954. }
  21955. #else
  21956. /* Use the built-in recursive mutexes if they are available.
  21957. */
  21958. pthread_mutex_lock(&p->mutex);
  21959. #if SQLITE_MUTEX_NREF
  21960. assert( p->nRef>0 || p->owner==0 );
  21961. p->owner = pthread_self();
  21962. p->nRef++;
  21963. #endif
  21964. #endif
  21965. #ifdef SQLITE_DEBUG
  21966. if( p->trace ){
  21967. printf("enter mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  21968. }
  21969. #endif
  21970. }
  21971. static int pthreadMutexTry(sqlite3_mutex *p){
  21972. int rc;
  21973. assert( p->id==SQLITE_MUTEX_RECURSIVE || pthreadMutexNotheld(p) );
  21974. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  21975. /* If recursive mutexes are not available, then we have to grow
  21976. ** our own. This implementation assumes that pthread_equal()
  21977. ** is atomic - that it cannot be deceived into thinking self
  21978. ** and p->owner are equal if p->owner changes between two values
  21979. ** that are not equal to self while the comparison is taking place.
  21980. ** This implementation also assumes a coherent cache - that
  21981. ** separate processes cannot read different values from the same
  21982. ** address at the same time. If either of these two conditions
  21983. ** are not met, then the mutexes will fail and problems will result.
  21984. */
  21985. {
  21986. pthread_t self = pthread_self();
  21987. if( p->nRef>0 && pthread_equal(p->owner, self) ){
  21988. p->nRef++;
  21989. rc = SQLITE_OK;
  21990. }else if( pthread_mutex_trylock(&p->mutex)==0 ){
  21991. assert( p->nRef==0 );
  21992. p->owner = self;
  21993. p->nRef = 1;
  21994. rc = SQLITE_OK;
  21995. }else{
  21996. rc = SQLITE_BUSY;
  21997. }
  21998. }
  21999. #else
  22000. /* Use the built-in recursive mutexes if they are available.
  22001. */
  22002. if( pthread_mutex_trylock(&p->mutex)==0 ){
  22003. #if SQLITE_MUTEX_NREF
  22004. p->owner = pthread_self();
  22005. p->nRef++;
  22006. #endif
  22007. rc = SQLITE_OK;
  22008. }else{
  22009. rc = SQLITE_BUSY;
  22010. }
  22011. #endif
  22012. #ifdef SQLITE_DEBUG
  22013. if( rc==SQLITE_OK && p->trace ){
  22014. printf("enter mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  22015. }
  22016. #endif
  22017. return rc;
  22018. }
  22019. /*
  22020. ** The sqlite3_mutex_leave() routine exits a mutex that was
  22021. ** previously entered by the same thread. The behavior
  22022. ** is undefined if the mutex is not currently entered or
  22023. ** is not currently allocated. SQLite will never do either.
  22024. */
  22025. static void pthreadMutexLeave(sqlite3_mutex *p){
  22026. assert( pthreadMutexHeld(p) );
  22027. #if SQLITE_MUTEX_NREF
  22028. p->nRef--;
  22029. if( p->nRef==0 ) p->owner = 0;
  22030. #endif
  22031. assert( p->nRef==0 || p->id==SQLITE_MUTEX_RECURSIVE );
  22032. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  22033. if( p->nRef==0 ){
  22034. pthread_mutex_unlock(&p->mutex);
  22035. }
  22036. #else
  22037. pthread_mutex_unlock(&p->mutex);
  22038. #endif
  22039. #ifdef SQLITE_DEBUG
  22040. if( p->trace ){
  22041. printf("leave mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  22042. }
  22043. #endif
  22044. }
  22045. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  22046. static const sqlite3_mutex_methods sMutex = {
  22047. pthreadMutexInit,
  22048. pthreadMutexEnd,
  22049. pthreadMutexAlloc,
  22050. pthreadMutexFree,
  22051. pthreadMutexEnter,
  22052. pthreadMutexTry,
  22053. pthreadMutexLeave,
  22054. #ifdef SQLITE_DEBUG
  22055. pthreadMutexHeld,
  22056. pthreadMutexNotheld
  22057. #else
  22058. 0,
  22059. 0
  22060. #endif
  22061. };
  22062. return &sMutex;
  22063. }
  22064. #endif /* SQLITE_MUTEX_PTHREADS */
  22065. /************** End of mutex_unix.c ******************************************/
  22066. /************** Begin file mutex_w32.c ***************************************/
  22067. /*
  22068. ** 2007 August 14
  22069. **
  22070. ** The author disclaims copyright to this source code. In place of
  22071. ** a legal notice, here is a blessing:
  22072. **
  22073. ** May you do good and not evil.
  22074. ** May you find forgiveness for yourself and forgive others.
  22075. ** May you share freely, never taking more than you give.
  22076. **
  22077. *************************************************************************
  22078. ** This file contains the C functions that implement mutexes for Win32.
  22079. */
  22080. /* #include "sqliteInt.h" */
  22081. #if SQLITE_OS_WIN
  22082. /*
  22083. ** Include code that is common to all os_*.c files
  22084. */
  22085. /************** Include os_common.h in the middle of mutex_w32.c *************/
  22086. /************** Begin file os_common.h ***************************************/
  22087. /*
  22088. ** 2004 May 22
  22089. **
  22090. ** The author disclaims copyright to this source code. In place of
  22091. ** a legal notice, here is a blessing:
  22092. **
  22093. ** May you do good and not evil.
  22094. ** May you find forgiveness for yourself and forgive others.
  22095. ** May you share freely, never taking more than you give.
  22096. **
  22097. ******************************************************************************
  22098. **
  22099. ** This file contains macros and a little bit of code that is common to
  22100. ** all of the platform-specific files (os_*.c) and is #included into those
  22101. ** files.
  22102. **
  22103. ** This file should be #included by the os_*.c files only. It is not a
  22104. ** general purpose header file.
  22105. */
  22106. #ifndef _OS_COMMON_H_
  22107. #define _OS_COMMON_H_
  22108. /*
  22109. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  22110. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  22111. ** switch. The following code should catch this problem at compile-time.
  22112. */
  22113. #ifdef MEMORY_DEBUG
  22114. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  22115. #endif
  22116. /*
  22117. ** Macros for performance tracing. Normally turned off. Only works
  22118. ** on i486 hardware.
  22119. */
  22120. #ifdef SQLITE_PERFORMANCE_TRACE
  22121. /*
  22122. ** hwtime.h contains inline assembler code for implementing
  22123. ** high-performance timing routines.
  22124. */
  22125. /************** Include hwtime.h in the middle of os_common.h ****************/
  22126. /************** Begin file hwtime.h ******************************************/
  22127. /*
  22128. ** 2008 May 27
  22129. **
  22130. ** The author disclaims copyright to this source code. In place of
  22131. ** a legal notice, here is a blessing:
  22132. **
  22133. ** May you do good and not evil.
  22134. ** May you find forgiveness for yourself and forgive others.
  22135. ** May you share freely, never taking more than you give.
  22136. **
  22137. ******************************************************************************
  22138. **
  22139. ** This file contains inline asm code for retrieving "high-performance"
  22140. ** counters for x86 class CPUs.
  22141. */
  22142. #ifndef SQLITE_HWTIME_H
  22143. #define SQLITE_HWTIME_H
  22144. /*
  22145. ** The following routine only works on pentium-class (or newer) processors.
  22146. ** It uses the RDTSC opcode to read the cycle count value out of the
  22147. ** processor and returns that value. This can be used for high-res
  22148. ** profiling.
  22149. */
  22150. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  22151. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  22152. #if defined(__GNUC__)
  22153. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  22154. unsigned int lo, hi;
  22155. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  22156. return (sqlite_uint64)hi << 32 | lo;
  22157. }
  22158. #elif defined(_MSC_VER)
  22159. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  22160. __asm {
  22161. rdtsc
  22162. ret ; return value at EDX:EAX
  22163. }
  22164. }
  22165. #endif
  22166. #elif (defined(__GNUC__) && defined(__x86_64__))
  22167. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  22168. unsigned long val;
  22169. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  22170. return val;
  22171. }
  22172. #elif (defined(__GNUC__) && defined(__ppc__))
  22173. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  22174. unsigned long long retval;
  22175. unsigned long junk;
  22176. __asm__ __volatile__ ("\n\
  22177. 1: mftbu %1\n\
  22178. mftb %L0\n\
  22179. mftbu %0\n\
  22180. cmpw %0,%1\n\
  22181. bne 1b"
  22182. : "=r" (retval), "=r" (junk));
  22183. return retval;
  22184. }
  22185. #else
  22186. #error Need implementation of sqlite3Hwtime() for your platform.
  22187. /*
  22188. ** To compile without implementing sqlite3Hwtime() for your platform,
  22189. ** you can remove the above #error and use the following
  22190. ** stub function. You will lose timing support for many
  22191. ** of the debugging and testing utilities, but it should at
  22192. ** least compile and run.
  22193. */
  22194. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  22195. #endif
  22196. #endif /* !defined(SQLITE_HWTIME_H) */
  22197. /************** End of hwtime.h **********************************************/
  22198. /************** Continuing where we left off in os_common.h ******************/
  22199. static sqlite_uint64 g_start;
  22200. static sqlite_uint64 g_elapsed;
  22201. #define TIMER_START g_start=sqlite3Hwtime()
  22202. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  22203. #define TIMER_ELAPSED g_elapsed
  22204. #else
  22205. #define TIMER_START
  22206. #define TIMER_END
  22207. #define TIMER_ELAPSED ((sqlite_uint64)0)
  22208. #endif
  22209. /*
  22210. ** If we compile with the SQLITE_TEST macro set, then the following block
  22211. ** of code will give us the ability to simulate a disk I/O error. This
  22212. ** is used for testing the I/O recovery logic.
  22213. */
  22214. #if defined(SQLITE_TEST)
  22215. SQLITE_API extern int sqlite3_io_error_hit;
  22216. SQLITE_API extern int sqlite3_io_error_hardhit;
  22217. SQLITE_API extern int sqlite3_io_error_pending;
  22218. SQLITE_API extern int sqlite3_io_error_persist;
  22219. SQLITE_API extern int sqlite3_io_error_benign;
  22220. SQLITE_API extern int sqlite3_diskfull_pending;
  22221. SQLITE_API extern int sqlite3_diskfull;
  22222. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  22223. #define SimulateIOError(CODE) \
  22224. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  22225. || sqlite3_io_error_pending-- == 1 ) \
  22226. { local_ioerr(); CODE; }
  22227. static void local_ioerr(){
  22228. IOTRACE(("IOERR\n"));
  22229. sqlite3_io_error_hit++;
  22230. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  22231. }
  22232. #define SimulateDiskfullError(CODE) \
  22233. if( sqlite3_diskfull_pending ){ \
  22234. if( sqlite3_diskfull_pending == 1 ){ \
  22235. local_ioerr(); \
  22236. sqlite3_diskfull = 1; \
  22237. sqlite3_io_error_hit = 1; \
  22238. CODE; \
  22239. }else{ \
  22240. sqlite3_diskfull_pending--; \
  22241. } \
  22242. }
  22243. #else
  22244. #define SimulateIOErrorBenign(X)
  22245. #define SimulateIOError(A)
  22246. #define SimulateDiskfullError(A)
  22247. #endif /* defined(SQLITE_TEST) */
  22248. /*
  22249. ** When testing, keep a count of the number of open files.
  22250. */
  22251. #if defined(SQLITE_TEST)
  22252. SQLITE_API extern int sqlite3_open_file_count;
  22253. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  22254. #else
  22255. #define OpenCounter(X)
  22256. #endif /* defined(SQLITE_TEST) */
  22257. #endif /* !defined(_OS_COMMON_H_) */
  22258. /************** End of os_common.h *******************************************/
  22259. /************** Continuing where we left off in mutex_w32.c ******************/
  22260. /*
  22261. ** Include the header file for the Windows VFS.
  22262. */
  22263. /************** Include os_win.h in the middle of mutex_w32.c ****************/
  22264. /************** Begin file os_win.h ******************************************/
  22265. /*
  22266. ** 2013 November 25
  22267. **
  22268. ** The author disclaims copyright to this source code. In place of
  22269. ** a legal notice, here is a blessing:
  22270. **
  22271. ** May you do good and not evil.
  22272. ** May you find forgiveness for yourself and forgive others.
  22273. ** May you share freely, never taking more than you give.
  22274. **
  22275. ******************************************************************************
  22276. **
  22277. ** This file contains code that is specific to Windows.
  22278. */
  22279. #ifndef SQLITE_OS_WIN_H
  22280. #define SQLITE_OS_WIN_H
  22281. /*
  22282. ** Include the primary Windows SDK header file.
  22283. */
  22284. #include "windows.h"
  22285. #ifdef __CYGWIN__
  22286. # include <sys/cygwin.h>
  22287. # include <errno.h> /* amalgamator: dontcache */
  22288. #endif
  22289. /*
  22290. ** Determine if we are dealing with Windows NT.
  22291. **
  22292. ** We ought to be able to determine if we are compiling for Windows 9x or
  22293. ** Windows NT using the _WIN32_WINNT macro as follows:
  22294. **
  22295. ** #if defined(_WIN32_WINNT)
  22296. ** # define SQLITE_OS_WINNT 1
  22297. ** #else
  22298. ** # define SQLITE_OS_WINNT 0
  22299. ** #endif
  22300. **
  22301. ** However, Visual Studio 2005 does not set _WIN32_WINNT by default, as
  22302. ** it ought to, so the above test does not work. We'll just assume that
  22303. ** everything is Windows NT unless the programmer explicitly says otherwise
  22304. ** by setting SQLITE_OS_WINNT to 0.
  22305. */
  22306. #if SQLITE_OS_WIN && !defined(SQLITE_OS_WINNT)
  22307. # define SQLITE_OS_WINNT 1
  22308. #endif
  22309. /*
  22310. ** Determine if we are dealing with Windows CE - which has a much reduced
  22311. ** API.
  22312. */
  22313. #if defined(_WIN32_WCE)
  22314. # define SQLITE_OS_WINCE 1
  22315. #else
  22316. # define SQLITE_OS_WINCE 0
  22317. #endif
  22318. /*
  22319. ** Determine if we are dealing with WinRT, which provides only a subset of
  22320. ** the full Win32 API.
  22321. */
  22322. #if !defined(SQLITE_OS_WINRT)
  22323. # define SQLITE_OS_WINRT 0
  22324. #endif
  22325. /*
  22326. ** For WinCE, some API function parameters do not appear to be declared as
  22327. ** volatile.
  22328. */
  22329. #if SQLITE_OS_WINCE
  22330. # define SQLITE_WIN32_VOLATILE
  22331. #else
  22332. # define SQLITE_WIN32_VOLATILE volatile
  22333. #endif
  22334. /*
  22335. ** For some Windows sub-platforms, the _beginthreadex() / _endthreadex()
  22336. ** functions are not available (e.g. those not using MSVC, Cygwin, etc).
  22337. */
  22338. #if SQLITE_OS_WIN && !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && \
  22339. SQLITE_THREADSAFE>0 && !defined(__CYGWIN__)
  22340. # define SQLITE_OS_WIN_THREADS 1
  22341. #else
  22342. # define SQLITE_OS_WIN_THREADS 0
  22343. #endif
  22344. #endif /* SQLITE_OS_WIN_H */
  22345. /************** End of os_win.h **********************************************/
  22346. /************** Continuing where we left off in mutex_w32.c ******************/
  22347. #endif
  22348. /*
  22349. ** The code in this file is only used if we are compiling multithreaded
  22350. ** on a Win32 system.
  22351. */
  22352. #ifdef SQLITE_MUTEX_W32
  22353. /*
  22354. ** Each recursive mutex is an instance of the following structure.
  22355. */
  22356. struct sqlite3_mutex {
  22357. CRITICAL_SECTION mutex; /* Mutex controlling the lock */
  22358. int id; /* Mutex type */
  22359. #ifdef SQLITE_DEBUG
  22360. volatile int nRef; /* Number of enterances */
  22361. volatile DWORD owner; /* Thread holding this mutex */
  22362. volatile int trace; /* True to trace changes */
  22363. #endif
  22364. };
  22365. /*
  22366. ** These are the initializer values used when declaring a "static" mutex
  22367. ** on Win32. It should be noted that all mutexes require initialization
  22368. ** on the Win32 platform.
  22369. */
  22370. #define SQLITE_W32_MUTEX_INITIALIZER { 0 }
  22371. #ifdef SQLITE_DEBUG
  22372. #define SQLITE3_MUTEX_INITIALIZER { SQLITE_W32_MUTEX_INITIALIZER, 0, \
  22373. 0L, (DWORD)0, 0 }
  22374. #else
  22375. #define SQLITE3_MUTEX_INITIALIZER { SQLITE_W32_MUTEX_INITIALIZER, 0 }
  22376. #endif
  22377. #ifdef SQLITE_DEBUG
  22378. /*
  22379. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  22380. ** intended for use only inside assert() statements.
  22381. */
  22382. static int winMutexHeld(sqlite3_mutex *p){
  22383. return p->nRef!=0 && p->owner==GetCurrentThreadId();
  22384. }
  22385. static int winMutexNotheld2(sqlite3_mutex *p, DWORD tid){
  22386. return p->nRef==0 || p->owner!=tid;
  22387. }
  22388. static int winMutexNotheld(sqlite3_mutex *p){
  22389. DWORD tid = GetCurrentThreadId();
  22390. return winMutexNotheld2(p, tid);
  22391. }
  22392. #endif
  22393. /*
  22394. ** Try to provide a memory barrier operation, needed for initialization
  22395. ** and also for the xShmBarrier method of the VFS in cases when SQLite is
  22396. ** compiled without mutexes (SQLITE_THREADSAFE=0).
  22397. */
  22398. SQLITE_PRIVATE void sqlite3MemoryBarrier(void){
  22399. #if defined(SQLITE_MEMORY_BARRIER)
  22400. SQLITE_MEMORY_BARRIER;
  22401. #elif defined(__GNUC__)
  22402. __sync_synchronize();
  22403. #elif !defined(SQLITE_DISABLE_INTRINSIC) && \
  22404. defined(_MSC_VER) && _MSC_VER>=1300
  22405. _ReadWriteBarrier();
  22406. #elif defined(MemoryBarrier)
  22407. MemoryBarrier();
  22408. #endif
  22409. }
  22410. /*
  22411. ** Initialize and deinitialize the mutex subsystem.
  22412. */
  22413. static sqlite3_mutex winMutex_staticMutexes[] = {
  22414. SQLITE3_MUTEX_INITIALIZER,
  22415. SQLITE3_MUTEX_INITIALIZER,
  22416. SQLITE3_MUTEX_INITIALIZER,
  22417. SQLITE3_MUTEX_INITIALIZER,
  22418. SQLITE3_MUTEX_INITIALIZER,
  22419. SQLITE3_MUTEX_INITIALIZER,
  22420. SQLITE3_MUTEX_INITIALIZER,
  22421. SQLITE3_MUTEX_INITIALIZER,
  22422. SQLITE3_MUTEX_INITIALIZER,
  22423. SQLITE3_MUTEX_INITIALIZER,
  22424. SQLITE3_MUTEX_INITIALIZER,
  22425. SQLITE3_MUTEX_INITIALIZER
  22426. };
  22427. static int winMutex_isInit = 0;
  22428. static int winMutex_isNt = -1; /* <0 means "need to query" */
  22429. /* As the winMutexInit() and winMutexEnd() functions are called as part
  22430. ** of the sqlite3_initialize() and sqlite3_shutdown() processing, the
  22431. ** "interlocked" magic used here is probably not strictly necessary.
  22432. */
  22433. static LONG SQLITE_WIN32_VOLATILE winMutex_lock = 0;
  22434. SQLITE_API int sqlite3_win32_is_nt(void); /* os_win.c */
  22435. SQLITE_API void sqlite3_win32_sleep(DWORD milliseconds); /* os_win.c */
  22436. static int winMutexInit(void){
  22437. /* The first to increment to 1 does actual initialization */
  22438. if( InterlockedCompareExchange(&winMutex_lock, 1, 0)==0 ){
  22439. int i;
  22440. for(i=0; i<ArraySize(winMutex_staticMutexes); i++){
  22441. #if SQLITE_OS_WINRT
  22442. InitializeCriticalSectionEx(&winMutex_staticMutexes[i].mutex, 0, 0);
  22443. #else
  22444. InitializeCriticalSection(&winMutex_staticMutexes[i].mutex);
  22445. #endif
  22446. }
  22447. winMutex_isInit = 1;
  22448. }else{
  22449. /* Another thread is (in the process of) initializing the static
  22450. ** mutexes */
  22451. while( !winMutex_isInit ){
  22452. sqlite3_win32_sleep(1);
  22453. }
  22454. }
  22455. return SQLITE_OK;
  22456. }
  22457. static int winMutexEnd(void){
  22458. /* The first to decrement to 0 does actual shutdown
  22459. ** (which should be the last to shutdown.) */
  22460. if( InterlockedCompareExchange(&winMutex_lock, 0, 1)==1 ){
  22461. if( winMutex_isInit==1 ){
  22462. int i;
  22463. for(i=0; i<ArraySize(winMutex_staticMutexes); i++){
  22464. DeleteCriticalSection(&winMutex_staticMutexes[i].mutex);
  22465. }
  22466. winMutex_isInit = 0;
  22467. }
  22468. }
  22469. return SQLITE_OK;
  22470. }
  22471. /*
  22472. ** The sqlite3_mutex_alloc() routine allocates a new
  22473. ** mutex and returns a pointer to it. If it returns NULL
  22474. ** that means that a mutex could not be allocated. SQLite
  22475. ** will unwind its stack and return an error. The argument
  22476. ** to sqlite3_mutex_alloc() is one of these integer constants:
  22477. **
  22478. ** <ul>
  22479. ** <li> SQLITE_MUTEX_FAST
  22480. ** <li> SQLITE_MUTEX_RECURSIVE
  22481. ** <li> SQLITE_MUTEX_STATIC_MASTER
  22482. ** <li> SQLITE_MUTEX_STATIC_MEM
  22483. ** <li> SQLITE_MUTEX_STATIC_OPEN
  22484. ** <li> SQLITE_MUTEX_STATIC_PRNG
  22485. ** <li> SQLITE_MUTEX_STATIC_LRU
  22486. ** <li> SQLITE_MUTEX_STATIC_PMEM
  22487. ** <li> SQLITE_MUTEX_STATIC_APP1
  22488. ** <li> SQLITE_MUTEX_STATIC_APP2
  22489. ** <li> SQLITE_MUTEX_STATIC_APP3
  22490. ** <li> SQLITE_MUTEX_STATIC_VFS1
  22491. ** <li> SQLITE_MUTEX_STATIC_VFS2
  22492. ** <li> SQLITE_MUTEX_STATIC_VFS3
  22493. ** </ul>
  22494. **
  22495. ** The first two constants cause sqlite3_mutex_alloc() to create
  22496. ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  22497. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  22498. ** The mutex implementation does not need to make a distinction
  22499. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  22500. ** not want to. But SQLite will only request a recursive mutex in
  22501. ** cases where it really needs one. If a faster non-recursive mutex
  22502. ** implementation is available on the host platform, the mutex subsystem
  22503. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  22504. **
  22505. ** The other allowed parameters to sqlite3_mutex_alloc() each return
  22506. ** a pointer to a static preexisting mutex. Six static mutexes are
  22507. ** used by the current version of SQLite. Future versions of SQLite
  22508. ** may add additional static mutexes. Static mutexes are for internal
  22509. ** use by SQLite only. Applications that use SQLite mutexes should
  22510. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  22511. ** SQLITE_MUTEX_RECURSIVE.
  22512. **
  22513. ** Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  22514. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  22515. ** returns a different mutex on every call. But for the static
  22516. ** mutex types, the same mutex is returned on every call that has
  22517. ** the same type number.
  22518. */
  22519. static sqlite3_mutex *winMutexAlloc(int iType){
  22520. sqlite3_mutex *p;
  22521. switch( iType ){
  22522. case SQLITE_MUTEX_FAST:
  22523. case SQLITE_MUTEX_RECURSIVE: {
  22524. p = sqlite3MallocZero( sizeof(*p) );
  22525. if( p ){
  22526. p->id = iType;
  22527. #ifdef SQLITE_DEBUG
  22528. #ifdef SQLITE_WIN32_MUTEX_TRACE_DYNAMIC
  22529. p->trace = 1;
  22530. #endif
  22531. #endif
  22532. #if SQLITE_OS_WINRT
  22533. InitializeCriticalSectionEx(&p->mutex, 0, 0);
  22534. #else
  22535. InitializeCriticalSection(&p->mutex);
  22536. #endif
  22537. }
  22538. break;
  22539. }
  22540. default: {
  22541. #ifdef SQLITE_ENABLE_API_ARMOR
  22542. if( iType-2<0 || iType-2>=ArraySize(winMutex_staticMutexes) ){
  22543. (void)SQLITE_MISUSE_BKPT;
  22544. return 0;
  22545. }
  22546. #endif
  22547. p = &winMutex_staticMutexes[iType-2];
  22548. p->id = iType;
  22549. #ifdef SQLITE_DEBUG
  22550. #ifdef SQLITE_WIN32_MUTEX_TRACE_STATIC
  22551. p->trace = 1;
  22552. #endif
  22553. #endif
  22554. break;
  22555. }
  22556. }
  22557. return p;
  22558. }
  22559. /*
  22560. ** This routine deallocates a previously
  22561. ** allocated mutex. SQLite is careful to deallocate every
  22562. ** mutex that it allocates.
  22563. */
  22564. static void winMutexFree(sqlite3_mutex *p){
  22565. assert( p );
  22566. assert( p->nRef==0 && p->owner==0 );
  22567. if( p->id==SQLITE_MUTEX_FAST || p->id==SQLITE_MUTEX_RECURSIVE ){
  22568. DeleteCriticalSection(&p->mutex);
  22569. sqlite3_free(p);
  22570. }else{
  22571. #ifdef SQLITE_ENABLE_API_ARMOR
  22572. (void)SQLITE_MISUSE_BKPT;
  22573. #endif
  22574. }
  22575. }
  22576. /*
  22577. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  22578. ** to enter a mutex. If another thread is already within the mutex,
  22579. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  22580. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  22581. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  22582. ** be entered multiple times by the same thread. In such cases the,
  22583. ** mutex must be exited an equal number of times before another thread
  22584. ** can enter. If the same thread tries to enter any other kind of mutex
  22585. ** more than once, the behavior is undefined.
  22586. */
  22587. static void winMutexEnter(sqlite3_mutex *p){
  22588. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22589. DWORD tid = GetCurrentThreadId();
  22590. #endif
  22591. #ifdef SQLITE_DEBUG
  22592. assert( p );
  22593. assert( p->id==SQLITE_MUTEX_RECURSIVE || winMutexNotheld2(p, tid) );
  22594. #else
  22595. assert( p );
  22596. #endif
  22597. assert( winMutex_isInit==1 );
  22598. EnterCriticalSection(&p->mutex);
  22599. #ifdef SQLITE_DEBUG
  22600. assert( p->nRef>0 || p->owner==0 );
  22601. p->owner = tid;
  22602. p->nRef++;
  22603. if( p->trace ){
  22604. OSTRACE(("ENTER-MUTEX tid=%lu, mutex=%p (%d), nRef=%d\n",
  22605. tid, p, p->trace, p->nRef));
  22606. }
  22607. #endif
  22608. }
  22609. static int winMutexTry(sqlite3_mutex *p){
  22610. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22611. DWORD tid = GetCurrentThreadId();
  22612. #endif
  22613. int rc = SQLITE_BUSY;
  22614. assert( p );
  22615. assert( p->id==SQLITE_MUTEX_RECURSIVE || winMutexNotheld2(p, tid) );
  22616. /*
  22617. ** The sqlite3_mutex_try() routine is very rarely used, and when it
  22618. ** is used it is merely an optimization. So it is OK for it to always
  22619. ** fail.
  22620. **
  22621. ** The TryEnterCriticalSection() interface is only available on WinNT.
  22622. ** And some windows compilers complain if you try to use it without
  22623. ** first doing some #defines that prevent SQLite from building on Win98.
  22624. ** For that reason, we will omit this optimization for now. See
  22625. ** ticket #2685.
  22626. */
  22627. #if defined(_WIN32_WINNT) && _WIN32_WINNT >= 0x0400
  22628. assert( winMutex_isInit==1 );
  22629. assert( winMutex_isNt>=-1 && winMutex_isNt<=1 );
  22630. if( winMutex_isNt<0 ){
  22631. winMutex_isNt = sqlite3_win32_is_nt();
  22632. }
  22633. assert( winMutex_isNt==0 || winMutex_isNt==1 );
  22634. if( winMutex_isNt && TryEnterCriticalSection(&p->mutex) ){
  22635. #ifdef SQLITE_DEBUG
  22636. p->owner = tid;
  22637. p->nRef++;
  22638. #endif
  22639. rc = SQLITE_OK;
  22640. }
  22641. #else
  22642. UNUSED_PARAMETER(p);
  22643. #endif
  22644. #ifdef SQLITE_DEBUG
  22645. if( p->trace ){
  22646. OSTRACE(("TRY-MUTEX tid=%lu, mutex=%p (%d), owner=%lu, nRef=%d, rc=%s\n",
  22647. tid, p, p->trace, p->owner, p->nRef, sqlite3ErrName(rc)));
  22648. }
  22649. #endif
  22650. return rc;
  22651. }
  22652. /*
  22653. ** The sqlite3_mutex_leave() routine exits a mutex that was
  22654. ** previously entered by the same thread. The behavior
  22655. ** is undefined if the mutex is not currently entered or
  22656. ** is not currently allocated. SQLite will never do either.
  22657. */
  22658. static void winMutexLeave(sqlite3_mutex *p){
  22659. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22660. DWORD tid = GetCurrentThreadId();
  22661. #endif
  22662. assert( p );
  22663. #ifdef SQLITE_DEBUG
  22664. assert( p->nRef>0 );
  22665. assert( p->owner==tid );
  22666. p->nRef--;
  22667. if( p->nRef==0 ) p->owner = 0;
  22668. assert( p->nRef==0 || p->id==SQLITE_MUTEX_RECURSIVE );
  22669. #endif
  22670. assert( winMutex_isInit==1 );
  22671. LeaveCriticalSection(&p->mutex);
  22672. #ifdef SQLITE_DEBUG
  22673. if( p->trace ){
  22674. OSTRACE(("LEAVE-MUTEX tid=%lu, mutex=%p (%d), nRef=%d\n",
  22675. tid, p, p->trace, p->nRef));
  22676. }
  22677. #endif
  22678. }
  22679. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  22680. static const sqlite3_mutex_methods sMutex = {
  22681. winMutexInit,
  22682. winMutexEnd,
  22683. winMutexAlloc,
  22684. winMutexFree,
  22685. winMutexEnter,
  22686. winMutexTry,
  22687. winMutexLeave,
  22688. #ifdef SQLITE_DEBUG
  22689. winMutexHeld,
  22690. winMutexNotheld
  22691. #else
  22692. 0,
  22693. 0
  22694. #endif
  22695. };
  22696. return &sMutex;
  22697. }
  22698. #endif /* SQLITE_MUTEX_W32 */
  22699. /************** End of mutex_w32.c *******************************************/
  22700. /************** Begin file malloc.c ******************************************/
  22701. /*
  22702. ** 2001 September 15
  22703. **
  22704. ** The author disclaims copyright to this source code. In place of
  22705. ** a legal notice, here is a blessing:
  22706. **
  22707. ** May you do good and not evil.
  22708. ** May you find forgiveness for yourself and forgive others.
  22709. ** May you share freely, never taking more than you give.
  22710. **
  22711. *************************************************************************
  22712. **
  22713. ** Memory allocation functions used throughout sqlite.
  22714. */
  22715. /* #include "sqliteInt.h" */
  22716. /* #include <stdarg.h> */
  22717. /*
  22718. ** Attempt to release up to n bytes of non-essential memory currently
  22719. ** held by SQLite. An example of non-essential memory is memory used to
  22720. ** cache database pages that are not currently in use.
  22721. */
  22722. SQLITE_API int sqlite3_release_memory(int n){
  22723. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  22724. return sqlite3PcacheReleaseMemory(n);
  22725. #else
  22726. /* IMPLEMENTATION-OF: R-34391-24921 The sqlite3_release_memory() routine
  22727. ** is a no-op returning zero if SQLite is not compiled with
  22728. ** SQLITE_ENABLE_MEMORY_MANAGEMENT. */
  22729. UNUSED_PARAMETER(n);
  22730. return 0;
  22731. #endif
  22732. }
  22733. /*
  22734. ** An instance of the following object records the location of
  22735. ** each unused scratch buffer.
  22736. */
  22737. typedef struct ScratchFreeslot {
  22738. struct ScratchFreeslot *pNext; /* Next unused scratch buffer */
  22739. } ScratchFreeslot;
  22740. /*
  22741. ** State information local to the memory allocation subsystem.
  22742. */
  22743. static SQLITE_WSD struct Mem0Global {
  22744. sqlite3_mutex *mutex; /* Mutex to serialize access */
  22745. sqlite3_int64 alarmThreshold; /* The soft heap limit */
  22746. /*
  22747. ** Pointers to the end of sqlite3GlobalConfig.pScratch memory
  22748. ** (so that a range test can be used to determine if an allocation
  22749. ** being freed came from pScratch) and a pointer to the list of
  22750. ** unused scratch allocations.
  22751. */
  22752. void *pScratchEnd;
  22753. ScratchFreeslot *pScratchFree;
  22754. u32 nScratchFree;
  22755. /*
  22756. ** True if heap is nearly "full" where "full" is defined by the
  22757. ** sqlite3_soft_heap_limit() setting.
  22758. */
  22759. int nearlyFull;
  22760. } mem0 = { 0, 0, 0, 0, 0, 0 };
  22761. #define mem0 GLOBAL(struct Mem0Global, mem0)
  22762. /*
  22763. ** Return the memory allocator mutex. sqlite3_status() needs it.
  22764. */
  22765. SQLITE_PRIVATE sqlite3_mutex *sqlite3MallocMutex(void){
  22766. return mem0.mutex;
  22767. }
  22768. #ifndef SQLITE_OMIT_DEPRECATED
  22769. /*
  22770. ** Deprecated external interface. It used to set an alarm callback
  22771. ** that was invoked when memory usage grew too large. Now it is a
  22772. ** no-op.
  22773. */
  22774. SQLITE_API int sqlite3_memory_alarm(
  22775. void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
  22776. void *pArg,
  22777. sqlite3_int64 iThreshold
  22778. ){
  22779. (void)xCallback;
  22780. (void)pArg;
  22781. (void)iThreshold;
  22782. return SQLITE_OK;
  22783. }
  22784. #endif
  22785. /*
  22786. ** Set the soft heap-size limit for the library. Passing a zero or
  22787. ** negative value indicates no limit.
  22788. */
  22789. SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 n){
  22790. sqlite3_int64 priorLimit;
  22791. sqlite3_int64 excess;
  22792. sqlite3_int64 nUsed;
  22793. #ifndef SQLITE_OMIT_AUTOINIT
  22794. int rc = sqlite3_initialize();
  22795. if( rc ) return -1;
  22796. #endif
  22797. sqlite3_mutex_enter(mem0.mutex);
  22798. priorLimit = mem0.alarmThreshold;
  22799. if( n<0 ){
  22800. sqlite3_mutex_leave(mem0.mutex);
  22801. return priorLimit;
  22802. }
  22803. mem0.alarmThreshold = n;
  22804. nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
  22805. mem0.nearlyFull = (n>0 && n<=nUsed);
  22806. sqlite3_mutex_leave(mem0.mutex);
  22807. excess = sqlite3_memory_used() - n;
  22808. if( excess>0 ) sqlite3_release_memory((int)(excess & 0x7fffffff));
  22809. return priorLimit;
  22810. }
  22811. SQLITE_API void sqlite3_soft_heap_limit(int n){
  22812. if( n<0 ) n = 0;
  22813. sqlite3_soft_heap_limit64(n);
  22814. }
  22815. /*
  22816. ** Initialize the memory allocation subsystem.
  22817. */
  22818. SQLITE_PRIVATE int sqlite3MallocInit(void){
  22819. int rc;
  22820. if( sqlite3GlobalConfig.m.xMalloc==0 ){
  22821. sqlite3MemSetDefault();
  22822. }
  22823. memset(&mem0, 0, sizeof(mem0));
  22824. mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  22825. if( sqlite3GlobalConfig.pScratch && sqlite3GlobalConfig.szScratch>=100
  22826. && sqlite3GlobalConfig.nScratch>0 ){
  22827. int i, n, sz;
  22828. ScratchFreeslot *pSlot;
  22829. sz = ROUNDDOWN8(sqlite3GlobalConfig.szScratch);
  22830. sqlite3GlobalConfig.szScratch = sz;
  22831. pSlot = (ScratchFreeslot*)sqlite3GlobalConfig.pScratch;
  22832. n = sqlite3GlobalConfig.nScratch;
  22833. mem0.pScratchFree = pSlot;
  22834. mem0.nScratchFree = n;
  22835. for(i=0; i<n-1; i++){
  22836. pSlot->pNext = (ScratchFreeslot*)(sz+(char*)pSlot);
  22837. pSlot = pSlot->pNext;
  22838. }
  22839. pSlot->pNext = 0;
  22840. mem0.pScratchEnd = (void*)&pSlot[1];
  22841. }else{
  22842. mem0.pScratchEnd = 0;
  22843. sqlite3GlobalConfig.pScratch = 0;
  22844. sqlite3GlobalConfig.szScratch = 0;
  22845. sqlite3GlobalConfig.nScratch = 0;
  22846. }
  22847. if( sqlite3GlobalConfig.pPage==0 || sqlite3GlobalConfig.szPage<512
  22848. || sqlite3GlobalConfig.nPage<=0 ){
  22849. sqlite3GlobalConfig.pPage = 0;
  22850. sqlite3GlobalConfig.szPage = 0;
  22851. }
  22852. rc = sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
  22853. if( rc!=SQLITE_OK ) memset(&mem0, 0, sizeof(mem0));
  22854. return rc;
  22855. }
  22856. /*
  22857. ** Return true if the heap is currently under memory pressure - in other
  22858. ** words if the amount of heap used is close to the limit set by
  22859. ** sqlite3_soft_heap_limit().
  22860. */
  22861. SQLITE_PRIVATE int sqlite3HeapNearlyFull(void){
  22862. return mem0.nearlyFull;
  22863. }
  22864. /*
  22865. ** Deinitialize the memory allocation subsystem.
  22866. */
  22867. SQLITE_PRIVATE void sqlite3MallocEnd(void){
  22868. if( sqlite3GlobalConfig.m.xShutdown ){
  22869. sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
  22870. }
  22871. memset(&mem0, 0, sizeof(mem0));
  22872. }
  22873. /*
  22874. ** Return the amount of memory currently checked out.
  22875. */
  22876. SQLITE_API sqlite3_int64 sqlite3_memory_used(void){
  22877. sqlite3_int64 res, mx;
  22878. sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, 0);
  22879. return res;
  22880. }
  22881. /*
  22882. ** Return the maximum amount of memory that has ever been
  22883. ** checked out since either the beginning of this process
  22884. ** or since the most recent reset.
  22885. */
  22886. SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
  22887. sqlite3_int64 res, mx;
  22888. sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, resetFlag);
  22889. return mx;
  22890. }
  22891. /*
  22892. ** Trigger the alarm
  22893. */
  22894. static void sqlite3MallocAlarm(int nByte){
  22895. if( mem0.alarmThreshold<=0 ) return;
  22896. sqlite3_mutex_leave(mem0.mutex);
  22897. sqlite3_release_memory(nByte);
  22898. sqlite3_mutex_enter(mem0.mutex);
  22899. }
  22900. /*
  22901. ** Do a memory allocation with statistics and alarms. Assume the
  22902. ** lock is already held.
  22903. */
  22904. static int mallocWithAlarm(int n, void **pp){
  22905. int nFull;
  22906. void *p;
  22907. assert( sqlite3_mutex_held(mem0.mutex) );
  22908. nFull = sqlite3GlobalConfig.m.xRoundup(n);
  22909. sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, n);
  22910. if( mem0.alarmThreshold>0 ){
  22911. sqlite3_int64 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
  22912. if( nUsed >= mem0.alarmThreshold - nFull ){
  22913. mem0.nearlyFull = 1;
  22914. sqlite3MallocAlarm(nFull);
  22915. }else{
  22916. mem0.nearlyFull = 0;
  22917. }
  22918. }
  22919. p = sqlite3GlobalConfig.m.xMalloc(nFull);
  22920. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  22921. if( p==0 && mem0.alarmThreshold>0 ){
  22922. sqlite3MallocAlarm(nFull);
  22923. p = sqlite3GlobalConfig.m.xMalloc(nFull);
  22924. }
  22925. #endif
  22926. if( p ){
  22927. nFull = sqlite3MallocSize(p);
  22928. sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nFull);
  22929. sqlite3StatusUp(SQLITE_STATUS_MALLOC_COUNT, 1);
  22930. }
  22931. *pp = p;
  22932. return nFull;
  22933. }
  22934. /*
  22935. ** Allocate memory. This routine is like sqlite3_malloc() except that it
  22936. ** assumes the memory subsystem has already been initialized.
  22937. */
  22938. SQLITE_PRIVATE void *sqlite3Malloc(u64 n){
  22939. void *p;
  22940. if( n==0 || n>=0x7fffff00 ){
  22941. /* A memory allocation of a number of bytes which is near the maximum
  22942. ** signed integer value might cause an integer overflow inside of the
  22943. ** xMalloc(). Hence we limit the maximum size to 0x7fffff00, giving
  22944. ** 255 bytes of overhead. SQLite itself will never use anything near
  22945. ** this amount. The only way to reach the limit is with sqlite3_malloc() */
  22946. p = 0;
  22947. }else if( sqlite3GlobalConfig.bMemstat ){
  22948. sqlite3_mutex_enter(mem0.mutex);
  22949. mallocWithAlarm((int)n, &p);
  22950. sqlite3_mutex_leave(mem0.mutex);
  22951. }else{
  22952. p = sqlite3GlobalConfig.m.xMalloc((int)n);
  22953. }
  22954. assert( EIGHT_BYTE_ALIGNMENT(p) ); /* IMP: R-11148-40995 */
  22955. return p;
  22956. }
  22957. /*
  22958. ** This version of the memory allocation is for use by the application.
  22959. ** First make sure the memory subsystem is initialized, then do the
  22960. ** allocation.
  22961. */
  22962. SQLITE_API void *sqlite3_malloc(int n){
  22963. #ifndef SQLITE_OMIT_AUTOINIT
  22964. if( sqlite3_initialize() ) return 0;
  22965. #endif
  22966. return n<=0 ? 0 : sqlite3Malloc(n);
  22967. }
  22968. SQLITE_API void *sqlite3_malloc64(sqlite3_uint64 n){
  22969. #ifndef SQLITE_OMIT_AUTOINIT
  22970. if( sqlite3_initialize() ) return 0;
  22971. #endif
  22972. return sqlite3Malloc(n);
  22973. }
  22974. /*
  22975. ** Each thread may only have a single outstanding allocation from
  22976. ** xScratchMalloc(). We verify this constraint in the single-threaded
  22977. ** case by setting scratchAllocOut to 1 when an allocation
  22978. ** is outstanding clearing it when the allocation is freed.
  22979. */
  22980. #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
  22981. static int scratchAllocOut = 0;
  22982. #endif
  22983. /*
  22984. ** Allocate memory that is to be used and released right away.
  22985. ** This routine is similar to alloca() in that it is not intended
  22986. ** for situations where the memory might be held long-term. This
  22987. ** routine is intended to get memory to old large transient data
  22988. ** structures that would not normally fit on the stack of an
  22989. ** embedded processor.
  22990. */
  22991. SQLITE_PRIVATE void *sqlite3ScratchMalloc(int n){
  22992. void *p;
  22993. assert( n>0 );
  22994. sqlite3_mutex_enter(mem0.mutex);
  22995. sqlite3StatusHighwater(SQLITE_STATUS_SCRATCH_SIZE, n);
  22996. if( mem0.nScratchFree && sqlite3GlobalConfig.szScratch>=n ){
  22997. p = mem0.pScratchFree;
  22998. mem0.pScratchFree = mem0.pScratchFree->pNext;
  22999. mem0.nScratchFree--;
  23000. sqlite3StatusUp(SQLITE_STATUS_SCRATCH_USED, 1);
  23001. sqlite3_mutex_leave(mem0.mutex);
  23002. }else{
  23003. sqlite3_mutex_leave(mem0.mutex);
  23004. p = sqlite3Malloc(n);
  23005. if( sqlite3GlobalConfig.bMemstat && p ){
  23006. sqlite3_mutex_enter(mem0.mutex);
  23007. sqlite3StatusUp(SQLITE_STATUS_SCRATCH_OVERFLOW, sqlite3MallocSize(p));
  23008. sqlite3_mutex_leave(mem0.mutex);
  23009. }
  23010. sqlite3MemdebugSetType(p, MEMTYPE_SCRATCH);
  23011. }
  23012. assert( sqlite3_mutex_notheld(mem0.mutex) );
  23013. #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
  23014. /* EVIDENCE-OF: R-12970-05880 SQLite will not use more than one scratch
  23015. ** buffers per thread.
  23016. **
  23017. ** This can only be checked in single-threaded mode.
  23018. */
  23019. assert( scratchAllocOut==0 );
  23020. if( p ) scratchAllocOut++;
  23021. #endif
  23022. return p;
  23023. }
  23024. SQLITE_PRIVATE void sqlite3ScratchFree(void *p){
  23025. if( p ){
  23026. #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
  23027. /* Verify that no more than two scratch allocation per thread
  23028. ** is outstanding at one time. (This is only checked in the
  23029. ** single-threaded case since checking in the multi-threaded case
  23030. ** would be much more complicated.) */
  23031. assert( scratchAllocOut>=1 && scratchAllocOut<=2 );
  23032. scratchAllocOut--;
  23033. #endif
  23034. if( SQLITE_WITHIN(p, sqlite3GlobalConfig.pScratch, mem0.pScratchEnd) ){
  23035. /* Release memory from the SQLITE_CONFIG_SCRATCH allocation */
  23036. ScratchFreeslot *pSlot;
  23037. pSlot = (ScratchFreeslot*)p;
  23038. sqlite3_mutex_enter(mem0.mutex);
  23039. pSlot->pNext = mem0.pScratchFree;
  23040. mem0.pScratchFree = pSlot;
  23041. mem0.nScratchFree++;
  23042. assert( mem0.nScratchFree <= (u32)sqlite3GlobalConfig.nScratch );
  23043. sqlite3StatusDown(SQLITE_STATUS_SCRATCH_USED, 1);
  23044. sqlite3_mutex_leave(mem0.mutex);
  23045. }else{
  23046. /* Release memory back to the heap */
  23047. assert( sqlite3MemdebugHasType(p, MEMTYPE_SCRATCH) );
  23048. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_SCRATCH) );
  23049. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  23050. if( sqlite3GlobalConfig.bMemstat ){
  23051. int iSize = sqlite3MallocSize(p);
  23052. sqlite3_mutex_enter(mem0.mutex);
  23053. sqlite3StatusDown(SQLITE_STATUS_SCRATCH_OVERFLOW, iSize);
  23054. sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, iSize);
  23055. sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
  23056. sqlite3GlobalConfig.m.xFree(p);
  23057. sqlite3_mutex_leave(mem0.mutex);
  23058. }else{
  23059. sqlite3GlobalConfig.m.xFree(p);
  23060. }
  23061. }
  23062. }
  23063. }
  23064. /*
  23065. ** TRUE if p is a lookaside memory allocation from db
  23066. */
  23067. #ifndef SQLITE_OMIT_LOOKASIDE
  23068. static int isLookaside(sqlite3 *db, void *p){
  23069. return SQLITE_WITHIN(p, db->lookaside.pStart, db->lookaside.pEnd);
  23070. }
  23071. #else
  23072. #define isLookaside(A,B) 0
  23073. #endif
  23074. /*
  23075. ** Return the size of a memory allocation previously obtained from
  23076. ** sqlite3Malloc() or sqlite3_malloc().
  23077. */
  23078. SQLITE_PRIVATE int sqlite3MallocSize(void *p){
  23079. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  23080. return sqlite3GlobalConfig.m.xSize(p);
  23081. }
  23082. SQLITE_PRIVATE int sqlite3DbMallocSize(sqlite3 *db, void *p){
  23083. assert( p!=0 );
  23084. if( db==0 || !isLookaside(db,p) ){
  23085. #if SQLITE_DEBUG
  23086. if( db==0 ){
  23087. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  23088. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  23089. }else{
  23090. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23091. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23092. }
  23093. #endif
  23094. return sqlite3GlobalConfig.m.xSize(p);
  23095. }else{
  23096. assert( sqlite3_mutex_held(db->mutex) );
  23097. return db->lookaside.sz;
  23098. }
  23099. }
  23100. SQLITE_API sqlite3_uint64 sqlite3_msize(void *p){
  23101. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  23102. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  23103. return p ? sqlite3GlobalConfig.m.xSize(p) : 0;
  23104. }
  23105. /*
  23106. ** Free memory previously obtained from sqlite3Malloc().
  23107. */
  23108. SQLITE_API void sqlite3_free(void *p){
  23109. if( p==0 ) return; /* IMP: R-49053-54554 */
  23110. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  23111. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  23112. if( sqlite3GlobalConfig.bMemstat ){
  23113. sqlite3_mutex_enter(mem0.mutex);
  23114. sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, sqlite3MallocSize(p));
  23115. sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
  23116. sqlite3GlobalConfig.m.xFree(p);
  23117. sqlite3_mutex_leave(mem0.mutex);
  23118. }else{
  23119. sqlite3GlobalConfig.m.xFree(p);
  23120. }
  23121. }
  23122. /*
  23123. ** Add the size of memory allocation "p" to the count in
  23124. ** *db->pnBytesFreed.
  23125. */
  23126. static SQLITE_NOINLINE void measureAllocationSize(sqlite3 *db, void *p){
  23127. *db->pnBytesFreed += sqlite3DbMallocSize(db,p);
  23128. }
  23129. /*
  23130. ** Free memory that might be associated with a particular database
  23131. ** connection.
  23132. */
  23133. SQLITE_PRIVATE void sqlite3DbFree(sqlite3 *db, void *p){
  23134. assert( db==0 || sqlite3_mutex_held(db->mutex) );
  23135. if( p==0 ) return;
  23136. if( db ){
  23137. if( db->pnBytesFreed ){
  23138. measureAllocationSize(db, p);
  23139. return;
  23140. }
  23141. if( isLookaside(db, p) ){
  23142. LookasideSlot *pBuf = (LookasideSlot*)p;
  23143. #if SQLITE_DEBUG
  23144. /* Trash all content in the buffer being freed */
  23145. memset(p, 0xaa, db->lookaside.sz);
  23146. #endif
  23147. pBuf->pNext = db->lookaside.pFree;
  23148. db->lookaside.pFree = pBuf;
  23149. db->lookaside.nOut--;
  23150. return;
  23151. }
  23152. }
  23153. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23154. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23155. assert( db!=0 || sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
  23156. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  23157. sqlite3_free(p);
  23158. }
  23159. /*
  23160. ** Change the size of an existing memory allocation
  23161. */
  23162. SQLITE_PRIVATE void *sqlite3Realloc(void *pOld, u64 nBytes){
  23163. int nOld, nNew, nDiff;
  23164. void *pNew;
  23165. assert( sqlite3MemdebugHasType(pOld, MEMTYPE_HEAP) );
  23166. assert( sqlite3MemdebugNoType(pOld, (u8)~MEMTYPE_HEAP) );
  23167. if( pOld==0 ){
  23168. return sqlite3Malloc(nBytes); /* IMP: R-04300-56712 */
  23169. }
  23170. if( nBytes==0 ){
  23171. sqlite3_free(pOld); /* IMP: R-26507-47431 */
  23172. return 0;
  23173. }
  23174. if( nBytes>=0x7fffff00 ){
  23175. /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
  23176. return 0;
  23177. }
  23178. nOld = sqlite3MallocSize(pOld);
  23179. /* IMPLEMENTATION-OF: R-46199-30249 SQLite guarantees that the second
  23180. ** argument to xRealloc is always a value returned by a prior call to
  23181. ** xRoundup. */
  23182. nNew = sqlite3GlobalConfig.m.xRoundup((int)nBytes);
  23183. if( nOld==nNew ){
  23184. pNew = pOld;
  23185. }else if( sqlite3GlobalConfig.bMemstat ){
  23186. sqlite3_mutex_enter(mem0.mutex);
  23187. sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, (int)nBytes);
  23188. nDiff = nNew - nOld;
  23189. if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED) >=
  23190. mem0.alarmThreshold-nDiff ){
  23191. sqlite3MallocAlarm(nDiff);
  23192. }
  23193. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  23194. if( pNew==0 && mem0.alarmThreshold>0 ){
  23195. sqlite3MallocAlarm((int)nBytes);
  23196. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  23197. }
  23198. if( pNew ){
  23199. nNew = sqlite3MallocSize(pNew);
  23200. sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
  23201. }
  23202. sqlite3_mutex_leave(mem0.mutex);
  23203. }else{
  23204. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  23205. }
  23206. assert( EIGHT_BYTE_ALIGNMENT(pNew) ); /* IMP: R-11148-40995 */
  23207. return pNew;
  23208. }
  23209. /*
  23210. ** The public interface to sqlite3Realloc. Make sure that the memory
  23211. ** subsystem is initialized prior to invoking sqliteRealloc.
  23212. */
  23213. SQLITE_API void *sqlite3_realloc(void *pOld, int n){
  23214. #ifndef SQLITE_OMIT_AUTOINIT
  23215. if( sqlite3_initialize() ) return 0;
  23216. #endif
  23217. if( n<0 ) n = 0; /* IMP: R-26507-47431 */
  23218. return sqlite3Realloc(pOld, n);
  23219. }
  23220. SQLITE_API void *sqlite3_realloc64(void *pOld, sqlite3_uint64 n){
  23221. #ifndef SQLITE_OMIT_AUTOINIT
  23222. if( sqlite3_initialize() ) return 0;
  23223. #endif
  23224. return sqlite3Realloc(pOld, n);
  23225. }
  23226. /*
  23227. ** Allocate and zero memory.
  23228. */
  23229. SQLITE_PRIVATE void *sqlite3MallocZero(u64 n){
  23230. void *p = sqlite3Malloc(n);
  23231. if( p ){
  23232. memset(p, 0, (size_t)n);
  23233. }
  23234. return p;
  23235. }
  23236. /*
  23237. ** Allocate and zero memory. If the allocation fails, make
  23238. ** the mallocFailed flag in the connection pointer.
  23239. */
  23240. SQLITE_PRIVATE void *sqlite3DbMallocZero(sqlite3 *db, u64 n){
  23241. void *p;
  23242. testcase( db==0 );
  23243. p = sqlite3DbMallocRaw(db, n);
  23244. if( p ) memset(p, 0, (size_t)n);
  23245. return p;
  23246. }
  23247. /* Finish the work of sqlite3DbMallocRawNN for the unusual and
  23248. ** slower case when the allocation cannot be fulfilled using lookaside.
  23249. */
  23250. static SQLITE_NOINLINE void *dbMallocRawFinish(sqlite3 *db, u64 n){
  23251. void *p;
  23252. assert( db!=0 );
  23253. p = sqlite3Malloc(n);
  23254. if( !p ) sqlite3OomFault(db);
  23255. sqlite3MemdebugSetType(p,
  23256. (db->lookaside.bDisable==0) ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP);
  23257. return p;
  23258. }
  23259. /*
  23260. ** Allocate memory, either lookaside (if possible) or heap.
  23261. ** If the allocation fails, set the mallocFailed flag in
  23262. ** the connection pointer.
  23263. **
  23264. ** If db!=0 and db->mallocFailed is true (indicating a prior malloc
  23265. ** failure on the same database connection) then always return 0.
  23266. ** Hence for a particular database connection, once malloc starts
  23267. ** failing, it fails consistently until mallocFailed is reset.
  23268. ** This is an important assumption. There are many places in the
  23269. ** code that do things like this:
  23270. **
  23271. ** int *a = (int*)sqlite3DbMallocRaw(db, 100);
  23272. ** int *b = (int*)sqlite3DbMallocRaw(db, 200);
  23273. ** if( b ) a[10] = 9;
  23274. **
  23275. ** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
  23276. ** that all prior mallocs (ex: "a") worked too.
  23277. **
  23278. ** The sqlite3MallocRawNN() variant guarantees that the "db" parameter is
  23279. ** not a NULL pointer.
  23280. */
  23281. SQLITE_PRIVATE void *sqlite3DbMallocRaw(sqlite3 *db, u64 n){
  23282. void *p;
  23283. if( db ) return sqlite3DbMallocRawNN(db, n);
  23284. p = sqlite3Malloc(n);
  23285. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  23286. return p;
  23287. }
  23288. SQLITE_PRIVATE void *sqlite3DbMallocRawNN(sqlite3 *db, u64 n){
  23289. #ifndef SQLITE_OMIT_LOOKASIDE
  23290. LookasideSlot *pBuf;
  23291. assert( db!=0 );
  23292. assert( sqlite3_mutex_held(db->mutex) );
  23293. assert( db->pnBytesFreed==0 );
  23294. if( db->lookaside.bDisable==0 ){
  23295. assert( db->mallocFailed==0 );
  23296. if( n>db->lookaside.sz ){
  23297. db->lookaside.anStat[1]++;
  23298. }else if( (pBuf = db->lookaside.pFree)==0 ){
  23299. db->lookaside.anStat[2]++;
  23300. }else{
  23301. db->lookaside.pFree = pBuf->pNext;
  23302. db->lookaside.nOut++;
  23303. db->lookaside.anStat[0]++;
  23304. if( db->lookaside.nOut>db->lookaside.mxOut ){
  23305. db->lookaside.mxOut = db->lookaside.nOut;
  23306. }
  23307. return (void*)pBuf;
  23308. }
  23309. }else if( db->mallocFailed ){
  23310. return 0;
  23311. }
  23312. #else
  23313. assert( db!=0 );
  23314. assert( sqlite3_mutex_held(db->mutex) );
  23315. assert( db->pnBytesFreed==0 );
  23316. if( db->mallocFailed ){
  23317. return 0;
  23318. }
  23319. #endif
  23320. return dbMallocRawFinish(db, n);
  23321. }
  23322. /* Forward declaration */
  23323. static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n);
  23324. /*
  23325. ** Resize the block of memory pointed to by p to n bytes. If the
  23326. ** resize fails, set the mallocFailed flag in the connection object.
  23327. */
  23328. SQLITE_PRIVATE void *sqlite3DbRealloc(sqlite3 *db, void *p, u64 n){
  23329. assert( db!=0 );
  23330. if( p==0 ) return sqlite3DbMallocRawNN(db, n);
  23331. assert( sqlite3_mutex_held(db->mutex) );
  23332. if( isLookaside(db,p) && n<=db->lookaside.sz ) return p;
  23333. return dbReallocFinish(db, p, n);
  23334. }
  23335. static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n){
  23336. void *pNew = 0;
  23337. assert( db!=0 );
  23338. assert( p!=0 );
  23339. if( db->mallocFailed==0 ){
  23340. if( isLookaside(db, p) ){
  23341. pNew = sqlite3DbMallocRawNN(db, n);
  23342. if( pNew ){
  23343. memcpy(pNew, p, db->lookaside.sz);
  23344. sqlite3DbFree(db, p);
  23345. }
  23346. }else{
  23347. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23348. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  23349. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  23350. pNew = sqlite3_realloc64(p, n);
  23351. if( !pNew ){
  23352. sqlite3OomFault(db);
  23353. }
  23354. sqlite3MemdebugSetType(pNew,
  23355. (db->lookaside.bDisable==0 ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP));
  23356. }
  23357. }
  23358. return pNew;
  23359. }
  23360. /*
  23361. ** Attempt to reallocate p. If the reallocation fails, then free p
  23362. ** and set the mallocFailed flag in the database connection.
  23363. */
  23364. SQLITE_PRIVATE void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, u64 n){
  23365. void *pNew;
  23366. pNew = sqlite3DbRealloc(db, p, n);
  23367. if( !pNew ){
  23368. sqlite3DbFree(db, p);
  23369. }
  23370. return pNew;
  23371. }
  23372. /*
  23373. ** Make a copy of a string in memory obtained from sqliteMalloc(). These
  23374. ** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
  23375. ** is because when memory debugging is turned on, these two functions are
  23376. ** called via macros that record the current file and line number in the
  23377. ** ThreadData structure.
  23378. */
  23379. SQLITE_PRIVATE char *sqlite3DbStrDup(sqlite3 *db, const char *z){
  23380. char *zNew;
  23381. size_t n;
  23382. if( z==0 ){
  23383. return 0;
  23384. }
  23385. n = sqlite3Strlen30(z) + 1;
  23386. assert( (n&0x7fffffff)==n );
  23387. zNew = sqlite3DbMallocRaw(db, (int)n);
  23388. if( zNew ){
  23389. memcpy(zNew, z, n);
  23390. }
  23391. return zNew;
  23392. }
  23393. SQLITE_PRIVATE char *sqlite3DbStrNDup(sqlite3 *db, const char *z, u64 n){
  23394. char *zNew;
  23395. assert( db!=0 );
  23396. if( z==0 ){
  23397. return 0;
  23398. }
  23399. assert( (n&0x7fffffff)==n );
  23400. zNew = sqlite3DbMallocRawNN(db, n+1);
  23401. if( zNew ){
  23402. memcpy(zNew, z, (size_t)n);
  23403. zNew[n] = 0;
  23404. }
  23405. return zNew;
  23406. }
  23407. /*
  23408. ** Free any prior content in *pz and replace it with a copy of zNew.
  23409. */
  23410. SQLITE_PRIVATE void sqlite3SetString(char **pz, sqlite3 *db, const char *zNew){
  23411. sqlite3DbFree(db, *pz);
  23412. *pz = sqlite3DbStrDup(db, zNew);
  23413. }
  23414. /*
  23415. ** Call this routine to record the fact that an OOM (out-of-memory) error
  23416. ** has happened. This routine will set db->mallocFailed, and also
  23417. ** temporarily disable the lookaside memory allocator and interrupt
  23418. ** any running VDBEs.
  23419. */
  23420. SQLITE_PRIVATE void sqlite3OomFault(sqlite3 *db){
  23421. if( db->mallocFailed==0 && db->bBenignMalloc==0 ){
  23422. db->mallocFailed = 1;
  23423. if( db->nVdbeExec>0 ){
  23424. db->u1.isInterrupted = 1;
  23425. }
  23426. db->lookaside.bDisable++;
  23427. }
  23428. }
  23429. /*
  23430. ** This routine reactivates the memory allocator and clears the
  23431. ** db->mallocFailed flag as necessary.
  23432. **
  23433. ** The memory allocator is not restarted if there are running
  23434. ** VDBEs.
  23435. */
  23436. SQLITE_PRIVATE void sqlite3OomClear(sqlite3 *db){
  23437. if( db->mallocFailed && db->nVdbeExec==0 ){
  23438. db->mallocFailed = 0;
  23439. db->u1.isInterrupted = 0;
  23440. assert( db->lookaside.bDisable>0 );
  23441. db->lookaside.bDisable--;
  23442. }
  23443. }
  23444. /*
  23445. ** Take actions at the end of an API call to indicate an OOM error
  23446. */
  23447. static SQLITE_NOINLINE int apiOomError(sqlite3 *db){
  23448. sqlite3OomClear(db);
  23449. sqlite3Error(db, SQLITE_NOMEM);
  23450. return SQLITE_NOMEM_BKPT;
  23451. }
  23452. /*
  23453. ** This function must be called before exiting any API function (i.e.
  23454. ** returning control to the user) that has called sqlite3_malloc or
  23455. ** sqlite3_realloc.
  23456. **
  23457. ** The returned value is normally a copy of the second argument to this
  23458. ** function. However, if a malloc() failure has occurred since the previous
  23459. ** invocation SQLITE_NOMEM is returned instead.
  23460. **
  23461. ** If an OOM as occurred, then the connection error-code (the value
  23462. ** returned by sqlite3_errcode()) is set to SQLITE_NOMEM.
  23463. */
  23464. SQLITE_PRIVATE int sqlite3ApiExit(sqlite3* db, int rc){
  23465. /* If the db handle must hold the connection handle mutex here.
  23466. ** Otherwise the read (and possible write) of db->mallocFailed
  23467. ** is unsafe, as is the call to sqlite3Error().
  23468. */
  23469. assert( db!=0 );
  23470. assert( sqlite3_mutex_held(db->mutex) );
  23471. if( db->mallocFailed || rc==SQLITE_IOERR_NOMEM ){
  23472. return apiOomError(db);
  23473. }
  23474. return rc & db->errMask;
  23475. }
  23476. /************** End of malloc.c **********************************************/
  23477. /************** Begin file printf.c ******************************************/
  23478. /*
  23479. ** The "printf" code that follows dates from the 1980's. It is in
  23480. ** the public domain.
  23481. **
  23482. **************************************************************************
  23483. **
  23484. ** This file contains code for a set of "printf"-like routines. These
  23485. ** routines format strings much like the printf() from the standard C
  23486. ** library, though the implementation here has enhancements to support
  23487. ** SQLite.
  23488. */
  23489. /* #include "sqliteInt.h" */
  23490. /*
  23491. ** Conversion types fall into various categories as defined by the
  23492. ** following enumeration.
  23493. */
  23494. #define etRADIX 0 /* Integer types. %d, %x, %o, and so forth */
  23495. #define etFLOAT 1 /* Floating point. %f */
  23496. #define etEXP 2 /* Exponentional notation. %e and %E */
  23497. #define etGENERIC 3 /* Floating or exponential, depending on exponent. %g */
  23498. #define etSIZE 4 /* Return number of characters processed so far. %n */
  23499. #define etSTRING 5 /* Strings. %s */
  23500. #define etDYNSTRING 6 /* Dynamically allocated strings. %z */
  23501. #define etPERCENT 7 /* Percent symbol. %% */
  23502. #define etCHARX 8 /* Characters. %c */
  23503. /* The rest are extensions, not normally found in printf() */
  23504. #define etSQLESCAPE 9 /* Strings with '\'' doubled. %q */
  23505. #define etSQLESCAPE2 10 /* Strings with '\'' doubled and enclosed in '',
  23506. NULL pointers replaced by SQL NULL. %Q */
  23507. #define etTOKEN 11 /* a pointer to a Token structure */
  23508. #define etSRCLIST 12 /* a pointer to a SrcList */
  23509. #define etPOINTER 13 /* The %p conversion */
  23510. #define etSQLESCAPE3 14 /* %w -> Strings with '\"' doubled */
  23511. #define etORDINAL 15 /* %r -> 1st, 2nd, 3rd, 4th, etc. English only */
  23512. #define etINVALID 16 /* Any unrecognized conversion type */
  23513. /*
  23514. ** An "etByte" is an 8-bit unsigned value.
  23515. */
  23516. typedef unsigned char etByte;
  23517. /*
  23518. ** Each builtin conversion character (ex: the 'd' in "%d") is described
  23519. ** by an instance of the following structure
  23520. */
  23521. typedef struct et_info { /* Information about each format field */
  23522. char fmttype; /* The format field code letter */
  23523. etByte base; /* The base for radix conversion */
  23524. etByte flags; /* One or more of FLAG_ constants below */
  23525. etByte type; /* Conversion paradigm */
  23526. etByte charset; /* Offset into aDigits[] of the digits string */
  23527. etByte prefix; /* Offset into aPrefix[] of the prefix string */
  23528. } et_info;
  23529. /*
  23530. ** Allowed values for et_info.flags
  23531. */
  23532. #define FLAG_SIGNED 1 /* True if the value to convert is signed */
  23533. #define FLAG_INTERN 2 /* True if for internal use only */
  23534. #define FLAG_STRING 4 /* Allow infinity precision */
  23535. /*
  23536. ** The following table is searched linearly, so it is good to put the
  23537. ** most frequently used conversion types first.
  23538. */
  23539. static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
  23540. static const char aPrefix[] = "-x0\000X0";
  23541. static const et_info fmtinfo[] = {
  23542. { 'd', 10, 1, etRADIX, 0, 0 },
  23543. { 's', 0, 4, etSTRING, 0, 0 },
  23544. { 'g', 0, 1, etGENERIC, 30, 0 },
  23545. { 'z', 0, 4, etDYNSTRING, 0, 0 },
  23546. { 'q', 0, 4, etSQLESCAPE, 0, 0 },
  23547. { 'Q', 0, 4, etSQLESCAPE2, 0, 0 },
  23548. { 'w', 0, 4, etSQLESCAPE3, 0, 0 },
  23549. { 'c', 0, 0, etCHARX, 0, 0 },
  23550. { 'o', 8, 0, etRADIX, 0, 2 },
  23551. { 'u', 10, 0, etRADIX, 0, 0 },
  23552. { 'x', 16, 0, etRADIX, 16, 1 },
  23553. { 'X', 16, 0, etRADIX, 0, 4 },
  23554. #ifndef SQLITE_OMIT_FLOATING_POINT
  23555. { 'f', 0, 1, etFLOAT, 0, 0 },
  23556. { 'e', 0, 1, etEXP, 30, 0 },
  23557. { 'E', 0, 1, etEXP, 14, 0 },
  23558. { 'G', 0, 1, etGENERIC, 14, 0 },
  23559. #endif
  23560. { 'i', 10, 1, etRADIX, 0, 0 },
  23561. { 'n', 0, 0, etSIZE, 0, 0 },
  23562. { '%', 0, 0, etPERCENT, 0, 0 },
  23563. { 'p', 16, 0, etPOINTER, 0, 1 },
  23564. /* All the rest have the FLAG_INTERN bit set and are thus for internal
  23565. ** use only */
  23566. { 'T', 0, 2, etTOKEN, 0, 0 },
  23567. { 'S', 0, 2, etSRCLIST, 0, 0 },
  23568. { 'r', 10, 3, etORDINAL, 0, 0 },
  23569. };
  23570. /*
  23571. ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
  23572. ** conversions will work.
  23573. */
  23574. #ifndef SQLITE_OMIT_FLOATING_POINT
  23575. /*
  23576. ** "*val" is a double such that 0.1 <= *val < 10.0
  23577. ** Return the ascii code for the leading digit of *val, then
  23578. ** multiply "*val" by 10.0 to renormalize.
  23579. **
  23580. ** Example:
  23581. ** input: *val = 3.14159
  23582. ** output: *val = 1.4159 function return = '3'
  23583. **
  23584. ** The counter *cnt is incremented each time. After counter exceeds
  23585. ** 16 (the number of significant digits in a 64-bit float) '0' is
  23586. ** always returned.
  23587. */
  23588. static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
  23589. int digit;
  23590. LONGDOUBLE_TYPE d;
  23591. if( (*cnt)<=0 ) return '0';
  23592. (*cnt)--;
  23593. digit = (int)*val;
  23594. d = digit;
  23595. digit += '0';
  23596. *val = (*val - d)*10.0;
  23597. return (char)digit;
  23598. }
  23599. #endif /* SQLITE_OMIT_FLOATING_POINT */
  23600. /*
  23601. ** Set the StrAccum object to an error mode.
  23602. */
  23603. static void setStrAccumError(StrAccum *p, u8 eError){
  23604. assert( eError==STRACCUM_NOMEM || eError==STRACCUM_TOOBIG );
  23605. p->accError = eError;
  23606. p->nAlloc = 0;
  23607. }
  23608. /*
  23609. ** Extra argument values from a PrintfArguments object
  23610. */
  23611. static sqlite3_int64 getIntArg(PrintfArguments *p){
  23612. if( p->nArg<=p->nUsed ) return 0;
  23613. return sqlite3_value_int64(p->apArg[p->nUsed++]);
  23614. }
  23615. static double getDoubleArg(PrintfArguments *p){
  23616. if( p->nArg<=p->nUsed ) return 0.0;
  23617. return sqlite3_value_double(p->apArg[p->nUsed++]);
  23618. }
  23619. static char *getTextArg(PrintfArguments *p){
  23620. if( p->nArg<=p->nUsed ) return 0;
  23621. return (char*)sqlite3_value_text(p->apArg[p->nUsed++]);
  23622. }
  23623. /*
  23624. ** On machines with a small stack size, you can redefine the
  23625. ** SQLITE_PRINT_BUF_SIZE to be something smaller, if desired.
  23626. */
  23627. #ifndef SQLITE_PRINT_BUF_SIZE
  23628. # define SQLITE_PRINT_BUF_SIZE 70
  23629. #endif
  23630. #define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */
  23631. /*
  23632. ** Render a string given by "fmt" into the StrAccum object.
  23633. */
  23634. SQLITE_PRIVATE void sqlite3VXPrintf(
  23635. StrAccum *pAccum, /* Accumulate results here */
  23636. const char *fmt, /* Format string */
  23637. va_list ap /* arguments */
  23638. ){
  23639. int c; /* Next character in the format string */
  23640. char *bufpt; /* Pointer to the conversion buffer */
  23641. int precision; /* Precision of the current field */
  23642. int length; /* Length of the field */
  23643. int idx; /* A general purpose loop counter */
  23644. int width; /* Width of the current field */
  23645. etByte flag_leftjustify; /* True if "-" flag is present */
  23646. etByte flag_plussign; /* True if "+" flag is present */
  23647. etByte flag_blanksign; /* True if " " flag is present */
  23648. etByte flag_alternateform; /* True if "#" flag is present */
  23649. etByte flag_altform2; /* True if "!" flag is present */
  23650. etByte flag_zeropad; /* True if field width constant starts with zero */
  23651. etByte flag_long; /* True if "l" flag is present */
  23652. etByte flag_longlong; /* True if the "ll" flag is present */
  23653. etByte done; /* Loop termination flag */
  23654. etByte xtype = etINVALID; /* Conversion paradigm */
  23655. u8 bArgList; /* True for SQLITE_PRINTF_SQLFUNC */
  23656. u8 useIntern; /* Ok to use internal conversions (ex: %T) */
  23657. char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */
  23658. sqlite_uint64 longvalue; /* Value for integer types */
  23659. LONGDOUBLE_TYPE realvalue; /* Value for real types */
  23660. const et_info *infop; /* Pointer to the appropriate info structure */
  23661. char *zOut; /* Rendering buffer */
  23662. int nOut; /* Size of the rendering buffer */
  23663. char *zExtra = 0; /* Malloced memory used by some conversion */
  23664. #ifndef SQLITE_OMIT_FLOATING_POINT
  23665. int exp, e2; /* exponent of real numbers */
  23666. int nsd; /* Number of significant digits returned */
  23667. double rounder; /* Used for rounding floating point values */
  23668. etByte flag_dp; /* True if decimal point should be shown */
  23669. etByte flag_rtz; /* True if trailing zeros should be removed */
  23670. #endif
  23671. PrintfArguments *pArgList = 0; /* Arguments for SQLITE_PRINTF_SQLFUNC */
  23672. char buf[etBUFSIZE]; /* Conversion buffer */
  23673. bufpt = 0;
  23674. if( pAccum->printfFlags ){
  23675. if( (bArgList = (pAccum->printfFlags & SQLITE_PRINTF_SQLFUNC))!=0 ){
  23676. pArgList = va_arg(ap, PrintfArguments*);
  23677. }
  23678. useIntern = pAccum->printfFlags & SQLITE_PRINTF_INTERNAL;
  23679. }else{
  23680. bArgList = useIntern = 0;
  23681. }
  23682. for(; (c=(*fmt))!=0; ++fmt){
  23683. if( c!='%' ){
  23684. bufpt = (char *)fmt;
  23685. #if HAVE_STRCHRNUL
  23686. fmt = strchrnul(fmt, '%');
  23687. #else
  23688. do{ fmt++; }while( *fmt && *fmt != '%' );
  23689. #endif
  23690. sqlite3StrAccumAppend(pAccum, bufpt, (int)(fmt - bufpt));
  23691. if( *fmt==0 ) break;
  23692. }
  23693. if( (c=(*++fmt))==0 ){
  23694. sqlite3StrAccumAppend(pAccum, "%", 1);
  23695. break;
  23696. }
  23697. /* Find out what flags are present */
  23698. flag_leftjustify = flag_plussign = flag_blanksign =
  23699. flag_alternateform = flag_altform2 = flag_zeropad = 0;
  23700. done = 0;
  23701. do{
  23702. switch( c ){
  23703. case '-': flag_leftjustify = 1; break;
  23704. case '+': flag_plussign = 1; break;
  23705. case ' ': flag_blanksign = 1; break;
  23706. case '#': flag_alternateform = 1; break;
  23707. case '!': flag_altform2 = 1; break;
  23708. case '0': flag_zeropad = 1; break;
  23709. default: done = 1; break;
  23710. }
  23711. }while( !done && (c=(*++fmt))!=0 );
  23712. /* Get the field width */
  23713. if( c=='*' ){
  23714. if( bArgList ){
  23715. width = (int)getIntArg(pArgList);
  23716. }else{
  23717. width = va_arg(ap,int);
  23718. }
  23719. if( width<0 ){
  23720. flag_leftjustify = 1;
  23721. width = width >= -2147483647 ? -width : 0;
  23722. }
  23723. c = *++fmt;
  23724. }else{
  23725. unsigned wx = 0;
  23726. while( c>='0' && c<='9' ){
  23727. wx = wx*10 + c - '0';
  23728. c = *++fmt;
  23729. }
  23730. testcase( wx>0x7fffffff );
  23731. width = wx & 0x7fffffff;
  23732. }
  23733. assert( width>=0 );
  23734. #ifdef SQLITE_PRINTF_PRECISION_LIMIT
  23735. if( width>SQLITE_PRINTF_PRECISION_LIMIT ){
  23736. width = SQLITE_PRINTF_PRECISION_LIMIT;
  23737. }
  23738. #endif
  23739. /* Get the precision */
  23740. if( c=='.' ){
  23741. c = *++fmt;
  23742. if( c=='*' ){
  23743. if( bArgList ){
  23744. precision = (int)getIntArg(pArgList);
  23745. }else{
  23746. precision = va_arg(ap,int);
  23747. }
  23748. c = *++fmt;
  23749. if( precision<0 ){
  23750. precision = precision >= -2147483647 ? -precision : -1;
  23751. }
  23752. }else{
  23753. unsigned px = 0;
  23754. while( c>='0' && c<='9' ){
  23755. px = px*10 + c - '0';
  23756. c = *++fmt;
  23757. }
  23758. testcase( px>0x7fffffff );
  23759. precision = px & 0x7fffffff;
  23760. }
  23761. }else{
  23762. precision = -1;
  23763. }
  23764. assert( precision>=(-1) );
  23765. #ifdef SQLITE_PRINTF_PRECISION_LIMIT
  23766. if( precision>SQLITE_PRINTF_PRECISION_LIMIT ){
  23767. precision = SQLITE_PRINTF_PRECISION_LIMIT;
  23768. }
  23769. #endif
  23770. /* Get the conversion type modifier */
  23771. if( c=='l' ){
  23772. flag_long = 1;
  23773. c = *++fmt;
  23774. if( c=='l' ){
  23775. flag_longlong = 1;
  23776. c = *++fmt;
  23777. }else{
  23778. flag_longlong = 0;
  23779. }
  23780. }else{
  23781. flag_long = flag_longlong = 0;
  23782. }
  23783. /* Fetch the info entry for the field */
  23784. infop = &fmtinfo[0];
  23785. xtype = etINVALID;
  23786. for(idx=0; idx<ArraySize(fmtinfo); idx++){
  23787. if( c==fmtinfo[idx].fmttype ){
  23788. infop = &fmtinfo[idx];
  23789. if( useIntern || (infop->flags & FLAG_INTERN)==0 ){
  23790. xtype = infop->type;
  23791. }else{
  23792. return;
  23793. }
  23794. break;
  23795. }
  23796. }
  23797. /*
  23798. ** At this point, variables are initialized as follows:
  23799. **
  23800. ** flag_alternateform TRUE if a '#' is present.
  23801. ** flag_altform2 TRUE if a '!' is present.
  23802. ** flag_plussign TRUE if a '+' is present.
  23803. ** flag_leftjustify TRUE if a '-' is present or if the
  23804. ** field width was negative.
  23805. ** flag_zeropad TRUE if the width began with 0.
  23806. ** flag_long TRUE if the letter 'l' (ell) prefixed
  23807. ** the conversion character.
  23808. ** flag_longlong TRUE if the letter 'll' (ell ell) prefixed
  23809. ** the conversion character.
  23810. ** flag_blanksign TRUE if a ' ' is present.
  23811. ** width The specified field width. This is
  23812. ** always non-negative. Zero is the default.
  23813. ** precision The specified precision. The default
  23814. ** is -1.
  23815. ** xtype The class of the conversion.
  23816. ** infop Pointer to the appropriate info struct.
  23817. */
  23818. switch( xtype ){
  23819. case etPOINTER:
  23820. flag_longlong = sizeof(char*)==sizeof(i64);
  23821. flag_long = sizeof(char*)==sizeof(long int);
  23822. /* Fall through into the next case */
  23823. case etORDINAL:
  23824. case etRADIX:
  23825. if( infop->flags & FLAG_SIGNED ){
  23826. i64 v;
  23827. if( bArgList ){
  23828. v = getIntArg(pArgList);
  23829. }else if( flag_longlong ){
  23830. v = va_arg(ap,i64);
  23831. }else if( flag_long ){
  23832. v = va_arg(ap,long int);
  23833. }else{
  23834. v = va_arg(ap,int);
  23835. }
  23836. if( v<0 ){
  23837. if( v==SMALLEST_INT64 ){
  23838. longvalue = ((u64)1)<<63;
  23839. }else{
  23840. longvalue = -v;
  23841. }
  23842. prefix = '-';
  23843. }else{
  23844. longvalue = v;
  23845. if( flag_plussign ) prefix = '+';
  23846. else if( flag_blanksign ) prefix = ' ';
  23847. else prefix = 0;
  23848. }
  23849. }else{
  23850. if( bArgList ){
  23851. longvalue = (u64)getIntArg(pArgList);
  23852. }else if( flag_longlong ){
  23853. longvalue = va_arg(ap,u64);
  23854. }else if( flag_long ){
  23855. longvalue = va_arg(ap,unsigned long int);
  23856. }else{
  23857. longvalue = va_arg(ap,unsigned int);
  23858. }
  23859. prefix = 0;
  23860. }
  23861. if( longvalue==0 ) flag_alternateform = 0;
  23862. if( flag_zeropad && precision<width-(prefix!=0) ){
  23863. precision = width-(prefix!=0);
  23864. }
  23865. if( precision<etBUFSIZE-10 ){
  23866. nOut = etBUFSIZE;
  23867. zOut = buf;
  23868. }else{
  23869. nOut = precision + 10;
  23870. zOut = zExtra = sqlite3Malloc( nOut );
  23871. if( zOut==0 ){
  23872. setStrAccumError(pAccum, STRACCUM_NOMEM);
  23873. return;
  23874. }
  23875. }
  23876. bufpt = &zOut[nOut-1];
  23877. if( xtype==etORDINAL ){
  23878. static const char zOrd[] = "thstndrd";
  23879. int x = (int)(longvalue % 10);
  23880. if( x>=4 || (longvalue/10)%10==1 ){
  23881. x = 0;
  23882. }
  23883. *(--bufpt) = zOrd[x*2+1];
  23884. *(--bufpt) = zOrd[x*2];
  23885. }
  23886. {
  23887. const char *cset = &aDigits[infop->charset];
  23888. u8 base = infop->base;
  23889. do{ /* Convert to ascii */
  23890. *(--bufpt) = cset[longvalue%base];
  23891. longvalue = longvalue/base;
  23892. }while( longvalue>0 );
  23893. }
  23894. length = (int)(&zOut[nOut-1]-bufpt);
  23895. for(idx=precision-length; idx>0; idx--){
  23896. *(--bufpt) = '0'; /* Zero pad */
  23897. }
  23898. if( prefix ) *(--bufpt) = prefix; /* Add sign */
  23899. if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */
  23900. const char *pre;
  23901. char x;
  23902. pre = &aPrefix[infop->prefix];
  23903. for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
  23904. }
  23905. length = (int)(&zOut[nOut-1]-bufpt);
  23906. break;
  23907. case etFLOAT:
  23908. case etEXP:
  23909. case etGENERIC:
  23910. if( bArgList ){
  23911. realvalue = getDoubleArg(pArgList);
  23912. }else{
  23913. realvalue = va_arg(ap,double);
  23914. }
  23915. #ifdef SQLITE_OMIT_FLOATING_POINT
  23916. length = 0;
  23917. #else
  23918. if( precision<0 ) precision = 6; /* Set default precision */
  23919. if( realvalue<0.0 ){
  23920. realvalue = -realvalue;
  23921. prefix = '-';
  23922. }else{
  23923. if( flag_plussign ) prefix = '+';
  23924. else if( flag_blanksign ) prefix = ' ';
  23925. else prefix = 0;
  23926. }
  23927. if( xtype==etGENERIC && precision>0 ) precision--;
  23928. testcase( precision>0xfff );
  23929. for(idx=precision&0xfff, rounder=0.5; idx>0; idx--, rounder*=0.1){}
  23930. if( xtype==etFLOAT ) realvalue += rounder;
  23931. /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
  23932. exp = 0;
  23933. if( sqlite3IsNaN((double)realvalue) ){
  23934. bufpt = "NaN";
  23935. length = 3;
  23936. break;
  23937. }
  23938. if( realvalue>0.0 ){
  23939. LONGDOUBLE_TYPE scale = 1.0;
  23940. while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;}
  23941. while( realvalue>=1e10*scale && exp<=350 ){ scale *= 1e10; exp+=10; }
  23942. while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; }
  23943. realvalue /= scale;
  23944. while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
  23945. while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
  23946. if( exp>350 ){
  23947. bufpt = buf;
  23948. buf[0] = prefix;
  23949. memcpy(buf+(prefix!=0),"Inf",4);
  23950. length = 3+(prefix!=0);
  23951. break;
  23952. }
  23953. }
  23954. bufpt = buf;
  23955. /*
  23956. ** If the field type is etGENERIC, then convert to either etEXP
  23957. ** or etFLOAT, as appropriate.
  23958. */
  23959. if( xtype!=etFLOAT ){
  23960. realvalue += rounder;
  23961. if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
  23962. }
  23963. if( xtype==etGENERIC ){
  23964. flag_rtz = !flag_alternateform;
  23965. if( exp<-4 || exp>precision ){
  23966. xtype = etEXP;
  23967. }else{
  23968. precision = precision - exp;
  23969. xtype = etFLOAT;
  23970. }
  23971. }else{
  23972. flag_rtz = flag_altform2;
  23973. }
  23974. if( xtype==etEXP ){
  23975. e2 = 0;
  23976. }else{
  23977. e2 = exp;
  23978. }
  23979. if( MAX(e2,0)+(i64)precision+(i64)width > etBUFSIZE - 15 ){
  23980. bufpt = zExtra
  23981. = sqlite3Malloc( MAX(e2,0)+(i64)precision+(i64)width+15 );
  23982. if( bufpt==0 ){
  23983. setStrAccumError(pAccum, STRACCUM_NOMEM);
  23984. return;
  23985. }
  23986. }
  23987. zOut = bufpt;
  23988. nsd = 16 + flag_altform2*10;
  23989. flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
  23990. /* The sign in front of the number */
  23991. if( prefix ){
  23992. *(bufpt++) = prefix;
  23993. }
  23994. /* Digits prior to the decimal point */
  23995. if( e2<0 ){
  23996. *(bufpt++) = '0';
  23997. }else{
  23998. for(; e2>=0; e2--){
  23999. *(bufpt++) = et_getdigit(&realvalue,&nsd);
  24000. }
  24001. }
  24002. /* The decimal point */
  24003. if( flag_dp ){
  24004. *(bufpt++) = '.';
  24005. }
  24006. /* "0" digits after the decimal point but before the first
  24007. ** significant digit of the number */
  24008. for(e2++; e2<0; precision--, e2++){
  24009. assert( precision>0 );
  24010. *(bufpt++) = '0';
  24011. }
  24012. /* Significant digits after the decimal point */
  24013. while( (precision--)>0 ){
  24014. *(bufpt++) = et_getdigit(&realvalue,&nsd);
  24015. }
  24016. /* Remove trailing zeros and the "." if no digits follow the "." */
  24017. if( flag_rtz && flag_dp ){
  24018. while( bufpt[-1]=='0' ) *(--bufpt) = 0;
  24019. assert( bufpt>zOut );
  24020. if( bufpt[-1]=='.' ){
  24021. if( flag_altform2 ){
  24022. *(bufpt++) = '0';
  24023. }else{
  24024. *(--bufpt) = 0;
  24025. }
  24026. }
  24027. }
  24028. /* Add the "eNNN" suffix */
  24029. if( xtype==etEXP ){
  24030. *(bufpt++) = aDigits[infop->charset];
  24031. if( exp<0 ){
  24032. *(bufpt++) = '-'; exp = -exp;
  24033. }else{
  24034. *(bufpt++) = '+';
  24035. }
  24036. if( exp>=100 ){
  24037. *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */
  24038. exp %= 100;
  24039. }
  24040. *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */
  24041. *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */
  24042. }
  24043. *bufpt = 0;
  24044. /* The converted number is in buf[] and zero terminated. Output it.
  24045. ** Note that the number is in the usual order, not reversed as with
  24046. ** integer conversions. */
  24047. length = (int)(bufpt-zOut);
  24048. bufpt = zOut;
  24049. /* Special case: Add leading zeros if the flag_zeropad flag is
  24050. ** set and we are not left justified */
  24051. if( flag_zeropad && !flag_leftjustify && length < width){
  24052. int i;
  24053. int nPad = width - length;
  24054. for(i=width; i>=nPad; i--){
  24055. bufpt[i] = bufpt[i-nPad];
  24056. }
  24057. i = prefix!=0;
  24058. while( nPad-- ) bufpt[i++] = '0';
  24059. length = width;
  24060. }
  24061. #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
  24062. break;
  24063. case etSIZE:
  24064. if( !bArgList ){
  24065. *(va_arg(ap,int*)) = pAccum->nChar;
  24066. }
  24067. length = width = 0;
  24068. break;
  24069. case etPERCENT:
  24070. buf[0] = '%';
  24071. bufpt = buf;
  24072. length = 1;
  24073. break;
  24074. case etCHARX:
  24075. if( bArgList ){
  24076. bufpt = getTextArg(pArgList);
  24077. c = bufpt ? bufpt[0] : 0;
  24078. }else{
  24079. c = va_arg(ap,int);
  24080. }
  24081. if( precision>1 ){
  24082. width -= precision-1;
  24083. if( width>1 && !flag_leftjustify ){
  24084. sqlite3AppendChar(pAccum, width-1, ' ');
  24085. width = 0;
  24086. }
  24087. sqlite3AppendChar(pAccum, precision-1, c);
  24088. }
  24089. length = 1;
  24090. buf[0] = c;
  24091. bufpt = buf;
  24092. break;
  24093. case etSTRING:
  24094. case etDYNSTRING:
  24095. if( bArgList ){
  24096. bufpt = getTextArg(pArgList);
  24097. xtype = etSTRING;
  24098. }else{
  24099. bufpt = va_arg(ap,char*);
  24100. }
  24101. if( bufpt==0 ){
  24102. bufpt = "";
  24103. }else if( xtype==etDYNSTRING ){
  24104. zExtra = bufpt;
  24105. }
  24106. if( precision>=0 ){
  24107. for(length=0; length<precision && bufpt[length]; length++){}
  24108. }else{
  24109. length = sqlite3Strlen30(bufpt);
  24110. }
  24111. break;
  24112. case etSQLESCAPE: /* Escape ' characters */
  24113. case etSQLESCAPE2: /* Escape ' and enclose in '...' */
  24114. case etSQLESCAPE3: { /* Escape " characters */
  24115. int i, j, k, n, isnull;
  24116. int needQuote;
  24117. char ch;
  24118. char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */
  24119. char *escarg;
  24120. if( bArgList ){
  24121. escarg = getTextArg(pArgList);
  24122. }else{
  24123. escarg = va_arg(ap,char*);
  24124. }
  24125. isnull = escarg==0;
  24126. if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
  24127. k = precision;
  24128. for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){
  24129. if( ch==q ) n++;
  24130. }
  24131. needQuote = !isnull && xtype==etSQLESCAPE2;
  24132. n += i + 3;
  24133. if( n>etBUFSIZE ){
  24134. bufpt = zExtra = sqlite3Malloc( n );
  24135. if( bufpt==0 ){
  24136. setStrAccumError(pAccum, STRACCUM_NOMEM);
  24137. return;
  24138. }
  24139. }else{
  24140. bufpt = buf;
  24141. }
  24142. j = 0;
  24143. if( needQuote ) bufpt[j++] = q;
  24144. k = i;
  24145. for(i=0; i<k; i++){
  24146. bufpt[j++] = ch = escarg[i];
  24147. if( ch==q ) bufpt[j++] = ch;
  24148. }
  24149. if( needQuote ) bufpt[j++] = q;
  24150. bufpt[j] = 0;
  24151. length = j;
  24152. /* The precision in %q and %Q means how many input characters to
  24153. ** consume, not the length of the output...
  24154. ** if( precision>=0 && precision<length ) length = precision; */
  24155. break;
  24156. }
  24157. case etTOKEN: {
  24158. Token *pToken = va_arg(ap, Token*);
  24159. assert( bArgList==0 );
  24160. if( pToken && pToken->n ){
  24161. sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n);
  24162. }
  24163. length = width = 0;
  24164. break;
  24165. }
  24166. case etSRCLIST: {
  24167. SrcList *pSrc = va_arg(ap, SrcList*);
  24168. int k = va_arg(ap, int);
  24169. struct SrcList_item *pItem = &pSrc->a[k];
  24170. assert( bArgList==0 );
  24171. assert( k>=0 && k<pSrc->nSrc );
  24172. if( pItem->zDatabase ){
  24173. sqlite3StrAccumAppendAll(pAccum, pItem->zDatabase);
  24174. sqlite3StrAccumAppend(pAccum, ".", 1);
  24175. }
  24176. sqlite3StrAccumAppendAll(pAccum, pItem->zName);
  24177. length = width = 0;
  24178. break;
  24179. }
  24180. default: {
  24181. assert( xtype==etINVALID );
  24182. return;
  24183. }
  24184. }/* End switch over the format type */
  24185. /*
  24186. ** The text of the conversion is pointed to by "bufpt" and is
  24187. ** "length" characters long. The field width is "width". Do
  24188. ** the output.
  24189. */
  24190. width -= length;
  24191. if( width>0 && !flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' ');
  24192. sqlite3StrAccumAppend(pAccum, bufpt, length);
  24193. if( width>0 && flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' ');
  24194. if( zExtra ){
  24195. sqlite3DbFree(pAccum->db, zExtra);
  24196. zExtra = 0;
  24197. }
  24198. }/* End for loop over the format string */
  24199. } /* End of function */
  24200. /*
  24201. ** Enlarge the memory allocation on a StrAccum object so that it is
  24202. ** able to accept at least N more bytes of text.
  24203. **
  24204. ** Return the number of bytes of text that StrAccum is able to accept
  24205. ** after the attempted enlargement. The value returned might be zero.
  24206. */
  24207. static int sqlite3StrAccumEnlarge(StrAccum *p, int N){
  24208. char *zNew;
  24209. assert( p->nChar+(i64)N >= p->nAlloc ); /* Only called if really needed */
  24210. if( p->accError ){
  24211. testcase(p->accError==STRACCUM_TOOBIG);
  24212. testcase(p->accError==STRACCUM_NOMEM);
  24213. return 0;
  24214. }
  24215. if( p->mxAlloc==0 ){
  24216. N = p->nAlloc - p->nChar - 1;
  24217. setStrAccumError(p, STRACCUM_TOOBIG);
  24218. return N;
  24219. }else{
  24220. char *zOld = isMalloced(p) ? p->zText : 0;
  24221. i64 szNew = p->nChar;
  24222. assert( (p->zText==0 || p->zText==p->zBase)==!isMalloced(p) );
  24223. szNew += N + 1;
  24224. if( szNew+p->nChar<=p->mxAlloc ){
  24225. /* Force exponential buffer size growth as long as it does not overflow,
  24226. ** to avoid having to call this routine too often */
  24227. szNew += p->nChar;
  24228. }
  24229. if( szNew > p->mxAlloc ){
  24230. sqlite3StrAccumReset(p);
  24231. setStrAccumError(p, STRACCUM_TOOBIG);
  24232. return 0;
  24233. }else{
  24234. p->nAlloc = (int)szNew;
  24235. }
  24236. if( p->db ){
  24237. zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc);
  24238. }else{
  24239. zNew = sqlite3_realloc64(zOld, p->nAlloc);
  24240. }
  24241. if( zNew ){
  24242. assert( p->zText!=0 || p->nChar==0 );
  24243. if( !isMalloced(p) && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar);
  24244. p->zText = zNew;
  24245. p->nAlloc = sqlite3DbMallocSize(p->db, zNew);
  24246. p->printfFlags |= SQLITE_PRINTF_MALLOCED;
  24247. }else{
  24248. sqlite3StrAccumReset(p);
  24249. setStrAccumError(p, STRACCUM_NOMEM);
  24250. return 0;
  24251. }
  24252. }
  24253. return N;
  24254. }
  24255. /*
  24256. ** Append N copies of character c to the given string buffer.
  24257. */
  24258. SQLITE_PRIVATE void sqlite3AppendChar(StrAccum *p, int N, char c){
  24259. testcase( p->nChar + (i64)N > 0x7fffffff );
  24260. if( p->nChar+(i64)N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ){
  24261. return;
  24262. }
  24263. assert( (p->zText==p->zBase)==!isMalloced(p) );
  24264. while( (N--)>0 ) p->zText[p->nChar++] = c;
  24265. }
  24266. /*
  24267. ** The StrAccum "p" is not large enough to accept N new bytes of z[].
  24268. ** So enlarge if first, then do the append.
  24269. **
  24270. ** This is a helper routine to sqlite3StrAccumAppend() that does special-case
  24271. ** work (enlarging the buffer) using tail recursion, so that the
  24272. ** sqlite3StrAccumAppend() routine can use fast calling semantics.
  24273. */
  24274. static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){
  24275. N = sqlite3StrAccumEnlarge(p, N);
  24276. if( N>0 ){
  24277. memcpy(&p->zText[p->nChar], z, N);
  24278. p->nChar += N;
  24279. }
  24280. assert( (p->zText==0 || p->zText==p->zBase)==!isMalloced(p) );
  24281. }
  24282. /*
  24283. ** Append N bytes of text from z to the StrAccum object. Increase the
  24284. ** size of the memory allocation for StrAccum if necessary.
  24285. */
  24286. SQLITE_PRIVATE void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){
  24287. assert( z!=0 || N==0 );
  24288. assert( p->zText!=0 || p->nChar==0 || p->accError );
  24289. assert( N>=0 );
  24290. assert( p->accError==0 || p->nAlloc==0 );
  24291. if( p->nChar+N >= p->nAlloc ){
  24292. enlargeAndAppend(p,z,N);
  24293. }else{
  24294. assert( p->zText );
  24295. p->nChar += N;
  24296. memcpy(&p->zText[p->nChar-N], z, N);
  24297. }
  24298. }
  24299. /*
  24300. ** Append the complete text of zero-terminated string z[] to the p string.
  24301. */
  24302. SQLITE_PRIVATE void sqlite3StrAccumAppendAll(StrAccum *p, const char *z){
  24303. sqlite3StrAccumAppend(p, z, sqlite3Strlen30(z));
  24304. }
  24305. /*
  24306. ** Finish off a string by making sure it is zero-terminated.
  24307. ** Return a pointer to the resulting string. Return a NULL
  24308. ** pointer if any kind of error was encountered.
  24309. */
  24310. SQLITE_PRIVATE char *sqlite3StrAccumFinish(StrAccum *p){
  24311. if( p->zText ){
  24312. assert( (p->zText==p->zBase)==!isMalloced(p) );
  24313. p->zText[p->nChar] = 0;
  24314. if( p->mxAlloc>0 && !isMalloced(p) ){
  24315. p->zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
  24316. if( p->zText ){
  24317. memcpy(p->zText, p->zBase, p->nChar+1);
  24318. p->printfFlags |= SQLITE_PRINTF_MALLOCED;
  24319. }else{
  24320. setStrAccumError(p, STRACCUM_NOMEM);
  24321. }
  24322. }
  24323. }
  24324. return p->zText;
  24325. }
  24326. /*
  24327. ** Reset an StrAccum string. Reclaim all malloced memory.
  24328. */
  24329. SQLITE_PRIVATE void sqlite3StrAccumReset(StrAccum *p){
  24330. assert( (p->zText==0 || p->zText==p->zBase)==!isMalloced(p) );
  24331. if( isMalloced(p) ){
  24332. sqlite3DbFree(p->db, p->zText);
  24333. p->printfFlags &= ~SQLITE_PRINTF_MALLOCED;
  24334. }
  24335. p->zText = 0;
  24336. }
  24337. /*
  24338. ** Initialize a string accumulator.
  24339. **
  24340. ** p: The accumulator to be initialized.
  24341. ** db: Pointer to a database connection. May be NULL. Lookaside
  24342. ** memory is used if not NULL. db->mallocFailed is set appropriately
  24343. ** when not NULL.
  24344. ** zBase: An initial buffer. May be NULL in which case the initial buffer
  24345. ** is malloced.
  24346. ** n: Size of zBase in bytes. If total space requirements never exceed
  24347. ** n then no memory allocations ever occur.
  24348. ** mx: Maximum number of bytes to accumulate. If mx==0 then no memory
  24349. ** allocations will ever occur.
  24350. */
  24351. SQLITE_PRIVATE void sqlite3StrAccumInit(StrAccum *p, sqlite3 *db, char *zBase, int n, int mx){
  24352. p->zText = p->zBase = zBase;
  24353. p->db = db;
  24354. p->nChar = 0;
  24355. p->nAlloc = n;
  24356. p->mxAlloc = mx;
  24357. p->accError = 0;
  24358. p->printfFlags = 0;
  24359. }
  24360. /*
  24361. ** Print into memory obtained from sqliteMalloc(). Use the internal
  24362. ** %-conversion extensions.
  24363. */
  24364. SQLITE_PRIVATE char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
  24365. char *z;
  24366. char zBase[SQLITE_PRINT_BUF_SIZE];
  24367. StrAccum acc;
  24368. assert( db!=0 );
  24369. sqlite3StrAccumInit(&acc, db, zBase, sizeof(zBase),
  24370. db->aLimit[SQLITE_LIMIT_LENGTH]);
  24371. acc.printfFlags = SQLITE_PRINTF_INTERNAL;
  24372. sqlite3VXPrintf(&acc, zFormat, ap);
  24373. z = sqlite3StrAccumFinish(&acc);
  24374. if( acc.accError==STRACCUM_NOMEM ){
  24375. sqlite3OomFault(db);
  24376. }
  24377. return z;
  24378. }
  24379. /*
  24380. ** Print into memory obtained from sqliteMalloc(). Use the internal
  24381. ** %-conversion extensions.
  24382. */
  24383. SQLITE_PRIVATE char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
  24384. va_list ap;
  24385. char *z;
  24386. va_start(ap, zFormat);
  24387. z = sqlite3VMPrintf(db, zFormat, ap);
  24388. va_end(ap);
  24389. return z;
  24390. }
  24391. /*
  24392. ** Print into memory obtained from sqlite3_malloc(). Omit the internal
  24393. ** %-conversion extensions.
  24394. */
  24395. SQLITE_API char *sqlite3_vmprintf(const char *zFormat, va_list ap){
  24396. char *z;
  24397. char zBase[SQLITE_PRINT_BUF_SIZE];
  24398. StrAccum acc;
  24399. #ifdef SQLITE_ENABLE_API_ARMOR
  24400. if( zFormat==0 ){
  24401. (void)SQLITE_MISUSE_BKPT;
  24402. return 0;
  24403. }
  24404. #endif
  24405. #ifndef SQLITE_OMIT_AUTOINIT
  24406. if( sqlite3_initialize() ) return 0;
  24407. #endif
  24408. sqlite3StrAccumInit(&acc, 0, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
  24409. sqlite3VXPrintf(&acc, zFormat, ap);
  24410. z = sqlite3StrAccumFinish(&acc);
  24411. return z;
  24412. }
  24413. /*
  24414. ** Print into memory obtained from sqlite3_malloc()(). Omit the internal
  24415. ** %-conversion extensions.
  24416. */
  24417. SQLITE_API char *sqlite3_mprintf(const char *zFormat, ...){
  24418. va_list ap;
  24419. char *z;
  24420. #ifndef SQLITE_OMIT_AUTOINIT
  24421. if( sqlite3_initialize() ) return 0;
  24422. #endif
  24423. va_start(ap, zFormat);
  24424. z = sqlite3_vmprintf(zFormat, ap);
  24425. va_end(ap);
  24426. return z;
  24427. }
  24428. /*
  24429. ** sqlite3_snprintf() works like snprintf() except that it ignores the
  24430. ** current locale settings. This is important for SQLite because we
  24431. ** are not able to use a "," as the decimal point in place of "." as
  24432. ** specified by some locales.
  24433. **
  24434. ** Oops: The first two arguments of sqlite3_snprintf() are backwards
  24435. ** from the snprintf() standard. Unfortunately, it is too late to change
  24436. ** this without breaking compatibility, so we just have to live with the
  24437. ** mistake.
  24438. **
  24439. ** sqlite3_vsnprintf() is the varargs version.
  24440. */
  24441. SQLITE_API char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){
  24442. StrAccum acc;
  24443. if( n<=0 ) return zBuf;
  24444. #ifdef SQLITE_ENABLE_API_ARMOR
  24445. if( zBuf==0 || zFormat==0 ) {
  24446. (void)SQLITE_MISUSE_BKPT;
  24447. if( zBuf ) zBuf[0] = 0;
  24448. return zBuf;
  24449. }
  24450. #endif
  24451. sqlite3StrAccumInit(&acc, 0, zBuf, n, 0);
  24452. sqlite3VXPrintf(&acc, zFormat, ap);
  24453. return sqlite3StrAccumFinish(&acc);
  24454. }
  24455. SQLITE_API char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
  24456. char *z;
  24457. va_list ap;
  24458. va_start(ap,zFormat);
  24459. z = sqlite3_vsnprintf(n, zBuf, zFormat, ap);
  24460. va_end(ap);
  24461. return z;
  24462. }
  24463. /*
  24464. ** This is the routine that actually formats the sqlite3_log() message.
  24465. ** We house it in a separate routine from sqlite3_log() to avoid using
  24466. ** stack space on small-stack systems when logging is disabled.
  24467. **
  24468. ** sqlite3_log() must render into a static buffer. It cannot dynamically
  24469. ** allocate memory because it might be called while the memory allocator
  24470. ** mutex is held.
  24471. **
  24472. ** sqlite3VXPrintf() might ask for *temporary* memory allocations for
  24473. ** certain format characters (%q) or for very large precisions or widths.
  24474. ** Care must be taken that any sqlite3_log() calls that occur while the
  24475. ** memory mutex is held do not use these mechanisms.
  24476. */
  24477. static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){
  24478. StrAccum acc; /* String accumulator */
  24479. char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */
  24480. sqlite3StrAccumInit(&acc, 0, zMsg, sizeof(zMsg), 0);
  24481. sqlite3VXPrintf(&acc, zFormat, ap);
  24482. sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode,
  24483. sqlite3StrAccumFinish(&acc));
  24484. }
  24485. /*
  24486. ** Format and write a message to the log if logging is enabled.
  24487. */
  24488. SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...){
  24489. va_list ap; /* Vararg list */
  24490. if( sqlite3GlobalConfig.xLog ){
  24491. va_start(ap, zFormat);
  24492. renderLogMsg(iErrCode, zFormat, ap);
  24493. va_end(ap);
  24494. }
  24495. }
  24496. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  24497. /*
  24498. ** A version of printf() that understands %lld. Used for debugging.
  24499. ** The printf() built into some versions of windows does not understand %lld
  24500. ** and segfaults if you give it a long long int.
  24501. */
  24502. SQLITE_PRIVATE void sqlite3DebugPrintf(const char *zFormat, ...){
  24503. va_list ap;
  24504. StrAccum acc;
  24505. char zBuf[500];
  24506. sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
  24507. va_start(ap,zFormat);
  24508. sqlite3VXPrintf(&acc, zFormat, ap);
  24509. va_end(ap);
  24510. sqlite3StrAccumFinish(&acc);
  24511. fprintf(stdout,"%s", zBuf);
  24512. fflush(stdout);
  24513. }
  24514. #endif
  24515. /*
  24516. ** variable-argument wrapper around sqlite3VXPrintf(). The bFlags argument
  24517. ** can contain the bit SQLITE_PRINTF_INTERNAL enable internal formats.
  24518. */
  24519. SQLITE_PRIVATE void sqlite3XPrintf(StrAccum *p, const char *zFormat, ...){
  24520. va_list ap;
  24521. va_start(ap,zFormat);
  24522. sqlite3VXPrintf(p, zFormat, ap);
  24523. va_end(ap);
  24524. }
  24525. /************** End of printf.c **********************************************/
  24526. /************** Begin file treeview.c ****************************************/
  24527. /*
  24528. ** 2015-06-08
  24529. **
  24530. ** The author disclaims copyright to this source code. In place of
  24531. ** a legal notice, here is a blessing:
  24532. **
  24533. ** May you do good and not evil.
  24534. ** May you find forgiveness for yourself and forgive others.
  24535. ** May you share freely, never taking more than you give.
  24536. **
  24537. *************************************************************************
  24538. **
  24539. ** This file contains C code to implement the TreeView debugging routines.
  24540. ** These routines print a parse tree to standard output for debugging and
  24541. ** analysis.
  24542. **
  24543. ** The interfaces in this file is only available when compiling
  24544. ** with SQLITE_DEBUG.
  24545. */
  24546. /* #include "sqliteInt.h" */
  24547. #ifdef SQLITE_DEBUG
  24548. /*
  24549. ** Add a new subitem to the tree. The moreToFollow flag indicates that this
  24550. ** is not the last item in the tree.
  24551. */
  24552. static TreeView *sqlite3TreeViewPush(TreeView *p, u8 moreToFollow){
  24553. if( p==0 ){
  24554. p = sqlite3_malloc64( sizeof(*p) );
  24555. if( p==0 ) return 0;
  24556. memset(p, 0, sizeof(*p));
  24557. }else{
  24558. p->iLevel++;
  24559. }
  24560. assert( moreToFollow==0 || moreToFollow==1 );
  24561. if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow;
  24562. return p;
  24563. }
  24564. /*
  24565. ** Finished with one layer of the tree
  24566. */
  24567. static void sqlite3TreeViewPop(TreeView *p){
  24568. if( p==0 ) return;
  24569. p->iLevel--;
  24570. if( p->iLevel<0 ) sqlite3_free(p);
  24571. }
  24572. /*
  24573. ** Generate a single line of output for the tree, with a prefix that contains
  24574. ** all the appropriate tree lines
  24575. */
  24576. static void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){
  24577. va_list ap;
  24578. int i;
  24579. StrAccum acc;
  24580. char zBuf[500];
  24581. sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
  24582. if( p ){
  24583. for(i=0; i<p->iLevel && i<sizeof(p->bLine)-1; i++){
  24584. sqlite3StrAccumAppend(&acc, p->bLine[i] ? "| " : " ", 4);
  24585. }
  24586. sqlite3StrAccumAppend(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
  24587. }
  24588. va_start(ap, zFormat);
  24589. sqlite3VXPrintf(&acc, zFormat, ap);
  24590. va_end(ap);
  24591. if( zBuf[acc.nChar-1]!='\n' ) sqlite3StrAccumAppend(&acc, "\n", 1);
  24592. sqlite3StrAccumFinish(&acc);
  24593. fprintf(stdout,"%s", zBuf);
  24594. fflush(stdout);
  24595. }
  24596. /*
  24597. ** Shorthand for starting a new tree item that consists of a single label
  24598. */
  24599. static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
  24600. p = sqlite3TreeViewPush(p, moreFollows);
  24601. sqlite3TreeViewLine(p, "%s", zLabel);
  24602. }
  24603. /*
  24604. ** Generate a human-readable description of a WITH clause.
  24605. */
  24606. SQLITE_PRIVATE void sqlite3TreeViewWith(TreeView *pView, const With *pWith, u8 moreToFollow){
  24607. int i;
  24608. if( pWith==0 ) return;
  24609. if( pWith->nCte==0 ) return;
  24610. if( pWith->pOuter ){
  24611. sqlite3TreeViewLine(pView, "WITH (0x%p, pOuter=0x%p)",pWith,pWith->pOuter);
  24612. }else{
  24613. sqlite3TreeViewLine(pView, "WITH (0x%p)", pWith);
  24614. }
  24615. if( pWith->nCte>0 ){
  24616. pView = sqlite3TreeViewPush(pView, 1);
  24617. for(i=0; i<pWith->nCte; i++){
  24618. StrAccum x;
  24619. char zLine[1000];
  24620. const struct Cte *pCte = &pWith->a[i];
  24621. sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
  24622. sqlite3XPrintf(&x, "%s", pCte->zName);
  24623. if( pCte->pCols && pCte->pCols->nExpr>0 ){
  24624. char cSep = '(';
  24625. int j;
  24626. for(j=0; j<pCte->pCols->nExpr; j++){
  24627. sqlite3XPrintf(&x, "%c%s", cSep, pCte->pCols->a[j].zName);
  24628. cSep = ',';
  24629. }
  24630. sqlite3XPrintf(&x, ")");
  24631. }
  24632. sqlite3XPrintf(&x, " AS");
  24633. sqlite3StrAccumFinish(&x);
  24634. sqlite3TreeViewItem(pView, zLine, i<pWith->nCte-1);
  24635. sqlite3TreeViewSelect(pView, pCte->pSelect, 0);
  24636. sqlite3TreeViewPop(pView);
  24637. }
  24638. sqlite3TreeViewPop(pView);
  24639. }
  24640. }
  24641. /*
  24642. ** Generate a human-readable description of a Select object.
  24643. */
  24644. SQLITE_PRIVATE void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
  24645. int n = 0;
  24646. int cnt = 0;
  24647. pView = sqlite3TreeViewPush(pView, moreToFollow);
  24648. if( p->pWith ){
  24649. sqlite3TreeViewWith(pView, p->pWith, 1);
  24650. cnt = 1;
  24651. sqlite3TreeViewPush(pView, 1);
  24652. }
  24653. do{
  24654. sqlite3TreeViewLine(pView, "SELECT%s%s (0x%p) selFlags=0x%x nSelectRow=%d",
  24655. ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
  24656. ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""), p, p->selFlags,
  24657. (int)p->nSelectRow
  24658. );
  24659. if( cnt++ ) sqlite3TreeViewPop(pView);
  24660. if( p->pPrior ){
  24661. n = 1000;
  24662. }else{
  24663. n = 0;
  24664. if( p->pSrc && p->pSrc->nSrc ) n++;
  24665. if( p->pWhere ) n++;
  24666. if( p->pGroupBy ) n++;
  24667. if( p->pHaving ) n++;
  24668. if( p->pOrderBy ) n++;
  24669. if( p->pLimit ) n++;
  24670. if( p->pOffset ) n++;
  24671. }
  24672. sqlite3TreeViewExprList(pView, p->pEList, (n--)>0, "result-set");
  24673. if( p->pSrc && p->pSrc->nSrc ){
  24674. int i;
  24675. pView = sqlite3TreeViewPush(pView, (n--)>0);
  24676. sqlite3TreeViewLine(pView, "FROM");
  24677. for(i=0; i<p->pSrc->nSrc; i++){
  24678. struct SrcList_item *pItem = &p->pSrc->a[i];
  24679. StrAccum x;
  24680. char zLine[100];
  24681. sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
  24682. sqlite3XPrintf(&x, "{%d,*}", pItem->iCursor);
  24683. if( pItem->zDatabase ){
  24684. sqlite3XPrintf(&x, " %s.%s", pItem->zDatabase, pItem->zName);
  24685. }else if( pItem->zName ){
  24686. sqlite3XPrintf(&x, " %s", pItem->zName);
  24687. }
  24688. if( pItem->pTab ){
  24689. sqlite3XPrintf(&x, " tabname=%Q", pItem->pTab->zName);
  24690. }
  24691. if( pItem->zAlias ){
  24692. sqlite3XPrintf(&x, " (AS %s)", pItem->zAlias);
  24693. }
  24694. if( pItem->fg.jointype & JT_LEFT ){
  24695. sqlite3XPrintf(&x, " LEFT-JOIN");
  24696. }
  24697. sqlite3StrAccumFinish(&x);
  24698. sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1);
  24699. if( pItem->pSelect ){
  24700. sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
  24701. }
  24702. if( pItem->fg.isTabFunc ){
  24703. sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
  24704. }
  24705. sqlite3TreeViewPop(pView);
  24706. }
  24707. sqlite3TreeViewPop(pView);
  24708. }
  24709. if( p->pWhere ){
  24710. sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
  24711. sqlite3TreeViewExpr(pView, p->pWhere, 0);
  24712. sqlite3TreeViewPop(pView);
  24713. }
  24714. if( p->pGroupBy ){
  24715. sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
  24716. }
  24717. if( p->pHaving ){
  24718. sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
  24719. sqlite3TreeViewExpr(pView, p->pHaving, 0);
  24720. sqlite3TreeViewPop(pView);
  24721. }
  24722. if( p->pOrderBy ){
  24723. sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
  24724. }
  24725. if( p->pLimit ){
  24726. sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
  24727. sqlite3TreeViewExpr(pView, p->pLimit, 0);
  24728. sqlite3TreeViewPop(pView);
  24729. }
  24730. if( p->pOffset ){
  24731. sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
  24732. sqlite3TreeViewExpr(pView, p->pOffset, 0);
  24733. sqlite3TreeViewPop(pView);
  24734. }
  24735. if( p->pPrior ){
  24736. const char *zOp = "UNION";
  24737. switch( p->op ){
  24738. case TK_ALL: zOp = "UNION ALL"; break;
  24739. case TK_INTERSECT: zOp = "INTERSECT"; break;
  24740. case TK_EXCEPT: zOp = "EXCEPT"; break;
  24741. }
  24742. sqlite3TreeViewItem(pView, zOp, 1);
  24743. }
  24744. p = p->pPrior;
  24745. }while( p!=0 );
  24746. sqlite3TreeViewPop(pView);
  24747. }
  24748. /*
  24749. ** Generate a human-readable explanation of an expression tree.
  24750. */
  24751. SQLITE_PRIVATE void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
  24752. const char *zBinOp = 0; /* Binary operator */
  24753. const char *zUniOp = 0; /* Unary operator */
  24754. char zFlgs[30];
  24755. pView = sqlite3TreeViewPush(pView, moreToFollow);
  24756. if( pExpr==0 ){
  24757. sqlite3TreeViewLine(pView, "nil");
  24758. sqlite3TreeViewPop(pView);
  24759. return;
  24760. }
  24761. if( pExpr->flags ){
  24762. sqlite3_snprintf(sizeof(zFlgs),zFlgs," flags=0x%x",pExpr->flags);
  24763. }else{
  24764. zFlgs[0] = 0;
  24765. }
  24766. switch( pExpr->op ){
  24767. case TK_AGG_COLUMN: {
  24768. sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
  24769. pExpr->iTable, pExpr->iColumn, zFlgs);
  24770. break;
  24771. }
  24772. case TK_COLUMN: {
  24773. if( pExpr->iTable<0 ){
  24774. /* This only happens when coding check constraints */
  24775. sqlite3TreeViewLine(pView, "COLUMN(%d)%s", pExpr->iColumn, zFlgs);
  24776. }else{
  24777. sqlite3TreeViewLine(pView, "{%d:%d}%s",
  24778. pExpr->iTable, pExpr->iColumn, zFlgs);
  24779. }
  24780. break;
  24781. }
  24782. case TK_INTEGER: {
  24783. if( pExpr->flags & EP_IntValue ){
  24784. sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
  24785. }else{
  24786. sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
  24787. }
  24788. break;
  24789. }
  24790. #ifndef SQLITE_OMIT_FLOATING_POINT
  24791. case TK_FLOAT: {
  24792. sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
  24793. break;
  24794. }
  24795. #endif
  24796. case TK_STRING: {
  24797. sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
  24798. break;
  24799. }
  24800. case TK_NULL: {
  24801. sqlite3TreeViewLine(pView,"NULL");
  24802. break;
  24803. }
  24804. #ifndef SQLITE_OMIT_BLOB_LITERAL
  24805. case TK_BLOB: {
  24806. sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
  24807. break;
  24808. }
  24809. #endif
  24810. case TK_VARIABLE: {
  24811. sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
  24812. pExpr->u.zToken, pExpr->iColumn);
  24813. break;
  24814. }
  24815. case TK_REGISTER: {
  24816. sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
  24817. break;
  24818. }
  24819. case TK_ID: {
  24820. sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
  24821. break;
  24822. }
  24823. #ifndef SQLITE_OMIT_CAST
  24824. case TK_CAST: {
  24825. /* Expressions of the form: CAST(pLeft AS token) */
  24826. sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
  24827. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  24828. break;
  24829. }
  24830. #endif /* SQLITE_OMIT_CAST */
  24831. case TK_LT: zBinOp = "LT"; break;
  24832. case TK_LE: zBinOp = "LE"; break;
  24833. case TK_GT: zBinOp = "GT"; break;
  24834. case TK_GE: zBinOp = "GE"; break;
  24835. case TK_NE: zBinOp = "NE"; break;
  24836. case TK_EQ: zBinOp = "EQ"; break;
  24837. case TK_IS: zBinOp = "IS"; break;
  24838. case TK_ISNOT: zBinOp = "ISNOT"; break;
  24839. case TK_AND: zBinOp = "AND"; break;
  24840. case TK_OR: zBinOp = "OR"; break;
  24841. case TK_PLUS: zBinOp = "ADD"; break;
  24842. case TK_STAR: zBinOp = "MUL"; break;
  24843. case TK_MINUS: zBinOp = "SUB"; break;
  24844. case TK_REM: zBinOp = "REM"; break;
  24845. case TK_BITAND: zBinOp = "BITAND"; break;
  24846. case TK_BITOR: zBinOp = "BITOR"; break;
  24847. case TK_SLASH: zBinOp = "DIV"; break;
  24848. case TK_LSHIFT: zBinOp = "LSHIFT"; break;
  24849. case TK_RSHIFT: zBinOp = "RSHIFT"; break;
  24850. case TK_CONCAT: zBinOp = "CONCAT"; break;
  24851. case TK_DOT: zBinOp = "DOT"; break;
  24852. case TK_UMINUS: zUniOp = "UMINUS"; break;
  24853. case TK_UPLUS: zUniOp = "UPLUS"; break;
  24854. case TK_BITNOT: zUniOp = "BITNOT"; break;
  24855. case TK_NOT: zUniOp = "NOT"; break;
  24856. case TK_ISNULL: zUniOp = "ISNULL"; break;
  24857. case TK_NOTNULL: zUniOp = "NOTNULL"; break;
  24858. case TK_SPAN: {
  24859. sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
  24860. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  24861. break;
  24862. }
  24863. case TK_COLLATE: {
  24864. sqlite3TreeViewLine(pView, "COLLATE %Q", pExpr->u.zToken);
  24865. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  24866. break;
  24867. }
  24868. case TK_AGG_FUNCTION:
  24869. case TK_FUNCTION: {
  24870. ExprList *pFarg; /* List of function arguments */
  24871. if( ExprHasProperty(pExpr, EP_TokenOnly) ){
  24872. pFarg = 0;
  24873. }else{
  24874. pFarg = pExpr->x.pList;
  24875. }
  24876. if( pExpr->op==TK_AGG_FUNCTION ){
  24877. sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q",
  24878. pExpr->op2, pExpr->u.zToken);
  24879. }else{
  24880. sqlite3TreeViewLine(pView, "FUNCTION %Q", pExpr->u.zToken);
  24881. }
  24882. if( pFarg ){
  24883. sqlite3TreeViewExprList(pView, pFarg, 0, 0);
  24884. }
  24885. break;
  24886. }
  24887. #ifndef SQLITE_OMIT_SUBQUERY
  24888. case TK_EXISTS: {
  24889. sqlite3TreeViewLine(pView, "EXISTS-expr");
  24890. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  24891. break;
  24892. }
  24893. case TK_SELECT: {
  24894. sqlite3TreeViewLine(pView, "SELECT-expr");
  24895. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  24896. break;
  24897. }
  24898. case TK_IN: {
  24899. sqlite3TreeViewLine(pView, "IN");
  24900. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  24901. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  24902. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  24903. }else{
  24904. sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
  24905. }
  24906. break;
  24907. }
  24908. #endif /* SQLITE_OMIT_SUBQUERY */
  24909. /*
  24910. ** x BETWEEN y AND z
  24911. **
  24912. ** This is equivalent to
  24913. **
  24914. ** x>=y AND x<=z
  24915. **
  24916. ** X is stored in pExpr->pLeft.
  24917. ** Y is stored in pExpr->pList->a[0].pExpr.
  24918. ** Z is stored in pExpr->pList->a[1].pExpr.
  24919. */
  24920. case TK_BETWEEN: {
  24921. Expr *pX = pExpr->pLeft;
  24922. Expr *pY = pExpr->x.pList->a[0].pExpr;
  24923. Expr *pZ = pExpr->x.pList->a[1].pExpr;
  24924. sqlite3TreeViewLine(pView, "BETWEEN");
  24925. sqlite3TreeViewExpr(pView, pX, 1);
  24926. sqlite3TreeViewExpr(pView, pY, 1);
  24927. sqlite3TreeViewExpr(pView, pZ, 0);
  24928. break;
  24929. }
  24930. case TK_TRIGGER: {
  24931. /* If the opcode is TK_TRIGGER, then the expression is a reference
  24932. ** to a column in the new.* or old.* pseudo-tables available to
  24933. ** trigger programs. In this case Expr.iTable is set to 1 for the
  24934. ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
  24935. ** is set to the column of the pseudo-table to read, or to -1 to
  24936. ** read the rowid field.
  24937. */
  24938. sqlite3TreeViewLine(pView, "%s(%d)",
  24939. pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
  24940. break;
  24941. }
  24942. case TK_CASE: {
  24943. sqlite3TreeViewLine(pView, "CASE");
  24944. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  24945. sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
  24946. break;
  24947. }
  24948. #ifndef SQLITE_OMIT_TRIGGER
  24949. case TK_RAISE: {
  24950. const char *zType = "unk";
  24951. switch( pExpr->affinity ){
  24952. case OE_Rollback: zType = "rollback"; break;
  24953. case OE_Abort: zType = "abort"; break;
  24954. case OE_Fail: zType = "fail"; break;
  24955. case OE_Ignore: zType = "ignore"; break;
  24956. }
  24957. sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
  24958. break;
  24959. }
  24960. #endif
  24961. case TK_MATCH: {
  24962. sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
  24963. pExpr->iTable, pExpr->iColumn, zFlgs);
  24964. sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
  24965. break;
  24966. }
  24967. case TK_VECTOR: {
  24968. sqlite3TreeViewBareExprList(pView, pExpr->x.pList, "VECTOR");
  24969. break;
  24970. }
  24971. case TK_SELECT_COLUMN: {
  24972. sqlite3TreeViewLine(pView, "SELECT-COLUMN %d", pExpr->iColumn);
  24973. sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
  24974. break;
  24975. }
  24976. default: {
  24977. sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
  24978. break;
  24979. }
  24980. }
  24981. if( zBinOp ){
  24982. sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
  24983. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  24984. sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
  24985. }else if( zUniOp ){
  24986. sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
  24987. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  24988. }
  24989. sqlite3TreeViewPop(pView);
  24990. }
  24991. /*
  24992. ** Generate a human-readable explanation of an expression list.
  24993. */
  24994. SQLITE_PRIVATE void sqlite3TreeViewBareExprList(
  24995. TreeView *pView,
  24996. const ExprList *pList,
  24997. const char *zLabel
  24998. ){
  24999. if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
  25000. if( pList==0 ){
  25001. sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
  25002. }else{
  25003. int i;
  25004. sqlite3TreeViewLine(pView, "%s", zLabel);
  25005. for(i=0; i<pList->nExpr; i++){
  25006. int j = pList->a[i].u.x.iOrderByCol;
  25007. if( j ){
  25008. sqlite3TreeViewPush(pView, 0);
  25009. sqlite3TreeViewLine(pView, "iOrderByCol=%d", j);
  25010. }
  25011. sqlite3TreeViewExpr(pView, pList->a[i].pExpr, i<pList->nExpr-1);
  25012. if( j ) sqlite3TreeViewPop(pView);
  25013. }
  25014. }
  25015. }
  25016. SQLITE_PRIVATE void sqlite3TreeViewExprList(
  25017. TreeView *pView,
  25018. const ExprList *pList,
  25019. u8 moreToFollow,
  25020. const char *zLabel
  25021. ){
  25022. pView = sqlite3TreeViewPush(pView, moreToFollow);
  25023. sqlite3TreeViewBareExprList(pView, pList, zLabel);
  25024. sqlite3TreeViewPop(pView);
  25025. }
  25026. #endif /* SQLITE_DEBUG */
  25027. /************** End of treeview.c ********************************************/
  25028. /************** Begin file random.c ******************************************/
  25029. /*
  25030. ** 2001 September 15
  25031. **
  25032. ** The author disclaims copyright to this source code. In place of
  25033. ** a legal notice, here is a blessing:
  25034. **
  25035. ** May you do good and not evil.
  25036. ** May you find forgiveness for yourself and forgive others.
  25037. ** May you share freely, never taking more than you give.
  25038. **
  25039. *************************************************************************
  25040. ** This file contains code to implement a pseudo-random number
  25041. ** generator (PRNG) for SQLite.
  25042. **
  25043. ** Random numbers are used by some of the database backends in order
  25044. ** to generate random integer keys for tables or random filenames.
  25045. */
  25046. /* #include "sqliteInt.h" */
  25047. /* All threads share a single random number generator.
  25048. ** This structure is the current state of the generator.
  25049. */
  25050. static SQLITE_WSD struct sqlite3PrngType {
  25051. unsigned char isInit; /* True if initialized */
  25052. unsigned char i, j; /* State variables */
  25053. unsigned char s[256]; /* State variables */
  25054. } sqlite3Prng;
  25055. /*
  25056. ** Return N random bytes.
  25057. */
  25058. SQLITE_API void sqlite3_randomness(int N, void *pBuf){
  25059. unsigned char t;
  25060. unsigned char *zBuf = pBuf;
  25061. /* The "wsdPrng" macro will resolve to the pseudo-random number generator
  25062. ** state vector. If writable static data is unsupported on the target,
  25063. ** we have to locate the state vector at run-time. In the more common
  25064. ** case where writable static data is supported, wsdPrng can refer directly
  25065. ** to the "sqlite3Prng" state vector declared above.
  25066. */
  25067. #ifdef SQLITE_OMIT_WSD
  25068. struct sqlite3PrngType *p = &GLOBAL(struct sqlite3PrngType, sqlite3Prng);
  25069. # define wsdPrng p[0]
  25070. #else
  25071. # define wsdPrng sqlite3Prng
  25072. #endif
  25073. #if SQLITE_THREADSAFE
  25074. sqlite3_mutex *mutex;
  25075. #endif
  25076. #ifndef SQLITE_OMIT_AUTOINIT
  25077. if( sqlite3_initialize() ) return;
  25078. #endif
  25079. #if SQLITE_THREADSAFE
  25080. mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_PRNG);
  25081. #endif
  25082. sqlite3_mutex_enter(mutex);
  25083. if( N<=0 || pBuf==0 ){
  25084. wsdPrng.isInit = 0;
  25085. sqlite3_mutex_leave(mutex);
  25086. return;
  25087. }
  25088. /* Initialize the state of the random number generator once,
  25089. ** the first time this routine is called. The seed value does
  25090. ** not need to contain a lot of randomness since we are not
  25091. ** trying to do secure encryption or anything like that...
  25092. **
  25093. ** Nothing in this file or anywhere else in SQLite does any kind of
  25094. ** encryption. The RC4 algorithm is being used as a PRNG (pseudo-random
  25095. ** number generator) not as an encryption device.
  25096. */
  25097. if( !wsdPrng.isInit ){
  25098. int i;
  25099. char k[256];
  25100. wsdPrng.j = 0;
  25101. wsdPrng.i = 0;
  25102. sqlite3OsRandomness(sqlite3_vfs_find(0), 256, k);
  25103. for(i=0; i<256; i++){
  25104. wsdPrng.s[i] = (u8)i;
  25105. }
  25106. for(i=0; i<256; i++){
  25107. wsdPrng.j += wsdPrng.s[i] + k[i];
  25108. t = wsdPrng.s[wsdPrng.j];
  25109. wsdPrng.s[wsdPrng.j] = wsdPrng.s[i];
  25110. wsdPrng.s[i] = t;
  25111. }
  25112. wsdPrng.isInit = 1;
  25113. }
  25114. assert( N>0 );
  25115. do{
  25116. wsdPrng.i++;
  25117. t = wsdPrng.s[wsdPrng.i];
  25118. wsdPrng.j += t;
  25119. wsdPrng.s[wsdPrng.i] = wsdPrng.s[wsdPrng.j];
  25120. wsdPrng.s[wsdPrng.j] = t;
  25121. t += wsdPrng.s[wsdPrng.i];
  25122. *(zBuf++) = wsdPrng.s[t];
  25123. }while( --N );
  25124. sqlite3_mutex_leave(mutex);
  25125. }
  25126. #ifndef SQLITE_OMIT_BUILTIN_TEST
  25127. /*
  25128. ** For testing purposes, we sometimes want to preserve the state of
  25129. ** PRNG and restore the PRNG to its saved state at a later time, or
  25130. ** to reset the PRNG to its initial state. These routines accomplish
  25131. ** those tasks.
  25132. **
  25133. ** The sqlite3_test_control() interface calls these routines to
  25134. ** control the PRNG.
  25135. */
  25136. static SQLITE_WSD struct sqlite3PrngType sqlite3SavedPrng;
  25137. SQLITE_PRIVATE void sqlite3PrngSaveState(void){
  25138. memcpy(
  25139. &GLOBAL(struct sqlite3PrngType, sqlite3SavedPrng),
  25140. &GLOBAL(struct sqlite3PrngType, sqlite3Prng),
  25141. sizeof(sqlite3Prng)
  25142. );
  25143. }
  25144. SQLITE_PRIVATE void sqlite3PrngRestoreState(void){
  25145. memcpy(
  25146. &GLOBAL(struct sqlite3PrngType, sqlite3Prng),
  25147. &GLOBAL(struct sqlite3PrngType, sqlite3SavedPrng),
  25148. sizeof(sqlite3Prng)
  25149. );
  25150. }
  25151. #endif /* SQLITE_OMIT_BUILTIN_TEST */
  25152. /************** End of random.c **********************************************/
  25153. /************** Begin file threads.c *****************************************/
  25154. /*
  25155. ** 2012 July 21
  25156. **
  25157. ** The author disclaims copyright to this source code. In place of
  25158. ** a legal notice, here is a blessing:
  25159. **
  25160. ** May you do good and not evil.
  25161. ** May you find forgiveness for yourself and forgive others.
  25162. ** May you share freely, never taking more than you give.
  25163. **
  25164. ******************************************************************************
  25165. **
  25166. ** This file presents a simple cross-platform threading interface for
  25167. ** use internally by SQLite.
  25168. **
  25169. ** A "thread" can be created using sqlite3ThreadCreate(). This thread
  25170. ** runs independently of its creator until it is joined using
  25171. ** sqlite3ThreadJoin(), at which point it terminates.
  25172. **
  25173. ** Threads do not have to be real. It could be that the work of the
  25174. ** "thread" is done by the main thread at either the sqlite3ThreadCreate()
  25175. ** or sqlite3ThreadJoin() call. This is, in fact, what happens in
  25176. ** single threaded systems. Nothing in SQLite requires multiple threads.
  25177. ** This interface exists so that applications that want to take advantage
  25178. ** of multiple cores can do so, while also allowing applications to stay
  25179. ** single-threaded if desired.
  25180. */
  25181. /* #include "sqliteInt.h" */
  25182. #if SQLITE_OS_WIN
  25183. /* # include "os_win.h" */
  25184. #endif
  25185. #if SQLITE_MAX_WORKER_THREADS>0
  25186. /********************************* Unix Pthreads ****************************/
  25187. #if SQLITE_OS_UNIX && defined(SQLITE_MUTEX_PTHREADS) && SQLITE_THREADSAFE>0
  25188. #define SQLITE_THREADS_IMPLEMENTED 1 /* Prevent the single-thread code below */
  25189. /* #include <pthread.h> */
  25190. /* A running thread */
  25191. struct SQLiteThread {
  25192. pthread_t tid; /* Thread ID */
  25193. int done; /* Set to true when thread finishes */
  25194. void *pOut; /* Result returned by the thread */
  25195. void *(*xTask)(void*); /* The thread routine */
  25196. void *pIn; /* Argument to the thread */
  25197. };
  25198. /* Create a new thread */
  25199. SQLITE_PRIVATE int sqlite3ThreadCreate(
  25200. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  25201. void *(*xTask)(void*), /* Routine to run in a separate thread */
  25202. void *pIn /* Argument passed into xTask() */
  25203. ){
  25204. SQLiteThread *p;
  25205. int rc;
  25206. assert( ppThread!=0 );
  25207. assert( xTask!=0 );
  25208. /* This routine is never used in single-threaded mode */
  25209. assert( sqlite3GlobalConfig.bCoreMutex!=0 );
  25210. *ppThread = 0;
  25211. p = sqlite3Malloc(sizeof(*p));
  25212. if( p==0 ) return SQLITE_NOMEM_BKPT;
  25213. memset(p, 0, sizeof(*p));
  25214. p->xTask = xTask;
  25215. p->pIn = pIn;
  25216. /* If the SQLITE_TESTCTRL_FAULT_INSTALL callback is registered to a
  25217. ** function that returns SQLITE_ERROR when passed the argument 200, that
  25218. ** forces worker threads to run sequentially and deterministically
  25219. ** for testing purposes. */
  25220. if( sqlite3FaultSim(200) ){
  25221. rc = 1;
  25222. }else{
  25223. rc = pthread_create(&p->tid, 0, xTask, pIn);
  25224. }
  25225. if( rc ){
  25226. p->done = 1;
  25227. p->pOut = xTask(pIn);
  25228. }
  25229. *ppThread = p;
  25230. return SQLITE_OK;
  25231. }
  25232. /* Get the results of the thread */
  25233. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  25234. int rc;
  25235. assert( ppOut!=0 );
  25236. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  25237. if( p->done ){
  25238. *ppOut = p->pOut;
  25239. rc = SQLITE_OK;
  25240. }else{
  25241. rc = pthread_join(p->tid, ppOut) ? SQLITE_ERROR : SQLITE_OK;
  25242. }
  25243. sqlite3_free(p);
  25244. return rc;
  25245. }
  25246. #endif /* SQLITE_OS_UNIX && defined(SQLITE_MUTEX_PTHREADS) */
  25247. /******************************** End Unix Pthreads *************************/
  25248. /********************************* Win32 Threads ****************************/
  25249. #if SQLITE_OS_WIN_THREADS
  25250. #define SQLITE_THREADS_IMPLEMENTED 1 /* Prevent the single-thread code below */
  25251. #include <process.h>
  25252. /* A running thread */
  25253. struct SQLiteThread {
  25254. void *tid; /* The thread handle */
  25255. unsigned id; /* The thread identifier */
  25256. void *(*xTask)(void*); /* The routine to run as a thread */
  25257. void *pIn; /* Argument to xTask */
  25258. void *pResult; /* Result of xTask */
  25259. };
  25260. /* Thread procedure Win32 compatibility shim */
  25261. static unsigned __stdcall sqlite3ThreadProc(
  25262. void *pArg /* IN: Pointer to the SQLiteThread structure */
  25263. ){
  25264. SQLiteThread *p = (SQLiteThread *)pArg;
  25265. assert( p!=0 );
  25266. #if 0
  25267. /*
  25268. ** This assert appears to trigger spuriously on certain
  25269. ** versions of Windows, possibly due to _beginthreadex()
  25270. ** and/or CreateThread() not fully setting their thread
  25271. ** ID parameter before starting the thread.
  25272. */
  25273. assert( p->id==GetCurrentThreadId() );
  25274. #endif
  25275. assert( p->xTask!=0 );
  25276. p->pResult = p->xTask(p->pIn);
  25277. _endthreadex(0);
  25278. return 0; /* NOT REACHED */
  25279. }
  25280. /* Create a new thread */
  25281. SQLITE_PRIVATE int sqlite3ThreadCreate(
  25282. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  25283. void *(*xTask)(void*), /* Routine to run in a separate thread */
  25284. void *pIn /* Argument passed into xTask() */
  25285. ){
  25286. SQLiteThread *p;
  25287. assert( ppThread!=0 );
  25288. assert( xTask!=0 );
  25289. *ppThread = 0;
  25290. p = sqlite3Malloc(sizeof(*p));
  25291. if( p==0 ) return SQLITE_NOMEM_BKPT;
  25292. /* If the SQLITE_TESTCTRL_FAULT_INSTALL callback is registered to a
  25293. ** function that returns SQLITE_ERROR when passed the argument 200, that
  25294. ** forces worker threads to run sequentially and deterministically
  25295. ** (via the sqlite3FaultSim() term of the conditional) for testing
  25296. ** purposes. */
  25297. if( sqlite3GlobalConfig.bCoreMutex==0 || sqlite3FaultSim(200) ){
  25298. memset(p, 0, sizeof(*p));
  25299. }else{
  25300. p->xTask = xTask;
  25301. p->pIn = pIn;
  25302. p->tid = (void*)_beginthreadex(0, 0, sqlite3ThreadProc, p, 0, &p->id);
  25303. if( p->tid==0 ){
  25304. memset(p, 0, sizeof(*p));
  25305. }
  25306. }
  25307. if( p->xTask==0 ){
  25308. p->id = GetCurrentThreadId();
  25309. p->pResult = xTask(pIn);
  25310. }
  25311. *ppThread = p;
  25312. return SQLITE_OK;
  25313. }
  25314. SQLITE_PRIVATE DWORD sqlite3Win32Wait(HANDLE hObject); /* os_win.c */
  25315. /* Get the results of the thread */
  25316. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  25317. DWORD rc;
  25318. BOOL bRc;
  25319. assert( ppOut!=0 );
  25320. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  25321. if( p->xTask==0 ){
  25322. /* assert( p->id==GetCurrentThreadId() ); */
  25323. rc = WAIT_OBJECT_0;
  25324. assert( p->tid==0 );
  25325. }else{
  25326. assert( p->id!=0 && p->id!=GetCurrentThreadId() );
  25327. rc = sqlite3Win32Wait((HANDLE)p->tid);
  25328. assert( rc!=WAIT_IO_COMPLETION );
  25329. bRc = CloseHandle((HANDLE)p->tid);
  25330. assert( bRc );
  25331. }
  25332. if( rc==WAIT_OBJECT_0 ) *ppOut = p->pResult;
  25333. sqlite3_free(p);
  25334. return (rc==WAIT_OBJECT_0) ? SQLITE_OK : SQLITE_ERROR;
  25335. }
  25336. #endif /* SQLITE_OS_WIN_THREADS */
  25337. /******************************** End Win32 Threads *************************/
  25338. /********************************* Single-Threaded **************************/
  25339. #ifndef SQLITE_THREADS_IMPLEMENTED
  25340. /*
  25341. ** This implementation does not actually create a new thread. It does the
  25342. ** work of the thread in the main thread, when either the thread is created
  25343. ** or when it is joined
  25344. */
  25345. /* A running thread */
  25346. struct SQLiteThread {
  25347. void *(*xTask)(void*); /* The routine to run as a thread */
  25348. void *pIn; /* Argument to xTask */
  25349. void *pResult; /* Result of xTask */
  25350. };
  25351. /* Create a new thread */
  25352. SQLITE_PRIVATE int sqlite3ThreadCreate(
  25353. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  25354. void *(*xTask)(void*), /* Routine to run in a separate thread */
  25355. void *pIn /* Argument passed into xTask() */
  25356. ){
  25357. SQLiteThread *p;
  25358. assert( ppThread!=0 );
  25359. assert( xTask!=0 );
  25360. *ppThread = 0;
  25361. p = sqlite3Malloc(sizeof(*p));
  25362. if( p==0 ) return SQLITE_NOMEM_BKPT;
  25363. if( (SQLITE_PTR_TO_INT(p)/17)&1 ){
  25364. p->xTask = xTask;
  25365. p->pIn = pIn;
  25366. }else{
  25367. p->xTask = 0;
  25368. p->pResult = xTask(pIn);
  25369. }
  25370. *ppThread = p;
  25371. return SQLITE_OK;
  25372. }
  25373. /* Get the results of the thread */
  25374. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  25375. assert( ppOut!=0 );
  25376. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  25377. if( p->xTask ){
  25378. *ppOut = p->xTask(p->pIn);
  25379. }else{
  25380. *ppOut = p->pResult;
  25381. }
  25382. sqlite3_free(p);
  25383. #if defined(SQLITE_TEST)
  25384. {
  25385. void *pTstAlloc = sqlite3Malloc(10);
  25386. if (!pTstAlloc) return SQLITE_NOMEM_BKPT;
  25387. sqlite3_free(pTstAlloc);
  25388. }
  25389. #endif
  25390. return SQLITE_OK;
  25391. }
  25392. #endif /* !defined(SQLITE_THREADS_IMPLEMENTED) */
  25393. /****************************** End Single-Threaded *************************/
  25394. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  25395. /************** End of threads.c *********************************************/
  25396. /************** Begin file utf.c *********************************************/
  25397. /*
  25398. ** 2004 April 13
  25399. **
  25400. ** The author disclaims copyright to this source code. In place of
  25401. ** a legal notice, here is a blessing:
  25402. **
  25403. ** May you do good and not evil.
  25404. ** May you find forgiveness for yourself and forgive others.
  25405. ** May you share freely, never taking more than you give.
  25406. **
  25407. *************************************************************************
  25408. ** This file contains routines used to translate between UTF-8,
  25409. ** UTF-16, UTF-16BE, and UTF-16LE.
  25410. **
  25411. ** Notes on UTF-8:
  25412. **
  25413. ** Byte-0 Byte-1 Byte-2 Byte-3 Value
  25414. ** 0xxxxxxx 00000000 00000000 0xxxxxxx
  25415. ** 110yyyyy 10xxxxxx 00000000 00000yyy yyxxxxxx
  25416. ** 1110zzzz 10yyyyyy 10xxxxxx 00000000 zzzzyyyy yyxxxxxx
  25417. ** 11110uuu 10uuzzzz 10yyyyyy 10xxxxxx 000uuuuu zzzzyyyy yyxxxxxx
  25418. **
  25419. **
  25420. ** Notes on UTF-16: (with wwww+1==uuuuu)
  25421. **
  25422. ** Word-0 Word-1 Value
  25423. ** 110110ww wwzzzzyy 110111yy yyxxxxxx 000uuuuu zzzzyyyy yyxxxxxx
  25424. ** zzzzyyyy yyxxxxxx 00000000 zzzzyyyy yyxxxxxx
  25425. **
  25426. **
  25427. ** BOM or Byte Order Mark:
  25428. ** 0xff 0xfe little-endian utf-16 follows
  25429. ** 0xfe 0xff big-endian utf-16 follows
  25430. **
  25431. */
  25432. /* #include "sqliteInt.h" */
  25433. /* #include <assert.h> */
  25434. /* #include "vdbeInt.h" */
  25435. #if !defined(SQLITE_AMALGAMATION) && SQLITE_BYTEORDER==0
  25436. /*
  25437. ** The following constant value is used by the SQLITE_BIGENDIAN and
  25438. ** SQLITE_LITTLEENDIAN macros.
  25439. */
  25440. SQLITE_PRIVATE const int sqlite3one = 1;
  25441. #endif /* SQLITE_AMALGAMATION && SQLITE_BYTEORDER==0 */
  25442. /*
  25443. ** This lookup table is used to help decode the first byte of
  25444. ** a multi-byte UTF8 character.
  25445. */
  25446. static const unsigned char sqlite3Utf8Trans1[] = {
  25447. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  25448. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  25449. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  25450. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  25451. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  25452. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  25453. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  25454. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  25455. };
  25456. #define WRITE_UTF8(zOut, c) { \
  25457. if( c<0x00080 ){ \
  25458. *zOut++ = (u8)(c&0xFF); \
  25459. } \
  25460. else if( c<0x00800 ){ \
  25461. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F); \
  25462. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  25463. } \
  25464. else if( c<0x10000 ){ \
  25465. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F); \
  25466. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  25467. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  25468. }else{ \
  25469. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07); \
  25470. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F); \
  25471. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  25472. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  25473. } \
  25474. }
  25475. #define WRITE_UTF16LE(zOut, c) { \
  25476. if( c<=0xFFFF ){ \
  25477. *zOut++ = (u8)(c&0x00FF); \
  25478. *zOut++ = (u8)((c>>8)&0x00FF); \
  25479. }else{ \
  25480. *zOut++ = (u8)(((c>>10)&0x003F) + (((c-0x10000)>>10)&0x00C0)); \
  25481. *zOut++ = (u8)(0x00D8 + (((c-0x10000)>>18)&0x03)); \
  25482. *zOut++ = (u8)(c&0x00FF); \
  25483. *zOut++ = (u8)(0x00DC + ((c>>8)&0x03)); \
  25484. } \
  25485. }
  25486. #define WRITE_UTF16BE(zOut, c) { \
  25487. if( c<=0xFFFF ){ \
  25488. *zOut++ = (u8)((c>>8)&0x00FF); \
  25489. *zOut++ = (u8)(c&0x00FF); \
  25490. }else{ \
  25491. *zOut++ = (u8)(0x00D8 + (((c-0x10000)>>18)&0x03)); \
  25492. *zOut++ = (u8)(((c>>10)&0x003F) + (((c-0x10000)>>10)&0x00C0)); \
  25493. *zOut++ = (u8)(0x00DC + ((c>>8)&0x03)); \
  25494. *zOut++ = (u8)(c&0x00FF); \
  25495. } \
  25496. }
  25497. #define READ_UTF16LE(zIn, TERM, c){ \
  25498. c = (*zIn++); \
  25499. c += ((*zIn++)<<8); \
  25500. if( c>=0xD800 && c<0xE000 && TERM ){ \
  25501. int c2 = (*zIn++); \
  25502. c2 += ((*zIn++)<<8); \
  25503. c = (c2&0x03FF) + ((c&0x003F)<<10) + (((c&0x03C0)+0x0040)<<10); \
  25504. } \
  25505. }
  25506. #define READ_UTF16BE(zIn, TERM, c){ \
  25507. c = ((*zIn++)<<8); \
  25508. c += (*zIn++); \
  25509. if( c>=0xD800 && c<0xE000 && TERM ){ \
  25510. int c2 = ((*zIn++)<<8); \
  25511. c2 += (*zIn++); \
  25512. c = (c2&0x03FF) + ((c&0x003F)<<10) + (((c&0x03C0)+0x0040)<<10); \
  25513. } \
  25514. }
  25515. /*
  25516. ** Translate a single UTF-8 character. Return the unicode value.
  25517. **
  25518. ** During translation, assume that the byte that zTerm points
  25519. ** is a 0x00.
  25520. **
  25521. ** Write a pointer to the next unread byte back into *pzNext.
  25522. **
  25523. ** Notes On Invalid UTF-8:
  25524. **
  25525. ** * This routine never allows a 7-bit character (0x00 through 0x7f) to
  25526. ** be encoded as a multi-byte character. Any multi-byte character that
  25527. ** attempts to encode a value between 0x00 and 0x7f is rendered as 0xfffd.
  25528. **
  25529. ** * This routine never allows a UTF16 surrogate value to be encoded.
  25530. ** If a multi-byte character attempts to encode a value between
  25531. ** 0xd800 and 0xe000 then it is rendered as 0xfffd.
  25532. **
  25533. ** * Bytes in the range of 0x80 through 0xbf which occur as the first
  25534. ** byte of a character are interpreted as single-byte characters
  25535. ** and rendered as themselves even though they are technically
  25536. ** invalid characters.
  25537. **
  25538. ** * This routine accepts over-length UTF8 encodings
  25539. ** for unicode values 0x80 and greater. It does not change over-length
  25540. ** encodings to 0xfffd as some systems recommend.
  25541. */
  25542. #define READ_UTF8(zIn, zTerm, c) \
  25543. c = *(zIn++); \
  25544. if( c>=0xc0 ){ \
  25545. c = sqlite3Utf8Trans1[c-0xc0]; \
  25546. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  25547. c = (c<<6) + (0x3f & *(zIn++)); \
  25548. } \
  25549. if( c<0x80 \
  25550. || (c&0xFFFFF800)==0xD800 \
  25551. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  25552. }
  25553. SQLITE_PRIVATE u32 sqlite3Utf8Read(
  25554. const unsigned char **pz /* Pointer to string from which to read char */
  25555. ){
  25556. unsigned int c;
  25557. /* Same as READ_UTF8() above but without the zTerm parameter.
  25558. ** For this routine, we assume the UTF8 string is always zero-terminated.
  25559. */
  25560. c = *((*pz)++);
  25561. if( c>=0xc0 ){
  25562. c = sqlite3Utf8Trans1[c-0xc0];
  25563. while( (*(*pz) & 0xc0)==0x80 ){
  25564. c = (c<<6) + (0x3f & *((*pz)++));
  25565. }
  25566. if( c<0x80
  25567. || (c&0xFFFFF800)==0xD800
  25568. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; }
  25569. }
  25570. return c;
  25571. }
  25572. /*
  25573. ** If the TRANSLATE_TRACE macro is defined, the value of each Mem is
  25574. ** printed on stderr on the way into and out of sqlite3VdbeMemTranslate().
  25575. */
  25576. /* #define TRANSLATE_TRACE 1 */
  25577. #ifndef SQLITE_OMIT_UTF16
  25578. /*
  25579. ** This routine transforms the internal text encoding used by pMem to
  25580. ** desiredEnc. It is an error if the string is already of the desired
  25581. ** encoding, or if *pMem does not contain a string value.
  25582. */
  25583. SQLITE_PRIVATE SQLITE_NOINLINE int sqlite3VdbeMemTranslate(Mem *pMem, u8 desiredEnc){
  25584. int len; /* Maximum length of output string in bytes */
  25585. unsigned char *zOut; /* Output buffer */
  25586. unsigned char *zIn; /* Input iterator */
  25587. unsigned char *zTerm; /* End of input */
  25588. unsigned char *z; /* Output iterator */
  25589. unsigned int c;
  25590. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  25591. assert( pMem->flags&MEM_Str );
  25592. assert( pMem->enc!=desiredEnc );
  25593. assert( pMem->enc!=0 );
  25594. assert( pMem->n>=0 );
  25595. #if defined(TRANSLATE_TRACE) && defined(SQLITE_DEBUG)
  25596. {
  25597. char zBuf[100];
  25598. sqlite3VdbeMemPrettyPrint(pMem, zBuf);
  25599. fprintf(stderr, "INPUT: %s\n", zBuf);
  25600. }
  25601. #endif
  25602. /* If the translation is between UTF-16 little and big endian, then
  25603. ** all that is required is to swap the byte order. This case is handled
  25604. ** differently from the others.
  25605. */
  25606. if( pMem->enc!=SQLITE_UTF8 && desiredEnc!=SQLITE_UTF8 ){
  25607. u8 temp;
  25608. int rc;
  25609. rc = sqlite3VdbeMemMakeWriteable(pMem);
  25610. if( rc!=SQLITE_OK ){
  25611. assert( rc==SQLITE_NOMEM );
  25612. return SQLITE_NOMEM_BKPT;
  25613. }
  25614. zIn = (u8*)pMem->z;
  25615. zTerm = &zIn[pMem->n&~1];
  25616. while( zIn<zTerm ){
  25617. temp = *zIn;
  25618. *zIn = *(zIn+1);
  25619. zIn++;
  25620. *zIn++ = temp;
  25621. }
  25622. pMem->enc = desiredEnc;
  25623. goto translate_out;
  25624. }
  25625. /* Set len to the maximum number of bytes required in the output buffer. */
  25626. if( desiredEnc==SQLITE_UTF8 ){
  25627. /* When converting from UTF-16, the maximum growth results from
  25628. ** translating a 2-byte character to a 4-byte UTF-8 character.
  25629. ** A single byte is required for the output string
  25630. ** nul-terminator.
  25631. */
  25632. pMem->n &= ~1;
  25633. len = pMem->n * 2 + 1;
  25634. }else{
  25635. /* When converting from UTF-8 to UTF-16 the maximum growth is caused
  25636. ** when a 1-byte UTF-8 character is translated into a 2-byte UTF-16
  25637. ** character. Two bytes are required in the output buffer for the
  25638. ** nul-terminator.
  25639. */
  25640. len = pMem->n * 2 + 2;
  25641. }
  25642. /* Set zIn to point at the start of the input buffer and zTerm to point 1
  25643. ** byte past the end.
  25644. **
  25645. ** Variable zOut is set to point at the output buffer, space obtained
  25646. ** from sqlite3_malloc().
  25647. */
  25648. zIn = (u8*)pMem->z;
  25649. zTerm = &zIn[pMem->n];
  25650. zOut = sqlite3DbMallocRaw(pMem->db, len);
  25651. if( !zOut ){
  25652. return SQLITE_NOMEM_BKPT;
  25653. }
  25654. z = zOut;
  25655. if( pMem->enc==SQLITE_UTF8 ){
  25656. if( desiredEnc==SQLITE_UTF16LE ){
  25657. /* UTF-8 -> UTF-16 Little-endian */
  25658. while( zIn<zTerm ){
  25659. READ_UTF8(zIn, zTerm, c);
  25660. WRITE_UTF16LE(z, c);
  25661. }
  25662. }else{
  25663. assert( desiredEnc==SQLITE_UTF16BE );
  25664. /* UTF-8 -> UTF-16 Big-endian */
  25665. while( zIn<zTerm ){
  25666. READ_UTF8(zIn, zTerm, c);
  25667. WRITE_UTF16BE(z, c);
  25668. }
  25669. }
  25670. pMem->n = (int)(z - zOut);
  25671. *z++ = 0;
  25672. }else{
  25673. assert( desiredEnc==SQLITE_UTF8 );
  25674. if( pMem->enc==SQLITE_UTF16LE ){
  25675. /* UTF-16 Little-endian -> UTF-8 */
  25676. while( zIn<zTerm ){
  25677. READ_UTF16LE(zIn, zIn<zTerm, c);
  25678. WRITE_UTF8(z, c);
  25679. }
  25680. }else{
  25681. /* UTF-16 Big-endian -> UTF-8 */
  25682. while( zIn<zTerm ){
  25683. READ_UTF16BE(zIn, zIn<zTerm, c);
  25684. WRITE_UTF8(z, c);
  25685. }
  25686. }
  25687. pMem->n = (int)(z - zOut);
  25688. }
  25689. *z = 0;
  25690. assert( (pMem->n+(desiredEnc==SQLITE_UTF8?1:2))<=len );
  25691. c = pMem->flags;
  25692. sqlite3VdbeMemRelease(pMem);
  25693. pMem->flags = MEM_Str|MEM_Term|(c&(MEM_AffMask|MEM_Subtype));
  25694. pMem->enc = desiredEnc;
  25695. pMem->z = (char*)zOut;
  25696. pMem->zMalloc = pMem->z;
  25697. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->z);
  25698. translate_out:
  25699. #if defined(TRANSLATE_TRACE) && defined(SQLITE_DEBUG)
  25700. {
  25701. char zBuf[100];
  25702. sqlite3VdbeMemPrettyPrint(pMem, zBuf);
  25703. fprintf(stderr, "OUTPUT: %s\n", zBuf);
  25704. }
  25705. #endif
  25706. return SQLITE_OK;
  25707. }
  25708. /*
  25709. ** This routine checks for a byte-order mark at the beginning of the
  25710. ** UTF-16 string stored in *pMem. If one is present, it is removed and
  25711. ** the encoding of the Mem adjusted. This routine does not do any
  25712. ** byte-swapping, it just sets Mem.enc appropriately.
  25713. **
  25714. ** The allocation (static, dynamic etc.) and encoding of the Mem may be
  25715. ** changed by this function.
  25716. */
  25717. SQLITE_PRIVATE int sqlite3VdbeMemHandleBom(Mem *pMem){
  25718. int rc = SQLITE_OK;
  25719. u8 bom = 0;
  25720. assert( pMem->n>=0 );
  25721. if( pMem->n>1 ){
  25722. u8 b1 = *(u8 *)pMem->z;
  25723. u8 b2 = *(((u8 *)pMem->z) + 1);
  25724. if( b1==0xFE && b2==0xFF ){
  25725. bom = SQLITE_UTF16BE;
  25726. }
  25727. if( b1==0xFF && b2==0xFE ){
  25728. bom = SQLITE_UTF16LE;
  25729. }
  25730. }
  25731. if( bom ){
  25732. rc = sqlite3VdbeMemMakeWriteable(pMem);
  25733. if( rc==SQLITE_OK ){
  25734. pMem->n -= 2;
  25735. memmove(pMem->z, &pMem->z[2], pMem->n);
  25736. pMem->z[pMem->n] = '\0';
  25737. pMem->z[pMem->n+1] = '\0';
  25738. pMem->flags |= MEM_Term;
  25739. pMem->enc = bom;
  25740. }
  25741. }
  25742. return rc;
  25743. }
  25744. #endif /* SQLITE_OMIT_UTF16 */
  25745. /*
  25746. ** pZ is a UTF-8 encoded unicode string. If nByte is less than zero,
  25747. ** return the number of unicode characters in pZ up to (but not including)
  25748. ** the first 0x00 byte. If nByte is not less than zero, return the
  25749. ** number of unicode characters in the first nByte of pZ (or up to
  25750. ** the first 0x00, whichever comes first).
  25751. */
  25752. SQLITE_PRIVATE int sqlite3Utf8CharLen(const char *zIn, int nByte){
  25753. int r = 0;
  25754. const u8 *z = (const u8*)zIn;
  25755. const u8 *zTerm;
  25756. if( nByte>=0 ){
  25757. zTerm = &z[nByte];
  25758. }else{
  25759. zTerm = (const u8*)(-1);
  25760. }
  25761. assert( z<=zTerm );
  25762. while( *z!=0 && z<zTerm ){
  25763. SQLITE_SKIP_UTF8(z);
  25764. r++;
  25765. }
  25766. return r;
  25767. }
  25768. /* This test function is not currently used by the automated test-suite.
  25769. ** Hence it is only available in debug builds.
  25770. */
  25771. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  25772. /*
  25773. ** Translate UTF-8 to UTF-8.
  25774. **
  25775. ** This has the effect of making sure that the string is well-formed
  25776. ** UTF-8. Miscoded characters are removed.
  25777. **
  25778. ** The translation is done in-place and aborted if the output
  25779. ** overruns the input.
  25780. */
  25781. SQLITE_PRIVATE int sqlite3Utf8To8(unsigned char *zIn){
  25782. unsigned char *zOut = zIn;
  25783. unsigned char *zStart = zIn;
  25784. u32 c;
  25785. while( zIn[0] && zOut<=zIn ){
  25786. c = sqlite3Utf8Read((const u8**)&zIn);
  25787. if( c!=0xfffd ){
  25788. WRITE_UTF8(zOut, c);
  25789. }
  25790. }
  25791. *zOut = 0;
  25792. return (int)(zOut - zStart);
  25793. }
  25794. #endif
  25795. #ifndef SQLITE_OMIT_UTF16
  25796. /*
  25797. ** Convert a UTF-16 string in the native encoding into a UTF-8 string.
  25798. ** Memory to hold the UTF-8 string is obtained from sqlite3_malloc and must
  25799. ** be freed by the calling function.
  25800. **
  25801. ** NULL is returned if there is an allocation error.
  25802. */
  25803. SQLITE_PRIVATE char *sqlite3Utf16to8(sqlite3 *db, const void *z, int nByte, u8 enc){
  25804. Mem m;
  25805. memset(&m, 0, sizeof(m));
  25806. m.db = db;
  25807. sqlite3VdbeMemSetStr(&m, z, nByte, enc, SQLITE_STATIC);
  25808. sqlite3VdbeChangeEncoding(&m, SQLITE_UTF8);
  25809. if( db->mallocFailed ){
  25810. sqlite3VdbeMemRelease(&m);
  25811. m.z = 0;
  25812. }
  25813. assert( (m.flags & MEM_Term)!=0 || db->mallocFailed );
  25814. assert( (m.flags & MEM_Str)!=0 || db->mallocFailed );
  25815. assert( m.z || db->mallocFailed );
  25816. return m.z;
  25817. }
  25818. /*
  25819. ** zIn is a UTF-16 encoded unicode string at least nChar characters long.
  25820. ** Return the number of bytes in the first nChar unicode characters
  25821. ** in pZ. nChar must be non-negative.
  25822. */
  25823. SQLITE_PRIVATE int sqlite3Utf16ByteLen(const void *zIn, int nChar){
  25824. int c;
  25825. unsigned char const *z = zIn;
  25826. int n = 0;
  25827. if( SQLITE_UTF16NATIVE==SQLITE_UTF16BE ){
  25828. while( n<nChar ){
  25829. READ_UTF16BE(z, 1, c);
  25830. n++;
  25831. }
  25832. }else{
  25833. while( n<nChar ){
  25834. READ_UTF16LE(z, 1, c);
  25835. n++;
  25836. }
  25837. }
  25838. return (int)(z-(unsigned char const *)zIn);
  25839. }
  25840. #if defined(SQLITE_TEST)
  25841. /*
  25842. ** This routine is called from the TCL test function "translate_selftest".
  25843. ** It checks that the primitives for serializing and deserializing
  25844. ** characters in each encoding are inverses of each other.
  25845. */
  25846. SQLITE_PRIVATE void sqlite3UtfSelfTest(void){
  25847. unsigned int i, t;
  25848. unsigned char zBuf[20];
  25849. unsigned char *z;
  25850. int n;
  25851. unsigned int c;
  25852. for(i=0; i<0x00110000; i++){
  25853. z = zBuf;
  25854. WRITE_UTF8(z, i);
  25855. n = (int)(z-zBuf);
  25856. assert( n>0 && n<=4 );
  25857. z[0] = 0;
  25858. z = zBuf;
  25859. c = sqlite3Utf8Read((const u8**)&z);
  25860. t = i;
  25861. if( i>=0xD800 && i<=0xDFFF ) t = 0xFFFD;
  25862. if( (i&0xFFFFFFFE)==0xFFFE ) t = 0xFFFD;
  25863. assert( c==t );
  25864. assert( (z-zBuf)==n );
  25865. }
  25866. for(i=0; i<0x00110000; i++){
  25867. if( i>=0xD800 && i<0xE000 ) continue;
  25868. z = zBuf;
  25869. WRITE_UTF16LE(z, i);
  25870. n = (int)(z-zBuf);
  25871. assert( n>0 && n<=4 );
  25872. z[0] = 0;
  25873. z = zBuf;
  25874. READ_UTF16LE(z, 1, c);
  25875. assert( c==i );
  25876. assert( (z-zBuf)==n );
  25877. }
  25878. for(i=0; i<0x00110000; i++){
  25879. if( i>=0xD800 && i<0xE000 ) continue;
  25880. z = zBuf;
  25881. WRITE_UTF16BE(z, i);
  25882. n = (int)(z-zBuf);
  25883. assert( n>0 && n<=4 );
  25884. z[0] = 0;
  25885. z = zBuf;
  25886. READ_UTF16BE(z, 1, c);
  25887. assert( c==i );
  25888. assert( (z-zBuf)==n );
  25889. }
  25890. }
  25891. #endif /* SQLITE_TEST */
  25892. #endif /* SQLITE_OMIT_UTF16 */
  25893. /************** End of utf.c *************************************************/
  25894. /************** Begin file util.c ********************************************/
  25895. /*
  25896. ** 2001 September 15
  25897. **
  25898. ** The author disclaims copyright to this source code. In place of
  25899. ** a legal notice, here is a blessing:
  25900. **
  25901. ** May you do good and not evil.
  25902. ** May you find forgiveness for yourself and forgive others.
  25903. ** May you share freely, never taking more than you give.
  25904. **
  25905. *************************************************************************
  25906. ** Utility functions used throughout sqlite.
  25907. **
  25908. ** This file contains functions for allocating memory, comparing
  25909. ** strings, and stuff like that.
  25910. **
  25911. */
  25912. /* #include "sqliteInt.h" */
  25913. /* #include <stdarg.h> */
  25914. #if HAVE_ISNAN || SQLITE_HAVE_ISNAN
  25915. # include <math.h>
  25916. #endif
  25917. /*
  25918. ** Routine needed to support the testcase() macro.
  25919. */
  25920. #ifdef SQLITE_COVERAGE_TEST
  25921. SQLITE_PRIVATE void sqlite3Coverage(int x){
  25922. static unsigned dummy = 0;
  25923. dummy += (unsigned)x;
  25924. }
  25925. #endif
  25926. /*
  25927. ** Give a callback to the test harness that can be used to simulate faults
  25928. ** in places where it is difficult or expensive to do so purely by means
  25929. ** of inputs.
  25930. **
  25931. ** The intent of the integer argument is to let the fault simulator know
  25932. ** which of multiple sqlite3FaultSim() calls has been hit.
  25933. **
  25934. ** Return whatever integer value the test callback returns, or return
  25935. ** SQLITE_OK if no test callback is installed.
  25936. */
  25937. #ifndef SQLITE_OMIT_BUILTIN_TEST
  25938. SQLITE_PRIVATE int sqlite3FaultSim(int iTest){
  25939. int (*xCallback)(int) = sqlite3GlobalConfig.xTestCallback;
  25940. return xCallback ? xCallback(iTest) : SQLITE_OK;
  25941. }
  25942. #endif
  25943. #ifndef SQLITE_OMIT_FLOATING_POINT
  25944. /*
  25945. ** Return true if the floating point value is Not a Number (NaN).
  25946. **
  25947. ** Use the math library isnan() function if compiled with SQLITE_HAVE_ISNAN.
  25948. ** Otherwise, we have our own implementation that works on most systems.
  25949. */
  25950. SQLITE_PRIVATE int sqlite3IsNaN(double x){
  25951. int rc; /* The value return */
  25952. #if !SQLITE_HAVE_ISNAN && !HAVE_ISNAN
  25953. /*
  25954. ** Systems that support the isnan() library function should probably
  25955. ** make use of it by compiling with -DSQLITE_HAVE_ISNAN. But we have
  25956. ** found that many systems do not have a working isnan() function so
  25957. ** this implementation is provided as an alternative.
  25958. **
  25959. ** This NaN test sometimes fails if compiled on GCC with -ffast-math.
  25960. ** On the other hand, the use of -ffast-math comes with the following
  25961. ** warning:
  25962. **
  25963. ** This option [-ffast-math] should never be turned on by any
  25964. ** -O option since it can result in incorrect output for programs
  25965. ** which depend on an exact implementation of IEEE or ISO
  25966. ** rules/specifications for math functions.
  25967. **
  25968. ** Under MSVC, this NaN test may fail if compiled with a floating-
  25969. ** point precision mode other than /fp:precise. From the MSDN
  25970. ** documentation:
  25971. **
  25972. ** The compiler [with /fp:precise] will properly handle comparisons
  25973. ** involving NaN. For example, x != x evaluates to true if x is NaN
  25974. ** ...
  25975. */
  25976. #ifdef __FAST_MATH__
  25977. # error SQLite will not work correctly with the -ffast-math option of GCC.
  25978. #endif
  25979. volatile double y = x;
  25980. volatile double z = y;
  25981. rc = (y!=z);
  25982. #else /* if HAVE_ISNAN */
  25983. rc = isnan(x);
  25984. #endif /* HAVE_ISNAN */
  25985. testcase( rc );
  25986. return rc;
  25987. }
  25988. #endif /* SQLITE_OMIT_FLOATING_POINT */
  25989. /*
  25990. ** Compute a string length that is limited to what can be stored in
  25991. ** lower 30 bits of a 32-bit signed integer.
  25992. **
  25993. ** The value returned will never be negative. Nor will it ever be greater
  25994. ** than the actual length of the string. For very long strings (greater
  25995. ** than 1GiB) the value returned might be less than the true string length.
  25996. */
  25997. SQLITE_PRIVATE int sqlite3Strlen30(const char *z){
  25998. if( z==0 ) return 0;
  25999. return 0x3fffffff & (int)strlen(z);
  26000. }
  26001. /*
  26002. ** Return the declared type of a column. Or return zDflt if the column
  26003. ** has no declared type.
  26004. **
  26005. ** The column type is an extra string stored after the zero-terminator on
  26006. ** the column name if and only if the COLFLAG_HASTYPE flag is set.
  26007. */
  26008. SQLITE_PRIVATE char *sqlite3ColumnType(Column *pCol, char *zDflt){
  26009. if( (pCol->colFlags & COLFLAG_HASTYPE)==0 ) return zDflt;
  26010. return pCol->zName + strlen(pCol->zName) + 1;
  26011. }
  26012. /*
  26013. ** Helper function for sqlite3Error() - called rarely. Broken out into
  26014. ** a separate routine to avoid unnecessary register saves on entry to
  26015. ** sqlite3Error().
  26016. */
  26017. static SQLITE_NOINLINE void sqlite3ErrorFinish(sqlite3 *db, int err_code){
  26018. if( db->pErr ) sqlite3ValueSetNull(db->pErr);
  26019. sqlite3SystemError(db, err_code);
  26020. }
  26021. /*
  26022. ** Set the current error code to err_code and clear any prior error message.
  26023. ** Also set iSysErrno (by calling sqlite3System) if the err_code indicates
  26024. ** that would be appropriate.
  26025. */
  26026. SQLITE_PRIVATE void sqlite3Error(sqlite3 *db, int err_code){
  26027. assert( db!=0 );
  26028. db->errCode = err_code;
  26029. if( err_code || db->pErr ) sqlite3ErrorFinish(db, err_code);
  26030. }
  26031. /*
  26032. ** Load the sqlite3.iSysErrno field if that is an appropriate thing
  26033. ** to do based on the SQLite error code in rc.
  26034. */
  26035. SQLITE_PRIVATE void sqlite3SystemError(sqlite3 *db, int rc){
  26036. if( rc==SQLITE_IOERR_NOMEM ) return;
  26037. rc &= 0xff;
  26038. if( rc==SQLITE_CANTOPEN || rc==SQLITE_IOERR ){
  26039. db->iSysErrno = sqlite3OsGetLastError(db->pVfs);
  26040. }
  26041. }
  26042. /*
  26043. ** Set the most recent error code and error string for the sqlite
  26044. ** handle "db". The error code is set to "err_code".
  26045. **
  26046. ** If it is not NULL, string zFormat specifies the format of the
  26047. ** error string in the style of the printf functions: The following
  26048. ** format characters are allowed:
  26049. **
  26050. ** %s Insert a string
  26051. ** %z A string that should be freed after use
  26052. ** %d Insert an integer
  26053. ** %T Insert a token
  26054. ** %S Insert the first element of a SrcList
  26055. **
  26056. ** zFormat and any string tokens that follow it are assumed to be
  26057. ** encoded in UTF-8.
  26058. **
  26059. ** To clear the most recent error for sqlite handle "db", sqlite3Error
  26060. ** should be called with err_code set to SQLITE_OK and zFormat set
  26061. ** to NULL.
  26062. */
  26063. SQLITE_PRIVATE void sqlite3ErrorWithMsg(sqlite3 *db, int err_code, const char *zFormat, ...){
  26064. assert( db!=0 );
  26065. db->errCode = err_code;
  26066. sqlite3SystemError(db, err_code);
  26067. if( zFormat==0 ){
  26068. sqlite3Error(db, err_code);
  26069. }else if( db->pErr || (db->pErr = sqlite3ValueNew(db))!=0 ){
  26070. char *z;
  26071. va_list ap;
  26072. va_start(ap, zFormat);
  26073. z = sqlite3VMPrintf(db, zFormat, ap);
  26074. va_end(ap);
  26075. sqlite3ValueSetStr(db->pErr, -1, z, SQLITE_UTF8, SQLITE_DYNAMIC);
  26076. }
  26077. }
  26078. /*
  26079. ** Add an error message to pParse->zErrMsg and increment pParse->nErr.
  26080. ** The following formatting characters are allowed:
  26081. **
  26082. ** %s Insert a string
  26083. ** %z A string that should be freed after use
  26084. ** %d Insert an integer
  26085. ** %T Insert a token
  26086. ** %S Insert the first element of a SrcList
  26087. **
  26088. ** This function should be used to report any error that occurs while
  26089. ** compiling an SQL statement (i.e. within sqlite3_prepare()). The
  26090. ** last thing the sqlite3_prepare() function does is copy the error
  26091. ** stored by this function into the database handle using sqlite3Error().
  26092. ** Functions sqlite3Error() or sqlite3ErrorWithMsg() should be used
  26093. ** during statement execution (sqlite3_step() etc.).
  26094. */
  26095. SQLITE_PRIVATE void sqlite3ErrorMsg(Parse *pParse, const char *zFormat, ...){
  26096. char *zMsg;
  26097. va_list ap;
  26098. sqlite3 *db = pParse->db;
  26099. va_start(ap, zFormat);
  26100. zMsg = sqlite3VMPrintf(db, zFormat, ap);
  26101. va_end(ap);
  26102. if( db->suppressErr ){
  26103. sqlite3DbFree(db, zMsg);
  26104. }else{
  26105. pParse->nErr++;
  26106. sqlite3DbFree(db, pParse->zErrMsg);
  26107. pParse->zErrMsg = zMsg;
  26108. pParse->rc = SQLITE_ERROR;
  26109. }
  26110. }
  26111. /*
  26112. ** Convert an SQL-style quoted string into a normal string by removing
  26113. ** the quote characters. The conversion is done in-place. If the
  26114. ** input does not begin with a quote character, then this routine
  26115. ** is a no-op.
  26116. **
  26117. ** The input string must be zero-terminated. A new zero-terminator
  26118. ** is added to the dequoted string.
  26119. **
  26120. ** The return value is -1 if no dequoting occurs or the length of the
  26121. ** dequoted string, exclusive of the zero terminator, if dequoting does
  26122. ** occur.
  26123. **
  26124. ** 2002-Feb-14: This routine is extended to remove MS-Access style
  26125. ** brackets from around identifiers. For example: "[a-b-c]" becomes
  26126. ** "a-b-c".
  26127. */
  26128. SQLITE_PRIVATE void sqlite3Dequote(char *z){
  26129. char quote;
  26130. int i, j;
  26131. if( z==0 ) return;
  26132. quote = z[0];
  26133. if( !sqlite3Isquote(quote) ) return;
  26134. if( quote=='[' ) quote = ']';
  26135. for(i=1, j=0;; i++){
  26136. assert( z[i] );
  26137. if( z[i]==quote ){
  26138. if( z[i+1]==quote ){
  26139. z[j++] = quote;
  26140. i++;
  26141. }else{
  26142. break;
  26143. }
  26144. }else{
  26145. z[j++] = z[i];
  26146. }
  26147. }
  26148. z[j] = 0;
  26149. }
  26150. /*
  26151. ** Generate a Token object from a string
  26152. */
  26153. SQLITE_PRIVATE void sqlite3TokenInit(Token *p, char *z){
  26154. p->z = z;
  26155. p->n = sqlite3Strlen30(z);
  26156. }
  26157. /* Convenient short-hand */
  26158. #define UpperToLower sqlite3UpperToLower
  26159. /*
  26160. ** Some systems have stricmp(). Others have strcasecmp(). Because
  26161. ** there is no consistency, we will define our own.
  26162. **
  26163. ** IMPLEMENTATION-OF: R-30243-02494 The sqlite3_stricmp() and
  26164. ** sqlite3_strnicmp() APIs allow applications and extensions to compare
  26165. ** the contents of two buffers containing UTF-8 strings in a
  26166. ** case-independent fashion, using the same definition of "case
  26167. ** independence" that SQLite uses internally when comparing identifiers.
  26168. */
  26169. SQLITE_API int sqlite3_stricmp(const char *zLeft, const char *zRight){
  26170. if( zLeft==0 ){
  26171. return zRight ? -1 : 0;
  26172. }else if( zRight==0 ){
  26173. return 1;
  26174. }
  26175. return sqlite3StrICmp(zLeft, zRight);
  26176. }
  26177. SQLITE_PRIVATE int sqlite3StrICmp(const char *zLeft, const char *zRight){
  26178. unsigned char *a, *b;
  26179. int c;
  26180. a = (unsigned char *)zLeft;
  26181. b = (unsigned char *)zRight;
  26182. for(;;){
  26183. c = (int)UpperToLower[*a] - (int)UpperToLower[*b];
  26184. if( c || *a==0 ) break;
  26185. a++;
  26186. b++;
  26187. }
  26188. return c;
  26189. }
  26190. SQLITE_API int sqlite3_strnicmp(const char *zLeft, const char *zRight, int N){
  26191. register unsigned char *a, *b;
  26192. if( zLeft==0 ){
  26193. return zRight ? -1 : 0;
  26194. }else if( zRight==0 ){
  26195. return 1;
  26196. }
  26197. a = (unsigned char *)zLeft;
  26198. b = (unsigned char *)zRight;
  26199. while( N-- > 0 && *a!=0 && UpperToLower[*a]==UpperToLower[*b]){ a++; b++; }
  26200. return N<0 ? 0 : UpperToLower[*a] - UpperToLower[*b];
  26201. }
  26202. /*
  26203. ** The string z[] is an text representation of a real number.
  26204. ** Convert this string to a double and write it into *pResult.
  26205. **
  26206. ** The string z[] is length bytes in length (bytes, not characters) and
  26207. ** uses the encoding enc. The string is not necessarily zero-terminated.
  26208. **
  26209. ** Return TRUE if the result is a valid real number (or integer) and FALSE
  26210. ** if the string is empty or contains extraneous text. Valid numbers
  26211. ** are in one of these formats:
  26212. **
  26213. ** [+-]digits[E[+-]digits]
  26214. ** [+-]digits.[digits][E[+-]digits]
  26215. ** [+-].digits[E[+-]digits]
  26216. **
  26217. ** Leading and trailing whitespace is ignored for the purpose of determining
  26218. ** validity.
  26219. **
  26220. ** If some prefix of the input string is a valid number, this routine
  26221. ** returns FALSE but it still converts the prefix and writes the result
  26222. ** into *pResult.
  26223. */
  26224. SQLITE_PRIVATE int sqlite3AtoF(const char *z, double *pResult, int length, u8 enc){
  26225. #ifndef SQLITE_OMIT_FLOATING_POINT
  26226. int incr;
  26227. const char *zEnd = z + length;
  26228. /* sign * significand * (10 ^ (esign * exponent)) */
  26229. int sign = 1; /* sign of significand */
  26230. i64 s = 0; /* significand */
  26231. int d = 0; /* adjust exponent for shifting decimal point */
  26232. int esign = 1; /* sign of exponent */
  26233. int e = 0; /* exponent */
  26234. int eValid = 1; /* True exponent is either not used or is well-formed */
  26235. double result;
  26236. int nDigits = 0;
  26237. int nonNum = 0; /* True if input contains UTF16 with high byte non-zero */
  26238. assert( enc==SQLITE_UTF8 || enc==SQLITE_UTF16LE || enc==SQLITE_UTF16BE );
  26239. *pResult = 0.0; /* Default return value, in case of an error */
  26240. if( enc==SQLITE_UTF8 ){
  26241. incr = 1;
  26242. }else{
  26243. int i;
  26244. incr = 2;
  26245. assert( SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  26246. for(i=3-enc; i<length && z[i]==0; i+=2){}
  26247. nonNum = i<length;
  26248. zEnd = &z[i^1];
  26249. z += (enc&1);
  26250. }
  26251. /* skip leading spaces */
  26252. while( z<zEnd && sqlite3Isspace(*z) ) z+=incr;
  26253. if( z>=zEnd ) return 0;
  26254. /* get sign of significand */
  26255. if( *z=='-' ){
  26256. sign = -1;
  26257. z+=incr;
  26258. }else if( *z=='+' ){
  26259. z+=incr;
  26260. }
  26261. /* copy max significant digits to significand */
  26262. while( z<zEnd && sqlite3Isdigit(*z) && s<((LARGEST_INT64-9)/10) ){
  26263. s = s*10 + (*z - '0');
  26264. z+=incr, nDigits++;
  26265. }
  26266. /* skip non-significant significand digits
  26267. ** (increase exponent by d to shift decimal left) */
  26268. while( z<zEnd && sqlite3Isdigit(*z) ) z+=incr, nDigits++, d++;
  26269. if( z>=zEnd ) goto do_atof_calc;
  26270. /* if decimal point is present */
  26271. if( *z=='.' ){
  26272. z+=incr;
  26273. /* copy digits from after decimal to significand
  26274. ** (decrease exponent by d to shift decimal right) */
  26275. while( z<zEnd && sqlite3Isdigit(*z) ){
  26276. if( s<((LARGEST_INT64-9)/10) ){
  26277. s = s*10 + (*z - '0');
  26278. d--;
  26279. }
  26280. z+=incr, nDigits++;
  26281. }
  26282. }
  26283. if( z>=zEnd ) goto do_atof_calc;
  26284. /* if exponent is present */
  26285. if( *z=='e' || *z=='E' ){
  26286. z+=incr;
  26287. eValid = 0;
  26288. /* This branch is needed to avoid a (harmless) buffer overread. The
  26289. ** special comment alerts the mutation tester that the correct answer
  26290. ** is obtained even if the branch is omitted */
  26291. if( z>=zEnd ) goto do_atof_calc; /*PREVENTS-HARMLESS-OVERREAD*/
  26292. /* get sign of exponent */
  26293. if( *z=='-' ){
  26294. esign = -1;
  26295. z+=incr;
  26296. }else if( *z=='+' ){
  26297. z+=incr;
  26298. }
  26299. /* copy digits to exponent */
  26300. while( z<zEnd && sqlite3Isdigit(*z) ){
  26301. e = e<10000 ? (e*10 + (*z - '0')) : 10000;
  26302. z+=incr;
  26303. eValid = 1;
  26304. }
  26305. }
  26306. /* skip trailing spaces */
  26307. while( z<zEnd && sqlite3Isspace(*z) ) z+=incr;
  26308. do_atof_calc:
  26309. /* adjust exponent by d, and update sign */
  26310. e = (e*esign) + d;
  26311. if( e<0 ) {
  26312. esign = -1;
  26313. e *= -1;
  26314. } else {
  26315. esign = 1;
  26316. }
  26317. if( s==0 ) {
  26318. /* In the IEEE 754 standard, zero is signed. */
  26319. result = sign<0 ? -(double)0 : (double)0;
  26320. } else {
  26321. /* Attempt to reduce exponent.
  26322. **
  26323. ** Branches that are not required for the correct answer but which only
  26324. ** help to obtain the correct answer faster are marked with special
  26325. ** comments, as a hint to the mutation tester.
  26326. */
  26327. while( e>0 ){ /*OPTIMIZATION-IF-TRUE*/
  26328. if( esign>0 ){
  26329. if( s>=(LARGEST_INT64/10) ) break; /*OPTIMIZATION-IF-FALSE*/
  26330. s *= 10;
  26331. }else{
  26332. if( s%10!=0 ) break; /*OPTIMIZATION-IF-FALSE*/
  26333. s /= 10;
  26334. }
  26335. e--;
  26336. }
  26337. /* adjust the sign of significand */
  26338. s = sign<0 ? -s : s;
  26339. if( e==0 ){ /*OPTIMIZATION-IF-TRUE*/
  26340. result = (double)s;
  26341. }else{
  26342. LONGDOUBLE_TYPE scale = 1.0;
  26343. /* attempt to handle extremely small/large numbers better */
  26344. if( e>307 ){ /*OPTIMIZATION-IF-TRUE*/
  26345. if( e<342 ){ /*OPTIMIZATION-IF-TRUE*/
  26346. while( e%308 ) { scale *= 1.0e+1; e -= 1; }
  26347. if( esign<0 ){
  26348. result = s / scale;
  26349. result /= 1.0e+308;
  26350. }else{
  26351. result = s * scale;
  26352. result *= 1.0e+308;
  26353. }
  26354. }else{ assert( e>=342 );
  26355. if( esign<0 ){
  26356. result = 0.0*s;
  26357. }else{
  26358. result = 1e308*1e308*s; /* Infinity */
  26359. }
  26360. }
  26361. }else{
  26362. /* 1.0e+22 is the largest power of 10 than can be
  26363. ** represented exactly. */
  26364. while( e%22 ) { scale *= 1.0e+1; e -= 1; }
  26365. while( e>0 ) { scale *= 1.0e+22; e -= 22; }
  26366. if( esign<0 ){
  26367. result = s / scale;
  26368. }else{
  26369. result = s * scale;
  26370. }
  26371. }
  26372. }
  26373. }
  26374. /* store the result */
  26375. *pResult = result;
  26376. /* return true if number and no extra non-whitespace chracters after */
  26377. return z==zEnd && nDigits>0 && eValid && nonNum==0;
  26378. #else
  26379. return !sqlite3Atoi64(z, pResult, length, enc);
  26380. #endif /* SQLITE_OMIT_FLOATING_POINT */
  26381. }
  26382. /*
  26383. ** Compare the 19-character string zNum against the text representation
  26384. ** value 2^63: 9223372036854775808. Return negative, zero, or positive
  26385. ** if zNum is less than, equal to, or greater than the string.
  26386. ** Note that zNum must contain exactly 19 characters.
  26387. **
  26388. ** Unlike memcmp() this routine is guaranteed to return the difference
  26389. ** in the values of the last digit if the only difference is in the
  26390. ** last digit. So, for example,
  26391. **
  26392. ** compare2pow63("9223372036854775800", 1)
  26393. **
  26394. ** will return -8.
  26395. */
  26396. static int compare2pow63(const char *zNum, int incr){
  26397. int c = 0;
  26398. int i;
  26399. /* 012345678901234567 */
  26400. const char *pow63 = "922337203685477580";
  26401. for(i=0; c==0 && i<18; i++){
  26402. c = (zNum[i*incr]-pow63[i])*10;
  26403. }
  26404. if( c==0 ){
  26405. c = zNum[18*incr] - '8';
  26406. testcase( c==(-1) );
  26407. testcase( c==0 );
  26408. testcase( c==(+1) );
  26409. }
  26410. return c;
  26411. }
  26412. /*
  26413. ** Convert zNum to a 64-bit signed integer. zNum must be decimal. This
  26414. ** routine does *not* accept hexadecimal notation.
  26415. **
  26416. ** If the zNum value is representable as a 64-bit twos-complement
  26417. ** integer, then write that value into *pNum and return 0.
  26418. **
  26419. ** If zNum is exactly 9223372036854775808, return 2. This special
  26420. ** case is broken out because while 9223372036854775808 cannot be a
  26421. ** signed 64-bit integer, its negative -9223372036854775808 can be.
  26422. **
  26423. ** If zNum is too big for a 64-bit integer and is not
  26424. ** 9223372036854775808 or if zNum contains any non-numeric text,
  26425. ** then return 1.
  26426. **
  26427. ** length is the number of bytes in the string (bytes, not characters).
  26428. ** The string is not necessarily zero-terminated. The encoding is
  26429. ** given by enc.
  26430. */
  26431. SQLITE_PRIVATE int sqlite3Atoi64(const char *zNum, i64 *pNum, int length, u8 enc){
  26432. int incr;
  26433. u64 u = 0;
  26434. int neg = 0; /* assume positive */
  26435. int i;
  26436. int c = 0;
  26437. int nonNum = 0; /* True if input contains UTF16 with high byte non-zero */
  26438. const char *zStart;
  26439. const char *zEnd = zNum + length;
  26440. assert( enc==SQLITE_UTF8 || enc==SQLITE_UTF16LE || enc==SQLITE_UTF16BE );
  26441. if( enc==SQLITE_UTF8 ){
  26442. incr = 1;
  26443. }else{
  26444. incr = 2;
  26445. assert( SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  26446. for(i=3-enc; i<length && zNum[i]==0; i+=2){}
  26447. nonNum = i<length;
  26448. zEnd = &zNum[i^1];
  26449. zNum += (enc&1);
  26450. }
  26451. while( zNum<zEnd && sqlite3Isspace(*zNum) ) zNum+=incr;
  26452. if( zNum<zEnd ){
  26453. if( *zNum=='-' ){
  26454. neg = 1;
  26455. zNum+=incr;
  26456. }else if( *zNum=='+' ){
  26457. zNum+=incr;
  26458. }
  26459. }
  26460. zStart = zNum;
  26461. while( zNum<zEnd && zNum[0]=='0' ){ zNum+=incr; } /* Skip leading zeros. */
  26462. for(i=0; &zNum[i]<zEnd && (c=zNum[i])>='0' && c<='9'; i+=incr){
  26463. u = u*10 + c - '0';
  26464. }
  26465. if( u>LARGEST_INT64 ){
  26466. *pNum = neg ? SMALLEST_INT64 : LARGEST_INT64;
  26467. }else if( neg ){
  26468. *pNum = -(i64)u;
  26469. }else{
  26470. *pNum = (i64)u;
  26471. }
  26472. testcase( i==18 );
  26473. testcase( i==19 );
  26474. testcase( i==20 );
  26475. if( &zNum[i]<zEnd /* Extra bytes at the end */
  26476. || (i==0 && zStart==zNum) /* No digits */
  26477. || i>19*incr /* Too many digits */
  26478. || nonNum /* UTF16 with high-order bytes non-zero */
  26479. ){
  26480. /* zNum is empty or contains non-numeric text or is longer
  26481. ** than 19 digits (thus guaranteeing that it is too large) */
  26482. return 1;
  26483. }else if( i<19*incr ){
  26484. /* Less than 19 digits, so we know that it fits in 64 bits */
  26485. assert( u<=LARGEST_INT64 );
  26486. return 0;
  26487. }else{
  26488. /* zNum is a 19-digit numbers. Compare it against 9223372036854775808. */
  26489. c = compare2pow63(zNum, incr);
  26490. if( c<0 ){
  26491. /* zNum is less than 9223372036854775808 so it fits */
  26492. assert( u<=LARGEST_INT64 );
  26493. return 0;
  26494. }else if( c>0 ){
  26495. /* zNum is greater than 9223372036854775808 so it overflows */
  26496. return 1;
  26497. }else{
  26498. /* zNum is exactly 9223372036854775808. Fits if negative. The
  26499. ** special case 2 overflow if positive */
  26500. assert( u-1==LARGEST_INT64 );
  26501. return neg ? 0 : 2;
  26502. }
  26503. }
  26504. }
  26505. /*
  26506. ** Transform a UTF-8 integer literal, in either decimal or hexadecimal,
  26507. ** into a 64-bit signed integer. This routine accepts hexadecimal literals,
  26508. ** whereas sqlite3Atoi64() does not.
  26509. **
  26510. ** Returns:
  26511. **
  26512. ** 0 Successful transformation. Fits in a 64-bit signed integer.
  26513. ** 1 Integer too large for a 64-bit signed integer or is malformed
  26514. ** 2 Special case of 9223372036854775808
  26515. */
  26516. SQLITE_PRIVATE int sqlite3DecOrHexToI64(const char *z, i64 *pOut){
  26517. #ifndef SQLITE_OMIT_HEX_INTEGER
  26518. if( z[0]=='0'
  26519. && (z[1]=='x' || z[1]=='X')
  26520. ){
  26521. u64 u = 0;
  26522. int i, k;
  26523. for(i=2; z[i]=='0'; i++){}
  26524. for(k=i; sqlite3Isxdigit(z[k]); k++){
  26525. u = u*16 + sqlite3HexToInt(z[k]);
  26526. }
  26527. memcpy(pOut, &u, 8);
  26528. return (z[k]==0 && k-i<=16) ? 0 : 1;
  26529. }else
  26530. #endif /* SQLITE_OMIT_HEX_INTEGER */
  26531. {
  26532. return sqlite3Atoi64(z, pOut, sqlite3Strlen30(z), SQLITE_UTF8);
  26533. }
  26534. }
  26535. /*
  26536. ** If zNum represents an integer that will fit in 32-bits, then set
  26537. ** *pValue to that integer and return true. Otherwise return false.
  26538. **
  26539. ** This routine accepts both decimal and hexadecimal notation for integers.
  26540. **
  26541. ** Any non-numeric characters that following zNum are ignored.
  26542. ** This is different from sqlite3Atoi64() which requires the
  26543. ** input number to be zero-terminated.
  26544. */
  26545. SQLITE_PRIVATE int sqlite3GetInt32(const char *zNum, int *pValue){
  26546. sqlite_int64 v = 0;
  26547. int i, c;
  26548. int neg = 0;
  26549. if( zNum[0]=='-' ){
  26550. neg = 1;
  26551. zNum++;
  26552. }else if( zNum[0]=='+' ){
  26553. zNum++;
  26554. }
  26555. #ifndef SQLITE_OMIT_HEX_INTEGER
  26556. else if( zNum[0]=='0'
  26557. && (zNum[1]=='x' || zNum[1]=='X')
  26558. && sqlite3Isxdigit(zNum[2])
  26559. ){
  26560. u32 u = 0;
  26561. zNum += 2;
  26562. while( zNum[0]=='0' ) zNum++;
  26563. for(i=0; sqlite3Isxdigit(zNum[i]) && i<8; i++){
  26564. u = u*16 + sqlite3HexToInt(zNum[i]);
  26565. }
  26566. if( (u&0x80000000)==0 && sqlite3Isxdigit(zNum[i])==0 ){
  26567. memcpy(pValue, &u, 4);
  26568. return 1;
  26569. }else{
  26570. return 0;
  26571. }
  26572. }
  26573. #endif
  26574. while( zNum[0]=='0' ) zNum++;
  26575. for(i=0; i<11 && (c = zNum[i] - '0')>=0 && c<=9; i++){
  26576. v = v*10 + c;
  26577. }
  26578. /* The longest decimal representation of a 32 bit integer is 10 digits:
  26579. **
  26580. ** 1234567890
  26581. ** 2^31 -> 2147483648
  26582. */
  26583. testcase( i==10 );
  26584. if( i>10 ){
  26585. return 0;
  26586. }
  26587. testcase( v-neg==2147483647 );
  26588. if( v-neg>2147483647 ){
  26589. return 0;
  26590. }
  26591. if( neg ){
  26592. v = -v;
  26593. }
  26594. *pValue = (int)v;
  26595. return 1;
  26596. }
  26597. /*
  26598. ** Return a 32-bit integer value extracted from a string. If the
  26599. ** string is not an integer, just return 0.
  26600. */
  26601. SQLITE_PRIVATE int sqlite3Atoi(const char *z){
  26602. int x = 0;
  26603. if( z ) sqlite3GetInt32(z, &x);
  26604. return x;
  26605. }
  26606. /*
  26607. ** The variable-length integer encoding is as follows:
  26608. **
  26609. ** KEY:
  26610. ** A = 0xxxxxxx 7 bits of data and one flag bit
  26611. ** B = 1xxxxxxx 7 bits of data and one flag bit
  26612. ** C = xxxxxxxx 8 bits of data
  26613. **
  26614. ** 7 bits - A
  26615. ** 14 bits - BA
  26616. ** 21 bits - BBA
  26617. ** 28 bits - BBBA
  26618. ** 35 bits - BBBBA
  26619. ** 42 bits - BBBBBA
  26620. ** 49 bits - BBBBBBA
  26621. ** 56 bits - BBBBBBBA
  26622. ** 64 bits - BBBBBBBBC
  26623. */
  26624. /*
  26625. ** Write a 64-bit variable-length integer to memory starting at p[0].
  26626. ** The length of data write will be between 1 and 9 bytes. The number
  26627. ** of bytes written is returned.
  26628. **
  26629. ** A variable-length integer consists of the lower 7 bits of each byte
  26630. ** for all bytes that have the 8th bit set and one byte with the 8th
  26631. ** bit clear. Except, if we get to the 9th byte, it stores the full
  26632. ** 8 bits and is the last byte.
  26633. */
  26634. static int SQLITE_NOINLINE putVarint64(unsigned char *p, u64 v){
  26635. int i, j, n;
  26636. u8 buf[10];
  26637. if( v & (((u64)0xff000000)<<32) ){
  26638. p[8] = (u8)v;
  26639. v >>= 8;
  26640. for(i=7; i>=0; i--){
  26641. p[i] = (u8)((v & 0x7f) | 0x80);
  26642. v >>= 7;
  26643. }
  26644. return 9;
  26645. }
  26646. n = 0;
  26647. do{
  26648. buf[n++] = (u8)((v & 0x7f) | 0x80);
  26649. v >>= 7;
  26650. }while( v!=0 );
  26651. buf[0] &= 0x7f;
  26652. assert( n<=9 );
  26653. for(i=0, j=n-1; j>=0; j--, i++){
  26654. p[i] = buf[j];
  26655. }
  26656. return n;
  26657. }
  26658. SQLITE_PRIVATE int sqlite3PutVarint(unsigned char *p, u64 v){
  26659. if( v<=0x7f ){
  26660. p[0] = v&0x7f;
  26661. return 1;
  26662. }
  26663. if( v<=0x3fff ){
  26664. p[0] = ((v>>7)&0x7f)|0x80;
  26665. p[1] = v&0x7f;
  26666. return 2;
  26667. }
  26668. return putVarint64(p,v);
  26669. }
  26670. /*
  26671. ** Bitmasks used by sqlite3GetVarint(). These precomputed constants
  26672. ** are defined here rather than simply putting the constant expressions
  26673. ** inline in order to work around bugs in the RVT compiler.
  26674. **
  26675. ** SLOT_2_0 A mask for (0x7f<<14) | 0x7f
  26676. **
  26677. ** SLOT_4_2_0 A mask for (0x7f<<28) | SLOT_2_0
  26678. */
  26679. #define SLOT_2_0 0x001fc07f
  26680. #define SLOT_4_2_0 0xf01fc07f
  26681. /*
  26682. ** Read a 64-bit variable-length integer from memory starting at p[0].
  26683. ** Return the number of bytes read. The value is stored in *v.
  26684. */
  26685. SQLITE_PRIVATE u8 sqlite3GetVarint(const unsigned char *p, u64 *v){
  26686. u32 a,b,s;
  26687. a = *p;
  26688. /* a: p0 (unmasked) */
  26689. if (!(a&0x80))
  26690. {
  26691. *v = a;
  26692. return 1;
  26693. }
  26694. p++;
  26695. b = *p;
  26696. /* b: p1 (unmasked) */
  26697. if (!(b&0x80))
  26698. {
  26699. a &= 0x7f;
  26700. a = a<<7;
  26701. a |= b;
  26702. *v = a;
  26703. return 2;
  26704. }
  26705. /* Verify that constants are precomputed correctly */
  26706. assert( SLOT_2_0 == ((0x7f<<14) | (0x7f)) );
  26707. assert( SLOT_4_2_0 == ((0xfU<<28) | (0x7f<<14) | (0x7f)) );
  26708. p++;
  26709. a = a<<14;
  26710. a |= *p;
  26711. /* a: p0<<14 | p2 (unmasked) */
  26712. if (!(a&0x80))
  26713. {
  26714. a &= SLOT_2_0;
  26715. b &= 0x7f;
  26716. b = b<<7;
  26717. a |= b;
  26718. *v = a;
  26719. return 3;
  26720. }
  26721. /* CSE1 from below */
  26722. a &= SLOT_2_0;
  26723. p++;
  26724. b = b<<14;
  26725. b |= *p;
  26726. /* b: p1<<14 | p3 (unmasked) */
  26727. if (!(b&0x80))
  26728. {
  26729. b &= SLOT_2_0;
  26730. /* moved CSE1 up */
  26731. /* a &= (0x7f<<14)|(0x7f); */
  26732. a = a<<7;
  26733. a |= b;
  26734. *v = a;
  26735. return 4;
  26736. }
  26737. /* a: p0<<14 | p2 (masked) */
  26738. /* b: p1<<14 | p3 (unmasked) */
  26739. /* 1:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  26740. /* moved CSE1 up */
  26741. /* a &= (0x7f<<14)|(0x7f); */
  26742. b &= SLOT_2_0;
  26743. s = a;
  26744. /* s: p0<<14 | p2 (masked) */
  26745. p++;
  26746. a = a<<14;
  26747. a |= *p;
  26748. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  26749. if (!(a&0x80))
  26750. {
  26751. /* we can skip these cause they were (effectively) done above
  26752. ** while calculating s */
  26753. /* a &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  26754. /* b &= (0x7f<<14)|(0x7f); */
  26755. b = b<<7;
  26756. a |= b;
  26757. s = s>>18;
  26758. *v = ((u64)s)<<32 | a;
  26759. return 5;
  26760. }
  26761. /* 2:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  26762. s = s<<7;
  26763. s |= b;
  26764. /* s: p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  26765. p++;
  26766. b = b<<14;
  26767. b |= *p;
  26768. /* b: p1<<28 | p3<<14 | p5 (unmasked) */
  26769. if (!(b&0x80))
  26770. {
  26771. /* we can skip this cause it was (effectively) done above in calc'ing s */
  26772. /* b &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  26773. a &= SLOT_2_0;
  26774. a = a<<7;
  26775. a |= b;
  26776. s = s>>18;
  26777. *v = ((u64)s)<<32 | a;
  26778. return 6;
  26779. }
  26780. p++;
  26781. a = a<<14;
  26782. a |= *p;
  26783. /* a: p2<<28 | p4<<14 | p6 (unmasked) */
  26784. if (!(a&0x80))
  26785. {
  26786. a &= SLOT_4_2_0;
  26787. b &= SLOT_2_0;
  26788. b = b<<7;
  26789. a |= b;
  26790. s = s>>11;
  26791. *v = ((u64)s)<<32 | a;
  26792. return 7;
  26793. }
  26794. /* CSE2 from below */
  26795. a &= SLOT_2_0;
  26796. p++;
  26797. b = b<<14;
  26798. b |= *p;
  26799. /* b: p3<<28 | p5<<14 | p7 (unmasked) */
  26800. if (!(b&0x80))
  26801. {
  26802. b &= SLOT_4_2_0;
  26803. /* moved CSE2 up */
  26804. /* a &= (0x7f<<14)|(0x7f); */
  26805. a = a<<7;
  26806. a |= b;
  26807. s = s>>4;
  26808. *v = ((u64)s)<<32 | a;
  26809. return 8;
  26810. }
  26811. p++;
  26812. a = a<<15;
  26813. a |= *p;
  26814. /* a: p4<<29 | p6<<15 | p8 (unmasked) */
  26815. /* moved CSE2 up */
  26816. /* a &= (0x7f<<29)|(0x7f<<15)|(0xff); */
  26817. b &= SLOT_2_0;
  26818. b = b<<8;
  26819. a |= b;
  26820. s = s<<4;
  26821. b = p[-4];
  26822. b &= 0x7f;
  26823. b = b>>3;
  26824. s |= b;
  26825. *v = ((u64)s)<<32 | a;
  26826. return 9;
  26827. }
  26828. /*
  26829. ** Read a 32-bit variable-length integer from memory starting at p[0].
  26830. ** Return the number of bytes read. The value is stored in *v.
  26831. **
  26832. ** If the varint stored in p[0] is larger than can fit in a 32-bit unsigned
  26833. ** integer, then set *v to 0xffffffff.
  26834. **
  26835. ** A MACRO version, getVarint32, is provided which inlines the
  26836. ** single-byte case. All code should use the MACRO version as
  26837. ** this function assumes the single-byte case has already been handled.
  26838. */
  26839. SQLITE_PRIVATE u8 sqlite3GetVarint32(const unsigned char *p, u32 *v){
  26840. u32 a,b;
  26841. /* The 1-byte case. Overwhelmingly the most common. Handled inline
  26842. ** by the getVarin32() macro */
  26843. a = *p;
  26844. /* a: p0 (unmasked) */
  26845. #ifndef getVarint32
  26846. if (!(a&0x80))
  26847. {
  26848. /* Values between 0 and 127 */
  26849. *v = a;
  26850. return 1;
  26851. }
  26852. #endif
  26853. /* The 2-byte case */
  26854. p++;
  26855. b = *p;
  26856. /* b: p1 (unmasked) */
  26857. if (!(b&0x80))
  26858. {
  26859. /* Values between 128 and 16383 */
  26860. a &= 0x7f;
  26861. a = a<<7;
  26862. *v = a | b;
  26863. return 2;
  26864. }
  26865. /* The 3-byte case */
  26866. p++;
  26867. a = a<<14;
  26868. a |= *p;
  26869. /* a: p0<<14 | p2 (unmasked) */
  26870. if (!(a&0x80))
  26871. {
  26872. /* Values between 16384 and 2097151 */
  26873. a &= (0x7f<<14)|(0x7f);
  26874. b &= 0x7f;
  26875. b = b<<7;
  26876. *v = a | b;
  26877. return 3;
  26878. }
  26879. /* A 32-bit varint is used to store size information in btrees.
  26880. ** Objects are rarely larger than 2MiB limit of a 3-byte varint.
  26881. ** A 3-byte varint is sufficient, for example, to record the size
  26882. ** of a 1048569-byte BLOB or string.
  26883. **
  26884. ** We only unroll the first 1-, 2-, and 3- byte cases. The very
  26885. ** rare larger cases can be handled by the slower 64-bit varint
  26886. ** routine.
  26887. */
  26888. #if 1
  26889. {
  26890. u64 v64;
  26891. u8 n;
  26892. p -= 2;
  26893. n = sqlite3GetVarint(p, &v64);
  26894. assert( n>3 && n<=9 );
  26895. if( (v64 & SQLITE_MAX_U32)!=v64 ){
  26896. *v = 0xffffffff;
  26897. }else{
  26898. *v = (u32)v64;
  26899. }
  26900. return n;
  26901. }
  26902. #else
  26903. /* For following code (kept for historical record only) shows an
  26904. ** unrolling for the 3- and 4-byte varint cases. This code is
  26905. ** slightly faster, but it is also larger and much harder to test.
  26906. */
  26907. p++;
  26908. b = b<<14;
  26909. b |= *p;
  26910. /* b: p1<<14 | p3 (unmasked) */
  26911. if (!(b&0x80))
  26912. {
  26913. /* Values between 2097152 and 268435455 */
  26914. b &= (0x7f<<14)|(0x7f);
  26915. a &= (0x7f<<14)|(0x7f);
  26916. a = a<<7;
  26917. *v = a | b;
  26918. return 4;
  26919. }
  26920. p++;
  26921. a = a<<14;
  26922. a |= *p;
  26923. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  26924. if (!(a&0x80))
  26925. {
  26926. /* Values between 268435456 and 34359738367 */
  26927. a &= SLOT_4_2_0;
  26928. b &= SLOT_4_2_0;
  26929. b = b<<7;
  26930. *v = a | b;
  26931. return 5;
  26932. }
  26933. /* We can only reach this point when reading a corrupt database
  26934. ** file. In that case we are not in any hurry. Use the (relatively
  26935. ** slow) general-purpose sqlite3GetVarint() routine to extract the
  26936. ** value. */
  26937. {
  26938. u64 v64;
  26939. u8 n;
  26940. p -= 4;
  26941. n = sqlite3GetVarint(p, &v64);
  26942. assert( n>5 && n<=9 );
  26943. *v = (u32)v64;
  26944. return n;
  26945. }
  26946. #endif
  26947. }
  26948. /*
  26949. ** Return the number of bytes that will be needed to store the given
  26950. ** 64-bit integer.
  26951. */
  26952. SQLITE_PRIVATE int sqlite3VarintLen(u64 v){
  26953. int i;
  26954. for(i=1; (v >>= 7)!=0; i++){ assert( i<10 ); }
  26955. return i;
  26956. }
  26957. /*
  26958. ** Read or write a four-byte big-endian integer value.
  26959. */
  26960. SQLITE_PRIVATE u32 sqlite3Get4byte(const u8 *p){
  26961. #if SQLITE_BYTEORDER==4321
  26962. u32 x;
  26963. memcpy(&x,p,4);
  26964. return x;
  26965. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  26966. && defined(__GNUC__) && GCC_VERSION>=4003000
  26967. u32 x;
  26968. memcpy(&x,p,4);
  26969. return __builtin_bswap32(x);
  26970. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  26971. && defined(_MSC_VER) && _MSC_VER>=1300
  26972. u32 x;
  26973. memcpy(&x,p,4);
  26974. return _byteswap_ulong(x);
  26975. #else
  26976. testcase( p[0]&0x80 );
  26977. return ((unsigned)p[0]<<24) | (p[1]<<16) | (p[2]<<8) | p[3];
  26978. #endif
  26979. }
  26980. SQLITE_PRIVATE void sqlite3Put4byte(unsigned char *p, u32 v){
  26981. #if SQLITE_BYTEORDER==4321
  26982. memcpy(p,&v,4);
  26983. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  26984. && defined(__GNUC__) && GCC_VERSION>=4003000
  26985. u32 x = __builtin_bswap32(v);
  26986. memcpy(p,&x,4);
  26987. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  26988. && defined(_MSC_VER) && _MSC_VER>=1300
  26989. u32 x = _byteswap_ulong(v);
  26990. memcpy(p,&x,4);
  26991. #else
  26992. p[0] = (u8)(v>>24);
  26993. p[1] = (u8)(v>>16);
  26994. p[2] = (u8)(v>>8);
  26995. p[3] = (u8)v;
  26996. #endif
  26997. }
  26998. /*
  26999. ** Translate a single byte of Hex into an integer.
  27000. ** This routine only works if h really is a valid hexadecimal
  27001. ** character: 0..9a..fA..F
  27002. */
  27003. SQLITE_PRIVATE u8 sqlite3HexToInt(int h){
  27004. assert( (h>='0' && h<='9') || (h>='a' && h<='f') || (h>='A' && h<='F') );
  27005. #ifdef SQLITE_ASCII
  27006. h += 9*(1&(h>>6));
  27007. #endif
  27008. #ifdef SQLITE_EBCDIC
  27009. h += 9*(1&~(h>>4));
  27010. #endif
  27011. return (u8)(h & 0xf);
  27012. }
  27013. #if !defined(SQLITE_OMIT_BLOB_LITERAL) || defined(SQLITE_HAS_CODEC)
  27014. /*
  27015. ** Convert a BLOB literal of the form "x'hhhhhh'" into its binary
  27016. ** value. Return a pointer to its binary value. Space to hold the
  27017. ** binary value has been obtained from malloc and must be freed by
  27018. ** the calling routine.
  27019. */
  27020. SQLITE_PRIVATE void *sqlite3HexToBlob(sqlite3 *db, const char *z, int n){
  27021. char *zBlob;
  27022. int i;
  27023. zBlob = (char *)sqlite3DbMallocRawNN(db, n/2 + 1);
  27024. n--;
  27025. if( zBlob ){
  27026. for(i=0; i<n; i+=2){
  27027. zBlob[i/2] = (sqlite3HexToInt(z[i])<<4) | sqlite3HexToInt(z[i+1]);
  27028. }
  27029. zBlob[i/2] = 0;
  27030. }
  27031. return zBlob;
  27032. }
  27033. #endif /* !SQLITE_OMIT_BLOB_LITERAL || SQLITE_HAS_CODEC */
  27034. /*
  27035. ** Log an error that is an API call on a connection pointer that should
  27036. ** not have been used. The "type" of connection pointer is given as the
  27037. ** argument. The zType is a word like "NULL" or "closed" or "invalid".
  27038. */
  27039. static void logBadConnection(const char *zType){
  27040. sqlite3_log(SQLITE_MISUSE,
  27041. "API call with %s database connection pointer",
  27042. zType
  27043. );
  27044. }
  27045. /*
  27046. ** Check to make sure we have a valid db pointer. This test is not
  27047. ** foolproof but it does provide some measure of protection against
  27048. ** misuse of the interface such as passing in db pointers that are
  27049. ** NULL or which have been previously closed. If this routine returns
  27050. ** 1 it means that the db pointer is valid and 0 if it should not be
  27051. ** dereferenced for any reason. The calling function should invoke
  27052. ** SQLITE_MISUSE immediately.
  27053. **
  27054. ** sqlite3SafetyCheckOk() requires that the db pointer be valid for
  27055. ** use. sqlite3SafetyCheckSickOrOk() allows a db pointer that failed to
  27056. ** open properly and is not fit for general use but which can be
  27057. ** used as an argument to sqlite3_errmsg() or sqlite3_close().
  27058. */
  27059. SQLITE_PRIVATE int sqlite3SafetyCheckOk(sqlite3 *db){
  27060. u32 magic;
  27061. if( db==0 ){
  27062. logBadConnection("NULL");
  27063. return 0;
  27064. }
  27065. magic = db->magic;
  27066. if( magic!=SQLITE_MAGIC_OPEN ){
  27067. if( sqlite3SafetyCheckSickOrOk(db) ){
  27068. testcase( sqlite3GlobalConfig.xLog!=0 );
  27069. logBadConnection("unopened");
  27070. }
  27071. return 0;
  27072. }else{
  27073. return 1;
  27074. }
  27075. }
  27076. SQLITE_PRIVATE int sqlite3SafetyCheckSickOrOk(sqlite3 *db){
  27077. u32 magic;
  27078. magic = db->magic;
  27079. if( magic!=SQLITE_MAGIC_SICK &&
  27080. magic!=SQLITE_MAGIC_OPEN &&
  27081. magic!=SQLITE_MAGIC_BUSY ){
  27082. testcase( sqlite3GlobalConfig.xLog!=0 );
  27083. logBadConnection("invalid");
  27084. return 0;
  27085. }else{
  27086. return 1;
  27087. }
  27088. }
  27089. /*
  27090. ** Attempt to add, substract, or multiply the 64-bit signed value iB against
  27091. ** the other 64-bit signed integer at *pA and store the result in *pA.
  27092. ** Return 0 on success. Or if the operation would have resulted in an
  27093. ** overflow, leave *pA unchanged and return 1.
  27094. */
  27095. SQLITE_PRIVATE int sqlite3AddInt64(i64 *pA, i64 iB){
  27096. i64 iA = *pA;
  27097. testcase( iA==0 ); testcase( iA==1 );
  27098. testcase( iB==-1 ); testcase( iB==0 );
  27099. if( iB>=0 ){
  27100. testcase( iA>0 && LARGEST_INT64 - iA == iB );
  27101. testcase( iA>0 && LARGEST_INT64 - iA == iB - 1 );
  27102. if( iA>0 && LARGEST_INT64 - iA < iB ) return 1;
  27103. }else{
  27104. testcase( iA<0 && -(iA + LARGEST_INT64) == iB + 1 );
  27105. testcase( iA<0 && -(iA + LARGEST_INT64) == iB + 2 );
  27106. if( iA<0 && -(iA + LARGEST_INT64) > iB + 1 ) return 1;
  27107. }
  27108. *pA += iB;
  27109. return 0;
  27110. }
  27111. SQLITE_PRIVATE int sqlite3SubInt64(i64 *pA, i64 iB){
  27112. testcase( iB==SMALLEST_INT64+1 );
  27113. if( iB==SMALLEST_INT64 ){
  27114. testcase( (*pA)==(-1) ); testcase( (*pA)==0 );
  27115. if( (*pA)>=0 ) return 1;
  27116. *pA -= iB;
  27117. return 0;
  27118. }else{
  27119. return sqlite3AddInt64(pA, -iB);
  27120. }
  27121. }
  27122. SQLITE_PRIVATE int sqlite3MulInt64(i64 *pA, i64 iB){
  27123. i64 iA = *pA;
  27124. if( iB>0 ){
  27125. if( iA>LARGEST_INT64/iB ) return 1;
  27126. if( iA<SMALLEST_INT64/iB ) return 1;
  27127. }else if( iB<0 ){
  27128. if( iA>0 ){
  27129. if( iB<SMALLEST_INT64/iA ) return 1;
  27130. }else if( iA<0 ){
  27131. if( iB==SMALLEST_INT64 ) return 1;
  27132. if( iA==SMALLEST_INT64 ) return 1;
  27133. if( -iA>LARGEST_INT64/-iB ) return 1;
  27134. }
  27135. }
  27136. *pA = iA*iB;
  27137. return 0;
  27138. }
  27139. /*
  27140. ** Compute the absolute value of a 32-bit signed integer, of possible. Or
  27141. ** if the integer has a value of -2147483648, return +2147483647
  27142. */
  27143. SQLITE_PRIVATE int sqlite3AbsInt32(int x){
  27144. if( x>=0 ) return x;
  27145. if( x==(int)0x80000000 ) return 0x7fffffff;
  27146. return -x;
  27147. }
  27148. #ifdef SQLITE_ENABLE_8_3_NAMES
  27149. /*
  27150. ** If SQLITE_ENABLE_8_3_NAMES is set at compile-time and if the database
  27151. ** filename in zBaseFilename is a URI with the "8_3_names=1" parameter and
  27152. ** if filename in z[] has a suffix (a.k.a. "extension") that is longer than
  27153. ** three characters, then shorten the suffix on z[] to be the last three
  27154. ** characters of the original suffix.
  27155. **
  27156. ** If SQLITE_ENABLE_8_3_NAMES is set to 2 at compile-time, then always
  27157. ** do the suffix shortening regardless of URI parameter.
  27158. **
  27159. ** Examples:
  27160. **
  27161. ** test.db-journal => test.nal
  27162. ** test.db-wal => test.wal
  27163. ** test.db-shm => test.shm
  27164. ** test.db-mj7f3319fa => test.9fa
  27165. */
  27166. SQLITE_PRIVATE void sqlite3FileSuffix3(const char *zBaseFilename, char *z){
  27167. #if SQLITE_ENABLE_8_3_NAMES<2
  27168. if( sqlite3_uri_boolean(zBaseFilename, "8_3_names", 0) )
  27169. #endif
  27170. {
  27171. int i, sz;
  27172. sz = sqlite3Strlen30(z);
  27173. for(i=sz-1; i>0 && z[i]!='/' && z[i]!='.'; i--){}
  27174. if( z[i]=='.' && ALWAYS(sz>i+4) ) memmove(&z[i+1], &z[sz-3], 4);
  27175. }
  27176. }
  27177. #endif
  27178. /*
  27179. ** Find (an approximate) sum of two LogEst values. This computation is
  27180. ** not a simple "+" operator because LogEst is stored as a logarithmic
  27181. ** value.
  27182. **
  27183. */
  27184. SQLITE_PRIVATE LogEst sqlite3LogEstAdd(LogEst a, LogEst b){
  27185. static const unsigned char x[] = {
  27186. 10, 10, /* 0,1 */
  27187. 9, 9, /* 2,3 */
  27188. 8, 8, /* 4,5 */
  27189. 7, 7, 7, /* 6,7,8 */
  27190. 6, 6, 6, /* 9,10,11 */
  27191. 5, 5, 5, /* 12-14 */
  27192. 4, 4, 4, 4, /* 15-18 */
  27193. 3, 3, 3, 3, 3, 3, /* 19-24 */
  27194. 2, 2, 2, 2, 2, 2, 2, /* 25-31 */
  27195. };
  27196. if( a>=b ){
  27197. if( a>b+49 ) return a;
  27198. if( a>b+31 ) return a+1;
  27199. return a+x[a-b];
  27200. }else{
  27201. if( b>a+49 ) return b;
  27202. if( b>a+31 ) return b+1;
  27203. return b+x[b-a];
  27204. }
  27205. }
  27206. /*
  27207. ** Convert an integer into a LogEst. In other words, compute an
  27208. ** approximation for 10*log2(x).
  27209. */
  27210. SQLITE_PRIVATE LogEst sqlite3LogEst(u64 x){
  27211. static LogEst a[] = { 0, 2, 3, 5, 6, 7, 8, 9 };
  27212. LogEst y = 40;
  27213. if( x<8 ){
  27214. if( x<2 ) return 0;
  27215. while( x<8 ){ y -= 10; x <<= 1; }
  27216. }else{
  27217. while( x>255 ){ y += 40; x >>= 4; } /*OPTIMIZATION-IF-TRUE*/
  27218. while( x>15 ){ y += 10; x >>= 1; }
  27219. }
  27220. return a[x&7] + y - 10;
  27221. }
  27222. #ifndef SQLITE_OMIT_VIRTUALTABLE
  27223. /*
  27224. ** Convert a double into a LogEst
  27225. ** In other words, compute an approximation for 10*log2(x).
  27226. */
  27227. SQLITE_PRIVATE LogEst sqlite3LogEstFromDouble(double x){
  27228. u64 a;
  27229. LogEst e;
  27230. assert( sizeof(x)==8 && sizeof(a)==8 );
  27231. if( x<=1 ) return 0;
  27232. if( x<=2000000000 ) return sqlite3LogEst((u64)x);
  27233. memcpy(&a, &x, 8);
  27234. e = (a>>52) - 1022;
  27235. return e*10;
  27236. }
  27237. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  27238. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  27239. defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
  27240. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  27241. /*
  27242. ** Convert a LogEst into an integer.
  27243. **
  27244. ** Note that this routine is only used when one or more of various
  27245. ** non-standard compile-time options is enabled.
  27246. */
  27247. SQLITE_PRIVATE u64 sqlite3LogEstToInt(LogEst x){
  27248. u64 n;
  27249. n = x%10;
  27250. x /= 10;
  27251. if( n>=5 ) n -= 2;
  27252. else if( n>=1 ) n -= 1;
  27253. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  27254. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  27255. if( x>60 ) return (u64)LARGEST_INT64;
  27256. #else
  27257. /* If only SQLITE_ENABLE_STAT3_OR_STAT4 is on, then the largest input
  27258. ** possible to this routine is 310, resulting in a maximum x of 31 */
  27259. assert( x<=60 );
  27260. #endif
  27261. return x>=3 ? (n+8)<<(x-3) : (n+8)>>(3-x);
  27262. }
  27263. #endif /* defined SCANSTAT or STAT4 or ESTIMATED_ROWS */
  27264. /************** End of util.c ************************************************/
  27265. /************** Begin file hash.c ********************************************/
  27266. /*
  27267. ** 2001 September 22
  27268. **
  27269. ** The author disclaims copyright to this source code. In place of
  27270. ** a legal notice, here is a blessing:
  27271. **
  27272. ** May you do good and not evil.
  27273. ** May you find forgiveness for yourself and forgive others.
  27274. ** May you share freely, never taking more than you give.
  27275. **
  27276. *************************************************************************
  27277. ** This is the implementation of generic hash-tables
  27278. ** used in SQLite.
  27279. */
  27280. /* #include "sqliteInt.h" */
  27281. /* #include <assert.h> */
  27282. /* Turn bulk memory into a hash table object by initializing the
  27283. ** fields of the Hash structure.
  27284. **
  27285. ** "pNew" is a pointer to the hash table that is to be initialized.
  27286. */
  27287. SQLITE_PRIVATE void sqlite3HashInit(Hash *pNew){
  27288. assert( pNew!=0 );
  27289. pNew->first = 0;
  27290. pNew->count = 0;
  27291. pNew->htsize = 0;
  27292. pNew->ht = 0;
  27293. }
  27294. /* Remove all entries from a hash table. Reclaim all memory.
  27295. ** Call this routine to delete a hash table or to reset a hash table
  27296. ** to the empty state.
  27297. */
  27298. SQLITE_PRIVATE void sqlite3HashClear(Hash *pH){
  27299. HashElem *elem; /* For looping over all elements of the table */
  27300. assert( pH!=0 );
  27301. elem = pH->first;
  27302. pH->first = 0;
  27303. sqlite3_free(pH->ht);
  27304. pH->ht = 0;
  27305. pH->htsize = 0;
  27306. while( elem ){
  27307. HashElem *next_elem = elem->next;
  27308. sqlite3_free(elem);
  27309. elem = next_elem;
  27310. }
  27311. pH->count = 0;
  27312. }
  27313. /*
  27314. ** The hashing function.
  27315. */
  27316. static unsigned int strHash(const char *z){
  27317. unsigned int h = 0;
  27318. unsigned char c;
  27319. while( (c = (unsigned char)*z++)!=0 ){ /*OPTIMIZATION-IF-TRUE*/
  27320. /* Knuth multiplicative hashing. (Sorting & Searching, p. 510).
  27321. ** 0x9e3779b1 is 2654435761 which is the closest prime number to
  27322. ** (2**32)*golden_ratio, where golden_ratio = (sqrt(5) - 1)/2. */
  27323. h += sqlite3UpperToLower[c];
  27324. h *= 0x9e3779b1;
  27325. }
  27326. return h;
  27327. }
  27328. /* Link pNew element into the hash table pH. If pEntry!=0 then also
  27329. ** insert pNew into the pEntry hash bucket.
  27330. */
  27331. static void insertElement(
  27332. Hash *pH, /* The complete hash table */
  27333. struct _ht *pEntry, /* The entry into which pNew is inserted */
  27334. HashElem *pNew /* The element to be inserted */
  27335. ){
  27336. HashElem *pHead; /* First element already in pEntry */
  27337. if( pEntry ){
  27338. pHead = pEntry->count ? pEntry->chain : 0;
  27339. pEntry->count++;
  27340. pEntry->chain = pNew;
  27341. }else{
  27342. pHead = 0;
  27343. }
  27344. if( pHead ){
  27345. pNew->next = pHead;
  27346. pNew->prev = pHead->prev;
  27347. if( pHead->prev ){ pHead->prev->next = pNew; }
  27348. else { pH->first = pNew; }
  27349. pHead->prev = pNew;
  27350. }else{
  27351. pNew->next = pH->first;
  27352. if( pH->first ){ pH->first->prev = pNew; }
  27353. pNew->prev = 0;
  27354. pH->first = pNew;
  27355. }
  27356. }
  27357. /* Resize the hash table so that it cantains "new_size" buckets.
  27358. **
  27359. ** The hash table might fail to resize if sqlite3_malloc() fails or
  27360. ** if the new size is the same as the prior size.
  27361. ** Return TRUE if the resize occurs and false if not.
  27362. */
  27363. static int rehash(Hash *pH, unsigned int new_size){
  27364. struct _ht *new_ht; /* The new hash table */
  27365. HashElem *elem, *next_elem; /* For looping over existing elements */
  27366. #if SQLITE_MALLOC_SOFT_LIMIT>0
  27367. if( new_size*sizeof(struct _ht)>SQLITE_MALLOC_SOFT_LIMIT ){
  27368. new_size = SQLITE_MALLOC_SOFT_LIMIT/sizeof(struct _ht);
  27369. }
  27370. if( new_size==pH->htsize ) return 0;
  27371. #endif
  27372. /* The inability to allocates space for a larger hash table is
  27373. ** a performance hit but it is not a fatal error. So mark the
  27374. ** allocation as a benign. Use sqlite3Malloc()/memset(0) instead of
  27375. ** sqlite3MallocZero() to make the allocation, as sqlite3MallocZero()
  27376. ** only zeroes the requested number of bytes whereas this module will
  27377. ** use the actual amount of space allocated for the hash table (which
  27378. ** may be larger than the requested amount).
  27379. */
  27380. sqlite3BeginBenignMalloc();
  27381. new_ht = (struct _ht *)sqlite3Malloc( new_size*sizeof(struct _ht) );
  27382. sqlite3EndBenignMalloc();
  27383. if( new_ht==0 ) return 0;
  27384. sqlite3_free(pH->ht);
  27385. pH->ht = new_ht;
  27386. pH->htsize = new_size = sqlite3MallocSize(new_ht)/sizeof(struct _ht);
  27387. memset(new_ht, 0, new_size*sizeof(struct _ht));
  27388. for(elem=pH->first, pH->first=0; elem; elem = next_elem){
  27389. unsigned int h = strHash(elem->pKey) % new_size;
  27390. next_elem = elem->next;
  27391. insertElement(pH, &new_ht[h], elem);
  27392. }
  27393. return 1;
  27394. }
  27395. /* This function (for internal use only) locates an element in an
  27396. ** hash table that matches the given key. The hash for this key is
  27397. ** also computed and returned in the *pH parameter.
  27398. */
  27399. static HashElem *findElementWithHash(
  27400. const Hash *pH, /* The pH to be searched */
  27401. const char *pKey, /* The key we are searching for */
  27402. unsigned int *pHash /* Write the hash value here */
  27403. ){
  27404. HashElem *elem; /* Used to loop thru the element list */
  27405. int count; /* Number of elements left to test */
  27406. unsigned int h; /* The computed hash */
  27407. if( pH->ht ){ /*OPTIMIZATION-IF-TRUE*/
  27408. struct _ht *pEntry;
  27409. h = strHash(pKey) % pH->htsize;
  27410. pEntry = &pH->ht[h];
  27411. elem = pEntry->chain;
  27412. count = pEntry->count;
  27413. }else{
  27414. h = 0;
  27415. elem = pH->first;
  27416. count = pH->count;
  27417. }
  27418. *pHash = h;
  27419. while( count-- ){
  27420. assert( elem!=0 );
  27421. if( sqlite3StrICmp(elem->pKey,pKey)==0 ){
  27422. return elem;
  27423. }
  27424. elem = elem->next;
  27425. }
  27426. return 0;
  27427. }
  27428. /* Remove a single entry from the hash table given a pointer to that
  27429. ** element and a hash on the element's key.
  27430. */
  27431. static void removeElementGivenHash(
  27432. Hash *pH, /* The pH containing "elem" */
  27433. HashElem* elem, /* The element to be removed from the pH */
  27434. unsigned int h /* Hash value for the element */
  27435. ){
  27436. struct _ht *pEntry;
  27437. if( elem->prev ){
  27438. elem->prev->next = elem->next;
  27439. }else{
  27440. pH->first = elem->next;
  27441. }
  27442. if( elem->next ){
  27443. elem->next->prev = elem->prev;
  27444. }
  27445. if( pH->ht ){
  27446. pEntry = &pH->ht[h];
  27447. if( pEntry->chain==elem ){
  27448. pEntry->chain = elem->next;
  27449. }
  27450. pEntry->count--;
  27451. assert( pEntry->count>=0 );
  27452. }
  27453. sqlite3_free( elem );
  27454. pH->count--;
  27455. if( pH->count==0 ){
  27456. assert( pH->first==0 );
  27457. assert( pH->count==0 );
  27458. sqlite3HashClear(pH);
  27459. }
  27460. }
  27461. /* Attempt to locate an element of the hash table pH with a key
  27462. ** that matches pKey. Return the data for this element if it is
  27463. ** found, or NULL if there is no match.
  27464. */
  27465. SQLITE_PRIVATE void *sqlite3HashFind(const Hash *pH, const char *pKey){
  27466. HashElem *elem; /* The element that matches key */
  27467. unsigned int h; /* A hash on key */
  27468. assert( pH!=0 );
  27469. assert( pKey!=0 );
  27470. elem = findElementWithHash(pH, pKey, &h);
  27471. return elem ? elem->data : 0;
  27472. }
  27473. /* Insert an element into the hash table pH. The key is pKey
  27474. ** and the data is "data".
  27475. **
  27476. ** If no element exists with a matching key, then a new
  27477. ** element is created and NULL is returned.
  27478. **
  27479. ** If another element already exists with the same key, then the
  27480. ** new data replaces the old data and the old data is returned.
  27481. ** The key is not copied in this instance. If a malloc fails, then
  27482. ** the new data is returned and the hash table is unchanged.
  27483. **
  27484. ** If the "data" parameter to this function is NULL, then the
  27485. ** element corresponding to "key" is removed from the hash table.
  27486. */
  27487. SQLITE_PRIVATE void *sqlite3HashInsert(Hash *pH, const char *pKey, void *data){
  27488. unsigned int h; /* the hash of the key modulo hash table size */
  27489. HashElem *elem; /* Used to loop thru the element list */
  27490. HashElem *new_elem; /* New element added to the pH */
  27491. assert( pH!=0 );
  27492. assert( pKey!=0 );
  27493. elem = findElementWithHash(pH,pKey,&h);
  27494. if( elem ){
  27495. void *old_data = elem->data;
  27496. if( data==0 ){
  27497. removeElementGivenHash(pH,elem,h);
  27498. }else{
  27499. elem->data = data;
  27500. elem->pKey = pKey;
  27501. }
  27502. return old_data;
  27503. }
  27504. if( data==0 ) return 0;
  27505. new_elem = (HashElem*)sqlite3Malloc( sizeof(HashElem) );
  27506. if( new_elem==0 ) return data;
  27507. new_elem->pKey = pKey;
  27508. new_elem->data = data;
  27509. pH->count++;
  27510. if( pH->count>=10 && pH->count > 2*pH->htsize ){
  27511. if( rehash(pH, pH->count*2) ){
  27512. assert( pH->htsize>0 );
  27513. h = strHash(pKey) % pH->htsize;
  27514. }
  27515. }
  27516. insertElement(pH, pH->ht ? &pH->ht[h] : 0, new_elem);
  27517. return 0;
  27518. }
  27519. /************** End of hash.c ************************************************/
  27520. /************** Begin file opcodes.c *****************************************/
  27521. /* Automatically generated. Do not edit */
  27522. /* See the tool/mkopcodec.tcl script for details. */
  27523. #if !defined(SQLITE_OMIT_EXPLAIN) \
  27524. || defined(VDBE_PROFILE) \
  27525. || defined(SQLITE_DEBUG)
  27526. #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) || defined(SQLITE_DEBUG)
  27527. # define OpHelp(X) "\0" X
  27528. #else
  27529. # define OpHelp(X)
  27530. #endif
  27531. SQLITE_PRIVATE const char *sqlite3OpcodeName(int i){
  27532. static const char *const azName[] = {
  27533. /* 0 */ "Savepoint" OpHelp(""),
  27534. /* 1 */ "AutoCommit" OpHelp(""),
  27535. /* 2 */ "Transaction" OpHelp(""),
  27536. /* 3 */ "SorterNext" OpHelp(""),
  27537. /* 4 */ "PrevIfOpen" OpHelp(""),
  27538. /* 5 */ "NextIfOpen" OpHelp(""),
  27539. /* 6 */ "Prev" OpHelp(""),
  27540. /* 7 */ "Next" OpHelp(""),
  27541. /* 8 */ "Checkpoint" OpHelp(""),
  27542. /* 9 */ "JournalMode" OpHelp(""),
  27543. /* 10 */ "Vacuum" OpHelp(""),
  27544. /* 11 */ "VFilter" OpHelp("iplan=r[P3] zplan='P4'"),
  27545. /* 12 */ "VUpdate" OpHelp("data=r[P3@P2]"),
  27546. /* 13 */ "Goto" OpHelp(""),
  27547. /* 14 */ "Gosub" OpHelp(""),
  27548. /* 15 */ "InitCoroutine" OpHelp(""),
  27549. /* 16 */ "Yield" OpHelp(""),
  27550. /* 17 */ "MustBeInt" OpHelp(""),
  27551. /* 18 */ "Jump" OpHelp(""),
  27552. /* 19 */ "Not" OpHelp("r[P2]= !r[P1]"),
  27553. /* 20 */ "Once" OpHelp(""),
  27554. /* 21 */ "If" OpHelp(""),
  27555. /* 22 */ "IfNot" OpHelp(""),
  27556. /* 23 */ "SeekLT" OpHelp("key=r[P3@P4]"),
  27557. /* 24 */ "SeekLE" OpHelp("key=r[P3@P4]"),
  27558. /* 25 */ "SeekGE" OpHelp("key=r[P3@P4]"),
  27559. /* 26 */ "SeekGT" OpHelp("key=r[P3@P4]"),
  27560. /* 27 */ "Or" OpHelp("r[P3]=(r[P1] || r[P2])"),
  27561. /* 28 */ "And" OpHelp("r[P3]=(r[P1] && r[P2])"),
  27562. /* 29 */ "NoConflict" OpHelp("key=r[P3@P4]"),
  27563. /* 30 */ "NotFound" OpHelp("key=r[P3@P4]"),
  27564. /* 31 */ "Found" OpHelp("key=r[P3@P4]"),
  27565. /* 32 */ "SeekRowid" OpHelp("intkey=r[P3]"),
  27566. /* 33 */ "NotExists" OpHelp("intkey=r[P3]"),
  27567. /* 34 */ "IsNull" OpHelp("if r[P1]==NULL goto P2"),
  27568. /* 35 */ "NotNull" OpHelp("if r[P1]!=NULL goto P2"),
  27569. /* 36 */ "Ne" OpHelp("IF r[P3]!=r[P1]"),
  27570. /* 37 */ "Eq" OpHelp("IF r[P3]==r[P1]"),
  27571. /* 38 */ "Gt" OpHelp("IF r[P3]>r[P1]"),
  27572. /* 39 */ "Le" OpHelp("IF r[P3]<=r[P1]"),
  27573. /* 40 */ "Lt" OpHelp("IF r[P3]<r[P1]"),
  27574. /* 41 */ "Ge" OpHelp("IF r[P3]>=r[P1]"),
  27575. /* 42 */ "ElseNotEq" OpHelp(""),
  27576. /* 43 */ "BitAnd" OpHelp("r[P3]=r[P1]&r[P2]"),
  27577. /* 44 */ "BitOr" OpHelp("r[P3]=r[P1]|r[P2]"),
  27578. /* 45 */ "ShiftLeft" OpHelp("r[P3]=r[P2]<<r[P1]"),
  27579. /* 46 */ "ShiftRight" OpHelp("r[P3]=r[P2]>>r[P1]"),
  27580. /* 47 */ "Add" OpHelp("r[P3]=r[P1]+r[P2]"),
  27581. /* 48 */ "Subtract" OpHelp("r[P3]=r[P2]-r[P1]"),
  27582. /* 49 */ "Multiply" OpHelp("r[P3]=r[P1]*r[P2]"),
  27583. /* 50 */ "Divide" OpHelp("r[P3]=r[P2]/r[P1]"),
  27584. /* 51 */ "Remainder" OpHelp("r[P3]=r[P2]%r[P1]"),
  27585. /* 52 */ "Concat" OpHelp("r[P3]=r[P2]+r[P1]"),
  27586. /* 53 */ "Last" OpHelp(""),
  27587. /* 54 */ "BitNot" OpHelp("r[P1]= ~r[P1]"),
  27588. /* 55 */ "SorterSort" OpHelp(""),
  27589. /* 56 */ "Sort" OpHelp(""),
  27590. /* 57 */ "Rewind" OpHelp(""),
  27591. /* 58 */ "IdxLE" OpHelp("key=r[P3@P4]"),
  27592. /* 59 */ "IdxGT" OpHelp("key=r[P3@P4]"),
  27593. /* 60 */ "IdxLT" OpHelp("key=r[P3@P4]"),
  27594. /* 61 */ "IdxGE" OpHelp("key=r[P3@P4]"),
  27595. /* 62 */ "RowSetRead" OpHelp("r[P3]=rowset(P1)"),
  27596. /* 63 */ "RowSetTest" OpHelp("if r[P3] in rowset(P1) goto P2"),
  27597. /* 64 */ "Program" OpHelp(""),
  27598. /* 65 */ "FkIfZero" OpHelp("if fkctr[P1]==0 goto P2"),
  27599. /* 66 */ "IfPos" OpHelp("if r[P1]>0 then r[P1]-=P3, goto P2"),
  27600. /* 67 */ "IfNotZero" OpHelp("if r[P1]!=0 then r[P1]-=P3, goto P2"),
  27601. /* 68 */ "DecrJumpZero" OpHelp("if (--r[P1])==0 goto P2"),
  27602. /* 69 */ "IncrVacuum" OpHelp(""),
  27603. /* 70 */ "VNext" OpHelp(""),
  27604. /* 71 */ "Init" OpHelp("Start at P2"),
  27605. /* 72 */ "Return" OpHelp(""),
  27606. /* 73 */ "EndCoroutine" OpHelp(""),
  27607. /* 74 */ "HaltIfNull" OpHelp("if r[P3]=null halt"),
  27608. /* 75 */ "Halt" OpHelp(""),
  27609. /* 76 */ "Integer" OpHelp("r[P2]=P1"),
  27610. /* 77 */ "Int64" OpHelp("r[P2]=P4"),
  27611. /* 78 */ "String" OpHelp("r[P2]='P4' (len=P1)"),
  27612. /* 79 */ "Null" OpHelp("r[P2..P3]=NULL"),
  27613. /* 80 */ "SoftNull" OpHelp("r[P1]=NULL"),
  27614. /* 81 */ "Blob" OpHelp("r[P2]=P4 (len=P1)"),
  27615. /* 82 */ "Variable" OpHelp("r[P2]=parameter(P1,P4)"),
  27616. /* 83 */ "Move" OpHelp("r[P2@P3]=r[P1@P3]"),
  27617. /* 84 */ "Copy" OpHelp("r[P2@P3+1]=r[P1@P3+1]"),
  27618. /* 85 */ "SCopy" OpHelp("r[P2]=r[P1]"),
  27619. /* 86 */ "IntCopy" OpHelp("r[P2]=r[P1]"),
  27620. /* 87 */ "ResultRow" OpHelp("output=r[P1@P2]"),
  27621. /* 88 */ "CollSeq" OpHelp(""),
  27622. /* 89 */ "Function0" OpHelp("r[P3]=func(r[P2@P5])"),
  27623. /* 90 */ "Function" OpHelp("r[P3]=func(r[P2@P5])"),
  27624. /* 91 */ "AddImm" OpHelp("r[P1]=r[P1]+P2"),
  27625. /* 92 */ "RealAffinity" OpHelp(""),
  27626. /* 93 */ "Cast" OpHelp("affinity(r[P1])"),
  27627. /* 94 */ "Permutation" OpHelp(""),
  27628. /* 95 */ "Compare" OpHelp("r[P1@P3] <-> r[P2@P3]"),
  27629. /* 96 */ "Column" OpHelp("r[P3]=PX"),
  27630. /* 97 */ "String8" OpHelp("r[P2]='P4'"),
  27631. /* 98 */ "Affinity" OpHelp("affinity(r[P1@P2])"),
  27632. /* 99 */ "MakeRecord" OpHelp("r[P3]=mkrec(r[P1@P2])"),
  27633. /* 100 */ "Count" OpHelp("r[P2]=count()"),
  27634. /* 101 */ "ReadCookie" OpHelp(""),
  27635. /* 102 */ "SetCookie" OpHelp(""),
  27636. /* 103 */ "ReopenIdx" OpHelp("root=P2 iDb=P3"),
  27637. /* 104 */ "OpenRead" OpHelp("root=P2 iDb=P3"),
  27638. /* 105 */ "OpenWrite" OpHelp("root=P2 iDb=P3"),
  27639. /* 106 */ "OpenAutoindex" OpHelp("nColumn=P2"),
  27640. /* 107 */ "OpenEphemeral" OpHelp("nColumn=P2"),
  27641. /* 108 */ "SorterOpen" OpHelp(""),
  27642. /* 109 */ "SequenceTest" OpHelp("if( cursor[P1].ctr++ ) pc = P2"),
  27643. /* 110 */ "OpenPseudo" OpHelp("P3 columns in r[P2]"),
  27644. /* 111 */ "Close" OpHelp(""),
  27645. /* 112 */ "ColumnsUsed" OpHelp(""),
  27646. /* 113 */ "Sequence" OpHelp("r[P2]=cursor[P1].ctr++"),
  27647. /* 114 */ "NewRowid" OpHelp("r[P2]=rowid"),
  27648. /* 115 */ "Insert" OpHelp("intkey=r[P3] data=r[P2]"),
  27649. /* 116 */ "InsertInt" OpHelp("intkey=P3 data=r[P2]"),
  27650. /* 117 */ "Delete" OpHelp(""),
  27651. /* 118 */ "ResetCount" OpHelp(""),
  27652. /* 119 */ "SorterCompare" OpHelp("if key(P1)!=trim(r[P3],P4) goto P2"),
  27653. /* 120 */ "SorterData" OpHelp("r[P2]=data"),
  27654. /* 121 */ "RowKey" OpHelp("r[P2]=key"),
  27655. /* 122 */ "RowData" OpHelp("r[P2]=data"),
  27656. /* 123 */ "Rowid" OpHelp("r[P2]=rowid"),
  27657. /* 124 */ "NullRow" OpHelp(""),
  27658. /* 125 */ "SorterInsert" OpHelp(""),
  27659. /* 126 */ "IdxInsert" OpHelp("key=r[P2]"),
  27660. /* 127 */ "IdxDelete" OpHelp("key=r[P2@P3]"),
  27661. /* 128 */ "Seek" OpHelp("Move P3 to P1.rowid"),
  27662. /* 129 */ "IdxRowid" OpHelp("r[P2]=rowid"),
  27663. /* 130 */ "Destroy" OpHelp(""),
  27664. /* 131 */ "Clear" OpHelp(""),
  27665. /* 132 */ "Real" OpHelp("r[P2]=P4"),
  27666. /* 133 */ "ResetSorter" OpHelp(""),
  27667. /* 134 */ "CreateIndex" OpHelp("r[P2]=root iDb=P1"),
  27668. /* 135 */ "CreateTable" OpHelp("r[P2]=root iDb=P1"),
  27669. /* 136 */ "ParseSchema" OpHelp(""),
  27670. /* 137 */ "LoadAnalysis" OpHelp(""),
  27671. /* 138 */ "DropTable" OpHelp(""),
  27672. /* 139 */ "DropIndex" OpHelp(""),
  27673. /* 140 */ "DropTrigger" OpHelp(""),
  27674. /* 141 */ "IntegrityCk" OpHelp(""),
  27675. /* 142 */ "RowSetAdd" OpHelp("rowset(P1)=r[P2]"),
  27676. /* 143 */ "Param" OpHelp(""),
  27677. /* 144 */ "FkCounter" OpHelp("fkctr[P1]+=P2"),
  27678. /* 145 */ "MemMax" OpHelp("r[P1]=max(r[P1],r[P2])"),
  27679. /* 146 */ "OffsetLimit" OpHelp("if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)"),
  27680. /* 147 */ "AggStep0" OpHelp("accum=r[P3] step(r[P2@P5])"),
  27681. /* 148 */ "AggStep" OpHelp("accum=r[P3] step(r[P2@P5])"),
  27682. /* 149 */ "AggFinal" OpHelp("accum=r[P1] N=P2"),
  27683. /* 150 */ "Expire" OpHelp(""),
  27684. /* 151 */ "TableLock" OpHelp("iDb=P1 root=P2 write=P3"),
  27685. /* 152 */ "VBegin" OpHelp(""),
  27686. /* 153 */ "VCreate" OpHelp(""),
  27687. /* 154 */ "VDestroy" OpHelp(""),
  27688. /* 155 */ "VOpen" OpHelp(""),
  27689. /* 156 */ "VColumn" OpHelp("r[P3]=vcolumn(P2)"),
  27690. /* 157 */ "VRename" OpHelp(""),
  27691. /* 158 */ "Pagecount" OpHelp(""),
  27692. /* 159 */ "MaxPgcnt" OpHelp(""),
  27693. /* 160 */ "CursorHint" OpHelp(""),
  27694. /* 161 */ "Noop" OpHelp(""),
  27695. /* 162 */ "Explain" OpHelp(""),
  27696. };
  27697. return azName[i];
  27698. }
  27699. #endif
  27700. /************** End of opcodes.c *********************************************/
  27701. /************** Begin file os_unix.c *****************************************/
  27702. /*
  27703. ** 2004 May 22
  27704. **
  27705. ** The author disclaims copyright to this source code. In place of
  27706. ** a legal notice, here is a blessing:
  27707. **
  27708. ** May you do good and not evil.
  27709. ** May you find forgiveness for yourself and forgive others.
  27710. ** May you share freely, never taking more than you give.
  27711. **
  27712. ******************************************************************************
  27713. **
  27714. ** This file contains the VFS implementation for unix-like operating systems
  27715. ** include Linux, MacOSX, *BSD, QNX, VxWorks, AIX, HPUX, and others.
  27716. **
  27717. ** There are actually several different VFS implementations in this file.
  27718. ** The differences are in the way that file locking is done. The default
  27719. ** implementation uses Posix Advisory Locks. Alternative implementations
  27720. ** use flock(), dot-files, various proprietary locking schemas, or simply
  27721. ** skip locking all together.
  27722. **
  27723. ** This source file is organized into divisions where the logic for various
  27724. ** subfunctions is contained within the appropriate division. PLEASE
  27725. ** KEEP THE STRUCTURE OF THIS FILE INTACT. New code should be placed
  27726. ** in the correct division and should be clearly labeled.
  27727. **
  27728. ** The layout of divisions is as follows:
  27729. **
  27730. ** * General-purpose declarations and utility functions.
  27731. ** * Unique file ID logic used by VxWorks.
  27732. ** * Various locking primitive implementations (all except proxy locking):
  27733. ** + for Posix Advisory Locks
  27734. ** + for no-op locks
  27735. ** + for dot-file locks
  27736. ** + for flock() locking
  27737. ** + for named semaphore locks (VxWorks only)
  27738. ** + for AFP filesystem locks (MacOSX only)
  27739. ** * sqlite3_file methods not associated with locking.
  27740. ** * Definitions of sqlite3_io_methods objects for all locking
  27741. ** methods plus "finder" functions for each locking method.
  27742. ** * sqlite3_vfs method implementations.
  27743. ** * Locking primitives for the proxy uber-locking-method. (MacOSX only)
  27744. ** * Definitions of sqlite3_vfs objects for all locking methods
  27745. ** plus implementations of sqlite3_os_init() and sqlite3_os_end().
  27746. */
  27747. /* #include "sqliteInt.h" */
  27748. #if SQLITE_OS_UNIX /* This file is used on unix only */
  27749. /*
  27750. ** There are various methods for file locking used for concurrency
  27751. ** control:
  27752. **
  27753. ** 1. POSIX locking (the default),
  27754. ** 2. No locking,
  27755. ** 3. Dot-file locking,
  27756. ** 4. flock() locking,
  27757. ** 5. AFP locking (OSX only),
  27758. ** 6. Named POSIX semaphores (VXWorks only),
  27759. ** 7. proxy locking. (OSX only)
  27760. **
  27761. ** Styles 4, 5, and 7 are only available of SQLITE_ENABLE_LOCKING_STYLE
  27762. ** is defined to 1. The SQLITE_ENABLE_LOCKING_STYLE also enables automatic
  27763. ** selection of the appropriate locking style based on the filesystem
  27764. ** where the database is located.
  27765. */
  27766. #if !defined(SQLITE_ENABLE_LOCKING_STYLE)
  27767. # if defined(__APPLE__)
  27768. # define SQLITE_ENABLE_LOCKING_STYLE 1
  27769. # else
  27770. # define SQLITE_ENABLE_LOCKING_STYLE 0
  27771. # endif
  27772. #endif
  27773. /* Use pread() and pwrite() if they are available */
  27774. #if defined(__APPLE__)
  27775. # define HAVE_PREAD 1
  27776. # define HAVE_PWRITE 1
  27777. #endif
  27778. #if defined(HAVE_PREAD64) && defined(HAVE_PWRITE64)
  27779. # undef USE_PREAD
  27780. # define USE_PREAD64 1
  27781. #elif defined(HAVE_PREAD) && defined(HAVE_PWRITE)
  27782. # undef USE_PREAD64
  27783. # define USE_PREAD 1
  27784. #endif
  27785. /*
  27786. ** standard include files.
  27787. */
  27788. #include <sys/types.h>
  27789. #include <sys/stat.h>
  27790. #include <fcntl.h>
  27791. #include <unistd.h>
  27792. /* #include <time.h> */
  27793. #include <sys/time.h>
  27794. #include <errno.h>
  27795. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  27796. # include <sys/mman.h>
  27797. #endif
  27798. #if SQLITE_ENABLE_LOCKING_STYLE
  27799. # include <sys/ioctl.h>
  27800. # include <sys/file.h>
  27801. # include <sys/param.h>
  27802. #endif /* SQLITE_ENABLE_LOCKING_STYLE */
  27803. #if defined(__APPLE__) && ((__MAC_OS_X_VERSION_MIN_REQUIRED > 1050) || \
  27804. (__IPHONE_OS_VERSION_MIN_REQUIRED > 2000))
  27805. # if (!defined(TARGET_OS_EMBEDDED) || (TARGET_OS_EMBEDDED==0)) \
  27806. && (!defined(TARGET_IPHONE_SIMULATOR) || (TARGET_IPHONE_SIMULATOR==0))
  27807. # define HAVE_GETHOSTUUID 1
  27808. # else
  27809. # warning "gethostuuid() is disabled."
  27810. # endif
  27811. #endif
  27812. #if OS_VXWORKS
  27813. /* # include <sys/ioctl.h> */
  27814. # include <semaphore.h>
  27815. # include <limits.h>
  27816. #endif /* OS_VXWORKS */
  27817. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  27818. # include <sys/mount.h>
  27819. #endif
  27820. #ifdef HAVE_UTIME
  27821. # include <utime.h>
  27822. #endif
  27823. /*
  27824. ** Allowed values of unixFile.fsFlags
  27825. */
  27826. #define SQLITE_FSFLAGS_IS_MSDOS 0x1
  27827. /*
  27828. ** If we are to be thread-safe, include the pthreads header and define
  27829. ** the SQLITE_UNIX_THREADS macro.
  27830. */
  27831. #if SQLITE_THREADSAFE
  27832. /* # include <pthread.h> */
  27833. # define SQLITE_UNIX_THREADS 1
  27834. #endif
  27835. /*
  27836. ** Default permissions when creating a new file
  27837. */
  27838. #ifndef SQLITE_DEFAULT_FILE_PERMISSIONS
  27839. # define SQLITE_DEFAULT_FILE_PERMISSIONS 0644
  27840. #endif
  27841. /*
  27842. ** Default permissions when creating auto proxy dir
  27843. */
  27844. #ifndef SQLITE_DEFAULT_PROXYDIR_PERMISSIONS
  27845. # define SQLITE_DEFAULT_PROXYDIR_PERMISSIONS 0755
  27846. #endif
  27847. /*
  27848. ** Maximum supported path-length.
  27849. */
  27850. #define MAX_PATHNAME 512
  27851. /*
  27852. ** Maximum supported symbolic links
  27853. */
  27854. #define SQLITE_MAX_SYMLINKS 100
  27855. /* Always cast the getpid() return type for compatibility with
  27856. ** kernel modules in VxWorks. */
  27857. #define osGetpid(X) (pid_t)getpid()
  27858. /*
  27859. ** Only set the lastErrno if the error code is a real error and not
  27860. ** a normal expected return code of SQLITE_BUSY or SQLITE_OK
  27861. */
  27862. #define IS_LOCK_ERROR(x) ((x != SQLITE_OK) && (x != SQLITE_BUSY))
  27863. /* Forward references */
  27864. typedef struct unixShm unixShm; /* Connection shared memory */
  27865. typedef struct unixShmNode unixShmNode; /* Shared memory instance */
  27866. typedef struct unixInodeInfo unixInodeInfo; /* An i-node */
  27867. typedef struct UnixUnusedFd UnixUnusedFd; /* An unused file descriptor */
  27868. /*
  27869. ** Sometimes, after a file handle is closed by SQLite, the file descriptor
  27870. ** cannot be closed immediately. In these cases, instances of the following
  27871. ** structure are used to store the file descriptor while waiting for an
  27872. ** opportunity to either close or reuse it.
  27873. */
  27874. struct UnixUnusedFd {
  27875. int fd; /* File descriptor to close */
  27876. int flags; /* Flags this file descriptor was opened with */
  27877. UnixUnusedFd *pNext; /* Next unused file descriptor on same file */
  27878. };
  27879. /*
  27880. ** The unixFile structure is subclass of sqlite3_file specific to the unix
  27881. ** VFS implementations.
  27882. */
  27883. typedef struct unixFile unixFile;
  27884. struct unixFile {
  27885. sqlite3_io_methods const *pMethod; /* Always the first entry */
  27886. sqlite3_vfs *pVfs; /* The VFS that created this unixFile */
  27887. unixInodeInfo *pInode; /* Info about locks on this inode */
  27888. int h; /* The file descriptor */
  27889. unsigned char eFileLock; /* The type of lock held on this fd */
  27890. unsigned short int ctrlFlags; /* Behavioral bits. UNIXFILE_* flags */
  27891. int lastErrno; /* The unix errno from last I/O error */
  27892. void *lockingContext; /* Locking style specific state */
  27893. UnixUnusedFd *pUnused; /* Pre-allocated UnixUnusedFd */
  27894. const char *zPath; /* Name of the file */
  27895. unixShm *pShm; /* Shared memory segment information */
  27896. int szChunk; /* Configured by FCNTL_CHUNK_SIZE */
  27897. #if SQLITE_MAX_MMAP_SIZE>0
  27898. int nFetchOut; /* Number of outstanding xFetch refs */
  27899. sqlite3_int64 mmapSize; /* Usable size of mapping at pMapRegion */
  27900. sqlite3_int64 mmapSizeActual; /* Actual size of mapping at pMapRegion */
  27901. sqlite3_int64 mmapSizeMax; /* Configured FCNTL_MMAP_SIZE value */
  27902. void *pMapRegion; /* Memory mapped region */
  27903. #endif
  27904. #ifdef __QNXNTO__
  27905. int sectorSize; /* Device sector size */
  27906. int deviceCharacteristics; /* Precomputed device characteristics */
  27907. #endif
  27908. #if SQLITE_ENABLE_LOCKING_STYLE
  27909. int openFlags; /* The flags specified at open() */
  27910. #endif
  27911. #if SQLITE_ENABLE_LOCKING_STYLE || defined(__APPLE__)
  27912. unsigned fsFlags; /* cached details from statfs() */
  27913. #endif
  27914. #if OS_VXWORKS
  27915. struct vxworksFileId *pId; /* Unique file ID */
  27916. #endif
  27917. #ifdef SQLITE_DEBUG
  27918. /* The next group of variables are used to track whether or not the
  27919. ** transaction counter in bytes 24-27 of database files are updated
  27920. ** whenever any part of the database changes. An assertion fault will
  27921. ** occur if a file is updated without also updating the transaction
  27922. ** counter. This test is made to avoid new problems similar to the
  27923. ** one described by ticket #3584.
  27924. */
  27925. unsigned char transCntrChng; /* True if the transaction counter changed */
  27926. unsigned char dbUpdate; /* True if any part of database file changed */
  27927. unsigned char inNormalWrite; /* True if in a normal write operation */
  27928. #endif
  27929. #ifdef SQLITE_TEST
  27930. /* In test mode, increase the size of this structure a bit so that
  27931. ** it is larger than the struct CrashFile defined in test6.c.
  27932. */
  27933. char aPadding[32];
  27934. #endif
  27935. };
  27936. /* This variable holds the process id (pid) from when the xRandomness()
  27937. ** method was called. If xOpen() is called from a different process id,
  27938. ** indicating that a fork() has occurred, the PRNG will be reset.
  27939. */
  27940. static pid_t randomnessPid = 0;
  27941. /*
  27942. ** Allowed values for the unixFile.ctrlFlags bitmask:
  27943. */
  27944. #define UNIXFILE_EXCL 0x01 /* Connections from one process only */
  27945. #define UNIXFILE_RDONLY 0x02 /* Connection is read only */
  27946. #define UNIXFILE_PERSIST_WAL 0x04 /* Persistent WAL mode */
  27947. #ifndef SQLITE_DISABLE_DIRSYNC
  27948. # define UNIXFILE_DIRSYNC 0x08 /* Directory sync needed */
  27949. #else
  27950. # define UNIXFILE_DIRSYNC 0x00
  27951. #endif
  27952. #define UNIXFILE_PSOW 0x10 /* SQLITE_IOCAP_POWERSAFE_OVERWRITE */
  27953. #define UNIXFILE_DELETE 0x20 /* Delete on close */
  27954. #define UNIXFILE_URI 0x40 /* Filename might have query parameters */
  27955. #define UNIXFILE_NOLOCK 0x80 /* Do no file locking */
  27956. /*
  27957. ** Include code that is common to all os_*.c files
  27958. */
  27959. /************** Include os_common.h in the middle of os_unix.c ***************/
  27960. /************** Begin file os_common.h ***************************************/
  27961. /*
  27962. ** 2004 May 22
  27963. **
  27964. ** The author disclaims copyright to this source code. In place of
  27965. ** a legal notice, here is a blessing:
  27966. **
  27967. ** May you do good and not evil.
  27968. ** May you find forgiveness for yourself and forgive others.
  27969. ** May you share freely, never taking more than you give.
  27970. **
  27971. ******************************************************************************
  27972. **
  27973. ** This file contains macros and a little bit of code that is common to
  27974. ** all of the platform-specific files (os_*.c) and is #included into those
  27975. ** files.
  27976. **
  27977. ** This file should be #included by the os_*.c files only. It is not a
  27978. ** general purpose header file.
  27979. */
  27980. #ifndef _OS_COMMON_H_
  27981. #define _OS_COMMON_H_
  27982. /*
  27983. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  27984. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  27985. ** switch. The following code should catch this problem at compile-time.
  27986. */
  27987. #ifdef MEMORY_DEBUG
  27988. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  27989. #endif
  27990. /*
  27991. ** Macros for performance tracing. Normally turned off. Only works
  27992. ** on i486 hardware.
  27993. */
  27994. #ifdef SQLITE_PERFORMANCE_TRACE
  27995. /*
  27996. ** hwtime.h contains inline assembler code for implementing
  27997. ** high-performance timing routines.
  27998. */
  27999. /************** Include hwtime.h in the middle of os_common.h ****************/
  28000. /************** Begin file hwtime.h ******************************************/
  28001. /*
  28002. ** 2008 May 27
  28003. **
  28004. ** The author disclaims copyright to this source code. In place of
  28005. ** a legal notice, here is a blessing:
  28006. **
  28007. ** May you do good and not evil.
  28008. ** May you find forgiveness for yourself and forgive others.
  28009. ** May you share freely, never taking more than you give.
  28010. **
  28011. ******************************************************************************
  28012. **
  28013. ** This file contains inline asm code for retrieving "high-performance"
  28014. ** counters for x86 class CPUs.
  28015. */
  28016. #ifndef SQLITE_HWTIME_H
  28017. #define SQLITE_HWTIME_H
  28018. /*
  28019. ** The following routine only works on pentium-class (or newer) processors.
  28020. ** It uses the RDTSC opcode to read the cycle count value out of the
  28021. ** processor and returns that value. This can be used for high-res
  28022. ** profiling.
  28023. */
  28024. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  28025. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  28026. #if defined(__GNUC__)
  28027. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  28028. unsigned int lo, hi;
  28029. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  28030. return (sqlite_uint64)hi << 32 | lo;
  28031. }
  28032. #elif defined(_MSC_VER)
  28033. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  28034. __asm {
  28035. rdtsc
  28036. ret ; return value at EDX:EAX
  28037. }
  28038. }
  28039. #endif
  28040. #elif (defined(__GNUC__) && defined(__x86_64__))
  28041. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  28042. unsigned long val;
  28043. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  28044. return val;
  28045. }
  28046. #elif (defined(__GNUC__) && defined(__ppc__))
  28047. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  28048. unsigned long long retval;
  28049. unsigned long junk;
  28050. __asm__ __volatile__ ("\n\
  28051. 1: mftbu %1\n\
  28052. mftb %L0\n\
  28053. mftbu %0\n\
  28054. cmpw %0,%1\n\
  28055. bne 1b"
  28056. : "=r" (retval), "=r" (junk));
  28057. return retval;
  28058. }
  28059. #else
  28060. #error Need implementation of sqlite3Hwtime() for your platform.
  28061. /*
  28062. ** To compile without implementing sqlite3Hwtime() for your platform,
  28063. ** you can remove the above #error and use the following
  28064. ** stub function. You will lose timing support for many
  28065. ** of the debugging and testing utilities, but it should at
  28066. ** least compile and run.
  28067. */
  28068. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  28069. #endif
  28070. #endif /* !defined(SQLITE_HWTIME_H) */
  28071. /************** End of hwtime.h **********************************************/
  28072. /************** Continuing where we left off in os_common.h ******************/
  28073. static sqlite_uint64 g_start;
  28074. static sqlite_uint64 g_elapsed;
  28075. #define TIMER_START g_start=sqlite3Hwtime()
  28076. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  28077. #define TIMER_ELAPSED g_elapsed
  28078. #else
  28079. #define TIMER_START
  28080. #define TIMER_END
  28081. #define TIMER_ELAPSED ((sqlite_uint64)0)
  28082. #endif
  28083. /*
  28084. ** If we compile with the SQLITE_TEST macro set, then the following block
  28085. ** of code will give us the ability to simulate a disk I/O error. This
  28086. ** is used for testing the I/O recovery logic.
  28087. */
  28088. #if defined(SQLITE_TEST)
  28089. SQLITE_API extern int sqlite3_io_error_hit;
  28090. SQLITE_API extern int sqlite3_io_error_hardhit;
  28091. SQLITE_API extern int sqlite3_io_error_pending;
  28092. SQLITE_API extern int sqlite3_io_error_persist;
  28093. SQLITE_API extern int sqlite3_io_error_benign;
  28094. SQLITE_API extern int sqlite3_diskfull_pending;
  28095. SQLITE_API extern int sqlite3_diskfull;
  28096. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  28097. #define SimulateIOError(CODE) \
  28098. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  28099. || sqlite3_io_error_pending-- == 1 ) \
  28100. { local_ioerr(); CODE; }
  28101. static void local_ioerr(){
  28102. IOTRACE(("IOERR\n"));
  28103. sqlite3_io_error_hit++;
  28104. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  28105. }
  28106. #define SimulateDiskfullError(CODE) \
  28107. if( sqlite3_diskfull_pending ){ \
  28108. if( sqlite3_diskfull_pending == 1 ){ \
  28109. local_ioerr(); \
  28110. sqlite3_diskfull = 1; \
  28111. sqlite3_io_error_hit = 1; \
  28112. CODE; \
  28113. }else{ \
  28114. sqlite3_diskfull_pending--; \
  28115. } \
  28116. }
  28117. #else
  28118. #define SimulateIOErrorBenign(X)
  28119. #define SimulateIOError(A)
  28120. #define SimulateDiskfullError(A)
  28121. #endif /* defined(SQLITE_TEST) */
  28122. /*
  28123. ** When testing, keep a count of the number of open files.
  28124. */
  28125. #if defined(SQLITE_TEST)
  28126. SQLITE_API extern int sqlite3_open_file_count;
  28127. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  28128. #else
  28129. #define OpenCounter(X)
  28130. #endif /* defined(SQLITE_TEST) */
  28131. #endif /* !defined(_OS_COMMON_H_) */
  28132. /************** End of os_common.h *******************************************/
  28133. /************** Continuing where we left off in os_unix.c ********************/
  28134. /*
  28135. ** Define various macros that are missing from some systems.
  28136. */
  28137. #ifndef O_LARGEFILE
  28138. # define O_LARGEFILE 0
  28139. #endif
  28140. #ifdef SQLITE_DISABLE_LFS
  28141. # undef O_LARGEFILE
  28142. # define O_LARGEFILE 0
  28143. #endif
  28144. #ifndef O_NOFOLLOW
  28145. # define O_NOFOLLOW 0
  28146. #endif
  28147. #ifndef O_BINARY
  28148. # define O_BINARY 0
  28149. #endif
  28150. /*
  28151. ** The threadid macro resolves to the thread-id or to 0. Used for
  28152. ** testing and debugging only.
  28153. */
  28154. #if SQLITE_THREADSAFE
  28155. #define threadid pthread_self()
  28156. #else
  28157. #define threadid 0
  28158. #endif
  28159. /*
  28160. ** HAVE_MREMAP defaults to true on Linux and false everywhere else.
  28161. */
  28162. #if !defined(HAVE_MREMAP)
  28163. # if defined(__linux__) && defined(_GNU_SOURCE)
  28164. # define HAVE_MREMAP 1
  28165. # else
  28166. # define HAVE_MREMAP 0
  28167. # endif
  28168. #endif
  28169. /*
  28170. ** Explicitly call the 64-bit version of lseek() on Android. Otherwise, lseek()
  28171. ** is the 32-bit version, even if _FILE_OFFSET_BITS=64 is defined.
  28172. */
  28173. #ifdef __ANDROID__
  28174. # define lseek lseek64
  28175. #endif
  28176. /*
  28177. ** Different Unix systems declare open() in different ways. Same use
  28178. ** open(const char*,int,mode_t). Others use open(const char*,int,...).
  28179. ** The difference is important when using a pointer to the function.
  28180. **
  28181. ** The safest way to deal with the problem is to always use this wrapper
  28182. ** which always has the same well-defined interface.
  28183. */
  28184. static int posixOpen(const char *zFile, int flags, int mode){
  28185. return open(zFile, flags, mode);
  28186. }
  28187. /* Forward reference */
  28188. static int openDirectory(const char*, int*);
  28189. static int unixGetpagesize(void);
  28190. /*
  28191. ** Many system calls are accessed through pointer-to-functions so that
  28192. ** they may be overridden at runtime to facilitate fault injection during
  28193. ** testing and sandboxing. The following array holds the names and pointers
  28194. ** to all overrideable system calls.
  28195. */
  28196. static struct unix_syscall {
  28197. const char *zName; /* Name of the system call */
  28198. sqlite3_syscall_ptr pCurrent; /* Current value of the system call */
  28199. sqlite3_syscall_ptr pDefault; /* Default value */
  28200. } aSyscall[] = {
  28201. { "open", (sqlite3_syscall_ptr)posixOpen, 0 },
  28202. #define osOpen ((int(*)(const char*,int,int))aSyscall[0].pCurrent)
  28203. { "close", (sqlite3_syscall_ptr)close, 0 },
  28204. #define osClose ((int(*)(int))aSyscall[1].pCurrent)
  28205. { "access", (sqlite3_syscall_ptr)access, 0 },
  28206. #define osAccess ((int(*)(const char*,int))aSyscall[2].pCurrent)
  28207. { "getcwd", (sqlite3_syscall_ptr)getcwd, 0 },
  28208. #define osGetcwd ((char*(*)(char*,size_t))aSyscall[3].pCurrent)
  28209. { "stat", (sqlite3_syscall_ptr)stat, 0 },
  28210. #define osStat ((int(*)(const char*,struct stat*))aSyscall[4].pCurrent)
  28211. /*
  28212. ** The DJGPP compiler environment looks mostly like Unix, but it
  28213. ** lacks the fcntl() system call. So redefine fcntl() to be something
  28214. ** that always succeeds. This means that locking does not occur under
  28215. ** DJGPP. But it is DOS - what did you expect?
  28216. */
  28217. #ifdef __DJGPP__
  28218. { "fstat", 0, 0 },
  28219. #define osFstat(a,b,c) 0
  28220. #else
  28221. { "fstat", (sqlite3_syscall_ptr)fstat, 0 },
  28222. #define osFstat ((int(*)(int,struct stat*))aSyscall[5].pCurrent)
  28223. #endif
  28224. { "ftruncate", (sqlite3_syscall_ptr)ftruncate, 0 },
  28225. #define osFtruncate ((int(*)(int,off_t))aSyscall[6].pCurrent)
  28226. { "fcntl", (sqlite3_syscall_ptr)fcntl, 0 },
  28227. #define osFcntl ((int(*)(int,int,...))aSyscall[7].pCurrent)
  28228. { "read", (sqlite3_syscall_ptr)read, 0 },
  28229. #define osRead ((ssize_t(*)(int,void*,size_t))aSyscall[8].pCurrent)
  28230. #if defined(USE_PREAD) || SQLITE_ENABLE_LOCKING_STYLE
  28231. { "pread", (sqlite3_syscall_ptr)pread, 0 },
  28232. #else
  28233. { "pread", (sqlite3_syscall_ptr)0, 0 },
  28234. #endif
  28235. #define osPread ((ssize_t(*)(int,void*,size_t,off_t))aSyscall[9].pCurrent)
  28236. #if defined(USE_PREAD64)
  28237. { "pread64", (sqlite3_syscall_ptr)pread64, 0 },
  28238. #else
  28239. { "pread64", (sqlite3_syscall_ptr)0, 0 },
  28240. #endif
  28241. #define osPread64 ((ssize_t(*)(int,void*,size_t,off64_t))aSyscall[10].pCurrent)
  28242. { "write", (sqlite3_syscall_ptr)write, 0 },
  28243. #define osWrite ((ssize_t(*)(int,const void*,size_t))aSyscall[11].pCurrent)
  28244. #if defined(USE_PREAD) || SQLITE_ENABLE_LOCKING_STYLE
  28245. { "pwrite", (sqlite3_syscall_ptr)pwrite, 0 },
  28246. #else
  28247. { "pwrite", (sqlite3_syscall_ptr)0, 0 },
  28248. #endif
  28249. #define osPwrite ((ssize_t(*)(int,const void*,size_t,off_t))\
  28250. aSyscall[12].pCurrent)
  28251. #if defined(USE_PREAD64)
  28252. { "pwrite64", (sqlite3_syscall_ptr)pwrite64, 0 },
  28253. #else
  28254. { "pwrite64", (sqlite3_syscall_ptr)0, 0 },
  28255. #endif
  28256. #define osPwrite64 ((ssize_t(*)(int,const void*,size_t,off64_t))\
  28257. aSyscall[13].pCurrent)
  28258. { "fchmod", (sqlite3_syscall_ptr)fchmod, 0 },
  28259. #define osFchmod ((int(*)(int,mode_t))aSyscall[14].pCurrent)
  28260. #if defined(HAVE_POSIX_FALLOCATE) && HAVE_POSIX_FALLOCATE
  28261. { "fallocate", (sqlite3_syscall_ptr)posix_fallocate, 0 },
  28262. #else
  28263. { "fallocate", (sqlite3_syscall_ptr)0, 0 },
  28264. #endif
  28265. #define osFallocate ((int(*)(int,off_t,off_t))aSyscall[15].pCurrent)
  28266. { "unlink", (sqlite3_syscall_ptr)unlink, 0 },
  28267. #define osUnlink ((int(*)(const char*))aSyscall[16].pCurrent)
  28268. { "openDirectory", (sqlite3_syscall_ptr)openDirectory, 0 },
  28269. #define osOpenDirectory ((int(*)(const char*,int*))aSyscall[17].pCurrent)
  28270. { "mkdir", (sqlite3_syscall_ptr)mkdir, 0 },
  28271. #define osMkdir ((int(*)(const char*,mode_t))aSyscall[18].pCurrent)
  28272. { "rmdir", (sqlite3_syscall_ptr)rmdir, 0 },
  28273. #define osRmdir ((int(*)(const char*))aSyscall[19].pCurrent)
  28274. #if defined(HAVE_FCHOWN)
  28275. { "fchown", (sqlite3_syscall_ptr)fchown, 0 },
  28276. #else
  28277. { "fchown", (sqlite3_syscall_ptr)0, 0 },
  28278. #endif
  28279. #define osFchown ((int(*)(int,uid_t,gid_t))aSyscall[20].pCurrent)
  28280. { "geteuid", (sqlite3_syscall_ptr)geteuid, 0 },
  28281. #define osGeteuid ((uid_t(*)(void))aSyscall[21].pCurrent)
  28282. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  28283. { "mmap", (sqlite3_syscall_ptr)mmap, 0 },
  28284. #else
  28285. { "mmap", (sqlite3_syscall_ptr)0, 0 },
  28286. #endif
  28287. #define osMmap ((void*(*)(void*,size_t,int,int,int,off_t))aSyscall[22].pCurrent)
  28288. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  28289. { "munmap", (sqlite3_syscall_ptr)munmap, 0 },
  28290. #else
  28291. { "munmap", (sqlite3_syscall_ptr)0, 0 },
  28292. #endif
  28293. #define osMunmap ((void*(*)(void*,size_t))aSyscall[23].pCurrent)
  28294. #if HAVE_MREMAP && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  28295. { "mremap", (sqlite3_syscall_ptr)mremap, 0 },
  28296. #else
  28297. { "mremap", (sqlite3_syscall_ptr)0, 0 },
  28298. #endif
  28299. #define osMremap ((void*(*)(void*,size_t,size_t,int,...))aSyscall[24].pCurrent)
  28300. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  28301. { "getpagesize", (sqlite3_syscall_ptr)unixGetpagesize, 0 },
  28302. #else
  28303. { "getpagesize", (sqlite3_syscall_ptr)0, 0 },
  28304. #endif
  28305. #define osGetpagesize ((int(*)(void))aSyscall[25].pCurrent)
  28306. #if defined(HAVE_READLINK)
  28307. { "readlink", (sqlite3_syscall_ptr)readlink, 0 },
  28308. #else
  28309. { "readlink", (sqlite3_syscall_ptr)0, 0 },
  28310. #endif
  28311. #define osReadlink ((ssize_t(*)(const char*,char*,size_t))aSyscall[26].pCurrent)
  28312. #if defined(HAVE_LSTAT)
  28313. { "lstat", (sqlite3_syscall_ptr)lstat, 0 },
  28314. #else
  28315. { "lstat", (sqlite3_syscall_ptr)0, 0 },
  28316. #endif
  28317. #define osLstat ((int(*)(const char*,struct stat*))aSyscall[27].pCurrent)
  28318. }; /* End of the overrideable system calls */
  28319. /*
  28320. ** On some systems, calls to fchown() will trigger a message in a security
  28321. ** log if they come from non-root processes. So avoid calling fchown() if
  28322. ** we are not running as root.
  28323. */
  28324. static int robustFchown(int fd, uid_t uid, gid_t gid){
  28325. #if defined(HAVE_FCHOWN)
  28326. return osGeteuid() ? 0 : osFchown(fd,uid,gid);
  28327. #else
  28328. return 0;
  28329. #endif
  28330. }
  28331. /*
  28332. ** This is the xSetSystemCall() method of sqlite3_vfs for all of the
  28333. ** "unix" VFSes. Return SQLITE_OK opon successfully updating the
  28334. ** system call pointer, or SQLITE_NOTFOUND if there is no configurable
  28335. ** system call named zName.
  28336. */
  28337. static int unixSetSystemCall(
  28338. sqlite3_vfs *pNotUsed, /* The VFS pointer. Not used */
  28339. const char *zName, /* Name of system call to override */
  28340. sqlite3_syscall_ptr pNewFunc /* Pointer to new system call value */
  28341. ){
  28342. unsigned int i;
  28343. int rc = SQLITE_NOTFOUND;
  28344. UNUSED_PARAMETER(pNotUsed);
  28345. if( zName==0 ){
  28346. /* If no zName is given, restore all system calls to their default
  28347. ** settings and return NULL
  28348. */
  28349. rc = SQLITE_OK;
  28350. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  28351. if( aSyscall[i].pDefault ){
  28352. aSyscall[i].pCurrent = aSyscall[i].pDefault;
  28353. }
  28354. }
  28355. }else{
  28356. /* If zName is specified, operate on only the one system call
  28357. ** specified.
  28358. */
  28359. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  28360. if( strcmp(zName, aSyscall[i].zName)==0 ){
  28361. if( aSyscall[i].pDefault==0 ){
  28362. aSyscall[i].pDefault = aSyscall[i].pCurrent;
  28363. }
  28364. rc = SQLITE_OK;
  28365. if( pNewFunc==0 ) pNewFunc = aSyscall[i].pDefault;
  28366. aSyscall[i].pCurrent = pNewFunc;
  28367. break;
  28368. }
  28369. }
  28370. }
  28371. return rc;
  28372. }
  28373. /*
  28374. ** Return the value of a system call. Return NULL if zName is not a
  28375. ** recognized system call name. NULL is also returned if the system call
  28376. ** is currently undefined.
  28377. */
  28378. static sqlite3_syscall_ptr unixGetSystemCall(
  28379. sqlite3_vfs *pNotUsed,
  28380. const char *zName
  28381. ){
  28382. unsigned int i;
  28383. UNUSED_PARAMETER(pNotUsed);
  28384. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  28385. if( strcmp(zName, aSyscall[i].zName)==0 ) return aSyscall[i].pCurrent;
  28386. }
  28387. return 0;
  28388. }
  28389. /*
  28390. ** Return the name of the first system call after zName. If zName==NULL
  28391. ** then return the name of the first system call. Return NULL if zName
  28392. ** is the last system call or if zName is not the name of a valid
  28393. ** system call.
  28394. */
  28395. static const char *unixNextSystemCall(sqlite3_vfs *p, const char *zName){
  28396. int i = -1;
  28397. UNUSED_PARAMETER(p);
  28398. if( zName ){
  28399. for(i=0; i<ArraySize(aSyscall)-1; i++){
  28400. if( strcmp(zName, aSyscall[i].zName)==0 ) break;
  28401. }
  28402. }
  28403. for(i++; i<ArraySize(aSyscall); i++){
  28404. if( aSyscall[i].pCurrent!=0 ) return aSyscall[i].zName;
  28405. }
  28406. return 0;
  28407. }
  28408. /*
  28409. ** Do not accept any file descriptor less than this value, in order to avoid
  28410. ** opening database file using file descriptors that are commonly used for
  28411. ** standard input, output, and error.
  28412. */
  28413. #ifndef SQLITE_MINIMUM_FILE_DESCRIPTOR
  28414. # define SQLITE_MINIMUM_FILE_DESCRIPTOR 3
  28415. #endif
  28416. /*
  28417. ** Invoke open(). Do so multiple times, until it either succeeds or
  28418. ** fails for some reason other than EINTR.
  28419. **
  28420. ** If the file creation mode "m" is 0 then set it to the default for
  28421. ** SQLite. The default is SQLITE_DEFAULT_FILE_PERMISSIONS (normally
  28422. ** 0644) as modified by the system umask. If m is not 0, then
  28423. ** make the file creation mode be exactly m ignoring the umask.
  28424. **
  28425. ** The m parameter will be non-zero only when creating -wal, -journal,
  28426. ** and -shm files. We want those files to have *exactly* the same
  28427. ** permissions as their original database, unadulterated by the umask.
  28428. ** In that way, if a database file is -rw-rw-rw or -rw-rw-r-, and a
  28429. ** transaction crashes and leaves behind hot journals, then any
  28430. ** process that is able to write to the database will also be able to
  28431. ** recover the hot journals.
  28432. */
  28433. static int robust_open(const char *z, int f, mode_t m){
  28434. int fd;
  28435. mode_t m2 = m ? m : SQLITE_DEFAULT_FILE_PERMISSIONS;
  28436. while(1){
  28437. #if defined(O_CLOEXEC)
  28438. fd = osOpen(z,f|O_CLOEXEC,m2);
  28439. #else
  28440. fd = osOpen(z,f,m2);
  28441. #endif
  28442. if( fd<0 ){
  28443. if( errno==EINTR ) continue;
  28444. break;
  28445. }
  28446. if( fd>=SQLITE_MINIMUM_FILE_DESCRIPTOR ) break;
  28447. osClose(fd);
  28448. sqlite3_log(SQLITE_WARNING,
  28449. "attempt to open \"%s\" as file descriptor %d", z, fd);
  28450. fd = -1;
  28451. if( osOpen("/dev/null", f, m)<0 ) break;
  28452. }
  28453. if( fd>=0 ){
  28454. if( m!=0 ){
  28455. struct stat statbuf;
  28456. if( osFstat(fd, &statbuf)==0
  28457. && statbuf.st_size==0
  28458. && (statbuf.st_mode&0777)!=m
  28459. ){
  28460. osFchmod(fd, m);
  28461. }
  28462. }
  28463. #if defined(FD_CLOEXEC) && (!defined(O_CLOEXEC) || O_CLOEXEC==0)
  28464. osFcntl(fd, F_SETFD, osFcntl(fd, F_GETFD, 0) | FD_CLOEXEC);
  28465. #endif
  28466. }
  28467. return fd;
  28468. }
  28469. /*
  28470. ** Helper functions to obtain and relinquish the global mutex. The
  28471. ** global mutex is used to protect the unixInodeInfo and
  28472. ** vxworksFileId objects used by this file, all of which may be
  28473. ** shared by multiple threads.
  28474. **
  28475. ** Function unixMutexHeld() is used to assert() that the global mutex
  28476. ** is held when required. This function is only used as part of assert()
  28477. ** statements. e.g.
  28478. **
  28479. ** unixEnterMutex()
  28480. ** assert( unixMutexHeld() );
  28481. ** unixEnterLeave()
  28482. */
  28483. static void unixEnterMutex(void){
  28484. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  28485. }
  28486. static void unixLeaveMutex(void){
  28487. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  28488. }
  28489. #ifdef SQLITE_DEBUG
  28490. static int unixMutexHeld(void) {
  28491. return sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  28492. }
  28493. #endif
  28494. #ifdef SQLITE_HAVE_OS_TRACE
  28495. /*
  28496. ** Helper function for printing out trace information from debugging
  28497. ** binaries. This returns the string representation of the supplied
  28498. ** integer lock-type.
  28499. */
  28500. static const char *azFileLock(int eFileLock){
  28501. switch( eFileLock ){
  28502. case NO_LOCK: return "NONE";
  28503. case SHARED_LOCK: return "SHARED";
  28504. case RESERVED_LOCK: return "RESERVED";
  28505. case PENDING_LOCK: return "PENDING";
  28506. case EXCLUSIVE_LOCK: return "EXCLUSIVE";
  28507. }
  28508. return "ERROR";
  28509. }
  28510. #endif
  28511. #ifdef SQLITE_LOCK_TRACE
  28512. /*
  28513. ** Print out information about all locking operations.
  28514. **
  28515. ** This routine is used for troubleshooting locks on multithreaded
  28516. ** platforms. Enable by compiling with the -DSQLITE_LOCK_TRACE
  28517. ** command-line option on the compiler. This code is normally
  28518. ** turned off.
  28519. */
  28520. static int lockTrace(int fd, int op, struct flock *p){
  28521. char *zOpName, *zType;
  28522. int s;
  28523. int savedErrno;
  28524. if( op==F_GETLK ){
  28525. zOpName = "GETLK";
  28526. }else if( op==F_SETLK ){
  28527. zOpName = "SETLK";
  28528. }else{
  28529. s = osFcntl(fd, op, p);
  28530. sqlite3DebugPrintf("fcntl unknown %d %d %d\n", fd, op, s);
  28531. return s;
  28532. }
  28533. if( p->l_type==F_RDLCK ){
  28534. zType = "RDLCK";
  28535. }else if( p->l_type==F_WRLCK ){
  28536. zType = "WRLCK";
  28537. }else if( p->l_type==F_UNLCK ){
  28538. zType = "UNLCK";
  28539. }else{
  28540. assert( 0 );
  28541. }
  28542. assert( p->l_whence==SEEK_SET );
  28543. s = osFcntl(fd, op, p);
  28544. savedErrno = errno;
  28545. sqlite3DebugPrintf("fcntl %d %d %s %s %d %d %d %d\n",
  28546. threadid, fd, zOpName, zType, (int)p->l_start, (int)p->l_len,
  28547. (int)p->l_pid, s);
  28548. if( s==(-1) && op==F_SETLK && (p->l_type==F_RDLCK || p->l_type==F_WRLCK) ){
  28549. struct flock l2;
  28550. l2 = *p;
  28551. osFcntl(fd, F_GETLK, &l2);
  28552. if( l2.l_type==F_RDLCK ){
  28553. zType = "RDLCK";
  28554. }else if( l2.l_type==F_WRLCK ){
  28555. zType = "WRLCK";
  28556. }else if( l2.l_type==F_UNLCK ){
  28557. zType = "UNLCK";
  28558. }else{
  28559. assert( 0 );
  28560. }
  28561. sqlite3DebugPrintf("fcntl-failure-reason: %s %d %d %d\n",
  28562. zType, (int)l2.l_start, (int)l2.l_len, (int)l2.l_pid);
  28563. }
  28564. errno = savedErrno;
  28565. return s;
  28566. }
  28567. #undef osFcntl
  28568. #define osFcntl lockTrace
  28569. #endif /* SQLITE_LOCK_TRACE */
  28570. /*
  28571. ** Retry ftruncate() calls that fail due to EINTR
  28572. **
  28573. ** All calls to ftruncate() within this file should be made through
  28574. ** this wrapper. On the Android platform, bypassing the logic below
  28575. ** could lead to a corrupt database.
  28576. */
  28577. static int robust_ftruncate(int h, sqlite3_int64 sz){
  28578. int rc;
  28579. #ifdef __ANDROID__
  28580. /* On Android, ftruncate() always uses 32-bit offsets, even if
  28581. ** _FILE_OFFSET_BITS=64 is defined. This means it is unsafe to attempt to
  28582. ** truncate a file to any size larger than 2GiB. Silently ignore any
  28583. ** such attempts. */
  28584. if( sz>(sqlite3_int64)0x7FFFFFFF ){
  28585. rc = SQLITE_OK;
  28586. }else
  28587. #endif
  28588. do{ rc = osFtruncate(h,sz); }while( rc<0 && errno==EINTR );
  28589. return rc;
  28590. }
  28591. /*
  28592. ** This routine translates a standard POSIX errno code into something
  28593. ** useful to the clients of the sqlite3 functions. Specifically, it is
  28594. ** intended to translate a variety of "try again" errors into SQLITE_BUSY
  28595. ** and a variety of "please close the file descriptor NOW" errors into
  28596. ** SQLITE_IOERR
  28597. **
  28598. ** Errors during initialization of locks, or file system support for locks,
  28599. ** should handle ENOLCK, ENOTSUP, EOPNOTSUPP separately.
  28600. */
  28601. static int sqliteErrorFromPosixError(int posixError, int sqliteIOErr) {
  28602. assert( (sqliteIOErr == SQLITE_IOERR_LOCK) ||
  28603. (sqliteIOErr == SQLITE_IOERR_UNLOCK) ||
  28604. (sqliteIOErr == SQLITE_IOERR_RDLOCK) ||
  28605. (sqliteIOErr == SQLITE_IOERR_CHECKRESERVEDLOCK) );
  28606. switch (posixError) {
  28607. case EACCES:
  28608. case EAGAIN:
  28609. case ETIMEDOUT:
  28610. case EBUSY:
  28611. case EINTR:
  28612. case ENOLCK:
  28613. /* random NFS retry error, unless during file system support
  28614. * introspection, in which it actually means what it says */
  28615. return SQLITE_BUSY;
  28616. case EPERM:
  28617. return SQLITE_PERM;
  28618. default:
  28619. return sqliteIOErr;
  28620. }
  28621. }
  28622. /******************************************************************************
  28623. ****************** Begin Unique File ID Utility Used By VxWorks ***************
  28624. **
  28625. ** On most versions of unix, we can get a unique ID for a file by concatenating
  28626. ** the device number and the inode number. But this does not work on VxWorks.
  28627. ** On VxWorks, a unique file id must be based on the canonical filename.
  28628. **
  28629. ** A pointer to an instance of the following structure can be used as a
  28630. ** unique file ID in VxWorks. Each instance of this structure contains
  28631. ** a copy of the canonical filename. There is also a reference count.
  28632. ** The structure is reclaimed when the number of pointers to it drops to
  28633. ** zero.
  28634. **
  28635. ** There are never very many files open at one time and lookups are not
  28636. ** a performance-critical path, so it is sufficient to put these
  28637. ** structures on a linked list.
  28638. */
  28639. struct vxworksFileId {
  28640. struct vxworksFileId *pNext; /* Next in a list of them all */
  28641. int nRef; /* Number of references to this one */
  28642. int nName; /* Length of the zCanonicalName[] string */
  28643. char *zCanonicalName; /* Canonical filename */
  28644. };
  28645. #if OS_VXWORKS
  28646. /*
  28647. ** All unique filenames are held on a linked list headed by this
  28648. ** variable:
  28649. */
  28650. static struct vxworksFileId *vxworksFileList = 0;
  28651. /*
  28652. ** Simplify a filename into its canonical form
  28653. ** by making the following changes:
  28654. **
  28655. ** * removing any trailing and duplicate /
  28656. ** * convert /./ into just /
  28657. ** * convert /A/../ where A is any simple name into just /
  28658. **
  28659. ** Changes are made in-place. Return the new name length.
  28660. **
  28661. ** The original filename is in z[0..n-1]. Return the number of
  28662. ** characters in the simplified name.
  28663. */
  28664. static int vxworksSimplifyName(char *z, int n){
  28665. int i, j;
  28666. while( n>1 && z[n-1]=='/' ){ n--; }
  28667. for(i=j=0; i<n; i++){
  28668. if( z[i]=='/' ){
  28669. if( z[i+1]=='/' ) continue;
  28670. if( z[i+1]=='.' && i+2<n && z[i+2]=='/' ){
  28671. i += 1;
  28672. continue;
  28673. }
  28674. if( z[i+1]=='.' && i+3<n && z[i+2]=='.' && z[i+3]=='/' ){
  28675. while( j>0 && z[j-1]!='/' ){ j--; }
  28676. if( j>0 ){ j--; }
  28677. i += 2;
  28678. continue;
  28679. }
  28680. }
  28681. z[j++] = z[i];
  28682. }
  28683. z[j] = 0;
  28684. return j;
  28685. }
  28686. /*
  28687. ** Find a unique file ID for the given absolute pathname. Return
  28688. ** a pointer to the vxworksFileId object. This pointer is the unique
  28689. ** file ID.
  28690. **
  28691. ** The nRef field of the vxworksFileId object is incremented before
  28692. ** the object is returned. A new vxworksFileId object is created
  28693. ** and added to the global list if necessary.
  28694. **
  28695. ** If a memory allocation error occurs, return NULL.
  28696. */
  28697. static struct vxworksFileId *vxworksFindFileId(const char *zAbsoluteName){
  28698. struct vxworksFileId *pNew; /* search key and new file ID */
  28699. struct vxworksFileId *pCandidate; /* For looping over existing file IDs */
  28700. int n; /* Length of zAbsoluteName string */
  28701. assert( zAbsoluteName[0]=='/' );
  28702. n = (int)strlen(zAbsoluteName);
  28703. pNew = sqlite3_malloc64( sizeof(*pNew) + (n+1) );
  28704. if( pNew==0 ) return 0;
  28705. pNew->zCanonicalName = (char*)&pNew[1];
  28706. memcpy(pNew->zCanonicalName, zAbsoluteName, n+1);
  28707. n = vxworksSimplifyName(pNew->zCanonicalName, n);
  28708. /* Search for an existing entry that matching the canonical name.
  28709. ** If found, increment the reference count and return a pointer to
  28710. ** the existing file ID.
  28711. */
  28712. unixEnterMutex();
  28713. for(pCandidate=vxworksFileList; pCandidate; pCandidate=pCandidate->pNext){
  28714. if( pCandidate->nName==n
  28715. && memcmp(pCandidate->zCanonicalName, pNew->zCanonicalName, n)==0
  28716. ){
  28717. sqlite3_free(pNew);
  28718. pCandidate->nRef++;
  28719. unixLeaveMutex();
  28720. return pCandidate;
  28721. }
  28722. }
  28723. /* No match was found. We will make a new file ID */
  28724. pNew->nRef = 1;
  28725. pNew->nName = n;
  28726. pNew->pNext = vxworksFileList;
  28727. vxworksFileList = pNew;
  28728. unixLeaveMutex();
  28729. return pNew;
  28730. }
  28731. /*
  28732. ** Decrement the reference count on a vxworksFileId object. Free
  28733. ** the object when the reference count reaches zero.
  28734. */
  28735. static void vxworksReleaseFileId(struct vxworksFileId *pId){
  28736. unixEnterMutex();
  28737. assert( pId->nRef>0 );
  28738. pId->nRef--;
  28739. if( pId->nRef==0 ){
  28740. struct vxworksFileId **pp;
  28741. for(pp=&vxworksFileList; *pp && *pp!=pId; pp = &((*pp)->pNext)){}
  28742. assert( *pp==pId );
  28743. *pp = pId->pNext;
  28744. sqlite3_free(pId);
  28745. }
  28746. unixLeaveMutex();
  28747. }
  28748. #endif /* OS_VXWORKS */
  28749. /*************** End of Unique File ID Utility Used By VxWorks ****************
  28750. ******************************************************************************/
  28751. /******************************************************************************
  28752. *************************** Posix Advisory Locking ****************************
  28753. **
  28754. ** POSIX advisory locks are broken by design. ANSI STD 1003.1 (1996)
  28755. ** section 6.5.2.2 lines 483 through 490 specify that when a process
  28756. ** sets or clears a lock, that operation overrides any prior locks set
  28757. ** by the same process. It does not explicitly say so, but this implies
  28758. ** that it overrides locks set by the same process using a different
  28759. ** file descriptor. Consider this test case:
  28760. **
  28761. ** int fd1 = open("./file1", O_RDWR|O_CREAT, 0644);
  28762. ** int fd2 = open("./file2", O_RDWR|O_CREAT, 0644);
  28763. **
  28764. ** Suppose ./file1 and ./file2 are really the same file (because
  28765. ** one is a hard or symbolic link to the other) then if you set
  28766. ** an exclusive lock on fd1, then try to get an exclusive lock
  28767. ** on fd2, it works. I would have expected the second lock to
  28768. ** fail since there was already a lock on the file due to fd1.
  28769. ** But not so. Since both locks came from the same process, the
  28770. ** second overrides the first, even though they were on different
  28771. ** file descriptors opened on different file names.
  28772. **
  28773. ** This means that we cannot use POSIX locks to synchronize file access
  28774. ** among competing threads of the same process. POSIX locks will work fine
  28775. ** to synchronize access for threads in separate processes, but not
  28776. ** threads within the same process.
  28777. **
  28778. ** To work around the problem, SQLite has to manage file locks internally
  28779. ** on its own. Whenever a new database is opened, we have to find the
  28780. ** specific inode of the database file (the inode is determined by the
  28781. ** st_dev and st_ino fields of the stat structure that fstat() fills in)
  28782. ** and check for locks already existing on that inode. When locks are
  28783. ** created or removed, we have to look at our own internal record of the
  28784. ** locks to see if another thread has previously set a lock on that same
  28785. ** inode.
  28786. **
  28787. ** (Aside: The use of inode numbers as unique IDs does not work on VxWorks.
  28788. ** For VxWorks, we have to use the alternative unique ID system based on
  28789. ** canonical filename and implemented in the previous division.)
  28790. **
  28791. ** The sqlite3_file structure for POSIX is no longer just an integer file
  28792. ** descriptor. It is now a structure that holds the integer file
  28793. ** descriptor and a pointer to a structure that describes the internal
  28794. ** locks on the corresponding inode. There is one locking structure
  28795. ** per inode, so if the same inode is opened twice, both unixFile structures
  28796. ** point to the same locking structure. The locking structure keeps
  28797. ** a reference count (so we will know when to delete it) and a "cnt"
  28798. ** field that tells us its internal lock status. cnt==0 means the
  28799. ** file is unlocked. cnt==-1 means the file has an exclusive lock.
  28800. ** cnt>0 means there are cnt shared locks on the file.
  28801. **
  28802. ** Any attempt to lock or unlock a file first checks the locking
  28803. ** structure. The fcntl() system call is only invoked to set a
  28804. ** POSIX lock if the internal lock structure transitions between
  28805. ** a locked and an unlocked state.
  28806. **
  28807. ** But wait: there are yet more problems with POSIX advisory locks.
  28808. **
  28809. ** If you close a file descriptor that points to a file that has locks,
  28810. ** all locks on that file that are owned by the current process are
  28811. ** released. To work around this problem, each unixInodeInfo object
  28812. ** maintains a count of the number of pending locks on tha inode.
  28813. ** When an attempt is made to close an unixFile, if there are
  28814. ** other unixFile open on the same inode that are holding locks, the call
  28815. ** to close() the file descriptor is deferred until all of the locks clear.
  28816. ** The unixInodeInfo structure keeps a list of file descriptors that need to
  28817. ** be closed and that list is walked (and cleared) when the last lock
  28818. ** clears.
  28819. **
  28820. ** Yet another problem: LinuxThreads do not play well with posix locks.
  28821. **
  28822. ** Many older versions of linux use the LinuxThreads library which is
  28823. ** not posix compliant. Under LinuxThreads, a lock created by thread
  28824. ** A cannot be modified or overridden by a different thread B.
  28825. ** Only thread A can modify the lock. Locking behavior is correct
  28826. ** if the appliation uses the newer Native Posix Thread Library (NPTL)
  28827. ** on linux - with NPTL a lock created by thread A can override locks
  28828. ** in thread B. But there is no way to know at compile-time which
  28829. ** threading library is being used. So there is no way to know at
  28830. ** compile-time whether or not thread A can override locks on thread B.
  28831. ** One has to do a run-time check to discover the behavior of the
  28832. ** current process.
  28833. **
  28834. ** SQLite used to support LinuxThreads. But support for LinuxThreads
  28835. ** was dropped beginning with version 3.7.0. SQLite will still work with
  28836. ** LinuxThreads provided that (1) there is no more than one connection
  28837. ** per database file in the same process and (2) database connections
  28838. ** do not move across threads.
  28839. */
  28840. /*
  28841. ** An instance of the following structure serves as the key used
  28842. ** to locate a particular unixInodeInfo object.
  28843. */
  28844. struct unixFileId {
  28845. dev_t dev; /* Device number */
  28846. #if OS_VXWORKS
  28847. struct vxworksFileId *pId; /* Unique file ID for vxworks. */
  28848. #else
  28849. ino_t ino; /* Inode number */
  28850. #endif
  28851. };
  28852. /*
  28853. ** An instance of the following structure is allocated for each open
  28854. ** inode. Or, on LinuxThreads, there is one of these structures for
  28855. ** each inode opened by each thread.
  28856. **
  28857. ** A single inode can have multiple file descriptors, so each unixFile
  28858. ** structure contains a pointer to an instance of this object and this
  28859. ** object keeps a count of the number of unixFile pointing to it.
  28860. */
  28861. struct unixInodeInfo {
  28862. struct unixFileId fileId; /* The lookup key */
  28863. int nShared; /* Number of SHARED locks held */
  28864. unsigned char eFileLock; /* One of SHARED_LOCK, RESERVED_LOCK etc. */
  28865. unsigned char bProcessLock; /* An exclusive process lock is held */
  28866. int nRef; /* Number of pointers to this structure */
  28867. unixShmNode *pShmNode; /* Shared memory associated with this inode */
  28868. int nLock; /* Number of outstanding file locks */
  28869. UnixUnusedFd *pUnused; /* Unused file descriptors to close */
  28870. unixInodeInfo *pNext; /* List of all unixInodeInfo objects */
  28871. unixInodeInfo *pPrev; /* .... doubly linked */
  28872. #if SQLITE_ENABLE_LOCKING_STYLE
  28873. unsigned long long sharedByte; /* for AFP simulated shared lock */
  28874. #endif
  28875. #if OS_VXWORKS
  28876. sem_t *pSem; /* Named POSIX semaphore */
  28877. char aSemName[MAX_PATHNAME+2]; /* Name of that semaphore */
  28878. #endif
  28879. };
  28880. /*
  28881. ** A lists of all unixInodeInfo objects.
  28882. */
  28883. static unixInodeInfo *inodeList = 0;
  28884. /*
  28885. **
  28886. ** This function - unixLogErrorAtLine(), is only ever called via the macro
  28887. ** unixLogError().
  28888. **
  28889. ** It is invoked after an error occurs in an OS function and errno has been
  28890. ** set. It logs a message using sqlite3_log() containing the current value of
  28891. ** errno and, if possible, the human-readable equivalent from strerror() or
  28892. ** strerror_r().
  28893. **
  28894. ** The first argument passed to the macro should be the error code that
  28895. ** will be returned to SQLite (e.g. SQLITE_IOERR_DELETE, SQLITE_CANTOPEN).
  28896. ** The two subsequent arguments should be the name of the OS function that
  28897. ** failed (e.g. "unlink", "open") and the associated file-system path,
  28898. ** if any.
  28899. */
  28900. #define unixLogError(a,b,c) unixLogErrorAtLine(a,b,c,__LINE__)
  28901. static int unixLogErrorAtLine(
  28902. int errcode, /* SQLite error code */
  28903. const char *zFunc, /* Name of OS function that failed */
  28904. const char *zPath, /* File path associated with error */
  28905. int iLine /* Source line number where error occurred */
  28906. ){
  28907. char *zErr; /* Message from strerror() or equivalent */
  28908. int iErrno = errno; /* Saved syscall error number */
  28909. /* If this is not a threadsafe build (SQLITE_THREADSAFE==0), then use
  28910. ** the strerror() function to obtain the human-readable error message
  28911. ** equivalent to errno. Otherwise, use strerror_r().
  28912. */
  28913. #if SQLITE_THREADSAFE && defined(HAVE_STRERROR_R)
  28914. char aErr[80];
  28915. memset(aErr, 0, sizeof(aErr));
  28916. zErr = aErr;
  28917. /* If STRERROR_R_CHAR_P (set by autoconf scripts) or __USE_GNU is defined,
  28918. ** assume that the system provides the GNU version of strerror_r() that
  28919. ** returns a pointer to a buffer containing the error message. That pointer
  28920. ** may point to aErr[], or it may point to some static storage somewhere.
  28921. ** Otherwise, assume that the system provides the POSIX version of
  28922. ** strerror_r(), which always writes an error message into aErr[].
  28923. **
  28924. ** If the code incorrectly assumes that it is the POSIX version that is
  28925. ** available, the error message will often be an empty string. Not a
  28926. ** huge problem. Incorrectly concluding that the GNU version is available
  28927. ** could lead to a segfault though.
  28928. */
  28929. #if defined(STRERROR_R_CHAR_P) || defined(__USE_GNU)
  28930. zErr =
  28931. # endif
  28932. strerror_r(iErrno, aErr, sizeof(aErr)-1);
  28933. #elif SQLITE_THREADSAFE
  28934. /* This is a threadsafe build, but strerror_r() is not available. */
  28935. zErr = "";
  28936. #else
  28937. /* Non-threadsafe build, use strerror(). */
  28938. zErr = strerror(iErrno);
  28939. #endif
  28940. if( zPath==0 ) zPath = "";
  28941. sqlite3_log(errcode,
  28942. "os_unix.c:%d: (%d) %s(%s) - %s",
  28943. iLine, iErrno, zFunc, zPath, zErr
  28944. );
  28945. return errcode;
  28946. }
  28947. /*
  28948. ** Close a file descriptor.
  28949. **
  28950. ** We assume that close() almost always works, since it is only in a
  28951. ** very sick application or on a very sick platform that it might fail.
  28952. ** If it does fail, simply leak the file descriptor, but do log the
  28953. ** error.
  28954. **
  28955. ** Note that it is not safe to retry close() after EINTR since the
  28956. ** file descriptor might have already been reused by another thread.
  28957. ** So we don't even try to recover from an EINTR. Just log the error
  28958. ** and move on.
  28959. */
  28960. static void robust_close(unixFile *pFile, int h, int lineno){
  28961. if( osClose(h) ){
  28962. unixLogErrorAtLine(SQLITE_IOERR_CLOSE, "close",
  28963. pFile ? pFile->zPath : 0, lineno);
  28964. }
  28965. }
  28966. /*
  28967. ** Set the pFile->lastErrno. Do this in a subroutine as that provides
  28968. ** a convenient place to set a breakpoint.
  28969. */
  28970. static void storeLastErrno(unixFile *pFile, int error){
  28971. pFile->lastErrno = error;
  28972. }
  28973. /*
  28974. ** Close all file descriptors accumuated in the unixInodeInfo->pUnused list.
  28975. */
  28976. static void closePendingFds(unixFile *pFile){
  28977. unixInodeInfo *pInode = pFile->pInode;
  28978. UnixUnusedFd *p;
  28979. UnixUnusedFd *pNext;
  28980. for(p=pInode->pUnused; p; p=pNext){
  28981. pNext = p->pNext;
  28982. robust_close(pFile, p->fd, __LINE__);
  28983. sqlite3_free(p);
  28984. }
  28985. pInode->pUnused = 0;
  28986. }
  28987. /*
  28988. ** Release a unixInodeInfo structure previously allocated by findInodeInfo().
  28989. **
  28990. ** The mutex entered using the unixEnterMutex() function must be held
  28991. ** when this function is called.
  28992. */
  28993. static void releaseInodeInfo(unixFile *pFile){
  28994. unixInodeInfo *pInode = pFile->pInode;
  28995. assert( unixMutexHeld() );
  28996. if( ALWAYS(pInode) ){
  28997. pInode->nRef--;
  28998. if( pInode->nRef==0 ){
  28999. assert( pInode->pShmNode==0 );
  29000. closePendingFds(pFile);
  29001. if( pInode->pPrev ){
  29002. assert( pInode->pPrev->pNext==pInode );
  29003. pInode->pPrev->pNext = pInode->pNext;
  29004. }else{
  29005. assert( inodeList==pInode );
  29006. inodeList = pInode->pNext;
  29007. }
  29008. if( pInode->pNext ){
  29009. assert( pInode->pNext->pPrev==pInode );
  29010. pInode->pNext->pPrev = pInode->pPrev;
  29011. }
  29012. sqlite3_free(pInode);
  29013. }
  29014. }
  29015. }
  29016. /*
  29017. ** Given a file descriptor, locate the unixInodeInfo object that
  29018. ** describes that file descriptor. Create a new one if necessary. The
  29019. ** return value might be uninitialized if an error occurs.
  29020. **
  29021. ** The mutex entered using the unixEnterMutex() function must be held
  29022. ** when this function is called.
  29023. **
  29024. ** Return an appropriate error code.
  29025. */
  29026. static int findInodeInfo(
  29027. unixFile *pFile, /* Unix file with file desc used in the key */
  29028. unixInodeInfo **ppInode /* Return the unixInodeInfo object here */
  29029. ){
  29030. int rc; /* System call return code */
  29031. int fd; /* The file descriptor for pFile */
  29032. struct unixFileId fileId; /* Lookup key for the unixInodeInfo */
  29033. struct stat statbuf; /* Low-level file information */
  29034. unixInodeInfo *pInode = 0; /* Candidate unixInodeInfo object */
  29035. assert( unixMutexHeld() );
  29036. /* Get low-level information about the file that we can used to
  29037. ** create a unique name for the file.
  29038. */
  29039. fd = pFile->h;
  29040. rc = osFstat(fd, &statbuf);
  29041. if( rc!=0 ){
  29042. storeLastErrno(pFile, errno);
  29043. #if defined(EOVERFLOW) && defined(SQLITE_DISABLE_LFS)
  29044. if( pFile->lastErrno==EOVERFLOW ) return SQLITE_NOLFS;
  29045. #endif
  29046. return SQLITE_IOERR;
  29047. }
  29048. #ifdef __APPLE__
  29049. /* On OS X on an msdos filesystem, the inode number is reported
  29050. ** incorrectly for zero-size files. See ticket #3260. To work
  29051. ** around this problem (we consider it a bug in OS X, not SQLite)
  29052. ** we always increase the file size to 1 by writing a single byte
  29053. ** prior to accessing the inode number. The one byte written is
  29054. ** an ASCII 'S' character which also happens to be the first byte
  29055. ** in the header of every SQLite database. In this way, if there
  29056. ** is a race condition such that another thread has already populated
  29057. ** the first page of the database, no damage is done.
  29058. */
  29059. if( statbuf.st_size==0 && (pFile->fsFlags & SQLITE_FSFLAGS_IS_MSDOS)!=0 ){
  29060. do{ rc = osWrite(fd, "S", 1); }while( rc<0 && errno==EINTR );
  29061. if( rc!=1 ){
  29062. storeLastErrno(pFile, errno);
  29063. return SQLITE_IOERR;
  29064. }
  29065. rc = osFstat(fd, &statbuf);
  29066. if( rc!=0 ){
  29067. storeLastErrno(pFile, errno);
  29068. return SQLITE_IOERR;
  29069. }
  29070. }
  29071. #endif
  29072. memset(&fileId, 0, sizeof(fileId));
  29073. fileId.dev = statbuf.st_dev;
  29074. #if OS_VXWORKS
  29075. fileId.pId = pFile->pId;
  29076. #else
  29077. fileId.ino = statbuf.st_ino;
  29078. #endif
  29079. pInode = inodeList;
  29080. while( pInode && memcmp(&fileId, &pInode->fileId, sizeof(fileId)) ){
  29081. pInode = pInode->pNext;
  29082. }
  29083. if( pInode==0 ){
  29084. pInode = sqlite3_malloc64( sizeof(*pInode) );
  29085. if( pInode==0 ){
  29086. return SQLITE_NOMEM_BKPT;
  29087. }
  29088. memset(pInode, 0, sizeof(*pInode));
  29089. memcpy(&pInode->fileId, &fileId, sizeof(fileId));
  29090. pInode->nRef = 1;
  29091. pInode->pNext = inodeList;
  29092. pInode->pPrev = 0;
  29093. if( inodeList ) inodeList->pPrev = pInode;
  29094. inodeList = pInode;
  29095. }else{
  29096. pInode->nRef++;
  29097. }
  29098. *ppInode = pInode;
  29099. return SQLITE_OK;
  29100. }
  29101. /*
  29102. ** Return TRUE if pFile has been renamed or unlinked since it was first opened.
  29103. */
  29104. static int fileHasMoved(unixFile *pFile){
  29105. #if OS_VXWORKS
  29106. return pFile->pInode!=0 && pFile->pId!=pFile->pInode->fileId.pId;
  29107. #else
  29108. struct stat buf;
  29109. return pFile->pInode!=0 &&
  29110. (osStat(pFile->zPath, &buf)!=0 || buf.st_ino!=pFile->pInode->fileId.ino);
  29111. #endif
  29112. }
  29113. /*
  29114. ** Check a unixFile that is a database. Verify the following:
  29115. **
  29116. ** (1) There is exactly one hard link on the file
  29117. ** (2) The file is not a symbolic link
  29118. ** (3) The file has not been renamed or unlinked
  29119. **
  29120. ** Issue sqlite3_log(SQLITE_WARNING,...) messages if anything is not right.
  29121. */
  29122. static void verifyDbFile(unixFile *pFile){
  29123. struct stat buf;
  29124. int rc;
  29125. /* These verifications occurs for the main database only */
  29126. if( pFile->ctrlFlags & UNIXFILE_NOLOCK ) return;
  29127. rc = osFstat(pFile->h, &buf);
  29128. if( rc!=0 ){
  29129. sqlite3_log(SQLITE_WARNING, "cannot fstat db file %s", pFile->zPath);
  29130. return;
  29131. }
  29132. if( buf.st_nlink==0 ){
  29133. sqlite3_log(SQLITE_WARNING, "file unlinked while open: %s", pFile->zPath);
  29134. return;
  29135. }
  29136. if( buf.st_nlink>1 ){
  29137. sqlite3_log(SQLITE_WARNING, "multiple links to file: %s", pFile->zPath);
  29138. return;
  29139. }
  29140. if( fileHasMoved(pFile) ){
  29141. sqlite3_log(SQLITE_WARNING, "file renamed while open: %s", pFile->zPath);
  29142. return;
  29143. }
  29144. }
  29145. /*
  29146. ** This routine checks if there is a RESERVED lock held on the specified
  29147. ** file by this or any other process. If such a lock is held, set *pResOut
  29148. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  29149. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  29150. */
  29151. static int unixCheckReservedLock(sqlite3_file *id, int *pResOut){
  29152. int rc = SQLITE_OK;
  29153. int reserved = 0;
  29154. unixFile *pFile = (unixFile*)id;
  29155. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  29156. assert( pFile );
  29157. assert( pFile->eFileLock<=SHARED_LOCK );
  29158. unixEnterMutex(); /* Because pFile->pInode is shared across threads */
  29159. /* Check if a thread in this process holds such a lock */
  29160. if( pFile->pInode->eFileLock>SHARED_LOCK ){
  29161. reserved = 1;
  29162. }
  29163. /* Otherwise see if some other process holds it.
  29164. */
  29165. #ifndef __DJGPP__
  29166. if( !reserved && !pFile->pInode->bProcessLock ){
  29167. struct flock lock;
  29168. lock.l_whence = SEEK_SET;
  29169. lock.l_start = RESERVED_BYTE;
  29170. lock.l_len = 1;
  29171. lock.l_type = F_WRLCK;
  29172. if( osFcntl(pFile->h, F_GETLK, &lock) ){
  29173. rc = SQLITE_IOERR_CHECKRESERVEDLOCK;
  29174. storeLastErrno(pFile, errno);
  29175. } else if( lock.l_type!=F_UNLCK ){
  29176. reserved = 1;
  29177. }
  29178. }
  29179. #endif
  29180. unixLeaveMutex();
  29181. OSTRACE(("TEST WR-LOCK %d %d %d (unix)\n", pFile->h, rc, reserved));
  29182. *pResOut = reserved;
  29183. return rc;
  29184. }
  29185. /*
  29186. ** Attempt to set a system-lock on the file pFile. The lock is
  29187. ** described by pLock.
  29188. **
  29189. ** If the pFile was opened read/write from unix-excl, then the only lock
  29190. ** ever obtained is an exclusive lock, and it is obtained exactly once
  29191. ** the first time any lock is attempted. All subsequent system locking
  29192. ** operations become no-ops. Locking operations still happen internally,
  29193. ** in order to coordinate access between separate database connections
  29194. ** within this process, but all of that is handled in memory and the
  29195. ** operating system does not participate.
  29196. **
  29197. ** This function is a pass-through to fcntl(F_SETLK) if pFile is using
  29198. ** any VFS other than "unix-excl" or if pFile is opened on "unix-excl"
  29199. ** and is read-only.
  29200. **
  29201. ** Zero is returned if the call completes successfully, or -1 if a call
  29202. ** to fcntl() fails. In this case, errno is set appropriately (by fcntl()).
  29203. */
  29204. static int unixFileLock(unixFile *pFile, struct flock *pLock){
  29205. int rc;
  29206. unixInodeInfo *pInode = pFile->pInode;
  29207. assert( unixMutexHeld() );
  29208. assert( pInode!=0 );
  29209. if( (pFile->ctrlFlags & (UNIXFILE_EXCL|UNIXFILE_RDONLY))==UNIXFILE_EXCL ){
  29210. if( pInode->bProcessLock==0 ){
  29211. struct flock lock;
  29212. assert( pInode->nLock==0 );
  29213. lock.l_whence = SEEK_SET;
  29214. lock.l_start = SHARED_FIRST;
  29215. lock.l_len = SHARED_SIZE;
  29216. lock.l_type = F_WRLCK;
  29217. rc = osFcntl(pFile->h, F_SETLK, &lock);
  29218. if( rc<0 ) return rc;
  29219. pInode->bProcessLock = 1;
  29220. pInode->nLock++;
  29221. }else{
  29222. rc = 0;
  29223. }
  29224. }else{
  29225. rc = osFcntl(pFile->h, F_SETLK, pLock);
  29226. }
  29227. return rc;
  29228. }
  29229. /*
  29230. ** Lock the file with the lock specified by parameter eFileLock - one
  29231. ** of the following:
  29232. **
  29233. ** (1) SHARED_LOCK
  29234. ** (2) RESERVED_LOCK
  29235. ** (3) PENDING_LOCK
  29236. ** (4) EXCLUSIVE_LOCK
  29237. **
  29238. ** Sometimes when requesting one lock state, additional lock states
  29239. ** are inserted in between. The locking might fail on one of the later
  29240. ** transitions leaving the lock state different from what it started but
  29241. ** still short of its goal. The following chart shows the allowed
  29242. ** transitions and the inserted intermediate states:
  29243. **
  29244. ** UNLOCKED -> SHARED
  29245. ** SHARED -> RESERVED
  29246. ** SHARED -> (PENDING) -> EXCLUSIVE
  29247. ** RESERVED -> (PENDING) -> EXCLUSIVE
  29248. ** PENDING -> EXCLUSIVE
  29249. **
  29250. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  29251. ** routine to lower a locking level.
  29252. */
  29253. static int unixLock(sqlite3_file *id, int eFileLock){
  29254. /* The following describes the implementation of the various locks and
  29255. ** lock transitions in terms of the POSIX advisory shared and exclusive
  29256. ** lock primitives (called read-locks and write-locks below, to avoid
  29257. ** confusion with SQLite lock names). The algorithms are complicated
  29258. ** slightly in order to be compatible with Windows95 systems simultaneously
  29259. ** accessing the same database file, in case that is ever required.
  29260. **
  29261. ** Symbols defined in os.h indentify the 'pending byte' and the 'reserved
  29262. ** byte', each single bytes at well known offsets, and the 'shared byte
  29263. ** range', a range of 510 bytes at a well known offset.
  29264. **
  29265. ** To obtain a SHARED lock, a read-lock is obtained on the 'pending
  29266. ** byte'. If this is successful, 'shared byte range' is read-locked
  29267. ** and the lock on the 'pending byte' released. (Legacy note: When
  29268. ** SQLite was first developed, Windows95 systems were still very common,
  29269. ** and Widnows95 lacks a shared-lock capability. So on Windows95, a
  29270. ** single randomly selected by from the 'shared byte range' is locked.
  29271. ** Windows95 is now pretty much extinct, but this work-around for the
  29272. ** lack of shared-locks on Windows95 lives on, for backwards
  29273. ** compatibility.)
  29274. **
  29275. ** A process may only obtain a RESERVED lock after it has a SHARED lock.
  29276. ** A RESERVED lock is implemented by grabbing a write-lock on the
  29277. ** 'reserved byte'.
  29278. **
  29279. ** A process may only obtain a PENDING lock after it has obtained a
  29280. ** SHARED lock. A PENDING lock is implemented by obtaining a write-lock
  29281. ** on the 'pending byte'. This ensures that no new SHARED locks can be
  29282. ** obtained, but existing SHARED locks are allowed to persist. A process
  29283. ** does not have to obtain a RESERVED lock on the way to a PENDING lock.
  29284. ** This property is used by the algorithm for rolling back a journal file
  29285. ** after a crash.
  29286. **
  29287. ** An EXCLUSIVE lock, obtained after a PENDING lock is held, is
  29288. ** implemented by obtaining a write-lock on the entire 'shared byte
  29289. ** range'. Since all other locks require a read-lock on one of the bytes
  29290. ** within this range, this ensures that no other locks are held on the
  29291. ** database.
  29292. */
  29293. int rc = SQLITE_OK;
  29294. unixFile *pFile = (unixFile*)id;
  29295. unixInodeInfo *pInode;
  29296. struct flock lock;
  29297. int tErrno = 0;
  29298. assert( pFile );
  29299. OSTRACE(("LOCK %d %s was %s(%s,%d) pid=%d (unix)\n", pFile->h,
  29300. azFileLock(eFileLock), azFileLock(pFile->eFileLock),
  29301. azFileLock(pFile->pInode->eFileLock), pFile->pInode->nShared,
  29302. osGetpid(0)));
  29303. /* If there is already a lock of this type or more restrictive on the
  29304. ** unixFile, do nothing. Don't use the end_lock: exit path, as
  29305. ** unixEnterMutex() hasn't been called yet.
  29306. */
  29307. if( pFile->eFileLock>=eFileLock ){
  29308. OSTRACE(("LOCK %d %s ok (already held) (unix)\n", pFile->h,
  29309. azFileLock(eFileLock)));
  29310. return SQLITE_OK;
  29311. }
  29312. /* Make sure the locking sequence is correct.
  29313. ** (1) We never move from unlocked to anything higher than shared lock.
  29314. ** (2) SQLite never explicitly requests a pendig lock.
  29315. ** (3) A shared lock is always held when a reserve lock is requested.
  29316. */
  29317. assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK );
  29318. assert( eFileLock!=PENDING_LOCK );
  29319. assert( eFileLock!=RESERVED_LOCK || pFile->eFileLock==SHARED_LOCK );
  29320. /* This mutex is needed because pFile->pInode is shared across threads
  29321. */
  29322. unixEnterMutex();
  29323. pInode = pFile->pInode;
  29324. /* If some thread using this PID has a lock via a different unixFile*
  29325. ** handle that precludes the requested lock, return BUSY.
  29326. */
  29327. if( (pFile->eFileLock!=pInode->eFileLock &&
  29328. (pInode->eFileLock>=PENDING_LOCK || eFileLock>SHARED_LOCK))
  29329. ){
  29330. rc = SQLITE_BUSY;
  29331. goto end_lock;
  29332. }
  29333. /* If a SHARED lock is requested, and some thread using this PID already
  29334. ** has a SHARED or RESERVED lock, then increment reference counts and
  29335. ** return SQLITE_OK.
  29336. */
  29337. if( eFileLock==SHARED_LOCK &&
  29338. (pInode->eFileLock==SHARED_LOCK || pInode->eFileLock==RESERVED_LOCK) ){
  29339. assert( eFileLock==SHARED_LOCK );
  29340. assert( pFile->eFileLock==0 );
  29341. assert( pInode->nShared>0 );
  29342. pFile->eFileLock = SHARED_LOCK;
  29343. pInode->nShared++;
  29344. pInode->nLock++;
  29345. goto end_lock;
  29346. }
  29347. /* A PENDING lock is needed before acquiring a SHARED lock and before
  29348. ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
  29349. ** be released.
  29350. */
  29351. lock.l_len = 1L;
  29352. lock.l_whence = SEEK_SET;
  29353. if( eFileLock==SHARED_LOCK
  29354. || (eFileLock==EXCLUSIVE_LOCK && pFile->eFileLock<PENDING_LOCK)
  29355. ){
  29356. lock.l_type = (eFileLock==SHARED_LOCK?F_RDLCK:F_WRLCK);
  29357. lock.l_start = PENDING_BYTE;
  29358. if( unixFileLock(pFile, &lock) ){
  29359. tErrno = errno;
  29360. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  29361. if( rc!=SQLITE_BUSY ){
  29362. storeLastErrno(pFile, tErrno);
  29363. }
  29364. goto end_lock;
  29365. }
  29366. }
  29367. /* If control gets to this point, then actually go ahead and make
  29368. ** operating system calls for the specified lock.
  29369. */
  29370. if( eFileLock==SHARED_LOCK ){
  29371. assert( pInode->nShared==0 );
  29372. assert( pInode->eFileLock==0 );
  29373. assert( rc==SQLITE_OK );
  29374. /* Now get the read-lock */
  29375. lock.l_start = SHARED_FIRST;
  29376. lock.l_len = SHARED_SIZE;
  29377. if( unixFileLock(pFile, &lock) ){
  29378. tErrno = errno;
  29379. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  29380. }
  29381. /* Drop the temporary PENDING lock */
  29382. lock.l_start = PENDING_BYTE;
  29383. lock.l_len = 1L;
  29384. lock.l_type = F_UNLCK;
  29385. if( unixFileLock(pFile, &lock) && rc==SQLITE_OK ){
  29386. /* This could happen with a network mount */
  29387. tErrno = errno;
  29388. rc = SQLITE_IOERR_UNLOCK;
  29389. }
  29390. if( rc ){
  29391. if( rc!=SQLITE_BUSY ){
  29392. storeLastErrno(pFile, tErrno);
  29393. }
  29394. goto end_lock;
  29395. }else{
  29396. pFile->eFileLock = SHARED_LOCK;
  29397. pInode->nLock++;
  29398. pInode->nShared = 1;
  29399. }
  29400. }else if( eFileLock==EXCLUSIVE_LOCK && pInode->nShared>1 ){
  29401. /* We are trying for an exclusive lock but another thread in this
  29402. ** same process is still holding a shared lock. */
  29403. rc = SQLITE_BUSY;
  29404. }else{
  29405. /* The request was for a RESERVED or EXCLUSIVE lock. It is
  29406. ** assumed that there is a SHARED or greater lock on the file
  29407. ** already.
  29408. */
  29409. assert( 0!=pFile->eFileLock );
  29410. lock.l_type = F_WRLCK;
  29411. assert( eFileLock==RESERVED_LOCK || eFileLock==EXCLUSIVE_LOCK );
  29412. if( eFileLock==RESERVED_LOCK ){
  29413. lock.l_start = RESERVED_BYTE;
  29414. lock.l_len = 1L;
  29415. }else{
  29416. lock.l_start = SHARED_FIRST;
  29417. lock.l_len = SHARED_SIZE;
  29418. }
  29419. if( unixFileLock(pFile, &lock) ){
  29420. tErrno = errno;
  29421. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  29422. if( rc!=SQLITE_BUSY ){
  29423. storeLastErrno(pFile, tErrno);
  29424. }
  29425. }
  29426. }
  29427. #ifdef SQLITE_DEBUG
  29428. /* Set up the transaction-counter change checking flags when
  29429. ** transitioning from a SHARED to a RESERVED lock. The change
  29430. ** from SHARED to RESERVED marks the beginning of a normal
  29431. ** write operation (not a hot journal rollback).
  29432. */
  29433. if( rc==SQLITE_OK
  29434. && pFile->eFileLock<=SHARED_LOCK
  29435. && eFileLock==RESERVED_LOCK
  29436. ){
  29437. pFile->transCntrChng = 0;
  29438. pFile->dbUpdate = 0;
  29439. pFile->inNormalWrite = 1;
  29440. }
  29441. #endif
  29442. if( rc==SQLITE_OK ){
  29443. pFile->eFileLock = eFileLock;
  29444. pInode->eFileLock = eFileLock;
  29445. }else if( eFileLock==EXCLUSIVE_LOCK ){
  29446. pFile->eFileLock = PENDING_LOCK;
  29447. pInode->eFileLock = PENDING_LOCK;
  29448. }
  29449. end_lock:
  29450. unixLeaveMutex();
  29451. OSTRACE(("LOCK %d %s %s (unix)\n", pFile->h, azFileLock(eFileLock),
  29452. rc==SQLITE_OK ? "ok" : "failed"));
  29453. return rc;
  29454. }
  29455. /*
  29456. ** Add the file descriptor used by file handle pFile to the corresponding
  29457. ** pUnused list.
  29458. */
  29459. static void setPendingFd(unixFile *pFile){
  29460. unixInodeInfo *pInode = pFile->pInode;
  29461. UnixUnusedFd *p = pFile->pUnused;
  29462. p->pNext = pInode->pUnused;
  29463. pInode->pUnused = p;
  29464. pFile->h = -1;
  29465. pFile->pUnused = 0;
  29466. }
  29467. /*
  29468. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  29469. ** must be either NO_LOCK or SHARED_LOCK.
  29470. **
  29471. ** If the locking level of the file descriptor is already at or below
  29472. ** the requested locking level, this routine is a no-op.
  29473. **
  29474. ** If handleNFSUnlock is true, then on downgrading an EXCLUSIVE_LOCK to SHARED
  29475. ** the byte range is divided into 2 parts and the first part is unlocked then
  29476. ** set to a read lock, then the other part is simply unlocked. This works
  29477. ** around a bug in BSD NFS lockd (also seen on MacOSX 10.3+) that fails to
  29478. ** remove the write lock on a region when a read lock is set.
  29479. */
  29480. static int posixUnlock(sqlite3_file *id, int eFileLock, int handleNFSUnlock){
  29481. unixFile *pFile = (unixFile*)id;
  29482. unixInodeInfo *pInode;
  29483. struct flock lock;
  29484. int rc = SQLITE_OK;
  29485. assert( pFile );
  29486. OSTRACE(("UNLOCK %d %d was %d(%d,%d) pid=%d (unix)\n", pFile->h, eFileLock,
  29487. pFile->eFileLock, pFile->pInode->eFileLock, pFile->pInode->nShared,
  29488. osGetpid(0)));
  29489. assert( eFileLock<=SHARED_LOCK );
  29490. if( pFile->eFileLock<=eFileLock ){
  29491. return SQLITE_OK;
  29492. }
  29493. unixEnterMutex();
  29494. pInode = pFile->pInode;
  29495. assert( pInode->nShared!=0 );
  29496. if( pFile->eFileLock>SHARED_LOCK ){
  29497. assert( pInode->eFileLock==pFile->eFileLock );
  29498. #ifdef SQLITE_DEBUG
  29499. /* When reducing a lock such that other processes can start
  29500. ** reading the database file again, make sure that the
  29501. ** transaction counter was updated if any part of the database
  29502. ** file changed. If the transaction counter is not updated,
  29503. ** other connections to the same file might not realize that
  29504. ** the file has changed and hence might not know to flush their
  29505. ** cache. The use of a stale cache can lead to database corruption.
  29506. */
  29507. pFile->inNormalWrite = 0;
  29508. #endif
  29509. /* downgrading to a shared lock on NFS involves clearing the write lock
  29510. ** before establishing the readlock - to avoid a race condition we downgrade
  29511. ** the lock in 2 blocks, so that part of the range will be covered by a
  29512. ** write lock until the rest is covered by a read lock:
  29513. ** 1: [WWWWW]
  29514. ** 2: [....W]
  29515. ** 3: [RRRRW]
  29516. ** 4: [RRRR.]
  29517. */
  29518. if( eFileLock==SHARED_LOCK ){
  29519. #if !defined(__APPLE__) || !SQLITE_ENABLE_LOCKING_STYLE
  29520. (void)handleNFSUnlock;
  29521. assert( handleNFSUnlock==0 );
  29522. #endif
  29523. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  29524. if( handleNFSUnlock ){
  29525. int tErrno; /* Error code from system call errors */
  29526. off_t divSize = SHARED_SIZE - 1;
  29527. lock.l_type = F_UNLCK;
  29528. lock.l_whence = SEEK_SET;
  29529. lock.l_start = SHARED_FIRST;
  29530. lock.l_len = divSize;
  29531. if( unixFileLock(pFile, &lock)==(-1) ){
  29532. tErrno = errno;
  29533. rc = SQLITE_IOERR_UNLOCK;
  29534. storeLastErrno(pFile, tErrno);
  29535. goto end_unlock;
  29536. }
  29537. lock.l_type = F_RDLCK;
  29538. lock.l_whence = SEEK_SET;
  29539. lock.l_start = SHARED_FIRST;
  29540. lock.l_len = divSize;
  29541. if( unixFileLock(pFile, &lock)==(-1) ){
  29542. tErrno = errno;
  29543. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_RDLOCK);
  29544. if( IS_LOCK_ERROR(rc) ){
  29545. storeLastErrno(pFile, tErrno);
  29546. }
  29547. goto end_unlock;
  29548. }
  29549. lock.l_type = F_UNLCK;
  29550. lock.l_whence = SEEK_SET;
  29551. lock.l_start = SHARED_FIRST+divSize;
  29552. lock.l_len = SHARED_SIZE-divSize;
  29553. if( unixFileLock(pFile, &lock)==(-1) ){
  29554. tErrno = errno;
  29555. rc = SQLITE_IOERR_UNLOCK;
  29556. storeLastErrno(pFile, tErrno);
  29557. goto end_unlock;
  29558. }
  29559. }else
  29560. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  29561. {
  29562. lock.l_type = F_RDLCK;
  29563. lock.l_whence = SEEK_SET;
  29564. lock.l_start = SHARED_FIRST;
  29565. lock.l_len = SHARED_SIZE;
  29566. if( unixFileLock(pFile, &lock) ){
  29567. /* In theory, the call to unixFileLock() cannot fail because another
  29568. ** process is holding an incompatible lock. If it does, this
  29569. ** indicates that the other process is not following the locking
  29570. ** protocol. If this happens, return SQLITE_IOERR_RDLOCK. Returning
  29571. ** SQLITE_BUSY would confuse the upper layer (in practice it causes
  29572. ** an assert to fail). */
  29573. rc = SQLITE_IOERR_RDLOCK;
  29574. storeLastErrno(pFile, errno);
  29575. goto end_unlock;
  29576. }
  29577. }
  29578. }
  29579. lock.l_type = F_UNLCK;
  29580. lock.l_whence = SEEK_SET;
  29581. lock.l_start = PENDING_BYTE;
  29582. lock.l_len = 2L; assert( PENDING_BYTE+1==RESERVED_BYTE );
  29583. if( unixFileLock(pFile, &lock)==0 ){
  29584. pInode->eFileLock = SHARED_LOCK;
  29585. }else{
  29586. rc = SQLITE_IOERR_UNLOCK;
  29587. storeLastErrno(pFile, errno);
  29588. goto end_unlock;
  29589. }
  29590. }
  29591. if( eFileLock==NO_LOCK ){
  29592. /* Decrement the shared lock counter. Release the lock using an
  29593. ** OS call only when all threads in this same process have released
  29594. ** the lock.
  29595. */
  29596. pInode->nShared--;
  29597. if( pInode->nShared==0 ){
  29598. lock.l_type = F_UNLCK;
  29599. lock.l_whence = SEEK_SET;
  29600. lock.l_start = lock.l_len = 0L;
  29601. if( unixFileLock(pFile, &lock)==0 ){
  29602. pInode->eFileLock = NO_LOCK;
  29603. }else{
  29604. rc = SQLITE_IOERR_UNLOCK;
  29605. storeLastErrno(pFile, errno);
  29606. pInode->eFileLock = NO_LOCK;
  29607. pFile->eFileLock = NO_LOCK;
  29608. }
  29609. }
  29610. /* Decrement the count of locks against this same file. When the
  29611. ** count reaches zero, close any other file descriptors whose close
  29612. ** was deferred because of outstanding locks.
  29613. */
  29614. pInode->nLock--;
  29615. assert( pInode->nLock>=0 );
  29616. if( pInode->nLock==0 ){
  29617. closePendingFds(pFile);
  29618. }
  29619. }
  29620. end_unlock:
  29621. unixLeaveMutex();
  29622. if( rc==SQLITE_OK ) pFile->eFileLock = eFileLock;
  29623. return rc;
  29624. }
  29625. /*
  29626. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  29627. ** must be either NO_LOCK or SHARED_LOCK.
  29628. **
  29629. ** If the locking level of the file descriptor is already at or below
  29630. ** the requested locking level, this routine is a no-op.
  29631. */
  29632. static int unixUnlock(sqlite3_file *id, int eFileLock){
  29633. #if SQLITE_MAX_MMAP_SIZE>0
  29634. assert( eFileLock==SHARED_LOCK || ((unixFile *)id)->nFetchOut==0 );
  29635. #endif
  29636. return posixUnlock(id, eFileLock, 0);
  29637. }
  29638. #if SQLITE_MAX_MMAP_SIZE>0
  29639. static int unixMapfile(unixFile *pFd, i64 nByte);
  29640. static void unixUnmapfile(unixFile *pFd);
  29641. #endif
  29642. /*
  29643. ** This function performs the parts of the "close file" operation
  29644. ** common to all locking schemes. It closes the directory and file
  29645. ** handles, if they are valid, and sets all fields of the unixFile
  29646. ** structure to 0.
  29647. **
  29648. ** It is *not* necessary to hold the mutex when this routine is called,
  29649. ** even on VxWorks. A mutex will be acquired on VxWorks by the
  29650. ** vxworksReleaseFileId() routine.
  29651. */
  29652. static int closeUnixFile(sqlite3_file *id){
  29653. unixFile *pFile = (unixFile*)id;
  29654. #if SQLITE_MAX_MMAP_SIZE>0
  29655. unixUnmapfile(pFile);
  29656. #endif
  29657. if( pFile->h>=0 ){
  29658. robust_close(pFile, pFile->h, __LINE__);
  29659. pFile->h = -1;
  29660. }
  29661. #if OS_VXWORKS
  29662. if( pFile->pId ){
  29663. if( pFile->ctrlFlags & UNIXFILE_DELETE ){
  29664. osUnlink(pFile->pId->zCanonicalName);
  29665. }
  29666. vxworksReleaseFileId(pFile->pId);
  29667. pFile->pId = 0;
  29668. }
  29669. #endif
  29670. #ifdef SQLITE_UNLINK_AFTER_CLOSE
  29671. if( pFile->ctrlFlags & UNIXFILE_DELETE ){
  29672. osUnlink(pFile->zPath);
  29673. sqlite3_free(*(char**)&pFile->zPath);
  29674. pFile->zPath = 0;
  29675. }
  29676. #endif
  29677. OSTRACE(("CLOSE %-3d\n", pFile->h));
  29678. OpenCounter(-1);
  29679. sqlite3_free(pFile->pUnused);
  29680. memset(pFile, 0, sizeof(unixFile));
  29681. return SQLITE_OK;
  29682. }
  29683. /*
  29684. ** Close a file.
  29685. */
  29686. static int unixClose(sqlite3_file *id){
  29687. int rc = SQLITE_OK;
  29688. unixFile *pFile = (unixFile *)id;
  29689. verifyDbFile(pFile);
  29690. unixUnlock(id, NO_LOCK);
  29691. unixEnterMutex();
  29692. /* unixFile.pInode is always valid here. Otherwise, a different close
  29693. ** routine (e.g. nolockClose()) would be called instead.
  29694. */
  29695. assert( pFile->pInode->nLock>0 || pFile->pInode->bProcessLock==0 );
  29696. if( ALWAYS(pFile->pInode) && pFile->pInode->nLock ){
  29697. /* If there are outstanding locks, do not actually close the file just
  29698. ** yet because that would clear those locks. Instead, add the file
  29699. ** descriptor to pInode->pUnused list. It will be automatically closed
  29700. ** when the last lock is cleared.
  29701. */
  29702. setPendingFd(pFile);
  29703. }
  29704. releaseInodeInfo(pFile);
  29705. rc = closeUnixFile(id);
  29706. unixLeaveMutex();
  29707. return rc;
  29708. }
  29709. /************** End of the posix advisory lock implementation *****************
  29710. ******************************************************************************/
  29711. /******************************************************************************
  29712. ****************************** No-op Locking **********************************
  29713. **
  29714. ** Of the various locking implementations available, this is by far the
  29715. ** simplest: locking is ignored. No attempt is made to lock the database
  29716. ** file for reading or writing.
  29717. **
  29718. ** This locking mode is appropriate for use on read-only databases
  29719. ** (ex: databases that are burned into CD-ROM, for example.) It can
  29720. ** also be used if the application employs some external mechanism to
  29721. ** prevent simultaneous access of the same database by two or more
  29722. ** database connections. But there is a serious risk of database
  29723. ** corruption if this locking mode is used in situations where multiple
  29724. ** database connections are accessing the same database file at the same
  29725. ** time and one or more of those connections are writing.
  29726. */
  29727. static int nolockCheckReservedLock(sqlite3_file *NotUsed, int *pResOut){
  29728. UNUSED_PARAMETER(NotUsed);
  29729. *pResOut = 0;
  29730. return SQLITE_OK;
  29731. }
  29732. static int nolockLock(sqlite3_file *NotUsed, int NotUsed2){
  29733. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  29734. return SQLITE_OK;
  29735. }
  29736. static int nolockUnlock(sqlite3_file *NotUsed, int NotUsed2){
  29737. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  29738. return SQLITE_OK;
  29739. }
  29740. /*
  29741. ** Close the file.
  29742. */
  29743. static int nolockClose(sqlite3_file *id) {
  29744. return closeUnixFile(id);
  29745. }
  29746. /******************* End of the no-op lock implementation *********************
  29747. ******************************************************************************/
  29748. /******************************************************************************
  29749. ************************* Begin dot-file Locking ******************************
  29750. **
  29751. ** The dotfile locking implementation uses the existence of separate lock
  29752. ** files (really a directory) to control access to the database. This works
  29753. ** on just about every filesystem imaginable. But there are serious downsides:
  29754. **
  29755. ** (1) There is zero concurrency. A single reader blocks all other
  29756. ** connections from reading or writing the database.
  29757. **
  29758. ** (2) An application crash or power loss can leave stale lock files
  29759. ** sitting around that need to be cleared manually.
  29760. **
  29761. ** Nevertheless, a dotlock is an appropriate locking mode for use if no
  29762. ** other locking strategy is available.
  29763. **
  29764. ** Dotfile locking works by creating a subdirectory in the same directory as
  29765. ** the database and with the same name but with a ".lock" extension added.
  29766. ** The existence of a lock directory implies an EXCLUSIVE lock. All other
  29767. ** lock types (SHARED, RESERVED, PENDING) are mapped into EXCLUSIVE.
  29768. */
  29769. /*
  29770. ** The file suffix added to the data base filename in order to create the
  29771. ** lock directory.
  29772. */
  29773. #define DOTLOCK_SUFFIX ".lock"
  29774. /*
  29775. ** This routine checks if there is a RESERVED lock held on the specified
  29776. ** file by this or any other process. If such a lock is held, set *pResOut
  29777. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  29778. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  29779. **
  29780. ** In dotfile locking, either a lock exists or it does not. So in this
  29781. ** variation of CheckReservedLock(), *pResOut is set to true if any lock
  29782. ** is held on the file and false if the file is unlocked.
  29783. */
  29784. static int dotlockCheckReservedLock(sqlite3_file *id, int *pResOut) {
  29785. int rc = SQLITE_OK;
  29786. int reserved = 0;
  29787. unixFile *pFile = (unixFile*)id;
  29788. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  29789. assert( pFile );
  29790. reserved = osAccess((const char*)pFile->lockingContext, 0)==0;
  29791. OSTRACE(("TEST WR-LOCK %d %d %d (dotlock)\n", pFile->h, rc, reserved));
  29792. *pResOut = reserved;
  29793. return rc;
  29794. }
  29795. /*
  29796. ** Lock the file with the lock specified by parameter eFileLock - one
  29797. ** of the following:
  29798. **
  29799. ** (1) SHARED_LOCK
  29800. ** (2) RESERVED_LOCK
  29801. ** (3) PENDING_LOCK
  29802. ** (4) EXCLUSIVE_LOCK
  29803. **
  29804. ** Sometimes when requesting one lock state, additional lock states
  29805. ** are inserted in between. The locking might fail on one of the later
  29806. ** transitions leaving the lock state different from what it started but
  29807. ** still short of its goal. The following chart shows the allowed
  29808. ** transitions and the inserted intermediate states:
  29809. **
  29810. ** UNLOCKED -> SHARED
  29811. ** SHARED -> RESERVED
  29812. ** SHARED -> (PENDING) -> EXCLUSIVE
  29813. ** RESERVED -> (PENDING) -> EXCLUSIVE
  29814. ** PENDING -> EXCLUSIVE
  29815. **
  29816. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  29817. ** routine to lower a locking level.
  29818. **
  29819. ** With dotfile locking, we really only support state (4): EXCLUSIVE.
  29820. ** But we track the other locking levels internally.
  29821. */
  29822. static int dotlockLock(sqlite3_file *id, int eFileLock) {
  29823. unixFile *pFile = (unixFile*)id;
  29824. char *zLockFile = (char *)pFile->lockingContext;
  29825. int rc = SQLITE_OK;
  29826. /* If we have any lock, then the lock file already exists. All we have
  29827. ** to do is adjust our internal record of the lock level.
  29828. */
  29829. if( pFile->eFileLock > NO_LOCK ){
  29830. pFile->eFileLock = eFileLock;
  29831. /* Always update the timestamp on the old file */
  29832. #ifdef HAVE_UTIME
  29833. utime(zLockFile, NULL);
  29834. #else
  29835. utimes(zLockFile, NULL);
  29836. #endif
  29837. return SQLITE_OK;
  29838. }
  29839. /* grab an exclusive lock */
  29840. rc = osMkdir(zLockFile, 0777);
  29841. if( rc<0 ){
  29842. /* failed to open/create the lock directory */
  29843. int tErrno = errno;
  29844. if( EEXIST == tErrno ){
  29845. rc = SQLITE_BUSY;
  29846. } else {
  29847. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  29848. if( rc!=SQLITE_BUSY ){
  29849. storeLastErrno(pFile, tErrno);
  29850. }
  29851. }
  29852. return rc;
  29853. }
  29854. /* got it, set the type and return ok */
  29855. pFile->eFileLock = eFileLock;
  29856. return rc;
  29857. }
  29858. /*
  29859. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  29860. ** must be either NO_LOCK or SHARED_LOCK.
  29861. **
  29862. ** If the locking level of the file descriptor is already at or below
  29863. ** the requested locking level, this routine is a no-op.
  29864. **
  29865. ** When the locking level reaches NO_LOCK, delete the lock file.
  29866. */
  29867. static int dotlockUnlock(sqlite3_file *id, int eFileLock) {
  29868. unixFile *pFile = (unixFile*)id;
  29869. char *zLockFile = (char *)pFile->lockingContext;
  29870. int rc;
  29871. assert( pFile );
  29872. OSTRACE(("UNLOCK %d %d was %d pid=%d (dotlock)\n", pFile->h, eFileLock,
  29873. pFile->eFileLock, osGetpid(0)));
  29874. assert( eFileLock<=SHARED_LOCK );
  29875. /* no-op if possible */
  29876. if( pFile->eFileLock==eFileLock ){
  29877. return SQLITE_OK;
  29878. }
  29879. /* To downgrade to shared, simply update our internal notion of the
  29880. ** lock state. No need to mess with the file on disk.
  29881. */
  29882. if( eFileLock==SHARED_LOCK ){
  29883. pFile->eFileLock = SHARED_LOCK;
  29884. return SQLITE_OK;
  29885. }
  29886. /* To fully unlock the database, delete the lock file */
  29887. assert( eFileLock==NO_LOCK );
  29888. rc = osRmdir(zLockFile);
  29889. if( rc<0 ){
  29890. int tErrno = errno;
  29891. if( tErrno==ENOENT ){
  29892. rc = SQLITE_OK;
  29893. }else{
  29894. rc = SQLITE_IOERR_UNLOCK;
  29895. storeLastErrno(pFile, tErrno);
  29896. }
  29897. return rc;
  29898. }
  29899. pFile->eFileLock = NO_LOCK;
  29900. return SQLITE_OK;
  29901. }
  29902. /*
  29903. ** Close a file. Make sure the lock has been released before closing.
  29904. */
  29905. static int dotlockClose(sqlite3_file *id) {
  29906. unixFile *pFile = (unixFile*)id;
  29907. assert( id!=0 );
  29908. dotlockUnlock(id, NO_LOCK);
  29909. sqlite3_free(pFile->lockingContext);
  29910. return closeUnixFile(id);
  29911. }
  29912. /****************** End of the dot-file lock implementation *******************
  29913. ******************************************************************************/
  29914. /******************************************************************************
  29915. ************************** Begin flock Locking ********************************
  29916. **
  29917. ** Use the flock() system call to do file locking.
  29918. **
  29919. ** flock() locking is like dot-file locking in that the various
  29920. ** fine-grain locking levels supported by SQLite are collapsed into
  29921. ** a single exclusive lock. In other words, SHARED, RESERVED, and
  29922. ** PENDING locks are the same thing as an EXCLUSIVE lock. SQLite
  29923. ** still works when you do this, but concurrency is reduced since
  29924. ** only a single process can be reading the database at a time.
  29925. **
  29926. ** Omit this section if SQLITE_ENABLE_LOCKING_STYLE is turned off
  29927. */
  29928. #if SQLITE_ENABLE_LOCKING_STYLE
  29929. /*
  29930. ** Retry flock() calls that fail with EINTR
  29931. */
  29932. #ifdef EINTR
  29933. static int robust_flock(int fd, int op){
  29934. int rc;
  29935. do{ rc = flock(fd,op); }while( rc<0 && errno==EINTR );
  29936. return rc;
  29937. }
  29938. #else
  29939. # define robust_flock(a,b) flock(a,b)
  29940. #endif
  29941. /*
  29942. ** This routine checks if there is a RESERVED lock held on the specified
  29943. ** file by this or any other process. If such a lock is held, set *pResOut
  29944. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  29945. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  29946. */
  29947. static int flockCheckReservedLock(sqlite3_file *id, int *pResOut){
  29948. int rc = SQLITE_OK;
  29949. int reserved = 0;
  29950. unixFile *pFile = (unixFile*)id;
  29951. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  29952. assert( pFile );
  29953. /* Check if a thread in this process holds such a lock */
  29954. if( pFile->eFileLock>SHARED_LOCK ){
  29955. reserved = 1;
  29956. }
  29957. /* Otherwise see if some other process holds it. */
  29958. if( !reserved ){
  29959. /* attempt to get the lock */
  29960. int lrc = robust_flock(pFile->h, LOCK_EX | LOCK_NB);
  29961. if( !lrc ){
  29962. /* got the lock, unlock it */
  29963. lrc = robust_flock(pFile->h, LOCK_UN);
  29964. if ( lrc ) {
  29965. int tErrno = errno;
  29966. /* unlock failed with an error */
  29967. lrc = SQLITE_IOERR_UNLOCK;
  29968. storeLastErrno(pFile, tErrno);
  29969. rc = lrc;
  29970. }
  29971. } else {
  29972. int tErrno = errno;
  29973. reserved = 1;
  29974. /* someone else might have it reserved */
  29975. lrc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  29976. if( IS_LOCK_ERROR(lrc) ){
  29977. storeLastErrno(pFile, tErrno);
  29978. rc = lrc;
  29979. }
  29980. }
  29981. }
  29982. OSTRACE(("TEST WR-LOCK %d %d %d (flock)\n", pFile->h, rc, reserved));
  29983. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  29984. if( (rc & SQLITE_IOERR) == SQLITE_IOERR ){
  29985. rc = SQLITE_OK;
  29986. reserved=1;
  29987. }
  29988. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  29989. *pResOut = reserved;
  29990. return rc;
  29991. }
  29992. /*
  29993. ** Lock the file with the lock specified by parameter eFileLock - one
  29994. ** of the following:
  29995. **
  29996. ** (1) SHARED_LOCK
  29997. ** (2) RESERVED_LOCK
  29998. ** (3) PENDING_LOCK
  29999. ** (4) EXCLUSIVE_LOCK
  30000. **
  30001. ** Sometimes when requesting one lock state, additional lock states
  30002. ** are inserted in between. The locking might fail on one of the later
  30003. ** transitions leaving the lock state different from what it started but
  30004. ** still short of its goal. The following chart shows the allowed
  30005. ** transitions and the inserted intermediate states:
  30006. **
  30007. ** UNLOCKED -> SHARED
  30008. ** SHARED -> RESERVED
  30009. ** SHARED -> (PENDING) -> EXCLUSIVE
  30010. ** RESERVED -> (PENDING) -> EXCLUSIVE
  30011. ** PENDING -> EXCLUSIVE
  30012. **
  30013. ** flock() only really support EXCLUSIVE locks. We track intermediate
  30014. ** lock states in the sqlite3_file structure, but all locks SHARED or
  30015. ** above are really EXCLUSIVE locks and exclude all other processes from
  30016. ** access the file.
  30017. **
  30018. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  30019. ** routine to lower a locking level.
  30020. */
  30021. static int flockLock(sqlite3_file *id, int eFileLock) {
  30022. int rc = SQLITE_OK;
  30023. unixFile *pFile = (unixFile*)id;
  30024. assert( pFile );
  30025. /* if we already have a lock, it is exclusive.
  30026. ** Just adjust level and punt on outta here. */
  30027. if (pFile->eFileLock > NO_LOCK) {
  30028. pFile->eFileLock = eFileLock;
  30029. return SQLITE_OK;
  30030. }
  30031. /* grab an exclusive lock */
  30032. if (robust_flock(pFile->h, LOCK_EX | LOCK_NB)) {
  30033. int tErrno = errno;
  30034. /* didn't get, must be busy */
  30035. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  30036. if( IS_LOCK_ERROR(rc) ){
  30037. storeLastErrno(pFile, tErrno);
  30038. }
  30039. } else {
  30040. /* got it, set the type and return ok */
  30041. pFile->eFileLock = eFileLock;
  30042. }
  30043. OSTRACE(("LOCK %d %s %s (flock)\n", pFile->h, azFileLock(eFileLock),
  30044. rc==SQLITE_OK ? "ok" : "failed"));
  30045. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  30046. if( (rc & SQLITE_IOERR) == SQLITE_IOERR ){
  30047. rc = SQLITE_BUSY;
  30048. }
  30049. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  30050. return rc;
  30051. }
  30052. /*
  30053. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  30054. ** must be either NO_LOCK or SHARED_LOCK.
  30055. **
  30056. ** If the locking level of the file descriptor is already at or below
  30057. ** the requested locking level, this routine is a no-op.
  30058. */
  30059. static int flockUnlock(sqlite3_file *id, int eFileLock) {
  30060. unixFile *pFile = (unixFile*)id;
  30061. assert( pFile );
  30062. OSTRACE(("UNLOCK %d %d was %d pid=%d (flock)\n", pFile->h, eFileLock,
  30063. pFile->eFileLock, osGetpid(0)));
  30064. assert( eFileLock<=SHARED_LOCK );
  30065. /* no-op if possible */
  30066. if( pFile->eFileLock==eFileLock ){
  30067. return SQLITE_OK;
  30068. }
  30069. /* shared can just be set because we always have an exclusive */
  30070. if (eFileLock==SHARED_LOCK) {
  30071. pFile->eFileLock = eFileLock;
  30072. return SQLITE_OK;
  30073. }
  30074. /* no, really, unlock. */
  30075. if( robust_flock(pFile->h, LOCK_UN) ){
  30076. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  30077. return SQLITE_OK;
  30078. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  30079. return SQLITE_IOERR_UNLOCK;
  30080. }else{
  30081. pFile->eFileLock = NO_LOCK;
  30082. return SQLITE_OK;
  30083. }
  30084. }
  30085. /*
  30086. ** Close a file.
  30087. */
  30088. static int flockClose(sqlite3_file *id) {
  30089. assert( id!=0 );
  30090. flockUnlock(id, NO_LOCK);
  30091. return closeUnixFile(id);
  30092. }
  30093. #endif /* SQLITE_ENABLE_LOCKING_STYLE && !OS_VXWORK */
  30094. /******************* End of the flock lock implementation *********************
  30095. ******************************************************************************/
  30096. /******************************************************************************
  30097. ************************ Begin Named Semaphore Locking ************************
  30098. **
  30099. ** Named semaphore locking is only supported on VxWorks.
  30100. **
  30101. ** Semaphore locking is like dot-lock and flock in that it really only
  30102. ** supports EXCLUSIVE locking. Only a single process can read or write
  30103. ** the database file at a time. This reduces potential concurrency, but
  30104. ** makes the lock implementation much easier.
  30105. */
  30106. #if OS_VXWORKS
  30107. /*
  30108. ** This routine checks if there is a RESERVED lock held on the specified
  30109. ** file by this or any other process. If such a lock is held, set *pResOut
  30110. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  30111. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  30112. */
  30113. static int semXCheckReservedLock(sqlite3_file *id, int *pResOut) {
  30114. int rc = SQLITE_OK;
  30115. int reserved = 0;
  30116. unixFile *pFile = (unixFile*)id;
  30117. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  30118. assert( pFile );
  30119. /* Check if a thread in this process holds such a lock */
  30120. if( pFile->eFileLock>SHARED_LOCK ){
  30121. reserved = 1;
  30122. }
  30123. /* Otherwise see if some other process holds it. */
  30124. if( !reserved ){
  30125. sem_t *pSem = pFile->pInode->pSem;
  30126. if( sem_trywait(pSem)==-1 ){
  30127. int tErrno = errno;
  30128. if( EAGAIN != tErrno ){
  30129. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_CHECKRESERVEDLOCK);
  30130. storeLastErrno(pFile, tErrno);
  30131. } else {
  30132. /* someone else has the lock when we are in NO_LOCK */
  30133. reserved = (pFile->eFileLock < SHARED_LOCK);
  30134. }
  30135. }else{
  30136. /* we could have it if we want it */
  30137. sem_post(pSem);
  30138. }
  30139. }
  30140. OSTRACE(("TEST WR-LOCK %d %d %d (sem)\n", pFile->h, rc, reserved));
  30141. *pResOut = reserved;
  30142. return rc;
  30143. }
  30144. /*
  30145. ** Lock the file with the lock specified by parameter eFileLock - one
  30146. ** of the following:
  30147. **
  30148. ** (1) SHARED_LOCK
  30149. ** (2) RESERVED_LOCK
  30150. ** (3) PENDING_LOCK
  30151. ** (4) EXCLUSIVE_LOCK
  30152. **
  30153. ** Sometimes when requesting one lock state, additional lock states
  30154. ** are inserted in between. The locking might fail on one of the later
  30155. ** transitions leaving the lock state different from what it started but
  30156. ** still short of its goal. The following chart shows the allowed
  30157. ** transitions and the inserted intermediate states:
  30158. **
  30159. ** UNLOCKED -> SHARED
  30160. ** SHARED -> RESERVED
  30161. ** SHARED -> (PENDING) -> EXCLUSIVE
  30162. ** RESERVED -> (PENDING) -> EXCLUSIVE
  30163. ** PENDING -> EXCLUSIVE
  30164. **
  30165. ** Semaphore locks only really support EXCLUSIVE locks. We track intermediate
  30166. ** lock states in the sqlite3_file structure, but all locks SHARED or
  30167. ** above are really EXCLUSIVE locks and exclude all other processes from
  30168. ** access the file.
  30169. **
  30170. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  30171. ** routine to lower a locking level.
  30172. */
  30173. static int semXLock(sqlite3_file *id, int eFileLock) {
  30174. unixFile *pFile = (unixFile*)id;
  30175. sem_t *pSem = pFile->pInode->pSem;
  30176. int rc = SQLITE_OK;
  30177. /* if we already have a lock, it is exclusive.
  30178. ** Just adjust level and punt on outta here. */
  30179. if (pFile->eFileLock > NO_LOCK) {
  30180. pFile->eFileLock = eFileLock;
  30181. rc = SQLITE_OK;
  30182. goto sem_end_lock;
  30183. }
  30184. /* lock semaphore now but bail out when already locked. */
  30185. if( sem_trywait(pSem)==-1 ){
  30186. rc = SQLITE_BUSY;
  30187. goto sem_end_lock;
  30188. }
  30189. /* got it, set the type and return ok */
  30190. pFile->eFileLock = eFileLock;
  30191. sem_end_lock:
  30192. return rc;
  30193. }
  30194. /*
  30195. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  30196. ** must be either NO_LOCK or SHARED_LOCK.
  30197. **
  30198. ** If the locking level of the file descriptor is already at or below
  30199. ** the requested locking level, this routine is a no-op.
  30200. */
  30201. static int semXUnlock(sqlite3_file *id, int eFileLock) {
  30202. unixFile *pFile = (unixFile*)id;
  30203. sem_t *pSem = pFile->pInode->pSem;
  30204. assert( pFile );
  30205. assert( pSem );
  30206. OSTRACE(("UNLOCK %d %d was %d pid=%d (sem)\n", pFile->h, eFileLock,
  30207. pFile->eFileLock, osGetpid(0)));
  30208. assert( eFileLock<=SHARED_LOCK );
  30209. /* no-op if possible */
  30210. if( pFile->eFileLock==eFileLock ){
  30211. return SQLITE_OK;
  30212. }
  30213. /* shared can just be set because we always have an exclusive */
  30214. if (eFileLock==SHARED_LOCK) {
  30215. pFile->eFileLock = eFileLock;
  30216. return SQLITE_OK;
  30217. }
  30218. /* no, really unlock. */
  30219. if ( sem_post(pSem)==-1 ) {
  30220. int rc, tErrno = errno;
  30221. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
  30222. if( IS_LOCK_ERROR(rc) ){
  30223. storeLastErrno(pFile, tErrno);
  30224. }
  30225. return rc;
  30226. }
  30227. pFile->eFileLock = NO_LOCK;
  30228. return SQLITE_OK;
  30229. }
  30230. /*
  30231. ** Close a file.
  30232. */
  30233. static int semXClose(sqlite3_file *id) {
  30234. if( id ){
  30235. unixFile *pFile = (unixFile*)id;
  30236. semXUnlock(id, NO_LOCK);
  30237. assert( pFile );
  30238. unixEnterMutex();
  30239. releaseInodeInfo(pFile);
  30240. unixLeaveMutex();
  30241. closeUnixFile(id);
  30242. }
  30243. return SQLITE_OK;
  30244. }
  30245. #endif /* OS_VXWORKS */
  30246. /*
  30247. ** Named semaphore locking is only available on VxWorks.
  30248. **
  30249. *************** End of the named semaphore lock implementation ****************
  30250. ******************************************************************************/
  30251. /******************************************************************************
  30252. *************************** Begin AFP Locking *********************************
  30253. **
  30254. ** AFP is the Apple Filing Protocol. AFP is a network filesystem found
  30255. ** on Apple Macintosh computers - both OS9 and OSX.
  30256. **
  30257. ** Third-party implementations of AFP are available. But this code here
  30258. ** only works on OSX.
  30259. */
  30260. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  30261. /*
  30262. ** The afpLockingContext structure contains all afp lock specific state
  30263. */
  30264. typedef struct afpLockingContext afpLockingContext;
  30265. struct afpLockingContext {
  30266. int reserved;
  30267. const char *dbPath; /* Name of the open file */
  30268. };
  30269. struct ByteRangeLockPB2
  30270. {
  30271. unsigned long long offset; /* offset to first byte to lock */
  30272. unsigned long long length; /* nbr of bytes to lock */
  30273. unsigned long long retRangeStart; /* nbr of 1st byte locked if successful */
  30274. unsigned char unLockFlag; /* 1 = unlock, 0 = lock */
  30275. unsigned char startEndFlag; /* 1=rel to end of fork, 0=rel to start */
  30276. int fd; /* file desc to assoc this lock with */
  30277. };
  30278. #define afpfsByteRangeLock2FSCTL _IOWR('z', 23, struct ByteRangeLockPB2)
  30279. /*
  30280. ** This is a utility for setting or clearing a bit-range lock on an
  30281. ** AFP filesystem.
  30282. **
  30283. ** Return SQLITE_OK on success, SQLITE_BUSY on failure.
  30284. */
  30285. static int afpSetLock(
  30286. const char *path, /* Name of the file to be locked or unlocked */
  30287. unixFile *pFile, /* Open file descriptor on path */
  30288. unsigned long long offset, /* First byte to be locked */
  30289. unsigned long long length, /* Number of bytes to lock */
  30290. int setLockFlag /* True to set lock. False to clear lock */
  30291. ){
  30292. struct ByteRangeLockPB2 pb;
  30293. int err;
  30294. pb.unLockFlag = setLockFlag ? 0 : 1;
  30295. pb.startEndFlag = 0;
  30296. pb.offset = offset;
  30297. pb.length = length;
  30298. pb.fd = pFile->h;
  30299. OSTRACE(("AFPSETLOCK [%s] for %d%s in range %llx:%llx\n",
  30300. (setLockFlag?"ON":"OFF"), pFile->h, (pb.fd==-1?"[testval-1]":""),
  30301. offset, length));
  30302. err = fsctl(path, afpfsByteRangeLock2FSCTL, &pb, 0);
  30303. if ( err==-1 ) {
  30304. int rc;
  30305. int tErrno = errno;
  30306. OSTRACE(("AFPSETLOCK failed to fsctl() '%s' %d %s\n",
  30307. path, tErrno, strerror(tErrno)));
  30308. #ifdef SQLITE_IGNORE_AFP_LOCK_ERRORS
  30309. rc = SQLITE_BUSY;
  30310. #else
  30311. rc = sqliteErrorFromPosixError(tErrno,
  30312. setLockFlag ? SQLITE_IOERR_LOCK : SQLITE_IOERR_UNLOCK);
  30313. #endif /* SQLITE_IGNORE_AFP_LOCK_ERRORS */
  30314. if( IS_LOCK_ERROR(rc) ){
  30315. storeLastErrno(pFile, tErrno);
  30316. }
  30317. return rc;
  30318. } else {
  30319. return SQLITE_OK;
  30320. }
  30321. }
  30322. /*
  30323. ** This routine checks if there is a RESERVED lock held on the specified
  30324. ** file by this or any other process. If such a lock is held, set *pResOut
  30325. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  30326. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  30327. */
  30328. static int afpCheckReservedLock(sqlite3_file *id, int *pResOut){
  30329. int rc = SQLITE_OK;
  30330. int reserved = 0;
  30331. unixFile *pFile = (unixFile*)id;
  30332. afpLockingContext *context;
  30333. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  30334. assert( pFile );
  30335. context = (afpLockingContext *) pFile->lockingContext;
  30336. if( context->reserved ){
  30337. *pResOut = 1;
  30338. return SQLITE_OK;
  30339. }
  30340. unixEnterMutex(); /* Because pFile->pInode is shared across threads */
  30341. /* Check if a thread in this process holds such a lock */
  30342. if( pFile->pInode->eFileLock>SHARED_LOCK ){
  30343. reserved = 1;
  30344. }
  30345. /* Otherwise see if some other process holds it.
  30346. */
  30347. if( !reserved ){
  30348. /* lock the RESERVED byte */
  30349. int lrc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1,1);
  30350. if( SQLITE_OK==lrc ){
  30351. /* if we succeeded in taking the reserved lock, unlock it to restore
  30352. ** the original state */
  30353. lrc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1, 0);
  30354. } else {
  30355. /* if we failed to get the lock then someone else must have it */
  30356. reserved = 1;
  30357. }
  30358. if( IS_LOCK_ERROR(lrc) ){
  30359. rc=lrc;
  30360. }
  30361. }
  30362. unixLeaveMutex();
  30363. OSTRACE(("TEST WR-LOCK %d %d %d (afp)\n", pFile->h, rc, reserved));
  30364. *pResOut = reserved;
  30365. return rc;
  30366. }
  30367. /*
  30368. ** Lock the file with the lock specified by parameter eFileLock - one
  30369. ** of the following:
  30370. **
  30371. ** (1) SHARED_LOCK
  30372. ** (2) RESERVED_LOCK
  30373. ** (3) PENDING_LOCK
  30374. ** (4) EXCLUSIVE_LOCK
  30375. **
  30376. ** Sometimes when requesting one lock state, additional lock states
  30377. ** are inserted in between. The locking might fail on one of the later
  30378. ** transitions leaving the lock state different from what it started but
  30379. ** still short of its goal. The following chart shows the allowed
  30380. ** transitions and the inserted intermediate states:
  30381. **
  30382. ** UNLOCKED -> SHARED
  30383. ** SHARED -> RESERVED
  30384. ** SHARED -> (PENDING) -> EXCLUSIVE
  30385. ** RESERVED -> (PENDING) -> EXCLUSIVE
  30386. ** PENDING -> EXCLUSIVE
  30387. **
  30388. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  30389. ** routine to lower a locking level.
  30390. */
  30391. static int afpLock(sqlite3_file *id, int eFileLock){
  30392. int rc = SQLITE_OK;
  30393. unixFile *pFile = (unixFile*)id;
  30394. unixInodeInfo *pInode = pFile->pInode;
  30395. afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
  30396. assert( pFile );
  30397. OSTRACE(("LOCK %d %s was %s(%s,%d) pid=%d (afp)\n", pFile->h,
  30398. azFileLock(eFileLock), azFileLock(pFile->eFileLock),
  30399. azFileLock(pInode->eFileLock), pInode->nShared , osGetpid(0)));
  30400. /* If there is already a lock of this type or more restrictive on the
  30401. ** unixFile, do nothing. Don't use the afp_end_lock: exit path, as
  30402. ** unixEnterMutex() hasn't been called yet.
  30403. */
  30404. if( pFile->eFileLock>=eFileLock ){
  30405. OSTRACE(("LOCK %d %s ok (already held) (afp)\n", pFile->h,
  30406. azFileLock(eFileLock)));
  30407. return SQLITE_OK;
  30408. }
  30409. /* Make sure the locking sequence is correct
  30410. ** (1) We never move from unlocked to anything higher than shared lock.
  30411. ** (2) SQLite never explicitly requests a pendig lock.
  30412. ** (3) A shared lock is always held when a reserve lock is requested.
  30413. */
  30414. assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK );
  30415. assert( eFileLock!=PENDING_LOCK );
  30416. assert( eFileLock!=RESERVED_LOCK || pFile->eFileLock==SHARED_LOCK );
  30417. /* This mutex is needed because pFile->pInode is shared across threads
  30418. */
  30419. unixEnterMutex();
  30420. pInode = pFile->pInode;
  30421. /* If some thread using this PID has a lock via a different unixFile*
  30422. ** handle that precludes the requested lock, return BUSY.
  30423. */
  30424. if( (pFile->eFileLock!=pInode->eFileLock &&
  30425. (pInode->eFileLock>=PENDING_LOCK || eFileLock>SHARED_LOCK))
  30426. ){
  30427. rc = SQLITE_BUSY;
  30428. goto afp_end_lock;
  30429. }
  30430. /* If a SHARED lock is requested, and some thread using this PID already
  30431. ** has a SHARED or RESERVED lock, then increment reference counts and
  30432. ** return SQLITE_OK.
  30433. */
  30434. if( eFileLock==SHARED_LOCK &&
  30435. (pInode->eFileLock==SHARED_LOCK || pInode->eFileLock==RESERVED_LOCK) ){
  30436. assert( eFileLock==SHARED_LOCK );
  30437. assert( pFile->eFileLock==0 );
  30438. assert( pInode->nShared>0 );
  30439. pFile->eFileLock = SHARED_LOCK;
  30440. pInode->nShared++;
  30441. pInode->nLock++;
  30442. goto afp_end_lock;
  30443. }
  30444. /* A PENDING lock is needed before acquiring a SHARED lock and before
  30445. ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
  30446. ** be released.
  30447. */
  30448. if( eFileLock==SHARED_LOCK
  30449. || (eFileLock==EXCLUSIVE_LOCK && pFile->eFileLock<PENDING_LOCK)
  30450. ){
  30451. int failed;
  30452. failed = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 1);
  30453. if (failed) {
  30454. rc = failed;
  30455. goto afp_end_lock;
  30456. }
  30457. }
  30458. /* If control gets to this point, then actually go ahead and make
  30459. ** operating system calls for the specified lock.
  30460. */
  30461. if( eFileLock==SHARED_LOCK ){
  30462. int lrc1, lrc2, lrc1Errno = 0;
  30463. long lk, mask;
  30464. assert( pInode->nShared==0 );
  30465. assert( pInode->eFileLock==0 );
  30466. mask = (sizeof(long)==8) ? LARGEST_INT64 : 0x7fffffff;
  30467. /* Now get the read-lock SHARED_LOCK */
  30468. /* note that the quality of the randomness doesn't matter that much */
  30469. lk = random();
  30470. pInode->sharedByte = (lk & mask)%(SHARED_SIZE - 1);
  30471. lrc1 = afpSetLock(context->dbPath, pFile,
  30472. SHARED_FIRST+pInode->sharedByte, 1, 1);
  30473. if( IS_LOCK_ERROR(lrc1) ){
  30474. lrc1Errno = pFile->lastErrno;
  30475. }
  30476. /* Drop the temporary PENDING lock */
  30477. lrc2 = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 0);
  30478. if( IS_LOCK_ERROR(lrc1) ) {
  30479. storeLastErrno(pFile, lrc1Errno);
  30480. rc = lrc1;
  30481. goto afp_end_lock;
  30482. } else if( IS_LOCK_ERROR(lrc2) ){
  30483. rc = lrc2;
  30484. goto afp_end_lock;
  30485. } else if( lrc1 != SQLITE_OK ) {
  30486. rc = lrc1;
  30487. } else {
  30488. pFile->eFileLock = SHARED_LOCK;
  30489. pInode->nLock++;
  30490. pInode->nShared = 1;
  30491. }
  30492. }else if( eFileLock==EXCLUSIVE_LOCK && pInode->nShared>1 ){
  30493. /* We are trying for an exclusive lock but another thread in this
  30494. ** same process is still holding a shared lock. */
  30495. rc = SQLITE_BUSY;
  30496. }else{
  30497. /* The request was for a RESERVED or EXCLUSIVE lock. It is
  30498. ** assumed that there is a SHARED or greater lock on the file
  30499. ** already.
  30500. */
  30501. int failed = 0;
  30502. assert( 0!=pFile->eFileLock );
  30503. if (eFileLock >= RESERVED_LOCK && pFile->eFileLock < RESERVED_LOCK) {
  30504. /* Acquire a RESERVED lock */
  30505. failed = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1,1);
  30506. if( !failed ){
  30507. context->reserved = 1;
  30508. }
  30509. }
  30510. if (!failed && eFileLock == EXCLUSIVE_LOCK) {
  30511. /* Acquire an EXCLUSIVE lock */
  30512. /* Remove the shared lock before trying the range. we'll need to
  30513. ** reestablish the shared lock if we can't get the afpUnlock
  30514. */
  30515. if( !(failed = afpSetLock(context->dbPath, pFile, SHARED_FIRST +
  30516. pInode->sharedByte, 1, 0)) ){
  30517. int failed2 = SQLITE_OK;
  30518. /* now attemmpt to get the exclusive lock range */
  30519. failed = afpSetLock(context->dbPath, pFile, SHARED_FIRST,
  30520. SHARED_SIZE, 1);
  30521. if( failed && (failed2 = afpSetLock(context->dbPath, pFile,
  30522. SHARED_FIRST + pInode->sharedByte, 1, 1)) ){
  30523. /* Can't reestablish the shared lock. Sqlite can't deal, this is
  30524. ** a critical I/O error
  30525. */
  30526. rc = ((failed & SQLITE_IOERR) == SQLITE_IOERR) ? failed2 :
  30527. SQLITE_IOERR_LOCK;
  30528. goto afp_end_lock;
  30529. }
  30530. }else{
  30531. rc = failed;
  30532. }
  30533. }
  30534. if( failed ){
  30535. rc = failed;
  30536. }
  30537. }
  30538. if( rc==SQLITE_OK ){
  30539. pFile->eFileLock = eFileLock;
  30540. pInode->eFileLock = eFileLock;
  30541. }else if( eFileLock==EXCLUSIVE_LOCK ){
  30542. pFile->eFileLock = PENDING_LOCK;
  30543. pInode->eFileLock = PENDING_LOCK;
  30544. }
  30545. afp_end_lock:
  30546. unixLeaveMutex();
  30547. OSTRACE(("LOCK %d %s %s (afp)\n", pFile->h, azFileLock(eFileLock),
  30548. rc==SQLITE_OK ? "ok" : "failed"));
  30549. return rc;
  30550. }
  30551. /*
  30552. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  30553. ** must be either NO_LOCK or SHARED_LOCK.
  30554. **
  30555. ** If the locking level of the file descriptor is already at or below
  30556. ** the requested locking level, this routine is a no-op.
  30557. */
  30558. static int afpUnlock(sqlite3_file *id, int eFileLock) {
  30559. int rc = SQLITE_OK;
  30560. unixFile *pFile = (unixFile*)id;
  30561. unixInodeInfo *pInode;
  30562. afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
  30563. int skipShared = 0;
  30564. #ifdef SQLITE_TEST
  30565. int h = pFile->h;
  30566. #endif
  30567. assert( pFile );
  30568. OSTRACE(("UNLOCK %d %d was %d(%d,%d) pid=%d (afp)\n", pFile->h, eFileLock,
  30569. pFile->eFileLock, pFile->pInode->eFileLock, pFile->pInode->nShared,
  30570. osGetpid(0)));
  30571. assert( eFileLock<=SHARED_LOCK );
  30572. if( pFile->eFileLock<=eFileLock ){
  30573. return SQLITE_OK;
  30574. }
  30575. unixEnterMutex();
  30576. pInode = pFile->pInode;
  30577. assert( pInode->nShared!=0 );
  30578. if( pFile->eFileLock>SHARED_LOCK ){
  30579. assert( pInode->eFileLock==pFile->eFileLock );
  30580. SimulateIOErrorBenign(1);
  30581. SimulateIOError( h=(-1) )
  30582. SimulateIOErrorBenign(0);
  30583. #ifdef SQLITE_DEBUG
  30584. /* When reducing a lock such that other processes can start
  30585. ** reading the database file again, make sure that the
  30586. ** transaction counter was updated if any part of the database
  30587. ** file changed. If the transaction counter is not updated,
  30588. ** other connections to the same file might not realize that
  30589. ** the file has changed and hence might not know to flush their
  30590. ** cache. The use of a stale cache can lead to database corruption.
  30591. */
  30592. assert( pFile->inNormalWrite==0
  30593. || pFile->dbUpdate==0
  30594. || pFile->transCntrChng==1 );
  30595. pFile->inNormalWrite = 0;
  30596. #endif
  30597. if( pFile->eFileLock==EXCLUSIVE_LOCK ){
  30598. rc = afpSetLock(context->dbPath, pFile, SHARED_FIRST, SHARED_SIZE, 0);
  30599. if( rc==SQLITE_OK && (eFileLock==SHARED_LOCK || pInode->nShared>1) ){
  30600. /* only re-establish the shared lock if necessary */
  30601. int sharedLockByte = SHARED_FIRST+pInode->sharedByte;
  30602. rc = afpSetLock(context->dbPath, pFile, sharedLockByte, 1, 1);
  30603. } else {
  30604. skipShared = 1;
  30605. }
  30606. }
  30607. if( rc==SQLITE_OK && pFile->eFileLock>=PENDING_LOCK ){
  30608. rc = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 0);
  30609. }
  30610. if( rc==SQLITE_OK && pFile->eFileLock>=RESERVED_LOCK && context->reserved ){
  30611. rc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1, 0);
  30612. if( !rc ){
  30613. context->reserved = 0;
  30614. }
  30615. }
  30616. if( rc==SQLITE_OK && (eFileLock==SHARED_LOCK || pInode->nShared>1)){
  30617. pInode->eFileLock = SHARED_LOCK;
  30618. }
  30619. }
  30620. if( rc==SQLITE_OK && eFileLock==NO_LOCK ){
  30621. /* Decrement the shared lock counter. Release the lock using an
  30622. ** OS call only when all threads in this same process have released
  30623. ** the lock.
  30624. */
  30625. unsigned long long sharedLockByte = SHARED_FIRST+pInode->sharedByte;
  30626. pInode->nShared--;
  30627. if( pInode->nShared==0 ){
  30628. SimulateIOErrorBenign(1);
  30629. SimulateIOError( h=(-1) )
  30630. SimulateIOErrorBenign(0);
  30631. if( !skipShared ){
  30632. rc = afpSetLock(context->dbPath, pFile, sharedLockByte, 1, 0);
  30633. }
  30634. if( !rc ){
  30635. pInode->eFileLock = NO_LOCK;
  30636. pFile->eFileLock = NO_LOCK;
  30637. }
  30638. }
  30639. if( rc==SQLITE_OK ){
  30640. pInode->nLock--;
  30641. assert( pInode->nLock>=0 );
  30642. if( pInode->nLock==0 ){
  30643. closePendingFds(pFile);
  30644. }
  30645. }
  30646. }
  30647. unixLeaveMutex();
  30648. if( rc==SQLITE_OK ) pFile->eFileLock = eFileLock;
  30649. return rc;
  30650. }
  30651. /*
  30652. ** Close a file & cleanup AFP specific locking context
  30653. */
  30654. static int afpClose(sqlite3_file *id) {
  30655. int rc = SQLITE_OK;
  30656. unixFile *pFile = (unixFile*)id;
  30657. assert( id!=0 );
  30658. afpUnlock(id, NO_LOCK);
  30659. unixEnterMutex();
  30660. if( pFile->pInode && pFile->pInode->nLock ){
  30661. /* If there are outstanding locks, do not actually close the file just
  30662. ** yet because that would clear those locks. Instead, add the file
  30663. ** descriptor to pInode->aPending. It will be automatically closed when
  30664. ** the last lock is cleared.
  30665. */
  30666. setPendingFd(pFile);
  30667. }
  30668. releaseInodeInfo(pFile);
  30669. sqlite3_free(pFile->lockingContext);
  30670. rc = closeUnixFile(id);
  30671. unixLeaveMutex();
  30672. return rc;
  30673. }
  30674. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  30675. /*
  30676. ** The code above is the AFP lock implementation. The code is specific
  30677. ** to MacOSX and does not work on other unix platforms. No alternative
  30678. ** is available. If you don't compile for a mac, then the "unix-afp"
  30679. ** VFS is not available.
  30680. **
  30681. ********************* End of the AFP lock implementation **********************
  30682. ******************************************************************************/
  30683. /******************************************************************************
  30684. *************************** Begin NFS Locking ********************************/
  30685. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  30686. /*
  30687. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  30688. ** must be either NO_LOCK or SHARED_LOCK.
  30689. **
  30690. ** If the locking level of the file descriptor is already at or below
  30691. ** the requested locking level, this routine is a no-op.
  30692. */
  30693. static int nfsUnlock(sqlite3_file *id, int eFileLock){
  30694. return posixUnlock(id, eFileLock, 1);
  30695. }
  30696. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  30697. /*
  30698. ** The code above is the NFS lock implementation. The code is specific
  30699. ** to MacOSX and does not work on other unix platforms. No alternative
  30700. ** is available.
  30701. **
  30702. ********************* End of the NFS lock implementation **********************
  30703. ******************************************************************************/
  30704. /******************************************************************************
  30705. **************** Non-locking sqlite3_file methods *****************************
  30706. **
  30707. ** The next division contains implementations for all methods of the
  30708. ** sqlite3_file object other than the locking methods. The locking
  30709. ** methods were defined in divisions above (one locking method per
  30710. ** division). Those methods that are common to all locking modes
  30711. ** are gather together into this division.
  30712. */
  30713. /*
  30714. ** Seek to the offset passed as the second argument, then read cnt
  30715. ** bytes into pBuf. Return the number of bytes actually read.
  30716. **
  30717. ** NB: If you define USE_PREAD or USE_PREAD64, then it might also
  30718. ** be necessary to define _XOPEN_SOURCE to be 500. This varies from
  30719. ** one system to another. Since SQLite does not define USE_PREAD
  30720. ** in any form by default, we will not attempt to define _XOPEN_SOURCE.
  30721. ** See tickets #2741 and #2681.
  30722. **
  30723. ** To avoid stomping the errno value on a failed read the lastErrno value
  30724. ** is set before returning.
  30725. */
  30726. static int seekAndRead(unixFile *id, sqlite3_int64 offset, void *pBuf, int cnt){
  30727. int got;
  30728. int prior = 0;
  30729. #if (!defined(USE_PREAD) && !defined(USE_PREAD64))
  30730. i64 newOffset;
  30731. #endif
  30732. TIMER_START;
  30733. assert( cnt==(cnt&0x1ffff) );
  30734. assert( id->h>2 );
  30735. do{
  30736. #if defined(USE_PREAD)
  30737. got = osPread(id->h, pBuf, cnt, offset);
  30738. SimulateIOError( got = -1 );
  30739. #elif defined(USE_PREAD64)
  30740. got = osPread64(id->h, pBuf, cnt, offset);
  30741. SimulateIOError( got = -1 );
  30742. #else
  30743. newOffset = lseek(id->h, offset, SEEK_SET);
  30744. SimulateIOError( newOffset = -1 );
  30745. if( newOffset<0 ){
  30746. storeLastErrno((unixFile*)id, errno);
  30747. return -1;
  30748. }
  30749. got = osRead(id->h, pBuf, cnt);
  30750. #endif
  30751. if( got==cnt ) break;
  30752. if( got<0 ){
  30753. if( errno==EINTR ){ got = 1; continue; }
  30754. prior = 0;
  30755. storeLastErrno((unixFile*)id, errno);
  30756. break;
  30757. }else if( got>0 ){
  30758. cnt -= got;
  30759. offset += got;
  30760. prior += got;
  30761. pBuf = (void*)(got + (char*)pBuf);
  30762. }
  30763. }while( got>0 );
  30764. TIMER_END;
  30765. OSTRACE(("READ %-3d %5d %7lld %llu\n",
  30766. id->h, got+prior, offset-prior, TIMER_ELAPSED));
  30767. return got+prior;
  30768. }
  30769. /*
  30770. ** Read data from a file into a buffer. Return SQLITE_OK if all
  30771. ** bytes were read successfully and SQLITE_IOERR if anything goes
  30772. ** wrong.
  30773. */
  30774. static int unixRead(
  30775. sqlite3_file *id,
  30776. void *pBuf,
  30777. int amt,
  30778. sqlite3_int64 offset
  30779. ){
  30780. unixFile *pFile = (unixFile *)id;
  30781. int got;
  30782. assert( id );
  30783. assert( offset>=0 );
  30784. assert( amt>0 );
  30785. /* If this is a database file (not a journal, master-journal or temp
  30786. ** file), the bytes in the locking range should never be read or written. */
  30787. #if 0
  30788. assert( pFile->pUnused==0
  30789. || offset>=PENDING_BYTE+512
  30790. || offset+amt<=PENDING_BYTE
  30791. );
  30792. #endif
  30793. #if SQLITE_MAX_MMAP_SIZE>0
  30794. /* Deal with as much of this read request as possible by transfering
  30795. ** data from the memory mapping using memcpy(). */
  30796. if( offset<pFile->mmapSize ){
  30797. if( offset+amt <= pFile->mmapSize ){
  30798. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], amt);
  30799. return SQLITE_OK;
  30800. }else{
  30801. int nCopy = pFile->mmapSize - offset;
  30802. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], nCopy);
  30803. pBuf = &((u8 *)pBuf)[nCopy];
  30804. amt -= nCopy;
  30805. offset += nCopy;
  30806. }
  30807. }
  30808. #endif
  30809. got = seekAndRead(pFile, offset, pBuf, amt);
  30810. if( got==amt ){
  30811. return SQLITE_OK;
  30812. }else if( got<0 ){
  30813. /* lastErrno set by seekAndRead */
  30814. return SQLITE_IOERR_READ;
  30815. }else{
  30816. storeLastErrno(pFile, 0); /* not a system error */
  30817. /* Unread parts of the buffer must be zero-filled */
  30818. memset(&((char*)pBuf)[got], 0, amt-got);
  30819. return SQLITE_IOERR_SHORT_READ;
  30820. }
  30821. }
  30822. /*
  30823. ** Attempt to seek the file-descriptor passed as the first argument to
  30824. ** absolute offset iOff, then attempt to write nBuf bytes of data from
  30825. ** pBuf to it. If an error occurs, return -1 and set *piErrno. Otherwise,
  30826. ** return the actual number of bytes written (which may be less than
  30827. ** nBuf).
  30828. */
  30829. static int seekAndWriteFd(
  30830. int fd, /* File descriptor to write to */
  30831. i64 iOff, /* File offset to begin writing at */
  30832. const void *pBuf, /* Copy data from this buffer to the file */
  30833. int nBuf, /* Size of buffer pBuf in bytes */
  30834. int *piErrno /* OUT: Error number if error occurs */
  30835. ){
  30836. int rc = 0; /* Value returned by system call */
  30837. assert( nBuf==(nBuf&0x1ffff) );
  30838. assert( fd>2 );
  30839. assert( piErrno!=0 );
  30840. nBuf &= 0x1ffff;
  30841. TIMER_START;
  30842. #if defined(USE_PREAD)
  30843. do{ rc = (int)osPwrite(fd, pBuf, nBuf, iOff); }while( rc<0 && errno==EINTR );
  30844. #elif defined(USE_PREAD64)
  30845. do{ rc = (int)osPwrite64(fd, pBuf, nBuf, iOff);}while( rc<0 && errno==EINTR);
  30846. #else
  30847. do{
  30848. i64 iSeek = lseek(fd, iOff, SEEK_SET);
  30849. SimulateIOError( iSeek = -1 );
  30850. if( iSeek<0 ){
  30851. rc = -1;
  30852. break;
  30853. }
  30854. rc = osWrite(fd, pBuf, nBuf);
  30855. }while( rc<0 && errno==EINTR );
  30856. #endif
  30857. TIMER_END;
  30858. OSTRACE(("WRITE %-3d %5d %7lld %llu\n", fd, rc, iOff, TIMER_ELAPSED));
  30859. if( rc<0 ) *piErrno = errno;
  30860. return rc;
  30861. }
  30862. /*
  30863. ** Seek to the offset in id->offset then read cnt bytes into pBuf.
  30864. ** Return the number of bytes actually read. Update the offset.
  30865. **
  30866. ** To avoid stomping the errno value on a failed write the lastErrno value
  30867. ** is set before returning.
  30868. */
  30869. static int seekAndWrite(unixFile *id, i64 offset, const void *pBuf, int cnt){
  30870. return seekAndWriteFd(id->h, offset, pBuf, cnt, &id->lastErrno);
  30871. }
  30872. /*
  30873. ** Write data from a buffer into a file. Return SQLITE_OK on success
  30874. ** or some other error code on failure.
  30875. */
  30876. static int unixWrite(
  30877. sqlite3_file *id,
  30878. const void *pBuf,
  30879. int amt,
  30880. sqlite3_int64 offset
  30881. ){
  30882. unixFile *pFile = (unixFile*)id;
  30883. int wrote = 0;
  30884. assert( id );
  30885. assert( amt>0 );
  30886. /* If this is a database file (not a journal, master-journal or temp
  30887. ** file), the bytes in the locking range should never be read or written. */
  30888. #if 0
  30889. assert( pFile->pUnused==0
  30890. || offset>=PENDING_BYTE+512
  30891. || offset+amt<=PENDING_BYTE
  30892. );
  30893. #endif
  30894. #ifdef SQLITE_DEBUG
  30895. /* If we are doing a normal write to a database file (as opposed to
  30896. ** doing a hot-journal rollback or a write to some file other than a
  30897. ** normal database file) then record the fact that the database
  30898. ** has changed. If the transaction counter is modified, record that
  30899. ** fact too.
  30900. */
  30901. if( pFile->inNormalWrite ){
  30902. pFile->dbUpdate = 1; /* The database has been modified */
  30903. if( offset<=24 && offset+amt>=27 ){
  30904. int rc;
  30905. char oldCntr[4];
  30906. SimulateIOErrorBenign(1);
  30907. rc = seekAndRead(pFile, 24, oldCntr, 4);
  30908. SimulateIOErrorBenign(0);
  30909. if( rc!=4 || memcmp(oldCntr, &((char*)pBuf)[24-offset], 4)!=0 ){
  30910. pFile->transCntrChng = 1; /* The transaction counter has changed */
  30911. }
  30912. }
  30913. }
  30914. #endif
  30915. #if defined(SQLITE_MMAP_READWRITE) && SQLITE_MAX_MMAP_SIZE>0
  30916. /* Deal with as much of this write request as possible by transfering
  30917. ** data from the memory mapping using memcpy(). */
  30918. if( offset<pFile->mmapSize ){
  30919. if( offset+amt <= pFile->mmapSize ){
  30920. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, amt);
  30921. return SQLITE_OK;
  30922. }else{
  30923. int nCopy = pFile->mmapSize - offset;
  30924. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, nCopy);
  30925. pBuf = &((u8 *)pBuf)[nCopy];
  30926. amt -= nCopy;
  30927. offset += nCopy;
  30928. }
  30929. }
  30930. #endif
  30931. while( (wrote = seekAndWrite(pFile, offset, pBuf, amt))<amt && wrote>0 ){
  30932. amt -= wrote;
  30933. offset += wrote;
  30934. pBuf = &((char*)pBuf)[wrote];
  30935. }
  30936. SimulateIOError(( wrote=(-1), amt=1 ));
  30937. SimulateDiskfullError(( wrote=0, amt=1 ));
  30938. if( amt>wrote ){
  30939. if( wrote<0 && pFile->lastErrno!=ENOSPC ){
  30940. /* lastErrno set by seekAndWrite */
  30941. return SQLITE_IOERR_WRITE;
  30942. }else{
  30943. storeLastErrno(pFile, 0); /* not a system error */
  30944. return SQLITE_FULL;
  30945. }
  30946. }
  30947. return SQLITE_OK;
  30948. }
  30949. #ifdef SQLITE_TEST
  30950. /*
  30951. ** Count the number of fullsyncs and normal syncs. This is used to test
  30952. ** that syncs and fullsyncs are occurring at the right times.
  30953. */
  30954. SQLITE_API int sqlite3_sync_count = 0;
  30955. SQLITE_API int sqlite3_fullsync_count = 0;
  30956. #endif
  30957. /*
  30958. ** We do not trust systems to provide a working fdatasync(). Some do.
  30959. ** Others do no. To be safe, we will stick with the (slightly slower)
  30960. ** fsync(). If you know that your system does support fdatasync() correctly,
  30961. ** then simply compile with -Dfdatasync=fdatasync or -DHAVE_FDATASYNC
  30962. */
  30963. #if !defined(fdatasync) && !HAVE_FDATASYNC
  30964. # define fdatasync fsync
  30965. #endif
  30966. /*
  30967. ** Define HAVE_FULLFSYNC to 0 or 1 depending on whether or not
  30968. ** the F_FULLFSYNC macro is defined. F_FULLFSYNC is currently
  30969. ** only available on Mac OS X. But that could change.
  30970. */
  30971. #ifdef F_FULLFSYNC
  30972. # define HAVE_FULLFSYNC 1
  30973. #else
  30974. # define HAVE_FULLFSYNC 0
  30975. #endif
  30976. /*
  30977. ** The fsync() system call does not work as advertised on many
  30978. ** unix systems. The following procedure is an attempt to make
  30979. ** it work better.
  30980. **
  30981. ** The SQLITE_NO_SYNC macro disables all fsync()s. This is useful
  30982. ** for testing when we want to run through the test suite quickly.
  30983. ** You are strongly advised *not* to deploy with SQLITE_NO_SYNC
  30984. ** enabled, however, since with SQLITE_NO_SYNC enabled, an OS crash
  30985. ** or power failure will likely corrupt the database file.
  30986. **
  30987. ** SQLite sets the dataOnly flag if the size of the file is unchanged.
  30988. ** The idea behind dataOnly is that it should only write the file content
  30989. ** to disk, not the inode. We only set dataOnly if the file size is
  30990. ** unchanged since the file size is part of the inode. However,
  30991. ** Ted Ts'o tells us that fdatasync() will also write the inode if the
  30992. ** file size has changed. The only real difference between fdatasync()
  30993. ** and fsync(), Ted tells us, is that fdatasync() will not flush the
  30994. ** inode if the mtime or owner or other inode attributes have changed.
  30995. ** We only care about the file size, not the other file attributes, so
  30996. ** as far as SQLite is concerned, an fdatasync() is always adequate.
  30997. ** So, we always use fdatasync() if it is available, regardless of
  30998. ** the value of the dataOnly flag.
  30999. */
  31000. static int full_fsync(int fd, int fullSync, int dataOnly){
  31001. int rc;
  31002. /* The following "ifdef/elif/else/" block has the same structure as
  31003. ** the one below. It is replicated here solely to avoid cluttering
  31004. ** up the real code with the UNUSED_PARAMETER() macros.
  31005. */
  31006. #ifdef SQLITE_NO_SYNC
  31007. UNUSED_PARAMETER(fd);
  31008. UNUSED_PARAMETER(fullSync);
  31009. UNUSED_PARAMETER(dataOnly);
  31010. #elif HAVE_FULLFSYNC
  31011. UNUSED_PARAMETER(dataOnly);
  31012. #else
  31013. UNUSED_PARAMETER(fullSync);
  31014. UNUSED_PARAMETER(dataOnly);
  31015. #endif
  31016. /* Record the number of times that we do a normal fsync() and
  31017. ** FULLSYNC. This is used during testing to verify that this procedure
  31018. ** gets called with the correct arguments.
  31019. */
  31020. #ifdef SQLITE_TEST
  31021. if( fullSync ) sqlite3_fullsync_count++;
  31022. sqlite3_sync_count++;
  31023. #endif
  31024. /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
  31025. ** no-op. But go ahead and call fstat() to validate the file
  31026. ** descriptor as we need a method to provoke a failure during
  31027. ** coverate testing.
  31028. */
  31029. #ifdef SQLITE_NO_SYNC
  31030. {
  31031. struct stat buf;
  31032. rc = osFstat(fd, &buf);
  31033. }
  31034. #elif HAVE_FULLFSYNC
  31035. if( fullSync ){
  31036. rc = osFcntl(fd, F_FULLFSYNC, 0);
  31037. }else{
  31038. rc = 1;
  31039. }
  31040. /* If the FULLFSYNC failed, fall back to attempting an fsync().
  31041. ** It shouldn't be possible for fullfsync to fail on the local
  31042. ** file system (on OSX), so failure indicates that FULLFSYNC
  31043. ** isn't supported for this file system. So, attempt an fsync
  31044. ** and (for now) ignore the overhead of a superfluous fcntl call.
  31045. ** It'd be better to detect fullfsync support once and avoid
  31046. ** the fcntl call every time sync is called.
  31047. */
  31048. if( rc ) rc = fsync(fd);
  31049. #elif defined(__APPLE__)
  31050. /* fdatasync() on HFS+ doesn't yet flush the file size if it changed correctly
  31051. ** so currently we default to the macro that redefines fdatasync to fsync
  31052. */
  31053. rc = fsync(fd);
  31054. #else
  31055. rc = fdatasync(fd);
  31056. #if OS_VXWORKS
  31057. if( rc==-1 && errno==ENOTSUP ){
  31058. rc = fsync(fd);
  31059. }
  31060. #endif /* OS_VXWORKS */
  31061. #endif /* ifdef SQLITE_NO_SYNC elif HAVE_FULLFSYNC */
  31062. if( OS_VXWORKS && rc!= -1 ){
  31063. rc = 0;
  31064. }
  31065. return rc;
  31066. }
  31067. /*
  31068. ** Open a file descriptor to the directory containing file zFilename.
  31069. ** If successful, *pFd is set to the opened file descriptor and
  31070. ** SQLITE_OK is returned. If an error occurs, either SQLITE_NOMEM
  31071. ** or SQLITE_CANTOPEN is returned and *pFd is set to an undefined
  31072. ** value.
  31073. **
  31074. ** The directory file descriptor is used for only one thing - to
  31075. ** fsync() a directory to make sure file creation and deletion events
  31076. ** are flushed to disk. Such fsyncs are not needed on newer
  31077. ** journaling filesystems, but are required on older filesystems.
  31078. **
  31079. ** This routine can be overridden using the xSetSysCall interface.
  31080. ** The ability to override this routine was added in support of the
  31081. ** chromium sandbox. Opening a directory is a security risk (we are
  31082. ** told) so making it overrideable allows the chromium sandbox to
  31083. ** replace this routine with a harmless no-op. To make this routine
  31084. ** a no-op, replace it with a stub that returns SQLITE_OK but leaves
  31085. ** *pFd set to a negative number.
  31086. **
  31087. ** If SQLITE_OK is returned, the caller is responsible for closing
  31088. ** the file descriptor *pFd using close().
  31089. */
  31090. static int openDirectory(const char *zFilename, int *pFd){
  31091. int ii;
  31092. int fd = -1;
  31093. char zDirname[MAX_PATHNAME+1];
  31094. sqlite3_snprintf(MAX_PATHNAME, zDirname, "%s", zFilename);
  31095. for(ii=(int)strlen(zDirname); ii>0 && zDirname[ii]!='/'; ii--);
  31096. if( ii>0 ){
  31097. zDirname[ii] = '\0';
  31098. }else{
  31099. if( zDirname[0]!='/' ) zDirname[0] = '.';
  31100. zDirname[1] = 0;
  31101. }
  31102. fd = robust_open(zDirname, O_RDONLY|O_BINARY, 0);
  31103. if( fd>=0 ){
  31104. OSTRACE(("OPENDIR %-3d %s\n", fd, zDirname));
  31105. }
  31106. *pFd = fd;
  31107. if( fd>=0 ) return SQLITE_OK;
  31108. return unixLogError(SQLITE_CANTOPEN_BKPT, "openDirectory", zDirname);
  31109. }
  31110. /*
  31111. ** Make sure all writes to a particular file are committed to disk.
  31112. **
  31113. ** If dataOnly==0 then both the file itself and its metadata (file
  31114. ** size, access time, etc) are synced. If dataOnly!=0 then only the
  31115. ** file data is synced.
  31116. **
  31117. ** Under Unix, also make sure that the directory entry for the file
  31118. ** has been created by fsync-ing the directory that contains the file.
  31119. ** If we do not do this and we encounter a power failure, the directory
  31120. ** entry for the journal might not exist after we reboot. The next
  31121. ** SQLite to access the file will not know that the journal exists (because
  31122. ** the directory entry for the journal was never created) and the transaction
  31123. ** will not roll back - possibly leading to database corruption.
  31124. */
  31125. static int unixSync(sqlite3_file *id, int flags){
  31126. int rc;
  31127. unixFile *pFile = (unixFile*)id;
  31128. int isDataOnly = (flags&SQLITE_SYNC_DATAONLY);
  31129. int isFullsync = (flags&0x0F)==SQLITE_SYNC_FULL;
  31130. /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
  31131. assert((flags&0x0F)==SQLITE_SYNC_NORMAL
  31132. || (flags&0x0F)==SQLITE_SYNC_FULL
  31133. );
  31134. /* Unix cannot, but some systems may return SQLITE_FULL from here. This
  31135. ** line is to test that doing so does not cause any problems.
  31136. */
  31137. SimulateDiskfullError( return SQLITE_FULL );
  31138. assert( pFile );
  31139. OSTRACE(("SYNC %-3d\n", pFile->h));
  31140. rc = full_fsync(pFile->h, isFullsync, isDataOnly);
  31141. SimulateIOError( rc=1 );
  31142. if( rc ){
  31143. storeLastErrno(pFile, errno);
  31144. return unixLogError(SQLITE_IOERR_FSYNC, "full_fsync", pFile->zPath);
  31145. }
  31146. /* Also fsync the directory containing the file if the DIRSYNC flag
  31147. ** is set. This is a one-time occurrence. Many systems (examples: AIX)
  31148. ** are unable to fsync a directory, so ignore errors on the fsync.
  31149. */
  31150. if( pFile->ctrlFlags & UNIXFILE_DIRSYNC ){
  31151. int dirfd;
  31152. OSTRACE(("DIRSYNC %s (have_fullfsync=%d fullsync=%d)\n", pFile->zPath,
  31153. HAVE_FULLFSYNC, isFullsync));
  31154. rc = osOpenDirectory(pFile->zPath, &dirfd);
  31155. if( rc==SQLITE_OK ){
  31156. full_fsync(dirfd, 0, 0);
  31157. robust_close(pFile, dirfd, __LINE__);
  31158. }else{
  31159. assert( rc==SQLITE_CANTOPEN );
  31160. rc = SQLITE_OK;
  31161. }
  31162. pFile->ctrlFlags &= ~UNIXFILE_DIRSYNC;
  31163. }
  31164. return rc;
  31165. }
  31166. /*
  31167. ** Truncate an open file to a specified size
  31168. */
  31169. static int unixTruncate(sqlite3_file *id, i64 nByte){
  31170. unixFile *pFile = (unixFile *)id;
  31171. int rc;
  31172. assert( pFile );
  31173. SimulateIOError( return SQLITE_IOERR_TRUNCATE );
  31174. /* If the user has configured a chunk-size for this file, truncate the
  31175. ** file so that it consists of an integer number of chunks (i.e. the
  31176. ** actual file size after the operation may be larger than the requested
  31177. ** size).
  31178. */
  31179. if( pFile->szChunk>0 ){
  31180. nByte = ((nByte + pFile->szChunk - 1)/pFile->szChunk) * pFile->szChunk;
  31181. }
  31182. rc = robust_ftruncate(pFile->h, nByte);
  31183. if( rc ){
  31184. storeLastErrno(pFile, errno);
  31185. return unixLogError(SQLITE_IOERR_TRUNCATE, "ftruncate", pFile->zPath);
  31186. }else{
  31187. #ifdef SQLITE_DEBUG
  31188. /* If we are doing a normal write to a database file (as opposed to
  31189. ** doing a hot-journal rollback or a write to some file other than a
  31190. ** normal database file) and we truncate the file to zero length,
  31191. ** that effectively updates the change counter. This might happen
  31192. ** when restoring a database using the backup API from a zero-length
  31193. ** source.
  31194. */
  31195. if( pFile->inNormalWrite && nByte==0 ){
  31196. pFile->transCntrChng = 1;
  31197. }
  31198. #endif
  31199. #if SQLITE_MAX_MMAP_SIZE>0
  31200. /* If the file was just truncated to a size smaller than the currently
  31201. ** mapped region, reduce the effective mapping size as well. SQLite will
  31202. ** use read() and write() to access data beyond this point from now on.
  31203. */
  31204. if( nByte<pFile->mmapSize ){
  31205. pFile->mmapSize = nByte;
  31206. }
  31207. #endif
  31208. return SQLITE_OK;
  31209. }
  31210. }
  31211. /*
  31212. ** Determine the current size of a file in bytes
  31213. */
  31214. static int unixFileSize(sqlite3_file *id, i64 *pSize){
  31215. int rc;
  31216. struct stat buf;
  31217. assert( id );
  31218. rc = osFstat(((unixFile*)id)->h, &buf);
  31219. SimulateIOError( rc=1 );
  31220. if( rc!=0 ){
  31221. storeLastErrno((unixFile*)id, errno);
  31222. return SQLITE_IOERR_FSTAT;
  31223. }
  31224. *pSize = buf.st_size;
  31225. /* When opening a zero-size database, the findInodeInfo() procedure
  31226. ** writes a single byte into that file in order to work around a bug
  31227. ** in the OS-X msdos filesystem. In order to avoid problems with upper
  31228. ** layers, we need to report this file size as zero even though it is
  31229. ** really 1. Ticket #3260.
  31230. */
  31231. if( *pSize==1 ) *pSize = 0;
  31232. return SQLITE_OK;
  31233. }
  31234. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  31235. /*
  31236. ** Handler for proxy-locking file-control verbs. Defined below in the
  31237. ** proxying locking division.
  31238. */
  31239. static int proxyFileControl(sqlite3_file*,int,void*);
  31240. #endif
  31241. /*
  31242. ** This function is called to handle the SQLITE_FCNTL_SIZE_HINT
  31243. ** file-control operation. Enlarge the database to nBytes in size
  31244. ** (rounded up to the next chunk-size). If the database is already
  31245. ** nBytes or larger, this routine is a no-op.
  31246. */
  31247. static int fcntlSizeHint(unixFile *pFile, i64 nByte){
  31248. if( pFile->szChunk>0 ){
  31249. i64 nSize; /* Required file size */
  31250. struct stat buf; /* Used to hold return values of fstat() */
  31251. if( osFstat(pFile->h, &buf) ){
  31252. return SQLITE_IOERR_FSTAT;
  31253. }
  31254. nSize = ((nByte+pFile->szChunk-1) / pFile->szChunk) * pFile->szChunk;
  31255. if( nSize>(i64)buf.st_size ){
  31256. #if defined(HAVE_POSIX_FALLOCATE) && HAVE_POSIX_FALLOCATE
  31257. /* The code below is handling the return value of osFallocate()
  31258. ** correctly. posix_fallocate() is defined to "returns zero on success,
  31259. ** or an error number on failure". See the manpage for details. */
  31260. int err;
  31261. do{
  31262. err = osFallocate(pFile->h, buf.st_size, nSize-buf.st_size);
  31263. }while( err==EINTR );
  31264. if( err ) return SQLITE_IOERR_WRITE;
  31265. #else
  31266. /* If the OS does not have posix_fallocate(), fake it. Write a
  31267. ** single byte to the last byte in each block that falls entirely
  31268. ** within the extended region. Then, if required, a single byte
  31269. ** at offset (nSize-1), to set the size of the file correctly.
  31270. ** This is a similar technique to that used by glibc on systems
  31271. ** that do not have a real fallocate() call.
  31272. */
  31273. int nBlk = buf.st_blksize; /* File-system block size */
  31274. int nWrite = 0; /* Number of bytes written by seekAndWrite */
  31275. i64 iWrite; /* Next offset to write to */
  31276. iWrite = (buf.st_size/nBlk)*nBlk + nBlk - 1;
  31277. assert( iWrite>=buf.st_size );
  31278. assert( ((iWrite+1)%nBlk)==0 );
  31279. for(/*no-op*/; iWrite<nSize+nBlk-1; iWrite+=nBlk ){
  31280. if( iWrite>=nSize ) iWrite = nSize - 1;
  31281. nWrite = seekAndWrite(pFile, iWrite, "", 1);
  31282. if( nWrite!=1 ) return SQLITE_IOERR_WRITE;
  31283. }
  31284. #endif
  31285. }
  31286. }
  31287. #if SQLITE_MAX_MMAP_SIZE>0
  31288. if( pFile->mmapSizeMax>0 && nByte>pFile->mmapSize ){
  31289. int rc;
  31290. if( pFile->szChunk<=0 ){
  31291. if( robust_ftruncate(pFile->h, nByte) ){
  31292. storeLastErrno(pFile, errno);
  31293. return unixLogError(SQLITE_IOERR_TRUNCATE, "ftruncate", pFile->zPath);
  31294. }
  31295. }
  31296. rc = unixMapfile(pFile, nByte);
  31297. return rc;
  31298. }
  31299. #endif
  31300. return SQLITE_OK;
  31301. }
  31302. /*
  31303. ** If *pArg is initially negative then this is a query. Set *pArg to
  31304. ** 1 or 0 depending on whether or not bit mask of pFile->ctrlFlags is set.
  31305. **
  31306. ** If *pArg is 0 or 1, then clear or set the mask bit of pFile->ctrlFlags.
  31307. */
  31308. static void unixModeBit(unixFile *pFile, unsigned char mask, int *pArg){
  31309. if( *pArg<0 ){
  31310. *pArg = (pFile->ctrlFlags & mask)!=0;
  31311. }else if( (*pArg)==0 ){
  31312. pFile->ctrlFlags &= ~mask;
  31313. }else{
  31314. pFile->ctrlFlags |= mask;
  31315. }
  31316. }
  31317. /* Forward declaration */
  31318. static int unixGetTempname(int nBuf, char *zBuf);
  31319. /*
  31320. ** Information and control of an open file handle.
  31321. */
  31322. static int unixFileControl(sqlite3_file *id, int op, void *pArg){
  31323. unixFile *pFile = (unixFile*)id;
  31324. switch( op ){
  31325. case SQLITE_FCNTL_LOCKSTATE: {
  31326. *(int*)pArg = pFile->eFileLock;
  31327. return SQLITE_OK;
  31328. }
  31329. case SQLITE_FCNTL_LAST_ERRNO: {
  31330. *(int*)pArg = pFile->lastErrno;
  31331. return SQLITE_OK;
  31332. }
  31333. case SQLITE_FCNTL_CHUNK_SIZE: {
  31334. pFile->szChunk = *(int *)pArg;
  31335. return SQLITE_OK;
  31336. }
  31337. case SQLITE_FCNTL_SIZE_HINT: {
  31338. int rc;
  31339. SimulateIOErrorBenign(1);
  31340. rc = fcntlSizeHint(pFile, *(i64 *)pArg);
  31341. SimulateIOErrorBenign(0);
  31342. return rc;
  31343. }
  31344. case SQLITE_FCNTL_PERSIST_WAL: {
  31345. unixModeBit(pFile, UNIXFILE_PERSIST_WAL, (int*)pArg);
  31346. return SQLITE_OK;
  31347. }
  31348. case SQLITE_FCNTL_POWERSAFE_OVERWRITE: {
  31349. unixModeBit(pFile, UNIXFILE_PSOW, (int*)pArg);
  31350. return SQLITE_OK;
  31351. }
  31352. case SQLITE_FCNTL_VFSNAME: {
  31353. *(char**)pArg = sqlite3_mprintf("%s", pFile->pVfs->zName);
  31354. return SQLITE_OK;
  31355. }
  31356. case SQLITE_FCNTL_TEMPFILENAME: {
  31357. char *zTFile = sqlite3_malloc64( pFile->pVfs->mxPathname );
  31358. if( zTFile ){
  31359. unixGetTempname(pFile->pVfs->mxPathname, zTFile);
  31360. *(char**)pArg = zTFile;
  31361. }
  31362. return SQLITE_OK;
  31363. }
  31364. case SQLITE_FCNTL_HAS_MOVED: {
  31365. *(int*)pArg = fileHasMoved(pFile);
  31366. return SQLITE_OK;
  31367. }
  31368. #if SQLITE_MAX_MMAP_SIZE>0
  31369. case SQLITE_FCNTL_MMAP_SIZE: {
  31370. i64 newLimit = *(i64*)pArg;
  31371. int rc = SQLITE_OK;
  31372. if( newLimit>sqlite3GlobalConfig.mxMmap ){
  31373. newLimit = sqlite3GlobalConfig.mxMmap;
  31374. }
  31375. *(i64*)pArg = pFile->mmapSizeMax;
  31376. if( newLimit>=0 && newLimit!=pFile->mmapSizeMax && pFile->nFetchOut==0 ){
  31377. pFile->mmapSizeMax = newLimit;
  31378. if( pFile->mmapSize>0 ){
  31379. unixUnmapfile(pFile);
  31380. rc = unixMapfile(pFile, -1);
  31381. }
  31382. }
  31383. return rc;
  31384. }
  31385. #endif
  31386. #ifdef SQLITE_DEBUG
  31387. /* The pager calls this method to signal that it has done
  31388. ** a rollback and that the database is therefore unchanged and
  31389. ** it hence it is OK for the transaction change counter to be
  31390. ** unchanged.
  31391. */
  31392. case SQLITE_FCNTL_DB_UNCHANGED: {
  31393. ((unixFile*)id)->dbUpdate = 0;
  31394. return SQLITE_OK;
  31395. }
  31396. #endif
  31397. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  31398. case SQLITE_FCNTL_SET_LOCKPROXYFILE:
  31399. case SQLITE_FCNTL_GET_LOCKPROXYFILE: {
  31400. return proxyFileControl(id,op,pArg);
  31401. }
  31402. #endif /* SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__) */
  31403. }
  31404. return SQLITE_NOTFOUND;
  31405. }
  31406. /*
  31407. ** Return the sector size in bytes of the underlying block device for
  31408. ** the specified file. This is almost always 512 bytes, but may be
  31409. ** larger for some devices.
  31410. **
  31411. ** SQLite code assumes this function cannot fail. It also assumes that
  31412. ** if two files are created in the same file-system directory (i.e.
  31413. ** a database and its journal file) that the sector size will be the
  31414. ** same for both.
  31415. */
  31416. #ifndef __QNXNTO__
  31417. static int unixSectorSize(sqlite3_file *NotUsed){
  31418. UNUSED_PARAMETER(NotUsed);
  31419. return SQLITE_DEFAULT_SECTOR_SIZE;
  31420. }
  31421. #endif
  31422. /*
  31423. ** The following version of unixSectorSize() is optimized for QNX.
  31424. */
  31425. #ifdef __QNXNTO__
  31426. #include <sys/dcmd_blk.h>
  31427. #include <sys/statvfs.h>
  31428. static int unixSectorSize(sqlite3_file *id){
  31429. unixFile *pFile = (unixFile*)id;
  31430. if( pFile->sectorSize == 0 ){
  31431. struct statvfs fsInfo;
  31432. /* Set defaults for non-supported filesystems */
  31433. pFile->sectorSize = SQLITE_DEFAULT_SECTOR_SIZE;
  31434. pFile->deviceCharacteristics = 0;
  31435. if( fstatvfs(pFile->h, &fsInfo) == -1 ) {
  31436. return pFile->sectorSize;
  31437. }
  31438. if( !strcmp(fsInfo.f_basetype, "tmp") ) {
  31439. pFile->sectorSize = fsInfo.f_bsize;
  31440. pFile->deviceCharacteristics =
  31441. SQLITE_IOCAP_ATOMIC4K | /* All ram filesystem writes are atomic */
  31442. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  31443. ** the write succeeds */
  31444. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  31445. ** so it is ordered */
  31446. 0;
  31447. }else if( strstr(fsInfo.f_basetype, "etfs") ){
  31448. pFile->sectorSize = fsInfo.f_bsize;
  31449. pFile->deviceCharacteristics =
  31450. /* etfs cluster size writes are atomic */
  31451. (pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) |
  31452. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  31453. ** the write succeeds */
  31454. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  31455. ** so it is ordered */
  31456. 0;
  31457. }else if( !strcmp(fsInfo.f_basetype, "qnx6") ){
  31458. pFile->sectorSize = fsInfo.f_bsize;
  31459. pFile->deviceCharacteristics =
  31460. SQLITE_IOCAP_ATOMIC | /* All filesystem writes are atomic */
  31461. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  31462. ** the write succeeds */
  31463. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  31464. ** so it is ordered */
  31465. 0;
  31466. }else if( !strcmp(fsInfo.f_basetype, "qnx4") ){
  31467. pFile->sectorSize = fsInfo.f_bsize;
  31468. pFile->deviceCharacteristics =
  31469. /* full bitset of atomics from max sector size and smaller */
  31470. ((pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) << 1) - 2 |
  31471. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  31472. ** so it is ordered */
  31473. 0;
  31474. }else if( strstr(fsInfo.f_basetype, "dos") ){
  31475. pFile->sectorSize = fsInfo.f_bsize;
  31476. pFile->deviceCharacteristics =
  31477. /* full bitset of atomics from max sector size and smaller */
  31478. ((pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) << 1) - 2 |
  31479. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  31480. ** so it is ordered */
  31481. 0;
  31482. }else{
  31483. pFile->deviceCharacteristics =
  31484. SQLITE_IOCAP_ATOMIC512 | /* blocks are atomic */
  31485. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  31486. ** the write succeeds */
  31487. 0;
  31488. }
  31489. }
  31490. /* Last chance verification. If the sector size isn't a multiple of 512
  31491. ** then it isn't valid.*/
  31492. if( pFile->sectorSize % 512 != 0 ){
  31493. pFile->deviceCharacteristics = 0;
  31494. pFile->sectorSize = SQLITE_DEFAULT_SECTOR_SIZE;
  31495. }
  31496. return pFile->sectorSize;
  31497. }
  31498. #endif /* __QNXNTO__ */
  31499. /*
  31500. ** Return the device characteristics for the file.
  31501. **
  31502. ** This VFS is set up to return SQLITE_IOCAP_POWERSAFE_OVERWRITE by default.
  31503. ** However, that choice is controversial since technically the underlying
  31504. ** file system does not always provide powersafe overwrites. (In other
  31505. ** words, after a power-loss event, parts of the file that were never
  31506. ** written might end up being altered.) However, non-PSOW behavior is very,
  31507. ** very rare. And asserting PSOW makes a large reduction in the amount
  31508. ** of required I/O for journaling, since a lot of padding is eliminated.
  31509. ** Hence, while POWERSAFE_OVERWRITE is on by default, there is a file-control
  31510. ** available to turn it off and URI query parameter available to turn it off.
  31511. */
  31512. static int unixDeviceCharacteristics(sqlite3_file *id){
  31513. unixFile *p = (unixFile*)id;
  31514. int rc = 0;
  31515. #ifdef __QNXNTO__
  31516. if( p->sectorSize==0 ) unixSectorSize(id);
  31517. rc = p->deviceCharacteristics;
  31518. #endif
  31519. if( p->ctrlFlags & UNIXFILE_PSOW ){
  31520. rc |= SQLITE_IOCAP_POWERSAFE_OVERWRITE;
  31521. }
  31522. return rc;
  31523. }
  31524. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  31525. /*
  31526. ** Return the system page size.
  31527. **
  31528. ** This function should not be called directly by other code in this file.
  31529. ** Instead, it should be called via macro osGetpagesize().
  31530. */
  31531. static int unixGetpagesize(void){
  31532. #if OS_VXWORKS
  31533. return 1024;
  31534. #elif defined(_BSD_SOURCE)
  31535. return getpagesize();
  31536. #else
  31537. return (int)sysconf(_SC_PAGESIZE);
  31538. #endif
  31539. }
  31540. #endif /* !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0 */
  31541. #ifndef SQLITE_OMIT_WAL
  31542. /*
  31543. ** Object used to represent an shared memory buffer.
  31544. **
  31545. ** When multiple threads all reference the same wal-index, each thread
  31546. ** has its own unixShm object, but they all point to a single instance
  31547. ** of this unixShmNode object. In other words, each wal-index is opened
  31548. ** only once per process.
  31549. **
  31550. ** Each unixShmNode object is connected to a single unixInodeInfo object.
  31551. ** We could coalesce this object into unixInodeInfo, but that would mean
  31552. ** every open file that does not use shared memory (in other words, most
  31553. ** open files) would have to carry around this extra information. So
  31554. ** the unixInodeInfo object contains a pointer to this unixShmNode object
  31555. ** and the unixShmNode object is created only when needed.
  31556. **
  31557. ** unixMutexHeld() must be true when creating or destroying
  31558. ** this object or while reading or writing the following fields:
  31559. **
  31560. ** nRef
  31561. **
  31562. ** The following fields are read-only after the object is created:
  31563. **
  31564. ** fid
  31565. ** zFilename
  31566. **
  31567. ** Either unixShmNode.mutex must be held or unixShmNode.nRef==0 and
  31568. ** unixMutexHeld() is true when reading or writing any other field
  31569. ** in this structure.
  31570. */
  31571. struct unixShmNode {
  31572. unixInodeInfo *pInode; /* unixInodeInfo that owns this SHM node */
  31573. sqlite3_mutex *mutex; /* Mutex to access this object */
  31574. char *zFilename; /* Name of the mmapped file */
  31575. int h; /* Open file descriptor */
  31576. int szRegion; /* Size of shared-memory regions */
  31577. u16 nRegion; /* Size of array apRegion */
  31578. u8 isReadonly; /* True if read-only */
  31579. char **apRegion; /* Array of mapped shared-memory regions */
  31580. int nRef; /* Number of unixShm objects pointing to this */
  31581. unixShm *pFirst; /* All unixShm objects pointing to this */
  31582. #ifdef SQLITE_DEBUG
  31583. u8 exclMask; /* Mask of exclusive locks held */
  31584. u8 sharedMask; /* Mask of shared locks held */
  31585. u8 nextShmId; /* Next available unixShm.id value */
  31586. #endif
  31587. };
  31588. /*
  31589. ** Structure used internally by this VFS to record the state of an
  31590. ** open shared memory connection.
  31591. **
  31592. ** The following fields are initialized when this object is created and
  31593. ** are read-only thereafter:
  31594. **
  31595. ** unixShm.pFile
  31596. ** unixShm.id
  31597. **
  31598. ** All other fields are read/write. The unixShm.pFile->mutex must be held
  31599. ** while accessing any read/write fields.
  31600. */
  31601. struct unixShm {
  31602. unixShmNode *pShmNode; /* The underlying unixShmNode object */
  31603. unixShm *pNext; /* Next unixShm with the same unixShmNode */
  31604. u8 hasMutex; /* True if holding the unixShmNode mutex */
  31605. u8 id; /* Id of this connection within its unixShmNode */
  31606. u16 sharedMask; /* Mask of shared locks held */
  31607. u16 exclMask; /* Mask of exclusive locks held */
  31608. };
  31609. /*
  31610. ** Constants used for locking
  31611. */
  31612. #define UNIX_SHM_BASE ((22+SQLITE_SHM_NLOCK)*4) /* first lock byte */
  31613. #define UNIX_SHM_DMS (UNIX_SHM_BASE+SQLITE_SHM_NLOCK) /* deadman switch */
  31614. /*
  31615. ** Apply posix advisory locks for all bytes from ofst through ofst+n-1.
  31616. **
  31617. ** Locks block if the mask is exactly UNIX_SHM_C and are non-blocking
  31618. ** otherwise.
  31619. */
  31620. static int unixShmSystemLock(
  31621. unixFile *pFile, /* Open connection to the WAL file */
  31622. int lockType, /* F_UNLCK, F_RDLCK, or F_WRLCK */
  31623. int ofst, /* First byte of the locking range */
  31624. int n /* Number of bytes to lock */
  31625. ){
  31626. unixShmNode *pShmNode; /* Apply locks to this open shared-memory segment */
  31627. struct flock f; /* The posix advisory locking structure */
  31628. int rc = SQLITE_OK; /* Result code form fcntl() */
  31629. /* Access to the unixShmNode object is serialized by the caller */
  31630. pShmNode = pFile->pInode->pShmNode;
  31631. assert( sqlite3_mutex_held(pShmNode->mutex) || pShmNode->nRef==0 );
  31632. /* Shared locks never span more than one byte */
  31633. assert( n==1 || lockType!=F_RDLCK );
  31634. /* Locks are within range */
  31635. assert( n>=1 && n<=SQLITE_SHM_NLOCK );
  31636. if( pShmNode->h>=0 ){
  31637. /* Initialize the locking parameters */
  31638. memset(&f, 0, sizeof(f));
  31639. f.l_type = lockType;
  31640. f.l_whence = SEEK_SET;
  31641. f.l_start = ofst;
  31642. f.l_len = n;
  31643. rc = osFcntl(pShmNode->h, F_SETLK, &f);
  31644. rc = (rc!=(-1)) ? SQLITE_OK : SQLITE_BUSY;
  31645. }
  31646. /* Update the global lock state and do debug tracing */
  31647. #ifdef SQLITE_DEBUG
  31648. { u16 mask;
  31649. OSTRACE(("SHM-LOCK "));
  31650. mask = ofst>31 ? 0xffff : (1<<(ofst+n)) - (1<<ofst);
  31651. if( rc==SQLITE_OK ){
  31652. if( lockType==F_UNLCK ){
  31653. OSTRACE(("unlock %d ok", ofst));
  31654. pShmNode->exclMask &= ~mask;
  31655. pShmNode->sharedMask &= ~mask;
  31656. }else if( lockType==F_RDLCK ){
  31657. OSTRACE(("read-lock %d ok", ofst));
  31658. pShmNode->exclMask &= ~mask;
  31659. pShmNode->sharedMask |= mask;
  31660. }else{
  31661. assert( lockType==F_WRLCK );
  31662. OSTRACE(("write-lock %d ok", ofst));
  31663. pShmNode->exclMask |= mask;
  31664. pShmNode->sharedMask &= ~mask;
  31665. }
  31666. }else{
  31667. if( lockType==F_UNLCK ){
  31668. OSTRACE(("unlock %d failed", ofst));
  31669. }else if( lockType==F_RDLCK ){
  31670. OSTRACE(("read-lock failed"));
  31671. }else{
  31672. assert( lockType==F_WRLCK );
  31673. OSTRACE(("write-lock %d failed", ofst));
  31674. }
  31675. }
  31676. OSTRACE((" - afterwards %03x,%03x\n",
  31677. pShmNode->sharedMask, pShmNode->exclMask));
  31678. }
  31679. #endif
  31680. return rc;
  31681. }
  31682. /*
  31683. ** Return the minimum number of 32KB shm regions that should be mapped at
  31684. ** a time, assuming that each mapping must be an integer multiple of the
  31685. ** current system page-size.
  31686. **
  31687. ** Usually, this is 1. The exception seems to be systems that are configured
  31688. ** to use 64KB pages - in this case each mapping must cover at least two
  31689. ** shm regions.
  31690. */
  31691. static int unixShmRegionPerMap(void){
  31692. int shmsz = 32*1024; /* SHM region size */
  31693. int pgsz = osGetpagesize(); /* System page size */
  31694. assert( ((pgsz-1)&pgsz)==0 ); /* Page size must be a power of 2 */
  31695. if( pgsz<shmsz ) return 1;
  31696. return pgsz/shmsz;
  31697. }
  31698. /*
  31699. ** Purge the unixShmNodeList list of all entries with unixShmNode.nRef==0.
  31700. **
  31701. ** This is not a VFS shared-memory method; it is a utility function called
  31702. ** by VFS shared-memory methods.
  31703. */
  31704. static void unixShmPurge(unixFile *pFd){
  31705. unixShmNode *p = pFd->pInode->pShmNode;
  31706. assert( unixMutexHeld() );
  31707. if( p && ALWAYS(p->nRef==0) ){
  31708. int nShmPerMap = unixShmRegionPerMap();
  31709. int i;
  31710. assert( p->pInode==pFd->pInode );
  31711. sqlite3_mutex_free(p->mutex);
  31712. for(i=0; i<p->nRegion; i+=nShmPerMap){
  31713. if( p->h>=0 ){
  31714. osMunmap(p->apRegion[i], p->szRegion);
  31715. }else{
  31716. sqlite3_free(p->apRegion[i]);
  31717. }
  31718. }
  31719. sqlite3_free(p->apRegion);
  31720. if( p->h>=0 ){
  31721. robust_close(pFd, p->h, __LINE__);
  31722. p->h = -1;
  31723. }
  31724. p->pInode->pShmNode = 0;
  31725. sqlite3_free(p);
  31726. }
  31727. }
  31728. /*
  31729. ** Open a shared-memory area associated with open database file pDbFd.
  31730. ** This particular implementation uses mmapped files.
  31731. **
  31732. ** The file used to implement shared-memory is in the same directory
  31733. ** as the open database file and has the same name as the open database
  31734. ** file with the "-shm" suffix added. For example, if the database file
  31735. ** is "/home/user1/config.db" then the file that is created and mmapped
  31736. ** for shared memory will be called "/home/user1/config.db-shm".
  31737. **
  31738. ** Another approach to is to use files in /dev/shm or /dev/tmp or an
  31739. ** some other tmpfs mount. But if a file in a different directory
  31740. ** from the database file is used, then differing access permissions
  31741. ** or a chroot() might cause two different processes on the same
  31742. ** database to end up using different files for shared memory -
  31743. ** meaning that their memory would not really be shared - resulting
  31744. ** in database corruption. Nevertheless, this tmpfs file usage
  31745. ** can be enabled at compile-time using -DSQLITE_SHM_DIRECTORY="/dev/shm"
  31746. ** or the equivalent. The use of the SQLITE_SHM_DIRECTORY compile-time
  31747. ** option results in an incompatible build of SQLite; builds of SQLite
  31748. ** that with differing SQLITE_SHM_DIRECTORY settings attempt to use the
  31749. ** same database file at the same time, database corruption will likely
  31750. ** result. The SQLITE_SHM_DIRECTORY compile-time option is considered
  31751. ** "unsupported" and may go away in a future SQLite release.
  31752. **
  31753. ** When opening a new shared-memory file, if no other instances of that
  31754. ** file are currently open, in this process or in other processes, then
  31755. ** the file must be truncated to zero length or have its header cleared.
  31756. **
  31757. ** If the original database file (pDbFd) is using the "unix-excl" VFS
  31758. ** that means that an exclusive lock is held on the database file and
  31759. ** that no other processes are able to read or write the database. In
  31760. ** that case, we do not really need shared memory. No shared memory
  31761. ** file is created. The shared memory will be simulated with heap memory.
  31762. */
  31763. static int unixOpenSharedMemory(unixFile *pDbFd){
  31764. struct unixShm *p = 0; /* The connection to be opened */
  31765. struct unixShmNode *pShmNode; /* The underlying mmapped file */
  31766. int rc; /* Result code */
  31767. unixInodeInfo *pInode; /* The inode of fd */
  31768. char *zShmFilename; /* Name of the file used for SHM */
  31769. int nShmFilename; /* Size of the SHM filename in bytes */
  31770. /* Allocate space for the new unixShm object. */
  31771. p = sqlite3_malloc64( sizeof(*p) );
  31772. if( p==0 ) return SQLITE_NOMEM_BKPT;
  31773. memset(p, 0, sizeof(*p));
  31774. assert( pDbFd->pShm==0 );
  31775. /* Check to see if a unixShmNode object already exists. Reuse an existing
  31776. ** one if present. Create a new one if necessary.
  31777. */
  31778. unixEnterMutex();
  31779. pInode = pDbFd->pInode;
  31780. pShmNode = pInode->pShmNode;
  31781. if( pShmNode==0 ){
  31782. struct stat sStat; /* fstat() info for database file */
  31783. #ifndef SQLITE_SHM_DIRECTORY
  31784. const char *zBasePath = pDbFd->zPath;
  31785. #endif
  31786. /* Call fstat() to figure out the permissions on the database file. If
  31787. ** a new *-shm file is created, an attempt will be made to create it
  31788. ** with the same permissions.
  31789. */
  31790. if( osFstat(pDbFd->h, &sStat) ){
  31791. rc = SQLITE_IOERR_FSTAT;
  31792. goto shm_open_err;
  31793. }
  31794. #ifdef SQLITE_SHM_DIRECTORY
  31795. nShmFilename = sizeof(SQLITE_SHM_DIRECTORY) + 31;
  31796. #else
  31797. nShmFilename = 6 + (int)strlen(zBasePath);
  31798. #endif
  31799. pShmNode = sqlite3_malloc64( sizeof(*pShmNode) + nShmFilename );
  31800. if( pShmNode==0 ){
  31801. rc = SQLITE_NOMEM_BKPT;
  31802. goto shm_open_err;
  31803. }
  31804. memset(pShmNode, 0, sizeof(*pShmNode)+nShmFilename);
  31805. zShmFilename = pShmNode->zFilename = (char*)&pShmNode[1];
  31806. #ifdef SQLITE_SHM_DIRECTORY
  31807. sqlite3_snprintf(nShmFilename, zShmFilename,
  31808. SQLITE_SHM_DIRECTORY "/sqlite-shm-%x-%x",
  31809. (u32)sStat.st_ino, (u32)sStat.st_dev);
  31810. #else
  31811. sqlite3_snprintf(nShmFilename, zShmFilename, "%s-shm", zBasePath);
  31812. sqlite3FileSuffix3(pDbFd->zPath, zShmFilename);
  31813. #endif
  31814. pShmNode->h = -1;
  31815. pDbFd->pInode->pShmNode = pShmNode;
  31816. pShmNode->pInode = pDbFd->pInode;
  31817. if( sqlite3GlobalConfig.bCoreMutex ){
  31818. pShmNode->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_FAST);
  31819. if( pShmNode->mutex==0 ){
  31820. rc = SQLITE_NOMEM_BKPT;
  31821. goto shm_open_err;
  31822. }
  31823. }
  31824. if( pInode->bProcessLock==0 ){
  31825. int openFlags = O_RDWR | O_CREAT;
  31826. if( sqlite3_uri_boolean(pDbFd->zPath, "readonly_shm", 0) ){
  31827. openFlags = O_RDONLY;
  31828. pShmNode->isReadonly = 1;
  31829. }
  31830. pShmNode->h = robust_open(zShmFilename, openFlags, (sStat.st_mode&0777));
  31831. if( pShmNode->h<0 ){
  31832. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "open", zShmFilename);
  31833. goto shm_open_err;
  31834. }
  31835. /* If this process is running as root, make sure that the SHM file
  31836. ** is owned by the same user that owns the original database. Otherwise,
  31837. ** the original owner will not be able to connect.
  31838. */
  31839. robustFchown(pShmNode->h, sStat.st_uid, sStat.st_gid);
  31840. /* Check to see if another process is holding the dead-man switch.
  31841. ** If not, truncate the file to zero length.
  31842. */
  31843. rc = SQLITE_OK;
  31844. if( unixShmSystemLock(pDbFd, F_WRLCK, UNIX_SHM_DMS, 1)==SQLITE_OK ){
  31845. if( robust_ftruncate(pShmNode->h, 0) ){
  31846. rc = unixLogError(SQLITE_IOERR_SHMOPEN, "ftruncate", zShmFilename);
  31847. }
  31848. }
  31849. if( rc==SQLITE_OK ){
  31850. rc = unixShmSystemLock(pDbFd, F_RDLCK, UNIX_SHM_DMS, 1);
  31851. }
  31852. if( rc ) goto shm_open_err;
  31853. }
  31854. }
  31855. /* Make the new connection a child of the unixShmNode */
  31856. p->pShmNode = pShmNode;
  31857. #ifdef SQLITE_DEBUG
  31858. p->id = pShmNode->nextShmId++;
  31859. #endif
  31860. pShmNode->nRef++;
  31861. pDbFd->pShm = p;
  31862. unixLeaveMutex();
  31863. /* The reference count on pShmNode has already been incremented under
  31864. ** the cover of the unixEnterMutex() mutex and the pointer from the
  31865. ** new (struct unixShm) object to the pShmNode has been set. All that is
  31866. ** left to do is to link the new object into the linked list starting
  31867. ** at pShmNode->pFirst. This must be done while holding the pShmNode->mutex
  31868. ** mutex.
  31869. */
  31870. sqlite3_mutex_enter(pShmNode->mutex);
  31871. p->pNext = pShmNode->pFirst;
  31872. pShmNode->pFirst = p;
  31873. sqlite3_mutex_leave(pShmNode->mutex);
  31874. return SQLITE_OK;
  31875. /* Jump here on any error */
  31876. shm_open_err:
  31877. unixShmPurge(pDbFd); /* This call frees pShmNode if required */
  31878. sqlite3_free(p);
  31879. unixLeaveMutex();
  31880. return rc;
  31881. }
  31882. /*
  31883. ** This function is called to obtain a pointer to region iRegion of the
  31884. ** shared-memory associated with the database file fd. Shared-memory regions
  31885. ** are numbered starting from zero. Each shared-memory region is szRegion
  31886. ** bytes in size.
  31887. **
  31888. ** If an error occurs, an error code is returned and *pp is set to NULL.
  31889. **
  31890. ** Otherwise, if the bExtend parameter is 0 and the requested shared-memory
  31891. ** region has not been allocated (by any client, including one running in a
  31892. ** separate process), then *pp is set to NULL and SQLITE_OK returned. If
  31893. ** bExtend is non-zero and the requested shared-memory region has not yet
  31894. ** been allocated, it is allocated by this function.
  31895. **
  31896. ** If the shared-memory region has already been allocated or is allocated by
  31897. ** this call as described above, then it is mapped into this processes
  31898. ** address space (if it is not already), *pp is set to point to the mapped
  31899. ** memory and SQLITE_OK returned.
  31900. */
  31901. static int unixShmMap(
  31902. sqlite3_file *fd, /* Handle open on database file */
  31903. int iRegion, /* Region to retrieve */
  31904. int szRegion, /* Size of regions */
  31905. int bExtend, /* True to extend file if necessary */
  31906. void volatile **pp /* OUT: Mapped memory */
  31907. ){
  31908. unixFile *pDbFd = (unixFile*)fd;
  31909. unixShm *p;
  31910. unixShmNode *pShmNode;
  31911. int rc = SQLITE_OK;
  31912. int nShmPerMap = unixShmRegionPerMap();
  31913. int nReqRegion;
  31914. /* If the shared-memory file has not yet been opened, open it now. */
  31915. if( pDbFd->pShm==0 ){
  31916. rc = unixOpenSharedMemory(pDbFd);
  31917. if( rc!=SQLITE_OK ) return rc;
  31918. }
  31919. p = pDbFd->pShm;
  31920. pShmNode = p->pShmNode;
  31921. sqlite3_mutex_enter(pShmNode->mutex);
  31922. assert( szRegion==pShmNode->szRegion || pShmNode->nRegion==0 );
  31923. assert( pShmNode->pInode==pDbFd->pInode );
  31924. assert( pShmNode->h>=0 || pDbFd->pInode->bProcessLock==1 );
  31925. assert( pShmNode->h<0 || pDbFd->pInode->bProcessLock==0 );
  31926. /* Minimum number of regions required to be mapped. */
  31927. nReqRegion = ((iRegion+nShmPerMap) / nShmPerMap) * nShmPerMap;
  31928. if( pShmNode->nRegion<nReqRegion ){
  31929. char **apNew; /* New apRegion[] array */
  31930. int nByte = nReqRegion*szRegion; /* Minimum required file size */
  31931. struct stat sStat; /* Used by fstat() */
  31932. pShmNode->szRegion = szRegion;
  31933. if( pShmNode->h>=0 ){
  31934. /* The requested region is not mapped into this processes address space.
  31935. ** Check to see if it has been allocated (i.e. if the wal-index file is
  31936. ** large enough to contain the requested region).
  31937. */
  31938. if( osFstat(pShmNode->h, &sStat) ){
  31939. rc = SQLITE_IOERR_SHMSIZE;
  31940. goto shmpage_out;
  31941. }
  31942. if( sStat.st_size<nByte ){
  31943. /* The requested memory region does not exist. If bExtend is set to
  31944. ** false, exit early. *pp will be set to NULL and SQLITE_OK returned.
  31945. */
  31946. if( !bExtend ){
  31947. goto shmpage_out;
  31948. }
  31949. /* Alternatively, if bExtend is true, extend the file. Do this by
  31950. ** writing a single byte to the end of each (OS) page being
  31951. ** allocated or extended. Technically, we need only write to the
  31952. ** last page in order to extend the file. But writing to all new
  31953. ** pages forces the OS to allocate them immediately, which reduces
  31954. ** the chances of SIGBUS while accessing the mapped region later on.
  31955. */
  31956. else{
  31957. static const int pgsz = 4096;
  31958. int iPg;
  31959. /* Write to the last byte of each newly allocated or extended page */
  31960. assert( (nByte % pgsz)==0 );
  31961. for(iPg=(sStat.st_size/pgsz); iPg<(nByte/pgsz); iPg++){
  31962. int x = 0;
  31963. if( seekAndWriteFd(pShmNode->h, iPg*pgsz + pgsz-1, "", 1, &x)!=1 ){
  31964. const char *zFile = pShmNode->zFilename;
  31965. rc = unixLogError(SQLITE_IOERR_SHMSIZE, "write", zFile);
  31966. goto shmpage_out;
  31967. }
  31968. }
  31969. }
  31970. }
  31971. }
  31972. /* Map the requested memory region into this processes address space. */
  31973. apNew = (char **)sqlite3_realloc(
  31974. pShmNode->apRegion, nReqRegion*sizeof(char *)
  31975. );
  31976. if( !apNew ){
  31977. rc = SQLITE_IOERR_NOMEM_BKPT;
  31978. goto shmpage_out;
  31979. }
  31980. pShmNode->apRegion = apNew;
  31981. while( pShmNode->nRegion<nReqRegion ){
  31982. int nMap = szRegion*nShmPerMap;
  31983. int i;
  31984. void *pMem;
  31985. if( pShmNode->h>=0 ){
  31986. pMem = osMmap(0, nMap,
  31987. pShmNode->isReadonly ? PROT_READ : PROT_READ|PROT_WRITE,
  31988. MAP_SHARED, pShmNode->h, szRegion*(i64)pShmNode->nRegion
  31989. );
  31990. if( pMem==MAP_FAILED ){
  31991. rc = unixLogError(SQLITE_IOERR_SHMMAP, "mmap", pShmNode->zFilename);
  31992. goto shmpage_out;
  31993. }
  31994. }else{
  31995. pMem = sqlite3_malloc64(szRegion);
  31996. if( pMem==0 ){
  31997. rc = SQLITE_NOMEM_BKPT;
  31998. goto shmpage_out;
  31999. }
  32000. memset(pMem, 0, szRegion);
  32001. }
  32002. for(i=0; i<nShmPerMap; i++){
  32003. pShmNode->apRegion[pShmNode->nRegion+i] = &((char*)pMem)[szRegion*i];
  32004. }
  32005. pShmNode->nRegion += nShmPerMap;
  32006. }
  32007. }
  32008. shmpage_out:
  32009. if( pShmNode->nRegion>iRegion ){
  32010. *pp = pShmNode->apRegion[iRegion];
  32011. }else{
  32012. *pp = 0;
  32013. }
  32014. if( pShmNode->isReadonly && rc==SQLITE_OK ) rc = SQLITE_READONLY;
  32015. sqlite3_mutex_leave(pShmNode->mutex);
  32016. return rc;
  32017. }
  32018. /*
  32019. ** Change the lock state for a shared-memory segment.
  32020. **
  32021. ** Note that the relationship between SHAREd and EXCLUSIVE locks is a little
  32022. ** different here than in posix. In xShmLock(), one can go from unlocked
  32023. ** to shared and back or from unlocked to exclusive and back. But one may
  32024. ** not go from shared to exclusive or from exclusive to shared.
  32025. */
  32026. static int unixShmLock(
  32027. sqlite3_file *fd, /* Database file holding the shared memory */
  32028. int ofst, /* First lock to acquire or release */
  32029. int n, /* Number of locks to acquire or release */
  32030. int flags /* What to do with the lock */
  32031. ){
  32032. unixFile *pDbFd = (unixFile*)fd; /* Connection holding shared memory */
  32033. unixShm *p = pDbFd->pShm; /* The shared memory being locked */
  32034. unixShm *pX; /* For looping over all siblings */
  32035. unixShmNode *pShmNode = p->pShmNode; /* The underlying file iNode */
  32036. int rc = SQLITE_OK; /* Result code */
  32037. u16 mask; /* Mask of locks to take or release */
  32038. assert( pShmNode==pDbFd->pInode->pShmNode );
  32039. assert( pShmNode->pInode==pDbFd->pInode );
  32040. assert( ofst>=0 && ofst+n<=SQLITE_SHM_NLOCK );
  32041. assert( n>=1 );
  32042. assert( flags==(SQLITE_SHM_LOCK | SQLITE_SHM_SHARED)
  32043. || flags==(SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE)
  32044. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED)
  32045. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE) );
  32046. assert( n==1 || (flags & SQLITE_SHM_EXCLUSIVE)!=0 );
  32047. assert( pShmNode->h>=0 || pDbFd->pInode->bProcessLock==1 );
  32048. assert( pShmNode->h<0 || pDbFd->pInode->bProcessLock==0 );
  32049. mask = (1<<(ofst+n)) - (1<<ofst);
  32050. assert( n>1 || mask==(1<<ofst) );
  32051. sqlite3_mutex_enter(pShmNode->mutex);
  32052. if( flags & SQLITE_SHM_UNLOCK ){
  32053. u16 allMask = 0; /* Mask of locks held by siblings */
  32054. /* See if any siblings hold this same lock */
  32055. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  32056. if( pX==p ) continue;
  32057. assert( (pX->exclMask & (p->exclMask|p->sharedMask))==0 );
  32058. allMask |= pX->sharedMask;
  32059. }
  32060. /* Unlock the system-level locks */
  32061. if( (mask & allMask)==0 ){
  32062. rc = unixShmSystemLock(pDbFd, F_UNLCK, ofst+UNIX_SHM_BASE, n);
  32063. }else{
  32064. rc = SQLITE_OK;
  32065. }
  32066. /* Undo the local locks */
  32067. if( rc==SQLITE_OK ){
  32068. p->exclMask &= ~mask;
  32069. p->sharedMask &= ~mask;
  32070. }
  32071. }else if( flags & SQLITE_SHM_SHARED ){
  32072. u16 allShared = 0; /* Union of locks held by connections other than "p" */
  32073. /* Find out which shared locks are already held by sibling connections.
  32074. ** If any sibling already holds an exclusive lock, go ahead and return
  32075. ** SQLITE_BUSY.
  32076. */
  32077. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  32078. if( (pX->exclMask & mask)!=0 ){
  32079. rc = SQLITE_BUSY;
  32080. break;
  32081. }
  32082. allShared |= pX->sharedMask;
  32083. }
  32084. /* Get shared locks at the system level, if necessary */
  32085. if( rc==SQLITE_OK ){
  32086. if( (allShared & mask)==0 ){
  32087. rc = unixShmSystemLock(pDbFd, F_RDLCK, ofst+UNIX_SHM_BASE, n);
  32088. }else{
  32089. rc = SQLITE_OK;
  32090. }
  32091. }
  32092. /* Get the local shared locks */
  32093. if( rc==SQLITE_OK ){
  32094. p->sharedMask |= mask;
  32095. }
  32096. }else{
  32097. /* Make sure no sibling connections hold locks that will block this
  32098. ** lock. If any do, return SQLITE_BUSY right away.
  32099. */
  32100. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  32101. if( (pX->exclMask & mask)!=0 || (pX->sharedMask & mask)!=0 ){
  32102. rc = SQLITE_BUSY;
  32103. break;
  32104. }
  32105. }
  32106. /* Get the exclusive locks at the system level. Then if successful
  32107. ** also mark the local connection as being locked.
  32108. */
  32109. if( rc==SQLITE_OK ){
  32110. rc = unixShmSystemLock(pDbFd, F_WRLCK, ofst+UNIX_SHM_BASE, n);
  32111. if( rc==SQLITE_OK ){
  32112. assert( (p->sharedMask & mask)==0 );
  32113. p->exclMask |= mask;
  32114. }
  32115. }
  32116. }
  32117. sqlite3_mutex_leave(pShmNode->mutex);
  32118. OSTRACE(("SHM-LOCK shmid-%d, pid-%d got %03x,%03x\n",
  32119. p->id, osGetpid(0), p->sharedMask, p->exclMask));
  32120. return rc;
  32121. }
  32122. /*
  32123. ** Implement a memory barrier or memory fence on shared memory.
  32124. **
  32125. ** All loads and stores begun before the barrier must complete before
  32126. ** any load or store begun after the barrier.
  32127. */
  32128. static void unixShmBarrier(
  32129. sqlite3_file *fd /* Database file holding the shared memory */
  32130. ){
  32131. UNUSED_PARAMETER(fd);
  32132. sqlite3MemoryBarrier(); /* compiler-defined memory barrier */
  32133. unixEnterMutex(); /* Also mutex, for redundancy */
  32134. unixLeaveMutex();
  32135. }
  32136. /*
  32137. ** Close a connection to shared-memory. Delete the underlying
  32138. ** storage if deleteFlag is true.
  32139. **
  32140. ** If there is no shared memory associated with the connection then this
  32141. ** routine is a harmless no-op.
  32142. */
  32143. static int unixShmUnmap(
  32144. sqlite3_file *fd, /* The underlying database file */
  32145. int deleteFlag /* Delete shared-memory if true */
  32146. ){
  32147. unixShm *p; /* The connection to be closed */
  32148. unixShmNode *pShmNode; /* The underlying shared-memory file */
  32149. unixShm **pp; /* For looping over sibling connections */
  32150. unixFile *pDbFd; /* The underlying database file */
  32151. pDbFd = (unixFile*)fd;
  32152. p = pDbFd->pShm;
  32153. if( p==0 ) return SQLITE_OK;
  32154. pShmNode = p->pShmNode;
  32155. assert( pShmNode==pDbFd->pInode->pShmNode );
  32156. assert( pShmNode->pInode==pDbFd->pInode );
  32157. /* Remove connection p from the set of connections associated
  32158. ** with pShmNode */
  32159. sqlite3_mutex_enter(pShmNode->mutex);
  32160. for(pp=&pShmNode->pFirst; (*pp)!=p; pp = &(*pp)->pNext){}
  32161. *pp = p->pNext;
  32162. /* Free the connection p */
  32163. sqlite3_free(p);
  32164. pDbFd->pShm = 0;
  32165. sqlite3_mutex_leave(pShmNode->mutex);
  32166. /* If pShmNode->nRef has reached 0, then close the underlying
  32167. ** shared-memory file, too */
  32168. unixEnterMutex();
  32169. assert( pShmNode->nRef>0 );
  32170. pShmNode->nRef--;
  32171. if( pShmNode->nRef==0 ){
  32172. if( deleteFlag && pShmNode->h>=0 ){
  32173. osUnlink(pShmNode->zFilename);
  32174. }
  32175. unixShmPurge(pDbFd);
  32176. }
  32177. unixLeaveMutex();
  32178. return SQLITE_OK;
  32179. }
  32180. #else
  32181. # define unixShmMap 0
  32182. # define unixShmLock 0
  32183. # define unixShmBarrier 0
  32184. # define unixShmUnmap 0
  32185. #endif /* #ifndef SQLITE_OMIT_WAL */
  32186. #if SQLITE_MAX_MMAP_SIZE>0
  32187. /*
  32188. ** If it is currently memory mapped, unmap file pFd.
  32189. */
  32190. static void unixUnmapfile(unixFile *pFd){
  32191. assert( pFd->nFetchOut==0 );
  32192. if( pFd->pMapRegion ){
  32193. osMunmap(pFd->pMapRegion, pFd->mmapSizeActual);
  32194. pFd->pMapRegion = 0;
  32195. pFd->mmapSize = 0;
  32196. pFd->mmapSizeActual = 0;
  32197. }
  32198. }
  32199. /*
  32200. ** Attempt to set the size of the memory mapping maintained by file
  32201. ** descriptor pFd to nNew bytes. Any existing mapping is discarded.
  32202. **
  32203. ** If successful, this function sets the following variables:
  32204. **
  32205. ** unixFile.pMapRegion
  32206. ** unixFile.mmapSize
  32207. ** unixFile.mmapSizeActual
  32208. **
  32209. ** If unsuccessful, an error message is logged via sqlite3_log() and
  32210. ** the three variables above are zeroed. In this case SQLite should
  32211. ** continue accessing the database using the xRead() and xWrite()
  32212. ** methods.
  32213. */
  32214. static void unixRemapfile(
  32215. unixFile *pFd, /* File descriptor object */
  32216. i64 nNew /* Required mapping size */
  32217. ){
  32218. const char *zErr = "mmap";
  32219. int h = pFd->h; /* File descriptor open on db file */
  32220. u8 *pOrig = (u8 *)pFd->pMapRegion; /* Pointer to current file mapping */
  32221. i64 nOrig = pFd->mmapSizeActual; /* Size of pOrig region in bytes */
  32222. u8 *pNew = 0; /* Location of new mapping */
  32223. int flags = PROT_READ; /* Flags to pass to mmap() */
  32224. assert( pFd->nFetchOut==0 );
  32225. assert( nNew>pFd->mmapSize );
  32226. assert( nNew<=pFd->mmapSizeMax );
  32227. assert( nNew>0 );
  32228. assert( pFd->mmapSizeActual>=pFd->mmapSize );
  32229. assert( MAP_FAILED!=0 );
  32230. #ifdef SQLITE_MMAP_READWRITE
  32231. if( (pFd->ctrlFlags & UNIXFILE_RDONLY)==0 ) flags |= PROT_WRITE;
  32232. #endif
  32233. if( pOrig ){
  32234. #if HAVE_MREMAP
  32235. i64 nReuse = pFd->mmapSize;
  32236. #else
  32237. const int szSyspage = osGetpagesize();
  32238. i64 nReuse = (pFd->mmapSize & ~(szSyspage-1));
  32239. #endif
  32240. u8 *pReq = &pOrig[nReuse];
  32241. /* Unmap any pages of the existing mapping that cannot be reused. */
  32242. if( nReuse!=nOrig ){
  32243. osMunmap(pReq, nOrig-nReuse);
  32244. }
  32245. #if HAVE_MREMAP
  32246. pNew = osMremap(pOrig, nReuse, nNew, MREMAP_MAYMOVE);
  32247. zErr = "mremap";
  32248. #else
  32249. pNew = osMmap(pReq, nNew-nReuse, flags, MAP_SHARED, h, nReuse);
  32250. if( pNew!=MAP_FAILED ){
  32251. if( pNew!=pReq ){
  32252. osMunmap(pNew, nNew - nReuse);
  32253. pNew = 0;
  32254. }else{
  32255. pNew = pOrig;
  32256. }
  32257. }
  32258. #endif
  32259. /* The attempt to extend the existing mapping failed. Free it. */
  32260. if( pNew==MAP_FAILED || pNew==0 ){
  32261. osMunmap(pOrig, nReuse);
  32262. }
  32263. }
  32264. /* If pNew is still NULL, try to create an entirely new mapping. */
  32265. if( pNew==0 ){
  32266. pNew = osMmap(0, nNew, flags, MAP_SHARED, h, 0);
  32267. }
  32268. if( pNew==MAP_FAILED ){
  32269. pNew = 0;
  32270. nNew = 0;
  32271. unixLogError(SQLITE_OK, zErr, pFd->zPath);
  32272. /* If the mmap() above failed, assume that all subsequent mmap() calls
  32273. ** will probably fail too. Fall back to using xRead/xWrite exclusively
  32274. ** in this case. */
  32275. pFd->mmapSizeMax = 0;
  32276. }
  32277. pFd->pMapRegion = (void *)pNew;
  32278. pFd->mmapSize = pFd->mmapSizeActual = nNew;
  32279. }
  32280. /*
  32281. ** Memory map or remap the file opened by file-descriptor pFd (if the file
  32282. ** is already mapped, the existing mapping is replaced by the new). Or, if
  32283. ** there already exists a mapping for this file, and there are still
  32284. ** outstanding xFetch() references to it, this function is a no-op.
  32285. **
  32286. ** If parameter nByte is non-negative, then it is the requested size of
  32287. ** the mapping to create. Otherwise, if nByte is less than zero, then the
  32288. ** requested size is the size of the file on disk. The actual size of the
  32289. ** created mapping is either the requested size or the value configured
  32290. ** using SQLITE_FCNTL_MMAP_LIMIT, whichever is smaller.
  32291. **
  32292. ** SQLITE_OK is returned if no error occurs (even if the mapping is not
  32293. ** recreated as a result of outstanding references) or an SQLite error
  32294. ** code otherwise.
  32295. */
  32296. static int unixMapfile(unixFile *pFd, i64 nMap){
  32297. assert( nMap>=0 || pFd->nFetchOut==0 );
  32298. assert( nMap>0 || (pFd->mmapSize==0 && pFd->pMapRegion==0) );
  32299. if( pFd->nFetchOut>0 ) return SQLITE_OK;
  32300. if( nMap<0 ){
  32301. struct stat statbuf; /* Low-level file information */
  32302. if( osFstat(pFd->h, &statbuf) ){
  32303. return SQLITE_IOERR_FSTAT;
  32304. }
  32305. nMap = statbuf.st_size;
  32306. }
  32307. if( nMap>pFd->mmapSizeMax ){
  32308. nMap = pFd->mmapSizeMax;
  32309. }
  32310. assert( nMap>0 || (pFd->mmapSize==0 && pFd->pMapRegion==0) );
  32311. if( nMap!=pFd->mmapSize ){
  32312. unixRemapfile(pFd, nMap);
  32313. }
  32314. return SQLITE_OK;
  32315. }
  32316. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  32317. /*
  32318. ** If possible, return a pointer to a mapping of file fd starting at offset
  32319. ** iOff. The mapping must be valid for at least nAmt bytes.
  32320. **
  32321. ** If such a pointer can be obtained, store it in *pp and return SQLITE_OK.
  32322. ** Or, if one cannot but no error occurs, set *pp to 0 and return SQLITE_OK.
  32323. ** Finally, if an error does occur, return an SQLite error code. The final
  32324. ** value of *pp is undefined in this case.
  32325. **
  32326. ** If this function does return a pointer, the caller must eventually
  32327. ** release the reference by calling unixUnfetch().
  32328. */
  32329. static int unixFetch(sqlite3_file *fd, i64 iOff, int nAmt, void **pp){
  32330. #if SQLITE_MAX_MMAP_SIZE>0
  32331. unixFile *pFd = (unixFile *)fd; /* The underlying database file */
  32332. #endif
  32333. *pp = 0;
  32334. #if SQLITE_MAX_MMAP_SIZE>0
  32335. if( pFd->mmapSizeMax>0 ){
  32336. if( pFd->pMapRegion==0 ){
  32337. int rc = unixMapfile(pFd, -1);
  32338. if( rc!=SQLITE_OK ) return rc;
  32339. }
  32340. if( pFd->mmapSize >= iOff+nAmt ){
  32341. *pp = &((u8 *)pFd->pMapRegion)[iOff];
  32342. pFd->nFetchOut++;
  32343. }
  32344. }
  32345. #endif
  32346. return SQLITE_OK;
  32347. }
  32348. /*
  32349. ** If the third argument is non-NULL, then this function releases a
  32350. ** reference obtained by an earlier call to unixFetch(). The second
  32351. ** argument passed to this function must be the same as the corresponding
  32352. ** argument that was passed to the unixFetch() invocation.
  32353. **
  32354. ** Or, if the third argument is NULL, then this function is being called
  32355. ** to inform the VFS layer that, according to POSIX, any existing mapping
  32356. ** may now be invalid and should be unmapped.
  32357. */
  32358. static int unixUnfetch(sqlite3_file *fd, i64 iOff, void *p){
  32359. #if SQLITE_MAX_MMAP_SIZE>0
  32360. unixFile *pFd = (unixFile *)fd; /* The underlying database file */
  32361. UNUSED_PARAMETER(iOff);
  32362. /* If p==0 (unmap the entire file) then there must be no outstanding
  32363. ** xFetch references. Or, if p!=0 (meaning it is an xFetch reference),
  32364. ** then there must be at least one outstanding. */
  32365. assert( (p==0)==(pFd->nFetchOut==0) );
  32366. /* If p!=0, it must match the iOff value. */
  32367. assert( p==0 || p==&((u8 *)pFd->pMapRegion)[iOff] );
  32368. if( p ){
  32369. pFd->nFetchOut--;
  32370. }else{
  32371. unixUnmapfile(pFd);
  32372. }
  32373. assert( pFd->nFetchOut>=0 );
  32374. #else
  32375. UNUSED_PARAMETER(fd);
  32376. UNUSED_PARAMETER(p);
  32377. UNUSED_PARAMETER(iOff);
  32378. #endif
  32379. return SQLITE_OK;
  32380. }
  32381. /*
  32382. ** Here ends the implementation of all sqlite3_file methods.
  32383. **
  32384. ********************** End sqlite3_file Methods *******************************
  32385. ******************************************************************************/
  32386. /*
  32387. ** This division contains definitions of sqlite3_io_methods objects that
  32388. ** implement various file locking strategies. It also contains definitions
  32389. ** of "finder" functions. A finder-function is used to locate the appropriate
  32390. ** sqlite3_io_methods object for a particular database file. The pAppData
  32391. ** field of the sqlite3_vfs VFS objects are initialized to be pointers to
  32392. ** the correct finder-function for that VFS.
  32393. **
  32394. ** Most finder functions return a pointer to a fixed sqlite3_io_methods
  32395. ** object. The only interesting finder-function is autolockIoFinder, which
  32396. ** looks at the filesystem type and tries to guess the best locking
  32397. ** strategy from that.
  32398. **
  32399. ** For finder-function F, two objects are created:
  32400. **
  32401. ** (1) The real finder-function named "FImpt()".
  32402. **
  32403. ** (2) A constant pointer to this function named just "F".
  32404. **
  32405. **
  32406. ** A pointer to the F pointer is used as the pAppData value for VFS
  32407. ** objects. We have to do this instead of letting pAppData point
  32408. ** directly at the finder-function since C90 rules prevent a void*
  32409. ** from be cast into a function pointer.
  32410. **
  32411. **
  32412. ** Each instance of this macro generates two objects:
  32413. **
  32414. ** * A constant sqlite3_io_methods object call METHOD that has locking
  32415. ** methods CLOSE, LOCK, UNLOCK, CKRESLOCK.
  32416. **
  32417. ** * An I/O method finder function called FINDER that returns a pointer
  32418. ** to the METHOD object in the previous bullet.
  32419. */
  32420. #define IOMETHODS(FINDER,METHOD,VERSION,CLOSE,LOCK,UNLOCK,CKLOCK,SHMMAP) \
  32421. static const sqlite3_io_methods METHOD = { \
  32422. VERSION, /* iVersion */ \
  32423. CLOSE, /* xClose */ \
  32424. unixRead, /* xRead */ \
  32425. unixWrite, /* xWrite */ \
  32426. unixTruncate, /* xTruncate */ \
  32427. unixSync, /* xSync */ \
  32428. unixFileSize, /* xFileSize */ \
  32429. LOCK, /* xLock */ \
  32430. UNLOCK, /* xUnlock */ \
  32431. CKLOCK, /* xCheckReservedLock */ \
  32432. unixFileControl, /* xFileControl */ \
  32433. unixSectorSize, /* xSectorSize */ \
  32434. unixDeviceCharacteristics, /* xDeviceCapabilities */ \
  32435. SHMMAP, /* xShmMap */ \
  32436. unixShmLock, /* xShmLock */ \
  32437. unixShmBarrier, /* xShmBarrier */ \
  32438. unixShmUnmap, /* xShmUnmap */ \
  32439. unixFetch, /* xFetch */ \
  32440. unixUnfetch, /* xUnfetch */ \
  32441. }; \
  32442. static const sqlite3_io_methods *FINDER##Impl(const char *z, unixFile *p){ \
  32443. UNUSED_PARAMETER(z); UNUSED_PARAMETER(p); \
  32444. return &METHOD; \
  32445. } \
  32446. static const sqlite3_io_methods *(*const FINDER)(const char*,unixFile *p) \
  32447. = FINDER##Impl;
  32448. /*
  32449. ** Here are all of the sqlite3_io_methods objects for each of the
  32450. ** locking strategies. Functions that return pointers to these methods
  32451. ** are also created.
  32452. */
  32453. IOMETHODS(
  32454. posixIoFinder, /* Finder function name */
  32455. posixIoMethods, /* sqlite3_io_methods object name */
  32456. 3, /* shared memory and mmap are enabled */
  32457. unixClose, /* xClose method */
  32458. unixLock, /* xLock method */
  32459. unixUnlock, /* xUnlock method */
  32460. unixCheckReservedLock, /* xCheckReservedLock method */
  32461. unixShmMap /* xShmMap method */
  32462. )
  32463. IOMETHODS(
  32464. nolockIoFinder, /* Finder function name */
  32465. nolockIoMethods, /* sqlite3_io_methods object name */
  32466. 3, /* shared memory is disabled */
  32467. nolockClose, /* xClose method */
  32468. nolockLock, /* xLock method */
  32469. nolockUnlock, /* xUnlock method */
  32470. nolockCheckReservedLock, /* xCheckReservedLock method */
  32471. 0 /* xShmMap method */
  32472. )
  32473. IOMETHODS(
  32474. dotlockIoFinder, /* Finder function name */
  32475. dotlockIoMethods, /* sqlite3_io_methods object name */
  32476. 1, /* shared memory is disabled */
  32477. dotlockClose, /* xClose method */
  32478. dotlockLock, /* xLock method */
  32479. dotlockUnlock, /* xUnlock method */
  32480. dotlockCheckReservedLock, /* xCheckReservedLock method */
  32481. 0 /* xShmMap method */
  32482. )
  32483. #if SQLITE_ENABLE_LOCKING_STYLE
  32484. IOMETHODS(
  32485. flockIoFinder, /* Finder function name */
  32486. flockIoMethods, /* sqlite3_io_methods object name */
  32487. 1, /* shared memory is disabled */
  32488. flockClose, /* xClose method */
  32489. flockLock, /* xLock method */
  32490. flockUnlock, /* xUnlock method */
  32491. flockCheckReservedLock, /* xCheckReservedLock method */
  32492. 0 /* xShmMap method */
  32493. )
  32494. #endif
  32495. #if OS_VXWORKS
  32496. IOMETHODS(
  32497. semIoFinder, /* Finder function name */
  32498. semIoMethods, /* sqlite3_io_methods object name */
  32499. 1, /* shared memory is disabled */
  32500. semXClose, /* xClose method */
  32501. semXLock, /* xLock method */
  32502. semXUnlock, /* xUnlock method */
  32503. semXCheckReservedLock, /* xCheckReservedLock method */
  32504. 0 /* xShmMap method */
  32505. )
  32506. #endif
  32507. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32508. IOMETHODS(
  32509. afpIoFinder, /* Finder function name */
  32510. afpIoMethods, /* sqlite3_io_methods object name */
  32511. 1, /* shared memory is disabled */
  32512. afpClose, /* xClose method */
  32513. afpLock, /* xLock method */
  32514. afpUnlock, /* xUnlock method */
  32515. afpCheckReservedLock, /* xCheckReservedLock method */
  32516. 0 /* xShmMap method */
  32517. )
  32518. #endif
  32519. /*
  32520. ** The proxy locking method is a "super-method" in the sense that it
  32521. ** opens secondary file descriptors for the conch and lock files and
  32522. ** it uses proxy, dot-file, AFP, and flock() locking methods on those
  32523. ** secondary files. For this reason, the division that implements
  32524. ** proxy locking is located much further down in the file. But we need
  32525. ** to go ahead and define the sqlite3_io_methods and finder function
  32526. ** for proxy locking here. So we forward declare the I/O methods.
  32527. */
  32528. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32529. static int proxyClose(sqlite3_file*);
  32530. static int proxyLock(sqlite3_file*, int);
  32531. static int proxyUnlock(sqlite3_file*, int);
  32532. static int proxyCheckReservedLock(sqlite3_file*, int*);
  32533. IOMETHODS(
  32534. proxyIoFinder, /* Finder function name */
  32535. proxyIoMethods, /* sqlite3_io_methods object name */
  32536. 1, /* shared memory is disabled */
  32537. proxyClose, /* xClose method */
  32538. proxyLock, /* xLock method */
  32539. proxyUnlock, /* xUnlock method */
  32540. proxyCheckReservedLock, /* xCheckReservedLock method */
  32541. 0 /* xShmMap method */
  32542. )
  32543. #endif
  32544. /* nfs lockd on OSX 10.3+ doesn't clear write locks when a read lock is set */
  32545. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32546. IOMETHODS(
  32547. nfsIoFinder, /* Finder function name */
  32548. nfsIoMethods, /* sqlite3_io_methods object name */
  32549. 1, /* shared memory is disabled */
  32550. unixClose, /* xClose method */
  32551. unixLock, /* xLock method */
  32552. nfsUnlock, /* xUnlock method */
  32553. unixCheckReservedLock, /* xCheckReservedLock method */
  32554. 0 /* xShmMap method */
  32555. )
  32556. #endif
  32557. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32558. /*
  32559. ** This "finder" function attempts to determine the best locking strategy
  32560. ** for the database file "filePath". It then returns the sqlite3_io_methods
  32561. ** object that implements that strategy.
  32562. **
  32563. ** This is for MacOSX only.
  32564. */
  32565. static const sqlite3_io_methods *autolockIoFinderImpl(
  32566. const char *filePath, /* name of the database file */
  32567. unixFile *pNew /* open file object for the database file */
  32568. ){
  32569. static const struct Mapping {
  32570. const char *zFilesystem; /* Filesystem type name */
  32571. const sqlite3_io_methods *pMethods; /* Appropriate locking method */
  32572. } aMap[] = {
  32573. { "hfs", &posixIoMethods },
  32574. { "ufs", &posixIoMethods },
  32575. { "afpfs", &afpIoMethods },
  32576. { "smbfs", &afpIoMethods },
  32577. { "webdav", &nolockIoMethods },
  32578. { 0, 0 }
  32579. };
  32580. int i;
  32581. struct statfs fsInfo;
  32582. struct flock lockInfo;
  32583. if( !filePath ){
  32584. /* If filePath==NULL that means we are dealing with a transient file
  32585. ** that does not need to be locked. */
  32586. return &nolockIoMethods;
  32587. }
  32588. if( statfs(filePath, &fsInfo) != -1 ){
  32589. if( fsInfo.f_flags & MNT_RDONLY ){
  32590. return &nolockIoMethods;
  32591. }
  32592. for(i=0; aMap[i].zFilesystem; i++){
  32593. if( strcmp(fsInfo.f_fstypename, aMap[i].zFilesystem)==0 ){
  32594. return aMap[i].pMethods;
  32595. }
  32596. }
  32597. }
  32598. /* Default case. Handles, amongst others, "nfs".
  32599. ** Test byte-range lock using fcntl(). If the call succeeds,
  32600. ** assume that the file-system supports POSIX style locks.
  32601. */
  32602. lockInfo.l_len = 1;
  32603. lockInfo.l_start = 0;
  32604. lockInfo.l_whence = SEEK_SET;
  32605. lockInfo.l_type = F_RDLCK;
  32606. if( osFcntl(pNew->h, F_GETLK, &lockInfo)!=-1 ) {
  32607. if( strcmp(fsInfo.f_fstypename, "nfs")==0 ){
  32608. return &nfsIoMethods;
  32609. } else {
  32610. return &posixIoMethods;
  32611. }
  32612. }else{
  32613. return &dotlockIoMethods;
  32614. }
  32615. }
  32616. static const sqlite3_io_methods
  32617. *(*const autolockIoFinder)(const char*,unixFile*) = autolockIoFinderImpl;
  32618. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  32619. #if OS_VXWORKS
  32620. /*
  32621. ** This "finder" function for VxWorks checks to see if posix advisory
  32622. ** locking works. If it does, then that is what is used. If it does not
  32623. ** work, then fallback to named semaphore locking.
  32624. */
  32625. static const sqlite3_io_methods *vxworksIoFinderImpl(
  32626. const char *filePath, /* name of the database file */
  32627. unixFile *pNew /* the open file object */
  32628. ){
  32629. struct flock lockInfo;
  32630. if( !filePath ){
  32631. /* If filePath==NULL that means we are dealing with a transient file
  32632. ** that does not need to be locked. */
  32633. return &nolockIoMethods;
  32634. }
  32635. /* Test if fcntl() is supported and use POSIX style locks.
  32636. ** Otherwise fall back to the named semaphore method.
  32637. */
  32638. lockInfo.l_len = 1;
  32639. lockInfo.l_start = 0;
  32640. lockInfo.l_whence = SEEK_SET;
  32641. lockInfo.l_type = F_RDLCK;
  32642. if( osFcntl(pNew->h, F_GETLK, &lockInfo)!=-1 ) {
  32643. return &posixIoMethods;
  32644. }else{
  32645. return &semIoMethods;
  32646. }
  32647. }
  32648. static const sqlite3_io_methods
  32649. *(*const vxworksIoFinder)(const char*,unixFile*) = vxworksIoFinderImpl;
  32650. #endif /* OS_VXWORKS */
  32651. /*
  32652. ** An abstract type for a pointer to an IO method finder function:
  32653. */
  32654. typedef const sqlite3_io_methods *(*finder_type)(const char*,unixFile*);
  32655. /****************************************************************************
  32656. **************************** sqlite3_vfs methods ****************************
  32657. **
  32658. ** This division contains the implementation of methods on the
  32659. ** sqlite3_vfs object.
  32660. */
  32661. /*
  32662. ** Initialize the contents of the unixFile structure pointed to by pId.
  32663. */
  32664. static int fillInUnixFile(
  32665. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  32666. int h, /* Open file descriptor of file being opened */
  32667. sqlite3_file *pId, /* Write to the unixFile structure here */
  32668. const char *zFilename, /* Name of the file being opened */
  32669. int ctrlFlags /* Zero or more UNIXFILE_* values */
  32670. ){
  32671. const sqlite3_io_methods *pLockingStyle;
  32672. unixFile *pNew = (unixFile *)pId;
  32673. int rc = SQLITE_OK;
  32674. assert( pNew->pInode==NULL );
  32675. /* Usually the path zFilename should not be a relative pathname. The
  32676. ** exception is when opening the proxy "conch" file in builds that
  32677. ** include the special Apple locking styles.
  32678. */
  32679. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32680. assert( zFilename==0 || zFilename[0]=='/'
  32681. || pVfs->pAppData==(void*)&autolockIoFinder );
  32682. #else
  32683. assert( zFilename==0 || zFilename[0]=='/' );
  32684. #endif
  32685. /* No locking occurs in temporary files */
  32686. assert( zFilename!=0 || (ctrlFlags & UNIXFILE_NOLOCK)!=0 );
  32687. OSTRACE(("OPEN %-3d %s\n", h, zFilename));
  32688. pNew->h = h;
  32689. pNew->pVfs = pVfs;
  32690. pNew->zPath = zFilename;
  32691. pNew->ctrlFlags = (u8)ctrlFlags;
  32692. #if SQLITE_MAX_MMAP_SIZE>0
  32693. pNew->mmapSizeMax = sqlite3GlobalConfig.szMmap;
  32694. #endif
  32695. if( sqlite3_uri_boolean(((ctrlFlags & UNIXFILE_URI) ? zFilename : 0),
  32696. "psow", SQLITE_POWERSAFE_OVERWRITE) ){
  32697. pNew->ctrlFlags |= UNIXFILE_PSOW;
  32698. }
  32699. if( strcmp(pVfs->zName,"unix-excl")==0 ){
  32700. pNew->ctrlFlags |= UNIXFILE_EXCL;
  32701. }
  32702. #if OS_VXWORKS
  32703. pNew->pId = vxworksFindFileId(zFilename);
  32704. if( pNew->pId==0 ){
  32705. ctrlFlags |= UNIXFILE_NOLOCK;
  32706. rc = SQLITE_NOMEM_BKPT;
  32707. }
  32708. #endif
  32709. if( ctrlFlags & UNIXFILE_NOLOCK ){
  32710. pLockingStyle = &nolockIoMethods;
  32711. }else{
  32712. pLockingStyle = (**(finder_type*)pVfs->pAppData)(zFilename, pNew);
  32713. #if SQLITE_ENABLE_LOCKING_STYLE
  32714. /* Cache zFilename in the locking context (AFP and dotlock override) for
  32715. ** proxyLock activation is possible (remote proxy is based on db name)
  32716. ** zFilename remains valid until file is closed, to support */
  32717. pNew->lockingContext = (void*)zFilename;
  32718. #endif
  32719. }
  32720. if( pLockingStyle == &posixIoMethods
  32721. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32722. || pLockingStyle == &nfsIoMethods
  32723. #endif
  32724. ){
  32725. unixEnterMutex();
  32726. rc = findInodeInfo(pNew, &pNew->pInode);
  32727. if( rc!=SQLITE_OK ){
  32728. /* If an error occurred in findInodeInfo(), close the file descriptor
  32729. ** immediately, before releasing the mutex. findInodeInfo() may fail
  32730. ** in two scenarios:
  32731. **
  32732. ** (a) A call to fstat() failed.
  32733. ** (b) A malloc failed.
  32734. **
  32735. ** Scenario (b) may only occur if the process is holding no other
  32736. ** file descriptors open on the same file. If there were other file
  32737. ** descriptors on this file, then no malloc would be required by
  32738. ** findInodeInfo(). If this is the case, it is quite safe to close
  32739. ** handle h - as it is guaranteed that no posix locks will be released
  32740. ** by doing so.
  32741. **
  32742. ** If scenario (a) caused the error then things are not so safe. The
  32743. ** implicit assumption here is that if fstat() fails, things are in
  32744. ** such bad shape that dropping a lock or two doesn't matter much.
  32745. */
  32746. robust_close(pNew, h, __LINE__);
  32747. h = -1;
  32748. }
  32749. unixLeaveMutex();
  32750. }
  32751. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  32752. else if( pLockingStyle == &afpIoMethods ){
  32753. /* AFP locking uses the file path so it needs to be included in
  32754. ** the afpLockingContext.
  32755. */
  32756. afpLockingContext *pCtx;
  32757. pNew->lockingContext = pCtx = sqlite3_malloc64( sizeof(*pCtx) );
  32758. if( pCtx==0 ){
  32759. rc = SQLITE_NOMEM_BKPT;
  32760. }else{
  32761. /* NB: zFilename exists and remains valid until the file is closed
  32762. ** according to requirement F11141. So we do not need to make a
  32763. ** copy of the filename. */
  32764. pCtx->dbPath = zFilename;
  32765. pCtx->reserved = 0;
  32766. srandomdev();
  32767. unixEnterMutex();
  32768. rc = findInodeInfo(pNew, &pNew->pInode);
  32769. if( rc!=SQLITE_OK ){
  32770. sqlite3_free(pNew->lockingContext);
  32771. robust_close(pNew, h, __LINE__);
  32772. h = -1;
  32773. }
  32774. unixLeaveMutex();
  32775. }
  32776. }
  32777. #endif
  32778. else if( pLockingStyle == &dotlockIoMethods ){
  32779. /* Dotfile locking uses the file path so it needs to be included in
  32780. ** the dotlockLockingContext
  32781. */
  32782. char *zLockFile;
  32783. int nFilename;
  32784. assert( zFilename!=0 );
  32785. nFilename = (int)strlen(zFilename) + 6;
  32786. zLockFile = (char *)sqlite3_malloc64(nFilename);
  32787. if( zLockFile==0 ){
  32788. rc = SQLITE_NOMEM_BKPT;
  32789. }else{
  32790. sqlite3_snprintf(nFilename, zLockFile, "%s" DOTLOCK_SUFFIX, zFilename);
  32791. }
  32792. pNew->lockingContext = zLockFile;
  32793. }
  32794. #if OS_VXWORKS
  32795. else if( pLockingStyle == &semIoMethods ){
  32796. /* Named semaphore locking uses the file path so it needs to be
  32797. ** included in the semLockingContext
  32798. */
  32799. unixEnterMutex();
  32800. rc = findInodeInfo(pNew, &pNew->pInode);
  32801. if( (rc==SQLITE_OK) && (pNew->pInode->pSem==NULL) ){
  32802. char *zSemName = pNew->pInode->aSemName;
  32803. int n;
  32804. sqlite3_snprintf(MAX_PATHNAME, zSemName, "/%s.sem",
  32805. pNew->pId->zCanonicalName);
  32806. for( n=1; zSemName[n]; n++ )
  32807. if( zSemName[n]=='/' ) zSemName[n] = '_';
  32808. pNew->pInode->pSem = sem_open(zSemName, O_CREAT, 0666, 1);
  32809. if( pNew->pInode->pSem == SEM_FAILED ){
  32810. rc = SQLITE_NOMEM_BKPT;
  32811. pNew->pInode->aSemName[0] = '\0';
  32812. }
  32813. }
  32814. unixLeaveMutex();
  32815. }
  32816. #endif
  32817. storeLastErrno(pNew, 0);
  32818. #if OS_VXWORKS
  32819. if( rc!=SQLITE_OK ){
  32820. if( h>=0 ) robust_close(pNew, h, __LINE__);
  32821. h = -1;
  32822. osUnlink(zFilename);
  32823. pNew->ctrlFlags |= UNIXFILE_DELETE;
  32824. }
  32825. #endif
  32826. if( rc!=SQLITE_OK ){
  32827. if( h>=0 ) robust_close(pNew, h, __LINE__);
  32828. }else{
  32829. pNew->pMethod = pLockingStyle;
  32830. OpenCounter(+1);
  32831. verifyDbFile(pNew);
  32832. }
  32833. return rc;
  32834. }
  32835. /*
  32836. ** Return the name of a directory in which to put temporary files.
  32837. ** If no suitable temporary file directory can be found, return NULL.
  32838. */
  32839. static const char *unixTempFileDir(void){
  32840. static const char *azDirs[] = {
  32841. 0,
  32842. 0,
  32843. "/var/tmp",
  32844. "/usr/tmp",
  32845. "/tmp",
  32846. "."
  32847. };
  32848. unsigned int i = 0;
  32849. struct stat buf;
  32850. const char *zDir = sqlite3_temp_directory;
  32851. if( !azDirs[0] ) azDirs[0] = getenv("SQLITE_TMPDIR");
  32852. if( !azDirs[1] ) azDirs[1] = getenv("TMPDIR");
  32853. while(1){
  32854. if( zDir!=0
  32855. && osStat(zDir, &buf)==0
  32856. && S_ISDIR(buf.st_mode)
  32857. && osAccess(zDir, 03)==0
  32858. ){
  32859. return zDir;
  32860. }
  32861. if( i>=sizeof(azDirs)/sizeof(azDirs[0]) ) break;
  32862. zDir = azDirs[i++];
  32863. }
  32864. return 0;
  32865. }
  32866. /*
  32867. ** Create a temporary file name in zBuf. zBuf must be allocated
  32868. ** by the calling process and must be big enough to hold at least
  32869. ** pVfs->mxPathname bytes.
  32870. */
  32871. static int unixGetTempname(int nBuf, char *zBuf){
  32872. const char *zDir;
  32873. int iLimit = 0;
  32874. /* It's odd to simulate an io-error here, but really this is just
  32875. ** using the io-error infrastructure to test that SQLite handles this
  32876. ** function failing.
  32877. */
  32878. zBuf[0] = 0;
  32879. SimulateIOError( return SQLITE_IOERR );
  32880. zDir = unixTempFileDir();
  32881. if( zDir==0 ) return SQLITE_IOERR_GETTEMPPATH;
  32882. do{
  32883. u64 r;
  32884. sqlite3_randomness(sizeof(r), &r);
  32885. assert( nBuf>2 );
  32886. zBuf[nBuf-2] = 0;
  32887. sqlite3_snprintf(nBuf, zBuf, "%s/"SQLITE_TEMP_FILE_PREFIX"%llx%c",
  32888. zDir, r, 0);
  32889. if( zBuf[nBuf-2]!=0 || (iLimit++)>10 ) return SQLITE_ERROR;
  32890. }while( osAccess(zBuf,0)==0 );
  32891. return SQLITE_OK;
  32892. }
  32893. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  32894. /*
  32895. ** Routine to transform a unixFile into a proxy-locking unixFile.
  32896. ** Implementation in the proxy-lock division, but used by unixOpen()
  32897. ** if SQLITE_PREFER_PROXY_LOCKING is defined.
  32898. */
  32899. static int proxyTransformUnixFile(unixFile*, const char*);
  32900. #endif
  32901. /*
  32902. ** Search for an unused file descriptor that was opened on the database
  32903. ** file (not a journal or master-journal file) identified by pathname
  32904. ** zPath with SQLITE_OPEN_XXX flags matching those passed as the second
  32905. ** argument to this function.
  32906. **
  32907. ** Such a file descriptor may exist if a database connection was closed
  32908. ** but the associated file descriptor could not be closed because some
  32909. ** other file descriptor open on the same file is holding a file-lock.
  32910. ** Refer to comments in the unixClose() function and the lengthy comment
  32911. ** describing "Posix Advisory Locking" at the start of this file for
  32912. ** further details. Also, ticket #4018.
  32913. **
  32914. ** If a suitable file descriptor is found, then it is returned. If no
  32915. ** such file descriptor is located, -1 is returned.
  32916. */
  32917. static UnixUnusedFd *findReusableFd(const char *zPath, int flags){
  32918. UnixUnusedFd *pUnused = 0;
  32919. /* Do not search for an unused file descriptor on vxworks. Not because
  32920. ** vxworks would not benefit from the change (it might, we're not sure),
  32921. ** but because no way to test it is currently available. It is better
  32922. ** not to risk breaking vxworks support for the sake of such an obscure
  32923. ** feature. */
  32924. #if !OS_VXWORKS
  32925. struct stat sStat; /* Results of stat() call */
  32926. /* A stat() call may fail for various reasons. If this happens, it is
  32927. ** almost certain that an open() call on the same path will also fail.
  32928. ** For this reason, if an error occurs in the stat() call here, it is
  32929. ** ignored and -1 is returned. The caller will try to open a new file
  32930. ** descriptor on the same path, fail, and return an error to SQLite.
  32931. **
  32932. ** Even if a subsequent open() call does succeed, the consequences of
  32933. ** not searching for a reusable file descriptor are not dire. */
  32934. if( 0==osStat(zPath, &sStat) ){
  32935. unixInodeInfo *pInode;
  32936. unixEnterMutex();
  32937. pInode = inodeList;
  32938. while( pInode && (pInode->fileId.dev!=sStat.st_dev
  32939. || pInode->fileId.ino!=sStat.st_ino) ){
  32940. pInode = pInode->pNext;
  32941. }
  32942. if( pInode ){
  32943. UnixUnusedFd **pp;
  32944. for(pp=&pInode->pUnused; *pp && (*pp)->flags!=flags; pp=&((*pp)->pNext));
  32945. pUnused = *pp;
  32946. if( pUnused ){
  32947. *pp = pUnused->pNext;
  32948. }
  32949. }
  32950. unixLeaveMutex();
  32951. }
  32952. #endif /* if !OS_VXWORKS */
  32953. return pUnused;
  32954. }
  32955. /*
  32956. ** Find the mode, uid and gid of file zFile.
  32957. */
  32958. static int getFileMode(
  32959. const char *zFile, /* File name */
  32960. mode_t *pMode, /* OUT: Permissions of zFile */
  32961. uid_t *pUid, /* OUT: uid of zFile. */
  32962. gid_t *pGid /* OUT: gid of zFile. */
  32963. ){
  32964. struct stat sStat; /* Output of stat() on database file */
  32965. int rc = SQLITE_OK;
  32966. if( 0==osStat(zFile, &sStat) ){
  32967. *pMode = sStat.st_mode & 0777;
  32968. *pUid = sStat.st_uid;
  32969. *pGid = sStat.st_gid;
  32970. }else{
  32971. rc = SQLITE_IOERR_FSTAT;
  32972. }
  32973. return rc;
  32974. }
  32975. /*
  32976. ** This function is called by unixOpen() to determine the unix permissions
  32977. ** to create new files with. If no error occurs, then SQLITE_OK is returned
  32978. ** and a value suitable for passing as the third argument to open(2) is
  32979. ** written to *pMode. If an IO error occurs, an SQLite error code is
  32980. ** returned and the value of *pMode is not modified.
  32981. **
  32982. ** In most cases, this routine sets *pMode to 0, which will become
  32983. ** an indication to robust_open() to create the file using
  32984. ** SQLITE_DEFAULT_FILE_PERMISSIONS adjusted by the umask.
  32985. ** But if the file being opened is a WAL or regular journal file, then
  32986. ** this function queries the file-system for the permissions on the
  32987. ** corresponding database file and sets *pMode to this value. Whenever
  32988. ** possible, WAL and journal files are created using the same permissions
  32989. ** as the associated database file.
  32990. **
  32991. ** If the SQLITE_ENABLE_8_3_NAMES option is enabled, then the
  32992. ** original filename is unavailable. But 8_3_NAMES is only used for
  32993. ** FAT filesystems and permissions do not matter there, so just use
  32994. ** the default permissions.
  32995. */
  32996. static int findCreateFileMode(
  32997. const char *zPath, /* Path of file (possibly) being created */
  32998. int flags, /* Flags passed as 4th argument to xOpen() */
  32999. mode_t *pMode, /* OUT: Permissions to open file with */
  33000. uid_t *pUid, /* OUT: uid to set on the file */
  33001. gid_t *pGid /* OUT: gid to set on the file */
  33002. ){
  33003. int rc = SQLITE_OK; /* Return Code */
  33004. *pMode = 0;
  33005. *pUid = 0;
  33006. *pGid = 0;
  33007. if( flags & (SQLITE_OPEN_WAL|SQLITE_OPEN_MAIN_JOURNAL) ){
  33008. char zDb[MAX_PATHNAME+1]; /* Database file path */
  33009. int nDb; /* Number of valid bytes in zDb */
  33010. /* zPath is a path to a WAL or journal file. The following block derives
  33011. ** the path to the associated database file from zPath. This block handles
  33012. ** the following naming conventions:
  33013. **
  33014. ** "<path to db>-journal"
  33015. ** "<path to db>-wal"
  33016. ** "<path to db>-journalNN"
  33017. ** "<path to db>-walNN"
  33018. **
  33019. ** where NN is a decimal number. The NN naming schemes are
  33020. ** used by the test_multiplex.c module.
  33021. */
  33022. nDb = sqlite3Strlen30(zPath) - 1;
  33023. while( zPath[nDb]!='-' ){
  33024. #ifndef SQLITE_ENABLE_8_3_NAMES
  33025. /* In the normal case (8+3 filenames disabled) the journal filename
  33026. ** is guaranteed to contain a '-' character. */
  33027. assert( nDb>0 );
  33028. assert( sqlite3Isalnum(zPath[nDb]) );
  33029. #else
  33030. /* If 8+3 names are possible, then the journal file might not contain
  33031. ** a '-' character. So check for that case and return early. */
  33032. if( nDb==0 || zPath[nDb]=='.' ) return SQLITE_OK;
  33033. #endif
  33034. nDb--;
  33035. }
  33036. memcpy(zDb, zPath, nDb);
  33037. zDb[nDb] = '\0';
  33038. rc = getFileMode(zDb, pMode, pUid, pGid);
  33039. }else if( flags & SQLITE_OPEN_DELETEONCLOSE ){
  33040. *pMode = 0600;
  33041. }else if( flags & SQLITE_OPEN_URI ){
  33042. /* If this is a main database file and the file was opened using a URI
  33043. ** filename, check for the "modeof" parameter. If present, interpret
  33044. ** its value as a filename and try to copy the mode, uid and gid from
  33045. ** that file. */
  33046. const char *z = sqlite3_uri_parameter(zPath, "modeof");
  33047. if( z ){
  33048. rc = getFileMode(z, pMode, pUid, pGid);
  33049. }
  33050. }
  33051. return rc;
  33052. }
  33053. /*
  33054. ** Open the file zPath.
  33055. **
  33056. ** Previously, the SQLite OS layer used three functions in place of this
  33057. ** one:
  33058. **
  33059. ** sqlite3OsOpenReadWrite();
  33060. ** sqlite3OsOpenReadOnly();
  33061. ** sqlite3OsOpenExclusive();
  33062. **
  33063. ** These calls correspond to the following combinations of flags:
  33064. **
  33065. ** ReadWrite() -> (READWRITE | CREATE)
  33066. ** ReadOnly() -> (READONLY)
  33067. ** OpenExclusive() -> (READWRITE | CREATE | EXCLUSIVE)
  33068. **
  33069. ** The old OpenExclusive() accepted a boolean argument - "delFlag". If
  33070. ** true, the file was configured to be automatically deleted when the
  33071. ** file handle closed. To achieve the same effect using this new
  33072. ** interface, add the DELETEONCLOSE flag to those specified above for
  33073. ** OpenExclusive().
  33074. */
  33075. static int unixOpen(
  33076. sqlite3_vfs *pVfs, /* The VFS for which this is the xOpen method */
  33077. const char *zPath, /* Pathname of file to be opened */
  33078. sqlite3_file *pFile, /* The file descriptor to be filled in */
  33079. int flags, /* Input flags to control the opening */
  33080. int *pOutFlags /* Output flags returned to SQLite core */
  33081. ){
  33082. unixFile *p = (unixFile *)pFile;
  33083. int fd = -1; /* File descriptor returned by open() */
  33084. int openFlags = 0; /* Flags to pass to open() */
  33085. int eType = flags&0xFFFFFF00; /* Type of file to open */
  33086. int noLock; /* True to omit locking primitives */
  33087. int rc = SQLITE_OK; /* Function Return Code */
  33088. int ctrlFlags = 0; /* UNIXFILE_* flags */
  33089. int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
  33090. int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
  33091. int isCreate = (flags & SQLITE_OPEN_CREATE);
  33092. int isReadonly = (flags & SQLITE_OPEN_READONLY);
  33093. int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
  33094. #if SQLITE_ENABLE_LOCKING_STYLE
  33095. int isAutoProxy = (flags & SQLITE_OPEN_AUTOPROXY);
  33096. #endif
  33097. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  33098. struct statfs fsInfo;
  33099. #endif
  33100. /* If creating a master or main-file journal, this function will open
  33101. ** a file-descriptor on the directory too. The first time unixSync()
  33102. ** is called the directory file descriptor will be fsync()ed and close()d.
  33103. */
  33104. int syncDir = (isCreate && (
  33105. eType==SQLITE_OPEN_MASTER_JOURNAL
  33106. || eType==SQLITE_OPEN_MAIN_JOURNAL
  33107. || eType==SQLITE_OPEN_WAL
  33108. ));
  33109. /* If argument zPath is a NULL pointer, this function is required to open
  33110. ** a temporary file. Use this buffer to store the file name in.
  33111. */
  33112. char zTmpname[MAX_PATHNAME+2];
  33113. const char *zName = zPath;
  33114. /* Check the following statements are true:
  33115. **
  33116. ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
  33117. ** (b) if CREATE is set, then READWRITE must also be set, and
  33118. ** (c) if EXCLUSIVE is set, then CREATE must also be set.
  33119. ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
  33120. */
  33121. assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
  33122. assert(isCreate==0 || isReadWrite);
  33123. assert(isExclusive==0 || isCreate);
  33124. assert(isDelete==0 || isCreate);
  33125. /* The main DB, main journal, WAL file and master journal are never
  33126. ** automatically deleted. Nor are they ever temporary files. */
  33127. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_DB );
  33128. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_JOURNAL );
  33129. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MASTER_JOURNAL );
  33130. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_WAL );
  33131. /* Assert that the upper layer has set one of the "file-type" flags. */
  33132. assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
  33133. || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
  33134. || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
  33135. || eType==SQLITE_OPEN_TRANSIENT_DB || eType==SQLITE_OPEN_WAL
  33136. );
  33137. /* Detect a pid change and reset the PRNG. There is a race condition
  33138. ** here such that two or more threads all trying to open databases at
  33139. ** the same instant might all reset the PRNG. But multiple resets
  33140. ** are harmless.
  33141. */
  33142. if( randomnessPid!=osGetpid(0) ){
  33143. randomnessPid = osGetpid(0);
  33144. sqlite3_randomness(0,0);
  33145. }
  33146. memset(p, 0, sizeof(unixFile));
  33147. if( eType==SQLITE_OPEN_MAIN_DB ){
  33148. UnixUnusedFd *pUnused;
  33149. pUnused = findReusableFd(zName, flags);
  33150. if( pUnused ){
  33151. fd = pUnused->fd;
  33152. }else{
  33153. pUnused = sqlite3_malloc64(sizeof(*pUnused));
  33154. if( !pUnused ){
  33155. return SQLITE_NOMEM_BKPT;
  33156. }
  33157. }
  33158. p->pUnused = pUnused;
  33159. /* Database filenames are double-zero terminated if they are not
  33160. ** URIs with parameters. Hence, they can always be passed into
  33161. ** sqlite3_uri_parameter(). */
  33162. assert( (flags & SQLITE_OPEN_URI) || zName[strlen(zName)+1]==0 );
  33163. }else if( !zName ){
  33164. /* If zName is NULL, the upper layer is requesting a temp file. */
  33165. assert(isDelete && !syncDir);
  33166. rc = unixGetTempname(pVfs->mxPathname, zTmpname);
  33167. if( rc!=SQLITE_OK ){
  33168. return rc;
  33169. }
  33170. zName = zTmpname;
  33171. /* Generated temporary filenames are always double-zero terminated
  33172. ** for use by sqlite3_uri_parameter(). */
  33173. assert( zName[strlen(zName)+1]==0 );
  33174. }
  33175. /* Determine the value of the flags parameter passed to POSIX function
  33176. ** open(). These must be calculated even if open() is not called, as
  33177. ** they may be stored as part of the file handle and used by the
  33178. ** 'conch file' locking functions later on. */
  33179. if( isReadonly ) openFlags |= O_RDONLY;
  33180. if( isReadWrite ) openFlags |= O_RDWR;
  33181. if( isCreate ) openFlags |= O_CREAT;
  33182. if( isExclusive ) openFlags |= (O_EXCL|O_NOFOLLOW);
  33183. openFlags |= (O_LARGEFILE|O_BINARY);
  33184. if( fd<0 ){
  33185. mode_t openMode; /* Permissions to create file with */
  33186. uid_t uid; /* Userid for the file */
  33187. gid_t gid; /* Groupid for the file */
  33188. rc = findCreateFileMode(zName, flags, &openMode, &uid, &gid);
  33189. if( rc!=SQLITE_OK ){
  33190. assert( !p->pUnused );
  33191. assert( eType==SQLITE_OPEN_WAL || eType==SQLITE_OPEN_MAIN_JOURNAL );
  33192. return rc;
  33193. }
  33194. fd = robust_open(zName, openFlags, openMode);
  33195. OSTRACE(("OPENX %-3d %s 0%o\n", fd, zName, openFlags));
  33196. assert( !isExclusive || (openFlags & O_CREAT)!=0 );
  33197. if( fd<0 && errno!=EISDIR && isReadWrite ){
  33198. /* Failed to open the file for read/write access. Try read-only. */
  33199. flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
  33200. openFlags &= ~(O_RDWR|O_CREAT);
  33201. flags |= SQLITE_OPEN_READONLY;
  33202. openFlags |= O_RDONLY;
  33203. isReadonly = 1;
  33204. fd = robust_open(zName, openFlags, openMode);
  33205. }
  33206. if( fd<0 ){
  33207. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "open", zName);
  33208. goto open_finished;
  33209. }
  33210. /* If this process is running as root and if creating a new rollback
  33211. ** journal or WAL file, set the ownership of the journal or WAL to be
  33212. ** the same as the original database.
  33213. */
  33214. if( flags & (SQLITE_OPEN_WAL|SQLITE_OPEN_MAIN_JOURNAL) ){
  33215. robustFchown(fd, uid, gid);
  33216. }
  33217. }
  33218. assert( fd>=0 );
  33219. if( pOutFlags ){
  33220. *pOutFlags = flags;
  33221. }
  33222. if( p->pUnused ){
  33223. p->pUnused->fd = fd;
  33224. p->pUnused->flags = flags;
  33225. }
  33226. if( isDelete ){
  33227. #if OS_VXWORKS
  33228. zPath = zName;
  33229. #elif defined(SQLITE_UNLINK_AFTER_CLOSE)
  33230. zPath = sqlite3_mprintf("%s", zName);
  33231. if( zPath==0 ){
  33232. robust_close(p, fd, __LINE__);
  33233. return SQLITE_NOMEM_BKPT;
  33234. }
  33235. #else
  33236. osUnlink(zName);
  33237. #endif
  33238. }
  33239. #if SQLITE_ENABLE_LOCKING_STYLE
  33240. else{
  33241. p->openFlags = openFlags;
  33242. }
  33243. #endif
  33244. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  33245. if( fstatfs(fd, &fsInfo) == -1 ){
  33246. storeLastErrno(p, errno);
  33247. robust_close(p, fd, __LINE__);
  33248. return SQLITE_IOERR_ACCESS;
  33249. }
  33250. if (0 == strncmp("msdos", fsInfo.f_fstypename, 5)) {
  33251. ((unixFile*)pFile)->fsFlags |= SQLITE_FSFLAGS_IS_MSDOS;
  33252. }
  33253. if (0 == strncmp("exfat", fsInfo.f_fstypename, 5)) {
  33254. ((unixFile*)pFile)->fsFlags |= SQLITE_FSFLAGS_IS_MSDOS;
  33255. }
  33256. #endif
  33257. /* Set up appropriate ctrlFlags */
  33258. if( isDelete ) ctrlFlags |= UNIXFILE_DELETE;
  33259. if( isReadonly ) ctrlFlags |= UNIXFILE_RDONLY;
  33260. noLock = eType!=SQLITE_OPEN_MAIN_DB;
  33261. if( noLock ) ctrlFlags |= UNIXFILE_NOLOCK;
  33262. if( syncDir ) ctrlFlags |= UNIXFILE_DIRSYNC;
  33263. if( flags & SQLITE_OPEN_URI ) ctrlFlags |= UNIXFILE_URI;
  33264. #if SQLITE_ENABLE_LOCKING_STYLE
  33265. #if SQLITE_PREFER_PROXY_LOCKING
  33266. isAutoProxy = 1;
  33267. #endif
  33268. if( isAutoProxy && (zPath!=NULL) && (!noLock) && pVfs->xOpen ){
  33269. char *envforce = getenv("SQLITE_FORCE_PROXY_LOCKING");
  33270. int useProxy = 0;
  33271. /* SQLITE_FORCE_PROXY_LOCKING==1 means force always use proxy, 0 means
  33272. ** never use proxy, NULL means use proxy for non-local files only. */
  33273. if( envforce!=NULL ){
  33274. useProxy = atoi(envforce)>0;
  33275. }else{
  33276. useProxy = !(fsInfo.f_flags&MNT_LOCAL);
  33277. }
  33278. if( useProxy ){
  33279. rc = fillInUnixFile(pVfs, fd, pFile, zPath, ctrlFlags);
  33280. if( rc==SQLITE_OK ){
  33281. rc = proxyTransformUnixFile((unixFile*)pFile, ":auto:");
  33282. if( rc!=SQLITE_OK ){
  33283. /* Use unixClose to clean up the resources added in fillInUnixFile
  33284. ** and clear all the structure's references. Specifically,
  33285. ** pFile->pMethods will be NULL so sqlite3OsClose will be a no-op
  33286. */
  33287. unixClose(pFile);
  33288. return rc;
  33289. }
  33290. }
  33291. goto open_finished;
  33292. }
  33293. }
  33294. #endif
  33295. rc = fillInUnixFile(pVfs, fd, pFile, zPath, ctrlFlags);
  33296. open_finished:
  33297. if( rc!=SQLITE_OK ){
  33298. sqlite3_free(p->pUnused);
  33299. }
  33300. return rc;
  33301. }
  33302. /*
  33303. ** Delete the file at zPath. If the dirSync argument is true, fsync()
  33304. ** the directory after deleting the file.
  33305. */
  33306. static int unixDelete(
  33307. sqlite3_vfs *NotUsed, /* VFS containing this as the xDelete method */
  33308. const char *zPath, /* Name of file to be deleted */
  33309. int dirSync /* If true, fsync() directory after deleting file */
  33310. ){
  33311. int rc = SQLITE_OK;
  33312. UNUSED_PARAMETER(NotUsed);
  33313. SimulateIOError(return SQLITE_IOERR_DELETE);
  33314. if( osUnlink(zPath)==(-1) ){
  33315. if( errno==ENOENT
  33316. #if OS_VXWORKS
  33317. || osAccess(zPath,0)!=0
  33318. #endif
  33319. ){
  33320. rc = SQLITE_IOERR_DELETE_NOENT;
  33321. }else{
  33322. rc = unixLogError(SQLITE_IOERR_DELETE, "unlink", zPath);
  33323. }
  33324. return rc;
  33325. }
  33326. #ifndef SQLITE_DISABLE_DIRSYNC
  33327. if( (dirSync & 1)!=0 ){
  33328. int fd;
  33329. rc = osOpenDirectory(zPath, &fd);
  33330. if( rc==SQLITE_OK ){
  33331. if( full_fsync(fd,0,0) ){
  33332. rc = unixLogError(SQLITE_IOERR_DIR_FSYNC, "fsync", zPath);
  33333. }
  33334. robust_close(0, fd, __LINE__);
  33335. }else{
  33336. assert( rc==SQLITE_CANTOPEN );
  33337. rc = SQLITE_OK;
  33338. }
  33339. }
  33340. #endif
  33341. return rc;
  33342. }
  33343. /*
  33344. ** Test the existence of or access permissions of file zPath. The
  33345. ** test performed depends on the value of flags:
  33346. **
  33347. ** SQLITE_ACCESS_EXISTS: Return 1 if the file exists
  33348. ** SQLITE_ACCESS_READWRITE: Return 1 if the file is read and writable.
  33349. ** SQLITE_ACCESS_READONLY: Return 1 if the file is readable.
  33350. **
  33351. ** Otherwise return 0.
  33352. */
  33353. static int unixAccess(
  33354. sqlite3_vfs *NotUsed, /* The VFS containing this xAccess method */
  33355. const char *zPath, /* Path of the file to examine */
  33356. int flags, /* What do we want to learn about the zPath file? */
  33357. int *pResOut /* Write result boolean here */
  33358. ){
  33359. UNUSED_PARAMETER(NotUsed);
  33360. SimulateIOError( return SQLITE_IOERR_ACCESS; );
  33361. assert( pResOut!=0 );
  33362. /* The spec says there are three possible values for flags. But only
  33363. ** two of them are actually used */
  33364. assert( flags==SQLITE_ACCESS_EXISTS || flags==SQLITE_ACCESS_READWRITE );
  33365. if( flags==SQLITE_ACCESS_EXISTS ){
  33366. struct stat buf;
  33367. *pResOut = (0==osStat(zPath, &buf) && buf.st_size>0);
  33368. }else{
  33369. *pResOut = osAccess(zPath, W_OK|R_OK)==0;
  33370. }
  33371. return SQLITE_OK;
  33372. }
  33373. /*
  33374. **
  33375. */
  33376. static int mkFullPathname(
  33377. const char *zPath, /* Input path */
  33378. char *zOut, /* Output buffer */
  33379. int nOut /* Allocated size of buffer zOut */
  33380. ){
  33381. int nPath = sqlite3Strlen30(zPath);
  33382. int iOff = 0;
  33383. if( zPath[0]!='/' ){
  33384. if( osGetcwd(zOut, nOut-2)==0 ){
  33385. return unixLogError(SQLITE_CANTOPEN_BKPT, "getcwd", zPath);
  33386. }
  33387. iOff = sqlite3Strlen30(zOut);
  33388. zOut[iOff++] = '/';
  33389. }
  33390. if( (iOff+nPath+1)>nOut ){
  33391. /* SQLite assumes that xFullPathname() nul-terminates the output buffer
  33392. ** even if it returns an error. */
  33393. zOut[iOff] = '\0';
  33394. return SQLITE_CANTOPEN_BKPT;
  33395. }
  33396. sqlite3_snprintf(nOut-iOff, &zOut[iOff], "%s", zPath);
  33397. return SQLITE_OK;
  33398. }
  33399. /*
  33400. ** Turn a relative pathname into a full pathname. The relative path
  33401. ** is stored as a nul-terminated string in the buffer pointed to by
  33402. ** zPath.
  33403. **
  33404. ** zOut points to a buffer of at least sqlite3_vfs.mxPathname bytes
  33405. ** (in this case, MAX_PATHNAME bytes). The full-path is written to
  33406. ** this buffer before returning.
  33407. */
  33408. static int unixFullPathname(
  33409. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  33410. const char *zPath, /* Possibly relative input path */
  33411. int nOut, /* Size of output buffer in bytes */
  33412. char *zOut /* Output buffer */
  33413. ){
  33414. #if !defined(HAVE_READLINK) || !defined(HAVE_LSTAT)
  33415. return mkFullPathname(zPath, zOut, nOut);
  33416. #else
  33417. int rc = SQLITE_OK;
  33418. int nByte;
  33419. int nLink = 1; /* Number of symbolic links followed so far */
  33420. const char *zIn = zPath; /* Input path for each iteration of loop */
  33421. char *zDel = 0;
  33422. assert( pVfs->mxPathname==MAX_PATHNAME );
  33423. UNUSED_PARAMETER(pVfs);
  33424. /* It's odd to simulate an io-error here, but really this is just
  33425. ** using the io-error infrastructure to test that SQLite handles this
  33426. ** function failing. This function could fail if, for example, the
  33427. ** current working directory has been unlinked.
  33428. */
  33429. SimulateIOError( return SQLITE_ERROR );
  33430. do {
  33431. /* Call stat() on path zIn. Set bLink to true if the path is a symbolic
  33432. ** link, or false otherwise. */
  33433. int bLink = 0;
  33434. struct stat buf;
  33435. if( osLstat(zIn, &buf)!=0 ){
  33436. if( errno!=ENOENT ){
  33437. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "lstat", zIn);
  33438. }
  33439. }else{
  33440. bLink = S_ISLNK(buf.st_mode);
  33441. }
  33442. if( bLink ){
  33443. if( zDel==0 ){
  33444. zDel = sqlite3_malloc(nOut);
  33445. if( zDel==0 ) rc = SQLITE_NOMEM_BKPT;
  33446. }else if( ++nLink>SQLITE_MAX_SYMLINKS ){
  33447. rc = SQLITE_CANTOPEN_BKPT;
  33448. }
  33449. if( rc==SQLITE_OK ){
  33450. nByte = osReadlink(zIn, zDel, nOut-1);
  33451. if( nByte<0 ){
  33452. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "readlink", zIn);
  33453. }else{
  33454. if( zDel[0]!='/' ){
  33455. int n;
  33456. for(n = sqlite3Strlen30(zIn); n>0 && zIn[n-1]!='/'; n--);
  33457. if( nByte+n+1>nOut ){
  33458. rc = SQLITE_CANTOPEN_BKPT;
  33459. }else{
  33460. memmove(&zDel[n], zDel, nByte+1);
  33461. memcpy(zDel, zIn, n);
  33462. nByte += n;
  33463. }
  33464. }
  33465. zDel[nByte] = '\0';
  33466. }
  33467. }
  33468. zIn = zDel;
  33469. }
  33470. assert( rc!=SQLITE_OK || zIn!=zOut || zIn[0]=='/' );
  33471. if( rc==SQLITE_OK && zIn!=zOut ){
  33472. rc = mkFullPathname(zIn, zOut, nOut);
  33473. }
  33474. if( bLink==0 ) break;
  33475. zIn = zOut;
  33476. }while( rc==SQLITE_OK );
  33477. sqlite3_free(zDel);
  33478. return rc;
  33479. #endif /* HAVE_READLINK && HAVE_LSTAT */
  33480. }
  33481. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  33482. /*
  33483. ** Interfaces for opening a shared library, finding entry points
  33484. ** within the shared library, and closing the shared library.
  33485. */
  33486. #include <dlfcn.h>
  33487. static void *unixDlOpen(sqlite3_vfs *NotUsed, const char *zFilename){
  33488. UNUSED_PARAMETER(NotUsed);
  33489. return dlopen(zFilename, RTLD_NOW | RTLD_GLOBAL);
  33490. }
  33491. /*
  33492. ** SQLite calls this function immediately after a call to unixDlSym() or
  33493. ** unixDlOpen() fails (returns a null pointer). If a more detailed error
  33494. ** message is available, it is written to zBufOut. If no error message
  33495. ** is available, zBufOut is left unmodified and SQLite uses a default
  33496. ** error message.
  33497. */
  33498. static void unixDlError(sqlite3_vfs *NotUsed, int nBuf, char *zBufOut){
  33499. const char *zErr;
  33500. UNUSED_PARAMETER(NotUsed);
  33501. unixEnterMutex();
  33502. zErr = dlerror();
  33503. if( zErr ){
  33504. sqlite3_snprintf(nBuf, zBufOut, "%s", zErr);
  33505. }
  33506. unixLeaveMutex();
  33507. }
  33508. static void (*unixDlSym(sqlite3_vfs *NotUsed, void *p, const char*zSym))(void){
  33509. /*
  33510. ** GCC with -pedantic-errors says that C90 does not allow a void* to be
  33511. ** cast into a pointer to a function. And yet the library dlsym() routine
  33512. ** returns a void* which is really a pointer to a function. So how do we
  33513. ** use dlsym() with -pedantic-errors?
  33514. **
  33515. ** Variable x below is defined to be a pointer to a function taking
  33516. ** parameters void* and const char* and returning a pointer to a function.
  33517. ** We initialize x by assigning it a pointer to the dlsym() function.
  33518. ** (That assignment requires a cast.) Then we call the function that
  33519. ** x points to.
  33520. **
  33521. ** This work-around is unlikely to work correctly on any system where
  33522. ** you really cannot cast a function pointer into void*. But then, on the
  33523. ** other hand, dlsym() will not work on such a system either, so we have
  33524. ** not really lost anything.
  33525. */
  33526. void (*(*x)(void*,const char*))(void);
  33527. UNUSED_PARAMETER(NotUsed);
  33528. x = (void(*(*)(void*,const char*))(void))dlsym;
  33529. return (*x)(p, zSym);
  33530. }
  33531. static void unixDlClose(sqlite3_vfs *NotUsed, void *pHandle){
  33532. UNUSED_PARAMETER(NotUsed);
  33533. dlclose(pHandle);
  33534. }
  33535. #else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
  33536. #define unixDlOpen 0
  33537. #define unixDlError 0
  33538. #define unixDlSym 0
  33539. #define unixDlClose 0
  33540. #endif
  33541. /*
  33542. ** Write nBuf bytes of random data to the supplied buffer zBuf.
  33543. */
  33544. static int unixRandomness(sqlite3_vfs *NotUsed, int nBuf, char *zBuf){
  33545. UNUSED_PARAMETER(NotUsed);
  33546. assert((size_t)nBuf>=(sizeof(time_t)+sizeof(int)));
  33547. /* We have to initialize zBuf to prevent valgrind from reporting
  33548. ** errors. The reports issued by valgrind are incorrect - we would
  33549. ** prefer that the randomness be increased by making use of the
  33550. ** uninitialized space in zBuf - but valgrind errors tend to worry
  33551. ** some users. Rather than argue, it seems easier just to initialize
  33552. ** the whole array and silence valgrind, even if that means less randomness
  33553. ** in the random seed.
  33554. **
  33555. ** When testing, initializing zBuf[] to zero is all we do. That means
  33556. ** that we always use the same random number sequence. This makes the
  33557. ** tests repeatable.
  33558. */
  33559. memset(zBuf, 0, nBuf);
  33560. randomnessPid = osGetpid(0);
  33561. #if !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS)
  33562. {
  33563. int fd, got;
  33564. fd = robust_open("/dev/urandom", O_RDONLY, 0);
  33565. if( fd<0 ){
  33566. time_t t;
  33567. time(&t);
  33568. memcpy(zBuf, &t, sizeof(t));
  33569. memcpy(&zBuf[sizeof(t)], &randomnessPid, sizeof(randomnessPid));
  33570. assert( sizeof(t)+sizeof(randomnessPid)<=(size_t)nBuf );
  33571. nBuf = sizeof(t) + sizeof(randomnessPid);
  33572. }else{
  33573. do{ got = osRead(fd, zBuf, nBuf); }while( got<0 && errno==EINTR );
  33574. robust_close(0, fd, __LINE__);
  33575. }
  33576. }
  33577. #endif
  33578. return nBuf;
  33579. }
  33580. /*
  33581. ** Sleep for a little while. Return the amount of time slept.
  33582. ** The argument is the number of microseconds we want to sleep.
  33583. ** The return value is the number of microseconds of sleep actually
  33584. ** requested from the underlying operating system, a number which
  33585. ** might be greater than or equal to the argument, but not less
  33586. ** than the argument.
  33587. */
  33588. static int unixSleep(sqlite3_vfs *NotUsed, int microseconds){
  33589. #if OS_VXWORKS
  33590. struct timespec sp;
  33591. sp.tv_sec = microseconds / 1000000;
  33592. sp.tv_nsec = (microseconds % 1000000) * 1000;
  33593. nanosleep(&sp, NULL);
  33594. UNUSED_PARAMETER(NotUsed);
  33595. return microseconds;
  33596. #elif defined(HAVE_USLEEP) && HAVE_USLEEP
  33597. usleep(microseconds);
  33598. UNUSED_PARAMETER(NotUsed);
  33599. return microseconds;
  33600. #else
  33601. int seconds = (microseconds+999999)/1000000;
  33602. sleep(seconds);
  33603. UNUSED_PARAMETER(NotUsed);
  33604. return seconds*1000000;
  33605. #endif
  33606. }
  33607. /*
  33608. ** The following variable, if set to a non-zero value, is interpreted as
  33609. ** the number of seconds since 1970 and is used to set the result of
  33610. ** sqlite3OsCurrentTime() during testing.
  33611. */
  33612. #ifdef SQLITE_TEST
  33613. SQLITE_API int sqlite3_current_time = 0; /* Fake system time in seconds since 1970. */
  33614. #endif
  33615. /*
  33616. ** Find the current time (in Universal Coordinated Time). Write into *piNow
  33617. ** the current time and date as a Julian Day number times 86_400_000. In
  33618. ** other words, write into *piNow the number of milliseconds since the Julian
  33619. ** epoch of noon in Greenwich on November 24, 4714 B.C according to the
  33620. ** proleptic Gregorian calendar.
  33621. **
  33622. ** On success, return SQLITE_OK. Return SQLITE_ERROR if the time and date
  33623. ** cannot be found.
  33624. */
  33625. static int unixCurrentTimeInt64(sqlite3_vfs *NotUsed, sqlite3_int64 *piNow){
  33626. static const sqlite3_int64 unixEpoch = 24405875*(sqlite3_int64)8640000;
  33627. int rc = SQLITE_OK;
  33628. #if defined(NO_GETTOD)
  33629. time_t t;
  33630. time(&t);
  33631. *piNow = ((sqlite3_int64)t)*1000 + unixEpoch;
  33632. #elif OS_VXWORKS
  33633. struct timespec sNow;
  33634. clock_gettime(CLOCK_REALTIME, &sNow);
  33635. *piNow = unixEpoch + 1000*(sqlite3_int64)sNow.tv_sec + sNow.tv_nsec/1000000;
  33636. #else
  33637. struct timeval sNow;
  33638. (void)gettimeofday(&sNow, 0); /* Cannot fail given valid arguments */
  33639. *piNow = unixEpoch + 1000*(sqlite3_int64)sNow.tv_sec + sNow.tv_usec/1000;
  33640. #endif
  33641. #ifdef SQLITE_TEST
  33642. if( sqlite3_current_time ){
  33643. *piNow = 1000*(sqlite3_int64)sqlite3_current_time + unixEpoch;
  33644. }
  33645. #endif
  33646. UNUSED_PARAMETER(NotUsed);
  33647. return rc;
  33648. }
  33649. #ifndef SQLITE_OMIT_DEPRECATED
  33650. /*
  33651. ** Find the current time (in Universal Coordinated Time). Write the
  33652. ** current time and date as a Julian Day number into *prNow and
  33653. ** return 0. Return 1 if the time and date cannot be found.
  33654. */
  33655. static int unixCurrentTime(sqlite3_vfs *NotUsed, double *prNow){
  33656. sqlite3_int64 i = 0;
  33657. int rc;
  33658. UNUSED_PARAMETER(NotUsed);
  33659. rc = unixCurrentTimeInt64(0, &i);
  33660. *prNow = i/86400000.0;
  33661. return rc;
  33662. }
  33663. #else
  33664. # define unixCurrentTime 0
  33665. #endif
  33666. /*
  33667. ** The xGetLastError() method is designed to return a better
  33668. ** low-level error message when operating-system problems come up
  33669. ** during SQLite operation. Only the integer return code is currently
  33670. ** used.
  33671. */
  33672. static int unixGetLastError(sqlite3_vfs *NotUsed, int NotUsed2, char *NotUsed3){
  33673. UNUSED_PARAMETER(NotUsed);
  33674. UNUSED_PARAMETER(NotUsed2);
  33675. UNUSED_PARAMETER(NotUsed3);
  33676. return errno;
  33677. }
  33678. /*
  33679. ************************ End of sqlite3_vfs methods ***************************
  33680. ******************************************************************************/
  33681. /******************************************************************************
  33682. ************************** Begin Proxy Locking ********************************
  33683. **
  33684. ** Proxy locking is a "uber-locking-method" in this sense: It uses the
  33685. ** other locking methods on secondary lock files. Proxy locking is a
  33686. ** meta-layer over top of the primitive locking implemented above. For
  33687. ** this reason, the division that implements of proxy locking is deferred
  33688. ** until late in the file (here) after all of the other I/O methods have
  33689. ** been defined - so that the primitive locking methods are available
  33690. ** as services to help with the implementation of proxy locking.
  33691. **
  33692. ****
  33693. **
  33694. ** The default locking schemes in SQLite use byte-range locks on the
  33695. ** database file to coordinate safe, concurrent access by multiple readers
  33696. ** and writers [http://sqlite.org/lockingv3.html]. The five file locking
  33697. ** states (UNLOCKED, PENDING, SHARED, RESERVED, EXCLUSIVE) are implemented
  33698. ** as POSIX read & write locks over fixed set of locations (via fsctl),
  33699. ** on AFP and SMB only exclusive byte-range locks are available via fsctl
  33700. ** with _IOWR('z', 23, struct ByteRangeLockPB2) to track the same 5 states.
  33701. ** To simulate a F_RDLCK on the shared range, on AFP a randomly selected
  33702. ** address in the shared range is taken for a SHARED lock, the entire
  33703. ** shared range is taken for an EXCLUSIVE lock):
  33704. **
  33705. ** PENDING_BYTE 0x40000000
  33706. ** RESERVED_BYTE 0x40000001
  33707. ** SHARED_RANGE 0x40000002 -> 0x40000200
  33708. **
  33709. ** This works well on the local file system, but shows a nearly 100x
  33710. ** slowdown in read performance on AFP because the AFP client disables
  33711. ** the read cache when byte-range locks are present. Enabling the read
  33712. ** cache exposes a cache coherency problem that is present on all OS X
  33713. ** supported network file systems. NFS and AFP both observe the
  33714. ** close-to-open semantics for ensuring cache coherency
  33715. ** [http://nfs.sourceforge.net/#faq_a8], which does not effectively
  33716. ** address the requirements for concurrent database access by multiple
  33717. ** readers and writers
  33718. ** [http://www.nabble.com/SQLite-on-NFS-cache-coherency-td15655701.html].
  33719. **
  33720. ** To address the performance and cache coherency issues, proxy file locking
  33721. ** changes the way database access is controlled by limiting access to a
  33722. ** single host at a time and moving file locks off of the database file
  33723. ** and onto a proxy file on the local file system.
  33724. **
  33725. **
  33726. ** Using proxy locks
  33727. ** -----------------
  33728. **
  33729. ** C APIs
  33730. **
  33731. ** sqlite3_file_control(db, dbname, SQLITE_FCNTL_SET_LOCKPROXYFILE,
  33732. ** <proxy_path> | ":auto:");
  33733. ** sqlite3_file_control(db, dbname, SQLITE_FCNTL_GET_LOCKPROXYFILE,
  33734. ** &<proxy_path>);
  33735. **
  33736. **
  33737. ** SQL pragmas
  33738. **
  33739. ** PRAGMA [database.]lock_proxy_file=<proxy_path> | :auto:
  33740. ** PRAGMA [database.]lock_proxy_file
  33741. **
  33742. ** Specifying ":auto:" means that if there is a conch file with a matching
  33743. ** host ID in it, the proxy path in the conch file will be used, otherwise
  33744. ** a proxy path based on the user's temp dir
  33745. ** (via confstr(_CS_DARWIN_USER_TEMP_DIR,...)) will be used and the
  33746. ** actual proxy file name is generated from the name and path of the
  33747. ** database file. For example:
  33748. **
  33749. ** For database path "/Users/me/foo.db"
  33750. ** The lock path will be "<tmpdir>/sqliteplocks/_Users_me_foo.db:auto:")
  33751. **
  33752. ** Once a lock proxy is configured for a database connection, it can not
  33753. ** be removed, however it may be switched to a different proxy path via
  33754. ** the above APIs (assuming the conch file is not being held by another
  33755. ** connection or process).
  33756. **
  33757. **
  33758. ** How proxy locking works
  33759. ** -----------------------
  33760. **
  33761. ** Proxy file locking relies primarily on two new supporting files:
  33762. **
  33763. ** * conch file to limit access to the database file to a single host
  33764. ** at a time
  33765. **
  33766. ** * proxy file to act as a proxy for the advisory locks normally
  33767. ** taken on the database
  33768. **
  33769. ** The conch file - to use a proxy file, sqlite must first "hold the conch"
  33770. ** by taking an sqlite-style shared lock on the conch file, reading the
  33771. ** contents and comparing the host's unique host ID (see below) and lock
  33772. ** proxy path against the values stored in the conch. The conch file is
  33773. ** stored in the same directory as the database file and the file name
  33774. ** is patterned after the database file name as ".<databasename>-conch".
  33775. ** If the conch file does not exist, or its contents do not match the
  33776. ** host ID and/or proxy path, then the lock is escalated to an exclusive
  33777. ** lock and the conch file contents is updated with the host ID and proxy
  33778. ** path and the lock is downgraded to a shared lock again. If the conch
  33779. ** is held by another process (with a shared lock), the exclusive lock
  33780. ** will fail and SQLITE_BUSY is returned.
  33781. **
  33782. ** The proxy file - a single-byte file used for all advisory file locks
  33783. ** normally taken on the database file. This allows for safe sharing
  33784. ** of the database file for multiple readers and writers on the same
  33785. ** host (the conch ensures that they all use the same local lock file).
  33786. **
  33787. ** Requesting the lock proxy does not immediately take the conch, it is
  33788. ** only taken when the first request to lock database file is made.
  33789. ** This matches the semantics of the traditional locking behavior, where
  33790. ** opening a connection to a database file does not take a lock on it.
  33791. ** The shared lock and an open file descriptor are maintained until
  33792. ** the connection to the database is closed.
  33793. **
  33794. ** The proxy file and the lock file are never deleted so they only need
  33795. ** to be created the first time they are used.
  33796. **
  33797. ** Configuration options
  33798. ** ---------------------
  33799. **
  33800. ** SQLITE_PREFER_PROXY_LOCKING
  33801. **
  33802. ** Database files accessed on non-local file systems are
  33803. ** automatically configured for proxy locking, lock files are
  33804. ** named automatically using the same logic as
  33805. ** PRAGMA lock_proxy_file=":auto:"
  33806. **
  33807. ** SQLITE_PROXY_DEBUG
  33808. **
  33809. ** Enables the logging of error messages during host id file
  33810. ** retrieval and creation
  33811. **
  33812. ** LOCKPROXYDIR
  33813. **
  33814. ** Overrides the default directory used for lock proxy files that
  33815. ** are named automatically via the ":auto:" setting
  33816. **
  33817. ** SQLITE_DEFAULT_PROXYDIR_PERMISSIONS
  33818. **
  33819. ** Permissions to use when creating a directory for storing the
  33820. ** lock proxy files, only used when LOCKPROXYDIR is not set.
  33821. **
  33822. **
  33823. ** As mentioned above, when compiled with SQLITE_PREFER_PROXY_LOCKING,
  33824. ** setting the environment variable SQLITE_FORCE_PROXY_LOCKING to 1 will
  33825. ** force proxy locking to be used for every database file opened, and 0
  33826. ** will force automatic proxy locking to be disabled for all database
  33827. ** files (explicitly calling the SQLITE_FCNTL_SET_LOCKPROXYFILE pragma or
  33828. ** sqlite_file_control API is not affected by SQLITE_FORCE_PROXY_LOCKING).
  33829. */
  33830. /*
  33831. ** Proxy locking is only available on MacOSX
  33832. */
  33833. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  33834. /*
  33835. ** The proxyLockingContext has the path and file structures for the remote
  33836. ** and local proxy files in it
  33837. */
  33838. typedef struct proxyLockingContext proxyLockingContext;
  33839. struct proxyLockingContext {
  33840. unixFile *conchFile; /* Open conch file */
  33841. char *conchFilePath; /* Name of the conch file */
  33842. unixFile *lockProxy; /* Open proxy lock file */
  33843. char *lockProxyPath; /* Name of the proxy lock file */
  33844. char *dbPath; /* Name of the open file */
  33845. int conchHeld; /* 1 if the conch is held, -1 if lockless */
  33846. int nFails; /* Number of conch taking failures */
  33847. void *oldLockingContext; /* Original lockingcontext to restore on close */
  33848. sqlite3_io_methods const *pOldMethod; /* Original I/O methods for close */
  33849. };
  33850. /*
  33851. ** The proxy lock file path for the database at dbPath is written into lPath,
  33852. ** which must point to valid, writable memory large enough for a maxLen length
  33853. ** file path.
  33854. */
  33855. static int proxyGetLockPath(const char *dbPath, char *lPath, size_t maxLen){
  33856. int len;
  33857. int dbLen;
  33858. int i;
  33859. #ifdef LOCKPROXYDIR
  33860. len = strlcpy(lPath, LOCKPROXYDIR, maxLen);
  33861. #else
  33862. # ifdef _CS_DARWIN_USER_TEMP_DIR
  33863. {
  33864. if( !confstr(_CS_DARWIN_USER_TEMP_DIR, lPath, maxLen) ){
  33865. OSTRACE(("GETLOCKPATH failed %s errno=%d pid=%d\n",
  33866. lPath, errno, osGetpid(0)));
  33867. return SQLITE_IOERR_LOCK;
  33868. }
  33869. len = strlcat(lPath, "sqliteplocks", maxLen);
  33870. }
  33871. # else
  33872. len = strlcpy(lPath, "/tmp/", maxLen);
  33873. # endif
  33874. #endif
  33875. if( lPath[len-1]!='/' ){
  33876. len = strlcat(lPath, "/", maxLen);
  33877. }
  33878. /* transform the db path to a unique cache name */
  33879. dbLen = (int)strlen(dbPath);
  33880. for( i=0; i<dbLen && (i+len+7)<(int)maxLen; i++){
  33881. char c = dbPath[i];
  33882. lPath[i+len] = (c=='/')?'_':c;
  33883. }
  33884. lPath[i+len]='\0';
  33885. strlcat(lPath, ":auto:", maxLen);
  33886. OSTRACE(("GETLOCKPATH proxy lock path=%s pid=%d\n", lPath, osGetpid(0)));
  33887. return SQLITE_OK;
  33888. }
  33889. /*
  33890. ** Creates the lock file and any missing directories in lockPath
  33891. */
  33892. static int proxyCreateLockPath(const char *lockPath){
  33893. int i, len;
  33894. char buf[MAXPATHLEN];
  33895. int start = 0;
  33896. assert(lockPath!=NULL);
  33897. /* try to create all the intermediate directories */
  33898. len = (int)strlen(lockPath);
  33899. buf[0] = lockPath[0];
  33900. for( i=1; i<len; i++ ){
  33901. if( lockPath[i] == '/' && (i - start > 0) ){
  33902. /* only mkdir if leaf dir != "." or "/" or ".." */
  33903. if( i-start>2 || (i-start==1 && buf[start] != '.' && buf[start] != '/')
  33904. || (i-start==2 && buf[start] != '.' && buf[start+1] != '.') ){
  33905. buf[i]='\0';
  33906. if( osMkdir(buf, SQLITE_DEFAULT_PROXYDIR_PERMISSIONS) ){
  33907. int err=errno;
  33908. if( err!=EEXIST ) {
  33909. OSTRACE(("CREATELOCKPATH FAILED creating %s, "
  33910. "'%s' proxy lock path=%s pid=%d\n",
  33911. buf, strerror(err), lockPath, osGetpid(0)));
  33912. return err;
  33913. }
  33914. }
  33915. }
  33916. start=i+1;
  33917. }
  33918. buf[i] = lockPath[i];
  33919. }
  33920. OSTRACE(("CREATELOCKPATH proxy lock path=%s pid=%d\n",lockPath,osGetpid(0)));
  33921. return 0;
  33922. }
  33923. /*
  33924. ** Create a new VFS file descriptor (stored in memory obtained from
  33925. ** sqlite3_malloc) and open the file named "path" in the file descriptor.
  33926. **
  33927. ** The caller is responsible not only for closing the file descriptor
  33928. ** but also for freeing the memory associated with the file descriptor.
  33929. */
  33930. static int proxyCreateUnixFile(
  33931. const char *path, /* path for the new unixFile */
  33932. unixFile **ppFile, /* unixFile created and returned by ref */
  33933. int islockfile /* if non zero missing dirs will be created */
  33934. ) {
  33935. int fd = -1;
  33936. unixFile *pNew;
  33937. int rc = SQLITE_OK;
  33938. int openFlags = O_RDWR | O_CREAT;
  33939. sqlite3_vfs dummyVfs;
  33940. int terrno = 0;
  33941. UnixUnusedFd *pUnused = NULL;
  33942. /* 1. first try to open/create the file
  33943. ** 2. if that fails, and this is a lock file (not-conch), try creating
  33944. ** the parent directories and then try again.
  33945. ** 3. if that fails, try to open the file read-only
  33946. ** otherwise return BUSY (if lock file) or CANTOPEN for the conch file
  33947. */
  33948. pUnused = findReusableFd(path, openFlags);
  33949. if( pUnused ){
  33950. fd = pUnused->fd;
  33951. }else{
  33952. pUnused = sqlite3_malloc64(sizeof(*pUnused));
  33953. if( !pUnused ){
  33954. return SQLITE_NOMEM_BKPT;
  33955. }
  33956. }
  33957. if( fd<0 ){
  33958. fd = robust_open(path, openFlags, 0);
  33959. terrno = errno;
  33960. if( fd<0 && errno==ENOENT && islockfile ){
  33961. if( proxyCreateLockPath(path) == SQLITE_OK ){
  33962. fd = robust_open(path, openFlags, 0);
  33963. }
  33964. }
  33965. }
  33966. if( fd<0 ){
  33967. openFlags = O_RDONLY;
  33968. fd = robust_open(path, openFlags, 0);
  33969. terrno = errno;
  33970. }
  33971. if( fd<0 ){
  33972. if( islockfile ){
  33973. return SQLITE_BUSY;
  33974. }
  33975. switch (terrno) {
  33976. case EACCES:
  33977. return SQLITE_PERM;
  33978. case EIO:
  33979. return SQLITE_IOERR_LOCK; /* even though it is the conch */
  33980. default:
  33981. return SQLITE_CANTOPEN_BKPT;
  33982. }
  33983. }
  33984. pNew = (unixFile *)sqlite3_malloc64(sizeof(*pNew));
  33985. if( pNew==NULL ){
  33986. rc = SQLITE_NOMEM_BKPT;
  33987. goto end_create_proxy;
  33988. }
  33989. memset(pNew, 0, sizeof(unixFile));
  33990. pNew->openFlags = openFlags;
  33991. memset(&dummyVfs, 0, sizeof(dummyVfs));
  33992. dummyVfs.pAppData = (void*)&autolockIoFinder;
  33993. dummyVfs.zName = "dummy";
  33994. pUnused->fd = fd;
  33995. pUnused->flags = openFlags;
  33996. pNew->pUnused = pUnused;
  33997. rc = fillInUnixFile(&dummyVfs, fd, (sqlite3_file*)pNew, path, 0);
  33998. if( rc==SQLITE_OK ){
  33999. *ppFile = pNew;
  34000. return SQLITE_OK;
  34001. }
  34002. end_create_proxy:
  34003. robust_close(pNew, fd, __LINE__);
  34004. sqlite3_free(pNew);
  34005. sqlite3_free(pUnused);
  34006. return rc;
  34007. }
  34008. #ifdef SQLITE_TEST
  34009. /* simulate multiple hosts by creating unique hostid file paths */
  34010. SQLITE_API int sqlite3_hostid_num = 0;
  34011. #endif
  34012. #define PROXY_HOSTIDLEN 16 /* conch file host id length */
  34013. #ifdef HAVE_GETHOSTUUID
  34014. /* Not always defined in the headers as it ought to be */
  34015. extern int gethostuuid(uuid_t id, const struct timespec *wait);
  34016. #endif
  34017. /* get the host ID via gethostuuid(), pHostID must point to PROXY_HOSTIDLEN
  34018. ** bytes of writable memory.
  34019. */
  34020. static int proxyGetHostID(unsigned char *pHostID, int *pError){
  34021. assert(PROXY_HOSTIDLEN == sizeof(uuid_t));
  34022. memset(pHostID, 0, PROXY_HOSTIDLEN);
  34023. #ifdef HAVE_GETHOSTUUID
  34024. {
  34025. struct timespec timeout = {1, 0}; /* 1 sec timeout */
  34026. if( gethostuuid(pHostID, &timeout) ){
  34027. int err = errno;
  34028. if( pError ){
  34029. *pError = err;
  34030. }
  34031. return SQLITE_IOERR;
  34032. }
  34033. }
  34034. #else
  34035. UNUSED_PARAMETER(pError);
  34036. #endif
  34037. #ifdef SQLITE_TEST
  34038. /* simulate multiple hosts by creating unique hostid file paths */
  34039. if( sqlite3_hostid_num != 0){
  34040. pHostID[0] = (char)(pHostID[0] + (char)(sqlite3_hostid_num & 0xFF));
  34041. }
  34042. #endif
  34043. return SQLITE_OK;
  34044. }
  34045. /* The conch file contains the header, host id and lock file path
  34046. */
  34047. #define PROXY_CONCHVERSION 2 /* 1-byte header, 16-byte host id, path */
  34048. #define PROXY_HEADERLEN 1 /* conch file header length */
  34049. #define PROXY_PATHINDEX (PROXY_HEADERLEN+PROXY_HOSTIDLEN)
  34050. #define PROXY_MAXCONCHLEN (PROXY_HEADERLEN+PROXY_HOSTIDLEN+MAXPATHLEN)
  34051. /*
  34052. ** Takes an open conch file, copies the contents to a new path and then moves
  34053. ** it back. The newly created file's file descriptor is assigned to the
  34054. ** conch file structure and finally the original conch file descriptor is
  34055. ** closed. Returns zero if successful.
  34056. */
  34057. static int proxyBreakConchLock(unixFile *pFile, uuid_t myHostID){
  34058. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34059. unixFile *conchFile = pCtx->conchFile;
  34060. char tPath[MAXPATHLEN];
  34061. char buf[PROXY_MAXCONCHLEN];
  34062. char *cPath = pCtx->conchFilePath;
  34063. size_t readLen = 0;
  34064. size_t pathLen = 0;
  34065. char errmsg[64] = "";
  34066. int fd = -1;
  34067. int rc = -1;
  34068. UNUSED_PARAMETER(myHostID);
  34069. /* create a new path by replace the trailing '-conch' with '-break' */
  34070. pathLen = strlcpy(tPath, cPath, MAXPATHLEN);
  34071. if( pathLen>MAXPATHLEN || pathLen<6 ||
  34072. (strlcpy(&tPath[pathLen-5], "break", 6) != 5) ){
  34073. sqlite3_snprintf(sizeof(errmsg),errmsg,"path error (len %d)",(int)pathLen);
  34074. goto end_breaklock;
  34075. }
  34076. /* read the conch content */
  34077. readLen = osPread(conchFile->h, buf, PROXY_MAXCONCHLEN, 0);
  34078. if( readLen<PROXY_PATHINDEX ){
  34079. sqlite3_snprintf(sizeof(errmsg),errmsg,"read error (len %d)",(int)readLen);
  34080. goto end_breaklock;
  34081. }
  34082. /* write it out to the temporary break file */
  34083. fd = robust_open(tPath, (O_RDWR|O_CREAT|O_EXCL), 0);
  34084. if( fd<0 ){
  34085. sqlite3_snprintf(sizeof(errmsg), errmsg, "create failed (%d)", errno);
  34086. goto end_breaklock;
  34087. }
  34088. if( osPwrite(fd, buf, readLen, 0) != (ssize_t)readLen ){
  34089. sqlite3_snprintf(sizeof(errmsg), errmsg, "write failed (%d)", errno);
  34090. goto end_breaklock;
  34091. }
  34092. if( rename(tPath, cPath) ){
  34093. sqlite3_snprintf(sizeof(errmsg), errmsg, "rename failed (%d)", errno);
  34094. goto end_breaklock;
  34095. }
  34096. rc = 0;
  34097. fprintf(stderr, "broke stale lock on %s\n", cPath);
  34098. robust_close(pFile, conchFile->h, __LINE__);
  34099. conchFile->h = fd;
  34100. conchFile->openFlags = O_RDWR | O_CREAT;
  34101. end_breaklock:
  34102. if( rc ){
  34103. if( fd>=0 ){
  34104. osUnlink(tPath);
  34105. robust_close(pFile, fd, __LINE__);
  34106. }
  34107. fprintf(stderr, "failed to break stale lock on %s, %s\n", cPath, errmsg);
  34108. }
  34109. return rc;
  34110. }
  34111. /* Take the requested lock on the conch file and break a stale lock if the
  34112. ** host id matches.
  34113. */
  34114. static int proxyConchLock(unixFile *pFile, uuid_t myHostID, int lockType){
  34115. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34116. unixFile *conchFile = pCtx->conchFile;
  34117. int rc = SQLITE_OK;
  34118. int nTries = 0;
  34119. struct timespec conchModTime;
  34120. memset(&conchModTime, 0, sizeof(conchModTime));
  34121. do {
  34122. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, lockType);
  34123. nTries ++;
  34124. if( rc==SQLITE_BUSY ){
  34125. /* If the lock failed (busy):
  34126. * 1st try: get the mod time of the conch, wait 0.5s and try again.
  34127. * 2nd try: fail if the mod time changed or host id is different, wait
  34128. * 10 sec and try again
  34129. * 3rd try: break the lock unless the mod time has changed.
  34130. */
  34131. struct stat buf;
  34132. if( osFstat(conchFile->h, &buf) ){
  34133. storeLastErrno(pFile, errno);
  34134. return SQLITE_IOERR_LOCK;
  34135. }
  34136. if( nTries==1 ){
  34137. conchModTime = buf.st_mtimespec;
  34138. usleep(500000); /* wait 0.5 sec and try the lock again*/
  34139. continue;
  34140. }
  34141. assert( nTries>1 );
  34142. if( conchModTime.tv_sec != buf.st_mtimespec.tv_sec ||
  34143. conchModTime.tv_nsec != buf.st_mtimespec.tv_nsec ){
  34144. return SQLITE_BUSY;
  34145. }
  34146. if( nTries==2 ){
  34147. char tBuf[PROXY_MAXCONCHLEN];
  34148. int len = osPread(conchFile->h, tBuf, PROXY_MAXCONCHLEN, 0);
  34149. if( len<0 ){
  34150. storeLastErrno(pFile, errno);
  34151. return SQLITE_IOERR_LOCK;
  34152. }
  34153. if( len>PROXY_PATHINDEX && tBuf[0]==(char)PROXY_CONCHVERSION){
  34154. /* don't break the lock if the host id doesn't match */
  34155. if( 0!=memcmp(&tBuf[PROXY_HEADERLEN], myHostID, PROXY_HOSTIDLEN) ){
  34156. return SQLITE_BUSY;
  34157. }
  34158. }else{
  34159. /* don't break the lock on short read or a version mismatch */
  34160. return SQLITE_BUSY;
  34161. }
  34162. usleep(10000000); /* wait 10 sec and try the lock again */
  34163. continue;
  34164. }
  34165. assert( nTries==3 );
  34166. if( 0==proxyBreakConchLock(pFile, myHostID) ){
  34167. rc = SQLITE_OK;
  34168. if( lockType==EXCLUSIVE_LOCK ){
  34169. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, SHARED_LOCK);
  34170. }
  34171. if( !rc ){
  34172. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, lockType);
  34173. }
  34174. }
  34175. }
  34176. } while( rc==SQLITE_BUSY && nTries<3 );
  34177. return rc;
  34178. }
  34179. /* Takes the conch by taking a shared lock and read the contents conch, if
  34180. ** lockPath is non-NULL, the host ID and lock file path must match. A NULL
  34181. ** lockPath means that the lockPath in the conch file will be used if the
  34182. ** host IDs match, or a new lock path will be generated automatically
  34183. ** and written to the conch file.
  34184. */
  34185. static int proxyTakeConch(unixFile *pFile){
  34186. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34187. if( pCtx->conchHeld!=0 ){
  34188. return SQLITE_OK;
  34189. }else{
  34190. unixFile *conchFile = pCtx->conchFile;
  34191. uuid_t myHostID;
  34192. int pError = 0;
  34193. char readBuf[PROXY_MAXCONCHLEN];
  34194. char lockPath[MAXPATHLEN];
  34195. char *tempLockPath = NULL;
  34196. int rc = SQLITE_OK;
  34197. int createConch = 0;
  34198. int hostIdMatch = 0;
  34199. int readLen = 0;
  34200. int tryOldLockPath = 0;
  34201. int forceNewLockPath = 0;
  34202. OSTRACE(("TAKECONCH %d for %s pid=%d\n", conchFile->h,
  34203. (pCtx->lockProxyPath ? pCtx->lockProxyPath : ":auto:"),
  34204. osGetpid(0)));
  34205. rc = proxyGetHostID(myHostID, &pError);
  34206. if( (rc&0xff)==SQLITE_IOERR ){
  34207. storeLastErrno(pFile, pError);
  34208. goto end_takeconch;
  34209. }
  34210. rc = proxyConchLock(pFile, myHostID, SHARED_LOCK);
  34211. if( rc!=SQLITE_OK ){
  34212. goto end_takeconch;
  34213. }
  34214. /* read the existing conch file */
  34215. readLen = seekAndRead((unixFile*)conchFile, 0, readBuf, PROXY_MAXCONCHLEN);
  34216. if( readLen<0 ){
  34217. /* I/O error: lastErrno set by seekAndRead */
  34218. storeLastErrno(pFile, conchFile->lastErrno);
  34219. rc = SQLITE_IOERR_READ;
  34220. goto end_takeconch;
  34221. }else if( readLen<=(PROXY_HEADERLEN+PROXY_HOSTIDLEN) ||
  34222. readBuf[0]!=(char)PROXY_CONCHVERSION ){
  34223. /* a short read or version format mismatch means we need to create a new
  34224. ** conch file.
  34225. */
  34226. createConch = 1;
  34227. }
  34228. /* if the host id matches and the lock path already exists in the conch
  34229. ** we'll try to use the path there, if we can't open that path, we'll
  34230. ** retry with a new auto-generated path
  34231. */
  34232. do { /* in case we need to try again for an :auto: named lock file */
  34233. if( !createConch && !forceNewLockPath ){
  34234. hostIdMatch = !memcmp(&readBuf[PROXY_HEADERLEN], myHostID,
  34235. PROXY_HOSTIDLEN);
  34236. /* if the conch has data compare the contents */
  34237. if( !pCtx->lockProxyPath ){
  34238. /* for auto-named local lock file, just check the host ID and we'll
  34239. ** use the local lock file path that's already in there
  34240. */
  34241. if( hostIdMatch ){
  34242. size_t pathLen = (readLen - PROXY_PATHINDEX);
  34243. if( pathLen>=MAXPATHLEN ){
  34244. pathLen=MAXPATHLEN-1;
  34245. }
  34246. memcpy(lockPath, &readBuf[PROXY_PATHINDEX], pathLen);
  34247. lockPath[pathLen] = 0;
  34248. tempLockPath = lockPath;
  34249. tryOldLockPath = 1;
  34250. /* create a copy of the lock path if the conch is taken */
  34251. goto end_takeconch;
  34252. }
  34253. }else if( hostIdMatch
  34254. && !strncmp(pCtx->lockProxyPath, &readBuf[PROXY_PATHINDEX],
  34255. readLen-PROXY_PATHINDEX)
  34256. ){
  34257. /* conch host and lock path match */
  34258. goto end_takeconch;
  34259. }
  34260. }
  34261. /* if the conch isn't writable and doesn't match, we can't take it */
  34262. if( (conchFile->openFlags&O_RDWR) == 0 ){
  34263. rc = SQLITE_BUSY;
  34264. goto end_takeconch;
  34265. }
  34266. /* either the conch didn't match or we need to create a new one */
  34267. if( !pCtx->lockProxyPath ){
  34268. proxyGetLockPath(pCtx->dbPath, lockPath, MAXPATHLEN);
  34269. tempLockPath = lockPath;
  34270. /* create a copy of the lock path _only_ if the conch is taken */
  34271. }
  34272. /* update conch with host and path (this will fail if other process
  34273. ** has a shared lock already), if the host id matches, use the big
  34274. ** stick.
  34275. */
  34276. futimes(conchFile->h, NULL);
  34277. if( hostIdMatch && !createConch ){
  34278. if( conchFile->pInode && conchFile->pInode->nShared>1 ){
  34279. /* We are trying for an exclusive lock but another thread in this
  34280. ** same process is still holding a shared lock. */
  34281. rc = SQLITE_BUSY;
  34282. } else {
  34283. rc = proxyConchLock(pFile, myHostID, EXCLUSIVE_LOCK);
  34284. }
  34285. }else{
  34286. rc = proxyConchLock(pFile, myHostID, EXCLUSIVE_LOCK);
  34287. }
  34288. if( rc==SQLITE_OK ){
  34289. char writeBuffer[PROXY_MAXCONCHLEN];
  34290. int writeSize = 0;
  34291. writeBuffer[0] = (char)PROXY_CONCHVERSION;
  34292. memcpy(&writeBuffer[PROXY_HEADERLEN], myHostID, PROXY_HOSTIDLEN);
  34293. if( pCtx->lockProxyPath!=NULL ){
  34294. strlcpy(&writeBuffer[PROXY_PATHINDEX], pCtx->lockProxyPath,
  34295. MAXPATHLEN);
  34296. }else{
  34297. strlcpy(&writeBuffer[PROXY_PATHINDEX], tempLockPath, MAXPATHLEN);
  34298. }
  34299. writeSize = PROXY_PATHINDEX + strlen(&writeBuffer[PROXY_PATHINDEX]);
  34300. robust_ftruncate(conchFile->h, writeSize);
  34301. rc = unixWrite((sqlite3_file *)conchFile, writeBuffer, writeSize, 0);
  34302. full_fsync(conchFile->h,0,0);
  34303. /* If we created a new conch file (not just updated the contents of a
  34304. ** valid conch file), try to match the permissions of the database
  34305. */
  34306. if( rc==SQLITE_OK && createConch ){
  34307. struct stat buf;
  34308. int err = osFstat(pFile->h, &buf);
  34309. if( err==0 ){
  34310. mode_t cmode = buf.st_mode&(S_IRUSR|S_IWUSR | S_IRGRP|S_IWGRP |
  34311. S_IROTH|S_IWOTH);
  34312. /* try to match the database file R/W permissions, ignore failure */
  34313. #ifndef SQLITE_PROXY_DEBUG
  34314. osFchmod(conchFile->h, cmode);
  34315. #else
  34316. do{
  34317. rc = osFchmod(conchFile->h, cmode);
  34318. }while( rc==(-1) && errno==EINTR );
  34319. if( rc!=0 ){
  34320. int code = errno;
  34321. fprintf(stderr, "fchmod %o FAILED with %d %s\n",
  34322. cmode, code, strerror(code));
  34323. } else {
  34324. fprintf(stderr, "fchmod %o SUCCEDED\n",cmode);
  34325. }
  34326. }else{
  34327. int code = errno;
  34328. fprintf(stderr, "STAT FAILED[%d] with %d %s\n",
  34329. err, code, strerror(code));
  34330. #endif
  34331. }
  34332. }
  34333. }
  34334. conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, SHARED_LOCK);
  34335. end_takeconch:
  34336. OSTRACE(("TRANSPROXY: CLOSE %d\n", pFile->h));
  34337. if( rc==SQLITE_OK && pFile->openFlags ){
  34338. int fd;
  34339. if( pFile->h>=0 ){
  34340. robust_close(pFile, pFile->h, __LINE__);
  34341. }
  34342. pFile->h = -1;
  34343. fd = robust_open(pCtx->dbPath, pFile->openFlags, 0);
  34344. OSTRACE(("TRANSPROXY: OPEN %d\n", fd));
  34345. if( fd>=0 ){
  34346. pFile->h = fd;
  34347. }else{
  34348. rc=SQLITE_CANTOPEN_BKPT; /* SQLITE_BUSY? proxyTakeConch called
  34349. during locking */
  34350. }
  34351. }
  34352. if( rc==SQLITE_OK && !pCtx->lockProxy ){
  34353. char *path = tempLockPath ? tempLockPath : pCtx->lockProxyPath;
  34354. rc = proxyCreateUnixFile(path, &pCtx->lockProxy, 1);
  34355. if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && tryOldLockPath ){
  34356. /* we couldn't create the proxy lock file with the old lock file path
  34357. ** so try again via auto-naming
  34358. */
  34359. forceNewLockPath = 1;
  34360. tryOldLockPath = 0;
  34361. continue; /* go back to the do {} while start point, try again */
  34362. }
  34363. }
  34364. if( rc==SQLITE_OK ){
  34365. /* Need to make a copy of path if we extracted the value
  34366. ** from the conch file or the path was allocated on the stack
  34367. */
  34368. if( tempLockPath ){
  34369. pCtx->lockProxyPath = sqlite3DbStrDup(0, tempLockPath);
  34370. if( !pCtx->lockProxyPath ){
  34371. rc = SQLITE_NOMEM_BKPT;
  34372. }
  34373. }
  34374. }
  34375. if( rc==SQLITE_OK ){
  34376. pCtx->conchHeld = 1;
  34377. if( pCtx->lockProxy->pMethod == &afpIoMethods ){
  34378. afpLockingContext *afpCtx;
  34379. afpCtx = (afpLockingContext *)pCtx->lockProxy->lockingContext;
  34380. afpCtx->dbPath = pCtx->lockProxyPath;
  34381. }
  34382. } else {
  34383. conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, NO_LOCK);
  34384. }
  34385. OSTRACE(("TAKECONCH %d %s\n", conchFile->h,
  34386. rc==SQLITE_OK?"ok":"failed"));
  34387. return rc;
  34388. } while (1); /* in case we need to retry the :auto: lock file -
  34389. ** we should never get here except via the 'continue' call. */
  34390. }
  34391. }
  34392. /*
  34393. ** If pFile holds a lock on a conch file, then release that lock.
  34394. */
  34395. static int proxyReleaseConch(unixFile *pFile){
  34396. int rc = SQLITE_OK; /* Subroutine return code */
  34397. proxyLockingContext *pCtx; /* The locking context for the proxy lock */
  34398. unixFile *conchFile; /* Name of the conch file */
  34399. pCtx = (proxyLockingContext *)pFile->lockingContext;
  34400. conchFile = pCtx->conchFile;
  34401. OSTRACE(("RELEASECONCH %d for %s pid=%d\n", conchFile->h,
  34402. (pCtx->lockProxyPath ? pCtx->lockProxyPath : ":auto:"),
  34403. osGetpid(0)));
  34404. if( pCtx->conchHeld>0 ){
  34405. rc = conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, NO_LOCK);
  34406. }
  34407. pCtx->conchHeld = 0;
  34408. OSTRACE(("RELEASECONCH %d %s\n", conchFile->h,
  34409. (rc==SQLITE_OK ? "ok" : "failed")));
  34410. return rc;
  34411. }
  34412. /*
  34413. ** Given the name of a database file, compute the name of its conch file.
  34414. ** Store the conch filename in memory obtained from sqlite3_malloc64().
  34415. ** Make *pConchPath point to the new name. Return SQLITE_OK on success
  34416. ** or SQLITE_NOMEM if unable to obtain memory.
  34417. **
  34418. ** The caller is responsible for ensuring that the allocated memory
  34419. ** space is eventually freed.
  34420. **
  34421. ** *pConchPath is set to NULL if a memory allocation error occurs.
  34422. */
  34423. static int proxyCreateConchPathname(char *dbPath, char **pConchPath){
  34424. int i; /* Loop counter */
  34425. int len = (int)strlen(dbPath); /* Length of database filename - dbPath */
  34426. char *conchPath; /* buffer in which to construct conch name */
  34427. /* Allocate space for the conch filename and initialize the name to
  34428. ** the name of the original database file. */
  34429. *pConchPath = conchPath = (char *)sqlite3_malloc64(len + 8);
  34430. if( conchPath==0 ){
  34431. return SQLITE_NOMEM_BKPT;
  34432. }
  34433. memcpy(conchPath, dbPath, len+1);
  34434. /* now insert a "." before the last / character */
  34435. for( i=(len-1); i>=0; i-- ){
  34436. if( conchPath[i]=='/' ){
  34437. i++;
  34438. break;
  34439. }
  34440. }
  34441. conchPath[i]='.';
  34442. while ( i<len ){
  34443. conchPath[i+1]=dbPath[i];
  34444. i++;
  34445. }
  34446. /* append the "-conch" suffix to the file */
  34447. memcpy(&conchPath[i+1], "-conch", 7);
  34448. assert( (int)strlen(conchPath) == len+7 );
  34449. return SQLITE_OK;
  34450. }
  34451. /* Takes a fully configured proxy locking-style unix file and switches
  34452. ** the local lock file path
  34453. */
  34454. static int switchLockProxyPath(unixFile *pFile, const char *path) {
  34455. proxyLockingContext *pCtx = (proxyLockingContext*)pFile->lockingContext;
  34456. char *oldPath = pCtx->lockProxyPath;
  34457. int rc = SQLITE_OK;
  34458. if( pFile->eFileLock!=NO_LOCK ){
  34459. return SQLITE_BUSY;
  34460. }
  34461. /* nothing to do if the path is NULL, :auto: or matches the existing path */
  34462. if( !path || path[0]=='\0' || !strcmp(path, ":auto:") ||
  34463. (oldPath && !strncmp(oldPath, path, MAXPATHLEN)) ){
  34464. return SQLITE_OK;
  34465. }else{
  34466. unixFile *lockProxy = pCtx->lockProxy;
  34467. pCtx->lockProxy=NULL;
  34468. pCtx->conchHeld = 0;
  34469. if( lockProxy!=NULL ){
  34470. rc=lockProxy->pMethod->xClose((sqlite3_file *)lockProxy);
  34471. if( rc ) return rc;
  34472. sqlite3_free(lockProxy);
  34473. }
  34474. sqlite3_free(oldPath);
  34475. pCtx->lockProxyPath = sqlite3DbStrDup(0, path);
  34476. }
  34477. return rc;
  34478. }
  34479. /*
  34480. ** pFile is a file that has been opened by a prior xOpen call. dbPath
  34481. ** is a string buffer at least MAXPATHLEN+1 characters in size.
  34482. **
  34483. ** This routine find the filename associated with pFile and writes it
  34484. ** int dbPath.
  34485. */
  34486. static int proxyGetDbPathForUnixFile(unixFile *pFile, char *dbPath){
  34487. #if defined(__APPLE__)
  34488. if( pFile->pMethod == &afpIoMethods ){
  34489. /* afp style keeps a reference to the db path in the filePath field
  34490. ** of the struct */
  34491. assert( (int)strlen((char*)pFile->lockingContext)<=MAXPATHLEN );
  34492. strlcpy(dbPath, ((afpLockingContext *)pFile->lockingContext)->dbPath,
  34493. MAXPATHLEN);
  34494. } else
  34495. #endif
  34496. if( pFile->pMethod == &dotlockIoMethods ){
  34497. /* dot lock style uses the locking context to store the dot lock
  34498. ** file path */
  34499. int len = strlen((char *)pFile->lockingContext) - strlen(DOTLOCK_SUFFIX);
  34500. memcpy(dbPath, (char *)pFile->lockingContext, len + 1);
  34501. }else{
  34502. /* all other styles use the locking context to store the db file path */
  34503. assert( strlen((char*)pFile->lockingContext)<=MAXPATHLEN );
  34504. strlcpy(dbPath, (char *)pFile->lockingContext, MAXPATHLEN);
  34505. }
  34506. return SQLITE_OK;
  34507. }
  34508. /*
  34509. ** Takes an already filled in unix file and alters it so all file locking
  34510. ** will be performed on the local proxy lock file. The following fields
  34511. ** are preserved in the locking context so that they can be restored and
  34512. ** the unix structure properly cleaned up at close time:
  34513. ** ->lockingContext
  34514. ** ->pMethod
  34515. */
  34516. static int proxyTransformUnixFile(unixFile *pFile, const char *path) {
  34517. proxyLockingContext *pCtx;
  34518. char dbPath[MAXPATHLEN+1]; /* Name of the database file */
  34519. char *lockPath=NULL;
  34520. int rc = SQLITE_OK;
  34521. if( pFile->eFileLock!=NO_LOCK ){
  34522. return SQLITE_BUSY;
  34523. }
  34524. proxyGetDbPathForUnixFile(pFile, dbPath);
  34525. if( !path || path[0]=='\0' || !strcmp(path, ":auto:") ){
  34526. lockPath=NULL;
  34527. }else{
  34528. lockPath=(char *)path;
  34529. }
  34530. OSTRACE(("TRANSPROXY %d for %s pid=%d\n", pFile->h,
  34531. (lockPath ? lockPath : ":auto:"), osGetpid(0)));
  34532. pCtx = sqlite3_malloc64( sizeof(*pCtx) );
  34533. if( pCtx==0 ){
  34534. return SQLITE_NOMEM_BKPT;
  34535. }
  34536. memset(pCtx, 0, sizeof(*pCtx));
  34537. rc = proxyCreateConchPathname(dbPath, &pCtx->conchFilePath);
  34538. if( rc==SQLITE_OK ){
  34539. rc = proxyCreateUnixFile(pCtx->conchFilePath, &pCtx->conchFile, 0);
  34540. if( rc==SQLITE_CANTOPEN && ((pFile->openFlags&O_RDWR) == 0) ){
  34541. /* if (a) the open flags are not O_RDWR, (b) the conch isn't there, and
  34542. ** (c) the file system is read-only, then enable no-locking access.
  34543. ** Ugh, since O_RDONLY==0x0000 we test for !O_RDWR since unixOpen asserts
  34544. ** that openFlags will have only one of O_RDONLY or O_RDWR.
  34545. */
  34546. struct statfs fsInfo;
  34547. struct stat conchInfo;
  34548. int goLockless = 0;
  34549. if( osStat(pCtx->conchFilePath, &conchInfo) == -1 ) {
  34550. int err = errno;
  34551. if( (err==ENOENT) && (statfs(dbPath, &fsInfo) != -1) ){
  34552. goLockless = (fsInfo.f_flags&MNT_RDONLY) == MNT_RDONLY;
  34553. }
  34554. }
  34555. if( goLockless ){
  34556. pCtx->conchHeld = -1; /* read only FS/ lockless */
  34557. rc = SQLITE_OK;
  34558. }
  34559. }
  34560. }
  34561. if( rc==SQLITE_OK && lockPath ){
  34562. pCtx->lockProxyPath = sqlite3DbStrDup(0, lockPath);
  34563. }
  34564. if( rc==SQLITE_OK ){
  34565. pCtx->dbPath = sqlite3DbStrDup(0, dbPath);
  34566. if( pCtx->dbPath==NULL ){
  34567. rc = SQLITE_NOMEM_BKPT;
  34568. }
  34569. }
  34570. if( rc==SQLITE_OK ){
  34571. /* all memory is allocated, proxys are created and assigned,
  34572. ** switch the locking context and pMethod then return.
  34573. */
  34574. pCtx->oldLockingContext = pFile->lockingContext;
  34575. pFile->lockingContext = pCtx;
  34576. pCtx->pOldMethod = pFile->pMethod;
  34577. pFile->pMethod = &proxyIoMethods;
  34578. }else{
  34579. if( pCtx->conchFile ){
  34580. pCtx->conchFile->pMethod->xClose((sqlite3_file *)pCtx->conchFile);
  34581. sqlite3_free(pCtx->conchFile);
  34582. }
  34583. sqlite3DbFree(0, pCtx->lockProxyPath);
  34584. sqlite3_free(pCtx->conchFilePath);
  34585. sqlite3_free(pCtx);
  34586. }
  34587. OSTRACE(("TRANSPROXY %d %s\n", pFile->h,
  34588. (rc==SQLITE_OK ? "ok" : "failed")));
  34589. return rc;
  34590. }
  34591. /*
  34592. ** This routine handles sqlite3_file_control() calls that are specific
  34593. ** to proxy locking.
  34594. */
  34595. static int proxyFileControl(sqlite3_file *id, int op, void *pArg){
  34596. switch( op ){
  34597. case SQLITE_FCNTL_GET_LOCKPROXYFILE: {
  34598. unixFile *pFile = (unixFile*)id;
  34599. if( pFile->pMethod == &proxyIoMethods ){
  34600. proxyLockingContext *pCtx = (proxyLockingContext*)pFile->lockingContext;
  34601. proxyTakeConch(pFile);
  34602. if( pCtx->lockProxyPath ){
  34603. *(const char **)pArg = pCtx->lockProxyPath;
  34604. }else{
  34605. *(const char **)pArg = ":auto: (not held)";
  34606. }
  34607. } else {
  34608. *(const char **)pArg = NULL;
  34609. }
  34610. return SQLITE_OK;
  34611. }
  34612. case SQLITE_FCNTL_SET_LOCKPROXYFILE: {
  34613. unixFile *pFile = (unixFile*)id;
  34614. int rc = SQLITE_OK;
  34615. int isProxyStyle = (pFile->pMethod == &proxyIoMethods);
  34616. if( pArg==NULL || (const char *)pArg==0 ){
  34617. if( isProxyStyle ){
  34618. /* turn off proxy locking - not supported. If support is added for
  34619. ** switching proxy locking mode off then it will need to fail if
  34620. ** the journal mode is WAL mode.
  34621. */
  34622. rc = SQLITE_ERROR /*SQLITE_PROTOCOL? SQLITE_MISUSE?*/;
  34623. }else{
  34624. /* turn off proxy locking - already off - NOOP */
  34625. rc = SQLITE_OK;
  34626. }
  34627. }else{
  34628. const char *proxyPath = (const char *)pArg;
  34629. if( isProxyStyle ){
  34630. proxyLockingContext *pCtx =
  34631. (proxyLockingContext*)pFile->lockingContext;
  34632. if( !strcmp(pArg, ":auto:")
  34633. || (pCtx->lockProxyPath &&
  34634. !strncmp(pCtx->lockProxyPath, proxyPath, MAXPATHLEN))
  34635. ){
  34636. rc = SQLITE_OK;
  34637. }else{
  34638. rc = switchLockProxyPath(pFile, proxyPath);
  34639. }
  34640. }else{
  34641. /* turn on proxy file locking */
  34642. rc = proxyTransformUnixFile(pFile, proxyPath);
  34643. }
  34644. }
  34645. return rc;
  34646. }
  34647. default: {
  34648. assert( 0 ); /* The call assures that only valid opcodes are sent */
  34649. }
  34650. }
  34651. /*NOTREACHED*/
  34652. return SQLITE_ERROR;
  34653. }
  34654. /*
  34655. ** Within this division (the proxying locking implementation) the procedures
  34656. ** above this point are all utilities. The lock-related methods of the
  34657. ** proxy-locking sqlite3_io_method object follow.
  34658. */
  34659. /*
  34660. ** This routine checks if there is a RESERVED lock held on the specified
  34661. ** file by this or any other process. If such a lock is held, set *pResOut
  34662. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  34663. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  34664. */
  34665. static int proxyCheckReservedLock(sqlite3_file *id, int *pResOut) {
  34666. unixFile *pFile = (unixFile*)id;
  34667. int rc = proxyTakeConch(pFile);
  34668. if( rc==SQLITE_OK ){
  34669. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34670. if( pCtx->conchHeld>0 ){
  34671. unixFile *proxy = pCtx->lockProxy;
  34672. return proxy->pMethod->xCheckReservedLock((sqlite3_file*)proxy, pResOut);
  34673. }else{ /* conchHeld < 0 is lockless */
  34674. pResOut=0;
  34675. }
  34676. }
  34677. return rc;
  34678. }
  34679. /*
  34680. ** Lock the file with the lock specified by parameter eFileLock - one
  34681. ** of the following:
  34682. **
  34683. ** (1) SHARED_LOCK
  34684. ** (2) RESERVED_LOCK
  34685. ** (3) PENDING_LOCK
  34686. ** (4) EXCLUSIVE_LOCK
  34687. **
  34688. ** Sometimes when requesting one lock state, additional lock states
  34689. ** are inserted in between. The locking might fail on one of the later
  34690. ** transitions leaving the lock state different from what it started but
  34691. ** still short of its goal. The following chart shows the allowed
  34692. ** transitions and the inserted intermediate states:
  34693. **
  34694. ** UNLOCKED -> SHARED
  34695. ** SHARED -> RESERVED
  34696. ** SHARED -> (PENDING) -> EXCLUSIVE
  34697. ** RESERVED -> (PENDING) -> EXCLUSIVE
  34698. ** PENDING -> EXCLUSIVE
  34699. **
  34700. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  34701. ** routine to lower a locking level.
  34702. */
  34703. static int proxyLock(sqlite3_file *id, int eFileLock) {
  34704. unixFile *pFile = (unixFile*)id;
  34705. int rc = proxyTakeConch(pFile);
  34706. if( rc==SQLITE_OK ){
  34707. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34708. if( pCtx->conchHeld>0 ){
  34709. unixFile *proxy = pCtx->lockProxy;
  34710. rc = proxy->pMethod->xLock((sqlite3_file*)proxy, eFileLock);
  34711. pFile->eFileLock = proxy->eFileLock;
  34712. }else{
  34713. /* conchHeld < 0 is lockless */
  34714. }
  34715. }
  34716. return rc;
  34717. }
  34718. /*
  34719. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  34720. ** must be either NO_LOCK or SHARED_LOCK.
  34721. **
  34722. ** If the locking level of the file descriptor is already at or below
  34723. ** the requested locking level, this routine is a no-op.
  34724. */
  34725. static int proxyUnlock(sqlite3_file *id, int eFileLock) {
  34726. unixFile *pFile = (unixFile*)id;
  34727. int rc = proxyTakeConch(pFile);
  34728. if( rc==SQLITE_OK ){
  34729. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34730. if( pCtx->conchHeld>0 ){
  34731. unixFile *proxy = pCtx->lockProxy;
  34732. rc = proxy->pMethod->xUnlock((sqlite3_file*)proxy, eFileLock);
  34733. pFile->eFileLock = proxy->eFileLock;
  34734. }else{
  34735. /* conchHeld < 0 is lockless */
  34736. }
  34737. }
  34738. return rc;
  34739. }
  34740. /*
  34741. ** Close a file that uses proxy locks.
  34742. */
  34743. static int proxyClose(sqlite3_file *id) {
  34744. if( ALWAYS(id) ){
  34745. unixFile *pFile = (unixFile*)id;
  34746. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  34747. unixFile *lockProxy = pCtx->lockProxy;
  34748. unixFile *conchFile = pCtx->conchFile;
  34749. int rc = SQLITE_OK;
  34750. if( lockProxy ){
  34751. rc = lockProxy->pMethod->xUnlock((sqlite3_file*)lockProxy, NO_LOCK);
  34752. if( rc ) return rc;
  34753. rc = lockProxy->pMethod->xClose((sqlite3_file*)lockProxy);
  34754. if( rc ) return rc;
  34755. sqlite3_free(lockProxy);
  34756. pCtx->lockProxy = 0;
  34757. }
  34758. if( conchFile ){
  34759. if( pCtx->conchHeld ){
  34760. rc = proxyReleaseConch(pFile);
  34761. if( rc ) return rc;
  34762. }
  34763. rc = conchFile->pMethod->xClose((sqlite3_file*)conchFile);
  34764. if( rc ) return rc;
  34765. sqlite3_free(conchFile);
  34766. }
  34767. sqlite3DbFree(0, pCtx->lockProxyPath);
  34768. sqlite3_free(pCtx->conchFilePath);
  34769. sqlite3DbFree(0, pCtx->dbPath);
  34770. /* restore the original locking context and pMethod then close it */
  34771. pFile->lockingContext = pCtx->oldLockingContext;
  34772. pFile->pMethod = pCtx->pOldMethod;
  34773. sqlite3_free(pCtx);
  34774. return pFile->pMethod->xClose(id);
  34775. }
  34776. return SQLITE_OK;
  34777. }
  34778. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  34779. /*
  34780. ** The proxy locking style is intended for use with AFP filesystems.
  34781. ** And since AFP is only supported on MacOSX, the proxy locking is also
  34782. ** restricted to MacOSX.
  34783. **
  34784. **
  34785. ******************* End of the proxy lock implementation **********************
  34786. ******************************************************************************/
  34787. /*
  34788. ** Initialize the operating system interface.
  34789. **
  34790. ** This routine registers all VFS implementations for unix-like operating
  34791. ** systems. This routine, and the sqlite3_os_end() routine that follows,
  34792. ** should be the only routines in this file that are visible from other
  34793. ** files.
  34794. **
  34795. ** This routine is called once during SQLite initialization and by a
  34796. ** single thread. The memory allocation and mutex subsystems have not
  34797. ** necessarily been initialized when this routine is called, and so they
  34798. ** should not be used.
  34799. */
  34800. SQLITE_API int sqlite3_os_init(void){
  34801. /*
  34802. ** The following macro defines an initializer for an sqlite3_vfs object.
  34803. ** The name of the VFS is NAME. The pAppData is a pointer to a pointer
  34804. ** to the "finder" function. (pAppData is a pointer to a pointer because
  34805. ** silly C90 rules prohibit a void* from being cast to a function pointer
  34806. ** and so we have to go through the intermediate pointer to avoid problems
  34807. ** when compiling with -pedantic-errors on GCC.)
  34808. **
  34809. ** The FINDER parameter to this macro is the name of the pointer to the
  34810. ** finder-function. The finder-function returns a pointer to the
  34811. ** sqlite_io_methods object that implements the desired locking
  34812. ** behaviors. See the division above that contains the IOMETHODS
  34813. ** macro for addition information on finder-functions.
  34814. **
  34815. ** Most finders simply return a pointer to a fixed sqlite3_io_methods
  34816. ** object. But the "autolockIoFinder" available on MacOSX does a little
  34817. ** more than that; it looks at the filesystem type that hosts the
  34818. ** database file and tries to choose an locking method appropriate for
  34819. ** that filesystem time.
  34820. */
  34821. #define UNIXVFS(VFSNAME, FINDER) { \
  34822. 3, /* iVersion */ \
  34823. sizeof(unixFile), /* szOsFile */ \
  34824. MAX_PATHNAME, /* mxPathname */ \
  34825. 0, /* pNext */ \
  34826. VFSNAME, /* zName */ \
  34827. (void*)&FINDER, /* pAppData */ \
  34828. unixOpen, /* xOpen */ \
  34829. unixDelete, /* xDelete */ \
  34830. unixAccess, /* xAccess */ \
  34831. unixFullPathname, /* xFullPathname */ \
  34832. unixDlOpen, /* xDlOpen */ \
  34833. unixDlError, /* xDlError */ \
  34834. unixDlSym, /* xDlSym */ \
  34835. unixDlClose, /* xDlClose */ \
  34836. unixRandomness, /* xRandomness */ \
  34837. unixSleep, /* xSleep */ \
  34838. unixCurrentTime, /* xCurrentTime */ \
  34839. unixGetLastError, /* xGetLastError */ \
  34840. unixCurrentTimeInt64, /* xCurrentTimeInt64 */ \
  34841. unixSetSystemCall, /* xSetSystemCall */ \
  34842. unixGetSystemCall, /* xGetSystemCall */ \
  34843. unixNextSystemCall, /* xNextSystemCall */ \
  34844. }
  34845. /*
  34846. ** All default VFSes for unix are contained in the following array.
  34847. **
  34848. ** Note that the sqlite3_vfs.pNext field of the VFS object is modified
  34849. ** by the SQLite core when the VFS is registered. So the following
  34850. ** array cannot be const.
  34851. */
  34852. static sqlite3_vfs aVfs[] = {
  34853. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  34854. UNIXVFS("unix", autolockIoFinder ),
  34855. #elif OS_VXWORKS
  34856. UNIXVFS("unix", vxworksIoFinder ),
  34857. #else
  34858. UNIXVFS("unix", posixIoFinder ),
  34859. #endif
  34860. UNIXVFS("unix-none", nolockIoFinder ),
  34861. UNIXVFS("unix-dotfile", dotlockIoFinder ),
  34862. UNIXVFS("unix-excl", posixIoFinder ),
  34863. #if OS_VXWORKS
  34864. UNIXVFS("unix-namedsem", semIoFinder ),
  34865. #endif
  34866. #if SQLITE_ENABLE_LOCKING_STYLE || OS_VXWORKS
  34867. UNIXVFS("unix-posix", posixIoFinder ),
  34868. #endif
  34869. #if SQLITE_ENABLE_LOCKING_STYLE
  34870. UNIXVFS("unix-flock", flockIoFinder ),
  34871. #endif
  34872. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  34873. UNIXVFS("unix-afp", afpIoFinder ),
  34874. UNIXVFS("unix-nfs", nfsIoFinder ),
  34875. UNIXVFS("unix-proxy", proxyIoFinder ),
  34876. #endif
  34877. };
  34878. unsigned int i; /* Loop counter */
  34879. /* Double-check that the aSyscall[] array has been constructed
  34880. ** correctly. See ticket [bb3a86e890c8e96ab] */
  34881. assert( ArraySize(aSyscall)==28 );
  34882. /* Register all VFSes defined in the aVfs[] array */
  34883. for(i=0; i<(sizeof(aVfs)/sizeof(sqlite3_vfs)); i++){
  34884. sqlite3_vfs_register(&aVfs[i], i==0);
  34885. }
  34886. return SQLITE_OK;
  34887. }
  34888. /*
  34889. ** Shutdown the operating system interface.
  34890. **
  34891. ** Some operating systems might need to do some cleanup in this routine,
  34892. ** to release dynamically allocated objects. But not on unix.
  34893. ** This routine is a no-op for unix.
  34894. */
  34895. SQLITE_API int sqlite3_os_end(void){
  34896. return SQLITE_OK;
  34897. }
  34898. #endif /* SQLITE_OS_UNIX */
  34899. /************** End of os_unix.c *********************************************/
  34900. /************** Begin file os_win.c ******************************************/
  34901. /*
  34902. ** 2004 May 22
  34903. **
  34904. ** The author disclaims copyright to this source code. In place of
  34905. ** a legal notice, here is a blessing:
  34906. **
  34907. ** May you do good and not evil.
  34908. ** May you find forgiveness for yourself and forgive others.
  34909. ** May you share freely, never taking more than you give.
  34910. **
  34911. ******************************************************************************
  34912. **
  34913. ** This file contains code that is specific to Windows.
  34914. */
  34915. /* #include "sqliteInt.h" */
  34916. #if SQLITE_OS_WIN /* This file is used for Windows only */
  34917. /*
  34918. ** Include code that is common to all os_*.c files
  34919. */
  34920. /************** Include os_common.h in the middle of os_win.c ****************/
  34921. /************** Begin file os_common.h ***************************************/
  34922. /*
  34923. ** 2004 May 22
  34924. **
  34925. ** The author disclaims copyright to this source code. In place of
  34926. ** a legal notice, here is a blessing:
  34927. **
  34928. ** May you do good and not evil.
  34929. ** May you find forgiveness for yourself and forgive others.
  34930. ** May you share freely, never taking more than you give.
  34931. **
  34932. ******************************************************************************
  34933. **
  34934. ** This file contains macros and a little bit of code that is common to
  34935. ** all of the platform-specific files (os_*.c) and is #included into those
  34936. ** files.
  34937. **
  34938. ** This file should be #included by the os_*.c files only. It is not a
  34939. ** general purpose header file.
  34940. */
  34941. #ifndef _OS_COMMON_H_
  34942. #define _OS_COMMON_H_
  34943. /*
  34944. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  34945. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  34946. ** switch. The following code should catch this problem at compile-time.
  34947. */
  34948. #ifdef MEMORY_DEBUG
  34949. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  34950. #endif
  34951. /*
  34952. ** Macros for performance tracing. Normally turned off. Only works
  34953. ** on i486 hardware.
  34954. */
  34955. #ifdef SQLITE_PERFORMANCE_TRACE
  34956. /*
  34957. ** hwtime.h contains inline assembler code for implementing
  34958. ** high-performance timing routines.
  34959. */
  34960. /************** Include hwtime.h in the middle of os_common.h ****************/
  34961. /************** Begin file hwtime.h ******************************************/
  34962. /*
  34963. ** 2008 May 27
  34964. **
  34965. ** The author disclaims copyright to this source code. In place of
  34966. ** a legal notice, here is a blessing:
  34967. **
  34968. ** May you do good and not evil.
  34969. ** May you find forgiveness for yourself and forgive others.
  34970. ** May you share freely, never taking more than you give.
  34971. **
  34972. ******************************************************************************
  34973. **
  34974. ** This file contains inline asm code for retrieving "high-performance"
  34975. ** counters for x86 class CPUs.
  34976. */
  34977. #ifndef SQLITE_HWTIME_H
  34978. #define SQLITE_HWTIME_H
  34979. /*
  34980. ** The following routine only works on pentium-class (or newer) processors.
  34981. ** It uses the RDTSC opcode to read the cycle count value out of the
  34982. ** processor and returns that value. This can be used for high-res
  34983. ** profiling.
  34984. */
  34985. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  34986. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  34987. #if defined(__GNUC__)
  34988. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  34989. unsigned int lo, hi;
  34990. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  34991. return (sqlite_uint64)hi << 32 | lo;
  34992. }
  34993. #elif defined(_MSC_VER)
  34994. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  34995. __asm {
  34996. rdtsc
  34997. ret ; return value at EDX:EAX
  34998. }
  34999. }
  35000. #endif
  35001. #elif (defined(__GNUC__) && defined(__x86_64__))
  35002. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  35003. unsigned long val;
  35004. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  35005. return val;
  35006. }
  35007. #elif (defined(__GNUC__) && defined(__ppc__))
  35008. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  35009. unsigned long long retval;
  35010. unsigned long junk;
  35011. __asm__ __volatile__ ("\n\
  35012. 1: mftbu %1\n\
  35013. mftb %L0\n\
  35014. mftbu %0\n\
  35015. cmpw %0,%1\n\
  35016. bne 1b"
  35017. : "=r" (retval), "=r" (junk));
  35018. return retval;
  35019. }
  35020. #else
  35021. #error Need implementation of sqlite3Hwtime() for your platform.
  35022. /*
  35023. ** To compile without implementing sqlite3Hwtime() for your platform,
  35024. ** you can remove the above #error and use the following
  35025. ** stub function. You will lose timing support for many
  35026. ** of the debugging and testing utilities, but it should at
  35027. ** least compile and run.
  35028. */
  35029. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  35030. #endif
  35031. #endif /* !defined(SQLITE_HWTIME_H) */
  35032. /************** End of hwtime.h **********************************************/
  35033. /************** Continuing where we left off in os_common.h ******************/
  35034. static sqlite_uint64 g_start;
  35035. static sqlite_uint64 g_elapsed;
  35036. #define TIMER_START g_start=sqlite3Hwtime()
  35037. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  35038. #define TIMER_ELAPSED g_elapsed
  35039. #else
  35040. #define TIMER_START
  35041. #define TIMER_END
  35042. #define TIMER_ELAPSED ((sqlite_uint64)0)
  35043. #endif
  35044. /*
  35045. ** If we compile with the SQLITE_TEST macro set, then the following block
  35046. ** of code will give us the ability to simulate a disk I/O error. This
  35047. ** is used for testing the I/O recovery logic.
  35048. */
  35049. #if defined(SQLITE_TEST)
  35050. SQLITE_API extern int sqlite3_io_error_hit;
  35051. SQLITE_API extern int sqlite3_io_error_hardhit;
  35052. SQLITE_API extern int sqlite3_io_error_pending;
  35053. SQLITE_API extern int sqlite3_io_error_persist;
  35054. SQLITE_API extern int sqlite3_io_error_benign;
  35055. SQLITE_API extern int sqlite3_diskfull_pending;
  35056. SQLITE_API extern int sqlite3_diskfull;
  35057. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  35058. #define SimulateIOError(CODE) \
  35059. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  35060. || sqlite3_io_error_pending-- == 1 ) \
  35061. { local_ioerr(); CODE; }
  35062. static void local_ioerr(){
  35063. IOTRACE(("IOERR\n"));
  35064. sqlite3_io_error_hit++;
  35065. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  35066. }
  35067. #define SimulateDiskfullError(CODE) \
  35068. if( sqlite3_diskfull_pending ){ \
  35069. if( sqlite3_diskfull_pending == 1 ){ \
  35070. local_ioerr(); \
  35071. sqlite3_diskfull = 1; \
  35072. sqlite3_io_error_hit = 1; \
  35073. CODE; \
  35074. }else{ \
  35075. sqlite3_diskfull_pending--; \
  35076. } \
  35077. }
  35078. #else
  35079. #define SimulateIOErrorBenign(X)
  35080. #define SimulateIOError(A)
  35081. #define SimulateDiskfullError(A)
  35082. #endif /* defined(SQLITE_TEST) */
  35083. /*
  35084. ** When testing, keep a count of the number of open files.
  35085. */
  35086. #if defined(SQLITE_TEST)
  35087. SQLITE_API extern int sqlite3_open_file_count;
  35088. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  35089. #else
  35090. #define OpenCounter(X)
  35091. #endif /* defined(SQLITE_TEST) */
  35092. #endif /* !defined(_OS_COMMON_H_) */
  35093. /************** End of os_common.h *******************************************/
  35094. /************** Continuing where we left off in os_win.c *********************/
  35095. /*
  35096. ** Include the header file for the Windows VFS.
  35097. */
  35098. /* #include "os_win.h" */
  35099. /*
  35100. ** Compiling and using WAL mode requires several APIs that are only
  35101. ** available in Windows platforms based on the NT kernel.
  35102. */
  35103. #if !SQLITE_OS_WINNT && !defined(SQLITE_OMIT_WAL)
  35104. # error "WAL mode requires support from the Windows NT kernel, compile\
  35105. with SQLITE_OMIT_WAL."
  35106. #endif
  35107. #if !SQLITE_OS_WINNT && SQLITE_MAX_MMAP_SIZE>0
  35108. # error "Memory mapped files require support from the Windows NT kernel,\
  35109. compile with SQLITE_MAX_MMAP_SIZE=0."
  35110. #endif
  35111. /*
  35112. ** Are most of the Win32 ANSI APIs available (i.e. with certain exceptions
  35113. ** based on the sub-platform)?
  35114. */
  35115. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(SQLITE_WIN32_NO_ANSI)
  35116. # define SQLITE_WIN32_HAS_ANSI
  35117. #endif
  35118. /*
  35119. ** Are most of the Win32 Unicode APIs available (i.e. with certain exceptions
  35120. ** based on the sub-platform)?
  35121. */
  35122. #if (SQLITE_OS_WINCE || SQLITE_OS_WINNT || SQLITE_OS_WINRT) && \
  35123. !defined(SQLITE_WIN32_NO_WIDE)
  35124. # define SQLITE_WIN32_HAS_WIDE
  35125. #endif
  35126. /*
  35127. ** Make sure at least one set of Win32 APIs is available.
  35128. */
  35129. #if !defined(SQLITE_WIN32_HAS_ANSI) && !defined(SQLITE_WIN32_HAS_WIDE)
  35130. # error "At least one of SQLITE_WIN32_HAS_ANSI and SQLITE_WIN32_HAS_WIDE\
  35131. must be defined."
  35132. #endif
  35133. /*
  35134. ** Define the required Windows SDK version constants if they are not
  35135. ** already available.
  35136. */
  35137. #ifndef NTDDI_WIN8
  35138. # define NTDDI_WIN8 0x06020000
  35139. #endif
  35140. #ifndef NTDDI_WINBLUE
  35141. # define NTDDI_WINBLUE 0x06030000
  35142. #endif
  35143. #ifndef NTDDI_WINTHRESHOLD
  35144. # define NTDDI_WINTHRESHOLD 0x06040000
  35145. #endif
  35146. /*
  35147. ** Check to see if the GetVersionEx[AW] functions are deprecated on the
  35148. ** target system. GetVersionEx was first deprecated in Win8.1.
  35149. */
  35150. #ifndef SQLITE_WIN32_GETVERSIONEX
  35151. # if defined(NTDDI_VERSION) && NTDDI_VERSION >= NTDDI_WINBLUE
  35152. # define SQLITE_WIN32_GETVERSIONEX 0 /* GetVersionEx() is deprecated */
  35153. # else
  35154. # define SQLITE_WIN32_GETVERSIONEX 1 /* GetVersionEx() is current */
  35155. # endif
  35156. #endif
  35157. /*
  35158. ** Check to see if the CreateFileMappingA function is supported on the
  35159. ** target system. It is unavailable when using "mincore.lib" on Win10.
  35160. ** When compiling for Windows 10, always assume "mincore.lib" is in use.
  35161. */
  35162. #ifndef SQLITE_WIN32_CREATEFILEMAPPINGA
  35163. # if defined(NTDDI_VERSION) && NTDDI_VERSION >= NTDDI_WINTHRESHOLD
  35164. # define SQLITE_WIN32_CREATEFILEMAPPINGA 0
  35165. # else
  35166. # define SQLITE_WIN32_CREATEFILEMAPPINGA 1
  35167. # endif
  35168. #endif
  35169. /*
  35170. ** This constant should already be defined (in the "WinDef.h" SDK file).
  35171. */
  35172. #ifndef MAX_PATH
  35173. # define MAX_PATH (260)
  35174. #endif
  35175. /*
  35176. ** Maximum pathname length (in chars) for Win32. This should normally be
  35177. ** MAX_PATH.
  35178. */
  35179. #ifndef SQLITE_WIN32_MAX_PATH_CHARS
  35180. # define SQLITE_WIN32_MAX_PATH_CHARS (MAX_PATH)
  35181. #endif
  35182. /*
  35183. ** This constant should already be defined (in the "WinNT.h" SDK file).
  35184. */
  35185. #ifndef UNICODE_STRING_MAX_CHARS
  35186. # define UNICODE_STRING_MAX_CHARS (32767)
  35187. #endif
  35188. /*
  35189. ** Maximum pathname length (in chars) for WinNT. This should normally be
  35190. ** UNICODE_STRING_MAX_CHARS.
  35191. */
  35192. #ifndef SQLITE_WINNT_MAX_PATH_CHARS
  35193. # define SQLITE_WINNT_MAX_PATH_CHARS (UNICODE_STRING_MAX_CHARS)
  35194. #endif
  35195. /*
  35196. ** Maximum pathname length (in bytes) for Win32. The MAX_PATH macro is in
  35197. ** characters, so we allocate 4 bytes per character assuming worst-case of
  35198. ** 4-bytes-per-character for UTF8.
  35199. */
  35200. #ifndef SQLITE_WIN32_MAX_PATH_BYTES
  35201. # define SQLITE_WIN32_MAX_PATH_BYTES (SQLITE_WIN32_MAX_PATH_CHARS*4)
  35202. #endif
  35203. /*
  35204. ** Maximum pathname length (in bytes) for WinNT. This should normally be
  35205. ** UNICODE_STRING_MAX_CHARS * sizeof(WCHAR).
  35206. */
  35207. #ifndef SQLITE_WINNT_MAX_PATH_BYTES
  35208. # define SQLITE_WINNT_MAX_PATH_BYTES \
  35209. (sizeof(WCHAR) * SQLITE_WINNT_MAX_PATH_CHARS)
  35210. #endif
  35211. /*
  35212. ** Maximum error message length (in chars) for WinRT.
  35213. */
  35214. #ifndef SQLITE_WIN32_MAX_ERRMSG_CHARS
  35215. # define SQLITE_WIN32_MAX_ERRMSG_CHARS (1024)
  35216. #endif
  35217. /*
  35218. ** Returns non-zero if the character should be treated as a directory
  35219. ** separator.
  35220. */
  35221. #ifndef winIsDirSep
  35222. # define winIsDirSep(a) (((a) == '/') || ((a) == '\\'))
  35223. #endif
  35224. /*
  35225. ** This macro is used when a local variable is set to a value that is
  35226. ** [sometimes] not used by the code (e.g. via conditional compilation).
  35227. */
  35228. #ifndef UNUSED_VARIABLE_VALUE
  35229. # define UNUSED_VARIABLE_VALUE(x) (void)(x)
  35230. #endif
  35231. /*
  35232. ** Returns the character that should be used as the directory separator.
  35233. */
  35234. #ifndef winGetDirSep
  35235. # define winGetDirSep() '\\'
  35236. #endif
  35237. /*
  35238. ** Do we need to manually define the Win32 file mapping APIs for use with WAL
  35239. ** mode or memory mapped files (e.g. these APIs are available in the Windows
  35240. ** CE SDK; however, they are not present in the header file)?
  35241. */
  35242. #if SQLITE_WIN32_FILEMAPPING_API && \
  35243. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  35244. /*
  35245. ** Two of the file mapping APIs are different under WinRT. Figure out which
  35246. ** set we need.
  35247. */
  35248. #if SQLITE_OS_WINRT
  35249. WINBASEAPI HANDLE WINAPI CreateFileMappingFromApp(HANDLE, \
  35250. LPSECURITY_ATTRIBUTES, ULONG, ULONG64, LPCWSTR);
  35251. WINBASEAPI LPVOID WINAPI MapViewOfFileFromApp(HANDLE, ULONG, ULONG64, SIZE_T);
  35252. #else
  35253. #if defined(SQLITE_WIN32_HAS_ANSI)
  35254. WINBASEAPI HANDLE WINAPI CreateFileMappingA(HANDLE, LPSECURITY_ATTRIBUTES, \
  35255. DWORD, DWORD, DWORD, LPCSTR);
  35256. #endif /* defined(SQLITE_WIN32_HAS_ANSI) */
  35257. #if defined(SQLITE_WIN32_HAS_WIDE)
  35258. WINBASEAPI HANDLE WINAPI CreateFileMappingW(HANDLE, LPSECURITY_ATTRIBUTES, \
  35259. DWORD, DWORD, DWORD, LPCWSTR);
  35260. #endif /* defined(SQLITE_WIN32_HAS_WIDE) */
  35261. WINBASEAPI LPVOID WINAPI MapViewOfFile(HANDLE, DWORD, DWORD, DWORD, SIZE_T);
  35262. #endif /* SQLITE_OS_WINRT */
  35263. /*
  35264. ** These file mapping APIs are common to both Win32 and WinRT.
  35265. */
  35266. WINBASEAPI BOOL WINAPI FlushViewOfFile(LPCVOID, SIZE_T);
  35267. WINBASEAPI BOOL WINAPI UnmapViewOfFile(LPCVOID);
  35268. #endif /* SQLITE_WIN32_FILEMAPPING_API */
  35269. /*
  35270. ** Some Microsoft compilers lack this definition.
  35271. */
  35272. #ifndef INVALID_FILE_ATTRIBUTES
  35273. # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
  35274. #endif
  35275. #ifndef FILE_FLAG_MASK
  35276. # define FILE_FLAG_MASK (0xFF3C0000)
  35277. #endif
  35278. #ifndef FILE_ATTRIBUTE_MASK
  35279. # define FILE_ATTRIBUTE_MASK (0x0003FFF7)
  35280. #endif
  35281. #ifndef SQLITE_OMIT_WAL
  35282. /* Forward references to structures used for WAL */
  35283. typedef struct winShm winShm; /* A connection to shared-memory */
  35284. typedef struct winShmNode winShmNode; /* A region of shared-memory */
  35285. #endif
  35286. /*
  35287. ** WinCE lacks native support for file locking so we have to fake it
  35288. ** with some code of our own.
  35289. */
  35290. #if SQLITE_OS_WINCE
  35291. typedef struct winceLock {
  35292. int nReaders; /* Number of reader locks obtained */
  35293. BOOL bPending; /* Indicates a pending lock has been obtained */
  35294. BOOL bReserved; /* Indicates a reserved lock has been obtained */
  35295. BOOL bExclusive; /* Indicates an exclusive lock has been obtained */
  35296. } winceLock;
  35297. #endif
  35298. /*
  35299. ** The winFile structure is a subclass of sqlite3_file* specific to the win32
  35300. ** portability layer.
  35301. */
  35302. typedef struct winFile winFile;
  35303. struct winFile {
  35304. const sqlite3_io_methods *pMethod; /*** Must be first ***/
  35305. sqlite3_vfs *pVfs; /* The VFS used to open this file */
  35306. HANDLE h; /* Handle for accessing the file */
  35307. u8 locktype; /* Type of lock currently held on this file */
  35308. short sharedLockByte; /* Randomly chosen byte used as a shared lock */
  35309. u8 ctrlFlags; /* Flags. See WINFILE_* below */
  35310. DWORD lastErrno; /* The Windows errno from the last I/O error */
  35311. #ifndef SQLITE_OMIT_WAL
  35312. winShm *pShm; /* Instance of shared memory on this file */
  35313. #endif
  35314. const char *zPath; /* Full pathname of this file */
  35315. int szChunk; /* Chunk size configured by FCNTL_CHUNK_SIZE */
  35316. #if SQLITE_OS_WINCE
  35317. LPWSTR zDeleteOnClose; /* Name of file to delete when closing */
  35318. HANDLE hMutex; /* Mutex used to control access to shared lock */
  35319. HANDLE hShared; /* Shared memory segment used for locking */
  35320. winceLock local; /* Locks obtained by this instance of winFile */
  35321. winceLock *shared; /* Global shared lock memory for the file */
  35322. #endif
  35323. #if SQLITE_MAX_MMAP_SIZE>0
  35324. int nFetchOut; /* Number of outstanding xFetch references */
  35325. HANDLE hMap; /* Handle for accessing memory mapping */
  35326. void *pMapRegion; /* Area memory mapped */
  35327. sqlite3_int64 mmapSize; /* Usable size of mapped region */
  35328. sqlite3_int64 mmapSizeActual; /* Actual size of mapped region */
  35329. sqlite3_int64 mmapSizeMax; /* Configured FCNTL_MMAP_SIZE value */
  35330. #endif
  35331. };
  35332. /*
  35333. ** The winVfsAppData structure is used for the pAppData member for all of the
  35334. ** Win32 VFS variants.
  35335. */
  35336. typedef struct winVfsAppData winVfsAppData;
  35337. struct winVfsAppData {
  35338. const sqlite3_io_methods *pMethod; /* The file I/O methods to use. */
  35339. void *pAppData; /* The extra pAppData, if any. */
  35340. BOOL bNoLock; /* Non-zero if locking is disabled. */
  35341. };
  35342. /*
  35343. ** Allowed values for winFile.ctrlFlags
  35344. */
  35345. #define WINFILE_RDONLY 0x02 /* Connection is read only */
  35346. #define WINFILE_PERSIST_WAL 0x04 /* Persistent WAL mode */
  35347. #define WINFILE_PSOW 0x10 /* SQLITE_IOCAP_POWERSAFE_OVERWRITE */
  35348. /*
  35349. * The size of the buffer used by sqlite3_win32_write_debug().
  35350. */
  35351. #ifndef SQLITE_WIN32_DBG_BUF_SIZE
  35352. # define SQLITE_WIN32_DBG_BUF_SIZE ((int)(4096-sizeof(DWORD)))
  35353. #endif
  35354. /*
  35355. * The value used with sqlite3_win32_set_directory() to specify that
  35356. * the data directory should be changed.
  35357. */
  35358. #ifndef SQLITE_WIN32_DATA_DIRECTORY_TYPE
  35359. # define SQLITE_WIN32_DATA_DIRECTORY_TYPE (1)
  35360. #endif
  35361. /*
  35362. * The value used with sqlite3_win32_set_directory() to specify that
  35363. * the temporary directory should be changed.
  35364. */
  35365. #ifndef SQLITE_WIN32_TEMP_DIRECTORY_TYPE
  35366. # define SQLITE_WIN32_TEMP_DIRECTORY_TYPE (2)
  35367. #endif
  35368. /*
  35369. * If compiled with SQLITE_WIN32_MALLOC on Windows, we will use the
  35370. * various Win32 API heap functions instead of our own.
  35371. */
  35372. #ifdef SQLITE_WIN32_MALLOC
  35373. /*
  35374. * If this is non-zero, an isolated heap will be created by the native Win32
  35375. * allocator subsystem; otherwise, the default process heap will be used. This
  35376. * setting has no effect when compiling for WinRT. By default, this is enabled
  35377. * and an isolated heap will be created to store all allocated data.
  35378. *
  35379. ******************************************************************************
  35380. * WARNING: It is important to note that when this setting is non-zero and the
  35381. * winMemShutdown function is called (e.g. by the sqlite3_shutdown
  35382. * function), all data that was allocated using the isolated heap will
  35383. * be freed immediately and any attempt to access any of that freed
  35384. * data will almost certainly result in an immediate access violation.
  35385. ******************************************************************************
  35386. */
  35387. #ifndef SQLITE_WIN32_HEAP_CREATE
  35388. # define SQLITE_WIN32_HEAP_CREATE (TRUE)
  35389. #endif
  35390. /*
  35391. * This is cache size used in the calculation of the initial size of the
  35392. * Win32-specific heap. It cannot be negative.
  35393. */
  35394. #ifndef SQLITE_WIN32_CACHE_SIZE
  35395. # if SQLITE_DEFAULT_CACHE_SIZE>=0
  35396. # define SQLITE_WIN32_CACHE_SIZE (SQLITE_DEFAULT_CACHE_SIZE)
  35397. # else
  35398. # define SQLITE_WIN32_CACHE_SIZE (-(SQLITE_DEFAULT_CACHE_SIZE))
  35399. # endif
  35400. #endif
  35401. /*
  35402. * The initial size of the Win32-specific heap. This value may be zero.
  35403. */
  35404. #ifndef SQLITE_WIN32_HEAP_INIT_SIZE
  35405. # define SQLITE_WIN32_HEAP_INIT_SIZE ((SQLITE_WIN32_CACHE_SIZE) * \
  35406. (SQLITE_DEFAULT_PAGE_SIZE) + 4194304)
  35407. #endif
  35408. /*
  35409. * The maximum size of the Win32-specific heap. This value may be zero.
  35410. */
  35411. #ifndef SQLITE_WIN32_HEAP_MAX_SIZE
  35412. # define SQLITE_WIN32_HEAP_MAX_SIZE (0)
  35413. #endif
  35414. /*
  35415. * The extra flags to use in calls to the Win32 heap APIs. This value may be
  35416. * zero for the default behavior.
  35417. */
  35418. #ifndef SQLITE_WIN32_HEAP_FLAGS
  35419. # define SQLITE_WIN32_HEAP_FLAGS (0)
  35420. #endif
  35421. /*
  35422. ** The winMemData structure stores information required by the Win32-specific
  35423. ** sqlite3_mem_methods implementation.
  35424. */
  35425. typedef struct winMemData winMemData;
  35426. struct winMemData {
  35427. #ifndef NDEBUG
  35428. u32 magic1; /* Magic number to detect structure corruption. */
  35429. #endif
  35430. HANDLE hHeap; /* The handle to our heap. */
  35431. BOOL bOwned; /* Do we own the heap (i.e. destroy it on shutdown)? */
  35432. #ifndef NDEBUG
  35433. u32 magic2; /* Magic number to detect structure corruption. */
  35434. #endif
  35435. };
  35436. #ifndef NDEBUG
  35437. #define WINMEM_MAGIC1 0x42b2830b
  35438. #define WINMEM_MAGIC2 0xbd4d7cf4
  35439. #endif
  35440. static struct winMemData win_mem_data = {
  35441. #ifndef NDEBUG
  35442. WINMEM_MAGIC1,
  35443. #endif
  35444. NULL, FALSE
  35445. #ifndef NDEBUG
  35446. ,WINMEM_MAGIC2
  35447. #endif
  35448. };
  35449. #ifndef NDEBUG
  35450. #define winMemAssertMagic1() assert( win_mem_data.magic1==WINMEM_MAGIC1 )
  35451. #define winMemAssertMagic2() assert( win_mem_data.magic2==WINMEM_MAGIC2 )
  35452. #define winMemAssertMagic() winMemAssertMagic1(); winMemAssertMagic2();
  35453. #else
  35454. #define winMemAssertMagic()
  35455. #endif
  35456. #define winMemGetDataPtr() &win_mem_data
  35457. #define winMemGetHeap() win_mem_data.hHeap
  35458. #define winMemGetOwned() win_mem_data.bOwned
  35459. static void *winMemMalloc(int nBytes);
  35460. static void winMemFree(void *pPrior);
  35461. static void *winMemRealloc(void *pPrior, int nBytes);
  35462. static int winMemSize(void *p);
  35463. static int winMemRoundup(int n);
  35464. static int winMemInit(void *pAppData);
  35465. static void winMemShutdown(void *pAppData);
  35466. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetWin32(void);
  35467. #endif /* SQLITE_WIN32_MALLOC */
  35468. /*
  35469. ** The following variable is (normally) set once and never changes
  35470. ** thereafter. It records whether the operating system is Win9x
  35471. ** or WinNT.
  35472. **
  35473. ** 0: Operating system unknown.
  35474. ** 1: Operating system is Win9x.
  35475. ** 2: Operating system is WinNT.
  35476. **
  35477. ** In order to facilitate testing on a WinNT system, the test fixture
  35478. ** can manually set this value to 1 to emulate Win98 behavior.
  35479. */
  35480. #ifdef SQLITE_TEST
  35481. SQLITE_API LONG SQLITE_WIN32_VOLATILE sqlite3_os_type = 0;
  35482. #else
  35483. static LONG SQLITE_WIN32_VOLATILE sqlite3_os_type = 0;
  35484. #endif
  35485. #ifndef SYSCALL
  35486. # define SYSCALL sqlite3_syscall_ptr
  35487. #endif
  35488. /*
  35489. ** This function is not available on Windows CE or WinRT.
  35490. */
  35491. #if SQLITE_OS_WINCE || SQLITE_OS_WINRT
  35492. # define osAreFileApisANSI() 1
  35493. #endif
  35494. /*
  35495. ** Many system calls are accessed through pointer-to-functions so that
  35496. ** they may be overridden at runtime to facilitate fault injection during
  35497. ** testing and sandboxing. The following array holds the names and pointers
  35498. ** to all overrideable system calls.
  35499. */
  35500. static struct win_syscall {
  35501. const char *zName; /* Name of the system call */
  35502. sqlite3_syscall_ptr pCurrent; /* Current value of the system call */
  35503. sqlite3_syscall_ptr pDefault; /* Default value */
  35504. } aSyscall[] = {
  35505. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  35506. { "AreFileApisANSI", (SYSCALL)AreFileApisANSI, 0 },
  35507. #else
  35508. { "AreFileApisANSI", (SYSCALL)0, 0 },
  35509. #endif
  35510. #ifndef osAreFileApisANSI
  35511. #define osAreFileApisANSI ((BOOL(WINAPI*)(VOID))aSyscall[0].pCurrent)
  35512. #endif
  35513. #if SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_WIDE)
  35514. { "CharLowerW", (SYSCALL)CharLowerW, 0 },
  35515. #else
  35516. { "CharLowerW", (SYSCALL)0, 0 },
  35517. #endif
  35518. #define osCharLowerW ((LPWSTR(WINAPI*)(LPWSTR))aSyscall[1].pCurrent)
  35519. #if SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_WIDE)
  35520. { "CharUpperW", (SYSCALL)CharUpperW, 0 },
  35521. #else
  35522. { "CharUpperW", (SYSCALL)0, 0 },
  35523. #endif
  35524. #define osCharUpperW ((LPWSTR(WINAPI*)(LPWSTR))aSyscall[2].pCurrent)
  35525. { "CloseHandle", (SYSCALL)CloseHandle, 0 },
  35526. #define osCloseHandle ((BOOL(WINAPI*)(HANDLE))aSyscall[3].pCurrent)
  35527. #if defined(SQLITE_WIN32_HAS_ANSI)
  35528. { "CreateFileA", (SYSCALL)CreateFileA, 0 },
  35529. #else
  35530. { "CreateFileA", (SYSCALL)0, 0 },
  35531. #endif
  35532. #define osCreateFileA ((HANDLE(WINAPI*)(LPCSTR,DWORD,DWORD, \
  35533. LPSECURITY_ATTRIBUTES,DWORD,DWORD,HANDLE))aSyscall[4].pCurrent)
  35534. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35535. { "CreateFileW", (SYSCALL)CreateFileW, 0 },
  35536. #else
  35537. { "CreateFileW", (SYSCALL)0, 0 },
  35538. #endif
  35539. #define osCreateFileW ((HANDLE(WINAPI*)(LPCWSTR,DWORD,DWORD, \
  35540. LPSECURITY_ATTRIBUTES,DWORD,DWORD,HANDLE))aSyscall[5].pCurrent)
  35541. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_ANSI) && \
  35542. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0) && \
  35543. SQLITE_WIN32_CREATEFILEMAPPINGA
  35544. { "CreateFileMappingA", (SYSCALL)CreateFileMappingA, 0 },
  35545. #else
  35546. { "CreateFileMappingA", (SYSCALL)0, 0 },
  35547. #endif
  35548. #define osCreateFileMappingA ((HANDLE(WINAPI*)(HANDLE,LPSECURITY_ATTRIBUTES, \
  35549. DWORD,DWORD,DWORD,LPCSTR))aSyscall[6].pCurrent)
  35550. #if SQLITE_OS_WINCE || (!SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  35551. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0))
  35552. { "CreateFileMappingW", (SYSCALL)CreateFileMappingW, 0 },
  35553. #else
  35554. { "CreateFileMappingW", (SYSCALL)0, 0 },
  35555. #endif
  35556. #define osCreateFileMappingW ((HANDLE(WINAPI*)(HANDLE,LPSECURITY_ATTRIBUTES, \
  35557. DWORD,DWORD,DWORD,LPCWSTR))aSyscall[7].pCurrent)
  35558. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35559. { "CreateMutexW", (SYSCALL)CreateMutexW, 0 },
  35560. #else
  35561. { "CreateMutexW", (SYSCALL)0, 0 },
  35562. #endif
  35563. #define osCreateMutexW ((HANDLE(WINAPI*)(LPSECURITY_ATTRIBUTES,BOOL, \
  35564. LPCWSTR))aSyscall[8].pCurrent)
  35565. #if defined(SQLITE_WIN32_HAS_ANSI)
  35566. { "DeleteFileA", (SYSCALL)DeleteFileA, 0 },
  35567. #else
  35568. { "DeleteFileA", (SYSCALL)0, 0 },
  35569. #endif
  35570. #define osDeleteFileA ((BOOL(WINAPI*)(LPCSTR))aSyscall[9].pCurrent)
  35571. #if defined(SQLITE_WIN32_HAS_WIDE)
  35572. { "DeleteFileW", (SYSCALL)DeleteFileW, 0 },
  35573. #else
  35574. { "DeleteFileW", (SYSCALL)0, 0 },
  35575. #endif
  35576. #define osDeleteFileW ((BOOL(WINAPI*)(LPCWSTR))aSyscall[10].pCurrent)
  35577. #if SQLITE_OS_WINCE
  35578. { "FileTimeToLocalFileTime", (SYSCALL)FileTimeToLocalFileTime, 0 },
  35579. #else
  35580. { "FileTimeToLocalFileTime", (SYSCALL)0, 0 },
  35581. #endif
  35582. #define osFileTimeToLocalFileTime ((BOOL(WINAPI*)(CONST FILETIME*, \
  35583. LPFILETIME))aSyscall[11].pCurrent)
  35584. #if SQLITE_OS_WINCE
  35585. { "FileTimeToSystemTime", (SYSCALL)FileTimeToSystemTime, 0 },
  35586. #else
  35587. { "FileTimeToSystemTime", (SYSCALL)0, 0 },
  35588. #endif
  35589. #define osFileTimeToSystemTime ((BOOL(WINAPI*)(CONST FILETIME*, \
  35590. LPSYSTEMTIME))aSyscall[12].pCurrent)
  35591. { "FlushFileBuffers", (SYSCALL)FlushFileBuffers, 0 },
  35592. #define osFlushFileBuffers ((BOOL(WINAPI*)(HANDLE))aSyscall[13].pCurrent)
  35593. #if defined(SQLITE_WIN32_HAS_ANSI)
  35594. { "FormatMessageA", (SYSCALL)FormatMessageA, 0 },
  35595. #else
  35596. { "FormatMessageA", (SYSCALL)0, 0 },
  35597. #endif
  35598. #define osFormatMessageA ((DWORD(WINAPI*)(DWORD,LPCVOID,DWORD,DWORD,LPSTR, \
  35599. DWORD,va_list*))aSyscall[14].pCurrent)
  35600. #if defined(SQLITE_WIN32_HAS_WIDE)
  35601. { "FormatMessageW", (SYSCALL)FormatMessageW, 0 },
  35602. #else
  35603. { "FormatMessageW", (SYSCALL)0, 0 },
  35604. #endif
  35605. #define osFormatMessageW ((DWORD(WINAPI*)(DWORD,LPCVOID,DWORD,DWORD,LPWSTR, \
  35606. DWORD,va_list*))aSyscall[15].pCurrent)
  35607. #if !defined(SQLITE_OMIT_LOAD_EXTENSION)
  35608. { "FreeLibrary", (SYSCALL)FreeLibrary, 0 },
  35609. #else
  35610. { "FreeLibrary", (SYSCALL)0, 0 },
  35611. #endif
  35612. #define osFreeLibrary ((BOOL(WINAPI*)(HMODULE))aSyscall[16].pCurrent)
  35613. { "GetCurrentProcessId", (SYSCALL)GetCurrentProcessId, 0 },
  35614. #define osGetCurrentProcessId ((DWORD(WINAPI*)(VOID))aSyscall[17].pCurrent)
  35615. #if !SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_ANSI)
  35616. { "GetDiskFreeSpaceA", (SYSCALL)GetDiskFreeSpaceA, 0 },
  35617. #else
  35618. { "GetDiskFreeSpaceA", (SYSCALL)0, 0 },
  35619. #endif
  35620. #define osGetDiskFreeSpaceA ((BOOL(WINAPI*)(LPCSTR,LPDWORD,LPDWORD,LPDWORD, \
  35621. LPDWORD))aSyscall[18].pCurrent)
  35622. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35623. { "GetDiskFreeSpaceW", (SYSCALL)GetDiskFreeSpaceW, 0 },
  35624. #else
  35625. { "GetDiskFreeSpaceW", (SYSCALL)0, 0 },
  35626. #endif
  35627. #define osGetDiskFreeSpaceW ((BOOL(WINAPI*)(LPCWSTR,LPDWORD,LPDWORD,LPDWORD, \
  35628. LPDWORD))aSyscall[19].pCurrent)
  35629. #if defined(SQLITE_WIN32_HAS_ANSI)
  35630. { "GetFileAttributesA", (SYSCALL)GetFileAttributesA, 0 },
  35631. #else
  35632. { "GetFileAttributesA", (SYSCALL)0, 0 },
  35633. #endif
  35634. #define osGetFileAttributesA ((DWORD(WINAPI*)(LPCSTR))aSyscall[20].pCurrent)
  35635. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35636. { "GetFileAttributesW", (SYSCALL)GetFileAttributesW, 0 },
  35637. #else
  35638. { "GetFileAttributesW", (SYSCALL)0, 0 },
  35639. #endif
  35640. #define osGetFileAttributesW ((DWORD(WINAPI*)(LPCWSTR))aSyscall[21].pCurrent)
  35641. #if defined(SQLITE_WIN32_HAS_WIDE)
  35642. { "GetFileAttributesExW", (SYSCALL)GetFileAttributesExW, 0 },
  35643. #else
  35644. { "GetFileAttributesExW", (SYSCALL)0, 0 },
  35645. #endif
  35646. #define osGetFileAttributesExW ((BOOL(WINAPI*)(LPCWSTR,GET_FILEEX_INFO_LEVELS, \
  35647. LPVOID))aSyscall[22].pCurrent)
  35648. #if !SQLITE_OS_WINRT
  35649. { "GetFileSize", (SYSCALL)GetFileSize, 0 },
  35650. #else
  35651. { "GetFileSize", (SYSCALL)0, 0 },
  35652. #endif
  35653. #define osGetFileSize ((DWORD(WINAPI*)(HANDLE,LPDWORD))aSyscall[23].pCurrent)
  35654. #if !SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_ANSI)
  35655. { "GetFullPathNameA", (SYSCALL)GetFullPathNameA, 0 },
  35656. #else
  35657. { "GetFullPathNameA", (SYSCALL)0, 0 },
  35658. #endif
  35659. #define osGetFullPathNameA ((DWORD(WINAPI*)(LPCSTR,DWORD,LPSTR, \
  35660. LPSTR*))aSyscall[24].pCurrent)
  35661. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35662. { "GetFullPathNameW", (SYSCALL)GetFullPathNameW, 0 },
  35663. #else
  35664. { "GetFullPathNameW", (SYSCALL)0, 0 },
  35665. #endif
  35666. #define osGetFullPathNameW ((DWORD(WINAPI*)(LPCWSTR,DWORD,LPWSTR, \
  35667. LPWSTR*))aSyscall[25].pCurrent)
  35668. { "GetLastError", (SYSCALL)GetLastError, 0 },
  35669. #define osGetLastError ((DWORD(WINAPI*)(VOID))aSyscall[26].pCurrent)
  35670. #if !defined(SQLITE_OMIT_LOAD_EXTENSION)
  35671. #if SQLITE_OS_WINCE
  35672. /* The GetProcAddressA() routine is only available on Windows CE. */
  35673. { "GetProcAddressA", (SYSCALL)GetProcAddressA, 0 },
  35674. #else
  35675. /* All other Windows platforms expect GetProcAddress() to take
  35676. ** an ANSI string regardless of the _UNICODE setting */
  35677. { "GetProcAddressA", (SYSCALL)GetProcAddress, 0 },
  35678. #endif
  35679. #else
  35680. { "GetProcAddressA", (SYSCALL)0, 0 },
  35681. #endif
  35682. #define osGetProcAddressA ((FARPROC(WINAPI*)(HMODULE, \
  35683. LPCSTR))aSyscall[27].pCurrent)
  35684. #if !SQLITE_OS_WINRT
  35685. { "GetSystemInfo", (SYSCALL)GetSystemInfo, 0 },
  35686. #else
  35687. { "GetSystemInfo", (SYSCALL)0, 0 },
  35688. #endif
  35689. #define osGetSystemInfo ((VOID(WINAPI*)(LPSYSTEM_INFO))aSyscall[28].pCurrent)
  35690. { "GetSystemTime", (SYSCALL)GetSystemTime, 0 },
  35691. #define osGetSystemTime ((VOID(WINAPI*)(LPSYSTEMTIME))aSyscall[29].pCurrent)
  35692. #if !SQLITE_OS_WINCE
  35693. { "GetSystemTimeAsFileTime", (SYSCALL)GetSystemTimeAsFileTime, 0 },
  35694. #else
  35695. { "GetSystemTimeAsFileTime", (SYSCALL)0, 0 },
  35696. #endif
  35697. #define osGetSystemTimeAsFileTime ((VOID(WINAPI*)( \
  35698. LPFILETIME))aSyscall[30].pCurrent)
  35699. #if defined(SQLITE_WIN32_HAS_ANSI)
  35700. { "GetTempPathA", (SYSCALL)GetTempPathA, 0 },
  35701. #else
  35702. { "GetTempPathA", (SYSCALL)0, 0 },
  35703. #endif
  35704. #define osGetTempPathA ((DWORD(WINAPI*)(DWORD,LPSTR))aSyscall[31].pCurrent)
  35705. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  35706. { "GetTempPathW", (SYSCALL)GetTempPathW, 0 },
  35707. #else
  35708. { "GetTempPathW", (SYSCALL)0, 0 },
  35709. #endif
  35710. #define osGetTempPathW ((DWORD(WINAPI*)(DWORD,LPWSTR))aSyscall[32].pCurrent)
  35711. #if !SQLITE_OS_WINRT
  35712. { "GetTickCount", (SYSCALL)GetTickCount, 0 },
  35713. #else
  35714. { "GetTickCount", (SYSCALL)0, 0 },
  35715. #endif
  35716. #define osGetTickCount ((DWORD(WINAPI*)(VOID))aSyscall[33].pCurrent)
  35717. #if defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_GETVERSIONEX
  35718. { "GetVersionExA", (SYSCALL)GetVersionExA, 0 },
  35719. #else
  35720. { "GetVersionExA", (SYSCALL)0, 0 },
  35721. #endif
  35722. #define osGetVersionExA ((BOOL(WINAPI*)( \
  35723. LPOSVERSIONINFOA))aSyscall[34].pCurrent)
  35724. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  35725. SQLITE_WIN32_GETVERSIONEX
  35726. { "GetVersionExW", (SYSCALL)GetVersionExW, 0 },
  35727. #else
  35728. { "GetVersionExW", (SYSCALL)0, 0 },
  35729. #endif
  35730. #define osGetVersionExW ((BOOL(WINAPI*)( \
  35731. LPOSVERSIONINFOW))aSyscall[35].pCurrent)
  35732. { "HeapAlloc", (SYSCALL)HeapAlloc, 0 },
  35733. #define osHeapAlloc ((LPVOID(WINAPI*)(HANDLE,DWORD, \
  35734. SIZE_T))aSyscall[36].pCurrent)
  35735. #if !SQLITE_OS_WINRT
  35736. { "HeapCreate", (SYSCALL)HeapCreate, 0 },
  35737. #else
  35738. { "HeapCreate", (SYSCALL)0, 0 },
  35739. #endif
  35740. #define osHeapCreate ((HANDLE(WINAPI*)(DWORD,SIZE_T, \
  35741. SIZE_T))aSyscall[37].pCurrent)
  35742. #if !SQLITE_OS_WINRT
  35743. { "HeapDestroy", (SYSCALL)HeapDestroy, 0 },
  35744. #else
  35745. { "HeapDestroy", (SYSCALL)0, 0 },
  35746. #endif
  35747. #define osHeapDestroy ((BOOL(WINAPI*)(HANDLE))aSyscall[38].pCurrent)
  35748. { "HeapFree", (SYSCALL)HeapFree, 0 },
  35749. #define osHeapFree ((BOOL(WINAPI*)(HANDLE,DWORD,LPVOID))aSyscall[39].pCurrent)
  35750. { "HeapReAlloc", (SYSCALL)HeapReAlloc, 0 },
  35751. #define osHeapReAlloc ((LPVOID(WINAPI*)(HANDLE,DWORD,LPVOID, \
  35752. SIZE_T))aSyscall[40].pCurrent)
  35753. { "HeapSize", (SYSCALL)HeapSize, 0 },
  35754. #define osHeapSize ((SIZE_T(WINAPI*)(HANDLE,DWORD, \
  35755. LPCVOID))aSyscall[41].pCurrent)
  35756. #if !SQLITE_OS_WINRT
  35757. { "HeapValidate", (SYSCALL)HeapValidate, 0 },
  35758. #else
  35759. { "HeapValidate", (SYSCALL)0, 0 },
  35760. #endif
  35761. #define osHeapValidate ((BOOL(WINAPI*)(HANDLE,DWORD, \
  35762. LPCVOID))aSyscall[42].pCurrent)
  35763. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  35764. { "HeapCompact", (SYSCALL)HeapCompact, 0 },
  35765. #else
  35766. { "HeapCompact", (SYSCALL)0, 0 },
  35767. #endif
  35768. #define osHeapCompact ((UINT(WINAPI*)(HANDLE,DWORD))aSyscall[43].pCurrent)
  35769. #if defined(SQLITE_WIN32_HAS_ANSI) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  35770. { "LoadLibraryA", (SYSCALL)LoadLibraryA, 0 },
  35771. #else
  35772. { "LoadLibraryA", (SYSCALL)0, 0 },
  35773. #endif
  35774. #define osLoadLibraryA ((HMODULE(WINAPI*)(LPCSTR))aSyscall[44].pCurrent)
  35775. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  35776. !defined(SQLITE_OMIT_LOAD_EXTENSION)
  35777. { "LoadLibraryW", (SYSCALL)LoadLibraryW, 0 },
  35778. #else
  35779. { "LoadLibraryW", (SYSCALL)0, 0 },
  35780. #endif
  35781. #define osLoadLibraryW ((HMODULE(WINAPI*)(LPCWSTR))aSyscall[45].pCurrent)
  35782. #if !SQLITE_OS_WINRT
  35783. { "LocalFree", (SYSCALL)LocalFree, 0 },
  35784. #else
  35785. { "LocalFree", (SYSCALL)0, 0 },
  35786. #endif
  35787. #define osLocalFree ((HLOCAL(WINAPI*)(HLOCAL))aSyscall[46].pCurrent)
  35788. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  35789. { "LockFile", (SYSCALL)LockFile, 0 },
  35790. #else
  35791. { "LockFile", (SYSCALL)0, 0 },
  35792. #endif
  35793. #ifndef osLockFile
  35794. #define osLockFile ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  35795. DWORD))aSyscall[47].pCurrent)
  35796. #endif
  35797. #if !SQLITE_OS_WINCE
  35798. { "LockFileEx", (SYSCALL)LockFileEx, 0 },
  35799. #else
  35800. { "LockFileEx", (SYSCALL)0, 0 },
  35801. #endif
  35802. #ifndef osLockFileEx
  35803. #define osLockFileEx ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD,DWORD, \
  35804. LPOVERLAPPED))aSyscall[48].pCurrent)
  35805. #endif
  35806. #if SQLITE_OS_WINCE || (!SQLITE_OS_WINRT && \
  35807. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0))
  35808. { "MapViewOfFile", (SYSCALL)MapViewOfFile, 0 },
  35809. #else
  35810. { "MapViewOfFile", (SYSCALL)0, 0 },
  35811. #endif
  35812. #define osMapViewOfFile ((LPVOID(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  35813. SIZE_T))aSyscall[49].pCurrent)
  35814. { "MultiByteToWideChar", (SYSCALL)MultiByteToWideChar, 0 },
  35815. #define osMultiByteToWideChar ((int(WINAPI*)(UINT,DWORD,LPCSTR,int,LPWSTR, \
  35816. int))aSyscall[50].pCurrent)
  35817. { "QueryPerformanceCounter", (SYSCALL)QueryPerformanceCounter, 0 },
  35818. #define osQueryPerformanceCounter ((BOOL(WINAPI*)( \
  35819. LARGE_INTEGER*))aSyscall[51].pCurrent)
  35820. { "ReadFile", (SYSCALL)ReadFile, 0 },
  35821. #define osReadFile ((BOOL(WINAPI*)(HANDLE,LPVOID,DWORD,LPDWORD, \
  35822. LPOVERLAPPED))aSyscall[52].pCurrent)
  35823. { "SetEndOfFile", (SYSCALL)SetEndOfFile, 0 },
  35824. #define osSetEndOfFile ((BOOL(WINAPI*)(HANDLE))aSyscall[53].pCurrent)
  35825. #if !SQLITE_OS_WINRT
  35826. { "SetFilePointer", (SYSCALL)SetFilePointer, 0 },
  35827. #else
  35828. { "SetFilePointer", (SYSCALL)0, 0 },
  35829. #endif
  35830. #define osSetFilePointer ((DWORD(WINAPI*)(HANDLE,LONG,PLONG, \
  35831. DWORD))aSyscall[54].pCurrent)
  35832. #if !SQLITE_OS_WINRT
  35833. { "Sleep", (SYSCALL)Sleep, 0 },
  35834. #else
  35835. { "Sleep", (SYSCALL)0, 0 },
  35836. #endif
  35837. #define osSleep ((VOID(WINAPI*)(DWORD))aSyscall[55].pCurrent)
  35838. { "SystemTimeToFileTime", (SYSCALL)SystemTimeToFileTime, 0 },
  35839. #define osSystemTimeToFileTime ((BOOL(WINAPI*)(CONST SYSTEMTIME*, \
  35840. LPFILETIME))aSyscall[56].pCurrent)
  35841. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  35842. { "UnlockFile", (SYSCALL)UnlockFile, 0 },
  35843. #else
  35844. { "UnlockFile", (SYSCALL)0, 0 },
  35845. #endif
  35846. #ifndef osUnlockFile
  35847. #define osUnlockFile ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  35848. DWORD))aSyscall[57].pCurrent)
  35849. #endif
  35850. #if !SQLITE_OS_WINCE
  35851. { "UnlockFileEx", (SYSCALL)UnlockFileEx, 0 },
  35852. #else
  35853. { "UnlockFileEx", (SYSCALL)0, 0 },
  35854. #endif
  35855. #define osUnlockFileEx ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  35856. LPOVERLAPPED))aSyscall[58].pCurrent)
  35857. #if SQLITE_OS_WINCE || !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  35858. { "UnmapViewOfFile", (SYSCALL)UnmapViewOfFile, 0 },
  35859. #else
  35860. { "UnmapViewOfFile", (SYSCALL)0, 0 },
  35861. #endif
  35862. #define osUnmapViewOfFile ((BOOL(WINAPI*)(LPCVOID))aSyscall[59].pCurrent)
  35863. { "WideCharToMultiByte", (SYSCALL)WideCharToMultiByte, 0 },
  35864. #define osWideCharToMultiByte ((int(WINAPI*)(UINT,DWORD,LPCWSTR,int,LPSTR,int, \
  35865. LPCSTR,LPBOOL))aSyscall[60].pCurrent)
  35866. { "WriteFile", (SYSCALL)WriteFile, 0 },
  35867. #define osWriteFile ((BOOL(WINAPI*)(HANDLE,LPCVOID,DWORD,LPDWORD, \
  35868. LPOVERLAPPED))aSyscall[61].pCurrent)
  35869. #if SQLITE_OS_WINRT
  35870. { "CreateEventExW", (SYSCALL)CreateEventExW, 0 },
  35871. #else
  35872. { "CreateEventExW", (SYSCALL)0, 0 },
  35873. #endif
  35874. #define osCreateEventExW ((HANDLE(WINAPI*)(LPSECURITY_ATTRIBUTES,LPCWSTR, \
  35875. DWORD,DWORD))aSyscall[62].pCurrent)
  35876. #if !SQLITE_OS_WINRT
  35877. { "WaitForSingleObject", (SYSCALL)WaitForSingleObject, 0 },
  35878. #else
  35879. { "WaitForSingleObject", (SYSCALL)0, 0 },
  35880. #endif
  35881. #define osWaitForSingleObject ((DWORD(WINAPI*)(HANDLE, \
  35882. DWORD))aSyscall[63].pCurrent)
  35883. #if !SQLITE_OS_WINCE
  35884. { "WaitForSingleObjectEx", (SYSCALL)WaitForSingleObjectEx, 0 },
  35885. #else
  35886. { "WaitForSingleObjectEx", (SYSCALL)0, 0 },
  35887. #endif
  35888. #define osWaitForSingleObjectEx ((DWORD(WINAPI*)(HANDLE,DWORD, \
  35889. BOOL))aSyscall[64].pCurrent)
  35890. #if SQLITE_OS_WINRT
  35891. { "SetFilePointerEx", (SYSCALL)SetFilePointerEx, 0 },
  35892. #else
  35893. { "SetFilePointerEx", (SYSCALL)0, 0 },
  35894. #endif
  35895. #define osSetFilePointerEx ((BOOL(WINAPI*)(HANDLE,LARGE_INTEGER, \
  35896. PLARGE_INTEGER,DWORD))aSyscall[65].pCurrent)
  35897. #if SQLITE_OS_WINRT
  35898. { "GetFileInformationByHandleEx", (SYSCALL)GetFileInformationByHandleEx, 0 },
  35899. #else
  35900. { "GetFileInformationByHandleEx", (SYSCALL)0, 0 },
  35901. #endif
  35902. #define osGetFileInformationByHandleEx ((BOOL(WINAPI*)(HANDLE, \
  35903. FILE_INFO_BY_HANDLE_CLASS,LPVOID,DWORD))aSyscall[66].pCurrent)
  35904. #if SQLITE_OS_WINRT && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  35905. { "MapViewOfFileFromApp", (SYSCALL)MapViewOfFileFromApp, 0 },
  35906. #else
  35907. { "MapViewOfFileFromApp", (SYSCALL)0, 0 },
  35908. #endif
  35909. #define osMapViewOfFileFromApp ((LPVOID(WINAPI*)(HANDLE,ULONG,ULONG64, \
  35910. SIZE_T))aSyscall[67].pCurrent)
  35911. #if SQLITE_OS_WINRT
  35912. { "CreateFile2", (SYSCALL)CreateFile2, 0 },
  35913. #else
  35914. { "CreateFile2", (SYSCALL)0, 0 },
  35915. #endif
  35916. #define osCreateFile2 ((HANDLE(WINAPI*)(LPCWSTR,DWORD,DWORD,DWORD, \
  35917. LPCREATEFILE2_EXTENDED_PARAMETERS))aSyscall[68].pCurrent)
  35918. #if SQLITE_OS_WINRT && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  35919. { "LoadPackagedLibrary", (SYSCALL)LoadPackagedLibrary, 0 },
  35920. #else
  35921. { "LoadPackagedLibrary", (SYSCALL)0, 0 },
  35922. #endif
  35923. #define osLoadPackagedLibrary ((HMODULE(WINAPI*)(LPCWSTR, \
  35924. DWORD))aSyscall[69].pCurrent)
  35925. #if SQLITE_OS_WINRT
  35926. { "GetTickCount64", (SYSCALL)GetTickCount64, 0 },
  35927. #else
  35928. { "GetTickCount64", (SYSCALL)0, 0 },
  35929. #endif
  35930. #define osGetTickCount64 ((ULONGLONG(WINAPI*)(VOID))aSyscall[70].pCurrent)
  35931. #if SQLITE_OS_WINRT
  35932. { "GetNativeSystemInfo", (SYSCALL)GetNativeSystemInfo, 0 },
  35933. #else
  35934. { "GetNativeSystemInfo", (SYSCALL)0, 0 },
  35935. #endif
  35936. #define osGetNativeSystemInfo ((VOID(WINAPI*)( \
  35937. LPSYSTEM_INFO))aSyscall[71].pCurrent)
  35938. #if defined(SQLITE_WIN32_HAS_ANSI)
  35939. { "OutputDebugStringA", (SYSCALL)OutputDebugStringA, 0 },
  35940. #else
  35941. { "OutputDebugStringA", (SYSCALL)0, 0 },
  35942. #endif
  35943. #define osOutputDebugStringA ((VOID(WINAPI*)(LPCSTR))aSyscall[72].pCurrent)
  35944. #if defined(SQLITE_WIN32_HAS_WIDE)
  35945. { "OutputDebugStringW", (SYSCALL)OutputDebugStringW, 0 },
  35946. #else
  35947. { "OutputDebugStringW", (SYSCALL)0, 0 },
  35948. #endif
  35949. #define osOutputDebugStringW ((VOID(WINAPI*)(LPCWSTR))aSyscall[73].pCurrent)
  35950. { "GetProcessHeap", (SYSCALL)GetProcessHeap, 0 },
  35951. #define osGetProcessHeap ((HANDLE(WINAPI*)(VOID))aSyscall[74].pCurrent)
  35952. #if SQLITE_OS_WINRT && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  35953. { "CreateFileMappingFromApp", (SYSCALL)CreateFileMappingFromApp, 0 },
  35954. #else
  35955. { "CreateFileMappingFromApp", (SYSCALL)0, 0 },
  35956. #endif
  35957. #define osCreateFileMappingFromApp ((HANDLE(WINAPI*)(HANDLE, \
  35958. LPSECURITY_ATTRIBUTES,ULONG,ULONG64,LPCWSTR))aSyscall[75].pCurrent)
  35959. /*
  35960. ** NOTE: On some sub-platforms, the InterlockedCompareExchange "function"
  35961. ** is really just a macro that uses a compiler intrinsic (e.g. x64).
  35962. ** So do not try to make this is into a redefinable interface.
  35963. */
  35964. #if defined(InterlockedCompareExchange)
  35965. { "InterlockedCompareExchange", (SYSCALL)0, 0 },
  35966. #define osInterlockedCompareExchange InterlockedCompareExchange
  35967. #else
  35968. { "InterlockedCompareExchange", (SYSCALL)InterlockedCompareExchange, 0 },
  35969. #define osInterlockedCompareExchange ((LONG(WINAPI*)(LONG \
  35970. SQLITE_WIN32_VOLATILE*, LONG,LONG))aSyscall[76].pCurrent)
  35971. #endif /* defined(InterlockedCompareExchange) */
  35972. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  35973. { "UuidCreate", (SYSCALL)UuidCreate, 0 },
  35974. #else
  35975. { "UuidCreate", (SYSCALL)0, 0 },
  35976. #endif
  35977. #define osUuidCreate ((RPC_STATUS(RPC_ENTRY*)(UUID*))aSyscall[77].pCurrent)
  35978. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  35979. { "UuidCreateSequential", (SYSCALL)UuidCreateSequential, 0 },
  35980. #else
  35981. { "UuidCreateSequential", (SYSCALL)0, 0 },
  35982. #endif
  35983. #define osUuidCreateSequential \
  35984. ((RPC_STATUS(RPC_ENTRY*)(UUID*))aSyscall[78].pCurrent)
  35985. #if !defined(SQLITE_NO_SYNC) && SQLITE_MAX_MMAP_SIZE>0
  35986. { "FlushViewOfFile", (SYSCALL)FlushViewOfFile, 0 },
  35987. #else
  35988. { "FlushViewOfFile", (SYSCALL)0, 0 },
  35989. #endif
  35990. #define osFlushViewOfFile \
  35991. ((BOOL(WINAPI*)(LPCVOID,SIZE_T))aSyscall[79].pCurrent)
  35992. }; /* End of the overrideable system calls */
  35993. /*
  35994. ** This is the xSetSystemCall() method of sqlite3_vfs for all of the
  35995. ** "win32" VFSes. Return SQLITE_OK opon successfully updating the
  35996. ** system call pointer, or SQLITE_NOTFOUND if there is no configurable
  35997. ** system call named zName.
  35998. */
  35999. static int winSetSystemCall(
  36000. sqlite3_vfs *pNotUsed, /* The VFS pointer. Not used */
  36001. const char *zName, /* Name of system call to override */
  36002. sqlite3_syscall_ptr pNewFunc /* Pointer to new system call value */
  36003. ){
  36004. unsigned int i;
  36005. int rc = SQLITE_NOTFOUND;
  36006. UNUSED_PARAMETER(pNotUsed);
  36007. if( zName==0 ){
  36008. /* If no zName is given, restore all system calls to their default
  36009. ** settings and return NULL
  36010. */
  36011. rc = SQLITE_OK;
  36012. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  36013. if( aSyscall[i].pDefault ){
  36014. aSyscall[i].pCurrent = aSyscall[i].pDefault;
  36015. }
  36016. }
  36017. }else{
  36018. /* If zName is specified, operate on only the one system call
  36019. ** specified.
  36020. */
  36021. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  36022. if( strcmp(zName, aSyscall[i].zName)==0 ){
  36023. if( aSyscall[i].pDefault==0 ){
  36024. aSyscall[i].pDefault = aSyscall[i].pCurrent;
  36025. }
  36026. rc = SQLITE_OK;
  36027. if( pNewFunc==0 ) pNewFunc = aSyscall[i].pDefault;
  36028. aSyscall[i].pCurrent = pNewFunc;
  36029. break;
  36030. }
  36031. }
  36032. }
  36033. return rc;
  36034. }
  36035. /*
  36036. ** Return the value of a system call. Return NULL if zName is not a
  36037. ** recognized system call name. NULL is also returned if the system call
  36038. ** is currently undefined.
  36039. */
  36040. static sqlite3_syscall_ptr winGetSystemCall(
  36041. sqlite3_vfs *pNotUsed,
  36042. const char *zName
  36043. ){
  36044. unsigned int i;
  36045. UNUSED_PARAMETER(pNotUsed);
  36046. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  36047. if( strcmp(zName, aSyscall[i].zName)==0 ) return aSyscall[i].pCurrent;
  36048. }
  36049. return 0;
  36050. }
  36051. /*
  36052. ** Return the name of the first system call after zName. If zName==NULL
  36053. ** then return the name of the first system call. Return NULL if zName
  36054. ** is the last system call or if zName is not the name of a valid
  36055. ** system call.
  36056. */
  36057. static const char *winNextSystemCall(sqlite3_vfs *p, const char *zName){
  36058. int i = -1;
  36059. UNUSED_PARAMETER(p);
  36060. if( zName ){
  36061. for(i=0; i<ArraySize(aSyscall)-1; i++){
  36062. if( strcmp(zName, aSyscall[i].zName)==0 ) break;
  36063. }
  36064. }
  36065. for(i++; i<ArraySize(aSyscall); i++){
  36066. if( aSyscall[i].pCurrent!=0 ) return aSyscall[i].zName;
  36067. }
  36068. return 0;
  36069. }
  36070. #ifdef SQLITE_WIN32_MALLOC
  36071. /*
  36072. ** If a Win32 native heap has been configured, this function will attempt to
  36073. ** compact it. Upon success, SQLITE_OK will be returned. Upon failure, one
  36074. ** of SQLITE_NOMEM, SQLITE_ERROR, or SQLITE_NOTFOUND will be returned. The
  36075. ** "pnLargest" argument, if non-zero, will be used to return the size of the
  36076. ** largest committed free block in the heap, in bytes.
  36077. */
  36078. SQLITE_API int sqlite3_win32_compact_heap(LPUINT pnLargest){
  36079. int rc = SQLITE_OK;
  36080. UINT nLargest = 0;
  36081. HANDLE hHeap;
  36082. winMemAssertMagic();
  36083. hHeap = winMemGetHeap();
  36084. assert( hHeap!=0 );
  36085. assert( hHeap!=INVALID_HANDLE_VALUE );
  36086. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36087. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  36088. #endif
  36089. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  36090. if( (nLargest=osHeapCompact(hHeap, SQLITE_WIN32_HEAP_FLAGS))==0 ){
  36091. DWORD lastErrno = osGetLastError();
  36092. if( lastErrno==NO_ERROR ){
  36093. sqlite3_log(SQLITE_NOMEM, "failed to HeapCompact (no space), heap=%p",
  36094. (void*)hHeap);
  36095. rc = SQLITE_NOMEM_BKPT;
  36096. }else{
  36097. sqlite3_log(SQLITE_ERROR, "failed to HeapCompact (%lu), heap=%p",
  36098. osGetLastError(), (void*)hHeap);
  36099. rc = SQLITE_ERROR;
  36100. }
  36101. }
  36102. #else
  36103. sqlite3_log(SQLITE_NOTFOUND, "failed to HeapCompact, heap=%p",
  36104. (void*)hHeap);
  36105. rc = SQLITE_NOTFOUND;
  36106. #endif
  36107. if( pnLargest ) *pnLargest = nLargest;
  36108. return rc;
  36109. }
  36110. /*
  36111. ** If a Win32 native heap has been configured, this function will attempt to
  36112. ** destroy and recreate it. If the Win32 native heap is not isolated and/or
  36113. ** the sqlite3_memory_used() function does not return zero, SQLITE_BUSY will
  36114. ** be returned and no changes will be made to the Win32 native heap.
  36115. */
  36116. SQLITE_API int sqlite3_win32_reset_heap(){
  36117. int rc;
  36118. MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
  36119. MUTEX_LOGIC( sqlite3_mutex *pMem; ) /* The memsys static mutex */
  36120. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  36121. MUTEX_LOGIC( pMem = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM); )
  36122. sqlite3_mutex_enter(pMaster);
  36123. sqlite3_mutex_enter(pMem);
  36124. winMemAssertMagic();
  36125. if( winMemGetHeap()!=NULL && winMemGetOwned() && sqlite3_memory_used()==0 ){
  36126. /*
  36127. ** At this point, there should be no outstanding memory allocations on
  36128. ** the heap. Also, since both the master and memsys locks are currently
  36129. ** being held by us, no other function (i.e. from another thread) should
  36130. ** be able to even access the heap. Attempt to destroy and recreate our
  36131. ** isolated Win32 native heap now.
  36132. */
  36133. assert( winMemGetHeap()!=NULL );
  36134. assert( winMemGetOwned() );
  36135. assert( sqlite3_memory_used()==0 );
  36136. winMemShutdown(winMemGetDataPtr());
  36137. assert( winMemGetHeap()==NULL );
  36138. assert( !winMemGetOwned() );
  36139. assert( sqlite3_memory_used()==0 );
  36140. rc = winMemInit(winMemGetDataPtr());
  36141. assert( rc!=SQLITE_OK || winMemGetHeap()!=NULL );
  36142. assert( rc!=SQLITE_OK || winMemGetOwned() );
  36143. assert( rc!=SQLITE_OK || sqlite3_memory_used()==0 );
  36144. }else{
  36145. /*
  36146. ** The Win32 native heap cannot be modified because it may be in use.
  36147. */
  36148. rc = SQLITE_BUSY;
  36149. }
  36150. sqlite3_mutex_leave(pMem);
  36151. sqlite3_mutex_leave(pMaster);
  36152. return rc;
  36153. }
  36154. #endif /* SQLITE_WIN32_MALLOC */
  36155. /*
  36156. ** This function outputs the specified (ANSI) string to the Win32 debugger
  36157. ** (if available).
  36158. */
  36159. SQLITE_API void sqlite3_win32_write_debug(const char *zBuf, int nBuf){
  36160. char zDbgBuf[SQLITE_WIN32_DBG_BUF_SIZE];
  36161. int nMin = MIN(nBuf, (SQLITE_WIN32_DBG_BUF_SIZE - 1)); /* may be negative. */
  36162. if( nMin<-1 ) nMin = -1; /* all negative values become -1. */
  36163. assert( nMin==-1 || nMin==0 || nMin<SQLITE_WIN32_DBG_BUF_SIZE );
  36164. #ifdef SQLITE_ENABLE_API_ARMOR
  36165. if( !zBuf ){
  36166. (void)SQLITE_MISUSE_BKPT;
  36167. return;
  36168. }
  36169. #endif
  36170. #if defined(SQLITE_WIN32_HAS_ANSI)
  36171. if( nMin>0 ){
  36172. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  36173. memcpy(zDbgBuf, zBuf, nMin);
  36174. osOutputDebugStringA(zDbgBuf);
  36175. }else{
  36176. osOutputDebugStringA(zBuf);
  36177. }
  36178. #elif defined(SQLITE_WIN32_HAS_WIDE)
  36179. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  36180. if ( osMultiByteToWideChar(
  36181. osAreFileApisANSI() ? CP_ACP : CP_OEMCP, 0, zBuf,
  36182. nMin, (LPWSTR)zDbgBuf, SQLITE_WIN32_DBG_BUF_SIZE/sizeof(WCHAR))<=0 ){
  36183. return;
  36184. }
  36185. osOutputDebugStringW((LPCWSTR)zDbgBuf);
  36186. #else
  36187. if( nMin>0 ){
  36188. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  36189. memcpy(zDbgBuf, zBuf, nMin);
  36190. fprintf(stderr, "%s", zDbgBuf);
  36191. }else{
  36192. fprintf(stderr, "%s", zBuf);
  36193. }
  36194. #endif
  36195. }
  36196. /*
  36197. ** The following routine suspends the current thread for at least ms
  36198. ** milliseconds. This is equivalent to the Win32 Sleep() interface.
  36199. */
  36200. #if SQLITE_OS_WINRT
  36201. static HANDLE sleepObj = NULL;
  36202. #endif
  36203. SQLITE_API void sqlite3_win32_sleep(DWORD milliseconds){
  36204. #if SQLITE_OS_WINRT
  36205. if ( sleepObj==NULL ){
  36206. sleepObj = osCreateEventExW(NULL, NULL, CREATE_EVENT_MANUAL_RESET,
  36207. SYNCHRONIZE);
  36208. }
  36209. assert( sleepObj!=NULL );
  36210. osWaitForSingleObjectEx(sleepObj, milliseconds, FALSE);
  36211. #else
  36212. osSleep(milliseconds);
  36213. #endif
  36214. }
  36215. #if SQLITE_MAX_WORKER_THREADS>0 && !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && \
  36216. SQLITE_THREADSAFE>0
  36217. SQLITE_PRIVATE DWORD sqlite3Win32Wait(HANDLE hObject){
  36218. DWORD rc;
  36219. while( (rc = osWaitForSingleObjectEx(hObject, INFINITE,
  36220. TRUE))==WAIT_IO_COMPLETION ){}
  36221. return rc;
  36222. }
  36223. #endif
  36224. /*
  36225. ** Return true (non-zero) if we are running under WinNT, Win2K, WinXP,
  36226. ** or WinCE. Return false (zero) for Win95, Win98, or WinME.
  36227. **
  36228. ** Here is an interesting observation: Win95, Win98, and WinME lack
  36229. ** the LockFileEx() API. But we can still statically link against that
  36230. ** API as long as we don't call it when running Win95/98/ME. A call to
  36231. ** this routine is used to determine if the host is Win95/98/ME or
  36232. ** WinNT/2K/XP so that we will know whether or not we can safely call
  36233. ** the LockFileEx() API.
  36234. */
  36235. #if !SQLITE_WIN32_GETVERSIONEX
  36236. # define osIsNT() (1)
  36237. #elif SQLITE_OS_WINCE || SQLITE_OS_WINRT || !defined(SQLITE_WIN32_HAS_ANSI)
  36238. # define osIsNT() (1)
  36239. #elif !defined(SQLITE_WIN32_HAS_WIDE)
  36240. # define osIsNT() (0)
  36241. #else
  36242. # define osIsNT() ((sqlite3_os_type==2) || sqlite3_win32_is_nt())
  36243. #endif
  36244. /*
  36245. ** This function determines if the machine is running a version of Windows
  36246. ** based on the NT kernel.
  36247. */
  36248. SQLITE_API int sqlite3_win32_is_nt(void){
  36249. #if SQLITE_OS_WINRT
  36250. /*
  36251. ** NOTE: The WinRT sub-platform is always assumed to be based on the NT
  36252. ** kernel.
  36253. */
  36254. return 1;
  36255. #elif SQLITE_WIN32_GETVERSIONEX
  36256. if( osInterlockedCompareExchange(&sqlite3_os_type, 0, 0)==0 ){
  36257. #if defined(SQLITE_WIN32_HAS_ANSI)
  36258. OSVERSIONINFOA sInfo;
  36259. sInfo.dwOSVersionInfoSize = sizeof(sInfo);
  36260. osGetVersionExA(&sInfo);
  36261. osInterlockedCompareExchange(&sqlite3_os_type,
  36262. (sInfo.dwPlatformId == VER_PLATFORM_WIN32_NT) ? 2 : 1, 0);
  36263. #elif defined(SQLITE_WIN32_HAS_WIDE)
  36264. OSVERSIONINFOW sInfo;
  36265. sInfo.dwOSVersionInfoSize = sizeof(sInfo);
  36266. osGetVersionExW(&sInfo);
  36267. osInterlockedCompareExchange(&sqlite3_os_type,
  36268. (sInfo.dwPlatformId == VER_PLATFORM_WIN32_NT) ? 2 : 1, 0);
  36269. #endif
  36270. }
  36271. return osInterlockedCompareExchange(&sqlite3_os_type, 2, 2)==2;
  36272. #elif SQLITE_TEST
  36273. return osInterlockedCompareExchange(&sqlite3_os_type, 2, 2)==2;
  36274. #else
  36275. /*
  36276. ** NOTE: All sub-platforms where the GetVersionEx[AW] functions are
  36277. ** deprecated are always assumed to be based on the NT kernel.
  36278. */
  36279. return 1;
  36280. #endif
  36281. }
  36282. #ifdef SQLITE_WIN32_MALLOC
  36283. /*
  36284. ** Allocate nBytes of memory.
  36285. */
  36286. static void *winMemMalloc(int nBytes){
  36287. HANDLE hHeap;
  36288. void *p;
  36289. winMemAssertMagic();
  36290. hHeap = winMemGetHeap();
  36291. assert( hHeap!=0 );
  36292. assert( hHeap!=INVALID_HANDLE_VALUE );
  36293. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36294. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  36295. #endif
  36296. assert( nBytes>=0 );
  36297. p = osHeapAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, (SIZE_T)nBytes);
  36298. if( !p ){
  36299. sqlite3_log(SQLITE_NOMEM, "failed to HeapAlloc %u bytes (%lu), heap=%p",
  36300. nBytes, osGetLastError(), (void*)hHeap);
  36301. }
  36302. return p;
  36303. }
  36304. /*
  36305. ** Free memory.
  36306. */
  36307. static void winMemFree(void *pPrior){
  36308. HANDLE hHeap;
  36309. winMemAssertMagic();
  36310. hHeap = winMemGetHeap();
  36311. assert( hHeap!=0 );
  36312. assert( hHeap!=INVALID_HANDLE_VALUE );
  36313. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36314. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) );
  36315. #endif
  36316. if( !pPrior ) return; /* Passing NULL to HeapFree is undefined. */
  36317. if( !osHeapFree(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) ){
  36318. sqlite3_log(SQLITE_NOMEM, "failed to HeapFree block %p (%lu), heap=%p",
  36319. pPrior, osGetLastError(), (void*)hHeap);
  36320. }
  36321. }
  36322. /*
  36323. ** Change the size of an existing memory allocation
  36324. */
  36325. static void *winMemRealloc(void *pPrior, int nBytes){
  36326. HANDLE hHeap;
  36327. void *p;
  36328. winMemAssertMagic();
  36329. hHeap = winMemGetHeap();
  36330. assert( hHeap!=0 );
  36331. assert( hHeap!=INVALID_HANDLE_VALUE );
  36332. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36333. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) );
  36334. #endif
  36335. assert( nBytes>=0 );
  36336. if( !pPrior ){
  36337. p = osHeapAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, (SIZE_T)nBytes);
  36338. }else{
  36339. p = osHeapReAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior, (SIZE_T)nBytes);
  36340. }
  36341. if( !p ){
  36342. sqlite3_log(SQLITE_NOMEM, "failed to %s %u bytes (%lu), heap=%p",
  36343. pPrior ? "HeapReAlloc" : "HeapAlloc", nBytes, osGetLastError(),
  36344. (void*)hHeap);
  36345. }
  36346. return p;
  36347. }
  36348. /*
  36349. ** Return the size of an outstanding allocation, in bytes.
  36350. */
  36351. static int winMemSize(void *p){
  36352. HANDLE hHeap;
  36353. SIZE_T n;
  36354. winMemAssertMagic();
  36355. hHeap = winMemGetHeap();
  36356. assert( hHeap!=0 );
  36357. assert( hHeap!=INVALID_HANDLE_VALUE );
  36358. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36359. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, p) );
  36360. #endif
  36361. if( !p ) return 0;
  36362. n = osHeapSize(hHeap, SQLITE_WIN32_HEAP_FLAGS, p);
  36363. if( n==(SIZE_T)-1 ){
  36364. sqlite3_log(SQLITE_NOMEM, "failed to HeapSize block %p (%lu), heap=%p",
  36365. p, osGetLastError(), (void*)hHeap);
  36366. return 0;
  36367. }
  36368. return (int)n;
  36369. }
  36370. /*
  36371. ** Round up a request size to the next valid allocation size.
  36372. */
  36373. static int winMemRoundup(int n){
  36374. return n;
  36375. }
  36376. /*
  36377. ** Initialize this module.
  36378. */
  36379. static int winMemInit(void *pAppData){
  36380. winMemData *pWinMemData = (winMemData *)pAppData;
  36381. if( !pWinMemData ) return SQLITE_ERROR;
  36382. assert( pWinMemData->magic1==WINMEM_MAGIC1 );
  36383. assert( pWinMemData->magic2==WINMEM_MAGIC2 );
  36384. #if !SQLITE_OS_WINRT && SQLITE_WIN32_HEAP_CREATE
  36385. if( !pWinMemData->hHeap ){
  36386. DWORD dwInitialSize = SQLITE_WIN32_HEAP_INIT_SIZE;
  36387. DWORD dwMaximumSize = (DWORD)sqlite3GlobalConfig.nHeap;
  36388. if( dwMaximumSize==0 ){
  36389. dwMaximumSize = SQLITE_WIN32_HEAP_MAX_SIZE;
  36390. }else if( dwInitialSize>dwMaximumSize ){
  36391. dwInitialSize = dwMaximumSize;
  36392. }
  36393. pWinMemData->hHeap = osHeapCreate(SQLITE_WIN32_HEAP_FLAGS,
  36394. dwInitialSize, dwMaximumSize);
  36395. if( !pWinMemData->hHeap ){
  36396. sqlite3_log(SQLITE_NOMEM,
  36397. "failed to HeapCreate (%lu), flags=%u, initSize=%lu, maxSize=%lu",
  36398. osGetLastError(), SQLITE_WIN32_HEAP_FLAGS, dwInitialSize,
  36399. dwMaximumSize);
  36400. return SQLITE_NOMEM_BKPT;
  36401. }
  36402. pWinMemData->bOwned = TRUE;
  36403. assert( pWinMemData->bOwned );
  36404. }
  36405. #else
  36406. pWinMemData->hHeap = osGetProcessHeap();
  36407. if( !pWinMemData->hHeap ){
  36408. sqlite3_log(SQLITE_NOMEM,
  36409. "failed to GetProcessHeap (%lu)", osGetLastError());
  36410. return SQLITE_NOMEM_BKPT;
  36411. }
  36412. pWinMemData->bOwned = FALSE;
  36413. assert( !pWinMemData->bOwned );
  36414. #endif
  36415. assert( pWinMemData->hHeap!=0 );
  36416. assert( pWinMemData->hHeap!=INVALID_HANDLE_VALUE );
  36417. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36418. assert( osHeapValidate(pWinMemData->hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  36419. #endif
  36420. return SQLITE_OK;
  36421. }
  36422. /*
  36423. ** Deinitialize this module.
  36424. */
  36425. static void winMemShutdown(void *pAppData){
  36426. winMemData *pWinMemData = (winMemData *)pAppData;
  36427. if( !pWinMemData ) return;
  36428. assert( pWinMemData->magic1==WINMEM_MAGIC1 );
  36429. assert( pWinMemData->magic2==WINMEM_MAGIC2 );
  36430. if( pWinMemData->hHeap ){
  36431. assert( pWinMemData->hHeap!=INVALID_HANDLE_VALUE );
  36432. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  36433. assert( osHeapValidate(pWinMemData->hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  36434. #endif
  36435. if( pWinMemData->bOwned ){
  36436. if( !osHeapDestroy(pWinMemData->hHeap) ){
  36437. sqlite3_log(SQLITE_NOMEM, "failed to HeapDestroy (%lu), heap=%p",
  36438. osGetLastError(), (void*)pWinMemData->hHeap);
  36439. }
  36440. pWinMemData->bOwned = FALSE;
  36441. }
  36442. pWinMemData->hHeap = NULL;
  36443. }
  36444. }
  36445. /*
  36446. ** Populate the low-level memory allocation function pointers in
  36447. ** sqlite3GlobalConfig.m with pointers to the routines in this file. The
  36448. ** arguments specify the block of memory to manage.
  36449. **
  36450. ** This routine is only called by sqlite3_config(), and therefore
  36451. ** is not required to be threadsafe (it is not).
  36452. */
  36453. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetWin32(void){
  36454. static const sqlite3_mem_methods winMemMethods = {
  36455. winMemMalloc,
  36456. winMemFree,
  36457. winMemRealloc,
  36458. winMemSize,
  36459. winMemRoundup,
  36460. winMemInit,
  36461. winMemShutdown,
  36462. &win_mem_data
  36463. };
  36464. return &winMemMethods;
  36465. }
  36466. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  36467. sqlite3_config(SQLITE_CONFIG_MALLOC, sqlite3MemGetWin32());
  36468. }
  36469. #endif /* SQLITE_WIN32_MALLOC */
  36470. /*
  36471. ** Convert a UTF-8 string to Microsoft Unicode.
  36472. **
  36473. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36474. */
  36475. static LPWSTR winUtf8ToUnicode(const char *zText){
  36476. int nChar;
  36477. LPWSTR zWideText;
  36478. nChar = osMultiByteToWideChar(CP_UTF8, 0, zText, -1, NULL, 0);
  36479. if( nChar==0 ){
  36480. return 0;
  36481. }
  36482. zWideText = sqlite3MallocZero( nChar*sizeof(WCHAR) );
  36483. if( zWideText==0 ){
  36484. return 0;
  36485. }
  36486. nChar = osMultiByteToWideChar(CP_UTF8, 0, zText, -1, zWideText,
  36487. nChar);
  36488. if( nChar==0 ){
  36489. sqlite3_free(zWideText);
  36490. zWideText = 0;
  36491. }
  36492. return zWideText;
  36493. }
  36494. /*
  36495. ** Convert a Microsoft Unicode string to UTF-8.
  36496. **
  36497. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36498. */
  36499. static char *winUnicodeToUtf8(LPCWSTR zWideText){
  36500. int nByte;
  36501. char *zText;
  36502. nByte = osWideCharToMultiByte(CP_UTF8, 0, zWideText, -1, 0, 0, 0, 0);
  36503. if( nByte == 0 ){
  36504. return 0;
  36505. }
  36506. zText = sqlite3MallocZero( nByte );
  36507. if( zText==0 ){
  36508. return 0;
  36509. }
  36510. nByte = osWideCharToMultiByte(CP_UTF8, 0, zWideText, -1, zText, nByte,
  36511. 0, 0);
  36512. if( nByte == 0 ){
  36513. sqlite3_free(zText);
  36514. zText = 0;
  36515. }
  36516. return zText;
  36517. }
  36518. /*
  36519. ** Convert an ANSI string to Microsoft Unicode, using the ANSI or OEM
  36520. ** code page.
  36521. **
  36522. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36523. */
  36524. static LPWSTR winMbcsToUnicode(const char *zText, int useAnsi){
  36525. int nByte;
  36526. LPWSTR zMbcsText;
  36527. int codepage = useAnsi ? CP_ACP : CP_OEMCP;
  36528. nByte = osMultiByteToWideChar(codepage, 0, zText, -1, NULL,
  36529. 0)*sizeof(WCHAR);
  36530. if( nByte==0 ){
  36531. return 0;
  36532. }
  36533. zMbcsText = sqlite3MallocZero( nByte*sizeof(WCHAR) );
  36534. if( zMbcsText==0 ){
  36535. return 0;
  36536. }
  36537. nByte = osMultiByteToWideChar(codepage, 0, zText, -1, zMbcsText,
  36538. nByte);
  36539. if( nByte==0 ){
  36540. sqlite3_free(zMbcsText);
  36541. zMbcsText = 0;
  36542. }
  36543. return zMbcsText;
  36544. }
  36545. /*
  36546. ** Convert a Microsoft Unicode string to a multi-byte character string,
  36547. ** using the ANSI or OEM code page.
  36548. **
  36549. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36550. */
  36551. static char *winUnicodeToMbcs(LPCWSTR zWideText, int useAnsi){
  36552. int nByte;
  36553. char *zText;
  36554. int codepage = useAnsi ? CP_ACP : CP_OEMCP;
  36555. nByte = osWideCharToMultiByte(codepage, 0, zWideText, -1, 0, 0, 0, 0);
  36556. if( nByte == 0 ){
  36557. return 0;
  36558. }
  36559. zText = sqlite3MallocZero( nByte );
  36560. if( zText==0 ){
  36561. return 0;
  36562. }
  36563. nByte = osWideCharToMultiByte(codepage, 0, zWideText, -1, zText,
  36564. nByte, 0, 0);
  36565. if( nByte == 0 ){
  36566. sqlite3_free(zText);
  36567. zText = 0;
  36568. }
  36569. return zText;
  36570. }
  36571. /*
  36572. ** Convert a multi-byte character string to UTF-8.
  36573. **
  36574. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36575. */
  36576. static char *winMbcsToUtf8(const char *zText, int useAnsi){
  36577. char *zTextUtf8;
  36578. LPWSTR zTmpWide;
  36579. zTmpWide = winMbcsToUnicode(zText, useAnsi);
  36580. if( zTmpWide==0 ){
  36581. return 0;
  36582. }
  36583. zTextUtf8 = winUnicodeToUtf8(zTmpWide);
  36584. sqlite3_free(zTmpWide);
  36585. return zTextUtf8;
  36586. }
  36587. /*
  36588. ** Convert a UTF-8 string to a multi-byte character string.
  36589. **
  36590. ** Space to hold the returned string is obtained from sqlite3_malloc().
  36591. */
  36592. static char *winUtf8ToMbcs(const char *zText, int useAnsi){
  36593. char *zTextMbcs;
  36594. LPWSTR zTmpWide;
  36595. zTmpWide = winUtf8ToUnicode(zText);
  36596. if( zTmpWide==0 ){
  36597. return 0;
  36598. }
  36599. zTextMbcs = winUnicodeToMbcs(zTmpWide, useAnsi);
  36600. sqlite3_free(zTmpWide);
  36601. return zTextMbcs;
  36602. }
  36603. /*
  36604. ** This is a public wrapper for the winUtf8ToUnicode() function.
  36605. */
  36606. SQLITE_API LPWSTR sqlite3_win32_utf8_to_unicode(const char *zText){
  36607. #ifdef SQLITE_ENABLE_API_ARMOR
  36608. if( !zText ){
  36609. (void)SQLITE_MISUSE_BKPT;
  36610. return 0;
  36611. }
  36612. #endif
  36613. #ifndef SQLITE_OMIT_AUTOINIT
  36614. if( sqlite3_initialize() ) return 0;
  36615. #endif
  36616. return winUtf8ToUnicode(zText);
  36617. }
  36618. /*
  36619. ** This is a public wrapper for the winUnicodeToUtf8() function.
  36620. */
  36621. SQLITE_API char *sqlite3_win32_unicode_to_utf8(LPCWSTR zWideText){
  36622. #ifdef SQLITE_ENABLE_API_ARMOR
  36623. if( !zWideText ){
  36624. (void)SQLITE_MISUSE_BKPT;
  36625. return 0;
  36626. }
  36627. #endif
  36628. #ifndef SQLITE_OMIT_AUTOINIT
  36629. if( sqlite3_initialize() ) return 0;
  36630. #endif
  36631. return winUnicodeToUtf8(zWideText);
  36632. }
  36633. /*
  36634. ** This is a public wrapper for the winMbcsToUtf8() function.
  36635. */
  36636. SQLITE_API char *sqlite3_win32_mbcs_to_utf8(const char *zText){
  36637. #ifdef SQLITE_ENABLE_API_ARMOR
  36638. if( !zText ){
  36639. (void)SQLITE_MISUSE_BKPT;
  36640. return 0;
  36641. }
  36642. #endif
  36643. #ifndef SQLITE_OMIT_AUTOINIT
  36644. if( sqlite3_initialize() ) return 0;
  36645. #endif
  36646. return winMbcsToUtf8(zText, osAreFileApisANSI());
  36647. }
  36648. /*
  36649. ** This is a public wrapper for the winMbcsToUtf8() function.
  36650. */
  36651. SQLITE_API char *sqlite3_win32_mbcs_to_utf8_v2(const char *zText, int useAnsi){
  36652. #ifdef SQLITE_ENABLE_API_ARMOR
  36653. if( !zText ){
  36654. (void)SQLITE_MISUSE_BKPT;
  36655. return 0;
  36656. }
  36657. #endif
  36658. #ifndef SQLITE_OMIT_AUTOINIT
  36659. if( sqlite3_initialize() ) return 0;
  36660. #endif
  36661. return winMbcsToUtf8(zText, useAnsi);
  36662. }
  36663. /*
  36664. ** This is a public wrapper for the winUtf8ToMbcs() function.
  36665. */
  36666. SQLITE_API char *sqlite3_win32_utf8_to_mbcs(const char *zText){
  36667. #ifdef SQLITE_ENABLE_API_ARMOR
  36668. if( !zText ){
  36669. (void)SQLITE_MISUSE_BKPT;
  36670. return 0;
  36671. }
  36672. #endif
  36673. #ifndef SQLITE_OMIT_AUTOINIT
  36674. if( sqlite3_initialize() ) return 0;
  36675. #endif
  36676. return winUtf8ToMbcs(zText, osAreFileApisANSI());
  36677. }
  36678. /*
  36679. ** This is a public wrapper for the winUtf8ToMbcs() function.
  36680. */
  36681. SQLITE_API char *sqlite3_win32_utf8_to_mbcs_v2(const char *zText, int useAnsi){
  36682. #ifdef SQLITE_ENABLE_API_ARMOR
  36683. if( !zText ){
  36684. (void)SQLITE_MISUSE_BKPT;
  36685. return 0;
  36686. }
  36687. #endif
  36688. #ifndef SQLITE_OMIT_AUTOINIT
  36689. if( sqlite3_initialize() ) return 0;
  36690. #endif
  36691. return winUtf8ToMbcs(zText, useAnsi);
  36692. }
  36693. /*
  36694. ** This function sets the data directory or the temporary directory based on
  36695. ** the provided arguments. The type argument must be 1 in order to set the
  36696. ** data directory or 2 in order to set the temporary directory. The zValue
  36697. ** argument is the name of the directory to use. The return value will be
  36698. ** SQLITE_OK if successful.
  36699. */
  36700. SQLITE_API int sqlite3_win32_set_directory(DWORD type, LPCWSTR zValue){
  36701. char **ppDirectory = 0;
  36702. #ifndef SQLITE_OMIT_AUTOINIT
  36703. int rc = sqlite3_initialize();
  36704. if( rc ) return rc;
  36705. #endif
  36706. if( type==SQLITE_WIN32_DATA_DIRECTORY_TYPE ){
  36707. ppDirectory = &sqlite3_data_directory;
  36708. }else if( type==SQLITE_WIN32_TEMP_DIRECTORY_TYPE ){
  36709. ppDirectory = &sqlite3_temp_directory;
  36710. }
  36711. assert( !ppDirectory || type==SQLITE_WIN32_DATA_DIRECTORY_TYPE
  36712. || type==SQLITE_WIN32_TEMP_DIRECTORY_TYPE
  36713. );
  36714. assert( !ppDirectory || sqlite3MemdebugHasType(*ppDirectory, MEMTYPE_HEAP) );
  36715. if( ppDirectory ){
  36716. char *zValueUtf8 = 0;
  36717. if( zValue && zValue[0] ){
  36718. zValueUtf8 = winUnicodeToUtf8(zValue);
  36719. if ( zValueUtf8==0 ){
  36720. return SQLITE_NOMEM_BKPT;
  36721. }
  36722. }
  36723. sqlite3_free(*ppDirectory);
  36724. *ppDirectory = zValueUtf8;
  36725. return SQLITE_OK;
  36726. }
  36727. return SQLITE_ERROR;
  36728. }
  36729. /*
  36730. ** The return value of winGetLastErrorMsg
  36731. ** is zero if the error message fits in the buffer, or non-zero
  36732. ** otherwise (if the message was truncated).
  36733. */
  36734. static int winGetLastErrorMsg(DWORD lastErrno, int nBuf, char *zBuf){
  36735. /* FormatMessage returns 0 on failure. Otherwise it
  36736. ** returns the number of TCHARs written to the output
  36737. ** buffer, excluding the terminating null char.
  36738. */
  36739. DWORD dwLen = 0;
  36740. char *zOut = 0;
  36741. if( osIsNT() ){
  36742. #if SQLITE_OS_WINRT
  36743. WCHAR zTempWide[SQLITE_WIN32_MAX_ERRMSG_CHARS+1];
  36744. dwLen = osFormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
  36745. FORMAT_MESSAGE_IGNORE_INSERTS,
  36746. NULL,
  36747. lastErrno,
  36748. 0,
  36749. zTempWide,
  36750. SQLITE_WIN32_MAX_ERRMSG_CHARS,
  36751. 0);
  36752. #else
  36753. LPWSTR zTempWide = NULL;
  36754. dwLen = osFormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER |
  36755. FORMAT_MESSAGE_FROM_SYSTEM |
  36756. FORMAT_MESSAGE_IGNORE_INSERTS,
  36757. NULL,
  36758. lastErrno,
  36759. 0,
  36760. (LPWSTR) &zTempWide,
  36761. 0,
  36762. 0);
  36763. #endif
  36764. if( dwLen > 0 ){
  36765. /* allocate a buffer and convert to UTF8 */
  36766. sqlite3BeginBenignMalloc();
  36767. zOut = winUnicodeToUtf8(zTempWide);
  36768. sqlite3EndBenignMalloc();
  36769. #if !SQLITE_OS_WINRT
  36770. /* free the system buffer allocated by FormatMessage */
  36771. osLocalFree(zTempWide);
  36772. #endif
  36773. }
  36774. }
  36775. #ifdef SQLITE_WIN32_HAS_ANSI
  36776. else{
  36777. char *zTemp = NULL;
  36778. dwLen = osFormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER |
  36779. FORMAT_MESSAGE_FROM_SYSTEM |
  36780. FORMAT_MESSAGE_IGNORE_INSERTS,
  36781. NULL,
  36782. lastErrno,
  36783. 0,
  36784. (LPSTR) &zTemp,
  36785. 0,
  36786. 0);
  36787. if( dwLen > 0 ){
  36788. /* allocate a buffer and convert to UTF8 */
  36789. sqlite3BeginBenignMalloc();
  36790. zOut = winMbcsToUtf8(zTemp, osAreFileApisANSI());
  36791. sqlite3EndBenignMalloc();
  36792. /* free the system buffer allocated by FormatMessage */
  36793. osLocalFree(zTemp);
  36794. }
  36795. }
  36796. #endif
  36797. if( 0 == dwLen ){
  36798. sqlite3_snprintf(nBuf, zBuf, "OsError 0x%lx (%lu)", lastErrno, lastErrno);
  36799. }else{
  36800. /* copy a maximum of nBuf chars to output buffer */
  36801. sqlite3_snprintf(nBuf, zBuf, "%s", zOut);
  36802. /* free the UTF8 buffer */
  36803. sqlite3_free(zOut);
  36804. }
  36805. return 0;
  36806. }
  36807. /*
  36808. **
  36809. ** This function - winLogErrorAtLine() - is only ever called via the macro
  36810. ** winLogError().
  36811. **
  36812. ** This routine is invoked after an error occurs in an OS function.
  36813. ** It logs a message using sqlite3_log() containing the current value of
  36814. ** error code and, if possible, the human-readable equivalent from
  36815. ** FormatMessage.
  36816. **
  36817. ** The first argument passed to the macro should be the error code that
  36818. ** will be returned to SQLite (e.g. SQLITE_IOERR_DELETE, SQLITE_CANTOPEN).
  36819. ** The two subsequent arguments should be the name of the OS function that
  36820. ** failed and the associated file-system path, if any.
  36821. */
  36822. #define winLogError(a,b,c,d) winLogErrorAtLine(a,b,c,d,__LINE__)
  36823. static int winLogErrorAtLine(
  36824. int errcode, /* SQLite error code */
  36825. DWORD lastErrno, /* Win32 last error */
  36826. const char *zFunc, /* Name of OS function that failed */
  36827. const char *zPath, /* File path associated with error */
  36828. int iLine /* Source line number where error occurred */
  36829. ){
  36830. char zMsg[500]; /* Human readable error text */
  36831. int i; /* Loop counter */
  36832. zMsg[0] = 0;
  36833. winGetLastErrorMsg(lastErrno, sizeof(zMsg), zMsg);
  36834. assert( errcode!=SQLITE_OK );
  36835. if( zPath==0 ) zPath = "";
  36836. for(i=0; zMsg[i] && zMsg[i]!='\r' && zMsg[i]!='\n'; i++){}
  36837. zMsg[i] = 0;
  36838. sqlite3_log(errcode,
  36839. "os_win.c:%d: (%lu) %s(%s) - %s",
  36840. iLine, lastErrno, zFunc, zPath, zMsg
  36841. );
  36842. return errcode;
  36843. }
  36844. /*
  36845. ** The number of times that a ReadFile(), WriteFile(), and DeleteFile()
  36846. ** will be retried following a locking error - probably caused by
  36847. ** antivirus software. Also the initial delay before the first retry.
  36848. ** The delay increases linearly with each retry.
  36849. */
  36850. #ifndef SQLITE_WIN32_IOERR_RETRY
  36851. # define SQLITE_WIN32_IOERR_RETRY 10
  36852. #endif
  36853. #ifndef SQLITE_WIN32_IOERR_RETRY_DELAY
  36854. # define SQLITE_WIN32_IOERR_RETRY_DELAY 25
  36855. #endif
  36856. static int winIoerrRetry = SQLITE_WIN32_IOERR_RETRY;
  36857. static int winIoerrRetryDelay = SQLITE_WIN32_IOERR_RETRY_DELAY;
  36858. /*
  36859. ** The "winIoerrCanRetry1" macro is used to determine if a particular I/O
  36860. ** error code obtained via GetLastError() is eligible to be retried. It
  36861. ** must accept the error code DWORD as its only argument and should return
  36862. ** non-zero if the error code is transient in nature and the operation
  36863. ** responsible for generating the original error might succeed upon being
  36864. ** retried. The argument to this macro should be a variable.
  36865. **
  36866. ** Additionally, a macro named "winIoerrCanRetry2" may be defined. If it
  36867. ** is defined, it will be consulted only when the macro "winIoerrCanRetry1"
  36868. ** returns zero. The "winIoerrCanRetry2" macro is completely optional and
  36869. ** may be used to include additional error codes in the set that should
  36870. ** result in the failing I/O operation being retried by the caller. If
  36871. ** defined, the "winIoerrCanRetry2" macro must exhibit external semantics
  36872. ** identical to those of the "winIoerrCanRetry1" macro.
  36873. */
  36874. #if !defined(winIoerrCanRetry1)
  36875. #define winIoerrCanRetry1(a) (((a)==ERROR_ACCESS_DENIED) || \
  36876. ((a)==ERROR_SHARING_VIOLATION) || \
  36877. ((a)==ERROR_LOCK_VIOLATION) || \
  36878. ((a)==ERROR_DEV_NOT_EXIST) || \
  36879. ((a)==ERROR_NETNAME_DELETED) || \
  36880. ((a)==ERROR_SEM_TIMEOUT) || \
  36881. ((a)==ERROR_NETWORK_UNREACHABLE))
  36882. #endif
  36883. /*
  36884. ** If a ReadFile() or WriteFile() error occurs, invoke this routine
  36885. ** to see if it should be retried. Return TRUE to retry. Return FALSE
  36886. ** to give up with an error.
  36887. */
  36888. static int winRetryIoerr(int *pnRetry, DWORD *pError){
  36889. DWORD e = osGetLastError();
  36890. if( *pnRetry>=winIoerrRetry ){
  36891. if( pError ){
  36892. *pError = e;
  36893. }
  36894. return 0;
  36895. }
  36896. if( winIoerrCanRetry1(e) ){
  36897. sqlite3_win32_sleep(winIoerrRetryDelay*(1+*pnRetry));
  36898. ++*pnRetry;
  36899. return 1;
  36900. }
  36901. #if defined(winIoerrCanRetry2)
  36902. else if( winIoerrCanRetry2(e) ){
  36903. sqlite3_win32_sleep(winIoerrRetryDelay*(1+*pnRetry));
  36904. ++*pnRetry;
  36905. return 1;
  36906. }
  36907. #endif
  36908. if( pError ){
  36909. *pError = e;
  36910. }
  36911. return 0;
  36912. }
  36913. /*
  36914. ** Log a I/O error retry episode.
  36915. */
  36916. static void winLogIoerr(int nRetry, int lineno){
  36917. if( nRetry ){
  36918. sqlite3_log(SQLITE_NOTICE,
  36919. "delayed %dms for lock/sharing conflict at line %d",
  36920. winIoerrRetryDelay*nRetry*(nRetry+1)/2, lineno
  36921. );
  36922. }
  36923. }
  36924. /*
  36925. ** This #if does not rely on the SQLITE_OS_WINCE define because the
  36926. ** corresponding section in "date.c" cannot use it.
  36927. */
  36928. #if !defined(SQLITE_OMIT_LOCALTIME) && defined(_WIN32_WCE) && \
  36929. (!defined(SQLITE_MSVC_LOCALTIME_API) || !SQLITE_MSVC_LOCALTIME_API)
  36930. /*
  36931. ** The MSVC CRT on Windows CE may not have a localtime() function.
  36932. ** So define a substitute.
  36933. */
  36934. /* # include <time.h> */
  36935. struct tm *__cdecl localtime(const time_t *t)
  36936. {
  36937. static struct tm y;
  36938. FILETIME uTm, lTm;
  36939. SYSTEMTIME pTm;
  36940. sqlite3_int64 t64;
  36941. t64 = *t;
  36942. t64 = (t64 + 11644473600)*10000000;
  36943. uTm.dwLowDateTime = (DWORD)(t64 & 0xFFFFFFFF);
  36944. uTm.dwHighDateTime= (DWORD)(t64 >> 32);
  36945. osFileTimeToLocalFileTime(&uTm,&lTm);
  36946. osFileTimeToSystemTime(&lTm,&pTm);
  36947. y.tm_year = pTm.wYear - 1900;
  36948. y.tm_mon = pTm.wMonth - 1;
  36949. y.tm_wday = pTm.wDayOfWeek;
  36950. y.tm_mday = pTm.wDay;
  36951. y.tm_hour = pTm.wHour;
  36952. y.tm_min = pTm.wMinute;
  36953. y.tm_sec = pTm.wSecond;
  36954. return &y;
  36955. }
  36956. #endif
  36957. #if SQLITE_OS_WINCE
  36958. /*************************************************************************
  36959. ** This section contains code for WinCE only.
  36960. */
  36961. #define HANDLE_TO_WINFILE(a) (winFile*)&((char*)a)[-(int)offsetof(winFile,h)]
  36962. /*
  36963. ** Acquire a lock on the handle h
  36964. */
  36965. static void winceMutexAcquire(HANDLE h){
  36966. DWORD dwErr;
  36967. do {
  36968. dwErr = osWaitForSingleObject(h, INFINITE);
  36969. } while (dwErr != WAIT_OBJECT_0 && dwErr != WAIT_ABANDONED);
  36970. }
  36971. /*
  36972. ** Release a lock acquired by winceMutexAcquire()
  36973. */
  36974. #define winceMutexRelease(h) ReleaseMutex(h)
  36975. /*
  36976. ** Create the mutex and shared memory used for locking in the file
  36977. ** descriptor pFile
  36978. */
  36979. static int winceCreateLock(const char *zFilename, winFile *pFile){
  36980. LPWSTR zTok;
  36981. LPWSTR zName;
  36982. DWORD lastErrno;
  36983. BOOL bLogged = FALSE;
  36984. BOOL bInit = TRUE;
  36985. zName = winUtf8ToUnicode(zFilename);
  36986. if( zName==0 ){
  36987. /* out of memory */
  36988. return SQLITE_IOERR_NOMEM_BKPT;
  36989. }
  36990. /* Initialize the local lockdata */
  36991. memset(&pFile->local, 0, sizeof(pFile->local));
  36992. /* Replace the backslashes from the filename and lowercase it
  36993. ** to derive a mutex name. */
  36994. zTok = osCharLowerW(zName);
  36995. for (;*zTok;zTok++){
  36996. if (*zTok == '\\') *zTok = '_';
  36997. }
  36998. /* Create/open the named mutex */
  36999. pFile->hMutex = osCreateMutexW(NULL, FALSE, zName);
  37000. if (!pFile->hMutex){
  37001. pFile->lastErrno = osGetLastError();
  37002. sqlite3_free(zName);
  37003. return winLogError(SQLITE_IOERR, pFile->lastErrno,
  37004. "winceCreateLock1", zFilename);
  37005. }
  37006. /* Acquire the mutex before continuing */
  37007. winceMutexAcquire(pFile->hMutex);
  37008. /* Since the names of named mutexes, semaphores, file mappings etc are
  37009. ** case-sensitive, take advantage of that by uppercasing the mutex name
  37010. ** and using that as the shared filemapping name.
  37011. */
  37012. osCharUpperW(zName);
  37013. pFile->hShared = osCreateFileMappingW(INVALID_HANDLE_VALUE, NULL,
  37014. PAGE_READWRITE, 0, sizeof(winceLock),
  37015. zName);
  37016. /* Set a flag that indicates we're the first to create the memory so it
  37017. ** must be zero-initialized */
  37018. lastErrno = osGetLastError();
  37019. if (lastErrno == ERROR_ALREADY_EXISTS){
  37020. bInit = FALSE;
  37021. }
  37022. sqlite3_free(zName);
  37023. /* If we succeeded in making the shared memory handle, map it. */
  37024. if( pFile->hShared ){
  37025. pFile->shared = (winceLock*)osMapViewOfFile(pFile->hShared,
  37026. FILE_MAP_READ|FILE_MAP_WRITE, 0, 0, sizeof(winceLock));
  37027. /* If mapping failed, close the shared memory handle and erase it */
  37028. if( !pFile->shared ){
  37029. pFile->lastErrno = osGetLastError();
  37030. winLogError(SQLITE_IOERR, pFile->lastErrno,
  37031. "winceCreateLock2", zFilename);
  37032. bLogged = TRUE;
  37033. osCloseHandle(pFile->hShared);
  37034. pFile->hShared = NULL;
  37035. }
  37036. }
  37037. /* If shared memory could not be created, then close the mutex and fail */
  37038. if( pFile->hShared==NULL ){
  37039. if( !bLogged ){
  37040. pFile->lastErrno = lastErrno;
  37041. winLogError(SQLITE_IOERR, pFile->lastErrno,
  37042. "winceCreateLock3", zFilename);
  37043. bLogged = TRUE;
  37044. }
  37045. winceMutexRelease(pFile->hMutex);
  37046. osCloseHandle(pFile->hMutex);
  37047. pFile->hMutex = NULL;
  37048. return SQLITE_IOERR;
  37049. }
  37050. /* Initialize the shared memory if we're supposed to */
  37051. if( bInit ){
  37052. memset(pFile->shared, 0, sizeof(winceLock));
  37053. }
  37054. winceMutexRelease(pFile->hMutex);
  37055. return SQLITE_OK;
  37056. }
  37057. /*
  37058. ** Destroy the part of winFile that deals with wince locks
  37059. */
  37060. static void winceDestroyLock(winFile *pFile){
  37061. if (pFile->hMutex){
  37062. /* Acquire the mutex */
  37063. winceMutexAcquire(pFile->hMutex);
  37064. /* The following blocks should probably assert in debug mode, but they
  37065. are to cleanup in case any locks remained open */
  37066. if (pFile->local.nReaders){
  37067. pFile->shared->nReaders --;
  37068. }
  37069. if (pFile->local.bReserved){
  37070. pFile->shared->bReserved = FALSE;
  37071. }
  37072. if (pFile->local.bPending){
  37073. pFile->shared->bPending = FALSE;
  37074. }
  37075. if (pFile->local.bExclusive){
  37076. pFile->shared->bExclusive = FALSE;
  37077. }
  37078. /* De-reference and close our copy of the shared memory handle */
  37079. osUnmapViewOfFile(pFile->shared);
  37080. osCloseHandle(pFile->hShared);
  37081. /* Done with the mutex */
  37082. winceMutexRelease(pFile->hMutex);
  37083. osCloseHandle(pFile->hMutex);
  37084. pFile->hMutex = NULL;
  37085. }
  37086. }
  37087. /*
  37088. ** An implementation of the LockFile() API of Windows for CE
  37089. */
  37090. static BOOL winceLockFile(
  37091. LPHANDLE phFile,
  37092. DWORD dwFileOffsetLow,
  37093. DWORD dwFileOffsetHigh,
  37094. DWORD nNumberOfBytesToLockLow,
  37095. DWORD nNumberOfBytesToLockHigh
  37096. ){
  37097. winFile *pFile = HANDLE_TO_WINFILE(phFile);
  37098. BOOL bReturn = FALSE;
  37099. UNUSED_PARAMETER(dwFileOffsetHigh);
  37100. UNUSED_PARAMETER(nNumberOfBytesToLockHigh);
  37101. if (!pFile->hMutex) return TRUE;
  37102. winceMutexAcquire(pFile->hMutex);
  37103. /* Wanting an exclusive lock? */
  37104. if (dwFileOffsetLow == (DWORD)SHARED_FIRST
  37105. && nNumberOfBytesToLockLow == (DWORD)SHARED_SIZE){
  37106. if (pFile->shared->nReaders == 0 && pFile->shared->bExclusive == 0){
  37107. pFile->shared->bExclusive = TRUE;
  37108. pFile->local.bExclusive = TRUE;
  37109. bReturn = TRUE;
  37110. }
  37111. }
  37112. /* Want a read-only lock? */
  37113. else if (dwFileOffsetLow == (DWORD)SHARED_FIRST &&
  37114. nNumberOfBytesToLockLow == 1){
  37115. if (pFile->shared->bExclusive == 0){
  37116. pFile->local.nReaders ++;
  37117. if (pFile->local.nReaders == 1){
  37118. pFile->shared->nReaders ++;
  37119. }
  37120. bReturn = TRUE;
  37121. }
  37122. }
  37123. /* Want a pending lock? */
  37124. else if (dwFileOffsetLow == (DWORD)PENDING_BYTE
  37125. && nNumberOfBytesToLockLow == 1){
  37126. /* If no pending lock has been acquired, then acquire it */
  37127. if (pFile->shared->bPending == 0) {
  37128. pFile->shared->bPending = TRUE;
  37129. pFile->local.bPending = TRUE;
  37130. bReturn = TRUE;
  37131. }
  37132. }
  37133. /* Want a reserved lock? */
  37134. else if (dwFileOffsetLow == (DWORD)RESERVED_BYTE
  37135. && nNumberOfBytesToLockLow == 1){
  37136. if (pFile->shared->bReserved == 0) {
  37137. pFile->shared->bReserved = TRUE;
  37138. pFile->local.bReserved = TRUE;
  37139. bReturn = TRUE;
  37140. }
  37141. }
  37142. winceMutexRelease(pFile->hMutex);
  37143. return bReturn;
  37144. }
  37145. /*
  37146. ** An implementation of the UnlockFile API of Windows for CE
  37147. */
  37148. static BOOL winceUnlockFile(
  37149. LPHANDLE phFile,
  37150. DWORD dwFileOffsetLow,
  37151. DWORD dwFileOffsetHigh,
  37152. DWORD nNumberOfBytesToUnlockLow,
  37153. DWORD nNumberOfBytesToUnlockHigh
  37154. ){
  37155. winFile *pFile = HANDLE_TO_WINFILE(phFile);
  37156. BOOL bReturn = FALSE;
  37157. UNUSED_PARAMETER(dwFileOffsetHigh);
  37158. UNUSED_PARAMETER(nNumberOfBytesToUnlockHigh);
  37159. if (!pFile->hMutex) return TRUE;
  37160. winceMutexAcquire(pFile->hMutex);
  37161. /* Releasing a reader lock or an exclusive lock */
  37162. if (dwFileOffsetLow == (DWORD)SHARED_FIRST){
  37163. /* Did we have an exclusive lock? */
  37164. if (pFile->local.bExclusive){
  37165. assert(nNumberOfBytesToUnlockLow == (DWORD)SHARED_SIZE);
  37166. pFile->local.bExclusive = FALSE;
  37167. pFile->shared->bExclusive = FALSE;
  37168. bReturn = TRUE;
  37169. }
  37170. /* Did we just have a reader lock? */
  37171. else if (pFile->local.nReaders){
  37172. assert(nNumberOfBytesToUnlockLow == (DWORD)SHARED_SIZE
  37173. || nNumberOfBytesToUnlockLow == 1);
  37174. pFile->local.nReaders --;
  37175. if (pFile->local.nReaders == 0)
  37176. {
  37177. pFile->shared->nReaders --;
  37178. }
  37179. bReturn = TRUE;
  37180. }
  37181. }
  37182. /* Releasing a pending lock */
  37183. else if (dwFileOffsetLow == (DWORD)PENDING_BYTE
  37184. && nNumberOfBytesToUnlockLow == 1){
  37185. if (pFile->local.bPending){
  37186. pFile->local.bPending = FALSE;
  37187. pFile->shared->bPending = FALSE;
  37188. bReturn = TRUE;
  37189. }
  37190. }
  37191. /* Releasing a reserved lock */
  37192. else if (dwFileOffsetLow == (DWORD)RESERVED_BYTE
  37193. && nNumberOfBytesToUnlockLow == 1){
  37194. if (pFile->local.bReserved) {
  37195. pFile->local.bReserved = FALSE;
  37196. pFile->shared->bReserved = FALSE;
  37197. bReturn = TRUE;
  37198. }
  37199. }
  37200. winceMutexRelease(pFile->hMutex);
  37201. return bReturn;
  37202. }
  37203. /*
  37204. ** End of the special code for wince
  37205. *****************************************************************************/
  37206. #endif /* SQLITE_OS_WINCE */
  37207. /*
  37208. ** Lock a file region.
  37209. */
  37210. static BOOL winLockFile(
  37211. LPHANDLE phFile,
  37212. DWORD flags,
  37213. DWORD offsetLow,
  37214. DWORD offsetHigh,
  37215. DWORD numBytesLow,
  37216. DWORD numBytesHigh
  37217. ){
  37218. #if SQLITE_OS_WINCE
  37219. /*
  37220. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  37221. ** API LockFile.
  37222. */
  37223. return winceLockFile(phFile, offsetLow, offsetHigh,
  37224. numBytesLow, numBytesHigh);
  37225. #else
  37226. if( osIsNT() ){
  37227. OVERLAPPED ovlp;
  37228. memset(&ovlp, 0, sizeof(OVERLAPPED));
  37229. ovlp.Offset = offsetLow;
  37230. ovlp.OffsetHigh = offsetHigh;
  37231. return osLockFileEx(*phFile, flags, 0, numBytesLow, numBytesHigh, &ovlp);
  37232. }else{
  37233. return osLockFile(*phFile, offsetLow, offsetHigh, numBytesLow,
  37234. numBytesHigh);
  37235. }
  37236. #endif
  37237. }
  37238. /*
  37239. ** Unlock a file region.
  37240. */
  37241. static BOOL winUnlockFile(
  37242. LPHANDLE phFile,
  37243. DWORD offsetLow,
  37244. DWORD offsetHigh,
  37245. DWORD numBytesLow,
  37246. DWORD numBytesHigh
  37247. ){
  37248. #if SQLITE_OS_WINCE
  37249. /*
  37250. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  37251. ** API UnlockFile.
  37252. */
  37253. return winceUnlockFile(phFile, offsetLow, offsetHigh,
  37254. numBytesLow, numBytesHigh);
  37255. #else
  37256. if( osIsNT() ){
  37257. OVERLAPPED ovlp;
  37258. memset(&ovlp, 0, sizeof(OVERLAPPED));
  37259. ovlp.Offset = offsetLow;
  37260. ovlp.OffsetHigh = offsetHigh;
  37261. return osUnlockFileEx(*phFile, 0, numBytesLow, numBytesHigh, &ovlp);
  37262. }else{
  37263. return osUnlockFile(*phFile, offsetLow, offsetHigh, numBytesLow,
  37264. numBytesHigh);
  37265. }
  37266. #endif
  37267. }
  37268. /*****************************************************************************
  37269. ** The next group of routines implement the I/O methods specified
  37270. ** by the sqlite3_io_methods object.
  37271. ******************************************************************************/
  37272. /*
  37273. ** Some Microsoft compilers lack this definition.
  37274. */
  37275. #ifndef INVALID_SET_FILE_POINTER
  37276. # define INVALID_SET_FILE_POINTER ((DWORD)-1)
  37277. #endif
  37278. /*
  37279. ** Move the current position of the file handle passed as the first
  37280. ** argument to offset iOffset within the file. If successful, return 0.
  37281. ** Otherwise, set pFile->lastErrno and return non-zero.
  37282. */
  37283. static int winSeekFile(winFile *pFile, sqlite3_int64 iOffset){
  37284. #if !SQLITE_OS_WINRT
  37285. LONG upperBits; /* Most sig. 32 bits of new offset */
  37286. LONG lowerBits; /* Least sig. 32 bits of new offset */
  37287. DWORD dwRet; /* Value returned by SetFilePointer() */
  37288. DWORD lastErrno; /* Value returned by GetLastError() */
  37289. OSTRACE(("SEEK file=%p, offset=%lld\n", pFile->h, iOffset));
  37290. upperBits = (LONG)((iOffset>>32) & 0x7fffffff);
  37291. lowerBits = (LONG)(iOffset & 0xffffffff);
  37292. /* API oddity: If successful, SetFilePointer() returns a dword
  37293. ** containing the lower 32-bits of the new file-offset. Or, if it fails,
  37294. ** it returns INVALID_SET_FILE_POINTER. However according to MSDN,
  37295. ** INVALID_SET_FILE_POINTER may also be a valid new offset. So to determine
  37296. ** whether an error has actually occurred, it is also necessary to call
  37297. ** GetLastError().
  37298. */
  37299. dwRet = osSetFilePointer(pFile->h, lowerBits, &upperBits, FILE_BEGIN);
  37300. if( (dwRet==INVALID_SET_FILE_POINTER
  37301. && ((lastErrno = osGetLastError())!=NO_ERROR)) ){
  37302. pFile->lastErrno = lastErrno;
  37303. winLogError(SQLITE_IOERR_SEEK, pFile->lastErrno,
  37304. "winSeekFile", pFile->zPath);
  37305. OSTRACE(("SEEK file=%p, rc=SQLITE_IOERR_SEEK\n", pFile->h));
  37306. return 1;
  37307. }
  37308. OSTRACE(("SEEK file=%p, rc=SQLITE_OK\n", pFile->h));
  37309. return 0;
  37310. #else
  37311. /*
  37312. ** Same as above, except that this implementation works for WinRT.
  37313. */
  37314. LARGE_INTEGER x; /* The new offset */
  37315. BOOL bRet; /* Value returned by SetFilePointerEx() */
  37316. x.QuadPart = iOffset;
  37317. bRet = osSetFilePointerEx(pFile->h, x, 0, FILE_BEGIN);
  37318. if(!bRet){
  37319. pFile->lastErrno = osGetLastError();
  37320. winLogError(SQLITE_IOERR_SEEK, pFile->lastErrno,
  37321. "winSeekFile", pFile->zPath);
  37322. OSTRACE(("SEEK file=%p, rc=SQLITE_IOERR_SEEK\n", pFile->h));
  37323. return 1;
  37324. }
  37325. OSTRACE(("SEEK file=%p, rc=SQLITE_OK\n", pFile->h));
  37326. return 0;
  37327. #endif
  37328. }
  37329. #if SQLITE_MAX_MMAP_SIZE>0
  37330. /* Forward references to VFS helper methods used for memory mapped files */
  37331. static int winMapfile(winFile*, sqlite3_int64);
  37332. static int winUnmapfile(winFile*);
  37333. #endif
  37334. /*
  37335. ** Close a file.
  37336. **
  37337. ** It is reported that an attempt to close a handle might sometimes
  37338. ** fail. This is a very unreasonable result, but Windows is notorious
  37339. ** for being unreasonable so I do not doubt that it might happen. If
  37340. ** the close fails, we pause for 100 milliseconds and try again. As
  37341. ** many as MX_CLOSE_ATTEMPT attempts to close the handle are made before
  37342. ** giving up and returning an error.
  37343. */
  37344. #define MX_CLOSE_ATTEMPT 3
  37345. static int winClose(sqlite3_file *id){
  37346. int rc, cnt = 0;
  37347. winFile *pFile = (winFile*)id;
  37348. assert( id!=0 );
  37349. #ifndef SQLITE_OMIT_WAL
  37350. assert( pFile->pShm==0 );
  37351. #endif
  37352. assert( pFile->h!=NULL && pFile->h!=INVALID_HANDLE_VALUE );
  37353. OSTRACE(("CLOSE pid=%lu, pFile=%p, file=%p\n",
  37354. osGetCurrentProcessId(), pFile, pFile->h));
  37355. #if SQLITE_MAX_MMAP_SIZE>0
  37356. winUnmapfile(pFile);
  37357. #endif
  37358. do{
  37359. rc = osCloseHandle(pFile->h);
  37360. /* SimulateIOError( rc=0; cnt=MX_CLOSE_ATTEMPT; ); */
  37361. }while( rc==0 && ++cnt < MX_CLOSE_ATTEMPT && (sqlite3_win32_sleep(100), 1) );
  37362. #if SQLITE_OS_WINCE
  37363. #define WINCE_DELETION_ATTEMPTS 3
  37364. {
  37365. winVfsAppData *pAppData = (winVfsAppData*)pFile->pVfs->pAppData;
  37366. if( pAppData==NULL || !pAppData->bNoLock ){
  37367. winceDestroyLock(pFile);
  37368. }
  37369. }
  37370. if( pFile->zDeleteOnClose ){
  37371. int cnt = 0;
  37372. while(
  37373. osDeleteFileW(pFile->zDeleteOnClose)==0
  37374. && osGetFileAttributesW(pFile->zDeleteOnClose)!=0xffffffff
  37375. && cnt++ < WINCE_DELETION_ATTEMPTS
  37376. ){
  37377. sqlite3_win32_sleep(100); /* Wait a little before trying again */
  37378. }
  37379. sqlite3_free(pFile->zDeleteOnClose);
  37380. }
  37381. #endif
  37382. if( rc ){
  37383. pFile->h = NULL;
  37384. }
  37385. OpenCounter(-1);
  37386. OSTRACE(("CLOSE pid=%lu, pFile=%p, file=%p, rc=%s\n",
  37387. osGetCurrentProcessId(), pFile, pFile->h, rc ? "ok" : "failed"));
  37388. return rc ? SQLITE_OK
  37389. : winLogError(SQLITE_IOERR_CLOSE, osGetLastError(),
  37390. "winClose", pFile->zPath);
  37391. }
  37392. /*
  37393. ** Read data from a file into a buffer. Return SQLITE_OK if all
  37394. ** bytes were read successfully and SQLITE_IOERR if anything goes
  37395. ** wrong.
  37396. */
  37397. static int winRead(
  37398. sqlite3_file *id, /* File to read from */
  37399. void *pBuf, /* Write content into this buffer */
  37400. int amt, /* Number of bytes to read */
  37401. sqlite3_int64 offset /* Begin reading at this offset */
  37402. ){
  37403. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  37404. OVERLAPPED overlapped; /* The offset for ReadFile. */
  37405. #endif
  37406. winFile *pFile = (winFile*)id; /* file handle */
  37407. DWORD nRead; /* Number of bytes actually read from file */
  37408. int nRetry = 0; /* Number of retrys */
  37409. assert( id!=0 );
  37410. assert( amt>0 );
  37411. assert( offset>=0 );
  37412. SimulateIOError(return SQLITE_IOERR_READ);
  37413. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, buffer=%p, amount=%d, "
  37414. "offset=%lld, lock=%d\n", osGetCurrentProcessId(), pFile,
  37415. pFile->h, pBuf, amt, offset, pFile->locktype));
  37416. #if SQLITE_MAX_MMAP_SIZE>0
  37417. /* Deal with as much of this read request as possible by transfering
  37418. ** data from the memory mapping using memcpy(). */
  37419. if( offset<pFile->mmapSize ){
  37420. if( offset+amt <= pFile->mmapSize ){
  37421. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], amt);
  37422. OSTRACE(("READ-MMAP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37423. osGetCurrentProcessId(), pFile, pFile->h));
  37424. return SQLITE_OK;
  37425. }else{
  37426. int nCopy = (int)(pFile->mmapSize - offset);
  37427. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], nCopy);
  37428. pBuf = &((u8 *)pBuf)[nCopy];
  37429. amt -= nCopy;
  37430. offset += nCopy;
  37431. }
  37432. }
  37433. #endif
  37434. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  37435. if( winSeekFile(pFile, offset) ){
  37436. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_FULL\n",
  37437. osGetCurrentProcessId(), pFile, pFile->h));
  37438. return SQLITE_FULL;
  37439. }
  37440. while( !osReadFile(pFile->h, pBuf, amt, &nRead, 0) ){
  37441. #else
  37442. memset(&overlapped, 0, sizeof(OVERLAPPED));
  37443. overlapped.Offset = (LONG)(offset & 0xffffffff);
  37444. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  37445. while( !osReadFile(pFile->h, pBuf, amt, &nRead, &overlapped) &&
  37446. osGetLastError()!=ERROR_HANDLE_EOF ){
  37447. #endif
  37448. DWORD lastErrno;
  37449. if( winRetryIoerr(&nRetry, &lastErrno) ) continue;
  37450. pFile->lastErrno = lastErrno;
  37451. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_READ\n",
  37452. osGetCurrentProcessId(), pFile, pFile->h));
  37453. return winLogError(SQLITE_IOERR_READ, pFile->lastErrno,
  37454. "winRead", pFile->zPath);
  37455. }
  37456. winLogIoerr(nRetry, __LINE__);
  37457. if( nRead<(DWORD)amt ){
  37458. /* Unread parts of the buffer must be zero-filled */
  37459. memset(&((char*)pBuf)[nRead], 0, amt-nRead);
  37460. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_SHORT_READ\n",
  37461. osGetCurrentProcessId(), pFile, pFile->h));
  37462. return SQLITE_IOERR_SHORT_READ;
  37463. }
  37464. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37465. osGetCurrentProcessId(), pFile, pFile->h));
  37466. return SQLITE_OK;
  37467. }
  37468. /*
  37469. ** Write data from a buffer into a file. Return SQLITE_OK on success
  37470. ** or some other error code on failure.
  37471. */
  37472. static int winWrite(
  37473. sqlite3_file *id, /* File to write into */
  37474. const void *pBuf, /* The bytes to be written */
  37475. int amt, /* Number of bytes to write */
  37476. sqlite3_int64 offset /* Offset into the file to begin writing at */
  37477. ){
  37478. int rc = 0; /* True if error has occurred, else false */
  37479. winFile *pFile = (winFile*)id; /* File handle */
  37480. int nRetry = 0; /* Number of retries */
  37481. assert( amt>0 );
  37482. assert( pFile );
  37483. SimulateIOError(return SQLITE_IOERR_WRITE);
  37484. SimulateDiskfullError(return SQLITE_FULL);
  37485. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, buffer=%p, amount=%d, "
  37486. "offset=%lld, lock=%d\n", osGetCurrentProcessId(), pFile,
  37487. pFile->h, pBuf, amt, offset, pFile->locktype));
  37488. #if defined(SQLITE_MMAP_READWRITE) && SQLITE_MAX_MMAP_SIZE>0
  37489. /* Deal with as much of this write request as possible by transfering
  37490. ** data from the memory mapping using memcpy(). */
  37491. if( offset<pFile->mmapSize ){
  37492. if( offset+amt <= pFile->mmapSize ){
  37493. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, amt);
  37494. OSTRACE(("WRITE-MMAP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37495. osGetCurrentProcessId(), pFile, pFile->h));
  37496. return SQLITE_OK;
  37497. }else{
  37498. int nCopy = (int)(pFile->mmapSize - offset);
  37499. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, nCopy);
  37500. pBuf = &((u8 *)pBuf)[nCopy];
  37501. amt -= nCopy;
  37502. offset += nCopy;
  37503. }
  37504. }
  37505. #endif
  37506. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  37507. rc = winSeekFile(pFile, offset);
  37508. if( rc==0 ){
  37509. #else
  37510. {
  37511. #endif
  37512. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  37513. OVERLAPPED overlapped; /* The offset for WriteFile. */
  37514. #endif
  37515. u8 *aRem = (u8 *)pBuf; /* Data yet to be written */
  37516. int nRem = amt; /* Number of bytes yet to be written */
  37517. DWORD nWrite; /* Bytes written by each WriteFile() call */
  37518. DWORD lastErrno = NO_ERROR; /* Value returned by GetLastError() */
  37519. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  37520. memset(&overlapped, 0, sizeof(OVERLAPPED));
  37521. overlapped.Offset = (LONG)(offset & 0xffffffff);
  37522. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  37523. #endif
  37524. while( nRem>0 ){
  37525. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  37526. if( !osWriteFile(pFile->h, aRem, nRem, &nWrite, 0) ){
  37527. #else
  37528. if( !osWriteFile(pFile->h, aRem, nRem, &nWrite, &overlapped) ){
  37529. #endif
  37530. if( winRetryIoerr(&nRetry, &lastErrno) ) continue;
  37531. break;
  37532. }
  37533. assert( nWrite==0 || nWrite<=(DWORD)nRem );
  37534. if( nWrite==0 || nWrite>(DWORD)nRem ){
  37535. lastErrno = osGetLastError();
  37536. break;
  37537. }
  37538. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  37539. offset += nWrite;
  37540. overlapped.Offset = (LONG)(offset & 0xffffffff);
  37541. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  37542. #endif
  37543. aRem += nWrite;
  37544. nRem -= nWrite;
  37545. }
  37546. if( nRem>0 ){
  37547. pFile->lastErrno = lastErrno;
  37548. rc = 1;
  37549. }
  37550. }
  37551. if( rc ){
  37552. if( ( pFile->lastErrno==ERROR_HANDLE_DISK_FULL )
  37553. || ( pFile->lastErrno==ERROR_DISK_FULL )){
  37554. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_FULL\n",
  37555. osGetCurrentProcessId(), pFile, pFile->h));
  37556. return winLogError(SQLITE_FULL, pFile->lastErrno,
  37557. "winWrite1", pFile->zPath);
  37558. }
  37559. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_WRITE\n",
  37560. osGetCurrentProcessId(), pFile, pFile->h));
  37561. return winLogError(SQLITE_IOERR_WRITE, pFile->lastErrno,
  37562. "winWrite2", pFile->zPath);
  37563. }else{
  37564. winLogIoerr(nRetry, __LINE__);
  37565. }
  37566. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37567. osGetCurrentProcessId(), pFile, pFile->h));
  37568. return SQLITE_OK;
  37569. }
  37570. /*
  37571. ** Truncate an open file to a specified size
  37572. */
  37573. static int winTruncate(sqlite3_file *id, sqlite3_int64 nByte){
  37574. winFile *pFile = (winFile*)id; /* File handle object */
  37575. int rc = SQLITE_OK; /* Return code for this function */
  37576. DWORD lastErrno;
  37577. assert( pFile );
  37578. SimulateIOError(return SQLITE_IOERR_TRUNCATE);
  37579. OSTRACE(("TRUNCATE pid=%lu, pFile=%p, file=%p, size=%lld, lock=%d\n",
  37580. osGetCurrentProcessId(), pFile, pFile->h, nByte, pFile->locktype));
  37581. /* If the user has configured a chunk-size for this file, truncate the
  37582. ** file so that it consists of an integer number of chunks (i.e. the
  37583. ** actual file size after the operation may be larger than the requested
  37584. ** size).
  37585. */
  37586. if( pFile->szChunk>0 ){
  37587. nByte = ((nByte + pFile->szChunk - 1)/pFile->szChunk) * pFile->szChunk;
  37588. }
  37589. /* SetEndOfFile() returns non-zero when successful, or zero when it fails. */
  37590. if( winSeekFile(pFile, nByte) ){
  37591. rc = winLogError(SQLITE_IOERR_TRUNCATE, pFile->lastErrno,
  37592. "winTruncate1", pFile->zPath);
  37593. }else if( 0==osSetEndOfFile(pFile->h) &&
  37594. ((lastErrno = osGetLastError())!=ERROR_USER_MAPPED_FILE) ){
  37595. pFile->lastErrno = lastErrno;
  37596. rc = winLogError(SQLITE_IOERR_TRUNCATE, pFile->lastErrno,
  37597. "winTruncate2", pFile->zPath);
  37598. }
  37599. #if SQLITE_MAX_MMAP_SIZE>0
  37600. /* If the file was truncated to a size smaller than the currently
  37601. ** mapped region, reduce the effective mapping size as well. SQLite will
  37602. ** use read() and write() to access data beyond this point from now on.
  37603. */
  37604. if( pFile->pMapRegion && nByte<pFile->mmapSize ){
  37605. pFile->mmapSize = nByte;
  37606. }
  37607. #endif
  37608. OSTRACE(("TRUNCATE pid=%lu, pFile=%p, file=%p, rc=%s\n",
  37609. osGetCurrentProcessId(), pFile, pFile->h, sqlite3ErrName(rc)));
  37610. return rc;
  37611. }
  37612. #ifdef SQLITE_TEST
  37613. /*
  37614. ** Count the number of fullsyncs and normal syncs. This is used to test
  37615. ** that syncs and fullsyncs are occuring at the right times.
  37616. */
  37617. SQLITE_API int sqlite3_sync_count = 0;
  37618. SQLITE_API int sqlite3_fullsync_count = 0;
  37619. #endif
  37620. /*
  37621. ** Make sure all writes to a particular file are committed to disk.
  37622. */
  37623. static int winSync(sqlite3_file *id, int flags){
  37624. #ifndef SQLITE_NO_SYNC
  37625. /*
  37626. ** Used only when SQLITE_NO_SYNC is not defined.
  37627. */
  37628. BOOL rc;
  37629. #endif
  37630. #if !defined(NDEBUG) || !defined(SQLITE_NO_SYNC) || \
  37631. defined(SQLITE_HAVE_OS_TRACE)
  37632. /*
  37633. ** Used when SQLITE_NO_SYNC is not defined and by the assert() and/or
  37634. ** OSTRACE() macros.
  37635. */
  37636. winFile *pFile = (winFile*)id;
  37637. #else
  37638. UNUSED_PARAMETER(id);
  37639. #endif
  37640. assert( pFile );
  37641. /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
  37642. assert((flags&0x0F)==SQLITE_SYNC_NORMAL
  37643. || (flags&0x0F)==SQLITE_SYNC_FULL
  37644. );
  37645. /* Unix cannot, but some systems may return SQLITE_FULL from here. This
  37646. ** line is to test that doing so does not cause any problems.
  37647. */
  37648. SimulateDiskfullError( return SQLITE_FULL );
  37649. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, flags=%x, lock=%d\n",
  37650. osGetCurrentProcessId(), pFile, pFile->h, flags,
  37651. pFile->locktype));
  37652. #ifndef SQLITE_TEST
  37653. UNUSED_PARAMETER(flags);
  37654. #else
  37655. if( (flags&0x0F)==SQLITE_SYNC_FULL ){
  37656. sqlite3_fullsync_count++;
  37657. }
  37658. sqlite3_sync_count++;
  37659. #endif
  37660. /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
  37661. ** no-op
  37662. */
  37663. #ifdef SQLITE_NO_SYNC
  37664. OSTRACE(("SYNC-NOP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37665. osGetCurrentProcessId(), pFile, pFile->h));
  37666. return SQLITE_OK;
  37667. #else
  37668. #if SQLITE_MAX_MMAP_SIZE>0
  37669. if( pFile->pMapRegion ){
  37670. if( osFlushViewOfFile(pFile->pMapRegion, 0) ){
  37671. OSTRACE(("SYNC-MMAP pid=%lu, pFile=%p, pMapRegion=%p, "
  37672. "rc=SQLITE_OK\n", osGetCurrentProcessId(),
  37673. pFile, pFile->pMapRegion));
  37674. }else{
  37675. pFile->lastErrno = osGetLastError();
  37676. OSTRACE(("SYNC-MMAP pid=%lu, pFile=%p, pMapRegion=%p, "
  37677. "rc=SQLITE_IOERR_MMAP\n", osGetCurrentProcessId(),
  37678. pFile, pFile->pMapRegion));
  37679. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  37680. "winSync1", pFile->zPath);
  37681. }
  37682. }
  37683. #endif
  37684. rc = osFlushFileBuffers(pFile->h);
  37685. SimulateIOError( rc=FALSE );
  37686. if( rc ){
  37687. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  37688. osGetCurrentProcessId(), pFile, pFile->h));
  37689. return SQLITE_OK;
  37690. }else{
  37691. pFile->lastErrno = osGetLastError();
  37692. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_FSYNC\n",
  37693. osGetCurrentProcessId(), pFile, pFile->h));
  37694. return winLogError(SQLITE_IOERR_FSYNC, pFile->lastErrno,
  37695. "winSync2", pFile->zPath);
  37696. }
  37697. #endif
  37698. }
  37699. /*
  37700. ** Determine the current size of a file in bytes
  37701. */
  37702. static int winFileSize(sqlite3_file *id, sqlite3_int64 *pSize){
  37703. winFile *pFile = (winFile*)id;
  37704. int rc = SQLITE_OK;
  37705. assert( id!=0 );
  37706. assert( pSize!=0 );
  37707. SimulateIOError(return SQLITE_IOERR_FSTAT);
  37708. OSTRACE(("SIZE file=%p, pSize=%p\n", pFile->h, pSize));
  37709. #if SQLITE_OS_WINRT
  37710. {
  37711. FILE_STANDARD_INFO info;
  37712. if( osGetFileInformationByHandleEx(pFile->h, FileStandardInfo,
  37713. &info, sizeof(info)) ){
  37714. *pSize = info.EndOfFile.QuadPart;
  37715. }else{
  37716. pFile->lastErrno = osGetLastError();
  37717. rc = winLogError(SQLITE_IOERR_FSTAT, pFile->lastErrno,
  37718. "winFileSize", pFile->zPath);
  37719. }
  37720. }
  37721. #else
  37722. {
  37723. DWORD upperBits;
  37724. DWORD lowerBits;
  37725. DWORD lastErrno;
  37726. lowerBits = osGetFileSize(pFile->h, &upperBits);
  37727. *pSize = (((sqlite3_int64)upperBits)<<32) + lowerBits;
  37728. if( (lowerBits == INVALID_FILE_SIZE)
  37729. && ((lastErrno = osGetLastError())!=NO_ERROR) ){
  37730. pFile->lastErrno = lastErrno;
  37731. rc = winLogError(SQLITE_IOERR_FSTAT, pFile->lastErrno,
  37732. "winFileSize", pFile->zPath);
  37733. }
  37734. }
  37735. #endif
  37736. OSTRACE(("SIZE file=%p, pSize=%p, *pSize=%lld, rc=%s\n",
  37737. pFile->h, pSize, *pSize, sqlite3ErrName(rc)));
  37738. return rc;
  37739. }
  37740. /*
  37741. ** LOCKFILE_FAIL_IMMEDIATELY is undefined on some Windows systems.
  37742. */
  37743. #ifndef LOCKFILE_FAIL_IMMEDIATELY
  37744. # define LOCKFILE_FAIL_IMMEDIATELY 1
  37745. #endif
  37746. #ifndef LOCKFILE_EXCLUSIVE_LOCK
  37747. # define LOCKFILE_EXCLUSIVE_LOCK 2
  37748. #endif
  37749. /*
  37750. ** Historically, SQLite has used both the LockFile and LockFileEx functions.
  37751. ** When the LockFile function was used, it was always expected to fail
  37752. ** immediately if the lock could not be obtained. Also, it always expected to
  37753. ** obtain an exclusive lock. These flags are used with the LockFileEx function
  37754. ** and reflect those expectations; therefore, they should not be changed.
  37755. */
  37756. #ifndef SQLITE_LOCKFILE_FLAGS
  37757. # define SQLITE_LOCKFILE_FLAGS (LOCKFILE_FAIL_IMMEDIATELY | \
  37758. LOCKFILE_EXCLUSIVE_LOCK)
  37759. #endif
  37760. /*
  37761. ** Currently, SQLite never calls the LockFileEx function without wanting the
  37762. ** call to fail immediately if the lock cannot be obtained.
  37763. */
  37764. #ifndef SQLITE_LOCKFILEEX_FLAGS
  37765. # define SQLITE_LOCKFILEEX_FLAGS (LOCKFILE_FAIL_IMMEDIATELY)
  37766. #endif
  37767. /*
  37768. ** Acquire a reader lock.
  37769. ** Different API routines are called depending on whether or not this
  37770. ** is Win9x or WinNT.
  37771. */
  37772. static int winGetReadLock(winFile *pFile){
  37773. int res;
  37774. OSTRACE(("READ-LOCK file=%p, lock=%d\n", pFile->h, pFile->locktype));
  37775. if( osIsNT() ){
  37776. #if SQLITE_OS_WINCE
  37777. /*
  37778. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  37779. ** API LockFileEx.
  37780. */
  37781. res = winceLockFile(&pFile->h, SHARED_FIRST, 0, 1, 0);
  37782. #else
  37783. res = winLockFile(&pFile->h, SQLITE_LOCKFILEEX_FLAGS, SHARED_FIRST, 0,
  37784. SHARED_SIZE, 0);
  37785. #endif
  37786. }
  37787. #ifdef SQLITE_WIN32_HAS_ANSI
  37788. else{
  37789. int lk;
  37790. sqlite3_randomness(sizeof(lk), &lk);
  37791. pFile->sharedLockByte = (short)((lk & 0x7fffffff)%(SHARED_SIZE - 1));
  37792. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS,
  37793. SHARED_FIRST+pFile->sharedLockByte, 0, 1, 0);
  37794. }
  37795. #endif
  37796. if( res == 0 ){
  37797. pFile->lastErrno = osGetLastError();
  37798. /* No need to log a failure to lock */
  37799. }
  37800. OSTRACE(("READ-LOCK file=%p, result=%d\n", pFile->h, res));
  37801. return res;
  37802. }
  37803. /*
  37804. ** Undo a readlock
  37805. */
  37806. static int winUnlockReadLock(winFile *pFile){
  37807. int res;
  37808. DWORD lastErrno;
  37809. OSTRACE(("READ-UNLOCK file=%p, lock=%d\n", pFile->h, pFile->locktype));
  37810. if( osIsNT() ){
  37811. res = winUnlockFile(&pFile->h, SHARED_FIRST, 0, SHARED_SIZE, 0);
  37812. }
  37813. #ifdef SQLITE_WIN32_HAS_ANSI
  37814. else{
  37815. res = winUnlockFile(&pFile->h, SHARED_FIRST+pFile->sharedLockByte, 0, 1, 0);
  37816. }
  37817. #endif
  37818. if( res==0 && ((lastErrno = osGetLastError())!=ERROR_NOT_LOCKED) ){
  37819. pFile->lastErrno = lastErrno;
  37820. winLogError(SQLITE_IOERR_UNLOCK, pFile->lastErrno,
  37821. "winUnlockReadLock", pFile->zPath);
  37822. }
  37823. OSTRACE(("READ-UNLOCK file=%p, result=%d\n", pFile->h, res));
  37824. return res;
  37825. }
  37826. /*
  37827. ** Lock the file with the lock specified by parameter locktype - one
  37828. ** of the following:
  37829. **
  37830. ** (1) SHARED_LOCK
  37831. ** (2) RESERVED_LOCK
  37832. ** (3) PENDING_LOCK
  37833. ** (4) EXCLUSIVE_LOCK
  37834. **
  37835. ** Sometimes when requesting one lock state, additional lock states
  37836. ** are inserted in between. The locking might fail on one of the later
  37837. ** transitions leaving the lock state different from what it started but
  37838. ** still short of its goal. The following chart shows the allowed
  37839. ** transitions and the inserted intermediate states:
  37840. **
  37841. ** UNLOCKED -> SHARED
  37842. ** SHARED -> RESERVED
  37843. ** SHARED -> (PENDING) -> EXCLUSIVE
  37844. ** RESERVED -> (PENDING) -> EXCLUSIVE
  37845. ** PENDING -> EXCLUSIVE
  37846. **
  37847. ** This routine will only increase a lock. The winUnlock() routine
  37848. ** erases all locks at once and returns us immediately to locking level 0.
  37849. ** It is not possible to lower the locking level one step at a time. You
  37850. ** must go straight to locking level 0.
  37851. */
  37852. static int winLock(sqlite3_file *id, int locktype){
  37853. int rc = SQLITE_OK; /* Return code from subroutines */
  37854. int res = 1; /* Result of a Windows lock call */
  37855. int newLocktype; /* Set pFile->locktype to this value before exiting */
  37856. int gotPendingLock = 0;/* True if we acquired a PENDING lock this time */
  37857. winFile *pFile = (winFile*)id;
  37858. DWORD lastErrno = NO_ERROR;
  37859. assert( id!=0 );
  37860. OSTRACE(("LOCK file=%p, oldLock=%d(%d), newLock=%d\n",
  37861. pFile->h, pFile->locktype, pFile->sharedLockByte, locktype));
  37862. /* If there is already a lock of this type or more restrictive on the
  37863. ** OsFile, do nothing. Don't use the end_lock: exit path, as
  37864. ** sqlite3OsEnterMutex() hasn't been called yet.
  37865. */
  37866. if( pFile->locktype>=locktype ){
  37867. OSTRACE(("LOCK-HELD file=%p, rc=SQLITE_OK\n", pFile->h));
  37868. return SQLITE_OK;
  37869. }
  37870. /* Do not allow any kind of write-lock on a read-only database
  37871. */
  37872. if( (pFile->ctrlFlags & WINFILE_RDONLY)!=0 && locktype>=RESERVED_LOCK ){
  37873. return SQLITE_IOERR_LOCK;
  37874. }
  37875. /* Make sure the locking sequence is correct
  37876. */
  37877. assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
  37878. assert( locktype!=PENDING_LOCK );
  37879. assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
  37880. /* Lock the PENDING_LOCK byte if we need to acquire a PENDING lock or
  37881. ** a SHARED lock. If we are acquiring a SHARED lock, the acquisition of
  37882. ** the PENDING_LOCK byte is temporary.
  37883. */
  37884. newLocktype = pFile->locktype;
  37885. if( pFile->locktype==NO_LOCK
  37886. || (locktype==EXCLUSIVE_LOCK && pFile->locktype<=RESERVED_LOCK)
  37887. ){
  37888. int cnt = 3;
  37889. while( cnt-->0 && (res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS,
  37890. PENDING_BYTE, 0, 1, 0))==0 ){
  37891. /* Try 3 times to get the pending lock. This is needed to work
  37892. ** around problems caused by indexing and/or anti-virus software on
  37893. ** Windows systems.
  37894. ** If you are using this code as a model for alternative VFSes, do not
  37895. ** copy this retry logic. It is a hack intended for Windows only.
  37896. */
  37897. lastErrno = osGetLastError();
  37898. OSTRACE(("LOCK-PENDING-FAIL file=%p, count=%d, result=%d\n",
  37899. pFile->h, cnt, res));
  37900. if( lastErrno==ERROR_INVALID_HANDLE ){
  37901. pFile->lastErrno = lastErrno;
  37902. rc = SQLITE_IOERR_LOCK;
  37903. OSTRACE(("LOCK-FAIL file=%p, count=%d, rc=%s\n",
  37904. pFile->h, cnt, sqlite3ErrName(rc)));
  37905. return rc;
  37906. }
  37907. if( cnt ) sqlite3_win32_sleep(1);
  37908. }
  37909. gotPendingLock = res;
  37910. if( !res ){
  37911. lastErrno = osGetLastError();
  37912. }
  37913. }
  37914. /* Acquire a shared lock
  37915. */
  37916. if( locktype==SHARED_LOCK && res ){
  37917. assert( pFile->locktype==NO_LOCK );
  37918. res = winGetReadLock(pFile);
  37919. if( res ){
  37920. newLocktype = SHARED_LOCK;
  37921. }else{
  37922. lastErrno = osGetLastError();
  37923. }
  37924. }
  37925. /* Acquire a RESERVED lock
  37926. */
  37927. if( locktype==RESERVED_LOCK && res ){
  37928. assert( pFile->locktype==SHARED_LOCK );
  37929. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS, RESERVED_BYTE, 0, 1, 0);
  37930. if( res ){
  37931. newLocktype = RESERVED_LOCK;
  37932. }else{
  37933. lastErrno = osGetLastError();
  37934. }
  37935. }
  37936. /* Acquire a PENDING lock
  37937. */
  37938. if( locktype==EXCLUSIVE_LOCK && res ){
  37939. newLocktype = PENDING_LOCK;
  37940. gotPendingLock = 0;
  37941. }
  37942. /* Acquire an EXCLUSIVE lock
  37943. */
  37944. if( locktype==EXCLUSIVE_LOCK && res ){
  37945. assert( pFile->locktype>=SHARED_LOCK );
  37946. res = winUnlockReadLock(pFile);
  37947. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS, SHARED_FIRST, 0,
  37948. SHARED_SIZE, 0);
  37949. if( res ){
  37950. newLocktype = EXCLUSIVE_LOCK;
  37951. }else{
  37952. lastErrno = osGetLastError();
  37953. winGetReadLock(pFile);
  37954. }
  37955. }
  37956. /* If we are holding a PENDING lock that ought to be released, then
  37957. ** release it now.
  37958. */
  37959. if( gotPendingLock && locktype==SHARED_LOCK ){
  37960. winUnlockFile(&pFile->h, PENDING_BYTE, 0, 1, 0);
  37961. }
  37962. /* Update the state of the lock has held in the file descriptor then
  37963. ** return the appropriate result code.
  37964. */
  37965. if( res ){
  37966. rc = SQLITE_OK;
  37967. }else{
  37968. pFile->lastErrno = lastErrno;
  37969. rc = SQLITE_BUSY;
  37970. OSTRACE(("LOCK-FAIL file=%p, wanted=%d, got=%d\n",
  37971. pFile->h, locktype, newLocktype));
  37972. }
  37973. pFile->locktype = (u8)newLocktype;
  37974. OSTRACE(("LOCK file=%p, lock=%d, rc=%s\n",
  37975. pFile->h, pFile->locktype, sqlite3ErrName(rc)));
  37976. return rc;
  37977. }
  37978. /*
  37979. ** This routine checks if there is a RESERVED lock held on the specified
  37980. ** file by this or any other process. If such a lock is held, return
  37981. ** non-zero, otherwise zero.
  37982. */
  37983. static int winCheckReservedLock(sqlite3_file *id, int *pResOut){
  37984. int res;
  37985. winFile *pFile = (winFile*)id;
  37986. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  37987. OSTRACE(("TEST-WR-LOCK file=%p, pResOut=%p\n", pFile->h, pResOut));
  37988. assert( id!=0 );
  37989. if( pFile->locktype>=RESERVED_LOCK ){
  37990. res = 1;
  37991. OSTRACE(("TEST-WR-LOCK file=%p, result=%d (local)\n", pFile->h, res));
  37992. }else{
  37993. res = winLockFile(&pFile->h, SQLITE_LOCKFILEEX_FLAGS,RESERVED_BYTE,0,1,0);
  37994. if( res ){
  37995. winUnlockFile(&pFile->h, RESERVED_BYTE, 0, 1, 0);
  37996. }
  37997. res = !res;
  37998. OSTRACE(("TEST-WR-LOCK file=%p, result=%d (remote)\n", pFile->h, res));
  37999. }
  38000. *pResOut = res;
  38001. OSTRACE(("TEST-WR-LOCK file=%p, pResOut=%p, *pResOut=%d, rc=SQLITE_OK\n",
  38002. pFile->h, pResOut, *pResOut));
  38003. return SQLITE_OK;
  38004. }
  38005. /*
  38006. ** Lower the locking level on file descriptor id to locktype. locktype
  38007. ** must be either NO_LOCK or SHARED_LOCK.
  38008. **
  38009. ** If the locking level of the file descriptor is already at or below
  38010. ** the requested locking level, this routine is a no-op.
  38011. **
  38012. ** It is not possible for this routine to fail if the second argument
  38013. ** is NO_LOCK. If the second argument is SHARED_LOCK then this routine
  38014. ** might return SQLITE_IOERR;
  38015. */
  38016. static int winUnlock(sqlite3_file *id, int locktype){
  38017. int type;
  38018. winFile *pFile = (winFile*)id;
  38019. int rc = SQLITE_OK;
  38020. assert( pFile!=0 );
  38021. assert( locktype<=SHARED_LOCK );
  38022. OSTRACE(("UNLOCK file=%p, oldLock=%d(%d), newLock=%d\n",
  38023. pFile->h, pFile->locktype, pFile->sharedLockByte, locktype));
  38024. type = pFile->locktype;
  38025. if( type>=EXCLUSIVE_LOCK ){
  38026. winUnlockFile(&pFile->h, SHARED_FIRST, 0, SHARED_SIZE, 0);
  38027. if( locktype==SHARED_LOCK && !winGetReadLock(pFile) ){
  38028. /* This should never happen. We should always be able to
  38029. ** reacquire the read lock */
  38030. rc = winLogError(SQLITE_IOERR_UNLOCK, osGetLastError(),
  38031. "winUnlock", pFile->zPath);
  38032. }
  38033. }
  38034. if( type>=RESERVED_LOCK ){
  38035. winUnlockFile(&pFile->h, RESERVED_BYTE, 0, 1, 0);
  38036. }
  38037. if( locktype==NO_LOCK && type>=SHARED_LOCK ){
  38038. winUnlockReadLock(pFile);
  38039. }
  38040. if( type>=PENDING_LOCK ){
  38041. winUnlockFile(&pFile->h, PENDING_BYTE, 0, 1, 0);
  38042. }
  38043. pFile->locktype = (u8)locktype;
  38044. OSTRACE(("UNLOCK file=%p, lock=%d, rc=%s\n",
  38045. pFile->h, pFile->locktype, sqlite3ErrName(rc)));
  38046. return rc;
  38047. }
  38048. /******************************************************************************
  38049. ****************************** No-op Locking **********************************
  38050. **
  38051. ** Of the various locking implementations available, this is by far the
  38052. ** simplest: locking is ignored. No attempt is made to lock the database
  38053. ** file for reading or writing.
  38054. **
  38055. ** This locking mode is appropriate for use on read-only databases
  38056. ** (ex: databases that are burned into CD-ROM, for example.) It can
  38057. ** also be used if the application employs some external mechanism to
  38058. ** prevent simultaneous access of the same database by two or more
  38059. ** database connections. But there is a serious risk of database
  38060. ** corruption if this locking mode is used in situations where multiple
  38061. ** database connections are accessing the same database file at the same
  38062. ** time and one or more of those connections are writing.
  38063. */
  38064. static int winNolockLock(sqlite3_file *id, int locktype){
  38065. UNUSED_PARAMETER(id);
  38066. UNUSED_PARAMETER(locktype);
  38067. return SQLITE_OK;
  38068. }
  38069. static int winNolockCheckReservedLock(sqlite3_file *id, int *pResOut){
  38070. UNUSED_PARAMETER(id);
  38071. UNUSED_PARAMETER(pResOut);
  38072. return SQLITE_OK;
  38073. }
  38074. static int winNolockUnlock(sqlite3_file *id, int locktype){
  38075. UNUSED_PARAMETER(id);
  38076. UNUSED_PARAMETER(locktype);
  38077. return SQLITE_OK;
  38078. }
  38079. /******************* End of the no-op lock implementation *********************
  38080. ******************************************************************************/
  38081. /*
  38082. ** If *pArg is initially negative then this is a query. Set *pArg to
  38083. ** 1 or 0 depending on whether or not bit mask of pFile->ctrlFlags is set.
  38084. **
  38085. ** If *pArg is 0 or 1, then clear or set the mask bit of pFile->ctrlFlags.
  38086. */
  38087. static void winModeBit(winFile *pFile, unsigned char mask, int *pArg){
  38088. if( *pArg<0 ){
  38089. *pArg = (pFile->ctrlFlags & mask)!=0;
  38090. }else if( (*pArg)==0 ){
  38091. pFile->ctrlFlags &= ~mask;
  38092. }else{
  38093. pFile->ctrlFlags |= mask;
  38094. }
  38095. }
  38096. /* Forward references to VFS helper methods used for temporary files */
  38097. static int winGetTempname(sqlite3_vfs *, char **);
  38098. static int winIsDir(const void *);
  38099. static BOOL winIsDriveLetterAndColon(const char *);
  38100. /*
  38101. ** Control and query of the open file handle.
  38102. */
  38103. static int winFileControl(sqlite3_file *id, int op, void *pArg){
  38104. winFile *pFile = (winFile*)id;
  38105. OSTRACE(("FCNTL file=%p, op=%d, pArg=%p\n", pFile->h, op, pArg));
  38106. switch( op ){
  38107. case SQLITE_FCNTL_LOCKSTATE: {
  38108. *(int*)pArg = pFile->locktype;
  38109. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38110. return SQLITE_OK;
  38111. }
  38112. case SQLITE_FCNTL_LAST_ERRNO: {
  38113. *(int*)pArg = (int)pFile->lastErrno;
  38114. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38115. return SQLITE_OK;
  38116. }
  38117. case SQLITE_FCNTL_CHUNK_SIZE: {
  38118. pFile->szChunk = *(int *)pArg;
  38119. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38120. return SQLITE_OK;
  38121. }
  38122. case SQLITE_FCNTL_SIZE_HINT: {
  38123. if( pFile->szChunk>0 ){
  38124. sqlite3_int64 oldSz;
  38125. int rc = winFileSize(id, &oldSz);
  38126. if( rc==SQLITE_OK ){
  38127. sqlite3_int64 newSz = *(sqlite3_int64*)pArg;
  38128. if( newSz>oldSz ){
  38129. SimulateIOErrorBenign(1);
  38130. rc = winTruncate(id, newSz);
  38131. SimulateIOErrorBenign(0);
  38132. }
  38133. }
  38134. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  38135. return rc;
  38136. }
  38137. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38138. return SQLITE_OK;
  38139. }
  38140. case SQLITE_FCNTL_PERSIST_WAL: {
  38141. winModeBit(pFile, WINFILE_PERSIST_WAL, (int*)pArg);
  38142. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38143. return SQLITE_OK;
  38144. }
  38145. case SQLITE_FCNTL_POWERSAFE_OVERWRITE: {
  38146. winModeBit(pFile, WINFILE_PSOW, (int*)pArg);
  38147. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38148. return SQLITE_OK;
  38149. }
  38150. case SQLITE_FCNTL_VFSNAME: {
  38151. *(char**)pArg = sqlite3_mprintf("%s", pFile->pVfs->zName);
  38152. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38153. return SQLITE_OK;
  38154. }
  38155. case SQLITE_FCNTL_WIN32_AV_RETRY: {
  38156. int *a = (int*)pArg;
  38157. if( a[0]>0 ){
  38158. winIoerrRetry = a[0];
  38159. }else{
  38160. a[0] = winIoerrRetry;
  38161. }
  38162. if( a[1]>0 ){
  38163. winIoerrRetryDelay = a[1];
  38164. }else{
  38165. a[1] = winIoerrRetryDelay;
  38166. }
  38167. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38168. return SQLITE_OK;
  38169. }
  38170. case SQLITE_FCNTL_WIN32_GET_HANDLE: {
  38171. LPHANDLE phFile = (LPHANDLE)pArg;
  38172. *phFile = pFile->h;
  38173. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  38174. return SQLITE_OK;
  38175. }
  38176. #ifdef SQLITE_TEST
  38177. case SQLITE_FCNTL_WIN32_SET_HANDLE: {
  38178. LPHANDLE phFile = (LPHANDLE)pArg;
  38179. HANDLE hOldFile = pFile->h;
  38180. pFile->h = *phFile;
  38181. *phFile = hOldFile;
  38182. OSTRACE(("FCNTL oldFile=%p, newFile=%p, rc=SQLITE_OK\n",
  38183. hOldFile, pFile->h));
  38184. return SQLITE_OK;
  38185. }
  38186. #endif
  38187. case SQLITE_FCNTL_TEMPFILENAME: {
  38188. char *zTFile = 0;
  38189. int rc = winGetTempname(pFile->pVfs, &zTFile);
  38190. if( rc==SQLITE_OK ){
  38191. *(char**)pArg = zTFile;
  38192. }
  38193. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  38194. return rc;
  38195. }
  38196. #if SQLITE_MAX_MMAP_SIZE>0
  38197. case SQLITE_FCNTL_MMAP_SIZE: {
  38198. i64 newLimit = *(i64*)pArg;
  38199. int rc = SQLITE_OK;
  38200. if( newLimit>sqlite3GlobalConfig.mxMmap ){
  38201. newLimit = sqlite3GlobalConfig.mxMmap;
  38202. }
  38203. *(i64*)pArg = pFile->mmapSizeMax;
  38204. if( newLimit>=0 && newLimit!=pFile->mmapSizeMax && pFile->nFetchOut==0 ){
  38205. pFile->mmapSizeMax = newLimit;
  38206. if( pFile->mmapSize>0 ){
  38207. winUnmapfile(pFile);
  38208. rc = winMapfile(pFile, -1);
  38209. }
  38210. }
  38211. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  38212. return rc;
  38213. }
  38214. #endif
  38215. }
  38216. OSTRACE(("FCNTL file=%p, rc=SQLITE_NOTFOUND\n", pFile->h));
  38217. return SQLITE_NOTFOUND;
  38218. }
  38219. /*
  38220. ** Return the sector size in bytes of the underlying block device for
  38221. ** the specified file. This is almost always 512 bytes, but may be
  38222. ** larger for some devices.
  38223. **
  38224. ** SQLite code assumes this function cannot fail. It also assumes that
  38225. ** if two files are created in the same file-system directory (i.e.
  38226. ** a database and its journal file) that the sector size will be the
  38227. ** same for both.
  38228. */
  38229. static int winSectorSize(sqlite3_file *id){
  38230. (void)id;
  38231. return SQLITE_DEFAULT_SECTOR_SIZE;
  38232. }
  38233. /*
  38234. ** Return a vector of device characteristics.
  38235. */
  38236. static int winDeviceCharacteristics(sqlite3_file *id){
  38237. winFile *p = (winFile*)id;
  38238. return SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN |
  38239. ((p->ctrlFlags & WINFILE_PSOW)?SQLITE_IOCAP_POWERSAFE_OVERWRITE:0);
  38240. }
  38241. /*
  38242. ** Windows will only let you create file view mappings
  38243. ** on allocation size granularity boundaries.
  38244. ** During sqlite3_os_init() we do a GetSystemInfo()
  38245. ** to get the granularity size.
  38246. */
  38247. static SYSTEM_INFO winSysInfo;
  38248. #ifndef SQLITE_OMIT_WAL
  38249. /*
  38250. ** Helper functions to obtain and relinquish the global mutex. The
  38251. ** global mutex is used to protect the winLockInfo objects used by
  38252. ** this file, all of which may be shared by multiple threads.
  38253. **
  38254. ** Function winShmMutexHeld() is used to assert() that the global mutex
  38255. ** is held when required. This function is only used as part of assert()
  38256. ** statements. e.g.
  38257. **
  38258. ** winShmEnterMutex()
  38259. ** assert( winShmMutexHeld() );
  38260. ** winShmLeaveMutex()
  38261. */
  38262. static void winShmEnterMutex(void){
  38263. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  38264. }
  38265. static void winShmLeaveMutex(void){
  38266. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  38267. }
  38268. #ifndef NDEBUG
  38269. static int winShmMutexHeld(void) {
  38270. return sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1));
  38271. }
  38272. #endif
  38273. /*
  38274. ** Object used to represent a single file opened and mmapped to provide
  38275. ** shared memory. When multiple threads all reference the same
  38276. ** log-summary, each thread has its own winFile object, but they all
  38277. ** point to a single instance of this object. In other words, each
  38278. ** log-summary is opened only once per process.
  38279. **
  38280. ** winShmMutexHeld() must be true when creating or destroying
  38281. ** this object or while reading or writing the following fields:
  38282. **
  38283. ** nRef
  38284. ** pNext
  38285. **
  38286. ** The following fields are read-only after the object is created:
  38287. **
  38288. ** fid
  38289. ** zFilename
  38290. **
  38291. ** Either winShmNode.mutex must be held or winShmNode.nRef==0 and
  38292. ** winShmMutexHeld() is true when reading or writing any other field
  38293. ** in this structure.
  38294. **
  38295. */
  38296. struct winShmNode {
  38297. sqlite3_mutex *mutex; /* Mutex to access this object */
  38298. char *zFilename; /* Name of the file */
  38299. winFile hFile; /* File handle from winOpen */
  38300. int szRegion; /* Size of shared-memory regions */
  38301. int nRegion; /* Size of array apRegion */
  38302. struct ShmRegion {
  38303. HANDLE hMap; /* File handle from CreateFileMapping */
  38304. void *pMap;
  38305. } *aRegion;
  38306. DWORD lastErrno; /* The Windows errno from the last I/O error */
  38307. int nRef; /* Number of winShm objects pointing to this */
  38308. winShm *pFirst; /* All winShm objects pointing to this */
  38309. winShmNode *pNext; /* Next in list of all winShmNode objects */
  38310. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  38311. u8 nextShmId; /* Next available winShm.id value */
  38312. #endif
  38313. };
  38314. /*
  38315. ** A global array of all winShmNode objects.
  38316. **
  38317. ** The winShmMutexHeld() must be true while reading or writing this list.
  38318. */
  38319. static winShmNode *winShmNodeList = 0;
  38320. /*
  38321. ** Structure used internally by this VFS to record the state of an
  38322. ** open shared memory connection.
  38323. **
  38324. ** The following fields are initialized when this object is created and
  38325. ** are read-only thereafter:
  38326. **
  38327. ** winShm.pShmNode
  38328. ** winShm.id
  38329. **
  38330. ** All other fields are read/write. The winShm.pShmNode->mutex must be held
  38331. ** while accessing any read/write fields.
  38332. */
  38333. struct winShm {
  38334. winShmNode *pShmNode; /* The underlying winShmNode object */
  38335. winShm *pNext; /* Next winShm with the same winShmNode */
  38336. u8 hasMutex; /* True if holding the winShmNode mutex */
  38337. u16 sharedMask; /* Mask of shared locks held */
  38338. u16 exclMask; /* Mask of exclusive locks held */
  38339. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  38340. u8 id; /* Id of this connection with its winShmNode */
  38341. #endif
  38342. };
  38343. /*
  38344. ** Constants used for locking
  38345. */
  38346. #define WIN_SHM_BASE ((22+SQLITE_SHM_NLOCK)*4) /* first lock byte */
  38347. #define WIN_SHM_DMS (WIN_SHM_BASE+SQLITE_SHM_NLOCK) /* deadman switch */
  38348. /*
  38349. ** Apply advisory locks for all n bytes beginning at ofst.
  38350. */
  38351. #define WINSHM_UNLCK 1
  38352. #define WINSHM_RDLCK 2
  38353. #define WINSHM_WRLCK 3
  38354. static int winShmSystemLock(
  38355. winShmNode *pFile, /* Apply locks to this open shared-memory segment */
  38356. int lockType, /* WINSHM_UNLCK, WINSHM_RDLCK, or WINSHM_WRLCK */
  38357. int ofst, /* Offset to first byte to be locked/unlocked */
  38358. int nByte /* Number of bytes to lock or unlock */
  38359. ){
  38360. int rc = 0; /* Result code form Lock/UnlockFileEx() */
  38361. /* Access to the winShmNode object is serialized by the caller */
  38362. assert( sqlite3_mutex_held(pFile->mutex) || pFile->nRef==0 );
  38363. OSTRACE(("SHM-LOCK file=%p, lock=%d, offset=%d, size=%d\n",
  38364. pFile->hFile.h, lockType, ofst, nByte));
  38365. /* Release/Acquire the system-level lock */
  38366. if( lockType==WINSHM_UNLCK ){
  38367. rc = winUnlockFile(&pFile->hFile.h, ofst, 0, nByte, 0);
  38368. }else{
  38369. /* Initialize the locking parameters */
  38370. DWORD dwFlags = LOCKFILE_FAIL_IMMEDIATELY;
  38371. if( lockType == WINSHM_WRLCK ) dwFlags |= LOCKFILE_EXCLUSIVE_LOCK;
  38372. rc = winLockFile(&pFile->hFile.h, dwFlags, ofst, 0, nByte, 0);
  38373. }
  38374. if( rc!= 0 ){
  38375. rc = SQLITE_OK;
  38376. }else{
  38377. pFile->lastErrno = osGetLastError();
  38378. rc = SQLITE_BUSY;
  38379. }
  38380. OSTRACE(("SHM-LOCK file=%p, func=%s, errno=%lu, rc=%s\n",
  38381. pFile->hFile.h, (lockType == WINSHM_UNLCK) ? "winUnlockFile" :
  38382. "winLockFile", pFile->lastErrno, sqlite3ErrName(rc)));
  38383. return rc;
  38384. }
  38385. /* Forward references to VFS methods */
  38386. static int winOpen(sqlite3_vfs*,const char*,sqlite3_file*,int,int*);
  38387. static int winDelete(sqlite3_vfs *,const char*,int);
  38388. /*
  38389. ** Purge the winShmNodeList list of all entries with winShmNode.nRef==0.
  38390. **
  38391. ** This is not a VFS shared-memory method; it is a utility function called
  38392. ** by VFS shared-memory methods.
  38393. */
  38394. static void winShmPurge(sqlite3_vfs *pVfs, int deleteFlag){
  38395. winShmNode **pp;
  38396. winShmNode *p;
  38397. assert( winShmMutexHeld() );
  38398. OSTRACE(("SHM-PURGE pid=%lu, deleteFlag=%d\n",
  38399. osGetCurrentProcessId(), deleteFlag));
  38400. pp = &winShmNodeList;
  38401. while( (p = *pp)!=0 ){
  38402. if( p->nRef==0 ){
  38403. int i;
  38404. if( p->mutex ){ sqlite3_mutex_free(p->mutex); }
  38405. for(i=0; i<p->nRegion; i++){
  38406. BOOL bRc = osUnmapViewOfFile(p->aRegion[i].pMap);
  38407. OSTRACE(("SHM-PURGE-UNMAP pid=%lu, region=%d, rc=%s\n",
  38408. osGetCurrentProcessId(), i, bRc ? "ok" : "failed"));
  38409. UNUSED_VARIABLE_VALUE(bRc);
  38410. bRc = osCloseHandle(p->aRegion[i].hMap);
  38411. OSTRACE(("SHM-PURGE-CLOSE pid=%lu, region=%d, rc=%s\n",
  38412. osGetCurrentProcessId(), i, bRc ? "ok" : "failed"));
  38413. UNUSED_VARIABLE_VALUE(bRc);
  38414. }
  38415. if( p->hFile.h!=NULL && p->hFile.h!=INVALID_HANDLE_VALUE ){
  38416. SimulateIOErrorBenign(1);
  38417. winClose((sqlite3_file *)&p->hFile);
  38418. SimulateIOErrorBenign(0);
  38419. }
  38420. if( deleteFlag ){
  38421. SimulateIOErrorBenign(1);
  38422. sqlite3BeginBenignMalloc();
  38423. winDelete(pVfs, p->zFilename, 0);
  38424. sqlite3EndBenignMalloc();
  38425. SimulateIOErrorBenign(0);
  38426. }
  38427. *pp = p->pNext;
  38428. sqlite3_free(p->aRegion);
  38429. sqlite3_free(p);
  38430. }else{
  38431. pp = &p->pNext;
  38432. }
  38433. }
  38434. }
  38435. /*
  38436. ** Open the shared-memory area associated with database file pDbFd.
  38437. **
  38438. ** When opening a new shared-memory file, if no other instances of that
  38439. ** file are currently open, in this process or in other processes, then
  38440. ** the file must be truncated to zero length or have its header cleared.
  38441. */
  38442. static int winOpenSharedMemory(winFile *pDbFd){
  38443. struct winShm *p; /* The connection to be opened */
  38444. struct winShmNode *pShmNode = 0; /* The underlying mmapped file */
  38445. int rc; /* Result code */
  38446. struct winShmNode *pNew; /* Newly allocated winShmNode */
  38447. int nName; /* Size of zName in bytes */
  38448. assert( pDbFd->pShm==0 ); /* Not previously opened */
  38449. /* Allocate space for the new sqlite3_shm object. Also speculatively
  38450. ** allocate space for a new winShmNode and filename.
  38451. */
  38452. p = sqlite3MallocZero( sizeof(*p) );
  38453. if( p==0 ) return SQLITE_IOERR_NOMEM_BKPT;
  38454. nName = sqlite3Strlen30(pDbFd->zPath);
  38455. pNew = sqlite3MallocZero( sizeof(*pShmNode) + nName + 17 );
  38456. if( pNew==0 ){
  38457. sqlite3_free(p);
  38458. return SQLITE_IOERR_NOMEM_BKPT;
  38459. }
  38460. pNew->zFilename = (char*)&pNew[1];
  38461. sqlite3_snprintf(nName+15, pNew->zFilename, "%s-shm", pDbFd->zPath);
  38462. sqlite3FileSuffix3(pDbFd->zPath, pNew->zFilename);
  38463. /* Look to see if there is an existing winShmNode that can be used.
  38464. ** If no matching winShmNode currently exists, create a new one.
  38465. */
  38466. winShmEnterMutex();
  38467. for(pShmNode = winShmNodeList; pShmNode; pShmNode=pShmNode->pNext){
  38468. /* TBD need to come up with better match here. Perhaps
  38469. ** use FILE_ID_BOTH_DIR_INFO Structure.
  38470. */
  38471. if( sqlite3StrICmp(pShmNode->zFilename, pNew->zFilename)==0 ) break;
  38472. }
  38473. if( pShmNode ){
  38474. sqlite3_free(pNew);
  38475. }else{
  38476. pShmNode = pNew;
  38477. pNew = 0;
  38478. ((winFile*)(&pShmNode->hFile))->h = INVALID_HANDLE_VALUE;
  38479. pShmNode->pNext = winShmNodeList;
  38480. winShmNodeList = pShmNode;
  38481. if( sqlite3GlobalConfig.bCoreMutex ){
  38482. pShmNode->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_FAST);
  38483. if( pShmNode->mutex==0 ){
  38484. rc = SQLITE_IOERR_NOMEM_BKPT;
  38485. goto shm_open_err;
  38486. }
  38487. }
  38488. rc = winOpen(pDbFd->pVfs,
  38489. pShmNode->zFilename, /* Name of the file (UTF-8) */
  38490. (sqlite3_file*)&pShmNode->hFile, /* File handle here */
  38491. SQLITE_OPEN_WAL | SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE,
  38492. 0);
  38493. if( SQLITE_OK!=rc ){
  38494. goto shm_open_err;
  38495. }
  38496. /* Check to see if another process is holding the dead-man switch.
  38497. ** If not, truncate the file to zero length.
  38498. */
  38499. if( winShmSystemLock(pShmNode, WINSHM_WRLCK, WIN_SHM_DMS, 1)==SQLITE_OK ){
  38500. rc = winTruncate((sqlite3_file *)&pShmNode->hFile, 0);
  38501. if( rc!=SQLITE_OK ){
  38502. rc = winLogError(SQLITE_IOERR_SHMOPEN, osGetLastError(),
  38503. "winOpenShm", pDbFd->zPath);
  38504. }
  38505. }
  38506. if( rc==SQLITE_OK ){
  38507. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  38508. rc = winShmSystemLock(pShmNode, WINSHM_RDLCK, WIN_SHM_DMS, 1);
  38509. }
  38510. if( rc ) goto shm_open_err;
  38511. }
  38512. /* Make the new connection a child of the winShmNode */
  38513. p->pShmNode = pShmNode;
  38514. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  38515. p->id = pShmNode->nextShmId++;
  38516. #endif
  38517. pShmNode->nRef++;
  38518. pDbFd->pShm = p;
  38519. winShmLeaveMutex();
  38520. /* The reference count on pShmNode has already been incremented under
  38521. ** the cover of the winShmEnterMutex() mutex and the pointer from the
  38522. ** new (struct winShm) object to the pShmNode has been set. All that is
  38523. ** left to do is to link the new object into the linked list starting
  38524. ** at pShmNode->pFirst. This must be done while holding the pShmNode->mutex
  38525. ** mutex.
  38526. */
  38527. sqlite3_mutex_enter(pShmNode->mutex);
  38528. p->pNext = pShmNode->pFirst;
  38529. pShmNode->pFirst = p;
  38530. sqlite3_mutex_leave(pShmNode->mutex);
  38531. return SQLITE_OK;
  38532. /* Jump here on any error */
  38533. shm_open_err:
  38534. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  38535. winShmPurge(pDbFd->pVfs, 0); /* This call frees pShmNode if required */
  38536. sqlite3_free(p);
  38537. sqlite3_free(pNew);
  38538. winShmLeaveMutex();
  38539. return rc;
  38540. }
  38541. /*
  38542. ** Close a connection to shared-memory. Delete the underlying
  38543. ** storage if deleteFlag is true.
  38544. */
  38545. static int winShmUnmap(
  38546. sqlite3_file *fd, /* Database holding shared memory */
  38547. int deleteFlag /* Delete after closing if true */
  38548. ){
  38549. winFile *pDbFd; /* Database holding shared-memory */
  38550. winShm *p; /* The connection to be closed */
  38551. winShmNode *pShmNode; /* The underlying shared-memory file */
  38552. winShm **pp; /* For looping over sibling connections */
  38553. pDbFd = (winFile*)fd;
  38554. p = pDbFd->pShm;
  38555. if( p==0 ) return SQLITE_OK;
  38556. pShmNode = p->pShmNode;
  38557. /* Remove connection p from the set of connections associated
  38558. ** with pShmNode */
  38559. sqlite3_mutex_enter(pShmNode->mutex);
  38560. for(pp=&pShmNode->pFirst; (*pp)!=p; pp = &(*pp)->pNext){}
  38561. *pp = p->pNext;
  38562. /* Free the connection p */
  38563. sqlite3_free(p);
  38564. pDbFd->pShm = 0;
  38565. sqlite3_mutex_leave(pShmNode->mutex);
  38566. /* If pShmNode->nRef has reached 0, then close the underlying
  38567. ** shared-memory file, too */
  38568. winShmEnterMutex();
  38569. assert( pShmNode->nRef>0 );
  38570. pShmNode->nRef--;
  38571. if( pShmNode->nRef==0 ){
  38572. winShmPurge(pDbFd->pVfs, deleteFlag);
  38573. }
  38574. winShmLeaveMutex();
  38575. return SQLITE_OK;
  38576. }
  38577. /*
  38578. ** Change the lock state for a shared-memory segment.
  38579. */
  38580. static int winShmLock(
  38581. sqlite3_file *fd, /* Database file holding the shared memory */
  38582. int ofst, /* First lock to acquire or release */
  38583. int n, /* Number of locks to acquire or release */
  38584. int flags /* What to do with the lock */
  38585. ){
  38586. winFile *pDbFd = (winFile*)fd; /* Connection holding shared memory */
  38587. winShm *p = pDbFd->pShm; /* The shared memory being locked */
  38588. winShm *pX; /* For looping over all siblings */
  38589. winShmNode *pShmNode = p->pShmNode;
  38590. int rc = SQLITE_OK; /* Result code */
  38591. u16 mask; /* Mask of locks to take or release */
  38592. assert( ofst>=0 && ofst+n<=SQLITE_SHM_NLOCK );
  38593. assert( n>=1 );
  38594. assert( flags==(SQLITE_SHM_LOCK | SQLITE_SHM_SHARED)
  38595. || flags==(SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE)
  38596. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED)
  38597. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE) );
  38598. assert( n==1 || (flags & SQLITE_SHM_EXCLUSIVE)!=0 );
  38599. mask = (u16)((1U<<(ofst+n)) - (1U<<ofst));
  38600. assert( n>1 || mask==(1<<ofst) );
  38601. sqlite3_mutex_enter(pShmNode->mutex);
  38602. if( flags & SQLITE_SHM_UNLOCK ){
  38603. u16 allMask = 0; /* Mask of locks held by siblings */
  38604. /* See if any siblings hold this same lock */
  38605. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  38606. if( pX==p ) continue;
  38607. assert( (pX->exclMask & (p->exclMask|p->sharedMask))==0 );
  38608. allMask |= pX->sharedMask;
  38609. }
  38610. /* Unlock the system-level locks */
  38611. if( (mask & allMask)==0 ){
  38612. rc = winShmSystemLock(pShmNode, WINSHM_UNLCK, ofst+WIN_SHM_BASE, n);
  38613. }else{
  38614. rc = SQLITE_OK;
  38615. }
  38616. /* Undo the local locks */
  38617. if( rc==SQLITE_OK ){
  38618. p->exclMask &= ~mask;
  38619. p->sharedMask &= ~mask;
  38620. }
  38621. }else if( flags & SQLITE_SHM_SHARED ){
  38622. u16 allShared = 0; /* Union of locks held by connections other than "p" */
  38623. /* Find out which shared locks are already held by sibling connections.
  38624. ** If any sibling already holds an exclusive lock, go ahead and return
  38625. ** SQLITE_BUSY.
  38626. */
  38627. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  38628. if( (pX->exclMask & mask)!=0 ){
  38629. rc = SQLITE_BUSY;
  38630. break;
  38631. }
  38632. allShared |= pX->sharedMask;
  38633. }
  38634. /* Get shared locks at the system level, if necessary */
  38635. if( rc==SQLITE_OK ){
  38636. if( (allShared & mask)==0 ){
  38637. rc = winShmSystemLock(pShmNode, WINSHM_RDLCK, ofst+WIN_SHM_BASE, n);
  38638. }else{
  38639. rc = SQLITE_OK;
  38640. }
  38641. }
  38642. /* Get the local shared locks */
  38643. if( rc==SQLITE_OK ){
  38644. p->sharedMask |= mask;
  38645. }
  38646. }else{
  38647. /* Make sure no sibling connections hold locks that will block this
  38648. ** lock. If any do, return SQLITE_BUSY right away.
  38649. */
  38650. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  38651. if( (pX->exclMask & mask)!=0 || (pX->sharedMask & mask)!=0 ){
  38652. rc = SQLITE_BUSY;
  38653. break;
  38654. }
  38655. }
  38656. /* Get the exclusive locks at the system level. Then if successful
  38657. ** also mark the local connection as being locked.
  38658. */
  38659. if( rc==SQLITE_OK ){
  38660. rc = winShmSystemLock(pShmNode, WINSHM_WRLCK, ofst+WIN_SHM_BASE, n);
  38661. if( rc==SQLITE_OK ){
  38662. assert( (p->sharedMask & mask)==0 );
  38663. p->exclMask |= mask;
  38664. }
  38665. }
  38666. }
  38667. sqlite3_mutex_leave(pShmNode->mutex);
  38668. OSTRACE(("SHM-LOCK pid=%lu, id=%d, sharedMask=%03x, exclMask=%03x, rc=%s\n",
  38669. osGetCurrentProcessId(), p->id, p->sharedMask, p->exclMask,
  38670. sqlite3ErrName(rc)));
  38671. return rc;
  38672. }
  38673. /*
  38674. ** Implement a memory barrier or memory fence on shared memory.
  38675. **
  38676. ** All loads and stores begun before the barrier must complete before
  38677. ** any load or store begun after the barrier.
  38678. */
  38679. static void winShmBarrier(
  38680. sqlite3_file *fd /* Database holding the shared memory */
  38681. ){
  38682. UNUSED_PARAMETER(fd);
  38683. sqlite3MemoryBarrier(); /* compiler-defined memory barrier */
  38684. winShmEnterMutex(); /* Also mutex, for redundancy */
  38685. winShmLeaveMutex();
  38686. }
  38687. /*
  38688. ** This function is called to obtain a pointer to region iRegion of the
  38689. ** shared-memory associated with the database file fd. Shared-memory regions
  38690. ** are numbered starting from zero. Each shared-memory region is szRegion
  38691. ** bytes in size.
  38692. **
  38693. ** If an error occurs, an error code is returned and *pp is set to NULL.
  38694. **
  38695. ** Otherwise, if the isWrite parameter is 0 and the requested shared-memory
  38696. ** region has not been allocated (by any client, including one running in a
  38697. ** separate process), then *pp is set to NULL and SQLITE_OK returned. If
  38698. ** isWrite is non-zero and the requested shared-memory region has not yet
  38699. ** been allocated, it is allocated by this function.
  38700. **
  38701. ** If the shared-memory region has already been allocated or is allocated by
  38702. ** this call as described above, then it is mapped into this processes
  38703. ** address space (if it is not already), *pp is set to point to the mapped
  38704. ** memory and SQLITE_OK returned.
  38705. */
  38706. static int winShmMap(
  38707. sqlite3_file *fd, /* Handle open on database file */
  38708. int iRegion, /* Region to retrieve */
  38709. int szRegion, /* Size of regions */
  38710. int isWrite, /* True to extend file if necessary */
  38711. void volatile **pp /* OUT: Mapped memory */
  38712. ){
  38713. winFile *pDbFd = (winFile*)fd;
  38714. winShm *pShm = pDbFd->pShm;
  38715. winShmNode *pShmNode;
  38716. int rc = SQLITE_OK;
  38717. if( !pShm ){
  38718. rc = winOpenSharedMemory(pDbFd);
  38719. if( rc!=SQLITE_OK ) return rc;
  38720. pShm = pDbFd->pShm;
  38721. }
  38722. pShmNode = pShm->pShmNode;
  38723. sqlite3_mutex_enter(pShmNode->mutex);
  38724. assert( szRegion==pShmNode->szRegion || pShmNode->nRegion==0 );
  38725. if( pShmNode->nRegion<=iRegion ){
  38726. struct ShmRegion *apNew; /* New aRegion[] array */
  38727. int nByte = (iRegion+1)*szRegion; /* Minimum required file size */
  38728. sqlite3_int64 sz; /* Current size of wal-index file */
  38729. pShmNode->szRegion = szRegion;
  38730. /* The requested region is not mapped into this processes address space.
  38731. ** Check to see if it has been allocated (i.e. if the wal-index file is
  38732. ** large enough to contain the requested region).
  38733. */
  38734. rc = winFileSize((sqlite3_file *)&pShmNode->hFile, &sz);
  38735. if( rc!=SQLITE_OK ){
  38736. rc = winLogError(SQLITE_IOERR_SHMSIZE, osGetLastError(),
  38737. "winShmMap1", pDbFd->zPath);
  38738. goto shmpage_out;
  38739. }
  38740. if( sz<nByte ){
  38741. /* The requested memory region does not exist. If isWrite is set to
  38742. ** zero, exit early. *pp will be set to NULL and SQLITE_OK returned.
  38743. **
  38744. ** Alternatively, if isWrite is non-zero, use ftruncate() to allocate
  38745. ** the requested memory region.
  38746. */
  38747. if( !isWrite ) goto shmpage_out;
  38748. rc = winTruncate((sqlite3_file *)&pShmNode->hFile, nByte);
  38749. if( rc!=SQLITE_OK ){
  38750. rc = winLogError(SQLITE_IOERR_SHMSIZE, osGetLastError(),
  38751. "winShmMap2", pDbFd->zPath);
  38752. goto shmpage_out;
  38753. }
  38754. }
  38755. /* Map the requested memory region into this processes address space. */
  38756. apNew = (struct ShmRegion *)sqlite3_realloc64(
  38757. pShmNode->aRegion, (iRegion+1)*sizeof(apNew[0])
  38758. );
  38759. if( !apNew ){
  38760. rc = SQLITE_IOERR_NOMEM_BKPT;
  38761. goto shmpage_out;
  38762. }
  38763. pShmNode->aRegion = apNew;
  38764. while( pShmNode->nRegion<=iRegion ){
  38765. HANDLE hMap = NULL; /* file-mapping handle */
  38766. void *pMap = 0; /* Mapped memory region */
  38767. #if SQLITE_OS_WINRT
  38768. hMap = osCreateFileMappingFromApp(pShmNode->hFile.h,
  38769. NULL, PAGE_READWRITE, nByte, NULL
  38770. );
  38771. #elif defined(SQLITE_WIN32_HAS_WIDE)
  38772. hMap = osCreateFileMappingW(pShmNode->hFile.h,
  38773. NULL, PAGE_READWRITE, 0, nByte, NULL
  38774. );
  38775. #elif defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_CREATEFILEMAPPINGA
  38776. hMap = osCreateFileMappingA(pShmNode->hFile.h,
  38777. NULL, PAGE_READWRITE, 0, nByte, NULL
  38778. );
  38779. #endif
  38780. OSTRACE(("SHM-MAP-CREATE pid=%lu, region=%d, size=%d, rc=%s\n",
  38781. osGetCurrentProcessId(), pShmNode->nRegion, nByte,
  38782. hMap ? "ok" : "failed"));
  38783. if( hMap ){
  38784. int iOffset = pShmNode->nRegion*szRegion;
  38785. int iOffsetShift = iOffset % winSysInfo.dwAllocationGranularity;
  38786. #if SQLITE_OS_WINRT
  38787. pMap = osMapViewOfFileFromApp(hMap, FILE_MAP_WRITE | FILE_MAP_READ,
  38788. iOffset - iOffsetShift, szRegion + iOffsetShift
  38789. );
  38790. #else
  38791. pMap = osMapViewOfFile(hMap, FILE_MAP_WRITE | FILE_MAP_READ,
  38792. 0, iOffset - iOffsetShift, szRegion + iOffsetShift
  38793. );
  38794. #endif
  38795. OSTRACE(("SHM-MAP-MAP pid=%lu, region=%d, offset=%d, size=%d, rc=%s\n",
  38796. osGetCurrentProcessId(), pShmNode->nRegion, iOffset,
  38797. szRegion, pMap ? "ok" : "failed"));
  38798. }
  38799. if( !pMap ){
  38800. pShmNode->lastErrno = osGetLastError();
  38801. rc = winLogError(SQLITE_IOERR_SHMMAP, pShmNode->lastErrno,
  38802. "winShmMap3", pDbFd->zPath);
  38803. if( hMap ) osCloseHandle(hMap);
  38804. goto shmpage_out;
  38805. }
  38806. pShmNode->aRegion[pShmNode->nRegion].pMap = pMap;
  38807. pShmNode->aRegion[pShmNode->nRegion].hMap = hMap;
  38808. pShmNode->nRegion++;
  38809. }
  38810. }
  38811. shmpage_out:
  38812. if( pShmNode->nRegion>iRegion ){
  38813. int iOffset = iRegion*szRegion;
  38814. int iOffsetShift = iOffset % winSysInfo.dwAllocationGranularity;
  38815. char *p = (char *)pShmNode->aRegion[iRegion].pMap;
  38816. *pp = (void *)&p[iOffsetShift];
  38817. }else{
  38818. *pp = 0;
  38819. }
  38820. sqlite3_mutex_leave(pShmNode->mutex);
  38821. return rc;
  38822. }
  38823. #else
  38824. # define winShmMap 0
  38825. # define winShmLock 0
  38826. # define winShmBarrier 0
  38827. # define winShmUnmap 0
  38828. #endif /* #ifndef SQLITE_OMIT_WAL */
  38829. /*
  38830. ** Cleans up the mapped region of the specified file, if any.
  38831. */
  38832. #if SQLITE_MAX_MMAP_SIZE>0
  38833. static int winUnmapfile(winFile *pFile){
  38834. assert( pFile!=0 );
  38835. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, hMap=%p, pMapRegion=%p, "
  38836. "mmapSize=%lld, mmapSizeActual=%lld, mmapSizeMax=%lld\n",
  38837. osGetCurrentProcessId(), pFile, pFile->hMap, pFile->pMapRegion,
  38838. pFile->mmapSize, pFile->mmapSizeActual, pFile->mmapSizeMax));
  38839. if( pFile->pMapRegion ){
  38840. if( !osUnmapViewOfFile(pFile->pMapRegion) ){
  38841. pFile->lastErrno = osGetLastError();
  38842. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, pMapRegion=%p, "
  38843. "rc=SQLITE_IOERR_MMAP\n", osGetCurrentProcessId(), pFile,
  38844. pFile->pMapRegion));
  38845. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  38846. "winUnmapfile1", pFile->zPath);
  38847. }
  38848. pFile->pMapRegion = 0;
  38849. pFile->mmapSize = 0;
  38850. pFile->mmapSizeActual = 0;
  38851. }
  38852. if( pFile->hMap!=NULL ){
  38853. if( !osCloseHandle(pFile->hMap) ){
  38854. pFile->lastErrno = osGetLastError();
  38855. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, hMap=%p, rc=SQLITE_IOERR_MMAP\n",
  38856. osGetCurrentProcessId(), pFile, pFile->hMap));
  38857. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  38858. "winUnmapfile2", pFile->zPath);
  38859. }
  38860. pFile->hMap = NULL;
  38861. }
  38862. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  38863. osGetCurrentProcessId(), pFile));
  38864. return SQLITE_OK;
  38865. }
  38866. /*
  38867. ** Memory map or remap the file opened by file-descriptor pFd (if the file
  38868. ** is already mapped, the existing mapping is replaced by the new). Or, if
  38869. ** there already exists a mapping for this file, and there are still
  38870. ** outstanding xFetch() references to it, this function is a no-op.
  38871. **
  38872. ** If parameter nByte is non-negative, then it is the requested size of
  38873. ** the mapping to create. Otherwise, if nByte is less than zero, then the
  38874. ** requested size is the size of the file on disk. The actual size of the
  38875. ** created mapping is either the requested size or the value configured
  38876. ** using SQLITE_FCNTL_MMAP_SIZE, whichever is smaller.
  38877. **
  38878. ** SQLITE_OK is returned if no error occurs (even if the mapping is not
  38879. ** recreated as a result of outstanding references) or an SQLite error
  38880. ** code otherwise.
  38881. */
  38882. static int winMapfile(winFile *pFd, sqlite3_int64 nByte){
  38883. sqlite3_int64 nMap = nByte;
  38884. int rc;
  38885. assert( nMap>=0 || pFd->nFetchOut==0 );
  38886. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, size=%lld\n",
  38887. osGetCurrentProcessId(), pFd, nByte));
  38888. if( pFd->nFetchOut>0 ) return SQLITE_OK;
  38889. if( nMap<0 ){
  38890. rc = winFileSize((sqlite3_file*)pFd, &nMap);
  38891. if( rc ){
  38892. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, rc=SQLITE_IOERR_FSTAT\n",
  38893. osGetCurrentProcessId(), pFd));
  38894. return SQLITE_IOERR_FSTAT;
  38895. }
  38896. }
  38897. if( nMap>pFd->mmapSizeMax ){
  38898. nMap = pFd->mmapSizeMax;
  38899. }
  38900. nMap &= ~(sqlite3_int64)(winSysInfo.dwPageSize - 1);
  38901. if( nMap==0 && pFd->mmapSize>0 ){
  38902. winUnmapfile(pFd);
  38903. }
  38904. if( nMap!=pFd->mmapSize ){
  38905. void *pNew = 0;
  38906. DWORD protect = PAGE_READONLY;
  38907. DWORD flags = FILE_MAP_READ;
  38908. winUnmapfile(pFd);
  38909. #ifdef SQLITE_MMAP_READWRITE
  38910. if( (pFd->ctrlFlags & WINFILE_RDONLY)==0 ){
  38911. protect = PAGE_READWRITE;
  38912. flags |= FILE_MAP_WRITE;
  38913. }
  38914. #endif
  38915. #if SQLITE_OS_WINRT
  38916. pFd->hMap = osCreateFileMappingFromApp(pFd->h, NULL, protect, nMap, NULL);
  38917. #elif defined(SQLITE_WIN32_HAS_WIDE)
  38918. pFd->hMap = osCreateFileMappingW(pFd->h, NULL, protect,
  38919. (DWORD)((nMap>>32) & 0xffffffff),
  38920. (DWORD)(nMap & 0xffffffff), NULL);
  38921. #elif defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_CREATEFILEMAPPINGA
  38922. pFd->hMap = osCreateFileMappingA(pFd->h, NULL, protect,
  38923. (DWORD)((nMap>>32) & 0xffffffff),
  38924. (DWORD)(nMap & 0xffffffff), NULL);
  38925. #endif
  38926. if( pFd->hMap==NULL ){
  38927. pFd->lastErrno = osGetLastError();
  38928. rc = winLogError(SQLITE_IOERR_MMAP, pFd->lastErrno,
  38929. "winMapfile1", pFd->zPath);
  38930. /* Log the error, but continue normal operation using xRead/xWrite */
  38931. OSTRACE(("MAP-FILE-CREATE pid=%lu, pFile=%p, rc=%s\n",
  38932. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  38933. return SQLITE_OK;
  38934. }
  38935. assert( (nMap % winSysInfo.dwPageSize)==0 );
  38936. assert( sizeof(SIZE_T)==sizeof(sqlite3_int64) || nMap<=0xffffffff );
  38937. #if SQLITE_OS_WINRT
  38938. pNew = osMapViewOfFileFromApp(pFd->hMap, flags, 0, (SIZE_T)nMap);
  38939. #else
  38940. pNew = osMapViewOfFile(pFd->hMap, flags, 0, 0, (SIZE_T)nMap);
  38941. #endif
  38942. if( pNew==NULL ){
  38943. osCloseHandle(pFd->hMap);
  38944. pFd->hMap = NULL;
  38945. pFd->lastErrno = osGetLastError();
  38946. rc = winLogError(SQLITE_IOERR_MMAP, pFd->lastErrno,
  38947. "winMapfile2", pFd->zPath);
  38948. /* Log the error, but continue normal operation using xRead/xWrite */
  38949. OSTRACE(("MAP-FILE-MAP pid=%lu, pFile=%p, rc=%s\n",
  38950. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  38951. return SQLITE_OK;
  38952. }
  38953. pFd->pMapRegion = pNew;
  38954. pFd->mmapSize = nMap;
  38955. pFd->mmapSizeActual = nMap;
  38956. }
  38957. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  38958. osGetCurrentProcessId(), pFd));
  38959. return SQLITE_OK;
  38960. }
  38961. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  38962. /*
  38963. ** If possible, return a pointer to a mapping of file fd starting at offset
  38964. ** iOff. The mapping must be valid for at least nAmt bytes.
  38965. **
  38966. ** If such a pointer can be obtained, store it in *pp and return SQLITE_OK.
  38967. ** Or, if one cannot but no error occurs, set *pp to 0 and return SQLITE_OK.
  38968. ** Finally, if an error does occur, return an SQLite error code. The final
  38969. ** value of *pp is undefined in this case.
  38970. **
  38971. ** If this function does return a pointer, the caller must eventually
  38972. ** release the reference by calling winUnfetch().
  38973. */
  38974. static int winFetch(sqlite3_file *fd, i64 iOff, int nAmt, void **pp){
  38975. #if SQLITE_MAX_MMAP_SIZE>0
  38976. winFile *pFd = (winFile*)fd; /* The underlying database file */
  38977. #endif
  38978. *pp = 0;
  38979. OSTRACE(("FETCH pid=%lu, pFile=%p, offset=%lld, amount=%d, pp=%p\n",
  38980. osGetCurrentProcessId(), fd, iOff, nAmt, pp));
  38981. #if SQLITE_MAX_MMAP_SIZE>0
  38982. if( pFd->mmapSizeMax>0 ){
  38983. if( pFd->pMapRegion==0 ){
  38984. int rc = winMapfile(pFd, -1);
  38985. if( rc!=SQLITE_OK ){
  38986. OSTRACE(("FETCH pid=%lu, pFile=%p, rc=%s\n",
  38987. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  38988. return rc;
  38989. }
  38990. }
  38991. if( pFd->mmapSize >= iOff+nAmt ){
  38992. *pp = &((u8 *)pFd->pMapRegion)[iOff];
  38993. pFd->nFetchOut++;
  38994. }
  38995. }
  38996. #endif
  38997. OSTRACE(("FETCH pid=%lu, pFile=%p, pp=%p, *pp=%p, rc=SQLITE_OK\n",
  38998. osGetCurrentProcessId(), fd, pp, *pp));
  38999. return SQLITE_OK;
  39000. }
  39001. /*
  39002. ** If the third argument is non-NULL, then this function releases a
  39003. ** reference obtained by an earlier call to winFetch(). The second
  39004. ** argument passed to this function must be the same as the corresponding
  39005. ** argument that was passed to the winFetch() invocation.
  39006. **
  39007. ** Or, if the third argument is NULL, then this function is being called
  39008. ** to inform the VFS layer that, according to POSIX, any existing mapping
  39009. ** may now be invalid and should be unmapped.
  39010. */
  39011. static int winUnfetch(sqlite3_file *fd, i64 iOff, void *p){
  39012. #if SQLITE_MAX_MMAP_SIZE>0
  39013. winFile *pFd = (winFile*)fd; /* The underlying database file */
  39014. /* If p==0 (unmap the entire file) then there must be no outstanding
  39015. ** xFetch references. Or, if p!=0 (meaning it is an xFetch reference),
  39016. ** then there must be at least one outstanding. */
  39017. assert( (p==0)==(pFd->nFetchOut==0) );
  39018. /* If p!=0, it must match the iOff value. */
  39019. assert( p==0 || p==&((u8 *)pFd->pMapRegion)[iOff] );
  39020. OSTRACE(("UNFETCH pid=%lu, pFile=%p, offset=%lld, p=%p\n",
  39021. osGetCurrentProcessId(), pFd, iOff, p));
  39022. if( p ){
  39023. pFd->nFetchOut--;
  39024. }else{
  39025. /* FIXME: If Windows truly always prevents truncating or deleting a
  39026. ** file while a mapping is held, then the following winUnmapfile() call
  39027. ** is unnecessary can be omitted - potentially improving
  39028. ** performance. */
  39029. winUnmapfile(pFd);
  39030. }
  39031. assert( pFd->nFetchOut>=0 );
  39032. #endif
  39033. OSTRACE(("UNFETCH pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  39034. osGetCurrentProcessId(), fd));
  39035. return SQLITE_OK;
  39036. }
  39037. /*
  39038. ** Here ends the implementation of all sqlite3_file methods.
  39039. **
  39040. ********************** End sqlite3_file Methods *******************************
  39041. ******************************************************************************/
  39042. /*
  39043. ** This vector defines all the methods that can operate on an
  39044. ** sqlite3_file for win32.
  39045. */
  39046. static const sqlite3_io_methods winIoMethod = {
  39047. 3, /* iVersion */
  39048. winClose, /* xClose */
  39049. winRead, /* xRead */
  39050. winWrite, /* xWrite */
  39051. winTruncate, /* xTruncate */
  39052. winSync, /* xSync */
  39053. winFileSize, /* xFileSize */
  39054. winLock, /* xLock */
  39055. winUnlock, /* xUnlock */
  39056. winCheckReservedLock, /* xCheckReservedLock */
  39057. winFileControl, /* xFileControl */
  39058. winSectorSize, /* xSectorSize */
  39059. winDeviceCharacteristics, /* xDeviceCharacteristics */
  39060. winShmMap, /* xShmMap */
  39061. winShmLock, /* xShmLock */
  39062. winShmBarrier, /* xShmBarrier */
  39063. winShmUnmap, /* xShmUnmap */
  39064. winFetch, /* xFetch */
  39065. winUnfetch /* xUnfetch */
  39066. };
  39067. /*
  39068. ** This vector defines all the methods that can operate on an
  39069. ** sqlite3_file for win32 without performing any locking.
  39070. */
  39071. static const sqlite3_io_methods winIoNolockMethod = {
  39072. 3, /* iVersion */
  39073. winClose, /* xClose */
  39074. winRead, /* xRead */
  39075. winWrite, /* xWrite */
  39076. winTruncate, /* xTruncate */
  39077. winSync, /* xSync */
  39078. winFileSize, /* xFileSize */
  39079. winNolockLock, /* xLock */
  39080. winNolockUnlock, /* xUnlock */
  39081. winNolockCheckReservedLock, /* xCheckReservedLock */
  39082. winFileControl, /* xFileControl */
  39083. winSectorSize, /* xSectorSize */
  39084. winDeviceCharacteristics, /* xDeviceCharacteristics */
  39085. winShmMap, /* xShmMap */
  39086. winShmLock, /* xShmLock */
  39087. winShmBarrier, /* xShmBarrier */
  39088. winShmUnmap, /* xShmUnmap */
  39089. winFetch, /* xFetch */
  39090. winUnfetch /* xUnfetch */
  39091. };
  39092. static winVfsAppData winAppData = {
  39093. &winIoMethod, /* pMethod */
  39094. 0, /* pAppData */
  39095. 0 /* bNoLock */
  39096. };
  39097. static winVfsAppData winNolockAppData = {
  39098. &winIoNolockMethod, /* pMethod */
  39099. 0, /* pAppData */
  39100. 1 /* bNoLock */
  39101. };
  39102. /****************************************************************************
  39103. **************************** sqlite3_vfs methods ****************************
  39104. **
  39105. ** This division contains the implementation of methods on the
  39106. ** sqlite3_vfs object.
  39107. */
  39108. #if defined(__CYGWIN__)
  39109. /*
  39110. ** Convert a filename from whatever the underlying operating system
  39111. ** supports for filenames into UTF-8. Space to hold the result is
  39112. ** obtained from malloc and must be freed by the calling function.
  39113. */
  39114. static char *winConvertToUtf8Filename(const void *zFilename){
  39115. char *zConverted = 0;
  39116. if( osIsNT() ){
  39117. zConverted = winUnicodeToUtf8(zFilename);
  39118. }
  39119. #ifdef SQLITE_WIN32_HAS_ANSI
  39120. else{
  39121. zConverted = winMbcsToUtf8(zFilename, osAreFileApisANSI());
  39122. }
  39123. #endif
  39124. /* caller will handle out of memory */
  39125. return zConverted;
  39126. }
  39127. #endif
  39128. /*
  39129. ** Convert a UTF-8 filename into whatever form the underlying
  39130. ** operating system wants filenames in. Space to hold the result
  39131. ** is obtained from malloc and must be freed by the calling
  39132. ** function.
  39133. */
  39134. static void *winConvertFromUtf8Filename(const char *zFilename){
  39135. void *zConverted = 0;
  39136. if( osIsNT() ){
  39137. zConverted = winUtf8ToUnicode(zFilename);
  39138. }
  39139. #ifdef SQLITE_WIN32_HAS_ANSI
  39140. else{
  39141. zConverted = winUtf8ToMbcs(zFilename, osAreFileApisANSI());
  39142. }
  39143. #endif
  39144. /* caller will handle out of memory */
  39145. return zConverted;
  39146. }
  39147. /*
  39148. ** This function returns non-zero if the specified UTF-8 string buffer
  39149. ** ends with a directory separator character or one was successfully
  39150. ** added to it.
  39151. */
  39152. static int winMakeEndInDirSep(int nBuf, char *zBuf){
  39153. if( zBuf ){
  39154. int nLen = sqlite3Strlen30(zBuf);
  39155. if( nLen>0 ){
  39156. if( winIsDirSep(zBuf[nLen-1]) ){
  39157. return 1;
  39158. }else if( nLen+1<nBuf ){
  39159. zBuf[nLen] = winGetDirSep();
  39160. zBuf[nLen+1] = '\0';
  39161. return 1;
  39162. }
  39163. }
  39164. }
  39165. return 0;
  39166. }
  39167. /*
  39168. ** Create a temporary file name and store the resulting pointer into pzBuf.
  39169. ** The pointer returned in pzBuf must be freed via sqlite3_free().
  39170. */
  39171. static int winGetTempname(sqlite3_vfs *pVfs, char **pzBuf){
  39172. static char zChars[] =
  39173. "abcdefghijklmnopqrstuvwxyz"
  39174. "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  39175. "0123456789";
  39176. size_t i, j;
  39177. int nPre = sqlite3Strlen30(SQLITE_TEMP_FILE_PREFIX);
  39178. int nMax, nBuf, nDir, nLen;
  39179. char *zBuf;
  39180. /* It's odd to simulate an io-error here, but really this is just
  39181. ** using the io-error infrastructure to test that SQLite handles this
  39182. ** function failing.
  39183. */
  39184. SimulateIOError( return SQLITE_IOERR );
  39185. /* Allocate a temporary buffer to store the fully qualified file
  39186. ** name for the temporary file. If this fails, we cannot continue.
  39187. */
  39188. nMax = pVfs->mxPathname; nBuf = nMax + 2;
  39189. zBuf = sqlite3MallocZero( nBuf );
  39190. if( !zBuf ){
  39191. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39192. return SQLITE_IOERR_NOMEM_BKPT;
  39193. }
  39194. /* Figure out the effective temporary directory. First, check if one
  39195. ** has been explicitly set by the application; otherwise, use the one
  39196. ** configured by the operating system.
  39197. */
  39198. nDir = nMax - (nPre + 15);
  39199. assert( nDir>0 );
  39200. if( sqlite3_temp_directory ){
  39201. int nDirLen = sqlite3Strlen30(sqlite3_temp_directory);
  39202. if( nDirLen>0 ){
  39203. if( !winIsDirSep(sqlite3_temp_directory[nDirLen-1]) ){
  39204. nDirLen++;
  39205. }
  39206. if( nDirLen>nDir ){
  39207. sqlite3_free(zBuf);
  39208. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  39209. return winLogError(SQLITE_ERROR, 0, "winGetTempname1", 0);
  39210. }
  39211. sqlite3_snprintf(nMax, zBuf, "%s", sqlite3_temp_directory);
  39212. }
  39213. }
  39214. #if defined(__CYGWIN__)
  39215. else{
  39216. static const char *azDirs[] = {
  39217. 0, /* getenv("SQLITE_TMPDIR") */
  39218. 0, /* getenv("TMPDIR") */
  39219. 0, /* getenv("TMP") */
  39220. 0, /* getenv("TEMP") */
  39221. 0, /* getenv("USERPROFILE") */
  39222. "/var/tmp",
  39223. "/usr/tmp",
  39224. "/tmp",
  39225. ".",
  39226. 0 /* List terminator */
  39227. };
  39228. unsigned int i;
  39229. const char *zDir = 0;
  39230. if( !azDirs[0] ) azDirs[0] = getenv("SQLITE_TMPDIR");
  39231. if( !azDirs[1] ) azDirs[1] = getenv("TMPDIR");
  39232. if( !azDirs[2] ) azDirs[2] = getenv("TMP");
  39233. if( !azDirs[3] ) azDirs[3] = getenv("TEMP");
  39234. if( !azDirs[4] ) azDirs[4] = getenv("USERPROFILE");
  39235. for(i=0; i<sizeof(azDirs)/sizeof(azDirs[0]); zDir=azDirs[i++]){
  39236. void *zConverted;
  39237. if( zDir==0 ) continue;
  39238. /* If the path starts with a drive letter followed by the colon
  39239. ** character, assume it is already a native Win32 path; otherwise,
  39240. ** it must be converted to a native Win32 path via the Cygwin API
  39241. ** prior to using it.
  39242. */
  39243. if( winIsDriveLetterAndColon(zDir) ){
  39244. zConverted = winConvertFromUtf8Filename(zDir);
  39245. if( !zConverted ){
  39246. sqlite3_free(zBuf);
  39247. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39248. return SQLITE_IOERR_NOMEM_BKPT;
  39249. }
  39250. if( winIsDir(zConverted) ){
  39251. sqlite3_snprintf(nMax, zBuf, "%s", zDir);
  39252. sqlite3_free(zConverted);
  39253. break;
  39254. }
  39255. sqlite3_free(zConverted);
  39256. }else{
  39257. zConverted = sqlite3MallocZero( nMax+1 );
  39258. if( !zConverted ){
  39259. sqlite3_free(zBuf);
  39260. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39261. return SQLITE_IOERR_NOMEM_BKPT;
  39262. }
  39263. if( cygwin_conv_path(
  39264. osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A, zDir,
  39265. zConverted, nMax+1)<0 ){
  39266. sqlite3_free(zConverted);
  39267. sqlite3_free(zBuf);
  39268. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_CONVPATH\n"));
  39269. return winLogError(SQLITE_IOERR_CONVPATH, (DWORD)errno,
  39270. "winGetTempname2", zDir);
  39271. }
  39272. if( winIsDir(zConverted) ){
  39273. /* At this point, we know the candidate directory exists and should
  39274. ** be used. However, we may need to convert the string containing
  39275. ** its name into UTF-8 (i.e. if it is UTF-16 right now).
  39276. */
  39277. char *zUtf8 = winConvertToUtf8Filename(zConverted);
  39278. if( !zUtf8 ){
  39279. sqlite3_free(zConverted);
  39280. sqlite3_free(zBuf);
  39281. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39282. return SQLITE_IOERR_NOMEM_BKPT;
  39283. }
  39284. sqlite3_snprintf(nMax, zBuf, "%s", zUtf8);
  39285. sqlite3_free(zUtf8);
  39286. sqlite3_free(zConverted);
  39287. break;
  39288. }
  39289. sqlite3_free(zConverted);
  39290. }
  39291. }
  39292. }
  39293. #elif !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  39294. else if( osIsNT() ){
  39295. char *zMulti;
  39296. LPWSTR zWidePath = sqlite3MallocZero( nMax*sizeof(WCHAR) );
  39297. if( !zWidePath ){
  39298. sqlite3_free(zBuf);
  39299. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39300. return SQLITE_IOERR_NOMEM_BKPT;
  39301. }
  39302. if( osGetTempPathW(nMax, zWidePath)==0 ){
  39303. sqlite3_free(zWidePath);
  39304. sqlite3_free(zBuf);
  39305. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_GETTEMPPATH\n"));
  39306. return winLogError(SQLITE_IOERR_GETTEMPPATH, osGetLastError(),
  39307. "winGetTempname2", 0);
  39308. }
  39309. zMulti = winUnicodeToUtf8(zWidePath);
  39310. if( zMulti ){
  39311. sqlite3_snprintf(nMax, zBuf, "%s", zMulti);
  39312. sqlite3_free(zMulti);
  39313. sqlite3_free(zWidePath);
  39314. }else{
  39315. sqlite3_free(zWidePath);
  39316. sqlite3_free(zBuf);
  39317. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39318. return SQLITE_IOERR_NOMEM_BKPT;
  39319. }
  39320. }
  39321. #ifdef SQLITE_WIN32_HAS_ANSI
  39322. else{
  39323. char *zUtf8;
  39324. char *zMbcsPath = sqlite3MallocZero( nMax );
  39325. if( !zMbcsPath ){
  39326. sqlite3_free(zBuf);
  39327. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39328. return SQLITE_IOERR_NOMEM_BKPT;
  39329. }
  39330. if( osGetTempPathA(nMax, zMbcsPath)==0 ){
  39331. sqlite3_free(zBuf);
  39332. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_GETTEMPPATH\n"));
  39333. return winLogError(SQLITE_IOERR_GETTEMPPATH, osGetLastError(),
  39334. "winGetTempname3", 0);
  39335. }
  39336. zUtf8 = winMbcsToUtf8(zMbcsPath, osAreFileApisANSI());
  39337. if( zUtf8 ){
  39338. sqlite3_snprintf(nMax, zBuf, "%s", zUtf8);
  39339. sqlite3_free(zUtf8);
  39340. }else{
  39341. sqlite3_free(zBuf);
  39342. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  39343. return SQLITE_IOERR_NOMEM_BKPT;
  39344. }
  39345. }
  39346. #endif /* SQLITE_WIN32_HAS_ANSI */
  39347. #endif /* !SQLITE_OS_WINRT */
  39348. /*
  39349. ** Check to make sure the temporary directory ends with an appropriate
  39350. ** separator. If it does not and there is not enough space left to add
  39351. ** one, fail.
  39352. */
  39353. if( !winMakeEndInDirSep(nDir+1, zBuf) ){
  39354. sqlite3_free(zBuf);
  39355. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  39356. return winLogError(SQLITE_ERROR, 0, "winGetTempname4", 0);
  39357. }
  39358. /*
  39359. ** Check that the output buffer is large enough for the temporary file
  39360. ** name in the following format:
  39361. **
  39362. ** "<temporary_directory>/etilqs_XXXXXXXXXXXXXXX\0\0"
  39363. **
  39364. ** If not, return SQLITE_ERROR. The number 17 is used here in order to
  39365. ** account for the space used by the 15 character random suffix and the
  39366. ** two trailing NUL characters. The final directory separator character
  39367. ** has already added if it was not already present.
  39368. */
  39369. nLen = sqlite3Strlen30(zBuf);
  39370. if( (nLen + nPre + 17) > nBuf ){
  39371. sqlite3_free(zBuf);
  39372. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  39373. return winLogError(SQLITE_ERROR, 0, "winGetTempname5", 0);
  39374. }
  39375. sqlite3_snprintf(nBuf-16-nLen, zBuf+nLen, SQLITE_TEMP_FILE_PREFIX);
  39376. j = sqlite3Strlen30(zBuf);
  39377. sqlite3_randomness(15, &zBuf[j]);
  39378. for(i=0; i<15; i++, j++){
  39379. zBuf[j] = (char)zChars[ ((unsigned char)zBuf[j])%(sizeof(zChars)-1) ];
  39380. }
  39381. zBuf[j] = 0;
  39382. zBuf[j+1] = 0;
  39383. *pzBuf = zBuf;
  39384. OSTRACE(("TEMP-FILENAME name=%s, rc=SQLITE_OK\n", zBuf));
  39385. return SQLITE_OK;
  39386. }
  39387. /*
  39388. ** Return TRUE if the named file is really a directory. Return false if
  39389. ** it is something other than a directory, or if there is any kind of memory
  39390. ** allocation failure.
  39391. */
  39392. static int winIsDir(const void *zConverted){
  39393. DWORD attr;
  39394. int rc = 0;
  39395. DWORD lastErrno;
  39396. if( osIsNT() ){
  39397. int cnt = 0;
  39398. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  39399. memset(&sAttrData, 0, sizeof(sAttrData));
  39400. while( !(rc = osGetFileAttributesExW((LPCWSTR)zConverted,
  39401. GetFileExInfoStandard,
  39402. &sAttrData)) && winRetryIoerr(&cnt, &lastErrno) ){}
  39403. if( !rc ){
  39404. return 0; /* Invalid name? */
  39405. }
  39406. attr = sAttrData.dwFileAttributes;
  39407. #if SQLITE_OS_WINCE==0
  39408. }else{
  39409. attr = osGetFileAttributesA((char*)zConverted);
  39410. #endif
  39411. }
  39412. return (attr!=INVALID_FILE_ATTRIBUTES) && (attr&FILE_ATTRIBUTE_DIRECTORY);
  39413. }
  39414. /*
  39415. ** Open a file.
  39416. */
  39417. static int winOpen(
  39418. sqlite3_vfs *pVfs, /* Used to get maximum path length and AppData */
  39419. const char *zName, /* Name of the file (UTF-8) */
  39420. sqlite3_file *id, /* Write the SQLite file handle here */
  39421. int flags, /* Open mode flags */
  39422. int *pOutFlags /* Status return flags */
  39423. ){
  39424. HANDLE h;
  39425. DWORD lastErrno = 0;
  39426. DWORD dwDesiredAccess;
  39427. DWORD dwShareMode;
  39428. DWORD dwCreationDisposition;
  39429. DWORD dwFlagsAndAttributes = 0;
  39430. #if SQLITE_OS_WINCE
  39431. int isTemp = 0;
  39432. #endif
  39433. winVfsAppData *pAppData;
  39434. winFile *pFile = (winFile*)id;
  39435. void *zConverted; /* Filename in OS encoding */
  39436. const char *zUtf8Name = zName; /* Filename in UTF-8 encoding */
  39437. int cnt = 0;
  39438. /* If argument zPath is a NULL pointer, this function is required to open
  39439. ** a temporary file. Use this buffer to store the file name in.
  39440. */
  39441. char *zTmpname = 0; /* For temporary filename, if necessary. */
  39442. int rc = SQLITE_OK; /* Function Return Code */
  39443. #if !defined(NDEBUG) || SQLITE_OS_WINCE
  39444. int eType = flags&0xFFFFFF00; /* Type of file to open */
  39445. #endif
  39446. int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
  39447. int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
  39448. int isCreate = (flags & SQLITE_OPEN_CREATE);
  39449. int isReadonly = (flags & SQLITE_OPEN_READONLY);
  39450. int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
  39451. #ifndef NDEBUG
  39452. int isOpenJournal = (isCreate && (
  39453. eType==SQLITE_OPEN_MASTER_JOURNAL
  39454. || eType==SQLITE_OPEN_MAIN_JOURNAL
  39455. || eType==SQLITE_OPEN_WAL
  39456. ));
  39457. #endif
  39458. OSTRACE(("OPEN name=%s, pFile=%p, flags=%x, pOutFlags=%p\n",
  39459. zUtf8Name, id, flags, pOutFlags));
  39460. /* Check the following statements are true:
  39461. **
  39462. ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
  39463. ** (b) if CREATE is set, then READWRITE must also be set, and
  39464. ** (c) if EXCLUSIVE is set, then CREATE must also be set.
  39465. ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
  39466. */
  39467. assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
  39468. assert(isCreate==0 || isReadWrite);
  39469. assert(isExclusive==0 || isCreate);
  39470. assert(isDelete==0 || isCreate);
  39471. /* The main DB, main journal, WAL file and master journal are never
  39472. ** automatically deleted. Nor are they ever temporary files. */
  39473. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_DB );
  39474. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_JOURNAL );
  39475. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MASTER_JOURNAL );
  39476. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_WAL );
  39477. /* Assert that the upper layer has set one of the "file-type" flags. */
  39478. assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
  39479. || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
  39480. || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
  39481. || eType==SQLITE_OPEN_TRANSIENT_DB || eType==SQLITE_OPEN_WAL
  39482. );
  39483. assert( pFile!=0 );
  39484. memset(pFile, 0, sizeof(winFile));
  39485. pFile->h = INVALID_HANDLE_VALUE;
  39486. #if SQLITE_OS_WINRT
  39487. if( !zUtf8Name && !sqlite3_temp_directory ){
  39488. sqlite3_log(SQLITE_ERROR,
  39489. "sqlite3_temp_directory variable should be set for WinRT");
  39490. }
  39491. #endif
  39492. /* If the second argument to this function is NULL, generate a
  39493. ** temporary file name to use
  39494. */
  39495. if( !zUtf8Name ){
  39496. assert( isDelete && !isOpenJournal );
  39497. rc = winGetTempname(pVfs, &zTmpname);
  39498. if( rc!=SQLITE_OK ){
  39499. OSTRACE(("OPEN name=%s, rc=%s", zUtf8Name, sqlite3ErrName(rc)));
  39500. return rc;
  39501. }
  39502. zUtf8Name = zTmpname;
  39503. }
  39504. /* Database filenames are double-zero terminated if they are not
  39505. ** URIs with parameters. Hence, they can always be passed into
  39506. ** sqlite3_uri_parameter().
  39507. */
  39508. assert( (eType!=SQLITE_OPEN_MAIN_DB) || (flags & SQLITE_OPEN_URI) ||
  39509. zUtf8Name[sqlite3Strlen30(zUtf8Name)+1]==0 );
  39510. /* Convert the filename to the system encoding. */
  39511. zConverted = winConvertFromUtf8Filename(zUtf8Name);
  39512. if( zConverted==0 ){
  39513. sqlite3_free(zTmpname);
  39514. OSTRACE(("OPEN name=%s, rc=SQLITE_IOERR_NOMEM", zUtf8Name));
  39515. return SQLITE_IOERR_NOMEM_BKPT;
  39516. }
  39517. if( winIsDir(zConverted) ){
  39518. sqlite3_free(zConverted);
  39519. sqlite3_free(zTmpname);
  39520. OSTRACE(("OPEN name=%s, rc=SQLITE_CANTOPEN_ISDIR", zUtf8Name));
  39521. return SQLITE_CANTOPEN_ISDIR;
  39522. }
  39523. if( isReadWrite ){
  39524. dwDesiredAccess = GENERIC_READ | GENERIC_WRITE;
  39525. }else{
  39526. dwDesiredAccess = GENERIC_READ;
  39527. }
  39528. /* SQLITE_OPEN_EXCLUSIVE is used to make sure that a new file is
  39529. ** created. SQLite doesn't use it to indicate "exclusive access"
  39530. ** as it is usually understood.
  39531. */
  39532. if( isExclusive ){
  39533. /* Creates a new file, only if it does not already exist. */
  39534. /* If the file exists, it fails. */
  39535. dwCreationDisposition = CREATE_NEW;
  39536. }else if( isCreate ){
  39537. /* Open existing file, or create if it doesn't exist */
  39538. dwCreationDisposition = OPEN_ALWAYS;
  39539. }else{
  39540. /* Opens a file, only if it exists. */
  39541. dwCreationDisposition = OPEN_EXISTING;
  39542. }
  39543. dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE;
  39544. if( isDelete ){
  39545. #if SQLITE_OS_WINCE
  39546. dwFlagsAndAttributes = FILE_ATTRIBUTE_HIDDEN;
  39547. isTemp = 1;
  39548. #else
  39549. dwFlagsAndAttributes = FILE_ATTRIBUTE_TEMPORARY
  39550. | FILE_ATTRIBUTE_HIDDEN
  39551. | FILE_FLAG_DELETE_ON_CLOSE;
  39552. #endif
  39553. }else{
  39554. dwFlagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
  39555. }
  39556. /* Reports from the internet are that performance is always
  39557. ** better if FILE_FLAG_RANDOM_ACCESS is used. Ticket #2699. */
  39558. #if SQLITE_OS_WINCE
  39559. dwFlagsAndAttributes |= FILE_FLAG_RANDOM_ACCESS;
  39560. #endif
  39561. if( osIsNT() ){
  39562. #if SQLITE_OS_WINRT
  39563. CREATEFILE2_EXTENDED_PARAMETERS extendedParameters;
  39564. extendedParameters.dwSize = sizeof(CREATEFILE2_EXTENDED_PARAMETERS);
  39565. extendedParameters.dwFileAttributes =
  39566. dwFlagsAndAttributes & FILE_ATTRIBUTE_MASK;
  39567. extendedParameters.dwFileFlags = dwFlagsAndAttributes & FILE_FLAG_MASK;
  39568. extendedParameters.dwSecurityQosFlags = SECURITY_ANONYMOUS;
  39569. extendedParameters.lpSecurityAttributes = NULL;
  39570. extendedParameters.hTemplateFile = NULL;
  39571. while( (h = osCreateFile2((LPCWSTR)zConverted,
  39572. dwDesiredAccess,
  39573. dwShareMode,
  39574. dwCreationDisposition,
  39575. &extendedParameters))==INVALID_HANDLE_VALUE &&
  39576. winRetryIoerr(&cnt, &lastErrno) ){
  39577. /* Noop */
  39578. }
  39579. #else
  39580. while( (h = osCreateFileW((LPCWSTR)zConverted,
  39581. dwDesiredAccess,
  39582. dwShareMode, NULL,
  39583. dwCreationDisposition,
  39584. dwFlagsAndAttributes,
  39585. NULL))==INVALID_HANDLE_VALUE &&
  39586. winRetryIoerr(&cnt, &lastErrno) ){
  39587. /* Noop */
  39588. }
  39589. #endif
  39590. }
  39591. #ifdef SQLITE_WIN32_HAS_ANSI
  39592. else{
  39593. while( (h = osCreateFileA((LPCSTR)zConverted,
  39594. dwDesiredAccess,
  39595. dwShareMode, NULL,
  39596. dwCreationDisposition,
  39597. dwFlagsAndAttributes,
  39598. NULL))==INVALID_HANDLE_VALUE &&
  39599. winRetryIoerr(&cnt, &lastErrno) ){
  39600. /* Noop */
  39601. }
  39602. }
  39603. #endif
  39604. winLogIoerr(cnt, __LINE__);
  39605. OSTRACE(("OPEN file=%p, name=%s, access=%lx, rc=%s\n", h, zUtf8Name,
  39606. dwDesiredAccess, (h==INVALID_HANDLE_VALUE) ? "failed" : "ok"));
  39607. if( h==INVALID_HANDLE_VALUE ){
  39608. pFile->lastErrno = lastErrno;
  39609. winLogError(SQLITE_CANTOPEN, pFile->lastErrno, "winOpen", zUtf8Name);
  39610. sqlite3_free(zConverted);
  39611. sqlite3_free(zTmpname);
  39612. if( isReadWrite && !isExclusive ){
  39613. return winOpen(pVfs, zName, id,
  39614. ((flags|SQLITE_OPEN_READONLY) &
  39615. ~(SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE)),
  39616. pOutFlags);
  39617. }else{
  39618. return SQLITE_CANTOPEN_BKPT;
  39619. }
  39620. }
  39621. if( pOutFlags ){
  39622. if( isReadWrite ){
  39623. *pOutFlags = SQLITE_OPEN_READWRITE;
  39624. }else{
  39625. *pOutFlags = SQLITE_OPEN_READONLY;
  39626. }
  39627. }
  39628. OSTRACE(("OPEN file=%p, name=%s, access=%lx, pOutFlags=%p, *pOutFlags=%d, "
  39629. "rc=%s\n", h, zUtf8Name, dwDesiredAccess, pOutFlags, pOutFlags ?
  39630. *pOutFlags : 0, (h==INVALID_HANDLE_VALUE) ? "failed" : "ok"));
  39631. pAppData = (winVfsAppData*)pVfs->pAppData;
  39632. #if SQLITE_OS_WINCE
  39633. {
  39634. if( isReadWrite && eType==SQLITE_OPEN_MAIN_DB
  39635. && ((pAppData==NULL) || !pAppData->bNoLock)
  39636. && (rc = winceCreateLock(zName, pFile))!=SQLITE_OK
  39637. ){
  39638. osCloseHandle(h);
  39639. sqlite3_free(zConverted);
  39640. sqlite3_free(zTmpname);
  39641. OSTRACE(("OPEN-CE-LOCK name=%s, rc=%s\n", zName, sqlite3ErrName(rc)));
  39642. return rc;
  39643. }
  39644. }
  39645. if( isTemp ){
  39646. pFile->zDeleteOnClose = zConverted;
  39647. }else
  39648. #endif
  39649. {
  39650. sqlite3_free(zConverted);
  39651. }
  39652. sqlite3_free(zTmpname);
  39653. pFile->pMethod = pAppData ? pAppData->pMethod : &winIoMethod;
  39654. pFile->pVfs = pVfs;
  39655. pFile->h = h;
  39656. if( isReadonly ){
  39657. pFile->ctrlFlags |= WINFILE_RDONLY;
  39658. }
  39659. if( sqlite3_uri_boolean(zName, "psow", SQLITE_POWERSAFE_OVERWRITE) ){
  39660. pFile->ctrlFlags |= WINFILE_PSOW;
  39661. }
  39662. pFile->lastErrno = NO_ERROR;
  39663. pFile->zPath = zName;
  39664. #if SQLITE_MAX_MMAP_SIZE>0
  39665. pFile->hMap = NULL;
  39666. pFile->pMapRegion = 0;
  39667. pFile->mmapSize = 0;
  39668. pFile->mmapSizeActual = 0;
  39669. pFile->mmapSizeMax = sqlite3GlobalConfig.szMmap;
  39670. #endif
  39671. OpenCounter(+1);
  39672. return rc;
  39673. }
  39674. /*
  39675. ** Delete the named file.
  39676. **
  39677. ** Note that Windows does not allow a file to be deleted if some other
  39678. ** process has it open. Sometimes a virus scanner or indexing program
  39679. ** will open a journal file shortly after it is created in order to do
  39680. ** whatever it does. While this other process is holding the
  39681. ** file open, we will be unable to delete it. To work around this
  39682. ** problem, we delay 100 milliseconds and try to delete again. Up
  39683. ** to MX_DELETION_ATTEMPTs deletion attempts are run before giving
  39684. ** up and returning an error.
  39685. */
  39686. static int winDelete(
  39687. sqlite3_vfs *pVfs, /* Not used on win32 */
  39688. const char *zFilename, /* Name of file to delete */
  39689. int syncDir /* Not used on win32 */
  39690. ){
  39691. int cnt = 0;
  39692. int rc;
  39693. DWORD attr;
  39694. DWORD lastErrno = 0;
  39695. void *zConverted;
  39696. UNUSED_PARAMETER(pVfs);
  39697. UNUSED_PARAMETER(syncDir);
  39698. SimulateIOError(return SQLITE_IOERR_DELETE);
  39699. OSTRACE(("DELETE name=%s, syncDir=%d\n", zFilename, syncDir));
  39700. zConverted = winConvertFromUtf8Filename(zFilename);
  39701. if( zConverted==0 ){
  39702. OSTRACE(("DELETE name=%s, rc=SQLITE_IOERR_NOMEM\n", zFilename));
  39703. return SQLITE_IOERR_NOMEM_BKPT;
  39704. }
  39705. if( osIsNT() ){
  39706. do {
  39707. #if SQLITE_OS_WINRT
  39708. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  39709. memset(&sAttrData, 0, sizeof(sAttrData));
  39710. if ( osGetFileAttributesExW(zConverted, GetFileExInfoStandard,
  39711. &sAttrData) ){
  39712. attr = sAttrData.dwFileAttributes;
  39713. }else{
  39714. lastErrno = osGetLastError();
  39715. if( lastErrno==ERROR_FILE_NOT_FOUND
  39716. || lastErrno==ERROR_PATH_NOT_FOUND ){
  39717. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  39718. }else{
  39719. rc = SQLITE_ERROR;
  39720. }
  39721. break;
  39722. }
  39723. #else
  39724. attr = osGetFileAttributesW(zConverted);
  39725. #endif
  39726. if ( attr==INVALID_FILE_ATTRIBUTES ){
  39727. lastErrno = osGetLastError();
  39728. if( lastErrno==ERROR_FILE_NOT_FOUND
  39729. || lastErrno==ERROR_PATH_NOT_FOUND ){
  39730. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  39731. }else{
  39732. rc = SQLITE_ERROR;
  39733. }
  39734. break;
  39735. }
  39736. if ( attr&FILE_ATTRIBUTE_DIRECTORY ){
  39737. rc = SQLITE_ERROR; /* Files only. */
  39738. break;
  39739. }
  39740. if ( osDeleteFileW(zConverted) ){
  39741. rc = SQLITE_OK; /* Deleted OK. */
  39742. break;
  39743. }
  39744. if ( !winRetryIoerr(&cnt, &lastErrno) ){
  39745. rc = SQLITE_ERROR; /* No more retries. */
  39746. break;
  39747. }
  39748. } while(1);
  39749. }
  39750. #ifdef SQLITE_WIN32_HAS_ANSI
  39751. else{
  39752. do {
  39753. attr = osGetFileAttributesA(zConverted);
  39754. if ( attr==INVALID_FILE_ATTRIBUTES ){
  39755. lastErrno = osGetLastError();
  39756. if( lastErrno==ERROR_FILE_NOT_FOUND
  39757. || lastErrno==ERROR_PATH_NOT_FOUND ){
  39758. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  39759. }else{
  39760. rc = SQLITE_ERROR;
  39761. }
  39762. break;
  39763. }
  39764. if ( attr&FILE_ATTRIBUTE_DIRECTORY ){
  39765. rc = SQLITE_ERROR; /* Files only. */
  39766. break;
  39767. }
  39768. if ( osDeleteFileA(zConverted) ){
  39769. rc = SQLITE_OK; /* Deleted OK. */
  39770. break;
  39771. }
  39772. if ( !winRetryIoerr(&cnt, &lastErrno) ){
  39773. rc = SQLITE_ERROR; /* No more retries. */
  39774. break;
  39775. }
  39776. } while(1);
  39777. }
  39778. #endif
  39779. if( rc && rc!=SQLITE_IOERR_DELETE_NOENT ){
  39780. rc = winLogError(SQLITE_IOERR_DELETE, lastErrno, "winDelete", zFilename);
  39781. }else{
  39782. winLogIoerr(cnt, __LINE__);
  39783. }
  39784. sqlite3_free(zConverted);
  39785. OSTRACE(("DELETE name=%s, rc=%s\n", zFilename, sqlite3ErrName(rc)));
  39786. return rc;
  39787. }
  39788. /*
  39789. ** Check the existence and status of a file.
  39790. */
  39791. static int winAccess(
  39792. sqlite3_vfs *pVfs, /* Not used on win32 */
  39793. const char *zFilename, /* Name of file to check */
  39794. int flags, /* Type of test to make on this file */
  39795. int *pResOut /* OUT: Result */
  39796. ){
  39797. DWORD attr;
  39798. int rc = 0;
  39799. DWORD lastErrno = 0;
  39800. void *zConverted;
  39801. UNUSED_PARAMETER(pVfs);
  39802. SimulateIOError( return SQLITE_IOERR_ACCESS; );
  39803. OSTRACE(("ACCESS name=%s, flags=%x, pResOut=%p\n",
  39804. zFilename, flags, pResOut));
  39805. zConverted = winConvertFromUtf8Filename(zFilename);
  39806. if( zConverted==0 ){
  39807. OSTRACE(("ACCESS name=%s, rc=SQLITE_IOERR_NOMEM\n", zFilename));
  39808. return SQLITE_IOERR_NOMEM_BKPT;
  39809. }
  39810. if( osIsNT() ){
  39811. int cnt = 0;
  39812. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  39813. memset(&sAttrData, 0, sizeof(sAttrData));
  39814. while( !(rc = osGetFileAttributesExW((LPCWSTR)zConverted,
  39815. GetFileExInfoStandard,
  39816. &sAttrData)) && winRetryIoerr(&cnt, &lastErrno) ){}
  39817. if( rc ){
  39818. /* For an SQLITE_ACCESS_EXISTS query, treat a zero-length file
  39819. ** as if it does not exist.
  39820. */
  39821. if( flags==SQLITE_ACCESS_EXISTS
  39822. && sAttrData.nFileSizeHigh==0
  39823. && sAttrData.nFileSizeLow==0 ){
  39824. attr = INVALID_FILE_ATTRIBUTES;
  39825. }else{
  39826. attr = sAttrData.dwFileAttributes;
  39827. }
  39828. }else{
  39829. winLogIoerr(cnt, __LINE__);
  39830. if( lastErrno!=ERROR_FILE_NOT_FOUND && lastErrno!=ERROR_PATH_NOT_FOUND ){
  39831. sqlite3_free(zConverted);
  39832. return winLogError(SQLITE_IOERR_ACCESS, lastErrno, "winAccess",
  39833. zFilename);
  39834. }else{
  39835. attr = INVALID_FILE_ATTRIBUTES;
  39836. }
  39837. }
  39838. }
  39839. #ifdef SQLITE_WIN32_HAS_ANSI
  39840. else{
  39841. attr = osGetFileAttributesA((char*)zConverted);
  39842. }
  39843. #endif
  39844. sqlite3_free(zConverted);
  39845. switch( flags ){
  39846. case SQLITE_ACCESS_READ:
  39847. case SQLITE_ACCESS_EXISTS:
  39848. rc = attr!=INVALID_FILE_ATTRIBUTES;
  39849. break;
  39850. case SQLITE_ACCESS_READWRITE:
  39851. rc = attr!=INVALID_FILE_ATTRIBUTES &&
  39852. (attr & FILE_ATTRIBUTE_READONLY)==0;
  39853. break;
  39854. default:
  39855. assert(!"Invalid flags argument");
  39856. }
  39857. *pResOut = rc;
  39858. OSTRACE(("ACCESS name=%s, pResOut=%p, *pResOut=%d, rc=SQLITE_OK\n",
  39859. zFilename, pResOut, *pResOut));
  39860. return SQLITE_OK;
  39861. }
  39862. /*
  39863. ** Returns non-zero if the specified path name starts with a drive letter
  39864. ** followed by a colon character.
  39865. */
  39866. static BOOL winIsDriveLetterAndColon(
  39867. const char *zPathname
  39868. ){
  39869. return ( sqlite3Isalpha(zPathname[0]) && zPathname[1]==':' );
  39870. }
  39871. /*
  39872. ** Returns non-zero if the specified path name should be used verbatim. If
  39873. ** non-zero is returned from this function, the calling function must simply
  39874. ** use the provided path name verbatim -OR- resolve it into a full path name
  39875. ** using the GetFullPathName Win32 API function (if available).
  39876. */
  39877. static BOOL winIsVerbatimPathname(
  39878. const char *zPathname
  39879. ){
  39880. /*
  39881. ** If the path name starts with a forward slash or a backslash, it is either
  39882. ** a legal UNC name, a volume relative path, or an absolute path name in the
  39883. ** "Unix" format on Windows. There is no easy way to differentiate between
  39884. ** the final two cases; therefore, we return the safer return value of TRUE
  39885. ** so that callers of this function will simply use it verbatim.
  39886. */
  39887. if ( winIsDirSep(zPathname[0]) ){
  39888. return TRUE;
  39889. }
  39890. /*
  39891. ** If the path name starts with a letter and a colon it is either a volume
  39892. ** relative path or an absolute path. Callers of this function must not
  39893. ** attempt to treat it as a relative path name (i.e. they should simply use
  39894. ** it verbatim).
  39895. */
  39896. if ( winIsDriveLetterAndColon(zPathname) ){
  39897. return TRUE;
  39898. }
  39899. /*
  39900. ** If we get to this point, the path name should almost certainly be a purely
  39901. ** relative one (i.e. not a UNC name, not absolute, and not volume relative).
  39902. */
  39903. return FALSE;
  39904. }
  39905. /*
  39906. ** Turn a relative pathname into a full pathname. Write the full
  39907. ** pathname into zOut[]. zOut[] will be at least pVfs->mxPathname
  39908. ** bytes in size.
  39909. */
  39910. static int winFullPathname(
  39911. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  39912. const char *zRelative, /* Possibly relative input path */
  39913. int nFull, /* Size of output buffer in bytes */
  39914. char *zFull /* Output buffer */
  39915. ){
  39916. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  39917. DWORD nByte;
  39918. void *zConverted;
  39919. char *zOut;
  39920. #endif
  39921. /* If this path name begins with "/X:", where "X" is any alphabetic
  39922. ** character, discard the initial "/" from the pathname.
  39923. */
  39924. if( zRelative[0]=='/' && winIsDriveLetterAndColon(zRelative+1) ){
  39925. zRelative++;
  39926. }
  39927. #if defined(__CYGWIN__)
  39928. SimulateIOError( return SQLITE_ERROR );
  39929. UNUSED_PARAMETER(nFull);
  39930. assert( nFull>=pVfs->mxPathname );
  39931. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  39932. /*
  39933. ** NOTE: We are dealing with a relative path name and the data
  39934. ** directory has been set. Therefore, use it as the basis
  39935. ** for converting the relative path name to an absolute
  39936. ** one by prepending the data directory and a slash.
  39937. */
  39938. char *zOut = sqlite3MallocZero( pVfs->mxPathname+1 );
  39939. if( !zOut ){
  39940. return SQLITE_IOERR_NOMEM_BKPT;
  39941. }
  39942. if( cygwin_conv_path(
  39943. (osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A) |
  39944. CCP_RELATIVE, zRelative, zOut, pVfs->mxPathname+1)<0 ){
  39945. sqlite3_free(zOut);
  39946. return winLogError(SQLITE_CANTOPEN_CONVPATH, (DWORD)errno,
  39947. "winFullPathname1", zRelative);
  39948. }else{
  39949. char *zUtf8 = winConvertToUtf8Filename(zOut);
  39950. if( !zUtf8 ){
  39951. sqlite3_free(zOut);
  39952. return SQLITE_IOERR_NOMEM_BKPT;
  39953. }
  39954. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  39955. sqlite3_data_directory, winGetDirSep(), zUtf8);
  39956. sqlite3_free(zUtf8);
  39957. sqlite3_free(zOut);
  39958. }
  39959. }else{
  39960. char *zOut = sqlite3MallocZero( pVfs->mxPathname+1 );
  39961. if( !zOut ){
  39962. return SQLITE_IOERR_NOMEM_BKPT;
  39963. }
  39964. if( cygwin_conv_path(
  39965. (osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A),
  39966. zRelative, zOut, pVfs->mxPathname+1)<0 ){
  39967. sqlite3_free(zOut);
  39968. return winLogError(SQLITE_CANTOPEN_CONVPATH, (DWORD)errno,
  39969. "winFullPathname2", zRelative);
  39970. }else{
  39971. char *zUtf8 = winConvertToUtf8Filename(zOut);
  39972. if( !zUtf8 ){
  39973. sqlite3_free(zOut);
  39974. return SQLITE_IOERR_NOMEM_BKPT;
  39975. }
  39976. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zUtf8);
  39977. sqlite3_free(zUtf8);
  39978. sqlite3_free(zOut);
  39979. }
  39980. }
  39981. return SQLITE_OK;
  39982. #endif
  39983. #if (SQLITE_OS_WINCE || SQLITE_OS_WINRT) && !defined(__CYGWIN__)
  39984. SimulateIOError( return SQLITE_ERROR );
  39985. /* WinCE has no concept of a relative pathname, or so I am told. */
  39986. /* WinRT has no way to convert a relative path to an absolute one. */
  39987. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  39988. /*
  39989. ** NOTE: We are dealing with a relative path name and the data
  39990. ** directory has been set. Therefore, use it as the basis
  39991. ** for converting the relative path name to an absolute
  39992. ** one by prepending the data directory and a backslash.
  39993. */
  39994. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  39995. sqlite3_data_directory, winGetDirSep(), zRelative);
  39996. }else{
  39997. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zRelative);
  39998. }
  39999. return SQLITE_OK;
  40000. #endif
  40001. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  40002. /* It's odd to simulate an io-error here, but really this is just
  40003. ** using the io-error infrastructure to test that SQLite handles this
  40004. ** function failing. This function could fail if, for example, the
  40005. ** current working directory has been unlinked.
  40006. */
  40007. SimulateIOError( return SQLITE_ERROR );
  40008. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  40009. /*
  40010. ** NOTE: We are dealing with a relative path name and the data
  40011. ** directory has been set. Therefore, use it as the basis
  40012. ** for converting the relative path name to an absolute
  40013. ** one by prepending the data directory and a backslash.
  40014. */
  40015. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  40016. sqlite3_data_directory, winGetDirSep(), zRelative);
  40017. return SQLITE_OK;
  40018. }
  40019. zConverted = winConvertFromUtf8Filename(zRelative);
  40020. if( zConverted==0 ){
  40021. return SQLITE_IOERR_NOMEM_BKPT;
  40022. }
  40023. if( osIsNT() ){
  40024. LPWSTR zTemp;
  40025. nByte = osGetFullPathNameW((LPCWSTR)zConverted, 0, 0, 0);
  40026. if( nByte==0 ){
  40027. sqlite3_free(zConverted);
  40028. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  40029. "winFullPathname1", zRelative);
  40030. }
  40031. nByte += 3;
  40032. zTemp = sqlite3MallocZero( nByte*sizeof(zTemp[0]) );
  40033. if( zTemp==0 ){
  40034. sqlite3_free(zConverted);
  40035. return SQLITE_IOERR_NOMEM_BKPT;
  40036. }
  40037. nByte = osGetFullPathNameW((LPCWSTR)zConverted, nByte, zTemp, 0);
  40038. if( nByte==0 ){
  40039. sqlite3_free(zConverted);
  40040. sqlite3_free(zTemp);
  40041. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  40042. "winFullPathname2", zRelative);
  40043. }
  40044. sqlite3_free(zConverted);
  40045. zOut = winUnicodeToUtf8(zTemp);
  40046. sqlite3_free(zTemp);
  40047. }
  40048. #ifdef SQLITE_WIN32_HAS_ANSI
  40049. else{
  40050. char *zTemp;
  40051. nByte = osGetFullPathNameA((char*)zConverted, 0, 0, 0);
  40052. if( nByte==0 ){
  40053. sqlite3_free(zConverted);
  40054. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  40055. "winFullPathname3", zRelative);
  40056. }
  40057. nByte += 3;
  40058. zTemp = sqlite3MallocZero( nByte*sizeof(zTemp[0]) );
  40059. if( zTemp==0 ){
  40060. sqlite3_free(zConverted);
  40061. return SQLITE_IOERR_NOMEM_BKPT;
  40062. }
  40063. nByte = osGetFullPathNameA((char*)zConverted, nByte, zTemp, 0);
  40064. if( nByte==0 ){
  40065. sqlite3_free(zConverted);
  40066. sqlite3_free(zTemp);
  40067. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  40068. "winFullPathname4", zRelative);
  40069. }
  40070. sqlite3_free(zConverted);
  40071. zOut = winMbcsToUtf8(zTemp, osAreFileApisANSI());
  40072. sqlite3_free(zTemp);
  40073. }
  40074. #endif
  40075. if( zOut ){
  40076. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zOut);
  40077. sqlite3_free(zOut);
  40078. return SQLITE_OK;
  40079. }else{
  40080. return SQLITE_IOERR_NOMEM_BKPT;
  40081. }
  40082. #endif
  40083. }
  40084. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  40085. /*
  40086. ** Interfaces for opening a shared library, finding entry points
  40087. ** within the shared library, and closing the shared library.
  40088. */
  40089. static void *winDlOpen(sqlite3_vfs *pVfs, const char *zFilename){
  40090. HANDLE h;
  40091. #if defined(__CYGWIN__)
  40092. int nFull = pVfs->mxPathname+1;
  40093. char *zFull = sqlite3MallocZero( nFull );
  40094. void *zConverted = 0;
  40095. if( zFull==0 ){
  40096. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  40097. return 0;
  40098. }
  40099. if( winFullPathname(pVfs, zFilename, nFull, zFull)!=SQLITE_OK ){
  40100. sqlite3_free(zFull);
  40101. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  40102. return 0;
  40103. }
  40104. zConverted = winConvertFromUtf8Filename(zFull);
  40105. sqlite3_free(zFull);
  40106. #else
  40107. void *zConverted = winConvertFromUtf8Filename(zFilename);
  40108. UNUSED_PARAMETER(pVfs);
  40109. #endif
  40110. if( zConverted==0 ){
  40111. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  40112. return 0;
  40113. }
  40114. if( osIsNT() ){
  40115. #if SQLITE_OS_WINRT
  40116. h = osLoadPackagedLibrary((LPCWSTR)zConverted, 0);
  40117. #else
  40118. h = osLoadLibraryW((LPCWSTR)zConverted);
  40119. #endif
  40120. }
  40121. #ifdef SQLITE_WIN32_HAS_ANSI
  40122. else{
  40123. h = osLoadLibraryA((char*)zConverted);
  40124. }
  40125. #endif
  40126. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)h));
  40127. sqlite3_free(zConverted);
  40128. return (void*)h;
  40129. }
  40130. static void winDlError(sqlite3_vfs *pVfs, int nBuf, char *zBufOut){
  40131. UNUSED_PARAMETER(pVfs);
  40132. winGetLastErrorMsg(osGetLastError(), nBuf, zBufOut);
  40133. }
  40134. static void (*winDlSym(sqlite3_vfs *pVfs,void *pH,const char *zSym))(void){
  40135. FARPROC proc;
  40136. UNUSED_PARAMETER(pVfs);
  40137. proc = osGetProcAddressA((HANDLE)pH, zSym);
  40138. OSTRACE(("DLSYM handle=%p, symbol=%s, address=%p\n",
  40139. (void*)pH, zSym, (void*)proc));
  40140. return (void(*)(void))proc;
  40141. }
  40142. static void winDlClose(sqlite3_vfs *pVfs, void *pHandle){
  40143. UNUSED_PARAMETER(pVfs);
  40144. osFreeLibrary((HANDLE)pHandle);
  40145. OSTRACE(("DLCLOSE handle=%p\n", (void*)pHandle));
  40146. }
  40147. #else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
  40148. #define winDlOpen 0
  40149. #define winDlError 0
  40150. #define winDlSym 0
  40151. #define winDlClose 0
  40152. #endif
  40153. /* State information for the randomness gatherer. */
  40154. typedef struct EntropyGatherer EntropyGatherer;
  40155. struct EntropyGatherer {
  40156. unsigned char *a; /* Gather entropy into this buffer */
  40157. int na; /* Size of a[] in bytes */
  40158. int i; /* XOR next input into a[i] */
  40159. int nXor; /* Number of XOR operations done */
  40160. };
  40161. #if !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS)
  40162. /* Mix sz bytes of entropy into p. */
  40163. static void xorMemory(EntropyGatherer *p, unsigned char *x, int sz){
  40164. int j, k;
  40165. for(j=0, k=p->i; j<sz; j++){
  40166. p->a[k++] ^= x[j];
  40167. if( k>=p->na ) k = 0;
  40168. }
  40169. p->i = k;
  40170. p->nXor += sz;
  40171. }
  40172. #endif /* !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS) */
  40173. /*
  40174. ** Write up to nBuf bytes of randomness into zBuf.
  40175. */
  40176. static int winRandomness(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  40177. #if defined(SQLITE_TEST) || defined(SQLITE_OMIT_RANDOMNESS)
  40178. UNUSED_PARAMETER(pVfs);
  40179. memset(zBuf, 0, nBuf);
  40180. return nBuf;
  40181. #else
  40182. EntropyGatherer e;
  40183. UNUSED_PARAMETER(pVfs);
  40184. memset(zBuf, 0, nBuf);
  40185. #if defined(_MSC_VER) && _MSC_VER>=1400 && !SQLITE_OS_WINCE
  40186. rand_s((unsigned int*)zBuf); /* rand_s() is not available with MinGW */
  40187. #endif /* defined(_MSC_VER) && _MSC_VER>=1400 */
  40188. e.a = (unsigned char*)zBuf;
  40189. e.na = nBuf;
  40190. e.nXor = 0;
  40191. e.i = 0;
  40192. {
  40193. SYSTEMTIME x;
  40194. osGetSystemTime(&x);
  40195. xorMemory(&e, (unsigned char*)&x, sizeof(SYSTEMTIME));
  40196. }
  40197. {
  40198. DWORD pid = osGetCurrentProcessId();
  40199. xorMemory(&e, (unsigned char*)&pid, sizeof(DWORD));
  40200. }
  40201. #if SQLITE_OS_WINRT
  40202. {
  40203. ULONGLONG cnt = osGetTickCount64();
  40204. xorMemory(&e, (unsigned char*)&cnt, sizeof(ULONGLONG));
  40205. }
  40206. #else
  40207. {
  40208. DWORD cnt = osGetTickCount();
  40209. xorMemory(&e, (unsigned char*)&cnt, sizeof(DWORD));
  40210. }
  40211. #endif /* SQLITE_OS_WINRT */
  40212. {
  40213. LARGE_INTEGER i;
  40214. osQueryPerformanceCounter(&i);
  40215. xorMemory(&e, (unsigned char*)&i, sizeof(LARGE_INTEGER));
  40216. }
  40217. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  40218. {
  40219. UUID id;
  40220. memset(&id, 0, sizeof(UUID));
  40221. osUuidCreate(&id);
  40222. xorMemory(&e, (unsigned char*)&id, sizeof(UUID));
  40223. memset(&id, 0, sizeof(UUID));
  40224. osUuidCreateSequential(&id);
  40225. xorMemory(&e, (unsigned char*)&id, sizeof(UUID));
  40226. }
  40227. #endif /* !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID */
  40228. return e.nXor>nBuf ? nBuf : e.nXor;
  40229. #endif /* defined(SQLITE_TEST) || defined(SQLITE_OMIT_RANDOMNESS) */
  40230. }
  40231. /*
  40232. ** Sleep for a little while. Return the amount of time slept.
  40233. */
  40234. static int winSleep(sqlite3_vfs *pVfs, int microsec){
  40235. sqlite3_win32_sleep((microsec+999)/1000);
  40236. UNUSED_PARAMETER(pVfs);
  40237. return ((microsec+999)/1000)*1000;
  40238. }
  40239. /*
  40240. ** The following variable, if set to a non-zero value, is interpreted as
  40241. ** the number of seconds since 1970 and is used to set the result of
  40242. ** sqlite3OsCurrentTime() during testing.
  40243. */
  40244. #ifdef SQLITE_TEST
  40245. SQLITE_API int sqlite3_current_time = 0; /* Fake system time in seconds since 1970. */
  40246. #endif
  40247. /*
  40248. ** Find the current time (in Universal Coordinated Time). Write into *piNow
  40249. ** the current time and date as a Julian Day number times 86_400_000. In
  40250. ** other words, write into *piNow the number of milliseconds since the Julian
  40251. ** epoch of noon in Greenwich on November 24, 4714 B.C according to the
  40252. ** proleptic Gregorian calendar.
  40253. **
  40254. ** On success, return SQLITE_OK. Return SQLITE_ERROR if the time and date
  40255. ** cannot be found.
  40256. */
  40257. static int winCurrentTimeInt64(sqlite3_vfs *pVfs, sqlite3_int64 *piNow){
  40258. /* FILETIME structure is a 64-bit value representing the number of
  40259. 100-nanosecond intervals since January 1, 1601 (= JD 2305813.5).
  40260. */
  40261. FILETIME ft;
  40262. static const sqlite3_int64 winFiletimeEpoch = 23058135*(sqlite3_int64)8640000;
  40263. #ifdef SQLITE_TEST
  40264. static const sqlite3_int64 unixEpoch = 24405875*(sqlite3_int64)8640000;
  40265. #endif
  40266. /* 2^32 - to avoid use of LL and warnings in gcc */
  40267. static const sqlite3_int64 max32BitValue =
  40268. (sqlite3_int64)2000000000 + (sqlite3_int64)2000000000 +
  40269. (sqlite3_int64)294967296;
  40270. #if SQLITE_OS_WINCE
  40271. SYSTEMTIME time;
  40272. osGetSystemTime(&time);
  40273. /* if SystemTimeToFileTime() fails, it returns zero. */
  40274. if (!osSystemTimeToFileTime(&time,&ft)){
  40275. return SQLITE_ERROR;
  40276. }
  40277. #else
  40278. osGetSystemTimeAsFileTime( &ft );
  40279. #endif
  40280. *piNow = winFiletimeEpoch +
  40281. ((((sqlite3_int64)ft.dwHighDateTime)*max32BitValue) +
  40282. (sqlite3_int64)ft.dwLowDateTime)/(sqlite3_int64)10000;
  40283. #ifdef SQLITE_TEST
  40284. if( sqlite3_current_time ){
  40285. *piNow = 1000*(sqlite3_int64)sqlite3_current_time + unixEpoch;
  40286. }
  40287. #endif
  40288. UNUSED_PARAMETER(pVfs);
  40289. return SQLITE_OK;
  40290. }
  40291. /*
  40292. ** Find the current time (in Universal Coordinated Time). Write the
  40293. ** current time and date as a Julian Day number into *prNow and
  40294. ** return 0. Return 1 if the time and date cannot be found.
  40295. */
  40296. static int winCurrentTime(sqlite3_vfs *pVfs, double *prNow){
  40297. int rc;
  40298. sqlite3_int64 i;
  40299. rc = winCurrentTimeInt64(pVfs, &i);
  40300. if( !rc ){
  40301. *prNow = i/86400000.0;
  40302. }
  40303. return rc;
  40304. }
  40305. /*
  40306. ** The idea is that this function works like a combination of
  40307. ** GetLastError() and FormatMessage() on Windows (or errno and
  40308. ** strerror_r() on Unix). After an error is returned by an OS
  40309. ** function, SQLite calls this function with zBuf pointing to
  40310. ** a buffer of nBuf bytes. The OS layer should populate the
  40311. ** buffer with a nul-terminated UTF-8 encoded error message
  40312. ** describing the last IO error to have occurred within the calling
  40313. ** thread.
  40314. **
  40315. ** If the error message is too large for the supplied buffer,
  40316. ** it should be truncated. The return value of xGetLastError
  40317. ** is zero if the error message fits in the buffer, or non-zero
  40318. ** otherwise (if the message was truncated). If non-zero is returned,
  40319. ** then it is not necessary to include the nul-terminator character
  40320. ** in the output buffer.
  40321. **
  40322. ** Not supplying an error message will have no adverse effect
  40323. ** on SQLite. It is fine to have an implementation that never
  40324. ** returns an error message:
  40325. **
  40326. ** int xGetLastError(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  40327. ** assert(zBuf[0]=='\0');
  40328. ** return 0;
  40329. ** }
  40330. **
  40331. ** However if an error message is supplied, it will be incorporated
  40332. ** by sqlite into the error message available to the user using
  40333. ** sqlite3_errmsg(), possibly making IO errors easier to debug.
  40334. */
  40335. static int winGetLastError(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  40336. DWORD e = osGetLastError();
  40337. UNUSED_PARAMETER(pVfs);
  40338. if( nBuf>0 ) winGetLastErrorMsg(e, nBuf, zBuf);
  40339. return e;
  40340. }
  40341. /*
  40342. ** Initialize and deinitialize the operating system interface.
  40343. */
  40344. SQLITE_API int sqlite3_os_init(void){
  40345. static sqlite3_vfs winVfs = {
  40346. 3, /* iVersion */
  40347. sizeof(winFile), /* szOsFile */
  40348. SQLITE_WIN32_MAX_PATH_BYTES, /* mxPathname */
  40349. 0, /* pNext */
  40350. "win32", /* zName */
  40351. &winAppData, /* pAppData */
  40352. winOpen, /* xOpen */
  40353. winDelete, /* xDelete */
  40354. winAccess, /* xAccess */
  40355. winFullPathname, /* xFullPathname */
  40356. winDlOpen, /* xDlOpen */
  40357. winDlError, /* xDlError */
  40358. winDlSym, /* xDlSym */
  40359. winDlClose, /* xDlClose */
  40360. winRandomness, /* xRandomness */
  40361. winSleep, /* xSleep */
  40362. winCurrentTime, /* xCurrentTime */
  40363. winGetLastError, /* xGetLastError */
  40364. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  40365. winSetSystemCall, /* xSetSystemCall */
  40366. winGetSystemCall, /* xGetSystemCall */
  40367. winNextSystemCall, /* xNextSystemCall */
  40368. };
  40369. #if defined(SQLITE_WIN32_HAS_WIDE)
  40370. static sqlite3_vfs winLongPathVfs = {
  40371. 3, /* iVersion */
  40372. sizeof(winFile), /* szOsFile */
  40373. SQLITE_WINNT_MAX_PATH_BYTES, /* mxPathname */
  40374. 0, /* pNext */
  40375. "win32-longpath", /* zName */
  40376. &winAppData, /* pAppData */
  40377. winOpen, /* xOpen */
  40378. winDelete, /* xDelete */
  40379. winAccess, /* xAccess */
  40380. winFullPathname, /* xFullPathname */
  40381. winDlOpen, /* xDlOpen */
  40382. winDlError, /* xDlError */
  40383. winDlSym, /* xDlSym */
  40384. winDlClose, /* xDlClose */
  40385. winRandomness, /* xRandomness */
  40386. winSleep, /* xSleep */
  40387. winCurrentTime, /* xCurrentTime */
  40388. winGetLastError, /* xGetLastError */
  40389. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  40390. winSetSystemCall, /* xSetSystemCall */
  40391. winGetSystemCall, /* xGetSystemCall */
  40392. winNextSystemCall, /* xNextSystemCall */
  40393. };
  40394. #endif
  40395. static sqlite3_vfs winNolockVfs = {
  40396. 3, /* iVersion */
  40397. sizeof(winFile), /* szOsFile */
  40398. SQLITE_WIN32_MAX_PATH_BYTES, /* mxPathname */
  40399. 0, /* pNext */
  40400. "win32-none", /* zName */
  40401. &winNolockAppData, /* pAppData */
  40402. winOpen, /* xOpen */
  40403. winDelete, /* xDelete */
  40404. winAccess, /* xAccess */
  40405. winFullPathname, /* xFullPathname */
  40406. winDlOpen, /* xDlOpen */
  40407. winDlError, /* xDlError */
  40408. winDlSym, /* xDlSym */
  40409. winDlClose, /* xDlClose */
  40410. winRandomness, /* xRandomness */
  40411. winSleep, /* xSleep */
  40412. winCurrentTime, /* xCurrentTime */
  40413. winGetLastError, /* xGetLastError */
  40414. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  40415. winSetSystemCall, /* xSetSystemCall */
  40416. winGetSystemCall, /* xGetSystemCall */
  40417. winNextSystemCall, /* xNextSystemCall */
  40418. };
  40419. #if defined(SQLITE_WIN32_HAS_WIDE)
  40420. static sqlite3_vfs winLongPathNolockVfs = {
  40421. 3, /* iVersion */
  40422. sizeof(winFile), /* szOsFile */
  40423. SQLITE_WINNT_MAX_PATH_BYTES, /* mxPathname */
  40424. 0, /* pNext */
  40425. "win32-longpath-none", /* zName */
  40426. &winNolockAppData, /* pAppData */
  40427. winOpen, /* xOpen */
  40428. winDelete, /* xDelete */
  40429. winAccess, /* xAccess */
  40430. winFullPathname, /* xFullPathname */
  40431. winDlOpen, /* xDlOpen */
  40432. winDlError, /* xDlError */
  40433. winDlSym, /* xDlSym */
  40434. winDlClose, /* xDlClose */
  40435. winRandomness, /* xRandomness */
  40436. winSleep, /* xSleep */
  40437. winCurrentTime, /* xCurrentTime */
  40438. winGetLastError, /* xGetLastError */
  40439. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  40440. winSetSystemCall, /* xSetSystemCall */
  40441. winGetSystemCall, /* xGetSystemCall */
  40442. winNextSystemCall, /* xNextSystemCall */
  40443. };
  40444. #endif
  40445. /* Double-check that the aSyscall[] array has been constructed
  40446. ** correctly. See ticket [bb3a86e890c8e96ab] */
  40447. assert( ArraySize(aSyscall)==80 );
  40448. /* get memory map allocation granularity */
  40449. memset(&winSysInfo, 0, sizeof(SYSTEM_INFO));
  40450. #if SQLITE_OS_WINRT
  40451. osGetNativeSystemInfo(&winSysInfo);
  40452. #else
  40453. osGetSystemInfo(&winSysInfo);
  40454. #endif
  40455. assert( winSysInfo.dwAllocationGranularity>0 );
  40456. assert( winSysInfo.dwPageSize>0 );
  40457. sqlite3_vfs_register(&winVfs, 1);
  40458. #if defined(SQLITE_WIN32_HAS_WIDE)
  40459. sqlite3_vfs_register(&winLongPathVfs, 0);
  40460. #endif
  40461. sqlite3_vfs_register(&winNolockVfs, 0);
  40462. #if defined(SQLITE_WIN32_HAS_WIDE)
  40463. sqlite3_vfs_register(&winLongPathNolockVfs, 0);
  40464. #endif
  40465. return SQLITE_OK;
  40466. }
  40467. SQLITE_API int sqlite3_os_end(void){
  40468. #if SQLITE_OS_WINRT
  40469. if( sleepObj!=NULL ){
  40470. osCloseHandle(sleepObj);
  40471. sleepObj = NULL;
  40472. }
  40473. #endif
  40474. return SQLITE_OK;
  40475. }
  40476. #endif /* SQLITE_OS_WIN */
  40477. /************** End of os_win.c **********************************************/
  40478. /************** Begin file bitvec.c ******************************************/
  40479. /*
  40480. ** 2008 February 16
  40481. **
  40482. ** The author disclaims copyright to this source code. In place of
  40483. ** a legal notice, here is a blessing:
  40484. **
  40485. ** May you do good and not evil.
  40486. ** May you find forgiveness for yourself and forgive others.
  40487. ** May you share freely, never taking more than you give.
  40488. **
  40489. *************************************************************************
  40490. ** This file implements an object that represents a fixed-length
  40491. ** bitmap. Bits are numbered starting with 1.
  40492. **
  40493. ** A bitmap is used to record which pages of a database file have been
  40494. ** journalled during a transaction, or which pages have the "dont-write"
  40495. ** property. Usually only a few pages are meet either condition.
  40496. ** So the bitmap is usually sparse and has low cardinality.
  40497. ** But sometimes (for example when during a DROP of a large table) most
  40498. ** or all of the pages in a database can get journalled. In those cases,
  40499. ** the bitmap becomes dense with high cardinality. The algorithm needs
  40500. ** to handle both cases well.
  40501. **
  40502. ** The size of the bitmap is fixed when the object is created.
  40503. **
  40504. ** All bits are clear when the bitmap is created. Individual bits
  40505. ** may be set or cleared one at a time.
  40506. **
  40507. ** Test operations are about 100 times more common that set operations.
  40508. ** Clear operations are exceedingly rare. There are usually between
  40509. ** 5 and 500 set operations per Bitvec object, though the number of sets can
  40510. ** sometimes grow into tens of thousands or larger. The size of the
  40511. ** Bitvec object is the number of pages in the database file at the
  40512. ** start of a transaction, and is thus usually less than a few thousand,
  40513. ** but can be as large as 2 billion for a really big database.
  40514. */
  40515. /* #include "sqliteInt.h" */
  40516. /* Size of the Bitvec structure in bytes. */
  40517. #define BITVEC_SZ 512
  40518. /* Round the union size down to the nearest pointer boundary, since that's how
  40519. ** it will be aligned within the Bitvec struct. */
  40520. #define BITVEC_USIZE \
  40521. (((BITVEC_SZ-(3*sizeof(u32)))/sizeof(Bitvec*))*sizeof(Bitvec*))
  40522. /* Type of the array "element" for the bitmap representation.
  40523. ** Should be a power of 2, and ideally, evenly divide into BITVEC_USIZE.
  40524. ** Setting this to the "natural word" size of your CPU may improve
  40525. ** performance. */
  40526. #define BITVEC_TELEM u8
  40527. /* Size, in bits, of the bitmap element. */
  40528. #define BITVEC_SZELEM 8
  40529. /* Number of elements in a bitmap array. */
  40530. #define BITVEC_NELEM (BITVEC_USIZE/sizeof(BITVEC_TELEM))
  40531. /* Number of bits in the bitmap array. */
  40532. #define BITVEC_NBIT (BITVEC_NELEM*BITVEC_SZELEM)
  40533. /* Number of u32 values in hash table. */
  40534. #define BITVEC_NINT (BITVEC_USIZE/sizeof(u32))
  40535. /* Maximum number of entries in hash table before
  40536. ** sub-dividing and re-hashing. */
  40537. #define BITVEC_MXHASH (BITVEC_NINT/2)
  40538. /* Hashing function for the aHash representation.
  40539. ** Empirical testing showed that the *37 multiplier
  40540. ** (an arbitrary prime)in the hash function provided
  40541. ** no fewer collisions than the no-op *1. */
  40542. #define BITVEC_HASH(X) (((X)*1)%BITVEC_NINT)
  40543. #define BITVEC_NPTR (BITVEC_USIZE/sizeof(Bitvec *))
  40544. /*
  40545. ** A bitmap is an instance of the following structure.
  40546. **
  40547. ** This bitmap records the existence of zero or more bits
  40548. ** with values between 1 and iSize, inclusive.
  40549. **
  40550. ** There are three possible representations of the bitmap.
  40551. ** If iSize<=BITVEC_NBIT, then Bitvec.u.aBitmap[] is a straight
  40552. ** bitmap. The least significant bit is bit 1.
  40553. **
  40554. ** If iSize>BITVEC_NBIT and iDivisor==0 then Bitvec.u.aHash[] is
  40555. ** a hash table that will hold up to BITVEC_MXHASH distinct values.
  40556. **
  40557. ** Otherwise, the value i is redirected into one of BITVEC_NPTR
  40558. ** sub-bitmaps pointed to by Bitvec.u.apSub[]. Each subbitmap
  40559. ** handles up to iDivisor separate values of i. apSub[0] holds
  40560. ** values between 1 and iDivisor. apSub[1] holds values between
  40561. ** iDivisor+1 and 2*iDivisor. apSub[N] holds values between
  40562. ** N*iDivisor+1 and (N+1)*iDivisor. Each subbitmap is normalized
  40563. ** to hold deal with values between 1 and iDivisor.
  40564. */
  40565. struct Bitvec {
  40566. u32 iSize; /* Maximum bit index. Max iSize is 4,294,967,296. */
  40567. u32 nSet; /* Number of bits that are set - only valid for aHash
  40568. ** element. Max is BITVEC_NINT. For BITVEC_SZ of 512,
  40569. ** this would be 125. */
  40570. u32 iDivisor; /* Number of bits handled by each apSub[] entry. */
  40571. /* Should >=0 for apSub element. */
  40572. /* Max iDivisor is max(u32) / BITVEC_NPTR + 1. */
  40573. /* For a BITVEC_SZ of 512, this would be 34,359,739. */
  40574. union {
  40575. BITVEC_TELEM aBitmap[BITVEC_NELEM]; /* Bitmap representation */
  40576. u32 aHash[BITVEC_NINT]; /* Hash table representation */
  40577. Bitvec *apSub[BITVEC_NPTR]; /* Recursive representation */
  40578. } u;
  40579. };
  40580. /*
  40581. ** Create a new bitmap object able to handle bits between 0 and iSize,
  40582. ** inclusive. Return a pointer to the new object. Return NULL if
  40583. ** malloc fails.
  40584. */
  40585. SQLITE_PRIVATE Bitvec *sqlite3BitvecCreate(u32 iSize){
  40586. Bitvec *p;
  40587. assert( sizeof(*p)==BITVEC_SZ );
  40588. p = sqlite3MallocZero( sizeof(*p) );
  40589. if( p ){
  40590. p->iSize = iSize;
  40591. }
  40592. return p;
  40593. }
  40594. /*
  40595. ** Check to see if the i-th bit is set. Return true or false.
  40596. ** If p is NULL (if the bitmap has not been created) or if
  40597. ** i is out of range, then return false.
  40598. */
  40599. SQLITE_PRIVATE int sqlite3BitvecTestNotNull(Bitvec *p, u32 i){
  40600. assert( p!=0 );
  40601. i--;
  40602. if( i>=p->iSize ) return 0;
  40603. while( p->iDivisor ){
  40604. u32 bin = i/p->iDivisor;
  40605. i = i%p->iDivisor;
  40606. p = p->u.apSub[bin];
  40607. if (!p) {
  40608. return 0;
  40609. }
  40610. }
  40611. if( p->iSize<=BITVEC_NBIT ){
  40612. return (p->u.aBitmap[i/BITVEC_SZELEM] & (1<<(i&(BITVEC_SZELEM-1))))!=0;
  40613. } else{
  40614. u32 h = BITVEC_HASH(i++);
  40615. while( p->u.aHash[h] ){
  40616. if( p->u.aHash[h]==i ) return 1;
  40617. h = (h+1) % BITVEC_NINT;
  40618. }
  40619. return 0;
  40620. }
  40621. }
  40622. SQLITE_PRIVATE int sqlite3BitvecTest(Bitvec *p, u32 i){
  40623. return p!=0 && sqlite3BitvecTestNotNull(p,i);
  40624. }
  40625. /*
  40626. ** Set the i-th bit. Return 0 on success and an error code if
  40627. ** anything goes wrong.
  40628. **
  40629. ** This routine might cause sub-bitmaps to be allocated. Failing
  40630. ** to get the memory needed to hold the sub-bitmap is the only
  40631. ** that can go wrong with an insert, assuming p and i are valid.
  40632. **
  40633. ** The calling function must ensure that p is a valid Bitvec object
  40634. ** and that the value for "i" is within range of the Bitvec object.
  40635. ** Otherwise the behavior is undefined.
  40636. */
  40637. SQLITE_PRIVATE int sqlite3BitvecSet(Bitvec *p, u32 i){
  40638. u32 h;
  40639. if( p==0 ) return SQLITE_OK;
  40640. assert( i>0 );
  40641. assert( i<=p->iSize );
  40642. i--;
  40643. while((p->iSize > BITVEC_NBIT) && p->iDivisor) {
  40644. u32 bin = i/p->iDivisor;
  40645. i = i%p->iDivisor;
  40646. if( p->u.apSub[bin]==0 ){
  40647. p->u.apSub[bin] = sqlite3BitvecCreate( p->iDivisor );
  40648. if( p->u.apSub[bin]==0 ) return SQLITE_NOMEM_BKPT;
  40649. }
  40650. p = p->u.apSub[bin];
  40651. }
  40652. if( p->iSize<=BITVEC_NBIT ){
  40653. p->u.aBitmap[i/BITVEC_SZELEM] |= 1 << (i&(BITVEC_SZELEM-1));
  40654. return SQLITE_OK;
  40655. }
  40656. h = BITVEC_HASH(i++);
  40657. /* if there wasn't a hash collision, and this doesn't */
  40658. /* completely fill the hash, then just add it without */
  40659. /* worring about sub-dividing and re-hashing. */
  40660. if( !p->u.aHash[h] ){
  40661. if (p->nSet<(BITVEC_NINT-1)) {
  40662. goto bitvec_set_end;
  40663. } else {
  40664. goto bitvec_set_rehash;
  40665. }
  40666. }
  40667. /* there was a collision, check to see if it's already */
  40668. /* in hash, if not, try to find a spot for it */
  40669. do {
  40670. if( p->u.aHash[h]==i ) return SQLITE_OK;
  40671. h++;
  40672. if( h>=BITVEC_NINT ) h = 0;
  40673. } while( p->u.aHash[h] );
  40674. /* we didn't find it in the hash. h points to the first */
  40675. /* available free spot. check to see if this is going to */
  40676. /* make our hash too "full". */
  40677. bitvec_set_rehash:
  40678. if( p->nSet>=BITVEC_MXHASH ){
  40679. unsigned int j;
  40680. int rc;
  40681. u32 *aiValues = sqlite3StackAllocRaw(0, sizeof(p->u.aHash));
  40682. if( aiValues==0 ){
  40683. return SQLITE_NOMEM_BKPT;
  40684. }else{
  40685. memcpy(aiValues, p->u.aHash, sizeof(p->u.aHash));
  40686. memset(p->u.apSub, 0, sizeof(p->u.apSub));
  40687. p->iDivisor = (p->iSize + BITVEC_NPTR - 1)/BITVEC_NPTR;
  40688. rc = sqlite3BitvecSet(p, i);
  40689. for(j=0; j<BITVEC_NINT; j++){
  40690. if( aiValues[j] ) rc |= sqlite3BitvecSet(p, aiValues[j]);
  40691. }
  40692. sqlite3StackFree(0, aiValues);
  40693. return rc;
  40694. }
  40695. }
  40696. bitvec_set_end:
  40697. p->nSet++;
  40698. p->u.aHash[h] = i;
  40699. return SQLITE_OK;
  40700. }
  40701. /*
  40702. ** Clear the i-th bit.
  40703. **
  40704. ** pBuf must be a pointer to at least BITVEC_SZ bytes of temporary storage
  40705. ** that BitvecClear can use to rebuilt its hash table.
  40706. */
  40707. SQLITE_PRIVATE void sqlite3BitvecClear(Bitvec *p, u32 i, void *pBuf){
  40708. if( p==0 ) return;
  40709. assert( i>0 );
  40710. i--;
  40711. while( p->iDivisor ){
  40712. u32 bin = i/p->iDivisor;
  40713. i = i%p->iDivisor;
  40714. p = p->u.apSub[bin];
  40715. if (!p) {
  40716. return;
  40717. }
  40718. }
  40719. if( p->iSize<=BITVEC_NBIT ){
  40720. p->u.aBitmap[i/BITVEC_SZELEM] &= ~(1 << (i&(BITVEC_SZELEM-1)));
  40721. }else{
  40722. unsigned int j;
  40723. u32 *aiValues = pBuf;
  40724. memcpy(aiValues, p->u.aHash, sizeof(p->u.aHash));
  40725. memset(p->u.aHash, 0, sizeof(p->u.aHash));
  40726. p->nSet = 0;
  40727. for(j=0; j<BITVEC_NINT; j++){
  40728. if( aiValues[j] && aiValues[j]!=(i+1) ){
  40729. u32 h = BITVEC_HASH(aiValues[j]-1);
  40730. p->nSet++;
  40731. while( p->u.aHash[h] ){
  40732. h++;
  40733. if( h>=BITVEC_NINT ) h = 0;
  40734. }
  40735. p->u.aHash[h] = aiValues[j];
  40736. }
  40737. }
  40738. }
  40739. }
  40740. /*
  40741. ** Destroy a bitmap object. Reclaim all memory used.
  40742. */
  40743. SQLITE_PRIVATE void sqlite3BitvecDestroy(Bitvec *p){
  40744. if( p==0 ) return;
  40745. if( p->iDivisor ){
  40746. unsigned int i;
  40747. for(i=0; i<BITVEC_NPTR; i++){
  40748. sqlite3BitvecDestroy(p->u.apSub[i]);
  40749. }
  40750. }
  40751. sqlite3_free(p);
  40752. }
  40753. /*
  40754. ** Return the value of the iSize parameter specified when Bitvec *p
  40755. ** was created.
  40756. */
  40757. SQLITE_PRIVATE u32 sqlite3BitvecSize(Bitvec *p){
  40758. return p->iSize;
  40759. }
  40760. #ifndef SQLITE_OMIT_BUILTIN_TEST
  40761. /*
  40762. ** Let V[] be an array of unsigned characters sufficient to hold
  40763. ** up to N bits. Let I be an integer between 0 and N. 0<=I<N.
  40764. ** Then the following macros can be used to set, clear, or test
  40765. ** individual bits within V.
  40766. */
  40767. #define SETBIT(V,I) V[I>>3] |= (1<<(I&7))
  40768. #define CLEARBIT(V,I) V[I>>3] &= ~(1<<(I&7))
  40769. #define TESTBIT(V,I) (V[I>>3]&(1<<(I&7)))!=0
  40770. /*
  40771. ** This routine runs an extensive test of the Bitvec code.
  40772. **
  40773. ** The input is an array of integers that acts as a program
  40774. ** to test the Bitvec. The integers are opcodes followed
  40775. ** by 0, 1, or 3 operands, depending on the opcode. Another
  40776. ** opcode follows immediately after the last operand.
  40777. **
  40778. ** There are 6 opcodes numbered from 0 through 5. 0 is the
  40779. ** "halt" opcode and causes the test to end.
  40780. **
  40781. ** 0 Halt and return the number of errors
  40782. ** 1 N S X Set N bits beginning with S and incrementing by X
  40783. ** 2 N S X Clear N bits beginning with S and incrementing by X
  40784. ** 3 N Set N randomly chosen bits
  40785. ** 4 N Clear N randomly chosen bits
  40786. ** 5 N S X Set N bits from S increment X in array only, not in bitvec
  40787. **
  40788. ** The opcodes 1 through 4 perform set and clear operations are performed
  40789. ** on both a Bitvec object and on a linear array of bits obtained from malloc.
  40790. ** Opcode 5 works on the linear array only, not on the Bitvec.
  40791. ** Opcode 5 is used to deliberately induce a fault in order to
  40792. ** confirm that error detection works.
  40793. **
  40794. ** At the conclusion of the test the linear array is compared
  40795. ** against the Bitvec object. If there are any differences,
  40796. ** an error is returned. If they are the same, zero is returned.
  40797. **
  40798. ** If a memory allocation error occurs, return -1.
  40799. */
  40800. SQLITE_PRIVATE int sqlite3BitvecBuiltinTest(int sz, int *aOp){
  40801. Bitvec *pBitvec = 0;
  40802. unsigned char *pV = 0;
  40803. int rc = -1;
  40804. int i, nx, pc, op;
  40805. void *pTmpSpace;
  40806. /* Allocate the Bitvec to be tested and a linear array of
  40807. ** bits to act as the reference */
  40808. pBitvec = sqlite3BitvecCreate( sz );
  40809. pV = sqlite3MallocZero( (sz+7)/8 + 1 );
  40810. pTmpSpace = sqlite3_malloc64(BITVEC_SZ);
  40811. if( pBitvec==0 || pV==0 || pTmpSpace==0 ) goto bitvec_end;
  40812. /* NULL pBitvec tests */
  40813. sqlite3BitvecSet(0, 1);
  40814. sqlite3BitvecClear(0, 1, pTmpSpace);
  40815. /* Run the program */
  40816. pc = 0;
  40817. while( (op = aOp[pc])!=0 ){
  40818. switch( op ){
  40819. case 1:
  40820. case 2:
  40821. case 5: {
  40822. nx = 4;
  40823. i = aOp[pc+2] - 1;
  40824. aOp[pc+2] += aOp[pc+3];
  40825. break;
  40826. }
  40827. case 3:
  40828. case 4:
  40829. default: {
  40830. nx = 2;
  40831. sqlite3_randomness(sizeof(i), &i);
  40832. break;
  40833. }
  40834. }
  40835. if( (--aOp[pc+1]) > 0 ) nx = 0;
  40836. pc += nx;
  40837. i = (i & 0x7fffffff)%sz;
  40838. if( (op & 1)!=0 ){
  40839. SETBIT(pV, (i+1));
  40840. if( op!=5 ){
  40841. if( sqlite3BitvecSet(pBitvec, i+1) ) goto bitvec_end;
  40842. }
  40843. }else{
  40844. CLEARBIT(pV, (i+1));
  40845. sqlite3BitvecClear(pBitvec, i+1, pTmpSpace);
  40846. }
  40847. }
  40848. /* Test to make sure the linear array exactly matches the
  40849. ** Bitvec object. Start with the assumption that they do
  40850. ** match (rc==0). Change rc to non-zero if a discrepancy
  40851. ** is found.
  40852. */
  40853. rc = sqlite3BitvecTest(0,0) + sqlite3BitvecTest(pBitvec, sz+1)
  40854. + sqlite3BitvecTest(pBitvec, 0)
  40855. + (sqlite3BitvecSize(pBitvec) - sz);
  40856. for(i=1; i<=sz; i++){
  40857. if( (TESTBIT(pV,i))!=sqlite3BitvecTest(pBitvec,i) ){
  40858. rc = i;
  40859. break;
  40860. }
  40861. }
  40862. /* Free allocated structure */
  40863. bitvec_end:
  40864. sqlite3_free(pTmpSpace);
  40865. sqlite3_free(pV);
  40866. sqlite3BitvecDestroy(pBitvec);
  40867. return rc;
  40868. }
  40869. #endif /* SQLITE_OMIT_BUILTIN_TEST */
  40870. /************** End of bitvec.c **********************************************/
  40871. /************** Begin file pcache.c ******************************************/
  40872. /*
  40873. ** 2008 August 05
  40874. **
  40875. ** The author disclaims copyright to this source code. In place of
  40876. ** a legal notice, here is a blessing:
  40877. **
  40878. ** May you do good and not evil.
  40879. ** May you find forgiveness for yourself and forgive others.
  40880. ** May you share freely, never taking more than you give.
  40881. **
  40882. *************************************************************************
  40883. ** This file implements that page cache.
  40884. */
  40885. /* #include "sqliteInt.h" */
  40886. /*
  40887. ** A complete page cache is an instance of this structure. Every
  40888. ** entry in the cache holds a single page of the database file. The
  40889. ** btree layer only operates on the cached copy of the database pages.
  40890. **
  40891. ** A page cache entry is "clean" if it exactly matches what is currently
  40892. ** on disk. A page is "dirty" if it has been modified and needs to be
  40893. ** persisted to disk.
  40894. **
  40895. ** pDirty, pDirtyTail, pSynced:
  40896. ** All dirty pages are linked into the doubly linked list using
  40897. ** PgHdr.pDirtyNext and pDirtyPrev. The list is maintained in LRU order
  40898. ** such that p was added to the list more recently than p->pDirtyNext.
  40899. ** PCache.pDirty points to the first (newest) element in the list and
  40900. ** pDirtyTail to the last (oldest).
  40901. **
  40902. ** The PCache.pSynced variable is used to optimize searching for a dirty
  40903. ** page to eject from the cache mid-transaction. It is better to eject
  40904. ** a page that does not require a journal sync than one that does.
  40905. ** Therefore, pSynced is maintained to that it *almost* always points
  40906. ** to either the oldest page in the pDirty/pDirtyTail list that has a
  40907. ** clear PGHDR_NEED_SYNC flag or to a page that is older than this one
  40908. ** (so that the right page to eject can be found by following pDirtyPrev
  40909. ** pointers).
  40910. */
  40911. struct PCache {
  40912. PgHdr *pDirty, *pDirtyTail; /* List of dirty pages in LRU order */
  40913. PgHdr *pSynced; /* Last synced page in dirty page list */
  40914. int nRefSum; /* Sum of ref counts over all pages */
  40915. int szCache; /* Configured cache size */
  40916. int szSpill; /* Size before spilling occurs */
  40917. int szPage; /* Size of every page in this cache */
  40918. int szExtra; /* Size of extra space for each page */
  40919. u8 bPurgeable; /* True if pages are on backing store */
  40920. u8 eCreate; /* eCreate value for for xFetch() */
  40921. int (*xStress)(void*,PgHdr*); /* Call to try make a page clean */
  40922. void *pStress; /* Argument to xStress */
  40923. sqlite3_pcache *pCache; /* Pluggable cache module */
  40924. };
  40925. /********************************** Test and Debug Logic **********************/
  40926. /*
  40927. ** Debug tracing macros. Enable by by changing the "0" to "1" and
  40928. ** recompiling.
  40929. **
  40930. ** When sqlite3PcacheTrace is 1, single line trace messages are issued.
  40931. ** When sqlite3PcacheTrace is 2, a dump of the pcache showing all cache entries
  40932. ** is displayed for many operations, resulting in a lot of output.
  40933. */
  40934. #if defined(SQLITE_DEBUG) && 0
  40935. int sqlite3PcacheTrace = 2; /* 0: off 1: simple 2: cache dumps */
  40936. int sqlite3PcacheMxDump = 9999; /* Max cache entries for pcacheDump() */
  40937. # define pcacheTrace(X) if(sqlite3PcacheTrace){sqlite3DebugPrintf X;}
  40938. void pcacheDump(PCache *pCache){
  40939. int N;
  40940. int i, j;
  40941. sqlite3_pcache_page *pLower;
  40942. PgHdr *pPg;
  40943. unsigned char *a;
  40944. if( sqlite3PcacheTrace<2 ) return;
  40945. if( pCache->pCache==0 ) return;
  40946. N = sqlite3PcachePagecount(pCache);
  40947. if( N>sqlite3PcacheMxDump ) N = sqlite3PcacheMxDump;
  40948. for(i=1; i<=N; i++){
  40949. pLower = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, i, 0);
  40950. if( pLower==0 ) continue;
  40951. pPg = (PgHdr*)pLower->pExtra;
  40952. printf("%3d: nRef %2d flgs %02x data ", i, pPg->nRef, pPg->flags);
  40953. a = (unsigned char *)pLower->pBuf;
  40954. for(j=0; j<12; j++) printf("%02x", a[j]);
  40955. printf("\n");
  40956. if( pPg->pPage==0 ){
  40957. sqlite3GlobalConfig.pcache2.xUnpin(pCache->pCache, pLower, 0);
  40958. }
  40959. }
  40960. }
  40961. #else
  40962. # define pcacheTrace(X)
  40963. # define pcacheDump(X)
  40964. #endif
  40965. /*
  40966. ** Check invariants on a PgHdr entry. Return true if everything is OK.
  40967. ** Return false if any invariant is violated.
  40968. **
  40969. ** This routine is for use inside of assert() statements only. For
  40970. ** example:
  40971. **
  40972. ** assert( sqlite3PcachePageSanity(pPg) );
  40973. */
  40974. #if SQLITE_DEBUG
  40975. SQLITE_PRIVATE int sqlite3PcachePageSanity(PgHdr *pPg){
  40976. PCache *pCache;
  40977. assert( pPg!=0 );
  40978. assert( pPg->pgno>0 ); /* Page number is 1 or more */
  40979. pCache = pPg->pCache;
  40980. assert( pCache!=0 ); /* Every page has an associated PCache */
  40981. if( pPg->flags & PGHDR_CLEAN ){
  40982. assert( (pPg->flags & PGHDR_DIRTY)==0 );/* Cannot be both CLEAN and DIRTY */
  40983. assert( pCache->pDirty!=pPg ); /* CLEAN pages not on dirty list */
  40984. assert( pCache->pDirtyTail!=pPg );
  40985. }
  40986. /* WRITEABLE pages must also be DIRTY */
  40987. if( pPg->flags & PGHDR_WRITEABLE ){
  40988. assert( pPg->flags & PGHDR_DIRTY ); /* WRITEABLE implies DIRTY */
  40989. }
  40990. /* NEED_SYNC can be set independently of WRITEABLE. This can happen,
  40991. ** for example, when using the sqlite3PagerDontWrite() optimization:
  40992. ** (1) Page X is journalled, and gets WRITEABLE and NEED_SEEK.
  40993. ** (2) Page X moved to freelist, WRITEABLE is cleared
  40994. ** (3) Page X reused, WRITEABLE is set again
  40995. ** If NEED_SYNC had been cleared in step 2, then it would not be reset
  40996. ** in step 3, and page might be written into the database without first
  40997. ** syncing the rollback journal, which might cause corruption on a power
  40998. ** loss.
  40999. **
  41000. ** Another example is when the database page size is smaller than the
  41001. ** disk sector size. When any page of a sector is journalled, all pages
  41002. ** in that sector are marked NEED_SYNC even if they are still CLEAN, just
  41003. ** in case they are later modified, since all pages in the same sector
  41004. ** must be journalled and synced before any of those pages can be safely
  41005. ** written.
  41006. */
  41007. return 1;
  41008. }
  41009. #endif /* SQLITE_DEBUG */
  41010. /********************************** Linked List Management ********************/
  41011. /* Allowed values for second argument to pcacheManageDirtyList() */
  41012. #define PCACHE_DIRTYLIST_REMOVE 1 /* Remove pPage from dirty list */
  41013. #define PCACHE_DIRTYLIST_ADD 2 /* Add pPage to the dirty list */
  41014. #define PCACHE_DIRTYLIST_FRONT 3 /* Move pPage to the front of the list */
  41015. /*
  41016. ** Manage pPage's participation on the dirty list. Bits of the addRemove
  41017. ** argument determines what operation to do. The 0x01 bit means first
  41018. ** remove pPage from the dirty list. The 0x02 means add pPage back to
  41019. ** the dirty list. Doing both moves pPage to the front of the dirty list.
  41020. */
  41021. static void pcacheManageDirtyList(PgHdr *pPage, u8 addRemove){
  41022. PCache *p = pPage->pCache;
  41023. pcacheTrace(("%p.DIRTYLIST.%s %d\n", p,
  41024. addRemove==1 ? "REMOVE" : addRemove==2 ? "ADD" : "FRONT",
  41025. pPage->pgno));
  41026. if( addRemove & PCACHE_DIRTYLIST_REMOVE ){
  41027. assert( pPage->pDirtyNext || pPage==p->pDirtyTail );
  41028. assert( pPage->pDirtyPrev || pPage==p->pDirty );
  41029. /* Update the PCache1.pSynced variable if necessary. */
  41030. if( p->pSynced==pPage ){
  41031. p->pSynced = pPage->pDirtyPrev;
  41032. }
  41033. if( pPage->pDirtyNext ){
  41034. pPage->pDirtyNext->pDirtyPrev = pPage->pDirtyPrev;
  41035. }else{
  41036. assert( pPage==p->pDirtyTail );
  41037. p->pDirtyTail = pPage->pDirtyPrev;
  41038. }
  41039. if( pPage->pDirtyPrev ){
  41040. pPage->pDirtyPrev->pDirtyNext = pPage->pDirtyNext;
  41041. }else{
  41042. /* If there are now no dirty pages in the cache, set eCreate to 2.
  41043. ** This is an optimization that allows sqlite3PcacheFetch() to skip
  41044. ** searching for a dirty page to eject from the cache when it might
  41045. ** otherwise have to. */
  41046. assert( pPage==p->pDirty );
  41047. p->pDirty = pPage->pDirtyNext;
  41048. assert( p->bPurgeable || p->eCreate==2 );
  41049. if( p->pDirty==0 ){ /*OPTIMIZATION-IF-TRUE*/
  41050. assert( p->bPurgeable==0 || p->eCreate==1 );
  41051. p->eCreate = 2;
  41052. }
  41053. }
  41054. pPage->pDirtyNext = 0;
  41055. pPage->pDirtyPrev = 0;
  41056. }
  41057. if( addRemove & PCACHE_DIRTYLIST_ADD ){
  41058. assert( pPage->pDirtyNext==0 && pPage->pDirtyPrev==0 && p->pDirty!=pPage );
  41059. pPage->pDirtyNext = p->pDirty;
  41060. if( pPage->pDirtyNext ){
  41061. assert( pPage->pDirtyNext->pDirtyPrev==0 );
  41062. pPage->pDirtyNext->pDirtyPrev = pPage;
  41063. }else{
  41064. p->pDirtyTail = pPage;
  41065. if( p->bPurgeable ){
  41066. assert( p->eCreate==2 );
  41067. p->eCreate = 1;
  41068. }
  41069. }
  41070. p->pDirty = pPage;
  41071. /* If pSynced is NULL and this page has a clear NEED_SYNC flag, set
  41072. ** pSynced to point to it. Checking the NEED_SYNC flag is an
  41073. ** optimization, as if pSynced points to a page with the NEED_SYNC
  41074. ** flag set sqlite3PcacheFetchStress() searches through all newer
  41075. ** entries of the dirty-list for a page with NEED_SYNC clear anyway. */
  41076. if( !p->pSynced
  41077. && 0==(pPage->flags&PGHDR_NEED_SYNC) /*OPTIMIZATION-IF-FALSE*/
  41078. ){
  41079. p->pSynced = pPage;
  41080. }
  41081. }
  41082. pcacheDump(p);
  41083. }
  41084. /*
  41085. ** Wrapper around the pluggable caches xUnpin method. If the cache is
  41086. ** being used for an in-memory database, this function is a no-op.
  41087. */
  41088. static void pcacheUnpin(PgHdr *p){
  41089. if( p->pCache->bPurgeable ){
  41090. pcacheTrace(("%p.UNPIN %d\n", p->pCache, p->pgno));
  41091. sqlite3GlobalConfig.pcache2.xUnpin(p->pCache->pCache, p->pPage, 0);
  41092. pcacheDump(p->pCache);
  41093. }
  41094. }
  41095. /*
  41096. ** Compute the number of pages of cache requested. p->szCache is the
  41097. ** cache size requested by the "PRAGMA cache_size" statement.
  41098. */
  41099. static int numberOfCachePages(PCache *p){
  41100. if( p->szCache>=0 ){
  41101. /* IMPLEMENTATION-OF: R-42059-47211 If the argument N is positive then the
  41102. ** suggested cache size is set to N. */
  41103. return p->szCache;
  41104. }else{
  41105. /* IMPLEMENTATION-OF: R-61436-13639 If the argument N is negative, then
  41106. ** the number of cache pages is adjusted to use approximately abs(N*1024)
  41107. ** bytes of memory. */
  41108. return (int)((-1024*(i64)p->szCache)/(p->szPage+p->szExtra));
  41109. }
  41110. }
  41111. /*************************************************** General Interfaces ******
  41112. **
  41113. ** Initialize and shutdown the page cache subsystem. Neither of these
  41114. ** functions are threadsafe.
  41115. */
  41116. SQLITE_PRIVATE int sqlite3PcacheInitialize(void){
  41117. if( sqlite3GlobalConfig.pcache2.xInit==0 ){
  41118. /* IMPLEMENTATION-OF: R-26801-64137 If the xInit() method is NULL, then the
  41119. ** built-in default page cache is used instead of the application defined
  41120. ** page cache. */
  41121. sqlite3PCacheSetDefault();
  41122. }
  41123. return sqlite3GlobalConfig.pcache2.xInit(sqlite3GlobalConfig.pcache2.pArg);
  41124. }
  41125. SQLITE_PRIVATE void sqlite3PcacheShutdown(void){
  41126. if( sqlite3GlobalConfig.pcache2.xShutdown ){
  41127. /* IMPLEMENTATION-OF: R-26000-56589 The xShutdown() method may be NULL. */
  41128. sqlite3GlobalConfig.pcache2.xShutdown(sqlite3GlobalConfig.pcache2.pArg);
  41129. }
  41130. }
  41131. /*
  41132. ** Return the size in bytes of a PCache object.
  41133. */
  41134. SQLITE_PRIVATE int sqlite3PcacheSize(void){ return sizeof(PCache); }
  41135. /*
  41136. ** Create a new PCache object. Storage space to hold the object
  41137. ** has already been allocated and is passed in as the p pointer.
  41138. ** The caller discovers how much space needs to be allocated by
  41139. ** calling sqlite3PcacheSize().
  41140. */
  41141. SQLITE_PRIVATE int sqlite3PcacheOpen(
  41142. int szPage, /* Size of every page */
  41143. int szExtra, /* Extra space associated with each page */
  41144. int bPurgeable, /* True if pages are on backing store */
  41145. int (*xStress)(void*,PgHdr*),/* Call to try to make pages clean */
  41146. void *pStress, /* Argument to xStress */
  41147. PCache *p /* Preallocated space for the PCache */
  41148. ){
  41149. memset(p, 0, sizeof(PCache));
  41150. p->szPage = 1;
  41151. p->szExtra = szExtra;
  41152. p->bPurgeable = bPurgeable;
  41153. p->eCreate = 2;
  41154. p->xStress = xStress;
  41155. p->pStress = pStress;
  41156. p->szCache = 100;
  41157. p->szSpill = 1;
  41158. pcacheTrace(("%p.OPEN szPage %d bPurgeable %d\n",p,szPage,bPurgeable));
  41159. return sqlite3PcacheSetPageSize(p, szPage);
  41160. }
  41161. /*
  41162. ** Change the page size for PCache object. The caller must ensure that there
  41163. ** are no outstanding page references when this function is called.
  41164. */
  41165. SQLITE_PRIVATE int sqlite3PcacheSetPageSize(PCache *pCache, int szPage){
  41166. assert( pCache->nRefSum==0 && pCache->pDirty==0 );
  41167. if( pCache->szPage ){
  41168. sqlite3_pcache *pNew;
  41169. pNew = sqlite3GlobalConfig.pcache2.xCreate(
  41170. szPage, pCache->szExtra + ROUND8(sizeof(PgHdr)),
  41171. pCache->bPurgeable
  41172. );
  41173. if( pNew==0 ) return SQLITE_NOMEM_BKPT;
  41174. sqlite3GlobalConfig.pcache2.xCachesize(pNew, numberOfCachePages(pCache));
  41175. if( pCache->pCache ){
  41176. sqlite3GlobalConfig.pcache2.xDestroy(pCache->pCache);
  41177. }
  41178. pCache->pCache = pNew;
  41179. pCache->szPage = szPage;
  41180. pcacheTrace(("%p.PAGESIZE %d\n",pCache,szPage));
  41181. }
  41182. return SQLITE_OK;
  41183. }
  41184. /*
  41185. ** Try to obtain a page from the cache.
  41186. **
  41187. ** This routine returns a pointer to an sqlite3_pcache_page object if
  41188. ** such an object is already in cache, or if a new one is created.
  41189. ** This routine returns a NULL pointer if the object was not in cache
  41190. ** and could not be created.
  41191. **
  41192. ** The createFlags should be 0 to check for existing pages and should
  41193. ** be 3 (not 1, but 3) to try to create a new page.
  41194. **
  41195. ** If the createFlag is 0, then NULL is always returned if the page
  41196. ** is not already in the cache. If createFlag is 1, then a new page
  41197. ** is created only if that can be done without spilling dirty pages
  41198. ** and without exceeding the cache size limit.
  41199. **
  41200. ** The caller needs to invoke sqlite3PcacheFetchFinish() to properly
  41201. ** initialize the sqlite3_pcache_page object and convert it into a
  41202. ** PgHdr object. The sqlite3PcacheFetch() and sqlite3PcacheFetchFinish()
  41203. ** routines are split this way for performance reasons. When separated
  41204. ** they can both (usually) operate without having to push values to
  41205. ** the stack on entry and pop them back off on exit, which saves a
  41206. ** lot of pushing and popping.
  41207. */
  41208. SQLITE_PRIVATE sqlite3_pcache_page *sqlite3PcacheFetch(
  41209. PCache *pCache, /* Obtain the page from this cache */
  41210. Pgno pgno, /* Page number to obtain */
  41211. int createFlag /* If true, create page if it does not exist already */
  41212. ){
  41213. int eCreate;
  41214. sqlite3_pcache_page *pRes;
  41215. assert( pCache!=0 );
  41216. assert( pCache->pCache!=0 );
  41217. assert( createFlag==3 || createFlag==0 );
  41218. assert( pgno>0 );
  41219. assert( pCache->eCreate==((pCache->bPurgeable && pCache->pDirty) ? 1 : 2) );
  41220. /* eCreate defines what to do if the page does not exist.
  41221. ** 0 Do not allocate a new page. (createFlag==0)
  41222. ** 1 Allocate a new page if doing so is inexpensive.
  41223. ** (createFlag==1 AND bPurgeable AND pDirty)
  41224. ** 2 Allocate a new page even it doing so is difficult.
  41225. ** (createFlag==1 AND !(bPurgeable AND pDirty)
  41226. */
  41227. eCreate = createFlag & pCache->eCreate;
  41228. assert( eCreate==0 || eCreate==1 || eCreate==2 );
  41229. assert( createFlag==0 || pCache->eCreate==eCreate );
  41230. assert( createFlag==0 || eCreate==1+(!pCache->bPurgeable||!pCache->pDirty) );
  41231. pRes = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, pgno, eCreate);
  41232. pcacheTrace(("%p.FETCH %d%s (result: %p)\n",pCache,pgno,
  41233. createFlag?" create":"",pRes));
  41234. return pRes;
  41235. }
  41236. /*
  41237. ** If the sqlite3PcacheFetch() routine is unable to allocate a new
  41238. ** page because no clean pages are available for reuse and the cache
  41239. ** size limit has been reached, then this routine can be invoked to
  41240. ** try harder to allocate a page. This routine might invoke the stress
  41241. ** callback to spill dirty pages to the journal. It will then try to
  41242. ** allocate the new page and will only fail to allocate a new page on
  41243. ** an OOM error.
  41244. **
  41245. ** This routine should be invoked only after sqlite3PcacheFetch() fails.
  41246. */
  41247. SQLITE_PRIVATE int sqlite3PcacheFetchStress(
  41248. PCache *pCache, /* Obtain the page from this cache */
  41249. Pgno pgno, /* Page number to obtain */
  41250. sqlite3_pcache_page **ppPage /* Write result here */
  41251. ){
  41252. PgHdr *pPg;
  41253. if( pCache->eCreate==2 ) return 0;
  41254. if( sqlite3PcachePagecount(pCache)>pCache->szSpill ){
  41255. /* Find a dirty page to write-out and recycle. First try to find a
  41256. ** page that does not require a journal-sync (one with PGHDR_NEED_SYNC
  41257. ** cleared), but if that is not possible settle for any other
  41258. ** unreferenced dirty page.
  41259. **
  41260. ** If the LRU page in the dirty list that has a clear PGHDR_NEED_SYNC
  41261. ** flag is currently referenced, then the following may leave pSynced
  41262. ** set incorrectly (pointing to other than the LRU page with NEED_SYNC
  41263. ** cleared). This is Ok, as pSynced is just an optimization. */
  41264. for(pPg=pCache->pSynced;
  41265. pPg && (pPg->nRef || (pPg->flags&PGHDR_NEED_SYNC));
  41266. pPg=pPg->pDirtyPrev
  41267. );
  41268. pCache->pSynced = pPg;
  41269. if( !pPg ){
  41270. for(pPg=pCache->pDirtyTail; pPg && pPg->nRef; pPg=pPg->pDirtyPrev);
  41271. }
  41272. if( pPg ){
  41273. int rc;
  41274. #ifdef SQLITE_LOG_CACHE_SPILL
  41275. sqlite3_log(SQLITE_FULL,
  41276. "spill page %d making room for %d - cache used: %d/%d",
  41277. pPg->pgno, pgno,
  41278. sqlite3GlobalConfig.pcache.xPagecount(pCache->pCache),
  41279. numberOfCachePages(pCache));
  41280. #endif
  41281. pcacheTrace(("%p.SPILL %d\n",pCache,pPg->pgno));
  41282. rc = pCache->xStress(pCache->pStress, pPg);
  41283. pcacheDump(pCache);
  41284. if( rc!=SQLITE_OK && rc!=SQLITE_BUSY ){
  41285. return rc;
  41286. }
  41287. }
  41288. }
  41289. *ppPage = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, pgno, 2);
  41290. return *ppPage==0 ? SQLITE_NOMEM_BKPT : SQLITE_OK;
  41291. }
  41292. /*
  41293. ** This is a helper routine for sqlite3PcacheFetchFinish()
  41294. **
  41295. ** In the uncommon case where the page being fetched has not been
  41296. ** initialized, this routine is invoked to do the initialization.
  41297. ** This routine is broken out into a separate function since it
  41298. ** requires extra stack manipulation that can be avoided in the common
  41299. ** case.
  41300. */
  41301. static SQLITE_NOINLINE PgHdr *pcacheFetchFinishWithInit(
  41302. PCache *pCache, /* Obtain the page from this cache */
  41303. Pgno pgno, /* Page number obtained */
  41304. sqlite3_pcache_page *pPage /* Page obtained by prior PcacheFetch() call */
  41305. ){
  41306. PgHdr *pPgHdr;
  41307. assert( pPage!=0 );
  41308. pPgHdr = (PgHdr*)pPage->pExtra;
  41309. assert( pPgHdr->pPage==0 );
  41310. memset(&pPgHdr->pDirty, 0, sizeof(PgHdr) - offsetof(PgHdr,pDirty));
  41311. pPgHdr->pPage = pPage;
  41312. pPgHdr->pData = pPage->pBuf;
  41313. pPgHdr->pExtra = (void *)&pPgHdr[1];
  41314. memset(pPgHdr->pExtra, 0, pCache->szExtra);
  41315. pPgHdr->pCache = pCache;
  41316. pPgHdr->pgno = pgno;
  41317. pPgHdr->flags = PGHDR_CLEAN;
  41318. return sqlite3PcacheFetchFinish(pCache,pgno,pPage);
  41319. }
  41320. /*
  41321. ** This routine converts the sqlite3_pcache_page object returned by
  41322. ** sqlite3PcacheFetch() into an initialized PgHdr object. This routine
  41323. ** must be called after sqlite3PcacheFetch() in order to get a usable
  41324. ** result.
  41325. */
  41326. SQLITE_PRIVATE PgHdr *sqlite3PcacheFetchFinish(
  41327. PCache *pCache, /* Obtain the page from this cache */
  41328. Pgno pgno, /* Page number obtained */
  41329. sqlite3_pcache_page *pPage /* Page obtained by prior PcacheFetch() call */
  41330. ){
  41331. PgHdr *pPgHdr;
  41332. assert( pPage!=0 );
  41333. pPgHdr = (PgHdr *)pPage->pExtra;
  41334. if( !pPgHdr->pPage ){
  41335. return pcacheFetchFinishWithInit(pCache, pgno, pPage);
  41336. }
  41337. pCache->nRefSum++;
  41338. pPgHdr->nRef++;
  41339. assert( sqlite3PcachePageSanity(pPgHdr) );
  41340. return pPgHdr;
  41341. }
  41342. /*
  41343. ** Decrement the reference count on a page. If the page is clean and the
  41344. ** reference count drops to 0, then it is made eligible for recycling.
  41345. */
  41346. SQLITE_PRIVATE void SQLITE_NOINLINE sqlite3PcacheRelease(PgHdr *p){
  41347. assert( p->nRef>0 );
  41348. p->pCache->nRefSum--;
  41349. if( (--p->nRef)==0 ){
  41350. if( p->flags&PGHDR_CLEAN ){
  41351. pcacheUnpin(p);
  41352. }else if( p->pDirtyPrev!=0 ){ /*OPTIMIZATION-IF-FALSE*/
  41353. /* Move the page to the head of the dirty list. If p->pDirtyPrev==0,
  41354. ** then page p is already at the head of the dirty list and the
  41355. ** following call would be a no-op. Hence the OPTIMIZATION-IF-FALSE
  41356. ** tag above. */
  41357. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_FRONT);
  41358. }
  41359. }
  41360. }
  41361. /*
  41362. ** Increase the reference count of a supplied page by 1.
  41363. */
  41364. SQLITE_PRIVATE void sqlite3PcacheRef(PgHdr *p){
  41365. assert(p->nRef>0);
  41366. assert( sqlite3PcachePageSanity(p) );
  41367. p->nRef++;
  41368. p->pCache->nRefSum++;
  41369. }
  41370. /*
  41371. ** Drop a page from the cache. There must be exactly one reference to the
  41372. ** page. This function deletes that reference, so after it returns the
  41373. ** page pointed to by p is invalid.
  41374. */
  41375. SQLITE_PRIVATE void sqlite3PcacheDrop(PgHdr *p){
  41376. assert( p->nRef==1 );
  41377. assert( sqlite3PcachePageSanity(p) );
  41378. if( p->flags&PGHDR_DIRTY ){
  41379. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_REMOVE);
  41380. }
  41381. p->pCache->nRefSum--;
  41382. sqlite3GlobalConfig.pcache2.xUnpin(p->pCache->pCache, p->pPage, 1);
  41383. }
  41384. /*
  41385. ** Make sure the page is marked as dirty. If it isn't dirty already,
  41386. ** make it so.
  41387. */
  41388. SQLITE_PRIVATE void sqlite3PcacheMakeDirty(PgHdr *p){
  41389. assert( p->nRef>0 );
  41390. assert( sqlite3PcachePageSanity(p) );
  41391. if( p->flags & (PGHDR_CLEAN|PGHDR_DONT_WRITE) ){ /*OPTIMIZATION-IF-FALSE*/
  41392. p->flags &= ~PGHDR_DONT_WRITE;
  41393. if( p->flags & PGHDR_CLEAN ){
  41394. p->flags ^= (PGHDR_DIRTY|PGHDR_CLEAN);
  41395. pcacheTrace(("%p.DIRTY %d\n",p->pCache,p->pgno));
  41396. assert( (p->flags & (PGHDR_DIRTY|PGHDR_CLEAN))==PGHDR_DIRTY );
  41397. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_ADD);
  41398. }
  41399. assert( sqlite3PcachePageSanity(p) );
  41400. }
  41401. }
  41402. /*
  41403. ** Make sure the page is marked as clean. If it isn't clean already,
  41404. ** make it so.
  41405. */
  41406. SQLITE_PRIVATE void sqlite3PcacheMakeClean(PgHdr *p){
  41407. assert( sqlite3PcachePageSanity(p) );
  41408. if( ALWAYS((p->flags & PGHDR_DIRTY)!=0) ){
  41409. assert( (p->flags & PGHDR_CLEAN)==0 );
  41410. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_REMOVE);
  41411. p->flags &= ~(PGHDR_DIRTY|PGHDR_NEED_SYNC|PGHDR_WRITEABLE);
  41412. p->flags |= PGHDR_CLEAN;
  41413. pcacheTrace(("%p.CLEAN %d\n",p->pCache,p->pgno));
  41414. assert( sqlite3PcachePageSanity(p) );
  41415. if( p->nRef==0 ){
  41416. pcacheUnpin(p);
  41417. }
  41418. }
  41419. }
  41420. /*
  41421. ** Make every page in the cache clean.
  41422. */
  41423. SQLITE_PRIVATE void sqlite3PcacheCleanAll(PCache *pCache){
  41424. PgHdr *p;
  41425. pcacheTrace(("%p.CLEAN-ALL\n",pCache));
  41426. while( (p = pCache->pDirty)!=0 ){
  41427. sqlite3PcacheMakeClean(p);
  41428. }
  41429. }
  41430. /*
  41431. ** Clear the PGHDR_NEED_SYNC and PGHDR_WRITEABLE flag from all dirty pages.
  41432. */
  41433. SQLITE_PRIVATE void sqlite3PcacheClearWritable(PCache *pCache){
  41434. PgHdr *p;
  41435. pcacheTrace(("%p.CLEAR-WRITEABLE\n",pCache));
  41436. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  41437. p->flags &= ~(PGHDR_NEED_SYNC|PGHDR_WRITEABLE);
  41438. }
  41439. pCache->pSynced = pCache->pDirtyTail;
  41440. }
  41441. /*
  41442. ** Clear the PGHDR_NEED_SYNC flag from all dirty pages.
  41443. */
  41444. SQLITE_PRIVATE void sqlite3PcacheClearSyncFlags(PCache *pCache){
  41445. PgHdr *p;
  41446. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  41447. p->flags &= ~PGHDR_NEED_SYNC;
  41448. }
  41449. pCache->pSynced = pCache->pDirtyTail;
  41450. }
  41451. /*
  41452. ** Change the page number of page p to newPgno.
  41453. */
  41454. SQLITE_PRIVATE void sqlite3PcacheMove(PgHdr *p, Pgno newPgno){
  41455. PCache *pCache = p->pCache;
  41456. assert( p->nRef>0 );
  41457. assert( newPgno>0 );
  41458. assert( sqlite3PcachePageSanity(p) );
  41459. pcacheTrace(("%p.MOVE %d -> %d\n",pCache,p->pgno,newPgno));
  41460. sqlite3GlobalConfig.pcache2.xRekey(pCache->pCache, p->pPage, p->pgno,newPgno);
  41461. p->pgno = newPgno;
  41462. if( (p->flags&PGHDR_DIRTY) && (p->flags&PGHDR_NEED_SYNC) ){
  41463. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_FRONT);
  41464. }
  41465. }
  41466. /*
  41467. ** Drop every cache entry whose page number is greater than "pgno". The
  41468. ** caller must ensure that there are no outstanding references to any pages
  41469. ** other than page 1 with a page number greater than pgno.
  41470. **
  41471. ** If there is a reference to page 1 and the pgno parameter passed to this
  41472. ** function is 0, then the data area associated with page 1 is zeroed, but
  41473. ** the page object is not dropped.
  41474. */
  41475. SQLITE_PRIVATE void sqlite3PcacheTruncate(PCache *pCache, Pgno pgno){
  41476. if( pCache->pCache ){
  41477. PgHdr *p;
  41478. PgHdr *pNext;
  41479. pcacheTrace(("%p.TRUNCATE %d\n",pCache,pgno));
  41480. for(p=pCache->pDirty; p; p=pNext){
  41481. pNext = p->pDirtyNext;
  41482. /* This routine never gets call with a positive pgno except right
  41483. ** after sqlite3PcacheCleanAll(). So if there are dirty pages,
  41484. ** it must be that pgno==0.
  41485. */
  41486. assert( p->pgno>0 );
  41487. if( p->pgno>pgno ){
  41488. assert( p->flags&PGHDR_DIRTY );
  41489. sqlite3PcacheMakeClean(p);
  41490. }
  41491. }
  41492. if( pgno==0 && pCache->nRefSum ){
  41493. sqlite3_pcache_page *pPage1;
  41494. pPage1 = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache,1,0);
  41495. if( ALWAYS(pPage1) ){ /* Page 1 is always available in cache, because
  41496. ** pCache->nRefSum>0 */
  41497. memset(pPage1->pBuf, 0, pCache->szPage);
  41498. pgno = 1;
  41499. }
  41500. }
  41501. sqlite3GlobalConfig.pcache2.xTruncate(pCache->pCache, pgno+1);
  41502. }
  41503. }
  41504. /*
  41505. ** Close a cache.
  41506. */
  41507. SQLITE_PRIVATE void sqlite3PcacheClose(PCache *pCache){
  41508. assert( pCache->pCache!=0 );
  41509. pcacheTrace(("%p.CLOSE\n",pCache));
  41510. sqlite3GlobalConfig.pcache2.xDestroy(pCache->pCache);
  41511. }
  41512. /*
  41513. ** Discard the contents of the cache.
  41514. */
  41515. SQLITE_PRIVATE void sqlite3PcacheClear(PCache *pCache){
  41516. sqlite3PcacheTruncate(pCache, 0);
  41517. }
  41518. /*
  41519. ** Merge two lists of pages connected by pDirty and in pgno order.
  41520. ** Do not bother fixing the pDirtyPrev pointers.
  41521. */
  41522. static PgHdr *pcacheMergeDirtyList(PgHdr *pA, PgHdr *pB){
  41523. PgHdr result, *pTail;
  41524. pTail = &result;
  41525. assert( pA!=0 && pB!=0 );
  41526. for(;;){
  41527. if( pA->pgno<pB->pgno ){
  41528. pTail->pDirty = pA;
  41529. pTail = pA;
  41530. pA = pA->pDirty;
  41531. if( pA==0 ){
  41532. pTail->pDirty = pB;
  41533. break;
  41534. }
  41535. }else{
  41536. pTail->pDirty = pB;
  41537. pTail = pB;
  41538. pB = pB->pDirty;
  41539. if( pB==0 ){
  41540. pTail->pDirty = pA;
  41541. break;
  41542. }
  41543. }
  41544. }
  41545. return result.pDirty;
  41546. }
  41547. /*
  41548. ** Sort the list of pages in accending order by pgno. Pages are
  41549. ** connected by pDirty pointers. The pDirtyPrev pointers are
  41550. ** corrupted by this sort.
  41551. **
  41552. ** Since there cannot be more than 2^31 distinct pages in a database,
  41553. ** there cannot be more than 31 buckets required by the merge sorter.
  41554. ** One extra bucket is added to catch overflow in case something
  41555. ** ever changes to make the previous sentence incorrect.
  41556. */
  41557. #define N_SORT_BUCKET 32
  41558. static PgHdr *pcacheSortDirtyList(PgHdr *pIn){
  41559. PgHdr *a[N_SORT_BUCKET], *p;
  41560. int i;
  41561. memset(a, 0, sizeof(a));
  41562. while( pIn ){
  41563. p = pIn;
  41564. pIn = p->pDirty;
  41565. p->pDirty = 0;
  41566. for(i=0; ALWAYS(i<N_SORT_BUCKET-1); i++){
  41567. if( a[i]==0 ){
  41568. a[i] = p;
  41569. break;
  41570. }else{
  41571. p = pcacheMergeDirtyList(a[i], p);
  41572. a[i] = 0;
  41573. }
  41574. }
  41575. if( NEVER(i==N_SORT_BUCKET-1) ){
  41576. /* To get here, there need to be 2^(N_SORT_BUCKET) elements in
  41577. ** the input list. But that is impossible.
  41578. */
  41579. a[i] = pcacheMergeDirtyList(a[i], p);
  41580. }
  41581. }
  41582. p = a[0];
  41583. for(i=1; i<N_SORT_BUCKET; i++){
  41584. if( a[i]==0 ) continue;
  41585. p = p ? pcacheMergeDirtyList(p, a[i]) : a[i];
  41586. }
  41587. return p;
  41588. }
  41589. /*
  41590. ** Return a list of all dirty pages in the cache, sorted by page number.
  41591. */
  41592. SQLITE_PRIVATE PgHdr *sqlite3PcacheDirtyList(PCache *pCache){
  41593. PgHdr *p;
  41594. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  41595. p->pDirty = p->pDirtyNext;
  41596. }
  41597. return pcacheSortDirtyList(pCache->pDirty);
  41598. }
  41599. /*
  41600. ** Return the total number of references to all pages held by the cache.
  41601. **
  41602. ** This is not the total number of pages referenced, but the sum of the
  41603. ** reference count for all pages.
  41604. */
  41605. SQLITE_PRIVATE int sqlite3PcacheRefCount(PCache *pCache){
  41606. return pCache->nRefSum;
  41607. }
  41608. /*
  41609. ** Return the number of references to the page supplied as an argument.
  41610. */
  41611. SQLITE_PRIVATE int sqlite3PcachePageRefcount(PgHdr *p){
  41612. return p->nRef;
  41613. }
  41614. /*
  41615. ** Return the total number of pages in the cache.
  41616. */
  41617. SQLITE_PRIVATE int sqlite3PcachePagecount(PCache *pCache){
  41618. assert( pCache->pCache!=0 );
  41619. return sqlite3GlobalConfig.pcache2.xPagecount(pCache->pCache);
  41620. }
  41621. #ifdef SQLITE_TEST
  41622. /*
  41623. ** Get the suggested cache-size value.
  41624. */
  41625. SQLITE_PRIVATE int sqlite3PcacheGetCachesize(PCache *pCache){
  41626. return numberOfCachePages(pCache);
  41627. }
  41628. #endif
  41629. /*
  41630. ** Set the suggested cache-size value.
  41631. */
  41632. SQLITE_PRIVATE void sqlite3PcacheSetCachesize(PCache *pCache, int mxPage){
  41633. assert( pCache->pCache!=0 );
  41634. pCache->szCache = mxPage;
  41635. sqlite3GlobalConfig.pcache2.xCachesize(pCache->pCache,
  41636. numberOfCachePages(pCache));
  41637. }
  41638. /*
  41639. ** Set the suggested cache-spill value. Make no changes if if the
  41640. ** argument is zero. Return the effective cache-spill size, which will
  41641. ** be the larger of the szSpill and szCache.
  41642. */
  41643. SQLITE_PRIVATE int sqlite3PcacheSetSpillsize(PCache *p, int mxPage){
  41644. int res;
  41645. assert( p->pCache!=0 );
  41646. if( mxPage ){
  41647. if( mxPage<0 ){
  41648. mxPage = (int)((-1024*(i64)mxPage)/(p->szPage+p->szExtra));
  41649. }
  41650. p->szSpill = mxPage;
  41651. }
  41652. res = numberOfCachePages(p);
  41653. if( res<p->szSpill ) res = p->szSpill;
  41654. return res;
  41655. }
  41656. /*
  41657. ** Free up as much memory as possible from the page cache.
  41658. */
  41659. SQLITE_PRIVATE void sqlite3PcacheShrink(PCache *pCache){
  41660. assert( pCache->pCache!=0 );
  41661. sqlite3GlobalConfig.pcache2.xShrink(pCache->pCache);
  41662. }
  41663. /*
  41664. ** Return the size of the header added by this middleware layer
  41665. ** in the page-cache hierarchy.
  41666. */
  41667. SQLITE_PRIVATE int sqlite3HeaderSizePcache(void){ return ROUND8(sizeof(PgHdr)); }
  41668. /*
  41669. ** Return the number of dirty pages currently in the cache, as a percentage
  41670. ** of the configured cache size.
  41671. */
  41672. SQLITE_PRIVATE int sqlite3PCachePercentDirty(PCache *pCache){
  41673. PgHdr *pDirty;
  41674. int nDirty = 0;
  41675. int nCache = numberOfCachePages(pCache);
  41676. for(pDirty=pCache->pDirty; pDirty; pDirty=pDirty->pDirtyNext) nDirty++;
  41677. return nCache ? (int)(((i64)nDirty * 100) / nCache) : 0;
  41678. }
  41679. #if defined(SQLITE_CHECK_PAGES) || defined(SQLITE_DEBUG)
  41680. /*
  41681. ** For all dirty pages currently in the cache, invoke the specified
  41682. ** callback. This is only used if the SQLITE_CHECK_PAGES macro is
  41683. ** defined.
  41684. */
  41685. SQLITE_PRIVATE void sqlite3PcacheIterateDirty(PCache *pCache, void (*xIter)(PgHdr *)){
  41686. PgHdr *pDirty;
  41687. for(pDirty=pCache->pDirty; pDirty; pDirty=pDirty->pDirtyNext){
  41688. xIter(pDirty);
  41689. }
  41690. }
  41691. #endif
  41692. /************** End of pcache.c **********************************************/
  41693. /************** Begin file pcache1.c *****************************************/
  41694. /*
  41695. ** 2008 November 05
  41696. **
  41697. ** The author disclaims copyright to this source code. In place of
  41698. ** a legal notice, here is a blessing:
  41699. **
  41700. ** May you do good and not evil.
  41701. ** May you find forgiveness for yourself and forgive others.
  41702. ** May you share freely, never taking more than you give.
  41703. **
  41704. *************************************************************************
  41705. **
  41706. ** This file implements the default page cache implementation (the
  41707. ** sqlite3_pcache interface). It also contains part of the implementation
  41708. ** of the SQLITE_CONFIG_PAGECACHE and sqlite3_release_memory() features.
  41709. ** If the default page cache implementation is overridden, then neither of
  41710. ** these two features are available.
  41711. **
  41712. ** A Page cache line looks like this:
  41713. **
  41714. ** -------------------------------------------------------------
  41715. ** | database page content | PgHdr1 | MemPage | PgHdr |
  41716. ** -------------------------------------------------------------
  41717. **
  41718. ** The database page content is up front (so that buffer overreads tend to
  41719. ** flow harmlessly into the PgHdr1, MemPage, and PgHdr extensions). MemPage
  41720. ** is the extension added by the btree.c module containing information such
  41721. ** as the database page number and how that database page is used. PgHdr
  41722. ** is added by the pcache.c layer and contains information used to keep track
  41723. ** of which pages are "dirty". PgHdr1 is an extension added by this
  41724. ** module (pcache1.c). The PgHdr1 header is a subclass of sqlite3_pcache_page.
  41725. ** PgHdr1 contains information needed to look up a page by its page number.
  41726. ** The superclass sqlite3_pcache_page.pBuf points to the start of the
  41727. ** database page content and sqlite3_pcache_page.pExtra points to PgHdr.
  41728. **
  41729. ** The size of the extension (MemPage+PgHdr+PgHdr1) can be determined at
  41730. ** runtime using sqlite3_config(SQLITE_CONFIG_PCACHE_HDRSZ, &size). The
  41731. ** sizes of the extensions sum to 272 bytes on x64 for 3.8.10, but this
  41732. ** size can vary according to architecture, compile-time options, and
  41733. ** SQLite library version number.
  41734. **
  41735. ** If SQLITE_PCACHE_SEPARATE_HEADER is defined, then the extension is obtained
  41736. ** using a separate memory allocation from the database page content. This
  41737. ** seeks to overcome the "clownshoe" problem (also called "internal
  41738. ** fragmentation" in academic literature) of allocating a few bytes more
  41739. ** than a power of two with the memory allocator rounding up to the next
  41740. ** power of two, and leaving the rounded-up space unused.
  41741. **
  41742. ** This module tracks pointers to PgHdr1 objects. Only pcache.c communicates
  41743. ** with this module. Information is passed back and forth as PgHdr1 pointers.
  41744. **
  41745. ** The pcache.c and pager.c modules deal pointers to PgHdr objects.
  41746. ** The btree.c module deals with pointers to MemPage objects.
  41747. **
  41748. ** SOURCE OF PAGE CACHE MEMORY:
  41749. **
  41750. ** Memory for a page might come from any of three sources:
  41751. **
  41752. ** (1) The general-purpose memory allocator - sqlite3Malloc()
  41753. ** (2) Global page-cache memory provided using sqlite3_config() with
  41754. ** SQLITE_CONFIG_PAGECACHE.
  41755. ** (3) PCache-local bulk allocation.
  41756. **
  41757. ** The third case is a chunk of heap memory (defaulting to 100 pages worth)
  41758. ** that is allocated when the page cache is created. The size of the local
  41759. ** bulk allocation can be adjusted using
  41760. **
  41761. ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, (void*)0, 0, N).
  41762. **
  41763. ** If N is positive, then N pages worth of memory are allocated using a single
  41764. ** sqlite3Malloc() call and that memory is used for the first N pages allocated.
  41765. ** Or if N is negative, then -1024*N bytes of memory are allocated and used
  41766. ** for as many pages as can be accomodated.
  41767. **
  41768. ** Only one of (2) or (3) can be used. Once the memory available to (2) or
  41769. ** (3) is exhausted, subsequent allocations fail over to the general-purpose
  41770. ** memory allocator (1).
  41771. **
  41772. ** Earlier versions of SQLite used only methods (1) and (2). But experiments
  41773. ** show that method (3) with N==100 provides about a 5% performance boost for
  41774. ** common workloads.
  41775. */
  41776. /* #include "sqliteInt.h" */
  41777. typedef struct PCache1 PCache1;
  41778. typedef struct PgHdr1 PgHdr1;
  41779. typedef struct PgFreeslot PgFreeslot;
  41780. typedef struct PGroup PGroup;
  41781. /*
  41782. ** Each cache entry is represented by an instance of the following
  41783. ** structure. Unless SQLITE_PCACHE_SEPARATE_HEADER is defined, a buffer of
  41784. ** PgHdr1.pCache->szPage bytes is allocated directly before this structure
  41785. ** in memory.
  41786. */
  41787. struct PgHdr1 {
  41788. sqlite3_pcache_page page; /* Base class. Must be first. pBuf & pExtra */
  41789. unsigned int iKey; /* Key value (page number) */
  41790. u8 isPinned; /* Page in use, not on the LRU list */
  41791. u8 isBulkLocal; /* This page from bulk local storage */
  41792. u8 isAnchor; /* This is the PGroup.lru element */
  41793. PgHdr1 *pNext; /* Next in hash table chain */
  41794. PCache1 *pCache; /* Cache that currently owns this page */
  41795. PgHdr1 *pLruNext; /* Next in LRU list of unpinned pages */
  41796. PgHdr1 *pLruPrev; /* Previous in LRU list of unpinned pages */
  41797. };
  41798. /* Each page cache (or PCache) belongs to a PGroup. A PGroup is a set
  41799. ** of one or more PCaches that are able to recycle each other's unpinned
  41800. ** pages when they are under memory pressure. A PGroup is an instance of
  41801. ** the following object.
  41802. **
  41803. ** This page cache implementation works in one of two modes:
  41804. **
  41805. ** (1) Every PCache is the sole member of its own PGroup. There is
  41806. ** one PGroup per PCache.
  41807. **
  41808. ** (2) There is a single global PGroup that all PCaches are a member
  41809. ** of.
  41810. **
  41811. ** Mode 1 uses more memory (since PCache instances are not able to rob
  41812. ** unused pages from other PCaches) but it also operates without a mutex,
  41813. ** and is therefore often faster. Mode 2 requires a mutex in order to be
  41814. ** threadsafe, but recycles pages more efficiently.
  41815. **
  41816. ** For mode (1), PGroup.mutex is NULL. For mode (2) there is only a single
  41817. ** PGroup which is the pcache1.grp global variable and its mutex is
  41818. ** SQLITE_MUTEX_STATIC_LRU.
  41819. */
  41820. struct PGroup {
  41821. sqlite3_mutex *mutex; /* MUTEX_STATIC_LRU or NULL */
  41822. unsigned int nMaxPage; /* Sum of nMax for purgeable caches */
  41823. unsigned int nMinPage; /* Sum of nMin for purgeable caches */
  41824. unsigned int mxPinned; /* nMaxpage + 10 - nMinPage */
  41825. unsigned int nCurrentPage; /* Number of purgeable pages allocated */
  41826. PgHdr1 lru; /* The beginning and end of the LRU list */
  41827. };
  41828. /* Each page cache is an instance of the following object. Every
  41829. ** open database file (including each in-memory database and each
  41830. ** temporary or transient database) has a single page cache which
  41831. ** is an instance of this object.
  41832. **
  41833. ** Pointers to structures of this type are cast and returned as
  41834. ** opaque sqlite3_pcache* handles.
  41835. */
  41836. struct PCache1 {
  41837. /* Cache configuration parameters. Page size (szPage) and the purgeable
  41838. ** flag (bPurgeable) are set when the cache is created. nMax may be
  41839. ** modified at any time by a call to the pcache1Cachesize() method.
  41840. ** The PGroup mutex must be held when accessing nMax.
  41841. */
  41842. PGroup *pGroup; /* PGroup this cache belongs to */
  41843. int szPage; /* Size of database content section */
  41844. int szExtra; /* sizeof(MemPage)+sizeof(PgHdr) */
  41845. int szAlloc; /* Total size of one pcache line */
  41846. int bPurgeable; /* True if cache is purgeable */
  41847. unsigned int nMin; /* Minimum number of pages reserved */
  41848. unsigned int nMax; /* Configured "cache_size" value */
  41849. unsigned int n90pct; /* nMax*9/10 */
  41850. unsigned int iMaxKey; /* Largest key seen since xTruncate() */
  41851. /* Hash table of all pages. The following variables may only be accessed
  41852. ** when the accessor is holding the PGroup mutex.
  41853. */
  41854. unsigned int nRecyclable; /* Number of pages in the LRU list */
  41855. unsigned int nPage; /* Total number of pages in apHash */
  41856. unsigned int nHash; /* Number of slots in apHash[] */
  41857. PgHdr1 **apHash; /* Hash table for fast lookup by key */
  41858. PgHdr1 *pFree; /* List of unused pcache-local pages */
  41859. void *pBulk; /* Bulk memory used by pcache-local */
  41860. };
  41861. /*
  41862. ** Free slots in the allocator used to divide up the global page cache
  41863. ** buffer provided using the SQLITE_CONFIG_PAGECACHE mechanism.
  41864. */
  41865. struct PgFreeslot {
  41866. PgFreeslot *pNext; /* Next free slot */
  41867. };
  41868. /*
  41869. ** Global data used by this cache.
  41870. */
  41871. static SQLITE_WSD struct PCacheGlobal {
  41872. PGroup grp; /* The global PGroup for mode (2) */
  41873. /* Variables related to SQLITE_CONFIG_PAGECACHE settings. The
  41874. ** szSlot, nSlot, pStart, pEnd, nReserve, and isInit values are all
  41875. ** fixed at sqlite3_initialize() time and do not require mutex protection.
  41876. ** The nFreeSlot and pFree values do require mutex protection.
  41877. */
  41878. int isInit; /* True if initialized */
  41879. int separateCache; /* Use a new PGroup for each PCache */
  41880. int nInitPage; /* Initial bulk allocation size */
  41881. int szSlot; /* Size of each free slot */
  41882. int nSlot; /* The number of pcache slots */
  41883. int nReserve; /* Try to keep nFreeSlot above this */
  41884. void *pStart, *pEnd; /* Bounds of global page cache memory */
  41885. /* Above requires no mutex. Use mutex below for variable that follow. */
  41886. sqlite3_mutex *mutex; /* Mutex for accessing the following: */
  41887. PgFreeslot *pFree; /* Free page blocks */
  41888. int nFreeSlot; /* Number of unused pcache slots */
  41889. /* The following value requires a mutex to change. We skip the mutex on
  41890. ** reading because (1) most platforms read a 32-bit integer atomically and
  41891. ** (2) even if an incorrect value is read, no great harm is done since this
  41892. ** is really just an optimization. */
  41893. int bUnderPressure; /* True if low on PAGECACHE memory */
  41894. } pcache1_g;
  41895. /*
  41896. ** All code in this file should access the global structure above via the
  41897. ** alias "pcache1". This ensures that the WSD emulation is used when
  41898. ** compiling for systems that do not support real WSD.
  41899. */
  41900. #define pcache1 (GLOBAL(struct PCacheGlobal, pcache1_g))
  41901. /*
  41902. ** Macros to enter and leave the PCache LRU mutex.
  41903. */
  41904. #if !defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) || SQLITE_THREADSAFE==0
  41905. # define pcache1EnterMutex(X) assert((X)->mutex==0)
  41906. # define pcache1LeaveMutex(X) assert((X)->mutex==0)
  41907. # define PCACHE1_MIGHT_USE_GROUP_MUTEX 0
  41908. #else
  41909. # define pcache1EnterMutex(X) sqlite3_mutex_enter((X)->mutex)
  41910. # define pcache1LeaveMutex(X) sqlite3_mutex_leave((X)->mutex)
  41911. # define PCACHE1_MIGHT_USE_GROUP_MUTEX 1
  41912. #endif
  41913. /******************************************************************************/
  41914. /******** Page Allocation/SQLITE_CONFIG_PCACHE Related Functions **************/
  41915. /*
  41916. ** This function is called during initialization if a static buffer is
  41917. ** supplied to use for the page-cache by passing the SQLITE_CONFIG_PAGECACHE
  41918. ** verb to sqlite3_config(). Parameter pBuf points to an allocation large
  41919. ** enough to contain 'n' buffers of 'sz' bytes each.
  41920. **
  41921. ** This routine is called from sqlite3_initialize() and so it is guaranteed
  41922. ** to be serialized already. There is no need for further mutexing.
  41923. */
  41924. SQLITE_PRIVATE void sqlite3PCacheBufferSetup(void *pBuf, int sz, int n){
  41925. if( pcache1.isInit ){
  41926. PgFreeslot *p;
  41927. if( pBuf==0 ) sz = n = 0;
  41928. sz = ROUNDDOWN8(sz);
  41929. pcache1.szSlot = sz;
  41930. pcache1.nSlot = pcache1.nFreeSlot = n;
  41931. pcache1.nReserve = n>90 ? 10 : (n/10 + 1);
  41932. pcache1.pStart = pBuf;
  41933. pcache1.pFree = 0;
  41934. pcache1.bUnderPressure = 0;
  41935. while( n-- ){
  41936. p = (PgFreeslot*)pBuf;
  41937. p->pNext = pcache1.pFree;
  41938. pcache1.pFree = p;
  41939. pBuf = (void*)&((char*)pBuf)[sz];
  41940. }
  41941. pcache1.pEnd = pBuf;
  41942. }
  41943. }
  41944. /*
  41945. ** Try to initialize the pCache->pFree and pCache->pBulk fields. Return
  41946. ** true if pCache->pFree ends up containing one or more free pages.
  41947. */
  41948. static int pcache1InitBulk(PCache1 *pCache){
  41949. i64 szBulk;
  41950. char *zBulk;
  41951. if( pcache1.nInitPage==0 ) return 0;
  41952. /* Do not bother with a bulk allocation if the cache size very small */
  41953. if( pCache->nMax<3 ) return 0;
  41954. sqlite3BeginBenignMalloc();
  41955. if( pcache1.nInitPage>0 ){
  41956. szBulk = pCache->szAlloc * (i64)pcache1.nInitPage;
  41957. }else{
  41958. szBulk = -1024 * (i64)pcache1.nInitPage;
  41959. }
  41960. if( szBulk > pCache->szAlloc*(i64)pCache->nMax ){
  41961. szBulk = pCache->szAlloc*(i64)pCache->nMax;
  41962. }
  41963. zBulk = pCache->pBulk = sqlite3Malloc( szBulk );
  41964. sqlite3EndBenignMalloc();
  41965. if( zBulk ){
  41966. int nBulk = sqlite3MallocSize(zBulk)/pCache->szAlloc;
  41967. int i;
  41968. for(i=0; i<nBulk; i++){
  41969. PgHdr1 *pX = (PgHdr1*)&zBulk[pCache->szPage];
  41970. pX->page.pBuf = zBulk;
  41971. pX->page.pExtra = &pX[1];
  41972. pX->isBulkLocal = 1;
  41973. pX->isAnchor = 0;
  41974. pX->pNext = pCache->pFree;
  41975. pCache->pFree = pX;
  41976. zBulk += pCache->szAlloc;
  41977. }
  41978. }
  41979. return pCache->pFree!=0;
  41980. }
  41981. /*
  41982. ** Malloc function used within this file to allocate space from the buffer
  41983. ** configured using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no
  41984. ** such buffer exists or there is no space left in it, this function falls
  41985. ** back to sqlite3Malloc().
  41986. **
  41987. ** Multiple threads can run this routine at the same time. Global variables
  41988. ** in pcache1 need to be protected via mutex.
  41989. */
  41990. static void *pcache1Alloc(int nByte){
  41991. void *p = 0;
  41992. assert( sqlite3_mutex_notheld(pcache1.grp.mutex) );
  41993. if( nByte<=pcache1.szSlot ){
  41994. sqlite3_mutex_enter(pcache1.mutex);
  41995. p = (PgHdr1 *)pcache1.pFree;
  41996. if( p ){
  41997. pcache1.pFree = pcache1.pFree->pNext;
  41998. pcache1.nFreeSlot--;
  41999. pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve;
  42000. assert( pcache1.nFreeSlot>=0 );
  42001. sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte);
  42002. sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_USED, 1);
  42003. }
  42004. sqlite3_mutex_leave(pcache1.mutex);
  42005. }
  42006. if( p==0 ){
  42007. /* Memory is not available in the SQLITE_CONFIG_PAGECACHE pool. Get
  42008. ** it from sqlite3Malloc instead.
  42009. */
  42010. p = sqlite3Malloc(nByte);
  42011. #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS
  42012. if( p ){
  42013. int sz = sqlite3MallocSize(p);
  42014. sqlite3_mutex_enter(pcache1.mutex);
  42015. sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte);
  42016. sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_OVERFLOW, sz);
  42017. sqlite3_mutex_leave(pcache1.mutex);
  42018. }
  42019. #endif
  42020. sqlite3MemdebugSetType(p, MEMTYPE_PCACHE);
  42021. }
  42022. return p;
  42023. }
  42024. /*
  42025. ** Free an allocated buffer obtained from pcache1Alloc().
  42026. */
  42027. static void pcache1Free(void *p){
  42028. if( p==0 ) return;
  42029. if( SQLITE_WITHIN(p, pcache1.pStart, pcache1.pEnd) ){
  42030. PgFreeslot *pSlot;
  42031. sqlite3_mutex_enter(pcache1.mutex);
  42032. sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_USED, 1);
  42033. pSlot = (PgFreeslot*)p;
  42034. pSlot->pNext = pcache1.pFree;
  42035. pcache1.pFree = pSlot;
  42036. pcache1.nFreeSlot++;
  42037. pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve;
  42038. assert( pcache1.nFreeSlot<=pcache1.nSlot );
  42039. sqlite3_mutex_leave(pcache1.mutex);
  42040. }else{
  42041. assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) );
  42042. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  42043. #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS
  42044. {
  42045. int nFreed = 0;
  42046. nFreed = sqlite3MallocSize(p);
  42047. sqlite3_mutex_enter(pcache1.mutex);
  42048. sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_OVERFLOW, nFreed);
  42049. sqlite3_mutex_leave(pcache1.mutex);
  42050. }
  42051. #endif
  42052. sqlite3_free(p);
  42053. }
  42054. }
  42055. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  42056. /*
  42057. ** Return the size of a pcache allocation
  42058. */
  42059. static int pcache1MemSize(void *p){
  42060. if( p>=pcache1.pStart && p<pcache1.pEnd ){
  42061. return pcache1.szSlot;
  42062. }else{
  42063. int iSize;
  42064. assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) );
  42065. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  42066. iSize = sqlite3MallocSize(p);
  42067. sqlite3MemdebugSetType(p, MEMTYPE_PCACHE);
  42068. return iSize;
  42069. }
  42070. }
  42071. #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
  42072. /*
  42073. ** Allocate a new page object initially associated with cache pCache.
  42074. */
  42075. static PgHdr1 *pcache1AllocPage(PCache1 *pCache, int benignMalloc){
  42076. PgHdr1 *p = 0;
  42077. void *pPg;
  42078. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  42079. if( pCache->pFree || (pCache->nPage==0 && pcache1InitBulk(pCache)) ){
  42080. p = pCache->pFree;
  42081. pCache->pFree = p->pNext;
  42082. p->pNext = 0;
  42083. }else{
  42084. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  42085. /* The group mutex must be released before pcache1Alloc() is called. This
  42086. ** is because it might call sqlite3_release_memory(), which assumes that
  42087. ** this mutex is not held. */
  42088. assert( pcache1.separateCache==0 );
  42089. assert( pCache->pGroup==&pcache1.grp );
  42090. pcache1LeaveMutex(pCache->pGroup);
  42091. #endif
  42092. if( benignMalloc ){ sqlite3BeginBenignMalloc(); }
  42093. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  42094. pPg = pcache1Alloc(pCache->szPage);
  42095. p = sqlite3Malloc(sizeof(PgHdr1) + pCache->szExtra);
  42096. if( !pPg || !p ){
  42097. pcache1Free(pPg);
  42098. sqlite3_free(p);
  42099. pPg = 0;
  42100. }
  42101. #else
  42102. pPg = pcache1Alloc(pCache->szAlloc);
  42103. p = (PgHdr1 *)&((u8 *)pPg)[pCache->szPage];
  42104. #endif
  42105. if( benignMalloc ){ sqlite3EndBenignMalloc(); }
  42106. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  42107. pcache1EnterMutex(pCache->pGroup);
  42108. #endif
  42109. if( pPg==0 ) return 0;
  42110. p->page.pBuf = pPg;
  42111. p->page.pExtra = &p[1];
  42112. p->isBulkLocal = 0;
  42113. p->isAnchor = 0;
  42114. }
  42115. if( pCache->bPurgeable ){
  42116. pCache->pGroup->nCurrentPage++;
  42117. }
  42118. return p;
  42119. }
  42120. /*
  42121. ** Free a page object allocated by pcache1AllocPage().
  42122. */
  42123. static void pcache1FreePage(PgHdr1 *p){
  42124. PCache1 *pCache;
  42125. assert( p!=0 );
  42126. pCache = p->pCache;
  42127. assert( sqlite3_mutex_held(p->pCache->pGroup->mutex) );
  42128. if( p->isBulkLocal ){
  42129. p->pNext = pCache->pFree;
  42130. pCache->pFree = p;
  42131. }else{
  42132. pcache1Free(p->page.pBuf);
  42133. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  42134. sqlite3_free(p);
  42135. #endif
  42136. }
  42137. if( pCache->bPurgeable ){
  42138. pCache->pGroup->nCurrentPage--;
  42139. }
  42140. }
  42141. /*
  42142. ** Malloc function used by SQLite to obtain space from the buffer configured
  42143. ** using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no such buffer
  42144. ** exists, this function falls back to sqlite3Malloc().
  42145. */
  42146. SQLITE_PRIVATE void *sqlite3PageMalloc(int sz){
  42147. return pcache1Alloc(sz);
  42148. }
  42149. /*
  42150. ** Free an allocated buffer obtained from sqlite3PageMalloc().
  42151. */
  42152. SQLITE_PRIVATE void sqlite3PageFree(void *p){
  42153. pcache1Free(p);
  42154. }
  42155. /*
  42156. ** Return true if it desirable to avoid allocating a new page cache
  42157. ** entry.
  42158. **
  42159. ** If memory was allocated specifically to the page cache using
  42160. ** SQLITE_CONFIG_PAGECACHE but that memory has all been used, then
  42161. ** it is desirable to avoid allocating a new page cache entry because
  42162. ** presumably SQLITE_CONFIG_PAGECACHE was suppose to be sufficient
  42163. ** for all page cache needs and we should not need to spill the
  42164. ** allocation onto the heap.
  42165. **
  42166. ** Or, the heap is used for all page cache memory but the heap is
  42167. ** under memory pressure, then again it is desirable to avoid
  42168. ** allocating a new page cache entry in order to avoid stressing
  42169. ** the heap even further.
  42170. */
  42171. static int pcache1UnderMemoryPressure(PCache1 *pCache){
  42172. if( pcache1.nSlot && (pCache->szPage+pCache->szExtra)<=pcache1.szSlot ){
  42173. return pcache1.bUnderPressure;
  42174. }else{
  42175. return sqlite3HeapNearlyFull();
  42176. }
  42177. }
  42178. /******************************************************************************/
  42179. /******** General Implementation Functions ************************************/
  42180. /*
  42181. ** This function is used to resize the hash table used by the cache passed
  42182. ** as the first argument.
  42183. **
  42184. ** The PCache mutex must be held when this function is called.
  42185. */
  42186. static void pcache1ResizeHash(PCache1 *p){
  42187. PgHdr1 **apNew;
  42188. unsigned int nNew;
  42189. unsigned int i;
  42190. assert( sqlite3_mutex_held(p->pGroup->mutex) );
  42191. nNew = p->nHash*2;
  42192. if( nNew<256 ){
  42193. nNew = 256;
  42194. }
  42195. pcache1LeaveMutex(p->pGroup);
  42196. if( p->nHash ){ sqlite3BeginBenignMalloc(); }
  42197. apNew = (PgHdr1 **)sqlite3MallocZero(sizeof(PgHdr1 *)*nNew);
  42198. if( p->nHash ){ sqlite3EndBenignMalloc(); }
  42199. pcache1EnterMutex(p->pGroup);
  42200. if( apNew ){
  42201. for(i=0; i<p->nHash; i++){
  42202. PgHdr1 *pPage;
  42203. PgHdr1 *pNext = p->apHash[i];
  42204. while( (pPage = pNext)!=0 ){
  42205. unsigned int h = pPage->iKey % nNew;
  42206. pNext = pPage->pNext;
  42207. pPage->pNext = apNew[h];
  42208. apNew[h] = pPage;
  42209. }
  42210. }
  42211. sqlite3_free(p->apHash);
  42212. p->apHash = apNew;
  42213. p->nHash = nNew;
  42214. }
  42215. }
  42216. /*
  42217. ** This function is used internally to remove the page pPage from the
  42218. ** PGroup LRU list, if is part of it. If pPage is not part of the PGroup
  42219. ** LRU list, then this function is a no-op.
  42220. **
  42221. ** The PGroup mutex must be held when this function is called.
  42222. */
  42223. static PgHdr1 *pcache1PinPage(PgHdr1 *pPage){
  42224. PCache1 *pCache;
  42225. assert( pPage!=0 );
  42226. assert( pPage->isPinned==0 );
  42227. pCache = pPage->pCache;
  42228. assert( pPage->pLruNext );
  42229. assert( pPage->pLruPrev );
  42230. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  42231. pPage->pLruPrev->pLruNext = pPage->pLruNext;
  42232. pPage->pLruNext->pLruPrev = pPage->pLruPrev;
  42233. pPage->pLruNext = 0;
  42234. pPage->pLruPrev = 0;
  42235. pPage->isPinned = 1;
  42236. assert( pPage->isAnchor==0 );
  42237. assert( pCache->pGroup->lru.isAnchor==1 );
  42238. pCache->nRecyclable--;
  42239. return pPage;
  42240. }
  42241. /*
  42242. ** Remove the page supplied as an argument from the hash table
  42243. ** (PCache1.apHash structure) that it is currently stored in.
  42244. ** Also free the page if freePage is true.
  42245. **
  42246. ** The PGroup mutex must be held when this function is called.
  42247. */
  42248. static void pcache1RemoveFromHash(PgHdr1 *pPage, int freeFlag){
  42249. unsigned int h;
  42250. PCache1 *pCache = pPage->pCache;
  42251. PgHdr1 **pp;
  42252. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  42253. h = pPage->iKey % pCache->nHash;
  42254. for(pp=&pCache->apHash[h]; (*pp)!=pPage; pp=&(*pp)->pNext);
  42255. *pp = (*pp)->pNext;
  42256. pCache->nPage--;
  42257. if( freeFlag ) pcache1FreePage(pPage);
  42258. }
  42259. /*
  42260. ** If there are currently more than nMaxPage pages allocated, try
  42261. ** to recycle pages to reduce the number allocated to nMaxPage.
  42262. */
  42263. static void pcache1EnforceMaxPage(PCache1 *pCache){
  42264. PGroup *pGroup = pCache->pGroup;
  42265. PgHdr1 *p;
  42266. assert( sqlite3_mutex_held(pGroup->mutex) );
  42267. while( pGroup->nCurrentPage>pGroup->nMaxPage
  42268. && (p=pGroup->lru.pLruPrev)->isAnchor==0
  42269. ){
  42270. assert( p->pCache->pGroup==pGroup );
  42271. assert( p->isPinned==0 );
  42272. pcache1PinPage(p);
  42273. pcache1RemoveFromHash(p, 1);
  42274. }
  42275. if( pCache->nPage==0 && pCache->pBulk ){
  42276. sqlite3_free(pCache->pBulk);
  42277. pCache->pBulk = pCache->pFree = 0;
  42278. }
  42279. }
  42280. /*
  42281. ** Discard all pages from cache pCache with a page number (key value)
  42282. ** greater than or equal to iLimit. Any pinned pages that meet this
  42283. ** criteria are unpinned before they are discarded.
  42284. **
  42285. ** The PCache mutex must be held when this function is called.
  42286. */
  42287. static void pcache1TruncateUnsafe(
  42288. PCache1 *pCache, /* The cache to truncate */
  42289. unsigned int iLimit /* Drop pages with this pgno or larger */
  42290. ){
  42291. TESTONLY( int nPage = 0; ) /* To assert pCache->nPage is correct */
  42292. unsigned int h, iStop;
  42293. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  42294. assert( pCache->iMaxKey >= iLimit );
  42295. assert( pCache->nHash > 0 );
  42296. if( pCache->iMaxKey - iLimit < pCache->nHash ){
  42297. /* If we are just shaving the last few pages off the end of the
  42298. ** cache, then there is no point in scanning the entire hash table.
  42299. ** Only scan those hash slots that might contain pages that need to
  42300. ** be removed. */
  42301. h = iLimit % pCache->nHash;
  42302. iStop = pCache->iMaxKey % pCache->nHash;
  42303. TESTONLY( nPage = -10; ) /* Disable the pCache->nPage validity check */
  42304. }else{
  42305. /* This is the general case where many pages are being removed.
  42306. ** It is necessary to scan the entire hash table */
  42307. h = pCache->nHash/2;
  42308. iStop = h - 1;
  42309. }
  42310. for(;;){
  42311. PgHdr1 **pp;
  42312. PgHdr1 *pPage;
  42313. assert( h<pCache->nHash );
  42314. pp = &pCache->apHash[h];
  42315. while( (pPage = *pp)!=0 ){
  42316. if( pPage->iKey>=iLimit ){
  42317. pCache->nPage--;
  42318. *pp = pPage->pNext;
  42319. if( !pPage->isPinned ) pcache1PinPage(pPage);
  42320. pcache1FreePage(pPage);
  42321. }else{
  42322. pp = &pPage->pNext;
  42323. TESTONLY( if( nPage>=0 ) nPage++; )
  42324. }
  42325. }
  42326. if( h==iStop ) break;
  42327. h = (h+1) % pCache->nHash;
  42328. }
  42329. assert( nPage<0 || pCache->nPage==(unsigned)nPage );
  42330. }
  42331. /******************************************************************************/
  42332. /******** sqlite3_pcache Methods **********************************************/
  42333. /*
  42334. ** Implementation of the sqlite3_pcache.xInit method.
  42335. */
  42336. static int pcache1Init(void *NotUsed){
  42337. UNUSED_PARAMETER(NotUsed);
  42338. assert( pcache1.isInit==0 );
  42339. memset(&pcache1, 0, sizeof(pcache1));
  42340. /*
  42341. ** The pcache1.separateCache variable is true if each PCache has its own
  42342. ** private PGroup (mode-1). pcache1.separateCache is false if the single
  42343. ** PGroup in pcache1.grp is used for all page caches (mode-2).
  42344. **
  42345. ** * Always use a unified cache (mode-2) if ENABLE_MEMORY_MANAGEMENT
  42346. **
  42347. ** * Use a unified cache in single-threaded applications that have
  42348. ** configured a start-time buffer for use as page-cache memory using
  42349. ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, pBuf, sz, N) with non-NULL
  42350. ** pBuf argument.
  42351. **
  42352. ** * Otherwise use separate caches (mode-1)
  42353. */
  42354. #if defined(SQLITE_ENABLE_MEMORY_MANAGEMENT)
  42355. pcache1.separateCache = 0;
  42356. #elif SQLITE_THREADSAFE
  42357. pcache1.separateCache = sqlite3GlobalConfig.pPage==0
  42358. || sqlite3GlobalConfig.bCoreMutex>0;
  42359. #else
  42360. pcache1.separateCache = sqlite3GlobalConfig.pPage==0;
  42361. #endif
  42362. #if SQLITE_THREADSAFE
  42363. if( sqlite3GlobalConfig.bCoreMutex ){
  42364. pcache1.grp.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_LRU);
  42365. pcache1.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_PMEM);
  42366. }
  42367. #endif
  42368. if( pcache1.separateCache
  42369. && sqlite3GlobalConfig.nPage!=0
  42370. && sqlite3GlobalConfig.pPage==0
  42371. ){
  42372. pcache1.nInitPage = sqlite3GlobalConfig.nPage;
  42373. }else{
  42374. pcache1.nInitPage = 0;
  42375. }
  42376. pcache1.grp.mxPinned = 10;
  42377. pcache1.isInit = 1;
  42378. return SQLITE_OK;
  42379. }
  42380. /*
  42381. ** Implementation of the sqlite3_pcache.xShutdown method.
  42382. ** Note that the static mutex allocated in xInit does
  42383. ** not need to be freed.
  42384. */
  42385. static void pcache1Shutdown(void *NotUsed){
  42386. UNUSED_PARAMETER(NotUsed);
  42387. assert( pcache1.isInit!=0 );
  42388. memset(&pcache1, 0, sizeof(pcache1));
  42389. }
  42390. /* forward declaration */
  42391. static void pcache1Destroy(sqlite3_pcache *p);
  42392. /*
  42393. ** Implementation of the sqlite3_pcache.xCreate method.
  42394. **
  42395. ** Allocate a new cache.
  42396. */
  42397. static sqlite3_pcache *pcache1Create(int szPage, int szExtra, int bPurgeable){
  42398. PCache1 *pCache; /* The newly created page cache */
  42399. PGroup *pGroup; /* The group the new page cache will belong to */
  42400. int sz; /* Bytes of memory required to allocate the new cache */
  42401. assert( (szPage & (szPage-1))==0 && szPage>=512 && szPage<=65536 );
  42402. assert( szExtra < 300 );
  42403. sz = sizeof(PCache1) + sizeof(PGroup)*pcache1.separateCache;
  42404. pCache = (PCache1 *)sqlite3MallocZero(sz);
  42405. if( pCache ){
  42406. if( pcache1.separateCache ){
  42407. pGroup = (PGroup*)&pCache[1];
  42408. pGroup->mxPinned = 10;
  42409. }else{
  42410. pGroup = &pcache1.grp;
  42411. }
  42412. if( pGroup->lru.isAnchor==0 ){
  42413. pGroup->lru.isAnchor = 1;
  42414. pGroup->lru.pLruPrev = pGroup->lru.pLruNext = &pGroup->lru;
  42415. }
  42416. pCache->pGroup = pGroup;
  42417. pCache->szPage = szPage;
  42418. pCache->szExtra = szExtra;
  42419. pCache->szAlloc = szPage + szExtra + ROUND8(sizeof(PgHdr1));
  42420. pCache->bPurgeable = (bPurgeable ? 1 : 0);
  42421. pcache1EnterMutex(pGroup);
  42422. pcache1ResizeHash(pCache);
  42423. if( bPurgeable ){
  42424. pCache->nMin = 10;
  42425. pGroup->nMinPage += pCache->nMin;
  42426. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  42427. }
  42428. pcache1LeaveMutex(pGroup);
  42429. if( pCache->nHash==0 ){
  42430. pcache1Destroy((sqlite3_pcache*)pCache);
  42431. pCache = 0;
  42432. }
  42433. }
  42434. return (sqlite3_pcache *)pCache;
  42435. }
  42436. /*
  42437. ** Implementation of the sqlite3_pcache.xCachesize method.
  42438. **
  42439. ** Configure the cache_size limit for a cache.
  42440. */
  42441. static void pcache1Cachesize(sqlite3_pcache *p, int nMax){
  42442. PCache1 *pCache = (PCache1 *)p;
  42443. if( pCache->bPurgeable ){
  42444. PGroup *pGroup = pCache->pGroup;
  42445. pcache1EnterMutex(pGroup);
  42446. pGroup->nMaxPage += (nMax - pCache->nMax);
  42447. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  42448. pCache->nMax = nMax;
  42449. pCache->n90pct = pCache->nMax*9/10;
  42450. pcache1EnforceMaxPage(pCache);
  42451. pcache1LeaveMutex(pGroup);
  42452. }
  42453. }
  42454. /*
  42455. ** Implementation of the sqlite3_pcache.xShrink method.
  42456. **
  42457. ** Free up as much memory as possible.
  42458. */
  42459. static void pcache1Shrink(sqlite3_pcache *p){
  42460. PCache1 *pCache = (PCache1*)p;
  42461. if( pCache->bPurgeable ){
  42462. PGroup *pGroup = pCache->pGroup;
  42463. int savedMaxPage;
  42464. pcache1EnterMutex(pGroup);
  42465. savedMaxPage = pGroup->nMaxPage;
  42466. pGroup->nMaxPage = 0;
  42467. pcache1EnforceMaxPage(pCache);
  42468. pGroup->nMaxPage = savedMaxPage;
  42469. pcache1LeaveMutex(pGroup);
  42470. }
  42471. }
  42472. /*
  42473. ** Implementation of the sqlite3_pcache.xPagecount method.
  42474. */
  42475. static int pcache1Pagecount(sqlite3_pcache *p){
  42476. int n;
  42477. PCache1 *pCache = (PCache1*)p;
  42478. pcache1EnterMutex(pCache->pGroup);
  42479. n = pCache->nPage;
  42480. pcache1LeaveMutex(pCache->pGroup);
  42481. return n;
  42482. }
  42483. /*
  42484. ** Implement steps 3, 4, and 5 of the pcache1Fetch() algorithm described
  42485. ** in the header of the pcache1Fetch() procedure.
  42486. **
  42487. ** This steps are broken out into a separate procedure because they are
  42488. ** usually not needed, and by avoiding the stack initialization required
  42489. ** for these steps, the main pcache1Fetch() procedure can run faster.
  42490. */
  42491. static SQLITE_NOINLINE PgHdr1 *pcache1FetchStage2(
  42492. PCache1 *pCache,
  42493. unsigned int iKey,
  42494. int createFlag
  42495. ){
  42496. unsigned int nPinned;
  42497. PGroup *pGroup = pCache->pGroup;
  42498. PgHdr1 *pPage = 0;
  42499. /* Step 3: Abort if createFlag is 1 but the cache is nearly full */
  42500. assert( pCache->nPage >= pCache->nRecyclable );
  42501. nPinned = pCache->nPage - pCache->nRecyclable;
  42502. assert( pGroup->mxPinned == pGroup->nMaxPage + 10 - pGroup->nMinPage );
  42503. assert( pCache->n90pct == pCache->nMax*9/10 );
  42504. if( createFlag==1 && (
  42505. nPinned>=pGroup->mxPinned
  42506. || nPinned>=pCache->n90pct
  42507. || (pcache1UnderMemoryPressure(pCache) && pCache->nRecyclable<nPinned)
  42508. )){
  42509. return 0;
  42510. }
  42511. if( pCache->nPage>=pCache->nHash ) pcache1ResizeHash(pCache);
  42512. assert( pCache->nHash>0 && pCache->apHash );
  42513. /* Step 4. Try to recycle a page. */
  42514. if( pCache->bPurgeable
  42515. && !pGroup->lru.pLruPrev->isAnchor
  42516. && ((pCache->nPage+1>=pCache->nMax) || pcache1UnderMemoryPressure(pCache))
  42517. ){
  42518. PCache1 *pOther;
  42519. pPage = pGroup->lru.pLruPrev;
  42520. assert( pPage->isPinned==0 );
  42521. pcache1RemoveFromHash(pPage, 0);
  42522. pcache1PinPage(pPage);
  42523. pOther = pPage->pCache;
  42524. if( pOther->szAlloc != pCache->szAlloc ){
  42525. pcache1FreePage(pPage);
  42526. pPage = 0;
  42527. }else{
  42528. pGroup->nCurrentPage -= (pOther->bPurgeable - pCache->bPurgeable);
  42529. }
  42530. }
  42531. /* Step 5. If a usable page buffer has still not been found,
  42532. ** attempt to allocate a new one.
  42533. */
  42534. if( !pPage ){
  42535. pPage = pcache1AllocPage(pCache, createFlag==1);
  42536. }
  42537. if( pPage ){
  42538. unsigned int h = iKey % pCache->nHash;
  42539. pCache->nPage++;
  42540. pPage->iKey = iKey;
  42541. pPage->pNext = pCache->apHash[h];
  42542. pPage->pCache = pCache;
  42543. pPage->pLruPrev = 0;
  42544. pPage->pLruNext = 0;
  42545. pPage->isPinned = 1;
  42546. *(void **)pPage->page.pExtra = 0;
  42547. pCache->apHash[h] = pPage;
  42548. if( iKey>pCache->iMaxKey ){
  42549. pCache->iMaxKey = iKey;
  42550. }
  42551. }
  42552. return pPage;
  42553. }
  42554. /*
  42555. ** Implementation of the sqlite3_pcache.xFetch method.
  42556. **
  42557. ** Fetch a page by key value.
  42558. **
  42559. ** Whether or not a new page may be allocated by this function depends on
  42560. ** the value of the createFlag argument. 0 means do not allocate a new
  42561. ** page. 1 means allocate a new page if space is easily available. 2
  42562. ** means to try really hard to allocate a new page.
  42563. **
  42564. ** For a non-purgeable cache (a cache used as the storage for an in-memory
  42565. ** database) there is really no difference between createFlag 1 and 2. So
  42566. ** the calling function (pcache.c) will never have a createFlag of 1 on
  42567. ** a non-purgeable cache.
  42568. **
  42569. ** There are three different approaches to obtaining space for a page,
  42570. ** depending on the value of parameter createFlag (which may be 0, 1 or 2).
  42571. **
  42572. ** 1. Regardless of the value of createFlag, the cache is searched for a
  42573. ** copy of the requested page. If one is found, it is returned.
  42574. **
  42575. ** 2. If createFlag==0 and the page is not already in the cache, NULL is
  42576. ** returned.
  42577. **
  42578. ** 3. If createFlag is 1, and the page is not already in the cache, then
  42579. ** return NULL (do not allocate a new page) if any of the following
  42580. ** conditions are true:
  42581. **
  42582. ** (a) the number of pages pinned by the cache is greater than
  42583. ** PCache1.nMax, or
  42584. **
  42585. ** (b) the number of pages pinned by the cache is greater than
  42586. ** the sum of nMax for all purgeable caches, less the sum of
  42587. ** nMin for all other purgeable caches, or
  42588. **
  42589. ** 4. If none of the first three conditions apply and the cache is marked
  42590. ** as purgeable, and if one of the following is true:
  42591. **
  42592. ** (a) The number of pages allocated for the cache is already
  42593. ** PCache1.nMax, or
  42594. **
  42595. ** (b) The number of pages allocated for all purgeable caches is
  42596. ** already equal to or greater than the sum of nMax for all
  42597. ** purgeable caches,
  42598. **
  42599. ** (c) The system is under memory pressure and wants to avoid
  42600. ** unnecessary pages cache entry allocations
  42601. **
  42602. ** then attempt to recycle a page from the LRU list. If it is the right
  42603. ** size, return the recycled buffer. Otherwise, free the buffer and
  42604. ** proceed to step 5.
  42605. **
  42606. ** 5. Otherwise, allocate and return a new page buffer.
  42607. **
  42608. ** There are two versions of this routine. pcache1FetchWithMutex() is
  42609. ** the general case. pcache1FetchNoMutex() is a faster implementation for
  42610. ** the common case where pGroup->mutex is NULL. The pcache1Fetch() wrapper
  42611. ** invokes the appropriate routine.
  42612. */
  42613. static PgHdr1 *pcache1FetchNoMutex(
  42614. sqlite3_pcache *p,
  42615. unsigned int iKey,
  42616. int createFlag
  42617. ){
  42618. PCache1 *pCache = (PCache1 *)p;
  42619. PgHdr1 *pPage = 0;
  42620. /* Step 1: Search the hash table for an existing entry. */
  42621. pPage = pCache->apHash[iKey % pCache->nHash];
  42622. while( pPage && pPage->iKey!=iKey ){ pPage = pPage->pNext; }
  42623. /* Step 2: If the page was found in the hash table, then return it.
  42624. ** If the page was not in the hash table and createFlag is 0, abort.
  42625. ** Otherwise (page not in hash and createFlag!=0) continue with
  42626. ** subsequent steps to try to create the page. */
  42627. if( pPage ){
  42628. if( !pPage->isPinned ){
  42629. return pcache1PinPage(pPage);
  42630. }else{
  42631. return pPage;
  42632. }
  42633. }else if( createFlag ){
  42634. /* Steps 3, 4, and 5 implemented by this subroutine */
  42635. return pcache1FetchStage2(pCache, iKey, createFlag);
  42636. }else{
  42637. return 0;
  42638. }
  42639. }
  42640. #if PCACHE1_MIGHT_USE_GROUP_MUTEX
  42641. static PgHdr1 *pcache1FetchWithMutex(
  42642. sqlite3_pcache *p,
  42643. unsigned int iKey,
  42644. int createFlag
  42645. ){
  42646. PCache1 *pCache = (PCache1 *)p;
  42647. PgHdr1 *pPage;
  42648. pcache1EnterMutex(pCache->pGroup);
  42649. pPage = pcache1FetchNoMutex(p, iKey, createFlag);
  42650. assert( pPage==0 || pCache->iMaxKey>=iKey );
  42651. pcache1LeaveMutex(pCache->pGroup);
  42652. return pPage;
  42653. }
  42654. #endif
  42655. static sqlite3_pcache_page *pcache1Fetch(
  42656. sqlite3_pcache *p,
  42657. unsigned int iKey,
  42658. int createFlag
  42659. ){
  42660. #if PCACHE1_MIGHT_USE_GROUP_MUTEX || defined(SQLITE_DEBUG)
  42661. PCache1 *pCache = (PCache1 *)p;
  42662. #endif
  42663. assert( offsetof(PgHdr1,page)==0 );
  42664. assert( pCache->bPurgeable || createFlag!=1 );
  42665. assert( pCache->bPurgeable || pCache->nMin==0 );
  42666. assert( pCache->bPurgeable==0 || pCache->nMin==10 );
  42667. assert( pCache->nMin==0 || pCache->bPurgeable );
  42668. assert( pCache->nHash>0 );
  42669. #if PCACHE1_MIGHT_USE_GROUP_MUTEX
  42670. if( pCache->pGroup->mutex ){
  42671. return (sqlite3_pcache_page*)pcache1FetchWithMutex(p, iKey, createFlag);
  42672. }else
  42673. #endif
  42674. {
  42675. return (sqlite3_pcache_page*)pcache1FetchNoMutex(p, iKey, createFlag);
  42676. }
  42677. }
  42678. /*
  42679. ** Implementation of the sqlite3_pcache.xUnpin method.
  42680. **
  42681. ** Mark a page as unpinned (eligible for asynchronous recycling).
  42682. */
  42683. static void pcache1Unpin(
  42684. sqlite3_pcache *p,
  42685. sqlite3_pcache_page *pPg,
  42686. int reuseUnlikely
  42687. ){
  42688. PCache1 *pCache = (PCache1 *)p;
  42689. PgHdr1 *pPage = (PgHdr1 *)pPg;
  42690. PGroup *pGroup = pCache->pGroup;
  42691. assert( pPage->pCache==pCache );
  42692. pcache1EnterMutex(pGroup);
  42693. /* It is an error to call this function if the page is already
  42694. ** part of the PGroup LRU list.
  42695. */
  42696. assert( pPage->pLruPrev==0 && pPage->pLruNext==0 );
  42697. assert( pPage->isPinned==1 );
  42698. if( reuseUnlikely || pGroup->nCurrentPage>pGroup->nMaxPage ){
  42699. pcache1RemoveFromHash(pPage, 1);
  42700. }else{
  42701. /* Add the page to the PGroup LRU list. */
  42702. PgHdr1 **ppFirst = &pGroup->lru.pLruNext;
  42703. pPage->pLruPrev = &pGroup->lru;
  42704. (pPage->pLruNext = *ppFirst)->pLruPrev = pPage;
  42705. *ppFirst = pPage;
  42706. pCache->nRecyclable++;
  42707. pPage->isPinned = 0;
  42708. }
  42709. pcache1LeaveMutex(pCache->pGroup);
  42710. }
  42711. /*
  42712. ** Implementation of the sqlite3_pcache.xRekey method.
  42713. */
  42714. static void pcache1Rekey(
  42715. sqlite3_pcache *p,
  42716. sqlite3_pcache_page *pPg,
  42717. unsigned int iOld,
  42718. unsigned int iNew
  42719. ){
  42720. PCache1 *pCache = (PCache1 *)p;
  42721. PgHdr1 *pPage = (PgHdr1 *)pPg;
  42722. PgHdr1 **pp;
  42723. unsigned int h;
  42724. assert( pPage->iKey==iOld );
  42725. assert( pPage->pCache==pCache );
  42726. pcache1EnterMutex(pCache->pGroup);
  42727. h = iOld%pCache->nHash;
  42728. pp = &pCache->apHash[h];
  42729. while( (*pp)!=pPage ){
  42730. pp = &(*pp)->pNext;
  42731. }
  42732. *pp = pPage->pNext;
  42733. h = iNew%pCache->nHash;
  42734. pPage->iKey = iNew;
  42735. pPage->pNext = pCache->apHash[h];
  42736. pCache->apHash[h] = pPage;
  42737. if( iNew>pCache->iMaxKey ){
  42738. pCache->iMaxKey = iNew;
  42739. }
  42740. pcache1LeaveMutex(pCache->pGroup);
  42741. }
  42742. /*
  42743. ** Implementation of the sqlite3_pcache.xTruncate method.
  42744. **
  42745. ** Discard all unpinned pages in the cache with a page number equal to
  42746. ** or greater than parameter iLimit. Any pinned pages with a page number
  42747. ** equal to or greater than iLimit are implicitly unpinned.
  42748. */
  42749. static void pcache1Truncate(sqlite3_pcache *p, unsigned int iLimit){
  42750. PCache1 *pCache = (PCache1 *)p;
  42751. pcache1EnterMutex(pCache->pGroup);
  42752. if( iLimit<=pCache->iMaxKey ){
  42753. pcache1TruncateUnsafe(pCache, iLimit);
  42754. pCache->iMaxKey = iLimit-1;
  42755. }
  42756. pcache1LeaveMutex(pCache->pGroup);
  42757. }
  42758. /*
  42759. ** Implementation of the sqlite3_pcache.xDestroy method.
  42760. **
  42761. ** Destroy a cache allocated using pcache1Create().
  42762. */
  42763. static void pcache1Destroy(sqlite3_pcache *p){
  42764. PCache1 *pCache = (PCache1 *)p;
  42765. PGroup *pGroup = pCache->pGroup;
  42766. assert( pCache->bPurgeable || (pCache->nMax==0 && pCache->nMin==0) );
  42767. pcache1EnterMutex(pGroup);
  42768. if( pCache->nPage ) pcache1TruncateUnsafe(pCache, 0);
  42769. assert( pGroup->nMaxPage >= pCache->nMax );
  42770. pGroup->nMaxPage -= pCache->nMax;
  42771. assert( pGroup->nMinPage >= pCache->nMin );
  42772. pGroup->nMinPage -= pCache->nMin;
  42773. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  42774. pcache1EnforceMaxPage(pCache);
  42775. pcache1LeaveMutex(pGroup);
  42776. sqlite3_free(pCache->pBulk);
  42777. sqlite3_free(pCache->apHash);
  42778. sqlite3_free(pCache);
  42779. }
  42780. /*
  42781. ** This function is called during initialization (sqlite3_initialize()) to
  42782. ** install the default pluggable cache module, assuming the user has not
  42783. ** already provided an alternative.
  42784. */
  42785. SQLITE_PRIVATE void sqlite3PCacheSetDefault(void){
  42786. static const sqlite3_pcache_methods2 defaultMethods = {
  42787. 1, /* iVersion */
  42788. 0, /* pArg */
  42789. pcache1Init, /* xInit */
  42790. pcache1Shutdown, /* xShutdown */
  42791. pcache1Create, /* xCreate */
  42792. pcache1Cachesize, /* xCachesize */
  42793. pcache1Pagecount, /* xPagecount */
  42794. pcache1Fetch, /* xFetch */
  42795. pcache1Unpin, /* xUnpin */
  42796. pcache1Rekey, /* xRekey */
  42797. pcache1Truncate, /* xTruncate */
  42798. pcache1Destroy, /* xDestroy */
  42799. pcache1Shrink /* xShrink */
  42800. };
  42801. sqlite3_config(SQLITE_CONFIG_PCACHE2, &defaultMethods);
  42802. }
  42803. /*
  42804. ** Return the size of the header on each page of this PCACHE implementation.
  42805. */
  42806. SQLITE_PRIVATE int sqlite3HeaderSizePcache1(void){ return ROUND8(sizeof(PgHdr1)); }
  42807. /*
  42808. ** Return the global mutex used by this PCACHE implementation. The
  42809. ** sqlite3_status() routine needs access to this mutex.
  42810. */
  42811. SQLITE_PRIVATE sqlite3_mutex *sqlite3Pcache1Mutex(void){
  42812. return pcache1.mutex;
  42813. }
  42814. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  42815. /*
  42816. ** This function is called to free superfluous dynamically allocated memory
  42817. ** held by the pager system. Memory in use by any SQLite pager allocated
  42818. ** by the current thread may be sqlite3_free()ed.
  42819. **
  42820. ** nReq is the number of bytes of memory required. Once this much has
  42821. ** been released, the function returns. The return value is the total number
  42822. ** of bytes of memory released.
  42823. */
  42824. SQLITE_PRIVATE int sqlite3PcacheReleaseMemory(int nReq){
  42825. int nFree = 0;
  42826. assert( sqlite3_mutex_notheld(pcache1.grp.mutex) );
  42827. assert( sqlite3_mutex_notheld(pcache1.mutex) );
  42828. if( sqlite3GlobalConfig.nPage==0 ){
  42829. PgHdr1 *p;
  42830. pcache1EnterMutex(&pcache1.grp);
  42831. while( (nReq<0 || nFree<nReq)
  42832. && (p=pcache1.grp.lru.pLruPrev)!=0
  42833. && p->isAnchor==0
  42834. ){
  42835. nFree += pcache1MemSize(p->page.pBuf);
  42836. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  42837. nFree += sqlite3MemSize(p);
  42838. #endif
  42839. assert( p->isPinned==0 );
  42840. pcache1PinPage(p);
  42841. pcache1RemoveFromHash(p, 1);
  42842. }
  42843. pcache1LeaveMutex(&pcache1.grp);
  42844. }
  42845. return nFree;
  42846. }
  42847. #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
  42848. #ifdef SQLITE_TEST
  42849. /*
  42850. ** This function is used by test procedures to inspect the internal state
  42851. ** of the global cache.
  42852. */
  42853. SQLITE_PRIVATE void sqlite3PcacheStats(
  42854. int *pnCurrent, /* OUT: Total number of pages cached */
  42855. int *pnMax, /* OUT: Global maximum cache size */
  42856. int *pnMin, /* OUT: Sum of PCache1.nMin for purgeable caches */
  42857. int *pnRecyclable /* OUT: Total number of pages available for recycling */
  42858. ){
  42859. PgHdr1 *p;
  42860. int nRecyclable = 0;
  42861. for(p=pcache1.grp.lru.pLruNext; p && !p->isAnchor; p=p->pLruNext){
  42862. assert( p->isPinned==0 );
  42863. nRecyclable++;
  42864. }
  42865. *pnCurrent = pcache1.grp.nCurrentPage;
  42866. *pnMax = (int)pcache1.grp.nMaxPage;
  42867. *pnMin = (int)pcache1.grp.nMinPage;
  42868. *pnRecyclable = nRecyclable;
  42869. }
  42870. #endif
  42871. /************** End of pcache1.c *********************************************/
  42872. /************** Begin file rowset.c ******************************************/
  42873. /*
  42874. ** 2008 December 3
  42875. **
  42876. ** The author disclaims copyright to this source code. In place of
  42877. ** a legal notice, here is a blessing:
  42878. **
  42879. ** May you do good and not evil.
  42880. ** May you find forgiveness for yourself and forgive others.
  42881. ** May you share freely, never taking more than you give.
  42882. **
  42883. *************************************************************************
  42884. **
  42885. ** This module implements an object we call a "RowSet".
  42886. **
  42887. ** The RowSet object is a collection of rowids. Rowids
  42888. ** are inserted into the RowSet in an arbitrary order. Inserts
  42889. ** can be intermixed with tests to see if a given rowid has been
  42890. ** previously inserted into the RowSet.
  42891. **
  42892. ** After all inserts are finished, it is possible to extract the
  42893. ** elements of the RowSet in sorted order. Once this extraction
  42894. ** process has started, no new elements may be inserted.
  42895. **
  42896. ** Hence, the primitive operations for a RowSet are:
  42897. **
  42898. ** CREATE
  42899. ** INSERT
  42900. ** TEST
  42901. ** SMALLEST
  42902. ** DESTROY
  42903. **
  42904. ** The CREATE and DESTROY primitives are the constructor and destructor,
  42905. ** obviously. The INSERT primitive adds a new element to the RowSet.
  42906. ** TEST checks to see if an element is already in the RowSet. SMALLEST
  42907. ** extracts the least value from the RowSet.
  42908. **
  42909. ** The INSERT primitive might allocate additional memory. Memory is
  42910. ** allocated in chunks so most INSERTs do no allocation. There is an
  42911. ** upper bound on the size of allocated memory. No memory is freed
  42912. ** until DESTROY.
  42913. **
  42914. ** The TEST primitive includes a "batch" number. The TEST primitive
  42915. ** will only see elements that were inserted before the last change
  42916. ** in the batch number. In other words, if an INSERT occurs between
  42917. ** two TESTs where the TESTs have the same batch nubmer, then the
  42918. ** value added by the INSERT will not be visible to the second TEST.
  42919. ** The initial batch number is zero, so if the very first TEST contains
  42920. ** a non-zero batch number, it will see all prior INSERTs.
  42921. **
  42922. ** No INSERTs may occurs after a SMALLEST. An assertion will fail if
  42923. ** that is attempted.
  42924. **
  42925. ** The cost of an INSERT is roughly constant. (Sometimes new memory
  42926. ** has to be allocated on an INSERT.) The cost of a TEST with a new
  42927. ** batch number is O(NlogN) where N is the number of elements in the RowSet.
  42928. ** The cost of a TEST using the same batch number is O(logN). The cost
  42929. ** of the first SMALLEST is O(NlogN). Second and subsequent SMALLEST
  42930. ** primitives are constant time. The cost of DESTROY is O(N).
  42931. **
  42932. ** TEST and SMALLEST may not be used by the same RowSet. This used to
  42933. ** be possible, but the feature was not used, so it was removed in order
  42934. ** to simplify the code.
  42935. */
  42936. /* #include "sqliteInt.h" */
  42937. /*
  42938. ** Target size for allocation chunks.
  42939. */
  42940. #define ROWSET_ALLOCATION_SIZE 1024
  42941. /*
  42942. ** The number of rowset entries per allocation chunk.
  42943. */
  42944. #define ROWSET_ENTRY_PER_CHUNK \
  42945. ((ROWSET_ALLOCATION_SIZE-8)/sizeof(struct RowSetEntry))
  42946. /*
  42947. ** Each entry in a RowSet is an instance of the following object.
  42948. **
  42949. ** This same object is reused to store a linked list of trees of RowSetEntry
  42950. ** objects. In that alternative use, pRight points to the next entry
  42951. ** in the list, pLeft points to the tree, and v is unused. The
  42952. ** RowSet.pForest value points to the head of this forest list.
  42953. */
  42954. struct RowSetEntry {
  42955. i64 v; /* ROWID value for this entry */
  42956. struct RowSetEntry *pRight; /* Right subtree (larger entries) or list */
  42957. struct RowSetEntry *pLeft; /* Left subtree (smaller entries) */
  42958. };
  42959. /*
  42960. ** RowSetEntry objects are allocated in large chunks (instances of the
  42961. ** following structure) to reduce memory allocation overhead. The
  42962. ** chunks are kept on a linked list so that they can be deallocated
  42963. ** when the RowSet is destroyed.
  42964. */
  42965. struct RowSetChunk {
  42966. struct RowSetChunk *pNextChunk; /* Next chunk on list of them all */
  42967. struct RowSetEntry aEntry[ROWSET_ENTRY_PER_CHUNK]; /* Allocated entries */
  42968. };
  42969. /*
  42970. ** A RowSet in an instance of the following structure.
  42971. **
  42972. ** A typedef of this structure if found in sqliteInt.h.
  42973. */
  42974. struct RowSet {
  42975. struct RowSetChunk *pChunk; /* List of all chunk allocations */
  42976. sqlite3 *db; /* The database connection */
  42977. struct RowSetEntry *pEntry; /* List of entries using pRight */
  42978. struct RowSetEntry *pLast; /* Last entry on the pEntry list */
  42979. struct RowSetEntry *pFresh; /* Source of new entry objects */
  42980. struct RowSetEntry *pForest; /* List of binary trees of entries */
  42981. u16 nFresh; /* Number of objects on pFresh */
  42982. u16 rsFlags; /* Various flags */
  42983. int iBatch; /* Current insert batch */
  42984. };
  42985. /*
  42986. ** Allowed values for RowSet.rsFlags
  42987. */
  42988. #define ROWSET_SORTED 0x01 /* True if RowSet.pEntry is sorted */
  42989. #define ROWSET_NEXT 0x02 /* True if sqlite3RowSetNext() has been called */
  42990. /*
  42991. ** Turn bulk memory into a RowSet object. N bytes of memory
  42992. ** are available at pSpace. The db pointer is used as a memory context
  42993. ** for any subsequent allocations that need to occur.
  42994. ** Return a pointer to the new RowSet object.
  42995. **
  42996. ** It must be the case that N is sufficient to make a Rowset. If not
  42997. ** an assertion fault occurs.
  42998. **
  42999. ** If N is larger than the minimum, use the surplus as an initial
  43000. ** allocation of entries available to be filled.
  43001. */
  43002. SQLITE_PRIVATE RowSet *sqlite3RowSetInit(sqlite3 *db, void *pSpace, unsigned int N){
  43003. RowSet *p;
  43004. assert( N >= ROUND8(sizeof(*p)) );
  43005. p = pSpace;
  43006. p->pChunk = 0;
  43007. p->db = db;
  43008. p->pEntry = 0;
  43009. p->pLast = 0;
  43010. p->pForest = 0;
  43011. p->pFresh = (struct RowSetEntry*)(ROUND8(sizeof(*p)) + (char*)p);
  43012. p->nFresh = (u16)((N - ROUND8(sizeof(*p)))/sizeof(struct RowSetEntry));
  43013. p->rsFlags = ROWSET_SORTED;
  43014. p->iBatch = 0;
  43015. return p;
  43016. }
  43017. /*
  43018. ** Deallocate all chunks from a RowSet. This frees all memory that
  43019. ** the RowSet has allocated over its lifetime. This routine is
  43020. ** the destructor for the RowSet.
  43021. */
  43022. SQLITE_PRIVATE void sqlite3RowSetClear(RowSet *p){
  43023. struct RowSetChunk *pChunk, *pNextChunk;
  43024. for(pChunk=p->pChunk; pChunk; pChunk = pNextChunk){
  43025. pNextChunk = pChunk->pNextChunk;
  43026. sqlite3DbFree(p->db, pChunk);
  43027. }
  43028. p->pChunk = 0;
  43029. p->nFresh = 0;
  43030. p->pEntry = 0;
  43031. p->pLast = 0;
  43032. p->pForest = 0;
  43033. p->rsFlags = ROWSET_SORTED;
  43034. }
  43035. /*
  43036. ** Allocate a new RowSetEntry object that is associated with the
  43037. ** given RowSet. Return a pointer to the new and completely uninitialized
  43038. ** objected.
  43039. **
  43040. ** In an OOM situation, the RowSet.db->mallocFailed flag is set and this
  43041. ** routine returns NULL.
  43042. */
  43043. static struct RowSetEntry *rowSetEntryAlloc(RowSet *p){
  43044. assert( p!=0 );
  43045. if( p->nFresh==0 ){ /*OPTIMIZATION-IF-FALSE*/
  43046. /* We could allocate a fresh RowSetEntry each time one is needed, but it
  43047. ** is more efficient to pull a preallocated entry from the pool */
  43048. struct RowSetChunk *pNew;
  43049. pNew = sqlite3DbMallocRawNN(p->db, sizeof(*pNew));
  43050. if( pNew==0 ){
  43051. return 0;
  43052. }
  43053. pNew->pNextChunk = p->pChunk;
  43054. p->pChunk = pNew;
  43055. p->pFresh = pNew->aEntry;
  43056. p->nFresh = ROWSET_ENTRY_PER_CHUNK;
  43057. }
  43058. p->nFresh--;
  43059. return p->pFresh++;
  43060. }
  43061. /*
  43062. ** Insert a new value into a RowSet.
  43063. **
  43064. ** The mallocFailed flag of the database connection is set if a
  43065. ** memory allocation fails.
  43066. */
  43067. SQLITE_PRIVATE void sqlite3RowSetInsert(RowSet *p, i64 rowid){
  43068. struct RowSetEntry *pEntry; /* The new entry */
  43069. struct RowSetEntry *pLast; /* The last prior entry */
  43070. /* This routine is never called after sqlite3RowSetNext() */
  43071. assert( p!=0 && (p->rsFlags & ROWSET_NEXT)==0 );
  43072. pEntry = rowSetEntryAlloc(p);
  43073. if( pEntry==0 ) return;
  43074. pEntry->v = rowid;
  43075. pEntry->pRight = 0;
  43076. pLast = p->pLast;
  43077. if( pLast ){
  43078. if( rowid<=pLast->v ){ /*OPTIMIZATION-IF-FALSE*/
  43079. /* Avoid unnecessary sorts by preserving the ROWSET_SORTED flags
  43080. ** where possible */
  43081. p->rsFlags &= ~ROWSET_SORTED;
  43082. }
  43083. pLast->pRight = pEntry;
  43084. }else{
  43085. p->pEntry = pEntry;
  43086. }
  43087. p->pLast = pEntry;
  43088. }
  43089. /*
  43090. ** Merge two lists of RowSetEntry objects. Remove duplicates.
  43091. **
  43092. ** The input lists are connected via pRight pointers and are
  43093. ** assumed to each already be in sorted order.
  43094. */
  43095. static struct RowSetEntry *rowSetEntryMerge(
  43096. struct RowSetEntry *pA, /* First sorted list to be merged */
  43097. struct RowSetEntry *pB /* Second sorted list to be merged */
  43098. ){
  43099. struct RowSetEntry head;
  43100. struct RowSetEntry *pTail;
  43101. pTail = &head;
  43102. assert( pA!=0 && pB!=0 );
  43103. for(;;){
  43104. assert( pA->pRight==0 || pA->v<=pA->pRight->v );
  43105. assert( pB->pRight==0 || pB->v<=pB->pRight->v );
  43106. if( pA->v<=pB->v ){
  43107. if( pA->v<pB->v ) pTail = pTail->pRight = pA;
  43108. pA = pA->pRight;
  43109. if( pA==0 ){
  43110. pTail->pRight = pB;
  43111. break;
  43112. }
  43113. }else{
  43114. pTail = pTail->pRight = pB;
  43115. pB = pB->pRight;
  43116. if( pB==0 ){
  43117. pTail->pRight = pA;
  43118. break;
  43119. }
  43120. }
  43121. }
  43122. return head.pRight;
  43123. }
  43124. /*
  43125. ** Sort all elements on the list of RowSetEntry objects into order of
  43126. ** increasing v.
  43127. */
  43128. static struct RowSetEntry *rowSetEntrySort(struct RowSetEntry *pIn){
  43129. unsigned int i;
  43130. struct RowSetEntry *pNext, *aBucket[40];
  43131. memset(aBucket, 0, sizeof(aBucket));
  43132. while( pIn ){
  43133. pNext = pIn->pRight;
  43134. pIn->pRight = 0;
  43135. for(i=0; aBucket[i]; i++){
  43136. pIn = rowSetEntryMerge(aBucket[i], pIn);
  43137. aBucket[i] = 0;
  43138. }
  43139. aBucket[i] = pIn;
  43140. pIn = pNext;
  43141. }
  43142. pIn = aBucket[0];
  43143. for(i=1; i<sizeof(aBucket)/sizeof(aBucket[0]); i++){
  43144. if( aBucket[i]==0 ) continue;
  43145. pIn = pIn ? rowSetEntryMerge(pIn, aBucket[i]) : aBucket[i];
  43146. }
  43147. return pIn;
  43148. }
  43149. /*
  43150. ** The input, pIn, is a binary tree (or subtree) of RowSetEntry objects.
  43151. ** Convert this tree into a linked list connected by the pRight pointers
  43152. ** and return pointers to the first and last elements of the new list.
  43153. */
  43154. static void rowSetTreeToList(
  43155. struct RowSetEntry *pIn, /* Root of the input tree */
  43156. struct RowSetEntry **ppFirst, /* Write head of the output list here */
  43157. struct RowSetEntry **ppLast /* Write tail of the output list here */
  43158. ){
  43159. assert( pIn!=0 );
  43160. if( pIn->pLeft ){
  43161. struct RowSetEntry *p;
  43162. rowSetTreeToList(pIn->pLeft, ppFirst, &p);
  43163. p->pRight = pIn;
  43164. }else{
  43165. *ppFirst = pIn;
  43166. }
  43167. if( pIn->pRight ){
  43168. rowSetTreeToList(pIn->pRight, &pIn->pRight, ppLast);
  43169. }else{
  43170. *ppLast = pIn;
  43171. }
  43172. assert( (*ppLast)->pRight==0 );
  43173. }
  43174. /*
  43175. ** Convert a sorted list of elements (connected by pRight) into a binary
  43176. ** tree with depth of iDepth. A depth of 1 means the tree contains a single
  43177. ** node taken from the head of *ppList. A depth of 2 means a tree with
  43178. ** three nodes. And so forth.
  43179. **
  43180. ** Use as many entries from the input list as required and update the
  43181. ** *ppList to point to the unused elements of the list. If the input
  43182. ** list contains too few elements, then construct an incomplete tree
  43183. ** and leave *ppList set to NULL.
  43184. **
  43185. ** Return a pointer to the root of the constructed binary tree.
  43186. */
  43187. static struct RowSetEntry *rowSetNDeepTree(
  43188. struct RowSetEntry **ppList,
  43189. int iDepth
  43190. ){
  43191. struct RowSetEntry *p; /* Root of the new tree */
  43192. struct RowSetEntry *pLeft; /* Left subtree */
  43193. if( *ppList==0 ){ /*OPTIMIZATION-IF-TRUE*/
  43194. /* Prevent unnecessary deep recursion when we run out of entries */
  43195. return 0;
  43196. }
  43197. if( iDepth>1 ){ /*OPTIMIZATION-IF-TRUE*/
  43198. /* This branch causes a *balanced* tree to be generated. A valid tree
  43199. ** is still generated without this branch, but the tree is wildly
  43200. ** unbalanced and inefficient. */
  43201. pLeft = rowSetNDeepTree(ppList, iDepth-1);
  43202. p = *ppList;
  43203. if( p==0 ){ /*OPTIMIZATION-IF-FALSE*/
  43204. /* It is safe to always return here, but the resulting tree
  43205. ** would be unbalanced */
  43206. return pLeft;
  43207. }
  43208. p->pLeft = pLeft;
  43209. *ppList = p->pRight;
  43210. p->pRight = rowSetNDeepTree(ppList, iDepth-1);
  43211. }else{
  43212. p = *ppList;
  43213. *ppList = p->pRight;
  43214. p->pLeft = p->pRight = 0;
  43215. }
  43216. return p;
  43217. }
  43218. /*
  43219. ** Convert a sorted list of elements into a binary tree. Make the tree
  43220. ** as deep as it needs to be in order to contain the entire list.
  43221. */
  43222. static struct RowSetEntry *rowSetListToTree(struct RowSetEntry *pList){
  43223. int iDepth; /* Depth of the tree so far */
  43224. struct RowSetEntry *p; /* Current tree root */
  43225. struct RowSetEntry *pLeft; /* Left subtree */
  43226. assert( pList!=0 );
  43227. p = pList;
  43228. pList = p->pRight;
  43229. p->pLeft = p->pRight = 0;
  43230. for(iDepth=1; pList; iDepth++){
  43231. pLeft = p;
  43232. p = pList;
  43233. pList = p->pRight;
  43234. p->pLeft = pLeft;
  43235. p->pRight = rowSetNDeepTree(&pList, iDepth);
  43236. }
  43237. return p;
  43238. }
  43239. /*
  43240. ** Extract the smallest element from the RowSet.
  43241. ** Write the element into *pRowid. Return 1 on success. Return
  43242. ** 0 if the RowSet is already empty.
  43243. **
  43244. ** After this routine has been called, the sqlite3RowSetInsert()
  43245. ** routine may not be called again.
  43246. **
  43247. ** This routine may not be called after sqlite3RowSetTest() has
  43248. ** been used. Older versions of RowSet allowed that, but as the
  43249. ** capability was not used by the code generator, it was removed
  43250. ** for code economy.
  43251. */
  43252. SQLITE_PRIVATE int sqlite3RowSetNext(RowSet *p, i64 *pRowid){
  43253. assert( p!=0 );
  43254. assert( p->pForest==0 ); /* Cannot be used with sqlite3RowSetText() */
  43255. /* Merge the forest into a single sorted list on first call */
  43256. if( (p->rsFlags & ROWSET_NEXT)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  43257. if( (p->rsFlags & ROWSET_SORTED)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  43258. p->pEntry = rowSetEntrySort(p->pEntry);
  43259. }
  43260. p->rsFlags |= ROWSET_SORTED|ROWSET_NEXT;
  43261. }
  43262. /* Return the next entry on the list */
  43263. if( p->pEntry ){
  43264. *pRowid = p->pEntry->v;
  43265. p->pEntry = p->pEntry->pRight;
  43266. if( p->pEntry==0 ){ /*OPTIMIZATION-IF-TRUE*/
  43267. /* Free memory immediately, rather than waiting on sqlite3_finalize() */
  43268. sqlite3RowSetClear(p);
  43269. }
  43270. return 1;
  43271. }else{
  43272. return 0;
  43273. }
  43274. }
  43275. /*
  43276. ** Check to see if element iRowid was inserted into the rowset as
  43277. ** part of any insert batch prior to iBatch. Return 1 or 0.
  43278. **
  43279. ** If this is the first test of a new batch and if there exist entries
  43280. ** on pRowSet->pEntry, then sort those entries into the forest at
  43281. ** pRowSet->pForest so that they can be tested.
  43282. */
  43283. SQLITE_PRIVATE int sqlite3RowSetTest(RowSet *pRowSet, int iBatch, sqlite3_int64 iRowid){
  43284. struct RowSetEntry *p, *pTree;
  43285. /* This routine is never called after sqlite3RowSetNext() */
  43286. assert( pRowSet!=0 && (pRowSet->rsFlags & ROWSET_NEXT)==0 );
  43287. /* Sort entries into the forest on the first test of a new batch.
  43288. ** To save unnecessary work, only do this when the batch number changes.
  43289. */
  43290. if( iBatch!=pRowSet->iBatch ){ /*OPTIMIZATION-IF-FALSE*/
  43291. p = pRowSet->pEntry;
  43292. if( p ){
  43293. struct RowSetEntry **ppPrevTree = &pRowSet->pForest;
  43294. if( (pRowSet->rsFlags & ROWSET_SORTED)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  43295. /* Only sort the current set of entiries if they need it */
  43296. p = rowSetEntrySort(p);
  43297. }
  43298. for(pTree = pRowSet->pForest; pTree; pTree=pTree->pRight){
  43299. ppPrevTree = &pTree->pRight;
  43300. if( pTree->pLeft==0 ){
  43301. pTree->pLeft = rowSetListToTree(p);
  43302. break;
  43303. }else{
  43304. struct RowSetEntry *pAux, *pTail;
  43305. rowSetTreeToList(pTree->pLeft, &pAux, &pTail);
  43306. pTree->pLeft = 0;
  43307. p = rowSetEntryMerge(pAux, p);
  43308. }
  43309. }
  43310. if( pTree==0 ){
  43311. *ppPrevTree = pTree = rowSetEntryAlloc(pRowSet);
  43312. if( pTree ){
  43313. pTree->v = 0;
  43314. pTree->pRight = 0;
  43315. pTree->pLeft = rowSetListToTree(p);
  43316. }
  43317. }
  43318. pRowSet->pEntry = 0;
  43319. pRowSet->pLast = 0;
  43320. pRowSet->rsFlags |= ROWSET_SORTED;
  43321. }
  43322. pRowSet->iBatch = iBatch;
  43323. }
  43324. /* Test to see if the iRowid value appears anywhere in the forest.
  43325. ** Return 1 if it does and 0 if not.
  43326. */
  43327. for(pTree = pRowSet->pForest; pTree; pTree=pTree->pRight){
  43328. p = pTree->pLeft;
  43329. while( p ){
  43330. if( p->v<iRowid ){
  43331. p = p->pRight;
  43332. }else if( p->v>iRowid ){
  43333. p = p->pLeft;
  43334. }else{
  43335. return 1;
  43336. }
  43337. }
  43338. }
  43339. return 0;
  43340. }
  43341. /************** End of rowset.c **********************************************/
  43342. /************** Begin file pager.c *******************************************/
  43343. /*
  43344. ** 2001 September 15
  43345. **
  43346. ** The author disclaims copyright to this source code. In place of
  43347. ** a legal notice, here is a blessing:
  43348. **
  43349. ** May you do good and not evil.
  43350. ** May you find forgiveness for yourself and forgive others.
  43351. ** May you share freely, never taking more than you give.
  43352. **
  43353. *************************************************************************
  43354. ** This is the implementation of the page cache subsystem or "pager".
  43355. **
  43356. ** The pager is used to access a database disk file. It implements
  43357. ** atomic commit and rollback through the use of a journal file that
  43358. ** is separate from the database file. The pager also implements file
  43359. ** locking to prevent two processes from writing the same database
  43360. ** file simultaneously, or one process from reading the database while
  43361. ** another is writing.
  43362. */
  43363. #ifndef SQLITE_OMIT_DISKIO
  43364. /* #include "sqliteInt.h" */
  43365. /************** Include wal.h in the middle of pager.c ***********************/
  43366. /************** Begin file wal.h *********************************************/
  43367. /*
  43368. ** 2010 February 1
  43369. **
  43370. ** The author disclaims copyright to this source code. In place of
  43371. ** a legal notice, here is a blessing:
  43372. **
  43373. ** May you do good and not evil.
  43374. ** May you find forgiveness for yourself and forgive others.
  43375. ** May you share freely, never taking more than you give.
  43376. **
  43377. *************************************************************************
  43378. ** This header file defines the interface to the write-ahead logging
  43379. ** system. Refer to the comments below and the header comment attached to
  43380. ** the implementation of each function in log.c for further details.
  43381. */
  43382. #ifndef SQLITE_WAL_H
  43383. #define SQLITE_WAL_H
  43384. /* #include "sqliteInt.h" */
  43385. /* Additional values that can be added to the sync_flags argument of
  43386. ** sqlite3WalFrames():
  43387. */
  43388. #define WAL_SYNC_TRANSACTIONS 0x20 /* Sync at the end of each transaction */
  43389. #define SQLITE_SYNC_MASK 0x13 /* Mask off the SQLITE_SYNC_* values */
  43390. #ifdef SQLITE_OMIT_WAL
  43391. # define sqlite3WalOpen(x,y,z) 0
  43392. # define sqlite3WalLimit(x,y)
  43393. # define sqlite3WalClose(w,x,y,z) 0
  43394. # define sqlite3WalBeginReadTransaction(y,z) 0
  43395. # define sqlite3WalEndReadTransaction(z)
  43396. # define sqlite3WalDbsize(y) 0
  43397. # define sqlite3WalBeginWriteTransaction(y) 0
  43398. # define sqlite3WalEndWriteTransaction(x) 0
  43399. # define sqlite3WalUndo(x,y,z) 0
  43400. # define sqlite3WalSavepoint(y,z)
  43401. # define sqlite3WalSavepointUndo(y,z) 0
  43402. # define sqlite3WalFrames(u,v,w,x,y,z) 0
  43403. # define sqlite3WalCheckpoint(r,s,t,u,v,w,x,y,z) 0
  43404. # define sqlite3WalCallback(z) 0
  43405. # define sqlite3WalExclusiveMode(y,z) 0
  43406. # define sqlite3WalHeapMemory(z) 0
  43407. # define sqlite3WalFramesize(z) 0
  43408. # define sqlite3WalFindFrame(x,y,z) 0
  43409. # define sqlite3WalFile(x) 0
  43410. #else
  43411. #define WAL_SAVEPOINT_NDATA 4
  43412. /* Connection to a write-ahead log (WAL) file.
  43413. ** There is one object of this type for each pager.
  43414. */
  43415. typedef struct Wal Wal;
  43416. /* Open and close a connection to a write-ahead log. */
  43417. SQLITE_PRIVATE int sqlite3WalOpen(sqlite3_vfs*, sqlite3_file*, const char *, int, i64, Wal**);
  43418. SQLITE_PRIVATE int sqlite3WalClose(Wal *pWal, int sync_flags, int, u8 *);
  43419. /* Set the limiting size of a WAL file. */
  43420. SQLITE_PRIVATE void sqlite3WalLimit(Wal*, i64);
  43421. /* Used by readers to open (lock) and close (unlock) a snapshot. A
  43422. ** snapshot is like a read-transaction. It is the state of the database
  43423. ** at an instant in time. sqlite3WalOpenSnapshot gets a read lock and
  43424. ** preserves the current state even if the other threads or processes
  43425. ** write to or checkpoint the WAL. sqlite3WalCloseSnapshot() closes the
  43426. ** transaction and releases the lock.
  43427. */
  43428. SQLITE_PRIVATE int sqlite3WalBeginReadTransaction(Wal *pWal, int *);
  43429. SQLITE_PRIVATE void sqlite3WalEndReadTransaction(Wal *pWal);
  43430. /* Read a page from the write-ahead log, if it is present. */
  43431. SQLITE_PRIVATE int sqlite3WalFindFrame(Wal *, Pgno, u32 *);
  43432. SQLITE_PRIVATE int sqlite3WalReadFrame(Wal *, u32, int, u8 *);
  43433. /* If the WAL is not empty, return the size of the database. */
  43434. SQLITE_PRIVATE Pgno sqlite3WalDbsize(Wal *pWal);
  43435. /* Obtain or release the WRITER lock. */
  43436. SQLITE_PRIVATE int sqlite3WalBeginWriteTransaction(Wal *pWal);
  43437. SQLITE_PRIVATE int sqlite3WalEndWriteTransaction(Wal *pWal);
  43438. /* Undo any frames written (but not committed) to the log */
  43439. SQLITE_PRIVATE int sqlite3WalUndo(Wal *pWal, int (*xUndo)(void *, Pgno), void *pUndoCtx);
  43440. /* Return an integer that records the current (uncommitted) write
  43441. ** position in the WAL */
  43442. SQLITE_PRIVATE void sqlite3WalSavepoint(Wal *pWal, u32 *aWalData);
  43443. /* Move the write position of the WAL back to iFrame. Called in
  43444. ** response to a ROLLBACK TO command. */
  43445. SQLITE_PRIVATE int sqlite3WalSavepointUndo(Wal *pWal, u32 *aWalData);
  43446. /* Write a frame or frames to the log. */
  43447. SQLITE_PRIVATE int sqlite3WalFrames(Wal *pWal, int, PgHdr *, Pgno, int, int);
  43448. /* Copy pages from the log to the database file */
  43449. SQLITE_PRIVATE int sqlite3WalCheckpoint(
  43450. Wal *pWal, /* Write-ahead log connection */
  43451. int eMode, /* One of PASSIVE, FULL and RESTART */
  43452. int (*xBusy)(void*), /* Function to call when busy */
  43453. void *pBusyArg, /* Context argument for xBusyHandler */
  43454. int sync_flags, /* Flags to sync db file with (or 0) */
  43455. int nBuf, /* Size of buffer nBuf */
  43456. u8 *zBuf, /* Temporary buffer to use */
  43457. int *pnLog, /* OUT: Number of frames in WAL */
  43458. int *pnCkpt /* OUT: Number of backfilled frames in WAL */
  43459. );
  43460. /* Return the value to pass to a sqlite3_wal_hook callback, the
  43461. ** number of frames in the WAL at the point of the last commit since
  43462. ** sqlite3WalCallback() was called. If no commits have occurred since
  43463. ** the last call, then return 0.
  43464. */
  43465. SQLITE_PRIVATE int sqlite3WalCallback(Wal *pWal);
  43466. /* Tell the wal layer that an EXCLUSIVE lock has been obtained (or released)
  43467. ** by the pager layer on the database file.
  43468. */
  43469. SQLITE_PRIVATE int sqlite3WalExclusiveMode(Wal *pWal, int op);
  43470. /* Return true if the argument is non-NULL and the WAL module is using
  43471. ** heap-memory for the wal-index. Otherwise, if the argument is NULL or the
  43472. ** WAL module is using shared-memory, return false.
  43473. */
  43474. SQLITE_PRIVATE int sqlite3WalHeapMemory(Wal *pWal);
  43475. #ifdef SQLITE_ENABLE_SNAPSHOT
  43476. SQLITE_PRIVATE int sqlite3WalSnapshotGet(Wal *pWal, sqlite3_snapshot **ppSnapshot);
  43477. SQLITE_PRIVATE void sqlite3WalSnapshotOpen(Wal *pWal, sqlite3_snapshot *pSnapshot);
  43478. #endif
  43479. #ifdef SQLITE_ENABLE_ZIPVFS
  43480. /* If the WAL file is not empty, return the number of bytes of content
  43481. ** stored in each frame (i.e. the db page-size when the WAL was created).
  43482. */
  43483. SQLITE_PRIVATE int sqlite3WalFramesize(Wal *pWal);
  43484. #endif
  43485. /* Return the sqlite3_file object for the WAL file */
  43486. SQLITE_PRIVATE sqlite3_file *sqlite3WalFile(Wal *pWal);
  43487. #endif /* ifndef SQLITE_OMIT_WAL */
  43488. #endif /* SQLITE_WAL_H */
  43489. /************** End of wal.h *************************************************/
  43490. /************** Continuing where we left off in pager.c **********************/
  43491. /******************* NOTES ON THE DESIGN OF THE PAGER ************************
  43492. **
  43493. ** This comment block describes invariants that hold when using a rollback
  43494. ** journal. These invariants do not apply for journal_mode=WAL,
  43495. ** journal_mode=MEMORY, or journal_mode=OFF.
  43496. **
  43497. ** Within this comment block, a page is deemed to have been synced
  43498. ** automatically as soon as it is written when PRAGMA synchronous=OFF.
  43499. ** Otherwise, the page is not synced until the xSync method of the VFS
  43500. ** is called successfully on the file containing the page.
  43501. **
  43502. ** Definition: A page of the database file is said to be "overwriteable" if
  43503. ** one or more of the following are true about the page:
  43504. **
  43505. ** (a) The original content of the page as it was at the beginning of
  43506. ** the transaction has been written into the rollback journal and
  43507. ** synced.
  43508. **
  43509. ** (b) The page was a freelist leaf page at the start of the transaction.
  43510. **
  43511. ** (c) The page number is greater than the largest page that existed in
  43512. ** the database file at the start of the transaction.
  43513. **
  43514. ** (1) A page of the database file is never overwritten unless one of the
  43515. ** following are true:
  43516. **
  43517. ** (a) The page and all other pages on the same sector are overwriteable.
  43518. **
  43519. ** (b) The atomic page write optimization is enabled, and the entire
  43520. ** transaction other than the update of the transaction sequence
  43521. ** number consists of a single page change.
  43522. **
  43523. ** (2) The content of a page written into the rollback journal exactly matches
  43524. ** both the content in the database when the rollback journal was written
  43525. ** and the content in the database at the beginning of the current
  43526. ** transaction.
  43527. **
  43528. ** (3) Writes to the database file are an integer multiple of the page size
  43529. ** in length and are aligned on a page boundary.
  43530. **
  43531. ** (4) Reads from the database file are either aligned on a page boundary and
  43532. ** an integer multiple of the page size in length or are taken from the
  43533. ** first 100 bytes of the database file.
  43534. **
  43535. ** (5) All writes to the database file are synced prior to the rollback journal
  43536. ** being deleted, truncated, or zeroed.
  43537. **
  43538. ** (6) If a master journal file is used, then all writes to the database file
  43539. ** are synced prior to the master journal being deleted.
  43540. **
  43541. ** Definition: Two databases (or the same database at two points it time)
  43542. ** are said to be "logically equivalent" if they give the same answer to
  43543. ** all queries. Note in particular the content of freelist leaf
  43544. ** pages can be changed arbitrarily without affecting the logical equivalence
  43545. ** of the database.
  43546. **
  43547. ** (7) At any time, if any subset, including the empty set and the total set,
  43548. ** of the unsynced changes to a rollback journal are removed and the
  43549. ** journal is rolled back, the resulting database file will be logically
  43550. ** equivalent to the database file at the beginning of the transaction.
  43551. **
  43552. ** (8) When a transaction is rolled back, the xTruncate method of the VFS
  43553. ** is called to restore the database file to the same size it was at
  43554. ** the beginning of the transaction. (In some VFSes, the xTruncate
  43555. ** method is a no-op, but that does not change the fact the SQLite will
  43556. ** invoke it.)
  43557. **
  43558. ** (9) Whenever the database file is modified, at least one bit in the range
  43559. ** of bytes from 24 through 39 inclusive will be changed prior to releasing
  43560. ** the EXCLUSIVE lock, thus signaling other connections on the same
  43561. ** database to flush their caches.
  43562. **
  43563. ** (10) The pattern of bits in bytes 24 through 39 shall not repeat in less
  43564. ** than one billion transactions.
  43565. **
  43566. ** (11) A database file is well-formed at the beginning and at the conclusion
  43567. ** of every transaction.
  43568. **
  43569. ** (12) An EXCLUSIVE lock is held on the database file when writing to
  43570. ** the database file.
  43571. **
  43572. ** (13) A SHARED lock is held on the database file while reading any
  43573. ** content out of the database file.
  43574. **
  43575. ******************************************************************************/
  43576. /*
  43577. ** Macros for troubleshooting. Normally turned off
  43578. */
  43579. #if 0
  43580. int sqlite3PagerTrace=1; /* True to enable tracing */
  43581. #define sqlite3DebugPrintf printf
  43582. #define PAGERTRACE(X) if( sqlite3PagerTrace ){ sqlite3DebugPrintf X; }
  43583. #else
  43584. #define PAGERTRACE(X)
  43585. #endif
  43586. /*
  43587. ** The following two macros are used within the PAGERTRACE() macros above
  43588. ** to print out file-descriptors.
  43589. **
  43590. ** PAGERID() takes a pointer to a Pager struct as its argument. The
  43591. ** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
  43592. ** struct as its argument.
  43593. */
  43594. #define PAGERID(p) ((int)(p->fd))
  43595. #define FILEHANDLEID(fd) ((int)fd)
  43596. /*
  43597. ** The Pager.eState variable stores the current 'state' of a pager. A
  43598. ** pager may be in any one of the seven states shown in the following
  43599. ** state diagram.
  43600. **
  43601. ** OPEN <------+------+
  43602. ** | | |
  43603. ** V | |
  43604. ** +---------> READER-------+ |
  43605. ** | | |
  43606. ** | V |
  43607. ** |<-------WRITER_LOCKED------> ERROR
  43608. ** | | ^
  43609. ** | V |
  43610. ** |<------WRITER_CACHEMOD-------->|
  43611. ** | | |
  43612. ** | V |
  43613. ** |<-------WRITER_DBMOD---------->|
  43614. ** | | |
  43615. ** | V |
  43616. ** +<------WRITER_FINISHED-------->+
  43617. **
  43618. **
  43619. ** List of state transitions and the C [function] that performs each:
  43620. **
  43621. ** OPEN -> READER [sqlite3PagerSharedLock]
  43622. ** READER -> OPEN [pager_unlock]
  43623. **
  43624. ** READER -> WRITER_LOCKED [sqlite3PagerBegin]
  43625. ** WRITER_LOCKED -> WRITER_CACHEMOD [pager_open_journal]
  43626. ** WRITER_CACHEMOD -> WRITER_DBMOD [syncJournal]
  43627. ** WRITER_DBMOD -> WRITER_FINISHED [sqlite3PagerCommitPhaseOne]
  43628. ** WRITER_*** -> READER [pager_end_transaction]
  43629. **
  43630. ** WRITER_*** -> ERROR [pager_error]
  43631. ** ERROR -> OPEN [pager_unlock]
  43632. **
  43633. **
  43634. ** OPEN:
  43635. **
  43636. ** The pager starts up in this state. Nothing is guaranteed in this
  43637. ** state - the file may or may not be locked and the database size is
  43638. ** unknown. The database may not be read or written.
  43639. **
  43640. ** * No read or write transaction is active.
  43641. ** * Any lock, or no lock at all, may be held on the database file.
  43642. ** * The dbSize, dbOrigSize and dbFileSize variables may not be trusted.
  43643. **
  43644. ** READER:
  43645. **
  43646. ** In this state all the requirements for reading the database in
  43647. ** rollback (non-WAL) mode are met. Unless the pager is (or recently
  43648. ** was) in exclusive-locking mode, a user-level read transaction is
  43649. ** open. The database size is known in this state.
  43650. **
  43651. ** A connection running with locking_mode=normal enters this state when
  43652. ** it opens a read-transaction on the database and returns to state
  43653. ** OPEN after the read-transaction is completed. However a connection
  43654. ** running in locking_mode=exclusive (including temp databases) remains in
  43655. ** this state even after the read-transaction is closed. The only way
  43656. ** a locking_mode=exclusive connection can transition from READER to OPEN
  43657. ** is via the ERROR state (see below).
  43658. **
  43659. ** * A read transaction may be active (but a write-transaction cannot).
  43660. ** * A SHARED or greater lock is held on the database file.
  43661. ** * The dbSize variable may be trusted (even if a user-level read
  43662. ** transaction is not active). The dbOrigSize and dbFileSize variables
  43663. ** may not be trusted at this point.
  43664. ** * If the database is a WAL database, then the WAL connection is open.
  43665. ** * Even if a read-transaction is not open, it is guaranteed that
  43666. ** there is no hot-journal in the file-system.
  43667. **
  43668. ** WRITER_LOCKED:
  43669. **
  43670. ** The pager moves to this state from READER when a write-transaction
  43671. ** is first opened on the database. In WRITER_LOCKED state, all locks
  43672. ** required to start a write-transaction are held, but no actual
  43673. ** modifications to the cache or database have taken place.
  43674. **
  43675. ** In rollback mode, a RESERVED or (if the transaction was opened with
  43676. ** BEGIN EXCLUSIVE) EXCLUSIVE lock is obtained on the database file when
  43677. ** moving to this state, but the journal file is not written to or opened
  43678. ** to in this state. If the transaction is committed or rolled back while
  43679. ** in WRITER_LOCKED state, all that is required is to unlock the database
  43680. ** file.
  43681. **
  43682. ** IN WAL mode, WalBeginWriteTransaction() is called to lock the log file.
  43683. ** If the connection is running with locking_mode=exclusive, an attempt
  43684. ** is made to obtain an EXCLUSIVE lock on the database file.
  43685. **
  43686. ** * A write transaction is active.
  43687. ** * If the connection is open in rollback-mode, a RESERVED or greater
  43688. ** lock is held on the database file.
  43689. ** * If the connection is open in WAL-mode, a WAL write transaction
  43690. ** is open (i.e. sqlite3WalBeginWriteTransaction() has been successfully
  43691. ** called).
  43692. ** * The dbSize, dbOrigSize and dbFileSize variables are all valid.
  43693. ** * The contents of the pager cache have not been modified.
  43694. ** * The journal file may or may not be open.
  43695. ** * Nothing (not even the first header) has been written to the journal.
  43696. **
  43697. ** WRITER_CACHEMOD:
  43698. **
  43699. ** A pager moves from WRITER_LOCKED state to this state when a page is
  43700. ** first modified by the upper layer. In rollback mode the journal file
  43701. ** is opened (if it is not already open) and a header written to the
  43702. ** start of it. The database file on disk has not been modified.
  43703. **
  43704. ** * A write transaction is active.
  43705. ** * A RESERVED or greater lock is held on the database file.
  43706. ** * The journal file is open and the first header has been written
  43707. ** to it, but the header has not been synced to disk.
  43708. ** * The contents of the page cache have been modified.
  43709. **
  43710. ** WRITER_DBMOD:
  43711. **
  43712. ** The pager transitions from WRITER_CACHEMOD into WRITER_DBMOD state
  43713. ** when it modifies the contents of the database file. WAL connections
  43714. ** never enter this state (since they do not modify the database file,
  43715. ** just the log file).
  43716. **
  43717. ** * A write transaction is active.
  43718. ** * An EXCLUSIVE or greater lock is held on the database file.
  43719. ** * The journal file is open and the first header has been written
  43720. ** and synced to disk.
  43721. ** * The contents of the page cache have been modified (and possibly
  43722. ** written to disk).
  43723. **
  43724. ** WRITER_FINISHED:
  43725. **
  43726. ** It is not possible for a WAL connection to enter this state.
  43727. **
  43728. ** A rollback-mode pager changes to WRITER_FINISHED state from WRITER_DBMOD
  43729. ** state after the entire transaction has been successfully written into the
  43730. ** database file. In this state the transaction may be committed simply
  43731. ** by finalizing the journal file. Once in WRITER_FINISHED state, it is
  43732. ** not possible to modify the database further. At this point, the upper
  43733. ** layer must either commit or rollback the transaction.
  43734. **
  43735. ** * A write transaction is active.
  43736. ** * An EXCLUSIVE or greater lock is held on the database file.
  43737. ** * All writing and syncing of journal and database data has finished.
  43738. ** If no error occurred, all that remains is to finalize the journal to
  43739. ** commit the transaction. If an error did occur, the caller will need
  43740. ** to rollback the transaction.
  43741. **
  43742. ** ERROR:
  43743. **
  43744. ** The ERROR state is entered when an IO or disk-full error (including
  43745. ** SQLITE_IOERR_NOMEM) occurs at a point in the code that makes it
  43746. ** difficult to be sure that the in-memory pager state (cache contents,
  43747. ** db size etc.) are consistent with the contents of the file-system.
  43748. **
  43749. ** Temporary pager files may enter the ERROR state, but in-memory pagers
  43750. ** cannot.
  43751. **
  43752. ** For example, if an IO error occurs while performing a rollback,
  43753. ** the contents of the page-cache may be left in an inconsistent state.
  43754. ** At this point it would be dangerous to change back to READER state
  43755. ** (as usually happens after a rollback). Any subsequent readers might
  43756. ** report database corruption (due to the inconsistent cache), and if
  43757. ** they upgrade to writers, they may inadvertently corrupt the database
  43758. ** file. To avoid this hazard, the pager switches into the ERROR state
  43759. ** instead of READER following such an error.
  43760. **
  43761. ** Once it has entered the ERROR state, any attempt to use the pager
  43762. ** to read or write data returns an error. Eventually, once all
  43763. ** outstanding transactions have been abandoned, the pager is able to
  43764. ** transition back to OPEN state, discarding the contents of the
  43765. ** page-cache and any other in-memory state at the same time. Everything
  43766. ** is reloaded from disk (and, if necessary, hot-journal rollback peformed)
  43767. ** when a read-transaction is next opened on the pager (transitioning
  43768. ** the pager into READER state). At that point the system has recovered
  43769. ** from the error.
  43770. **
  43771. ** Specifically, the pager jumps into the ERROR state if:
  43772. **
  43773. ** 1. An error occurs while attempting a rollback. This happens in
  43774. ** function sqlite3PagerRollback().
  43775. **
  43776. ** 2. An error occurs while attempting to finalize a journal file
  43777. ** following a commit in function sqlite3PagerCommitPhaseTwo().
  43778. **
  43779. ** 3. An error occurs while attempting to write to the journal or
  43780. ** database file in function pagerStress() in order to free up
  43781. ** memory.
  43782. **
  43783. ** In other cases, the error is returned to the b-tree layer. The b-tree
  43784. ** layer then attempts a rollback operation. If the error condition
  43785. ** persists, the pager enters the ERROR state via condition (1) above.
  43786. **
  43787. ** Condition (3) is necessary because it can be triggered by a read-only
  43788. ** statement executed within a transaction. In this case, if the error
  43789. ** code were simply returned to the user, the b-tree layer would not
  43790. ** automatically attempt a rollback, as it assumes that an error in a
  43791. ** read-only statement cannot leave the pager in an internally inconsistent
  43792. ** state.
  43793. **
  43794. ** * The Pager.errCode variable is set to something other than SQLITE_OK.
  43795. ** * There are one or more outstanding references to pages (after the
  43796. ** last reference is dropped the pager should move back to OPEN state).
  43797. ** * The pager is not an in-memory pager.
  43798. **
  43799. **
  43800. ** Notes:
  43801. **
  43802. ** * A pager is never in WRITER_DBMOD or WRITER_FINISHED state if the
  43803. ** connection is open in WAL mode. A WAL connection is always in one
  43804. ** of the first four states.
  43805. **
  43806. ** * Normally, a connection open in exclusive mode is never in PAGER_OPEN
  43807. ** state. There are two exceptions: immediately after exclusive-mode has
  43808. ** been turned on (and before any read or write transactions are
  43809. ** executed), and when the pager is leaving the "error state".
  43810. **
  43811. ** * See also: assert_pager_state().
  43812. */
  43813. #define PAGER_OPEN 0
  43814. #define PAGER_READER 1
  43815. #define PAGER_WRITER_LOCKED 2
  43816. #define PAGER_WRITER_CACHEMOD 3
  43817. #define PAGER_WRITER_DBMOD 4
  43818. #define PAGER_WRITER_FINISHED 5
  43819. #define PAGER_ERROR 6
  43820. /*
  43821. ** The Pager.eLock variable is almost always set to one of the
  43822. ** following locking-states, according to the lock currently held on
  43823. ** the database file: NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
  43824. ** This variable is kept up to date as locks are taken and released by
  43825. ** the pagerLockDb() and pagerUnlockDb() wrappers.
  43826. **
  43827. ** If the VFS xLock() or xUnlock() returns an error other than SQLITE_BUSY
  43828. ** (i.e. one of the SQLITE_IOERR subtypes), it is not clear whether or not
  43829. ** the operation was successful. In these circumstances pagerLockDb() and
  43830. ** pagerUnlockDb() take a conservative approach - eLock is always updated
  43831. ** when unlocking the file, and only updated when locking the file if the
  43832. ** VFS call is successful. This way, the Pager.eLock variable may be set
  43833. ** to a less exclusive (lower) value than the lock that is actually held
  43834. ** at the system level, but it is never set to a more exclusive value.
  43835. **
  43836. ** This is usually safe. If an xUnlock fails or appears to fail, there may
  43837. ** be a few redundant xLock() calls or a lock may be held for longer than
  43838. ** required, but nothing really goes wrong.
  43839. **
  43840. ** The exception is when the database file is unlocked as the pager moves
  43841. ** from ERROR to OPEN state. At this point there may be a hot-journal file
  43842. ** in the file-system that needs to be rolled back (as part of an OPEN->SHARED
  43843. ** transition, by the same pager or any other). If the call to xUnlock()
  43844. ** fails at this point and the pager is left holding an EXCLUSIVE lock, this
  43845. ** can confuse the call to xCheckReservedLock() call made later as part
  43846. ** of hot-journal detection.
  43847. **
  43848. ** xCheckReservedLock() is defined as returning true "if there is a RESERVED
  43849. ** lock held by this process or any others". So xCheckReservedLock may
  43850. ** return true because the caller itself is holding an EXCLUSIVE lock (but
  43851. ** doesn't know it because of a previous error in xUnlock). If this happens
  43852. ** a hot-journal may be mistaken for a journal being created by an active
  43853. ** transaction in another process, causing SQLite to read from the database
  43854. ** without rolling it back.
  43855. **
  43856. ** To work around this, if a call to xUnlock() fails when unlocking the
  43857. ** database in the ERROR state, Pager.eLock is set to UNKNOWN_LOCK. It
  43858. ** is only changed back to a real locking state after a successful call
  43859. ** to xLock(EXCLUSIVE). Also, the code to do the OPEN->SHARED state transition
  43860. ** omits the check for a hot-journal if Pager.eLock is set to UNKNOWN_LOCK
  43861. ** lock. Instead, it assumes a hot-journal exists and obtains an EXCLUSIVE
  43862. ** lock on the database file before attempting to roll it back. See function
  43863. ** PagerSharedLock() for more detail.
  43864. **
  43865. ** Pager.eLock may only be set to UNKNOWN_LOCK when the pager is in
  43866. ** PAGER_OPEN state.
  43867. */
  43868. #define UNKNOWN_LOCK (EXCLUSIVE_LOCK+1)
  43869. /*
  43870. ** A macro used for invoking the codec if there is one
  43871. */
  43872. #ifdef SQLITE_HAS_CODEC
  43873. # define CODEC1(P,D,N,X,E) \
  43874. if( P->xCodec && P->xCodec(P->pCodec,D,N,X)==0 ){ E; }
  43875. # define CODEC2(P,D,N,X,E,O) \
  43876. if( P->xCodec==0 ){ O=(char*)D; }else \
  43877. if( (O=(char*)(P->xCodec(P->pCodec,D,N,X)))==0 ){ E; }
  43878. #else
  43879. # define CODEC1(P,D,N,X,E) /* NO-OP */
  43880. # define CODEC2(P,D,N,X,E,O) O=(char*)D
  43881. #endif
  43882. /*
  43883. ** The maximum allowed sector size. 64KiB. If the xSectorsize() method
  43884. ** returns a value larger than this, then MAX_SECTOR_SIZE is used instead.
  43885. ** This could conceivably cause corruption following a power failure on
  43886. ** such a system. This is currently an undocumented limit.
  43887. */
  43888. #define MAX_SECTOR_SIZE 0x10000
  43889. /*
  43890. ** An instance of the following structure is allocated for each active
  43891. ** savepoint and statement transaction in the system. All such structures
  43892. ** are stored in the Pager.aSavepoint[] array, which is allocated and
  43893. ** resized using sqlite3Realloc().
  43894. **
  43895. ** When a savepoint is created, the PagerSavepoint.iHdrOffset field is
  43896. ** set to 0. If a journal-header is written into the main journal while
  43897. ** the savepoint is active, then iHdrOffset is set to the byte offset
  43898. ** immediately following the last journal record written into the main
  43899. ** journal before the journal-header. This is required during savepoint
  43900. ** rollback (see pagerPlaybackSavepoint()).
  43901. */
  43902. typedef struct PagerSavepoint PagerSavepoint;
  43903. struct PagerSavepoint {
  43904. i64 iOffset; /* Starting offset in main journal */
  43905. i64 iHdrOffset; /* See above */
  43906. Bitvec *pInSavepoint; /* Set of pages in this savepoint */
  43907. Pgno nOrig; /* Original number of pages in file */
  43908. Pgno iSubRec; /* Index of first record in sub-journal */
  43909. #ifndef SQLITE_OMIT_WAL
  43910. u32 aWalData[WAL_SAVEPOINT_NDATA]; /* WAL savepoint context */
  43911. #endif
  43912. };
  43913. /*
  43914. ** Bits of the Pager.doNotSpill flag. See further description below.
  43915. */
  43916. #define SPILLFLAG_OFF 0x01 /* Never spill cache. Set via pragma */
  43917. #define SPILLFLAG_ROLLBACK 0x02 /* Current rolling back, so do not spill */
  43918. #define SPILLFLAG_NOSYNC 0x04 /* Spill is ok, but do not sync */
  43919. /*
  43920. ** An open page cache is an instance of struct Pager. A description of
  43921. ** some of the more important member variables follows:
  43922. **
  43923. ** eState
  43924. **
  43925. ** The current 'state' of the pager object. See the comment and state
  43926. ** diagram above for a description of the pager state.
  43927. **
  43928. ** eLock
  43929. **
  43930. ** For a real on-disk database, the current lock held on the database file -
  43931. ** NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
  43932. **
  43933. ** For a temporary or in-memory database (neither of which require any
  43934. ** locks), this variable is always set to EXCLUSIVE_LOCK. Since such
  43935. ** databases always have Pager.exclusiveMode==1, this tricks the pager
  43936. ** logic into thinking that it already has all the locks it will ever
  43937. ** need (and no reason to release them).
  43938. **
  43939. ** In some (obscure) circumstances, this variable may also be set to
  43940. ** UNKNOWN_LOCK. See the comment above the #define of UNKNOWN_LOCK for
  43941. ** details.
  43942. **
  43943. ** changeCountDone
  43944. **
  43945. ** This boolean variable is used to make sure that the change-counter
  43946. ** (the 4-byte header field at byte offset 24 of the database file) is
  43947. ** not updated more often than necessary.
  43948. **
  43949. ** It is set to true when the change-counter field is updated, which
  43950. ** can only happen if an exclusive lock is held on the database file.
  43951. ** It is cleared (set to false) whenever an exclusive lock is
  43952. ** relinquished on the database file. Each time a transaction is committed,
  43953. ** The changeCountDone flag is inspected. If it is true, the work of
  43954. ** updating the change-counter is omitted for the current transaction.
  43955. **
  43956. ** This mechanism means that when running in exclusive mode, a connection
  43957. ** need only update the change-counter once, for the first transaction
  43958. ** committed.
  43959. **
  43960. ** setMaster
  43961. **
  43962. ** When PagerCommitPhaseOne() is called to commit a transaction, it may
  43963. ** (or may not) specify a master-journal name to be written into the
  43964. ** journal file before it is synced to disk.
  43965. **
  43966. ** Whether or not a journal file contains a master-journal pointer affects
  43967. ** the way in which the journal file is finalized after the transaction is
  43968. ** committed or rolled back when running in "journal_mode=PERSIST" mode.
  43969. ** If a journal file does not contain a master-journal pointer, it is
  43970. ** finalized by overwriting the first journal header with zeroes. If
  43971. ** it does contain a master-journal pointer the journal file is finalized
  43972. ** by truncating it to zero bytes, just as if the connection were
  43973. ** running in "journal_mode=truncate" mode.
  43974. **
  43975. ** Journal files that contain master journal pointers cannot be finalized
  43976. ** simply by overwriting the first journal-header with zeroes, as the
  43977. ** master journal pointer could interfere with hot-journal rollback of any
  43978. ** subsequently interrupted transaction that reuses the journal file.
  43979. **
  43980. ** The flag is cleared as soon as the journal file is finalized (either
  43981. ** by PagerCommitPhaseTwo or PagerRollback). If an IO error prevents the
  43982. ** journal file from being successfully finalized, the setMaster flag
  43983. ** is cleared anyway (and the pager will move to ERROR state).
  43984. **
  43985. ** doNotSpill
  43986. **
  43987. ** This variables control the behavior of cache-spills (calls made by
  43988. ** the pcache module to the pagerStress() routine to write cached data
  43989. ** to the file-system in order to free up memory).
  43990. **
  43991. ** When bits SPILLFLAG_OFF or SPILLFLAG_ROLLBACK of doNotSpill are set,
  43992. ** writing to the database from pagerStress() is disabled altogether.
  43993. ** The SPILLFLAG_ROLLBACK case is done in a very obscure case that
  43994. ** comes up during savepoint rollback that requires the pcache module
  43995. ** to allocate a new page to prevent the journal file from being written
  43996. ** while it is being traversed by code in pager_playback(). The SPILLFLAG_OFF
  43997. ** case is a user preference.
  43998. **
  43999. ** If the SPILLFLAG_NOSYNC bit is set, writing to the database from
  44000. ** pagerStress() is permitted, but syncing the journal file is not.
  44001. ** This flag is set by sqlite3PagerWrite() when the file-system sector-size
  44002. ** is larger than the database page-size in order to prevent a journal sync
  44003. ** from happening in between the journalling of two pages on the same sector.
  44004. **
  44005. ** subjInMemory
  44006. **
  44007. ** This is a boolean variable. If true, then any required sub-journal
  44008. ** is opened as an in-memory journal file. If false, then in-memory
  44009. ** sub-journals are only used for in-memory pager files.
  44010. **
  44011. ** This variable is updated by the upper layer each time a new
  44012. ** write-transaction is opened.
  44013. **
  44014. ** dbSize, dbOrigSize, dbFileSize
  44015. **
  44016. ** Variable dbSize is set to the number of pages in the database file.
  44017. ** It is valid in PAGER_READER and higher states (all states except for
  44018. ** OPEN and ERROR).
  44019. **
  44020. ** dbSize is set based on the size of the database file, which may be
  44021. ** larger than the size of the database (the value stored at offset
  44022. ** 28 of the database header by the btree). If the size of the file
  44023. ** is not an integer multiple of the page-size, the value stored in
  44024. ** dbSize is rounded down (i.e. a 5KB file with 2K page-size has dbSize==2).
  44025. ** Except, any file that is greater than 0 bytes in size is considered
  44026. ** to have at least one page. (i.e. a 1KB file with 2K page-size leads
  44027. ** to dbSize==1).
  44028. **
  44029. ** During a write-transaction, if pages with page-numbers greater than
  44030. ** dbSize are modified in the cache, dbSize is updated accordingly.
  44031. ** Similarly, if the database is truncated using PagerTruncateImage(),
  44032. ** dbSize is updated.
  44033. **
  44034. ** Variables dbOrigSize and dbFileSize are valid in states
  44035. ** PAGER_WRITER_LOCKED and higher. dbOrigSize is a copy of the dbSize
  44036. ** variable at the start of the transaction. It is used during rollback,
  44037. ** and to determine whether or not pages need to be journalled before
  44038. ** being modified.
  44039. **
  44040. ** Throughout a write-transaction, dbFileSize contains the size of
  44041. ** the file on disk in pages. It is set to a copy of dbSize when the
  44042. ** write-transaction is first opened, and updated when VFS calls are made
  44043. ** to write or truncate the database file on disk.
  44044. **
  44045. ** The only reason the dbFileSize variable is required is to suppress
  44046. ** unnecessary calls to xTruncate() after committing a transaction. If,
  44047. ** when a transaction is committed, the dbFileSize variable indicates
  44048. ** that the database file is larger than the database image (Pager.dbSize),
  44049. ** pager_truncate() is called. The pager_truncate() call uses xFilesize()
  44050. ** to measure the database file on disk, and then truncates it if required.
  44051. ** dbFileSize is not used when rolling back a transaction. In this case
  44052. ** pager_truncate() is called unconditionally (which means there may be
  44053. ** a call to xFilesize() that is not strictly required). In either case,
  44054. ** pager_truncate() may cause the file to become smaller or larger.
  44055. **
  44056. ** dbHintSize
  44057. **
  44058. ** The dbHintSize variable is used to limit the number of calls made to
  44059. ** the VFS xFileControl(FCNTL_SIZE_HINT) method.
  44060. **
  44061. ** dbHintSize is set to a copy of the dbSize variable when a
  44062. ** write-transaction is opened (at the same time as dbFileSize and
  44063. ** dbOrigSize). If the xFileControl(FCNTL_SIZE_HINT) method is called,
  44064. ** dbHintSize is increased to the number of pages that correspond to the
  44065. ** size-hint passed to the method call. See pager_write_pagelist() for
  44066. ** details.
  44067. **
  44068. ** errCode
  44069. **
  44070. ** The Pager.errCode variable is only ever used in PAGER_ERROR state. It
  44071. ** is set to zero in all other states. In PAGER_ERROR state, Pager.errCode
  44072. ** is always set to SQLITE_FULL, SQLITE_IOERR or one of the SQLITE_IOERR_XXX
  44073. ** sub-codes.
  44074. */
  44075. struct Pager {
  44076. sqlite3_vfs *pVfs; /* OS functions to use for IO */
  44077. u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
  44078. u8 journalMode; /* One of the PAGER_JOURNALMODE_* values */
  44079. u8 useJournal; /* Use a rollback journal on this file */
  44080. u8 noSync; /* Do not sync the journal if true */
  44081. u8 fullSync; /* Do extra syncs of the journal for robustness */
  44082. u8 extraSync; /* sync directory after journal delete */
  44083. u8 ckptSyncFlags; /* SYNC_NORMAL or SYNC_FULL for checkpoint */
  44084. u8 walSyncFlags; /* SYNC_NORMAL or SYNC_FULL for wal writes */
  44085. u8 syncFlags; /* SYNC_NORMAL or SYNC_FULL otherwise */
  44086. u8 tempFile; /* zFilename is a temporary or immutable file */
  44087. u8 noLock; /* Do not lock (except in WAL mode) */
  44088. u8 readOnly; /* True for a read-only database */
  44089. u8 memDb; /* True to inhibit all file I/O */
  44090. /**************************************************************************
  44091. ** The following block contains those class members that change during
  44092. ** routine operation. Class members not in this block are either fixed
  44093. ** when the pager is first created or else only change when there is a
  44094. ** significant mode change (such as changing the page_size, locking_mode,
  44095. ** or the journal_mode). From another view, these class members describe
  44096. ** the "state" of the pager, while other class members describe the
  44097. ** "configuration" of the pager.
  44098. */
  44099. u8 eState; /* Pager state (OPEN, READER, WRITER_LOCKED..) */
  44100. u8 eLock; /* Current lock held on database file */
  44101. u8 changeCountDone; /* Set after incrementing the change-counter */
  44102. u8 setMaster; /* True if a m-j name has been written to jrnl */
  44103. u8 doNotSpill; /* Do not spill the cache when non-zero */
  44104. u8 subjInMemory; /* True to use in-memory sub-journals */
  44105. u8 bUseFetch; /* True to use xFetch() */
  44106. u8 hasHeldSharedLock; /* True if a shared lock has ever been held */
  44107. Pgno dbSize; /* Number of pages in the database */
  44108. Pgno dbOrigSize; /* dbSize before the current transaction */
  44109. Pgno dbFileSize; /* Number of pages in the database file */
  44110. Pgno dbHintSize; /* Value passed to FCNTL_SIZE_HINT call */
  44111. int errCode; /* One of several kinds of errors */
  44112. int nRec; /* Pages journalled since last j-header written */
  44113. u32 cksumInit; /* Quasi-random value added to every checksum */
  44114. u32 nSubRec; /* Number of records written to sub-journal */
  44115. Bitvec *pInJournal; /* One bit for each page in the database file */
  44116. sqlite3_file *fd; /* File descriptor for database */
  44117. sqlite3_file *jfd; /* File descriptor for main journal */
  44118. sqlite3_file *sjfd; /* File descriptor for sub-journal */
  44119. i64 journalOff; /* Current write offset in the journal file */
  44120. i64 journalHdr; /* Byte offset to previous journal header */
  44121. sqlite3_backup *pBackup; /* Pointer to list of ongoing backup processes */
  44122. PagerSavepoint *aSavepoint; /* Array of active savepoints */
  44123. int nSavepoint; /* Number of elements in aSavepoint[] */
  44124. u32 iDataVersion; /* Changes whenever database content changes */
  44125. char dbFileVers[16]; /* Changes whenever database file changes */
  44126. int nMmapOut; /* Number of mmap pages currently outstanding */
  44127. sqlite3_int64 szMmap; /* Desired maximum mmap size */
  44128. PgHdr *pMmapFreelist; /* List of free mmap page headers (pDirty) */
  44129. /*
  44130. ** End of the routinely-changing class members
  44131. ***************************************************************************/
  44132. u16 nExtra; /* Add this many bytes to each in-memory page */
  44133. i16 nReserve; /* Number of unused bytes at end of each page */
  44134. u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
  44135. u32 sectorSize; /* Assumed sector size during rollback */
  44136. int pageSize; /* Number of bytes in a page */
  44137. Pgno mxPgno; /* Maximum allowed size of the database */
  44138. i64 journalSizeLimit; /* Size limit for persistent journal files */
  44139. char *zFilename; /* Name of the database file */
  44140. char *zJournal; /* Name of the journal file */
  44141. int (*xBusyHandler)(void*); /* Function to call when busy */
  44142. void *pBusyHandlerArg; /* Context argument for xBusyHandler */
  44143. int aStat[3]; /* Total cache hits, misses and writes */
  44144. #ifdef SQLITE_TEST
  44145. int nRead; /* Database pages read */
  44146. #endif
  44147. void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
  44148. #ifdef SQLITE_HAS_CODEC
  44149. void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
  44150. void (*xCodecSizeChng)(void*,int,int); /* Notify of page size changes */
  44151. void (*xCodecFree)(void*); /* Destructor for the codec */
  44152. void *pCodec; /* First argument to xCodec... methods */
  44153. #endif
  44154. char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
  44155. PCache *pPCache; /* Pointer to page cache object */
  44156. #ifndef SQLITE_OMIT_WAL
  44157. Wal *pWal; /* Write-ahead log used by "journal_mode=wal" */
  44158. char *zWal; /* File name for write-ahead log */
  44159. #endif
  44160. };
  44161. /*
  44162. ** Indexes for use with Pager.aStat[]. The Pager.aStat[] array contains
  44163. ** the values accessed by passing SQLITE_DBSTATUS_CACHE_HIT, CACHE_MISS
  44164. ** or CACHE_WRITE to sqlite3_db_status().
  44165. */
  44166. #define PAGER_STAT_HIT 0
  44167. #define PAGER_STAT_MISS 1
  44168. #define PAGER_STAT_WRITE 2
  44169. /*
  44170. ** The following global variables hold counters used for
  44171. ** testing purposes only. These variables do not exist in
  44172. ** a non-testing build. These variables are not thread-safe.
  44173. */
  44174. #ifdef SQLITE_TEST
  44175. SQLITE_API int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
  44176. SQLITE_API int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
  44177. SQLITE_API int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
  44178. # define PAGER_INCR(v) v++
  44179. #else
  44180. # define PAGER_INCR(v)
  44181. #endif
  44182. /*
  44183. ** Journal files begin with the following magic string. The data
  44184. ** was obtained from /dev/random. It is used only as a sanity check.
  44185. **
  44186. ** Since version 2.8.0, the journal format contains additional sanity
  44187. ** checking information. If the power fails while the journal is being
  44188. ** written, semi-random garbage data might appear in the journal
  44189. ** file after power is restored. If an attempt is then made
  44190. ** to roll the journal back, the database could be corrupted. The additional
  44191. ** sanity checking data is an attempt to discover the garbage in the
  44192. ** journal and ignore it.
  44193. **
  44194. ** The sanity checking information for the new journal format consists
  44195. ** of a 32-bit checksum on each page of data. The checksum covers both
  44196. ** the page number and the pPager->pageSize bytes of data for the page.
  44197. ** This cksum is initialized to a 32-bit random value that appears in the
  44198. ** journal file right after the header. The random initializer is important,
  44199. ** because garbage data that appears at the end of a journal is likely
  44200. ** data that was once in other files that have now been deleted. If the
  44201. ** garbage data came from an obsolete journal file, the checksums might
  44202. ** be correct. But by initializing the checksum to random value which
  44203. ** is different for every journal, we minimize that risk.
  44204. */
  44205. static const unsigned char aJournalMagic[] = {
  44206. 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
  44207. };
  44208. /*
  44209. ** The size of the of each page record in the journal is given by
  44210. ** the following macro.
  44211. */
  44212. #define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
  44213. /*
  44214. ** The journal header size for this pager. This is usually the same
  44215. ** size as a single disk sector. See also setSectorSize().
  44216. */
  44217. #define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
  44218. /*
  44219. ** The macro MEMDB is true if we are dealing with an in-memory database.
  44220. ** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
  44221. ** the value of MEMDB will be a constant and the compiler will optimize
  44222. ** out code that would never execute.
  44223. */
  44224. #ifdef SQLITE_OMIT_MEMORYDB
  44225. # define MEMDB 0
  44226. #else
  44227. # define MEMDB pPager->memDb
  44228. #endif
  44229. /*
  44230. ** The macro USEFETCH is true if we are allowed to use the xFetch and xUnfetch
  44231. ** interfaces to access the database using memory-mapped I/O.
  44232. */
  44233. #if SQLITE_MAX_MMAP_SIZE>0
  44234. # define USEFETCH(x) ((x)->bUseFetch)
  44235. #else
  44236. # define USEFETCH(x) 0
  44237. #endif
  44238. /*
  44239. ** The maximum legal page number is (2^31 - 1).
  44240. */
  44241. #define PAGER_MAX_PGNO 2147483647
  44242. /*
  44243. ** The argument to this macro is a file descriptor (type sqlite3_file*).
  44244. ** Return 0 if it is not open, or non-zero (but not 1) if it is.
  44245. **
  44246. ** This is so that expressions can be written as:
  44247. **
  44248. ** if( isOpen(pPager->jfd) ){ ...
  44249. **
  44250. ** instead of
  44251. **
  44252. ** if( pPager->jfd->pMethods ){ ...
  44253. */
  44254. #define isOpen(pFd) ((pFd)->pMethods!=0)
  44255. /*
  44256. ** Return true if this pager uses a write-ahead log instead of the usual
  44257. ** rollback journal. Otherwise false.
  44258. */
  44259. #ifndef SQLITE_OMIT_WAL
  44260. SQLITE_PRIVATE int sqlite3PagerUseWal(Pager *pPager){
  44261. return (pPager->pWal!=0);
  44262. }
  44263. # define pagerUseWal(x) sqlite3PagerUseWal(x)
  44264. #else
  44265. # define pagerUseWal(x) 0
  44266. # define pagerRollbackWal(x) 0
  44267. # define pagerWalFrames(v,w,x,y) 0
  44268. # define pagerOpenWalIfPresent(z) SQLITE_OK
  44269. # define pagerBeginReadTransaction(z) SQLITE_OK
  44270. #endif
  44271. #ifndef NDEBUG
  44272. /*
  44273. ** Usage:
  44274. **
  44275. ** assert( assert_pager_state(pPager) );
  44276. **
  44277. ** This function runs many asserts to try to find inconsistencies in
  44278. ** the internal state of the Pager object.
  44279. */
  44280. static int assert_pager_state(Pager *p){
  44281. Pager *pPager = p;
  44282. /* State must be valid. */
  44283. assert( p->eState==PAGER_OPEN
  44284. || p->eState==PAGER_READER
  44285. || p->eState==PAGER_WRITER_LOCKED
  44286. || p->eState==PAGER_WRITER_CACHEMOD
  44287. || p->eState==PAGER_WRITER_DBMOD
  44288. || p->eState==PAGER_WRITER_FINISHED
  44289. || p->eState==PAGER_ERROR
  44290. );
  44291. /* Regardless of the current state, a temp-file connection always behaves
  44292. ** as if it has an exclusive lock on the database file. It never updates
  44293. ** the change-counter field, so the changeCountDone flag is always set.
  44294. */
  44295. assert( p->tempFile==0 || p->eLock==EXCLUSIVE_LOCK );
  44296. assert( p->tempFile==0 || pPager->changeCountDone );
  44297. /* If the useJournal flag is clear, the journal-mode must be "OFF".
  44298. ** And if the journal-mode is "OFF", the journal file must not be open.
  44299. */
  44300. assert( p->journalMode==PAGER_JOURNALMODE_OFF || p->useJournal );
  44301. assert( p->journalMode!=PAGER_JOURNALMODE_OFF || !isOpen(p->jfd) );
  44302. /* Check that MEMDB implies noSync. And an in-memory journal. Since
  44303. ** this means an in-memory pager performs no IO at all, it cannot encounter
  44304. ** either SQLITE_IOERR or SQLITE_FULL during rollback or while finalizing
  44305. ** a journal file. (although the in-memory journal implementation may
  44306. ** return SQLITE_IOERR_NOMEM while the journal file is being written). It
  44307. ** is therefore not possible for an in-memory pager to enter the ERROR
  44308. ** state.
  44309. */
  44310. if( MEMDB ){
  44311. assert( !isOpen(p->fd) );
  44312. assert( p->noSync );
  44313. assert( p->journalMode==PAGER_JOURNALMODE_OFF
  44314. || p->journalMode==PAGER_JOURNALMODE_MEMORY
  44315. );
  44316. assert( p->eState!=PAGER_ERROR && p->eState!=PAGER_OPEN );
  44317. assert( pagerUseWal(p)==0 );
  44318. }
  44319. /* If changeCountDone is set, a RESERVED lock or greater must be held
  44320. ** on the file.
  44321. */
  44322. assert( pPager->changeCountDone==0 || pPager->eLock>=RESERVED_LOCK );
  44323. assert( p->eLock!=PENDING_LOCK );
  44324. switch( p->eState ){
  44325. case PAGER_OPEN:
  44326. assert( !MEMDB );
  44327. assert( pPager->errCode==SQLITE_OK );
  44328. assert( sqlite3PcacheRefCount(pPager->pPCache)==0 || pPager->tempFile );
  44329. break;
  44330. case PAGER_READER:
  44331. assert( pPager->errCode==SQLITE_OK );
  44332. assert( p->eLock!=UNKNOWN_LOCK );
  44333. assert( p->eLock>=SHARED_LOCK );
  44334. break;
  44335. case PAGER_WRITER_LOCKED:
  44336. assert( p->eLock!=UNKNOWN_LOCK );
  44337. assert( pPager->errCode==SQLITE_OK );
  44338. if( !pagerUseWal(pPager) ){
  44339. assert( p->eLock>=RESERVED_LOCK );
  44340. }
  44341. assert( pPager->dbSize==pPager->dbOrigSize );
  44342. assert( pPager->dbOrigSize==pPager->dbFileSize );
  44343. assert( pPager->dbOrigSize==pPager->dbHintSize );
  44344. assert( pPager->setMaster==0 );
  44345. break;
  44346. case PAGER_WRITER_CACHEMOD:
  44347. assert( p->eLock!=UNKNOWN_LOCK );
  44348. assert( pPager->errCode==SQLITE_OK );
  44349. if( !pagerUseWal(pPager) ){
  44350. /* It is possible that if journal_mode=wal here that neither the
  44351. ** journal file nor the WAL file are open. This happens during
  44352. ** a rollback transaction that switches from journal_mode=off
  44353. ** to journal_mode=wal.
  44354. */
  44355. assert( p->eLock>=RESERVED_LOCK );
  44356. assert( isOpen(p->jfd)
  44357. || p->journalMode==PAGER_JOURNALMODE_OFF
  44358. || p->journalMode==PAGER_JOURNALMODE_WAL
  44359. );
  44360. }
  44361. assert( pPager->dbOrigSize==pPager->dbFileSize );
  44362. assert( pPager->dbOrigSize==pPager->dbHintSize );
  44363. break;
  44364. case PAGER_WRITER_DBMOD:
  44365. assert( p->eLock==EXCLUSIVE_LOCK );
  44366. assert( pPager->errCode==SQLITE_OK );
  44367. assert( !pagerUseWal(pPager) );
  44368. assert( p->eLock>=EXCLUSIVE_LOCK );
  44369. assert( isOpen(p->jfd)
  44370. || p->journalMode==PAGER_JOURNALMODE_OFF
  44371. || p->journalMode==PAGER_JOURNALMODE_WAL
  44372. );
  44373. assert( pPager->dbOrigSize<=pPager->dbHintSize );
  44374. break;
  44375. case PAGER_WRITER_FINISHED:
  44376. assert( p->eLock==EXCLUSIVE_LOCK );
  44377. assert( pPager->errCode==SQLITE_OK );
  44378. assert( !pagerUseWal(pPager) );
  44379. assert( isOpen(p->jfd)
  44380. || p->journalMode==PAGER_JOURNALMODE_OFF
  44381. || p->journalMode==PAGER_JOURNALMODE_WAL
  44382. );
  44383. break;
  44384. case PAGER_ERROR:
  44385. /* There must be at least one outstanding reference to the pager if
  44386. ** in ERROR state. Otherwise the pager should have already dropped
  44387. ** back to OPEN state.
  44388. */
  44389. assert( pPager->errCode!=SQLITE_OK );
  44390. assert( sqlite3PcacheRefCount(pPager->pPCache)>0 || pPager->tempFile );
  44391. break;
  44392. }
  44393. return 1;
  44394. }
  44395. #endif /* ifndef NDEBUG */
  44396. #ifdef SQLITE_DEBUG
  44397. /*
  44398. ** Return a pointer to a human readable string in a static buffer
  44399. ** containing the state of the Pager object passed as an argument. This
  44400. ** is intended to be used within debuggers. For example, as an alternative
  44401. ** to "print *pPager" in gdb:
  44402. **
  44403. ** (gdb) printf "%s", print_pager_state(pPager)
  44404. */
  44405. static char *print_pager_state(Pager *p){
  44406. static char zRet[1024];
  44407. sqlite3_snprintf(1024, zRet,
  44408. "Filename: %s\n"
  44409. "State: %s errCode=%d\n"
  44410. "Lock: %s\n"
  44411. "Locking mode: locking_mode=%s\n"
  44412. "Journal mode: journal_mode=%s\n"
  44413. "Backing store: tempFile=%d memDb=%d useJournal=%d\n"
  44414. "Journal: journalOff=%lld journalHdr=%lld\n"
  44415. "Size: dbsize=%d dbOrigSize=%d dbFileSize=%d\n"
  44416. , p->zFilename
  44417. , p->eState==PAGER_OPEN ? "OPEN" :
  44418. p->eState==PAGER_READER ? "READER" :
  44419. p->eState==PAGER_WRITER_LOCKED ? "WRITER_LOCKED" :
  44420. p->eState==PAGER_WRITER_CACHEMOD ? "WRITER_CACHEMOD" :
  44421. p->eState==PAGER_WRITER_DBMOD ? "WRITER_DBMOD" :
  44422. p->eState==PAGER_WRITER_FINISHED ? "WRITER_FINISHED" :
  44423. p->eState==PAGER_ERROR ? "ERROR" : "?error?"
  44424. , (int)p->errCode
  44425. , p->eLock==NO_LOCK ? "NO_LOCK" :
  44426. p->eLock==RESERVED_LOCK ? "RESERVED" :
  44427. p->eLock==EXCLUSIVE_LOCK ? "EXCLUSIVE" :
  44428. p->eLock==SHARED_LOCK ? "SHARED" :
  44429. p->eLock==UNKNOWN_LOCK ? "UNKNOWN" : "?error?"
  44430. , p->exclusiveMode ? "exclusive" : "normal"
  44431. , p->journalMode==PAGER_JOURNALMODE_MEMORY ? "memory" :
  44432. p->journalMode==PAGER_JOURNALMODE_OFF ? "off" :
  44433. p->journalMode==PAGER_JOURNALMODE_DELETE ? "delete" :
  44434. p->journalMode==PAGER_JOURNALMODE_PERSIST ? "persist" :
  44435. p->journalMode==PAGER_JOURNALMODE_TRUNCATE ? "truncate" :
  44436. p->journalMode==PAGER_JOURNALMODE_WAL ? "wal" : "?error?"
  44437. , (int)p->tempFile, (int)p->memDb, (int)p->useJournal
  44438. , p->journalOff, p->journalHdr
  44439. , (int)p->dbSize, (int)p->dbOrigSize, (int)p->dbFileSize
  44440. );
  44441. return zRet;
  44442. }
  44443. #endif
  44444. /*
  44445. ** Return true if it is necessary to write page *pPg into the sub-journal.
  44446. ** A page needs to be written into the sub-journal if there exists one
  44447. ** or more open savepoints for which:
  44448. **
  44449. ** * The page-number is less than or equal to PagerSavepoint.nOrig, and
  44450. ** * The bit corresponding to the page-number is not set in
  44451. ** PagerSavepoint.pInSavepoint.
  44452. */
  44453. static int subjRequiresPage(PgHdr *pPg){
  44454. Pager *pPager = pPg->pPager;
  44455. PagerSavepoint *p;
  44456. Pgno pgno = pPg->pgno;
  44457. int i;
  44458. for(i=0; i<pPager->nSavepoint; i++){
  44459. p = &pPager->aSavepoint[i];
  44460. if( p->nOrig>=pgno && 0==sqlite3BitvecTestNotNull(p->pInSavepoint, pgno) ){
  44461. return 1;
  44462. }
  44463. }
  44464. return 0;
  44465. }
  44466. #ifdef SQLITE_DEBUG
  44467. /*
  44468. ** Return true if the page is already in the journal file.
  44469. */
  44470. static int pageInJournal(Pager *pPager, PgHdr *pPg){
  44471. return sqlite3BitvecTest(pPager->pInJournal, pPg->pgno);
  44472. }
  44473. #endif
  44474. /*
  44475. ** Read a 32-bit integer from the given file descriptor. Store the integer
  44476. ** that is read in *pRes. Return SQLITE_OK if everything worked, or an
  44477. ** error code is something goes wrong.
  44478. **
  44479. ** All values are stored on disk as big-endian.
  44480. */
  44481. static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
  44482. unsigned char ac[4];
  44483. int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
  44484. if( rc==SQLITE_OK ){
  44485. *pRes = sqlite3Get4byte(ac);
  44486. }
  44487. return rc;
  44488. }
  44489. /*
  44490. ** Write a 32-bit integer into a string buffer in big-endian byte order.
  44491. */
  44492. #define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
  44493. /*
  44494. ** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
  44495. ** on success or an error code is something goes wrong.
  44496. */
  44497. static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
  44498. char ac[4];
  44499. put32bits(ac, val);
  44500. return sqlite3OsWrite(fd, ac, 4, offset);
  44501. }
  44502. /*
  44503. ** Unlock the database file to level eLock, which must be either NO_LOCK
  44504. ** or SHARED_LOCK. Regardless of whether or not the call to xUnlock()
  44505. ** succeeds, set the Pager.eLock variable to match the (attempted) new lock.
  44506. **
  44507. ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
  44508. ** called, do not modify it. See the comment above the #define of
  44509. ** UNKNOWN_LOCK for an explanation of this.
  44510. */
  44511. static int pagerUnlockDb(Pager *pPager, int eLock){
  44512. int rc = SQLITE_OK;
  44513. assert( !pPager->exclusiveMode || pPager->eLock==eLock );
  44514. assert( eLock==NO_LOCK || eLock==SHARED_LOCK );
  44515. assert( eLock!=NO_LOCK || pagerUseWal(pPager)==0 );
  44516. if( isOpen(pPager->fd) ){
  44517. assert( pPager->eLock>=eLock );
  44518. rc = pPager->noLock ? SQLITE_OK : sqlite3OsUnlock(pPager->fd, eLock);
  44519. if( pPager->eLock!=UNKNOWN_LOCK ){
  44520. pPager->eLock = (u8)eLock;
  44521. }
  44522. IOTRACE(("UNLOCK %p %d\n", pPager, eLock))
  44523. }
  44524. return rc;
  44525. }
  44526. /*
  44527. ** Lock the database file to level eLock, which must be either SHARED_LOCK,
  44528. ** RESERVED_LOCK or EXCLUSIVE_LOCK. If the caller is successful, set the
  44529. ** Pager.eLock variable to the new locking state.
  44530. **
  44531. ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
  44532. ** called, do not modify it unless the new locking state is EXCLUSIVE_LOCK.
  44533. ** See the comment above the #define of UNKNOWN_LOCK for an explanation
  44534. ** of this.
  44535. */
  44536. static int pagerLockDb(Pager *pPager, int eLock){
  44537. int rc = SQLITE_OK;
  44538. assert( eLock==SHARED_LOCK || eLock==RESERVED_LOCK || eLock==EXCLUSIVE_LOCK );
  44539. if( pPager->eLock<eLock || pPager->eLock==UNKNOWN_LOCK ){
  44540. rc = pPager->noLock ? SQLITE_OK : sqlite3OsLock(pPager->fd, eLock);
  44541. if( rc==SQLITE_OK && (pPager->eLock!=UNKNOWN_LOCK||eLock==EXCLUSIVE_LOCK) ){
  44542. pPager->eLock = (u8)eLock;
  44543. IOTRACE(("LOCK %p %d\n", pPager, eLock))
  44544. }
  44545. }
  44546. return rc;
  44547. }
  44548. /*
  44549. ** This function determines whether or not the atomic-write optimization
  44550. ** can be used with this pager. The optimization can be used if:
  44551. **
  44552. ** (a) the value returned by OsDeviceCharacteristics() indicates that
  44553. ** a database page may be written atomically, and
  44554. ** (b) the value returned by OsSectorSize() is less than or equal
  44555. ** to the page size.
  44556. **
  44557. ** The optimization is also always enabled for temporary files. It is
  44558. ** an error to call this function if pPager is opened on an in-memory
  44559. ** database.
  44560. **
  44561. ** If the optimization cannot be used, 0 is returned. If it can be used,
  44562. ** then the value returned is the size of the journal file when it
  44563. ** contains rollback data for exactly one page.
  44564. */
  44565. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  44566. static int jrnlBufferSize(Pager *pPager){
  44567. assert( !MEMDB );
  44568. if( !pPager->tempFile ){
  44569. int dc; /* Device characteristics */
  44570. int nSector; /* Sector size */
  44571. int szPage; /* Page size */
  44572. assert( isOpen(pPager->fd) );
  44573. dc = sqlite3OsDeviceCharacteristics(pPager->fd);
  44574. nSector = pPager->sectorSize;
  44575. szPage = pPager->pageSize;
  44576. assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
  44577. assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
  44578. if( 0==(dc&(SQLITE_IOCAP_ATOMIC|(szPage>>8)) || nSector>szPage) ){
  44579. return 0;
  44580. }
  44581. }
  44582. return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
  44583. }
  44584. #else
  44585. # define jrnlBufferSize(x) 0
  44586. #endif
  44587. /*
  44588. ** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
  44589. ** on the cache using a hash function. This is used for testing
  44590. ** and debugging only.
  44591. */
  44592. #ifdef SQLITE_CHECK_PAGES
  44593. /*
  44594. ** Return a 32-bit hash of the page data for pPage.
  44595. */
  44596. static u32 pager_datahash(int nByte, unsigned char *pData){
  44597. u32 hash = 0;
  44598. int i;
  44599. for(i=0; i<nByte; i++){
  44600. hash = (hash*1039) + pData[i];
  44601. }
  44602. return hash;
  44603. }
  44604. static u32 pager_pagehash(PgHdr *pPage){
  44605. return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
  44606. }
  44607. static void pager_set_pagehash(PgHdr *pPage){
  44608. pPage->pageHash = pager_pagehash(pPage);
  44609. }
  44610. /*
  44611. ** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
  44612. ** is defined, and NDEBUG is not defined, an assert() statement checks
  44613. ** that the page is either dirty or still matches the calculated page-hash.
  44614. */
  44615. #define CHECK_PAGE(x) checkPage(x)
  44616. static void checkPage(PgHdr *pPg){
  44617. Pager *pPager = pPg->pPager;
  44618. assert( pPager->eState!=PAGER_ERROR );
  44619. assert( (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
  44620. }
  44621. #else
  44622. #define pager_datahash(X,Y) 0
  44623. #define pager_pagehash(X) 0
  44624. #define pager_set_pagehash(X)
  44625. #define CHECK_PAGE(x)
  44626. #endif /* SQLITE_CHECK_PAGES */
  44627. /*
  44628. ** When this is called the journal file for pager pPager must be open.
  44629. ** This function attempts to read a master journal file name from the
  44630. ** end of the file and, if successful, copies it into memory supplied
  44631. ** by the caller. See comments above writeMasterJournal() for the format
  44632. ** used to store a master journal file name at the end of a journal file.
  44633. **
  44634. ** zMaster must point to a buffer of at least nMaster bytes allocated by
  44635. ** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
  44636. ** enough space to write the master journal name). If the master journal
  44637. ** name in the journal is longer than nMaster bytes (including a
  44638. ** nul-terminator), then this is handled as if no master journal name
  44639. ** were present in the journal.
  44640. **
  44641. ** If a master journal file name is present at the end of the journal
  44642. ** file, then it is copied into the buffer pointed to by zMaster. A
  44643. ** nul-terminator byte is appended to the buffer following the master
  44644. ** journal file name.
  44645. **
  44646. ** If it is determined that no master journal file name is present
  44647. ** zMaster[0] is set to 0 and SQLITE_OK returned.
  44648. **
  44649. ** If an error occurs while reading from the journal file, an SQLite
  44650. ** error code is returned.
  44651. */
  44652. static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
  44653. int rc; /* Return code */
  44654. u32 len; /* Length in bytes of master journal name */
  44655. i64 szJ; /* Total size in bytes of journal file pJrnl */
  44656. u32 cksum; /* MJ checksum value read from journal */
  44657. u32 u; /* Unsigned loop counter */
  44658. unsigned char aMagic[8]; /* A buffer to hold the magic header */
  44659. zMaster[0] = '\0';
  44660. if( SQLITE_OK!=(rc = sqlite3OsFileSize(pJrnl, &szJ))
  44661. || szJ<16
  44662. || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-16, &len))
  44663. || len>=nMaster
  44664. || len==0
  44665. || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-12, &cksum))
  44666. || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8))
  44667. || memcmp(aMagic, aJournalMagic, 8)
  44668. || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len))
  44669. ){
  44670. return rc;
  44671. }
  44672. /* See if the checksum matches the master journal name */
  44673. for(u=0; u<len; u++){
  44674. cksum -= zMaster[u];
  44675. }
  44676. if( cksum ){
  44677. /* If the checksum doesn't add up, then one or more of the disk sectors
  44678. ** containing the master journal filename is corrupted. This means
  44679. ** definitely roll back, so just return SQLITE_OK and report a (nul)
  44680. ** master-journal filename.
  44681. */
  44682. len = 0;
  44683. }
  44684. zMaster[len] = '\0';
  44685. return SQLITE_OK;
  44686. }
  44687. /*
  44688. ** Return the offset of the sector boundary at or immediately
  44689. ** following the value in pPager->journalOff, assuming a sector
  44690. ** size of pPager->sectorSize bytes.
  44691. **
  44692. ** i.e for a sector size of 512:
  44693. **
  44694. ** Pager.journalOff Return value
  44695. ** ---------------------------------------
  44696. ** 0 0
  44697. ** 512 512
  44698. ** 100 512
  44699. ** 2000 2048
  44700. **
  44701. */
  44702. static i64 journalHdrOffset(Pager *pPager){
  44703. i64 offset = 0;
  44704. i64 c = pPager->journalOff;
  44705. if( c ){
  44706. offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
  44707. }
  44708. assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
  44709. assert( offset>=c );
  44710. assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
  44711. return offset;
  44712. }
  44713. /*
  44714. ** The journal file must be open when this function is called.
  44715. **
  44716. ** This function is a no-op if the journal file has not been written to
  44717. ** within the current transaction (i.e. if Pager.journalOff==0).
  44718. **
  44719. ** If doTruncate is non-zero or the Pager.journalSizeLimit variable is
  44720. ** set to 0, then truncate the journal file to zero bytes in size. Otherwise,
  44721. ** zero the 28-byte header at the start of the journal file. In either case,
  44722. ** if the pager is not in no-sync mode, sync the journal file immediately
  44723. ** after writing or truncating it.
  44724. **
  44725. ** If Pager.journalSizeLimit is set to a positive, non-zero value, and
  44726. ** following the truncation or zeroing described above the size of the
  44727. ** journal file in bytes is larger than this value, then truncate the
  44728. ** journal file to Pager.journalSizeLimit bytes. The journal file does
  44729. ** not need to be synced following this operation.
  44730. **
  44731. ** If an IO error occurs, abandon processing and return the IO error code.
  44732. ** Otherwise, return SQLITE_OK.
  44733. */
  44734. static int zeroJournalHdr(Pager *pPager, int doTruncate){
  44735. int rc = SQLITE_OK; /* Return code */
  44736. assert( isOpen(pPager->jfd) );
  44737. assert( !sqlite3JournalIsInMemory(pPager->jfd) );
  44738. if( pPager->journalOff ){
  44739. const i64 iLimit = pPager->journalSizeLimit; /* Local cache of jsl */
  44740. IOTRACE(("JZEROHDR %p\n", pPager))
  44741. if( doTruncate || iLimit==0 ){
  44742. rc = sqlite3OsTruncate(pPager->jfd, 0);
  44743. }else{
  44744. static const char zeroHdr[28] = {0};
  44745. rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
  44746. }
  44747. if( rc==SQLITE_OK && !pPager->noSync ){
  44748. rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->syncFlags);
  44749. }
  44750. /* At this point the transaction is committed but the write lock
  44751. ** is still held on the file. If there is a size limit configured for
  44752. ** the persistent journal and the journal file currently consumes more
  44753. ** space than that limit allows for, truncate it now. There is no need
  44754. ** to sync the file following this operation.
  44755. */
  44756. if( rc==SQLITE_OK && iLimit>0 ){
  44757. i64 sz;
  44758. rc = sqlite3OsFileSize(pPager->jfd, &sz);
  44759. if( rc==SQLITE_OK && sz>iLimit ){
  44760. rc = sqlite3OsTruncate(pPager->jfd, iLimit);
  44761. }
  44762. }
  44763. }
  44764. return rc;
  44765. }
  44766. /*
  44767. ** The journal file must be open when this routine is called. A journal
  44768. ** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
  44769. ** current location.
  44770. **
  44771. ** The format for the journal header is as follows:
  44772. ** - 8 bytes: Magic identifying journal format.
  44773. ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
  44774. ** - 4 bytes: Random number used for page hash.
  44775. ** - 4 bytes: Initial database page count.
  44776. ** - 4 bytes: Sector size used by the process that wrote this journal.
  44777. ** - 4 bytes: Database page size.
  44778. **
  44779. ** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
  44780. */
  44781. static int writeJournalHdr(Pager *pPager){
  44782. int rc = SQLITE_OK; /* Return code */
  44783. char *zHeader = pPager->pTmpSpace; /* Temporary space used to build header */
  44784. u32 nHeader = (u32)pPager->pageSize;/* Size of buffer pointed to by zHeader */
  44785. u32 nWrite; /* Bytes of header sector written */
  44786. int ii; /* Loop counter */
  44787. assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
  44788. if( nHeader>JOURNAL_HDR_SZ(pPager) ){
  44789. nHeader = JOURNAL_HDR_SZ(pPager);
  44790. }
  44791. /* If there are active savepoints and any of them were created
  44792. ** since the most recent journal header was written, update the
  44793. ** PagerSavepoint.iHdrOffset fields now.
  44794. */
  44795. for(ii=0; ii<pPager->nSavepoint; ii++){
  44796. if( pPager->aSavepoint[ii].iHdrOffset==0 ){
  44797. pPager->aSavepoint[ii].iHdrOffset = pPager->journalOff;
  44798. }
  44799. }
  44800. pPager->journalHdr = pPager->journalOff = journalHdrOffset(pPager);
  44801. /*
  44802. ** Write the nRec Field - the number of page records that follow this
  44803. ** journal header. Normally, zero is written to this value at this time.
  44804. ** After the records are added to the journal (and the journal synced,
  44805. ** if in full-sync mode), the zero is overwritten with the true number
  44806. ** of records (see syncJournal()).
  44807. **
  44808. ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
  44809. ** reading the journal this value tells SQLite to assume that the
  44810. ** rest of the journal file contains valid page records. This assumption
  44811. ** is dangerous, as if a failure occurred whilst writing to the journal
  44812. ** file it may contain some garbage data. There are two scenarios
  44813. ** where this risk can be ignored:
  44814. **
  44815. ** * When the pager is in no-sync mode. Corruption can follow a
  44816. ** power failure in this case anyway.
  44817. **
  44818. ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
  44819. ** that garbage data is never appended to the journal file.
  44820. */
  44821. assert( isOpen(pPager->fd) || pPager->noSync );
  44822. if( pPager->noSync || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
  44823. || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
  44824. ){
  44825. memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
  44826. put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
  44827. }else{
  44828. memset(zHeader, 0, sizeof(aJournalMagic)+4);
  44829. }
  44830. /* The random check-hash initializer */
  44831. sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
  44832. put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
  44833. /* The initial database size */
  44834. put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbOrigSize);
  44835. /* The assumed sector size for this process */
  44836. put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
  44837. /* The page size */
  44838. put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
  44839. /* Initializing the tail of the buffer is not necessary. Everything
  44840. ** works find if the following memset() is omitted. But initializing
  44841. ** the memory prevents valgrind from complaining, so we are willing to
  44842. ** take the performance hit.
  44843. */
  44844. memset(&zHeader[sizeof(aJournalMagic)+20], 0,
  44845. nHeader-(sizeof(aJournalMagic)+20));
  44846. /* In theory, it is only necessary to write the 28 bytes that the
  44847. ** journal header consumes to the journal file here. Then increment the
  44848. ** Pager.journalOff variable by JOURNAL_HDR_SZ so that the next
  44849. ** record is written to the following sector (leaving a gap in the file
  44850. ** that will be implicitly filled in by the OS).
  44851. **
  44852. ** However it has been discovered that on some systems this pattern can
  44853. ** be significantly slower than contiguously writing data to the file,
  44854. ** even if that means explicitly writing data to the block of
  44855. ** (JOURNAL_HDR_SZ - 28) bytes that will not be used. So that is what
  44856. ** is done.
  44857. **
  44858. ** The loop is required here in case the sector-size is larger than the
  44859. ** database page size. Since the zHeader buffer is only Pager.pageSize
  44860. ** bytes in size, more than one call to sqlite3OsWrite() may be required
  44861. ** to populate the entire journal header sector.
  44862. */
  44863. for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
  44864. IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
  44865. rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
  44866. assert( pPager->journalHdr <= pPager->journalOff );
  44867. pPager->journalOff += nHeader;
  44868. }
  44869. return rc;
  44870. }
  44871. /*
  44872. ** The journal file must be open when this is called. A journal header file
  44873. ** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
  44874. ** file. The current location in the journal file is given by
  44875. ** pPager->journalOff. See comments above function writeJournalHdr() for
  44876. ** a description of the journal header format.
  44877. **
  44878. ** If the header is read successfully, *pNRec is set to the number of
  44879. ** page records following this header and *pDbSize is set to the size of the
  44880. ** database before the transaction began, in pages. Also, pPager->cksumInit
  44881. ** is set to the value read from the journal header. SQLITE_OK is returned
  44882. ** in this case.
  44883. **
  44884. ** If the journal header file appears to be corrupted, SQLITE_DONE is
  44885. ** returned and *pNRec and *PDbSize are undefined. If JOURNAL_HDR_SZ bytes
  44886. ** cannot be read from the journal file an error code is returned.
  44887. */
  44888. static int readJournalHdr(
  44889. Pager *pPager, /* Pager object */
  44890. int isHot,
  44891. i64 journalSize, /* Size of the open journal file in bytes */
  44892. u32 *pNRec, /* OUT: Value read from the nRec field */
  44893. u32 *pDbSize /* OUT: Value of original database size field */
  44894. ){
  44895. int rc; /* Return code */
  44896. unsigned char aMagic[8]; /* A buffer to hold the magic header */
  44897. i64 iHdrOff; /* Offset of journal header being read */
  44898. assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
  44899. /* Advance Pager.journalOff to the start of the next sector. If the
  44900. ** journal file is too small for there to be a header stored at this
  44901. ** point, return SQLITE_DONE.
  44902. */
  44903. pPager->journalOff = journalHdrOffset(pPager);
  44904. if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
  44905. return SQLITE_DONE;
  44906. }
  44907. iHdrOff = pPager->journalOff;
  44908. /* Read in the first 8 bytes of the journal header. If they do not match
  44909. ** the magic string found at the start of each journal header, return
  44910. ** SQLITE_DONE. If an IO error occurs, return an error code. Otherwise,
  44911. ** proceed.
  44912. */
  44913. if( isHot || iHdrOff!=pPager->journalHdr ){
  44914. rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), iHdrOff);
  44915. if( rc ){
  44916. return rc;
  44917. }
  44918. if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
  44919. return SQLITE_DONE;
  44920. }
  44921. }
  44922. /* Read the first three 32-bit fields of the journal header: The nRec
  44923. ** field, the checksum-initializer and the database size at the start
  44924. ** of the transaction. Return an error code if anything goes wrong.
  44925. */
  44926. if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+8, pNRec))
  44927. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+12, &pPager->cksumInit))
  44928. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+16, pDbSize))
  44929. ){
  44930. return rc;
  44931. }
  44932. if( pPager->journalOff==0 ){
  44933. u32 iPageSize; /* Page-size field of journal header */
  44934. u32 iSectorSize; /* Sector-size field of journal header */
  44935. /* Read the page-size and sector-size journal header fields. */
  44936. if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+20, &iSectorSize))
  44937. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+24, &iPageSize))
  44938. ){
  44939. return rc;
  44940. }
  44941. /* Versions of SQLite prior to 3.5.8 set the page-size field of the
  44942. ** journal header to zero. In this case, assume that the Pager.pageSize
  44943. ** variable is already set to the correct page size.
  44944. */
  44945. if( iPageSize==0 ){
  44946. iPageSize = pPager->pageSize;
  44947. }
  44948. /* Check that the values read from the page-size and sector-size fields
  44949. ** are within range. To be 'in range', both values need to be a power
  44950. ** of two greater than or equal to 512 or 32, and not greater than their
  44951. ** respective compile time maximum limits.
  44952. */
  44953. if( iPageSize<512 || iSectorSize<32
  44954. || iPageSize>SQLITE_MAX_PAGE_SIZE || iSectorSize>MAX_SECTOR_SIZE
  44955. || ((iPageSize-1)&iPageSize)!=0 || ((iSectorSize-1)&iSectorSize)!=0
  44956. ){
  44957. /* If the either the page-size or sector-size in the journal-header is
  44958. ** invalid, then the process that wrote the journal-header must have
  44959. ** crashed before the header was synced. In this case stop reading
  44960. ** the journal file here.
  44961. */
  44962. return SQLITE_DONE;
  44963. }
  44964. /* Update the page-size to match the value read from the journal.
  44965. ** Use a testcase() macro to make sure that malloc failure within
  44966. ** PagerSetPagesize() is tested.
  44967. */
  44968. rc = sqlite3PagerSetPagesize(pPager, &iPageSize, -1);
  44969. testcase( rc!=SQLITE_OK );
  44970. /* Update the assumed sector-size to match the value used by
  44971. ** the process that created this journal. If this journal was
  44972. ** created by a process other than this one, then this routine
  44973. ** is being called from within pager_playback(). The local value
  44974. ** of Pager.sectorSize is restored at the end of that routine.
  44975. */
  44976. pPager->sectorSize = iSectorSize;
  44977. }
  44978. pPager->journalOff += JOURNAL_HDR_SZ(pPager);
  44979. return rc;
  44980. }
  44981. /*
  44982. ** Write the supplied master journal name into the journal file for pager
  44983. ** pPager at the current location. The master journal name must be the last
  44984. ** thing written to a journal file. If the pager is in full-sync mode, the
  44985. ** journal file descriptor is advanced to the next sector boundary before
  44986. ** anything is written. The format is:
  44987. **
  44988. ** + 4 bytes: PAGER_MJ_PGNO.
  44989. ** + N bytes: Master journal filename in utf-8.
  44990. ** + 4 bytes: N (length of master journal name in bytes, no nul-terminator).
  44991. ** + 4 bytes: Master journal name checksum.
  44992. ** + 8 bytes: aJournalMagic[].
  44993. **
  44994. ** The master journal page checksum is the sum of the bytes in the master
  44995. ** journal name, where each byte is interpreted as a signed 8-bit integer.
  44996. **
  44997. ** If zMaster is a NULL pointer (occurs for a single database transaction),
  44998. ** this call is a no-op.
  44999. */
  45000. static int writeMasterJournal(Pager *pPager, const char *zMaster){
  45001. int rc; /* Return code */
  45002. int nMaster; /* Length of string zMaster */
  45003. i64 iHdrOff; /* Offset of header in journal file */
  45004. i64 jrnlSize; /* Size of journal file on disk */
  45005. u32 cksum = 0; /* Checksum of string zMaster */
  45006. assert( pPager->setMaster==0 );
  45007. assert( !pagerUseWal(pPager) );
  45008. if( !zMaster
  45009. || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
  45010. || !isOpen(pPager->jfd)
  45011. ){
  45012. return SQLITE_OK;
  45013. }
  45014. pPager->setMaster = 1;
  45015. assert( pPager->journalHdr <= pPager->journalOff );
  45016. /* Calculate the length in bytes and the checksum of zMaster */
  45017. for(nMaster=0; zMaster[nMaster]; nMaster++){
  45018. cksum += zMaster[nMaster];
  45019. }
  45020. /* If in full-sync mode, advance to the next disk sector before writing
  45021. ** the master journal name. This is in case the previous page written to
  45022. ** the journal has already been synced.
  45023. */
  45024. if( pPager->fullSync ){
  45025. pPager->journalOff = journalHdrOffset(pPager);
  45026. }
  45027. iHdrOff = pPager->journalOff;
  45028. /* Write the master journal data to the end of the journal file. If
  45029. ** an error occurs, return the error code to the caller.
  45030. */
  45031. if( (0 != (rc = write32bits(pPager->jfd, iHdrOff, PAGER_MJ_PGNO(pPager))))
  45032. || (0 != (rc = sqlite3OsWrite(pPager->jfd, zMaster, nMaster, iHdrOff+4)))
  45033. || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster, nMaster)))
  45034. || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster+4, cksum)))
  45035. || (0 != (rc = sqlite3OsWrite(pPager->jfd, aJournalMagic, 8,
  45036. iHdrOff+4+nMaster+8)))
  45037. ){
  45038. return rc;
  45039. }
  45040. pPager->journalOff += (nMaster+20);
  45041. /* If the pager is in peristent-journal mode, then the physical
  45042. ** journal-file may extend past the end of the master-journal name
  45043. ** and 8 bytes of magic data just written to the file. This is
  45044. ** dangerous because the code to rollback a hot-journal file
  45045. ** will not be able to find the master-journal name to determine
  45046. ** whether or not the journal is hot.
  45047. **
  45048. ** Easiest thing to do in this scenario is to truncate the journal
  45049. ** file to the required size.
  45050. */
  45051. if( SQLITE_OK==(rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))
  45052. && jrnlSize>pPager->journalOff
  45053. ){
  45054. rc = sqlite3OsTruncate(pPager->jfd, pPager->journalOff);
  45055. }
  45056. return rc;
  45057. }
  45058. /*
  45059. ** Discard the entire contents of the in-memory page-cache.
  45060. */
  45061. static void pager_reset(Pager *pPager){
  45062. pPager->iDataVersion++;
  45063. sqlite3BackupRestart(pPager->pBackup);
  45064. sqlite3PcacheClear(pPager->pPCache);
  45065. }
  45066. /*
  45067. ** Return the pPager->iDataVersion value
  45068. */
  45069. SQLITE_PRIVATE u32 sqlite3PagerDataVersion(Pager *pPager){
  45070. assert( pPager->eState>PAGER_OPEN );
  45071. return pPager->iDataVersion;
  45072. }
  45073. /*
  45074. ** Free all structures in the Pager.aSavepoint[] array and set both
  45075. ** Pager.aSavepoint and Pager.nSavepoint to zero. Close the sub-journal
  45076. ** if it is open and the pager is not in exclusive mode.
  45077. */
  45078. static void releaseAllSavepoints(Pager *pPager){
  45079. int ii; /* Iterator for looping through Pager.aSavepoint */
  45080. for(ii=0; ii<pPager->nSavepoint; ii++){
  45081. sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
  45082. }
  45083. if( !pPager->exclusiveMode || sqlite3JournalIsInMemory(pPager->sjfd) ){
  45084. sqlite3OsClose(pPager->sjfd);
  45085. }
  45086. sqlite3_free(pPager->aSavepoint);
  45087. pPager->aSavepoint = 0;
  45088. pPager->nSavepoint = 0;
  45089. pPager->nSubRec = 0;
  45090. }
  45091. /*
  45092. ** Set the bit number pgno in the PagerSavepoint.pInSavepoint
  45093. ** bitvecs of all open savepoints. Return SQLITE_OK if successful
  45094. ** or SQLITE_NOMEM if a malloc failure occurs.
  45095. */
  45096. static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
  45097. int ii; /* Loop counter */
  45098. int rc = SQLITE_OK; /* Result code */
  45099. for(ii=0; ii<pPager->nSavepoint; ii++){
  45100. PagerSavepoint *p = &pPager->aSavepoint[ii];
  45101. if( pgno<=p->nOrig ){
  45102. rc |= sqlite3BitvecSet(p->pInSavepoint, pgno);
  45103. testcase( rc==SQLITE_NOMEM );
  45104. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  45105. }
  45106. }
  45107. return rc;
  45108. }
  45109. /*
  45110. ** This function is a no-op if the pager is in exclusive mode and not
  45111. ** in the ERROR state. Otherwise, it switches the pager to PAGER_OPEN
  45112. ** state.
  45113. **
  45114. ** If the pager is not in exclusive-access mode, the database file is
  45115. ** completely unlocked. If the file is unlocked and the file-system does
  45116. ** not exhibit the UNDELETABLE_WHEN_OPEN property, the journal file is
  45117. ** closed (if it is open).
  45118. **
  45119. ** If the pager is in ERROR state when this function is called, the
  45120. ** contents of the pager cache are discarded before switching back to
  45121. ** the OPEN state. Regardless of whether the pager is in exclusive-mode
  45122. ** or not, any journal file left in the file-system will be treated
  45123. ** as a hot-journal and rolled back the next time a read-transaction
  45124. ** is opened (by this or by any other connection).
  45125. */
  45126. static void pager_unlock(Pager *pPager){
  45127. assert( pPager->eState==PAGER_READER
  45128. || pPager->eState==PAGER_OPEN
  45129. || pPager->eState==PAGER_ERROR
  45130. );
  45131. sqlite3BitvecDestroy(pPager->pInJournal);
  45132. pPager->pInJournal = 0;
  45133. releaseAllSavepoints(pPager);
  45134. if( pagerUseWal(pPager) ){
  45135. assert( !isOpen(pPager->jfd) );
  45136. sqlite3WalEndReadTransaction(pPager->pWal);
  45137. pPager->eState = PAGER_OPEN;
  45138. }else if( !pPager->exclusiveMode ){
  45139. int rc; /* Error code returned by pagerUnlockDb() */
  45140. int iDc = isOpen(pPager->fd)?sqlite3OsDeviceCharacteristics(pPager->fd):0;
  45141. /* If the operating system support deletion of open files, then
  45142. ** close the journal file when dropping the database lock. Otherwise
  45143. ** another connection with journal_mode=delete might delete the file
  45144. ** out from under us.
  45145. */
  45146. assert( (PAGER_JOURNALMODE_MEMORY & 5)!=1 );
  45147. assert( (PAGER_JOURNALMODE_OFF & 5)!=1 );
  45148. assert( (PAGER_JOURNALMODE_WAL & 5)!=1 );
  45149. assert( (PAGER_JOURNALMODE_DELETE & 5)!=1 );
  45150. assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
  45151. assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
  45152. if( 0==(iDc & SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN)
  45153. || 1!=(pPager->journalMode & 5)
  45154. ){
  45155. sqlite3OsClose(pPager->jfd);
  45156. }
  45157. /* If the pager is in the ERROR state and the call to unlock the database
  45158. ** file fails, set the current lock to UNKNOWN_LOCK. See the comment
  45159. ** above the #define for UNKNOWN_LOCK for an explanation of why this
  45160. ** is necessary.
  45161. */
  45162. rc = pagerUnlockDb(pPager, NO_LOCK);
  45163. if( rc!=SQLITE_OK && pPager->eState==PAGER_ERROR ){
  45164. pPager->eLock = UNKNOWN_LOCK;
  45165. }
  45166. /* The pager state may be changed from PAGER_ERROR to PAGER_OPEN here
  45167. ** without clearing the error code. This is intentional - the error
  45168. ** code is cleared and the cache reset in the block below.
  45169. */
  45170. assert( pPager->errCode || pPager->eState!=PAGER_ERROR );
  45171. pPager->changeCountDone = 0;
  45172. pPager->eState = PAGER_OPEN;
  45173. }
  45174. /* If Pager.errCode is set, the contents of the pager cache cannot be
  45175. ** trusted. Now that there are no outstanding references to the pager,
  45176. ** it can safely move back to PAGER_OPEN state. This happens in both
  45177. ** normal and exclusive-locking mode.
  45178. */
  45179. assert( pPager->errCode==SQLITE_OK || !MEMDB );
  45180. if( pPager->errCode ){
  45181. if( pPager->tempFile==0 ){
  45182. pager_reset(pPager);
  45183. pPager->changeCountDone = 0;
  45184. pPager->eState = PAGER_OPEN;
  45185. }else{
  45186. pPager->eState = (isOpen(pPager->jfd) ? PAGER_OPEN : PAGER_READER);
  45187. }
  45188. if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
  45189. pPager->errCode = SQLITE_OK;
  45190. }
  45191. pPager->journalOff = 0;
  45192. pPager->journalHdr = 0;
  45193. pPager->setMaster = 0;
  45194. }
  45195. /*
  45196. ** This function is called whenever an IOERR or FULL error that requires
  45197. ** the pager to transition into the ERROR state may ahve occurred.
  45198. ** The first argument is a pointer to the pager structure, the second
  45199. ** the error-code about to be returned by a pager API function. The
  45200. ** value returned is a copy of the second argument to this function.
  45201. **
  45202. ** If the second argument is SQLITE_FULL, SQLITE_IOERR or one of the
  45203. ** IOERR sub-codes, the pager enters the ERROR state and the error code
  45204. ** is stored in Pager.errCode. While the pager remains in the ERROR state,
  45205. ** all major API calls on the Pager will immediately return Pager.errCode.
  45206. **
  45207. ** The ERROR state indicates that the contents of the pager-cache
  45208. ** cannot be trusted. This state can be cleared by completely discarding
  45209. ** the contents of the pager-cache. If a transaction was active when
  45210. ** the persistent error occurred, then the rollback journal may need
  45211. ** to be replayed to restore the contents of the database file (as if
  45212. ** it were a hot-journal).
  45213. */
  45214. static int pager_error(Pager *pPager, int rc){
  45215. int rc2 = rc & 0xff;
  45216. assert( rc==SQLITE_OK || !MEMDB );
  45217. assert(
  45218. pPager->errCode==SQLITE_FULL ||
  45219. pPager->errCode==SQLITE_OK ||
  45220. (pPager->errCode & 0xff)==SQLITE_IOERR
  45221. );
  45222. if( rc2==SQLITE_FULL || rc2==SQLITE_IOERR ){
  45223. pPager->errCode = rc;
  45224. pPager->eState = PAGER_ERROR;
  45225. }
  45226. return rc;
  45227. }
  45228. static int pager_truncate(Pager *pPager, Pgno nPage);
  45229. /*
  45230. ** The write transaction open on pPager is being committed (bCommit==1)
  45231. ** or rolled back (bCommit==0).
  45232. **
  45233. ** Return TRUE if and only if all dirty pages should be flushed to disk.
  45234. **
  45235. ** Rules:
  45236. **
  45237. ** * For non-TEMP databases, always sync to disk. This is necessary
  45238. ** for transactions to be durable.
  45239. **
  45240. ** * Sync TEMP database only on a COMMIT (not a ROLLBACK) when the backing
  45241. ** file has been created already (via a spill on pagerStress()) and
  45242. ** when the number of dirty pages in memory exceeds 25% of the total
  45243. ** cache size.
  45244. */
  45245. static int pagerFlushOnCommit(Pager *pPager, int bCommit){
  45246. if( pPager->tempFile==0 ) return 1;
  45247. if( !bCommit ) return 0;
  45248. if( !isOpen(pPager->fd) ) return 0;
  45249. return (sqlite3PCachePercentDirty(pPager->pPCache)>=25);
  45250. }
  45251. /*
  45252. ** This routine ends a transaction. A transaction is usually ended by
  45253. ** either a COMMIT or a ROLLBACK operation. This routine may be called
  45254. ** after rollback of a hot-journal, or if an error occurs while opening
  45255. ** the journal file or writing the very first journal-header of a
  45256. ** database transaction.
  45257. **
  45258. ** This routine is never called in PAGER_ERROR state. If it is called
  45259. ** in PAGER_NONE or PAGER_SHARED state and the lock held is less
  45260. ** exclusive than a RESERVED lock, it is a no-op.
  45261. **
  45262. ** Otherwise, any active savepoints are released.
  45263. **
  45264. ** If the journal file is open, then it is "finalized". Once a journal
  45265. ** file has been finalized it is not possible to use it to roll back a
  45266. ** transaction. Nor will it be considered to be a hot-journal by this
  45267. ** or any other database connection. Exactly how a journal is finalized
  45268. ** depends on whether or not the pager is running in exclusive mode and
  45269. ** the current journal-mode (Pager.journalMode value), as follows:
  45270. **
  45271. ** journalMode==MEMORY
  45272. ** Journal file descriptor is simply closed. This destroys an
  45273. ** in-memory journal.
  45274. **
  45275. ** journalMode==TRUNCATE
  45276. ** Journal file is truncated to zero bytes in size.
  45277. **
  45278. ** journalMode==PERSIST
  45279. ** The first 28 bytes of the journal file are zeroed. This invalidates
  45280. ** the first journal header in the file, and hence the entire journal
  45281. ** file. An invalid journal file cannot be rolled back.
  45282. **
  45283. ** journalMode==DELETE
  45284. ** The journal file is closed and deleted using sqlite3OsDelete().
  45285. **
  45286. ** If the pager is running in exclusive mode, this method of finalizing
  45287. ** the journal file is never used. Instead, if the journalMode is
  45288. ** DELETE and the pager is in exclusive mode, the method described under
  45289. ** journalMode==PERSIST is used instead.
  45290. **
  45291. ** After the journal is finalized, the pager moves to PAGER_READER state.
  45292. ** If running in non-exclusive rollback mode, the lock on the file is
  45293. ** downgraded to a SHARED_LOCK.
  45294. **
  45295. ** SQLITE_OK is returned if no error occurs. If an error occurs during
  45296. ** any of the IO operations to finalize the journal file or unlock the
  45297. ** database then the IO error code is returned to the user. If the
  45298. ** operation to finalize the journal file fails, then the code still
  45299. ** tries to unlock the database file if not in exclusive mode. If the
  45300. ** unlock operation fails as well, then the first error code related
  45301. ** to the first error encountered (the journal finalization one) is
  45302. ** returned.
  45303. */
  45304. static int pager_end_transaction(Pager *pPager, int hasMaster, int bCommit){
  45305. int rc = SQLITE_OK; /* Error code from journal finalization operation */
  45306. int rc2 = SQLITE_OK; /* Error code from db file unlock operation */
  45307. /* Do nothing if the pager does not have an open write transaction
  45308. ** or at least a RESERVED lock. This function may be called when there
  45309. ** is no write-transaction active but a RESERVED or greater lock is
  45310. ** held under two circumstances:
  45311. **
  45312. ** 1. After a successful hot-journal rollback, it is called with
  45313. ** eState==PAGER_NONE and eLock==EXCLUSIVE_LOCK.
  45314. **
  45315. ** 2. If a connection with locking_mode=exclusive holding an EXCLUSIVE
  45316. ** lock switches back to locking_mode=normal and then executes a
  45317. ** read-transaction, this function is called with eState==PAGER_READER
  45318. ** and eLock==EXCLUSIVE_LOCK when the read-transaction is closed.
  45319. */
  45320. assert( assert_pager_state(pPager) );
  45321. assert( pPager->eState!=PAGER_ERROR );
  45322. if( pPager->eState<PAGER_WRITER_LOCKED && pPager->eLock<RESERVED_LOCK ){
  45323. return SQLITE_OK;
  45324. }
  45325. releaseAllSavepoints(pPager);
  45326. assert( isOpen(pPager->jfd) || pPager->pInJournal==0 );
  45327. if( isOpen(pPager->jfd) ){
  45328. assert( !pagerUseWal(pPager) );
  45329. /* Finalize the journal file. */
  45330. if( sqlite3JournalIsInMemory(pPager->jfd) ){
  45331. /* assert( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ); */
  45332. sqlite3OsClose(pPager->jfd);
  45333. }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE ){
  45334. if( pPager->journalOff==0 ){
  45335. rc = SQLITE_OK;
  45336. }else{
  45337. rc = sqlite3OsTruncate(pPager->jfd, 0);
  45338. if( rc==SQLITE_OK && pPager->fullSync ){
  45339. /* Make sure the new file size is written into the inode right away.
  45340. ** Otherwise the journal might resurrect following a power loss and
  45341. ** cause the last transaction to roll back. See
  45342. ** https://bugzilla.mozilla.org/show_bug.cgi?id=1072773
  45343. */
  45344. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
  45345. }
  45346. }
  45347. pPager->journalOff = 0;
  45348. }else if( pPager->journalMode==PAGER_JOURNALMODE_PERSIST
  45349. || (pPager->exclusiveMode && pPager->journalMode!=PAGER_JOURNALMODE_WAL)
  45350. ){
  45351. rc = zeroJournalHdr(pPager, hasMaster||pPager->tempFile);
  45352. pPager->journalOff = 0;
  45353. }else{
  45354. /* This branch may be executed with Pager.journalMode==MEMORY if
  45355. ** a hot-journal was just rolled back. In this case the journal
  45356. ** file should be closed and deleted. If this connection writes to
  45357. ** the database file, it will do so using an in-memory journal.
  45358. */
  45359. int bDelete = !pPager->tempFile;
  45360. assert( sqlite3JournalIsInMemory(pPager->jfd)==0 );
  45361. assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE
  45362. || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
  45363. || pPager->journalMode==PAGER_JOURNALMODE_WAL
  45364. );
  45365. sqlite3OsClose(pPager->jfd);
  45366. if( bDelete ){
  45367. rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, pPager->extraSync);
  45368. }
  45369. }
  45370. }
  45371. #ifdef SQLITE_CHECK_PAGES
  45372. sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
  45373. if( pPager->dbSize==0 && sqlite3PcacheRefCount(pPager->pPCache)>0 ){
  45374. PgHdr *p = sqlite3PagerLookup(pPager, 1);
  45375. if( p ){
  45376. p->pageHash = 0;
  45377. sqlite3PagerUnrefNotNull(p);
  45378. }
  45379. }
  45380. #endif
  45381. sqlite3BitvecDestroy(pPager->pInJournal);
  45382. pPager->pInJournal = 0;
  45383. pPager->nRec = 0;
  45384. if( rc==SQLITE_OK ){
  45385. if( pagerFlushOnCommit(pPager, bCommit) ){
  45386. sqlite3PcacheCleanAll(pPager->pPCache);
  45387. }else{
  45388. sqlite3PcacheClearWritable(pPager->pPCache);
  45389. }
  45390. sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
  45391. }
  45392. if( pagerUseWal(pPager) ){
  45393. /* Drop the WAL write-lock, if any. Also, if the connection was in
  45394. ** locking_mode=exclusive mode but is no longer, drop the EXCLUSIVE
  45395. ** lock held on the database file.
  45396. */
  45397. rc2 = sqlite3WalEndWriteTransaction(pPager->pWal);
  45398. assert( rc2==SQLITE_OK );
  45399. }else if( rc==SQLITE_OK && bCommit && pPager->dbFileSize>pPager->dbSize ){
  45400. /* This branch is taken when committing a transaction in rollback-journal
  45401. ** mode if the database file on disk is larger than the database image.
  45402. ** At this point the journal has been finalized and the transaction
  45403. ** successfully committed, but the EXCLUSIVE lock is still held on the
  45404. ** file. So it is safe to truncate the database file to its minimum
  45405. ** required size. */
  45406. assert( pPager->eLock==EXCLUSIVE_LOCK );
  45407. rc = pager_truncate(pPager, pPager->dbSize);
  45408. }
  45409. if( rc==SQLITE_OK && bCommit && isOpen(pPager->fd) ){
  45410. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_COMMIT_PHASETWO, 0);
  45411. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  45412. }
  45413. if( !pPager->exclusiveMode
  45414. && (!pagerUseWal(pPager) || sqlite3WalExclusiveMode(pPager->pWal, 0))
  45415. ){
  45416. rc2 = pagerUnlockDb(pPager, SHARED_LOCK);
  45417. pPager->changeCountDone = 0;
  45418. }
  45419. pPager->eState = PAGER_READER;
  45420. pPager->setMaster = 0;
  45421. return (rc==SQLITE_OK?rc2:rc);
  45422. }
  45423. /*
  45424. ** Execute a rollback if a transaction is active and unlock the
  45425. ** database file.
  45426. **
  45427. ** If the pager has already entered the ERROR state, do not attempt
  45428. ** the rollback at this time. Instead, pager_unlock() is called. The
  45429. ** call to pager_unlock() will discard all in-memory pages, unlock
  45430. ** the database file and move the pager back to OPEN state. If this
  45431. ** means that there is a hot-journal left in the file-system, the next
  45432. ** connection to obtain a shared lock on the pager (which may be this one)
  45433. ** will roll it back.
  45434. **
  45435. ** If the pager has not already entered the ERROR state, but an IO or
  45436. ** malloc error occurs during a rollback, then this will itself cause
  45437. ** the pager to enter the ERROR state. Which will be cleared by the
  45438. ** call to pager_unlock(), as described above.
  45439. */
  45440. static void pagerUnlockAndRollback(Pager *pPager){
  45441. if( pPager->eState!=PAGER_ERROR && pPager->eState!=PAGER_OPEN ){
  45442. assert( assert_pager_state(pPager) );
  45443. if( pPager->eState>=PAGER_WRITER_LOCKED ){
  45444. sqlite3BeginBenignMalloc();
  45445. sqlite3PagerRollback(pPager);
  45446. sqlite3EndBenignMalloc();
  45447. }else if( !pPager->exclusiveMode ){
  45448. assert( pPager->eState==PAGER_READER );
  45449. pager_end_transaction(pPager, 0, 0);
  45450. }
  45451. }
  45452. pager_unlock(pPager);
  45453. }
  45454. /*
  45455. ** Parameter aData must point to a buffer of pPager->pageSize bytes
  45456. ** of data. Compute and return a checksum based ont the contents of the
  45457. ** page of data and the current value of pPager->cksumInit.
  45458. **
  45459. ** This is not a real checksum. It is really just the sum of the
  45460. ** random initial value (pPager->cksumInit) and every 200th byte
  45461. ** of the page data, starting with byte offset (pPager->pageSize%200).
  45462. ** Each byte is interpreted as an 8-bit unsigned integer.
  45463. **
  45464. ** Changing the formula used to compute this checksum results in an
  45465. ** incompatible journal file format.
  45466. **
  45467. ** If journal corruption occurs due to a power failure, the most likely
  45468. ** scenario is that one end or the other of the record will be changed.
  45469. ** It is much less likely that the two ends of the journal record will be
  45470. ** correct and the middle be corrupt. Thus, this "checksum" scheme,
  45471. ** though fast and simple, catches the mostly likely kind of corruption.
  45472. */
  45473. static u32 pager_cksum(Pager *pPager, const u8 *aData){
  45474. u32 cksum = pPager->cksumInit; /* Checksum value to return */
  45475. int i = pPager->pageSize-200; /* Loop counter */
  45476. while( i>0 ){
  45477. cksum += aData[i];
  45478. i -= 200;
  45479. }
  45480. return cksum;
  45481. }
  45482. /*
  45483. ** Report the current page size and number of reserved bytes back
  45484. ** to the codec.
  45485. */
  45486. #ifdef SQLITE_HAS_CODEC
  45487. static void pagerReportSize(Pager *pPager){
  45488. if( pPager->xCodecSizeChng ){
  45489. pPager->xCodecSizeChng(pPager->pCodec, pPager->pageSize,
  45490. (int)pPager->nReserve);
  45491. }
  45492. }
  45493. #else
  45494. # define pagerReportSize(X) /* No-op if we do not support a codec */
  45495. #endif
  45496. #ifdef SQLITE_HAS_CODEC
  45497. /*
  45498. ** Make sure the number of reserved bits is the same in the destination
  45499. ** pager as it is in the source. This comes up when a VACUUM changes the
  45500. ** number of reserved bits to the "optimal" amount.
  45501. */
  45502. SQLITE_PRIVATE void sqlite3PagerAlignReserve(Pager *pDest, Pager *pSrc){
  45503. if( pDest->nReserve!=pSrc->nReserve ){
  45504. pDest->nReserve = pSrc->nReserve;
  45505. pagerReportSize(pDest);
  45506. }
  45507. }
  45508. #endif
  45509. /*
  45510. ** Read a single page from either the journal file (if isMainJrnl==1) or
  45511. ** from the sub-journal (if isMainJrnl==0) and playback that page.
  45512. ** The page begins at offset *pOffset into the file. The *pOffset
  45513. ** value is increased to the start of the next page in the journal.
  45514. **
  45515. ** The main rollback journal uses checksums - the statement journal does
  45516. ** not.
  45517. **
  45518. ** If the page number of the page record read from the (sub-)journal file
  45519. ** is greater than the current value of Pager.dbSize, then playback is
  45520. ** skipped and SQLITE_OK is returned.
  45521. **
  45522. ** If pDone is not NULL, then it is a record of pages that have already
  45523. ** been played back. If the page at *pOffset has already been played back
  45524. ** (if the corresponding pDone bit is set) then skip the playback.
  45525. ** Make sure the pDone bit corresponding to the *pOffset page is set
  45526. ** prior to returning.
  45527. **
  45528. ** If the page record is successfully read from the (sub-)journal file
  45529. ** and played back, then SQLITE_OK is returned. If an IO error occurs
  45530. ** while reading the record from the (sub-)journal file or while writing
  45531. ** to the database file, then the IO error code is returned. If data
  45532. ** is successfully read from the (sub-)journal file but appears to be
  45533. ** corrupted, SQLITE_DONE is returned. Data is considered corrupted in
  45534. ** two circumstances:
  45535. **
  45536. ** * If the record page-number is illegal (0 or PAGER_MJ_PGNO), or
  45537. ** * If the record is being rolled back from the main journal file
  45538. ** and the checksum field does not match the record content.
  45539. **
  45540. ** Neither of these two scenarios are possible during a savepoint rollback.
  45541. **
  45542. ** If this is a savepoint rollback, then memory may have to be dynamically
  45543. ** allocated by this function. If this is the case and an allocation fails,
  45544. ** SQLITE_NOMEM is returned.
  45545. */
  45546. static int pager_playback_one_page(
  45547. Pager *pPager, /* The pager being played back */
  45548. i64 *pOffset, /* Offset of record to playback */
  45549. Bitvec *pDone, /* Bitvec of pages already played back */
  45550. int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
  45551. int isSavepnt /* True for a savepoint rollback */
  45552. ){
  45553. int rc;
  45554. PgHdr *pPg; /* An existing page in the cache */
  45555. Pgno pgno; /* The page number of a page in journal */
  45556. u32 cksum; /* Checksum used for sanity checking */
  45557. char *aData; /* Temporary storage for the page */
  45558. sqlite3_file *jfd; /* The file descriptor for the journal file */
  45559. int isSynced; /* True if journal page is synced */
  45560. assert( (isMainJrnl&~1)==0 ); /* isMainJrnl is 0 or 1 */
  45561. assert( (isSavepnt&~1)==0 ); /* isSavepnt is 0 or 1 */
  45562. assert( isMainJrnl || pDone ); /* pDone always used on sub-journals */
  45563. assert( isSavepnt || pDone==0 ); /* pDone never used on non-savepoint */
  45564. aData = pPager->pTmpSpace;
  45565. assert( aData ); /* Temp storage must have already been allocated */
  45566. assert( pagerUseWal(pPager)==0 || (!isMainJrnl && isSavepnt) );
  45567. /* Either the state is greater than PAGER_WRITER_CACHEMOD (a transaction
  45568. ** or savepoint rollback done at the request of the caller) or this is
  45569. ** a hot-journal rollback. If it is a hot-journal rollback, the pager
  45570. ** is in state OPEN and holds an EXCLUSIVE lock. Hot-journal rollback
  45571. ** only reads from the main journal, not the sub-journal.
  45572. */
  45573. assert( pPager->eState>=PAGER_WRITER_CACHEMOD
  45574. || (pPager->eState==PAGER_OPEN && pPager->eLock==EXCLUSIVE_LOCK)
  45575. );
  45576. assert( pPager->eState>=PAGER_WRITER_CACHEMOD || isMainJrnl );
  45577. /* Read the page number and page data from the journal or sub-journal
  45578. ** file. Return an error code to the caller if an IO error occurs.
  45579. */
  45580. jfd = isMainJrnl ? pPager->jfd : pPager->sjfd;
  45581. rc = read32bits(jfd, *pOffset, &pgno);
  45582. if( rc!=SQLITE_OK ) return rc;
  45583. rc = sqlite3OsRead(jfd, (u8*)aData, pPager->pageSize, (*pOffset)+4);
  45584. if( rc!=SQLITE_OK ) return rc;
  45585. *pOffset += pPager->pageSize + 4 + isMainJrnl*4;
  45586. /* Sanity checking on the page. This is more important that I originally
  45587. ** thought. If a power failure occurs while the journal is being written,
  45588. ** it could cause invalid data to be written into the journal. We need to
  45589. ** detect this invalid data (with high probability) and ignore it.
  45590. */
  45591. if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
  45592. assert( !isSavepnt );
  45593. return SQLITE_DONE;
  45594. }
  45595. if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
  45596. return SQLITE_OK;
  45597. }
  45598. if( isMainJrnl ){
  45599. rc = read32bits(jfd, (*pOffset)-4, &cksum);
  45600. if( rc ) return rc;
  45601. if( !isSavepnt && pager_cksum(pPager, (u8*)aData)!=cksum ){
  45602. return SQLITE_DONE;
  45603. }
  45604. }
  45605. /* If this page has already been played back before during the current
  45606. ** rollback, then don't bother to play it back again.
  45607. */
  45608. if( pDone && (rc = sqlite3BitvecSet(pDone, pgno))!=SQLITE_OK ){
  45609. return rc;
  45610. }
  45611. /* When playing back page 1, restore the nReserve setting
  45612. */
  45613. if( pgno==1 && pPager->nReserve!=((u8*)aData)[20] ){
  45614. pPager->nReserve = ((u8*)aData)[20];
  45615. pagerReportSize(pPager);
  45616. }
  45617. /* If the pager is in CACHEMOD state, then there must be a copy of this
  45618. ** page in the pager cache. In this case just update the pager cache,
  45619. ** not the database file. The page is left marked dirty in this case.
  45620. **
  45621. ** An exception to the above rule: If the database is in no-sync mode
  45622. ** and a page is moved during an incremental vacuum then the page may
  45623. ** not be in the pager cache. Later: if a malloc() or IO error occurs
  45624. ** during a Movepage() call, then the page may not be in the cache
  45625. ** either. So the condition described in the above paragraph is not
  45626. ** assert()able.
  45627. **
  45628. ** If in WRITER_DBMOD, WRITER_FINISHED or OPEN state, then we update the
  45629. ** pager cache if it exists and the main file. The page is then marked
  45630. ** not dirty. Since this code is only executed in PAGER_OPEN state for
  45631. ** a hot-journal rollback, it is guaranteed that the page-cache is empty
  45632. ** if the pager is in OPEN state.
  45633. **
  45634. ** Ticket #1171: The statement journal might contain page content that is
  45635. ** different from the page content at the start of the transaction.
  45636. ** This occurs when a page is changed prior to the start of a statement
  45637. ** then changed again within the statement. When rolling back such a
  45638. ** statement we must not write to the original database unless we know
  45639. ** for certain that original page contents are synced into the main rollback
  45640. ** journal. Otherwise, a power loss might leave modified data in the
  45641. ** database file without an entry in the rollback journal that can
  45642. ** restore the database to its original form. Two conditions must be
  45643. ** met before writing to the database files. (1) the database must be
  45644. ** locked. (2) we know that the original page content is fully synced
  45645. ** in the main journal either because the page is not in cache or else
  45646. ** the page is marked as needSync==0.
  45647. **
  45648. ** 2008-04-14: When attempting to vacuum a corrupt database file, it
  45649. ** is possible to fail a statement on a database that does not yet exist.
  45650. ** Do not attempt to write if database file has never been opened.
  45651. */
  45652. if( pagerUseWal(pPager) ){
  45653. pPg = 0;
  45654. }else{
  45655. pPg = sqlite3PagerLookup(pPager, pgno);
  45656. }
  45657. assert( pPg || !MEMDB );
  45658. assert( pPager->eState!=PAGER_OPEN || pPg==0 || pPager->tempFile );
  45659. PAGERTRACE(("PLAYBACK %d page %d hash(%08x) %s\n",
  45660. PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, (u8*)aData),
  45661. (isMainJrnl?"main-journal":"sub-journal")
  45662. ));
  45663. if( isMainJrnl ){
  45664. isSynced = pPager->noSync || (*pOffset <= pPager->journalHdr);
  45665. }else{
  45666. isSynced = (pPg==0 || 0==(pPg->flags & PGHDR_NEED_SYNC));
  45667. }
  45668. if( isOpen(pPager->fd)
  45669. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  45670. && isSynced
  45671. ){
  45672. i64 ofst = (pgno-1)*(i64)pPager->pageSize;
  45673. testcase( !isSavepnt && pPg!=0 && (pPg->flags&PGHDR_NEED_SYNC)!=0 );
  45674. assert( !pagerUseWal(pPager) );
  45675. rc = sqlite3OsWrite(pPager->fd, (u8 *)aData, pPager->pageSize, ofst);
  45676. if( pgno>pPager->dbFileSize ){
  45677. pPager->dbFileSize = pgno;
  45678. }
  45679. if( pPager->pBackup ){
  45680. CODEC1(pPager, aData, pgno, 3, rc=SQLITE_NOMEM_BKPT);
  45681. sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)aData);
  45682. CODEC2(pPager, aData, pgno, 7, rc=SQLITE_NOMEM_BKPT, aData);
  45683. }
  45684. }else if( !isMainJrnl && pPg==0 ){
  45685. /* If this is a rollback of a savepoint and data was not written to
  45686. ** the database and the page is not in-memory, there is a potential
  45687. ** problem. When the page is next fetched by the b-tree layer, it
  45688. ** will be read from the database file, which may or may not be
  45689. ** current.
  45690. **
  45691. ** There are a couple of different ways this can happen. All are quite
  45692. ** obscure. When running in synchronous mode, this can only happen
  45693. ** if the page is on the free-list at the start of the transaction, then
  45694. ** populated, then moved using sqlite3PagerMovepage().
  45695. **
  45696. ** The solution is to add an in-memory page to the cache containing
  45697. ** the data just read from the sub-journal. Mark the page as dirty
  45698. ** and if the pager requires a journal-sync, then mark the page as
  45699. ** requiring a journal-sync before it is written.
  45700. */
  45701. assert( isSavepnt );
  45702. assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)==0 );
  45703. pPager->doNotSpill |= SPILLFLAG_ROLLBACK;
  45704. rc = sqlite3PagerGet(pPager, pgno, &pPg, 1);
  45705. assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)!=0 );
  45706. pPager->doNotSpill &= ~SPILLFLAG_ROLLBACK;
  45707. if( rc!=SQLITE_OK ) return rc;
  45708. sqlite3PcacheMakeDirty(pPg);
  45709. }
  45710. if( pPg ){
  45711. /* No page should ever be explicitly rolled back that is in use, except
  45712. ** for page 1 which is held in use in order to keep the lock on the
  45713. ** database active. However such a page may be rolled back as a result
  45714. ** of an internal error resulting in an automatic call to
  45715. ** sqlite3PagerRollback().
  45716. */
  45717. void *pData;
  45718. pData = pPg->pData;
  45719. memcpy(pData, (u8*)aData, pPager->pageSize);
  45720. pPager->xReiniter(pPg);
  45721. /* It used to be that sqlite3PcacheMakeClean(pPg) was called here. But
  45722. ** that call was dangerous and had no detectable benefit since the cache
  45723. ** is normally cleaned by sqlite3PcacheCleanAll() after rollback and so
  45724. ** has been removed. */
  45725. pager_set_pagehash(pPg);
  45726. /* If this was page 1, then restore the value of Pager.dbFileVers.
  45727. ** Do this before any decoding. */
  45728. if( pgno==1 ){
  45729. memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
  45730. }
  45731. /* Decode the page just read from disk */
  45732. CODEC1(pPager, pData, pPg->pgno, 3, rc=SQLITE_NOMEM_BKPT);
  45733. sqlite3PcacheRelease(pPg);
  45734. }
  45735. return rc;
  45736. }
  45737. /*
  45738. ** Parameter zMaster is the name of a master journal file. A single journal
  45739. ** file that referred to the master journal file has just been rolled back.
  45740. ** This routine checks if it is possible to delete the master journal file,
  45741. ** and does so if it is.
  45742. **
  45743. ** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
  45744. ** available for use within this function.
  45745. **
  45746. ** When a master journal file is created, it is populated with the names
  45747. ** of all of its child journals, one after another, formatted as utf-8
  45748. ** encoded text. The end of each child journal file is marked with a
  45749. ** nul-terminator byte (0x00). i.e. the entire contents of a master journal
  45750. ** file for a transaction involving two databases might be:
  45751. **
  45752. ** "/home/bill/a.db-journal\x00/home/bill/b.db-journal\x00"
  45753. **
  45754. ** A master journal file may only be deleted once all of its child
  45755. ** journals have been rolled back.
  45756. **
  45757. ** This function reads the contents of the master-journal file into
  45758. ** memory and loops through each of the child journal names. For
  45759. ** each child journal, it checks if:
  45760. **
  45761. ** * if the child journal exists, and if so
  45762. ** * if the child journal contains a reference to master journal
  45763. ** file zMaster
  45764. **
  45765. ** If a child journal can be found that matches both of the criteria
  45766. ** above, this function returns without doing anything. Otherwise, if
  45767. ** no such child journal can be found, file zMaster is deleted from
  45768. ** the file-system using sqlite3OsDelete().
  45769. **
  45770. ** If an IO error within this function, an error code is returned. This
  45771. ** function allocates memory by calling sqlite3Malloc(). If an allocation
  45772. ** fails, SQLITE_NOMEM is returned. Otherwise, if no IO or malloc errors
  45773. ** occur, SQLITE_OK is returned.
  45774. **
  45775. ** TODO: This function allocates a single block of memory to load
  45776. ** the entire contents of the master journal file. This could be
  45777. ** a couple of kilobytes or so - potentially larger than the page
  45778. ** size.
  45779. */
  45780. static int pager_delmaster(Pager *pPager, const char *zMaster){
  45781. sqlite3_vfs *pVfs = pPager->pVfs;
  45782. int rc; /* Return code */
  45783. sqlite3_file *pMaster; /* Malloc'd master-journal file descriptor */
  45784. sqlite3_file *pJournal; /* Malloc'd child-journal file descriptor */
  45785. char *zMasterJournal = 0; /* Contents of master journal file */
  45786. i64 nMasterJournal; /* Size of master journal file */
  45787. char *zJournal; /* Pointer to one journal within MJ file */
  45788. char *zMasterPtr; /* Space to hold MJ filename from a journal file */
  45789. int nMasterPtr; /* Amount of space allocated to zMasterPtr[] */
  45790. /* Allocate space for both the pJournal and pMaster file descriptors.
  45791. ** If successful, open the master journal file for reading.
  45792. */
  45793. pMaster = (sqlite3_file *)sqlite3MallocZero(pVfs->szOsFile * 2);
  45794. pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
  45795. if( !pMaster ){
  45796. rc = SQLITE_NOMEM_BKPT;
  45797. }else{
  45798. const int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
  45799. rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
  45800. }
  45801. if( rc!=SQLITE_OK ) goto delmaster_out;
  45802. /* Load the entire master journal file into space obtained from
  45803. ** sqlite3_malloc() and pointed to by zMasterJournal. Also obtain
  45804. ** sufficient space (in zMasterPtr) to hold the names of master
  45805. ** journal files extracted from regular rollback-journals.
  45806. */
  45807. rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
  45808. if( rc!=SQLITE_OK ) goto delmaster_out;
  45809. nMasterPtr = pVfs->mxPathname+1;
  45810. zMasterJournal = sqlite3Malloc(nMasterJournal + nMasterPtr + 1);
  45811. if( !zMasterJournal ){
  45812. rc = SQLITE_NOMEM_BKPT;
  45813. goto delmaster_out;
  45814. }
  45815. zMasterPtr = &zMasterJournal[nMasterJournal+1];
  45816. rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
  45817. if( rc!=SQLITE_OK ) goto delmaster_out;
  45818. zMasterJournal[nMasterJournal] = 0;
  45819. zJournal = zMasterJournal;
  45820. while( (zJournal-zMasterJournal)<nMasterJournal ){
  45821. int exists;
  45822. rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
  45823. if( rc!=SQLITE_OK ){
  45824. goto delmaster_out;
  45825. }
  45826. if( exists ){
  45827. /* One of the journals pointed to by the master journal exists.
  45828. ** Open it and check if it points at the master journal. If
  45829. ** so, return without deleting the master journal file.
  45830. */
  45831. int c;
  45832. int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
  45833. rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
  45834. if( rc!=SQLITE_OK ){
  45835. goto delmaster_out;
  45836. }
  45837. rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
  45838. sqlite3OsClose(pJournal);
  45839. if( rc!=SQLITE_OK ){
  45840. goto delmaster_out;
  45841. }
  45842. c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
  45843. if( c ){
  45844. /* We have a match. Do not delete the master journal file. */
  45845. goto delmaster_out;
  45846. }
  45847. }
  45848. zJournal += (sqlite3Strlen30(zJournal)+1);
  45849. }
  45850. sqlite3OsClose(pMaster);
  45851. rc = sqlite3OsDelete(pVfs, zMaster, 0);
  45852. delmaster_out:
  45853. sqlite3_free(zMasterJournal);
  45854. if( pMaster ){
  45855. sqlite3OsClose(pMaster);
  45856. assert( !isOpen(pJournal) );
  45857. sqlite3_free(pMaster);
  45858. }
  45859. return rc;
  45860. }
  45861. /*
  45862. ** This function is used to change the actual size of the database
  45863. ** file in the file-system. This only happens when committing a transaction,
  45864. ** or rolling back a transaction (including rolling back a hot-journal).
  45865. **
  45866. ** If the main database file is not open, or the pager is not in either
  45867. ** DBMOD or OPEN state, this function is a no-op. Otherwise, the size
  45868. ** of the file is changed to nPage pages (nPage*pPager->pageSize bytes).
  45869. ** If the file on disk is currently larger than nPage pages, then use the VFS
  45870. ** xTruncate() method to truncate it.
  45871. **
  45872. ** Or, it might be the case that the file on disk is smaller than
  45873. ** nPage pages. Some operating system implementations can get confused if
  45874. ** you try to truncate a file to some size that is larger than it
  45875. ** currently is, so detect this case and write a single zero byte to
  45876. ** the end of the new file instead.
  45877. **
  45878. ** If successful, return SQLITE_OK. If an IO error occurs while modifying
  45879. ** the database file, return the error code to the caller.
  45880. */
  45881. static int pager_truncate(Pager *pPager, Pgno nPage){
  45882. int rc = SQLITE_OK;
  45883. assert( pPager->eState!=PAGER_ERROR );
  45884. assert( pPager->eState!=PAGER_READER );
  45885. if( isOpen(pPager->fd)
  45886. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  45887. ){
  45888. i64 currentSize, newSize;
  45889. int szPage = pPager->pageSize;
  45890. assert( pPager->eLock==EXCLUSIVE_LOCK );
  45891. /* TODO: Is it safe to use Pager.dbFileSize here? */
  45892. rc = sqlite3OsFileSize(pPager->fd, &currentSize);
  45893. newSize = szPage*(i64)nPage;
  45894. if( rc==SQLITE_OK && currentSize!=newSize ){
  45895. if( currentSize>newSize ){
  45896. rc = sqlite3OsTruncate(pPager->fd, newSize);
  45897. }else if( (currentSize+szPage)<=newSize ){
  45898. char *pTmp = pPager->pTmpSpace;
  45899. memset(pTmp, 0, szPage);
  45900. testcase( (newSize-szPage) == currentSize );
  45901. testcase( (newSize-szPage) > currentSize );
  45902. rc = sqlite3OsWrite(pPager->fd, pTmp, szPage, newSize-szPage);
  45903. }
  45904. if( rc==SQLITE_OK ){
  45905. pPager->dbFileSize = nPage;
  45906. }
  45907. }
  45908. }
  45909. return rc;
  45910. }
  45911. /*
  45912. ** Return a sanitized version of the sector-size of OS file pFile. The
  45913. ** return value is guaranteed to lie between 32 and MAX_SECTOR_SIZE.
  45914. */
  45915. SQLITE_PRIVATE int sqlite3SectorSize(sqlite3_file *pFile){
  45916. int iRet = sqlite3OsSectorSize(pFile);
  45917. if( iRet<32 ){
  45918. iRet = 512;
  45919. }else if( iRet>MAX_SECTOR_SIZE ){
  45920. assert( MAX_SECTOR_SIZE>=512 );
  45921. iRet = MAX_SECTOR_SIZE;
  45922. }
  45923. return iRet;
  45924. }
  45925. /*
  45926. ** Set the value of the Pager.sectorSize variable for the given
  45927. ** pager based on the value returned by the xSectorSize method
  45928. ** of the open database file. The sector size will be used
  45929. ** to determine the size and alignment of journal header and
  45930. ** master journal pointers within created journal files.
  45931. **
  45932. ** For temporary files the effective sector size is always 512 bytes.
  45933. **
  45934. ** Otherwise, for non-temporary files, the effective sector size is
  45935. ** the value returned by the xSectorSize() method rounded up to 32 if
  45936. ** it is less than 32, or rounded down to MAX_SECTOR_SIZE if it
  45937. ** is greater than MAX_SECTOR_SIZE.
  45938. **
  45939. ** If the file has the SQLITE_IOCAP_POWERSAFE_OVERWRITE property, then set
  45940. ** the effective sector size to its minimum value (512). The purpose of
  45941. ** pPager->sectorSize is to define the "blast radius" of bytes that
  45942. ** might change if a crash occurs while writing to a single byte in
  45943. ** that range. But with POWERSAFE_OVERWRITE, the blast radius is zero
  45944. ** (that is what POWERSAFE_OVERWRITE means), so we minimize the sector
  45945. ** size. For backwards compatibility of the rollback journal file format,
  45946. ** we cannot reduce the effective sector size below 512.
  45947. */
  45948. static void setSectorSize(Pager *pPager){
  45949. assert( isOpen(pPager->fd) || pPager->tempFile );
  45950. if( pPager->tempFile
  45951. || (sqlite3OsDeviceCharacteristics(pPager->fd) &
  45952. SQLITE_IOCAP_POWERSAFE_OVERWRITE)!=0
  45953. ){
  45954. /* Sector size doesn't matter for temporary files. Also, the file
  45955. ** may not have been opened yet, in which case the OsSectorSize()
  45956. ** call will segfault. */
  45957. pPager->sectorSize = 512;
  45958. }else{
  45959. pPager->sectorSize = sqlite3SectorSize(pPager->fd);
  45960. }
  45961. }
  45962. /*
  45963. ** Playback the journal and thus restore the database file to
  45964. ** the state it was in before we started making changes.
  45965. **
  45966. ** The journal file format is as follows:
  45967. **
  45968. ** (1) 8 byte prefix. A copy of aJournalMagic[].
  45969. ** (2) 4 byte big-endian integer which is the number of valid page records
  45970. ** in the journal. If this value is 0xffffffff, then compute the
  45971. ** number of page records from the journal size.
  45972. ** (3) 4 byte big-endian integer which is the initial value for the
  45973. ** sanity checksum.
  45974. ** (4) 4 byte integer which is the number of pages to truncate the
  45975. ** database to during a rollback.
  45976. ** (5) 4 byte big-endian integer which is the sector size. The header
  45977. ** is this many bytes in size.
  45978. ** (6) 4 byte big-endian integer which is the page size.
  45979. ** (7) zero padding out to the next sector size.
  45980. ** (8) Zero or more pages instances, each as follows:
  45981. ** + 4 byte page number.
  45982. ** + pPager->pageSize bytes of data.
  45983. ** + 4 byte checksum
  45984. **
  45985. ** When we speak of the journal header, we mean the first 7 items above.
  45986. ** Each entry in the journal is an instance of the 8th item.
  45987. **
  45988. ** Call the value from the second bullet "nRec". nRec is the number of
  45989. ** valid page entries in the journal. In most cases, you can compute the
  45990. ** value of nRec from the size of the journal file. But if a power
  45991. ** failure occurred while the journal was being written, it could be the
  45992. ** case that the size of the journal file had already been increased but
  45993. ** the extra entries had not yet made it safely to disk. In such a case,
  45994. ** the value of nRec computed from the file size would be too large. For
  45995. ** that reason, we always use the nRec value in the header.
  45996. **
  45997. ** If the nRec value is 0xffffffff it means that nRec should be computed
  45998. ** from the file size. This value is used when the user selects the
  45999. ** no-sync option for the journal. A power failure could lead to corruption
  46000. ** in this case. But for things like temporary table (which will be
  46001. ** deleted when the power is restored) we don't care.
  46002. **
  46003. ** If the file opened as the journal file is not a well-formed
  46004. ** journal file then all pages up to the first corrupted page are rolled
  46005. ** back (or no pages if the journal header is corrupted). The journal file
  46006. ** is then deleted and SQLITE_OK returned, just as if no corruption had
  46007. ** been encountered.
  46008. **
  46009. ** If an I/O or malloc() error occurs, the journal-file is not deleted
  46010. ** and an error code is returned.
  46011. **
  46012. ** The isHot parameter indicates that we are trying to rollback a journal
  46013. ** that might be a hot journal. Or, it could be that the journal is
  46014. ** preserved because of JOURNALMODE_PERSIST or JOURNALMODE_TRUNCATE.
  46015. ** If the journal really is hot, reset the pager cache prior rolling
  46016. ** back any content. If the journal is merely persistent, no reset is
  46017. ** needed.
  46018. */
  46019. static int pager_playback(Pager *pPager, int isHot){
  46020. sqlite3_vfs *pVfs = pPager->pVfs;
  46021. i64 szJ; /* Size of the journal file in bytes */
  46022. u32 nRec; /* Number of Records in the journal */
  46023. u32 u; /* Unsigned loop counter */
  46024. Pgno mxPg = 0; /* Size of the original file in pages */
  46025. int rc; /* Result code of a subroutine */
  46026. int res = 1; /* Value returned by sqlite3OsAccess() */
  46027. char *zMaster = 0; /* Name of master journal file if any */
  46028. int needPagerReset; /* True to reset page prior to first page rollback */
  46029. int nPlayback = 0; /* Total number of pages restored from journal */
  46030. /* Figure out how many records are in the journal. Abort early if
  46031. ** the journal is empty.
  46032. */
  46033. assert( isOpen(pPager->jfd) );
  46034. rc = sqlite3OsFileSize(pPager->jfd, &szJ);
  46035. if( rc!=SQLITE_OK ){
  46036. goto end_playback;
  46037. }
  46038. /* Read the master journal name from the journal, if it is present.
  46039. ** If a master journal file name is specified, but the file is not
  46040. ** present on disk, then the journal is not hot and does not need to be
  46041. ** played back.
  46042. **
  46043. ** TODO: Technically the following is an error because it assumes that
  46044. ** buffer Pager.pTmpSpace is (mxPathname+1) bytes or larger. i.e. that
  46045. ** (pPager->pageSize >= pPager->pVfs->mxPathname+1). Using os_unix.c,
  46046. ** mxPathname is 512, which is the same as the minimum allowable value
  46047. ** for pageSize.
  46048. */
  46049. zMaster = pPager->pTmpSpace;
  46050. rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
  46051. if( rc==SQLITE_OK && zMaster[0] ){
  46052. rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
  46053. }
  46054. zMaster = 0;
  46055. if( rc!=SQLITE_OK || !res ){
  46056. goto end_playback;
  46057. }
  46058. pPager->journalOff = 0;
  46059. needPagerReset = isHot;
  46060. /* This loop terminates either when a readJournalHdr() or
  46061. ** pager_playback_one_page() call returns SQLITE_DONE or an IO error
  46062. ** occurs.
  46063. */
  46064. while( 1 ){
  46065. /* Read the next journal header from the journal file. If there are
  46066. ** not enough bytes left in the journal file for a complete header, or
  46067. ** it is corrupted, then a process must have failed while writing it.
  46068. ** This indicates nothing more needs to be rolled back.
  46069. */
  46070. rc = readJournalHdr(pPager, isHot, szJ, &nRec, &mxPg);
  46071. if( rc!=SQLITE_OK ){
  46072. if( rc==SQLITE_DONE ){
  46073. rc = SQLITE_OK;
  46074. }
  46075. goto end_playback;
  46076. }
  46077. /* If nRec is 0xffffffff, then this journal was created by a process
  46078. ** working in no-sync mode. This means that the rest of the journal
  46079. ** file consists of pages, there are no more journal headers. Compute
  46080. ** the value of nRec based on this assumption.
  46081. */
  46082. if( nRec==0xffffffff ){
  46083. assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
  46084. nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
  46085. }
  46086. /* If nRec is 0 and this rollback is of a transaction created by this
  46087. ** process and if this is the final header in the journal, then it means
  46088. ** that this part of the journal was being filled but has not yet been
  46089. ** synced to disk. Compute the number of pages based on the remaining
  46090. ** size of the file.
  46091. **
  46092. ** The third term of the test was added to fix ticket #2565.
  46093. ** When rolling back a hot journal, nRec==0 always means that the next
  46094. ** chunk of the journal contains zero pages to be rolled back. But
  46095. ** when doing a ROLLBACK and the nRec==0 chunk is the last chunk in
  46096. ** the journal, it means that the journal might contain additional
  46097. ** pages that need to be rolled back and that the number of pages
  46098. ** should be computed based on the journal file size.
  46099. */
  46100. if( nRec==0 && !isHot &&
  46101. pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
  46102. nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
  46103. }
  46104. /* If this is the first header read from the journal, truncate the
  46105. ** database file back to its original size.
  46106. */
  46107. if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
  46108. rc = pager_truncate(pPager, mxPg);
  46109. if( rc!=SQLITE_OK ){
  46110. goto end_playback;
  46111. }
  46112. pPager->dbSize = mxPg;
  46113. }
  46114. /* Copy original pages out of the journal and back into the
  46115. ** database file and/or page cache.
  46116. */
  46117. for(u=0; u<nRec; u++){
  46118. if( needPagerReset ){
  46119. pager_reset(pPager);
  46120. needPagerReset = 0;
  46121. }
  46122. rc = pager_playback_one_page(pPager,&pPager->journalOff,0,1,0);
  46123. if( rc==SQLITE_OK ){
  46124. nPlayback++;
  46125. }else{
  46126. if( rc==SQLITE_DONE ){
  46127. pPager->journalOff = szJ;
  46128. break;
  46129. }else if( rc==SQLITE_IOERR_SHORT_READ ){
  46130. /* If the journal has been truncated, simply stop reading and
  46131. ** processing the journal. This might happen if the journal was
  46132. ** not completely written and synced prior to a crash. In that
  46133. ** case, the database should have never been written in the
  46134. ** first place so it is OK to simply abandon the rollback. */
  46135. rc = SQLITE_OK;
  46136. goto end_playback;
  46137. }else{
  46138. /* If we are unable to rollback, quit and return the error
  46139. ** code. This will cause the pager to enter the error state
  46140. ** so that no further harm will be done. Perhaps the next
  46141. ** process to come along will be able to rollback the database.
  46142. */
  46143. goto end_playback;
  46144. }
  46145. }
  46146. }
  46147. }
  46148. /*NOTREACHED*/
  46149. assert( 0 );
  46150. end_playback:
  46151. /* Following a rollback, the database file should be back in its original
  46152. ** state prior to the start of the transaction, so invoke the
  46153. ** SQLITE_FCNTL_DB_UNCHANGED file-control method to disable the
  46154. ** assertion that the transaction counter was modified.
  46155. */
  46156. #ifdef SQLITE_DEBUG
  46157. if( pPager->fd->pMethods ){
  46158. sqlite3OsFileControlHint(pPager->fd,SQLITE_FCNTL_DB_UNCHANGED,0);
  46159. }
  46160. #endif
  46161. /* If this playback is happening automatically as a result of an IO or
  46162. ** malloc error that occurred after the change-counter was updated but
  46163. ** before the transaction was committed, then the change-counter
  46164. ** modification may just have been reverted. If this happens in exclusive
  46165. ** mode, then subsequent transactions performed by the connection will not
  46166. ** update the change-counter at all. This may lead to cache inconsistency
  46167. ** problems for other processes at some point in the future. So, just
  46168. ** in case this has happened, clear the changeCountDone flag now.
  46169. */
  46170. pPager->changeCountDone = pPager->tempFile;
  46171. if( rc==SQLITE_OK ){
  46172. zMaster = pPager->pTmpSpace;
  46173. rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
  46174. testcase( rc!=SQLITE_OK );
  46175. }
  46176. if( rc==SQLITE_OK
  46177. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  46178. ){
  46179. rc = sqlite3PagerSync(pPager, 0);
  46180. }
  46181. if( rc==SQLITE_OK ){
  46182. rc = pager_end_transaction(pPager, zMaster[0]!='\0', 0);
  46183. testcase( rc!=SQLITE_OK );
  46184. }
  46185. if( rc==SQLITE_OK && zMaster[0] && res ){
  46186. /* If there was a master journal and this routine will return success,
  46187. ** see if it is possible to delete the master journal.
  46188. */
  46189. rc = pager_delmaster(pPager, zMaster);
  46190. testcase( rc!=SQLITE_OK );
  46191. }
  46192. if( isHot && nPlayback ){
  46193. sqlite3_log(SQLITE_NOTICE_RECOVER_ROLLBACK, "recovered %d pages from %s",
  46194. nPlayback, pPager->zJournal);
  46195. }
  46196. /* The Pager.sectorSize variable may have been updated while rolling
  46197. ** back a journal created by a process with a different sector size
  46198. ** value. Reset it to the correct value for this process.
  46199. */
  46200. setSectorSize(pPager);
  46201. return rc;
  46202. }
  46203. /*
  46204. ** Read the content for page pPg out of the database file and into
  46205. ** pPg->pData. A shared lock or greater must be held on the database
  46206. ** file before this function is called.
  46207. **
  46208. ** If page 1 is read, then the value of Pager.dbFileVers[] is set to
  46209. ** the value read from the database file.
  46210. **
  46211. ** If an IO error occurs, then the IO error is returned to the caller.
  46212. ** Otherwise, SQLITE_OK is returned.
  46213. */
  46214. static int readDbPage(PgHdr *pPg, u32 iFrame){
  46215. Pager *pPager = pPg->pPager; /* Pager object associated with page pPg */
  46216. Pgno pgno = pPg->pgno; /* Page number to read */
  46217. int rc = SQLITE_OK; /* Return code */
  46218. int pgsz = pPager->pageSize; /* Number of bytes to read */
  46219. assert( pPager->eState>=PAGER_READER && !MEMDB );
  46220. assert( isOpen(pPager->fd) );
  46221. #ifndef SQLITE_OMIT_WAL
  46222. if( iFrame ){
  46223. /* Try to pull the page from the write-ahead log. */
  46224. rc = sqlite3WalReadFrame(pPager->pWal, iFrame, pgsz, pPg->pData);
  46225. }else
  46226. #endif
  46227. {
  46228. i64 iOffset = (pgno-1)*(i64)pPager->pageSize;
  46229. rc = sqlite3OsRead(pPager->fd, pPg->pData, pgsz, iOffset);
  46230. if( rc==SQLITE_IOERR_SHORT_READ ){
  46231. rc = SQLITE_OK;
  46232. }
  46233. }
  46234. if( pgno==1 ){
  46235. if( rc ){
  46236. /* If the read is unsuccessful, set the dbFileVers[] to something
  46237. ** that will never be a valid file version. dbFileVers[] is a copy
  46238. ** of bytes 24..39 of the database. Bytes 28..31 should always be
  46239. ** zero or the size of the database in page. Bytes 32..35 and 35..39
  46240. ** should be page numbers which are never 0xffffffff. So filling
  46241. ** pPager->dbFileVers[] with all 0xff bytes should suffice.
  46242. **
  46243. ** For an encrypted database, the situation is more complex: bytes
  46244. ** 24..39 of the database are white noise. But the probability of
  46245. ** white noise equaling 16 bytes of 0xff is vanishingly small so
  46246. ** we should still be ok.
  46247. */
  46248. memset(pPager->dbFileVers, 0xff, sizeof(pPager->dbFileVers));
  46249. }else{
  46250. u8 *dbFileVers = &((u8*)pPg->pData)[24];
  46251. memcpy(&pPager->dbFileVers, dbFileVers, sizeof(pPager->dbFileVers));
  46252. }
  46253. }
  46254. CODEC1(pPager, pPg->pData, pgno, 3, rc = SQLITE_NOMEM_BKPT);
  46255. PAGER_INCR(sqlite3_pager_readdb_count);
  46256. PAGER_INCR(pPager->nRead);
  46257. IOTRACE(("PGIN %p %d\n", pPager, pgno));
  46258. PAGERTRACE(("FETCH %d page %d hash(%08x)\n",
  46259. PAGERID(pPager), pgno, pager_pagehash(pPg)));
  46260. return rc;
  46261. }
  46262. /*
  46263. ** Update the value of the change-counter at offsets 24 and 92 in
  46264. ** the header and the sqlite version number at offset 96.
  46265. **
  46266. ** This is an unconditional update. See also the pager_incr_changecounter()
  46267. ** routine which only updates the change-counter if the update is actually
  46268. ** needed, as determined by the pPager->changeCountDone state variable.
  46269. */
  46270. static void pager_write_changecounter(PgHdr *pPg){
  46271. u32 change_counter;
  46272. /* Increment the value just read and write it back to byte 24. */
  46273. change_counter = sqlite3Get4byte((u8*)pPg->pPager->dbFileVers)+1;
  46274. put32bits(((char*)pPg->pData)+24, change_counter);
  46275. /* Also store the SQLite version number in bytes 96..99 and in
  46276. ** bytes 92..95 store the change counter for which the version number
  46277. ** is valid. */
  46278. put32bits(((char*)pPg->pData)+92, change_counter);
  46279. put32bits(((char*)pPg->pData)+96, SQLITE_VERSION_NUMBER);
  46280. }
  46281. #ifndef SQLITE_OMIT_WAL
  46282. /*
  46283. ** This function is invoked once for each page that has already been
  46284. ** written into the log file when a WAL transaction is rolled back.
  46285. ** Parameter iPg is the page number of said page. The pCtx argument
  46286. ** is actually a pointer to the Pager structure.
  46287. **
  46288. ** If page iPg is present in the cache, and has no outstanding references,
  46289. ** it is discarded. Otherwise, if there are one or more outstanding
  46290. ** references, the page content is reloaded from the database. If the
  46291. ** attempt to reload content from the database is required and fails,
  46292. ** return an SQLite error code. Otherwise, SQLITE_OK.
  46293. */
  46294. static int pagerUndoCallback(void *pCtx, Pgno iPg){
  46295. int rc = SQLITE_OK;
  46296. Pager *pPager = (Pager *)pCtx;
  46297. PgHdr *pPg;
  46298. assert( pagerUseWal(pPager) );
  46299. pPg = sqlite3PagerLookup(pPager, iPg);
  46300. if( pPg ){
  46301. if( sqlite3PcachePageRefcount(pPg)==1 ){
  46302. sqlite3PcacheDrop(pPg);
  46303. }else{
  46304. u32 iFrame = 0;
  46305. rc = sqlite3WalFindFrame(pPager->pWal, pPg->pgno, &iFrame);
  46306. if( rc==SQLITE_OK ){
  46307. rc = readDbPage(pPg, iFrame);
  46308. }
  46309. if( rc==SQLITE_OK ){
  46310. pPager->xReiniter(pPg);
  46311. }
  46312. sqlite3PagerUnrefNotNull(pPg);
  46313. }
  46314. }
  46315. /* Normally, if a transaction is rolled back, any backup processes are
  46316. ** updated as data is copied out of the rollback journal and into the
  46317. ** database. This is not generally possible with a WAL database, as
  46318. ** rollback involves simply truncating the log file. Therefore, if one
  46319. ** or more frames have already been written to the log (and therefore
  46320. ** also copied into the backup databases) as part of this transaction,
  46321. ** the backups must be restarted.
  46322. */
  46323. sqlite3BackupRestart(pPager->pBackup);
  46324. return rc;
  46325. }
  46326. /*
  46327. ** This function is called to rollback a transaction on a WAL database.
  46328. */
  46329. static int pagerRollbackWal(Pager *pPager){
  46330. int rc; /* Return Code */
  46331. PgHdr *pList; /* List of dirty pages to revert */
  46332. /* For all pages in the cache that are currently dirty or have already
  46333. ** been written (but not committed) to the log file, do one of the
  46334. ** following:
  46335. **
  46336. ** + Discard the cached page (if refcount==0), or
  46337. ** + Reload page content from the database (if refcount>0).
  46338. */
  46339. pPager->dbSize = pPager->dbOrigSize;
  46340. rc = sqlite3WalUndo(pPager->pWal, pagerUndoCallback, (void *)pPager);
  46341. pList = sqlite3PcacheDirtyList(pPager->pPCache);
  46342. while( pList && rc==SQLITE_OK ){
  46343. PgHdr *pNext = pList->pDirty;
  46344. rc = pagerUndoCallback((void *)pPager, pList->pgno);
  46345. pList = pNext;
  46346. }
  46347. return rc;
  46348. }
  46349. /*
  46350. ** This function is a wrapper around sqlite3WalFrames(). As well as logging
  46351. ** the contents of the list of pages headed by pList (connected by pDirty),
  46352. ** this function notifies any active backup processes that the pages have
  46353. ** changed.
  46354. **
  46355. ** The list of pages passed into this routine is always sorted by page number.
  46356. ** Hence, if page 1 appears anywhere on the list, it will be the first page.
  46357. */
  46358. static int pagerWalFrames(
  46359. Pager *pPager, /* Pager object */
  46360. PgHdr *pList, /* List of frames to log */
  46361. Pgno nTruncate, /* Database size after this commit */
  46362. int isCommit /* True if this is a commit */
  46363. ){
  46364. int rc; /* Return code */
  46365. int nList; /* Number of pages in pList */
  46366. PgHdr *p; /* For looping over pages */
  46367. assert( pPager->pWal );
  46368. assert( pList );
  46369. #ifdef SQLITE_DEBUG
  46370. /* Verify that the page list is in accending order */
  46371. for(p=pList; p && p->pDirty; p=p->pDirty){
  46372. assert( p->pgno < p->pDirty->pgno );
  46373. }
  46374. #endif
  46375. assert( pList->pDirty==0 || isCommit );
  46376. if( isCommit ){
  46377. /* If a WAL transaction is being committed, there is no point in writing
  46378. ** any pages with page numbers greater than nTruncate into the WAL file.
  46379. ** They will never be read by any client. So remove them from the pDirty
  46380. ** list here. */
  46381. PgHdr **ppNext = &pList;
  46382. nList = 0;
  46383. for(p=pList; (*ppNext = p)!=0; p=p->pDirty){
  46384. if( p->pgno<=nTruncate ){
  46385. ppNext = &p->pDirty;
  46386. nList++;
  46387. }
  46388. }
  46389. assert( pList );
  46390. }else{
  46391. nList = 1;
  46392. }
  46393. pPager->aStat[PAGER_STAT_WRITE] += nList;
  46394. if( pList->pgno==1 ) pager_write_changecounter(pList);
  46395. rc = sqlite3WalFrames(pPager->pWal,
  46396. pPager->pageSize, pList, nTruncate, isCommit, pPager->walSyncFlags
  46397. );
  46398. if( rc==SQLITE_OK && pPager->pBackup ){
  46399. for(p=pList; p; p=p->pDirty){
  46400. sqlite3BackupUpdate(pPager->pBackup, p->pgno, (u8 *)p->pData);
  46401. }
  46402. }
  46403. #ifdef SQLITE_CHECK_PAGES
  46404. pList = sqlite3PcacheDirtyList(pPager->pPCache);
  46405. for(p=pList; p; p=p->pDirty){
  46406. pager_set_pagehash(p);
  46407. }
  46408. #endif
  46409. return rc;
  46410. }
  46411. /*
  46412. ** Begin a read transaction on the WAL.
  46413. **
  46414. ** This routine used to be called "pagerOpenSnapshot()" because it essentially
  46415. ** makes a snapshot of the database at the current point in time and preserves
  46416. ** that snapshot for use by the reader in spite of concurrently changes by
  46417. ** other writers or checkpointers.
  46418. */
  46419. static int pagerBeginReadTransaction(Pager *pPager){
  46420. int rc; /* Return code */
  46421. int changed = 0; /* True if cache must be reset */
  46422. assert( pagerUseWal(pPager) );
  46423. assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
  46424. /* sqlite3WalEndReadTransaction() was not called for the previous
  46425. ** transaction in locking_mode=EXCLUSIVE. So call it now. If we
  46426. ** are in locking_mode=NORMAL and EndRead() was previously called,
  46427. ** the duplicate call is harmless.
  46428. */
  46429. sqlite3WalEndReadTransaction(pPager->pWal);
  46430. rc = sqlite3WalBeginReadTransaction(pPager->pWal, &changed);
  46431. if( rc!=SQLITE_OK || changed ){
  46432. pager_reset(pPager);
  46433. if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
  46434. }
  46435. return rc;
  46436. }
  46437. #endif
  46438. /*
  46439. ** This function is called as part of the transition from PAGER_OPEN
  46440. ** to PAGER_READER state to determine the size of the database file
  46441. ** in pages (assuming the page size currently stored in Pager.pageSize).
  46442. **
  46443. ** If no error occurs, SQLITE_OK is returned and the size of the database
  46444. ** in pages is stored in *pnPage. Otherwise, an error code (perhaps
  46445. ** SQLITE_IOERR_FSTAT) is returned and *pnPage is left unmodified.
  46446. */
  46447. static int pagerPagecount(Pager *pPager, Pgno *pnPage){
  46448. Pgno nPage; /* Value to return via *pnPage */
  46449. /* Query the WAL sub-system for the database size. The WalDbsize()
  46450. ** function returns zero if the WAL is not open (i.e. Pager.pWal==0), or
  46451. ** if the database size is not available. The database size is not
  46452. ** available from the WAL sub-system if the log file is empty or
  46453. ** contains no valid committed transactions.
  46454. */
  46455. assert( pPager->eState==PAGER_OPEN );
  46456. assert( pPager->eLock>=SHARED_LOCK );
  46457. assert( isOpen(pPager->fd) );
  46458. assert( pPager->tempFile==0 );
  46459. nPage = sqlite3WalDbsize(pPager->pWal);
  46460. /* If the number of pages in the database is not available from the
  46461. ** WAL sub-system, determine the page counte based on the size of
  46462. ** the database file. If the size of the database file is not an
  46463. ** integer multiple of the page-size, round up the result.
  46464. */
  46465. if( nPage==0 && ALWAYS(isOpen(pPager->fd)) ){
  46466. i64 n = 0; /* Size of db file in bytes */
  46467. int rc = sqlite3OsFileSize(pPager->fd, &n);
  46468. if( rc!=SQLITE_OK ){
  46469. return rc;
  46470. }
  46471. nPage = (Pgno)((n+pPager->pageSize-1) / pPager->pageSize);
  46472. }
  46473. /* If the current number of pages in the file is greater than the
  46474. ** configured maximum pager number, increase the allowed limit so
  46475. ** that the file can be read.
  46476. */
  46477. if( nPage>pPager->mxPgno ){
  46478. pPager->mxPgno = (Pgno)nPage;
  46479. }
  46480. *pnPage = nPage;
  46481. return SQLITE_OK;
  46482. }
  46483. #ifndef SQLITE_OMIT_WAL
  46484. /*
  46485. ** Check if the *-wal file that corresponds to the database opened by pPager
  46486. ** exists if the database is not empy, or verify that the *-wal file does
  46487. ** not exist (by deleting it) if the database file is empty.
  46488. **
  46489. ** If the database is not empty and the *-wal file exists, open the pager
  46490. ** in WAL mode. If the database is empty or if no *-wal file exists and
  46491. ** if no error occurs, make sure Pager.journalMode is not set to
  46492. ** PAGER_JOURNALMODE_WAL.
  46493. **
  46494. ** Return SQLITE_OK or an error code.
  46495. **
  46496. ** The caller must hold a SHARED lock on the database file to call this
  46497. ** function. Because an EXCLUSIVE lock on the db file is required to delete
  46498. ** a WAL on a none-empty database, this ensures there is no race condition
  46499. ** between the xAccess() below and an xDelete() being executed by some
  46500. ** other connection.
  46501. */
  46502. static int pagerOpenWalIfPresent(Pager *pPager){
  46503. int rc = SQLITE_OK;
  46504. assert( pPager->eState==PAGER_OPEN );
  46505. assert( pPager->eLock>=SHARED_LOCK );
  46506. if( !pPager->tempFile ){
  46507. int isWal; /* True if WAL file exists */
  46508. Pgno nPage; /* Size of the database file */
  46509. rc = pagerPagecount(pPager, &nPage);
  46510. if( rc ) return rc;
  46511. if( nPage==0 ){
  46512. rc = sqlite3OsDelete(pPager->pVfs, pPager->zWal, 0);
  46513. if( rc==SQLITE_IOERR_DELETE_NOENT ) rc = SQLITE_OK;
  46514. isWal = 0;
  46515. }else{
  46516. rc = sqlite3OsAccess(
  46517. pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &isWal
  46518. );
  46519. }
  46520. if( rc==SQLITE_OK ){
  46521. if( isWal ){
  46522. testcase( sqlite3PcachePagecount(pPager->pPCache)==0 );
  46523. rc = sqlite3PagerOpenWal(pPager, 0);
  46524. }else if( pPager->journalMode==PAGER_JOURNALMODE_WAL ){
  46525. pPager->journalMode = PAGER_JOURNALMODE_DELETE;
  46526. }
  46527. }
  46528. }
  46529. return rc;
  46530. }
  46531. #endif
  46532. /*
  46533. ** Playback savepoint pSavepoint. Or, if pSavepoint==NULL, then playback
  46534. ** the entire master journal file. The case pSavepoint==NULL occurs when
  46535. ** a ROLLBACK TO command is invoked on a SAVEPOINT that is a transaction
  46536. ** savepoint.
  46537. **
  46538. ** When pSavepoint is not NULL (meaning a non-transaction savepoint is
  46539. ** being rolled back), then the rollback consists of up to three stages,
  46540. ** performed in the order specified:
  46541. **
  46542. ** * Pages are played back from the main journal starting at byte
  46543. ** offset PagerSavepoint.iOffset and continuing to
  46544. ** PagerSavepoint.iHdrOffset, or to the end of the main journal
  46545. ** file if PagerSavepoint.iHdrOffset is zero.
  46546. **
  46547. ** * If PagerSavepoint.iHdrOffset is not zero, then pages are played
  46548. ** back starting from the journal header immediately following
  46549. ** PagerSavepoint.iHdrOffset to the end of the main journal file.
  46550. **
  46551. ** * Pages are then played back from the sub-journal file, starting
  46552. ** with the PagerSavepoint.iSubRec and continuing to the end of
  46553. ** the journal file.
  46554. **
  46555. ** Throughout the rollback process, each time a page is rolled back, the
  46556. ** corresponding bit is set in a bitvec structure (variable pDone in the
  46557. ** implementation below). This is used to ensure that a page is only
  46558. ** rolled back the first time it is encountered in either journal.
  46559. **
  46560. ** If pSavepoint is NULL, then pages are only played back from the main
  46561. ** journal file. There is no need for a bitvec in this case.
  46562. **
  46563. ** In either case, before playback commences the Pager.dbSize variable
  46564. ** is reset to the value that it held at the start of the savepoint
  46565. ** (or transaction). No page with a page-number greater than this value
  46566. ** is played back. If one is encountered it is simply skipped.
  46567. */
  46568. static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
  46569. i64 szJ; /* Effective size of the main journal */
  46570. i64 iHdrOff; /* End of first segment of main-journal records */
  46571. int rc = SQLITE_OK; /* Return code */
  46572. Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
  46573. assert( pPager->eState!=PAGER_ERROR );
  46574. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  46575. /* Allocate a bitvec to use to store the set of pages rolled back */
  46576. if( pSavepoint ){
  46577. pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
  46578. if( !pDone ){
  46579. return SQLITE_NOMEM_BKPT;
  46580. }
  46581. }
  46582. /* Set the database size back to the value it was before the savepoint
  46583. ** being reverted was opened.
  46584. */
  46585. pPager->dbSize = pSavepoint ? pSavepoint->nOrig : pPager->dbOrigSize;
  46586. pPager->changeCountDone = pPager->tempFile;
  46587. if( !pSavepoint && pagerUseWal(pPager) ){
  46588. return pagerRollbackWal(pPager);
  46589. }
  46590. /* Use pPager->journalOff as the effective size of the main rollback
  46591. ** journal. The actual file might be larger than this in
  46592. ** PAGER_JOURNALMODE_TRUNCATE or PAGER_JOURNALMODE_PERSIST. But anything
  46593. ** past pPager->journalOff is off-limits to us.
  46594. */
  46595. szJ = pPager->journalOff;
  46596. assert( pagerUseWal(pPager)==0 || szJ==0 );
  46597. /* Begin by rolling back records from the main journal starting at
  46598. ** PagerSavepoint.iOffset and continuing to the next journal header.
  46599. ** There might be records in the main journal that have a page number
  46600. ** greater than the current database size (pPager->dbSize) but those
  46601. ** will be skipped automatically. Pages are added to pDone as they
  46602. ** are played back.
  46603. */
  46604. if( pSavepoint && !pagerUseWal(pPager) ){
  46605. iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
  46606. pPager->journalOff = pSavepoint->iOffset;
  46607. while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
  46608. rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
  46609. }
  46610. assert( rc!=SQLITE_DONE );
  46611. }else{
  46612. pPager->journalOff = 0;
  46613. }
  46614. /* Continue rolling back records out of the main journal starting at
  46615. ** the first journal header seen and continuing until the effective end
  46616. ** of the main journal file. Continue to skip out-of-range pages and
  46617. ** continue adding pages rolled back to pDone.
  46618. */
  46619. while( rc==SQLITE_OK && pPager->journalOff<szJ ){
  46620. u32 ii; /* Loop counter */
  46621. u32 nJRec = 0; /* Number of Journal Records */
  46622. u32 dummy;
  46623. rc = readJournalHdr(pPager, 0, szJ, &nJRec, &dummy);
  46624. assert( rc!=SQLITE_DONE );
  46625. /*
  46626. ** The "pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff"
  46627. ** test is related to ticket #2565. See the discussion in the
  46628. ** pager_playback() function for additional information.
  46629. */
  46630. if( nJRec==0
  46631. && pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff
  46632. ){
  46633. nJRec = (u32)((szJ - pPager->journalOff)/JOURNAL_PG_SZ(pPager));
  46634. }
  46635. for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
  46636. rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
  46637. }
  46638. assert( rc!=SQLITE_DONE );
  46639. }
  46640. assert( rc!=SQLITE_OK || pPager->journalOff>=szJ );
  46641. /* Finally, rollback pages from the sub-journal. Page that were
  46642. ** previously rolled back out of the main journal (and are hence in pDone)
  46643. ** will be skipped. Out-of-range pages are also skipped.
  46644. */
  46645. if( pSavepoint ){
  46646. u32 ii; /* Loop counter */
  46647. i64 offset = (i64)pSavepoint->iSubRec*(4+pPager->pageSize);
  46648. if( pagerUseWal(pPager) ){
  46649. rc = sqlite3WalSavepointUndo(pPager->pWal, pSavepoint->aWalData);
  46650. }
  46651. for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->nSubRec; ii++){
  46652. assert( offset==(i64)ii*(4+pPager->pageSize) );
  46653. rc = pager_playback_one_page(pPager, &offset, pDone, 0, 1);
  46654. }
  46655. assert( rc!=SQLITE_DONE );
  46656. }
  46657. sqlite3BitvecDestroy(pDone);
  46658. if( rc==SQLITE_OK ){
  46659. pPager->journalOff = szJ;
  46660. }
  46661. return rc;
  46662. }
  46663. /*
  46664. ** Change the maximum number of in-memory pages that are allowed
  46665. ** before attempting to recycle clean and unused pages.
  46666. */
  46667. SQLITE_PRIVATE void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
  46668. sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
  46669. }
  46670. /*
  46671. ** Change the maximum number of in-memory pages that are allowed
  46672. ** before attempting to spill pages to journal.
  46673. */
  46674. SQLITE_PRIVATE int sqlite3PagerSetSpillsize(Pager *pPager, int mxPage){
  46675. return sqlite3PcacheSetSpillsize(pPager->pPCache, mxPage);
  46676. }
  46677. /*
  46678. ** Invoke SQLITE_FCNTL_MMAP_SIZE based on the current value of szMmap.
  46679. */
  46680. static void pagerFixMaplimit(Pager *pPager){
  46681. #if SQLITE_MAX_MMAP_SIZE>0
  46682. sqlite3_file *fd = pPager->fd;
  46683. if( isOpen(fd) && fd->pMethods->iVersion>=3 ){
  46684. sqlite3_int64 sz;
  46685. sz = pPager->szMmap;
  46686. pPager->bUseFetch = (sz>0);
  46687. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_MMAP_SIZE, &sz);
  46688. }
  46689. #endif
  46690. }
  46691. /*
  46692. ** Change the maximum size of any memory mapping made of the database file.
  46693. */
  46694. SQLITE_PRIVATE void sqlite3PagerSetMmapLimit(Pager *pPager, sqlite3_int64 szMmap){
  46695. pPager->szMmap = szMmap;
  46696. pagerFixMaplimit(pPager);
  46697. }
  46698. /*
  46699. ** Free as much memory as possible from the pager.
  46700. */
  46701. SQLITE_PRIVATE void sqlite3PagerShrink(Pager *pPager){
  46702. sqlite3PcacheShrink(pPager->pPCache);
  46703. }
  46704. /*
  46705. ** Adjust settings of the pager to those specified in the pgFlags parameter.
  46706. **
  46707. ** The "level" in pgFlags & PAGER_SYNCHRONOUS_MASK sets the robustness
  46708. ** of the database to damage due to OS crashes or power failures by
  46709. ** changing the number of syncs()s when writing the journals.
  46710. ** There are four levels:
  46711. **
  46712. ** OFF sqlite3OsSync() is never called. This is the default
  46713. ** for temporary and transient files.
  46714. **
  46715. ** NORMAL The journal is synced once before writes begin on the
  46716. ** database. This is normally adequate protection, but
  46717. ** it is theoretically possible, though very unlikely,
  46718. ** that an inopertune power failure could leave the journal
  46719. ** in a state which would cause damage to the database
  46720. ** when it is rolled back.
  46721. **
  46722. ** FULL The journal is synced twice before writes begin on the
  46723. ** database (with some additional information - the nRec field
  46724. ** of the journal header - being written in between the two
  46725. ** syncs). If we assume that writing a
  46726. ** single disk sector is atomic, then this mode provides
  46727. ** assurance that the journal will not be corrupted to the
  46728. ** point of causing damage to the database during rollback.
  46729. **
  46730. ** EXTRA This is like FULL except that is also syncs the directory
  46731. ** that contains the rollback journal after the rollback
  46732. ** journal is unlinked.
  46733. **
  46734. ** The above is for a rollback-journal mode. For WAL mode, OFF continues
  46735. ** to mean that no syncs ever occur. NORMAL means that the WAL is synced
  46736. ** prior to the start of checkpoint and that the database file is synced
  46737. ** at the conclusion of the checkpoint if the entire content of the WAL
  46738. ** was written back into the database. But no sync operations occur for
  46739. ** an ordinary commit in NORMAL mode with WAL. FULL means that the WAL
  46740. ** file is synced following each commit operation, in addition to the
  46741. ** syncs associated with NORMAL. There is no difference between FULL
  46742. ** and EXTRA for WAL mode.
  46743. **
  46744. ** Do not confuse synchronous=FULL with SQLITE_SYNC_FULL. The
  46745. ** SQLITE_SYNC_FULL macro means to use the MacOSX-style full-fsync
  46746. ** using fcntl(F_FULLFSYNC). SQLITE_SYNC_NORMAL means to do an
  46747. ** ordinary fsync() call. There is no difference between SQLITE_SYNC_FULL
  46748. ** and SQLITE_SYNC_NORMAL on platforms other than MacOSX. But the
  46749. ** synchronous=FULL versus synchronous=NORMAL setting determines when
  46750. ** the xSync primitive is called and is relevant to all platforms.
  46751. **
  46752. ** Numeric values associated with these states are OFF==1, NORMAL=2,
  46753. ** and FULL=3.
  46754. */
  46755. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  46756. SQLITE_PRIVATE void sqlite3PagerSetFlags(
  46757. Pager *pPager, /* The pager to set safety level for */
  46758. unsigned pgFlags /* Various flags */
  46759. ){
  46760. unsigned level = pgFlags & PAGER_SYNCHRONOUS_MASK;
  46761. if( pPager->tempFile ){
  46762. pPager->noSync = 1;
  46763. pPager->fullSync = 0;
  46764. pPager->extraSync = 0;
  46765. }else{
  46766. pPager->noSync = level==PAGER_SYNCHRONOUS_OFF ?1:0;
  46767. pPager->fullSync = level>=PAGER_SYNCHRONOUS_FULL ?1:0;
  46768. pPager->extraSync = level==PAGER_SYNCHRONOUS_EXTRA ?1:0;
  46769. }
  46770. if( pPager->noSync ){
  46771. pPager->syncFlags = 0;
  46772. pPager->ckptSyncFlags = 0;
  46773. }else if( pgFlags & PAGER_FULLFSYNC ){
  46774. pPager->syncFlags = SQLITE_SYNC_FULL;
  46775. pPager->ckptSyncFlags = SQLITE_SYNC_FULL;
  46776. }else if( pgFlags & PAGER_CKPT_FULLFSYNC ){
  46777. pPager->syncFlags = SQLITE_SYNC_NORMAL;
  46778. pPager->ckptSyncFlags = SQLITE_SYNC_FULL;
  46779. }else{
  46780. pPager->syncFlags = SQLITE_SYNC_NORMAL;
  46781. pPager->ckptSyncFlags = SQLITE_SYNC_NORMAL;
  46782. }
  46783. pPager->walSyncFlags = pPager->syncFlags;
  46784. if( pPager->fullSync ){
  46785. pPager->walSyncFlags |= WAL_SYNC_TRANSACTIONS;
  46786. }
  46787. if( pgFlags & PAGER_CACHESPILL ){
  46788. pPager->doNotSpill &= ~SPILLFLAG_OFF;
  46789. }else{
  46790. pPager->doNotSpill |= SPILLFLAG_OFF;
  46791. }
  46792. }
  46793. #endif
  46794. /*
  46795. ** The following global variable is incremented whenever the library
  46796. ** attempts to open a temporary file. This information is used for
  46797. ** testing and analysis only.
  46798. */
  46799. #ifdef SQLITE_TEST
  46800. SQLITE_API int sqlite3_opentemp_count = 0;
  46801. #endif
  46802. /*
  46803. ** Open a temporary file.
  46804. **
  46805. ** Write the file descriptor into *pFile. Return SQLITE_OK on success
  46806. ** or some other error code if we fail. The OS will automatically
  46807. ** delete the temporary file when it is closed.
  46808. **
  46809. ** The flags passed to the VFS layer xOpen() call are those specified
  46810. ** by parameter vfsFlags ORed with the following:
  46811. **
  46812. ** SQLITE_OPEN_READWRITE
  46813. ** SQLITE_OPEN_CREATE
  46814. ** SQLITE_OPEN_EXCLUSIVE
  46815. ** SQLITE_OPEN_DELETEONCLOSE
  46816. */
  46817. static int pagerOpentemp(
  46818. Pager *pPager, /* The pager object */
  46819. sqlite3_file *pFile, /* Write the file descriptor here */
  46820. int vfsFlags /* Flags passed through to the VFS */
  46821. ){
  46822. int rc; /* Return code */
  46823. #ifdef SQLITE_TEST
  46824. sqlite3_opentemp_count++; /* Used for testing and analysis only */
  46825. #endif
  46826. vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  46827. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
  46828. rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
  46829. assert( rc!=SQLITE_OK || isOpen(pFile) );
  46830. return rc;
  46831. }
  46832. /*
  46833. ** Set the busy handler function.
  46834. **
  46835. ** The pager invokes the busy-handler if sqlite3OsLock() returns
  46836. ** SQLITE_BUSY when trying to upgrade from no-lock to a SHARED lock,
  46837. ** or when trying to upgrade from a RESERVED lock to an EXCLUSIVE
  46838. ** lock. It does *not* invoke the busy handler when upgrading from
  46839. ** SHARED to RESERVED, or when upgrading from SHARED to EXCLUSIVE
  46840. ** (which occurs during hot-journal rollback). Summary:
  46841. **
  46842. ** Transition | Invokes xBusyHandler
  46843. ** --------------------------------------------------------
  46844. ** NO_LOCK -> SHARED_LOCK | Yes
  46845. ** SHARED_LOCK -> RESERVED_LOCK | No
  46846. ** SHARED_LOCK -> EXCLUSIVE_LOCK | No
  46847. ** RESERVED_LOCK -> EXCLUSIVE_LOCK | Yes
  46848. **
  46849. ** If the busy-handler callback returns non-zero, the lock is
  46850. ** retried. If it returns zero, then the SQLITE_BUSY error is
  46851. ** returned to the caller of the pager API function.
  46852. */
  46853. SQLITE_PRIVATE void sqlite3PagerSetBusyhandler(
  46854. Pager *pPager, /* Pager object */
  46855. int (*xBusyHandler)(void *), /* Pointer to busy-handler function */
  46856. void *pBusyHandlerArg /* Argument to pass to xBusyHandler */
  46857. ){
  46858. pPager->xBusyHandler = xBusyHandler;
  46859. pPager->pBusyHandlerArg = pBusyHandlerArg;
  46860. if( isOpen(pPager->fd) ){
  46861. void **ap = (void **)&pPager->xBusyHandler;
  46862. assert( ((int(*)(void *))(ap[0]))==xBusyHandler );
  46863. assert( ap[1]==pBusyHandlerArg );
  46864. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_BUSYHANDLER, (void *)ap);
  46865. }
  46866. }
  46867. /*
  46868. ** Change the page size used by the Pager object. The new page size
  46869. ** is passed in *pPageSize.
  46870. **
  46871. ** If the pager is in the error state when this function is called, it
  46872. ** is a no-op. The value returned is the error state error code (i.e.
  46873. ** one of SQLITE_IOERR, an SQLITE_IOERR_xxx sub-code or SQLITE_FULL).
  46874. **
  46875. ** Otherwise, if all of the following are true:
  46876. **
  46877. ** * the new page size (value of *pPageSize) is valid (a power
  46878. ** of two between 512 and SQLITE_MAX_PAGE_SIZE, inclusive), and
  46879. **
  46880. ** * there are no outstanding page references, and
  46881. **
  46882. ** * the database is either not an in-memory database or it is
  46883. ** an in-memory database that currently consists of zero pages.
  46884. **
  46885. ** then the pager object page size is set to *pPageSize.
  46886. **
  46887. ** If the page size is changed, then this function uses sqlite3PagerMalloc()
  46888. ** to obtain a new Pager.pTmpSpace buffer. If this allocation attempt
  46889. ** fails, SQLITE_NOMEM is returned and the page size remains unchanged.
  46890. ** In all other cases, SQLITE_OK is returned.
  46891. **
  46892. ** If the page size is not changed, either because one of the enumerated
  46893. ** conditions above is not true, the pager was in error state when this
  46894. ** function was called, or because the memory allocation attempt failed,
  46895. ** then *pPageSize is set to the old, retained page size before returning.
  46896. */
  46897. SQLITE_PRIVATE int sqlite3PagerSetPagesize(Pager *pPager, u32 *pPageSize, int nReserve){
  46898. int rc = SQLITE_OK;
  46899. /* It is not possible to do a full assert_pager_state() here, as this
  46900. ** function may be called from within PagerOpen(), before the state
  46901. ** of the Pager object is internally consistent.
  46902. **
  46903. ** At one point this function returned an error if the pager was in
  46904. ** PAGER_ERROR state. But since PAGER_ERROR state guarantees that
  46905. ** there is at least one outstanding page reference, this function
  46906. ** is a no-op for that case anyhow.
  46907. */
  46908. u32 pageSize = *pPageSize;
  46909. assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
  46910. if( (pPager->memDb==0 || pPager->dbSize==0)
  46911. && sqlite3PcacheRefCount(pPager->pPCache)==0
  46912. && pageSize && pageSize!=(u32)pPager->pageSize
  46913. ){
  46914. char *pNew = NULL; /* New temp space */
  46915. i64 nByte = 0;
  46916. if( pPager->eState>PAGER_OPEN && isOpen(pPager->fd) ){
  46917. rc = sqlite3OsFileSize(pPager->fd, &nByte);
  46918. }
  46919. if( rc==SQLITE_OK ){
  46920. pNew = (char *)sqlite3PageMalloc(pageSize);
  46921. if( !pNew ) rc = SQLITE_NOMEM_BKPT;
  46922. }
  46923. if( rc==SQLITE_OK ){
  46924. pager_reset(pPager);
  46925. rc = sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
  46926. }
  46927. if( rc==SQLITE_OK ){
  46928. sqlite3PageFree(pPager->pTmpSpace);
  46929. pPager->pTmpSpace = pNew;
  46930. pPager->dbSize = (Pgno)((nByte+pageSize-1)/pageSize);
  46931. pPager->pageSize = pageSize;
  46932. }else{
  46933. sqlite3PageFree(pNew);
  46934. }
  46935. }
  46936. *pPageSize = pPager->pageSize;
  46937. if( rc==SQLITE_OK ){
  46938. if( nReserve<0 ) nReserve = pPager->nReserve;
  46939. assert( nReserve>=0 && nReserve<1000 );
  46940. pPager->nReserve = (i16)nReserve;
  46941. pagerReportSize(pPager);
  46942. pagerFixMaplimit(pPager);
  46943. }
  46944. return rc;
  46945. }
  46946. /*
  46947. ** Return a pointer to the "temporary page" buffer held internally
  46948. ** by the pager. This is a buffer that is big enough to hold the
  46949. ** entire content of a database page. This buffer is used internally
  46950. ** during rollback and will be overwritten whenever a rollback
  46951. ** occurs. But other modules are free to use it too, as long as
  46952. ** no rollbacks are happening.
  46953. */
  46954. SQLITE_PRIVATE void *sqlite3PagerTempSpace(Pager *pPager){
  46955. return pPager->pTmpSpace;
  46956. }
  46957. /*
  46958. ** Attempt to set the maximum database page count if mxPage is positive.
  46959. ** Make no changes if mxPage is zero or negative. And never reduce the
  46960. ** maximum page count below the current size of the database.
  46961. **
  46962. ** Regardless of mxPage, return the current maximum page count.
  46963. */
  46964. SQLITE_PRIVATE int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
  46965. if( mxPage>0 ){
  46966. pPager->mxPgno = mxPage;
  46967. }
  46968. assert( pPager->eState!=PAGER_OPEN ); /* Called only by OP_MaxPgcnt */
  46969. assert( pPager->mxPgno>=pPager->dbSize ); /* OP_MaxPgcnt enforces this */
  46970. return pPager->mxPgno;
  46971. }
  46972. /*
  46973. ** The following set of routines are used to disable the simulated
  46974. ** I/O error mechanism. These routines are used to avoid simulated
  46975. ** errors in places where we do not care about errors.
  46976. **
  46977. ** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
  46978. ** and generate no code.
  46979. */
  46980. #ifdef SQLITE_TEST
  46981. SQLITE_API extern int sqlite3_io_error_pending;
  46982. SQLITE_API extern int sqlite3_io_error_hit;
  46983. static int saved_cnt;
  46984. void disable_simulated_io_errors(void){
  46985. saved_cnt = sqlite3_io_error_pending;
  46986. sqlite3_io_error_pending = -1;
  46987. }
  46988. void enable_simulated_io_errors(void){
  46989. sqlite3_io_error_pending = saved_cnt;
  46990. }
  46991. #else
  46992. # define disable_simulated_io_errors()
  46993. # define enable_simulated_io_errors()
  46994. #endif
  46995. /*
  46996. ** Read the first N bytes from the beginning of the file into memory
  46997. ** that pDest points to.
  46998. **
  46999. ** If the pager was opened on a transient file (zFilename==""), or
  47000. ** opened on a file less than N bytes in size, the output buffer is
  47001. ** zeroed and SQLITE_OK returned. The rationale for this is that this
  47002. ** function is used to read database headers, and a new transient or
  47003. ** zero sized database has a header than consists entirely of zeroes.
  47004. **
  47005. ** If any IO error apart from SQLITE_IOERR_SHORT_READ is encountered,
  47006. ** the error code is returned to the caller and the contents of the
  47007. ** output buffer undefined.
  47008. */
  47009. SQLITE_PRIVATE int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
  47010. int rc = SQLITE_OK;
  47011. memset(pDest, 0, N);
  47012. assert( isOpen(pPager->fd) || pPager->tempFile );
  47013. /* This routine is only called by btree immediately after creating
  47014. ** the Pager object. There has not been an opportunity to transition
  47015. ** to WAL mode yet.
  47016. */
  47017. assert( !pagerUseWal(pPager) );
  47018. if( isOpen(pPager->fd) ){
  47019. IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
  47020. rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
  47021. if( rc==SQLITE_IOERR_SHORT_READ ){
  47022. rc = SQLITE_OK;
  47023. }
  47024. }
  47025. return rc;
  47026. }
  47027. /*
  47028. ** This function may only be called when a read-transaction is open on
  47029. ** the pager. It returns the total number of pages in the database.
  47030. **
  47031. ** However, if the file is between 1 and <page-size> bytes in size, then
  47032. ** this is considered a 1 page file.
  47033. */
  47034. SQLITE_PRIVATE void sqlite3PagerPagecount(Pager *pPager, int *pnPage){
  47035. assert( pPager->eState>=PAGER_READER );
  47036. assert( pPager->eState!=PAGER_WRITER_FINISHED );
  47037. *pnPage = (int)pPager->dbSize;
  47038. }
  47039. /*
  47040. ** Try to obtain a lock of type locktype on the database file. If
  47041. ** a similar or greater lock is already held, this function is a no-op
  47042. ** (returning SQLITE_OK immediately).
  47043. **
  47044. ** Otherwise, attempt to obtain the lock using sqlite3OsLock(). Invoke
  47045. ** the busy callback if the lock is currently not available. Repeat
  47046. ** until the busy callback returns false or until the attempt to
  47047. ** obtain the lock succeeds.
  47048. **
  47049. ** Return SQLITE_OK on success and an error code if we cannot obtain
  47050. ** the lock. If the lock is obtained successfully, set the Pager.state
  47051. ** variable to locktype before returning.
  47052. */
  47053. static int pager_wait_on_lock(Pager *pPager, int locktype){
  47054. int rc; /* Return code */
  47055. /* Check that this is either a no-op (because the requested lock is
  47056. ** already held), or one of the transitions that the busy-handler
  47057. ** may be invoked during, according to the comment above
  47058. ** sqlite3PagerSetBusyhandler().
  47059. */
  47060. assert( (pPager->eLock>=locktype)
  47061. || (pPager->eLock==NO_LOCK && locktype==SHARED_LOCK)
  47062. || (pPager->eLock==RESERVED_LOCK && locktype==EXCLUSIVE_LOCK)
  47063. );
  47064. do {
  47065. rc = pagerLockDb(pPager, locktype);
  47066. }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
  47067. return rc;
  47068. }
  47069. /*
  47070. ** Function assertTruncateConstraint(pPager) checks that one of the
  47071. ** following is true for all dirty pages currently in the page-cache:
  47072. **
  47073. ** a) The page number is less than or equal to the size of the
  47074. ** current database image, in pages, OR
  47075. **
  47076. ** b) if the page content were written at this time, it would not
  47077. ** be necessary to write the current content out to the sub-journal
  47078. ** (as determined by function subjRequiresPage()).
  47079. **
  47080. ** If the condition asserted by this function were not true, and the
  47081. ** dirty page were to be discarded from the cache via the pagerStress()
  47082. ** routine, pagerStress() would not write the current page content to
  47083. ** the database file. If a savepoint transaction were rolled back after
  47084. ** this happened, the correct behavior would be to restore the current
  47085. ** content of the page. However, since this content is not present in either
  47086. ** the database file or the portion of the rollback journal and
  47087. ** sub-journal rolled back the content could not be restored and the
  47088. ** database image would become corrupt. It is therefore fortunate that
  47089. ** this circumstance cannot arise.
  47090. */
  47091. #if defined(SQLITE_DEBUG)
  47092. static void assertTruncateConstraintCb(PgHdr *pPg){
  47093. assert( pPg->flags&PGHDR_DIRTY );
  47094. assert( !subjRequiresPage(pPg) || pPg->pgno<=pPg->pPager->dbSize );
  47095. }
  47096. static void assertTruncateConstraint(Pager *pPager){
  47097. sqlite3PcacheIterateDirty(pPager->pPCache, assertTruncateConstraintCb);
  47098. }
  47099. #else
  47100. # define assertTruncateConstraint(pPager)
  47101. #endif
  47102. /*
  47103. ** Truncate the in-memory database file image to nPage pages. This
  47104. ** function does not actually modify the database file on disk. It
  47105. ** just sets the internal state of the pager object so that the
  47106. ** truncation will be done when the current transaction is committed.
  47107. **
  47108. ** This function is only called right before committing a transaction.
  47109. ** Once this function has been called, the transaction must either be
  47110. ** rolled back or committed. It is not safe to call this function and
  47111. ** then continue writing to the database.
  47112. */
  47113. SQLITE_PRIVATE void sqlite3PagerTruncateImage(Pager *pPager, Pgno nPage){
  47114. assert( pPager->dbSize>=nPage );
  47115. assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
  47116. pPager->dbSize = nPage;
  47117. /* At one point the code here called assertTruncateConstraint() to
  47118. ** ensure that all pages being truncated away by this operation are,
  47119. ** if one or more savepoints are open, present in the savepoint
  47120. ** journal so that they can be restored if the savepoint is rolled
  47121. ** back. This is no longer necessary as this function is now only
  47122. ** called right before committing a transaction. So although the
  47123. ** Pager object may still have open savepoints (Pager.nSavepoint!=0),
  47124. ** they cannot be rolled back. So the assertTruncateConstraint() call
  47125. ** is no longer correct. */
  47126. }
  47127. /*
  47128. ** This function is called before attempting a hot-journal rollback. It
  47129. ** syncs the journal file to disk, then sets pPager->journalHdr to the
  47130. ** size of the journal file so that the pager_playback() routine knows
  47131. ** that the entire journal file has been synced.
  47132. **
  47133. ** Syncing a hot-journal to disk before attempting to roll it back ensures
  47134. ** that if a power-failure occurs during the rollback, the process that
  47135. ** attempts rollback following system recovery sees the same journal
  47136. ** content as this process.
  47137. **
  47138. ** If everything goes as planned, SQLITE_OK is returned. Otherwise,
  47139. ** an SQLite error code.
  47140. */
  47141. static int pagerSyncHotJournal(Pager *pPager){
  47142. int rc = SQLITE_OK;
  47143. if( !pPager->noSync ){
  47144. rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_NORMAL);
  47145. }
  47146. if( rc==SQLITE_OK ){
  47147. rc = sqlite3OsFileSize(pPager->jfd, &pPager->journalHdr);
  47148. }
  47149. return rc;
  47150. }
  47151. /*
  47152. ** Obtain a reference to a memory mapped page object for page number pgno.
  47153. ** The new object will use the pointer pData, obtained from xFetch().
  47154. ** If successful, set *ppPage to point to the new page reference
  47155. ** and return SQLITE_OK. Otherwise, return an SQLite error code and set
  47156. ** *ppPage to zero.
  47157. **
  47158. ** Page references obtained by calling this function should be released
  47159. ** by calling pagerReleaseMapPage().
  47160. */
  47161. static int pagerAcquireMapPage(
  47162. Pager *pPager, /* Pager object */
  47163. Pgno pgno, /* Page number */
  47164. void *pData, /* xFetch()'d data for this page */
  47165. PgHdr **ppPage /* OUT: Acquired page object */
  47166. ){
  47167. PgHdr *p; /* Memory mapped page to return */
  47168. if( pPager->pMmapFreelist ){
  47169. *ppPage = p = pPager->pMmapFreelist;
  47170. pPager->pMmapFreelist = p->pDirty;
  47171. p->pDirty = 0;
  47172. memset(p->pExtra, 0, pPager->nExtra);
  47173. }else{
  47174. *ppPage = p = (PgHdr *)sqlite3MallocZero(sizeof(PgHdr) + pPager->nExtra);
  47175. if( p==0 ){
  47176. sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1) * pPager->pageSize, pData);
  47177. return SQLITE_NOMEM_BKPT;
  47178. }
  47179. p->pExtra = (void *)&p[1];
  47180. p->flags = PGHDR_MMAP;
  47181. p->nRef = 1;
  47182. p->pPager = pPager;
  47183. }
  47184. assert( p->pExtra==(void *)&p[1] );
  47185. assert( p->pPage==0 );
  47186. assert( p->flags==PGHDR_MMAP );
  47187. assert( p->pPager==pPager );
  47188. assert( p->nRef==1 );
  47189. p->pgno = pgno;
  47190. p->pData = pData;
  47191. pPager->nMmapOut++;
  47192. return SQLITE_OK;
  47193. }
  47194. /*
  47195. ** Release a reference to page pPg. pPg must have been returned by an
  47196. ** earlier call to pagerAcquireMapPage().
  47197. */
  47198. static void pagerReleaseMapPage(PgHdr *pPg){
  47199. Pager *pPager = pPg->pPager;
  47200. pPager->nMmapOut--;
  47201. pPg->pDirty = pPager->pMmapFreelist;
  47202. pPager->pMmapFreelist = pPg;
  47203. assert( pPager->fd->pMethods->iVersion>=3 );
  47204. sqlite3OsUnfetch(pPager->fd, (i64)(pPg->pgno-1)*pPager->pageSize, pPg->pData);
  47205. }
  47206. /*
  47207. ** Free all PgHdr objects stored in the Pager.pMmapFreelist list.
  47208. */
  47209. static void pagerFreeMapHdrs(Pager *pPager){
  47210. PgHdr *p;
  47211. PgHdr *pNext;
  47212. for(p=pPager->pMmapFreelist; p; p=pNext){
  47213. pNext = p->pDirty;
  47214. sqlite3_free(p);
  47215. }
  47216. }
  47217. /*
  47218. ** Shutdown the page cache. Free all memory and close all files.
  47219. **
  47220. ** If a transaction was in progress when this routine is called, that
  47221. ** transaction is rolled back. All outstanding pages are invalidated
  47222. ** and their memory is freed. Any attempt to use a page associated
  47223. ** with this page cache after this function returns will likely
  47224. ** result in a coredump.
  47225. **
  47226. ** This function always succeeds. If a transaction is active an attempt
  47227. ** is made to roll it back. If an error occurs during the rollback
  47228. ** a hot journal may be left in the filesystem but no error is returned
  47229. ** to the caller.
  47230. */
  47231. SQLITE_PRIVATE int sqlite3PagerClose(Pager *pPager){
  47232. u8 *pTmp = (u8 *)pPager->pTmpSpace;
  47233. assert( assert_pager_state(pPager) );
  47234. disable_simulated_io_errors();
  47235. sqlite3BeginBenignMalloc();
  47236. pagerFreeMapHdrs(pPager);
  47237. /* pPager->errCode = 0; */
  47238. pPager->exclusiveMode = 0;
  47239. #ifndef SQLITE_OMIT_WAL
  47240. sqlite3WalClose(pPager->pWal, pPager->ckptSyncFlags, pPager->pageSize, pTmp);
  47241. pPager->pWal = 0;
  47242. #endif
  47243. pager_reset(pPager);
  47244. if( MEMDB ){
  47245. pager_unlock(pPager);
  47246. }else{
  47247. /* If it is open, sync the journal file before calling UnlockAndRollback.
  47248. ** If this is not done, then an unsynced portion of the open journal
  47249. ** file may be played back into the database. If a power failure occurs
  47250. ** while this is happening, the database could become corrupt.
  47251. **
  47252. ** If an error occurs while trying to sync the journal, shift the pager
  47253. ** into the ERROR state. This causes UnlockAndRollback to unlock the
  47254. ** database and close the journal file without attempting to roll it
  47255. ** back or finalize it. The next database user will have to do hot-journal
  47256. ** rollback before accessing the database file.
  47257. */
  47258. if( isOpen(pPager->jfd) ){
  47259. pager_error(pPager, pagerSyncHotJournal(pPager));
  47260. }
  47261. pagerUnlockAndRollback(pPager);
  47262. }
  47263. sqlite3EndBenignMalloc();
  47264. enable_simulated_io_errors();
  47265. PAGERTRACE(("CLOSE %d\n", PAGERID(pPager)));
  47266. IOTRACE(("CLOSE %p\n", pPager))
  47267. sqlite3OsClose(pPager->jfd);
  47268. sqlite3OsClose(pPager->fd);
  47269. sqlite3PageFree(pTmp);
  47270. sqlite3PcacheClose(pPager->pPCache);
  47271. #ifdef SQLITE_HAS_CODEC
  47272. if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
  47273. #endif
  47274. assert( !pPager->aSavepoint && !pPager->pInJournal );
  47275. assert( !isOpen(pPager->jfd) && !isOpen(pPager->sjfd) );
  47276. sqlite3_free(pPager);
  47277. return SQLITE_OK;
  47278. }
  47279. #if !defined(NDEBUG) || defined(SQLITE_TEST)
  47280. /*
  47281. ** Return the page number for page pPg.
  47282. */
  47283. SQLITE_PRIVATE Pgno sqlite3PagerPagenumber(DbPage *pPg){
  47284. return pPg->pgno;
  47285. }
  47286. #endif
  47287. /*
  47288. ** Increment the reference count for page pPg.
  47289. */
  47290. SQLITE_PRIVATE void sqlite3PagerRef(DbPage *pPg){
  47291. sqlite3PcacheRef(pPg);
  47292. }
  47293. /*
  47294. ** Sync the journal. In other words, make sure all the pages that have
  47295. ** been written to the journal have actually reached the surface of the
  47296. ** disk and can be restored in the event of a hot-journal rollback.
  47297. **
  47298. ** If the Pager.noSync flag is set, then this function is a no-op.
  47299. ** Otherwise, the actions required depend on the journal-mode and the
  47300. ** device characteristics of the file-system, as follows:
  47301. **
  47302. ** * If the journal file is an in-memory journal file, no action need
  47303. ** be taken.
  47304. **
  47305. ** * Otherwise, if the device does not support the SAFE_APPEND property,
  47306. ** then the nRec field of the most recently written journal header
  47307. ** is updated to contain the number of journal records that have
  47308. ** been written following it. If the pager is operating in full-sync
  47309. ** mode, then the journal file is synced before this field is updated.
  47310. **
  47311. ** * If the device does not support the SEQUENTIAL property, then
  47312. ** journal file is synced.
  47313. **
  47314. ** Or, in pseudo-code:
  47315. **
  47316. ** if( NOT <in-memory journal> ){
  47317. ** if( NOT SAFE_APPEND ){
  47318. ** if( <full-sync mode> ) xSync(<journal file>);
  47319. ** <update nRec field>
  47320. ** }
  47321. ** if( NOT SEQUENTIAL ) xSync(<journal file>);
  47322. ** }
  47323. **
  47324. ** If successful, this routine clears the PGHDR_NEED_SYNC flag of every
  47325. ** page currently held in memory before returning SQLITE_OK. If an IO
  47326. ** error is encountered, then the IO error code is returned to the caller.
  47327. */
  47328. static int syncJournal(Pager *pPager, int newHdr){
  47329. int rc; /* Return code */
  47330. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  47331. || pPager->eState==PAGER_WRITER_DBMOD
  47332. );
  47333. assert( assert_pager_state(pPager) );
  47334. assert( !pagerUseWal(pPager) );
  47335. rc = sqlite3PagerExclusiveLock(pPager);
  47336. if( rc!=SQLITE_OK ) return rc;
  47337. if( !pPager->noSync ){
  47338. assert( !pPager->tempFile );
  47339. if( isOpen(pPager->jfd) && pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
  47340. const int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
  47341. assert( isOpen(pPager->jfd) );
  47342. if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
  47343. /* This block deals with an obscure problem. If the last connection
  47344. ** that wrote to this database was operating in persistent-journal
  47345. ** mode, then the journal file may at this point actually be larger
  47346. ** than Pager.journalOff bytes. If the next thing in the journal
  47347. ** file happens to be a journal-header (written as part of the
  47348. ** previous connection's transaction), and a crash or power-failure
  47349. ** occurs after nRec is updated but before this connection writes
  47350. ** anything else to the journal file (or commits/rolls back its
  47351. ** transaction), then SQLite may become confused when doing the
  47352. ** hot-journal rollback following recovery. It may roll back all
  47353. ** of this connections data, then proceed to rolling back the old,
  47354. ** out-of-date data that follows it. Database corruption.
  47355. **
  47356. ** To work around this, if the journal file does appear to contain
  47357. ** a valid header following Pager.journalOff, then write a 0x00
  47358. ** byte to the start of it to prevent it from being recognized.
  47359. **
  47360. ** Variable iNextHdrOffset is set to the offset at which this
  47361. ** problematic header will occur, if it exists. aMagic is used
  47362. ** as a temporary buffer to inspect the first couple of bytes of
  47363. ** the potential journal header.
  47364. */
  47365. i64 iNextHdrOffset;
  47366. u8 aMagic[8];
  47367. u8 zHeader[sizeof(aJournalMagic)+4];
  47368. memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
  47369. put32bits(&zHeader[sizeof(aJournalMagic)], pPager->nRec);
  47370. iNextHdrOffset = journalHdrOffset(pPager);
  47371. rc = sqlite3OsRead(pPager->jfd, aMagic, 8, iNextHdrOffset);
  47372. if( rc==SQLITE_OK && 0==memcmp(aMagic, aJournalMagic, 8) ){
  47373. static const u8 zerobyte = 0;
  47374. rc = sqlite3OsWrite(pPager->jfd, &zerobyte, 1, iNextHdrOffset);
  47375. }
  47376. if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
  47377. return rc;
  47378. }
  47379. /* Write the nRec value into the journal file header. If in
  47380. ** full-synchronous mode, sync the journal first. This ensures that
  47381. ** all data has really hit the disk before nRec is updated to mark
  47382. ** it as a candidate for rollback.
  47383. **
  47384. ** This is not required if the persistent media supports the
  47385. ** SAFE_APPEND property. Because in this case it is not possible
  47386. ** for garbage data to be appended to the file, the nRec field
  47387. ** is populated with 0xFFFFFFFF when the journal header is written
  47388. ** and never needs to be updated.
  47389. */
  47390. if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
  47391. PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
  47392. IOTRACE(("JSYNC %p\n", pPager))
  47393. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
  47394. if( rc!=SQLITE_OK ) return rc;
  47395. }
  47396. IOTRACE(("JHDR %p %lld\n", pPager, pPager->journalHdr));
  47397. rc = sqlite3OsWrite(
  47398. pPager->jfd, zHeader, sizeof(zHeader), pPager->journalHdr
  47399. );
  47400. if( rc!=SQLITE_OK ) return rc;
  47401. }
  47402. if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
  47403. PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
  47404. IOTRACE(("JSYNC %p\n", pPager))
  47405. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags|
  47406. (pPager->syncFlags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
  47407. );
  47408. if( rc!=SQLITE_OK ) return rc;
  47409. }
  47410. pPager->journalHdr = pPager->journalOff;
  47411. if( newHdr && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
  47412. pPager->nRec = 0;
  47413. rc = writeJournalHdr(pPager);
  47414. if( rc!=SQLITE_OK ) return rc;
  47415. }
  47416. }else{
  47417. pPager->journalHdr = pPager->journalOff;
  47418. }
  47419. }
  47420. /* Unless the pager is in noSync mode, the journal file was just
  47421. ** successfully synced. Either way, clear the PGHDR_NEED_SYNC flag on
  47422. ** all pages.
  47423. */
  47424. sqlite3PcacheClearSyncFlags(pPager->pPCache);
  47425. pPager->eState = PAGER_WRITER_DBMOD;
  47426. assert( assert_pager_state(pPager) );
  47427. return SQLITE_OK;
  47428. }
  47429. /*
  47430. ** The argument is the first in a linked list of dirty pages connected
  47431. ** by the PgHdr.pDirty pointer. This function writes each one of the
  47432. ** in-memory pages in the list to the database file. The argument may
  47433. ** be NULL, representing an empty list. In this case this function is
  47434. ** a no-op.
  47435. **
  47436. ** The pager must hold at least a RESERVED lock when this function
  47437. ** is called. Before writing anything to the database file, this lock
  47438. ** is upgraded to an EXCLUSIVE lock. If the lock cannot be obtained,
  47439. ** SQLITE_BUSY is returned and no data is written to the database file.
  47440. **
  47441. ** If the pager is a temp-file pager and the actual file-system file
  47442. ** is not yet open, it is created and opened before any data is
  47443. ** written out.
  47444. **
  47445. ** Once the lock has been upgraded and, if necessary, the file opened,
  47446. ** the pages are written out to the database file in list order. Writing
  47447. ** a page is skipped if it meets either of the following criteria:
  47448. **
  47449. ** * The page number is greater than Pager.dbSize, or
  47450. ** * The PGHDR_DONT_WRITE flag is set on the page.
  47451. **
  47452. ** If writing out a page causes the database file to grow, Pager.dbFileSize
  47453. ** is updated accordingly. If page 1 is written out, then the value cached
  47454. ** in Pager.dbFileVers[] is updated to match the new value stored in
  47455. ** the database file.
  47456. **
  47457. ** If everything is successful, SQLITE_OK is returned. If an IO error
  47458. ** occurs, an IO error code is returned. Or, if the EXCLUSIVE lock cannot
  47459. ** be obtained, SQLITE_BUSY is returned.
  47460. */
  47461. static int pager_write_pagelist(Pager *pPager, PgHdr *pList){
  47462. int rc = SQLITE_OK; /* Return code */
  47463. /* This function is only called for rollback pagers in WRITER_DBMOD state. */
  47464. assert( !pagerUseWal(pPager) );
  47465. assert( pPager->tempFile || pPager->eState==PAGER_WRITER_DBMOD );
  47466. assert( pPager->eLock==EXCLUSIVE_LOCK );
  47467. assert( isOpen(pPager->fd) || pList->pDirty==0 );
  47468. /* If the file is a temp-file has not yet been opened, open it now. It
  47469. ** is not possible for rc to be other than SQLITE_OK if this branch
  47470. ** is taken, as pager_wait_on_lock() is a no-op for temp-files.
  47471. */
  47472. if( !isOpen(pPager->fd) ){
  47473. assert( pPager->tempFile && rc==SQLITE_OK );
  47474. rc = pagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
  47475. }
  47476. /* Before the first write, give the VFS a hint of what the final
  47477. ** file size will be.
  47478. */
  47479. assert( rc!=SQLITE_OK || isOpen(pPager->fd) );
  47480. if( rc==SQLITE_OK
  47481. && pPager->dbHintSize<pPager->dbSize
  47482. && (pList->pDirty || pList->pgno>pPager->dbHintSize)
  47483. ){
  47484. sqlite3_int64 szFile = pPager->pageSize * (sqlite3_int64)pPager->dbSize;
  47485. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_SIZE_HINT, &szFile);
  47486. pPager->dbHintSize = pPager->dbSize;
  47487. }
  47488. while( rc==SQLITE_OK && pList ){
  47489. Pgno pgno = pList->pgno;
  47490. /* If there are dirty pages in the page cache with page numbers greater
  47491. ** than Pager.dbSize, this means sqlite3PagerTruncateImage() was called to
  47492. ** make the file smaller (presumably by auto-vacuum code). Do not write
  47493. ** any such pages to the file.
  47494. **
  47495. ** Also, do not write out any page that has the PGHDR_DONT_WRITE flag
  47496. ** set (set by sqlite3PagerDontWrite()).
  47497. */
  47498. if( pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
  47499. i64 offset = (pgno-1)*(i64)pPager->pageSize; /* Offset to write */
  47500. char *pData; /* Data to write */
  47501. assert( (pList->flags&PGHDR_NEED_SYNC)==0 );
  47502. if( pList->pgno==1 ) pager_write_changecounter(pList);
  47503. /* Encode the database */
  47504. CODEC2(pPager, pList->pData, pgno, 6, return SQLITE_NOMEM_BKPT, pData);
  47505. /* Write out the page data. */
  47506. rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
  47507. /* If page 1 was just written, update Pager.dbFileVers to match
  47508. ** the value now stored in the database file. If writing this
  47509. ** page caused the database file to grow, update dbFileSize.
  47510. */
  47511. if( pgno==1 ){
  47512. memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
  47513. }
  47514. if( pgno>pPager->dbFileSize ){
  47515. pPager->dbFileSize = pgno;
  47516. }
  47517. pPager->aStat[PAGER_STAT_WRITE]++;
  47518. /* Update any backup objects copying the contents of this pager. */
  47519. sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)pList->pData);
  47520. PAGERTRACE(("STORE %d page %d hash(%08x)\n",
  47521. PAGERID(pPager), pgno, pager_pagehash(pList)));
  47522. IOTRACE(("PGOUT %p %d\n", pPager, pgno));
  47523. PAGER_INCR(sqlite3_pager_writedb_count);
  47524. }else{
  47525. PAGERTRACE(("NOSTORE %d page %d\n", PAGERID(pPager), pgno));
  47526. }
  47527. pager_set_pagehash(pList);
  47528. pList = pList->pDirty;
  47529. }
  47530. return rc;
  47531. }
  47532. /*
  47533. ** Ensure that the sub-journal file is open. If it is already open, this
  47534. ** function is a no-op.
  47535. **
  47536. ** SQLITE_OK is returned if everything goes according to plan. An
  47537. ** SQLITE_IOERR_XXX error code is returned if a call to sqlite3OsOpen()
  47538. ** fails.
  47539. */
  47540. static int openSubJournal(Pager *pPager){
  47541. int rc = SQLITE_OK;
  47542. if( !isOpen(pPager->sjfd) ){
  47543. const int flags = SQLITE_OPEN_SUBJOURNAL | SQLITE_OPEN_READWRITE
  47544. | SQLITE_OPEN_CREATE | SQLITE_OPEN_EXCLUSIVE
  47545. | SQLITE_OPEN_DELETEONCLOSE;
  47546. int nStmtSpill = sqlite3Config.nStmtSpill;
  47547. if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY || pPager->subjInMemory ){
  47548. nStmtSpill = -1;
  47549. }
  47550. rc = sqlite3JournalOpen(pPager->pVfs, 0, pPager->sjfd, flags, nStmtSpill);
  47551. }
  47552. return rc;
  47553. }
  47554. /*
  47555. ** Append a record of the current state of page pPg to the sub-journal.
  47556. **
  47557. ** If successful, set the bit corresponding to pPg->pgno in the bitvecs
  47558. ** for all open savepoints before returning.
  47559. **
  47560. ** This function returns SQLITE_OK if everything is successful, an IO
  47561. ** error code if the attempt to write to the sub-journal fails, or
  47562. ** SQLITE_NOMEM if a malloc fails while setting a bit in a savepoint
  47563. ** bitvec.
  47564. */
  47565. static int subjournalPage(PgHdr *pPg){
  47566. int rc = SQLITE_OK;
  47567. Pager *pPager = pPg->pPager;
  47568. if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
  47569. /* Open the sub-journal, if it has not already been opened */
  47570. assert( pPager->useJournal );
  47571. assert( isOpen(pPager->jfd) || pagerUseWal(pPager) );
  47572. assert( isOpen(pPager->sjfd) || pPager->nSubRec==0 );
  47573. assert( pagerUseWal(pPager)
  47574. || pageInJournal(pPager, pPg)
  47575. || pPg->pgno>pPager->dbOrigSize
  47576. );
  47577. rc = openSubJournal(pPager);
  47578. /* If the sub-journal was opened successfully (or was already open),
  47579. ** write the journal record into the file. */
  47580. if( rc==SQLITE_OK ){
  47581. void *pData = pPg->pData;
  47582. i64 offset = (i64)pPager->nSubRec*(4+pPager->pageSize);
  47583. char *pData2;
  47584. CODEC2(pPager, pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
  47585. PAGERTRACE(("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno));
  47586. rc = write32bits(pPager->sjfd, offset, pPg->pgno);
  47587. if( rc==SQLITE_OK ){
  47588. rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
  47589. }
  47590. }
  47591. }
  47592. if( rc==SQLITE_OK ){
  47593. pPager->nSubRec++;
  47594. assert( pPager->nSavepoint>0 );
  47595. rc = addToSavepointBitvecs(pPager, pPg->pgno);
  47596. }
  47597. return rc;
  47598. }
  47599. static int subjournalPageIfRequired(PgHdr *pPg){
  47600. if( subjRequiresPage(pPg) ){
  47601. return subjournalPage(pPg);
  47602. }else{
  47603. return SQLITE_OK;
  47604. }
  47605. }
  47606. /*
  47607. ** This function is called by the pcache layer when it has reached some
  47608. ** soft memory limit. The first argument is a pointer to a Pager object
  47609. ** (cast as a void*). The pager is always 'purgeable' (not an in-memory
  47610. ** database). The second argument is a reference to a page that is
  47611. ** currently dirty but has no outstanding references. The page
  47612. ** is always associated with the Pager object passed as the first
  47613. ** argument.
  47614. **
  47615. ** The job of this function is to make pPg clean by writing its contents
  47616. ** out to the database file, if possible. This may involve syncing the
  47617. ** journal file.
  47618. **
  47619. ** If successful, sqlite3PcacheMakeClean() is called on the page and
  47620. ** SQLITE_OK returned. If an IO error occurs while trying to make the
  47621. ** page clean, the IO error code is returned. If the page cannot be
  47622. ** made clean for some other reason, but no error occurs, then SQLITE_OK
  47623. ** is returned by sqlite3PcacheMakeClean() is not called.
  47624. */
  47625. static int pagerStress(void *p, PgHdr *pPg){
  47626. Pager *pPager = (Pager *)p;
  47627. int rc = SQLITE_OK;
  47628. assert( pPg->pPager==pPager );
  47629. assert( pPg->flags&PGHDR_DIRTY );
  47630. /* The doNotSpill NOSYNC bit is set during times when doing a sync of
  47631. ** journal (and adding a new header) is not allowed. This occurs
  47632. ** during calls to sqlite3PagerWrite() while trying to journal multiple
  47633. ** pages belonging to the same sector.
  47634. **
  47635. ** The doNotSpill ROLLBACK and OFF bits inhibits all cache spilling
  47636. ** regardless of whether or not a sync is required. This is set during
  47637. ** a rollback or by user request, respectively.
  47638. **
  47639. ** Spilling is also prohibited when in an error state since that could
  47640. ** lead to database corruption. In the current implementation it
  47641. ** is impossible for sqlite3PcacheFetch() to be called with createFlag==3
  47642. ** while in the error state, hence it is impossible for this routine to
  47643. ** be called in the error state. Nevertheless, we include a NEVER()
  47644. ** test for the error state as a safeguard against future changes.
  47645. */
  47646. if( NEVER(pPager->errCode) ) return SQLITE_OK;
  47647. testcase( pPager->doNotSpill & SPILLFLAG_ROLLBACK );
  47648. testcase( pPager->doNotSpill & SPILLFLAG_OFF );
  47649. testcase( pPager->doNotSpill & SPILLFLAG_NOSYNC );
  47650. if( pPager->doNotSpill
  47651. && ((pPager->doNotSpill & (SPILLFLAG_ROLLBACK|SPILLFLAG_OFF))!=0
  47652. || (pPg->flags & PGHDR_NEED_SYNC)!=0)
  47653. ){
  47654. return SQLITE_OK;
  47655. }
  47656. pPg->pDirty = 0;
  47657. if( pagerUseWal(pPager) ){
  47658. /* Write a single frame for this page to the log. */
  47659. rc = subjournalPageIfRequired(pPg);
  47660. if( rc==SQLITE_OK ){
  47661. rc = pagerWalFrames(pPager, pPg, 0, 0);
  47662. }
  47663. }else{
  47664. /* Sync the journal file if required. */
  47665. if( pPg->flags&PGHDR_NEED_SYNC
  47666. || pPager->eState==PAGER_WRITER_CACHEMOD
  47667. ){
  47668. rc = syncJournal(pPager, 1);
  47669. }
  47670. /* Write the contents of the page out to the database file. */
  47671. if( rc==SQLITE_OK ){
  47672. assert( (pPg->flags&PGHDR_NEED_SYNC)==0 );
  47673. rc = pager_write_pagelist(pPager, pPg);
  47674. }
  47675. }
  47676. /* Mark the page as clean. */
  47677. if( rc==SQLITE_OK ){
  47678. PAGERTRACE(("STRESS %d page %d\n", PAGERID(pPager), pPg->pgno));
  47679. sqlite3PcacheMakeClean(pPg);
  47680. }
  47681. return pager_error(pPager, rc);
  47682. }
  47683. /*
  47684. ** Flush all unreferenced dirty pages to disk.
  47685. */
  47686. SQLITE_PRIVATE int sqlite3PagerFlush(Pager *pPager){
  47687. int rc = pPager->errCode;
  47688. if( !MEMDB ){
  47689. PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
  47690. assert( assert_pager_state(pPager) );
  47691. while( rc==SQLITE_OK && pList ){
  47692. PgHdr *pNext = pList->pDirty;
  47693. if( pList->nRef==0 ){
  47694. rc = pagerStress((void*)pPager, pList);
  47695. }
  47696. pList = pNext;
  47697. }
  47698. }
  47699. return rc;
  47700. }
  47701. /*
  47702. ** Allocate and initialize a new Pager object and put a pointer to it
  47703. ** in *ppPager. The pager should eventually be freed by passing it
  47704. ** to sqlite3PagerClose().
  47705. **
  47706. ** The zFilename argument is the path to the database file to open.
  47707. ** If zFilename is NULL then a randomly-named temporary file is created
  47708. ** and used as the file to be cached. Temporary files are be deleted
  47709. ** automatically when they are closed. If zFilename is ":memory:" then
  47710. ** all information is held in cache. It is never written to disk.
  47711. ** This can be used to implement an in-memory database.
  47712. **
  47713. ** The nExtra parameter specifies the number of bytes of space allocated
  47714. ** along with each page reference. This space is available to the user
  47715. ** via the sqlite3PagerGetExtra() API.
  47716. **
  47717. ** The flags argument is used to specify properties that affect the
  47718. ** operation of the pager. It should be passed some bitwise combination
  47719. ** of the PAGER_* flags.
  47720. **
  47721. ** The vfsFlags parameter is a bitmask to pass to the flags parameter
  47722. ** of the xOpen() method of the supplied VFS when opening files.
  47723. **
  47724. ** If the pager object is allocated and the specified file opened
  47725. ** successfully, SQLITE_OK is returned and *ppPager set to point to
  47726. ** the new pager object. If an error occurs, *ppPager is set to NULL
  47727. ** and error code returned. This function may return SQLITE_NOMEM
  47728. ** (sqlite3Malloc() is used to allocate memory), SQLITE_CANTOPEN or
  47729. ** various SQLITE_IO_XXX errors.
  47730. */
  47731. SQLITE_PRIVATE int sqlite3PagerOpen(
  47732. sqlite3_vfs *pVfs, /* The virtual file system to use */
  47733. Pager **ppPager, /* OUT: Return the Pager structure here */
  47734. const char *zFilename, /* Name of the database file to open */
  47735. int nExtra, /* Extra bytes append to each in-memory page */
  47736. int flags, /* flags controlling this file */
  47737. int vfsFlags, /* flags passed through to sqlite3_vfs.xOpen() */
  47738. void (*xReinit)(DbPage*) /* Function to reinitialize pages */
  47739. ){
  47740. u8 *pPtr;
  47741. Pager *pPager = 0; /* Pager object to allocate and return */
  47742. int rc = SQLITE_OK; /* Return code */
  47743. int tempFile = 0; /* True for temp files (incl. in-memory files) */
  47744. int memDb = 0; /* True if this is an in-memory file */
  47745. int readOnly = 0; /* True if this is a read-only file */
  47746. int journalFileSize; /* Bytes to allocate for each journal fd */
  47747. char *zPathname = 0; /* Full path to database file */
  47748. int nPathname = 0; /* Number of bytes in zPathname */
  47749. int useJournal = (flags & PAGER_OMIT_JOURNAL)==0; /* False to omit journal */
  47750. int pcacheSize = sqlite3PcacheSize(); /* Bytes to allocate for PCache */
  47751. u32 szPageDflt = SQLITE_DEFAULT_PAGE_SIZE; /* Default page size */
  47752. const char *zUri = 0; /* URI args to copy */
  47753. int nUri = 0; /* Number of bytes of URI args at *zUri */
  47754. /* Figure out how much space is required for each journal file-handle
  47755. ** (there are two of them, the main journal and the sub-journal). */
  47756. journalFileSize = ROUND8(sqlite3JournalSize(pVfs));
  47757. /* Set the output variable to NULL in case an error occurs. */
  47758. *ppPager = 0;
  47759. #ifndef SQLITE_OMIT_MEMORYDB
  47760. if( flags & PAGER_MEMORY ){
  47761. memDb = 1;
  47762. if( zFilename && zFilename[0] ){
  47763. zPathname = sqlite3DbStrDup(0, zFilename);
  47764. if( zPathname==0 ) return SQLITE_NOMEM_BKPT;
  47765. nPathname = sqlite3Strlen30(zPathname);
  47766. zFilename = 0;
  47767. }
  47768. }
  47769. #endif
  47770. /* Compute and store the full pathname in an allocated buffer pointed
  47771. ** to by zPathname, length nPathname. Or, if this is a temporary file,
  47772. ** leave both nPathname and zPathname set to 0.
  47773. */
  47774. if( zFilename && zFilename[0] ){
  47775. const char *z;
  47776. nPathname = pVfs->mxPathname+1;
  47777. zPathname = sqlite3DbMallocRaw(0, nPathname*2);
  47778. if( zPathname==0 ){
  47779. return SQLITE_NOMEM_BKPT;
  47780. }
  47781. zPathname[0] = 0; /* Make sure initialized even if FullPathname() fails */
  47782. rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
  47783. nPathname = sqlite3Strlen30(zPathname);
  47784. z = zUri = &zFilename[sqlite3Strlen30(zFilename)+1];
  47785. while( *z ){
  47786. z += sqlite3Strlen30(z)+1;
  47787. z += sqlite3Strlen30(z)+1;
  47788. }
  47789. nUri = (int)(&z[1] - zUri);
  47790. assert( nUri>=0 );
  47791. if( rc==SQLITE_OK && nPathname+8>pVfs->mxPathname ){
  47792. /* This branch is taken when the journal path required by
  47793. ** the database being opened will be more than pVfs->mxPathname
  47794. ** bytes in length. This means the database cannot be opened,
  47795. ** as it will not be possible to open the journal file or even
  47796. ** check for a hot-journal before reading.
  47797. */
  47798. rc = SQLITE_CANTOPEN_BKPT;
  47799. }
  47800. if( rc!=SQLITE_OK ){
  47801. sqlite3DbFree(0, zPathname);
  47802. return rc;
  47803. }
  47804. }
  47805. /* Allocate memory for the Pager structure, PCache object, the
  47806. ** three file descriptors, the database file name and the journal
  47807. ** file name. The layout in memory is as follows:
  47808. **
  47809. ** Pager object (sizeof(Pager) bytes)
  47810. ** PCache object (sqlite3PcacheSize() bytes)
  47811. ** Database file handle (pVfs->szOsFile bytes)
  47812. ** Sub-journal file handle (journalFileSize bytes)
  47813. ** Main journal file handle (journalFileSize bytes)
  47814. ** Database file name (nPathname+1 bytes)
  47815. ** Journal file name (nPathname+8+1 bytes)
  47816. */
  47817. pPtr = (u8 *)sqlite3MallocZero(
  47818. ROUND8(sizeof(*pPager)) + /* Pager structure */
  47819. ROUND8(pcacheSize) + /* PCache object */
  47820. ROUND8(pVfs->szOsFile) + /* The main db file */
  47821. journalFileSize * 2 + /* The two journal files */
  47822. nPathname + 1 + nUri + /* zFilename */
  47823. nPathname + 8 + 2 /* zJournal */
  47824. #ifndef SQLITE_OMIT_WAL
  47825. + nPathname + 4 + 2 /* zWal */
  47826. #endif
  47827. );
  47828. assert( EIGHT_BYTE_ALIGNMENT(SQLITE_INT_TO_PTR(journalFileSize)) );
  47829. if( !pPtr ){
  47830. sqlite3DbFree(0, zPathname);
  47831. return SQLITE_NOMEM_BKPT;
  47832. }
  47833. pPager = (Pager*)(pPtr);
  47834. pPager->pPCache = (PCache*)(pPtr += ROUND8(sizeof(*pPager)));
  47835. pPager->fd = (sqlite3_file*)(pPtr += ROUND8(pcacheSize));
  47836. pPager->sjfd = (sqlite3_file*)(pPtr += ROUND8(pVfs->szOsFile));
  47837. pPager->jfd = (sqlite3_file*)(pPtr += journalFileSize);
  47838. pPager->zFilename = (char*)(pPtr += journalFileSize);
  47839. assert( EIGHT_BYTE_ALIGNMENT(pPager->jfd) );
  47840. /* Fill in the Pager.zFilename and Pager.zJournal buffers, if required. */
  47841. if( zPathname ){
  47842. assert( nPathname>0 );
  47843. pPager->zJournal = (char*)(pPtr += nPathname + 1 + nUri);
  47844. memcpy(pPager->zFilename, zPathname, nPathname);
  47845. if( nUri ) memcpy(&pPager->zFilename[nPathname+1], zUri, nUri);
  47846. memcpy(pPager->zJournal, zPathname, nPathname);
  47847. memcpy(&pPager->zJournal[nPathname], "-journal\000", 8+2);
  47848. sqlite3FileSuffix3(pPager->zFilename, pPager->zJournal);
  47849. #ifndef SQLITE_OMIT_WAL
  47850. pPager->zWal = &pPager->zJournal[nPathname+8+1];
  47851. memcpy(pPager->zWal, zPathname, nPathname);
  47852. memcpy(&pPager->zWal[nPathname], "-wal\000", 4+1);
  47853. sqlite3FileSuffix3(pPager->zFilename, pPager->zWal);
  47854. #endif
  47855. sqlite3DbFree(0, zPathname);
  47856. }
  47857. pPager->pVfs = pVfs;
  47858. pPager->vfsFlags = vfsFlags;
  47859. /* Open the pager file.
  47860. */
  47861. if( zFilename && zFilename[0] ){
  47862. int fout = 0; /* VFS flags returned by xOpen() */
  47863. rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, vfsFlags, &fout);
  47864. assert( !memDb );
  47865. readOnly = (fout&SQLITE_OPEN_READONLY);
  47866. /* If the file was successfully opened for read/write access,
  47867. ** choose a default page size in case we have to create the
  47868. ** database file. The default page size is the maximum of:
  47869. **
  47870. ** + SQLITE_DEFAULT_PAGE_SIZE,
  47871. ** + The value returned by sqlite3OsSectorSize()
  47872. ** + The largest page size that can be written atomically.
  47873. */
  47874. if( rc==SQLITE_OK ){
  47875. int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
  47876. if( !readOnly ){
  47877. setSectorSize(pPager);
  47878. assert(SQLITE_DEFAULT_PAGE_SIZE<=SQLITE_MAX_DEFAULT_PAGE_SIZE);
  47879. if( szPageDflt<pPager->sectorSize ){
  47880. if( pPager->sectorSize>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
  47881. szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
  47882. }else{
  47883. szPageDflt = (u32)pPager->sectorSize;
  47884. }
  47885. }
  47886. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  47887. {
  47888. int ii;
  47889. assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
  47890. assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
  47891. assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
  47892. for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
  47893. if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ){
  47894. szPageDflt = ii;
  47895. }
  47896. }
  47897. }
  47898. #endif
  47899. }
  47900. pPager->noLock = sqlite3_uri_boolean(zFilename, "nolock", 0);
  47901. if( (iDc & SQLITE_IOCAP_IMMUTABLE)!=0
  47902. || sqlite3_uri_boolean(zFilename, "immutable", 0) ){
  47903. vfsFlags |= SQLITE_OPEN_READONLY;
  47904. goto act_like_temp_file;
  47905. }
  47906. }
  47907. }else{
  47908. /* If a temporary file is requested, it is not opened immediately.
  47909. ** In this case we accept the default page size and delay actually
  47910. ** opening the file until the first call to OsWrite().
  47911. **
  47912. ** This branch is also run for an in-memory database. An in-memory
  47913. ** database is the same as a temp-file that is never written out to
  47914. ** disk and uses an in-memory rollback journal.
  47915. **
  47916. ** This branch also runs for files marked as immutable.
  47917. */
  47918. act_like_temp_file:
  47919. tempFile = 1;
  47920. pPager->eState = PAGER_READER; /* Pretend we already have a lock */
  47921. pPager->eLock = EXCLUSIVE_LOCK; /* Pretend we are in EXCLUSIVE mode */
  47922. pPager->noLock = 1; /* Do no locking */
  47923. readOnly = (vfsFlags&SQLITE_OPEN_READONLY);
  47924. }
  47925. /* The following call to PagerSetPagesize() serves to set the value of
  47926. ** Pager.pageSize and to allocate the Pager.pTmpSpace buffer.
  47927. */
  47928. if( rc==SQLITE_OK ){
  47929. assert( pPager->memDb==0 );
  47930. rc = sqlite3PagerSetPagesize(pPager, &szPageDflt, -1);
  47931. testcase( rc!=SQLITE_OK );
  47932. }
  47933. /* Initialize the PCache object. */
  47934. if( rc==SQLITE_OK ){
  47935. assert( nExtra<1000 );
  47936. nExtra = ROUND8(nExtra);
  47937. rc = sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
  47938. !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
  47939. }
  47940. /* If an error occurred above, free the Pager structure and close the file.
  47941. */
  47942. if( rc!=SQLITE_OK ){
  47943. sqlite3OsClose(pPager->fd);
  47944. sqlite3PageFree(pPager->pTmpSpace);
  47945. sqlite3_free(pPager);
  47946. return rc;
  47947. }
  47948. PAGERTRACE(("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename));
  47949. IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
  47950. pPager->useJournal = (u8)useJournal;
  47951. /* pPager->stmtOpen = 0; */
  47952. /* pPager->stmtInUse = 0; */
  47953. /* pPager->nRef = 0; */
  47954. /* pPager->stmtSize = 0; */
  47955. /* pPager->stmtJSize = 0; */
  47956. /* pPager->nPage = 0; */
  47957. pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
  47958. /* pPager->state = PAGER_UNLOCK; */
  47959. /* pPager->errMask = 0; */
  47960. pPager->tempFile = (u8)tempFile;
  47961. assert( tempFile==PAGER_LOCKINGMODE_NORMAL
  47962. || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
  47963. assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
  47964. pPager->exclusiveMode = (u8)tempFile;
  47965. pPager->changeCountDone = pPager->tempFile;
  47966. pPager->memDb = (u8)memDb;
  47967. pPager->readOnly = (u8)readOnly;
  47968. assert( useJournal || pPager->tempFile );
  47969. pPager->noSync = pPager->tempFile;
  47970. if( pPager->noSync ){
  47971. assert( pPager->fullSync==0 );
  47972. assert( pPager->extraSync==0 );
  47973. assert( pPager->syncFlags==0 );
  47974. assert( pPager->walSyncFlags==0 );
  47975. assert( pPager->ckptSyncFlags==0 );
  47976. }else{
  47977. pPager->fullSync = 1;
  47978. pPager->extraSync = 0;
  47979. pPager->syncFlags = SQLITE_SYNC_NORMAL;
  47980. pPager->walSyncFlags = SQLITE_SYNC_NORMAL | WAL_SYNC_TRANSACTIONS;
  47981. pPager->ckptSyncFlags = SQLITE_SYNC_NORMAL;
  47982. }
  47983. /* pPager->pFirst = 0; */
  47984. /* pPager->pFirstSynced = 0; */
  47985. /* pPager->pLast = 0; */
  47986. pPager->nExtra = (u16)nExtra;
  47987. pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
  47988. assert( isOpen(pPager->fd) || tempFile );
  47989. setSectorSize(pPager);
  47990. if( !useJournal ){
  47991. pPager->journalMode = PAGER_JOURNALMODE_OFF;
  47992. }else if( memDb ){
  47993. pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
  47994. }
  47995. /* pPager->xBusyHandler = 0; */
  47996. /* pPager->pBusyHandlerArg = 0; */
  47997. pPager->xReiniter = xReinit;
  47998. /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
  47999. /* pPager->szMmap = SQLITE_DEFAULT_MMAP_SIZE // will be set by btree.c */
  48000. *ppPager = pPager;
  48001. return SQLITE_OK;
  48002. }
  48003. /* Verify that the database file has not be deleted or renamed out from
  48004. ** under the pager. Return SQLITE_OK if the database is still were it ought
  48005. ** to be on disk. Return non-zero (SQLITE_READONLY_DBMOVED or some other error
  48006. ** code from sqlite3OsAccess()) if the database has gone missing.
  48007. */
  48008. static int databaseIsUnmoved(Pager *pPager){
  48009. int bHasMoved = 0;
  48010. int rc;
  48011. if( pPager->tempFile ) return SQLITE_OK;
  48012. if( pPager->dbSize==0 ) return SQLITE_OK;
  48013. assert( pPager->zFilename && pPager->zFilename[0] );
  48014. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_HAS_MOVED, &bHasMoved);
  48015. if( rc==SQLITE_NOTFOUND ){
  48016. /* If the HAS_MOVED file-control is unimplemented, assume that the file
  48017. ** has not been moved. That is the historical behavior of SQLite: prior to
  48018. ** version 3.8.3, it never checked */
  48019. rc = SQLITE_OK;
  48020. }else if( rc==SQLITE_OK && bHasMoved ){
  48021. rc = SQLITE_READONLY_DBMOVED;
  48022. }
  48023. return rc;
  48024. }
  48025. /*
  48026. ** This function is called after transitioning from PAGER_UNLOCK to
  48027. ** PAGER_SHARED state. It tests if there is a hot journal present in
  48028. ** the file-system for the given pager. A hot journal is one that
  48029. ** needs to be played back. According to this function, a hot-journal
  48030. ** file exists if the following criteria are met:
  48031. **
  48032. ** * The journal file exists in the file system, and
  48033. ** * No process holds a RESERVED or greater lock on the database file, and
  48034. ** * The database file itself is greater than 0 bytes in size, and
  48035. ** * The first byte of the journal file exists and is not 0x00.
  48036. **
  48037. ** If the current size of the database file is 0 but a journal file
  48038. ** exists, that is probably an old journal left over from a prior
  48039. ** database with the same name. In this case the journal file is
  48040. ** just deleted using OsDelete, *pExists is set to 0 and SQLITE_OK
  48041. ** is returned.
  48042. **
  48043. ** This routine does not check if there is a master journal filename
  48044. ** at the end of the file. If there is, and that master journal file
  48045. ** does not exist, then the journal file is not really hot. In this
  48046. ** case this routine will return a false-positive. The pager_playback()
  48047. ** routine will discover that the journal file is not really hot and
  48048. ** will not roll it back.
  48049. **
  48050. ** If a hot-journal file is found to exist, *pExists is set to 1 and
  48051. ** SQLITE_OK returned. If no hot-journal file is present, *pExists is
  48052. ** set to 0 and SQLITE_OK returned. If an IO error occurs while trying
  48053. ** to determine whether or not a hot-journal file exists, the IO error
  48054. ** code is returned and the value of *pExists is undefined.
  48055. */
  48056. static int hasHotJournal(Pager *pPager, int *pExists){
  48057. sqlite3_vfs * const pVfs = pPager->pVfs;
  48058. int rc = SQLITE_OK; /* Return code */
  48059. int exists = 1; /* True if a journal file is present */
  48060. int jrnlOpen = !!isOpen(pPager->jfd);
  48061. assert( pPager->useJournal );
  48062. assert( isOpen(pPager->fd) );
  48063. assert( pPager->eState==PAGER_OPEN );
  48064. assert( jrnlOpen==0 || ( sqlite3OsDeviceCharacteristics(pPager->jfd) &
  48065. SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
  48066. ));
  48067. *pExists = 0;
  48068. if( !jrnlOpen ){
  48069. rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
  48070. }
  48071. if( rc==SQLITE_OK && exists ){
  48072. int locked = 0; /* True if some process holds a RESERVED lock */
  48073. /* Race condition here: Another process might have been holding the
  48074. ** the RESERVED lock and have a journal open at the sqlite3OsAccess()
  48075. ** call above, but then delete the journal and drop the lock before
  48076. ** we get to the following sqlite3OsCheckReservedLock() call. If that
  48077. ** is the case, this routine might think there is a hot journal when
  48078. ** in fact there is none. This results in a false-positive which will
  48079. ** be dealt with by the playback routine. Ticket #3883.
  48080. */
  48081. rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
  48082. if( rc==SQLITE_OK && !locked ){
  48083. Pgno nPage; /* Number of pages in database file */
  48084. assert( pPager->tempFile==0 );
  48085. rc = pagerPagecount(pPager, &nPage);
  48086. if( rc==SQLITE_OK ){
  48087. /* If the database is zero pages in size, that means that either (1) the
  48088. ** journal is a remnant from a prior database with the same name where
  48089. ** the database file but not the journal was deleted, or (2) the initial
  48090. ** transaction that populates a new database is being rolled back.
  48091. ** In either case, the journal file can be deleted. However, take care
  48092. ** not to delete the journal file if it is already open due to
  48093. ** journal_mode=PERSIST.
  48094. */
  48095. if( nPage==0 && !jrnlOpen ){
  48096. sqlite3BeginBenignMalloc();
  48097. if( pagerLockDb(pPager, RESERVED_LOCK)==SQLITE_OK ){
  48098. sqlite3OsDelete(pVfs, pPager->zJournal, 0);
  48099. if( !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
  48100. }
  48101. sqlite3EndBenignMalloc();
  48102. }else{
  48103. /* The journal file exists and no other connection has a reserved
  48104. ** or greater lock on the database file. Now check that there is
  48105. ** at least one non-zero bytes at the start of the journal file.
  48106. ** If there is, then we consider this journal to be hot. If not,
  48107. ** it can be ignored.
  48108. */
  48109. if( !jrnlOpen ){
  48110. int f = SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL;
  48111. rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &f);
  48112. }
  48113. if( rc==SQLITE_OK ){
  48114. u8 first = 0;
  48115. rc = sqlite3OsRead(pPager->jfd, (void *)&first, 1, 0);
  48116. if( rc==SQLITE_IOERR_SHORT_READ ){
  48117. rc = SQLITE_OK;
  48118. }
  48119. if( !jrnlOpen ){
  48120. sqlite3OsClose(pPager->jfd);
  48121. }
  48122. *pExists = (first!=0);
  48123. }else if( rc==SQLITE_CANTOPEN ){
  48124. /* If we cannot open the rollback journal file in order to see if
  48125. ** it has a zero header, that might be due to an I/O error, or
  48126. ** it might be due to the race condition described above and in
  48127. ** ticket #3883. Either way, assume that the journal is hot.
  48128. ** This might be a false positive. But if it is, then the
  48129. ** automatic journal playback and recovery mechanism will deal
  48130. ** with it under an EXCLUSIVE lock where we do not need to
  48131. ** worry so much with race conditions.
  48132. */
  48133. *pExists = 1;
  48134. rc = SQLITE_OK;
  48135. }
  48136. }
  48137. }
  48138. }
  48139. }
  48140. return rc;
  48141. }
  48142. /*
  48143. ** This function is called to obtain a shared lock on the database file.
  48144. ** It is illegal to call sqlite3PagerGet() until after this function
  48145. ** has been successfully called. If a shared-lock is already held when
  48146. ** this function is called, it is a no-op.
  48147. **
  48148. ** The following operations are also performed by this function.
  48149. **
  48150. ** 1) If the pager is currently in PAGER_OPEN state (no lock held
  48151. ** on the database file), then an attempt is made to obtain a
  48152. ** SHARED lock on the database file. Immediately after obtaining
  48153. ** the SHARED lock, the file-system is checked for a hot-journal,
  48154. ** which is played back if present. Following any hot-journal
  48155. ** rollback, the contents of the cache are validated by checking
  48156. ** the 'change-counter' field of the database file header and
  48157. ** discarded if they are found to be invalid.
  48158. **
  48159. ** 2) If the pager is running in exclusive-mode, and there are currently
  48160. ** no outstanding references to any pages, and is in the error state,
  48161. ** then an attempt is made to clear the error state by discarding
  48162. ** the contents of the page cache and rolling back any open journal
  48163. ** file.
  48164. **
  48165. ** If everything is successful, SQLITE_OK is returned. If an IO error
  48166. ** occurs while locking the database, checking for a hot-journal file or
  48167. ** rolling back a journal file, the IO error code is returned.
  48168. */
  48169. SQLITE_PRIVATE int sqlite3PagerSharedLock(Pager *pPager){
  48170. int rc = SQLITE_OK; /* Return code */
  48171. /* This routine is only called from b-tree and only when there are no
  48172. ** outstanding pages. This implies that the pager state should either
  48173. ** be OPEN or READER. READER is only possible if the pager is or was in
  48174. ** exclusive access mode. */
  48175. assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
  48176. assert( assert_pager_state(pPager) );
  48177. assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
  48178. assert( pPager->errCode==SQLITE_OK );
  48179. if( !pagerUseWal(pPager) && pPager->eState==PAGER_OPEN ){
  48180. int bHotJournal = 1; /* True if there exists a hot journal-file */
  48181. assert( !MEMDB );
  48182. assert( pPager->tempFile==0 || pPager->eLock==EXCLUSIVE_LOCK );
  48183. rc = pager_wait_on_lock(pPager, SHARED_LOCK);
  48184. if( rc!=SQLITE_OK ){
  48185. assert( pPager->eLock==NO_LOCK || pPager->eLock==UNKNOWN_LOCK );
  48186. goto failed;
  48187. }
  48188. /* If a journal file exists, and there is no RESERVED lock on the
  48189. ** database file, then it either needs to be played back or deleted.
  48190. */
  48191. if( pPager->eLock<=SHARED_LOCK ){
  48192. rc = hasHotJournal(pPager, &bHotJournal);
  48193. }
  48194. if( rc!=SQLITE_OK ){
  48195. goto failed;
  48196. }
  48197. if( bHotJournal ){
  48198. if( pPager->readOnly ){
  48199. rc = SQLITE_READONLY_ROLLBACK;
  48200. goto failed;
  48201. }
  48202. /* Get an EXCLUSIVE lock on the database file. At this point it is
  48203. ** important that a RESERVED lock is not obtained on the way to the
  48204. ** EXCLUSIVE lock. If it were, another process might open the
  48205. ** database file, detect the RESERVED lock, and conclude that the
  48206. ** database is safe to read while this process is still rolling the
  48207. ** hot-journal back.
  48208. **
  48209. ** Because the intermediate RESERVED lock is not requested, any
  48210. ** other process attempting to access the database file will get to
  48211. ** this point in the code and fail to obtain its own EXCLUSIVE lock
  48212. ** on the database file.
  48213. **
  48214. ** Unless the pager is in locking_mode=exclusive mode, the lock is
  48215. ** downgraded to SHARED_LOCK before this function returns.
  48216. */
  48217. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  48218. if( rc!=SQLITE_OK ){
  48219. goto failed;
  48220. }
  48221. /* If it is not already open and the file exists on disk, open the
  48222. ** journal for read/write access. Write access is required because
  48223. ** in exclusive-access mode the file descriptor will be kept open
  48224. ** and possibly used for a transaction later on. Also, write-access
  48225. ** is usually required to finalize the journal in journal_mode=persist
  48226. ** mode (and also for journal_mode=truncate on some systems).
  48227. **
  48228. ** If the journal does not exist, it usually means that some
  48229. ** other connection managed to get in and roll it back before
  48230. ** this connection obtained the exclusive lock above. Or, it
  48231. ** may mean that the pager was in the error-state when this
  48232. ** function was called and the journal file does not exist.
  48233. */
  48234. if( !isOpen(pPager->jfd) ){
  48235. sqlite3_vfs * const pVfs = pPager->pVfs;
  48236. int bExists; /* True if journal file exists */
  48237. rc = sqlite3OsAccess(
  48238. pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &bExists);
  48239. if( rc==SQLITE_OK && bExists ){
  48240. int fout = 0;
  48241. int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
  48242. assert( !pPager->tempFile );
  48243. rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
  48244. assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
  48245. if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
  48246. rc = SQLITE_CANTOPEN_BKPT;
  48247. sqlite3OsClose(pPager->jfd);
  48248. }
  48249. }
  48250. }
  48251. /* Playback and delete the journal. Drop the database write
  48252. ** lock and reacquire the read lock. Purge the cache before
  48253. ** playing back the hot-journal so that we don't end up with
  48254. ** an inconsistent cache. Sync the hot journal before playing
  48255. ** it back since the process that crashed and left the hot journal
  48256. ** probably did not sync it and we are required to always sync
  48257. ** the journal before playing it back.
  48258. */
  48259. if( isOpen(pPager->jfd) ){
  48260. assert( rc==SQLITE_OK );
  48261. rc = pagerSyncHotJournal(pPager);
  48262. if( rc==SQLITE_OK ){
  48263. rc = pager_playback(pPager, !pPager->tempFile);
  48264. pPager->eState = PAGER_OPEN;
  48265. }
  48266. }else if( !pPager->exclusiveMode ){
  48267. pagerUnlockDb(pPager, SHARED_LOCK);
  48268. }
  48269. if( rc!=SQLITE_OK ){
  48270. /* This branch is taken if an error occurs while trying to open
  48271. ** or roll back a hot-journal while holding an EXCLUSIVE lock. The
  48272. ** pager_unlock() routine will be called before returning to unlock
  48273. ** the file. If the unlock attempt fails, then Pager.eLock must be
  48274. ** set to UNKNOWN_LOCK (see the comment above the #define for
  48275. ** UNKNOWN_LOCK above for an explanation).
  48276. **
  48277. ** In order to get pager_unlock() to do this, set Pager.eState to
  48278. ** PAGER_ERROR now. This is not actually counted as a transition
  48279. ** to ERROR state in the state diagram at the top of this file,
  48280. ** since we know that the same call to pager_unlock() will very
  48281. ** shortly transition the pager object to the OPEN state. Calling
  48282. ** assert_pager_state() would fail now, as it should not be possible
  48283. ** to be in ERROR state when there are zero outstanding page
  48284. ** references.
  48285. */
  48286. pager_error(pPager, rc);
  48287. goto failed;
  48288. }
  48289. assert( pPager->eState==PAGER_OPEN );
  48290. assert( (pPager->eLock==SHARED_LOCK)
  48291. || (pPager->exclusiveMode && pPager->eLock>SHARED_LOCK)
  48292. );
  48293. }
  48294. if( !pPager->tempFile && pPager->hasHeldSharedLock ){
  48295. /* The shared-lock has just been acquired then check to
  48296. ** see if the database has been modified. If the database has changed,
  48297. ** flush the cache. The hasHeldSharedLock flag prevents this from
  48298. ** occurring on the very first access to a file, in order to save a
  48299. ** single unnecessary sqlite3OsRead() call at the start-up.
  48300. **
  48301. ** Database changes are detected by looking at 15 bytes beginning
  48302. ** at offset 24 into the file. The first 4 of these 16 bytes are
  48303. ** a 32-bit counter that is incremented with each change. The
  48304. ** other bytes change randomly with each file change when
  48305. ** a codec is in use.
  48306. **
  48307. ** There is a vanishingly small chance that a change will not be
  48308. ** detected. The chance of an undetected change is so small that
  48309. ** it can be neglected.
  48310. */
  48311. Pgno nPage = 0;
  48312. char dbFileVers[sizeof(pPager->dbFileVers)];
  48313. rc = pagerPagecount(pPager, &nPage);
  48314. if( rc ) goto failed;
  48315. if( nPage>0 ){
  48316. IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
  48317. rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
  48318. if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
  48319. goto failed;
  48320. }
  48321. }else{
  48322. memset(dbFileVers, 0, sizeof(dbFileVers));
  48323. }
  48324. if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
  48325. pager_reset(pPager);
  48326. /* Unmap the database file. It is possible that external processes
  48327. ** may have truncated the database file and then extended it back
  48328. ** to its original size while this process was not holding a lock.
  48329. ** In this case there may exist a Pager.pMap mapping that appears
  48330. ** to be the right size but is not actually valid. Avoid this
  48331. ** possibility by unmapping the db here. */
  48332. if( USEFETCH(pPager) ){
  48333. sqlite3OsUnfetch(pPager->fd, 0, 0);
  48334. }
  48335. }
  48336. }
  48337. /* If there is a WAL file in the file-system, open this database in WAL
  48338. ** mode. Otherwise, the following function call is a no-op.
  48339. */
  48340. rc = pagerOpenWalIfPresent(pPager);
  48341. #ifndef SQLITE_OMIT_WAL
  48342. assert( pPager->pWal==0 || rc==SQLITE_OK );
  48343. #endif
  48344. }
  48345. if( pagerUseWal(pPager) ){
  48346. assert( rc==SQLITE_OK );
  48347. rc = pagerBeginReadTransaction(pPager);
  48348. }
  48349. if( pPager->tempFile==0 && pPager->eState==PAGER_OPEN && rc==SQLITE_OK ){
  48350. rc = pagerPagecount(pPager, &pPager->dbSize);
  48351. }
  48352. failed:
  48353. if( rc!=SQLITE_OK ){
  48354. assert( !MEMDB );
  48355. pager_unlock(pPager);
  48356. assert( pPager->eState==PAGER_OPEN );
  48357. }else{
  48358. pPager->eState = PAGER_READER;
  48359. pPager->hasHeldSharedLock = 1;
  48360. }
  48361. return rc;
  48362. }
  48363. /*
  48364. ** If the reference count has reached zero, rollback any active
  48365. ** transaction and unlock the pager.
  48366. **
  48367. ** Except, in locking_mode=EXCLUSIVE when there is nothing to in
  48368. ** the rollback journal, the unlock is not performed and there is
  48369. ** nothing to rollback, so this routine is a no-op.
  48370. */
  48371. static void pagerUnlockIfUnused(Pager *pPager){
  48372. if( pPager->nMmapOut==0 && (sqlite3PcacheRefCount(pPager->pPCache)==0) ){
  48373. pagerUnlockAndRollback(pPager);
  48374. }
  48375. }
  48376. /*
  48377. ** Acquire a reference to page number pgno in pager pPager (a page
  48378. ** reference has type DbPage*). If the requested reference is
  48379. ** successfully obtained, it is copied to *ppPage and SQLITE_OK returned.
  48380. **
  48381. ** If the requested page is already in the cache, it is returned.
  48382. ** Otherwise, a new page object is allocated and populated with data
  48383. ** read from the database file. In some cases, the pcache module may
  48384. ** choose not to allocate a new page object and may reuse an existing
  48385. ** object with no outstanding references.
  48386. **
  48387. ** The extra data appended to a page is always initialized to zeros the
  48388. ** first time a page is loaded into memory. If the page requested is
  48389. ** already in the cache when this function is called, then the extra
  48390. ** data is left as it was when the page object was last used.
  48391. **
  48392. ** If the database image is smaller than the requested page or if a
  48393. ** non-zero value is passed as the noContent parameter and the
  48394. ** requested page is not already stored in the cache, then no
  48395. ** actual disk read occurs. In this case the memory image of the
  48396. ** page is initialized to all zeros.
  48397. **
  48398. ** If noContent is true, it means that we do not care about the contents
  48399. ** of the page. This occurs in two scenarios:
  48400. **
  48401. ** a) When reading a free-list leaf page from the database, and
  48402. **
  48403. ** b) When a savepoint is being rolled back and we need to load
  48404. ** a new page into the cache to be filled with the data read
  48405. ** from the savepoint journal.
  48406. **
  48407. ** If noContent is true, then the data returned is zeroed instead of
  48408. ** being read from the database. Additionally, the bits corresponding
  48409. ** to pgno in Pager.pInJournal (bitvec of pages already written to the
  48410. ** journal file) and the PagerSavepoint.pInSavepoint bitvecs of any open
  48411. ** savepoints are set. This means if the page is made writable at any
  48412. ** point in the future, using a call to sqlite3PagerWrite(), its contents
  48413. ** will not be journaled. This saves IO.
  48414. **
  48415. ** The acquisition might fail for several reasons. In all cases,
  48416. ** an appropriate error code is returned and *ppPage is set to NULL.
  48417. **
  48418. ** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
  48419. ** to find a page in the in-memory cache first. If the page is not already
  48420. ** in memory, this routine goes to disk to read it in whereas Lookup()
  48421. ** just returns 0. This routine acquires a read-lock the first time it
  48422. ** has to go to disk, and could also playback an old journal if necessary.
  48423. ** Since Lookup() never goes to disk, it never has to deal with locks
  48424. ** or journal files.
  48425. */
  48426. SQLITE_PRIVATE int sqlite3PagerGet(
  48427. Pager *pPager, /* The pager open on the database file */
  48428. Pgno pgno, /* Page number to fetch */
  48429. DbPage **ppPage, /* Write a pointer to the page here */
  48430. int flags /* PAGER_GET_XXX flags */
  48431. ){
  48432. int rc = SQLITE_OK;
  48433. PgHdr *pPg = 0;
  48434. u32 iFrame = 0; /* Frame to read from WAL file */
  48435. const int noContent = (flags & PAGER_GET_NOCONTENT);
  48436. /* It is acceptable to use a read-only (mmap) page for any page except
  48437. ** page 1 if there is no write-transaction open or the ACQUIRE_READONLY
  48438. ** flag was specified by the caller. And so long as the db is not a
  48439. ** temporary or in-memory database. */
  48440. const int bMmapOk = (pgno>1 && USEFETCH(pPager)
  48441. && (pPager->eState==PAGER_READER || (flags & PAGER_GET_READONLY))
  48442. #ifdef SQLITE_HAS_CODEC
  48443. && pPager->xCodec==0
  48444. #endif
  48445. );
  48446. /* Optimization note: Adding the "pgno<=1" term before "pgno==0" here
  48447. ** allows the compiler optimizer to reuse the results of the "pgno>1"
  48448. ** test in the previous statement, and avoid testing pgno==0 in the
  48449. ** common case where pgno is large. */
  48450. if( pgno<=1 && pgno==0 ){
  48451. return SQLITE_CORRUPT_BKPT;
  48452. }
  48453. assert( pPager->eState>=PAGER_READER );
  48454. assert( assert_pager_state(pPager) );
  48455. assert( noContent==0 || bMmapOk==0 );
  48456. assert( pPager->hasHeldSharedLock==1 );
  48457. /* If the pager is in the error state, return an error immediately.
  48458. ** Otherwise, request the page from the PCache layer. */
  48459. if( pPager->errCode!=SQLITE_OK ){
  48460. rc = pPager->errCode;
  48461. }else{
  48462. if( bMmapOk && pagerUseWal(pPager) ){
  48463. rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iFrame);
  48464. if( rc!=SQLITE_OK ) goto pager_acquire_err;
  48465. }
  48466. if( bMmapOk && iFrame==0 ){
  48467. void *pData = 0;
  48468. rc = sqlite3OsFetch(pPager->fd,
  48469. (i64)(pgno-1) * pPager->pageSize, pPager->pageSize, &pData
  48470. );
  48471. if( rc==SQLITE_OK && pData ){
  48472. if( pPager->eState>PAGER_READER || pPager->tempFile ){
  48473. pPg = sqlite3PagerLookup(pPager, pgno);
  48474. }
  48475. if( pPg==0 ){
  48476. rc = pagerAcquireMapPage(pPager, pgno, pData, &pPg);
  48477. }else{
  48478. sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1)*pPager->pageSize, pData);
  48479. }
  48480. if( pPg ){
  48481. assert( rc==SQLITE_OK );
  48482. *ppPage = pPg;
  48483. return SQLITE_OK;
  48484. }
  48485. }
  48486. if( rc!=SQLITE_OK ){
  48487. goto pager_acquire_err;
  48488. }
  48489. }
  48490. {
  48491. sqlite3_pcache_page *pBase;
  48492. pBase = sqlite3PcacheFetch(pPager->pPCache, pgno, 3);
  48493. if( pBase==0 ){
  48494. rc = sqlite3PcacheFetchStress(pPager->pPCache, pgno, &pBase);
  48495. if( rc!=SQLITE_OK ) goto pager_acquire_err;
  48496. if( pBase==0 ){
  48497. pPg = *ppPage = 0;
  48498. rc = SQLITE_NOMEM_BKPT;
  48499. goto pager_acquire_err;
  48500. }
  48501. }
  48502. pPg = *ppPage = sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pBase);
  48503. assert( pPg!=0 );
  48504. }
  48505. }
  48506. if( rc!=SQLITE_OK ){
  48507. /* Either the call to sqlite3PcacheFetch() returned an error or the
  48508. ** pager was already in the error-state when this function was called.
  48509. ** Set pPg to 0 and jump to the exception handler. */
  48510. pPg = 0;
  48511. goto pager_acquire_err;
  48512. }
  48513. assert( pPg==(*ppPage) );
  48514. assert( pPg->pgno==pgno );
  48515. assert( pPg->pPager==pPager || pPg->pPager==0 );
  48516. if( pPg->pPager && !noContent ){
  48517. /* In this case the pcache already contains an initialized copy of
  48518. ** the page. Return without further ado. */
  48519. assert( pgno<=PAGER_MAX_PGNO && pgno!=PAGER_MJ_PGNO(pPager) );
  48520. pPager->aStat[PAGER_STAT_HIT]++;
  48521. return SQLITE_OK;
  48522. }else{
  48523. /* The pager cache has created a new page. Its content needs to
  48524. ** be initialized. */
  48525. pPg->pPager = pPager;
  48526. /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
  48527. ** number greater than this, or the unused locking-page, is requested. */
  48528. if( pgno>PAGER_MAX_PGNO || pgno==PAGER_MJ_PGNO(pPager) ){
  48529. rc = SQLITE_CORRUPT_BKPT;
  48530. goto pager_acquire_err;
  48531. }
  48532. assert( !isOpen(pPager->fd) || !MEMDB );
  48533. if( !isOpen(pPager->fd) || pPager->dbSize<pgno || noContent ){
  48534. if( pgno>pPager->mxPgno ){
  48535. rc = SQLITE_FULL;
  48536. goto pager_acquire_err;
  48537. }
  48538. if( noContent ){
  48539. /* Failure to set the bits in the InJournal bit-vectors is benign.
  48540. ** It merely means that we might do some extra work to journal a
  48541. ** page that does not need to be journaled. Nevertheless, be sure
  48542. ** to test the case where a malloc error occurs while trying to set
  48543. ** a bit in a bit vector.
  48544. */
  48545. sqlite3BeginBenignMalloc();
  48546. if( pgno<=pPager->dbOrigSize ){
  48547. TESTONLY( rc = ) sqlite3BitvecSet(pPager->pInJournal, pgno);
  48548. testcase( rc==SQLITE_NOMEM );
  48549. }
  48550. TESTONLY( rc = ) addToSavepointBitvecs(pPager, pgno);
  48551. testcase( rc==SQLITE_NOMEM );
  48552. sqlite3EndBenignMalloc();
  48553. }
  48554. memset(pPg->pData, 0, pPager->pageSize);
  48555. IOTRACE(("ZERO %p %d\n", pPager, pgno));
  48556. }else{
  48557. if( pagerUseWal(pPager) && bMmapOk==0 ){
  48558. rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iFrame);
  48559. if( rc!=SQLITE_OK ) goto pager_acquire_err;
  48560. }
  48561. assert( pPg->pPager==pPager );
  48562. pPager->aStat[PAGER_STAT_MISS]++;
  48563. rc = readDbPage(pPg, iFrame);
  48564. if( rc!=SQLITE_OK ){
  48565. goto pager_acquire_err;
  48566. }
  48567. }
  48568. pager_set_pagehash(pPg);
  48569. }
  48570. return SQLITE_OK;
  48571. pager_acquire_err:
  48572. assert( rc!=SQLITE_OK );
  48573. if( pPg ){
  48574. sqlite3PcacheDrop(pPg);
  48575. }
  48576. pagerUnlockIfUnused(pPager);
  48577. *ppPage = 0;
  48578. return rc;
  48579. }
  48580. /*
  48581. ** Acquire a page if it is already in the in-memory cache. Do
  48582. ** not read the page from disk. Return a pointer to the page,
  48583. ** or 0 if the page is not in cache.
  48584. **
  48585. ** See also sqlite3PagerGet(). The difference between this routine
  48586. ** and sqlite3PagerGet() is that _get() will go to the disk and read
  48587. ** in the page if the page is not already in cache. This routine
  48588. ** returns NULL if the page is not in cache or if a disk I/O error
  48589. ** has ever happened.
  48590. */
  48591. SQLITE_PRIVATE DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
  48592. sqlite3_pcache_page *pPage;
  48593. assert( pPager!=0 );
  48594. assert( pgno!=0 );
  48595. assert( pPager->pPCache!=0 );
  48596. pPage = sqlite3PcacheFetch(pPager->pPCache, pgno, 0);
  48597. assert( pPage==0 || pPager->hasHeldSharedLock );
  48598. if( pPage==0 ) return 0;
  48599. return sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pPage);
  48600. }
  48601. /*
  48602. ** Release a page reference.
  48603. **
  48604. ** If the number of references to the page drop to zero, then the
  48605. ** page is added to the LRU list. When all references to all pages
  48606. ** are released, a rollback occurs and the lock on the database is
  48607. ** removed.
  48608. */
  48609. SQLITE_PRIVATE void sqlite3PagerUnrefNotNull(DbPage *pPg){
  48610. Pager *pPager;
  48611. assert( pPg!=0 );
  48612. pPager = pPg->pPager;
  48613. if( pPg->flags & PGHDR_MMAP ){
  48614. pagerReleaseMapPage(pPg);
  48615. }else{
  48616. sqlite3PcacheRelease(pPg);
  48617. }
  48618. pagerUnlockIfUnused(pPager);
  48619. }
  48620. SQLITE_PRIVATE void sqlite3PagerUnref(DbPage *pPg){
  48621. if( pPg ) sqlite3PagerUnrefNotNull(pPg);
  48622. }
  48623. /*
  48624. ** This function is called at the start of every write transaction.
  48625. ** There must already be a RESERVED or EXCLUSIVE lock on the database
  48626. ** file when this routine is called.
  48627. **
  48628. ** Open the journal file for pager pPager and write a journal header
  48629. ** to the start of it. If there are active savepoints, open the sub-journal
  48630. ** as well. This function is only used when the journal file is being
  48631. ** opened to write a rollback log for a transaction. It is not used
  48632. ** when opening a hot journal file to roll it back.
  48633. **
  48634. ** If the journal file is already open (as it may be in exclusive mode),
  48635. ** then this function just writes a journal header to the start of the
  48636. ** already open file.
  48637. **
  48638. ** Whether or not the journal file is opened by this function, the
  48639. ** Pager.pInJournal bitvec structure is allocated.
  48640. **
  48641. ** Return SQLITE_OK if everything is successful. Otherwise, return
  48642. ** SQLITE_NOMEM if the attempt to allocate Pager.pInJournal fails, or
  48643. ** an IO error code if opening or writing the journal file fails.
  48644. */
  48645. static int pager_open_journal(Pager *pPager){
  48646. int rc = SQLITE_OK; /* Return code */
  48647. sqlite3_vfs * const pVfs = pPager->pVfs; /* Local cache of vfs pointer */
  48648. assert( pPager->eState==PAGER_WRITER_LOCKED );
  48649. assert( assert_pager_state(pPager) );
  48650. assert( pPager->pInJournal==0 );
  48651. /* If already in the error state, this function is a no-op. But on
  48652. ** the other hand, this routine is never called if we are already in
  48653. ** an error state. */
  48654. if( NEVER(pPager->errCode) ) return pPager->errCode;
  48655. if( !pagerUseWal(pPager) && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
  48656. pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
  48657. if( pPager->pInJournal==0 ){
  48658. return SQLITE_NOMEM_BKPT;
  48659. }
  48660. /* Open the journal file if it is not already open. */
  48661. if( !isOpen(pPager->jfd) ){
  48662. if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
  48663. sqlite3MemJournalOpen(pPager->jfd);
  48664. }else{
  48665. int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE;
  48666. int nSpill;
  48667. if( pPager->tempFile ){
  48668. flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
  48669. nSpill = sqlite3Config.nStmtSpill;
  48670. }else{
  48671. flags |= SQLITE_OPEN_MAIN_JOURNAL;
  48672. nSpill = jrnlBufferSize(pPager);
  48673. }
  48674. /* Verify that the database still has the same name as it did when
  48675. ** it was originally opened. */
  48676. rc = databaseIsUnmoved(pPager);
  48677. if( rc==SQLITE_OK ){
  48678. rc = sqlite3JournalOpen (
  48679. pVfs, pPager->zJournal, pPager->jfd, flags, nSpill
  48680. );
  48681. }
  48682. }
  48683. assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
  48684. }
  48685. /* Write the first journal header to the journal file and open
  48686. ** the sub-journal if necessary.
  48687. */
  48688. if( rc==SQLITE_OK ){
  48689. /* TODO: Check if all of these are really required. */
  48690. pPager->nRec = 0;
  48691. pPager->journalOff = 0;
  48692. pPager->setMaster = 0;
  48693. pPager->journalHdr = 0;
  48694. rc = writeJournalHdr(pPager);
  48695. }
  48696. }
  48697. if( rc!=SQLITE_OK ){
  48698. sqlite3BitvecDestroy(pPager->pInJournal);
  48699. pPager->pInJournal = 0;
  48700. }else{
  48701. assert( pPager->eState==PAGER_WRITER_LOCKED );
  48702. pPager->eState = PAGER_WRITER_CACHEMOD;
  48703. }
  48704. return rc;
  48705. }
  48706. /*
  48707. ** Begin a write-transaction on the specified pager object. If a
  48708. ** write-transaction has already been opened, this function is a no-op.
  48709. **
  48710. ** If the exFlag argument is false, then acquire at least a RESERVED
  48711. ** lock on the database file. If exFlag is true, then acquire at least
  48712. ** an EXCLUSIVE lock. If such a lock is already held, no locking
  48713. ** functions need be called.
  48714. **
  48715. ** If the subjInMemory argument is non-zero, then any sub-journal opened
  48716. ** within this transaction will be opened as an in-memory file. This
  48717. ** has no effect if the sub-journal is already opened (as it may be when
  48718. ** running in exclusive mode) or if the transaction does not require a
  48719. ** sub-journal. If the subjInMemory argument is zero, then any required
  48720. ** sub-journal is implemented in-memory if pPager is an in-memory database,
  48721. ** or using a temporary file otherwise.
  48722. */
  48723. SQLITE_PRIVATE int sqlite3PagerBegin(Pager *pPager, int exFlag, int subjInMemory){
  48724. int rc = SQLITE_OK;
  48725. if( pPager->errCode ) return pPager->errCode;
  48726. assert( pPager->eState>=PAGER_READER && pPager->eState<PAGER_ERROR );
  48727. pPager->subjInMemory = (u8)subjInMemory;
  48728. if( ALWAYS(pPager->eState==PAGER_READER) ){
  48729. assert( pPager->pInJournal==0 );
  48730. if( pagerUseWal(pPager) ){
  48731. /* If the pager is configured to use locking_mode=exclusive, and an
  48732. ** exclusive lock on the database is not already held, obtain it now.
  48733. */
  48734. if( pPager->exclusiveMode && sqlite3WalExclusiveMode(pPager->pWal, -1) ){
  48735. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  48736. if( rc!=SQLITE_OK ){
  48737. return rc;
  48738. }
  48739. (void)sqlite3WalExclusiveMode(pPager->pWal, 1);
  48740. }
  48741. /* Grab the write lock on the log file. If successful, upgrade to
  48742. ** PAGER_RESERVED state. Otherwise, return an error code to the caller.
  48743. ** The busy-handler is not invoked if another connection already
  48744. ** holds the write-lock. If possible, the upper layer will call it.
  48745. */
  48746. rc = sqlite3WalBeginWriteTransaction(pPager->pWal);
  48747. }else{
  48748. /* Obtain a RESERVED lock on the database file. If the exFlag parameter
  48749. ** is true, then immediately upgrade this to an EXCLUSIVE lock. The
  48750. ** busy-handler callback can be used when upgrading to the EXCLUSIVE
  48751. ** lock, but not when obtaining the RESERVED lock.
  48752. */
  48753. rc = pagerLockDb(pPager, RESERVED_LOCK);
  48754. if( rc==SQLITE_OK && exFlag ){
  48755. rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
  48756. }
  48757. }
  48758. if( rc==SQLITE_OK ){
  48759. /* Change to WRITER_LOCKED state.
  48760. **
  48761. ** WAL mode sets Pager.eState to PAGER_WRITER_LOCKED or CACHEMOD
  48762. ** when it has an open transaction, but never to DBMOD or FINISHED.
  48763. ** This is because in those states the code to roll back savepoint
  48764. ** transactions may copy data from the sub-journal into the database
  48765. ** file as well as into the page cache. Which would be incorrect in
  48766. ** WAL mode.
  48767. */
  48768. pPager->eState = PAGER_WRITER_LOCKED;
  48769. pPager->dbHintSize = pPager->dbSize;
  48770. pPager->dbFileSize = pPager->dbSize;
  48771. pPager->dbOrigSize = pPager->dbSize;
  48772. pPager->journalOff = 0;
  48773. }
  48774. assert( rc==SQLITE_OK || pPager->eState==PAGER_READER );
  48775. assert( rc!=SQLITE_OK || pPager->eState==PAGER_WRITER_LOCKED );
  48776. assert( assert_pager_state(pPager) );
  48777. }
  48778. PAGERTRACE(("TRANSACTION %d\n", PAGERID(pPager)));
  48779. return rc;
  48780. }
  48781. /*
  48782. ** Write page pPg onto the end of the rollback journal.
  48783. */
  48784. static SQLITE_NOINLINE int pagerAddPageToRollbackJournal(PgHdr *pPg){
  48785. Pager *pPager = pPg->pPager;
  48786. int rc;
  48787. u32 cksum;
  48788. char *pData2;
  48789. i64 iOff = pPager->journalOff;
  48790. /* We should never write to the journal file the page that
  48791. ** contains the database locks. The following assert verifies
  48792. ** that we do not. */
  48793. assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
  48794. assert( pPager->journalHdr<=pPager->journalOff );
  48795. CODEC2(pPager, pPg->pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
  48796. cksum = pager_cksum(pPager, (u8*)pData2);
  48797. /* Even if an IO or diskfull error occurs while journalling the
  48798. ** page in the block above, set the need-sync flag for the page.
  48799. ** Otherwise, when the transaction is rolled back, the logic in
  48800. ** playback_one_page() will think that the page needs to be restored
  48801. ** in the database file. And if an IO error occurs while doing so,
  48802. ** then corruption may follow.
  48803. */
  48804. pPg->flags |= PGHDR_NEED_SYNC;
  48805. rc = write32bits(pPager->jfd, iOff, pPg->pgno);
  48806. if( rc!=SQLITE_OK ) return rc;
  48807. rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize, iOff+4);
  48808. if( rc!=SQLITE_OK ) return rc;
  48809. rc = write32bits(pPager->jfd, iOff+pPager->pageSize+4, cksum);
  48810. if( rc!=SQLITE_OK ) return rc;
  48811. IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
  48812. pPager->journalOff, pPager->pageSize));
  48813. PAGER_INCR(sqlite3_pager_writej_count);
  48814. PAGERTRACE(("JOURNAL %d page %d needSync=%d hash(%08x)\n",
  48815. PAGERID(pPager), pPg->pgno,
  48816. ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg)));
  48817. pPager->journalOff += 8 + pPager->pageSize;
  48818. pPager->nRec++;
  48819. assert( pPager->pInJournal!=0 );
  48820. rc = sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
  48821. testcase( rc==SQLITE_NOMEM );
  48822. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  48823. rc |= addToSavepointBitvecs(pPager, pPg->pgno);
  48824. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  48825. return rc;
  48826. }
  48827. /*
  48828. ** Mark a single data page as writeable. The page is written into the
  48829. ** main journal or sub-journal as required. If the page is written into
  48830. ** one of the journals, the corresponding bit is set in the
  48831. ** Pager.pInJournal bitvec and the PagerSavepoint.pInSavepoint bitvecs
  48832. ** of any open savepoints as appropriate.
  48833. */
  48834. static int pager_write(PgHdr *pPg){
  48835. Pager *pPager = pPg->pPager;
  48836. int rc = SQLITE_OK;
  48837. /* This routine is not called unless a write-transaction has already
  48838. ** been started. The journal file may or may not be open at this point.
  48839. ** It is never called in the ERROR state.
  48840. */
  48841. assert( pPager->eState==PAGER_WRITER_LOCKED
  48842. || pPager->eState==PAGER_WRITER_CACHEMOD
  48843. || pPager->eState==PAGER_WRITER_DBMOD
  48844. );
  48845. assert( assert_pager_state(pPager) );
  48846. assert( pPager->errCode==0 );
  48847. assert( pPager->readOnly==0 );
  48848. CHECK_PAGE(pPg);
  48849. /* The journal file needs to be opened. Higher level routines have already
  48850. ** obtained the necessary locks to begin the write-transaction, but the
  48851. ** rollback journal might not yet be open. Open it now if this is the case.
  48852. **
  48853. ** This is done before calling sqlite3PcacheMakeDirty() on the page.
  48854. ** Otherwise, if it were done after calling sqlite3PcacheMakeDirty(), then
  48855. ** an error might occur and the pager would end up in WRITER_LOCKED state
  48856. ** with pages marked as dirty in the cache.
  48857. */
  48858. if( pPager->eState==PAGER_WRITER_LOCKED ){
  48859. rc = pager_open_journal(pPager);
  48860. if( rc!=SQLITE_OK ) return rc;
  48861. }
  48862. assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
  48863. assert( assert_pager_state(pPager) );
  48864. /* Mark the page that is about to be modified as dirty. */
  48865. sqlite3PcacheMakeDirty(pPg);
  48866. /* If a rollback journal is in use, them make sure the page that is about
  48867. ** to change is in the rollback journal, or if the page is a new page off
  48868. ** then end of the file, make sure it is marked as PGHDR_NEED_SYNC.
  48869. */
  48870. assert( (pPager->pInJournal!=0) == isOpen(pPager->jfd) );
  48871. if( pPager->pInJournal!=0
  48872. && sqlite3BitvecTestNotNull(pPager->pInJournal, pPg->pgno)==0
  48873. ){
  48874. assert( pagerUseWal(pPager)==0 );
  48875. if( pPg->pgno<=pPager->dbOrigSize ){
  48876. rc = pagerAddPageToRollbackJournal(pPg);
  48877. if( rc!=SQLITE_OK ){
  48878. return rc;
  48879. }
  48880. }else{
  48881. if( pPager->eState!=PAGER_WRITER_DBMOD ){
  48882. pPg->flags |= PGHDR_NEED_SYNC;
  48883. }
  48884. PAGERTRACE(("APPEND %d page %d needSync=%d\n",
  48885. PAGERID(pPager), pPg->pgno,
  48886. ((pPg->flags&PGHDR_NEED_SYNC)?1:0)));
  48887. }
  48888. }
  48889. /* The PGHDR_DIRTY bit is set above when the page was added to the dirty-list
  48890. ** and before writing the page into the rollback journal. Wait until now,
  48891. ** after the page has been successfully journalled, before setting the
  48892. ** PGHDR_WRITEABLE bit that indicates that the page can be safely modified.
  48893. */
  48894. pPg->flags |= PGHDR_WRITEABLE;
  48895. /* If the statement journal is open and the page is not in it,
  48896. ** then write the page into the statement journal.
  48897. */
  48898. if( pPager->nSavepoint>0 ){
  48899. rc = subjournalPageIfRequired(pPg);
  48900. }
  48901. /* Update the database size and return. */
  48902. if( pPager->dbSize<pPg->pgno ){
  48903. pPager->dbSize = pPg->pgno;
  48904. }
  48905. return rc;
  48906. }
  48907. /*
  48908. ** This is a variant of sqlite3PagerWrite() that runs when the sector size
  48909. ** is larger than the page size. SQLite makes the (reasonable) assumption that
  48910. ** all bytes of a sector are written together by hardware. Hence, all bytes of
  48911. ** a sector need to be journalled in case of a power loss in the middle of
  48912. ** a write.
  48913. **
  48914. ** Usually, the sector size is less than or equal to the page size, in which
  48915. ** case pages can be individually written. This routine only runs in the
  48916. ** exceptional case where the page size is smaller than the sector size.
  48917. */
  48918. static SQLITE_NOINLINE int pagerWriteLargeSector(PgHdr *pPg){
  48919. int rc = SQLITE_OK; /* Return code */
  48920. Pgno nPageCount; /* Total number of pages in database file */
  48921. Pgno pg1; /* First page of the sector pPg is located on. */
  48922. int nPage = 0; /* Number of pages starting at pg1 to journal */
  48923. int ii; /* Loop counter */
  48924. int needSync = 0; /* True if any page has PGHDR_NEED_SYNC */
  48925. Pager *pPager = pPg->pPager; /* The pager that owns pPg */
  48926. Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
  48927. /* Set the doNotSpill NOSYNC bit to 1. This is because we cannot allow
  48928. ** a journal header to be written between the pages journaled by
  48929. ** this function.
  48930. */
  48931. assert( !MEMDB );
  48932. assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)==0 );
  48933. pPager->doNotSpill |= SPILLFLAG_NOSYNC;
  48934. /* This trick assumes that both the page-size and sector-size are
  48935. ** an integer power of 2. It sets variable pg1 to the identifier
  48936. ** of the first page of the sector pPg is located on.
  48937. */
  48938. pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
  48939. nPageCount = pPager->dbSize;
  48940. if( pPg->pgno>nPageCount ){
  48941. nPage = (pPg->pgno - pg1)+1;
  48942. }else if( (pg1+nPagePerSector-1)>nPageCount ){
  48943. nPage = nPageCount+1-pg1;
  48944. }else{
  48945. nPage = nPagePerSector;
  48946. }
  48947. assert(nPage>0);
  48948. assert(pg1<=pPg->pgno);
  48949. assert((pg1+nPage)>pPg->pgno);
  48950. for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
  48951. Pgno pg = pg1+ii;
  48952. PgHdr *pPage;
  48953. if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
  48954. if( pg!=PAGER_MJ_PGNO(pPager) ){
  48955. rc = sqlite3PagerGet(pPager, pg, &pPage, 0);
  48956. if( rc==SQLITE_OK ){
  48957. rc = pager_write(pPage);
  48958. if( pPage->flags&PGHDR_NEED_SYNC ){
  48959. needSync = 1;
  48960. }
  48961. sqlite3PagerUnrefNotNull(pPage);
  48962. }
  48963. }
  48964. }else if( (pPage = sqlite3PagerLookup(pPager, pg))!=0 ){
  48965. if( pPage->flags&PGHDR_NEED_SYNC ){
  48966. needSync = 1;
  48967. }
  48968. sqlite3PagerUnrefNotNull(pPage);
  48969. }
  48970. }
  48971. /* If the PGHDR_NEED_SYNC flag is set for any of the nPage pages
  48972. ** starting at pg1, then it needs to be set for all of them. Because
  48973. ** writing to any of these nPage pages may damage the others, the
  48974. ** journal file must contain sync()ed copies of all of them
  48975. ** before any of them can be written out to the database file.
  48976. */
  48977. if( rc==SQLITE_OK && needSync ){
  48978. assert( !MEMDB );
  48979. for(ii=0; ii<nPage; ii++){
  48980. PgHdr *pPage = sqlite3PagerLookup(pPager, pg1+ii);
  48981. if( pPage ){
  48982. pPage->flags |= PGHDR_NEED_SYNC;
  48983. sqlite3PagerUnrefNotNull(pPage);
  48984. }
  48985. }
  48986. }
  48987. assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)!=0 );
  48988. pPager->doNotSpill &= ~SPILLFLAG_NOSYNC;
  48989. return rc;
  48990. }
  48991. /*
  48992. ** Mark a data page as writeable. This routine must be called before
  48993. ** making changes to a page. The caller must check the return value
  48994. ** of this function and be careful not to change any page data unless
  48995. ** this routine returns SQLITE_OK.
  48996. **
  48997. ** The difference between this function and pager_write() is that this
  48998. ** function also deals with the special case where 2 or more pages
  48999. ** fit on a single disk sector. In this case all co-resident pages
  49000. ** must have been written to the journal file before returning.
  49001. **
  49002. ** If an error occurs, SQLITE_NOMEM or an IO error code is returned
  49003. ** as appropriate. Otherwise, SQLITE_OK.
  49004. */
  49005. SQLITE_PRIVATE int sqlite3PagerWrite(PgHdr *pPg){
  49006. Pager *pPager = pPg->pPager;
  49007. assert( (pPg->flags & PGHDR_MMAP)==0 );
  49008. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  49009. assert( assert_pager_state(pPager) );
  49010. if( pPager->errCode ){
  49011. return pPager->errCode;
  49012. }else if( (pPg->flags & PGHDR_WRITEABLE)!=0 && pPager->dbSize>=pPg->pgno ){
  49013. if( pPager->nSavepoint ) return subjournalPageIfRequired(pPg);
  49014. return SQLITE_OK;
  49015. }else if( pPager->sectorSize > (u32)pPager->pageSize ){
  49016. assert( pPager->tempFile==0 );
  49017. return pagerWriteLargeSector(pPg);
  49018. }else{
  49019. return pager_write(pPg);
  49020. }
  49021. }
  49022. /*
  49023. ** Return TRUE if the page given in the argument was previously passed
  49024. ** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
  49025. ** to change the content of the page.
  49026. */
  49027. #ifndef NDEBUG
  49028. SQLITE_PRIVATE int sqlite3PagerIswriteable(DbPage *pPg){
  49029. return pPg->flags & PGHDR_WRITEABLE;
  49030. }
  49031. #endif
  49032. /*
  49033. ** A call to this routine tells the pager that it is not necessary to
  49034. ** write the information on page pPg back to the disk, even though
  49035. ** that page might be marked as dirty. This happens, for example, when
  49036. ** the page has been added as a leaf of the freelist and so its
  49037. ** content no longer matters.
  49038. **
  49039. ** The overlying software layer calls this routine when all of the data
  49040. ** on the given page is unused. The pager marks the page as clean so
  49041. ** that it does not get written to disk.
  49042. **
  49043. ** Tests show that this optimization can quadruple the speed of large
  49044. ** DELETE operations.
  49045. **
  49046. ** This optimization cannot be used with a temp-file, as the page may
  49047. ** have been dirty at the start of the transaction. In that case, if
  49048. ** memory pressure forces page pPg out of the cache, the data does need
  49049. ** to be written out to disk so that it may be read back in if the
  49050. ** current transaction is rolled back.
  49051. */
  49052. SQLITE_PRIVATE void sqlite3PagerDontWrite(PgHdr *pPg){
  49053. Pager *pPager = pPg->pPager;
  49054. if( !pPager->tempFile && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
  49055. PAGERTRACE(("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager)));
  49056. IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
  49057. pPg->flags |= PGHDR_DONT_WRITE;
  49058. pPg->flags &= ~PGHDR_WRITEABLE;
  49059. testcase( pPg->flags & PGHDR_NEED_SYNC );
  49060. pager_set_pagehash(pPg);
  49061. }
  49062. }
  49063. /*
  49064. ** This routine is called to increment the value of the database file
  49065. ** change-counter, stored as a 4-byte big-endian integer starting at
  49066. ** byte offset 24 of the pager file. The secondary change counter at
  49067. ** 92 is also updated, as is the SQLite version number at offset 96.
  49068. **
  49069. ** But this only happens if the pPager->changeCountDone flag is false.
  49070. ** To avoid excess churning of page 1, the update only happens once.
  49071. ** See also the pager_write_changecounter() routine that does an
  49072. ** unconditional update of the change counters.
  49073. **
  49074. ** If the isDirectMode flag is zero, then this is done by calling
  49075. ** sqlite3PagerWrite() on page 1, then modifying the contents of the
  49076. ** page data. In this case the file will be updated when the current
  49077. ** transaction is committed.
  49078. **
  49079. ** The isDirectMode flag may only be non-zero if the library was compiled
  49080. ** with the SQLITE_ENABLE_ATOMIC_WRITE macro defined. In this case,
  49081. ** if isDirect is non-zero, then the database file is updated directly
  49082. ** by writing an updated version of page 1 using a call to the
  49083. ** sqlite3OsWrite() function.
  49084. */
  49085. static int pager_incr_changecounter(Pager *pPager, int isDirectMode){
  49086. int rc = SQLITE_OK;
  49087. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  49088. || pPager->eState==PAGER_WRITER_DBMOD
  49089. );
  49090. assert( assert_pager_state(pPager) );
  49091. /* Declare and initialize constant integer 'isDirect'. If the
  49092. ** atomic-write optimization is enabled in this build, then isDirect
  49093. ** is initialized to the value passed as the isDirectMode parameter
  49094. ** to this function. Otherwise, it is always set to zero.
  49095. **
  49096. ** The idea is that if the atomic-write optimization is not
  49097. ** enabled at compile time, the compiler can omit the tests of
  49098. ** 'isDirect' below, as well as the block enclosed in the
  49099. ** "if( isDirect )" condition.
  49100. */
  49101. #ifndef SQLITE_ENABLE_ATOMIC_WRITE
  49102. # define DIRECT_MODE 0
  49103. assert( isDirectMode==0 );
  49104. UNUSED_PARAMETER(isDirectMode);
  49105. #else
  49106. # define DIRECT_MODE isDirectMode
  49107. #endif
  49108. if( !pPager->changeCountDone && ALWAYS(pPager->dbSize>0) ){
  49109. PgHdr *pPgHdr; /* Reference to page 1 */
  49110. assert( !pPager->tempFile && isOpen(pPager->fd) );
  49111. /* Open page 1 of the file for writing. */
  49112. rc = sqlite3PagerGet(pPager, 1, &pPgHdr, 0);
  49113. assert( pPgHdr==0 || rc==SQLITE_OK );
  49114. /* If page one was fetched successfully, and this function is not
  49115. ** operating in direct-mode, make page 1 writable. When not in
  49116. ** direct mode, page 1 is always held in cache and hence the PagerGet()
  49117. ** above is always successful - hence the ALWAYS on rc==SQLITE_OK.
  49118. */
  49119. if( !DIRECT_MODE && ALWAYS(rc==SQLITE_OK) ){
  49120. rc = sqlite3PagerWrite(pPgHdr);
  49121. }
  49122. if( rc==SQLITE_OK ){
  49123. /* Actually do the update of the change counter */
  49124. pager_write_changecounter(pPgHdr);
  49125. /* If running in direct mode, write the contents of page 1 to the file. */
  49126. if( DIRECT_MODE ){
  49127. const void *zBuf;
  49128. assert( pPager->dbFileSize>0 );
  49129. CODEC2(pPager, pPgHdr->pData, 1, 6, rc=SQLITE_NOMEM_BKPT, zBuf);
  49130. if( rc==SQLITE_OK ){
  49131. rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
  49132. pPager->aStat[PAGER_STAT_WRITE]++;
  49133. }
  49134. if( rc==SQLITE_OK ){
  49135. /* Update the pager's copy of the change-counter. Otherwise, the
  49136. ** next time a read transaction is opened the cache will be
  49137. ** flushed (as the change-counter values will not match). */
  49138. const void *pCopy = (const void *)&((const char *)zBuf)[24];
  49139. memcpy(&pPager->dbFileVers, pCopy, sizeof(pPager->dbFileVers));
  49140. pPager->changeCountDone = 1;
  49141. }
  49142. }else{
  49143. pPager->changeCountDone = 1;
  49144. }
  49145. }
  49146. /* Release the page reference. */
  49147. sqlite3PagerUnref(pPgHdr);
  49148. }
  49149. return rc;
  49150. }
  49151. /*
  49152. ** Sync the database file to disk. This is a no-op for in-memory databases
  49153. ** or pages with the Pager.noSync flag set.
  49154. **
  49155. ** If successful, or if called on a pager for which it is a no-op, this
  49156. ** function returns SQLITE_OK. Otherwise, an IO error code is returned.
  49157. */
  49158. SQLITE_PRIVATE int sqlite3PagerSync(Pager *pPager, const char *zMaster){
  49159. int rc = SQLITE_OK;
  49160. if( isOpen(pPager->fd) ){
  49161. void *pArg = (void*)zMaster;
  49162. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_SYNC, pArg);
  49163. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  49164. }
  49165. if( rc==SQLITE_OK && !pPager->noSync ){
  49166. assert( !MEMDB );
  49167. rc = sqlite3OsSync(pPager->fd, pPager->syncFlags);
  49168. }
  49169. return rc;
  49170. }
  49171. /*
  49172. ** This function may only be called while a write-transaction is active in
  49173. ** rollback. If the connection is in WAL mode, this call is a no-op.
  49174. ** Otherwise, if the connection does not already have an EXCLUSIVE lock on
  49175. ** the database file, an attempt is made to obtain one.
  49176. **
  49177. ** If the EXCLUSIVE lock is already held or the attempt to obtain it is
  49178. ** successful, or the connection is in WAL mode, SQLITE_OK is returned.
  49179. ** Otherwise, either SQLITE_BUSY or an SQLITE_IOERR_XXX error code is
  49180. ** returned.
  49181. */
  49182. SQLITE_PRIVATE int sqlite3PagerExclusiveLock(Pager *pPager){
  49183. int rc = pPager->errCode;
  49184. assert( assert_pager_state(pPager) );
  49185. if( rc==SQLITE_OK ){
  49186. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  49187. || pPager->eState==PAGER_WRITER_DBMOD
  49188. || pPager->eState==PAGER_WRITER_LOCKED
  49189. );
  49190. assert( assert_pager_state(pPager) );
  49191. if( 0==pagerUseWal(pPager) ){
  49192. rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
  49193. }
  49194. }
  49195. return rc;
  49196. }
  49197. /*
  49198. ** Sync the database file for the pager pPager. zMaster points to the name
  49199. ** of a master journal file that should be written into the individual
  49200. ** journal file. zMaster may be NULL, which is interpreted as no master
  49201. ** journal (a single database transaction).
  49202. **
  49203. ** This routine ensures that:
  49204. **
  49205. ** * The database file change-counter is updated,
  49206. ** * the journal is synced (unless the atomic-write optimization is used),
  49207. ** * all dirty pages are written to the database file,
  49208. ** * the database file is truncated (if required), and
  49209. ** * the database file synced.
  49210. **
  49211. ** The only thing that remains to commit the transaction is to finalize
  49212. ** (delete, truncate or zero the first part of) the journal file (or
  49213. ** delete the master journal file if specified).
  49214. **
  49215. ** Note that if zMaster==NULL, this does not overwrite a previous value
  49216. ** passed to an sqlite3PagerCommitPhaseOne() call.
  49217. **
  49218. ** If the final parameter - noSync - is true, then the database file itself
  49219. ** is not synced. The caller must call sqlite3PagerSync() directly to
  49220. ** sync the database file before calling CommitPhaseTwo() to delete the
  49221. ** journal file in this case.
  49222. */
  49223. SQLITE_PRIVATE int sqlite3PagerCommitPhaseOne(
  49224. Pager *pPager, /* Pager object */
  49225. const char *zMaster, /* If not NULL, the master journal name */
  49226. int noSync /* True to omit the xSync on the db file */
  49227. ){
  49228. int rc = SQLITE_OK; /* Return code */
  49229. assert( pPager->eState==PAGER_WRITER_LOCKED
  49230. || pPager->eState==PAGER_WRITER_CACHEMOD
  49231. || pPager->eState==PAGER_WRITER_DBMOD
  49232. || pPager->eState==PAGER_ERROR
  49233. );
  49234. assert( assert_pager_state(pPager) );
  49235. /* If a prior error occurred, report that error again. */
  49236. if( NEVER(pPager->errCode) ) return pPager->errCode;
  49237. /* Provide the ability to easily simulate an I/O error during testing */
  49238. if( sqlite3FaultSim(400) ) return SQLITE_IOERR;
  49239. PAGERTRACE(("DATABASE SYNC: File=%s zMaster=%s nSize=%d\n",
  49240. pPager->zFilename, zMaster, pPager->dbSize));
  49241. /* If no database changes have been made, return early. */
  49242. if( pPager->eState<PAGER_WRITER_CACHEMOD ) return SQLITE_OK;
  49243. assert( MEMDB==0 || pPager->tempFile );
  49244. assert( isOpen(pPager->fd) || pPager->tempFile );
  49245. if( 0==pagerFlushOnCommit(pPager, 1) ){
  49246. /* If this is an in-memory db, or no pages have been written to, or this
  49247. ** function has already been called, it is mostly a no-op. However, any
  49248. ** backup in progress needs to be restarted. */
  49249. sqlite3BackupRestart(pPager->pBackup);
  49250. }else{
  49251. if( pagerUseWal(pPager) ){
  49252. PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
  49253. PgHdr *pPageOne = 0;
  49254. if( pList==0 ){
  49255. /* Must have at least one page for the WAL commit flag.
  49256. ** Ticket [2d1a5c67dfc2363e44f29d9bbd57f] 2011-05-18 */
  49257. rc = sqlite3PagerGet(pPager, 1, &pPageOne, 0);
  49258. pList = pPageOne;
  49259. pList->pDirty = 0;
  49260. }
  49261. assert( rc==SQLITE_OK );
  49262. if( ALWAYS(pList) ){
  49263. rc = pagerWalFrames(pPager, pList, pPager->dbSize, 1);
  49264. }
  49265. sqlite3PagerUnref(pPageOne);
  49266. if( rc==SQLITE_OK ){
  49267. sqlite3PcacheCleanAll(pPager->pPCache);
  49268. }
  49269. }else{
  49270. /* The following block updates the change-counter. Exactly how it
  49271. ** does this depends on whether or not the atomic-update optimization
  49272. ** was enabled at compile time, and if this transaction meets the
  49273. ** runtime criteria to use the operation:
  49274. **
  49275. ** * The file-system supports the atomic-write property for
  49276. ** blocks of size page-size, and
  49277. ** * This commit is not part of a multi-file transaction, and
  49278. ** * Exactly one page has been modified and store in the journal file.
  49279. **
  49280. ** If the optimization was not enabled at compile time, then the
  49281. ** pager_incr_changecounter() function is called to update the change
  49282. ** counter in 'indirect-mode'. If the optimization is compiled in but
  49283. ** is not applicable to this transaction, call sqlite3JournalCreate()
  49284. ** to make sure the journal file has actually been created, then call
  49285. ** pager_incr_changecounter() to update the change-counter in indirect
  49286. ** mode.
  49287. **
  49288. ** Otherwise, if the optimization is both enabled and applicable,
  49289. ** then call pager_incr_changecounter() to update the change-counter
  49290. ** in 'direct' mode. In this case the journal file will never be
  49291. ** created for this transaction.
  49292. */
  49293. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  49294. PgHdr *pPg;
  49295. assert( isOpen(pPager->jfd)
  49296. || pPager->journalMode==PAGER_JOURNALMODE_OFF
  49297. || pPager->journalMode==PAGER_JOURNALMODE_WAL
  49298. );
  49299. if( !zMaster && isOpen(pPager->jfd)
  49300. && pPager->journalOff==jrnlBufferSize(pPager)
  49301. && pPager->dbSize>=pPager->dbOrigSize
  49302. && (0==(pPg = sqlite3PcacheDirtyList(pPager->pPCache)) || 0==pPg->pDirty)
  49303. ){
  49304. /* Update the db file change counter via the direct-write method. The
  49305. ** following call will modify the in-memory representation of page 1
  49306. ** to include the updated change counter and then write page 1
  49307. ** directly to the database file. Because of the atomic-write
  49308. ** property of the host file-system, this is safe.
  49309. */
  49310. rc = pager_incr_changecounter(pPager, 1);
  49311. }else{
  49312. rc = sqlite3JournalCreate(pPager->jfd);
  49313. if( rc==SQLITE_OK ){
  49314. rc = pager_incr_changecounter(pPager, 0);
  49315. }
  49316. }
  49317. #else
  49318. rc = pager_incr_changecounter(pPager, 0);
  49319. #endif
  49320. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  49321. /* Write the master journal name into the journal file. If a master
  49322. ** journal file name has already been written to the journal file,
  49323. ** or if zMaster is NULL (no master journal), then this call is a no-op.
  49324. */
  49325. rc = writeMasterJournal(pPager, zMaster);
  49326. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  49327. /* Sync the journal file and write all dirty pages to the database.
  49328. ** If the atomic-update optimization is being used, this sync will not
  49329. ** create the journal file or perform any real IO.
  49330. **
  49331. ** Because the change-counter page was just modified, unless the
  49332. ** atomic-update optimization is used it is almost certain that the
  49333. ** journal requires a sync here. However, in locking_mode=exclusive
  49334. ** on a system under memory pressure it is just possible that this is
  49335. ** not the case. In this case it is likely enough that the redundant
  49336. ** xSync() call will be changed to a no-op by the OS anyhow.
  49337. */
  49338. rc = syncJournal(pPager, 0);
  49339. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  49340. rc = pager_write_pagelist(pPager,sqlite3PcacheDirtyList(pPager->pPCache));
  49341. if( rc!=SQLITE_OK ){
  49342. assert( rc!=SQLITE_IOERR_BLOCKED );
  49343. goto commit_phase_one_exit;
  49344. }
  49345. sqlite3PcacheCleanAll(pPager->pPCache);
  49346. /* If the file on disk is smaller than the database image, use
  49347. ** pager_truncate to grow the file here. This can happen if the database
  49348. ** image was extended as part of the current transaction and then the
  49349. ** last page in the db image moved to the free-list. In this case the
  49350. ** last page is never written out to disk, leaving the database file
  49351. ** undersized. Fix this now if it is the case. */
  49352. if( pPager->dbSize>pPager->dbFileSize ){
  49353. Pgno nNew = pPager->dbSize - (pPager->dbSize==PAGER_MJ_PGNO(pPager));
  49354. assert( pPager->eState==PAGER_WRITER_DBMOD );
  49355. rc = pager_truncate(pPager, nNew);
  49356. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  49357. }
  49358. /* Finally, sync the database file. */
  49359. if( !noSync ){
  49360. rc = sqlite3PagerSync(pPager, zMaster);
  49361. }
  49362. IOTRACE(("DBSYNC %p\n", pPager))
  49363. }
  49364. }
  49365. commit_phase_one_exit:
  49366. if( rc==SQLITE_OK && !pagerUseWal(pPager) ){
  49367. pPager->eState = PAGER_WRITER_FINISHED;
  49368. }
  49369. return rc;
  49370. }
  49371. /*
  49372. ** When this function is called, the database file has been completely
  49373. ** updated to reflect the changes made by the current transaction and
  49374. ** synced to disk. The journal file still exists in the file-system
  49375. ** though, and if a failure occurs at this point it will eventually
  49376. ** be used as a hot-journal and the current transaction rolled back.
  49377. **
  49378. ** This function finalizes the journal file, either by deleting,
  49379. ** truncating or partially zeroing it, so that it cannot be used
  49380. ** for hot-journal rollback. Once this is done the transaction is
  49381. ** irrevocably committed.
  49382. **
  49383. ** If an error occurs, an IO error code is returned and the pager
  49384. ** moves into the error state. Otherwise, SQLITE_OK is returned.
  49385. */
  49386. SQLITE_PRIVATE int sqlite3PagerCommitPhaseTwo(Pager *pPager){
  49387. int rc = SQLITE_OK; /* Return code */
  49388. /* This routine should not be called if a prior error has occurred.
  49389. ** But if (due to a coding error elsewhere in the system) it does get
  49390. ** called, just return the same error code without doing anything. */
  49391. if( NEVER(pPager->errCode) ) return pPager->errCode;
  49392. assert( pPager->eState==PAGER_WRITER_LOCKED
  49393. || pPager->eState==PAGER_WRITER_FINISHED
  49394. || (pagerUseWal(pPager) && pPager->eState==PAGER_WRITER_CACHEMOD)
  49395. );
  49396. assert( assert_pager_state(pPager) );
  49397. /* An optimization. If the database was not actually modified during
  49398. ** this transaction, the pager is running in exclusive-mode and is
  49399. ** using persistent journals, then this function is a no-op.
  49400. **
  49401. ** The start of the journal file currently contains a single journal
  49402. ** header with the nRec field set to 0. If such a journal is used as
  49403. ** a hot-journal during hot-journal rollback, 0 changes will be made
  49404. ** to the database file. So there is no need to zero the journal
  49405. ** header. Since the pager is in exclusive mode, there is no need
  49406. ** to drop any locks either.
  49407. */
  49408. if( pPager->eState==PAGER_WRITER_LOCKED
  49409. && pPager->exclusiveMode
  49410. && pPager->journalMode==PAGER_JOURNALMODE_PERSIST
  49411. ){
  49412. assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) || !pPager->journalOff );
  49413. pPager->eState = PAGER_READER;
  49414. return SQLITE_OK;
  49415. }
  49416. PAGERTRACE(("COMMIT %d\n", PAGERID(pPager)));
  49417. pPager->iDataVersion++;
  49418. rc = pager_end_transaction(pPager, pPager->setMaster, 1);
  49419. return pager_error(pPager, rc);
  49420. }
  49421. /*
  49422. ** If a write transaction is open, then all changes made within the
  49423. ** transaction are reverted and the current write-transaction is closed.
  49424. ** The pager falls back to PAGER_READER state if successful, or PAGER_ERROR
  49425. ** state if an error occurs.
  49426. **
  49427. ** If the pager is already in PAGER_ERROR state when this function is called,
  49428. ** it returns Pager.errCode immediately. No work is performed in this case.
  49429. **
  49430. ** Otherwise, in rollback mode, this function performs two functions:
  49431. **
  49432. ** 1) It rolls back the journal file, restoring all database file and
  49433. ** in-memory cache pages to the state they were in when the transaction
  49434. ** was opened, and
  49435. **
  49436. ** 2) It finalizes the journal file, so that it is not used for hot
  49437. ** rollback at any point in the future.
  49438. **
  49439. ** Finalization of the journal file (task 2) is only performed if the
  49440. ** rollback is successful.
  49441. **
  49442. ** In WAL mode, all cache-entries containing data modified within the
  49443. ** current transaction are either expelled from the cache or reverted to
  49444. ** their pre-transaction state by re-reading data from the database or
  49445. ** WAL files. The WAL transaction is then closed.
  49446. */
  49447. SQLITE_PRIVATE int sqlite3PagerRollback(Pager *pPager){
  49448. int rc = SQLITE_OK; /* Return code */
  49449. PAGERTRACE(("ROLLBACK %d\n", PAGERID(pPager)));
  49450. /* PagerRollback() is a no-op if called in READER or OPEN state. If
  49451. ** the pager is already in the ERROR state, the rollback is not
  49452. ** attempted here. Instead, the error code is returned to the caller.
  49453. */
  49454. assert( assert_pager_state(pPager) );
  49455. if( pPager->eState==PAGER_ERROR ) return pPager->errCode;
  49456. if( pPager->eState<=PAGER_READER ) return SQLITE_OK;
  49457. if( pagerUseWal(pPager) ){
  49458. int rc2;
  49459. rc = sqlite3PagerSavepoint(pPager, SAVEPOINT_ROLLBACK, -1);
  49460. rc2 = pager_end_transaction(pPager, pPager->setMaster, 0);
  49461. if( rc==SQLITE_OK ) rc = rc2;
  49462. }else if( !isOpen(pPager->jfd) || pPager->eState==PAGER_WRITER_LOCKED ){
  49463. int eState = pPager->eState;
  49464. rc = pager_end_transaction(pPager, 0, 0);
  49465. if( !MEMDB && eState>PAGER_WRITER_LOCKED ){
  49466. /* This can happen using journal_mode=off. Move the pager to the error
  49467. ** state to indicate that the contents of the cache may not be trusted.
  49468. ** Any active readers will get SQLITE_ABORT.
  49469. */
  49470. pPager->errCode = SQLITE_ABORT;
  49471. pPager->eState = PAGER_ERROR;
  49472. return rc;
  49473. }
  49474. }else{
  49475. rc = pager_playback(pPager, 0);
  49476. }
  49477. assert( pPager->eState==PAGER_READER || rc!=SQLITE_OK );
  49478. assert( rc==SQLITE_OK || rc==SQLITE_FULL || rc==SQLITE_CORRUPT
  49479. || rc==SQLITE_NOMEM || (rc&0xFF)==SQLITE_IOERR
  49480. || rc==SQLITE_CANTOPEN
  49481. );
  49482. /* If an error occurs during a ROLLBACK, we can no longer trust the pager
  49483. ** cache. So call pager_error() on the way out to make any error persistent.
  49484. */
  49485. return pager_error(pPager, rc);
  49486. }
  49487. /*
  49488. ** Return TRUE if the database file is opened read-only. Return FALSE
  49489. ** if the database is (in theory) writable.
  49490. */
  49491. SQLITE_PRIVATE u8 sqlite3PagerIsreadonly(Pager *pPager){
  49492. return pPager->readOnly;
  49493. }
  49494. #ifdef SQLITE_DEBUG
  49495. /*
  49496. ** Return the sum of the reference counts for all pages held by pPager.
  49497. */
  49498. SQLITE_PRIVATE int sqlite3PagerRefcount(Pager *pPager){
  49499. return sqlite3PcacheRefCount(pPager->pPCache);
  49500. }
  49501. #endif
  49502. /*
  49503. ** Return the approximate number of bytes of memory currently
  49504. ** used by the pager and its associated cache.
  49505. */
  49506. SQLITE_PRIVATE int sqlite3PagerMemUsed(Pager *pPager){
  49507. int perPageSize = pPager->pageSize + pPager->nExtra + sizeof(PgHdr)
  49508. + 5*sizeof(void*);
  49509. return perPageSize*sqlite3PcachePagecount(pPager->pPCache)
  49510. + sqlite3MallocSize(pPager)
  49511. + pPager->pageSize;
  49512. }
  49513. /*
  49514. ** Return the number of references to the specified page.
  49515. */
  49516. SQLITE_PRIVATE int sqlite3PagerPageRefcount(DbPage *pPage){
  49517. return sqlite3PcachePageRefcount(pPage);
  49518. }
  49519. #ifdef SQLITE_TEST
  49520. /*
  49521. ** This routine is used for testing and analysis only.
  49522. */
  49523. SQLITE_PRIVATE int *sqlite3PagerStats(Pager *pPager){
  49524. static int a[11];
  49525. a[0] = sqlite3PcacheRefCount(pPager->pPCache);
  49526. a[1] = sqlite3PcachePagecount(pPager->pPCache);
  49527. a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
  49528. a[3] = pPager->eState==PAGER_OPEN ? -1 : (int) pPager->dbSize;
  49529. a[4] = pPager->eState;
  49530. a[5] = pPager->errCode;
  49531. a[6] = pPager->aStat[PAGER_STAT_HIT];
  49532. a[7] = pPager->aStat[PAGER_STAT_MISS];
  49533. a[8] = 0; /* Used to be pPager->nOvfl */
  49534. a[9] = pPager->nRead;
  49535. a[10] = pPager->aStat[PAGER_STAT_WRITE];
  49536. return a;
  49537. }
  49538. #endif
  49539. /*
  49540. ** Parameter eStat must be either SQLITE_DBSTATUS_CACHE_HIT or
  49541. ** SQLITE_DBSTATUS_CACHE_MISS. Before returning, *pnVal is incremented by the
  49542. ** current cache hit or miss count, according to the value of eStat. If the
  49543. ** reset parameter is non-zero, the cache hit or miss count is zeroed before
  49544. ** returning.
  49545. */
  49546. SQLITE_PRIVATE void sqlite3PagerCacheStat(Pager *pPager, int eStat, int reset, int *pnVal){
  49547. assert( eStat==SQLITE_DBSTATUS_CACHE_HIT
  49548. || eStat==SQLITE_DBSTATUS_CACHE_MISS
  49549. || eStat==SQLITE_DBSTATUS_CACHE_WRITE
  49550. );
  49551. assert( SQLITE_DBSTATUS_CACHE_HIT+1==SQLITE_DBSTATUS_CACHE_MISS );
  49552. assert( SQLITE_DBSTATUS_CACHE_HIT+2==SQLITE_DBSTATUS_CACHE_WRITE );
  49553. assert( PAGER_STAT_HIT==0 && PAGER_STAT_MISS==1 && PAGER_STAT_WRITE==2 );
  49554. *pnVal += pPager->aStat[eStat - SQLITE_DBSTATUS_CACHE_HIT];
  49555. if( reset ){
  49556. pPager->aStat[eStat - SQLITE_DBSTATUS_CACHE_HIT] = 0;
  49557. }
  49558. }
  49559. /*
  49560. ** Return true if this is an in-memory or temp-file backed pager.
  49561. */
  49562. SQLITE_PRIVATE int sqlite3PagerIsMemdb(Pager *pPager){
  49563. return pPager->tempFile;
  49564. }
  49565. /*
  49566. ** Check that there are at least nSavepoint savepoints open. If there are
  49567. ** currently less than nSavepoints open, then open one or more savepoints
  49568. ** to make up the difference. If the number of savepoints is already
  49569. ** equal to nSavepoint, then this function is a no-op.
  49570. **
  49571. ** If a memory allocation fails, SQLITE_NOMEM is returned. If an error
  49572. ** occurs while opening the sub-journal file, then an IO error code is
  49573. ** returned. Otherwise, SQLITE_OK.
  49574. */
  49575. static SQLITE_NOINLINE int pagerOpenSavepoint(Pager *pPager, int nSavepoint){
  49576. int rc = SQLITE_OK; /* Return code */
  49577. int nCurrent = pPager->nSavepoint; /* Current number of savepoints */
  49578. int ii; /* Iterator variable */
  49579. PagerSavepoint *aNew; /* New Pager.aSavepoint array */
  49580. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  49581. assert( assert_pager_state(pPager) );
  49582. assert( nSavepoint>nCurrent && pPager->useJournal );
  49583. /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
  49584. ** if the allocation fails. Otherwise, zero the new portion in case a
  49585. ** malloc failure occurs while populating it in the for(...) loop below.
  49586. */
  49587. aNew = (PagerSavepoint *)sqlite3Realloc(
  49588. pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
  49589. );
  49590. if( !aNew ){
  49591. return SQLITE_NOMEM_BKPT;
  49592. }
  49593. memset(&aNew[nCurrent], 0, (nSavepoint-nCurrent) * sizeof(PagerSavepoint));
  49594. pPager->aSavepoint = aNew;
  49595. /* Populate the PagerSavepoint structures just allocated. */
  49596. for(ii=nCurrent; ii<nSavepoint; ii++){
  49597. aNew[ii].nOrig = pPager->dbSize;
  49598. if( isOpen(pPager->jfd) && pPager->journalOff>0 ){
  49599. aNew[ii].iOffset = pPager->journalOff;
  49600. }else{
  49601. aNew[ii].iOffset = JOURNAL_HDR_SZ(pPager);
  49602. }
  49603. aNew[ii].iSubRec = pPager->nSubRec;
  49604. aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
  49605. if( !aNew[ii].pInSavepoint ){
  49606. return SQLITE_NOMEM_BKPT;
  49607. }
  49608. if( pagerUseWal(pPager) ){
  49609. sqlite3WalSavepoint(pPager->pWal, aNew[ii].aWalData);
  49610. }
  49611. pPager->nSavepoint = ii+1;
  49612. }
  49613. assert( pPager->nSavepoint==nSavepoint );
  49614. assertTruncateConstraint(pPager);
  49615. return rc;
  49616. }
  49617. SQLITE_PRIVATE int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
  49618. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  49619. assert( assert_pager_state(pPager) );
  49620. if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
  49621. return pagerOpenSavepoint(pPager, nSavepoint);
  49622. }else{
  49623. return SQLITE_OK;
  49624. }
  49625. }
  49626. /*
  49627. ** This function is called to rollback or release (commit) a savepoint.
  49628. ** The savepoint to release or rollback need not be the most recently
  49629. ** created savepoint.
  49630. **
  49631. ** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
  49632. ** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
  49633. ** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
  49634. ** that have occurred since the specified savepoint was created.
  49635. **
  49636. ** The savepoint to rollback or release is identified by parameter
  49637. ** iSavepoint. A value of 0 means to operate on the outermost savepoint
  49638. ** (the first created). A value of (Pager.nSavepoint-1) means operate
  49639. ** on the most recently created savepoint. If iSavepoint is greater than
  49640. ** (Pager.nSavepoint-1), then this function is a no-op.
  49641. **
  49642. ** If a negative value is passed to this function, then the current
  49643. ** transaction is rolled back. This is different to calling
  49644. ** sqlite3PagerRollback() because this function does not terminate
  49645. ** the transaction or unlock the database, it just restores the
  49646. ** contents of the database to its original state.
  49647. **
  49648. ** In any case, all savepoints with an index greater than iSavepoint
  49649. ** are destroyed. If this is a release operation (op==SAVEPOINT_RELEASE),
  49650. ** then savepoint iSavepoint is also destroyed.
  49651. **
  49652. ** This function may return SQLITE_NOMEM if a memory allocation fails,
  49653. ** or an IO error code if an IO error occurs while rolling back a
  49654. ** savepoint. If no errors occur, SQLITE_OK is returned.
  49655. */
  49656. SQLITE_PRIVATE int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
  49657. int rc = pPager->errCode;
  49658. #ifdef SQLITE_ENABLE_ZIPVFS
  49659. if( op==SAVEPOINT_RELEASE ) rc = SQLITE_OK;
  49660. #endif
  49661. assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
  49662. assert( iSavepoint>=0 || op==SAVEPOINT_ROLLBACK );
  49663. if( rc==SQLITE_OK && iSavepoint<pPager->nSavepoint ){
  49664. int ii; /* Iterator variable */
  49665. int nNew; /* Number of remaining savepoints after this op. */
  49666. /* Figure out how many savepoints will still be active after this
  49667. ** operation. Store this value in nNew. Then free resources associated
  49668. ** with any savepoints that are destroyed by this operation.
  49669. */
  49670. nNew = iSavepoint + (( op==SAVEPOINT_RELEASE ) ? 0 : 1);
  49671. for(ii=nNew; ii<pPager->nSavepoint; ii++){
  49672. sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
  49673. }
  49674. pPager->nSavepoint = nNew;
  49675. /* If this is a release of the outermost savepoint, truncate
  49676. ** the sub-journal to zero bytes in size. */
  49677. if( op==SAVEPOINT_RELEASE ){
  49678. if( nNew==0 && isOpen(pPager->sjfd) ){
  49679. /* Only truncate if it is an in-memory sub-journal. */
  49680. if( sqlite3JournalIsInMemory(pPager->sjfd) ){
  49681. rc = sqlite3OsTruncate(pPager->sjfd, 0);
  49682. assert( rc==SQLITE_OK );
  49683. }
  49684. pPager->nSubRec = 0;
  49685. }
  49686. }
  49687. /* Else this is a rollback operation, playback the specified savepoint.
  49688. ** If this is a temp-file, it is possible that the journal file has
  49689. ** not yet been opened. In this case there have been no changes to
  49690. ** the database file, so the playback operation can be skipped.
  49691. */
  49692. else if( pagerUseWal(pPager) || isOpen(pPager->jfd) ){
  49693. PagerSavepoint *pSavepoint = (nNew==0)?0:&pPager->aSavepoint[nNew-1];
  49694. rc = pagerPlaybackSavepoint(pPager, pSavepoint);
  49695. assert(rc!=SQLITE_DONE);
  49696. }
  49697. #ifdef SQLITE_ENABLE_ZIPVFS
  49698. /* If the cache has been modified but the savepoint cannot be rolled
  49699. ** back journal_mode=off, put the pager in the error state. This way,
  49700. ** if the VFS used by this pager includes ZipVFS, the entire transaction
  49701. ** can be rolled back at the ZipVFS level. */
  49702. else if(
  49703. pPager->journalMode==PAGER_JOURNALMODE_OFF
  49704. && pPager->eState>=PAGER_WRITER_CACHEMOD
  49705. ){
  49706. pPager->errCode = SQLITE_ABORT;
  49707. pPager->eState = PAGER_ERROR;
  49708. }
  49709. #endif
  49710. }
  49711. return rc;
  49712. }
  49713. /*
  49714. ** Return the full pathname of the database file.
  49715. **
  49716. ** Except, if the pager is in-memory only, then return an empty string if
  49717. ** nullIfMemDb is true. This routine is called with nullIfMemDb==1 when
  49718. ** used to report the filename to the user, for compatibility with legacy
  49719. ** behavior. But when the Btree needs to know the filename for matching to
  49720. ** shared cache, it uses nullIfMemDb==0 so that in-memory databases can
  49721. ** participate in shared-cache.
  49722. */
  49723. SQLITE_PRIVATE const char *sqlite3PagerFilename(Pager *pPager, int nullIfMemDb){
  49724. return (nullIfMemDb && pPager->memDb) ? "" : pPager->zFilename;
  49725. }
  49726. /*
  49727. ** Return the VFS structure for the pager.
  49728. */
  49729. SQLITE_PRIVATE sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
  49730. return pPager->pVfs;
  49731. }
  49732. /*
  49733. ** Return the file handle for the database file associated
  49734. ** with the pager. This might return NULL if the file has
  49735. ** not yet been opened.
  49736. */
  49737. SQLITE_PRIVATE sqlite3_file *sqlite3PagerFile(Pager *pPager){
  49738. return pPager->fd;
  49739. }
  49740. /*
  49741. ** Return the file handle for the journal file (if it exists).
  49742. ** This will be either the rollback journal or the WAL file.
  49743. */
  49744. SQLITE_PRIVATE sqlite3_file *sqlite3PagerJrnlFile(Pager *pPager){
  49745. #if SQLITE_OMIT_WAL
  49746. return pPager->jfd;
  49747. #else
  49748. return pPager->pWal ? sqlite3WalFile(pPager->pWal) : pPager->jfd;
  49749. #endif
  49750. }
  49751. /*
  49752. ** Return the full pathname of the journal file.
  49753. */
  49754. SQLITE_PRIVATE const char *sqlite3PagerJournalname(Pager *pPager){
  49755. return pPager->zJournal;
  49756. }
  49757. #ifdef SQLITE_HAS_CODEC
  49758. /*
  49759. ** Set or retrieve the codec for this pager
  49760. */
  49761. SQLITE_PRIVATE void sqlite3PagerSetCodec(
  49762. Pager *pPager,
  49763. void *(*xCodec)(void*,void*,Pgno,int),
  49764. void (*xCodecSizeChng)(void*,int,int),
  49765. void (*xCodecFree)(void*),
  49766. void *pCodec
  49767. ){
  49768. if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
  49769. pPager->xCodec = pPager->memDb ? 0 : xCodec;
  49770. pPager->xCodecSizeChng = xCodecSizeChng;
  49771. pPager->xCodecFree = xCodecFree;
  49772. pPager->pCodec = pCodec;
  49773. pagerReportSize(pPager);
  49774. }
  49775. SQLITE_PRIVATE void *sqlite3PagerGetCodec(Pager *pPager){
  49776. return pPager->pCodec;
  49777. }
  49778. /*
  49779. ** This function is called by the wal module when writing page content
  49780. ** into the log file.
  49781. **
  49782. ** This function returns a pointer to a buffer containing the encrypted
  49783. ** page content. If a malloc fails, this function may return NULL.
  49784. */
  49785. SQLITE_PRIVATE void *sqlite3PagerCodec(PgHdr *pPg){
  49786. void *aData = 0;
  49787. CODEC2(pPg->pPager, pPg->pData, pPg->pgno, 6, return 0, aData);
  49788. return aData;
  49789. }
  49790. /*
  49791. ** Return the current pager state
  49792. */
  49793. SQLITE_PRIVATE int sqlite3PagerState(Pager *pPager){
  49794. return pPager->eState;
  49795. }
  49796. #endif /* SQLITE_HAS_CODEC */
  49797. #ifndef SQLITE_OMIT_AUTOVACUUM
  49798. /*
  49799. ** Move the page pPg to location pgno in the file.
  49800. **
  49801. ** There must be no references to the page previously located at
  49802. ** pgno (which we call pPgOld) though that page is allowed to be
  49803. ** in cache. If the page previously located at pgno is not already
  49804. ** in the rollback journal, it is not put there by by this routine.
  49805. **
  49806. ** References to the page pPg remain valid. Updating any
  49807. ** meta-data associated with pPg (i.e. data stored in the nExtra bytes
  49808. ** allocated along with the page) is the responsibility of the caller.
  49809. **
  49810. ** A transaction must be active when this routine is called. It used to be
  49811. ** required that a statement transaction was not active, but this restriction
  49812. ** has been removed (CREATE INDEX needs to move a page when a statement
  49813. ** transaction is active).
  49814. **
  49815. ** If the fourth argument, isCommit, is non-zero, then this page is being
  49816. ** moved as part of a database reorganization just before the transaction
  49817. ** is being committed. In this case, it is guaranteed that the database page
  49818. ** pPg refers to will not be written to again within this transaction.
  49819. **
  49820. ** This function may return SQLITE_NOMEM or an IO error code if an error
  49821. ** occurs. Otherwise, it returns SQLITE_OK.
  49822. */
  49823. SQLITE_PRIVATE int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
  49824. PgHdr *pPgOld; /* The page being overwritten. */
  49825. Pgno needSyncPgno = 0; /* Old value of pPg->pgno, if sync is required */
  49826. int rc; /* Return code */
  49827. Pgno origPgno; /* The original page number */
  49828. assert( pPg->nRef>0 );
  49829. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  49830. || pPager->eState==PAGER_WRITER_DBMOD
  49831. );
  49832. assert( assert_pager_state(pPager) );
  49833. /* In order to be able to rollback, an in-memory database must journal
  49834. ** the page we are moving from.
  49835. */
  49836. assert( pPager->tempFile || !MEMDB );
  49837. if( pPager->tempFile ){
  49838. rc = sqlite3PagerWrite(pPg);
  49839. if( rc ) return rc;
  49840. }
  49841. /* If the page being moved is dirty and has not been saved by the latest
  49842. ** savepoint, then save the current contents of the page into the
  49843. ** sub-journal now. This is required to handle the following scenario:
  49844. **
  49845. ** BEGIN;
  49846. ** <journal page X, then modify it in memory>
  49847. ** SAVEPOINT one;
  49848. ** <Move page X to location Y>
  49849. ** ROLLBACK TO one;
  49850. **
  49851. ** If page X were not written to the sub-journal here, it would not
  49852. ** be possible to restore its contents when the "ROLLBACK TO one"
  49853. ** statement were is processed.
  49854. **
  49855. ** subjournalPage() may need to allocate space to store pPg->pgno into
  49856. ** one or more savepoint bitvecs. This is the reason this function
  49857. ** may return SQLITE_NOMEM.
  49858. */
  49859. if( (pPg->flags & PGHDR_DIRTY)!=0
  49860. && SQLITE_OK!=(rc = subjournalPageIfRequired(pPg))
  49861. ){
  49862. return rc;
  49863. }
  49864. PAGERTRACE(("MOVE %d page %d (needSync=%d) moves to %d\n",
  49865. PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno));
  49866. IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
  49867. /* If the journal needs to be sync()ed before page pPg->pgno can
  49868. ** be written to, store pPg->pgno in local variable needSyncPgno.
  49869. **
  49870. ** If the isCommit flag is set, there is no need to remember that
  49871. ** the journal needs to be sync()ed before database page pPg->pgno
  49872. ** can be written to. The caller has already promised not to write to it.
  49873. */
  49874. if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
  49875. needSyncPgno = pPg->pgno;
  49876. assert( pPager->journalMode==PAGER_JOURNALMODE_OFF ||
  49877. pageInJournal(pPager, pPg) || pPg->pgno>pPager->dbOrigSize );
  49878. assert( pPg->flags&PGHDR_DIRTY );
  49879. }
  49880. /* If the cache contains a page with page-number pgno, remove it
  49881. ** from its hash chain. Also, if the PGHDR_NEED_SYNC flag was set for
  49882. ** page pgno before the 'move' operation, it needs to be retained
  49883. ** for the page moved there.
  49884. */
  49885. pPg->flags &= ~PGHDR_NEED_SYNC;
  49886. pPgOld = sqlite3PagerLookup(pPager, pgno);
  49887. assert( !pPgOld || pPgOld->nRef==1 );
  49888. if( pPgOld ){
  49889. pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
  49890. if( pPager->tempFile ){
  49891. /* Do not discard pages from an in-memory database since we might
  49892. ** need to rollback later. Just move the page out of the way. */
  49893. sqlite3PcacheMove(pPgOld, pPager->dbSize+1);
  49894. }else{
  49895. sqlite3PcacheDrop(pPgOld);
  49896. }
  49897. }
  49898. origPgno = pPg->pgno;
  49899. sqlite3PcacheMove(pPg, pgno);
  49900. sqlite3PcacheMakeDirty(pPg);
  49901. /* For an in-memory database, make sure the original page continues
  49902. ** to exist, in case the transaction needs to roll back. Use pPgOld
  49903. ** as the original page since it has already been allocated.
  49904. */
  49905. if( pPager->tempFile && pPgOld ){
  49906. sqlite3PcacheMove(pPgOld, origPgno);
  49907. sqlite3PagerUnrefNotNull(pPgOld);
  49908. }
  49909. if( needSyncPgno ){
  49910. /* If needSyncPgno is non-zero, then the journal file needs to be
  49911. ** sync()ed before any data is written to database file page needSyncPgno.
  49912. ** Currently, no such page exists in the page-cache and the
  49913. ** "is journaled" bitvec flag has been set. This needs to be remedied by
  49914. ** loading the page into the pager-cache and setting the PGHDR_NEED_SYNC
  49915. ** flag.
  49916. **
  49917. ** If the attempt to load the page into the page-cache fails, (due
  49918. ** to a malloc() or IO failure), clear the bit in the pInJournal[]
  49919. ** array. Otherwise, if the page is loaded and written again in
  49920. ** this transaction, it may be written to the database file before
  49921. ** it is synced into the journal file. This way, it may end up in
  49922. ** the journal file twice, but that is not a problem.
  49923. */
  49924. PgHdr *pPgHdr;
  49925. rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr, 0);
  49926. if( rc!=SQLITE_OK ){
  49927. if( needSyncPgno<=pPager->dbOrigSize ){
  49928. assert( pPager->pTmpSpace!=0 );
  49929. sqlite3BitvecClear(pPager->pInJournal, needSyncPgno, pPager->pTmpSpace);
  49930. }
  49931. return rc;
  49932. }
  49933. pPgHdr->flags |= PGHDR_NEED_SYNC;
  49934. sqlite3PcacheMakeDirty(pPgHdr);
  49935. sqlite3PagerUnrefNotNull(pPgHdr);
  49936. }
  49937. return SQLITE_OK;
  49938. }
  49939. #endif
  49940. /*
  49941. ** The page handle passed as the first argument refers to a dirty page
  49942. ** with a page number other than iNew. This function changes the page's
  49943. ** page number to iNew and sets the value of the PgHdr.flags field to
  49944. ** the value passed as the third parameter.
  49945. */
  49946. SQLITE_PRIVATE void sqlite3PagerRekey(DbPage *pPg, Pgno iNew, u16 flags){
  49947. assert( pPg->pgno!=iNew );
  49948. pPg->flags = flags;
  49949. sqlite3PcacheMove(pPg, iNew);
  49950. }
  49951. /*
  49952. ** Return a pointer to the data for the specified page.
  49953. */
  49954. SQLITE_PRIVATE void *sqlite3PagerGetData(DbPage *pPg){
  49955. assert( pPg->nRef>0 || pPg->pPager->memDb );
  49956. return pPg->pData;
  49957. }
  49958. /*
  49959. ** Return a pointer to the Pager.nExtra bytes of "extra" space
  49960. ** allocated along with the specified page.
  49961. */
  49962. SQLITE_PRIVATE void *sqlite3PagerGetExtra(DbPage *pPg){
  49963. return pPg->pExtra;
  49964. }
  49965. /*
  49966. ** Get/set the locking-mode for this pager. Parameter eMode must be one
  49967. ** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
  49968. ** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
  49969. ** the locking-mode is set to the value specified.
  49970. **
  49971. ** The returned value is either PAGER_LOCKINGMODE_NORMAL or
  49972. ** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
  49973. ** locking-mode.
  49974. */
  49975. SQLITE_PRIVATE int sqlite3PagerLockingMode(Pager *pPager, int eMode){
  49976. assert( eMode==PAGER_LOCKINGMODE_QUERY
  49977. || eMode==PAGER_LOCKINGMODE_NORMAL
  49978. || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
  49979. assert( PAGER_LOCKINGMODE_QUERY<0 );
  49980. assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
  49981. assert( pPager->exclusiveMode || 0==sqlite3WalHeapMemory(pPager->pWal) );
  49982. if( eMode>=0 && !pPager->tempFile && !sqlite3WalHeapMemory(pPager->pWal) ){
  49983. pPager->exclusiveMode = (u8)eMode;
  49984. }
  49985. return (int)pPager->exclusiveMode;
  49986. }
  49987. /*
  49988. ** Set the journal-mode for this pager. Parameter eMode must be one of:
  49989. **
  49990. ** PAGER_JOURNALMODE_DELETE
  49991. ** PAGER_JOURNALMODE_TRUNCATE
  49992. ** PAGER_JOURNALMODE_PERSIST
  49993. ** PAGER_JOURNALMODE_OFF
  49994. ** PAGER_JOURNALMODE_MEMORY
  49995. ** PAGER_JOURNALMODE_WAL
  49996. **
  49997. ** The journalmode is set to the value specified if the change is allowed.
  49998. ** The change may be disallowed for the following reasons:
  49999. **
  50000. ** * An in-memory database can only have its journal_mode set to _OFF
  50001. ** or _MEMORY.
  50002. **
  50003. ** * Temporary databases cannot have _WAL journalmode.
  50004. **
  50005. ** The returned indicate the current (possibly updated) journal-mode.
  50006. */
  50007. SQLITE_PRIVATE int sqlite3PagerSetJournalMode(Pager *pPager, int eMode){
  50008. u8 eOld = pPager->journalMode; /* Prior journalmode */
  50009. #ifdef SQLITE_DEBUG
  50010. /* The print_pager_state() routine is intended to be used by the debugger
  50011. ** only. We invoke it once here to suppress a compiler warning. */
  50012. print_pager_state(pPager);
  50013. #endif
  50014. /* The eMode parameter is always valid */
  50015. assert( eMode==PAGER_JOURNALMODE_DELETE
  50016. || eMode==PAGER_JOURNALMODE_TRUNCATE
  50017. || eMode==PAGER_JOURNALMODE_PERSIST
  50018. || eMode==PAGER_JOURNALMODE_OFF
  50019. || eMode==PAGER_JOURNALMODE_WAL
  50020. || eMode==PAGER_JOURNALMODE_MEMORY );
  50021. /* This routine is only called from the OP_JournalMode opcode, and
  50022. ** the logic there will never allow a temporary file to be changed
  50023. ** to WAL mode.
  50024. */
  50025. assert( pPager->tempFile==0 || eMode!=PAGER_JOURNALMODE_WAL );
  50026. /* Do allow the journalmode of an in-memory database to be set to
  50027. ** anything other than MEMORY or OFF
  50028. */
  50029. if( MEMDB ){
  50030. assert( eOld==PAGER_JOURNALMODE_MEMORY || eOld==PAGER_JOURNALMODE_OFF );
  50031. if( eMode!=PAGER_JOURNALMODE_MEMORY && eMode!=PAGER_JOURNALMODE_OFF ){
  50032. eMode = eOld;
  50033. }
  50034. }
  50035. if( eMode!=eOld ){
  50036. /* Change the journal mode. */
  50037. assert( pPager->eState!=PAGER_ERROR );
  50038. pPager->journalMode = (u8)eMode;
  50039. /* When transistioning from TRUNCATE or PERSIST to any other journal
  50040. ** mode except WAL, unless the pager is in locking_mode=exclusive mode,
  50041. ** delete the journal file.
  50042. */
  50043. assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
  50044. assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
  50045. assert( (PAGER_JOURNALMODE_DELETE & 5)==0 );
  50046. assert( (PAGER_JOURNALMODE_MEMORY & 5)==4 );
  50047. assert( (PAGER_JOURNALMODE_OFF & 5)==0 );
  50048. assert( (PAGER_JOURNALMODE_WAL & 5)==5 );
  50049. assert( isOpen(pPager->fd) || pPager->exclusiveMode );
  50050. if( !pPager->exclusiveMode && (eOld & 5)==1 && (eMode & 1)==0 ){
  50051. /* In this case we would like to delete the journal file. If it is
  50052. ** not possible, then that is not a problem. Deleting the journal file
  50053. ** here is an optimization only.
  50054. **
  50055. ** Before deleting the journal file, obtain a RESERVED lock on the
  50056. ** database file. This ensures that the journal file is not deleted
  50057. ** while it is in use by some other client.
  50058. */
  50059. sqlite3OsClose(pPager->jfd);
  50060. if( pPager->eLock>=RESERVED_LOCK ){
  50061. sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
  50062. }else{
  50063. int rc = SQLITE_OK;
  50064. int state = pPager->eState;
  50065. assert( state==PAGER_OPEN || state==PAGER_READER );
  50066. if( state==PAGER_OPEN ){
  50067. rc = sqlite3PagerSharedLock(pPager);
  50068. }
  50069. if( pPager->eState==PAGER_READER ){
  50070. assert( rc==SQLITE_OK );
  50071. rc = pagerLockDb(pPager, RESERVED_LOCK);
  50072. }
  50073. if( rc==SQLITE_OK ){
  50074. sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
  50075. }
  50076. if( rc==SQLITE_OK && state==PAGER_READER ){
  50077. pagerUnlockDb(pPager, SHARED_LOCK);
  50078. }else if( state==PAGER_OPEN ){
  50079. pager_unlock(pPager);
  50080. }
  50081. assert( state==pPager->eState );
  50082. }
  50083. }else if( eMode==PAGER_JOURNALMODE_OFF ){
  50084. sqlite3OsClose(pPager->jfd);
  50085. }
  50086. }
  50087. /* Return the new journal mode */
  50088. return (int)pPager->journalMode;
  50089. }
  50090. /*
  50091. ** Return the current journal mode.
  50092. */
  50093. SQLITE_PRIVATE int sqlite3PagerGetJournalMode(Pager *pPager){
  50094. return (int)pPager->journalMode;
  50095. }
  50096. /*
  50097. ** Return TRUE if the pager is in a state where it is OK to change the
  50098. ** journalmode. Journalmode changes can only happen when the database
  50099. ** is unmodified.
  50100. */
  50101. SQLITE_PRIVATE int sqlite3PagerOkToChangeJournalMode(Pager *pPager){
  50102. assert( assert_pager_state(pPager) );
  50103. if( pPager->eState>=PAGER_WRITER_CACHEMOD ) return 0;
  50104. if( NEVER(isOpen(pPager->jfd) && pPager->journalOff>0) ) return 0;
  50105. return 1;
  50106. }
  50107. /*
  50108. ** Get/set the size-limit used for persistent journal files.
  50109. **
  50110. ** Setting the size limit to -1 means no limit is enforced.
  50111. ** An attempt to set a limit smaller than -1 is a no-op.
  50112. */
  50113. SQLITE_PRIVATE i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
  50114. if( iLimit>=-1 ){
  50115. pPager->journalSizeLimit = iLimit;
  50116. sqlite3WalLimit(pPager->pWal, iLimit);
  50117. }
  50118. return pPager->journalSizeLimit;
  50119. }
  50120. /*
  50121. ** Return a pointer to the pPager->pBackup variable. The backup module
  50122. ** in backup.c maintains the content of this variable. This module
  50123. ** uses it opaquely as an argument to sqlite3BackupRestart() and
  50124. ** sqlite3BackupUpdate() only.
  50125. */
  50126. SQLITE_PRIVATE sqlite3_backup **sqlite3PagerBackupPtr(Pager *pPager){
  50127. return &pPager->pBackup;
  50128. }
  50129. #ifndef SQLITE_OMIT_VACUUM
  50130. /*
  50131. ** Unless this is an in-memory or temporary database, clear the pager cache.
  50132. */
  50133. SQLITE_PRIVATE void sqlite3PagerClearCache(Pager *pPager){
  50134. assert( MEMDB==0 || pPager->tempFile );
  50135. if( pPager->tempFile==0 ) pager_reset(pPager);
  50136. }
  50137. #endif
  50138. #ifndef SQLITE_OMIT_WAL
  50139. /*
  50140. ** This function is called when the user invokes "PRAGMA wal_checkpoint",
  50141. ** "PRAGMA wal_blocking_checkpoint" or calls the sqlite3_wal_checkpoint()
  50142. ** or wal_blocking_checkpoint() API functions.
  50143. **
  50144. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
  50145. */
  50146. SQLITE_PRIVATE int sqlite3PagerCheckpoint(Pager *pPager, int eMode, int *pnLog, int *pnCkpt){
  50147. int rc = SQLITE_OK;
  50148. if( pPager->pWal ){
  50149. rc = sqlite3WalCheckpoint(pPager->pWal, eMode,
  50150. (eMode==SQLITE_CHECKPOINT_PASSIVE ? 0 : pPager->xBusyHandler),
  50151. pPager->pBusyHandlerArg,
  50152. pPager->ckptSyncFlags, pPager->pageSize, (u8 *)pPager->pTmpSpace,
  50153. pnLog, pnCkpt
  50154. );
  50155. }
  50156. return rc;
  50157. }
  50158. SQLITE_PRIVATE int sqlite3PagerWalCallback(Pager *pPager){
  50159. return sqlite3WalCallback(pPager->pWal);
  50160. }
  50161. /*
  50162. ** Return true if the underlying VFS for the given pager supports the
  50163. ** primitives necessary for write-ahead logging.
  50164. */
  50165. SQLITE_PRIVATE int sqlite3PagerWalSupported(Pager *pPager){
  50166. const sqlite3_io_methods *pMethods = pPager->fd->pMethods;
  50167. if( pPager->noLock ) return 0;
  50168. return pPager->exclusiveMode || (pMethods->iVersion>=2 && pMethods->xShmMap);
  50169. }
  50170. /*
  50171. ** Attempt to take an exclusive lock on the database file. If a PENDING lock
  50172. ** is obtained instead, immediately release it.
  50173. */
  50174. static int pagerExclusiveLock(Pager *pPager){
  50175. int rc; /* Return code */
  50176. assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
  50177. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  50178. if( rc!=SQLITE_OK ){
  50179. /* If the attempt to grab the exclusive lock failed, release the
  50180. ** pending lock that may have been obtained instead. */
  50181. pagerUnlockDb(pPager, SHARED_LOCK);
  50182. }
  50183. return rc;
  50184. }
  50185. /*
  50186. ** Call sqlite3WalOpen() to open the WAL handle. If the pager is in
  50187. ** exclusive-locking mode when this function is called, take an EXCLUSIVE
  50188. ** lock on the database file and use heap-memory to store the wal-index
  50189. ** in. Otherwise, use the normal shared-memory.
  50190. */
  50191. static int pagerOpenWal(Pager *pPager){
  50192. int rc = SQLITE_OK;
  50193. assert( pPager->pWal==0 && pPager->tempFile==0 );
  50194. assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
  50195. /* If the pager is already in exclusive-mode, the WAL module will use
  50196. ** heap-memory for the wal-index instead of the VFS shared-memory
  50197. ** implementation. Take the exclusive lock now, before opening the WAL
  50198. ** file, to make sure this is safe.
  50199. */
  50200. if( pPager->exclusiveMode ){
  50201. rc = pagerExclusiveLock(pPager);
  50202. }
  50203. /* Open the connection to the log file. If this operation fails,
  50204. ** (e.g. due to malloc() failure), return an error code.
  50205. */
  50206. if( rc==SQLITE_OK ){
  50207. rc = sqlite3WalOpen(pPager->pVfs,
  50208. pPager->fd, pPager->zWal, pPager->exclusiveMode,
  50209. pPager->journalSizeLimit, &pPager->pWal
  50210. );
  50211. }
  50212. pagerFixMaplimit(pPager);
  50213. return rc;
  50214. }
  50215. /*
  50216. ** The caller must be holding a SHARED lock on the database file to call
  50217. ** this function.
  50218. **
  50219. ** If the pager passed as the first argument is open on a real database
  50220. ** file (not a temp file or an in-memory database), and the WAL file
  50221. ** is not already open, make an attempt to open it now. If successful,
  50222. ** return SQLITE_OK. If an error occurs or the VFS used by the pager does
  50223. ** not support the xShmXXX() methods, return an error code. *pbOpen is
  50224. ** not modified in either case.
  50225. **
  50226. ** If the pager is open on a temp-file (or in-memory database), or if
  50227. ** the WAL file is already open, set *pbOpen to 1 and return SQLITE_OK
  50228. ** without doing anything.
  50229. */
  50230. SQLITE_PRIVATE int sqlite3PagerOpenWal(
  50231. Pager *pPager, /* Pager object */
  50232. int *pbOpen /* OUT: Set to true if call is a no-op */
  50233. ){
  50234. int rc = SQLITE_OK; /* Return code */
  50235. assert( assert_pager_state(pPager) );
  50236. assert( pPager->eState==PAGER_OPEN || pbOpen );
  50237. assert( pPager->eState==PAGER_READER || !pbOpen );
  50238. assert( pbOpen==0 || *pbOpen==0 );
  50239. assert( pbOpen!=0 || (!pPager->tempFile && !pPager->pWal) );
  50240. if( !pPager->tempFile && !pPager->pWal ){
  50241. if( !sqlite3PagerWalSupported(pPager) ) return SQLITE_CANTOPEN;
  50242. /* Close any rollback journal previously open */
  50243. sqlite3OsClose(pPager->jfd);
  50244. rc = pagerOpenWal(pPager);
  50245. if( rc==SQLITE_OK ){
  50246. pPager->journalMode = PAGER_JOURNALMODE_WAL;
  50247. pPager->eState = PAGER_OPEN;
  50248. }
  50249. }else{
  50250. *pbOpen = 1;
  50251. }
  50252. return rc;
  50253. }
  50254. /*
  50255. ** This function is called to close the connection to the log file prior
  50256. ** to switching from WAL to rollback mode.
  50257. **
  50258. ** Before closing the log file, this function attempts to take an
  50259. ** EXCLUSIVE lock on the database file. If this cannot be obtained, an
  50260. ** error (SQLITE_BUSY) is returned and the log connection is not closed.
  50261. ** If successful, the EXCLUSIVE lock is not released before returning.
  50262. */
  50263. SQLITE_PRIVATE int sqlite3PagerCloseWal(Pager *pPager){
  50264. int rc = SQLITE_OK;
  50265. assert( pPager->journalMode==PAGER_JOURNALMODE_WAL );
  50266. /* If the log file is not already open, but does exist in the file-system,
  50267. ** it may need to be checkpointed before the connection can switch to
  50268. ** rollback mode. Open it now so this can happen.
  50269. */
  50270. if( !pPager->pWal ){
  50271. int logexists = 0;
  50272. rc = pagerLockDb(pPager, SHARED_LOCK);
  50273. if( rc==SQLITE_OK ){
  50274. rc = sqlite3OsAccess(
  50275. pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &logexists
  50276. );
  50277. }
  50278. if( rc==SQLITE_OK && logexists ){
  50279. rc = pagerOpenWal(pPager);
  50280. }
  50281. }
  50282. /* Checkpoint and close the log. Because an EXCLUSIVE lock is held on
  50283. ** the database file, the log and log-summary files will be deleted.
  50284. */
  50285. if( rc==SQLITE_OK && pPager->pWal ){
  50286. rc = pagerExclusiveLock(pPager);
  50287. if( rc==SQLITE_OK ){
  50288. rc = sqlite3WalClose(pPager->pWal, pPager->ckptSyncFlags,
  50289. pPager->pageSize, (u8*)pPager->pTmpSpace);
  50290. pPager->pWal = 0;
  50291. pagerFixMaplimit(pPager);
  50292. if( rc && !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
  50293. }
  50294. }
  50295. return rc;
  50296. }
  50297. #ifdef SQLITE_ENABLE_SNAPSHOT
  50298. /*
  50299. ** If this is a WAL database, obtain a snapshot handle for the snapshot
  50300. ** currently open. Otherwise, return an error.
  50301. */
  50302. SQLITE_PRIVATE int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot){
  50303. int rc = SQLITE_ERROR;
  50304. if( pPager->pWal ){
  50305. rc = sqlite3WalSnapshotGet(pPager->pWal, ppSnapshot);
  50306. }
  50307. return rc;
  50308. }
  50309. /*
  50310. ** If this is a WAL database, store a pointer to pSnapshot. Next time a
  50311. ** read transaction is opened, attempt to read from the snapshot it
  50312. ** identifies. If this is not a WAL database, return an error.
  50313. */
  50314. SQLITE_PRIVATE int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot){
  50315. int rc = SQLITE_OK;
  50316. if( pPager->pWal ){
  50317. sqlite3WalSnapshotOpen(pPager->pWal, pSnapshot);
  50318. }else{
  50319. rc = SQLITE_ERROR;
  50320. }
  50321. return rc;
  50322. }
  50323. #endif /* SQLITE_ENABLE_SNAPSHOT */
  50324. #endif /* !SQLITE_OMIT_WAL */
  50325. #ifdef SQLITE_ENABLE_ZIPVFS
  50326. /*
  50327. ** A read-lock must be held on the pager when this function is called. If
  50328. ** the pager is in WAL mode and the WAL file currently contains one or more
  50329. ** frames, return the size in bytes of the page images stored within the
  50330. ** WAL frames. Otherwise, if this is not a WAL database or the WAL file
  50331. ** is empty, return 0.
  50332. */
  50333. SQLITE_PRIVATE int sqlite3PagerWalFramesize(Pager *pPager){
  50334. assert( pPager->eState>=PAGER_READER );
  50335. return sqlite3WalFramesize(pPager->pWal);
  50336. }
  50337. #endif
  50338. #endif /* SQLITE_OMIT_DISKIO */
  50339. /************** End of pager.c ***********************************************/
  50340. /************** Begin file wal.c *********************************************/
  50341. /*
  50342. ** 2010 February 1
  50343. **
  50344. ** The author disclaims copyright to this source code. In place of
  50345. ** a legal notice, here is a blessing:
  50346. **
  50347. ** May you do good and not evil.
  50348. ** May you find forgiveness for yourself and forgive others.
  50349. ** May you share freely, never taking more than you give.
  50350. **
  50351. *************************************************************************
  50352. **
  50353. ** This file contains the implementation of a write-ahead log (WAL) used in
  50354. ** "journal_mode=WAL" mode.
  50355. **
  50356. ** WRITE-AHEAD LOG (WAL) FILE FORMAT
  50357. **
  50358. ** A WAL file consists of a header followed by zero or more "frames".
  50359. ** Each frame records the revised content of a single page from the
  50360. ** database file. All changes to the database are recorded by writing
  50361. ** frames into the WAL. Transactions commit when a frame is written that
  50362. ** contains a commit marker. A single WAL can and usually does record
  50363. ** multiple transactions. Periodically, the content of the WAL is
  50364. ** transferred back into the database file in an operation called a
  50365. ** "checkpoint".
  50366. **
  50367. ** A single WAL file can be used multiple times. In other words, the
  50368. ** WAL can fill up with frames and then be checkpointed and then new
  50369. ** frames can overwrite the old ones. A WAL always grows from beginning
  50370. ** toward the end. Checksums and counters attached to each frame are
  50371. ** used to determine which frames within the WAL are valid and which
  50372. ** are leftovers from prior checkpoints.
  50373. **
  50374. ** The WAL header is 32 bytes in size and consists of the following eight
  50375. ** big-endian 32-bit unsigned integer values:
  50376. **
  50377. ** 0: Magic number. 0x377f0682 or 0x377f0683
  50378. ** 4: File format version. Currently 3007000
  50379. ** 8: Database page size. Example: 1024
  50380. ** 12: Checkpoint sequence number
  50381. ** 16: Salt-1, random integer incremented with each checkpoint
  50382. ** 20: Salt-2, a different random integer changing with each ckpt
  50383. ** 24: Checksum-1 (first part of checksum for first 24 bytes of header).
  50384. ** 28: Checksum-2 (second part of checksum for first 24 bytes of header).
  50385. **
  50386. ** Immediately following the wal-header are zero or more frames. Each
  50387. ** frame consists of a 24-byte frame-header followed by a <page-size> bytes
  50388. ** of page data. The frame-header is six big-endian 32-bit unsigned
  50389. ** integer values, as follows:
  50390. **
  50391. ** 0: Page number.
  50392. ** 4: For commit records, the size of the database image in pages
  50393. ** after the commit. For all other records, zero.
  50394. ** 8: Salt-1 (copied from the header)
  50395. ** 12: Salt-2 (copied from the header)
  50396. ** 16: Checksum-1.
  50397. ** 20: Checksum-2.
  50398. **
  50399. ** A frame is considered valid if and only if the following conditions are
  50400. ** true:
  50401. **
  50402. ** (1) The salt-1 and salt-2 values in the frame-header match
  50403. ** salt values in the wal-header
  50404. **
  50405. ** (2) The checksum values in the final 8 bytes of the frame-header
  50406. ** exactly match the checksum computed consecutively on the
  50407. ** WAL header and the first 8 bytes and the content of all frames
  50408. ** up to and including the current frame.
  50409. **
  50410. ** The checksum is computed using 32-bit big-endian integers if the
  50411. ** magic number in the first 4 bytes of the WAL is 0x377f0683 and it
  50412. ** is computed using little-endian if the magic number is 0x377f0682.
  50413. ** The checksum values are always stored in the frame header in a
  50414. ** big-endian format regardless of which byte order is used to compute
  50415. ** the checksum. The checksum is computed by interpreting the input as
  50416. ** an even number of unsigned 32-bit integers: x[0] through x[N]. The
  50417. ** algorithm used for the checksum is as follows:
  50418. **
  50419. ** for i from 0 to n-1 step 2:
  50420. ** s0 += x[i] + s1;
  50421. ** s1 += x[i+1] + s0;
  50422. ** endfor
  50423. **
  50424. ** Note that s0 and s1 are both weighted checksums using fibonacci weights
  50425. ** in reverse order (the largest fibonacci weight occurs on the first element
  50426. ** of the sequence being summed.) The s1 value spans all 32-bit
  50427. ** terms of the sequence whereas s0 omits the final term.
  50428. **
  50429. ** On a checkpoint, the WAL is first VFS.xSync-ed, then valid content of the
  50430. ** WAL is transferred into the database, then the database is VFS.xSync-ed.
  50431. ** The VFS.xSync operations serve as write barriers - all writes launched
  50432. ** before the xSync must complete before any write that launches after the
  50433. ** xSync begins.
  50434. **
  50435. ** After each checkpoint, the salt-1 value is incremented and the salt-2
  50436. ** value is randomized. This prevents old and new frames in the WAL from
  50437. ** being considered valid at the same time and being checkpointing together
  50438. ** following a crash.
  50439. **
  50440. ** READER ALGORITHM
  50441. **
  50442. ** To read a page from the database (call it page number P), a reader
  50443. ** first checks the WAL to see if it contains page P. If so, then the
  50444. ** last valid instance of page P that is a followed by a commit frame
  50445. ** or is a commit frame itself becomes the value read. If the WAL
  50446. ** contains no copies of page P that are valid and which are a commit
  50447. ** frame or are followed by a commit frame, then page P is read from
  50448. ** the database file.
  50449. **
  50450. ** To start a read transaction, the reader records the index of the last
  50451. ** valid frame in the WAL. The reader uses this recorded "mxFrame" value
  50452. ** for all subsequent read operations. New transactions can be appended
  50453. ** to the WAL, but as long as the reader uses its original mxFrame value
  50454. ** and ignores the newly appended content, it will see a consistent snapshot
  50455. ** of the database from a single point in time. This technique allows
  50456. ** multiple concurrent readers to view different versions of the database
  50457. ** content simultaneously.
  50458. **
  50459. ** The reader algorithm in the previous paragraphs works correctly, but
  50460. ** because frames for page P can appear anywhere within the WAL, the
  50461. ** reader has to scan the entire WAL looking for page P frames. If the
  50462. ** WAL is large (multiple megabytes is typical) that scan can be slow,
  50463. ** and read performance suffers. To overcome this problem, a separate
  50464. ** data structure called the wal-index is maintained to expedite the
  50465. ** search for frames of a particular page.
  50466. **
  50467. ** WAL-INDEX FORMAT
  50468. **
  50469. ** Conceptually, the wal-index is shared memory, though VFS implementations
  50470. ** might choose to implement the wal-index using a mmapped file. Because
  50471. ** the wal-index is shared memory, SQLite does not support journal_mode=WAL
  50472. ** on a network filesystem. All users of the database must be able to
  50473. ** share memory.
  50474. **
  50475. ** The wal-index is transient. After a crash, the wal-index can (and should
  50476. ** be) reconstructed from the original WAL file. In fact, the VFS is required
  50477. ** to either truncate or zero the header of the wal-index when the last
  50478. ** connection to it closes. Because the wal-index is transient, it can
  50479. ** use an architecture-specific format; it does not have to be cross-platform.
  50480. ** Hence, unlike the database and WAL file formats which store all values
  50481. ** as big endian, the wal-index can store multi-byte values in the native
  50482. ** byte order of the host computer.
  50483. **
  50484. ** The purpose of the wal-index is to answer this question quickly: Given
  50485. ** a page number P and a maximum frame index M, return the index of the
  50486. ** last frame in the wal before frame M for page P in the WAL, or return
  50487. ** NULL if there are no frames for page P in the WAL prior to M.
  50488. **
  50489. ** The wal-index consists of a header region, followed by an one or
  50490. ** more index blocks.
  50491. **
  50492. ** The wal-index header contains the total number of frames within the WAL
  50493. ** in the mxFrame field.
  50494. **
  50495. ** Each index block except for the first contains information on
  50496. ** HASHTABLE_NPAGE frames. The first index block contains information on
  50497. ** HASHTABLE_NPAGE_ONE frames. The values of HASHTABLE_NPAGE_ONE and
  50498. ** HASHTABLE_NPAGE are selected so that together the wal-index header and
  50499. ** first index block are the same size as all other index blocks in the
  50500. ** wal-index.
  50501. **
  50502. ** Each index block contains two sections, a page-mapping that contains the
  50503. ** database page number associated with each wal frame, and a hash-table
  50504. ** that allows readers to query an index block for a specific page number.
  50505. ** The page-mapping is an array of HASHTABLE_NPAGE (or HASHTABLE_NPAGE_ONE
  50506. ** for the first index block) 32-bit page numbers. The first entry in the
  50507. ** first index-block contains the database page number corresponding to the
  50508. ** first frame in the WAL file. The first entry in the second index block
  50509. ** in the WAL file corresponds to the (HASHTABLE_NPAGE_ONE+1)th frame in
  50510. ** the log, and so on.
  50511. **
  50512. ** The last index block in a wal-index usually contains less than the full
  50513. ** complement of HASHTABLE_NPAGE (or HASHTABLE_NPAGE_ONE) page-numbers,
  50514. ** depending on the contents of the WAL file. This does not change the
  50515. ** allocated size of the page-mapping array - the page-mapping array merely
  50516. ** contains unused entries.
  50517. **
  50518. ** Even without using the hash table, the last frame for page P
  50519. ** can be found by scanning the page-mapping sections of each index block
  50520. ** starting with the last index block and moving toward the first, and
  50521. ** within each index block, starting at the end and moving toward the
  50522. ** beginning. The first entry that equals P corresponds to the frame
  50523. ** holding the content for that page.
  50524. **
  50525. ** The hash table consists of HASHTABLE_NSLOT 16-bit unsigned integers.
  50526. ** HASHTABLE_NSLOT = 2*HASHTABLE_NPAGE, and there is one entry in the
  50527. ** hash table for each page number in the mapping section, so the hash
  50528. ** table is never more than half full. The expected number of collisions
  50529. ** prior to finding a match is 1. Each entry of the hash table is an
  50530. ** 1-based index of an entry in the mapping section of the same
  50531. ** index block. Let K be the 1-based index of the largest entry in
  50532. ** the mapping section. (For index blocks other than the last, K will
  50533. ** always be exactly HASHTABLE_NPAGE (4096) and for the last index block
  50534. ** K will be (mxFrame%HASHTABLE_NPAGE).) Unused slots of the hash table
  50535. ** contain a value of 0.
  50536. **
  50537. ** To look for page P in the hash table, first compute a hash iKey on
  50538. ** P as follows:
  50539. **
  50540. ** iKey = (P * 383) % HASHTABLE_NSLOT
  50541. **
  50542. ** Then start scanning entries of the hash table, starting with iKey
  50543. ** (wrapping around to the beginning when the end of the hash table is
  50544. ** reached) until an unused hash slot is found. Let the first unused slot
  50545. ** be at index iUnused. (iUnused might be less than iKey if there was
  50546. ** wrap-around.) Because the hash table is never more than half full,
  50547. ** the search is guaranteed to eventually hit an unused entry. Let
  50548. ** iMax be the value between iKey and iUnused, closest to iUnused,
  50549. ** where aHash[iMax]==P. If there is no iMax entry (if there exists
  50550. ** no hash slot such that aHash[i]==p) then page P is not in the
  50551. ** current index block. Otherwise the iMax-th mapping entry of the
  50552. ** current index block corresponds to the last entry that references
  50553. ** page P.
  50554. **
  50555. ** A hash search begins with the last index block and moves toward the
  50556. ** first index block, looking for entries corresponding to page P. On
  50557. ** average, only two or three slots in each index block need to be
  50558. ** examined in order to either find the last entry for page P, or to
  50559. ** establish that no such entry exists in the block. Each index block
  50560. ** holds over 4000 entries. So two or three index blocks are sufficient
  50561. ** to cover a typical 10 megabyte WAL file, assuming 1K pages. 8 or 10
  50562. ** comparisons (on average) suffice to either locate a frame in the
  50563. ** WAL or to establish that the frame does not exist in the WAL. This
  50564. ** is much faster than scanning the entire 10MB WAL.
  50565. **
  50566. ** Note that entries are added in order of increasing K. Hence, one
  50567. ** reader might be using some value K0 and a second reader that started
  50568. ** at a later time (after additional transactions were added to the WAL
  50569. ** and to the wal-index) might be using a different value K1, where K1>K0.
  50570. ** Both readers can use the same hash table and mapping section to get
  50571. ** the correct result. There may be entries in the hash table with
  50572. ** K>K0 but to the first reader, those entries will appear to be unused
  50573. ** slots in the hash table and so the first reader will get an answer as
  50574. ** if no values greater than K0 had ever been inserted into the hash table
  50575. ** in the first place - which is what reader one wants. Meanwhile, the
  50576. ** second reader using K1 will see additional values that were inserted
  50577. ** later, which is exactly what reader two wants.
  50578. **
  50579. ** When a rollback occurs, the value of K is decreased. Hash table entries
  50580. ** that correspond to frames greater than the new K value are removed
  50581. ** from the hash table at this point.
  50582. */
  50583. #ifndef SQLITE_OMIT_WAL
  50584. /* #include "wal.h" */
  50585. /*
  50586. ** Trace output macros
  50587. */
  50588. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  50589. SQLITE_PRIVATE int sqlite3WalTrace = 0;
  50590. # define WALTRACE(X) if(sqlite3WalTrace) sqlite3DebugPrintf X
  50591. #else
  50592. # define WALTRACE(X)
  50593. #endif
  50594. /*
  50595. ** The maximum (and only) versions of the wal and wal-index formats
  50596. ** that may be interpreted by this version of SQLite.
  50597. **
  50598. ** If a client begins recovering a WAL file and finds that (a) the checksum
  50599. ** values in the wal-header are correct and (b) the version field is not
  50600. ** WAL_MAX_VERSION, recovery fails and SQLite returns SQLITE_CANTOPEN.
  50601. **
  50602. ** Similarly, if a client successfully reads a wal-index header (i.e. the
  50603. ** checksum test is successful) and finds that the version field is not
  50604. ** WALINDEX_MAX_VERSION, then no read-transaction is opened and SQLite
  50605. ** returns SQLITE_CANTOPEN.
  50606. */
  50607. #define WAL_MAX_VERSION 3007000
  50608. #define WALINDEX_MAX_VERSION 3007000
  50609. /*
  50610. ** Indices of various locking bytes. WAL_NREADER is the number
  50611. ** of available reader locks and should be at least 3. The default
  50612. ** is SQLITE_SHM_NLOCK==8 and WAL_NREADER==5.
  50613. */
  50614. #define WAL_WRITE_LOCK 0
  50615. #define WAL_ALL_BUT_WRITE 1
  50616. #define WAL_CKPT_LOCK 1
  50617. #define WAL_RECOVER_LOCK 2
  50618. #define WAL_READ_LOCK(I) (3+(I))
  50619. #define WAL_NREADER (SQLITE_SHM_NLOCK-3)
  50620. /* Object declarations */
  50621. typedef struct WalIndexHdr WalIndexHdr;
  50622. typedef struct WalIterator WalIterator;
  50623. typedef struct WalCkptInfo WalCkptInfo;
  50624. /*
  50625. ** The following object holds a copy of the wal-index header content.
  50626. **
  50627. ** The actual header in the wal-index consists of two copies of this
  50628. ** object followed by one instance of the WalCkptInfo object.
  50629. ** For all versions of SQLite through 3.10.0 and probably beyond,
  50630. ** the locking bytes (WalCkptInfo.aLock) start at offset 120 and
  50631. ** the total header size is 136 bytes.
  50632. **
  50633. ** The szPage value can be any power of 2 between 512 and 32768, inclusive.
  50634. ** Or it can be 1 to represent a 65536-byte page. The latter case was
  50635. ** added in 3.7.1 when support for 64K pages was added.
  50636. */
  50637. struct WalIndexHdr {
  50638. u32 iVersion; /* Wal-index version */
  50639. u32 unused; /* Unused (padding) field */
  50640. u32 iChange; /* Counter incremented each transaction */
  50641. u8 isInit; /* 1 when initialized */
  50642. u8 bigEndCksum; /* True if checksums in WAL are big-endian */
  50643. u16 szPage; /* Database page size in bytes. 1==64K */
  50644. u32 mxFrame; /* Index of last valid frame in the WAL */
  50645. u32 nPage; /* Size of database in pages */
  50646. u32 aFrameCksum[2]; /* Checksum of last frame in log */
  50647. u32 aSalt[2]; /* Two salt values copied from WAL header */
  50648. u32 aCksum[2]; /* Checksum over all prior fields */
  50649. };
  50650. /*
  50651. ** A copy of the following object occurs in the wal-index immediately
  50652. ** following the second copy of the WalIndexHdr. This object stores
  50653. ** information used by checkpoint.
  50654. **
  50655. ** nBackfill is the number of frames in the WAL that have been written
  50656. ** back into the database. (We call the act of moving content from WAL to
  50657. ** database "backfilling".) The nBackfill number is never greater than
  50658. ** WalIndexHdr.mxFrame. nBackfill can only be increased by threads
  50659. ** holding the WAL_CKPT_LOCK lock (which includes a recovery thread).
  50660. ** However, a WAL_WRITE_LOCK thread can move the value of nBackfill from
  50661. ** mxFrame back to zero when the WAL is reset.
  50662. **
  50663. ** nBackfillAttempted is the largest value of nBackfill that a checkpoint
  50664. ** has attempted to achieve. Normally nBackfill==nBackfillAtempted, however
  50665. ** the nBackfillAttempted is set before any backfilling is done and the
  50666. ** nBackfill is only set after all backfilling completes. So if a checkpoint
  50667. ** crashes, nBackfillAttempted might be larger than nBackfill. The
  50668. ** WalIndexHdr.mxFrame must never be less than nBackfillAttempted.
  50669. **
  50670. ** The aLock[] field is a set of bytes used for locking. These bytes should
  50671. ** never be read or written.
  50672. **
  50673. ** There is one entry in aReadMark[] for each reader lock. If a reader
  50674. ** holds read-lock K, then the value in aReadMark[K] is no greater than
  50675. ** the mxFrame for that reader. The value READMARK_NOT_USED (0xffffffff)
  50676. ** for any aReadMark[] means that entry is unused. aReadMark[0] is
  50677. ** a special case; its value is never used and it exists as a place-holder
  50678. ** to avoid having to offset aReadMark[] indexs by one. Readers holding
  50679. ** WAL_READ_LOCK(0) always ignore the entire WAL and read all content
  50680. ** directly from the database.
  50681. **
  50682. ** The value of aReadMark[K] may only be changed by a thread that
  50683. ** is holding an exclusive lock on WAL_READ_LOCK(K). Thus, the value of
  50684. ** aReadMark[K] cannot changed while there is a reader is using that mark
  50685. ** since the reader will be holding a shared lock on WAL_READ_LOCK(K).
  50686. **
  50687. ** The checkpointer may only transfer frames from WAL to database where
  50688. ** the frame numbers are less than or equal to every aReadMark[] that is
  50689. ** in use (that is, every aReadMark[j] for which there is a corresponding
  50690. ** WAL_READ_LOCK(j)). New readers (usually) pick the aReadMark[] with the
  50691. ** largest value and will increase an unused aReadMark[] to mxFrame if there
  50692. ** is not already an aReadMark[] equal to mxFrame. The exception to the
  50693. ** previous sentence is when nBackfill equals mxFrame (meaning that everything
  50694. ** in the WAL has been backfilled into the database) then new readers
  50695. ** will choose aReadMark[0] which has value 0 and hence such reader will
  50696. ** get all their all content directly from the database file and ignore
  50697. ** the WAL.
  50698. **
  50699. ** Writers normally append new frames to the end of the WAL. However,
  50700. ** if nBackfill equals mxFrame (meaning that all WAL content has been
  50701. ** written back into the database) and if no readers are using the WAL
  50702. ** (in other words, if there are no WAL_READ_LOCK(i) where i>0) then
  50703. ** the writer will first "reset" the WAL back to the beginning and start
  50704. ** writing new content beginning at frame 1.
  50705. **
  50706. ** We assume that 32-bit loads are atomic and so no locks are needed in
  50707. ** order to read from any aReadMark[] entries.
  50708. */
  50709. struct WalCkptInfo {
  50710. u32 nBackfill; /* Number of WAL frames backfilled into DB */
  50711. u32 aReadMark[WAL_NREADER]; /* Reader marks */
  50712. u8 aLock[SQLITE_SHM_NLOCK]; /* Reserved space for locks */
  50713. u32 nBackfillAttempted; /* WAL frames perhaps written, or maybe not */
  50714. u32 notUsed0; /* Available for future enhancements */
  50715. };
  50716. #define READMARK_NOT_USED 0xffffffff
  50717. /* A block of WALINDEX_LOCK_RESERVED bytes beginning at
  50718. ** WALINDEX_LOCK_OFFSET is reserved for locks. Since some systems
  50719. ** only support mandatory file-locks, we do not read or write data
  50720. ** from the region of the file on which locks are applied.
  50721. */
  50722. #define WALINDEX_LOCK_OFFSET (sizeof(WalIndexHdr)*2+offsetof(WalCkptInfo,aLock))
  50723. #define WALINDEX_HDR_SIZE (sizeof(WalIndexHdr)*2+sizeof(WalCkptInfo))
  50724. /* Size of header before each frame in wal */
  50725. #define WAL_FRAME_HDRSIZE 24
  50726. /* Size of write ahead log header, including checksum. */
  50727. /* #define WAL_HDRSIZE 24 */
  50728. #define WAL_HDRSIZE 32
  50729. /* WAL magic value. Either this value, or the same value with the least
  50730. ** significant bit also set (WAL_MAGIC | 0x00000001) is stored in 32-bit
  50731. ** big-endian format in the first 4 bytes of a WAL file.
  50732. **
  50733. ** If the LSB is set, then the checksums for each frame within the WAL
  50734. ** file are calculated by treating all data as an array of 32-bit
  50735. ** big-endian words. Otherwise, they are calculated by interpreting
  50736. ** all data as 32-bit little-endian words.
  50737. */
  50738. #define WAL_MAGIC 0x377f0682
  50739. /*
  50740. ** Return the offset of frame iFrame in the write-ahead log file,
  50741. ** assuming a database page size of szPage bytes. The offset returned
  50742. ** is to the start of the write-ahead log frame-header.
  50743. */
  50744. #define walFrameOffset(iFrame, szPage) ( \
  50745. WAL_HDRSIZE + ((iFrame)-1)*(i64)((szPage)+WAL_FRAME_HDRSIZE) \
  50746. )
  50747. /*
  50748. ** An open write-ahead log file is represented by an instance of the
  50749. ** following object.
  50750. */
  50751. struct Wal {
  50752. sqlite3_vfs *pVfs; /* The VFS used to create pDbFd */
  50753. sqlite3_file *pDbFd; /* File handle for the database file */
  50754. sqlite3_file *pWalFd; /* File handle for WAL file */
  50755. u32 iCallback; /* Value to pass to log callback (or 0) */
  50756. i64 mxWalSize; /* Truncate WAL to this size upon reset */
  50757. int nWiData; /* Size of array apWiData */
  50758. int szFirstBlock; /* Size of first block written to WAL file */
  50759. volatile u32 **apWiData; /* Pointer to wal-index content in memory */
  50760. u32 szPage; /* Database page size */
  50761. i16 readLock; /* Which read lock is being held. -1 for none */
  50762. u8 syncFlags; /* Flags to use to sync header writes */
  50763. u8 exclusiveMode; /* Non-zero if connection is in exclusive mode */
  50764. u8 writeLock; /* True if in a write transaction */
  50765. u8 ckptLock; /* True if holding a checkpoint lock */
  50766. u8 readOnly; /* WAL_RDWR, WAL_RDONLY, or WAL_SHM_RDONLY */
  50767. u8 truncateOnCommit; /* True to truncate WAL file on commit */
  50768. u8 syncHeader; /* Fsync the WAL header if true */
  50769. u8 padToSectorBoundary; /* Pad transactions out to the next sector */
  50770. WalIndexHdr hdr; /* Wal-index header for current transaction */
  50771. u32 minFrame; /* Ignore wal frames before this one */
  50772. u32 iReCksum; /* On commit, recalculate checksums from here */
  50773. const char *zWalName; /* Name of WAL file */
  50774. u32 nCkpt; /* Checkpoint sequence counter in the wal-header */
  50775. #ifdef SQLITE_DEBUG
  50776. u8 lockError; /* True if a locking error has occurred */
  50777. #endif
  50778. #ifdef SQLITE_ENABLE_SNAPSHOT
  50779. WalIndexHdr *pSnapshot; /* Start transaction here if not NULL */
  50780. #endif
  50781. };
  50782. /*
  50783. ** Candidate values for Wal.exclusiveMode.
  50784. */
  50785. #define WAL_NORMAL_MODE 0
  50786. #define WAL_EXCLUSIVE_MODE 1
  50787. #define WAL_HEAPMEMORY_MODE 2
  50788. /*
  50789. ** Possible values for WAL.readOnly
  50790. */
  50791. #define WAL_RDWR 0 /* Normal read/write connection */
  50792. #define WAL_RDONLY 1 /* The WAL file is readonly */
  50793. #define WAL_SHM_RDONLY 2 /* The SHM file is readonly */
  50794. /*
  50795. ** Each page of the wal-index mapping contains a hash-table made up of
  50796. ** an array of HASHTABLE_NSLOT elements of the following type.
  50797. */
  50798. typedef u16 ht_slot;
  50799. /*
  50800. ** This structure is used to implement an iterator that loops through
  50801. ** all frames in the WAL in database page order. Where two or more frames
  50802. ** correspond to the same database page, the iterator visits only the
  50803. ** frame most recently written to the WAL (in other words, the frame with
  50804. ** the largest index).
  50805. **
  50806. ** The internals of this structure are only accessed by:
  50807. **
  50808. ** walIteratorInit() - Create a new iterator,
  50809. ** walIteratorNext() - Step an iterator,
  50810. ** walIteratorFree() - Free an iterator.
  50811. **
  50812. ** This functionality is used by the checkpoint code (see walCheckpoint()).
  50813. */
  50814. struct WalIterator {
  50815. int iPrior; /* Last result returned from the iterator */
  50816. int nSegment; /* Number of entries in aSegment[] */
  50817. struct WalSegment {
  50818. int iNext; /* Next slot in aIndex[] not yet returned */
  50819. ht_slot *aIndex; /* i0, i1, i2... such that aPgno[iN] ascend */
  50820. u32 *aPgno; /* Array of page numbers. */
  50821. int nEntry; /* Nr. of entries in aPgno[] and aIndex[] */
  50822. int iZero; /* Frame number associated with aPgno[0] */
  50823. } aSegment[1]; /* One for every 32KB page in the wal-index */
  50824. };
  50825. /*
  50826. ** Define the parameters of the hash tables in the wal-index file. There
  50827. ** is a hash-table following every HASHTABLE_NPAGE page numbers in the
  50828. ** wal-index.
  50829. **
  50830. ** Changing any of these constants will alter the wal-index format and
  50831. ** create incompatibilities.
  50832. */
  50833. #define HASHTABLE_NPAGE 4096 /* Must be power of 2 */
  50834. #define HASHTABLE_HASH_1 383 /* Should be prime */
  50835. #define HASHTABLE_NSLOT (HASHTABLE_NPAGE*2) /* Must be a power of 2 */
  50836. /*
  50837. ** The block of page numbers associated with the first hash-table in a
  50838. ** wal-index is smaller than usual. This is so that there is a complete
  50839. ** hash-table on each aligned 32KB page of the wal-index.
  50840. */
  50841. #define HASHTABLE_NPAGE_ONE (HASHTABLE_NPAGE - (WALINDEX_HDR_SIZE/sizeof(u32)))
  50842. /* The wal-index is divided into pages of WALINDEX_PGSZ bytes each. */
  50843. #define WALINDEX_PGSZ ( \
  50844. sizeof(ht_slot)*HASHTABLE_NSLOT + HASHTABLE_NPAGE*sizeof(u32) \
  50845. )
  50846. /*
  50847. ** Obtain a pointer to the iPage'th page of the wal-index. The wal-index
  50848. ** is broken into pages of WALINDEX_PGSZ bytes. Wal-index pages are
  50849. ** numbered from zero.
  50850. **
  50851. ** If this call is successful, *ppPage is set to point to the wal-index
  50852. ** page and SQLITE_OK is returned. If an error (an OOM or VFS error) occurs,
  50853. ** then an SQLite error code is returned and *ppPage is set to 0.
  50854. */
  50855. static int walIndexPage(Wal *pWal, int iPage, volatile u32 **ppPage){
  50856. int rc = SQLITE_OK;
  50857. /* Enlarge the pWal->apWiData[] array if required */
  50858. if( pWal->nWiData<=iPage ){
  50859. int nByte = sizeof(u32*)*(iPage+1);
  50860. volatile u32 **apNew;
  50861. apNew = (volatile u32 **)sqlite3_realloc64((void *)pWal->apWiData, nByte);
  50862. if( !apNew ){
  50863. *ppPage = 0;
  50864. return SQLITE_NOMEM_BKPT;
  50865. }
  50866. memset((void*)&apNew[pWal->nWiData], 0,
  50867. sizeof(u32*)*(iPage+1-pWal->nWiData));
  50868. pWal->apWiData = apNew;
  50869. pWal->nWiData = iPage+1;
  50870. }
  50871. /* Request a pointer to the required page from the VFS */
  50872. if( pWal->apWiData[iPage]==0 ){
  50873. if( pWal->exclusiveMode==WAL_HEAPMEMORY_MODE ){
  50874. pWal->apWiData[iPage] = (u32 volatile *)sqlite3MallocZero(WALINDEX_PGSZ);
  50875. if( !pWal->apWiData[iPage] ) rc = SQLITE_NOMEM_BKPT;
  50876. }else{
  50877. rc = sqlite3OsShmMap(pWal->pDbFd, iPage, WALINDEX_PGSZ,
  50878. pWal->writeLock, (void volatile **)&pWal->apWiData[iPage]
  50879. );
  50880. if( rc==SQLITE_READONLY ){
  50881. pWal->readOnly |= WAL_SHM_RDONLY;
  50882. rc = SQLITE_OK;
  50883. }
  50884. }
  50885. }
  50886. *ppPage = pWal->apWiData[iPage];
  50887. assert( iPage==0 || *ppPage || rc!=SQLITE_OK );
  50888. return rc;
  50889. }
  50890. /*
  50891. ** Return a pointer to the WalCkptInfo structure in the wal-index.
  50892. */
  50893. static volatile WalCkptInfo *walCkptInfo(Wal *pWal){
  50894. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  50895. return (volatile WalCkptInfo*)&(pWal->apWiData[0][sizeof(WalIndexHdr)/2]);
  50896. }
  50897. /*
  50898. ** Return a pointer to the WalIndexHdr structure in the wal-index.
  50899. */
  50900. static volatile WalIndexHdr *walIndexHdr(Wal *pWal){
  50901. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  50902. return (volatile WalIndexHdr*)pWal->apWiData[0];
  50903. }
  50904. /*
  50905. ** The argument to this macro must be of type u32. On a little-endian
  50906. ** architecture, it returns the u32 value that results from interpreting
  50907. ** the 4 bytes as a big-endian value. On a big-endian architecture, it
  50908. ** returns the value that would be produced by interpreting the 4 bytes
  50909. ** of the input value as a little-endian integer.
  50910. */
  50911. #define BYTESWAP32(x) ( \
  50912. (((x)&0x000000FF)<<24) + (((x)&0x0000FF00)<<8) \
  50913. + (((x)&0x00FF0000)>>8) + (((x)&0xFF000000)>>24) \
  50914. )
  50915. /*
  50916. ** Generate or extend an 8 byte checksum based on the data in
  50917. ** array aByte[] and the initial values of aIn[0] and aIn[1] (or
  50918. ** initial values of 0 and 0 if aIn==NULL).
  50919. **
  50920. ** The checksum is written back into aOut[] before returning.
  50921. **
  50922. ** nByte must be a positive multiple of 8.
  50923. */
  50924. static void walChecksumBytes(
  50925. int nativeCksum, /* True for native byte-order, false for non-native */
  50926. u8 *a, /* Content to be checksummed */
  50927. int nByte, /* Bytes of content in a[]. Must be a multiple of 8. */
  50928. const u32 *aIn, /* Initial checksum value input */
  50929. u32 *aOut /* OUT: Final checksum value output */
  50930. ){
  50931. u32 s1, s2;
  50932. u32 *aData = (u32 *)a;
  50933. u32 *aEnd = (u32 *)&a[nByte];
  50934. if( aIn ){
  50935. s1 = aIn[0];
  50936. s2 = aIn[1];
  50937. }else{
  50938. s1 = s2 = 0;
  50939. }
  50940. assert( nByte>=8 );
  50941. assert( (nByte&0x00000007)==0 );
  50942. if( nativeCksum ){
  50943. do {
  50944. s1 += *aData++ + s2;
  50945. s2 += *aData++ + s1;
  50946. }while( aData<aEnd );
  50947. }else{
  50948. do {
  50949. s1 += BYTESWAP32(aData[0]) + s2;
  50950. s2 += BYTESWAP32(aData[1]) + s1;
  50951. aData += 2;
  50952. }while( aData<aEnd );
  50953. }
  50954. aOut[0] = s1;
  50955. aOut[1] = s2;
  50956. }
  50957. static void walShmBarrier(Wal *pWal){
  50958. if( pWal->exclusiveMode!=WAL_HEAPMEMORY_MODE ){
  50959. sqlite3OsShmBarrier(pWal->pDbFd);
  50960. }
  50961. }
  50962. /*
  50963. ** Write the header information in pWal->hdr into the wal-index.
  50964. **
  50965. ** The checksum on pWal->hdr is updated before it is written.
  50966. */
  50967. static void walIndexWriteHdr(Wal *pWal){
  50968. volatile WalIndexHdr *aHdr = walIndexHdr(pWal);
  50969. const int nCksum = offsetof(WalIndexHdr, aCksum);
  50970. assert( pWal->writeLock );
  50971. pWal->hdr.isInit = 1;
  50972. pWal->hdr.iVersion = WALINDEX_MAX_VERSION;
  50973. walChecksumBytes(1, (u8*)&pWal->hdr, nCksum, 0, pWal->hdr.aCksum);
  50974. memcpy((void*)&aHdr[1], (const void*)&pWal->hdr, sizeof(WalIndexHdr));
  50975. walShmBarrier(pWal);
  50976. memcpy((void*)&aHdr[0], (const void*)&pWal->hdr, sizeof(WalIndexHdr));
  50977. }
  50978. /*
  50979. ** This function encodes a single frame header and writes it to a buffer
  50980. ** supplied by the caller. A frame-header is made up of a series of
  50981. ** 4-byte big-endian integers, as follows:
  50982. **
  50983. ** 0: Page number.
  50984. ** 4: For commit records, the size of the database image in pages
  50985. ** after the commit. For all other records, zero.
  50986. ** 8: Salt-1 (copied from the wal-header)
  50987. ** 12: Salt-2 (copied from the wal-header)
  50988. ** 16: Checksum-1.
  50989. ** 20: Checksum-2.
  50990. */
  50991. static void walEncodeFrame(
  50992. Wal *pWal, /* The write-ahead log */
  50993. u32 iPage, /* Database page number for frame */
  50994. u32 nTruncate, /* New db size (or 0 for non-commit frames) */
  50995. u8 *aData, /* Pointer to page data */
  50996. u8 *aFrame /* OUT: Write encoded frame here */
  50997. ){
  50998. int nativeCksum; /* True for native byte-order checksums */
  50999. u32 *aCksum = pWal->hdr.aFrameCksum;
  51000. assert( WAL_FRAME_HDRSIZE==24 );
  51001. sqlite3Put4byte(&aFrame[0], iPage);
  51002. sqlite3Put4byte(&aFrame[4], nTruncate);
  51003. if( pWal->iReCksum==0 ){
  51004. memcpy(&aFrame[8], pWal->hdr.aSalt, 8);
  51005. nativeCksum = (pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN);
  51006. walChecksumBytes(nativeCksum, aFrame, 8, aCksum, aCksum);
  51007. walChecksumBytes(nativeCksum, aData, pWal->szPage, aCksum, aCksum);
  51008. sqlite3Put4byte(&aFrame[16], aCksum[0]);
  51009. sqlite3Put4byte(&aFrame[20], aCksum[1]);
  51010. }else{
  51011. memset(&aFrame[8], 0, 16);
  51012. }
  51013. }
  51014. /*
  51015. ** Check to see if the frame with header in aFrame[] and content
  51016. ** in aData[] is valid. If it is a valid frame, fill *piPage and
  51017. ** *pnTruncate and return true. Return if the frame is not valid.
  51018. */
  51019. static int walDecodeFrame(
  51020. Wal *pWal, /* The write-ahead log */
  51021. u32 *piPage, /* OUT: Database page number for frame */
  51022. u32 *pnTruncate, /* OUT: New db size (or 0 if not commit) */
  51023. u8 *aData, /* Pointer to page data (for checksum) */
  51024. u8 *aFrame /* Frame data */
  51025. ){
  51026. int nativeCksum; /* True for native byte-order checksums */
  51027. u32 *aCksum = pWal->hdr.aFrameCksum;
  51028. u32 pgno; /* Page number of the frame */
  51029. assert( WAL_FRAME_HDRSIZE==24 );
  51030. /* A frame is only valid if the salt values in the frame-header
  51031. ** match the salt values in the wal-header.
  51032. */
  51033. if( memcmp(&pWal->hdr.aSalt, &aFrame[8], 8)!=0 ){
  51034. return 0;
  51035. }
  51036. /* A frame is only valid if the page number is creater than zero.
  51037. */
  51038. pgno = sqlite3Get4byte(&aFrame[0]);
  51039. if( pgno==0 ){
  51040. return 0;
  51041. }
  51042. /* A frame is only valid if a checksum of the WAL header,
  51043. ** all prior frams, the first 16 bytes of this frame-header,
  51044. ** and the frame-data matches the checksum in the last 8
  51045. ** bytes of this frame-header.
  51046. */
  51047. nativeCksum = (pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN);
  51048. walChecksumBytes(nativeCksum, aFrame, 8, aCksum, aCksum);
  51049. walChecksumBytes(nativeCksum, aData, pWal->szPage, aCksum, aCksum);
  51050. if( aCksum[0]!=sqlite3Get4byte(&aFrame[16])
  51051. || aCksum[1]!=sqlite3Get4byte(&aFrame[20])
  51052. ){
  51053. /* Checksum failed. */
  51054. return 0;
  51055. }
  51056. /* If we reach this point, the frame is valid. Return the page number
  51057. ** and the new database size.
  51058. */
  51059. *piPage = pgno;
  51060. *pnTruncate = sqlite3Get4byte(&aFrame[4]);
  51061. return 1;
  51062. }
  51063. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  51064. /*
  51065. ** Names of locks. This routine is used to provide debugging output and is not
  51066. ** a part of an ordinary build.
  51067. */
  51068. static const char *walLockName(int lockIdx){
  51069. if( lockIdx==WAL_WRITE_LOCK ){
  51070. return "WRITE-LOCK";
  51071. }else if( lockIdx==WAL_CKPT_LOCK ){
  51072. return "CKPT-LOCK";
  51073. }else if( lockIdx==WAL_RECOVER_LOCK ){
  51074. return "RECOVER-LOCK";
  51075. }else{
  51076. static char zName[15];
  51077. sqlite3_snprintf(sizeof(zName), zName, "READ-LOCK[%d]",
  51078. lockIdx-WAL_READ_LOCK(0));
  51079. return zName;
  51080. }
  51081. }
  51082. #endif /*defined(SQLITE_TEST) || defined(SQLITE_DEBUG) */
  51083. /*
  51084. ** Set or release locks on the WAL. Locks are either shared or exclusive.
  51085. ** A lock cannot be moved directly between shared and exclusive - it must go
  51086. ** through the unlocked state first.
  51087. **
  51088. ** In locking_mode=EXCLUSIVE, all of these routines become no-ops.
  51089. */
  51090. static int walLockShared(Wal *pWal, int lockIdx){
  51091. int rc;
  51092. if( pWal->exclusiveMode ) return SQLITE_OK;
  51093. rc = sqlite3OsShmLock(pWal->pDbFd, lockIdx, 1,
  51094. SQLITE_SHM_LOCK | SQLITE_SHM_SHARED);
  51095. WALTRACE(("WAL%p: acquire SHARED-%s %s\n", pWal,
  51096. walLockName(lockIdx), rc ? "failed" : "ok"));
  51097. VVA_ONLY( pWal->lockError = (u8)(rc!=SQLITE_OK && rc!=SQLITE_BUSY); )
  51098. return rc;
  51099. }
  51100. static void walUnlockShared(Wal *pWal, int lockIdx){
  51101. if( pWal->exclusiveMode ) return;
  51102. (void)sqlite3OsShmLock(pWal->pDbFd, lockIdx, 1,
  51103. SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED);
  51104. WALTRACE(("WAL%p: release SHARED-%s\n", pWal, walLockName(lockIdx)));
  51105. }
  51106. static int walLockExclusive(Wal *pWal, int lockIdx, int n){
  51107. int rc;
  51108. if( pWal->exclusiveMode ) return SQLITE_OK;
  51109. rc = sqlite3OsShmLock(pWal->pDbFd, lockIdx, n,
  51110. SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE);
  51111. WALTRACE(("WAL%p: acquire EXCLUSIVE-%s cnt=%d %s\n", pWal,
  51112. walLockName(lockIdx), n, rc ? "failed" : "ok"));
  51113. VVA_ONLY( pWal->lockError = (u8)(rc!=SQLITE_OK && rc!=SQLITE_BUSY); )
  51114. return rc;
  51115. }
  51116. static void walUnlockExclusive(Wal *pWal, int lockIdx, int n){
  51117. if( pWal->exclusiveMode ) return;
  51118. (void)sqlite3OsShmLock(pWal->pDbFd, lockIdx, n,
  51119. SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE);
  51120. WALTRACE(("WAL%p: release EXCLUSIVE-%s cnt=%d\n", pWal,
  51121. walLockName(lockIdx), n));
  51122. }
  51123. /*
  51124. ** Compute a hash on a page number. The resulting hash value must land
  51125. ** between 0 and (HASHTABLE_NSLOT-1). The walHashNext() function advances
  51126. ** the hash to the next value in the event of a collision.
  51127. */
  51128. static int walHash(u32 iPage){
  51129. assert( iPage>0 );
  51130. assert( (HASHTABLE_NSLOT & (HASHTABLE_NSLOT-1))==0 );
  51131. return (iPage*HASHTABLE_HASH_1) & (HASHTABLE_NSLOT-1);
  51132. }
  51133. static int walNextHash(int iPriorHash){
  51134. return (iPriorHash+1)&(HASHTABLE_NSLOT-1);
  51135. }
  51136. /*
  51137. ** Return pointers to the hash table and page number array stored on
  51138. ** page iHash of the wal-index. The wal-index is broken into 32KB pages
  51139. ** numbered starting from 0.
  51140. **
  51141. ** Set output variable *paHash to point to the start of the hash table
  51142. ** in the wal-index file. Set *piZero to one less than the frame
  51143. ** number of the first frame indexed by this hash table. If a
  51144. ** slot in the hash table is set to N, it refers to frame number
  51145. ** (*piZero+N) in the log.
  51146. **
  51147. ** Finally, set *paPgno so that *paPgno[1] is the page number of the
  51148. ** first frame indexed by the hash table, frame (*piZero+1).
  51149. */
  51150. static int walHashGet(
  51151. Wal *pWal, /* WAL handle */
  51152. int iHash, /* Find the iHash'th table */
  51153. volatile ht_slot **paHash, /* OUT: Pointer to hash index */
  51154. volatile u32 **paPgno, /* OUT: Pointer to page number array */
  51155. u32 *piZero /* OUT: Frame associated with *paPgno[0] */
  51156. ){
  51157. int rc; /* Return code */
  51158. volatile u32 *aPgno;
  51159. rc = walIndexPage(pWal, iHash, &aPgno);
  51160. assert( rc==SQLITE_OK || iHash>0 );
  51161. if( rc==SQLITE_OK ){
  51162. u32 iZero;
  51163. volatile ht_slot *aHash;
  51164. aHash = (volatile ht_slot *)&aPgno[HASHTABLE_NPAGE];
  51165. if( iHash==0 ){
  51166. aPgno = &aPgno[WALINDEX_HDR_SIZE/sizeof(u32)];
  51167. iZero = 0;
  51168. }else{
  51169. iZero = HASHTABLE_NPAGE_ONE + (iHash-1)*HASHTABLE_NPAGE;
  51170. }
  51171. *paPgno = &aPgno[-1];
  51172. *paHash = aHash;
  51173. *piZero = iZero;
  51174. }
  51175. return rc;
  51176. }
  51177. /*
  51178. ** Return the number of the wal-index page that contains the hash-table
  51179. ** and page-number array that contain entries corresponding to WAL frame
  51180. ** iFrame. The wal-index is broken up into 32KB pages. Wal-index pages
  51181. ** are numbered starting from 0.
  51182. */
  51183. static int walFramePage(u32 iFrame){
  51184. int iHash = (iFrame+HASHTABLE_NPAGE-HASHTABLE_NPAGE_ONE-1) / HASHTABLE_NPAGE;
  51185. assert( (iHash==0 || iFrame>HASHTABLE_NPAGE_ONE)
  51186. && (iHash>=1 || iFrame<=HASHTABLE_NPAGE_ONE)
  51187. && (iHash<=1 || iFrame>(HASHTABLE_NPAGE_ONE+HASHTABLE_NPAGE))
  51188. && (iHash>=2 || iFrame<=HASHTABLE_NPAGE_ONE+HASHTABLE_NPAGE)
  51189. && (iHash<=2 || iFrame>(HASHTABLE_NPAGE_ONE+2*HASHTABLE_NPAGE))
  51190. );
  51191. return iHash;
  51192. }
  51193. /*
  51194. ** Return the page number associated with frame iFrame in this WAL.
  51195. */
  51196. static u32 walFramePgno(Wal *pWal, u32 iFrame){
  51197. int iHash = walFramePage(iFrame);
  51198. if( iHash==0 ){
  51199. return pWal->apWiData[0][WALINDEX_HDR_SIZE/sizeof(u32) + iFrame - 1];
  51200. }
  51201. return pWal->apWiData[iHash][(iFrame-1-HASHTABLE_NPAGE_ONE)%HASHTABLE_NPAGE];
  51202. }
  51203. /*
  51204. ** Remove entries from the hash table that point to WAL slots greater
  51205. ** than pWal->hdr.mxFrame.
  51206. **
  51207. ** This function is called whenever pWal->hdr.mxFrame is decreased due
  51208. ** to a rollback or savepoint.
  51209. **
  51210. ** At most only the hash table containing pWal->hdr.mxFrame needs to be
  51211. ** updated. Any later hash tables will be automatically cleared when
  51212. ** pWal->hdr.mxFrame advances to the point where those hash tables are
  51213. ** actually needed.
  51214. */
  51215. static void walCleanupHash(Wal *pWal){
  51216. volatile ht_slot *aHash = 0; /* Pointer to hash table to clear */
  51217. volatile u32 *aPgno = 0; /* Page number array for hash table */
  51218. u32 iZero = 0; /* frame == (aHash[x]+iZero) */
  51219. int iLimit = 0; /* Zero values greater than this */
  51220. int nByte; /* Number of bytes to zero in aPgno[] */
  51221. int i; /* Used to iterate through aHash[] */
  51222. assert( pWal->writeLock );
  51223. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE-1 );
  51224. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE );
  51225. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE+1 );
  51226. if( pWal->hdr.mxFrame==0 ) return;
  51227. /* Obtain pointers to the hash-table and page-number array containing
  51228. ** the entry that corresponds to frame pWal->hdr.mxFrame. It is guaranteed
  51229. ** that the page said hash-table and array reside on is already mapped.
  51230. */
  51231. assert( pWal->nWiData>walFramePage(pWal->hdr.mxFrame) );
  51232. assert( pWal->apWiData[walFramePage(pWal->hdr.mxFrame)] );
  51233. walHashGet(pWal, walFramePage(pWal->hdr.mxFrame), &aHash, &aPgno, &iZero);
  51234. /* Zero all hash-table entries that correspond to frame numbers greater
  51235. ** than pWal->hdr.mxFrame.
  51236. */
  51237. iLimit = pWal->hdr.mxFrame - iZero;
  51238. assert( iLimit>0 );
  51239. for(i=0; i<HASHTABLE_NSLOT; i++){
  51240. if( aHash[i]>iLimit ){
  51241. aHash[i] = 0;
  51242. }
  51243. }
  51244. /* Zero the entries in the aPgno array that correspond to frames with
  51245. ** frame numbers greater than pWal->hdr.mxFrame.
  51246. */
  51247. nByte = (int)((char *)aHash - (char *)&aPgno[iLimit+1]);
  51248. memset((void *)&aPgno[iLimit+1], 0, nByte);
  51249. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  51250. /* Verify that the every entry in the mapping region is still reachable
  51251. ** via the hash table even after the cleanup.
  51252. */
  51253. if( iLimit ){
  51254. int j; /* Loop counter */
  51255. int iKey; /* Hash key */
  51256. for(j=1; j<=iLimit; j++){
  51257. for(iKey=walHash(aPgno[j]); aHash[iKey]; iKey=walNextHash(iKey)){
  51258. if( aHash[iKey]==j ) break;
  51259. }
  51260. assert( aHash[iKey]==j );
  51261. }
  51262. }
  51263. #endif /* SQLITE_ENABLE_EXPENSIVE_ASSERT */
  51264. }
  51265. /*
  51266. ** Set an entry in the wal-index that will map database page number
  51267. ** pPage into WAL frame iFrame.
  51268. */
  51269. static int walIndexAppend(Wal *pWal, u32 iFrame, u32 iPage){
  51270. int rc; /* Return code */
  51271. u32 iZero = 0; /* One less than frame number of aPgno[1] */
  51272. volatile u32 *aPgno = 0; /* Page number array */
  51273. volatile ht_slot *aHash = 0; /* Hash table */
  51274. rc = walHashGet(pWal, walFramePage(iFrame), &aHash, &aPgno, &iZero);
  51275. /* Assuming the wal-index file was successfully mapped, populate the
  51276. ** page number array and hash table entry.
  51277. */
  51278. if( rc==SQLITE_OK ){
  51279. int iKey; /* Hash table key */
  51280. int idx; /* Value to write to hash-table slot */
  51281. int nCollide; /* Number of hash collisions */
  51282. idx = iFrame - iZero;
  51283. assert( idx <= HASHTABLE_NSLOT/2 + 1 );
  51284. /* If this is the first entry to be added to this hash-table, zero the
  51285. ** entire hash table and aPgno[] array before proceeding.
  51286. */
  51287. if( idx==1 ){
  51288. int nByte = (int)((u8 *)&aHash[HASHTABLE_NSLOT] - (u8 *)&aPgno[1]);
  51289. memset((void*)&aPgno[1], 0, nByte);
  51290. }
  51291. /* If the entry in aPgno[] is already set, then the previous writer
  51292. ** must have exited unexpectedly in the middle of a transaction (after
  51293. ** writing one or more dirty pages to the WAL to free up memory).
  51294. ** Remove the remnants of that writers uncommitted transaction from
  51295. ** the hash-table before writing any new entries.
  51296. */
  51297. if( aPgno[idx] ){
  51298. walCleanupHash(pWal);
  51299. assert( !aPgno[idx] );
  51300. }
  51301. /* Write the aPgno[] array entry and the hash-table slot. */
  51302. nCollide = idx;
  51303. for(iKey=walHash(iPage); aHash[iKey]; iKey=walNextHash(iKey)){
  51304. if( (nCollide--)==0 ) return SQLITE_CORRUPT_BKPT;
  51305. }
  51306. aPgno[idx] = iPage;
  51307. aHash[iKey] = (ht_slot)idx;
  51308. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  51309. /* Verify that the number of entries in the hash table exactly equals
  51310. ** the number of entries in the mapping region.
  51311. */
  51312. {
  51313. int i; /* Loop counter */
  51314. int nEntry = 0; /* Number of entries in the hash table */
  51315. for(i=0; i<HASHTABLE_NSLOT; i++){ if( aHash[i] ) nEntry++; }
  51316. assert( nEntry==idx );
  51317. }
  51318. /* Verify that the every entry in the mapping region is reachable
  51319. ** via the hash table. This turns out to be a really, really expensive
  51320. ** thing to check, so only do this occasionally - not on every
  51321. ** iteration.
  51322. */
  51323. if( (idx&0x3ff)==0 ){
  51324. int i; /* Loop counter */
  51325. for(i=1; i<=idx; i++){
  51326. for(iKey=walHash(aPgno[i]); aHash[iKey]; iKey=walNextHash(iKey)){
  51327. if( aHash[iKey]==i ) break;
  51328. }
  51329. assert( aHash[iKey]==i );
  51330. }
  51331. }
  51332. #endif /* SQLITE_ENABLE_EXPENSIVE_ASSERT */
  51333. }
  51334. return rc;
  51335. }
  51336. /*
  51337. ** Recover the wal-index by reading the write-ahead log file.
  51338. **
  51339. ** This routine first tries to establish an exclusive lock on the
  51340. ** wal-index to prevent other threads/processes from doing anything
  51341. ** with the WAL or wal-index while recovery is running. The
  51342. ** WAL_RECOVER_LOCK is also held so that other threads will know
  51343. ** that this thread is running recovery. If unable to establish
  51344. ** the necessary locks, this routine returns SQLITE_BUSY.
  51345. */
  51346. static int walIndexRecover(Wal *pWal){
  51347. int rc; /* Return Code */
  51348. i64 nSize; /* Size of log file */
  51349. u32 aFrameCksum[2] = {0, 0};
  51350. int iLock; /* Lock offset to lock for checkpoint */
  51351. int nLock; /* Number of locks to hold */
  51352. /* Obtain an exclusive lock on all byte in the locking range not already
  51353. ** locked by the caller. The caller is guaranteed to have locked the
  51354. ** WAL_WRITE_LOCK byte, and may have also locked the WAL_CKPT_LOCK byte.
  51355. ** If successful, the same bytes that are locked here are unlocked before
  51356. ** this function returns.
  51357. */
  51358. assert( pWal->ckptLock==1 || pWal->ckptLock==0 );
  51359. assert( WAL_ALL_BUT_WRITE==WAL_WRITE_LOCK+1 );
  51360. assert( WAL_CKPT_LOCK==WAL_ALL_BUT_WRITE );
  51361. assert( pWal->writeLock );
  51362. iLock = WAL_ALL_BUT_WRITE + pWal->ckptLock;
  51363. nLock = SQLITE_SHM_NLOCK - iLock;
  51364. rc = walLockExclusive(pWal, iLock, nLock);
  51365. if( rc ){
  51366. return rc;
  51367. }
  51368. WALTRACE(("WAL%p: recovery begin...\n", pWal));
  51369. memset(&pWal->hdr, 0, sizeof(WalIndexHdr));
  51370. rc = sqlite3OsFileSize(pWal->pWalFd, &nSize);
  51371. if( rc!=SQLITE_OK ){
  51372. goto recovery_error;
  51373. }
  51374. if( nSize>WAL_HDRSIZE ){
  51375. u8 aBuf[WAL_HDRSIZE]; /* Buffer to load WAL header into */
  51376. u8 *aFrame = 0; /* Malloc'd buffer to load entire frame */
  51377. int szFrame; /* Number of bytes in buffer aFrame[] */
  51378. u8 *aData; /* Pointer to data part of aFrame buffer */
  51379. int iFrame; /* Index of last frame read */
  51380. i64 iOffset; /* Next offset to read from log file */
  51381. int szPage; /* Page size according to the log */
  51382. u32 magic; /* Magic value read from WAL header */
  51383. u32 version; /* Magic value read from WAL header */
  51384. int isValid; /* True if this frame is valid */
  51385. /* Read in the WAL header. */
  51386. rc = sqlite3OsRead(pWal->pWalFd, aBuf, WAL_HDRSIZE, 0);
  51387. if( rc!=SQLITE_OK ){
  51388. goto recovery_error;
  51389. }
  51390. /* If the database page size is not a power of two, or is greater than
  51391. ** SQLITE_MAX_PAGE_SIZE, conclude that the WAL file contains no valid
  51392. ** data. Similarly, if the 'magic' value is invalid, ignore the whole
  51393. ** WAL file.
  51394. */
  51395. magic = sqlite3Get4byte(&aBuf[0]);
  51396. szPage = sqlite3Get4byte(&aBuf[8]);
  51397. if( (magic&0xFFFFFFFE)!=WAL_MAGIC
  51398. || szPage&(szPage-1)
  51399. || szPage>SQLITE_MAX_PAGE_SIZE
  51400. || szPage<512
  51401. ){
  51402. goto finished;
  51403. }
  51404. pWal->hdr.bigEndCksum = (u8)(magic&0x00000001);
  51405. pWal->szPage = szPage;
  51406. pWal->nCkpt = sqlite3Get4byte(&aBuf[12]);
  51407. memcpy(&pWal->hdr.aSalt, &aBuf[16], 8);
  51408. /* Verify that the WAL header checksum is correct */
  51409. walChecksumBytes(pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN,
  51410. aBuf, WAL_HDRSIZE-2*4, 0, pWal->hdr.aFrameCksum
  51411. );
  51412. if( pWal->hdr.aFrameCksum[0]!=sqlite3Get4byte(&aBuf[24])
  51413. || pWal->hdr.aFrameCksum[1]!=sqlite3Get4byte(&aBuf[28])
  51414. ){
  51415. goto finished;
  51416. }
  51417. /* Verify that the version number on the WAL format is one that
  51418. ** are able to understand */
  51419. version = sqlite3Get4byte(&aBuf[4]);
  51420. if( version!=WAL_MAX_VERSION ){
  51421. rc = SQLITE_CANTOPEN_BKPT;
  51422. goto finished;
  51423. }
  51424. /* Malloc a buffer to read frames into. */
  51425. szFrame = szPage + WAL_FRAME_HDRSIZE;
  51426. aFrame = (u8 *)sqlite3_malloc64(szFrame);
  51427. if( !aFrame ){
  51428. rc = SQLITE_NOMEM_BKPT;
  51429. goto recovery_error;
  51430. }
  51431. aData = &aFrame[WAL_FRAME_HDRSIZE];
  51432. /* Read all frames from the log file. */
  51433. iFrame = 0;
  51434. for(iOffset=WAL_HDRSIZE; (iOffset+szFrame)<=nSize; iOffset+=szFrame){
  51435. u32 pgno; /* Database page number for frame */
  51436. u32 nTruncate; /* dbsize field from frame header */
  51437. /* Read and decode the next log frame. */
  51438. iFrame++;
  51439. rc = sqlite3OsRead(pWal->pWalFd, aFrame, szFrame, iOffset);
  51440. if( rc!=SQLITE_OK ) break;
  51441. isValid = walDecodeFrame(pWal, &pgno, &nTruncate, aData, aFrame);
  51442. if( !isValid ) break;
  51443. rc = walIndexAppend(pWal, iFrame, pgno);
  51444. if( rc!=SQLITE_OK ) break;
  51445. /* If nTruncate is non-zero, this is a commit record. */
  51446. if( nTruncate ){
  51447. pWal->hdr.mxFrame = iFrame;
  51448. pWal->hdr.nPage = nTruncate;
  51449. pWal->hdr.szPage = (u16)((szPage&0xff00) | (szPage>>16));
  51450. testcase( szPage<=32768 );
  51451. testcase( szPage>=65536 );
  51452. aFrameCksum[0] = pWal->hdr.aFrameCksum[0];
  51453. aFrameCksum[1] = pWal->hdr.aFrameCksum[1];
  51454. }
  51455. }
  51456. sqlite3_free(aFrame);
  51457. }
  51458. finished:
  51459. if( rc==SQLITE_OK ){
  51460. volatile WalCkptInfo *pInfo;
  51461. int i;
  51462. pWal->hdr.aFrameCksum[0] = aFrameCksum[0];
  51463. pWal->hdr.aFrameCksum[1] = aFrameCksum[1];
  51464. walIndexWriteHdr(pWal);
  51465. /* Reset the checkpoint-header. This is safe because this thread is
  51466. ** currently holding locks that exclude all other readers, writers and
  51467. ** checkpointers.
  51468. */
  51469. pInfo = walCkptInfo(pWal);
  51470. pInfo->nBackfill = 0;
  51471. pInfo->nBackfillAttempted = pWal->hdr.mxFrame;
  51472. pInfo->aReadMark[0] = 0;
  51473. for(i=1; i<WAL_NREADER; i++) pInfo->aReadMark[i] = READMARK_NOT_USED;
  51474. if( pWal->hdr.mxFrame ) pInfo->aReadMark[1] = pWal->hdr.mxFrame;
  51475. /* If more than one frame was recovered from the log file, report an
  51476. ** event via sqlite3_log(). This is to help with identifying performance
  51477. ** problems caused by applications routinely shutting down without
  51478. ** checkpointing the log file.
  51479. */
  51480. if( pWal->hdr.nPage ){
  51481. sqlite3_log(SQLITE_NOTICE_RECOVER_WAL,
  51482. "recovered %d frames from WAL file %s",
  51483. pWal->hdr.mxFrame, pWal->zWalName
  51484. );
  51485. }
  51486. }
  51487. recovery_error:
  51488. WALTRACE(("WAL%p: recovery %s\n", pWal, rc ? "failed" : "ok"));
  51489. walUnlockExclusive(pWal, iLock, nLock);
  51490. return rc;
  51491. }
  51492. /*
  51493. ** Close an open wal-index.
  51494. */
  51495. static void walIndexClose(Wal *pWal, int isDelete){
  51496. if( pWal->exclusiveMode==WAL_HEAPMEMORY_MODE ){
  51497. int i;
  51498. for(i=0; i<pWal->nWiData; i++){
  51499. sqlite3_free((void *)pWal->apWiData[i]);
  51500. pWal->apWiData[i] = 0;
  51501. }
  51502. }else{
  51503. sqlite3OsShmUnmap(pWal->pDbFd, isDelete);
  51504. }
  51505. }
  51506. /*
  51507. ** Open a connection to the WAL file zWalName. The database file must
  51508. ** already be opened on connection pDbFd. The buffer that zWalName points
  51509. ** to must remain valid for the lifetime of the returned Wal* handle.
  51510. **
  51511. ** A SHARED lock should be held on the database file when this function
  51512. ** is called. The purpose of this SHARED lock is to prevent any other
  51513. ** client from unlinking the WAL or wal-index file. If another process
  51514. ** were to do this just after this client opened one of these files, the
  51515. ** system would be badly broken.
  51516. **
  51517. ** If the log file is successfully opened, SQLITE_OK is returned and
  51518. ** *ppWal is set to point to a new WAL handle. If an error occurs,
  51519. ** an SQLite error code is returned and *ppWal is left unmodified.
  51520. */
  51521. SQLITE_PRIVATE int sqlite3WalOpen(
  51522. sqlite3_vfs *pVfs, /* vfs module to open wal and wal-index */
  51523. sqlite3_file *pDbFd, /* The open database file */
  51524. const char *zWalName, /* Name of the WAL file */
  51525. int bNoShm, /* True to run in heap-memory mode */
  51526. i64 mxWalSize, /* Truncate WAL to this size on reset */
  51527. Wal **ppWal /* OUT: Allocated Wal handle */
  51528. ){
  51529. int rc; /* Return Code */
  51530. Wal *pRet; /* Object to allocate and return */
  51531. int flags; /* Flags passed to OsOpen() */
  51532. assert( zWalName && zWalName[0] );
  51533. assert( pDbFd );
  51534. /* In the amalgamation, the os_unix.c and os_win.c source files come before
  51535. ** this source file. Verify that the #defines of the locking byte offsets
  51536. ** in os_unix.c and os_win.c agree with the WALINDEX_LOCK_OFFSET value.
  51537. ** For that matter, if the lock offset ever changes from its initial design
  51538. ** value of 120, we need to know that so there is an assert() to check it.
  51539. */
  51540. assert( 120==WALINDEX_LOCK_OFFSET );
  51541. assert( 136==WALINDEX_HDR_SIZE );
  51542. #ifdef WIN_SHM_BASE
  51543. assert( WIN_SHM_BASE==WALINDEX_LOCK_OFFSET );
  51544. #endif
  51545. #ifdef UNIX_SHM_BASE
  51546. assert( UNIX_SHM_BASE==WALINDEX_LOCK_OFFSET );
  51547. #endif
  51548. /* Allocate an instance of struct Wal to return. */
  51549. *ppWal = 0;
  51550. pRet = (Wal*)sqlite3MallocZero(sizeof(Wal) + pVfs->szOsFile);
  51551. if( !pRet ){
  51552. return SQLITE_NOMEM_BKPT;
  51553. }
  51554. pRet->pVfs = pVfs;
  51555. pRet->pWalFd = (sqlite3_file *)&pRet[1];
  51556. pRet->pDbFd = pDbFd;
  51557. pRet->readLock = -1;
  51558. pRet->mxWalSize = mxWalSize;
  51559. pRet->zWalName = zWalName;
  51560. pRet->syncHeader = 1;
  51561. pRet->padToSectorBoundary = 1;
  51562. pRet->exclusiveMode = (bNoShm ? WAL_HEAPMEMORY_MODE: WAL_NORMAL_MODE);
  51563. /* Open file handle on the write-ahead log file. */
  51564. flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_WAL);
  51565. rc = sqlite3OsOpen(pVfs, zWalName, pRet->pWalFd, flags, &flags);
  51566. if( rc==SQLITE_OK && flags&SQLITE_OPEN_READONLY ){
  51567. pRet->readOnly = WAL_RDONLY;
  51568. }
  51569. if( rc!=SQLITE_OK ){
  51570. walIndexClose(pRet, 0);
  51571. sqlite3OsClose(pRet->pWalFd);
  51572. sqlite3_free(pRet);
  51573. }else{
  51574. int iDC = sqlite3OsDeviceCharacteristics(pDbFd);
  51575. if( iDC & SQLITE_IOCAP_SEQUENTIAL ){ pRet->syncHeader = 0; }
  51576. if( iDC & SQLITE_IOCAP_POWERSAFE_OVERWRITE ){
  51577. pRet->padToSectorBoundary = 0;
  51578. }
  51579. *ppWal = pRet;
  51580. WALTRACE(("WAL%d: opened\n", pRet));
  51581. }
  51582. return rc;
  51583. }
  51584. /*
  51585. ** Change the size to which the WAL file is trucated on each reset.
  51586. */
  51587. SQLITE_PRIVATE void sqlite3WalLimit(Wal *pWal, i64 iLimit){
  51588. if( pWal ) pWal->mxWalSize = iLimit;
  51589. }
  51590. /*
  51591. ** Find the smallest page number out of all pages held in the WAL that
  51592. ** has not been returned by any prior invocation of this method on the
  51593. ** same WalIterator object. Write into *piFrame the frame index where
  51594. ** that page was last written into the WAL. Write into *piPage the page
  51595. ** number.
  51596. **
  51597. ** Return 0 on success. If there are no pages in the WAL with a page
  51598. ** number larger than *piPage, then return 1.
  51599. */
  51600. static int walIteratorNext(
  51601. WalIterator *p, /* Iterator */
  51602. u32 *piPage, /* OUT: The page number of the next page */
  51603. u32 *piFrame /* OUT: Wal frame index of next page */
  51604. ){
  51605. u32 iMin; /* Result pgno must be greater than iMin */
  51606. u32 iRet = 0xFFFFFFFF; /* 0xffffffff is never a valid page number */
  51607. int i; /* For looping through segments */
  51608. iMin = p->iPrior;
  51609. assert( iMin<0xffffffff );
  51610. for(i=p->nSegment-1; i>=0; i--){
  51611. struct WalSegment *pSegment = &p->aSegment[i];
  51612. while( pSegment->iNext<pSegment->nEntry ){
  51613. u32 iPg = pSegment->aPgno[pSegment->aIndex[pSegment->iNext]];
  51614. if( iPg>iMin ){
  51615. if( iPg<iRet ){
  51616. iRet = iPg;
  51617. *piFrame = pSegment->iZero + pSegment->aIndex[pSegment->iNext];
  51618. }
  51619. break;
  51620. }
  51621. pSegment->iNext++;
  51622. }
  51623. }
  51624. *piPage = p->iPrior = iRet;
  51625. return (iRet==0xFFFFFFFF);
  51626. }
  51627. /*
  51628. ** This function merges two sorted lists into a single sorted list.
  51629. **
  51630. ** aLeft[] and aRight[] are arrays of indices. The sort key is
  51631. ** aContent[aLeft[]] and aContent[aRight[]]. Upon entry, the following
  51632. ** is guaranteed for all J<K:
  51633. **
  51634. ** aContent[aLeft[J]] < aContent[aLeft[K]]
  51635. ** aContent[aRight[J]] < aContent[aRight[K]]
  51636. **
  51637. ** This routine overwrites aRight[] with a new (probably longer) sequence
  51638. ** of indices such that the aRight[] contains every index that appears in
  51639. ** either aLeft[] or the old aRight[] and such that the second condition
  51640. ** above is still met.
  51641. **
  51642. ** The aContent[aLeft[X]] values will be unique for all X. And the
  51643. ** aContent[aRight[X]] values will be unique too. But there might be
  51644. ** one or more combinations of X and Y such that
  51645. **
  51646. ** aLeft[X]!=aRight[Y] && aContent[aLeft[X]] == aContent[aRight[Y]]
  51647. **
  51648. ** When that happens, omit the aLeft[X] and use the aRight[Y] index.
  51649. */
  51650. static void walMerge(
  51651. const u32 *aContent, /* Pages in wal - keys for the sort */
  51652. ht_slot *aLeft, /* IN: Left hand input list */
  51653. int nLeft, /* IN: Elements in array *paLeft */
  51654. ht_slot **paRight, /* IN/OUT: Right hand input list */
  51655. int *pnRight, /* IN/OUT: Elements in *paRight */
  51656. ht_slot *aTmp /* Temporary buffer */
  51657. ){
  51658. int iLeft = 0; /* Current index in aLeft */
  51659. int iRight = 0; /* Current index in aRight */
  51660. int iOut = 0; /* Current index in output buffer */
  51661. int nRight = *pnRight;
  51662. ht_slot *aRight = *paRight;
  51663. assert( nLeft>0 && nRight>0 );
  51664. while( iRight<nRight || iLeft<nLeft ){
  51665. ht_slot logpage;
  51666. Pgno dbpage;
  51667. if( (iLeft<nLeft)
  51668. && (iRight>=nRight || aContent[aLeft[iLeft]]<aContent[aRight[iRight]])
  51669. ){
  51670. logpage = aLeft[iLeft++];
  51671. }else{
  51672. logpage = aRight[iRight++];
  51673. }
  51674. dbpage = aContent[logpage];
  51675. aTmp[iOut++] = logpage;
  51676. if( iLeft<nLeft && aContent[aLeft[iLeft]]==dbpage ) iLeft++;
  51677. assert( iLeft>=nLeft || aContent[aLeft[iLeft]]>dbpage );
  51678. assert( iRight>=nRight || aContent[aRight[iRight]]>dbpage );
  51679. }
  51680. *paRight = aLeft;
  51681. *pnRight = iOut;
  51682. memcpy(aLeft, aTmp, sizeof(aTmp[0])*iOut);
  51683. }
  51684. /*
  51685. ** Sort the elements in list aList using aContent[] as the sort key.
  51686. ** Remove elements with duplicate keys, preferring to keep the
  51687. ** larger aList[] values.
  51688. **
  51689. ** The aList[] entries are indices into aContent[]. The values in
  51690. ** aList[] are to be sorted so that for all J<K:
  51691. **
  51692. ** aContent[aList[J]] < aContent[aList[K]]
  51693. **
  51694. ** For any X and Y such that
  51695. **
  51696. ** aContent[aList[X]] == aContent[aList[Y]]
  51697. **
  51698. ** Keep the larger of the two values aList[X] and aList[Y] and discard
  51699. ** the smaller.
  51700. */
  51701. static void walMergesort(
  51702. const u32 *aContent, /* Pages in wal */
  51703. ht_slot *aBuffer, /* Buffer of at least *pnList items to use */
  51704. ht_slot *aList, /* IN/OUT: List to sort */
  51705. int *pnList /* IN/OUT: Number of elements in aList[] */
  51706. ){
  51707. struct Sublist {
  51708. int nList; /* Number of elements in aList */
  51709. ht_slot *aList; /* Pointer to sub-list content */
  51710. };
  51711. const int nList = *pnList; /* Size of input list */
  51712. int nMerge = 0; /* Number of elements in list aMerge */
  51713. ht_slot *aMerge = 0; /* List to be merged */
  51714. int iList; /* Index into input list */
  51715. u32 iSub = 0; /* Index into aSub array */
  51716. struct Sublist aSub[13]; /* Array of sub-lists */
  51717. memset(aSub, 0, sizeof(aSub));
  51718. assert( nList<=HASHTABLE_NPAGE && nList>0 );
  51719. assert( HASHTABLE_NPAGE==(1<<(ArraySize(aSub)-1)) );
  51720. for(iList=0; iList<nList; iList++){
  51721. nMerge = 1;
  51722. aMerge = &aList[iList];
  51723. for(iSub=0; iList & (1<<iSub); iSub++){
  51724. struct Sublist *p;
  51725. assert( iSub<ArraySize(aSub) );
  51726. p = &aSub[iSub];
  51727. assert( p->aList && p->nList<=(1<<iSub) );
  51728. assert( p->aList==&aList[iList&~((2<<iSub)-1)] );
  51729. walMerge(aContent, p->aList, p->nList, &aMerge, &nMerge, aBuffer);
  51730. }
  51731. aSub[iSub].aList = aMerge;
  51732. aSub[iSub].nList = nMerge;
  51733. }
  51734. for(iSub++; iSub<ArraySize(aSub); iSub++){
  51735. if( nList & (1<<iSub) ){
  51736. struct Sublist *p;
  51737. assert( iSub<ArraySize(aSub) );
  51738. p = &aSub[iSub];
  51739. assert( p->nList<=(1<<iSub) );
  51740. assert( p->aList==&aList[nList&~((2<<iSub)-1)] );
  51741. walMerge(aContent, p->aList, p->nList, &aMerge, &nMerge, aBuffer);
  51742. }
  51743. }
  51744. assert( aMerge==aList );
  51745. *pnList = nMerge;
  51746. #ifdef SQLITE_DEBUG
  51747. {
  51748. int i;
  51749. for(i=1; i<*pnList; i++){
  51750. assert( aContent[aList[i]] > aContent[aList[i-1]] );
  51751. }
  51752. }
  51753. #endif
  51754. }
  51755. /*
  51756. ** Free an iterator allocated by walIteratorInit().
  51757. */
  51758. static void walIteratorFree(WalIterator *p){
  51759. sqlite3_free(p);
  51760. }
  51761. /*
  51762. ** Construct a WalInterator object that can be used to loop over all
  51763. ** pages in the WAL in ascending order. The caller must hold the checkpoint
  51764. ** lock.
  51765. **
  51766. ** On success, make *pp point to the newly allocated WalInterator object
  51767. ** return SQLITE_OK. Otherwise, return an error code. If this routine
  51768. ** returns an error, the value of *pp is undefined.
  51769. **
  51770. ** The calling routine should invoke walIteratorFree() to destroy the
  51771. ** WalIterator object when it has finished with it.
  51772. */
  51773. static int walIteratorInit(Wal *pWal, WalIterator **pp){
  51774. WalIterator *p; /* Return value */
  51775. int nSegment; /* Number of segments to merge */
  51776. u32 iLast; /* Last frame in log */
  51777. int nByte; /* Number of bytes to allocate */
  51778. int i; /* Iterator variable */
  51779. ht_slot *aTmp; /* Temp space used by merge-sort */
  51780. int rc = SQLITE_OK; /* Return Code */
  51781. /* This routine only runs while holding the checkpoint lock. And
  51782. ** it only runs if there is actually content in the log (mxFrame>0).
  51783. */
  51784. assert( pWal->ckptLock && pWal->hdr.mxFrame>0 );
  51785. iLast = pWal->hdr.mxFrame;
  51786. /* Allocate space for the WalIterator object. */
  51787. nSegment = walFramePage(iLast) + 1;
  51788. nByte = sizeof(WalIterator)
  51789. + (nSegment-1)*sizeof(struct WalSegment)
  51790. + iLast*sizeof(ht_slot);
  51791. p = (WalIterator *)sqlite3_malloc64(nByte);
  51792. if( !p ){
  51793. return SQLITE_NOMEM_BKPT;
  51794. }
  51795. memset(p, 0, nByte);
  51796. p->nSegment = nSegment;
  51797. /* Allocate temporary space used by the merge-sort routine. This block
  51798. ** of memory will be freed before this function returns.
  51799. */
  51800. aTmp = (ht_slot *)sqlite3_malloc64(
  51801. sizeof(ht_slot) * (iLast>HASHTABLE_NPAGE?HASHTABLE_NPAGE:iLast)
  51802. );
  51803. if( !aTmp ){
  51804. rc = SQLITE_NOMEM_BKPT;
  51805. }
  51806. for(i=0; rc==SQLITE_OK && i<nSegment; i++){
  51807. volatile ht_slot *aHash;
  51808. u32 iZero;
  51809. volatile u32 *aPgno;
  51810. rc = walHashGet(pWal, i, &aHash, &aPgno, &iZero);
  51811. if( rc==SQLITE_OK ){
  51812. int j; /* Counter variable */
  51813. int nEntry; /* Number of entries in this segment */
  51814. ht_slot *aIndex; /* Sorted index for this segment */
  51815. aPgno++;
  51816. if( (i+1)==nSegment ){
  51817. nEntry = (int)(iLast - iZero);
  51818. }else{
  51819. nEntry = (int)((u32*)aHash - (u32*)aPgno);
  51820. }
  51821. aIndex = &((ht_slot *)&p->aSegment[p->nSegment])[iZero];
  51822. iZero++;
  51823. for(j=0; j<nEntry; j++){
  51824. aIndex[j] = (ht_slot)j;
  51825. }
  51826. walMergesort((u32 *)aPgno, aTmp, aIndex, &nEntry);
  51827. p->aSegment[i].iZero = iZero;
  51828. p->aSegment[i].nEntry = nEntry;
  51829. p->aSegment[i].aIndex = aIndex;
  51830. p->aSegment[i].aPgno = (u32 *)aPgno;
  51831. }
  51832. }
  51833. sqlite3_free(aTmp);
  51834. if( rc!=SQLITE_OK ){
  51835. walIteratorFree(p);
  51836. }
  51837. *pp = p;
  51838. return rc;
  51839. }
  51840. /*
  51841. ** Attempt to obtain the exclusive WAL lock defined by parameters lockIdx and
  51842. ** n. If the attempt fails and parameter xBusy is not NULL, then it is a
  51843. ** busy-handler function. Invoke it and retry the lock until either the
  51844. ** lock is successfully obtained or the busy-handler returns 0.
  51845. */
  51846. static int walBusyLock(
  51847. Wal *pWal, /* WAL connection */
  51848. int (*xBusy)(void*), /* Function to call when busy */
  51849. void *pBusyArg, /* Context argument for xBusyHandler */
  51850. int lockIdx, /* Offset of first byte to lock */
  51851. int n /* Number of bytes to lock */
  51852. ){
  51853. int rc;
  51854. do {
  51855. rc = walLockExclusive(pWal, lockIdx, n);
  51856. }while( xBusy && rc==SQLITE_BUSY && xBusy(pBusyArg) );
  51857. return rc;
  51858. }
  51859. /*
  51860. ** The cache of the wal-index header must be valid to call this function.
  51861. ** Return the page-size in bytes used by the database.
  51862. */
  51863. static int walPagesize(Wal *pWal){
  51864. return (pWal->hdr.szPage&0xfe00) + ((pWal->hdr.szPage&0x0001)<<16);
  51865. }
  51866. /*
  51867. ** The following is guaranteed when this function is called:
  51868. **
  51869. ** a) the WRITER lock is held,
  51870. ** b) the entire log file has been checkpointed, and
  51871. ** c) any existing readers are reading exclusively from the database
  51872. ** file - there are no readers that may attempt to read a frame from
  51873. ** the log file.
  51874. **
  51875. ** This function updates the shared-memory structures so that the next
  51876. ** client to write to the database (which may be this one) does so by
  51877. ** writing frames into the start of the log file.
  51878. **
  51879. ** The value of parameter salt1 is used as the aSalt[1] value in the
  51880. ** new wal-index header. It should be passed a pseudo-random value (i.e.
  51881. ** one obtained from sqlite3_randomness()).
  51882. */
  51883. static void walRestartHdr(Wal *pWal, u32 salt1){
  51884. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  51885. int i; /* Loop counter */
  51886. u32 *aSalt = pWal->hdr.aSalt; /* Big-endian salt values */
  51887. pWal->nCkpt++;
  51888. pWal->hdr.mxFrame = 0;
  51889. sqlite3Put4byte((u8*)&aSalt[0], 1 + sqlite3Get4byte((u8*)&aSalt[0]));
  51890. memcpy(&pWal->hdr.aSalt[1], &salt1, 4);
  51891. walIndexWriteHdr(pWal);
  51892. pInfo->nBackfill = 0;
  51893. pInfo->nBackfillAttempted = 0;
  51894. pInfo->aReadMark[1] = 0;
  51895. for(i=2; i<WAL_NREADER; i++) pInfo->aReadMark[i] = READMARK_NOT_USED;
  51896. assert( pInfo->aReadMark[0]==0 );
  51897. }
  51898. /*
  51899. ** Copy as much content as we can from the WAL back into the database file
  51900. ** in response to an sqlite3_wal_checkpoint() request or the equivalent.
  51901. **
  51902. ** The amount of information copies from WAL to database might be limited
  51903. ** by active readers. This routine will never overwrite a database page
  51904. ** that a concurrent reader might be using.
  51905. **
  51906. ** All I/O barrier operations (a.k.a fsyncs) occur in this routine when
  51907. ** SQLite is in WAL-mode in synchronous=NORMAL. That means that if
  51908. ** checkpoints are always run by a background thread or background
  51909. ** process, foreground threads will never block on a lengthy fsync call.
  51910. **
  51911. ** Fsync is called on the WAL before writing content out of the WAL and
  51912. ** into the database. This ensures that if the new content is persistent
  51913. ** in the WAL and can be recovered following a power-loss or hard reset.
  51914. **
  51915. ** Fsync is also called on the database file if (and only if) the entire
  51916. ** WAL content is copied into the database file. This second fsync makes
  51917. ** it safe to delete the WAL since the new content will persist in the
  51918. ** database file.
  51919. **
  51920. ** This routine uses and updates the nBackfill field of the wal-index header.
  51921. ** This is the only routine that will increase the value of nBackfill.
  51922. ** (A WAL reset or recovery will revert nBackfill to zero, but not increase
  51923. ** its value.)
  51924. **
  51925. ** The caller must be holding sufficient locks to ensure that no other
  51926. ** checkpoint is running (in any other thread or process) at the same
  51927. ** time.
  51928. */
  51929. static int walCheckpoint(
  51930. Wal *pWal, /* Wal connection */
  51931. int eMode, /* One of PASSIVE, FULL or RESTART */
  51932. int (*xBusy)(void*), /* Function to call when busy */
  51933. void *pBusyArg, /* Context argument for xBusyHandler */
  51934. int sync_flags, /* Flags for OsSync() (or 0) */
  51935. u8 *zBuf /* Temporary buffer to use */
  51936. ){
  51937. int rc = SQLITE_OK; /* Return code */
  51938. int szPage; /* Database page-size */
  51939. WalIterator *pIter = 0; /* Wal iterator context */
  51940. u32 iDbpage = 0; /* Next database page to write */
  51941. u32 iFrame = 0; /* Wal frame containing data for iDbpage */
  51942. u32 mxSafeFrame; /* Max frame that can be backfilled */
  51943. u32 mxPage; /* Max database page to write */
  51944. int i; /* Loop counter */
  51945. volatile WalCkptInfo *pInfo; /* The checkpoint status information */
  51946. szPage = walPagesize(pWal);
  51947. testcase( szPage<=32768 );
  51948. testcase( szPage>=65536 );
  51949. pInfo = walCkptInfo(pWal);
  51950. if( pInfo->nBackfill<pWal->hdr.mxFrame ){
  51951. /* Allocate the iterator */
  51952. rc = walIteratorInit(pWal, &pIter);
  51953. if( rc!=SQLITE_OK ){
  51954. return rc;
  51955. }
  51956. assert( pIter );
  51957. /* EVIDENCE-OF: R-62920-47450 The busy-handler callback is never invoked
  51958. ** in the SQLITE_CHECKPOINT_PASSIVE mode. */
  51959. assert( eMode!=SQLITE_CHECKPOINT_PASSIVE || xBusy==0 );
  51960. /* Compute in mxSafeFrame the index of the last frame of the WAL that is
  51961. ** safe to write into the database. Frames beyond mxSafeFrame might
  51962. ** overwrite database pages that are in use by active readers and thus
  51963. ** cannot be backfilled from the WAL.
  51964. */
  51965. mxSafeFrame = pWal->hdr.mxFrame;
  51966. mxPage = pWal->hdr.nPage;
  51967. for(i=1; i<WAL_NREADER; i++){
  51968. /* Thread-sanitizer reports that the following is an unsafe read,
  51969. ** as some other thread may be in the process of updating the value
  51970. ** of the aReadMark[] slot. The assumption here is that if that is
  51971. ** happening, the other client may only be increasing the value,
  51972. ** not decreasing it. So assuming either that either the "old" or
  51973. ** "new" version of the value is read, and not some arbitrary value
  51974. ** that would never be written by a real client, things are still
  51975. ** safe. */
  51976. u32 y = pInfo->aReadMark[i];
  51977. if( mxSafeFrame>y ){
  51978. assert( y<=pWal->hdr.mxFrame );
  51979. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(i), 1);
  51980. if( rc==SQLITE_OK ){
  51981. pInfo->aReadMark[i] = (i==1 ? mxSafeFrame : READMARK_NOT_USED);
  51982. walUnlockExclusive(pWal, WAL_READ_LOCK(i), 1);
  51983. }else if( rc==SQLITE_BUSY ){
  51984. mxSafeFrame = y;
  51985. xBusy = 0;
  51986. }else{
  51987. goto walcheckpoint_out;
  51988. }
  51989. }
  51990. }
  51991. if( pInfo->nBackfill<mxSafeFrame
  51992. && (rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(0),1))==SQLITE_OK
  51993. ){
  51994. i64 nSize; /* Current size of database file */
  51995. u32 nBackfill = pInfo->nBackfill;
  51996. pInfo->nBackfillAttempted = mxSafeFrame;
  51997. /* Sync the WAL to disk */
  51998. if( sync_flags ){
  51999. rc = sqlite3OsSync(pWal->pWalFd, sync_flags);
  52000. }
  52001. /* If the database may grow as a result of this checkpoint, hint
  52002. ** about the eventual size of the db file to the VFS layer.
  52003. */
  52004. if( rc==SQLITE_OK ){
  52005. i64 nReq = ((i64)mxPage * szPage);
  52006. rc = sqlite3OsFileSize(pWal->pDbFd, &nSize);
  52007. if( rc==SQLITE_OK && nSize<nReq ){
  52008. sqlite3OsFileControlHint(pWal->pDbFd, SQLITE_FCNTL_SIZE_HINT, &nReq);
  52009. }
  52010. }
  52011. /* Iterate through the contents of the WAL, copying data to the db file */
  52012. while( rc==SQLITE_OK && 0==walIteratorNext(pIter, &iDbpage, &iFrame) ){
  52013. i64 iOffset;
  52014. assert( walFramePgno(pWal, iFrame)==iDbpage );
  52015. if( iFrame<=nBackfill || iFrame>mxSafeFrame || iDbpage>mxPage ){
  52016. continue;
  52017. }
  52018. iOffset = walFrameOffset(iFrame, szPage) + WAL_FRAME_HDRSIZE;
  52019. /* testcase( IS_BIG_INT(iOffset) ); // requires a 4GiB WAL file */
  52020. rc = sqlite3OsRead(pWal->pWalFd, zBuf, szPage, iOffset);
  52021. if( rc!=SQLITE_OK ) break;
  52022. iOffset = (iDbpage-1)*(i64)szPage;
  52023. testcase( IS_BIG_INT(iOffset) );
  52024. rc = sqlite3OsWrite(pWal->pDbFd, zBuf, szPage, iOffset);
  52025. if( rc!=SQLITE_OK ) break;
  52026. }
  52027. /* If work was actually accomplished... */
  52028. if( rc==SQLITE_OK ){
  52029. if( mxSafeFrame==walIndexHdr(pWal)->mxFrame ){
  52030. i64 szDb = pWal->hdr.nPage*(i64)szPage;
  52031. testcase( IS_BIG_INT(szDb) );
  52032. rc = sqlite3OsTruncate(pWal->pDbFd, szDb);
  52033. if( rc==SQLITE_OK && sync_flags ){
  52034. rc = sqlite3OsSync(pWal->pDbFd, sync_flags);
  52035. }
  52036. }
  52037. if( rc==SQLITE_OK ){
  52038. pInfo->nBackfill = mxSafeFrame;
  52039. }
  52040. }
  52041. /* Release the reader lock held while backfilling */
  52042. walUnlockExclusive(pWal, WAL_READ_LOCK(0), 1);
  52043. }
  52044. if( rc==SQLITE_BUSY ){
  52045. /* Reset the return code so as not to report a checkpoint failure
  52046. ** just because there are active readers. */
  52047. rc = SQLITE_OK;
  52048. }
  52049. }
  52050. /* If this is an SQLITE_CHECKPOINT_RESTART or TRUNCATE operation, and the
  52051. ** entire wal file has been copied into the database file, then block
  52052. ** until all readers have finished using the wal file. This ensures that
  52053. ** the next process to write to the database restarts the wal file.
  52054. */
  52055. if( rc==SQLITE_OK && eMode!=SQLITE_CHECKPOINT_PASSIVE ){
  52056. assert( pWal->writeLock );
  52057. if( pInfo->nBackfill<pWal->hdr.mxFrame ){
  52058. rc = SQLITE_BUSY;
  52059. }else if( eMode>=SQLITE_CHECKPOINT_RESTART ){
  52060. u32 salt1;
  52061. sqlite3_randomness(4, &salt1);
  52062. assert( pInfo->nBackfill==pWal->hdr.mxFrame );
  52063. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(1), WAL_NREADER-1);
  52064. if( rc==SQLITE_OK ){
  52065. if( eMode==SQLITE_CHECKPOINT_TRUNCATE ){
  52066. /* IMPLEMENTATION-OF: R-44699-57140 This mode works the same way as
  52067. ** SQLITE_CHECKPOINT_RESTART with the addition that it also
  52068. ** truncates the log file to zero bytes just prior to a
  52069. ** successful return.
  52070. **
  52071. ** In theory, it might be safe to do this without updating the
  52072. ** wal-index header in shared memory, as all subsequent reader or
  52073. ** writer clients should see that the entire log file has been
  52074. ** checkpointed and behave accordingly. This seems unsafe though,
  52075. ** as it would leave the system in a state where the contents of
  52076. ** the wal-index header do not match the contents of the
  52077. ** file-system. To avoid this, update the wal-index header to
  52078. ** indicate that the log file contains zero valid frames. */
  52079. walRestartHdr(pWal, salt1);
  52080. rc = sqlite3OsTruncate(pWal->pWalFd, 0);
  52081. }
  52082. walUnlockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  52083. }
  52084. }
  52085. }
  52086. walcheckpoint_out:
  52087. walIteratorFree(pIter);
  52088. return rc;
  52089. }
  52090. /*
  52091. ** If the WAL file is currently larger than nMax bytes in size, truncate
  52092. ** it to exactly nMax bytes. If an error occurs while doing so, ignore it.
  52093. */
  52094. static void walLimitSize(Wal *pWal, i64 nMax){
  52095. i64 sz;
  52096. int rx;
  52097. sqlite3BeginBenignMalloc();
  52098. rx = sqlite3OsFileSize(pWal->pWalFd, &sz);
  52099. if( rx==SQLITE_OK && (sz > nMax ) ){
  52100. rx = sqlite3OsTruncate(pWal->pWalFd, nMax);
  52101. }
  52102. sqlite3EndBenignMalloc();
  52103. if( rx ){
  52104. sqlite3_log(rx, "cannot limit WAL size: %s", pWal->zWalName);
  52105. }
  52106. }
  52107. /*
  52108. ** Close a connection to a log file.
  52109. */
  52110. SQLITE_PRIVATE int sqlite3WalClose(
  52111. Wal *pWal, /* Wal to close */
  52112. int sync_flags, /* Flags to pass to OsSync() (or 0) */
  52113. int nBuf,
  52114. u8 *zBuf /* Buffer of at least nBuf bytes */
  52115. ){
  52116. int rc = SQLITE_OK;
  52117. if( pWal ){
  52118. int isDelete = 0; /* True to unlink wal and wal-index files */
  52119. /* If an EXCLUSIVE lock can be obtained on the database file (using the
  52120. ** ordinary, rollback-mode locking methods, this guarantees that the
  52121. ** connection associated with this log file is the only connection to
  52122. ** the database. In this case checkpoint the database and unlink both
  52123. ** the wal and wal-index files.
  52124. **
  52125. ** The EXCLUSIVE lock is not released before returning.
  52126. */
  52127. rc = sqlite3OsLock(pWal->pDbFd, SQLITE_LOCK_EXCLUSIVE);
  52128. if( rc==SQLITE_OK ){
  52129. if( pWal->exclusiveMode==WAL_NORMAL_MODE ){
  52130. pWal->exclusiveMode = WAL_EXCLUSIVE_MODE;
  52131. }
  52132. rc = sqlite3WalCheckpoint(
  52133. pWal, SQLITE_CHECKPOINT_PASSIVE, 0, 0, sync_flags, nBuf, zBuf, 0, 0
  52134. );
  52135. if( rc==SQLITE_OK ){
  52136. int bPersist = -1;
  52137. sqlite3OsFileControlHint(
  52138. pWal->pDbFd, SQLITE_FCNTL_PERSIST_WAL, &bPersist
  52139. );
  52140. if( bPersist!=1 ){
  52141. /* Try to delete the WAL file if the checkpoint completed and
  52142. ** fsyned (rc==SQLITE_OK) and if we are not in persistent-wal
  52143. ** mode (!bPersist) */
  52144. isDelete = 1;
  52145. }else if( pWal->mxWalSize>=0 ){
  52146. /* Try to truncate the WAL file to zero bytes if the checkpoint
  52147. ** completed and fsynced (rc==SQLITE_OK) and we are in persistent
  52148. ** WAL mode (bPersist) and if the PRAGMA journal_size_limit is a
  52149. ** non-negative value (pWal->mxWalSize>=0). Note that we truncate
  52150. ** to zero bytes as truncating to the journal_size_limit might
  52151. ** leave a corrupt WAL file on disk. */
  52152. walLimitSize(pWal, 0);
  52153. }
  52154. }
  52155. }
  52156. walIndexClose(pWal, isDelete);
  52157. sqlite3OsClose(pWal->pWalFd);
  52158. if( isDelete ){
  52159. sqlite3BeginBenignMalloc();
  52160. sqlite3OsDelete(pWal->pVfs, pWal->zWalName, 0);
  52161. sqlite3EndBenignMalloc();
  52162. }
  52163. WALTRACE(("WAL%p: closed\n", pWal));
  52164. sqlite3_free((void *)pWal->apWiData);
  52165. sqlite3_free(pWal);
  52166. }
  52167. return rc;
  52168. }
  52169. /*
  52170. ** Try to read the wal-index header. Return 0 on success and 1 if
  52171. ** there is a problem.
  52172. **
  52173. ** The wal-index is in shared memory. Another thread or process might
  52174. ** be writing the header at the same time this procedure is trying to
  52175. ** read it, which might result in inconsistency. A dirty read is detected
  52176. ** by verifying that both copies of the header are the same and also by
  52177. ** a checksum on the header.
  52178. **
  52179. ** If and only if the read is consistent and the header is different from
  52180. ** pWal->hdr, then pWal->hdr is updated to the content of the new header
  52181. ** and *pChanged is set to 1.
  52182. **
  52183. ** If the checksum cannot be verified return non-zero. If the header
  52184. ** is read successfully and the checksum verified, return zero.
  52185. */
  52186. static int walIndexTryHdr(Wal *pWal, int *pChanged){
  52187. u32 aCksum[2]; /* Checksum on the header content */
  52188. WalIndexHdr h1, h2; /* Two copies of the header content */
  52189. WalIndexHdr volatile *aHdr; /* Header in shared memory */
  52190. /* The first page of the wal-index must be mapped at this point. */
  52191. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  52192. /* Read the header. This might happen concurrently with a write to the
  52193. ** same area of shared memory on a different CPU in a SMP,
  52194. ** meaning it is possible that an inconsistent snapshot is read
  52195. ** from the file. If this happens, return non-zero.
  52196. **
  52197. ** There are two copies of the header at the beginning of the wal-index.
  52198. ** When reading, read [0] first then [1]. Writes are in the reverse order.
  52199. ** Memory barriers are used to prevent the compiler or the hardware from
  52200. ** reordering the reads and writes.
  52201. */
  52202. aHdr = walIndexHdr(pWal);
  52203. memcpy(&h1, (void *)&aHdr[0], sizeof(h1));
  52204. walShmBarrier(pWal);
  52205. memcpy(&h2, (void *)&aHdr[1], sizeof(h2));
  52206. if( memcmp(&h1, &h2, sizeof(h1))!=0 ){
  52207. return 1; /* Dirty read */
  52208. }
  52209. if( h1.isInit==0 ){
  52210. return 1; /* Malformed header - probably all zeros */
  52211. }
  52212. walChecksumBytes(1, (u8*)&h1, sizeof(h1)-sizeof(h1.aCksum), 0, aCksum);
  52213. if( aCksum[0]!=h1.aCksum[0] || aCksum[1]!=h1.aCksum[1] ){
  52214. return 1; /* Checksum does not match */
  52215. }
  52216. if( memcmp(&pWal->hdr, &h1, sizeof(WalIndexHdr)) ){
  52217. *pChanged = 1;
  52218. memcpy(&pWal->hdr, &h1, sizeof(WalIndexHdr));
  52219. pWal->szPage = (pWal->hdr.szPage&0xfe00) + ((pWal->hdr.szPage&0x0001)<<16);
  52220. testcase( pWal->szPage<=32768 );
  52221. testcase( pWal->szPage>=65536 );
  52222. }
  52223. /* The header was successfully read. Return zero. */
  52224. return 0;
  52225. }
  52226. /*
  52227. ** Read the wal-index header from the wal-index and into pWal->hdr.
  52228. ** If the wal-header appears to be corrupt, try to reconstruct the
  52229. ** wal-index from the WAL before returning.
  52230. **
  52231. ** Set *pChanged to 1 if the wal-index header value in pWal->hdr is
  52232. ** changed by this operation. If pWal->hdr is unchanged, set *pChanged
  52233. ** to 0.
  52234. **
  52235. ** If the wal-index header is successfully read, return SQLITE_OK.
  52236. ** Otherwise an SQLite error code.
  52237. */
  52238. static int walIndexReadHdr(Wal *pWal, int *pChanged){
  52239. int rc; /* Return code */
  52240. int badHdr; /* True if a header read failed */
  52241. volatile u32 *page0; /* Chunk of wal-index containing header */
  52242. /* Ensure that page 0 of the wal-index (the page that contains the
  52243. ** wal-index header) is mapped. Return early if an error occurs here.
  52244. */
  52245. assert( pChanged );
  52246. rc = walIndexPage(pWal, 0, &page0);
  52247. if( rc!=SQLITE_OK ){
  52248. return rc;
  52249. };
  52250. assert( page0 || pWal->writeLock==0 );
  52251. /* If the first page of the wal-index has been mapped, try to read the
  52252. ** wal-index header immediately, without holding any lock. This usually
  52253. ** works, but may fail if the wal-index header is corrupt or currently
  52254. ** being modified by another thread or process.
  52255. */
  52256. badHdr = (page0 ? walIndexTryHdr(pWal, pChanged) : 1);
  52257. /* If the first attempt failed, it might have been due to a race
  52258. ** with a writer. So get a WRITE lock and try again.
  52259. */
  52260. assert( badHdr==0 || pWal->writeLock==0 );
  52261. if( badHdr ){
  52262. if( pWal->readOnly & WAL_SHM_RDONLY ){
  52263. if( SQLITE_OK==(rc = walLockShared(pWal, WAL_WRITE_LOCK)) ){
  52264. walUnlockShared(pWal, WAL_WRITE_LOCK);
  52265. rc = SQLITE_READONLY_RECOVERY;
  52266. }
  52267. }else if( SQLITE_OK==(rc = walLockExclusive(pWal, WAL_WRITE_LOCK, 1)) ){
  52268. pWal->writeLock = 1;
  52269. if( SQLITE_OK==(rc = walIndexPage(pWal, 0, &page0)) ){
  52270. badHdr = walIndexTryHdr(pWal, pChanged);
  52271. if( badHdr ){
  52272. /* If the wal-index header is still malformed even while holding
  52273. ** a WRITE lock, it can only mean that the header is corrupted and
  52274. ** needs to be reconstructed. So run recovery to do exactly that.
  52275. */
  52276. rc = walIndexRecover(pWal);
  52277. *pChanged = 1;
  52278. }
  52279. }
  52280. pWal->writeLock = 0;
  52281. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  52282. }
  52283. }
  52284. /* If the header is read successfully, check the version number to make
  52285. ** sure the wal-index was not constructed with some future format that
  52286. ** this version of SQLite cannot understand.
  52287. */
  52288. if( badHdr==0 && pWal->hdr.iVersion!=WALINDEX_MAX_VERSION ){
  52289. rc = SQLITE_CANTOPEN_BKPT;
  52290. }
  52291. return rc;
  52292. }
  52293. /*
  52294. ** This is the value that walTryBeginRead returns when it needs to
  52295. ** be retried.
  52296. */
  52297. #define WAL_RETRY (-1)
  52298. /*
  52299. ** Attempt to start a read transaction. This might fail due to a race or
  52300. ** other transient condition. When that happens, it returns WAL_RETRY to
  52301. ** indicate to the caller that it is safe to retry immediately.
  52302. **
  52303. ** On success return SQLITE_OK. On a permanent failure (such an
  52304. ** I/O error or an SQLITE_BUSY because another process is running
  52305. ** recovery) return a positive error code.
  52306. **
  52307. ** The useWal parameter is true to force the use of the WAL and disable
  52308. ** the case where the WAL is bypassed because it has been completely
  52309. ** checkpointed. If useWal==0 then this routine calls walIndexReadHdr()
  52310. ** to make a copy of the wal-index header into pWal->hdr. If the
  52311. ** wal-index header has changed, *pChanged is set to 1 (as an indication
  52312. ** to the caller that the local paget cache is obsolete and needs to be
  52313. ** flushed.) When useWal==1, the wal-index header is assumed to already
  52314. ** be loaded and the pChanged parameter is unused.
  52315. **
  52316. ** The caller must set the cnt parameter to the number of prior calls to
  52317. ** this routine during the current read attempt that returned WAL_RETRY.
  52318. ** This routine will start taking more aggressive measures to clear the
  52319. ** race conditions after multiple WAL_RETRY returns, and after an excessive
  52320. ** number of errors will ultimately return SQLITE_PROTOCOL. The
  52321. ** SQLITE_PROTOCOL return indicates that some other process has gone rogue
  52322. ** and is not honoring the locking protocol. There is a vanishingly small
  52323. ** chance that SQLITE_PROTOCOL could be returned because of a run of really
  52324. ** bad luck when there is lots of contention for the wal-index, but that
  52325. ** possibility is so small that it can be safely neglected, we believe.
  52326. **
  52327. ** On success, this routine obtains a read lock on
  52328. ** WAL_READ_LOCK(pWal->readLock). The pWal->readLock integer is
  52329. ** in the range 0 <= pWal->readLock < WAL_NREADER. If pWal->readLock==(-1)
  52330. ** that means the Wal does not hold any read lock. The reader must not
  52331. ** access any database page that is modified by a WAL frame up to and
  52332. ** including frame number aReadMark[pWal->readLock]. The reader will
  52333. ** use WAL frames up to and including pWal->hdr.mxFrame if pWal->readLock>0
  52334. ** Or if pWal->readLock==0, then the reader will ignore the WAL
  52335. ** completely and get all content directly from the database file.
  52336. ** If the useWal parameter is 1 then the WAL will never be ignored and
  52337. ** this routine will always set pWal->readLock>0 on success.
  52338. ** When the read transaction is completed, the caller must release the
  52339. ** lock on WAL_READ_LOCK(pWal->readLock) and set pWal->readLock to -1.
  52340. **
  52341. ** This routine uses the nBackfill and aReadMark[] fields of the header
  52342. ** to select a particular WAL_READ_LOCK() that strives to let the
  52343. ** checkpoint process do as much work as possible. This routine might
  52344. ** update values of the aReadMark[] array in the header, but if it does
  52345. ** so it takes care to hold an exclusive lock on the corresponding
  52346. ** WAL_READ_LOCK() while changing values.
  52347. */
  52348. static int walTryBeginRead(Wal *pWal, int *pChanged, int useWal, int cnt){
  52349. volatile WalCkptInfo *pInfo; /* Checkpoint information in wal-index */
  52350. u32 mxReadMark; /* Largest aReadMark[] value */
  52351. int mxI; /* Index of largest aReadMark[] value */
  52352. int i; /* Loop counter */
  52353. int rc = SQLITE_OK; /* Return code */
  52354. u32 mxFrame; /* Wal frame to lock to */
  52355. assert( pWal->readLock<0 ); /* Not currently locked */
  52356. /* Take steps to avoid spinning forever if there is a protocol error.
  52357. **
  52358. ** Circumstances that cause a RETRY should only last for the briefest
  52359. ** instances of time. No I/O or other system calls are done while the
  52360. ** locks are held, so the locks should not be held for very long. But
  52361. ** if we are unlucky, another process that is holding a lock might get
  52362. ** paged out or take a page-fault that is time-consuming to resolve,
  52363. ** during the few nanoseconds that it is holding the lock. In that case,
  52364. ** it might take longer than normal for the lock to free.
  52365. **
  52366. ** After 5 RETRYs, we begin calling sqlite3OsSleep(). The first few
  52367. ** calls to sqlite3OsSleep() have a delay of 1 microsecond. Really this
  52368. ** is more of a scheduler yield than an actual delay. But on the 10th
  52369. ** an subsequent retries, the delays start becoming longer and longer,
  52370. ** so that on the 100th (and last) RETRY we delay for 323 milliseconds.
  52371. ** The total delay time before giving up is less than 10 seconds.
  52372. */
  52373. if( cnt>5 ){
  52374. int nDelay = 1; /* Pause time in microseconds */
  52375. if( cnt>100 ){
  52376. VVA_ONLY( pWal->lockError = 1; )
  52377. return SQLITE_PROTOCOL;
  52378. }
  52379. if( cnt>=10 ) nDelay = (cnt-9)*(cnt-9)*39;
  52380. sqlite3OsSleep(pWal->pVfs, nDelay);
  52381. }
  52382. if( !useWal ){
  52383. rc = walIndexReadHdr(pWal, pChanged);
  52384. if( rc==SQLITE_BUSY ){
  52385. /* If there is not a recovery running in another thread or process
  52386. ** then convert BUSY errors to WAL_RETRY. If recovery is known to
  52387. ** be running, convert BUSY to BUSY_RECOVERY. There is a race here
  52388. ** which might cause WAL_RETRY to be returned even if BUSY_RECOVERY
  52389. ** would be technically correct. But the race is benign since with
  52390. ** WAL_RETRY this routine will be called again and will probably be
  52391. ** right on the second iteration.
  52392. */
  52393. if( pWal->apWiData[0]==0 ){
  52394. /* This branch is taken when the xShmMap() method returns SQLITE_BUSY.
  52395. ** We assume this is a transient condition, so return WAL_RETRY. The
  52396. ** xShmMap() implementation used by the default unix and win32 VFS
  52397. ** modules may return SQLITE_BUSY due to a race condition in the
  52398. ** code that determines whether or not the shared-memory region
  52399. ** must be zeroed before the requested page is returned.
  52400. */
  52401. rc = WAL_RETRY;
  52402. }else if( SQLITE_OK==(rc = walLockShared(pWal, WAL_RECOVER_LOCK)) ){
  52403. walUnlockShared(pWal, WAL_RECOVER_LOCK);
  52404. rc = WAL_RETRY;
  52405. }else if( rc==SQLITE_BUSY ){
  52406. rc = SQLITE_BUSY_RECOVERY;
  52407. }
  52408. }
  52409. if( rc!=SQLITE_OK ){
  52410. return rc;
  52411. }
  52412. }
  52413. pInfo = walCkptInfo(pWal);
  52414. if( !useWal && pInfo->nBackfill==pWal->hdr.mxFrame
  52415. #ifdef SQLITE_ENABLE_SNAPSHOT
  52416. && (pWal->pSnapshot==0 || pWal->hdr.mxFrame==0
  52417. || 0==memcmp(&pWal->hdr, pWal->pSnapshot, sizeof(WalIndexHdr)))
  52418. #endif
  52419. ){
  52420. /* The WAL has been completely backfilled (or it is empty).
  52421. ** and can be safely ignored.
  52422. */
  52423. rc = walLockShared(pWal, WAL_READ_LOCK(0));
  52424. walShmBarrier(pWal);
  52425. if( rc==SQLITE_OK ){
  52426. if( memcmp((void *)walIndexHdr(pWal), &pWal->hdr, sizeof(WalIndexHdr)) ){
  52427. /* It is not safe to allow the reader to continue here if frames
  52428. ** may have been appended to the log before READ_LOCK(0) was obtained.
  52429. ** When holding READ_LOCK(0), the reader ignores the entire log file,
  52430. ** which implies that the database file contains a trustworthy
  52431. ** snapshot. Since holding READ_LOCK(0) prevents a checkpoint from
  52432. ** happening, this is usually correct.
  52433. **
  52434. ** However, if frames have been appended to the log (or if the log
  52435. ** is wrapped and written for that matter) before the READ_LOCK(0)
  52436. ** is obtained, that is not necessarily true. A checkpointer may
  52437. ** have started to backfill the appended frames but crashed before
  52438. ** it finished. Leaving a corrupt image in the database file.
  52439. */
  52440. walUnlockShared(pWal, WAL_READ_LOCK(0));
  52441. return WAL_RETRY;
  52442. }
  52443. pWal->readLock = 0;
  52444. return SQLITE_OK;
  52445. }else if( rc!=SQLITE_BUSY ){
  52446. return rc;
  52447. }
  52448. }
  52449. /* If we get this far, it means that the reader will want to use
  52450. ** the WAL to get at content from recent commits. The job now is
  52451. ** to select one of the aReadMark[] entries that is closest to
  52452. ** but not exceeding pWal->hdr.mxFrame and lock that entry.
  52453. */
  52454. mxReadMark = 0;
  52455. mxI = 0;
  52456. mxFrame = pWal->hdr.mxFrame;
  52457. #ifdef SQLITE_ENABLE_SNAPSHOT
  52458. if( pWal->pSnapshot && pWal->pSnapshot->mxFrame<mxFrame ){
  52459. mxFrame = pWal->pSnapshot->mxFrame;
  52460. }
  52461. #endif
  52462. for(i=1; i<WAL_NREADER; i++){
  52463. u32 thisMark = pInfo->aReadMark[i];
  52464. if( mxReadMark<=thisMark && thisMark<=mxFrame ){
  52465. assert( thisMark!=READMARK_NOT_USED );
  52466. mxReadMark = thisMark;
  52467. mxI = i;
  52468. }
  52469. }
  52470. if( (pWal->readOnly & WAL_SHM_RDONLY)==0
  52471. && (mxReadMark<mxFrame || mxI==0)
  52472. ){
  52473. for(i=1; i<WAL_NREADER; i++){
  52474. rc = walLockExclusive(pWal, WAL_READ_LOCK(i), 1);
  52475. if( rc==SQLITE_OK ){
  52476. mxReadMark = pInfo->aReadMark[i] = mxFrame;
  52477. mxI = i;
  52478. walUnlockExclusive(pWal, WAL_READ_LOCK(i), 1);
  52479. break;
  52480. }else if( rc!=SQLITE_BUSY ){
  52481. return rc;
  52482. }
  52483. }
  52484. }
  52485. if( mxI==0 ){
  52486. assert( rc==SQLITE_BUSY || (pWal->readOnly & WAL_SHM_RDONLY)!=0 );
  52487. return rc==SQLITE_BUSY ? WAL_RETRY : SQLITE_READONLY_CANTLOCK;
  52488. }
  52489. rc = walLockShared(pWal, WAL_READ_LOCK(mxI));
  52490. if( rc ){
  52491. return rc==SQLITE_BUSY ? WAL_RETRY : rc;
  52492. }
  52493. /* Now that the read-lock has been obtained, check that neither the
  52494. ** value in the aReadMark[] array or the contents of the wal-index
  52495. ** header have changed.
  52496. **
  52497. ** It is necessary to check that the wal-index header did not change
  52498. ** between the time it was read and when the shared-lock was obtained
  52499. ** on WAL_READ_LOCK(mxI) was obtained to account for the possibility
  52500. ** that the log file may have been wrapped by a writer, or that frames
  52501. ** that occur later in the log than pWal->hdr.mxFrame may have been
  52502. ** copied into the database by a checkpointer. If either of these things
  52503. ** happened, then reading the database with the current value of
  52504. ** pWal->hdr.mxFrame risks reading a corrupted snapshot. So, retry
  52505. ** instead.
  52506. **
  52507. ** Before checking that the live wal-index header has not changed
  52508. ** since it was read, set Wal.minFrame to the first frame in the wal
  52509. ** file that has not yet been checkpointed. This client will not need
  52510. ** to read any frames earlier than minFrame from the wal file - they
  52511. ** can be safely read directly from the database file.
  52512. **
  52513. ** Because a ShmBarrier() call is made between taking the copy of
  52514. ** nBackfill and checking that the wal-header in shared-memory still
  52515. ** matches the one cached in pWal->hdr, it is guaranteed that the
  52516. ** checkpointer that set nBackfill was not working with a wal-index
  52517. ** header newer than that cached in pWal->hdr. If it were, that could
  52518. ** cause a problem. The checkpointer could omit to checkpoint
  52519. ** a version of page X that lies before pWal->minFrame (call that version
  52520. ** A) on the basis that there is a newer version (version B) of the same
  52521. ** page later in the wal file. But if version B happens to like past
  52522. ** frame pWal->hdr.mxFrame - then the client would incorrectly assume
  52523. ** that it can read version A from the database file. However, since
  52524. ** we can guarantee that the checkpointer that set nBackfill could not
  52525. ** see any pages past pWal->hdr.mxFrame, this problem does not come up.
  52526. */
  52527. pWal->minFrame = pInfo->nBackfill+1;
  52528. walShmBarrier(pWal);
  52529. if( pInfo->aReadMark[mxI]!=mxReadMark
  52530. || memcmp((void *)walIndexHdr(pWal), &pWal->hdr, sizeof(WalIndexHdr))
  52531. ){
  52532. walUnlockShared(pWal, WAL_READ_LOCK(mxI));
  52533. return WAL_RETRY;
  52534. }else{
  52535. assert( mxReadMark<=pWal->hdr.mxFrame );
  52536. pWal->readLock = (i16)mxI;
  52537. }
  52538. return rc;
  52539. }
  52540. /*
  52541. ** Begin a read transaction on the database.
  52542. **
  52543. ** This routine used to be called sqlite3OpenSnapshot() and with good reason:
  52544. ** it takes a snapshot of the state of the WAL and wal-index for the current
  52545. ** instant in time. The current thread will continue to use this snapshot.
  52546. ** Other threads might append new content to the WAL and wal-index but
  52547. ** that extra content is ignored by the current thread.
  52548. **
  52549. ** If the database contents have changes since the previous read
  52550. ** transaction, then *pChanged is set to 1 before returning. The
  52551. ** Pager layer will use this to know that is cache is stale and
  52552. ** needs to be flushed.
  52553. */
  52554. SQLITE_PRIVATE int sqlite3WalBeginReadTransaction(Wal *pWal, int *pChanged){
  52555. int rc; /* Return code */
  52556. int cnt = 0; /* Number of TryBeginRead attempts */
  52557. #ifdef SQLITE_ENABLE_SNAPSHOT
  52558. int bChanged = 0;
  52559. WalIndexHdr *pSnapshot = pWal->pSnapshot;
  52560. if( pSnapshot && memcmp(pSnapshot, &pWal->hdr, sizeof(WalIndexHdr))!=0 ){
  52561. bChanged = 1;
  52562. }
  52563. #endif
  52564. do{
  52565. rc = walTryBeginRead(pWal, pChanged, 0, ++cnt);
  52566. }while( rc==WAL_RETRY );
  52567. testcase( (rc&0xff)==SQLITE_BUSY );
  52568. testcase( (rc&0xff)==SQLITE_IOERR );
  52569. testcase( rc==SQLITE_PROTOCOL );
  52570. testcase( rc==SQLITE_OK );
  52571. #ifdef SQLITE_ENABLE_SNAPSHOT
  52572. if( rc==SQLITE_OK ){
  52573. if( pSnapshot && memcmp(pSnapshot, &pWal->hdr, sizeof(WalIndexHdr))!=0 ){
  52574. /* At this point the client has a lock on an aReadMark[] slot holding
  52575. ** a value equal to or smaller than pSnapshot->mxFrame, but pWal->hdr
  52576. ** is populated with the wal-index header corresponding to the head
  52577. ** of the wal file. Verify that pSnapshot is still valid before
  52578. ** continuing. Reasons why pSnapshot might no longer be valid:
  52579. **
  52580. ** (1) The WAL file has been reset since the snapshot was taken.
  52581. ** In this case, the salt will have changed.
  52582. **
  52583. ** (2) A checkpoint as been attempted that wrote frames past
  52584. ** pSnapshot->mxFrame into the database file. Note that the
  52585. ** checkpoint need not have completed for this to cause problems.
  52586. */
  52587. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  52588. assert( pWal->readLock>0 || pWal->hdr.mxFrame==0 );
  52589. assert( pInfo->aReadMark[pWal->readLock]<=pSnapshot->mxFrame );
  52590. /* It is possible that there is a checkpointer thread running
  52591. ** concurrent with this code. If this is the case, it may be that the
  52592. ** checkpointer has already determined that it will checkpoint
  52593. ** snapshot X, where X is later in the wal file than pSnapshot, but
  52594. ** has not yet set the pInfo->nBackfillAttempted variable to indicate
  52595. ** its intent. To avoid the race condition this leads to, ensure that
  52596. ** there is no checkpointer process by taking a shared CKPT lock
  52597. ** before checking pInfo->nBackfillAttempted. */
  52598. rc = walLockShared(pWal, WAL_CKPT_LOCK);
  52599. if( rc==SQLITE_OK ){
  52600. /* Check that the wal file has not been wrapped. Assuming that it has
  52601. ** not, also check that no checkpointer has attempted to checkpoint any
  52602. ** frames beyond pSnapshot->mxFrame. If either of these conditions are
  52603. ** true, return SQLITE_BUSY_SNAPSHOT. Otherwise, overwrite pWal->hdr
  52604. ** with *pSnapshot and set *pChanged as appropriate for opening the
  52605. ** snapshot. */
  52606. if( !memcmp(pSnapshot->aSalt, pWal->hdr.aSalt, sizeof(pWal->hdr.aSalt))
  52607. && pSnapshot->mxFrame>=pInfo->nBackfillAttempted
  52608. ){
  52609. assert( pWal->readLock>0 );
  52610. memcpy(&pWal->hdr, pSnapshot, sizeof(WalIndexHdr));
  52611. *pChanged = bChanged;
  52612. }else{
  52613. rc = SQLITE_BUSY_SNAPSHOT;
  52614. }
  52615. /* Release the shared CKPT lock obtained above. */
  52616. walUnlockShared(pWal, WAL_CKPT_LOCK);
  52617. }
  52618. if( rc!=SQLITE_OK ){
  52619. sqlite3WalEndReadTransaction(pWal);
  52620. }
  52621. }
  52622. }
  52623. #endif
  52624. return rc;
  52625. }
  52626. /*
  52627. ** Finish with a read transaction. All this does is release the
  52628. ** read-lock.
  52629. */
  52630. SQLITE_PRIVATE void sqlite3WalEndReadTransaction(Wal *pWal){
  52631. sqlite3WalEndWriteTransaction(pWal);
  52632. if( pWal->readLock>=0 ){
  52633. walUnlockShared(pWal, WAL_READ_LOCK(pWal->readLock));
  52634. pWal->readLock = -1;
  52635. }
  52636. }
  52637. /*
  52638. ** Search the wal file for page pgno. If found, set *piRead to the frame that
  52639. ** contains the page. Otherwise, if pgno is not in the wal file, set *piRead
  52640. ** to zero.
  52641. **
  52642. ** Return SQLITE_OK if successful, or an error code if an error occurs. If an
  52643. ** error does occur, the final value of *piRead is undefined.
  52644. */
  52645. SQLITE_PRIVATE int sqlite3WalFindFrame(
  52646. Wal *pWal, /* WAL handle */
  52647. Pgno pgno, /* Database page number to read data for */
  52648. u32 *piRead /* OUT: Frame number (or zero) */
  52649. ){
  52650. u32 iRead = 0; /* If !=0, WAL frame to return data from */
  52651. u32 iLast = pWal->hdr.mxFrame; /* Last page in WAL for this reader */
  52652. int iHash; /* Used to loop through N hash tables */
  52653. int iMinHash;
  52654. /* This routine is only be called from within a read transaction. */
  52655. assert( pWal->readLock>=0 || pWal->lockError );
  52656. /* If the "last page" field of the wal-index header snapshot is 0, then
  52657. ** no data will be read from the wal under any circumstances. Return early
  52658. ** in this case as an optimization. Likewise, if pWal->readLock==0,
  52659. ** then the WAL is ignored by the reader so return early, as if the
  52660. ** WAL were empty.
  52661. */
  52662. if( iLast==0 || pWal->readLock==0 ){
  52663. *piRead = 0;
  52664. return SQLITE_OK;
  52665. }
  52666. /* Search the hash table or tables for an entry matching page number
  52667. ** pgno. Each iteration of the following for() loop searches one
  52668. ** hash table (each hash table indexes up to HASHTABLE_NPAGE frames).
  52669. **
  52670. ** This code might run concurrently to the code in walIndexAppend()
  52671. ** that adds entries to the wal-index (and possibly to this hash
  52672. ** table). This means the value just read from the hash
  52673. ** slot (aHash[iKey]) may have been added before or after the
  52674. ** current read transaction was opened. Values added after the
  52675. ** read transaction was opened may have been written incorrectly -
  52676. ** i.e. these slots may contain garbage data. However, we assume
  52677. ** that any slots written before the current read transaction was
  52678. ** opened remain unmodified.
  52679. **
  52680. ** For the reasons above, the if(...) condition featured in the inner
  52681. ** loop of the following block is more stringent that would be required
  52682. ** if we had exclusive access to the hash-table:
  52683. **
  52684. ** (aPgno[iFrame]==pgno):
  52685. ** This condition filters out normal hash-table collisions.
  52686. **
  52687. ** (iFrame<=iLast):
  52688. ** This condition filters out entries that were added to the hash
  52689. ** table after the current read-transaction had started.
  52690. */
  52691. iMinHash = walFramePage(pWal->minFrame);
  52692. for(iHash=walFramePage(iLast); iHash>=iMinHash && iRead==0; iHash--){
  52693. volatile ht_slot *aHash; /* Pointer to hash table */
  52694. volatile u32 *aPgno; /* Pointer to array of page numbers */
  52695. u32 iZero; /* Frame number corresponding to aPgno[0] */
  52696. int iKey; /* Hash slot index */
  52697. int nCollide; /* Number of hash collisions remaining */
  52698. int rc; /* Error code */
  52699. rc = walHashGet(pWal, iHash, &aHash, &aPgno, &iZero);
  52700. if( rc!=SQLITE_OK ){
  52701. return rc;
  52702. }
  52703. nCollide = HASHTABLE_NSLOT;
  52704. for(iKey=walHash(pgno); aHash[iKey]; iKey=walNextHash(iKey)){
  52705. u32 iFrame = aHash[iKey] + iZero;
  52706. if( iFrame<=iLast && iFrame>=pWal->minFrame && aPgno[aHash[iKey]]==pgno ){
  52707. assert( iFrame>iRead || CORRUPT_DB );
  52708. iRead = iFrame;
  52709. }
  52710. if( (nCollide--)==0 ){
  52711. return SQLITE_CORRUPT_BKPT;
  52712. }
  52713. }
  52714. }
  52715. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  52716. /* If expensive assert() statements are available, do a linear search
  52717. ** of the wal-index file content. Make sure the results agree with the
  52718. ** result obtained using the hash indexes above. */
  52719. {
  52720. u32 iRead2 = 0;
  52721. u32 iTest;
  52722. assert( pWal->minFrame>0 );
  52723. for(iTest=iLast; iTest>=pWal->minFrame; iTest--){
  52724. if( walFramePgno(pWal, iTest)==pgno ){
  52725. iRead2 = iTest;
  52726. break;
  52727. }
  52728. }
  52729. assert( iRead==iRead2 );
  52730. }
  52731. #endif
  52732. *piRead = iRead;
  52733. return SQLITE_OK;
  52734. }
  52735. /*
  52736. ** Read the contents of frame iRead from the wal file into buffer pOut
  52737. ** (which is nOut bytes in size). Return SQLITE_OK if successful, or an
  52738. ** error code otherwise.
  52739. */
  52740. SQLITE_PRIVATE int sqlite3WalReadFrame(
  52741. Wal *pWal, /* WAL handle */
  52742. u32 iRead, /* Frame to read */
  52743. int nOut, /* Size of buffer pOut in bytes */
  52744. u8 *pOut /* Buffer to write page data to */
  52745. ){
  52746. int sz;
  52747. i64 iOffset;
  52748. sz = pWal->hdr.szPage;
  52749. sz = (sz&0xfe00) + ((sz&0x0001)<<16);
  52750. testcase( sz<=32768 );
  52751. testcase( sz>=65536 );
  52752. iOffset = walFrameOffset(iRead, sz) + WAL_FRAME_HDRSIZE;
  52753. /* testcase( IS_BIG_INT(iOffset) ); // requires a 4GiB WAL */
  52754. return sqlite3OsRead(pWal->pWalFd, pOut, (nOut>sz ? sz : nOut), iOffset);
  52755. }
  52756. /*
  52757. ** Return the size of the database in pages (or zero, if unknown).
  52758. */
  52759. SQLITE_PRIVATE Pgno sqlite3WalDbsize(Wal *pWal){
  52760. if( pWal && ALWAYS(pWal->readLock>=0) ){
  52761. return pWal->hdr.nPage;
  52762. }
  52763. return 0;
  52764. }
  52765. /*
  52766. ** This function starts a write transaction on the WAL.
  52767. **
  52768. ** A read transaction must have already been started by a prior call
  52769. ** to sqlite3WalBeginReadTransaction().
  52770. **
  52771. ** If another thread or process has written into the database since
  52772. ** the read transaction was started, then it is not possible for this
  52773. ** thread to write as doing so would cause a fork. So this routine
  52774. ** returns SQLITE_BUSY in that case and no write transaction is started.
  52775. **
  52776. ** There can only be a single writer active at a time.
  52777. */
  52778. SQLITE_PRIVATE int sqlite3WalBeginWriteTransaction(Wal *pWal){
  52779. int rc;
  52780. /* Cannot start a write transaction without first holding a read
  52781. ** transaction. */
  52782. assert( pWal->readLock>=0 );
  52783. assert( pWal->writeLock==0 && pWal->iReCksum==0 );
  52784. if( pWal->readOnly ){
  52785. return SQLITE_READONLY;
  52786. }
  52787. /* Only one writer allowed at a time. Get the write lock. Return
  52788. ** SQLITE_BUSY if unable.
  52789. */
  52790. rc = walLockExclusive(pWal, WAL_WRITE_LOCK, 1);
  52791. if( rc ){
  52792. return rc;
  52793. }
  52794. pWal->writeLock = 1;
  52795. /* If another connection has written to the database file since the
  52796. ** time the read transaction on this connection was started, then
  52797. ** the write is disallowed.
  52798. */
  52799. if( memcmp(&pWal->hdr, (void *)walIndexHdr(pWal), sizeof(WalIndexHdr))!=0 ){
  52800. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  52801. pWal->writeLock = 0;
  52802. rc = SQLITE_BUSY_SNAPSHOT;
  52803. }
  52804. return rc;
  52805. }
  52806. /*
  52807. ** End a write transaction. The commit has already been done. This
  52808. ** routine merely releases the lock.
  52809. */
  52810. SQLITE_PRIVATE int sqlite3WalEndWriteTransaction(Wal *pWal){
  52811. if( pWal->writeLock ){
  52812. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  52813. pWal->writeLock = 0;
  52814. pWal->iReCksum = 0;
  52815. pWal->truncateOnCommit = 0;
  52816. }
  52817. return SQLITE_OK;
  52818. }
  52819. /*
  52820. ** If any data has been written (but not committed) to the log file, this
  52821. ** function moves the write-pointer back to the start of the transaction.
  52822. **
  52823. ** Additionally, the callback function is invoked for each frame written
  52824. ** to the WAL since the start of the transaction. If the callback returns
  52825. ** other than SQLITE_OK, it is not invoked again and the error code is
  52826. ** returned to the caller.
  52827. **
  52828. ** Otherwise, if the callback function does not return an error, this
  52829. ** function returns SQLITE_OK.
  52830. */
  52831. SQLITE_PRIVATE int sqlite3WalUndo(Wal *pWal, int (*xUndo)(void *, Pgno), void *pUndoCtx){
  52832. int rc = SQLITE_OK;
  52833. if( ALWAYS(pWal->writeLock) ){
  52834. Pgno iMax = pWal->hdr.mxFrame;
  52835. Pgno iFrame;
  52836. /* Restore the clients cache of the wal-index header to the state it
  52837. ** was in before the client began writing to the database.
  52838. */
  52839. memcpy(&pWal->hdr, (void *)walIndexHdr(pWal), sizeof(WalIndexHdr));
  52840. for(iFrame=pWal->hdr.mxFrame+1;
  52841. ALWAYS(rc==SQLITE_OK) && iFrame<=iMax;
  52842. iFrame++
  52843. ){
  52844. /* This call cannot fail. Unless the page for which the page number
  52845. ** is passed as the second argument is (a) in the cache and
  52846. ** (b) has an outstanding reference, then xUndo is either a no-op
  52847. ** (if (a) is false) or simply expels the page from the cache (if (b)
  52848. ** is false).
  52849. **
  52850. ** If the upper layer is doing a rollback, it is guaranteed that there
  52851. ** are no outstanding references to any page other than page 1. And
  52852. ** page 1 is never written to the log until the transaction is
  52853. ** committed. As a result, the call to xUndo may not fail.
  52854. */
  52855. assert( walFramePgno(pWal, iFrame)!=1 );
  52856. rc = xUndo(pUndoCtx, walFramePgno(pWal, iFrame));
  52857. }
  52858. if( iMax!=pWal->hdr.mxFrame ) walCleanupHash(pWal);
  52859. }
  52860. return rc;
  52861. }
  52862. /*
  52863. ** Argument aWalData must point to an array of WAL_SAVEPOINT_NDATA u32
  52864. ** values. This function populates the array with values required to
  52865. ** "rollback" the write position of the WAL handle back to the current
  52866. ** point in the event of a savepoint rollback (via WalSavepointUndo()).
  52867. */
  52868. SQLITE_PRIVATE void sqlite3WalSavepoint(Wal *pWal, u32 *aWalData){
  52869. assert( pWal->writeLock );
  52870. aWalData[0] = pWal->hdr.mxFrame;
  52871. aWalData[1] = pWal->hdr.aFrameCksum[0];
  52872. aWalData[2] = pWal->hdr.aFrameCksum[1];
  52873. aWalData[3] = pWal->nCkpt;
  52874. }
  52875. /*
  52876. ** Move the write position of the WAL back to the point identified by
  52877. ** the values in the aWalData[] array. aWalData must point to an array
  52878. ** of WAL_SAVEPOINT_NDATA u32 values that has been previously populated
  52879. ** by a call to WalSavepoint().
  52880. */
  52881. SQLITE_PRIVATE int sqlite3WalSavepointUndo(Wal *pWal, u32 *aWalData){
  52882. int rc = SQLITE_OK;
  52883. assert( pWal->writeLock );
  52884. assert( aWalData[3]!=pWal->nCkpt || aWalData[0]<=pWal->hdr.mxFrame );
  52885. if( aWalData[3]!=pWal->nCkpt ){
  52886. /* This savepoint was opened immediately after the write-transaction
  52887. ** was started. Right after that, the writer decided to wrap around
  52888. ** to the start of the log. Update the savepoint values to match.
  52889. */
  52890. aWalData[0] = 0;
  52891. aWalData[3] = pWal->nCkpt;
  52892. }
  52893. if( aWalData[0]<pWal->hdr.mxFrame ){
  52894. pWal->hdr.mxFrame = aWalData[0];
  52895. pWal->hdr.aFrameCksum[0] = aWalData[1];
  52896. pWal->hdr.aFrameCksum[1] = aWalData[2];
  52897. walCleanupHash(pWal);
  52898. }
  52899. return rc;
  52900. }
  52901. /*
  52902. ** This function is called just before writing a set of frames to the log
  52903. ** file (see sqlite3WalFrames()). It checks to see if, instead of appending
  52904. ** to the current log file, it is possible to overwrite the start of the
  52905. ** existing log file with the new frames (i.e. "reset" the log). If so,
  52906. ** it sets pWal->hdr.mxFrame to 0. Otherwise, pWal->hdr.mxFrame is left
  52907. ** unchanged.
  52908. **
  52909. ** SQLITE_OK is returned if no error is encountered (regardless of whether
  52910. ** or not pWal->hdr.mxFrame is modified). An SQLite error code is returned
  52911. ** if an error occurs.
  52912. */
  52913. static int walRestartLog(Wal *pWal){
  52914. int rc = SQLITE_OK;
  52915. int cnt;
  52916. if( pWal->readLock==0 ){
  52917. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  52918. assert( pInfo->nBackfill==pWal->hdr.mxFrame );
  52919. if( pInfo->nBackfill>0 ){
  52920. u32 salt1;
  52921. sqlite3_randomness(4, &salt1);
  52922. rc = walLockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  52923. if( rc==SQLITE_OK ){
  52924. /* If all readers are using WAL_READ_LOCK(0) (in other words if no
  52925. ** readers are currently using the WAL), then the transactions
  52926. ** frames will overwrite the start of the existing log. Update the
  52927. ** wal-index header to reflect this.
  52928. **
  52929. ** In theory it would be Ok to update the cache of the header only
  52930. ** at this point. But updating the actual wal-index header is also
  52931. ** safe and means there is no special case for sqlite3WalUndo()
  52932. ** to handle if this transaction is rolled back. */
  52933. walRestartHdr(pWal, salt1);
  52934. walUnlockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  52935. }else if( rc!=SQLITE_BUSY ){
  52936. return rc;
  52937. }
  52938. }
  52939. walUnlockShared(pWal, WAL_READ_LOCK(0));
  52940. pWal->readLock = -1;
  52941. cnt = 0;
  52942. do{
  52943. int notUsed;
  52944. rc = walTryBeginRead(pWal, &notUsed, 1, ++cnt);
  52945. }while( rc==WAL_RETRY );
  52946. assert( (rc&0xff)!=SQLITE_BUSY ); /* BUSY not possible when useWal==1 */
  52947. testcase( (rc&0xff)==SQLITE_IOERR );
  52948. testcase( rc==SQLITE_PROTOCOL );
  52949. testcase( rc==SQLITE_OK );
  52950. }
  52951. return rc;
  52952. }
  52953. /*
  52954. ** Information about the current state of the WAL file and where
  52955. ** the next fsync should occur - passed from sqlite3WalFrames() into
  52956. ** walWriteToLog().
  52957. */
  52958. typedef struct WalWriter {
  52959. Wal *pWal; /* The complete WAL information */
  52960. sqlite3_file *pFd; /* The WAL file to which we write */
  52961. sqlite3_int64 iSyncPoint; /* Fsync at this offset */
  52962. int syncFlags; /* Flags for the fsync */
  52963. int szPage; /* Size of one page */
  52964. } WalWriter;
  52965. /*
  52966. ** Write iAmt bytes of content into the WAL file beginning at iOffset.
  52967. ** Do a sync when crossing the p->iSyncPoint boundary.
  52968. **
  52969. ** In other words, if iSyncPoint is in between iOffset and iOffset+iAmt,
  52970. ** first write the part before iSyncPoint, then sync, then write the
  52971. ** rest.
  52972. */
  52973. static int walWriteToLog(
  52974. WalWriter *p, /* WAL to write to */
  52975. void *pContent, /* Content to be written */
  52976. int iAmt, /* Number of bytes to write */
  52977. sqlite3_int64 iOffset /* Start writing at this offset */
  52978. ){
  52979. int rc;
  52980. if( iOffset<p->iSyncPoint && iOffset+iAmt>=p->iSyncPoint ){
  52981. int iFirstAmt = (int)(p->iSyncPoint - iOffset);
  52982. rc = sqlite3OsWrite(p->pFd, pContent, iFirstAmt, iOffset);
  52983. if( rc ) return rc;
  52984. iOffset += iFirstAmt;
  52985. iAmt -= iFirstAmt;
  52986. pContent = (void*)(iFirstAmt + (char*)pContent);
  52987. assert( p->syncFlags & (SQLITE_SYNC_NORMAL|SQLITE_SYNC_FULL) );
  52988. rc = sqlite3OsSync(p->pFd, p->syncFlags & SQLITE_SYNC_MASK);
  52989. if( iAmt==0 || rc ) return rc;
  52990. }
  52991. rc = sqlite3OsWrite(p->pFd, pContent, iAmt, iOffset);
  52992. return rc;
  52993. }
  52994. /*
  52995. ** Write out a single frame of the WAL
  52996. */
  52997. static int walWriteOneFrame(
  52998. WalWriter *p, /* Where to write the frame */
  52999. PgHdr *pPage, /* The page of the frame to be written */
  53000. int nTruncate, /* The commit flag. Usually 0. >0 for commit */
  53001. sqlite3_int64 iOffset /* Byte offset at which to write */
  53002. ){
  53003. int rc; /* Result code from subfunctions */
  53004. void *pData; /* Data actually written */
  53005. u8 aFrame[WAL_FRAME_HDRSIZE]; /* Buffer to assemble frame-header in */
  53006. #if defined(SQLITE_HAS_CODEC)
  53007. if( (pData = sqlite3PagerCodec(pPage))==0 ) return SQLITE_NOMEM_BKPT;
  53008. #else
  53009. pData = pPage->pData;
  53010. #endif
  53011. walEncodeFrame(p->pWal, pPage->pgno, nTruncate, pData, aFrame);
  53012. rc = walWriteToLog(p, aFrame, sizeof(aFrame), iOffset);
  53013. if( rc ) return rc;
  53014. /* Write the page data */
  53015. rc = walWriteToLog(p, pData, p->szPage, iOffset+sizeof(aFrame));
  53016. return rc;
  53017. }
  53018. /*
  53019. ** This function is called as part of committing a transaction within which
  53020. ** one or more frames have been overwritten. It updates the checksums for
  53021. ** all frames written to the wal file by the current transaction starting
  53022. ** with the earliest to have been overwritten.
  53023. **
  53024. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  53025. */
  53026. static int walRewriteChecksums(Wal *pWal, u32 iLast){
  53027. const int szPage = pWal->szPage;/* Database page size */
  53028. int rc = SQLITE_OK; /* Return code */
  53029. u8 *aBuf; /* Buffer to load data from wal file into */
  53030. u8 aFrame[WAL_FRAME_HDRSIZE]; /* Buffer to assemble frame-headers in */
  53031. u32 iRead; /* Next frame to read from wal file */
  53032. i64 iCksumOff;
  53033. aBuf = sqlite3_malloc(szPage + WAL_FRAME_HDRSIZE);
  53034. if( aBuf==0 ) return SQLITE_NOMEM_BKPT;
  53035. /* Find the checksum values to use as input for the recalculating the
  53036. ** first checksum. If the first frame is frame 1 (implying that the current
  53037. ** transaction restarted the wal file), these values must be read from the
  53038. ** wal-file header. Otherwise, read them from the frame header of the
  53039. ** previous frame. */
  53040. assert( pWal->iReCksum>0 );
  53041. if( pWal->iReCksum==1 ){
  53042. iCksumOff = 24;
  53043. }else{
  53044. iCksumOff = walFrameOffset(pWal->iReCksum-1, szPage) + 16;
  53045. }
  53046. rc = sqlite3OsRead(pWal->pWalFd, aBuf, sizeof(u32)*2, iCksumOff);
  53047. pWal->hdr.aFrameCksum[0] = sqlite3Get4byte(aBuf);
  53048. pWal->hdr.aFrameCksum[1] = sqlite3Get4byte(&aBuf[sizeof(u32)]);
  53049. iRead = pWal->iReCksum;
  53050. pWal->iReCksum = 0;
  53051. for(; rc==SQLITE_OK && iRead<=iLast; iRead++){
  53052. i64 iOff = walFrameOffset(iRead, szPage);
  53053. rc = sqlite3OsRead(pWal->pWalFd, aBuf, szPage+WAL_FRAME_HDRSIZE, iOff);
  53054. if( rc==SQLITE_OK ){
  53055. u32 iPgno, nDbSize;
  53056. iPgno = sqlite3Get4byte(aBuf);
  53057. nDbSize = sqlite3Get4byte(&aBuf[4]);
  53058. walEncodeFrame(pWal, iPgno, nDbSize, &aBuf[WAL_FRAME_HDRSIZE], aFrame);
  53059. rc = sqlite3OsWrite(pWal->pWalFd, aFrame, sizeof(aFrame), iOff);
  53060. }
  53061. }
  53062. sqlite3_free(aBuf);
  53063. return rc;
  53064. }
  53065. /*
  53066. ** Write a set of frames to the log. The caller must hold the write-lock
  53067. ** on the log file (obtained using sqlite3WalBeginWriteTransaction()).
  53068. */
  53069. SQLITE_PRIVATE int sqlite3WalFrames(
  53070. Wal *pWal, /* Wal handle to write to */
  53071. int szPage, /* Database page-size in bytes */
  53072. PgHdr *pList, /* List of dirty pages to write */
  53073. Pgno nTruncate, /* Database size after this commit */
  53074. int isCommit, /* True if this is a commit */
  53075. int sync_flags /* Flags to pass to OsSync() (or 0) */
  53076. ){
  53077. int rc; /* Used to catch return codes */
  53078. u32 iFrame; /* Next frame address */
  53079. PgHdr *p; /* Iterator to run through pList with. */
  53080. PgHdr *pLast = 0; /* Last frame in list */
  53081. int nExtra = 0; /* Number of extra copies of last page */
  53082. int szFrame; /* The size of a single frame */
  53083. i64 iOffset; /* Next byte to write in WAL file */
  53084. WalWriter w; /* The writer */
  53085. u32 iFirst = 0; /* First frame that may be overwritten */
  53086. WalIndexHdr *pLive; /* Pointer to shared header */
  53087. assert( pList );
  53088. assert( pWal->writeLock );
  53089. /* If this frame set completes a transaction, then nTruncate>0. If
  53090. ** nTruncate==0 then this frame set does not complete the transaction. */
  53091. assert( (isCommit!=0)==(nTruncate!=0) );
  53092. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  53093. { int cnt; for(cnt=0, p=pList; p; p=p->pDirty, cnt++){}
  53094. WALTRACE(("WAL%p: frame write begin. %d frames. mxFrame=%d. %s\n",
  53095. pWal, cnt, pWal->hdr.mxFrame, isCommit ? "Commit" : "Spill"));
  53096. }
  53097. #endif
  53098. pLive = (WalIndexHdr*)walIndexHdr(pWal);
  53099. if( memcmp(&pWal->hdr, (void *)pLive, sizeof(WalIndexHdr))!=0 ){
  53100. iFirst = pLive->mxFrame+1;
  53101. }
  53102. /* See if it is possible to write these frames into the start of the
  53103. ** log file, instead of appending to it at pWal->hdr.mxFrame.
  53104. */
  53105. if( SQLITE_OK!=(rc = walRestartLog(pWal)) ){
  53106. return rc;
  53107. }
  53108. /* If this is the first frame written into the log, write the WAL
  53109. ** header to the start of the WAL file. See comments at the top of
  53110. ** this source file for a description of the WAL header format.
  53111. */
  53112. iFrame = pWal->hdr.mxFrame;
  53113. if( iFrame==0 ){
  53114. u8 aWalHdr[WAL_HDRSIZE]; /* Buffer to assemble wal-header in */
  53115. u32 aCksum[2]; /* Checksum for wal-header */
  53116. sqlite3Put4byte(&aWalHdr[0], (WAL_MAGIC | SQLITE_BIGENDIAN));
  53117. sqlite3Put4byte(&aWalHdr[4], WAL_MAX_VERSION);
  53118. sqlite3Put4byte(&aWalHdr[8], szPage);
  53119. sqlite3Put4byte(&aWalHdr[12], pWal->nCkpt);
  53120. if( pWal->nCkpt==0 ) sqlite3_randomness(8, pWal->hdr.aSalt);
  53121. memcpy(&aWalHdr[16], pWal->hdr.aSalt, 8);
  53122. walChecksumBytes(1, aWalHdr, WAL_HDRSIZE-2*4, 0, aCksum);
  53123. sqlite3Put4byte(&aWalHdr[24], aCksum[0]);
  53124. sqlite3Put4byte(&aWalHdr[28], aCksum[1]);
  53125. pWal->szPage = szPage;
  53126. pWal->hdr.bigEndCksum = SQLITE_BIGENDIAN;
  53127. pWal->hdr.aFrameCksum[0] = aCksum[0];
  53128. pWal->hdr.aFrameCksum[1] = aCksum[1];
  53129. pWal->truncateOnCommit = 1;
  53130. rc = sqlite3OsWrite(pWal->pWalFd, aWalHdr, sizeof(aWalHdr), 0);
  53131. WALTRACE(("WAL%p: wal-header write %s\n", pWal, rc ? "failed" : "ok"));
  53132. if( rc!=SQLITE_OK ){
  53133. return rc;
  53134. }
  53135. /* Sync the header (unless SQLITE_IOCAP_SEQUENTIAL is true or unless
  53136. ** all syncing is turned off by PRAGMA synchronous=OFF). Otherwise
  53137. ** an out-of-order write following a WAL restart could result in
  53138. ** database corruption. See the ticket:
  53139. **
  53140. ** http://localhost:591/sqlite/info/ff5be73dee
  53141. */
  53142. if( pWal->syncHeader && sync_flags ){
  53143. rc = sqlite3OsSync(pWal->pWalFd, sync_flags & SQLITE_SYNC_MASK);
  53144. if( rc ) return rc;
  53145. }
  53146. }
  53147. assert( (int)pWal->szPage==szPage );
  53148. /* Setup information needed to write frames into the WAL */
  53149. w.pWal = pWal;
  53150. w.pFd = pWal->pWalFd;
  53151. w.iSyncPoint = 0;
  53152. w.syncFlags = sync_flags;
  53153. w.szPage = szPage;
  53154. iOffset = walFrameOffset(iFrame+1, szPage);
  53155. szFrame = szPage + WAL_FRAME_HDRSIZE;
  53156. /* Write all frames into the log file exactly once */
  53157. for(p=pList; p; p=p->pDirty){
  53158. int nDbSize; /* 0 normally. Positive == commit flag */
  53159. /* Check if this page has already been written into the wal file by
  53160. ** the current transaction. If so, overwrite the existing frame and
  53161. ** set Wal.writeLock to WAL_WRITELOCK_RECKSUM - indicating that
  53162. ** checksums must be recomputed when the transaction is committed. */
  53163. if( iFirst && (p->pDirty || isCommit==0) ){
  53164. u32 iWrite = 0;
  53165. VVA_ONLY(rc =) sqlite3WalFindFrame(pWal, p->pgno, &iWrite);
  53166. assert( rc==SQLITE_OK || iWrite==0 );
  53167. if( iWrite>=iFirst ){
  53168. i64 iOff = walFrameOffset(iWrite, szPage) + WAL_FRAME_HDRSIZE;
  53169. void *pData;
  53170. if( pWal->iReCksum==0 || iWrite<pWal->iReCksum ){
  53171. pWal->iReCksum = iWrite;
  53172. }
  53173. #if defined(SQLITE_HAS_CODEC)
  53174. if( (pData = sqlite3PagerCodec(p))==0 ) return SQLITE_NOMEM;
  53175. #else
  53176. pData = p->pData;
  53177. #endif
  53178. rc = sqlite3OsWrite(pWal->pWalFd, pData, szPage, iOff);
  53179. if( rc ) return rc;
  53180. p->flags &= ~PGHDR_WAL_APPEND;
  53181. continue;
  53182. }
  53183. }
  53184. iFrame++;
  53185. assert( iOffset==walFrameOffset(iFrame, szPage) );
  53186. nDbSize = (isCommit && p->pDirty==0) ? nTruncate : 0;
  53187. rc = walWriteOneFrame(&w, p, nDbSize, iOffset);
  53188. if( rc ) return rc;
  53189. pLast = p;
  53190. iOffset += szFrame;
  53191. p->flags |= PGHDR_WAL_APPEND;
  53192. }
  53193. /* Recalculate checksums within the wal file if required. */
  53194. if( isCommit && pWal->iReCksum ){
  53195. rc = walRewriteChecksums(pWal, iFrame);
  53196. if( rc ) return rc;
  53197. }
  53198. /* If this is the end of a transaction, then we might need to pad
  53199. ** the transaction and/or sync the WAL file.
  53200. **
  53201. ** Padding and syncing only occur if this set of frames complete a
  53202. ** transaction and if PRAGMA synchronous=FULL. If synchronous==NORMAL
  53203. ** or synchronous==OFF, then no padding or syncing are needed.
  53204. **
  53205. ** If SQLITE_IOCAP_POWERSAFE_OVERWRITE is defined, then padding is not
  53206. ** needed and only the sync is done. If padding is needed, then the
  53207. ** final frame is repeated (with its commit mark) until the next sector
  53208. ** boundary is crossed. Only the part of the WAL prior to the last
  53209. ** sector boundary is synced; the part of the last frame that extends
  53210. ** past the sector boundary is written after the sync.
  53211. */
  53212. if( isCommit && (sync_flags & WAL_SYNC_TRANSACTIONS)!=0 ){
  53213. int bSync = 1;
  53214. if( pWal->padToSectorBoundary ){
  53215. int sectorSize = sqlite3SectorSize(pWal->pWalFd);
  53216. w.iSyncPoint = ((iOffset+sectorSize-1)/sectorSize)*sectorSize;
  53217. bSync = (w.iSyncPoint==iOffset);
  53218. testcase( bSync );
  53219. while( iOffset<w.iSyncPoint ){
  53220. rc = walWriteOneFrame(&w, pLast, nTruncate, iOffset);
  53221. if( rc ) return rc;
  53222. iOffset += szFrame;
  53223. nExtra++;
  53224. }
  53225. }
  53226. if( bSync ){
  53227. assert( rc==SQLITE_OK );
  53228. rc = sqlite3OsSync(w.pFd, sync_flags & SQLITE_SYNC_MASK);
  53229. }
  53230. }
  53231. /* If this frame set completes the first transaction in the WAL and
  53232. ** if PRAGMA journal_size_limit is set, then truncate the WAL to the
  53233. ** journal size limit, if possible.
  53234. */
  53235. if( isCommit && pWal->truncateOnCommit && pWal->mxWalSize>=0 ){
  53236. i64 sz = pWal->mxWalSize;
  53237. if( walFrameOffset(iFrame+nExtra+1, szPage)>pWal->mxWalSize ){
  53238. sz = walFrameOffset(iFrame+nExtra+1, szPage);
  53239. }
  53240. walLimitSize(pWal, sz);
  53241. pWal->truncateOnCommit = 0;
  53242. }
  53243. /* Append data to the wal-index. It is not necessary to lock the
  53244. ** wal-index to do this as the SQLITE_SHM_WRITE lock held on the wal-index
  53245. ** guarantees that there are no other writers, and no data that may
  53246. ** be in use by existing readers is being overwritten.
  53247. */
  53248. iFrame = pWal->hdr.mxFrame;
  53249. for(p=pList; p && rc==SQLITE_OK; p=p->pDirty){
  53250. if( (p->flags & PGHDR_WAL_APPEND)==0 ) continue;
  53251. iFrame++;
  53252. rc = walIndexAppend(pWal, iFrame, p->pgno);
  53253. }
  53254. while( rc==SQLITE_OK && nExtra>0 ){
  53255. iFrame++;
  53256. nExtra--;
  53257. rc = walIndexAppend(pWal, iFrame, pLast->pgno);
  53258. }
  53259. if( rc==SQLITE_OK ){
  53260. /* Update the private copy of the header. */
  53261. pWal->hdr.szPage = (u16)((szPage&0xff00) | (szPage>>16));
  53262. testcase( szPage<=32768 );
  53263. testcase( szPage>=65536 );
  53264. pWal->hdr.mxFrame = iFrame;
  53265. if( isCommit ){
  53266. pWal->hdr.iChange++;
  53267. pWal->hdr.nPage = nTruncate;
  53268. }
  53269. /* If this is a commit, update the wal-index header too. */
  53270. if( isCommit ){
  53271. walIndexWriteHdr(pWal);
  53272. pWal->iCallback = iFrame;
  53273. }
  53274. }
  53275. WALTRACE(("WAL%p: frame write %s\n", pWal, rc ? "failed" : "ok"));
  53276. return rc;
  53277. }
  53278. /*
  53279. ** This routine is called to implement sqlite3_wal_checkpoint() and
  53280. ** related interfaces.
  53281. **
  53282. ** Obtain a CHECKPOINT lock and then backfill as much information as
  53283. ** we can from WAL into the database.
  53284. **
  53285. ** If parameter xBusy is not NULL, it is a pointer to a busy-handler
  53286. ** callback. In this case this function runs a blocking checkpoint.
  53287. */
  53288. SQLITE_PRIVATE int sqlite3WalCheckpoint(
  53289. Wal *pWal, /* Wal connection */
  53290. int eMode, /* PASSIVE, FULL, RESTART, or TRUNCATE */
  53291. int (*xBusy)(void*), /* Function to call when busy */
  53292. void *pBusyArg, /* Context argument for xBusyHandler */
  53293. int sync_flags, /* Flags to sync db file with (or 0) */
  53294. int nBuf, /* Size of temporary buffer */
  53295. u8 *zBuf, /* Temporary buffer to use */
  53296. int *pnLog, /* OUT: Number of frames in WAL */
  53297. int *pnCkpt /* OUT: Number of backfilled frames in WAL */
  53298. ){
  53299. int rc; /* Return code */
  53300. int isChanged = 0; /* True if a new wal-index header is loaded */
  53301. int eMode2 = eMode; /* Mode to pass to walCheckpoint() */
  53302. int (*xBusy2)(void*) = xBusy; /* Busy handler for eMode2 */
  53303. assert( pWal->ckptLock==0 );
  53304. assert( pWal->writeLock==0 );
  53305. /* EVIDENCE-OF: R-62920-47450 The busy-handler callback is never invoked
  53306. ** in the SQLITE_CHECKPOINT_PASSIVE mode. */
  53307. assert( eMode!=SQLITE_CHECKPOINT_PASSIVE || xBusy==0 );
  53308. if( pWal->readOnly ) return SQLITE_READONLY;
  53309. WALTRACE(("WAL%p: checkpoint begins\n", pWal));
  53310. /* IMPLEMENTATION-OF: R-62028-47212 All calls obtain an exclusive
  53311. ** "checkpoint" lock on the database file. */
  53312. rc = walLockExclusive(pWal, WAL_CKPT_LOCK, 1);
  53313. if( rc ){
  53314. /* EVIDENCE-OF: R-10421-19736 If any other process is running a
  53315. ** checkpoint operation at the same time, the lock cannot be obtained and
  53316. ** SQLITE_BUSY is returned.
  53317. ** EVIDENCE-OF: R-53820-33897 Even if there is a busy-handler configured,
  53318. ** it will not be invoked in this case.
  53319. */
  53320. testcase( rc==SQLITE_BUSY );
  53321. testcase( xBusy!=0 );
  53322. return rc;
  53323. }
  53324. pWal->ckptLock = 1;
  53325. /* IMPLEMENTATION-OF: R-59782-36818 The SQLITE_CHECKPOINT_FULL, RESTART and
  53326. ** TRUNCATE modes also obtain the exclusive "writer" lock on the database
  53327. ** file.
  53328. **
  53329. ** EVIDENCE-OF: R-60642-04082 If the writer lock cannot be obtained
  53330. ** immediately, and a busy-handler is configured, it is invoked and the
  53331. ** writer lock retried until either the busy-handler returns 0 or the
  53332. ** lock is successfully obtained.
  53333. */
  53334. if( eMode!=SQLITE_CHECKPOINT_PASSIVE ){
  53335. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_WRITE_LOCK, 1);
  53336. if( rc==SQLITE_OK ){
  53337. pWal->writeLock = 1;
  53338. }else if( rc==SQLITE_BUSY ){
  53339. eMode2 = SQLITE_CHECKPOINT_PASSIVE;
  53340. xBusy2 = 0;
  53341. rc = SQLITE_OK;
  53342. }
  53343. }
  53344. /* Read the wal-index header. */
  53345. if( rc==SQLITE_OK ){
  53346. rc = walIndexReadHdr(pWal, &isChanged);
  53347. if( isChanged && pWal->pDbFd->pMethods->iVersion>=3 ){
  53348. sqlite3OsUnfetch(pWal->pDbFd, 0, 0);
  53349. }
  53350. }
  53351. /* Copy data from the log to the database file. */
  53352. if( rc==SQLITE_OK ){
  53353. if( pWal->hdr.mxFrame && walPagesize(pWal)!=nBuf ){
  53354. rc = SQLITE_CORRUPT_BKPT;
  53355. }else{
  53356. rc = walCheckpoint(pWal, eMode2, xBusy2, pBusyArg, sync_flags, zBuf);
  53357. }
  53358. /* If no error occurred, set the output variables. */
  53359. if( rc==SQLITE_OK || rc==SQLITE_BUSY ){
  53360. if( pnLog ) *pnLog = (int)pWal->hdr.mxFrame;
  53361. if( pnCkpt ) *pnCkpt = (int)(walCkptInfo(pWal)->nBackfill);
  53362. }
  53363. }
  53364. if( isChanged ){
  53365. /* If a new wal-index header was loaded before the checkpoint was
  53366. ** performed, then the pager-cache associated with pWal is now
  53367. ** out of date. So zero the cached wal-index header to ensure that
  53368. ** next time the pager opens a snapshot on this database it knows that
  53369. ** the cache needs to be reset.
  53370. */
  53371. memset(&pWal->hdr, 0, sizeof(WalIndexHdr));
  53372. }
  53373. /* Release the locks. */
  53374. sqlite3WalEndWriteTransaction(pWal);
  53375. walUnlockExclusive(pWal, WAL_CKPT_LOCK, 1);
  53376. pWal->ckptLock = 0;
  53377. WALTRACE(("WAL%p: checkpoint %s\n", pWal, rc ? "failed" : "ok"));
  53378. return (rc==SQLITE_OK && eMode!=eMode2 ? SQLITE_BUSY : rc);
  53379. }
  53380. /* Return the value to pass to a sqlite3_wal_hook callback, the
  53381. ** number of frames in the WAL at the point of the last commit since
  53382. ** sqlite3WalCallback() was called. If no commits have occurred since
  53383. ** the last call, then return 0.
  53384. */
  53385. SQLITE_PRIVATE int sqlite3WalCallback(Wal *pWal){
  53386. u32 ret = 0;
  53387. if( pWal ){
  53388. ret = pWal->iCallback;
  53389. pWal->iCallback = 0;
  53390. }
  53391. return (int)ret;
  53392. }
  53393. /*
  53394. ** This function is called to change the WAL subsystem into or out
  53395. ** of locking_mode=EXCLUSIVE.
  53396. **
  53397. ** If op is zero, then attempt to change from locking_mode=EXCLUSIVE
  53398. ** into locking_mode=NORMAL. This means that we must acquire a lock
  53399. ** on the pWal->readLock byte. If the WAL is already in locking_mode=NORMAL
  53400. ** or if the acquisition of the lock fails, then return 0. If the
  53401. ** transition out of exclusive-mode is successful, return 1. This
  53402. ** operation must occur while the pager is still holding the exclusive
  53403. ** lock on the main database file.
  53404. **
  53405. ** If op is one, then change from locking_mode=NORMAL into
  53406. ** locking_mode=EXCLUSIVE. This means that the pWal->readLock must
  53407. ** be released. Return 1 if the transition is made and 0 if the
  53408. ** WAL is already in exclusive-locking mode - meaning that this
  53409. ** routine is a no-op. The pager must already hold the exclusive lock
  53410. ** on the main database file before invoking this operation.
  53411. **
  53412. ** If op is negative, then do a dry-run of the op==1 case but do
  53413. ** not actually change anything. The pager uses this to see if it
  53414. ** should acquire the database exclusive lock prior to invoking
  53415. ** the op==1 case.
  53416. */
  53417. SQLITE_PRIVATE int sqlite3WalExclusiveMode(Wal *pWal, int op){
  53418. int rc;
  53419. assert( pWal->writeLock==0 );
  53420. assert( pWal->exclusiveMode!=WAL_HEAPMEMORY_MODE || op==-1 );
  53421. /* pWal->readLock is usually set, but might be -1 if there was a
  53422. ** prior error while attempting to acquire are read-lock. This cannot
  53423. ** happen if the connection is actually in exclusive mode (as no xShmLock
  53424. ** locks are taken in this case). Nor should the pager attempt to
  53425. ** upgrade to exclusive-mode following such an error.
  53426. */
  53427. assert( pWal->readLock>=0 || pWal->lockError );
  53428. assert( pWal->readLock>=0 || (op<=0 && pWal->exclusiveMode==0) );
  53429. if( op==0 ){
  53430. if( pWal->exclusiveMode ){
  53431. pWal->exclusiveMode = 0;
  53432. if( walLockShared(pWal, WAL_READ_LOCK(pWal->readLock))!=SQLITE_OK ){
  53433. pWal->exclusiveMode = 1;
  53434. }
  53435. rc = pWal->exclusiveMode==0;
  53436. }else{
  53437. /* Already in locking_mode=NORMAL */
  53438. rc = 0;
  53439. }
  53440. }else if( op>0 ){
  53441. assert( pWal->exclusiveMode==0 );
  53442. assert( pWal->readLock>=0 );
  53443. walUnlockShared(pWal, WAL_READ_LOCK(pWal->readLock));
  53444. pWal->exclusiveMode = 1;
  53445. rc = 1;
  53446. }else{
  53447. rc = pWal->exclusiveMode==0;
  53448. }
  53449. return rc;
  53450. }
  53451. /*
  53452. ** Return true if the argument is non-NULL and the WAL module is using
  53453. ** heap-memory for the wal-index. Otherwise, if the argument is NULL or the
  53454. ** WAL module is using shared-memory, return false.
  53455. */
  53456. SQLITE_PRIVATE int sqlite3WalHeapMemory(Wal *pWal){
  53457. return (pWal && pWal->exclusiveMode==WAL_HEAPMEMORY_MODE );
  53458. }
  53459. #ifdef SQLITE_ENABLE_SNAPSHOT
  53460. /* Create a snapshot object. The content of a snapshot is opaque to
  53461. ** every other subsystem, so the WAL module can put whatever it needs
  53462. ** in the object.
  53463. */
  53464. SQLITE_PRIVATE int sqlite3WalSnapshotGet(Wal *pWal, sqlite3_snapshot **ppSnapshot){
  53465. int rc = SQLITE_OK;
  53466. WalIndexHdr *pRet;
  53467. assert( pWal->readLock>=0 && pWal->writeLock==0 );
  53468. pRet = (WalIndexHdr*)sqlite3_malloc(sizeof(WalIndexHdr));
  53469. if( pRet==0 ){
  53470. rc = SQLITE_NOMEM_BKPT;
  53471. }else{
  53472. memcpy(pRet, &pWal->hdr, sizeof(WalIndexHdr));
  53473. *ppSnapshot = (sqlite3_snapshot*)pRet;
  53474. }
  53475. return rc;
  53476. }
  53477. /* Try to open on pSnapshot when the next read-transaction starts
  53478. */
  53479. SQLITE_PRIVATE void sqlite3WalSnapshotOpen(Wal *pWal, sqlite3_snapshot *pSnapshot){
  53480. pWal->pSnapshot = (WalIndexHdr*)pSnapshot;
  53481. }
  53482. /*
  53483. ** Return a +ve value if snapshot p1 is newer than p2. A -ve value if
  53484. ** p1 is older than p2 and zero if p1 and p2 are the same snapshot.
  53485. */
  53486. SQLITE_API int sqlite3_snapshot_cmp(sqlite3_snapshot *p1, sqlite3_snapshot *p2){
  53487. WalIndexHdr *pHdr1 = (WalIndexHdr*)p1;
  53488. WalIndexHdr *pHdr2 = (WalIndexHdr*)p2;
  53489. /* aSalt[0] is a copy of the value stored in the wal file header. It
  53490. ** is incremented each time the wal file is restarted. */
  53491. if( pHdr1->aSalt[0]<pHdr2->aSalt[0] ) return -1;
  53492. if( pHdr1->aSalt[0]>pHdr2->aSalt[0] ) return +1;
  53493. if( pHdr1->mxFrame<pHdr2->mxFrame ) return -1;
  53494. if( pHdr1->mxFrame>pHdr2->mxFrame ) return +1;
  53495. return 0;
  53496. }
  53497. #endif /* SQLITE_ENABLE_SNAPSHOT */
  53498. #ifdef SQLITE_ENABLE_ZIPVFS
  53499. /*
  53500. ** If the argument is not NULL, it points to a Wal object that holds a
  53501. ** read-lock. This function returns the database page-size if it is known,
  53502. ** or zero if it is not (or if pWal is NULL).
  53503. */
  53504. SQLITE_PRIVATE int sqlite3WalFramesize(Wal *pWal){
  53505. assert( pWal==0 || pWal->readLock>=0 );
  53506. return (pWal ? pWal->szPage : 0);
  53507. }
  53508. #endif
  53509. /* Return the sqlite3_file object for the WAL file
  53510. */
  53511. SQLITE_PRIVATE sqlite3_file *sqlite3WalFile(Wal *pWal){
  53512. return pWal->pWalFd;
  53513. }
  53514. #endif /* #ifndef SQLITE_OMIT_WAL */
  53515. /************** End of wal.c *************************************************/
  53516. /************** Begin file btmutex.c *****************************************/
  53517. /*
  53518. ** 2007 August 27
  53519. **
  53520. ** The author disclaims copyright to this source code. In place of
  53521. ** a legal notice, here is a blessing:
  53522. **
  53523. ** May you do good and not evil.
  53524. ** May you find forgiveness for yourself and forgive others.
  53525. ** May you share freely, never taking more than you give.
  53526. **
  53527. *************************************************************************
  53528. **
  53529. ** This file contains code used to implement mutexes on Btree objects.
  53530. ** This code really belongs in btree.c. But btree.c is getting too
  53531. ** big and we want to break it down some. This packaged seemed like
  53532. ** a good breakout.
  53533. */
  53534. /************** Include btreeInt.h in the middle of btmutex.c ****************/
  53535. /************** Begin file btreeInt.h ****************************************/
  53536. /*
  53537. ** 2004 April 6
  53538. **
  53539. ** The author disclaims copyright to this source code. In place of
  53540. ** a legal notice, here is a blessing:
  53541. **
  53542. ** May you do good and not evil.
  53543. ** May you find forgiveness for yourself and forgive others.
  53544. ** May you share freely, never taking more than you give.
  53545. **
  53546. *************************************************************************
  53547. ** This file implements an external (disk-based) database using BTrees.
  53548. ** For a detailed discussion of BTrees, refer to
  53549. **
  53550. ** Donald E. Knuth, THE ART OF COMPUTER PROGRAMMING, Volume 3:
  53551. ** "Sorting And Searching", pages 473-480. Addison-Wesley
  53552. ** Publishing Company, Reading, Massachusetts.
  53553. **
  53554. ** The basic idea is that each page of the file contains N database
  53555. ** entries and N+1 pointers to subpages.
  53556. **
  53557. ** ----------------------------------------------------------------
  53558. ** | Ptr(0) | Key(0) | Ptr(1) | Key(1) | ... | Key(N-1) | Ptr(N) |
  53559. ** ----------------------------------------------------------------
  53560. **
  53561. ** All of the keys on the page that Ptr(0) points to have values less
  53562. ** than Key(0). All of the keys on page Ptr(1) and its subpages have
  53563. ** values greater than Key(0) and less than Key(1). All of the keys
  53564. ** on Ptr(N) and its subpages have values greater than Key(N-1). And
  53565. ** so forth.
  53566. **
  53567. ** Finding a particular key requires reading O(log(M)) pages from the
  53568. ** disk where M is the number of entries in the tree.
  53569. **
  53570. ** In this implementation, a single file can hold one or more separate
  53571. ** BTrees. Each BTree is identified by the index of its root page. The
  53572. ** key and data for any entry are combined to form the "payload". A
  53573. ** fixed amount of payload can be carried directly on the database
  53574. ** page. If the payload is larger than the preset amount then surplus
  53575. ** bytes are stored on overflow pages. The payload for an entry
  53576. ** and the preceding pointer are combined to form a "Cell". Each
  53577. ** page has a small header which contains the Ptr(N) pointer and other
  53578. ** information such as the size of key and data.
  53579. **
  53580. ** FORMAT DETAILS
  53581. **
  53582. ** The file is divided into pages. The first page is called page 1,
  53583. ** the second is page 2, and so forth. A page number of zero indicates
  53584. ** "no such page". The page size can be any power of 2 between 512 and 65536.
  53585. ** Each page can be either a btree page, a freelist page, an overflow
  53586. ** page, or a pointer-map page.
  53587. **
  53588. ** The first page is always a btree page. The first 100 bytes of the first
  53589. ** page contain a special header (the "file header") that describes the file.
  53590. ** The format of the file header is as follows:
  53591. **
  53592. ** OFFSET SIZE DESCRIPTION
  53593. ** 0 16 Header string: "SQLite format 3\000"
  53594. ** 16 2 Page size in bytes. (1 means 65536)
  53595. ** 18 1 File format write version
  53596. ** 19 1 File format read version
  53597. ** 20 1 Bytes of unused space at the end of each page
  53598. ** 21 1 Max embedded payload fraction (must be 64)
  53599. ** 22 1 Min embedded payload fraction (must be 32)
  53600. ** 23 1 Min leaf payload fraction (must be 32)
  53601. ** 24 4 File change counter
  53602. ** 28 4 Reserved for future use
  53603. ** 32 4 First freelist page
  53604. ** 36 4 Number of freelist pages in the file
  53605. ** 40 60 15 4-byte meta values passed to higher layers
  53606. **
  53607. ** 40 4 Schema cookie
  53608. ** 44 4 File format of schema layer
  53609. ** 48 4 Size of page cache
  53610. ** 52 4 Largest root-page (auto/incr_vacuum)
  53611. ** 56 4 1=UTF-8 2=UTF16le 3=UTF16be
  53612. ** 60 4 User version
  53613. ** 64 4 Incremental vacuum mode
  53614. ** 68 4 Application-ID
  53615. ** 72 20 unused
  53616. ** 92 4 The version-valid-for number
  53617. ** 96 4 SQLITE_VERSION_NUMBER
  53618. **
  53619. ** All of the integer values are big-endian (most significant byte first).
  53620. **
  53621. ** The file change counter is incremented when the database is changed
  53622. ** This counter allows other processes to know when the file has changed
  53623. ** and thus when they need to flush their cache.
  53624. **
  53625. ** The max embedded payload fraction is the amount of the total usable
  53626. ** space in a page that can be consumed by a single cell for standard
  53627. ** B-tree (non-LEAFDATA) tables. A value of 255 means 100%. The default
  53628. ** is to limit the maximum cell size so that at least 4 cells will fit
  53629. ** on one page. Thus the default max embedded payload fraction is 64.
  53630. **
  53631. ** If the payload for a cell is larger than the max payload, then extra
  53632. ** payload is spilled to overflow pages. Once an overflow page is allocated,
  53633. ** as many bytes as possible are moved into the overflow pages without letting
  53634. ** the cell size drop below the min embedded payload fraction.
  53635. **
  53636. ** The min leaf payload fraction is like the min embedded payload fraction
  53637. ** except that it applies to leaf nodes in a LEAFDATA tree. The maximum
  53638. ** payload fraction for a LEAFDATA tree is always 100% (or 255) and it
  53639. ** not specified in the header.
  53640. **
  53641. ** Each btree pages is divided into three sections: The header, the
  53642. ** cell pointer array, and the cell content area. Page 1 also has a 100-byte
  53643. ** file header that occurs before the page header.
  53644. **
  53645. ** |----------------|
  53646. ** | file header | 100 bytes. Page 1 only.
  53647. ** |----------------|
  53648. ** | page header | 8 bytes for leaves. 12 bytes for interior nodes
  53649. ** |----------------|
  53650. ** | cell pointer | | 2 bytes per cell. Sorted order.
  53651. ** | array | | Grows downward
  53652. ** | | v
  53653. ** |----------------|
  53654. ** | unallocated |
  53655. ** | space |
  53656. ** |----------------| ^ Grows upwards
  53657. ** | cell content | | Arbitrary order interspersed with freeblocks.
  53658. ** | area | | and free space fragments.
  53659. ** |----------------|
  53660. **
  53661. ** The page headers looks like this:
  53662. **
  53663. ** OFFSET SIZE DESCRIPTION
  53664. ** 0 1 Flags. 1: intkey, 2: zerodata, 4: leafdata, 8: leaf
  53665. ** 1 2 byte offset to the first freeblock
  53666. ** 3 2 number of cells on this page
  53667. ** 5 2 first byte of the cell content area
  53668. ** 7 1 number of fragmented free bytes
  53669. ** 8 4 Right child (the Ptr(N) value). Omitted on leaves.
  53670. **
  53671. ** The flags define the format of this btree page. The leaf flag means that
  53672. ** this page has no children. The zerodata flag means that this page carries
  53673. ** only keys and no data. The intkey flag means that the key is an integer
  53674. ** which is stored in the key size entry of the cell header rather than in
  53675. ** the payload area.
  53676. **
  53677. ** The cell pointer array begins on the first byte after the page header.
  53678. ** The cell pointer array contains zero or more 2-byte numbers which are
  53679. ** offsets from the beginning of the page to the cell content in the cell
  53680. ** content area. The cell pointers occur in sorted order. The system strives
  53681. ** to keep free space after the last cell pointer so that new cells can
  53682. ** be easily added without having to defragment the page.
  53683. **
  53684. ** Cell content is stored at the very end of the page and grows toward the
  53685. ** beginning of the page.
  53686. **
  53687. ** Unused space within the cell content area is collected into a linked list of
  53688. ** freeblocks. Each freeblock is at least 4 bytes in size. The byte offset
  53689. ** to the first freeblock is given in the header. Freeblocks occur in
  53690. ** increasing order. Because a freeblock must be at least 4 bytes in size,
  53691. ** any group of 3 or fewer unused bytes in the cell content area cannot
  53692. ** exist on the freeblock chain. A group of 3 or fewer free bytes is called
  53693. ** a fragment. The total number of bytes in all fragments is recorded.
  53694. ** in the page header at offset 7.
  53695. **
  53696. ** SIZE DESCRIPTION
  53697. ** 2 Byte offset of the next freeblock
  53698. ** 2 Bytes in this freeblock
  53699. **
  53700. ** Cells are of variable length. Cells are stored in the cell content area at
  53701. ** the end of the page. Pointers to the cells are in the cell pointer array
  53702. ** that immediately follows the page header. Cells is not necessarily
  53703. ** contiguous or in order, but cell pointers are contiguous and in order.
  53704. **
  53705. ** Cell content makes use of variable length integers. A variable
  53706. ** length integer is 1 to 9 bytes where the lower 7 bits of each
  53707. ** byte are used. The integer consists of all bytes that have bit 8 set and
  53708. ** the first byte with bit 8 clear. The most significant byte of the integer
  53709. ** appears first. A variable-length integer may not be more than 9 bytes long.
  53710. ** As a special case, all 8 bytes of the 9th byte are used as data. This
  53711. ** allows a 64-bit integer to be encoded in 9 bytes.
  53712. **
  53713. ** 0x00 becomes 0x00000000
  53714. ** 0x7f becomes 0x0000007f
  53715. ** 0x81 0x00 becomes 0x00000080
  53716. ** 0x82 0x00 becomes 0x00000100
  53717. ** 0x80 0x7f becomes 0x0000007f
  53718. ** 0x8a 0x91 0xd1 0xac 0x78 becomes 0x12345678
  53719. ** 0x81 0x81 0x81 0x81 0x01 becomes 0x10204081
  53720. **
  53721. ** Variable length integers are used for rowids and to hold the number of
  53722. ** bytes of key and data in a btree cell.
  53723. **
  53724. ** The content of a cell looks like this:
  53725. **
  53726. ** SIZE DESCRIPTION
  53727. ** 4 Page number of the left child. Omitted if leaf flag is set.
  53728. ** var Number of bytes of data. Omitted if the zerodata flag is set.
  53729. ** var Number of bytes of key. Or the key itself if intkey flag is set.
  53730. ** * Payload
  53731. ** 4 First page of the overflow chain. Omitted if no overflow
  53732. **
  53733. ** Overflow pages form a linked list. Each page except the last is completely
  53734. ** filled with data (pagesize - 4 bytes). The last page can have as little
  53735. ** as 1 byte of data.
  53736. **
  53737. ** SIZE DESCRIPTION
  53738. ** 4 Page number of next overflow page
  53739. ** * Data
  53740. **
  53741. ** Freelist pages come in two subtypes: trunk pages and leaf pages. The
  53742. ** file header points to the first in a linked list of trunk page. Each trunk
  53743. ** page points to multiple leaf pages. The content of a leaf page is
  53744. ** unspecified. A trunk page looks like this:
  53745. **
  53746. ** SIZE DESCRIPTION
  53747. ** 4 Page number of next trunk page
  53748. ** 4 Number of leaf pointers on this page
  53749. ** * zero or more pages numbers of leaves
  53750. */
  53751. /* #include "sqliteInt.h" */
  53752. /* The following value is the maximum cell size assuming a maximum page
  53753. ** size give above.
  53754. */
  53755. #define MX_CELL_SIZE(pBt) ((int)(pBt->pageSize-8))
  53756. /* The maximum number of cells on a single page of the database. This
  53757. ** assumes a minimum cell size of 6 bytes (4 bytes for the cell itself
  53758. ** plus 2 bytes for the index to the cell in the page header). Such
  53759. ** small cells will be rare, but they are possible.
  53760. */
  53761. #define MX_CELL(pBt) ((pBt->pageSize-8)/6)
  53762. /* Forward declarations */
  53763. typedef struct MemPage MemPage;
  53764. typedef struct BtLock BtLock;
  53765. typedef struct CellInfo CellInfo;
  53766. /*
  53767. ** This is a magic string that appears at the beginning of every
  53768. ** SQLite database in order to identify the file as a real database.
  53769. **
  53770. ** You can change this value at compile-time by specifying a
  53771. ** -DSQLITE_FILE_HEADER="..." on the compiler command-line. The
  53772. ** header must be exactly 16 bytes including the zero-terminator so
  53773. ** the string itself should be 15 characters long. If you change
  53774. ** the header, then your custom library will not be able to read
  53775. ** databases generated by the standard tools and the standard tools
  53776. ** will not be able to read databases created by your custom library.
  53777. */
  53778. #ifndef SQLITE_FILE_HEADER /* 123456789 123456 */
  53779. # define SQLITE_FILE_HEADER "SQLite format 3"
  53780. #endif
  53781. /*
  53782. ** Page type flags. An ORed combination of these flags appear as the
  53783. ** first byte of on-disk image of every BTree page.
  53784. */
  53785. #define PTF_INTKEY 0x01
  53786. #define PTF_ZERODATA 0x02
  53787. #define PTF_LEAFDATA 0x04
  53788. #define PTF_LEAF 0x08
  53789. /*
  53790. ** As each page of the file is loaded into memory, an instance of the following
  53791. ** structure is appended and initialized to zero. This structure stores
  53792. ** information about the page that is decoded from the raw file page.
  53793. **
  53794. ** The pParent field points back to the parent page. This allows us to
  53795. ** walk up the BTree from any leaf to the root. Care must be taken to
  53796. ** unref() the parent page pointer when this page is no longer referenced.
  53797. ** The pageDestructor() routine handles that chore.
  53798. **
  53799. ** Access to all fields of this structure is controlled by the mutex
  53800. ** stored in MemPage.pBt->mutex.
  53801. */
  53802. struct MemPage {
  53803. u8 isInit; /* True if previously initialized. MUST BE FIRST! */
  53804. u8 nOverflow; /* Number of overflow cell bodies in aCell[] */
  53805. u8 intKey; /* True if table b-trees. False for index b-trees */
  53806. u8 intKeyLeaf; /* True if the leaf of an intKey table */
  53807. u8 leaf; /* True if a leaf page */
  53808. u8 hdrOffset; /* 100 for page 1. 0 otherwise */
  53809. u8 childPtrSize; /* 0 if leaf==1. 4 if leaf==0 */
  53810. u8 max1bytePayload; /* min(maxLocal,127) */
  53811. u8 bBusy; /* Prevent endless loops on corrupt database files */
  53812. u16 maxLocal; /* Copy of BtShared.maxLocal or BtShared.maxLeaf */
  53813. u16 minLocal; /* Copy of BtShared.minLocal or BtShared.minLeaf */
  53814. u16 cellOffset; /* Index in aData of first cell pointer */
  53815. u16 nFree; /* Number of free bytes on the page */
  53816. u16 nCell; /* Number of cells on this page, local and ovfl */
  53817. u16 maskPage; /* Mask for page offset */
  53818. u16 aiOvfl[5]; /* Insert the i-th overflow cell before the aiOvfl-th
  53819. ** non-overflow cell */
  53820. u8 *apOvfl[5]; /* Pointers to the body of overflow cells */
  53821. BtShared *pBt; /* Pointer to BtShared that this page is part of */
  53822. u8 *aData; /* Pointer to disk image of the page data */
  53823. u8 *aDataEnd; /* One byte past the end of usable data */
  53824. u8 *aCellIdx; /* The cell index area */
  53825. u8 *aDataOfst; /* Same as aData for leaves. aData+4 for interior */
  53826. DbPage *pDbPage; /* Pager page handle */
  53827. u16 (*xCellSize)(MemPage*,u8*); /* cellSizePtr method */
  53828. void (*xParseCell)(MemPage*,u8*,CellInfo*); /* btreeParseCell method */
  53829. Pgno pgno; /* Page number for this page */
  53830. };
  53831. /*
  53832. ** The in-memory image of a disk page has the auxiliary information appended
  53833. ** to the end. EXTRA_SIZE is the number of bytes of space needed to hold
  53834. ** that extra information.
  53835. */
  53836. #define EXTRA_SIZE sizeof(MemPage)
  53837. /*
  53838. ** A linked list of the following structures is stored at BtShared.pLock.
  53839. ** Locks are added (or upgraded from READ_LOCK to WRITE_LOCK) when a cursor
  53840. ** is opened on the table with root page BtShared.iTable. Locks are removed
  53841. ** from this list when a transaction is committed or rolled back, or when
  53842. ** a btree handle is closed.
  53843. */
  53844. struct BtLock {
  53845. Btree *pBtree; /* Btree handle holding this lock */
  53846. Pgno iTable; /* Root page of table */
  53847. u8 eLock; /* READ_LOCK or WRITE_LOCK */
  53848. BtLock *pNext; /* Next in BtShared.pLock list */
  53849. };
  53850. /* Candidate values for BtLock.eLock */
  53851. #define READ_LOCK 1
  53852. #define WRITE_LOCK 2
  53853. /* A Btree handle
  53854. **
  53855. ** A database connection contains a pointer to an instance of
  53856. ** this object for every database file that it has open. This structure
  53857. ** is opaque to the database connection. The database connection cannot
  53858. ** see the internals of this structure and only deals with pointers to
  53859. ** this structure.
  53860. **
  53861. ** For some database files, the same underlying database cache might be
  53862. ** shared between multiple connections. In that case, each connection
  53863. ** has it own instance of this object. But each instance of this object
  53864. ** points to the same BtShared object. The database cache and the
  53865. ** schema associated with the database file are all contained within
  53866. ** the BtShared object.
  53867. **
  53868. ** All fields in this structure are accessed under sqlite3.mutex.
  53869. ** The pBt pointer itself may not be changed while there exists cursors
  53870. ** in the referenced BtShared that point back to this Btree since those
  53871. ** cursors have to go through this Btree to find their BtShared and
  53872. ** they often do so without holding sqlite3.mutex.
  53873. */
  53874. struct Btree {
  53875. sqlite3 *db; /* The database connection holding this btree */
  53876. BtShared *pBt; /* Sharable content of this btree */
  53877. u8 inTrans; /* TRANS_NONE, TRANS_READ or TRANS_WRITE */
  53878. u8 sharable; /* True if we can share pBt with another db */
  53879. u8 locked; /* True if db currently has pBt locked */
  53880. u8 hasIncrblobCur; /* True if there are one or more Incrblob cursors */
  53881. int wantToLock; /* Number of nested calls to sqlite3BtreeEnter() */
  53882. int nBackup; /* Number of backup operations reading this btree */
  53883. u32 iDataVersion; /* Combines with pBt->pPager->iDataVersion */
  53884. Btree *pNext; /* List of other sharable Btrees from the same db */
  53885. Btree *pPrev; /* Back pointer of the same list */
  53886. #ifndef SQLITE_OMIT_SHARED_CACHE
  53887. BtLock lock; /* Object used to lock page 1 */
  53888. #endif
  53889. };
  53890. /*
  53891. ** Btree.inTrans may take one of the following values.
  53892. **
  53893. ** If the shared-data extension is enabled, there may be multiple users
  53894. ** of the Btree structure. At most one of these may open a write transaction,
  53895. ** but any number may have active read transactions.
  53896. */
  53897. #define TRANS_NONE 0
  53898. #define TRANS_READ 1
  53899. #define TRANS_WRITE 2
  53900. /*
  53901. ** An instance of this object represents a single database file.
  53902. **
  53903. ** A single database file can be in use at the same time by two
  53904. ** or more database connections. When two or more connections are
  53905. ** sharing the same database file, each connection has it own
  53906. ** private Btree object for the file and each of those Btrees points
  53907. ** to this one BtShared object. BtShared.nRef is the number of
  53908. ** connections currently sharing this database file.
  53909. **
  53910. ** Fields in this structure are accessed under the BtShared.mutex
  53911. ** mutex, except for nRef and pNext which are accessed under the
  53912. ** global SQLITE_MUTEX_STATIC_MASTER mutex. The pPager field
  53913. ** may not be modified once it is initially set as long as nRef>0.
  53914. ** The pSchema field may be set once under BtShared.mutex and
  53915. ** thereafter is unchanged as long as nRef>0.
  53916. **
  53917. ** isPending:
  53918. **
  53919. ** If a BtShared client fails to obtain a write-lock on a database
  53920. ** table (because there exists one or more read-locks on the table),
  53921. ** the shared-cache enters 'pending-lock' state and isPending is
  53922. ** set to true.
  53923. **
  53924. ** The shared-cache leaves the 'pending lock' state when either of
  53925. ** the following occur:
  53926. **
  53927. ** 1) The current writer (BtShared.pWriter) concludes its transaction, OR
  53928. ** 2) The number of locks held by other connections drops to zero.
  53929. **
  53930. ** while in the 'pending-lock' state, no connection may start a new
  53931. ** transaction.
  53932. **
  53933. ** This feature is included to help prevent writer-starvation.
  53934. */
  53935. struct BtShared {
  53936. Pager *pPager; /* The page cache */
  53937. sqlite3 *db; /* Database connection currently using this Btree */
  53938. BtCursor *pCursor; /* A list of all open cursors */
  53939. MemPage *pPage1; /* First page of the database */
  53940. u8 openFlags; /* Flags to sqlite3BtreeOpen() */
  53941. #ifndef SQLITE_OMIT_AUTOVACUUM
  53942. u8 autoVacuum; /* True if auto-vacuum is enabled */
  53943. u8 incrVacuum; /* True if incr-vacuum is enabled */
  53944. u8 bDoTruncate; /* True to truncate db on commit */
  53945. #endif
  53946. u8 inTransaction; /* Transaction state */
  53947. u8 max1bytePayload; /* Maximum first byte of cell for a 1-byte payload */
  53948. #ifdef SQLITE_HAS_CODEC
  53949. u8 optimalReserve; /* Desired amount of reserved space per page */
  53950. #endif
  53951. u16 btsFlags; /* Boolean parameters. See BTS_* macros below */
  53952. u16 maxLocal; /* Maximum local payload in non-LEAFDATA tables */
  53953. u16 minLocal; /* Minimum local payload in non-LEAFDATA tables */
  53954. u16 maxLeaf; /* Maximum local payload in a LEAFDATA table */
  53955. u16 minLeaf; /* Minimum local payload in a LEAFDATA table */
  53956. u32 pageSize; /* Total number of bytes on a page */
  53957. u32 usableSize; /* Number of usable bytes on each page */
  53958. int nTransaction; /* Number of open transactions (read + write) */
  53959. u32 nPage; /* Number of pages in the database */
  53960. void *pSchema; /* Pointer to space allocated by sqlite3BtreeSchema() */
  53961. void (*xFreeSchema)(void*); /* Destructor for BtShared.pSchema */
  53962. sqlite3_mutex *mutex; /* Non-recursive mutex required to access this object */
  53963. Bitvec *pHasContent; /* Set of pages moved to free-list this transaction */
  53964. #ifndef SQLITE_OMIT_SHARED_CACHE
  53965. int nRef; /* Number of references to this structure */
  53966. BtShared *pNext; /* Next on a list of sharable BtShared structs */
  53967. BtLock *pLock; /* List of locks held on this shared-btree struct */
  53968. Btree *pWriter; /* Btree with currently open write transaction */
  53969. #endif
  53970. u8 *pTmpSpace; /* Temp space sufficient to hold a single cell */
  53971. };
  53972. /*
  53973. ** Allowed values for BtShared.btsFlags
  53974. */
  53975. #define BTS_READ_ONLY 0x0001 /* Underlying file is readonly */
  53976. #define BTS_PAGESIZE_FIXED 0x0002 /* Page size can no longer be changed */
  53977. #define BTS_SECURE_DELETE 0x0004 /* PRAGMA secure_delete is enabled */
  53978. #define BTS_INITIALLY_EMPTY 0x0008 /* Database was empty at trans start */
  53979. #define BTS_NO_WAL 0x0010 /* Do not open write-ahead-log files */
  53980. #define BTS_EXCLUSIVE 0x0020 /* pWriter has an exclusive lock */
  53981. #define BTS_PENDING 0x0040 /* Waiting for read-locks to clear */
  53982. /*
  53983. ** An instance of the following structure is used to hold information
  53984. ** about a cell. The parseCellPtr() function fills in this structure
  53985. ** based on information extract from the raw disk page.
  53986. */
  53987. struct CellInfo {
  53988. i64 nKey; /* The key for INTKEY tables, or nPayload otherwise */
  53989. u8 *pPayload; /* Pointer to the start of payload */
  53990. u32 nPayload; /* Bytes of payload */
  53991. u16 nLocal; /* Amount of payload held locally, not on overflow */
  53992. u16 nSize; /* Size of the cell content on the main b-tree page */
  53993. };
  53994. /*
  53995. ** Maximum depth of an SQLite B-Tree structure. Any B-Tree deeper than
  53996. ** this will be declared corrupt. This value is calculated based on a
  53997. ** maximum database size of 2^31 pages a minimum fanout of 2 for a
  53998. ** root-node and 3 for all other internal nodes.
  53999. **
  54000. ** If a tree that appears to be taller than this is encountered, it is
  54001. ** assumed that the database is corrupt.
  54002. */
  54003. #define BTCURSOR_MAX_DEPTH 20
  54004. /*
  54005. ** A cursor is a pointer to a particular entry within a particular
  54006. ** b-tree within a database file.
  54007. **
  54008. ** The entry is identified by its MemPage and the index in
  54009. ** MemPage.aCell[] of the entry.
  54010. **
  54011. ** A single database file can be shared by two more database connections,
  54012. ** but cursors cannot be shared. Each cursor is associated with a
  54013. ** particular database connection identified BtCursor.pBtree.db.
  54014. **
  54015. ** Fields in this structure are accessed under the BtShared.mutex
  54016. ** found at self->pBt->mutex.
  54017. **
  54018. ** skipNext meaning:
  54019. ** eState==SKIPNEXT && skipNext>0: Next sqlite3BtreeNext() is no-op.
  54020. ** eState==SKIPNEXT && skipNext<0: Next sqlite3BtreePrevious() is no-op.
  54021. ** eState==FAULT: Cursor fault with skipNext as error code.
  54022. */
  54023. struct BtCursor {
  54024. Btree *pBtree; /* The Btree to which this cursor belongs */
  54025. BtShared *pBt; /* The BtShared this cursor points to */
  54026. BtCursor *pNext; /* Forms a linked list of all cursors */
  54027. Pgno *aOverflow; /* Cache of overflow page locations */
  54028. CellInfo info; /* A parse of the cell we are pointing at */
  54029. i64 nKey; /* Size of pKey, or last integer key */
  54030. void *pKey; /* Saved key that was cursor last known position */
  54031. Pgno pgnoRoot; /* The root page of this tree */
  54032. int nOvflAlloc; /* Allocated size of aOverflow[] array */
  54033. int skipNext; /* Prev() is noop if negative. Next() is noop if positive.
  54034. ** Error code if eState==CURSOR_FAULT */
  54035. u8 curFlags; /* zero or more BTCF_* flags defined below */
  54036. u8 curPagerFlags; /* Flags to send to sqlite3PagerGet() */
  54037. u8 eState; /* One of the CURSOR_XXX constants (see below) */
  54038. u8 hints; /* As configured by CursorSetHints() */
  54039. /* All fields above are zeroed when the cursor is allocated. See
  54040. ** sqlite3BtreeCursorZero(). Fields that follow must be manually
  54041. ** initialized. */
  54042. i8 iPage; /* Index of current page in apPage */
  54043. u8 curIntKey; /* Value of apPage[0]->intKey */
  54044. struct KeyInfo *pKeyInfo; /* Argument passed to comparison function */
  54045. void *padding1; /* Make object size a multiple of 16 */
  54046. u16 aiIdx[BTCURSOR_MAX_DEPTH]; /* Current index in apPage[i] */
  54047. MemPage *apPage[BTCURSOR_MAX_DEPTH]; /* Pages from root to current page */
  54048. };
  54049. /*
  54050. ** Legal values for BtCursor.curFlags
  54051. */
  54052. #define BTCF_WriteFlag 0x01 /* True if a write cursor */
  54053. #define BTCF_ValidNKey 0x02 /* True if info.nKey is valid */
  54054. #define BTCF_ValidOvfl 0x04 /* True if aOverflow is valid */
  54055. #define BTCF_AtLast 0x08 /* Cursor is pointing ot the last entry */
  54056. #define BTCF_Incrblob 0x10 /* True if an incremental I/O handle */
  54057. #define BTCF_Multiple 0x20 /* Maybe another cursor on the same btree */
  54058. /*
  54059. ** Potential values for BtCursor.eState.
  54060. **
  54061. ** CURSOR_INVALID:
  54062. ** Cursor does not point to a valid entry. This can happen (for example)
  54063. ** because the table is empty or because BtreeCursorFirst() has not been
  54064. ** called.
  54065. **
  54066. ** CURSOR_VALID:
  54067. ** Cursor points to a valid entry. getPayload() etc. may be called.
  54068. **
  54069. ** CURSOR_SKIPNEXT:
  54070. ** Cursor is valid except that the Cursor.skipNext field is non-zero
  54071. ** indicating that the next sqlite3BtreeNext() or sqlite3BtreePrevious()
  54072. ** operation should be a no-op.
  54073. **
  54074. ** CURSOR_REQUIRESEEK:
  54075. ** The table that this cursor was opened on still exists, but has been
  54076. ** modified since the cursor was last used. The cursor position is saved
  54077. ** in variables BtCursor.pKey and BtCursor.nKey. When a cursor is in
  54078. ** this state, restoreCursorPosition() can be called to attempt to
  54079. ** seek the cursor to the saved position.
  54080. **
  54081. ** CURSOR_FAULT:
  54082. ** An unrecoverable error (an I/O error or a malloc failure) has occurred
  54083. ** on a different connection that shares the BtShared cache with this
  54084. ** cursor. The error has left the cache in an inconsistent state.
  54085. ** Do nothing else with this cursor. Any attempt to use the cursor
  54086. ** should return the error code stored in BtCursor.skipNext
  54087. */
  54088. #define CURSOR_INVALID 0
  54089. #define CURSOR_VALID 1
  54090. #define CURSOR_SKIPNEXT 2
  54091. #define CURSOR_REQUIRESEEK 3
  54092. #define CURSOR_FAULT 4
  54093. /*
  54094. ** The database page the PENDING_BYTE occupies. This page is never used.
  54095. */
  54096. # define PENDING_BYTE_PAGE(pBt) PAGER_MJ_PGNO(pBt)
  54097. /*
  54098. ** These macros define the location of the pointer-map entry for a
  54099. ** database page. The first argument to each is the number of usable
  54100. ** bytes on each page of the database (often 1024). The second is the
  54101. ** page number to look up in the pointer map.
  54102. **
  54103. ** PTRMAP_PAGENO returns the database page number of the pointer-map
  54104. ** page that stores the required pointer. PTRMAP_PTROFFSET returns
  54105. ** the offset of the requested map entry.
  54106. **
  54107. ** If the pgno argument passed to PTRMAP_PAGENO is a pointer-map page,
  54108. ** then pgno is returned. So (pgno==PTRMAP_PAGENO(pgsz, pgno)) can be
  54109. ** used to test if pgno is a pointer-map page. PTRMAP_ISPAGE implements
  54110. ** this test.
  54111. */
  54112. #define PTRMAP_PAGENO(pBt, pgno) ptrmapPageno(pBt, pgno)
  54113. #define PTRMAP_PTROFFSET(pgptrmap, pgno) (5*(pgno-pgptrmap-1))
  54114. #define PTRMAP_ISPAGE(pBt, pgno) (PTRMAP_PAGENO((pBt),(pgno))==(pgno))
  54115. /*
  54116. ** The pointer map is a lookup table that identifies the parent page for
  54117. ** each child page in the database file. The parent page is the page that
  54118. ** contains a pointer to the child. Every page in the database contains
  54119. ** 0 or 1 parent pages. (In this context 'database page' refers
  54120. ** to any page that is not part of the pointer map itself.) Each pointer map
  54121. ** entry consists of a single byte 'type' and a 4 byte parent page number.
  54122. ** The PTRMAP_XXX identifiers below are the valid types.
  54123. **
  54124. ** The purpose of the pointer map is to facility moving pages from one
  54125. ** position in the file to another as part of autovacuum. When a page
  54126. ** is moved, the pointer in its parent must be updated to point to the
  54127. ** new location. The pointer map is used to locate the parent page quickly.
  54128. **
  54129. ** PTRMAP_ROOTPAGE: The database page is a root-page. The page-number is not
  54130. ** used in this case.
  54131. **
  54132. ** PTRMAP_FREEPAGE: The database page is an unused (free) page. The page-number
  54133. ** is not used in this case.
  54134. **
  54135. ** PTRMAP_OVERFLOW1: The database page is the first page in a list of
  54136. ** overflow pages. The page number identifies the page that
  54137. ** contains the cell with a pointer to this overflow page.
  54138. **
  54139. ** PTRMAP_OVERFLOW2: The database page is the second or later page in a list of
  54140. ** overflow pages. The page-number identifies the previous
  54141. ** page in the overflow page list.
  54142. **
  54143. ** PTRMAP_BTREE: The database page is a non-root btree page. The page number
  54144. ** identifies the parent page in the btree.
  54145. */
  54146. #define PTRMAP_ROOTPAGE 1
  54147. #define PTRMAP_FREEPAGE 2
  54148. #define PTRMAP_OVERFLOW1 3
  54149. #define PTRMAP_OVERFLOW2 4
  54150. #define PTRMAP_BTREE 5
  54151. /* A bunch of assert() statements to check the transaction state variables
  54152. ** of handle p (type Btree*) are internally consistent.
  54153. */
  54154. #define btreeIntegrity(p) \
  54155. assert( p->pBt->inTransaction!=TRANS_NONE || p->pBt->nTransaction==0 ); \
  54156. assert( p->pBt->inTransaction>=p->inTrans );
  54157. /*
  54158. ** The ISAUTOVACUUM macro is used within balance_nonroot() to determine
  54159. ** if the database supports auto-vacuum or not. Because it is used
  54160. ** within an expression that is an argument to another macro
  54161. ** (sqliteMallocRaw), it is not possible to use conditional compilation.
  54162. ** So, this macro is defined instead.
  54163. */
  54164. #ifndef SQLITE_OMIT_AUTOVACUUM
  54165. #define ISAUTOVACUUM (pBt->autoVacuum)
  54166. #else
  54167. #define ISAUTOVACUUM 0
  54168. #endif
  54169. /*
  54170. ** This structure is passed around through all the sanity checking routines
  54171. ** in order to keep track of some global state information.
  54172. **
  54173. ** The aRef[] array is allocated so that there is 1 bit for each page in
  54174. ** the database. As the integrity-check proceeds, for each page used in
  54175. ** the database the corresponding bit is set. This allows integrity-check to
  54176. ** detect pages that are used twice and orphaned pages (both of which
  54177. ** indicate corruption).
  54178. */
  54179. typedef struct IntegrityCk IntegrityCk;
  54180. struct IntegrityCk {
  54181. BtShared *pBt; /* The tree being checked out */
  54182. Pager *pPager; /* The associated pager. Also accessible by pBt->pPager */
  54183. u8 *aPgRef; /* 1 bit per page in the db (see above) */
  54184. Pgno nPage; /* Number of pages in the database */
  54185. int mxErr; /* Stop accumulating errors when this reaches zero */
  54186. int nErr; /* Number of messages written to zErrMsg so far */
  54187. int mallocFailed; /* A memory allocation error has occurred */
  54188. const char *zPfx; /* Error message prefix */
  54189. int v1, v2; /* Values for up to two %d fields in zPfx */
  54190. StrAccum errMsg; /* Accumulate the error message text here */
  54191. u32 *heap; /* Min-heap used for analyzing cell coverage */
  54192. };
  54193. /*
  54194. ** Routines to read or write a two- and four-byte big-endian integer values.
  54195. */
  54196. #define get2byte(x) ((x)[0]<<8 | (x)[1])
  54197. #define put2byte(p,v) ((p)[0] = (u8)((v)>>8), (p)[1] = (u8)(v))
  54198. #define get4byte sqlite3Get4byte
  54199. #define put4byte sqlite3Put4byte
  54200. /*
  54201. ** get2byteAligned(), unlike get2byte(), requires that its argument point to a
  54202. ** two-byte aligned address. get2bytea() is only used for accessing the
  54203. ** cell addresses in a btree header.
  54204. */
  54205. #if SQLITE_BYTEORDER==4321
  54206. # define get2byteAligned(x) (*(u16*)(x))
  54207. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  54208. && GCC_VERSION>=4008000
  54209. # define get2byteAligned(x) __builtin_bswap16(*(u16*)(x))
  54210. #elif SQLITE_BYTEORDER==1234 && !defined(SQLITE_DISABLE_INTRINSIC) \
  54211. && defined(_MSC_VER) && _MSC_VER>=1300
  54212. # define get2byteAligned(x) _byteswap_ushort(*(u16*)(x))
  54213. #else
  54214. # define get2byteAligned(x) ((x)[0]<<8 | (x)[1])
  54215. #endif
  54216. /************** End of btreeInt.h ********************************************/
  54217. /************** Continuing where we left off in btmutex.c ********************/
  54218. #ifndef SQLITE_OMIT_SHARED_CACHE
  54219. #if SQLITE_THREADSAFE
  54220. /*
  54221. ** Obtain the BtShared mutex associated with B-Tree handle p. Also,
  54222. ** set BtShared.db to the database handle associated with p and the
  54223. ** p->locked boolean to true.
  54224. */
  54225. static void lockBtreeMutex(Btree *p){
  54226. assert( p->locked==0 );
  54227. assert( sqlite3_mutex_notheld(p->pBt->mutex) );
  54228. assert( sqlite3_mutex_held(p->db->mutex) );
  54229. sqlite3_mutex_enter(p->pBt->mutex);
  54230. p->pBt->db = p->db;
  54231. p->locked = 1;
  54232. }
  54233. /*
  54234. ** Release the BtShared mutex associated with B-Tree handle p and
  54235. ** clear the p->locked boolean.
  54236. */
  54237. static void SQLITE_NOINLINE unlockBtreeMutex(Btree *p){
  54238. BtShared *pBt = p->pBt;
  54239. assert( p->locked==1 );
  54240. assert( sqlite3_mutex_held(pBt->mutex) );
  54241. assert( sqlite3_mutex_held(p->db->mutex) );
  54242. assert( p->db==pBt->db );
  54243. sqlite3_mutex_leave(pBt->mutex);
  54244. p->locked = 0;
  54245. }
  54246. /* Forward reference */
  54247. static void SQLITE_NOINLINE btreeLockCarefully(Btree *p);
  54248. /*
  54249. ** Enter a mutex on the given BTree object.
  54250. **
  54251. ** If the object is not sharable, then no mutex is ever required
  54252. ** and this routine is a no-op. The underlying mutex is non-recursive.
  54253. ** But we keep a reference count in Btree.wantToLock so the behavior
  54254. ** of this interface is recursive.
  54255. **
  54256. ** To avoid deadlocks, multiple Btrees are locked in the same order
  54257. ** by all database connections. The p->pNext is a list of other
  54258. ** Btrees belonging to the same database connection as the p Btree
  54259. ** which need to be locked after p. If we cannot get a lock on
  54260. ** p, then first unlock all of the others on p->pNext, then wait
  54261. ** for the lock to become available on p, then relock all of the
  54262. ** subsequent Btrees that desire a lock.
  54263. */
  54264. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree *p){
  54265. /* Some basic sanity checking on the Btree. The list of Btrees
  54266. ** connected by pNext and pPrev should be in sorted order by
  54267. ** Btree.pBt value. All elements of the list should belong to
  54268. ** the same connection. Only shared Btrees are on the list. */
  54269. assert( p->pNext==0 || p->pNext->pBt>p->pBt );
  54270. assert( p->pPrev==0 || p->pPrev->pBt<p->pBt );
  54271. assert( p->pNext==0 || p->pNext->db==p->db );
  54272. assert( p->pPrev==0 || p->pPrev->db==p->db );
  54273. assert( p->sharable || (p->pNext==0 && p->pPrev==0) );
  54274. /* Check for locking consistency */
  54275. assert( !p->locked || p->wantToLock>0 );
  54276. assert( p->sharable || p->wantToLock==0 );
  54277. /* We should already hold a lock on the database connection */
  54278. assert( sqlite3_mutex_held(p->db->mutex) );
  54279. /* Unless the database is sharable and unlocked, then BtShared.db
  54280. ** should already be set correctly. */
  54281. assert( (p->locked==0 && p->sharable) || p->pBt->db==p->db );
  54282. if( !p->sharable ) return;
  54283. p->wantToLock++;
  54284. if( p->locked ) return;
  54285. btreeLockCarefully(p);
  54286. }
  54287. /* This is a helper function for sqlite3BtreeLock(). By moving
  54288. ** complex, but seldom used logic, out of sqlite3BtreeLock() and
  54289. ** into this routine, we avoid unnecessary stack pointer changes
  54290. ** and thus help the sqlite3BtreeLock() routine to run much faster
  54291. ** in the common case.
  54292. */
  54293. static void SQLITE_NOINLINE btreeLockCarefully(Btree *p){
  54294. Btree *pLater;
  54295. /* In most cases, we should be able to acquire the lock we
  54296. ** want without having to go through the ascending lock
  54297. ** procedure that follows. Just be sure not to block.
  54298. */
  54299. if( sqlite3_mutex_try(p->pBt->mutex)==SQLITE_OK ){
  54300. p->pBt->db = p->db;
  54301. p->locked = 1;
  54302. return;
  54303. }
  54304. /* To avoid deadlock, first release all locks with a larger
  54305. ** BtShared address. Then acquire our lock. Then reacquire
  54306. ** the other BtShared locks that we used to hold in ascending
  54307. ** order.
  54308. */
  54309. for(pLater=p->pNext; pLater; pLater=pLater->pNext){
  54310. assert( pLater->sharable );
  54311. assert( pLater->pNext==0 || pLater->pNext->pBt>pLater->pBt );
  54312. assert( !pLater->locked || pLater->wantToLock>0 );
  54313. if( pLater->locked ){
  54314. unlockBtreeMutex(pLater);
  54315. }
  54316. }
  54317. lockBtreeMutex(p);
  54318. for(pLater=p->pNext; pLater; pLater=pLater->pNext){
  54319. if( pLater->wantToLock ){
  54320. lockBtreeMutex(pLater);
  54321. }
  54322. }
  54323. }
  54324. /*
  54325. ** Exit the recursive mutex on a Btree.
  54326. */
  54327. SQLITE_PRIVATE void sqlite3BtreeLeave(Btree *p){
  54328. assert( sqlite3_mutex_held(p->db->mutex) );
  54329. if( p->sharable ){
  54330. assert( p->wantToLock>0 );
  54331. p->wantToLock--;
  54332. if( p->wantToLock==0 ){
  54333. unlockBtreeMutex(p);
  54334. }
  54335. }
  54336. }
  54337. #ifndef NDEBUG
  54338. /*
  54339. ** Return true if the BtShared mutex is held on the btree, or if the
  54340. ** B-Tree is not marked as sharable.
  54341. **
  54342. ** This routine is used only from within assert() statements.
  54343. */
  54344. SQLITE_PRIVATE int sqlite3BtreeHoldsMutex(Btree *p){
  54345. assert( p->sharable==0 || p->locked==0 || p->wantToLock>0 );
  54346. assert( p->sharable==0 || p->locked==0 || p->db==p->pBt->db );
  54347. assert( p->sharable==0 || p->locked==0 || sqlite3_mutex_held(p->pBt->mutex) );
  54348. assert( p->sharable==0 || p->locked==0 || sqlite3_mutex_held(p->db->mutex) );
  54349. return (p->sharable==0 || p->locked);
  54350. }
  54351. #endif
  54352. /*
  54353. ** Enter the mutex on every Btree associated with a database
  54354. ** connection. This is needed (for example) prior to parsing
  54355. ** a statement since we will be comparing table and column names
  54356. ** against all schemas and we do not want those schemas being
  54357. ** reset out from under us.
  54358. **
  54359. ** There is a corresponding leave-all procedures.
  54360. **
  54361. ** Enter the mutexes in accending order by BtShared pointer address
  54362. ** to avoid the possibility of deadlock when two threads with
  54363. ** two or more btrees in common both try to lock all their btrees
  54364. ** at the same instant.
  54365. */
  54366. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3 *db){
  54367. int i;
  54368. Btree *p;
  54369. assert( sqlite3_mutex_held(db->mutex) );
  54370. for(i=0; i<db->nDb; i++){
  54371. p = db->aDb[i].pBt;
  54372. if( p ) sqlite3BtreeEnter(p);
  54373. }
  54374. }
  54375. SQLITE_PRIVATE void sqlite3BtreeLeaveAll(sqlite3 *db){
  54376. int i;
  54377. Btree *p;
  54378. assert( sqlite3_mutex_held(db->mutex) );
  54379. for(i=0; i<db->nDb; i++){
  54380. p = db->aDb[i].pBt;
  54381. if( p ) sqlite3BtreeLeave(p);
  54382. }
  54383. }
  54384. #ifndef NDEBUG
  54385. /*
  54386. ** Return true if the current thread holds the database connection
  54387. ** mutex and all required BtShared mutexes.
  54388. **
  54389. ** This routine is used inside assert() statements only.
  54390. */
  54391. SQLITE_PRIVATE int sqlite3BtreeHoldsAllMutexes(sqlite3 *db){
  54392. int i;
  54393. if( !sqlite3_mutex_held(db->mutex) ){
  54394. return 0;
  54395. }
  54396. for(i=0; i<db->nDb; i++){
  54397. Btree *p;
  54398. p = db->aDb[i].pBt;
  54399. if( p && p->sharable &&
  54400. (p->wantToLock==0 || !sqlite3_mutex_held(p->pBt->mutex)) ){
  54401. return 0;
  54402. }
  54403. }
  54404. return 1;
  54405. }
  54406. #endif /* NDEBUG */
  54407. #ifndef NDEBUG
  54408. /*
  54409. ** Return true if the correct mutexes are held for accessing the
  54410. ** db->aDb[iDb].pSchema structure. The mutexes required for schema
  54411. ** access are:
  54412. **
  54413. ** (1) The mutex on db
  54414. ** (2) if iDb!=1, then the mutex on db->aDb[iDb].pBt.
  54415. **
  54416. ** If pSchema is not NULL, then iDb is computed from pSchema and
  54417. ** db using sqlite3SchemaToIndex().
  54418. */
  54419. SQLITE_PRIVATE int sqlite3SchemaMutexHeld(sqlite3 *db, int iDb, Schema *pSchema){
  54420. Btree *p;
  54421. assert( db!=0 );
  54422. if( pSchema ) iDb = sqlite3SchemaToIndex(db, pSchema);
  54423. assert( iDb>=0 && iDb<db->nDb );
  54424. if( !sqlite3_mutex_held(db->mutex) ) return 0;
  54425. if( iDb==1 ) return 1;
  54426. p = db->aDb[iDb].pBt;
  54427. assert( p!=0 );
  54428. return p->sharable==0 || p->locked==1;
  54429. }
  54430. #endif /* NDEBUG */
  54431. #else /* SQLITE_THREADSAFE>0 above. SQLITE_THREADSAFE==0 below */
  54432. /*
  54433. ** The following are special cases for mutex enter routines for use
  54434. ** in single threaded applications that use shared cache. Except for
  54435. ** these two routines, all mutex operations are no-ops in that case and
  54436. ** are null #defines in btree.h.
  54437. **
  54438. ** If shared cache is disabled, then all btree mutex routines, including
  54439. ** the ones below, are no-ops and are null #defines in btree.h.
  54440. */
  54441. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree *p){
  54442. p->pBt->db = p->db;
  54443. }
  54444. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3 *db){
  54445. int i;
  54446. for(i=0; i<db->nDb; i++){
  54447. Btree *p = db->aDb[i].pBt;
  54448. if( p ){
  54449. p->pBt->db = p->db;
  54450. }
  54451. }
  54452. }
  54453. #endif /* if SQLITE_THREADSAFE */
  54454. #ifndef SQLITE_OMIT_INCRBLOB
  54455. /*
  54456. ** Enter a mutex on a Btree given a cursor owned by that Btree.
  54457. **
  54458. ** These entry points are used by incremental I/O only. Enter() is required
  54459. ** any time OMIT_SHARED_CACHE is not defined, regardless of whether or not
  54460. ** the build is threadsafe. Leave() is only required by threadsafe builds.
  54461. */
  54462. SQLITE_PRIVATE void sqlite3BtreeEnterCursor(BtCursor *pCur){
  54463. sqlite3BtreeEnter(pCur->pBtree);
  54464. }
  54465. # if SQLITE_THREADSAFE
  54466. SQLITE_PRIVATE void sqlite3BtreeLeaveCursor(BtCursor *pCur){
  54467. sqlite3BtreeLeave(pCur->pBtree);
  54468. }
  54469. # endif
  54470. #endif /* ifndef SQLITE_OMIT_INCRBLOB */
  54471. #endif /* ifndef SQLITE_OMIT_SHARED_CACHE */
  54472. /************** End of btmutex.c *********************************************/
  54473. /************** Begin file btree.c *******************************************/
  54474. /*
  54475. ** 2004 April 6
  54476. **
  54477. ** The author disclaims copyright to this source code. In place of
  54478. ** a legal notice, here is a blessing:
  54479. **
  54480. ** May you do good and not evil.
  54481. ** May you find forgiveness for yourself and forgive others.
  54482. ** May you share freely, never taking more than you give.
  54483. **
  54484. *************************************************************************
  54485. ** This file implements an external (disk-based) database using BTrees.
  54486. ** See the header comment on "btreeInt.h" for additional information.
  54487. ** Including a description of file format and an overview of operation.
  54488. */
  54489. /* #include "btreeInt.h" */
  54490. /*
  54491. ** The header string that appears at the beginning of every
  54492. ** SQLite database.
  54493. */
  54494. static const char zMagicHeader[] = SQLITE_FILE_HEADER;
  54495. /*
  54496. ** Set this global variable to 1 to enable tracing using the TRACE
  54497. ** macro.
  54498. */
  54499. #if 0
  54500. int sqlite3BtreeTrace=1; /* True to enable tracing */
  54501. # define TRACE(X) if(sqlite3BtreeTrace){printf X;fflush(stdout);}
  54502. #else
  54503. # define TRACE(X)
  54504. #endif
  54505. /*
  54506. ** Extract a 2-byte big-endian integer from an array of unsigned bytes.
  54507. ** But if the value is zero, make it 65536.
  54508. **
  54509. ** This routine is used to extract the "offset to cell content area" value
  54510. ** from the header of a btree page. If the page size is 65536 and the page
  54511. ** is empty, the offset should be 65536, but the 2-byte value stores zero.
  54512. ** This routine makes the necessary adjustment to 65536.
  54513. */
  54514. #define get2byteNotZero(X) (((((int)get2byte(X))-1)&0xffff)+1)
  54515. /*
  54516. ** Values passed as the 5th argument to allocateBtreePage()
  54517. */
  54518. #define BTALLOC_ANY 0 /* Allocate any page */
  54519. #define BTALLOC_EXACT 1 /* Allocate exact page if possible */
  54520. #define BTALLOC_LE 2 /* Allocate any page <= the parameter */
  54521. /*
  54522. ** Macro IfNotOmitAV(x) returns (x) if SQLITE_OMIT_AUTOVACUUM is not
  54523. ** defined, or 0 if it is. For example:
  54524. **
  54525. ** bIncrVacuum = IfNotOmitAV(pBtShared->incrVacuum);
  54526. */
  54527. #ifndef SQLITE_OMIT_AUTOVACUUM
  54528. #define IfNotOmitAV(expr) (expr)
  54529. #else
  54530. #define IfNotOmitAV(expr) 0
  54531. #endif
  54532. #ifndef SQLITE_OMIT_SHARED_CACHE
  54533. /*
  54534. ** A list of BtShared objects that are eligible for participation
  54535. ** in shared cache. This variable has file scope during normal builds,
  54536. ** but the test harness needs to access it so we make it global for
  54537. ** test builds.
  54538. **
  54539. ** Access to this variable is protected by SQLITE_MUTEX_STATIC_MASTER.
  54540. */
  54541. #ifdef SQLITE_TEST
  54542. SQLITE_PRIVATE BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
  54543. #else
  54544. static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
  54545. #endif
  54546. #endif /* SQLITE_OMIT_SHARED_CACHE */
  54547. #ifndef SQLITE_OMIT_SHARED_CACHE
  54548. /*
  54549. ** Enable or disable the shared pager and schema features.
  54550. **
  54551. ** This routine has no effect on existing database connections.
  54552. ** The shared cache setting effects only future calls to
  54553. ** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
  54554. */
  54555. SQLITE_API int sqlite3_enable_shared_cache(int enable){
  54556. sqlite3GlobalConfig.sharedCacheEnabled = enable;
  54557. return SQLITE_OK;
  54558. }
  54559. #endif
  54560. #ifdef SQLITE_OMIT_SHARED_CACHE
  54561. /*
  54562. ** The functions querySharedCacheTableLock(), setSharedCacheTableLock(),
  54563. ** and clearAllSharedCacheTableLocks()
  54564. ** manipulate entries in the BtShared.pLock linked list used to store
  54565. ** shared-cache table level locks. If the library is compiled with the
  54566. ** shared-cache feature disabled, then there is only ever one user
  54567. ** of each BtShared structure and so this locking is not necessary.
  54568. ** So define the lock related functions as no-ops.
  54569. */
  54570. #define querySharedCacheTableLock(a,b,c) SQLITE_OK
  54571. #define setSharedCacheTableLock(a,b,c) SQLITE_OK
  54572. #define clearAllSharedCacheTableLocks(a)
  54573. #define downgradeAllSharedCacheTableLocks(a)
  54574. #define hasSharedCacheTableLock(a,b,c,d) 1
  54575. #define hasReadConflicts(a, b) 0
  54576. #endif
  54577. #ifndef SQLITE_OMIT_SHARED_CACHE
  54578. #ifdef SQLITE_DEBUG
  54579. /*
  54580. **** This function is only used as part of an assert() statement. ***
  54581. **
  54582. ** Check to see if pBtree holds the required locks to read or write to the
  54583. ** table with root page iRoot. Return 1 if it does and 0 if not.
  54584. **
  54585. ** For example, when writing to a table with root-page iRoot via
  54586. ** Btree connection pBtree:
  54587. **
  54588. ** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
  54589. **
  54590. ** When writing to an index that resides in a sharable database, the
  54591. ** caller should have first obtained a lock specifying the root page of
  54592. ** the corresponding table. This makes things a bit more complicated,
  54593. ** as this module treats each table as a separate structure. To determine
  54594. ** the table corresponding to the index being written, this
  54595. ** function has to search through the database schema.
  54596. **
  54597. ** Instead of a lock on the table/index rooted at page iRoot, the caller may
  54598. ** hold a write-lock on the schema table (root page 1). This is also
  54599. ** acceptable.
  54600. */
  54601. static int hasSharedCacheTableLock(
  54602. Btree *pBtree, /* Handle that must hold lock */
  54603. Pgno iRoot, /* Root page of b-tree */
  54604. int isIndex, /* True if iRoot is the root of an index b-tree */
  54605. int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
  54606. ){
  54607. Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
  54608. Pgno iTab = 0;
  54609. BtLock *pLock;
  54610. /* If this database is not shareable, or if the client is reading
  54611. ** and has the read-uncommitted flag set, then no lock is required.
  54612. ** Return true immediately.
  54613. */
  54614. if( (pBtree->sharable==0)
  54615. || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommitted))
  54616. ){
  54617. return 1;
  54618. }
  54619. /* If the client is reading or writing an index and the schema is
  54620. ** not loaded, then it is too difficult to actually check to see if
  54621. ** the correct locks are held. So do not bother - just return true.
  54622. ** This case does not come up very often anyhow.
  54623. */
  54624. if( isIndex && (!pSchema || (pSchema->schemaFlags&DB_SchemaLoaded)==0) ){
  54625. return 1;
  54626. }
  54627. /* Figure out the root-page that the lock should be held on. For table
  54628. ** b-trees, this is just the root page of the b-tree being read or
  54629. ** written. For index b-trees, it is the root page of the associated
  54630. ** table. */
  54631. if( isIndex ){
  54632. HashElem *p;
  54633. for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
  54634. Index *pIdx = (Index *)sqliteHashData(p);
  54635. if( pIdx->tnum==(int)iRoot ){
  54636. if( iTab ){
  54637. /* Two or more indexes share the same root page. There must
  54638. ** be imposter tables. So just return true. The assert is not
  54639. ** useful in that case. */
  54640. return 1;
  54641. }
  54642. iTab = pIdx->pTable->tnum;
  54643. }
  54644. }
  54645. }else{
  54646. iTab = iRoot;
  54647. }
  54648. /* Search for the required lock. Either a write-lock on root-page iTab, a
  54649. ** write-lock on the schema table, or (if the client is reading) a
  54650. ** read-lock on iTab will suffice. Return 1 if any of these are found. */
  54651. for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
  54652. if( pLock->pBtree==pBtree
  54653. && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
  54654. && pLock->eLock>=eLockType
  54655. ){
  54656. return 1;
  54657. }
  54658. }
  54659. /* Failed to find the required lock. */
  54660. return 0;
  54661. }
  54662. #endif /* SQLITE_DEBUG */
  54663. #ifdef SQLITE_DEBUG
  54664. /*
  54665. **** This function may be used as part of assert() statements only. ****
  54666. **
  54667. ** Return true if it would be illegal for pBtree to write into the
  54668. ** table or index rooted at iRoot because other shared connections are
  54669. ** simultaneously reading that same table or index.
  54670. **
  54671. ** It is illegal for pBtree to write if some other Btree object that
  54672. ** shares the same BtShared object is currently reading or writing
  54673. ** the iRoot table. Except, if the other Btree object has the
  54674. ** read-uncommitted flag set, then it is OK for the other object to
  54675. ** have a read cursor.
  54676. **
  54677. ** For example, before writing to any part of the table or index
  54678. ** rooted at page iRoot, one should call:
  54679. **
  54680. ** assert( !hasReadConflicts(pBtree, iRoot) );
  54681. */
  54682. static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
  54683. BtCursor *p;
  54684. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  54685. if( p->pgnoRoot==iRoot
  54686. && p->pBtree!=pBtree
  54687. && 0==(p->pBtree->db->flags & SQLITE_ReadUncommitted)
  54688. ){
  54689. return 1;
  54690. }
  54691. }
  54692. return 0;
  54693. }
  54694. #endif /* #ifdef SQLITE_DEBUG */
  54695. /*
  54696. ** Query to see if Btree handle p may obtain a lock of type eLock
  54697. ** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
  54698. ** SQLITE_OK if the lock may be obtained (by calling
  54699. ** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
  54700. */
  54701. static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
  54702. BtShared *pBt = p->pBt;
  54703. BtLock *pIter;
  54704. assert( sqlite3BtreeHoldsMutex(p) );
  54705. assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
  54706. assert( p->db!=0 );
  54707. assert( !(p->db->flags&SQLITE_ReadUncommitted)||eLock==WRITE_LOCK||iTab==1 );
  54708. /* If requesting a write-lock, then the Btree must have an open write
  54709. ** transaction on this file. And, obviously, for this to be so there
  54710. ** must be an open write transaction on the file itself.
  54711. */
  54712. assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
  54713. assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
  54714. /* This routine is a no-op if the shared-cache is not enabled */
  54715. if( !p->sharable ){
  54716. return SQLITE_OK;
  54717. }
  54718. /* If some other connection is holding an exclusive lock, the
  54719. ** requested lock may not be obtained.
  54720. */
  54721. if( pBt->pWriter!=p && (pBt->btsFlags & BTS_EXCLUSIVE)!=0 ){
  54722. sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
  54723. return SQLITE_LOCKED_SHAREDCACHE;
  54724. }
  54725. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  54726. /* The condition (pIter->eLock!=eLock) in the following if(...)
  54727. ** statement is a simplification of:
  54728. **
  54729. ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
  54730. **
  54731. ** since we know that if eLock==WRITE_LOCK, then no other connection
  54732. ** may hold a WRITE_LOCK on any table in this file (since there can
  54733. ** only be a single writer).
  54734. */
  54735. assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
  54736. assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
  54737. if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
  54738. sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
  54739. if( eLock==WRITE_LOCK ){
  54740. assert( p==pBt->pWriter );
  54741. pBt->btsFlags |= BTS_PENDING;
  54742. }
  54743. return SQLITE_LOCKED_SHAREDCACHE;
  54744. }
  54745. }
  54746. return SQLITE_OK;
  54747. }
  54748. #endif /* !SQLITE_OMIT_SHARED_CACHE */
  54749. #ifndef SQLITE_OMIT_SHARED_CACHE
  54750. /*
  54751. ** Add a lock on the table with root-page iTable to the shared-btree used
  54752. ** by Btree handle p. Parameter eLock must be either READ_LOCK or
  54753. ** WRITE_LOCK.
  54754. **
  54755. ** This function assumes the following:
  54756. **
  54757. ** (a) The specified Btree object p is connected to a sharable
  54758. ** database (one with the BtShared.sharable flag set), and
  54759. **
  54760. ** (b) No other Btree objects hold a lock that conflicts
  54761. ** with the requested lock (i.e. querySharedCacheTableLock() has
  54762. ** already been called and returned SQLITE_OK).
  54763. **
  54764. ** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
  54765. ** is returned if a malloc attempt fails.
  54766. */
  54767. static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
  54768. BtShared *pBt = p->pBt;
  54769. BtLock *pLock = 0;
  54770. BtLock *pIter;
  54771. assert( sqlite3BtreeHoldsMutex(p) );
  54772. assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
  54773. assert( p->db!=0 );
  54774. /* A connection with the read-uncommitted flag set will never try to
  54775. ** obtain a read-lock using this function. The only read-lock obtained
  54776. ** by a connection in read-uncommitted mode is on the sqlite_master
  54777. ** table, and that lock is obtained in BtreeBeginTrans(). */
  54778. assert( 0==(p->db->flags&SQLITE_ReadUncommitted) || eLock==WRITE_LOCK );
  54779. /* This function should only be called on a sharable b-tree after it
  54780. ** has been determined that no other b-tree holds a conflicting lock. */
  54781. assert( p->sharable );
  54782. assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
  54783. /* First search the list for an existing lock on this table. */
  54784. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  54785. if( pIter->iTable==iTable && pIter->pBtree==p ){
  54786. pLock = pIter;
  54787. break;
  54788. }
  54789. }
  54790. /* If the above search did not find a BtLock struct associating Btree p
  54791. ** with table iTable, allocate one and link it into the list.
  54792. */
  54793. if( !pLock ){
  54794. pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
  54795. if( !pLock ){
  54796. return SQLITE_NOMEM_BKPT;
  54797. }
  54798. pLock->iTable = iTable;
  54799. pLock->pBtree = p;
  54800. pLock->pNext = pBt->pLock;
  54801. pBt->pLock = pLock;
  54802. }
  54803. /* Set the BtLock.eLock variable to the maximum of the current lock
  54804. ** and the requested lock. This means if a write-lock was already held
  54805. ** and a read-lock requested, we don't incorrectly downgrade the lock.
  54806. */
  54807. assert( WRITE_LOCK>READ_LOCK );
  54808. if( eLock>pLock->eLock ){
  54809. pLock->eLock = eLock;
  54810. }
  54811. return SQLITE_OK;
  54812. }
  54813. #endif /* !SQLITE_OMIT_SHARED_CACHE */
  54814. #ifndef SQLITE_OMIT_SHARED_CACHE
  54815. /*
  54816. ** Release all the table locks (locks obtained via calls to
  54817. ** the setSharedCacheTableLock() procedure) held by Btree object p.
  54818. **
  54819. ** This function assumes that Btree p has an open read or write
  54820. ** transaction. If it does not, then the BTS_PENDING flag
  54821. ** may be incorrectly cleared.
  54822. */
  54823. static void clearAllSharedCacheTableLocks(Btree *p){
  54824. BtShared *pBt = p->pBt;
  54825. BtLock **ppIter = &pBt->pLock;
  54826. assert( sqlite3BtreeHoldsMutex(p) );
  54827. assert( p->sharable || 0==*ppIter );
  54828. assert( p->inTrans>0 );
  54829. while( *ppIter ){
  54830. BtLock *pLock = *ppIter;
  54831. assert( (pBt->btsFlags & BTS_EXCLUSIVE)==0 || pBt->pWriter==pLock->pBtree );
  54832. assert( pLock->pBtree->inTrans>=pLock->eLock );
  54833. if( pLock->pBtree==p ){
  54834. *ppIter = pLock->pNext;
  54835. assert( pLock->iTable!=1 || pLock==&p->lock );
  54836. if( pLock->iTable!=1 ){
  54837. sqlite3_free(pLock);
  54838. }
  54839. }else{
  54840. ppIter = &pLock->pNext;
  54841. }
  54842. }
  54843. assert( (pBt->btsFlags & BTS_PENDING)==0 || pBt->pWriter );
  54844. if( pBt->pWriter==p ){
  54845. pBt->pWriter = 0;
  54846. pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
  54847. }else if( pBt->nTransaction==2 ){
  54848. /* This function is called when Btree p is concluding its
  54849. ** transaction. If there currently exists a writer, and p is not
  54850. ** that writer, then the number of locks held by connections other
  54851. ** than the writer must be about to drop to zero. In this case
  54852. ** set the BTS_PENDING flag to 0.
  54853. **
  54854. ** If there is not currently a writer, then BTS_PENDING must
  54855. ** be zero already. So this next line is harmless in that case.
  54856. */
  54857. pBt->btsFlags &= ~BTS_PENDING;
  54858. }
  54859. }
  54860. /*
  54861. ** This function changes all write-locks held by Btree p into read-locks.
  54862. */
  54863. static void downgradeAllSharedCacheTableLocks(Btree *p){
  54864. BtShared *pBt = p->pBt;
  54865. if( pBt->pWriter==p ){
  54866. BtLock *pLock;
  54867. pBt->pWriter = 0;
  54868. pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
  54869. for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
  54870. assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
  54871. pLock->eLock = READ_LOCK;
  54872. }
  54873. }
  54874. }
  54875. #endif /* SQLITE_OMIT_SHARED_CACHE */
  54876. static void releasePage(MemPage *pPage); /* Forward reference */
  54877. /*
  54878. ***** This routine is used inside of assert() only ****
  54879. **
  54880. ** Verify that the cursor holds the mutex on its BtShared
  54881. */
  54882. #ifdef SQLITE_DEBUG
  54883. static int cursorHoldsMutex(BtCursor *p){
  54884. return sqlite3_mutex_held(p->pBt->mutex);
  54885. }
  54886. /* Verify that the cursor and the BtShared agree about what is the current
  54887. ** database connetion. This is important in shared-cache mode. If the database
  54888. ** connection pointers get out-of-sync, it is possible for routines like
  54889. ** btreeInitPage() to reference an stale connection pointer that references a
  54890. ** a connection that has already closed. This routine is used inside assert()
  54891. ** statements only and for the purpose of double-checking that the btree code
  54892. ** does keep the database connection pointers up-to-date.
  54893. */
  54894. static int cursorOwnsBtShared(BtCursor *p){
  54895. assert( cursorHoldsMutex(p) );
  54896. return (p->pBtree->db==p->pBt->db);
  54897. }
  54898. #endif
  54899. /*
  54900. ** Invalidate the overflow cache of the cursor passed as the first argument.
  54901. ** on the shared btree structure pBt.
  54902. */
  54903. #define invalidateOverflowCache(pCur) (pCur->curFlags &= ~BTCF_ValidOvfl)
  54904. /*
  54905. ** Invalidate the overflow page-list cache for all cursors opened
  54906. ** on the shared btree structure pBt.
  54907. */
  54908. static void invalidateAllOverflowCache(BtShared *pBt){
  54909. BtCursor *p;
  54910. assert( sqlite3_mutex_held(pBt->mutex) );
  54911. for(p=pBt->pCursor; p; p=p->pNext){
  54912. invalidateOverflowCache(p);
  54913. }
  54914. }
  54915. #ifndef SQLITE_OMIT_INCRBLOB
  54916. /*
  54917. ** This function is called before modifying the contents of a table
  54918. ** to invalidate any incrblob cursors that are open on the
  54919. ** row or one of the rows being modified.
  54920. **
  54921. ** If argument isClearTable is true, then the entire contents of the
  54922. ** table is about to be deleted. In this case invalidate all incrblob
  54923. ** cursors open on any row within the table with root-page pgnoRoot.
  54924. **
  54925. ** Otherwise, if argument isClearTable is false, then the row with
  54926. ** rowid iRow is being replaced or deleted. In this case invalidate
  54927. ** only those incrblob cursors open on that specific row.
  54928. */
  54929. static void invalidateIncrblobCursors(
  54930. Btree *pBtree, /* The database file to check */
  54931. i64 iRow, /* The rowid that might be changing */
  54932. int isClearTable /* True if all rows are being deleted */
  54933. ){
  54934. BtCursor *p;
  54935. if( pBtree->hasIncrblobCur==0 ) return;
  54936. assert( sqlite3BtreeHoldsMutex(pBtree) );
  54937. pBtree->hasIncrblobCur = 0;
  54938. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  54939. if( (p->curFlags & BTCF_Incrblob)!=0 ){
  54940. pBtree->hasIncrblobCur = 1;
  54941. if( isClearTable || p->info.nKey==iRow ){
  54942. p->eState = CURSOR_INVALID;
  54943. }
  54944. }
  54945. }
  54946. }
  54947. #else
  54948. /* Stub function when INCRBLOB is omitted */
  54949. #define invalidateIncrblobCursors(x,y,z)
  54950. #endif /* SQLITE_OMIT_INCRBLOB */
  54951. /*
  54952. ** Set bit pgno of the BtShared.pHasContent bitvec. This is called
  54953. ** when a page that previously contained data becomes a free-list leaf
  54954. ** page.
  54955. **
  54956. ** The BtShared.pHasContent bitvec exists to work around an obscure
  54957. ** bug caused by the interaction of two useful IO optimizations surrounding
  54958. ** free-list leaf pages:
  54959. **
  54960. ** 1) When all data is deleted from a page and the page becomes
  54961. ** a free-list leaf page, the page is not written to the database
  54962. ** (as free-list leaf pages contain no meaningful data). Sometimes
  54963. ** such a page is not even journalled (as it will not be modified,
  54964. ** why bother journalling it?).
  54965. **
  54966. ** 2) When a free-list leaf page is reused, its content is not read
  54967. ** from the database or written to the journal file (why should it
  54968. ** be, if it is not at all meaningful?).
  54969. **
  54970. ** By themselves, these optimizations work fine and provide a handy
  54971. ** performance boost to bulk delete or insert operations. However, if
  54972. ** a page is moved to the free-list and then reused within the same
  54973. ** transaction, a problem comes up. If the page is not journalled when
  54974. ** it is moved to the free-list and it is also not journalled when it
  54975. ** is extracted from the free-list and reused, then the original data
  54976. ** may be lost. In the event of a rollback, it may not be possible
  54977. ** to restore the database to its original configuration.
  54978. **
  54979. ** The solution is the BtShared.pHasContent bitvec. Whenever a page is
  54980. ** moved to become a free-list leaf page, the corresponding bit is
  54981. ** set in the bitvec. Whenever a leaf page is extracted from the free-list,
  54982. ** optimization 2 above is omitted if the corresponding bit is already
  54983. ** set in BtShared.pHasContent. The contents of the bitvec are cleared
  54984. ** at the end of every transaction.
  54985. */
  54986. static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
  54987. int rc = SQLITE_OK;
  54988. if( !pBt->pHasContent ){
  54989. assert( pgno<=pBt->nPage );
  54990. pBt->pHasContent = sqlite3BitvecCreate(pBt->nPage);
  54991. if( !pBt->pHasContent ){
  54992. rc = SQLITE_NOMEM_BKPT;
  54993. }
  54994. }
  54995. if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
  54996. rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
  54997. }
  54998. return rc;
  54999. }
  55000. /*
  55001. ** Query the BtShared.pHasContent vector.
  55002. **
  55003. ** This function is called when a free-list leaf page is removed from the
  55004. ** free-list for reuse. It returns false if it is safe to retrieve the
  55005. ** page from the pager layer with the 'no-content' flag set. True otherwise.
  55006. */
  55007. static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
  55008. Bitvec *p = pBt->pHasContent;
  55009. return (p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTest(p, pgno)));
  55010. }
  55011. /*
  55012. ** Clear (destroy) the BtShared.pHasContent bitvec. This should be
  55013. ** invoked at the conclusion of each write-transaction.
  55014. */
  55015. static void btreeClearHasContent(BtShared *pBt){
  55016. sqlite3BitvecDestroy(pBt->pHasContent);
  55017. pBt->pHasContent = 0;
  55018. }
  55019. /*
  55020. ** Release all of the apPage[] pages for a cursor.
  55021. */
  55022. static void btreeReleaseAllCursorPages(BtCursor *pCur){
  55023. int i;
  55024. for(i=0; i<=pCur->iPage; i++){
  55025. releasePage(pCur->apPage[i]);
  55026. pCur->apPage[i] = 0;
  55027. }
  55028. pCur->iPage = -1;
  55029. }
  55030. /*
  55031. ** The cursor passed as the only argument must point to a valid entry
  55032. ** when this function is called (i.e. have eState==CURSOR_VALID). This
  55033. ** function saves the current cursor key in variables pCur->nKey and
  55034. ** pCur->pKey. SQLITE_OK is returned if successful or an SQLite error
  55035. ** code otherwise.
  55036. **
  55037. ** If the cursor is open on an intkey table, then the integer key
  55038. ** (the rowid) is stored in pCur->nKey and pCur->pKey is left set to
  55039. ** NULL. If the cursor is open on a non-intkey table, then pCur->pKey is
  55040. ** set to point to a malloced buffer pCur->nKey bytes in size containing
  55041. ** the key.
  55042. */
  55043. static int saveCursorKey(BtCursor *pCur){
  55044. int rc = SQLITE_OK;
  55045. assert( CURSOR_VALID==pCur->eState );
  55046. assert( 0==pCur->pKey );
  55047. assert( cursorHoldsMutex(pCur) );
  55048. if( pCur->curIntKey ){
  55049. /* Only the rowid is required for a table btree */
  55050. pCur->nKey = sqlite3BtreeIntegerKey(pCur);
  55051. }else{
  55052. /* For an index btree, save the complete key content */
  55053. void *pKey;
  55054. pCur->nKey = sqlite3BtreePayloadSize(pCur);
  55055. pKey = sqlite3Malloc( pCur->nKey );
  55056. if( pKey ){
  55057. rc = sqlite3BtreeKey(pCur, 0, (int)pCur->nKey, pKey);
  55058. if( rc==SQLITE_OK ){
  55059. pCur->pKey = pKey;
  55060. }else{
  55061. sqlite3_free(pKey);
  55062. }
  55063. }else{
  55064. rc = SQLITE_NOMEM_BKPT;
  55065. }
  55066. }
  55067. assert( !pCur->curIntKey || !pCur->pKey );
  55068. return rc;
  55069. }
  55070. /*
  55071. ** Save the current cursor position in the variables BtCursor.nKey
  55072. ** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
  55073. **
  55074. ** The caller must ensure that the cursor is valid (has eState==CURSOR_VALID)
  55075. ** prior to calling this routine.
  55076. */
  55077. static int saveCursorPosition(BtCursor *pCur){
  55078. int rc;
  55079. assert( CURSOR_VALID==pCur->eState || CURSOR_SKIPNEXT==pCur->eState );
  55080. assert( 0==pCur->pKey );
  55081. assert( cursorHoldsMutex(pCur) );
  55082. if( pCur->eState==CURSOR_SKIPNEXT ){
  55083. pCur->eState = CURSOR_VALID;
  55084. }else{
  55085. pCur->skipNext = 0;
  55086. }
  55087. rc = saveCursorKey(pCur);
  55088. if( rc==SQLITE_OK ){
  55089. btreeReleaseAllCursorPages(pCur);
  55090. pCur->eState = CURSOR_REQUIRESEEK;
  55091. }
  55092. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl|BTCF_AtLast);
  55093. return rc;
  55094. }
  55095. /* Forward reference */
  55096. static int SQLITE_NOINLINE saveCursorsOnList(BtCursor*,Pgno,BtCursor*);
  55097. /*
  55098. ** Save the positions of all cursors (except pExcept) that are open on
  55099. ** the table with root-page iRoot. "Saving the cursor position" means that
  55100. ** the location in the btree is remembered in such a way that it can be
  55101. ** moved back to the same spot after the btree has been modified. This
  55102. ** routine is called just before cursor pExcept is used to modify the
  55103. ** table, for example in BtreeDelete() or BtreeInsert().
  55104. **
  55105. ** If there are two or more cursors on the same btree, then all such
  55106. ** cursors should have their BTCF_Multiple flag set. The btreeCursor()
  55107. ** routine enforces that rule. This routine only needs to be called in
  55108. ** the uncommon case when pExpect has the BTCF_Multiple flag set.
  55109. **
  55110. ** If pExpect!=NULL and if no other cursors are found on the same root-page,
  55111. ** then the BTCF_Multiple flag on pExpect is cleared, to avoid another
  55112. ** pointless call to this routine.
  55113. **
  55114. ** Implementation note: This routine merely checks to see if any cursors
  55115. ** need to be saved. It calls out to saveCursorsOnList() in the (unusual)
  55116. ** event that cursors are in need to being saved.
  55117. */
  55118. static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
  55119. BtCursor *p;
  55120. assert( sqlite3_mutex_held(pBt->mutex) );
  55121. assert( pExcept==0 || pExcept->pBt==pBt );
  55122. for(p=pBt->pCursor; p; p=p->pNext){
  55123. if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ) break;
  55124. }
  55125. if( p ) return saveCursorsOnList(p, iRoot, pExcept);
  55126. if( pExcept ) pExcept->curFlags &= ~BTCF_Multiple;
  55127. return SQLITE_OK;
  55128. }
  55129. /* This helper routine to saveAllCursors does the actual work of saving
  55130. ** the cursors if and when a cursor is found that actually requires saving.
  55131. ** The common case is that no cursors need to be saved, so this routine is
  55132. ** broken out from its caller to avoid unnecessary stack pointer movement.
  55133. */
  55134. static int SQLITE_NOINLINE saveCursorsOnList(
  55135. BtCursor *p, /* The first cursor that needs saving */
  55136. Pgno iRoot, /* Only save cursor with this iRoot. Save all if zero */
  55137. BtCursor *pExcept /* Do not save this cursor */
  55138. ){
  55139. do{
  55140. if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ){
  55141. if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
  55142. int rc = saveCursorPosition(p);
  55143. if( SQLITE_OK!=rc ){
  55144. return rc;
  55145. }
  55146. }else{
  55147. testcase( p->iPage>0 );
  55148. btreeReleaseAllCursorPages(p);
  55149. }
  55150. }
  55151. p = p->pNext;
  55152. }while( p );
  55153. return SQLITE_OK;
  55154. }
  55155. /*
  55156. ** Clear the current cursor position.
  55157. */
  55158. SQLITE_PRIVATE void sqlite3BtreeClearCursor(BtCursor *pCur){
  55159. assert( cursorHoldsMutex(pCur) );
  55160. sqlite3_free(pCur->pKey);
  55161. pCur->pKey = 0;
  55162. pCur->eState = CURSOR_INVALID;
  55163. }
  55164. /*
  55165. ** In this version of BtreeMoveto, pKey is a packed index record
  55166. ** such as is generated by the OP_MakeRecord opcode. Unpack the
  55167. ** record and then call BtreeMovetoUnpacked() to do the work.
  55168. */
  55169. static int btreeMoveto(
  55170. BtCursor *pCur, /* Cursor open on the btree to be searched */
  55171. const void *pKey, /* Packed key if the btree is an index */
  55172. i64 nKey, /* Integer key for tables. Size of pKey for indices */
  55173. int bias, /* Bias search to the high end */
  55174. int *pRes /* Write search results here */
  55175. ){
  55176. int rc; /* Status code */
  55177. UnpackedRecord *pIdxKey; /* Unpacked index key */
  55178. char aSpace[384]; /* Temp space for pIdxKey - to avoid a malloc */
  55179. char *pFree = 0;
  55180. if( pKey ){
  55181. assert( nKey==(i64)(int)nKey );
  55182. pIdxKey = sqlite3VdbeAllocUnpackedRecord(
  55183. pCur->pKeyInfo, aSpace, sizeof(aSpace), &pFree
  55184. );
  55185. if( pIdxKey==0 ) return SQLITE_NOMEM_BKPT;
  55186. sqlite3VdbeRecordUnpack(pCur->pKeyInfo, (int)nKey, pKey, pIdxKey);
  55187. if( pIdxKey->nField==0 ){
  55188. sqlite3DbFree(pCur->pKeyInfo->db, pFree);
  55189. return SQLITE_CORRUPT_BKPT;
  55190. }
  55191. }else{
  55192. pIdxKey = 0;
  55193. }
  55194. rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
  55195. if( pFree ){
  55196. sqlite3DbFree(pCur->pKeyInfo->db, pFree);
  55197. }
  55198. return rc;
  55199. }
  55200. /*
  55201. ** Restore the cursor to the position it was in (or as close to as possible)
  55202. ** when saveCursorPosition() was called. Note that this call deletes the
  55203. ** saved position info stored by saveCursorPosition(), so there can be
  55204. ** at most one effective restoreCursorPosition() call after each
  55205. ** saveCursorPosition().
  55206. */
  55207. static int btreeRestoreCursorPosition(BtCursor *pCur){
  55208. int rc;
  55209. int skipNext;
  55210. assert( cursorOwnsBtShared(pCur) );
  55211. assert( pCur->eState>=CURSOR_REQUIRESEEK );
  55212. if( pCur->eState==CURSOR_FAULT ){
  55213. return pCur->skipNext;
  55214. }
  55215. pCur->eState = CURSOR_INVALID;
  55216. rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &skipNext);
  55217. if( rc==SQLITE_OK ){
  55218. sqlite3_free(pCur->pKey);
  55219. pCur->pKey = 0;
  55220. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
  55221. pCur->skipNext |= skipNext;
  55222. if( pCur->skipNext && pCur->eState==CURSOR_VALID ){
  55223. pCur->eState = CURSOR_SKIPNEXT;
  55224. }
  55225. }
  55226. return rc;
  55227. }
  55228. #define restoreCursorPosition(p) \
  55229. (p->eState>=CURSOR_REQUIRESEEK ? \
  55230. btreeRestoreCursorPosition(p) : \
  55231. SQLITE_OK)
  55232. /*
  55233. ** Determine whether or not a cursor has moved from the position where
  55234. ** it was last placed, or has been invalidated for any other reason.
  55235. ** Cursors can move when the row they are pointing at is deleted out
  55236. ** from under them, for example. Cursor might also move if a btree
  55237. ** is rebalanced.
  55238. **
  55239. ** Calling this routine with a NULL cursor pointer returns false.
  55240. **
  55241. ** Use the separate sqlite3BtreeCursorRestore() routine to restore a cursor
  55242. ** back to where it ought to be if this routine returns true.
  55243. */
  55244. SQLITE_PRIVATE int sqlite3BtreeCursorHasMoved(BtCursor *pCur){
  55245. return pCur->eState!=CURSOR_VALID;
  55246. }
  55247. /*
  55248. ** This routine restores a cursor back to its original position after it
  55249. ** has been moved by some outside activity (such as a btree rebalance or
  55250. ** a row having been deleted out from under the cursor).
  55251. **
  55252. ** On success, the *pDifferentRow parameter is false if the cursor is left
  55253. ** pointing at exactly the same row. *pDifferntRow is the row the cursor
  55254. ** was pointing to has been deleted, forcing the cursor to point to some
  55255. ** nearby row.
  55256. **
  55257. ** This routine should only be called for a cursor that just returned
  55258. ** TRUE from sqlite3BtreeCursorHasMoved().
  55259. */
  55260. SQLITE_PRIVATE int sqlite3BtreeCursorRestore(BtCursor *pCur, int *pDifferentRow){
  55261. int rc;
  55262. assert( pCur!=0 );
  55263. assert( pCur->eState!=CURSOR_VALID );
  55264. rc = restoreCursorPosition(pCur);
  55265. if( rc ){
  55266. *pDifferentRow = 1;
  55267. return rc;
  55268. }
  55269. if( pCur->eState!=CURSOR_VALID ){
  55270. *pDifferentRow = 1;
  55271. }else{
  55272. assert( pCur->skipNext==0 );
  55273. *pDifferentRow = 0;
  55274. }
  55275. return SQLITE_OK;
  55276. }
  55277. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  55278. /*
  55279. ** Provide hints to the cursor. The particular hint given (and the type
  55280. ** and number of the varargs parameters) is determined by the eHintType
  55281. ** parameter. See the definitions of the BTREE_HINT_* macros for details.
  55282. */
  55283. SQLITE_PRIVATE void sqlite3BtreeCursorHint(BtCursor *pCur, int eHintType, ...){
  55284. /* Used only by system that substitute their own storage engine */
  55285. }
  55286. #endif
  55287. /*
  55288. ** Provide flag hints to the cursor.
  55289. */
  55290. SQLITE_PRIVATE void sqlite3BtreeCursorHintFlags(BtCursor *pCur, unsigned x){
  55291. assert( x==BTREE_SEEK_EQ || x==BTREE_BULKLOAD || x==0 );
  55292. pCur->hints = x;
  55293. }
  55294. #ifndef SQLITE_OMIT_AUTOVACUUM
  55295. /*
  55296. ** Given a page number of a regular database page, return the page
  55297. ** number for the pointer-map page that contains the entry for the
  55298. ** input page number.
  55299. **
  55300. ** Return 0 (not a valid page) for pgno==1 since there is
  55301. ** no pointer map associated with page 1. The integrity_check logic
  55302. ** requires that ptrmapPageno(*,1)!=1.
  55303. */
  55304. static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
  55305. int nPagesPerMapPage;
  55306. Pgno iPtrMap, ret;
  55307. assert( sqlite3_mutex_held(pBt->mutex) );
  55308. if( pgno<2 ) return 0;
  55309. nPagesPerMapPage = (pBt->usableSize/5)+1;
  55310. iPtrMap = (pgno-2)/nPagesPerMapPage;
  55311. ret = (iPtrMap*nPagesPerMapPage) + 2;
  55312. if( ret==PENDING_BYTE_PAGE(pBt) ){
  55313. ret++;
  55314. }
  55315. return ret;
  55316. }
  55317. /*
  55318. ** Write an entry into the pointer map.
  55319. **
  55320. ** This routine updates the pointer map entry for page number 'key'
  55321. ** so that it maps to type 'eType' and parent page number 'pgno'.
  55322. **
  55323. ** If *pRC is initially non-zero (non-SQLITE_OK) then this routine is
  55324. ** a no-op. If an error occurs, the appropriate error code is written
  55325. ** into *pRC.
  55326. */
  55327. static void ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent, int *pRC){
  55328. DbPage *pDbPage; /* The pointer map page */
  55329. u8 *pPtrmap; /* The pointer map data */
  55330. Pgno iPtrmap; /* The pointer map page number */
  55331. int offset; /* Offset in pointer map page */
  55332. int rc; /* Return code from subfunctions */
  55333. if( *pRC ) return;
  55334. assert( sqlite3_mutex_held(pBt->mutex) );
  55335. /* The master-journal page number must never be used as a pointer map page */
  55336. assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
  55337. assert( pBt->autoVacuum );
  55338. if( key==0 ){
  55339. *pRC = SQLITE_CORRUPT_BKPT;
  55340. return;
  55341. }
  55342. iPtrmap = PTRMAP_PAGENO(pBt, key);
  55343. rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
  55344. if( rc!=SQLITE_OK ){
  55345. *pRC = rc;
  55346. return;
  55347. }
  55348. offset = PTRMAP_PTROFFSET(iPtrmap, key);
  55349. if( offset<0 ){
  55350. *pRC = SQLITE_CORRUPT_BKPT;
  55351. goto ptrmap_exit;
  55352. }
  55353. assert( offset <= (int)pBt->usableSize-5 );
  55354. pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
  55355. if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
  55356. TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
  55357. *pRC= rc = sqlite3PagerWrite(pDbPage);
  55358. if( rc==SQLITE_OK ){
  55359. pPtrmap[offset] = eType;
  55360. put4byte(&pPtrmap[offset+1], parent);
  55361. }
  55362. }
  55363. ptrmap_exit:
  55364. sqlite3PagerUnref(pDbPage);
  55365. }
  55366. /*
  55367. ** Read an entry from the pointer map.
  55368. **
  55369. ** This routine retrieves the pointer map entry for page 'key', writing
  55370. ** the type and parent page number to *pEType and *pPgno respectively.
  55371. ** An error code is returned if something goes wrong, otherwise SQLITE_OK.
  55372. */
  55373. static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
  55374. DbPage *pDbPage; /* The pointer map page */
  55375. int iPtrmap; /* Pointer map page index */
  55376. u8 *pPtrmap; /* Pointer map page data */
  55377. int offset; /* Offset of entry in pointer map */
  55378. int rc;
  55379. assert( sqlite3_mutex_held(pBt->mutex) );
  55380. iPtrmap = PTRMAP_PAGENO(pBt, key);
  55381. rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
  55382. if( rc!=0 ){
  55383. return rc;
  55384. }
  55385. pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
  55386. offset = PTRMAP_PTROFFSET(iPtrmap, key);
  55387. if( offset<0 ){
  55388. sqlite3PagerUnref(pDbPage);
  55389. return SQLITE_CORRUPT_BKPT;
  55390. }
  55391. assert( offset <= (int)pBt->usableSize-5 );
  55392. assert( pEType!=0 );
  55393. *pEType = pPtrmap[offset];
  55394. if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
  55395. sqlite3PagerUnref(pDbPage);
  55396. if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_BKPT;
  55397. return SQLITE_OK;
  55398. }
  55399. #else /* if defined SQLITE_OMIT_AUTOVACUUM */
  55400. #define ptrmapPut(w,x,y,z,rc)
  55401. #define ptrmapGet(w,x,y,z) SQLITE_OK
  55402. #define ptrmapPutOvflPtr(x, y, rc)
  55403. #endif
  55404. /*
  55405. ** Given a btree page and a cell index (0 means the first cell on
  55406. ** the page, 1 means the second cell, and so forth) return a pointer
  55407. ** to the cell content.
  55408. **
  55409. ** findCellPastPtr() does the same except it skips past the initial
  55410. ** 4-byte child pointer found on interior pages, if there is one.
  55411. **
  55412. ** This routine works only for pages that do not contain overflow cells.
  55413. */
  55414. #define findCell(P,I) \
  55415. ((P)->aData + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
  55416. #define findCellPastPtr(P,I) \
  55417. ((P)->aDataOfst + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
  55418. /*
  55419. ** This is common tail processing for btreeParseCellPtr() and
  55420. ** btreeParseCellPtrIndex() for the case when the cell does not fit entirely
  55421. ** on a single B-tree page. Make necessary adjustments to the CellInfo
  55422. ** structure.
  55423. */
  55424. static SQLITE_NOINLINE void btreeParseCellAdjustSizeForOverflow(
  55425. MemPage *pPage, /* Page containing the cell */
  55426. u8 *pCell, /* Pointer to the cell text. */
  55427. CellInfo *pInfo /* Fill in this structure */
  55428. ){
  55429. /* If the payload will not fit completely on the local page, we have
  55430. ** to decide how much to store locally and how much to spill onto
  55431. ** overflow pages. The strategy is to minimize the amount of unused
  55432. ** space on overflow pages while keeping the amount of local storage
  55433. ** in between minLocal and maxLocal.
  55434. **
  55435. ** Warning: changing the way overflow payload is distributed in any
  55436. ** way will result in an incompatible file format.
  55437. */
  55438. int minLocal; /* Minimum amount of payload held locally */
  55439. int maxLocal; /* Maximum amount of payload held locally */
  55440. int surplus; /* Overflow payload available for local storage */
  55441. minLocal = pPage->minLocal;
  55442. maxLocal = pPage->maxLocal;
  55443. surplus = minLocal + (pInfo->nPayload - minLocal)%(pPage->pBt->usableSize-4);
  55444. testcase( surplus==maxLocal );
  55445. testcase( surplus==maxLocal+1 );
  55446. if( surplus <= maxLocal ){
  55447. pInfo->nLocal = (u16)surplus;
  55448. }else{
  55449. pInfo->nLocal = (u16)minLocal;
  55450. }
  55451. pInfo->nSize = (u16)(&pInfo->pPayload[pInfo->nLocal] - pCell) + 4;
  55452. }
  55453. /*
  55454. ** The following routines are implementations of the MemPage.xParseCell()
  55455. ** method.
  55456. **
  55457. ** Parse a cell content block and fill in the CellInfo structure.
  55458. **
  55459. ** btreeParseCellPtr() => table btree leaf nodes
  55460. ** btreeParseCellNoPayload() => table btree internal nodes
  55461. ** btreeParseCellPtrIndex() => index btree nodes
  55462. **
  55463. ** There is also a wrapper function btreeParseCell() that works for
  55464. ** all MemPage types and that references the cell by index rather than
  55465. ** by pointer.
  55466. */
  55467. static void btreeParseCellPtrNoPayload(
  55468. MemPage *pPage, /* Page containing the cell */
  55469. u8 *pCell, /* Pointer to the cell text. */
  55470. CellInfo *pInfo /* Fill in this structure */
  55471. ){
  55472. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55473. assert( pPage->leaf==0 );
  55474. assert( pPage->childPtrSize==4 );
  55475. #ifndef SQLITE_DEBUG
  55476. UNUSED_PARAMETER(pPage);
  55477. #endif
  55478. pInfo->nSize = 4 + getVarint(&pCell[4], (u64*)&pInfo->nKey);
  55479. pInfo->nPayload = 0;
  55480. pInfo->nLocal = 0;
  55481. pInfo->pPayload = 0;
  55482. return;
  55483. }
  55484. static void btreeParseCellPtr(
  55485. MemPage *pPage, /* Page containing the cell */
  55486. u8 *pCell, /* Pointer to the cell text. */
  55487. CellInfo *pInfo /* Fill in this structure */
  55488. ){
  55489. u8 *pIter; /* For scanning through pCell */
  55490. u32 nPayload; /* Number of bytes of cell payload */
  55491. u64 iKey; /* Extracted Key value */
  55492. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55493. assert( pPage->leaf==0 || pPage->leaf==1 );
  55494. assert( pPage->intKeyLeaf );
  55495. assert( pPage->childPtrSize==0 );
  55496. pIter = pCell;
  55497. /* The next block of code is equivalent to:
  55498. **
  55499. ** pIter += getVarint32(pIter, nPayload);
  55500. **
  55501. ** The code is inlined to avoid a function call.
  55502. */
  55503. nPayload = *pIter;
  55504. if( nPayload>=0x80 ){
  55505. u8 *pEnd = &pIter[8];
  55506. nPayload &= 0x7f;
  55507. do{
  55508. nPayload = (nPayload<<7) | (*++pIter & 0x7f);
  55509. }while( (*pIter)>=0x80 && pIter<pEnd );
  55510. }
  55511. pIter++;
  55512. /* The next block of code is equivalent to:
  55513. **
  55514. ** pIter += getVarint(pIter, (u64*)&pInfo->nKey);
  55515. **
  55516. ** The code is inlined to avoid a function call.
  55517. */
  55518. iKey = *pIter;
  55519. if( iKey>=0x80 ){
  55520. u8 *pEnd = &pIter[7];
  55521. iKey &= 0x7f;
  55522. while(1){
  55523. iKey = (iKey<<7) | (*++pIter & 0x7f);
  55524. if( (*pIter)<0x80 ) break;
  55525. if( pIter>=pEnd ){
  55526. iKey = (iKey<<8) | *++pIter;
  55527. break;
  55528. }
  55529. }
  55530. }
  55531. pIter++;
  55532. pInfo->nKey = *(i64*)&iKey;
  55533. pInfo->nPayload = nPayload;
  55534. pInfo->pPayload = pIter;
  55535. testcase( nPayload==pPage->maxLocal );
  55536. testcase( nPayload==pPage->maxLocal+1 );
  55537. if( nPayload<=pPage->maxLocal ){
  55538. /* This is the (easy) common case where the entire payload fits
  55539. ** on the local page. No overflow is required.
  55540. */
  55541. pInfo->nSize = nPayload + (u16)(pIter - pCell);
  55542. if( pInfo->nSize<4 ) pInfo->nSize = 4;
  55543. pInfo->nLocal = (u16)nPayload;
  55544. }else{
  55545. btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
  55546. }
  55547. }
  55548. static void btreeParseCellPtrIndex(
  55549. MemPage *pPage, /* Page containing the cell */
  55550. u8 *pCell, /* Pointer to the cell text. */
  55551. CellInfo *pInfo /* Fill in this structure */
  55552. ){
  55553. u8 *pIter; /* For scanning through pCell */
  55554. u32 nPayload; /* Number of bytes of cell payload */
  55555. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55556. assert( pPage->leaf==0 || pPage->leaf==1 );
  55557. assert( pPage->intKeyLeaf==0 );
  55558. pIter = pCell + pPage->childPtrSize;
  55559. nPayload = *pIter;
  55560. if( nPayload>=0x80 ){
  55561. u8 *pEnd = &pIter[8];
  55562. nPayload &= 0x7f;
  55563. do{
  55564. nPayload = (nPayload<<7) | (*++pIter & 0x7f);
  55565. }while( *(pIter)>=0x80 && pIter<pEnd );
  55566. }
  55567. pIter++;
  55568. pInfo->nKey = nPayload;
  55569. pInfo->nPayload = nPayload;
  55570. pInfo->pPayload = pIter;
  55571. testcase( nPayload==pPage->maxLocal );
  55572. testcase( nPayload==pPage->maxLocal+1 );
  55573. if( nPayload<=pPage->maxLocal ){
  55574. /* This is the (easy) common case where the entire payload fits
  55575. ** on the local page. No overflow is required.
  55576. */
  55577. pInfo->nSize = nPayload + (u16)(pIter - pCell);
  55578. if( pInfo->nSize<4 ) pInfo->nSize = 4;
  55579. pInfo->nLocal = (u16)nPayload;
  55580. }else{
  55581. btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
  55582. }
  55583. }
  55584. static void btreeParseCell(
  55585. MemPage *pPage, /* Page containing the cell */
  55586. int iCell, /* The cell index. First cell is 0 */
  55587. CellInfo *pInfo /* Fill in this structure */
  55588. ){
  55589. pPage->xParseCell(pPage, findCell(pPage, iCell), pInfo);
  55590. }
  55591. /*
  55592. ** The following routines are implementations of the MemPage.xCellSize
  55593. ** method.
  55594. **
  55595. ** Compute the total number of bytes that a Cell needs in the cell
  55596. ** data area of the btree-page. The return number includes the cell
  55597. ** data header and the local payload, but not any overflow page or
  55598. ** the space used by the cell pointer.
  55599. **
  55600. ** cellSizePtrNoPayload() => table internal nodes
  55601. ** cellSizePtr() => all index nodes & table leaf nodes
  55602. */
  55603. static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
  55604. u8 *pIter = pCell + pPage->childPtrSize; /* For looping over bytes of pCell */
  55605. u8 *pEnd; /* End mark for a varint */
  55606. u32 nSize; /* Size value to return */
  55607. #ifdef SQLITE_DEBUG
  55608. /* The value returned by this function should always be the same as
  55609. ** the (CellInfo.nSize) value found by doing a full parse of the
  55610. ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
  55611. ** this function verifies that this invariant is not violated. */
  55612. CellInfo debuginfo;
  55613. pPage->xParseCell(pPage, pCell, &debuginfo);
  55614. #endif
  55615. nSize = *pIter;
  55616. if( nSize>=0x80 ){
  55617. pEnd = &pIter[8];
  55618. nSize &= 0x7f;
  55619. do{
  55620. nSize = (nSize<<7) | (*++pIter & 0x7f);
  55621. }while( *(pIter)>=0x80 && pIter<pEnd );
  55622. }
  55623. pIter++;
  55624. if( pPage->intKey ){
  55625. /* pIter now points at the 64-bit integer key value, a variable length
  55626. ** integer. The following block moves pIter to point at the first byte
  55627. ** past the end of the key value. */
  55628. pEnd = &pIter[9];
  55629. while( (*pIter++)&0x80 && pIter<pEnd );
  55630. }
  55631. testcase( nSize==pPage->maxLocal );
  55632. testcase( nSize==pPage->maxLocal+1 );
  55633. if( nSize<=pPage->maxLocal ){
  55634. nSize += (u32)(pIter - pCell);
  55635. if( nSize<4 ) nSize = 4;
  55636. }else{
  55637. int minLocal = pPage->minLocal;
  55638. nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
  55639. testcase( nSize==pPage->maxLocal );
  55640. testcase( nSize==pPage->maxLocal+1 );
  55641. if( nSize>pPage->maxLocal ){
  55642. nSize = minLocal;
  55643. }
  55644. nSize += 4 + (u16)(pIter - pCell);
  55645. }
  55646. assert( nSize==debuginfo.nSize || CORRUPT_DB );
  55647. return (u16)nSize;
  55648. }
  55649. static u16 cellSizePtrNoPayload(MemPage *pPage, u8 *pCell){
  55650. u8 *pIter = pCell + 4; /* For looping over bytes of pCell */
  55651. u8 *pEnd; /* End mark for a varint */
  55652. #ifdef SQLITE_DEBUG
  55653. /* The value returned by this function should always be the same as
  55654. ** the (CellInfo.nSize) value found by doing a full parse of the
  55655. ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
  55656. ** this function verifies that this invariant is not violated. */
  55657. CellInfo debuginfo;
  55658. pPage->xParseCell(pPage, pCell, &debuginfo);
  55659. #else
  55660. UNUSED_PARAMETER(pPage);
  55661. #endif
  55662. assert( pPage->childPtrSize==4 );
  55663. pEnd = pIter + 9;
  55664. while( (*pIter++)&0x80 && pIter<pEnd );
  55665. assert( debuginfo.nSize==(u16)(pIter - pCell) || CORRUPT_DB );
  55666. return (u16)(pIter - pCell);
  55667. }
  55668. #ifdef SQLITE_DEBUG
  55669. /* This variation on cellSizePtr() is used inside of assert() statements
  55670. ** only. */
  55671. static u16 cellSize(MemPage *pPage, int iCell){
  55672. return pPage->xCellSize(pPage, findCell(pPage, iCell));
  55673. }
  55674. #endif
  55675. #ifndef SQLITE_OMIT_AUTOVACUUM
  55676. /*
  55677. ** If the cell pCell, part of page pPage contains a pointer
  55678. ** to an overflow page, insert an entry into the pointer-map
  55679. ** for the overflow page.
  55680. */
  55681. static void ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell, int *pRC){
  55682. CellInfo info;
  55683. if( *pRC ) return;
  55684. assert( pCell!=0 );
  55685. pPage->xParseCell(pPage, pCell, &info);
  55686. if( info.nLocal<info.nPayload ){
  55687. Pgno ovfl = get4byte(&pCell[info.nSize-4]);
  55688. ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, pRC);
  55689. }
  55690. }
  55691. #endif
  55692. /*
  55693. ** Defragment the page given. All Cells are moved to the
  55694. ** end of the page and all free space is collected into one
  55695. ** big FreeBlk that occurs in between the header and cell
  55696. ** pointer array and the cell content area.
  55697. **
  55698. ** EVIDENCE-OF: R-44582-60138 SQLite may from time to time reorganize a
  55699. ** b-tree page so that there are no freeblocks or fragment bytes, all
  55700. ** unused bytes are contained in the unallocated space region, and all
  55701. ** cells are packed tightly at the end of the page.
  55702. */
  55703. static int defragmentPage(MemPage *pPage){
  55704. int i; /* Loop counter */
  55705. int pc; /* Address of the i-th cell */
  55706. int hdr; /* Offset to the page header */
  55707. int size; /* Size of a cell */
  55708. int usableSize; /* Number of usable bytes on a page */
  55709. int cellOffset; /* Offset to the cell pointer array */
  55710. int cbrk; /* Offset to the cell content area */
  55711. int nCell; /* Number of cells on the page */
  55712. unsigned char *data; /* The page data */
  55713. unsigned char *temp; /* Temp area for cell content */
  55714. unsigned char *src; /* Source of content */
  55715. int iCellFirst; /* First allowable cell index */
  55716. int iCellLast; /* Last possible cell index */
  55717. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  55718. assert( pPage->pBt!=0 );
  55719. assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
  55720. assert( pPage->nOverflow==0 );
  55721. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55722. temp = 0;
  55723. src = data = pPage->aData;
  55724. hdr = pPage->hdrOffset;
  55725. cellOffset = pPage->cellOffset;
  55726. nCell = pPage->nCell;
  55727. assert( nCell==get2byte(&data[hdr+3]) );
  55728. usableSize = pPage->pBt->usableSize;
  55729. cbrk = usableSize;
  55730. iCellFirst = cellOffset + 2*nCell;
  55731. iCellLast = usableSize - 4;
  55732. for(i=0; i<nCell; i++){
  55733. u8 *pAddr; /* The i-th cell pointer */
  55734. pAddr = &data[cellOffset + i*2];
  55735. pc = get2byte(pAddr);
  55736. testcase( pc==iCellFirst );
  55737. testcase( pc==iCellLast );
  55738. /* These conditions have already been verified in btreeInitPage()
  55739. ** if PRAGMA cell_size_check=ON.
  55740. */
  55741. if( pc<iCellFirst || pc>iCellLast ){
  55742. return SQLITE_CORRUPT_BKPT;
  55743. }
  55744. assert( pc>=iCellFirst && pc<=iCellLast );
  55745. size = pPage->xCellSize(pPage, &src[pc]);
  55746. cbrk -= size;
  55747. if( cbrk<iCellFirst || pc+size>usableSize ){
  55748. return SQLITE_CORRUPT_BKPT;
  55749. }
  55750. assert( cbrk+size<=usableSize && cbrk>=iCellFirst );
  55751. testcase( cbrk+size==usableSize );
  55752. testcase( pc+size==usableSize );
  55753. put2byte(pAddr, cbrk);
  55754. if( temp==0 ){
  55755. int x;
  55756. if( cbrk==pc ) continue;
  55757. temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
  55758. x = get2byte(&data[hdr+5]);
  55759. memcpy(&temp[x], &data[x], (cbrk+size) - x);
  55760. src = temp;
  55761. }
  55762. memcpy(&data[cbrk], &src[pc], size);
  55763. }
  55764. assert( cbrk>=iCellFirst );
  55765. put2byte(&data[hdr+5], cbrk);
  55766. data[hdr+1] = 0;
  55767. data[hdr+2] = 0;
  55768. data[hdr+7] = 0;
  55769. memset(&data[iCellFirst], 0, cbrk-iCellFirst);
  55770. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  55771. if( cbrk-iCellFirst!=pPage->nFree ){
  55772. return SQLITE_CORRUPT_BKPT;
  55773. }
  55774. return SQLITE_OK;
  55775. }
  55776. /*
  55777. ** Search the free-list on page pPg for space to store a cell nByte bytes in
  55778. ** size. If one can be found, return a pointer to the space and remove it
  55779. ** from the free-list.
  55780. **
  55781. ** If no suitable space can be found on the free-list, return NULL.
  55782. **
  55783. ** This function may detect corruption within pPg. If corruption is
  55784. ** detected then *pRc is set to SQLITE_CORRUPT and NULL is returned.
  55785. **
  55786. ** Slots on the free list that are between 1 and 3 bytes larger than nByte
  55787. ** will be ignored if adding the extra space to the fragmentation count
  55788. ** causes the fragmentation count to exceed 60.
  55789. */
  55790. static u8 *pageFindSlot(MemPage *pPg, int nByte, int *pRc){
  55791. const int hdr = pPg->hdrOffset;
  55792. u8 * const aData = pPg->aData;
  55793. int iAddr = hdr + 1;
  55794. int pc = get2byte(&aData[iAddr]);
  55795. int x;
  55796. int usableSize = pPg->pBt->usableSize;
  55797. assert( pc>0 );
  55798. do{
  55799. int size; /* Size of the free slot */
  55800. /* EVIDENCE-OF: R-06866-39125 Freeblocks are always connected in order of
  55801. ** increasing offset. */
  55802. if( pc>usableSize-4 || pc<iAddr+4 ){
  55803. *pRc = SQLITE_CORRUPT_BKPT;
  55804. return 0;
  55805. }
  55806. /* EVIDENCE-OF: R-22710-53328 The third and fourth bytes of each
  55807. ** freeblock form a big-endian integer which is the size of the freeblock
  55808. ** in bytes, including the 4-byte header. */
  55809. size = get2byte(&aData[pc+2]);
  55810. if( (x = size - nByte)>=0 ){
  55811. testcase( x==4 );
  55812. testcase( x==3 );
  55813. if( pc < pPg->cellOffset+2*pPg->nCell || size+pc > usableSize ){
  55814. *pRc = SQLITE_CORRUPT_BKPT;
  55815. return 0;
  55816. }else if( x<4 ){
  55817. /* EVIDENCE-OF: R-11498-58022 In a well-formed b-tree page, the total
  55818. ** number of bytes in fragments may not exceed 60. */
  55819. if( aData[hdr+7]>57 ) return 0;
  55820. /* Remove the slot from the free-list. Update the number of
  55821. ** fragmented bytes within the page. */
  55822. memcpy(&aData[iAddr], &aData[pc], 2);
  55823. aData[hdr+7] += (u8)x;
  55824. }else{
  55825. /* The slot remains on the free-list. Reduce its size to account
  55826. ** for the portion used by the new allocation. */
  55827. put2byte(&aData[pc+2], x);
  55828. }
  55829. return &aData[pc + x];
  55830. }
  55831. iAddr = pc;
  55832. pc = get2byte(&aData[pc]);
  55833. }while( pc );
  55834. return 0;
  55835. }
  55836. /*
  55837. ** Allocate nByte bytes of space from within the B-Tree page passed
  55838. ** as the first argument. Write into *pIdx the index into pPage->aData[]
  55839. ** of the first byte of allocated space. Return either SQLITE_OK or
  55840. ** an error code (usually SQLITE_CORRUPT).
  55841. **
  55842. ** The caller guarantees that there is sufficient space to make the
  55843. ** allocation. This routine might need to defragment in order to bring
  55844. ** all the space together, however. This routine will avoid using
  55845. ** the first two bytes past the cell pointer area since presumably this
  55846. ** allocation is being made in order to insert a new cell, so we will
  55847. ** also end up needing a new cell pointer.
  55848. */
  55849. static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
  55850. const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
  55851. u8 * const data = pPage->aData; /* Local cache of pPage->aData */
  55852. int top; /* First byte of cell content area */
  55853. int rc = SQLITE_OK; /* Integer return code */
  55854. int gap; /* First byte of gap between cell pointers and cell content */
  55855. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  55856. assert( pPage->pBt );
  55857. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55858. assert( nByte>=0 ); /* Minimum cell size is 4 */
  55859. assert( pPage->nFree>=nByte );
  55860. assert( pPage->nOverflow==0 );
  55861. assert( nByte < (int)(pPage->pBt->usableSize-8) );
  55862. assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
  55863. gap = pPage->cellOffset + 2*pPage->nCell;
  55864. assert( gap<=65536 );
  55865. /* EVIDENCE-OF: R-29356-02391 If the database uses a 65536-byte page size
  55866. ** and the reserved space is zero (the usual value for reserved space)
  55867. ** then the cell content offset of an empty page wants to be 65536.
  55868. ** However, that integer is too large to be stored in a 2-byte unsigned
  55869. ** integer, so a value of 0 is used in its place. */
  55870. top = get2byte(&data[hdr+5]);
  55871. assert( top<=(int)pPage->pBt->usableSize ); /* Prevent by getAndInitPage() */
  55872. if( gap>top ){
  55873. if( top==0 && pPage->pBt->usableSize==65536 ){
  55874. top = 65536;
  55875. }else{
  55876. return SQLITE_CORRUPT_BKPT;
  55877. }
  55878. }
  55879. /* If there is enough space between gap and top for one more cell pointer
  55880. ** array entry offset, and if the freelist is not empty, then search the
  55881. ** freelist looking for a free slot big enough to satisfy the request.
  55882. */
  55883. testcase( gap+2==top );
  55884. testcase( gap+1==top );
  55885. testcase( gap==top );
  55886. if( (data[hdr+2] || data[hdr+1]) && gap+2<=top ){
  55887. u8 *pSpace = pageFindSlot(pPage, nByte, &rc);
  55888. if( pSpace ){
  55889. assert( pSpace>=data && (pSpace - data)<65536 );
  55890. *pIdx = (int)(pSpace - data);
  55891. return SQLITE_OK;
  55892. }else if( rc ){
  55893. return rc;
  55894. }
  55895. }
  55896. /* The request could not be fulfilled using a freelist slot. Check
  55897. ** to see if defragmentation is necessary.
  55898. */
  55899. testcase( gap+2+nByte==top );
  55900. if( gap+2+nByte>top ){
  55901. assert( pPage->nCell>0 || CORRUPT_DB );
  55902. rc = defragmentPage(pPage);
  55903. if( rc ) return rc;
  55904. top = get2byteNotZero(&data[hdr+5]);
  55905. assert( gap+nByte<=top );
  55906. }
  55907. /* Allocate memory from the gap in between the cell pointer array
  55908. ** and the cell content area. The btreeInitPage() call has already
  55909. ** validated the freelist. Given that the freelist is valid, there
  55910. ** is no way that the allocation can extend off the end of the page.
  55911. ** The assert() below verifies the previous sentence.
  55912. */
  55913. top -= nByte;
  55914. put2byte(&data[hdr+5], top);
  55915. assert( top+nByte <= (int)pPage->pBt->usableSize );
  55916. *pIdx = top;
  55917. return SQLITE_OK;
  55918. }
  55919. /*
  55920. ** Return a section of the pPage->aData to the freelist.
  55921. ** The first byte of the new free block is pPage->aData[iStart]
  55922. ** and the size of the block is iSize bytes.
  55923. **
  55924. ** Adjacent freeblocks are coalesced.
  55925. **
  55926. ** Note that even though the freeblock list was checked by btreeInitPage(),
  55927. ** that routine will not detect overlap between cells or freeblocks. Nor
  55928. ** does it detect cells or freeblocks that encrouch into the reserved bytes
  55929. ** at the end of the page. So do additional corruption checks inside this
  55930. ** routine and return SQLITE_CORRUPT if any problems are found.
  55931. */
  55932. static int freeSpace(MemPage *pPage, u16 iStart, u16 iSize){
  55933. u16 iPtr; /* Address of ptr to next freeblock */
  55934. u16 iFreeBlk; /* Address of the next freeblock */
  55935. u8 hdr; /* Page header size. 0 or 100 */
  55936. u8 nFrag = 0; /* Reduction in fragmentation */
  55937. u16 iOrigSize = iSize; /* Original value of iSize */
  55938. u32 iLast = pPage->pBt->usableSize-4; /* Largest possible freeblock offset */
  55939. u32 iEnd = iStart + iSize; /* First byte past the iStart buffer */
  55940. unsigned char *data = pPage->aData; /* Page content */
  55941. assert( pPage->pBt!=0 );
  55942. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  55943. assert( CORRUPT_DB || iStart>=pPage->hdrOffset+6+pPage->childPtrSize );
  55944. assert( CORRUPT_DB || iEnd <= pPage->pBt->usableSize );
  55945. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  55946. assert( iSize>=4 ); /* Minimum cell size is 4 */
  55947. assert( iStart<=iLast );
  55948. /* Overwrite deleted information with zeros when the secure_delete
  55949. ** option is enabled */
  55950. if( pPage->pBt->btsFlags & BTS_SECURE_DELETE ){
  55951. memset(&data[iStart], 0, iSize);
  55952. }
  55953. /* The list of freeblocks must be in ascending order. Find the
  55954. ** spot on the list where iStart should be inserted.
  55955. */
  55956. hdr = pPage->hdrOffset;
  55957. iPtr = hdr + 1;
  55958. if( data[iPtr+1]==0 && data[iPtr]==0 ){
  55959. iFreeBlk = 0; /* Shortcut for the case when the freelist is empty */
  55960. }else{
  55961. while( (iFreeBlk = get2byte(&data[iPtr]))<iStart ){
  55962. if( iFreeBlk<iPtr+4 ){
  55963. if( iFreeBlk==0 ) break;
  55964. return SQLITE_CORRUPT_BKPT;
  55965. }
  55966. iPtr = iFreeBlk;
  55967. }
  55968. if( iFreeBlk>iLast ) return SQLITE_CORRUPT_BKPT;
  55969. assert( iFreeBlk>iPtr || iFreeBlk==0 );
  55970. /* At this point:
  55971. ** iFreeBlk: First freeblock after iStart, or zero if none
  55972. ** iPtr: The address of a pointer to iFreeBlk
  55973. **
  55974. ** Check to see if iFreeBlk should be coalesced onto the end of iStart.
  55975. */
  55976. if( iFreeBlk && iEnd+3>=iFreeBlk ){
  55977. nFrag = iFreeBlk - iEnd;
  55978. if( iEnd>iFreeBlk ) return SQLITE_CORRUPT_BKPT;
  55979. iEnd = iFreeBlk + get2byte(&data[iFreeBlk+2]);
  55980. if( iEnd > pPage->pBt->usableSize ) return SQLITE_CORRUPT_BKPT;
  55981. iSize = iEnd - iStart;
  55982. iFreeBlk = get2byte(&data[iFreeBlk]);
  55983. }
  55984. /* If iPtr is another freeblock (that is, if iPtr is not the freelist
  55985. ** pointer in the page header) then check to see if iStart should be
  55986. ** coalesced onto the end of iPtr.
  55987. */
  55988. if( iPtr>hdr+1 ){
  55989. int iPtrEnd = iPtr + get2byte(&data[iPtr+2]);
  55990. if( iPtrEnd+3>=iStart ){
  55991. if( iPtrEnd>iStart ) return SQLITE_CORRUPT_BKPT;
  55992. nFrag += iStart - iPtrEnd;
  55993. iSize = iEnd - iPtr;
  55994. iStart = iPtr;
  55995. }
  55996. }
  55997. if( nFrag>data[hdr+7] ) return SQLITE_CORRUPT_BKPT;
  55998. data[hdr+7] -= nFrag;
  55999. }
  56000. if( iStart==get2byte(&data[hdr+5]) ){
  56001. /* The new freeblock is at the beginning of the cell content area,
  56002. ** so just extend the cell content area rather than create another
  56003. ** freelist entry */
  56004. if( iPtr!=hdr+1 ) return SQLITE_CORRUPT_BKPT;
  56005. put2byte(&data[hdr+1], iFreeBlk);
  56006. put2byte(&data[hdr+5], iEnd);
  56007. }else{
  56008. /* Insert the new freeblock into the freelist */
  56009. put2byte(&data[iPtr], iStart);
  56010. put2byte(&data[iStart], iFreeBlk);
  56011. put2byte(&data[iStart+2], iSize);
  56012. }
  56013. pPage->nFree += iOrigSize;
  56014. return SQLITE_OK;
  56015. }
  56016. /*
  56017. ** Decode the flags byte (the first byte of the header) for a page
  56018. ** and initialize fields of the MemPage structure accordingly.
  56019. **
  56020. ** Only the following combinations are supported. Anything different
  56021. ** indicates a corrupt database files:
  56022. **
  56023. ** PTF_ZERODATA
  56024. ** PTF_ZERODATA | PTF_LEAF
  56025. ** PTF_LEAFDATA | PTF_INTKEY
  56026. ** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
  56027. */
  56028. static int decodeFlags(MemPage *pPage, int flagByte){
  56029. BtShared *pBt; /* A copy of pPage->pBt */
  56030. assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
  56031. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  56032. pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
  56033. flagByte &= ~PTF_LEAF;
  56034. pPage->childPtrSize = 4-4*pPage->leaf;
  56035. pPage->xCellSize = cellSizePtr;
  56036. pBt = pPage->pBt;
  56037. if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
  56038. /* EVIDENCE-OF: R-07291-35328 A value of 5 (0x05) means the page is an
  56039. ** interior table b-tree page. */
  56040. assert( (PTF_LEAFDATA|PTF_INTKEY)==5 );
  56041. /* EVIDENCE-OF: R-26900-09176 A value of 13 (0x0d) means the page is a
  56042. ** leaf table b-tree page. */
  56043. assert( (PTF_LEAFDATA|PTF_INTKEY|PTF_LEAF)==13 );
  56044. pPage->intKey = 1;
  56045. if( pPage->leaf ){
  56046. pPage->intKeyLeaf = 1;
  56047. pPage->xParseCell = btreeParseCellPtr;
  56048. }else{
  56049. pPage->intKeyLeaf = 0;
  56050. pPage->xCellSize = cellSizePtrNoPayload;
  56051. pPage->xParseCell = btreeParseCellPtrNoPayload;
  56052. }
  56053. pPage->maxLocal = pBt->maxLeaf;
  56054. pPage->minLocal = pBt->minLeaf;
  56055. }else if( flagByte==PTF_ZERODATA ){
  56056. /* EVIDENCE-OF: R-43316-37308 A value of 2 (0x02) means the page is an
  56057. ** interior index b-tree page. */
  56058. assert( (PTF_ZERODATA)==2 );
  56059. /* EVIDENCE-OF: R-59615-42828 A value of 10 (0x0a) means the page is a
  56060. ** leaf index b-tree page. */
  56061. assert( (PTF_ZERODATA|PTF_LEAF)==10 );
  56062. pPage->intKey = 0;
  56063. pPage->intKeyLeaf = 0;
  56064. pPage->xParseCell = btreeParseCellPtrIndex;
  56065. pPage->maxLocal = pBt->maxLocal;
  56066. pPage->minLocal = pBt->minLocal;
  56067. }else{
  56068. /* EVIDENCE-OF: R-47608-56469 Any other value for the b-tree page type is
  56069. ** an error. */
  56070. return SQLITE_CORRUPT_BKPT;
  56071. }
  56072. pPage->max1bytePayload = pBt->max1bytePayload;
  56073. return SQLITE_OK;
  56074. }
  56075. /*
  56076. ** Initialize the auxiliary information for a disk block.
  56077. **
  56078. ** Return SQLITE_OK on success. If we see that the page does
  56079. ** not contain a well-formed database page, then return
  56080. ** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
  56081. ** guarantee that the page is well-formed. It only shows that
  56082. ** we failed to detect any corruption.
  56083. */
  56084. static int btreeInitPage(MemPage *pPage){
  56085. assert( pPage->pBt!=0 );
  56086. assert( pPage->pBt->db!=0 );
  56087. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  56088. assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
  56089. assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
  56090. assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
  56091. if( !pPage->isInit ){
  56092. u16 pc; /* Address of a freeblock within pPage->aData[] */
  56093. u8 hdr; /* Offset to beginning of page header */
  56094. u8 *data; /* Equal to pPage->aData */
  56095. BtShared *pBt; /* The main btree structure */
  56096. int usableSize; /* Amount of usable space on each page */
  56097. u16 cellOffset; /* Offset from start of page to first cell pointer */
  56098. int nFree; /* Number of unused bytes on the page */
  56099. int top; /* First byte of the cell content area */
  56100. int iCellFirst; /* First allowable cell or freeblock offset */
  56101. int iCellLast; /* Last possible cell or freeblock offset */
  56102. pBt = pPage->pBt;
  56103. hdr = pPage->hdrOffset;
  56104. data = pPage->aData;
  56105. /* EVIDENCE-OF: R-28594-02890 The one-byte flag at offset 0 indicating
  56106. ** the b-tree page type. */
  56107. if( decodeFlags(pPage, data[hdr]) ) return SQLITE_CORRUPT_BKPT;
  56108. assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
  56109. pPage->maskPage = (u16)(pBt->pageSize - 1);
  56110. pPage->nOverflow = 0;
  56111. usableSize = pBt->usableSize;
  56112. pPage->cellOffset = cellOffset = hdr + 8 + pPage->childPtrSize;
  56113. pPage->aDataEnd = &data[usableSize];
  56114. pPage->aCellIdx = &data[cellOffset];
  56115. pPage->aDataOfst = &data[pPage->childPtrSize];
  56116. /* EVIDENCE-OF: R-58015-48175 The two-byte integer at offset 5 designates
  56117. ** the start of the cell content area. A zero value for this integer is
  56118. ** interpreted as 65536. */
  56119. top = get2byteNotZero(&data[hdr+5]);
  56120. /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
  56121. ** number of cells on the page. */
  56122. pPage->nCell = get2byte(&data[hdr+3]);
  56123. if( pPage->nCell>MX_CELL(pBt) ){
  56124. /* To many cells for a single page. The page must be corrupt */
  56125. return SQLITE_CORRUPT_BKPT;
  56126. }
  56127. testcase( pPage->nCell==MX_CELL(pBt) );
  56128. /* EVIDENCE-OF: R-24089-57979 If a page contains no cells (which is only
  56129. ** possible for a root page of a table that contains no rows) then the
  56130. ** offset to the cell content area will equal the page size minus the
  56131. ** bytes of reserved space. */
  56132. assert( pPage->nCell>0 || top==usableSize || CORRUPT_DB );
  56133. /* A malformed database page might cause us to read past the end
  56134. ** of page when parsing a cell.
  56135. **
  56136. ** The following block of code checks early to see if a cell extends
  56137. ** past the end of a page boundary and causes SQLITE_CORRUPT to be
  56138. ** returned if it does.
  56139. */
  56140. iCellFirst = cellOffset + 2*pPage->nCell;
  56141. iCellLast = usableSize - 4;
  56142. if( pBt->db->flags & SQLITE_CellSizeCk ){
  56143. int i; /* Index into the cell pointer array */
  56144. int sz; /* Size of a cell */
  56145. if( !pPage->leaf ) iCellLast--;
  56146. for(i=0; i<pPage->nCell; i++){
  56147. pc = get2byteAligned(&data[cellOffset+i*2]);
  56148. testcase( pc==iCellFirst );
  56149. testcase( pc==iCellLast );
  56150. if( pc<iCellFirst || pc>iCellLast ){
  56151. return SQLITE_CORRUPT_BKPT;
  56152. }
  56153. sz = pPage->xCellSize(pPage, &data[pc]);
  56154. testcase( pc+sz==usableSize );
  56155. if( pc+sz>usableSize ){
  56156. return SQLITE_CORRUPT_BKPT;
  56157. }
  56158. }
  56159. if( !pPage->leaf ) iCellLast++;
  56160. }
  56161. /* Compute the total free space on the page
  56162. ** EVIDENCE-OF: R-23588-34450 The two-byte integer at offset 1 gives the
  56163. ** start of the first freeblock on the page, or is zero if there are no
  56164. ** freeblocks. */
  56165. pc = get2byte(&data[hdr+1]);
  56166. nFree = data[hdr+7] + top; /* Init nFree to non-freeblock free space */
  56167. while( pc>0 ){
  56168. u16 next, size;
  56169. if( pc<iCellFirst || pc>iCellLast ){
  56170. /* EVIDENCE-OF: R-55530-52930 In a well-formed b-tree page, there will
  56171. ** always be at least one cell before the first freeblock.
  56172. **
  56173. ** Or, the freeblock is off the end of the page
  56174. */
  56175. return SQLITE_CORRUPT_BKPT;
  56176. }
  56177. next = get2byte(&data[pc]);
  56178. size = get2byte(&data[pc+2]);
  56179. if( (next>0 && next<=pc+size+3) || pc+size>usableSize ){
  56180. /* Free blocks must be in ascending order. And the last byte of
  56181. ** the free-block must lie on the database page. */
  56182. return SQLITE_CORRUPT_BKPT;
  56183. }
  56184. nFree = nFree + size;
  56185. pc = next;
  56186. }
  56187. /* At this point, nFree contains the sum of the offset to the start
  56188. ** of the cell-content area plus the number of free bytes within
  56189. ** the cell-content area. If this is greater than the usable-size
  56190. ** of the page, then the page must be corrupted. This check also
  56191. ** serves to verify that the offset to the start of the cell-content
  56192. ** area, according to the page header, lies within the page.
  56193. */
  56194. if( nFree>usableSize ){
  56195. return SQLITE_CORRUPT_BKPT;
  56196. }
  56197. pPage->nFree = (u16)(nFree - iCellFirst);
  56198. pPage->isInit = 1;
  56199. }
  56200. return SQLITE_OK;
  56201. }
  56202. /*
  56203. ** Set up a raw page so that it looks like a database page holding
  56204. ** no entries.
  56205. */
  56206. static void zeroPage(MemPage *pPage, int flags){
  56207. unsigned char *data = pPage->aData;
  56208. BtShared *pBt = pPage->pBt;
  56209. u8 hdr = pPage->hdrOffset;
  56210. u16 first;
  56211. assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
  56212. assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
  56213. assert( sqlite3PagerGetData(pPage->pDbPage) == data );
  56214. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  56215. assert( sqlite3_mutex_held(pBt->mutex) );
  56216. if( pBt->btsFlags & BTS_SECURE_DELETE ){
  56217. memset(&data[hdr], 0, pBt->usableSize - hdr);
  56218. }
  56219. data[hdr] = (char)flags;
  56220. first = hdr + ((flags&PTF_LEAF)==0 ? 12 : 8);
  56221. memset(&data[hdr+1], 0, 4);
  56222. data[hdr+7] = 0;
  56223. put2byte(&data[hdr+5], pBt->usableSize);
  56224. pPage->nFree = (u16)(pBt->usableSize - first);
  56225. decodeFlags(pPage, flags);
  56226. pPage->cellOffset = first;
  56227. pPage->aDataEnd = &data[pBt->usableSize];
  56228. pPage->aCellIdx = &data[first];
  56229. pPage->aDataOfst = &data[pPage->childPtrSize];
  56230. pPage->nOverflow = 0;
  56231. assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
  56232. pPage->maskPage = (u16)(pBt->pageSize - 1);
  56233. pPage->nCell = 0;
  56234. pPage->isInit = 1;
  56235. }
  56236. /*
  56237. ** Convert a DbPage obtained from the pager into a MemPage used by
  56238. ** the btree layer.
  56239. */
  56240. static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
  56241. MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
  56242. if( pgno!=pPage->pgno ){
  56243. pPage->aData = sqlite3PagerGetData(pDbPage);
  56244. pPage->pDbPage = pDbPage;
  56245. pPage->pBt = pBt;
  56246. pPage->pgno = pgno;
  56247. pPage->hdrOffset = pgno==1 ? 100 : 0;
  56248. }
  56249. assert( pPage->aData==sqlite3PagerGetData(pDbPage) );
  56250. return pPage;
  56251. }
  56252. /*
  56253. ** Get a page from the pager. Initialize the MemPage.pBt and
  56254. ** MemPage.aData elements if needed. See also: btreeGetUnusedPage().
  56255. **
  56256. ** If the PAGER_GET_NOCONTENT flag is set, it means that we do not care
  56257. ** about the content of the page at this time. So do not go to the disk
  56258. ** to fetch the content. Just fill in the content with zeros for now.
  56259. ** If in the future we call sqlite3PagerWrite() on this page, that
  56260. ** means we have started to be concerned about content and the disk
  56261. ** read should occur at that point.
  56262. */
  56263. static int btreeGetPage(
  56264. BtShared *pBt, /* The btree */
  56265. Pgno pgno, /* Number of the page to fetch */
  56266. MemPage **ppPage, /* Return the page in this parameter */
  56267. int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
  56268. ){
  56269. int rc;
  56270. DbPage *pDbPage;
  56271. assert( flags==0 || flags==PAGER_GET_NOCONTENT || flags==PAGER_GET_READONLY );
  56272. assert( sqlite3_mutex_held(pBt->mutex) );
  56273. rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, flags);
  56274. if( rc ) return rc;
  56275. *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
  56276. return SQLITE_OK;
  56277. }
  56278. /*
  56279. ** Retrieve a page from the pager cache. If the requested page is not
  56280. ** already in the pager cache return NULL. Initialize the MemPage.pBt and
  56281. ** MemPage.aData elements if needed.
  56282. */
  56283. static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
  56284. DbPage *pDbPage;
  56285. assert( sqlite3_mutex_held(pBt->mutex) );
  56286. pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
  56287. if( pDbPage ){
  56288. return btreePageFromDbPage(pDbPage, pgno, pBt);
  56289. }
  56290. return 0;
  56291. }
  56292. /*
  56293. ** Return the size of the database file in pages. If there is any kind of
  56294. ** error, return ((unsigned int)-1).
  56295. */
  56296. static Pgno btreePagecount(BtShared *pBt){
  56297. return pBt->nPage;
  56298. }
  56299. SQLITE_PRIVATE u32 sqlite3BtreeLastPage(Btree *p){
  56300. assert( sqlite3BtreeHoldsMutex(p) );
  56301. assert( ((p->pBt->nPage)&0x8000000)==0 );
  56302. return btreePagecount(p->pBt);
  56303. }
  56304. /*
  56305. ** Get a page from the pager and initialize it.
  56306. **
  56307. ** If pCur!=0 then the page is being fetched as part of a moveToChild()
  56308. ** call. Do additional sanity checking on the page in this case.
  56309. ** And if the fetch fails, this routine must decrement pCur->iPage.
  56310. **
  56311. ** The page is fetched as read-write unless pCur is not NULL and is
  56312. ** a read-only cursor.
  56313. **
  56314. ** If an error occurs, then *ppPage is undefined. It
  56315. ** may remain unchanged, or it may be set to an invalid value.
  56316. */
  56317. static int getAndInitPage(
  56318. BtShared *pBt, /* The database file */
  56319. Pgno pgno, /* Number of the page to get */
  56320. MemPage **ppPage, /* Write the page pointer here */
  56321. BtCursor *pCur, /* Cursor to receive the page, or NULL */
  56322. int bReadOnly /* True for a read-only page */
  56323. ){
  56324. int rc;
  56325. DbPage *pDbPage;
  56326. assert( sqlite3_mutex_held(pBt->mutex) );
  56327. assert( pCur==0 || ppPage==&pCur->apPage[pCur->iPage] );
  56328. assert( pCur==0 || bReadOnly==pCur->curPagerFlags );
  56329. assert( pCur==0 || pCur->iPage>0 );
  56330. if( pgno>btreePagecount(pBt) ){
  56331. rc = SQLITE_CORRUPT_BKPT;
  56332. goto getAndInitPage_error;
  56333. }
  56334. rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, bReadOnly);
  56335. if( rc ){
  56336. goto getAndInitPage_error;
  56337. }
  56338. *ppPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
  56339. if( (*ppPage)->isInit==0 ){
  56340. btreePageFromDbPage(pDbPage, pgno, pBt);
  56341. rc = btreeInitPage(*ppPage);
  56342. if( rc!=SQLITE_OK ){
  56343. releasePage(*ppPage);
  56344. goto getAndInitPage_error;
  56345. }
  56346. }
  56347. assert( (*ppPage)->pgno==pgno );
  56348. assert( (*ppPage)->aData==sqlite3PagerGetData(pDbPage) );
  56349. /* If obtaining a child page for a cursor, we must verify that the page is
  56350. ** compatible with the root page. */
  56351. if( pCur && ((*ppPage)->nCell<1 || (*ppPage)->intKey!=pCur->curIntKey) ){
  56352. rc = SQLITE_CORRUPT_BKPT;
  56353. releasePage(*ppPage);
  56354. goto getAndInitPage_error;
  56355. }
  56356. return SQLITE_OK;
  56357. getAndInitPage_error:
  56358. if( pCur ) pCur->iPage--;
  56359. testcase( pgno==0 );
  56360. assert( pgno!=0 || rc==SQLITE_CORRUPT );
  56361. return rc;
  56362. }
  56363. /*
  56364. ** Release a MemPage. This should be called once for each prior
  56365. ** call to btreeGetPage.
  56366. */
  56367. static void releasePageNotNull(MemPage *pPage){
  56368. assert( pPage->aData );
  56369. assert( pPage->pBt );
  56370. assert( pPage->pDbPage!=0 );
  56371. assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
  56372. assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
  56373. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  56374. sqlite3PagerUnrefNotNull(pPage->pDbPage);
  56375. }
  56376. static void releasePage(MemPage *pPage){
  56377. if( pPage ) releasePageNotNull(pPage);
  56378. }
  56379. /*
  56380. ** Get an unused page.
  56381. **
  56382. ** This works just like btreeGetPage() with the addition:
  56383. **
  56384. ** * If the page is already in use for some other purpose, immediately
  56385. ** release it and return an SQLITE_CURRUPT error.
  56386. ** * Make sure the isInit flag is clear
  56387. */
  56388. static int btreeGetUnusedPage(
  56389. BtShared *pBt, /* The btree */
  56390. Pgno pgno, /* Number of the page to fetch */
  56391. MemPage **ppPage, /* Return the page in this parameter */
  56392. int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
  56393. ){
  56394. int rc = btreeGetPage(pBt, pgno, ppPage, flags);
  56395. if( rc==SQLITE_OK ){
  56396. if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
  56397. releasePage(*ppPage);
  56398. *ppPage = 0;
  56399. return SQLITE_CORRUPT_BKPT;
  56400. }
  56401. (*ppPage)->isInit = 0;
  56402. }else{
  56403. *ppPage = 0;
  56404. }
  56405. return rc;
  56406. }
  56407. /*
  56408. ** During a rollback, when the pager reloads information into the cache
  56409. ** so that the cache is restored to its original state at the start of
  56410. ** the transaction, for each page restored this routine is called.
  56411. **
  56412. ** This routine needs to reset the extra data section at the end of the
  56413. ** page to agree with the restored data.
  56414. */
  56415. static void pageReinit(DbPage *pData){
  56416. MemPage *pPage;
  56417. pPage = (MemPage *)sqlite3PagerGetExtra(pData);
  56418. assert( sqlite3PagerPageRefcount(pData)>0 );
  56419. if( pPage->isInit ){
  56420. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  56421. pPage->isInit = 0;
  56422. if( sqlite3PagerPageRefcount(pData)>1 ){
  56423. /* pPage might not be a btree page; it might be an overflow page
  56424. ** or ptrmap page or a free page. In those cases, the following
  56425. ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
  56426. ** But no harm is done by this. And it is very important that
  56427. ** btreeInitPage() be called on every btree page so we make
  56428. ** the call for every page that comes in for re-initing. */
  56429. btreeInitPage(pPage);
  56430. }
  56431. }
  56432. }
  56433. /*
  56434. ** Invoke the busy handler for a btree.
  56435. */
  56436. static int btreeInvokeBusyHandler(void *pArg){
  56437. BtShared *pBt = (BtShared*)pArg;
  56438. assert( pBt->db );
  56439. assert( sqlite3_mutex_held(pBt->db->mutex) );
  56440. return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
  56441. }
  56442. /*
  56443. ** Open a database file.
  56444. **
  56445. ** zFilename is the name of the database file. If zFilename is NULL
  56446. ** then an ephemeral database is created. The ephemeral database might
  56447. ** be exclusively in memory, or it might use a disk-based memory cache.
  56448. ** Either way, the ephemeral database will be automatically deleted
  56449. ** when sqlite3BtreeClose() is called.
  56450. **
  56451. ** If zFilename is ":memory:" then an in-memory database is created
  56452. ** that is automatically destroyed when it is closed.
  56453. **
  56454. ** The "flags" parameter is a bitmask that might contain bits like
  56455. ** BTREE_OMIT_JOURNAL and/or BTREE_MEMORY.
  56456. **
  56457. ** If the database is already opened in the same database connection
  56458. ** and we are in shared cache mode, then the open will fail with an
  56459. ** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
  56460. ** objects in the same database connection since doing so will lead
  56461. ** to problems with locking.
  56462. */
  56463. SQLITE_PRIVATE int sqlite3BtreeOpen(
  56464. sqlite3_vfs *pVfs, /* VFS to use for this b-tree */
  56465. const char *zFilename, /* Name of the file containing the BTree database */
  56466. sqlite3 *db, /* Associated database handle */
  56467. Btree **ppBtree, /* Pointer to new Btree object written here */
  56468. int flags, /* Options */
  56469. int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
  56470. ){
  56471. BtShared *pBt = 0; /* Shared part of btree structure */
  56472. Btree *p; /* Handle to return */
  56473. sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
  56474. int rc = SQLITE_OK; /* Result code from this function */
  56475. u8 nReserve; /* Byte of unused space on each page */
  56476. unsigned char zDbHeader[100]; /* Database header content */
  56477. /* True if opening an ephemeral, temporary database */
  56478. const int isTempDb = zFilename==0 || zFilename[0]==0;
  56479. /* Set the variable isMemdb to true for an in-memory database, or
  56480. ** false for a file-based database.
  56481. */
  56482. #ifdef SQLITE_OMIT_MEMORYDB
  56483. const int isMemdb = 0;
  56484. #else
  56485. const int isMemdb = (zFilename && strcmp(zFilename, ":memory:")==0)
  56486. || (isTempDb && sqlite3TempInMemory(db))
  56487. || (vfsFlags & SQLITE_OPEN_MEMORY)!=0;
  56488. #endif
  56489. assert( db!=0 );
  56490. assert( pVfs!=0 );
  56491. assert( sqlite3_mutex_held(db->mutex) );
  56492. assert( (flags&0xff)==flags ); /* flags fit in 8 bits */
  56493. /* Only a BTREE_SINGLE database can be BTREE_UNORDERED */
  56494. assert( (flags & BTREE_UNORDERED)==0 || (flags & BTREE_SINGLE)!=0 );
  56495. /* A BTREE_SINGLE database is always a temporary and/or ephemeral */
  56496. assert( (flags & BTREE_SINGLE)==0 || isTempDb );
  56497. if( isMemdb ){
  56498. flags |= BTREE_MEMORY;
  56499. }
  56500. if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (isMemdb || isTempDb) ){
  56501. vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
  56502. }
  56503. p = sqlite3MallocZero(sizeof(Btree));
  56504. if( !p ){
  56505. return SQLITE_NOMEM_BKPT;
  56506. }
  56507. p->inTrans = TRANS_NONE;
  56508. p->db = db;
  56509. #ifndef SQLITE_OMIT_SHARED_CACHE
  56510. p->lock.pBtree = p;
  56511. p->lock.iTable = 1;
  56512. #endif
  56513. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  56514. /*
  56515. ** If this Btree is a candidate for shared cache, try to find an
  56516. ** existing BtShared object that we can share with
  56517. */
  56518. if( isTempDb==0 && (isMemdb==0 || (vfsFlags&SQLITE_OPEN_URI)!=0) ){
  56519. if( vfsFlags & SQLITE_OPEN_SHAREDCACHE ){
  56520. int nFilename = sqlite3Strlen30(zFilename)+1;
  56521. int nFullPathname = pVfs->mxPathname+1;
  56522. char *zFullPathname = sqlite3Malloc(MAX(nFullPathname,nFilename));
  56523. MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
  56524. p->sharable = 1;
  56525. if( !zFullPathname ){
  56526. sqlite3_free(p);
  56527. return SQLITE_NOMEM_BKPT;
  56528. }
  56529. if( isMemdb ){
  56530. memcpy(zFullPathname, zFilename, nFilename);
  56531. }else{
  56532. rc = sqlite3OsFullPathname(pVfs, zFilename,
  56533. nFullPathname, zFullPathname);
  56534. if( rc ){
  56535. sqlite3_free(zFullPathname);
  56536. sqlite3_free(p);
  56537. return rc;
  56538. }
  56539. }
  56540. #if SQLITE_THREADSAFE
  56541. mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
  56542. sqlite3_mutex_enter(mutexOpen);
  56543. mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  56544. sqlite3_mutex_enter(mutexShared);
  56545. #endif
  56546. for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
  56547. assert( pBt->nRef>0 );
  56548. if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager, 0))
  56549. && sqlite3PagerVfs(pBt->pPager)==pVfs ){
  56550. int iDb;
  56551. for(iDb=db->nDb-1; iDb>=0; iDb--){
  56552. Btree *pExisting = db->aDb[iDb].pBt;
  56553. if( pExisting && pExisting->pBt==pBt ){
  56554. sqlite3_mutex_leave(mutexShared);
  56555. sqlite3_mutex_leave(mutexOpen);
  56556. sqlite3_free(zFullPathname);
  56557. sqlite3_free(p);
  56558. return SQLITE_CONSTRAINT;
  56559. }
  56560. }
  56561. p->pBt = pBt;
  56562. pBt->nRef++;
  56563. break;
  56564. }
  56565. }
  56566. sqlite3_mutex_leave(mutexShared);
  56567. sqlite3_free(zFullPathname);
  56568. }
  56569. #ifdef SQLITE_DEBUG
  56570. else{
  56571. /* In debug mode, we mark all persistent databases as sharable
  56572. ** even when they are not. This exercises the locking code and
  56573. ** gives more opportunity for asserts(sqlite3_mutex_held())
  56574. ** statements to find locking problems.
  56575. */
  56576. p->sharable = 1;
  56577. }
  56578. #endif
  56579. }
  56580. #endif
  56581. if( pBt==0 ){
  56582. /*
  56583. ** The following asserts make sure that structures used by the btree are
  56584. ** the right size. This is to guard against size changes that result
  56585. ** when compiling on a different architecture.
  56586. */
  56587. assert( sizeof(i64)==8 );
  56588. assert( sizeof(u64)==8 );
  56589. assert( sizeof(u32)==4 );
  56590. assert( sizeof(u16)==2 );
  56591. assert( sizeof(Pgno)==4 );
  56592. pBt = sqlite3MallocZero( sizeof(*pBt) );
  56593. if( pBt==0 ){
  56594. rc = SQLITE_NOMEM_BKPT;
  56595. goto btree_open_out;
  56596. }
  56597. rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
  56598. EXTRA_SIZE, flags, vfsFlags, pageReinit);
  56599. if( rc==SQLITE_OK ){
  56600. sqlite3PagerSetMmapLimit(pBt->pPager, db->szMmap);
  56601. rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
  56602. }
  56603. if( rc!=SQLITE_OK ){
  56604. goto btree_open_out;
  56605. }
  56606. pBt->openFlags = (u8)flags;
  56607. pBt->db = db;
  56608. sqlite3PagerSetBusyhandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
  56609. p->pBt = pBt;
  56610. pBt->pCursor = 0;
  56611. pBt->pPage1 = 0;
  56612. if( sqlite3PagerIsreadonly(pBt->pPager) ) pBt->btsFlags |= BTS_READ_ONLY;
  56613. #ifdef SQLITE_SECURE_DELETE
  56614. pBt->btsFlags |= BTS_SECURE_DELETE;
  56615. #endif
  56616. /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
  56617. ** determined by the 2-byte integer located at an offset of 16 bytes from
  56618. ** the beginning of the database file. */
  56619. pBt->pageSize = (zDbHeader[16]<<8) | (zDbHeader[17]<<16);
  56620. if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
  56621. || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
  56622. pBt->pageSize = 0;
  56623. #ifndef SQLITE_OMIT_AUTOVACUUM
  56624. /* If the magic name ":memory:" will create an in-memory database, then
  56625. ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
  56626. ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
  56627. ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
  56628. ** regular file-name. In this case the auto-vacuum applies as per normal.
  56629. */
  56630. if( zFilename && !isMemdb ){
  56631. pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
  56632. pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
  56633. }
  56634. #endif
  56635. nReserve = 0;
  56636. }else{
  56637. /* EVIDENCE-OF: R-37497-42412 The size of the reserved region is
  56638. ** determined by the one-byte unsigned integer found at an offset of 20
  56639. ** into the database file header. */
  56640. nReserve = zDbHeader[20];
  56641. pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  56642. #ifndef SQLITE_OMIT_AUTOVACUUM
  56643. pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
  56644. pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
  56645. #endif
  56646. }
  56647. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
  56648. if( rc ) goto btree_open_out;
  56649. pBt->usableSize = pBt->pageSize - nReserve;
  56650. assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
  56651. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  56652. /* Add the new BtShared object to the linked list sharable BtShareds.
  56653. */
  56654. pBt->nRef = 1;
  56655. if( p->sharable ){
  56656. MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
  56657. MUTEX_LOGIC( mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);)
  56658. if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
  56659. pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
  56660. if( pBt->mutex==0 ){
  56661. rc = SQLITE_NOMEM_BKPT;
  56662. goto btree_open_out;
  56663. }
  56664. }
  56665. sqlite3_mutex_enter(mutexShared);
  56666. pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
  56667. GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
  56668. sqlite3_mutex_leave(mutexShared);
  56669. }
  56670. #endif
  56671. }
  56672. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  56673. /* If the new Btree uses a sharable pBtShared, then link the new
  56674. ** Btree into the list of all sharable Btrees for the same connection.
  56675. ** The list is kept in ascending order by pBt address.
  56676. */
  56677. if( p->sharable ){
  56678. int i;
  56679. Btree *pSib;
  56680. for(i=0; i<db->nDb; i++){
  56681. if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
  56682. while( pSib->pPrev ){ pSib = pSib->pPrev; }
  56683. if( (uptr)p->pBt<(uptr)pSib->pBt ){
  56684. p->pNext = pSib;
  56685. p->pPrev = 0;
  56686. pSib->pPrev = p;
  56687. }else{
  56688. while( pSib->pNext && (uptr)pSib->pNext->pBt<(uptr)p->pBt ){
  56689. pSib = pSib->pNext;
  56690. }
  56691. p->pNext = pSib->pNext;
  56692. p->pPrev = pSib;
  56693. if( p->pNext ){
  56694. p->pNext->pPrev = p;
  56695. }
  56696. pSib->pNext = p;
  56697. }
  56698. break;
  56699. }
  56700. }
  56701. }
  56702. #endif
  56703. *ppBtree = p;
  56704. btree_open_out:
  56705. if( rc!=SQLITE_OK ){
  56706. if( pBt && pBt->pPager ){
  56707. sqlite3PagerClose(pBt->pPager);
  56708. }
  56709. sqlite3_free(pBt);
  56710. sqlite3_free(p);
  56711. *ppBtree = 0;
  56712. }else{
  56713. /* If the B-Tree was successfully opened, set the pager-cache size to the
  56714. ** default value. Except, when opening on an existing shared pager-cache,
  56715. ** do not change the pager-cache size.
  56716. */
  56717. if( sqlite3BtreeSchema(p, 0, 0)==0 ){
  56718. sqlite3PagerSetCachesize(p->pBt->pPager, SQLITE_DEFAULT_CACHE_SIZE);
  56719. }
  56720. }
  56721. if( mutexOpen ){
  56722. assert( sqlite3_mutex_held(mutexOpen) );
  56723. sqlite3_mutex_leave(mutexOpen);
  56724. }
  56725. assert( rc!=SQLITE_OK || sqlite3BtreeConnectionCount(*ppBtree)>0 );
  56726. return rc;
  56727. }
  56728. /*
  56729. ** Decrement the BtShared.nRef counter. When it reaches zero,
  56730. ** remove the BtShared structure from the sharing list. Return
  56731. ** true if the BtShared.nRef counter reaches zero and return
  56732. ** false if it is still positive.
  56733. */
  56734. static int removeFromSharingList(BtShared *pBt){
  56735. #ifndef SQLITE_OMIT_SHARED_CACHE
  56736. MUTEX_LOGIC( sqlite3_mutex *pMaster; )
  56737. BtShared *pList;
  56738. int removed = 0;
  56739. assert( sqlite3_mutex_notheld(pBt->mutex) );
  56740. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  56741. sqlite3_mutex_enter(pMaster);
  56742. pBt->nRef--;
  56743. if( pBt->nRef<=0 ){
  56744. if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
  56745. GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
  56746. }else{
  56747. pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
  56748. while( ALWAYS(pList) && pList->pNext!=pBt ){
  56749. pList=pList->pNext;
  56750. }
  56751. if( ALWAYS(pList) ){
  56752. pList->pNext = pBt->pNext;
  56753. }
  56754. }
  56755. if( SQLITE_THREADSAFE ){
  56756. sqlite3_mutex_free(pBt->mutex);
  56757. }
  56758. removed = 1;
  56759. }
  56760. sqlite3_mutex_leave(pMaster);
  56761. return removed;
  56762. #else
  56763. return 1;
  56764. #endif
  56765. }
  56766. /*
  56767. ** Make sure pBt->pTmpSpace points to an allocation of
  56768. ** MX_CELL_SIZE(pBt) bytes with a 4-byte prefix for a left-child
  56769. ** pointer.
  56770. */
  56771. static void allocateTempSpace(BtShared *pBt){
  56772. if( !pBt->pTmpSpace ){
  56773. pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
  56774. /* One of the uses of pBt->pTmpSpace is to format cells before
  56775. ** inserting them into a leaf page (function fillInCell()). If
  56776. ** a cell is less than 4 bytes in size, it is rounded up to 4 bytes
  56777. ** by the various routines that manipulate binary cells. Which
  56778. ** can mean that fillInCell() only initializes the first 2 or 3
  56779. ** bytes of pTmpSpace, but that the first 4 bytes are copied from
  56780. ** it into a database page. This is not actually a problem, but it
  56781. ** does cause a valgrind error when the 1 or 2 bytes of unitialized
  56782. ** data is passed to system call write(). So to avoid this error,
  56783. ** zero the first 4 bytes of temp space here.
  56784. **
  56785. ** Also: Provide four bytes of initialized space before the
  56786. ** beginning of pTmpSpace as an area available to prepend the
  56787. ** left-child pointer to the beginning of a cell.
  56788. */
  56789. if( pBt->pTmpSpace ){
  56790. memset(pBt->pTmpSpace, 0, 8);
  56791. pBt->pTmpSpace += 4;
  56792. }
  56793. }
  56794. }
  56795. /*
  56796. ** Free the pBt->pTmpSpace allocation
  56797. */
  56798. static void freeTempSpace(BtShared *pBt){
  56799. if( pBt->pTmpSpace ){
  56800. pBt->pTmpSpace -= 4;
  56801. sqlite3PageFree(pBt->pTmpSpace);
  56802. pBt->pTmpSpace = 0;
  56803. }
  56804. }
  56805. /*
  56806. ** Close an open database and invalidate all cursors.
  56807. */
  56808. SQLITE_PRIVATE int sqlite3BtreeClose(Btree *p){
  56809. BtShared *pBt = p->pBt;
  56810. BtCursor *pCur;
  56811. /* Close all cursors opened via this handle. */
  56812. assert( sqlite3_mutex_held(p->db->mutex) );
  56813. sqlite3BtreeEnter(p);
  56814. pCur = pBt->pCursor;
  56815. while( pCur ){
  56816. BtCursor *pTmp = pCur;
  56817. pCur = pCur->pNext;
  56818. if( pTmp->pBtree==p ){
  56819. sqlite3BtreeCloseCursor(pTmp);
  56820. }
  56821. }
  56822. /* Rollback any active transaction and free the handle structure.
  56823. ** The call to sqlite3BtreeRollback() drops any table-locks held by
  56824. ** this handle.
  56825. */
  56826. sqlite3BtreeRollback(p, SQLITE_OK, 0);
  56827. sqlite3BtreeLeave(p);
  56828. /* If there are still other outstanding references to the shared-btree
  56829. ** structure, return now. The remainder of this procedure cleans
  56830. ** up the shared-btree.
  56831. */
  56832. assert( p->wantToLock==0 && p->locked==0 );
  56833. if( !p->sharable || removeFromSharingList(pBt) ){
  56834. /* The pBt is no longer on the sharing list, so we can access
  56835. ** it without having to hold the mutex.
  56836. **
  56837. ** Clean out and delete the BtShared object.
  56838. */
  56839. assert( !pBt->pCursor );
  56840. sqlite3PagerClose(pBt->pPager);
  56841. if( pBt->xFreeSchema && pBt->pSchema ){
  56842. pBt->xFreeSchema(pBt->pSchema);
  56843. }
  56844. sqlite3DbFree(0, pBt->pSchema);
  56845. freeTempSpace(pBt);
  56846. sqlite3_free(pBt);
  56847. }
  56848. #ifndef SQLITE_OMIT_SHARED_CACHE
  56849. assert( p->wantToLock==0 );
  56850. assert( p->locked==0 );
  56851. if( p->pPrev ) p->pPrev->pNext = p->pNext;
  56852. if( p->pNext ) p->pNext->pPrev = p->pPrev;
  56853. #endif
  56854. sqlite3_free(p);
  56855. return SQLITE_OK;
  56856. }
  56857. /*
  56858. ** Change the "soft" limit on the number of pages in the cache.
  56859. ** Unused and unmodified pages will be recycled when the number of
  56860. ** pages in the cache exceeds this soft limit. But the size of the
  56861. ** cache is allowed to grow larger than this limit if it contains
  56862. ** dirty pages or pages still in active use.
  56863. */
  56864. SQLITE_PRIVATE int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
  56865. BtShared *pBt = p->pBt;
  56866. assert( sqlite3_mutex_held(p->db->mutex) );
  56867. sqlite3BtreeEnter(p);
  56868. sqlite3PagerSetCachesize(pBt->pPager, mxPage);
  56869. sqlite3BtreeLeave(p);
  56870. return SQLITE_OK;
  56871. }
  56872. /*
  56873. ** Change the "spill" limit on the number of pages in the cache.
  56874. ** If the number of pages exceeds this limit during a write transaction,
  56875. ** the pager might attempt to "spill" pages to the journal early in
  56876. ** order to free up memory.
  56877. **
  56878. ** The value returned is the current spill size. If zero is passed
  56879. ** as an argument, no changes are made to the spill size setting, so
  56880. ** using mxPage of 0 is a way to query the current spill size.
  56881. */
  56882. SQLITE_PRIVATE int sqlite3BtreeSetSpillSize(Btree *p, int mxPage){
  56883. BtShared *pBt = p->pBt;
  56884. int res;
  56885. assert( sqlite3_mutex_held(p->db->mutex) );
  56886. sqlite3BtreeEnter(p);
  56887. res = sqlite3PagerSetSpillsize(pBt->pPager, mxPage);
  56888. sqlite3BtreeLeave(p);
  56889. return res;
  56890. }
  56891. #if SQLITE_MAX_MMAP_SIZE>0
  56892. /*
  56893. ** Change the limit on the amount of the database file that may be
  56894. ** memory mapped.
  56895. */
  56896. SQLITE_PRIVATE int sqlite3BtreeSetMmapLimit(Btree *p, sqlite3_int64 szMmap){
  56897. BtShared *pBt = p->pBt;
  56898. assert( sqlite3_mutex_held(p->db->mutex) );
  56899. sqlite3BtreeEnter(p);
  56900. sqlite3PagerSetMmapLimit(pBt->pPager, szMmap);
  56901. sqlite3BtreeLeave(p);
  56902. return SQLITE_OK;
  56903. }
  56904. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  56905. /*
  56906. ** Change the way data is synced to disk in order to increase or decrease
  56907. ** how well the database resists damage due to OS crashes and power
  56908. ** failures. Level 1 is the same as asynchronous (no syncs() occur and
  56909. ** there is a high probability of damage) Level 2 is the default. There
  56910. ** is a very low but non-zero probability of damage. Level 3 reduces the
  56911. ** probability of damage to near zero but with a write performance reduction.
  56912. */
  56913. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  56914. SQLITE_PRIVATE int sqlite3BtreeSetPagerFlags(
  56915. Btree *p, /* The btree to set the safety level on */
  56916. unsigned pgFlags /* Various PAGER_* flags */
  56917. ){
  56918. BtShared *pBt = p->pBt;
  56919. assert( sqlite3_mutex_held(p->db->mutex) );
  56920. sqlite3BtreeEnter(p);
  56921. sqlite3PagerSetFlags(pBt->pPager, pgFlags);
  56922. sqlite3BtreeLeave(p);
  56923. return SQLITE_OK;
  56924. }
  56925. #endif
  56926. /*
  56927. ** Change the default pages size and the number of reserved bytes per page.
  56928. ** Or, if the page size has already been fixed, return SQLITE_READONLY
  56929. ** without changing anything.
  56930. **
  56931. ** The page size must be a power of 2 between 512 and 65536. If the page
  56932. ** size supplied does not meet this constraint then the page size is not
  56933. ** changed.
  56934. **
  56935. ** Page sizes are constrained to be a power of two so that the region
  56936. ** of the database file used for locking (beginning at PENDING_BYTE,
  56937. ** the first byte past the 1GB boundary, 0x40000000) needs to occur
  56938. ** at the beginning of a page.
  56939. **
  56940. ** If parameter nReserve is less than zero, then the number of reserved
  56941. ** bytes per page is left unchanged.
  56942. **
  56943. ** If the iFix!=0 then the BTS_PAGESIZE_FIXED flag is set so that the page size
  56944. ** and autovacuum mode can no longer be changed.
  56945. */
  56946. SQLITE_PRIVATE int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
  56947. int rc = SQLITE_OK;
  56948. BtShared *pBt = p->pBt;
  56949. assert( nReserve>=-1 && nReserve<=255 );
  56950. sqlite3BtreeEnter(p);
  56951. #if SQLITE_HAS_CODEC
  56952. if( nReserve>pBt->optimalReserve ) pBt->optimalReserve = (u8)nReserve;
  56953. #endif
  56954. if( pBt->btsFlags & BTS_PAGESIZE_FIXED ){
  56955. sqlite3BtreeLeave(p);
  56956. return SQLITE_READONLY;
  56957. }
  56958. if( nReserve<0 ){
  56959. nReserve = pBt->pageSize - pBt->usableSize;
  56960. }
  56961. assert( nReserve>=0 && nReserve<=255 );
  56962. if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
  56963. ((pageSize-1)&pageSize)==0 ){
  56964. assert( (pageSize & 7)==0 );
  56965. assert( !pBt->pCursor );
  56966. pBt->pageSize = (u32)pageSize;
  56967. freeTempSpace(pBt);
  56968. }
  56969. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
  56970. pBt->usableSize = pBt->pageSize - (u16)nReserve;
  56971. if( iFix ) pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  56972. sqlite3BtreeLeave(p);
  56973. return rc;
  56974. }
  56975. /*
  56976. ** Return the currently defined page size
  56977. */
  56978. SQLITE_PRIVATE int sqlite3BtreeGetPageSize(Btree *p){
  56979. return p->pBt->pageSize;
  56980. }
  56981. /*
  56982. ** This function is similar to sqlite3BtreeGetReserve(), except that it
  56983. ** may only be called if it is guaranteed that the b-tree mutex is already
  56984. ** held.
  56985. **
  56986. ** This is useful in one special case in the backup API code where it is
  56987. ** known that the shared b-tree mutex is held, but the mutex on the
  56988. ** database handle that owns *p is not. In this case if sqlite3BtreeEnter()
  56989. ** were to be called, it might collide with some other operation on the
  56990. ** database handle that owns *p, causing undefined behavior.
  56991. */
  56992. SQLITE_PRIVATE int sqlite3BtreeGetReserveNoMutex(Btree *p){
  56993. int n;
  56994. assert( sqlite3_mutex_held(p->pBt->mutex) );
  56995. n = p->pBt->pageSize - p->pBt->usableSize;
  56996. return n;
  56997. }
  56998. /*
  56999. ** Return the number of bytes of space at the end of every page that
  57000. ** are intentually left unused. This is the "reserved" space that is
  57001. ** sometimes used by extensions.
  57002. **
  57003. ** If SQLITE_HAS_MUTEX is defined then the number returned is the
  57004. ** greater of the current reserved space and the maximum requested
  57005. ** reserve space.
  57006. */
  57007. SQLITE_PRIVATE int sqlite3BtreeGetOptimalReserve(Btree *p){
  57008. int n;
  57009. sqlite3BtreeEnter(p);
  57010. n = sqlite3BtreeGetReserveNoMutex(p);
  57011. #ifdef SQLITE_HAS_CODEC
  57012. if( n<p->pBt->optimalReserve ) n = p->pBt->optimalReserve;
  57013. #endif
  57014. sqlite3BtreeLeave(p);
  57015. return n;
  57016. }
  57017. /*
  57018. ** Set the maximum page count for a database if mxPage is positive.
  57019. ** No changes are made if mxPage is 0 or negative.
  57020. ** Regardless of the value of mxPage, return the maximum page count.
  57021. */
  57022. SQLITE_PRIVATE int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
  57023. int n;
  57024. sqlite3BtreeEnter(p);
  57025. n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
  57026. sqlite3BtreeLeave(p);
  57027. return n;
  57028. }
  57029. /*
  57030. ** Set the BTS_SECURE_DELETE flag if newFlag is 0 or 1. If newFlag is -1,
  57031. ** then make no changes. Always return the value of the BTS_SECURE_DELETE
  57032. ** setting after the change.
  57033. */
  57034. SQLITE_PRIVATE int sqlite3BtreeSecureDelete(Btree *p, int newFlag){
  57035. int b;
  57036. if( p==0 ) return 0;
  57037. sqlite3BtreeEnter(p);
  57038. if( newFlag>=0 ){
  57039. p->pBt->btsFlags &= ~BTS_SECURE_DELETE;
  57040. if( newFlag ) p->pBt->btsFlags |= BTS_SECURE_DELETE;
  57041. }
  57042. b = (p->pBt->btsFlags & BTS_SECURE_DELETE)!=0;
  57043. sqlite3BtreeLeave(p);
  57044. return b;
  57045. }
  57046. /*
  57047. ** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
  57048. ** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
  57049. ** is disabled. The default value for the auto-vacuum property is
  57050. ** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
  57051. */
  57052. SQLITE_PRIVATE int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
  57053. #ifdef SQLITE_OMIT_AUTOVACUUM
  57054. return SQLITE_READONLY;
  57055. #else
  57056. BtShared *pBt = p->pBt;
  57057. int rc = SQLITE_OK;
  57058. u8 av = (u8)autoVacuum;
  57059. sqlite3BtreeEnter(p);
  57060. if( (pBt->btsFlags & BTS_PAGESIZE_FIXED)!=0 && (av ?1:0)!=pBt->autoVacuum ){
  57061. rc = SQLITE_READONLY;
  57062. }else{
  57063. pBt->autoVacuum = av ?1:0;
  57064. pBt->incrVacuum = av==2 ?1:0;
  57065. }
  57066. sqlite3BtreeLeave(p);
  57067. return rc;
  57068. #endif
  57069. }
  57070. /*
  57071. ** Return the value of the 'auto-vacuum' property. If auto-vacuum is
  57072. ** enabled 1 is returned. Otherwise 0.
  57073. */
  57074. SQLITE_PRIVATE int sqlite3BtreeGetAutoVacuum(Btree *p){
  57075. #ifdef SQLITE_OMIT_AUTOVACUUM
  57076. return BTREE_AUTOVACUUM_NONE;
  57077. #else
  57078. int rc;
  57079. sqlite3BtreeEnter(p);
  57080. rc = (
  57081. (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
  57082. (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
  57083. BTREE_AUTOVACUUM_INCR
  57084. );
  57085. sqlite3BtreeLeave(p);
  57086. return rc;
  57087. #endif
  57088. }
  57089. /*
  57090. ** Get a reference to pPage1 of the database file. This will
  57091. ** also acquire a readlock on that file.
  57092. **
  57093. ** SQLITE_OK is returned on success. If the file is not a
  57094. ** well-formed database file, then SQLITE_CORRUPT is returned.
  57095. ** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
  57096. ** is returned if we run out of memory.
  57097. */
  57098. static int lockBtree(BtShared *pBt){
  57099. int rc; /* Result code from subfunctions */
  57100. MemPage *pPage1; /* Page 1 of the database file */
  57101. int nPage; /* Number of pages in the database */
  57102. int nPageFile = 0; /* Number of pages in the database file */
  57103. int nPageHeader; /* Number of pages in the database according to hdr */
  57104. assert( sqlite3_mutex_held(pBt->mutex) );
  57105. assert( pBt->pPage1==0 );
  57106. rc = sqlite3PagerSharedLock(pBt->pPager);
  57107. if( rc!=SQLITE_OK ) return rc;
  57108. rc = btreeGetPage(pBt, 1, &pPage1, 0);
  57109. if( rc!=SQLITE_OK ) return rc;
  57110. /* Do some checking to help insure the file we opened really is
  57111. ** a valid database file.
  57112. */
  57113. nPage = nPageHeader = get4byte(28+(u8*)pPage1->aData);
  57114. sqlite3PagerPagecount(pBt->pPager, &nPageFile);
  57115. if( nPage==0 || memcmp(24+(u8*)pPage1->aData, 92+(u8*)pPage1->aData,4)!=0 ){
  57116. nPage = nPageFile;
  57117. }
  57118. if( nPage>0 ){
  57119. u32 pageSize;
  57120. u32 usableSize;
  57121. u8 *page1 = pPage1->aData;
  57122. rc = SQLITE_NOTADB;
  57123. /* EVIDENCE-OF: R-43737-39999 Every valid SQLite database file begins
  57124. ** with the following 16 bytes (in hex): 53 51 4c 69 74 65 20 66 6f 72 6d
  57125. ** 61 74 20 33 00. */
  57126. if( memcmp(page1, zMagicHeader, 16)!=0 ){
  57127. goto page1_init_failed;
  57128. }
  57129. #ifdef SQLITE_OMIT_WAL
  57130. if( page1[18]>1 ){
  57131. pBt->btsFlags |= BTS_READ_ONLY;
  57132. }
  57133. if( page1[19]>1 ){
  57134. goto page1_init_failed;
  57135. }
  57136. #else
  57137. if( page1[18]>2 ){
  57138. pBt->btsFlags |= BTS_READ_ONLY;
  57139. }
  57140. if( page1[19]>2 ){
  57141. goto page1_init_failed;
  57142. }
  57143. /* If the write version is set to 2, this database should be accessed
  57144. ** in WAL mode. If the log is not already open, open it now. Then
  57145. ** return SQLITE_OK and return without populating BtShared.pPage1.
  57146. ** The caller detects this and calls this function again. This is
  57147. ** required as the version of page 1 currently in the page1 buffer
  57148. ** may not be the latest version - there may be a newer one in the log
  57149. ** file.
  57150. */
  57151. if( page1[19]==2 && (pBt->btsFlags & BTS_NO_WAL)==0 ){
  57152. int isOpen = 0;
  57153. rc = sqlite3PagerOpenWal(pBt->pPager, &isOpen);
  57154. if( rc!=SQLITE_OK ){
  57155. goto page1_init_failed;
  57156. }else{
  57157. #if SQLITE_DEFAULT_SYNCHRONOUS!=SQLITE_DEFAULT_WAL_SYNCHRONOUS
  57158. sqlite3 *db;
  57159. Db *pDb;
  57160. if( (db=pBt->db)!=0 && (pDb=db->aDb)!=0 ){
  57161. while( pDb->pBt==0 || pDb->pBt->pBt!=pBt ){ pDb++; }
  57162. if( pDb->bSyncSet==0
  57163. && pDb->safety_level==SQLITE_DEFAULT_SYNCHRONOUS+1
  57164. ){
  57165. pDb->safety_level = SQLITE_DEFAULT_WAL_SYNCHRONOUS+1;
  57166. sqlite3PagerSetFlags(pBt->pPager,
  57167. pDb->safety_level | (db->flags & PAGER_FLAGS_MASK));
  57168. }
  57169. }
  57170. #endif
  57171. if( isOpen==0 ){
  57172. releasePage(pPage1);
  57173. return SQLITE_OK;
  57174. }
  57175. }
  57176. rc = SQLITE_NOTADB;
  57177. }
  57178. #endif
  57179. /* EVIDENCE-OF: R-15465-20813 The maximum and minimum embedded payload
  57180. ** fractions and the leaf payload fraction values must be 64, 32, and 32.
  57181. **
  57182. ** The original design allowed these amounts to vary, but as of
  57183. ** version 3.6.0, we require them to be fixed.
  57184. */
  57185. if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
  57186. goto page1_init_failed;
  57187. }
  57188. /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
  57189. ** determined by the 2-byte integer located at an offset of 16 bytes from
  57190. ** the beginning of the database file. */
  57191. pageSize = (page1[16]<<8) | (page1[17]<<16);
  57192. /* EVIDENCE-OF: R-25008-21688 The size of a page is a power of two
  57193. ** between 512 and 65536 inclusive. */
  57194. if( ((pageSize-1)&pageSize)!=0
  57195. || pageSize>SQLITE_MAX_PAGE_SIZE
  57196. || pageSize<=256
  57197. ){
  57198. goto page1_init_failed;
  57199. }
  57200. assert( (pageSize & 7)==0 );
  57201. /* EVIDENCE-OF: R-59310-51205 The "reserved space" size in the 1-byte
  57202. ** integer at offset 20 is the number of bytes of space at the end of
  57203. ** each page to reserve for extensions.
  57204. **
  57205. ** EVIDENCE-OF: R-37497-42412 The size of the reserved region is
  57206. ** determined by the one-byte unsigned integer found at an offset of 20
  57207. ** into the database file header. */
  57208. usableSize = pageSize - page1[20];
  57209. if( (u32)pageSize!=pBt->pageSize ){
  57210. /* After reading the first page of the database assuming a page size
  57211. ** of BtShared.pageSize, we have discovered that the page-size is
  57212. ** actually pageSize. Unlock the database, leave pBt->pPage1 at
  57213. ** zero and return SQLITE_OK. The caller will call this function
  57214. ** again with the correct page-size.
  57215. */
  57216. releasePage(pPage1);
  57217. pBt->usableSize = usableSize;
  57218. pBt->pageSize = pageSize;
  57219. freeTempSpace(pBt);
  57220. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
  57221. pageSize-usableSize);
  57222. return rc;
  57223. }
  57224. if( (pBt->db->flags & SQLITE_RecoveryMode)==0 && nPage>nPageFile ){
  57225. rc = SQLITE_CORRUPT_BKPT;
  57226. goto page1_init_failed;
  57227. }
  57228. /* EVIDENCE-OF: R-28312-64704 However, the usable size is not allowed to
  57229. ** be less than 480. In other words, if the page size is 512, then the
  57230. ** reserved space size cannot exceed 32. */
  57231. if( usableSize<480 ){
  57232. goto page1_init_failed;
  57233. }
  57234. pBt->pageSize = pageSize;
  57235. pBt->usableSize = usableSize;
  57236. #ifndef SQLITE_OMIT_AUTOVACUUM
  57237. pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
  57238. pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
  57239. #endif
  57240. }
  57241. /* maxLocal is the maximum amount of payload to store locally for
  57242. ** a cell. Make sure it is small enough so that at least minFanout
  57243. ** cells can will fit on one page. We assume a 10-byte page header.
  57244. ** Besides the payload, the cell must store:
  57245. ** 2-byte pointer to the cell
  57246. ** 4-byte child pointer
  57247. ** 9-byte nKey value
  57248. ** 4-byte nData value
  57249. ** 4-byte overflow page pointer
  57250. ** So a cell consists of a 2-byte pointer, a header which is as much as
  57251. ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
  57252. ** page pointer.
  57253. */
  57254. pBt->maxLocal = (u16)((pBt->usableSize-12)*64/255 - 23);
  57255. pBt->minLocal = (u16)((pBt->usableSize-12)*32/255 - 23);
  57256. pBt->maxLeaf = (u16)(pBt->usableSize - 35);
  57257. pBt->minLeaf = (u16)((pBt->usableSize-12)*32/255 - 23);
  57258. if( pBt->maxLocal>127 ){
  57259. pBt->max1bytePayload = 127;
  57260. }else{
  57261. pBt->max1bytePayload = (u8)pBt->maxLocal;
  57262. }
  57263. assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
  57264. pBt->pPage1 = pPage1;
  57265. pBt->nPage = nPage;
  57266. return SQLITE_OK;
  57267. page1_init_failed:
  57268. releasePage(pPage1);
  57269. pBt->pPage1 = 0;
  57270. return rc;
  57271. }
  57272. #ifndef NDEBUG
  57273. /*
  57274. ** Return the number of cursors open on pBt. This is for use
  57275. ** in assert() expressions, so it is only compiled if NDEBUG is not
  57276. ** defined.
  57277. **
  57278. ** Only write cursors are counted if wrOnly is true. If wrOnly is
  57279. ** false then all cursors are counted.
  57280. **
  57281. ** For the purposes of this routine, a cursor is any cursor that
  57282. ** is capable of reading or writing to the database. Cursors that
  57283. ** have been tripped into the CURSOR_FAULT state are not counted.
  57284. */
  57285. static int countValidCursors(BtShared *pBt, int wrOnly){
  57286. BtCursor *pCur;
  57287. int r = 0;
  57288. for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
  57289. if( (wrOnly==0 || (pCur->curFlags & BTCF_WriteFlag)!=0)
  57290. && pCur->eState!=CURSOR_FAULT ) r++;
  57291. }
  57292. return r;
  57293. }
  57294. #endif
  57295. /*
  57296. ** If there are no outstanding cursors and we are not in the middle
  57297. ** of a transaction but there is a read lock on the database, then
  57298. ** this routine unrefs the first page of the database file which
  57299. ** has the effect of releasing the read lock.
  57300. **
  57301. ** If there is a transaction in progress, this routine is a no-op.
  57302. */
  57303. static void unlockBtreeIfUnused(BtShared *pBt){
  57304. assert( sqlite3_mutex_held(pBt->mutex) );
  57305. assert( countValidCursors(pBt,0)==0 || pBt->inTransaction>TRANS_NONE );
  57306. if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
  57307. MemPage *pPage1 = pBt->pPage1;
  57308. assert( pPage1->aData );
  57309. assert( sqlite3PagerRefcount(pBt->pPager)==1 );
  57310. pBt->pPage1 = 0;
  57311. releasePageNotNull(pPage1);
  57312. }
  57313. }
  57314. /*
  57315. ** If pBt points to an empty file then convert that empty file
  57316. ** into a new empty database by initializing the first page of
  57317. ** the database.
  57318. */
  57319. static int newDatabase(BtShared *pBt){
  57320. MemPage *pP1;
  57321. unsigned char *data;
  57322. int rc;
  57323. assert( sqlite3_mutex_held(pBt->mutex) );
  57324. if( pBt->nPage>0 ){
  57325. return SQLITE_OK;
  57326. }
  57327. pP1 = pBt->pPage1;
  57328. assert( pP1!=0 );
  57329. data = pP1->aData;
  57330. rc = sqlite3PagerWrite(pP1->pDbPage);
  57331. if( rc ) return rc;
  57332. memcpy(data, zMagicHeader, sizeof(zMagicHeader));
  57333. assert( sizeof(zMagicHeader)==16 );
  57334. data[16] = (u8)((pBt->pageSize>>8)&0xff);
  57335. data[17] = (u8)((pBt->pageSize>>16)&0xff);
  57336. data[18] = 1;
  57337. data[19] = 1;
  57338. assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
  57339. data[20] = (u8)(pBt->pageSize - pBt->usableSize);
  57340. data[21] = 64;
  57341. data[22] = 32;
  57342. data[23] = 32;
  57343. memset(&data[24], 0, 100-24);
  57344. zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
  57345. pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  57346. #ifndef SQLITE_OMIT_AUTOVACUUM
  57347. assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
  57348. assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
  57349. put4byte(&data[36 + 4*4], pBt->autoVacuum);
  57350. put4byte(&data[36 + 7*4], pBt->incrVacuum);
  57351. #endif
  57352. pBt->nPage = 1;
  57353. data[31] = 1;
  57354. return SQLITE_OK;
  57355. }
  57356. /*
  57357. ** Initialize the first page of the database file (creating a database
  57358. ** consisting of a single page and no schema objects). Return SQLITE_OK
  57359. ** if successful, or an SQLite error code otherwise.
  57360. */
  57361. SQLITE_PRIVATE int sqlite3BtreeNewDb(Btree *p){
  57362. int rc;
  57363. sqlite3BtreeEnter(p);
  57364. p->pBt->nPage = 0;
  57365. rc = newDatabase(p->pBt);
  57366. sqlite3BtreeLeave(p);
  57367. return rc;
  57368. }
  57369. /*
  57370. ** Attempt to start a new transaction. A write-transaction
  57371. ** is started if the second argument is nonzero, otherwise a read-
  57372. ** transaction. If the second argument is 2 or more and exclusive
  57373. ** transaction is started, meaning that no other process is allowed
  57374. ** to access the database. A preexisting transaction may not be
  57375. ** upgraded to exclusive by calling this routine a second time - the
  57376. ** exclusivity flag only works for a new transaction.
  57377. **
  57378. ** A write-transaction must be started before attempting any
  57379. ** changes to the database. None of the following routines
  57380. ** will work unless a transaction is started first:
  57381. **
  57382. ** sqlite3BtreeCreateTable()
  57383. ** sqlite3BtreeCreateIndex()
  57384. ** sqlite3BtreeClearTable()
  57385. ** sqlite3BtreeDropTable()
  57386. ** sqlite3BtreeInsert()
  57387. ** sqlite3BtreeDelete()
  57388. ** sqlite3BtreeUpdateMeta()
  57389. **
  57390. ** If an initial attempt to acquire the lock fails because of lock contention
  57391. ** and the database was previously unlocked, then invoke the busy handler
  57392. ** if there is one. But if there was previously a read-lock, do not
  57393. ** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
  57394. ** returned when there is already a read-lock in order to avoid a deadlock.
  57395. **
  57396. ** Suppose there are two processes A and B. A has a read lock and B has
  57397. ** a reserved lock. B tries to promote to exclusive but is blocked because
  57398. ** of A's read lock. A tries to promote to reserved but is blocked by B.
  57399. ** One or the other of the two processes must give way or there can be
  57400. ** no progress. By returning SQLITE_BUSY and not invoking the busy callback
  57401. ** when A already has a read lock, we encourage A to give up and let B
  57402. ** proceed.
  57403. */
  57404. SQLITE_PRIVATE int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
  57405. BtShared *pBt = p->pBt;
  57406. int rc = SQLITE_OK;
  57407. sqlite3BtreeEnter(p);
  57408. btreeIntegrity(p);
  57409. /* If the btree is already in a write-transaction, or it
  57410. ** is already in a read-transaction and a read-transaction
  57411. ** is requested, this is a no-op.
  57412. */
  57413. if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
  57414. goto trans_begun;
  57415. }
  57416. assert( pBt->inTransaction==TRANS_WRITE || IfNotOmitAV(pBt->bDoTruncate)==0 );
  57417. /* Write transactions are not possible on a read-only database */
  57418. if( (pBt->btsFlags & BTS_READ_ONLY)!=0 && wrflag ){
  57419. rc = SQLITE_READONLY;
  57420. goto trans_begun;
  57421. }
  57422. #ifndef SQLITE_OMIT_SHARED_CACHE
  57423. {
  57424. sqlite3 *pBlock = 0;
  57425. /* If another database handle has already opened a write transaction
  57426. ** on this shared-btree structure and a second write transaction is
  57427. ** requested, return SQLITE_LOCKED.
  57428. */
  57429. if( (wrflag && pBt->inTransaction==TRANS_WRITE)
  57430. || (pBt->btsFlags & BTS_PENDING)!=0
  57431. ){
  57432. pBlock = pBt->pWriter->db;
  57433. }else if( wrflag>1 ){
  57434. BtLock *pIter;
  57435. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  57436. if( pIter->pBtree!=p ){
  57437. pBlock = pIter->pBtree->db;
  57438. break;
  57439. }
  57440. }
  57441. }
  57442. if( pBlock ){
  57443. sqlite3ConnectionBlocked(p->db, pBlock);
  57444. rc = SQLITE_LOCKED_SHAREDCACHE;
  57445. goto trans_begun;
  57446. }
  57447. }
  57448. #endif
  57449. /* Any read-only or read-write transaction implies a read-lock on
  57450. ** page 1. So if some other shared-cache client already has a write-lock
  57451. ** on page 1, the transaction cannot be opened. */
  57452. rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
  57453. if( SQLITE_OK!=rc ) goto trans_begun;
  57454. pBt->btsFlags &= ~BTS_INITIALLY_EMPTY;
  57455. if( pBt->nPage==0 ) pBt->btsFlags |= BTS_INITIALLY_EMPTY;
  57456. do {
  57457. /* Call lockBtree() until either pBt->pPage1 is populated or
  57458. ** lockBtree() returns something other than SQLITE_OK. lockBtree()
  57459. ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
  57460. ** reading page 1 it discovers that the page-size of the database
  57461. ** file is not pBt->pageSize. In this case lockBtree() will update
  57462. ** pBt->pageSize to the page-size of the file on disk.
  57463. */
  57464. while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
  57465. if( rc==SQLITE_OK && wrflag ){
  57466. if( (pBt->btsFlags & BTS_READ_ONLY)!=0 ){
  57467. rc = SQLITE_READONLY;
  57468. }else{
  57469. rc = sqlite3PagerBegin(pBt->pPager,wrflag>1,sqlite3TempInMemory(p->db));
  57470. if( rc==SQLITE_OK ){
  57471. rc = newDatabase(pBt);
  57472. }
  57473. }
  57474. }
  57475. if( rc!=SQLITE_OK ){
  57476. unlockBtreeIfUnused(pBt);
  57477. }
  57478. }while( (rc&0xFF)==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
  57479. btreeInvokeBusyHandler(pBt) );
  57480. if( rc==SQLITE_OK ){
  57481. if( p->inTrans==TRANS_NONE ){
  57482. pBt->nTransaction++;
  57483. #ifndef SQLITE_OMIT_SHARED_CACHE
  57484. if( p->sharable ){
  57485. assert( p->lock.pBtree==p && p->lock.iTable==1 );
  57486. p->lock.eLock = READ_LOCK;
  57487. p->lock.pNext = pBt->pLock;
  57488. pBt->pLock = &p->lock;
  57489. }
  57490. #endif
  57491. }
  57492. p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
  57493. if( p->inTrans>pBt->inTransaction ){
  57494. pBt->inTransaction = p->inTrans;
  57495. }
  57496. if( wrflag ){
  57497. MemPage *pPage1 = pBt->pPage1;
  57498. #ifndef SQLITE_OMIT_SHARED_CACHE
  57499. assert( !pBt->pWriter );
  57500. pBt->pWriter = p;
  57501. pBt->btsFlags &= ~BTS_EXCLUSIVE;
  57502. if( wrflag>1 ) pBt->btsFlags |= BTS_EXCLUSIVE;
  57503. #endif
  57504. /* If the db-size header field is incorrect (as it may be if an old
  57505. ** client has been writing the database file), update it now. Doing
  57506. ** this sooner rather than later means the database size can safely
  57507. ** re-read the database size from page 1 if a savepoint or transaction
  57508. ** rollback occurs within the transaction.
  57509. */
  57510. if( pBt->nPage!=get4byte(&pPage1->aData[28]) ){
  57511. rc = sqlite3PagerWrite(pPage1->pDbPage);
  57512. if( rc==SQLITE_OK ){
  57513. put4byte(&pPage1->aData[28], pBt->nPage);
  57514. }
  57515. }
  57516. }
  57517. }
  57518. trans_begun:
  57519. if( rc==SQLITE_OK && wrflag ){
  57520. /* This call makes sure that the pager has the correct number of
  57521. ** open savepoints. If the second parameter is greater than 0 and
  57522. ** the sub-journal is not already open, then it will be opened here.
  57523. */
  57524. rc = sqlite3PagerOpenSavepoint(pBt->pPager, p->db->nSavepoint);
  57525. }
  57526. btreeIntegrity(p);
  57527. sqlite3BtreeLeave(p);
  57528. return rc;
  57529. }
  57530. #ifndef SQLITE_OMIT_AUTOVACUUM
  57531. /*
  57532. ** Set the pointer-map entries for all children of page pPage. Also, if
  57533. ** pPage contains cells that point to overflow pages, set the pointer
  57534. ** map entries for the overflow pages as well.
  57535. */
  57536. static int setChildPtrmaps(MemPage *pPage){
  57537. int i; /* Counter variable */
  57538. int nCell; /* Number of cells in page pPage */
  57539. int rc; /* Return code */
  57540. BtShared *pBt = pPage->pBt;
  57541. u8 isInitOrig = pPage->isInit;
  57542. Pgno pgno = pPage->pgno;
  57543. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  57544. rc = btreeInitPage(pPage);
  57545. if( rc!=SQLITE_OK ){
  57546. goto set_child_ptrmaps_out;
  57547. }
  57548. nCell = pPage->nCell;
  57549. for(i=0; i<nCell; i++){
  57550. u8 *pCell = findCell(pPage, i);
  57551. ptrmapPutOvflPtr(pPage, pCell, &rc);
  57552. if( !pPage->leaf ){
  57553. Pgno childPgno = get4byte(pCell);
  57554. ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
  57555. }
  57556. }
  57557. if( !pPage->leaf ){
  57558. Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  57559. ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
  57560. }
  57561. set_child_ptrmaps_out:
  57562. pPage->isInit = isInitOrig;
  57563. return rc;
  57564. }
  57565. /*
  57566. ** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
  57567. ** that it points to iTo. Parameter eType describes the type of pointer to
  57568. ** be modified, as follows:
  57569. **
  57570. ** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
  57571. ** page of pPage.
  57572. **
  57573. ** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
  57574. ** page pointed to by one of the cells on pPage.
  57575. **
  57576. ** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
  57577. ** overflow page in the list.
  57578. */
  57579. static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
  57580. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  57581. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  57582. if( eType==PTRMAP_OVERFLOW2 ){
  57583. /* The pointer is always the first 4 bytes of the page in this case. */
  57584. if( get4byte(pPage->aData)!=iFrom ){
  57585. return SQLITE_CORRUPT_BKPT;
  57586. }
  57587. put4byte(pPage->aData, iTo);
  57588. }else{
  57589. u8 isInitOrig = pPage->isInit;
  57590. int i;
  57591. int nCell;
  57592. int rc;
  57593. rc = btreeInitPage(pPage);
  57594. if( rc ) return rc;
  57595. nCell = pPage->nCell;
  57596. for(i=0; i<nCell; i++){
  57597. u8 *pCell = findCell(pPage, i);
  57598. if( eType==PTRMAP_OVERFLOW1 ){
  57599. CellInfo info;
  57600. pPage->xParseCell(pPage, pCell, &info);
  57601. if( info.nLocal<info.nPayload
  57602. && pCell+info.nSize-1<=pPage->aData+pPage->maskPage
  57603. && iFrom==get4byte(pCell+info.nSize-4)
  57604. ){
  57605. put4byte(pCell+info.nSize-4, iTo);
  57606. break;
  57607. }
  57608. }else{
  57609. if( get4byte(pCell)==iFrom ){
  57610. put4byte(pCell, iTo);
  57611. break;
  57612. }
  57613. }
  57614. }
  57615. if( i==nCell ){
  57616. if( eType!=PTRMAP_BTREE ||
  57617. get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
  57618. return SQLITE_CORRUPT_BKPT;
  57619. }
  57620. put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
  57621. }
  57622. pPage->isInit = isInitOrig;
  57623. }
  57624. return SQLITE_OK;
  57625. }
  57626. /*
  57627. ** Move the open database page pDbPage to location iFreePage in the
  57628. ** database. The pDbPage reference remains valid.
  57629. **
  57630. ** The isCommit flag indicates that there is no need to remember that
  57631. ** the journal needs to be sync()ed before database page pDbPage->pgno
  57632. ** can be written to. The caller has already promised not to write to that
  57633. ** page.
  57634. */
  57635. static int relocatePage(
  57636. BtShared *pBt, /* Btree */
  57637. MemPage *pDbPage, /* Open page to move */
  57638. u8 eType, /* Pointer map 'type' entry for pDbPage */
  57639. Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
  57640. Pgno iFreePage, /* The location to move pDbPage to */
  57641. int isCommit /* isCommit flag passed to sqlite3PagerMovepage */
  57642. ){
  57643. MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
  57644. Pgno iDbPage = pDbPage->pgno;
  57645. Pager *pPager = pBt->pPager;
  57646. int rc;
  57647. assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
  57648. eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
  57649. assert( sqlite3_mutex_held(pBt->mutex) );
  57650. assert( pDbPage->pBt==pBt );
  57651. /* Move page iDbPage from its current location to page number iFreePage */
  57652. TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
  57653. iDbPage, iFreePage, iPtrPage, eType));
  57654. rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
  57655. if( rc!=SQLITE_OK ){
  57656. return rc;
  57657. }
  57658. pDbPage->pgno = iFreePage;
  57659. /* If pDbPage was a btree-page, then it may have child pages and/or cells
  57660. ** that point to overflow pages. The pointer map entries for all these
  57661. ** pages need to be changed.
  57662. **
  57663. ** If pDbPage is an overflow page, then the first 4 bytes may store a
  57664. ** pointer to a subsequent overflow page. If this is the case, then
  57665. ** the pointer map needs to be updated for the subsequent overflow page.
  57666. */
  57667. if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
  57668. rc = setChildPtrmaps(pDbPage);
  57669. if( rc!=SQLITE_OK ){
  57670. return rc;
  57671. }
  57672. }else{
  57673. Pgno nextOvfl = get4byte(pDbPage->aData);
  57674. if( nextOvfl!=0 ){
  57675. ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage, &rc);
  57676. if( rc!=SQLITE_OK ){
  57677. return rc;
  57678. }
  57679. }
  57680. }
  57681. /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
  57682. ** that it points at iFreePage. Also fix the pointer map entry for
  57683. ** iPtrPage.
  57684. */
  57685. if( eType!=PTRMAP_ROOTPAGE ){
  57686. rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
  57687. if( rc!=SQLITE_OK ){
  57688. return rc;
  57689. }
  57690. rc = sqlite3PagerWrite(pPtrPage->pDbPage);
  57691. if( rc!=SQLITE_OK ){
  57692. releasePage(pPtrPage);
  57693. return rc;
  57694. }
  57695. rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
  57696. releasePage(pPtrPage);
  57697. if( rc==SQLITE_OK ){
  57698. ptrmapPut(pBt, iFreePage, eType, iPtrPage, &rc);
  57699. }
  57700. }
  57701. return rc;
  57702. }
  57703. /* Forward declaration required by incrVacuumStep(). */
  57704. static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
  57705. /*
  57706. ** Perform a single step of an incremental-vacuum. If successful, return
  57707. ** SQLITE_OK. If there is no work to do (and therefore no point in
  57708. ** calling this function again), return SQLITE_DONE. Or, if an error
  57709. ** occurs, return some other error code.
  57710. **
  57711. ** More specifically, this function attempts to re-organize the database so
  57712. ** that the last page of the file currently in use is no longer in use.
  57713. **
  57714. ** Parameter nFin is the number of pages that this database would contain
  57715. ** were this function called until it returns SQLITE_DONE.
  57716. **
  57717. ** If the bCommit parameter is non-zero, this function assumes that the
  57718. ** caller will keep calling incrVacuumStep() until it returns SQLITE_DONE
  57719. ** or an error. bCommit is passed true for an auto-vacuum-on-commit
  57720. ** operation, or false for an incremental vacuum.
  57721. */
  57722. static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg, int bCommit){
  57723. Pgno nFreeList; /* Number of pages still on the free-list */
  57724. int rc;
  57725. assert( sqlite3_mutex_held(pBt->mutex) );
  57726. assert( iLastPg>nFin );
  57727. if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
  57728. u8 eType;
  57729. Pgno iPtrPage;
  57730. nFreeList = get4byte(&pBt->pPage1->aData[36]);
  57731. if( nFreeList==0 ){
  57732. return SQLITE_DONE;
  57733. }
  57734. rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
  57735. if( rc!=SQLITE_OK ){
  57736. return rc;
  57737. }
  57738. if( eType==PTRMAP_ROOTPAGE ){
  57739. return SQLITE_CORRUPT_BKPT;
  57740. }
  57741. if( eType==PTRMAP_FREEPAGE ){
  57742. if( bCommit==0 ){
  57743. /* Remove the page from the files free-list. This is not required
  57744. ** if bCommit is non-zero. In that case, the free-list will be
  57745. ** truncated to zero after this function returns, so it doesn't
  57746. ** matter if it still contains some garbage entries.
  57747. */
  57748. Pgno iFreePg;
  57749. MemPage *pFreePg;
  57750. rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, BTALLOC_EXACT);
  57751. if( rc!=SQLITE_OK ){
  57752. return rc;
  57753. }
  57754. assert( iFreePg==iLastPg );
  57755. releasePage(pFreePg);
  57756. }
  57757. } else {
  57758. Pgno iFreePg; /* Index of free page to move pLastPg to */
  57759. MemPage *pLastPg;
  57760. u8 eMode = BTALLOC_ANY; /* Mode parameter for allocateBtreePage() */
  57761. Pgno iNear = 0; /* nearby parameter for allocateBtreePage() */
  57762. rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
  57763. if( rc!=SQLITE_OK ){
  57764. return rc;
  57765. }
  57766. /* If bCommit is zero, this loop runs exactly once and page pLastPg
  57767. ** is swapped with the first free page pulled off the free list.
  57768. **
  57769. ** On the other hand, if bCommit is greater than zero, then keep
  57770. ** looping until a free-page located within the first nFin pages
  57771. ** of the file is found.
  57772. */
  57773. if( bCommit==0 ){
  57774. eMode = BTALLOC_LE;
  57775. iNear = nFin;
  57776. }
  57777. do {
  57778. MemPage *pFreePg;
  57779. rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iNear, eMode);
  57780. if( rc!=SQLITE_OK ){
  57781. releasePage(pLastPg);
  57782. return rc;
  57783. }
  57784. releasePage(pFreePg);
  57785. }while( bCommit && iFreePg>nFin );
  57786. assert( iFreePg<iLastPg );
  57787. rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, bCommit);
  57788. releasePage(pLastPg);
  57789. if( rc!=SQLITE_OK ){
  57790. return rc;
  57791. }
  57792. }
  57793. }
  57794. if( bCommit==0 ){
  57795. do {
  57796. iLastPg--;
  57797. }while( iLastPg==PENDING_BYTE_PAGE(pBt) || PTRMAP_ISPAGE(pBt, iLastPg) );
  57798. pBt->bDoTruncate = 1;
  57799. pBt->nPage = iLastPg;
  57800. }
  57801. return SQLITE_OK;
  57802. }
  57803. /*
  57804. ** The database opened by the first argument is an auto-vacuum database
  57805. ** nOrig pages in size containing nFree free pages. Return the expected
  57806. ** size of the database in pages following an auto-vacuum operation.
  57807. */
  57808. static Pgno finalDbSize(BtShared *pBt, Pgno nOrig, Pgno nFree){
  57809. int nEntry; /* Number of entries on one ptrmap page */
  57810. Pgno nPtrmap; /* Number of PtrMap pages to be freed */
  57811. Pgno nFin; /* Return value */
  57812. nEntry = pBt->usableSize/5;
  57813. nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+nEntry)/nEntry;
  57814. nFin = nOrig - nFree - nPtrmap;
  57815. if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
  57816. nFin--;
  57817. }
  57818. while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
  57819. nFin--;
  57820. }
  57821. return nFin;
  57822. }
  57823. /*
  57824. ** A write-transaction must be opened before calling this function.
  57825. ** It performs a single unit of work towards an incremental vacuum.
  57826. **
  57827. ** If the incremental vacuum is finished after this function has run,
  57828. ** SQLITE_DONE is returned. If it is not finished, but no error occurred,
  57829. ** SQLITE_OK is returned. Otherwise an SQLite error code.
  57830. */
  57831. SQLITE_PRIVATE int sqlite3BtreeIncrVacuum(Btree *p){
  57832. int rc;
  57833. BtShared *pBt = p->pBt;
  57834. sqlite3BtreeEnter(p);
  57835. assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
  57836. if( !pBt->autoVacuum ){
  57837. rc = SQLITE_DONE;
  57838. }else{
  57839. Pgno nOrig = btreePagecount(pBt);
  57840. Pgno nFree = get4byte(&pBt->pPage1->aData[36]);
  57841. Pgno nFin = finalDbSize(pBt, nOrig, nFree);
  57842. if( nOrig<nFin ){
  57843. rc = SQLITE_CORRUPT_BKPT;
  57844. }else if( nFree>0 ){
  57845. rc = saveAllCursors(pBt, 0, 0);
  57846. if( rc==SQLITE_OK ){
  57847. invalidateAllOverflowCache(pBt);
  57848. rc = incrVacuumStep(pBt, nFin, nOrig, 0);
  57849. }
  57850. if( rc==SQLITE_OK ){
  57851. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  57852. put4byte(&pBt->pPage1->aData[28], pBt->nPage);
  57853. }
  57854. }else{
  57855. rc = SQLITE_DONE;
  57856. }
  57857. }
  57858. sqlite3BtreeLeave(p);
  57859. return rc;
  57860. }
  57861. /*
  57862. ** This routine is called prior to sqlite3PagerCommit when a transaction
  57863. ** is committed for an auto-vacuum database.
  57864. **
  57865. ** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
  57866. ** the database file should be truncated to during the commit process.
  57867. ** i.e. the database has been reorganized so that only the first *pnTrunc
  57868. ** pages are in use.
  57869. */
  57870. static int autoVacuumCommit(BtShared *pBt){
  57871. int rc = SQLITE_OK;
  57872. Pager *pPager = pBt->pPager;
  57873. VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager); )
  57874. assert( sqlite3_mutex_held(pBt->mutex) );
  57875. invalidateAllOverflowCache(pBt);
  57876. assert(pBt->autoVacuum);
  57877. if( !pBt->incrVacuum ){
  57878. Pgno nFin; /* Number of pages in database after autovacuuming */
  57879. Pgno nFree; /* Number of pages on the freelist initially */
  57880. Pgno iFree; /* The next page to be freed */
  57881. Pgno nOrig; /* Database size before freeing */
  57882. nOrig = btreePagecount(pBt);
  57883. if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
  57884. /* It is not possible to create a database for which the final page
  57885. ** is either a pointer-map page or the pending-byte page. If one
  57886. ** is encountered, this indicates corruption.
  57887. */
  57888. return SQLITE_CORRUPT_BKPT;
  57889. }
  57890. nFree = get4byte(&pBt->pPage1->aData[36]);
  57891. nFin = finalDbSize(pBt, nOrig, nFree);
  57892. if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
  57893. if( nFin<nOrig ){
  57894. rc = saveAllCursors(pBt, 0, 0);
  57895. }
  57896. for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
  57897. rc = incrVacuumStep(pBt, nFin, iFree, 1);
  57898. }
  57899. if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
  57900. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  57901. put4byte(&pBt->pPage1->aData[32], 0);
  57902. put4byte(&pBt->pPage1->aData[36], 0);
  57903. put4byte(&pBt->pPage1->aData[28], nFin);
  57904. pBt->bDoTruncate = 1;
  57905. pBt->nPage = nFin;
  57906. }
  57907. if( rc!=SQLITE_OK ){
  57908. sqlite3PagerRollback(pPager);
  57909. }
  57910. }
  57911. assert( nRef>=sqlite3PagerRefcount(pPager) );
  57912. return rc;
  57913. }
  57914. #else /* ifndef SQLITE_OMIT_AUTOVACUUM */
  57915. # define setChildPtrmaps(x) SQLITE_OK
  57916. #endif
  57917. /*
  57918. ** This routine does the first phase of a two-phase commit. This routine
  57919. ** causes a rollback journal to be created (if it does not already exist)
  57920. ** and populated with enough information so that if a power loss occurs
  57921. ** the database can be restored to its original state by playing back
  57922. ** the journal. Then the contents of the journal are flushed out to
  57923. ** the disk. After the journal is safely on oxide, the changes to the
  57924. ** database are written into the database file and flushed to oxide.
  57925. ** At the end of this call, the rollback journal still exists on the
  57926. ** disk and we are still holding all locks, so the transaction has not
  57927. ** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
  57928. ** commit process.
  57929. **
  57930. ** This call is a no-op if no write-transaction is currently active on pBt.
  57931. **
  57932. ** Otherwise, sync the database file for the btree pBt. zMaster points to
  57933. ** the name of a master journal file that should be written into the
  57934. ** individual journal file, or is NULL, indicating no master journal file
  57935. ** (single database transaction).
  57936. **
  57937. ** When this is called, the master journal should already have been
  57938. ** created, populated with this journal pointer and synced to disk.
  57939. **
  57940. ** Once this is routine has returned, the only thing required to commit
  57941. ** the write-transaction for this database file is to delete the journal.
  57942. */
  57943. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
  57944. int rc = SQLITE_OK;
  57945. if( p->inTrans==TRANS_WRITE ){
  57946. BtShared *pBt = p->pBt;
  57947. sqlite3BtreeEnter(p);
  57948. #ifndef SQLITE_OMIT_AUTOVACUUM
  57949. if( pBt->autoVacuum ){
  57950. rc = autoVacuumCommit(pBt);
  57951. if( rc!=SQLITE_OK ){
  57952. sqlite3BtreeLeave(p);
  57953. return rc;
  57954. }
  57955. }
  57956. if( pBt->bDoTruncate ){
  57957. sqlite3PagerTruncateImage(pBt->pPager, pBt->nPage);
  57958. }
  57959. #endif
  57960. rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, 0);
  57961. sqlite3BtreeLeave(p);
  57962. }
  57963. return rc;
  57964. }
  57965. /*
  57966. ** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
  57967. ** at the conclusion of a transaction.
  57968. */
  57969. static void btreeEndTransaction(Btree *p){
  57970. BtShared *pBt = p->pBt;
  57971. sqlite3 *db = p->db;
  57972. assert( sqlite3BtreeHoldsMutex(p) );
  57973. #ifndef SQLITE_OMIT_AUTOVACUUM
  57974. pBt->bDoTruncate = 0;
  57975. #endif
  57976. if( p->inTrans>TRANS_NONE && db->nVdbeRead>1 ){
  57977. /* If there are other active statements that belong to this database
  57978. ** handle, downgrade to a read-only transaction. The other statements
  57979. ** may still be reading from the database. */
  57980. downgradeAllSharedCacheTableLocks(p);
  57981. p->inTrans = TRANS_READ;
  57982. }else{
  57983. /* If the handle had any kind of transaction open, decrement the
  57984. ** transaction count of the shared btree. If the transaction count
  57985. ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
  57986. ** call below will unlock the pager. */
  57987. if( p->inTrans!=TRANS_NONE ){
  57988. clearAllSharedCacheTableLocks(p);
  57989. pBt->nTransaction--;
  57990. if( 0==pBt->nTransaction ){
  57991. pBt->inTransaction = TRANS_NONE;
  57992. }
  57993. }
  57994. /* Set the current transaction state to TRANS_NONE and unlock the
  57995. ** pager if this call closed the only read or write transaction. */
  57996. p->inTrans = TRANS_NONE;
  57997. unlockBtreeIfUnused(pBt);
  57998. }
  57999. btreeIntegrity(p);
  58000. }
  58001. /*
  58002. ** Commit the transaction currently in progress.
  58003. **
  58004. ** This routine implements the second phase of a 2-phase commit. The
  58005. ** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
  58006. ** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
  58007. ** routine did all the work of writing information out to disk and flushing the
  58008. ** contents so that they are written onto the disk platter. All this
  58009. ** routine has to do is delete or truncate or zero the header in the
  58010. ** the rollback journal (which causes the transaction to commit) and
  58011. ** drop locks.
  58012. **
  58013. ** Normally, if an error occurs while the pager layer is attempting to
  58014. ** finalize the underlying journal file, this function returns an error and
  58015. ** the upper layer will attempt a rollback. However, if the second argument
  58016. ** is non-zero then this b-tree transaction is part of a multi-file
  58017. ** transaction. In this case, the transaction has already been committed
  58018. ** (by deleting a master journal file) and the caller will ignore this
  58019. ** functions return code. So, even if an error occurs in the pager layer,
  58020. ** reset the b-tree objects internal state to indicate that the write
  58021. ** transaction has been closed. This is quite safe, as the pager will have
  58022. ** transitioned to the error state.
  58023. **
  58024. ** This will release the write lock on the database file. If there
  58025. ** are no active cursors, it also releases the read lock.
  58026. */
  58027. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseTwo(Btree *p, int bCleanup){
  58028. if( p->inTrans==TRANS_NONE ) return SQLITE_OK;
  58029. sqlite3BtreeEnter(p);
  58030. btreeIntegrity(p);
  58031. /* If the handle has a write-transaction open, commit the shared-btrees
  58032. ** transaction and set the shared state to TRANS_READ.
  58033. */
  58034. if( p->inTrans==TRANS_WRITE ){
  58035. int rc;
  58036. BtShared *pBt = p->pBt;
  58037. assert( pBt->inTransaction==TRANS_WRITE );
  58038. assert( pBt->nTransaction>0 );
  58039. rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
  58040. if( rc!=SQLITE_OK && bCleanup==0 ){
  58041. sqlite3BtreeLeave(p);
  58042. return rc;
  58043. }
  58044. p->iDataVersion--; /* Compensate for pPager->iDataVersion++; */
  58045. pBt->inTransaction = TRANS_READ;
  58046. btreeClearHasContent(pBt);
  58047. }
  58048. btreeEndTransaction(p);
  58049. sqlite3BtreeLeave(p);
  58050. return SQLITE_OK;
  58051. }
  58052. /*
  58053. ** Do both phases of a commit.
  58054. */
  58055. SQLITE_PRIVATE int sqlite3BtreeCommit(Btree *p){
  58056. int rc;
  58057. sqlite3BtreeEnter(p);
  58058. rc = sqlite3BtreeCommitPhaseOne(p, 0);
  58059. if( rc==SQLITE_OK ){
  58060. rc = sqlite3BtreeCommitPhaseTwo(p, 0);
  58061. }
  58062. sqlite3BtreeLeave(p);
  58063. return rc;
  58064. }
  58065. /*
  58066. ** This routine sets the state to CURSOR_FAULT and the error
  58067. ** code to errCode for every cursor on any BtShared that pBtree
  58068. ** references. Or if the writeOnly flag is set to 1, then only
  58069. ** trip write cursors and leave read cursors unchanged.
  58070. **
  58071. ** Every cursor is a candidate to be tripped, including cursors
  58072. ** that belong to other database connections that happen to be
  58073. ** sharing the cache with pBtree.
  58074. **
  58075. ** This routine gets called when a rollback occurs. If the writeOnly
  58076. ** flag is true, then only write-cursors need be tripped - read-only
  58077. ** cursors save their current positions so that they may continue
  58078. ** following the rollback. Or, if writeOnly is false, all cursors are
  58079. ** tripped. In general, writeOnly is false if the transaction being
  58080. ** rolled back modified the database schema. In this case b-tree root
  58081. ** pages may be moved or deleted from the database altogether, making
  58082. ** it unsafe for read cursors to continue.
  58083. **
  58084. ** If the writeOnly flag is true and an error is encountered while
  58085. ** saving the current position of a read-only cursor, all cursors,
  58086. ** including all read-cursors are tripped.
  58087. **
  58088. ** SQLITE_OK is returned if successful, or if an error occurs while
  58089. ** saving a cursor position, an SQLite error code.
  58090. */
  58091. SQLITE_PRIVATE int sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode, int writeOnly){
  58092. BtCursor *p;
  58093. int rc = SQLITE_OK;
  58094. assert( (writeOnly==0 || writeOnly==1) && BTCF_WriteFlag==1 );
  58095. if( pBtree ){
  58096. sqlite3BtreeEnter(pBtree);
  58097. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  58098. int i;
  58099. if( writeOnly && (p->curFlags & BTCF_WriteFlag)==0 ){
  58100. if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
  58101. rc = saveCursorPosition(p);
  58102. if( rc!=SQLITE_OK ){
  58103. (void)sqlite3BtreeTripAllCursors(pBtree, rc, 0);
  58104. break;
  58105. }
  58106. }
  58107. }else{
  58108. sqlite3BtreeClearCursor(p);
  58109. p->eState = CURSOR_FAULT;
  58110. p->skipNext = errCode;
  58111. }
  58112. for(i=0; i<=p->iPage; i++){
  58113. releasePage(p->apPage[i]);
  58114. p->apPage[i] = 0;
  58115. }
  58116. }
  58117. sqlite3BtreeLeave(pBtree);
  58118. }
  58119. return rc;
  58120. }
  58121. /*
  58122. ** Rollback the transaction in progress.
  58123. **
  58124. ** If tripCode is not SQLITE_OK then cursors will be invalidated (tripped).
  58125. ** Only write cursors are tripped if writeOnly is true but all cursors are
  58126. ** tripped if writeOnly is false. Any attempt to use
  58127. ** a tripped cursor will result in an error.
  58128. **
  58129. ** This will release the write lock on the database file. If there
  58130. ** are no active cursors, it also releases the read lock.
  58131. */
  58132. SQLITE_PRIVATE int sqlite3BtreeRollback(Btree *p, int tripCode, int writeOnly){
  58133. int rc;
  58134. BtShared *pBt = p->pBt;
  58135. MemPage *pPage1;
  58136. assert( writeOnly==1 || writeOnly==0 );
  58137. assert( tripCode==SQLITE_ABORT_ROLLBACK || tripCode==SQLITE_OK );
  58138. sqlite3BtreeEnter(p);
  58139. if( tripCode==SQLITE_OK ){
  58140. rc = tripCode = saveAllCursors(pBt, 0, 0);
  58141. if( rc ) writeOnly = 0;
  58142. }else{
  58143. rc = SQLITE_OK;
  58144. }
  58145. if( tripCode ){
  58146. int rc2 = sqlite3BtreeTripAllCursors(p, tripCode, writeOnly);
  58147. assert( rc==SQLITE_OK || (writeOnly==0 && rc2==SQLITE_OK) );
  58148. if( rc2!=SQLITE_OK ) rc = rc2;
  58149. }
  58150. btreeIntegrity(p);
  58151. if( p->inTrans==TRANS_WRITE ){
  58152. int rc2;
  58153. assert( TRANS_WRITE==pBt->inTransaction );
  58154. rc2 = sqlite3PagerRollback(pBt->pPager);
  58155. if( rc2!=SQLITE_OK ){
  58156. rc = rc2;
  58157. }
  58158. /* The rollback may have destroyed the pPage1->aData value. So
  58159. ** call btreeGetPage() on page 1 again to make
  58160. ** sure pPage1->aData is set correctly. */
  58161. if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
  58162. int nPage = get4byte(28+(u8*)pPage1->aData);
  58163. testcase( nPage==0 );
  58164. if( nPage==0 ) sqlite3PagerPagecount(pBt->pPager, &nPage);
  58165. testcase( pBt->nPage!=nPage );
  58166. pBt->nPage = nPage;
  58167. releasePage(pPage1);
  58168. }
  58169. assert( countValidCursors(pBt, 1)==0 );
  58170. pBt->inTransaction = TRANS_READ;
  58171. btreeClearHasContent(pBt);
  58172. }
  58173. btreeEndTransaction(p);
  58174. sqlite3BtreeLeave(p);
  58175. return rc;
  58176. }
  58177. /*
  58178. ** Start a statement subtransaction. The subtransaction can be rolled
  58179. ** back independently of the main transaction. You must start a transaction
  58180. ** before starting a subtransaction. The subtransaction is ended automatically
  58181. ** if the main transaction commits or rolls back.
  58182. **
  58183. ** Statement subtransactions are used around individual SQL statements
  58184. ** that are contained within a BEGIN...COMMIT block. If a constraint
  58185. ** error occurs within the statement, the effect of that one statement
  58186. ** can be rolled back without having to rollback the entire transaction.
  58187. **
  58188. ** A statement sub-transaction is implemented as an anonymous savepoint. The
  58189. ** value passed as the second parameter is the total number of savepoints,
  58190. ** including the new anonymous savepoint, open on the B-Tree. i.e. if there
  58191. ** are no active savepoints and no other statement-transactions open,
  58192. ** iStatement is 1. This anonymous savepoint can be released or rolled back
  58193. ** using the sqlite3BtreeSavepoint() function.
  58194. */
  58195. SQLITE_PRIVATE int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
  58196. int rc;
  58197. BtShared *pBt = p->pBt;
  58198. sqlite3BtreeEnter(p);
  58199. assert( p->inTrans==TRANS_WRITE );
  58200. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  58201. assert( iStatement>0 );
  58202. assert( iStatement>p->db->nSavepoint );
  58203. assert( pBt->inTransaction==TRANS_WRITE );
  58204. /* At the pager level, a statement transaction is a savepoint with
  58205. ** an index greater than all savepoints created explicitly using
  58206. ** SQL statements. It is illegal to open, release or rollback any
  58207. ** such savepoints while the statement transaction savepoint is active.
  58208. */
  58209. rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
  58210. sqlite3BtreeLeave(p);
  58211. return rc;
  58212. }
  58213. /*
  58214. ** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
  58215. ** or SAVEPOINT_RELEASE. This function either releases or rolls back the
  58216. ** savepoint identified by parameter iSavepoint, depending on the value
  58217. ** of op.
  58218. **
  58219. ** Normally, iSavepoint is greater than or equal to zero. However, if op is
  58220. ** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
  58221. ** contents of the entire transaction are rolled back. This is different
  58222. ** from a normal transaction rollback, as no locks are released and the
  58223. ** transaction remains open.
  58224. */
  58225. SQLITE_PRIVATE int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
  58226. int rc = SQLITE_OK;
  58227. if( p && p->inTrans==TRANS_WRITE ){
  58228. BtShared *pBt = p->pBt;
  58229. assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
  58230. assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
  58231. sqlite3BtreeEnter(p);
  58232. rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
  58233. if( rc==SQLITE_OK ){
  58234. if( iSavepoint<0 && (pBt->btsFlags & BTS_INITIALLY_EMPTY)!=0 ){
  58235. pBt->nPage = 0;
  58236. }
  58237. rc = newDatabase(pBt);
  58238. pBt->nPage = get4byte(28 + pBt->pPage1->aData);
  58239. /* The database size was written into the offset 28 of the header
  58240. ** when the transaction started, so we know that the value at offset
  58241. ** 28 is nonzero. */
  58242. assert( pBt->nPage>0 );
  58243. }
  58244. sqlite3BtreeLeave(p);
  58245. }
  58246. return rc;
  58247. }
  58248. /*
  58249. ** Create a new cursor for the BTree whose root is on the page
  58250. ** iTable. If a read-only cursor is requested, it is assumed that
  58251. ** the caller already has at least a read-only transaction open
  58252. ** on the database already. If a write-cursor is requested, then
  58253. ** the caller is assumed to have an open write transaction.
  58254. **
  58255. ** If the BTREE_WRCSR bit of wrFlag is clear, then the cursor can only
  58256. ** be used for reading. If the BTREE_WRCSR bit is set, then the cursor
  58257. ** can be used for reading or for writing if other conditions for writing
  58258. ** are also met. These are the conditions that must be met in order
  58259. ** for writing to be allowed:
  58260. **
  58261. ** 1: The cursor must have been opened with wrFlag containing BTREE_WRCSR
  58262. **
  58263. ** 2: Other database connections that share the same pager cache
  58264. ** but which are not in the READ_UNCOMMITTED state may not have
  58265. ** cursors open with wrFlag==0 on the same table. Otherwise
  58266. ** the changes made by this write cursor would be visible to
  58267. ** the read cursors in the other database connection.
  58268. **
  58269. ** 3: The database must be writable (not on read-only media)
  58270. **
  58271. ** 4: There must be an active transaction.
  58272. **
  58273. ** The BTREE_FORDELETE bit of wrFlag may optionally be set if BTREE_WRCSR
  58274. ** is set. If FORDELETE is set, that is a hint to the implementation that
  58275. ** this cursor will only be used to seek to and delete entries of an index
  58276. ** as part of a larger DELETE statement. The FORDELETE hint is not used by
  58277. ** this implementation. But in a hypothetical alternative storage engine
  58278. ** in which index entries are automatically deleted when corresponding table
  58279. ** rows are deleted, the FORDELETE flag is a hint that all SEEK and DELETE
  58280. ** operations on this cursor can be no-ops and all READ operations can
  58281. ** return a null row (2-bytes: 0x01 0x00).
  58282. **
  58283. ** No checking is done to make sure that page iTable really is the
  58284. ** root page of a b-tree. If it is not, then the cursor acquired
  58285. ** will not work correctly.
  58286. **
  58287. ** It is assumed that the sqlite3BtreeCursorZero() has been called
  58288. ** on pCur to initialize the memory space prior to invoking this routine.
  58289. */
  58290. static int btreeCursor(
  58291. Btree *p, /* The btree */
  58292. int iTable, /* Root page of table to open */
  58293. int wrFlag, /* 1 to write. 0 read-only */
  58294. struct KeyInfo *pKeyInfo, /* First arg to comparison function */
  58295. BtCursor *pCur /* Space for new cursor */
  58296. ){
  58297. BtShared *pBt = p->pBt; /* Shared b-tree handle */
  58298. BtCursor *pX; /* Looping over other all cursors */
  58299. assert( sqlite3BtreeHoldsMutex(p) );
  58300. assert( wrFlag==0
  58301. || wrFlag==BTREE_WRCSR
  58302. || wrFlag==(BTREE_WRCSR|BTREE_FORDELETE)
  58303. );
  58304. /* The following assert statements verify that if this is a sharable
  58305. ** b-tree database, the connection is holding the required table locks,
  58306. ** and that no other connection has any open cursor that conflicts with
  58307. ** this lock. */
  58308. assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, (wrFlag?2:1)) );
  58309. assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
  58310. /* Assert that the caller has opened the required transaction. */
  58311. assert( p->inTrans>TRANS_NONE );
  58312. assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
  58313. assert( pBt->pPage1 && pBt->pPage1->aData );
  58314. assert( wrFlag==0 || (pBt->btsFlags & BTS_READ_ONLY)==0 );
  58315. if( wrFlag ){
  58316. allocateTempSpace(pBt);
  58317. if( pBt->pTmpSpace==0 ) return SQLITE_NOMEM_BKPT;
  58318. }
  58319. if( iTable==1 && btreePagecount(pBt)==0 ){
  58320. assert( wrFlag==0 );
  58321. iTable = 0;
  58322. }
  58323. /* Now that no other errors can occur, finish filling in the BtCursor
  58324. ** variables and link the cursor into the BtShared list. */
  58325. pCur->pgnoRoot = (Pgno)iTable;
  58326. pCur->iPage = -1;
  58327. pCur->pKeyInfo = pKeyInfo;
  58328. pCur->pBtree = p;
  58329. pCur->pBt = pBt;
  58330. pCur->curFlags = wrFlag ? BTCF_WriteFlag : 0;
  58331. pCur->curPagerFlags = wrFlag ? 0 : PAGER_GET_READONLY;
  58332. /* If there are two or more cursors on the same btree, then all such
  58333. ** cursors *must* have the BTCF_Multiple flag set. */
  58334. for(pX=pBt->pCursor; pX; pX=pX->pNext){
  58335. if( pX->pgnoRoot==(Pgno)iTable ){
  58336. pX->curFlags |= BTCF_Multiple;
  58337. pCur->curFlags |= BTCF_Multiple;
  58338. }
  58339. }
  58340. pCur->pNext = pBt->pCursor;
  58341. pBt->pCursor = pCur;
  58342. pCur->eState = CURSOR_INVALID;
  58343. return SQLITE_OK;
  58344. }
  58345. SQLITE_PRIVATE int sqlite3BtreeCursor(
  58346. Btree *p, /* The btree */
  58347. int iTable, /* Root page of table to open */
  58348. int wrFlag, /* 1 to write. 0 read-only */
  58349. struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
  58350. BtCursor *pCur /* Write new cursor here */
  58351. ){
  58352. int rc;
  58353. if( iTable<1 ){
  58354. rc = SQLITE_CORRUPT_BKPT;
  58355. }else{
  58356. sqlite3BtreeEnter(p);
  58357. rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
  58358. sqlite3BtreeLeave(p);
  58359. }
  58360. return rc;
  58361. }
  58362. /*
  58363. ** Return the size of a BtCursor object in bytes.
  58364. **
  58365. ** This interfaces is needed so that users of cursors can preallocate
  58366. ** sufficient storage to hold a cursor. The BtCursor object is opaque
  58367. ** to users so they cannot do the sizeof() themselves - they must call
  58368. ** this routine.
  58369. */
  58370. SQLITE_PRIVATE int sqlite3BtreeCursorSize(void){
  58371. return ROUND8(sizeof(BtCursor));
  58372. }
  58373. /*
  58374. ** Initialize memory that will be converted into a BtCursor object.
  58375. **
  58376. ** The simple approach here would be to memset() the entire object
  58377. ** to zero. But it turns out that the apPage[] and aiIdx[] arrays
  58378. ** do not need to be zeroed and they are large, so we can save a lot
  58379. ** of run-time by skipping the initialization of those elements.
  58380. */
  58381. SQLITE_PRIVATE void sqlite3BtreeCursorZero(BtCursor *p){
  58382. memset(p, 0, offsetof(BtCursor, iPage));
  58383. }
  58384. /*
  58385. ** Close a cursor. The read lock on the database file is released
  58386. ** when the last cursor is closed.
  58387. */
  58388. SQLITE_PRIVATE int sqlite3BtreeCloseCursor(BtCursor *pCur){
  58389. Btree *pBtree = pCur->pBtree;
  58390. if( pBtree ){
  58391. int i;
  58392. BtShared *pBt = pCur->pBt;
  58393. sqlite3BtreeEnter(pBtree);
  58394. sqlite3BtreeClearCursor(pCur);
  58395. assert( pBt->pCursor!=0 );
  58396. if( pBt->pCursor==pCur ){
  58397. pBt->pCursor = pCur->pNext;
  58398. }else{
  58399. BtCursor *pPrev = pBt->pCursor;
  58400. do{
  58401. if( pPrev->pNext==pCur ){
  58402. pPrev->pNext = pCur->pNext;
  58403. break;
  58404. }
  58405. pPrev = pPrev->pNext;
  58406. }while( ALWAYS(pPrev) );
  58407. }
  58408. for(i=0; i<=pCur->iPage; i++){
  58409. releasePage(pCur->apPage[i]);
  58410. }
  58411. unlockBtreeIfUnused(pBt);
  58412. sqlite3_free(pCur->aOverflow);
  58413. /* sqlite3_free(pCur); */
  58414. sqlite3BtreeLeave(pBtree);
  58415. }
  58416. return SQLITE_OK;
  58417. }
  58418. /*
  58419. ** Make sure the BtCursor* given in the argument has a valid
  58420. ** BtCursor.info structure. If it is not already valid, call
  58421. ** btreeParseCell() to fill it in.
  58422. **
  58423. ** BtCursor.info is a cache of the information in the current cell.
  58424. ** Using this cache reduces the number of calls to btreeParseCell().
  58425. */
  58426. #ifndef NDEBUG
  58427. static void assertCellInfo(BtCursor *pCur){
  58428. CellInfo info;
  58429. int iPage = pCur->iPage;
  58430. memset(&info, 0, sizeof(info));
  58431. btreeParseCell(pCur->apPage[iPage], pCur->aiIdx[iPage], &info);
  58432. assert( CORRUPT_DB || memcmp(&info, &pCur->info, sizeof(info))==0 );
  58433. }
  58434. #else
  58435. #define assertCellInfo(x)
  58436. #endif
  58437. static SQLITE_NOINLINE void getCellInfo(BtCursor *pCur){
  58438. if( pCur->info.nSize==0 ){
  58439. int iPage = pCur->iPage;
  58440. pCur->curFlags |= BTCF_ValidNKey;
  58441. btreeParseCell(pCur->apPage[iPage],pCur->aiIdx[iPage],&pCur->info);
  58442. }else{
  58443. assertCellInfo(pCur);
  58444. }
  58445. }
  58446. #ifndef NDEBUG /* The next routine used only within assert() statements */
  58447. /*
  58448. ** Return true if the given BtCursor is valid. A valid cursor is one
  58449. ** that is currently pointing to a row in a (non-empty) table.
  58450. ** This is a verification routine is used only within assert() statements.
  58451. */
  58452. SQLITE_PRIVATE int sqlite3BtreeCursorIsValid(BtCursor *pCur){
  58453. return pCur && pCur->eState==CURSOR_VALID;
  58454. }
  58455. #endif /* NDEBUG */
  58456. /*
  58457. ** Return the value of the integer key or "rowid" for a table btree.
  58458. ** This routine is only valid for a cursor that is pointing into a
  58459. ** ordinary table btree. If the cursor points to an index btree or
  58460. ** is invalid, the result of this routine is undefined.
  58461. */
  58462. SQLITE_PRIVATE i64 sqlite3BtreeIntegerKey(BtCursor *pCur){
  58463. assert( cursorHoldsMutex(pCur) );
  58464. assert( pCur->eState==CURSOR_VALID );
  58465. assert( pCur->curIntKey );
  58466. getCellInfo(pCur);
  58467. return pCur->info.nKey;
  58468. }
  58469. /*
  58470. ** Return the number of bytes of payload for the entry that pCur is
  58471. ** currently pointing to. For table btrees, this will be the amount
  58472. ** of data. For index btrees, this will be the size of the key.
  58473. **
  58474. ** The caller must guarantee that the cursor is pointing to a non-NULL
  58475. ** valid entry. In other words, the calling procedure must guarantee
  58476. ** that the cursor has Cursor.eState==CURSOR_VALID.
  58477. */
  58478. SQLITE_PRIVATE u32 sqlite3BtreePayloadSize(BtCursor *pCur){
  58479. assert( cursorHoldsMutex(pCur) );
  58480. assert( pCur->eState==CURSOR_VALID );
  58481. getCellInfo(pCur);
  58482. return pCur->info.nPayload;
  58483. }
  58484. /*
  58485. ** Given the page number of an overflow page in the database (parameter
  58486. ** ovfl), this function finds the page number of the next page in the
  58487. ** linked list of overflow pages. If possible, it uses the auto-vacuum
  58488. ** pointer-map data instead of reading the content of page ovfl to do so.
  58489. **
  58490. ** If an error occurs an SQLite error code is returned. Otherwise:
  58491. **
  58492. ** The page number of the next overflow page in the linked list is
  58493. ** written to *pPgnoNext. If page ovfl is the last page in its linked
  58494. ** list, *pPgnoNext is set to zero.
  58495. **
  58496. ** If ppPage is not NULL, and a reference to the MemPage object corresponding
  58497. ** to page number pOvfl was obtained, then *ppPage is set to point to that
  58498. ** reference. It is the responsibility of the caller to call releasePage()
  58499. ** on *ppPage to free the reference. In no reference was obtained (because
  58500. ** the pointer-map was used to obtain the value for *pPgnoNext), then
  58501. ** *ppPage is set to zero.
  58502. */
  58503. static int getOverflowPage(
  58504. BtShared *pBt, /* The database file */
  58505. Pgno ovfl, /* Current overflow page number */
  58506. MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
  58507. Pgno *pPgnoNext /* OUT: Next overflow page number */
  58508. ){
  58509. Pgno next = 0;
  58510. MemPage *pPage = 0;
  58511. int rc = SQLITE_OK;
  58512. assert( sqlite3_mutex_held(pBt->mutex) );
  58513. assert(pPgnoNext);
  58514. #ifndef SQLITE_OMIT_AUTOVACUUM
  58515. /* Try to find the next page in the overflow list using the
  58516. ** autovacuum pointer-map pages. Guess that the next page in
  58517. ** the overflow list is page number (ovfl+1). If that guess turns
  58518. ** out to be wrong, fall back to loading the data of page
  58519. ** number ovfl to determine the next page number.
  58520. */
  58521. if( pBt->autoVacuum ){
  58522. Pgno pgno;
  58523. Pgno iGuess = ovfl+1;
  58524. u8 eType;
  58525. while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
  58526. iGuess++;
  58527. }
  58528. if( iGuess<=btreePagecount(pBt) ){
  58529. rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
  58530. if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
  58531. next = iGuess;
  58532. rc = SQLITE_DONE;
  58533. }
  58534. }
  58535. }
  58536. #endif
  58537. assert( next==0 || rc==SQLITE_DONE );
  58538. if( rc==SQLITE_OK ){
  58539. rc = btreeGetPage(pBt, ovfl, &pPage, (ppPage==0) ? PAGER_GET_READONLY : 0);
  58540. assert( rc==SQLITE_OK || pPage==0 );
  58541. if( rc==SQLITE_OK ){
  58542. next = get4byte(pPage->aData);
  58543. }
  58544. }
  58545. *pPgnoNext = next;
  58546. if( ppPage ){
  58547. *ppPage = pPage;
  58548. }else{
  58549. releasePage(pPage);
  58550. }
  58551. return (rc==SQLITE_DONE ? SQLITE_OK : rc);
  58552. }
  58553. /*
  58554. ** Copy data from a buffer to a page, or from a page to a buffer.
  58555. **
  58556. ** pPayload is a pointer to data stored on database page pDbPage.
  58557. ** If argument eOp is false, then nByte bytes of data are copied
  58558. ** from pPayload to the buffer pointed at by pBuf. If eOp is true,
  58559. ** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
  58560. ** of data are copied from the buffer pBuf to pPayload.
  58561. **
  58562. ** SQLITE_OK is returned on success, otherwise an error code.
  58563. */
  58564. static int copyPayload(
  58565. void *pPayload, /* Pointer to page data */
  58566. void *pBuf, /* Pointer to buffer */
  58567. int nByte, /* Number of bytes to copy */
  58568. int eOp, /* 0 -> copy from page, 1 -> copy to page */
  58569. DbPage *pDbPage /* Page containing pPayload */
  58570. ){
  58571. if( eOp ){
  58572. /* Copy data from buffer to page (a write operation) */
  58573. int rc = sqlite3PagerWrite(pDbPage);
  58574. if( rc!=SQLITE_OK ){
  58575. return rc;
  58576. }
  58577. memcpy(pPayload, pBuf, nByte);
  58578. }else{
  58579. /* Copy data from page to buffer (a read operation) */
  58580. memcpy(pBuf, pPayload, nByte);
  58581. }
  58582. return SQLITE_OK;
  58583. }
  58584. /*
  58585. ** This function is used to read or overwrite payload information
  58586. ** for the entry that the pCur cursor is pointing to. The eOp
  58587. ** argument is interpreted as follows:
  58588. **
  58589. ** 0: The operation is a read. Populate the overflow cache.
  58590. ** 1: The operation is a write. Populate the overflow cache.
  58591. ** 2: The operation is a read. Do not populate the overflow cache.
  58592. **
  58593. ** A total of "amt" bytes are read or written beginning at "offset".
  58594. ** Data is read to or from the buffer pBuf.
  58595. **
  58596. ** The content being read or written might appear on the main page
  58597. ** or be scattered out on multiple overflow pages.
  58598. **
  58599. ** If the current cursor entry uses one or more overflow pages and the
  58600. ** eOp argument is not 2, this function may allocate space for and lazily
  58601. ** populates the overflow page-list cache array (BtCursor.aOverflow).
  58602. ** Subsequent calls use this cache to make seeking to the supplied offset
  58603. ** more efficient.
  58604. **
  58605. ** Once an overflow page-list cache has been allocated, it may be
  58606. ** invalidated if some other cursor writes to the same table, or if
  58607. ** the cursor is moved to a different row. Additionally, in auto-vacuum
  58608. ** mode, the following events may invalidate an overflow page-list cache.
  58609. **
  58610. ** * An incremental vacuum,
  58611. ** * A commit in auto_vacuum="full" mode,
  58612. ** * Creating a table (may require moving an overflow page).
  58613. */
  58614. static int accessPayload(
  58615. BtCursor *pCur, /* Cursor pointing to entry to read from */
  58616. u32 offset, /* Begin reading this far into payload */
  58617. u32 amt, /* Read this many bytes */
  58618. unsigned char *pBuf, /* Write the bytes into this buffer */
  58619. int eOp /* zero to read. non-zero to write. */
  58620. ){
  58621. unsigned char *aPayload;
  58622. int rc = SQLITE_OK;
  58623. int iIdx = 0;
  58624. MemPage *pPage = pCur->apPage[pCur->iPage]; /* Btree page of current entry */
  58625. BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
  58626. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  58627. unsigned char * const pBufStart = pBuf;
  58628. int bEnd; /* True if reading to end of data */
  58629. #endif
  58630. assert( pPage );
  58631. assert( pCur->eState==CURSOR_VALID );
  58632. assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
  58633. assert( cursorHoldsMutex(pCur) );
  58634. assert( eOp!=2 || offset==0 ); /* Always start from beginning for eOp==2 */
  58635. getCellInfo(pCur);
  58636. aPayload = pCur->info.pPayload;
  58637. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  58638. bEnd = offset+amt==pCur->info.nPayload;
  58639. #endif
  58640. assert( offset+amt <= pCur->info.nPayload );
  58641. assert( aPayload > pPage->aData );
  58642. if( (uptr)(aPayload - pPage->aData) > (pBt->usableSize - pCur->info.nLocal) ){
  58643. /* Trying to read or write past the end of the data is an error. The
  58644. ** conditional above is really:
  58645. ** &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
  58646. ** but is recast into its current form to avoid integer overflow problems
  58647. */
  58648. return SQLITE_CORRUPT_BKPT;
  58649. }
  58650. /* Check if data must be read/written to/from the btree page itself. */
  58651. if( offset<pCur->info.nLocal ){
  58652. int a = amt;
  58653. if( a+offset>pCur->info.nLocal ){
  58654. a = pCur->info.nLocal - offset;
  58655. }
  58656. rc = copyPayload(&aPayload[offset], pBuf, a, (eOp & 0x01), pPage->pDbPage);
  58657. offset = 0;
  58658. pBuf += a;
  58659. amt -= a;
  58660. }else{
  58661. offset -= pCur->info.nLocal;
  58662. }
  58663. if( rc==SQLITE_OK && amt>0 ){
  58664. const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
  58665. Pgno nextPage;
  58666. nextPage = get4byte(&aPayload[pCur->info.nLocal]);
  58667. /* If the BtCursor.aOverflow[] has not been allocated, allocate it now.
  58668. ** Except, do not allocate aOverflow[] for eOp==2.
  58669. **
  58670. ** The aOverflow[] array is sized at one entry for each overflow page
  58671. ** in the overflow chain. The page number of the first overflow page is
  58672. ** stored in aOverflow[0], etc. A value of 0 in the aOverflow[] array
  58673. ** means "not yet known" (the cache is lazily populated).
  58674. */
  58675. if( eOp!=2 && (pCur->curFlags & BTCF_ValidOvfl)==0 ){
  58676. int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
  58677. if( nOvfl>pCur->nOvflAlloc ){
  58678. Pgno *aNew = (Pgno*)sqlite3Realloc(
  58679. pCur->aOverflow, nOvfl*2*sizeof(Pgno)
  58680. );
  58681. if( aNew==0 ){
  58682. rc = SQLITE_NOMEM_BKPT;
  58683. }else{
  58684. pCur->nOvflAlloc = nOvfl*2;
  58685. pCur->aOverflow = aNew;
  58686. }
  58687. }
  58688. if( rc==SQLITE_OK ){
  58689. memset(pCur->aOverflow, 0, nOvfl*sizeof(Pgno));
  58690. pCur->curFlags |= BTCF_ValidOvfl;
  58691. }
  58692. }
  58693. /* If the overflow page-list cache has been allocated and the
  58694. ** entry for the first required overflow page is valid, skip
  58695. ** directly to it.
  58696. */
  58697. if( (pCur->curFlags & BTCF_ValidOvfl)!=0
  58698. && pCur->aOverflow[offset/ovflSize]
  58699. ){
  58700. iIdx = (offset/ovflSize);
  58701. nextPage = pCur->aOverflow[iIdx];
  58702. offset = (offset%ovflSize);
  58703. }
  58704. for( ; rc==SQLITE_OK && amt>0 && nextPage; iIdx++){
  58705. /* If required, populate the overflow page-list cache. */
  58706. if( (pCur->curFlags & BTCF_ValidOvfl)!=0 ){
  58707. assert( pCur->aOverflow[iIdx]==0
  58708. || pCur->aOverflow[iIdx]==nextPage
  58709. || CORRUPT_DB );
  58710. pCur->aOverflow[iIdx] = nextPage;
  58711. }
  58712. if( offset>=ovflSize ){
  58713. /* The only reason to read this page is to obtain the page
  58714. ** number for the next page in the overflow chain. The page
  58715. ** data is not required. So first try to lookup the overflow
  58716. ** page-list cache, if any, then fall back to the getOverflowPage()
  58717. ** function.
  58718. **
  58719. ** Note that the aOverflow[] array must be allocated because eOp!=2
  58720. ** here. If eOp==2, then offset==0 and this branch is never taken.
  58721. */
  58722. assert( eOp!=2 );
  58723. assert( pCur->curFlags & BTCF_ValidOvfl );
  58724. assert( pCur->pBtree->db==pBt->db );
  58725. if( pCur->aOverflow[iIdx+1] ){
  58726. nextPage = pCur->aOverflow[iIdx+1];
  58727. }else{
  58728. rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
  58729. }
  58730. offset -= ovflSize;
  58731. }else{
  58732. /* Need to read this page properly. It contains some of the
  58733. ** range of data that is being read (eOp==0) or written (eOp!=0).
  58734. */
  58735. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  58736. sqlite3_file *fd;
  58737. #endif
  58738. int a = amt;
  58739. if( a + offset > ovflSize ){
  58740. a = ovflSize - offset;
  58741. }
  58742. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  58743. /* If all the following are true:
  58744. **
  58745. ** 1) this is a read operation, and
  58746. ** 2) data is required from the start of this overflow page, and
  58747. ** 3) the database is file-backed, and
  58748. ** 4) there is no open write-transaction, and
  58749. ** 5) the database is not a WAL database,
  58750. ** 6) all data from the page is being read.
  58751. ** 7) at least 4 bytes have already been read into the output buffer
  58752. **
  58753. ** then data can be read directly from the database file into the
  58754. ** output buffer, bypassing the page-cache altogether. This speeds
  58755. ** up loading large records that span many overflow pages.
  58756. */
  58757. if( (eOp&0x01)==0 /* (1) */
  58758. && offset==0 /* (2) */
  58759. && (bEnd || a==ovflSize) /* (6) */
  58760. && pBt->inTransaction==TRANS_READ /* (4) */
  58761. && (fd = sqlite3PagerFile(pBt->pPager))->pMethods /* (3) */
  58762. && 0==sqlite3PagerUseWal(pBt->pPager) /* (5) */
  58763. && &pBuf[-4]>=pBufStart /* (7) */
  58764. ){
  58765. u8 aSave[4];
  58766. u8 *aWrite = &pBuf[-4];
  58767. assert( aWrite>=pBufStart ); /* hence (7) */
  58768. memcpy(aSave, aWrite, 4);
  58769. rc = sqlite3OsRead(fd, aWrite, a+4, (i64)pBt->pageSize*(nextPage-1));
  58770. nextPage = get4byte(aWrite);
  58771. memcpy(aWrite, aSave, 4);
  58772. }else
  58773. #endif
  58774. {
  58775. DbPage *pDbPage;
  58776. rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage,
  58777. ((eOp&0x01)==0 ? PAGER_GET_READONLY : 0)
  58778. );
  58779. if( rc==SQLITE_OK ){
  58780. aPayload = sqlite3PagerGetData(pDbPage);
  58781. nextPage = get4byte(aPayload);
  58782. rc = copyPayload(&aPayload[offset+4], pBuf, a, (eOp&0x01), pDbPage);
  58783. sqlite3PagerUnref(pDbPage);
  58784. offset = 0;
  58785. }
  58786. }
  58787. amt -= a;
  58788. pBuf += a;
  58789. }
  58790. }
  58791. }
  58792. if( rc==SQLITE_OK && amt>0 ){
  58793. return SQLITE_CORRUPT_BKPT;
  58794. }
  58795. return rc;
  58796. }
  58797. /*
  58798. ** Read part of the key associated with cursor pCur. Exactly
  58799. ** "amt" bytes will be transferred into pBuf[]. The transfer
  58800. ** begins at "offset".
  58801. **
  58802. ** The caller must ensure that pCur is pointing to a valid row
  58803. ** in the table.
  58804. **
  58805. ** Return SQLITE_OK on success or an error code if anything goes
  58806. ** wrong. An error is returned if "offset+amt" is larger than
  58807. ** the available payload.
  58808. */
  58809. SQLITE_PRIVATE int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
  58810. assert( cursorHoldsMutex(pCur) );
  58811. assert( pCur->eState==CURSOR_VALID );
  58812. assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
  58813. assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
  58814. return accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
  58815. }
  58816. /*
  58817. ** Read part of the data associated with cursor pCur. Exactly
  58818. ** "amt" bytes will be transfered into pBuf[]. The transfer
  58819. ** begins at "offset".
  58820. **
  58821. ** Return SQLITE_OK on success or an error code if anything goes
  58822. ** wrong. An error is returned if "offset+amt" is larger than
  58823. ** the available payload.
  58824. */
  58825. SQLITE_PRIVATE int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
  58826. int rc;
  58827. #ifndef SQLITE_OMIT_INCRBLOB
  58828. if ( pCur->eState==CURSOR_INVALID ){
  58829. return SQLITE_ABORT;
  58830. }
  58831. #endif
  58832. assert( cursorOwnsBtShared(pCur) );
  58833. rc = restoreCursorPosition(pCur);
  58834. if( rc==SQLITE_OK ){
  58835. assert( pCur->eState==CURSOR_VALID );
  58836. assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
  58837. assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
  58838. rc = accessPayload(pCur, offset, amt, pBuf, 0);
  58839. }
  58840. return rc;
  58841. }
  58842. /*
  58843. ** Return a pointer to payload information from the entry that the
  58844. ** pCur cursor is pointing to. The pointer is to the beginning of
  58845. ** the key if index btrees (pPage->intKey==0) and is the data for
  58846. ** table btrees (pPage->intKey==1). The number of bytes of available
  58847. ** key/data is written into *pAmt. If *pAmt==0, then the value
  58848. ** returned will not be a valid pointer.
  58849. **
  58850. ** This routine is an optimization. It is common for the entire key
  58851. ** and data to fit on the local page and for there to be no overflow
  58852. ** pages. When that is so, this routine can be used to access the
  58853. ** key and data without making a copy. If the key and/or data spills
  58854. ** onto overflow pages, then accessPayload() must be used to reassemble
  58855. ** the key/data and copy it into a preallocated buffer.
  58856. **
  58857. ** The pointer returned by this routine looks directly into the cached
  58858. ** page of the database. The data might change or move the next time
  58859. ** any btree routine is called.
  58860. */
  58861. static const void *fetchPayload(
  58862. BtCursor *pCur, /* Cursor pointing to entry to read from */
  58863. u32 *pAmt /* Write the number of available bytes here */
  58864. ){
  58865. u32 amt;
  58866. assert( pCur!=0 && pCur->iPage>=0 && pCur->apPage[pCur->iPage]);
  58867. assert( pCur->eState==CURSOR_VALID );
  58868. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  58869. assert( cursorOwnsBtShared(pCur) );
  58870. assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
  58871. assert( pCur->info.nSize>0 );
  58872. assert( pCur->info.pPayload>pCur->apPage[pCur->iPage]->aData || CORRUPT_DB );
  58873. assert( pCur->info.pPayload<pCur->apPage[pCur->iPage]->aDataEnd ||CORRUPT_DB);
  58874. amt = (int)(pCur->apPage[pCur->iPage]->aDataEnd - pCur->info.pPayload);
  58875. if( pCur->info.nLocal<amt ) amt = pCur->info.nLocal;
  58876. *pAmt = amt;
  58877. return (void*)pCur->info.pPayload;
  58878. }
  58879. /*
  58880. ** For the entry that cursor pCur is point to, return as
  58881. ** many bytes of the key or data as are available on the local
  58882. ** b-tree page. Write the number of available bytes into *pAmt.
  58883. **
  58884. ** The pointer returned is ephemeral. The key/data may move
  58885. ** or be destroyed on the next call to any Btree routine,
  58886. ** including calls from other threads against the same cache.
  58887. ** Hence, a mutex on the BtShared should be held prior to calling
  58888. ** this routine.
  58889. **
  58890. ** These routines is used to get quick access to key and data
  58891. ** in the common case where no overflow pages are used.
  58892. */
  58893. SQLITE_PRIVATE const void *sqlite3BtreePayloadFetch(BtCursor *pCur, u32 *pAmt){
  58894. return fetchPayload(pCur, pAmt);
  58895. }
  58896. /*
  58897. ** Move the cursor down to a new child page. The newPgno argument is the
  58898. ** page number of the child page to move to.
  58899. **
  58900. ** This function returns SQLITE_CORRUPT if the page-header flags field of
  58901. ** the new child page does not match the flags field of the parent (i.e.
  58902. ** if an intkey page appears to be the parent of a non-intkey page, or
  58903. ** vice-versa).
  58904. */
  58905. static int moveToChild(BtCursor *pCur, u32 newPgno){
  58906. BtShared *pBt = pCur->pBt;
  58907. assert( cursorOwnsBtShared(pCur) );
  58908. assert( pCur->eState==CURSOR_VALID );
  58909. assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
  58910. assert( pCur->iPage>=0 );
  58911. if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
  58912. return SQLITE_CORRUPT_BKPT;
  58913. }
  58914. pCur->info.nSize = 0;
  58915. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  58916. pCur->iPage++;
  58917. pCur->aiIdx[pCur->iPage] = 0;
  58918. return getAndInitPage(pBt, newPgno, &pCur->apPage[pCur->iPage],
  58919. pCur, pCur->curPagerFlags);
  58920. }
  58921. #if SQLITE_DEBUG
  58922. /*
  58923. ** Page pParent is an internal (non-leaf) tree page. This function
  58924. ** asserts that page number iChild is the left-child if the iIdx'th
  58925. ** cell in page pParent. Or, if iIdx is equal to the total number of
  58926. ** cells in pParent, that page number iChild is the right-child of
  58927. ** the page.
  58928. */
  58929. static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
  58930. if( CORRUPT_DB ) return; /* The conditions tested below might not be true
  58931. ** in a corrupt database */
  58932. assert( iIdx<=pParent->nCell );
  58933. if( iIdx==pParent->nCell ){
  58934. assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
  58935. }else{
  58936. assert( get4byte(findCell(pParent, iIdx))==iChild );
  58937. }
  58938. }
  58939. #else
  58940. # define assertParentIndex(x,y,z)
  58941. #endif
  58942. /*
  58943. ** Move the cursor up to the parent page.
  58944. **
  58945. ** pCur->idx is set to the cell index that contains the pointer
  58946. ** to the page we are coming from. If we are coming from the
  58947. ** right-most child page then pCur->idx is set to one more than
  58948. ** the largest cell index.
  58949. */
  58950. static void moveToParent(BtCursor *pCur){
  58951. assert( cursorOwnsBtShared(pCur) );
  58952. assert( pCur->eState==CURSOR_VALID );
  58953. assert( pCur->iPage>0 );
  58954. assert( pCur->apPage[pCur->iPage] );
  58955. assertParentIndex(
  58956. pCur->apPage[pCur->iPage-1],
  58957. pCur->aiIdx[pCur->iPage-1],
  58958. pCur->apPage[pCur->iPage]->pgno
  58959. );
  58960. testcase( pCur->aiIdx[pCur->iPage-1] > pCur->apPage[pCur->iPage-1]->nCell );
  58961. pCur->info.nSize = 0;
  58962. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  58963. releasePageNotNull(pCur->apPage[pCur->iPage--]);
  58964. }
  58965. /*
  58966. ** Move the cursor to point to the root page of its b-tree structure.
  58967. **
  58968. ** If the table has a virtual root page, then the cursor is moved to point
  58969. ** to the virtual root page instead of the actual root page. A table has a
  58970. ** virtual root page when the actual root page contains no cells and a
  58971. ** single child page. This can only happen with the table rooted at page 1.
  58972. **
  58973. ** If the b-tree structure is empty, the cursor state is set to
  58974. ** CURSOR_INVALID. Otherwise, the cursor is set to point to the first
  58975. ** cell located on the root (or virtual root) page and the cursor state
  58976. ** is set to CURSOR_VALID.
  58977. **
  58978. ** If this function returns successfully, it may be assumed that the
  58979. ** page-header flags indicate that the [virtual] root-page is the expected
  58980. ** kind of b-tree page (i.e. if when opening the cursor the caller did not
  58981. ** specify a KeyInfo structure the flags byte is set to 0x05 or 0x0D,
  58982. ** indicating a table b-tree, or if the caller did specify a KeyInfo
  58983. ** structure the flags byte is set to 0x02 or 0x0A, indicating an index
  58984. ** b-tree).
  58985. */
  58986. static int moveToRoot(BtCursor *pCur){
  58987. MemPage *pRoot;
  58988. int rc = SQLITE_OK;
  58989. assert( cursorOwnsBtShared(pCur) );
  58990. assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
  58991. assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
  58992. assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
  58993. if( pCur->eState>=CURSOR_REQUIRESEEK ){
  58994. if( pCur->eState==CURSOR_FAULT ){
  58995. assert( pCur->skipNext!=SQLITE_OK );
  58996. return pCur->skipNext;
  58997. }
  58998. sqlite3BtreeClearCursor(pCur);
  58999. }
  59000. if( pCur->iPage>=0 ){
  59001. while( pCur->iPage ){
  59002. assert( pCur->apPage[pCur->iPage]!=0 );
  59003. releasePageNotNull(pCur->apPage[pCur->iPage--]);
  59004. }
  59005. }else if( pCur->pgnoRoot==0 ){
  59006. pCur->eState = CURSOR_INVALID;
  59007. return SQLITE_OK;
  59008. }else{
  59009. assert( pCur->iPage==(-1) );
  59010. rc = getAndInitPage(pCur->pBtree->pBt, pCur->pgnoRoot, &pCur->apPage[0],
  59011. 0, pCur->curPagerFlags);
  59012. if( rc!=SQLITE_OK ){
  59013. pCur->eState = CURSOR_INVALID;
  59014. return rc;
  59015. }
  59016. pCur->iPage = 0;
  59017. pCur->curIntKey = pCur->apPage[0]->intKey;
  59018. }
  59019. pRoot = pCur->apPage[0];
  59020. assert( pRoot->pgno==pCur->pgnoRoot );
  59021. /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
  59022. ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
  59023. ** NULL, the caller expects a table b-tree. If this is not the case,
  59024. ** return an SQLITE_CORRUPT error.
  59025. **
  59026. ** Earlier versions of SQLite assumed that this test could not fail
  59027. ** if the root page was already loaded when this function was called (i.e.
  59028. ** if pCur->iPage>=0). But this is not so if the database is corrupted
  59029. ** in such a way that page pRoot is linked into a second b-tree table
  59030. ** (or the freelist). */
  59031. assert( pRoot->intKey==1 || pRoot->intKey==0 );
  59032. if( pRoot->isInit==0 || (pCur->pKeyInfo==0)!=pRoot->intKey ){
  59033. return SQLITE_CORRUPT_BKPT;
  59034. }
  59035. pCur->aiIdx[0] = 0;
  59036. pCur->info.nSize = 0;
  59037. pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidNKey|BTCF_ValidOvfl);
  59038. if( pRoot->nCell>0 ){
  59039. pCur->eState = CURSOR_VALID;
  59040. }else if( !pRoot->leaf ){
  59041. Pgno subpage;
  59042. if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
  59043. subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
  59044. pCur->eState = CURSOR_VALID;
  59045. rc = moveToChild(pCur, subpage);
  59046. }else{
  59047. pCur->eState = CURSOR_INVALID;
  59048. }
  59049. return rc;
  59050. }
  59051. /*
  59052. ** Move the cursor down to the left-most leaf entry beneath the
  59053. ** entry to which it is currently pointing.
  59054. **
  59055. ** The left-most leaf is the one with the smallest key - the first
  59056. ** in ascending order.
  59057. */
  59058. static int moveToLeftmost(BtCursor *pCur){
  59059. Pgno pgno;
  59060. int rc = SQLITE_OK;
  59061. MemPage *pPage;
  59062. assert( cursorOwnsBtShared(pCur) );
  59063. assert( pCur->eState==CURSOR_VALID );
  59064. while( rc==SQLITE_OK && !(pPage = pCur->apPage[pCur->iPage])->leaf ){
  59065. assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
  59066. pgno = get4byte(findCell(pPage, pCur->aiIdx[pCur->iPage]));
  59067. rc = moveToChild(pCur, pgno);
  59068. }
  59069. return rc;
  59070. }
  59071. /*
  59072. ** Move the cursor down to the right-most leaf entry beneath the
  59073. ** page to which it is currently pointing. Notice the difference
  59074. ** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
  59075. ** finds the left-most entry beneath the *entry* whereas moveToRightmost()
  59076. ** finds the right-most entry beneath the *page*.
  59077. **
  59078. ** The right-most entry is the one with the largest key - the last
  59079. ** key in ascending order.
  59080. */
  59081. static int moveToRightmost(BtCursor *pCur){
  59082. Pgno pgno;
  59083. int rc = SQLITE_OK;
  59084. MemPage *pPage = 0;
  59085. assert( cursorOwnsBtShared(pCur) );
  59086. assert( pCur->eState==CURSOR_VALID );
  59087. while( !(pPage = pCur->apPage[pCur->iPage])->leaf ){
  59088. pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  59089. pCur->aiIdx[pCur->iPage] = pPage->nCell;
  59090. rc = moveToChild(pCur, pgno);
  59091. if( rc ) return rc;
  59092. }
  59093. pCur->aiIdx[pCur->iPage] = pPage->nCell-1;
  59094. assert( pCur->info.nSize==0 );
  59095. assert( (pCur->curFlags & BTCF_ValidNKey)==0 );
  59096. return SQLITE_OK;
  59097. }
  59098. /* Move the cursor to the first entry in the table. Return SQLITE_OK
  59099. ** on success. Set *pRes to 0 if the cursor actually points to something
  59100. ** or set *pRes to 1 if the table is empty.
  59101. */
  59102. SQLITE_PRIVATE int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
  59103. int rc;
  59104. assert( cursorOwnsBtShared(pCur) );
  59105. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  59106. rc = moveToRoot(pCur);
  59107. if( rc==SQLITE_OK ){
  59108. if( pCur->eState==CURSOR_INVALID ){
  59109. assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
  59110. *pRes = 1;
  59111. }else{
  59112. assert( pCur->apPage[pCur->iPage]->nCell>0 );
  59113. *pRes = 0;
  59114. rc = moveToLeftmost(pCur);
  59115. }
  59116. }
  59117. return rc;
  59118. }
  59119. /* Move the cursor to the last entry in the table. Return SQLITE_OK
  59120. ** on success. Set *pRes to 0 if the cursor actually points to something
  59121. ** or set *pRes to 1 if the table is empty.
  59122. */
  59123. SQLITE_PRIVATE int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
  59124. int rc;
  59125. assert( cursorOwnsBtShared(pCur) );
  59126. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  59127. /* If the cursor already points to the last entry, this is a no-op. */
  59128. if( CURSOR_VALID==pCur->eState && (pCur->curFlags & BTCF_AtLast)!=0 ){
  59129. #ifdef SQLITE_DEBUG
  59130. /* This block serves to assert() that the cursor really does point
  59131. ** to the last entry in the b-tree. */
  59132. int ii;
  59133. for(ii=0; ii<pCur->iPage; ii++){
  59134. assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
  59135. }
  59136. assert( pCur->aiIdx[pCur->iPage]==pCur->apPage[pCur->iPage]->nCell-1 );
  59137. assert( pCur->apPage[pCur->iPage]->leaf );
  59138. #endif
  59139. return SQLITE_OK;
  59140. }
  59141. rc = moveToRoot(pCur);
  59142. if( rc==SQLITE_OK ){
  59143. if( CURSOR_INVALID==pCur->eState ){
  59144. assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
  59145. *pRes = 1;
  59146. }else{
  59147. assert( pCur->eState==CURSOR_VALID );
  59148. *pRes = 0;
  59149. rc = moveToRightmost(pCur);
  59150. if( rc==SQLITE_OK ){
  59151. pCur->curFlags |= BTCF_AtLast;
  59152. }else{
  59153. pCur->curFlags &= ~BTCF_AtLast;
  59154. }
  59155. }
  59156. }
  59157. return rc;
  59158. }
  59159. /* Move the cursor so that it points to an entry near the key
  59160. ** specified by pIdxKey or intKey. Return a success code.
  59161. **
  59162. ** For INTKEY tables, the intKey parameter is used. pIdxKey
  59163. ** must be NULL. For index tables, pIdxKey is used and intKey
  59164. ** is ignored.
  59165. **
  59166. ** If an exact match is not found, then the cursor is always
  59167. ** left pointing at a leaf page which would hold the entry if it
  59168. ** were present. The cursor might point to an entry that comes
  59169. ** before or after the key.
  59170. **
  59171. ** An integer is written into *pRes which is the result of
  59172. ** comparing the key with the entry to which the cursor is
  59173. ** pointing. The meaning of the integer written into
  59174. ** *pRes is as follows:
  59175. **
  59176. ** *pRes<0 The cursor is left pointing at an entry that
  59177. ** is smaller than intKey/pIdxKey or if the table is empty
  59178. ** and the cursor is therefore left point to nothing.
  59179. **
  59180. ** *pRes==0 The cursor is left pointing at an entry that
  59181. ** exactly matches intKey/pIdxKey.
  59182. **
  59183. ** *pRes>0 The cursor is left pointing at an entry that
  59184. ** is larger than intKey/pIdxKey.
  59185. **
  59186. ** For index tables, the pIdxKey->eqSeen field is set to 1 if there
  59187. ** exists an entry in the table that exactly matches pIdxKey.
  59188. */
  59189. SQLITE_PRIVATE int sqlite3BtreeMovetoUnpacked(
  59190. BtCursor *pCur, /* The cursor to be moved */
  59191. UnpackedRecord *pIdxKey, /* Unpacked index key */
  59192. i64 intKey, /* The table key */
  59193. int biasRight, /* If true, bias the search to the high end */
  59194. int *pRes /* Write search results here */
  59195. ){
  59196. int rc;
  59197. RecordCompare xRecordCompare;
  59198. assert( cursorOwnsBtShared(pCur) );
  59199. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  59200. assert( pRes );
  59201. assert( (pIdxKey==0)==(pCur->pKeyInfo==0) );
  59202. assert( pCur->eState!=CURSOR_VALID || (pIdxKey==0)==(pCur->curIntKey!=0) );
  59203. /* If the cursor is already positioned at the point we are trying
  59204. ** to move to, then just return without doing any work */
  59205. if( pIdxKey==0
  59206. && pCur->eState==CURSOR_VALID && (pCur->curFlags & BTCF_ValidNKey)!=0
  59207. ){
  59208. if( pCur->info.nKey==intKey ){
  59209. *pRes = 0;
  59210. return SQLITE_OK;
  59211. }
  59212. if( (pCur->curFlags & BTCF_AtLast)!=0 && pCur->info.nKey<intKey ){
  59213. *pRes = -1;
  59214. return SQLITE_OK;
  59215. }
  59216. }
  59217. if( pIdxKey ){
  59218. xRecordCompare = sqlite3VdbeFindCompare(pIdxKey);
  59219. pIdxKey->errCode = 0;
  59220. assert( pIdxKey->default_rc==1
  59221. || pIdxKey->default_rc==0
  59222. || pIdxKey->default_rc==-1
  59223. );
  59224. }else{
  59225. xRecordCompare = 0; /* All keys are integers */
  59226. }
  59227. rc = moveToRoot(pCur);
  59228. if( rc ){
  59229. return rc;
  59230. }
  59231. assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage] );
  59232. assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->isInit );
  59233. assert( pCur->eState==CURSOR_INVALID || pCur->apPage[pCur->iPage]->nCell>0 );
  59234. if( pCur->eState==CURSOR_INVALID ){
  59235. *pRes = -1;
  59236. assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
  59237. return SQLITE_OK;
  59238. }
  59239. assert( pCur->apPage[0]->intKey==pCur->curIntKey );
  59240. assert( pCur->curIntKey || pIdxKey );
  59241. for(;;){
  59242. int lwr, upr, idx, c;
  59243. Pgno chldPg;
  59244. MemPage *pPage = pCur->apPage[pCur->iPage];
  59245. u8 *pCell; /* Pointer to current cell in pPage */
  59246. /* pPage->nCell must be greater than zero. If this is the root-page
  59247. ** the cursor would have been INVALID above and this for(;;) loop
  59248. ** not run. If this is not the root-page, then the moveToChild() routine
  59249. ** would have already detected db corruption. Similarly, pPage must
  59250. ** be the right kind (index or table) of b-tree page. Otherwise
  59251. ** a moveToChild() or moveToRoot() call would have detected corruption. */
  59252. assert( pPage->nCell>0 );
  59253. assert( pPage->intKey==(pIdxKey==0) );
  59254. lwr = 0;
  59255. upr = pPage->nCell-1;
  59256. assert( biasRight==0 || biasRight==1 );
  59257. idx = upr>>(1-biasRight); /* idx = biasRight ? upr : (lwr+upr)/2; */
  59258. pCur->aiIdx[pCur->iPage] = (u16)idx;
  59259. if( xRecordCompare==0 ){
  59260. for(;;){
  59261. i64 nCellKey;
  59262. pCell = findCellPastPtr(pPage, idx);
  59263. if( pPage->intKeyLeaf ){
  59264. while( 0x80 <= *(pCell++) ){
  59265. if( pCell>=pPage->aDataEnd ) return SQLITE_CORRUPT_BKPT;
  59266. }
  59267. }
  59268. getVarint(pCell, (u64*)&nCellKey);
  59269. if( nCellKey<intKey ){
  59270. lwr = idx+1;
  59271. if( lwr>upr ){ c = -1; break; }
  59272. }else if( nCellKey>intKey ){
  59273. upr = idx-1;
  59274. if( lwr>upr ){ c = +1; break; }
  59275. }else{
  59276. assert( nCellKey==intKey );
  59277. pCur->curFlags |= BTCF_ValidNKey;
  59278. pCur->info.nKey = nCellKey;
  59279. pCur->aiIdx[pCur->iPage] = (u16)idx;
  59280. if( !pPage->leaf ){
  59281. lwr = idx;
  59282. goto moveto_next_layer;
  59283. }else{
  59284. *pRes = 0;
  59285. rc = SQLITE_OK;
  59286. goto moveto_finish;
  59287. }
  59288. }
  59289. assert( lwr+upr>=0 );
  59290. idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2; */
  59291. }
  59292. }else{
  59293. for(;;){
  59294. int nCell; /* Size of the pCell cell in bytes */
  59295. pCell = findCellPastPtr(pPage, idx);
  59296. /* The maximum supported page-size is 65536 bytes. This means that
  59297. ** the maximum number of record bytes stored on an index B-Tree
  59298. ** page is less than 16384 bytes and may be stored as a 2-byte
  59299. ** varint. This information is used to attempt to avoid parsing
  59300. ** the entire cell by checking for the cases where the record is
  59301. ** stored entirely within the b-tree page by inspecting the first
  59302. ** 2 bytes of the cell.
  59303. */
  59304. nCell = pCell[0];
  59305. if( nCell<=pPage->max1bytePayload ){
  59306. /* This branch runs if the record-size field of the cell is a
  59307. ** single byte varint and the record fits entirely on the main
  59308. ** b-tree page. */
  59309. testcase( pCell+nCell+1==pPage->aDataEnd );
  59310. c = xRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
  59311. }else if( !(pCell[1] & 0x80)
  59312. && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
  59313. ){
  59314. /* The record-size field is a 2 byte varint and the record
  59315. ** fits entirely on the main b-tree page. */
  59316. testcase( pCell+nCell+2==pPage->aDataEnd );
  59317. c = xRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
  59318. }else{
  59319. /* The record flows over onto one or more overflow pages. In
  59320. ** this case the whole cell needs to be parsed, a buffer allocated
  59321. ** and accessPayload() used to retrieve the record into the
  59322. ** buffer before VdbeRecordCompare() can be called.
  59323. **
  59324. ** If the record is corrupt, the xRecordCompare routine may read
  59325. ** up to two varints past the end of the buffer. An extra 18
  59326. ** bytes of padding is allocated at the end of the buffer in
  59327. ** case this happens. */
  59328. void *pCellKey;
  59329. u8 * const pCellBody = pCell - pPage->childPtrSize;
  59330. pPage->xParseCell(pPage, pCellBody, &pCur->info);
  59331. nCell = (int)pCur->info.nKey;
  59332. testcase( nCell<0 ); /* True if key size is 2^32 or more */
  59333. testcase( nCell==0 ); /* Invalid key size: 0x80 0x80 0x00 */
  59334. testcase( nCell==1 ); /* Invalid key size: 0x80 0x80 0x01 */
  59335. testcase( nCell==2 ); /* Minimum legal index key size */
  59336. if( nCell<2 ){
  59337. rc = SQLITE_CORRUPT_BKPT;
  59338. goto moveto_finish;
  59339. }
  59340. pCellKey = sqlite3Malloc( nCell+18 );
  59341. if( pCellKey==0 ){
  59342. rc = SQLITE_NOMEM_BKPT;
  59343. goto moveto_finish;
  59344. }
  59345. pCur->aiIdx[pCur->iPage] = (u16)idx;
  59346. rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 2);
  59347. if( rc ){
  59348. sqlite3_free(pCellKey);
  59349. goto moveto_finish;
  59350. }
  59351. c = xRecordCompare(nCell, pCellKey, pIdxKey);
  59352. sqlite3_free(pCellKey);
  59353. }
  59354. assert(
  59355. (pIdxKey->errCode!=SQLITE_CORRUPT || c==0)
  59356. && (pIdxKey->errCode!=SQLITE_NOMEM || pCur->pBtree->db->mallocFailed)
  59357. );
  59358. if( c<0 ){
  59359. lwr = idx+1;
  59360. }else if( c>0 ){
  59361. upr = idx-1;
  59362. }else{
  59363. assert( c==0 );
  59364. *pRes = 0;
  59365. rc = SQLITE_OK;
  59366. pCur->aiIdx[pCur->iPage] = (u16)idx;
  59367. if( pIdxKey->errCode ) rc = SQLITE_CORRUPT;
  59368. goto moveto_finish;
  59369. }
  59370. if( lwr>upr ) break;
  59371. assert( lwr+upr>=0 );
  59372. idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2 */
  59373. }
  59374. }
  59375. assert( lwr==upr+1 || (pPage->intKey && !pPage->leaf) );
  59376. assert( pPage->isInit );
  59377. if( pPage->leaf ){
  59378. assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
  59379. pCur->aiIdx[pCur->iPage] = (u16)idx;
  59380. *pRes = c;
  59381. rc = SQLITE_OK;
  59382. goto moveto_finish;
  59383. }
  59384. moveto_next_layer:
  59385. if( lwr>=pPage->nCell ){
  59386. chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  59387. }else{
  59388. chldPg = get4byte(findCell(pPage, lwr));
  59389. }
  59390. pCur->aiIdx[pCur->iPage] = (u16)lwr;
  59391. rc = moveToChild(pCur, chldPg);
  59392. if( rc ) break;
  59393. }
  59394. moveto_finish:
  59395. pCur->info.nSize = 0;
  59396. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  59397. return rc;
  59398. }
  59399. /*
  59400. ** Return TRUE if the cursor is not pointing at an entry of the table.
  59401. **
  59402. ** TRUE will be returned after a call to sqlite3BtreeNext() moves
  59403. ** past the last entry in the table or sqlite3BtreePrev() moves past
  59404. ** the first entry. TRUE is also returned if the table is empty.
  59405. */
  59406. SQLITE_PRIVATE int sqlite3BtreeEof(BtCursor *pCur){
  59407. /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
  59408. ** have been deleted? This API will need to change to return an error code
  59409. ** as well as the boolean result value.
  59410. */
  59411. return (CURSOR_VALID!=pCur->eState);
  59412. }
  59413. /*
  59414. ** Advance the cursor to the next entry in the database. If
  59415. ** successful then set *pRes=0. If the cursor
  59416. ** was already pointing to the last entry in the database before
  59417. ** this routine was called, then set *pRes=1.
  59418. **
  59419. ** The main entry point is sqlite3BtreeNext(). That routine is optimized
  59420. ** for the common case of merely incrementing the cell counter BtCursor.aiIdx
  59421. ** to the next cell on the current page. The (slower) btreeNext() helper
  59422. ** routine is called when it is necessary to move to a different page or
  59423. ** to restore the cursor.
  59424. **
  59425. ** The calling function will set *pRes to 0 or 1. The initial *pRes value
  59426. ** will be 1 if the cursor being stepped corresponds to an SQL index and
  59427. ** if this routine could have been skipped if that SQL index had been
  59428. ** a unique index. Otherwise the caller will have set *pRes to zero.
  59429. ** Zero is the common case. The btree implementation is free to use the
  59430. ** initial *pRes value as a hint to improve performance, but the current
  59431. ** SQLite btree implementation does not. (Note that the comdb2 btree
  59432. ** implementation does use this hint, however.)
  59433. */
  59434. static SQLITE_NOINLINE int btreeNext(BtCursor *pCur, int *pRes){
  59435. int rc;
  59436. int idx;
  59437. MemPage *pPage;
  59438. assert( cursorOwnsBtShared(pCur) );
  59439. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  59440. assert( *pRes==0 );
  59441. if( pCur->eState!=CURSOR_VALID ){
  59442. assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
  59443. rc = restoreCursorPosition(pCur);
  59444. if( rc!=SQLITE_OK ){
  59445. return rc;
  59446. }
  59447. if( CURSOR_INVALID==pCur->eState ){
  59448. *pRes = 1;
  59449. return SQLITE_OK;
  59450. }
  59451. if( pCur->skipNext ){
  59452. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
  59453. pCur->eState = CURSOR_VALID;
  59454. if( pCur->skipNext>0 ){
  59455. pCur->skipNext = 0;
  59456. return SQLITE_OK;
  59457. }
  59458. pCur->skipNext = 0;
  59459. }
  59460. }
  59461. pPage = pCur->apPage[pCur->iPage];
  59462. idx = ++pCur->aiIdx[pCur->iPage];
  59463. assert( pPage->isInit );
  59464. /* If the database file is corrupt, it is possible for the value of idx
  59465. ** to be invalid here. This can only occur if a second cursor modifies
  59466. ** the page while cursor pCur is holding a reference to it. Which can
  59467. ** only happen if the database is corrupt in such a way as to link the
  59468. ** page into more than one b-tree structure. */
  59469. testcase( idx>pPage->nCell );
  59470. if( idx>=pPage->nCell ){
  59471. if( !pPage->leaf ){
  59472. rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
  59473. if( rc ) return rc;
  59474. return moveToLeftmost(pCur);
  59475. }
  59476. do{
  59477. if( pCur->iPage==0 ){
  59478. *pRes = 1;
  59479. pCur->eState = CURSOR_INVALID;
  59480. return SQLITE_OK;
  59481. }
  59482. moveToParent(pCur);
  59483. pPage = pCur->apPage[pCur->iPage];
  59484. }while( pCur->aiIdx[pCur->iPage]>=pPage->nCell );
  59485. if( pPage->intKey ){
  59486. return sqlite3BtreeNext(pCur, pRes);
  59487. }else{
  59488. return SQLITE_OK;
  59489. }
  59490. }
  59491. if( pPage->leaf ){
  59492. return SQLITE_OK;
  59493. }else{
  59494. return moveToLeftmost(pCur);
  59495. }
  59496. }
  59497. SQLITE_PRIVATE int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
  59498. MemPage *pPage;
  59499. assert( cursorOwnsBtShared(pCur) );
  59500. assert( pRes!=0 );
  59501. assert( *pRes==0 || *pRes==1 );
  59502. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  59503. pCur->info.nSize = 0;
  59504. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  59505. *pRes = 0;
  59506. if( pCur->eState!=CURSOR_VALID ) return btreeNext(pCur, pRes);
  59507. pPage = pCur->apPage[pCur->iPage];
  59508. if( (++pCur->aiIdx[pCur->iPage])>=pPage->nCell ){
  59509. pCur->aiIdx[pCur->iPage]--;
  59510. return btreeNext(pCur, pRes);
  59511. }
  59512. if( pPage->leaf ){
  59513. return SQLITE_OK;
  59514. }else{
  59515. return moveToLeftmost(pCur);
  59516. }
  59517. }
  59518. /*
  59519. ** Step the cursor to the back to the previous entry in the database. If
  59520. ** successful then set *pRes=0. If the cursor
  59521. ** was already pointing to the first entry in the database before
  59522. ** this routine was called, then set *pRes=1.
  59523. **
  59524. ** The main entry point is sqlite3BtreePrevious(). That routine is optimized
  59525. ** for the common case of merely decrementing the cell counter BtCursor.aiIdx
  59526. ** to the previous cell on the current page. The (slower) btreePrevious()
  59527. ** helper routine is called when it is necessary to move to a different page
  59528. ** or to restore the cursor.
  59529. **
  59530. ** The calling function will set *pRes to 0 or 1. The initial *pRes value
  59531. ** will be 1 if the cursor being stepped corresponds to an SQL index and
  59532. ** if this routine could have been skipped if that SQL index had been
  59533. ** a unique index. Otherwise the caller will have set *pRes to zero.
  59534. ** Zero is the common case. The btree implementation is free to use the
  59535. ** initial *pRes value as a hint to improve performance, but the current
  59536. ** SQLite btree implementation does not. (Note that the comdb2 btree
  59537. ** implementation does use this hint, however.)
  59538. */
  59539. static SQLITE_NOINLINE int btreePrevious(BtCursor *pCur, int *pRes){
  59540. int rc;
  59541. MemPage *pPage;
  59542. assert( cursorOwnsBtShared(pCur) );
  59543. assert( pRes!=0 );
  59544. assert( *pRes==0 );
  59545. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  59546. assert( (pCur->curFlags & (BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey))==0 );
  59547. assert( pCur->info.nSize==0 );
  59548. if( pCur->eState!=CURSOR_VALID ){
  59549. rc = restoreCursorPosition(pCur);
  59550. if( rc!=SQLITE_OK ){
  59551. return rc;
  59552. }
  59553. if( CURSOR_INVALID==pCur->eState ){
  59554. *pRes = 1;
  59555. return SQLITE_OK;
  59556. }
  59557. if( pCur->skipNext ){
  59558. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
  59559. pCur->eState = CURSOR_VALID;
  59560. if( pCur->skipNext<0 ){
  59561. pCur->skipNext = 0;
  59562. return SQLITE_OK;
  59563. }
  59564. pCur->skipNext = 0;
  59565. }
  59566. }
  59567. pPage = pCur->apPage[pCur->iPage];
  59568. assert( pPage->isInit );
  59569. if( !pPage->leaf ){
  59570. int idx = pCur->aiIdx[pCur->iPage];
  59571. rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
  59572. if( rc ) return rc;
  59573. rc = moveToRightmost(pCur);
  59574. }else{
  59575. while( pCur->aiIdx[pCur->iPage]==0 ){
  59576. if( pCur->iPage==0 ){
  59577. pCur->eState = CURSOR_INVALID;
  59578. *pRes = 1;
  59579. return SQLITE_OK;
  59580. }
  59581. moveToParent(pCur);
  59582. }
  59583. assert( pCur->info.nSize==0 );
  59584. assert( (pCur->curFlags & (BTCF_ValidNKey|BTCF_ValidOvfl))==0 );
  59585. pCur->aiIdx[pCur->iPage]--;
  59586. pPage = pCur->apPage[pCur->iPage];
  59587. if( pPage->intKey && !pPage->leaf ){
  59588. rc = sqlite3BtreePrevious(pCur, pRes);
  59589. }else{
  59590. rc = SQLITE_OK;
  59591. }
  59592. }
  59593. return rc;
  59594. }
  59595. SQLITE_PRIVATE int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
  59596. assert( cursorOwnsBtShared(pCur) );
  59597. assert( pRes!=0 );
  59598. assert( *pRes==0 || *pRes==1 );
  59599. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  59600. *pRes = 0;
  59601. pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey);
  59602. pCur->info.nSize = 0;
  59603. if( pCur->eState!=CURSOR_VALID
  59604. || pCur->aiIdx[pCur->iPage]==0
  59605. || pCur->apPage[pCur->iPage]->leaf==0
  59606. ){
  59607. return btreePrevious(pCur, pRes);
  59608. }
  59609. pCur->aiIdx[pCur->iPage]--;
  59610. return SQLITE_OK;
  59611. }
  59612. /*
  59613. ** Allocate a new page from the database file.
  59614. **
  59615. ** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
  59616. ** has already been called on the new page.) The new page has also
  59617. ** been referenced and the calling routine is responsible for calling
  59618. ** sqlite3PagerUnref() on the new page when it is done.
  59619. **
  59620. ** SQLITE_OK is returned on success. Any other return value indicates
  59621. ** an error. *ppPage is set to NULL in the event of an error.
  59622. **
  59623. ** If the "nearby" parameter is not 0, then an effort is made to
  59624. ** locate a page close to the page number "nearby". This can be used in an
  59625. ** attempt to keep related pages close to each other in the database file,
  59626. ** which in turn can make database access faster.
  59627. **
  59628. ** If the eMode parameter is BTALLOC_EXACT and the nearby page exists
  59629. ** anywhere on the free-list, then it is guaranteed to be returned. If
  59630. ** eMode is BTALLOC_LT then the page returned will be less than or equal
  59631. ** to nearby if any such page exists. If eMode is BTALLOC_ANY then there
  59632. ** are no restrictions on which page is returned.
  59633. */
  59634. static int allocateBtreePage(
  59635. BtShared *pBt, /* The btree */
  59636. MemPage **ppPage, /* Store pointer to the allocated page here */
  59637. Pgno *pPgno, /* Store the page number here */
  59638. Pgno nearby, /* Search for a page near this one */
  59639. u8 eMode /* BTALLOC_EXACT, BTALLOC_LT, or BTALLOC_ANY */
  59640. ){
  59641. MemPage *pPage1;
  59642. int rc;
  59643. u32 n; /* Number of pages on the freelist */
  59644. u32 k; /* Number of leaves on the trunk of the freelist */
  59645. MemPage *pTrunk = 0;
  59646. MemPage *pPrevTrunk = 0;
  59647. Pgno mxPage; /* Total size of the database file */
  59648. assert( sqlite3_mutex_held(pBt->mutex) );
  59649. assert( eMode==BTALLOC_ANY || (nearby>0 && IfNotOmitAV(pBt->autoVacuum)) );
  59650. pPage1 = pBt->pPage1;
  59651. mxPage = btreePagecount(pBt);
  59652. /* EVIDENCE-OF: R-05119-02637 The 4-byte big-endian integer at offset 36
  59653. ** stores stores the total number of pages on the freelist. */
  59654. n = get4byte(&pPage1->aData[36]);
  59655. testcase( n==mxPage-1 );
  59656. if( n>=mxPage ){
  59657. return SQLITE_CORRUPT_BKPT;
  59658. }
  59659. if( n>0 ){
  59660. /* There are pages on the freelist. Reuse one of those pages. */
  59661. Pgno iTrunk;
  59662. u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
  59663. u32 nSearch = 0; /* Count of the number of search attempts */
  59664. /* If eMode==BTALLOC_EXACT and a query of the pointer-map
  59665. ** shows that the page 'nearby' is somewhere on the free-list, then
  59666. ** the entire-list will be searched for that page.
  59667. */
  59668. #ifndef SQLITE_OMIT_AUTOVACUUM
  59669. if( eMode==BTALLOC_EXACT ){
  59670. if( nearby<=mxPage ){
  59671. u8 eType;
  59672. assert( nearby>0 );
  59673. assert( pBt->autoVacuum );
  59674. rc = ptrmapGet(pBt, nearby, &eType, 0);
  59675. if( rc ) return rc;
  59676. if( eType==PTRMAP_FREEPAGE ){
  59677. searchList = 1;
  59678. }
  59679. }
  59680. }else if( eMode==BTALLOC_LE ){
  59681. searchList = 1;
  59682. }
  59683. #endif
  59684. /* Decrement the free-list count by 1. Set iTrunk to the index of the
  59685. ** first free-list trunk page. iPrevTrunk is initially 1.
  59686. */
  59687. rc = sqlite3PagerWrite(pPage1->pDbPage);
  59688. if( rc ) return rc;
  59689. put4byte(&pPage1->aData[36], n-1);
  59690. /* The code within this loop is run only once if the 'searchList' variable
  59691. ** is not true. Otherwise, it runs once for each trunk-page on the
  59692. ** free-list until the page 'nearby' is located (eMode==BTALLOC_EXACT)
  59693. ** or until a page less than 'nearby' is located (eMode==BTALLOC_LT)
  59694. */
  59695. do {
  59696. pPrevTrunk = pTrunk;
  59697. if( pPrevTrunk ){
  59698. /* EVIDENCE-OF: R-01506-11053 The first integer on a freelist trunk page
  59699. ** is the page number of the next freelist trunk page in the list or
  59700. ** zero if this is the last freelist trunk page. */
  59701. iTrunk = get4byte(&pPrevTrunk->aData[0]);
  59702. }else{
  59703. /* EVIDENCE-OF: R-59841-13798 The 4-byte big-endian integer at offset 32
  59704. ** stores the page number of the first page of the freelist, or zero if
  59705. ** the freelist is empty. */
  59706. iTrunk = get4byte(&pPage1->aData[32]);
  59707. }
  59708. testcase( iTrunk==mxPage );
  59709. if( iTrunk>mxPage || nSearch++ > n ){
  59710. rc = SQLITE_CORRUPT_BKPT;
  59711. }else{
  59712. rc = btreeGetUnusedPage(pBt, iTrunk, &pTrunk, 0);
  59713. }
  59714. if( rc ){
  59715. pTrunk = 0;
  59716. goto end_allocate_page;
  59717. }
  59718. assert( pTrunk!=0 );
  59719. assert( pTrunk->aData!=0 );
  59720. /* EVIDENCE-OF: R-13523-04394 The second integer on a freelist trunk page
  59721. ** is the number of leaf page pointers to follow. */
  59722. k = get4byte(&pTrunk->aData[4]);
  59723. if( k==0 && !searchList ){
  59724. /* The trunk has no leaves and the list is not being searched.
  59725. ** So extract the trunk page itself and use it as the newly
  59726. ** allocated page */
  59727. assert( pPrevTrunk==0 );
  59728. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  59729. if( rc ){
  59730. goto end_allocate_page;
  59731. }
  59732. *pPgno = iTrunk;
  59733. memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
  59734. *ppPage = pTrunk;
  59735. pTrunk = 0;
  59736. TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
  59737. }else if( k>(u32)(pBt->usableSize/4 - 2) ){
  59738. /* Value of k is out of range. Database corruption */
  59739. rc = SQLITE_CORRUPT_BKPT;
  59740. goto end_allocate_page;
  59741. #ifndef SQLITE_OMIT_AUTOVACUUM
  59742. }else if( searchList
  59743. && (nearby==iTrunk || (iTrunk<nearby && eMode==BTALLOC_LE))
  59744. ){
  59745. /* The list is being searched and this trunk page is the page
  59746. ** to allocate, regardless of whether it has leaves.
  59747. */
  59748. *pPgno = iTrunk;
  59749. *ppPage = pTrunk;
  59750. searchList = 0;
  59751. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  59752. if( rc ){
  59753. goto end_allocate_page;
  59754. }
  59755. if( k==0 ){
  59756. if( !pPrevTrunk ){
  59757. memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
  59758. }else{
  59759. rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
  59760. if( rc!=SQLITE_OK ){
  59761. goto end_allocate_page;
  59762. }
  59763. memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
  59764. }
  59765. }else{
  59766. /* The trunk page is required by the caller but it contains
  59767. ** pointers to free-list leaves. The first leaf becomes a trunk
  59768. ** page in this case.
  59769. */
  59770. MemPage *pNewTrunk;
  59771. Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
  59772. if( iNewTrunk>mxPage ){
  59773. rc = SQLITE_CORRUPT_BKPT;
  59774. goto end_allocate_page;
  59775. }
  59776. testcase( iNewTrunk==mxPage );
  59777. rc = btreeGetUnusedPage(pBt, iNewTrunk, &pNewTrunk, 0);
  59778. if( rc!=SQLITE_OK ){
  59779. goto end_allocate_page;
  59780. }
  59781. rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
  59782. if( rc!=SQLITE_OK ){
  59783. releasePage(pNewTrunk);
  59784. goto end_allocate_page;
  59785. }
  59786. memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
  59787. put4byte(&pNewTrunk->aData[4], k-1);
  59788. memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
  59789. releasePage(pNewTrunk);
  59790. if( !pPrevTrunk ){
  59791. assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
  59792. put4byte(&pPage1->aData[32], iNewTrunk);
  59793. }else{
  59794. rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
  59795. if( rc ){
  59796. goto end_allocate_page;
  59797. }
  59798. put4byte(&pPrevTrunk->aData[0], iNewTrunk);
  59799. }
  59800. }
  59801. pTrunk = 0;
  59802. TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
  59803. #endif
  59804. }else if( k>0 ){
  59805. /* Extract a leaf from the trunk */
  59806. u32 closest;
  59807. Pgno iPage;
  59808. unsigned char *aData = pTrunk->aData;
  59809. if( nearby>0 ){
  59810. u32 i;
  59811. closest = 0;
  59812. if( eMode==BTALLOC_LE ){
  59813. for(i=0; i<k; i++){
  59814. iPage = get4byte(&aData[8+i*4]);
  59815. if( iPage<=nearby ){
  59816. closest = i;
  59817. break;
  59818. }
  59819. }
  59820. }else{
  59821. int dist;
  59822. dist = sqlite3AbsInt32(get4byte(&aData[8]) - nearby);
  59823. for(i=1; i<k; i++){
  59824. int d2 = sqlite3AbsInt32(get4byte(&aData[8+i*4]) - nearby);
  59825. if( d2<dist ){
  59826. closest = i;
  59827. dist = d2;
  59828. }
  59829. }
  59830. }
  59831. }else{
  59832. closest = 0;
  59833. }
  59834. iPage = get4byte(&aData[8+closest*4]);
  59835. testcase( iPage==mxPage );
  59836. if( iPage>mxPage ){
  59837. rc = SQLITE_CORRUPT_BKPT;
  59838. goto end_allocate_page;
  59839. }
  59840. testcase( iPage==mxPage );
  59841. if( !searchList
  59842. || (iPage==nearby || (iPage<nearby && eMode==BTALLOC_LE))
  59843. ){
  59844. int noContent;
  59845. *pPgno = iPage;
  59846. TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
  59847. ": %d more free pages\n",
  59848. *pPgno, closest+1, k, pTrunk->pgno, n-1));
  59849. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  59850. if( rc ) goto end_allocate_page;
  59851. if( closest<k-1 ){
  59852. memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
  59853. }
  59854. put4byte(&aData[4], k-1);
  59855. noContent = !btreeGetHasContent(pBt, *pPgno)? PAGER_GET_NOCONTENT : 0;
  59856. rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, noContent);
  59857. if( rc==SQLITE_OK ){
  59858. rc = sqlite3PagerWrite((*ppPage)->pDbPage);
  59859. if( rc!=SQLITE_OK ){
  59860. releasePage(*ppPage);
  59861. *ppPage = 0;
  59862. }
  59863. }
  59864. searchList = 0;
  59865. }
  59866. }
  59867. releasePage(pPrevTrunk);
  59868. pPrevTrunk = 0;
  59869. }while( searchList );
  59870. }else{
  59871. /* There are no pages on the freelist, so append a new page to the
  59872. ** database image.
  59873. **
  59874. ** Normally, new pages allocated by this block can be requested from the
  59875. ** pager layer with the 'no-content' flag set. This prevents the pager
  59876. ** from trying to read the pages content from disk. However, if the
  59877. ** current transaction has already run one or more incremental-vacuum
  59878. ** steps, then the page we are about to allocate may contain content
  59879. ** that is required in the event of a rollback. In this case, do
  59880. ** not set the no-content flag. This causes the pager to load and journal
  59881. ** the current page content before overwriting it.
  59882. **
  59883. ** Note that the pager will not actually attempt to load or journal
  59884. ** content for any page that really does lie past the end of the database
  59885. ** file on disk. So the effects of disabling the no-content optimization
  59886. ** here are confined to those pages that lie between the end of the
  59887. ** database image and the end of the database file.
  59888. */
  59889. int bNoContent = (0==IfNotOmitAV(pBt->bDoTruncate))? PAGER_GET_NOCONTENT:0;
  59890. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  59891. if( rc ) return rc;
  59892. pBt->nPage++;
  59893. if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ) pBt->nPage++;
  59894. #ifndef SQLITE_OMIT_AUTOVACUUM
  59895. if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, pBt->nPage) ){
  59896. /* If *pPgno refers to a pointer-map page, allocate two new pages
  59897. ** at the end of the file instead of one. The first allocated page
  59898. ** becomes a new pointer-map page, the second is used by the caller.
  59899. */
  59900. MemPage *pPg = 0;
  59901. TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", pBt->nPage));
  59902. assert( pBt->nPage!=PENDING_BYTE_PAGE(pBt) );
  59903. rc = btreeGetUnusedPage(pBt, pBt->nPage, &pPg, bNoContent);
  59904. if( rc==SQLITE_OK ){
  59905. rc = sqlite3PagerWrite(pPg->pDbPage);
  59906. releasePage(pPg);
  59907. }
  59908. if( rc ) return rc;
  59909. pBt->nPage++;
  59910. if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ){ pBt->nPage++; }
  59911. }
  59912. #endif
  59913. put4byte(28 + (u8*)pBt->pPage1->aData, pBt->nPage);
  59914. *pPgno = pBt->nPage;
  59915. assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
  59916. rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, bNoContent);
  59917. if( rc ) return rc;
  59918. rc = sqlite3PagerWrite((*ppPage)->pDbPage);
  59919. if( rc!=SQLITE_OK ){
  59920. releasePage(*ppPage);
  59921. *ppPage = 0;
  59922. }
  59923. TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
  59924. }
  59925. assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
  59926. end_allocate_page:
  59927. releasePage(pTrunk);
  59928. releasePage(pPrevTrunk);
  59929. assert( rc!=SQLITE_OK || sqlite3PagerPageRefcount((*ppPage)->pDbPage)<=1 );
  59930. assert( rc!=SQLITE_OK || (*ppPage)->isInit==0 );
  59931. return rc;
  59932. }
  59933. /*
  59934. ** This function is used to add page iPage to the database file free-list.
  59935. ** It is assumed that the page is not already a part of the free-list.
  59936. **
  59937. ** The value passed as the second argument to this function is optional.
  59938. ** If the caller happens to have a pointer to the MemPage object
  59939. ** corresponding to page iPage handy, it may pass it as the second value.
  59940. ** Otherwise, it may pass NULL.
  59941. **
  59942. ** If a pointer to a MemPage object is passed as the second argument,
  59943. ** its reference count is not altered by this function.
  59944. */
  59945. static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
  59946. MemPage *pTrunk = 0; /* Free-list trunk page */
  59947. Pgno iTrunk = 0; /* Page number of free-list trunk page */
  59948. MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
  59949. MemPage *pPage; /* Page being freed. May be NULL. */
  59950. int rc; /* Return Code */
  59951. int nFree; /* Initial number of pages on free-list */
  59952. assert( sqlite3_mutex_held(pBt->mutex) );
  59953. assert( CORRUPT_DB || iPage>1 );
  59954. assert( !pMemPage || pMemPage->pgno==iPage );
  59955. if( iPage<2 ) return SQLITE_CORRUPT_BKPT;
  59956. if( pMemPage ){
  59957. pPage = pMemPage;
  59958. sqlite3PagerRef(pPage->pDbPage);
  59959. }else{
  59960. pPage = btreePageLookup(pBt, iPage);
  59961. }
  59962. /* Increment the free page count on pPage1 */
  59963. rc = sqlite3PagerWrite(pPage1->pDbPage);
  59964. if( rc ) goto freepage_out;
  59965. nFree = get4byte(&pPage1->aData[36]);
  59966. put4byte(&pPage1->aData[36], nFree+1);
  59967. if( pBt->btsFlags & BTS_SECURE_DELETE ){
  59968. /* If the secure_delete option is enabled, then
  59969. ** always fully overwrite deleted information with zeros.
  59970. */
  59971. if( (!pPage && ((rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0) )
  59972. || ((rc = sqlite3PagerWrite(pPage->pDbPage))!=0)
  59973. ){
  59974. goto freepage_out;
  59975. }
  59976. memset(pPage->aData, 0, pPage->pBt->pageSize);
  59977. }
  59978. /* If the database supports auto-vacuum, write an entry in the pointer-map
  59979. ** to indicate that the page is free.
  59980. */
  59981. if( ISAUTOVACUUM ){
  59982. ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0, &rc);
  59983. if( rc ) goto freepage_out;
  59984. }
  59985. /* Now manipulate the actual database free-list structure. There are two
  59986. ** possibilities. If the free-list is currently empty, or if the first
  59987. ** trunk page in the free-list is full, then this page will become a
  59988. ** new free-list trunk page. Otherwise, it will become a leaf of the
  59989. ** first trunk page in the current free-list. This block tests if it
  59990. ** is possible to add the page as a new free-list leaf.
  59991. */
  59992. if( nFree!=0 ){
  59993. u32 nLeaf; /* Initial number of leaf cells on trunk page */
  59994. iTrunk = get4byte(&pPage1->aData[32]);
  59995. rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
  59996. if( rc!=SQLITE_OK ){
  59997. goto freepage_out;
  59998. }
  59999. nLeaf = get4byte(&pTrunk->aData[4]);
  60000. assert( pBt->usableSize>32 );
  60001. if( nLeaf > (u32)pBt->usableSize/4 - 2 ){
  60002. rc = SQLITE_CORRUPT_BKPT;
  60003. goto freepage_out;
  60004. }
  60005. if( nLeaf < (u32)pBt->usableSize/4 - 8 ){
  60006. /* In this case there is room on the trunk page to insert the page
  60007. ** being freed as a new leaf.
  60008. **
  60009. ** Note that the trunk page is not really full until it contains
  60010. ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
  60011. ** coded. But due to a coding error in versions of SQLite prior to
  60012. ** 3.6.0, databases with freelist trunk pages holding more than
  60013. ** usableSize/4 - 8 entries will be reported as corrupt. In order
  60014. ** to maintain backwards compatibility with older versions of SQLite,
  60015. ** we will continue to restrict the number of entries to usableSize/4 - 8
  60016. ** for now. At some point in the future (once everyone has upgraded
  60017. ** to 3.6.0 or later) we should consider fixing the conditional above
  60018. ** to read "usableSize/4-2" instead of "usableSize/4-8".
  60019. **
  60020. ** EVIDENCE-OF: R-19920-11576 However, newer versions of SQLite still
  60021. ** avoid using the last six entries in the freelist trunk page array in
  60022. ** order that database files created by newer versions of SQLite can be
  60023. ** read by older versions of SQLite.
  60024. */
  60025. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  60026. if( rc==SQLITE_OK ){
  60027. put4byte(&pTrunk->aData[4], nLeaf+1);
  60028. put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
  60029. if( pPage && (pBt->btsFlags & BTS_SECURE_DELETE)==0 ){
  60030. sqlite3PagerDontWrite(pPage->pDbPage);
  60031. }
  60032. rc = btreeSetHasContent(pBt, iPage);
  60033. }
  60034. TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
  60035. goto freepage_out;
  60036. }
  60037. }
  60038. /* If control flows to this point, then it was not possible to add the
  60039. ** the page being freed as a leaf page of the first trunk in the free-list.
  60040. ** Possibly because the free-list is empty, or possibly because the
  60041. ** first trunk in the free-list is full. Either way, the page being freed
  60042. ** will become the new first trunk page in the free-list.
  60043. */
  60044. if( pPage==0 && SQLITE_OK!=(rc = btreeGetPage(pBt, iPage, &pPage, 0)) ){
  60045. goto freepage_out;
  60046. }
  60047. rc = sqlite3PagerWrite(pPage->pDbPage);
  60048. if( rc!=SQLITE_OK ){
  60049. goto freepage_out;
  60050. }
  60051. put4byte(pPage->aData, iTrunk);
  60052. put4byte(&pPage->aData[4], 0);
  60053. put4byte(&pPage1->aData[32], iPage);
  60054. TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
  60055. freepage_out:
  60056. if( pPage ){
  60057. pPage->isInit = 0;
  60058. }
  60059. releasePage(pPage);
  60060. releasePage(pTrunk);
  60061. return rc;
  60062. }
  60063. static void freePage(MemPage *pPage, int *pRC){
  60064. if( (*pRC)==SQLITE_OK ){
  60065. *pRC = freePage2(pPage->pBt, pPage, pPage->pgno);
  60066. }
  60067. }
  60068. /*
  60069. ** Free any overflow pages associated with the given Cell. Write the
  60070. ** local Cell size (the number of bytes on the original page, omitting
  60071. ** overflow) into *pnSize.
  60072. */
  60073. static int clearCell(
  60074. MemPage *pPage, /* The page that contains the Cell */
  60075. unsigned char *pCell, /* First byte of the Cell */
  60076. u16 *pnSize /* Write the size of the Cell here */
  60077. ){
  60078. BtShared *pBt = pPage->pBt;
  60079. CellInfo info;
  60080. Pgno ovflPgno;
  60081. int rc;
  60082. int nOvfl;
  60083. u32 ovflPageSize;
  60084. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60085. pPage->xParseCell(pPage, pCell, &info);
  60086. *pnSize = info.nSize;
  60087. if( info.nLocal==info.nPayload ){
  60088. return SQLITE_OK; /* No overflow pages. Return without doing anything */
  60089. }
  60090. if( pCell+info.nSize-1 > pPage->aData+pPage->maskPage ){
  60091. return SQLITE_CORRUPT_BKPT; /* Cell extends past end of page */
  60092. }
  60093. ovflPgno = get4byte(pCell + info.nSize - 4);
  60094. assert( pBt->usableSize > 4 );
  60095. ovflPageSize = pBt->usableSize - 4;
  60096. nOvfl = (info.nPayload - info.nLocal + ovflPageSize - 1)/ovflPageSize;
  60097. assert( nOvfl>0 ||
  60098. (CORRUPT_DB && (info.nPayload + ovflPageSize)<ovflPageSize)
  60099. );
  60100. while( nOvfl-- ){
  60101. Pgno iNext = 0;
  60102. MemPage *pOvfl = 0;
  60103. if( ovflPgno<2 || ovflPgno>btreePagecount(pBt) ){
  60104. /* 0 is not a legal page number and page 1 cannot be an
  60105. ** overflow page. Therefore if ovflPgno<2 or past the end of the
  60106. ** file the database must be corrupt. */
  60107. return SQLITE_CORRUPT_BKPT;
  60108. }
  60109. if( nOvfl ){
  60110. rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
  60111. if( rc ) return rc;
  60112. }
  60113. if( ( pOvfl || ((pOvfl = btreePageLookup(pBt, ovflPgno))!=0) )
  60114. && sqlite3PagerPageRefcount(pOvfl->pDbPage)!=1
  60115. ){
  60116. /* There is no reason any cursor should have an outstanding reference
  60117. ** to an overflow page belonging to a cell that is being deleted/updated.
  60118. ** So if there exists more than one reference to this page, then it
  60119. ** must not really be an overflow page and the database must be corrupt.
  60120. ** It is helpful to detect this before calling freePage2(), as
  60121. ** freePage2() may zero the page contents if secure-delete mode is
  60122. ** enabled. If this 'overflow' page happens to be a page that the
  60123. ** caller is iterating through or using in some other way, this
  60124. ** can be problematic.
  60125. */
  60126. rc = SQLITE_CORRUPT_BKPT;
  60127. }else{
  60128. rc = freePage2(pBt, pOvfl, ovflPgno);
  60129. }
  60130. if( pOvfl ){
  60131. sqlite3PagerUnref(pOvfl->pDbPage);
  60132. }
  60133. if( rc ) return rc;
  60134. ovflPgno = iNext;
  60135. }
  60136. return SQLITE_OK;
  60137. }
  60138. /*
  60139. ** Create the byte sequence used to represent a cell on page pPage
  60140. ** and write that byte sequence into pCell[]. Overflow pages are
  60141. ** allocated and filled in as necessary. The calling procedure
  60142. ** is responsible for making sure sufficient space has been allocated
  60143. ** for pCell[].
  60144. **
  60145. ** Note that pCell does not necessary need to point to the pPage->aData
  60146. ** area. pCell might point to some temporary storage. The cell will
  60147. ** be constructed in this temporary area then copied into pPage->aData
  60148. ** later.
  60149. */
  60150. static int fillInCell(
  60151. MemPage *pPage, /* The page that contains the cell */
  60152. unsigned char *pCell, /* Complete text of the cell */
  60153. const BtreePayload *pX, /* Payload with which to construct the cell */
  60154. int *pnSize /* Write cell size here */
  60155. ){
  60156. int nPayload;
  60157. const u8 *pSrc;
  60158. int nSrc, n, rc;
  60159. int spaceLeft;
  60160. MemPage *pOvfl = 0;
  60161. MemPage *pToRelease = 0;
  60162. unsigned char *pPrior;
  60163. unsigned char *pPayload;
  60164. BtShared *pBt = pPage->pBt;
  60165. Pgno pgnoOvfl = 0;
  60166. int nHeader;
  60167. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60168. /* pPage is not necessarily writeable since pCell might be auxiliary
  60169. ** buffer space that is separate from the pPage buffer area */
  60170. assert( pCell<pPage->aData || pCell>=&pPage->aData[pBt->pageSize]
  60171. || sqlite3PagerIswriteable(pPage->pDbPage) );
  60172. /* Fill in the header. */
  60173. nHeader = pPage->childPtrSize;
  60174. if( pPage->intKey ){
  60175. nPayload = pX->nData + pX->nZero;
  60176. pSrc = pX->pData;
  60177. nSrc = pX->nData;
  60178. assert( pPage->intKeyLeaf ); /* fillInCell() only called for leaves */
  60179. nHeader += putVarint32(&pCell[nHeader], nPayload);
  60180. nHeader += putVarint(&pCell[nHeader], *(u64*)&pX->nKey);
  60181. }else{
  60182. assert( pX->nKey<=0x7fffffff && pX->pKey!=0 );
  60183. nSrc = nPayload = (int)pX->nKey;
  60184. pSrc = pX->pKey;
  60185. nHeader += putVarint32(&pCell[nHeader], nPayload);
  60186. }
  60187. /* Fill in the payload */
  60188. if( nPayload<=pPage->maxLocal ){
  60189. n = nHeader + nPayload;
  60190. testcase( n==3 );
  60191. testcase( n==4 );
  60192. if( n<4 ) n = 4;
  60193. *pnSize = n;
  60194. spaceLeft = nPayload;
  60195. pPrior = pCell;
  60196. }else{
  60197. int mn = pPage->minLocal;
  60198. n = mn + (nPayload - mn) % (pPage->pBt->usableSize - 4);
  60199. testcase( n==pPage->maxLocal );
  60200. testcase( n==pPage->maxLocal+1 );
  60201. if( n > pPage->maxLocal ) n = mn;
  60202. spaceLeft = n;
  60203. *pnSize = n + nHeader + 4;
  60204. pPrior = &pCell[nHeader+n];
  60205. }
  60206. pPayload = &pCell[nHeader];
  60207. /* At this point variables should be set as follows:
  60208. **
  60209. ** nPayload Total payload size in bytes
  60210. ** pPayload Begin writing payload here
  60211. ** spaceLeft Space available at pPayload. If nPayload>spaceLeft,
  60212. ** that means content must spill into overflow pages.
  60213. ** *pnSize Size of the local cell (not counting overflow pages)
  60214. ** pPrior Where to write the pgno of the first overflow page
  60215. **
  60216. ** Use a call to btreeParseCellPtr() to verify that the values above
  60217. ** were computed correctly.
  60218. */
  60219. #if SQLITE_DEBUG
  60220. {
  60221. CellInfo info;
  60222. pPage->xParseCell(pPage, pCell, &info);
  60223. assert( nHeader==(int)(info.pPayload - pCell) );
  60224. assert( info.nKey==pX->nKey );
  60225. assert( *pnSize == info.nSize );
  60226. assert( spaceLeft == info.nLocal );
  60227. }
  60228. #endif
  60229. /* Write the payload into the local Cell and any extra into overflow pages */
  60230. while( nPayload>0 ){
  60231. if( spaceLeft==0 ){
  60232. #ifndef SQLITE_OMIT_AUTOVACUUM
  60233. Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
  60234. if( pBt->autoVacuum ){
  60235. do{
  60236. pgnoOvfl++;
  60237. } while(
  60238. PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
  60239. );
  60240. }
  60241. #endif
  60242. rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
  60243. #ifndef SQLITE_OMIT_AUTOVACUUM
  60244. /* If the database supports auto-vacuum, and the second or subsequent
  60245. ** overflow page is being allocated, add an entry to the pointer-map
  60246. ** for that page now.
  60247. **
  60248. ** If this is the first overflow page, then write a partial entry
  60249. ** to the pointer-map. If we write nothing to this pointer-map slot,
  60250. ** then the optimistic overflow chain processing in clearCell()
  60251. ** may misinterpret the uninitialized values and delete the
  60252. ** wrong pages from the database.
  60253. */
  60254. if( pBt->autoVacuum && rc==SQLITE_OK ){
  60255. u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
  60256. ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap, &rc);
  60257. if( rc ){
  60258. releasePage(pOvfl);
  60259. }
  60260. }
  60261. #endif
  60262. if( rc ){
  60263. releasePage(pToRelease);
  60264. return rc;
  60265. }
  60266. /* If pToRelease is not zero than pPrior points into the data area
  60267. ** of pToRelease. Make sure pToRelease is still writeable. */
  60268. assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
  60269. /* If pPrior is part of the data area of pPage, then make sure pPage
  60270. ** is still writeable */
  60271. assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
  60272. || sqlite3PagerIswriteable(pPage->pDbPage) );
  60273. put4byte(pPrior, pgnoOvfl);
  60274. releasePage(pToRelease);
  60275. pToRelease = pOvfl;
  60276. pPrior = pOvfl->aData;
  60277. put4byte(pPrior, 0);
  60278. pPayload = &pOvfl->aData[4];
  60279. spaceLeft = pBt->usableSize - 4;
  60280. }
  60281. n = nPayload;
  60282. if( n>spaceLeft ) n = spaceLeft;
  60283. /* If pToRelease is not zero than pPayload points into the data area
  60284. ** of pToRelease. Make sure pToRelease is still writeable. */
  60285. assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
  60286. /* If pPayload is part of the data area of pPage, then make sure pPage
  60287. ** is still writeable */
  60288. assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
  60289. || sqlite3PagerIswriteable(pPage->pDbPage) );
  60290. if( nSrc>0 ){
  60291. if( n>nSrc ) n = nSrc;
  60292. assert( pSrc );
  60293. memcpy(pPayload, pSrc, n);
  60294. }else{
  60295. memset(pPayload, 0, n);
  60296. }
  60297. nPayload -= n;
  60298. pPayload += n;
  60299. pSrc += n;
  60300. nSrc -= n;
  60301. spaceLeft -= n;
  60302. }
  60303. releasePage(pToRelease);
  60304. return SQLITE_OK;
  60305. }
  60306. /*
  60307. ** Remove the i-th cell from pPage. This routine effects pPage only.
  60308. ** The cell content is not freed or deallocated. It is assumed that
  60309. ** the cell content has been copied someplace else. This routine just
  60310. ** removes the reference to the cell from pPage.
  60311. **
  60312. ** "sz" must be the number of bytes in the cell.
  60313. */
  60314. static void dropCell(MemPage *pPage, int idx, int sz, int *pRC){
  60315. u32 pc; /* Offset to cell content of cell being deleted */
  60316. u8 *data; /* pPage->aData */
  60317. u8 *ptr; /* Used to move bytes around within data[] */
  60318. int rc; /* The return code */
  60319. int hdr; /* Beginning of the header. 0 most pages. 100 page 1 */
  60320. if( *pRC ) return;
  60321. assert( idx>=0 && idx<pPage->nCell );
  60322. assert( CORRUPT_DB || sz==cellSize(pPage, idx) );
  60323. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  60324. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60325. data = pPage->aData;
  60326. ptr = &pPage->aCellIdx[2*idx];
  60327. pc = get2byte(ptr);
  60328. hdr = pPage->hdrOffset;
  60329. testcase( pc==get2byte(&data[hdr+5]) );
  60330. testcase( pc+sz==pPage->pBt->usableSize );
  60331. if( pc < (u32)get2byte(&data[hdr+5]) || pc+sz > pPage->pBt->usableSize ){
  60332. *pRC = SQLITE_CORRUPT_BKPT;
  60333. return;
  60334. }
  60335. rc = freeSpace(pPage, pc, sz);
  60336. if( rc ){
  60337. *pRC = rc;
  60338. return;
  60339. }
  60340. pPage->nCell--;
  60341. if( pPage->nCell==0 ){
  60342. memset(&data[hdr+1], 0, 4);
  60343. data[hdr+7] = 0;
  60344. put2byte(&data[hdr+5], pPage->pBt->usableSize);
  60345. pPage->nFree = pPage->pBt->usableSize - pPage->hdrOffset
  60346. - pPage->childPtrSize - 8;
  60347. }else{
  60348. memmove(ptr, ptr+2, 2*(pPage->nCell - idx));
  60349. put2byte(&data[hdr+3], pPage->nCell);
  60350. pPage->nFree += 2;
  60351. }
  60352. }
  60353. /*
  60354. ** Insert a new cell on pPage at cell index "i". pCell points to the
  60355. ** content of the cell.
  60356. **
  60357. ** If the cell content will fit on the page, then put it there. If it
  60358. ** will not fit, then make a copy of the cell content into pTemp if
  60359. ** pTemp is not null. Regardless of pTemp, allocate a new entry
  60360. ** in pPage->apOvfl[] and make it point to the cell content (either
  60361. ** in pTemp or the original pCell) and also record its index.
  60362. ** Allocating a new entry in pPage->aCell[] implies that
  60363. ** pPage->nOverflow is incremented.
  60364. **
  60365. ** *pRC must be SQLITE_OK when this routine is called.
  60366. */
  60367. static void insertCell(
  60368. MemPage *pPage, /* Page into which we are copying */
  60369. int i, /* New cell becomes the i-th cell of the page */
  60370. u8 *pCell, /* Content of the new cell */
  60371. int sz, /* Bytes of content in pCell */
  60372. u8 *pTemp, /* Temp storage space for pCell, if needed */
  60373. Pgno iChild, /* If non-zero, replace first 4 bytes with this value */
  60374. int *pRC /* Read and write return code from here */
  60375. ){
  60376. int idx = 0; /* Where to write new cell content in data[] */
  60377. int j; /* Loop counter */
  60378. u8 *data; /* The content of the whole page */
  60379. u8 *pIns; /* The point in pPage->aCellIdx[] where no cell inserted */
  60380. assert( *pRC==SQLITE_OK );
  60381. assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
  60382. assert( MX_CELL(pPage->pBt)<=10921 );
  60383. assert( pPage->nCell<=MX_CELL(pPage->pBt) || CORRUPT_DB );
  60384. assert( pPage->nOverflow<=ArraySize(pPage->apOvfl) );
  60385. assert( ArraySize(pPage->apOvfl)==ArraySize(pPage->aiOvfl) );
  60386. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60387. /* The cell should normally be sized correctly. However, when moving a
  60388. ** malformed cell from a leaf page to an interior page, if the cell size
  60389. ** wanted to be less than 4 but got rounded up to 4 on the leaf, then size
  60390. ** might be less than 8 (leaf-size + pointer) on the interior node. Hence
  60391. ** the term after the || in the following assert(). */
  60392. assert( sz==pPage->xCellSize(pPage, pCell) || (sz==8 && iChild>0) );
  60393. if( pPage->nOverflow || sz+2>pPage->nFree ){
  60394. if( pTemp ){
  60395. memcpy(pTemp, pCell, sz);
  60396. pCell = pTemp;
  60397. }
  60398. if( iChild ){
  60399. put4byte(pCell, iChild);
  60400. }
  60401. j = pPage->nOverflow++;
  60402. assert( j<(int)(sizeof(pPage->apOvfl)/sizeof(pPage->apOvfl[0])) );
  60403. pPage->apOvfl[j] = pCell;
  60404. pPage->aiOvfl[j] = (u16)i;
  60405. /* When multiple overflows occur, they are always sequential and in
  60406. ** sorted order. This invariants arise because multiple overflows can
  60407. ** only occur when inserting divider cells into the parent page during
  60408. ** balancing, and the dividers are adjacent and sorted.
  60409. */
  60410. assert( j==0 || pPage->aiOvfl[j-1]<(u16)i ); /* Overflows in sorted order */
  60411. assert( j==0 || i==pPage->aiOvfl[j-1]+1 ); /* Overflows are sequential */
  60412. }else{
  60413. int rc = sqlite3PagerWrite(pPage->pDbPage);
  60414. if( rc!=SQLITE_OK ){
  60415. *pRC = rc;
  60416. return;
  60417. }
  60418. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  60419. data = pPage->aData;
  60420. assert( &data[pPage->cellOffset]==pPage->aCellIdx );
  60421. rc = allocateSpace(pPage, sz, &idx);
  60422. if( rc ){ *pRC = rc; return; }
  60423. /* The allocateSpace() routine guarantees the following properties
  60424. ** if it returns successfully */
  60425. assert( idx >= 0 );
  60426. assert( idx >= pPage->cellOffset+2*pPage->nCell+2 || CORRUPT_DB );
  60427. assert( idx+sz <= (int)pPage->pBt->usableSize );
  60428. pPage->nFree -= (u16)(2 + sz);
  60429. memcpy(&data[idx], pCell, sz);
  60430. if( iChild ){
  60431. put4byte(&data[idx], iChild);
  60432. }
  60433. pIns = pPage->aCellIdx + i*2;
  60434. memmove(pIns+2, pIns, 2*(pPage->nCell - i));
  60435. put2byte(pIns, idx);
  60436. pPage->nCell++;
  60437. /* increment the cell count */
  60438. if( (++data[pPage->hdrOffset+4])==0 ) data[pPage->hdrOffset+3]++;
  60439. assert( get2byte(&data[pPage->hdrOffset+3])==pPage->nCell );
  60440. #ifndef SQLITE_OMIT_AUTOVACUUM
  60441. if( pPage->pBt->autoVacuum ){
  60442. /* The cell may contain a pointer to an overflow page. If so, write
  60443. ** the entry for the overflow page into the pointer map.
  60444. */
  60445. ptrmapPutOvflPtr(pPage, pCell, pRC);
  60446. }
  60447. #endif
  60448. }
  60449. }
  60450. /*
  60451. ** A CellArray object contains a cache of pointers and sizes for a
  60452. ** consecutive sequence of cells that might be held on multiple pages.
  60453. */
  60454. typedef struct CellArray CellArray;
  60455. struct CellArray {
  60456. int nCell; /* Number of cells in apCell[] */
  60457. MemPage *pRef; /* Reference page */
  60458. u8 **apCell; /* All cells begin balanced */
  60459. u16 *szCell; /* Local size of all cells in apCell[] */
  60460. };
  60461. /*
  60462. ** Make sure the cell sizes at idx, idx+1, ..., idx+N-1 have been
  60463. ** computed.
  60464. */
  60465. static void populateCellCache(CellArray *p, int idx, int N){
  60466. assert( idx>=0 && idx+N<=p->nCell );
  60467. while( N>0 ){
  60468. assert( p->apCell[idx]!=0 );
  60469. if( p->szCell[idx]==0 ){
  60470. p->szCell[idx] = p->pRef->xCellSize(p->pRef, p->apCell[idx]);
  60471. }else{
  60472. assert( CORRUPT_DB ||
  60473. p->szCell[idx]==p->pRef->xCellSize(p->pRef, p->apCell[idx]) );
  60474. }
  60475. idx++;
  60476. N--;
  60477. }
  60478. }
  60479. /*
  60480. ** Return the size of the Nth element of the cell array
  60481. */
  60482. static SQLITE_NOINLINE u16 computeCellSize(CellArray *p, int N){
  60483. assert( N>=0 && N<p->nCell );
  60484. assert( p->szCell[N]==0 );
  60485. p->szCell[N] = p->pRef->xCellSize(p->pRef, p->apCell[N]);
  60486. return p->szCell[N];
  60487. }
  60488. static u16 cachedCellSize(CellArray *p, int N){
  60489. assert( N>=0 && N<p->nCell );
  60490. if( p->szCell[N] ) return p->szCell[N];
  60491. return computeCellSize(p, N);
  60492. }
  60493. /*
  60494. ** Array apCell[] contains pointers to nCell b-tree page cells. The
  60495. ** szCell[] array contains the size in bytes of each cell. This function
  60496. ** replaces the current contents of page pPg with the contents of the cell
  60497. ** array.
  60498. **
  60499. ** Some of the cells in apCell[] may currently be stored in pPg. This
  60500. ** function works around problems caused by this by making a copy of any
  60501. ** such cells before overwriting the page data.
  60502. **
  60503. ** The MemPage.nFree field is invalidated by this function. It is the
  60504. ** responsibility of the caller to set it correctly.
  60505. */
  60506. static int rebuildPage(
  60507. MemPage *pPg, /* Edit this page */
  60508. int nCell, /* Final number of cells on page */
  60509. u8 **apCell, /* Array of cells */
  60510. u16 *szCell /* Array of cell sizes */
  60511. ){
  60512. const int hdr = pPg->hdrOffset; /* Offset of header on pPg */
  60513. u8 * const aData = pPg->aData; /* Pointer to data for pPg */
  60514. const int usableSize = pPg->pBt->usableSize;
  60515. u8 * const pEnd = &aData[usableSize];
  60516. int i;
  60517. u8 *pCellptr = pPg->aCellIdx;
  60518. u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
  60519. u8 *pData;
  60520. i = get2byte(&aData[hdr+5]);
  60521. memcpy(&pTmp[i], &aData[i], usableSize - i);
  60522. pData = pEnd;
  60523. for(i=0; i<nCell; i++){
  60524. u8 *pCell = apCell[i];
  60525. if( SQLITE_WITHIN(pCell,aData,pEnd) ){
  60526. pCell = &pTmp[pCell - aData];
  60527. }
  60528. pData -= szCell[i];
  60529. put2byte(pCellptr, (pData - aData));
  60530. pCellptr += 2;
  60531. if( pData < pCellptr ) return SQLITE_CORRUPT_BKPT;
  60532. memcpy(pData, pCell, szCell[i]);
  60533. assert( szCell[i]==pPg->xCellSize(pPg, pCell) || CORRUPT_DB );
  60534. testcase( szCell[i]!=pPg->xCellSize(pPg,pCell) );
  60535. }
  60536. /* The pPg->nFree field is now set incorrectly. The caller will fix it. */
  60537. pPg->nCell = nCell;
  60538. pPg->nOverflow = 0;
  60539. put2byte(&aData[hdr+1], 0);
  60540. put2byte(&aData[hdr+3], pPg->nCell);
  60541. put2byte(&aData[hdr+5], pData - aData);
  60542. aData[hdr+7] = 0x00;
  60543. return SQLITE_OK;
  60544. }
  60545. /*
  60546. ** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
  60547. ** contains the size in bytes of each such cell. This function attempts to
  60548. ** add the cells stored in the array to page pPg. If it cannot (because
  60549. ** the page needs to be defragmented before the cells will fit), non-zero
  60550. ** is returned. Otherwise, if the cells are added successfully, zero is
  60551. ** returned.
  60552. **
  60553. ** Argument pCellptr points to the first entry in the cell-pointer array
  60554. ** (part of page pPg) to populate. After cell apCell[0] is written to the
  60555. ** page body, a 16-bit offset is written to pCellptr. And so on, for each
  60556. ** cell in the array. It is the responsibility of the caller to ensure
  60557. ** that it is safe to overwrite this part of the cell-pointer array.
  60558. **
  60559. ** When this function is called, *ppData points to the start of the
  60560. ** content area on page pPg. If the size of the content area is extended,
  60561. ** *ppData is updated to point to the new start of the content area
  60562. ** before returning.
  60563. **
  60564. ** Finally, argument pBegin points to the byte immediately following the
  60565. ** end of the space required by this page for the cell-pointer area (for
  60566. ** all cells - not just those inserted by the current call). If the content
  60567. ** area must be extended to before this point in order to accomodate all
  60568. ** cells in apCell[], then the cells do not fit and non-zero is returned.
  60569. */
  60570. static int pageInsertArray(
  60571. MemPage *pPg, /* Page to add cells to */
  60572. u8 *pBegin, /* End of cell-pointer array */
  60573. u8 **ppData, /* IN/OUT: Page content -area pointer */
  60574. u8 *pCellptr, /* Pointer to cell-pointer area */
  60575. int iFirst, /* Index of first cell to add */
  60576. int nCell, /* Number of cells to add to pPg */
  60577. CellArray *pCArray /* Array of cells */
  60578. ){
  60579. int i;
  60580. u8 *aData = pPg->aData;
  60581. u8 *pData = *ppData;
  60582. int iEnd = iFirst + nCell;
  60583. assert( CORRUPT_DB || pPg->hdrOffset==0 ); /* Never called on page 1 */
  60584. for(i=iFirst; i<iEnd; i++){
  60585. int sz, rc;
  60586. u8 *pSlot;
  60587. sz = cachedCellSize(pCArray, i);
  60588. if( (aData[1]==0 && aData[2]==0) || (pSlot = pageFindSlot(pPg,sz,&rc))==0 ){
  60589. if( (pData - pBegin)<sz ) return 1;
  60590. pData -= sz;
  60591. pSlot = pData;
  60592. }
  60593. /* pSlot and pCArray->apCell[i] will never overlap on a well-formed
  60594. ** database. But they might for a corrupt database. Hence use memmove()
  60595. ** since memcpy() sends SIGABORT with overlapping buffers on OpenBSD */
  60596. assert( (pSlot+sz)<=pCArray->apCell[i]
  60597. || pSlot>=(pCArray->apCell[i]+sz)
  60598. || CORRUPT_DB );
  60599. memmove(pSlot, pCArray->apCell[i], sz);
  60600. put2byte(pCellptr, (pSlot - aData));
  60601. pCellptr += 2;
  60602. }
  60603. *ppData = pData;
  60604. return 0;
  60605. }
  60606. /*
  60607. ** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
  60608. ** contains the size in bytes of each such cell. This function adds the
  60609. ** space associated with each cell in the array that is currently stored
  60610. ** within the body of pPg to the pPg free-list. The cell-pointers and other
  60611. ** fields of the page are not updated.
  60612. **
  60613. ** This function returns the total number of cells added to the free-list.
  60614. */
  60615. static int pageFreeArray(
  60616. MemPage *pPg, /* Page to edit */
  60617. int iFirst, /* First cell to delete */
  60618. int nCell, /* Cells to delete */
  60619. CellArray *pCArray /* Array of cells */
  60620. ){
  60621. u8 * const aData = pPg->aData;
  60622. u8 * const pEnd = &aData[pPg->pBt->usableSize];
  60623. u8 * const pStart = &aData[pPg->hdrOffset + 8 + pPg->childPtrSize];
  60624. int nRet = 0;
  60625. int i;
  60626. int iEnd = iFirst + nCell;
  60627. u8 *pFree = 0;
  60628. int szFree = 0;
  60629. for(i=iFirst; i<iEnd; i++){
  60630. u8 *pCell = pCArray->apCell[i];
  60631. if( SQLITE_WITHIN(pCell, pStart, pEnd) ){
  60632. int sz;
  60633. /* No need to use cachedCellSize() here. The sizes of all cells that
  60634. ** are to be freed have already been computing while deciding which
  60635. ** cells need freeing */
  60636. sz = pCArray->szCell[i]; assert( sz>0 );
  60637. if( pFree!=(pCell + sz) ){
  60638. if( pFree ){
  60639. assert( pFree>aData && (pFree - aData)<65536 );
  60640. freeSpace(pPg, (u16)(pFree - aData), szFree);
  60641. }
  60642. pFree = pCell;
  60643. szFree = sz;
  60644. if( pFree+sz>pEnd ) return 0;
  60645. }else{
  60646. pFree = pCell;
  60647. szFree += sz;
  60648. }
  60649. nRet++;
  60650. }
  60651. }
  60652. if( pFree ){
  60653. assert( pFree>aData && (pFree - aData)<65536 );
  60654. freeSpace(pPg, (u16)(pFree - aData), szFree);
  60655. }
  60656. return nRet;
  60657. }
  60658. /*
  60659. ** apCell[] and szCell[] contains pointers to and sizes of all cells in the
  60660. ** pages being balanced. The current page, pPg, has pPg->nCell cells starting
  60661. ** with apCell[iOld]. After balancing, this page should hold nNew cells
  60662. ** starting at apCell[iNew].
  60663. **
  60664. ** This routine makes the necessary adjustments to pPg so that it contains
  60665. ** the correct cells after being balanced.
  60666. **
  60667. ** The pPg->nFree field is invalid when this function returns. It is the
  60668. ** responsibility of the caller to set it correctly.
  60669. */
  60670. static int editPage(
  60671. MemPage *pPg, /* Edit this page */
  60672. int iOld, /* Index of first cell currently on page */
  60673. int iNew, /* Index of new first cell on page */
  60674. int nNew, /* Final number of cells on page */
  60675. CellArray *pCArray /* Array of cells and sizes */
  60676. ){
  60677. u8 * const aData = pPg->aData;
  60678. const int hdr = pPg->hdrOffset;
  60679. u8 *pBegin = &pPg->aCellIdx[nNew * 2];
  60680. int nCell = pPg->nCell; /* Cells stored on pPg */
  60681. u8 *pData;
  60682. u8 *pCellptr;
  60683. int i;
  60684. int iOldEnd = iOld + pPg->nCell + pPg->nOverflow;
  60685. int iNewEnd = iNew + nNew;
  60686. #ifdef SQLITE_DEBUG
  60687. u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
  60688. memcpy(pTmp, aData, pPg->pBt->usableSize);
  60689. #endif
  60690. /* Remove cells from the start and end of the page */
  60691. if( iOld<iNew ){
  60692. int nShift = pageFreeArray(pPg, iOld, iNew-iOld, pCArray);
  60693. memmove(pPg->aCellIdx, &pPg->aCellIdx[nShift*2], nCell*2);
  60694. nCell -= nShift;
  60695. }
  60696. if( iNewEnd < iOldEnd ){
  60697. nCell -= pageFreeArray(pPg, iNewEnd, iOldEnd - iNewEnd, pCArray);
  60698. }
  60699. pData = &aData[get2byteNotZero(&aData[hdr+5])];
  60700. if( pData<pBegin ) goto editpage_fail;
  60701. /* Add cells to the start of the page */
  60702. if( iNew<iOld ){
  60703. int nAdd = MIN(nNew,iOld-iNew);
  60704. assert( (iOld-iNew)<nNew || nCell==0 || CORRUPT_DB );
  60705. pCellptr = pPg->aCellIdx;
  60706. memmove(&pCellptr[nAdd*2], pCellptr, nCell*2);
  60707. if( pageInsertArray(
  60708. pPg, pBegin, &pData, pCellptr,
  60709. iNew, nAdd, pCArray
  60710. ) ) goto editpage_fail;
  60711. nCell += nAdd;
  60712. }
  60713. /* Add any overflow cells */
  60714. for(i=0; i<pPg->nOverflow; i++){
  60715. int iCell = (iOld + pPg->aiOvfl[i]) - iNew;
  60716. if( iCell>=0 && iCell<nNew ){
  60717. pCellptr = &pPg->aCellIdx[iCell * 2];
  60718. memmove(&pCellptr[2], pCellptr, (nCell - iCell) * 2);
  60719. nCell++;
  60720. if( pageInsertArray(
  60721. pPg, pBegin, &pData, pCellptr,
  60722. iCell+iNew, 1, pCArray
  60723. ) ) goto editpage_fail;
  60724. }
  60725. }
  60726. /* Append cells to the end of the page */
  60727. pCellptr = &pPg->aCellIdx[nCell*2];
  60728. if( pageInsertArray(
  60729. pPg, pBegin, &pData, pCellptr,
  60730. iNew+nCell, nNew-nCell, pCArray
  60731. ) ) goto editpage_fail;
  60732. pPg->nCell = nNew;
  60733. pPg->nOverflow = 0;
  60734. put2byte(&aData[hdr+3], pPg->nCell);
  60735. put2byte(&aData[hdr+5], pData - aData);
  60736. #ifdef SQLITE_DEBUG
  60737. for(i=0; i<nNew && !CORRUPT_DB; i++){
  60738. u8 *pCell = pCArray->apCell[i+iNew];
  60739. int iOff = get2byteAligned(&pPg->aCellIdx[i*2]);
  60740. if( SQLITE_WITHIN(pCell, aData, &aData[pPg->pBt->usableSize]) ){
  60741. pCell = &pTmp[pCell - aData];
  60742. }
  60743. assert( 0==memcmp(pCell, &aData[iOff],
  60744. pCArray->pRef->xCellSize(pCArray->pRef, pCArray->apCell[i+iNew])) );
  60745. }
  60746. #endif
  60747. return SQLITE_OK;
  60748. editpage_fail:
  60749. /* Unable to edit this page. Rebuild it from scratch instead. */
  60750. populateCellCache(pCArray, iNew, nNew);
  60751. return rebuildPage(pPg, nNew, &pCArray->apCell[iNew], &pCArray->szCell[iNew]);
  60752. }
  60753. /*
  60754. ** The following parameters determine how many adjacent pages get involved
  60755. ** in a balancing operation. NN is the number of neighbors on either side
  60756. ** of the page that participate in the balancing operation. NB is the
  60757. ** total number of pages that participate, including the target page and
  60758. ** NN neighbors on either side.
  60759. **
  60760. ** The minimum value of NN is 1 (of course). Increasing NN above 1
  60761. ** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
  60762. ** in exchange for a larger degradation in INSERT and UPDATE performance.
  60763. ** The value of NN appears to give the best results overall.
  60764. */
  60765. #define NN 1 /* Number of neighbors on either side of pPage */
  60766. #define NB (NN*2+1) /* Total pages involved in the balance */
  60767. #ifndef SQLITE_OMIT_QUICKBALANCE
  60768. /*
  60769. ** This version of balance() handles the common special case where
  60770. ** a new entry is being inserted on the extreme right-end of the
  60771. ** tree, in other words, when the new entry will become the largest
  60772. ** entry in the tree.
  60773. **
  60774. ** Instead of trying to balance the 3 right-most leaf pages, just add
  60775. ** a new page to the right-hand side and put the one new entry in
  60776. ** that page. This leaves the right side of the tree somewhat
  60777. ** unbalanced. But odds are that we will be inserting new entries
  60778. ** at the end soon afterwards so the nearly empty page will quickly
  60779. ** fill up. On average.
  60780. **
  60781. ** pPage is the leaf page which is the right-most page in the tree.
  60782. ** pParent is its parent. pPage must have a single overflow entry
  60783. ** which is also the right-most entry on the page.
  60784. **
  60785. ** The pSpace buffer is used to store a temporary copy of the divider
  60786. ** cell that will be inserted into pParent. Such a cell consists of a 4
  60787. ** byte page number followed by a variable length integer. In other
  60788. ** words, at most 13 bytes. Hence the pSpace buffer must be at
  60789. ** least 13 bytes in size.
  60790. */
  60791. static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
  60792. BtShared *const pBt = pPage->pBt; /* B-Tree Database */
  60793. MemPage *pNew; /* Newly allocated page */
  60794. int rc; /* Return Code */
  60795. Pgno pgnoNew; /* Page number of pNew */
  60796. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60797. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  60798. assert( pPage->nOverflow==1 );
  60799. /* This error condition is now caught prior to reaching this function */
  60800. if( NEVER(pPage->nCell==0) ) return SQLITE_CORRUPT_BKPT;
  60801. /* Allocate a new page. This page will become the right-sibling of
  60802. ** pPage. Make the parent page writable, so that the new divider cell
  60803. ** may be inserted. If both these operations are successful, proceed.
  60804. */
  60805. rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
  60806. if( rc==SQLITE_OK ){
  60807. u8 *pOut = &pSpace[4];
  60808. u8 *pCell = pPage->apOvfl[0];
  60809. u16 szCell = pPage->xCellSize(pPage, pCell);
  60810. u8 *pStop;
  60811. assert( sqlite3PagerIswriteable(pNew->pDbPage) );
  60812. assert( pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
  60813. zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
  60814. rc = rebuildPage(pNew, 1, &pCell, &szCell);
  60815. if( NEVER(rc) ) return rc;
  60816. pNew->nFree = pBt->usableSize - pNew->cellOffset - 2 - szCell;
  60817. /* If this is an auto-vacuum database, update the pointer map
  60818. ** with entries for the new page, and any pointer from the
  60819. ** cell on the page to an overflow page. If either of these
  60820. ** operations fails, the return code is set, but the contents
  60821. ** of the parent page are still manipulated by thh code below.
  60822. ** That is Ok, at this point the parent page is guaranteed to
  60823. ** be marked as dirty. Returning an error code will cause a
  60824. ** rollback, undoing any changes made to the parent page.
  60825. */
  60826. if( ISAUTOVACUUM ){
  60827. ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno, &rc);
  60828. if( szCell>pNew->minLocal ){
  60829. ptrmapPutOvflPtr(pNew, pCell, &rc);
  60830. }
  60831. }
  60832. /* Create a divider cell to insert into pParent. The divider cell
  60833. ** consists of a 4-byte page number (the page number of pPage) and
  60834. ** a variable length key value (which must be the same value as the
  60835. ** largest key on pPage).
  60836. **
  60837. ** To find the largest key value on pPage, first find the right-most
  60838. ** cell on pPage. The first two fields of this cell are the
  60839. ** record-length (a variable length integer at most 32-bits in size)
  60840. ** and the key value (a variable length integer, may have any value).
  60841. ** The first of the while(...) loops below skips over the record-length
  60842. ** field. The second while(...) loop copies the key value from the
  60843. ** cell on pPage into the pSpace buffer.
  60844. */
  60845. pCell = findCell(pPage, pPage->nCell-1);
  60846. pStop = &pCell[9];
  60847. while( (*(pCell++)&0x80) && pCell<pStop );
  60848. pStop = &pCell[9];
  60849. while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
  60850. /* Insert the new divider cell into pParent. */
  60851. if( rc==SQLITE_OK ){
  60852. insertCell(pParent, pParent->nCell, pSpace, (int)(pOut-pSpace),
  60853. 0, pPage->pgno, &rc);
  60854. }
  60855. /* Set the right-child pointer of pParent to point to the new page. */
  60856. put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
  60857. /* Release the reference to the new page. */
  60858. releasePage(pNew);
  60859. }
  60860. return rc;
  60861. }
  60862. #endif /* SQLITE_OMIT_QUICKBALANCE */
  60863. #if 0
  60864. /*
  60865. ** This function does not contribute anything to the operation of SQLite.
  60866. ** it is sometimes activated temporarily while debugging code responsible
  60867. ** for setting pointer-map entries.
  60868. */
  60869. static int ptrmapCheckPages(MemPage **apPage, int nPage){
  60870. int i, j;
  60871. for(i=0; i<nPage; i++){
  60872. Pgno n;
  60873. u8 e;
  60874. MemPage *pPage = apPage[i];
  60875. BtShared *pBt = pPage->pBt;
  60876. assert( pPage->isInit );
  60877. for(j=0; j<pPage->nCell; j++){
  60878. CellInfo info;
  60879. u8 *z;
  60880. z = findCell(pPage, j);
  60881. pPage->xParseCell(pPage, z, &info);
  60882. if( info.nLocal<info.nPayload ){
  60883. Pgno ovfl = get4byte(&z[info.nSize-4]);
  60884. ptrmapGet(pBt, ovfl, &e, &n);
  60885. assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
  60886. }
  60887. if( !pPage->leaf ){
  60888. Pgno child = get4byte(z);
  60889. ptrmapGet(pBt, child, &e, &n);
  60890. assert( n==pPage->pgno && e==PTRMAP_BTREE );
  60891. }
  60892. }
  60893. if( !pPage->leaf ){
  60894. Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  60895. ptrmapGet(pBt, child, &e, &n);
  60896. assert( n==pPage->pgno && e==PTRMAP_BTREE );
  60897. }
  60898. }
  60899. return 1;
  60900. }
  60901. #endif
  60902. /*
  60903. ** This function is used to copy the contents of the b-tree node stored
  60904. ** on page pFrom to page pTo. If page pFrom was not a leaf page, then
  60905. ** the pointer-map entries for each child page are updated so that the
  60906. ** parent page stored in the pointer map is page pTo. If pFrom contained
  60907. ** any cells with overflow page pointers, then the corresponding pointer
  60908. ** map entries are also updated so that the parent page is page pTo.
  60909. **
  60910. ** If pFrom is currently carrying any overflow cells (entries in the
  60911. ** MemPage.apOvfl[] array), they are not copied to pTo.
  60912. **
  60913. ** Before returning, page pTo is reinitialized using btreeInitPage().
  60914. **
  60915. ** The performance of this function is not critical. It is only used by
  60916. ** the balance_shallower() and balance_deeper() procedures, neither of
  60917. ** which are called often under normal circumstances.
  60918. */
  60919. static void copyNodeContent(MemPage *pFrom, MemPage *pTo, int *pRC){
  60920. if( (*pRC)==SQLITE_OK ){
  60921. BtShared * const pBt = pFrom->pBt;
  60922. u8 * const aFrom = pFrom->aData;
  60923. u8 * const aTo = pTo->aData;
  60924. int const iFromHdr = pFrom->hdrOffset;
  60925. int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
  60926. int rc;
  60927. int iData;
  60928. assert( pFrom->isInit );
  60929. assert( pFrom->nFree>=iToHdr );
  60930. assert( get2byte(&aFrom[iFromHdr+5]) <= (int)pBt->usableSize );
  60931. /* Copy the b-tree node content from page pFrom to page pTo. */
  60932. iData = get2byte(&aFrom[iFromHdr+5]);
  60933. memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
  60934. memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
  60935. /* Reinitialize page pTo so that the contents of the MemPage structure
  60936. ** match the new data. The initialization of pTo can actually fail under
  60937. ** fairly obscure circumstances, even though it is a copy of initialized
  60938. ** page pFrom.
  60939. */
  60940. pTo->isInit = 0;
  60941. rc = btreeInitPage(pTo);
  60942. if( rc!=SQLITE_OK ){
  60943. *pRC = rc;
  60944. return;
  60945. }
  60946. /* If this is an auto-vacuum database, update the pointer-map entries
  60947. ** for any b-tree or overflow pages that pTo now contains the pointers to.
  60948. */
  60949. if( ISAUTOVACUUM ){
  60950. *pRC = setChildPtrmaps(pTo);
  60951. }
  60952. }
  60953. }
  60954. /*
  60955. ** This routine redistributes cells on the iParentIdx'th child of pParent
  60956. ** (hereafter "the page") and up to 2 siblings so that all pages have about the
  60957. ** same amount of free space. Usually a single sibling on either side of the
  60958. ** page are used in the balancing, though both siblings might come from one
  60959. ** side if the page is the first or last child of its parent. If the page
  60960. ** has fewer than 2 siblings (something which can only happen if the page
  60961. ** is a root page or a child of a root page) then all available siblings
  60962. ** participate in the balancing.
  60963. **
  60964. ** The number of siblings of the page might be increased or decreased by
  60965. ** one or two in an effort to keep pages nearly full but not over full.
  60966. **
  60967. ** Note that when this routine is called, some of the cells on the page
  60968. ** might not actually be stored in MemPage.aData[]. This can happen
  60969. ** if the page is overfull. This routine ensures that all cells allocated
  60970. ** to the page and its siblings fit into MemPage.aData[] before returning.
  60971. **
  60972. ** In the course of balancing the page and its siblings, cells may be
  60973. ** inserted into or removed from the parent page (pParent). Doing so
  60974. ** may cause the parent page to become overfull or underfull. If this
  60975. ** happens, it is the responsibility of the caller to invoke the correct
  60976. ** balancing routine to fix this problem (see the balance() routine).
  60977. **
  60978. ** If this routine fails for any reason, it might leave the database
  60979. ** in a corrupted state. So if this routine fails, the database should
  60980. ** be rolled back.
  60981. **
  60982. ** The third argument to this function, aOvflSpace, is a pointer to a
  60983. ** buffer big enough to hold one page. If while inserting cells into the parent
  60984. ** page (pParent) the parent page becomes overfull, this buffer is
  60985. ** used to store the parent's overflow cells. Because this function inserts
  60986. ** a maximum of four divider cells into the parent page, and the maximum
  60987. ** size of a cell stored within an internal node is always less than 1/4
  60988. ** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
  60989. ** enough for all overflow cells.
  60990. **
  60991. ** If aOvflSpace is set to a null pointer, this function returns
  60992. ** SQLITE_NOMEM.
  60993. */
  60994. static int balance_nonroot(
  60995. MemPage *pParent, /* Parent page of siblings being balanced */
  60996. int iParentIdx, /* Index of "the page" in pParent */
  60997. u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
  60998. int isRoot, /* True if pParent is a root-page */
  60999. int bBulk /* True if this call is part of a bulk load */
  61000. ){
  61001. BtShared *pBt; /* The whole database */
  61002. int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
  61003. int nNew = 0; /* Number of pages in apNew[] */
  61004. int nOld; /* Number of pages in apOld[] */
  61005. int i, j, k; /* Loop counters */
  61006. int nxDiv; /* Next divider slot in pParent->aCell[] */
  61007. int rc = SQLITE_OK; /* The return code */
  61008. u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
  61009. int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
  61010. int usableSpace; /* Bytes in pPage beyond the header */
  61011. int pageFlags; /* Value of pPage->aData[0] */
  61012. int iSpace1 = 0; /* First unused byte of aSpace1[] */
  61013. int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
  61014. int szScratch; /* Size of scratch memory requested */
  61015. MemPage *apOld[NB]; /* pPage and up to two siblings */
  61016. MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
  61017. u8 *pRight; /* Location in parent of right-sibling pointer */
  61018. u8 *apDiv[NB-1]; /* Divider cells in pParent */
  61019. int cntNew[NB+2]; /* Index in b.paCell[] of cell after i-th page */
  61020. int cntOld[NB+2]; /* Old index in b.apCell[] */
  61021. int szNew[NB+2]; /* Combined size of cells placed on i-th page */
  61022. u8 *aSpace1; /* Space for copies of dividers cells */
  61023. Pgno pgno; /* Temp var to store a page number in */
  61024. u8 abDone[NB+2]; /* True after i'th new page is populated */
  61025. Pgno aPgno[NB+2]; /* Page numbers of new pages before shuffling */
  61026. Pgno aPgOrder[NB+2]; /* Copy of aPgno[] used for sorting pages */
  61027. u16 aPgFlags[NB+2]; /* flags field of new pages before shuffling */
  61028. CellArray b; /* Parsed information on cells being balanced */
  61029. memset(abDone, 0, sizeof(abDone));
  61030. b.nCell = 0;
  61031. b.apCell = 0;
  61032. pBt = pParent->pBt;
  61033. assert( sqlite3_mutex_held(pBt->mutex) );
  61034. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  61035. #if 0
  61036. TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
  61037. #endif
  61038. /* At this point pParent may have at most one overflow cell. And if
  61039. ** this overflow cell is present, it must be the cell with
  61040. ** index iParentIdx. This scenario comes about when this function
  61041. ** is called (indirectly) from sqlite3BtreeDelete().
  61042. */
  61043. assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
  61044. assert( pParent->nOverflow==0 || pParent->aiOvfl[0]==iParentIdx );
  61045. if( !aOvflSpace ){
  61046. return SQLITE_NOMEM_BKPT;
  61047. }
  61048. /* Find the sibling pages to balance. Also locate the cells in pParent
  61049. ** that divide the siblings. An attempt is made to find NN siblings on
  61050. ** either side of pPage. More siblings are taken from one side, however,
  61051. ** if there are fewer than NN siblings on the other side. If pParent
  61052. ** has NB or fewer children then all children of pParent are taken.
  61053. **
  61054. ** This loop also drops the divider cells from the parent page. This
  61055. ** way, the remainder of the function does not have to deal with any
  61056. ** overflow cells in the parent page, since if any existed they will
  61057. ** have already been removed.
  61058. */
  61059. i = pParent->nOverflow + pParent->nCell;
  61060. if( i<2 ){
  61061. nxDiv = 0;
  61062. }else{
  61063. assert( bBulk==0 || bBulk==1 );
  61064. if( iParentIdx==0 ){
  61065. nxDiv = 0;
  61066. }else if( iParentIdx==i ){
  61067. nxDiv = i-2+bBulk;
  61068. }else{
  61069. nxDiv = iParentIdx-1;
  61070. }
  61071. i = 2-bBulk;
  61072. }
  61073. nOld = i+1;
  61074. if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
  61075. pRight = &pParent->aData[pParent->hdrOffset+8];
  61076. }else{
  61077. pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
  61078. }
  61079. pgno = get4byte(pRight);
  61080. while( 1 ){
  61081. rc = getAndInitPage(pBt, pgno, &apOld[i], 0, 0);
  61082. if( rc ){
  61083. memset(apOld, 0, (i+1)*sizeof(MemPage*));
  61084. goto balance_cleanup;
  61085. }
  61086. nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
  61087. if( (i--)==0 ) break;
  61088. if( i+nxDiv==pParent->aiOvfl[0] && pParent->nOverflow ){
  61089. apDiv[i] = pParent->apOvfl[0];
  61090. pgno = get4byte(apDiv[i]);
  61091. szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
  61092. pParent->nOverflow = 0;
  61093. }else{
  61094. apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
  61095. pgno = get4byte(apDiv[i]);
  61096. szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
  61097. /* Drop the cell from the parent page. apDiv[i] still points to
  61098. ** the cell within the parent, even though it has been dropped.
  61099. ** This is safe because dropping a cell only overwrites the first
  61100. ** four bytes of it, and this function does not need the first
  61101. ** four bytes of the divider cell. So the pointer is safe to use
  61102. ** later on.
  61103. **
  61104. ** But not if we are in secure-delete mode. In secure-delete mode,
  61105. ** the dropCell() routine will overwrite the entire cell with zeroes.
  61106. ** In this case, temporarily copy the cell into the aOvflSpace[]
  61107. ** buffer. It will be copied out again as soon as the aSpace[] buffer
  61108. ** is allocated. */
  61109. if( pBt->btsFlags & BTS_SECURE_DELETE ){
  61110. int iOff;
  61111. iOff = SQLITE_PTR_TO_INT(apDiv[i]) - SQLITE_PTR_TO_INT(pParent->aData);
  61112. if( (iOff+szNew[i])>(int)pBt->usableSize ){
  61113. rc = SQLITE_CORRUPT_BKPT;
  61114. memset(apOld, 0, (i+1)*sizeof(MemPage*));
  61115. goto balance_cleanup;
  61116. }else{
  61117. memcpy(&aOvflSpace[iOff], apDiv[i], szNew[i]);
  61118. apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
  61119. }
  61120. }
  61121. dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i], &rc);
  61122. }
  61123. }
  61124. /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
  61125. ** alignment */
  61126. nMaxCells = (nMaxCells + 3)&~3;
  61127. /*
  61128. ** Allocate space for memory structures
  61129. */
  61130. szScratch =
  61131. nMaxCells*sizeof(u8*) /* b.apCell */
  61132. + nMaxCells*sizeof(u16) /* b.szCell */
  61133. + pBt->pageSize; /* aSpace1 */
  61134. /* EVIDENCE-OF: R-28375-38319 SQLite will never request a scratch buffer
  61135. ** that is more than 6 times the database page size. */
  61136. assert( szScratch<=6*(int)pBt->pageSize );
  61137. b.apCell = sqlite3ScratchMalloc( szScratch );
  61138. if( b.apCell==0 ){
  61139. rc = SQLITE_NOMEM_BKPT;
  61140. goto balance_cleanup;
  61141. }
  61142. b.szCell = (u16*)&b.apCell[nMaxCells];
  61143. aSpace1 = (u8*)&b.szCell[nMaxCells];
  61144. assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
  61145. /*
  61146. ** Load pointers to all cells on sibling pages and the divider cells
  61147. ** into the local b.apCell[] array. Make copies of the divider cells
  61148. ** into space obtained from aSpace1[]. The divider cells have already
  61149. ** been removed from pParent.
  61150. **
  61151. ** If the siblings are on leaf pages, then the child pointers of the
  61152. ** divider cells are stripped from the cells before they are copied
  61153. ** into aSpace1[]. In this way, all cells in b.apCell[] are without
  61154. ** child pointers. If siblings are not leaves, then all cell in
  61155. ** b.apCell[] include child pointers. Either way, all cells in b.apCell[]
  61156. ** are alike.
  61157. **
  61158. ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
  61159. ** leafData: 1 if pPage holds key+data and pParent holds only keys.
  61160. */
  61161. b.pRef = apOld[0];
  61162. leafCorrection = b.pRef->leaf*4;
  61163. leafData = b.pRef->intKeyLeaf;
  61164. for(i=0; i<nOld; i++){
  61165. MemPage *pOld = apOld[i];
  61166. int limit = pOld->nCell;
  61167. u8 *aData = pOld->aData;
  61168. u16 maskPage = pOld->maskPage;
  61169. u8 *piCell = aData + pOld->cellOffset;
  61170. u8 *piEnd;
  61171. /* Verify that all sibling pages are of the same "type" (table-leaf,
  61172. ** table-interior, index-leaf, or index-interior).
  61173. */
  61174. if( pOld->aData[0]!=apOld[0]->aData[0] ){
  61175. rc = SQLITE_CORRUPT_BKPT;
  61176. goto balance_cleanup;
  61177. }
  61178. /* Load b.apCell[] with pointers to all cells in pOld. If pOld
  61179. ** constains overflow cells, include them in the b.apCell[] array
  61180. ** in the correct spot.
  61181. **
  61182. ** Note that when there are multiple overflow cells, it is always the
  61183. ** case that they are sequential and adjacent. This invariant arises
  61184. ** because multiple overflows can only occurs when inserting divider
  61185. ** cells into a parent on a prior balance, and divider cells are always
  61186. ** adjacent and are inserted in order. There is an assert() tagged
  61187. ** with "NOTE 1" in the overflow cell insertion loop to prove this
  61188. ** invariant.
  61189. **
  61190. ** This must be done in advance. Once the balance starts, the cell
  61191. ** offset section of the btree page will be overwritten and we will no
  61192. ** long be able to find the cells if a pointer to each cell is not saved
  61193. ** first.
  61194. */
  61195. memset(&b.szCell[b.nCell], 0, sizeof(b.szCell[0])*(limit+pOld->nOverflow));
  61196. if( pOld->nOverflow>0 ){
  61197. limit = pOld->aiOvfl[0];
  61198. for(j=0; j<limit; j++){
  61199. b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
  61200. piCell += 2;
  61201. b.nCell++;
  61202. }
  61203. for(k=0; k<pOld->nOverflow; k++){
  61204. assert( k==0 || pOld->aiOvfl[k-1]+1==pOld->aiOvfl[k] );/* NOTE 1 */
  61205. b.apCell[b.nCell] = pOld->apOvfl[k];
  61206. b.nCell++;
  61207. }
  61208. }
  61209. piEnd = aData + pOld->cellOffset + 2*pOld->nCell;
  61210. while( piCell<piEnd ){
  61211. assert( b.nCell<nMaxCells );
  61212. b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
  61213. piCell += 2;
  61214. b.nCell++;
  61215. }
  61216. cntOld[i] = b.nCell;
  61217. if( i<nOld-1 && !leafData){
  61218. u16 sz = (u16)szNew[i];
  61219. u8 *pTemp;
  61220. assert( b.nCell<nMaxCells );
  61221. b.szCell[b.nCell] = sz;
  61222. pTemp = &aSpace1[iSpace1];
  61223. iSpace1 += sz;
  61224. assert( sz<=pBt->maxLocal+23 );
  61225. assert( iSpace1 <= (int)pBt->pageSize );
  61226. memcpy(pTemp, apDiv[i], sz);
  61227. b.apCell[b.nCell] = pTemp+leafCorrection;
  61228. assert( leafCorrection==0 || leafCorrection==4 );
  61229. b.szCell[b.nCell] = b.szCell[b.nCell] - leafCorrection;
  61230. if( !pOld->leaf ){
  61231. assert( leafCorrection==0 );
  61232. assert( pOld->hdrOffset==0 );
  61233. /* The right pointer of the child page pOld becomes the left
  61234. ** pointer of the divider cell */
  61235. memcpy(b.apCell[b.nCell], &pOld->aData[8], 4);
  61236. }else{
  61237. assert( leafCorrection==4 );
  61238. while( b.szCell[b.nCell]<4 ){
  61239. /* Do not allow any cells smaller than 4 bytes. If a smaller cell
  61240. ** does exist, pad it with 0x00 bytes. */
  61241. assert( b.szCell[b.nCell]==3 || CORRUPT_DB );
  61242. assert( b.apCell[b.nCell]==&aSpace1[iSpace1-3] || CORRUPT_DB );
  61243. aSpace1[iSpace1++] = 0x00;
  61244. b.szCell[b.nCell]++;
  61245. }
  61246. }
  61247. b.nCell++;
  61248. }
  61249. }
  61250. /*
  61251. ** Figure out the number of pages needed to hold all b.nCell cells.
  61252. ** Store this number in "k". Also compute szNew[] which is the total
  61253. ** size of all cells on the i-th page and cntNew[] which is the index
  61254. ** in b.apCell[] of the cell that divides page i from page i+1.
  61255. ** cntNew[k] should equal b.nCell.
  61256. **
  61257. ** Values computed by this block:
  61258. **
  61259. ** k: The total number of sibling pages
  61260. ** szNew[i]: Spaced used on the i-th sibling page.
  61261. ** cntNew[i]: Index in b.apCell[] and b.szCell[] for the first cell to
  61262. ** the right of the i-th sibling page.
  61263. ** usableSpace: Number of bytes of space available on each sibling.
  61264. **
  61265. */
  61266. usableSpace = pBt->usableSize - 12 + leafCorrection;
  61267. for(i=0; i<nOld; i++){
  61268. MemPage *p = apOld[i];
  61269. szNew[i] = usableSpace - p->nFree;
  61270. if( szNew[i]<0 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
  61271. for(j=0; j<p->nOverflow; j++){
  61272. szNew[i] += 2 + p->xCellSize(p, p->apOvfl[j]);
  61273. }
  61274. cntNew[i] = cntOld[i];
  61275. }
  61276. k = nOld;
  61277. for(i=0; i<k; i++){
  61278. int sz;
  61279. while( szNew[i]>usableSpace ){
  61280. if( i+1>=k ){
  61281. k = i+2;
  61282. if( k>NB+2 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
  61283. szNew[k-1] = 0;
  61284. cntNew[k-1] = b.nCell;
  61285. }
  61286. sz = 2 + cachedCellSize(&b, cntNew[i]-1);
  61287. szNew[i] -= sz;
  61288. if( !leafData ){
  61289. if( cntNew[i]<b.nCell ){
  61290. sz = 2 + cachedCellSize(&b, cntNew[i]);
  61291. }else{
  61292. sz = 0;
  61293. }
  61294. }
  61295. szNew[i+1] += sz;
  61296. cntNew[i]--;
  61297. }
  61298. while( cntNew[i]<b.nCell ){
  61299. sz = 2 + cachedCellSize(&b, cntNew[i]);
  61300. if( szNew[i]+sz>usableSpace ) break;
  61301. szNew[i] += sz;
  61302. cntNew[i]++;
  61303. if( !leafData ){
  61304. if( cntNew[i]<b.nCell ){
  61305. sz = 2 + cachedCellSize(&b, cntNew[i]);
  61306. }else{
  61307. sz = 0;
  61308. }
  61309. }
  61310. szNew[i+1] -= sz;
  61311. }
  61312. if( cntNew[i]>=b.nCell ){
  61313. k = i+1;
  61314. }else if( cntNew[i] <= (i>0 ? cntNew[i-1] : 0) ){
  61315. rc = SQLITE_CORRUPT_BKPT;
  61316. goto balance_cleanup;
  61317. }
  61318. }
  61319. /*
  61320. ** The packing computed by the previous block is biased toward the siblings
  61321. ** on the left side (siblings with smaller keys). The left siblings are
  61322. ** always nearly full, while the right-most sibling might be nearly empty.
  61323. ** The next block of code attempts to adjust the packing of siblings to
  61324. ** get a better balance.
  61325. **
  61326. ** This adjustment is more than an optimization. The packing above might
  61327. ** be so out of balance as to be illegal. For example, the right-most
  61328. ** sibling might be completely empty. This adjustment is not optional.
  61329. */
  61330. for(i=k-1; i>0; i--){
  61331. int szRight = szNew[i]; /* Size of sibling on the right */
  61332. int szLeft = szNew[i-1]; /* Size of sibling on the left */
  61333. int r; /* Index of right-most cell in left sibling */
  61334. int d; /* Index of first cell to the left of right sibling */
  61335. r = cntNew[i-1] - 1;
  61336. d = r + 1 - leafData;
  61337. (void)cachedCellSize(&b, d);
  61338. do{
  61339. assert( d<nMaxCells );
  61340. assert( r<nMaxCells );
  61341. (void)cachedCellSize(&b, r);
  61342. if( szRight!=0
  61343. && (bBulk || szRight+b.szCell[d]+2 > szLeft-(b.szCell[r]+(i==k-1?0:2)))){
  61344. break;
  61345. }
  61346. szRight += b.szCell[d] + 2;
  61347. szLeft -= b.szCell[r] + 2;
  61348. cntNew[i-1] = r;
  61349. r--;
  61350. d--;
  61351. }while( r>=0 );
  61352. szNew[i] = szRight;
  61353. szNew[i-1] = szLeft;
  61354. if( cntNew[i-1] <= (i>1 ? cntNew[i-2] : 0) ){
  61355. rc = SQLITE_CORRUPT_BKPT;
  61356. goto balance_cleanup;
  61357. }
  61358. }
  61359. /* Sanity check: For a non-corrupt database file one of the follwing
  61360. ** must be true:
  61361. ** (1) We found one or more cells (cntNew[0])>0), or
  61362. ** (2) pPage is a virtual root page. A virtual root page is when
  61363. ** the real root page is page 1 and we are the only child of
  61364. ** that page.
  61365. */
  61366. assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) || CORRUPT_DB);
  61367. TRACE(("BALANCE: old: %d(nc=%d) %d(nc=%d) %d(nc=%d)\n",
  61368. apOld[0]->pgno, apOld[0]->nCell,
  61369. nOld>=2 ? apOld[1]->pgno : 0, nOld>=2 ? apOld[1]->nCell : 0,
  61370. nOld>=3 ? apOld[2]->pgno : 0, nOld>=3 ? apOld[2]->nCell : 0
  61371. ));
  61372. /*
  61373. ** Allocate k new pages. Reuse old pages where possible.
  61374. */
  61375. pageFlags = apOld[0]->aData[0];
  61376. for(i=0; i<k; i++){
  61377. MemPage *pNew;
  61378. if( i<nOld ){
  61379. pNew = apNew[i] = apOld[i];
  61380. apOld[i] = 0;
  61381. rc = sqlite3PagerWrite(pNew->pDbPage);
  61382. nNew++;
  61383. if( rc ) goto balance_cleanup;
  61384. }else{
  61385. assert( i>0 );
  61386. rc = allocateBtreePage(pBt, &pNew, &pgno, (bBulk ? 1 : pgno), 0);
  61387. if( rc ) goto balance_cleanup;
  61388. zeroPage(pNew, pageFlags);
  61389. apNew[i] = pNew;
  61390. nNew++;
  61391. cntOld[i] = b.nCell;
  61392. /* Set the pointer-map entry for the new sibling page. */
  61393. if( ISAUTOVACUUM ){
  61394. ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno, &rc);
  61395. if( rc!=SQLITE_OK ){
  61396. goto balance_cleanup;
  61397. }
  61398. }
  61399. }
  61400. }
  61401. /*
  61402. ** Reassign page numbers so that the new pages are in ascending order.
  61403. ** This helps to keep entries in the disk file in order so that a scan
  61404. ** of the table is closer to a linear scan through the file. That in turn
  61405. ** helps the operating system to deliver pages from the disk more rapidly.
  61406. **
  61407. ** An O(n^2) insertion sort algorithm is used, but since n is never more
  61408. ** than (NB+2) (a small constant), that should not be a problem.
  61409. **
  61410. ** When NB==3, this one optimization makes the database about 25% faster
  61411. ** for large insertions and deletions.
  61412. */
  61413. for(i=0; i<nNew; i++){
  61414. aPgOrder[i] = aPgno[i] = apNew[i]->pgno;
  61415. aPgFlags[i] = apNew[i]->pDbPage->flags;
  61416. for(j=0; j<i; j++){
  61417. if( aPgno[j]==aPgno[i] ){
  61418. /* This branch is taken if the set of sibling pages somehow contains
  61419. ** duplicate entries. This can happen if the database is corrupt.
  61420. ** It would be simpler to detect this as part of the loop below, but
  61421. ** we do the detection here in order to avoid populating the pager
  61422. ** cache with two separate objects associated with the same
  61423. ** page number. */
  61424. assert( CORRUPT_DB );
  61425. rc = SQLITE_CORRUPT_BKPT;
  61426. goto balance_cleanup;
  61427. }
  61428. }
  61429. }
  61430. for(i=0; i<nNew; i++){
  61431. int iBest = 0; /* aPgno[] index of page number to use */
  61432. for(j=1; j<nNew; j++){
  61433. if( aPgOrder[j]<aPgOrder[iBest] ) iBest = j;
  61434. }
  61435. pgno = aPgOrder[iBest];
  61436. aPgOrder[iBest] = 0xffffffff;
  61437. if( iBest!=i ){
  61438. if( iBest>i ){
  61439. sqlite3PagerRekey(apNew[iBest]->pDbPage, pBt->nPage+iBest+1, 0);
  61440. }
  61441. sqlite3PagerRekey(apNew[i]->pDbPage, pgno, aPgFlags[iBest]);
  61442. apNew[i]->pgno = pgno;
  61443. }
  61444. }
  61445. TRACE(("BALANCE: new: %d(%d nc=%d) %d(%d nc=%d) %d(%d nc=%d) "
  61446. "%d(%d nc=%d) %d(%d nc=%d)\n",
  61447. apNew[0]->pgno, szNew[0], cntNew[0],
  61448. nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
  61449. nNew>=2 ? cntNew[1] - cntNew[0] - !leafData : 0,
  61450. nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
  61451. nNew>=3 ? cntNew[2] - cntNew[1] - !leafData : 0,
  61452. nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
  61453. nNew>=4 ? cntNew[3] - cntNew[2] - !leafData : 0,
  61454. nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0,
  61455. nNew>=5 ? cntNew[4] - cntNew[3] - !leafData : 0
  61456. ));
  61457. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  61458. put4byte(pRight, apNew[nNew-1]->pgno);
  61459. /* If the sibling pages are not leaves, ensure that the right-child pointer
  61460. ** of the right-most new sibling page is set to the value that was
  61461. ** originally in the same field of the right-most old sibling page. */
  61462. if( (pageFlags & PTF_LEAF)==0 && nOld!=nNew ){
  61463. MemPage *pOld = (nNew>nOld ? apNew : apOld)[nOld-1];
  61464. memcpy(&apNew[nNew-1]->aData[8], &pOld->aData[8], 4);
  61465. }
  61466. /* Make any required updates to pointer map entries associated with
  61467. ** cells stored on sibling pages following the balance operation. Pointer
  61468. ** map entries associated with divider cells are set by the insertCell()
  61469. ** routine. The associated pointer map entries are:
  61470. **
  61471. ** a) if the cell contains a reference to an overflow chain, the
  61472. ** entry associated with the first page in the overflow chain, and
  61473. **
  61474. ** b) if the sibling pages are not leaves, the child page associated
  61475. ** with the cell.
  61476. **
  61477. ** If the sibling pages are not leaves, then the pointer map entry
  61478. ** associated with the right-child of each sibling may also need to be
  61479. ** updated. This happens below, after the sibling pages have been
  61480. ** populated, not here.
  61481. */
  61482. if( ISAUTOVACUUM ){
  61483. MemPage *pNew = apNew[0];
  61484. u8 *aOld = pNew->aData;
  61485. int cntOldNext = pNew->nCell + pNew->nOverflow;
  61486. int usableSize = pBt->usableSize;
  61487. int iNew = 0;
  61488. int iOld = 0;
  61489. for(i=0; i<b.nCell; i++){
  61490. u8 *pCell = b.apCell[i];
  61491. if( i==cntOldNext ){
  61492. MemPage *pOld = (++iOld)<nNew ? apNew[iOld] : apOld[iOld];
  61493. cntOldNext += pOld->nCell + pOld->nOverflow + !leafData;
  61494. aOld = pOld->aData;
  61495. }
  61496. if( i==cntNew[iNew] ){
  61497. pNew = apNew[++iNew];
  61498. if( !leafData ) continue;
  61499. }
  61500. /* Cell pCell is destined for new sibling page pNew. Originally, it
  61501. ** was either part of sibling page iOld (possibly an overflow cell),
  61502. ** or else the divider cell to the left of sibling page iOld. So,
  61503. ** if sibling page iOld had the same page number as pNew, and if
  61504. ** pCell really was a part of sibling page iOld (not a divider or
  61505. ** overflow cell), we can skip updating the pointer map entries. */
  61506. if( iOld>=nNew
  61507. || pNew->pgno!=aPgno[iOld]
  61508. || !SQLITE_WITHIN(pCell,aOld,&aOld[usableSize])
  61509. ){
  61510. if( !leafCorrection ){
  61511. ptrmapPut(pBt, get4byte(pCell), PTRMAP_BTREE, pNew->pgno, &rc);
  61512. }
  61513. if( cachedCellSize(&b,i)>pNew->minLocal ){
  61514. ptrmapPutOvflPtr(pNew, pCell, &rc);
  61515. }
  61516. if( rc ) goto balance_cleanup;
  61517. }
  61518. }
  61519. }
  61520. /* Insert new divider cells into pParent. */
  61521. for(i=0; i<nNew-1; i++){
  61522. u8 *pCell;
  61523. u8 *pTemp;
  61524. int sz;
  61525. MemPage *pNew = apNew[i];
  61526. j = cntNew[i];
  61527. assert( j<nMaxCells );
  61528. assert( b.apCell[j]!=0 );
  61529. pCell = b.apCell[j];
  61530. sz = b.szCell[j] + leafCorrection;
  61531. pTemp = &aOvflSpace[iOvflSpace];
  61532. if( !pNew->leaf ){
  61533. memcpy(&pNew->aData[8], pCell, 4);
  61534. }else if( leafData ){
  61535. /* If the tree is a leaf-data tree, and the siblings are leaves,
  61536. ** then there is no divider cell in b.apCell[]. Instead, the divider
  61537. ** cell consists of the integer key for the right-most cell of
  61538. ** the sibling-page assembled above only.
  61539. */
  61540. CellInfo info;
  61541. j--;
  61542. pNew->xParseCell(pNew, b.apCell[j], &info);
  61543. pCell = pTemp;
  61544. sz = 4 + putVarint(&pCell[4], info.nKey);
  61545. pTemp = 0;
  61546. }else{
  61547. pCell -= 4;
  61548. /* Obscure case for non-leaf-data trees: If the cell at pCell was
  61549. ** previously stored on a leaf node, and its reported size was 4
  61550. ** bytes, then it may actually be smaller than this
  61551. ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
  61552. ** any cell). But it is important to pass the correct size to
  61553. ** insertCell(), so reparse the cell now.
  61554. **
  61555. ** This can only happen for b-trees used to evaluate "IN (SELECT ...)"
  61556. ** and WITHOUT ROWID tables with exactly one column which is the
  61557. ** primary key.
  61558. */
  61559. if( b.szCell[j]==4 ){
  61560. assert(leafCorrection==4);
  61561. sz = pParent->xCellSize(pParent, pCell);
  61562. }
  61563. }
  61564. iOvflSpace += sz;
  61565. assert( sz<=pBt->maxLocal+23 );
  61566. assert( iOvflSpace <= (int)pBt->pageSize );
  61567. insertCell(pParent, nxDiv+i, pCell, sz, pTemp, pNew->pgno, &rc);
  61568. if( rc!=SQLITE_OK ) goto balance_cleanup;
  61569. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  61570. }
  61571. /* Now update the actual sibling pages. The order in which they are updated
  61572. ** is important, as this code needs to avoid disrupting any page from which
  61573. ** cells may still to be read. In practice, this means:
  61574. **
  61575. ** (1) If cells are moving left (from apNew[iPg] to apNew[iPg-1])
  61576. ** then it is not safe to update page apNew[iPg] until after
  61577. ** the left-hand sibling apNew[iPg-1] has been updated.
  61578. **
  61579. ** (2) If cells are moving right (from apNew[iPg] to apNew[iPg+1])
  61580. ** then it is not safe to update page apNew[iPg] until after
  61581. ** the right-hand sibling apNew[iPg+1] has been updated.
  61582. **
  61583. ** If neither of the above apply, the page is safe to update.
  61584. **
  61585. ** The iPg value in the following loop starts at nNew-1 goes down
  61586. ** to 0, then back up to nNew-1 again, thus making two passes over
  61587. ** the pages. On the initial downward pass, only condition (1) above
  61588. ** needs to be tested because (2) will always be true from the previous
  61589. ** step. On the upward pass, both conditions are always true, so the
  61590. ** upwards pass simply processes pages that were missed on the downward
  61591. ** pass.
  61592. */
  61593. for(i=1-nNew; i<nNew; i++){
  61594. int iPg = i<0 ? -i : i;
  61595. assert( iPg>=0 && iPg<nNew );
  61596. if( abDone[iPg] ) continue; /* Skip pages already processed */
  61597. if( i>=0 /* On the upwards pass, or... */
  61598. || cntOld[iPg-1]>=cntNew[iPg-1] /* Condition (1) is true */
  61599. ){
  61600. int iNew;
  61601. int iOld;
  61602. int nNewCell;
  61603. /* Verify condition (1): If cells are moving left, update iPg
  61604. ** only after iPg-1 has already been updated. */
  61605. assert( iPg==0 || cntOld[iPg-1]>=cntNew[iPg-1] || abDone[iPg-1] );
  61606. /* Verify condition (2): If cells are moving right, update iPg
  61607. ** only after iPg+1 has already been updated. */
  61608. assert( cntNew[iPg]>=cntOld[iPg] || abDone[iPg+1] );
  61609. if( iPg==0 ){
  61610. iNew = iOld = 0;
  61611. nNewCell = cntNew[0];
  61612. }else{
  61613. iOld = iPg<nOld ? (cntOld[iPg-1] + !leafData) : b.nCell;
  61614. iNew = cntNew[iPg-1] + !leafData;
  61615. nNewCell = cntNew[iPg] - iNew;
  61616. }
  61617. rc = editPage(apNew[iPg], iOld, iNew, nNewCell, &b);
  61618. if( rc ) goto balance_cleanup;
  61619. abDone[iPg]++;
  61620. apNew[iPg]->nFree = usableSpace-szNew[iPg];
  61621. assert( apNew[iPg]->nOverflow==0 );
  61622. assert( apNew[iPg]->nCell==nNewCell );
  61623. }
  61624. }
  61625. /* All pages have been processed exactly once */
  61626. assert( memcmp(abDone, "\01\01\01\01\01", nNew)==0 );
  61627. assert( nOld>0 );
  61628. assert( nNew>0 );
  61629. if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
  61630. /* The root page of the b-tree now contains no cells. The only sibling
  61631. ** page is the right-child of the parent. Copy the contents of the
  61632. ** child page into the parent, decreasing the overall height of the
  61633. ** b-tree structure by one. This is described as the "balance-shallower"
  61634. ** sub-algorithm in some documentation.
  61635. **
  61636. ** If this is an auto-vacuum database, the call to copyNodeContent()
  61637. ** sets all pointer-map entries corresponding to database image pages
  61638. ** for which the pointer is stored within the content being copied.
  61639. **
  61640. ** It is critical that the child page be defragmented before being
  61641. ** copied into the parent, because if the parent is page 1 then it will
  61642. ** by smaller than the child due to the database header, and so all the
  61643. ** free space needs to be up front.
  61644. */
  61645. assert( nNew==1 || CORRUPT_DB );
  61646. rc = defragmentPage(apNew[0]);
  61647. testcase( rc!=SQLITE_OK );
  61648. assert( apNew[0]->nFree ==
  61649. (get2byte(&apNew[0]->aData[5])-apNew[0]->cellOffset-apNew[0]->nCell*2)
  61650. || rc!=SQLITE_OK
  61651. );
  61652. copyNodeContent(apNew[0], pParent, &rc);
  61653. freePage(apNew[0], &rc);
  61654. }else if( ISAUTOVACUUM && !leafCorrection ){
  61655. /* Fix the pointer map entries associated with the right-child of each
  61656. ** sibling page. All other pointer map entries have already been taken
  61657. ** care of. */
  61658. for(i=0; i<nNew; i++){
  61659. u32 key = get4byte(&apNew[i]->aData[8]);
  61660. ptrmapPut(pBt, key, PTRMAP_BTREE, apNew[i]->pgno, &rc);
  61661. }
  61662. }
  61663. assert( pParent->isInit );
  61664. TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
  61665. nOld, nNew, b.nCell));
  61666. /* Free any old pages that were not reused as new pages.
  61667. */
  61668. for(i=nNew; i<nOld; i++){
  61669. freePage(apOld[i], &rc);
  61670. }
  61671. #if 0
  61672. if( ISAUTOVACUUM && rc==SQLITE_OK && apNew[0]->isInit ){
  61673. /* The ptrmapCheckPages() contains assert() statements that verify that
  61674. ** all pointer map pages are set correctly. This is helpful while
  61675. ** debugging. This is usually disabled because a corrupt database may
  61676. ** cause an assert() statement to fail. */
  61677. ptrmapCheckPages(apNew, nNew);
  61678. ptrmapCheckPages(&pParent, 1);
  61679. }
  61680. #endif
  61681. /*
  61682. ** Cleanup before returning.
  61683. */
  61684. balance_cleanup:
  61685. sqlite3ScratchFree(b.apCell);
  61686. for(i=0; i<nOld; i++){
  61687. releasePage(apOld[i]);
  61688. }
  61689. for(i=0; i<nNew; i++){
  61690. releasePage(apNew[i]);
  61691. }
  61692. return rc;
  61693. }
  61694. /*
  61695. ** This function is called when the root page of a b-tree structure is
  61696. ** overfull (has one or more overflow pages).
  61697. **
  61698. ** A new child page is allocated and the contents of the current root
  61699. ** page, including overflow cells, are copied into the child. The root
  61700. ** page is then overwritten to make it an empty page with the right-child
  61701. ** pointer pointing to the new page.
  61702. **
  61703. ** Before returning, all pointer-map entries corresponding to pages
  61704. ** that the new child-page now contains pointers to are updated. The
  61705. ** entry corresponding to the new right-child pointer of the root
  61706. ** page is also updated.
  61707. **
  61708. ** If successful, *ppChild is set to contain a reference to the child
  61709. ** page and SQLITE_OK is returned. In this case the caller is required
  61710. ** to call releasePage() on *ppChild exactly once. If an error occurs,
  61711. ** an error code is returned and *ppChild is set to 0.
  61712. */
  61713. static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
  61714. int rc; /* Return value from subprocedures */
  61715. MemPage *pChild = 0; /* Pointer to a new child page */
  61716. Pgno pgnoChild = 0; /* Page number of the new child page */
  61717. BtShared *pBt = pRoot->pBt; /* The BTree */
  61718. assert( pRoot->nOverflow>0 );
  61719. assert( sqlite3_mutex_held(pBt->mutex) );
  61720. /* Make pRoot, the root page of the b-tree, writable. Allocate a new
  61721. ** page that will become the new right-child of pPage. Copy the contents
  61722. ** of the node stored on pRoot into the new child page.
  61723. */
  61724. rc = sqlite3PagerWrite(pRoot->pDbPage);
  61725. if( rc==SQLITE_OK ){
  61726. rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0);
  61727. copyNodeContent(pRoot, pChild, &rc);
  61728. if( ISAUTOVACUUM ){
  61729. ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno, &rc);
  61730. }
  61731. }
  61732. if( rc ){
  61733. *ppChild = 0;
  61734. releasePage(pChild);
  61735. return rc;
  61736. }
  61737. assert( sqlite3PagerIswriteable(pChild->pDbPage) );
  61738. assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
  61739. assert( pChild->nCell==pRoot->nCell );
  61740. TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
  61741. /* Copy the overflow cells from pRoot to pChild */
  61742. memcpy(pChild->aiOvfl, pRoot->aiOvfl,
  61743. pRoot->nOverflow*sizeof(pRoot->aiOvfl[0]));
  61744. memcpy(pChild->apOvfl, pRoot->apOvfl,
  61745. pRoot->nOverflow*sizeof(pRoot->apOvfl[0]));
  61746. pChild->nOverflow = pRoot->nOverflow;
  61747. /* Zero the contents of pRoot. Then install pChild as the right-child. */
  61748. zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
  61749. put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
  61750. *ppChild = pChild;
  61751. return SQLITE_OK;
  61752. }
  61753. /*
  61754. ** The page that pCur currently points to has just been modified in
  61755. ** some way. This function figures out if this modification means the
  61756. ** tree needs to be balanced, and if so calls the appropriate balancing
  61757. ** routine. Balancing routines are:
  61758. **
  61759. ** balance_quick()
  61760. ** balance_deeper()
  61761. ** balance_nonroot()
  61762. */
  61763. static int balance(BtCursor *pCur){
  61764. int rc = SQLITE_OK;
  61765. const int nMin = pCur->pBt->usableSize * 2 / 3;
  61766. u8 aBalanceQuickSpace[13];
  61767. u8 *pFree = 0;
  61768. VVA_ONLY( int balance_quick_called = 0 );
  61769. VVA_ONLY( int balance_deeper_called = 0 );
  61770. do {
  61771. int iPage = pCur->iPage;
  61772. MemPage *pPage = pCur->apPage[iPage];
  61773. if( iPage==0 ){
  61774. if( pPage->nOverflow ){
  61775. /* The root page of the b-tree is overfull. In this case call the
  61776. ** balance_deeper() function to create a new child for the root-page
  61777. ** and copy the current contents of the root-page to it. The
  61778. ** next iteration of the do-loop will balance the child page.
  61779. */
  61780. assert( balance_deeper_called==0 );
  61781. VVA_ONLY( balance_deeper_called++ );
  61782. rc = balance_deeper(pPage, &pCur->apPage[1]);
  61783. if( rc==SQLITE_OK ){
  61784. pCur->iPage = 1;
  61785. pCur->aiIdx[0] = 0;
  61786. pCur->aiIdx[1] = 0;
  61787. assert( pCur->apPage[1]->nOverflow );
  61788. }
  61789. }else{
  61790. break;
  61791. }
  61792. }else if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
  61793. break;
  61794. }else{
  61795. MemPage * const pParent = pCur->apPage[iPage-1];
  61796. int const iIdx = pCur->aiIdx[iPage-1];
  61797. rc = sqlite3PagerWrite(pParent->pDbPage);
  61798. if( rc==SQLITE_OK ){
  61799. #ifndef SQLITE_OMIT_QUICKBALANCE
  61800. if( pPage->intKeyLeaf
  61801. && pPage->nOverflow==1
  61802. && pPage->aiOvfl[0]==pPage->nCell
  61803. && pParent->pgno!=1
  61804. && pParent->nCell==iIdx
  61805. ){
  61806. /* Call balance_quick() to create a new sibling of pPage on which
  61807. ** to store the overflow cell. balance_quick() inserts a new cell
  61808. ** into pParent, which may cause pParent overflow. If this
  61809. ** happens, the next iteration of the do-loop will balance pParent
  61810. ** use either balance_nonroot() or balance_deeper(). Until this
  61811. ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
  61812. ** buffer.
  61813. **
  61814. ** The purpose of the following assert() is to check that only a
  61815. ** single call to balance_quick() is made for each call to this
  61816. ** function. If this were not verified, a subtle bug involving reuse
  61817. ** of the aBalanceQuickSpace[] might sneak in.
  61818. */
  61819. assert( balance_quick_called==0 );
  61820. VVA_ONLY( balance_quick_called++ );
  61821. rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
  61822. }else
  61823. #endif
  61824. {
  61825. /* In this case, call balance_nonroot() to redistribute cells
  61826. ** between pPage and up to 2 of its sibling pages. This involves
  61827. ** modifying the contents of pParent, which may cause pParent to
  61828. ** become overfull or underfull. The next iteration of the do-loop
  61829. ** will balance the parent page to correct this.
  61830. **
  61831. ** If the parent page becomes overfull, the overflow cell or cells
  61832. ** are stored in the pSpace buffer allocated immediately below.
  61833. ** A subsequent iteration of the do-loop will deal with this by
  61834. ** calling balance_nonroot() (balance_deeper() may be called first,
  61835. ** but it doesn't deal with overflow cells - just moves them to a
  61836. ** different page). Once this subsequent call to balance_nonroot()
  61837. ** has completed, it is safe to release the pSpace buffer used by
  61838. ** the previous call, as the overflow cell data will have been
  61839. ** copied either into the body of a database page or into the new
  61840. ** pSpace buffer passed to the latter call to balance_nonroot().
  61841. */
  61842. u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
  61843. rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1,
  61844. pCur->hints&BTREE_BULKLOAD);
  61845. if( pFree ){
  61846. /* If pFree is not NULL, it points to the pSpace buffer used
  61847. ** by a previous call to balance_nonroot(). Its contents are
  61848. ** now stored either on real database pages or within the
  61849. ** new pSpace buffer, so it may be safely freed here. */
  61850. sqlite3PageFree(pFree);
  61851. }
  61852. /* The pSpace buffer will be freed after the next call to
  61853. ** balance_nonroot(), or just before this function returns, whichever
  61854. ** comes first. */
  61855. pFree = pSpace;
  61856. }
  61857. }
  61858. pPage->nOverflow = 0;
  61859. /* The next iteration of the do-loop balances the parent page. */
  61860. releasePage(pPage);
  61861. pCur->iPage--;
  61862. assert( pCur->iPage>=0 );
  61863. }
  61864. }while( rc==SQLITE_OK );
  61865. if( pFree ){
  61866. sqlite3PageFree(pFree);
  61867. }
  61868. return rc;
  61869. }
  61870. /*
  61871. ** Insert a new record into the BTree. The content of the new record
  61872. ** is described by the pX object. The pCur cursor is used only to
  61873. ** define what table the record should be inserted into, and is left
  61874. ** pointing at a random location.
  61875. **
  61876. ** For a table btree (used for rowid tables), only the pX.nKey value of
  61877. ** the key is used. The pX.pKey value must be NULL. The pX.nKey is the
  61878. ** rowid or INTEGER PRIMARY KEY of the row. The pX.nData,pData,nZero fields
  61879. ** hold the content of the row.
  61880. **
  61881. ** For an index btree (used for indexes and WITHOUT ROWID tables), the
  61882. ** key is an arbitrary byte sequence stored in pX.pKey,nKey. The
  61883. ** pX.pData,nData,nZero fields must be zero.
  61884. **
  61885. ** If the seekResult parameter is non-zero, then a successful call to
  61886. ** MovetoUnpacked() to seek cursor pCur to (pKey, nKey) has already
  61887. ** been performed. seekResult is the search result returned (a negative
  61888. ** number if pCur points at an entry that is smaller than (pKey, nKey), or
  61889. ** a positive value if pCur points at an entry that is larger than
  61890. ** (pKey, nKey)).
  61891. **
  61892. ** If the seekResult parameter is non-zero, then the caller guarantees that
  61893. ** cursor pCur is pointing at the existing copy of a row that is to be
  61894. ** overwritten. If the seekResult parameter is 0, then cursor pCur may
  61895. ** point to any entry or to no entry at all and so this function has to seek
  61896. ** the cursor before the new key can be inserted.
  61897. */
  61898. SQLITE_PRIVATE int sqlite3BtreeInsert(
  61899. BtCursor *pCur, /* Insert data into the table of this cursor */
  61900. const BtreePayload *pX, /* Content of the row to be inserted */
  61901. int appendBias, /* True if this is likely an append */
  61902. int seekResult /* Result of prior MovetoUnpacked() call */
  61903. ){
  61904. int rc;
  61905. int loc = seekResult; /* -1: before desired location +1: after */
  61906. int szNew = 0;
  61907. int idx;
  61908. MemPage *pPage;
  61909. Btree *p = pCur->pBtree;
  61910. BtShared *pBt = p->pBt;
  61911. unsigned char *oldCell;
  61912. unsigned char *newCell = 0;
  61913. if( pCur->eState==CURSOR_FAULT ){
  61914. assert( pCur->skipNext!=SQLITE_OK );
  61915. return pCur->skipNext;
  61916. }
  61917. assert( cursorOwnsBtShared(pCur) );
  61918. assert( (pCur->curFlags & BTCF_WriteFlag)!=0
  61919. && pBt->inTransaction==TRANS_WRITE
  61920. && (pBt->btsFlags & BTS_READ_ONLY)==0 );
  61921. assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
  61922. /* Assert that the caller has been consistent. If this cursor was opened
  61923. ** expecting an index b-tree, then the caller should be inserting blob
  61924. ** keys with no associated data. If the cursor was opened expecting an
  61925. ** intkey table, the caller should be inserting integer keys with a
  61926. ** blob of associated data. */
  61927. assert( (pX->pKey==0)==(pCur->pKeyInfo==0) );
  61928. /* Save the positions of any other cursors open on this table.
  61929. **
  61930. ** In some cases, the call to btreeMoveto() below is a no-op. For
  61931. ** example, when inserting data into a table with auto-generated integer
  61932. ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
  61933. ** integer key to use. It then calls this function to actually insert the
  61934. ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
  61935. ** that the cursor is already where it needs to be and returns without
  61936. ** doing any work. To avoid thwarting these optimizations, it is important
  61937. ** not to clear the cursor here.
  61938. */
  61939. if( pCur->curFlags & BTCF_Multiple ){
  61940. rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
  61941. if( rc ) return rc;
  61942. }
  61943. if( pCur->pKeyInfo==0 ){
  61944. assert( pX->pKey==0 );
  61945. /* If this is an insert into a table b-tree, invalidate any incrblob
  61946. ** cursors open on the row being replaced */
  61947. invalidateIncrblobCursors(p, pX->nKey, 0);
  61948. /* If the cursor is currently on the last row and we are appending a
  61949. ** new row onto the end, set the "loc" to avoid an unnecessary
  61950. ** btreeMoveto() call */
  61951. if( (pCur->curFlags&BTCF_ValidNKey)!=0 && pX->nKey>0
  61952. && pCur->info.nKey==pX->nKey-1 ){
  61953. loc = -1;
  61954. }else if( loc==0 ){
  61955. rc = sqlite3BtreeMovetoUnpacked(pCur, 0, pX->nKey, appendBias, &loc);
  61956. if( rc ) return rc;
  61957. }
  61958. }else if( loc==0 ){
  61959. rc = btreeMoveto(pCur, pX->pKey, pX->nKey, appendBias, &loc);
  61960. if( rc ) return rc;
  61961. }
  61962. assert( pCur->eState==CURSOR_VALID || (pCur->eState==CURSOR_INVALID && loc) );
  61963. pPage = pCur->apPage[pCur->iPage];
  61964. assert( pPage->intKey || pX->nKey>=0 );
  61965. assert( pPage->leaf || !pPage->intKey );
  61966. TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
  61967. pCur->pgnoRoot, pX->nKey, pX->nData, pPage->pgno,
  61968. loc==0 ? "overwrite" : "new entry"));
  61969. assert( pPage->isInit );
  61970. newCell = pBt->pTmpSpace;
  61971. assert( newCell!=0 );
  61972. rc = fillInCell(pPage, newCell, pX, &szNew);
  61973. if( rc ) goto end_insert;
  61974. assert( szNew==pPage->xCellSize(pPage, newCell) );
  61975. assert( szNew <= MX_CELL_SIZE(pBt) );
  61976. idx = pCur->aiIdx[pCur->iPage];
  61977. if( loc==0 ){
  61978. u16 szOld;
  61979. assert( idx<pPage->nCell );
  61980. rc = sqlite3PagerWrite(pPage->pDbPage);
  61981. if( rc ){
  61982. goto end_insert;
  61983. }
  61984. oldCell = findCell(pPage, idx);
  61985. if( !pPage->leaf ){
  61986. memcpy(newCell, oldCell, 4);
  61987. }
  61988. rc = clearCell(pPage, oldCell, &szOld);
  61989. dropCell(pPage, idx, szOld, &rc);
  61990. if( rc ) goto end_insert;
  61991. }else if( loc<0 && pPage->nCell>0 ){
  61992. assert( pPage->leaf );
  61993. idx = ++pCur->aiIdx[pCur->iPage];
  61994. }else{
  61995. assert( pPage->leaf );
  61996. }
  61997. insertCell(pPage, idx, newCell, szNew, 0, 0, &rc);
  61998. assert( pPage->nOverflow==0 || rc==SQLITE_OK );
  61999. assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
  62000. /* If no error has occurred and pPage has an overflow cell, call balance()
  62001. ** to redistribute the cells within the tree. Since balance() may move
  62002. ** the cursor, zero the BtCursor.info.nSize and BTCF_ValidNKey
  62003. ** variables.
  62004. **
  62005. ** Previous versions of SQLite called moveToRoot() to move the cursor
  62006. ** back to the root page as balance() used to invalidate the contents
  62007. ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
  62008. ** set the cursor state to "invalid". This makes common insert operations
  62009. ** slightly faster.
  62010. **
  62011. ** There is a subtle but important optimization here too. When inserting
  62012. ** multiple records into an intkey b-tree using a single cursor (as can
  62013. ** happen while processing an "INSERT INTO ... SELECT" statement), it
  62014. ** is advantageous to leave the cursor pointing to the last entry in
  62015. ** the b-tree if possible. If the cursor is left pointing to the last
  62016. ** entry in the table, and the next row inserted has an integer key
  62017. ** larger than the largest existing key, it is possible to insert the
  62018. ** row without seeking the cursor. This can be a big performance boost.
  62019. */
  62020. pCur->info.nSize = 0;
  62021. if( pPage->nOverflow ){
  62022. assert( rc==SQLITE_OK );
  62023. pCur->curFlags &= ~(BTCF_ValidNKey);
  62024. rc = balance(pCur);
  62025. /* Must make sure nOverflow is reset to zero even if the balance()
  62026. ** fails. Internal data structure corruption will result otherwise.
  62027. ** Also, set the cursor state to invalid. This stops saveCursorPosition()
  62028. ** from trying to save the current position of the cursor. */
  62029. pCur->apPage[pCur->iPage]->nOverflow = 0;
  62030. pCur->eState = CURSOR_INVALID;
  62031. }
  62032. assert( pCur->apPage[pCur->iPage]->nOverflow==0 );
  62033. end_insert:
  62034. return rc;
  62035. }
  62036. /*
  62037. ** Delete the entry that the cursor is pointing to.
  62038. **
  62039. ** If the BTREE_SAVEPOSITION bit of the flags parameter is zero, then
  62040. ** the cursor is left pointing at an arbitrary location after the delete.
  62041. ** But if that bit is set, then the cursor is left in a state such that
  62042. ** the next call to BtreeNext() or BtreePrev() moves it to the same row
  62043. ** as it would have been on if the call to BtreeDelete() had been omitted.
  62044. **
  62045. ** The BTREE_AUXDELETE bit of flags indicates that is one of several deletes
  62046. ** associated with a single table entry and its indexes. Only one of those
  62047. ** deletes is considered the "primary" delete. The primary delete occurs
  62048. ** on a cursor that is not a BTREE_FORDELETE cursor. All but one delete
  62049. ** operation on non-FORDELETE cursors is tagged with the AUXDELETE flag.
  62050. ** The BTREE_AUXDELETE bit is a hint that is not used by this implementation,
  62051. ** but which might be used by alternative storage engines.
  62052. */
  62053. SQLITE_PRIVATE int sqlite3BtreeDelete(BtCursor *pCur, u8 flags){
  62054. Btree *p = pCur->pBtree;
  62055. BtShared *pBt = p->pBt;
  62056. int rc; /* Return code */
  62057. MemPage *pPage; /* Page to delete cell from */
  62058. unsigned char *pCell; /* Pointer to cell to delete */
  62059. int iCellIdx; /* Index of cell to delete */
  62060. int iCellDepth; /* Depth of node containing pCell */
  62061. u16 szCell; /* Size of the cell being deleted */
  62062. int bSkipnext = 0; /* Leaf cursor in SKIPNEXT state */
  62063. u8 bPreserve = flags & BTREE_SAVEPOSITION; /* Keep cursor valid */
  62064. assert( cursorOwnsBtShared(pCur) );
  62065. assert( pBt->inTransaction==TRANS_WRITE );
  62066. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  62067. assert( pCur->curFlags & BTCF_WriteFlag );
  62068. assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
  62069. assert( !hasReadConflicts(p, pCur->pgnoRoot) );
  62070. assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
  62071. assert( pCur->eState==CURSOR_VALID );
  62072. assert( (flags & ~(BTREE_SAVEPOSITION | BTREE_AUXDELETE))==0 );
  62073. iCellDepth = pCur->iPage;
  62074. iCellIdx = pCur->aiIdx[iCellDepth];
  62075. pPage = pCur->apPage[iCellDepth];
  62076. pCell = findCell(pPage, iCellIdx);
  62077. /* If the bPreserve flag is set to true, then the cursor position must
  62078. ** be preserved following this delete operation. If the current delete
  62079. ** will cause a b-tree rebalance, then this is done by saving the cursor
  62080. ** key and leaving the cursor in CURSOR_REQUIRESEEK state before
  62081. ** returning.
  62082. **
  62083. ** Or, if the current delete will not cause a rebalance, then the cursor
  62084. ** will be left in CURSOR_SKIPNEXT state pointing to the entry immediately
  62085. ** before or after the deleted entry. In this case set bSkipnext to true. */
  62086. if( bPreserve ){
  62087. if( !pPage->leaf
  62088. || (pPage->nFree+cellSizePtr(pPage,pCell)+2)>(int)(pBt->usableSize*2/3)
  62089. ){
  62090. /* A b-tree rebalance will be required after deleting this entry.
  62091. ** Save the cursor key. */
  62092. rc = saveCursorKey(pCur);
  62093. if( rc ) return rc;
  62094. }else{
  62095. bSkipnext = 1;
  62096. }
  62097. }
  62098. /* If the page containing the entry to delete is not a leaf page, move
  62099. ** the cursor to the largest entry in the tree that is smaller than
  62100. ** the entry being deleted. This cell will replace the cell being deleted
  62101. ** from the internal node. The 'previous' entry is used for this instead
  62102. ** of the 'next' entry, as the previous entry is always a part of the
  62103. ** sub-tree headed by the child page of the cell being deleted. This makes
  62104. ** balancing the tree following the delete operation easier. */
  62105. if( !pPage->leaf ){
  62106. int notUsed = 0;
  62107. rc = sqlite3BtreePrevious(pCur, &notUsed);
  62108. if( rc ) return rc;
  62109. }
  62110. /* Save the positions of any other cursors open on this table before
  62111. ** making any modifications. */
  62112. if( pCur->curFlags & BTCF_Multiple ){
  62113. rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
  62114. if( rc ) return rc;
  62115. }
  62116. /* If this is a delete operation to remove a row from a table b-tree,
  62117. ** invalidate any incrblob cursors open on the row being deleted. */
  62118. if( pCur->pKeyInfo==0 ){
  62119. invalidateIncrblobCursors(p, pCur->info.nKey, 0);
  62120. }
  62121. /* Make the page containing the entry to be deleted writable. Then free any
  62122. ** overflow pages associated with the entry and finally remove the cell
  62123. ** itself from within the page. */
  62124. rc = sqlite3PagerWrite(pPage->pDbPage);
  62125. if( rc ) return rc;
  62126. rc = clearCell(pPage, pCell, &szCell);
  62127. dropCell(pPage, iCellIdx, szCell, &rc);
  62128. if( rc ) return rc;
  62129. /* If the cell deleted was not located on a leaf page, then the cursor
  62130. ** is currently pointing to the largest entry in the sub-tree headed
  62131. ** by the child-page of the cell that was just deleted from an internal
  62132. ** node. The cell from the leaf node needs to be moved to the internal
  62133. ** node to replace the deleted cell. */
  62134. if( !pPage->leaf ){
  62135. MemPage *pLeaf = pCur->apPage[pCur->iPage];
  62136. int nCell;
  62137. Pgno n = pCur->apPage[iCellDepth+1]->pgno;
  62138. unsigned char *pTmp;
  62139. pCell = findCell(pLeaf, pLeaf->nCell-1);
  62140. if( pCell<&pLeaf->aData[4] ) return SQLITE_CORRUPT_BKPT;
  62141. nCell = pLeaf->xCellSize(pLeaf, pCell);
  62142. assert( MX_CELL_SIZE(pBt) >= nCell );
  62143. pTmp = pBt->pTmpSpace;
  62144. assert( pTmp!=0 );
  62145. rc = sqlite3PagerWrite(pLeaf->pDbPage);
  62146. if( rc==SQLITE_OK ){
  62147. insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n, &rc);
  62148. }
  62149. dropCell(pLeaf, pLeaf->nCell-1, nCell, &rc);
  62150. if( rc ) return rc;
  62151. }
  62152. /* Balance the tree. If the entry deleted was located on a leaf page,
  62153. ** then the cursor still points to that page. In this case the first
  62154. ** call to balance() repairs the tree, and the if(...) condition is
  62155. ** never true.
  62156. **
  62157. ** Otherwise, if the entry deleted was on an internal node page, then
  62158. ** pCur is pointing to the leaf page from which a cell was removed to
  62159. ** replace the cell deleted from the internal node. This is slightly
  62160. ** tricky as the leaf node may be underfull, and the internal node may
  62161. ** be either under or overfull. In this case run the balancing algorithm
  62162. ** on the leaf node first. If the balance proceeds far enough up the
  62163. ** tree that we can be sure that any problem in the internal node has
  62164. ** been corrected, so be it. Otherwise, after balancing the leaf node,
  62165. ** walk the cursor up the tree to the internal node and balance it as
  62166. ** well. */
  62167. rc = balance(pCur);
  62168. if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
  62169. while( pCur->iPage>iCellDepth ){
  62170. releasePage(pCur->apPage[pCur->iPage--]);
  62171. }
  62172. rc = balance(pCur);
  62173. }
  62174. if( rc==SQLITE_OK ){
  62175. if( bSkipnext ){
  62176. assert( bPreserve && (pCur->iPage==iCellDepth || CORRUPT_DB) );
  62177. assert( pPage==pCur->apPage[pCur->iPage] || CORRUPT_DB );
  62178. assert( (pPage->nCell>0 || CORRUPT_DB) && iCellIdx<=pPage->nCell );
  62179. pCur->eState = CURSOR_SKIPNEXT;
  62180. if( iCellIdx>=pPage->nCell ){
  62181. pCur->skipNext = -1;
  62182. pCur->aiIdx[iCellDepth] = pPage->nCell-1;
  62183. }else{
  62184. pCur->skipNext = 1;
  62185. }
  62186. }else{
  62187. rc = moveToRoot(pCur);
  62188. if( bPreserve ){
  62189. pCur->eState = CURSOR_REQUIRESEEK;
  62190. }
  62191. }
  62192. }
  62193. return rc;
  62194. }
  62195. /*
  62196. ** Create a new BTree table. Write into *piTable the page
  62197. ** number for the root page of the new table.
  62198. **
  62199. ** The type of type is determined by the flags parameter. Only the
  62200. ** following values of flags are currently in use. Other values for
  62201. ** flags might not work:
  62202. **
  62203. ** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
  62204. ** BTREE_ZERODATA Used for SQL indices
  62205. */
  62206. static int btreeCreateTable(Btree *p, int *piTable, int createTabFlags){
  62207. BtShared *pBt = p->pBt;
  62208. MemPage *pRoot;
  62209. Pgno pgnoRoot;
  62210. int rc;
  62211. int ptfFlags; /* Page-type flage for the root page of new table */
  62212. assert( sqlite3BtreeHoldsMutex(p) );
  62213. assert( pBt->inTransaction==TRANS_WRITE );
  62214. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  62215. #ifdef SQLITE_OMIT_AUTOVACUUM
  62216. rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
  62217. if( rc ){
  62218. return rc;
  62219. }
  62220. #else
  62221. if( pBt->autoVacuum ){
  62222. Pgno pgnoMove; /* Move a page here to make room for the root-page */
  62223. MemPage *pPageMove; /* The page to move to. */
  62224. /* Creating a new table may probably require moving an existing database
  62225. ** to make room for the new tables root page. In case this page turns
  62226. ** out to be an overflow page, delete all overflow page-map caches
  62227. ** held by open cursors.
  62228. */
  62229. invalidateAllOverflowCache(pBt);
  62230. /* Read the value of meta[3] from the database to determine where the
  62231. ** root page of the new table should go. meta[3] is the largest root-page
  62232. ** created so far, so the new root-page is (meta[3]+1).
  62233. */
  62234. sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
  62235. pgnoRoot++;
  62236. /* The new root-page may not be allocated on a pointer-map page, or the
  62237. ** PENDING_BYTE page.
  62238. */
  62239. while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
  62240. pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
  62241. pgnoRoot++;
  62242. }
  62243. assert( pgnoRoot>=3 || CORRUPT_DB );
  62244. testcase( pgnoRoot<3 );
  62245. /* Allocate a page. The page that currently resides at pgnoRoot will
  62246. ** be moved to the allocated page (unless the allocated page happens
  62247. ** to reside at pgnoRoot).
  62248. */
  62249. rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, BTALLOC_EXACT);
  62250. if( rc!=SQLITE_OK ){
  62251. return rc;
  62252. }
  62253. if( pgnoMove!=pgnoRoot ){
  62254. /* pgnoRoot is the page that will be used for the root-page of
  62255. ** the new table (assuming an error did not occur). But we were
  62256. ** allocated pgnoMove. If required (i.e. if it was not allocated
  62257. ** by extending the file), the current page at position pgnoMove
  62258. ** is already journaled.
  62259. */
  62260. u8 eType = 0;
  62261. Pgno iPtrPage = 0;
  62262. /* Save the positions of any open cursors. This is required in
  62263. ** case they are holding a reference to an xFetch reference
  62264. ** corresponding to page pgnoRoot. */
  62265. rc = saveAllCursors(pBt, 0, 0);
  62266. releasePage(pPageMove);
  62267. if( rc!=SQLITE_OK ){
  62268. return rc;
  62269. }
  62270. /* Move the page currently at pgnoRoot to pgnoMove. */
  62271. rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
  62272. if( rc!=SQLITE_OK ){
  62273. return rc;
  62274. }
  62275. rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
  62276. if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
  62277. rc = SQLITE_CORRUPT_BKPT;
  62278. }
  62279. if( rc!=SQLITE_OK ){
  62280. releasePage(pRoot);
  62281. return rc;
  62282. }
  62283. assert( eType!=PTRMAP_ROOTPAGE );
  62284. assert( eType!=PTRMAP_FREEPAGE );
  62285. rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
  62286. releasePage(pRoot);
  62287. /* Obtain the page at pgnoRoot */
  62288. if( rc!=SQLITE_OK ){
  62289. return rc;
  62290. }
  62291. rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
  62292. if( rc!=SQLITE_OK ){
  62293. return rc;
  62294. }
  62295. rc = sqlite3PagerWrite(pRoot->pDbPage);
  62296. if( rc!=SQLITE_OK ){
  62297. releasePage(pRoot);
  62298. return rc;
  62299. }
  62300. }else{
  62301. pRoot = pPageMove;
  62302. }
  62303. /* Update the pointer-map and meta-data with the new root-page number. */
  62304. ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0, &rc);
  62305. if( rc ){
  62306. releasePage(pRoot);
  62307. return rc;
  62308. }
  62309. /* When the new root page was allocated, page 1 was made writable in
  62310. ** order either to increase the database filesize, or to decrement the
  62311. ** freelist count. Hence, the sqlite3BtreeUpdateMeta() call cannot fail.
  62312. */
  62313. assert( sqlite3PagerIswriteable(pBt->pPage1->pDbPage) );
  62314. rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
  62315. if( NEVER(rc) ){
  62316. releasePage(pRoot);
  62317. return rc;
  62318. }
  62319. }else{
  62320. rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
  62321. if( rc ) return rc;
  62322. }
  62323. #endif
  62324. assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
  62325. if( createTabFlags & BTREE_INTKEY ){
  62326. ptfFlags = PTF_INTKEY | PTF_LEAFDATA | PTF_LEAF;
  62327. }else{
  62328. ptfFlags = PTF_ZERODATA | PTF_LEAF;
  62329. }
  62330. zeroPage(pRoot, ptfFlags);
  62331. sqlite3PagerUnref(pRoot->pDbPage);
  62332. assert( (pBt->openFlags & BTREE_SINGLE)==0 || pgnoRoot==2 );
  62333. *piTable = (int)pgnoRoot;
  62334. return SQLITE_OK;
  62335. }
  62336. SQLITE_PRIVATE int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
  62337. int rc;
  62338. sqlite3BtreeEnter(p);
  62339. rc = btreeCreateTable(p, piTable, flags);
  62340. sqlite3BtreeLeave(p);
  62341. return rc;
  62342. }
  62343. /*
  62344. ** Erase the given database page and all its children. Return
  62345. ** the page to the freelist.
  62346. */
  62347. static int clearDatabasePage(
  62348. BtShared *pBt, /* The BTree that contains the table */
  62349. Pgno pgno, /* Page number to clear */
  62350. int freePageFlag, /* Deallocate page if true */
  62351. int *pnChange /* Add number of Cells freed to this counter */
  62352. ){
  62353. MemPage *pPage;
  62354. int rc;
  62355. unsigned char *pCell;
  62356. int i;
  62357. int hdr;
  62358. u16 szCell;
  62359. assert( sqlite3_mutex_held(pBt->mutex) );
  62360. if( pgno>btreePagecount(pBt) ){
  62361. return SQLITE_CORRUPT_BKPT;
  62362. }
  62363. rc = getAndInitPage(pBt, pgno, &pPage, 0, 0);
  62364. if( rc ) return rc;
  62365. if( pPage->bBusy ){
  62366. rc = SQLITE_CORRUPT_BKPT;
  62367. goto cleardatabasepage_out;
  62368. }
  62369. pPage->bBusy = 1;
  62370. hdr = pPage->hdrOffset;
  62371. for(i=0; i<pPage->nCell; i++){
  62372. pCell = findCell(pPage, i);
  62373. if( !pPage->leaf ){
  62374. rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
  62375. if( rc ) goto cleardatabasepage_out;
  62376. }
  62377. rc = clearCell(pPage, pCell, &szCell);
  62378. if( rc ) goto cleardatabasepage_out;
  62379. }
  62380. if( !pPage->leaf ){
  62381. rc = clearDatabasePage(pBt, get4byte(&pPage->aData[hdr+8]), 1, pnChange);
  62382. if( rc ) goto cleardatabasepage_out;
  62383. }else if( pnChange ){
  62384. assert( pPage->intKey || CORRUPT_DB );
  62385. testcase( !pPage->intKey );
  62386. *pnChange += pPage->nCell;
  62387. }
  62388. if( freePageFlag ){
  62389. freePage(pPage, &rc);
  62390. }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
  62391. zeroPage(pPage, pPage->aData[hdr] | PTF_LEAF);
  62392. }
  62393. cleardatabasepage_out:
  62394. pPage->bBusy = 0;
  62395. releasePage(pPage);
  62396. return rc;
  62397. }
  62398. /*
  62399. ** Delete all information from a single table in the database. iTable is
  62400. ** the page number of the root of the table. After this routine returns,
  62401. ** the root page is empty, but still exists.
  62402. **
  62403. ** This routine will fail with SQLITE_LOCKED if there are any open
  62404. ** read cursors on the table. Open write cursors are moved to the
  62405. ** root of the table.
  62406. **
  62407. ** If pnChange is not NULL, then table iTable must be an intkey table. The
  62408. ** integer value pointed to by pnChange is incremented by the number of
  62409. ** entries in the table.
  62410. */
  62411. SQLITE_PRIVATE int sqlite3BtreeClearTable(Btree *p, int iTable, int *pnChange){
  62412. int rc;
  62413. BtShared *pBt = p->pBt;
  62414. sqlite3BtreeEnter(p);
  62415. assert( p->inTrans==TRANS_WRITE );
  62416. rc = saveAllCursors(pBt, (Pgno)iTable, 0);
  62417. if( SQLITE_OK==rc ){
  62418. /* Invalidate all incrblob cursors open on table iTable (assuming iTable
  62419. ** is the root of a table b-tree - if it is not, the following call is
  62420. ** a no-op). */
  62421. invalidateIncrblobCursors(p, 0, 1);
  62422. rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
  62423. }
  62424. sqlite3BtreeLeave(p);
  62425. return rc;
  62426. }
  62427. /*
  62428. ** Delete all information from the single table that pCur is open on.
  62429. **
  62430. ** This routine only work for pCur on an ephemeral table.
  62431. */
  62432. SQLITE_PRIVATE int sqlite3BtreeClearTableOfCursor(BtCursor *pCur){
  62433. return sqlite3BtreeClearTable(pCur->pBtree, pCur->pgnoRoot, 0);
  62434. }
  62435. /*
  62436. ** Erase all information in a table and add the root of the table to
  62437. ** the freelist. Except, the root of the principle table (the one on
  62438. ** page 1) is never added to the freelist.
  62439. **
  62440. ** This routine will fail with SQLITE_LOCKED if there are any open
  62441. ** cursors on the table.
  62442. **
  62443. ** If AUTOVACUUM is enabled and the page at iTable is not the last
  62444. ** root page in the database file, then the last root page
  62445. ** in the database file is moved into the slot formerly occupied by
  62446. ** iTable and that last slot formerly occupied by the last root page
  62447. ** is added to the freelist instead of iTable. In this say, all
  62448. ** root pages are kept at the beginning of the database file, which
  62449. ** is necessary for AUTOVACUUM to work right. *piMoved is set to the
  62450. ** page number that used to be the last root page in the file before
  62451. ** the move. If no page gets moved, *piMoved is set to 0.
  62452. ** The last root page is recorded in meta[3] and the value of
  62453. ** meta[3] is updated by this procedure.
  62454. */
  62455. static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
  62456. int rc;
  62457. MemPage *pPage = 0;
  62458. BtShared *pBt = p->pBt;
  62459. assert( sqlite3BtreeHoldsMutex(p) );
  62460. assert( p->inTrans==TRANS_WRITE );
  62461. /* It is illegal to drop a table if any cursors are open on the
  62462. ** database. This is because in auto-vacuum mode the backend may
  62463. ** need to move another root-page to fill a gap left by the deleted
  62464. ** root page. If an open cursor was using this page a problem would
  62465. ** occur.
  62466. **
  62467. ** This error is caught long before control reaches this point.
  62468. */
  62469. if( NEVER(pBt->pCursor) ){
  62470. sqlite3ConnectionBlocked(p->db, pBt->pCursor->pBtree->db);
  62471. return SQLITE_LOCKED_SHAREDCACHE;
  62472. }
  62473. /*
  62474. ** It is illegal to drop the sqlite_master table on page 1. But again,
  62475. ** this error is caught long before reaching this point.
  62476. */
  62477. if( NEVER(iTable<2) ){
  62478. return SQLITE_CORRUPT_BKPT;
  62479. }
  62480. rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
  62481. if( rc ) return rc;
  62482. rc = sqlite3BtreeClearTable(p, iTable, 0);
  62483. if( rc ){
  62484. releasePage(pPage);
  62485. return rc;
  62486. }
  62487. *piMoved = 0;
  62488. #ifdef SQLITE_OMIT_AUTOVACUUM
  62489. freePage(pPage, &rc);
  62490. releasePage(pPage);
  62491. #else
  62492. if( pBt->autoVacuum ){
  62493. Pgno maxRootPgno;
  62494. sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
  62495. if( iTable==maxRootPgno ){
  62496. /* If the table being dropped is the table with the largest root-page
  62497. ** number in the database, put the root page on the free list.
  62498. */
  62499. freePage(pPage, &rc);
  62500. releasePage(pPage);
  62501. if( rc!=SQLITE_OK ){
  62502. return rc;
  62503. }
  62504. }else{
  62505. /* The table being dropped does not have the largest root-page
  62506. ** number in the database. So move the page that does into the
  62507. ** gap left by the deleted root-page.
  62508. */
  62509. MemPage *pMove;
  62510. releasePage(pPage);
  62511. rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
  62512. if( rc!=SQLITE_OK ){
  62513. return rc;
  62514. }
  62515. rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
  62516. releasePage(pMove);
  62517. if( rc!=SQLITE_OK ){
  62518. return rc;
  62519. }
  62520. pMove = 0;
  62521. rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
  62522. freePage(pMove, &rc);
  62523. releasePage(pMove);
  62524. if( rc!=SQLITE_OK ){
  62525. return rc;
  62526. }
  62527. *piMoved = maxRootPgno;
  62528. }
  62529. /* Set the new 'max-root-page' value in the database header. This
  62530. ** is the old value less one, less one more if that happens to
  62531. ** be a root-page number, less one again if that is the
  62532. ** PENDING_BYTE_PAGE.
  62533. */
  62534. maxRootPgno--;
  62535. while( maxRootPgno==PENDING_BYTE_PAGE(pBt)
  62536. || PTRMAP_ISPAGE(pBt, maxRootPgno) ){
  62537. maxRootPgno--;
  62538. }
  62539. assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
  62540. rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
  62541. }else{
  62542. freePage(pPage, &rc);
  62543. releasePage(pPage);
  62544. }
  62545. #endif
  62546. return rc;
  62547. }
  62548. SQLITE_PRIVATE int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
  62549. int rc;
  62550. sqlite3BtreeEnter(p);
  62551. rc = btreeDropTable(p, iTable, piMoved);
  62552. sqlite3BtreeLeave(p);
  62553. return rc;
  62554. }
  62555. /*
  62556. ** This function may only be called if the b-tree connection already
  62557. ** has a read or write transaction open on the database.
  62558. **
  62559. ** Read the meta-information out of a database file. Meta[0]
  62560. ** is the number of free pages currently in the database. Meta[1]
  62561. ** through meta[15] are available for use by higher layers. Meta[0]
  62562. ** is read-only, the others are read/write.
  62563. **
  62564. ** The schema layer numbers meta values differently. At the schema
  62565. ** layer (and the SetCookie and ReadCookie opcodes) the number of
  62566. ** free pages is not visible. So Cookie[0] is the same as Meta[1].
  62567. **
  62568. ** This routine treats Meta[BTREE_DATA_VERSION] as a special case. Instead
  62569. ** of reading the value out of the header, it instead loads the "DataVersion"
  62570. ** from the pager. The BTREE_DATA_VERSION value is not actually stored in the
  62571. ** database file. It is a number computed by the pager. But its access
  62572. ** pattern is the same as header meta values, and so it is convenient to
  62573. ** read it from this routine.
  62574. */
  62575. SQLITE_PRIVATE void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
  62576. BtShared *pBt = p->pBt;
  62577. sqlite3BtreeEnter(p);
  62578. assert( p->inTrans>TRANS_NONE );
  62579. assert( SQLITE_OK==querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK) );
  62580. assert( pBt->pPage1 );
  62581. assert( idx>=0 && idx<=15 );
  62582. if( idx==BTREE_DATA_VERSION ){
  62583. *pMeta = sqlite3PagerDataVersion(pBt->pPager) + p->iDataVersion;
  62584. }else{
  62585. *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
  62586. }
  62587. /* If auto-vacuum is disabled in this build and this is an auto-vacuum
  62588. ** database, mark the database as read-only. */
  62589. #ifdef SQLITE_OMIT_AUTOVACUUM
  62590. if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ){
  62591. pBt->btsFlags |= BTS_READ_ONLY;
  62592. }
  62593. #endif
  62594. sqlite3BtreeLeave(p);
  62595. }
  62596. /*
  62597. ** Write meta-information back into the database. Meta[0] is
  62598. ** read-only and may not be written.
  62599. */
  62600. SQLITE_PRIVATE int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
  62601. BtShared *pBt = p->pBt;
  62602. unsigned char *pP1;
  62603. int rc;
  62604. assert( idx>=1 && idx<=15 );
  62605. sqlite3BtreeEnter(p);
  62606. assert( p->inTrans==TRANS_WRITE );
  62607. assert( pBt->pPage1!=0 );
  62608. pP1 = pBt->pPage1->aData;
  62609. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  62610. if( rc==SQLITE_OK ){
  62611. put4byte(&pP1[36 + idx*4], iMeta);
  62612. #ifndef SQLITE_OMIT_AUTOVACUUM
  62613. if( idx==BTREE_INCR_VACUUM ){
  62614. assert( pBt->autoVacuum || iMeta==0 );
  62615. assert( iMeta==0 || iMeta==1 );
  62616. pBt->incrVacuum = (u8)iMeta;
  62617. }
  62618. #endif
  62619. }
  62620. sqlite3BtreeLeave(p);
  62621. return rc;
  62622. }
  62623. #ifndef SQLITE_OMIT_BTREECOUNT
  62624. /*
  62625. ** The first argument, pCur, is a cursor opened on some b-tree. Count the
  62626. ** number of entries in the b-tree and write the result to *pnEntry.
  62627. **
  62628. ** SQLITE_OK is returned if the operation is successfully executed.
  62629. ** Otherwise, if an error is encountered (i.e. an IO error or database
  62630. ** corruption) an SQLite error code is returned.
  62631. */
  62632. SQLITE_PRIVATE int sqlite3BtreeCount(BtCursor *pCur, i64 *pnEntry){
  62633. i64 nEntry = 0; /* Value to return in *pnEntry */
  62634. int rc; /* Return code */
  62635. if( pCur->pgnoRoot==0 ){
  62636. *pnEntry = 0;
  62637. return SQLITE_OK;
  62638. }
  62639. rc = moveToRoot(pCur);
  62640. /* Unless an error occurs, the following loop runs one iteration for each
  62641. ** page in the B-Tree structure (not including overflow pages).
  62642. */
  62643. while( rc==SQLITE_OK ){
  62644. int iIdx; /* Index of child node in parent */
  62645. MemPage *pPage; /* Current page of the b-tree */
  62646. /* If this is a leaf page or the tree is not an int-key tree, then
  62647. ** this page contains countable entries. Increment the entry counter
  62648. ** accordingly.
  62649. */
  62650. pPage = pCur->apPage[pCur->iPage];
  62651. if( pPage->leaf || !pPage->intKey ){
  62652. nEntry += pPage->nCell;
  62653. }
  62654. /* pPage is a leaf node. This loop navigates the cursor so that it
  62655. ** points to the first interior cell that it points to the parent of
  62656. ** the next page in the tree that has not yet been visited. The
  62657. ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
  62658. ** of the page, or to the number of cells in the page if the next page
  62659. ** to visit is the right-child of its parent.
  62660. **
  62661. ** If all pages in the tree have been visited, return SQLITE_OK to the
  62662. ** caller.
  62663. */
  62664. if( pPage->leaf ){
  62665. do {
  62666. if( pCur->iPage==0 ){
  62667. /* All pages of the b-tree have been visited. Return successfully. */
  62668. *pnEntry = nEntry;
  62669. return moveToRoot(pCur);
  62670. }
  62671. moveToParent(pCur);
  62672. }while ( pCur->aiIdx[pCur->iPage]>=pCur->apPage[pCur->iPage]->nCell );
  62673. pCur->aiIdx[pCur->iPage]++;
  62674. pPage = pCur->apPage[pCur->iPage];
  62675. }
  62676. /* Descend to the child node of the cell that the cursor currently
  62677. ** points at. This is the right-child if (iIdx==pPage->nCell).
  62678. */
  62679. iIdx = pCur->aiIdx[pCur->iPage];
  62680. if( iIdx==pPage->nCell ){
  62681. rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
  62682. }else{
  62683. rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
  62684. }
  62685. }
  62686. /* An error has occurred. Return an error code. */
  62687. return rc;
  62688. }
  62689. #endif
  62690. /*
  62691. ** Return the pager associated with a BTree. This routine is used for
  62692. ** testing and debugging only.
  62693. */
  62694. SQLITE_PRIVATE Pager *sqlite3BtreePager(Btree *p){
  62695. return p->pBt->pPager;
  62696. }
  62697. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  62698. /*
  62699. ** Append a message to the error message string.
  62700. */
  62701. static void checkAppendMsg(
  62702. IntegrityCk *pCheck,
  62703. const char *zFormat,
  62704. ...
  62705. ){
  62706. va_list ap;
  62707. if( !pCheck->mxErr ) return;
  62708. pCheck->mxErr--;
  62709. pCheck->nErr++;
  62710. va_start(ap, zFormat);
  62711. if( pCheck->errMsg.nChar ){
  62712. sqlite3StrAccumAppend(&pCheck->errMsg, "\n", 1);
  62713. }
  62714. if( pCheck->zPfx ){
  62715. sqlite3XPrintf(&pCheck->errMsg, pCheck->zPfx, pCheck->v1, pCheck->v2);
  62716. }
  62717. sqlite3VXPrintf(&pCheck->errMsg, zFormat, ap);
  62718. va_end(ap);
  62719. if( pCheck->errMsg.accError==STRACCUM_NOMEM ){
  62720. pCheck->mallocFailed = 1;
  62721. }
  62722. }
  62723. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  62724. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  62725. /*
  62726. ** Return non-zero if the bit in the IntegrityCk.aPgRef[] array that
  62727. ** corresponds to page iPg is already set.
  62728. */
  62729. static int getPageReferenced(IntegrityCk *pCheck, Pgno iPg){
  62730. assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
  62731. return (pCheck->aPgRef[iPg/8] & (1 << (iPg & 0x07)));
  62732. }
  62733. /*
  62734. ** Set the bit in the IntegrityCk.aPgRef[] array that corresponds to page iPg.
  62735. */
  62736. static void setPageReferenced(IntegrityCk *pCheck, Pgno iPg){
  62737. assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
  62738. pCheck->aPgRef[iPg/8] |= (1 << (iPg & 0x07));
  62739. }
  62740. /*
  62741. ** Add 1 to the reference count for page iPage. If this is the second
  62742. ** reference to the page, add an error message to pCheck->zErrMsg.
  62743. ** Return 1 if there are 2 or more references to the page and 0 if
  62744. ** if this is the first reference to the page.
  62745. **
  62746. ** Also check that the page number is in bounds.
  62747. */
  62748. static int checkRef(IntegrityCk *pCheck, Pgno iPage){
  62749. if( iPage==0 ) return 1;
  62750. if( iPage>pCheck->nPage ){
  62751. checkAppendMsg(pCheck, "invalid page number %d", iPage);
  62752. return 1;
  62753. }
  62754. if( getPageReferenced(pCheck, iPage) ){
  62755. checkAppendMsg(pCheck, "2nd reference to page %d", iPage);
  62756. return 1;
  62757. }
  62758. setPageReferenced(pCheck, iPage);
  62759. return 0;
  62760. }
  62761. #ifndef SQLITE_OMIT_AUTOVACUUM
  62762. /*
  62763. ** Check that the entry in the pointer-map for page iChild maps to
  62764. ** page iParent, pointer type ptrType. If not, append an error message
  62765. ** to pCheck.
  62766. */
  62767. static void checkPtrmap(
  62768. IntegrityCk *pCheck, /* Integrity check context */
  62769. Pgno iChild, /* Child page number */
  62770. u8 eType, /* Expected pointer map type */
  62771. Pgno iParent /* Expected pointer map parent page number */
  62772. ){
  62773. int rc;
  62774. u8 ePtrmapType;
  62775. Pgno iPtrmapParent;
  62776. rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
  62777. if( rc!=SQLITE_OK ){
  62778. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
  62779. checkAppendMsg(pCheck, "Failed to read ptrmap key=%d", iChild);
  62780. return;
  62781. }
  62782. if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
  62783. checkAppendMsg(pCheck,
  62784. "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
  62785. iChild, eType, iParent, ePtrmapType, iPtrmapParent);
  62786. }
  62787. }
  62788. #endif
  62789. /*
  62790. ** Check the integrity of the freelist or of an overflow page list.
  62791. ** Verify that the number of pages on the list is N.
  62792. */
  62793. static void checkList(
  62794. IntegrityCk *pCheck, /* Integrity checking context */
  62795. int isFreeList, /* True for a freelist. False for overflow page list */
  62796. int iPage, /* Page number for first page in the list */
  62797. int N /* Expected number of pages in the list */
  62798. ){
  62799. int i;
  62800. int expected = N;
  62801. int iFirst = iPage;
  62802. while( N-- > 0 && pCheck->mxErr ){
  62803. DbPage *pOvflPage;
  62804. unsigned char *pOvflData;
  62805. if( iPage<1 ){
  62806. checkAppendMsg(pCheck,
  62807. "%d of %d pages missing from overflow list starting at %d",
  62808. N+1, expected, iFirst);
  62809. break;
  62810. }
  62811. if( checkRef(pCheck, iPage) ) break;
  62812. if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage, 0) ){
  62813. checkAppendMsg(pCheck, "failed to get page %d", iPage);
  62814. break;
  62815. }
  62816. pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
  62817. if( isFreeList ){
  62818. int n = get4byte(&pOvflData[4]);
  62819. #ifndef SQLITE_OMIT_AUTOVACUUM
  62820. if( pCheck->pBt->autoVacuum ){
  62821. checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0);
  62822. }
  62823. #endif
  62824. if( n>(int)pCheck->pBt->usableSize/4-2 ){
  62825. checkAppendMsg(pCheck,
  62826. "freelist leaf count too big on page %d", iPage);
  62827. N--;
  62828. }else{
  62829. for(i=0; i<n; i++){
  62830. Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
  62831. #ifndef SQLITE_OMIT_AUTOVACUUM
  62832. if( pCheck->pBt->autoVacuum ){
  62833. checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0);
  62834. }
  62835. #endif
  62836. checkRef(pCheck, iFreePage);
  62837. }
  62838. N -= n;
  62839. }
  62840. }
  62841. #ifndef SQLITE_OMIT_AUTOVACUUM
  62842. else{
  62843. /* If this database supports auto-vacuum and iPage is not the last
  62844. ** page in this overflow list, check that the pointer-map entry for
  62845. ** the following page matches iPage.
  62846. */
  62847. if( pCheck->pBt->autoVacuum && N>0 ){
  62848. i = get4byte(pOvflData);
  62849. checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage);
  62850. }
  62851. }
  62852. #endif
  62853. iPage = get4byte(pOvflData);
  62854. sqlite3PagerUnref(pOvflPage);
  62855. if( isFreeList && N<(iPage!=0) ){
  62856. checkAppendMsg(pCheck, "free-page count in header is too small");
  62857. }
  62858. }
  62859. }
  62860. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  62861. /*
  62862. ** An implementation of a min-heap.
  62863. **
  62864. ** aHeap[0] is the number of elements on the heap. aHeap[1] is the
  62865. ** root element. The daughter nodes of aHeap[N] are aHeap[N*2]
  62866. ** and aHeap[N*2+1].
  62867. **
  62868. ** The heap property is this: Every node is less than or equal to both
  62869. ** of its daughter nodes. A consequence of the heap property is that the
  62870. ** root node aHeap[1] is always the minimum value currently in the heap.
  62871. **
  62872. ** The btreeHeapInsert() routine inserts an unsigned 32-bit number onto
  62873. ** the heap, preserving the heap property. The btreeHeapPull() routine
  62874. ** removes the root element from the heap (the minimum value in the heap)
  62875. ** and then moves other nodes around as necessary to preserve the heap
  62876. ** property.
  62877. **
  62878. ** This heap is used for cell overlap and coverage testing. Each u32
  62879. ** entry represents the span of a cell or freeblock on a btree page.
  62880. ** The upper 16 bits are the index of the first byte of a range and the
  62881. ** lower 16 bits are the index of the last byte of that range.
  62882. */
  62883. static void btreeHeapInsert(u32 *aHeap, u32 x){
  62884. u32 j, i = ++aHeap[0];
  62885. aHeap[i] = x;
  62886. while( (j = i/2)>0 && aHeap[j]>aHeap[i] ){
  62887. x = aHeap[j];
  62888. aHeap[j] = aHeap[i];
  62889. aHeap[i] = x;
  62890. i = j;
  62891. }
  62892. }
  62893. static int btreeHeapPull(u32 *aHeap, u32 *pOut){
  62894. u32 j, i, x;
  62895. if( (x = aHeap[0])==0 ) return 0;
  62896. *pOut = aHeap[1];
  62897. aHeap[1] = aHeap[x];
  62898. aHeap[x] = 0xffffffff;
  62899. aHeap[0]--;
  62900. i = 1;
  62901. while( (j = i*2)<=aHeap[0] ){
  62902. if( aHeap[j]>aHeap[j+1] ) j++;
  62903. if( aHeap[i]<aHeap[j] ) break;
  62904. x = aHeap[i];
  62905. aHeap[i] = aHeap[j];
  62906. aHeap[j] = x;
  62907. i = j;
  62908. }
  62909. return 1;
  62910. }
  62911. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  62912. /*
  62913. ** Do various sanity checks on a single page of a tree. Return
  62914. ** the tree depth. Root pages return 0. Parents of root pages
  62915. ** return 1, and so forth.
  62916. **
  62917. ** These checks are done:
  62918. **
  62919. ** 1. Make sure that cells and freeblocks do not overlap
  62920. ** but combine to completely cover the page.
  62921. ** 2. Make sure integer cell keys are in order.
  62922. ** 3. Check the integrity of overflow pages.
  62923. ** 4. Recursively call checkTreePage on all children.
  62924. ** 5. Verify that the depth of all children is the same.
  62925. */
  62926. static int checkTreePage(
  62927. IntegrityCk *pCheck, /* Context for the sanity check */
  62928. int iPage, /* Page number of the page to check */
  62929. i64 *piMinKey, /* Write minimum integer primary key here */
  62930. i64 maxKey /* Error if integer primary key greater than this */
  62931. ){
  62932. MemPage *pPage = 0; /* The page being analyzed */
  62933. int i; /* Loop counter */
  62934. int rc; /* Result code from subroutine call */
  62935. int depth = -1, d2; /* Depth of a subtree */
  62936. int pgno; /* Page number */
  62937. int nFrag; /* Number of fragmented bytes on the page */
  62938. int hdr; /* Offset to the page header */
  62939. int cellStart; /* Offset to the start of the cell pointer array */
  62940. int nCell; /* Number of cells */
  62941. int doCoverageCheck = 1; /* True if cell coverage checking should be done */
  62942. int keyCanBeEqual = 1; /* True if IPK can be equal to maxKey
  62943. ** False if IPK must be strictly less than maxKey */
  62944. u8 *data; /* Page content */
  62945. u8 *pCell; /* Cell content */
  62946. u8 *pCellIdx; /* Next element of the cell pointer array */
  62947. BtShared *pBt; /* The BtShared object that owns pPage */
  62948. u32 pc; /* Address of a cell */
  62949. u32 usableSize; /* Usable size of the page */
  62950. u32 contentOffset; /* Offset to the start of the cell content area */
  62951. u32 *heap = 0; /* Min-heap used for checking cell coverage */
  62952. u32 x, prev = 0; /* Next and previous entry on the min-heap */
  62953. const char *saved_zPfx = pCheck->zPfx;
  62954. int saved_v1 = pCheck->v1;
  62955. int saved_v2 = pCheck->v2;
  62956. u8 savedIsInit = 0;
  62957. /* Check that the page exists
  62958. */
  62959. pBt = pCheck->pBt;
  62960. usableSize = pBt->usableSize;
  62961. if( iPage==0 ) return 0;
  62962. if( checkRef(pCheck, iPage) ) return 0;
  62963. pCheck->zPfx = "Page %d: ";
  62964. pCheck->v1 = iPage;
  62965. if( (rc = btreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
  62966. checkAppendMsg(pCheck,
  62967. "unable to get the page. error code=%d", rc);
  62968. goto end_of_check;
  62969. }
  62970. /* Clear MemPage.isInit to make sure the corruption detection code in
  62971. ** btreeInitPage() is executed. */
  62972. savedIsInit = pPage->isInit;
  62973. pPage->isInit = 0;
  62974. if( (rc = btreeInitPage(pPage))!=0 ){
  62975. assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
  62976. checkAppendMsg(pCheck,
  62977. "btreeInitPage() returns error code %d", rc);
  62978. goto end_of_check;
  62979. }
  62980. data = pPage->aData;
  62981. hdr = pPage->hdrOffset;
  62982. /* Set up for cell analysis */
  62983. pCheck->zPfx = "On tree page %d cell %d: ";
  62984. contentOffset = get2byteNotZero(&data[hdr+5]);
  62985. assert( contentOffset<=usableSize ); /* Enforced by btreeInitPage() */
  62986. /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
  62987. ** number of cells on the page. */
  62988. nCell = get2byte(&data[hdr+3]);
  62989. assert( pPage->nCell==nCell );
  62990. /* EVIDENCE-OF: R-23882-45353 The cell pointer array of a b-tree page
  62991. ** immediately follows the b-tree page header. */
  62992. cellStart = hdr + 12 - 4*pPage->leaf;
  62993. assert( pPage->aCellIdx==&data[cellStart] );
  62994. pCellIdx = &data[cellStart + 2*(nCell-1)];
  62995. if( !pPage->leaf ){
  62996. /* Analyze the right-child page of internal pages */
  62997. pgno = get4byte(&data[hdr+8]);
  62998. #ifndef SQLITE_OMIT_AUTOVACUUM
  62999. if( pBt->autoVacuum ){
  63000. pCheck->zPfx = "On page %d at right child: ";
  63001. checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
  63002. }
  63003. #endif
  63004. depth = checkTreePage(pCheck, pgno, &maxKey, maxKey);
  63005. keyCanBeEqual = 0;
  63006. }else{
  63007. /* For leaf pages, the coverage check will occur in the same loop
  63008. ** as the other cell checks, so initialize the heap. */
  63009. heap = pCheck->heap;
  63010. heap[0] = 0;
  63011. }
  63012. /* EVIDENCE-OF: R-02776-14802 The cell pointer array consists of K 2-byte
  63013. ** integer offsets to the cell contents. */
  63014. for(i=nCell-1; i>=0 && pCheck->mxErr; i--){
  63015. CellInfo info;
  63016. /* Check cell size */
  63017. pCheck->v2 = i;
  63018. assert( pCellIdx==&data[cellStart + i*2] );
  63019. pc = get2byteAligned(pCellIdx);
  63020. pCellIdx -= 2;
  63021. if( pc<contentOffset || pc>usableSize-4 ){
  63022. checkAppendMsg(pCheck, "Offset %d out of range %d..%d",
  63023. pc, contentOffset, usableSize-4);
  63024. doCoverageCheck = 0;
  63025. continue;
  63026. }
  63027. pCell = &data[pc];
  63028. pPage->xParseCell(pPage, pCell, &info);
  63029. if( pc+info.nSize>usableSize ){
  63030. checkAppendMsg(pCheck, "Extends off end of page");
  63031. doCoverageCheck = 0;
  63032. continue;
  63033. }
  63034. /* Check for integer primary key out of range */
  63035. if( pPage->intKey ){
  63036. if( keyCanBeEqual ? (info.nKey > maxKey) : (info.nKey >= maxKey) ){
  63037. checkAppendMsg(pCheck, "Rowid %lld out of order", info.nKey);
  63038. }
  63039. maxKey = info.nKey;
  63040. }
  63041. /* Check the content overflow list */
  63042. if( info.nPayload>info.nLocal ){
  63043. int nPage; /* Number of pages on the overflow chain */
  63044. Pgno pgnoOvfl; /* First page of the overflow chain */
  63045. assert( pc + info.nSize - 4 <= usableSize );
  63046. nPage = (info.nPayload - info.nLocal + usableSize - 5)/(usableSize - 4);
  63047. pgnoOvfl = get4byte(&pCell[info.nSize - 4]);
  63048. #ifndef SQLITE_OMIT_AUTOVACUUM
  63049. if( pBt->autoVacuum ){
  63050. checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage);
  63051. }
  63052. #endif
  63053. checkList(pCheck, 0, pgnoOvfl, nPage);
  63054. }
  63055. if( !pPage->leaf ){
  63056. /* Check sanity of left child page for internal pages */
  63057. pgno = get4byte(pCell);
  63058. #ifndef SQLITE_OMIT_AUTOVACUUM
  63059. if( pBt->autoVacuum ){
  63060. checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
  63061. }
  63062. #endif
  63063. d2 = checkTreePage(pCheck, pgno, &maxKey, maxKey);
  63064. keyCanBeEqual = 0;
  63065. if( d2!=depth ){
  63066. checkAppendMsg(pCheck, "Child page depth differs");
  63067. depth = d2;
  63068. }
  63069. }else{
  63070. /* Populate the coverage-checking heap for leaf pages */
  63071. btreeHeapInsert(heap, (pc<<16)|(pc+info.nSize-1));
  63072. }
  63073. }
  63074. *piMinKey = maxKey;
  63075. /* Check for complete coverage of the page
  63076. */
  63077. pCheck->zPfx = 0;
  63078. if( doCoverageCheck && pCheck->mxErr>0 ){
  63079. /* For leaf pages, the min-heap has already been initialized and the
  63080. ** cells have already been inserted. But for internal pages, that has
  63081. ** not yet been done, so do it now */
  63082. if( !pPage->leaf ){
  63083. heap = pCheck->heap;
  63084. heap[0] = 0;
  63085. for(i=nCell-1; i>=0; i--){
  63086. u32 size;
  63087. pc = get2byteAligned(&data[cellStart+i*2]);
  63088. size = pPage->xCellSize(pPage, &data[pc]);
  63089. btreeHeapInsert(heap, (pc<<16)|(pc+size-1));
  63090. }
  63091. }
  63092. /* Add the freeblocks to the min-heap
  63093. **
  63094. ** EVIDENCE-OF: R-20690-50594 The second field of the b-tree page header
  63095. ** is the offset of the first freeblock, or zero if there are no
  63096. ** freeblocks on the page.
  63097. */
  63098. i = get2byte(&data[hdr+1]);
  63099. while( i>0 ){
  63100. int size, j;
  63101. assert( (u32)i<=usableSize-4 ); /* Enforced by btreeInitPage() */
  63102. size = get2byte(&data[i+2]);
  63103. assert( (u32)(i+size)<=usableSize ); /* Enforced by btreeInitPage() */
  63104. btreeHeapInsert(heap, (((u32)i)<<16)|(i+size-1));
  63105. /* EVIDENCE-OF: R-58208-19414 The first 2 bytes of a freeblock are a
  63106. ** big-endian integer which is the offset in the b-tree page of the next
  63107. ** freeblock in the chain, or zero if the freeblock is the last on the
  63108. ** chain. */
  63109. j = get2byte(&data[i]);
  63110. /* EVIDENCE-OF: R-06866-39125 Freeblocks are always connected in order of
  63111. ** increasing offset. */
  63112. assert( j==0 || j>i+size ); /* Enforced by btreeInitPage() */
  63113. assert( (u32)j<=usableSize-4 ); /* Enforced by btreeInitPage() */
  63114. i = j;
  63115. }
  63116. /* Analyze the min-heap looking for overlap between cells and/or
  63117. ** freeblocks, and counting the number of untracked bytes in nFrag.
  63118. **
  63119. ** Each min-heap entry is of the form: (start_address<<16)|end_address.
  63120. ** There is an implied first entry the covers the page header, the cell
  63121. ** pointer index, and the gap between the cell pointer index and the start
  63122. ** of cell content.
  63123. **
  63124. ** The loop below pulls entries from the min-heap in order and compares
  63125. ** the start_address against the previous end_address. If there is an
  63126. ** overlap, that means bytes are used multiple times. If there is a gap,
  63127. ** that gap is added to the fragmentation count.
  63128. */
  63129. nFrag = 0;
  63130. prev = contentOffset - 1; /* Implied first min-heap entry */
  63131. while( btreeHeapPull(heap,&x) ){
  63132. if( (prev&0xffff)>=(x>>16) ){
  63133. checkAppendMsg(pCheck,
  63134. "Multiple uses for byte %u of page %d", x>>16, iPage);
  63135. break;
  63136. }else{
  63137. nFrag += (x>>16) - (prev&0xffff) - 1;
  63138. prev = x;
  63139. }
  63140. }
  63141. nFrag += usableSize - (prev&0xffff) - 1;
  63142. /* EVIDENCE-OF: R-43263-13491 The total number of bytes in all fragments
  63143. ** is stored in the fifth field of the b-tree page header.
  63144. ** EVIDENCE-OF: R-07161-27322 The one-byte integer at offset 7 gives the
  63145. ** number of fragmented free bytes within the cell content area.
  63146. */
  63147. if( heap[0]==0 && nFrag!=data[hdr+7] ){
  63148. checkAppendMsg(pCheck,
  63149. "Fragmentation of %d bytes reported as %d on page %d",
  63150. nFrag, data[hdr+7], iPage);
  63151. }
  63152. }
  63153. end_of_check:
  63154. if( !doCoverageCheck ) pPage->isInit = savedIsInit;
  63155. releasePage(pPage);
  63156. pCheck->zPfx = saved_zPfx;
  63157. pCheck->v1 = saved_v1;
  63158. pCheck->v2 = saved_v2;
  63159. return depth+1;
  63160. }
  63161. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  63162. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  63163. /*
  63164. ** This routine does a complete check of the given BTree file. aRoot[] is
  63165. ** an array of pages numbers were each page number is the root page of
  63166. ** a table. nRoot is the number of entries in aRoot.
  63167. **
  63168. ** A read-only or read-write transaction must be opened before calling
  63169. ** this function.
  63170. **
  63171. ** Write the number of error seen in *pnErr. Except for some memory
  63172. ** allocation errors, an error message held in memory obtained from
  63173. ** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
  63174. ** returned. If a memory allocation error occurs, NULL is returned.
  63175. */
  63176. SQLITE_PRIVATE char *sqlite3BtreeIntegrityCheck(
  63177. Btree *p, /* The btree to be checked */
  63178. int *aRoot, /* An array of root pages numbers for individual trees */
  63179. int nRoot, /* Number of entries in aRoot[] */
  63180. int mxErr, /* Stop reporting errors after this many */
  63181. int *pnErr /* Write number of errors seen to this variable */
  63182. ){
  63183. Pgno i;
  63184. IntegrityCk sCheck;
  63185. BtShared *pBt = p->pBt;
  63186. int savedDbFlags = pBt->db->flags;
  63187. char zErr[100];
  63188. VVA_ONLY( int nRef );
  63189. sqlite3BtreeEnter(p);
  63190. assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
  63191. VVA_ONLY( nRef = sqlite3PagerRefcount(pBt->pPager) );
  63192. assert( nRef>=0 );
  63193. sCheck.pBt = pBt;
  63194. sCheck.pPager = pBt->pPager;
  63195. sCheck.nPage = btreePagecount(sCheck.pBt);
  63196. sCheck.mxErr = mxErr;
  63197. sCheck.nErr = 0;
  63198. sCheck.mallocFailed = 0;
  63199. sCheck.zPfx = 0;
  63200. sCheck.v1 = 0;
  63201. sCheck.v2 = 0;
  63202. sCheck.aPgRef = 0;
  63203. sCheck.heap = 0;
  63204. sqlite3StrAccumInit(&sCheck.errMsg, 0, zErr, sizeof(zErr), SQLITE_MAX_LENGTH);
  63205. sCheck.errMsg.printfFlags = SQLITE_PRINTF_INTERNAL;
  63206. if( sCheck.nPage==0 ){
  63207. goto integrity_ck_cleanup;
  63208. }
  63209. sCheck.aPgRef = sqlite3MallocZero((sCheck.nPage / 8)+ 1);
  63210. if( !sCheck.aPgRef ){
  63211. sCheck.mallocFailed = 1;
  63212. goto integrity_ck_cleanup;
  63213. }
  63214. sCheck.heap = (u32*)sqlite3PageMalloc( pBt->pageSize );
  63215. if( sCheck.heap==0 ){
  63216. sCheck.mallocFailed = 1;
  63217. goto integrity_ck_cleanup;
  63218. }
  63219. i = PENDING_BYTE_PAGE(pBt);
  63220. if( i<=sCheck.nPage ) setPageReferenced(&sCheck, i);
  63221. /* Check the integrity of the freelist
  63222. */
  63223. sCheck.zPfx = "Main freelist: ";
  63224. checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
  63225. get4byte(&pBt->pPage1->aData[36]));
  63226. sCheck.zPfx = 0;
  63227. /* Check all the tables.
  63228. */
  63229. testcase( pBt->db->flags & SQLITE_CellSizeCk );
  63230. pBt->db->flags &= ~SQLITE_CellSizeCk;
  63231. for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
  63232. i64 notUsed;
  63233. if( aRoot[i]==0 ) continue;
  63234. #ifndef SQLITE_OMIT_AUTOVACUUM
  63235. if( pBt->autoVacuum && aRoot[i]>1 ){
  63236. checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0);
  63237. }
  63238. #endif
  63239. checkTreePage(&sCheck, aRoot[i], &notUsed, LARGEST_INT64);
  63240. }
  63241. pBt->db->flags = savedDbFlags;
  63242. /* Make sure every page in the file is referenced
  63243. */
  63244. for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
  63245. #ifdef SQLITE_OMIT_AUTOVACUUM
  63246. if( getPageReferenced(&sCheck, i)==0 ){
  63247. checkAppendMsg(&sCheck, "Page %d is never used", i);
  63248. }
  63249. #else
  63250. /* If the database supports auto-vacuum, make sure no tables contain
  63251. ** references to pointer-map pages.
  63252. */
  63253. if( getPageReferenced(&sCheck, i)==0 &&
  63254. (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
  63255. checkAppendMsg(&sCheck, "Page %d is never used", i);
  63256. }
  63257. if( getPageReferenced(&sCheck, i)!=0 &&
  63258. (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
  63259. checkAppendMsg(&sCheck, "Pointer map page %d is referenced", i);
  63260. }
  63261. #endif
  63262. }
  63263. /* Clean up and report errors.
  63264. */
  63265. integrity_ck_cleanup:
  63266. sqlite3PageFree(sCheck.heap);
  63267. sqlite3_free(sCheck.aPgRef);
  63268. if( sCheck.mallocFailed ){
  63269. sqlite3StrAccumReset(&sCheck.errMsg);
  63270. sCheck.nErr++;
  63271. }
  63272. *pnErr = sCheck.nErr;
  63273. if( sCheck.nErr==0 ) sqlite3StrAccumReset(&sCheck.errMsg);
  63274. /* Make sure this analysis did not leave any unref() pages. */
  63275. assert( nRef==sqlite3PagerRefcount(pBt->pPager) );
  63276. sqlite3BtreeLeave(p);
  63277. return sqlite3StrAccumFinish(&sCheck.errMsg);
  63278. }
  63279. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  63280. /*
  63281. ** Return the full pathname of the underlying database file. Return
  63282. ** an empty string if the database is in-memory or a TEMP database.
  63283. **
  63284. ** The pager filename is invariant as long as the pager is
  63285. ** open so it is safe to access without the BtShared mutex.
  63286. */
  63287. SQLITE_PRIVATE const char *sqlite3BtreeGetFilename(Btree *p){
  63288. assert( p->pBt->pPager!=0 );
  63289. return sqlite3PagerFilename(p->pBt->pPager, 1);
  63290. }
  63291. /*
  63292. ** Return the pathname of the journal file for this database. The return
  63293. ** value of this routine is the same regardless of whether the journal file
  63294. ** has been created or not.
  63295. **
  63296. ** The pager journal filename is invariant as long as the pager is
  63297. ** open so it is safe to access without the BtShared mutex.
  63298. */
  63299. SQLITE_PRIVATE const char *sqlite3BtreeGetJournalname(Btree *p){
  63300. assert( p->pBt->pPager!=0 );
  63301. return sqlite3PagerJournalname(p->pBt->pPager);
  63302. }
  63303. /*
  63304. ** Return non-zero if a transaction is active.
  63305. */
  63306. SQLITE_PRIVATE int sqlite3BtreeIsInTrans(Btree *p){
  63307. assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
  63308. return (p && (p->inTrans==TRANS_WRITE));
  63309. }
  63310. #ifndef SQLITE_OMIT_WAL
  63311. /*
  63312. ** Run a checkpoint on the Btree passed as the first argument.
  63313. **
  63314. ** Return SQLITE_LOCKED if this or any other connection has an open
  63315. ** transaction on the shared-cache the argument Btree is connected to.
  63316. **
  63317. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
  63318. */
  63319. SQLITE_PRIVATE int sqlite3BtreeCheckpoint(Btree *p, int eMode, int *pnLog, int *pnCkpt){
  63320. int rc = SQLITE_OK;
  63321. if( p ){
  63322. BtShared *pBt = p->pBt;
  63323. sqlite3BtreeEnter(p);
  63324. if( pBt->inTransaction!=TRANS_NONE ){
  63325. rc = SQLITE_LOCKED;
  63326. }else{
  63327. rc = sqlite3PagerCheckpoint(pBt->pPager, eMode, pnLog, pnCkpt);
  63328. }
  63329. sqlite3BtreeLeave(p);
  63330. }
  63331. return rc;
  63332. }
  63333. #endif
  63334. /*
  63335. ** Return non-zero if a read (or write) transaction is active.
  63336. */
  63337. SQLITE_PRIVATE int sqlite3BtreeIsInReadTrans(Btree *p){
  63338. assert( p );
  63339. assert( sqlite3_mutex_held(p->db->mutex) );
  63340. return p->inTrans!=TRANS_NONE;
  63341. }
  63342. SQLITE_PRIVATE int sqlite3BtreeIsInBackup(Btree *p){
  63343. assert( p );
  63344. assert( sqlite3_mutex_held(p->db->mutex) );
  63345. return p->nBackup!=0;
  63346. }
  63347. /*
  63348. ** This function returns a pointer to a blob of memory associated with
  63349. ** a single shared-btree. The memory is used by client code for its own
  63350. ** purposes (for example, to store a high-level schema associated with
  63351. ** the shared-btree). The btree layer manages reference counting issues.
  63352. **
  63353. ** The first time this is called on a shared-btree, nBytes bytes of memory
  63354. ** are allocated, zeroed, and returned to the caller. For each subsequent
  63355. ** call the nBytes parameter is ignored and a pointer to the same blob
  63356. ** of memory returned.
  63357. **
  63358. ** If the nBytes parameter is 0 and the blob of memory has not yet been
  63359. ** allocated, a null pointer is returned. If the blob has already been
  63360. ** allocated, it is returned as normal.
  63361. **
  63362. ** Just before the shared-btree is closed, the function passed as the
  63363. ** xFree argument when the memory allocation was made is invoked on the
  63364. ** blob of allocated memory. The xFree function should not call sqlite3_free()
  63365. ** on the memory, the btree layer does that.
  63366. */
  63367. SQLITE_PRIVATE void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
  63368. BtShared *pBt = p->pBt;
  63369. sqlite3BtreeEnter(p);
  63370. if( !pBt->pSchema && nBytes ){
  63371. pBt->pSchema = sqlite3DbMallocZero(0, nBytes);
  63372. pBt->xFreeSchema = xFree;
  63373. }
  63374. sqlite3BtreeLeave(p);
  63375. return pBt->pSchema;
  63376. }
  63377. /*
  63378. ** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
  63379. ** btree as the argument handle holds an exclusive lock on the
  63380. ** sqlite_master table. Otherwise SQLITE_OK.
  63381. */
  63382. SQLITE_PRIVATE int sqlite3BtreeSchemaLocked(Btree *p){
  63383. int rc;
  63384. assert( sqlite3_mutex_held(p->db->mutex) );
  63385. sqlite3BtreeEnter(p);
  63386. rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
  63387. assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
  63388. sqlite3BtreeLeave(p);
  63389. return rc;
  63390. }
  63391. #ifndef SQLITE_OMIT_SHARED_CACHE
  63392. /*
  63393. ** Obtain a lock on the table whose root page is iTab. The
  63394. ** lock is a write lock if isWritelock is true or a read lock
  63395. ** if it is false.
  63396. */
  63397. SQLITE_PRIVATE int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
  63398. int rc = SQLITE_OK;
  63399. assert( p->inTrans!=TRANS_NONE );
  63400. if( p->sharable ){
  63401. u8 lockType = READ_LOCK + isWriteLock;
  63402. assert( READ_LOCK+1==WRITE_LOCK );
  63403. assert( isWriteLock==0 || isWriteLock==1 );
  63404. sqlite3BtreeEnter(p);
  63405. rc = querySharedCacheTableLock(p, iTab, lockType);
  63406. if( rc==SQLITE_OK ){
  63407. rc = setSharedCacheTableLock(p, iTab, lockType);
  63408. }
  63409. sqlite3BtreeLeave(p);
  63410. }
  63411. return rc;
  63412. }
  63413. #endif
  63414. #ifndef SQLITE_OMIT_INCRBLOB
  63415. /*
  63416. ** Argument pCsr must be a cursor opened for writing on an
  63417. ** INTKEY table currently pointing at a valid table entry.
  63418. ** This function modifies the data stored as part of that entry.
  63419. **
  63420. ** Only the data content may only be modified, it is not possible to
  63421. ** change the length of the data stored. If this function is called with
  63422. ** parameters that attempt to write past the end of the existing data,
  63423. ** no modifications are made and SQLITE_CORRUPT is returned.
  63424. */
  63425. SQLITE_PRIVATE int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
  63426. int rc;
  63427. assert( cursorOwnsBtShared(pCsr) );
  63428. assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
  63429. assert( pCsr->curFlags & BTCF_Incrblob );
  63430. rc = restoreCursorPosition(pCsr);
  63431. if( rc!=SQLITE_OK ){
  63432. return rc;
  63433. }
  63434. assert( pCsr->eState!=CURSOR_REQUIRESEEK );
  63435. if( pCsr->eState!=CURSOR_VALID ){
  63436. return SQLITE_ABORT;
  63437. }
  63438. /* Save the positions of all other cursors open on this table. This is
  63439. ** required in case any of them are holding references to an xFetch
  63440. ** version of the b-tree page modified by the accessPayload call below.
  63441. **
  63442. ** Note that pCsr must be open on a INTKEY table and saveCursorPosition()
  63443. ** and hence saveAllCursors() cannot fail on a BTREE_INTKEY table, hence
  63444. ** saveAllCursors can only return SQLITE_OK.
  63445. */
  63446. VVA_ONLY(rc =) saveAllCursors(pCsr->pBt, pCsr->pgnoRoot, pCsr);
  63447. assert( rc==SQLITE_OK );
  63448. /* Check some assumptions:
  63449. ** (a) the cursor is open for writing,
  63450. ** (b) there is a read/write transaction open,
  63451. ** (c) the connection holds a write-lock on the table (if required),
  63452. ** (d) there are no conflicting read-locks, and
  63453. ** (e) the cursor points at a valid row of an intKey table.
  63454. */
  63455. if( (pCsr->curFlags & BTCF_WriteFlag)==0 ){
  63456. return SQLITE_READONLY;
  63457. }
  63458. assert( (pCsr->pBt->btsFlags & BTS_READ_ONLY)==0
  63459. && pCsr->pBt->inTransaction==TRANS_WRITE );
  63460. assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
  63461. assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
  63462. assert( pCsr->apPage[pCsr->iPage]->intKey );
  63463. return accessPayload(pCsr, offset, amt, (unsigned char *)z, 1);
  63464. }
  63465. /*
  63466. ** Mark this cursor as an incremental blob cursor.
  63467. */
  63468. SQLITE_PRIVATE void sqlite3BtreeIncrblobCursor(BtCursor *pCur){
  63469. pCur->curFlags |= BTCF_Incrblob;
  63470. pCur->pBtree->hasIncrblobCur = 1;
  63471. }
  63472. #endif
  63473. /*
  63474. ** Set both the "read version" (single byte at byte offset 18) and
  63475. ** "write version" (single byte at byte offset 19) fields in the database
  63476. ** header to iVersion.
  63477. */
  63478. SQLITE_PRIVATE int sqlite3BtreeSetVersion(Btree *pBtree, int iVersion){
  63479. BtShared *pBt = pBtree->pBt;
  63480. int rc; /* Return code */
  63481. assert( iVersion==1 || iVersion==2 );
  63482. /* If setting the version fields to 1, do not automatically open the
  63483. ** WAL connection, even if the version fields are currently set to 2.
  63484. */
  63485. pBt->btsFlags &= ~BTS_NO_WAL;
  63486. if( iVersion==1 ) pBt->btsFlags |= BTS_NO_WAL;
  63487. rc = sqlite3BtreeBeginTrans(pBtree, 0);
  63488. if( rc==SQLITE_OK ){
  63489. u8 *aData = pBt->pPage1->aData;
  63490. if( aData[18]!=(u8)iVersion || aData[19]!=(u8)iVersion ){
  63491. rc = sqlite3BtreeBeginTrans(pBtree, 2);
  63492. if( rc==SQLITE_OK ){
  63493. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  63494. if( rc==SQLITE_OK ){
  63495. aData[18] = (u8)iVersion;
  63496. aData[19] = (u8)iVersion;
  63497. }
  63498. }
  63499. }
  63500. }
  63501. pBt->btsFlags &= ~BTS_NO_WAL;
  63502. return rc;
  63503. }
  63504. /*
  63505. ** Return true if the cursor has a hint specified. This routine is
  63506. ** only used from within assert() statements
  63507. */
  63508. SQLITE_PRIVATE int sqlite3BtreeCursorHasHint(BtCursor *pCsr, unsigned int mask){
  63509. return (pCsr->hints & mask)!=0;
  63510. }
  63511. /*
  63512. ** Return true if the given Btree is read-only.
  63513. */
  63514. SQLITE_PRIVATE int sqlite3BtreeIsReadonly(Btree *p){
  63515. return (p->pBt->btsFlags & BTS_READ_ONLY)!=0;
  63516. }
  63517. /*
  63518. ** Return the size of the header added to each page by this module.
  63519. */
  63520. SQLITE_PRIVATE int sqlite3HeaderSizeBtree(void){ return ROUND8(sizeof(MemPage)); }
  63521. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  63522. /*
  63523. ** Return true if the Btree passed as the only argument is sharable.
  63524. */
  63525. SQLITE_PRIVATE int sqlite3BtreeSharable(Btree *p){
  63526. return p->sharable;
  63527. }
  63528. /*
  63529. ** Return the number of connections to the BtShared object accessed by
  63530. ** the Btree handle passed as the only argument. For private caches
  63531. ** this is always 1. For shared caches it may be 1 or greater.
  63532. */
  63533. SQLITE_PRIVATE int sqlite3BtreeConnectionCount(Btree *p){
  63534. testcase( p->sharable );
  63535. return p->pBt->nRef;
  63536. }
  63537. #endif
  63538. /************** End of btree.c ***********************************************/
  63539. /************** Begin file backup.c ******************************************/
  63540. /*
  63541. ** 2009 January 28
  63542. **
  63543. ** The author disclaims copyright to this source code. In place of
  63544. ** a legal notice, here is a blessing:
  63545. **
  63546. ** May you do good and not evil.
  63547. ** May you find forgiveness for yourself and forgive others.
  63548. ** May you share freely, never taking more than you give.
  63549. **
  63550. *************************************************************************
  63551. ** This file contains the implementation of the sqlite3_backup_XXX()
  63552. ** API functions and the related features.
  63553. */
  63554. /* #include "sqliteInt.h" */
  63555. /* #include "btreeInt.h" */
  63556. /*
  63557. ** Structure allocated for each backup operation.
  63558. */
  63559. struct sqlite3_backup {
  63560. sqlite3* pDestDb; /* Destination database handle */
  63561. Btree *pDest; /* Destination b-tree file */
  63562. u32 iDestSchema; /* Original schema cookie in destination */
  63563. int bDestLocked; /* True once a write-transaction is open on pDest */
  63564. Pgno iNext; /* Page number of the next source page to copy */
  63565. sqlite3* pSrcDb; /* Source database handle */
  63566. Btree *pSrc; /* Source b-tree file */
  63567. int rc; /* Backup process error code */
  63568. /* These two variables are set by every call to backup_step(). They are
  63569. ** read by calls to backup_remaining() and backup_pagecount().
  63570. */
  63571. Pgno nRemaining; /* Number of pages left to copy */
  63572. Pgno nPagecount; /* Total number of pages to copy */
  63573. int isAttached; /* True once backup has been registered with pager */
  63574. sqlite3_backup *pNext; /* Next backup associated with source pager */
  63575. };
  63576. /*
  63577. ** THREAD SAFETY NOTES:
  63578. **
  63579. ** Once it has been created using backup_init(), a single sqlite3_backup
  63580. ** structure may be accessed via two groups of thread-safe entry points:
  63581. **
  63582. ** * Via the sqlite3_backup_XXX() API function backup_step() and
  63583. ** backup_finish(). Both these functions obtain the source database
  63584. ** handle mutex and the mutex associated with the source BtShared
  63585. ** structure, in that order.
  63586. **
  63587. ** * Via the BackupUpdate() and BackupRestart() functions, which are
  63588. ** invoked by the pager layer to report various state changes in
  63589. ** the page cache associated with the source database. The mutex
  63590. ** associated with the source database BtShared structure will always
  63591. ** be held when either of these functions are invoked.
  63592. **
  63593. ** The other sqlite3_backup_XXX() API functions, backup_remaining() and
  63594. ** backup_pagecount() are not thread-safe functions. If they are called
  63595. ** while some other thread is calling backup_step() or backup_finish(),
  63596. ** the values returned may be invalid. There is no way for a call to
  63597. ** BackupUpdate() or BackupRestart() to interfere with backup_remaining()
  63598. ** or backup_pagecount().
  63599. **
  63600. ** Depending on the SQLite configuration, the database handles and/or
  63601. ** the Btree objects may have their own mutexes that require locking.
  63602. ** Non-sharable Btrees (in-memory databases for example), do not have
  63603. ** associated mutexes.
  63604. */
  63605. /*
  63606. ** Return a pointer corresponding to database zDb (i.e. "main", "temp")
  63607. ** in connection handle pDb. If such a database cannot be found, return
  63608. ** a NULL pointer and write an error message to pErrorDb.
  63609. **
  63610. ** If the "temp" database is requested, it may need to be opened by this
  63611. ** function. If an error occurs while doing so, return 0 and write an
  63612. ** error message to pErrorDb.
  63613. */
  63614. static Btree *findBtree(sqlite3 *pErrorDb, sqlite3 *pDb, const char *zDb){
  63615. int i = sqlite3FindDbName(pDb, zDb);
  63616. if( i==1 ){
  63617. Parse sParse;
  63618. int rc = 0;
  63619. memset(&sParse, 0, sizeof(sParse));
  63620. sParse.db = pDb;
  63621. if( sqlite3OpenTempDatabase(&sParse) ){
  63622. sqlite3ErrorWithMsg(pErrorDb, sParse.rc, "%s", sParse.zErrMsg);
  63623. rc = SQLITE_ERROR;
  63624. }
  63625. sqlite3DbFree(pErrorDb, sParse.zErrMsg);
  63626. sqlite3ParserReset(&sParse);
  63627. if( rc ){
  63628. return 0;
  63629. }
  63630. }
  63631. if( i<0 ){
  63632. sqlite3ErrorWithMsg(pErrorDb, SQLITE_ERROR, "unknown database %s", zDb);
  63633. return 0;
  63634. }
  63635. return pDb->aDb[i].pBt;
  63636. }
  63637. /*
  63638. ** Attempt to set the page size of the destination to match the page size
  63639. ** of the source.
  63640. */
  63641. static int setDestPgsz(sqlite3_backup *p){
  63642. int rc;
  63643. rc = sqlite3BtreeSetPageSize(p->pDest,sqlite3BtreeGetPageSize(p->pSrc),-1,0);
  63644. return rc;
  63645. }
  63646. /*
  63647. ** Check that there is no open read-transaction on the b-tree passed as the
  63648. ** second argument. If there is not, return SQLITE_OK. Otherwise, if there
  63649. ** is an open read-transaction, return SQLITE_ERROR and leave an error
  63650. ** message in database handle db.
  63651. */
  63652. static int checkReadTransaction(sqlite3 *db, Btree *p){
  63653. if( sqlite3BtreeIsInReadTrans(p) ){
  63654. sqlite3ErrorWithMsg(db, SQLITE_ERROR, "destination database is in use");
  63655. return SQLITE_ERROR;
  63656. }
  63657. return SQLITE_OK;
  63658. }
  63659. /*
  63660. ** Create an sqlite3_backup process to copy the contents of zSrcDb from
  63661. ** connection handle pSrcDb to zDestDb in pDestDb. If successful, return
  63662. ** a pointer to the new sqlite3_backup object.
  63663. **
  63664. ** If an error occurs, NULL is returned and an error code and error message
  63665. ** stored in database handle pDestDb.
  63666. */
  63667. SQLITE_API sqlite3_backup *sqlite3_backup_init(
  63668. sqlite3* pDestDb, /* Database to write to */
  63669. const char *zDestDb, /* Name of database within pDestDb */
  63670. sqlite3* pSrcDb, /* Database connection to read from */
  63671. const char *zSrcDb /* Name of database within pSrcDb */
  63672. ){
  63673. sqlite3_backup *p; /* Value to return */
  63674. #ifdef SQLITE_ENABLE_API_ARMOR
  63675. if( !sqlite3SafetyCheckOk(pSrcDb)||!sqlite3SafetyCheckOk(pDestDb) ){
  63676. (void)SQLITE_MISUSE_BKPT;
  63677. return 0;
  63678. }
  63679. #endif
  63680. /* Lock the source database handle. The destination database
  63681. ** handle is not locked in this routine, but it is locked in
  63682. ** sqlite3_backup_step(). The user is required to ensure that no
  63683. ** other thread accesses the destination handle for the duration
  63684. ** of the backup operation. Any attempt to use the destination
  63685. ** database connection while a backup is in progress may cause
  63686. ** a malfunction or a deadlock.
  63687. */
  63688. sqlite3_mutex_enter(pSrcDb->mutex);
  63689. sqlite3_mutex_enter(pDestDb->mutex);
  63690. if( pSrcDb==pDestDb ){
  63691. sqlite3ErrorWithMsg(
  63692. pDestDb, SQLITE_ERROR, "source and destination must be distinct"
  63693. );
  63694. p = 0;
  63695. }else {
  63696. /* Allocate space for a new sqlite3_backup object...
  63697. ** EVIDENCE-OF: R-64852-21591 The sqlite3_backup object is created by a
  63698. ** call to sqlite3_backup_init() and is destroyed by a call to
  63699. ** sqlite3_backup_finish(). */
  63700. p = (sqlite3_backup *)sqlite3MallocZero(sizeof(sqlite3_backup));
  63701. if( !p ){
  63702. sqlite3Error(pDestDb, SQLITE_NOMEM_BKPT);
  63703. }
  63704. }
  63705. /* If the allocation succeeded, populate the new object. */
  63706. if( p ){
  63707. p->pSrc = findBtree(pDestDb, pSrcDb, zSrcDb);
  63708. p->pDest = findBtree(pDestDb, pDestDb, zDestDb);
  63709. p->pDestDb = pDestDb;
  63710. p->pSrcDb = pSrcDb;
  63711. p->iNext = 1;
  63712. p->isAttached = 0;
  63713. if( 0==p->pSrc || 0==p->pDest
  63714. || checkReadTransaction(pDestDb, p->pDest)!=SQLITE_OK
  63715. ){
  63716. /* One (or both) of the named databases did not exist or an OOM
  63717. ** error was hit. Or there is a transaction open on the destination
  63718. ** database. The error has already been written into the pDestDb
  63719. ** handle. All that is left to do here is free the sqlite3_backup
  63720. ** structure. */
  63721. sqlite3_free(p);
  63722. p = 0;
  63723. }
  63724. }
  63725. if( p ){
  63726. p->pSrc->nBackup++;
  63727. }
  63728. sqlite3_mutex_leave(pDestDb->mutex);
  63729. sqlite3_mutex_leave(pSrcDb->mutex);
  63730. return p;
  63731. }
  63732. /*
  63733. ** Argument rc is an SQLite error code. Return true if this error is
  63734. ** considered fatal if encountered during a backup operation. All errors
  63735. ** are considered fatal except for SQLITE_BUSY and SQLITE_LOCKED.
  63736. */
  63737. static int isFatalError(int rc){
  63738. return (rc!=SQLITE_OK && rc!=SQLITE_BUSY && ALWAYS(rc!=SQLITE_LOCKED));
  63739. }
  63740. /*
  63741. ** Parameter zSrcData points to a buffer containing the data for
  63742. ** page iSrcPg from the source database. Copy this data into the
  63743. ** destination database.
  63744. */
  63745. static int backupOnePage(
  63746. sqlite3_backup *p, /* Backup handle */
  63747. Pgno iSrcPg, /* Source database page to backup */
  63748. const u8 *zSrcData, /* Source database page data */
  63749. int bUpdate /* True for an update, false otherwise */
  63750. ){
  63751. Pager * const pDestPager = sqlite3BtreePager(p->pDest);
  63752. const int nSrcPgsz = sqlite3BtreeGetPageSize(p->pSrc);
  63753. int nDestPgsz = sqlite3BtreeGetPageSize(p->pDest);
  63754. const int nCopy = MIN(nSrcPgsz, nDestPgsz);
  63755. const i64 iEnd = (i64)iSrcPg*(i64)nSrcPgsz;
  63756. #ifdef SQLITE_HAS_CODEC
  63757. /* Use BtreeGetReserveNoMutex() for the source b-tree, as although it is
  63758. ** guaranteed that the shared-mutex is held by this thread, handle
  63759. ** p->pSrc may not actually be the owner. */
  63760. int nSrcReserve = sqlite3BtreeGetReserveNoMutex(p->pSrc);
  63761. int nDestReserve = sqlite3BtreeGetOptimalReserve(p->pDest);
  63762. #endif
  63763. int rc = SQLITE_OK;
  63764. i64 iOff;
  63765. assert( sqlite3BtreeGetReserveNoMutex(p->pSrc)>=0 );
  63766. assert( p->bDestLocked );
  63767. assert( !isFatalError(p->rc) );
  63768. assert( iSrcPg!=PENDING_BYTE_PAGE(p->pSrc->pBt) );
  63769. assert( zSrcData );
  63770. /* Catch the case where the destination is an in-memory database and the
  63771. ** page sizes of the source and destination differ.
  63772. */
  63773. if( nSrcPgsz!=nDestPgsz && sqlite3PagerIsMemdb(pDestPager) ){
  63774. rc = SQLITE_READONLY;
  63775. }
  63776. #ifdef SQLITE_HAS_CODEC
  63777. /* Backup is not possible if the page size of the destination is changing
  63778. ** and a codec is in use.
  63779. */
  63780. if( nSrcPgsz!=nDestPgsz && sqlite3PagerGetCodec(pDestPager)!=0 ){
  63781. rc = SQLITE_READONLY;
  63782. }
  63783. /* Backup is not possible if the number of bytes of reserve space differ
  63784. ** between source and destination. If there is a difference, try to
  63785. ** fix the destination to agree with the source. If that is not possible,
  63786. ** then the backup cannot proceed.
  63787. */
  63788. if( nSrcReserve!=nDestReserve ){
  63789. u32 newPgsz = nSrcPgsz;
  63790. rc = sqlite3PagerSetPagesize(pDestPager, &newPgsz, nSrcReserve);
  63791. if( rc==SQLITE_OK && newPgsz!=nSrcPgsz ) rc = SQLITE_READONLY;
  63792. }
  63793. #endif
  63794. /* This loop runs once for each destination page spanned by the source
  63795. ** page. For each iteration, variable iOff is set to the byte offset
  63796. ** of the destination page.
  63797. */
  63798. for(iOff=iEnd-(i64)nSrcPgsz; rc==SQLITE_OK && iOff<iEnd; iOff+=nDestPgsz){
  63799. DbPage *pDestPg = 0;
  63800. Pgno iDest = (Pgno)(iOff/nDestPgsz)+1;
  63801. if( iDest==PENDING_BYTE_PAGE(p->pDest->pBt) ) continue;
  63802. if( SQLITE_OK==(rc = sqlite3PagerGet(pDestPager, iDest, &pDestPg, 0))
  63803. && SQLITE_OK==(rc = sqlite3PagerWrite(pDestPg))
  63804. ){
  63805. const u8 *zIn = &zSrcData[iOff%nSrcPgsz];
  63806. u8 *zDestData = sqlite3PagerGetData(pDestPg);
  63807. u8 *zOut = &zDestData[iOff%nDestPgsz];
  63808. /* Copy the data from the source page into the destination page.
  63809. ** Then clear the Btree layer MemPage.isInit flag. Both this module
  63810. ** and the pager code use this trick (clearing the first byte
  63811. ** of the page 'extra' space to invalidate the Btree layers
  63812. ** cached parse of the page). MemPage.isInit is marked
  63813. ** "MUST BE FIRST" for this purpose.
  63814. */
  63815. memcpy(zOut, zIn, nCopy);
  63816. ((u8 *)sqlite3PagerGetExtra(pDestPg))[0] = 0;
  63817. if( iOff==0 && bUpdate==0 ){
  63818. sqlite3Put4byte(&zOut[28], sqlite3BtreeLastPage(p->pSrc));
  63819. }
  63820. }
  63821. sqlite3PagerUnref(pDestPg);
  63822. }
  63823. return rc;
  63824. }
  63825. /*
  63826. ** If pFile is currently larger than iSize bytes, then truncate it to
  63827. ** exactly iSize bytes. If pFile is not larger than iSize bytes, then
  63828. ** this function is a no-op.
  63829. **
  63830. ** Return SQLITE_OK if everything is successful, or an SQLite error
  63831. ** code if an error occurs.
  63832. */
  63833. static int backupTruncateFile(sqlite3_file *pFile, i64 iSize){
  63834. i64 iCurrent;
  63835. int rc = sqlite3OsFileSize(pFile, &iCurrent);
  63836. if( rc==SQLITE_OK && iCurrent>iSize ){
  63837. rc = sqlite3OsTruncate(pFile, iSize);
  63838. }
  63839. return rc;
  63840. }
  63841. /*
  63842. ** Register this backup object with the associated source pager for
  63843. ** callbacks when pages are changed or the cache invalidated.
  63844. */
  63845. static void attachBackupObject(sqlite3_backup *p){
  63846. sqlite3_backup **pp;
  63847. assert( sqlite3BtreeHoldsMutex(p->pSrc) );
  63848. pp = sqlite3PagerBackupPtr(sqlite3BtreePager(p->pSrc));
  63849. p->pNext = *pp;
  63850. *pp = p;
  63851. p->isAttached = 1;
  63852. }
  63853. /*
  63854. ** Copy nPage pages from the source b-tree to the destination.
  63855. */
  63856. SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage){
  63857. int rc;
  63858. int destMode; /* Destination journal mode */
  63859. int pgszSrc = 0; /* Source page size */
  63860. int pgszDest = 0; /* Destination page size */
  63861. #ifdef SQLITE_ENABLE_API_ARMOR
  63862. if( p==0 ) return SQLITE_MISUSE_BKPT;
  63863. #endif
  63864. sqlite3_mutex_enter(p->pSrcDb->mutex);
  63865. sqlite3BtreeEnter(p->pSrc);
  63866. if( p->pDestDb ){
  63867. sqlite3_mutex_enter(p->pDestDb->mutex);
  63868. }
  63869. rc = p->rc;
  63870. if( !isFatalError(rc) ){
  63871. Pager * const pSrcPager = sqlite3BtreePager(p->pSrc); /* Source pager */
  63872. Pager * const pDestPager = sqlite3BtreePager(p->pDest); /* Dest pager */
  63873. int ii; /* Iterator variable */
  63874. int nSrcPage = -1; /* Size of source db in pages */
  63875. int bCloseTrans = 0; /* True if src db requires unlocking */
  63876. /* If the source pager is currently in a write-transaction, return
  63877. ** SQLITE_BUSY immediately.
  63878. */
  63879. if( p->pDestDb && p->pSrc->pBt->inTransaction==TRANS_WRITE ){
  63880. rc = SQLITE_BUSY;
  63881. }else{
  63882. rc = SQLITE_OK;
  63883. }
  63884. /* If there is no open read-transaction on the source database, open
  63885. ** one now. If a transaction is opened here, then it will be closed
  63886. ** before this function exits.
  63887. */
  63888. if( rc==SQLITE_OK && 0==sqlite3BtreeIsInReadTrans(p->pSrc) ){
  63889. rc = sqlite3BtreeBeginTrans(p->pSrc, 0);
  63890. bCloseTrans = 1;
  63891. }
  63892. /* If the destination database has not yet been locked (i.e. if this
  63893. ** is the first call to backup_step() for the current backup operation),
  63894. ** try to set its page size to the same as the source database. This
  63895. ** is especially important on ZipVFS systems, as in that case it is
  63896. ** not possible to create a database file that uses one page size by
  63897. ** writing to it with another. */
  63898. if( p->bDestLocked==0 && rc==SQLITE_OK && setDestPgsz(p)==SQLITE_NOMEM ){
  63899. rc = SQLITE_NOMEM;
  63900. }
  63901. /* Lock the destination database, if it is not locked already. */
  63902. if( SQLITE_OK==rc && p->bDestLocked==0
  63903. && SQLITE_OK==(rc = sqlite3BtreeBeginTrans(p->pDest, 2))
  63904. ){
  63905. p->bDestLocked = 1;
  63906. sqlite3BtreeGetMeta(p->pDest, BTREE_SCHEMA_VERSION, &p->iDestSchema);
  63907. }
  63908. /* Do not allow backup if the destination database is in WAL mode
  63909. ** and the page sizes are different between source and destination */
  63910. pgszSrc = sqlite3BtreeGetPageSize(p->pSrc);
  63911. pgszDest = sqlite3BtreeGetPageSize(p->pDest);
  63912. destMode = sqlite3PagerGetJournalMode(sqlite3BtreePager(p->pDest));
  63913. if( SQLITE_OK==rc && destMode==PAGER_JOURNALMODE_WAL && pgszSrc!=pgszDest ){
  63914. rc = SQLITE_READONLY;
  63915. }
  63916. /* Now that there is a read-lock on the source database, query the
  63917. ** source pager for the number of pages in the database.
  63918. */
  63919. nSrcPage = (int)sqlite3BtreeLastPage(p->pSrc);
  63920. assert( nSrcPage>=0 );
  63921. for(ii=0; (nPage<0 || ii<nPage) && p->iNext<=(Pgno)nSrcPage && !rc; ii++){
  63922. const Pgno iSrcPg = p->iNext; /* Source page number */
  63923. if( iSrcPg!=PENDING_BYTE_PAGE(p->pSrc->pBt) ){
  63924. DbPage *pSrcPg; /* Source page object */
  63925. rc = sqlite3PagerGet(pSrcPager, iSrcPg, &pSrcPg,PAGER_GET_READONLY);
  63926. if( rc==SQLITE_OK ){
  63927. rc = backupOnePage(p, iSrcPg, sqlite3PagerGetData(pSrcPg), 0);
  63928. sqlite3PagerUnref(pSrcPg);
  63929. }
  63930. }
  63931. p->iNext++;
  63932. }
  63933. if( rc==SQLITE_OK ){
  63934. p->nPagecount = nSrcPage;
  63935. p->nRemaining = nSrcPage+1-p->iNext;
  63936. if( p->iNext>(Pgno)nSrcPage ){
  63937. rc = SQLITE_DONE;
  63938. }else if( !p->isAttached ){
  63939. attachBackupObject(p);
  63940. }
  63941. }
  63942. /* Update the schema version field in the destination database. This
  63943. ** is to make sure that the schema-version really does change in
  63944. ** the case where the source and destination databases have the
  63945. ** same schema version.
  63946. */
  63947. if( rc==SQLITE_DONE ){
  63948. if( nSrcPage==0 ){
  63949. rc = sqlite3BtreeNewDb(p->pDest);
  63950. nSrcPage = 1;
  63951. }
  63952. if( rc==SQLITE_OK || rc==SQLITE_DONE ){
  63953. rc = sqlite3BtreeUpdateMeta(p->pDest,1,p->iDestSchema+1);
  63954. }
  63955. if( rc==SQLITE_OK ){
  63956. if( p->pDestDb ){
  63957. sqlite3ResetAllSchemasOfConnection(p->pDestDb);
  63958. }
  63959. if( destMode==PAGER_JOURNALMODE_WAL ){
  63960. rc = sqlite3BtreeSetVersion(p->pDest, 2);
  63961. }
  63962. }
  63963. if( rc==SQLITE_OK ){
  63964. int nDestTruncate;
  63965. /* Set nDestTruncate to the final number of pages in the destination
  63966. ** database. The complication here is that the destination page
  63967. ** size may be different to the source page size.
  63968. **
  63969. ** If the source page size is smaller than the destination page size,
  63970. ** round up. In this case the call to sqlite3OsTruncate() below will
  63971. ** fix the size of the file. However it is important to call
  63972. ** sqlite3PagerTruncateImage() here so that any pages in the
  63973. ** destination file that lie beyond the nDestTruncate page mark are
  63974. ** journalled by PagerCommitPhaseOne() before they are destroyed
  63975. ** by the file truncation.
  63976. */
  63977. assert( pgszSrc==sqlite3BtreeGetPageSize(p->pSrc) );
  63978. assert( pgszDest==sqlite3BtreeGetPageSize(p->pDest) );
  63979. if( pgszSrc<pgszDest ){
  63980. int ratio = pgszDest/pgszSrc;
  63981. nDestTruncate = (nSrcPage+ratio-1)/ratio;
  63982. if( nDestTruncate==(int)PENDING_BYTE_PAGE(p->pDest->pBt) ){
  63983. nDestTruncate--;
  63984. }
  63985. }else{
  63986. nDestTruncate = nSrcPage * (pgszSrc/pgszDest);
  63987. }
  63988. assert( nDestTruncate>0 );
  63989. if( pgszSrc<pgszDest ){
  63990. /* If the source page-size is smaller than the destination page-size,
  63991. ** two extra things may need to happen:
  63992. **
  63993. ** * The destination may need to be truncated, and
  63994. **
  63995. ** * Data stored on the pages immediately following the
  63996. ** pending-byte page in the source database may need to be
  63997. ** copied into the destination database.
  63998. */
  63999. const i64 iSize = (i64)pgszSrc * (i64)nSrcPage;
  64000. sqlite3_file * const pFile = sqlite3PagerFile(pDestPager);
  64001. Pgno iPg;
  64002. int nDstPage;
  64003. i64 iOff;
  64004. i64 iEnd;
  64005. assert( pFile );
  64006. assert( nDestTruncate==0
  64007. || (i64)nDestTruncate*(i64)pgszDest >= iSize || (
  64008. nDestTruncate==(int)(PENDING_BYTE_PAGE(p->pDest->pBt)-1)
  64009. && iSize>=PENDING_BYTE && iSize<=PENDING_BYTE+pgszDest
  64010. ));
  64011. /* This block ensures that all data required to recreate the original
  64012. ** database has been stored in the journal for pDestPager and the
  64013. ** journal synced to disk. So at this point we may safely modify
  64014. ** the database file in any way, knowing that if a power failure
  64015. ** occurs, the original database will be reconstructed from the
  64016. ** journal file. */
  64017. sqlite3PagerPagecount(pDestPager, &nDstPage);
  64018. for(iPg=nDestTruncate; rc==SQLITE_OK && iPg<=(Pgno)nDstPage; iPg++){
  64019. if( iPg!=PENDING_BYTE_PAGE(p->pDest->pBt) ){
  64020. DbPage *pPg;
  64021. rc = sqlite3PagerGet(pDestPager, iPg, &pPg, 0);
  64022. if( rc==SQLITE_OK ){
  64023. rc = sqlite3PagerWrite(pPg);
  64024. sqlite3PagerUnref(pPg);
  64025. }
  64026. }
  64027. }
  64028. if( rc==SQLITE_OK ){
  64029. rc = sqlite3PagerCommitPhaseOne(pDestPager, 0, 1);
  64030. }
  64031. /* Write the extra pages and truncate the database file as required */
  64032. iEnd = MIN(PENDING_BYTE + pgszDest, iSize);
  64033. for(
  64034. iOff=PENDING_BYTE+pgszSrc;
  64035. rc==SQLITE_OK && iOff<iEnd;
  64036. iOff+=pgszSrc
  64037. ){
  64038. PgHdr *pSrcPg = 0;
  64039. const Pgno iSrcPg = (Pgno)((iOff/pgszSrc)+1);
  64040. rc = sqlite3PagerGet(pSrcPager, iSrcPg, &pSrcPg, 0);
  64041. if( rc==SQLITE_OK ){
  64042. u8 *zData = sqlite3PagerGetData(pSrcPg);
  64043. rc = sqlite3OsWrite(pFile, zData, pgszSrc, iOff);
  64044. }
  64045. sqlite3PagerUnref(pSrcPg);
  64046. }
  64047. if( rc==SQLITE_OK ){
  64048. rc = backupTruncateFile(pFile, iSize);
  64049. }
  64050. /* Sync the database file to disk. */
  64051. if( rc==SQLITE_OK ){
  64052. rc = sqlite3PagerSync(pDestPager, 0);
  64053. }
  64054. }else{
  64055. sqlite3PagerTruncateImage(pDestPager, nDestTruncate);
  64056. rc = sqlite3PagerCommitPhaseOne(pDestPager, 0, 0);
  64057. }
  64058. /* Finish committing the transaction to the destination database. */
  64059. if( SQLITE_OK==rc
  64060. && SQLITE_OK==(rc = sqlite3BtreeCommitPhaseTwo(p->pDest, 0))
  64061. ){
  64062. rc = SQLITE_DONE;
  64063. }
  64064. }
  64065. }
  64066. /* If bCloseTrans is true, then this function opened a read transaction
  64067. ** on the source database. Close the read transaction here. There is
  64068. ** no need to check the return values of the btree methods here, as
  64069. ** "committing" a read-only transaction cannot fail.
  64070. */
  64071. if( bCloseTrans ){
  64072. TESTONLY( int rc2 );
  64073. TESTONLY( rc2 = ) sqlite3BtreeCommitPhaseOne(p->pSrc, 0);
  64074. TESTONLY( rc2 |= ) sqlite3BtreeCommitPhaseTwo(p->pSrc, 0);
  64075. assert( rc2==SQLITE_OK );
  64076. }
  64077. if( rc==SQLITE_IOERR_NOMEM ){
  64078. rc = SQLITE_NOMEM_BKPT;
  64079. }
  64080. p->rc = rc;
  64081. }
  64082. if( p->pDestDb ){
  64083. sqlite3_mutex_leave(p->pDestDb->mutex);
  64084. }
  64085. sqlite3BtreeLeave(p->pSrc);
  64086. sqlite3_mutex_leave(p->pSrcDb->mutex);
  64087. return rc;
  64088. }
  64089. /*
  64090. ** Release all resources associated with an sqlite3_backup* handle.
  64091. */
  64092. SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p){
  64093. sqlite3_backup **pp; /* Ptr to head of pagers backup list */
  64094. sqlite3 *pSrcDb; /* Source database connection */
  64095. int rc; /* Value to return */
  64096. /* Enter the mutexes */
  64097. if( p==0 ) return SQLITE_OK;
  64098. pSrcDb = p->pSrcDb;
  64099. sqlite3_mutex_enter(pSrcDb->mutex);
  64100. sqlite3BtreeEnter(p->pSrc);
  64101. if( p->pDestDb ){
  64102. sqlite3_mutex_enter(p->pDestDb->mutex);
  64103. }
  64104. /* Detach this backup from the source pager. */
  64105. if( p->pDestDb ){
  64106. p->pSrc->nBackup--;
  64107. }
  64108. if( p->isAttached ){
  64109. pp = sqlite3PagerBackupPtr(sqlite3BtreePager(p->pSrc));
  64110. while( *pp!=p ){
  64111. pp = &(*pp)->pNext;
  64112. }
  64113. *pp = p->pNext;
  64114. }
  64115. /* If a transaction is still open on the Btree, roll it back. */
  64116. sqlite3BtreeRollback(p->pDest, SQLITE_OK, 0);
  64117. /* Set the error code of the destination database handle. */
  64118. rc = (p->rc==SQLITE_DONE) ? SQLITE_OK : p->rc;
  64119. if( p->pDestDb ){
  64120. sqlite3Error(p->pDestDb, rc);
  64121. /* Exit the mutexes and free the backup context structure. */
  64122. sqlite3LeaveMutexAndCloseZombie(p->pDestDb);
  64123. }
  64124. sqlite3BtreeLeave(p->pSrc);
  64125. if( p->pDestDb ){
  64126. /* EVIDENCE-OF: R-64852-21591 The sqlite3_backup object is created by a
  64127. ** call to sqlite3_backup_init() and is destroyed by a call to
  64128. ** sqlite3_backup_finish(). */
  64129. sqlite3_free(p);
  64130. }
  64131. sqlite3LeaveMutexAndCloseZombie(pSrcDb);
  64132. return rc;
  64133. }
  64134. /*
  64135. ** Return the number of pages still to be backed up as of the most recent
  64136. ** call to sqlite3_backup_step().
  64137. */
  64138. SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p){
  64139. #ifdef SQLITE_ENABLE_API_ARMOR
  64140. if( p==0 ){
  64141. (void)SQLITE_MISUSE_BKPT;
  64142. return 0;
  64143. }
  64144. #endif
  64145. return p->nRemaining;
  64146. }
  64147. /*
  64148. ** Return the total number of pages in the source database as of the most
  64149. ** recent call to sqlite3_backup_step().
  64150. */
  64151. SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p){
  64152. #ifdef SQLITE_ENABLE_API_ARMOR
  64153. if( p==0 ){
  64154. (void)SQLITE_MISUSE_BKPT;
  64155. return 0;
  64156. }
  64157. #endif
  64158. return p->nPagecount;
  64159. }
  64160. /*
  64161. ** This function is called after the contents of page iPage of the
  64162. ** source database have been modified. If page iPage has already been
  64163. ** copied into the destination database, then the data written to the
  64164. ** destination is now invalidated. The destination copy of iPage needs
  64165. ** to be updated with the new data before the backup operation is
  64166. ** complete.
  64167. **
  64168. ** It is assumed that the mutex associated with the BtShared object
  64169. ** corresponding to the source database is held when this function is
  64170. ** called.
  64171. */
  64172. static SQLITE_NOINLINE void backupUpdate(
  64173. sqlite3_backup *p,
  64174. Pgno iPage,
  64175. const u8 *aData
  64176. ){
  64177. assert( p!=0 );
  64178. do{
  64179. assert( sqlite3_mutex_held(p->pSrc->pBt->mutex) );
  64180. if( !isFatalError(p->rc) && iPage<p->iNext ){
  64181. /* The backup process p has already copied page iPage. But now it
  64182. ** has been modified by a transaction on the source pager. Copy
  64183. ** the new data into the backup.
  64184. */
  64185. int rc;
  64186. assert( p->pDestDb );
  64187. sqlite3_mutex_enter(p->pDestDb->mutex);
  64188. rc = backupOnePage(p, iPage, aData, 1);
  64189. sqlite3_mutex_leave(p->pDestDb->mutex);
  64190. assert( rc!=SQLITE_BUSY && rc!=SQLITE_LOCKED );
  64191. if( rc!=SQLITE_OK ){
  64192. p->rc = rc;
  64193. }
  64194. }
  64195. }while( (p = p->pNext)!=0 );
  64196. }
  64197. SQLITE_PRIVATE void sqlite3BackupUpdate(sqlite3_backup *pBackup, Pgno iPage, const u8 *aData){
  64198. if( pBackup ) backupUpdate(pBackup, iPage, aData);
  64199. }
  64200. /*
  64201. ** Restart the backup process. This is called when the pager layer
  64202. ** detects that the database has been modified by an external database
  64203. ** connection. In this case there is no way of knowing which of the
  64204. ** pages that have been copied into the destination database are still
  64205. ** valid and which are not, so the entire process needs to be restarted.
  64206. **
  64207. ** It is assumed that the mutex associated with the BtShared object
  64208. ** corresponding to the source database is held when this function is
  64209. ** called.
  64210. */
  64211. SQLITE_PRIVATE void sqlite3BackupRestart(sqlite3_backup *pBackup){
  64212. sqlite3_backup *p; /* Iterator variable */
  64213. for(p=pBackup; p; p=p->pNext){
  64214. assert( sqlite3_mutex_held(p->pSrc->pBt->mutex) );
  64215. p->iNext = 1;
  64216. }
  64217. }
  64218. #ifndef SQLITE_OMIT_VACUUM
  64219. /*
  64220. ** Copy the complete content of pBtFrom into pBtTo. A transaction
  64221. ** must be active for both files.
  64222. **
  64223. ** The size of file pTo may be reduced by this operation. If anything
  64224. ** goes wrong, the transaction on pTo is rolled back. If successful, the
  64225. ** transaction is committed before returning.
  64226. */
  64227. SQLITE_PRIVATE int sqlite3BtreeCopyFile(Btree *pTo, Btree *pFrom){
  64228. int rc;
  64229. sqlite3_file *pFd; /* File descriptor for database pTo */
  64230. sqlite3_backup b;
  64231. sqlite3BtreeEnter(pTo);
  64232. sqlite3BtreeEnter(pFrom);
  64233. assert( sqlite3BtreeIsInTrans(pTo) );
  64234. pFd = sqlite3PagerFile(sqlite3BtreePager(pTo));
  64235. if( pFd->pMethods ){
  64236. i64 nByte = sqlite3BtreeGetPageSize(pFrom)*(i64)sqlite3BtreeLastPage(pFrom);
  64237. rc = sqlite3OsFileControl(pFd, SQLITE_FCNTL_OVERWRITE, &nByte);
  64238. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  64239. if( rc ) goto copy_finished;
  64240. }
  64241. /* Set up an sqlite3_backup object. sqlite3_backup.pDestDb must be set
  64242. ** to 0. This is used by the implementations of sqlite3_backup_step()
  64243. ** and sqlite3_backup_finish() to detect that they are being called
  64244. ** from this function, not directly by the user.
  64245. */
  64246. memset(&b, 0, sizeof(b));
  64247. b.pSrcDb = pFrom->db;
  64248. b.pSrc = pFrom;
  64249. b.pDest = pTo;
  64250. b.iNext = 1;
  64251. #ifdef SQLITE_HAS_CODEC
  64252. sqlite3PagerAlignReserve(sqlite3BtreePager(pTo), sqlite3BtreePager(pFrom));
  64253. #endif
  64254. /* 0x7FFFFFFF is the hard limit for the number of pages in a database
  64255. ** file. By passing this as the number of pages to copy to
  64256. ** sqlite3_backup_step(), we can guarantee that the copy finishes
  64257. ** within a single call (unless an error occurs). The assert() statement
  64258. ** checks this assumption - (p->rc) should be set to either SQLITE_DONE
  64259. ** or an error code. */
  64260. sqlite3_backup_step(&b, 0x7FFFFFFF);
  64261. assert( b.rc!=SQLITE_OK );
  64262. rc = sqlite3_backup_finish(&b);
  64263. if( rc==SQLITE_OK ){
  64264. pTo->pBt->btsFlags &= ~BTS_PAGESIZE_FIXED;
  64265. }else{
  64266. sqlite3PagerClearCache(sqlite3BtreePager(b.pDest));
  64267. }
  64268. assert( sqlite3BtreeIsInTrans(pTo)==0 );
  64269. copy_finished:
  64270. sqlite3BtreeLeave(pFrom);
  64271. sqlite3BtreeLeave(pTo);
  64272. return rc;
  64273. }
  64274. #endif /* SQLITE_OMIT_VACUUM */
  64275. /************** End of backup.c **********************************************/
  64276. /************** Begin file vdbemem.c *****************************************/
  64277. /*
  64278. ** 2004 May 26
  64279. **
  64280. ** The author disclaims copyright to this source code. In place of
  64281. ** a legal notice, here is a blessing:
  64282. **
  64283. ** May you do good and not evil.
  64284. ** May you find forgiveness for yourself and forgive others.
  64285. ** May you share freely, never taking more than you give.
  64286. **
  64287. *************************************************************************
  64288. **
  64289. ** This file contains code use to manipulate "Mem" structure. A "Mem"
  64290. ** stores a single value in the VDBE. Mem is an opaque structure visible
  64291. ** only within the VDBE. Interface routines refer to a Mem using the
  64292. ** name sqlite_value
  64293. */
  64294. /* #include "sqliteInt.h" */
  64295. /* #include "vdbeInt.h" */
  64296. #ifdef SQLITE_DEBUG
  64297. /*
  64298. ** Check invariants on a Mem object.
  64299. **
  64300. ** This routine is intended for use inside of assert() statements, like
  64301. ** this: assert( sqlite3VdbeCheckMemInvariants(pMem) );
  64302. */
  64303. SQLITE_PRIVATE int sqlite3VdbeCheckMemInvariants(Mem *p){
  64304. /* If MEM_Dyn is set then Mem.xDel!=0.
  64305. ** Mem.xDel is might not be initialized if MEM_Dyn is clear.
  64306. */
  64307. assert( (p->flags & MEM_Dyn)==0 || p->xDel!=0 );
  64308. /* MEM_Dyn may only be set if Mem.szMalloc==0. In this way we
  64309. ** ensure that if Mem.szMalloc>0 then it is safe to do
  64310. ** Mem.z = Mem.zMalloc without having to check Mem.flags&MEM_Dyn.
  64311. ** That saves a few cycles in inner loops. */
  64312. assert( (p->flags & MEM_Dyn)==0 || p->szMalloc==0 );
  64313. /* Cannot be both MEM_Int and MEM_Real at the same time */
  64314. assert( (p->flags & (MEM_Int|MEM_Real))!=(MEM_Int|MEM_Real) );
  64315. /* The szMalloc field holds the correct memory allocation size */
  64316. assert( p->szMalloc==0
  64317. || p->szMalloc==sqlite3DbMallocSize(p->db,p->zMalloc) );
  64318. /* If p holds a string or blob, the Mem.z must point to exactly
  64319. ** one of the following:
  64320. **
  64321. ** (1) Memory in Mem.zMalloc and managed by the Mem object
  64322. ** (2) Memory to be freed using Mem.xDel
  64323. ** (3) An ephemeral string or blob
  64324. ** (4) A static string or blob
  64325. */
  64326. if( (p->flags & (MEM_Str|MEM_Blob)) && p->n>0 ){
  64327. assert(
  64328. ((p->szMalloc>0 && p->z==p->zMalloc)? 1 : 0) +
  64329. ((p->flags&MEM_Dyn)!=0 ? 1 : 0) +
  64330. ((p->flags&MEM_Ephem)!=0 ? 1 : 0) +
  64331. ((p->flags&MEM_Static)!=0 ? 1 : 0) == 1
  64332. );
  64333. }
  64334. return 1;
  64335. }
  64336. #endif
  64337. /*
  64338. ** If pMem is an object with a valid string representation, this routine
  64339. ** ensures the internal encoding for the string representation is
  64340. ** 'desiredEnc', one of SQLITE_UTF8, SQLITE_UTF16LE or SQLITE_UTF16BE.
  64341. **
  64342. ** If pMem is not a string object, or the encoding of the string
  64343. ** representation is already stored using the requested encoding, then this
  64344. ** routine is a no-op.
  64345. **
  64346. ** SQLITE_OK is returned if the conversion is successful (or not required).
  64347. ** SQLITE_NOMEM may be returned if a malloc() fails during conversion
  64348. ** between formats.
  64349. */
  64350. SQLITE_PRIVATE int sqlite3VdbeChangeEncoding(Mem *pMem, int desiredEnc){
  64351. #ifndef SQLITE_OMIT_UTF16
  64352. int rc;
  64353. #endif
  64354. assert( (pMem->flags&MEM_RowSet)==0 );
  64355. assert( desiredEnc==SQLITE_UTF8 || desiredEnc==SQLITE_UTF16LE
  64356. || desiredEnc==SQLITE_UTF16BE );
  64357. if( !(pMem->flags&MEM_Str) || pMem->enc==desiredEnc ){
  64358. return SQLITE_OK;
  64359. }
  64360. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64361. #ifdef SQLITE_OMIT_UTF16
  64362. return SQLITE_ERROR;
  64363. #else
  64364. /* MemTranslate() may return SQLITE_OK or SQLITE_NOMEM. If NOMEM is returned,
  64365. ** then the encoding of the value may not have changed.
  64366. */
  64367. rc = sqlite3VdbeMemTranslate(pMem, (u8)desiredEnc);
  64368. assert(rc==SQLITE_OK || rc==SQLITE_NOMEM);
  64369. assert(rc==SQLITE_OK || pMem->enc!=desiredEnc);
  64370. assert(rc==SQLITE_NOMEM || pMem->enc==desiredEnc);
  64371. return rc;
  64372. #endif
  64373. }
  64374. /*
  64375. ** Make sure pMem->z points to a writable allocation of at least
  64376. ** min(n,32) bytes.
  64377. **
  64378. ** If the bPreserve argument is true, then copy of the content of
  64379. ** pMem->z into the new allocation. pMem must be either a string or
  64380. ** blob if bPreserve is true. If bPreserve is false, any prior content
  64381. ** in pMem->z is discarded.
  64382. */
  64383. SQLITE_PRIVATE SQLITE_NOINLINE int sqlite3VdbeMemGrow(Mem *pMem, int n, int bPreserve){
  64384. assert( sqlite3VdbeCheckMemInvariants(pMem) );
  64385. assert( (pMem->flags&MEM_RowSet)==0 );
  64386. testcase( pMem->db==0 );
  64387. /* If the bPreserve flag is set to true, then the memory cell must already
  64388. ** contain a valid string or blob value. */
  64389. assert( bPreserve==0 || pMem->flags&(MEM_Blob|MEM_Str) );
  64390. testcase( bPreserve && pMem->z==0 );
  64391. assert( pMem->szMalloc==0
  64392. || pMem->szMalloc==sqlite3DbMallocSize(pMem->db, pMem->zMalloc) );
  64393. if( pMem->szMalloc<n ){
  64394. if( n<32 ) n = 32;
  64395. if( bPreserve && pMem->szMalloc>0 && pMem->z==pMem->zMalloc ){
  64396. pMem->z = pMem->zMalloc = sqlite3DbReallocOrFree(pMem->db, pMem->z, n);
  64397. bPreserve = 0;
  64398. }else{
  64399. if( pMem->szMalloc>0 ) sqlite3DbFree(pMem->db, pMem->zMalloc);
  64400. pMem->zMalloc = sqlite3DbMallocRaw(pMem->db, n);
  64401. }
  64402. if( pMem->zMalloc==0 ){
  64403. sqlite3VdbeMemSetNull(pMem);
  64404. pMem->z = 0;
  64405. pMem->szMalloc = 0;
  64406. return SQLITE_NOMEM_BKPT;
  64407. }else{
  64408. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->zMalloc);
  64409. }
  64410. }
  64411. if( bPreserve && pMem->z && pMem->z!=pMem->zMalloc ){
  64412. memcpy(pMem->zMalloc, pMem->z, pMem->n);
  64413. }
  64414. if( (pMem->flags&MEM_Dyn)!=0 ){
  64415. assert( pMem->xDel!=0 && pMem->xDel!=SQLITE_DYNAMIC );
  64416. pMem->xDel((void *)(pMem->z));
  64417. }
  64418. pMem->z = pMem->zMalloc;
  64419. pMem->flags &= ~(MEM_Dyn|MEM_Ephem|MEM_Static);
  64420. return SQLITE_OK;
  64421. }
  64422. /*
  64423. ** Change the pMem->zMalloc allocation to be at least szNew bytes.
  64424. ** If pMem->zMalloc already meets or exceeds the requested size, this
  64425. ** routine is a no-op.
  64426. **
  64427. ** Any prior string or blob content in the pMem object may be discarded.
  64428. ** The pMem->xDel destructor is called, if it exists. Though MEM_Str
  64429. ** and MEM_Blob values may be discarded, MEM_Int, MEM_Real, and MEM_Null
  64430. ** values are preserved.
  64431. **
  64432. ** Return SQLITE_OK on success or an error code (probably SQLITE_NOMEM)
  64433. ** if unable to complete the resizing.
  64434. */
  64435. SQLITE_PRIVATE int sqlite3VdbeMemClearAndResize(Mem *pMem, int szNew){
  64436. assert( szNew>0 );
  64437. assert( (pMem->flags & MEM_Dyn)==0 || pMem->szMalloc==0 );
  64438. if( pMem->szMalloc<szNew ){
  64439. return sqlite3VdbeMemGrow(pMem, szNew, 0);
  64440. }
  64441. assert( (pMem->flags & MEM_Dyn)==0 );
  64442. pMem->z = pMem->zMalloc;
  64443. pMem->flags &= (MEM_Null|MEM_Int|MEM_Real);
  64444. return SQLITE_OK;
  64445. }
  64446. /*
  64447. ** Change pMem so that its MEM_Str or MEM_Blob value is stored in
  64448. ** MEM.zMalloc, where it can be safely written.
  64449. **
  64450. ** Return SQLITE_OK on success or SQLITE_NOMEM if malloc fails.
  64451. */
  64452. SQLITE_PRIVATE int sqlite3VdbeMemMakeWriteable(Mem *pMem){
  64453. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64454. assert( (pMem->flags&MEM_RowSet)==0 );
  64455. if( (pMem->flags & (MEM_Str|MEM_Blob))!=0 ){
  64456. if( ExpandBlob(pMem) ) return SQLITE_NOMEM;
  64457. if( pMem->szMalloc==0 || pMem->z!=pMem->zMalloc ){
  64458. if( sqlite3VdbeMemGrow(pMem, pMem->n + 2, 1) ){
  64459. return SQLITE_NOMEM_BKPT;
  64460. }
  64461. pMem->z[pMem->n] = 0;
  64462. pMem->z[pMem->n+1] = 0;
  64463. pMem->flags |= MEM_Term;
  64464. }
  64465. }
  64466. pMem->flags &= ~MEM_Ephem;
  64467. #ifdef SQLITE_DEBUG
  64468. pMem->pScopyFrom = 0;
  64469. #endif
  64470. return SQLITE_OK;
  64471. }
  64472. /*
  64473. ** If the given Mem* has a zero-filled tail, turn it into an ordinary
  64474. ** blob stored in dynamically allocated space.
  64475. */
  64476. #ifndef SQLITE_OMIT_INCRBLOB
  64477. SQLITE_PRIVATE int sqlite3VdbeMemExpandBlob(Mem *pMem){
  64478. int nByte;
  64479. assert( pMem->flags & MEM_Zero );
  64480. assert( pMem->flags&MEM_Blob );
  64481. assert( (pMem->flags&MEM_RowSet)==0 );
  64482. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64483. /* Set nByte to the number of bytes required to store the expanded blob. */
  64484. nByte = pMem->n + pMem->u.nZero;
  64485. if( nByte<=0 ){
  64486. nByte = 1;
  64487. }
  64488. if( sqlite3VdbeMemGrow(pMem, nByte, 1) ){
  64489. return SQLITE_NOMEM_BKPT;
  64490. }
  64491. memset(&pMem->z[pMem->n], 0, pMem->u.nZero);
  64492. pMem->n += pMem->u.nZero;
  64493. pMem->flags &= ~(MEM_Zero|MEM_Term);
  64494. return SQLITE_OK;
  64495. }
  64496. #endif
  64497. /*
  64498. ** It is already known that pMem contains an unterminated string.
  64499. ** Add the zero terminator.
  64500. */
  64501. static SQLITE_NOINLINE int vdbeMemAddTerminator(Mem *pMem){
  64502. if( sqlite3VdbeMemGrow(pMem, pMem->n+2, 1) ){
  64503. return SQLITE_NOMEM_BKPT;
  64504. }
  64505. pMem->z[pMem->n] = 0;
  64506. pMem->z[pMem->n+1] = 0;
  64507. pMem->flags |= MEM_Term;
  64508. return SQLITE_OK;
  64509. }
  64510. /*
  64511. ** Make sure the given Mem is \u0000 terminated.
  64512. */
  64513. SQLITE_PRIVATE int sqlite3VdbeMemNulTerminate(Mem *pMem){
  64514. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64515. testcase( (pMem->flags & (MEM_Term|MEM_Str))==(MEM_Term|MEM_Str) );
  64516. testcase( (pMem->flags & (MEM_Term|MEM_Str))==0 );
  64517. if( (pMem->flags & (MEM_Term|MEM_Str))!=MEM_Str ){
  64518. return SQLITE_OK; /* Nothing to do */
  64519. }else{
  64520. return vdbeMemAddTerminator(pMem);
  64521. }
  64522. }
  64523. /*
  64524. ** Add MEM_Str to the set of representations for the given Mem. Numbers
  64525. ** are converted using sqlite3_snprintf(). Converting a BLOB to a string
  64526. ** is a no-op.
  64527. **
  64528. ** Existing representations MEM_Int and MEM_Real are invalidated if
  64529. ** bForce is true but are retained if bForce is false.
  64530. **
  64531. ** A MEM_Null value will never be passed to this function. This function is
  64532. ** used for converting values to text for returning to the user (i.e. via
  64533. ** sqlite3_value_text()), or for ensuring that values to be used as btree
  64534. ** keys are strings. In the former case a NULL pointer is returned the
  64535. ** user and the latter is an internal programming error.
  64536. */
  64537. SQLITE_PRIVATE int sqlite3VdbeMemStringify(Mem *pMem, u8 enc, u8 bForce){
  64538. int fg = pMem->flags;
  64539. const int nByte = 32;
  64540. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64541. assert( !(fg&MEM_Zero) );
  64542. assert( !(fg&(MEM_Str|MEM_Blob)) );
  64543. assert( fg&(MEM_Int|MEM_Real) );
  64544. assert( (pMem->flags&MEM_RowSet)==0 );
  64545. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64546. if( sqlite3VdbeMemClearAndResize(pMem, nByte) ){
  64547. pMem->enc = 0;
  64548. return SQLITE_NOMEM_BKPT;
  64549. }
  64550. /* For a Real or Integer, use sqlite3_snprintf() to produce the UTF-8
  64551. ** string representation of the value. Then, if the required encoding
  64552. ** is UTF-16le or UTF-16be do a translation.
  64553. **
  64554. ** FIX ME: It would be better if sqlite3_snprintf() could do UTF-16.
  64555. */
  64556. if( fg & MEM_Int ){
  64557. sqlite3_snprintf(nByte, pMem->z, "%lld", pMem->u.i);
  64558. }else{
  64559. assert( fg & MEM_Real );
  64560. sqlite3_snprintf(nByte, pMem->z, "%!.15g", pMem->u.r);
  64561. }
  64562. pMem->n = sqlite3Strlen30(pMem->z);
  64563. pMem->enc = SQLITE_UTF8;
  64564. pMem->flags |= MEM_Str|MEM_Term;
  64565. if( bForce ) pMem->flags &= ~(MEM_Int|MEM_Real);
  64566. sqlite3VdbeChangeEncoding(pMem, enc);
  64567. return SQLITE_OK;
  64568. }
  64569. /*
  64570. ** Memory cell pMem contains the context of an aggregate function.
  64571. ** This routine calls the finalize method for that function. The
  64572. ** result of the aggregate is stored back into pMem.
  64573. **
  64574. ** Return SQLITE_ERROR if the finalizer reports an error. SQLITE_OK
  64575. ** otherwise.
  64576. */
  64577. SQLITE_PRIVATE int sqlite3VdbeMemFinalize(Mem *pMem, FuncDef *pFunc){
  64578. int rc = SQLITE_OK;
  64579. if( ALWAYS(pFunc && pFunc->xFinalize) ){
  64580. sqlite3_context ctx;
  64581. Mem t;
  64582. assert( (pMem->flags & MEM_Null)!=0 || pFunc==pMem->u.pDef );
  64583. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64584. memset(&ctx, 0, sizeof(ctx));
  64585. memset(&t, 0, sizeof(t));
  64586. t.flags = MEM_Null;
  64587. t.db = pMem->db;
  64588. ctx.pOut = &t;
  64589. ctx.pMem = pMem;
  64590. ctx.pFunc = pFunc;
  64591. pFunc->xFinalize(&ctx); /* IMP: R-24505-23230 */
  64592. assert( (pMem->flags & MEM_Dyn)==0 );
  64593. if( pMem->szMalloc>0 ) sqlite3DbFree(pMem->db, pMem->zMalloc);
  64594. memcpy(pMem, &t, sizeof(t));
  64595. rc = ctx.isError;
  64596. }
  64597. return rc;
  64598. }
  64599. /*
  64600. ** If the memory cell contains a value that must be freed by
  64601. ** invoking the external callback in Mem.xDel, then this routine
  64602. ** will free that value. It also sets Mem.flags to MEM_Null.
  64603. **
  64604. ** This is a helper routine for sqlite3VdbeMemSetNull() and
  64605. ** for sqlite3VdbeMemRelease(). Use those other routines as the
  64606. ** entry point for releasing Mem resources.
  64607. */
  64608. static SQLITE_NOINLINE void vdbeMemClearExternAndSetNull(Mem *p){
  64609. assert( p->db==0 || sqlite3_mutex_held(p->db->mutex) );
  64610. assert( VdbeMemDynamic(p) );
  64611. if( p->flags&MEM_Agg ){
  64612. sqlite3VdbeMemFinalize(p, p->u.pDef);
  64613. assert( (p->flags & MEM_Agg)==0 );
  64614. testcase( p->flags & MEM_Dyn );
  64615. }
  64616. if( p->flags&MEM_Dyn ){
  64617. assert( (p->flags&MEM_RowSet)==0 );
  64618. assert( p->xDel!=SQLITE_DYNAMIC && p->xDel!=0 );
  64619. p->xDel((void *)p->z);
  64620. }else if( p->flags&MEM_RowSet ){
  64621. sqlite3RowSetClear(p->u.pRowSet);
  64622. }else if( p->flags&MEM_Frame ){
  64623. VdbeFrame *pFrame = p->u.pFrame;
  64624. pFrame->pParent = pFrame->v->pDelFrame;
  64625. pFrame->v->pDelFrame = pFrame;
  64626. }
  64627. p->flags = MEM_Null;
  64628. }
  64629. /*
  64630. ** Release memory held by the Mem p, both external memory cleared
  64631. ** by p->xDel and memory in p->zMalloc.
  64632. **
  64633. ** This is a helper routine invoked by sqlite3VdbeMemRelease() in
  64634. ** the unusual case where there really is memory in p that needs
  64635. ** to be freed.
  64636. */
  64637. static SQLITE_NOINLINE void vdbeMemClear(Mem *p){
  64638. if( VdbeMemDynamic(p) ){
  64639. vdbeMemClearExternAndSetNull(p);
  64640. }
  64641. if( p->szMalloc ){
  64642. sqlite3DbFree(p->db, p->zMalloc);
  64643. p->szMalloc = 0;
  64644. }
  64645. p->z = 0;
  64646. }
  64647. /*
  64648. ** Release any memory resources held by the Mem. Both the memory that is
  64649. ** free by Mem.xDel and the Mem.zMalloc allocation are freed.
  64650. **
  64651. ** Use this routine prior to clean up prior to abandoning a Mem, or to
  64652. ** reset a Mem back to its minimum memory utilization.
  64653. **
  64654. ** Use sqlite3VdbeMemSetNull() to release just the Mem.xDel space
  64655. ** prior to inserting new content into the Mem.
  64656. */
  64657. SQLITE_PRIVATE void sqlite3VdbeMemRelease(Mem *p){
  64658. assert( sqlite3VdbeCheckMemInvariants(p) );
  64659. if( VdbeMemDynamic(p) || p->szMalloc ){
  64660. vdbeMemClear(p);
  64661. }
  64662. }
  64663. /*
  64664. ** Convert a 64-bit IEEE double into a 64-bit signed integer.
  64665. ** If the double is out of range of a 64-bit signed integer then
  64666. ** return the closest available 64-bit signed integer.
  64667. */
  64668. static i64 doubleToInt64(double r){
  64669. #ifdef SQLITE_OMIT_FLOATING_POINT
  64670. /* When floating-point is omitted, double and int64 are the same thing */
  64671. return r;
  64672. #else
  64673. /*
  64674. ** Many compilers we encounter do not define constants for the
  64675. ** minimum and maximum 64-bit integers, or they define them
  64676. ** inconsistently. And many do not understand the "LL" notation.
  64677. ** So we define our own static constants here using nothing
  64678. ** larger than a 32-bit integer constant.
  64679. */
  64680. static const i64 maxInt = LARGEST_INT64;
  64681. static const i64 minInt = SMALLEST_INT64;
  64682. if( r<=(double)minInt ){
  64683. return minInt;
  64684. }else if( r>=(double)maxInt ){
  64685. return maxInt;
  64686. }else{
  64687. return (i64)r;
  64688. }
  64689. #endif
  64690. }
  64691. /*
  64692. ** Return some kind of integer value which is the best we can do
  64693. ** at representing the value that *pMem describes as an integer.
  64694. ** If pMem is an integer, then the value is exact. If pMem is
  64695. ** a floating-point then the value returned is the integer part.
  64696. ** If pMem is a string or blob, then we make an attempt to convert
  64697. ** it into an integer and return that. If pMem represents an
  64698. ** an SQL-NULL value, return 0.
  64699. **
  64700. ** If pMem represents a string value, its encoding might be changed.
  64701. */
  64702. SQLITE_PRIVATE i64 sqlite3VdbeIntValue(Mem *pMem){
  64703. int flags;
  64704. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64705. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64706. flags = pMem->flags;
  64707. if( flags & MEM_Int ){
  64708. return pMem->u.i;
  64709. }else if( flags & MEM_Real ){
  64710. return doubleToInt64(pMem->u.r);
  64711. }else if( flags & (MEM_Str|MEM_Blob) ){
  64712. i64 value = 0;
  64713. assert( pMem->z || pMem->n==0 );
  64714. sqlite3Atoi64(pMem->z, &value, pMem->n, pMem->enc);
  64715. return value;
  64716. }else{
  64717. return 0;
  64718. }
  64719. }
  64720. /*
  64721. ** Return the best representation of pMem that we can get into a
  64722. ** double. If pMem is already a double or an integer, return its
  64723. ** value. If it is a string or blob, try to convert it to a double.
  64724. ** If it is a NULL, return 0.0.
  64725. */
  64726. SQLITE_PRIVATE double sqlite3VdbeRealValue(Mem *pMem){
  64727. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64728. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64729. if( pMem->flags & MEM_Real ){
  64730. return pMem->u.r;
  64731. }else if( pMem->flags & MEM_Int ){
  64732. return (double)pMem->u.i;
  64733. }else if( pMem->flags & (MEM_Str|MEM_Blob) ){
  64734. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  64735. double val = (double)0;
  64736. sqlite3AtoF(pMem->z, &val, pMem->n, pMem->enc);
  64737. return val;
  64738. }else{
  64739. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  64740. return (double)0;
  64741. }
  64742. }
  64743. /*
  64744. ** The MEM structure is already a MEM_Real. Try to also make it a
  64745. ** MEM_Int if we can.
  64746. */
  64747. SQLITE_PRIVATE void sqlite3VdbeIntegerAffinity(Mem *pMem){
  64748. i64 ix;
  64749. assert( pMem->flags & MEM_Real );
  64750. assert( (pMem->flags & MEM_RowSet)==0 );
  64751. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64752. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64753. ix = doubleToInt64(pMem->u.r);
  64754. /* Only mark the value as an integer if
  64755. **
  64756. ** (1) the round-trip conversion real->int->real is a no-op, and
  64757. ** (2) The integer is neither the largest nor the smallest
  64758. ** possible integer (ticket #3922)
  64759. **
  64760. ** The second and third terms in the following conditional enforces
  64761. ** the second condition under the assumption that addition overflow causes
  64762. ** values to wrap around.
  64763. */
  64764. if( pMem->u.r==ix && ix>SMALLEST_INT64 && ix<LARGEST_INT64 ){
  64765. pMem->u.i = ix;
  64766. MemSetTypeFlag(pMem, MEM_Int);
  64767. }
  64768. }
  64769. /*
  64770. ** Convert pMem to type integer. Invalidate any prior representations.
  64771. */
  64772. SQLITE_PRIVATE int sqlite3VdbeMemIntegerify(Mem *pMem){
  64773. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64774. assert( (pMem->flags & MEM_RowSet)==0 );
  64775. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64776. pMem->u.i = sqlite3VdbeIntValue(pMem);
  64777. MemSetTypeFlag(pMem, MEM_Int);
  64778. return SQLITE_OK;
  64779. }
  64780. /*
  64781. ** Convert pMem so that it is of type MEM_Real.
  64782. ** Invalidate any prior representations.
  64783. */
  64784. SQLITE_PRIVATE int sqlite3VdbeMemRealify(Mem *pMem){
  64785. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64786. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  64787. pMem->u.r = sqlite3VdbeRealValue(pMem);
  64788. MemSetTypeFlag(pMem, MEM_Real);
  64789. return SQLITE_OK;
  64790. }
  64791. /*
  64792. ** Convert pMem so that it has types MEM_Real or MEM_Int or both.
  64793. ** Invalidate any prior representations.
  64794. **
  64795. ** Every effort is made to force the conversion, even if the input
  64796. ** is a string that does not look completely like a number. Convert
  64797. ** as much of the string as we can and ignore the rest.
  64798. */
  64799. SQLITE_PRIVATE int sqlite3VdbeMemNumerify(Mem *pMem){
  64800. if( (pMem->flags & (MEM_Int|MEM_Real|MEM_Null))==0 ){
  64801. assert( (pMem->flags & (MEM_Blob|MEM_Str))!=0 );
  64802. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  64803. if( 0==sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc) ){
  64804. MemSetTypeFlag(pMem, MEM_Int);
  64805. }else{
  64806. pMem->u.r = sqlite3VdbeRealValue(pMem);
  64807. MemSetTypeFlag(pMem, MEM_Real);
  64808. sqlite3VdbeIntegerAffinity(pMem);
  64809. }
  64810. }
  64811. assert( (pMem->flags & (MEM_Int|MEM_Real|MEM_Null))!=0 );
  64812. pMem->flags &= ~(MEM_Str|MEM_Blob|MEM_Zero);
  64813. return SQLITE_OK;
  64814. }
  64815. /*
  64816. ** Cast the datatype of the value in pMem according to the affinity
  64817. ** "aff". Casting is different from applying affinity in that a cast
  64818. ** is forced. In other words, the value is converted into the desired
  64819. ** affinity even if that results in loss of data. This routine is
  64820. ** used (for example) to implement the SQL "cast()" operator.
  64821. */
  64822. SQLITE_PRIVATE void sqlite3VdbeMemCast(Mem *pMem, u8 aff, u8 encoding){
  64823. if( pMem->flags & MEM_Null ) return;
  64824. switch( aff ){
  64825. case SQLITE_AFF_BLOB: { /* Really a cast to BLOB */
  64826. if( (pMem->flags & MEM_Blob)==0 ){
  64827. sqlite3ValueApplyAffinity(pMem, SQLITE_AFF_TEXT, encoding);
  64828. assert( pMem->flags & MEM_Str || pMem->db->mallocFailed );
  64829. if( pMem->flags & MEM_Str ) MemSetTypeFlag(pMem, MEM_Blob);
  64830. }else{
  64831. pMem->flags &= ~(MEM_TypeMask&~MEM_Blob);
  64832. }
  64833. break;
  64834. }
  64835. case SQLITE_AFF_NUMERIC: {
  64836. sqlite3VdbeMemNumerify(pMem);
  64837. break;
  64838. }
  64839. case SQLITE_AFF_INTEGER: {
  64840. sqlite3VdbeMemIntegerify(pMem);
  64841. break;
  64842. }
  64843. case SQLITE_AFF_REAL: {
  64844. sqlite3VdbeMemRealify(pMem);
  64845. break;
  64846. }
  64847. default: {
  64848. assert( aff==SQLITE_AFF_TEXT );
  64849. assert( MEM_Str==(MEM_Blob>>3) );
  64850. pMem->flags |= (pMem->flags&MEM_Blob)>>3;
  64851. sqlite3ValueApplyAffinity(pMem, SQLITE_AFF_TEXT, encoding);
  64852. assert( pMem->flags & MEM_Str || pMem->db->mallocFailed );
  64853. pMem->flags &= ~(MEM_Int|MEM_Real|MEM_Blob|MEM_Zero);
  64854. break;
  64855. }
  64856. }
  64857. }
  64858. /*
  64859. ** Initialize bulk memory to be a consistent Mem object.
  64860. **
  64861. ** The minimum amount of initialization feasible is performed.
  64862. */
  64863. SQLITE_PRIVATE void sqlite3VdbeMemInit(Mem *pMem, sqlite3 *db, u16 flags){
  64864. assert( (flags & ~MEM_TypeMask)==0 );
  64865. pMem->flags = flags;
  64866. pMem->db = db;
  64867. pMem->szMalloc = 0;
  64868. }
  64869. /*
  64870. ** Delete any previous value and set the value stored in *pMem to NULL.
  64871. **
  64872. ** This routine calls the Mem.xDel destructor to dispose of values that
  64873. ** require the destructor. But it preserves the Mem.zMalloc memory allocation.
  64874. ** To free all resources, use sqlite3VdbeMemRelease(), which both calls this
  64875. ** routine to invoke the destructor and deallocates Mem.zMalloc.
  64876. **
  64877. ** Use this routine to reset the Mem prior to insert a new value.
  64878. **
  64879. ** Use sqlite3VdbeMemRelease() to complete erase the Mem prior to abandoning it.
  64880. */
  64881. SQLITE_PRIVATE void sqlite3VdbeMemSetNull(Mem *pMem){
  64882. if( VdbeMemDynamic(pMem) ){
  64883. vdbeMemClearExternAndSetNull(pMem);
  64884. }else{
  64885. pMem->flags = MEM_Null;
  64886. }
  64887. }
  64888. SQLITE_PRIVATE void sqlite3ValueSetNull(sqlite3_value *p){
  64889. sqlite3VdbeMemSetNull((Mem*)p);
  64890. }
  64891. /*
  64892. ** Delete any previous value and set the value to be a BLOB of length
  64893. ** n containing all zeros.
  64894. */
  64895. SQLITE_PRIVATE void sqlite3VdbeMemSetZeroBlob(Mem *pMem, int n){
  64896. sqlite3VdbeMemRelease(pMem);
  64897. pMem->flags = MEM_Blob|MEM_Zero;
  64898. pMem->n = 0;
  64899. if( n<0 ) n = 0;
  64900. pMem->u.nZero = n;
  64901. pMem->enc = SQLITE_UTF8;
  64902. pMem->z = 0;
  64903. }
  64904. /*
  64905. ** The pMem is known to contain content that needs to be destroyed prior
  64906. ** to a value change. So invoke the destructor, then set the value to
  64907. ** a 64-bit integer.
  64908. */
  64909. static SQLITE_NOINLINE void vdbeReleaseAndSetInt64(Mem *pMem, i64 val){
  64910. sqlite3VdbeMemSetNull(pMem);
  64911. pMem->u.i = val;
  64912. pMem->flags = MEM_Int;
  64913. }
  64914. /*
  64915. ** Delete any previous value and set the value stored in *pMem to val,
  64916. ** manifest type INTEGER.
  64917. */
  64918. SQLITE_PRIVATE void sqlite3VdbeMemSetInt64(Mem *pMem, i64 val){
  64919. if( VdbeMemDynamic(pMem) ){
  64920. vdbeReleaseAndSetInt64(pMem, val);
  64921. }else{
  64922. pMem->u.i = val;
  64923. pMem->flags = MEM_Int;
  64924. }
  64925. }
  64926. #ifndef SQLITE_OMIT_FLOATING_POINT
  64927. /*
  64928. ** Delete any previous value and set the value stored in *pMem to val,
  64929. ** manifest type REAL.
  64930. */
  64931. SQLITE_PRIVATE void sqlite3VdbeMemSetDouble(Mem *pMem, double val){
  64932. sqlite3VdbeMemSetNull(pMem);
  64933. if( !sqlite3IsNaN(val) ){
  64934. pMem->u.r = val;
  64935. pMem->flags = MEM_Real;
  64936. }
  64937. }
  64938. #endif
  64939. /*
  64940. ** Delete any previous value and set the value of pMem to be an
  64941. ** empty boolean index.
  64942. */
  64943. SQLITE_PRIVATE void sqlite3VdbeMemSetRowSet(Mem *pMem){
  64944. sqlite3 *db = pMem->db;
  64945. assert( db!=0 );
  64946. assert( (pMem->flags & MEM_RowSet)==0 );
  64947. sqlite3VdbeMemRelease(pMem);
  64948. pMem->zMalloc = sqlite3DbMallocRawNN(db, 64);
  64949. if( db->mallocFailed ){
  64950. pMem->flags = MEM_Null;
  64951. pMem->szMalloc = 0;
  64952. }else{
  64953. assert( pMem->zMalloc );
  64954. pMem->szMalloc = sqlite3DbMallocSize(db, pMem->zMalloc);
  64955. pMem->u.pRowSet = sqlite3RowSetInit(db, pMem->zMalloc, pMem->szMalloc);
  64956. assert( pMem->u.pRowSet!=0 );
  64957. pMem->flags = MEM_RowSet;
  64958. }
  64959. }
  64960. /*
  64961. ** Return true if the Mem object contains a TEXT or BLOB that is
  64962. ** too large - whose size exceeds SQLITE_MAX_LENGTH.
  64963. */
  64964. SQLITE_PRIVATE int sqlite3VdbeMemTooBig(Mem *p){
  64965. assert( p->db!=0 );
  64966. if( p->flags & (MEM_Str|MEM_Blob) ){
  64967. int n = p->n;
  64968. if( p->flags & MEM_Zero ){
  64969. n += p->u.nZero;
  64970. }
  64971. return n>p->db->aLimit[SQLITE_LIMIT_LENGTH];
  64972. }
  64973. return 0;
  64974. }
  64975. #ifdef SQLITE_DEBUG
  64976. /*
  64977. ** This routine prepares a memory cell for modification by breaking
  64978. ** its link to a shallow copy and by marking any current shallow
  64979. ** copies of this cell as invalid.
  64980. **
  64981. ** This is used for testing and debugging only - to make sure shallow
  64982. ** copies are not misused.
  64983. */
  64984. SQLITE_PRIVATE void sqlite3VdbeMemAboutToChange(Vdbe *pVdbe, Mem *pMem){
  64985. int i;
  64986. Mem *pX;
  64987. for(i=0, pX=pVdbe->aMem; i<pVdbe->nMem; i++, pX++){
  64988. if( pX->pScopyFrom==pMem ){
  64989. pX->flags |= MEM_Undefined;
  64990. pX->pScopyFrom = 0;
  64991. }
  64992. }
  64993. pMem->pScopyFrom = 0;
  64994. }
  64995. #endif /* SQLITE_DEBUG */
  64996. /*
  64997. ** Make an shallow copy of pFrom into pTo. Prior contents of
  64998. ** pTo are freed. The pFrom->z field is not duplicated. If
  64999. ** pFrom->z is used, then pTo->z points to the same thing as pFrom->z
  65000. ** and flags gets srcType (either MEM_Ephem or MEM_Static).
  65001. */
  65002. static SQLITE_NOINLINE void vdbeClrCopy(Mem *pTo, const Mem *pFrom, int eType){
  65003. vdbeMemClearExternAndSetNull(pTo);
  65004. assert( !VdbeMemDynamic(pTo) );
  65005. sqlite3VdbeMemShallowCopy(pTo, pFrom, eType);
  65006. }
  65007. SQLITE_PRIVATE void sqlite3VdbeMemShallowCopy(Mem *pTo, const Mem *pFrom, int srcType){
  65008. assert( (pFrom->flags & MEM_RowSet)==0 );
  65009. assert( pTo->db==pFrom->db );
  65010. if( VdbeMemDynamic(pTo) ){ vdbeClrCopy(pTo,pFrom,srcType); return; }
  65011. memcpy(pTo, pFrom, MEMCELLSIZE);
  65012. if( (pFrom->flags&MEM_Static)==0 ){
  65013. pTo->flags &= ~(MEM_Dyn|MEM_Static|MEM_Ephem);
  65014. assert( srcType==MEM_Ephem || srcType==MEM_Static );
  65015. pTo->flags |= srcType;
  65016. }
  65017. }
  65018. /*
  65019. ** Make a full copy of pFrom into pTo. Prior contents of pTo are
  65020. ** freed before the copy is made.
  65021. */
  65022. SQLITE_PRIVATE int sqlite3VdbeMemCopy(Mem *pTo, const Mem *pFrom){
  65023. int rc = SQLITE_OK;
  65024. assert( (pFrom->flags & MEM_RowSet)==0 );
  65025. if( VdbeMemDynamic(pTo) ) vdbeMemClearExternAndSetNull(pTo);
  65026. memcpy(pTo, pFrom, MEMCELLSIZE);
  65027. pTo->flags &= ~MEM_Dyn;
  65028. if( pTo->flags&(MEM_Str|MEM_Blob) ){
  65029. if( 0==(pFrom->flags&MEM_Static) ){
  65030. pTo->flags |= MEM_Ephem;
  65031. rc = sqlite3VdbeMemMakeWriteable(pTo);
  65032. }
  65033. }
  65034. return rc;
  65035. }
  65036. /*
  65037. ** Transfer the contents of pFrom to pTo. Any existing value in pTo is
  65038. ** freed. If pFrom contains ephemeral data, a copy is made.
  65039. **
  65040. ** pFrom contains an SQL NULL when this routine returns.
  65041. */
  65042. SQLITE_PRIVATE void sqlite3VdbeMemMove(Mem *pTo, Mem *pFrom){
  65043. assert( pFrom->db==0 || sqlite3_mutex_held(pFrom->db->mutex) );
  65044. assert( pTo->db==0 || sqlite3_mutex_held(pTo->db->mutex) );
  65045. assert( pFrom->db==0 || pTo->db==0 || pFrom->db==pTo->db );
  65046. sqlite3VdbeMemRelease(pTo);
  65047. memcpy(pTo, pFrom, sizeof(Mem));
  65048. pFrom->flags = MEM_Null;
  65049. pFrom->szMalloc = 0;
  65050. }
  65051. /*
  65052. ** Change the value of a Mem to be a string or a BLOB.
  65053. **
  65054. ** The memory management strategy depends on the value of the xDel
  65055. ** parameter. If the value passed is SQLITE_TRANSIENT, then the
  65056. ** string is copied into a (possibly existing) buffer managed by the
  65057. ** Mem structure. Otherwise, any existing buffer is freed and the
  65058. ** pointer copied.
  65059. **
  65060. ** If the string is too large (if it exceeds the SQLITE_LIMIT_LENGTH
  65061. ** size limit) then no memory allocation occurs. If the string can be
  65062. ** stored without allocating memory, then it is. If a memory allocation
  65063. ** is required to store the string, then value of pMem is unchanged. In
  65064. ** either case, SQLITE_TOOBIG is returned.
  65065. */
  65066. SQLITE_PRIVATE int sqlite3VdbeMemSetStr(
  65067. Mem *pMem, /* Memory cell to set to string value */
  65068. const char *z, /* String pointer */
  65069. int n, /* Bytes in string, or negative */
  65070. u8 enc, /* Encoding of z. 0 for BLOBs */
  65071. void (*xDel)(void*) /* Destructor function */
  65072. ){
  65073. int nByte = n; /* New value for pMem->n */
  65074. int iLimit; /* Maximum allowed string or blob size */
  65075. u16 flags = 0; /* New value for pMem->flags */
  65076. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  65077. assert( (pMem->flags & MEM_RowSet)==0 );
  65078. /* If z is a NULL pointer, set pMem to contain an SQL NULL. */
  65079. if( !z ){
  65080. sqlite3VdbeMemSetNull(pMem);
  65081. return SQLITE_OK;
  65082. }
  65083. if( pMem->db ){
  65084. iLimit = pMem->db->aLimit[SQLITE_LIMIT_LENGTH];
  65085. }else{
  65086. iLimit = SQLITE_MAX_LENGTH;
  65087. }
  65088. flags = (enc==0?MEM_Blob:MEM_Str);
  65089. if( nByte<0 ){
  65090. assert( enc!=0 );
  65091. if( enc==SQLITE_UTF8 ){
  65092. nByte = sqlite3Strlen30(z);
  65093. if( nByte>iLimit ) nByte = iLimit+1;
  65094. }else{
  65095. for(nByte=0; nByte<=iLimit && (z[nByte] | z[nByte+1]); nByte+=2){}
  65096. }
  65097. flags |= MEM_Term;
  65098. }
  65099. /* The following block sets the new values of Mem.z and Mem.xDel. It
  65100. ** also sets a flag in local variable "flags" to indicate the memory
  65101. ** management (one of MEM_Dyn or MEM_Static).
  65102. */
  65103. if( xDel==SQLITE_TRANSIENT ){
  65104. int nAlloc = nByte;
  65105. if( flags&MEM_Term ){
  65106. nAlloc += (enc==SQLITE_UTF8?1:2);
  65107. }
  65108. if( nByte>iLimit ){
  65109. return SQLITE_TOOBIG;
  65110. }
  65111. testcase( nAlloc==0 );
  65112. testcase( nAlloc==31 );
  65113. testcase( nAlloc==32 );
  65114. if( sqlite3VdbeMemClearAndResize(pMem, MAX(nAlloc,32)) ){
  65115. return SQLITE_NOMEM_BKPT;
  65116. }
  65117. memcpy(pMem->z, z, nAlloc);
  65118. }else if( xDel==SQLITE_DYNAMIC ){
  65119. sqlite3VdbeMemRelease(pMem);
  65120. pMem->zMalloc = pMem->z = (char *)z;
  65121. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->zMalloc);
  65122. }else{
  65123. sqlite3VdbeMemRelease(pMem);
  65124. pMem->z = (char *)z;
  65125. pMem->xDel = xDel;
  65126. flags |= ((xDel==SQLITE_STATIC)?MEM_Static:MEM_Dyn);
  65127. }
  65128. pMem->n = nByte;
  65129. pMem->flags = flags;
  65130. pMem->enc = (enc==0 ? SQLITE_UTF8 : enc);
  65131. #ifndef SQLITE_OMIT_UTF16
  65132. if( pMem->enc!=SQLITE_UTF8 && sqlite3VdbeMemHandleBom(pMem) ){
  65133. return SQLITE_NOMEM_BKPT;
  65134. }
  65135. #endif
  65136. if( nByte>iLimit ){
  65137. return SQLITE_TOOBIG;
  65138. }
  65139. return SQLITE_OK;
  65140. }
  65141. /*
  65142. ** Move data out of a btree key or data field and into a Mem structure.
  65143. ** The data or key is taken from the entry that pCur is currently pointing
  65144. ** to. offset and amt determine what portion of the data or key to retrieve.
  65145. ** key is true to get the key or false to get data. The result is written
  65146. ** into the pMem element.
  65147. **
  65148. ** The pMem object must have been initialized. This routine will use
  65149. ** pMem->zMalloc to hold the content from the btree, if possible. New
  65150. ** pMem->zMalloc space will be allocated if necessary. The calling routine
  65151. ** is responsible for making sure that the pMem object is eventually
  65152. ** destroyed.
  65153. **
  65154. ** If this routine fails for any reason (malloc returns NULL or unable
  65155. ** to read from the disk) then the pMem is left in an inconsistent state.
  65156. */
  65157. static SQLITE_NOINLINE int vdbeMemFromBtreeResize(
  65158. BtCursor *pCur, /* Cursor pointing at record to retrieve. */
  65159. u32 offset, /* Offset from the start of data to return bytes from. */
  65160. u32 amt, /* Number of bytes to return. */
  65161. int key, /* If true, retrieve from the btree key, not data. */
  65162. Mem *pMem /* OUT: Return data in this Mem structure. */
  65163. ){
  65164. int rc;
  65165. pMem->flags = MEM_Null;
  65166. if( SQLITE_OK==(rc = sqlite3VdbeMemClearAndResize(pMem, amt+2)) ){
  65167. if( key ){
  65168. rc = sqlite3BtreeKey(pCur, offset, amt, pMem->z);
  65169. }else{
  65170. rc = sqlite3BtreeData(pCur, offset, amt, pMem->z);
  65171. }
  65172. if( rc==SQLITE_OK ){
  65173. pMem->z[amt] = 0;
  65174. pMem->z[amt+1] = 0;
  65175. pMem->flags = MEM_Blob|MEM_Term;
  65176. pMem->n = (int)amt;
  65177. }else{
  65178. sqlite3VdbeMemRelease(pMem);
  65179. }
  65180. }
  65181. return rc;
  65182. }
  65183. SQLITE_PRIVATE int sqlite3VdbeMemFromBtree(
  65184. BtCursor *pCur, /* Cursor pointing at record to retrieve. */
  65185. u32 offset, /* Offset from the start of data to return bytes from. */
  65186. u32 amt, /* Number of bytes to return. */
  65187. int key, /* If true, retrieve from the btree key, not data. */
  65188. Mem *pMem /* OUT: Return data in this Mem structure. */
  65189. ){
  65190. char *zData; /* Data from the btree layer */
  65191. u32 available = 0; /* Number of bytes available on the local btree page */
  65192. int rc = SQLITE_OK; /* Return code */
  65193. assert( sqlite3BtreeCursorIsValid(pCur) );
  65194. assert( !VdbeMemDynamic(pMem) );
  65195. /* Note: the calls to BtreeKeyFetch() and DataFetch() below assert()
  65196. ** that both the BtShared and database handle mutexes are held. */
  65197. assert( (pMem->flags & MEM_RowSet)==0 );
  65198. zData = (char *)sqlite3BtreePayloadFetch(pCur, &available);
  65199. assert( zData!=0 );
  65200. if( offset+amt<=available ){
  65201. pMem->z = &zData[offset];
  65202. pMem->flags = MEM_Blob|MEM_Ephem;
  65203. pMem->n = (int)amt;
  65204. }else{
  65205. rc = vdbeMemFromBtreeResize(pCur, offset, amt, key, pMem);
  65206. }
  65207. return rc;
  65208. }
  65209. /*
  65210. ** The pVal argument is known to be a value other than NULL.
  65211. ** Convert it into a string with encoding enc and return a pointer
  65212. ** to a zero-terminated version of that string.
  65213. */
  65214. static SQLITE_NOINLINE const void *valueToText(sqlite3_value* pVal, u8 enc){
  65215. assert( pVal!=0 );
  65216. assert( pVal->db==0 || sqlite3_mutex_held(pVal->db->mutex) );
  65217. assert( (enc&3)==(enc&~SQLITE_UTF16_ALIGNED) );
  65218. assert( (pVal->flags & MEM_RowSet)==0 );
  65219. assert( (pVal->flags & (MEM_Null))==0 );
  65220. if( pVal->flags & (MEM_Blob|MEM_Str) ){
  65221. pVal->flags |= MEM_Str;
  65222. if( pVal->enc != (enc & ~SQLITE_UTF16_ALIGNED) ){
  65223. sqlite3VdbeChangeEncoding(pVal, enc & ~SQLITE_UTF16_ALIGNED);
  65224. }
  65225. if( (enc & SQLITE_UTF16_ALIGNED)!=0 && 1==(1&SQLITE_PTR_TO_INT(pVal->z)) ){
  65226. assert( (pVal->flags & (MEM_Ephem|MEM_Static))!=0 );
  65227. if( sqlite3VdbeMemMakeWriteable(pVal)!=SQLITE_OK ){
  65228. return 0;
  65229. }
  65230. }
  65231. sqlite3VdbeMemNulTerminate(pVal); /* IMP: R-31275-44060 */
  65232. }else{
  65233. sqlite3VdbeMemStringify(pVal, enc, 0);
  65234. assert( 0==(1&SQLITE_PTR_TO_INT(pVal->z)) );
  65235. }
  65236. assert(pVal->enc==(enc & ~SQLITE_UTF16_ALIGNED) || pVal->db==0
  65237. || pVal->db->mallocFailed );
  65238. if( pVal->enc==(enc & ~SQLITE_UTF16_ALIGNED) ){
  65239. return pVal->z;
  65240. }else{
  65241. return 0;
  65242. }
  65243. }
  65244. /* This function is only available internally, it is not part of the
  65245. ** external API. It works in a similar way to sqlite3_value_text(),
  65246. ** except the data returned is in the encoding specified by the second
  65247. ** parameter, which must be one of SQLITE_UTF16BE, SQLITE_UTF16LE or
  65248. ** SQLITE_UTF8.
  65249. **
  65250. ** (2006-02-16:) The enc value can be or-ed with SQLITE_UTF16_ALIGNED.
  65251. ** If that is the case, then the result must be aligned on an even byte
  65252. ** boundary.
  65253. */
  65254. SQLITE_PRIVATE const void *sqlite3ValueText(sqlite3_value* pVal, u8 enc){
  65255. if( !pVal ) return 0;
  65256. assert( pVal->db==0 || sqlite3_mutex_held(pVal->db->mutex) );
  65257. assert( (enc&3)==(enc&~SQLITE_UTF16_ALIGNED) );
  65258. assert( (pVal->flags & MEM_RowSet)==0 );
  65259. if( (pVal->flags&(MEM_Str|MEM_Term))==(MEM_Str|MEM_Term) && pVal->enc==enc ){
  65260. return pVal->z;
  65261. }
  65262. if( pVal->flags&MEM_Null ){
  65263. return 0;
  65264. }
  65265. return valueToText(pVal, enc);
  65266. }
  65267. /*
  65268. ** Create a new sqlite3_value object.
  65269. */
  65270. SQLITE_PRIVATE sqlite3_value *sqlite3ValueNew(sqlite3 *db){
  65271. Mem *p = sqlite3DbMallocZero(db, sizeof(*p));
  65272. if( p ){
  65273. p->flags = MEM_Null;
  65274. p->db = db;
  65275. }
  65276. return p;
  65277. }
  65278. /*
  65279. ** Context object passed by sqlite3Stat4ProbeSetValue() through to
  65280. ** valueNew(). See comments above valueNew() for details.
  65281. */
  65282. struct ValueNewStat4Ctx {
  65283. Parse *pParse;
  65284. Index *pIdx;
  65285. UnpackedRecord **ppRec;
  65286. int iVal;
  65287. };
  65288. /*
  65289. ** Allocate and return a pointer to a new sqlite3_value object. If
  65290. ** the second argument to this function is NULL, the object is allocated
  65291. ** by calling sqlite3ValueNew().
  65292. **
  65293. ** Otherwise, if the second argument is non-zero, then this function is
  65294. ** being called indirectly by sqlite3Stat4ProbeSetValue(). If it has not
  65295. ** already been allocated, allocate the UnpackedRecord structure that
  65296. ** that function will return to its caller here. Then return a pointer to
  65297. ** an sqlite3_value within the UnpackedRecord.a[] array.
  65298. */
  65299. static sqlite3_value *valueNew(sqlite3 *db, struct ValueNewStat4Ctx *p){
  65300. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  65301. if( p ){
  65302. UnpackedRecord *pRec = p->ppRec[0];
  65303. if( pRec==0 ){
  65304. Index *pIdx = p->pIdx; /* Index being probed */
  65305. int nByte; /* Bytes of space to allocate */
  65306. int i; /* Counter variable */
  65307. int nCol = pIdx->nColumn; /* Number of index columns including rowid */
  65308. nByte = sizeof(Mem) * nCol + ROUND8(sizeof(UnpackedRecord));
  65309. pRec = (UnpackedRecord*)sqlite3DbMallocZero(db, nByte);
  65310. if( pRec ){
  65311. pRec->pKeyInfo = sqlite3KeyInfoOfIndex(p->pParse, pIdx);
  65312. if( pRec->pKeyInfo ){
  65313. assert( pRec->pKeyInfo->nField+pRec->pKeyInfo->nXField==nCol );
  65314. assert( pRec->pKeyInfo->enc==ENC(db) );
  65315. pRec->aMem = (Mem *)((u8*)pRec + ROUND8(sizeof(UnpackedRecord)));
  65316. for(i=0; i<nCol; i++){
  65317. pRec->aMem[i].flags = MEM_Null;
  65318. pRec->aMem[i].db = db;
  65319. }
  65320. }else{
  65321. sqlite3DbFree(db, pRec);
  65322. pRec = 0;
  65323. }
  65324. }
  65325. if( pRec==0 ) return 0;
  65326. p->ppRec[0] = pRec;
  65327. }
  65328. pRec->nField = p->iVal+1;
  65329. return &pRec->aMem[p->iVal];
  65330. }
  65331. #else
  65332. UNUSED_PARAMETER(p);
  65333. #endif /* defined(SQLITE_ENABLE_STAT3_OR_STAT4) */
  65334. return sqlite3ValueNew(db);
  65335. }
  65336. /*
  65337. ** The expression object indicated by the second argument is guaranteed
  65338. ** to be a scalar SQL function. If
  65339. **
  65340. ** * all function arguments are SQL literals,
  65341. ** * one of the SQLITE_FUNC_CONSTANT or _SLOCHNG function flags is set, and
  65342. ** * the SQLITE_FUNC_NEEDCOLL function flag is not set,
  65343. **
  65344. ** then this routine attempts to invoke the SQL function. Assuming no
  65345. ** error occurs, output parameter (*ppVal) is set to point to a value
  65346. ** object containing the result before returning SQLITE_OK.
  65347. **
  65348. ** Affinity aff is applied to the result of the function before returning.
  65349. ** If the result is a text value, the sqlite3_value object uses encoding
  65350. ** enc.
  65351. **
  65352. ** If the conditions above are not met, this function returns SQLITE_OK
  65353. ** and sets (*ppVal) to NULL. Or, if an error occurs, (*ppVal) is set to
  65354. ** NULL and an SQLite error code returned.
  65355. */
  65356. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  65357. static int valueFromFunction(
  65358. sqlite3 *db, /* The database connection */
  65359. Expr *p, /* The expression to evaluate */
  65360. u8 enc, /* Encoding to use */
  65361. u8 aff, /* Affinity to use */
  65362. sqlite3_value **ppVal, /* Write the new value here */
  65363. struct ValueNewStat4Ctx *pCtx /* Second argument for valueNew() */
  65364. ){
  65365. sqlite3_context ctx; /* Context object for function invocation */
  65366. sqlite3_value **apVal = 0; /* Function arguments */
  65367. int nVal = 0; /* Size of apVal[] array */
  65368. FuncDef *pFunc = 0; /* Function definition */
  65369. sqlite3_value *pVal = 0; /* New value */
  65370. int rc = SQLITE_OK; /* Return code */
  65371. ExprList *pList = 0; /* Function arguments */
  65372. int i; /* Iterator variable */
  65373. assert( pCtx!=0 );
  65374. assert( (p->flags & EP_TokenOnly)==0 );
  65375. pList = p->x.pList;
  65376. if( pList ) nVal = pList->nExpr;
  65377. pFunc = sqlite3FindFunction(db, p->u.zToken, nVal, enc, 0);
  65378. assert( pFunc );
  65379. if( (pFunc->funcFlags & (SQLITE_FUNC_CONSTANT|SQLITE_FUNC_SLOCHNG))==0
  65380. || (pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
  65381. ){
  65382. return SQLITE_OK;
  65383. }
  65384. if( pList ){
  65385. apVal = (sqlite3_value**)sqlite3DbMallocZero(db, sizeof(apVal[0]) * nVal);
  65386. if( apVal==0 ){
  65387. rc = SQLITE_NOMEM_BKPT;
  65388. goto value_from_function_out;
  65389. }
  65390. for(i=0; i<nVal; i++){
  65391. rc = sqlite3ValueFromExpr(db, pList->a[i].pExpr, enc, aff, &apVal[i]);
  65392. if( apVal[i]==0 || rc!=SQLITE_OK ) goto value_from_function_out;
  65393. }
  65394. }
  65395. pVal = valueNew(db, pCtx);
  65396. if( pVal==0 ){
  65397. rc = SQLITE_NOMEM_BKPT;
  65398. goto value_from_function_out;
  65399. }
  65400. assert( pCtx->pParse->rc==SQLITE_OK );
  65401. memset(&ctx, 0, sizeof(ctx));
  65402. ctx.pOut = pVal;
  65403. ctx.pFunc = pFunc;
  65404. pFunc->xSFunc(&ctx, nVal, apVal);
  65405. if( ctx.isError ){
  65406. rc = ctx.isError;
  65407. sqlite3ErrorMsg(pCtx->pParse, "%s", sqlite3_value_text(pVal));
  65408. }else{
  65409. sqlite3ValueApplyAffinity(pVal, aff, SQLITE_UTF8);
  65410. assert( rc==SQLITE_OK );
  65411. rc = sqlite3VdbeChangeEncoding(pVal, enc);
  65412. if( rc==SQLITE_OK && sqlite3VdbeMemTooBig(pVal) ){
  65413. rc = SQLITE_TOOBIG;
  65414. pCtx->pParse->nErr++;
  65415. }
  65416. }
  65417. pCtx->pParse->rc = rc;
  65418. value_from_function_out:
  65419. if( rc!=SQLITE_OK ){
  65420. pVal = 0;
  65421. }
  65422. if( apVal ){
  65423. for(i=0; i<nVal; i++){
  65424. sqlite3ValueFree(apVal[i]);
  65425. }
  65426. sqlite3DbFree(db, apVal);
  65427. }
  65428. *ppVal = pVal;
  65429. return rc;
  65430. }
  65431. #else
  65432. # define valueFromFunction(a,b,c,d,e,f) SQLITE_OK
  65433. #endif /* defined(SQLITE_ENABLE_STAT3_OR_STAT4) */
  65434. /*
  65435. ** Extract a value from the supplied expression in the manner described
  65436. ** above sqlite3ValueFromExpr(). Allocate the sqlite3_value object
  65437. ** using valueNew().
  65438. **
  65439. ** If pCtx is NULL and an error occurs after the sqlite3_value object
  65440. ** has been allocated, it is freed before returning. Or, if pCtx is not
  65441. ** NULL, it is assumed that the caller will free any allocated object
  65442. ** in all cases.
  65443. */
  65444. static int valueFromExpr(
  65445. sqlite3 *db, /* The database connection */
  65446. Expr *pExpr, /* The expression to evaluate */
  65447. u8 enc, /* Encoding to use */
  65448. u8 affinity, /* Affinity to use */
  65449. sqlite3_value **ppVal, /* Write the new value here */
  65450. struct ValueNewStat4Ctx *pCtx /* Second argument for valueNew() */
  65451. ){
  65452. int op;
  65453. char *zVal = 0;
  65454. sqlite3_value *pVal = 0;
  65455. int negInt = 1;
  65456. const char *zNeg = "";
  65457. int rc = SQLITE_OK;
  65458. assert( pExpr!=0 );
  65459. while( (op = pExpr->op)==TK_UPLUS || op==TK_SPAN ) pExpr = pExpr->pLeft;
  65460. if( NEVER(op==TK_REGISTER) ) op = pExpr->op2;
  65461. /* Compressed expressions only appear when parsing the DEFAULT clause
  65462. ** on a table column definition, and hence only when pCtx==0. This
  65463. ** check ensures that an EP_TokenOnly expression is never passed down
  65464. ** into valueFromFunction(). */
  65465. assert( (pExpr->flags & EP_TokenOnly)==0 || pCtx==0 );
  65466. if( op==TK_CAST ){
  65467. u8 aff = sqlite3AffinityType(pExpr->u.zToken,0);
  65468. rc = valueFromExpr(db, pExpr->pLeft, enc, aff, ppVal, pCtx);
  65469. testcase( rc!=SQLITE_OK );
  65470. if( *ppVal ){
  65471. sqlite3VdbeMemCast(*ppVal, aff, SQLITE_UTF8);
  65472. sqlite3ValueApplyAffinity(*ppVal, affinity, SQLITE_UTF8);
  65473. }
  65474. return rc;
  65475. }
  65476. /* Handle negative integers in a single step. This is needed in the
  65477. ** case when the value is -9223372036854775808.
  65478. */
  65479. if( op==TK_UMINUS
  65480. && (pExpr->pLeft->op==TK_INTEGER || pExpr->pLeft->op==TK_FLOAT) ){
  65481. pExpr = pExpr->pLeft;
  65482. op = pExpr->op;
  65483. negInt = -1;
  65484. zNeg = "-";
  65485. }
  65486. if( op==TK_STRING || op==TK_FLOAT || op==TK_INTEGER ){
  65487. pVal = valueNew(db, pCtx);
  65488. if( pVal==0 ) goto no_mem;
  65489. if( ExprHasProperty(pExpr, EP_IntValue) ){
  65490. sqlite3VdbeMemSetInt64(pVal, (i64)pExpr->u.iValue*negInt);
  65491. }else{
  65492. zVal = sqlite3MPrintf(db, "%s%s", zNeg, pExpr->u.zToken);
  65493. if( zVal==0 ) goto no_mem;
  65494. sqlite3ValueSetStr(pVal, -1, zVal, SQLITE_UTF8, SQLITE_DYNAMIC);
  65495. }
  65496. if( (op==TK_INTEGER || op==TK_FLOAT ) && affinity==SQLITE_AFF_BLOB ){
  65497. sqlite3ValueApplyAffinity(pVal, SQLITE_AFF_NUMERIC, SQLITE_UTF8);
  65498. }else{
  65499. sqlite3ValueApplyAffinity(pVal, affinity, SQLITE_UTF8);
  65500. }
  65501. if( pVal->flags & (MEM_Int|MEM_Real) ) pVal->flags &= ~MEM_Str;
  65502. if( enc!=SQLITE_UTF8 ){
  65503. rc = sqlite3VdbeChangeEncoding(pVal, enc);
  65504. }
  65505. }else if( op==TK_UMINUS ) {
  65506. /* This branch happens for multiple negative signs. Ex: -(-5) */
  65507. if( SQLITE_OK==sqlite3ValueFromExpr(db,pExpr->pLeft,enc,affinity,&pVal)
  65508. && pVal!=0
  65509. ){
  65510. sqlite3VdbeMemNumerify(pVal);
  65511. if( pVal->flags & MEM_Real ){
  65512. pVal->u.r = -pVal->u.r;
  65513. }else if( pVal->u.i==SMALLEST_INT64 ){
  65514. pVal->u.r = -(double)SMALLEST_INT64;
  65515. MemSetTypeFlag(pVal, MEM_Real);
  65516. }else{
  65517. pVal->u.i = -pVal->u.i;
  65518. }
  65519. sqlite3ValueApplyAffinity(pVal, affinity, enc);
  65520. }
  65521. }else if( op==TK_NULL ){
  65522. pVal = valueNew(db, pCtx);
  65523. if( pVal==0 ) goto no_mem;
  65524. }
  65525. #ifndef SQLITE_OMIT_BLOB_LITERAL
  65526. else if( op==TK_BLOB ){
  65527. int nVal;
  65528. assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
  65529. assert( pExpr->u.zToken[1]=='\'' );
  65530. pVal = valueNew(db, pCtx);
  65531. if( !pVal ) goto no_mem;
  65532. zVal = &pExpr->u.zToken[2];
  65533. nVal = sqlite3Strlen30(zVal)-1;
  65534. assert( zVal[nVal]=='\'' );
  65535. sqlite3VdbeMemSetStr(pVal, sqlite3HexToBlob(db, zVal, nVal), nVal/2,
  65536. 0, SQLITE_DYNAMIC);
  65537. }
  65538. #endif
  65539. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  65540. else if( op==TK_FUNCTION && pCtx!=0 ){
  65541. rc = valueFromFunction(db, pExpr, enc, affinity, &pVal, pCtx);
  65542. }
  65543. #endif
  65544. *ppVal = pVal;
  65545. return rc;
  65546. no_mem:
  65547. sqlite3OomFault(db);
  65548. sqlite3DbFree(db, zVal);
  65549. assert( *ppVal==0 );
  65550. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  65551. if( pCtx==0 ) sqlite3ValueFree(pVal);
  65552. #else
  65553. assert( pCtx==0 ); sqlite3ValueFree(pVal);
  65554. #endif
  65555. return SQLITE_NOMEM_BKPT;
  65556. }
  65557. /*
  65558. ** Create a new sqlite3_value object, containing the value of pExpr.
  65559. **
  65560. ** This only works for very simple expressions that consist of one constant
  65561. ** token (i.e. "5", "5.1", "'a string'"). If the expression can
  65562. ** be converted directly into a value, then the value is allocated and
  65563. ** a pointer written to *ppVal. The caller is responsible for deallocating
  65564. ** the value by passing it to sqlite3ValueFree() later on. If the expression
  65565. ** cannot be converted to a value, then *ppVal is set to NULL.
  65566. */
  65567. SQLITE_PRIVATE int sqlite3ValueFromExpr(
  65568. sqlite3 *db, /* The database connection */
  65569. Expr *pExpr, /* The expression to evaluate */
  65570. u8 enc, /* Encoding to use */
  65571. u8 affinity, /* Affinity to use */
  65572. sqlite3_value **ppVal /* Write the new value here */
  65573. ){
  65574. return pExpr ? valueFromExpr(db, pExpr, enc, affinity, ppVal, 0) : 0;
  65575. }
  65576. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  65577. /*
  65578. ** The implementation of the sqlite_record() function. This function accepts
  65579. ** a single argument of any type. The return value is a formatted database
  65580. ** record (a blob) containing the argument value.
  65581. **
  65582. ** This is used to convert the value stored in the 'sample' column of the
  65583. ** sqlite_stat3 table to the record format SQLite uses internally.
  65584. */
  65585. static void recordFunc(
  65586. sqlite3_context *context,
  65587. int argc,
  65588. sqlite3_value **argv
  65589. ){
  65590. const int file_format = 1;
  65591. u32 iSerial; /* Serial type */
  65592. int nSerial; /* Bytes of space for iSerial as varint */
  65593. u32 nVal; /* Bytes of space required for argv[0] */
  65594. int nRet;
  65595. sqlite3 *db;
  65596. u8 *aRet;
  65597. UNUSED_PARAMETER( argc );
  65598. iSerial = sqlite3VdbeSerialType(argv[0], file_format, &nVal);
  65599. nSerial = sqlite3VarintLen(iSerial);
  65600. db = sqlite3_context_db_handle(context);
  65601. nRet = 1 + nSerial + nVal;
  65602. aRet = sqlite3DbMallocRawNN(db, nRet);
  65603. if( aRet==0 ){
  65604. sqlite3_result_error_nomem(context);
  65605. }else{
  65606. aRet[0] = nSerial+1;
  65607. putVarint32(&aRet[1], iSerial);
  65608. sqlite3VdbeSerialPut(&aRet[1+nSerial], argv[0], iSerial);
  65609. sqlite3_result_blob(context, aRet, nRet, SQLITE_TRANSIENT);
  65610. sqlite3DbFree(db, aRet);
  65611. }
  65612. }
  65613. /*
  65614. ** Register built-in functions used to help read ANALYZE data.
  65615. */
  65616. SQLITE_PRIVATE void sqlite3AnalyzeFunctions(void){
  65617. static FuncDef aAnalyzeTableFuncs[] = {
  65618. FUNCTION(sqlite_record, 1, 0, 0, recordFunc),
  65619. };
  65620. sqlite3InsertBuiltinFuncs(aAnalyzeTableFuncs, ArraySize(aAnalyzeTableFuncs));
  65621. }
  65622. /*
  65623. ** Attempt to extract a value from pExpr and use it to construct *ppVal.
  65624. **
  65625. ** If pAlloc is not NULL, then an UnpackedRecord object is created for
  65626. ** pAlloc if one does not exist and the new value is added to the
  65627. ** UnpackedRecord object.
  65628. **
  65629. ** A value is extracted in the following cases:
  65630. **
  65631. ** * (pExpr==0). In this case the value is assumed to be an SQL NULL,
  65632. **
  65633. ** * The expression is a bound variable, and this is a reprepare, or
  65634. **
  65635. ** * The expression is a literal value.
  65636. **
  65637. ** On success, *ppVal is made to point to the extracted value. The caller
  65638. ** is responsible for ensuring that the value is eventually freed.
  65639. */
  65640. static int stat4ValueFromExpr(
  65641. Parse *pParse, /* Parse context */
  65642. Expr *pExpr, /* The expression to extract a value from */
  65643. u8 affinity, /* Affinity to use */
  65644. struct ValueNewStat4Ctx *pAlloc,/* How to allocate space. Or NULL */
  65645. sqlite3_value **ppVal /* OUT: New value object (or NULL) */
  65646. ){
  65647. int rc = SQLITE_OK;
  65648. sqlite3_value *pVal = 0;
  65649. sqlite3 *db = pParse->db;
  65650. /* Skip over any TK_COLLATE nodes */
  65651. pExpr = sqlite3ExprSkipCollate(pExpr);
  65652. if( !pExpr ){
  65653. pVal = valueNew(db, pAlloc);
  65654. if( pVal ){
  65655. sqlite3VdbeMemSetNull((Mem*)pVal);
  65656. }
  65657. }else if( pExpr->op==TK_VARIABLE
  65658. || NEVER(pExpr->op==TK_REGISTER && pExpr->op2==TK_VARIABLE)
  65659. ){
  65660. Vdbe *v;
  65661. int iBindVar = pExpr->iColumn;
  65662. sqlite3VdbeSetVarmask(pParse->pVdbe, iBindVar);
  65663. if( (v = pParse->pReprepare)!=0 ){
  65664. pVal = valueNew(db, pAlloc);
  65665. if( pVal ){
  65666. rc = sqlite3VdbeMemCopy((Mem*)pVal, &v->aVar[iBindVar-1]);
  65667. if( rc==SQLITE_OK ){
  65668. sqlite3ValueApplyAffinity(pVal, affinity, ENC(db));
  65669. }
  65670. pVal->db = pParse->db;
  65671. }
  65672. }
  65673. }else{
  65674. rc = valueFromExpr(db, pExpr, ENC(db), affinity, &pVal, pAlloc);
  65675. }
  65676. assert( pVal==0 || pVal->db==db );
  65677. *ppVal = pVal;
  65678. return rc;
  65679. }
  65680. /*
  65681. ** This function is used to allocate and populate UnpackedRecord
  65682. ** structures intended to be compared against sample index keys stored
  65683. ** in the sqlite_stat4 table.
  65684. **
  65685. ** A single call to this function populates zero or more fields of the
  65686. ** record starting with field iVal (fields are numbered from left to
  65687. ** right starting with 0). A single field is populated if:
  65688. **
  65689. ** * (pExpr==0). In this case the value is assumed to be an SQL NULL,
  65690. **
  65691. ** * The expression is a bound variable, and this is a reprepare, or
  65692. **
  65693. ** * The sqlite3ValueFromExpr() function is able to extract a value
  65694. ** from the expression (i.e. the expression is a literal value).
  65695. **
  65696. ** Or, if pExpr is a TK_VECTOR, one field is populated for each of the
  65697. ** vector components that match either of the two latter criteria listed
  65698. ** above.
  65699. **
  65700. ** Before any value is appended to the record, the affinity of the
  65701. ** corresponding column within index pIdx is applied to it. Before
  65702. ** this function returns, output parameter *pnExtract is set to the
  65703. ** number of values appended to the record.
  65704. **
  65705. ** When this function is called, *ppRec must either point to an object
  65706. ** allocated by an earlier call to this function, or must be NULL. If it
  65707. ** is NULL and a value can be successfully extracted, a new UnpackedRecord
  65708. ** is allocated (and *ppRec set to point to it) before returning.
  65709. **
  65710. ** Unless an error is encountered, SQLITE_OK is returned. It is not an
  65711. ** error if a value cannot be extracted from pExpr. If an error does
  65712. ** occur, an SQLite error code is returned.
  65713. */
  65714. SQLITE_PRIVATE int sqlite3Stat4ProbeSetValue(
  65715. Parse *pParse, /* Parse context */
  65716. Index *pIdx, /* Index being probed */
  65717. UnpackedRecord **ppRec, /* IN/OUT: Probe record */
  65718. Expr *pExpr, /* The expression to extract a value from */
  65719. int nElem, /* Maximum number of values to append */
  65720. int iVal, /* Array element to populate */
  65721. int *pnExtract /* OUT: Values appended to the record */
  65722. ){
  65723. int rc = SQLITE_OK;
  65724. int nExtract = 0;
  65725. if( pExpr==0 || pExpr->op!=TK_SELECT ){
  65726. int i;
  65727. struct ValueNewStat4Ctx alloc;
  65728. alloc.pParse = pParse;
  65729. alloc.pIdx = pIdx;
  65730. alloc.ppRec = ppRec;
  65731. for(i=0; i<nElem; i++){
  65732. sqlite3_value *pVal = 0;
  65733. Expr *pElem = (pExpr ? sqlite3VectorFieldSubexpr(pExpr, i) : 0);
  65734. u8 aff = sqlite3IndexColumnAffinity(pParse->db, pIdx, iVal+i);
  65735. alloc.iVal = iVal+i;
  65736. rc = stat4ValueFromExpr(pParse, pElem, aff, &alloc, &pVal);
  65737. if( !pVal ) break;
  65738. nExtract++;
  65739. }
  65740. }
  65741. *pnExtract = nExtract;
  65742. return rc;
  65743. }
  65744. /*
  65745. ** Attempt to extract a value from expression pExpr using the methods
  65746. ** as described for sqlite3Stat4ProbeSetValue() above.
  65747. **
  65748. ** If successful, set *ppVal to point to a new value object and return
  65749. ** SQLITE_OK. If no value can be extracted, but no other error occurs
  65750. ** (e.g. OOM), return SQLITE_OK and set *ppVal to NULL. Or, if an error
  65751. ** does occur, return an SQLite error code. The final value of *ppVal
  65752. ** is undefined in this case.
  65753. */
  65754. SQLITE_PRIVATE int sqlite3Stat4ValueFromExpr(
  65755. Parse *pParse, /* Parse context */
  65756. Expr *pExpr, /* The expression to extract a value from */
  65757. u8 affinity, /* Affinity to use */
  65758. sqlite3_value **ppVal /* OUT: New value object (or NULL) */
  65759. ){
  65760. return stat4ValueFromExpr(pParse, pExpr, affinity, 0, ppVal);
  65761. }
  65762. /*
  65763. ** Extract the iCol-th column from the nRec-byte record in pRec. Write
  65764. ** the column value into *ppVal. If *ppVal is initially NULL then a new
  65765. ** sqlite3_value object is allocated.
  65766. **
  65767. ** If *ppVal is initially NULL then the caller is responsible for
  65768. ** ensuring that the value written into *ppVal is eventually freed.
  65769. */
  65770. SQLITE_PRIVATE int sqlite3Stat4Column(
  65771. sqlite3 *db, /* Database handle */
  65772. const void *pRec, /* Pointer to buffer containing record */
  65773. int nRec, /* Size of buffer pRec in bytes */
  65774. int iCol, /* Column to extract */
  65775. sqlite3_value **ppVal /* OUT: Extracted value */
  65776. ){
  65777. u32 t; /* a column type code */
  65778. int nHdr; /* Size of the header in the record */
  65779. int iHdr; /* Next unread header byte */
  65780. int iField; /* Next unread data byte */
  65781. int szField; /* Size of the current data field */
  65782. int i; /* Column index */
  65783. u8 *a = (u8*)pRec; /* Typecast byte array */
  65784. Mem *pMem = *ppVal; /* Write result into this Mem object */
  65785. assert( iCol>0 );
  65786. iHdr = getVarint32(a, nHdr);
  65787. if( nHdr>nRec || iHdr>=nHdr ) return SQLITE_CORRUPT_BKPT;
  65788. iField = nHdr;
  65789. for(i=0; i<=iCol; i++){
  65790. iHdr += getVarint32(&a[iHdr], t);
  65791. testcase( iHdr==nHdr );
  65792. testcase( iHdr==nHdr+1 );
  65793. if( iHdr>nHdr ) return SQLITE_CORRUPT_BKPT;
  65794. szField = sqlite3VdbeSerialTypeLen(t);
  65795. iField += szField;
  65796. }
  65797. testcase( iField==nRec );
  65798. testcase( iField==nRec+1 );
  65799. if( iField>nRec ) return SQLITE_CORRUPT_BKPT;
  65800. if( pMem==0 ){
  65801. pMem = *ppVal = sqlite3ValueNew(db);
  65802. if( pMem==0 ) return SQLITE_NOMEM_BKPT;
  65803. }
  65804. sqlite3VdbeSerialGet(&a[iField-szField], t, pMem);
  65805. pMem->enc = ENC(db);
  65806. return SQLITE_OK;
  65807. }
  65808. /*
  65809. ** Unless it is NULL, the argument must be an UnpackedRecord object returned
  65810. ** by an earlier call to sqlite3Stat4ProbeSetValue(). This call deletes
  65811. ** the object.
  65812. */
  65813. SQLITE_PRIVATE void sqlite3Stat4ProbeFree(UnpackedRecord *pRec){
  65814. if( pRec ){
  65815. int i;
  65816. int nCol = pRec->pKeyInfo->nField+pRec->pKeyInfo->nXField;
  65817. Mem *aMem = pRec->aMem;
  65818. sqlite3 *db = aMem[0].db;
  65819. for(i=0; i<nCol; i++){
  65820. sqlite3VdbeMemRelease(&aMem[i]);
  65821. }
  65822. sqlite3KeyInfoUnref(pRec->pKeyInfo);
  65823. sqlite3DbFree(db, pRec);
  65824. }
  65825. }
  65826. #endif /* ifdef SQLITE_ENABLE_STAT4 */
  65827. /*
  65828. ** Change the string value of an sqlite3_value object
  65829. */
  65830. SQLITE_PRIVATE void sqlite3ValueSetStr(
  65831. sqlite3_value *v, /* Value to be set */
  65832. int n, /* Length of string z */
  65833. const void *z, /* Text of the new string */
  65834. u8 enc, /* Encoding to use */
  65835. void (*xDel)(void*) /* Destructor for the string */
  65836. ){
  65837. if( v ) sqlite3VdbeMemSetStr((Mem *)v, z, n, enc, xDel);
  65838. }
  65839. /*
  65840. ** Free an sqlite3_value object
  65841. */
  65842. SQLITE_PRIVATE void sqlite3ValueFree(sqlite3_value *v){
  65843. if( !v ) return;
  65844. sqlite3VdbeMemRelease((Mem *)v);
  65845. sqlite3DbFree(((Mem*)v)->db, v);
  65846. }
  65847. /*
  65848. ** The sqlite3ValueBytes() routine returns the number of bytes in the
  65849. ** sqlite3_value object assuming that it uses the encoding "enc".
  65850. ** The valueBytes() routine is a helper function.
  65851. */
  65852. static SQLITE_NOINLINE int valueBytes(sqlite3_value *pVal, u8 enc){
  65853. return valueToText(pVal, enc)!=0 ? pVal->n : 0;
  65854. }
  65855. SQLITE_PRIVATE int sqlite3ValueBytes(sqlite3_value *pVal, u8 enc){
  65856. Mem *p = (Mem*)pVal;
  65857. assert( (p->flags & MEM_Null)==0 || (p->flags & (MEM_Str|MEM_Blob))==0 );
  65858. if( (p->flags & MEM_Str)!=0 && pVal->enc==enc ){
  65859. return p->n;
  65860. }
  65861. if( (p->flags & MEM_Blob)!=0 ){
  65862. if( p->flags & MEM_Zero ){
  65863. return p->n + p->u.nZero;
  65864. }else{
  65865. return p->n;
  65866. }
  65867. }
  65868. if( p->flags & MEM_Null ) return 0;
  65869. return valueBytes(pVal, enc);
  65870. }
  65871. /************** End of vdbemem.c *********************************************/
  65872. /************** Begin file vdbeaux.c *****************************************/
  65873. /*
  65874. ** 2003 September 6
  65875. **
  65876. ** The author disclaims copyright to this source code. In place of
  65877. ** a legal notice, here is a blessing:
  65878. **
  65879. ** May you do good and not evil.
  65880. ** May you find forgiveness for yourself and forgive others.
  65881. ** May you share freely, never taking more than you give.
  65882. **
  65883. *************************************************************************
  65884. ** This file contains code used for creating, destroying, and populating
  65885. ** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)
  65886. */
  65887. /* #include "sqliteInt.h" */
  65888. /* #include "vdbeInt.h" */
  65889. /*
  65890. ** Create a new virtual database engine.
  65891. */
  65892. SQLITE_PRIVATE Vdbe *sqlite3VdbeCreate(Parse *pParse){
  65893. sqlite3 *db = pParse->db;
  65894. Vdbe *p;
  65895. p = sqlite3DbMallocRawNN(db, sizeof(Vdbe) );
  65896. if( p==0 ) return 0;
  65897. memset(&p->aOp, 0, sizeof(Vdbe)-offsetof(Vdbe,aOp));
  65898. p->db = db;
  65899. if( db->pVdbe ){
  65900. db->pVdbe->pPrev = p;
  65901. }
  65902. p->pNext = db->pVdbe;
  65903. p->pPrev = 0;
  65904. db->pVdbe = p;
  65905. p->magic = VDBE_MAGIC_INIT;
  65906. p->pParse = pParse;
  65907. assert( pParse->aLabel==0 );
  65908. assert( pParse->nLabel==0 );
  65909. assert( pParse->nOpAlloc==0 );
  65910. assert( pParse->szOpAlloc==0 );
  65911. return p;
  65912. }
  65913. /*
  65914. ** Change the error string stored in Vdbe.zErrMsg
  65915. */
  65916. SQLITE_PRIVATE void sqlite3VdbeError(Vdbe *p, const char *zFormat, ...){
  65917. va_list ap;
  65918. sqlite3DbFree(p->db, p->zErrMsg);
  65919. va_start(ap, zFormat);
  65920. p->zErrMsg = sqlite3VMPrintf(p->db, zFormat, ap);
  65921. va_end(ap);
  65922. }
  65923. /*
  65924. ** Remember the SQL string for a prepared statement.
  65925. */
  65926. SQLITE_PRIVATE void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, int isPrepareV2){
  65927. assert( isPrepareV2==1 || isPrepareV2==0 );
  65928. if( p==0 ) return;
  65929. #if defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_ENABLE_SQLLOG)
  65930. if( !isPrepareV2 ) return;
  65931. #endif
  65932. assert( p->zSql==0 );
  65933. p->zSql = sqlite3DbStrNDup(p->db, z, n);
  65934. p->isPrepareV2 = (u8)isPrepareV2;
  65935. }
  65936. /*
  65937. ** Swap all content between two VDBE structures.
  65938. */
  65939. SQLITE_PRIVATE void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
  65940. Vdbe tmp, *pTmp;
  65941. char *zTmp;
  65942. assert( pA->db==pB->db );
  65943. tmp = *pA;
  65944. *pA = *pB;
  65945. *pB = tmp;
  65946. pTmp = pA->pNext;
  65947. pA->pNext = pB->pNext;
  65948. pB->pNext = pTmp;
  65949. pTmp = pA->pPrev;
  65950. pA->pPrev = pB->pPrev;
  65951. pB->pPrev = pTmp;
  65952. zTmp = pA->zSql;
  65953. pA->zSql = pB->zSql;
  65954. pB->zSql = zTmp;
  65955. pB->isPrepareV2 = pA->isPrepareV2;
  65956. }
  65957. /*
  65958. ** Resize the Vdbe.aOp array so that it is at least nOp elements larger
  65959. ** than its current size. nOp is guaranteed to be less than or equal
  65960. ** to 1024/sizeof(Op).
  65961. **
  65962. ** If an out-of-memory error occurs while resizing the array, return
  65963. ** SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
  65964. ** unchanged (this is so that any opcodes already allocated can be
  65965. ** correctly deallocated along with the rest of the Vdbe).
  65966. */
  65967. static int growOpArray(Vdbe *v, int nOp){
  65968. VdbeOp *pNew;
  65969. Parse *p = v->pParse;
  65970. /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
  65971. ** more frequent reallocs and hence provide more opportunities for
  65972. ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
  65973. ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
  65974. ** by the minimum* amount required until the size reaches 512. Normal
  65975. ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
  65976. ** size of the op array or add 1KB of space, whichever is smaller. */
  65977. #ifdef SQLITE_TEST_REALLOC_STRESS
  65978. int nNew = (p->nOpAlloc>=512 ? p->nOpAlloc*2 : p->nOpAlloc+nOp);
  65979. #else
  65980. int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
  65981. UNUSED_PARAMETER(nOp);
  65982. #endif
  65983. assert( nOp<=(1024/sizeof(Op)) );
  65984. assert( nNew>=(p->nOpAlloc+nOp) );
  65985. pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
  65986. if( pNew ){
  65987. p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
  65988. p->nOpAlloc = p->szOpAlloc/sizeof(Op);
  65989. v->aOp = pNew;
  65990. }
  65991. return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
  65992. }
  65993. #ifdef SQLITE_DEBUG
  65994. /* This routine is just a convenient place to set a breakpoint that will
  65995. ** fire after each opcode is inserted and displayed using
  65996. ** "PRAGMA vdbe_addoptrace=on".
  65997. */
  65998. static void test_addop_breakpoint(void){
  65999. static int n = 0;
  66000. n++;
  66001. }
  66002. #endif
  66003. /*
  66004. ** Add a new instruction to the list of instructions current in the
  66005. ** VDBE. Return the address of the new instruction.
  66006. **
  66007. ** Parameters:
  66008. **
  66009. ** p Pointer to the VDBE
  66010. **
  66011. ** op The opcode for this instruction
  66012. **
  66013. ** p1, p2, p3 Operands
  66014. **
  66015. ** Use the sqlite3VdbeResolveLabel() function to fix an address and
  66016. ** the sqlite3VdbeChangeP4() function to change the value of the P4
  66017. ** operand.
  66018. */
  66019. static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
  66020. assert( p->pParse->nOpAlloc<=p->nOp );
  66021. if( growOpArray(p, 1) ) return 1;
  66022. assert( p->pParse->nOpAlloc>p->nOp );
  66023. return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  66024. }
  66025. SQLITE_PRIVATE int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
  66026. int i;
  66027. VdbeOp *pOp;
  66028. i = p->nOp;
  66029. assert( p->magic==VDBE_MAGIC_INIT );
  66030. assert( op>=0 && op<0xff );
  66031. if( p->pParse->nOpAlloc<=i ){
  66032. return growOp3(p, op, p1, p2, p3);
  66033. }
  66034. p->nOp++;
  66035. pOp = &p->aOp[i];
  66036. pOp->opcode = (u8)op;
  66037. pOp->p5 = 0;
  66038. pOp->p1 = p1;
  66039. pOp->p2 = p2;
  66040. pOp->p3 = p3;
  66041. pOp->p4.p = 0;
  66042. pOp->p4type = P4_NOTUSED;
  66043. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  66044. pOp->zComment = 0;
  66045. #endif
  66046. #ifdef SQLITE_DEBUG
  66047. if( p->db->flags & SQLITE_VdbeAddopTrace ){
  66048. int jj, kk;
  66049. Parse *pParse = p->pParse;
  66050. for(jj=kk=0; jj<pParse->nColCache; jj++){
  66051. struct yColCache *x = pParse->aColCache + jj;
  66052. printf(" r[%d]={%d:%d}", x->iReg, x->iTable, x->iColumn);
  66053. kk++;
  66054. }
  66055. if( kk ) printf("\n");
  66056. sqlite3VdbePrintOp(0, i, &p->aOp[i]);
  66057. test_addop_breakpoint();
  66058. }
  66059. #endif
  66060. #ifdef VDBE_PROFILE
  66061. pOp->cycles = 0;
  66062. pOp->cnt = 0;
  66063. #endif
  66064. #ifdef SQLITE_VDBE_COVERAGE
  66065. pOp->iSrcLine = 0;
  66066. #endif
  66067. return i;
  66068. }
  66069. SQLITE_PRIVATE int sqlite3VdbeAddOp0(Vdbe *p, int op){
  66070. return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
  66071. }
  66072. SQLITE_PRIVATE int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
  66073. return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
  66074. }
  66075. SQLITE_PRIVATE int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
  66076. return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
  66077. }
  66078. /* Generate code for an unconditional jump to instruction iDest
  66079. */
  66080. SQLITE_PRIVATE int sqlite3VdbeGoto(Vdbe *p, int iDest){
  66081. return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
  66082. }
  66083. /* Generate code to cause the string zStr to be loaded into
  66084. ** register iDest
  66085. */
  66086. SQLITE_PRIVATE int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
  66087. return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
  66088. }
  66089. /*
  66090. ** Generate code that initializes multiple registers to string or integer
  66091. ** constants. The registers begin with iDest and increase consecutively.
  66092. ** One register is initialized for each characgter in zTypes[]. For each
  66093. ** "s" character in zTypes[], the register is a string if the argument is
  66094. ** not NULL, or OP_Null if the value is a null pointer. For each "i" character
  66095. ** in zTypes[], the register is initialized to an integer.
  66096. */
  66097. SQLITE_PRIVATE void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
  66098. va_list ap;
  66099. int i;
  66100. char c;
  66101. va_start(ap, zTypes);
  66102. for(i=0; (c = zTypes[i])!=0; i++){
  66103. if( c=='s' ){
  66104. const char *z = va_arg(ap, const char*);
  66105. sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest++, 0, z, 0);
  66106. }else{
  66107. assert( c=='i' );
  66108. sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest++);
  66109. }
  66110. }
  66111. va_end(ap);
  66112. }
  66113. /*
  66114. ** Add an opcode that includes the p4 value as a pointer.
  66115. */
  66116. SQLITE_PRIVATE int sqlite3VdbeAddOp4(
  66117. Vdbe *p, /* Add the opcode to this VM */
  66118. int op, /* The new opcode */
  66119. int p1, /* The P1 operand */
  66120. int p2, /* The P2 operand */
  66121. int p3, /* The P3 operand */
  66122. const char *zP4, /* The P4 operand */
  66123. int p4type /* P4 operand type */
  66124. ){
  66125. int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  66126. sqlite3VdbeChangeP4(p, addr, zP4, p4type);
  66127. return addr;
  66128. }
  66129. /*
  66130. ** Add an opcode that includes the p4 value with a P4_INT64 or
  66131. ** P4_REAL type.
  66132. */
  66133. SQLITE_PRIVATE int sqlite3VdbeAddOp4Dup8(
  66134. Vdbe *p, /* Add the opcode to this VM */
  66135. int op, /* The new opcode */
  66136. int p1, /* The P1 operand */
  66137. int p2, /* The P2 operand */
  66138. int p3, /* The P3 operand */
  66139. const u8 *zP4, /* The P4 operand */
  66140. int p4type /* P4 operand type */
  66141. ){
  66142. char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
  66143. if( p4copy ) memcpy(p4copy, zP4, 8);
  66144. return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
  66145. }
  66146. /*
  66147. ** Add an OP_ParseSchema opcode. This routine is broken out from
  66148. ** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
  66149. ** as having been used.
  66150. **
  66151. ** The zWhere string must have been obtained from sqlite3_malloc().
  66152. ** This routine will take ownership of the allocated memory.
  66153. */
  66154. SQLITE_PRIVATE void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
  66155. int j;
  66156. sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
  66157. for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
  66158. }
  66159. /*
  66160. ** Add an opcode that includes the p4 value as an integer.
  66161. */
  66162. SQLITE_PRIVATE int sqlite3VdbeAddOp4Int(
  66163. Vdbe *p, /* Add the opcode to this VM */
  66164. int op, /* The new opcode */
  66165. int p1, /* The P1 operand */
  66166. int p2, /* The P2 operand */
  66167. int p3, /* The P3 operand */
  66168. int p4 /* The P4 operand as an integer */
  66169. ){
  66170. int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  66171. sqlite3VdbeChangeP4(p, addr, SQLITE_INT_TO_PTR(p4), P4_INT32);
  66172. return addr;
  66173. }
  66174. /* Insert the end of a co-routine
  66175. */
  66176. SQLITE_PRIVATE void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
  66177. sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
  66178. /* Clear the temporary register cache, thereby ensuring that each
  66179. ** co-routine has its own independent set of registers, because co-routines
  66180. ** might expect their registers to be preserved across an OP_Yield, and
  66181. ** that could cause problems if two or more co-routines are using the same
  66182. ** temporary register.
  66183. */
  66184. v->pParse->nTempReg = 0;
  66185. v->pParse->nRangeReg = 0;
  66186. }
  66187. /*
  66188. ** Create a new symbolic label for an instruction that has yet to be
  66189. ** coded. The symbolic label is really just a negative number. The
  66190. ** label can be used as the P2 value of an operation. Later, when
  66191. ** the label is resolved to a specific address, the VDBE will scan
  66192. ** through its operation list and change all values of P2 which match
  66193. ** the label into the resolved address.
  66194. **
  66195. ** The VDBE knows that a P2 value is a label because labels are
  66196. ** always negative and P2 values are suppose to be non-negative.
  66197. ** Hence, a negative P2 value is a label that has yet to be resolved.
  66198. **
  66199. ** Zero is returned if a malloc() fails.
  66200. */
  66201. SQLITE_PRIVATE int sqlite3VdbeMakeLabel(Vdbe *v){
  66202. Parse *p = v->pParse;
  66203. int i = p->nLabel++;
  66204. assert( v->magic==VDBE_MAGIC_INIT );
  66205. if( (i & (i-1))==0 ){
  66206. p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
  66207. (i*2+1)*sizeof(p->aLabel[0]));
  66208. }
  66209. if( p->aLabel ){
  66210. p->aLabel[i] = -1;
  66211. }
  66212. return ADDR(i);
  66213. }
  66214. /*
  66215. ** Resolve label "x" to be the address of the next instruction to
  66216. ** be inserted. The parameter "x" must have been obtained from
  66217. ** a prior call to sqlite3VdbeMakeLabel().
  66218. */
  66219. SQLITE_PRIVATE void sqlite3VdbeResolveLabel(Vdbe *v, int x){
  66220. Parse *p = v->pParse;
  66221. int j = ADDR(x);
  66222. assert( v->magic==VDBE_MAGIC_INIT );
  66223. assert( j<p->nLabel );
  66224. assert( j>=0 );
  66225. if( p->aLabel ){
  66226. p->aLabel[j] = v->nOp;
  66227. }
  66228. }
  66229. /*
  66230. ** Mark the VDBE as one that can only be run one time.
  66231. */
  66232. SQLITE_PRIVATE void sqlite3VdbeRunOnlyOnce(Vdbe *p){
  66233. p->runOnlyOnce = 1;
  66234. }
  66235. /*
  66236. ** Mark the VDBE as one that can only be run multiple times.
  66237. */
  66238. SQLITE_PRIVATE void sqlite3VdbeReusable(Vdbe *p){
  66239. p->runOnlyOnce = 0;
  66240. }
  66241. #ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
  66242. /*
  66243. ** The following type and function are used to iterate through all opcodes
  66244. ** in a Vdbe main program and each of the sub-programs (triggers) it may
  66245. ** invoke directly or indirectly. It should be used as follows:
  66246. **
  66247. ** Op *pOp;
  66248. ** VdbeOpIter sIter;
  66249. **
  66250. ** memset(&sIter, 0, sizeof(sIter));
  66251. ** sIter.v = v; // v is of type Vdbe*
  66252. ** while( (pOp = opIterNext(&sIter)) ){
  66253. ** // Do something with pOp
  66254. ** }
  66255. ** sqlite3DbFree(v->db, sIter.apSub);
  66256. **
  66257. */
  66258. typedef struct VdbeOpIter VdbeOpIter;
  66259. struct VdbeOpIter {
  66260. Vdbe *v; /* Vdbe to iterate through the opcodes of */
  66261. SubProgram **apSub; /* Array of subprograms */
  66262. int nSub; /* Number of entries in apSub */
  66263. int iAddr; /* Address of next instruction to return */
  66264. int iSub; /* 0 = main program, 1 = first sub-program etc. */
  66265. };
  66266. static Op *opIterNext(VdbeOpIter *p){
  66267. Vdbe *v = p->v;
  66268. Op *pRet = 0;
  66269. Op *aOp;
  66270. int nOp;
  66271. if( p->iSub<=p->nSub ){
  66272. if( p->iSub==0 ){
  66273. aOp = v->aOp;
  66274. nOp = v->nOp;
  66275. }else{
  66276. aOp = p->apSub[p->iSub-1]->aOp;
  66277. nOp = p->apSub[p->iSub-1]->nOp;
  66278. }
  66279. assert( p->iAddr<nOp );
  66280. pRet = &aOp[p->iAddr];
  66281. p->iAddr++;
  66282. if( p->iAddr==nOp ){
  66283. p->iSub++;
  66284. p->iAddr = 0;
  66285. }
  66286. if( pRet->p4type==P4_SUBPROGRAM ){
  66287. int nByte = (p->nSub+1)*sizeof(SubProgram*);
  66288. int j;
  66289. for(j=0; j<p->nSub; j++){
  66290. if( p->apSub[j]==pRet->p4.pProgram ) break;
  66291. }
  66292. if( j==p->nSub ){
  66293. p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
  66294. if( !p->apSub ){
  66295. pRet = 0;
  66296. }else{
  66297. p->apSub[p->nSub++] = pRet->p4.pProgram;
  66298. }
  66299. }
  66300. }
  66301. }
  66302. return pRet;
  66303. }
  66304. /*
  66305. ** Check if the program stored in the VM associated with pParse may
  66306. ** throw an ABORT exception (causing the statement, but not entire transaction
  66307. ** to be rolled back). This condition is true if the main program or any
  66308. ** sub-programs contains any of the following:
  66309. **
  66310. ** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
  66311. ** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
  66312. ** * OP_Destroy
  66313. ** * OP_VUpdate
  66314. ** * OP_VRename
  66315. ** * OP_FkCounter with P2==0 (immediate foreign key constraint)
  66316. ** * OP_CreateTable and OP_InitCoroutine (for CREATE TABLE AS SELECT ...)
  66317. **
  66318. ** Then check that the value of Parse.mayAbort is true if an
  66319. ** ABORT may be thrown, or false otherwise. Return true if it does
  66320. ** match, or false otherwise. This function is intended to be used as
  66321. ** part of an assert statement in the compiler. Similar to:
  66322. **
  66323. ** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
  66324. */
  66325. SQLITE_PRIVATE int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
  66326. int hasAbort = 0;
  66327. int hasFkCounter = 0;
  66328. int hasCreateTable = 0;
  66329. int hasInitCoroutine = 0;
  66330. Op *pOp;
  66331. VdbeOpIter sIter;
  66332. memset(&sIter, 0, sizeof(sIter));
  66333. sIter.v = v;
  66334. while( (pOp = opIterNext(&sIter))!=0 ){
  66335. int opcode = pOp->opcode;
  66336. if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
  66337. || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
  66338. && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
  66339. ){
  66340. hasAbort = 1;
  66341. break;
  66342. }
  66343. if( opcode==OP_CreateTable ) hasCreateTable = 1;
  66344. if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
  66345. #ifndef SQLITE_OMIT_FOREIGN_KEY
  66346. if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
  66347. hasFkCounter = 1;
  66348. }
  66349. #endif
  66350. }
  66351. sqlite3DbFree(v->db, sIter.apSub);
  66352. /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
  66353. ** If malloc failed, then the while() loop above may not have iterated
  66354. ** through all opcodes and hasAbort may be set incorrectly. Return
  66355. ** true for this case to prevent the assert() in the callers frame
  66356. ** from failing. */
  66357. return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
  66358. || (hasCreateTable && hasInitCoroutine) );
  66359. }
  66360. #endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
  66361. /*
  66362. ** This routine is called after all opcodes have been inserted. It loops
  66363. ** through all the opcodes and fixes up some details.
  66364. **
  66365. ** (1) For each jump instruction with a negative P2 value (a label)
  66366. ** resolve the P2 value to an actual address.
  66367. **
  66368. ** (2) Compute the maximum number of arguments used by any SQL function
  66369. ** and store that value in *pMaxFuncArgs.
  66370. **
  66371. ** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
  66372. ** indicate what the prepared statement actually does.
  66373. **
  66374. ** (4) Initialize the p4.xAdvance pointer on opcodes that use it.
  66375. **
  66376. ** (5) Reclaim the memory allocated for storing labels.
  66377. **
  66378. ** This routine will only function correctly if the mkopcodeh.tcl generator
  66379. ** script numbers the opcodes correctly. Changes to this routine must be
  66380. ** coordinated with changes to mkopcodeh.tcl.
  66381. */
  66382. static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
  66383. int nMaxArgs = *pMaxFuncArgs;
  66384. Op *pOp;
  66385. Parse *pParse = p->pParse;
  66386. int *aLabel = pParse->aLabel;
  66387. p->readOnly = 1;
  66388. p->bIsReader = 0;
  66389. pOp = &p->aOp[p->nOp-1];
  66390. while(1){
  66391. /* Only JUMP opcodes and the short list of special opcodes in the switch
  66392. ** below need to be considered. The mkopcodeh.tcl generator script groups
  66393. ** all these opcodes together near the front of the opcode list. Skip
  66394. ** any opcode that does not need processing by virtual of the fact that
  66395. ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
  66396. */
  66397. if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
  66398. /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
  66399. ** cases from this switch! */
  66400. switch( pOp->opcode ){
  66401. case OP_Transaction: {
  66402. if( pOp->p2!=0 ) p->readOnly = 0;
  66403. /* fall thru */
  66404. }
  66405. case OP_AutoCommit:
  66406. case OP_Savepoint: {
  66407. p->bIsReader = 1;
  66408. break;
  66409. }
  66410. #ifndef SQLITE_OMIT_WAL
  66411. case OP_Checkpoint:
  66412. #endif
  66413. case OP_Vacuum:
  66414. case OP_JournalMode: {
  66415. p->readOnly = 0;
  66416. p->bIsReader = 1;
  66417. break;
  66418. }
  66419. #ifndef SQLITE_OMIT_VIRTUALTABLE
  66420. case OP_VUpdate: {
  66421. if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
  66422. break;
  66423. }
  66424. case OP_VFilter: {
  66425. int n;
  66426. assert( (pOp - p->aOp) >= 3 );
  66427. assert( pOp[-1].opcode==OP_Integer );
  66428. n = pOp[-1].p1;
  66429. if( n>nMaxArgs ) nMaxArgs = n;
  66430. break;
  66431. }
  66432. #endif
  66433. case OP_Next:
  66434. case OP_NextIfOpen:
  66435. case OP_SorterNext: {
  66436. pOp->p4.xAdvance = sqlite3BtreeNext;
  66437. pOp->p4type = P4_ADVANCE;
  66438. break;
  66439. }
  66440. case OP_Prev:
  66441. case OP_PrevIfOpen: {
  66442. pOp->p4.xAdvance = sqlite3BtreePrevious;
  66443. pOp->p4type = P4_ADVANCE;
  66444. break;
  66445. }
  66446. }
  66447. if( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 && pOp->p2<0 ){
  66448. assert( ADDR(pOp->p2)<pParse->nLabel );
  66449. pOp->p2 = aLabel[ADDR(pOp->p2)];
  66450. }
  66451. }
  66452. if( pOp==p->aOp ) break;
  66453. pOp--;
  66454. }
  66455. sqlite3DbFree(p->db, pParse->aLabel);
  66456. pParse->aLabel = 0;
  66457. pParse->nLabel = 0;
  66458. *pMaxFuncArgs = nMaxArgs;
  66459. assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
  66460. }
  66461. /*
  66462. ** Return the address of the next instruction to be inserted.
  66463. */
  66464. SQLITE_PRIVATE int sqlite3VdbeCurrentAddr(Vdbe *p){
  66465. assert( p->magic==VDBE_MAGIC_INIT );
  66466. return p->nOp;
  66467. }
  66468. /*
  66469. ** Verify that at least N opcode slots are available in p without
  66470. ** having to malloc for more space (except when compiled using
  66471. ** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
  66472. ** to verify that certain calls to sqlite3VdbeAddOpList() can never
  66473. ** fail due to a OOM fault and hence that the return value from
  66474. ** sqlite3VdbeAddOpList() will always be non-NULL.
  66475. */
  66476. #if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
  66477. SQLITE_PRIVATE void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
  66478. assert( p->nOp + N <= p->pParse->nOpAlloc );
  66479. }
  66480. #endif
  66481. /*
  66482. ** This function returns a pointer to the array of opcodes associated with
  66483. ** the Vdbe passed as the first argument. It is the callers responsibility
  66484. ** to arrange for the returned array to be eventually freed using the
  66485. ** vdbeFreeOpArray() function.
  66486. **
  66487. ** Before returning, *pnOp is set to the number of entries in the returned
  66488. ** array. Also, *pnMaxArg is set to the larger of its current value and
  66489. ** the number of entries in the Vdbe.apArg[] array required to execute the
  66490. ** returned program.
  66491. */
  66492. SQLITE_PRIVATE VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
  66493. VdbeOp *aOp = p->aOp;
  66494. assert( aOp && !p->db->mallocFailed );
  66495. /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
  66496. assert( DbMaskAllZero(p->btreeMask) );
  66497. resolveP2Values(p, pnMaxArg);
  66498. *pnOp = p->nOp;
  66499. p->aOp = 0;
  66500. return aOp;
  66501. }
  66502. /*
  66503. ** Add a whole list of operations to the operation stack. Return a
  66504. ** pointer to the first operation inserted.
  66505. **
  66506. ** Non-zero P2 arguments to jump instructions are automatically adjusted
  66507. ** so that the jump target is relative to the first operation inserted.
  66508. */
  66509. SQLITE_PRIVATE VdbeOp *sqlite3VdbeAddOpList(
  66510. Vdbe *p, /* Add opcodes to the prepared statement */
  66511. int nOp, /* Number of opcodes to add */
  66512. VdbeOpList const *aOp, /* The opcodes to be added */
  66513. int iLineno /* Source-file line number of first opcode */
  66514. ){
  66515. int i;
  66516. VdbeOp *pOut, *pFirst;
  66517. assert( nOp>0 );
  66518. assert( p->magic==VDBE_MAGIC_INIT );
  66519. if( p->nOp + nOp > p->pParse->nOpAlloc && growOpArray(p, nOp) ){
  66520. return 0;
  66521. }
  66522. pFirst = pOut = &p->aOp[p->nOp];
  66523. for(i=0; i<nOp; i++, aOp++, pOut++){
  66524. pOut->opcode = aOp->opcode;
  66525. pOut->p1 = aOp->p1;
  66526. pOut->p2 = aOp->p2;
  66527. assert( aOp->p2>=0 );
  66528. if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
  66529. pOut->p2 += p->nOp;
  66530. }
  66531. pOut->p3 = aOp->p3;
  66532. pOut->p4type = P4_NOTUSED;
  66533. pOut->p4.p = 0;
  66534. pOut->p5 = 0;
  66535. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  66536. pOut->zComment = 0;
  66537. #endif
  66538. #ifdef SQLITE_VDBE_COVERAGE
  66539. pOut->iSrcLine = iLineno+i;
  66540. #else
  66541. (void)iLineno;
  66542. #endif
  66543. #ifdef SQLITE_DEBUG
  66544. if( p->db->flags & SQLITE_VdbeAddopTrace ){
  66545. sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
  66546. }
  66547. #endif
  66548. }
  66549. p->nOp += nOp;
  66550. return pFirst;
  66551. }
  66552. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
  66553. /*
  66554. ** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
  66555. */
  66556. SQLITE_PRIVATE void sqlite3VdbeScanStatus(
  66557. Vdbe *p, /* VM to add scanstatus() to */
  66558. int addrExplain, /* Address of OP_Explain (or 0) */
  66559. int addrLoop, /* Address of loop counter */
  66560. int addrVisit, /* Address of rows visited counter */
  66561. LogEst nEst, /* Estimated number of output rows */
  66562. const char *zName /* Name of table or index being scanned */
  66563. ){
  66564. int nByte = (p->nScan+1) * sizeof(ScanStatus);
  66565. ScanStatus *aNew;
  66566. aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
  66567. if( aNew ){
  66568. ScanStatus *pNew = &aNew[p->nScan++];
  66569. pNew->addrExplain = addrExplain;
  66570. pNew->addrLoop = addrLoop;
  66571. pNew->addrVisit = addrVisit;
  66572. pNew->nEst = nEst;
  66573. pNew->zName = sqlite3DbStrDup(p->db, zName);
  66574. p->aScan = aNew;
  66575. }
  66576. }
  66577. #endif
  66578. /*
  66579. ** Change the value of the opcode, or P1, P2, P3, or P5 operands
  66580. ** for a specific instruction.
  66581. */
  66582. SQLITE_PRIVATE void sqlite3VdbeChangeOpcode(Vdbe *p, u32 addr, u8 iNewOpcode){
  66583. sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
  66584. }
  66585. SQLITE_PRIVATE void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
  66586. sqlite3VdbeGetOp(p,addr)->p1 = val;
  66587. }
  66588. SQLITE_PRIVATE void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
  66589. sqlite3VdbeGetOp(p,addr)->p2 = val;
  66590. }
  66591. SQLITE_PRIVATE void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
  66592. sqlite3VdbeGetOp(p,addr)->p3 = val;
  66593. }
  66594. SQLITE_PRIVATE void sqlite3VdbeChangeP5(Vdbe *p, u8 p5){
  66595. assert( p->nOp>0 || p->db->mallocFailed );
  66596. if( p->nOp>0 ) p->aOp[p->nOp-1].p5 = p5;
  66597. }
  66598. /*
  66599. ** Change the P2 operand of instruction addr so that it points to
  66600. ** the address of the next instruction to be coded.
  66601. */
  66602. SQLITE_PRIVATE void sqlite3VdbeJumpHere(Vdbe *p, int addr){
  66603. sqlite3VdbeChangeP2(p, addr, p->nOp);
  66604. }
  66605. /*
  66606. ** If the input FuncDef structure is ephemeral, then free it. If
  66607. ** the FuncDef is not ephermal, then do nothing.
  66608. */
  66609. static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
  66610. if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
  66611. sqlite3DbFree(db, pDef);
  66612. }
  66613. }
  66614. static void vdbeFreeOpArray(sqlite3 *, Op *, int);
  66615. /*
  66616. ** Delete a P4 value if necessary.
  66617. */
  66618. static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
  66619. if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
  66620. sqlite3DbFree(db, p);
  66621. }
  66622. static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
  66623. freeEphemeralFunction(db, p->pFunc);
  66624. sqlite3DbFree(db, p);
  66625. }
  66626. static void freeP4(sqlite3 *db, int p4type, void *p4){
  66627. assert( db );
  66628. switch( p4type ){
  66629. case P4_FUNCCTX: {
  66630. freeP4FuncCtx(db, (sqlite3_context*)p4);
  66631. break;
  66632. }
  66633. case P4_REAL:
  66634. case P4_INT64:
  66635. case P4_DYNAMIC:
  66636. case P4_INTARRAY: {
  66637. sqlite3DbFree(db, p4);
  66638. break;
  66639. }
  66640. case P4_KEYINFO: {
  66641. if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
  66642. break;
  66643. }
  66644. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  66645. case P4_EXPR: {
  66646. sqlite3ExprDelete(db, (Expr*)p4);
  66647. break;
  66648. }
  66649. #endif
  66650. case P4_MPRINTF: {
  66651. if( db->pnBytesFreed==0 ) sqlite3_free(p4);
  66652. break;
  66653. }
  66654. case P4_FUNCDEF: {
  66655. freeEphemeralFunction(db, (FuncDef*)p4);
  66656. break;
  66657. }
  66658. case P4_MEM: {
  66659. if( db->pnBytesFreed==0 ){
  66660. sqlite3ValueFree((sqlite3_value*)p4);
  66661. }else{
  66662. freeP4Mem(db, (Mem*)p4);
  66663. }
  66664. break;
  66665. }
  66666. case P4_VTAB : {
  66667. if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
  66668. break;
  66669. }
  66670. }
  66671. }
  66672. /*
  66673. ** Free the space allocated for aOp and any p4 values allocated for the
  66674. ** opcodes contained within. If aOp is not NULL it is assumed to contain
  66675. ** nOp entries.
  66676. */
  66677. static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
  66678. if( aOp ){
  66679. Op *pOp;
  66680. for(pOp=aOp; pOp<&aOp[nOp]; pOp++){
  66681. if( pOp->p4type ) freeP4(db, pOp->p4type, pOp->p4.p);
  66682. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  66683. sqlite3DbFree(db, pOp->zComment);
  66684. #endif
  66685. }
  66686. }
  66687. sqlite3DbFree(db, aOp);
  66688. }
  66689. /*
  66690. ** Link the SubProgram object passed as the second argument into the linked
  66691. ** list at Vdbe.pSubProgram. This list is used to delete all sub-program
  66692. ** objects when the VM is no longer required.
  66693. */
  66694. SQLITE_PRIVATE void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
  66695. p->pNext = pVdbe->pProgram;
  66696. pVdbe->pProgram = p;
  66697. }
  66698. /*
  66699. ** Change the opcode at addr into OP_Noop
  66700. */
  66701. SQLITE_PRIVATE int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
  66702. VdbeOp *pOp;
  66703. if( p->db->mallocFailed ) return 0;
  66704. assert( addr>=0 && addr<p->nOp );
  66705. pOp = &p->aOp[addr];
  66706. freeP4(p->db, pOp->p4type, pOp->p4.p);
  66707. pOp->p4type = P4_NOTUSED;
  66708. pOp->p4.z = 0;
  66709. pOp->opcode = OP_Noop;
  66710. return 1;
  66711. }
  66712. /*
  66713. ** If the last opcode is "op" and it is not a jump destination,
  66714. ** then remove it. Return true if and only if an opcode was removed.
  66715. */
  66716. SQLITE_PRIVATE int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
  66717. if( p->nOp>0 && p->aOp[p->nOp-1].opcode==op ){
  66718. return sqlite3VdbeChangeToNoop(p, p->nOp-1);
  66719. }else{
  66720. return 0;
  66721. }
  66722. }
  66723. /*
  66724. ** Change the value of the P4 operand for a specific instruction.
  66725. ** This routine is useful when a large program is loaded from a
  66726. ** static array using sqlite3VdbeAddOpList but we want to make a
  66727. ** few minor changes to the program.
  66728. **
  66729. ** If n>=0 then the P4 operand is dynamic, meaning that a copy of
  66730. ** the string is made into memory obtained from sqlite3_malloc().
  66731. ** A value of n==0 means copy bytes of zP4 up to and including the
  66732. ** first null byte. If n>0 then copy n+1 bytes of zP4.
  66733. **
  66734. ** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
  66735. ** to a string or structure that is guaranteed to exist for the lifetime of
  66736. ** the Vdbe. In these cases we can just copy the pointer.
  66737. **
  66738. ** If addr<0 then change P4 on the most recently inserted instruction.
  66739. */
  66740. static void SQLITE_NOINLINE vdbeChangeP4Full(
  66741. Vdbe *p,
  66742. Op *pOp,
  66743. const char *zP4,
  66744. int n
  66745. ){
  66746. if( pOp->p4type ){
  66747. freeP4(p->db, pOp->p4type, pOp->p4.p);
  66748. pOp->p4type = 0;
  66749. pOp->p4.p = 0;
  66750. }
  66751. if( n<0 ){
  66752. sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
  66753. }else{
  66754. if( n==0 ) n = sqlite3Strlen30(zP4);
  66755. pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
  66756. pOp->p4type = P4_DYNAMIC;
  66757. }
  66758. }
  66759. SQLITE_PRIVATE void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
  66760. Op *pOp;
  66761. sqlite3 *db;
  66762. assert( p!=0 );
  66763. db = p->db;
  66764. assert( p->magic==VDBE_MAGIC_INIT );
  66765. assert( p->aOp!=0 || db->mallocFailed );
  66766. if( db->mallocFailed ){
  66767. if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
  66768. return;
  66769. }
  66770. assert( p->nOp>0 );
  66771. assert( addr<p->nOp );
  66772. if( addr<0 ){
  66773. addr = p->nOp - 1;
  66774. }
  66775. pOp = &p->aOp[addr];
  66776. if( n>=0 || pOp->p4type ){
  66777. vdbeChangeP4Full(p, pOp, zP4, n);
  66778. return;
  66779. }
  66780. if( n==P4_INT32 ){
  66781. /* Note: this cast is safe, because the origin data point was an int
  66782. ** that was cast to a (const char *). */
  66783. pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
  66784. pOp->p4type = P4_INT32;
  66785. }else if( zP4!=0 ){
  66786. assert( n<0 );
  66787. pOp->p4.p = (void*)zP4;
  66788. pOp->p4type = (signed char)n;
  66789. if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
  66790. }
  66791. }
  66792. /*
  66793. ** Set the P4 on the most recently added opcode to the KeyInfo for the
  66794. ** index given.
  66795. */
  66796. SQLITE_PRIVATE void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
  66797. Vdbe *v = pParse->pVdbe;
  66798. assert( v!=0 );
  66799. assert( pIdx!=0 );
  66800. sqlite3VdbeChangeP4(v, -1, (char*)sqlite3KeyInfoOfIndex(pParse, pIdx),
  66801. P4_KEYINFO);
  66802. }
  66803. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  66804. /*
  66805. ** Change the comment on the most recently coded instruction. Or
  66806. ** insert a No-op and add the comment to that new instruction. This
  66807. ** makes the code easier to read during debugging. None of this happens
  66808. ** in a production build.
  66809. */
  66810. static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
  66811. assert( p->nOp>0 || p->aOp==0 );
  66812. assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
  66813. if( p->nOp ){
  66814. assert( p->aOp );
  66815. sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
  66816. p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
  66817. }
  66818. }
  66819. SQLITE_PRIVATE void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
  66820. va_list ap;
  66821. if( p ){
  66822. va_start(ap, zFormat);
  66823. vdbeVComment(p, zFormat, ap);
  66824. va_end(ap);
  66825. }
  66826. }
  66827. SQLITE_PRIVATE void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
  66828. va_list ap;
  66829. if( p ){
  66830. sqlite3VdbeAddOp0(p, OP_Noop);
  66831. va_start(ap, zFormat);
  66832. vdbeVComment(p, zFormat, ap);
  66833. va_end(ap);
  66834. }
  66835. }
  66836. #endif /* NDEBUG */
  66837. #ifdef SQLITE_VDBE_COVERAGE
  66838. /*
  66839. ** Set the value if the iSrcLine field for the previously coded instruction.
  66840. */
  66841. SQLITE_PRIVATE void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
  66842. sqlite3VdbeGetOp(v,-1)->iSrcLine = iLine;
  66843. }
  66844. #endif /* SQLITE_VDBE_COVERAGE */
  66845. /*
  66846. ** Return the opcode for a given address. If the address is -1, then
  66847. ** return the most recently inserted opcode.
  66848. **
  66849. ** If a memory allocation error has occurred prior to the calling of this
  66850. ** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
  66851. ** is readable but not writable, though it is cast to a writable value.
  66852. ** The return of a dummy opcode allows the call to continue functioning
  66853. ** after an OOM fault without having to check to see if the return from
  66854. ** this routine is a valid pointer. But because the dummy.opcode is 0,
  66855. ** dummy will never be written to. This is verified by code inspection and
  66856. ** by running with Valgrind.
  66857. */
  66858. SQLITE_PRIVATE VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
  66859. /* C89 specifies that the constant "dummy" will be initialized to all
  66860. ** zeros, which is correct. MSVC generates a warning, nevertheless. */
  66861. static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
  66862. assert( p->magic==VDBE_MAGIC_INIT );
  66863. if( addr<0 ){
  66864. addr = p->nOp - 1;
  66865. }
  66866. assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
  66867. if( p->db->mallocFailed ){
  66868. return (VdbeOp*)&dummy;
  66869. }else{
  66870. return &p->aOp[addr];
  66871. }
  66872. }
  66873. #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
  66874. /*
  66875. ** Return an integer value for one of the parameters to the opcode pOp
  66876. ** determined by character c.
  66877. */
  66878. static int translateP(char c, const Op *pOp){
  66879. if( c=='1' ) return pOp->p1;
  66880. if( c=='2' ) return pOp->p2;
  66881. if( c=='3' ) return pOp->p3;
  66882. if( c=='4' ) return pOp->p4.i;
  66883. return pOp->p5;
  66884. }
  66885. /*
  66886. ** Compute a string for the "comment" field of a VDBE opcode listing.
  66887. **
  66888. ** The Synopsis: field in comments in the vdbe.c source file gets converted
  66889. ** to an extra string that is appended to the sqlite3OpcodeName(). In the
  66890. ** absence of other comments, this synopsis becomes the comment on the opcode.
  66891. ** Some translation occurs:
  66892. **
  66893. ** "PX" -> "r[X]"
  66894. ** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
  66895. ** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
  66896. ** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
  66897. */
  66898. static int displayComment(
  66899. const Op *pOp, /* The opcode to be commented */
  66900. const char *zP4, /* Previously obtained value for P4 */
  66901. char *zTemp, /* Write result here */
  66902. int nTemp /* Space available in zTemp[] */
  66903. ){
  66904. const char *zOpName;
  66905. const char *zSynopsis;
  66906. int nOpName;
  66907. int ii, jj;
  66908. char zAlt[50];
  66909. zOpName = sqlite3OpcodeName(pOp->opcode);
  66910. nOpName = sqlite3Strlen30(zOpName);
  66911. if( zOpName[nOpName+1] ){
  66912. int seenCom = 0;
  66913. char c;
  66914. zSynopsis = zOpName += nOpName + 1;
  66915. if( strncmp(zSynopsis,"IF ",3)==0 ){
  66916. if( pOp->p5 & SQLITE_STOREP2 ){
  66917. sqlite3_snprintf(sizeof(zAlt), zAlt, "r[P2] = (%s)", zSynopsis+3);
  66918. }else{
  66919. sqlite3_snprintf(sizeof(zAlt), zAlt, "if %s goto P2", zSynopsis+3);
  66920. }
  66921. zSynopsis = zAlt;
  66922. }
  66923. for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
  66924. if( c=='P' ){
  66925. c = zSynopsis[++ii];
  66926. if( c=='4' ){
  66927. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
  66928. }else if( c=='X' ){
  66929. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
  66930. seenCom = 1;
  66931. }else{
  66932. int v1 = translateP(c, pOp);
  66933. int v2;
  66934. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
  66935. if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
  66936. ii += 3;
  66937. jj += sqlite3Strlen30(zTemp+jj);
  66938. v2 = translateP(zSynopsis[ii], pOp);
  66939. if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
  66940. ii += 2;
  66941. v2++;
  66942. }
  66943. if( v2>1 ){
  66944. sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
  66945. }
  66946. }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
  66947. ii += 4;
  66948. }
  66949. }
  66950. jj += sqlite3Strlen30(zTemp+jj);
  66951. }else{
  66952. zTemp[jj++] = c;
  66953. }
  66954. }
  66955. if( !seenCom && jj<nTemp-5 && pOp->zComment ){
  66956. sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
  66957. jj += sqlite3Strlen30(zTemp+jj);
  66958. }
  66959. if( jj<nTemp ) zTemp[jj] = 0;
  66960. }else if( pOp->zComment ){
  66961. sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
  66962. jj = sqlite3Strlen30(zTemp);
  66963. }else{
  66964. zTemp[0] = 0;
  66965. jj = 0;
  66966. }
  66967. return jj;
  66968. }
  66969. #endif /* SQLITE_DEBUG */
  66970. #if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
  66971. /*
  66972. ** Translate the P4.pExpr value for an OP_CursorHint opcode into text
  66973. ** that can be displayed in the P4 column of EXPLAIN output.
  66974. */
  66975. static void displayP4Expr(StrAccum *p, Expr *pExpr){
  66976. const char *zOp = 0;
  66977. switch( pExpr->op ){
  66978. case TK_STRING:
  66979. sqlite3XPrintf(p, "%Q", pExpr->u.zToken);
  66980. break;
  66981. case TK_INTEGER:
  66982. sqlite3XPrintf(p, "%d", pExpr->u.iValue);
  66983. break;
  66984. case TK_NULL:
  66985. sqlite3XPrintf(p, "NULL");
  66986. break;
  66987. case TK_REGISTER: {
  66988. sqlite3XPrintf(p, "r[%d]", pExpr->iTable);
  66989. break;
  66990. }
  66991. case TK_COLUMN: {
  66992. if( pExpr->iColumn<0 ){
  66993. sqlite3XPrintf(p, "rowid");
  66994. }else{
  66995. sqlite3XPrintf(p, "c%d", (int)pExpr->iColumn);
  66996. }
  66997. break;
  66998. }
  66999. case TK_LT: zOp = "LT"; break;
  67000. case TK_LE: zOp = "LE"; break;
  67001. case TK_GT: zOp = "GT"; break;
  67002. case TK_GE: zOp = "GE"; break;
  67003. case TK_NE: zOp = "NE"; break;
  67004. case TK_EQ: zOp = "EQ"; break;
  67005. case TK_IS: zOp = "IS"; break;
  67006. case TK_ISNOT: zOp = "ISNOT"; break;
  67007. case TK_AND: zOp = "AND"; break;
  67008. case TK_OR: zOp = "OR"; break;
  67009. case TK_PLUS: zOp = "ADD"; break;
  67010. case TK_STAR: zOp = "MUL"; break;
  67011. case TK_MINUS: zOp = "SUB"; break;
  67012. case TK_REM: zOp = "REM"; break;
  67013. case TK_BITAND: zOp = "BITAND"; break;
  67014. case TK_BITOR: zOp = "BITOR"; break;
  67015. case TK_SLASH: zOp = "DIV"; break;
  67016. case TK_LSHIFT: zOp = "LSHIFT"; break;
  67017. case TK_RSHIFT: zOp = "RSHIFT"; break;
  67018. case TK_CONCAT: zOp = "CONCAT"; break;
  67019. case TK_UMINUS: zOp = "MINUS"; break;
  67020. case TK_UPLUS: zOp = "PLUS"; break;
  67021. case TK_BITNOT: zOp = "BITNOT"; break;
  67022. case TK_NOT: zOp = "NOT"; break;
  67023. case TK_ISNULL: zOp = "ISNULL"; break;
  67024. case TK_NOTNULL: zOp = "NOTNULL"; break;
  67025. default:
  67026. sqlite3XPrintf(p, "%s", "expr");
  67027. break;
  67028. }
  67029. if( zOp ){
  67030. sqlite3XPrintf(p, "%s(", zOp);
  67031. displayP4Expr(p, pExpr->pLeft);
  67032. if( pExpr->pRight ){
  67033. sqlite3StrAccumAppend(p, ",", 1);
  67034. displayP4Expr(p, pExpr->pRight);
  67035. }
  67036. sqlite3StrAccumAppend(p, ")", 1);
  67037. }
  67038. }
  67039. #endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
  67040. #if VDBE_DISPLAY_P4
  67041. /*
  67042. ** Compute a string that describes the P4 parameter for an opcode.
  67043. ** Use zTemp for any required temporary buffer space.
  67044. */
  67045. static char *displayP4(Op *pOp, char *zTemp, int nTemp){
  67046. char *zP4 = zTemp;
  67047. StrAccum x;
  67048. assert( nTemp>=20 );
  67049. sqlite3StrAccumInit(&x, 0, zTemp, nTemp, 0);
  67050. switch( pOp->p4type ){
  67051. case P4_KEYINFO: {
  67052. int j;
  67053. KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
  67054. assert( pKeyInfo->aSortOrder!=0 );
  67055. sqlite3XPrintf(&x, "k(%d", pKeyInfo->nField);
  67056. for(j=0; j<pKeyInfo->nField; j++){
  67057. CollSeq *pColl = pKeyInfo->aColl[j];
  67058. const char *zColl = pColl ? pColl->zName : "";
  67059. if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
  67060. sqlite3XPrintf(&x, ",%s%s", pKeyInfo->aSortOrder[j] ? "-" : "", zColl);
  67061. }
  67062. sqlite3StrAccumAppend(&x, ")", 1);
  67063. break;
  67064. }
  67065. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  67066. case P4_EXPR: {
  67067. displayP4Expr(&x, pOp->p4.pExpr);
  67068. break;
  67069. }
  67070. #endif
  67071. case P4_COLLSEQ: {
  67072. CollSeq *pColl = pOp->p4.pColl;
  67073. sqlite3XPrintf(&x, "(%.20s)", pColl->zName);
  67074. break;
  67075. }
  67076. case P4_FUNCDEF: {
  67077. FuncDef *pDef = pOp->p4.pFunc;
  67078. sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
  67079. break;
  67080. }
  67081. #ifdef SQLITE_DEBUG
  67082. case P4_FUNCCTX: {
  67083. FuncDef *pDef = pOp->p4.pCtx->pFunc;
  67084. sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
  67085. break;
  67086. }
  67087. #endif
  67088. case P4_INT64: {
  67089. sqlite3XPrintf(&x, "%lld", *pOp->p4.pI64);
  67090. break;
  67091. }
  67092. case P4_INT32: {
  67093. sqlite3XPrintf(&x, "%d", pOp->p4.i);
  67094. break;
  67095. }
  67096. case P4_REAL: {
  67097. sqlite3XPrintf(&x, "%.16g", *pOp->p4.pReal);
  67098. break;
  67099. }
  67100. case P4_MEM: {
  67101. Mem *pMem = pOp->p4.pMem;
  67102. if( pMem->flags & MEM_Str ){
  67103. zP4 = pMem->z;
  67104. }else if( pMem->flags & MEM_Int ){
  67105. sqlite3XPrintf(&x, "%lld", pMem->u.i);
  67106. }else if( pMem->flags & MEM_Real ){
  67107. sqlite3XPrintf(&x, "%.16g", pMem->u.r);
  67108. }else if( pMem->flags & MEM_Null ){
  67109. zP4 = "NULL";
  67110. }else{
  67111. assert( pMem->flags & MEM_Blob );
  67112. zP4 = "(blob)";
  67113. }
  67114. break;
  67115. }
  67116. #ifndef SQLITE_OMIT_VIRTUALTABLE
  67117. case P4_VTAB: {
  67118. sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
  67119. sqlite3XPrintf(&x, "vtab:%p", pVtab);
  67120. break;
  67121. }
  67122. #endif
  67123. case P4_INTARRAY: {
  67124. int i;
  67125. int *ai = pOp->p4.ai;
  67126. int n = ai[0]; /* The first element of an INTARRAY is always the
  67127. ** count of the number of elements to follow */
  67128. for(i=1; i<n; i++){
  67129. sqlite3XPrintf(&x, ",%d", ai[i]);
  67130. }
  67131. zTemp[0] = '[';
  67132. sqlite3StrAccumAppend(&x, "]", 1);
  67133. break;
  67134. }
  67135. case P4_SUBPROGRAM: {
  67136. sqlite3XPrintf(&x, "program");
  67137. break;
  67138. }
  67139. case P4_ADVANCE: {
  67140. zTemp[0] = 0;
  67141. break;
  67142. }
  67143. case P4_TABLE: {
  67144. sqlite3XPrintf(&x, "%s", pOp->p4.pTab->zName);
  67145. break;
  67146. }
  67147. default: {
  67148. zP4 = pOp->p4.z;
  67149. if( zP4==0 ){
  67150. zP4 = zTemp;
  67151. zTemp[0] = 0;
  67152. }
  67153. }
  67154. }
  67155. sqlite3StrAccumFinish(&x);
  67156. assert( zP4!=0 );
  67157. return zP4;
  67158. }
  67159. #endif /* VDBE_DISPLAY_P4 */
  67160. /*
  67161. ** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
  67162. **
  67163. ** The prepared statements need to know in advance the complete set of
  67164. ** attached databases that will be use. A mask of these databases
  67165. ** is maintained in p->btreeMask. The p->lockMask value is the subset of
  67166. ** p->btreeMask of databases that will require a lock.
  67167. */
  67168. SQLITE_PRIVATE void sqlite3VdbeUsesBtree(Vdbe *p, int i){
  67169. assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
  67170. assert( i<(int)sizeof(p->btreeMask)*8 );
  67171. DbMaskSet(p->btreeMask, i);
  67172. if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
  67173. DbMaskSet(p->lockMask, i);
  67174. }
  67175. }
  67176. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  67177. /*
  67178. ** If SQLite is compiled to support shared-cache mode and to be threadsafe,
  67179. ** this routine obtains the mutex associated with each BtShared structure
  67180. ** that may be accessed by the VM passed as an argument. In doing so it also
  67181. ** sets the BtShared.db member of each of the BtShared structures, ensuring
  67182. ** that the correct busy-handler callback is invoked if required.
  67183. **
  67184. ** If SQLite is not threadsafe but does support shared-cache mode, then
  67185. ** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
  67186. ** of all of BtShared structures accessible via the database handle
  67187. ** associated with the VM.
  67188. **
  67189. ** If SQLite is not threadsafe and does not support shared-cache mode, this
  67190. ** function is a no-op.
  67191. **
  67192. ** The p->btreeMask field is a bitmask of all btrees that the prepared
  67193. ** statement p will ever use. Let N be the number of bits in p->btreeMask
  67194. ** corresponding to btrees that use shared cache. Then the runtime of
  67195. ** this routine is N*N. But as N is rarely more than 1, this should not
  67196. ** be a problem.
  67197. */
  67198. SQLITE_PRIVATE void sqlite3VdbeEnter(Vdbe *p){
  67199. int i;
  67200. sqlite3 *db;
  67201. Db *aDb;
  67202. int nDb;
  67203. if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
  67204. db = p->db;
  67205. aDb = db->aDb;
  67206. nDb = db->nDb;
  67207. for(i=0; i<nDb; i++){
  67208. if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
  67209. sqlite3BtreeEnter(aDb[i].pBt);
  67210. }
  67211. }
  67212. }
  67213. #endif
  67214. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
  67215. /*
  67216. ** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
  67217. */
  67218. static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
  67219. int i;
  67220. sqlite3 *db;
  67221. Db *aDb;
  67222. int nDb;
  67223. db = p->db;
  67224. aDb = db->aDb;
  67225. nDb = db->nDb;
  67226. for(i=0; i<nDb; i++){
  67227. if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
  67228. sqlite3BtreeLeave(aDb[i].pBt);
  67229. }
  67230. }
  67231. }
  67232. SQLITE_PRIVATE void sqlite3VdbeLeave(Vdbe *p){
  67233. if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
  67234. vdbeLeave(p);
  67235. }
  67236. #endif
  67237. #if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  67238. /*
  67239. ** Print a single opcode. This routine is used for debugging only.
  67240. */
  67241. SQLITE_PRIVATE void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
  67242. char *zP4;
  67243. char zPtr[50];
  67244. char zCom[100];
  67245. static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
  67246. if( pOut==0 ) pOut = stdout;
  67247. zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
  67248. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  67249. displayComment(pOp, zP4, zCom, sizeof(zCom));
  67250. #else
  67251. zCom[0] = 0;
  67252. #endif
  67253. /* NB: The sqlite3OpcodeName() function is implemented by code created
  67254. ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
  67255. ** information from the vdbe.c source text */
  67256. fprintf(pOut, zFormat1, pc,
  67257. sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
  67258. zCom
  67259. );
  67260. fflush(pOut);
  67261. }
  67262. #endif
  67263. /*
  67264. ** Initialize an array of N Mem element.
  67265. */
  67266. static void initMemArray(Mem *p, int N, sqlite3 *db, u16 flags){
  67267. while( (N--)>0 ){
  67268. p->db = db;
  67269. p->flags = flags;
  67270. p->szMalloc = 0;
  67271. #ifdef SQLITE_DEBUG
  67272. p->pScopyFrom = 0;
  67273. #endif
  67274. p++;
  67275. }
  67276. }
  67277. /*
  67278. ** Release an array of N Mem elements
  67279. */
  67280. static void releaseMemArray(Mem *p, int N){
  67281. if( p && N ){
  67282. Mem *pEnd = &p[N];
  67283. sqlite3 *db = p->db;
  67284. if( db->pnBytesFreed ){
  67285. do{
  67286. if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
  67287. }while( (++p)<pEnd );
  67288. return;
  67289. }
  67290. do{
  67291. assert( (&p[1])==pEnd || p[0].db==p[1].db );
  67292. assert( sqlite3VdbeCheckMemInvariants(p) );
  67293. /* This block is really an inlined version of sqlite3VdbeMemRelease()
  67294. ** that takes advantage of the fact that the memory cell value is
  67295. ** being set to NULL after releasing any dynamic resources.
  67296. **
  67297. ** The justification for duplicating code is that according to
  67298. ** callgrind, this causes a certain test case to hit the CPU 4.7
  67299. ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
  67300. ** sqlite3MemRelease() were called from here. With -O2, this jumps
  67301. ** to 6.6 percent. The test case is inserting 1000 rows into a table
  67302. ** with no indexes using a single prepared INSERT statement, bind()
  67303. ** and reset(). Inserts are grouped into a transaction.
  67304. */
  67305. testcase( p->flags & MEM_Agg );
  67306. testcase( p->flags & MEM_Dyn );
  67307. testcase( p->flags & MEM_Frame );
  67308. testcase( p->flags & MEM_RowSet );
  67309. if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
  67310. sqlite3VdbeMemRelease(p);
  67311. }else if( p->szMalloc ){
  67312. sqlite3DbFree(db, p->zMalloc);
  67313. p->szMalloc = 0;
  67314. }
  67315. p->flags = MEM_Undefined;
  67316. }while( (++p)<pEnd );
  67317. }
  67318. }
  67319. /*
  67320. ** Delete a VdbeFrame object and its contents. VdbeFrame objects are
  67321. ** allocated by the OP_Program opcode in sqlite3VdbeExec().
  67322. */
  67323. SQLITE_PRIVATE void sqlite3VdbeFrameDelete(VdbeFrame *p){
  67324. int i;
  67325. Mem *aMem = VdbeFrameMem(p);
  67326. VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
  67327. for(i=0; i<p->nChildCsr; i++){
  67328. sqlite3VdbeFreeCursor(p->v, apCsr[i]);
  67329. }
  67330. releaseMemArray(aMem, p->nChildMem);
  67331. sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
  67332. sqlite3DbFree(p->v->db, p);
  67333. }
  67334. #ifndef SQLITE_OMIT_EXPLAIN
  67335. /*
  67336. ** Give a listing of the program in the virtual machine.
  67337. **
  67338. ** The interface is the same as sqlite3VdbeExec(). But instead of
  67339. ** running the code, it invokes the callback once for each instruction.
  67340. ** This feature is used to implement "EXPLAIN".
  67341. **
  67342. ** When p->explain==1, each instruction is listed. When
  67343. ** p->explain==2, only OP_Explain instructions are listed and these
  67344. ** are shown in a different format. p->explain==2 is used to implement
  67345. ** EXPLAIN QUERY PLAN.
  67346. **
  67347. ** When p->explain==1, first the main program is listed, then each of
  67348. ** the trigger subprograms are listed one by one.
  67349. */
  67350. SQLITE_PRIVATE int sqlite3VdbeList(
  67351. Vdbe *p /* The VDBE */
  67352. ){
  67353. int nRow; /* Stop when row count reaches this */
  67354. int nSub = 0; /* Number of sub-vdbes seen so far */
  67355. SubProgram **apSub = 0; /* Array of sub-vdbes */
  67356. Mem *pSub = 0; /* Memory cell hold array of subprogs */
  67357. sqlite3 *db = p->db; /* The database connection */
  67358. int i; /* Loop counter */
  67359. int rc = SQLITE_OK; /* Return code */
  67360. Mem *pMem = &p->aMem[1]; /* First Mem of result set */
  67361. assert( p->explain );
  67362. assert( p->magic==VDBE_MAGIC_RUN );
  67363. assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
  67364. /* Even though this opcode does not use dynamic strings for
  67365. ** the result, result columns may become dynamic if the user calls
  67366. ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
  67367. */
  67368. releaseMemArray(pMem, 8);
  67369. p->pResultSet = 0;
  67370. if( p->rc==SQLITE_NOMEM_BKPT ){
  67371. /* This happens if a malloc() inside a call to sqlite3_column_text() or
  67372. ** sqlite3_column_text16() failed. */
  67373. sqlite3OomFault(db);
  67374. return SQLITE_ERROR;
  67375. }
  67376. /* When the number of output rows reaches nRow, that means the
  67377. ** listing has finished and sqlite3_step() should return SQLITE_DONE.
  67378. ** nRow is the sum of the number of rows in the main program, plus
  67379. ** the sum of the number of rows in all trigger subprograms encountered
  67380. ** so far. The nRow value will increase as new trigger subprograms are
  67381. ** encountered, but p->pc will eventually catch up to nRow.
  67382. */
  67383. nRow = p->nOp;
  67384. if( p->explain==1 ){
  67385. /* The first 8 memory cells are used for the result set. So we will
  67386. ** commandeer the 9th cell to use as storage for an array of pointers
  67387. ** to trigger subprograms. The VDBE is guaranteed to have at least 9
  67388. ** cells. */
  67389. assert( p->nMem>9 );
  67390. pSub = &p->aMem[9];
  67391. if( pSub->flags&MEM_Blob ){
  67392. /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
  67393. ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
  67394. nSub = pSub->n/sizeof(Vdbe*);
  67395. apSub = (SubProgram **)pSub->z;
  67396. }
  67397. for(i=0; i<nSub; i++){
  67398. nRow += apSub[i]->nOp;
  67399. }
  67400. }
  67401. do{
  67402. i = p->pc++;
  67403. }while( i<nRow && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
  67404. if( i>=nRow ){
  67405. p->rc = SQLITE_OK;
  67406. rc = SQLITE_DONE;
  67407. }else if( db->u1.isInterrupted ){
  67408. p->rc = SQLITE_INTERRUPT;
  67409. rc = SQLITE_ERROR;
  67410. sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
  67411. }else{
  67412. char *zP4;
  67413. Op *pOp;
  67414. if( i<p->nOp ){
  67415. /* The output line number is small enough that we are still in the
  67416. ** main program. */
  67417. pOp = &p->aOp[i];
  67418. }else{
  67419. /* We are currently listing subprograms. Figure out which one and
  67420. ** pick up the appropriate opcode. */
  67421. int j;
  67422. i -= p->nOp;
  67423. for(j=0; i>=apSub[j]->nOp; j++){
  67424. i -= apSub[j]->nOp;
  67425. }
  67426. pOp = &apSub[j]->aOp[i];
  67427. }
  67428. if( p->explain==1 ){
  67429. pMem->flags = MEM_Int;
  67430. pMem->u.i = i; /* Program counter */
  67431. pMem++;
  67432. pMem->flags = MEM_Static|MEM_Str|MEM_Term;
  67433. pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
  67434. assert( pMem->z!=0 );
  67435. pMem->n = sqlite3Strlen30(pMem->z);
  67436. pMem->enc = SQLITE_UTF8;
  67437. pMem++;
  67438. /* When an OP_Program opcode is encounter (the only opcode that has
  67439. ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
  67440. ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
  67441. ** has not already been seen.
  67442. */
  67443. if( pOp->p4type==P4_SUBPROGRAM ){
  67444. int nByte = (nSub+1)*sizeof(SubProgram*);
  67445. int j;
  67446. for(j=0; j<nSub; j++){
  67447. if( apSub[j]==pOp->p4.pProgram ) break;
  67448. }
  67449. if( j==nSub && SQLITE_OK==sqlite3VdbeMemGrow(pSub, nByte, nSub!=0) ){
  67450. apSub = (SubProgram **)pSub->z;
  67451. apSub[nSub++] = pOp->p4.pProgram;
  67452. pSub->flags |= MEM_Blob;
  67453. pSub->n = nSub*sizeof(SubProgram*);
  67454. }
  67455. }
  67456. }
  67457. pMem->flags = MEM_Int;
  67458. pMem->u.i = pOp->p1; /* P1 */
  67459. pMem++;
  67460. pMem->flags = MEM_Int;
  67461. pMem->u.i = pOp->p2; /* P2 */
  67462. pMem++;
  67463. pMem->flags = MEM_Int;
  67464. pMem->u.i = pOp->p3; /* P3 */
  67465. pMem++;
  67466. if( sqlite3VdbeMemClearAndResize(pMem, 100) ){ /* P4 */
  67467. assert( p->db->mallocFailed );
  67468. return SQLITE_ERROR;
  67469. }
  67470. pMem->flags = MEM_Str|MEM_Term;
  67471. zP4 = displayP4(pOp, pMem->z, pMem->szMalloc);
  67472. if( zP4!=pMem->z ){
  67473. pMem->n = 0;
  67474. sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
  67475. }else{
  67476. assert( pMem->z!=0 );
  67477. pMem->n = sqlite3Strlen30(pMem->z);
  67478. pMem->enc = SQLITE_UTF8;
  67479. }
  67480. pMem++;
  67481. if( p->explain==1 ){
  67482. if( sqlite3VdbeMemClearAndResize(pMem, 4) ){
  67483. assert( p->db->mallocFailed );
  67484. return SQLITE_ERROR;
  67485. }
  67486. pMem->flags = MEM_Str|MEM_Term;
  67487. pMem->n = 2;
  67488. sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
  67489. pMem->enc = SQLITE_UTF8;
  67490. pMem++;
  67491. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  67492. if( sqlite3VdbeMemClearAndResize(pMem, 500) ){
  67493. assert( p->db->mallocFailed );
  67494. return SQLITE_ERROR;
  67495. }
  67496. pMem->flags = MEM_Str|MEM_Term;
  67497. pMem->n = displayComment(pOp, zP4, pMem->z, 500);
  67498. pMem->enc = SQLITE_UTF8;
  67499. #else
  67500. pMem->flags = MEM_Null; /* Comment */
  67501. #endif
  67502. }
  67503. p->nResColumn = 8 - 4*(p->explain-1);
  67504. p->pResultSet = &p->aMem[1];
  67505. p->rc = SQLITE_OK;
  67506. rc = SQLITE_ROW;
  67507. }
  67508. return rc;
  67509. }
  67510. #endif /* SQLITE_OMIT_EXPLAIN */
  67511. #ifdef SQLITE_DEBUG
  67512. /*
  67513. ** Print the SQL that was used to generate a VDBE program.
  67514. */
  67515. SQLITE_PRIVATE void sqlite3VdbePrintSql(Vdbe *p){
  67516. const char *z = 0;
  67517. if( p->zSql ){
  67518. z = p->zSql;
  67519. }else if( p->nOp>=1 ){
  67520. const VdbeOp *pOp = &p->aOp[0];
  67521. if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
  67522. z = pOp->p4.z;
  67523. while( sqlite3Isspace(*z) ) z++;
  67524. }
  67525. }
  67526. if( z ) printf("SQL: [%s]\n", z);
  67527. }
  67528. #endif
  67529. #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
  67530. /*
  67531. ** Print an IOTRACE message showing SQL content.
  67532. */
  67533. SQLITE_PRIVATE void sqlite3VdbeIOTraceSql(Vdbe *p){
  67534. int nOp = p->nOp;
  67535. VdbeOp *pOp;
  67536. if( sqlite3IoTrace==0 ) return;
  67537. if( nOp<1 ) return;
  67538. pOp = &p->aOp[0];
  67539. if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
  67540. int i, j;
  67541. char z[1000];
  67542. sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
  67543. for(i=0; sqlite3Isspace(z[i]); i++){}
  67544. for(j=0; z[i]; i++){
  67545. if( sqlite3Isspace(z[i]) ){
  67546. if( z[i-1]!=' ' ){
  67547. z[j++] = ' ';
  67548. }
  67549. }else{
  67550. z[j++] = z[i];
  67551. }
  67552. }
  67553. z[j] = 0;
  67554. sqlite3IoTrace("SQL %s\n", z);
  67555. }
  67556. }
  67557. #endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
  67558. /* An instance of this object describes bulk memory available for use
  67559. ** by subcomponents of a prepared statement. Space is allocated out
  67560. ** of a ReusableSpace object by the allocSpace() routine below.
  67561. */
  67562. struct ReusableSpace {
  67563. u8 *pSpace; /* Available memory */
  67564. int nFree; /* Bytes of available memory */
  67565. int nNeeded; /* Total bytes that could not be allocated */
  67566. };
  67567. /* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
  67568. ** from the ReusableSpace object. Return a pointer to the allocated
  67569. ** memory on success. If insufficient memory is available in the
  67570. ** ReusableSpace object, increase the ReusableSpace.nNeeded
  67571. ** value by the amount needed and return NULL.
  67572. **
  67573. ** If pBuf is not initially NULL, that means that the memory has already
  67574. ** been allocated by a prior call to this routine, so just return a copy
  67575. ** of pBuf and leave ReusableSpace unchanged.
  67576. **
  67577. ** This allocator is employed to repurpose unused slots at the end of the
  67578. ** opcode array of prepared state for other memory needs of the prepared
  67579. ** statement.
  67580. */
  67581. static void *allocSpace(
  67582. struct ReusableSpace *p, /* Bulk memory available for allocation */
  67583. void *pBuf, /* Pointer to a prior allocation */
  67584. int nByte /* Bytes of memory needed */
  67585. ){
  67586. assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
  67587. if( pBuf==0 ){
  67588. nByte = ROUND8(nByte);
  67589. if( nByte <= p->nFree ){
  67590. p->nFree -= nByte;
  67591. pBuf = &p->pSpace[p->nFree];
  67592. }else{
  67593. p->nNeeded += nByte;
  67594. }
  67595. }
  67596. assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
  67597. return pBuf;
  67598. }
  67599. /*
  67600. ** Rewind the VDBE back to the beginning in preparation for
  67601. ** running it.
  67602. */
  67603. SQLITE_PRIVATE void sqlite3VdbeRewind(Vdbe *p){
  67604. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  67605. int i;
  67606. #endif
  67607. assert( p!=0 );
  67608. assert( p->magic==VDBE_MAGIC_INIT || p->magic==VDBE_MAGIC_RESET );
  67609. /* There should be at least one opcode.
  67610. */
  67611. assert( p->nOp>0 );
  67612. /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
  67613. p->magic = VDBE_MAGIC_RUN;
  67614. #ifdef SQLITE_DEBUG
  67615. for(i=0; i<p->nMem; i++){
  67616. assert( p->aMem[i].db==p->db );
  67617. }
  67618. #endif
  67619. p->pc = -1;
  67620. p->rc = SQLITE_OK;
  67621. p->errorAction = OE_Abort;
  67622. p->nChange = 0;
  67623. p->cacheCtr = 1;
  67624. p->minWriteFileFormat = 255;
  67625. p->iStatement = 0;
  67626. p->nFkConstraint = 0;
  67627. #ifdef VDBE_PROFILE
  67628. for(i=0; i<p->nOp; i++){
  67629. p->aOp[i].cnt = 0;
  67630. p->aOp[i].cycles = 0;
  67631. }
  67632. #endif
  67633. }
  67634. /*
  67635. ** Prepare a virtual machine for execution for the first time after
  67636. ** creating the virtual machine. This involves things such
  67637. ** as allocating registers and initializing the program counter.
  67638. ** After the VDBE has be prepped, it can be executed by one or more
  67639. ** calls to sqlite3VdbeExec().
  67640. **
  67641. ** This function may be called exactly once on each virtual machine.
  67642. ** After this routine is called the VM has been "packaged" and is ready
  67643. ** to run. After this routine is called, further calls to
  67644. ** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
  67645. ** the Vdbe from the Parse object that helped generate it so that the
  67646. ** the Vdbe becomes an independent entity and the Parse object can be
  67647. ** destroyed.
  67648. **
  67649. ** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
  67650. ** to its initial state after it has been run.
  67651. */
  67652. SQLITE_PRIVATE void sqlite3VdbeMakeReady(
  67653. Vdbe *p, /* The VDBE */
  67654. Parse *pParse /* Parsing context */
  67655. ){
  67656. sqlite3 *db; /* The database connection */
  67657. int nVar; /* Number of parameters */
  67658. int nMem; /* Number of VM memory registers */
  67659. int nCursor; /* Number of cursors required */
  67660. int nArg; /* Number of arguments in subprograms */
  67661. int n; /* Loop counter */
  67662. struct ReusableSpace x; /* Reusable bulk memory */
  67663. assert( p!=0 );
  67664. assert( p->nOp>0 );
  67665. assert( pParse!=0 );
  67666. assert( p->magic==VDBE_MAGIC_INIT );
  67667. assert( pParse==p->pParse );
  67668. db = p->db;
  67669. assert( db->mallocFailed==0 );
  67670. nVar = pParse->nVar;
  67671. nMem = pParse->nMem;
  67672. nCursor = pParse->nTab;
  67673. nArg = pParse->nMaxArg;
  67674. /* Each cursor uses a memory cell. The first cursor (cursor 0) can
  67675. ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
  67676. ** space at the end of aMem[] for cursors 1 and greater.
  67677. ** See also: allocateCursor().
  67678. */
  67679. nMem += nCursor;
  67680. if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
  67681. /* Figure out how much reusable memory is available at the end of the
  67682. ** opcode array. This extra memory will be reallocated for other elements
  67683. ** of the prepared statement.
  67684. */
  67685. n = ROUND8(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
  67686. x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
  67687. assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
  67688. x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
  67689. assert( x.nFree>=0 );
  67690. assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
  67691. resolveP2Values(p, &nArg);
  67692. p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
  67693. if( pParse->explain && nMem<10 ){
  67694. nMem = 10;
  67695. }
  67696. p->expired = 0;
  67697. /* Memory for registers, parameters, cursor, etc, is allocated in one or two
  67698. ** passes. On the first pass, we try to reuse unused memory at the
  67699. ** end of the opcode array. If we are unable to satisfy all memory
  67700. ** requirements by reusing the opcode array tail, then the second
  67701. ** pass will fill in the remainder using a fresh memory allocation.
  67702. **
  67703. ** This two-pass approach that reuses as much memory as possible from
  67704. ** the leftover memory at the end of the opcode array. This can significantly
  67705. ** reduce the amount of memory held by a prepared statement.
  67706. */
  67707. do {
  67708. x.nNeeded = 0;
  67709. p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
  67710. p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
  67711. p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
  67712. p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
  67713. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  67714. p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
  67715. #endif
  67716. if( x.nNeeded==0 ) break;
  67717. x.pSpace = p->pFree = sqlite3DbMallocRawNN(db, x.nNeeded);
  67718. x.nFree = x.nNeeded;
  67719. }while( !db->mallocFailed );
  67720. p->nzVar = pParse->nzVar;
  67721. p->azVar = pParse->azVar;
  67722. pParse->nzVar = 0;
  67723. pParse->azVar = 0;
  67724. p->explain = pParse->explain;
  67725. if( db->mallocFailed ){
  67726. p->nVar = 0;
  67727. p->nCursor = 0;
  67728. p->nMem = 0;
  67729. }else{
  67730. p->nCursor = nCursor;
  67731. p->nVar = (ynVar)nVar;
  67732. initMemArray(p->aVar, nVar, db, MEM_Null);
  67733. p->nMem = nMem;
  67734. initMemArray(p->aMem, nMem, db, MEM_Undefined);
  67735. memset(p->apCsr, 0, nCursor*sizeof(VdbeCursor*));
  67736. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  67737. memset(p->anExec, 0, p->nOp*sizeof(i64));
  67738. #endif
  67739. }
  67740. sqlite3VdbeRewind(p);
  67741. }
  67742. /*
  67743. ** Close a VDBE cursor and release all the resources that cursor
  67744. ** happens to hold.
  67745. */
  67746. SQLITE_PRIVATE void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
  67747. if( pCx==0 ){
  67748. return;
  67749. }
  67750. assert( pCx->pBt==0 || pCx->eCurType==CURTYPE_BTREE );
  67751. switch( pCx->eCurType ){
  67752. case CURTYPE_SORTER: {
  67753. sqlite3VdbeSorterClose(p->db, pCx);
  67754. break;
  67755. }
  67756. case CURTYPE_BTREE: {
  67757. if( pCx->pBt ){
  67758. sqlite3BtreeClose(pCx->pBt);
  67759. /* The pCx->pCursor will be close automatically, if it exists, by
  67760. ** the call above. */
  67761. }else{
  67762. assert( pCx->uc.pCursor!=0 );
  67763. sqlite3BtreeCloseCursor(pCx->uc.pCursor);
  67764. }
  67765. break;
  67766. }
  67767. #ifndef SQLITE_OMIT_VIRTUALTABLE
  67768. case CURTYPE_VTAB: {
  67769. sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
  67770. const sqlite3_module *pModule = pVCur->pVtab->pModule;
  67771. assert( pVCur->pVtab->nRef>0 );
  67772. pVCur->pVtab->nRef--;
  67773. pModule->xClose(pVCur);
  67774. break;
  67775. }
  67776. #endif
  67777. }
  67778. }
  67779. /*
  67780. ** Close all cursors in the current frame.
  67781. */
  67782. static void closeCursorsInFrame(Vdbe *p){
  67783. if( p->apCsr ){
  67784. int i;
  67785. for(i=0; i<p->nCursor; i++){
  67786. VdbeCursor *pC = p->apCsr[i];
  67787. if( pC ){
  67788. sqlite3VdbeFreeCursor(p, pC);
  67789. p->apCsr[i] = 0;
  67790. }
  67791. }
  67792. }
  67793. }
  67794. /*
  67795. ** Copy the values stored in the VdbeFrame structure to its Vdbe. This
  67796. ** is used, for example, when a trigger sub-program is halted to restore
  67797. ** control to the main program.
  67798. */
  67799. SQLITE_PRIVATE int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
  67800. Vdbe *v = pFrame->v;
  67801. closeCursorsInFrame(v);
  67802. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  67803. v->anExec = pFrame->anExec;
  67804. #endif
  67805. v->aOp = pFrame->aOp;
  67806. v->nOp = pFrame->nOp;
  67807. v->aMem = pFrame->aMem;
  67808. v->nMem = pFrame->nMem;
  67809. v->apCsr = pFrame->apCsr;
  67810. v->nCursor = pFrame->nCursor;
  67811. v->db->lastRowid = pFrame->lastRowid;
  67812. v->nChange = pFrame->nChange;
  67813. v->db->nChange = pFrame->nDbChange;
  67814. sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
  67815. v->pAuxData = pFrame->pAuxData;
  67816. pFrame->pAuxData = 0;
  67817. return pFrame->pc;
  67818. }
  67819. /*
  67820. ** Close all cursors.
  67821. **
  67822. ** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
  67823. ** cell array. This is necessary as the memory cell array may contain
  67824. ** pointers to VdbeFrame objects, which may in turn contain pointers to
  67825. ** open cursors.
  67826. */
  67827. static void closeAllCursors(Vdbe *p){
  67828. if( p->pFrame ){
  67829. VdbeFrame *pFrame;
  67830. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  67831. sqlite3VdbeFrameRestore(pFrame);
  67832. p->pFrame = 0;
  67833. p->nFrame = 0;
  67834. }
  67835. assert( p->nFrame==0 );
  67836. closeCursorsInFrame(p);
  67837. if( p->aMem ){
  67838. releaseMemArray(p->aMem, p->nMem);
  67839. }
  67840. while( p->pDelFrame ){
  67841. VdbeFrame *pDel = p->pDelFrame;
  67842. p->pDelFrame = pDel->pParent;
  67843. sqlite3VdbeFrameDelete(pDel);
  67844. }
  67845. /* Delete any auxdata allocations made by the VM */
  67846. if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
  67847. assert( p->pAuxData==0 );
  67848. }
  67849. /*
  67850. ** Clean up the VM after a single run.
  67851. */
  67852. static void Cleanup(Vdbe *p){
  67853. sqlite3 *db = p->db;
  67854. #ifdef SQLITE_DEBUG
  67855. /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
  67856. ** Vdbe.aMem[] arrays have already been cleaned up. */
  67857. int i;
  67858. if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
  67859. if( p->aMem ){
  67860. for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
  67861. }
  67862. #endif
  67863. sqlite3DbFree(db, p->zErrMsg);
  67864. p->zErrMsg = 0;
  67865. p->pResultSet = 0;
  67866. }
  67867. /*
  67868. ** Set the number of result columns that will be returned by this SQL
  67869. ** statement. This is now set at compile time, rather than during
  67870. ** execution of the vdbe program so that sqlite3_column_count() can
  67871. ** be called on an SQL statement before sqlite3_step().
  67872. */
  67873. SQLITE_PRIVATE void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
  67874. Mem *pColName;
  67875. int n;
  67876. sqlite3 *db = p->db;
  67877. releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
  67878. sqlite3DbFree(db, p->aColName);
  67879. n = nResColumn*COLNAME_N;
  67880. p->nResColumn = (u16)nResColumn;
  67881. p->aColName = pColName = (Mem*)sqlite3DbMallocRawNN(db, sizeof(Mem)*n );
  67882. if( p->aColName==0 ) return;
  67883. initMemArray(p->aColName, n, p->db, MEM_Null);
  67884. }
  67885. /*
  67886. ** Set the name of the idx'th column to be returned by the SQL statement.
  67887. ** zName must be a pointer to a nul terminated string.
  67888. **
  67889. ** This call must be made after a call to sqlite3VdbeSetNumCols().
  67890. **
  67891. ** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
  67892. ** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
  67893. ** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
  67894. */
  67895. SQLITE_PRIVATE int sqlite3VdbeSetColName(
  67896. Vdbe *p, /* Vdbe being configured */
  67897. int idx, /* Index of column zName applies to */
  67898. int var, /* One of the COLNAME_* constants */
  67899. const char *zName, /* Pointer to buffer containing name */
  67900. void (*xDel)(void*) /* Memory management strategy for zName */
  67901. ){
  67902. int rc;
  67903. Mem *pColName;
  67904. assert( idx<p->nResColumn );
  67905. assert( var<COLNAME_N );
  67906. if( p->db->mallocFailed ){
  67907. assert( !zName || xDel!=SQLITE_DYNAMIC );
  67908. return SQLITE_NOMEM_BKPT;
  67909. }
  67910. assert( p->aColName!=0 );
  67911. pColName = &(p->aColName[idx+var*p->nResColumn]);
  67912. rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
  67913. assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
  67914. return rc;
  67915. }
  67916. /*
  67917. ** A read or write transaction may or may not be active on database handle
  67918. ** db. If a transaction is active, commit it. If there is a
  67919. ** write-transaction spanning more than one database file, this routine
  67920. ** takes care of the master journal trickery.
  67921. */
  67922. static int vdbeCommit(sqlite3 *db, Vdbe *p){
  67923. int i;
  67924. int nTrans = 0; /* Number of databases with an active write-transaction
  67925. ** that are candidates for a two-phase commit using a
  67926. ** master-journal */
  67927. int rc = SQLITE_OK;
  67928. int needXcommit = 0;
  67929. #ifdef SQLITE_OMIT_VIRTUALTABLE
  67930. /* With this option, sqlite3VtabSync() is defined to be simply
  67931. ** SQLITE_OK so p is not used.
  67932. */
  67933. UNUSED_PARAMETER(p);
  67934. #endif
  67935. /* Before doing anything else, call the xSync() callback for any
  67936. ** virtual module tables written in this transaction. This has to
  67937. ** be done before determining whether a master journal file is
  67938. ** required, as an xSync() callback may add an attached database
  67939. ** to the transaction.
  67940. */
  67941. rc = sqlite3VtabSync(db, p);
  67942. /* This loop determines (a) if the commit hook should be invoked and
  67943. ** (b) how many database files have open write transactions, not
  67944. ** including the temp database. (b) is important because if more than
  67945. ** one database file has an open write transaction, a master journal
  67946. ** file is required for an atomic commit.
  67947. */
  67948. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  67949. Btree *pBt = db->aDb[i].pBt;
  67950. if( sqlite3BtreeIsInTrans(pBt) ){
  67951. /* Whether or not a database might need a master journal depends upon
  67952. ** its journal mode (among other things). This matrix determines which
  67953. ** journal modes use a master journal and which do not */
  67954. static const u8 aMJNeeded[] = {
  67955. /* DELETE */ 1,
  67956. /* PERSIST */ 1,
  67957. /* OFF */ 0,
  67958. /* TRUNCATE */ 1,
  67959. /* MEMORY */ 0,
  67960. /* WAL */ 0
  67961. };
  67962. Pager *pPager; /* Pager associated with pBt */
  67963. needXcommit = 1;
  67964. sqlite3BtreeEnter(pBt);
  67965. pPager = sqlite3BtreePager(pBt);
  67966. if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
  67967. && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
  67968. ){
  67969. assert( i!=1 );
  67970. nTrans++;
  67971. }
  67972. rc = sqlite3PagerExclusiveLock(pPager);
  67973. sqlite3BtreeLeave(pBt);
  67974. }
  67975. }
  67976. if( rc!=SQLITE_OK ){
  67977. return rc;
  67978. }
  67979. /* If there are any write-transactions at all, invoke the commit hook */
  67980. if( needXcommit && db->xCommitCallback ){
  67981. rc = db->xCommitCallback(db->pCommitArg);
  67982. if( rc ){
  67983. return SQLITE_CONSTRAINT_COMMITHOOK;
  67984. }
  67985. }
  67986. /* The simple case - no more than one database file (not counting the
  67987. ** TEMP database) has a transaction active. There is no need for the
  67988. ** master-journal.
  67989. **
  67990. ** If the return value of sqlite3BtreeGetFilename() is a zero length
  67991. ** string, it means the main database is :memory: or a temp file. In
  67992. ** that case we do not support atomic multi-file commits, so use the
  67993. ** simple case then too.
  67994. */
  67995. if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
  67996. || nTrans<=1
  67997. ){
  67998. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  67999. Btree *pBt = db->aDb[i].pBt;
  68000. if( pBt ){
  68001. rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
  68002. }
  68003. }
  68004. /* Do the commit only if all databases successfully complete phase 1.
  68005. ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
  68006. ** IO error while deleting or truncating a journal file. It is unlikely,
  68007. ** but could happen. In this case abandon processing and return the error.
  68008. */
  68009. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  68010. Btree *pBt = db->aDb[i].pBt;
  68011. if( pBt ){
  68012. rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
  68013. }
  68014. }
  68015. if( rc==SQLITE_OK ){
  68016. sqlite3VtabCommit(db);
  68017. }
  68018. }
  68019. /* The complex case - There is a multi-file write-transaction active.
  68020. ** This requires a master journal file to ensure the transaction is
  68021. ** committed atomically.
  68022. */
  68023. #ifndef SQLITE_OMIT_DISKIO
  68024. else{
  68025. sqlite3_vfs *pVfs = db->pVfs;
  68026. char *zMaster = 0; /* File-name for the master journal */
  68027. char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
  68028. sqlite3_file *pMaster = 0;
  68029. i64 offset = 0;
  68030. int res;
  68031. int retryCount = 0;
  68032. int nMainFile;
  68033. /* Select a master journal file name */
  68034. nMainFile = sqlite3Strlen30(zMainFile);
  68035. zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
  68036. if( zMaster==0 ) return SQLITE_NOMEM_BKPT;
  68037. do {
  68038. u32 iRandom;
  68039. if( retryCount ){
  68040. if( retryCount>100 ){
  68041. sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
  68042. sqlite3OsDelete(pVfs, zMaster, 0);
  68043. break;
  68044. }else if( retryCount==1 ){
  68045. sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
  68046. }
  68047. }
  68048. retryCount++;
  68049. sqlite3_randomness(sizeof(iRandom), &iRandom);
  68050. sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
  68051. (iRandom>>8)&0xffffff, iRandom&0xff);
  68052. /* The antipenultimate character of the master journal name must
  68053. ** be "9" to avoid name collisions when using 8+3 filenames. */
  68054. assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
  68055. sqlite3FileSuffix3(zMainFile, zMaster);
  68056. rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
  68057. }while( rc==SQLITE_OK && res );
  68058. if( rc==SQLITE_OK ){
  68059. /* Open the master journal. */
  68060. rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
  68061. SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
  68062. SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
  68063. );
  68064. }
  68065. if( rc!=SQLITE_OK ){
  68066. sqlite3DbFree(db, zMaster);
  68067. return rc;
  68068. }
  68069. /* Write the name of each database file in the transaction into the new
  68070. ** master journal file. If an error occurs at this point close
  68071. ** and delete the master journal file. All the individual journal files
  68072. ** still have 'null' as the master journal pointer, so they will roll
  68073. ** back independently if a failure occurs.
  68074. */
  68075. for(i=0; i<db->nDb; i++){
  68076. Btree *pBt = db->aDb[i].pBt;
  68077. if( sqlite3BtreeIsInTrans(pBt) ){
  68078. char const *zFile = sqlite3BtreeGetJournalname(pBt);
  68079. if( zFile==0 ){
  68080. continue; /* Ignore TEMP and :memory: databases */
  68081. }
  68082. assert( zFile[0]!=0 );
  68083. rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
  68084. offset += sqlite3Strlen30(zFile)+1;
  68085. if( rc!=SQLITE_OK ){
  68086. sqlite3OsCloseFree(pMaster);
  68087. sqlite3OsDelete(pVfs, zMaster, 0);
  68088. sqlite3DbFree(db, zMaster);
  68089. return rc;
  68090. }
  68091. }
  68092. }
  68093. /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
  68094. ** flag is set this is not required.
  68095. */
  68096. if( 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
  68097. && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
  68098. ){
  68099. sqlite3OsCloseFree(pMaster);
  68100. sqlite3OsDelete(pVfs, zMaster, 0);
  68101. sqlite3DbFree(db, zMaster);
  68102. return rc;
  68103. }
  68104. /* Sync all the db files involved in the transaction. The same call
  68105. ** sets the master journal pointer in each individual journal. If
  68106. ** an error occurs here, do not delete the master journal file.
  68107. **
  68108. ** If the error occurs during the first call to
  68109. ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
  68110. ** master journal file will be orphaned. But we cannot delete it,
  68111. ** in case the master journal file name was written into the journal
  68112. ** file before the failure occurred.
  68113. */
  68114. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  68115. Btree *pBt = db->aDb[i].pBt;
  68116. if( pBt ){
  68117. rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
  68118. }
  68119. }
  68120. sqlite3OsCloseFree(pMaster);
  68121. assert( rc!=SQLITE_BUSY );
  68122. if( rc!=SQLITE_OK ){
  68123. sqlite3DbFree(db, zMaster);
  68124. return rc;
  68125. }
  68126. /* Delete the master journal file. This commits the transaction. After
  68127. ** doing this the directory is synced again before any individual
  68128. ** transaction files are deleted.
  68129. */
  68130. rc = sqlite3OsDelete(pVfs, zMaster, 1);
  68131. sqlite3DbFree(db, zMaster);
  68132. zMaster = 0;
  68133. if( rc ){
  68134. return rc;
  68135. }
  68136. /* All files and directories have already been synced, so the following
  68137. ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
  68138. ** deleting or truncating journals. If something goes wrong while
  68139. ** this is happening we don't really care. The integrity of the
  68140. ** transaction is already guaranteed, but some stray 'cold' journals
  68141. ** may be lying around. Returning an error code won't help matters.
  68142. */
  68143. disable_simulated_io_errors();
  68144. sqlite3BeginBenignMalloc();
  68145. for(i=0; i<db->nDb; i++){
  68146. Btree *pBt = db->aDb[i].pBt;
  68147. if( pBt ){
  68148. sqlite3BtreeCommitPhaseTwo(pBt, 1);
  68149. }
  68150. }
  68151. sqlite3EndBenignMalloc();
  68152. enable_simulated_io_errors();
  68153. sqlite3VtabCommit(db);
  68154. }
  68155. #endif
  68156. return rc;
  68157. }
  68158. /*
  68159. ** This routine checks that the sqlite3.nVdbeActive count variable
  68160. ** matches the number of vdbe's in the list sqlite3.pVdbe that are
  68161. ** currently active. An assertion fails if the two counts do not match.
  68162. ** This is an internal self-check only - it is not an essential processing
  68163. ** step.
  68164. **
  68165. ** This is a no-op if NDEBUG is defined.
  68166. */
  68167. #ifndef NDEBUG
  68168. static void checkActiveVdbeCnt(sqlite3 *db){
  68169. Vdbe *p;
  68170. int cnt = 0;
  68171. int nWrite = 0;
  68172. int nRead = 0;
  68173. p = db->pVdbe;
  68174. while( p ){
  68175. if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
  68176. cnt++;
  68177. if( p->readOnly==0 ) nWrite++;
  68178. if( p->bIsReader ) nRead++;
  68179. }
  68180. p = p->pNext;
  68181. }
  68182. assert( cnt==db->nVdbeActive );
  68183. assert( nWrite==db->nVdbeWrite );
  68184. assert( nRead==db->nVdbeRead );
  68185. }
  68186. #else
  68187. #define checkActiveVdbeCnt(x)
  68188. #endif
  68189. /*
  68190. ** If the Vdbe passed as the first argument opened a statement-transaction,
  68191. ** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
  68192. ** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
  68193. ** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
  68194. ** statement transaction is committed.
  68195. **
  68196. ** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
  68197. ** Otherwise SQLITE_OK.
  68198. */
  68199. SQLITE_PRIVATE int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
  68200. sqlite3 *const db = p->db;
  68201. int rc = SQLITE_OK;
  68202. /* If p->iStatement is greater than zero, then this Vdbe opened a
  68203. ** statement transaction that should be closed here. The only exception
  68204. ** is that an IO error may have occurred, causing an emergency rollback.
  68205. ** In this case (db->nStatement==0), and there is nothing to do.
  68206. */
  68207. if( db->nStatement && p->iStatement ){
  68208. int i;
  68209. const int iSavepoint = p->iStatement-1;
  68210. assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
  68211. assert( db->nStatement>0 );
  68212. assert( p->iStatement==(db->nStatement+db->nSavepoint) );
  68213. for(i=0; i<db->nDb; i++){
  68214. int rc2 = SQLITE_OK;
  68215. Btree *pBt = db->aDb[i].pBt;
  68216. if( pBt ){
  68217. if( eOp==SAVEPOINT_ROLLBACK ){
  68218. rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
  68219. }
  68220. if( rc2==SQLITE_OK ){
  68221. rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
  68222. }
  68223. if( rc==SQLITE_OK ){
  68224. rc = rc2;
  68225. }
  68226. }
  68227. }
  68228. db->nStatement--;
  68229. p->iStatement = 0;
  68230. if( rc==SQLITE_OK ){
  68231. if( eOp==SAVEPOINT_ROLLBACK ){
  68232. rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
  68233. }
  68234. if( rc==SQLITE_OK ){
  68235. rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
  68236. }
  68237. }
  68238. /* If the statement transaction is being rolled back, also restore the
  68239. ** database handles deferred constraint counter to the value it had when
  68240. ** the statement transaction was opened. */
  68241. if( eOp==SAVEPOINT_ROLLBACK ){
  68242. db->nDeferredCons = p->nStmtDefCons;
  68243. db->nDeferredImmCons = p->nStmtDefImmCons;
  68244. }
  68245. }
  68246. return rc;
  68247. }
  68248. /*
  68249. ** This function is called when a transaction opened by the database
  68250. ** handle associated with the VM passed as an argument is about to be
  68251. ** committed. If there are outstanding deferred foreign key constraint
  68252. ** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
  68253. **
  68254. ** If there are outstanding FK violations and this function returns
  68255. ** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
  68256. ** and write an error message to it. Then return SQLITE_ERROR.
  68257. */
  68258. #ifndef SQLITE_OMIT_FOREIGN_KEY
  68259. SQLITE_PRIVATE int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
  68260. sqlite3 *db = p->db;
  68261. if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
  68262. || (!deferred && p->nFkConstraint>0)
  68263. ){
  68264. p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
  68265. p->errorAction = OE_Abort;
  68266. sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
  68267. return SQLITE_ERROR;
  68268. }
  68269. return SQLITE_OK;
  68270. }
  68271. #endif
  68272. /*
  68273. ** This routine is called the when a VDBE tries to halt. If the VDBE
  68274. ** has made changes and is in autocommit mode, then commit those
  68275. ** changes. If a rollback is needed, then do the rollback.
  68276. **
  68277. ** This routine is the only way to move the state of a VM from
  68278. ** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
  68279. ** call this on a VM that is in the SQLITE_MAGIC_HALT state.
  68280. **
  68281. ** Return an error code. If the commit could not complete because of
  68282. ** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
  68283. ** means the close did not happen and needs to be repeated.
  68284. */
  68285. SQLITE_PRIVATE int sqlite3VdbeHalt(Vdbe *p){
  68286. int rc; /* Used to store transient return codes */
  68287. sqlite3 *db = p->db;
  68288. /* This function contains the logic that determines if a statement or
  68289. ** transaction will be committed or rolled back as a result of the
  68290. ** execution of this virtual machine.
  68291. **
  68292. ** If any of the following errors occur:
  68293. **
  68294. ** SQLITE_NOMEM
  68295. ** SQLITE_IOERR
  68296. ** SQLITE_FULL
  68297. ** SQLITE_INTERRUPT
  68298. **
  68299. ** Then the internal cache might have been left in an inconsistent
  68300. ** state. We need to rollback the statement transaction, if there is
  68301. ** one, or the complete transaction if there is no statement transaction.
  68302. */
  68303. if( db->mallocFailed ){
  68304. p->rc = SQLITE_NOMEM_BKPT;
  68305. }
  68306. closeAllCursors(p);
  68307. if( p->magic!=VDBE_MAGIC_RUN ){
  68308. return SQLITE_OK;
  68309. }
  68310. checkActiveVdbeCnt(db);
  68311. /* No commit or rollback needed if the program never started or if the
  68312. ** SQL statement does not read or write a database file. */
  68313. if( p->pc>=0 && p->bIsReader ){
  68314. int mrc; /* Primary error code from p->rc */
  68315. int eStatementOp = 0;
  68316. int isSpecialError; /* Set to true if a 'special' error */
  68317. /* Lock all btrees used by the statement */
  68318. sqlite3VdbeEnter(p);
  68319. /* Check for one of the special errors */
  68320. mrc = p->rc & 0xff;
  68321. isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
  68322. || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
  68323. if( isSpecialError ){
  68324. /* If the query was read-only and the error code is SQLITE_INTERRUPT,
  68325. ** no rollback is necessary. Otherwise, at least a savepoint
  68326. ** transaction must be rolled back to restore the database to a
  68327. ** consistent state.
  68328. **
  68329. ** Even if the statement is read-only, it is important to perform
  68330. ** a statement or transaction rollback operation. If the error
  68331. ** occurred while writing to the journal, sub-journal or database
  68332. ** file as part of an effort to free up cache space (see function
  68333. ** pagerStress() in pager.c), the rollback is required to restore
  68334. ** the pager to a consistent state.
  68335. */
  68336. if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
  68337. if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
  68338. eStatementOp = SAVEPOINT_ROLLBACK;
  68339. }else{
  68340. /* We are forced to roll back the active transaction. Before doing
  68341. ** so, abort any other statements this handle currently has active.
  68342. */
  68343. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  68344. sqlite3CloseSavepoints(db);
  68345. db->autoCommit = 1;
  68346. p->nChange = 0;
  68347. }
  68348. }
  68349. }
  68350. /* Check for immediate foreign key violations. */
  68351. if( p->rc==SQLITE_OK ){
  68352. sqlite3VdbeCheckFk(p, 0);
  68353. }
  68354. /* If the auto-commit flag is set and this is the only active writer
  68355. ** VM, then we do either a commit or rollback of the current transaction.
  68356. **
  68357. ** Note: This block also runs if one of the special errors handled
  68358. ** above has occurred.
  68359. */
  68360. if( !sqlite3VtabInSync(db)
  68361. && db->autoCommit
  68362. && db->nVdbeWrite==(p->readOnly==0)
  68363. ){
  68364. if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
  68365. rc = sqlite3VdbeCheckFk(p, 1);
  68366. if( rc!=SQLITE_OK ){
  68367. if( NEVER(p->readOnly) ){
  68368. sqlite3VdbeLeave(p);
  68369. return SQLITE_ERROR;
  68370. }
  68371. rc = SQLITE_CONSTRAINT_FOREIGNKEY;
  68372. }else{
  68373. /* The auto-commit flag is true, the vdbe program was successful
  68374. ** or hit an 'OR FAIL' constraint and there are no deferred foreign
  68375. ** key constraints to hold up the transaction. This means a commit
  68376. ** is required. */
  68377. rc = vdbeCommit(db, p);
  68378. }
  68379. if( rc==SQLITE_BUSY && p->readOnly ){
  68380. sqlite3VdbeLeave(p);
  68381. return SQLITE_BUSY;
  68382. }else if( rc!=SQLITE_OK ){
  68383. p->rc = rc;
  68384. sqlite3RollbackAll(db, SQLITE_OK);
  68385. p->nChange = 0;
  68386. }else{
  68387. db->nDeferredCons = 0;
  68388. db->nDeferredImmCons = 0;
  68389. db->flags &= ~SQLITE_DeferFKs;
  68390. sqlite3CommitInternalChanges(db);
  68391. }
  68392. }else{
  68393. sqlite3RollbackAll(db, SQLITE_OK);
  68394. p->nChange = 0;
  68395. }
  68396. db->nStatement = 0;
  68397. }else if( eStatementOp==0 ){
  68398. if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
  68399. eStatementOp = SAVEPOINT_RELEASE;
  68400. }else if( p->errorAction==OE_Abort ){
  68401. eStatementOp = SAVEPOINT_ROLLBACK;
  68402. }else{
  68403. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  68404. sqlite3CloseSavepoints(db);
  68405. db->autoCommit = 1;
  68406. p->nChange = 0;
  68407. }
  68408. }
  68409. /* If eStatementOp is non-zero, then a statement transaction needs to
  68410. ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
  68411. ** do so. If this operation returns an error, and the current statement
  68412. ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
  68413. ** current statement error code.
  68414. */
  68415. if( eStatementOp ){
  68416. rc = sqlite3VdbeCloseStatement(p, eStatementOp);
  68417. if( rc ){
  68418. if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
  68419. p->rc = rc;
  68420. sqlite3DbFree(db, p->zErrMsg);
  68421. p->zErrMsg = 0;
  68422. }
  68423. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  68424. sqlite3CloseSavepoints(db);
  68425. db->autoCommit = 1;
  68426. p->nChange = 0;
  68427. }
  68428. }
  68429. /* If this was an INSERT, UPDATE or DELETE and no statement transaction
  68430. ** has been rolled back, update the database connection change-counter.
  68431. */
  68432. if( p->changeCntOn ){
  68433. if( eStatementOp!=SAVEPOINT_ROLLBACK ){
  68434. sqlite3VdbeSetChanges(db, p->nChange);
  68435. }else{
  68436. sqlite3VdbeSetChanges(db, 0);
  68437. }
  68438. p->nChange = 0;
  68439. }
  68440. /* Release the locks */
  68441. sqlite3VdbeLeave(p);
  68442. }
  68443. /* We have successfully halted and closed the VM. Record this fact. */
  68444. if( p->pc>=0 ){
  68445. db->nVdbeActive--;
  68446. if( !p->readOnly ) db->nVdbeWrite--;
  68447. if( p->bIsReader ) db->nVdbeRead--;
  68448. assert( db->nVdbeActive>=db->nVdbeRead );
  68449. assert( db->nVdbeRead>=db->nVdbeWrite );
  68450. assert( db->nVdbeWrite>=0 );
  68451. }
  68452. p->magic = VDBE_MAGIC_HALT;
  68453. checkActiveVdbeCnt(db);
  68454. if( db->mallocFailed ){
  68455. p->rc = SQLITE_NOMEM_BKPT;
  68456. }
  68457. /* If the auto-commit flag is set to true, then any locks that were held
  68458. ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
  68459. ** to invoke any required unlock-notify callbacks.
  68460. */
  68461. if( db->autoCommit ){
  68462. sqlite3ConnectionUnlocked(db);
  68463. }
  68464. assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
  68465. return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
  68466. }
  68467. /*
  68468. ** Each VDBE holds the result of the most recent sqlite3_step() call
  68469. ** in p->rc. This routine sets that result back to SQLITE_OK.
  68470. */
  68471. SQLITE_PRIVATE void sqlite3VdbeResetStepResult(Vdbe *p){
  68472. p->rc = SQLITE_OK;
  68473. }
  68474. /*
  68475. ** Copy the error code and error message belonging to the VDBE passed
  68476. ** as the first argument to its database handle (so that they will be
  68477. ** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
  68478. **
  68479. ** This function does not clear the VDBE error code or message, just
  68480. ** copies them to the database handle.
  68481. */
  68482. SQLITE_PRIVATE int sqlite3VdbeTransferError(Vdbe *p){
  68483. sqlite3 *db = p->db;
  68484. int rc = p->rc;
  68485. if( p->zErrMsg ){
  68486. db->bBenignMalloc++;
  68487. sqlite3BeginBenignMalloc();
  68488. if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
  68489. sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
  68490. sqlite3EndBenignMalloc();
  68491. db->bBenignMalloc--;
  68492. db->errCode = rc;
  68493. }else{
  68494. sqlite3Error(db, rc);
  68495. }
  68496. return rc;
  68497. }
  68498. #ifdef SQLITE_ENABLE_SQLLOG
  68499. /*
  68500. ** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
  68501. ** invoke it.
  68502. */
  68503. static void vdbeInvokeSqllog(Vdbe *v){
  68504. if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
  68505. char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
  68506. assert( v->db->init.busy==0 );
  68507. if( zExpanded ){
  68508. sqlite3GlobalConfig.xSqllog(
  68509. sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
  68510. );
  68511. sqlite3DbFree(v->db, zExpanded);
  68512. }
  68513. }
  68514. }
  68515. #else
  68516. # define vdbeInvokeSqllog(x)
  68517. #endif
  68518. /*
  68519. ** Clean up a VDBE after execution but do not delete the VDBE just yet.
  68520. ** Write any error messages into *pzErrMsg. Return the result code.
  68521. **
  68522. ** After this routine is run, the VDBE should be ready to be executed
  68523. ** again.
  68524. **
  68525. ** To look at it another way, this routine resets the state of the
  68526. ** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
  68527. ** VDBE_MAGIC_INIT.
  68528. */
  68529. SQLITE_PRIVATE int sqlite3VdbeReset(Vdbe *p){
  68530. sqlite3 *db;
  68531. db = p->db;
  68532. /* If the VM did not run to completion or if it encountered an
  68533. ** error, then it might not have been halted properly. So halt
  68534. ** it now.
  68535. */
  68536. sqlite3VdbeHalt(p);
  68537. /* If the VDBE has be run even partially, then transfer the error code
  68538. ** and error message from the VDBE into the main database structure. But
  68539. ** if the VDBE has just been set to run but has not actually executed any
  68540. ** instructions yet, leave the main database error information unchanged.
  68541. */
  68542. if( p->pc>=0 ){
  68543. vdbeInvokeSqllog(p);
  68544. sqlite3VdbeTransferError(p);
  68545. sqlite3DbFree(db, p->zErrMsg);
  68546. p->zErrMsg = 0;
  68547. if( p->runOnlyOnce ) p->expired = 1;
  68548. }else if( p->rc && p->expired ){
  68549. /* The expired flag was set on the VDBE before the first call
  68550. ** to sqlite3_step(). For consistency (since sqlite3_step() was
  68551. ** called), set the database error in this case as well.
  68552. */
  68553. sqlite3ErrorWithMsg(db, p->rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
  68554. sqlite3DbFree(db, p->zErrMsg);
  68555. p->zErrMsg = 0;
  68556. }
  68557. /* Reclaim all memory used by the VDBE
  68558. */
  68559. Cleanup(p);
  68560. /* Save profiling information from this VDBE run.
  68561. */
  68562. #ifdef VDBE_PROFILE
  68563. {
  68564. FILE *out = fopen("vdbe_profile.out", "a");
  68565. if( out ){
  68566. int i;
  68567. fprintf(out, "---- ");
  68568. for(i=0; i<p->nOp; i++){
  68569. fprintf(out, "%02x", p->aOp[i].opcode);
  68570. }
  68571. fprintf(out, "\n");
  68572. if( p->zSql ){
  68573. char c, pc = 0;
  68574. fprintf(out, "-- ");
  68575. for(i=0; (c = p->zSql[i])!=0; i++){
  68576. if( pc=='\n' ) fprintf(out, "-- ");
  68577. putc(c, out);
  68578. pc = c;
  68579. }
  68580. if( pc!='\n' ) fprintf(out, "\n");
  68581. }
  68582. for(i=0; i<p->nOp; i++){
  68583. char zHdr[100];
  68584. sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
  68585. p->aOp[i].cnt,
  68586. p->aOp[i].cycles,
  68587. p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
  68588. );
  68589. fprintf(out, "%s", zHdr);
  68590. sqlite3VdbePrintOp(out, i, &p->aOp[i]);
  68591. }
  68592. fclose(out);
  68593. }
  68594. }
  68595. #endif
  68596. p->iCurrentTime = 0;
  68597. p->magic = VDBE_MAGIC_RESET;
  68598. return p->rc & db->errMask;
  68599. }
  68600. /*
  68601. ** Clean up and delete a VDBE after execution. Return an integer which is
  68602. ** the result code. Write any error message text into *pzErrMsg.
  68603. */
  68604. SQLITE_PRIVATE int sqlite3VdbeFinalize(Vdbe *p){
  68605. int rc = SQLITE_OK;
  68606. if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
  68607. rc = sqlite3VdbeReset(p);
  68608. assert( (rc & p->db->errMask)==rc );
  68609. }
  68610. sqlite3VdbeDelete(p);
  68611. return rc;
  68612. }
  68613. /*
  68614. ** If parameter iOp is less than zero, then invoke the destructor for
  68615. ** all auxiliary data pointers currently cached by the VM passed as
  68616. ** the first argument.
  68617. **
  68618. ** Or, if iOp is greater than or equal to zero, then the destructor is
  68619. ** only invoked for those auxiliary data pointers created by the user
  68620. ** function invoked by the OP_Function opcode at instruction iOp of
  68621. ** VM pVdbe, and only then if:
  68622. **
  68623. ** * the associated function parameter is the 32nd or later (counting
  68624. ** from left to right), or
  68625. **
  68626. ** * the corresponding bit in argument mask is clear (where the first
  68627. ** function parameter corresponds to bit 0 etc.).
  68628. */
  68629. SQLITE_PRIVATE void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
  68630. while( *pp ){
  68631. AuxData *pAux = *pp;
  68632. if( (iOp<0)
  68633. || (pAux->iOp==iOp && (pAux->iArg>31 || !(mask & MASKBIT32(pAux->iArg))))
  68634. ){
  68635. testcase( pAux->iArg==31 );
  68636. if( pAux->xDelete ){
  68637. pAux->xDelete(pAux->pAux);
  68638. }
  68639. *pp = pAux->pNext;
  68640. sqlite3DbFree(db, pAux);
  68641. }else{
  68642. pp= &pAux->pNext;
  68643. }
  68644. }
  68645. }
  68646. /*
  68647. ** Free all memory associated with the Vdbe passed as the second argument,
  68648. ** except for object itself, which is preserved.
  68649. **
  68650. ** The difference between this function and sqlite3VdbeDelete() is that
  68651. ** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
  68652. ** the database connection and frees the object itself.
  68653. */
  68654. SQLITE_PRIVATE void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
  68655. SubProgram *pSub, *pNext;
  68656. int i;
  68657. assert( p->db==0 || p->db==db );
  68658. releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
  68659. for(pSub=p->pProgram; pSub; pSub=pNext){
  68660. pNext = pSub->pNext;
  68661. vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
  68662. sqlite3DbFree(db, pSub);
  68663. }
  68664. if( p->magic!=VDBE_MAGIC_INIT ){
  68665. releaseMemArray(p->aVar, p->nVar);
  68666. for(i=p->nzVar-1; i>=0; i--) sqlite3DbFree(db, p->azVar[i]);
  68667. sqlite3DbFree(db, p->azVar);
  68668. sqlite3DbFree(db, p->pFree);
  68669. }
  68670. vdbeFreeOpArray(db, p->aOp, p->nOp);
  68671. sqlite3DbFree(db, p->aColName);
  68672. sqlite3DbFree(db, p->zSql);
  68673. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  68674. for(i=0; i<p->nScan; i++){
  68675. sqlite3DbFree(db, p->aScan[i].zName);
  68676. }
  68677. sqlite3DbFree(db, p->aScan);
  68678. #endif
  68679. }
  68680. /*
  68681. ** Delete an entire VDBE.
  68682. */
  68683. SQLITE_PRIVATE void sqlite3VdbeDelete(Vdbe *p){
  68684. sqlite3 *db;
  68685. if( NEVER(p==0) ) return;
  68686. db = p->db;
  68687. assert( sqlite3_mutex_held(db->mutex) );
  68688. sqlite3VdbeClearObject(db, p);
  68689. if( p->pPrev ){
  68690. p->pPrev->pNext = p->pNext;
  68691. }else{
  68692. assert( db->pVdbe==p );
  68693. db->pVdbe = p->pNext;
  68694. }
  68695. if( p->pNext ){
  68696. p->pNext->pPrev = p->pPrev;
  68697. }
  68698. p->magic = VDBE_MAGIC_DEAD;
  68699. p->db = 0;
  68700. sqlite3DbFree(db, p);
  68701. }
  68702. /*
  68703. ** The cursor "p" has a pending seek operation that has not yet been
  68704. ** carried out. Seek the cursor now. If an error occurs, return
  68705. ** the appropriate error code.
  68706. */
  68707. static int SQLITE_NOINLINE handleDeferredMoveto(VdbeCursor *p){
  68708. int res, rc;
  68709. #ifdef SQLITE_TEST
  68710. extern int sqlite3_search_count;
  68711. #endif
  68712. assert( p->deferredMoveto );
  68713. assert( p->isTable );
  68714. assert( p->eCurType==CURTYPE_BTREE );
  68715. rc = sqlite3BtreeMovetoUnpacked(p->uc.pCursor, 0, p->movetoTarget, 0, &res);
  68716. if( rc ) return rc;
  68717. if( res!=0 ) return SQLITE_CORRUPT_BKPT;
  68718. #ifdef SQLITE_TEST
  68719. sqlite3_search_count++;
  68720. #endif
  68721. p->deferredMoveto = 0;
  68722. p->cacheStatus = CACHE_STALE;
  68723. return SQLITE_OK;
  68724. }
  68725. /*
  68726. ** Something has moved cursor "p" out of place. Maybe the row it was
  68727. ** pointed to was deleted out from under it. Or maybe the btree was
  68728. ** rebalanced. Whatever the cause, try to restore "p" to the place it
  68729. ** is supposed to be pointing. If the row was deleted out from under the
  68730. ** cursor, set the cursor to point to a NULL row.
  68731. */
  68732. static int SQLITE_NOINLINE handleMovedCursor(VdbeCursor *p){
  68733. int isDifferentRow, rc;
  68734. assert( p->eCurType==CURTYPE_BTREE );
  68735. assert( p->uc.pCursor!=0 );
  68736. assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
  68737. rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
  68738. p->cacheStatus = CACHE_STALE;
  68739. if( isDifferentRow ) p->nullRow = 1;
  68740. return rc;
  68741. }
  68742. /*
  68743. ** Check to ensure that the cursor is valid. Restore the cursor
  68744. ** if need be. Return any I/O error from the restore operation.
  68745. */
  68746. SQLITE_PRIVATE int sqlite3VdbeCursorRestore(VdbeCursor *p){
  68747. assert( p->eCurType==CURTYPE_BTREE );
  68748. if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
  68749. return handleMovedCursor(p);
  68750. }
  68751. return SQLITE_OK;
  68752. }
  68753. /*
  68754. ** Make sure the cursor p is ready to read or write the row to which it
  68755. ** was last positioned. Return an error code if an OOM fault or I/O error
  68756. ** prevents us from positioning the cursor to its correct position.
  68757. **
  68758. ** If a MoveTo operation is pending on the given cursor, then do that
  68759. ** MoveTo now. If no move is pending, check to see if the row has been
  68760. ** deleted out from under the cursor and if it has, mark the row as
  68761. ** a NULL row.
  68762. **
  68763. ** If the cursor is already pointing to the correct row and that row has
  68764. ** not been deleted out from under the cursor, then this routine is a no-op.
  68765. */
  68766. SQLITE_PRIVATE int sqlite3VdbeCursorMoveto(VdbeCursor **pp, int *piCol){
  68767. VdbeCursor *p = *pp;
  68768. if( p->eCurType==CURTYPE_BTREE ){
  68769. if( p->deferredMoveto ){
  68770. int iMap;
  68771. if( p->aAltMap && (iMap = p->aAltMap[1+*piCol])>0 ){
  68772. *pp = p->pAltCursor;
  68773. *piCol = iMap - 1;
  68774. return SQLITE_OK;
  68775. }
  68776. return handleDeferredMoveto(p);
  68777. }
  68778. if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
  68779. return handleMovedCursor(p);
  68780. }
  68781. }
  68782. return SQLITE_OK;
  68783. }
  68784. /*
  68785. ** The following functions:
  68786. **
  68787. ** sqlite3VdbeSerialType()
  68788. ** sqlite3VdbeSerialTypeLen()
  68789. ** sqlite3VdbeSerialLen()
  68790. ** sqlite3VdbeSerialPut()
  68791. ** sqlite3VdbeSerialGet()
  68792. **
  68793. ** encapsulate the code that serializes values for storage in SQLite
  68794. ** data and index records. Each serialized value consists of a
  68795. ** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
  68796. ** integer, stored as a varint.
  68797. **
  68798. ** In an SQLite index record, the serial type is stored directly before
  68799. ** the blob of data that it corresponds to. In a table record, all serial
  68800. ** types are stored at the start of the record, and the blobs of data at
  68801. ** the end. Hence these functions allow the caller to handle the
  68802. ** serial-type and data blob separately.
  68803. **
  68804. ** The following table describes the various storage classes for data:
  68805. **
  68806. ** serial type bytes of data type
  68807. ** -------------- --------------- ---------------
  68808. ** 0 0 NULL
  68809. ** 1 1 signed integer
  68810. ** 2 2 signed integer
  68811. ** 3 3 signed integer
  68812. ** 4 4 signed integer
  68813. ** 5 6 signed integer
  68814. ** 6 8 signed integer
  68815. ** 7 8 IEEE float
  68816. ** 8 0 Integer constant 0
  68817. ** 9 0 Integer constant 1
  68818. ** 10,11 reserved for expansion
  68819. ** N>=12 and even (N-12)/2 BLOB
  68820. ** N>=13 and odd (N-13)/2 text
  68821. **
  68822. ** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
  68823. ** of SQLite will not understand those serial types.
  68824. */
  68825. /*
  68826. ** Return the serial-type for the value stored in pMem.
  68827. */
  68828. SQLITE_PRIVATE u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
  68829. int flags = pMem->flags;
  68830. u32 n;
  68831. assert( pLen!=0 );
  68832. if( flags&MEM_Null ){
  68833. *pLen = 0;
  68834. return 0;
  68835. }
  68836. if( flags&MEM_Int ){
  68837. /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
  68838. # define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
  68839. i64 i = pMem->u.i;
  68840. u64 u;
  68841. if( i<0 ){
  68842. u = ~i;
  68843. }else{
  68844. u = i;
  68845. }
  68846. if( u<=127 ){
  68847. if( (i&1)==i && file_format>=4 ){
  68848. *pLen = 0;
  68849. return 8+(u32)u;
  68850. }else{
  68851. *pLen = 1;
  68852. return 1;
  68853. }
  68854. }
  68855. if( u<=32767 ){ *pLen = 2; return 2; }
  68856. if( u<=8388607 ){ *pLen = 3; return 3; }
  68857. if( u<=2147483647 ){ *pLen = 4; return 4; }
  68858. if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
  68859. *pLen = 8;
  68860. return 6;
  68861. }
  68862. if( flags&MEM_Real ){
  68863. *pLen = 8;
  68864. return 7;
  68865. }
  68866. assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
  68867. assert( pMem->n>=0 );
  68868. n = (u32)pMem->n;
  68869. if( flags & MEM_Zero ){
  68870. n += pMem->u.nZero;
  68871. }
  68872. *pLen = n;
  68873. return ((n*2) + 12 + ((flags&MEM_Str)!=0));
  68874. }
  68875. /*
  68876. ** The sizes for serial types less than 128
  68877. */
  68878. static const u8 sqlite3SmallTypeSizes[] = {
  68879. /* 0 1 2 3 4 5 6 7 8 9 */
  68880. /* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
  68881. /* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
  68882. /* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
  68883. /* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
  68884. /* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
  68885. /* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
  68886. /* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
  68887. /* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
  68888. /* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
  68889. /* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
  68890. /* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
  68891. /* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
  68892. /* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
  68893. };
  68894. /*
  68895. ** Return the length of the data corresponding to the supplied serial-type.
  68896. */
  68897. SQLITE_PRIVATE u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
  68898. if( serial_type>=128 ){
  68899. return (serial_type-12)/2;
  68900. }else{
  68901. assert( serial_type<12
  68902. || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
  68903. return sqlite3SmallTypeSizes[serial_type];
  68904. }
  68905. }
  68906. SQLITE_PRIVATE u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
  68907. assert( serial_type<128 );
  68908. return sqlite3SmallTypeSizes[serial_type];
  68909. }
  68910. /*
  68911. ** If we are on an architecture with mixed-endian floating
  68912. ** points (ex: ARM7) then swap the lower 4 bytes with the
  68913. ** upper 4 bytes. Return the result.
  68914. **
  68915. ** For most architectures, this is a no-op.
  68916. **
  68917. ** (later): It is reported to me that the mixed-endian problem
  68918. ** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
  68919. ** that early versions of GCC stored the two words of a 64-bit
  68920. ** float in the wrong order. And that error has been propagated
  68921. ** ever since. The blame is not necessarily with GCC, though.
  68922. ** GCC might have just copying the problem from a prior compiler.
  68923. ** I am also told that newer versions of GCC that follow a different
  68924. ** ABI get the byte order right.
  68925. **
  68926. ** Developers using SQLite on an ARM7 should compile and run their
  68927. ** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
  68928. ** enabled, some asserts below will ensure that the byte order of
  68929. ** floating point values is correct.
  68930. **
  68931. ** (2007-08-30) Frank van Vugt has studied this problem closely
  68932. ** and has send his findings to the SQLite developers. Frank
  68933. ** writes that some Linux kernels offer floating point hardware
  68934. ** emulation that uses only 32-bit mantissas instead of a full
  68935. ** 48-bits as required by the IEEE standard. (This is the
  68936. ** CONFIG_FPE_FASTFPE option.) On such systems, floating point
  68937. ** byte swapping becomes very complicated. To avoid problems,
  68938. ** the necessary byte swapping is carried out using a 64-bit integer
  68939. ** rather than a 64-bit float. Frank assures us that the code here
  68940. ** works for him. We, the developers, have no way to independently
  68941. ** verify this, but Frank seems to know what he is talking about
  68942. ** so we trust him.
  68943. */
  68944. #ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  68945. static u64 floatSwap(u64 in){
  68946. union {
  68947. u64 r;
  68948. u32 i[2];
  68949. } u;
  68950. u32 t;
  68951. u.r = in;
  68952. t = u.i[0];
  68953. u.i[0] = u.i[1];
  68954. u.i[1] = t;
  68955. return u.r;
  68956. }
  68957. # define swapMixedEndianFloat(X) X = floatSwap(X)
  68958. #else
  68959. # define swapMixedEndianFloat(X)
  68960. #endif
  68961. /*
  68962. ** Write the serialized data blob for the value stored in pMem into
  68963. ** buf. It is assumed that the caller has allocated sufficient space.
  68964. ** Return the number of bytes written.
  68965. **
  68966. ** nBuf is the amount of space left in buf[]. The caller is responsible
  68967. ** for allocating enough space to buf[] to hold the entire field, exclusive
  68968. ** of the pMem->u.nZero bytes for a MEM_Zero value.
  68969. **
  68970. ** Return the number of bytes actually written into buf[]. The number
  68971. ** of bytes in the zero-filled tail is included in the return value only
  68972. ** if those bytes were zeroed in buf[].
  68973. */
  68974. SQLITE_PRIVATE u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
  68975. u32 len;
  68976. /* Integer and Real */
  68977. if( serial_type<=7 && serial_type>0 ){
  68978. u64 v;
  68979. u32 i;
  68980. if( serial_type==7 ){
  68981. assert( sizeof(v)==sizeof(pMem->u.r) );
  68982. memcpy(&v, &pMem->u.r, sizeof(v));
  68983. swapMixedEndianFloat(v);
  68984. }else{
  68985. v = pMem->u.i;
  68986. }
  68987. len = i = sqlite3SmallTypeSizes[serial_type];
  68988. assert( i>0 );
  68989. do{
  68990. buf[--i] = (u8)(v&0xFF);
  68991. v >>= 8;
  68992. }while( i );
  68993. return len;
  68994. }
  68995. /* String or blob */
  68996. if( serial_type>=12 ){
  68997. assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
  68998. == (int)sqlite3VdbeSerialTypeLen(serial_type) );
  68999. len = pMem->n;
  69000. if( len>0 ) memcpy(buf, pMem->z, len);
  69001. return len;
  69002. }
  69003. /* NULL or constants 0 or 1 */
  69004. return 0;
  69005. }
  69006. /* Input "x" is a sequence of unsigned characters that represent a
  69007. ** big-endian integer. Return the equivalent native integer
  69008. */
  69009. #define ONE_BYTE_INT(x) ((i8)(x)[0])
  69010. #define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
  69011. #define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
  69012. #define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  69013. #define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  69014. /*
  69015. ** Deserialize the data blob pointed to by buf as serial type serial_type
  69016. ** and store the result in pMem. Return the number of bytes read.
  69017. **
  69018. ** This function is implemented as two separate routines for performance.
  69019. ** The few cases that require local variables are broken out into a separate
  69020. ** routine so that in most cases the overhead of moving the stack pointer
  69021. ** is avoided.
  69022. */
  69023. static u32 SQLITE_NOINLINE serialGet(
  69024. const unsigned char *buf, /* Buffer to deserialize from */
  69025. u32 serial_type, /* Serial type to deserialize */
  69026. Mem *pMem /* Memory cell to write value into */
  69027. ){
  69028. u64 x = FOUR_BYTE_UINT(buf);
  69029. u32 y = FOUR_BYTE_UINT(buf+4);
  69030. x = (x<<32) + y;
  69031. if( serial_type==6 ){
  69032. /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
  69033. ** twos-complement integer. */
  69034. pMem->u.i = *(i64*)&x;
  69035. pMem->flags = MEM_Int;
  69036. testcase( pMem->u.i<0 );
  69037. }else{
  69038. /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
  69039. ** floating point number. */
  69040. #if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
  69041. /* Verify that integers and floating point values use the same
  69042. ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
  69043. ** defined that 64-bit floating point values really are mixed
  69044. ** endian.
  69045. */
  69046. static const u64 t1 = ((u64)0x3ff00000)<<32;
  69047. static const double r1 = 1.0;
  69048. u64 t2 = t1;
  69049. swapMixedEndianFloat(t2);
  69050. assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
  69051. #endif
  69052. assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
  69053. swapMixedEndianFloat(x);
  69054. memcpy(&pMem->u.r, &x, sizeof(x));
  69055. pMem->flags = sqlite3IsNaN(pMem->u.r) ? MEM_Null : MEM_Real;
  69056. }
  69057. return 8;
  69058. }
  69059. SQLITE_PRIVATE u32 sqlite3VdbeSerialGet(
  69060. const unsigned char *buf, /* Buffer to deserialize from */
  69061. u32 serial_type, /* Serial type to deserialize */
  69062. Mem *pMem /* Memory cell to write value into */
  69063. ){
  69064. switch( serial_type ){
  69065. case 10: /* Reserved for future use */
  69066. case 11: /* Reserved for future use */
  69067. case 0: { /* Null */
  69068. /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
  69069. pMem->flags = MEM_Null;
  69070. break;
  69071. }
  69072. case 1: {
  69073. /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
  69074. ** integer. */
  69075. pMem->u.i = ONE_BYTE_INT(buf);
  69076. pMem->flags = MEM_Int;
  69077. testcase( pMem->u.i<0 );
  69078. return 1;
  69079. }
  69080. case 2: { /* 2-byte signed integer */
  69081. /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
  69082. ** twos-complement integer. */
  69083. pMem->u.i = TWO_BYTE_INT(buf);
  69084. pMem->flags = MEM_Int;
  69085. testcase( pMem->u.i<0 );
  69086. return 2;
  69087. }
  69088. case 3: { /* 3-byte signed integer */
  69089. /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
  69090. ** twos-complement integer. */
  69091. pMem->u.i = THREE_BYTE_INT(buf);
  69092. pMem->flags = MEM_Int;
  69093. testcase( pMem->u.i<0 );
  69094. return 3;
  69095. }
  69096. case 4: { /* 4-byte signed integer */
  69097. /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
  69098. ** twos-complement integer. */
  69099. pMem->u.i = FOUR_BYTE_INT(buf);
  69100. #ifdef __HP_cc
  69101. /* Work around a sign-extension bug in the HP compiler for HP/UX */
  69102. if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
  69103. #endif
  69104. pMem->flags = MEM_Int;
  69105. testcase( pMem->u.i<0 );
  69106. return 4;
  69107. }
  69108. case 5: { /* 6-byte signed integer */
  69109. /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
  69110. ** twos-complement integer. */
  69111. pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
  69112. pMem->flags = MEM_Int;
  69113. testcase( pMem->u.i<0 );
  69114. return 6;
  69115. }
  69116. case 6: /* 8-byte signed integer */
  69117. case 7: { /* IEEE floating point */
  69118. /* These use local variables, so do them in a separate routine
  69119. ** to avoid having to move the frame pointer in the common case */
  69120. return serialGet(buf,serial_type,pMem);
  69121. }
  69122. case 8: /* Integer 0 */
  69123. case 9: { /* Integer 1 */
  69124. /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
  69125. /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
  69126. pMem->u.i = serial_type-8;
  69127. pMem->flags = MEM_Int;
  69128. return 0;
  69129. }
  69130. default: {
  69131. /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
  69132. ** length.
  69133. ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
  69134. ** (N-13)/2 bytes in length. */
  69135. static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
  69136. pMem->z = (char *)buf;
  69137. pMem->n = (serial_type-12)/2;
  69138. pMem->flags = aFlag[serial_type&1];
  69139. return pMem->n;
  69140. }
  69141. }
  69142. return 0;
  69143. }
  69144. /*
  69145. ** This routine is used to allocate sufficient space for an UnpackedRecord
  69146. ** structure large enough to be used with sqlite3VdbeRecordUnpack() if
  69147. ** the first argument is a pointer to KeyInfo structure pKeyInfo.
  69148. **
  69149. ** The space is either allocated using sqlite3DbMallocRaw() or from within
  69150. ** the unaligned buffer passed via the second and third arguments (presumably
  69151. ** stack space). If the former, then *ppFree is set to a pointer that should
  69152. ** be eventually freed by the caller using sqlite3DbFree(). Or, if the
  69153. ** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
  69154. ** before returning.
  69155. **
  69156. ** If an OOM error occurs, NULL is returned.
  69157. */
  69158. SQLITE_PRIVATE UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
  69159. KeyInfo *pKeyInfo, /* Description of the record */
  69160. char *pSpace, /* Unaligned space available */
  69161. int szSpace, /* Size of pSpace[] in bytes */
  69162. char **ppFree /* OUT: Caller should free this pointer */
  69163. ){
  69164. UnpackedRecord *p; /* Unpacked record to return */
  69165. int nOff; /* Increment pSpace by nOff to align it */
  69166. int nByte; /* Number of bytes required for *p */
  69167. /* We want to shift the pointer pSpace up such that it is 8-byte aligned.
  69168. ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
  69169. ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
  69170. */
  69171. nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
  69172. nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
  69173. if( nByte>szSpace+nOff ){
  69174. p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
  69175. *ppFree = (char *)p;
  69176. if( !p ) return 0;
  69177. }else{
  69178. p = (UnpackedRecord*)&pSpace[nOff];
  69179. *ppFree = 0;
  69180. }
  69181. p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
  69182. assert( pKeyInfo->aSortOrder!=0 );
  69183. p->pKeyInfo = pKeyInfo;
  69184. p->nField = pKeyInfo->nField + 1;
  69185. return p;
  69186. }
  69187. /*
  69188. ** Given the nKey-byte encoding of a record in pKey[], populate the
  69189. ** UnpackedRecord structure indicated by the fourth argument with the
  69190. ** contents of the decoded record.
  69191. */
  69192. SQLITE_PRIVATE void sqlite3VdbeRecordUnpack(
  69193. KeyInfo *pKeyInfo, /* Information about the record format */
  69194. int nKey, /* Size of the binary record */
  69195. const void *pKey, /* The binary record */
  69196. UnpackedRecord *p /* Populate this structure before returning. */
  69197. ){
  69198. const unsigned char *aKey = (const unsigned char *)pKey;
  69199. int d;
  69200. u32 idx; /* Offset in aKey[] to read from */
  69201. u16 u; /* Unsigned loop counter */
  69202. u32 szHdr;
  69203. Mem *pMem = p->aMem;
  69204. p->default_rc = 0;
  69205. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  69206. idx = getVarint32(aKey, szHdr);
  69207. d = szHdr;
  69208. u = 0;
  69209. while( idx<szHdr && d<=nKey ){
  69210. u32 serial_type;
  69211. idx += getVarint32(&aKey[idx], serial_type);
  69212. pMem->enc = pKeyInfo->enc;
  69213. pMem->db = pKeyInfo->db;
  69214. /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
  69215. pMem->szMalloc = 0;
  69216. pMem->z = 0;
  69217. d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
  69218. pMem++;
  69219. if( (++u)>=p->nField ) break;
  69220. }
  69221. assert( u<=pKeyInfo->nField + 1 );
  69222. p->nField = u;
  69223. }
  69224. #if SQLITE_DEBUG
  69225. /*
  69226. ** This function compares two index or table record keys in the same way
  69227. ** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
  69228. ** this function deserializes and compares values using the
  69229. ** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
  69230. ** in assert() statements to ensure that the optimized code in
  69231. ** sqlite3VdbeRecordCompare() returns results with these two primitives.
  69232. **
  69233. ** Return true if the result of comparison is equivalent to desiredResult.
  69234. ** Return false if there is a disagreement.
  69235. */
  69236. static int vdbeRecordCompareDebug(
  69237. int nKey1, const void *pKey1, /* Left key */
  69238. const UnpackedRecord *pPKey2, /* Right key */
  69239. int desiredResult /* Correct answer */
  69240. ){
  69241. u32 d1; /* Offset into aKey[] of next data element */
  69242. u32 idx1; /* Offset into aKey[] of next header element */
  69243. u32 szHdr1; /* Number of bytes in header */
  69244. int i = 0;
  69245. int rc = 0;
  69246. const unsigned char *aKey1 = (const unsigned char *)pKey1;
  69247. KeyInfo *pKeyInfo;
  69248. Mem mem1;
  69249. pKeyInfo = pPKey2->pKeyInfo;
  69250. if( pKeyInfo->db==0 ) return 1;
  69251. mem1.enc = pKeyInfo->enc;
  69252. mem1.db = pKeyInfo->db;
  69253. /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
  69254. VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
  69255. /* Compilers may complain that mem1.u.i is potentially uninitialized.
  69256. ** We could initialize it, as shown here, to silence those complaints.
  69257. ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
  69258. ** the unnecessary initialization has a measurable negative performance
  69259. ** impact, since this routine is a very high runner. And so, we choose
  69260. ** to ignore the compiler warnings and leave this variable uninitialized.
  69261. */
  69262. /* mem1.u.i = 0; // not needed, here to silence compiler warning */
  69263. idx1 = getVarint32(aKey1, szHdr1);
  69264. if( szHdr1>98307 ) return SQLITE_CORRUPT;
  69265. d1 = szHdr1;
  69266. assert( pKeyInfo->nField+pKeyInfo->nXField>=pPKey2->nField || CORRUPT_DB );
  69267. assert( pKeyInfo->aSortOrder!=0 );
  69268. assert( pKeyInfo->nField>0 );
  69269. assert( idx1<=szHdr1 || CORRUPT_DB );
  69270. do{
  69271. u32 serial_type1;
  69272. /* Read the serial types for the next element in each key. */
  69273. idx1 += getVarint32( aKey1+idx1, serial_type1 );
  69274. /* Verify that there is enough key space remaining to avoid
  69275. ** a buffer overread. The "d1+serial_type1+2" subexpression will
  69276. ** always be greater than or equal to the amount of required key space.
  69277. ** Use that approximation to avoid the more expensive call to
  69278. ** sqlite3VdbeSerialTypeLen() in the common case.
  69279. */
  69280. if( d1+serial_type1+2>(u32)nKey1
  69281. && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
  69282. ){
  69283. break;
  69284. }
  69285. /* Extract the values to be compared.
  69286. */
  69287. d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
  69288. /* Do the comparison
  69289. */
  69290. rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
  69291. if( rc!=0 ){
  69292. assert( mem1.szMalloc==0 ); /* See comment below */
  69293. if( pKeyInfo->aSortOrder[i] ){
  69294. rc = -rc; /* Invert the result for DESC sort order. */
  69295. }
  69296. goto debugCompareEnd;
  69297. }
  69298. i++;
  69299. }while( idx1<szHdr1 && i<pPKey2->nField );
  69300. /* No memory allocation is ever used on mem1. Prove this using
  69301. ** the following assert(). If the assert() fails, it indicates a
  69302. ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
  69303. */
  69304. assert( mem1.szMalloc==0 );
  69305. /* rc==0 here means that one of the keys ran out of fields and
  69306. ** all the fields up to that point were equal. Return the default_rc
  69307. ** value. */
  69308. rc = pPKey2->default_rc;
  69309. debugCompareEnd:
  69310. if( desiredResult==0 && rc==0 ) return 1;
  69311. if( desiredResult<0 && rc<0 ) return 1;
  69312. if( desiredResult>0 && rc>0 ) return 1;
  69313. if( CORRUPT_DB ) return 1;
  69314. if( pKeyInfo->db->mallocFailed ) return 1;
  69315. return 0;
  69316. }
  69317. #endif
  69318. #if SQLITE_DEBUG
  69319. /*
  69320. ** Count the number of fields (a.k.a. columns) in the record given by
  69321. ** pKey,nKey. The verify that this count is less than or equal to the
  69322. ** limit given by pKeyInfo->nField + pKeyInfo->nXField.
  69323. **
  69324. ** If this constraint is not satisfied, it means that the high-speed
  69325. ** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
  69326. ** not work correctly. If this assert() ever fires, it probably means
  69327. ** that the KeyInfo.nField or KeyInfo.nXField values were computed
  69328. ** incorrectly.
  69329. */
  69330. static void vdbeAssertFieldCountWithinLimits(
  69331. int nKey, const void *pKey, /* The record to verify */
  69332. const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
  69333. ){
  69334. int nField = 0;
  69335. u32 szHdr;
  69336. u32 idx;
  69337. u32 notUsed;
  69338. const unsigned char *aKey = (const unsigned char*)pKey;
  69339. if( CORRUPT_DB ) return;
  69340. idx = getVarint32(aKey, szHdr);
  69341. assert( nKey>=0 );
  69342. assert( szHdr<=(u32)nKey );
  69343. while( idx<szHdr ){
  69344. idx += getVarint32(aKey+idx, notUsed);
  69345. nField++;
  69346. }
  69347. assert( nField <= pKeyInfo->nField+pKeyInfo->nXField );
  69348. }
  69349. #else
  69350. # define vdbeAssertFieldCountWithinLimits(A,B,C)
  69351. #endif
  69352. /*
  69353. ** Both *pMem1 and *pMem2 contain string values. Compare the two values
  69354. ** using the collation sequence pColl. As usual, return a negative , zero
  69355. ** or positive value if *pMem1 is less than, equal to or greater than
  69356. ** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
  69357. */
  69358. static int vdbeCompareMemString(
  69359. const Mem *pMem1,
  69360. const Mem *pMem2,
  69361. const CollSeq *pColl,
  69362. u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
  69363. ){
  69364. if( pMem1->enc==pColl->enc ){
  69365. /* The strings are already in the correct encoding. Call the
  69366. ** comparison function directly */
  69367. return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
  69368. }else{
  69369. int rc;
  69370. const void *v1, *v2;
  69371. int n1, n2;
  69372. Mem c1;
  69373. Mem c2;
  69374. sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
  69375. sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
  69376. sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
  69377. sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
  69378. v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
  69379. n1 = v1==0 ? 0 : c1.n;
  69380. v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
  69381. n2 = v2==0 ? 0 : c2.n;
  69382. rc = pColl->xCmp(pColl->pUser, n1, v1, n2, v2);
  69383. if( (v1==0 || v2==0) && prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
  69384. sqlite3VdbeMemRelease(&c1);
  69385. sqlite3VdbeMemRelease(&c2);
  69386. return rc;
  69387. }
  69388. }
  69389. /*
  69390. ** The input pBlob is guaranteed to be a Blob that is not marked
  69391. ** with MEM_Zero. Return true if it could be a zero-blob.
  69392. */
  69393. static int isAllZero(const char *z, int n){
  69394. int i;
  69395. for(i=0; i<n; i++){
  69396. if( z[i] ) return 0;
  69397. }
  69398. return 1;
  69399. }
  69400. /*
  69401. ** Compare two blobs. Return negative, zero, or positive if the first
  69402. ** is less than, equal to, or greater than the second, respectively.
  69403. ** If one blob is a prefix of the other, then the shorter is the lessor.
  69404. */
  69405. static SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
  69406. int c;
  69407. int n1 = pB1->n;
  69408. int n2 = pB2->n;
  69409. /* It is possible to have a Blob value that has some non-zero content
  69410. ** followed by zero content. But that only comes up for Blobs formed
  69411. ** by the OP_MakeRecord opcode, and such Blobs never get passed into
  69412. ** sqlite3MemCompare(). */
  69413. assert( (pB1->flags & MEM_Zero)==0 || n1==0 );
  69414. assert( (pB2->flags & MEM_Zero)==0 || n2==0 );
  69415. if( (pB1->flags|pB2->flags) & MEM_Zero ){
  69416. if( pB1->flags & pB2->flags & MEM_Zero ){
  69417. return pB1->u.nZero - pB2->u.nZero;
  69418. }else if( pB1->flags & MEM_Zero ){
  69419. if( !isAllZero(pB2->z, pB2->n) ) return -1;
  69420. return pB1->u.nZero - n2;
  69421. }else{
  69422. if( !isAllZero(pB1->z, pB1->n) ) return +1;
  69423. return n1 - pB2->u.nZero;
  69424. }
  69425. }
  69426. c = memcmp(pB1->z, pB2->z, n1>n2 ? n2 : n1);
  69427. if( c ) return c;
  69428. return n1 - n2;
  69429. }
  69430. /*
  69431. ** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
  69432. ** number. Return negative, zero, or positive if the first (i64) is less than,
  69433. ** equal to, or greater than the second (double).
  69434. */
  69435. static int sqlite3IntFloatCompare(i64 i, double r){
  69436. if( sizeof(LONGDOUBLE_TYPE)>8 ){
  69437. LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
  69438. if( x<r ) return -1;
  69439. if( x>r ) return +1;
  69440. return 0;
  69441. }else{
  69442. i64 y;
  69443. double s;
  69444. if( r<-9223372036854775808.0 ) return +1;
  69445. if( r>9223372036854775807.0 ) return -1;
  69446. y = (i64)r;
  69447. if( i<y ) return -1;
  69448. if( i>y ){
  69449. if( y==SMALLEST_INT64 && r>0.0 ) return -1;
  69450. return +1;
  69451. }
  69452. s = (double)i;
  69453. if( s<r ) return -1;
  69454. if( s>r ) return +1;
  69455. return 0;
  69456. }
  69457. }
  69458. /*
  69459. ** Compare the values contained by the two memory cells, returning
  69460. ** negative, zero or positive if pMem1 is less than, equal to, or greater
  69461. ** than pMem2. Sorting order is NULL's first, followed by numbers (integers
  69462. ** and reals) sorted numerically, followed by text ordered by the collating
  69463. ** sequence pColl and finally blob's ordered by memcmp().
  69464. **
  69465. ** Two NULL values are considered equal by this function.
  69466. */
  69467. SQLITE_PRIVATE int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
  69468. int f1, f2;
  69469. int combined_flags;
  69470. f1 = pMem1->flags;
  69471. f2 = pMem2->flags;
  69472. combined_flags = f1|f2;
  69473. assert( (combined_flags & MEM_RowSet)==0 );
  69474. /* If one value is NULL, it is less than the other. If both values
  69475. ** are NULL, return 0.
  69476. */
  69477. if( combined_flags&MEM_Null ){
  69478. return (f2&MEM_Null) - (f1&MEM_Null);
  69479. }
  69480. /* At least one of the two values is a number
  69481. */
  69482. if( combined_flags&(MEM_Int|MEM_Real) ){
  69483. if( (f1 & f2 & MEM_Int)!=0 ){
  69484. if( pMem1->u.i < pMem2->u.i ) return -1;
  69485. if( pMem1->u.i > pMem2->u.i ) return +1;
  69486. return 0;
  69487. }
  69488. if( (f1 & f2 & MEM_Real)!=0 ){
  69489. if( pMem1->u.r < pMem2->u.r ) return -1;
  69490. if( pMem1->u.r > pMem2->u.r ) return +1;
  69491. return 0;
  69492. }
  69493. if( (f1&MEM_Int)!=0 ){
  69494. if( (f2&MEM_Real)!=0 ){
  69495. return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
  69496. }else{
  69497. return -1;
  69498. }
  69499. }
  69500. if( (f1&MEM_Real)!=0 ){
  69501. if( (f2&MEM_Int)!=0 ){
  69502. return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
  69503. }else{
  69504. return -1;
  69505. }
  69506. }
  69507. return +1;
  69508. }
  69509. /* If one value is a string and the other is a blob, the string is less.
  69510. ** If both are strings, compare using the collating functions.
  69511. */
  69512. if( combined_flags&MEM_Str ){
  69513. if( (f1 & MEM_Str)==0 ){
  69514. return 1;
  69515. }
  69516. if( (f2 & MEM_Str)==0 ){
  69517. return -1;
  69518. }
  69519. assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
  69520. assert( pMem1->enc==SQLITE_UTF8 ||
  69521. pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
  69522. /* The collation sequence must be defined at this point, even if
  69523. ** the user deletes the collation sequence after the vdbe program is
  69524. ** compiled (this was not always the case).
  69525. */
  69526. assert( !pColl || pColl->xCmp );
  69527. if( pColl ){
  69528. return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
  69529. }
  69530. /* If a NULL pointer was passed as the collate function, fall through
  69531. ** to the blob case and use memcmp(). */
  69532. }
  69533. /* Both values must be blobs. Compare using memcmp(). */
  69534. return sqlite3BlobCompare(pMem1, pMem2);
  69535. }
  69536. /*
  69537. ** The first argument passed to this function is a serial-type that
  69538. ** corresponds to an integer - all values between 1 and 9 inclusive
  69539. ** except 7. The second points to a buffer containing an integer value
  69540. ** serialized according to serial_type. This function deserializes
  69541. ** and returns the value.
  69542. */
  69543. static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
  69544. u32 y;
  69545. assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
  69546. switch( serial_type ){
  69547. case 0:
  69548. case 1:
  69549. testcase( aKey[0]&0x80 );
  69550. return ONE_BYTE_INT(aKey);
  69551. case 2:
  69552. testcase( aKey[0]&0x80 );
  69553. return TWO_BYTE_INT(aKey);
  69554. case 3:
  69555. testcase( aKey[0]&0x80 );
  69556. return THREE_BYTE_INT(aKey);
  69557. case 4: {
  69558. testcase( aKey[0]&0x80 );
  69559. y = FOUR_BYTE_UINT(aKey);
  69560. return (i64)*(int*)&y;
  69561. }
  69562. case 5: {
  69563. testcase( aKey[0]&0x80 );
  69564. return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
  69565. }
  69566. case 6: {
  69567. u64 x = FOUR_BYTE_UINT(aKey);
  69568. testcase( aKey[0]&0x80 );
  69569. x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
  69570. return (i64)*(i64*)&x;
  69571. }
  69572. }
  69573. return (serial_type - 8);
  69574. }
  69575. /*
  69576. ** This function compares the two table rows or index records
  69577. ** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
  69578. ** or positive integer if key1 is less than, equal to or
  69579. ** greater than key2. The {nKey1, pKey1} key must be a blob
  69580. ** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
  69581. ** key must be a parsed key such as obtained from
  69582. ** sqlite3VdbeParseRecord.
  69583. **
  69584. ** If argument bSkip is non-zero, it is assumed that the caller has already
  69585. ** determined that the first fields of the keys are equal.
  69586. **
  69587. ** Key1 and Key2 do not have to contain the same number of fields. If all
  69588. ** fields that appear in both keys are equal, then pPKey2->default_rc is
  69589. ** returned.
  69590. **
  69591. ** If database corruption is discovered, set pPKey2->errCode to
  69592. ** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
  69593. ** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
  69594. ** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
  69595. */
  69596. SQLITE_PRIVATE int sqlite3VdbeRecordCompareWithSkip(
  69597. int nKey1, const void *pKey1, /* Left key */
  69598. UnpackedRecord *pPKey2, /* Right key */
  69599. int bSkip /* If true, skip the first field */
  69600. ){
  69601. u32 d1; /* Offset into aKey[] of next data element */
  69602. int i; /* Index of next field to compare */
  69603. u32 szHdr1; /* Size of record header in bytes */
  69604. u32 idx1; /* Offset of first type in header */
  69605. int rc = 0; /* Return value */
  69606. Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
  69607. KeyInfo *pKeyInfo = pPKey2->pKeyInfo;
  69608. const unsigned char *aKey1 = (const unsigned char *)pKey1;
  69609. Mem mem1;
  69610. /* If bSkip is true, then the caller has already determined that the first
  69611. ** two elements in the keys are equal. Fix the various stack variables so
  69612. ** that this routine begins comparing at the second field. */
  69613. if( bSkip ){
  69614. u32 s1;
  69615. idx1 = 1 + getVarint32(&aKey1[1], s1);
  69616. szHdr1 = aKey1[0];
  69617. d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
  69618. i = 1;
  69619. pRhs++;
  69620. }else{
  69621. idx1 = getVarint32(aKey1, szHdr1);
  69622. d1 = szHdr1;
  69623. if( d1>(unsigned)nKey1 ){
  69624. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  69625. return 0; /* Corruption */
  69626. }
  69627. i = 0;
  69628. }
  69629. VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
  69630. assert( pPKey2->pKeyInfo->nField+pPKey2->pKeyInfo->nXField>=pPKey2->nField
  69631. || CORRUPT_DB );
  69632. assert( pPKey2->pKeyInfo->aSortOrder!=0 );
  69633. assert( pPKey2->pKeyInfo->nField>0 );
  69634. assert( idx1<=szHdr1 || CORRUPT_DB );
  69635. do{
  69636. u32 serial_type;
  69637. /* RHS is an integer */
  69638. if( pRhs->flags & MEM_Int ){
  69639. serial_type = aKey1[idx1];
  69640. testcase( serial_type==12 );
  69641. if( serial_type>=10 ){
  69642. rc = +1;
  69643. }else if( serial_type==0 ){
  69644. rc = -1;
  69645. }else if( serial_type==7 ){
  69646. sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
  69647. rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
  69648. }else{
  69649. i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
  69650. i64 rhs = pRhs->u.i;
  69651. if( lhs<rhs ){
  69652. rc = -1;
  69653. }else if( lhs>rhs ){
  69654. rc = +1;
  69655. }
  69656. }
  69657. }
  69658. /* RHS is real */
  69659. else if( pRhs->flags & MEM_Real ){
  69660. serial_type = aKey1[idx1];
  69661. if( serial_type>=10 ){
  69662. /* Serial types 12 or greater are strings and blobs (greater than
  69663. ** numbers). Types 10 and 11 are currently "reserved for future
  69664. ** use", so it doesn't really matter what the results of comparing
  69665. ** them to numberic values are. */
  69666. rc = +1;
  69667. }else if( serial_type==0 ){
  69668. rc = -1;
  69669. }else{
  69670. sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
  69671. if( serial_type==7 ){
  69672. if( mem1.u.r<pRhs->u.r ){
  69673. rc = -1;
  69674. }else if( mem1.u.r>pRhs->u.r ){
  69675. rc = +1;
  69676. }
  69677. }else{
  69678. rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
  69679. }
  69680. }
  69681. }
  69682. /* RHS is a string */
  69683. else if( pRhs->flags & MEM_Str ){
  69684. getVarint32(&aKey1[idx1], serial_type);
  69685. testcase( serial_type==12 );
  69686. if( serial_type<12 ){
  69687. rc = -1;
  69688. }else if( !(serial_type & 0x01) ){
  69689. rc = +1;
  69690. }else{
  69691. mem1.n = (serial_type - 12) / 2;
  69692. testcase( (d1+mem1.n)==(unsigned)nKey1 );
  69693. testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
  69694. if( (d1+mem1.n) > (unsigned)nKey1 ){
  69695. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  69696. return 0; /* Corruption */
  69697. }else if( pKeyInfo->aColl[i] ){
  69698. mem1.enc = pKeyInfo->enc;
  69699. mem1.db = pKeyInfo->db;
  69700. mem1.flags = MEM_Str;
  69701. mem1.z = (char*)&aKey1[d1];
  69702. rc = vdbeCompareMemString(
  69703. &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
  69704. );
  69705. }else{
  69706. int nCmp = MIN(mem1.n, pRhs->n);
  69707. rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
  69708. if( rc==0 ) rc = mem1.n - pRhs->n;
  69709. }
  69710. }
  69711. }
  69712. /* RHS is a blob */
  69713. else if( pRhs->flags & MEM_Blob ){
  69714. assert( (pRhs->flags & MEM_Zero)==0 || pRhs->n==0 );
  69715. getVarint32(&aKey1[idx1], serial_type);
  69716. testcase( serial_type==12 );
  69717. if( serial_type<12 || (serial_type & 0x01) ){
  69718. rc = -1;
  69719. }else{
  69720. int nStr = (serial_type - 12) / 2;
  69721. testcase( (d1+nStr)==(unsigned)nKey1 );
  69722. testcase( (d1+nStr+1)==(unsigned)nKey1 );
  69723. if( (d1+nStr) > (unsigned)nKey1 ){
  69724. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  69725. return 0; /* Corruption */
  69726. }else if( pRhs->flags & MEM_Zero ){
  69727. if( !isAllZero((const char*)&aKey1[d1],nStr) ){
  69728. rc = 1;
  69729. }else{
  69730. rc = nStr - pRhs->u.nZero;
  69731. }
  69732. }else{
  69733. int nCmp = MIN(nStr, pRhs->n);
  69734. rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
  69735. if( rc==0 ) rc = nStr - pRhs->n;
  69736. }
  69737. }
  69738. }
  69739. /* RHS is null */
  69740. else{
  69741. serial_type = aKey1[idx1];
  69742. rc = (serial_type!=0);
  69743. }
  69744. if( rc!=0 ){
  69745. if( pKeyInfo->aSortOrder[i] ){
  69746. rc = -rc;
  69747. }
  69748. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
  69749. assert( mem1.szMalloc==0 ); /* See comment below */
  69750. return rc;
  69751. }
  69752. i++;
  69753. pRhs++;
  69754. d1 += sqlite3VdbeSerialTypeLen(serial_type);
  69755. idx1 += sqlite3VarintLen(serial_type);
  69756. }while( idx1<(unsigned)szHdr1 && i<pPKey2->nField && d1<=(unsigned)nKey1 );
  69757. /* No memory allocation is ever used on mem1. Prove this using
  69758. ** the following assert(). If the assert() fails, it indicates a
  69759. ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
  69760. assert( mem1.szMalloc==0 );
  69761. /* rc==0 here means that one or both of the keys ran out of fields and
  69762. ** all the fields up to that point were equal. Return the default_rc
  69763. ** value. */
  69764. assert( CORRUPT_DB
  69765. || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
  69766. || pKeyInfo->db->mallocFailed
  69767. );
  69768. pPKey2->eqSeen = 1;
  69769. return pPKey2->default_rc;
  69770. }
  69771. SQLITE_PRIVATE int sqlite3VdbeRecordCompare(
  69772. int nKey1, const void *pKey1, /* Left key */
  69773. UnpackedRecord *pPKey2 /* Right key */
  69774. ){
  69775. return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
  69776. }
  69777. /*
  69778. ** This function is an optimized version of sqlite3VdbeRecordCompare()
  69779. ** that (a) the first field of pPKey2 is an integer, and (b) the
  69780. ** size-of-header varint at the start of (pKey1/nKey1) fits in a single
  69781. ** byte (i.e. is less than 128).
  69782. **
  69783. ** To avoid concerns about buffer overreads, this routine is only used
  69784. ** on schemas where the maximum valid header size is 63 bytes or less.
  69785. */
  69786. static int vdbeRecordCompareInt(
  69787. int nKey1, const void *pKey1, /* Left key */
  69788. UnpackedRecord *pPKey2 /* Right key */
  69789. ){
  69790. const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
  69791. int serial_type = ((const u8*)pKey1)[1];
  69792. int res;
  69793. u32 y;
  69794. u64 x;
  69795. i64 v;
  69796. i64 lhs;
  69797. vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
  69798. assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
  69799. switch( serial_type ){
  69800. case 1: { /* 1-byte signed integer */
  69801. lhs = ONE_BYTE_INT(aKey);
  69802. testcase( lhs<0 );
  69803. break;
  69804. }
  69805. case 2: { /* 2-byte signed integer */
  69806. lhs = TWO_BYTE_INT(aKey);
  69807. testcase( lhs<0 );
  69808. break;
  69809. }
  69810. case 3: { /* 3-byte signed integer */
  69811. lhs = THREE_BYTE_INT(aKey);
  69812. testcase( lhs<0 );
  69813. break;
  69814. }
  69815. case 4: { /* 4-byte signed integer */
  69816. y = FOUR_BYTE_UINT(aKey);
  69817. lhs = (i64)*(int*)&y;
  69818. testcase( lhs<0 );
  69819. break;
  69820. }
  69821. case 5: { /* 6-byte signed integer */
  69822. lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
  69823. testcase( lhs<0 );
  69824. break;
  69825. }
  69826. case 6: { /* 8-byte signed integer */
  69827. x = FOUR_BYTE_UINT(aKey);
  69828. x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
  69829. lhs = *(i64*)&x;
  69830. testcase( lhs<0 );
  69831. break;
  69832. }
  69833. case 8:
  69834. lhs = 0;
  69835. break;
  69836. case 9:
  69837. lhs = 1;
  69838. break;
  69839. /* This case could be removed without changing the results of running
  69840. ** this code. Including it causes gcc to generate a faster switch
  69841. ** statement (since the range of switch targets now starts at zero and
  69842. ** is contiguous) but does not cause any duplicate code to be generated
  69843. ** (as gcc is clever enough to combine the two like cases). Other
  69844. ** compilers might be similar. */
  69845. case 0: case 7:
  69846. return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
  69847. default:
  69848. return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
  69849. }
  69850. v = pPKey2->aMem[0].u.i;
  69851. if( v>lhs ){
  69852. res = pPKey2->r1;
  69853. }else if( v<lhs ){
  69854. res = pPKey2->r2;
  69855. }else if( pPKey2->nField>1 ){
  69856. /* The first fields of the two keys are equal. Compare the trailing
  69857. ** fields. */
  69858. res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
  69859. }else{
  69860. /* The first fields of the two keys are equal and there are no trailing
  69861. ** fields. Return pPKey2->default_rc in this case. */
  69862. res = pPKey2->default_rc;
  69863. pPKey2->eqSeen = 1;
  69864. }
  69865. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
  69866. return res;
  69867. }
  69868. /*
  69869. ** This function is an optimized version of sqlite3VdbeRecordCompare()
  69870. ** that (a) the first field of pPKey2 is a string, that (b) the first field
  69871. ** uses the collation sequence BINARY and (c) that the size-of-header varint
  69872. ** at the start of (pKey1/nKey1) fits in a single byte.
  69873. */
  69874. static int vdbeRecordCompareString(
  69875. int nKey1, const void *pKey1, /* Left key */
  69876. UnpackedRecord *pPKey2 /* Right key */
  69877. ){
  69878. const u8 *aKey1 = (const u8*)pKey1;
  69879. int serial_type;
  69880. int res;
  69881. assert( pPKey2->aMem[0].flags & MEM_Str );
  69882. vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
  69883. getVarint32(&aKey1[1], serial_type);
  69884. if( serial_type<12 ){
  69885. res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
  69886. }else if( !(serial_type & 0x01) ){
  69887. res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
  69888. }else{
  69889. int nCmp;
  69890. int nStr;
  69891. int szHdr = aKey1[0];
  69892. nStr = (serial_type-12) / 2;
  69893. if( (szHdr + nStr) > nKey1 ){
  69894. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  69895. return 0; /* Corruption */
  69896. }
  69897. nCmp = MIN( pPKey2->aMem[0].n, nStr );
  69898. res = memcmp(&aKey1[szHdr], pPKey2->aMem[0].z, nCmp);
  69899. if( res==0 ){
  69900. res = nStr - pPKey2->aMem[0].n;
  69901. if( res==0 ){
  69902. if( pPKey2->nField>1 ){
  69903. res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
  69904. }else{
  69905. res = pPKey2->default_rc;
  69906. pPKey2->eqSeen = 1;
  69907. }
  69908. }else if( res>0 ){
  69909. res = pPKey2->r2;
  69910. }else{
  69911. res = pPKey2->r1;
  69912. }
  69913. }else if( res>0 ){
  69914. res = pPKey2->r2;
  69915. }else{
  69916. res = pPKey2->r1;
  69917. }
  69918. }
  69919. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
  69920. || CORRUPT_DB
  69921. || pPKey2->pKeyInfo->db->mallocFailed
  69922. );
  69923. return res;
  69924. }
  69925. /*
  69926. ** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
  69927. ** suitable for comparing serialized records to the unpacked record passed
  69928. ** as the only argument.
  69929. */
  69930. SQLITE_PRIVATE RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
  69931. /* varintRecordCompareInt() and varintRecordCompareString() both assume
  69932. ** that the size-of-header varint that occurs at the start of each record
  69933. ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
  69934. ** also assumes that it is safe to overread a buffer by at least the
  69935. ** maximum possible legal header size plus 8 bytes. Because there is
  69936. ** guaranteed to be at least 74 (but not 136) bytes of padding following each
  69937. ** buffer passed to varintRecordCompareInt() this makes it convenient to
  69938. ** limit the size of the header to 64 bytes in cases where the first field
  69939. ** is an integer.
  69940. **
  69941. ** The easiest way to enforce this limit is to consider only records with
  69942. ** 13 fields or less. If the first field is an integer, the maximum legal
  69943. ** header size is (12*5 + 1 + 1) bytes. */
  69944. if( (p->pKeyInfo->nField + p->pKeyInfo->nXField)<=13 ){
  69945. int flags = p->aMem[0].flags;
  69946. if( p->pKeyInfo->aSortOrder[0] ){
  69947. p->r1 = 1;
  69948. p->r2 = -1;
  69949. }else{
  69950. p->r1 = -1;
  69951. p->r2 = 1;
  69952. }
  69953. if( (flags & MEM_Int) ){
  69954. return vdbeRecordCompareInt;
  69955. }
  69956. testcase( flags & MEM_Real );
  69957. testcase( flags & MEM_Null );
  69958. testcase( flags & MEM_Blob );
  69959. if( (flags & (MEM_Real|MEM_Null|MEM_Blob))==0 && p->pKeyInfo->aColl[0]==0 ){
  69960. assert( flags & MEM_Str );
  69961. return vdbeRecordCompareString;
  69962. }
  69963. }
  69964. return sqlite3VdbeRecordCompare;
  69965. }
  69966. /*
  69967. ** pCur points at an index entry created using the OP_MakeRecord opcode.
  69968. ** Read the rowid (the last field in the record) and store it in *rowid.
  69969. ** Return SQLITE_OK if everything works, or an error code otherwise.
  69970. **
  69971. ** pCur might be pointing to text obtained from a corrupt database file.
  69972. ** So the content cannot be trusted. Do appropriate checks on the content.
  69973. */
  69974. SQLITE_PRIVATE int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
  69975. i64 nCellKey = 0;
  69976. int rc;
  69977. u32 szHdr; /* Size of the header */
  69978. u32 typeRowid; /* Serial type of the rowid */
  69979. u32 lenRowid; /* Size of the rowid */
  69980. Mem m, v;
  69981. /* Get the size of the index entry. Only indices entries of less
  69982. ** than 2GiB are support - anything large must be database corruption.
  69983. ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
  69984. ** this code can safely assume that nCellKey is 32-bits
  69985. */
  69986. assert( sqlite3BtreeCursorIsValid(pCur) );
  69987. nCellKey = sqlite3BtreePayloadSize(pCur);
  69988. assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
  69989. /* Read in the complete content of the index entry */
  69990. sqlite3VdbeMemInit(&m, db, 0);
  69991. rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
  69992. if( rc ){
  69993. return rc;
  69994. }
  69995. /* The index entry must begin with a header size */
  69996. (void)getVarint32((u8*)m.z, szHdr);
  69997. testcase( szHdr==3 );
  69998. testcase( szHdr==m.n );
  69999. if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
  70000. goto idx_rowid_corruption;
  70001. }
  70002. /* The last field of the index should be an integer - the ROWID.
  70003. ** Verify that the last entry really is an integer. */
  70004. (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
  70005. testcase( typeRowid==1 );
  70006. testcase( typeRowid==2 );
  70007. testcase( typeRowid==3 );
  70008. testcase( typeRowid==4 );
  70009. testcase( typeRowid==5 );
  70010. testcase( typeRowid==6 );
  70011. testcase( typeRowid==8 );
  70012. testcase( typeRowid==9 );
  70013. if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
  70014. goto idx_rowid_corruption;
  70015. }
  70016. lenRowid = sqlite3SmallTypeSizes[typeRowid];
  70017. testcase( (u32)m.n==szHdr+lenRowid );
  70018. if( unlikely((u32)m.n<szHdr+lenRowid) ){
  70019. goto idx_rowid_corruption;
  70020. }
  70021. /* Fetch the integer off the end of the index record */
  70022. sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
  70023. *rowid = v.u.i;
  70024. sqlite3VdbeMemRelease(&m);
  70025. return SQLITE_OK;
  70026. /* Jump here if database corruption is detected after m has been
  70027. ** allocated. Free the m object and return SQLITE_CORRUPT. */
  70028. idx_rowid_corruption:
  70029. testcase( m.szMalloc!=0 );
  70030. sqlite3VdbeMemRelease(&m);
  70031. return SQLITE_CORRUPT_BKPT;
  70032. }
  70033. /*
  70034. ** Compare the key of the index entry that cursor pC is pointing to against
  70035. ** the key string in pUnpacked. Write into *pRes a number
  70036. ** that is negative, zero, or positive if pC is less than, equal to,
  70037. ** or greater than pUnpacked. Return SQLITE_OK on success.
  70038. **
  70039. ** pUnpacked is either created without a rowid or is truncated so that it
  70040. ** omits the rowid at the end. The rowid at the end of the index entry
  70041. ** is ignored as well. Hence, this routine only compares the prefixes
  70042. ** of the keys prior to the final rowid, not the entire key.
  70043. */
  70044. SQLITE_PRIVATE int sqlite3VdbeIdxKeyCompare(
  70045. sqlite3 *db, /* Database connection */
  70046. VdbeCursor *pC, /* The cursor to compare against */
  70047. UnpackedRecord *pUnpacked, /* Unpacked version of key */
  70048. int *res /* Write the comparison result here */
  70049. ){
  70050. i64 nCellKey = 0;
  70051. int rc;
  70052. BtCursor *pCur;
  70053. Mem m;
  70054. assert( pC->eCurType==CURTYPE_BTREE );
  70055. pCur = pC->uc.pCursor;
  70056. assert( sqlite3BtreeCursorIsValid(pCur) );
  70057. nCellKey = sqlite3BtreePayloadSize(pCur);
  70058. /* nCellKey will always be between 0 and 0xffffffff because of the way
  70059. ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
  70060. if( nCellKey<=0 || nCellKey>0x7fffffff ){
  70061. *res = 0;
  70062. return SQLITE_CORRUPT_BKPT;
  70063. }
  70064. sqlite3VdbeMemInit(&m, db, 0);
  70065. rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
  70066. if( rc ){
  70067. return rc;
  70068. }
  70069. *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
  70070. sqlite3VdbeMemRelease(&m);
  70071. return SQLITE_OK;
  70072. }
  70073. /*
  70074. ** This routine sets the value to be returned by subsequent calls to
  70075. ** sqlite3_changes() on the database handle 'db'.
  70076. */
  70077. SQLITE_PRIVATE void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
  70078. assert( sqlite3_mutex_held(db->mutex) );
  70079. db->nChange = nChange;
  70080. db->nTotalChange += nChange;
  70081. }
  70082. /*
  70083. ** Set a flag in the vdbe to update the change counter when it is finalised
  70084. ** or reset.
  70085. */
  70086. SQLITE_PRIVATE void sqlite3VdbeCountChanges(Vdbe *v){
  70087. v->changeCntOn = 1;
  70088. }
  70089. /*
  70090. ** Mark every prepared statement associated with a database connection
  70091. ** as expired.
  70092. **
  70093. ** An expired statement means that recompilation of the statement is
  70094. ** recommend. Statements expire when things happen that make their
  70095. ** programs obsolete. Removing user-defined functions or collating
  70096. ** sequences, or changing an authorization function are the types of
  70097. ** things that make prepared statements obsolete.
  70098. */
  70099. SQLITE_PRIVATE void sqlite3ExpirePreparedStatements(sqlite3 *db){
  70100. Vdbe *p;
  70101. for(p = db->pVdbe; p; p=p->pNext){
  70102. p->expired = 1;
  70103. }
  70104. }
  70105. /*
  70106. ** Return the database associated with the Vdbe.
  70107. */
  70108. SQLITE_PRIVATE sqlite3 *sqlite3VdbeDb(Vdbe *v){
  70109. return v->db;
  70110. }
  70111. /*
  70112. ** Return a pointer to an sqlite3_value structure containing the value bound
  70113. ** parameter iVar of VM v. Except, if the value is an SQL NULL, return
  70114. ** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
  70115. ** constants) to the value before returning it.
  70116. **
  70117. ** The returned value must be freed by the caller using sqlite3ValueFree().
  70118. */
  70119. SQLITE_PRIVATE sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
  70120. assert( iVar>0 );
  70121. if( v ){
  70122. Mem *pMem = &v->aVar[iVar-1];
  70123. if( 0==(pMem->flags & MEM_Null) ){
  70124. sqlite3_value *pRet = sqlite3ValueNew(v->db);
  70125. if( pRet ){
  70126. sqlite3VdbeMemCopy((Mem *)pRet, pMem);
  70127. sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
  70128. }
  70129. return pRet;
  70130. }
  70131. }
  70132. return 0;
  70133. }
  70134. /*
  70135. ** Configure SQL variable iVar so that binding a new value to it signals
  70136. ** to sqlite3_reoptimize() that re-preparing the statement may result
  70137. ** in a better query plan.
  70138. */
  70139. SQLITE_PRIVATE void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
  70140. assert( iVar>0 );
  70141. if( iVar>32 ){
  70142. v->expmask = 0xffffffff;
  70143. }else{
  70144. v->expmask |= ((u32)1 << (iVar-1));
  70145. }
  70146. }
  70147. #ifndef SQLITE_OMIT_VIRTUALTABLE
  70148. /*
  70149. ** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
  70150. ** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
  70151. ** in memory obtained from sqlite3DbMalloc).
  70152. */
  70153. SQLITE_PRIVATE void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
  70154. if( pVtab->zErrMsg ){
  70155. sqlite3 *db = p->db;
  70156. sqlite3DbFree(db, p->zErrMsg);
  70157. p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
  70158. sqlite3_free(pVtab->zErrMsg);
  70159. pVtab->zErrMsg = 0;
  70160. }
  70161. }
  70162. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  70163. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  70164. /*
  70165. ** If the second argument is not NULL, release any allocations associated
  70166. ** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
  70167. ** structure itself, using sqlite3DbFree().
  70168. **
  70169. ** This function is used to free UnpackedRecord structures allocated by
  70170. ** the vdbeUnpackRecord() function found in vdbeapi.c.
  70171. */
  70172. static void vdbeFreeUnpacked(sqlite3 *db, UnpackedRecord *p){
  70173. if( p ){
  70174. int i;
  70175. for(i=0; i<p->nField; i++){
  70176. Mem *pMem = &p->aMem[i];
  70177. if( pMem->zMalloc ) sqlite3VdbeMemRelease(pMem);
  70178. }
  70179. sqlite3DbFree(db, p);
  70180. }
  70181. }
  70182. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  70183. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  70184. /*
  70185. ** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
  70186. ** then cursor passed as the second argument should point to the row about
  70187. ** to be update or deleted. If the application calls sqlite3_preupdate_old(),
  70188. ** the required value will be read from the row the cursor points to.
  70189. */
  70190. SQLITE_PRIVATE void sqlite3VdbePreUpdateHook(
  70191. Vdbe *v, /* Vdbe pre-update hook is invoked by */
  70192. VdbeCursor *pCsr, /* Cursor to grab old.* values from */
  70193. int op, /* SQLITE_INSERT, UPDATE or DELETE */
  70194. const char *zDb, /* Database name */
  70195. Table *pTab, /* Modified table */
  70196. i64 iKey1, /* Initial key value */
  70197. int iReg /* Register for new.* record */
  70198. ){
  70199. sqlite3 *db = v->db;
  70200. i64 iKey2;
  70201. PreUpdate preupdate;
  70202. const char *zTbl = pTab->zName;
  70203. static const u8 fakeSortOrder = 0;
  70204. assert( db->pPreUpdate==0 );
  70205. memset(&preupdate, 0, sizeof(PreUpdate));
  70206. if( op==SQLITE_UPDATE ){
  70207. iKey2 = v->aMem[iReg].u.i;
  70208. }else{
  70209. iKey2 = iKey1;
  70210. }
  70211. assert( pCsr->nField==pTab->nCol
  70212. || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
  70213. );
  70214. preupdate.v = v;
  70215. preupdate.pCsr = pCsr;
  70216. preupdate.op = op;
  70217. preupdate.iNewReg = iReg;
  70218. preupdate.keyinfo.db = db;
  70219. preupdate.keyinfo.enc = ENC(db);
  70220. preupdate.keyinfo.nField = pTab->nCol;
  70221. preupdate.keyinfo.aSortOrder = (u8*)&fakeSortOrder;
  70222. preupdate.iKey1 = iKey1;
  70223. preupdate.iKey2 = iKey2;
  70224. preupdate.pTab = pTab;
  70225. db->pPreUpdate = &preupdate;
  70226. db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
  70227. db->pPreUpdate = 0;
  70228. sqlite3DbFree(db, preupdate.aRecord);
  70229. vdbeFreeUnpacked(db, preupdate.pUnpacked);
  70230. vdbeFreeUnpacked(db, preupdate.pNewUnpacked);
  70231. if( preupdate.aNew ){
  70232. int i;
  70233. for(i=0; i<pCsr->nField; i++){
  70234. sqlite3VdbeMemRelease(&preupdate.aNew[i]);
  70235. }
  70236. sqlite3DbFree(db, preupdate.aNew);
  70237. }
  70238. }
  70239. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  70240. /************** End of vdbeaux.c *********************************************/
  70241. /************** Begin file vdbeapi.c *****************************************/
  70242. /*
  70243. ** 2004 May 26
  70244. **
  70245. ** The author disclaims copyright to this source code. In place of
  70246. ** a legal notice, here is a blessing:
  70247. **
  70248. ** May you do good and not evil.
  70249. ** May you find forgiveness for yourself and forgive others.
  70250. ** May you share freely, never taking more than you give.
  70251. **
  70252. *************************************************************************
  70253. **
  70254. ** This file contains code use to implement APIs that are part of the
  70255. ** VDBE.
  70256. */
  70257. /* #include "sqliteInt.h" */
  70258. /* #include "vdbeInt.h" */
  70259. #ifndef SQLITE_OMIT_DEPRECATED
  70260. /*
  70261. ** Return TRUE (non-zero) of the statement supplied as an argument needs
  70262. ** to be recompiled. A statement needs to be recompiled whenever the
  70263. ** execution environment changes in a way that would alter the program
  70264. ** that sqlite3_prepare() generates. For example, if new functions or
  70265. ** collating sequences are registered or if an authorizer function is
  70266. ** added or changed.
  70267. */
  70268. SQLITE_API int sqlite3_expired(sqlite3_stmt *pStmt){
  70269. Vdbe *p = (Vdbe*)pStmt;
  70270. return p==0 || p->expired;
  70271. }
  70272. #endif
  70273. /*
  70274. ** Check on a Vdbe to make sure it has not been finalized. Log
  70275. ** an error and return true if it has been finalized (or is otherwise
  70276. ** invalid). Return false if it is ok.
  70277. */
  70278. static int vdbeSafety(Vdbe *p){
  70279. if( p->db==0 ){
  70280. sqlite3_log(SQLITE_MISUSE, "API called with finalized prepared statement");
  70281. return 1;
  70282. }else{
  70283. return 0;
  70284. }
  70285. }
  70286. static int vdbeSafetyNotNull(Vdbe *p){
  70287. if( p==0 ){
  70288. sqlite3_log(SQLITE_MISUSE, "API called with NULL prepared statement");
  70289. return 1;
  70290. }else{
  70291. return vdbeSafety(p);
  70292. }
  70293. }
  70294. #ifndef SQLITE_OMIT_TRACE
  70295. /*
  70296. ** Invoke the profile callback. This routine is only called if we already
  70297. ** know that the profile callback is defined and needs to be invoked.
  70298. */
  70299. static SQLITE_NOINLINE void invokeProfileCallback(sqlite3 *db, Vdbe *p){
  70300. sqlite3_int64 iNow;
  70301. sqlite3_int64 iElapse;
  70302. assert( p->startTime>0 );
  70303. assert( db->xProfile!=0 || (db->mTrace & SQLITE_TRACE_PROFILE)!=0 );
  70304. assert( db->init.busy==0 );
  70305. assert( p->zSql!=0 );
  70306. sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
  70307. iElapse = (iNow - p->startTime)*1000000;
  70308. if( db->xProfile ){
  70309. db->xProfile(db->pProfileArg, p->zSql, iElapse);
  70310. }
  70311. if( db->mTrace & SQLITE_TRACE_PROFILE ){
  70312. db->xTrace(SQLITE_TRACE_PROFILE, db->pTraceArg, p, (void*)&iElapse);
  70313. }
  70314. p->startTime = 0;
  70315. }
  70316. /*
  70317. ** The checkProfileCallback(DB,P) macro checks to see if a profile callback
  70318. ** is needed, and it invokes the callback if it is needed.
  70319. */
  70320. # define checkProfileCallback(DB,P) \
  70321. if( ((P)->startTime)>0 ){ invokeProfileCallback(DB,P); }
  70322. #else
  70323. # define checkProfileCallback(DB,P) /*no-op*/
  70324. #endif
  70325. /*
  70326. ** The following routine destroys a virtual machine that is created by
  70327. ** the sqlite3_compile() routine. The integer returned is an SQLITE_
  70328. ** success/failure code that describes the result of executing the virtual
  70329. ** machine.
  70330. **
  70331. ** This routine sets the error code and string returned by
  70332. ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
  70333. */
  70334. SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt){
  70335. int rc;
  70336. if( pStmt==0 ){
  70337. /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
  70338. ** pointer is a harmless no-op. */
  70339. rc = SQLITE_OK;
  70340. }else{
  70341. Vdbe *v = (Vdbe*)pStmt;
  70342. sqlite3 *db = v->db;
  70343. if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
  70344. sqlite3_mutex_enter(db->mutex);
  70345. checkProfileCallback(db, v);
  70346. rc = sqlite3VdbeFinalize(v);
  70347. rc = sqlite3ApiExit(db, rc);
  70348. sqlite3LeaveMutexAndCloseZombie(db);
  70349. }
  70350. return rc;
  70351. }
  70352. /*
  70353. ** Terminate the current execution of an SQL statement and reset it
  70354. ** back to its starting state so that it can be reused. A success code from
  70355. ** the prior execution is returned.
  70356. **
  70357. ** This routine sets the error code and string returned by
  70358. ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
  70359. */
  70360. SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt){
  70361. int rc;
  70362. if( pStmt==0 ){
  70363. rc = SQLITE_OK;
  70364. }else{
  70365. Vdbe *v = (Vdbe*)pStmt;
  70366. sqlite3 *db = v->db;
  70367. sqlite3_mutex_enter(db->mutex);
  70368. checkProfileCallback(db, v);
  70369. rc = sqlite3VdbeReset(v);
  70370. sqlite3VdbeRewind(v);
  70371. assert( (rc & (db->errMask))==rc );
  70372. rc = sqlite3ApiExit(db, rc);
  70373. sqlite3_mutex_leave(db->mutex);
  70374. }
  70375. return rc;
  70376. }
  70377. /*
  70378. ** Set all the parameters in the compiled SQL statement to NULL.
  70379. */
  70380. SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
  70381. int i;
  70382. int rc = SQLITE_OK;
  70383. Vdbe *p = (Vdbe*)pStmt;
  70384. #if SQLITE_THREADSAFE
  70385. sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
  70386. #endif
  70387. sqlite3_mutex_enter(mutex);
  70388. for(i=0; i<p->nVar; i++){
  70389. sqlite3VdbeMemRelease(&p->aVar[i]);
  70390. p->aVar[i].flags = MEM_Null;
  70391. }
  70392. if( p->isPrepareV2 && p->expmask ){
  70393. p->expired = 1;
  70394. }
  70395. sqlite3_mutex_leave(mutex);
  70396. return rc;
  70397. }
  70398. /**************************** sqlite3_value_ *******************************
  70399. ** The following routines extract information from a Mem or sqlite3_value
  70400. ** structure.
  70401. */
  70402. SQLITE_API const void *sqlite3_value_blob(sqlite3_value *pVal){
  70403. Mem *p = (Mem*)pVal;
  70404. if( p->flags & (MEM_Blob|MEM_Str) ){
  70405. if( ExpandBlob(p)!=SQLITE_OK ){
  70406. assert( p->flags==MEM_Null && p->z==0 );
  70407. return 0;
  70408. }
  70409. p->flags |= MEM_Blob;
  70410. return p->n ? p->z : 0;
  70411. }else{
  70412. return sqlite3_value_text(pVal);
  70413. }
  70414. }
  70415. SQLITE_API int sqlite3_value_bytes(sqlite3_value *pVal){
  70416. return sqlite3ValueBytes(pVal, SQLITE_UTF8);
  70417. }
  70418. SQLITE_API int sqlite3_value_bytes16(sqlite3_value *pVal){
  70419. return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
  70420. }
  70421. SQLITE_API double sqlite3_value_double(sqlite3_value *pVal){
  70422. return sqlite3VdbeRealValue((Mem*)pVal);
  70423. }
  70424. SQLITE_API int sqlite3_value_int(sqlite3_value *pVal){
  70425. return (int)sqlite3VdbeIntValue((Mem*)pVal);
  70426. }
  70427. SQLITE_API sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
  70428. return sqlite3VdbeIntValue((Mem*)pVal);
  70429. }
  70430. SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value *pVal){
  70431. Mem *pMem = (Mem*)pVal;
  70432. return ((pMem->flags & MEM_Subtype) ? pMem->eSubtype : 0);
  70433. }
  70434. SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
  70435. return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
  70436. }
  70437. #ifndef SQLITE_OMIT_UTF16
  70438. SQLITE_API const void *sqlite3_value_text16(sqlite3_value* pVal){
  70439. return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
  70440. }
  70441. SQLITE_API const void *sqlite3_value_text16be(sqlite3_value *pVal){
  70442. return sqlite3ValueText(pVal, SQLITE_UTF16BE);
  70443. }
  70444. SQLITE_API const void *sqlite3_value_text16le(sqlite3_value *pVal){
  70445. return sqlite3ValueText(pVal, SQLITE_UTF16LE);
  70446. }
  70447. #endif /* SQLITE_OMIT_UTF16 */
  70448. /* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
  70449. ** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
  70450. ** point number string BLOB NULL
  70451. */
  70452. SQLITE_API int sqlite3_value_type(sqlite3_value* pVal){
  70453. static const u8 aType[] = {
  70454. SQLITE_BLOB, /* 0x00 */
  70455. SQLITE_NULL, /* 0x01 */
  70456. SQLITE_TEXT, /* 0x02 */
  70457. SQLITE_NULL, /* 0x03 */
  70458. SQLITE_INTEGER, /* 0x04 */
  70459. SQLITE_NULL, /* 0x05 */
  70460. SQLITE_INTEGER, /* 0x06 */
  70461. SQLITE_NULL, /* 0x07 */
  70462. SQLITE_FLOAT, /* 0x08 */
  70463. SQLITE_NULL, /* 0x09 */
  70464. SQLITE_FLOAT, /* 0x0a */
  70465. SQLITE_NULL, /* 0x0b */
  70466. SQLITE_INTEGER, /* 0x0c */
  70467. SQLITE_NULL, /* 0x0d */
  70468. SQLITE_INTEGER, /* 0x0e */
  70469. SQLITE_NULL, /* 0x0f */
  70470. SQLITE_BLOB, /* 0x10 */
  70471. SQLITE_NULL, /* 0x11 */
  70472. SQLITE_TEXT, /* 0x12 */
  70473. SQLITE_NULL, /* 0x13 */
  70474. SQLITE_INTEGER, /* 0x14 */
  70475. SQLITE_NULL, /* 0x15 */
  70476. SQLITE_INTEGER, /* 0x16 */
  70477. SQLITE_NULL, /* 0x17 */
  70478. SQLITE_FLOAT, /* 0x18 */
  70479. SQLITE_NULL, /* 0x19 */
  70480. SQLITE_FLOAT, /* 0x1a */
  70481. SQLITE_NULL, /* 0x1b */
  70482. SQLITE_INTEGER, /* 0x1c */
  70483. SQLITE_NULL, /* 0x1d */
  70484. SQLITE_INTEGER, /* 0x1e */
  70485. SQLITE_NULL, /* 0x1f */
  70486. };
  70487. return aType[pVal->flags&MEM_AffMask];
  70488. }
  70489. /* Make a copy of an sqlite3_value object
  70490. */
  70491. SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
  70492. sqlite3_value *pNew;
  70493. if( pOrig==0 ) return 0;
  70494. pNew = sqlite3_malloc( sizeof(*pNew) );
  70495. if( pNew==0 ) return 0;
  70496. memset(pNew, 0, sizeof(*pNew));
  70497. memcpy(pNew, pOrig, MEMCELLSIZE);
  70498. pNew->flags &= ~MEM_Dyn;
  70499. pNew->db = 0;
  70500. if( pNew->flags&(MEM_Str|MEM_Blob) ){
  70501. pNew->flags &= ~(MEM_Static|MEM_Dyn);
  70502. pNew->flags |= MEM_Ephem;
  70503. if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
  70504. sqlite3ValueFree(pNew);
  70505. pNew = 0;
  70506. }
  70507. }
  70508. return pNew;
  70509. }
  70510. /* Destroy an sqlite3_value object previously obtained from
  70511. ** sqlite3_value_dup().
  70512. */
  70513. SQLITE_API void sqlite3_value_free(sqlite3_value *pOld){
  70514. sqlite3ValueFree(pOld);
  70515. }
  70516. /**************************** sqlite3_result_ *******************************
  70517. ** The following routines are used by user-defined functions to specify
  70518. ** the function result.
  70519. **
  70520. ** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
  70521. ** result as a string or blob but if the string or blob is too large, it
  70522. ** then sets the error code to SQLITE_TOOBIG
  70523. **
  70524. ** The invokeValueDestructor(P,X) routine invokes destructor function X()
  70525. ** on value P is not going to be used and need to be destroyed.
  70526. */
  70527. static void setResultStrOrError(
  70528. sqlite3_context *pCtx, /* Function context */
  70529. const char *z, /* String pointer */
  70530. int n, /* Bytes in string, or negative */
  70531. u8 enc, /* Encoding of z. 0 for BLOBs */
  70532. void (*xDel)(void*) /* Destructor function */
  70533. ){
  70534. if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
  70535. sqlite3_result_error_toobig(pCtx);
  70536. }
  70537. }
  70538. static int invokeValueDestructor(
  70539. const void *p, /* Value to destroy */
  70540. void (*xDel)(void*), /* The destructor */
  70541. sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
  70542. ){
  70543. assert( xDel!=SQLITE_DYNAMIC );
  70544. if( xDel==0 ){
  70545. /* noop */
  70546. }else if( xDel==SQLITE_TRANSIENT ){
  70547. /* noop */
  70548. }else{
  70549. xDel((void*)p);
  70550. }
  70551. if( pCtx ) sqlite3_result_error_toobig(pCtx);
  70552. return SQLITE_TOOBIG;
  70553. }
  70554. SQLITE_API void sqlite3_result_blob(
  70555. sqlite3_context *pCtx,
  70556. const void *z,
  70557. int n,
  70558. void (*xDel)(void *)
  70559. ){
  70560. assert( n>=0 );
  70561. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70562. setResultStrOrError(pCtx, z, n, 0, xDel);
  70563. }
  70564. SQLITE_API void sqlite3_result_blob64(
  70565. sqlite3_context *pCtx,
  70566. const void *z,
  70567. sqlite3_uint64 n,
  70568. void (*xDel)(void *)
  70569. ){
  70570. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70571. assert( xDel!=SQLITE_DYNAMIC );
  70572. if( n>0x7fffffff ){
  70573. (void)invokeValueDestructor(z, xDel, pCtx);
  70574. }else{
  70575. setResultStrOrError(pCtx, z, (int)n, 0, xDel);
  70576. }
  70577. }
  70578. SQLITE_API void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
  70579. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70580. sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
  70581. }
  70582. SQLITE_API void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
  70583. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70584. pCtx->isError = SQLITE_ERROR;
  70585. pCtx->fErrorOrAux = 1;
  70586. sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
  70587. }
  70588. #ifndef SQLITE_OMIT_UTF16
  70589. SQLITE_API void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
  70590. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70591. pCtx->isError = SQLITE_ERROR;
  70592. pCtx->fErrorOrAux = 1;
  70593. sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
  70594. }
  70595. #endif
  70596. SQLITE_API void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
  70597. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70598. sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
  70599. }
  70600. SQLITE_API void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
  70601. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70602. sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
  70603. }
  70604. SQLITE_API void sqlite3_result_null(sqlite3_context *pCtx){
  70605. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70606. sqlite3VdbeMemSetNull(pCtx->pOut);
  70607. }
  70608. SQLITE_API void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
  70609. Mem *pOut = pCtx->pOut;
  70610. assert( sqlite3_mutex_held(pOut->db->mutex) );
  70611. pOut->eSubtype = eSubtype & 0xff;
  70612. pOut->flags |= MEM_Subtype;
  70613. }
  70614. SQLITE_API void sqlite3_result_text(
  70615. sqlite3_context *pCtx,
  70616. const char *z,
  70617. int n,
  70618. void (*xDel)(void *)
  70619. ){
  70620. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70621. setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
  70622. }
  70623. SQLITE_API void sqlite3_result_text64(
  70624. sqlite3_context *pCtx,
  70625. const char *z,
  70626. sqlite3_uint64 n,
  70627. void (*xDel)(void *),
  70628. unsigned char enc
  70629. ){
  70630. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70631. assert( xDel!=SQLITE_DYNAMIC );
  70632. if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
  70633. if( n>0x7fffffff ){
  70634. (void)invokeValueDestructor(z, xDel, pCtx);
  70635. }else{
  70636. setResultStrOrError(pCtx, z, (int)n, enc, xDel);
  70637. }
  70638. }
  70639. #ifndef SQLITE_OMIT_UTF16
  70640. SQLITE_API void sqlite3_result_text16(
  70641. sqlite3_context *pCtx,
  70642. const void *z,
  70643. int n,
  70644. void (*xDel)(void *)
  70645. ){
  70646. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70647. setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
  70648. }
  70649. SQLITE_API void sqlite3_result_text16be(
  70650. sqlite3_context *pCtx,
  70651. const void *z,
  70652. int n,
  70653. void (*xDel)(void *)
  70654. ){
  70655. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70656. setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
  70657. }
  70658. SQLITE_API void sqlite3_result_text16le(
  70659. sqlite3_context *pCtx,
  70660. const void *z,
  70661. int n,
  70662. void (*xDel)(void *)
  70663. ){
  70664. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70665. setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
  70666. }
  70667. #endif /* SQLITE_OMIT_UTF16 */
  70668. SQLITE_API void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
  70669. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70670. sqlite3VdbeMemCopy(pCtx->pOut, pValue);
  70671. }
  70672. SQLITE_API void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
  70673. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70674. sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
  70675. }
  70676. SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
  70677. Mem *pOut = pCtx->pOut;
  70678. assert( sqlite3_mutex_held(pOut->db->mutex) );
  70679. if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
  70680. return SQLITE_TOOBIG;
  70681. }
  70682. sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
  70683. return SQLITE_OK;
  70684. }
  70685. SQLITE_API void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
  70686. pCtx->isError = errCode;
  70687. pCtx->fErrorOrAux = 1;
  70688. #ifdef SQLITE_DEBUG
  70689. if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
  70690. #endif
  70691. if( pCtx->pOut->flags & MEM_Null ){
  70692. sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
  70693. SQLITE_UTF8, SQLITE_STATIC);
  70694. }
  70695. }
  70696. /* Force an SQLITE_TOOBIG error. */
  70697. SQLITE_API void sqlite3_result_error_toobig(sqlite3_context *pCtx){
  70698. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70699. pCtx->isError = SQLITE_TOOBIG;
  70700. pCtx->fErrorOrAux = 1;
  70701. sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
  70702. SQLITE_UTF8, SQLITE_STATIC);
  70703. }
  70704. /* An SQLITE_NOMEM error. */
  70705. SQLITE_API void sqlite3_result_error_nomem(sqlite3_context *pCtx){
  70706. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  70707. sqlite3VdbeMemSetNull(pCtx->pOut);
  70708. pCtx->isError = SQLITE_NOMEM_BKPT;
  70709. pCtx->fErrorOrAux = 1;
  70710. sqlite3OomFault(pCtx->pOut->db);
  70711. }
  70712. /*
  70713. ** This function is called after a transaction has been committed. It
  70714. ** invokes callbacks registered with sqlite3_wal_hook() as required.
  70715. */
  70716. static int doWalCallbacks(sqlite3 *db){
  70717. int rc = SQLITE_OK;
  70718. #ifndef SQLITE_OMIT_WAL
  70719. int i;
  70720. for(i=0; i<db->nDb; i++){
  70721. Btree *pBt = db->aDb[i].pBt;
  70722. if( pBt ){
  70723. int nEntry;
  70724. sqlite3BtreeEnter(pBt);
  70725. nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
  70726. sqlite3BtreeLeave(pBt);
  70727. if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
  70728. rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
  70729. }
  70730. }
  70731. }
  70732. #endif
  70733. return rc;
  70734. }
  70735. /*
  70736. ** Execute the statement pStmt, either until a row of data is ready, the
  70737. ** statement is completely executed or an error occurs.
  70738. **
  70739. ** This routine implements the bulk of the logic behind the sqlite_step()
  70740. ** API. The only thing omitted is the automatic recompile if a
  70741. ** schema change has occurred. That detail is handled by the
  70742. ** outer sqlite3_step() wrapper procedure.
  70743. */
  70744. static int sqlite3Step(Vdbe *p){
  70745. sqlite3 *db;
  70746. int rc;
  70747. assert(p);
  70748. if( p->magic!=VDBE_MAGIC_RUN ){
  70749. /* We used to require that sqlite3_reset() be called before retrying
  70750. ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
  70751. ** with version 3.7.0, we changed this so that sqlite3_reset() would
  70752. ** be called automatically instead of throwing the SQLITE_MISUSE error.
  70753. ** This "automatic-reset" change is not technically an incompatibility,
  70754. ** since any application that receives an SQLITE_MISUSE is broken by
  70755. ** definition.
  70756. **
  70757. ** Nevertheless, some published applications that were originally written
  70758. ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
  70759. ** returns, and those were broken by the automatic-reset change. As a
  70760. ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
  70761. ** legacy behavior of returning SQLITE_MISUSE for cases where the
  70762. ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
  70763. ** or SQLITE_BUSY error.
  70764. */
  70765. #ifdef SQLITE_OMIT_AUTORESET
  70766. if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
  70767. sqlite3_reset((sqlite3_stmt*)p);
  70768. }else{
  70769. return SQLITE_MISUSE_BKPT;
  70770. }
  70771. #else
  70772. sqlite3_reset((sqlite3_stmt*)p);
  70773. #endif
  70774. }
  70775. /* Check that malloc() has not failed. If it has, return early. */
  70776. db = p->db;
  70777. if( db->mallocFailed ){
  70778. p->rc = SQLITE_NOMEM;
  70779. return SQLITE_NOMEM_BKPT;
  70780. }
  70781. if( p->pc<=0 && p->expired ){
  70782. p->rc = SQLITE_SCHEMA;
  70783. rc = SQLITE_ERROR;
  70784. goto end_of_step;
  70785. }
  70786. if( p->pc<0 ){
  70787. /* If there are no other statements currently running, then
  70788. ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
  70789. ** from interrupting a statement that has not yet started.
  70790. */
  70791. if( db->nVdbeActive==0 ){
  70792. db->u1.isInterrupted = 0;
  70793. }
  70794. assert( db->nVdbeWrite>0 || db->autoCommit==0
  70795. || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
  70796. );
  70797. #ifndef SQLITE_OMIT_TRACE
  70798. if( (db->xProfile || (db->mTrace & SQLITE_TRACE_PROFILE)!=0)
  70799. && !db->init.busy && p->zSql ){
  70800. sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
  70801. }else{
  70802. assert( p->startTime==0 );
  70803. }
  70804. #endif
  70805. db->nVdbeActive++;
  70806. if( p->readOnly==0 ) db->nVdbeWrite++;
  70807. if( p->bIsReader ) db->nVdbeRead++;
  70808. p->pc = 0;
  70809. }
  70810. #ifdef SQLITE_DEBUG
  70811. p->rcApp = SQLITE_OK;
  70812. #endif
  70813. #ifndef SQLITE_OMIT_EXPLAIN
  70814. if( p->explain ){
  70815. rc = sqlite3VdbeList(p);
  70816. }else
  70817. #endif /* SQLITE_OMIT_EXPLAIN */
  70818. {
  70819. db->nVdbeExec++;
  70820. rc = sqlite3VdbeExec(p);
  70821. db->nVdbeExec--;
  70822. }
  70823. #ifndef SQLITE_OMIT_TRACE
  70824. /* If the statement completed successfully, invoke the profile callback */
  70825. if( rc!=SQLITE_ROW ) checkProfileCallback(db, p);
  70826. #endif
  70827. if( rc==SQLITE_DONE ){
  70828. assert( p->rc==SQLITE_OK );
  70829. p->rc = doWalCallbacks(db);
  70830. if( p->rc!=SQLITE_OK ){
  70831. rc = SQLITE_ERROR;
  70832. }
  70833. }
  70834. db->errCode = rc;
  70835. if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
  70836. p->rc = SQLITE_NOMEM_BKPT;
  70837. }
  70838. end_of_step:
  70839. /* At this point local variable rc holds the value that should be
  70840. ** returned if this statement was compiled using the legacy
  70841. ** sqlite3_prepare() interface. According to the docs, this can only
  70842. ** be one of the values in the first assert() below. Variable p->rc
  70843. ** contains the value that would be returned if sqlite3_finalize()
  70844. ** were called on statement p.
  70845. */
  70846. assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
  70847. || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
  70848. );
  70849. assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
  70850. if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
  70851. /* If this statement was prepared using sqlite3_prepare_v2(), and an
  70852. ** error has occurred, then return the error code in p->rc to the
  70853. ** caller. Set the error code in the database handle to the same value.
  70854. */
  70855. rc = sqlite3VdbeTransferError(p);
  70856. }
  70857. return (rc&db->errMask);
  70858. }
  70859. /*
  70860. ** This is the top-level implementation of sqlite3_step(). Call
  70861. ** sqlite3Step() to do most of the work. If a schema error occurs,
  70862. ** call sqlite3Reprepare() and try again.
  70863. */
  70864. SQLITE_API int sqlite3_step(sqlite3_stmt *pStmt){
  70865. int rc = SQLITE_OK; /* Result from sqlite3Step() */
  70866. int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
  70867. Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
  70868. int cnt = 0; /* Counter to prevent infinite loop of reprepares */
  70869. sqlite3 *db; /* The database connection */
  70870. if( vdbeSafetyNotNull(v) ){
  70871. return SQLITE_MISUSE_BKPT;
  70872. }
  70873. db = v->db;
  70874. sqlite3_mutex_enter(db->mutex);
  70875. v->doingRerun = 0;
  70876. while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
  70877. && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
  70878. int savedPc = v->pc;
  70879. rc2 = rc = sqlite3Reprepare(v);
  70880. if( rc!=SQLITE_OK) break;
  70881. sqlite3_reset(pStmt);
  70882. if( savedPc>=0 ) v->doingRerun = 1;
  70883. assert( v->expired==0 );
  70884. }
  70885. if( rc2!=SQLITE_OK ){
  70886. /* This case occurs after failing to recompile an sql statement.
  70887. ** The error message from the SQL compiler has already been loaded
  70888. ** into the database handle. This block copies the error message
  70889. ** from the database handle into the statement and sets the statement
  70890. ** program counter to 0 to ensure that when the statement is
  70891. ** finalized or reset the parser error message is available via
  70892. ** sqlite3_errmsg() and sqlite3_errcode().
  70893. */
  70894. const char *zErr = (const char *)sqlite3_value_text(db->pErr);
  70895. sqlite3DbFree(db, v->zErrMsg);
  70896. if( !db->mallocFailed ){
  70897. v->zErrMsg = sqlite3DbStrDup(db, zErr);
  70898. v->rc = rc2;
  70899. } else {
  70900. v->zErrMsg = 0;
  70901. v->rc = rc = SQLITE_NOMEM_BKPT;
  70902. }
  70903. }
  70904. rc = sqlite3ApiExit(db, rc);
  70905. sqlite3_mutex_leave(db->mutex);
  70906. return rc;
  70907. }
  70908. /*
  70909. ** Extract the user data from a sqlite3_context structure and return a
  70910. ** pointer to it.
  70911. */
  70912. SQLITE_API void *sqlite3_user_data(sqlite3_context *p){
  70913. assert( p && p->pFunc );
  70914. return p->pFunc->pUserData;
  70915. }
  70916. /*
  70917. ** Extract the user data from a sqlite3_context structure and return a
  70918. ** pointer to it.
  70919. **
  70920. ** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
  70921. ** returns a copy of the pointer to the database connection (the 1st
  70922. ** parameter) of the sqlite3_create_function() and
  70923. ** sqlite3_create_function16() routines that originally registered the
  70924. ** application defined function.
  70925. */
  70926. SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
  70927. assert( p && p->pOut );
  70928. return p->pOut->db;
  70929. }
  70930. /*
  70931. ** Return the current time for a statement. If the current time
  70932. ** is requested more than once within the same run of a single prepared
  70933. ** statement, the exact same time is returned for each invocation regardless
  70934. ** of the amount of time that elapses between invocations. In other words,
  70935. ** the time returned is always the time of the first call.
  70936. */
  70937. SQLITE_PRIVATE sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
  70938. int rc;
  70939. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  70940. sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
  70941. assert( p->pVdbe!=0 );
  70942. #else
  70943. sqlite3_int64 iTime = 0;
  70944. sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
  70945. #endif
  70946. if( *piTime==0 ){
  70947. rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
  70948. if( rc ) *piTime = 0;
  70949. }
  70950. return *piTime;
  70951. }
  70952. /*
  70953. ** The following is the implementation of an SQL function that always
  70954. ** fails with an error message stating that the function is used in the
  70955. ** wrong context. The sqlite3_overload_function() API might construct
  70956. ** SQL function that use this routine so that the functions will exist
  70957. ** for name resolution but are actually overloaded by the xFindFunction
  70958. ** method of virtual tables.
  70959. */
  70960. SQLITE_PRIVATE void sqlite3InvalidFunction(
  70961. sqlite3_context *context, /* The function calling context */
  70962. int NotUsed, /* Number of arguments to the function */
  70963. sqlite3_value **NotUsed2 /* Value of each argument */
  70964. ){
  70965. const char *zName = context->pFunc->zName;
  70966. char *zErr;
  70967. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  70968. zErr = sqlite3_mprintf(
  70969. "unable to use function %s in the requested context", zName);
  70970. sqlite3_result_error(context, zErr, -1);
  70971. sqlite3_free(zErr);
  70972. }
  70973. /*
  70974. ** Create a new aggregate context for p and return a pointer to
  70975. ** its pMem->z element.
  70976. */
  70977. static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
  70978. Mem *pMem = p->pMem;
  70979. assert( (pMem->flags & MEM_Agg)==0 );
  70980. if( nByte<=0 ){
  70981. sqlite3VdbeMemSetNull(pMem);
  70982. pMem->z = 0;
  70983. }else{
  70984. sqlite3VdbeMemClearAndResize(pMem, nByte);
  70985. pMem->flags = MEM_Agg;
  70986. pMem->u.pDef = p->pFunc;
  70987. if( pMem->z ){
  70988. memset(pMem->z, 0, nByte);
  70989. }
  70990. }
  70991. return (void*)pMem->z;
  70992. }
  70993. /*
  70994. ** Allocate or return the aggregate context for a user function. A new
  70995. ** context is allocated on the first call. Subsequent calls return the
  70996. ** same context that was returned on prior calls.
  70997. */
  70998. SQLITE_API void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
  70999. assert( p && p->pFunc && p->pFunc->xFinalize );
  71000. assert( sqlite3_mutex_held(p->pOut->db->mutex) );
  71001. testcase( nByte<0 );
  71002. if( (p->pMem->flags & MEM_Agg)==0 ){
  71003. return createAggContext(p, nByte);
  71004. }else{
  71005. return (void*)p->pMem->z;
  71006. }
  71007. }
  71008. /*
  71009. ** Return the auxiliary data pointer, if any, for the iArg'th argument to
  71010. ** the user-function defined by pCtx.
  71011. */
  71012. SQLITE_API void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
  71013. AuxData *pAuxData;
  71014. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  71015. #if SQLITE_ENABLE_STAT3_OR_STAT4
  71016. if( pCtx->pVdbe==0 ) return 0;
  71017. #else
  71018. assert( pCtx->pVdbe!=0 );
  71019. #endif
  71020. for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
  71021. if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
  71022. }
  71023. return (pAuxData ? pAuxData->pAux : 0);
  71024. }
  71025. /*
  71026. ** Set the auxiliary data pointer and delete function, for the iArg'th
  71027. ** argument to the user-function defined by pCtx. Any previous value is
  71028. ** deleted by calling the delete function specified when it was set.
  71029. */
  71030. SQLITE_API void sqlite3_set_auxdata(
  71031. sqlite3_context *pCtx,
  71032. int iArg,
  71033. void *pAux,
  71034. void (*xDelete)(void*)
  71035. ){
  71036. AuxData *pAuxData;
  71037. Vdbe *pVdbe = pCtx->pVdbe;
  71038. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  71039. if( iArg<0 ) goto failed;
  71040. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  71041. if( pVdbe==0 ) goto failed;
  71042. #else
  71043. assert( pVdbe!=0 );
  71044. #endif
  71045. for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
  71046. if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
  71047. }
  71048. if( pAuxData==0 ){
  71049. pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
  71050. if( !pAuxData ) goto failed;
  71051. pAuxData->iOp = pCtx->iOp;
  71052. pAuxData->iArg = iArg;
  71053. pAuxData->pNext = pVdbe->pAuxData;
  71054. pVdbe->pAuxData = pAuxData;
  71055. if( pCtx->fErrorOrAux==0 ){
  71056. pCtx->isError = 0;
  71057. pCtx->fErrorOrAux = 1;
  71058. }
  71059. }else if( pAuxData->xDelete ){
  71060. pAuxData->xDelete(pAuxData->pAux);
  71061. }
  71062. pAuxData->pAux = pAux;
  71063. pAuxData->xDelete = xDelete;
  71064. return;
  71065. failed:
  71066. if( xDelete ){
  71067. xDelete(pAux);
  71068. }
  71069. }
  71070. #ifndef SQLITE_OMIT_DEPRECATED
  71071. /*
  71072. ** Return the number of times the Step function of an aggregate has been
  71073. ** called.
  71074. **
  71075. ** This function is deprecated. Do not use it for new code. It is
  71076. ** provide only to avoid breaking legacy code. New aggregate function
  71077. ** implementations should keep their own counts within their aggregate
  71078. ** context.
  71079. */
  71080. SQLITE_API int sqlite3_aggregate_count(sqlite3_context *p){
  71081. assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
  71082. return p->pMem->n;
  71083. }
  71084. #endif
  71085. /*
  71086. ** Return the number of columns in the result set for the statement pStmt.
  71087. */
  71088. SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt){
  71089. Vdbe *pVm = (Vdbe *)pStmt;
  71090. return pVm ? pVm->nResColumn : 0;
  71091. }
  71092. /*
  71093. ** Return the number of values available from the current row of the
  71094. ** currently executing statement pStmt.
  71095. */
  71096. SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt){
  71097. Vdbe *pVm = (Vdbe *)pStmt;
  71098. if( pVm==0 || pVm->pResultSet==0 ) return 0;
  71099. return pVm->nResColumn;
  71100. }
  71101. /*
  71102. ** Return a pointer to static memory containing an SQL NULL value.
  71103. */
  71104. static const Mem *columnNullValue(void){
  71105. /* Even though the Mem structure contains an element
  71106. ** of type i64, on certain architectures (x86) with certain compiler
  71107. ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
  71108. ** instead of an 8-byte one. This all works fine, except that when
  71109. ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
  71110. ** that a Mem structure is located on an 8-byte boundary. To prevent
  71111. ** these assert()s from failing, when building with SQLITE_DEBUG defined
  71112. ** using gcc, we force nullMem to be 8-byte aligned using the magical
  71113. ** __attribute__((aligned(8))) macro. */
  71114. static const Mem nullMem
  71115. #if defined(SQLITE_DEBUG) && defined(__GNUC__)
  71116. __attribute__((aligned(8)))
  71117. #endif
  71118. = {
  71119. /* .u = */ {0},
  71120. /* .flags = */ (u16)MEM_Null,
  71121. /* .enc = */ (u8)0,
  71122. /* .eSubtype = */ (u8)0,
  71123. /* .n = */ (int)0,
  71124. /* .z = */ (char*)0,
  71125. /* .zMalloc = */ (char*)0,
  71126. /* .szMalloc = */ (int)0,
  71127. /* .uTemp = */ (u32)0,
  71128. /* .db = */ (sqlite3*)0,
  71129. /* .xDel = */ (void(*)(void*))0,
  71130. #ifdef SQLITE_DEBUG
  71131. /* .pScopyFrom = */ (Mem*)0,
  71132. /* .pFiller = */ (void*)0,
  71133. #endif
  71134. };
  71135. return &nullMem;
  71136. }
  71137. /*
  71138. ** Check to see if column iCol of the given statement is valid. If
  71139. ** it is, return a pointer to the Mem for the value of that column.
  71140. ** If iCol is not valid, return a pointer to a Mem which has a value
  71141. ** of NULL.
  71142. */
  71143. static Mem *columnMem(sqlite3_stmt *pStmt, int i){
  71144. Vdbe *pVm;
  71145. Mem *pOut;
  71146. pVm = (Vdbe *)pStmt;
  71147. if( pVm==0 ) return (Mem*)columnNullValue();
  71148. assert( pVm->db );
  71149. sqlite3_mutex_enter(pVm->db->mutex);
  71150. if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
  71151. pOut = &pVm->pResultSet[i];
  71152. }else{
  71153. sqlite3Error(pVm->db, SQLITE_RANGE);
  71154. pOut = (Mem*)columnNullValue();
  71155. }
  71156. return pOut;
  71157. }
  71158. /*
  71159. ** This function is called after invoking an sqlite3_value_XXX function on a
  71160. ** column value (i.e. a value returned by evaluating an SQL expression in the
  71161. ** select list of a SELECT statement) that may cause a malloc() failure. If
  71162. ** malloc() has failed, the threads mallocFailed flag is cleared and the result
  71163. ** code of statement pStmt set to SQLITE_NOMEM.
  71164. **
  71165. ** Specifically, this is called from within:
  71166. **
  71167. ** sqlite3_column_int()
  71168. ** sqlite3_column_int64()
  71169. ** sqlite3_column_text()
  71170. ** sqlite3_column_text16()
  71171. ** sqlite3_column_real()
  71172. ** sqlite3_column_bytes()
  71173. ** sqlite3_column_bytes16()
  71174. ** sqiite3_column_blob()
  71175. */
  71176. static void columnMallocFailure(sqlite3_stmt *pStmt)
  71177. {
  71178. /* If malloc() failed during an encoding conversion within an
  71179. ** sqlite3_column_XXX API, then set the return code of the statement to
  71180. ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
  71181. ** and _finalize() will return NOMEM.
  71182. */
  71183. Vdbe *p = (Vdbe *)pStmt;
  71184. if( p ){
  71185. assert( p->db!=0 );
  71186. assert( sqlite3_mutex_held(p->db->mutex) );
  71187. p->rc = sqlite3ApiExit(p->db, p->rc);
  71188. sqlite3_mutex_leave(p->db->mutex);
  71189. }
  71190. }
  71191. /**************************** sqlite3_column_ *******************************
  71192. ** The following routines are used to access elements of the current row
  71193. ** in the result set.
  71194. */
  71195. SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
  71196. const void *val;
  71197. val = sqlite3_value_blob( columnMem(pStmt,i) );
  71198. /* Even though there is no encoding conversion, value_blob() might
  71199. ** need to call malloc() to expand the result of a zeroblob()
  71200. ** expression.
  71201. */
  71202. columnMallocFailure(pStmt);
  71203. return val;
  71204. }
  71205. SQLITE_API int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
  71206. int val = sqlite3_value_bytes( columnMem(pStmt,i) );
  71207. columnMallocFailure(pStmt);
  71208. return val;
  71209. }
  71210. SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
  71211. int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
  71212. columnMallocFailure(pStmt);
  71213. return val;
  71214. }
  71215. SQLITE_API double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
  71216. double val = sqlite3_value_double( columnMem(pStmt,i) );
  71217. columnMallocFailure(pStmt);
  71218. return val;
  71219. }
  71220. SQLITE_API int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
  71221. int val = sqlite3_value_int( columnMem(pStmt,i) );
  71222. columnMallocFailure(pStmt);
  71223. return val;
  71224. }
  71225. SQLITE_API sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
  71226. sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
  71227. columnMallocFailure(pStmt);
  71228. return val;
  71229. }
  71230. SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
  71231. const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
  71232. columnMallocFailure(pStmt);
  71233. return val;
  71234. }
  71235. SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
  71236. Mem *pOut = columnMem(pStmt, i);
  71237. if( pOut->flags&MEM_Static ){
  71238. pOut->flags &= ~MEM_Static;
  71239. pOut->flags |= MEM_Ephem;
  71240. }
  71241. columnMallocFailure(pStmt);
  71242. return (sqlite3_value *)pOut;
  71243. }
  71244. #ifndef SQLITE_OMIT_UTF16
  71245. SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
  71246. const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
  71247. columnMallocFailure(pStmt);
  71248. return val;
  71249. }
  71250. #endif /* SQLITE_OMIT_UTF16 */
  71251. SQLITE_API int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
  71252. int iType = sqlite3_value_type( columnMem(pStmt,i) );
  71253. columnMallocFailure(pStmt);
  71254. return iType;
  71255. }
  71256. /*
  71257. ** Convert the N-th element of pStmt->pColName[] into a string using
  71258. ** xFunc() then return that string. If N is out of range, return 0.
  71259. **
  71260. ** There are up to 5 names for each column. useType determines which
  71261. ** name is returned. Here are the names:
  71262. **
  71263. ** 0 The column name as it should be displayed for output
  71264. ** 1 The datatype name for the column
  71265. ** 2 The name of the database that the column derives from
  71266. ** 3 The name of the table that the column derives from
  71267. ** 4 The name of the table column that the result column derives from
  71268. **
  71269. ** If the result is not a simple column reference (if it is an expression
  71270. ** or a constant) then useTypes 2, 3, and 4 return NULL.
  71271. */
  71272. static const void *columnName(
  71273. sqlite3_stmt *pStmt,
  71274. int N,
  71275. const void *(*xFunc)(Mem*),
  71276. int useType
  71277. ){
  71278. const void *ret;
  71279. Vdbe *p;
  71280. int n;
  71281. sqlite3 *db;
  71282. #ifdef SQLITE_ENABLE_API_ARMOR
  71283. if( pStmt==0 ){
  71284. (void)SQLITE_MISUSE_BKPT;
  71285. return 0;
  71286. }
  71287. #endif
  71288. ret = 0;
  71289. p = (Vdbe *)pStmt;
  71290. db = p->db;
  71291. assert( db!=0 );
  71292. n = sqlite3_column_count(pStmt);
  71293. if( N<n && N>=0 ){
  71294. N += useType*n;
  71295. sqlite3_mutex_enter(db->mutex);
  71296. assert( db->mallocFailed==0 );
  71297. ret = xFunc(&p->aColName[N]);
  71298. /* A malloc may have failed inside of the xFunc() call. If this
  71299. ** is the case, clear the mallocFailed flag and return NULL.
  71300. */
  71301. if( db->mallocFailed ){
  71302. sqlite3OomClear(db);
  71303. ret = 0;
  71304. }
  71305. sqlite3_mutex_leave(db->mutex);
  71306. }
  71307. return ret;
  71308. }
  71309. /*
  71310. ** Return the name of the Nth column of the result set returned by SQL
  71311. ** statement pStmt.
  71312. */
  71313. SQLITE_API const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
  71314. return columnName(
  71315. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
  71316. }
  71317. #ifndef SQLITE_OMIT_UTF16
  71318. SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
  71319. return columnName(
  71320. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
  71321. }
  71322. #endif
  71323. /*
  71324. ** Constraint: If you have ENABLE_COLUMN_METADATA then you must
  71325. ** not define OMIT_DECLTYPE.
  71326. */
  71327. #if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
  71328. # error "Must not define both SQLITE_OMIT_DECLTYPE \
  71329. and SQLITE_ENABLE_COLUMN_METADATA"
  71330. #endif
  71331. #ifndef SQLITE_OMIT_DECLTYPE
  71332. /*
  71333. ** Return the column declaration type (if applicable) of the 'i'th column
  71334. ** of the result set of SQL statement pStmt.
  71335. */
  71336. SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
  71337. return columnName(
  71338. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
  71339. }
  71340. #ifndef SQLITE_OMIT_UTF16
  71341. SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
  71342. return columnName(
  71343. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
  71344. }
  71345. #endif /* SQLITE_OMIT_UTF16 */
  71346. #endif /* SQLITE_OMIT_DECLTYPE */
  71347. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  71348. /*
  71349. ** Return the name of the database from which a result column derives.
  71350. ** NULL is returned if the result column is an expression or constant or
  71351. ** anything else which is not an unambiguous reference to a database column.
  71352. */
  71353. SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
  71354. return columnName(
  71355. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
  71356. }
  71357. #ifndef SQLITE_OMIT_UTF16
  71358. SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
  71359. return columnName(
  71360. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
  71361. }
  71362. #endif /* SQLITE_OMIT_UTF16 */
  71363. /*
  71364. ** Return the name of the table from which a result column derives.
  71365. ** NULL is returned if the result column is an expression or constant or
  71366. ** anything else which is not an unambiguous reference to a database column.
  71367. */
  71368. SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
  71369. return columnName(
  71370. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
  71371. }
  71372. #ifndef SQLITE_OMIT_UTF16
  71373. SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
  71374. return columnName(
  71375. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
  71376. }
  71377. #endif /* SQLITE_OMIT_UTF16 */
  71378. /*
  71379. ** Return the name of the table column from which a result column derives.
  71380. ** NULL is returned if the result column is an expression or constant or
  71381. ** anything else which is not an unambiguous reference to a database column.
  71382. */
  71383. SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
  71384. return columnName(
  71385. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
  71386. }
  71387. #ifndef SQLITE_OMIT_UTF16
  71388. SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
  71389. return columnName(
  71390. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
  71391. }
  71392. #endif /* SQLITE_OMIT_UTF16 */
  71393. #endif /* SQLITE_ENABLE_COLUMN_METADATA */
  71394. /******************************* sqlite3_bind_ ***************************
  71395. **
  71396. ** Routines used to attach values to wildcards in a compiled SQL statement.
  71397. */
  71398. /*
  71399. ** Unbind the value bound to variable i in virtual machine p. This is the
  71400. ** the same as binding a NULL value to the column. If the "i" parameter is
  71401. ** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
  71402. **
  71403. ** A successful evaluation of this routine acquires the mutex on p.
  71404. ** the mutex is released if any kind of error occurs.
  71405. **
  71406. ** The error code stored in database p->db is overwritten with the return
  71407. ** value in any case.
  71408. */
  71409. static int vdbeUnbind(Vdbe *p, int i){
  71410. Mem *pVar;
  71411. if( vdbeSafetyNotNull(p) ){
  71412. return SQLITE_MISUSE_BKPT;
  71413. }
  71414. sqlite3_mutex_enter(p->db->mutex);
  71415. if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
  71416. sqlite3Error(p->db, SQLITE_MISUSE);
  71417. sqlite3_mutex_leave(p->db->mutex);
  71418. sqlite3_log(SQLITE_MISUSE,
  71419. "bind on a busy prepared statement: [%s]", p->zSql);
  71420. return SQLITE_MISUSE_BKPT;
  71421. }
  71422. if( i<1 || i>p->nVar ){
  71423. sqlite3Error(p->db, SQLITE_RANGE);
  71424. sqlite3_mutex_leave(p->db->mutex);
  71425. return SQLITE_RANGE;
  71426. }
  71427. i--;
  71428. pVar = &p->aVar[i];
  71429. sqlite3VdbeMemRelease(pVar);
  71430. pVar->flags = MEM_Null;
  71431. sqlite3Error(p->db, SQLITE_OK);
  71432. /* If the bit corresponding to this variable in Vdbe.expmask is set, then
  71433. ** binding a new value to this variable invalidates the current query plan.
  71434. **
  71435. ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
  71436. ** parameter in the WHERE clause might influence the choice of query plan
  71437. ** for a statement, then the statement will be automatically recompiled,
  71438. ** as if there had been a schema change, on the first sqlite3_step() call
  71439. ** following any change to the bindings of that parameter.
  71440. */
  71441. if( p->isPrepareV2 &&
  71442. ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
  71443. ){
  71444. p->expired = 1;
  71445. }
  71446. return SQLITE_OK;
  71447. }
  71448. /*
  71449. ** Bind a text or BLOB value.
  71450. */
  71451. static int bindText(
  71452. sqlite3_stmt *pStmt, /* The statement to bind against */
  71453. int i, /* Index of the parameter to bind */
  71454. const void *zData, /* Pointer to the data to be bound */
  71455. int nData, /* Number of bytes of data to be bound */
  71456. void (*xDel)(void*), /* Destructor for the data */
  71457. u8 encoding /* Encoding for the data */
  71458. ){
  71459. Vdbe *p = (Vdbe *)pStmt;
  71460. Mem *pVar;
  71461. int rc;
  71462. rc = vdbeUnbind(p, i);
  71463. if( rc==SQLITE_OK ){
  71464. if( zData!=0 ){
  71465. pVar = &p->aVar[i-1];
  71466. rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
  71467. if( rc==SQLITE_OK && encoding!=0 ){
  71468. rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
  71469. }
  71470. sqlite3Error(p->db, rc);
  71471. rc = sqlite3ApiExit(p->db, rc);
  71472. }
  71473. sqlite3_mutex_leave(p->db->mutex);
  71474. }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
  71475. xDel((void*)zData);
  71476. }
  71477. return rc;
  71478. }
  71479. /*
  71480. ** Bind a blob value to an SQL statement variable.
  71481. */
  71482. SQLITE_API int sqlite3_bind_blob(
  71483. sqlite3_stmt *pStmt,
  71484. int i,
  71485. const void *zData,
  71486. int nData,
  71487. void (*xDel)(void*)
  71488. ){
  71489. #ifdef SQLITE_ENABLE_API_ARMOR
  71490. if( nData<0 ) return SQLITE_MISUSE_BKPT;
  71491. #endif
  71492. return bindText(pStmt, i, zData, nData, xDel, 0);
  71493. }
  71494. SQLITE_API int sqlite3_bind_blob64(
  71495. sqlite3_stmt *pStmt,
  71496. int i,
  71497. const void *zData,
  71498. sqlite3_uint64 nData,
  71499. void (*xDel)(void*)
  71500. ){
  71501. assert( xDel!=SQLITE_DYNAMIC );
  71502. if( nData>0x7fffffff ){
  71503. return invokeValueDestructor(zData, xDel, 0);
  71504. }else{
  71505. return bindText(pStmt, i, zData, (int)nData, xDel, 0);
  71506. }
  71507. }
  71508. SQLITE_API int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
  71509. int rc;
  71510. Vdbe *p = (Vdbe *)pStmt;
  71511. rc = vdbeUnbind(p, i);
  71512. if( rc==SQLITE_OK ){
  71513. sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
  71514. sqlite3_mutex_leave(p->db->mutex);
  71515. }
  71516. return rc;
  71517. }
  71518. SQLITE_API int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
  71519. return sqlite3_bind_int64(p, i, (i64)iValue);
  71520. }
  71521. SQLITE_API int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
  71522. int rc;
  71523. Vdbe *p = (Vdbe *)pStmt;
  71524. rc = vdbeUnbind(p, i);
  71525. if( rc==SQLITE_OK ){
  71526. sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
  71527. sqlite3_mutex_leave(p->db->mutex);
  71528. }
  71529. return rc;
  71530. }
  71531. SQLITE_API int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
  71532. int rc;
  71533. Vdbe *p = (Vdbe*)pStmt;
  71534. rc = vdbeUnbind(p, i);
  71535. if( rc==SQLITE_OK ){
  71536. sqlite3_mutex_leave(p->db->mutex);
  71537. }
  71538. return rc;
  71539. }
  71540. SQLITE_API int sqlite3_bind_text(
  71541. sqlite3_stmt *pStmt,
  71542. int i,
  71543. const char *zData,
  71544. int nData,
  71545. void (*xDel)(void*)
  71546. ){
  71547. return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
  71548. }
  71549. SQLITE_API int sqlite3_bind_text64(
  71550. sqlite3_stmt *pStmt,
  71551. int i,
  71552. const char *zData,
  71553. sqlite3_uint64 nData,
  71554. void (*xDel)(void*),
  71555. unsigned char enc
  71556. ){
  71557. assert( xDel!=SQLITE_DYNAMIC );
  71558. if( nData>0x7fffffff ){
  71559. return invokeValueDestructor(zData, xDel, 0);
  71560. }else{
  71561. if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
  71562. return bindText(pStmt, i, zData, (int)nData, xDel, enc);
  71563. }
  71564. }
  71565. #ifndef SQLITE_OMIT_UTF16
  71566. SQLITE_API int sqlite3_bind_text16(
  71567. sqlite3_stmt *pStmt,
  71568. int i,
  71569. const void *zData,
  71570. int nData,
  71571. void (*xDel)(void*)
  71572. ){
  71573. return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
  71574. }
  71575. #endif /* SQLITE_OMIT_UTF16 */
  71576. SQLITE_API int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
  71577. int rc;
  71578. switch( sqlite3_value_type((sqlite3_value*)pValue) ){
  71579. case SQLITE_INTEGER: {
  71580. rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
  71581. break;
  71582. }
  71583. case SQLITE_FLOAT: {
  71584. rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
  71585. break;
  71586. }
  71587. case SQLITE_BLOB: {
  71588. if( pValue->flags & MEM_Zero ){
  71589. rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
  71590. }else{
  71591. rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
  71592. }
  71593. break;
  71594. }
  71595. case SQLITE_TEXT: {
  71596. rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
  71597. pValue->enc);
  71598. break;
  71599. }
  71600. default: {
  71601. rc = sqlite3_bind_null(pStmt, i);
  71602. break;
  71603. }
  71604. }
  71605. return rc;
  71606. }
  71607. SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
  71608. int rc;
  71609. Vdbe *p = (Vdbe *)pStmt;
  71610. rc = vdbeUnbind(p, i);
  71611. if( rc==SQLITE_OK ){
  71612. sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
  71613. sqlite3_mutex_leave(p->db->mutex);
  71614. }
  71615. return rc;
  71616. }
  71617. SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
  71618. int rc;
  71619. Vdbe *p = (Vdbe *)pStmt;
  71620. sqlite3_mutex_enter(p->db->mutex);
  71621. if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
  71622. rc = SQLITE_TOOBIG;
  71623. }else{
  71624. assert( (n & 0x7FFFFFFF)==n );
  71625. rc = sqlite3_bind_zeroblob(pStmt, i, n);
  71626. }
  71627. rc = sqlite3ApiExit(p->db, rc);
  71628. sqlite3_mutex_leave(p->db->mutex);
  71629. return rc;
  71630. }
  71631. /*
  71632. ** Return the number of wildcards that can be potentially bound to.
  71633. ** This routine is added to support DBD::SQLite.
  71634. */
  71635. SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
  71636. Vdbe *p = (Vdbe*)pStmt;
  71637. return p ? p->nVar : 0;
  71638. }
  71639. /*
  71640. ** Return the name of a wildcard parameter. Return NULL if the index
  71641. ** is out of range or if the wildcard is unnamed.
  71642. **
  71643. ** The result is always UTF-8.
  71644. */
  71645. SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
  71646. Vdbe *p = (Vdbe*)pStmt;
  71647. if( p==0 || i<1 || i>p->nzVar ){
  71648. return 0;
  71649. }
  71650. return p->azVar[i-1];
  71651. }
  71652. /*
  71653. ** Given a wildcard parameter name, return the index of the variable
  71654. ** with that name. If there is no variable with the given name,
  71655. ** return 0.
  71656. */
  71657. SQLITE_PRIVATE int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
  71658. int i;
  71659. if( p==0 ){
  71660. return 0;
  71661. }
  71662. if( zName ){
  71663. for(i=0; i<p->nzVar; i++){
  71664. const char *z = p->azVar[i];
  71665. if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
  71666. return i+1;
  71667. }
  71668. }
  71669. }
  71670. return 0;
  71671. }
  71672. SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
  71673. return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
  71674. }
  71675. /*
  71676. ** Transfer all bindings from the first statement over to the second.
  71677. */
  71678. SQLITE_PRIVATE int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
  71679. Vdbe *pFrom = (Vdbe*)pFromStmt;
  71680. Vdbe *pTo = (Vdbe*)pToStmt;
  71681. int i;
  71682. assert( pTo->db==pFrom->db );
  71683. assert( pTo->nVar==pFrom->nVar );
  71684. sqlite3_mutex_enter(pTo->db->mutex);
  71685. for(i=0; i<pFrom->nVar; i++){
  71686. sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
  71687. }
  71688. sqlite3_mutex_leave(pTo->db->mutex);
  71689. return SQLITE_OK;
  71690. }
  71691. #ifndef SQLITE_OMIT_DEPRECATED
  71692. /*
  71693. ** Deprecated external interface. Internal/core SQLite code
  71694. ** should call sqlite3TransferBindings.
  71695. **
  71696. ** It is misuse to call this routine with statements from different
  71697. ** database connections. But as this is a deprecated interface, we
  71698. ** will not bother to check for that condition.
  71699. **
  71700. ** If the two statements contain a different number of bindings, then
  71701. ** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
  71702. ** SQLITE_OK is returned.
  71703. */
  71704. SQLITE_API int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
  71705. Vdbe *pFrom = (Vdbe*)pFromStmt;
  71706. Vdbe *pTo = (Vdbe*)pToStmt;
  71707. if( pFrom->nVar!=pTo->nVar ){
  71708. return SQLITE_ERROR;
  71709. }
  71710. if( pTo->isPrepareV2 && pTo->expmask ){
  71711. pTo->expired = 1;
  71712. }
  71713. if( pFrom->isPrepareV2 && pFrom->expmask ){
  71714. pFrom->expired = 1;
  71715. }
  71716. return sqlite3TransferBindings(pFromStmt, pToStmt);
  71717. }
  71718. #endif
  71719. /*
  71720. ** Return the sqlite3* database handle to which the prepared statement given
  71721. ** in the argument belongs. This is the same database handle that was
  71722. ** the first argument to the sqlite3_prepare() that was used to create
  71723. ** the statement in the first place.
  71724. */
  71725. SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
  71726. return pStmt ? ((Vdbe*)pStmt)->db : 0;
  71727. }
  71728. /*
  71729. ** Return true if the prepared statement is guaranteed to not modify the
  71730. ** database.
  71731. */
  71732. SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
  71733. return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
  71734. }
  71735. /*
  71736. ** Return true if the prepared statement is in need of being reset.
  71737. */
  71738. SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
  71739. Vdbe *v = (Vdbe*)pStmt;
  71740. return v!=0 && v->magic==VDBE_MAGIC_RUN && v->pc>=0;
  71741. }
  71742. /*
  71743. ** Return a pointer to the next prepared statement after pStmt associated
  71744. ** with database connection pDb. If pStmt is NULL, return the first
  71745. ** prepared statement for the database connection. Return NULL if there
  71746. ** are no more.
  71747. */
  71748. SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
  71749. sqlite3_stmt *pNext;
  71750. #ifdef SQLITE_ENABLE_API_ARMOR
  71751. if( !sqlite3SafetyCheckOk(pDb) ){
  71752. (void)SQLITE_MISUSE_BKPT;
  71753. return 0;
  71754. }
  71755. #endif
  71756. sqlite3_mutex_enter(pDb->mutex);
  71757. if( pStmt==0 ){
  71758. pNext = (sqlite3_stmt*)pDb->pVdbe;
  71759. }else{
  71760. pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
  71761. }
  71762. sqlite3_mutex_leave(pDb->mutex);
  71763. return pNext;
  71764. }
  71765. /*
  71766. ** Return the value of a status counter for a prepared statement
  71767. */
  71768. SQLITE_API int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
  71769. Vdbe *pVdbe = (Vdbe*)pStmt;
  71770. u32 v;
  71771. #ifdef SQLITE_ENABLE_API_ARMOR
  71772. if( !pStmt ){
  71773. (void)SQLITE_MISUSE_BKPT;
  71774. return 0;
  71775. }
  71776. #endif
  71777. v = pVdbe->aCounter[op];
  71778. if( resetFlag ) pVdbe->aCounter[op] = 0;
  71779. return (int)v;
  71780. }
  71781. /*
  71782. ** Return the SQL associated with a prepared statement
  71783. */
  71784. SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt){
  71785. Vdbe *p = (Vdbe *)pStmt;
  71786. return p ? p->zSql : 0;
  71787. }
  71788. /*
  71789. ** Return the SQL associated with a prepared statement with
  71790. ** bound parameters expanded. Space to hold the returned string is
  71791. ** obtained from sqlite3_malloc(). The caller is responsible for
  71792. ** freeing the returned string by passing it to sqlite3_free().
  71793. **
  71794. ** The SQLITE_TRACE_SIZE_LIMIT puts an upper bound on the size of
  71795. ** expanded bound parameters.
  71796. */
  71797. SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt){
  71798. #ifdef SQLITE_OMIT_TRACE
  71799. return 0;
  71800. #else
  71801. char *z = 0;
  71802. const char *zSql = sqlite3_sql(pStmt);
  71803. if( zSql ){
  71804. Vdbe *p = (Vdbe *)pStmt;
  71805. sqlite3_mutex_enter(p->db->mutex);
  71806. z = sqlite3VdbeExpandSql(p, zSql);
  71807. sqlite3_mutex_leave(p->db->mutex);
  71808. }
  71809. return z;
  71810. #endif
  71811. }
  71812. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  71813. /*
  71814. ** Allocate and populate an UnpackedRecord structure based on the serialized
  71815. ** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
  71816. ** if successful, or a NULL pointer if an OOM error is encountered.
  71817. */
  71818. static UnpackedRecord *vdbeUnpackRecord(
  71819. KeyInfo *pKeyInfo,
  71820. int nKey,
  71821. const void *pKey
  71822. ){
  71823. char *dummy; /* Dummy argument for AllocUnpackedRecord() */
  71824. UnpackedRecord *pRet; /* Return value */
  71825. pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo, 0, 0, &dummy);
  71826. if( pRet ){
  71827. memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nField+1));
  71828. sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
  71829. }
  71830. return pRet;
  71831. }
  71832. /*
  71833. ** This function is called from within a pre-update callback to retrieve
  71834. ** a field of the row currently being updated or deleted.
  71835. */
  71836. SQLITE_API int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
  71837. PreUpdate *p = db->pPreUpdate;
  71838. int rc = SQLITE_OK;
  71839. /* Test that this call is being made from within an SQLITE_DELETE or
  71840. ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
  71841. if( !p || p->op==SQLITE_INSERT ){
  71842. rc = SQLITE_MISUSE_BKPT;
  71843. goto preupdate_old_out;
  71844. }
  71845. if( iIdx>=p->pCsr->nField || iIdx<0 ){
  71846. rc = SQLITE_RANGE;
  71847. goto preupdate_old_out;
  71848. }
  71849. /* If the old.* record has not yet been loaded into memory, do so now. */
  71850. if( p->pUnpacked==0 ){
  71851. u32 nRec;
  71852. u8 *aRec;
  71853. nRec = sqlite3BtreePayloadSize(p->pCsr->uc.pCursor);
  71854. aRec = sqlite3DbMallocRaw(db, nRec);
  71855. if( !aRec ) goto preupdate_old_out;
  71856. rc = sqlite3BtreeData(p->pCsr->uc.pCursor, 0, nRec, aRec);
  71857. if( rc==SQLITE_OK ){
  71858. p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
  71859. if( !p->pUnpacked ) rc = SQLITE_NOMEM;
  71860. }
  71861. if( rc!=SQLITE_OK ){
  71862. sqlite3DbFree(db, aRec);
  71863. goto preupdate_old_out;
  71864. }
  71865. p->aRecord = aRec;
  71866. }
  71867. if( iIdx>=p->pUnpacked->nField ){
  71868. *ppValue = (sqlite3_value *)columnNullValue();
  71869. }else{
  71870. Mem *pMem = *ppValue = &p->pUnpacked->aMem[iIdx];
  71871. *ppValue = &p->pUnpacked->aMem[iIdx];
  71872. if( iIdx==p->pTab->iPKey ){
  71873. sqlite3VdbeMemSetInt64(pMem, p->iKey1);
  71874. }else if( p->pTab->aCol[iIdx].affinity==SQLITE_AFF_REAL ){
  71875. if( pMem->flags & MEM_Int ){
  71876. sqlite3VdbeMemRealify(pMem);
  71877. }
  71878. }
  71879. }
  71880. preupdate_old_out:
  71881. sqlite3Error(db, rc);
  71882. return sqlite3ApiExit(db, rc);
  71883. }
  71884. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  71885. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  71886. /*
  71887. ** This function is called from within a pre-update callback to retrieve
  71888. ** the number of columns in the row being updated, deleted or inserted.
  71889. */
  71890. SQLITE_API int sqlite3_preupdate_count(sqlite3 *db){
  71891. PreUpdate *p = db->pPreUpdate;
  71892. return (p ? p->keyinfo.nField : 0);
  71893. }
  71894. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  71895. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  71896. /*
  71897. ** This function is designed to be called from within a pre-update callback
  71898. ** only. It returns zero if the change that caused the callback was made
  71899. ** immediately by a user SQL statement. Or, if the change was made by a
  71900. ** trigger program, it returns the number of trigger programs currently
  71901. ** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
  71902. ** top-level trigger etc.).
  71903. **
  71904. ** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
  71905. ** or SET DEFAULT action is considered a trigger.
  71906. */
  71907. SQLITE_API int sqlite3_preupdate_depth(sqlite3 *db){
  71908. PreUpdate *p = db->pPreUpdate;
  71909. return (p ? p->v->nFrame : 0);
  71910. }
  71911. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  71912. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  71913. /*
  71914. ** This function is called from within a pre-update callback to retrieve
  71915. ** a field of the row currently being updated or inserted.
  71916. */
  71917. SQLITE_API int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
  71918. PreUpdate *p = db->pPreUpdate;
  71919. int rc = SQLITE_OK;
  71920. Mem *pMem;
  71921. if( !p || p->op==SQLITE_DELETE ){
  71922. rc = SQLITE_MISUSE_BKPT;
  71923. goto preupdate_new_out;
  71924. }
  71925. if( iIdx>=p->pCsr->nField || iIdx<0 ){
  71926. rc = SQLITE_RANGE;
  71927. goto preupdate_new_out;
  71928. }
  71929. if( p->op==SQLITE_INSERT ){
  71930. /* For an INSERT, memory cell p->iNewReg contains the serialized record
  71931. ** that is being inserted. Deserialize it. */
  71932. UnpackedRecord *pUnpack = p->pNewUnpacked;
  71933. if( !pUnpack ){
  71934. Mem *pData = &p->v->aMem[p->iNewReg];
  71935. rc = ExpandBlob(pData);
  71936. if( rc!=SQLITE_OK ) goto preupdate_new_out;
  71937. pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
  71938. if( !pUnpack ){
  71939. rc = SQLITE_NOMEM;
  71940. goto preupdate_new_out;
  71941. }
  71942. p->pNewUnpacked = pUnpack;
  71943. }
  71944. if( iIdx>=pUnpack->nField ){
  71945. pMem = (sqlite3_value *)columnNullValue();
  71946. }else{
  71947. pMem = &pUnpack->aMem[iIdx];
  71948. if( iIdx==p->pTab->iPKey ){
  71949. sqlite3VdbeMemSetInt64(pMem, p->iKey2);
  71950. }
  71951. }
  71952. }else{
  71953. /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
  71954. ** value. Make a copy of the cell contents and return a pointer to it.
  71955. ** It is not safe to return a pointer to the memory cell itself as the
  71956. ** caller may modify the value text encoding.
  71957. */
  71958. assert( p->op==SQLITE_UPDATE );
  71959. if( !p->aNew ){
  71960. p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
  71961. if( !p->aNew ){
  71962. rc = SQLITE_NOMEM;
  71963. goto preupdate_new_out;
  71964. }
  71965. }
  71966. assert( iIdx>=0 && iIdx<p->pCsr->nField );
  71967. pMem = &p->aNew[iIdx];
  71968. if( pMem->flags==0 ){
  71969. if( iIdx==p->pTab->iPKey ){
  71970. sqlite3VdbeMemSetInt64(pMem, p->iKey2);
  71971. }else{
  71972. rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
  71973. if( rc!=SQLITE_OK ) goto preupdate_new_out;
  71974. }
  71975. }
  71976. }
  71977. *ppValue = pMem;
  71978. preupdate_new_out:
  71979. sqlite3Error(db, rc);
  71980. return sqlite3ApiExit(db, rc);
  71981. }
  71982. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  71983. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  71984. /*
  71985. ** Return status data for a single loop within query pStmt.
  71986. */
  71987. SQLITE_API int sqlite3_stmt_scanstatus(
  71988. sqlite3_stmt *pStmt, /* Prepared statement being queried */
  71989. int idx, /* Index of loop to report on */
  71990. int iScanStatusOp, /* Which metric to return */
  71991. void *pOut /* OUT: Write the answer here */
  71992. ){
  71993. Vdbe *p = (Vdbe*)pStmt;
  71994. ScanStatus *pScan;
  71995. if( idx<0 || idx>=p->nScan ) return 1;
  71996. pScan = &p->aScan[idx];
  71997. switch( iScanStatusOp ){
  71998. case SQLITE_SCANSTAT_NLOOP: {
  71999. *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
  72000. break;
  72001. }
  72002. case SQLITE_SCANSTAT_NVISIT: {
  72003. *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
  72004. break;
  72005. }
  72006. case SQLITE_SCANSTAT_EST: {
  72007. double r = 1.0;
  72008. LogEst x = pScan->nEst;
  72009. while( x<100 ){
  72010. x += 10;
  72011. r *= 0.5;
  72012. }
  72013. *(double*)pOut = r*sqlite3LogEstToInt(x);
  72014. break;
  72015. }
  72016. case SQLITE_SCANSTAT_NAME: {
  72017. *(const char**)pOut = pScan->zName;
  72018. break;
  72019. }
  72020. case SQLITE_SCANSTAT_EXPLAIN: {
  72021. if( pScan->addrExplain ){
  72022. *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
  72023. }else{
  72024. *(const char**)pOut = 0;
  72025. }
  72026. break;
  72027. }
  72028. case SQLITE_SCANSTAT_SELECTID: {
  72029. if( pScan->addrExplain ){
  72030. *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
  72031. }else{
  72032. *(int*)pOut = -1;
  72033. }
  72034. break;
  72035. }
  72036. default: {
  72037. return 1;
  72038. }
  72039. }
  72040. return 0;
  72041. }
  72042. /*
  72043. ** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
  72044. */
  72045. SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
  72046. Vdbe *p = (Vdbe*)pStmt;
  72047. memset(p->anExec, 0, p->nOp * sizeof(i64));
  72048. }
  72049. #endif /* SQLITE_ENABLE_STMT_SCANSTATUS */
  72050. /************** End of vdbeapi.c *********************************************/
  72051. /************** Begin file vdbetrace.c ***************************************/
  72052. /*
  72053. ** 2009 November 25
  72054. **
  72055. ** The author disclaims copyright to this source code. In place of
  72056. ** a legal notice, here is a blessing:
  72057. **
  72058. ** May you do good and not evil.
  72059. ** May you find forgiveness for yourself and forgive others.
  72060. ** May you share freely, never taking more than you give.
  72061. **
  72062. *************************************************************************
  72063. **
  72064. ** This file contains code used to insert the values of host parameters
  72065. ** (aka "wildcards") into the SQL text output by sqlite3_trace().
  72066. **
  72067. ** The Vdbe parse-tree explainer is also found here.
  72068. */
  72069. /* #include "sqliteInt.h" */
  72070. /* #include "vdbeInt.h" */
  72071. #ifndef SQLITE_OMIT_TRACE
  72072. /*
  72073. ** zSql is a zero-terminated string of UTF-8 SQL text. Return the number of
  72074. ** bytes in this text up to but excluding the first character in
  72075. ** a host parameter. If the text contains no host parameters, return
  72076. ** the total number of bytes in the text.
  72077. */
  72078. static int findNextHostParameter(const char *zSql, int *pnToken){
  72079. int tokenType;
  72080. int nTotal = 0;
  72081. int n;
  72082. *pnToken = 0;
  72083. while( zSql[0] ){
  72084. n = sqlite3GetToken((u8*)zSql, &tokenType);
  72085. assert( n>0 && tokenType!=TK_ILLEGAL );
  72086. if( tokenType==TK_VARIABLE ){
  72087. *pnToken = n;
  72088. break;
  72089. }
  72090. nTotal += n;
  72091. zSql += n;
  72092. }
  72093. return nTotal;
  72094. }
  72095. /*
  72096. ** This function returns a pointer to a nul-terminated string in memory
  72097. ** obtained from sqlite3DbMalloc(). If sqlite3.nVdbeExec is 1, then the
  72098. ** string contains a copy of zRawSql but with host parameters expanded to
  72099. ** their current bindings. Or, if sqlite3.nVdbeExec is greater than 1,
  72100. ** then the returned string holds a copy of zRawSql with "-- " prepended
  72101. ** to each line of text.
  72102. **
  72103. ** If the SQLITE_TRACE_SIZE_LIMIT macro is defined to an integer, then
  72104. ** then long strings and blobs are truncated to that many bytes. This
  72105. ** can be used to prevent unreasonably large trace strings when dealing
  72106. ** with large (multi-megabyte) strings and blobs.
  72107. **
  72108. ** The calling function is responsible for making sure the memory returned
  72109. ** is eventually freed.
  72110. **
  72111. ** ALGORITHM: Scan the input string looking for host parameters in any of
  72112. ** these forms: ?, ?N, $A, @A, :A. Take care to avoid text within
  72113. ** string literals, quoted identifier names, and comments. For text forms,
  72114. ** the host parameter index is found by scanning the prepared
  72115. ** statement for the corresponding OP_Variable opcode. Once the host
  72116. ** parameter index is known, locate the value in p->aVar[]. Then render
  72117. ** the value as a literal in place of the host parameter name.
  72118. */
  72119. SQLITE_PRIVATE char *sqlite3VdbeExpandSql(
  72120. Vdbe *p, /* The prepared statement being evaluated */
  72121. const char *zRawSql /* Raw text of the SQL statement */
  72122. ){
  72123. sqlite3 *db; /* The database connection */
  72124. int idx = 0; /* Index of a host parameter */
  72125. int nextIndex = 1; /* Index of next ? host parameter */
  72126. int n; /* Length of a token prefix */
  72127. int nToken; /* Length of the parameter token */
  72128. int i; /* Loop counter */
  72129. Mem *pVar; /* Value of a host parameter */
  72130. StrAccum out; /* Accumulate the output here */
  72131. #ifndef SQLITE_OMIT_UTF16
  72132. Mem utf8; /* Used to convert UTF16 parameters into UTF8 for display */
  72133. #endif
  72134. char zBase[100]; /* Initial working space */
  72135. db = p->db;
  72136. sqlite3StrAccumInit(&out, 0, zBase, sizeof(zBase),
  72137. db->aLimit[SQLITE_LIMIT_LENGTH]);
  72138. if( db->nVdbeExec>1 ){
  72139. while( *zRawSql ){
  72140. const char *zStart = zRawSql;
  72141. while( *(zRawSql++)!='\n' && *zRawSql );
  72142. sqlite3StrAccumAppend(&out, "-- ", 3);
  72143. assert( (zRawSql - zStart) > 0 );
  72144. sqlite3StrAccumAppend(&out, zStart, (int)(zRawSql-zStart));
  72145. }
  72146. }else if( p->nVar==0 ){
  72147. sqlite3StrAccumAppend(&out, zRawSql, sqlite3Strlen30(zRawSql));
  72148. }else{
  72149. while( zRawSql[0] ){
  72150. n = findNextHostParameter(zRawSql, &nToken);
  72151. assert( n>0 );
  72152. sqlite3StrAccumAppend(&out, zRawSql, n);
  72153. zRawSql += n;
  72154. assert( zRawSql[0] || nToken==0 );
  72155. if( nToken==0 ) break;
  72156. if( zRawSql[0]=='?' ){
  72157. if( nToken>1 ){
  72158. assert( sqlite3Isdigit(zRawSql[1]) );
  72159. sqlite3GetInt32(&zRawSql[1], &idx);
  72160. }else{
  72161. idx = nextIndex;
  72162. }
  72163. }else{
  72164. assert( zRawSql[0]==':' || zRawSql[0]=='$' ||
  72165. zRawSql[0]=='@' || zRawSql[0]=='#' );
  72166. testcase( zRawSql[0]==':' );
  72167. testcase( zRawSql[0]=='$' );
  72168. testcase( zRawSql[0]=='@' );
  72169. testcase( zRawSql[0]=='#' );
  72170. idx = sqlite3VdbeParameterIndex(p, zRawSql, nToken);
  72171. assert( idx>0 );
  72172. }
  72173. zRawSql += nToken;
  72174. nextIndex = idx + 1;
  72175. assert( idx>0 && idx<=p->nVar );
  72176. pVar = &p->aVar[idx-1];
  72177. if( pVar->flags & MEM_Null ){
  72178. sqlite3StrAccumAppend(&out, "NULL", 4);
  72179. }else if( pVar->flags & MEM_Int ){
  72180. sqlite3XPrintf(&out, "%lld", pVar->u.i);
  72181. }else if( pVar->flags & MEM_Real ){
  72182. sqlite3XPrintf(&out, "%!.15g", pVar->u.r);
  72183. }else if( pVar->flags & MEM_Str ){
  72184. int nOut; /* Number of bytes of the string text to include in output */
  72185. #ifndef SQLITE_OMIT_UTF16
  72186. u8 enc = ENC(db);
  72187. if( enc!=SQLITE_UTF8 ){
  72188. memset(&utf8, 0, sizeof(utf8));
  72189. utf8.db = db;
  72190. sqlite3VdbeMemSetStr(&utf8, pVar->z, pVar->n, enc, SQLITE_STATIC);
  72191. if( SQLITE_NOMEM==sqlite3VdbeChangeEncoding(&utf8, SQLITE_UTF8) ){
  72192. out.accError = STRACCUM_NOMEM;
  72193. out.nAlloc = 0;
  72194. }
  72195. pVar = &utf8;
  72196. }
  72197. #endif
  72198. nOut = pVar->n;
  72199. #ifdef SQLITE_TRACE_SIZE_LIMIT
  72200. if( nOut>SQLITE_TRACE_SIZE_LIMIT ){
  72201. nOut = SQLITE_TRACE_SIZE_LIMIT;
  72202. while( nOut<pVar->n && (pVar->z[nOut]&0xc0)==0x80 ){ nOut++; }
  72203. }
  72204. #endif
  72205. sqlite3XPrintf(&out, "'%.*q'", nOut, pVar->z);
  72206. #ifdef SQLITE_TRACE_SIZE_LIMIT
  72207. if( nOut<pVar->n ){
  72208. sqlite3XPrintf(&out, "/*+%d bytes*/", pVar->n-nOut);
  72209. }
  72210. #endif
  72211. #ifndef SQLITE_OMIT_UTF16
  72212. if( enc!=SQLITE_UTF8 ) sqlite3VdbeMemRelease(&utf8);
  72213. #endif
  72214. }else if( pVar->flags & MEM_Zero ){
  72215. sqlite3XPrintf(&out, "zeroblob(%d)", pVar->u.nZero);
  72216. }else{
  72217. int nOut; /* Number of bytes of the blob to include in output */
  72218. assert( pVar->flags & MEM_Blob );
  72219. sqlite3StrAccumAppend(&out, "x'", 2);
  72220. nOut = pVar->n;
  72221. #ifdef SQLITE_TRACE_SIZE_LIMIT
  72222. if( nOut>SQLITE_TRACE_SIZE_LIMIT ) nOut = SQLITE_TRACE_SIZE_LIMIT;
  72223. #endif
  72224. for(i=0; i<nOut; i++){
  72225. sqlite3XPrintf(&out, "%02x", pVar->z[i]&0xff);
  72226. }
  72227. sqlite3StrAccumAppend(&out, "'", 1);
  72228. #ifdef SQLITE_TRACE_SIZE_LIMIT
  72229. if( nOut<pVar->n ){
  72230. sqlite3XPrintf(&out, "/*+%d bytes*/", pVar->n-nOut);
  72231. }
  72232. #endif
  72233. }
  72234. }
  72235. }
  72236. if( out.accError ) sqlite3StrAccumReset(&out);
  72237. return sqlite3StrAccumFinish(&out);
  72238. }
  72239. #endif /* #ifndef SQLITE_OMIT_TRACE */
  72240. /************** End of vdbetrace.c *******************************************/
  72241. /************** Begin file vdbe.c ********************************************/
  72242. /*
  72243. ** 2001 September 15
  72244. **
  72245. ** The author disclaims copyright to this source code. In place of
  72246. ** a legal notice, here is a blessing:
  72247. **
  72248. ** May you do good and not evil.
  72249. ** May you find forgiveness for yourself and forgive others.
  72250. ** May you share freely, never taking more than you give.
  72251. **
  72252. *************************************************************************
  72253. ** The code in this file implements the function that runs the
  72254. ** bytecode of a prepared statement.
  72255. **
  72256. ** Various scripts scan this source file in order to generate HTML
  72257. ** documentation, headers files, or other derived files. The formatting
  72258. ** of the code in this file is, therefore, important. See other comments
  72259. ** in this file for details. If in doubt, do not deviate from existing
  72260. ** commenting and indentation practices when changing or adding code.
  72261. */
  72262. /* #include "sqliteInt.h" */
  72263. /* #include "vdbeInt.h" */
  72264. /*
  72265. ** Invoke this macro on memory cells just prior to changing the
  72266. ** value of the cell. This macro verifies that shallow copies are
  72267. ** not misused. A shallow copy of a string or blob just copies a
  72268. ** pointer to the string or blob, not the content. If the original
  72269. ** is changed while the copy is still in use, the string or blob might
  72270. ** be changed out from under the copy. This macro verifies that nothing
  72271. ** like that ever happens.
  72272. */
  72273. #ifdef SQLITE_DEBUG
  72274. # define memAboutToChange(P,M) sqlite3VdbeMemAboutToChange(P,M)
  72275. #else
  72276. # define memAboutToChange(P,M)
  72277. #endif
  72278. /*
  72279. ** The following global variable is incremented every time a cursor
  72280. ** moves, either by the OP_SeekXX, OP_Next, or OP_Prev opcodes. The test
  72281. ** procedures use this information to make sure that indices are
  72282. ** working correctly. This variable has no function other than to
  72283. ** help verify the correct operation of the library.
  72284. */
  72285. #ifdef SQLITE_TEST
  72286. SQLITE_API int sqlite3_search_count = 0;
  72287. #endif
  72288. /*
  72289. ** When this global variable is positive, it gets decremented once before
  72290. ** each instruction in the VDBE. When it reaches zero, the u1.isInterrupted
  72291. ** field of the sqlite3 structure is set in order to simulate an interrupt.
  72292. **
  72293. ** This facility is used for testing purposes only. It does not function
  72294. ** in an ordinary build.
  72295. */
  72296. #ifdef SQLITE_TEST
  72297. SQLITE_API int sqlite3_interrupt_count = 0;
  72298. #endif
  72299. /*
  72300. ** The next global variable is incremented each type the OP_Sort opcode
  72301. ** is executed. The test procedures use this information to make sure that
  72302. ** sorting is occurring or not occurring at appropriate times. This variable
  72303. ** has no function other than to help verify the correct operation of the
  72304. ** library.
  72305. */
  72306. #ifdef SQLITE_TEST
  72307. SQLITE_API int sqlite3_sort_count = 0;
  72308. #endif
  72309. /*
  72310. ** The next global variable records the size of the largest MEM_Blob
  72311. ** or MEM_Str that has been used by a VDBE opcode. The test procedures
  72312. ** use this information to make sure that the zero-blob functionality
  72313. ** is working correctly. This variable has no function other than to
  72314. ** help verify the correct operation of the library.
  72315. */
  72316. #ifdef SQLITE_TEST
  72317. SQLITE_API int sqlite3_max_blobsize = 0;
  72318. static void updateMaxBlobsize(Mem *p){
  72319. if( (p->flags & (MEM_Str|MEM_Blob))!=0 && p->n>sqlite3_max_blobsize ){
  72320. sqlite3_max_blobsize = p->n;
  72321. }
  72322. }
  72323. #endif
  72324. /*
  72325. ** This macro evaluates to true if either the update hook or the preupdate
  72326. ** hook are enabled for database connect DB.
  72327. */
  72328. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  72329. # define HAS_UPDATE_HOOK(DB) ((DB)->xPreUpdateCallback||(DB)->xUpdateCallback)
  72330. #else
  72331. # define HAS_UPDATE_HOOK(DB) ((DB)->xUpdateCallback)
  72332. #endif
  72333. /*
  72334. ** The next global variable is incremented each time the OP_Found opcode
  72335. ** is executed. This is used to test whether or not the foreign key
  72336. ** operation implemented using OP_FkIsZero is working. This variable
  72337. ** has no function other than to help verify the correct operation of the
  72338. ** library.
  72339. */
  72340. #ifdef SQLITE_TEST
  72341. SQLITE_API int sqlite3_found_count = 0;
  72342. #endif
  72343. /*
  72344. ** Test a register to see if it exceeds the current maximum blob size.
  72345. ** If it does, record the new maximum blob size.
  72346. */
  72347. #if defined(SQLITE_TEST) && !defined(SQLITE_OMIT_BUILTIN_TEST)
  72348. # define UPDATE_MAX_BLOBSIZE(P) updateMaxBlobsize(P)
  72349. #else
  72350. # define UPDATE_MAX_BLOBSIZE(P)
  72351. #endif
  72352. /*
  72353. ** Invoke the VDBE coverage callback, if that callback is defined. This
  72354. ** feature is used for test suite validation only and does not appear an
  72355. ** production builds.
  72356. **
  72357. ** M is an integer, 2 or 3, that indices how many different ways the
  72358. ** branch can go. It is usually 2. "I" is the direction the branch
  72359. ** goes. 0 means falls through. 1 means branch is taken. 2 means the
  72360. ** second alternative branch is taken.
  72361. **
  72362. ** iSrcLine is the source code line (from the __LINE__ macro) that
  72363. ** generated the VDBE instruction. This instrumentation assumes that all
  72364. ** source code is in a single file (the amalgamation). Special values 1
  72365. ** and 2 for the iSrcLine parameter mean that this particular branch is
  72366. ** always taken or never taken, respectively.
  72367. */
  72368. #if !defined(SQLITE_VDBE_COVERAGE)
  72369. # define VdbeBranchTaken(I,M)
  72370. #else
  72371. # define VdbeBranchTaken(I,M) vdbeTakeBranch(pOp->iSrcLine,I,M)
  72372. static void vdbeTakeBranch(int iSrcLine, u8 I, u8 M){
  72373. if( iSrcLine<=2 && ALWAYS(iSrcLine>0) ){
  72374. M = iSrcLine;
  72375. /* Assert the truth of VdbeCoverageAlwaysTaken() and
  72376. ** VdbeCoverageNeverTaken() */
  72377. assert( (M & I)==I );
  72378. }else{
  72379. if( sqlite3GlobalConfig.xVdbeBranch==0 ) return; /*NO_TEST*/
  72380. sqlite3GlobalConfig.xVdbeBranch(sqlite3GlobalConfig.pVdbeBranchArg,
  72381. iSrcLine,I,M);
  72382. }
  72383. }
  72384. #endif
  72385. /*
  72386. ** Convert the given register into a string if it isn't one
  72387. ** already. Return non-zero if a malloc() fails.
  72388. */
  72389. #define Stringify(P, enc) \
  72390. if(((P)->flags&(MEM_Str|MEM_Blob))==0 && sqlite3VdbeMemStringify(P,enc,0)) \
  72391. { goto no_mem; }
  72392. /*
  72393. ** An ephemeral string value (signified by the MEM_Ephem flag) contains
  72394. ** a pointer to a dynamically allocated string where some other entity
  72395. ** is responsible for deallocating that string. Because the register
  72396. ** does not control the string, it might be deleted without the register
  72397. ** knowing it.
  72398. **
  72399. ** This routine converts an ephemeral string into a dynamically allocated
  72400. ** string that the register itself controls. In other words, it
  72401. ** converts an MEM_Ephem string into a string with P.z==P.zMalloc.
  72402. */
  72403. #define Deephemeralize(P) \
  72404. if( ((P)->flags&MEM_Ephem)!=0 \
  72405. && sqlite3VdbeMemMakeWriteable(P) ){ goto no_mem;}
  72406. /* Return true if the cursor was opened using the OP_OpenSorter opcode. */
  72407. #define isSorter(x) ((x)->eCurType==CURTYPE_SORTER)
  72408. /*
  72409. ** Allocate VdbeCursor number iCur. Return a pointer to it. Return NULL
  72410. ** if we run out of memory.
  72411. */
  72412. static VdbeCursor *allocateCursor(
  72413. Vdbe *p, /* The virtual machine */
  72414. int iCur, /* Index of the new VdbeCursor */
  72415. int nField, /* Number of fields in the table or index */
  72416. int iDb, /* Database the cursor belongs to, or -1 */
  72417. u8 eCurType /* Type of the new cursor */
  72418. ){
  72419. /* Find the memory cell that will be used to store the blob of memory
  72420. ** required for this VdbeCursor structure. It is convenient to use a
  72421. ** vdbe memory cell to manage the memory allocation required for a
  72422. ** VdbeCursor structure for the following reasons:
  72423. **
  72424. ** * Sometimes cursor numbers are used for a couple of different
  72425. ** purposes in a vdbe program. The different uses might require
  72426. ** different sized allocations. Memory cells provide growable
  72427. ** allocations.
  72428. **
  72429. ** * When using ENABLE_MEMORY_MANAGEMENT, memory cell buffers can
  72430. ** be freed lazily via the sqlite3_release_memory() API. This
  72431. ** minimizes the number of malloc calls made by the system.
  72432. **
  72433. ** The memory cell for cursor 0 is aMem[0]. The rest are allocated from
  72434. ** the top of the register space. Cursor 1 is at Mem[p->nMem-1].
  72435. ** Cursor 2 is at Mem[p->nMem-2]. And so forth.
  72436. */
  72437. Mem *pMem = iCur>0 ? &p->aMem[p->nMem-iCur] : p->aMem;
  72438. int nByte;
  72439. VdbeCursor *pCx = 0;
  72440. nByte =
  72441. ROUND8(sizeof(VdbeCursor)) + 2*sizeof(u32)*nField +
  72442. (eCurType==CURTYPE_BTREE?sqlite3BtreeCursorSize():0);
  72443. assert( iCur>=0 && iCur<p->nCursor );
  72444. if( p->apCsr[iCur] ){ /*OPTIMIZATION-IF-FALSE*/
  72445. sqlite3VdbeFreeCursor(p, p->apCsr[iCur]);
  72446. p->apCsr[iCur] = 0;
  72447. }
  72448. if( SQLITE_OK==sqlite3VdbeMemClearAndResize(pMem, nByte) ){
  72449. p->apCsr[iCur] = pCx = (VdbeCursor*)pMem->z;
  72450. memset(pCx, 0, sizeof(VdbeCursor));
  72451. pCx->eCurType = eCurType;
  72452. pCx->iDb = iDb;
  72453. pCx->nField = nField;
  72454. pCx->aOffset = &pCx->aType[nField];
  72455. if( eCurType==CURTYPE_BTREE ){
  72456. pCx->uc.pCursor = (BtCursor*)
  72457. &pMem->z[ROUND8(sizeof(VdbeCursor))+2*sizeof(u32)*nField];
  72458. sqlite3BtreeCursorZero(pCx->uc.pCursor);
  72459. }
  72460. }
  72461. return pCx;
  72462. }
  72463. /*
  72464. ** Try to convert a value into a numeric representation if we can
  72465. ** do so without loss of information. In other words, if the string
  72466. ** looks like a number, convert it into a number. If it does not
  72467. ** look like a number, leave it alone.
  72468. **
  72469. ** If the bTryForInt flag is true, then extra effort is made to give
  72470. ** an integer representation. Strings that look like floating point
  72471. ** values but which have no fractional component (example: '48.00')
  72472. ** will have a MEM_Int representation when bTryForInt is true.
  72473. **
  72474. ** If bTryForInt is false, then if the input string contains a decimal
  72475. ** point or exponential notation, the result is only MEM_Real, even
  72476. ** if there is an exact integer representation of the quantity.
  72477. */
  72478. static void applyNumericAffinity(Mem *pRec, int bTryForInt){
  72479. double rValue;
  72480. i64 iValue;
  72481. u8 enc = pRec->enc;
  72482. assert( (pRec->flags & (MEM_Str|MEM_Int|MEM_Real))==MEM_Str );
  72483. if( sqlite3AtoF(pRec->z, &rValue, pRec->n, enc)==0 ) return;
  72484. if( 0==sqlite3Atoi64(pRec->z, &iValue, pRec->n, enc) ){
  72485. pRec->u.i = iValue;
  72486. pRec->flags |= MEM_Int;
  72487. }else{
  72488. pRec->u.r = rValue;
  72489. pRec->flags |= MEM_Real;
  72490. if( bTryForInt ) sqlite3VdbeIntegerAffinity(pRec);
  72491. }
  72492. }
  72493. /*
  72494. ** Processing is determine by the affinity parameter:
  72495. **
  72496. ** SQLITE_AFF_INTEGER:
  72497. ** SQLITE_AFF_REAL:
  72498. ** SQLITE_AFF_NUMERIC:
  72499. ** Try to convert pRec to an integer representation or a
  72500. ** floating-point representation if an integer representation
  72501. ** is not possible. Note that the integer representation is
  72502. ** always preferred, even if the affinity is REAL, because
  72503. ** an integer representation is more space efficient on disk.
  72504. **
  72505. ** SQLITE_AFF_TEXT:
  72506. ** Convert pRec to a text representation.
  72507. **
  72508. ** SQLITE_AFF_BLOB:
  72509. ** No-op. pRec is unchanged.
  72510. */
  72511. static void applyAffinity(
  72512. Mem *pRec, /* The value to apply affinity to */
  72513. char affinity, /* The affinity to be applied */
  72514. u8 enc /* Use this text encoding */
  72515. ){
  72516. if( affinity>=SQLITE_AFF_NUMERIC ){
  72517. assert( affinity==SQLITE_AFF_INTEGER || affinity==SQLITE_AFF_REAL
  72518. || affinity==SQLITE_AFF_NUMERIC );
  72519. if( (pRec->flags & MEM_Int)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  72520. if( (pRec->flags & MEM_Real)==0 ){
  72521. if( pRec->flags & MEM_Str ) applyNumericAffinity(pRec,1);
  72522. }else{
  72523. sqlite3VdbeIntegerAffinity(pRec);
  72524. }
  72525. }
  72526. }else if( affinity==SQLITE_AFF_TEXT ){
  72527. /* Only attempt the conversion to TEXT if there is an integer or real
  72528. ** representation (blob and NULL do not get converted) but no string
  72529. ** representation. It would be harmless to repeat the conversion if
  72530. ** there is already a string rep, but it is pointless to waste those
  72531. ** CPU cycles. */
  72532. if( 0==(pRec->flags&MEM_Str) ){ /*OPTIMIZATION-IF-FALSE*/
  72533. if( (pRec->flags&(MEM_Real|MEM_Int)) ){
  72534. sqlite3VdbeMemStringify(pRec, enc, 1);
  72535. }
  72536. }
  72537. pRec->flags &= ~(MEM_Real|MEM_Int);
  72538. }
  72539. }
  72540. /*
  72541. ** Try to convert the type of a function argument or a result column
  72542. ** into a numeric representation. Use either INTEGER or REAL whichever
  72543. ** is appropriate. But only do the conversion if it is possible without
  72544. ** loss of information and return the revised type of the argument.
  72545. */
  72546. SQLITE_API int sqlite3_value_numeric_type(sqlite3_value *pVal){
  72547. int eType = sqlite3_value_type(pVal);
  72548. if( eType==SQLITE_TEXT ){
  72549. Mem *pMem = (Mem*)pVal;
  72550. applyNumericAffinity(pMem, 0);
  72551. eType = sqlite3_value_type(pVal);
  72552. }
  72553. return eType;
  72554. }
  72555. /*
  72556. ** Exported version of applyAffinity(). This one works on sqlite3_value*,
  72557. ** not the internal Mem* type.
  72558. */
  72559. SQLITE_PRIVATE void sqlite3ValueApplyAffinity(
  72560. sqlite3_value *pVal,
  72561. u8 affinity,
  72562. u8 enc
  72563. ){
  72564. applyAffinity((Mem *)pVal, affinity, enc);
  72565. }
  72566. /*
  72567. ** pMem currently only holds a string type (or maybe a BLOB that we can
  72568. ** interpret as a string if we want to). Compute its corresponding
  72569. ** numeric type, if has one. Set the pMem->u.r and pMem->u.i fields
  72570. ** accordingly.
  72571. */
  72572. static u16 SQLITE_NOINLINE computeNumericType(Mem *pMem){
  72573. assert( (pMem->flags & (MEM_Int|MEM_Real))==0 );
  72574. assert( (pMem->flags & (MEM_Str|MEM_Blob))!=0 );
  72575. if( sqlite3AtoF(pMem->z, &pMem->u.r, pMem->n, pMem->enc)==0 ){
  72576. return 0;
  72577. }
  72578. if( sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc)==SQLITE_OK ){
  72579. return MEM_Int;
  72580. }
  72581. return MEM_Real;
  72582. }
  72583. /*
  72584. ** Return the numeric type for pMem, either MEM_Int or MEM_Real or both or
  72585. ** none.
  72586. **
  72587. ** Unlike applyNumericAffinity(), this routine does not modify pMem->flags.
  72588. ** But it does set pMem->u.r and pMem->u.i appropriately.
  72589. */
  72590. static u16 numericType(Mem *pMem){
  72591. if( pMem->flags & (MEM_Int|MEM_Real) ){
  72592. return pMem->flags & (MEM_Int|MEM_Real);
  72593. }
  72594. if( pMem->flags & (MEM_Str|MEM_Blob) ){
  72595. return computeNumericType(pMem);
  72596. }
  72597. return 0;
  72598. }
  72599. #ifdef SQLITE_DEBUG
  72600. /*
  72601. ** Write a nice string representation of the contents of cell pMem
  72602. ** into buffer zBuf, length nBuf.
  72603. */
  72604. SQLITE_PRIVATE void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf){
  72605. char *zCsr = zBuf;
  72606. int f = pMem->flags;
  72607. static const char *const encnames[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
  72608. if( f&MEM_Blob ){
  72609. int i;
  72610. char c;
  72611. if( f & MEM_Dyn ){
  72612. c = 'z';
  72613. assert( (f & (MEM_Static|MEM_Ephem))==0 );
  72614. }else if( f & MEM_Static ){
  72615. c = 't';
  72616. assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
  72617. }else if( f & MEM_Ephem ){
  72618. c = 'e';
  72619. assert( (f & (MEM_Static|MEM_Dyn))==0 );
  72620. }else{
  72621. c = 's';
  72622. }
  72623. sqlite3_snprintf(100, zCsr, "%c", c);
  72624. zCsr += sqlite3Strlen30(zCsr);
  72625. sqlite3_snprintf(100, zCsr, "%d[", pMem->n);
  72626. zCsr += sqlite3Strlen30(zCsr);
  72627. for(i=0; i<16 && i<pMem->n; i++){
  72628. sqlite3_snprintf(100, zCsr, "%02X", ((int)pMem->z[i] & 0xFF));
  72629. zCsr += sqlite3Strlen30(zCsr);
  72630. }
  72631. for(i=0; i<16 && i<pMem->n; i++){
  72632. char z = pMem->z[i];
  72633. if( z<32 || z>126 ) *zCsr++ = '.';
  72634. else *zCsr++ = z;
  72635. }
  72636. sqlite3_snprintf(100, zCsr, "]%s", encnames[pMem->enc]);
  72637. zCsr += sqlite3Strlen30(zCsr);
  72638. if( f & MEM_Zero ){
  72639. sqlite3_snprintf(100, zCsr,"+%dz",pMem->u.nZero);
  72640. zCsr += sqlite3Strlen30(zCsr);
  72641. }
  72642. *zCsr = '\0';
  72643. }else if( f & MEM_Str ){
  72644. int j, k;
  72645. zBuf[0] = ' ';
  72646. if( f & MEM_Dyn ){
  72647. zBuf[1] = 'z';
  72648. assert( (f & (MEM_Static|MEM_Ephem))==0 );
  72649. }else if( f & MEM_Static ){
  72650. zBuf[1] = 't';
  72651. assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
  72652. }else if( f & MEM_Ephem ){
  72653. zBuf[1] = 'e';
  72654. assert( (f & (MEM_Static|MEM_Dyn))==0 );
  72655. }else{
  72656. zBuf[1] = 's';
  72657. }
  72658. k = 2;
  72659. sqlite3_snprintf(100, &zBuf[k], "%d", pMem->n);
  72660. k += sqlite3Strlen30(&zBuf[k]);
  72661. zBuf[k++] = '[';
  72662. for(j=0; j<15 && j<pMem->n; j++){
  72663. u8 c = pMem->z[j];
  72664. if( c>=0x20 && c<0x7f ){
  72665. zBuf[k++] = c;
  72666. }else{
  72667. zBuf[k++] = '.';
  72668. }
  72669. }
  72670. zBuf[k++] = ']';
  72671. sqlite3_snprintf(100,&zBuf[k], encnames[pMem->enc]);
  72672. k += sqlite3Strlen30(&zBuf[k]);
  72673. zBuf[k++] = 0;
  72674. }
  72675. }
  72676. #endif
  72677. #ifdef SQLITE_DEBUG
  72678. /*
  72679. ** Print the value of a register for tracing purposes:
  72680. */
  72681. static void memTracePrint(Mem *p){
  72682. if( p->flags & MEM_Undefined ){
  72683. printf(" undefined");
  72684. }else if( p->flags & MEM_Null ){
  72685. printf(" NULL");
  72686. }else if( (p->flags & (MEM_Int|MEM_Str))==(MEM_Int|MEM_Str) ){
  72687. printf(" si:%lld", p->u.i);
  72688. }else if( p->flags & MEM_Int ){
  72689. printf(" i:%lld", p->u.i);
  72690. #ifndef SQLITE_OMIT_FLOATING_POINT
  72691. }else if( p->flags & MEM_Real ){
  72692. printf(" r:%g", p->u.r);
  72693. #endif
  72694. }else if( p->flags & MEM_RowSet ){
  72695. printf(" (rowset)");
  72696. }else{
  72697. char zBuf[200];
  72698. sqlite3VdbeMemPrettyPrint(p, zBuf);
  72699. printf(" %s", zBuf);
  72700. }
  72701. if( p->flags & MEM_Subtype ) printf(" subtype=0x%02x", p->eSubtype);
  72702. }
  72703. static void registerTrace(int iReg, Mem *p){
  72704. printf("REG[%d] = ", iReg);
  72705. memTracePrint(p);
  72706. printf("\n");
  72707. }
  72708. #endif
  72709. #ifdef SQLITE_DEBUG
  72710. # define REGISTER_TRACE(R,M) if(db->flags&SQLITE_VdbeTrace)registerTrace(R,M)
  72711. #else
  72712. # define REGISTER_TRACE(R,M)
  72713. #endif
  72714. #ifdef VDBE_PROFILE
  72715. /*
  72716. ** hwtime.h contains inline assembler code for implementing
  72717. ** high-performance timing routines.
  72718. */
  72719. /************** Include hwtime.h in the middle of vdbe.c *********************/
  72720. /************** Begin file hwtime.h ******************************************/
  72721. /*
  72722. ** 2008 May 27
  72723. **
  72724. ** The author disclaims copyright to this source code. In place of
  72725. ** a legal notice, here is a blessing:
  72726. **
  72727. ** May you do good and not evil.
  72728. ** May you find forgiveness for yourself and forgive others.
  72729. ** May you share freely, never taking more than you give.
  72730. **
  72731. ******************************************************************************
  72732. **
  72733. ** This file contains inline asm code for retrieving "high-performance"
  72734. ** counters for x86 class CPUs.
  72735. */
  72736. #ifndef SQLITE_HWTIME_H
  72737. #define SQLITE_HWTIME_H
  72738. /*
  72739. ** The following routine only works on pentium-class (or newer) processors.
  72740. ** It uses the RDTSC opcode to read the cycle count value out of the
  72741. ** processor and returns that value. This can be used for high-res
  72742. ** profiling.
  72743. */
  72744. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  72745. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  72746. #if defined(__GNUC__)
  72747. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  72748. unsigned int lo, hi;
  72749. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  72750. return (sqlite_uint64)hi << 32 | lo;
  72751. }
  72752. #elif defined(_MSC_VER)
  72753. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  72754. __asm {
  72755. rdtsc
  72756. ret ; return value at EDX:EAX
  72757. }
  72758. }
  72759. #endif
  72760. #elif (defined(__GNUC__) && defined(__x86_64__))
  72761. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  72762. unsigned long val;
  72763. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  72764. return val;
  72765. }
  72766. #elif (defined(__GNUC__) && defined(__ppc__))
  72767. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  72768. unsigned long long retval;
  72769. unsigned long junk;
  72770. __asm__ __volatile__ ("\n\
  72771. 1: mftbu %1\n\
  72772. mftb %L0\n\
  72773. mftbu %0\n\
  72774. cmpw %0,%1\n\
  72775. bne 1b"
  72776. : "=r" (retval), "=r" (junk));
  72777. return retval;
  72778. }
  72779. #else
  72780. #error Need implementation of sqlite3Hwtime() for your platform.
  72781. /*
  72782. ** To compile without implementing sqlite3Hwtime() for your platform,
  72783. ** you can remove the above #error and use the following
  72784. ** stub function. You will lose timing support for many
  72785. ** of the debugging and testing utilities, but it should at
  72786. ** least compile and run.
  72787. */
  72788. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  72789. #endif
  72790. #endif /* !defined(SQLITE_HWTIME_H) */
  72791. /************** End of hwtime.h **********************************************/
  72792. /************** Continuing where we left off in vdbe.c ***********************/
  72793. #endif
  72794. #ifndef NDEBUG
  72795. /*
  72796. ** This function is only called from within an assert() expression. It
  72797. ** checks that the sqlite3.nTransaction variable is correctly set to
  72798. ** the number of non-transaction savepoints currently in the
  72799. ** linked list starting at sqlite3.pSavepoint.
  72800. **
  72801. ** Usage:
  72802. **
  72803. ** assert( checkSavepointCount(db) );
  72804. */
  72805. static int checkSavepointCount(sqlite3 *db){
  72806. int n = 0;
  72807. Savepoint *p;
  72808. for(p=db->pSavepoint; p; p=p->pNext) n++;
  72809. assert( n==(db->nSavepoint + db->isTransactionSavepoint) );
  72810. return 1;
  72811. }
  72812. #endif
  72813. /*
  72814. ** Return the register of pOp->p2 after first preparing it to be
  72815. ** overwritten with an integer value.
  72816. */
  72817. static SQLITE_NOINLINE Mem *out2PrereleaseWithClear(Mem *pOut){
  72818. sqlite3VdbeMemSetNull(pOut);
  72819. pOut->flags = MEM_Int;
  72820. return pOut;
  72821. }
  72822. static Mem *out2Prerelease(Vdbe *p, VdbeOp *pOp){
  72823. Mem *pOut;
  72824. assert( pOp->p2>0 );
  72825. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  72826. pOut = &p->aMem[pOp->p2];
  72827. memAboutToChange(p, pOut);
  72828. if( VdbeMemDynamic(pOut) ){ /*OPTIMIZATION-IF-FALSE*/
  72829. return out2PrereleaseWithClear(pOut);
  72830. }else{
  72831. pOut->flags = MEM_Int;
  72832. return pOut;
  72833. }
  72834. }
  72835. /*
  72836. ** Execute as much of a VDBE program as we can.
  72837. ** This is the core of sqlite3_step().
  72838. */
  72839. SQLITE_PRIVATE int sqlite3VdbeExec(
  72840. Vdbe *p /* The VDBE */
  72841. ){
  72842. Op *aOp = p->aOp; /* Copy of p->aOp */
  72843. Op *pOp = aOp; /* Current operation */
  72844. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  72845. Op *pOrigOp; /* Value of pOp at the top of the loop */
  72846. #endif
  72847. #ifdef SQLITE_DEBUG
  72848. int nExtraDelete = 0; /* Verifies FORDELETE and AUXDELETE flags */
  72849. #endif
  72850. int rc = SQLITE_OK; /* Value to return */
  72851. sqlite3 *db = p->db; /* The database */
  72852. u8 resetSchemaOnFault = 0; /* Reset schema after an error if positive */
  72853. u8 encoding = ENC(db); /* The database encoding */
  72854. int iCompare = 0; /* Result of last comparison */
  72855. unsigned nVmStep = 0; /* Number of virtual machine steps */
  72856. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  72857. unsigned nProgressLimit = 0;/* Invoke xProgress() when nVmStep reaches this */
  72858. #endif
  72859. Mem *aMem = p->aMem; /* Copy of p->aMem */
  72860. Mem *pIn1 = 0; /* 1st input operand */
  72861. Mem *pIn2 = 0; /* 2nd input operand */
  72862. Mem *pIn3 = 0; /* 3rd input operand */
  72863. Mem *pOut = 0; /* Output operand */
  72864. int *aPermute = 0; /* Permutation of columns for OP_Compare */
  72865. i64 lastRowid = db->lastRowid; /* Saved value of the last insert ROWID */
  72866. #ifdef VDBE_PROFILE
  72867. u64 start; /* CPU clock count at start of opcode */
  72868. #endif
  72869. /*** INSERT STACK UNION HERE ***/
  72870. assert( p->magic==VDBE_MAGIC_RUN ); /* sqlite3_step() verifies this */
  72871. sqlite3VdbeEnter(p);
  72872. if( p->rc==SQLITE_NOMEM ){
  72873. /* This happens if a malloc() inside a call to sqlite3_column_text() or
  72874. ** sqlite3_column_text16() failed. */
  72875. goto no_mem;
  72876. }
  72877. assert( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_BUSY );
  72878. assert( p->bIsReader || p->readOnly!=0 );
  72879. p->rc = SQLITE_OK;
  72880. p->iCurrentTime = 0;
  72881. assert( p->explain==0 );
  72882. p->pResultSet = 0;
  72883. db->busyHandler.nBusy = 0;
  72884. if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
  72885. sqlite3VdbeIOTraceSql(p);
  72886. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  72887. if( db->xProgress ){
  72888. u32 iPrior = p->aCounter[SQLITE_STMTSTATUS_VM_STEP];
  72889. assert( 0 < db->nProgressOps );
  72890. nProgressLimit = db->nProgressOps - (iPrior % db->nProgressOps);
  72891. }
  72892. #endif
  72893. #ifdef SQLITE_DEBUG
  72894. sqlite3BeginBenignMalloc();
  72895. if( p->pc==0
  72896. && (p->db->flags & (SQLITE_VdbeListing|SQLITE_VdbeEQP|SQLITE_VdbeTrace))!=0
  72897. ){
  72898. int i;
  72899. int once = 1;
  72900. sqlite3VdbePrintSql(p);
  72901. if( p->db->flags & SQLITE_VdbeListing ){
  72902. printf("VDBE Program Listing:\n");
  72903. for(i=0; i<p->nOp; i++){
  72904. sqlite3VdbePrintOp(stdout, i, &aOp[i]);
  72905. }
  72906. }
  72907. if( p->db->flags & SQLITE_VdbeEQP ){
  72908. for(i=0; i<p->nOp; i++){
  72909. if( aOp[i].opcode==OP_Explain ){
  72910. if( once ) printf("VDBE Query Plan:\n");
  72911. printf("%s\n", aOp[i].p4.z);
  72912. once = 0;
  72913. }
  72914. }
  72915. }
  72916. if( p->db->flags & SQLITE_VdbeTrace ) printf("VDBE Trace:\n");
  72917. }
  72918. sqlite3EndBenignMalloc();
  72919. #endif
  72920. for(pOp=&aOp[p->pc]; 1; pOp++){
  72921. /* Errors are detected by individual opcodes, with an immediate
  72922. ** jumps to abort_due_to_error. */
  72923. assert( rc==SQLITE_OK );
  72924. assert( pOp>=aOp && pOp<&aOp[p->nOp]);
  72925. #ifdef VDBE_PROFILE
  72926. start = sqlite3Hwtime();
  72927. #endif
  72928. nVmStep++;
  72929. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  72930. if( p->anExec ) p->anExec[(int)(pOp-aOp)]++;
  72931. #endif
  72932. /* Only allow tracing if SQLITE_DEBUG is defined.
  72933. */
  72934. #ifdef SQLITE_DEBUG
  72935. if( db->flags & SQLITE_VdbeTrace ){
  72936. sqlite3VdbePrintOp(stdout, (int)(pOp - aOp), pOp);
  72937. }
  72938. #endif
  72939. /* Check to see if we need to simulate an interrupt. This only happens
  72940. ** if we have a special test build.
  72941. */
  72942. #ifdef SQLITE_TEST
  72943. if( sqlite3_interrupt_count>0 ){
  72944. sqlite3_interrupt_count--;
  72945. if( sqlite3_interrupt_count==0 ){
  72946. sqlite3_interrupt(db);
  72947. }
  72948. }
  72949. #endif
  72950. /* Sanity checking on other operands */
  72951. #ifdef SQLITE_DEBUG
  72952. {
  72953. u8 opProperty = sqlite3OpcodeProperty[pOp->opcode];
  72954. if( (opProperty & OPFLG_IN1)!=0 ){
  72955. assert( pOp->p1>0 );
  72956. assert( pOp->p1<=(p->nMem+1 - p->nCursor) );
  72957. assert( memIsValid(&aMem[pOp->p1]) );
  72958. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p1]) );
  72959. REGISTER_TRACE(pOp->p1, &aMem[pOp->p1]);
  72960. }
  72961. if( (opProperty & OPFLG_IN2)!=0 ){
  72962. assert( pOp->p2>0 );
  72963. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  72964. assert( memIsValid(&aMem[pOp->p2]) );
  72965. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p2]) );
  72966. REGISTER_TRACE(pOp->p2, &aMem[pOp->p2]);
  72967. }
  72968. if( (opProperty & OPFLG_IN3)!=0 ){
  72969. assert( pOp->p3>0 );
  72970. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  72971. assert( memIsValid(&aMem[pOp->p3]) );
  72972. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p3]) );
  72973. REGISTER_TRACE(pOp->p3, &aMem[pOp->p3]);
  72974. }
  72975. if( (opProperty & OPFLG_OUT2)!=0 ){
  72976. assert( pOp->p2>0 );
  72977. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  72978. memAboutToChange(p, &aMem[pOp->p2]);
  72979. }
  72980. if( (opProperty & OPFLG_OUT3)!=0 ){
  72981. assert( pOp->p3>0 );
  72982. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  72983. memAboutToChange(p, &aMem[pOp->p3]);
  72984. }
  72985. }
  72986. #endif
  72987. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  72988. pOrigOp = pOp;
  72989. #endif
  72990. switch( pOp->opcode ){
  72991. /*****************************************************************************
  72992. ** What follows is a massive switch statement where each case implements a
  72993. ** separate instruction in the virtual machine. If we follow the usual
  72994. ** indentation conventions, each case should be indented by 6 spaces. But
  72995. ** that is a lot of wasted space on the left margin. So the code within
  72996. ** the switch statement will break with convention and be flush-left. Another
  72997. ** big comment (similar to this one) will mark the point in the code where
  72998. ** we transition back to normal indentation.
  72999. **
  73000. ** The formatting of each case is important. The makefile for SQLite
  73001. ** generates two C files "opcodes.h" and "opcodes.c" by scanning this
  73002. ** file looking for lines that begin with "case OP_". The opcodes.h files
  73003. ** will be filled with #defines that give unique integer values to each
  73004. ** opcode and the opcodes.c file is filled with an array of strings where
  73005. ** each string is the symbolic name for the corresponding opcode. If the
  73006. ** case statement is followed by a comment of the form "/# same as ... #/"
  73007. ** that comment is used to determine the particular value of the opcode.
  73008. **
  73009. ** Other keywords in the comment that follows each case are used to
  73010. ** construct the OPFLG_INITIALIZER value that initializes opcodeProperty[].
  73011. ** Keywords include: in1, in2, in3, out2, out3. See
  73012. ** the mkopcodeh.awk script for additional information.
  73013. **
  73014. ** Documentation about VDBE opcodes is generated by scanning this file
  73015. ** for lines of that contain "Opcode:". That line and all subsequent
  73016. ** comment lines are used in the generation of the opcode.html documentation
  73017. ** file.
  73018. **
  73019. ** SUMMARY:
  73020. **
  73021. ** Formatting is important to scripts that scan this file.
  73022. ** Do not deviate from the formatting style currently in use.
  73023. **
  73024. *****************************************************************************/
  73025. /* Opcode: Goto * P2 * * *
  73026. **
  73027. ** An unconditional jump to address P2.
  73028. ** The next instruction executed will be
  73029. ** the one at index P2 from the beginning of
  73030. ** the program.
  73031. **
  73032. ** The P1 parameter is not actually used by this opcode. However, it
  73033. ** is sometimes set to 1 instead of 0 as a hint to the command-line shell
  73034. ** that this Goto is the bottom of a loop and that the lines from P2 down
  73035. ** to the current line should be indented for EXPLAIN output.
  73036. */
  73037. case OP_Goto: { /* jump */
  73038. jump_to_p2_and_check_for_interrupt:
  73039. pOp = &aOp[pOp->p2 - 1];
  73040. /* Opcodes that are used as the bottom of a loop (OP_Next, OP_Prev,
  73041. ** OP_VNext, OP_RowSetNext, or OP_SorterNext) all jump here upon
  73042. ** completion. Check to see if sqlite3_interrupt() has been called
  73043. ** or if the progress callback needs to be invoked.
  73044. **
  73045. ** This code uses unstructured "goto" statements and does not look clean.
  73046. ** But that is not due to sloppy coding habits. The code is written this
  73047. ** way for performance, to avoid having to run the interrupt and progress
  73048. ** checks on every opcode. This helps sqlite3_step() to run about 1.5%
  73049. ** faster according to "valgrind --tool=cachegrind" */
  73050. check_for_interrupt:
  73051. if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
  73052. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  73053. /* Call the progress callback if it is configured and the required number
  73054. ** of VDBE ops have been executed (either since this invocation of
  73055. ** sqlite3VdbeExec() or since last time the progress callback was called).
  73056. ** If the progress callback returns non-zero, exit the virtual machine with
  73057. ** a return code SQLITE_ABORT.
  73058. */
  73059. if( db->xProgress!=0 && nVmStep>=nProgressLimit ){
  73060. assert( db->nProgressOps!=0 );
  73061. nProgressLimit = nVmStep + db->nProgressOps - (nVmStep%db->nProgressOps);
  73062. if( db->xProgress(db->pProgressArg) ){
  73063. rc = SQLITE_INTERRUPT;
  73064. goto abort_due_to_error;
  73065. }
  73066. }
  73067. #endif
  73068. break;
  73069. }
  73070. /* Opcode: Gosub P1 P2 * * *
  73071. **
  73072. ** Write the current address onto register P1
  73073. ** and then jump to address P2.
  73074. */
  73075. case OP_Gosub: { /* jump */
  73076. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  73077. pIn1 = &aMem[pOp->p1];
  73078. assert( VdbeMemDynamic(pIn1)==0 );
  73079. memAboutToChange(p, pIn1);
  73080. pIn1->flags = MEM_Int;
  73081. pIn1->u.i = (int)(pOp-aOp);
  73082. REGISTER_TRACE(pOp->p1, pIn1);
  73083. /* Most jump operations do a goto to this spot in order to update
  73084. ** the pOp pointer. */
  73085. jump_to_p2:
  73086. pOp = &aOp[pOp->p2 - 1];
  73087. break;
  73088. }
  73089. /* Opcode: Return P1 * * * *
  73090. **
  73091. ** Jump to the next instruction after the address in register P1. After
  73092. ** the jump, register P1 becomes undefined.
  73093. */
  73094. case OP_Return: { /* in1 */
  73095. pIn1 = &aMem[pOp->p1];
  73096. assert( pIn1->flags==MEM_Int );
  73097. pOp = &aOp[pIn1->u.i];
  73098. pIn1->flags = MEM_Undefined;
  73099. break;
  73100. }
  73101. /* Opcode: InitCoroutine P1 P2 P3 * *
  73102. **
  73103. ** Set up register P1 so that it will Yield to the coroutine
  73104. ** located at address P3.
  73105. **
  73106. ** If P2!=0 then the coroutine implementation immediately follows
  73107. ** this opcode. So jump over the coroutine implementation to
  73108. ** address P2.
  73109. **
  73110. ** See also: EndCoroutine
  73111. */
  73112. case OP_InitCoroutine: { /* jump */
  73113. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  73114. assert( pOp->p2>=0 && pOp->p2<p->nOp );
  73115. assert( pOp->p3>=0 && pOp->p3<p->nOp );
  73116. pOut = &aMem[pOp->p1];
  73117. assert( !VdbeMemDynamic(pOut) );
  73118. pOut->u.i = pOp->p3 - 1;
  73119. pOut->flags = MEM_Int;
  73120. if( pOp->p2 ) goto jump_to_p2;
  73121. break;
  73122. }
  73123. /* Opcode: EndCoroutine P1 * * * *
  73124. **
  73125. ** The instruction at the address in register P1 is a Yield.
  73126. ** Jump to the P2 parameter of that Yield.
  73127. ** After the jump, register P1 becomes undefined.
  73128. **
  73129. ** See also: InitCoroutine
  73130. */
  73131. case OP_EndCoroutine: { /* in1 */
  73132. VdbeOp *pCaller;
  73133. pIn1 = &aMem[pOp->p1];
  73134. assert( pIn1->flags==MEM_Int );
  73135. assert( pIn1->u.i>=0 && pIn1->u.i<p->nOp );
  73136. pCaller = &aOp[pIn1->u.i];
  73137. assert( pCaller->opcode==OP_Yield );
  73138. assert( pCaller->p2>=0 && pCaller->p2<p->nOp );
  73139. pOp = &aOp[pCaller->p2 - 1];
  73140. pIn1->flags = MEM_Undefined;
  73141. break;
  73142. }
  73143. /* Opcode: Yield P1 P2 * * *
  73144. **
  73145. ** Swap the program counter with the value in register P1. This
  73146. ** has the effect of yielding to a coroutine.
  73147. **
  73148. ** If the coroutine that is launched by this instruction ends with
  73149. ** Yield or Return then continue to the next instruction. But if
  73150. ** the coroutine launched by this instruction ends with
  73151. ** EndCoroutine, then jump to P2 rather than continuing with the
  73152. ** next instruction.
  73153. **
  73154. ** See also: InitCoroutine
  73155. */
  73156. case OP_Yield: { /* in1, jump */
  73157. int pcDest;
  73158. pIn1 = &aMem[pOp->p1];
  73159. assert( VdbeMemDynamic(pIn1)==0 );
  73160. pIn1->flags = MEM_Int;
  73161. pcDest = (int)pIn1->u.i;
  73162. pIn1->u.i = (int)(pOp - aOp);
  73163. REGISTER_TRACE(pOp->p1, pIn1);
  73164. pOp = &aOp[pcDest];
  73165. break;
  73166. }
  73167. /* Opcode: HaltIfNull P1 P2 P3 P4 P5
  73168. ** Synopsis: if r[P3]=null halt
  73169. **
  73170. ** Check the value in register P3. If it is NULL then Halt using
  73171. ** parameter P1, P2, and P4 as if this were a Halt instruction. If the
  73172. ** value in register P3 is not NULL, then this routine is a no-op.
  73173. ** The P5 parameter should be 1.
  73174. */
  73175. case OP_HaltIfNull: { /* in3 */
  73176. pIn3 = &aMem[pOp->p3];
  73177. if( (pIn3->flags & MEM_Null)==0 ) break;
  73178. /* Fall through into OP_Halt */
  73179. }
  73180. /* Opcode: Halt P1 P2 * P4 P5
  73181. **
  73182. ** Exit immediately. All open cursors, etc are closed
  73183. ** automatically.
  73184. **
  73185. ** P1 is the result code returned by sqlite3_exec(), sqlite3_reset(),
  73186. ** or sqlite3_finalize(). For a normal halt, this should be SQLITE_OK (0).
  73187. ** For errors, it can be some other value. If P1!=0 then P2 will determine
  73188. ** whether or not to rollback the current transaction. Do not rollback
  73189. ** if P2==OE_Fail. Do the rollback if P2==OE_Rollback. If P2==OE_Abort,
  73190. ** then back out all changes that have occurred during this execution of the
  73191. ** VDBE, but do not rollback the transaction.
  73192. **
  73193. ** If P4 is not null then it is an error message string.
  73194. **
  73195. ** P5 is a value between 0 and 4, inclusive, that modifies the P4 string.
  73196. **
  73197. ** 0: (no change)
  73198. ** 1: NOT NULL contraint failed: P4
  73199. ** 2: UNIQUE constraint failed: P4
  73200. ** 3: CHECK constraint failed: P4
  73201. ** 4: FOREIGN KEY constraint failed: P4
  73202. **
  73203. ** If P5 is not zero and P4 is NULL, then everything after the ":" is
  73204. ** omitted.
  73205. **
  73206. ** There is an implied "Halt 0 0 0" instruction inserted at the very end of
  73207. ** every program. So a jump past the last instruction of the program
  73208. ** is the same as executing Halt.
  73209. */
  73210. case OP_Halt: {
  73211. VdbeFrame *pFrame;
  73212. int pcx;
  73213. pcx = (int)(pOp - aOp);
  73214. if( pOp->p1==SQLITE_OK && p->pFrame ){
  73215. /* Halt the sub-program. Return control to the parent frame. */
  73216. pFrame = p->pFrame;
  73217. p->pFrame = pFrame->pParent;
  73218. p->nFrame--;
  73219. sqlite3VdbeSetChanges(db, p->nChange);
  73220. pcx = sqlite3VdbeFrameRestore(pFrame);
  73221. lastRowid = db->lastRowid;
  73222. if( pOp->p2==OE_Ignore ){
  73223. /* Instruction pcx is the OP_Program that invoked the sub-program
  73224. ** currently being halted. If the p2 instruction of this OP_Halt
  73225. ** instruction is set to OE_Ignore, then the sub-program is throwing
  73226. ** an IGNORE exception. In this case jump to the address specified
  73227. ** as the p2 of the calling OP_Program. */
  73228. pcx = p->aOp[pcx].p2-1;
  73229. }
  73230. aOp = p->aOp;
  73231. aMem = p->aMem;
  73232. pOp = &aOp[pcx];
  73233. break;
  73234. }
  73235. p->rc = pOp->p1;
  73236. p->errorAction = (u8)pOp->p2;
  73237. p->pc = pcx;
  73238. assert( pOp->p5>=0 && pOp->p5<=4 );
  73239. if( p->rc ){
  73240. if( pOp->p5 ){
  73241. static const char * const azType[] = { "NOT NULL", "UNIQUE", "CHECK",
  73242. "FOREIGN KEY" };
  73243. testcase( pOp->p5==1 );
  73244. testcase( pOp->p5==2 );
  73245. testcase( pOp->p5==3 );
  73246. testcase( pOp->p5==4 );
  73247. sqlite3VdbeError(p, "%s constraint failed", azType[pOp->p5-1]);
  73248. if( pOp->p4.z ){
  73249. p->zErrMsg = sqlite3MPrintf(db, "%z: %s", p->zErrMsg, pOp->p4.z);
  73250. }
  73251. }else{
  73252. sqlite3VdbeError(p, "%s", pOp->p4.z);
  73253. }
  73254. sqlite3_log(pOp->p1, "abort at %d in [%s]: %s", pcx, p->zSql, p->zErrMsg);
  73255. }
  73256. rc = sqlite3VdbeHalt(p);
  73257. assert( rc==SQLITE_BUSY || rc==SQLITE_OK || rc==SQLITE_ERROR );
  73258. if( rc==SQLITE_BUSY ){
  73259. p->rc = SQLITE_BUSY;
  73260. }else{
  73261. assert( rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT );
  73262. assert( rc==SQLITE_OK || db->nDeferredCons>0 || db->nDeferredImmCons>0 );
  73263. rc = p->rc ? SQLITE_ERROR : SQLITE_DONE;
  73264. }
  73265. goto vdbe_return;
  73266. }
  73267. /* Opcode: Integer P1 P2 * * *
  73268. ** Synopsis: r[P2]=P1
  73269. **
  73270. ** The 32-bit integer value P1 is written into register P2.
  73271. */
  73272. case OP_Integer: { /* out2 */
  73273. pOut = out2Prerelease(p, pOp);
  73274. pOut->u.i = pOp->p1;
  73275. break;
  73276. }
  73277. /* Opcode: Int64 * P2 * P4 *
  73278. ** Synopsis: r[P2]=P4
  73279. **
  73280. ** P4 is a pointer to a 64-bit integer value.
  73281. ** Write that value into register P2.
  73282. */
  73283. case OP_Int64: { /* out2 */
  73284. pOut = out2Prerelease(p, pOp);
  73285. assert( pOp->p4.pI64!=0 );
  73286. pOut->u.i = *pOp->p4.pI64;
  73287. break;
  73288. }
  73289. #ifndef SQLITE_OMIT_FLOATING_POINT
  73290. /* Opcode: Real * P2 * P4 *
  73291. ** Synopsis: r[P2]=P4
  73292. **
  73293. ** P4 is a pointer to a 64-bit floating point value.
  73294. ** Write that value into register P2.
  73295. */
  73296. case OP_Real: { /* same as TK_FLOAT, out2 */
  73297. pOut = out2Prerelease(p, pOp);
  73298. pOut->flags = MEM_Real;
  73299. assert( !sqlite3IsNaN(*pOp->p4.pReal) );
  73300. pOut->u.r = *pOp->p4.pReal;
  73301. break;
  73302. }
  73303. #endif
  73304. /* Opcode: String8 * P2 * P4 *
  73305. ** Synopsis: r[P2]='P4'
  73306. **
  73307. ** P4 points to a nul terminated UTF-8 string. This opcode is transformed
  73308. ** into a String opcode before it is executed for the first time. During
  73309. ** this transformation, the length of string P4 is computed and stored
  73310. ** as the P1 parameter.
  73311. */
  73312. case OP_String8: { /* same as TK_STRING, out2 */
  73313. assert( pOp->p4.z!=0 );
  73314. pOut = out2Prerelease(p, pOp);
  73315. pOp->opcode = OP_String;
  73316. pOp->p1 = sqlite3Strlen30(pOp->p4.z);
  73317. #ifndef SQLITE_OMIT_UTF16
  73318. if( encoding!=SQLITE_UTF8 ){
  73319. rc = sqlite3VdbeMemSetStr(pOut, pOp->p4.z, -1, SQLITE_UTF8, SQLITE_STATIC);
  73320. assert( rc==SQLITE_OK || rc==SQLITE_TOOBIG );
  73321. if( SQLITE_OK!=sqlite3VdbeChangeEncoding(pOut, encoding) ) goto no_mem;
  73322. assert( pOut->szMalloc>0 && pOut->zMalloc==pOut->z );
  73323. assert( VdbeMemDynamic(pOut)==0 );
  73324. pOut->szMalloc = 0;
  73325. pOut->flags |= MEM_Static;
  73326. if( pOp->p4type==P4_DYNAMIC ){
  73327. sqlite3DbFree(db, pOp->p4.z);
  73328. }
  73329. pOp->p4type = P4_DYNAMIC;
  73330. pOp->p4.z = pOut->z;
  73331. pOp->p1 = pOut->n;
  73332. }
  73333. testcase( rc==SQLITE_TOOBIG );
  73334. #endif
  73335. if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  73336. goto too_big;
  73337. }
  73338. assert( rc==SQLITE_OK );
  73339. /* Fall through to the next case, OP_String */
  73340. }
  73341. /* Opcode: String P1 P2 P3 P4 P5
  73342. ** Synopsis: r[P2]='P4' (len=P1)
  73343. **
  73344. ** The string value P4 of length P1 (bytes) is stored in register P2.
  73345. **
  73346. ** If P3 is not zero and the content of register P3 is equal to P5, then
  73347. ** the datatype of the register P2 is converted to BLOB. The content is
  73348. ** the same sequence of bytes, it is merely interpreted as a BLOB instead
  73349. ** of a string, as if it had been CAST. In other words:
  73350. **
  73351. ** if( P3!=0 and reg[P3]==P5 ) reg[P2] := CAST(reg[P2] as BLOB)
  73352. */
  73353. case OP_String: { /* out2 */
  73354. assert( pOp->p4.z!=0 );
  73355. pOut = out2Prerelease(p, pOp);
  73356. pOut->flags = MEM_Str|MEM_Static|MEM_Term;
  73357. pOut->z = pOp->p4.z;
  73358. pOut->n = pOp->p1;
  73359. pOut->enc = encoding;
  73360. UPDATE_MAX_BLOBSIZE(pOut);
  73361. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  73362. if( pOp->p3>0 ){
  73363. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  73364. pIn3 = &aMem[pOp->p3];
  73365. assert( pIn3->flags & MEM_Int );
  73366. if( pIn3->u.i==pOp->p5 ) pOut->flags = MEM_Blob|MEM_Static|MEM_Term;
  73367. }
  73368. #endif
  73369. break;
  73370. }
  73371. /* Opcode: Null P1 P2 P3 * *
  73372. ** Synopsis: r[P2..P3]=NULL
  73373. **
  73374. ** Write a NULL into registers P2. If P3 greater than P2, then also write
  73375. ** NULL into register P3 and every register in between P2 and P3. If P3
  73376. ** is less than P2 (typically P3 is zero) then only register P2 is
  73377. ** set to NULL.
  73378. **
  73379. ** If the P1 value is non-zero, then also set the MEM_Cleared flag so that
  73380. ** NULL values will not compare equal even if SQLITE_NULLEQ is set on
  73381. ** OP_Ne or OP_Eq.
  73382. */
  73383. case OP_Null: { /* out2 */
  73384. int cnt;
  73385. u16 nullFlag;
  73386. pOut = out2Prerelease(p, pOp);
  73387. cnt = pOp->p3-pOp->p2;
  73388. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  73389. pOut->flags = nullFlag = pOp->p1 ? (MEM_Null|MEM_Cleared) : MEM_Null;
  73390. pOut->n = 0;
  73391. while( cnt>0 ){
  73392. pOut++;
  73393. memAboutToChange(p, pOut);
  73394. sqlite3VdbeMemSetNull(pOut);
  73395. pOut->flags = nullFlag;
  73396. pOut->n = 0;
  73397. cnt--;
  73398. }
  73399. break;
  73400. }
  73401. /* Opcode: SoftNull P1 * * * *
  73402. ** Synopsis: r[P1]=NULL
  73403. **
  73404. ** Set register P1 to have the value NULL as seen by the OP_MakeRecord
  73405. ** instruction, but do not free any string or blob memory associated with
  73406. ** the register, so that if the value was a string or blob that was
  73407. ** previously copied using OP_SCopy, the copies will continue to be valid.
  73408. */
  73409. case OP_SoftNull: {
  73410. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  73411. pOut = &aMem[pOp->p1];
  73412. pOut->flags = (pOut->flags|MEM_Null)&~MEM_Undefined;
  73413. break;
  73414. }
  73415. /* Opcode: Blob P1 P2 * P4 *
  73416. ** Synopsis: r[P2]=P4 (len=P1)
  73417. **
  73418. ** P4 points to a blob of data P1 bytes long. Store this
  73419. ** blob in register P2.
  73420. */
  73421. case OP_Blob: { /* out2 */
  73422. assert( pOp->p1 <= SQLITE_MAX_LENGTH );
  73423. pOut = out2Prerelease(p, pOp);
  73424. sqlite3VdbeMemSetStr(pOut, pOp->p4.z, pOp->p1, 0, 0);
  73425. pOut->enc = encoding;
  73426. UPDATE_MAX_BLOBSIZE(pOut);
  73427. break;
  73428. }
  73429. /* Opcode: Variable P1 P2 * P4 *
  73430. ** Synopsis: r[P2]=parameter(P1,P4)
  73431. **
  73432. ** Transfer the values of bound parameter P1 into register P2
  73433. **
  73434. ** If the parameter is named, then its name appears in P4.
  73435. ** The P4 value is used by sqlite3_bind_parameter_name().
  73436. */
  73437. case OP_Variable: { /* out2 */
  73438. Mem *pVar; /* Value being transferred */
  73439. assert( pOp->p1>0 && pOp->p1<=p->nVar );
  73440. assert( pOp->p4.z==0 || pOp->p4.z==p->azVar[pOp->p1-1] );
  73441. pVar = &p->aVar[pOp->p1 - 1];
  73442. if( sqlite3VdbeMemTooBig(pVar) ){
  73443. goto too_big;
  73444. }
  73445. pOut = out2Prerelease(p, pOp);
  73446. sqlite3VdbeMemShallowCopy(pOut, pVar, MEM_Static);
  73447. UPDATE_MAX_BLOBSIZE(pOut);
  73448. break;
  73449. }
  73450. /* Opcode: Move P1 P2 P3 * *
  73451. ** Synopsis: r[P2@P3]=r[P1@P3]
  73452. **
  73453. ** Move the P3 values in register P1..P1+P3-1 over into
  73454. ** registers P2..P2+P3-1. Registers P1..P1+P3-1 are
  73455. ** left holding a NULL. It is an error for register ranges
  73456. ** P1..P1+P3-1 and P2..P2+P3-1 to overlap. It is an error
  73457. ** for P3 to be less than 1.
  73458. */
  73459. case OP_Move: {
  73460. int n; /* Number of registers left to copy */
  73461. int p1; /* Register to copy from */
  73462. int p2; /* Register to copy to */
  73463. n = pOp->p3;
  73464. p1 = pOp->p1;
  73465. p2 = pOp->p2;
  73466. assert( n>0 && p1>0 && p2>0 );
  73467. assert( p1+n<=p2 || p2+n<=p1 );
  73468. pIn1 = &aMem[p1];
  73469. pOut = &aMem[p2];
  73470. do{
  73471. assert( pOut<=&aMem[(p->nMem+1 - p->nCursor)] );
  73472. assert( pIn1<=&aMem[(p->nMem+1 - p->nCursor)] );
  73473. assert( memIsValid(pIn1) );
  73474. memAboutToChange(p, pOut);
  73475. sqlite3VdbeMemMove(pOut, pIn1);
  73476. #ifdef SQLITE_DEBUG
  73477. if( pOut->pScopyFrom>=&aMem[p1] && pOut->pScopyFrom<pOut ){
  73478. pOut->pScopyFrom += pOp->p2 - p1;
  73479. }
  73480. #endif
  73481. Deephemeralize(pOut);
  73482. REGISTER_TRACE(p2++, pOut);
  73483. pIn1++;
  73484. pOut++;
  73485. }while( --n );
  73486. break;
  73487. }
  73488. /* Opcode: Copy P1 P2 P3 * *
  73489. ** Synopsis: r[P2@P3+1]=r[P1@P3+1]
  73490. **
  73491. ** Make a copy of registers P1..P1+P3 into registers P2..P2+P3.
  73492. **
  73493. ** This instruction makes a deep copy of the value. A duplicate
  73494. ** is made of any string or blob constant. See also OP_SCopy.
  73495. */
  73496. case OP_Copy: {
  73497. int n;
  73498. n = pOp->p3;
  73499. pIn1 = &aMem[pOp->p1];
  73500. pOut = &aMem[pOp->p2];
  73501. assert( pOut!=pIn1 );
  73502. while( 1 ){
  73503. sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
  73504. Deephemeralize(pOut);
  73505. #ifdef SQLITE_DEBUG
  73506. pOut->pScopyFrom = 0;
  73507. #endif
  73508. REGISTER_TRACE(pOp->p2+pOp->p3-n, pOut);
  73509. if( (n--)==0 ) break;
  73510. pOut++;
  73511. pIn1++;
  73512. }
  73513. break;
  73514. }
  73515. /* Opcode: SCopy P1 P2 * * *
  73516. ** Synopsis: r[P2]=r[P1]
  73517. **
  73518. ** Make a shallow copy of register P1 into register P2.
  73519. **
  73520. ** This instruction makes a shallow copy of the value. If the value
  73521. ** is a string or blob, then the copy is only a pointer to the
  73522. ** original and hence if the original changes so will the copy.
  73523. ** Worse, if the original is deallocated, the copy becomes invalid.
  73524. ** Thus the program must guarantee that the original will not change
  73525. ** during the lifetime of the copy. Use OP_Copy to make a complete
  73526. ** copy.
  73527. */
  73528. case OP_SCopy: { /* out2 */
  73529. pIn1 = &aMem[pOp->p1];
  73530. pOut = &aMem[pOp->p2];
  73531. assert( pOut!=pIn1 );
  73532. sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
  73533. #ifdef SQLITE_DEBUG
  73534. if( pOut->pScopyFrom==0 ) pOut->pScopyFrom = pIn1;
  73535. #endif
  73536. break;
  73537. }
  73538. /* Opcode: IntCopy P1 P2 * * *
  73539. ** Synopsis: r[P2]=r[P1]
  73540. **
  73541. ** Transfer the integer value held in register P1 into register P2.
  73542. **
  73543. ** This is an optimized version of SCopy that works only for integer
  73544. ** values.
  73545. */
  73546. case OP_IntCopy: { /* out2 */
  73547. pIn1 = &aMem[pOp->p1];
  73548. assert( (pIn1->flags & MEM_Int)!=0 );
  73549. pOut = &aMem[pOp->p2];
  73550. sqlite3VdbeMemSetInt64(pOut, pIn1->u.i);
  73551. break;
  73552. }
  73553. /* Opcode: ResultRow P1 P2 * * *
  73554. ** Synopsis: output=r[P1@P2]
  73555. **
  73556. ** The registers P1 through P1+P2-1 contain a single row of
  73557. ** results. This opcode causes the sqlite3_step() call to terminate
  73558. ** with an SQLITE_ROW return code and it sets up the sqlite3_stmt
  73559. ** structure to provide access to the r(P1)..r(P1+P2-1) values as
  73560. ** the result row.
  73561. */
  73562. case OP_ResultRow: {
  73563. Mem *pMem;
  73564. int i;
  73565. assert( p->nResColumn==pOp->p2 );
  73566. assert( pOp->p1>0 );
  73567. assert( pOp->p1+pOp->p2<=(p->nMem+1 - p->nCursor)+1 );
  73568. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  73569. /* Run the progress counter just before returning.
  73570. */
  73571. if( db->xProgress!=0
  73572. && nVmStep>=nProgressLimit
  73573. && db->xProgress(db->pProgressArg)!=0
  73574. ){
  73575. rc = SQLITE_INTERRUPT;
  73576. goto abort_due_to_error;
  73577. }
  73578. #endif
  73579. /* If this statement has violated immediate foreign key constraints, do
  73580. ** not return the number of rows modified. And do not RELEASE the statement
  73581. ** transaction. It needs to be rolled back. */
  73582. if( SQLITE_OK!=(rc = sqlite3VdbeCheckFk(p, 0)) ){
  73583. assert( db->flags&SQLITE_CountRows );
  73584. assert( p->usesStmtJournal );
  73585. goto abort_due_to_error;
  73586. }
  73587. /* If the SQLITE_CountRows flag is set in sqlite3.flags mask, then
  73588. ** DML statements invoke this opcode to return the number of rows
  73589. ** modified to the user. This is the only way that a VM that
  73590. ** opens a statement transaction may invoke this opcode.
  73591. **
  73592. ** In case this is such a statement, close any statement transaction
  73593. ** opened by this VM before returning control to the user. This is to
  73594. ** ensure that statement-transactions are always nested, not overlapping.
  73595. ** If the open statement-transaction is not closed here, then the user
  73596. ** may step another VM that opens its own statement transaction. This
  73597. ** may lead to overlapping statement transactions.
  73598. **
  73599. ** The statement transaction is never a top-level transaction. Hence
  73600. ** the RELEASE call below can never fail.
  73601. */
  73602. assert( p->iStatement==0 || db->flags&SQLITE_CountRows );
  73603. rc = sqlite3VdbeCloseStatement(p, SAVEPOINT_RELEASE);
  73604. assert( rc==SQLITE_OK );
  73605. /* Invalidate all ephemeral cursor row caches */
  73606. p->cacheCtr = (p->cacheCtr + 2)|1;
  73607. /* Make sure the results of the current row are \000 terminated
  73608. ** and have an assigned type. The results are de-ephemeralized as
  73609. ** a side effect.
  73610. */
  73611. pMem = p->pResultSet = &aMem[pOp->p1];
  73612. for(i=0; i<pOp->p2; i++){
  73613. assert( memIsValid(&pMem[i]) );
  73614. Deephemeralize(&pMem[i]);
  73615. assert( (pMem[i].flags & MEM_Ephem)==0
  73616. || (pMem[i].flags & (MEM_Str|MEM_Blob))==0 );
  73617. sqlite3VdbeMemNulTerminate(&pMem[i]);
  73618. REGISTER_TRACE(pOp->p1+i, &pMem[i]);
  73619. }
  73620. if( db->mallocFailed ) goto no_mem;
  73621. if( db->mTrace & SQLITE_TRACE_ROW ){
  73622. db->xTrace(SQLITE_TRACE_ROW, db->pTraceArg, p, 0);
  73623. }
  73624. /* Return SQLITE_ROW
  73625. */
  73626. p->pc = (int)(pOp - aOp) + 1;
  73627. rc = SQLITE_ROW;
  73628. goto vdbe_return;
  73629. }
  73630. /* Opcode: Concat P1 P2 P3 * *
  73631. ** Synopsis: r[P3]=r[P2]+r[P1]
  73632. **
  73633. ** Add the text in register P1 onto the end of the text in
  73634. ** register P2 and store the result in register P3.
  73635. ** If either the P1 or P2 text are NULL then store NULL in P3.
  73636. **
  73637. ** P3 = P2 || P1
  73638. **
  73639. ** It is illegal for P1 and P3 to be the same register. Sometimes,
  73640. ** if P3 is the same register as P2, the implementation is able
  73641. ** to avoid a memcpy().
  73642. */
  73643. case OP_Concat: { /* same as TK_CONCAT, in1, in2, out3 */
  73644. i64 nByte;
  73645. pIn1 = &aMem[pOp->p1];
  73646. pIn2 = &aMem[pOp->p2];
  73647. pOut = &aMem[pOp->p3];
  73648. assert( pIn1!=pOut );
  73649. if( (pIn1->flags | pIn2->flags) & MEM_Null ){
  73650. sqlite3VdbeMemSetNull(pOut);
  73651. break;
  73652. }
  73653. if( ExpandBlob(pIn1) || ExpandBlob(pIn2) ) goto no_mem;
  73654. Stringify(pIn1, encoding);
  73655. Stringify(pIn2, encoding);
  73656. nByte = pIn1->n + pIn2->n;
  73657. if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  73658. goto too_big;
  73659. }
  73660. if( sqlite3VdbeMemGrow(pOut, (int)nByte+2, pOut==pIn2) ){
  73661. goto no_mem;
  73662. }
  73663. MemSetTypeFlag(pOut, MEM_Str);
  73664. if( pOut!=pIn2 ){
  73665. memcpy(pOut->z, pIn2->z, pIn2->n);
  73666. }
  73667. memcpy(&pOut->z[pIn2->n], pIn1->z, pIn1->n);
  73668. pOut->z[nByte]=0;
  73669. pOut->z[nByte+1] = 0;
  73670. pOut->flags |= MEM_Term;
  73671. pOut->n = (int)nByte;
  73672. pOut->enc = encoding;
  73673. UPDATE_MAX_BLOBSIZE(pOut);
  73674. break;
  73675. }
  73676. /* Opcode: Add P1 P2 P3 * *
  73677. ** Synopsis: r[P3]=r[P1]+r[P2]
  73678. **
  73679. ** Add the value in register P1 to the value in register P2
  73680. ** and store the result in register P3.
  73681. ** If either input is NULL, the result is NULL.
  73682. */
  73683. /* Opcode: Multiply P1 P2 P3 * *
  73684. ** Synopsis: r[P3]=r[P1]*r[P2]
  73685. **
  73686. **
  73687. ** Multiply the value in register P1 by the value in register P2
  73688. ** and store the result in register P3.
  73689. ** If either input is NULL, the result is NULL.
  73690. */
  73691. /* Opcode: Subtract P1 P2 P3 * *
  73692. ** Synopsis: r[P3]=r[P2]-r[P1]
  73693. **
  73694. ** Subtract the value in register P1 from the value in register P2
  73695. ** and store the result in register P3.
  73696. ** If either input is NULL, the result is NULL.
  73697. */
  73698. /* Opcode: Divide P1 P2 P3 * *
  73699. ** Synopsis: r[P3]=r[P2]/r[P1]
  73700. **
  73701. ** Divide the value in register P1 by the value in register P2
  73702. ** and store the result in register P3 (P3=P2/P1). If the value in
  73703. ** register P1 is zero, then the result is NULL. If either input is
  73704. ** NULL, the result is NULL.
  73705. */
  73706. /* Opcode: Remainder P1 P2 P3 * *
  73707. ** Synopsis: r[P3]=r[P2]%r[P1]
  73708. **
  73709. ** Compute the remainder after integer register P2 is divided by
  73710. ** register P1 and store the result in register P3.
  73711. ** If the value in register P1 is zero the result is NULL.
  73712. ** If either operand is NULL, the result is NULL.
  73713. */
  73714. case OP_Add: /* same as TK_PLUS, in1, in2, out3 */
  73715. case OP_Subtract: /* same as TK_MINUS, in1, in2, out3 */
  73716. case OP_Multiply: /* same as TK_STAR, in1, in2, out3 */
  73717. case OP_Divide: /* same as TK_SLASH, in1, in2, out3 */
  73718. case OP_Remainder: { /* same as TK_REM, in1, in2, out3 */
  73719. char bIntint; /* Started out as two integer operands */
  73720. u16 flags; /* Combined MEM_* flags from both inputs */
  73721. u16 type1; /* Numeric type of left operand */
  73722. u16 type2; /* Numeric type of right operand */
  73723. i64 iA; /* Integer value of left operand */
  73724. i64 iB; /* Integer value of right operand */
  73725. double rA; /* Real value of left operand */
  73726. double rB; /* Real value of right operand */
  73727. pIn1 = &aMem[pOp->p1];
  73728. type1 = numericType(pIn1);
  73729. pIn2 = &aMem[pOp->p2];
  73730. type2 = numericType(pIn2);
  73731. pOut = &aMem[pOp->p3];
  73732. flags = pIn1->flags | pIn2->flags;
  73733. if( (flags & MEM_Null)!=0 ) goto arithmetic_result_is_null;
  73734. if( (type1 & type2 & MEM_Int)!=0 ){
  73735. iA = pIn1->u.i;
  73736. iB = pIn2->u.i;
  73737. bIntint = 1;
  73738. switch( pOp->opcode ){
  73739. case OP_Add: if( sqlite3AddInt64(&iB,iA) ) goto fp_math; break;
  73740. case OP_Subtract: if( sqlite3SubInt64(&iB,iA) ) goto fp_math; break;
  73741. case OP_Multiply: if( sqlite3MulInt64(&iB,iA) ) goto fp_math; break;
  73742. case OP_Divide: {
  73743. if( iA==0 ) goto arithmetic_result_is_null;
  73744. if( iA==-1 && iB==SMALLEST_INT64 ) goto fp_math;
  73745. iB /= iA;
  73746. break;
  73747. }
  73748. default: {
  73749. if( iA==0 ) goto arithmetic_result_is_null;
  73750. if( iA==-1 ) iA = 1;
  73751. iB %= iA;
  73752. break;
  73753. }
  73754. }
  73755. pOut->u.i = iB;
  73756. MemSetTypeFlag(pOut, MEM_Int);
  73757. }else{
  73758. bIntint = 0;
  73759. fp_math:
  73760. rA = sqlite3VdbeRealValue(pIn1);
  73761. rB = sqlite3VdbeRealValue(pIn2);
  73762. switch( pOp->opcode ){
  73763. case OP_Add: rB += rA; break;
  73764. case OP_Subtract: rB -= rA; break;
  73765. case OP_Multiply: rB *= rA; break;
  73766. case OP_Divide: {
  73767. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  73768. if( rA==(double)0 ) goto arithmetic_result_is_null;
  73769. rB /= rA;
  73770. break;
  73771. }
  73772. default: {
  73773. iA = (i64)rA;
  73774. iB = (i64)rB;
  73775. if( iA==0 ) goto arithmetic_result_is_null;
  73776. if( iA==-1 ) iA = 1;
  73777. rB = (double)(iB % iA);
  73778. break;
  73779. }
  73780. }
  73781. #ifdef SQLITE_OMIT_FLOATING_POINT
  73782. pOut->u.i = rB;
  73783. MemSetTypeFlag(pOut, MEM_Int);
  73784. #else
  73785. if( sqlite3IsNaN(rB) ){
  73786. goto arithmetic_result_is_null;
  73787. }
  73788. pOut->u.r = rB;
  73789. MemSetTypeFlag(pOut, MEM_Real);
  73790. if( ((type1|type2)&MEM_Real)==0 && !bIntint ){
  73791. sqlite3VdbeIntegerAffinity(pOut);
  73792. }
  73793. #endif
  73794. }
  73795. break;
  73796. arithmetic_result_is_null:
  73797. sqlite3VdbeMemSetNull(pOut);
  73798. break;
  73799. }
  73800. /* Opcode: CollSeq P1 * * P4
  73801. **
  73802. ** P4 is a pointer to a CollSeq struct. If the next call to a user function
  73803. ** or aggregate calls sqlite3GetFuncCollSeq(), this collation sequence will
  73804. ** be returned. This is used by the built-in min(), max() and nullif()
  73805. ** functions.
  73806. **
  73807. ** If P1 is not zero, then it is a register that a subsequent min() or
  73808. ** max() aggregate will set to 1 if the current row is not the minimum or
  73809. ** maximum. The P1 register is initialized to 0 by this instruction.
  73810. **
  73811. ** The interface used by the implementation of the aforementioned functions
  73812. ** to retrieve the collation sequence set by this opcode is not available
  73813. ** publicly. Only built-in functions have access to this feature.
  73814. */
  73815. case OP_CollSeq: {
  73816. assert( pOp->p4type==P4_COLLSEQ );
  73817. if( pOp->p1 ){
  73818. sqlite3VdbeMemSetInt64(&aMem[pOp->p1], 0);
  73819. }
  73820. break;
  73821. }
  73822. /* Opcode: Function0 P1 P2 P3 P4 P5
  73823. ** Synopsis: r[P3]=func(r[P2@P5])
  73824. **
  73825. ** Invoke a user function (P4 is a pointer to a FuncDef object that
  73826. ** defines the function) with P5 arguments taken from register P2 and
  73827. ** successors. The result of the function is stored in register P3.
  73828. ** Register P3 must not be one of the function inputs.
  73829. **
  73830. ** P1 is a 32-bit bitmask indicating whether or not each argument to the
  73831. ** function was determined to be constant at compile time. If the first
  73832. ** argument was constant then bit 0 of P1 is set. This is used to determine
  73833. ** whether meta data associated with a user function argument using the
  73834. ** sqlite3_set_auxdata() API may be safely retained until the next
  73835. ** invocation of this opcode.
  73836. **
  73837. ** See also: Function, AggStep, AggFinal
  73838. */
  73839. /* Opcode: Function P1 P2 P3 P4 P5
  73840. ** Synopsis: r[P3]=func(r[P2@P5])
  73841. **
  73842. ** Invoke a user function (P4 is a pointer to an sqlite3_context object that
  73843. ** contains a pointer to the function to be run) with P5 arguments taken
  73844. ** from register P2 and successors. The result of the function is stored
  73845. ** in register P3. Register P3 must not be one of the function inputs.
  73846. **
  73847. ** P1 is a 32-bit bitmask indicating whether or not each argument to the
  73848. ** function was determined to be constant at compile time. If the first
  73849. ** argument was constant then bit 0 of P1 is set. This is used to determine
  73850. ** whether meta data associated with a user function argument using the
  73851. ** sqlite3_set_auxdata() API may be safely retained until the next
  73852. ** invocation of this opcode.
  73853. **
  73854. ** SQL functions are initially coded as OP_Function0 with P4 pointing
  73855. ** to a FuncDef object. But on first evaluation, the P4 operand is
  73856. ** automatically converted into an sqlite3_context object and the operation
  73857. ** changed to this OP_Function opcode. In this way, the initialization of
  73858. ** the sqlite3_context object occurs only once, rather than once for each
  73859. ** evaluation of the function.
  73860. **
  73861. ** See also: Function0, AggStep, AggFinal
  73862. */
  73863. case OP_Function0: {
  73864. int n;
  73865. sqlite3_context *pCtx;
  73866. assert( pOp->p4type==P4_FUNCDEF );
  73867. n = pOp->p5;
  73868. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  73869. assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
  73870. assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
  73871. pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
  73872. if( pCtx==0 ) goto no_mem;
  73873. pCtx->pOut = 0;
  73874. pCtx->pFunc = pOp->p4.pFunc;
  73875. pCtx->iOp = (int)(pOp - aOp);
  73876. pCtx->pVdbe = p;
  73877. pCtx->argc = n;
  73878. pOp->p4type = P4_FUNCCTX;
  73879. pOp->p4.pCtx = pCtx;
  73880. pOp->opcode = OP_Function;
  73881. /* Fall through into OP_Function */
  73882. }
  73883. case OP_Function: {
  73884. int i;
  73885. sqlite3_context *pCtx;
  73886. assert( pOp->p4type==P4_FUNCCTX );
  73887. pCtx = pOp->p4.pCtx;
  73888. /* If this function is inside of a trigger, the register array in aMem[]
  73889. ** might change from one evaluation to the next. The next block of code
  73890. ** checks to see if the register array has changed, and if so it
  73891. ** reinitializes the relavant parts of the sqlite3_context object */
  73892. pOut = &aMem[pOp->p3];
  73893. if( pCtx->pOut != pOut ){
  73894. pCtx->pOut = pOut;
  73895. for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
  73896. }
  73897. memAboutToChange(p, pCtx->pOut);
  73898. #ifdef SQLITE_DEBUG
  73899. for(i=0; i<pCtx->argc; i++){
  73900. assert( memIsValid(pCtx->argv[i]) );
  73901. REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
  73902. }
  73903. #endif
  73904. MemSetTypeFlag(pCtx->pOut, MEM_Null);
  73905. pCtx->fErrorOrAux = 0;
  73906. db->lastRowid = lastRowid;
  73907. (*pCtx->pFunc->xSFunc)(pCtx, pCtx->argc, pCtx->argv);/* IMP: R-24505-23230 */
  73908. lastRowid = db->lastRowid; /* Remember rowid changes made by xSFunc */
  73909. /* If the function returned an error, throw an exception */
  73910. if( pCtx->fErrorOrAux ){
  73911. if( pCtx->isError ){
  73912. sqlite3VdbeError(p, "%s", sqlite3_value_text(pCtx->pOut));
  73913. rc = pCtx->isError;
  73914. }
  73915. sqlite3VdbeDeleteAuxData(db, &p->pAuxData, pCtx->iOp, pOp->p1);
  73916. if( rc ) goto abort_due_to_error;
  73917. }
  73918. /* Copy the result of the function into register P3 */
  73919. if( pOut->flags & (MEM_Str|MEM_Blob) ){
  73920. sqlite3VdbeChangeEncoding(pCtx->pOut, encoding);
  73921. if( sqlite3VdbeMemTooBig(pCtx->pOut) ) goto too_big;
  73922. }
  73923. REGISTER_TRACE(pOp->p3, pCtx->pOut);
  73924. UPDATE_MAX_BLOBSIZE(pCtx->pOut);
  73925. break;
  73926. }
  73927. /* Opcode: BitAnd P1 P2 P3 * *
  73928. ** Synopsis: r[P3]=r[P1]&r[P2]
  73929. **
  73930. ** Take the bit-wise AND of the values in register P1 and P2 and
  73931. ** store the result in register P3.
  73932. ** If either input is NULL, the result is NULL.
  73933. */
  73934. /* Opcode: BitOr P1 P2 P3 * *
  73935. ** Synopsis: r[P3]=r[P1]|r[P2]
  73936. **
  73937. ** Take the bit-wise OR of the values in register P1 and P2 and
  73938. ** store the result in register P3.
  73939. ** If either input is NULL, the result is NULL.
  73940. */
  73941. /* Opcode: ShiftLeft P1 P2 P3 * *
  73942. ** Synopsis: r[P3]=r[P2]<<r[P1]
  73943. **
  73944. ** Shift the integer value in register P2 to the left by the
  73945. ** number of bits specified by the integer in register P1.
  73946. ** Store the result in register P3.
  73947. ** If either input is NULL, the result is NULL.
  73948. */
  73949. /* Opcode: ShiftRight P1 P2 P3 * *
  73950. ** Synopsis: r[P3]=r[P2]>>r[P1]
  73951. **
  73952. ** Shift the integer value in register P2 to the right by the
  73953. ** number of bits specified by the integer in register P1.
  73954. ** Store the result in register P3.
  73955. ** If either input is NULL, the result is NULL.
  73956. */
  73957. case OP_BitAnd: /* same as TK_BITAND, in1, in2, out3 */
  73958. case OP_BitOr: /* same as TK_BITOR, in1, in2, out3 */
  73959. case OP_ShiftLeft: /* same as TK_LSHIFT, in1, in2, out3 */
  73960. case OP_ShiftRight: { /* same as TK_RSHIFT, in1, in2, out3 */
  73961. i64 iA;
  73962. u64 uA;
  73963. i64 iB;
  73964. u8 op;
  73965. pIn1 = &aMem[pOp->p1];
  73966. pIn2 = &aMem[pOp->p2];
  73967. pOut = &aMem[pOp->p3];
  73968. if( (pIn1->flags | pIn2->flags) & MEM_Null ){
  73969. sqlite3VdbeMemSetNull(pOut);
  73970. break;
  73971. }
  73972. iA = sqlite3VdbeIntValue(pIn2);
  73973. iB = sqlite3VdbeIntValue(pIn1);
  73974. op = pOp->opcode;
  73975. if( op==OP_BitAnd ){
  73976. iA &= iB;
  73977. }else if( op==OP_BitOr ){
  73978. iA |= iB;
  73979. }else if( iB!=0 ){
  73980. assert( op==OP_ShiftRight || op==OP_ShiftLeft );
  73981. /* If shifting by a negative amount, shift in the other direction */
  73982. if( iB<0 ){
  73983. assert( OP_ShiftRight==OP_ShiftLeft+1 );
  73984. op = 2*OP_ShiftLeft + 1 - op;
  73985. iB = iB>(-64) ? -iB : 64;
  73986. }
  73987. if( iB>=64 ){
  73988. iA = (iA>=0 || op==OP_ShiftLeft) ? 0 : -1;
  73989. }else{
  73990. memcpy(&uA, &iA, sizeof(uA));
  73991. if( op==OP_ShiftLeft ){
  73992. uA <<= iB;
  73993. }else{
  73994. uA >>= iB;
  73995. /* Sign-extend on a right shift of a negative number */
  73996. if( iA<0 ) uA |= ((((u64)0xffffffff)<<32)|0xffffffff) << (64-iB);
  73997. }
  73998. memcpy(&iA, &uA, sizeof(iA));
  73999. }
  74000. }
  74001. pOut->u.i = iA;
  74002. MemSetTypeFlag(pOut, MEM_Int);
  74003. break;
  74004. }
  74005. /* Opcode: AddImm P1 P2 * * *
  74006. ** Synopsis: r[P1]=r[P1]+P2
  74007. **
  74008. ** Add the constant P2 to the value in register P1.
  74009. ** The result is always an integer.
  74010. **
  74011. ** To force any register to be an integer, just add 0.
  74012. */
  74013. case OP_AddImm: { /* in1 */
  74014. pIn1 = &aMem[pOp->p1];
  74015. memAboutToChange(p, pIn1);
  74016. sqlite3VdbeMemIntegerify(pIn1);
  74017. pIn1->u.i += pOp->p2;
  74018. break;
  74019. }
  74020. /* Opcode: MustBeInt P1 P2 * * *
  74021. **
  74022. ** Force the value in register P1 to be an integer. If the value
  74023. ** in P1 is not an integer and cannot be converted into an integer
  74024. ** without data loss, then jump immediately to P2, or if P2==0
  74025. ** raise an SQLITE_MISMATCH exception.
  74026. */
  74027. case OP_MustBeInt: { /* jump, in1 */
  74028. pIn1 = &aMem[pOp->p1];
  74029. if( (pIn1->flags & MEM_Int)==0 ){
  74030. applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
  74031. VdbeBranchTaken((pIn1->flags&MEM_Int)==0, 2);
  74032. if( (pIn1->flags & MEM_Int)==0 ){
  74033. if( pOp->p2==0 ){
  74034. rc = SQLITE_MISMATCH;
  74035. goto abort_due_to_error;
  74036. }else{
  74037. goto jump_to_p2;
  74038. }
  74039. }
  74040. }
  74041. MemSetTypeFlag(pIn1, MEM_Int);
  74042. break;
  74043. }
  74044. #ifndef SQLITE_OMIT_FLOATING_POINT
  74045. /* Opcode: RealAffinity P1 * * * *
  74046. **
  74047. ** If register P1 holds an integer convert it to a real value.
  74048. **
  74049. ** This opcode is used when extracting information from a column that
  74050. ** has REAL affinity. Such column values may still be stored as
  74051. ** integers, for space efficiency, but after extraction we want them
  74052. ** to have only a real value.
  74053. */
  74054. case OP_RealAffinity: { /* in1 */
  74055. pIn1 = &aMem[pOp->p1];
  74056. if( pIn1->flags & MEM_Int ){
  74057. sqlite3VdbeMemRealify(pIn1);
  74058. }
  74059. break;
  74060. }
  74061. #endif
  74062. #ifndef SQLITE_OMIT_CAST
  74063. /* Opcode: Cast P1 P2 * * *
  74064. ** Synopsis: affinity(r[P1])
  74065. **
  74066. ** Force the value in register P1 to be the type defined by P2.
  74067. **
  74068. ** <ul>
  74069. ** <li value="97"> TEXT
  74070. ** <li value="98"> BLOB
  74071. ** <li value="99"> NUMERIC
  74072. ** <li value="100"> INTEGER
  74073. ** <li value="101"> REAL
  74074. ** </ul>
  74075. **
  74076. ** A NULL value is not changed by this routine. It remains NULL.
  74077. */
  74078. case OP_Cast: { /* in1 */
  74079. assert( pOp->p2>=SQLITE_AFF_BLOB && pOp->p2<=SQLITE_AFF_REAL );
  74080. testcase( pOp->p2==SQLITE_AFF_TEXT );
  74081. testcase( pOp->p2==SQLITE_AFF_BLOB );
  74082. testcase( pOp->p2==SQLITE_AFF_NUMERIC );
  74083. testcase( pOp->p2==SQLITE_AFF_INTEGER );
  74084. testcase( pOp->p2==SQLITE_AFF_REAL );
  74085. pIn1 = &aMem[pOp->p1];
  74086. memAboutToChange(p, pIn1);
  74087. rc = ExpandBlob(pIn1);
  74088. sqlite3VdbeMemCast(pIn1, pOp->p2, encoding);
  74089. UPDATE_MAX_BLOBSIZE(pIn1);
  74090. if( rc ) goto abort_due_to_error;
  74091. break;
  74092. }
  74093. #endif /* SQLITE_OMIT_CAST */
  74094. /* Opcode: Eq P1 P2 P3 P4 P5
  74095. ** Synopsis: IF r[P3]==r[P1]
  74096. **
  74097. ** Compare the values in register P1 and P3. If reg(P3)==reg(P1) then
  74098. ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5, then
  74099. ** store the result of comparison in register P2.
  74100. **
  74101. ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
  74102. ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
  74103. ** to coerce both inputs according to this affinity before the
  74104. ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
  74105. ** affinity is used. Note that the affinity conversions are stored
  74106. ** back into the input registers P1 and P3. So this opcode can cause
  74107. ** persistent changes to registers P1 and P3.
  74108. **
  74109. ** Once any conversions have taken place, and neither value is NULL,
  74110. ** the values are compared. If both values are blobs then memcmp() is
  74111. ** used to determine the results of the comparison. If both values
  74112. ** are text, then the appropriate collating function specified in
  74113. ** P4 is used to do the comparison. If P4 is not specified then
  74114. ** memcmp() is used to compare text string. If both values are
  74115. ** numeric, then a numeric comparison is used. If the two values
  74116. ** are of different types, then numbers are considered less than
  74117. ** strings and strings are considered less than blobs.
  74118. **
  74119. ** If SQLITE_NULLEQ is set in P5 then the result of comparison is always either
  74120. ** true or false and is never NULL. If both operands are NULL then the result
  74121. ** of comparison is true. If either operand is NULL then the result is false.
  74122. ** If neither operand is NULL the result is the same as it would be if
  74123. ** the SQLITE_NULLEQ flag were omitted from P5.
  74124. **
  74125. ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
  74126. ** content of r[P2] is only changed if the new value is NULL or 0 (false).
  74127. ** In other words, a prior r[P2] value will not be overwritten by 1 (true).
  74128. */
  74129. /* Opcode: Ne P1 P2 P3 P4 P5
  74130. ** Synopsis: IF r[P3]!=r[P1]
  74131. **
  74132. ** This works just like the Eq opcode except that the jump is taken if
  74133. ** the operands in registers P1 and P3 are not equal. See the Eq opcode for
  74134. ** additional information.
  74135. **
  74136. ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
  74137. ** content of r[P2] is only changed if the new value is NULL or 1 (true).
  74138. ** In other words, a prior r[P2] value will not be overwritten by 0 (false).
  74139. */
  74140. /* Opcode: Lt P1 P2 P3 P4 P5
  74141. ** Synopsis: IF r[P3]<r[P1]
  74142. **
  74143. ** Compare the values in register P1 and P3. If reg(P3)<reg(P1) then
  74144. ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5 store
  74145. ** the result of comparison (0 or 1 or NULL) into register P2.
  74146. **
  74147. ** If the SQLITE_JUMPIFNULL bit of P5 is set and either reg(P1) or
  74148. ** reg(P3) is NULL then the take the jump. If the SQLITE_JUMPIFNULL
  74149. ** bit is clear then fall through if either operand is NULL.
  74150. **
  74151. ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
  74152. ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
  74153. ** to coerce both inputs according to this affinity before the
  74154. ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
  74155. ** affinity is used. Note that the affinity conversions are stored
  74156. ** back into the input registers P1 and P3. So this opcode can cause
  74157. ** persistent changes to registers P1 and P3.
  74158. **
  74159. ** Once any conversions have taken place, and neither value is NULL,
  74160. ** the values are compared. If both values are blobs then memcmp() is
  74161. ** used to determine the results of the comparison. If both values
  74162. ** are text, then the appropriate collating function specified in
  74163. ** P4 is used to do the comparison. If P4 is not specified then
  74164. ** memcmp() is used to compare text string. If both values are
  74165. ** numeric, then a numeric comparison is used. If the two values
  74166. ** are of different types, then numbers are considered less than
  74167. ** strings and strings are considered less than blobs.
  74168. */
  74169. /* Opcode: Le P1 P2 P3 P4 P5
  74170. ** Synopsis: IF r[P3]<=r[P1]
  74171. **
  74172. ** This works just like the Lt opcode except that the jump is taken if
  74173. ** the content of register P3 is less than or equal to the content of
  74174. ** register P1. See the Lt opcode for additional information.
  74175. */
  74176. /* Opcode: Gt P1 P2 P3 P4 P5
  74177. ** Synopsis: IF r[P3]>r[P1]
  74178. **
  74179. ** This works just like the Lt opcode except that the jump is taken if
  74180. ** the content of register P3 is greater than the content of
  74181. ** register P1. See the Lt opcode for additional information.
  74182. */
  74183. /* Opcode: Ge P1 P2 P3 P4 P5
  74184. ** Synopsis: IF r[P3]>=r[P1]
  74185. **
  74186. ** This works just like the Lt opcode except that the jump is taken if
  74187. ** the content of register P3 is greater than or equal to the content of
  74188. ** register P1. See the Lt opcode for additional information.
  74189. */
  74190. case OP_Eq: /* same as TK_EQ, jump, in1, in3 */
  74191. case OP_Ne: /* same as TK_NE, jump, in1, in3 */
  74192. case OP_Lt: /* same as TK_LT, jump, in1, in3 */
  74193. case OP_Le: /* same as TK_LE, jump, in1, in3 */
  74194. case OP_Gt: /* same as TK_GT, jump, in1, in3 */
  74195. case OP_Ge: { /* same as TK_GE, jump, in1, in3 */
  74196. int res, res2; /* Result of the comparison of pIn1 against pIn3 */
  74197. char affinity; /* Affinity to use for comparison */
  74198. u16 flags1; /* Copy of initial value of pIn1->flags */
  74199. u16 flags3; /* Copy of initial value of pIn3->flags */
  74200. pIn1 = &aMem[pOp->p1];
  74201. pIn3 = &aMem[pOp->p3];
  74202. flags1 = pIn1->flags;
  74203. flags3 = pIn3->flags;
  74204. if( (flags1 | flags3)&MEM_Null ){
  74205. /* One or both operands are NULL */
  74206. if( pOp->p5 & SQLITE_NULLEQ ){
  74207. /* If SQLITE_NULLEQ is set (which will only happen if the operator is
  74208. ** OP_Eq or OP_Ne) then take the jump or not depending on whether
  74209. ** or not both operands are null.
  74210. */
  74211. assert( pOp->opcode==OP_Eq || pOp->opcode==OP_Ne );
  74212. assert( (flags1 & MEM_Cleared)==0 );
  74213. assert( (pOp->p5 & SQLITE_JUMPIFNULL)==0 );
  74214. if( (flags1&MEM_Null)!=0
  74215. && (flags3&MEM_Null)!=0
  74216. && (flags3&MEM_Cleared)==0
  74217. ){
  74218. res = 0; /* Operands are equal */
  74219. }else{
  74220. res = 1; /* Operands are not equal */
  74221. }
  74222. }else{
  74223. /* SQLITE_NULLEQ is clear and at least one operand is NULL,
  74224. ** then the result is always NULL.
  74225. ** The jump is taken if the SQLITE_JUMPIFNULL bit is set.
  74226. */
  74227. if( pOp->p5 & SQLITE_STOREP2 ){
  74228. pOut = &aMem[pOp->p2];
  74229. iCompare = 1; /* Operands are not equal */
  74230. memAboutToChange(p, pOut);
  74231. MemSetTypeFlag(pOut, MEM_Null);
  74232. REGISTER_TRACE(pOp->p2, pOut);
  74233. }else{
  74234. VdbeBranchTaken(2,3);
  74235. if( pOp->p5 & SQLITE_JUMPIFNULL ){
  74236. goto jump_to_p2;
  74237. }
  74238. }
  74239. break;
  74240. }
  74241. }else{
  74242. /* Neither operand is NULL. Do a comparison. */
  74243. affinity = pOp->p5 & SQLITE_AFF_MASK;
  74244. if( affinity>=SQLITE_AFF_NUMERIC ){
  74245. if( (flags1 | flags3)&MEM_Str ){
  74246. if( (flags1 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  74247. applyNumericAffinity(pIn1,0);
  74248. testcase( flags3!=pIn3->flags ); /* Possible if pIn1==pIn3 */
  74249. flags3 = pIn3->flags;
  74250. }
  74251. if( (flags3 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  74252. applyNumericAffinity(pIn3,0);
  74253. }
  74254. }
  74255. /* Handle the common case of integer comparison here, as an
  74256. ** optimization, to avoid a call to sqlite3MemCompare() */
  74257. if( (pIn1->flags & pIn3->flags & MEM_Int)!=0 ){
  74258. if( pIn3->u.i > pIn1->u.i ){ res = +1; goto compare_op; }
  74259. if( pIn3->u.i < pIn1->u.i ){ res = -1; goto compare_op; }
  74260. res = 0;
  74261. goto compare_op;
  74262. }
  74263. }else if( affinity==SQLITE_AFF_TEXT ){
  74264. if( (flags1 & MEM_Str)==0 && (flags1 & (MEM_Int|MEM_Real))!=0 ){
  74265. testcase( pIn1->flags & MEM_Int );
  74266. testcase( pIn1->flags & MEM_Real );
  74267. sqlite3VdbeMemStringify(pIn1, encoding, 1);
  74268. testcase( (flags1&MEM_Dyn) != (pIn1->flags&MEM_Dyn) );
  74269. flags1 = (pIn1->flags & ~MEM_TypeMask) | (flags1 & MEM_TypeMask);
  74270. assert( pIn1!=pIn3 );
  74271. }
  74272. if( (flags3 & MEM_Str)==0 && (flags3 & (MEM_Int|MEM_Real))!=0 ){
  74273. testcase( pIn3->flags & MEM_Int );
  74274. testcase( pIn3->flags & MEM_Real );
  74275. sqlite3VdbeMemStringify(pIn3, encoding, 1);
  74276. testcase( (flags3&MEM_Dyn) != (pIn3->flags&MEM_Dyn) );
  74277. flags3 = (pIn3->flags & ~MEM_TypeMask) | (flags3 & MEM_TypeMask);
  74278. }
  74279. }
  74280. assert( pOp->p4type==P4_COLLSEQ || pOp->p4.pColl==0 );
  74281. res = sqlite3MemCompare(pIn3, pIn1, pOp->p4.pColl);
  74282. }
  74283. compare_op:
  74284. switch( pOp->opcode ){
  74285. case OP_Eq: res2 = res==0; break;
  74286. case OP_Ne: res2 = res; break;
  74287. case OP_Lt: res2 = res<0; break;
  74288. case OP_Le: res2 = res<=0; break;
  74289. case OP_Gt: res2 = res>0; break;
  74290. default: res2 = res>=0; break;
  74291. }
  74292. /* Undo any changes made by applyAffinity() to the input registers. */
  74293. assert( (pIn1->flags & MEM_Dyn) == (flags1 & MEM_Dyn) );
  74294. pIn1->flags = flags1;
  74295. assert( (pIn3->flags & MEM_Dyn) == (flags3 & MEM_Dyn) );
  74296. pIn3->flags = flags3;
  74297. if( pOp->p5 & SQLITE_STOREP2 ){
  74298. pOut = &aMem[pOp->p2];
  74299. iCompare = res;
  74300. res2 = res2!=0; /* For this path res2 must be exactly 0 or 1 */
  74301. if( (pOp->p5 & SQLITE_KEEPNULL)!=0 ){
  74302. /* The KEEPNULL flag prevents OP_Eq from overwriting a NULL with 1
  74303. ** and prevents OP_Ne from overwriting NULL with 0. This flag
  74304. ** is only used in contexts where either:
  74305. ** (1) op==OP_Eq && (r[P2]==NULL || r[P2]==0)
  74306. ** (2) op==OP_Ne && (r[P2]==NULL || r[P2]==1)
  74307. ** Therefore it is not necessary to check the content of r[P2] for
  74308. ** NULL. */
  74309. assert( pOp->opcode==OP_Ne || pOp->opcode==OP_Eq );
  74310. assert( res2==0 || res2==1 );
  74311. testcase( res2==0 && pOp->opcode==OP_Eq );
  74312. testcase( res2==1 && pOp->opcode==OP_Eq );
  74313. testcase( res2==0 && pOp->opcode==OP_Ne );
  74314. testcase( res2==1 && pOp->opcode==OP_Ne );
  74315. if( (pOp->opcode==OP_Eq)==res2 ) break;
  74316. }
  74317. memAboutToChange(p, pOut);
  74318. MemSetTypeFlag(pOut, MEM_Int);
  74319. pOut->u.i = res2;
  74320. REGISTER_TRACE(pOp->p2, pOut);
  74321. }else{
  74322. VdbeBranchTaken(res!=0, (pOp->p5 & SQLITE_NULLEQ)?2:3);
  74323. if( res2 ){
  74324. goto jump_to_p2;
  74325. }
  74326. }
  74327. break;
  74328. }
  74329. /* Opcode: ElseNotEq * P2 * * *
  74330. **
  74331. ** This opcode must immediately follow an OP_Lt or OP_Gt comparison operator.
  74332. ** If result of an OP_Eq comparison on the same two operands
  74333. ** would have be NULL or false (0), then then jump to P2.
  74334. ** If the result of an OP_Eq comparison on the two previous operands
  74335. ** would have been true (1), then fall through.
  74336. */
  74337. case OP_ElseNotEq: { /* same as TK_ESCAPE, jump */
  74338. assert( pOp>aOp );
  74339. assert( pOp[-1].opcode==OP_Lt || pOp[-1].opcode==OP_Gt );
  74340. assert( pOp[-1].p5 & SQLITE_STOREP2 );
  74341. VdbeBranchTaken(iCompare!=0, 2);
  74342. if( iCompare!=0 ) goto jump_to_p2;
  74343. break;
  74344. }
  74345. /* Opcode: Permutation * * * P4 *
  74346. **
  74347. ** Set the permutation used by the OP_Compare operator to be the array
  74348. ** of integers in P4.
  74349. **
  74350. ** The permutation is only valid until the next OP_Compare that has
  74351. ** the OPFLAG_PERMUTE bit set in P5. Typically the OP_Permutation should
  74352. ** occur immediately prior to the OP_Compare.
  74353. **
  74354. ** The first integer in the P4 integer array is the length of the array
  74355. ** and does not become part of the permutation.
  74356. */
  74357. case OP_Permutation: {
  74358. assert( pOp->p4type==P4_INTARRAY );
  74359. assert( pOp->p4.ai );
  74360. aPermute = pOp->p4.ai + 1;
  74361. break;
  74362. }
  74363. /* Opcode: Compare P1 P2 P3 P4 P5
  74364. ** Synopsis: r[P1@P3] <-> r[P2@P3]
  74365. **
  74366. ** Compare two vectors of registers in reg(P1)..reg(P1+P3-1) (call this
  74367. ** vector "A") and in reg(P2)..reg(P2+P3-1) ("B"). Save the result of
  74368. ** the comparison for use by the next OP_Jump instruct.
  74369. **
  74370. ** If P5 has the OPFLAG_PERMUTE bit set, then the order of comparison is
  74371. ** determined by the most recent OP_Permutation operator. If the
  74372. ** OPFLAG_PERMUTE bit is clear, then register are compared in sequential
  74373. ** order.
  74374. **
  74375. ** P4 is a KeyInfo structure that defines collating sequences and sort
  74376. ** orders for the comparison. The permutation applies to registers
  74377. ** only. The KeyInfo elements are used sequentially.
  74378. **
  74379. ** The comparison is a sort comparison, so NULLs compare equal,
  74380. ** NULLs are less than numbers, numbers are less than strings,
  74381. ** and strings are less than blobs.
  74382. */
  74383. case OP_Compare: {
  74384. int n;
  74385. int i;
  74386. int p1;
  74387. int p2;
  74388. const KeyInfo *pKeyInfo;
  74389. int idx;
  74390. CollSeq *pColl; /* Collating sequence to use on this term */
  74391. int bRev; /* True for DESCENDING sort order */
  74392. if( (pOp->p5 & OPFLAG_PERMUTE)==0 ) aPermute = 0;
  74393. n = pOp->p3;
  74394. pKeyInfo = pOp->p4.pKeyInfo;
  74395. assert( n>0 );
  74396. assert( pKeyInfo!=0 );
  74397. p1 = pOp->p1;
  74398. p2 = pOp->p2;
  74399. #if SQLITE_DEBUG
  74400. if( aPermute ){
  74401. int k, mx = 0;
  74402. for(k=0; k<n; k++) if( aPermute[k]>mx ) mx = aPermute[k];
  74403. assert( p1>0 && p1+mx<=(p->nMem+1 - p->nCursor)+1 );
  74404. assert( p2>0 && p2+mx<=(p->nMem+1 - p->nCursor)+1 );
  74405. }else{
  74406. assert( p1>0 && p1+n<=(p->nMem+1 - p->nCursor)+1 );
  74407. assert( p2>0 && p2+n<=(p->nMem+1 - p->nCursor)+1 );
  74408. }
  74409. #endif /* SQLITE_DEBUG */
  74410. for(i=0; i<n; i++){
  74411. idx = aPermute ? aPermute[i] : i;
  74412. assert( memIsValid(&aMem[p1+idx]) );
  74413. assert( memIsValid(&aMem[p2+idx]) );
  74414. REGISTER_TRACE(p1+idx, &aMem[p1+idx]);
  74415. REGISTER_TRACE(p2+idx, &aMem[p2+idx]);
  74416. assert( i<pKeyInfo->nField );
  74417. pColl = pKeyInfo->aColl[i];
  74418. bRev = pKeyInfo->aSortOrder[i];
  74419. iCompare = sqlite3MemCompare(&aMem[p1+idx], &aMem[p2+idx], pColl);
  74420. if( iCompare ){
  74421. if( bRev ) iCompare = -iCompare;
  74422. break;
  74423. }
  74424. }
  74425. aPermute = 0;
  74426. break;
  74427. }
  74428. /* Opcode: Jump P1 P2 P3 * *
  74429. **
  74430. ** Jump to the instruction at address P1, P2, or P3 depending on whether
  74431. ** in the most recent OP_Compare instruction the P1 vector was less than
  74432. ** equal to, or greater than the P2 vector, respectively.
  74433. */
  74434. case OP_Jump: { /* jump */
  74435. if( iCompare<0 ){
  74436. VdbeBranchTaken(0,3); pOp = &aOp[pOp->p1 - 1];
  74437. }else if( iCompare==0 ){
  74438. VdbeBranchTaken(1,3); pOp = &aOp[pOp->p2 - 1];
  74439. }else{
  74440. VdbeBranchTaken(2,3); pOp = &aOp[pOp->p3 - 1];
  74441. }
  74442. break;
  74443. }
  74444. /* Opcode: And P1 P2 P3 * *
  74445. ** Synopsis: r[P3]=(r[P1] && r[P2])
  74446. **
  74447. ** Take the logical AND of the values in registers P1 and P2 and
  74448. ** write the result into register P3.
  74449. **
  74450. ** If either P1 or P2 is 0 (false) then the result is 0 even if
  74451. ** the other input is NULL. A NULL and true or two NULLs give
  74452. ** a NULL output.
  74453. */
  74454. /* Opcode: Or P1 P2 P3 * *
  74455. ** Synopsis: r[P3]=(r[P1] || r[P2])
  74456. **
  74457. ** Take the logical OR of the values in register P1 and P2 and
  74458. ** store the answer in register P3.
  74459. **
  74460. ** If either P1 or P2 is nonzero (true) then the result is 1 (true)
  74461. ** even if the other input is NULL. A NULL and false or two NULLs
  74462. ** give a NULL output.
  74463. */
  74464. case OP_And: /* same as TK_AND, in1, in2, out3 */
  74465. case OP_Or: { /* same as TK_OR, in1, in2, out3 */
  74466. int v1; /* Left operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
  74467. int v2; /* Right operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
  74468. pIn1 = &aMem[pOp->p1];
  74469. if( pIn1->flags & MEM_Null ){
  74470. v1 = 2;
  74471. }else{
  74472. v1 = sqlite3VdbeIntValue(pIn1)!=0;
  74473. }
  74474. pIn2 = &aMem[pOp->p2];
  74475. if( pIn2->flags & MEM_Null ){
  74476. v2 = 2;
  74477. }else{
  74478. v2 = sqlite3VdbeIntValue(pIn2)!=0;
  74479. }
  74480. if( pOp->opcode==OP_And ){
  74481. static const unsigned char and_logic[] = { 0, 0, 0, 0, 1, 2, 0, 2, 2 };
  74482. v1 = and_logic[v1*3+v2];
  74483. }else{
  74484. static const unsigned char or_logic[] = { 0, 1, 2, 1, 1, 1, 2, 1, 2 };
  74485. v1 = or_logic[v1*3+v2];
  74486. }
  74487. pOut = &aMem[pOp->p3];
  74488. if( v1==2 ){
  74489. MemSetTypeFlag(pOut, MEM_Null);
  74490. }else{
  74491. pOut->u.i = v1;
  74492. MemSetTypeFlag(pOut, MEM_Int);
  74493. }
  74494. break;
  74495. }
  74496. /* Opcode: Not P1 P2 * * *
  74497. ** Synopsis: r[P2]= !r[P1]
  74498. **
  74499. ** Interpret the value in register P1 as a boolean value. Store the
  74500. ** boolean complement in register P2. If the value in register P1 is
  74501. ** NULL, then a NULL is stored in P2.
  74502. */
  74503. case OP_Not: { /* same as TK_NOT, in1, out2 */
  74504. pIn1 = &aMem[pOp->p1];
  74505. pOut = &aMem[pOp->p2];
  74506. sqlite3VdbeMemSetNull(pOut);
  74507. if( (pIn1->flags & MEM_Null)==0 ){
  74508. pOut->flags = MEM_Int;
  74509. pOut->u.i = !sqlite3VdbeIntValue(pIn1);
  74510. }
  74511. break;
  74512. }
  74513. /* Opcode: BitNot P1 P2 * * *
  74514. ** Synopsis: r[P1]= ~r[P1]
  74515. **
  74516. ** Interpret the content of register P1 as an integer. Store the
  74517. ** ones-complement of the P1 value into register P2. If P1 holds
  74518. ** a NULL then store a NULL in P2.
  74519. */
  74520. case OP_BitNot: { /* same as TK_BITNOT, in1, out2 */
  74521. pIn1 = &aMem[pOp->p1];
  74522. pOut = &aMem[pOp->p2];
  74523. sqlite3VdbeMemSetNull(pOut);
  74524. if( (pIn1->flags & MEM_Null)==0 ){
  74525. pOut->flags = MEM_Int;
  74526. pOut->u.i = ~sqlite3VdbeIntValue(pIn1);
  74527. }
  74528. break;
  74529. }
  74530. /* Opcode: Once P1 P2 * * *
  74531. **
  74532. ** If the P1 value is equal to the P1 value on the OP_Init opcode at
  74533. ** instruction 0, then jump to P2. If the two P1 values differ, then
  74534. ** set the P1 value on this opcode to equal the P1 value on the OP_Init
  74535. ** and fall through.
  74536. */
  74537. case OP_Once: { /* jump */
  74538. assert( p->aOp[0].opcode==OP_Init );
  74539. VdbeBranchTaken(p->aOp[0].p1==pOp->p1, 2);
  74540. if( p->aOp[0].p1==pOp->p1 ){
  74541. goto jump_to_p2;
  74542. }else{
  74543. pOp->p1 = p->aOp[0].p1;
  74544. }
  74545. break;
  74546. }
  74547. /* Opcode: If P1 P2 P3 * *
  74548. **
  74549. ** Jump to P2 if the value in register P1 is true. The value
  74550. ** is considered true if it is numeric and non-zero. If the value
  74551. ** in P1 is NULL then take the jump if and only if P3 is non-zero.
  74552. */
  74553. /* Opcode: IfNot P1 P2 P3 * *
  74554. **
  74555. ** Jump to P2 if the value in register P1 is False. The value
  74556. ** is considered false if it has a numeric value of zero. If the value
  74557. ** in P1 is NULL then take the jump if and only if P3 is non-zero.
  74558. */
  74559. case OP_If: /* jump, in1 */
  74560. case OP_IfNot: { /* jump, in1 */
  74561. int c;
  74562. pIn1 = &aMem[pOp->p1];
  74563. if( pIn1->flags & MEM_Null ){
  74564. c = pOp->p3;
  74565. }else{
  74566. #ifdef SQLITE_OMIT_FLOATING_POINT
  74567. c = sqlite3VdbeIntValue(pIn1)!=0;
  74568. #else
  74569. c = sqlite3VdbeRealValue(pIn1)!=0.0;
  74570. #endif
  74571. if( pOp->opcode==OP_IfNot ) c = !c;
  74572. }
  74573. VdbeBranchTaken(c!=0, 2);
  74574. if( c ){
  74575. goto jump_to_p2;
  74576. }
  74577. break;
  74578. }
  74579. /* Opcode: IsNull P1 P2 * * *
  74580. ** Synopsis: if r[P1]==NULL goto P2
  74581. **
  74582. ** Jump to P2 if the value in register P1 is NULL.
  74583. */
  74584. case OP_IsNull: { /* same as TK_ISNULL, jump, in1 */
  74585. pIn1 = &aMem[pOp->p1];
  74586. VdbeBranchTaken( (pIn1->flags & MEM_Null)!=0, 2);
  74587. if( (pIn1->flags & MEM_Null)!=0 ){
  74588. goto jump_to_p2;
  74589. }
  74590. break;
  74591. }
  74592. /* Opcode: NotNull P1 P2 * * *
  74593. ** Synopsis: if r[P1]!=NULL goto P2
  74594. **
  74595. ** Jump to P2 if the value in register P1 is not NULL.
  74596. */
  74597. case OP_NotNull: { /* same as TK_NOTNULL, jump, in1 */
  74598. pIn1 = &aMem[pOp->p1];
  74599. VdbeBranchTaken( (pIn1->flags & MEM_Null)==0, 2);
  74600. if( (pIn1->flags & MEM_Null)==0 ){
  74601. goto jump_to_p2;
  74602. }
  74603. break;
  74604. }
  74605. /* Opcode: Column P1 P2 P3 P4 P5
  74606. ** Synopsis: r[P3]=PX
  74607. **
  74608. ** Interpret the data that cursor P1 points to as a structure built using
  74609. ** the MakeRecord instruction. (See the MakeRecord opcode for additional
  74610. ** information about the format of the data.) Extract the P2-th column
  74611. ** from this record. If there are less that (P2+1)
  74612. ** values in the record, extract a NULL.
  74613. **
  74614. ** The value extracted is stored in register P3.
  74615. **
  74616. ** If the column contains fewer than P2 fields, then extract a NULL. Or,
  74617. ** if the P4 argument is a P4_MEM use the value of the P4 argument as
  74618. ** the result.
  74619. **
  74620. ** If the OPFLAG_CLEARCACHE bit is set on P5 and P1 is a pseudo-table cursor,
  74621. ** then the cache of the cursor is reset prior to extracting the column.
  74622. ** The first OP_Column against a pseudo-table after the value of the content
  74623. ** register has changed should have this bit set.
  74624. **
  74625. ** If the OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG bits are set on P5 when
  74626. ** the result is guaranteed to only be used as the argument of a length()
  74627. ** or typeof() function, respectively. The loading of large blobs can be
  74628. ** skipped for length() and all content loading can be skipped for typeof().
  74629. */
  74630. case OP_Column: {
  74631. int p2; /* column number to retrieve */
  74632. VdbeCursor *pC; /* The VDBE cursor */
  74633. BtCursor *pCrsr; /* The BTree cursor */
  74634. u32 *aOffset; /* aOffset[i] is offset to start of data for i-th column */
  74635. int len; /* The length of the serialized data for the column */
  74636. int i; /* Loop counter */
  74637. Mem *pDest; /* Where to write the extracted value */
  74638. Mem sMem; /* For storing the record being decoded */
  74639. const u8 *zData; /* Part of the record being decoded */
  74640. const u8 *zHdr; /* Next unparsed byte of the header */
  74641. const u8 *zEndHdr; /* Pointer to first byte after the header */
  74642. u32 offset; /* Offset into the data */
  74643. u64 offset64; /* 64-bit offset */
  74644. u32 avail; /* Number of bytes of available data */
  74645. u32 t; /* A type code from the record header */
  74646. Mem *pReg; /* PseudoTable input register */
  74647. pC = p->apCsr[pOp->p1];
  74648. p2 = pOp->p2;
  74649. /* If the cursor cache is stale, bring it up-to-date */
  74650. rc = sqlite3VdbeCursorMoveto(&pC, &p2);
  74651. if( rc ) goto abort_due_to_error;
  74652. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  74653. pDest = &aMem[pOp->p3];
  74654. memAboutToChange(p, pDest);
  74655. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  74656. assert( pC!=0 );
  74657. assert( p2<pC->nField );
  74658. aOffset = pC->aOffset;
  74659. assert( pC->eCurType!=CURTYPE_VTAB );
  74660. assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
  74661. assert( pC->eCurType!=CURTYPE_SORTER );
  74662. pCrsr = pC->uc.pCursor;
  74663. if( pC->cacheStatus!=p->cacheCtr ){ /*OPTIMIZATION-IF-FALSE*/
  74664. if( pC->nullRow ){
  74665. if( pC->eCurType==CURTYPE_PSEUDO ){
  74666. assert( pC->uc.pseudoTableReg>0 );
  74667. pReg = &aMem[pC->uc.pseudoTableReg];
  74668. assert( pReg->flags & MEM_Blob );
  74669. assert( memIsValid(pReg) );
  74670. pC->payloadSize = pC->szRow = avail = pReg->n;
  74671. pC->aRow = (u8*)pReg->z;
  74672. }else{
  74673. sqlite3VdbeMemSetNull(pDest);
  74674. goto op_column_out;
  74675. }
  74676. }else{
  74677. assert( pC->eCurType==CURTYPE_BTREE );
  74678. assert( pCrsr );
  74679. assert( sqlite3BtreeCursorIsValid(pCrsr) );
  74680. pC->payloadSize = sqlite3BtreePayloadSize(pCrsr);
  74681. pC->aRow = sqlite3BtreePayloadFetch(pCrsr, &avail);
  74682. assert( avail<=65536 ); /* Maximum page size is 64KiB */
  74683. if( pC->payloadSize <= (u32)avail ){
  74684. pC->szRow = pC->payloadSize;
  74685. }else if( pC->payloadSize > (u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  74686. goto too_big;
  74687. }else{
  74688. pC->szRow = avail;
  74689. }
  74690. }
  74691. pC->cacheStatus = p->cacheCtr;
  74692. pC->iHdrOffset = getVarint32(pC->aRow, offset);
  74693. pC->nHdrParsed = 0;
  74694. aOffset[0] = offset;
  74695. if( avail<offset ){ /*OPTIMIZATION-IF-FALSE*/
  74696. /* pC->aRow does not have to hold the entire row, but it does at least
  74697. ** need to cover the header of the record. If pC->aRow does not contain
  74698. ** the complete header, then set it to zero, forcing the header to be
  74699. ** dynamically allocated. */
  74700. pC->aRow = 0;
  74701. pC->szRow = 0;
  74702. /* Make sure a corrupt database has not given us an oversize header.
  74703. ** Do this now to avoid an oversize memory allocation.
  74704. **
  74705. ** Type entries can be between 1 and 5 bytes each. But 4 and 5 byte
  74706. ** types use so much data space that there can only be 4096 and 32 of
  74707. ** them, respectively. So the maximum header length results from a
  74708. ** 3-byte type for each of the maximum of 32768 columns plus three
  74709. ** extra bytes for the header length itself. 32768*3 + 3 = 98307.
  74710. */
  74711. if( offset > 98307 || offset > pC->payloadSize ){
  74712. rc = SQLITE_CORRUPT_BKPT;
  74713. goto abort_due_to_error;
  74714. }
  74715. }else if( offset>0 ){ /*OPTIMIZATION-IF-TRUE*/
  74716. /* The following goto is an optimization. It can be omitted and
  74717. ** everything will still work. But OP_Column is measurably faster
  74718. ** by skipping the subsequent conditional, which is always true.
  74719. */
  74720. zData = pC->aRow;
  74721. assert( pC->nHdrParsed<=p2 ); /* Conditional skipped */
  74722. goto op_column_read_header;
  74723. }
  74724. }
  74725. /* Make sure at least the first p2+1 entries of the header have been
  74726. ** parsed and valid information is in aOffset[] and pC->aType[].
  74727. */
  74728. if( pC->nHdrParsed<=p2 ){
  74729. /* If there is more header available for parsing in the record, try
  74730. ** to extract additional fields up through the p2+1-th field
  74731. */
  74732. if( pC->iHdrOffset<aOffset[0] ){
  74733. /* Make sure zData points to enough of the record to cover the header. */
  74734. if( pC->aRow==0 ){
  74735. memset(&sMem, 0, sizeof(sMem));
  74736. rc = sqlite3VdbeMemFromBtree(pCrsr, 0, aOffset[0], !pC->isTable, &sMem);
  74737. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  74738. zData = (u8*)sMem.z;
  74739. }else{
  74740. zData = pC->aRow;
  74741. }
  74742. /* Fill in pC->aType[i] and aOffset[i] values through the p2-th field. */
  74743. op_column_read_header:
  74744. i = pC->nHdrParsed;
  74745. offset64 = aOffset[i];
  74746. zHdr = zData + pC->iHdrOffset;
  74747. zEndHdr = zData + aOffset[0];
  74748. do{
  74749. if( (t = zHdr[0])<0x80 ){
  74750. zHdr++;
  74751. offset64 += sqlite3VdbeOneByteSerialTypeLen(t);
  74752. }else{
  74753. zHdr += sqlite3GetVarint32(zHdr, &t);
  74754. offset64 += sqlite3VdbeSerialTypeLen(t);
  74755. }
  74756. pC->aType[i++] = t;
  74757. aOffset[i] = (u32)(offset64 & 0xffffffff);
  74758. }while( i<=p2 && zHdr<zEndHdr );
  74759. /* The record is corrupt if any of the following are true:
  74760. ** (1) the bytes of the header extend past the declared header size
  74761. ** (2) the entire header was used but not all data was used
  74762. ** (3) the end of the data extends beyond the end of the record.
  74763. */
  74764. if( (zHdr>=zEndHdr && (zHdr>zEndHdr || offset64!=pC->payloadSize))
  74765. || (offset64 > pC->payloadSize)
  74766. ){
  74767. if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
  74768. rc = SQLITE_CORRUPT_BKPT;
  74769. goto abort_due_to_error;
  74770. }
  74771. pC->nHdrParsed = i;
  74772. pC->iHdrOffset = (u32)(zHdr - zData);
  74773. if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
  74774. }else{
  74775. t = 0;
  74776. }
  74777. /* If after trying to extract new entries from the header, nHdrParsed is
  74778. ** still not up to p2, that means that the record has fewer than p2
  74779. ** columns. So the result will be either the default value or a NULL.
  74780. */
  74781. if( pC->nHdrParsed<=p2 ){
  74782. if( pOp->p4type==P4_MEM ){
  74783. sqlite3VdbeMemShallowCopy(pDest, pOp->p4.pMem, MEM_Static);
  74784. }else{
  74785. sqlite3VdbeMemSetNull(pDest);
  74786. }
  74787. goto op_column_out;
  74788. }
  74789. }else{
  74790. t = pC->aType[p2];
  74791. }
  74792. /* Extract the content for the p2+1-th column. Control can only
  74793. ** reach this point if aOffset[p2], aOffset[p2+1], and pC->aType[p2] are
  74794. ** all valid.
  74795. */
  74796. assert( p2<pC->nHdrParsed );
  74797. assert( rc==SQLITE_OK );
  74798. assert( sqlite3VdbeCheckMemInvariants(pDest) );
  74799. if( VdbeMemDynamic(pDest) ){
  74800. sqlite3VdbeMemSetNull(pDest);
  74801. }
  74802. assert( t==pC->aType[p2] );
  74803. if( pC->szRow>=aOffset[p2+1] ){
  74804. /* This is the common case where the desired content fits on the original
  74805. ** page - where the content is not on an overflow page */
  74806. zData = pC->aRow + aOffset[p2];
  74807. if( t<12 ){
  74808. sqlite3VdbeSerialGet(zData, t, pDest);
  74809. }else{
  74810. /* If the column value is a string, we need a persistent value, not
  74811. ** a MEM_Ephem value. This branch is a fast short-cut that is equivalent
  74812. ** to calling sqlite3VdbeSerialGet() and sqlite3VdbeDeephemeralize().
  74813. */
  74814. static const u16 aFlag[] = { MEM_Blob, MEM_Str|MEM_Term };
  74815. pDest->n = len = (t-12)/2;
  74816. pDest->enc = encoding;
  74817. if( pDest->szMalloc < len+2 ){
  74818. pDest->flags = MEM_Null;
  74819. if( sqlite3VdbeMemGrow(pDest, len+2, 0) ) goto no_mem;
  74820. }else{
  74821. pDest->z = pDest->zMalloc;
  74822. }
  74823. memcpy(pDest->z, zData, len);
  74824. pDest->z[len] = 0;
  74825. pDest->z[len+1] = 0;
  74826. pDest->flags = aFlag[t&1];
  74827. }
  74828. }else{
  74829. pDest->enc = encoding;
  74830. /* This branch happens only when content is on overflow pages */
  74831. if( ((pOp->p5 & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG))!=0
  74832. && ((t>=12 && (t&1)==0) || (pOp->p5 & OPFLAG_TYPEOFARG)!=0))
  74833. || (len = sqlite3VdbeSerialTypeLen(t))==0
  74834. ){
  74835. /* Content is irrelevant for
  74836. ** 1. the typeof() function,
  74837. ** 2. the length(X) function if X is a blob, and
  74838. ** 3. if the content length is zero.
  74839. ** So we might as well use bogus content rather than reading
  74840. ** content from disk. */
  74841. static u8 aZero[8]; /* This is the bogus content */
  74842. sqlite3VdbeSerialGet(aZero, t, pDest);
  74843. }else{
  74844. rc = sqlite3VdbeMemFromBtree(pCrsr, aOffset[p2], len, !pC->isTable,
  74845. pDest);
  74846. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  74847. sqlite3VdbeSerialGet((const u8*)pDest->z, t, pDest);
  74848. pDest->flags &= ~MEM_Ephem;
  74849. }
  74850. }
  74851. op_column_out:
  74852. UPDATE_MAX_BLOBSIZE(pDest);
  74853. REGISTER_TRACE(pOp->p3, pDest);
  74854. break;
  74855. }
  74856. /* Opcode: Affinity P1 P2 * P4 *
  74857. ** Synopsis: affinity(r[P1@P2])
  74858. **
  74859. ** Apply affinities to a range of P2 registers starting with P1.
  74860. **
  74861. ** P4 is a string that is P2 characters long. The nth character of the
  74862. ** string indicates the column affinity that should be used for the nth
  74863. ** memory cell in the range.
  74864. */
  74865. case OP_Affinity: {
  74866. const char *zAffinity; /* The affinity to be applied */
  74867. char cAff; /* A single character of affinity */
  74868. zAffinity = pOp->p4.z;
  74869. assert( zAffinity!=0 );
  74870. assert( zAffinity[pOp->p2]==0 );
  74871. pIn1 = &aMem[pOp->p1];
  74872. while( (cAff = *(zAffinity++))!=0 ){
  74873. assert( pIn1 <= &p->aMem[(p->nMem+1 - p->nCursor)] );
  74874. assert( memIsValid(pIn1) );
  74875. applyAffinity(pIn1, cAff, encoding);
  74876. pIn1++;
  74877. }
  74878. break;
  74879. }
  74880. /* Opcode: MakeRecord P1 P2 P3 P4 *
  74881. ** Synopsis: r[P3]=mkrec(r[P1@P2])
  74882. **
  74883. ** Convert P2 registers beginning with P1 into the [record format]
  74884. ** use as a data record in a database table or as a key
  74885. ** in an index. The OP_Column opcode can decode the record later.
  74886. **
  74887. ** P4 may be a string that is P2 characters long. The nth character of the
  74888. ** string indicates the column affinity that should be used for the nth
  74889. ** field of the index key.
  74890. **
  74891. ** The mapping from character to affinity is given by the SQLITE_AFF_
  74892. ** macros defined in sqliteInt.h.
  74893. **
  74894. ** If P4 is NULL then all index fields have the affinity BLOB.
  74895. */
  74896. case OP_MakeRecord: {
  74897. u8 *zNewRecord; /* A buffer to hold the data for the new record */
  74898. Mem *pRec; /* The new record */
  74899. u64 nData; /* Number of bytes of data space */
  74900. int nHdr; /* Number of bytes of header space */
  74901. i64 nByte; /* Data space required for this record */
  74902. i64 nZero; /* Number of zero bytes at the end of the record */
  74903. int nVarint; /* Number of bytes in a varint */
  74904. u32 serial_type; /* Type field */
  74905. Mem *pData0; /* First field to be combined into the record */
  74906. Mem *pLast; /* Last field of the record */
  74907. int nField; /* Number of fields in the record */
  74908. char *zAffinity; /* The affinity string for the record */
  74909. int file_format; /* File format to use for encoding */
  74910. int i; /* Space used in zNewRecord[] header */
  74911. int j; /* Space used in zNewRecord[] content */
  74912. u32 len; /* Length of a field */
  74913. /* Assuming the record contains N fields, the record format looks
  74914. ** like this:
  74915. **
  74916. ** ------------------------------------------------------------------------
  74917. ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
  74918. ** ------------------------------------------------------------------------
  74919. **
  74920. ** Data(0) is taken from register P1. Data(1) comes from register P1+1
  74921. ** and so forth.
  74922. **
  74923. ** Each type field is a varint representing the serial type of the
  74924. ** corresponding data element (see sqlite3VdbeSerialType()). The
  74925. ** hdr-size field is also a varint which is the offset from the beginning
  74926. ** of the record to data0.
  74927. */
  74928. nData = 0; /* Number of bytes of data space */
  74929. nHdr = 0; /* Number of bytes of header space */
  74930. nZero = 0; /* Number of zero bytes at the end of the record */
  74931. nField = pOp->p1;
  74932. zAffinity = pOp->p4.z;
  74933. assert( nField>0 && pOp->p2>0 && pOp->p2+nField<=(p->nMem+1 - p->nCursor)+1 );
  74934. pData0 = &aMem[nField];
  74935. nField = pOp->p2;
  74936. pLast = &pData0[nField-1];
  74937. file_format = p->minWriteFileFormat;
  74938. /* Identify the output register */
  74939. assert( pOp->p3<pOp->p1 || pOp->p3>=pOp->p1+pOp->p2 );
  74940. pOut = &aMem[pOp->p3];
  74941. memAboutToChange(p, pOut);
  74942. /* Apply the requested affinity to all inputs
  74943. */
  74944. assert( pData0<=pLast );
  74945. if( zAffinity ){
  74946. pRec = pData0;
  74947. do{
  74948. applyAffinity(pRec++, *(zAffinity++), encoding);
  74949. assert( zAffinity[0]==0 || pRec<=pLast );
  74950. }while( zAffinity[0] );
  74951. }
  74952. /* Loop through the elements that will make up the record to figure
  74953. ** out how much space is required for the new record.
  74954. */
  74955. pRec = pLast;
  74956. do{
  74957. assert( memIsValid(pRec) );
  74958. pRec->uTemp = serial_type = sqlite3VdbeSerialType(pRec, file_format, &len);
  74959. if( pRec->flags & MEM_Zero ){
  74960. if( nData ){
  74961. if( sqlite3VdbeMemExpandBlob(pRec) ) goto no_mem;
  74962. }else{
  74963. nZero += pRec->u.nZero;
  74964. len -= pRec->u.nZero;
  74965. }
  74966. }
  74967. nData += len;
  74968. testcase( serial_type==127 );
  74969. testcase( serial_type==128 );
  74970. nHdr += serial_type<=127 ? 1 : sqlite3VarintLen(serial_type);
  74971. if( pRec==pData0 ) break;
  74972. pRec--;
  74973. }while(1);
  74974. /* EVIDENCE-OF: R-22564-11647 The header begins with a single varint
  74975. ** which determines the total number of bytes in the header. The varint
  74976. ** value is the size of the header in bytes including the size varint
  74977. ** itself. */
  74978. testcase( nHdr==126 );
  74979. testcase( nHdr==127 );
  74980. if( nHdr<=126 ){
  74981. /* The common case */
  74982. nHdr += 1;
  74983. }else{
  74984. /* Rare case of a really large header */
  74985. nVarint = sqlite3VarintLen(nHdr);
  74986. nHdr += nVarint;
  74987. if( nVarint<sqlite3VarintLen(nHdr) ) nHdr++;
  74988. }
  74989. nByte = nHdr+nData;
  74990. if( nByte+nZero>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  74991. goto too_big;
  74992. }
  74993. /* Make sure the output register has a buffer large enough to store
  74994. ** the new record. The output register (pOp->p3) is not allowed to
  74995. ** be one of the input registers (because the following call to
  74996. ** sqlite3VdbeMemClearAndResize() could clobber the value before it is used).
  74997. */
  74998. if( sqlite3VdbeMemClearAndResize(pOut, (int)nByte) ){
  74999. goto no_mem;
  75000. }
  75001. zNewRecord = (u8 *)pOut->z;
  75002. /* Write the record */
  75003. i = putVarint32(zNewRecord, nHdr);
  75004. j = nHdr;
  75005. assert( pData0<=pLast );
  75006. pRec = pData0;
  75007. do{
  75008. serial_type = pRec->uTemp;
  75009. /* EVIDENCE-OF: R-06529-47362 Following the size varint are one or more
  75010. ** additional varints, one per column. */
  75011. i += putVarint32(&zNewRecord[i], serial_type); /* serial type */
  75012. /* EVIDENCE-OF: R-64536-51728 The values for each column in the record
  75013. ** immediately follow the header. */
  75014. j += sqlite3VdbeSerialPut(&zNewRecord[j], pRec, serial_type); /* content */
  75015. }while( (++pRec)<=pLast );
  75016. assert( i==nHdr );
  75017. assert( j==nByte );
  75018. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  75019. pOut->n = (int)nByte;
  75020. pOut->flags = MEM_Blob;
  75021. if( nZero ){
  75022. pOut->u.nZero = nZero;
  75023. pOut->flags |= MEM_Zero;
  75024. }
  75025. pOut->enc = SQLITE_UTF8; /* In case the blob is ever converted to text */
  75026. REGISTER_TRACE(pOp->p3, pOut);
  75027. UPDATE_MAX_BLOBSIZE(pOut);
  75028. break;
  75029. }
  75030. /* Opcode: Count P1 P2 * * *
  75031. ** Synopsis: r[P2]=count()
  75032. **
  75033. ** Store the number of entries (an integer value) in the table or index
  75034. ** opened by cursor P1 in register P2
  75035. */
  75036. #ifndef SQLITE_OMIT_BTREECOUNT
  75037. case OP_Count: { /* out2 */
  75038. i64 nEntry;
  75039. BtCursor *pCrsr;
  75040. assert( p->apCsr[pOp->p1]->eCurType==CURTYPE_BTREE );
  75041. pCrsr = p->apCsr[pOp->p1]->uc.pCursor;
  75042. assert( pCrsr );
  75043. nEntry = 0; /* Not needed. Only used to silence a warning. */
  75044. rc = sqlite3BtreeCount(pCrsr, &nEntry);
  75045. if( rc ) goto abort_due_to_error;
  75046. pOut = out2Prerelease(p, pOp);
  75047. pOut->u.i = nEntry;
  75048. break;
  75049. }
  75050. #endif
  75051. /* Opcode: Savepoint P1 * * P4 *
  75052. **
  75053. ** Open, release or rollback the savepoint named by parameter P4, depending
  75054. ** on the value of P1. To open a new savepoint, P1==0. To release (commit) an
  75055. ** existing savepoint, P1==1, or to rollback an existing savepoint P1==2.
  75056. */
  75057. case OP_Savepoint: {
  75058. int p1; /* Value of P1 operand */
  75059. char *zName; /* Name of savepoint */
  75060. int nName;
  75061. Savepoint *pNew;
  75062. Savepoint *pSavepoint;
  75063. Savepoint *pTmp;
  75064. int iSavepoint;
  75065. int ii;
  75066. p1 = pOp->p1;
  75067. zName = pOp->p4.z;
  75068. /* Assert that the p1 parameter is valid. Also that if there is no open
  75069. ** transaction, then there cannot be any savepoints.
  75070. */
  75071. assert( db->pSavepoint==0 || db->autoCommit==0 );
  75072. assert( p1==SAVEPOINT_BEGIN||p1==SAVEPOINT_RELEASE||p1==SAVEPOINT_ROLLBACK );
  75073. assert( db->pSavepoint || db->isTransactionSavepoint==0 );
  75074. assert( checkSavepointCount(db) );
  75075. assert( p->bIsReader );
  75076. if( p1==SAVEPOINT_BEGIN ){
  75077. if( db->nVdbeWrite>0 ){
  75078. /* A new savepoint cannot be created if there are active write
  75079. ** statements (i.e. open read/write incremental blob handles).
  75080. */
  75081. sqlite3VdbeError(p, "cannot open savepoint - SQL statements in progress");
  75082. rc = SQLITE_BUSY;
  75083. }else{
  75084. nName = sqlite3Strlen30(zName);
  75085. #ifndef SQLITE_OMIT_VIRTUALTABLE
  75086. /* This call is Ok even if this savepoint is actually a transaction
  75087. ** savepoint (and therefore should not prompt xSavepoint()) callbacks.
  75088. ** If this is a transaction savepoint being opened, it is guaranteed
  75089. ** that the db->aVTrans[] array is empty. */
  75090. assert( db->autoCommit==0 || db->nVTrans==0 );
  75091. rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN,
  75092. db->nStatement+db->nSavepoint);
  75093. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  75094. #endif
  75095. /* Create a new savepoint structure. */
  75096. pNew = sqlite3DbMallocRawNN(db, sizeof(Savepoint)+nName+1);
  75097. if( pNew ){
  75098. pNew->zName = (char *)&pNew[1];
  75099. memcpy(pNew->zName, zName, nName+1);
  75100. /* If there is no open transaction, then mark this as a special
  75101. ** "transaction savepoint". */
  75102. if( db->autoCommit ){
  75103. db->autoCommit = 0;
  75104. db->isTransactionSavepoint = 1;
  75105. }else{
  75106. db->nSavepoint++;
  75107. }
  75108. /* Link the new savepoint into the database handle's list. */
  75109. pNew->pNext = db->pSavepoint;
  75110. db->pSavepoint = pNew;
  75111. pNew->nDeferredCons = db->nDeferredCons;
  75112. pNew->nDeferredImmCons = db->nDeferredImmCons;
  75113. }
  75114. }
  75115. }else{
  75116. iSavepoint = 0;
  75117. /* Find the named savepoint. If there is no such savepoint, then an
  75118. ** an error is returned to the user. */
  75119. for(
  75120. pSavepoint = db->pSavepoint;
  75121. pSavepoint && sqlite3StrICmp(pSavepoint->zName, zName);
  75122. pSavepoint = pSavepoint->pNext
  75123. ){
  75124. iSavepoint++;
  75125. }
  75126. if( !pSavepoint ){
  75127. sqlite3VdbeError(p, "no such savepoint: %s", zName);
  75128. rc = SQLITE_ERROR;
  75129. }else if( db->nVdbeWrite>0 && p1==SAVEPOINT_RELEASE ){
  75130. /* It is not possible to release (commit) a savepoint if there are
  75131. ** active write statements.
  75132. */
  75133. sqlite3VdbeError(p, "cannot release savepoint - "
  75134. "SQL statements in progress");
  75135. rc = SQLITE_BUSY;
  75136. }else{
  75137. /* Determine whether or not this is a transaction savepoint. If so,
  75138. ** and this is a RELEASE command, then the current transaction
  75139. ** is committed.
  75140. */
  75141. int isTransaction = pSavepoint->pNext==0 && db->isTransactionSavepoint;
  75142. if( isTransaction && p1==SAVEPOINT_RELEASE ){
  75143. if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
  75144. goto vdbe_return;
  75145. }
  75146. db->autoCommit = 1;
  75147. if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
  75148. p->pc = (int)(pOp - aOp);
  75149. db->autoCommit = 0;
  75150. p->rc = rc = SQLITE_BUSY;
  75151. goto vdbe_return;
  75152. }
  75153. db->isTransactionSavepoint = 0;
  75154. rc = p->rc;
  75155. }else{
  75156. int isSchemaChange;
  75157. iSavepoint = db->nSavepoint - iSavepoint - 1;
  75158. if( p1==SAVEPOINT_ROLLBACK ){
  75159. isSchemaChange = (db->flags & SQLITE_InternChanges)!=0;
  75160. for(ii=0; ii<db->nDb; ii++){
  75161. rc = sqlite3BtreeTripAllCursors(db->aDb[ii].pBt,
  75162. SQLITE_ABORT_ROLLBACK,
  75163. isSchemaChange==0);
  75164. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  75165. }
  75166. }else{
  75167. isSchemaChange = 0;
  75168. }
  75169. for(ii=0; ii<db->nDb; ii++){
  75170. rc = sqlite3BtreeSavepoint(db->aDb[ii].pBt, p1, iSavepoint);
  75171. if( rc!=SQLITE_OK ){
  75172. goto abort_due_to_error;
  75173. }
  75174. }
  75175. if( isSchemaChange ){
  75176. sqlite3ExpirePreparedStatements(db);
  75177. sqlite3ResetAllSchemasOfConnection(db);
  75178. db->flags = (db->flags | SQLITE_InternChanges);
  75179. }
  75180. }
  75181. /* Regardless of whether this is a RELEASE or ROLLBACK, destroy all
  75182. ** savepoints nested inside of the savepoint being operated on. */
  75183. while( db->pSavepoint!=pSavepoint ){
  75184. pTmp = db->pSavepoint;
  75185. db->pSavepoint = pTmp->pNext;
  75186. sqlite3DbFree(db, pTmp);
  75187. db->nSavepoint--;
  75188. }
  75189. /* If it is a RELEASE, then destroy the savepoint being operated on
  75190. ** too. If it is a ROLLBACK TO, then set the number of deferred
  75191. ** constraint violations present in the database to the value stored
  75192. ** when the savepoint was created. */
  75193. if( p1==SAVEPOINT_RELEASE ){
  75194. assert( pSavepoint==db->pSavepoint );
  75195. db->pSavepoint = pSavepoint->pNext;
  75196. sqlite3DbFree(db, pSavepoint);
  75197. if( !isTransaction ){
  75198. db->nSavepoint--;
  75199. }
  75200. }else{
  75201. db->nDeferredCons = pSavepoint->nDeferredCons;
  75202. db->nDeferredImmCons = pSavepoint->nDeferredImmCons;
  75203. }
  75204. if( !isTransaction || p1==SAVEPOINT_ROLLBACK ){
  75205. rc = sqlite3VtabSavepoint(db, p1, iSavepoint);
  75206. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  75207. }
  75208. }
  75209. }
  75210. if( rc ) goto abort_due_to_error;
  75211. break;
  75212. }
  75213. /* Opcode: AutoCommit P1 P2 * * *
  75214. **
  75215. ** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
  75216. ** back any currently active btree transactions. If there are any active
  75217. ** VMs (apart from this one), then a ROLLBACK fails. A COMMIT fails if
  75218. ** there are active writing VMs or active VMs that use shared cache.
  75219. **
  75220. ** This instruction causes the VM to halt.
  75221. */
  75222. case OP_AutoCommit: {
  75223. int desiredAutoCommit;
  75224. int iRollback;
  75225. desiredAutoCommit = pOp->p1;
  75226. iRollback = pOp->p2;
  75227. assert( desiredAutoCommit==1 || desiredAutoCommit==0 );
  75228. assert( desiredAutoCommit==1 || iRollback==0 );
  75229. assert( db->nVdbeActive>0 ); /* At least this one VM is active */
  75230. assert( p->bIsReader );
  75231. if( desiredAutoCommit!=db->autoCommit ){
  75232. if( iRollback ){
  75233. assert( desiredAutoCommit==1 );
  75234. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  75235. db->autoCommit = 1;
  75236. }else if( desiredAutoCommit && db->nVdbeWrite>0 ){
  75237. /* If this instruction implements a COMMIT and other VMs are writing
  75238. ** return an error indicating that the other VMs must complete first.
  75239. */
  75240. sqlite3VdbeError(p, "cannot commit transaction - "
  75241. "SQL statements in progress");
  75242. rc = SQLITE_BUSY;
  75243. goto abort_due_to_error;
  75244. }else if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
  75245. goto vdbe_return;
  75246. }else{
  75247. db->autoCommit = (u8)desiredAutoCommit;
  75248. }
  75249. if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
  75250. p->pc = (int)(pOp - aOp);
  75251. db->autoCommit = (u8)(1-desiredAutoCommit);
  75252. p->rc = rc = SQLITE_BUSY;
  75253. goto vdbe_return;
  75254. }
  75255. assert( db->nStatement==0 );
  75256. sqlite3CloseSavepoints(db);
  75257. if( p->rc==SQLITE_OK ){
  75258. rc = SQLITE_DONE;
  75259. }else{
  75260. rc = SQLITE_ERROR;
  75261. }
  75262. goto vdbe_return;
  75263. }else{
  75264. sqlite3VdbeError(p,
  75265. (!desiredAutoCommit)?"cannot start a transaction within a transaction":(
  75266. (iRollback)?"cannot rollback - no transaction is active":
  75267. "cannot commit - no transaction is active"));
  75268. rc = SQLITE_ERROR;
  75269. goto abort_due_to_error;
  75270. }
  75271. break;
  75272. }
  75273. /* Opcode: Transaction P1 P2 P3 P4 P5
  75274. **
  75275. ** Begin a transaction on database P1 if a transaction is not already
  75276. ** active.
  75277. ** If P2 is non-zero, then a write-transaction is started, or if a
  75278. ** read-transaction is already active, it is upgraded to a write-transaction.
  75279. ** If P2 is zero, then a read-transaction is started.
  75280. **
  75281. ** P1 is the index of the database file on which the transaction is
  75282. ** started. Index 0 is the main database file and index 1 is the
  75283. ** file used for temporary tables. Indices of 2 or more are used for
  75284. ** attached databases.
  75285. **
  75286. ** If a write-transaction is started and the Vdbe.usesStmtJournal flag is
  75287. ** true (this flag is set if the Vdbe may modify more than one row and may
  75288. ** throw an ABORT exception), a statement transaction may also be opened.
  75289. ** More specifically, a statement transaction is opened iff the database
  75290. ** connection is currently not in autocommit mode, or if there are other
  75291. ** active statements. A statement transaction allows the changes made by this
  75292. ** VDBE to be rolled back after an error without having to roll back the
  75293. ** entire transaction. If no error is encountered, the statement transaction
  75294. ** will automatically commit when the VDBE halts.
  75295. **
  75296. ** If P5!=0 then this opcode also checks the schema cookie against P3
  75297. ** and the schema generation counter against P4.
  75298. ** The cookie changes its value whenever the database schema changes.
  75299. ** This operation is used to detect when that the cookie has changed
  75300. ** and that the current process needs to reread the schema. If the schema
  75301. ** cookie in P3 differs from the schema cookie in the database header or
  75302. ** if the schema generation counter in P4 differs from the current
  75303. ** generation counter, then an SQLITE_SCHEMA error is raised and execution
  75304. ** halts. The sqlite3_step() wrapper function might then reprepare the
  75305. ** statement and rerun it from the beginning.
  75306. */
  75307. case OP_Transaction: {
  75308. Btree *pBt;
  75309. int iMeta;
  75310. int iGen;
  75311. assert( p->bIsReader );
  75312. assert( p->readOnly==0 || pOp->p2==0 );
  75313. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  75314. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  75315. if( pOp->p2 && (db->flags & SQLITE_QueryOnly)!=0 ){
  75316. rc = SQLITE_READONLY;
  75317. goto abort_due_to_error;
  75318. }
  75319. pBt = db->aDb[pOp->p1].pBt;
  75320. if( pBt ){
  75321. rc = sqlite3BtreeBeginTrans(pBt, pOp->p2);
  75322. testcase( rc==SQLITE_BUSY_SNAPSHOT );
  75323. testcase( rc==SQLITE_BUSY_RECOVERY );
  75324. if( rc!=SQLITE_OK ){
  75325. if( (rc&0xff)==SQLITE_BUSY ){
  75326. p->pc = (int)(pOp - aOp);
  75327. p->rc = rc;
  75328. goto vdbe_return;
  75329. }
  75330. goto abort_due_to_error;
  75331. }
  75332. if( pOp->p2 && p->usesStmtJournal
  75333. && (db->autoCommit==0 || db->nVdbeRead>1)
  75334. ){
  75335. assert( sqlite3BtreeIsInTrans(pBt) );
  75336. if( p->iStatement==0 ){
  75337. assert( db->nStatement>=0 && db->nSavepoint>=0 );
  75338. db->nStatement++;
  75339. p->iStatement = db->nSavepoint + db->nStatement;
  75340. }
  75341. rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN, p->iStatement-1);
  75342. if( rc==SQLITE_OK ){
  75343. rc = sqlite3BtreeBeginStmt(pBt, p->iStatement);
  75344. }
  75345. /* Store the current value of the database handles deferred constraint
  75346. ** counter. If the statement transaction needs to be rolled back,
  75347. ** the value of this counter needs to be restored too. */
  75348. p->nStmtDefCons = db->nDeferredCons;
  75349. p->nStmtDefImmCons = db->nDeferredImmCons;
  75350. }
  75351. /* Gather the schema version number for checking:
  75352. ** IMPLEMENTATION-OF: R-03189-51135 As each SQL statement runs, the schema
  75353. ** version is checked to ensure that the schema has not changed since the
  75354. ** SQL statement was prepared.
  75355. */
  75356. sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&iMeta);
  75357. iGen = db->aDb[pOp->p1].pSchema->iGeneration;
  75358. }else{
  75359. iGen = iMeta = 0;
  75360. }
  75361. assert( pOp->p5==0 || pOp->p4type==P4_INT32 );
  75362. if( pOp->p5 && (iMeta!=pOp->p3 || iGen!=pOp->p4.i) ){
  75363. sqlite3DbFree(db, p->zErrMsg);
  75364. p->zErrMsg = sqlite3DbStrDup(db, "database schema has changed");
  75365. /* If the schema-cookie from the database file matches the cookie
  75366. ** stored with the in-memory representation of the schema, do
  75367. ** not reload the schema from the database file.
  75368. **
  75369. ** If virtual-tables are in use, this is not just an optimization.
  75370. ** Often, v-tables store their data in other SQLite tables, which
  75371. ** are queried from within xNext() and other v-table methods using
  75372. ** prepared queries. If such a query is out-of-date, we do not want to
  75373. ** discard the database schema, as the user code implementing the
  75374. ** v-table would have to be ready for the sqlite3_vtab structure itself
  75375. ** to be invalidated whenever sqlite3_step() is called from within
  75376. ** a v-table method.
  75377. */
  75378. if( db->aDb[pOp->p1].pSchema->schema_cookie!=iMeta ){
  75379. sqlite3ResetOneSchema(db, pOp->p1);
  75380. }
  75381. p->expired = 1;
  75382. rc = SQLITE_SCHEMA;
  75383. }
  75384. if( rc ) goto abort_due_to_error;
  75385. break;
  75386. }
  75387. /* Opcode: ReadCookie P1 P2 P3 * *
  75388. **
  75389. ** Read cookie number P3 from database P1 and write it into register P2.
  75390. ** P3==1 is the schema version. P3==2 is the database format.
  75391. ** P3==3 is the recommended pager cache size, and so forth. P1==0 is
  75392. ** the main database file and P1==1 is the database file used to store
  75393. ** temporary tables.
  75394. **
  75395. ** There must be a read-lock on the database (either a transaction
  75396. ** must be started or there must be an open cursor) before
  75397. ** executing this instruction.
  75398. */
  75399. case OP_ReadCookie: { /* out2 */
  75400. int iMeta;
  75401. int iDb;
  75402. int iCookie;
  75403. assert( p->bIsReader );
  75404. iDb = pOp->p1;
  75405. iCookie = pOp->p3;
  75406. assert( pOp->p3<SQLITE_N_BTREE_META );
  75407. assert( iDb>=0 && iDb<db->nDb );
  75408. assert( db->aDb[iDb].pBt!=0 );
  75409. assert( DbMaskTest(p->btreeMask, iDb) );
  75410. sqlite3BtreeGetMeta(db->aDb[iDb].pBt, iCookie, (u32 *)&iMeta);
  75411. pOut = out2Prerelease(p, pOp);
  75412. pOut->u.i = iMeta;
  75413. break;
  75414. }
  75415. /* Opcode: SetCookie P1 P2 P3 * *
  75416. **
  75417. ** Write the integer value P3 into cookie number P2 of database P1.
  75418. ** P2==1 is the schema version. P2==2 is the database format.
  75419. ** P2==3 is the recommended pager cache
  75420. ** size, and so forth. P1==0 is the main database file and P1==1 is the
  75421. ** database file used to store temporary tables.
  75422. **
  75423. ** A transaction must be started before executing this opcode.
  75424. */
  75425. case OP_SetCookie: {
  75426. Db *pDb;
  75427. assert( pOp->p2<SQLITE_N_BTREE_META );
  75428. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  75429. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  75430. assert( p->readOnly==0 );
  75431. pDb = &db->aDb[pOp->p1];
  75432. assert( pDb->pBt!=0 );
  75433. assert( sqlite3SchemaMutexHeld(db, pOp->p1, 0) );
  75434. /* See note about index shifting on OP_ReadCookie */
  75435. rc = sqlite3BtreeUpdateMeta(pDb->pBt, pOp->p2, pOp->p3);
  75436. if( pOp->p2==BTREE_SCHEMA_VERSION ){
  75437. /* When the schema cookie changes, record the new cookie internally */
  75438. pDb->pSchema->schema_cookie = pOp->p3;
  75439. db->flags |= SQLITE_InternChanges;
  75440. }else if( pOp->p2==BTREE_FILE_FORMAT ){
  75441. /* Record changes in the file format */
  75442. pDb->pSchema->file_format = pOp->p3;
  75443. }
  75444. if( pOp->p1==1 ){
  75445. /* Invalidate all prepared statements whenever the TEMP database
  75446. ** schema is changed. Ticket #1644 */
  75447. sqlite3ExpirePreparedStatements(db);
  75448. p->expired = 0;
  75449. }
  75450. if( rc ) goto abort_due_to_error;
  75451. break;
  75452. }
  75453. /* Opcode: OpenRead P1 P2 P3 P4 P5
  75454. ** Synopsis: root=P2 iDb=P3
  75455. **
  75456. ** Open a read-only cursor for the database table whose root page is
  75457. ** P2 in a database file. The database file is determined by P3.
  75458. ** P3==0 means the main database, P3==1 means the database used for
  75459. ** temporary tables, and P3>1 means used the corresponding attached
  75460. ** database. Give the new cursor an identifier of P1. The P1
  75461. ** values need not be contiguous but all P1 values should be small integers.
  75462. ** It is an error for P1 to be negative.
  75463. **
  75464. ** If P5!=0 then use the content of register P2 as the root page, not
  75465. ** the value of P2 itself.
  75466. **
  75467. ** There will be a read lock on the database whenever there is an
  75468. ** open cursor. If the database was unlocked prior to this instruction
  75469. ** then a read lock is acquired as part of this instruction. A read
  75470. ** lock allows other processes to read the database but prohibits
  75471. ** any other process from modifying the database. The read lock is
  75472. ** released when all cursors are closed. If this instruction attempts
  75473. ** to get a read lock but fails, the script terminates with an
  75474. ** SQLITE_BUSY error code.
  75475. **
  75476. ** The P4 value may be either an integer (P4_INT32) or a pointer to
  75477. ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
  75478. ** structure, then said structure defines the content and collating
  75479. ** sequence of the index being opened. Otherwise, if P4 is an integer
  75480. ** value, it is set to the number of columns in the table.
  75481. **
  75482. ** See also: OpenWrite, ReopenIdx
  75483. */
  75484. /* Opcode: ReopenIdx P1 P2 P3 P4 P5
  75485. ** Synopsis: root=P2 iDb=P3
  75486. **
  75487. ** The ReopenIdx opcode works exactly like ReadOpen except that it first
  75488. ** checks to see if the cursor on P1 is already open with a root page
  75489. ** number of P2 and if it is this opcode becomes a no-op. In other words,
  75490. ** if the cursor is already open, do not reopen it.
  75491. **
  75492. ** The ReopenIdx opcode may only be used with P5==0 and with P4 being
  75493. ** a P4_KEYINFO object. Furthermore, the P3 value must be the same as
  75494. ** every other ReopenIdx or OpenRead for the same cursor number.
  75495. **
  75496. ** See the OpenRead opcode documentation for additional information.
  75497. */
  75498. /* Opcode: OpenWrite P1 P2 P3 P4 P5
  75499. ** Synopsis: root=P2 iDb=P3
  75500. **
  75501. ** Open a read/write cursor named P1 on the table or index whose root
  75502. ** page is P2. Or if P5!=0 use the content of register P2 to find the
  75503. ** root page.
  75504. **
  75505. ** The P4 value may be either an integer (P4_INT32) or a pointer to
  75506. ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
  75507. ** structure, then said structure defines the content and collating
  75508. ** sequence of the index being opened. Otherwise, if P4 is an integer
  75509. ** value, it is set to the number of columns in the table, or to the
  75510. ** largest index of any column of the table that is actually used.
  75511. **
  75512. ** This instruction works just like OpenRead except that it opens the cursor
  75513. ** in read/write mode. For a given table, there can be one or more read-only
  75514. ** cursors or a single read/write cursor but not both.
  75515. **
  75516. ** See also OpenRead.
  75517. */
  75518. case OP_ReopenIdx: {
  75519. int nField;
  75520. KeyInfo *pKeyInfo;
  75521. int p2;
  75522. int iDb;
  75523. int wrFlag;
  75524. Btree *pX;
  75525. VdbeCursor *pCur;
  75526. Db *pDb;
  75527. assert( pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
  75528. assert( pOp->p4type==P4_KEYINFO );
  75529. pCur = p->apCsr[pOp->p1];
  75530. if( pCur && pCur->pgnoRoot==(u32)pOp->p2 ){
  75531. assert( pCur->iDb==pOp->p3 ); /* Guaranteed by the code generator */
  75532. goto open_cursor_set_hints;
  75533. }
  75534. /* If the cursor is not currently open or is open on a different
  75535. ** index, then fall through into OP_OpenRead to force a reopen */
  75536. case OP_OpenRead:
  75537. case OP_OpenWrite:
  75538. assert( pOp->opcode==OP_OpenWrite || pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
  75539. assert( p->bIsReader );
  75540. assert( pOp->opcode==OP_OpenRead || pOp->opcode==OP_ReopenIdx
  75541. || p->readOnly==0 );
  75542. if( p->expired ){
  75543. rc = SQLITE_ABORT_ROLLBACK;
  75544. goto abort_due_to_error;
  75545. }
  75546. nField = 0;
  75547. pKeyInfo = 0;
  75548. p2 = pOp->p2;
  75549. iDb = pOp->p3;
  75550. assert( iDb>=0 && iDb<db->nDb );
  75551. assert( DbMaskTest(p->btreeMask, iDb) );
  75552. pDb = &db->aDb[iDb];
  75553. pX = pDb->pBt;
  75554. assert( pX!=0 );
  75555. if( pOp->opcode==OP_OpenWrite ){
  75556. assert( OPFLAG_FORDELETE==BTREE_FORDELETE );
  75557. wrFlag = BTREE_WRCSR | (pOp->p5 & OPFLAG_FORDELETE);
  75558. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  75559. if( pDb->pSchema->file_format < p->minWriteFileFormat ){
  75560. p->minWriteFileFormat = pDb->pSchema->file_format;
  75561. }
  75562. }else{
  75563. wrFlag = 0;
  75564. }
  75565. if( pOp->p5 & OPFLAG_P2ISREG ){
  75566. assert( p2>0 );
  75567. assert( p2<=(p->nMem+1 - p->nCursor) );
  75568. pIn2 = &aMem[p2];
  75569. assert( memIsValid(pIn2) );
  75570. assert( (pIn2->flags & MEM_Int)!=0 );
  75571. sqlite3VdbeMemIntegerify(pIn2);
  75572. p2 = (int)pIn2->u.i;
  75573. /* The p2 value always comes from a prior OP_CreateTable opcode and
  75574. ** that opcode will always set the p2 value to 2 or more or else fail.
  75575. ** If there were a failure, the prepared statement would have halted
  75576. ** before reaching this instruction. */
  75577. assert( p2>=2 );
  75578. }
  75579. if( pOp->p4type==P4_KEYINFO ){
  75580. pKeyInfo = pOp->p4.pKeyInfo;
  75581. assert( pKeyInfo->enc==ENC(db) );
  75582. assert( pKeyInfo->db==db );
  75583. nField = pKeyInfo->nField+pKeyInfo->nXField;
  75584. }else if( pOp->p4type==P4_INT32 ){
  75585. nField = pOp->p4.i;
  75586. }
  75587. assert( pOp->p1>=0 );
  75588. assert( nField>=0 );
  75589. testcase( nField==0 ); /* Table with INTEGER PRIMARY KEY and nothing else */
  75590. pCur = allocateCursor(p, pOp->p1, nField, iDb, CURTYPE_BTREE);
  75591. if( pCur==0 ) goto no_mem;
  75592. pCur->nullRow = 1;
  75593. pCur->isOrdered = 1;
  75594. pCur->pgnoRoot = p2;
  75595. #ifdef SQLITE_DEBUG
  75596. pCur->wrFlag = wrFlag;
  75597. #endif
  75598. rc = sqlite3BtreeCursor(pX, p2, wrFlag, pKeyInfo, pCur->uc.pCursor);
  75599. pCur->pKeyInfo = pKeyInfo;
  75600. /* Set the VdbeCursor.isTable variable. Previous versions of
  75601. ** SQLite used to check if the root-page flags were sane at this point
  75602. ** and report database corruption if they were not, but this check has
  75603. ** since moved into the btree layer. */
  75604. pCur->isTable = pOp->p4type!=P4_KEYINFO;
  75605. open_cursor_set_hints:
  75606. assert( OPFLAG_BULKCSR==BTREE_BULKLOAD );
  75607. assert( OPFLAG_SEEKEQ==BTREE_SEEK_EQ );
  75608. testcase( pOp->p5 & OPFLAG_BULKCSR );
  75609. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  75610. testcase( pOp->p2 & OPFLAG_SEEKEQ );
  75611. #endif
  75612. sqlite3BtreeCursorHintFlags(pCur->uc.pCursor,
  75613. (pOp->p5 & (OPFLAG_BULKCSR|OPFLAG_SEEKEQ)));
  75614. if( rc ) goto abort_due_to_error;
  75615. break;
  75616. }
  75617. /* Opcode: OpenEphemeral P1 P2 * P4 P5
  75618. ** Synopsis: nColumn=P2
  75619. **
  75620. ** Open a new cursor P1 to a transient table.
  75621. ** The cursor is always opened read/write even if
  75622. ** the main database is read-only. The ephemeral
  75623. ** table is deleted automatically when the cursor is closed.
  75624. **
  75625. ** P2 is the number of columns in the ephemeral table.
  75626. ** The cursor points to a BTree table if P4==0 and to a BTree index
  75627. ** if P4 is not 0. If P4 is not NULL, it points to a KeyInfo structure
  75628. ** that defines the format of keys in the index.
  75629. **
  75630. ** The P5 parameter can be a mask of the BTREE_* flags defined
  75631. ** in btree.h. These flags control aspects of the operation of
  75632. ** the btree. The BTREE_OMIT_JOURNAL and BTREE_SINGLE flags are
  75633. ** added automatically.
  75634. */
  75635. /* Opcode: OpenAutoindex P1 P2 * P4 *
  75636. ** Synopsis: nColumn=P2
  75637. **
  75638. ** This opcode works the same as OP_OpenEphemeral. It has a
  75639. ** different name to distinguish its use. Tables created using
  75640. ** by this opcode will be used for automatically created transient
  75641. ** indices in joins.
  75642. */
  75643. case OP_OpenAutoindex:
  75644. case OP_OpenEphemeral: {
  75645. VdbeCursor *pCx;
  75646. KeyInfo *pKeyInfo;
  75647. static const int vfsFlags =
  75648. SQLITE_OPEN_READWRITE |
  75649. SQLITE_OPEN_CREATE |
  75650. SQLITE_OPEN_EXCLUSIVE |
  75651. SQLITE_OPEN_DELETEONCLOSE |
  75652. SQLITE_OPEN_TRANSIENT_DB;
  75653. assert( pOp->p1>=0 );
  75654. assert( pOp->p2>=0 );
  75655. pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_BTREE);
  75656. if( pCx==0 ) goto no_mem;
  75657. pCx->nullRow = 1;
  75658. pCx->isEphemeral = 1;
  75659. rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pCx->pBt,
  75660. BTREE_OMIT_JOURNAL | BTREE_SINGLE | pOp->p5, vfsFlags);
  75661. if( rc==SQLITE_OK ){
  75662. rc = sqlite3BtreeBeginTrans(pCx->pBt, 1);
  75663. }
  75664. if( rc==SQLITE_OK ){
  75665. /* If a transient index is required, create it by calling
  75666. ** sqlite3BtreeCreateTable() with the BTREE_BLOBKEY flag before
  75667. ** opening it. If a transient table is required, just use the
  75668. ** automatically created table with root-page 1 (an BLOB_INTKEY table).
  75669. */
  75670. if( (pKeyInfo = pOp->p4.pKeyInfo)!=0 ){
  75671. int pgno;
  75672. assert( pOp->p4type==P4_KEYINFO );
  75673. rc = sqlite3BtreeCreateTable(pCx->pBt, &pgno, BTREE_BLOBKEY | pOp->p5);
  75674. if( rc==SQLITE_OK ){
  75675. assert( pgno==MASTER_ROOT+1 );
  75676. assert( pKeyInfo->db==db );
  75677. assert( pKeyInfo->enc==ENC(db) );
  75678. pCx->pKeyInfo = pKeyInfo;
  75679. rc = sqlite3BtreeCursor(pCx->pBt, pgno, BTREE_WRCSR,
  75680. pKeyInfo, pCx->uc.pCursor);
  75681. }
  75682. pCx->isTable = 0;
  75683. }else{
  75684. rc = sqlite3BtreeCursor(pCx->pBt, MASTER_ROOT, BTREE_WRCSR,
  75685. 0, pCx->uc.pCursor);
  75686. pCx->isTable = 1;
  75687. }
  75688. }
  75689. if( rc ) goto abort_due_to_error;
  75690. pCx->isOrdered = (pOp->p5!=BTREE_UNORDERED);
  75691. break;
  75692. }
  75693. /* Opcode: SorterOpen P1 P2 P3 P4 *
  75694. **
  75695. ** This opcode works like OP_OpenEphemeral except that it opens
  75696. ** a transient index that is specifically designed to sort large
  75697. ** tables using an external merge-sort algorithm.
  75698. **
  75699. ** If argument P3 is non-zero, then it indicates that the sorter may
  75700. ** assume that a stable sort considering the first P3 fields of each
  75701. ** key is sufficient to produce the required results.
  75702. */
  75703. case OP_SorterOpen: {
  75704. VdbeCursor *pCx;
  75705. assert( pOp->p1>=0 );
  75706. assert( pOp->p2>=0 );
  75707. pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_SORTER);
  75708. if( pCx==0 ) goto no_mem;
  75709. pCx->pKeyInfo = pOp->p4.pKeyInfo;
  75710. assert( pCx->pKeyInfo->db==db );
  75711. assert( pCx->pKeyInfo->enc==ENC(db) );
  75712. rc = sqlite3VdbeSorterInit(db, pOp->p3, pCx);
  75713. if( rc ) goto abort_due_to_error;
  75714. break;
  75715. }
  75716. /* Opcode: SequenceTest P1 P2 * * *
  75717. ** Synopsis: if( cursor[P1].ctr++ ) pc = P2
  75718. **
  75719. ** P1 is a sorter cursor. If the sequence counter is currently zero, jump
  75720. ** to P2. Regardless of whether or not the jump is taken, increment the
  75721. ** the sequence value.
  75722. */
  75723. case OP_SequenceTest: {
  75724. VdbeCursor *pC;
  75725. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  75726. pC = p->apCsr[pOp->p1];
  75727. assert( isSorter(pC) );
  75728. if( (pC->seqCount++)==0 ){
  75729. goto jump_to_p2;
  75730. }
  75731. break;
  75732. }
  75733. /* Opcode: OpenPseudo P1 P2 P3 * *
  75734. ** Synopsis: P3 columns in r[P2]
  75735. **
  75736. ** Open a new cursor that points to a fake table that contains a single
  75737. ** row of data. The content of that one row is the content of memory
  75738. ** register P2. In other words, cursor P1 becomes an alias for the
  75739. ** MEM_Blob content contained in register P2.
  75740. **
  75741. ** A pseudo-table created by this opcode is used to hold a single
  75742. ** row output from the sorter so that the row can be decomposed into
  75743. ** individual columns using the OP_Column opcode. The OP_Column opcode
  75744. ** is the only cursor opcode that works with a pseudo-table.
  75745. **
  75746. ** P3 is the number of fields in the records that will be stored by
  75747. ** the pseudo-table.
  75748. */
  75749. case OP_OpenPseudo: {
  75750. VdbeCursor *pCx;
  75751. assert( pOp->p1>=0 );
  75752. assert( pOp->p3>=0 );
  75753. pCx = allocateCursor(p, pOp->p1, pOp->p3, -1, CURTYPE_PSEUDO);
  75754. if( pCx==0 ) goto no_mem;
  75755. pCx->nullRow = 1;
  75756. pCx->uc.pseudoTableReg = pOp->p2;
  75757. pCx->isTable = 1;
  75758. assert( pOp->p5==0 );
  75759. break;
  75760. }
  75761. /* Opcode: Close P1 * * * *
  75762. **
  75763. ** Close a cursor previously opened as P1. If P1 is not
  75764. ** currently open, this instruction is a no-op.
  75765. */
  75766. case OP_Close: {
  75767. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  75768. sqlite3VdbeFreeCursor(p, p->apCsr[pOp->p1]);
  75769. p->apCsr[pOp->p1] = 0;
  75770. break;
  75771. }
  75772. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  75773. /* Opcode: ColumnsUsed P1 * * P4 *
  75774. **
  75775. ** This opcode (which only exists if SQLite was compiled with
  75776. ** SQLITE_ENABLE_COLUMN_USED_MASK) identifies which columns of the
  75777. ** table or index for cursor P1 are used. P4 is a 64-bit integer
  75778. ** (P4_INT64) in which the first 63 bits are one for each of the
  75779. ** first 63 columns of the table or index that are actually used
  75780. ** by the cursor. The high-order bit is set if any column after
  75781. ** the 64th is used.
  75782. */
  75783. case OP_ColumnsUsed: {
  75784. VdbeCursor *pC;
  75785. pC = p->apCsr[pOp->p1];
  75786. assert( pC->eCurType==CURTYPE_BTREE );
  75787. pC->maskUsed = *(u64*)pOp->p4.pI64;
  75788. break;
  75789. }
  75790. #endif
  75791. /* Opcode: SeekGE P1 P2 P3 P4 *
  75792. ** Synopsis: key=r[P3@P4]
  75793. **
  75794. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  75795. ** use the value in register P3 as the key. If cursor P1 refers
  75796. ** to an SQL index, then P3 is the first in an array of P4 registers
  75797. ** that are used as an unpacked index key.
  75798. **
  75799. ** Reposition cursor P1 so that it points to the smallest entry that
  75800. ** is greater than or equal to the key value. If there are no records
  75801. ** greater than or equal to the key and P2 is not zero, then jump to P2.
  75802. **
  75803. ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
  75804. ** opcode will always land on a record that equally equals the key, or
  75805. ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
  75806. ** opcode must be followed by an IdxLE opcode with the same arguments.
  75807. ** The IdxLE opcode will be skipped if this opcode succeeds, but the
  75808. ** IdxLE opcode will be used on subsequent loop iterations.
  75809. **
  75810. ** This opcode leaves the cursor configured to move in forward order,
  75811. ** from the beginning toward the end. In other words, the cursor is
  75812. ** configured to use Next, not Prev.
  75813. **
  75814. ** See also: Found, NotFound, SeekLt, SeekGt, SeekLe
  75815. */
  75816. /* Opcode: SeekGT P1 P2 P3 P4 *
  75817. ** Synopsis: key=r[P3@P4]
  75818. **
  75819. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  75820. ** use the value in register P3 as a key. If cursor P1 refers
  75821. ** to an SQL index, then P3 is the first in an array of P4 registers
  75822. ** that are used as an unpacked index key.
  75823. **
  75824. ** Reposition cursor P1 so that it points to the smallest entry that
  75825. ** is greater than the key value. If there are no records greater than
  75826. ** the key and P2 is not zero, then jump to P2.
  75827. **
  75828. ** This opcode leaves the cursor configured to move in forward order,
  75829. ** from the beginning toward the end. In other words, the cursor is
  75830. ** configured to use Next, not Prev.
  75831. **
  75832. ** See also: Found, NotFound, SeekLt, SeekGe, SeekLe
  75833. */
  75834. /* Opcode: SeekLT P1 P2 P3 P4 *
  75835. ** Synopsis: key=r[P3@P4]
  75836. **
  75837. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  75838. ** use the value in register P3 as a key. If cursor P1 refers
  75839. ** to an SQL index, then P3 is the first in an array of P4 registers
  75840. ** that are used as an unpacked index key.
  75841. **
  75842. ** Reposition cursor P1 so that it points to the largest entry that
  75843. ** is less than the key value. If there are no records less than
  75844. ** the key and P2 is not zero, then jump to P2.
  75845. **
  75846. ** This opcode leaves the cursor configured to move in reverse order,
  75847. ** from the end toward the beginning. In other words, the cursor is
  75848. ** configured to use Prev, not Next.
  75849. **
  75850. ** See also: Found, NotFound, SeekGt, SeekGe, SeekLe
  75851. */
  75852. /* Opcode: SeekLE P1 P2 P3 P4 *
  75853. ** Synopsis: key=r[P3@P4]
  75854. **
  75855. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  75856. ** use the value in register P3 as a key. If cursor P1 refers
  75857. ** to an SQL index, then P3 is the first in an array of P4 registers
  75858. ** that are used as an unpacked index key.
  75859. **
  75860. ** Reposition cursor P1 so that it points to the largest entry that
  75861. ** is less than or equal to the key value. If there are no records
  75862. ** less than or equal to the key and P2 is not zero, then jump to P2.
  75863. **
  75864. ** This opcode leaves the cursor configured to move in reverse order,
  75865. ** from the end toward the beginning. In other words, the cursor is
  75866. ** configured to use Prev, not Next.
  75867. **
  75868. ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
  75869. ** opcode will always land on a record that equally equals the key, or
  75870. ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
  75871. ** opcode must be followed by an IdxGE opcode with the same arguments.
  75872. ** The IdxGE opcode will be skipped if this opcode succeeds, but the
  75873. ** IdxGE opcode will be used on subsequent loop iterations.
  75874. **
  75875. ** See also: Found, NotFound, SeekGt, SeekGe, SeekLt
  75876. */
  75877. case OP_SeekLT: /* jump, in3 */
  75878. case OP_SeekLE: /* jump, in3 */
  75879. case OP_SeekGE: /* jump, in3 */
  75880. case OP_SeekGT: { /* jump, in3 */
  75881. int res; /* Comparison result */
  75882. int oc; /* Opcode */
  75883. VdbeCursor *pC; /* The cursor to seek */
  75884. UnpackedRecord r; /* The key to seek for */
  75885. int nField; /* Number of columns or fields in the key */
  75886. i64 iKey; /* The rowid we are to seek to */
  75887. int eqOnly; /* Only interested in == results */
  75888. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  75889. assert( pOp->p2!=0 );
  75890. pC = p->apCsr[pOp->p1];
  75891. assert( pC!=0 );
  75892. assert( pC->eCurType==CURTYPE_BTREE );
  75893. assert( OP_SeekLE == OP_SeekLT+1 );
  75894. assert( OP_SeekGE == OP_SeekLT+2 );
  75895. assert( OP_SeekGT == OP_SeekLT+3 );
  75896. assert( pC->isOrdered );
  75897. assert( pC->uc.pCursor!=0 );
  75898. oc = pOp->opcode;
  75899. eqOnly = 0;
  75900. pC->nullRow = 0;
  75901. #ifdef SQLITE_DEBUG
  75902. pC->seekOp = pOp->opcode;
  75903. #endif
  75904. if( pC->isTable ){
  75905. /* The BTREE_SEEK_EQ flag is only set on index cursors */
  75906. assert( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ)==0 );
  75907. /* The input value in P3 might be of any type: integer, real, string,
  75908. ** blob, or NULL. But it needs to be an integer before we can do
  75909. ** the seek, so convert it. */
  75910. pIn3 = &aMem[pOp->p3];
  75911. if( (pIn3->flags & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  75912. applyNumericAffinity(pIn3, 0);
  75913. }
  75914. iKey = sqlite3VdbeIntValue(pIn3);
  75915. /* If the P3 value could not be converted into an integer without
  75916. ** loss of information, then special processing is required... */
  75917. if( (pIn3->flags & MEM_Int)==0 ){
  75918. if( (pIn3->flags & MEM_Real)==0 ){
  75919. /* If the P3 value cannot be converted into any kind of a number,
  75920. ** then the seek is not possible, so jump to P2 */
  75921. VdbeBranchTaken(1,2); goto jump_to_p2;
  75922. break;
  75923. }
  75924. /* If the approximation iKey is larger than the actual real search
  75925. ** term, substitute >= for > and < for <=. e.g. if the search term
  75926. ** is 4.9 and the integer approximation 5:
  75927. **
  75928. ** (x > 4.9) -> (x >= 5)
  75929. ** (x <= 4.9) -> (x < 5)
  75930. */
  75931. if( pIn3->u.r<(double)iKey ){
  75932. assert( OP_SeekGE==(OP_SeekGT-1) );
  75933. assert( OP_SeekLT==(OP_SeekLE-1) );
  75934. assert( (OP_SeekLE & 0x0001)==(OP_SeekGT & 0x0001) );
  75935. if( (oc & 0x0001)==(OP_SeekGT & 0x0001) ) oc--;
  75936. }
  75937. /* If the approximation iKey is smaller than the actual real search
  75938. ** term, substitute <= for < and > for >=. */
  75939. else if( pIn3->u.r>(double)iKey ){
  75940. assert( OP_SeekLE==(OP_SeekLT+1) );
  75941. assert( OP_SeekGT==(OP_SeekGE+1) );
  75942. assert( (OP_SeekLT & 0x0001)==(OP_SeekGE & 0x0001) );
  75943. if( (oc & 0x0001)==(OP_SeekLT & 0x0001) ) oc++;
  75944. }
  75945. }
  75946. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)iKey, 0, &res);
  75947. pC->movetoTarget = iKey; /* Used by OP_Delete */
  75948. if( rc!=SQLITE_OK ){
  75949. goto abort_due_to_error;
  75950. }
  75951. }else{
  75952. /* For a cursor with the BTREE_SEEK_EQ hint, only the OP_SeekGE and
  75953. ** OP_SeekLE opcodes are allowed, and these must be immediately followed
  75954. ** by an OP_IdxGT or OP_IdxLT opcode, respectively, with the same key.
  75955. */
  75956. if( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ) ){
  75957. eqOnly = 1;
  75958. assert( pOp->opcode==OP_SeekGE || pOp->opcode==OP_SeekLE );
  75959. assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
  75960. assert( pOp[1].p1==pOp[0].p1 );
  75961. assert( pOp[1].p2==pOp[0].p2 );
  75962. assert( pOp[1].p3==pOp[0].p3 );
  75963. assert( pOp[1].p4.i==pOp[0].p4.i );
  75964. }
  75965. nField = pOp->p4.i;
  75966. assert( pOp->p4type==P4_INT32 );
  75967. assert( nField>0 );
  75968. r.pKeyInfo = pC->pKeyInfo;
  75969. r.nField = (u16)nField;
  75970. /* The next line of code computes as follows, only faster:
  75971. ** if( oc==OP_SeekGT || oc==OP_SeekLE ){
  75972. ** r.default_rc = -1;
  75973. ** }else{
  75974. ** r.default_rc = +1;
  75975. ** }
  75976. */
  75977. r.default_rc = ((1 & (oc - OP_SeekLT)) ? -1 : +1);
  75978. assert( oc!=OP_SeekGT || r.default_rc==-1 );
  75979. assert( oc!=OP_SeekLE || r.default_rc==-1 );
  75980. assert( oc!=OP_SeekGE || r.default_rc==+1 );
  75981. assert( oc!=OP_SeekLT || r.default_rc==+1 );
  75982. r.aMem = &aMem[pOp->p3];
  75983. #ifdef SQLITE_DEBUG
  75984. { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
  75985. #endif
  75986. r.eqSeen = 0;
  75987. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, &r, 0, 0, &res);
  75988. if( rc!=SQLITE_OK ){
  75989. goto abort_due_to_error;
  75990. }
  75991. if( eqOnly && r.eqSeen==0 ){
  75992. assert( res!=0 );
  75993. goto seek_not_found;
  75994. }
  75995. }
  75996. pC->deferredMoveto = 0;
  75997. pC->cacheStatus = CACHE_STALE;
  75998. #ifdef SQLITE_TEST
  75999. sqlite3_search_count++;
  76000. #endif
  76001. if( oc>=OP_SeekGE ){ assert( oc==OP_SeekGE || oc==OP_SeekGT );
  76002. if( res<0 || (res==0 && oc==OP_SeekGT) ){
  76003. res = 0;
  76004. rc = sqlite3BtreeNext(pC->uc.pCursor, &res);
  76005. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  76006. }else{
  76007. res = 0;
  76008. }
  76009. }else{
  76010. assert( oc==OP_SeekLT || oc==OP_SeekLE );
  76011. if( res>0 || (res==0 && oc==OP_SeekLT) ){
  76012. res = 0;
  76013. rc = sqlite3BtreePrevious(pC->uc.pCursor, &res);
  76014. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  76015. }else{
  76016. /* res might be negative because the table is empty. Check to
  76017. ** see if this is the case.
  76018. */
  76019. res = sqlite3BtreeEof(pC->uc.pCursor);
  76020. }
  76021. }
  76022. seek_not_found:
  76023. assert( pOp->p2>0 );
  76024. VdbeBranchTaken(res!=0,2);
  76025. if( res ){
  76026. goto jump_to_p2;
  76027. }else if( eqOnly ){
  76028. assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
  76029. pOp++; /* Skip the OP_IdxLt or OP_IdxGT that follows */
  76030. }
  76031. break;
  76032. }
  76033. /* Opcode: Found P1 P2 P3 P4 *
  76034. ** Synopsis: key=r[P3@P4]
  76035. **
  76036. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  76037. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  76038. ** record.
  76039. **
  76040. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  76041. ** is a prefix of any entry in P1 then a jump is made to P2 and
  76042. ** P1 is left pointing at the matching entry.
  76043. **
  76044. ** This operation leaves the cursor in a state where it can be
  76045. ** advanced in the forward direction. The Next instruction will work,
  76046. ** but not the Prev instruction.
  76047. **
  76048. ** See also: NotFound, NoConflict, NotExists. SeekGe
  76049. */
  76050. /* Opcode: NotFound P1 P2 P3 P4 *
  76051. ** Synopsis: key=r[P3@P4]
  76052. **
  76053. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  76054. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  76055. ** record.
  76056. **
  76057. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  76058. ** is not the prefix of any entry in P1 then a jump is made to P2. If P1
  76059. ** does contain an entry whose prefix matches the P3/P4 record then control
  76060. ** falls through to the next instruction and P1 is left pointing at the
  76061. ** matching entry.
  76062. **
  76063. ** This operation leaves the cursor in a state where it cannot be
  76064. ** advanced in either direction. In other words, the Next and Prev
  76065. ** opcodes do not work after this operation.
  76066. **
  76067. ** See also: Found, NotExists, NoConflict
  76068. */
  76069. /* Opcode: NoConflict P1 P2 P3 P4 *
  76070. ** Synopsis: key=r[P3@P4]
  76071. **
  76072. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  76073. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  76074. ** record.
  76075. **
  76076. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  76077. ** contains any NULL value, jump immediately to P2. If all terms of the
  76078. ** record are not-NULL then a check is done to determine if any row in the
  76079. ** P1 index btree has a matching key prefix. If there are no matches, jump
  76080. ** immediately to P2. If there is a match, fall through and leave the P1
  76081. ** cursor pointing to the matching row.
  76082. **
  76083. ** This opcode is similar to OP_NotFound with the exceptions that the
  76084. ** branch is always taken if any part of the search key input is NULL.
  76085. **
  76086. ** This operation leaves the cursor in a state where it cannot be
  76087. ** advanced in either direction. In other words, the Next and Prev
  76088. ** opcodes do not work after this operation.
  76089. **
  76090. ** See also: NotFound, Found, NotExists
  76091. */
  76092. case OP_NoConflict: /* jump, in3 */
  76093. case OP_NotFound: /* jump, in3 */
  76094. case OP_Found: { /* jump, in3 */
  76095. int alreadyExists;
  76096. int takeJump;
  76097. int ii;
  76098. VdbeCursor *pC;
  76099. int res;
  76100. char *pFree;
  76101. UnpackedRecord *pIdxKey;
  76102. UnpackedRecord r;
  76103. char aTempRec[ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*4 + 7];
  76104. #ifdef SQLITE_TEST
  76105. if( pOp->opcode!=OP_NoConflict ) sqlite3_found_count++;
  76106. #endif
  76107. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76108. assert( pOp->p4type==P4_INT32 );
  76109. pC = p->apCsr[pOp->p1];
  76110. assert( pC!=0 );
  76111. #ifdef SQLITE_DEBUG
  76112. pC->seekOp = pOp->opcode;
  76113. #endif
  76114. pIn3 = &aMem[pOp->p3];
  76115. assert( pC->eCurType==CURTYPE_BTREE );
  76116. assert( pC->uc.pCursor!=0 );
  76117. assert( pC->isTable==0 );
  76118. pFree = 0;
  76119. if( pOp->p4.i>0 ){
  76120. r.pKeyInfo = pC->pKeyInfo;
  76121. r.nField = (u16)pOp->p4.i;
  76122. r.aMem = pIn3;
  76123. #ifdef SQLITE_DEBUG
  76124. for(ii=0; ii<r.nField; ii++){
  76125. assert( memIsValid(&r.aMem[ii]) );
  76126. assert( (r.aMem[ii].flags & MEM_Zero)==0 || r.aMem[ii].n==0 );
  76127. if( ii ) REGISTER_TRACE(pOp->p3+ii, &r.aMem[ii]);
  76128. }
  76129. #endif
  76130. pIdxKey = &r;
  76131. }else{
  76132. pIdxKey = sqlite3VdbeAllocUnpackedRecord(
  76133. pC->pKeyInfo, aTempRec, sizeof(aTempRec), &pFree
  76134. );
  76135. if( pIdxKey==0 ) goto no_mem;
  76136. assert( pIn3->flags & MEM_Blob );
  76137. (void)ExpandBlob(pIn3);
  76138. sqlite3VdbeRecordUnpack(pC->pKeyInfo, pIn3->n, pIn3->z, pIdxKey);
  76139. }
  76140. pIdxKey->default_rc = 0;
  76141. takeJump = 0;
  76142. if( pOp->opcode==OP_NoConflict ){
  76143. /* For the OP_NoConflict opcode, take the jump if any of the
  76144. ** input fields are NULL, since any key with a NULL will not
  76145. ** conflict */
  76146. for(ii=0; ii<pIdxKey->nField; ii++){
  76147. if( pIdxKey->aMem[ii].flags & MEM_Null ){
  76148. takeJump = 1;
  76149. break;
  76150. }
  76151. }
  76152. }
  76153. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, pIdxKey, 0, 0, &res);
  76154. sqlite3DbFree(db, pFree);
  76155. if( rc!=SQLITE_OK ){
  76156. goto abort_due_to_error;
  76157. }
  76158. pC->seekResult = res;
  76159. alreadyExists = (res==0);
  76160. pC->nullRow = 1-alreadyExists;
  76161. pC->deferredMoveto = 0;
  76162. pC->cacheStatus = CACHE_STALE;
  76163. if( pOp->opcode==OP_Found ){
  76164. VdbeBranchTaken(alreadyExists!=0,2);
  76165. if( alreadyExists ) goto jump_to_p2;
  76166. }else{
  76167. VdbeBranchTaken(takeJump||alreadyExists==0,2);
  76168. if( takeJump || !alreadyExists ) goto jump_to_p2;
  76169. }
  76170. break;
  76171. }
  76172. /* Opcode: SeekRowid P1 P2 P3 * *
  76173. ** Synopsis: intkey=r[P3]
  76174. **
  76175. ** P1 is the index of a cursor open on an SQL table btree (with integer
  76176. ** keys). If register P3 does not contain an integer or if P1 does not
  76177. ** contain a record with rowid P3 then jump immediately to P2.
  76178. ** Or, if P2 is 0, raise an SQLITE_CORRUPT error. If P1 does contain
  76179. ** a record with rowid P3 then
  76180. ** leave the cursor pointing at that record and fall through to the next
  76181. ** instruction.
  76182. **
  76183. ** The OP_NotExists opcode performs the same operation, but with OP_NotExists
  76184. ** the P3 register must be guaranteed to contain an integer value. With this
  76185. ** opcode, register P3 might not contain an integer.
  76186. **
  76187. ** The OP_NotFound opcode performs the same operation on index btrees
  76188. ** (with arbitrary multi-value keys).
  76189. **
  76190. ** This opcode leaves the cursor in a state where it cannot be advanced
  76191. ** in either direction. In other words, the Next and Prev opcodes will
  76192. ** not work following this opcode.
  76193. **
  76194. ** See also: Found, NotFound, NoConflict, SeekRowid
  76195. */
  76196. /* Opcode: NotExists P1 P2 P3 * *
  76197. ** Synopsis: intkey=r[P3]
  76198. **
  76199. ** P1 is the index of a cursor open on an SQL table btree (with integer
  76200. ** keys). P3 is an integer rowid. If P1 does not contain a record with
  76201. ** rowid P3 then jump immediately to P2. Or, if P2 is 0, raise an
  76202. ** SQLITE_CORRUPT error. If P1 does contain a record with rowid P3 then
  76203. ** leave the cursor pointing at that record and fall through to the next
  76204. ** instruction.
  76205. **
  76206. ** The OP_SeekRowid opcode performs the same operation but also allows the
  76207. ** P3 register to contain a non-integer value, in which case the jump is
  76208. ** always taken. This opcode requires that P3 always contain an integer.
  76209. **
  76210. ** The OP_NotFound opcode performs the same operation on index btrees
  76211. ** (with arbitrary multi-value keys).
  76212. **
  76213. ** This opcode leaves the cursor in a state where it cannot be advanced
  76214. ** in either direction. In other words, the Next and Prev opcodes will
  76215. ** not work following this opcode.
  76216. **
  76217. ** See also: Found, NotFound, NoConflict, SeekRowid
  76218. */
  76219. case OP_SeekRowid: { /* jump, in3 */
  76220. VdbeCursor *pC;
  76221. BtCursor *pCrsr;
  76222. int res;
  76223. u64 iKey;
  76224. pIn3 = &aMem[pOp->p3];
  76225. if( (pIn3->flags & MEM_Int)==0 ){
  76226. applyAffinity(pIn3, SQLITE_AFF_NUMERIC, encoding);
  76227. if( (pIn3->flags & MEM_Int)==0 ) goto jump_to_p2;
  76228. }
  76229. /* Fall through into OP_NotExists */
  76230. case OP_NotExists: /* jump, in3 */
  76231. pIn3 = &aMem[pOp->p3];
  76232. assert( pIn3->flags & MEM_Int );
  76233. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76234. pC = p->apCsr[pOp->p1];
  76235. assert( pC!=0 );
  76236. #ifdef SQLITE_DEBUG
  76237. pC->seekOp = 0;
  76238. #endif
  76239. assert( pC->isTable );
  76240. assert( pC->eCurType==CURTYPE_BTREE );
  76241. pCrsr = pC->uc.pCursor;
  76242. assert( pCrsr!=0 );
  76243. res = 0;
  76244. iKey = pIn3->u.i;
  76245. rc = sqlite3BtreeMovetoUnpacked(pCrsr, 0, iKey, 0, &res);
  76246. assert( rc==SQLITE_OK || res==0 );
  76247. pC->movetoTarget = iKey; /* Used by OP_Delete */
  76248. pC->nullRow = 0;
  76249. pC->cacheStatus = CACHE_STALE;
  76250. pC->deferredMoveto = 0;
  76251. VdbeBranchTaken(res!=0,2);
  76252. pC->seekResult = res;
  76253. if( res!=0 ){
  76254. assert( rc==SQLITE_OK );
  76255. if( pOp->p2==0 ){
  76256. rc = SQLITE_CORRUPT_BKPT;
  76257. }else{
  76258. goto jump_to_p2;
  76259. }
  76260. }
  76261. if( rc ) goto abort_due_to_error;
  76262. break;
  76263. }
  76264. /* Opcode: Sequence P1 P2 * * *
  76265. ** Synopsis: r[P2]=cursor[P1].ctr++
  76266. **
  76267. ** Find the next available sequence number for cursor P1.
  76268. ** Write the sequence number into register P2.
  76269. ** The sequence number on the cursor is incremented after this
  76270. ** instruction.
  76271. */
  76272. case OP_Sequence: { /* out2 */
  76273. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76274. assert( p->apCsr[pOp->p1]!=0 );
  76275. assert( p->apCsr[pOp->p1]->eCurType!=CURTYPE_VTAB );
  76276. pOut = out2Prerelease(p, pOp);
  76277. pOut->u.i = p->apCsr[pOp->p1]->seqCount++;
  76278. break;
  76279. }
  76280. /* Opcode: NewRowid P1 P2 P3 * *
  76281. ** Synopsis: r[P2]=rowid
  76282. **
  76283. ** Get a new integer record number (a.k.a "rowid") used as the key to a table.
  76284. ** The record number is not previously used as a key in the database
  76285. ** table that cursor P1 points to. The new record number is written
  76286. ** written to register P2.
  76287. **
  76288. ** If P3>0 then P3 is a register in the root frame of this VDBE that holds
  76289. ** the largest previously generated record number. No new record numbers are
  76290. ** allowed to be less than this value. When this value reaches its maximum,
  76291. ** an SQLITE_FULL error is generated. The P3 register is updated with the '
  76292. ** generated record number. This P3 mechanism is used to help implement the
  76293. ** AUTOINCREMENT feature.
  76294. */
  76295. case OP_NewRowid: { /* out2 */
  76296. i64 v; /* The new rowid */
  76297. VdbeCursor *pC; /* Cursor of table to get the new rowid */
  76298. int res; /* Result of an sqlite3BtreeLast() */
  76299. int cnt; /* Counter to limit the number of searches */
  76300. Mem *pMem; /* Register holding largest rowid for AUTOINCREMENT */
  76301. VdbeFrame *pFrame; /* Root frame of VDBE */
  76302. v = 0;
  76303. res = 0;
  76304. pOut = out2Prerelease(p, pOp);
  76305. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76306. pC = p->apCsr[pOp->p1];
  76307. assert( pC!=0 );
  76308. assert( pC->eCurType==CURTYPE_BTREE );
  76309. assert( pC->uc.pCursor!=0 );
  76310. {
  76311. /* The next rowid or record number (different terms for the same
  76312. ** thing) is obtained in a two-step algorithm.
  76313. **
  76314. ** First we attempt to find the largest existing rowid and add one
  76315. ** to that. But if the largest existing rowid is already the maximum
  76316. ** positive integer, we have to fall through to the second
  76317. ** probabilistic algorithm
  76318. **
  76319. ** The second algorithm is to select a rowid at random and see if
  76320. ** it already exists in the table. If it does not exist, we have
  76321. ** succeeded. If the random rowid does exist, we select a new one
  76322. ** and try again, up to 100 times.
  76323. */
  76324. assert( pC->isTable );
  76325. #ifdef SQLITE_32BIT_ROWID
  76326. # define MAX_ROWID 0x7fffffff
  76327. #else
  76328. /* Some compilers complain about constants of the form 0x7fffffffffffffff.
  76329. ** Others complain about 0x7ffffffffffffffffLL. The following macro seems
  76330. ** to provide the constant while making all compilers happy.
  76331. */
  76332. # define MAX_ROWID (i64)( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
  76333. #endif
  76334. if( !pC->useRandomRowid ){
  76335. rc = sqlite3BtreeLast(pC->uc.pCursor, &res);
  76336. if( rc!=SQLITE_OK ){
  76337. goto abort_due_to_error;
  76338. }
  76339. if( res ){
  76340. v = 1; /* IMP: R-61914-48074 */
  76341. }else{
  76342. assert( sqlite3BtreeCursorIsValid(pC->uc.pCursor) );
  76343. v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  76344. if( v>=MAX_ROWID ){
  76345. pC->useRandomRowid = 1;
  76346. }else{
  76347. v++; /* IMP: R-29538-34987 */
  76348. }
  76349. }
  76350. }
  76351. #ifndef SQLITE_OMIT_AUTOINCREMENT
  76352. if( pOp->p3 ){
  76353. /* Assert that P3 is a valid memory cell. */
  76354. assert( pOp->p3>0 );
  76355. if( p->pFrame ){
  76356. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  76357. /* Assert that P3 is a valid memory cell. */
  76358. assert( pOp->p3<=pFrame->nMem );
  76359. pMem = &pFrame->aMem[pOp->p3];
  76360. }else{
  76361. /* Assert that P3 is a valid memory cell. */
  76362. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  76363. pMem = &aMem[pOp->p3];
  76364. memAboutToChange(p, pMem);
  76365. }
  76366. assert( memIsValid(pMem) );
  76367. REGISTER_TRACE(pOp->p3, pMem);
  76368. sqlite3VdbeMemIntegerify(pMem);
  76369. assert( (pMem->flags & MEM_Int)!=0 ); /* mem(P3) holds an integer */
  76370. if( pMem->u.i==MAX_ROWID || pC->useRandomRowid ){
  76371. rc = SQLITE_FULL; /* IMP: R-12275-61338 */
  76372. goto abort_due_to_error;
  76373. }
  76374. if( v<pMem->u.i+1 ){
  76375. v = pMem->u.i + 1;
  76376. }
  76377. pMem->u.i = v;
  76378. }
  76379. #endif
  76380. if( pC->useRandomRowid ){
  76381. /* IMPLEMENTATION-OF: R-07677-41881 If the largest ROWID is equal to the
  76382. ** largest possible integer (9223372036854775807) then the database
  76383. ** engine starts picking positive candidate ROWIDs at random until
  76384. ** it finds one that is not previously used. */
  76385. assert( pOp->p3==0 ); /* We cannot be in random rowid mode if this is
  76386. ** an AUTOINCREMENT table. */
  76387. cnt = 0;
  76388. do{
  76389. sqlite3_randomness(sizeof(v), &v);
  76390. v &= (MAX_ROWID>>1); v++; /* Ensure that v is greater than zero */
  76391. }while( ((rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)v,
  76392. 0, &res))==SQLITE_OK)
  76393. && (res==0)
  76394. && (++cnt<100));
  76395. if( rc ) goto abort_due_to_error;
  76396. if( res==0 ){
  76397. rc = SQLITE_FULL; /* IMP: R-38219-53002 */
  76398. goto abort_due_to_error;
  76399. }
  76400. assert( v>0 ); /* EV: R-40812-03570 */
  76401. }
  76402. pC->deferredMoveto = 0;
  76403. pC->cacheStatus = CACHE_STALE;
  76404. }
  76405. pOut->u.i = v;
  76406. break;
  76407. }
  76408. /* Opcode: Insert P1 P2 P3 P4 P5
  76409. ** Synopsis: intkey=r[P3] data=r[P2]
  76410. **
  76411. ** Write an entry into the table of cursor P1. A new entry is
  76412. ** created if it doesn't already exist or the data for an existing
  76413. ** entry is overwritten. The data is the value MEM_Blob stored in register
  76414. ** number P2. The key is stored in register P3. The key must
  76415. ** be a MEM_Int.
  76416. **
  76417. ** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
  76418. ** incremented (otherwise not). If the OPFLAG_LASTROWID flag of P5 is set,
  76419. ** then rowid is stored for subsequent return by the
  76420. ** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
  76421. **
  76422. ** If the OPFLAG_USESEEKRESULT flag of P5 is set and if the result of
  76423. ** the last seek operation (OP_NotExists or OP_SeekRowid) was a success,
  76424. ** then this
  76425. ** operation will not attempt to find the appropriate row before doing
  76426. ** the insert but will instead overwrite the row that the cursor is
  76427. ** currently pointing to. Presumably, the prior OP_NotExists or
  76428. ** OP_SeekRowid opcode
  76429. ** has already positioned the cursor correctly. This is an optimization
  76430. ** that boosts performance by avoiding redundant seeks.
  76431. **
  76432. ** If the OPFLAG_ISUPDATE flag is set, then this opcode is part of an
  76433. ** UPDATE operation. Otherwise (if the flag is clear) then this opcode
  76434. ** is part of an INSERT operation. The difference is only important to
  76435. ** the update hook.
  76436. **
  76437. ** Parameter P4 may point to a Table structure, or may be NULL. If it is
  76438. ** not NULL, then the update-hook (sqlite3.xUpdateCallback) is invoked
  76439. ** following a successful insert.
  76440. **
  76441. ** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
  76442. ** allocated, then ownership of P2 is transferred to the pseudo-cursor
  76443. ** and register P2 becomes ephemeral. If the cursor is changed, the
  76444. ** value of register P2 will then change. Make sure this does not
  76445. ** cause any problems.)
  76446. **
  76447. ** This instruction only works on tables. The equivalent instruction
  76448. ** for indices is OP_IdxInsert.
  76449. */
  76450. /* Opcode: InsertInt P1 P2 P3 P4 P5
  76451. ** Synopsis: intkey=P3 data=r[P2]
  76452. **
  76453. ** This works exactly like OP_Insert except that the key is the
  76454. ** integer value P3, not the value of the integer stored in register P3.
  76455. */
  76456. case OP_Insert:
  76457. case OP_InsertInt: {
  76458. Mem *pData; /* MEM cell holding data for the record to be inserted */
  76459. Mem *pKey; /* MEM cell holding key for the record */
  76460. VdbeCursor *pC; /* Cursor to table into which insert is written */
  76461. int seekResult; /* Result of prior seek or 0 if no USESEEKRESULT flag */
  76462. const char *zDb; /* database name - used by the update hook */
  76463. Table *pTab; /* Table structure - used by update and pre-update hooks */
  76464. int op; /* Opcode for update hook: SQLITE_UPDATE or SQLITE_INSERT */
  76465. BtreePayload x; /* Payload to be inserted */
  76466. op = 0;
  76467. pData = &aMem[pOp->p2];
  76468. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76469. assert( memIsValid(pData) );
  76470. pC = p->apCsr[pOp->p1];
  76471. assert( pC!=0 );
  76472. assert( pC->eCurType==CURTYPE_BTREE );
  76473. assert( pC->uc.pCursor!=0 );
  76474. assert( pC->isTable );
  76475. assert( pOp->p4type==P4_TABLE || pOp->p4type>=P4_STATIC );
  76476. REGISTER_TRACE(pOp->p2, pData);
  76477. if( pOp->opcode==OP_Insert ){
  76478. pKey = &aMem[pOp->p3];
  76479. assert( pKey->flags & MEM_Int );
  76480. assert( memIsValid(pKey) );
  76481. REGISTER_TRACE(pOp->p3, pKey);
  76482. x.nKey = pKey->u.i;
  76483. }else{
  76484. assert( pOp->opcode==OP_InsertInt );
  76485. x.nKey = pOp->p3;
  76486. }
  76487. if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
  76488. assert( pC->isTable );
  76489. assert( pC->iDb>=0 );
  76490. zDb = db->aDb[pC->iDb].zDbSName;
  76491. pTab = pOp->p4.pTab;
  76492. assert( HasRowid(pTab) );
  76493. op = ((pOp->p5 & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_INSERT);
  76494. }else{
  76495. pTab = 0; /* Not needed. Silence a comiler warning. */
  76496. zDb = 0; /* Not needed. Silence a compiler warning. */
  76497. }
  76498. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  76499. /* Invoke the pre-update hook, if any */
  76500. if( db->xPreUpdateCallback
  76501. && pOp->p4type==P4_TABLE
  76502. && !(pOp->p5 & OPFLAG_ISUPDATE)
  76503. ){
  76504. sqlite3VdbePreUpdateHook(p, pC, SQLITE_INSERT, zDb, pTab, x.nKey, pOp->p2);
  76505. }
  76506. #endif
  76507. if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
  76508. if( pOp->p5 & OPFLAG_LASTROWID ) db->lastRowid = lastRowid = x.nKey;
  76509. if( pData->flags & MEM_Null ){
  76510. x.pData = 0;
  76511. x.nData = 0;
  76512. }else{
  76513. assert( pData->flags & (MEM_Blob|MEM_Str) );
  76514. x.pData = pData->z;
  76515. x.nData = pData->n;
  76516. }
  76517. seekResult = ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0);
  76518. if( pData->flags & MEM_Zero ){
  76519. x.nZero = pData->u.nZero;
  76520. }else{
  76521. x.nZero = 0;
  76522. }
  76523. x.pKey = 0;
  76524. rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
  76525. (pOp->p5 & OPFLAG_APPEND)!=0, seekResult
  76526. );
  76527. pC->deferredMoveto = 0;
  76528. pC->cacheStatus = CACHE_STALE;
  76529. /* Invoke the update-hook if required. */
  76530. if( rc ) goto abort_due_to_error;
  76531. if( db->xUpdateCallback && op ){
  76532. db->xUpdateCallback(db->pUpdateArg, op, zDb, pTab->zName, x.nKey);
  76533. }
  76534. break;
  76535. }
  76536. /* Opcode: Delete P1 P2 P3 P4 P5
  76537. **
  76538. ** Delete the record at which the P1 cursor is currently pointing.
  76539. **
  76540. ** If the OPFLAG_SAVEPOSITION bit of the P5 parameter is set, then
  76541. ** the cursor will be left pointing at either the next or the previous
  76542. ** record in the table. If it is left pointing at the next record, then
  76543. ** the next Next instruction will be a no-op. As a result, in this case
  76544. ** it is ok to delete a record from within a Next loop. If
  76545. ** OPFLAG_SAVEPOSITION bit of P5 is clear, then the cursor will be
  76546. ** left in an undefined state.
  76547. **
  76548. ** If the OPFLAG_AUXDELETE bit is set on P5, that indicates that this
  76549. ** delete one of several associated with deleting a table row and all its
  76550. ** associated index entries. Exactly one of those deletes is the "primary"
  76551. ** delete. The others are all on OPFLAG_FORDELETE cursors or else are
  76552. ** marked with the AUXDELETE flag.
  76553. **
  76554. ** If the OPFLAG_NCHANGE flag of P2 (NB: P2 not P5) is set, then the row
  76555. ** change count is incremented (otherwise not).
  76556. **
  76557. ** P1 must not be pseudo-table. It has to be a real table with
  76558. ** multiple rows.
  76559. **
  76560. ** If P4 is not NULL then it points to a Table object. In this case either
  76561. ** the update or pre-update hook, or both, may be invoked. The P1 cursor must
  76562. ** have been positioned using OP_NotFound prior to invoking this opcode in
  76563. ** this case. Specifically, if one is configured, the pre-update hook is
  76564. ** invoked if P4 is not NULL. The update-hook is invoked if one is configured,
  76565. ** P4 is not NULL, and the OPFLAG_NCHANGE flag is set in P2.
  76566. **
  76567. ** If the OPFLAG_ISUPDATE flag is set in P2, then P3 contains the address
  76568. ** of the memory cell that contains the value that the rowid of the row will
  76569. ** be set to by the update.
  76570. */
  76571. case OP_Delete: {
  76572. VdbeCursor *pC;
  76573. const char *zDb;
  76574. Table *pTab;
  76575. int opflags;
  76576. opflags = pOp->p2;
  76577. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76578. pC = p->apCsr[pOp->p1];
  76579. assert( pC!=0 );
  76580. assert( pC->eCurType==CURTYPE_BTREE );
  76581. assert( pC->uc.pCursor!=0 );
  76582. assert( pC->deferredMoveto==0 );
  76583. #ifdef SQLITE_DEBUG
  76584. if( pOp->p4type==P4_TABLE && HasRowid(pOp->p4.pTab) && pOp->p5==0 ){
  76585. /* If p5 is zero, the seek operation that positioned the cursor prior to
  76586. ** OP_Delete will have also set the pC->movetoTarget field to the rowid of
  76587. ** the row that is being deleted */
  76588. i64 iKey = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  76589. assert( pC->movetoTarget==iKey );
  76590. }
  76591. #endif
  76592. /* If the update-hook or pre-update-hook will be invoked, set zDb to
  76593. ** the name of the db to pass as to it. Also set local pTab to a copy
  76594. ** of p4.pTab. Finally, if p5 is true, indicating that this cursor was
  76595. ** last moved with OP_Next or OP_Prev, not Seek or NotFound, set
  76596. ** VdbeCursor.movetoTarget to the current rowid. */
  76597. if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
  76598. assert( pC->iDb>=0 );
  76599. assert( pOp->p4.pTab!=0 );
  76600. zDb = db->aDb[pC->iDb].zDbSName;
  76601. pTab = pOp->p4.pTab;
  76602. if( (pOp->p5 & OPFLAG_SAVEPOSITION)!=0 && pC->isTable ){
  76603. pC->movetoTarget = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  76604. }
  76605. }else{
  76606. zDb = 0; /* Not needed. Silence a compiler warning. */
  76607. pTab = 0; /* Not needed. Silence a compiler warning. */
  76608. }
  76609. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  76610. /* Invoke the pre-update-hook if required. */
  76611. if( db->xPreUpdateCallback && pOp->p4.pTab && HasRowid(pTab) ){
  76612. assert( !(opflags & OPFLAG_ISUPDATE) || (aMem[pOp->p3].flags & MEM_Int) );
  76613. sqlite3VdbePreUpdateHook(p, pC,
  76614. (opflags & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_DELETE,
  76615. zDb, pTab, pC->movetoTarget,
  76616. pOp->p3
  76617. );
  76618. }
  76619. if( opflags & OPFLAG_ISNOOP ) break;
  76620. #endif
  76621. /* Only flags that can be set are SAVEPOISTION and AUXDELETE */
  76622. assert( (pOp->p5 & ~(OPFLAG_SAVEPOSITION|OPFLAG_AUXDELETE))==0 );
  76623. assert( OPFLAG_SAVEPOSITION==BTREE_SAVEPOSITION );
  76624. assert( OPFLAG_AUXDELETE==BTREE_AUXDELETE );
  76625. #ifdef SQLITE_DEBUG
  76626. if( p->pFrame==0 ){
  76627. if( pC->isEphemeral==0
  76628. && (pOp->p5 & OPFLAG_AUXDELETE)==0
  76629. && (pC->wrFlag & OPFLAG_FORDELETE)==0
  76630. ){
  76631. nExtraDelete++;
  76632. }
  76633. if( pOp->p2 & OPFLAG_NCHANGE ){
  76634. nExtraDelete--;
  76635. }
  76636. }
  76637. #endif
  76638. rc = sqlite3BtreeDelete(pC->uc.pCursor, pOp->p5);
  76639. pC->cacheStatus = CACHE_STALE;
  76640. if( rc ) goto abort_due_to_error;
  76641. /* Invoke the update-hook if required. */
  76642. if( opflags & OPFLAG_NCHANGE ){
  76643. p->nChange++;
  76644. if( db->xUpdateCallback && HasRowid(pTab) ){
  76645. db->xUpdateCallback(db->pUpdateArg, SQLITE_DELETE, zDb, pTab->zName,
  76646. pC->movetoTarget);
  76647. assert( pC->iDb>=0 );
  76648. }
  76649. }
  76650. break;
  76651. }
  76652. /* Opcode: ResetCount * * * * *
  76653. **
  76654. ** The value of the change counter is copied to the database handle
  76655. ** change counter (returned by subsequent calls to sqlite3_changes()).
  76656. ** Then the VMs internal change counter resets to 0.
  76657. ** This is used by trigger programs.
  76658. */
  76659. case OP_ResetCount: {
  76660. sqlite3VdbeSetChanges(db, p->nChange);
  76661. p->nChange = 0;
  76662. break;
  76663. }
  76664. /* Opcode: SorterCompare P1 P2 P3 P4
  76665. ** Synopsis: if key(P1)!=trim(r[P3],P4) goto P2
  76666. **
  76667. ** P1 is a sorter cursor. This instruction compares a prefix of the
  76668. ** record blob in register P3 against a prefix of the entry that
  76669. ** the sorter cursor currently points to. Only the first P4 fields
  76670. ** of r[P3] and the sorter record are compared.
  76671. **
  76672. ** If either P3 or the sorter contains a NULL in one of their significant
  76673. ** fields (not counting the P4 fields at the end which are ignored) then
  76674. ** the comparison is assumed to be equal.
  76675. **
  76676. ** Fall through to next instruction if the two records compare equal to
  76677. ** each other. Jump to P2 if they are different.
  76678. */
  76679. case OP_SorterCompare: {
  76680. VdbeCursor *pC;
  76681. int res;
  76682. int nKeyCol;
  76683. pC = p->apCsr[pOp->p1];
  76684. assert( isSorter(pC) );
  76685. assert( pOp->p4type==P4_INT32 );
  76686. pIn3 = &aMem[pOp->p3];
  76687. nKeyCol = pOp->p4.i;
  76688. res = 0;
  76689. rc = sqlite3VdbeSorterCompare(pC, pIn3, nKeyCol, &res);
  76690. VdbeBranchTaken(res!=0,2);
  76691. if( rc ) goto abort_due_to_error;
  76692. if( res ) goto jump_to_p2;
  76693. break;
  76694. };
  76695. /* Opcode: SorterData P1 P2 P3 * *
  76696. ** Synopsis: r[P2]=data
  76697. **
  76698. ** Write into register P2 the current sorter data for sorter cursor P1.
  76699. ** Then clear the column header cache on cursor P3.
  76700. **
  76701. ** This opcode is normally use to move a record out of the sorter and into
  76702. ** a register that is the source for a pseudo-table cursor created using
  76703. ** OpenPseudo. That pseudo-table cursor is the one that is identified by
  76704. ** parameter P3. Clearing the P3 column cache as part of this opcode saves
  76705. ** us from having to issue a separate NullRow instruction to clear that cache.
  76706. */
  76707. case OP_SorterData: {
  76708. VdbeCursor *pC;
  76709. pOut = &aMem[pOp->p2];
  76710. pC = p->apCsr[pOp->p1];
  76711. assert( isSorter(pC) );
  76712. rc = sqlite3VdbeSorterRowkey(pC, pOut);
  76713. assert( rc!=SQLITE_OK || (pOut->flags & MEM_Blob) );
  76714. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76715. if( rc ) goto abort_due_to_error;
  76716. p->apCsr[pOp->p3]->cacheStatus = CACHE_STALE;
  76717. break;
  76718. }
  76719. /* Opcode: RowData P1 P2 * * *
  76720. ** Synopsis: r[P2]=data
  76721. **
  76722. ** Write into register P2 the complete row data for cursor P1.
  76723. ** There is no interpretation of the data.
  76724. ** It is just copied onto the P2 register exactly as
  76725. ** it is found in the database file.
  76726. **
  76727. ** If the P1 cursor must be pointing to a valid row (not a NULL row)
  76728. ** of a real table, not a pseudo-table.
  76729. */
  76730. /* Opcode: RowKey P1 P2 * * *
  76731. ** Synopsis: r[P2]=key
  76732. **
  76733. ** Write into register P2 the complete row key for cursor P1.
  76734. ** There is no interpretation of the data.
  76735. ** The key is copied onto the P2 register exactly as
  76736. ** it is found in the database file.
  76737. **
  76738. ** If the P1 cursor must be pointing to a valid row (not a NULL row)
  76739. ** of a real table, not a pseudo-table.
  76740. */
  76741. case OP_RowKey:
  76742. case OP_RowData: {
  76743. VdbeCursor *pC;
  76744. BtCursor *pCrsr;
  76745. u32 n;
  76746. pOut = &aMem[pOp->p2];
  76747. memAboutToChange(p, pOut);
  76748. /* Note that RowKey and RowData are really exactly the same instruction */
  76749. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76750. pC = p->apCsr[pOp->p1];
  76751. assert( pC!=0 );
  76752. assert( pC->eCurType==CURTYPE_BTREE );
  76753. assert( isSorter(pC)==0 );
  76754. assert( pC->isTable || pOp->opcode!=OP_RowData );
  76755. assert( pC->isTable==0 || pOp->opcode==OP_RowData );
  76756. assert( pC->nullRow==0 );
  76757. assert( pC->uc.pCursor!=0 );
  76758. pCrsr = pC->uc.pCursor;
  76759. /* The OP_RowKey and OP_RowData opcodes always follow OP_NotExists or
  76760. ** OP_SeekRowid or OP_Rewind/Op_Next with no intervening instructions
  76761. ** that might invalidate the cursor.
  76762. ** If this where not the case, on of the following assert()s
  76763. ** would fail. Should this ever change (because of changes in the code
  76764. ** generator) then the fix would be to insert a call to
  76765. ** sqlite3VdbeCursorMoveto().
  76766. */
  76767. assert( pC->deferredMoveto==0 );
  76768. assert( sqlite3BtreeCursorIsValid(pCrsr) );
  76769. #if 0 /* Not required due to the previous to assert() statements */
  76770. rc = sqlite3VdbeCursorMoveto(pC);
  76771. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  76772. #endif
  76773. n = sqlite3BtreePayloadSize(pCrsr);
  76774. if( n>(u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  76775. goto too_big;
  76776. }
  76777. testcase( n==0 );
  76778. if( sqlite3VdbeMemClearAndResize(pOut, MAX(n,32)) ){
  76779. goto no_mem;
  76780. }
  76781. pOut->n = n;
  76782. MemSetTypeFlag(pOut, MEM_Blob);
  76783. if( pC->isTable==0 ){
  76784. rc = sqlite3BtreeKey(pCrsr, 0, n, pOut->z);
  76785. }else{
  76786. rc = sqlite3BtreeData(pCrsr, 0, n, pOut->z);
  76787. }
  76788. if( rc ) goto abort_due_to_error;
  76789. pOut->enc = SQLITE_UTF8; /* In case the blob is ever cast to text */
  76790. UPDATE_MAX_BLOBSIZE(pOut);
  76791. REGISTER_TRACE(pOp->p2, pOut);
  76792. break;
  76793. }
  76794. /* Opcode: Rowid P1 P2 * * *
  76795. ** Synopsis: r[P2]=rowid
  76796. **
  76797. ** Store in register P2 an integer which is the key of the table entry that
  76798. ** P1 is currently point to.
  76799. **
  76800. ** P1 can be either an ordinary table or a virtual table. There used to
  76801. ** be a separate OP_VRowid opcode for use with virtual tables, but this
  76802. ** one opcode now works for both table types.
  76803. */
  76804. case OP_Rowid: { /* out2 */
  76805. VdbeCursor *pC;
  76806. i64 v;
  76807. sqlite3_vtab *pVtab;
  76808. const sqlite3_module *pModule;
  76809. pOut = out2Prerelease(p, pOp);
  76810. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76811. pC = p->apCsr[pOp->p1];
  76812. assert( pC!=0 );
  76813. assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
  76814. if( pC->nullRow ){
  76815. pOut->flags = MEM_Null;
  76816. break;
  76817. }else if( pC->deferredMoveto ){
  76818. v = pC->movetoTarget;
  76819. #ifndef SQLITE_OMIT_VIRTUALTABLE
  76820. }else if( pC->eCurType==CURTYPE_VTAB ){
  76821. assert( pC->uc.pVCur!=0 );
  76822. pVtab = pC->uc.pVCur->pVtab;
  76823. pModule = pVtab->pModule;
  76824. assert( pModule->xRowid );
  76825. rc = pModule->xRowid(pC->uc.pVCur, &v);
  76826. sqlite3VtabImportErrmsg(p, pVtab);
  76827. if( rc ) goto abort_due_to_error;
  76828. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  76829. }else{
  76830. assert( pC->eCurType==CURTYPE_BTREE );
  76831. assert( pC->uc.pCursor!=0 );
  76832. rc = sqlite3VdbeCursorRestore(pC);
  76833. if( rc ) goto abort_due_to_error;
  76834. if( pC->nullRow ){
  76835. pOut->flags = MEM_Null;
  76836. break;
  76837. }
  76838. v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  76839. }
  76840. pOut->u.i = v;
  76841. break;
  76842. }
  76843. /* Opcode: NullRow P1 * * * *
  76844. **
  76845. ** Move the cursor P1 to a null row. Any OP_Column operations
  76846. ** that occur while the cursor is on the null row will always
  76847. ** write a NULL.
  76848. */
  76849. case OP_NullRow: {
  76850. VdbeCursor *pC;
  76851. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76852. pC = p->apCsr[pOp->p1];
  76853. assert( pC!=0 );
  76854. pC->nullRow = 1;
  76855. pC->cacheStatus = CACHE_STALE;
  76856. if( pC->eCurType==CURTYPE_BTREE ){
  76857. assert( pC->uc.pCursor!=0 );
  76858. sqlite3BtreeClearCursor(pC->uc.pCursor);
  76859. }
  76860. break;
  76861. }
  76862. /* Opcode: Last P1 P2 P3 * *
  76863. **
  76864. ** The next use of the Rowid or Column or Prev instruction for P1
  76865. ** will refer to the last entry in the database table or index.
  76866. ** If the table or index is empty and P2>0, then jump immediately to P2.
  76867. ** If P2 is 0 or if the table or index is not empty, fall through
  76868. ** to the following instruction.
  76869. **
  76870. ** This opcode leaves the cursor configured to move in reverse order,
  76871. ** from the end toward the beginning. In other words, the cursor is
  76872. ** configured to use Prev, not Next.
  76873. */
  76874. case OP_Last: { /* jump */
  76875. VdbeCursor *pC;
  76876. BtCursor *pCrsr;
  76877. int res;
  76878. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76879. pC = p->apCsr[pOp->p1];
  76880. assert( pC!=0 );
  76881. assert( pC->eCurType==CURTYPE_BTREE );
  76882. pCrsr = pC->uc.pCursor;
  76883. res = 0;
  76884. assert( pCrsr!=0 );
  76885. rc = sqlite3BtreeLast(pCrsr, &res);
  76886. pC->nullRow = (u8)res;
  76887. pC->deferredMoveto = 0;
  76888. pC->cacheStatus = CACHE_STALE;
  76889. pC->seekResult = pOp->p3;
  76890. #ifdef SQLITE_DEBUG
  76891. pC->seekOp = OP_Last;
  76892. #endif
  76893. if( rc ) goto abort_due_to_error;
  76894. if( pOp->p2>0 ){
  76895. VdbeBranchTaken(res!=0,2);
  76896. if( res ) goto jump_to_p2;
  76897. }
  76898. break;
  76899. }
  76900. /* Opcode: Sort P1 P2 * * *
  76901. **
  76902. ** This opcode does exactly the same thing as OP_Rewind except that
  76903. ** it increments an undocumented global variable used for testing.
  76904. **
  76905. ** Sorting is accomplished by writing records into a sorting index,
  76906. ** then rewinding that index and playing it back from beginning to
  76907. ** end. We use the OP_Sort opcode instead of OP_Rewind to do the
  76908. ** rewinding so that the global variable will be incremented and
  76909. ** regression tests can determine whether or not the optimizer is
  76910. ** correctly optimizing out sorts.
  76911. */
  76912. case OP_SorterSort: /* jump */
  76913. case OP_Sort: { /* jump */
  76914. #ifdef SQLITE_TEST
  76915. sqlite3_sort_count++;
  76916. sqlite3_search_count--;
  76917. #endif
  76918. p->aCounter[SQLITE_STMTSTATUS_SORT]++;
  76919. /* Fall through into OP_Rewind */
  76920. }
  76921. /* Opcode: Rewind P1 P2 * * *
  76922. **
  76923. ** The next use of the Rowid or Column or Next instruction for P1
  76924. ** will refer to the first entry in the database table or index.
  76925. ** If the table or index is empty, jump immediately to P2.
  76926. ** If the table or index is not empty, fall through to the following
  76927. ** instruction.
  76928. **
  76929. ** This opcode leaves the cursor configured to move in forward order,
  76930. ** from the beginning toward the end. In other words, the cursor is
  76931. ** configured to use Next, not Prev.
  76932. */
  76933. case OP_Rewind: { /* jump */
  76934. VdbeCursor *pC;
  76935. BtCursor *pCrsr;
  76936. int res;
  76937. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  76938. pC = p->apCsr[pOp->p1];
  76939. assert( pC!=0 );
  76940. assert( isSorter(pC)==(pOp->opcode==OP_SorterSort) );
  76941. res = 1;
  76942. #ifdef SQLITE_DEBUG
  76943. pC->seekOp = OP_Rewind;
  76944. #endif
  76945. if( isSorter(pC) ){
  76946. rc = sqlite3VdbeSorterRewind(pC, &res);
  76947. }else{
  76948. assert( pC->eCurType==CURTYPE_BTREE );
  76949. pCrsr = pC->uc.pCursor;
  76950. assert( pCrsr );
  76951. rc = sqlite3BtreeFirst(pCrsr, &res);
  76952. pC->deferredMoveto = 0;
  76953. pC->cacheStatus = CACHE_STALE;
  76954. }
  76955. if( rc ) goto abort_due_to_error;
  76956. pC->nullRow = (u8)res;
  76957. assert( pOp->p2>0 && pOp->p2<p->nOp );
  76958. VdbeBranchTaken(res!=0,2);
  76959. if( res ) goto jump_to_p2;
  76960. break;
  76961. }
  76962. /* Opcode: Next P1 P2 P3 P4 P5
  76963. **
  76964. ** Advance cursor P1 so that it points to the next key/data pair in its
  76965. ** table or index. If there are no more key/value pairs then fall through
  76966. ** to the following instruction. But if the cursor advance was successful,
  76967. ** jump immediately to P2.
  76968. **
  76969. ** The Next opcode is only valid following an SeekGT, SeekGE, or
  76970. ** OP_Rewind opcode used to position the cursor. Next is not allowed
  76971. ** to follow SeekLT, SeekLE, or OP_Last.
  76972. **
  76973. ** The P1 cursor must be for a real table, not a pseudo-table. P1 must have
  76974. ** been opened prior to this opcode or the program will segfault.
  76975. **
  76976. ** The P3 value is a hint to the btree implementation. If P3==1, that
  76977. ** means P1 is an SQL index and that this instruction could have been
  76978. ** omitted if that index had been unique. P3 is usually 0. P3 is
  76979. ** always either 0 or 1.
  76980. **
  76981. ** P4 is always of type P4_ADVANCE. The function pointer points to
  76982. ** sqlite3BtreeNext().
  76983. **
  76984. ** If P5 is positive and the jump is taken, then event counter
  76985. ** number P5-1 in the prepared statement is incremented.
  76986. **
  76987. ** See also: Prev, NextIfOpen
  76988. */
  76989. /* Opcode: NextIfOpen P1 P2 P3 P4 P5
  76990. **
  76991. ** This opcode works just like Next except that if cursor P1 is not
  76992. ** open it behaves a no-op.
  76993. */
  76994. /* Opcode: Prev P1 P2 P3 P4 P5
  76995. **
  76996. ** Back up cursor P1 so that it points to the previous key/data pair in its
  76997. ** table or index. If there is no previous key/value pairs then fall through
  76998. ** to the following instruction. But if the cursor backup was successful,
  76999. ** jump immediately to P2.
  77000. **
  77001. **
  77002. ** The Prev opcode is only valid following an SeekLT, SeekLE, or
  77003. ** OP_Last opcode used to position the cursor. Prev is not allowed
  77004. ** to follow SeekGT, SeekGE, or OP_Rewind.
  77005. **
  77006. ** The P1 cursor must be for a real table, not a pseudo-table. If P1 is
  77007. ** not open then the behavior is undefined.
  77008. **
  77009. ** The P3 value is a hint to the btree implementation. If P3==1, that
  77010. ** means P1 is an SQL index and that this instruction could have been
  77011. ** omitted if that index had been unique. P3 is usually 0. P3 is
  77012. ** always either 0 or 1.
  77013. **
  77014. ** P4 is always of type P4_ADVANCE. The function pointer points to
  77015. ** sqlite3BtreePrevious().
  77016. **
  77017. ** If P5 is positive and the jump is taken, then event counter
  77018. ** number P5-1 in the prepared statement is incremented.
  77019. */
  77020. /* Opcode: PrevIfOpen P1 P2 P3 P4 P5
  77021. **
  77022. ** This opcode works just like Prev except that if cursor P1 is not
  77023. ** open it behaves a no-op.
  77024. */
  77025. case OP_SorterNext: { /* jump */
  77026. VdbeCursor *pC;
  77027. int res;
  77028. pC = p->apCsr[pOp->p1];
  77029. assert( isSorter(pC) );
  77030. res = 0;
  77031. rc = sqlite3VdbeSorterNext(db, pC, &res);
  77032. goto next_tail;
  77033. case OP_PrevIfOpen: /* jump */
  77034. case OP_NextIfOpen: /* jump */
  77035. if( p->apCsr[pOp->p1]==0 ) break;
  77036. /* Fall through */
  77037. case OP_Prev: /* jump */
  77038. case OP_Next: /* jump */
  77039. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77040. assert( pOp->p5<ArraySize(p->aCounter) );
  77041. pC = p->apCsr[pOp->p1];
  77042. res = pOp->p3;
  77043. assert( pC!=0 );
  77044. assert( pC->deferredMoveto==0 );
  77045. assert( pC->eCurType==CURTYPE_BTREE );
  77046. assert( res==0 || (res==1 && pC->isTable==0) );
  77047. testcase( res==1 );
  77048. assert( pOp->opcode!=OP_Next || pOp->p4.xAdvance==sqlite3BtreeNext );
  77049. assert( pOp->opcode!=OP_Prev || pOp->p4.xAdvance==sqlite3BtreePrevious );
  77050. assert( pOp->opcode!=OP_NextIfOpen || pOp->p4.xAdvance==sqlite3BtreeNext );
  77051. assert( pOp->opcode!=OP_PrevIfOpen || pOp->p4.xAdvance==sqlite3BtreePrevious);
  77052. /* The Next opcode is only used after SeekGT, SeekGE, and Rewind.
  77053. ** The Prev opcode is only used after SeekLT, SeekLE, and Last. */
  77054. assert( pOp->opcode!=OP_Next || pOp->opcode!=OP_NextIfOpen
  77055. || pC->seekOp==OP_SeekGT || pC->seekOp==OP_SeekGE
  77056. || pC->seekOp==OP_Rewind || pC->seekOp==OP_Found);
  77057. assert( pOp->opcode!=OP_Prev || pOp->opcode!=OP_PrevIfOpen
  77058. || pC->seekOp==OP_SeekLT || pC->seekOp==OP_SeekLE
  77059. || pC->seekOp==OP_Last );
  77060. rc = pOp->p4.xAdvance(pC->uc.pCursor, &res);
  77061. next_tail:
  77062. pC->cacheStatus = CACHE_STALE;
  77063. VdbeBranchTaken(res==0,2);
  77064. if( rc ) goto abort_due_to_error;
  77065. if( res==0 ){
  77066. pC->nullRow = 0;
  77067. p->aCounter[pOp->p5]++;
  77068. #ifdef SQLITE_TEST
  77069. sqlite3_search_count++;
  77070. #endif
  77071. goto jump_to_p2_and_check_for_interrupt;
  77072. }else{
  77073. pC->nullRow = 1;
  77074. }
  77075. goto check_for_interrupt;
  77076. }
  77077. /* Opcode: IdxInsert P1 P2 P3 * P5
  77078. ** Synopsis: key=r[P2]
  77079. **
  77080. ** Register P2 holds an SQL index key made using the
  77081. ** MakeRecord instructions. This opcode writes that key
  77082. ** into the index P1. Data for the entry is nil.
  77083. **
  77084. ** P3 is a flag that provides a hint to the b-tree layer that this
  77085. ** insert is likely to be an append.
  77086. **
  77087. ** If P5 has the OPFLAG_NCHANGE bit set, then the change counter is
  77088. ** incremented by this instruction. If the OPFLAG_NCHANGE bit is clear,
  77089. ** then the change counter is unchanged.
  77090. **
  77091. ** If P5 has the OPFLAG_USESEEKRESULT bit set, then the cursor must have
  77092. ** just done a seek to the spot where the new entry is to be inserted.
  77093. ** This flag avoids doing an extra seek.
  77094. **
  77095. ** This instruction only works for indices. The equivalent instruction
  77096. ** for tables is OP_Insert.
  77097. */
  77098. case OP_SorterInsert: /* in2 */
  77099. case OP_IdxInsert: { /* in2 */
  77100. VdbeCursor *pC;
  77101. BtreePayload x;
  77102. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77103. pC = p->apCsr[pOp->p1];
  77104. assert( pC!=0 );
  77105. assert( isSorter(pC)==(pOp->opcode==OP_SorterInsert) );
  77106. pIn2 = &aMem[pOp->p2];
  77107. assert( pIn2->flags & MEM_Blob );
  77108. if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
  77109. assert( pC->eCurType==CURTYPE_BTREE || pOp->opcode==OP_SorterInsert );
  77110. assert( pC->isTable==0 );
  77111. rc = ExpandBlob(pIn2);
  77112. if( rc ) goto abort_due_to_error;
  77113. if( pOp->opcode==OP_SorterInsert ){
  77114. rc = sqlite3VdbeSorterWrite(pC, pIn2);
  77115. }else{
  77116. x.nKey = pIn2->n;
  77117. x.pKey = pIn2->z;
  77118. rc = sqlite3BtreeInsert(pC->uc.pCursor, &x, pOp->p3,
  77119. ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0)
  77120. );
  77121. assert( pC->deferredMoveto==0 );
  77122. pC->cacheStatus = CACHE_STALE;
  77123. }
  77124. if( rc) goto abort_due_to_error;
  77125. break;
  77126. }
  77127. /* Opcode: IdxDelete P1 P2 P3 * *
  77128. ** Synopsis: key=r[P2@P3]
  77129. **
  77130. ** The content of P3 registers starting at register P2 form
  77131. ** an unpacked index key. This opcode removes that entry from the
  77132. ** index opened by cursor P1.
  77133. */
  77134. case OP_IdxDelete: {
  77135. VdbeCursor *pC;
  77136. BtCursor *pCrsr;
  77137. int res;
  77138. UnpackedRecord r;
  77139. assert( pOp->p3>0 );
  77140. assert( pOp->p2>0 && pOp->p2+pOp->p3<=(p->nMem+1 - p->nCursor)+1 );
  77141. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77142. pC = p->apCsr[pOp->p1];
  77143. assert( pC!=0 );
  77144. assert( pC->eCurType==CURTYPE_BTREE );
  77145. pCrsr = pC->uc.pCursor;
  77146. assert( pCrsr!=0 );
  77147. assert( pOp->p5==0 );
  77148. r.pKeyInfo = pC->pKeyInfo;
  77149. r.nField = (u16)pOp->p3;
  77150. r.default_rc = 0;
  77151. r.aMem = &aMem[pOp->p2];
  77152. rc = sqlite3BtreeMovetoUnpacked(pCrsr, &r, 0, 0, &res);
  77153. if( rc ) goto abort_due_to_error;
  77154. if( res==0 ){
  77155. rc = sqlite3BtreeDelete(pCrsr, BTREE_AUXDELETE);
  77156. if( rc ) goto abort_due_to_error;
  77157. }
  77158. assert( pC->deferredMoveto==0 );
  77159. pC->cacheStatus = CACHE_STALE;
  77160. break;
  77161. }
  77162. /* Opcode: Seek P1 * P3 P4 *
  77163. ** Synopsis: Move P3 to P1.rowid
  77164. **
  77165. ** P1 is an open index cursor and P3 is a cursor on the corresponding
  77166. ** table. This opcode does a deferred seek of the P3 table cursor
  77167. ** to the row that corresponds to the current row of P1.
  77168. **
  77169. ** This is a deferred seek. Nothing actually happens until
  77170. ** the cursor is used to read a record. That way, if no reads
  77171. ** occur, no unnecessary I/O happens.
  77172. **
  77173. ** P4 may be an array of integers (type P4_INTARRAY) containing
  77174. ** one entry for each column in the P3 table. If array entry a(i)
  77175. ** is non-zero, then reading column a(i)-1 from cursor P3 is
  77176. ** equivalent to performing the deferred seek and then reading column i
  77177. ** from P1. This information is stored in P3 and used to redirect
  77178. ** reads against P3 over to P1, thus possibly avoiding the need to
  77179. ** seek and read cursor P3.
  77180. */
  77181. /* Opcode: IdxRowid P1 P2 * * *
  77182. ** Synopsis: r[P2]=rowid
  77183. **
  77184. ** Write into register P2 an integer which is the last entry in the record at
  77185. ** the end of the index key pointed to by cursor P1. This integer should be
  77186. ** the rowid of the table entry to which this index entry points.
  77187. **
  77188. ** See also: Rowid, MakeRecord.
  77189. */
  77190. case OP_Seek:
  77191. case OP_IdxRowid: { /* out2 */
  77192. VdbeCursor *pC; /* The P1 index cursor */
  77193. VdbeCursor *pTabCur; /* The P2 table cursor (OP_Seek only) */
  77194. i64 rowid; /* Rowid that P1 current points to */
  77195. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77196. pC = p->apCsr[pOp->p1];
  77197. assert( pC!=0 );
  77198. assert( pC->eCurType==CURTYPE_BTREE );
  77199. assert( pC->uc.pCursor!=0 );
  77200. assert( pC->isTable==0 );
  77201. assert( pC->deferredMoveto==0 );
  77202. assert( !pC->nullRow || pOp->opcode==OP_IdxRowid );
  77203. /* The IdxRowid and Seek opcodes are combined because of the commonality
  77204. ** of sqlite3VdbeCursorRestore() and sqlite3VdbeIdxRowid(). */
  77205. rc = sqlite3VdbeCursorRestore(pC);
  77206. /* sqlite3VbeCursorRestore() can only fail if the record has been deleted
  77207. ** out from under the cursor. That will never happens for an IdxRowid
  77208. ** or Seek opcode */
  77209. if( NEVER(rc!=SQLITE_OK) ) goto abort_due_to_error;
  77210. if( !pC->nullRow ){
  77211. rowid = 0; /* Not needed. Only used to silence a warning. */
  77212. rc = sqlite3VdbeIdxRowid(db, pC->uc.pCursor, &rowid);
  77213. if( rc!=SQLITE_OK ){
  77214. goto abort_due_to_error;
  77215. }
  77216. if( pOp->opcode==OP_Seek ){
  77217. assert( pOp->p3>=0 && pOp->p3<p->nCursor );
  77218. pTabCur = p->apCsr[pOp->p3];
  77219. assert( pTabCur!=0 );
  77220. assert( pTabCur->eCurType==CURTYPE_BTREE );
  77221. assert( pTabCur->uc.pCursor!=0 );
  77222. assert( pTabCur->isTable );
  77223. pTabCur->nullRow = 0;
  77224. pTabCur->movetoTarget = rowid;
  77225. pTabCur->deferredMoveto = 1;
  77226. assert( pOp->p4type==P4_INTARRAY || pOp->p4.ai==0 );
  77227. pTabCur->aAltMap = pOp->p4.ai;
  77228. pTabCur->pAltCursor = pC;
  77229. }else{
  77230. pOut = out2Prerelease(p, pOp);
  77231. pOut->u.i = rowid;
  77232. pOut->flags = MEM_Int;
  77233. }
  77234. }else{
  77235. assert( pOp->opcode==OP_IdxRowid );
  77236. sqlite3VdbeMemSetNull(&aMem[pOp->p2]);
  77237. }
  77238. break;
  77239. }
  77240. /* Opcode: IdxGE P1 P2 P3 P4 P5
  77241. ** Synopsis: key=r[P3@P4]
  77242. **
  77243. ** The P4 register values beginning with P3 form an unpacked index
  77244. ** key that omits the PRIMARY KEY. Compare this key value against the index
  77245. ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
  77246. ** fields at the end.
  77247. **
  77248. ** If the P1 index entry is greater than or equal to the key value
  77249. ** then jump to P2. Otherwise fall through to the next instruction.
  77250. */
  77251. /* Opcode: IdxGT P1 P2 P3 P4 P5
  77252. ** Synopsis: key=r[P3@P4]
  77253. **
  77254. ** The P4 register values beginning with P3 form an unpacked index
  77255. ** key that omits the PRIMARY KEY. Compare this key value against the index
  77256. ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
  77257. ** fields at the end.
  77258. **
  77259. ** If the P1 index entry is greater than the key value
  77260. ** then jump to P2. Otherwise fall through to the next instruction.
  77261. */
  77262. /* Opcode: IdxLT P1 P2 P3 P4 P5
  77263. ** Synopsis: key=r[P3@P4]
  77264. **
  77265. ** The P4 register values beginning with P3 form an unpacked index
  77266. ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
  77267. ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
  77268. ** ROWID on the P1 index.
  77269. **
  77270. ** If the P1 index entry is less than the key value then jump to P2.
  77271. ** Otherwise fall through to the next instruction.
  77272. */
  77273. /* Opcode: IdxLE P1 P2 P3 P4 P5
  77274. ** Synopsis: key=r[P3@P4]
  77275. **
  77276. ** The P4 register values beginning with P3 form an unpacked index
  77277. ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
  77278. ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
  77279. ** ROWID on the P1 index.
  77280. **
  77281. ** If the P1 index entry is less than or equal to the key value then jump
  77282. ** to P2. Otherwise fall through to the next instruction.
  77283. */
  77284. case OP_IdxLE: /* jump */
  77285. case OP_IdxGT: /* jump */
  77286. case OP_IdxLT: /* jump */
  77287. case OP_IdxGE: { /* jump */
  77288. VdbeCursor *pC;
  77289. int res;
  77290. UnpackedRecord r;
  77291. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77292. pC = p->apCsr[pOp->p1];
  77293. assert( pC!=0 );
  77294. assert( pC->isOrdered );
  77295. assert( pC->eCurType==CURTYPE_BTREE );
  77296. assert( pC->uc.pCursor!=0);
  77297. assert( pC->deferredMoveto==0 );
  77298. assert( pOp->p5==0 || pOp->p5==1 );
  77299. assert( pOp->p4type==P4_INT32 );
  77300. r.pKeyInfo = pC->pKeyInfo;
  77301. r.nField = (u16)pOp->p4.i;
  77302. if( pOp->opcode<OP_IdxLT ){
  77303. assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxGT );
  77304. r.default_rc = -1;
  77305. }else{
  77306. assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxLT );
  77307. r.default_rc = 0;
  77308. }
  77309. r.aMem = &aMem[pOp->p3];
  77310. #ifdef SQLITE_DEBUG
  77311. { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
  77312. #endif
  77313. res = 0; /* Not needed. Only used to silence a warning. */
  77314. rc = sqlite3VdbeIdxKeyCompare(db, pC, &r, &res);
  77315. assert( (OP_IdxLE&1)==(OP_IdxLT&1) && (OP_IdxGE&1)==(OP_IdxGT&1) );
  77316. if( (pOp->opcode&1)==(OP_IdxLT&1) ){
  77317. assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxLT );
  77318. res = -res;
  77319. }else{
  77320. assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxGT );
  77321. res++;
  77322. }
  77323. VdbeBranchTaken(res>0,2);
  77324. if( rc ) goto abort_due_to_error;
  77325. if( res>0 ) goto jump_to_p2;
  77326. break;
  77327. }
  77328. /* Opcode: Destroy P1 P2 P3 * *
  77329. **
  77330. ** Delete an entire database table or index whose root page in the database
  77331. ** file is given by P1.
  77332. **
  77333. ** The table being destroyed is in the main database file if P3==0. If
  77334. ** P3==1 then the table to be clear is in the auxiliary database file
  77335. ** that is used to store tables create using CREATE TEMPORARY TABLE.
  77336. **
  77337. ** If AUTOVACUUM is enabled then it is possible that another root page
  77338. ** might be moved into the newly deleted root page in order to keep all
  77339. ** root pages contiguous at the beginning of the database. The former
  77340. ** value of the root page that moved - its value before the move occurred -
  77341. ** is stored in register P2. If no page
  77342. ** movement was required (because the table being dropped was already
  77343. ** the last one in the database) then a zero is stored in register P2.
  77344. ** If AUTOVACUUM is disabled then a zero is stored in register P2.
  77345. **
  77346. ** See also: Clear
  77347. */
  77348. case OP_Destroy: { /* out2 */
  77349. int iMoved;
  77350. int iDb;
  77351. assert( p->readOnly==0 );
  77352. assert( pOp->p1>1 );
  77353. pOut = out2Prerelease(p, pOp);
  77354. pOut->flags = MEM_Null;
  77355. if( db->nVdbeRead > db->nVDestroy+1 ){
  77356. rc = SQLITE_LOCKED;
  77357. p->errorAction = OE_Abort;
  77358. goto abort_due_to_error;
  77359. }else{
  77360. iDb = pOp->p3;
  77361. assert( DbMaskTest(p->btreeMask, iDb) );
  77362. iMoved = 0; /* Not needed. Only to silence a warning. */
  77363. rc = sqlite3BtreeDropTable(db->aDb[iDb].pBt, pOp->p1, &iMoved);
  77364. pOut->flags = MEM_Int;
  77365. pOut->u.i = iMoved;
  77366. if( rc ) goto abort_due_to_error;
  77367. #ifndef SQLITE_OMIT_AUTOVACUUM
  77368. if( iMoved!=0 ){
  77369. sqlite3RootPageMoved(db, iDb, iMoved, pOp->p1);
  77370. /* All OP_Destroy operations occur on the same btree */
  77371. assert( resetSchemaOnFault==0 || resetSchemaOnFault==iDb+1 );
  77372. resetSchemaOnFault = iDb+1;
  77373. }
  77374. #endif
  77375. }
  77376. break;
  77377. }
  77378. /* Opcode: Clear P1 P2 P3
  77379. **
  77380. ** Delete all contents of the database table or index whose root page
  77381. ** in the database file is given by P1. But, unlike Destroy, do not
  77382. ** remove the table or index from the database file.
  77383. **
  77384. ** The table being clear is in the main database file if P2==0. If
  77385. ** P2==1 then the table to be clear is in the auxiliary database file
  77386. ** that is used to store tables create using CREATE TEMPORARY TABLE.
  77387. **
  77388. ** If the P3 value is non-zero, then the table referred to must be an
  77389. ** intkey table (an SQL table, not an index). In this case the row change
  77390. ** count is incremented by the number of rows in the table being cleared.
  77391. ** If P3 is greater than zero, then the value stored in register P3 is
  77392. ** also incremented by the number of rows in the table being cleared.
  77393. **
  77394. ** See also: Destroy
  77395. */
  77396. case OP_Clear: {
  77397. int nChange;
  77398. nChange = 0;
  77399. assert( p->readOnly==0 );
  77400. assert( DbMaskTest(p->btreeMask, pOp->p2) );
  77401. rc = sqlite3BtreeClearTable(
  77402. db->aDb[pOp->p2].pBt, pOp->p1, (pOp->p3 ? &nChange : 0)
  77403. );
  77404. if( pOp->p3 ){
  77405. p->nChange += nChange;
  77406. if( pOp->p3>0 ){
  77407. assert( memIsValid(&aMem[pOp->p3]) );
  77408. memAboutToChange(p, &aMem[pOp->p3]);
  77409. aMem[pOp->p3].u.i += nChange;
  77410. }
  77411. }
  77412. if( rc ) goto abort_due_to_error;
  77413. break;
  77414. }
  77415. /* Opcode: ResetSorter P1 * * * *
  77416. **
  77417. ** Delete all contents from the ephemeral table or sorter
  77418. ** that is open on cursor P1.
  77419. **
  77420. ** This opcode only works for cursors used for sorting and
  77421. ** opened with OP_OpenEphemeral or OP_SorterOpen.
  77422. */
  77423. case OP_ResetSorter: {
  77424. VdbeCursor *pC;
  77425. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  77426. pC = p->apCsr[pOp->p1];
  77427. assert( pC!=0 );
  77428. if( isSorter(pC) ){
  77429. sqlite3VdbeSorterReset(db, pC->uc.pSorter);
  77430. }else{
  77431. assert( pC->eCurType==CURTYPE_BTREE );
  77432. assert( pC->isEphemeral );
  77433. rc = sqlite3BtreeClearTableOfCursor(pC->uc.pCursor);
  77434. if( rc ) goto abort_due_to_error;
  77435. }
  77436. break;
  77437. }
  77438. /* Opcode: CreateTable P1 P2 * * *
  77439. ** Synopsis: r[P2]=root iDb=P1
  77440. **
  77441. ** Allocate a new table in the main database file if P1==0 or in the
  77442. ** auxiliary database file if P1==1 or in an attached database if
  77443. ** P1>1. Write the root page number of the new table into
  77444. ** register P2
  77445. **
  77446. ** The difference between a table and an index is this: A table must
  77447. ** have a 4-byte integer key and can have arbitrary data. An index
  77448. ** has an arbitrary key but no data.
  77449. **
  77450. ** See also: CreateIndex
  77451. */
  77452. /* Opcode: CreateIndex P1 P2 * * *
  77453. ** Synopsis: r[P2]=root iDb=P1
  77454. **
  77455. ** Allocate a new index in the main database file if P1==0 or in the
  77456. ** auxiliary database file if P1==1 or in an attached database if
  77457. ** P1>1. Write the root page number of the new table into
  77458. ** register P2.
  77459. **
  77460. ** See documentation on OP_CreateTable for additional information.
  77461. */
  77462. case OP_CreateIndex: /* out2 */
  77463. case OP_CreateTable: { /* out2 */
  77464. int pgno;
  77465. int flags;
  77466. Db *pDb;
  77467. pOut = out2Prerelease(p, pOp);
  77468. pgno = 0;
  77469. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  77470. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  77471. assert( p->readOnly==0 );
  77472. pDb = &db->aDb[pOp->p1];
  77473. assert( pDb->pBt!=0 );
  77474. if( pOp->opcode==OP_CreateTable ){
  77475. /* flags = BTREE_INTKEY; */
  77476. flags = BTREE_INTKEY;
  77477. }else{
  77478. flags = BTREE_BLOBKEY;
  77479. }
  77480. rc = sqlite3BtreeCreateTable(pDb->pBt, &pgno, flags);
  77481. if( rc ) goto abort_due_to_error;
  77482. pOut->u.i = pgno;
  77483. break;
  77484. }
  77485. /* Opcode: ParseSchema P1 * * P4 *
  77486. **
  77487. ** Read and parse all entries from the SQLITE_MASTER table of database P1
  77488. ** that match the WHERE clause P4.
  77489. **
  77490. ** This opcode invokes the parser to create a new virtual machine,
  77491. ** then runs the new virtual machine. It is thus a re-entrant opcode.
  77492. */
  77493. case OP_ParseSchema: {
  77494. int iDb;
  77495. const char *zMaster;
  77496. char *zSql;
  77497. InitData initData;
  77498. /* Any prepared statement that invokes this opcode will hold mutexes
  77499. ** on every btree. This is a prerequisite for invoking
  77500. ** sqlite3InitCallback().
  77501. */
  77502. #ifdef SQLITE_DEBUG
  77503. for(iDb=0; iDb<db->nDb; iDb++){
  77504. assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
  77505. }
  77506. #endif
  77507. iDb = pOp->p1;
  77508. assert( iDb>=0 && iDb<db->nDb );
  77509. assert( DbHasProperty(db, iDb, DB_SchemaLoaded) );
  77510. /* Used to be a conditional */ {
  77511. zMaster = SCHEMA_TABLE(iDb);
  77512. initData.db = db;
  77513. initData.iDb = pOp->p1;
  77514. initData.pzErrMsg = &p->zErrMsg;
  77515. zSql = sqlite3MPrintf(db,
  77516. "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s ORDER BY rowid",
  77517. db->aDb[iDb].zDbSName, zMaster, pOp->p4.z);
  77518. if( zSql==0 ){
  77519. rc = SQLITE_NOMEM_BKPT;
  77520. }else{
  77521. assert( db->init.busy==0 );
  77522. db->init.busy = 1;
  77523. initData.rc = SQLITE_OK;
  77524. assert( !db->mallocFailed );
  77525. rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
  77526. if( rc==SQLITE_OK ) rc = initData.rc;
  77527. sqlite3DbFree(db, zSql);
  77528. db->init.busy = 0;
  77529. }
  77530. }
  77531. if( rc ){
  77532. sqlite3ResetAllSchemasOfConnection(db);
  77533. if( rc==SQLITE_NOMEM ){
  77534. goto no_mem;
  77535. }
  77536. goto abort_due_to_error;
  77537. }
  77538. break;
  77539. }
  77540. #if !defined(SQLITE_OMIT_ANALYZE)
  77541. /* Opcode: LoadAnalysis P1 * * * *
  77542. **
  77543. ** Read the sqlite_stat1 table for database P1 and load the content
  77544. ** of that table into the internal index hash table. This will cause
  77545. ** the analysis to be used when preparing all subsequent queries.
  77546. */
  77547. case OP_LoadAnalysis: {
  77548. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  77549. rc = sqlite3AnalysisLoad(db, pOp->p1);
  77550. if( rc ) goto abort_due_to_error;
  77551. break;
  77552. }
  77553. #endif /* !defined(SQLITE_OMIT_ANALYZE) */
  77554. /* Opcode: DropTable P1 * * P4 *
  77555. **
  77556. ** Remove the internal (in-memory) data structures that describe
  77557. ** the table named P4 in database P1. This is called after a table
  77558. ** is dropped from disk (using the Destroy opcode) in order to keep
  77559. ** the internal representation of the
  77560. ** schema consistent with what is on disk.
  77561. */
  77562. case OP_DropTable: {
  77563. sqlite3UnlinkAndDeleteTable(db, pOp->p1, pOp->p4.z);
  77564. break;
  77565. }
  77566. /* Opcode: DropIndex P1 * * P4 *
  77567. **
  77568. ** Remove the internal (in-memory) data structures that describe
  77569. ** the index named P4 in database P1. This is called after an index
  77570. ** is dropped from disk (using the Destroy opcode)
  77571. ** in order to keep the internal representation of the
  77572. ** schema consistent with what is on disk.
  77573. */
  77574. case OP_DropIndex: {
  77575. sqlite3UnlinkAndDeleteIndex(db, pOp->p1, pOp->p4.z);
  77576. break;
  77577. }
  77578. /* Opcode: DropTrigger P1 * * P4 *
  77579. **
  77580. ** Remove the internal (in-memory) data structures that describe
  77581. ** the trigger named P4 in database P1. This is called after a trigger
  77582. ** is dropped from disk (using the Destroy opcode) in order to keep
  77583. ** the internal representation of the
  77584. ** schema consistent with what is on disk.
  77585. */
  77586. case OP_DropTrigger: {
  77587. sqlite3UnlinkAndDeleteTrigger(db, pOp->p1, pOp->p4.z);
  77588. break;
  77589. }
  77590. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  77591. /* Opcode: IntegrityCk P1 P2 P3 P4 P5
  77592. **
  77593. ** Do an analysis of the currently open database. Store in
  77594. ** register P1 the text of an error message describing any problems.
  77595. ** If no problems are found, store a NULL in register P1.
  77596. **
  77597. ** The register P3 contains the maximum number of allowed errors.
  77598. ** At most reg(P3) errors will be reported.
  77599. ** In other words, the analysis stops as soon as reg(P1) errors are
  77600. ** seen. Reg(P1) is updated with the number of errors remaining.
  77601. **
  77602. ** The root page numbers of all tables in the database are integers
  77603. ** stored in P4_INTARRAY argument.
  77604. **
  77605. ** If P5 is not zero, the check is done on the auxiliary database
  77606. ** file, not the main database file.
  77607. **
  77608. ** This opcode is used to implement the integrity_check pragma.
  77609. */
  77610. case OP_IntegrityCk: {
  77611. int nRoot; /* Number of tables to check. (Number of root pages.) */
  77612. int *aRoot; /* Array of rootpage numbers for tables to be checked */
  77613. int nErr; /* Number of errors reported */
  77614. char *z; /* Text of the error report */
  77615. Mem *pnErr; /* Register keeping track of errors remaining */
  77616. assert( p->bIsReader );
  77617. nRoot = pOp->p2;
  77618. aRoot = pOp->p4.ai;
  77619. assert( nRoot>0 );
  77620. assert( aRoot[nRoot]==0 );
  77621. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  77622. pnErr = &aMem[pOp->p3];
  77623. assert( (pnErr->flags & MEM_Int)!=0 );
  77624. assert( (pnErr->flags & (MEM_Str|MEM_Blob))==0 );
  77625. pIn1 = &aMem[pOp->p1];
  77626. assert( pOp->p5<db->nDb );
  77627. assert( DbMaskTest(p->btreeMask, pOp->p5) );
  77628. z = sqlite3BtreeIntegrityCheck(db->aDb[pOp->p5].pBt, aRoot, nRoot,
  77629. (int)pnErr->u.i, &nErr);
  77630. pnErr->u.i -= nErr;
  77631. sqlite3VdbeMemSetNull(pIn1);
  77632. if( nErr==0 ){
  77633. assert( z==0 );
  77634. }else if( z==0 ){
  77635. goto no_mem;
  77636. }else{
  77637. sqlite3VdbeMemSetStr(pIn1, z, -1, SQLITE_UTF8, sqlite3_free);
  77638. }
  77639. UPDATE_MAX_BLOBSIZE(pIn1);
  77640. sqlite3VdbeChangeEncoding(pIn1, encoding);
  77641. break;
  77642. }
  77643. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  77644. /* Opcode: RowSetAdd P1 P2 * * *
  77645. ** Synopsis: rowset(P1)=r[P2]
  77646. **
  77647. ** Insert the integer value held by register P2 into a boolean index
  77648. ** held in register P1.
  77649. **
  77650. ** An assertion fails if P2 is not an integer.
  77651. */
  77652. case OP_RowSetAdd: { /* in1, in2 */
  77653. pIn1 = &aMem[pOp->p1];
  77654. pIn2 = &aMem[pOp->p2];
  77655. assert( (pIn2->flags & MEM_Int)!=0 );
  77656. if( (pIn1->flags & MEM_RowSet)==0 ){
  77657. sqlite3VdbeMemSetRowSet(pIn1);
  77658. if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
  77659. }
  77660. sqlite3RowSetInsert(pIn1->u.pRowSet, pIn2->u.i);
  77661. break;
  77662. }
  77663. /* Opcode: RowSetRead P1 P2 P3 * *
  77664. ** Synopsis: r[P3]=rowset(P1)
  77665. **
  77666. ** Extract the smallest value from boolean index P1 and put that value into
  77667. ** register P3. Or, if boolean index P1 is initially empty, leave P3
  77668. ** unchanged and jump to instruction P2.
  77669. */
  77670. case OP_RowSetRead: { /* jump, in1, out3 */
  77671. i64 val;
  77672. pIn1 = &aMem[pOp->p1];
  77673. if( (pIn1->flags & MEM_RowSet)==0
  77674. || sqlite3RowSetNext(pIn1->u.pRowSet, &val)==0
  77675. ){
  77676. /* The boolean index is empty */
  77677. sqlite3VdbeMemSetNull(pIn1);
  77678. VdbeBranchTaken(1,2);
  77679. goto jump_to_p2_and_check_for_interrupt;
  77680. }else{
  77681. /* A value was pulled from the index */
  77682. VdbeBranchTaken(0,2);
  77683. sqlite3VdbeMemSetInt64(&aMem[pOp->p3], val);
  77684. }
  77685. goto check_for_interrupt;
  77686. }
  77687. /* Opcode: RowSetTest P1 P2 P3 P4
  77688. ** Synopsis: if r[P3] in rowset(P1) goto P2
  77689. **
  77690. ** Register P3 is assumed to hold a 64-bit integer value. If register P1
  77691. ** contains a RowSet object and that RowSet object contains
  77692. ** the value held in P3, jump to register P2. Otherwise, insert the
  77693. ** integer in P3 into the RowSet and continue on to the
  77694. ** next opcode.
  77695. **
  77696. ** The RowSet object is optimized for the case where successive sets
  77697. ** of integers, where each set contains no duplicates. Each set
  77698. ** of values is identified by a unique P4 value. The first set
  77699. ** must have P4==0, the final set P4=-1. P4 must be either -1 or
  77700. ** non-negative. For non-negative values of P4 only the lower 4
  77701. ** bits are significant.
  77702. **
  77703. ** This allows optimizations: (a) when P4==0 there is no need to test
  77704. ** the rowset object for P3, as it is guaranteed not to contain it,
  77705. ** (b) when P4==-1 there is no need to insert the value, as it will
  77706. ** never be tested for, and (c) when a value that is part of set X is
  77707. ** inserted, there is no need to search to see if the same value was
  77708. ** previously inserted as part of set X (only if it was previously
  77709. ** inserted as part of some other set).
  77710. */
  77711. case OP_RowSetTest: { /* jump, in1, in3 */
  77712. int iSet;
  77713. int exists;
  77714. pIn1 = &aMem[pOp->p1];
  77715. pIn3 = &aMem[pOp->p3];
  77716. iSet = pOp->p4.i;
  77717. assert( pIn3->flags&MEM_Int );
  77718. /* If there is anything other than a rowset object in memory cell P1,
  77719. ** delete it now and initialize P1 with an empty rowset
  77720. */
  77721. if( (pIn1->flags & MEM_RowSet)==0 ){
  77722. sqlite3VdbeMemSetRowSet(pIn1);
  77723. if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
  77724. }
  77725. assert( pOp->p4type==P4_INT32 );
  77726. assert( iSet==-1 || iSet>=0 );
  77727. if( iSet ){
  77728. exists = sqlite3RowSetTest(pIn1->u.pRowSet, iSet, pIn3->u.i);
  77729. VdbeBranchTaken(exists!=0,2);
  77730. if( exists ) goto jump_to_p2;
  77731. }
  77732. if( iSet>=0 ){
  77733. sqlite3RowSetInsert(pIn1->u.pRowSet, pIn3->u.i);
  77734. }
  77735. break;
  77736. }
  77737. #ifndef SQLITE_OMIT_TRIGGER
  77738. /* Opcode: Program P1 P2 P3 P4 P5
  77739. **
  77740. ** Execute the trigger program passed as P4 (type P4_SUBPROGRAM).
  77741. **
  77742. ** P1 contains the address of the memory cell that contains the first memory
  77743. ** cell in an array of values used as arguments to the sub-program. P2
  77744. ** contains the address to jump to if the sub-program throws an IGNORE
  77745. ** exception using the RAISE() function. Register P3 contains the address
  77746. ** of a memory cell in this (the parent) VM that is used to allocate the
  77747. ** memory required by the sub-vdbe at runtime.
  77748. **
  77749. ** P4 is a pointer to the VM containing the trigger program.
  77750. **
  77751. ** If P5 is non-zero, then recursive program invocation is enabled.
  77752. */
  77753. case OP_Program: { /* jump */
  77754. int nMem; /* Number of memory registers for sub-program */
  77755. int nByte; /* Bytes of runtime space required for sub-program */
  77756. Mem *pRt; /* Register to allocate runtime space */
  77757. Mem *pMem; /* Used to iterate through memory cells */
  77758. Mem *pEnd; /* Last memory cell in new array */
  77759. VdbeFrame *pFrame; /* New vdbe frame to execute in */
  77760. SubProgram *pProgram; /* Sub-program to execute */
  77761. void *t; /* Token identifying trigger */
  77762. pProgram = pOp->p4.pProgram;
  77763. pRt = &aMem[pOp->p3];
  77764. assert( pProgram->nOp>0 );
  77765. /* If the p5 flag is clear, then recursive invocation of triggers is
  77766. ** disabled for backwards compatibility (p5 is set if this sub-program
  77767. ** is really a trigger, not a foreign key action, and the flag set
  77768. ** and cleared by the "PRAGMA recursive_triggers" command is clear).
  77769. **
  77770. ** It is recursive invocation of triggers, at the SQL level, that is
  77771. ** disabled. In some cases a single trigger may generate more than one
  77772. ** SubProgram (if the trigger may be executed with more than one different
  77773. ** ON CONFLICT algorithm). SubProgram structures associated with a
  77774. ** single trigger all have the same value for the SubProgram.token
  77775. ** variable. */
  77776. if( pOp->p5 ){
  77777. t = pProgram->token;
  77778. for(pFrame=p->pFrame; pFrame && pFrame->token!=t; pFrame=pFrame->pParent);
  77779. if( pFrame ) break;
  77780. }
  77781. if( p->nFrame>=db->aLimit[SQLITE_LIMIT_TRIGGER_DEPTH] ){
  77782. rc = SQLITE_ERROR;
  77783. sqlite3VdbeError(p, "too many levels of trigger recursion");
  77784. goto abort_due_to_error;
  77785. }
  77786. /* Register pRt is used to store the memory required to save the state
  77787. ** of the current program, and the memory required at runtime to execute
  77788. ** the trigger program. If this trigger has been fired before, then pRt
  77789. ** is already allocated. Otherwise, it must be initialized. */
  77790. if( (pRt->flags&MEM_Frame)==0 ){
  77791. /* SubProgram.nMem is set to the number of memory cells used by the
  77792. ** program stored in SubProgram.aOp. As well as these, one memory
  77793. ** cell is required for each cursor used by the program. Set local
  77794. ** variable nMem (and later, VdbeFrame.nChildMem) to this value.
  77795. */
  77796. nMem = pProgram->nMem + pProgram->nCsr;
  77797. assert( nMem>0 );
  77798. if( pProgram->nCsr==0 ) nMem++;
  77799. nByte = ROUND8(sizeof(VdbeFrame))
  77800. + nMem * sizeof(Mem)
  77801. + pProgram->nCsr * sizeof(VdbeCursor *);
  77802. pFrame = sqlite3DbMallocZero(db, nByte);
  77803. if( !pFrame ){
  77804. goto no_mem;
  77805. }
  77806. sqlite3VdbeMemRelease(pRt);
  77807. pRt->flags = MEM_Frame;
  77808. pRt->u.pFrame = pFrame;
  77809. pFrame->v = p;
  77810. pFrame->nChildMem = nMem;
  77811. pFrame->nChildCsr = pProgram->nCsr;
  77812. pFrame->pc = (int)(pOp - aOp);
  77813. pFrame->aMem = p->aMem;
  77814. pFrame->nMem = p->nMem;
  77815. pFrame->apCsr = p->apCsr;
  77816. pFrame->nCursor = p->nCursor;
  77817. pFrame->aOp = p->aOp;
  77818. pFrame->nOp = p->nOp;
  77819. pFrame->token = pProgram->token;
  77820. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  77821. pFrame->anExec = p->anExec;
  77822. #endif
  77823. pEnd = &VdbeFrameMem(pFrame)[pFrame->nChildMem];
  77824. for(pMem=VdbeFrameMem(pFrame); pMem!=pEnd; pMem++){
  77825. pMem->flags = MEM_Undefined;
  77826. pMem->db = db;
  77827. }
  77828. }else{
  77829. pFrame = pRt->u.pFrame;
  77830. assert( pProgram->nMem+pProgram->nCsr==pFrame->nChildMem
  77831. || (pProgram->nCsr==0 && pProgram->nMem+1==pFrame->nChildMem) );
  77832. assert( pProgram->nCsr==pFrame->nChildCsr );
  77833. assert( (int)(pOp - aOp)==pFrame->pc );
  77834. }
  77835. p->nFrame++;
  77836. pFrame->pParent = p->pFrame;
  77837. pFrame->lastRowid = lastRowid;
  77838. pFrame->nChange = p->nChange;
  77839. pFrame->nDbChange = p->db->nChange;
  77840. assert( pFrame->pAuxData==0 );
  77841. pFrame->pAuxData = p->pAuxData;
  77842. p->pAuxData = 0;
  77843. p->nChange = 0;
  77844. p->pFrame = pFrame;
  77845. p->aMem = aMem = VdbeFrameMem(pFrame);
  77846. p->nMem = pFrame->nChildMem;
  77847. p->nCursor = (u16)pFrame->nChildCsr;
  77848. p->apCsr = (VdbeCursor **)&aMem[p->nMem];
  77849. p->aOp = aOp = pProgram->aOp;
  77850. p->nOp = pProgram->nOp;
  77851. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  77852. p->anExec = 0;
  77853. #endif
  77854. pOp = &aOp[-1];
  77855. break;
  77856. }
  77857. /* Opcode: Param P1 P2 * * *
  77858. **
  77859. ** This opcode is only ever present in sub-programs called via the
  77860. ** OP_Program instruction. Copy a value currently stored in a memory
  77861. ** cell of the calling (parent) frame to cell P2 in the current frames
  77862. ** address space. This is used by trigger programs to access the new.*
  77863. ** and old.* values.
  77864. **
  77865. ** The address of the cell in the parent frame is determined by adding
  77866. ** the value of the P1 argument to the value of the P1 argument to the
  77867. ** calling OP_Program instruction.
  77868. */
  77869. case OP_Param: { /* out2 */
  77870. VdbeFrame *pFrame;
  77871. Mem *pIn;
  77872. pOut = out2Prerelease(p, pOp);
  77873. pFrame = p->pFrame;
  77874. pIn = &pFrame->aMem[pOp->p1 + pFrame->aOp[pFrame->pc].p1];
  77875. sqlite3VdbeMemShallowCopy(pOut, pIn, MEM_Ephem);
  77876. break;
  77877. }
  77878. #endif /* #ifndef SQLITE_OMIT_TRIGGER */
  77879. #ifndef SQLITE_OMIT_FOREIGN_KEY
  77880. /* Opcode: FkCounter P1 P2 * * *
  77881. ** Synopsis: fkctr[P1]+=P2
  77882. **
  77883. ** Increment a "constraint counter" by P2 (P2 may be negative or positive).
  77884. ** If P1 is non-zero, the database constraint counter is incremented
  77885. ** (deferred foreign key constraints). Otherwise, if P1 is zero, the
  77886. ** statement counter is incremented (immediate foreign key constraints).
  77887. */
  77888. case OP_FkCounter: {
  77889. if( db->flags & SQLITE_DeferFKs ){
  77890. db->nDeferredImmCons += pOp->p2;
  77891. }else if( pOp->p1 ){
  77892. db->nDeferredCons += pOp->p2;
  77893. }else{
  77894. p->nFkConstraint += pOp->p2;
  77895. }
  77896. break;
  77897. }
  77898. /* Opcode: FkIfZero P1 P2 * * *
  77899. ** Synopsis: if fkctr[P1]==0 goto P2
  77900. **
  77901. ** This opcode tests if a foreign key constraint-counter is currently zero.
  77902. ** If so, jump to instruction P2. Otherwise, fall through to the next
  77903. ** instruction.
  77904. **
  77905. ** If P1 is non-zero, then the jump is taken if the database constraint-counter
  77906. ** is zero (the one that counts deferred constraint violations). If P1 is
  77907. ** zero, the jump is taken if the statement constraint-counter is zero
  77908. ** (immediate foreign key constraint violations).
  77909. */
  77910. case OP_FkIfZero: { /* jump */
  77911. if( pOp->p1 ){
  77912. VdbeBranchTaken(db->nDeferredCons==0 && db->nDeferredImmCons==0, 2);
  77913. if( db->nDeferredCons==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
  77914. }else{
  77915. VdbeBranchTaken(p->nFkConstraint==0 && db->nDeferredImmCons==0, 2);
  77916. if( p->nFkConstraint==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
  77917. }
  77918. break;
  77919. }
  77920. #endif /* #ifndef SQLITE_OMIT_FOREIGN_KEY */
  77921. #ifndef SQLITE_OMIT_AUTOINCREMENT
  77922. /* Opcode: MemMax P1 P2 * * *
  77923. ** Synopsis: r[P1]=max(r[P1],r[P2])
  77924. **
  77925. ** P1 is a register in the root frame of this VM (the root frame is
  77926. ** different from the current frame if this instruction is being executed
  77927. ** within a sub-program). Set the value of register P1 to the maximum of
  77928. ** its current value and the value in register P2.
  77929. **
  77930. ** This instruction throws an error if the memory cell is not initially
  77931. ** an integer.
  77932. */
  77933. case OP_MemMax: { /* in2 */
  77934. VdbeFrame *pFrame;
  77935. if( p->pFrame ){
  77936. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  77937. pIn1 = &pFrame->aMem[pOp->p1];
  77938. }else{
  77939. pIn1 = &aMem[pOp->p1];
  77940. }
  77941. assert( memIsValid(pIn1) );
  77942. sqlite3VdbeMemIntegerify(pIn1);
  77943. pIn2 = &aMem[pOp->p2];
  77944. sqlite3VdbeMemIntegerify(pIn2);
  77945. if( pIn1->u.i<pIn2->u.i){
  77946. pIn1->u.i = pIn2->u.i;
  77947. }
  77948. break;
  77949. }
  77950. #endif /* SQLITE_OMIT_AUTOINCREMENT */
  77951. /* Opcode: IfPos P1 P2 P3 * *
  77952. ** Synopsis: if r[P1]>0 then r[P1]-=P3, goto P2
  77953. **
  77954. ** Register P1 must contain an integer.
  77955. ** If the value of register P1 is 1 or greater, subtract P3 from the
  77956. ** value in P1 and jump to P2.
  77957. **
  77958. ** If the initial value of register P1 is less than 1, then the
  77959. ** value is unchanged and control passes through to the next instruction.
  77960. */
  77961. case OP_IfPos: { /* jump, in1 */
  77962. pIn1 = &aMem[pOp->p1];
  77963. assert( pIn1->flags&MEM_Int );
  77964. VdbeBranchTaken( pIn1->u.i>0, 2);
  77965. if( pIn1->u.i>0 ){
  77966. pIn1->u.i -= pOp->p3;
  77967. goto jump_to_p2;
  77968. }
  77969. break;
  77970. }
  77971. /* Opcode: OffsetLimit P1 P2 P3 * *
  77972. ** Synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)
  77973. **
  77974. ** This opcode performs a commonly used computation associated with
  77975. ** LIMIT and OFFSET process. r[P1] holds the limit counter. r[P3]
  77976. ** holds the offset counter. The opcode computes the combined value
  77977. ** of the LIMIT and OFFSET and stores that value in r[P2]. The r[P2]
  77978. ** value computed is the total number of rows that will need to be
  77979. ** visited in order to complete the query.
  77980. **
  77981. ** If r[P3] is zero or negative, that means there is no OFFSET
  77982. ** and r[P2] is set to be the value of the LIMIT, r[P1].
  77983. **
  77984. ** if r[P1] is zero or negative, that means there is no LIMIT
  77985. ** and r[P2] is set to -1.
  77986. **
  77987. ** Otherwise, r[P2] is set to the sum of r[P1] and r[P3].
  77988. */
  77989. case OP_OffsetLimit: { /* in1, out2, in3 */
  77990. pIn1 = &aMem[pOp->p1];
  77991. pIn3 = &aMem[pOp->p3];
  77992. pOut = out2Prerelease(p, pOp);
  77993. assert( pIn1->flags & MEM_Int );
  77994. assert( pIn3->flags & MEM_Int );
  77995. pOut->u.i = pIn1->u.i<=0 ? -1 : pIn1->u.i+(pIn3->u.i>0?pIn3->u.i:0);
  77996. break;
  77997. }
  77998. /* Opcode: IfNotZero P1 P2 P3 * *
  77999. ** Synopsis: if r[P1]!=0 then r[P1]-=P3, goto P2
  78000. **
  78001. ** Register P1 must contain an integer. If the content of register P1 is
  78002. ** initially nonzero, then subtract P3 from the value in register P1 and
  78003. ** jump to P2. If register P1 is initially zero, leave it unchanged
  78004. ** and fall through.
  78005. */
  78006. case OP_IfNotZero: { /* jump, in1 */
  78007. pIn1 = &aMem[pOp->p1];
  78008. assert( pIn1->flags&MEM_Int );
  78009. VdbeBranchTaken(pIn1->u.i<0, 2);
  78010. if( pIn1->u.i ){
  78011. pIn1->u.i -= pOp->p3;
  78012. goto jump_to_p2;
  78013. }
  78014. break;
  78015. }
  78016. /* Opcode: DecrJumpZero P1 P2 * * *
  78017. ** Synopsis: if (--r[P1])==0 goto P2
  78018. **
  78019. ** Register P1 must hold an integer. Decrement the value in register P1
  78020. ** then jump to P2 if the new value is exactly zero.
  78021. */
  78022. case OP_DecrJumpZero: { /* jump, in1 */
  78023. pIn1 = &aMem[pOp->p1];
  78024. assert( pIn1->flags&MEM_Int );
  78025. pIn1->u.i--;
  78026. VdbeBranchTaken(pIn1->u.i==0, 2);
  78027. if( pIn1->u.i==0 ) goto jump_to_p2;
  78028. break;
  78029. }
  78030. /* Opcode: AggStep0 * P2 P3 P4 P5
  78031. ** Synopsis: accum=r[P3] step(r[P2@P5])
  78032. **
  78033. ** Execute the step function for an aggregate. The
  78034. ** function has P5 arguments. P4 is a pointer to the FuncDef
  78035. ** structure that specifies the function. Register P3 is the
  78036. ** accumulator.
  78037. **
  78038. ** The P5 arguments are taken from register P2 and its
  78039. ** successors.
  78040. */
  78041. /* Opcode: AggStep * P2 P3 P4 P5
  78042. ** Synopsis: accum=r[P3] step(r[P2@P5])
  78043. **
  78044. ** Execute the step function for an aggregate. The
  78045. ** function has P5 arguments. P4 is a pointer to an sqlite3_context
  78046. ** object that is used to run the function. Register P3 is
  78047. ** as the accumulator.
  78048. **
  78049. ** The P5 arguments are taken from register P2 and its
  78050. ** successors.
  78051. **
  78052. ** This opcode is initially coded as OP_AggStep0. On first evaluation,
  78053. ** the FuncDef stored in P4 is converted into an sqlite3_context and
  78054. ** the opcode is changed. In this way, the initialization of the
  78055. ** sqlite3_context only happens once, instead of on each call to the
  78056. ** step function.
  78057. */
  78058. case OP_AggStep0: {
  78059. int n;
  78060. sqlite3_context *pCtx;
  78061. assert( pOp->p4type==P4_FUNCDEF );
  78062. n = pOp->p5;
  78063. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  78064. assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
  78065. assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
  78066. pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
  78067. if( pCtx==0 ) goto no_mem;
  78068. pCtx->pMem = 0;
  78069. pCtx->pFunc = pOp->p4.pFunc;
  78070. pCtx->iOp = (int)(pOp - aOp);
  78071. pCtx->pVdbe = p;
  78072. pCtx->argc = n;
  78073. pOp->p4type = P4_FUNCCTX;
  78074. pOp->p4.pCtx = pCtx;
  78075. pOp->opcode = OP_AggStep;
  78076. /* Fall through into OP_AggStep */
  78077. }
  78078. case OP_AggStep: {
  78079. int i;
  78080. sqlite3_context *pCtx;
  78081. Mem *pMem;
  78082. Mem t;
  78083. assert( pOp->p4type==P4_FUNCCTX );
  78084. pCtx = pOp->p4.pCtx;
  78085. pMem = &aMem[pOp->p3];
  78086. /* If this function is inside of a trigger, the register array in aMem[]
  78087. ** might change from one evaluation to the next. The next block of code
  78088. ** checks to see if the register array has changed, and if so it
  78089. ** reinitializes the relavant parts of the sqlite3_context object */
  78090. if( pCtx->pMem != pMem ){
  78091. pCtx->pMem = pMem;
  78092. for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
  78093. }
  78094. #ifdef SQLITE_DEBUG
  78095. for(i=0; i<pCtx->argc; i++){
  78096. assert( memIsValid(pCtx->argv[i]) );
  78097. REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
  78098. }
  78099. #endif
  78100. pMem->n++;
  78101. sqlite3VdbeMemInit(&t, db, MEM_Null);
  78102. pCtx->pOut = &t;
  78103. pCtx->fErrorOrAux = 0;
  78104. pCtx->skipFlag = 0;
  78105. (pCtx->pFunc->xSFunc)(pCtx,pCtx->argc,pCtx->argv); /* IMP: R-24505-23230 */
  78106. if( pCtx->fErrorOrAux ){
  78107. if( pCtx->isError ){
  78108. sqlite3VdbeError(p, "%s", sqlite3_value_text(&t));
  78109. rc = pCtx->isError;
  78110. }
  78111. sqlite3VdbeMemRelease(&t);
  78112. if( rc ) goto abort_due_to_error;
  78113. }else{
  78114. assert( t.flags==MEM_Null );
  78115. }
  78116. if( pCtx->skipFlag ){
  78117. assert( pOp[-1].opcode==OP_CollSeq );
  78118. i = pOp[-1].p1;
  78119. if( i ) sqlite3VdbeMemSetInt64(&aMem[i], 1);
  78120. }
  78121. break;
  78122. }
  78123. /* Opcode: AggFinal P1 P2 * P4 *
  78124. ** Synopsis: accum=r[P1] N=P2
  78125. **
  78126. ** Execute the finalizer function for an aggregate. P1 is
  78127. ** the memory location that is the accumulator for the aggregate.
  78128. **
  78129. ** P2 is the number of arguments that the step function takes and
  78130. ** P4 is a pointer to the FuncDef for this function. The P2
  78131. ** argument is not used by this opcode. It is only there to disambiguate
  78132. ** functions that can take varying numbers of arguments. The
  78133. ** P4 argument is only needed for the degenerate case where
  78134. ** the step function was not previously called.
  78135. */
  78136. case OP_AggFinal: {
  78137. Mem *pMem;
  78138. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  78139. pMem = &aMem[pOp->p1];
  78140. assert( (pMem->flags & ~(MEM_Null|MEM_Agg))==0 );
  78141. rc = sqlite3VdbeMemFinalize(pMem, pOp->p4.pFunc);
  78142. if( rc ){
  78143. sqlite3VdbeError(p, "%s", sqlite3_value_text(pMem));
  78144. goto abort_due_to_error;
  78145. }
  78146. sqlite3VdbeChangeEncoding(pMem, encoding);
  78147. UPDATE_MAX_BLOBSIZE(pMem);
  78148. if( sqlite3VdbeMemTooBig(pMem) ){
  78149. goto too_big;
  78150. }
  78151. break;
  78152. }
  78153. #ifndef SQLITE_OMIT_WAL
  78154. /* Opcode: Checkpoint P1 P2 P3 * *
  78155. **
  78156. ** Checkpoint database P1. This is a no-op if P1 is not currently in
  78157. ** WAL mode. Parameter P2 is one of SQLITE_CHECKPOINT_PASSIVE, FULL,
  78158. ** RESTART, or TRUNCATE. Write 1 or 0 into mem[P3] if the checkpoint returns
  78159. ** SQLITE_BUSY or not, respectively. Write the number of pages in the
  78160. ** WAL after the checkpoint into mem[P3+1] and the number of pages
  78161. ** in the WAL that have been checkpointed after the checkpoint
  78162. ** completes into mem[P3+2]. However on an error, mem[P3+1] and
  78163. ** mem[P3+2] are initialized to -1.
  78164. */
  78165. case OP_Checkpoint: {
  78166. int i; /* Loop counter */
  78167. int aRes[3]; /* Results */
  78168. Mem *pMem; /* Write results here */
  78169. assert( p->readOnly==0 );
  78170. aRes[0] = 0;
  78171. aRes[1] = aRes[2] = -1;
  78172. assert( pOp->p2==SQLITE_CHECKPOINT_PASSIVE
  78173. || pOp->p2==SQLITE_CHECKPOINT_FULL
  78174. || pOp->p2==SQLITE_CHECKPOINT_RESTART
  78175. || pOp->p2==SQLITE_CHECKPOINT_TRUNCATE
  78176. );
  78177. rc = sqlite3Checkpoint(db, pOp->p1, pOp->p2, &aRes[1], &aRes[2]);
  78178. if( rc ){
  78179. if( rc!=SQLITE_BUSY ) goto abort_due_to_error;
  78180. rc = SQLITE_OK;
  78181. aRes[0] = 1;
  78182. }
  78183. for(i=0, pMem = &aMem[pOp->p3]; i<3; i++, pMem++){
  78184. sqlite3VdbeMemSetInt64(pMem, (i64)aRes[i]);
  78185. }
  78186. break;
  78187. };
  78188. #endif
  78189. #ifndef SQLITE_OMIT_PRAGMA
  78190. /* Opcode: JournalMode P1 P2 P3 * *
  78191. **
  78192. ** Change the journal mode of database P1 to P3. P3 must be one of the
  78193. ** PAGER_JOURNALMODE_XXX values. If changing between the various rollback
  78194. ** modes (delete, truncate, persist, off and memory), this is a simple
  78195. ** operation. No IO is required.
  78196. **
  78197. ** If changing into or out of WAL mode the procedure is more complicated.
  78198. **
  78199. ** Write a string containing the final journal-mode to register P2.
  78200. */
  78201. case OP_JournalMode: { /* out2 */
  78202. Btree *pBt; /* Btree to change journal mode of */
  78203. Pager *pPager; /* Pager associated with pBt */
  78204. int eNew; /* New journal mode */
  78205. int eOld; /* The old journal mode */
  78206. #ifndef SQLITE_OMIT_WAL
  78207. const char *zFilename; /* Name of database file for pPager */
  78208. #endif
  78209. pOut = out2Prerelease(p, pOp);
  78210. eNew = pOp->p3;
  78211. assert( eNew==PAGER_JOURNALMODE_DELETE
  78212. || eNew==PAGER_JOURNALMODE_TRUNCATE
  78213. || eNew==PAGER_JOURNALMODE_PERSIST
  78214. || eNew==PAGER_JOURNALMODE_OFF
  78215. || eNew==PAGER_JOURNALMODE_MEMORY
  78216. || eNew==PAGER_JOURNALMODE_WAL
  78217. || eNew==PAGER_JOURNALMODE_QUERY
  78218. );
  78219. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  78220. assert( p->readOnly==0 );
  78221. pBt = db->aDb[pOp->p1].pBt;
  78222. pPager = sqlite3BtreePager(pBt);
  78223. eOld = sqlite3PagerGetJournalMode(pPager);
  78224. if( eNew==PAGER_JOURNALMODE_QUERY ) eNew = eOld;
  78225. if( !sqlite3PagerOkToChangeJournalMode(pPager) ) eNew = eOld;
  78226. #ifndef SQLITE_OMIT_WAL
  78227. zFilename = sqlite3PagerFilename(pPager, 1);
  78228. /* Do not allow a transition to journal_mode=WAL for a database
  78229. ** in temporary storage or if the VFS does not support shared memory
  78230. */
  78231. if( eNew==PAGER_JOURNALMODE_WAL
  78232. && (sqlite3Strlen30(zFilename)==0 /* Temp file */
  78233. || !sqlite3PagerWalSupported(pPager)) /* No shared-memory support */
  78234. ){
  78235. eNew = eOld;
  78236. }
  78237. if( (eNew!=eOld)
  78238. && (eOld==PAGER_JOURNALMODE_WAL || eNew==PAGER_JOURNALMODE_WAL)
  78239. ){
  78240. if( !db->autoCommit || db->nVdbeRead>1 ){
  78241. rc = SQLITE_ERROR;
  78242. sqlite3VdbeError(p,
  78243. "cannot change %s wal mode from within a transaction",
  78244. (eNew==PAGER_JOURNALMODE_WAL ? "into" : "out of")
  78245. );
  78246. goto abort_due_to_error;
  78247. }else{
  78248. if( eOld==PAGER_JOURNALMODE_WAL ){
  78249. /* If leaving WAL mode, close the log file. If successful, the call
  78250. ** to PagerCloseWal() checkpoints and deletes the write-ahead-log
  78251. ** file. An EXCLUSIVE lock may still be held on the database file
  78252. ** after a successful return.
  78253. */
  78254. rc = sqlite3PagerCloseWal(pPager);
  78255. if( rc==SQLITE_OK ){
  78256. sqlite3PagerSetJournalMode(pPager, eNew);
  78257. }
  78258. }else if( eOld==PAGER_JOURNALMODE_MEMORY ){
  78259. /* Cannot transition directly from MEMORY to WAL. Use mode OFF
  78260. ** as an intermediate */
  78261. sqlite3PagerSetJournalMode(pPager, PAGER_JOURNALMODE_OFF);
  78262. }
  78263. /* Open a transaction on the database file. Regardless of the journal
  78264. ** mode, this transaction always uses a rollback journal.
  78265. */
  78266. assert( sqlite3BtreeIsInTrans(pBt)==0 );
  78267. if( rc==SQLITE_OK ){
  78268. rc = sqlite3BtreeSetVersion(pBt, (eNew==PAGER_JOURNALMODE_WAL ? 2 : 1));
  78269. }
  78270. }
  78271. }
  78272. #endif /* ifndef SQLITE_OMIT_WAL */
  78273. if( rc ) eNew = eOld;
  78274. eNew = sqlite3PagerSetJournalMode(pPager, eNew);
  78275. pOut->flags = MEM_Str|MEM_Static|MEM_Term;
  78276. pOut->z = (char *)sqlite3JournalModename(eNew);
  78277. pOut->n = sqlite3Strlen30(pOut->z);
  78278. pOut->enc = SQLITE_UTF8;
  78279. sqlite3VdbeChangeEncoding(pOut, encoding);
  78280. if( rc ) goto abort_due_to_error;
  78281. break;
  78282. };
  78283. #endif /* SQLITE_OMIT_PRAGMA */
  78284. #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
  78285. /* Opcode: Vacuum P1 * * * *
  78286. **
  78287. ** Vacuum the entire database P1. P1 is 0 for "main", and 2 or more
  78288. ** for an attached database. The "temp" database may not be vacuumed.
  78289. */
  78290. case OP_Vacuum: {
  78291. assert( p->readOnly==0 );
  78292. rc = sqlite3RunVacuum(&p->zErrMsg, db, pOp->p1);
  78293. if( rc ) goto abort_due_to_error;
  78294. break;
  78295. }
  78296. #endif
  78297. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  78298. /* Opcode: IncrVacuum P1 P2 * * *
  78299. **
  78300. ** Perform a single step of the incremental vacuum procedure on
  78301. ** the P1 database. If the vacuum has finished, jump to instruction
  78302. ** P2. Otherwise, fall through to the next instruction.
  78303. */
  78304. case OP_IncrVacuum: { /* jump */
  78305. Btree *pBt;
  78306. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  78307. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  78308. assert( p->readOnly==0 );
  78309. pBt = db->aDb[pOp->p1].pBt;
  78310. rc = sqlite3BtreeIncrVacuum(pBt);
  78311. VdbeBranchTaken(rc==SQLITE_DONE,2);
  78312. if( rc ){
  78313. if( rc!=SQLITE_DONE ) goto abort_due_to_error;
  78314. rc = SQLITE_OK;
  78315. goto jump_to_p2;
  78316. }
  78317. break;
  78318. }
  78319. #endif
  78320. /* Opcode: Expire P1 * * * *
  78321. **
  78322. ** Cause precompiled statements to expire. When an expired statement
  78323. ** is executed using sqlite3_step() it will either automatically
  78324. ** reprepare itself (if it was originally created using sqlite3_prepare_v2())
  78325. ** or it will fail with SQLITE_SCHEMA.
  78326. **
  78327. ** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
  78328. ** then only the currently executing statement is expired.
  78329. */
  78330. case OP_Expire: {
  78331. if( !pOp->p1 ){
  78332. sqlite3ExpirePreparedStatements(db);
  78333. }else{
  78334. p->expired = 1;
  78335. }
  78336. break;
  78337. }
  78338. #ifndef SQLITE_OMIT_SHARED_CACHE
  78339. /* Opcode: TableLock P1 P2 P3 P4 *
  78340. ** Synopsis: iDb=P1 root=P2 write=P3
  78341. **
  78342. ** Obtain a lock on a particular table. This instruction is only used when
  78343. ** the shared-cache feature is enabled.
  78344. **
  78345. ** P1 is the index of the database in sqlite3.aDb[] of the database
  78346. ** on which the lock is acquired. A readlock is obtained if P3==0 or
  78347. ** a write lock if P3==1.
  78348. **
  78349. ** P2 contains the root-page of the table to lock.
  78350. **
  78351. ** P4 contains a pointer to the name of the table being locked. This is only
  78352. ** used to generate an error message if the lock cannot be obtained.
  78353. */
  78354. case OP_TableLock: {
  78355. u8 isWriteLock = (u8)pOp->p3;
  78356. if( isWriteLock || 0==(db->flags&SQLITE_ReadUncommitted) ){
  78357. int p1 = pOp->p1;
  78358. assert( p1>=0 && p1<db->nDb );
  78359. assert( DbMaskTest(p->btreeMask, p1) );
  78360. assert( isWriteLock==0 || isWriteLock==1 );
  78361. rc = sqlite3BtreeLockTable(db->aDb[p1].pBt, pOp->p2, isWriteLock);
  78362. if( rc ){
  78363. if( (rc&0xFF)==SQLITE_LOCKED ){
  78364. const char *z = pOp->p4.z;
  78365. sqlite3VdbeError(p, "database table is locked: %s", z);
  78366. }
  78367. goto abort_due_to_error;
  78368. }
  78369. }
  78370. break;
  78371. }
  78372. #endif /* SQLITE_OMIT_SHARED_CACHE */
  78373. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78374. /* Opcode: VBegin * * * P4 *
  78375. **
  78376. ** P4 may be a pointer to an sqlite3_vtab structure. If so, call the
  78377. ** xBegin method for that table.
  78378. **
  78379. ** Also, whether or not P4 is set, check that this is not being called from
  78380. ** within a callback to a virtual table xSync() method. If it is, the error
  78381. ** code will be set to SQLITE_LOCKED.
  78382. */
  78383. case OP_VBegin: {
  78384. VTable *pVTab;
  78385. pVTab = pOp->p4.pVtab;
  78386. rc = sqlite3VtabBegin(db, pVTab);
  78387. if( pVTab ) sqlite3VtabImportErrmsg(p, pVTab->pVtab);
  78388. if( rc ) goto abort_due_to_error;
  78389. break;
  78390. }
  78391. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78392. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78393. /* Opcode: VCreate P1 P2 * * *
  78394. **
  78395. ** P2 is a register that holds the name of a virtual table in database
  78396. ** P1. Call the xCreate method for that table.
  78397. */
  78398. case OP_VCreate: {
  78399. Mem sMem; /* For storing the record being decoded */
  78400. const char *zTab; /* Name of the virtual table */
  78401. memset(&sMem, 0, sizeof(sMem));
  78402. sMem.db = db;
  78403. /* Because P2 is always a static string, it is impossible for the
  78404. ** sqlite3VdbeMemCopy() to fail */
  78405. assert( (aMem[pOp->p2].flags & MEM_Str)!=0 );
  78406. assert( (aMem[pOp->p2].flags & MEM_Static)!=0 );
  78407. rc = sqlite3VdbeMemCopy(&sMem, &aMem[pOp->p2]);
  78408. assert( rc==SQLITE_OK );
  78409. zTab = (const char*)sqlite3_value_text(&sMem);
  78410. assert( zTab || db->mallocFailed );
  78411. if( zTab ){
  78412. rc = sqlite3VtabCallCreate(db, pOp->p1, zTab, &p->zErrMsg);
  78413. }
  78414. sqlite3VdbeMemRelease(&sMem);
  78415. if( rc ) goto abort_due_to_error;
  78416. break;
  78417. }
  78418. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78419. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78420. /* Opcode: VDestroy P1 * * P4 *
  78421. **
  78422. ** P4 is the name of a virtual table in database P1. Call the xDestroy method
  78423. ** of that table.
  78424. */
  78425. case OP_VDestroy: {
  78426. db->nVDestroy++;
  78427. rc = sqlite3VtabCallDestroy(db, pOp->p1, pOp->p4.z);
  78428. db->nVDestroy--;
  78429. if( rc ) goto abort_due_to_error;
  78430. break;
  78431. }
  78432. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78433. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78434. /* Opcode: VOpen P1 * * P4 *
  78435. **
  78436. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  78437. ** P1 is a cursor number. This opcode opens a cursor to the virtual
  78438. ** table and stores that cursor in P1.
  78439. */
  78440. case OP_VOpen: {
  78441. VdbeCursor *pCur;
  78442. sqlite3_vtab_cursor *pVCur;
  78443. sqlite3_vtab *pVtab;
  78444. const sqlite3_module *pModule;
  78445. assert( p->bIsReader );
  78446. pCur = 0;
  78447. pVCur = 0;
  78448. pVtab = pOp->p4.pVtab->pVtab;
  78449. if( pVtab==0 || NEVER(pVtab->pModule==0) ){
  78450. rc = SQLITE_LOCKED;
  78451. goto abort_due_to_error;
  78452. }
  78453. pModule = pVtab->pModule;
  78454. rc = pModule->xOpen(pVtab, &pVCur);
  78455. sqlite3VtabImportErrmsg(p, pVtab);
  78456. if( rc ) goto abort_due_to_error;
  78457. /* Initialize sqlite3_vtab_cursor base class */
  78458. pVCur->pVtab = pVtab;
  78459. /* Initialize vdbe cursor object */
  78460. pCur = allocateCursor(p, pOp->p1, 0, -1, CURTYPE_VTAB);
  78461. if( pCur ){
  78462. pCur->uc.pVCur = pVCur;
  78463. pVtab->nRef++;
  78464. }else{
  78465. assert( db->mallocFailed );
  78466. pModule->xClose(pVCur);
  78467. goto no_mem;
  78468. }
  78469. break;
  78470. }
  78471. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78472. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78473. /* Opcode: VFilter P1 P2 P3 P4 *
  78474. ** Synopsis: iplan=r[P3] zplan='P4'
  78475. **
  78476. ** P1 is a cursor opened using VOpen. P2 is an address to jump to if
  78477. ** the filtered result set is empty.
  78478. **
  78479. ** P4 is either NULL or a string that was generated by the xBestIndex
  78480. ** method of the module. The interpretation of the P4 string is left
  78481. ** to the module implementation.
  78482. **
  78483. ** This opcode invokes the xFilter method on the virtual table specified
  78484. ** by P1. The integer query plan parameter to xFilter is stored in register
  78485. ** P3. Register P3+1 stores the argc parameter to be passed to the
  78486. ** xFilter method. Registers P3+2..P3+1+argc are the argc
  78487. ** additional parameters which are passed to
  78488. ** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
  78489. **
  78490. ** A jump is made to P2 if the result set after filtering would be empty.
  78491. */
  78492. case OP_VFilter: { /* jump */
  78493. int nArg;
  78494. int iQuery;
  78495. const sqlite3_module *pModule;
  78496. Mem *pQuery;
  78497. Mem *pArgc;
  78498. sqlite3_vtab_cursor *pVCur;
  78499. sqlite3_vtab *pVtab;
  78500. VdbeCursor *pCur;
  78501. int res;
  78502. int i;
  78503. Mem **apArg;
  78504. pQuery = &aMem[pOp->p3];
  78505. pArgc = &pQuery[1];
  78506. pCur = p->apCsr[pOp->p1];
  78507. assert( memIsValid(pQuery) );
  78508. REGISTER_TRACE(pOp->p3, pQuery);
  78509. assert( pCur->eCurType==CURTYPE_VTAB );
  78510. pVCur = pCur->uc.pVCur;
  78511. pVtab = pVCur->pVtab;
  78512. pModule = pVtab->pModule;
  78513. /* Grab the index number and argc parameters */
  78514. assert( (pQuery->flags&MEM_Int)!=0 && pArgc->flags==MEM_Int );
  78515. nArg = (int)pArgc->u.i;
  78516. iQuery = (int)pQuery->u.i;
  78517. /* Invoke the xFilter method */
  78518. res = 0;
  78519. apArg = p->apArg;
  78520. for(i = 0; i<nArg; i++){
  78521. apArg[i] = &pArgc[i+1];
  78522. }
  78523. rc = pModule->xFilter(pVCur, iQuery, pOp->p4.z, nArg, apArg);
  78524. sqlite3VtabImportErrmsg(p, pVtab);
  78525. if( rc ) goto abort_due_to_error;
  78526. res = pModule->xEof(pVCur);
  78527. pCur->nullRow = 0;
  78528. VdbeBranchTaken(res!=0,2);
  78529. if( res ) goto jump_to_p2;
  78530. break;
  78531. }
  78532. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78533. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78534. /* Opcode: VColumn P1 P2 P3 * *
  78535. ** Synopsis: r[P3]=vcolumn(P2)
  78536. **
  78537. ** Store the value of the P2-th column of
  78538. ** the row of the virtual-table that the
  78539. ** P1 cursor is pointing to into register P3.
  78540. */
  78541. case OP_VColumn: {
  78542. sqlite3_vtab *pVtab;
  78543. const sqlite3_module *pModule;
  78544. Mem *pDest;
  78545. sqlite3_context sContext;
  78546. VdbeCursor *pCur = p->apCsr[pOp->p1];
  78547. assert( pCur->eCurType==CURTYPE_VTAB );
  78548. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  78549. pDest = &aMem[pOp->p3];
  78550. memAboutToChange(p, pDest);
  78551. if( pCur->nullRow ){
  78552. sqlite3VdbeMemSetNull(pDest);
  78553. break;
  78554. }
  78555. pVtab = pCur->uc.pVCur->pVtab;
  78556. pModule = pVtab->pModule;
  78557. assert( pModule->xColumn );
  78558. memset(&sContext, 0, sizeof(sContext));
  78559. sContext.pOut = pDest;
  78560. MemSetTypeFlag(pDest, MEM_Null);
  78561. rc = pModule->xColumn(pCur->uc.pVCur, &sContext, pOp->p2);
  78562. sqlite3VtabImportErrmsg(p, pVtab);
  78563. if( sContext.isError ){
  78564. rc = sContext.isError;
  78565. }
  78566. sqlite3VdbeChangeEncoding(pDest, encoding);
  78567. REGISTER_TRACE(pOp->p3, pDest);
  78568. UPDATE_MAX_BLOBSIZE(pDest);
  78569. if( sqlite3VdbeMemTooBig(pDest) ){
  78570. goto too_big;
  78571. }
  78572. if( rc ) goto abort_due_to_error;
  78573. break;
  78574. }
  78575. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78576. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78577. /* Opcode: VNext P1 P2 * * *
  78578. **
  78579. ** Advance virtual table P1 to the next row in its result set and
  78580. ** jump to instruction P2. Or, if the virtual table has reached
  78581. ** the end of its result set, then fall through to the next instruction.
  78582. */
  78583. case OP_VNext: { /* jump */
  78584. sqlite3_vtab *pVtab;
  78585. const sqlite3_module *pModule;
  78586. int res;
  78587. VdbeCursor *pCur;
  78588. res = 0;
  78589. pCur = p->apCsr[pOp->p1];
  78590. assert( pCur->eCurType==CURTYPE_VTAB );
  78591. if( pCur->nullRow ){
  78592. break;
  78593. }
  78594. pVtab = pCur->uc.pVCur->pVtab;
  78595. pModule = pVtab->pModule;
  78596. assert( pModule->xNext );
  78597. /* Invoke the xNext() method of the module. There is no way for the
  78598. ** underlying implementation to return an error if one occurs during
  78599. ** xNext(). Instead, if an error occurs, true is returned (indicating that
  78600. ** data is available) and the error code returned when xColumn or
  78601. ** some other method is next invoked on the save virtual table cursor.
  78602. */
  78603. rc = pModule->xNext(pCur->uc.pVCur);
  78604. sqlite3VtabImportErrmsg(p, pVtab);
  78605. if( rc ) goto abort_due_to_error;
  78606. res = pModule->xEof(pCur->uc.pVCur);
  78607. VdbeBranchTaken(!res,2);
  78608. if( !res ){
  78609. /* If there is data, jump to P2 */
  78610. goto jump_to_p2_and_check_for_interrupt;
  78611. }
  78612. goto check_for_interrupt;
  78613. }
  78614. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78615. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78616. /* Opcode: VRename P1 * * P4 *
  78617. **
  78618. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  78619. ** This opcode invokes the corresponding xRename method. The value
  78620. ** in register P1 is passed as the zName argument to the xRename method.
  78621. */
  78622. case OP_VRename: {
  78623. sqlite3_vtab *pVtab;
  78624. Mem *pName;
  78625. pVtab = pOp->p4.pVtab->pVtab;
  78626. pName = &aMem[pOp->p1];
  78627. assert( pVtab->pModule->xRename );
  78628. assert( memIsValid(pName) );
  78629. assert( p->readOnly==0 );
  78630. REGISTER_TRACE(pOp->p1, pName);
  78631. assert( pName->flags & MEM_Str );
  78632. testcase( pName->enc==SQLITE_UTF8 );
  78633. testcase( pName->enc==SQLITE_UTF16BE );
  78634. testcase( pName->enc==SQLITE_UTF16LE );
  78635. rc = sqlite3VdbeChangeEncoding(pName, SQLITE_UTF8);
  78636. if( rc ) goto abort_due_to_error;
  78637. rc = pVtab->pModule->xRename(pVtab, pName->z);
  78638. sqlite3VtabImportErrmsg(p, pVtab);
  78639. p->expired = 0;
  78640. if( rc ) goto abort_due_to_error;
  78641. break;
  78642. }
  78643. #endif
  78644. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78645. /* Opcode: VUpdate P1 P2 P3 P4 P5
  78646. ** Synopsis: data=r[P3@P2]
  78647. **
  78648. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  78649. ** This opcode invokes the corresponding xUpdate method. P2 values
  78650. ** are contiguous memory cells starting at P3 to pass to the xUpdate
  78651. ** invocation. The value in register (P3+P2-1) corresponds to the
  78652. ** p2th element of the argv array passed to xUpdate.
  78653. **
  78654. ** The xUpdate method will do a DELETE or an INSERT or both.
  78655. ** The argv[0] element (which corresponds to memory cell P3)
  78656. ** is the rowid of a row to delete. If argv[0] is NULL then no
  78657. ** deletion occurs. The argv[1] element is the rowid of the new
  78658. ** row. This can be NULL to have the virtual table select the new
  78659. ** rowid for itself. The subsequent elements in the array are
  78660. ** the values of columns in the new row.
  78661. **
  78662. ** If P2==1 then no insert is performed. argv[0] is the rowid of
  78663. ** a row to delete.
  78664. **
  78665. ** P1 is a boolean flag. If it is set to true and the xUpdate call
  78666. ** is successful, then the value returned by sqlite3_last_insert_rowid()
  78667. ** is set to the value of the rowid for the row just inserted.
  78668. **
  78669. ** P5 is the error actions (OE_Replace, OE_Fail, OE_Ignore, etc) to
  78670. ** apply in the case of a constraint failure on an insert or update.
  78671. */
  78672. case OP_VUpdate: {
  78673. sqlite3_vtab *pVtab;
  78674. const sqlite3_module *pModule;
  78675. int nArg;
  78676. int i;
  78677. sqlite_int64 rowid;
  78678. Mem **apArg;
  78679. Mem *pX;
  78680. assert( pOp->p2==1 || pOp->p5==OE_Fail || pOp->p5==OE_Rollback
  78681. || pOp->p5==OE_Abort || pOp->p5==OE_Ignore || pOp->p5==OE_Replace
  78682. );
  78683. assert( p->readOnly==0 );
  78684. pVtab = pOp->p4.pVtab->pVtab;
  78685. if( pVtab==0 || NEVER(pVtab->pModule==0) ){
  78686. rc = SQLITE_LOCKED;
  78687. goto abort_due_to_error;
  78688. }
  78689. pModule = pVtab->pModule;
  78690. nArg = pOp->p2;
  78691. assert( pOp->p4type==P4_VTAB );
  78692. if( ALWAYS(pModule->xUpdate) ){
  78693. u8 vtabOnConflict = db->vtabOnConflict;
  78694. apArg = p->apArg;
  78695. pX = &aMem[pOp->p3];
  78696. for(i=0; i<nArg; i++){
  78697. assert( memIsValid(pX) );
  78698. memAboutToChange(p, pX);
  78699. apArg[i] = pX;
  78700. pX++;
  78701. }
  78702. db->vtabOnConflict = pOp->p5;
  78703. rc = pModule->xUpdate(pVtab, nArg, apArg, &rowid);
  78704. db->vtabOnConflict = vtabOnConflict;
  78705. sqlite3VtabImportErrmsg(p, pVtab);
  78706. if( rc==SQLITE_OK && pOp->p1 ){
  78707. assert( nArg>1 && apArg[0] && (apArg[0]->flags&MEM_Null) );
  78708. db->lastRowid = lastRowid = rowid;
  78709. }
  78710. if( (rc&0xff)==SQLITE_CONSTRAINT && pOp->p4.pVtab->bConstraint ){
  78711. if( pOp->p5==OE_Ignore ){
  78712. rc = SQLITE_OK;
  78713. }else{
  78714. p->errorAction = ((pOp->p5==OE_Replace) ? OE_Abort : pOp->p5);
  78715. }
  78716. }else{
  78717. p->nChange++;
  78718. }
  78719. if( rc ) goto abort_due_to_error;
  78720. }
  78721. break;
  78722. }
  78723. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  78724. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  78725. /* Opcode: Pagecount P1 P2 * * *
  78726. **
  78727. ** Write the current number of pages in database P1 to memory cell P2.
  78728. */
  78729. case OP_Pagecount: { /* out2 */
  78730. pOut = out2Prerelease(p, pOp);
  78731. pOut->u.i = sqlite3BtreeLastPage(db->aDb[pOp->p1].pBt);
  78732. break;
  78733. }
  78734. #endif
  78735. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  78736. /* Opcode: MaxPgcnt P1 P2 P3 * *
  78737. **
  78738. ** Try to set the maximum page count for database P1 to the value in P3.
  78739. ** Do not let the maximum page count fall below the current page count and
  78740. ** do not change the maximum page count value if P3==0.
  78741. **
  78742. ** Store the maximum page count after the change in register P2.
  78743. */
  78744. case OP_MaxPgcnt: { /* out2 */
  78745. unsigned int newMax;
  78746. Btree *pBt;
  78747. pOut = out2Prerelease(p, pOp);
  78748. pBt = db->aDb[pOp->p1].pBt;
  78749. newMax = 0;
  78750. if( pOp->p3 ){
  78751. newMax = sqlite3BtreeLastPage(pBt);
  78752. if( newMax < (unsigned)pOp->p3 ) newMax = (unsigned)pOp->p3;
  78753. }
  78754. pOut->u.i = sqlite3BtreeMaxPageCount(pBt, newMax);
  78755. break;
  78756. }
  78757. #endif
  78758. /* Opcode: Init P1 P2 * P4 *
  78759. ** Synopsis: Start at P2
  78760. **
  78761. ** Programs contain a single instance of this opcode as the very first
  78762. ** opcode.
  78763. **
  78764. ** If tracing is enabled (by the sqlite3_trace()) interface, then
  78765. ** the UTF-8 string contained in P4 is emitted on the trace callback.
  78766. ** Or if P4 is blank, use the string returned by sqlite3_sql().
  78767. **
  78768. ** If P2 is not zero, jump to instruction P2.
  78769. **
  78770. ** Increment the value of P1 so that OP_Once opcodes will jump the
  78771. ** first time they are evaluated for this run.
  78772. */
  78773. case OP_Init: { /* jump */
  78774. char *zTrace;
  78775. int i;
  78776. /* If the P4 argument is not NULL, then it must be an SQL comment string.
  78777. ** The "--" string is broken up to prevent false-positives with srcck1.c.
  78778. **
  78779. ** This assert() provides evidence for:
  78780. ** EVIDENCE-OF: R-50676-09860 The callback can compute the same text that
  78781. ** would have been returned by the legacy sqlite3_trace() interface by
  78782. ** using the X argument when X begins with "--" and invoking
  78783. ** sqlite3_expanded_sql(P) otherwise.
  78784. */
  78785. assert( pOp->p4.z==0 || strncmp(pOp->p4.z, "-" "- ", 3)==0 );
  78786. assert( pOp==p->aOp ); /* Always instruction 0 */
  78787. #ifndef SQLITE_OMIT_TRACE
  78788. if( (db->mTrace & (SQLITE_TRACE_STMT|SQLITE_TRACE_LEGACY))!=0
  78789. && !p->doingRerun
  78790. && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
  78791. ){
  78792. #ifndef SQLITE_OMIT_DEPRECATED
  78793. if( db->mTrace & SQLITE_TRACE_LEGACY ){
  78794. void (*x)(void*,const char*) = (void(*)(void*,const char*))db->xTrace;
  78795. char *z = sqlite3VdbeExpandSql(p, zTrace);
  78796. x(db->pTraceArg, z);
  78797. sqlite3_free(z);
  78798. }else
  78799. #endif
  78800. {
  78801. (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, zTrace);
  78802. }
  78803. }
  78804. #ifdef SQLITE_USE_FCNTL_TRACE
  78805. zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql);
  78806. if( zTrace ){
  78807. int j;
  78808. for(j=0; j<db->nDb; j++){
  78809. if( DbMaskTest(p->btreeMask, j)==0 ) continue;
  78810. sqlite3_file_control(db, db->aDb[j].zDbSName, SQLITE_FCNTL_TRACE, zTrace);
  78811. }
  78812. }
  78813. #endif /* SQLITE_USE_FCNTL_TRACE */
  78814. #ifdef SQLITE_DEBUG
  78815. if( (db->flags & SQLITE_SqlTrace)!=0
  78816. && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
  78817. ){
  78818. sqlite3DebugPrintf("SQL-trace: %s\n", zTrace);
  78819. }
  78820. #endif /* SQLITE_DEBUG */
  78821. #endif /* SQLITE_OMIT_TRACE */
  78822. assert( pOp->p2>0 );
  78823. if( pOp->p1>=sqlite3GlobalConfig.iOnceResetThreshold ){
  78824. for(i=1; i<p->nOp; i++){
  78825. if( p->aOp[i].opcode==OP_Once ) p->aOp[i].p1 = 0;
  78826. }
  78827. pOp->p1 = 0;
  78828. }
  78829. pOp->p1++;
  78830. goto jump_to_p2;
  78831. }
  78832. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  78833. /* Opcode: CursorHint P1 * * P4 *
  78834. **
  78835. ** Provide a hint to cursor P1 that it only needs to return rows that
  78836. ** satisfy the Expr in P4. TK_REGISTER terms in the P4 expression refer
  78837. ** to values currently held in registers. TK_COLUMN terms in the P4
  78838. ** expression refer to columns in the b-tree to which cursor P1 is pointing.
  78839. */
  78840. case OP_CursorHint: {
  78841. VdbeCursor *pC;
  78842. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  78843. assert( pOp->p4type==P4_EXPR );
  78844. pC = p->apCsr[pOp->p1];
  78845. if( pC ){
  78846. assert( pC->eCurType==CURTYPE_BTREE );
  78847. sqlite3BtreeCursorHint(pC->uc.pCursor, BTREE_HINT_RANGE,
  78848. pOp->p4.pExpr, aMem);
  78849. }
  78850. break;
  78851. }
  78852. #endif /* SQLITE_ENABLE_CURSOR_HINTS */
  78853. /* Opcode: Noop * * * * *
  78854. **
  78855. ** Do nothing. This instruction is often useful as a jump
  78856. ** destination.
  78857. */
  78858. /*
  78859. ** The magic Explain opcode are only inserted when explain==2 (which
  78860. ** is to say when the EXPLAIN QUERY PLAN syntax is used.)
  78861. ** This opcode records information from the optimizer. It is the
  78862. ** the same as a no-op. This opcodesnever appears in a real VM program.
  78863. */
  78864. default: { /* This is really OP_Noop and OP_Explain */
  78865. assert( pOp->opcode==OP_Noop || pOp->opcode==OP_Explain );
  78866. break;
  78867. }
  78868. /*****************************************************************************
  78869. ** The cases of the switch statement above this line should all be indented
  78870. ** by 6 spaces. But the left-most 6 spaces have been removed to improve the
  78871. ** readability. From this point on down, the normal indentation rules are
  78872. ** restored.
  78873. *****************************************************************************/
  78874. }
  78875. #ifdef VDBE_PROFILE
  78876. {
  78877. u64 endTime = sqlite3Hwtime();
  78878. if( endTime>start ) pOrigOp->cycles += endTime - start;
  78879. pOrigOp->cnt++;
  78880. }
  78881. #endif
  78882. /* The following code adds nothing to the actual functionality
  78883. ** of the program. It is only here for testing and debugging.
  78884. ** On the other hand, it does burn CPU cycles every time through
  78885. ** the evaluator loop. So we can leave it out when NDEBUG is defined.
  78886. */
  78887. #ifndef NDEBUG
  78888. assert( pOp>=&aOp[-1] && pOp<&aOp[p->nOp-1] );
  78889. #ifdef SQLITE_DEBUG
  78890. if( db->flags & SQLITE_VdbeTrace ){
  78891. u8 opProperty = sqlite3OpcodeProperty[pOrigOp->opcode];
  78892. if( rc!=0 ) printf("rc=%d\n",rc);
  78893. if( opProperty & (OPFLG_OUT2) ){
  78894. registerTrace(pOrigOp->p2, &aMem[pOrigOp->p2]);
  78895. }
  78896. if( opProperty & OPFLG_OUT3 ){
  78897. registerTrace(pOrigOp->p3, &aMem[pOrigOp->p3]);
  78898. }
  78899. }
  78900. #endif /* SQLITE_DEBUG */
  78901. #endif /* NDEBUG */
  78902. } /* The end of the for(;;) loop the loops through opcodes */
  78903. /* If we reach this point, it means that execution is finished with
  78904. ** an error of some kind.
  78905. */
  78906. abort_due_to_error:
  78907. if( db->mallocFailed ) rc = SQLITE_NOMEM_BKPT;
  78908. assert( rc );
  78909. if( p->zErrMsg==0 && rc!=SQLITE_IOERR_NOMEM ){
  78910. sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
  78911. }
  78912. p->rc = rc;
  78913. sqlite3SystemError(db, rc);
  78914. testcase( sqlite3GlobalConfig.xLog!=0 );
  78915. sqlite3_log(rc, "statement aborts at %d: [%s] %s",
  78916. (int)(pOp - aOp), p->zSql, p->zErrMsg);
  78917. sqlite3VdbeHalt(p);
  78918. if( rc==SQLITE_IOERR_NOMEM ) sqlite3OomFault(db);
  78919. rc = SQLITE_ERROR;
  78920. if( resetSchemaOnFault>0 ){
  78921. sqlite3ResetOneSchema(db, resetSchemaOnFault-1);
  78922. }
  78923. /* This is the only way out of this procedure. We have to
  78924. ** release the mutexes on btrees that were acquired at the
  78925. ** top. */
  78926. vdbe_return:
  78927. db->lastRowid = lastRowid;
  78928. testcase( nVmStep>0 );
  78929. p->aCounter[SQLITE_STMTSTATUS_VM_STEP] += (int)nVmStep;
  78930. sqlite3VdbeLeave(p);
  78931. assert( rc!=SQLITE_OK || nExtraDelete==0
  78932. || sqlite3_strlike("DELETE%",p->zSql,0)!=0
  78933. );
  78934. return rc;
  78935. /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
  78936. ** is encountered.
  78937. */
  78938. too_big:
  78939. sqlite3VdbeError(p, "string or blob too big");
  78940. rc = SQLITE_TOOBIG;
  78941. goto abort_due_to_error;
  78942. /* Jump to here if a malloc() fails.
  78943. */
  78944. no_mem:
  78945. sqlite3OomFault(db);
  78946. sqlite3VdbeError(p, "out of memory");
  78947. rc = SQLITE_NOMEM_BKPT;
  78948. goto abort_due_to_error;
  78949. /* Jump to here if the sqlite3_interrupt() API sets the interrupt
  78950. ** flag.
  78951. */
  78952. abort_due_to_interrupt:
  78953. assert( db->u1.isInterrupted );
  78954. rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_INTERRUPT;
  78955. p->rc = rc;
  78956. sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
  78957. goto abort_due_to_error;
  78958. }
  78959. /************** End of vdbe.c ************************************************/
  78960. /************** Begin file vdbeblob.c ****************************************/
  78961. /*
  78962. ** 2007 May 1
  78963. **
  78964. ** The author disclaims copyright to this source code. In place of
  78965. ** a legal notice, here is a blessing:
  78966. **
  78967. ** May you do good and not evil.
  78968. ** May you find forgiveness for yourself and forgive others.
  78969. ** May you share freely, never taking more than you give.
  78970. **
  78971. *************************************************************************
  78972. **
  78973. ** This file contains code used to implement incremental BLOB I/O.
  78974. */
  78975. /* #include "sqliteInt.h" */
  78976. /* #include "vdbeInt.h" */
  78977. #ifndef SQLITE_OMIT_INCRBLOB
  78978. /*
  78979. ** Valid sqlite3_blob* handles point to Incrblob structures.
  78980. */
  78981. typedef struct Incrblob Incrblob;
  78982. struct Incrblob {
  78983. int flags; /* Copy of "flags" passed to sqlite3_blob_open() */
  78984. int nByte; /* Size of open blob, in bytes */
  78985. int iOffset; /* Byte offset of blob in cursor data */
  78986. int iCol; /* Table column this handle is open on */
  78987. BtCursor *pCsr; /* Cursor pointing at blob row */
  78988. sqlite3_stmt *pStmt; /* Statement holding cursor open */
  78989. sqlite3 *db; /* The associated database */
  78990. char *zDb; /* Database name */
  78991. Table *pTab; /* Table object */
  78992. };
  78993. /*
  78994. ** This function is used by both blob_open() and blob_reopen(). It seeks
  78995. ** the b-tree cursor associated with blob handle p to point to row iRow.
  78996. ** If successful, SQLITE_OK is returned and subsequent calls to
  78997. ** sqlite3_blob_read() or sqlite3_blob_write() access the specified row.
  78998. **
  78999. ** If an error occurs, or if the specified row does not exist or does not
  79000. ** contain a value of type TEXT or BLOB in the column nominated when the
  79001. ** blob handle was opened, then an error code is returned and *pzErr may
  79002. ** be set to point to a buffer containing an error message. It is the
  79003. ** responsibility of the caller to free the error message buffer using
  79004. ** sqlite3DbFree().
  79005. **
  79006. ** If an error does occur, then the b-tree cursor is closed. All subsequent
  79007. ** calls to sqlite3_blob_read(), blob_write() or blob_reopen() will
  79008. ** immediately return SQLITE_ABORT.
  79009. */
  79010. static int blobSeekToRow(Incrblob *p, sqlite3_int64 iRow, char **pzErr){
  79011. int rc; /* Error code */
  79012. char *zErr = 0; /* Error message */
  79013. Vdbe *v = (Vdbe *)p->pStmt;
  79014. /* Set the value of the SQL statements only variable to integer iRow.
  79015. ** This is done directly instead of using sqlite3_bind_int64() to avoid
  79016. ** triggering asserts related to mutexes.
  79017. */
  79018. assert( v->aVar[0].flags&MEM_Int );
  79019. v->aVar[0].u.i = iRow;
  79020. rc = sqlite3_step(p->pStmt);
  79021. if( rc==SQLITE_ROW ){
  79022. VdbeCursor *pC = v->apCsr[0];
  79023. u32 type = pC->aType[p->iCol];
  79024. if( type<12 ){
  79025. zErr = sqlite3MPrintf(p->db, "cannot open value of type %s",
  79026. type==0?"null": type==7?"real": "integer"
  79027. );
  79028. rc = SQLITE_ERROR;
  79029. sqlite3_finalize(p->pStmt);
  79030. p->pStmt = 0;
  79031. }else{
  79032. p->iOffset = pC->aType[p->iCol + pC->nField];
  79033. p->nByte = sqlite3VdbeSerialTypeLen(type);
  79034. p->pCsr = pC->uc.pCursor;
  79035. sqlite3BtreeIncrblobCursor(p->pCsr);
  79036. }
  79037. }
  79038. if( rc==SQLITE_ROW ){
  79039. rc = SQLITE_OK;
  79040. }else if( p->pStmt ){
  79041. rc = sqlite3_finalize(p->pStmt);
  79042. p->pStmt = 0;
  79043. if( rc==SQLITE_OK ){
  79044. zErr = sqlite3MPrintf(p->db, "no such rowid: %lld", iRow);
  79045. rc = SQLITE_ERROR;
  79046. }else{
  79047. zErr = sqlite3MPrintf(p->db, "%s", sqlite3_errmsg(p->db));
  79048. }
  79049. }
  79050. assert( rc!=SQLITE_OK || zErr==0 );
  79051. assert( rc!=SQLITE_ROW && rc!=SQLITE_DONE );
  79052. *pzErr = zErr;
  79053. return rc;
  79054. }
  79055. /*
  79056. ** Open a blob handle.
  79057. */
  79058. SQLITE_API int sqlite3_blob_open(
  79059. sqlite3* db, /* The database connection */
  79060. const char *zDb, /* The attached database containing the blob */
  79061. const char *zTable, /* The table containing the blob */
  79062. const char *zColumn, /* The column containing the blob */
  79063. sqlite_int64 iRow, /* The row containing the glob */
  79064. int flags, /* True -> read/write access, false -> read-only */
  79065. sqlite3_blob **ppBlob /* Handle for accessing the blob returned here */
  79066. ){
  79067. int nAttempt = 0;
  79068. int iCol; /* Index of zColumn in row-record */
  79069. int rc = SQLITE_OK;
  79070. char *zErr = 0;
  79071. Table *pTab;
  79072. Parse *pParse = 0;
  79073. Incrblob *pBlob = 0;
  79074. #ifdef SQLITE_ENABLE_API_ARMOR
  79075. if( ppBlob==0 ){
  79076. return SQLITE_MISUSE_BKPT;
  79077. }
  79078. #endif
  79079. *ppBlob = 0;
  79080. #ifdef SQLITE_ENABLE_API_ARMOR
  79081. if( !sqlite3SafetyCheckOk(db) || zTable==0 ){
  79082. return SQLITE_MISUSE_BKPT;
  79083. }
  79084. #endif
  79085. flags = !!flags; /* flags = (flags ? 1 : 0); */
  79086. sqlite3_mutex_enter(db->mutex);
  79087. pBlob = (Incrblob *)sqlite3DbMallocZero(db, sizeof(Incrblob));
  79088. if( !pBlob ) goto blob_open_out;
  79089. pParse = sqlite3StackAllocRaw(db, sizeof(*pParse));
  79090. if( !pParse ) goto blob_open_out;
  79091. do {
  79092. memset(pParse, 0, sizeof(Parse));
  79093. pParse->db = db;
  79094. sqlite3DbFree(db, zErr);
  79095. zErr = 0;
  79096. sqlite3BtreeEnterAll(db);
  79097. pTab = sqlite3LocateTable(pParse, 0, zTable, zDb);
  79098. if( pTab && IsVirtual(pTab) ){
  79099. pTab = 0;
  79100. sqlite3ErrorMsg(pParse, "cannot open virtual table: %s", zTable);
  79101. }
  79102. if( pTab && !HasRowid(pTab) ){
  79103. pTab = 0;
  79104. sqlite3ErrorMsg(pParse, "cannot open table without rowid: %s", zTable);
  79105. }
  79106. #ifndef SQLITE_OMIT_VIEW
  79107. if( pTab && pTab->pSelect ){
  79108. pTab = 0;
  79109. sqlite3ErrorMsg(pParse, "cannot open view: %s", zTable);
  79110. }
  79111. #endif
  79112. if( !pTab ){
  79113. if( pParse->zErrMsg ){
  79114. sqlite3DbFree(db, zErr);
  79115. zErr = pParse->zErrMsg;
  79116. pParse->zErrMsg = 0;
  79117. }
  79118. rc = SQLITE_ERROR;
  79119. sqlite3BtreeLeaveAll(db);
  79120. goto blob_open_out;
  79121. }
  79122. pBlob->pTab = pTab;
  79123. pBlob->zDb = db->aDb[sqlite3SchemaToIndex(db, pTab->pSchema)].zDbSName;
  79124. /* Now search pTab for the exact column. */
  79125. for(iCol=0; iCol<pTab->nCol; iCol++) {
  79126. if( sqlite3StrICmp(pTab->aCol[iCol].zName, zColumn)==0 ){
  79127. break;
  79128. }
  79129. }
  79130. if( iCol==pTab->nCol ){
  79131. sqlite3DbFree(db, zErr);
  79132. zErr = sqlite3MPrintf(db, "no such column: \"%s\"", zColumn);
  79133. rc = SQLITE_ERROR;
  79134. sqlite3BtreeLeaveAll(db);
  79135. goto blob_open_out;
  79136. }
  79137. /* If the value is being opened for writing, check that the
  79138. ** column is not indexed, and that it is not part of a foreign key.
  79139. ** It is against the rules to open a column to which either of these
  79140. ** descriptions applies for writing. */
  79141. if( flags ){
  79142. const char *zFault = 0;
  79143. Index *pIdx;
  79144. #ifndef SQLITE_OMIT_FOREIGN_KEY
  79145. if( db->flags&SQLITE_ForeignKeys ){
  79146. /* Check that the column is not part of an FK child key definition. It
  79147. ** is not necessary to check if it is part of a parent key, as parent
  79148. ** key columns must be indexed. The check below will pick up this
  79149. ** case. */
  79150. FKey *pFKey;
  79151. for(pFKey=pTab->pFKey; pFKey; pFKey=pFKey->pNextFrom){
  79152. int j;
  79153. for(j=0; j<pFKey->nCol; j++){
  79154. if( pFKey->aCol[j].iFrom==iCol ){
  79155. zFault = "foreign key";
  79156. }
  79157. }
  79158. }
  79159. }
  79160. #endif
  79161. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  79162. int j;
  79163. for(j=0; j<pIdx->nKeyCol; j++){
  79164. /* FIXME: Be smarter about indexes that use expressions */
  79165. if( pIdx->aiColumn[j]==iCol || pIdx->aiColumn[j]==XN_EXPR ){
  79166. zFault = "indexed";
  79167. }
  79168. }
  79169. }
  79170. if( zFault ){
  79171. sqlite3DbFree(db, zErr);
  79172. zErr = sqlite3MPrintf(db, "cannot open %s column for writing", zFault);
  79173. rc = SQLITE_ERROR;
  79174. sqlite3BtreeLeaveAll(db);
  79175. goto blob_open_out;
  79176. }
  79177. }
  79178. pBlob->pStmt = (sqlite3_stmt *)sqlite3VdbeCreate(pParse);
  79179. assert( pBlob->pStmt || db->mallocFailed );
  79180. if( pBlob->pStmt ){
  79181. /* This VDBE program seeks a btree cursor to the identified
  79182. ** db/table/row entry. The reason for using a vdbe program instead
  79183. ** of writing code to use the b-tree layer directly is that the
  79184. ** vdbe program will take advantage of the various transaction,
  79185. ** locking and error handling infrastructure built into the vdbe.
  79186. **
  79187. ** After seeking the cursor, the vdbe executes an OP_ResultRow.
  79188. ** Code external to the Vdbe then "borrows" the b-tree cursor and
  79189. ** uses it to implement the blob_read(), blob_write() and
  79190. ** blob_bytes() functions.
  79191. **
  79192. ** The sqlite3_blob_close() function finalizes the vdbe program,
  79193. ** which closes the b-tree cursor and (possibly) commits the
  79194. ** transaction.
  79195. */
  79196. static const int iLn = VDBE_OFFSET_LINENO(2);
  79197. static const VdbeOpList openBlob[] = {
  79198. {OP_TableLock, 0, 0, 0}, /* 0: Acquire a read or write lock */
  79199. {OP_OpenRead, 0, 0, 0}, /* 1: Open a cursor */
  79200. {OP_Variable, 1, 1, 0}, /* 2: Move ?1 into reg[1] */
  79201. {OP_NotExists, 0, 7, 1}, /* 3: Seek the cursor */
  79202. {OP_Column, 0, 0, 1}, /* 4 */
  79203. {OP_ResultRow, 1, 0, 0}, /* 5 */
  79204. {OP_Goto, 0, 2, 0}, /* 6 */
  79205. {OP_Close, 0, 0, 0}, /* 7 */
  79206. {OP_Halt, 0, 0, 0}, /* 8 */
  79207. };
  79208. Vdbe *v = (Vdbe *)pBlob->pStmt;
  79209. int iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  79210. VdbeOp *aOp;
  79211. sqlite3VdbeAddOp4Int(v, OP_Transaction, iDb, flags,
  79212. pTab->pSchema->schema_cookie,
  79213. pTab->pSchema->iGeneration);
  79214. sqlite3VdbeChangeP5(v, 1);
  79215. aOp = sqlite3VdbeAddOpList(v, ArraySize(openBlob), openBlob, iLn);
  79216. /* Make sure a mutex is held on the table to be accessed */
  79217. sqlite3VdbeUsesBtree(v, iDb);
  79218. if( db->mallocFailed==0 ){
  79219. assert( aOp!=0 );
  79220. /* Configure the OP_TableLock instruction */
  79221. #ifdef SQLITE_OMIT_SHARED_CACHE
  79222. aOp[0].opcode = OP_Noop;
  79223. #else
  79224. aOp[0].p1 = iDb;
  79225. aOp[0].p2 = pTab->tnum;
  79226. aOp[0].p3 = flags;
  79227. sqlite3VdbeChangeP4(v, 1, pTab->zName, P4_TRANSIENT);
  79228. }
  79229. if( db->mallocFailed==0 ){
  79230. #endif
  79231. /* Remove either the OP_OpenWrite or OpenRead. Set the P2
  79232. ** parameter of the other to pTab->tnum. */
  79233. if( flags ) aOp[1].opcode = OP_OpenWrite;
  79234. aOp[1].p2 = pTab->tnum;
  79235. aOp[1].p3 = iDb;
  79236. /* Configure the number of columns. Configure the cursor to
  79237. ** think that the table has one more column than it really
  79238. ** does. An OP_Column to retrieve this imaginary column will
  79239. ** always return an SQL NULL. This is useful because it means
  79240. ** we can invoke OP_Column to fill in the vdbe cursors type
  79241. ** and offset cache without causing any IO.
  79242. */
  79243. aOp[1].p4type = P4_INT32;
  79244. aOp[1].p4.i = pTab->nCol+1;
  79245. aOp[4].p2 = pTab->nCol;
  79246. pParse->nVar = 1;
  79247. pParse->nMem = 1;
  79248. pParse->nTab = 1;
  79249. sqlite3VdbeMakeReady(v, pParse);
  79250. }
  79251. }
  79252. pBlob->flags = flags;
  79253. pBlob->iCol = iCol;
  79254. pBlob->db = db;
  79255. sqlite3BtreeLeaveAll(db);
  79256. if( db->mallocFailed ){
  79257. goto blob_open_out;
  79258. }
  79259. sqlite3_bind_int64(pBlob->pStmt, 1, iRow);
  79260. rc = blobSeekToRow(pBlob, iRow, &zErr);
  79261. } while( (++nAttempt)<SQLITE_MAX_SCHEMA_RETRY && rc==SQLITE_SCHEMA );
  79262. blob_open_out:
  79263. if( rc==SQLITE_OK && db->mallocFailed==0 ){
  79264. *ppBlob = (sqlite3_blob *)pBlob;
  79265. }else{
  79266. if( pBlob && pBlob->pStmt ) sqlite3VdbeFinalize((Vdbe *)pBlob->pStmt);
  79267. sqlite3DbFree(db, pBlob);
  79268. }
  79269. sqlite3ErrorWithMsg(db, rc, (zErr ? "%s" : 0), zErr);
  79270. sqlite3DbFree(db, zErr);
  79271. sqlite3ParserReset(pParse);
  79272. sqlite3StackFree(db, pParse);
  79273. rc = sqlite3ApiExit(db, rc);
  79274. sqlite3_mutex_leave(db->mutex);
  79275. return rc;
  79276. }
  79277. /*
  79278. ** Close a blob handle that was previously created using
  79279. ** sqlite3_blob_open().
  79280. */
  79281. SQLITE_API int sqlite3_blob_close(sqlite3_blob *pBlob){
  79282. Incrblob *p = (Incrblob *)pBlob;
  79283. int rc;
  79284. sqlite3 *db;
  79285. if( p ){
  79286. db = p->db;
  79287. sqlite3_mutex_enter(db->mutex);
  79288. rc = sqlite3_finalize(p->pStmt);
  79289. sqlite3DbFree(db, p);
  79290. sqlite3_mutex_leave(db->mutex);
  79291. }else{
  79292. rc = SQLITE_OK;
  79293. }
  79294. return rc;
  79295. }
  79296. /*
  79297. ** Perform a read or write operation on a blob
  79298. */
  79299. static int blobReadWrite(
  79300. sqlite3_blob *pBlob,
  79301. void *z,
  79302. int n,
  79303. int iOffset,
  79304. int (*xCall)(BtCursor*, u32, u32, void*)
  79305. ){
  79306. int rc;
  79307. Incrblob *p = (Incrblob *)pBlob;
  79308. Vdbe *v;
  79309. sqlite3 *db;
  79310. if( p==0 ) return SQLITE_MISUSE_BKPT;
  79311. db = p->db;
  79312. sqlite3_mutex_enter(db->mutex);
  79313. v = (Vdbe*)p->pStmt;
  79314. if( n<0 || iOffset<0 || ((sqlite3_int64)iOffset+n)>p->nByte ){
  79315. /* Request is out of range. Return a transient error. */
  79316. rc = SQLITE_ERROR;
  79317. }else if( v==0 ){
  79318. /* If there is no statement handle, then the blob-handle has
  79319. ** already been invalidated. Return SQLITE_ABORT in this case.
  79320. */
  79321. rc = SQLITE_ABORT;
  79322. }else{
  79323. /* Call either BtreeData() or BtreePutData(). If SQLITE_ABORT is
  79324. ** returned, clean-up the statement handle.
  79325. */
  79326. assert( db == v->db );
  79327. sqlite3BtreeEnterCursor(p->pCsr);
  79328. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  79329. if( xCall==sqlite3BtreePutData && db->xPreUpdateCallback ){
  79330. /* If a pre-update hook is registered and this is a write cursor,
  79331. ** invoke it here.
  79332. **
  79333. ** TODO: The preupdate-hook is passed SQLITE_DELETE, even though this
  79334. ** operation should really be an SQLITE_UPDATE. This is probably
  79335. ** incorrect, but is convenient because at this point the new.* values
  79336. ** are not easily obtainable. And for the sessions module, an
  79337. ** SQLITE_UPDATE where the PK columns do not change is handled in the
  79338. ** same way as an SQLITE_DELETE (the SQLITE_DELETE code is actually
  79339. ** slightly more efficient). Since you cannot write to a PK column
  79340. ** using the incremental-blob API, this works. For the sessions module
  79341. ** anyhow.
  79342. */
  79343. sqlite3_int64 iKey;
  79344. iKey = sqlite3BtreeIntegerKey(p->pCsr);
  79345. sqlite3VdbePreUpdateHook(
  79346. v, v->apCsr[0], SQLITE_DELETE, p->zDb, p->pTab, iKey, -1
  79347. );
  79348. }
  79349. #endif
  79350. rc = xCall(p->pCsr, iOffset+p->iOffset, n, z);
  79351. sqlite3BtreeLeaveCursor(p->pCsr);
  79352. if( rc==SQLITE_ABORT ){
  79353. sqlite3VdbeFinalize(v);
  79354. p->pStmt = 0;
  79355. }else{
  79356. v->rc = rc;
  79357. }
  79358. }
  79359. sqlite3Error(db, rc);
  79360. rc = sqlite3ApiExit(db, rc);
  79361. sqlite3_mutex_leave(db->mutex);
  79362. return rc;
  79363. }
  79364. /*
  79365. ** Read data from a blob handle.
  79366. */
  79367. SQLITE_API int sqlite3_blob_read(sqlite3_blob *pBlob, void *z, int n, int iOffset){
  79368. return blobReadWrite(pBlob, z, n, iOffset, sqlite3BtreeData);
  79369. }
  79370. /*
  79371. ** Write data to a blob handle.
  79372. */
  79373. SQLITE_API int sqlite3_blob_write(sqlite3_blob *pBlob, const void *z, int n, int iOffset){
  79374. return blobReadWrite(pBlob, (void *)z, n, iOffset, sqlite3BtreePutData);
  79375. }
  79376. /*
  79377. ** Query a blob handle for the size of the data.
  79378. **
  79379. ** The Incrblob.nByte field is fixed for the lifetime of the Incrblob
  79380. ** so no mutex is required for access.
  79381. */
  79382. SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *pBlob){
  79383. Incrblob *p = (Incrblob *)pBlob;
  79384. return (p && p->pStmt) ? p->nByte : 0;
  79385. }
  79386. /*
  79387. ** Move an existing blob handle to point to a different row of the same
  79388. ** database table.
  79389. **
  79390. ** If an error occurs, or if the specified row does not exist or does not
  79391. ** contain a blob or text value, then an error code is returned and the
  79392. ** database handle error code and message set. If this happens, then all
  79393. ** subsequent calls to sqlite3_blob_xxx() functions (except blob_close())
  79394. ** immediately return SQLITE_ABORT.
  79395. */
  79396. SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *pBlob, sqlite3_int64 iRow){
  79397. int rc;
  79398. Incrblob *p = (Incrblob *)pBlob;
  79399. sqlite3 *db;
  79400. if( p==0 ) return SQLITE_MISUSE_BKPT;
  79401. db = p->db;
  79402. sqlite3_mutex_enter(db->mutex);
  79403. if( p->pStmt==0 ){
  79404. /* If there is no statement handle, then the blob-handle has
  79405. ** already been invalidated. Return SQLITE_ABORT in this case.
  79406. */
  79407. rc = SQLITE_ABORT;
  79408. }else{
  79409. char *zErr;
  79410. rc = blobSeekToRow(p, iRow, &zErr);
  79411. if( rc!=SQLITE_OK ){
  79412. sqlite3ErrorWithMsg(db, rc, (zErr ? "%s" : 0), zErr);
  79413. sqlite3DbFree(db, zErr);
  79414. }
  79415. assert( rc!=SQLITE_SCHEMA );
  79416. }
  79417. rc = sqlite3ApiExit(db, rc);
  79418. assert( rc==SQLITE_OK || p->pStmt==0 );
  79419. sqlite3_mutex_leave(db->mutex);
  79420. return rc;
  79421. }
  79422. #endif /* #ifndef SQLITE_OMIT_INCRBLOB */
  79423. /************** End of vdbeblob.c ********************************************/
  79424. /************** Begin file vdbesort.c ****************************************/
  79425. /*
  79426. ** 2011-07-09
  79427. **
  79428. ** The author disclaims copyright to this source code. In place of
  79429. ** a legal notice, here is a blessing:
  79430. **
  79431. ** May you do good and not evil.
  79432. ** May you find forgiveness for yourself and forgive others.
  79433. ** May you share freely, never taking more than you give.
  79434. **
  79435. *************************************************************************
  79436. ** This file contains code for the VdbeSorter object, used in concert with
  79437. ** a VdbeCursor to sort large numbers of keys for CREATE INDEX statements
  79438. ** or by SELECT statements with ORDER BY clauses that cannot be satisfied
  79439. ** using indexes and without LIMIT clauses.
  79440. **
  79441. ** The VdbeSorter object implements a multi-threaded external merge sort
  79442. ** algorithm that is efficient even if the number of elements being sorted
  79443. ** exceeds the available memory.
  79444. **
  79445. ** Here is the (internal, non-API) interface between this module and the
  79446. ** rest of the SQLite system:
  79447. **
  79448. ** sqlite3VdbeSorterInit() Create a new VdbeSorter object.
  79449. **
  79450. ** sqlite3VdbeSorterWrite() Add a single new row to the VdbeSorter
  79451. ** object. The row is a binary blob in the
  79452. ** OP_MakeRecord format that contains both
  79453. ** the ORDER BY key columns and result columns
  79454. ** in the case of a SELECT w/ ORDER BY, or
  79455. ** the complete record for an index entry
  79456. ** in the case of a CREATE INDEX.
  79457. **
  79458. ** sqlite3VdbeSorterRewind() Sort all content previously added.
  79459. ** Position the read cursor on the
  79460. ** first sorted element.
  79461. **
  79462. ** sqlite3VdbeSorterNext() Advance the read cursor to the next sorted
  79463. ** element.
  79464. **
  79465. ** sqlite3VdbeSorterRowkey() Return the complete binary blob for the
  79466. ** row currently under the read cursor.
  79467. **
  79468. ** sqlite3VdbeSorterCompare() Compare the binary blob for the row
  79469. ** currently under the read cursor against
  79470. ** another binary blob X and report if
  79471. ** X is strictly less than the read cursor.
  79472. ** Used to enforce uniqueness in a
  79473. ** CREATE UNIQUE INDEX statement.
  79474. **
  79475. ** sqlite3VdbeSorterClose() Close the VdbeSorter object and reclaim
  79476. ** all resources.
  79477. **
  79478. ** sqlite3VdbeSorterReset() Refurbish the VdbeSorter for reuse. This
  79479. ** is like Close() followed by Init() only
  79480. ** much faster.
  79481. **
  79482. ** The interfaces above must be called in a particular order. Write() can
  79483. ** only occur in between Init()/Reset() and Rewind(). Next(), Rowkey(), and
  79484. ** Compare() can only occur in between Rewind() and Close()/Reset(). i.e.
  79485. **
  79486. ** Init()
  79487. ** for each record: Write()
  79488. ** Rewind()
  79489. ** Rowkey()/Compare()
  79490. ** Next()
  79491. ** Close()
  79492. **
  79493. ** Algorithm:
  79494. **
  79495. ** Records passed to the sorter via calls to Write() are initially held
  79496. ** unsorted in main memory. Assuming the amount of memory used never exceeds
  79497. ** a threshold, when Rewind() is called the set of records is sorted using
  79498. ** an in-memory merge sort. In this case, no temporary files are required
  79499. ** and subsequent calls to Rowkey(), Next() and Compare() read records
  79500. ** directly from main memory.
  79501. **
  79502. ** If the amount of space used to store records in main memory exceeds the
  79503. ** threshold, then the set of records currently in memory are sorted and
  79504. ** written to a temporary file in "Packed Memory Array" (PMA) format.
  79505. ** A PMA created at this point is known as a "level-0 PMA". Higher levels
  79506. ** of PMAs may be created by merging existing PMAs together - for example
  79507. ** merging two or more level-0 PMAs together creates a level-1 PMA.
  79508. **
  79509. ** The threshold for the amount of main memory to use before flushing
  79510. ** records to a PMA is roughly the same as the limit configured for the
  79511. ** page-cache of the main database. Specifically, the threshold is set to
  79512. ** the value returned by "PRAGMA main.page_size" multipled by
  79513. ** that returned by "PRAGMA main.cache_size", in bytes.
  79514. **
  79515. ** If the sorter is running in single-threaded mode, then all PMAs generated
  79516. ** are appended to a single temporary file. Or, if the sorter is running in
  79517. ** multi-threaded mode then up to (N+1) temporary files may be opened, where
  79518. ** N is the configured number of worker threads. In this case, instead of
  79519. ** sorting the records and writing the PMA to a temporary file itself, the
  79520. ** calling thread usually launches a worker thread to do so. Except, if
  79521. ** there are already N worker threads running, the main thread does the work
  79522. ** itself.
  79523. **
  79524. ** The sorter is running in multi-threaded mode if (a) the library was built
  79525. ** with pre-processor symbol SQLITE_MAX_WORKER_THREADS set to a value greater
  79526. ** than zero, and (b) worker threads have been enabled at runtime by calling
  79527. ** "PRAGMA threads=N" with some value of N greater than 0.
  79528. **
  79529. ** When Rewind() is called, any data remaining in memory is flushed to a
  79530. ** final PMA. So at this point the data is stored in some number of sorted
  79531. ** PMAs within temporary files on disk.
  79532. **
  79533. ** If there are fewer than SORTER_MAX_MERGE_COUNT PMAs in total and the
  79534. ** sorter is running in single-threaded mode, then these PMAs are merged
  79535. ** incrementally as keys are retreived from the sorter by the VDBE. The
  79536. ** MergeEngine object, described in further detail below, performs this
  79537. ** merge.
  79538. **
  79539. ** Or, if running in multi-threaded mode, then a background thread is
  79540. ** launched to merge the existing PMAs. Once the background thread has
  79541. ** merged T bytes of data into a single sorted PMA, the main thread
  79542. ** begins reading keys from that PMA while the background thread proceeds
  79543. ** with merging the next T bytes of data. And so on.
  79544. **
  79545. ** Parameter T is set to half the value of the memory threshold used
  79546. ** by Write() above to determine when to create a new PMA.
  79547. **
  79548. ** If there are more than SORTER_MAX_MERGE_COUNT PMAs in total when
  79549. ** Rewind() is called, then a hierarchy of incremental-merges is used.
  79550. ** First, T bytes of data from the first SORTER_MAX_MERGE_COUNT PMAs on
  79551. ** disk are merged together. Then T bytes of data from the second set, and
  79552. ** so on, such that no operation ever merges more than SORTER_MAX_MERGE_COUNT
  79553. ** PMAs at a time. This done is to improve locality.
  79554. **
  79555. ** If running in multi-threaded mode and there are more than
  79556. ** SORTER_MAX_MERGE_COUNT PMAs on disk when Rewind() is called, then more
  79557. ** than one background thread may be created. Specifically, there may be
  79558. ** one background thread for each temporary file on disk, and one background
  79559. ** thread to merge the output of each of the others to a single PMA for
  79560. ** the main thread to read from.
  79561. */
  79562. /* #include "sqliteInt.h" */
  79563. /* #include "vdbeInt.h" */
  79564. /*
  79565. ** If SQLITE_DEBUG_SORTER_THREADS is defined, this module outputs various
  79566. ** messages to stderr that may be helpful in understanding the performance
  79567. ** characteristics of the sorter in multi-threaded mode.
  79568. */
  79569. #if 0
  79570. # define SQLITE_DEBUG_SORTER_THREADS 1
  79571. #endif
  79572. /*
  79573. ** Hard-coded maximum amount of data to accumulate in memory before flushing
  79574. ** to a level 0 PMA. The purpose of this limit is to prevent various integer
  79575. ** overflows. 512MiB.
  79576. */
  79577. #define SQLITE_MAX_PMASZ (1<<29)
  79578. /*
  79579. ** Private objects used by the sorter
  79580. */
  79581. typedef struct MergeEngine MergeEngine; /* Merge PMAs together */
  79582. typedef struct PmaReader PmaReader; /* Incrementally read one PMA */
  79583. typedef struct PmaWriter PmaWriter; /* Incrementally write one PMA */
  79584. typedef struct SorterRecord SorterRecord; /* A record being sorted */
  79585. typedef struct SortSubtask SortSubtask; /* A sub-task in the sort process */
  79586. typedef struct SorterFile SorterFile; /* Temporary file object wrapper */
  79587. typedef struct SorterList SorterList; /* In-memory list of records */
  79588. typedef struct IncrMerger IncrMerger; /* Read & merge multiple PMAs */
  79589. /*
  79590. ** A container for a temp file handle and the current amount of data
  79591. ** stored in the file.
  79592. */
  79593. struct SorterFile {
  79594. sqlite3_file *pFd; /* File handle */
  79595. i64 iEof; /* Bytes of data stored in pFd */
  79596. };
  79597. /*
  79598. ** An in-memory list of objects to be sorted.
  79599. **
  79600. ** If aMemory==0 then each object is allocated separately and the objects
  79601. ** are connected using SorterRecord.u.pNext. If aMemory!=0 then all objects
  79602. ** are stored in the aMemory[] bulk memory, one right after the other, and
  79603. ** are connected using SorterRecord.u.iNext.
  79604. */
  79605. struct SorterList {
  79606. SorterRecord *pList; /* Linked list of records */
  79607. u8 *aMemory; /* If non-NULL, bulk memory to hold pList */
  79608. int szPMA; /* Size of pList as PMA in bytes */
  79609. };
  79610. /*
  79611. ** The MergeEngine object is used to combine two or more smaller PMAs into
  79612. ** one big PMA using a merge operation. Separate PMAs all need to be
  79613. ** combined into one big PMA in order to be able to step through the sorted
  79614. ** records in order.
  79615. **
  79616. ** The aReadr[] array contains a PmaReader object for each of the PMAs being
  79617. ** merged. An aReadr[] object either points to a valid key or else is at EOF.
  79618. ** ("EOF" means "End Of File". When aReadr[] is at EOF there is no more data.)
  79619. ** For the purposes of the paragraphs below, we assume that the array is
  79620. ** actually N elements in size, where N is the smallest power of 2 greater
  79621. ** to or equal to the number of PMAs being merged. The extra aReadr[] elements
  79622. ** are treated as if they are empty (always at EOF).
  79623. **
  79624. ** The aTree[] array is also N elements in size. The value of N is stored in
  79625. ** the MergeEngine.nTree variable.
  79626. **
  79627. ** The final (N/2) elements of aTree[] contain the results of comparing
  79628. ** pairs of PMA keys together. Element i contains the result of
  79629. ** comparing aReadr[2*i-N] and aReadr[2*i-N+1]. Whichever key is smaller, the
  79630. ** aTree element is set to the index of it.
  79631. **
  79632. ** For the purposes of this comparison, EOF is considered greater than any
  79633. ** other key value. If the keys are equal (only possible with two EOF
  79634. ** values), it doesn't matter which index is stored.
  79635. **
  79636. ** The (N/4) elements of aTree[] that precede the final (N/2) described
  79637. ** above contains the index of the smallest of each block of 4 PmaReaders
  79638. ** And so on. So that aTree[1] contains the index of the PmaReader that
  79639. ** currently points to the smallest key value. aTree[0] is unused.
  79640. **
  79641. ** Example:
  79642. **
  79643. ** aReadr[0] -> Banana
  79644. ** aReadr[1] -> Feijoa
  79645. ** aReadr[2] -> Elderberry
  79646. ** aReadr[3] -> Currant
  79647. ** aReadr[4] -> Grapefruit
  79648. ** aReadr[5] -> Apple
  79649. ** aReadr[6] -> Durian
  79650. ** aReadr[7] -> EOF
  79651. **
  79652. ** aTree[] = { X, 5 0, 5 0, 3, 5, 6 }
  79653. **
  79654. ** The current element is "Apple" (the value of the key indicated by
  79655. ** PmaReader 5). When the Next() operation is invoked, PmaReader 5 will
  79656. ** be advanced to the next key in its segment. Say the next key is
  79657. ** "Eggplant":
  79658. **
  79659. ** aReadr[5] -> Eggplant
  79660. **
  79661. ** The contents of aTree[] are updated first by comparing the new PmaReader
  79662. ** 5 key to the current key of PmaReader 4 (still "Grapefruit"). The PmaReader
  79663. ** 5 value is still smaller, so aTree[6] is set to 5. And so on up the tree.
  79664. ** The value of PmaReader 6 - "Durian" - is now smaller than that of PmaReader
  79665. ** 5, so aTree[3] is set to 6. Key 0 is smaller than key 6 (Banana<Durian),
  79666. ** so the value written into element 1 of the array is 0. As follows:
  79667. **
  79668. ** aTree[] = { X, 0 0, 6 0, 3, 5, 6 }
  79669. **
  79670. ** In other words, each time we advance to the next sorter element, log2(N)
  79671. ** key comparison operations are required, where N is the number of segments
  79672. ** being merged (rounded up to the next power of 2).
  79673. */
  79674. struct MergeEngine {
  79675. int nTree; /* Used size of aTree/aReadr (power of 2) */
  79676. SortSubtask *pTask; /* Used by this thread only */
  79677. int *aTree; /* Current state of incremental merge */
  79678. PmaReader *aReadr; /* Array of PmaReaders to merge data from */
  79679. };
  79680. /*
  79681. ** This object represents a single thread of control in a sort operation.
  79682. ** Exactly VdbeSorter.nTask instances of this object are allocated
  79683. ** as part of each VdbeSorter object. Instances are never allocated any
  79684. ** other way. VdbeSorter.nTask is set to the number of worker threads allowed
  79685. ** (see SQLITE_CONFIG_WORKER_THREADS) plus one (the main thread). Thus for
  79686. ** single-threaded operation, there is exactly one instance of this object
  79687. ** and for multi-threaded operation there are two or more instances.
  79688. **
  79689. ** Essentially, this structure contains all those fields of the VdbeSorter
  79690. ** structure for which each thread requires a separate instance. For example,
  79691. ** each thread requries its own UnpackedRecord object to unpack records in
  79692. ** as part of comparison operations.
  79693. **
  79694. ** Before a background thread is launched, variable bDone is set to 0. Then,
  79695. ** right before it exits, the thread itself sets bDone to 1. This is used for
  79696. ** two purposes:
  79697. **
  79698. ** 1. When flushing the contents of memory to a level-0 PMA on disk, to
  79699. ** attempt to select a SortSubtask for which there is not already an
  79700. ** active background thread (since doing so causes the main thread
  79701. ** to block until it finishes).
  79702. **
  79703. ** 2. If SQLITE_DEBUG_SORTER_THREADS is defined, to determine if a call
  79704. ** to sqlite3ThreadJoin() is likely to block. Cases that are likely to
  79705. ** block provoke debugging output.
  79706. **
  79707. ** In both cases, the effects of the main thread seeing (bDone==0) even
  79708. ** after the thread has finished are not dire. So we don't worry about
  79709. ** memory barriers and such here.
  79710. */
  79711. typedef int (*SorterCompare)(SortSubtask*,int*,const void*,int,const void*,int);
  79712. struct SortSubtask {
  79713. SQLiteThread *pThread; /* Background thread, if any */
  79714. int bDone; /* Set if thread is finished but not joined */
  79715. VdbeSorter *pSorter; /* Sorter that owns this sub-task */
  79716. UnpackedRecord *pUnpacked; /* Space to unpack a record */
  79717. SorterList list; /* List for thread to write to a PMA */
  79718. int nPMA; /* Number of PMAs currently in file */
  79719. SorterCompare xCompare; /* Compare function to use */
  79720. SorterFile file; /* Temp file for level-0 PMAs */
  79721. SorterFile file2; /* Space for other PMAs */
  79722. };
  79723. /*
  79724. ** Main sorter structure. A single instance of this is allocated for each
  79725. ** sorter cursor created by the VDBE.
  79726. **
  79727. ** mxKeysize:
  79728. ** As records are added to the sorter by calls to sqlite3VdbeSorterWrite(),
  79729. ** this variable is updated so as to be set to the size on disk of the
  79730. ** largest record in the sorter.
  79731. */
  79732. struct VdbeSorter {
  79733. int mnPmaSize; /* Minimum PMA size, in bytes */
  79734. int mxPmaSize; /* Maximum PMA size, in bytes. 0==no limit */
  79735. int mxKeysize; /* Largest serialized key seen so far */
  79736. int pgsz; /* Main database page size */
  79737. PmaReader *pReader; /* Readr data from here after Rewind() */
  79738. MergeEngine *pMerger; /* Or here, if bUseThreads==0 */
  79739. sqlite3 *db; /* Database connection */
  79740. KeyInfo *pKeyInfo; /* How to compare records */
  79741. UnpackedRecord *pUnpacked; /* Used by VdbeSorterCompare() */
  79742. SorterList list; /* List of in-memory records */
  79743. int iMemory; /* Offset of free space in list.aMemory */
  79744. int nMemory; /* Size of list.aMemory allocation in bytes */
  79745. u8 bUsePMA; /* True if one or more PMAs created */
  79746. u8 bUseThreads; /* True to use background threads */
  79747. u8 iPrev; /* Previous thread used to flush PMA */
  79748. u8 nTask; /* Size of aTask[] array */
  79749. u8 typeMask;
  79750. SortSubtask aTask[1]; /* One or more subtasks */
  79751. };
  79752. #define SORTER_TYPE_INTEGER 0x01
  79753. #define SORTER_TYPE_TEXT 0x02
  79754. /*
  79755. ** An instance of the following object is used to read records out of a
  79756. ** PMA, in sorted order. The next key to be read is cached in nKey/aKey.
  79757. ** aKey might point into aMap or into aBuffer. If neither of those locations
  79758. ** contain a contiguous representation of the key, then aAlloc is allocated
  79759. ** and the key is copied into aAlloc and aKey is made to poitn to aAlloc.
  79760. **
  79761. ** pFd==0 at EOF.
  79762. */
  79763. struct PmaReader {
  79764. i64 iReadOff; /* Current read offset */
  79765. i64 iEof; /* 1 byte past EOF for this PmaReader */
  79766. int nAlloc; /* Bytes of space at aAlloc */
  79767. int nKey; /* Number of bytes in key */
  79768. sqlite3_file *pFd; /* File handle we are reading from */
  79769. u8 *aAlloc; /* Space for aKey if aBuffer and pMap wont work */
  79770. u8 *aKey; /* Pointer to current key */
  79771. u8 *aBuffer; /* Current read buffer */
  79772. int nBuffer; /* Size of read buffer in bytes */
  79773. u8 *aMap; /* Pointer to mapping of entire file */
  79774. IncrMerger *pIncr; /* Incremental merger */
  79775. };
  79776. /*
  79777. ** Normally, a PmaReader object iterates through an existing PMA stored
  79778. ** within a temp file. However, if the PmaReader.pIncr variable points to
  79779. ** an object of the following type, it may be used to iterate/merge through
  79780. ** multiple PMAs simultaneously.
  79781. **
  79782. ** There are two types of IncrMerger object - single (bUseThread==0) and
  79783. ** multi-threaded (bUseThread==1).
  79784. **
  79785. ** A multi-threaded IncrMerger object uses two temporary files - aFile[0]
  79786. ** and aFile[1]. Neither file is allowed to grow to more than mxSz bytes in
  79787. ** size. When the IncrMerger is initialized, it reads enough data from
  79788. ** pMerger to populate aFile[0]. It then sets variables within the
  79789. ** corresponding PmaReader object to read from that file and kicks off
  79790. ** a background thread to populate aFile[1] with the next mxSz bytes of
  79791. ** sorted record data from pMerger.
  79792. **
  79793. ** When the PmaReader reaches the end of aFile[0], it blocks until the
  79794. ** background thread has finished populating aFile[1]. It then exchanges
  79795. ** the contents of the aFile[0] and aFile[1] variables within this structure,
  79796. ** sets the PmaReader fields to read from the new aFile[0] and kicks off
  79797. ** another background thread to populate the new aFile[1]. And so on, until
  79798. ** the contents of pMerger are exhausted.
  79799. **
  79800. ** A single-threaded IncrMerger does not open any temporary files of its
  79801. ** own. Instead, it has exclusive access to mxSz bytes of space beginning
  79802. ** at offset iStartOff of file pTask->file2. And instead of using a
  79803. ** background thread to prepare data for the PmaReader, with a single
  79804. ** threaded IncrMerger the allocate part of pTask->file2 is "refilled" with
  79805. ** keys from pMerger by the calling thread whenever the PmaReader runs out
  79806. ** of data.
  79807. */
  79808. struct IncrMerger {
  79809. SortSubtask *pTask; /* Task that owns this merger */
  79810. MergeEngine *pMerger; /* Merge engine thread reads data from */
  79811. i64 iStartOff; /* Offset to start writing file at */
  79812. int mxSz; /* Maximum bytes of data to store */
  79813. int bEof; /* Set to true when merge is finished */
  79814. int bUseThread; /* True to use a bg thread for this object */
  79815. SorterFile aFile[2]; /* aFile[0] for reading, [1] for writing */
  79816. };
  79817. /*
  79818. ** An instance of this object is used for writing a PMA.
  79819. **
  79820. ** The PMA is written one record at a time. Each record is of an arbitrary
  79821. ** size. But I/O is more efficient if it occurs in page-sized blocks where
  79822. ** each block is aligned on a page boundary. This object caches writes to
  79823. ** the PMA so that aligned, page-size blocks are written.
  79824. */
  79825. struct PmaWriter {
  79826. int eFWErr; /* Non-zero if in an error state */
  79827. u8 *aBuffer; /* Pointer to write buffer */
  79828. int nBuffer; /* Size of write buffer in bytes */
  79829. int iBufStart; /* First byte of buffer to write */
  79830. int iBufEnd; /* Last byte of buffer to write */
  79831. i64 iWriteOff; /* Offset of start of buffer in file */
  79832. sqlite3_file *pFd; /* File handle to write to */
  79833. };
  79834. /*
  79835. ** This object is the header on a single record while that record is being
  79836. ** held in memory and prior to being written out as part of a PMA.
  79837. **
  79838. ** How the linked list is connected depends on how memory is being managed
  79839. ** by this module. If using a separate allocation for each in-memory record
  79840. ** (VdbeSorter.list.aMemory==0), then the list is always connected using the
  79841. ** SorterRecord.u.pNext pointers.
  79842. **
  79843. ** Or, if using the single large allocation method (VdbeSorter.list.aMemory!=0),
  79844. ** then while records are being accumulated the list is linked using the
  79845. ** SorterRecord.u.iNext offset. This is because the aMemory[] array may
  79846. ** be sqlite3Realloc()ed while records are being accumulated. Once the VM
  79847. ** has finished passing records to the sorter, or when the in-memory buffer
  79848. ** is full, the list is sorted. As part of the sorting process, it is
  79849. ** converted to use the SorterRecord.u.pNext pointers. See function
  79850. ** vdbeSorterSort() for details.
  79851. */
  79852. struct SorterRecord {
  79853. int nVal; /* Size of the record in bytes */
  79854. union {
  79855. SorterRecord *pNext; /* Pointer to next record in list */
  79856. int iNext; /* Offset within aMemory of next record */
  79857. } u;
  79858. /* The data for the record immediately follows this header */
  79859. };
  79860. /* Return a pointer to the buffer containing the record data for SorterRecord
  79861. ** object p. Should be used as if:
  79862. **
  79863. ** void *SRVAL(SorterRecord *p) { return (void*)&p[1]; }
  79864. */
  79865. #define SRVAL(p) ((void*)((SorterRecord*)(p) + 1))
  79866. /* Maximum number of PMAs that a single MergeEngine can merge */
  79867. #define SORTER_MAX_MERGE_COUNT 16
  79868. static int vdbeIncrSwap(IncrMerger*);
  79869. static void vdbeIncrFree(IncrMerger *);
  79870. /*
  79871. ** Free all memory belonging to the PmaReader object passed as the
  79872. ** argument. All structure fields are set to zero before returning.
  79873. */
  79874. static void vdbePmaReaderClear(PmaReader *pReadr){
  79875. sqlite3_free(pReadr->aAlloc);
  79876. sqlite3_free(pReadr->aBuffer);
  79877. if( pReadr->aMap ) sqlite3OsUnfetch(pReadr->pFd, 0, pReadr->aMap);
  79878. vdbeIncrFree(pReadr->pIncr);
  79879. memset(pReadr, 0, sizeof(PmaReader));
  79880. }
  79881. /*
  79882. ** Read the next nByte bytes of data from the PMA p.
  79883. ** If successful, set *ppOut to point to a buffer containing the data
  79884. ** and return SQLITE_OK. Otherwise, if an error occurs, return an SQLite
  79885. ** error code.
  79886. **
  79887. ** The buffer returned in *ppOut is only valid until the
  79888. ** next call to this function.
  79889. */
  79890. static int vdbePmaReadBlob(
  79891. PmaReader *p, /* PmaReader from which to take the blob */
  79892. int nByte, /* Bytes of data to read */
  79893. u8 **ppOut /* OUT: Pointer to buffer containing data */
  79894. ){
  79895. int iBuf; /* Offset within buffer to read from */
  79896. int nAvail; /* Bytes of data available in buffer */
  79897. if( p->aMap ){
  79898. *ppOut = &p->aMap[p->iReadOff];
  79899. p->iReadOff += nByte;
  79900. return SQLITE_OK;
  79901. }
  79902. assert( p->aBuffer );
  79903. /* If there is no more data to be read from the buffer, read the next
  79904. ** p->nBuffer bytes of data from the file into it. Or, if there are less
  79905. ** than p->nBuffer bytes remaining in the PMA, read all remaining data. */
  79906. iBuf = p->iReadOff % p->nBuffer;
  79907. if( iBuf==0 ){
  79908. int nRead; /* Bytes to read from disk */
  79909. int rc; /* sqlite3OsRead() return code */
  79910. /* Determine how many bytes of data to read. */
  79911. if( (p->iEof - p->iReadOff) > (i64)p->nBuffer ){
  79912. nRead = p->nBuffer;
  79913. }else{
  79914. nRead = (int)(p->iEof - p->iReadOff);
  79915. }
  79916. assert( nRead>0 );
  79917. /* Readr data from the file. Return early if an error occurs. */
  79918. rc = sqlite3OsRead(p->pFd, p->aBuffer, nRead, p->iReadOff);
  79919. assert( rc!=SQLITE_IOERR_SHORT_READ );
  79920. if( rc!=SQLITE_OK ) return rc;
  79921. }
  79922. nAvail = p->nBuffer - iBuf;
  79923. if( nByte<=nAvail ){
  79924. /* The requested data is available in the in-memory buffer. In this
  79925. ** case there is no need to make a copy of the data, just return a
  79926. ** pointer into the buffer to the caller. */
  79927. *ppOut = &p->aBuffer[iBuf];
  79928. p->iReadOff += nByte;
  79929. }else{
  79930. /* The requested data is not all available in the in-memory buffer.
  79931. ** In this case, allocate space at p->aAlloc[] to copy the requested
  79932. ** range into. Then return a copy of pointer p->aAlloc to the caller. */
  79933. int nRem; /* Bytes remaining to copy */
  79934. /* Extend the p->aAlloc[] allocation if required. */
  79935. if( p->nAlloc<nByte ){
  79936. u8 *aNew;
  79937. int nNew = MAX(128, p->nAlloc*2);
  79938. while( nByte>nNew ) nNew = nNew*2;
  79939. aNew = sqlite3Realloc(p->aAlloc, nNew);
  79940. if( !aNew ) return SQLITE_NOMEM_BKPT;
  79941. p->nAlloc = nNew;
  79942. p->aAlloc = aNew;
  79943. }
  79944. /* Copy as much data as is available in the buffer into the start of
  79945. ** p->aAlloc[]. */
  79946. memcpy(p->aAlloc, &p->aBuffer[iBuf], nAvail);
  79947. p->iReadOff += nAvail;
  79948. nRem = nByte - nAvail;
  79949. /* The following loop copies up to p->nBuffer bytes per iteration into
  79950. ** the p->aAlloc[] buffer. */
  79951. while( nRem>0 ){
  79952. int rc; /* vdbePmaReadBlob() return code */
  79953. int nCopy; /* Number of bytes to copy */
  79954. u8 *aNext; /* Pointer to buffer to copy data from */
  79955. nCopy = nRem;
  79956. if( nRem>p->nBuffer ) nCopy = p->nBuffer;
  79957. rc = vdbePmaReadBlob(p, nCopy, &aNext);
  79958. if( rc!=SQLITE_OK ) return rc;
  79959. assert( aNext!=p->aAlloc );
  79960. memcpy(&p->aAlloc[nByte - nRem], aNext, nCopy);
  79961. nRem -= nCopy;
  79962. }
  79963. *ppOut = p->aAlloc;
  79964. }
  79965. return SQLITE_OK;
  79966. }
  79967. /*
  79968. ** Read a varint from the stream of data accessed by p. Set *pnOut to
  79969. ** the value read.
  79970. */
  79971. static int vdbePmaReadVarint(PmaReader *p, u64 *pnOut){
  79972. int iBuf;
  79973. if( p->aMap ){
  79974. p->iReadOff += sqlite3GetVarint(&p->aMap[p->iReadOff], pnOut);
  79975. }else{
  79976. iBuf = p->iReadOff % p->nBuffer;
  79977. if( iBuf && (p->nBuffer-iBuf)>=9 ){
  79978. p->iReadOff += sqlite3GetVarint(&p->aBuffer[iBuf], pnOut);
  79979. }else{
  79980. u8 aVarint[16], *a;
  79981. int i = 0, rc;
  79982. do{
  79983. rc = vdbePmaReadBlob(p, 1, &a);
  79984. if( rc ) return rc;
  79985. aVarint[(i++)&0xf] = a[0];
  79986. }while( (a[0]&0x80)!=0 );
  79987. sqlite3GetVarint(aVarint, pnOut);
  79988. }
  79989. }
  79990. return SQLITE_OK;
  79991. }
  79992. /*
  79993. ** Attempt to memory map file pFile. If successful, set *pp to point to the
  79994. ** new mapping and return SQLITE_OK. If the mapping is not attempted
  79995. ** (because the file is too large or the VFS layer is configured not to use
  79996. ** mmap), return SQLITE_OK and set *pp to NULL.
  79997. **
  79998. ** Or, if an error occurs, return an SQLite error code. The final value of
  79999. ** *pp is undefined in this case.
  80000. */
  80001. static int vdbeSorterMapFile(SortSubtask *pTask, SorterFile *pFile, u8 **pp){
  80002. int rc = SQLITE_OK;
  80003. if( pFile->iEof<=(i64)(pTask->pSorter->db->nMaxSorterMmap) ){
  80004. sqlite3_file *pFd = pFile->pFd;
  80005. if( pFd->pMethods->iVersion>=3 ){
  80006. rc = sqlite3OsFetch(pFd, 0, (int)pFile->iEof, (void**)pp);
  80007. testcase( rc!=SQLITE_OK );
  80008. }
  80009. }
  80010. return rc;
  80011. }
  80012. /*
  80013. ** Attach PmaReader pReadr to file pFile (if it is not already attached to
  80014. ** that file) and seek it to offset iOff within the file. Return SQLITE_OK
  80015. ** if successful, or an SQLite error code if an error occurs.
  80016. */
  80017. static int vdbePmaReaderSeek(
  80018. SortSubtask *pTask, /* Task context */
  80019. PmaReader *pReadr, /* Reader whose cursor is to be moved */
  80020. SorterFile *pFile, /* Sorter file to read from */
  80021. i64 iOff /* Offset in pFile */
  80022. ){
  80023. int rc = SQLITE_OK;
  80024. assert( pReadr->pIncr==0 || pReadr->pIncr->bEof==0 );
  80025. if( sqlite3FaultSim(201) ) return SQLITE_IOERR_READ;
  80026. if( pReadr->aMap ){
  80027. sqlite3OsUnfetch(pReadr->pFd, 0, pReadr->aMap);
  80028. pReadr->aMap = 0;
  80029. }
  80030. pReadr->iReadOff = iOff;
  80031. pReadr->iEof = pFile->iEof;
  80032. pReadr->pFd = pFile->pFd;
  80033. rc = vdbeSorterMapFile(pTask, pFile, &pReadr->aMap);
  80034. if( rc==SQLITE_OK && pReadr->aMap==0 ){
  80035. int pgsz = pTask->pSorter->pgsz;
  80036. int iBuf = pReadr->iReadOff % pgsz;
  80037. if( pReadr->aBuffer==0 ){
  80038. pReadr->aBuffer = (u8*)sqlite3Malloc(pgsz);
  80039. if( pReadr->aBuffer==0 ) rc = SQLITE_NOMEM_BKPT;
  80040. pReadr->nBuffer = pgsz;
  80041. }
  80042. if( rc==SQLITE_OK && iBuf ){
  80043. int nRead = pgsz - iBuf;
  80044. if( (pReadr->iReadOff + nRead) > pReadr->iEof ){
  80045. nRead = (int)(pReadr->iEof - pReadr->iReadOff);
  80046. }
  80047. rc = sqlite3OsRead(
  80048. pReadr->pFd, &pReadr->aBuffer[iBuf], nRead, pReadr->iReadOff
  80049. );
  80050. testcase( rc!=SQLITE_OK );
  80051. }
  80052. }
  80053. return rc;
  80054. }
  80055. /*
  80056. ** Advance PmaReader pReadr to the next key in its PMA. Return SQLITE_OK if
  80057. ** no error occurs, or an SQLite error code if one does.
  80058. */
  80059. static int vdbePmaReaderNext(PmaReader *pReadr){
  80060. int rc = SQLITE_OK; /* Return Code */
  80061. u64 nRec = 0; /* Size of record in bytes */
  80062. if( pReadr->iReadOff>=pReadr->iEof ){
  80063. IncrMerger *pIncr = pReadr->pIncr;
  80064. int bEof = 1;
  80065. if( pIncr ){
  80066. rc = vdbeIncrSwap(pIncr);
  80067. if( rc==SQLITE_OK && pIncr->bEof==0 ){
  80068. rc = vdbePmaReaderSeek(
  80069. pIncr->pTask, pReadr, &pIncr->aFile[0], pIncr->iStartOff
  80070. );
  80071. bEof = 0;
  80072. }
  80073. }
  80074. if( bEof ){
  80075. /* This is an EOF condition */
  80076. vdbePmaReaderClear(pReadr);
  80077. testcase( rc!=SQLITE_OK );
  80078. return rc;
  80079. }
  80080. }
  80081. if( rc==SQLITE_OK ){
  80082. rc = vdbePmaReadVarint(pReadr, &nRec);
  80083. }
  80084. if( rc==SQLITE_OK ){
  80085. pReadr->nKey = (int)nRec;
  80086. rc = vdbePmaReadBlob(pReadr, (int)nRec, &pReadr->aKey);
  80087. testcase( rc!=SQLITE_OK );
  80088. }
  80089. return rc;
  80090. }
  80091. /*
  80092. ** Initialize PmaReader pReadr to scan through the PMA stored in file pFile
  80093. ** starting at offset iStart and ending at offset iEof-1. This function
  80094. ** leaves the PmaReader pointing to the first key in the PMA (or EOF if the
  80095. ** PMA is empty).
  80096. **
  80097. ** If the pnByte parameter is NULL, then it is assumed that the file
  80098. ** contains a single PMA, and that that PMA omits the initial length varint.
  80099. */
  80100. static int vdbePmaReaderInit(
  80101. SortSubtask *pTask, /* Task context */
  80102. SorterFile *pFile, /* Sorter file to read from */
  80103. i64 iStart, /* Start offset in pFile */
  80104. PmaReader *pReadr, /* PmaReader to populate */
  80105. i64 *pnByte /* IN/OUT: Increment this value by PMA size */
  80106. ){
  80107. int rc;
  80108. assert( pFile->iEof>iStart );
  80109. assert( pReadr->aAlloc==0 && pReadr->nAlloc==0 );
  80110. assert( pReadr->aBuffer==0 );
  80111. assert( pReadr->aMap==0 );
  80112. rc = vdbePmaReaderSeek(pTask, pReadr, pFile, iStart);
  80113. if( rc==SQLITE_OK ){
  80114. u64 nByte = 0; /* Size of PMA in bytes */
  80115. rc = vdbePmaReadVarint(pReadr, &nByte);
  80116. pReadr->iEof = pReadr->iReadOff + nByte;
  80117. *pnByte += nByte;
  80118. }
  80119. if( rc==SQLITE_OK ){
  80120. rc = vdbePmaReaderNext(pReadr);
  80121. }
  80122. return rc;
  80123. }
  80124. /*
  80125. ** A version of vdbeSorterCompare() that assumes that it has already been
  80126. ** determined that the first field of key1 is equal to the first field of
  80127. ** key2.
  80128. */
  80129. static int vdbeSorterCompareTail(
  80130. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  80131. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  80132. const void *pKey1, int nKey1, /* Left side of comparison */
  80133. const void *pKey2, int nKey2 /* Right side of comparison */
  80134. ){
  80135. UnpackedRecord *r2 = pTask->pUnpacked;
  80136. if( *pbKey2Cached==0 ){
  80137. sqlite3VdbeRecordUnpack(pTask->pSorter->pKeyInfo, nKey2, pKey2, r2);
  80138. *pbKey2Cached = 1;
  80139. }
  80140. return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, r2, 1);
  80141. }
  80142. /*
  80143. ** Compare key1 (buffer pKey1, size nKey1 bytes) with key2 (buffer pKey2,
  80144. ** size nKey2 bytes). Use (pTask->pKeyInfo) for the collation sequences
  80145. ** used by the comparison. Return the result of the comparison.
  80146. **
  80147. ** If IN/OUT parameter *pbKey2Cached is true when this function is called,
  80148. ** it is assumed that (pTask->pUnpacked) contains the unpacked version
  80149. ** of key2. If it is false, (pTask->pUnpacked) is populated with the unpacked
  80150. ** version of key2 and *pbKey2Cached set to true before returning.
  80151. **
  80152. ** If an OOM error is encountered, (pTask->pUnpacked->error_rc) is set
  80153. ** to SQLITE_NOMEM.
  80154. */
  80155. static int vdbeSorterCompare(
  80156. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  80157. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  80158. const void *pKey1, int nKey1, /* Left side of comparison */
  80159. const void *pKey2, int nKey2 /* Right side of comparison */
  80160. ){
  80161. UnpackedRecord *r2 = pTask->pUnpacked;
  80162. if( !*pbKey2Cached ){
  80163. sqlite3VdbeRecordUnpack(pTask->pSorter->pKeyInfo, nKey2, pKey2, r2);
  80164. *pbKey2Cached = 1;
  80165. }
  80166. return sqlite3VdbeRecordCompare(nKey1, pKey1, r2);
  80167. }
  80168. /*
  80169. ** A specially optimized version of vdbeSorterCompare() that assumes that
  80170. ** the first field of each key is a TEXT value and that the collation
  80171. ** sequence to compare them with is BINARY.
  80172. */
  80173. static int vdbeSorterCompareText(
  80174. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  80175. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  80176. const void *pKey1, int nKey1, /* Left side of comparison */
  80177. const void *pKey2, int nKey2 /* Right side of comparison */
  80178. ){
  80179. const u8 * const p1 = (const u8 * const)pKey1;
  80180. const u8 * const p2 = (const u8 * const)pKey2;
  80181. const u8 * const v1 = &p1[ p1[0] ]; /* Pointer to value 1 */
  80182. const u8 * const v2 = &p2[ p2[0] ]; /* Pointer to value 2 */
  80183. int n1;
  80184. int n2;
  80185. int res;
  80186. getVarint32(&p1[1], n1); n1 = (n1 - 13) / 2;
  80187. getVarint32(&p2[1], n2); n2 = (n2 - 13) / 2;
  80188. res = memcmp(v1, v2, MIN(n1, n2));
  80189. if( res==0 ){
  80190. res = n1 - n2;
  80191. }
  80192. if( res==0 ){
  80193. if( pTask->pSorter->pKeyInfo->nField>1 ){
  80194. res = vdbeSorterCompareTail(
  80195. pTask, pbKey2Cached, pKey1, nKey1, pKey2, nKey2
  80196. );
  80197. }
  80198. }else{
  80199. if( pTask->pSorter->pKeyInfo->aSortOrder[0] ){
  80200. res = res * -1;
  80201. }
  80202. }
  80203. return res;
  80204. }
  80205. /*
  80206. ** A specially optimized version of vdbeSorterCompare() that assumes that
  80207. ** the first field of each key is an INTEGER value.
  80208. */
  80209. static int vdbeSorterCompareInt(
  80210. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  80211. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  80212. const void *pKey1, int nKey1, /* Left side of comparison */
  80213. const void *pKey2, int nKey2 /* Right side of comparison */
  80214. ){
  80215. const u8 * const p1 = (const u8 * const)pKey1;
  80216. const u8 * const p2 = (const u8 * const)pKey2;
  80217. const int s1 = p1[1]; /* Left hand serial type */
  80218. const int s2 = p2[1]; /* Right hand serial type */
  80219. const u8 * const v1 = &p1[ p1[0] ]; /* Pointer to value 1 */
  80220. const u8 * const v2 = &p2[ p2[0] ]; /* Pointer to value 2 */
  80221. int res; /* Return value */
  80222. assert( (s1>0 && s1<7) || s1==8 || s1==9 );
  80223. assert( (s2>0 && s2<7) || s2==8 || s2==9 );
  80224. if( s1>7 && s2>7 ){
  80225. res = s1 - s2;
  80226. }else{
  80227. if( s1==s2 ){
  80228. if( (*v1 ^ *v2) & 0x80 ){
  80229. /* The two values have different signs */
  80230. res = (*v1 & 0x80) ? -1 : +1;
  80231. }else{
  80232. /* The two values have the same sign. Compare using memcmp(). */
  80233. static const u8 aLen[] = {0, 1, 2, 3, 4, 6, 8 };
  80234. int i;
  80235. res = 0;
  80236. for(i=0; i<aLen[s1]; i++){
  80237. if( (res = v1[i] - v2[i]) ) break;
  80238. }
  80239. }
  80240. }else{
  80241. if( s2>7 ){
  80242. res = +1;
  80243. }else if( s1>7 ){
  80244. res = -1;
  80245. }else{
  80246. res = s1 - s2;
  80247. }
  80248. assert( res!=0 );
  80249. if( res>0 ){
  80250. if( *v1 & 0x80 ) res = -1;
  80251. }else{
  80252. if( *v2 & 0x80 ) res = +1;
  80253. }
  80254. }
  80255. }
  80256. if( res==0 ){
  80257. if( pTask->pSorter->pKeyInfo->nField>1 ){
  80258. res = vdbeSorterCompareTail(
  80259. pTask, pbKey2Cached, pKey1, nKey1, pKey2, nKey2
  80260. );
  80261. }
  80262. }else if( pTask->pSorter->pKeyInfo->aSortOrder[0] ){
  80263. res = res * -1;
  80264. }
  80265. return res;
  80266. }
  80267. /*
  80268. ** Initialize the temporary index cursor just opened as a sorter cursor.
  80269. **
  80270. ** Usually, the sorter module uses the value of (pCsr->pKeyInfo->nField)
  80271. ** to determine the number of fields that should be compared from the
  80272. ** records being sorted. However, if the value passed as argument nField
  80273. ** is non-zero and the sorter is able to guarantee a stable sort, nField
  80274. ** is used instead. This is used when sorting records for a CREATE INDEX
  80275. ** statement. In this case, keys are always delivered to the sorter in
  80276. ** order of the primary key, which happens to be make up the final part
  80277. ** of the records being sorted. So if the sort is stable, there is never
  80278. ** any reason to compare PK fields and they can be ignored for a small
  80279. ** performance boost.
  80280. **
  80281. ** The sorter can guarantee a stable sort when running in single-threaded
  80282. ** mode, but not in multi-threaded mode.
  80283. **
  80284. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  80285. */
  80286. SQLITE_PRIVATE int sqlite3VdbeSorterInit(
  80287. sqlite3 *db, /* Database connection (for malloc()) */
  80288. int nField, /* Number of key fields in each record */
  80289. VdbeCursor *pCsr /* Cursor that holds the new sorter */
  80290. ){
  80291. int pgsz; /* Page size of main database */
  80292. int i; /* Used to iterate through aTask[] */
  80293. VdbeSorter *pSorter; /* The new sorter */
  80294. KeyInfo *pKeyInfo; /* Copy of pCsr->pKeyInfo with db==0 */
  80295. int szKeyInfo; /* Size of pCsr->pKeyInfo in bytes */
  80296. int sz; /* Size of pSorter in bytes */
  80297. int rc = SQLITE_OK;
  80298. #if SQLITE_MAX_WORKER_THREADS==0
  80299. # define nWorker 0
  80300. #else
  80301. int nWorker;
  80302. #endif
  80303. /* Initialize the upper limit on the number of worker threads */
  80304. #if SQLITE_MAX_WORKER_THREADS>0
  80305. if( sqlite3TempInMemory(db) || sqlite3GlobalConfig.bCoreMutex==0 ){
  80306. nWorker = 0;
  80307. }else{
  80308. nWorker = db->aLimit[SQLITE_LIMIT_WORKER_THREADS];
  80309. }
  80310. #endif
  80311. /* Do not allow the total number of threads (main thread + all workers)
  80312. ** to exceed the maximum merge count */
  80313. #if SQLITE_MAX_WORKER_THREADS>=SORTER_MAX_MERGE_COUNT
  80314. if( nWorker>=SORTER_MAX_MERGE_COUNT ){
  80315. nWorker = SORTER_MAX_MERGE_COUNT-1;
  80316. }
  80317. #endif
  80318. assert( pCsr->pKeyInfo && pCsr->pBt==0 );
  80319. assert( pCsr->eCurType==CURTYPE_SORTER );
  80320. szKeyInfo = sizeof(KeyInfo) + (pCsr->pKeyInfo->nField-1)*sizeof(CollSeq*);
  80321. sz = sizeof(VdbeSorter) + nWorker * sizeof(SortSubtask);
  80322. pSorter = (VdbeSorter*)sqlite3DbMallocZero(db, sz + szKeyInfo);
  80323. pCsr->uc.pSorter = pSorter;
  80324. if( pSorter==0 ){
  80325. rc = SQLITE_NOMEM_BKPT;
  80326. }else{
  80327. pSorter->pKeyInfo = pKeyInfo = (KeyInfo*)((u8*)pSorter + sz);
  80328. memcpy(pKeyInfo, pCsr->pKeyInfo, szKeyInfo);
  80329. pKeyInfo->db = 0;
  80330. if( nField && nWorker==0 ){
  80331. pKeyInfo->nXField += (pKeyInfo->nField - nField);
  80332. pKeyInfo->nField = nField;
  80333. }
  80334. pSorter->pgsz = pgsz = sqlite3BtreeGetPageSize(db->aDb[0].pBt);
  80335. pSorter->nTask = nWorker + 1;
  80336. pSorter->iPrev = (u8)(nWorker - 1);
  80337. pSorter->bUseThreads = (pSorter->nTask>1);
  80338. pSorter->db = db;
  80339. for(i=0; i<pSorter->nTask; i++){
  80340. SortSubtask *pTask = &pSorter->aTask[i];
  80341. pTask->pSorter = pSorter;
  80342. }
  80343. if( !sqlite3TempInMemory(db) ){
  80344. i64 mxCache; /* Cache size in bytes*/
  80345. u32 szPma = sqlite3GlobalConfig.szPma;
  80346. pSorter->mnPmaSize = szPma * pgsz;
  80347. mxCache = db->aDb[0].pSchema->cache_size;
  80348. if( mxCache<0 ){
  80349. /* A negative cache-size value C indicates that the cache is abs(C)
  80350. ** KiB in size. */
  80351. mxCache = mxCache * -1024;
  80352. }else{
  80353. mxCache = mxCache * pgsz;
  80354. }
  80355. mxCache = MIN(mxCache, SQLITE_MAX_PMASZ);
  80356. pSorter->mxPmaSize = MAX(pSorter->mnPmaSize, (int)mxCache);
  80357. /* EVIDENCE-OF: R-26747-61719 When the application provides any amount of
  80358. ** scratch memory using SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary
  80359. ** large heap allocations.
  80360. */
  80361. if( sqlite3GlobalConfig.pScratch==0 ){
  80362. assert( pSorter->iMemory==0 );
  80363. pSorter->nMemory = pgsz;
  80364. pSorter->list.aMemory = (u8*)sqlite3Malloc(pgsz);
  80365. if( !pSorter->list.aMemory ) rc = SQLITE_NOMEM_BKPT;
  80366. }
  80367. }
  80368. if( (pKeyInfo->nField+pKeyInfo->nXField)<13
  80369. && (pKeyInfo->aColl[0]==0 || pKeyInfo->aColl[0]==db->pDfltColl)
  80370. ){
  80371. pSorter->typeMask = SORTER_TYPE_INTEGER | SORTER_TYPE_TEXT;
  80372. }
  80373. }
  80374. return rc;
  80375. }
  80376. #undef nWorker /* Defined at the top of this function */
  80377. /*
  80378. ** Free the list of sorted records starting at pRecord.
  80379. */
  80380. static void vdbeSorterRecordFree(sqlite3 *db, SorterRecord *pRecord){
  80381. SorterRecord *p;
  80382. SorterRecord *pNext;
  80383. for(p=pRecord; p; p=pNext){
  80384. pNext = p->u.pNext;
  80385. sqlite3DbFree(db, p);
  80386. }
  80387. }
  80388. /*
  80389. ** Free all resources owned by the object indicated by argument pTask. All
  80390. ** fields of *pTask are zeroed before returning.
  80391. */
  80392. static void vdbeSortSubtaskCleanup(sqlite3 *db, SortSubtask *pTask){
  80393. sqlite3DbFree(db, pTask->pUnpacked);
  80394. #if SQLITE_MAX_WORKER_THREADS>0
  80395. /* pTask->list.aMemory can only be non-zero if it was handed memory
  80396. ** from the main thread. That only occurs SQLITE_MAX_WORKER_THREADS>0 */
  80397. if( pTask->list.aMemory ){
  80398. sqlite3_free(pTask->list.aMemory);
  80399. }else
  80400. #endif
  80401. {
  80402. assert( pTask->list.aMemory==0 );
  80403. vdbeSorterRecordFree(0, pTask->list.pList);
  80404. }
  80405. if( pTask->file.pFd ){
  80406. sqlite3OsCloseFree(pTask->file.pFd);
  80407. }
  80408. if( pTask->file2.pFd ){
  80409. sqlite3OsCloseFree(pTask->file2.pFd);
  80410. }
  80411. memset(pTask, 0, sizeof(SortSubtask));
  80412. }
  80413. #ifdef SQLITE_DEBUG_SORTER_THREADS
  80414. static void vdbeSorterWorkDebug(SortSubtask *pTask, const char *zEvent){
  80415. i64 t;
  80416. int iTask = (pTask - pTask->pSorter->aTask);
  80417. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  80418. fprintf(stderr, "%lld:%d %s\n", t, iTask, zEvent);
  80419. }
  80420. static void vdbeSorterRewindDebug(const char *zEvent){
  80421. i64 t;
  80422. sqlite3OsCurrentTimeInt64(sqlite3_vfs_find(0), &t);
  80423. fprintf(stderr, "%lld:X %s\n", t, zEvent);
  80424. }
  80425. static void vdbeSorterPopulateDebug(
  80426. SortSubtask *pTask,
  80427. const char *zEvent
  80428. ){
  80429. i64 t;
  80430. int iTask = (pTask - pTask->pSorter->aTask);
  80431. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  80432. fprintf(stderr, "%lld:bg%d %s\n", t, iTask, zEvent);
  80433. }
  80434. static void vdbeSorterBlockDebug(
  80435. SortSubtask *pTask,
  80436. int bBlocked,
  80437. const char *zEvent
  80438. ){
  80439. if( bBlocked ){
  80440. i64 t;
  80441. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  80442. fprintf(stderr, "%lld:main %s\n", t, zEvent);
  80443. }
  80444. }
  80445. #else
  80446. # define vdbeSorterWorkDebug(x,y)
  80447. # define vdbeSorterRewindDebug(y)
  80448. # define vdbeSorterPopulateDebug(x,y)
  80449. # define vdbeSorterBlockDebug(x,y,z)
  80450. #endif
  80451. #if SQLITE_MAX_WORKER_THREADS>0
  80452. /*
  80453. ** Join thread pTask->thread.
  80454. */
  80455. static int vdbeSorterJoinThread(SortSubtask *pTask){
  80456. int rc = SQLITE_OK;
  80457. if( pTask->pThread ){
  80458. #ifdef SQLITE_DEBUG_SORTER_THREADS
  80459. int bDone = pTask->bDone;
  80460. #endif
  80461. void *pRet = SQLITE_INT_TO_PTR(SQLITE_ERROR);
  80462. vdbeSorterBlockDebug(pTask, !bDone, "enter");
  80463. (void)sqlite3ThreadJoin(pTask->pThread, &pRet);
  80464. vdbeSorterBlockDebug(pTask, !bDone, "exit");
  80465. rc = SQLITE_PTR_TO_INT(pRet);
  80466. assert( pTask->bDone==1 );
  80467. pTask->bDone = 0;
  80468. pTask->pThread = 0;
  80469. }
  80470. return rc;
  80471. }
  80472. /*
  80473. ** Launch a background thread to run xTask(pIn).
  80474. */
  80475. static int vdbeSorterCreateThread(
  80476. SortSubtask *pTask, /* Thread will use this task object */
  80477. void *(*xTask)(void*), /* Routine to run in a separate thread */
  80478. void *pIn /* Argument passed into xTask() */
  80479. ){
  80480. assert( pTask->pThread==0 && pTask->bDone==0 );
  80481. return sqlite3ThreadCreate(&pTask->pThread, xTask, pIn);
  80482. }
  80483. /*
  80484. ** Join all outstanding threads launched by SorterWrite() to create
  80485. ** level-0 PMAs.
  80486. */
  80487. static int vdbeSorterJoinAll(VdbeSorter *pSorter, int rcin){
  80488. int rc = rcin;
  80489. int i;
  80490. /* This function is always called by the main user thread.
  80491. **
  80492. ** If this function is being called after SorterRewind() has been called,
  80493. ** it is possible that thread pSorter->aTask[pSorter->nTask-1].pThread
  80494. ** is currently attempt to join one of the other threads. To avoid a race
  80495. ** condition where this thread also attempts to join the same object, join
  80496. ** thread pSorter->aTask[pSorter->nTask-1].pThread first. */
  80497. for(i=pSorter->nTask-1; i>=0; i--){
  80498. SortSubtask *pTask = &pSorter->aTask[i];
  80499. int rc2 = vdbeSorterJoinThread(pTask);
  80500. if( rc==SQLITE_OK ) rc = rc2;
  80501. }
  80502. return rc;
  80503. }
  80504. #else
  80505. # define vdbeSorterJoinAll(x,rcin) (rcin)
  80506. # define vdbeSorterJoinThread(pTask) SQLITE_OK
  80507. #endif
  80508. /*
  80509. ** Allocate a new MergeEngine object capable of handling up to
  80510. ** nReader PmaReader inputs.
  80511. **
  80512. ** nReader is automatically rounded up to the next power of two.
  80513. ** nReader may not exceed SORTER_MAX_MERGE_COUNT even after rounding up.
  80514. */
  80515. static MergeEngine *vdbeMergeEngineNew(int nReader){
  80516. int N = 2; /* Smallest power of two >= nReader */
  80517. int nByte; /* Total bytes of space to allocate */
  80518. MergeEngine *pNew; /* Pointer to allocated object to return */
  80519. assert( nReader<=SORTER_MAX_MERGE_COUNT );
  80520. while( N<nReader ) N += N;
  80521. nByte = sizeof(MergeEngine) + N * (sizeof(int) + sizeof(PmaReader));
  80522. pNew = sqlite3FaultSim(100) ? 0 : (MergeEngine*)sqlite3MallocZero(nByte);
  80523. if( pNew ){
  80524. pNew->nTree = N;
  80525. pNew->pTask = 0;
  80526. pNew->aReadr = (PmaReader*)&pNew[1];
  80527. pNew->aTree = (int*)&pNew->aReadr[N];
  80528. }
  80529. return pNew;
  80530. }
  80531. /*
  80532. ** Free the MergeEngine object passed as the only argument.
  80533. */
  80534. static void vdbeMergeEngineFree(MergeEngine *pMerger){
  80535. int i;
  80536. if( pMerger ){
  80537. for(i=0; i<pMerger->nTree; i++){
  80538. vdbePmaReaderClear(&pMerger->aReadr[i]);
  80539. }
  80540. }
  80541. sqlite3_free(pMerger);
  80542. }
  80543. /*
  80544. ** Free all resources associated with the IncrMerger object indicated by
  80545. ** the first argument.
  80546. */
  80547. static void vdbeIncrFree(IncrMerger *pIncr){
  80548. if( pIncr ){
  80549. #if SQLITE_MAX_WORKER_THREADS>0
  80550. if( pIncr->bUseThread ){
  80551. vdbeSorterJoinThread(pIncr->pTask);
  80552. if( pIncr->aFile[0].pFd ) sqlite3OsCloseFree(pIncr->aFile[0].pFd);
  80553. if( pIncr->aFile[1].pFd ) sqlite3OsCloseFree(pIncr->aFile[1].pFd);
  80554. }
  80555. #endif
  80556. vdbeMergeEngineFree(pIncr->pMerger);
  80557. sqlite3_free(pIncr);
  80558. }
  80559. }
  80560. /*
  80561. ** Reset a sorting cursor back to its original empty state.
  80562. */
  80563. SQLITE_PRIVATE void sqlite3VdbeSorterReset(sqlite3 *db, VdbeSorter *pSorter){
  80564. int i;
  80565. (void)vdbeSorterJoinAll(pSorter, SQLITE_OK);
  80566. assert( pSorter->bUseThreads || pSorter->pReader==0 );
  80567. #if SQLITE_MAX_WORKER_THREADS>0
  80568. if( pSorter->pReader ){
  80569. vdbePmaReaderClear(pSorter->pReader);
  80570. sqlite3DbFree(db, pSorter->pReader);
  80571. pSorter->pReader = 0;
  80572. }
  80573. #endif
  80574. vdbeMergeEngineFree(pSorter->pMerger);
  80575. pSorter->pMerger = 0;
  80576. for(i=0; i<pSorter->nTask; i++){
  80577. SortSubtask *pTask = &pSorter->aTask[i];
  80578. vdbeSortSubtaskCleanup(db, pTask);
  80579. pTask->pSorter = pSorter;
  80580. }
  80581. if( pSorter->list.aMemory==0 ){
  80582. vdbeSorterRecordFree(0, pSorter->list.pList);
  80583. }
  80584. pSorter->list.pList = 0;
  80585. pSorter->list.szPMA = 0;
  80586. pSorter->bUsePMA = 0;
  80587. pSorter->iMemory = 0;
  80588. pSorter->mxKeysize = 0;
  80589. sqlite3DbFree(db, pSorter->pUnpacked);
  80590. pSorter->pUnpacked = 0;
  80591. }
  80592. /*
  80593. ** Free any cursor components allocated by sqlite3VdbeSorterXXX routines.
  80594. */
  80595. SQLITE_PRIVATE void sqlite3VdbeSorterClose(sqlite3 *db, VdbeCursor *pCsr){
  80596. VdbeSorter *pSorter;
  80597. assert( pCsr->eCurType==CURTYPE_SORTER );
  80598. pSorter = pCsr->uc.pSorter;
  80599. if( pSorter ){
  80600. sqlite3VdbeSorterReset(db, pSorter);
  80601. sqlite3_free(pSorter->list.aMemory);
  80602. sqlite3DbFree(db, pSorter);
  80603. pCsr->uc.pSorter = 0;
  80604. }
  80605. }
  80606. #if SQLITE_MAX_MMAP_SIZE>0
  80607. /*
  80608. ** The first argument is a file-handle open on a temporary file. The file
  80609. ** is guaranteed to be nByte bytes or smaller in size. This function
  80610. ** attempts to extend the file to nByte bytes in size and to ensure that
  80611. ** the VFS has memory mapped it.
  80612. **
  80613. ** Whether or not the file does end up memory mapped of course depends on
  80614. ** the specific VFS implementation.
  80615. */
  80616. static void vdbeSorterExtendFile(sqlite3 *db, sqlite3_file *pFd, i64 nByte){
  80617. if( nByte<=(i64)(db->nMaxSorterMmap) && pFd->pMethods->iVersion>=3 ){
  80618. void *p = 0;
  80619. int chunksize = 4*1024;
  80620. sqlite3OsFileControlHint(pFd, SQLITE_FCNTL_CHUNK_SIZE, &chunksize);
  80621. sqlite3OsFileControlHint(pFd, SQLITE_FCNTL_SIZE_HINT, &nByte);
  80622. sqlite3OsFetch(pFd, 0, (int)nByte, &p);
  80623. sqlite3OsUnfetch(pFd, 0, p);
  80624. }
  80625. }
  80626. #else
  80627. # define vdbeSorterExtendFile(x,y,z)
  80628. #endif
  80629. /*
  80630. ** Allocate space for a file-handle and open a temporary file. If successful,
  80631. ** set *ppFd to point to the malloc'd file-handle and return SQLITE_OK.
  80632. ** Otherwise, set *ppFd to 0 and return an SQLite error code.
  80633. */
  80634. static int vdbeSorterOpenTempFile(
  80635. sqlite3 *db, /* Database handle doing sort */
  80636. i64 nExtend, /* Attempt to extend file to this size */
  80637. sqlite3_file **ppFd
  80638. ){
  80639. int rc;
  80640. if( sqlite3FaultSim(202) ) return SQLITE_IOERR_ACCESS;
  80641. rc = sqlite3OsOpenMalloc(db->pVfs, 0, ppFd,
  80642. SQLITE_OPEN_TEMP_JOURNAL |
  80643. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  80644. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE, &rc
  80645. );
  80646. if( rc==SQLITE_OK ){
  80647. i64 max = SQLITE_MAX_MMAP_SIZE;
  80648. sqlite3OsFileControlHint(*ppFd, SQLITE_FCNTL_MMAP_SIZE, (void*)&max);
  80649. if( nExtend>0 ){
  80650. vdbeSorterExtendFile(db, *ppFd, nExtend);
  80651. }
  80652. }
  80653. return rc;
  80654. }
  80655. /*
  80656. ** If it has not already been allocated, allocate the UnpackedRecord
  80657. ** structure at pTask->pUnpacked. Return SQLITE_OK if successful (or
  80658. ** if no allocation was required), or SQLITE_NOMEM otherwise.
  80659. */
  80660. static int vdbeSortAllocUnpacked(SortSubtask *pTask){
  80661. if( pTask->pUnpacked==0 ){
  80662. char *pFree;
  80663. pTask->pUnpacked = sqlite3VdbeAllocUnpackedRecord(
  80664. pTask->pSorter->pKeyInfo, 0, 0, &pFree
  80665. );
  80666. assert( pTask->pUnpacked==(UnpackedRecord*)pFree );
  80667. if( pFree==0 ) return SQLITE_NOMEM_BKPT;
  80668. pTask->pUnpacked->nField = pTask->pSorter->pKeyInfo->nField;
  80669. pTask->pUnpacked->errCode = 0;
  80670. }
  80671. return SQLITE_OK;
  80672. }
  80673. /*
  80674. ** Merge the two sorted lists p1 and p2 into a single list.
  80675. */
  80676. static SorterRecord *vdbeSorterMerge(
  80677. SortSubtask *pTask, /* Calling thread context */
  80678. SorterRecord *p1, /* First list to merge */
  80679. SorterRecord *p2 /* Second list to merge */
  80680. ){
  80681. SorterRecord *pFinal = 0;
  80682. SorterRecord **pp = &pFinal;
  80683. int bCached = 0;
  80684. assert( p1!=0 && p2!=0 );
  80685. for(;;){
  80686. int res;
  80687. res = pTask->xCompare(
  80688. pTask, &bCached, SRVAL(p1), p1->nVal, SRVAL(p2), p2->nVal
  80689. );
  80690. if( res<=0 ){
  80691. *pp = p1;
  80692. pp = &p1->u.pNext;
  80693. p1 = p1->u.pNext;
  80694. if( p1==0 ){
  80695. *pp = p2;
  80696. break;
  80697. }
  80698. }else{
  80699. *pp = p2;
  80700. pp = &p2->u.pNext;
  80701. p2 = p2->u.pNext;
  80702. bCached = 0;
  80703. if( p2==0 ){
  80704. *pp = p1;
  80705. break;
  80706. }
  80707. }
  80708. }
  80709. return pFinal;
  80710. }
  80711. /*
  80712. ** Return the SorterCompare function to compare values collected by the
  80713. ** sorter object passed as the only argument.
  80714. */
  80715. static SorterCompare vdbeSorterGetCompare(VdbeSorter *p){
  80716. if( p->typeMask==SORTER_TYPE_INTEGER ){
  80717. return vdbeSorterCompareInt;
  80718. }else if( p->typeMask==SORTER_TYPE_TEXT ){
  80719. return vdbeSorterCompareText;
  80720. }
  80721. return vdbeSorterCompare;
  80722. }
  80723. /*
  80724. ** Sort the linked list of records headed at pTask->pList. Return
  80725. ** SQLITE_OK if successful, or an SQLite error code (i.e. SQLITE_NOMEM) if
  80726. ** an error occurs.
  80727. */
  80728. static int vdbeSorterSort(SortSubtask *pTask, SorterList *pList){
  80729. int i;
  80730. SorterRecord **aSlot;
  80731. SorterRecord *p;
  80732. int rc;
  80733. rc = vdbeSortAllocUnpacked(pTask);
  80734. if( rc!=SQLITE_OK ) return rc;
  80735. p = pList->pList;
  80736. pTask->xCompare = vdbeSorterGetCompare(pTask->pSorter);
  80737. aSlot = (SorterRecord **)sqlite3MallocZero(64 * sizeof(SorterRecord *));
  80738. if( !aSlot ){
  80739. return SQLITE_NOMEM_BKPT;
  80740. }
  80741. while( p ){
  80742. SorterRecord *pNext;
  80743. if( pList->aMemory ){
  80744. if( (u8*)p==pList->aMemory ){
  80745. pNext = 0;
  80746. }else{
  80747. assert( p->u.iNext<sqlite3MallocSize(pList->aMemory) );
  80748. pNext = (SorterRecord*)&pList->aMemory[p->u.iNext];
  80749. }
  80750. }else{
  80751. pNext = p->u.pNext;
  80752. }
  80753. p->u.pNext = 0;
  80754. for(i=0; aSlot[i]; i++){
  80755. p = vdbeSorterMerge(pTask, p, aSlot[i]);
  80756. aSlot[i] = 0;
  80757. }
  80758. aSlot[i] = p;
  80759. p = pNext;
  80760. }
  80761. p = 0;
  80762. for(i=0; i<64; i++){
  80763. if( aSlot[i]==0 ) continue;
  80764. p = p ? vdbeSorterMerge(pTask, p, aSlot[i]) : aSlot[i];
  80765. }
  80766. pList->pList = p;
  80767. sqlite3_free(aSlot);
  80768. assert( pTask->pUnpacked->errCode==SQLITE_OK
  80769. || pTask->pUnpacked->errCode==SQLITE_NOMEM
  80770. );
  80771. return pTask->pUnpacked->errCode;
  80772. }
  80773. /*
  80774. ** Initialize a PMA-writer object.
  80775. */
  80776. static void vdbePmaWriterInit(
  80777. sqlite3_file *pFd, /* File handle to write to */
  80778. PmaWriter *p, /* Object to populate */
  80779. int nBuf, /* Buffer size */
  80780. i64 iStart /* Offset of pFd to begin writing at */
  80781. ){
  80782. memset(p, 0, sizeof(PmaWriter));
  80783. p->aBuffer = (u8*)sqlite3Malloc(nBuf);
  80784. if( !p->aBuffer ){
  80785. p->eFWErr = SQLITE_NOMEM_BKPT;
  80786. }else{
  80787. p->iBufEnd = p->iBufStart = (iStart % nBuf);
  80788. p->iWriteOff = iStart - p->iBufStart;
  80789. p->nBuffer = nBuf;
  80790. p->pFd = pFd;
  80791. }
  80792. }
  80793. /*
  80794. ** Write nData bytes of data to the PMA. Return SQLITE_OK
  80795. ** if successful, or an SQLite error code if an error occurs.
  80796. */
  80797. static void vdbePmaWriteBlob(PmaWriter *p, u8 *pData, int nData){
  80798. int nRem = nData;
  80799. while( nRem>0 && p->eFWErr==0 ){
  80800. int nCopy = nRem;
  80801. if( nCopy>(p->nBuffer - p->iBufEnd) ){
  80802. nCopy = p->nBuffer - p->iBufEnd;
  80803. }
  80804. memcpy(&p->aBuffer[p->iBufEnd], &pData[nData-nRem], nCopy);
  80805. p->iBufEnd += nCopy;
  80806. if( p->iBufEnd==p->nBuffer ){
  80807. p->eFWErr = sqlite3OsWrite(p->pFd,
  80808. &p->aBuffer[p->iBufStart], p->iBufEnd - p->iBufStart,
  80809. p->iWriteOff + p->iBufStart
  80810. );
  80811. p->iBufStart = p->iBufEnd = 0;
  80812. p->iWriteOff += p->nBuffer;
  80813. }
  80814. assert( p->iBufEnd<p->nBuffer );
  80815. nRem -= nCopy;
  80816. }
  80817. }
  80818. /*
  80819. ** Flush any buffered data to disk and clean up the PMA-writer object.
  80820. ** The results of using the PMA-writer after this call are undefined.
  80821. ** Return SQLITE_OK if flushing the buffered data succeeds or is not
  80822. ** required. Otherwise, return an SQLite error code.
  80823. **
  80824. ** Before returning, set *piEof to the offset immediately following the
  80825. ** last byte written to the file.
  80826. */
  80827. static int vdbePmaWriterFinish(PmaWriter *p, i64 *piEof){
  80828. int rc;
  80829. if( p->eFWErr==0 && ALWAYS(p->aBuffer) && p->iBufEnd>p->iBufStart ){
  80830. p->eFWErr = sqlite3OsWrite(p->pFd,
  80831. &p->aBuffer[p->iBufStart], p->iBufEnd - p->iBufStart,
  80832. p->iWriteOff + p->iBufStart
  80833. );
  80834. }
  80835. *piEof = (p->iWriteOff + p->iBufEnd);
  80836. sqlite3_free(p->aBuffer);
  80837. rc = p->eFWErr;
  80838. memset(p, 0, sizeof(PmaWriter));
  80839. return rc;
  80840. }
  80841. /*
  80842. ** Write value iVal encoded as a varint to the PMA. Return
  80843. ** SQLITE_OK if successful, or an SQLite error code if an error occurs.
  80844. */
  80845. static void vdbePmaWriteVarint(PmaWriter *p, u64 iVal){
  80846. int nByte;
  80847. u8 aByte[10];
  80848. nByte = sqlite3PutVarint(aByte, iVal);
  80849. vdbePmaWriteBlob(p, aByte, nByte);
  80850. }
  80851. /*
  80852. ** Write the current contents of in-memory linked-list pList to a level-0
  80853. ** PMA in the temp file belonging to sub-task pTask. Return SQLITE_OK if
  80854. ** successful, or an SQLite error code otherwise.
  80855. **
  80856. ** The format of a PMA is:
  80857. **
  80858. ** * A varint. This varint contains the total number of bytes of content
  80859. ** in the PMA (not including the varint itself).
  80860. **
  80861. ** * One or more records packed end-to-end in order of ascending keys.
  80862. ** Each record consists of a varint followed by a blob of data (the
  80863. ** key). The varint is the number of bytes in the blob of data.
  80864. */
  80865. static int vdbeSorterListToPMA(SortSubtask *pTask, SorterList *pList){
  80866. sqlite3 *db = pTask->pSorter->db;
  80867. int rc = SQLITE_OK; /* Return code */
  80868. PmaWriter writer; /* Object used to write to the file */
  80869. #ifdef SQLITE_DEBUG
  80870. /* Set iSz to the expected size of file pTask->file after writing the PMA.
  80871. ** This is used by an assert() statement at the end of this function. */
  80872. i64 iSz = pList->szPMA + sqlite3VarintLen(pList->szPMA) + pTask->file.iEof;
  80873. #endif
  80874. vdbeSorterWorkDebug(pTask, "enter");
  80875. memset(&writer, 0, sizeof(PmaWriter));
  80876. assert( pList->szPMA>0 );
  80877. /* If the first temporary PMA file has not been opened, open it now. */
  80878. if( pTask->file.pFd==0 ){
  80879. rc = vdbeSorterOpenTempFile(db, 0, &pTask->file.pFd);
  80880. assert( rc!=SQLITE_OK || pTask->file.pFd );
  80881. assert( pTask->file.iEof==0 );
  80882. assert( pTask->nPMA==0 );
  80883. }
  80884. /* Try to get the file to memory map */
  80885. if( rc==SQLITE_OK ){
  80886. vdbeSorterExtendFile(db, pTask->file.pFd, pTask->file.iEof+pList->szPMA+9);
  80887. }
  80888. /* Sort the list */
  80889. if( rc==SQLITE_OK ){
  80890. rc = vdbeSorterSort(pTask, pList);
  80891. }
  80892. if( rc==SQLITE_OK ){
  80893. SorterRecord *p;
  80894. SorterRecord *pNext = 0;
  80895. vdbePmaWriterInit(pTask->file.pFd, &writer, pTask->pSorter->pgsz,
  80896. pTask->file.iEof);
  80897. pTask->nPMA++;
  80898. vdbePmaWriteVarint(&writer, pList->szPMA);
  80899. for(p=pList->pList; p; p=pNext){
  80900. pNext = p->u.pNext;
  80901. vdbePmaWriteVarint(&writer, p->nVal);
  80902. vdbePmaWriteBlob(&writer, SRVAL(p), p->nVal);
  80903. if( pList->aMemory==0 ) sqlite3_free(p);
  80904. }
  80905. pList->pList = p;
  80906. rc = vdbePmaWriterFinish(&writer, &pTask->file.iEof);
  80907. }
  80908. vdbeSorterWorkDebug(pTask, "exit");
  80909. assert( rc!=SQLITE_OK || pList->pList==0 );
  80910. assert( rc!=SQLITE_OK || pTask->file.iEof==iSz );
  80911. return rc;
  80912. }
  80913. /*
  80914. ** Advance the MergeEngine to its next entry.
  80915. ** Set *pbEof to true there is no next entry because
  80916. ** the MergeEngine has reached the end of all its inputs.
  80917. **
  80918. ** Return SQLITE_OK if successful or an error code if an error occurs.
  80919. */
  80920. static int vdbeMergeEngineStep(
  80921. MergeEngine *pMerger, /* The merge engine to advance to the next row */
  80922. int *pbEof /* Set TRUE at EOF. Set false for more content */
  80923. ){
  80924. int rc;
  80925. int iPrev = pMerger->aTree[1];/* Index of PmaReader to advance */
  80926. SortSubtask *pTask = pMerger->pTask;
  80927. /* Advance the current PmaReader */
  80928. rc = vdbePmaReaderNext(&pMerger->aReadr[iPrev]);
  80929. /* Update contents of aTree[] */
  80930. if( rc==SQLITE_OK ){
  80931. int i; /* Index of aTree[] to recalculate */
  80932. PmaReader *pReadr1; /* First PmaReader to compare */
  80933. PmaReader *pReadr2; /* Second PmaReader to compare */
  80934. int bCached = 0;
  80935. /* Find the first two PmaReaders to compare. The one that was just
  80936. ** advanced (iPrev) and the one next to it in the array. */
  80937. pReadr1 = &pMerger->aReadr[(iPrev & 0xFFFE)];
  80938. pReadr2 = &pMerger->aReadr[(iPrev | 0x0001)];
  80939. for(i=(pMerger->nTree+iPrev)/2; i>0; i=i/2){
  80940. /* Compare pReadr1 and pReadr2. Store the result in variable iRes. */
  80941. int iRes;
  80942. if( pReadr1->pFd==0 ){
  80943. iRes = +1;
  80944. }else if( pReadr2->pFd==0 ){
  80945. iRes = -1;
  80946. }else{
  80947. iRes = pTask->xCompare(pTask, &bCached,
  80948. pReadr1->aKey, pReadr1->nKey, pReadr2->aKey, pReadr2->nKey
  80949. );
  80950. }
  80951. /* If pReadr1 contained the smaller value, set aTree[i] to its index.
  80952. ** Then set pReadr2 to the next PmaReader to compare to pReadr1. In this
  80953. ** case there is no cache of pReadr2 in pTask->pUnpacked, so set
  80954. ** pKey2 to point to the record belonging to pReadr2.
  80955. **
  80956. ** Alternatively, if pReadr2 contains the smaller of the two values,
  80957. ** set aTree[i] to its index and update pReadr1. If vdbeSorterCompare()
  80958. ** was actually called above, then pTask->pUnpacked now contains
  80959. ** a value equivalent to pReadr2. So set pKey2 to NULL to prevent
  80960. ** vdbeSorterCompare() from decoding pReadr2 again.
  80961. **
  80962. ** If the two values were equal, then the value from the oldest
  80963. ** PMA should be considered smaller. The VdbeSorter.aReadr[] array
  80964. ** is sorted from oldest to newest, so pReadr1 contains older values
  80965. ** than pReadr2 iff (pReadr1<pReadr2). */
  80966. if( iRes<0 || (iRes==0 && pReadr1<pReadr2) ){
  80967. pMerger->aTree[i] = (int)(pReadr1 - pMerger->aReadr);
  80968. pReadr2 = &pMerger->aReadr[ pMerger->aTree[i ^ 0x0001] ];
  80969. bCached = 0;
  80970. }else{
  80971. if( pReadr1->pFd ) bCached = 0;
  80972. pMerger->aTree[i] = (int)(pReadr2 - pMerger->aReadr);
  80973. pReadr1 = &pMerger->aReadr[ pMerger->aTree[i ^ 0x0001] ];
  80974. }
  80975. }
  80976. *pbEof = (pMerger->aReadr[pMerger->aTree[1]].pFd==0);
  80977. }
  80978. return (rc==SQLITE_OK ? pTask->pUnpacked->errCode : rc);
  80979. }
  80980. #if SQLITE_MAX_WORKER_THREADS>0
  80981. /*
  80982. ** The main routine for background threads that write level-0 PMAs.
  80983. */
  80984. static void *vdbeSorterFlushThread(void *pCtx){
  80985. SortSubtask *pTask = (SortSubtask*)pCtx;
  80986. int rc; /* Return code */
  80987. assert( pTask->bDone==0 );
  80988. rc = vdbeSorterListToPMA(pTask, &pTask->list);
  80989. pTask->bDone = 1;
  80990. return SQLITE_INT_TO_PTR(rc);
  80991. }
  80992. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  80993. /*
  80994. ** Flush the current contents of VdbeSorter.list to a new PMA, possibly
  80995. ** using a background thread.
  80996. */
  80997. static int vdbeSorterFlushPMA(VdbeSorter *pSorter){
  80998. #if SQLITE_MAX_WORKER_THREADS==0
  80999. pSorter->bUsePMA = 1;
  81000. return vdbeSorterListToPMA(&pSorter->aTask[0], &pSorter->list);
  81001. #else
  81002. int rc = SQLITE_OK;
  81003. int i;
  81004. SortSubtask *pTask = 0; /* Thread context used to create new PMA */
  81005. int nWorker = (pSorter->nTask-1);
  81006. /* Set the flag to indicate that at least one PMA has been written.
  81007. ** Or will be, anyhow. */
  81008. pSorter->bUsePMA = 1;
  81009. /* Select a sub-task to sort and flush the current list of in-memory
  81010. ** records to disk. If the sorter is running in multi-threaded mode,
  81011. ** round-robin between the first (pSorter->nTask-1) tasks. Except, if
  81012. ** the background thread from a sub-tasks previous turn is still running,
  81013. ** skip it. If the first (pSorter->nTask-1) sub-tasks are all still busy,
  81014. ** fall back to using the final sub-task. The first (pSorter->nTask-1)
  81015. ** sub-tasks are prefered as they use background threads - the final
  81016. ** sub-task uses the main thread. */
  81017. for(i=0; i<nWorker; i++){
  81018. int iTest = (pSorter->iPrev + i + 1) % nWorker;
  81019. pTask = &pSorter->aTask[iTest];
  81020. if( pTask->bDone ){
  81021. rc = vdbeSorterJoinThread(pTask);
  81022. }
  81023. if( rc!=SQLITE_OK || pTask->pThread==0 ) break;
  81024. }
  81025. if( rc==SQLITE_OK ){
  81026. if( i==nWorker ){
  81027. /* Use the foreground thread for this operation */
  81028. rc = vdbeSorterListToPMA(&pSorter->aTask[nWorker], &pSorter->list);
  81029. }else{
  81030. /* Launch a background thread for this operation */
  81031. u8 *aMem = pTask->list.aMemory;
  81032. void *pCtx = (void*)pTask;
  81033. assert( pTask->pThread==0 && pTask->bDone==0 );
  81034. assert( pTask->list.pList==0 );
  81035. assert( pTask->list.aMemory==0 || pSorter->list.aMemory!=0 );
  81036. pSorter->iPrev = (u8)(pTask - pSorter->aTask);
  81037. pTask->list = pSorter->list;
  81038. pSorter->list.pList = 0;
  81039. pSorter->list.szPMA = 0;
  81040. if( aMem ){
  81041. pSorter->list.aMemory = aMem;
  81042. pSorter->nMemory = sqlite3MallocSize(aMem);
  81043. }else if( pSorter->list.aMemory ){
  81044. pSorter->list.aMemory = sqlite3Malloc(pSorter->nMemory);
  81045. if( !pSorter->list.aMemory ) return SQLITE_NOMEM_BKPT;
  81046. }
  81047. rc = vdbeSorterCreateThread(pTask, vdbeSorterFlushThread, pCtx);
  81048. }
  81049. }
  81050. return rc;
  81051. #endif /* SQLITE_MAX_WORKER_THREADS!=0 */
  81052. }
  81053. /*
  81054. ** Add a record to the sorter.
  81055. */
  81056. SQLITE_PRIVATE int sqlite3VdbeSorterWrite(
  81057. const VdbeCursor *pCsr, /* Sorter cursor */
  81058. Mem *pVal /* Memory cell containing record */
  81059. ){
  81060. VdbeSorter *pSorter;
  81061. int rc = SQLITE_OK; /* Return Code */
  81062. SorterRecord *pNew; /* New list element */
  81063. int bFlush; /* True to flush contents of memory to PMA */
  81064. int nReq; /* Bytes of memory required */
  81065. int nPMA; /* Bytes of PMA space required */
  81066. int t; /* serial type of first record field */
  81067. assert( pCsr->eCurType==CURTYPE_SORTER );
  81068. pSorter = pCsr->uc.pSorter;
  81069. getVarint32((const u8*)&pVal->z[1], t);
  81070. if( t>0 && t<10 && t!=7 ){
  81071. pSorter->typeMask &= SORTER_TYPE_INTEGER;
  81072. }else if( t>10 && (t & 0x01) ){
  81073. pSorter->typeMask &= SORTER_TYPE_TEXT;
  81074. }else{
  81075. pSorter->typeMask = 0;
  81076. }
  81077. assert( pSorter );
  81078. /* Figure out whether or not the current contents of memory should be
  81079. ** flushed to a PMA before continuing. If so, do so.
  81080. **
  81081. ** If using the single large allocation mode (pSorter->aMemory!=0), then
  81082. ** flush the contents of memory to a new PMA if (a) at least one value is
  81083. ** already in memory and (b) the new value will not fit in memory.
  81084. **
  81085. ** Or, if using separate allocations for each record, flush the contents
  81086. ** of memory to a PMA if either of the following are true:
  81087. **
  81088. ** * The total memory allocated for the in-memory list is greater
  81089. ** than (page-size * cache-size), or
  81090. **
  81091. ** * The total memory allocated for the in-memory list is greater
  81092. ** than (page-size * 10) and sqlite3HeapNearlyFull() returns true.
  81093. */
  81094. nReq = pVal->n + sizeof(SorterRecord);
  81095. nPMA = pVal->n + sqlite3VarintLen(pVal->n);
  81096. if( pSorter->mxPmaSize ){
  81097. if( pSorter->list.aMemory ){
  81098. bFlush = pSorter->iMemory && (pSorter->iMemory+nReq) > pSorter->mxPmaSize;
  81099. }else{
  81100. bFlush = (
  81101. (pSorter->list.szPMA > pSorter->mxPmaSize)
  81102. || (pSorter->list.szPMA > pSorter->mnPmaSize && sqlite3HeapNearlyFull())
  81103. );
  81104. }
  81105. if( bFlush ){
  81106. rc = vdbeSorterFlushPMA(pSorter);
  81107. pSorter->list.szPMA = 0;
  81108. pSorter->iMemory = 0;
  81109. assert( rc!=SQLITE_OK || pSorter->list.pList==0 );
  81110. }
  81111. }
  81112. pSorter->list.szPMA += nPMA;
  81113. if( nPMA>pSorter->mxKeysize ){
  81114. pSorter->mxKeysize = nPMA;
  81115. }
  81116. if( pSorter->list.aMemory ){
  81117. int nMin = pSorter->iMemory + nReq;
  81118. if( nMin>pSorter->nMemory ){
  81119. u8 *aNew;
  81120. int iListOff = (u8*)pSorter->list.pList - pSorter->list.aMemory;
  81121. int nNew = pSorter->nMemory * 2;
  81122. while( nNew < nMin ) nNew = nNew*2;
  81123. if( nNew > pSorter->mxPmaSize ) nNew = pSorter->mxPmaSize;
  81124. if( nNew < nMin ) nNew = nMin;
  81125. aNew = sqlite3Realloc(pSorter->list.aMemory, nNew);
  81126. if( !aNew ) return SQLITE_NOMEM_BKPT;
  81127. pSorter->list.pList = (SorterRecord*)&aNew[iListOff];
  81128. pSorter->list.aMemory = aNew;
  81129. pSorter->nMemory = nNew;
  81130. }
  81131. pNew = (SorterRecord*)&pSorter->list.aMemory[pSorter->iMemory];
  81132. pSorter->iMemory += ROUND8(nReq);
  81133. if( pSorter->list.pList ){
  81134. pNew->u.iNext = (int)((u8*)(pSorter->list.pList) - pSorter->list.aMemory);
  81135. }
  81136. }else{
  81137. pNew = (SorterRecord *)sqlite3Malloc(nReq);
  81138. if( pNew==0 ){
  81139. return SQLITE_NOMEM_BKPT;
  81140. }
  81141. pNew->u.pNext = pSorter->list.pList;
  81142. }
  81143. memcpy(SRVAL(pNew), pVal->z, pVal->n);
  81144. pNew->nVal = pVal->n;
  81145. pSorter->list.pList = pNew;
  81146. return rc;
  81147. }
  81148. /*
  81149. ** Read keys from pIncr->pMerger and populate pIncr->aFile[1]. The format
  81150. ** of the data stored in aFile[1] is the same as that used by regular PMAs,
  81151. ** except that the number-of-bytes varint is omitted from the start.
  81152. */
  81153. static int vdbeIncrPopulate(IncrMerger *pIncr){
  81154. int rc = SQLITE_OK;
  81155. int rc2;
  81156. i64 iStart = pIncr->iStartOff;
  81157. SorterFile *pOut = &pIncr->aFile[1];
  81158. SortSubtask *pTask = pIncr->pTask;
  81159. MergeEngine *pMerger = pIncr->pMerger;
  81160. PmaWriter writer;
  81161. assert( pIncr->bEof==0 );
  81162. vdbeSorterPopulateDebug(pTask, "enter");
  81163. vdbePmaWriterInit(pOut->pFd, &writer, pTask->pSorter->pgsz, iStart);
  81164. while( rc==SQLITE_OK ){
  81165. int dummy;
  81166. PmaReader *pReader = &pMerger->aReadr[ pMerger->aTree[1] ];
  81167. int nKey = pReader->nKey;
  81168. i64 iEof = writer.iWriteOff + writer.iBufEnd;
  81169. /* Check if the output file is full or if the input has been exhausted.
  81170. ** In either case exit the loop. */
  81171. if( pReader->pFd==0 ) break;
  81172. if( (iEof + nKey + sqlite3VarintLen(nKey))>(iStart + pIncr->mxSz) ) break;
  81173. /* Write the next key to the output. */
  81174. vdbePmaWriteVarint(&writer, nKey);
  81175. vdbePmaWriteBlob(&writer, pReader->aKey, nKey);
  81176. assert( pIncr->pMerger->pTask==pTask );
  81177. rc = vdbeMergeEngineStep(pIncr->pMerger, &dummy);
  81178. }
  81179. rc2 = vdbePmaWriterFinish(&writer, &pOut->iEof);
  81180. if( rc==SQLITE_OK ) rc = rc2;
  81181. vdbeSorterPopulateDebug(pTask, "exit");
  81182. return rc;
  81183. }
  81184. #if SQLITE_MAX_WORKER_THREADS>0
  81185. /*
  81186. ** The main routine for background threads that populate aFile[1] of
  81187. ** multi-threaded IncrMerger objects.
  81188. */
  81189. static void *vdbeIncrPopulateThread(void *pCtx){
  81190. IncrMerger *pIncr = (IncrMerger*)pCtx;
  81191. void *pRet = SQLITE_INT_TO_PTR( vdbeIncrPopulate(pIncr) );
  81192. pIncr->pTask->bDone = 1;
  81193. return pRet;
  81194. }
  81195. /*
  81196. ** Launch a background thread to populate aFile[1] of pIncr.
  81197. */
  81198. static int vdbeIncrBgPopulate(IncrMerger *pIncr){
  81199. void *p = (void*)pIncr;
  81200. assert( pIncr->bUseThread );
  81201. return vdbeSorterCreateThread(pIncr->pTask, vdbeIncrPopulateThread, p);
  81202. }
  81203. #endif
  81204. /*
  81205. ** This function is called when the PmaReader corresponding to pIncr has
  81206. ** finished reading the contents of aFile[0]. Its purpose is to "refill"
  81207. ** aFile[0] such that the PmaReader should start rereading it from the
  81208. ** beginning.
  81209. **
  81210. ** For single-threaded objects, this is accomplished by literally reading
  81211. ** keys from pIncr->pMerger and repopulating aFile[0].
  81212. **
  81213. ** For multi-threaded objects, all that is required is to wait until the
  81214. ** background thread is finished (if it is not already) and then swap
  81215. ** aFile[0] and aFile[1] in place. If the contents of pMerger have not
  81216. ** been exhausted, this function also launches a new background thread
  81217. ** to populate the new aFile[1].
  81218. **
  81219. ** SQLITE_OK is returned on success, or an SQLite error code otherwise.
  81220. */
  81221. static int vdbeIncrSwap(IncrMerger *pIncr){
  81222. int rc = SQLITE_OK;
  81223. #if SQLITE_MAX_WORKER_THREADS>0
  81224. if( pIncr->bUseThread ){
  81225. rc = vdbeSorterJoinThread(pIncr->pTask);
  81226. if( rc==SQLITE_OK ){
  81227. SorterFile f0 = pIncr->aFile[0];
  81228. pIncr->aFile[0] = pIncr->aFile[1];
  81229. pIncr->aFile[1] = f0;
  81230. }
  81231. if( rc==SQLITE_OK ){
  81232. if( pIncr->aFile[0].iEof==pIncr->iStartOff ){
  81233. pIncr->bEof = 1;
  81234. }else{
  81235. rc = vdbeIncrBgPopulate(pIncr);
  81236. }
  81237. }
  81238. }else
  81239. #endif
  81240. {
  81241. rc = vdbeIncrPopulate(pIncr);
  81242. pIncr->aFile[0] = pIncr->aFile[1];
  81243. if( pIncr->aFile[0].iEof==pIncr->iStartOff ){
  81244. pIncr->bEof = 1;
  81245. }
  81246. }
  81247. return rc;
  81248. }
  81249. /*
  81250. ** Allocate and return a new IncrMerger object to read data from pMerger.
  81251. **
  81252. ** If an OOM condition is encountered, return NULL. In this case free the
  81253. ** pMerger argument before returning.
  81254. */
  81255. static int vdbeIncrMergerNew(
  81256. SortSubtask *pTask, /* The thread that will be using the new IncrMerger */
  81257. MergeEngine *pMerger, /* The MergeEngine that the IncrMerger will control */
  81258. IncrMerger **ppOut /* Write the new IncrMerger here */
  81259. ){
  81260. int rc = SQLITE_OK;
  81261. IncrMerger *pIncr = *ppOut = (IncrMerger*)
  81262. (sqlite3FaultSim(100) ? 0 : sqlite3MallocZero(sizeof(*pIncr)));
  81263. if( pIncr ){
  81264. pIncr->pMerger = pMerger;
  81265. pIncr->pTask = pTask;
  81266. pIncr->mxSz = MAX(pTask->pSorter->mxKeysize+9,pTask->pSorter->mxPmaSize/2);
  81267. pTask->file2.iEof += pIncr->mxSz;
  81268. }else{
  81269. vdbeMergeEngineFree(pMerger);
  81270. rc = SQLITE_NOMEM_BKPT;
  81271. }
  81272. return rc;
  81273. }
  81274. #if SQLITE_MAX_WORKER_THREADS>0
  81275. /*
  81276. ** Set the "use-threads" flag on object pIncr.
  81277. */
  81278. static void vdbeIncrMergerSetThreads(IncrMerger *pIncr){
  81279. pIncr->bUseThread = 1;
  81280. pIncr->pTask->file2.iEof -= pIncr->mxSz;
  81281. }
  81282. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  81283. /*
  81284. ** Recompute pMerger->aTree[iOut] by comparing the next keys on the
  81285. ** two PmaReaders that feed that entry. Neither of the PmaReaders
  81286. ** are advanced. This routine merely does the comparison.
  81287. */
  81288. static void vdbeMergeEngineCompare(
  81289. MergeEngine *pMerger, /* Merge engine containing PmaReaders to compare */
  81290. int iOut /* Store the result in pMerger->aTree[iOut] */
  81291. ){
  81292. int i1;
  81293. int i2;
  81294. int iRes;
  81295. PmaReader *p1;
  81296. PmaReader *p2;
  81297. assert( iOut<pMerger->nTree && iOut>0 );
  81298. if( iOut>=(pMerger->nTree/2) ){
  81299. i1 = (iOut - pMerger->nTree/2) * 2;
  81300. i2 = i1 + 1;
  81301. }else{
  81302. i1 = pMerger->aTree[iOut*2];
  81303. i2 = pMerger->aTree[iOut*2+1];
  81304. }
  81305. p1 = &pMerger->aReadr[i1];
  81306. p2 = &pMerger->aReadr[i2];
  81307. if( p1->pFd==0 ){
  81308. iRes = i2;
  81309. }else if( p2->pFd==0 ){
  81310. iRes = i1;
  81311. }else{
  81312. SortSubtask *pTask = pMerger->pTask;
  81313. int bCached = 0;
  81314. int res;
  81315. assert( pTask->pUnpacked!=0 ); /* from vdbeSortSubtaskMain() */
  81316. res = pTask->xCompare(
  81317. pTask, &bCached, p1->aKey, p1->nKey, p2->aKey, p2->nKey
  81318. );
  81319. if( res<=0 ){
  81320. iRes = i1;
  81321. }else{
  81322. iRes = i2;
  81323. }
  81324. }
  81325. pMerger->aTree[iOut] = iRes;
  81326. }
  81327. /*
  81328. ** Allowed values for the eMode parameter to vdbeMergeEngineInit()
  81329. ** and vdbePmaReaderIncrMergeInit().
  81330. **
  81331. ** Only INCRINIT_NORMAL is valid in single-threaded builds (when
  81332. ** SQLITE_MAX_WORKER_THREADS==0). The other values are only used
  81333. ** when there exists one or more separate worker threads.
  81334. */
  81335. #define INCRINIT_NORMAL 0
  81336. #define INCRINIT_TASK 1
  81337. #define INCRINIT_ROOT 2
  81338. /*
  81339. ** Forward reference required as the vdbeIncrMergeInit() and
  81340. ** vdbePmaReaderIncrInit() routines are called mutually recursively when
  81341. ** building a merge tree.
  81342. */
  81343. static int vdbePmaReaderIncrInit(PmaReader *pReadr, int eMode);
  81344. /*
  81345. ** Initialize the MergeEngine object passed as the second argument. Once this
  81346. ** function returns, the first key of merged data may be read from the
  81347. ** MergeEngine object in the usual fashion.
  81348. **
  81349. ** If argument eMode is INCRINIT_ROOT, then it is assumed that any IncrMerge
  81350. ** objects attached to the PmaReader objects that the merger reads from have
  81351. ** already been populated, but that they have not yet populated aFile[0] and
  81352. ** set the PmaReader objects up to read from it. In this case all that is
  81353. ** required is to call vdbePmaReaderNext() on each PmaReader to point it at
  81354. ** its first key.
  81355. **
  81356. ** Otherwise, if eMode is any value other than INCRINIT_ROOT, then use
  81357. ** vdbePmaReaderIncrMergeInit() to initialize each PmaReader that feeds data
  81358. ** to pMerger.
  81359. **
  81360. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  81361. */
  81362. static int vdbeMergeEngineInit(
  81363. SortSubtask *pTask, /* Thread that will run pMerger */
  81364. MergeEngine *pMerger, /* MergeEngine to initialize */
  81365. int eMode /* One of the INCRINIT_XXX constants */
  81366. ){
  81367. int rc = SQLITE_OK; /* Return code */
  81368. int i; /* For looping over PmaReader objects */
  81369. int nTree = pMerger->nTree;
  81370. /* eMode is always INCRINIT_NORMAL in single-threaded mode */
  81371. assert( SQLITE_MAX_WORKER_THREADS>0 || eMode==INCRINIT_NORMAL );
  81372. /* Verify that the MergeEngine is assigned to a single thread */
  81373. assert( pMerger->pTask==0 );
  81374. pMerger->pTask = pTask;
  81375. for(i=0; i<nTree; i++){
  81376. if( SQLITE_MAX_WORKER_THREADS>0 && eMode==INCRINIT_ROOT ){
  81377. /* PmaReaders should be normally initialized in order, as if they are
  81378. ** reading from the same temp file this makes for more linear file IO.
  81379. ** However, in the INCRINIT_ROOT case, if PmaReader aReadr[nTask-1] is
  81380. ** in use it will block the vdbePmaReaderNext() call while it uses
  81381. ** the main thread to fill its buffer. So calling PmaReaderNext()
  81382. ** on this PmaReader before any of the multi-threaded PmaReaders takes
  81383. ** better advantage of multi-processor hardware. */
  81384. rc = vdbePmaReaderNext(&pMerger->aReadr[nTree-i-1]);
  81385. }else{
  81386. rc = vdbePmaReaderIncrInit(&pMerger->aReadr[i], INCRINIT_NORMAL);
  81387. }
  81388. if( rc!=SQLITE_OK ) return rc;
  81389. }
  81390. for(i=pMerger->nTree-1; i>0; i--){
  81391. vdbeMergeEngineCompare(pMerger, i);
  81392. }
  81393. return pTask->pUnpacked->errCode;
  81394. }
  81395. /*
  81396. ** The PmaReader passed as the first argument is guaranteed to be an
  81397. ** incremental-reader (pReadr->pIncr!=0). This function serves to open
  81398. ** and/or initialize the temp file related fields of the IncrMerge
  81399. ** object at (pReadr->pIncr).
  81400. **
  81401. ** If argument eMode is set to INCRINIT_NORMAL, then all PmaReaders
  81402. ** in the sub-tree headed by pReadr are also initialized. Data is then
  81403. ** loaded into the buffers belonging to pReadr and it is set to point to
  81404. ** the first key in its range.
  81405. **
  81406. ** If argument eMode is set to INCRINIT_TASK, then pReadr is guaranteed
  81407. ** to be a multi-threaded PmaReader and this function is being called in a
  81408. ** background thread. In this case all PmaReaders in the sub-tree are
  81409. ** initialized as for INCRINIT_NORMAL and the aFile[1] buffer belonging to
  81410. ** pReadr is populated. However, pReadr itself is not set up to point
  81411. ** to its first key. A call to vdbePmaReaderNext() is still required to do
  81412. ** that.
  81413. **
  81414. ** The reason this function does not call vdbePmaReaderNext() immediately
  81415. ** in the INCRINIT_TASK case is that vdbePmaReaderNext() assumes that it has
  81416. ** to block on thread (pTask->thread) before accessing aFile[1]. But, since
  81417. ** this entire function is being run by thread (pTask->thread), that will
  81418. ** lead to the current background thread attempting to join itself.
  81419. **
  81420. ** Finally, if argument eMode is set to INCRINIT_ROOT, it may be assumed
  81421. ** that pReadr->pIncr is a multi-threaded IncrMerge objects, and that all
  81422. ** child-trees have already been initialized using IncrInit(INCRINIT_TASK).
  81423. ** In this case vdbePmaReaderNext() is called on all child PmaReaders and
  81424. ** the current PmaReader set to point to the first key in its range.
  81425. **
  81426. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  81427. */
  81428. static int vdbePmaReaderIncrMergeInit(PmaReader *pReadr, int eMode){
  81429. int rc = SQLITE_OK;
  81430. IncrMerger *pIncr = pReadr->pIncr;
  81431. SortSubtask *pTask = pIncr->pTask;
  81432. sqlite3 *db = pTask->pSorter->db;
  81433. /* eMode is always INCRINIT_NORMAL in single-threaded mode */
  81434. assert( SQLITE_MAX_WORKER_THREADS>0 || eMode==INCRINIT_NORMAL );
  81435. rc = vdbeMergeEngineInit(pTask, pIncr->pMerger, eMode);
  81436. /* Set up the required files for pIncr. A multi-theaded IncrMerge object
  81437. ** requires two temp files to itself, whereas a single-threaded object
  81438. ** only requires a region of pTask->file2. */
  81439. if( rc==SQLITE_OK ){
  81440. int mxSz = pIncr->mxSz;
  81441. #if SQLITE_MAX_WORKER_THREADS>0
  81442. if( pIncr->bUseThread ){
  81443. rc = vdbeSorterOpenTempFile(db, mxSz, &pIncr->aFile[0].pFd);
  81444. if( rc==SQLITE_OK ){
  81445. rc = vdbeSorterOpenTempFile(db, mxSz, &pIncr->aFile[1].pFd);
  81446. }
  81447. }else
  81448. #endif
  81449. /*if( !pIncr->bUseThread )*/{
  81450. if( pTask->file2.pFd==0 ){
  81451. assert( pTask->file2.iEof>0 );
  81452. rc = vdbeSorterOpenTempFile(db, pTask->file2.iEof, &pTask->file2.pFd);
  81453. pTask->file2.iEof = 0;
  81454. }
  81455. if( rc==SQLITE_OK ){
  81456. pIncr->aFile[1].pFd = pTask->file2.pFd;
  81457. pIncr->iStartOff = pTask->file2.iEof;
  81458. pTask->file2.iEof += mxSz;
  81459. }
  81460. }
  81461. }
  81462. #if SQLITE_MAX_WORKER_THREADS>0
  81463. if( rc==SQLITE_OK && pIncr->bUseThread ){
  81464. /* Use the current thread to populate aFile[1], even though this
  81465. ** PmaReader is multi-threaded. If this is an INCRINIT_TASK object,
  81466. ** then this function is already running in background thread
  81467. ** pIncr->pTask->thread.
  81468. **
  81469. ** If this is the INCRINIT_ROOT object, then it is running in the
  81470. ** main VDBE thread. But that is Ok, as that thread cannot return
  81471. ** control to the VDBE or proceed with anything useful until the
  81472. ** first results are ready from this merger object anyway.
  81473. */
  81474. assert( eMode==INCRINIT_ROOT || eMode==INCRINIT_TASK );
  81475. rc = vdbeIncrPopulate(pIncr);
  81476. }
  81477. #endif
  81478. if( rc==SQLITE_OK && (SQLITE_MAX_WORKER_THREADS==0 || eMode!=INCRINIT_TASK) ){
  81479. rc = vdbePmaReaderNext(pReadr);
  81480. }
  81481. return rc;
  81482. }
  81483. #if SQLITE_MAX_WORKER_THREADS>0
  81484. /*
  81485. ** The main routine for vdbePmaReaderIncrMergeInit() operations run in
  81486. ** background threads.
  81487. */
  81488. static void *vdbePmaReaderBgIncrInit(void *pCtx){
  81489. PmaReader *pReader = (PmaReader*)pCtx;
  81490. void *pRet = SQLITE_INT_TO_PTR(
  81491. vdbePmaReaderIncrMergeInit(pReader,INCRINIT_TASK)
  81492. );
  81493. pReader->pIncr->pTask->bDone = 1;
  81494. return pRet;
  81495. }
  81496. #endif
  81497. /*
  81498. ** If the PmaReader passed as the first argument is not an incremental-reader
  81499. ** (if pReadr->pIncr==0), then this function is a no-op. Otherwise, it invokes
  81500. ** the vdbePmaReaderIncrMergeInit() function with the parameters passed to
  81501. ** this routine to initialize the incremental merge.
  81502. **
  81503. ** If the IncrMerger object is multi-threaded (IncrMerger.bUseThread==1),
  81504. ** then a background thread is launched to call vdbePmaReaderIncrMergeInit().
  81505. ** Or, if the IncrMerger is single threaded, the same function is called
  81506. ** using the current thread.
  81507. */
  81508. static int vdbePmaReaderIncrInit(PmaReader *pReadr, int eMode){
  81509. IncrMerger *pIncr = pReadr->pIncr; /* Incremental merger */
  81510. int rc = SQLITE_OK; /* Return code */
  81511. if( pIncr ){
  81512. #if SQLITE_MAX_WORKER_THREADS>0
  81513. assert( pIncr->bUseThread==0 || eMode==INCRINIT_TASK );
  81514. if( pIncr->bUseThread ){
  81515. void *pCtx = (void*)pReadr;
  81516. rc = vdbeSorterCreateThread(pIncr->pTask, vdbePmaReaderBgIncrInit, pCtx);
  81517. }else
  81518. #endif
  81519. {
  81520. rc = vdbePmaReaderIncrMergeInit(pReadr, eMode);
  81521. }
  81522. }
  81523. return rc;
  81524. }
  81525. /*
  81526. ** Allocate a new MergeEngine object to merge the contents of nPMA level-0
  81527. ** PMAs from pTask->file. If no error occurs, set *ppOut to point to
  81528. ** the new object and return SQLITE_OK. Or, if an error does occur, set *ppOut
  81529. ** to NULL and return an SQLite error code.
  81530. **
  81531. ** When this function is called, *piOffset is set to the offset of the
  81532. ** first PMA to read from pTask->file. Assuming no error occurs, it is
  81533. ** set to the offset immediately following the last byte of the last
  81534. ** PMA before returning. If an error does occur, then the final value of
  81535. ** *piOffset is undefined.
  81536. */
  81537. static int vdbeMergeEngineLevel0(
  81538. SortSubtask *pTask, /* Sorter task to read from */
  81539. int nPMA, /* Number of PMAs to read */
  81540. i64 *piOffset, /* IN/OUT: Readr offset in pTask->file */
  81541. MergeEngine **ppOut /* OUT: New merge-engine */
  81542. ){
  81543. MergeEngine *pNew; /* Merge engine to return */
  81544. i64 iOff = *piOffset;
  81545. int i;
  81546. int rc = SQLITE_OK;
  81547. *ppOut = pNew = vdbeMergeEngineNew(nPMA);
  81548. if( pNew==0 ) rc = SQLITE_NOMEM_BKPT;
  81549. for(i=0; i<nPMA && rc==SQLITE_OK; i++){
  81550. i64 nDummy = 0;
  81551. PmaReader *pReadr = &pNew->aReadr[i];
  81552. rc = vdbePmaReaderInit(pTask, &pTask->file, iOff, pReadr, &nDummy);
  81553. iOff = pReadr->iEof;
  81554. }
  81555. if( rc!=SQLITE_OK ){
  81556. vdbeMergeEngineFree(pNew);
  81557. *ppOut = 0;
  81558. }
  81559. *piOffset = iOff;
  81560. return rc;
  81561. }
  81562. /*
  81563. ** Return the depth of a tree comprising nPMA PMAs, assuming a fanout of
  81564. ** SORTER_MAX_MERGE_COUNT. The returned value does not include leaf nodes.
  81565. **
  81566. ** i.e.
  81567. **
  81568. ** nPMA<=16 -> TreeDepth() == 0
  81569. ** nPMA<=256 -> TreeDepth() == 1
  81570. ** nPMA<=65536 -> TreeDepth() == 2
  81571. */
  81572. static int vdbeSorterTreeDepth(int nPMA){
  81573. int nDepth = 0;
  81574. i64 nDiv = SORTER_MAX_MERGE_COUNT;
  81575. while( nDiv < (i64)nPMA ){
  81576. nDiv = nDiv * SORTER_MAX_MERGE_COUNT;
  81577. nDepth++;
  81578. }
  81579. return nDepth;
  81580. }
  81581. /*
  81582. ** pRoot is the root of an incremental merge-tree with depth nDepth (according
  81583. ** to vdbeSorterTreeDepth()). pLeaf is the iSeq'th leaf to be added to the
  81584. ** tree, counting from zero. This function adds pLeaf to the tree.
  81585. **
  81586. ** If successful, SQLITE_OK is returned. If an error occurs, an SQLite error
  81587. ** code is returned and pLeaf is freed.
  81588. */
  81589. static int vdbeSorterAddToTree(
  81590. SortSubtask *pTask, /* Task context */
  81591. int nDepth, /* Depth of tree according to TreeDepth() */
  81592. int iSeq, /* Sequence number of leaf within tree */
  81593. MergeEngine *pRoot, /* Root of tree */
  81594. MergeEngine *pLeaf /* Leaf to add to tree */
  81595. ){
  81596. int rc = SQLITE_OK;
  81597. int nDiv = 1;
  81598. int i;
  81599. MergeEngine *p = pRoot;
  81600. IncrMerger *pIncr;
  81601. rc = vdbeIncrMergerNew(pTask, pLeaf, &pIncr);
  81602. for(i=1; i<nDepth; i++){
  81603. nDiv = nDiv * SORTER_MAX_MERGE_COUNT;
  81604. }
  81605. for(i=1; i<nDepth && rc==SQLITE_OK; i++){
  81606. int iIter = (iSeq / nDiv) % SORTER_MAX_MERGE_COUNT;
  81607. PmaReader *pReadr = &p->aReadr[iIter];
  81608. if( pReadr->pIncr==0 ){
  81609. MergeEngine *pNew = vdbeMergeEngineNew(SORTER_MAX_MERGE_COUNT);
  81610. if( pNew==0 ){
  81611. rc = SQLITE_NOMEM_BKPT;
  81612. }else{
  81613. rc = vdbeIncrMergerNew(pTask, pNew, &pReadr->pIncr);
  81614. }
  81615. }
  81616. if( rc==SQLITE_OK ){
  81617. p = pReadr->pIncr->pMerger;
  81618. nDiv = nDiv / SORTER_MAX_MERGE_COUNT;
  81619. }
  81620. }
  81621. if( rc==SQLITE_OK ){
  81622. p->aReadr[iSeq % SORTER_MAX_MERGE_COUNT].pIncr = pIncr;
  81623. }else{
  81624. vdbeIncrFree(pIncr);
  81625. }
  81626. return rc;
  81627. }
  81628. /*
  81629. ** This function is called as part of a SorterRewind() operation on a sorter
  81630. ** that has already written two or more level-0 PMAs to one or more temp
  81631. ** files. It builds a tree of MergeEngine/IncrMerger/PmaReader objects that
  81632. ** can be used to incrementally merge all PMAs on disk.
  81633. **
  81634. ** If successful, SQLITE_OK is returned and *ppOut set to point to the
  81635. ** MergeEngine object at the root of the tree before returning. Or, if an
  81636. ** error occurs, an SQLite error code is returned and the final value
  81637. ** of *ppOut is undefined.
  81638. */
  81639. static int vdbeSorterMergeTreeBuild(
  81640. VdbeSorter *pSorter, /* The VDBE cursor that implements the sort */
  81641. MergeEngine **ppOut /* Write the MergeEngine here */
  81642. ){
  81643. MergeEngine *pMain = 0;
  81644. int rc = SQLITE_OK;
  81645. int iTask;
  81646. #if SQLITE_MAX_WORKER_THREADS>0
  81647. /* If the sorter uses more than one task, then create the top-level
  81648. ** MergeEngine here. This MergeEngine will read data from exactly
  81649. ** one PmaReader per sub-task. */
  81650. assert( pSorter->bUseThreads || pSorter->nTask==1 );
  81651. if( pSorter->nTask>1 ){
  81652. pMain = vdbeMergeEngineNew(pSorter->nTask);
  81653. if( pMain==0 ) rc = SQLITE_NOMEM_BKPT;
  81654. }
  81655. #endif
  81656. for(iTask=0; rc==SQLITE_OK && iTask<pSorter->nTask; iTask++){
  81657. SortSubtask *pTask = &pSorter->aTask[iTask];
  81658. assert( pTask->nPMA>0 || SQLITE_MAX_WORKER_THREADS>0 );
  81659. if( SQLITE_MAX_WORKER_THREADS==0 || pTask->nPMA ){
  81660. MergeEngine *pRoot = 0; /* Root node of tree for this task */
  81661. int nDepth = vdbeSorterTreeDepth(pTask->nPMA);
  81662. i64 iReadOff = 0;
  81663. if( pTask->nPMA<=SORTER_MAX_MERGE_COUNT ){
  81664. rc = vdbeMergeEngineLevel0(pTask, pTask->nPMA, &iReadOff, &pRoot);
  81665. }else{
  81666. int i;
  81667. int iSeq = 0;
  81668. pRoot = vdbeMergeEngineNew(SORTER_MAX_MERGE_COUNT);
  81669. if( pRoot==0 ) rc = SQLITE_NOMEM_BKPT;
  81670. for(i=0; i<pTask->nPMA && rc==SQLITE_OK; i += SORTER_MAX_MERGE_COUNT){
  81671. MergeEngine *pMerger = 0; /* New level-0 PMA merger */
  81672. int nReader; /* Number of level-0 PMAs to merge */
  81673. nReader = MIN(pTask->nPMA - i, SORTER_MAX_MERGE_COUNT);
  81674. rc = vdbeMergeEngineLevel0(pTask, nReader, &iReadOff, &pMerger);
  81675. if( rc==SQLITE_OK ){
  81676. rc = vdbeSorterAddToTree(pTask, nDepth, iSeq++, pRoot, pMerger);
  81677. }
  81678. }
  81679. }
  81680. if( rc==SQLITE_OK ){
  81681. #if SQLITE_MAX_WORKER_THREADS>0
  81682. if( pMain!=0 ){
  81683. rc = vdbeIncrMergerNew(pTask, pRoot, &pMain->aReadr[iTask].pIncr);
  81684. }else
  81685. #endif
  81686. {
  81687. assert( pMain==0 );
  81688. pMain = pRoot;
  81689. }
  81690. }else{
  81691. vdbeMergeEngineFree(pRoot);
  81692. }
  81693. }
  81694. }
  81695. if( rc!=SQLITE_OK ){
  81696. vdbeMergeEngineFree(pMain);
  81697. pMain = 0;
  81698. }
  81699. *ppOut = pMain;
  81700. return rc;
  81701. }
  81702. /*
  81703. ** This function is called as part of an sqlite3VdbeSorterRewind() operation
  81704. ** on a sorter that has written two or more PMAs to temporary files. It sets
  81705. ** up either VdbeSorter.pMerger (for single threaded sorters) or pReader
  81706. ** (for multi-threaded sorters) so that it can be used to iterate through
  81707. ** all records stored in the sorter.
  81708. **
  81709. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  81710. */
  81711. static int vdbeSorterSetupMerge(VdbeSorter *pSorter){
  81712. int rc; /* Return code */
  81713. SortSubtask *pTask0 = &pSorter->aTask[0];
  81714. MergeEngine *pMain = 0;
  81715. #if SQLITE_MAX_WORKER_THREADS
  81716. sqlite3 *db = pTask0->pSorter->db;
  81717. int i;
  81718. SorterCompare xCompare = vdbeSorterGetCompare(pSorter);
  81719. for(i=0; i<pSorter->nTask; i++){
  81720. pSorter->aTask[i].xCompare = xCompare;
  81721. }
  81722. #endif
  81723. rc = vdbeSorterMergeTreeBuild(pSorter, &pMain);
  81724. if( rc==SQLITE_OK ){
  81725. #if SQLITE_MAX_WORKER_THREADS
  81726. assert( pSorter->bUseThreads==0 || pSorter->nTask>1 );
  81727. if( pSorter->bUseThreads ){
  81728. int iTask;
  81729. PmaReader *pReadr = 0;
  81730. SortSubtask *pLast = &pSorter->aTask[pSorter->nTask-1];
  81731. rc = vdbeSortAllocUnpacked(pLast);
  81732. if( rc==SQLITE_OK ){
  81733. pReadr = (PmaReader*)sqlite3DbMallocZero(db, sizeof(PmaReader));
  81734. pSorter->pReader = pReadr;
  81735. if( pReadr==0 ) rc = SQLITE_NOMEM_BKPT;
  81736. }
  81737. if( rc==SQLITE_OK ){
  81738. rc = vdbeIncrMergerNew(pLast, pMain, &pReadr->pIncr);
  81739. if( rc==SQLITE_OK ){
  81740. vdbeIncrMergerSetThreads(pReadr->pIncr);
  81741. for(iTask=0; iTask<(pSorter->nTask-1); iTask++){
  81742. IncrMerger *pIncr;
  81743. if( (pIncr = pMain->aReadr[iTask].pIncr) ){
  81744. vdbeIncrMergerSetThreads(pIncr);
  81745. assert( pIncr->pTask!=pLast );
  81746. }
  81747. }
  81748. for(iTask=0; rc==SQLITE_OK && iTask<pSorter->nTask; iTask++){
  81749. /* Check that:
  81750. **
  81751. ** a) The incremental merge object is configured to use the
  81752. ** right task, and
  81753. ** b) If it is using task (nTask-1), it is configured to run
  81754. ** in single-threaded mode. This is important, as the
  81755. ** root merge (INCRINIT_ROOT) will be using the same task
  81756. ** object.
  81757. */
  81758. PmaReader *p = &pMain->aReadr[iTask];
  81759. assert( p->pIncr==0 || (
  81760. (p->pIncr->pTask==&pSorter->aTask[iTask]) /* a */
  81761. && (iTask!=pSorter->nTask-1 || p->pIncr->bUseThread==0) /* b */
  81762. ));
  81763. rc = vdbePmaReaderIncrInit(p, INCRINIT_TASK);
  81764. }
  81765. }
  81766. pMain = 0;
  81767. }
  81768. if( rc==SQLITE_OK ){
  81769. rc = vdbePmaReaderIncrMergeInit(pReadr, INCRINIT_ROOT);
  81770. }
  81771. }else
  81772. #endif
  81773. {
  81774. rc = vdbeMergeEngineInit(pTask0, pMain, INCRINIT_NORMAL);
  81775. pSorter->pMerger = pMain;
  81776. pMain = 0;
  81777. }
  81778. }
  81779. if( rc!=SQLITE_OK ){
  81780. vdbeMergeEngineFree(pMain);
  81781. }
  81782. return rc;
  81783. }
  81784. /*
  81785. ** Once the sorter has been populated by calls to sqlite3VdbeSorterWrite,
  81786. ** this function is called to prepare for iterating through the records
  81787. ** in sorted order.
  81788. */
  81789. SQLITE_PRIVATE int sqlite3VdbeSorterRewind(const VdbeCursor *pCsr, int *pbEof){
  81790. VdbeSorter *pSorter;
  81791. int rc = SQLITE_OK; /* Return code */
  81792. assert( pCsr->eCurType==CURTYPE_SORTER );
  81793. pSorter = pCsr->uc.pSorter;
  81794. assert( pSorter );
  81795. /* If no data has been written to disk, then do not do so now. Instead,
  81796. ** sort the VdbeSorter.pRecord list. The vdbe layer will read data directly
  81797. ** from the in-memory list. */
  81798. if( pSorter->bUsePMA==0 ){
  81799. if( pSorter->list.pList ){
  81800. *pbEof = 0;
  81801. rc = vdbeSorterSort(&pSorter->aTask[0], &pSorter->list);
  81802. }else{
  81803. *pbEof = 1;
  81804. }
  81805. return rc;
  81806. }
  81807. /* Write the current in-memory list to a PMA. When the VdbeSorterWrite()
  81808. ** function flushes the contents of memory to disk, it immediately always
  81809. ** creates a new list consisting of a single key immediately afterwards.
  81810. ** So the list is never empty at this point. */
  81811. assert( pSorter->list.pList );
  81812. rc = vdbeSorterFlushPMA(pSorter);
  81813. /* Join all threads */
  81814. rc = vdbeSorterJoinAll(pSorter, rc);
  81815. vdbeSorterRewindDebug("rewind");
  81816. /* Assuming no errors have occurred, set up a merger structure to
  81817. ** incrementally read and merge all remaining PMAs. */
  81818. assert( pSorter->pReader==0 );
  81819. if( rc==SQLITE_OK ){
  81820. rc = vdbeSorterSetupMerge(pSorter);
  81821. *pbEof = 0;
  81822. }
  81823. vdbeSorterRewindDebug("rewinddone");
  81824. return rc;
  81825. }
  81826. /*
  81827. ** Advance to the next element in the sorter.
  81828. */
  81829. SQLITE_PRIVATE int sqlite3VdbeSorterNext(sqlite3 *db, const VdbeCursor *pCsr, int *pbEof){
  81830. VdbeSorter *pSorter;
  81831. int rc; /* Return code */
  81832. assert( pCsr->eCurType==CURTYPE_SORTER );
  81833. pSorter = pCsr->uc.pSorter;
  81834. assert( pSorter->bUsePMA || (pSorter->pReader==0 && pSorter->pMerger==0) );
  81835. if( pSorter->bUsePMA ){
  81836. assert( pSorter->pReader==0 || pSorter->pMerger==0 );
  81837. assert( pSorter->bUseThreads==0 || pSorter->pReader );
  81838. assert( pSorter->bUseThreads==1 || pSorter->pMerger );
  81839. #if SQLITE_MAX_WORKER_THREADS>0
  81840. if( pSorter->bUseThreads ){
  81841. rc = vdbePmaReaderNext(pSorter->pReader);
  81842. *pbEof = (pSorter->pReader->pFd==0);
  81843. }else
  81844. #endif
  81845. /*if( !pSorter->bUseThreads )*/ {
  81846. assert( pSorter->pMerger!=0 );
  81847. assert( pSorter->pMerger->pTask==(&pSorter->aTask[0]) );
  81848. rc = vdbeMergeEngineStep(pSorter->pMerger, pbEof);
  81849. }
  81850. }else{
  81851. SorterRecord *pFree = pSorter->list.pList;
  81852. pSorter->list.pList = pFree->u.pNext;
  81853. pFree->u.pNext = 0;
  81854. if( pSorter->list.aMemory==0 ) vdbeSorterRecordFree(db, pFree);
  81855. *pbEof = !pSorter->list.pList;
  81856. rc = SQLITE_OK;
  81857. }
  81858. return rc;
  81859. }
  81860. /*
  81861. ** Return a pointer to a buffer owned by the sorter that contains the
  81862. ** current key.
  81863. */
  81864. static void *vdbeSorterRowkey(
  81865. const VdbeSorter *pSorter, /* Sorter object */
  81866. int *pnKey /* OUT: Size of current key in bytes */
  81867. ){
  81868. void *pKey;
  81869. if( pSorter->bUsePMA ){
  81870. PmaReader *pReader;
  81871. #if SQLITE_MAX_WORKER_THREADS>0
  81872. if( pSorter->bUseThreads ){
  81873. pReader = pSorter->pReader;
  81874. }else
  81875. #endif
  81876. /*if( !pSorter->bUseThreads )*/{
  81877. pReader = &pSorter->pMerger->aReadr[pSorter->pMerger->aTree[1]];
  81878. }
  81879. *pnKey = pReader->nKey;
  81880. pKey = pReader->aKey;
  81881. }else{
  81882. *pnKey = pSorter->list.pList->nVal;
  81883. pKey = SRVAL(pSorter->list.pList);
  81884. }
  81885. return pKey;
  81886. }
  81887. /*
  81888. ** Copy the current sorter key into the memory cell pOut.
  81889. */
  81890. SQLITE_PRIVATE int sqlite3VdbeSorterRowkey(const VdbeCursor *pCsr, Mem *pOut){
  81891. VdbeSorter *pSorter;
  81892. void *pKey; int nKey; /* Sorter key to copy into pOut */
  81893. assert( pCsr->eCurType==CURTYPE_SORTER );
  81894. pSorter = pCsr->uc.pSorter;
  81895. pKey = vdbeSorterRowkey(pSorter, &nKey);
  81896. if( sqlite3VdbeMemClearAndResize(pOut, nKey) ){
  81897. return SQLITE_NOMEM_BKPT;
  81898. }
  81899. pOut->n = nKey;
  81900. MemSetTypeFlag(pOut, MEM_Blob);
  81901. memcpy(pOut->z, pKey, nKey);
  81902. return SQLITE_OK;
  81903. }
  81904. /*
  81905. ** Compare the key in memory cell pVal with the key that the sorter cursor
  81906. ** passed as the first argument currently points to. For the purposes of
  81907. ** the comparison, ignore the rowid field at the end of each record.
  81908. **
  81909. ** If the sorter cursor key contains any NULL values, consider it to be
  81910. ** less than pVal. Even if pVal also contains NULL values.
  81911. **
  81912. ** If an error occurs, return an SQLite error code (i.e. SQLITE_NOMEM).
  81913. ** Otherwise, set *pRes to a negative, zero or positive value if the
  81914. ** key in pVal is smaller than, equal to or larger than the current sorter
  81915. ** key.
  81916. **
  81917. ** This routine forms the core of the OP_SorterCompare opcode, which in
  81918. ** turn is used to verify uniqueness when constructing a UNIQUE INDEX.
  81919. */
  81920. SQLITE_PRIVATE int sqlite3VdbeSorterCompare(
  81921. const VdbeCursor *pCsr, /* Sorter cursor */
  81922. Mem *pVal, /* Value to compare to current sorter key */
  81923. int nKeyCol, /* Compare this many columns */
  81924. int *pRes /* OUT: Result of comparison */
  81925. ){
  81926. VdbeSorter *pSorter;
  81927. UnpackedRecord *r2;
  81928. KeyInfo *pKeyInfo;
  81929. int i;
  81930. void *pKey; int nKey; /* Sorter key to compare pVal with */
  81931. assert( pCsr->eCurType==CURTYPE_SORTER );
  81932. pSorter = pCsr->uc.pSorter;
  81933. r2 = pSorter->pUnpacked;
  81934. pKeyInfo = pCsr->pKeyInfo;
  81935. if( r2==0 ){
  81936. char *p;
  81937. r2 = pSorter->pUnpacked = sqlite3VdbeAllocUnpackedRecord(pKeyInfo,0,0,&p);
  81938. assert( pSorter->pUnpacked==(UnpackedRecord*)p );
  81939. if( r2==0 ) return SQLITE_NOMEM_BKPT;
  81940. r2->nField = nKeyCol;
  81941. }
  81942. assert( r2->nField==nKeyCol );
  81943. pKey = vdbeSorterRowkey(pSorter, &nKey);
  81944. sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, r2);
  81945. for(i=0; i<nKeyCol; i++){
  81946. if( r2->aMem[i].flags & MEM_Null ){
  81947. *pRes = -1;
  81948. return SQLITE_OK;
  81949. }
  81950. }
  81951. *pRes = sqlite3VdbeRecordCompare(pVal->n, pVal->z, r2);
  81952. return SQLITE_OK;
  81953. }
  81954. /************** End of vdbesort.c ********************************************/
  81955. /************** Begin file memjournal.c **************************************/
  81956. /*
  81957. ** 2008 October 7
  81958. **
  81959. ** The author disclaims copyright to this source code. In place of
  81960. ** a legal notice, here is a blessing:
  81961. **
  81962. ** May you do good and not evil.
  81963. ** May you find forgiveness for yourself and forgive others.
  81964. ** May you share freely, never taking more than you give.
  81965. **
  81966. *************************************************************************
  81967. **
  81968. ** This file contains code use to implement an in-memory rollback journal.
  81969. ** The in-memory rollback journal is used to journal transactions for
  81970. ** ":memory:" databases and when the journal_mode=MEMORY pragma is used.
  81971. **
  81972. ** Update: The in-memory journal is also used to temporarily cache
  81973. ** smaller journals that are not critical for power-loss recovery.
  81974. ** For example, statement journals that are not too big will be held
  81975. ** entirely in memory, thus reducing the number of file I/O calls, and
  81976. ** more importantly, reducing temporary file creation events. If these
  81977. ** journals become too large for memory, they are spilled to disk. But
  81978. ** in the common case, they are usually small and no file I/O needs to
  81979. ** occur.
  81980. */
  81981. /* #include "sqliteInt.h" */
  81982. /* Forward references to internal structures */
  81983. typedef struct MemJournal MemJournal;
  81984. typedef struct FilePoint FilePoint;
  81985. typedef struct FileChunk FileChunk;
  81986. /*
  81987. ** The rollback journal is composed of a linked list of these structures.
  81988. **
  81989. ** The zChunk array is always at least 8 bytes in size - usually much more.
  81990. ** Its actual size is stored in the MemJournal.nChunkSize variable.
  81991. */
  81992. struct FileChunk {
  81993. FileChunk *pNext; /* Next chunk in the journal */
  81994. u8 zChunk[8]; /* Content of this chunk */
  81995. };
  81996. /*
  81997. ** By default, allocate this many bytes of memory for each FileChunk object.
  81998. */
  81999. #define MEMJOURNAL_DFLT_FILECHUNKSIZE 1024
  82000. /*
  82001. ** For chunk size nChunkSize, return the number of bytes that should
  82002. ** be allocated for each FileChunk structure.
  82003. */
  82004. #define fileChunkSize(nChunkSize) (sizeof(FileChunk) + ((nChunkSize)-8))
  82005. /*
  82006. ** An instance of this object serves as a cursor into the rollback journal.
  82007. ** The cursor can be either for reading or writing.
  82008. */
  82009. struct FilePoint {
  82010. sqlite3_int64 iOffset; /* Offset from the beginning of the file */
  82011. FileChunk *pChunk; /* Specific chunk into which cursor points */
  82012. };
  82013. /*
  82014. ** This structure is a subclass of sqlite3_file. Each open memory-journal
  82015. ** is an instance of this class.
  82016. */
  82017. struct MemJournal {
  82018. const sqlite3_io_methods *pMethod; /* Parent class. MUST BE FIRST */
  82019. int nChunkSize; /* In-memory chunk-size */
  82020. int nSpill; /* Bytes of data before flushing */
  82021. int nSize; /* Bytes of data currently in memory */
  82022. FileChunk *pFirst; /* Head of in-memory chunk-list */
  82023. FilePoint endpoint; /* Pointer to the end of the file */
  82024. FilePoint readpoint; /* Pointer to the end of the last xRead() */
  82025. int flags; /* xOpen flags */
  82026. sqlite3_vfs *pVfs; /* The "real" underlying VFS */
  82027. const char *zJournal; /* Name of the journal file */
  82028. };
  82029. /*
  82030. ** Read data from the in-memory journal file. This is the implementation
  82031. ** of the sqlite3_vfs.xRead method.
  82032. */
  82033. static int memjrnlRead(
  82034. sqlite3_file *pJfd, /* The journal file from which to read */
  82035. void *zBuf, /* Put the results here */
  82036. int iAmt, /* Number of bytes to read */
  82037. sqlite_int64 iOfst /* Begin reading at this offset */
  82038. ){
  82039. MemJournal *p = (MemJournal *)pJfd;
  82040. u8 *zOut = zBuf;
  82041. int nRead = iAmt;
  82042. int iChunkOffset;
  82043. FileChunk *pChunk;
  82044. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  82045. if( (iAmt+iOfst)>p->endpoint.iOffset ){
  82046. return SQLITE_IOERR_SHORT_READ;
  82047. }
  82048. #endif
  82049. assert( (iAmt+iOfst)<=p->endpoint.iOffset );
  82050. assert( p->readpoint.iOffset==0 || p->readpoint.pChunk!=0 );
  82051. if( p->readpoint.iOffset!=iOfst || iOfst==0 ){
  82052. sqlite3_int64 iOff = 0;
  82053. for(pChunk=p->pFirst;
  82054. ALWAYS(pChunk) && (iOff+p->nChunkSize)<=iOfst;
  82055. pChunk=pChunk->pNext
  82056. ){
  82057. iOff += p->nChunkSize;
  82058. }
  82059. }else{
  82060. pChunk = p->readpoint.pChunk;
  82061. assert( pChunk!=0 );
  82062. }
  82063. iChunkOffset = (int)(iOfst%p->nChunkSize);
  82064. do {
  82065. int iSpace = p->nChunkSize - iChunkOffset;
  82066. int nCopy = MIN(nRead, (p->nChunkSize - iChunkOffset));
  82067. memcpy(zOut, (u8*)pChunk->zChunk + iChunkOffset, nCopy);
  82068. zOut += nCopy;
  82069. nRead -= iSpace;
  82070. iChunkOffset = 0;
  82071. } while( nRead>=0 && (pChunk=pChunk->pNext)!=0 && nRead>0 );
  82072. p->readpoint.iOffset = pChunk ? iOfst+iAmt : 0;
  82073. p->readpoint.pChunk = pChunk;
  82074. return SQLITE_OK;
  82075. }
  82076. /*
  82077. ** Free the list of FileChunk structures headed at MemJournal.pFirst.
  82078. */
  82079. static void memjrnlFreeChunks(MemJournal *p){
  82080. FileChunk *pIter;
  82081. FileChunk *pNext;
  82082. for(pIter=p->pFirst; pIter; pIter=pNext){
  82083. pNext = pIter->pNext;
  82084. sqlite3_free(pIter);
  82085. }
  82086. p->pFirst = 0;
  82087. }
  82088. /*
  82089. ** Flush the contents of memory to a real file on disk.
  82090. */
  82091. static int memjrnlCreateFile(MemJournal *p){
  82092. int rc;
  82093. sqlite3_file *pReal = (sqlite3_file*)p;
  82094. MemJournal copy = *p;
  82095. memset(p, 0, sizeof(MemJournal));
  82096. rc = sqlite3OsOpen(copy.pVfs, copy.zJournal, pReal, copy.flags, 0);
  82097. if( rc==SQLITE_OK ){
  82098. int nChunk = copy.nChunkSize;
  82099. i64 iOff = 0;
  82100. FileChunk *pIter;
  82101. for(pIter=copy.pFirst; pIter; pIter=pIter->pNext){
  82102. if( iOff + nChunk > copy.endpoint.iOffset ){
  82103. nChunk = copy.endpoint.iOffset - iOff;
  82104. }
  82105. rc = sqlite3OsWrite(pReal, (u8*)pIter->zChunk, nChunk, iOff);
  82106. if( rc ) break;
  82107. iOff += nChunk;
  82108. }
  82109. if( rc==SQLITE_OK ){
  82110. /* No error has occurred. Free the in-memory buffers. */
  82111. memjrnlFreeChunks(&copy);
  82112. }
  82113. }
  82114. if( rc!=SQLITE_OK ){
  82115. /* If an error occurred while creating or writing to the file, restore
  82116. ** the original before returning. This way, SQLite uses the in-memory
  82117. ** journal data to roll back changes made to the internal page-cache
  82118. ** before this function was called. */
  82119. sqlite3OsClose(pReal);
  82120. *p = copy;
  82121. }
  82122. return rc;
  82123. }
  82124. /*
  82125. ** Write data to the file.
  82126. */
  82127. static int memjrnlWrite(
  82128. sqlite3_file *pJfd, /* The journal file into which to write */
  82129. const void *zBuf, /* Take data to be written from here */
  82130. int iAmt, /* Number of bytes to write */
  82131. sqlite_int64 iOfst /* Begin writing at this offset into the file */
  82132. ){
  82133. MemJournal *p = (MemJournal *)pJfd;
  82134. int nWrite = iAmt;
  82135. u8 *zWrite = (u8 *)zBuf;
  82136. /* If the file should be created now, create it and write the new data
  82137. ** into the file on disk. */
  82138. if( p->nSpill>0 && (iAmt+iOfst)>p->nSpill ){
  82139. int rc = memjrnlCreateFile(p);
  82140. if( rc==SQLITE_OK ){
  82141. rc = sqlite3OsWrite(pJfd, zBuf, iAmt, iOfst);
  82142. }
  82143. return rc;
  82144. }
  82145. /* If the contents of this write should be stored in memory */
  82146. else{
  82147. /* An in-memory journal file should only ever be appended to. Random
  82148. ** access writes are not required. The only exception to this is when
  82149. ** the in-memory journal is being used by a connection using the
  82150. ** atomic-write optimization. In this case the first 28 bytes of the
  82151. ** journal file may be written as part of committing the transaction. */
  82152. assert( iOfst==p->endpoint.iOffset || iOfst==0 );
  82153. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  82154. if( iOfst==0 && p->pFirst ){
  82155. assert( p->nChunkSize>iAmt );
  82156. memcpy((u8*)p->pFirst->zChunk, zBuf, iAmt);
  82157. }else
  82158. #else
  82159. assert( iOfst>0 || p->pFirst==0 );
  82160. #endif
  82161. {
  82162. while( nWrite>0 ){
  82163. FileChunk *pChunk = p->endpoint.pChunk;
  82164. int iChunkOffset = (int)(p->endpoint.iOffset%p->nChunkSize);
  82165. int iSpace = MIN(nWrite, p->nChunkSize - iChunkOffset);
  82166. if( iChunkOffset==0 ){
  82167. /* New chunk is required to extend the file. */
  82168. FileChunk *pNew = sqlite3_malloc(fileChunkSize(p->nChunkSize));
  82169. if( !pNew ){
  82170. return SQLITE_IOERR_NOMEM_BKPT;
  82171. }
  82172. pNew->pNext = 0;
  82173. if( pChunk ){
  82174. assert( p->pFirst );
  82175. pChunk->pNext = pNew;
  82176. }else{
  82177. assert( !p->pFirst );
  82178. p->pFirst = pNew;
  82179. }
  82180. p->endpoint.pChunk = pNew;
  82181. }
  82182. memcpy((u8*)p->endpoint.pChunk->zChunk + iChunkOffset, zWrite, iSpace);
  82183. zWrite += iSpace;
  82184. nWrite -= iSpace;
  82185. p->endpoint.iOffset += iSpace;
  82186. }
  82187. p->nSize = iAmt + iOfst;
  82188. }
  82189. }
  82190. return SQLITE_OK;
  82191. }
  82192. /*
  82193. ** Truncate the file.
  82194. **
  82195. ** If the journal file is already on disk, truncate it there. Or, if it
  82196. ** is still in main memory but is being truncated to zero bytes in size,
  82197. ** ignore
  82198. */
  82199. static int memjrnlTruncate(sqlite3_file *pJfd, sqlite_int64 size){
  82200. MemJournal *p = (MemJournal *)pJfd;
  82201. if( ALWAYS(size==0) ){
  82202. memjrnlFreeChunks(p);
  82203. p->nSize = 0;
  82204. p->endpoint.pChunk = 0;
  82205. p->endpoint.iOffset = 0;
  82206. p->readpoint.pChunk = 0;
  82207. p->readpoint.iOffset = 0;
  82208. }
  82209. return SQLITE_OK;
  82210. }
  82211. /*
  82212. ** Close the file.
  82213. */
  82214. static int memjrnlClose(sqlite3_file *pJfd){
  82215. MemJournal *p = (MemJournal *)pJfd;
  82216. memjrnlFreeChunks(p);
  82217. return SQLITE_OK;
  82218. }
  82219. /*
  82220. ** Sync the file.
  82221. **
  82222. ** If the real file has been created, call its xSync method. Otherwise,
  82223. ** syncing an in-memory journal is a no-op.
  82224. */
  82225. static int memjrnlSync(sqlite3_file *pJfd, int flags){
  82226. UNUSED_PARAMETER2(pJfd, flags);
  82227. return SQLITE_OK;
  82228. }
  82229. /*
  82230. ** Query the size of the file in bytes.
  82231. */
  82232. static int memjrnlFileSize(sqlite3_file *pJfd, sqlite_int64 *pSize){
  82233. MemJournal *p = (MemJournal *)pJfd;
  82234. *pSize = (sqlite_int64) p->endpoint.iOffset;
  82235. return SQLITE_OK;
  82236. }
  82237. /*
  82238. ** Table of methods for MemJournal sqlite3_file object.
  82239. */
  82240. static const struct sqlite3_io_methods MemJournalMethods = {
  82241. 1, /* iVersion */
  82242. memjrnlClose, /* xClose */
  82243. memjrnlRead, /* xRead */
  82244. memjrnlWrite, /* xWrite */
  82245. memjrnlTruncate, /* xTruncate */
  82246. memjrnlSync, /* xSync */
  82247. memjrnlFileSize, /* xFileSize */
  82248. 0, /* xLock */
  82249. 0, /* xUnlock */
  82250. 0, /* xCheckReservedLock */
  82251. 0, /* xFileControl */
  82252. 0, /* xSectorSize */
  82253. 0, /* xDeviceCharacteristics */
  82254. 0, /* xShmMap */
  82255. 0, /* xShmLock */
  82256. 0, /* xShmBarrier */
  82257. 0, /* xShmUnmap */
  82258. 0, /* xFetch */
  82259. 0 /* xUnfetch */
  82260. };
  82261. /*
  82262. ** Open a journal file.
  82263. **
  82264. ** The behaviour of the journal file depends on the value of parameter
  82265. ** nSpill. If nSpill is 0, then the journal file is always create and
  82266. ** accessed using the underlying VFS. If nSpill is less than zero, then
  82267. ** all content is always stored in main-memory. Finally, if nSpill is a
  82268. ** positive value, then the journal file is initially created in-memory
  82269. ** but may be flushed to disk later on. In this case the journal file is
  82270. ** flushed to disk either when it grows larger than nSpill bytes in size,
  82271. ** or when sqlite3JournalCreate() is called.
  82272. */
  82273. SQLITE_PRIVATE int sqlite3JournalOpen(
  82274. sqlite3_vfs *pVfs, /* The VFS to use for actual file I/O */
  82275. const char *zName, /* Name of the journal file */
  82276. sqlite3_file *pJfd, /* Preallocated, blank file handle */
  82277. int flags, /* Opening flags */
  82278. int nSpill /* Bytes buffered before opening the file */
  82279. ){
  82280. MemJournal *p = (MemJournal*)pJfd;
  82281. /* Zero the file-handle object. If nSpill was passed zero, initialize
  82282. ** it using the sqlite3OsOpen() function of the underlying VFS. In this
  82283. ** case none of the code in this module is executed as a result of calls
  82284. ** made on the journal file-handle. */
  82285. memset(p, 0, sizeof(MemJournal));
  82286. if( nSpill==0 ){
  82287. return sqlite3OsOpen(pVfs, zName, pJfd, flags, 0);
  82288. }
  82289. if( nSpill>0 ){
  82290. p->nChunkSize = nSpill;
  82291. }else{
  82292. p->nChunkSize = 8 + MEMJOURNAL_DFLT_FILECHUNKSIZE - sizeof(FileChunk);
  82293. assert( MEMJOURNAL_DFLT_FILECHUNKSIZE==fileChunkSize(p->nChunkSize) );
  82294. }
  82295. p->pMethod = (const sqlite3_io_methods*)&MemJournalMethods;
  82296. p->nSpill = nSpill;
  82297. p->flags = flags;
  82298. p->zJournal = zName;
  82299. p->pVfs = pVfs;
  82300. return SQLITE_OK;
  82301. }
  82302. /*
  82303. ** Open an in-memory journal file.
  82304. */
  82305. SQLITE_PRIVATE void sqlite3MemJournalOpen(sqlite3_file *pJfd){
  82306. sqlite3JournalOpen(0, 0, pJfd, 0, -1);
  82307. }
  82308. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  82309. /*
  82310. ** If the argument p points to a MemJournal structure that is not an
  82311. ** in-memory-only journal file (i.e. is one that was opened with a +ve
  82312. ** nSpill parameter), and the underlying file has not yet been created,
  82313. ** create it now.
  82314. */
  82315. SQLITE_PRIVATE int sqlite3JournalCreate(sqlite3_file *p){
  82316. int rc = SQLITE_OK;
  82317. if( p->pMethods==&MemJournalMethods && ((MemJournal*)p)->nSpill>0 ){
  82318. rc = memjrnlCreateFile((MemJournal*)p);
  82319. }
  82320. return rc;
  82321. }
  82322. #endif
  82323. /*
  82324. ** The file-handle passed as the only argument is open on a journal file.
  82325. ** Return true if this "journal file" is currently stored in heap memory,
  82326. ** or false otherwise.
  82327. */
  82328. SQLITE_PRIVATE int sqlite3JournalIsInMemory(sqlite3_file *p){
  82329. return p->pMethods==&MemJournalMethods;
  82330. }
  82331. /*
  82332. ** Return the number of bytes required to store a JournalFile that uses vfs
  82333. ** pVfs to create the underlying on-disk files.
  82334. */
  82335. SQLITE_PRIVATE int sqlite3JournalSize(sqlite3_vfs *pVfs){
  82336. return MAX(pVfs->szOsFile, (int)sizeof(MemJournal));
  82337. }
  82338. /************** End of memjournal.c ******************************************/
  82339. /************** Begin file walker.c ******************************************/
  82340. /*
  82341. ** 2008 August 16
  82342. **
  82343. ** The author disclaims copyright to this source code. In place of
  82344. ** a legal notice, here is a blessing:
  82345. **
  82346. ** May you do good and not evil.
  82347. ** May you find forgiveness for yourself and forgive others.
  82348. ** May you share freely, never taking more than you give.
  82349. **
  82350. *************************************************************************
  82351. ** This file contains routines used for walking the parser tree for
  82352. ** an SQL statement.
  82353. */
  82354. /* #include "sqliteInt.h" */
  82355. /* #include <stdlib.h> */
  82356. /* #include <string.h> */
  82357. /*
  82358. ** Walk an expression tree. Invoke the callback once for each node
  82359. ** of the expression, while descending. (In other words, the callback
  82360. ** is invoked before visiting children.)
  82361. **
  82362. ** The return value from the callback should be one of the WRC_*
  82363. ** constants to specify how to proceed with the walk.
  82364. **
  82365. ** WRC_Continue Continue descending down the tree.
  82366. **
  82367. ** WRC_Prune Do not descend into child nodes. But allow
  82368. ** the walk to continue with sibling nodes.
  82369. **
  82370. ** WRC_Abort Do no more callbacks. Unwind the stack and
  82371. ** return the top-level walk call.
  82372. **
  82373. ** The return value from this routine is WRC_Abort to abandon the tree walk
  82374. ** and WRC_Continue to continue.
  82375. */
  82376. static SQLITE_NOINLINE int walkExpr(Walker *pWalker, Expr *pExpr){
  82377. int rc;
  82378. testcase( ExprHasProperty(pExpr, EP_TokenOnly) );
  82379. testcase( ExprHasProperty(pExpr, EP_Reduced) );
  82380. rc = pWalker->xExprCallback(pWalker, pExpr);
  82381. if( rc || ExprHasProperty(pExpr,(EP_TokenOnly|EP_Leaf)) ){
  82382. return rc & WRC_Abort;
  82383. }
  82384. if( pExpr->pLeft && walkExpr(pWalker, pExpr->pLeft) ) return WRC_Abort;
  82385. if( pExpr->pRight && walkExpr(pWalker, pExpr->pRight) ) return WRC_Abort;
  82386. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  82387. if( sqlite3WalkSelect(pWalker, pExpr->x.pSelect) ) return WRC_Abort;
  82388. }else if( pExpr->x.pList ){
  82389. if( sqlite3WalkExprList(pWalker, pExpr->x.pList) ) return WRC_Abort;
  82390. }
  82391. return WRC_Continue;
  82392. }
  82393. SQLITE_PRIVATE int sqlite3WalkExpr(Walker *pWalker, Expr *pExpr){
  82394. return pExpr ? walkExpr(pWalker,pExpr) : WRC_Continue;
  82395. }
  82396. /*
  82397. ** Call sqlite3WalkExpr() for every expression in list p or until
  82398. ** an abort request is seen.
  82399. */
  82400. SQLITE_PRIVATE int sqlite3WalkExprList(Walker *pWalker, ExprList *p){
  82401. int i;
  82402. struct ExprList_item *pItem;
  82403. if( p ){
  82404. for(i=p->nExpr, pItem=p->a; i>0; i--, pItem++){
  82405. if( sqlite3WalkExpr(pWalker, pItem->pExpr) ) return WRC_Abort;
  82406. }
  82407. }
  82408. return WRC_Continue;
  82409. }
  82410. /*
  82411. ** Walk all expressions associated with SELECT statement p. Do
  82412. ** not invoke the SELECT callback on p, but do (of course) invoke
  82413. ** any expr callbacks and SELECT callbacks that come from subqueries.
  82414. ** Return WRC_Abort or WRC_Continue.
  82415. */
  82416. SQLITE_PRIVATE int sqlite3WalkSelectExpr(Walker *pWalker, Select *p){
  82417. if( sqlite3WalkExprList(pWalker, p->pEList) ) return WRC_Abort;
  82418. if( sqlite3WalkExpr(pWalker, p->pWhere) ) return WRC_Abort;
  82419. if( sqlite3WalkExprList(pWalker, p->pGroupBy) ) return WRC_Abort;
  82420. if( sqlite3WalkExpr(pWalker, p->pHaving) ) return WRC_Abort;
  82421. if( sqlite3WalkExprList(pWalker, p->pOrderBy) ) return WRC_Abort;
  82422. if( sqlite3WalkExpr(pWalker, p->pLimit) ) return WRC_Abort;
  82423. if( sqlite3WalkExpr(pWalker, p->pOffset) ) return WRC_Abort;
  82424. return WRC_Continue;
  82425. }
  82426. /*
  82427. ** Walk the parse trees associated with all subqueries in the
  82428. ** FROM clause of SELECT statement p. Do not invoke the select
  82429. ** callback on p, but do invoke it on each FROM clause subquery
  82430. ** and on any subqueries further down in the tree. Return
  82431. ** WRC_Abort or WRC_Continue;
  82432. */
  82433. SQLITE_PRIVATE int sqlite3WalkSelectFrom(Walker *pWalker, Select *p){
  82434. SrcList *pSrc;
  82435. int i;
  82436. struct SrcList_item *pItem;
  82437. pSrc = p->pSrc;
  82438. if( ALWAYS(pSrc) ){
  82439. for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
  82440. if( sqlite3WalkSelect(pWalker, pItem->pSelect) ){
  82441. return WRC_Abort;
  82442. }
  82443. if( pItem->fg.isTabFunc
  82444. && sqlite3WalkExprList(pWalker, pItem->u1.pFuncArg)
  82445. ){
  82446. return WRC_Abort;
  82447. }
  82448. }
  82449. }
  82450. return WRC_Continue;
  82451. }
  82452. /*
  82453. ** Call sqlite3WalkExpr() for every expression in Select statement p.
  82454. ** Invoke sqlite3WalkSelect() for subqueries in the FROM clause and
  82455. ** on the compound select chain, p->pPrior.
  82456. **
  82457. ** If it is not NULL, the xSelectCallback() callback is invoked before
  82458. ** the walk of the expressions and FROM clause. The xSelectCallback2()
  82459. ** method, if it is not NULL, is invoked following the walk of the
  82460. ** expressions and FROM clause.
  82461. **
  82462. ** Return WRC_Continue under normal conditions. Return WRC_Abort if
  82463. ** there is an abort request.
  82464. **
  82465. ** If the Walker does not have an xSelectCallback() then this routine
  82466. ** is a no-op returning WRC_Continue.
  82467. */
  82468. SQLITE_PRIVATE int sqlite3WalkSelect(Walker *pWalker, Select *p){
  82469. int rc;
  82470. if( p==0 || (pWalker->xSelectCallback==0 && pWalker->xSelectCallback2==0) ){
  82471. return WRC_Continue;
  82472. }
  82473. rc = WRC_Continue;
  82474. pWalker->walkerDepth++;
  82475. while( p ){
  82476. if( pWalker->xSelectCallback ){
  82477. rc = pWalker->xSelectCallback(pWalker, p);
  82478. if( rc ) break;
  82479. }
  82480. if( sqlite3WalkSelectExpr(pWalker, p)
  82481. || sqlite3WalkSelectFrom(pWalker, p)
  82482. ){
  82483. pWalker->walkerDepth--;
  82484. return WRC_Abort;
  82485. }
  82486. if( pWalker->xSelectCallback2 ){
  82487. pWalker->xSelectCallback2(pWalker, p);
  82488. }
  82489. p = p->pPrior;
  82490. }
  82491. pWalker->walkerDepth--;
  82492. return rc & WRC_Abort;
  82493. }
  82494. /************** End of walker.c **********************************************/
  82495. /************** Begin file resolve.c *****************************************/
  82496. /*
  82497. ** 2008 August 18
  82498. **
  82499. ** The author disclaims copyright to this source code. In place of
  82500. ** a legal notice, here is a blessing:
  82501. **
  82502. ** May you do good and not evil.
  82503. ** May you find forgiveness for yourself and forgive others.
  82504. ** May you share freely, never taking more than you give.
  82505. **
  82506. *************************************************************************
  82507. **
  82508. ** This file contains routines used for walking the parser tree and
  82509. ** resolve all identifiers by associating them with a particular
  82510. ** table and column.
  82511. */
  82512. /* #include "sqliteInt.h" */
  82513. /* #include <stdlib.h> */
  82514. /* #include <string.h> */
  82515. /*
  82516. ** Walk the expression tree pExpr and increase the aggregate function
  82517. ** depth (the Expr.op2 field) by N on every TK_AGG_FUNCTION node.
  82518. ** This needs to occur when copying a TK_AGG_FUNCTION node from an
  82519. ** outer query into an inner subquery.
  82520. **
  82521. ** incrAggFunctionDepth(pExpr,n) is the main routine. incrAggDepth(..)
  82522. ** is a helper function - a callback for the tree walker.
  82523. */
  82524. static int incrAggDepth(Walker *pWalker, Expr *pExpr){
  82525. if( pExpr->op==TK_AGG_FUNCTION ) pExpr->op2 += pWalker->u.n;
  82526. return WRC_Continue;
  82527. }
  82528. static void incrAggFunctionDepth(Expr *pExpr, int N){
  82529. if( N>0 ){
  82530. Walker w;
  82531. memset(&w, 0, sizeof(w));
  82532. w.xExprCallback = incrAggDepth;
  82533. w.u.n = N;
  82534. sqlite3WalkExpr(&w, pExpr);
  82535. }
  82536. }
  82537. /*
  82538. ** Turn the pExpr expression into an alias for the iCol-th column of the
  82539. ** result set in pEList.
  82540. **
  82541. ** If the reference is followed by a COLLATE operator, then make sure
  82542. ** the COLLATE operator is preserved. For example:
  82543. **
  82544. ** SELECT a+b, c+d FROM t1 ORDER BY 1 COLLATE nocase;
  82545. **
  82546. ** Should be transformed into:
  82547. **
  82548. ** SELECT a+b, c+d FROM t1 ORDER BY (a+b) COLLATE nocase;
  82549. **
  82550. ** The nSubquery parameter specifies how many levels of subquery the
  82551. ** alias is removed from the original expression. The usual value is
  82552. ** zero but it might be more if the alias is contained within a subquery
  82553. ** of the original expression. The Expr.op2 field of TK_AGG_FUNCTION
  82554. ** structures must be increased by the nSubquery amount.
  82555. */
  82556. static void resolveAlias(
  82557. Parse *pParse, /* Parsing context */
  82558. ExprList *pEList, /* A result set */
  82559. int iCol, /* A column in the result set. 0..pEList->nExpr-1 */
  82560. Expr *pExpr, /* Transform this into an alias to the result set */
  82561. const char *zType, /* "GROUP" or "ORDER" or "" */
  82562. int nSubquery /* Number of subqueries that the label is moving */
  82563. ){
  82564. Expr *pOrig; /* The iCol-th column of the result set */
  82565. Expr *pDup; /* Copy of pOrig */
  82566. sqlite3 *db; /* The database connection */
  82567. assert( iCol>=0 && iCol<pEList->nExpr );
  82568. pOrig = pEList->a[iCol].pExpr;
  82569. assert( pOrig!=0 );
  82570. db = pParse->db;
  82571. pDup = sqlite3ExprDup(db, pOrig, 0);
  82572. if( pDup==0 ) return;
  82573. if( zType[0]!='G' ) incrAggFunctionDepth(pDup, nSubquery);
  82574. if( pExpr->op==TK_COLLATE ){
  82575. pDup = sqlite3ExprAddCollateString(pParse, pDup, pExpr->u.zToken);
  82576. }
  82577. ExprSetProperty(pDup, EP_Alias);
  82578. /* Before calling sqlite3ExprDelete(), set the EP_Static flag. This
  82579. ** prevents ExprDelete() from deleting the Expr structure itself,
  82580. ** allowing it to be repopulated by the memcpy() on the following line.
  82581. ** The pExpr->u.zToken might point into memory that will be freed by the
  82582. ** sqlite3DbFree(db, pDup) on the last line of this block, so be sure to
  82583. ** make a copy of the token before doing the sqlite3DbFree().
  82584. */
  82585. ExprSetProperty(pExpr, EP_Static);
  82586. sqlite3ExprDelete(db, pExpr);
  82587. memcpy(pExpr, pDup, sizeof(*pExpr));
  82588. if( !ExprHasProperty(pExpr, EP_IntValue) && pExpr->u.zToken!=0 ){
  82589. assert( (pExpr->flags & (EP_Reduced|EP_TokenOnly))==0 );
  82590. pExpr->u.zToken = sqlite3DbStrDup(db, pExpr->u.zToken);
  82591. pExpr->flags |= EP_MemToken;
  82592. }
  82593. sqlite3DbFree(db, pDup);
  82594. }
  82595. /*
  82596. ** Return TRUE if the name zCol occurs anywhere in the USING clause.
  82597. **
  82598. ** Return FALSE if the USING clause is NULL or if it does not contain
  82599. ** zCol.
  82600. */
  82601. static int nameInUsingClause(IdList *pUsing, const char *zCol){
  82602. if( pUsing ){
  82603. int k;
  82604. for(k=0; k<pUsing->nId; k++){
  82605. if( sqlite3StrICmp(pUsing->a[k].zName, zCol)==0 ) return 1;
  82606. }
  82607. }
  82608. return 0;
  82609. }
  82610. /*
  82611. ** Subqueries stores the original database, table and column names for their
  82612. ** result sets in ExprList.a[].zSpan, in the form "DATABASE.TABLE.COLUMN".
  82613. ** Check to see if the zSpan given to this routine matches the zDb, zTab,
  82614. ** and zCol. If any of zDb, zTab, and zCol are NULL then those fields will
  82615. ** match anything.
  82616. */
  82617. SQLITE_PRIVATE int sqlite3MatchSpanName(
  82618. const char *zSpan,
  82619. const char *zCol,
  82620. const char *zTab,
  82621. const char *zDb
  82622. ){
  82623. int n;
  82624. for(n=0; ALWAYS(zSpan[n]) && zSpan[n]!='.'; n++){}
  82625. if( zDb && (sqlite3StrNICmp(zSpan, zDb, n)!=0 || zDb[n]!=0) ){
  82626. return 0;
  82627. }
  82628. zSpan += n+1;
  82629. for(n=0; ALWAYS(zSpan[n]) && zSpan[n]!='.'; n++){}
  82630. if( zTab && (sqlite3StrNICmp(zSpan, zTab, n)!=0 || zTab[n]!=0) ){
  82631. return 0;
  82632. }
  82633. zSpan += n+1;
  82634. if( zCol && sqlite3StrICmp(zSpan, zCol)!=0 ){
  82635. return 0;
  82636. }
  82637. return 1;
  82638. }
  82639. /*
  82640. ** Given the name of a column of the form X.Y.Z or Y.Z or just Z, look up
  82641. ** that name in the set of source tables in pSrcList and make the pExpr
  82642. ** expression node refer back to that source column. The following changes
  82643. ** are made to pExpr:
  82644. **
  82645. ** pExpr->iDb Set the index in db->aDb[] of the database X
  82646. ** (even if X is implied).
  82647. ** pExpr->iTable Set to the cursor number for the table obtained
  82648. ** from pSrcList.
  82649. ** pExpr->pTab Points to the Table structure of X.Y (even if
  82650. ** X and/or Y are implied.)
  82651. ** pExpr->iColumn Set to the column number within the table.
  82652. ** pExpr->op Set to TK_COLUMN.
  82653. ** pExpr->pLeft Any expression this points to is deleted
  82654. ** pExpr->pRight Any expression this points to is deleted.
  82655. **
  82656. ** The zDb variable is the name of the database (the "X"). This value may be
  82657. ** NULL meaning that name is of the form Y.Z or Z. Any available database
  82658. ** can be used. The zTable variable is the name of the table (the "Y"). This
  82659. ** value can be NULL if zDb is also NULL. If zTable is NULL it
  82660. ** means that the form of the name is Z and that columns from any table
  82661. ** can be used.
  82662. **
  82663. ** If the name cannot be resolved unambiguously, leave an error message
  82664. ** in pParse and return WRC_Abort. Return WRC_Prune on success.
  82665. */
  82666. static int lookupName(
  82667. Parse *pParse, /* The parsing context */
  82668. const char *zDb, /* Name of the database containing table, or NULL */
  82669. const char *zTab, /* Name of table containing column, or NULL */
  82670. const char *zCol, /* Name of the column. */
  82671. NameContext *pNC, /* The name context used to resolve the name */
  82672. Expr *pExpr /* Make this EXPR node point to the selected column */
  82673. ){
  82674. int i, j; /* Loop counters */
  82675. int cnt = 0; /* Number of matching column names */
  82676. int cntTab = 0; /* Number of matching table names */
  82677. int nSubquery = 0; /* How many levels of subquery */
  82678. sqlite3 *db = pParse->db; /* The database connection */
  82679. struct SrcList_item *pItem; /* Use for looping over pSrcList items */
  82680. struct SrcList_item *pMatch = 0; /* The matching pSrcList item */
  82681. NameContext *pTopNC = pNC; /* First namecontext in the list */
  82682. Schema *pSchema = 0; /* Schema of the expression */
  82683. int isTrigger = 0; /* True if resolved to a trigger column */
  82684. Table *pTab = 0; /* Table hold the row */
  82685. Column *pCol; /* A column of pTab */
  82686. assert( pNC ); /* the name context cannot be NULL. */
  82687. assert( zCol ); /* The Z in X.Y.Z cannot be NULL */
  82688. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  82689. /* Initialize the node to no-match */
  82690. pExpr->iTable = -1;
  82691. pExpr->pTab = 0;
  82692. ExprSetVVAProperty(pExpr, EP_NoReduce);
  82693. /* Translate the schema name in zDb into a pointer to the corresponding
  82694. ** schema. If not found, pSchema will remain NULL and nothing will match
  82695. ** resulting in an appropriate error message toward the end of this routine
  82696. */
  82697. if( zDb ){
  82698. testcase( pNC->ncFlags & NC_PartIdx );
  82699. testcase( pNC->ncFlags & NC_IsCheck );
  82700. if( (pNC->ncFlags & (NC_PartIdx|NC_IsCheck))!=0 ){
  82701. /* Silently ignore database qualifiers inside CHECK constraints and
  82702. ** partial indices. Do not raise errors because that might break
  82703. ** legacy and because it does not hurt anything to just ignore the
  82704. ** database name. */
  82705. zDb = 0;
  82706. }else{
  82707. for(i=0; i<db->nDb; i++){
  82708. assert( db->aDb[i].zDbSName );
  82709. if( sqlite3StrICmp(db->aDb[i].zDbSName,zDb)==0 ){
  82710. pSchema = db->aDb[i].pSchema;
  82711. break;
  82712. }
  82713. }
  82714. }
  82715. }
  82716. /* Start at the inner-most context and move outward until a match is found */
  82717. while( pNC && cnt==0 ){
  82718. ExprList *pEList;
  82719. SrcList *pSrcList = pNC->pSrcList;
  82720. if( pSrcList ){
  82721. for(i=0, pItem=pSrcList->a; i<pSrcList->nSrc; i++, pItem++){
  82722. pTab = pItem->pTab;
  82723. assert( pTab!=0 && pTab->zName!=0 );
  82724. assert( pTab->nCol>0 );
  82725. if( pItem->pSelect && (pItem->pSelect->selFlags & SF_NestedFrom)!=0 ){
  82726. int hit = 0;
  82727. pEList = pItem->pSelect->pEList;
  82728. for(j=0; j<pEList->nExpr; j++){
  82729. if( sqlite3MatchSpanName(pEList->a[j].zSpan, zCol, zTab, zDb) ){
  82730. cnt++;
  82731. cntTab = 2;
  82732. pMatch = pItem;
  82733. pExpr->iColumn = j;
  82734. hit = 1;
  82735. }
  82736. }
  82737. if( hit || zTab==0 ) continue;
  82738. }
  82739. if( zDb && pTab->pSchema!=pSchema ){
  82740. continue;
  82741. }
  82742. if( zTab ){
  82743. const char *zTabName = pItem->zAlias ? pItem->zAlias : pTab->zName;
  82744. assert( zTabName!=0 );
  82745. if( sqlite3StrICmp(zTabName, zTab)!=0 ){
  82746. continue;
  82747. }
  82748. }
  82749. if( 0==(cntTab++) ){
  82750. pMatch = pItem;
  82751. }
  82752. for(j=0, pCol=pTab->aCol; j<pTab->nCol; j++, pCol++){
  82753. if( sqlite3StrICmp(pCol->zName, zCol)==0 ){
  82754. /* If there has been exactly one prior match and this match
  82755. ** is for the right-hand table of a NATURAL JOIN or is in a
  82756. ** USING clause, then skip this match.
  82757. */
  82758. if( cnt==1 ){
  82759. if( pItem->fg.jointype & JT_NATURAL ) continue;
  82760. if( nameInUsingClause(pItem->pUsing, zCol) ) continue;
  82761. }
  82762. cnt++;
  82763. pMatch = pItem;
  82764. /* Substitute the rowid (column -1) for the INTEGER PRIMARY KEY */
  82765. pExpr->iColumn = j==pTab->iPKey ? -1 : (i16)j;
  82766. break;
  82767. }
  82768. }
  82769. }
  82770. if( pMatch ){
  82771. pExpr->iTable = pMatch->iCursor;
  82772. pExpr->pTab = pMatch->pTab;
  82773. /* RIGHT JOIN not (yet) supported */
  82774. assert( (pMatch->fg.jointype & JT_RIGHT)==0 );
  82775. if( (pMatch->fg.jointype & JT_LEFT)!=0 ){
  82776. ExprSetProperty(pExpr, EP_CanBeNull);
  82777. }
  82778. pSchema = pExpr->pTab->pSchema;
  82779. }
  82780. } /* if( pSrcList ) */
  82781. #ifndef SQLITE_OMIT_TRIGGER
  82782. /* If we have not already resolved the name, then maybe
  82783. ** it is a new.* or old.* trigger argument reference
  82784. */
  82785. if( zDb==0 && zTab!=0 && cntTab==0 && pParse->pTriggerTab!=0 ){
  82786. int op = pParse->eTriggerOp;
  82787. assert( op==TK_DELETE || op==TK_UPDATE || op==TK_INSERT );
  82788. if( op!=TK_DELETE && sqlite3StrICmp("new",zTab) == 0 ){
  82789. pExpr->iTable = 1;
  82790. pTab = pParse->pTriggerTab;
  82791. }else if( op!=TK_INSERT && sqlite3StrICmp("old",zTab)==0 ){
  82792. pExpr->iTable = 0;
  82793. pTab = pParse->pTriggerTab;
  82794. }else{
  82795. pTab = 0;
  82796. }
  82797. if( pTab ){
  82798. int iCol;
  82799. pSchema = pTab->pSchema;
  82800. cntTab++;
  82801. for(iCol=0, pCol=pTab->aCol; iCol<pTab->nCol; iCol++, pCol++){
  82802. if( sqlite3StrICmp(pCol->zName, zCol)==0 ){
  82803. if( iCol==pTab->iPKey ){
  82804. iCol = -1;
  82805. }
  82806. break;
  82807. }
  82808. }
  82809. if( iCol>=pTab->nCol && sqlite3IsRowid(zCol) && VisibleRowid(pTab) ){
  82810. /* IMP: R-51414-32910 */
  82811. iCol = -1;
  82812. }
  82813. if( iCol<pTab->nCol ){
  82814. cnt++;
  82815. if( iCol<0 ){
  82816. pExpr->affinity = SQLITE_AFF_INTEGER;
  82817. }else if( pExpr->iTable==0 ){
  82818. testcase( iCol==31 );
  82819. testcase( iCol==32 );
  82820. pParse->oldmask |= (iCol>=32 ? 0xffffffff : (((u32)1)<<iCol));
  82821. }else{
  82822. testcase( iCol==31 );
  82823. testcase( iCol==32 );
  82824. pParse->newmask |= (iCol>=32 ? 0xffffffff : (((u32)1)<<iCol));
  82825. }
  82826. pExpr->iColumn = (i16)iCol;
  82827. pExpr->pTab = pTab;
  82828. isTrigger = 1;
  82829. }
  82830. }
  82831. }
  82832. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  82833. /*
  82834. ** Perhaps the name is a reference to the ROWID
  82835. */
  82836. if( cnt==0
  82837. && cntTab==1
  82838. && pMatch
  82839. && (pNC->ncFlags & NC_IdxExpr)==0
  82840. && sqlite3IsRowid(zCol)
  82841. && VisibleRowid(pMatch->pTab)
  82842. ){
  82843. cnt = 1;
  82844. pExpr->iColumn = -1;
  82845. pExpr->affinity = SQLITE_AFF_INTEGER;
  82846. }
  82847. /*
  82848. ** If the input is of the form Z (not Y.Z or X.Y.Z) then the name Z
  82849. ** might refer to an result-set alias. This happens, for example, when
  82850. ** we are resolving names in the WHERE clause of the following command:
  82851. **
  82852. ** SELECT a+b AS x FROM table WHERE x<10;
  82853. **
  82854. ** In cases like this, replace pExpr with a copy of the expression that
  82855. ** forms the result set entry ("a+b" in the example) and return immediately.
  82856. ** Note that the expression in the result set should have already been
  82857. ** resolved by the time the WHERE clause is resolved.
  82858. **
  82859. ** The ability to use an output result-set column in the WHERE, GROUP BY,
  82860. ** or HAVING clauses, or as part of a larger expression in the ORDER BY
  82861. ** clause is not standard SQL. This is a (goofy) SQLite extension, that
  82862. ** is supported for backwards compatibility only. Hence, we issue a warning
  82863. ** on sqlite3_log() whenever the capability is used.
  82864. */
  82865. if( (pEList = pNC->pEList)!=0
  82866. && zTab==0
  82867. && cnt==0
  82868. ){
  82869. for(j=0; j<pEList->nExpr; j++){
  82870. char *zAs = pEList->a[j].zName;
  82871. if( zAs!=0 && sqlite3StrICmp(zAs, zCol)==0 ){
  82872. Expr *pOrig;
  82873. assert( pExpr->pLeft==0 && pExpr->pRight==0 );
  82874. assert( pExpr->x.pList==0 );
  82875. assert( pExpr->x.pSelect==0 );
  82876. pOrig = pEList->a[j].pExpr;
  82877. if( (pNC->ncFlags&NC_AllowAgg)==0 && ExprHasProperty(pOrig, EP_Agg) ){
  82878. sqlite3ErrorMsg(pParse, "misuse of aliased aggregate %s", zAs);
  82879. return WRC_Abort;
  82880. }
  82881. resolveAlias(pParse, pEList, j, pExpr, "", nSubquery);
  82882. cnt = 1;
  82883. pMatch = 0;
  82884. assert( zTab==0 && zDb==0 );
  82885. goto lookupname_end;
  82886. }
  82887. }
  82888. }
  82889. /* Advance to the next name context. The loop will exit when either
  82890. ** we have a match (cnt>0) or when we run out of name contexts.
  82891. */
  82892. if( cnt==0 ){
  82893. pNC = pNC->pNext;
  82894. nSubquery++;
  82895. }
  82896. }
  82897. /*
  82898. ** If X and Y are NULL (in other words if only the column name Z is
  82899. ** supplied) and the value of Z is enclosed in double-quotes, then
  82900. ** Z is a string literal if it doesn't match any column names. In that
  82901. ** case, we need to return right away and not make any changes to
  82902. ** pExpr.
  82903. **
  82904. ** Because no reference was made to outer contexts, the pNC->nRef
  82905. ** fields are not changed in any context.
  82906. */
  82907. if( cnt==0 && zTab==0 && ExprHasProperty(pExpr,EP_DblQuoted) ){
  82908. pExpr->op = TK_STRING;
  82909. pExpr->pTab = 0;
  82910. return WRC_Prune;
  82911. }
  82912. /*
  82913. ** cnt==0 means there was not match. cnt>1 means there were two or
  82914. ** more matches. Either way, we have an error.
  82915. */
  82916. if( cnt!=1 ){
  82917. const char *zErr;
  82918. zErr = cnt==0 ? "no such column" : "ambiguous column name";
  82919. if( zDb ){
  82920. sqlite3ErrorMsg(pParse, "%s: %s.%s.%s", zErr, zDb, zTab, zCol);
  82921. }else if( zTab ){
  82922. sqlite3ErrorMsg(pParse, "%s: %s.%s", zErr, zTab, zCol);
  82923. }else{
  82924. sqlite3ErrorMsg(pParse, "%s: %s", zErr, zCol);
  82925. }
  82926. pParse->checkSchema = 1;
  82927. pTopNC->nErr++;
  82928. }
  82929. /* If a column from a table in pSrcList is referenced, then record
  82930. ** this fact in the pSrcList.a[].colUsed bitmask. Column 0 causes
  82931. ** bit 0 to be set. Column 1 sets bit 1. And so forth. If the
  82932. ** column number is greater than the number of bits in the bitmask
  82933. ** then set the high-order bit of the bitmask.
  82934. */
  82935. if( pExpr->iColumn>=0 && pMatch!=0 ){
  82936. int n = pExpr->iColumn;
  82937. testcase( n==BMS-1 );
  82938. if( n>=BMS ){
  82939. n = BMS-1;
  82940. }
  82941. assert( pMatch->iCursor==pExpr->iTable );
  82942. pMatch->colUsed |= ((Bitmask)1)<<n;
  82943. }
  82944. /* Clean up and return
  82945. */
  82946. sqlite3ExprDelete(db, pExpr->pLeft);
  82947. pExpr->pLeft = 0;
  82948. sqlite3ExprDelete(db, pExpr->pRight);
  82949. pExpr->pRight = 0;
  82950. pExpr->op = (isTrigger ? TK_TRIGGER : TK_COLUMN);
  82951. lookupname_end:
  82952. if( cnt==1 ){
  82953. assert( pNC!=0 );
  82954. if( !ExprHasProperty(pExpr, EP_Alias) ){
  82955. sqlite3AuthRead(pParse, pExpr, pSchema, pNC->pSrcList);
  82956. }
  82957. /* Increment the nRef value on all name contexts from TopNC up to
  82958. ** the point where the name matched. */
  82959. for(;;){
  82960. assert( pTopNC!=0 );
  82961. pTopNC->nRef++;
  82962. if( pTopNC==pNC ) break;
  82963. pTopNC = pTopNC->pNext;
  82964. }
  82965. return WRC_Prune;
  82966. } else {
  82967. return WRC_Abort;
  82968. }
  82969. }
  82970. /*
  82971. ** Allocate and return a pointer to an expression to load the column iCol
  82972. ** from datasource iSrc in SrcList pSrc.
  82973. */
  82974. SQLITE_PRIVATE Expr *sqlite3CreateColumnExpr(sqlite3 *db, SrcList *pSrc, int iSrc, int iCol){
  82975. Expr *p = sqlite3ExprAlloc(db, TK_COLUMN, 0, 0);
  82976. if( p ){
  82977. struct SrcList_item *pItem = &pSrc->a[iSrc];
  82978. p->pTab = pItem->pTab;
  82979. p->iTable = pItem->iCursor;
  82980. if( p->pTab->iPKey==iCol ){
  82981. p->iColumn = -1;
  82982. }else{
  82983. p->iColumn = (ynVar)iCol;
  82984. testcase( iCol==BMS );
  82985. testcase( iCol==BMS-1 );
  82986. pItem->colUsed |= ((Bitmask)1)<<(iCol>=BMS ? BMS-1 : iCol);
  82987. }
  82988. ExprSetProperty(p, EP_Resolved);
  82989. }
  82990. return p;
  82991. }
  82992. /*
  82993. ** Report an error that an expression is not valid for some set of
  82994. ** pNC->ncFlags values determined by validMask.
  82995. */
  82996. static void notValid(
  82997. Parse *pParse, /* Leave error message here */
  82998. NameContext *pNC, /* The name context */
  82999. const char *zMsg, /* Type of error */
  83000. int validMask /* Set of contexts for which prohibited */
  83001. ){
  83002. assert( (validMask&~(NC_IsCheck|NC_PartIdx|NC_IdxExpr))==0 );
  83003. if( (pNC->ncFlags & validMask)!=0 ){
  83004. const char *zIn = "partial index WHERE clauses";
  83005. if( pNC->ncFlags & NC_IdxExpr ) zIn = "index expressions";
  83006. #ifndef SQLITE_OMIT_CHECK
  83007. else if( pNC->ncFlags & NC_IsCheck ) zIn = "CHECK constraints";
  83008. #endif
  83009. sqlite3ErrorMsg(pParse, "%s prohibited in %s", zMsg, zIn);
  83010. }
  83011. }
  83012. /*
  83013. ** Expression p should encode a floating point value between 1.0 and 0.0.
  83014. ** Return 1024 times this value. Or return -1 if p is not a floating point
  83015. ** value between 1.0 and 0.0.
  83016. */
  83017. static int exprProbability(Expr *p){
  83018. double r = -1.0;
  83019. if( p->op!=TK_FLOAT ) return -1;
  83020. sqlite3AtoF(p->u.zToken, &r, sqlite3Strlen30(p->u.zToken), SQLITE_UTF8);
  83021. assert( r>=0.0 );
  83022. if( r>1.0 ) return -1;
  83023. return (int)(r*134217728.0);
  83024. }
  83025. /*
  83026. ** This routine is callback for sqlite3WalkExpr().
  83027. **
  83028. ** Resolve symbolic names into TK_COLUMN operators for the current
  83029. ** node in the expression tree. Return 0 to continue the search down
  83030. ** the tree or 2 to abort the tree walk.
  83031. **
  83032. ** This routine also does error checking and name resolution for
  83033. ** function names. The operator for aggregate functions is changed
  83034. ** to TK_AGG_FUNCTION.
  83035. */
  83036. static int resolveExprStep(Walker *pWalker, Expr *pExpr){
  83037. NameContext *pNC;
  83038. Parse *pParse;
  83039. pNC = pWalker->u.pNC;
  83040. assert( pNC!=0 );
  83041. pParse = pNC->pParse;
  83042. assert( pParse==pWalker->pParse );
  83043. if( ExprHasProperty(pExpr, EP_Resolved) ) return WRC_Prune;
  83044. ExprSetProperty(pExpr, EP_Resolved);
  83045. #ifndef NDEBUG
  83046. if( pNC->pSrcList && pNC->pSrcList->nAlloc>0 ){
  83047. SrcList *pSrcList = pNC->pSrcList;
  83048. int i;
  83049. for(i=0; i<pNC->pSrcList->nSrc; i++){
  83050. assert( pSrcList->a[i].iCursor>=0 && pSrcList->a[i].iCursor<pParse->nTab);
  83051. }
  83052. }
  83053. #endif
  83054. switch( pExpr->op ){
  83055. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  83056. /* The special operator TK_ROW means use the rowid for the first
  83057. ** column in the FROM clause. This is used by the LIMIT and ORDER BY
  83058. ** clause processing on UPDATE and DELETE statements.
  83059. */
  83060. case TK_ROW: {
  83061. SrcList *pSrcList = pNC->pSrcList;
  83062. struct SrcList_item *pItem;
  83063. assert( pSrcList && pSrcList->nSrc==1 );
  83064. pItem = pSrcList->a;
  83065. pExpr->op = TK_COLUMN;
  83066. pExpr->pTab = pItem->pTab;
  83067. pExpr->iTable = pItem->iCursor;
  83068. pExpr->iColumn = -1;
  83069. pExpr->affinity = SQLITE_AFF_INTEGER;
  83070. break;
  83071. }
  83072. #endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
  83073. && !defined(SQLITE_OMIT_SUBQUERY) */
  83074. /* A lone identifier is the name of a column.
  83075. */
  83076. case TK_ID: {
  83077. return lookupName(pParse, 0, 0, pExpr->u.zToken, pNC, pExpr);
  83078. }
  83079. /* A table name and column name: ID.ID
  83080. ** Or a database, table and column: ID.ID.ID
  83081. */
  83082. case TK_DOT: {
  83083. const char *zColumn;
  83084. const char *zTable;
  83085. const char *zDb;
  83086. Expr *pRight;
  83087. /* if( pSrcList==0 ) break; */
  83088. notValid(pParse, pNC, "the \".\" operator", NC_IdxExpr);
  83089. pRight = pExpr->pRight;
  83090. if( pRight->op==TK_ID ){
  83091. zDb = 0;
  83092. zTable = pExpr->pLeft->u.zToken;
  83093. zColumn = pRight->u.zToken;
  83094. }else{
  83095. assert( pRight->op==TK_DOT );
  83096. zDb = pExpr->pLeft->u.zToken;
  83097. zTable = pRight->pLeft->u.zToken;
  83098. zColumn = pRight->pRight->u.zToken;
  83099. }
  83100. return lookupName(pParse, zDb, zTable, zColumn, pNC, pExpr);
  83101. }
  83102. /* Resolve function names
  83103. */
  83104. case TK_FUNCTION: {
  83105. ExprList *pList = pExpr->x.pList; /* The argument list */
  83106. int n = pList ? pList->nExpr : 0; /* Number of arguments */
  83107. int no_such_func = 0; /* True if no such function exists */
  83108. int wrong_num_args = 0; /* True if wrong number of arguments */
  83109. int is_agg = 0; /* True if is an aggregate function */
  83110. int nId; /* Number of characters in function name */
  83111. const char *zId; /* The function name. */
  83112. FuncDef *pDef; /* Information about the function */
  83113. u8 enc = ENC(pParse->db); /* The database encoding */
  83114. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  83115. zId = pExpr->u.zToken;
  83116. nId = sqlite3Strlen30(zId);
  83117. pDef = sqlite3FindFunction(pParse->db, zId, n, enc, 0);
  83118. if( pDef==0 ){
  83119. pDef = sqlite3FindFunction(pParse->db, zId, -2, enc, 0);
  83120. if( pDef==0 ){
  83121. no_such_func = 1;
  83122. }else{
  83123. wrong_num_args = 1;
  83124. }
  83125. }else{
  83126. is_agg = pDef->xFinalize!=0;
  83127. if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
  83128. ExprSetProperty(pExpr, EP_Unlikely|EP_Skip);
  83129. if( n==2 ){
  83130. pExpr->iTable = exprProbability(pList->a[1].pExpr);
  83131. if( pExpr->iTable<0 ){
  83132. sqlite3ErrorMsg(pParse,
  83133. "second argument to likelihood() must be a "
  83134. "constant between 0.0 and 1.0");
  83135. pNC->nErr++;
  83136. }
  83137. }else{
  83138. /* EVIDENCE-OF: R-61304-29449 The unlikely(X) function is
  83139. ** equivalent to likelihood(X, 0.0625).
  83140. ** EVIDENCE-OF: R-01283-11636 The unlikely(X) function is
  83141. ** short-hand for likelihood(X,0.0625).
  83142. ** EVIDENCE-OF: R-36850-34127 The likely(X) function is short-hand
  83143. ** for likelihood(X,0.9375).
  83144. ** EVIDENCE-OF: R-53436-40973 The likely(X) function is equivalent
  83145. ** to likelihood(X,0.9375). */
  83146. /* TUNING: unlikely() probability is 0.0625. likely() is 0.9375 */
  83147. pExpr->iTable = pDef->zName[0]=='u' ? 8388608 : 125829120;
  83148. }
  83149. }
  83150. #ifndef SQLITE_OMIT_AUTHORIZATION
  83151. {
  83152. int auth = sqlite3AuthCheck(pParse, SQLITE_FUNCTION, 0,pDef->zName,0);
  83153. if( auth!=SQLITE_OK ){
  83154. if( auth==SQLITE_DENY ){
  83155. sqlite3ErrorMsg(pParse, "not authorized to use function: %s",
  83156. pDef->zName);
  83157. pNC->nErr++;
  83158. }
  83159. pExpr->op = TK_NULL;
  83160. return WRC_Prune;
  83161. }
  83162. }
  83163. #endif
  83164. if( pDef->funcFlags & (SQLITE_FUNC_CONSTANT|SQLITE_FUNC_SLOCHNG) ){
  83165. /* For the purposes of the EP_ConstFunc flag, date and time
  83166. ** functions and other functions that change slowly are considered
  83167. ** constant because they are constant for the duration of one query */
  83168. ExprSetProperty(pExpr,EP_ConstFunc);
  83169. }
  83170. if( (pDef->funcFlags & SQLITE_FUNC_CONSTANT)==0 ){
  83171. /* Date/time functions that use 'now', and other functions like
  83172. ** sqlite_version() that might change over time cannot be used
  83173. ** in an index. */
  83174. notValid(pParse, pNC, "non-deterministic functions",
  83175. NC_IdxExpr|NC_PartIdx);
  83176. }
  83177. }
  83178. if( is_agg && (pNC->ncFlags & NC_AllowAgg)==0 ){
  83179. sqlite3ErrorMsg(pParse, "misuse of aggregate function %.*s()", nId,zId);
  83180. pNC->nErr++;
  83181. is_agg = 0;
  83182. }else if( no_such_func && pParse->db->init.busy==0
  83183. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  83184. && pParse->explain==0
  83185. #endif
  83186. ){
  83187. sqlite3ErrorMsg(pParse, "no such function: %.*s", nId, zId);
  83188. pNC->nErr++;
  83189. }else if( wrong_num_args ){
  83190. sqlite3ErrorMsg(pParse,"wrong number of arguments to function %.*s()",
  83191. nId, zId);
  83192. pNC->nErr++;
  83193. }
  83194. if( is_agg ) pNC->ncFlags &= ~NC_AllowAgg;
  83195. sqlite3WalkExprList(pWalker, pList);
  83196. if( is_agg ){
  83197. NameContext *pNC2 = pNC;
  83198. pExpr->op = TK_AGG_FUNCTION;
  83199. pExpr->op2 = 0;
  83200. while( pNC2 && !sqlite3FunctionUsesThisSrc(pExpr, pNC2->pSrcList) ){
  83201. pExpr->op2++;
  83202. pNC2 = pNC2->pNext;
  83203. }
  83204. assert( pDef!=0 );
  83205. if( pNC2 ){
  83206. assert( SQLITE_FUNC_MINMAX==NC_MinMaxAgg );
  83207. testcase( (pDef->funcFlags & SQLITE_FUNC_MINMAX)!=0 );
  83208. pNC2->ncFlags |= NC_HasAgg | (pDef->funcFlags & SQLITE_FUNC_MINMAX);
  83209. }
  83210. pNC->ncFlags |= NC_AllowAgg;
  83211. }
  83212. /* FIX ME: Compute pExpr->affinity based on the expected return
  83213. ** type of the function
  83214. */
  83215. return WRC_Prune;
  83216. }
  83217. #ifndef SQLITE_OMIT_SUBQUERY
  83218. case TK_SELECT:
  83219. case TK_EXISTS: testcase( pExpr->op==TK_EXISTS );
  83220. #endif
  83221. case TK_IN: {
  83222. testcase( pExpr->op==TK_IN );
  83223. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  83224. int nRef = pNC->nRef;
  83225. notValid(pParse, pNC, "subqueries", NC_IsCheck|NC_PartIdx|NC_IdxExpr);
  83226. sqlite3WalkSelect(pWalker, pExpr->x.pSelect);
  83227. assert( pNC->nRef>=nRef );
  83228. if( nRef!=pNC->nRef ){
  83229. ExprSetProperty(pExpr, EP_VarSelect);
  83230. pNC->ncFlags |= NC_VarSelect;
  83231. }
  83232. }
  83233. break;
  83234. }
  83235. case TK_VARIABLE: {
  83236. notValid(pParse, pNC, "parameters", NC_IsCheck|NC_PartIdx|NC_IdxExpr);
  83237. break;
  83238. }
  83239. case TK_EQ:
  83240. case TK_NE:
  83241. case TK_LT:
  83242. case TK_LE:
  83243. case TK_GT:
  83244. case TK_GE:
  83245. case TK_IS:
  83246. case TK_ISNOT: {
  83247. int nLeft, nRight;
  83248. if( pParse->db->mallocFailed ) break;
  83249. assert( pExpr->pRight!=0 );
  83250. assert( pExpr->pLeft!=0 );
  83251. nLeft = sqlite3ExprVectorSize(pExpr->pLeft);
  83252. nRight = sqlite3ExprVectorSize(pExpr->pRight);
  83253. if( nLeft!=nRight ){
  83254. testcase( pExpr->op==TK_EQ );
  83255. testcase( pExpr->op==TK_NE );
  83256. testcase( pExpr->op==TK_LT );
  83257. testcase( pExpr->op==TK_LE );
  83258. testcase( pExpr->op==TK_GT );
  83259. testcase( pExpr->op==TK_GE );
  83260. testcase( pExpr->op==TK_IS );
  83261. testcase( pExpr->op==TK_ISNOT );
  83262. sqlite3ErrorMsg(pParse, "row value misused");
  83263. }
  83264. break;
  83265. }
  83266. }
  83267. return (pParse->nErr || pParse->db->mallocFailed) ? WRC_Abort : WRC_Continue;
  83268. }
  83269. /*
  83270. ** pEList is a list of expressions which are really the result set of the
  83271. ** a SELECT statement. pE is a term in an ORDER BY or GROUP BY clause.
  83272. ** This routine checks to see if pE is a simple identifier which corresponds
  83273. ** to the AS-name of one of the terms of the expression list. If it is,
  83274. ** this routine return an integer between 1 and N where N is the number of
  83275. ** elements in pEList, corresponding to the matching entry. If there is
  83276. ** no match, or if pE is not a simple identifier, then this routine
  83277. ** return 0.
  83278. **
  83279. ** pEList has been resolved. pE has not.
  83280. */
  83281. static int resolveAsName(
  83282. Parse *pParse, /* Parsing context for error messages */
  83283. ExprList *pEList, /* List of expressions to scan */
  83284. Expr *pE /* Expression we are trying to match */
  83285. ){
  83286. int i; /* Loop counter */
  83287. UNUSED_PARAMETER(pParse);
  83288. if( pE->op==TK_ID ){
  83289. char *zCol = pE->u.zToken;
  83290. for(i=0; i<pEList->nExpr; i++){
  83291. char *zAs = pEList->a[i].zName;
  83292. if( zAs!=0 && sqlite3StrICmp(zAs, zCol)==0 ){
  83293. return i+1;
  83294. }
  83295. }
  83296. }
  83297. return 0;
  83298. }
  83299. /*
  83300. ** pE is a pointer to an expression which is a single term in the
  83301. ** ORDER BY of a compound SELECT. The expression has not been
  83302. ** name resolved.
  83303. **
  83304. ** At the point this routine is called, we already know that the
  83305. ** ORDER BY term is not an integer index into the result set. That
  83306. ** case is handled by the calling routine.
  83307. **
  83308. ** Attempt to match pE against result set columns in the left-most
  83309. ** SELECT statement. Return the index i of the matching column,
  83310. ** as an indication to the caller that it should sort by the i-th column.
  83311. ** The left-most column is 1. In other words, the value returned is the
  83312. ** same integer value that would be used in the SQL statement to indicate
  83313. ** the column.
  83314. **
  83315. ** If there is no match, return 0. Return -1 if an error occurs.
  83316. */
  83317. static int resolveOrderByTermToExprList(
  83318. Parse *pParse, /* Parsing context for error messages */
  83319. Select *pSelect, /* The SELECT statement with the ORDER BY clause */
  83320. Expr *pE /* The specific ORDER BY term */
  83321. ){
  83322. int i; /* Loop counter */
  83323. ExprList *pEList; /* The columns of the result set */
  83324. NameContext nc; /* Name context for resolving pE */
  83325. sqlite3 *db; /* Database connection */
  83326. int rc; /* Return code from subprocedures */
  83327. u8 savedSuppErr; /* Saved value of db->suppressErr */
  83328. assert( sqlite3ExprIsInteger(pE, &i)==0 );
  83329. pEList = pSelect->pEList;
  83330. /* Resolve all names in the ORDER BY term expression
  83331. */
  83332. memset(&nc, 0, sizeof(nc));
  83333. nc.pParse = pParse;
  83334. nc.pSrcList = pSelect->pSrc;
  83335. nc.pEList = pEList;
  83336. nc.ncFlags = NC_AllowAgg;
  83337. nc.nErr = 0;
  83338. db = pParse->db;
  83339. savedSuppErr = db->suppressErr;
  83340. db->suppressErr = 1;
  83341. rc = sqlite3ResolveExprNames(&nc, pE);
  83342. db->suppressErr = savedSuppErr;
  83343. if( rc ) return 0;
  83344. /* Try to match the ORDER BY expression against an expression
  83345. ** in the result set. Return an 1-based index of the matching
  83346. ** result-set entry.
  83347. */
  83348. for(i=0; i<pEList->nExpr; i++){
  83349. if( sqlite3ExprCompare(pEList->a[i].pExpr, pE, -1)<2 ){
  83350. return i+1;
  83351. }
  83352. }
  83353. /* If no match, return 0. */
  83354. return 0;
  83355. }
  83356. /*
  83357. ** Generate an ORDER BY or GROUP BY term out-of-range error.
  83358. */
  83359. static void resolveOutOfRangeError(
  83360. Parse *pParse, /* The error context into which to write the error */
  83361. const char *zType, /* "ORDER" or "GROUP" */
  83362. int i, /* The index (1-based) of the term out of range */
  83363. int mx /* Largest permissible value of i */
  83364. ){
  83365. sqlite3ErrorMsg(pParse,
  83366. "%r %s BY term out of range - should be "
  83367. "between 1 and %d", i, zType, mx);
  83368. }
  83369. /*
  83370. ** Analyze the ORDER BY clause in a compound SELECT statement. Modify
  83371. ** each term of the ORDER BY clause is a constant integer between 1
  83372. ** and N where N is the number of columns in the compound SELECT.
  83373. **
  83374. ** ORDER BY terms that are already an integer between 1 and N are
  83375. ** unmodified. ORDER BY terms that are integers outside the range of
  83376. ** 1 through N generate an error. ORDER BY terms that are expressions
  83377. ** are matched against result set expressions of compound SELECT
  83378. ** beginning with the left-most SELECT and working toward the right.
  83379. ** At the first match, the ORDER BY expression is transformed into
  83380. ** the integer column number.
  83381. **
  83382. ** Return the number of errors seen.
  83383. */
  83384. static int resolveCompoundOrderBy(
  83385. Parse *pParse, /* Parsing context. Leave error messages here */
  83386. Select *pSelect /* The SELECT statement containing the ORDER BY */
  83387. ){
  83388. int i;
  83389. ExprList *pOrderBy;
  83390. ExprList *pEList;
  83391. sqlite3 *db;
  83392. int moreToDo = 1;
  83393. pOrderBy = pSelect->pOrderBy;
  83394. if( pOrderBy==0 ) return 0;
  83395. db = pParse->db;
  83396. #if SQLITE_MAX_COLUMN
  83397. if( pOrderBy->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  83398. sqlite3ErrorMsg(pParse, "too many terms in ORDER BY clause");
  83399. return 1;
  83400. }
  83401. #endif
  83402. for(i=0; i<pOrderBy->nExpr; i++){
  83403. pOrderBy->a[i].done = 0;
  83404. }
  83405. pSelect->pNext = 0;
  83406. while( pSelect->pPrior ){
  83407. pSelect->pPrior->pNext = pSelect;
  83408. pSelect = pSelect->pPrior;
  83409. }
  83410. while( pSelect && moreToDo ){
  83411. struct ExprList_item *pItem;
  83412. moreToDo = 0;
  83413. pEList = pSelect->pEList;
  83414. assert( pEList!=0 );
  83415. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  83416. int iCol = -1;
  83417. Expr *pE, *pDup;
  83418. if( pItem->done ) continue;
  83419. pE = sqlite3ExprSkipCollate(pItem->pExpr);
  83420. if( sqlite3ExprIsInteger(pE, &iCol) ){
  83421. if( iCol<=0 || iCol>pEList->nExpr ){
  83422. resolveOutOfRangeError(pParse, "ORDER", i+1, pEList->nExpr);
  83423. return 1;
  83424. }
  83425. }else{
  83426. iCol = resolveAsName(pParse, pEList, pE);
  83427. if( iCol==0 ){
  83428. pDup = sqlite3ExprDup(db, pE, 0);
  83429. if( !db->mallocFailed ){
  83430. assert(pDup);
  83431. iCol = resolveOrderByTermToExprList(pParse, pSelect, pDup);
  83432. }
  83433. sqlite3ExprDelete(db, pDup);
  83434. }
  83435. }
  83436. if( iCol>0 ){
  83437. /* Convert the ORDER BY term into an integer column number iCol,
  83438. ** taking care to preserve the COLLATE clause if it exists */
  83439. Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
  83440. if( pNew==0 ) return 1;
  83441. pNew->flags |= EP_IntValue;
  83442. pNew->u.iValue = iCol;
  83443. if( pItem->pExpr==pE ){
  83444. pItem->pExpr = pNew;
  83445. }else{
  83446. Expr *pParent = pItem->pExpr;
  83447. assert( pParent->op==TK_COLLATE );
  83448. while( pParent->pLeft->op==TK_COLLATE ) pParent = pParent->pLeft;
  83449. assert( pParent->pLeft==pE );
  83450. pParent->pLeft = pNew;
  83451. }
  83452. sqlite3ExprDelete(db, pE);
  83453. pItem->u.x.iOrderByCol = (u16)iCol;
  83454. pItem->done = 1;
  83455. }else{
  83456. moreToDo = 1;
  83457. }
  83458. }
  83459. pSelect = pSelect->pNext;
  83460. }
  83461. for(i=0; i<pOrderBy->nExpr; i++){
  83462. if( pOrderBy->a[i].done==0 ){
  83463. sqlite3ErrorMsg(pParse, "%r ORDER BY term does not match any "
  83464. "column in the result set", i+1);
  83465. return 1;
  83466. }
  83467. }
  83468. return 0;
  83469. }
  83470. /*
  83471. ** Check every term in the ORDER BY or GROUP BY clause pOrderBy of
  83472. ** the SELECT statement pSelect. If any term is reference to a
  83473. ** result set expression (as determined by the ExprList.a.u.x.iOrderByCol
  83474. ** field) then convert that term into a copy of the corresponding result set
  83475. ** column.
  83476. **
  83477. ** If any errors are detected, add an error message to pParse and
  83478. ** return non-zero. Return zero if no errors are seen.
  83479. */
  83480. SQLITE_PRIVATE int sqlite3ResolveOrderGroupBy(
  83481. Parse *pParse, /* Parsing context. Leave error messages here */
  83482. Select *pSelect, /* The SELECT statement containing the clause */
  83483. ExprList *pOrderBy, /* The ORDER BY or GROUP BY clause to be processed */
  83484. const char *zType /* "ORDER" or "GROUP" */
  83485. ){
  83486. int i;
  83487. sqlite3 *db = pParse->db;
  83488. ExprList *pEList;
  83489. struct ExprList_item *pItem;
  83490. if( pOrderBy==0 || pParse->db->mallocFailed ) return 0;
  83491. #if SQLITE_MAX_COLUMN
  83492. if( pOrderBy->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  83493. sqlite3ErrorMsg(pParse, "too many terms in %s BY clause", zType);
  83494. return 1;
  83495. }
  83496. #endif
  83497. pEList = pSelect->pEList;
  83498. assert( pEList!=0 ); /* sqlite3SelectNew() guarantees this */
  83499. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  83500. if( pItem->u.x.iOrderByCol ){
  83501. if( pItem->u.x.iOrderByCol>pEList->nExpr ){
  83502. resolveOutOfRangeError(pParse, zType, i+1, pEList->nExpr);
  83503. return 1;
  83504. }
  83505. resolveAlias(pParse, pEList, pItem->u.x.iOrderByCol-1, pItem->pExpr,
  83506. zType,0);
  83507. }
  83508. }
  83509. return 0;
  83510. }
  83511. /*
  83512. ** pOrderBy is an ORDER BY or GROUP BY clause in SELECT statement pSelect.
  83513. ** The Name context of the SELECT statement is pNC. zType is either
  83514. ** "ORDER" or "GROUP" depending on which type of clause pOrderBy is.
  83515. **
  83516. ** This routine resolves each term of the clause into an expression.
  83517. ** If the order-by term is an integer I between 1 and N (where N is the
  83518. ** number of columns in the result set of the SELECT) then the expression
  83519. ** in the resolution is a copy of the I-th result-set expression. If
  83520. ** the order-by term is an identifier that corresponds to the AS-name of
  83521. ** a result-set expression, then the term resolves to a copy of the
  83522. ** result-set expression. Otherwise, the expression is resolved in
  83523. ** the usual way - using sqlite3ResolveExprNames().
  83524. **
  83525. ** This routine returns the number of errors. If errors occur, then
  83526. ** an appropriate error message might be left in pParse. (OOM errors
  83527. ** excepted.)
  83528. */
  83529. static int resolveOrderGroupBy(
  83530. NameContext *pNC, /* The name context of the SELECT statement */
  83531. Select *pSelect, /* The SELECT statement holding pOrderBy */
  83532. ExprList *pOrderBy, /* An ORDER BY or GROUP BY clause to resolve */
  83533. const char *zType /* Either "ORDER" or "GROUP", as appropriate */
  83534. ){
  83535. int i, j; /* Loop counters */
  83536. int iCol; /* Column number */
  83537. struct ExprList_item *pItem; /* A term of the ORDER BY clause */
  83538. Parse *pParse; /* Parsing context */
  83539. int nResult; /* Number of terms in the result set */
  83540. if( pOrderBy==0 ) return 0;
  83541. nResult = pSelect->pEList->nExpr;
  83542. pParse = pNC->pParse;
  83543. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  83544. Expr *pE = pItem->pExpr;
  83545. Expr *pE2 = sqlite3ExprSkipCollate(pE);
  83546. if( zType[0]!='G' ){
  83547. iCol = resolveAsName(pParse, pSelect->pEList, pE2);
  83548. if( iCol>0 ){
  83549. /* If an AS-name match is found, mark this ORDER BY column as being
  83550. ** a copy of the iCol-th result-set column. The subsequent call to
  83551. ** sqlite3ResolveOrderGroupBy() will convert the expression to a
  83552. ** copy of the iCol-th result-set expression. */
  83553. pItem->u.x.iOrderByCol = (u16)iCol;
  83554. continue;
  83555. }
  83556. }
  83557. if( sqlite3ExprIsInteger(pE2, &iCol) ){
  83558. /* The ORDER BY term is an integer constant. Again, set the column
  83559. ** number so that sqlite3ResolveOrderGroupBy() will convert the
  83560. ** order-by term to a copy of the result-set expression */
  83561. if( iCol<1 || iCol>0xffff ){
  83562. resolveOutOfRangeError(pParse, zType, i+1, nResult);
  83563. return 1;
  83564. }
  83565. pItem->u.x.iOrderByCol = (u16)iCol;
  83566. continue;
  83567. }
  83568. /* Otherwise, treat the ORDER BY term as an ordinary expression */
  83569. pItem->u.x.iOrderByCol = 0;
  83570. if( sqlite3ResolveExprNames(pNC, pE) ){
  83571. return 1;
  83572. }
  83573. for(j=0; j<pSelect->pEList->nExpr; j++){
  83574. if( sqlite3ExprCompare(pE, pSelect->pEList->a[j].pExpr, -1)==0 ){
  83575. pItem->u.x.iOrderByCol = j+1;
  83576. }
  83577. }
  83578. }
  83579. return sqlite3ResolveOrderGroupBy(pParse, pSelect, pOrderBy, zType);
  83580. }
  83581. /*
  83582. ** Resolve names in the SELECT statement p and all of its descendants.
  83583. */
  83584. static int resolveSelectStep(Walker *pWalker, Select *p){
  83585. NameContext *pOuterNC; /* Context that contains this SELECT */
  83586. NameContext sNC; /* Name context of this SELECT */
  83587. int isCompound; /* True if p is a compound select */
  83588. int nCompound; /* Number of compound terms processed so far */
  83589. Parse *pParse; /* Parsing context */
  83590. int i; /* Loop counter */
  83591. ExprList *pGroupBy; /* The GROUP BY clause */
  83592. Select *pLeftmost; /* Left-most of SELECT of a compound */
  83593. sqlite3 *db; /* Database connection */
  83594. assert( p!=0 );
  83595. if( p->selFlags & SF_Resolved ){
  83596. return WRC_Prune;
  83597. }
  83598. pOuterNC = pWalker->u.pNC;
  83599. pParse = pWalker->pParse;
  83600. db = pParse->db;
  83601. /* Normally sqlite3SelectExpand() will be called first and will have
  83602. ** already expanded this SELECT. However, if this is a subquery within
  83603. ** an expression, sqlite3ResolveExprNames() will be called without a
  83604. ** prior call to sqlite3SelectExpand(). When that happens, let
  83605. ** sqlite3SelectPrep() do all of the processing for this SELECT.
  83606. ** sqlite3SelectPrep() will invoke both sqlite3SelectExpand() and
  83607. ** this routine in the correct order.
  83608. */
  83609. if( (p->selFlags & SF_Expanded)==0 ){
  83610. sqlite3SelectPrep(pParse, p, pOuterNC);
  83611. return (pParse->nErr || db->mallocFailed) ? WRC_Abort : WRC_Prune;
  83612. }
  83613. isCompound = p->pPrior!=0;
  83614. nCompound = 0;
  83615. pLeftmost = p;
  83616. while( p ){
  83617. assert( (p->selFlags & SF_Expanded)!=0 );
  83618. assert( (p->selFlags & SF_Resolved)==0 );
  83619. p->selFlags |= SF_Resolved;
  83620. /* Resolve the expressions in the LIMIT and OFFSET clauses. These
  83621. ** are not allowed to refer to any names, so pass an empty NameContext.
  83622. */
  83623. memset(&sNC, 0, sizeof(sNC));
  83624. sNC.pParse = pParse;
  83625. if( sqlite3ResolveExprNames(&sNC, p->pLimit) ||
  83626. sqlite3ResolveExprNames(&sNC, p->pOffset) ){
  83627. return WRC_Abort;
  83628. }
  83629. /* If the SF_Converted flags is set, then this Select object was
  83630. ** was created by the convertCompoundSelectToSubquery() function.
  83631. ** In this case the ORDER BY clause (p->pOrderBy) should be resolved
  83632. ** as if it were part of the sub-query, not the parent. This block
  83633. ** moves the pOrderBy down to the sub-query. It will be moved back
  83634. ** after the names have been resolved. */
  83635. if( p->selFlags & SF_Converted ){
  83636. Select *pSub = p->pSrc->a[0].pSelect;
  83637. assert( p->pSrc->nSrc==1 && p->pOrderBy );
  83638. assert( pSub->pPrior && pSub->pOrderBy==0 );
  83639. pSub->pOrderBy = p->pOrderBy;
  83640. p->pOrderBy = 0;
  83641. }
  83642. /* Recursively resolve names in all subqueries
  83643. */
  83644. for(i=0; i<p->pSrc->nSrc; i++){
  83645. struct SrcList_item *pItem = &p->pSrc->a[i];
  83646. if( pItem->pSelect ){
  83647. NameContext *pNC; /* Used to iterate name contexts */
  83648. int nRef = 0; /* Refcount for pOuterNC and outer contexts */
  83649. const char *zSavedContext = pParse->zAuthContext;
  83650. /* Count the total number of references to pOuterNC and all of its
  83651. ** parent contexts. After resolving references to expressions in
  83652. ** pItem->pSelect, check if this value has changed. If so, then
  83653. ** SELECT statement pItem->pSelect must be correlated. Set the
  83654. ** pItem->fg.isCorrelated flag if this is the case. */
  83655. for(pNC=pOuterNC; pNC; pNC=pNC->pNext) nRef += pNC->nRef;
  83656. if( pItem->zName ) pParse->zAuthContext = pItem->zName;
  83657. sqlite3ResolveSelectNames(pParse, pItem->pSelect, pOuterNC);
  83658. pParse->zAuthContext = zSavedContext;
  83659. if( pParse->nErr || db->mallocFailed ) return WRC_Abort;
  83660. for(pNC=pOuterNC; pNC; pNC=pNC->pNext) nRef -= pNC->nRef;
  83661. assert( pItem->fg.isCorrelated==0 && nRef<=0 );
  83662. pItem->fg.isCorrelated = (nRef!=0);
  83663. }
  83664. }
  83665. /* Set up the local name-context to pass to sqlite3ResolveExprNames() to
  83666. ** resolve the result-set expression list.
  83667. */
  83668. sNC.ncFlags = NC_AllowAgg;
  83669. sNC.pSrcList = p->pSrc;
  83670. sNC.pNext = pOuterNC;
  83671. /* Resolve names in the result set. */
  83672. if( sqlite3ResolveExprListNames(&sNC, p->pEList) ) return WRC_Abort;
  83673. /* If there are no aggregate functions in the result-set, and no GROUP BY
  83674. ** expression, do not allow aggregates in any of the other expressions.
  83675. */
  83676. assert( (p->selFlags & SF_Aggregate)==0 );
  83677. pGroupBy = p->pGroupBy;
  83678. if( pGroupBy || (sNC.ncFlags & NC_HasAgg)!=0 ){
  83679. assert( NC_MinMaxAgg==SF_MinMaxAgg );
  83680. p->selFlags |= SF_Aggregate | (sNC.ncFlags&NC_MinMaxAgg);
  83681. }else{
  83682. sNC.ncFlags &= ~NC_AllowAgg;
  83683. }
  83684. /* If a HAVING clause is present, then there must be a GROUP BY clause.
  83685. */
  83686. if( p->pHaving && !pGroupBy ){
  83687. sqlite3ErrorMsg(pParse, "a GROUP BY clause is required before HAVING");
  83688. return WRC_Abort;
  83689. }
  83690. /* Add the output column list to the name-context before parsing the
  83691. ** other expressions in the SELECT statement. This is so that
  83692. ** expressions in the WHERE clause (etc.) can refer to expressions by
  83693. ** aliases in the result set.
  83694. **
  83695. ** Minor point: If this is the case, then the expression will be
  83696. ** re-evaluated for each reference to it.
  83697. */
  83698. sNC.pEList = p->pEList;
  83699. if( sqlite3ResolveExprNames(&sNC, p->pHaving) ) return WRC_Abort;
  83700. if( sqlite3ResolveExprNames(&sNC, p->pWhere) ) return WRC_Abort;
  83701. /* Resolve names in table-valued-function arguments */
  83702. for(i=0; i<p->pSrc->nSrc; i++){
  83703. struct SrcList_item *pItem = &p->pSrc->a[i];
  83704. if( pItem->fg.isTabFunc
  83705. && sqlite3ResolveExprListNames(&sNC, pItem->u1.pFuncArg)
  83706. ){
  83707. return WRC_Abort;
  83708. }
  83709. }
  83710. /* The ORDER BY and GROUP BY clauses may not refer to terms in
  83711. ** outer queries
  83712. */
  83713. sNC.pNext = 0;
  83714. sNC.ncFlags |= NC_AllowAgg;
  83715. /* If this is a converted compound query, move the ORDER BY clause from
  83716. ** the sub-query back to the parent query. At this point each term
  83717. ** within the ORDER BY clause has been transformed to an integer value.
  83718. ** These integers will be replaced by copies of the corresponding result
  83719. ** set expressions by the call to resolveOrderGroupBy() below. */
  83720. if( p->selFlags & SF_Converted ){
  83721. Select *pSub = p->pSrc->a[0].pSelect;
  83722. p->pOrderBy = pSub->pOrderBy;
  83723. pSub->pOrderBy = 0;
  83724. }
  83725. /* Process the ORDER BY clause for singleton SELECT statements.
  83726. ** The ORDER BY clause for compounds SELECT statements is handled
  83727. ** below, after all of the result-sets for all of the elements of
  83728. ** the compound have been resolved.
  83729. **
  83730. ** If there is an ORDER BY clause on a term of a compound-select other
  83731. ** than the right-most term, then that is a syntax error. But the error
  83732. ** is not detected until much later, and so we need to go ahead and
  83733. ** resolve those symbols on the incorrect ORDER BY for consistency.
  83734. */
  83735. if( isCompound<=nCompound /* Defer right-most ORDER BY of a compound */
  83736. && resolveOrderGroupBy(&sNC, p, p->pOrderBy, "ORDER")
  83737. ){
  83738. return WRC_Abort;
  83739. }
  83740. if( db->mallocFailed ){
  83741. return WRC_Abort;
  83742. }
  83743. /* Resolve the GROUP BY clause. At the same time, make sure
  83744. ** the GROUP BY clause does not contain aggregate functions.
  83745. */
  83746. if( pGroupBy ){
  83747. struct ExprList_item *pItem;
  83748. if( resolveOrderGroupBy(&sNC, p, pGroupBy, "GROUP") || db->mallocFailed ){
  83749. return WRC_Abort;
  83750. }
  83751. for(i=0, pItem=pGroupBy->a; i<pGroupBy->nExpr; i++, pItem++){
  83752. if( ExprHasProperty(pItem->pExpr, EP_Agg) ){
  83753. sqlite3ErrorMsg(pParse, "aggregate functions are not allowed in "
  83754. "the GROUP BY clause");
  83755. return WRC_Abort;
  83756. }
  83757. }
  83758. }
  83759. /* If this is part of a compound SELECT, check that it has the right
  83760. ** number of expressions in the select list. */
  83761. if( p->pNext && p->pEList->nExpr!=p->pNext->pEList->nExpr ){
  83762. sqlite3SelectWrongNumTermsError(pParse, p->pNext);
  83763. return WRC_Abort;
  83764. }
  83765. /* Advance to the next term of the compound
  83766. */
  83767. p = p->pPrior;
  83768. nCompound++;
  83769. }
  83770. /* Resolve the ORDER BY on a compound SELECT after all terms of
  83771. ** the compound have been resolved.
  83772. */
  83773. if( isCompound && resolveCompoundOrderBy(pParse, pLeftmost) ){
  83774. return WRC_Abort;
  83775. }
  83776. return WRC_Prune;
  83777. }
  83778. /*
  83779. ** This routine walks an expression tree and resolves references to
  83780. ** table columns and result-set columns. At the same time, do error
  83781. ** checking on function usage and set a flag if any aggregate functions
  83782. ** are seen.
  83783. **
  83784. ** To resolve table columns references we look for nodes (or subtrees) of the
  83785. ** form X.Y.Z or Y.Z or just Z where
  83786. **
  83787. ** X: The name of a database. Ex: "main" or "temp" or
  83788. ** the symbolic name assigned to an ATTACH-ed database.
  83789. **
  83790. ** Y: The name of a table in a FROM clause. Or in a trigger
  83791. ** one of the special names "old" or "new".
  83792. **
  83793. ** Z: The name of a column in table Y.
  83794. **
  83795. ** The node at the root of the subtree is modified as follows:
  83796. **
  83797. ** Expr.op Changed to TK_COLUMN
  83798. ** Expr.pTab Points to the Table object for X.Y
  83799. ** Expr.iColumn The column index in X.Y. -1 for the rowid.
  83800. ** Expr.iTable The VDBE cursor number for X.Y
  83801. **
  83802. **
  83803. ** To resolve result-set references, look for expression nodes of the
  83804. ** form Z (with no X and Y prefix) where the Z matches the right-hand
  83805. ** size of an AS clause in the result-set of a SELECT. The Z expression
  83806. ** is replaced by a copy of the left-hand side of the result-set expression.
  83807. ** Table-name and function resolution occurs on the substituted expression
  83808. ** tree. For example, in:
  83809. **
  83810. ** SELECT a+b AS x, c+d AS y FROM t1 ORDER BY x;
  83811. **
  83812. ** The "x" term of the order by is replaced by "a+b" to render:
  83813. **
  83814. ** SELECT a+b AS x, c+d AS y FROM t1 ORDER BY a+b;
  83815. **
  83816. ** Function calls are checked to make sure that the function is
  83817. ** defined and that the correct number of arguments are specified.
  83818. ** If the function is an aggregate function, then the NC_HasAgg flag is
  83819. ** set and the opcode is changed from TK_FUNCTION to TK_AGG_FUNCTION.
  83820. ** If an expression contains aggregate functions then the EP_Agg
  83821. ** property on the expression is set.
  83822. **
  83823. ** An error message is left in pParse if anything is amiss. The number
  83824. ** if errors is returned.
  83825. */
  83826. SQLITE_PRIVATE int sqlite3ResolveExprNames(
  83827. NameContext *pNC, /* Namespace to resolve expressions in. */
  83828. Expr *pExpr /* The expression to be analyzed. */
  83829. ){
  83830. u16 savedHasAgg;
  83831. Walker w;
  83832. if( pExpr==0 ) return 0;
  83833. #if SQLITE_MAX_EXPR_DEPTH>0
  83834. {
  83835. Parse *pParse = pNC->pParse;
  83836. if( sqlite3ExprCheckHeight(pParse, pExpr->nHeight+pNC->pParse->nHeight) ){
  83837. return 1;
  83838. }
  83839. pParse->nHeight += pExpr->nHeight;
  83840. }
  83841. #endif
  83842. savedHasAgg = pNC->ncFlags & (NC_HasAgg|NC_MinMaxAgg);
  83843. pNC->ncFlags &= ~(NC_HasAgg|NC_MinMaxAgg);
  83844. w.pParse = pNC->pParse;
  83845. w.xExprCallback = resolveExprStep;
  83846. w.xSelectCallback = resolveSelectStep;
  83847. w.xSelectCallback2 = 0;
  83848. w.walkerDepth = 0;
  83849. w.eCode = 0;
  83850. w.u.pNC = pNC;
  83851. sqlite3WalkExpr(&w, pExpr);
  83852. #if SQLITE_MAX_EXPR_DEPTH>0
  83853. pNC->pParse->nHeight -= pExpr->nHeight;
  83854. #endif
  83855. if( pNC->nErr>0 || w.pParse->nErr>0 ){
  83856. ExprSetProperty(pExpr, EP_Error);
  83857. }
  83858. if( pNC->ncFlags & NC_HasAgg ){
  83859. ExprSetProperty(pExpr, EP_Agg);
  83860. }
  83861. pNC->ncFlags |= savedHasAgg;
  83862. return ExprHasProperty(pExpr, EP_Error);
  83863. }
  83864. /*
  83865. ** Resolve all names for all expression in an expression list. This is
  83866. ** just like sqlite3ResolveExprNames() except that it works for an expression
  83867. ** list rather than a single expression.
  83868. */
  83869. SQLITE_PRIVATE int sqlite3ResolveExprListNames(
  83870. NameContext *pNC, /* Namespace to resolve expressions in. */
  83871. ExprList *pList /* The expression list to be analyzed. */
  83872. ){
  83873. int i;
  83874. if( pList ){
  83875. for(i=0; i<pList->nExpr; i++){
  83876. if( sqlite3ResolveExprNames(pNC, pList->a[i].pExpr) ) return WRC_Abort;
  83877. }
  83878. }
  83879. return WRC_Continue;
  83880. }
  83881. /*
  83882. ** Resolve all names in all expressions of a SELECT and in all
  83883. ** decendents of the SELECT, including compounds off of p->pPrior,
  83884. ** subqueries in expressions, and subqueries used as FROM clause
  83885. ** terms.
  83886. **
  83887. ** See sqlite3ResolveExprNames() for a description of the kinds of
  83888. ** transformations that occur.
  83889. **
  83890. ** All SELECT statements should have been expanded using
  83891. ** sqlite3SelectExpand() prior to invoking this routine.
  83892. */
  83893. SQLITE_PRIVATE void sqlite3ResolveSelectNames(
  83894. Parse *pParse, /* The parser context */
  83895. Select *p, /* The SELECT statement being coded. */
  83896. NameContext *pOuterNC /* Name context for parent SELECT statement */
  83897. ){
  83898. Walker w;
  83899. assert( p!=0 );
  83900. memset(&w, 0, sizeof(w));
  83901. w.xExprCallback = resolveExprStep;
  83902. w.xSelectCallback = resolveSelectStep;
  83903. w.pParse = pParse;
  83904. w.u.pNC = pOuterNC;
  83905. sqlite3WalkSelect(&w, p);
  83906. }
  83907. /*
  83908. ** Resolve names in expressions that can only reference a single table:
  83909. **
  83910. ** * CHECK constraints
  83911. ** * WHERE clauses on partial indices
  83912. **
  83913. ** The Expr.iTable value for Expr.op==TK_COLUMN nodes of the expression
  83914. ** is set to -1 and the Expr.iColumn value is set to the column number.
  83915. **
  83916. ** Any errors cause an error message to be set in pParse.
  83917. */
  83918. SQLITE_PRIVATE void sqlite3ResolveSelfReference(
  83919. Parse *pParse, /* Parsing context */
  83920. Table *pTab, /* The table being referenced */
  83921. int type, /* NC_IsCheck or NC_PartIdx or NC_IdxExpr */
  83922. Expr *pExpr, /* Expression to resolve. May be NULL. */
  83923. ExprList *pList /* Expression list to resolve. May be NUL. */
  83924. ){
  83925. SrcList sSrc; /* Fake SrcList for pParse->pNewTable */
  83926. NameContext sNC; /* Name context for pParse->pNewTable */
  83927. assert( type==NC_IsCheck || type==NC_PartIdx || type==NC_IdxExpr );
  83928. memset(&sNC, 0, sizeof(sNC));
  83929. memset(&sSrc, 0, sizeof(sSrc));
  83930. sSrc.nSrc = 1;
  83931. sSrc.a[0].zName = pTab->zName;
  83932. sSrc.a[0].pTab = pTab;
  83933. sSrc.a[0].iCursor = -1;
  83934. sNC.pParse = pParse;
  83935. sNC.pSrcList = &sSrc;
  83936. sNC.ncFlags = type;
  83937. if( sqlite3ResolveExprNames(&sNC, pExpr) ) return;
  83938. if( pList ) sqlite3ResolveExprListNames(&sNC, pList);
  83939. }
  83940. /************** End of resolve.c *********************************************/
  83941. /************** Begin file expr.c ********************************************/
  83942. /*
  83943. ** 2001 September 15
  83944. **
  83945. ** The author disclaims copyright to this source code. In place of
  83946. ** a legal notice, here is a blessing:
  83947. **
  83948. ** May you do good and not evil.
  83949. ** May you find forgiveness for yourself and forgive others.
  83950. ** May you share freely, never taking more than you give.
  83951. **
  83952. *************************************************************************
  83953. ** This file contains routines used for analyzing expressions and
  83954. ** for generating VDBE code that evaluates expressions in SQLite.
  83955. */
  83956. /* #include "sqliteInt.h" */
  83957. /* Forward declarations */
  83958. static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
  83959. static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
  83960. /*
  83961. ** Return the affinity character for a single column of a table.
  83962. */
  83963. SQLITE_PRIVATE char sqlite3TableColumnAffinity(Table *pTab, int iCol){
  83964. assert( iCol<pTab->nCol );
  83965. return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
  83966. }
  83967. /*
  83968. ** Return the 'affinity' of the expression pExpr if any.
  83969. **
  83970. ** If pExpr is a column, a reference to a column via an 'AS' alias,
  83971. ** or a sub-select with a column as the return value, then the
  83972. ** affinity of that column is returned. Otherwise, 0x00 is returned,
  83973. ** indicating no affinity for the expression.
  83974. **
  83975. ** i.e. the WHERE clause expressions in the following statements all
  83976. ** have an affinity:
  83977. **
  83978. ** CREATE TABLE t1(a);
  83979. ** SELECT * FROM t1 WHERE a;
  83980. ** SELECT a AS b FROM t1 WHERE b;
  83981. ** SELECT * FROM t1 WHERE (select a from t1);
  83982. */
  83983. SQLITE_PRIVATE char sqlite3ExprAffinity(Expr *pExpr){
  83984. int op;
  83985. pExpr = sqlite3ExprSkipCollate(pExpr);
  83986. if( pExpr->flags & EP_Generic ) return 0;
  83987. op = pExpr->op;
  83988. if( op==TK_SELECT ){
  83989. assert( pExpr->flags&EP_xIsSelect );
  83990. return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
  83991. }
  83992. if( op==TK_REGISTER ) op = pExpr->op2;
  83993. #ifndef SQLITE_OMIT_CAST
  83994. if( op==TK_CAST ){
  83995. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  83996. return sqlite3AffinityType(pExpr->u.zToken, 0);
  83997. }
  83998. #endif
  83999. if( op==TK_AGG_COLUMN || op==TK_COLUMN ){
  84000. return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
  84001. }
  84002. if( op==TK_SELECT_COLUMN ){
  84003. assert( pExpr->pLeft->flags&EP_xIsSelect );
  84004. return sqlite3ExprAffinity(
  84005. pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
  84006. );
  84007. }
  84008. return pExpr->affinity;
  84009. }
  84010. /*
  84011. ** Set the collating sequence for expression pExpr to be the collating
  84012. ** sequence named by pToken. Return a pointer to a new Expr node that
  84013. ** implements the COLLATE operator.
  84014. **
  84015. ** If a memory allocation error occurs, that fact is recorded in pParse->db
  84016. ** and the pExpr parameter is returned unchanged.
  84017. */
  84018. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateToken(
  84019. Parse *pParse, /* Parsing context */
  84020. Expr *pExpr, /* Add the "COLLATE" clause to this expression */
  84021. const Token *pCollName, /* Name of collating sequence */
  84022. int dequote /* True to dequote pCollName */
  84023. ){
  84024. if( pCollName->n>0 ){
  84025. Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
  84026. if( pNew ){
  84027. pNew->pLeft = pExpr;
  84028. pNew->flags |= EP_Collate|EP_Skip;
  84029. pExpr = pNew;
  84030. }
  84031. }
  84032. return pExpr;
  84033. }
  84034. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
  84035. Token s;
  84036. assert( zC!=0 );
  84037. sqlite3TokenInit(&s, (char*)zC);
  84038. return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
  84039. }
  84040. /*
  84041. ** Skip over any TK_COLLATE operators and any unlikely()
  84042. ** or likelihood() function at the root of an expression.
  84043. */
  84044. SQLITE_PRIVATE Expr *sqlite3ExprSkipCollate(Expr *pExpr){
  84045. while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
  84046. if( ExprHasProperty(pExpr, EP_Unlikely) ){
  84047. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  84048. assert( pExpr->x.pList->nExpr>0 );
  84049. assert( pExpr->op==TK_FUNCTION );
  84050. pExpr = pExpr->x.pList->a[0].pExpr;
  84051. }else{
  84052. assert( pExpr->op==TK_COLLATE );
  84053. pExpr = pExpr->pLeft;
  84054. }
  84055. }
  84056. return pExpr;
  84057. }
  84058. /*
  84059. ** Return the collation sequence for the expression pExpr. If
  84060. ** there is no defined collating sequence, return NULL.
  84061. **
  84062. ** The collating sequence might be determined by a COLLATE operator
  84063. ** or by the presence of a column with a defined collating sequence.
  84064. ** COLLATE operators take first precedence. Left operands take
  84065. ** precedence over right operands.
  84066. */
  84067. SQLITE_PRIVATE CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
  84068. sqlite3 *db = pParse->db;
  84069. CollSeq *pColl = 0;
  84070. Expr *p = pExpr;
  84071. while( p ){
  84072. int op = p->op;
  84073. if( p->flags & EP_Generic ) break;
  84074. if( op==TK_CAST || op==TK_UPLUS ){
  84075. p = p->pLeft;
  84076. continue;
  84077. }
  84078. if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
  84079. pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
  84080. break;
  84081. }
  84082. if( (op==TK_AGG_COLUMN || op==TK_COLUMN
  84083. || op==TK_REGISTER || op==TK_TRIGGER)
  84084. && p->pTab!=0
  84085. ){
  84086. /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
  84087. ** a TK_COLUMN but was previously evaluated and cached in a register */
  84088. int j = p->iColumn;
  84089. if( j>=0 ){
  84090. const char *zColl = p->pTab->aCol[j].zColl;
  84091. pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
  84092. }
  84093. break;
  84094. }
  84095. if( p->flags & EP_Collate ){
  84096. if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
  84097. p = p->pLeft;
  84098. }else{
  84099. Expr *pNext = p->pRight;
  84100. /* The Expr.x union is never used at the same time as Expr.pRight */
  84101. assert( p->x.pList==0 || p->pRight==0 );
  84102. /* p->flags holds EP_Collate and p->pLeft->flags does not. And
  84103. ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
  84104. ** least one EP_Collate. Thus the following two ALWAYS. */
  84105. if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
  84106. int i;
  84107. for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
  84108. if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
  84109. pNext = p->x.pList->a[i].pExpr;
  84110. break;
  84111. }
  84112. }
  84113. }
  84114. p = pNext;
  84115. }
  84116. }else{
  84117. break;
  84118. }
  84119. }
  84120. if( sqlite3CheckCollSeq(pParse, pColl) ){
  84121. pColl = 0;
  84122. }
  84123. return pColl;
  84124. }
  84125. /*
  84126. ** pExpr is an operand of a comparison operator. aff2 is the
  84127. ** type affinity of the other operand. This routine returns the
  84128. ** type affinity that should be used for the comparison operator.
  84129. */
  84130. SQLITE_PRIVATE char sqlite3CompareAffinity(Expr *pExpr, char aff2){
  84131. char aff1 = sqlite3ExprAffinity(pExpr);
  84132. if( aff1 && aff2 ){
  84133. /* Both sides of the comparison are columns. If one has numeric
  84134. ** affinity, use that. Otherwise use no affinity.
  84135. */
  84136. if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
  84137. return SQLITE_AFF_NUMERIC;
  84138. }else{
  84139. return SQLITE_AFF_BLOB;
  84140. }
  84141. }else if( !aff1 && !aff2 ){
  84142. /* Neither side of the comparison is a column. Compare the
  84143. ** results directly.
  84144. */
  84145. return SQLITE_AFF_BLOB;
  84146. }else{
  84147. /* One side is a column, the other is not. Use the columns affinity. */
  84148. assert( aff1==0 || aff2==0 );
  84149. return (aff1 + aff2);
  84150. }
  84151. }
  84152. /*
  84153. ** pExpr is a comparison operator. Return the type affinity that should
  84154. ** be applied to both operands prior to doing the comparison.
  84155. */
  84156. static char comparisonAffinity(Expr *pExpr){
  84157. char aff;
  84158. assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
  84159. pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
  84160. pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
  84161. assert( pExpr->pLeft );
  84162. aff = sqlite3ExprAffinity(pExpr->pLeft);
  84163. if( pExpr->pRight ){
  84164. aff = sqlite3CompareAffinity(pExpr->pRight, aff);
  84165. }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  84166. aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
  84167. }else if( NEVER(aff==0) ){
  84168. aff = SQLITE_AFF_BLOB;
  84169. }
  84170. return aff;
  84171. }
  84172. /*
  84173. ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
  84174. ** idx_affinity is the affinity of an indexed column. Return true
  84175. ** if the index with affinity idx_affinity may be used to implement
  84176. ** the comparison in pExpr.
  84177. */
  84178. SQLITE_PRIVATE int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
  84179. char aff = comparisonAffinity(pExpr);
  84180. switch( aff ){
  84181. case SQLITE_AFF_BLOB:
  84182. return 1;
  84183. case SQLITE_AFF_TEXT:
  84184. return idx_affinity==SQLITE_AFF_TEXT;
  84185. default:
  84186. return sqlite3IsNumericAffinity(idx_affinity);
  84187. }
  84188. }
  84189. /*
  84190. ** Return the P5 value that should be used for a binary comparison
  84191. ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
  84192. */
  84193. static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
  84194. u8 aff = (char)sqlite3ExprAffinity(pExpr2);
  84195. aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
  84196. return aff;
  84197. }
  84198. /*
  84199. ** Return a pointer to the collation sequence that should be used by
  84200. ** a binary comparison operator comparing pLeft and pRight.
  84201. **
  84202. ** If the left hand expression has a collating sequence type, then it is
  84203. ** used. Otherwise the collation sequence for the right hand expression
  84204. ** is used, or the default (BINARY) if neither expression has a collating
  84205. ** type.
  84206. **
  84207. ** Argument pRight (but not pLeft) may be a null pointer. In this case,
  84208. ** it is not considered.
  84209. */
  84210. SQLITE_PRIVATE CollSeq *sqlite3BinaryCompareCollSeq(
  84211. Parse *pParse,
  84212. Expr *pLeft,
  84213. Expr *pRight
  84214. ){
  84215. CollSeq *pColl;
  84216. assert( pLeft );
  84217. if( pLeft->flags & EP_Collate ){
  84218. pColl = sqlite3ExprCollSeq(pParse, pLeft);
  84219. }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
  84220. pColl = sqlite3ExprCollSeq(pParse, pRight);
  84221. }else{
  84222. pColl = sqlite3ExprCollSeq(pParse, pLeft);
  84223. if( !pColl ){
  84224. pColl = sqlite3ExprCollSeq(pParse, pRight);
  84225. }
  84226. }
  84227. return pColl;
  84228. }
  84229. /*
  84230. ** Generate code for a comparison operator.
  84231. */
  84232. static int codeCompare(
  84233. Parse *pParse, /* The parsing (and code generating) context */
  84234. Expr *pLeft, /* The left operand */
  84235. Expr *pRight, /* The right operand */
  84236. int opcode, /* The comparison opcode */
  84237. int in1, int in2, /* Register holding operands */
  84238. int dest, /* Jump here if true. */
  84239. int jumpIfNull /* If true, jump if either operand is NULL */
  84240. ){
  84241. int p5;
  84242. int addr;
  84243. CollSeq *p4;
  84244. p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
  84245. p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
  84246. addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
  84247. (void*)p4, P4_COLLSEQ);
  84248. sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
  84249. return addr;
  84250. }
  84251. /*
  84252. ** Return true if expression pExpr is a vector, or false otherwise.
  84253. **
  84254. ** A vector is defined as any expression that results in two or more
  84255. ** columns of result. Every TK_VECTOR node is an vector because the
  84256. ** parser will not generate a TK_VECTOR with fewer than two entries.
  84257. ** But a TK_SELECT might be either a vector or a scalar. It is only
  84258. ** considered a vector if it has two or more result columns.
  84259. */
  84260. SQLITE_PRIVATE int sqlite3ExprIsVector(Expr *pExpr){
  84261. return sqlite3ExprVectorSize(pExpr)>1;
  84262. }
  84263. /*
  84264. ** If the expression passed as the only argument is of type TK_VECTOR
  84265. ** return the number of expressions in the vector. Or, if the expression
  84266. ** is a sub-select, return the number of columns in the sub-select. For
  84267. ** any other type of expression, return 1.
  84268. */
  84269. SQLITE_PRIVATE int sqlite3ExprVectorSize(Expr *pExpr){
  84270. u8 op = pExpr->op;
  84271. if( op==TK_REGISTER ) op = pExpr->op2;
  84272. if( op==TK_VECTOR ){
  84273. return pExpr->x.pList->nExpr;
  84274. }else if( op==TK_SELECT ){
  84275. return pExpr->x.pSelect->pEList->nExpr;
  84276. }else{
  84277. return 1;
  84278. }
  84279. }
  84280. #ifndef SQLITE_OMIT_SUBQUERY
  84281. /*
  84282. ** Return a pointer to a subexpression of pVector that is the i-th
  84283. ** column of the vector (numbered starting with 0). The caller must
  84284. ** ensure that i is within range.
  84285. **
  84286. ** If pVector is really a scalar (and "scalar" here includes subqueries
  84287. ** that return a single column!) then return pVector unmodified.
  84288. **
  84289. ** pVector retains ownership of the returned subexpression.
  84290. **
  84291. ** If the vector is a (SELECT ...) then the expression returned is
  84292. ** just the expression for the i-th term of the result set, and may
  84293. ** not be ready for evaluation because the table cursor has not yet
  84294. ** been positioned.
  84295. */
  84296. SQLITE_PRIVATE Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
  84297. assert( i<sqlite3ExprVectorSize(pVector) );
  84298. if( sqlite3ExprIsVector(pVector) ){
  84299. assert( pVector->op2==0 || pVector->op==TK_REGISTER );
  84300. if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
  84301. return pVector->x.pSelect->pEList->a[i].pExpr;
  84302. }else{
  84303. return pVector->x.pList->a[i].pExpr;
  84304. }
  84305. }
  84306. return pVector;
  84307. }
  84308. #endif /* !defined(SQLITE_OMIT_SUBQUERY) */
  84309. #ifndef SQLITE_OMIT_SUBQUERY
  84310. /*
  84311. ** Compute and return a new Expr object which when passed to
  84312. ** sqlite3ExprCode() will generate all necessary code to compute
  84313. ** the iField-th column of the vector expression pVector.
  84314. **
  84315. ** It is ok for pVector to be a scalar (as long as iField==0).
  84316. ** In that case, this routine works like sqlite3ExprDup().
  84317. **
  84318. ** The caller owns the returned Expr object and is responsible for
  84319. ** ensuring that the returned value eventually gets freed.
  84320. **
  84321. ** The caller retains ownership of pVector. If pVector is a TK_SELECT,
  84322. ** then the returned object will reference pVector and so pVector must remain
  84323. ** valid for the life of the returned object. If pVector is a TK_VECTOR
  84324. ** or a scalar expression, then it can be deleted as soon as this routine
  84325. ** returns.
  84326. **
  84327. ** A trick to cause a TK_SELECT pVector to be deleted together with
  84328. ** the returned Expr object is to attach the pVector to the pRight field
  84329. ** of the returned TK_SELECT_COLUMN Expr object.
  84330. */
  84331. SQLITE_PRIVATE Expr *sqlite3ExprForVectorField(
  84332. Parse *pParse, /* Parsing context */
  84333. Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
  84334. int iField /* Which column of the vector to return */
  84335. ){
  84336. Expr *pRet;
  84337. if( pVector->op==TK_SELECT ){
  84338. assert( pVector->flags & EP_xIsSelect );
  84339. /* The TK_SELECT_COLUMN Expr node:
  84340. **
  84341. ** pLeft: pVector containing TK_SELECT
  84342. ** pRight: not used. But recursively deleted.
  84343. ** iColumn: Index of a column in pVector
  84344. ** pLeft->iTable: First in an array of register holding result, or 0
  84345. ** if the result is not yet computed.
  84346. **
  84347. ** sqlite3ExprDelete() specifically skips the recursive delete of
  84348. ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
  84349. ** can be attached to pRight to cause this node to take ownership of
  84350. ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
  84351. ** with the same pLeft pointer to the pVector, but only one of them
  84352. ** will own the pVector.
  84353. */
  84354. pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0, 0);
  84355. if( pRet ){
  84356. pRet->iColumn = iField;
  84357. pRet->pLeft = pVector;
  84358. }
  84359. assert( pRet==0 || pRet->iTable==0 );
  84360. }else{
  84361. if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
  84362. pRet = sqlite3ExprDup(pParse->db, pVector, 0);
  84363. }
  84364. return pRet;
  84365. }
  84366. #endif /* !define(SQLITE_OMIT_SUBQUERY) */
  84367. /*
  84368. ** If expression pExpr is of type TK_SELECT, generate code to evaluate
  84369. ** it. Return the register in which the result is stored (or, if the
  84370. ** sub-select returns more than one column, the first in an array
  84371. ** of registers in which the result is stored).
  84372. **
  84373. ** If pExpr is not a TK_SELECT expression, return 0.
  84374. */
  84375. static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
  84376. int reg = 0;
  84377. #ifndef SQLITE_OMIT_SUBQUERY
  84378. if( pExpr->op==TK_SELECT ){
  84379. reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
  84380. }
  84381. #endif
  84382. return reg;
  84383. }
  84384. /*
  84385. ** Argument pVector points to a vector expression - either a TK_VECTOR
  84386. ** or TK_SELECT that returns more than one column. This function returns
  84387. ** the register number of a register that contains the value of
  84388. ** element iField of the vector.
  84389. **
  84390. ** If pVector is a TK_SELECT expression, then code for it must have
  84391. ** already been generated using the exprCodeSubselect() routine. In this
  84392. ** case parameter regSelect should be the first in an array of registers
  84393. ** containing the results of the sub-select.
  84394. **
  84395. ** If pVector is of type TK_VECTOR, then code for the requested field
  84396. ** is generated. In this case (*pRegFree) may be set to the number of
  84397. ** a temporary register to be freed by the caller before returning.
  84398. **
  84399. ** Before returning, output parameter (*ppExpr) is set to point to the
  84400. ** Expr object corresponding to element iElem of the vector.
  84401. */
  84402. static int exprVectorRegister(
  84403. Parse *pParse, /* Parse context */
  84404. Expr *pVector, /* Vector to extract element from */
  84405. int iField, /* Field to extract from pVector */
  84406. int regSelect, /* First in array of registers */
  84407. Expr **ppExpr, /* OUT: Expression element */
  84408. int *pRegFree /* OUT: Temp register to free */
  84409. ){
  84410. u8 op = pVector->op;
  84411. assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
  84412. if( op==TK_REGISTER ){
  84413. *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
  84414. return pVector->iTable+iField;
  84415. }
  84416. if( op==TK_SELECT ){
  84417. *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
  84418. return regSelect+iField;
  84419. }
  84420. *ppExpr = pVector->x.pList->a[iField].pExpr;
  84421. return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
  84422. }
  84423. /*
  84424. ** Expression pExpr is a comparison between two vector values. Compute
  84425. ** the result of the comparison (1, 0, or NULL) and write that
  84426. ** result into register dest.
  84427. **
  84428. ** The caller must satisfy the following preconditions:
  84429. **
  84430. ** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
  84431. ** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
  84432. ** otherwise: op==pExpr->op and p5==0
  84433. */
  84434. static void codeVectorCompare(
  84435. Parse *pParse, /* Code generator context */
  84436. Expr *pExpr, /* The comparison operation */
  84437. int dest, /* Write results into this register */
  84438. u8 op, /* Comparison operator */
  84439. u8 p5 /* SQLITE_NULLEQ or zero */
  84440. ){
  84441. Vdbe *v = pParse->pVdbe;
  84442. Expr *pLeft = pExpr->pLeft;
  84443. Expr *pRight = pExpr->pRight;
  84444. int nLeft = sqlite3ExprVectorSize(pLeft);
  84445. int i;
  84446. int regLeft = 0;
  84447. int regRight = 0;
  84448. u8 opx = op;
  84449. int addrDone = sqlite3VdbeMakeLabel(v);
  84450. assert( nLeft==sqlite3ExprVectorSize(pRight) );
  84451. assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
  84452. || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
  84453. || pExpr->op==TK_LT || pExpr->op==TK_GT
  84454. || pExpr->op==TK_LE || pExpr->op==TK_GE
  84455. );
  84456. assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
  84457. || (pExpr->op==TK_ISNOT && op==TK_NE) );
  84458. assert( p5==0 || pExpr->op!=op );
  84459. assert( p5==SQLITE_NULLEQ || pExpr->op==op );
  84460. p5 |= SQLITE_STOREP2;
  84461. if( opx==TK_LE ) opx = TK_LT;
  84462. if( opx==TK_GE ) opx = TK_GT;
  84463. regLeft = exprCodeSubselect(pParse, pLeft);
  84464. regRight = exprCodeSubselect(pParse, pRight);
  84465. for(i=0; 1 /*Loop exits by "break"*/; i++){
  84466. int regFree1 = 0, regFree2 = 0;
  84467. Expr *pL, *pR;
  84468. int r1, r2;
  84469. assert( i>=0 && i<nLeft );
  84470. if( i>0 ) sqlite3ExprCachePush(pParse);
  84471. r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
  84472. r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
  84473. codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
  84474. testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  84475. testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  84476. testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  84477. testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  84478. testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
  84479. testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
  84480. sqlite3ReleaseTempReg(pParse, regFree1);
  84481. sqlite3ReleaseTempReg(pParse, regFree2);
  84482. if( i>0 ) sqlite3ExprCachePop(pParse);
  84483. if( i==nLeft-1 ){
  84484. break;
  84485. }
  84486. if( opx==TK_EQ ){
  84487. sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
  84488. p5 |= SQLITE_KEEPNULL;
  84489. }else if( opx==TK_NE ){
  84490. sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
  84491. p5 |= SQLITE_KEEPNULL;
  84492. }else{
  84493. assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
  84494. sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
  84495. VdbeCoverageIf(v, op==TK_LT);
  84496. VdbeCoverageIf(v, op==TK_GT);
  84497. VdbeCoverageIf(v, op==TK_LE);
  84498. VdbeCoverageIf(v, op==TK_GE);
  84499. if( i==nLeft-2 ) opx = op;
  84500. }
  84501. }
  84502. sqlite3VdbeResolveLabel(v, addrDone);
  84503. }
  84504. #if SQLITE_MAX_EXPR_DEPTH>0
  84505. /*
  84506. ** Check that argument nHeight is less than or equal to the maximum
  84507. ** expression depth allowed. If it is not, leave an error message in
  84508. ** pParse.
  84509. */
  84510. SQLITE_PRIVATE int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
  84511. int rc = SQLITE_OK;
  84512. int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
  84513. if( nHeight>mxHeight ){
  84514. sqlite3ErrorMsg(pParse,
  84515. "Expression tree is too large (maximum depth %d)", mxHeight
  84516. );
  84517. rc = SQLITE_ERROR;
  84518. }
  84519. return rc;
  84520. }
  84521. /* The following three functions, heightOfExpr(), heightOfExprList()
  84522. ** and heightOfSelect(), are used to determine the maximum height
  84523. ** of any expression tree referenced by the structure passed as the
  84524. ** first argument.
  84525. **
  84526. ** If this maximum height is greater than the current value pointed
  84527. ** to by pnHeight, the second parameter, then set *pnHeight to that
  84528. ** value.
  84529. */
  84530. static void heightOfExpr(Expr *p, int *pnHeight){
  84531. if( p ){
  84532. if( p->nHeight>*pnHeight ){
  84533. *pnHeight = p->nHeight;
  84534. }
  84535. }
  84536. }
  84537. static void heightOfExprList(ExprList *p, int *pnHeight){
  84538. if( p ){
  84539. int i;
  84540. for(i=0; i<p->nExpr; i++){
  84541. heightOfExpr(p->a[i].pExpr, pnHeight);
  84542. }
  84543. }
  84544. }
  84545. static void heightOfSelect(Select *p, int *pnHeight){
  84546. if( p ){
  84547. heightOfExpr(p->pWhere, pnHeight);
  84548. heightOfExpr(p->pHaving, pnHeight);
  84549. heightOfExpr(p->pLimit, pnHeight);
  84550. heightOfExpr(p->pOffset, pnHeight);
  84551. heightOfExprList(p->pEList, pnHeight);
  84552. heightOfExprList(p->pGroupBy, pnHeight);
  84553. heightOfExprList(p->pOrderBy, pnHeight);
  84554. heightOfSelect(p->pPrior, pnHeight);
  84555. }
  84556. }
  84557. /*
  84558. ** Set the Expr.nHeight variable in the structure passed as an
  84559. ** argument. An expression with no children, Expr.pList or
  84560. ** Expr.pSelect member has a height of 1. Any other expression
  84561. ** has a height equal to the maximum height of any other
  84562. ** referenced Expr plus one.
  84563. **
  84564. ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
  84565. ** if appropriate.
  84566. */
  84567. static void exprSetHeight(Expr *p){
  84568. int nHeight = 0;
  84569. heightOfExpr(p->pLeft, &nHeight);
  84570. heightOfExpr(p->pRight, &nHeight);
  84571. if( ExprHasProperty(p, EP_xIsSelect) ){
  84572. heightOfSelect(p->x.pSelect, &nHeight);
  84573. }else if( p->x.pList ){
  84574. heightOfExprList(p->x.pList, &nHeight);
  84575. p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
  84576. }
  84577. p->nHeight = nHeight + 1;
  84578. }
  84579. /*
  84580. ** Set the Expr.nHeight variable using the exprSetHeight() function. If
  84581. ** the height is greater than the maximum allowed expression depth,
  84582. ** leave an error in pParse.
  84583. **
  84584. ** Also propagate all EP_Propagate flags from the Expr.x.pList into
  84585. ** Expr.flags.
  84586. */
  84587. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
  84588. if( pParse->nErr ) return;
  84589. exprSetHeight(p);
  84590. sqlite3ExprCheckHeight(pParse, p->nHeight);
  84591. }
  84592. /*
  84593. ** Return the maximum height of any expression tree referenced
  84594. ** by the select statement passed as an argument.
  84595. */
  84596. SQLITE_PRIVATE int sqlite3SelectExprHeight(Select *p){
  84597. int nHeight = 0;
  84598. heightOfSelect(p, &nHeight);
  84599. return nHeight;
  84600. }
  84601. #else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
  84602. /*
  84603. ** Propagate all EP_Propagate flags from the Expr.x.pList into
  84604. ** Expr.flags.
  84605. */
  84606. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
  84607. if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
  84608. p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
  84609. }
  84610. }
  84611. #define exprSetHeight(y)
  84612. #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
  84613. /*
  84614. ** This routine is the core allocator for Expr nodes.
  84615. **
  84616. ** Construct a new expression node and return a pointer to it. Memory
  84617. ** for this node and for the pToken argument is a single allocation
  84618. ** obtained from sqlite3DbMalloc(). The calling function
  84619. ** is responsible for making sure the node eventually gets freed.
  84620. **
  84621. ** If dequote is true, then the token (if it exists) is dequoted.
  84622. ** If dequote is false, no dequoting is performed. The deQuote
  84623. ** parameter is ignored if pToken is NULL or if the token does not
  84624. ** appear to be quoted. If the quotes were of the form "..." (double-quotes)
  84625. ** then the EP_DblQuoted flag is set on the expression node.
  84626. **
  84627. ** Special case: If op==TK_INTEGER and pToken points to a string that
  84628. ** can be translated into a 32-bit integer, then the token is not
  84629. ** stored in u.zToken. Instead, the integer values is written
  84630. ** into u.iValue and the EP_IntValue flag is set. No extra storage
  84631. ** is allocated to hold the integer text and the dequote flag is ignored.
  84632. */
  84633. SQLITE_PRIVATE Expr *sqlite3ExprAlloc(
  84634. sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
  84635. int op, /* Expression opcode */
  84636. const Token *pToken, /* Token argument. Might be NULL */
  84637. int dequote /* True to dequote */
  84638. ){
  84639. Expr *pNew;
  84640. int nExtra = 0;
  84641. int iValue = 0;
  84642. assert( db!=0 );
  84643. if( pToken ){
  84644. if( op!=TK_INTEGER || pToken->z==0
  84645. || sqlite3GetInt32(pToken->z, &iValue)==0 ){
  84646. nExtra = pToken->n+1;
  84647. assert( iValue>=0 );
  84648. }
  84649. }
  84650. pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
  84651. if( pNew ){
  84652. memset(pNew, 0, sizeof(Expr));
  84653. pNew->op = (u8)op;
  84654. pNew->iAgg = -1;
  84655. if( pToken ){
  84656. if( nExtra==0 ){
  84657. pNew->flags |= EP_IntValue;
  84658. pNew->u.iValue = iValue;
  84659. }else{
  84660. pNew->u.zToken = (char*)&pNew[1];
  84661. assert( pToken->z!=0 || pToken->n==0 );
  84662. if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
  84663. pNew->u.zToken[pToken->n] = 0;
  84664. if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
  84665. if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
  84666. sqlite3Dequote(pNew->u.zToken);
  84667. }
  84668. }
  84669. }
  84670. #if SQLITE_MAX_EXPR_DEPTH>0
  84671. pNew->nHeight = 1;
  84672. #endif
  84673. }
  84674. return pNew;
  84675. }
  84676. /*
  84677. ** Allocate a new expression node from a zero-terminated token that has
  84678. ** already been dequoted.
  84679. */
  84680. SQLITE_PRIVATE Expr *sqlite3Expr(
  84681. sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
  84682. int op, /* Expression opcode */
  84683. const char *zToken /* Token argument. Might be NULL */
  84684. ){
  84685. Token x;
  84686. x.z = zToken;
  84687. x.n = zToken ? sqlite3Strlen30(zToken) : 0;
  84688. return sqlite3ExprAlloc(db, op, &x, 0);
  84689. }
  84690. /*
  84691. ** Attach subtrees pLeft and pRight to the Expr node pRoot.
  84692. **
  84693. ** If pRoot==NULL that means that a memory allocation error has occurred.
  84694. ** In that case, delete the subtrees pLeft and pRight.
  84695. */
  84696. SQLITE_PRIVATE void sqlite3ExprAttachSubtrees(
  84697. sqlite3 *db,
  84698. Expr *pRoot,
  84699. Expr *pLeft,
  84700. Expr *pRight
  84701. ){
  84702. if( pRoot==0 ){
  84703. assert( db->mallocFailed );
  84704. sqlite3ExprDelete(db, pLeft);
  84705. sqlite3ExprDelete(db, pRight);
  84706. }else{
  84707. if( pRight ){
  84708. pRoot->pRight = pRight;
  84709. pRoot->flags |= EP_Propagate & pRight->flags;
  84710. }
  84711. if( pLeft ){
  84712. pRoot->pLeft = pLeft;
  84713. pRoot->flags |= EP_Propagate & pLeft->flags;
  84714. }
  84715. exprSetHeight(pRoot);
  84716. }
  84717. }
  84718. /*
  84719. ** Allocate an Expr node which joins as many as two subtrees.
  84720. **
  84721. ** One or both of the subtrees can be NULL. Return a pointer to the new
  84722. ** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
  84723. ** free the subtrees and return NULL.
  84724. */
  84725. SQLITE_PRIVATE Expr *sqlite3PExpr(
  84726. Parse *pParse, /* Parsing context */
  84727. int op, /* Expression opcode */
  84728. Expr *pLeft, /* Left operand */
  84729. Expr *pRight, /* Right operand */
  84730. const Token *pToken /* Argument token */
  84731. ){
  84732. Expr *p;
  84733. if( op==TK_AND && pParse->nErr==0 ){
  84734. /* Take advantage of short-circuit false optimization for AND */
  84735. p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
  84736. }else{
  84737. p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
  84738. sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
  84739. }
  84740. if( p ) {
  84741. sqlite3ExprCheckHeight(pParse, p->nHeight);
  84742. }
  84743. return p;
  84744. }
  84745. /*
  84746. ** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
  84747. ** do a memory allocation failure) then delete the pSelect object.
  84748. */
  84749. SQLITE_PRIVATE void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
  84750. if( pExpr ){
  84751. pExpr->x.pSelect = pSelect;
  84752. ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
  84753. sqlite3ExprSetHeightAndFlags(pParse, pExpr);
  84754. }else{
  84755. assert( pParse->db->mallocFailed );
  84756. sqlite3SelectDelete(pParse->db, pSelect);
  84757. }
  84758. }
  84759. /*
  84760. ** If the expression is always either TRUE or FALSE (respectively),
  84761. ** then return 1. If one cannot determine the truth value of the
  84762. ** expression at compile-time return 0.
  84763. **
  84764. ** This is an optimization. If is OK to return 0 here even if
  84765. ** the expression really is always false or false (a false negative).
  84766. ** But it is a bug to return 1 if the expression might have different
  84767. ** boolean values in different circumstances (a false positive.)
  84768. **
  84769. ** Note that if the expression is part of conditional for a
  84770. ** LEFT JOIN, then we cannot determine at compile-time whether or not
  84771. ** is it true or false, so always return 0.
  84772. */
  84773. static int exprAlwaysTrue(Expr *p){
  84774. int v = 0;
  84775. if( ExprHasProperty(p, EP_FromJoin) ) return 0;
  84776. if( !sqlite3ExprIsInteger(p, &v) ) return 0;
  84777. return v!=0;
  84778. }
  84779. static int exprAlwaysFalse(Expr *p){
  84780. int v = 0;
  84781. if( ExprHasProperty(p, EP_FromJoin) ) return 0;
  84782. if( !sqlite3ExprIsInteger(p, &v) ) return 0;
  84783. return v==0;
  84784. }
  84785. /*
  84786. ** Join two expressions using an AND operator. If either expression is
  84787. ** NULL, then just return the other expression.
  84788. **
  84789. ** If one side or the other of the AND is known to be false, then instead
  84790. ** of returning an AND expression, just return a constant expression with
  84791. ** a value of false.
  84792. */
  84793. SQLITE_PRIVATE Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
  84794. if( pLeft==0 ){
  84795. return pRight;
  84796. }else if( pRight==0 ){
  84797. return pLeft;
  84798. }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
  84799. sqlite3ExprDelete(db, pLeft);
  84800. sqlite3ExprDelete(db, pRight);
  84801. return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
  84802. }else{
  84803. Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
  84804. sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
  84805. return pNew;
  84806. }
  84807. }
  84808. /*
  84809. ** Construct a new expression node for a function with multiple
  84810. ** arguments.
  84811. */
  84812. SQLITE_PRIVATE Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
  84813. Expr *pNew;
  84814. sqlite3 *db = pParse->db;
  84815. assert( pToken );
  84816. pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
  84817. if( pNew==0 ){
  84818. sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
  84819. return 0;
  84820. }
  84821. pNew->x.pList = pList;
  84822. assert( !ExprHasProperty(pNew, EP_xIsSelect) );
  84823. sqlite3ExprSetHeightAndFlags(pParse, pNew);
  84824. return pNew;
  84825. }
  84826. /*
  84827. ** Assign a variable number to an expression that encodes a wildcard
  84828. ** in the original SQL statement.
  84829. **
  84830. ** Wildcards consisting of a single "?" are assigned the next sequential
  84831. ** variable number.
  84832. **
  84833. ** Wildcards of the form "?nnn" are assigned the number "nnn". We make
  84834. ** sure "nnn" is not too be to avoid a denial of service attack when
  84835. ** the SQL statement comes from an external source.
  84836. **
  84837. ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
  84838. ** as the previous instance of the same wildcard. Or if this is the first
  84839. ** instance of the wildcard, the next sequential variable number is
  84840. ** assigned.
  84841. */
  84842. SQLITE_PRIVATE void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
  84843. sqlite3 *db = pParse->db;
  84844. const char *z;
  84845. if( pExpr==0 ) return;
  84846. assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
  84847. z = pExpr->u.zToken;
  84848. assert( z!=0 );
  84849. assert( z[0]!=0 );
  84850. assert( n==sqlite3Strlen30(z) );
  84851. if( z[1]==0 ){
  84852. /* Wildcard of the form "?". Assign the next variable number */
  84853. assert( z[0]=='?' );
  84854. pExpr->iColumn = (ynVar)(++pParse->nVar);
  84855. }else{
  84856. ynVar x;
  84857. if( z[0]=='?' ){
  84858. /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
  84859. ** use it as the variable number */
  84860. i64 i;
  84861. int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
  84862. x = (ynVar)i;
  84863. testcase( i==0 );
  84864. testcase( i==1 );
  84865. testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
  84866. testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
  84867. if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
  84868. sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
  84869. db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
  84870. return;
  84871. }
  84872. if( i>pParse->nVar ){
  84873. pParse->nVar = (int)i;
  84874. }
  84875. }else{
  84876. /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
  84877. ** number as the prior appearance of the same name, or if the name
  84878. ** has never appeared before, reuse the same variable number
  84879. */
  84880. ynVar i;
  84881. for(i=x=0; i<pParse->nzVar; i++){
  84882. if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
  84883. x = (ynVar)i+1;
  84884. break;
  84885. }
  84886. }
  84887. if( x==0 ) x = (ynVar)(++pParse->nVar);
  84888. }
  84889. pExpr->iColumn = x;
  84890. if( x>pParse->nzVar ){
  84891. char **a;
  84892. a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
  84893. if( a==0 ){
  84894. assert( db->mallocFailed ); /* Error reported through mallocFailed */
  84895. return;
  84896. }
  84897. pParse->azVar = a;
  84898. memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
  84899. pParse->nzVar = x;
  84900. }
  84901. if( pParse->azVar[x-1]==0 ){
  84902. pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
  84903. }
  84904. }
  84905. if( pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
  84906. sqlite3ErrorMsg(pParse, "too many SQL variables");
  84907. }
  84908. }
  84909. /*
  84910. ** Recursively delete an expression tree.
  84911. */
  84912. static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
  84913. assert( p!=0 );
  84914. /* Sanity check: Assert that the IntValue is non-negative if it exists */
  84915. assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
  84916. #ifdef SQLITE_DEBUG
  84917. if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
  84918. assert( p->pLeft==0 );
  84919. assert( p->pRight==0 );
  84920. assert( p->x.pSelect==0 );
  84921. }
  84922. #endif
  84923. if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
  84924. /* The Expr.x union is never used at the same time as Expr.pRight */
  84925. assert( p->x.pList==0 || p->pRight==0 );
  84926. if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
  84927. sqlite3ExprDelete(db, p->pRight);
  84928. if( ExprHasProperty(p, EP_xIsSelect) ){
  84929. sqlite3SelectDelete(db, p->x.pSelect);
  84930. }else{
  84931. sqlite3ExprListDelete(db, p->x.pList);
  84932. }
  84933. }
  84934. if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
  84935. if( !ExprHasProperty(p, EP_Static) ){
  84936. sqlite3DbFree(db, p);
  84937. }
  84938. }
  84939. SQLITE_PRIVATE void sqlite3ExprDelete(sqlite3 *db, Expr *p){
  84940. if( p ) sqlite3ExprDeleteNN(db, p);
  84941. }
  84942. /*
  84943. ** Return the number of bytes allocated for the expression structure
  84944. ** passed as the first argument. This is always one of EXPR_FULLSIZE,
  84945. ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
  84946. */
  84947. static int exprStructSize(Expr *p){
  84948. if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
  84949. if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
  84950. return EXPR_FULLSIZE;
  84951. }
  84952. /*
  84953. ** The dupedExpr*Size() routines each return the number of bytes required
  84954. ** to store a copy of an expression or expression tree. They differ in
  84955. ** how much of the tree is measured.
  84956. **
  84957. ** dupedExprStructSize() Size of only the Expr structure
  84958. ** dupedExprNodeSize() Size of Expr + space for token
  84959. ** dupedExprSize() Expr + token + subtree components
  84960. **
  84961. ***************************************************************************
  84962. **
  84963. ** The dupedExprStructSize() function returns two values OR-ed together:
  84964. ** (1) the space required for a copy of the Expr structure only and
  84965. ** (2) the EP_xxx flags that indicate what the structure size should be.
  84966. ** The return values is always one of:
  84967. **
  84968. ** EXPR_FULLSIZE
  84969. ** EXPR_REDUCEDSIZE | EP_Reduced
  84970. ** EXPR_TOKENONLYSIZE | EP_TokenOnly
  84971. **
  84972. ** The size of the structure can be found by masking the return value
  84973. ** of this routine with 0xfff. The flags can be found by masking the
  84974. ** return value with EP_Reduced|EP_TokenOnly.
  84975. **
  84976. ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
  84977. ** (unreduced) Expr objects as they or originally constructed by the parser.
  84978. ** During expression analysis, extra information is computed and moved into
  84979. ** later parts of teh Expr object and that extra information might get chopped
  84980. ** off if the expression is reduced. Note also that it does not work to
  84981. ** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
  84982. ** to reduce a pristine expression tree from the parser. The implementation
  84983. ** of dupedExprStructSize() contain multiple assert() statements that attempt
  84984. ** to enforce this constraint.
  84985. */
  84986. static int dupedExprStructSize(Expr *p, int flags){
  84987. int nSize;
  84988. assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
  84989. assert( EXPR_FULLSIZE<=0xfff );
  84990. assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
  84991. if( 0==flags ){
  84992. nSize = EXPR_FULLSIZE;
  84993. }else{
  84994. assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
  84995. assert( !ExprHasProperty(p, EP_FromJoin) );
  84996. assert( !ExprHasProperty(p, EP_MemToken) );
  84997. assert( !ExprHasProperty(p, EP_NoReduce) );
  84998. if( p->pLeft || p->x.pList ){
  84999. nSize = EXPR_REDUCEDSIZE | EP_Reduced;
  85000. }else{
  85001. assert( p->pRight==0 );
  85002. nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
  85003. }
  85004. }
  85005. return nSize;
  85006. }
  85007. /*
  85008. ** This function returns the space in bytes required to store the copy
  85009. ** of the Expr structure and a copy of the Expr.u.zToken string (if that
  85010. ** string is defined.)
  85011. */
  85012. static int dupedExprNodeSize(Expr *p, int flags){
  85013. int nByte = dupedExprStructSize(p, flags) & 0xfff;
  85014. if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
  85015. nByte += sqlite3Strlen30(p->u.zToken)+1;
  85016. }
  85017. return ROUND8(nByte);
  85018. }
  85019. /*
  85020. ** Return the number of bytes required to create a duplicate of the
  85021. ** expression passed as the first argument. The second argument is a
  85022. ** mask containing EXPRDUP_XXX flags.
  85023. **
  85024. ** The value returned includes space to create a copy of the Expr struct
  85025. ** itself and the buffer referred to by Expr.u.zToken, if any.
  85026. **
  85027. ** If the EXPRDUP_REDUCE flag is set, then the return value includes
  85028. ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
  85029. ** and Expr.pRight variables (but not for any structures pointed to or
  85030. ** descended from the Expr.x.pList or Expr.x.pSelect variables).
  85031. */
  85032. static int dupedExprSize(Expr *p, int flags){
  85033. int nByte = 0;
  85034. if( p ){
  85035. nByte = dupedExprNodeSize(p, flags);
  85036. if( flags&EXPRDUP_REDUCE ){
  85037. nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
  85038. }
  85039. }
  85040. return nByte;
  85041. }
  85042. /*
  85043. ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
  85044. ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
  85045. ** to store the copy of expression p, the copies of p->u.zToken
  85046. ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
  85047. ** if any. Before returning, *pzBuffer is set to the first byte past the
  85048. ** portion of the buffer copied into by this function.
  85049. */
  85050. static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
  85051. Expr *pNew; /* Value to return */
  85052. u8 *zAlloc; /* Memory space from which to build Expr object */
  85053. u32 staticFlag; /* EP_Static if space not obtained from malloc */
  85054. assert( db!=0 );
  85055. assert( p );
  85056. assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
  85057. assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
  85058. /* Figure out where to write the new Expr structure. */
  85059. if( pzBuffer ){
  85060. zAlloc = *pzBuffer;
  85061. staticFlag = EP_Static;
  85062. }else{
  85063. zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
  85064. staticFlag = 0;
  85065. }
  85066. pNew = (Expr *)zAlloc;
  85067. if( pNew ){
  85068. /* Set nNewSize to the size allocated for the structure pointed to
  85069. ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
  85070. ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
  85071. ** by the copy of the p->u.zToken string (if any).
  85072. */
  85073. const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
  85074. const int nNewSize = nStructSize & 0xfff;
  85075. int nToken;
  85076. if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
  85077. nToken = sqlite3Strlen30(p->u.zToken) + 1;
  85078. }else{
  85079. nToken = 0;
  85080. }
  85081. if( dupFlags ){
  85082. assert( ExprHasProperty(p, EP_Reduced)==0 );
  85083. memcpy(zAlloc, p, nNewSize);
  85084. }else{
  85085. u32 nSize = (u32)exprStructSize(p);
  85086. memcpy(zAlloc, p, nSize);
  85087. if( nSize<EXPR_FULLSIZE ){
  85088. memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
  85089. }
  85090. }
  85091. /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
  85092. pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
  85093. pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
  85094. pNew->flags |= staticFlag;
  85095. /* Copy the p->u.zToken string, if any. */
  85096. if( nToken ){
  85097. char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
  85098. memcpy(zToken, p->u.zToken, nToken);
  85099. }
  85100. if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
  85101. /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
  85102. if( ExprHasProperty(p, EP_xIsSelect) ){
  85103. pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
  85104. }else{
  85105. pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
  85106. }
  85107. }
  85108. /* Fill in pNew->pLeft and pNew->pRight. */
  85109. if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
  85110. zAlloc += dupedExprNodeSize(p, dupFlags);
  85111. if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
  85112. pNew->pLeft = p->pLeft ?
  85113. exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
  85114. pNew->pRight = p->pRight ?
  85115. exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
  85116. }
  85117. if( pzBuffer ){
  85118. *pzBuffer = zAlloc;
  85119. }
  85120. }else{
  85121. if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
  85122. if( pNew->op==TK_SELECT_COLUMN ){
  85123. pNew->pLeft = p->pLeft;
  85124. }else{
  85125. pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
  85126. }
  85127. pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
  85128. }
  85129. }
  85130. }
  85131. return pNew;
  85132. }
  85133. /*
  85134. ** Create and return a deep copy of the object passed as the second
  85135. ** argument. If an OOM condition is encountered, NULL is returned
  85136. ** and the db->mallocFailed flag set.
  85137. */
  85138. #ifndef SQLITE_OMIT_CTE
  85139. static With *withDup(sqlite3 *db, With *p){
  85140. With *pRet = 0;
  85141. if( p ){
  85142. int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
  85143. pRet = sqlite3DbMallocZero(db, nByte);
  85144. if( pRet ){
  85145. int i;
  85146. pRet->nCte = p->nCte;
  85147. for(i=0; i<p->nCte; i++){
  85148. pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
  85149. pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
  85150. pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
  85151. }
  85152. }
  85153. }
  85154. return pRet;
  85155. }
  85156. #else
  85157. # define withDup(x,y) 0
  85158. #endif
  85159. /*
  85160. ** The following group of routines make deep copies of expressions,
  85161. ** expression lists, ID lists, and select statements. The copies can
  85162. ** be deleted (by being passed to their respective ...Delete() routines)
  85163. ** without effecting the originals.
  85164. **
  85165. ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
  85166. ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
  85167. ** by subsequent calls to sqlite*ListAppend() routines.
  85168. **
  85169. ** Any tables that the SrcList might point to are not duplicated.
  85170. **
  85171. ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
  85172. ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
  85173. ** truncated version of the usual Expr structure that will be stored as
  85174. ** part of the in-memory representation of the database schema.
  85175. */
  85176. SQLITE_PRIVATE Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
  85177. assert( flags==0 || flags==EXPRDUP_REDUCE );
  85178. return p ? exprDup(db, p, flags, 0) : 0;
  85179. }
  85180. SQLITE_PRIVATE ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
  85181. ExprList *pNew;
  85182. struct ExprList_item *pItem, *pOldItem;
  85183. int i;
  85184. assert( db!=0 );
  85185. if( p==0 ) return 0;
  85186. pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
  85187. if( pNew==0 ) return 0;
  85188. pNew->nExpr = i = p->nExpr;
  85189. if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
  85190. pNew->a = pItem = sqlite3DbMallocRawNN(db, i*sizeof(p->a[0]) );
  85191. if( pItem==0 ){
  85192. sqlite3DbFree(db, pNew);
  85193. return 0;
  85194. }
  85195. pOldItem = p->a;
  85196. for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
  85197. Expr *pOldExpr = pOldItem->pExpr;
  85198. pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
  85199. pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  85200. pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
  85201. pItem->sortOrder = pOldItem->sortOrder;
  85202. pItem->done = 0;
  85203. pItem->bSpanIsTab = pOldItem->bSpanIsTab;
  85204. pItem->u = pOldItem->u;
  85205. }
  85206. return pNew;
  85207. }
  85208. /*
  85209. ** If cursors, triggers, views and subqueries are all omitted from
  85210. ** the build, then none of the following routines, except for
  85211. ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
  85212. ** called with a NULL argument.
  85213. */
  85214. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
  85215. || !defined(SQLITE_OMIT_SUBQUERY)
  85216. SQLITE_PRIVATE SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
  85217. SrcList *pNew;
  85218. int i;
  85219. int nByte;
  85220. assert( db!=0 );
  85221. if( p==0 ) return 0;
  85222. nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
  85223. pNew = sqlite3DbMallocRawNN(db, nByte );
  85224. if( pNew==0 ) return 0;
  85225. pNew->nSrc = pNew->nAlloc = p->nSrc;
  85226. for(i=0; i<p->nSrc; i++){
  85227. struct SrcList_item *pNewItem = &pNew->a[i];
  85228. struct SrcList_item *pOldItem = &p->a[i];
  85229. Table *pTab;
  85230. pNewItem->pSchema = pOldItem->pSchema;
  85231. pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
  85232. pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  85233. pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
  85234. pNewItem->fg = pOldItem->fg;
  85235. pNewItem->iCursor = pOldItem->iCursor;
  85236. pNewItem->addrFillSub = pOldItem->addrFillSub;
  85237. pNewItem->regReturn = pOldItem->regReturn;
  85238. if( pNewItem->fg.isIndexedBy ){
  85239. pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
  85240. }
  85241. pNewItem->pIBIndex = pOldItem->pIBIndex;
  85242. if( pNewItem->fg.isTabFunc ){
  85243. pNewItem->u1.pFuncArg =
  85244. sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
  85245. }
  85246. pTab = pNewItem->pTab = pOldItem->pTab;
  85247. if( pTab ){
  85248. pTab->nRef++;
  85249. }
  85250. pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
  85251. pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
  85252. pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
  85253. pNewItem->colUsed = pOldItem->colUsed;
  85254. }
  85255. return pNew;
  85256. }
  85257. SQLITE_PRIVATE IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
  85258. IdList *pNew;
  85259. int i;
  85260. assert( db!=0 );
  85261. if( p==0 ) return 0;
  85262. pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
  85263. if( pNew==0 ) return 0;
  85264. pNew->nId = p->nId;
  85265. pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
  85266. if( pNew->a==0 ){
  85267. sqlite3DbFree(db, pNew);
  85268. return 0;
  85269. }
  85270. /* Note that because the size of the allocation for p->a[] is not
  85271. ** necessarily a power of two, sqlite3IdListAppend() may not be called
  85272. ** on the duplicate created by this function. */
  85273. for(i=0; i<p->nId; i++){
  85274. struct IdList_item *pNewItem = &pNew->a[i];
  85275. struct IdList_item *pOldItem = &p->a[i];
  85276. pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  85277. pNewItem->idx = pOldItem->idx;
  85278. }
  85279. return pNew;
  85280. }
  85281. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
  85282. Select *pNew, *pPrior;
  85283. assert( db!=0 );
  85284. if( p==0 ) return 0;
  85285. pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
  85286. if( pNew==0 ) return 0;
  85287. pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
  85288. pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
  85289. pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
  85290. pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
  85291. pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
  85292. pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
  85293. pNew->op = p->op;
  85294. pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
  85295. if( pPrior ) pPrior->pNext = pNew;
  85296. pNew->pNext = 0;
  85297. pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
  85298. pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
  85299. pNew->iLimit = 0;
  85300. pNew->iOffset = 0;
  85301. pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
  85302. pNew->addrOpenEphm[0] = -1;
  85303. pNew->addrOpenEphm[1] = -1;
  85304. pNew->nSelectRow = p->nSelectRow;
  85305. pNew->pWith = withDup(db, p->pWith);
  85306. sqlite3SelectSetName(pNew, p->zSelName);
  85307. return pNew;
  85308. }
  85309. #else
  85310. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
  85311. assert( p==0 );
  85312. return 0;
  85313. }
  85314. #endif
  85315. /*
  85316. ** Add a new element to the end of an expression list. If pList is
  85317. ** initially NULL, then create a new expression list.
  85318. **
  85319. ** If a memory allocation error occurs, the entire list is freed and
  85320. ** NULL is returned. If non-NULL is returned, then it is guaranteed
  85321. ** that the new entry was successfully appended.
  85322. */
  85323. SQLITE_PRIVATE ExprList *sqlite3ExprListAppend(
  85324. Parse *pParse, /* Parsing context */
  85325. ExprList *pList, /* List to which to append. Might be NULL */
  85326. Expr *pExpr /* Expression to be appended. Might be NULL */
  85327. ){
  85328. sqlite3 *db = pParse->db;
  85329. assert( db!=0 );
  85330. if( pList==0 ){
  85331. pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
  85332. if( pList==0 ){
  85333. goto no_mem;
  85334. }
  85335. pList->nExpr = 0;
  85336. pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
  85337. if( pList->a==0 ) goto no_mem;
  85338. }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
  85339. struct ExprList_item *a;
  85340. assert( pList->nExpr>0 );
  85341. a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
  85342. if( a==0 ){
  85343. goto no_mem;
  85344. }
  85345. pList->a = a;
  85346. }
  85347. assert( pList->a!=0 );
  85348. if( 1 ){
  85349. struct ExprList_item *pItem = &pList->a[pList->nExpr++];
  85350. memset(pItem, 0, sizeof(*pItem));
  85351. pItem->pExpr = pExpr;
  85352. }
  85353. return pList;
  85354. no_mem:
  85355. /* Avoid leaking memory if malloc has failed. */
  85356. sqlite3ExprDelete(db, pExpr);
  85357. sqlite3ExprListDelete(db, pList);
  85358. return 0;
  85359. }
  85360. /*
  85361. ** pColumns and pExpr form a vector assignment which is part of the SET
  85362. ** clause of an UPDATE statement. Like this:
  85363. **
  85364. ** (a,b,c) = (expr1,expr2,expr3)
  85365. ** Or: (a,b,c) = (SELECT x,y,z FROM ....)
  85366. **
  85367. ** For each term of the vector assignment, append new entries to the
  85368. ** expression list pList. In the case of a subquery on the LHS, append
  85369. ** TK_SELECT_COLUMN expressions.
  85370. */
  85371. SQLITE_PRIVATE ExprList *sqlite3ExprListAppendVector(
  85372. Parse *pParse, /* Parsing context */
  85373. ExprList *pList, /* List to which to append. Might be NULL */
  85374. IdList *pColumns, /* List of names of LHS of the assignment */
  85375. Expr *pExpr /* Vector expression to be appended. Might be NULL */
  85376. ){
  85377. sqlite3 *db = pParse->db;
  85378. int n;
  85379. int i;
  85380. int iFirst = pList ? pList->nExpr : 0;
  85381. /* pColumns can only be NULL due to an OOM but an OOM will cause an
  85382. ** exit prior to this routine being invoked */
  85383. if( NEVER(pColumns==0) ) goto vector_append_error;
  85384. if( pExpr==0 ) goto vector_append_error;
  85385. n = sqlite3ExprVectorSize(pExpr);
  85386. if( pColumns->nId!=n ){
  85387. sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
  85388. pColumns->nId, n);
  85389. goto vector_append_error;
  85390. }
  85391. for(i=0; i<n; i++){
  85392. Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
  85393. pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
  85394. if( pList ){
  85395. assert( pList->nExpr==iFirst+i+1 );
  85396. pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
  85397. pColumns->a[i].zName = 0;
  85398. }
  85399. }
  85400. if( pExpr->op==TK_SELECT ){
  85401. if( pList && pList->a[iFirst].pExpr ){
  85402. assert( pList->a[iFirst].pExpr->op==TK_SELECT_COLUMN );
  85403. pList->a[iFirst].pExpr->pRight = pExpr;
  85404. pExpr = 0;
  85405. }
  85406. }
  85407. vector_append_error:
  85408. sqlite3ExprDelete(db, pExpr);
  85409. sqlite3IdListDelete(db, pColumns);
  85410. return pList;
  85411. }
  85412. /*
  85413. ** Set the sort order for the last element on the given ExprList.
  85414. */
  85415. SQLITE_PRIVATE void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
  85416. if( p==0 ) return;
  85417. assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
  85418. assert( p->nExpr>0 );
  85419. if( iSortOrder<0 ){
  85420. assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
  85421. return;
  85422. }
  85423. p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
  85424. }
  85425. /*
  85426. ** Set the ExprList.a[].zName element of the most recently added item
  85427. ** on the expression list.
  85428. **
  85429. ** pList might be NULL following an OOM error. But pName should never be
  85430. ** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
  85431. ** is set.
  85432. */
  85433. SQLITE_PRIVATE void sqlite3ExprListSetName(
  85434. Parse *pParse, /* Parsing context */
  85435. ExprList *pList, /* List to which to add the span. */
  85436. Token *pName, /* Name to be added */
  85437. int dequote /* True to cause the name to be dequoted */
  85438. ){
  85439. assert( pList!=0 || pParse->db->mallocFailed!=0 );
  85440. if( pList ){
  85441. struct ExprList_item *pItem;
  85442. assert( pList->nExpr>0 );
  85443. pItem = &pList->a[pList->nExpr-1];
  85444. assert( pItem->zName==0 );
  85445. pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
  85446. if( dequote ) sqlite3Dequote(pItem->zName);
  85447. }
  85448. }
  85449. /*
  85450. ** Set the ExprList.a[].zSpan element of the most recently added item
  85451. ** on the expression list.
  85452. **
  85453. ** pList might be NULL following an OOM error. But pSpan should never be
  85454. ** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
  85455. ** is set.
  85456. */
  85457. SQLITE_PRIVATE void sqlite3ExprListSetSpan(
  85458. Parse *pParse, /* Parsing context */
  85459. ExprList *pList, /* List to which to add the span. */
  85460. ExprSpan *pSpan /* The span to be added */
  85461. ){
  85462. sqlite3 *db = pParse->db;
  85463. assert( pList!=0 || db->mallocFailed!=0 );
  85464. if( pList ){
  85465. struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
  85466. assert( pList->nExpr>0 );
  85467. assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
  85468. sqlite3DbFree(db, pItem->zSpan);
  85469. pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
  85470. (int)(pSpan->zEnd - pSpan->zStart));
  85471. }
  85472. }
  85473. /*
  85474. ** If the expression list pEList contains more than iLimit elements,
  85475. ** leave an error message in pParse.
  85476. */
  85477. SQLITE_PRIVATE void sqlite3ExprListCheckLength(
  85478. Parse *pParse,
  85479. ExprList *pEList,
  85480. const char *zObject
  85481. ){
  85482. int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
  85483. testcase( pEList && pEList->nExpr==mx );
  85484. testcase( pEList && pEList->nExpr==mx+1 );
  85485. if( pEList && pEList->nExpr>mx ){
  85486. sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
  85487. }
  85488. }
  85489. /*
  85490. ** Delete an entire expression list.
  85491. */
  85492. static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
  85493. int i;
  85494. struct ExprList_item *pItem;
  85495. assert( pList->a!=0 || pList->nExpr==0 );
  85496. for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
  85497. sqlite3ExprDelete(db, pItem->pExpr);
  85498. sqlite3DbFree(db, pItem->zName);
  85499. sqlite3DbFree(db, pItem->zSpan);
  85500. }
  85501. sqlite3DbFree(db, pList->a);
  85502. sqlite3DbFree(db, pList);
  85503. }
  85504. SQLITE_PRIVATE void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
  85505. if( pList ) exprListDeleteNN(db, pList);
  85506. }
  85507. /*
  85508. ** Return the bitwise-OR of all Expr.flags fields in the given
  85509. ** ExprList.
  85510. */
  85511. SQLITE_PRIVATE u32 sqlite3ExprListFlags(const ExprList *pList){
  85512. int i;
  85513. u32 m = 0;
  85514. if( pList ){
  85515. for(i=0; i<pList->nExpr; i++){
  85516. Expr *pExpr = pList->a[i].pExpr;
  85517. assert( pExpr!=0 );
  85518. m |= pExpr->flags;
  85519. }
  85520. }
  85521. return m;
  85522. }
  85523. /*
  85524. ** These routines are Walker callbacks used to check expressions to
  85525. ** see if they are "constant" for some definition of constant. The
  85526. ** Walker.eCode value determines the type of "constant" we are looking
  85527. ** for.
  85528. **
  85529. ** These callback routines are used to implement the following:
  85530. **
  85531. ** sqlite3ExprIsConstant() pWalker->eCode==1
  85532. ** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
  85533. ** sqlite3ExprIsTableConstant() pWalker->eCode==3
  85534. ** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
  85535. **
  85536. ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
  85537. ** is found to not be a constant.
  85538. **
  85539. ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
  85540. ** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
  85541. ** an existing schema and 4 when processing a new statement. A bound
  85542. ** parameter raises an error for new statements, but is silently converted
  85543. ** to NULL for existing schemas. This allows sqlite_master tables that
  85544. ** contain a bound parameter because they were generated by older versions
  85545. ** of SQLite to be parsed by newer versions of SQLite without raising a
  85546. ** malformed schema error.
  85547. */
  85548. static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
  85549. /* If pWalker->eCode is 2 then any term of the expression that comes from
  85550. ** the ON or USING clauses of a left join disqualifies the expression
  85551. ** from being considered constant. */
  85552. if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
  85553. pWalker->eCode = 0;
  85554. return WRC_Abort;
  85555. }
  85556. switch( pExpr->op ){
  85557. /* Consider functions to be constant if all their arguments are constant
  85558. ** and either pWalker->eCode==4 or 5 or the function has the
  85559. ** SQLITE_FUNC_CONST flag. */
  85560. case TK_FUNCTION:
  85561. if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
  85562. return WRC_Continue;
  85563. }else{
  85564. pWalker->eCode = 0;
  85565. return WRC_Abort;
  85566. }
  85567. case TK_ID:
  85568. case TK_COLUMN:
  85569. case TK_AGG_FUNCTION:
  85570. case TK_AGG_COLUMN:
  85571. testcase( pExpr->op==TK_ID );
  85572. testcase( pExpr->op==TK_COLUMN );
  85573. testcase( pExpr->op==TK_AGG_FUNCTION );
  85574. testcase( pExpr->op==TK_AGG_COLUMN );
  85575. if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
  85576. return WRC_Continue;
  85577. }else{
  85578. pWalker->eCode = 0;
  85579. return WRC_Abort;
  85580. }
  85581. case TK_VARIABLE:
  85582. if( pWalker->eCode==5 ){
  85583. /* Silently convert bound parameters that appear inside of CREATE
  85584. ** statements into a NULL when parsing the CREATE statement text out
  85585. ** of the sqlite_master table */
  85586. pExpr->op = TK_NULL;
  85587. }else if( pWalker->eCode==4 ){
  85588. /* A bound parameter in a CREATE statement that originates from
  85589. ** sqlite3_prepare() causes an error */
  85590. pWalker->eCode = 0;
  85591. return WRC_Abort;
  85592. }
  85593. /* Fall through */
  85594. default:
  85595. testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
  85596. testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
  85597. return WRC_Continue;
  85598. }
  85599. }
  85600. static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
  85601. UNUSED_PARAMETER(NotUsed);
  85602. pWalker->eCode = 0;
  85603. return WRC_Abort;
  85604. }
  85605. static int exprIsConst(Expr *p, int initFlag, int iCur){
  85606. Walker w;
  85607. memset(&w, 0, sizeof(w));
  85608. w.eCode = initFlag;
  85609. w.xExprCallback = exprNodeIsConstant;
  85610. w.xSelectCallback = selectNodeIsConstant;
  85611. w.u.iCur = iCur;
  85612. sqlite3WalkExpr(&w, p);
  85613. return w.eCode;
  85614. }
  85615. /*
  85616. ** Walk an expression tree. Return non-zero if the expression is constant
  85617. ** and 0 if it involves variables or function calls.
  85618. **
  85619. ** For the purposes of this function, a double-quoted string (ex: "abc")
  85620. ** is considered a variable but a single-quoted string (ex: 'abc') is
  85621. ** a constant.
  85622. */
  85623. SQLITE_PRIVATE int sqlite3ExprIsConstant(Expr *p){
  85624. return exprIsConst(p, 1, 0);
  85625. }
  85626. /*
  85627. ** Walk an expression tree. Return non-zero if the expression is constant
  85628. ** that does no originate from the ON or USING clauses of a join.
  85629. ** Return 0 if it involves variables or function calls or terms from
  85630. ** an ON or USING clause.
  85631. */
  85632. SQLITE_PRIVATE int sqlite3ExprIsConstantNotJoin(Expr *p){
  85633. return exprIsConst(p, 2, 0);
  85634. }
  85635. /*
  85636. ** Walk an expression tree. Return non-zero if the expression is constant
  85637. ** for any single row of the table with cursor iCur. In other words, the
  85638. ** expression must not refer to any non-deterministic function nor any
  85639. ** table other than iCur.
  85640. */
  85641. SQLITE_PRIVATE int sqlite3ExprIsTableConstant(Expr *p, int iCur){
  85642. return exprIsConst(p, 3, iCur);
  85643. }
  85644. /*
  85645. ** Walk an expression tree. Return non-zero if the expression is constant
  85646. ** or a function call with constant arguments. Return and 0 if there
  85647. ** are any variables.
  85648. **
  85649. ** For the purposes of this function, a double-quoted string (ex: "abc")
  85650. ** is considered a variable but a single-quoted string (ex: 'abc') is
  85651. ** a constant.
  85652. */
  85653. SQLITE_PRIVATE int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
  85654. assert( isInit==0 || isInit==1 );
  85655. return exprIsConst(p, 4+isInit, 0);
  85656. }
  85657. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  85658. /*
  85659. ** Walk an expression tree. Return 1 if the expression contains a
  85660. ** subquery of some kind. Return 0 if there are no subqueries.
  85661. */
  85662. SQLITE_PRIVATE int sqlite3ExprContainsSubquery(Expr *p){
  85663. Walker w;
  85664. memset(&w, 0, sizeof(w));
  85665. w.eCode = 1;
  85666. w.xExprCallback = sqlite3ExprWalkNoop;
  85667. w.xSelectCallback = selectNodeIsConstant;
  85668. sqlite3WalkExpr(&w, p);
  85669. return w.eCode==0;
  85670. }
  85671. #endif
  85672. /*
  85673. ** If the expression p codes a constant integer that is small enough
  85674. ** to fit in a 32-bit integer, return 1 and put the value of the integer
  85675. ** in *pValue. If the expression is not an integer or if it is too big
  85676. ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
  85677. */
  85678. SQLITE_PRIVATE int sqlite3ExprIsInteger(Expr *p, int *pValue){
  85679. int rc = 0;
  85680. /* If an expression is an integer literal that fits in a signed 32-bit
  85681. ** integer, then the EP_IntValue flag will have already been set */
  85682. assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
  85683. || sqlite3GetInt32(p->u.zToken, &rc)==0 );
  85684. if( p->flags & EP_IntValue ){
  85685. *pValue = p->u.iValue;
  85686. return 1;
  85687. }
  85688. switch( p->op ){
  85689. case TK_UPLUS: {
  85690. rc = sqlite3ExprIsInteger(p->pLeft, pValue);
  85691. break;
  85692. }
  85693. case TK_UMINUS: {
  85694. int v;
  85695. if( sqlite3ExprIsInteger(p->pLeft, &v) ){
  85696. assert( v!=(-2147483647-1) );
  85697. *pValue = -v;
  85698. rc = 1;
  85699. }
  85700. break;
  85701. }
  85702. default: break;
  85703. }
  85704. return rc;
  85705. }
  85706. /*
  85707. ** Return FALSE if there is no chance that the expression can be NULL.
  85708. **
  85709. ** If the expression might be NULL or if the expression is too complex
  85710. ** to tell return TRUE.
  85711. **
  85712. ** This routine is used as an optimization, to skip OP_IsNull opcodes
  85713. ** when we know that a value cannot be NULL. Hence, a false positive
  85714. ** (returning TRUE when in fact the expression can never be NULL) might
  85715. ** be a small performance hit but is otherwise harmless. On the other
  85716. ** hand, a false negative (returning FALSE when the result could be NULL)
  85717. ** will likely result in an incorrect answer. So when in doubt, return
  85718. ** TRUE.
  85719. */
  85720. SQLITE_PRIVATE int sqlite3ExprCanBeNull(const Expr *p){
  85721. u8 op;
  85722. while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
  85723. op = p->op;
  85724. if( op==TK_REGISTER ) op = p->op2;
  85725. switch( op ){
  85726. case TK_INTEGER:
  85727. case TK_STRING:
  85728. case TK_FLOAT:
  85729. case TK_BLOB:
  85730. return 0;
  85731. case TK_COLUMN:
  85732. assert( p->pTab!=0 );
  85733. return ExprHasProperty(p, EP_CanBeNull) ||
  85734. (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
  85735. default:
  85736. return 1;
  85737. }
  85738. }
  85739. /*
  85740. ** Return TRUE if the given expression is a constant which would be
  85741. ** unchanged by OP_Affinity with the affinity given in the second
  85742. ** argument.
  85743. **
  85744. ** This routine is used to determine if the OP_Affinity operation
  85745. ** can be omitted. When in doubt return FALSE. A false negative
  85746. ** is harmless. A false positive, however, can result in the wrong
  85747. ** answer.
  85748. */
  85749. SQLITE_PRIVATE int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
  85750. u8 op;
  85751. if( aff==SQLITE_AFF_BLOB ) return 1;
  85752. while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
  85753. op = p->op;
  85754. if( op==TK_REGISTER ) op = p->op2;
  85755. switch( op ){
  85756. case TK_INTEGER: {
  85757. return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
  85758. }
  85759. case TK_FLOAT: {
  85760. return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
  85761. }
  85762. case TK_STRING: {
  85763. return aff==SQLITE_AFF_TEXT;
  85764. }
  85765. case TK_BLOB: {
  85766. return 1;
  85767. }
  85768. case TK_COLUMN: {
  85769. assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
  85770. return p->iColumn<0
  85771. && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
  85772. }
  85773. default: {
  85774. return 0;
  85775. }
  85776. }
  85777. }
  85778. /*
  85779. ** Return TRUE if the given string is a row-id column name.
  85780. */
  85781. SQLITE_PRIVATE int sqlite3IsRowid(const char *z){
  85782. if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
  85783. if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
  85784. if( sqlite3StrICmp(z, "OID")==0 ) return 1;
  85785. return 0;
  85786. }
  85787. /*
  85788. ** pX is the RHS of an IN operator. If pX is a SELECT statement
  85789. ** that can be simplified to a direct table access, then return
  85790. ** a pointer to the SELECT statement. If pX is not a SELECT statement,
  85791. ** or if the SELECT statement needs to be manifested into a transient
  85792. ** table, then return NULL.
  85793. */
  85794. #ifndef SQLITE_OMIT_SUBQUERY
  85795. static Select *isCandidateForInOpt(Expr *pX){
  85796. Select *p;
  85797. SrcList *pSrc;
  85798. ExprList *pEList;
  85799. Table *pTab;
  85800. int i;
  85801. if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
  85802. if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
  85803. p = pX->x.pSelect;
  85804. if( p->pPrior ) return 0; /* Not a compound SELECT */
  85805. if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
  85806. testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
  85807. testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
  85808. return 0; /* No DISTINCT keyword and no aggregate functions */
  85809. }
  85810. assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
  85811. if( p->pLimit ) return 0; /* Has no LIMIT clause */
  85812. assert( p->pOffset==0 ); /* No LIMIT means no OFFSET */
  85813. if( p->pWhere ) return 0; /* Has no WHERE clause */
  85814. pSrc = p->pSrc;
  85815. assert( pSrc!=0 );
  85816. if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
  85817. if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
  85818. pTab = pSrc->a[0].pTab;
  85819. assert( pTab!=0 );
  85820. assert( pTab->pSelect==0 ); /* FROM clause is not a view */
  85821. if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
  85822. pEList = p->pEList;
  85823. assert( pEList!=0 );
  85824. /* All SELECT results must be columns. */
  85825. for(i=0; i<pEList->nExpr; i++){
  85826. Expr *pRes = pEList->a[i].pExpr;
  85827. if( pRes->op!=TK_COLUMN ) return 0;
  85828. assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
  85829. }
  85830. return p;
  85831. }
  85832. #endif /* SQLITE_OMIT_SUBQUERY */
  85833. #ifndef SQLITE_OMIT_SUBQUERY
  85834. /*
  85835. ** Generate code that checks the left-most column of index table iCur to see if
  85836. ** it contains any NULL entries. Cause the register at regHasNull to be set
  85837. ** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
  85838. ** to be set to NULL if iCur contains one or more NULL values.
  85839. */
  85840. static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
  85841. int addr1;
  85842. sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
  85843. addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
  85844. sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
  85845. sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
  85846. VdbeComment((v, "first_entry_in(%d)", iCur));
  85847. sqlite3VdbeJumpHere(v, addr1);
  85848. }
  85849. #endif
  85850. #ifndef SQLITE_OMIT_SUBQUERY
  85851. /*
  85852. ** The argument is an IN operator with a list (not a subquery) on the
  85853. ** right-hand side. Return TRUE if that list is constant.
  85854. */
  85855. static int sqlite3InRhsIsConstant(Expr *pIn){
  85856. Expr *pLHS;
  85857. int res;
  85858. assert( !ExprHasProperty(pIn, EP_xIsSelect) );
  85859. pLHS = pIn->pLeft;
  85860. pIn->pLeft = 0;
  85861. res = sqlite3ExprIsConstant(pIn);
  85862. pIn->pLeft = pLHS;
  85863. return res;
  85864. }
  85865. #endif
  85866. /*
  85867. ** This function is used by the implementation of the IN (...) operator.
  85868. ** The pX parameter is the expression on the RHS of the IN operator, which
  85869. ** might be either a list of expressions or a subquery.
  85870. **
  85871. ** The job of this routine is to find or create a b-tree object that can
  85872. ** be used either to test for membership in the RHS set or to iterate through
  85873. ** all members of the RHS set, skipping duplicates.
  85874. **
  85875. ** A cursor is opened on the b-tree object that is the RHS of the IN operator
  85876. ** and pX->iTable is set to the index of that cursor.
  85877. **
  85878. ** The returned value of this function indicates the b-tree type, as follows:
  85879. **
  85880. ** IN_INDEX_ROWID - The cursor was opened on a database table.
  85881. ** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
  85882. ** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
  85883. ** IN_INDEX_EPH - The cursor was opened on a specially created and
  85884. ** populated epheremal table.
  85885. ** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
  85886. ** implemented as a sequence of comparisons.
  85887. **
  85888. ** An existing b-tree might be used if the RHS expression pX is a simple
  85889. ** subquery such as:
  85890. **
  85891. ** SELECT <column1>, <column2>... FROM <table>
  85892. **
  85893. ** If the RHS of the IN operator is a list or a more complex subquery, then
  85894. ** an ephemeral table might need to be generated from the RHS and then
  85895. ** pX->iTable made to point to the ephemeral table instead of an
  85896. ** existing table.
  85897. **
  85898. ** The inFlags parameter must contain exactly one of the bits
  85899. ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP. If inFlags contains
  85900. ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
  85901. ** fast membership test. When the IN_INDEX_LOOP bit is set, the
  85902. ** IN index will be used to loop over all values of the RHS of the
  85903. ** IN operator.
  85904. **
  85905. ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
  85906. ** through the set members) then the b-tree must not contain duplicates.
  85907. ** An epheremal table must be used unless the selected columns are guaranteed
  85908. ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
  85909. ** a UNIQUE constraint or index.
  85910. **
  85911. ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
  85912. ** for fast set membership tests) then an epheremal table must
  85913. ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
  85914. ** index can be found with the specified <columns> as its left-most.
  85915. **
  85916. ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
  85917. ** if the RHS of the IN operator is a list (not a subquery) then this
  85918. ** routine might decide that creating an ephemeral b-tree for membership
  85919. ** testing is too expensive and return IN_INDEX_NOOP. In that case, the
  85920. ** calling routine should implement the IN operator using a sequence
  85921. ** of Eq or Ne comparison operations.
  85922. **
  85923. ** When the b-tree is being used for membership tests, the calling function
  85924. ** might need to know whether or not the RHS side of the IN operator
  85925. ** contains a NULL. If prRhsHasNull is not a NULL pointer and
  85926. ** if there is any chance that the (...) might contain a NULL value at
  85927. ** runtime, then a register is allocated and the register number written
  85928. ** to *prRhsHasNull. If there is no chance that the (...) contains a
  85929. ** NULL value, then *prRhsHasNull is left unchanged.
  85930. **
  85931. ** If a register is allocated and its location stored in *prRhsHasNull, then
  85932. ** the value in that register will be NULL if the b-tree contains one or more
  85933. ** NULL values, and it will be some non-NULL value if the b-tree contains no
  85934. ** NULL values.
  85935. **
  85936. ** If the aiMap parameter is not NULL, it must point to an array containing
  85937. ** one element for each column returned by the SELECT statement on the RHS
  85938. ** of the IN(...) operator. The i'th entry of the array is populated with the
  85939. ** offset of the index column that matches the i'th column returned by the
  85940. ** SELECT. For example, if the expression and selected index are:
  85941. **
  85942. ** (?,?,?) IN (SELECT a, b, c FROM t1)
  85943. ** CREATE INDEX i1 ON t1(b, c, a);
  85944. **
  85945. ** then aiMap[] is populated with {2, 0, 1}.
  85946. */
  85947. #ifndef SQLITE_OMIT_SUBQUERY
  85948. SQLITE_PRIVATE int sqlite3FindInIndex(
  85949. Parse *pParse, /* Parsing context */
  85950. Expr *pX, /* The right-hand side (RHS) of the IN operator */
  85951. u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
  85952. int *prRhsHasNull, /* Register holding NULL status. See notes */
  85953. int *aiMap /* Mapping from Index fields to RHS fields */
  85954. ){
  85955. Select *p; /* SELECT to the right of IN operator */
  85956. int eType = 0; /* Type of RHS table. IN_INDEX_* */
  85957. int iTab = pParse->nTab++; /* Cursor of the RHS table */
  85958. int mustBeUnique; /* True if RHS must be unique */
  85959. Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
  85960. assert( pX->op==TK_IN );
  85961. mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
  85962. /* If the RHS of this IN(...) operator is a SELECT, and if it matters
  85963. ** whether or not the SELECT result contains NULL values, check whether
  85964. ** or not NULL is actually possible (it may not be, for example, due
  85965. ** to NOT NULL constraints in the schema). If no NULL values are possible,
  85966. ** set prRhsHasNull to 0 before continuing. */
  85967. if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
  85968. int i;
  85969. ExprList *pEList = pX->x.pSelect->pEList;
  85970. for(i=0; i<pEList->nExpr; i++){
  85971. if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
  85972. }
  85973. if( i==pEList->nExpr ){
  85974. prRhsHasNull = 0;
  85975. }
  85976. }
  85977. /* Check to see if an existing table or index can be used to
  85978. ** satisfy the query. This is preferable to generating a new
  85979. ** ephemeral table. */
  85980. if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
  85981. sqlite3 *db = pParse->db; /* Database connection */
  85982. Table *pTab; /* Table <table>. */
  85983. i16 iDb; /* Database idx for pTab */
  85984. ExprList *pEList = p->pEList;
  85985. int nExpr = pEList->nExpr;
  85986. assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
  85987. assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
  85988. assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
  85989. pTab = p->pSrc->a[0].pTab;
  85990. /* Code an OP_Transaction and OP_TableLock for <table>. */
  85991. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  85992. sqlite3CodeVerifySchema(pParse, iDb);
  85993. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  85994. assert(v); /* sqlite3GetVdbe() has always been previously called */
  85995. if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
  85996. /* The "x IN (SELECT rowid FROM table)" case */
  85997. int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
  85998. VdbeCoverage(v);
  85999. sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
  86000. eType = IN_INDEX_ROWID;
  86001. sqlite3VdbeJumpHere(v, iAddr);
  86002. }else{
  86003. Index *pIdx; /* Iterator variable */
  86004. int affinity_ok = 1;
  86005. int i;
  86006. /* Check that the affinity that will be used to perform each
  86007. ** comparison is the same as the affinity of each column in table
  86008. ** on the RHS of the IN operator. If it not, it is not possible to
  86009. ** use any index of the RHS table. */
  86010. for(i=0; i<nExpr && affinity_ok; i++){
  86011. Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
  86012. int iCol = pEList->a[i].pExpr->iColumn;
  86013. char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
  86014. char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
  86015. testcase( cmpaff==SQLITE_AFF_BLOB );
  86016. testcase( cmpaff==SQLITE_AFF_TEXT );
  86017. switch( cmpaff ){
  86018. case SQLITE_AFF_BLOB:
  86019. break;
  86020. case SQLITE_AFF_TEXT:
  86021. /* sqlite3CompareAffinity() only returns TEXT if one side or the
  86022. ** other has no affinity and the other side is TEXT. Hence,
  86023. ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
  86024. ** and for the term on the LHS of the IN to have no affinity. */
  86025. assert( idxaff==SQLITE_AFF_TEXT );
  86026. break;
  86027. default:
  86028. affinity_ok = sqlite3IsNumericAffinity(idxaff);
  86029. }
  86030. }
  86031. if( affinity_ok ){
  86032. /* Search for an existing index that will work for this IN operator */
  86033. for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
  86034. Bitmask colUsed; /* Columns of the index used */
  86035. Bitmask mCol; /* Mask for the current column */
  86036. if( pIdx->nColumn<nExpr ) continue;
  86037. /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
  86038. ** BITMASK(nExpr) without overflowing */
  86039. testcase( pIdx->nColumn==BMS-2 );
  86040. testcase( pIdx->nColumn==BMS-1 );
  86041. if( pIdx->nColumn>=BMS-1 ) continue;
  86042. if( mustBeUnique ){
  86043. if( pIdx->nKeyCol>nExpr
  86044. ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
  86045. ){
  86046. continue; /* This index is not unique over the IN RHS columns */
  86047. }
  86048. }
  86049. colUsed = 0; /* Columns of index used so far */
  86050. for(i=0; i<nExpr; i++){
  86051. Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
  86052. Expr *pRhs = pEList->a[i].pExpr;
  86053. CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
  86054. int j;
  86055. assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
  86056. for(j=0; j<nExpr; j++){
  86057. if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
  86058. assert( pIdx->azColl[j] );
  86059. if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
  86060. continue;
  86061. }
  86062. break;
  86063. }
  86064. if( j==nExpr ) break;
  86065. mCol = MASKBIT(j);
  86066. if( mCol & colUsed ) break; /* Each column used only once */
  86067. colUsed |= mCol;
  86068. if( aiMap ) aiMap[i] = j;
  86069. }
  86070. assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
  86071. if( colUsed==(MASKBIT(nExpr)-1) ){
  86072. /* If we reach this point, that means the index pIdx is usable */
  86073. int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  86074. #ifndef SQLITE_OMIT_EXPLAIN
  86075. sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
  86076. sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
  86077. P4_DYNAMIC);
  86078. #endif
  86079. sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
  86080. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  86081. VdbeComment((v, "%s", pIdx->zName));
  86082. assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
  86083. eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
  86084. if( prRhsHasNull ){
  86085. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  86086. i64 mask = (1<<nExpr)-1;
  86087. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
  86088. iTab, 0, 0, (u8*)&mask, P4_INT64);
  86089. #endif
  86090. *prRhsHasNull = ++pParse->nMem;
  86091. if( nExpr==1 ){
  86092. sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
  86093. }
  86094. }
  86095. sqlite3VdbeJumpHere(v, iAddr);
  86096. }
  86097. } /* End loop over indexes */
  86098. } /* End if( affinity_ok ) */
  86099. } /* End if not an rowid index */
  86100. } /* End attempt to optimize using an index */
  86101. /* If no preexisting index is available for the IN clause
  86102. ** and IN_INDEX_NOOP is an allowed reply
  86103. ** and the RHS of the IN operator is a list, not a subquery
  86104. ** and the RHS is not constant or has two or fewer terms,
  86105. ** then it is not worth creating an ephemeral table to evaluate
  86106. ** the IN operator so return IN_INDEX_NOOP.
  86107. */
  86108. if( eType==0
  86109. && (inFlags & IN_INDEX_NOOP_OK)
  86110. && !ExprHasProperty(pX, EP_xIsSelect)
  86111. && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
  86112. ){
  86113. eType = IN_INDEX_NOOP;
  86114. }
  86115. if( eType==0 ){
  86116. /* Could not find an existing table or index to use as the RHS b-tree.
  86117. ** We will have to generate an ephemeral table to do the job.
  86118. */
  86119. u32 savedNQueryLoop = pParse->nQueryLoop;
  86120. int rMayHaveNull = 0;
  86121. eType = IN_INDEX_EPH;
  86122. if( inFlags & IN_INDEX_LOOP ){
  86123. pParse->nQueryLoop = 0;
  86124. if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
  86125. eType = IN_INDEX_ROWID;
  86126. }
  86127. }else if( prRhsHasNull ){
  86128. *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
  86129. }
  86130. sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
  86131. pParse->nQueryLoop = savedNQueryLoop;
  86132. }else{
  86133. pX->iTable = iTab;
  86134. }
  86135. if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
  86136. int i, n;
  86137. n = sqlite3ExprVectorSize(pX->pLeft);
  86138. for(i=0; i<n; i++) aiMap[i] = i;
  86139. }
  86140. return eType;
  86141. }
  86142. #endif
  86143. #ifndef SQLITE_OMIT_SUBQUERY
  86144. /*
  86145. ** Argument pExpr is an (?, ?...) IN(...) expression. This
  86146. ** function allocates and returns a nul-terminated string containing
  86147. ** the affinities to be used for each column of the comparison.
  86148. **
  86149. ** It is the responsibility of the caller to ensure that the returned
  86150. ** string is eventually freed using sqlite3DbFree().
  86151. */
  86152. static char *exprINAffinity(Parse *pParse, Expr *pExpr){
  86153. Expr *pLeft = pExpr->pLeft;
  86154. int nVal = sqlite3ExprVectorSize(pLeft);
  86155. Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
  86156. char *zRet;
  86157. assert( pExpr->op==TK_IN );
  86158. zRet = sqlite3DbMallocZero(pParse->db, nVal+1);
  86159. if( zRet ){
  86160. int i;
  86161. for(i=0; i<nVal; i++){
  86162. Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
  86163. char a = sqlite3ExprAffinity(pA);
  86164. if( pSelect ){
  86165. zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
  86166. }else{
  86167. zRet[i] = a;
  86168. }
  86169. }
  86170. zRet[nVal] = '\0';
  86171. }
  86172. return zRet;
  86173. }
  86174. #endif
  86175. #ifndef SQLITE_OMIT_SUBQUERY
  86176. /*
  86177. ** Load the Parse object passed as the first argument with an error
  86178. ** message of the form:
  86179. **
  86180. ** "sub-select returns N columns - expected M"
  86181. */
  86182. SQLITE_PRIVATE void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
  86183. const char *zFmt = "sub-select returns %d columns - expected %d";
  86184. sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
  86185. }
  86186. #endif
  86187. /*
  86188. ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
  86189. ** or IN operators. Examples:
  86190. **
  86191. ** (SELECT a FROM b) -- subquery
  86192. ** EXISTS (SELECT a FROM b) -- EXISTS subquery
  86193. ** x IN (4,5,11) -- IN operator with list on right-hand side
  86194. ** x IN (SELECT a FROM b) -- IN operator with subquery on the right
  86195. **
  86196. ** The pExpr parameter describes the expression that contains the IN
  86197. ** operator or subquery.
  86198. **
  86199. ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
  86200. ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
  86201. ** to some integer key column of a table B-Tree. In this case, use an
  86202. ** intkey B-Tree to store the set of IN(...) values instead of the usual
  86203. ** (slower) variable length keys B-Tree.
  86204. **
  86205. ** If rMayHaveNull is non-zero, that means that the operation is an IN
  86206. ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
  86207. ** All this routine does is initialize the register given by rMayHaveNull
  86208. ** to NULL. Calling routines will take care of changing this register
  86209. ** value to non-NULL if the RHS is NULL-free.
  86210. **
  86211. ** For a SELECT or EXISTS operator, return the register that holds the
  86212. ** result. For a multi-column SELECT, the result is stored in a contiguous
  86213. ** array of registers and the return value is the register of the left-most
  86214. ** result column. Return 0 for IN operators or if an error occurs.
  86215. */
  86216. #ifndef SQLITE_OMIT_SUBQUERY
  86217. SQLITE_PRIVATE int sqlite3CodeSubselect(
  86218. Parse *pParse, /* Parsing context */
  86219. Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
  86220. int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
  86221. int isRowid /* If true, LHS of IN operator is a rowid */
  86222. ){
  86223. int jmpIfDynamic = -1; /* One-time test address */
  86224. int rReg = 0; /* Register storing resulting */
  86225. Vdbe *v = sqlite3GetVdbe(pParse);
  86226. if( NEVER(v==0) ) return 0;
  86227. sqlite3ExprCachePush(pParse);
  86228. /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
  86229. ** is encountered if any of the following is true:
  86230. **
  86231. ** * The right-hand side is a correlated subquery
  86232. ** * The right-hand side is an expression list containing variables
  86233. ** * We are inside a trigger
  86234. **
  86235. ** If all of the above are false, then we can run this code just once
  86236. ** save the results, and reuse the same result on subsequent invocations.
  86237. */
  86238. if( !ExprHasProperty(pExpr, EP_VarSelect) ){
  86239. jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  86240. }
  86241. #ifndef SQLITE_OMIT_EXPLAIN
  86242. if( pParse->explain==2 ){
  86243. char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
  86244. jmpIfDynamic>=0?"":"CORRELATED ",
  86245. pExpr->op==TK_IN?"LIST":"SCALAR",
  86246. pParse->iNextSelectId
  86247. );
  86248. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  86249. }
  86250. #endif
  86251. switch( pExpr->op ){
  86252. case TK_IN: {
  86253. int addr; /* Address of OP_OpenEphemeral instruction */
  86254. Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
  86255. KeyInfo *pKeyInfo = 0; /* Key information */
  86256. int nVal; /* Size of vector pLeft */
  86257. nVal = sqlite3ExprVectorSize(pLeft);
  86258. assert( !isRowid || nVal==1 );
  86259. /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
  86260. ** expression it is handled the same way. An ephemeral table is
  86261. ** filled with index keys representing the results from the
  86262. ** SELECT or the <exprlist>.
  86263. **
  86264. ** If the 'x' expression is a column value, or the SELECT...
  86265. ** statement returns a column value, then the affinity of that
  86266. ** column is used to build the index keys. If both 'x' and the
  86267. ** SELECT... statement are columns, then numeric affinity is used
  86268. ** if either column has NUMERIC or INTEGER affinity. If neither
  86269. ** 'x' nor the SELECT... statement are columns, then numeric affinity
  86270. ** is used.
  86271. */
  86272. pExpr->iTable = pParse->nTab++;
  86273. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
  86274. pExpr->iTable, (isRowid?0:nVal));
  86275. pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
  86276. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  86277. /* Case 1: expr IN (SELECT ...)
  86278. **
  86279. ** Generate code to write the results of the select into the temporary
  86280. ** table allocated and opened above.
  86281. */
  86282. Select *pSelect = pExpr->x.pSelect;
  86283. ExprList *pEList = pSelect->pEList;
  86284. assert( !isRowid );
  86285. /* If the LHS and RHS of the IN operator do not match, that
  86286. ** error will have been caught long before we reach this point. */
  86287. if( ALWAYS(pEList->nExpr==nVal) ){
  86288. SelectDest dest;
  86289. int i;
  86290. sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
  86291. dest.zAffSdst = exprINAffinity(pParse, pExpr);
  86292. assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
  86293. pSelect->iLimit = 0;
  86294. testcase( pSelect->selFlags & SF_Distinct );
  86295. testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
  86296. if( sqlite3Select(pParse, pSelect, &dest) ){
  86297. sqlite3DbFree(pParse->db, dest.zAffSdst);
  86298. sqlite3KeyInfoUnref(pKeyInfo);
  86299. return 0;
  86300. }
  86301. sqlite3DbFree(pParse->db, dest.zAffSdst);
  86302. assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
  86303. assert( pEList!=0 );
  86304. assert( pEList->nExpr>0 );
  86305. assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
  86306. for(i=0; i<nVal; i++){
  86307. Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
  86308. pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
  86309. pParse, p, pEList->a[i].pExpr
  86310. );
  86311. }
  86312. }
  86313. }else if( ALWAYS(pExpr->x.pList!=0) ){
  86314. /* Case 2: expr IN (exprlist)
  86315. **
  86316. ** For each expression, build an index key from the evaluation and
  86317. ** store it in the temporary table. If <expr> is a column, then use
  86318. ** that columns affinity when building index keys. If <expr> is not
  86319. ** a column, use numeric affinity.
  86320. */
  86321. char affinity; /* Affinity of the LHS of the IN */
  86322. int i;
  86323. ExprList *pList = pExpr->x.pList;
  86324. struct ExprList_item *pItem;
  86325. int r1, r2, r3;
  86326. affinity = sqlite3ExprAffinity(pLeft);
  86327. if( !affinity ){
  86328. affinity = SQLITE_AFF_BLOB;
  86329. }
  86330. if( pKeyInfo ){
  86331. assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
  86332. pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
  86333. }
  86334. /* Loop through each expression in <exprlist>. */
  86335. r1 = sqlite3GetTempReg(pParse);
  86336. r2 = sqlite3GetTempReg(pParse);
  86337. if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
  86338. for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
  86339. Expr *pE2 = pItem->pExpr;
  86340. int iValToIns;
  86341. /* If the expression is not constant then we will need to
  86342. ** disable the test that was generated above that makes sure
  86343. ** this code only executes once. Because for a non-constant
  86344. ** expression we need to rerun this code each time.
  86345. */
  86346. if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
  86347. sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
  86348. jmpIfDynamic = -1;
  86349. }
  86350. /* Evaluate the expression and insert it into the temp table */
  86351. if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
  86352. sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
  86353. }else{
  86354. r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
  86355. if( isRowid ){
  86356. sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
  86357. sqlite3VdbeCurrentAddr(v)+2);
  86358. VdbeCoverage(v);
  86359. sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
  86360. }else{
  86361. sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
  86362. sqlite3ExprCacheAffinityChange(pParse, r3, 1);
  86363. sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
  86364. }
  86365. }
  86366. }
  86367. sqlite3ReleaseTempReg(pParse, r1);
  86368. sqlite3ReleaseTempReg(pParse, r2);
  86369. }
  86370. if( pKeyInfo ){
  86371. sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
  86372. }
  86373. break;
  86374. }
  86375. case TK_EXISTS:
  86376. case TK_SELECT:
  86377. default: {
  86378. /* Case 3: (SELECT ... FROM ...)
  86379. ** or: EXISTS(SELECT ... FROM ...)
  86380. **
  86381. ** For a SELECT, generate code to put the values for all columns of
  86382. ** the first row into an array of registers and return the index of
  86383. ** the first register.
  86384. **
  86385. ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
  86386. ** into a register and return that register number.
  86387. **
  86388. ** In both cases, the query is augmented with "LIMIT 1". Any
  86389. ** preexisting limit is discarded in place of the new LIMIT 1.
  86390. */
  86391. Select *pSel; /* SELECT statement to encode */
  86392. SelectDest dest; /* How to deal with SELECT result */
  86393. int nReg; /* Registers to allocate */
  86394. testcase( pExpr->op==TK_EXISTS );
  86395. testcase( pExpr->op==TK_SELECT );
  86396. assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
  86397. assert( ExprHasProperty(pExpr, EP_xIsSelect) );
  86398. pSel = pExpr->x.pSelect;
  86399. nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
  86400. sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
  86401. pParse->nMem += nReg;
  86402. if( pExpr->op==TK_SELECT ){
  86403. dest.eDest = SRT_Mem;
  86404. dest.iSdst = dest.iSDParm;
  86405. dest.nSdst = nReg;
  86406. sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
  86407. VdbeComment((v, "Init subquery result"));
  86408. }else{
  86409. dest.eDest = SRT_Exists;
  86410. sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
  86411. VdbeComment((v, "Init EXISTS result"));
  86412. }
  86413. sqlite3ExprDelete(pParse->db, pSel->pLimit);
  86414. pSel->pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,
  86415. &sqlite3IntTokens[1], 0);
  86416. pSel->iLimit = 0;
  86417. pSel->selFlags &= ~SF_MultiValue;
  86418. if( sqlite3Select(pParse, pSel, &dest) ){
  86419. return 0;
  86420. }
  86421. rReg = dest.iSDParm;
  86422. ExprSetVVAProperty(pExpr, EP_NoReduce);
  86423. break;
  86424. }
  86425. }
  86426. if( rHasNullFlag ){
  86427. sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
  86428. }
  86429. if( jmpIfDynamic>=0 ){
  86430. sqlite3VdbeJumpHere(v, jmpIfDynamic);
  86431. }
  86432. sqlite3ExprCachePop(pParse);
  86433. return rReg;
  86434. }
  86435. #endif /* SQLITE_OMIT_SUBQUERY */
  86436. #ifndef SQLITE_OMIT_SUBQUERY
  86437. /*
  86438. ** Expr pIn is an IN(...) expression. This function checks that the
  86439. ** sub-select on the RHS of the IN() operator has the same number of
  86440. ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
  86441. ** a sub-query, that the LHS is a vector of size 1.
  86442. */
  86443. SQLITE_PRIVATE int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
  86444. int nVector = sqlite3ExprVectorSize(pIn->pLeft);
  86445. if( (pIn->flags & EP_xIsSelect) ){
  86446. if( nVector!=pIn->x.pSelect->pEList->nExpr ){
  86447. sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
  86448. return 1;
  86449. }
  86450. }else if( nVector!=1 ){
  86451. if( (pIn->pLeft->flags & EP_xIsSelect) ){
  86452. sqlite3SubselectError(pParse, nVector, 1);
  86453. }else{
  86454. sqlite3ErrorMsg(pParse, "row value misused");
  86455. }
  86456. return 1;
  86457. }
  86458. return 0;
  86459. }
  86460. #endif
  86461. #ifndef SQLITE_OMIT_SUBQUERY
  86462. /*
  86463. ** Generate code for an IN expression.
  86464. **
  86465. ** x IN (SELECT ...)
  86466. ** x IN (value, value, ...)
  86467. **
  86468. ** The left-hand side (LHS) is a scalar or vector expression. The
  86469. ** right-hand side (RHS) is an array of zero or more scalar values, or a
  86470. ** subquery. If the RHS is a subquery, the number of result columns must
  86471. ** match the number of columns in the vector on the LHS. If the RHS is
  86472. ** a list of values, the LHS must be a scalar.
  86473. **
  86474. ** The IN operator is true if the LHS value is contained within the RHS.
  86475. ** The result is false if the LHS is definitely not in the RHS. The
  86476. ** result is NULL if the presence of the LHS in the RHS cannot be
  86477. ** determined due to NULLs.
  86478. **
  86479. ** This routine generates code that jumps to destIfFalse if the LHS is not
  86480. ** contained within the RHS. If due to NULLs we cannot determine if the LHS
  86481. ** is contained in the RHS then jump to destIfNull. If the LHS is contained
  86482. ** within the RHS then fall through.
  86483. **
  86484. ** See the separate in-operator.md documentation file in the canonical
  86485. ** SQLite source tree for additional information.
  86486. */
  86487. static void sqlite3ExprCodeIN(
  86488. Parse *pParse, /* Parsing and code generating context */
  86489. Expr *pExpr, /* The IN expression */
  86490. int destIfFalse, /* Jump here if LHS is not contained in the RHS */
  86491. int destIfNull /* Jump here if the results are unknown due to NULLs */
  86492. ){
  86493. int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
  86494. int eType; /* Type of the RHS */
  86495. int rLhs; /* Register(s) holding the LHS values */
  86496. int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
  86497. Vdbe *v; /* Statement under construction */
  86498. int *aiMap = 0; /* Map from vector field to index column */
  86499. char *zAff = 0; /* Affinity string for comparisons */
  86500. int nVector; /* Size of vectors for this IN operator */
  86501. int iDummy; /* Dummy parameter to exprCodeVector() */
  86502. Expr *pLeft; /* The LHS of the IN operator */
  86503. int i; /* loop counter */
  86504. int destStep2; /* Where to jump when NULLs seen in step 2 */
  86505. int destStep6 = 0; /* Start of code for Step 6 */
  86506. int addrTruthOp; /* Address of opcode that determines the IN is true */
  86507. int destNotNull; /* Jump here if a comparison is not true in step 6 */
  86508. int addrTop; /* Top of the step-6 loop */
  86509. pLeft = pExpr->pLeft;
  86510. if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
  86511. zAff = exprINAffinity(pParse, pExpr);
  86512. nVector = sqlite3ExprVectorSize(pExpr->pLeft);
  86513. aiMap = (int*)sqlite3DbMallocZero(
  86514. pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
  86515. );
  86516. if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
  86517. /* Attempt to compute the RHS. After this step, if anything other than
  86518. ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
  86519. ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
  86520. ** the RHS has not yet been coded. */
  86521. v = pParse->pVdbe;
  86522. assert( v!=0 ); /* OOM detected prior to this routine */
  86523. VdbeNoopComment((v, "begin IN expr"));
  86524. eType = sqlite3FindInIndex(pParse, pExpr,
  86525. IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
  86526. destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
  86527. assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
  86528. || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
  86529. );
  86530. #ifdef SQLITE_DEBUG
  86531. /* Confirm that aiMap[] contains nVector integer values between 0 and
  86532. ** nVector-1. */
  86533. for(i=0; i<nVector; i++){
  86534. int j, cnt;
  86535. for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
  86536. assert( cnt==1 );
  86537. }
  86538. #endif
  86539. /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
  86540. ** vector, then it is stored in an array of nVector registers starting
  86541. ** at r1.
  86542. **
  86543. ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
  86544. ** so that the fields are in the same order as an existing index. The
  86545. ** aiMap[] array contains a mapping from the original LHS field order to
  86546. ** the field order that matches the RHS index.
  86547. */
  86548. sqlite3ExprCachePush(pParse);
  86549. rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
  86550. for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
  86551. if( i==nVector ){
  86552. /* LHS fields are not reordered */
  86553. rLhs = rLhsOrig;
  86554. }else{
  86555. /* Need to reorder the LHS fields according to aiMap */
  86556. rLhs = sqlite3GetTempRange(pParse, nVector);
  86557. for(i=0; i<nVector; i++){
  86558. sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
  86559. }
  86560. }
  86561. /* If sqlite3FindInIndex() did not find or create an index that is
  86562. ** suitable for evaluating the IN operator, then evaluate using a
  86563. ** sequence of comparisons.
  86564. **
  86565. ** This is step (1) in the in-operator.md optimized algorithm.
  86566. */
  86567. if( eType==IN_INDEX_NOOP ){
  86568. ExprList *pList = pExpr->x.pList;
  86569. CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
  86570. int labelOk = sqlite3VdbeMakeLabel(v);
  86571. int r2, regToFree;
  86572. int regCkNull = 0;
  86573. int ii;
  86574. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  86575. if( destIfNull!=destIfFalse ){
  86576. regCkNull = sqlite3GetTempReg(pParse);
  86577. sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
  86578. }
  86579. for(ii=0; ii<pList->nExpr; ii++){
  86580. r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
  86581. if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
  86582. sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
  86583. }
  86584. if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
  86585. sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
  86586. (void*)pColl, P4_COLLSEQ);
  86587. VdbeCoverageIf(v, ii<pList->nExpr-1);
  86588. VdbeCoverageIf(v, ii==pList->nExpr-1);
  86589. sqlite3VdbeChangeP5(v, zAff[0]);
  86590. }else{
  86591. assert( destIfNull==destIfFalse );
  86592. sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
  86593. (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
  86594. sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
  86595. }
  86596. sqlite3ReleaseTempReg(pParse, regToFree);
  86597. }
  86598. if( regCkNull ){
  86599. sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
  86600. sqlite3VdbeGoto(v, destIfFalse);
  86601. }
  86602. sqlite3VdbeResolveLabel(v, labelOk);
  86603. sqlite3ReleaseTempReg(pParse, regCkNull);
  86604. goto sqlite3ExprCodeIN_finished;
  86605. }
  86606. /* Step 2: Check to see if the LHS contains any NULL columns. If the
  86607. ** LHS does contain NULLs then the result must be either FALSE or NULL.
  86608. ** We will then skip the binary search of the RHS.
  86609. */
  86610. if( destIfNull==destIfFalse ){
  86611. destStep2 = destIfFalse;
  86612. }else{
  86613. destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
  86614. }
  86615. for(i=0; i<nVector; i++){
  86616. Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
  86617. if( sqlite3ExprCanBeNull(p) ){
  86618. sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
  86619. VdbeCoverage(v);
  86620. }
  86621. }
  86622. /* Step 3. The LHS is now known to be non-NULL. Do the binary search
  86623. ** of the RHS using the LHS as a probe. If found, the result is
  86624. ** true.
  86625. */
  86626. if( eType==IN_INDEX_ROWID ){
  86627. /* In this case, the RHS is the ROWID of table b-tree and so we also
  86628. ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
  86629. ** into a single opcode. */
  86630. sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
  86631. VdbeCoverage(v);
  86632. addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
  86633. }else{
  86634. sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
  86635. if( destIfFalse==destIfNull ){
  86636. /* Combine Step 3 and Step 5 into a single opcode */
  86637. sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
  86638. rLhs, nVector); VdbeCoverage(v);
  86639. goto sqlite3ExprCodeIN_finished;
  86640. }
  86641. /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
  86642. addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
  86643. rLhs, nVector); VdbeCoverage(v);
  86644. }
  86645. /* Step 4. If the RHS is known to be non-NULL and we did not find
  86646. ** an match on the search above, then the result must be FALSE.
  86647. */
  86648. if( rRhsHasNull && nVector==1 ){
  86649. sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
  86650. VdbeCoverage(v);
  86651. }
  86652. /* Step 5. If we do not care about the difference between NULL and
  86653. ** FALSE, then just return false.
  86654. */
  86655. if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
  86656. /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
  86657. ** If any comparison is NULL, then the result is NULL. If all
  86658. ** comparisons are FALSE then the final result is FALSE.
  86659. **
  86660. ** For a scalar LHS, it is sufficient to check just the first row
  86661. ** of the RHS.
  86662. */
  86663. if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
  86664. addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
  86665. VdbeCoverage(v);
  86666. if( nVector>1 ){
  86667. destNotNull = sqlite3VdbeMakeLabel(v);
  86668. }else{
  86669. /* For nVector==1, combine steps 6 and 7 by immediately returning
  86670. ** FALSE if the first comparison is not NULL */
  86671. destNotNull = destIfFalse;
  86672. }
  86673. for(i=0; i<nVector; i++){
  86674. Expr *p;
  86675. CollSeq *pColl;
  86676. int r3 = sqlite3GetTempReg(pParse);
  86677. p = sqlite3VectorFieldSubexpr(pLeft, i);
  86678. pColl = sqlite3ExprCollSeq(pParse, p);
  86679. sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
  86680. sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
  86681. (void*)pColl, P4_COLLSEQ);
  86682. VdbeCoverage(v);
  86683. sqlite3ReleaseTempReg(pParse, r3);
  86684. }
  86685. sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
  86686. if( nVector>1 ){
  86687. sqlite3VdbeResolveLabel(v, destNotNull);
  86688. sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
  86689. VdbeCoverage(v);
  86690. /* Step 7: If we reach this point, we know that the result must
  86691. ** be false. */
  86692. sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
  86693. }
  86694. /* Jumps here in order to return true. */
  86695. sqlite3VdbeJumpHere(v, addrTruthOp);
  86696. sqlite3ExprCodeIN_finished:
  86697. if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
  86698. sqlite3ExprCachePop(pParse);
  86699. VdbeComment((v, "end IN expr"));
  86700. sqlite3ExprCodeIN_oom_error:
  86701. sqlite3DbFree(pParse->db, aiMap);
  86702. sqlite3DbFree(pParse->db, zAff);
  86703. }
  86704. #endif /* SQLITE_OMIT_SUBQUERY */
  86705. #ifndef SQLITE_OMIT_FLOATING_POINT
  86706. /*
  86707. ** Generate an instruction that will put the floating point
  86708. ** value described by z[0..n-1] into register iMem.
  86709. **
  86710. ** The z[] string will probably not be zero-terminated. But the
  86711. ** z[n] character is guaranteed to be something that does not look
  86712. ** like the continuation of the number.
  86713. */
  86714. static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
  86715. if( ALWAYS(z!=0) ){
  86716. double value;
  86717. sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
  86718. assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
  86719. if( negateFlag ) value = -value;
  86720. sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
  86721. }
  86722. }
  86723. #endif
  86724. /*
  86725. ** Generate an instruction that will put the integer describe by
  86726. ** text z[0..n-1] into register iMem.
  86727. **
  86728. ** Expr.u.zToken is always UTF8 and zero-terminated.
  86729. */
  86730. static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
  86731. Vdbe *v = pParse->pVdbe;
  86732. if( pExpr->flags & EP_IntValue ){
  86733. int i = pExpr->u.iValue;
  86734. assert( i>=0 );
  86735. if( negFlag ) i = -i;
  86736. sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
  86737. }else{
  86738. int c;
  86739. i64 value;
  86740. const char *z = pExpr->u.zToken;
  86741. assert( z!=0 );
  86742. c = sqlite3DecOrHexToI64(z, &value);
  86743. if( c==0 || (c==2 && negFlag) ){
  86744. if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
  86745. sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
  86746. }else{
  86747. #ifdef SQLITE_OMIT_FLOATING_POINT
  86748. sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
  86749. #else
  86750. #ifndef SQLITE_OMIT_HEX_INTEGER
  86751. if( sqlite3_strnicmp(z,"0x",2)==0 ){
  86752. sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
  86753. }else
  86754. #endif
  86755. {
  86756. codeReal(v, z, negFlag, iMem);
  86757. }
  86758. #endif
  86759. }
  86760. }
  86761. }
  86762. /*
  86763. ** Erase column-cache entry number i
  86764. */
  86765. static void cacheEntryClear(Parse *pParse, int i){
  86766. if( pParse->aColCache[i].tempReg ){
  86767. if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
  86768. pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
  86769. }
  86770. }
  86771. pParse->nColCache--;
  86772. if( i<pParse->nColCache ){
  86773. pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
  86774. }
  86775. }
  86776. /*
  86777. ** Record in the column cache that a particular column from a
  86778. ** particular table is stored in a particular register.
  86779. */
  86780. SQLITE_PRIVATE void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
  86781. int i;
  86782. int minLru;
  86783. int idxLru;
  86784. struct yColCache *p;
  86785. /* Unless an error has occurred, register numbers are always positive. */
  86786. assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
  86787. assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
  86788. /* The SQLITE_ColumnCache flag disables the column cache. This is used
  86789. ** for testing only - to verify that SQLite always gets the same answer
  86790. ** with and without the column cache.
  86791. */
  86792. if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
  86793. /* First replace any existing entry.
  86794. **
  86795. ** Actually, the way the column cache is currently used, we are guaranteed
  86796. ** that the object will never already be in cache. Verify this guarantee.
  86797. */
  86798. #ifndef NDEBUG
  86799. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  86800. assert( p->iTable!=iTab || p->iColumn!=iCol );
  86801. }
  86802. #endif
  86803. /* If the cache is already full, delete the least recently used entry */
  86804. if( pParse->nColCache>=SQLITE_N_COLCACHE ){
  86805. minLru = 0x7fffffff;
  86806. idxLru = -1;
  86807. for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
  86808. if( p->lru<minLru ){
  86809. idxLru = i;
  86810. minLru = p->lru;
  86811. }
  86812. }
  86813. p = &pParse->aColCache[idxLru];
  86814. }else{
  86815. p = &pParse->aColCache[pParse->nColCache++];
  86816. }
  86817. /* Add the new entry to the end of the cache */
  86818. p->iLevel = pParse->iCacheLevel;
  86819. p->iTable = iTab;
  86820. p->iColumn = iCol;
  86821. p->iReg = iReg;
  86822. p->tempReg = 0;
  86823. p->lru = pParse->iCacheCnt++;
  86824. }
  86825. /*
  86826. ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
  86827. ** Purge the range of registers from the column cache.
  86828. */
  86829. SQLITE_PRIVATE void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
  86830. int i = 0;
  86831. while( i<pParse->nColCache ){
  86832. struct yColCache *p = &pParse->aColCache[i];
  86833. if( p->iReg >= iReg && p->iReg < iReg+nReg ){
  86834. cacheEntryClear(pParse, i);
  86835. }else{
  86836. i++;
  86837. }
  86838. }
  86839. }
  86840. /*
  86841. ** Remember the current column cache context. Any new entries added
  86842. ** added to the column cache after this call are removed when the
  86843. ** corresponding pop occurs.
  86844. */
  86845. SQLITE_PRIVATE void sqlite3ExprCachePush(Parse *pParse){
  86846. pParse->iCacheLevel++;
  86847. #ifdef SQLITE_DEBUG
  86848. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  86849. printf("PUSH to %d\n", pParse->iCacheLevel);
  86850. }
  86851. #endif
  86852. }
  86853. /*
  86854. ** Remove from the column cache any entries that were added since the
  86855. ** the previous sqlite3ExprCachePush operation. In other words, restore
  86856. ** the cache to the state it was in prior the most recent Push.
  86857. */
  86858. SQLITE_PRIVATE void sqlite3ExprCachePop(Parse *pParse){
  86859. int i = 0;
  86860. assert( pParse->iCacheLevel>=1 );
  86861. pParse->iCacheLevel--;
  86862. #ifdef SQLITE_DEBUG
  86863. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  86864. printf("POP to %d\n", pParse->iCacheLevel);
  86865. }
  86866. #endif
  86867. while( i<pParse->nColCache ){
  86868. if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
  86869. cacheEntryClear(pParse, i);
  86870. }else{
  86871. i++;
  86872. }
  86873. }
  86874. }
  86875. /*
  86876. ** When a cached column is reused, make sure that its register is
  86877. ** no longer available as a temp register. ticket #3879: that same
  86878. ** register might be in the cache in multiple places, so be sure to
  86879. ** get them all.
  86880. */
  86881. static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
  86882. int i;
  86883. struct yColCache *p;
  86884. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  86885. if( p->iReg==iReg ){
  86886. p->tempReg = 0;
  86887. }
  86888. }
  86889. }
  86890. /* Generate code that will load into register regOut a value that is
  86891. ** appropriate for the iIdxCol-th column of index pIdx.
  86892. */
  86893. SQLITE_PRIVATE void sqlite3ExprCodeLoadIndexColumn(
  86894. Parse *pParse, /* The parsing context */
  86895. Index *pIdx, /* The index whose column is to be loaded */
  86896. int iTabCur, /* Cursor pointing to a table row */
  86897. int iIdxCol, /* The column of the index to be loaded */
  86898. int regOut /* Store the index column value in this register */
  86899. ){
  86900. i16 iTabCol = pIdx->aiColumn[iIdxCol];
  86901. if( iTabCol==XN_EXPR ){
  86902. assert( pIdx->aColExpr );
  86903. assert( pIdx->aColExpr->nExpr>iIdxCol );
  86904. pParse->iSelfTab = iTabCur;
  86905. sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
  86906. }else{
  86907. sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
  86908. iTabCol, regOut);
  86909. }
  86910. }
  86911. /*
  86912. ** Generate code to extract the value of the iCol-th column of a table.
  86913. */
  86914. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnOfTable(
  86915. Vdbe *v, /* The VDBE under construction */
  86916. Table *pTab, /* The table containing the value */
  86917. int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
  86918. int iCol, /* Index of the column to extract */
  86919. int regOut /* Extract the value into this register */
  86920. ){
  86921. if( iCol<0 || iCol==pTab->iPKey ){
  86922. sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
  86923. }else{
  86924. int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
  86925. int x = iCol;
  86926. if( !HasRowid(pTab) && !IsVirtual(pTab) ){
  86927. x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
  86928. }
  86929. sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
  86930. }
  86931. if( iCol>=0 ){
  86932. sqlite3ColumnDefault(v, pTab, iCol, regOut);
  86933. }
  86934. }
  86935. /*
  86936. ** Generate code that will extract the iColumn-th column from
  86937. ** table pTab and store the column value in a register.
  86938. **
  86939. ** An effort is made to store the column value in register iReg. This
  86940. ** is not garanteeed for GetColumn() - the result can be stored in
  86941. ** any register. But the result is guaranteed to land in register iReg
  86942. ** for GetColumnToReg().
  86943. **
  86944. ** There must be an open cursor to pTab in iTable when this routine
  86945. ** is called. If iColumn<0 then code is generated that extracts the rowid.
  86946. */
  86947. SQLITE_PRIVATE int sqlite3ExprCodeGetColumn(
  86948. Parse *pParse, /* Parsing and code generating context */
  86949. Table *pTab, /* Description of the table we are reading from */
  86950. int iColumn, /* Index of the table column */
  86951. int iTable, /* The cursor pointing to the table */
  86952. int iReg, /* Store results here */
  86953. u8 p5 /* P5 value for OP_Column + FLAGS */
  86954. ){
  86955. Vdbe *v = pParse->pVdbe;
  86956. int i;
  86957. struct yColCache *p;
  86958. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  86959. if( p->iTable==iTable && p->iColumn==iColumn ){
  86960. p->lru = pParse->iCacheCnt++;
  86961. sqlite3ExprCachePinRegister(pParse, p->iReg);
  86962. return p->iReg;
  86963. }
  86964. }
  86965. assert( v!=0 );
  86966. sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
  86967. if( p5 ){
  86968. sqlite3VdbeChangeP5(v, p5);
  86969. }else{
  86970. sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
  86971. }
  86972. return iReg;
  86973. }
  86974. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnToReg(
  86975. Parse *pParse, /* Parsing and code generating context */
  86976. Table *pTab, /* Description of the table we are reading from */
  86977. int iColumn, /* Index of the table column */
  86978. int iTable, /* The cursor pointing to the table */
  86979. int iReg /* Store results here */
  86980. ){
  86981. int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
  86982. if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
  86983. }
  86984. /*
  86985. ** Clear all column cache entries.
  86986. */
  86987. SQLITE_PRIVATE void sqlite3ExprCacheClear(Parse *pParse){
  86988. int i;
  86989. #if SQLITE_DEBUG
  86990. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  86991. printf("CLEAR\n");
  86992. }
  86993. #endif
  86994. for(i=0; i<pParse->nColCache; i++){
  86995. if( pParse->aColCache[i].tempReg
  86996. && pParse->nTempReg<ArraySize(pParse->aTempReg)
  86997. ){
  86998. pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
  86999. }
  87000. }
  87001. pParse->nColCache = 0;
  87002. }
  87003. /*
  87004. ** Record the fact that an affinity change has occurred on iCount
  87005. ** registers starting with iStart.
  87006. */
  87007. SQLITE_PRIVATE void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
  87008. sqlite3ExprCacheRemove(pParse, iStart, iCount);
  87009. }
  87010. /*
  87011. ** Generate code to move content from registers iFrom...iFrom+nReg-1
  87012. ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
  87013. */
  87014. SQLITE_PRIVATE void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
  87015. assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
  87016. sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
  87017. sqlite3ExprCacheRemove(pParse, iFrom, nReg);
  87018. }
  87019. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  87020. /*
  87021. ** Return true if any register in the range iFrom..iTo (inclusive)
  87022. ** is used as part of the column cache.
  87023. **
  87024. ** This routine is used within assert() and testcase() macros only
  87025. ** and does not appear in a normal build.
  87026. */
  87027. static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
  87028. int i;
  87029. struct yColCache *p;
  87030. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  87031. int r = p->iReg;
  87032. if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
  87033. }
  87034. return 0;
  87035. }
  87036. #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
  87037. /*
  87038. ** Convert a scalar expression node to a TK_REGISTER referencing
  87039. ** register iReg. The caller must ensure that iReg already contains
  87040. ** the correct value for the expression.
  87041. */
  87042. static void exprToRegister(Expr *p, int iReg){
  87043. p->op2 = p->op;
  87044. p->op = TK_REGISTER;
  87045. p->iTable = iReg;
  87046. ExprClearProperty(p, EP_Skip);
  87047. }
  87048. /*
  87049. ** Evaluate an expression (either a vector or a scalar expression) and store
  87050. ** the result in continguous temporary registers. Return the index of
  87051. ** the first register used to store the result.
  87052. **
  87053. ** If the returned result register is a temporary scalar, then also write
  87054. ** that register number into *piFreeable. If the returned result register
  87055. ** is not a temporary or if the expression is a vector set *piFreeable
  87056. ** to 0.
  87057. */
  87058. static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
  87059. int iResult;
  87060. int nResult = sqlite3ExprVectorSize(p);
  87061. if( nResult==1 ){
  87062. iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
  87063. }else{
  87064. *piFreeable = 0;
  87065. if( p->op==TK_SELECT ){
  87066. iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
  87067. }else{
  87068. int i;
  87069. iResult = pParse->nMem+1;
  87070. pParse->nMem += nResult;
  87071. for(i=0; i<nResult; i++){
  87072. sqlite3ExprCode(pParse, p->x.pList->a[i].pExpr, i+iResult);
  87073. }
  87074. }
  87075. }
  87076. return iResult;
  87077. }
  87078. /*
  87079. ** Generate code into the current Vdbe to evaluate the given
  87080. ** expression. Attempt to store the results in register "target".
  87081. ** Return the register where results are stored.
  87082. **
  87083. ** With this routine, there is no guarantee that results will
  87084. ** be stored in target. The result might be stored in some other
  87085. ** register if it is convenient to do so. The calling function
  87086. ** must check the return code and move the results to the desired
  87087. ** register.
  87088. */
  87089. SQLITE_PRIVATE int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
  87090. Vdbe *v = pParse->pVdbe; /* The VM under construction */
  87091. int op; /* The opcode being coded */
  87092. int inReg = target; /* Results stored in register inReg */
  87093. int regFree1 = 0; /* If non-zero free this temporary register */
  87094. int regFree2 = 0; /* If non-zero free this temporary register */
  87095. int r1, r2; /* Various register numbers */
  87096. Expr tempX; /* Temporary expression node */
  87097. int p5 = 0;
  87098. assert( target>0 && target<=pParse->nMem );
  87099. if( v==0 ){
  87100. assert( pParse->db->mallocFailed );
  87101. return 0;
  87102. }
  87103. if( pExpr==0 ){
  87104. op = TK_NULL;
  87105. }else{
  87106. op = pExpr->op;
  87107. }
  87108. switch( op ){
  87109. case TK_AGG_COLUMN: {
  87110. AggInfo *pAggInfo = pExpr->pAggInfo;
  87111. struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
  87112. if( !pAggInfo->directMode ){
  87113. assert( pCol->iMem>0 );
  87114. return pCol->iMem;
  87115. }else if( pAggInfo->useSortingIdx ){
  87116. sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
  87117. pCol->iSorterColumn, target);
  87118. return target;
  87119. }
  87120. /* Otherwise, fall thru into the TK_COLUMN case */
  87121. }
  87122. case TK_COLUMN: {
  87123. int iTab = pExpr->iTable;
  87124. if( iTab<0 ){
  87125. if( pParse->ckBase>0 ){
  87126. /* Generating CHECK constraints or inserting into partial index */
  87127. return pExpr->iColumn + pParse->ckBase;
  87128. }else{
  87129. /* Coding an expression that is part of an index where column names
  87130. ** in the index refer to the table to which the index belongs */
  87131. iTab = pParse->iSelfTab;
  87132. }
  87133. }
  87134. return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
  87135. pExpr->iColumn, iTab, target,
  87136. pExpr->op2);
  87137. }
  87138. case TK_INTEGER: {
  87139. codeInteger(pParse, pExpr, 0, target);
  87140. return target;
  87141. }
  87142. #ifndef SQLITE_OMIT_FLOATING_POINT
  87143. case TK_FLOAT: {
  87144. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87145. codeReal(v, pExpr->u.zToken, 0, target);
  87146. return target;
  87147. }
  87148. #endif
  87149. case TK_STRING: {
  87150. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87151. sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
  87152. return target;
  87153. }
  87154. case TK_NULL: {
  87155. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  87156. return target;
  87157. }
  87158. #ifndef SQLITE_OMIT_BLOB_LITERAL
  87159. case TK_BLOB: {
  87160. int n;
  87161. const char *z;
  87162. char *zBlob;
  87163. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87164. assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
  87165. assert( pExpr->u.zToken[1]=='\'' );
  87166. z = &pExpr->u.zToken[2];
  87167. n = sqlite3Strlen30(z) - 1;
  87168. assert( z[n]=='\'' );
  87169. zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
  87170. sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
  87171. return target;
  87172. }
  87173. #endif
  87174. case TK_VARIABLE: {
  87175. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87176. assert( pExpr->u.zToken!=0 );
  87177. assert( pExpr->u.zToken[0]!=0 );
  87178. sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
  87179. if( pExpr->u.zToken[1]!=0 ){
  87180. assert( pExpr->u.zToken[0]=='?'
  87181. || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
  87182. sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
  87183. }
  87184. return target;
  87185. }
  87186. case TK_REGISTER: {
  87187. return pExpr->iTable;
  87188. }
  87189. #ifndef SQLITE_OMIT_CAST
  87190. case TK_CAST: {
  87191. /* Expressions of the form: CAST(pLeft AS token) */
  87192. inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
  87193. if( inReg!=target ){
  87194. sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
  87195. inReg = target;
  87196. }
  87197. sqlite3VdbeAddOp2(v, OP_Cast, target,
  87198. sqlite3AffinityType(pExpr->u.zToken, 0));
  87199. testcase( usedAsColumnCache(pParse, inReg, inReg) );
  87200. sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
  87201. return inReg;
  87202. }
  87203. #endif /* SQLITE_OMIT_CAST */
  87204. case TK_IS:
  87205. case TK_ISNOT:
  87206. op = (op==TK_IS) ? TK_EQ : TK_NE;
  87207. p5 = SQLITE_NULLEQ;
  87208. /* fall-through */
  87209. case TK_LT:
  87210. case TK_LE:
  87211. case TK_GT:
  87212. case TK_GE:
  87213. case TK_NE:
  87214. case TK_EQ: {
  87215. Expr *pLeft = pExpr->pLeft;
  87216. if( sqlite3ExprIsVector(pLeft) ){
  87217. codeVectorCompare(pParse, pExpr, target, op, p5);
  87218. }else{
  87219. r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
  87220. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  87221. codeCompare(pParse, pLeft, pExpr->pRight, op,
  87222. r1, r2, inReg, SQLITE_STOREP2 | p5);
  87223. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  87224. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  87225. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  87226. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  87227. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
  87228. assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
  87229. testcase( regFree1==0 );
  87230. testcase( regFree2==0 );
  87231. }
  87232. break;
  87233. }
  87234. case TK_AND:
  87235. case TK_OR:
  87236. case TK_PLUS:
  87237. case TK_STAR:
  87238. case TK_MINUS:
  87239. case TK_REM:
  87240. case TK_BITAND:
  87241. case TK_BITOR:
  87242. case TK_SLASH:
  87243. case TK_LSHIFT:
  87244. case TK_RSHIFT:
  87245. case TK_CONCAT: {
  87246. assert( TK_AND==OP_And ); testcase( op==TK_AND );
  87247. assert( TK_OR==OP_Or ); testcase( op==TK_OR );
  87248. assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
  87249. assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
  87250. assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
  87251. assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
  87252. assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
  87253. assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
  87254. assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
  87255. assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
  87256. assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
  87257. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  87258. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  87259. sqlite3VdbeAddOp3(v, op, r2, r1, target);
  87260. testcase( regFree1==0 );
  87261. testcase( regFree2==0 );
  87262. break;
  87263. }
  87264. case TK_UMINUS: {
  87265. Expr *pLeft = pExpr->pLeft;
  87266. assert( pLeft );
  87267. if( pLeft->op==TK_INTEGER ){
  87268. codeInteger(pParse, pLeft, 1, target);
  87269. return target;
  87270. #ifndef SQLITE_OMIT_FLOATING_POINT
  87271. }else if( pLeft->op==TK_FLOAT ){
  87272. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87273. codeReal(v, pLeft->u.zToken, 1, target);
  87274. return target;
  87275. #endif
  87276. }else{
  87277. tempX.op = TK_INTEGER;
  87278. tempX.flags = EP_IntValue|EP_TokenOnly;
  87279. tempX.u.iValue = 0;
  87280. r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
  87281. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
  87282. sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
  87283. testcase( regFree2==0 );
  87284. }
  87285. break;
  87286. }
  87287. case TK_BITNOT:
  87288. case TK_NOT: {
  87289. assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
  87290. assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
  87291. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  87292. testcase( regFree1==0 );
  87293. sqlite3VdbeAddOp2(v, op, r1, inReg);
  87294. break;
  87295. }
  87296. case TK_ISNULL:
  87297. case TK_NOTNULL: {
  87298. int addr;
  87299. assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
  87300. assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
  87301. sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
  87302. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  87303. testcase( regFree1==0 );
  87304. addr = sqlite3VdbeAddOp1(v, op, r1);
  87305. VdbeCoverageIf(v, op==TK_ISNULL);
  87306. VdbeCoverageIf(v, op==TK_NOTNULL);
  87307. sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
  87308. sqlite3VdbeJumpHere(v, addr);
  87309. break;
  87310. }
  87311. case TK_AGG_FUNCTION: {
  87312. AggInfo *pInfo = pExpr->pAggInfo;
  87313. if( pInfo==0 ){
  87314. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87315. sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
  87316. }else{
  87317. return pInfo->aFunc[pExpr->iAgg].iMem;
  87318. }
  87319. break;
  87320. }
  87321. case TK_FUNCTION: {
  87322. ExprList *pFarg; /* List of function arguments */
  87323. int nFarg; /* Number of function arguments */
  87324. FuncDef *pDef; /* The function definition object */
  87325. const char *zId; /* The function name */
  87326. u32 constMask = 0; /* Mask of function arguments that are constant */
  87327. int i; /* Loop counter */
  87328. sqlite3 *db = pParse->db; /* The database connection */
  87329. u8 enc = ENC(db); /* The text encoding used by this database */
  87330. CollSeq *pColl = 0; /* A collating sequence */
  87331. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  87332. if( ExprHasProperty(pExpr, EP_TokenOnly) ){
  87333. pFarg = 0;
  87334. }else{
  87335. pFarg = pExpr->x.pList;
  87336. }
  87337. nFarg = pFarg ? pFarg->nExpr : 0;
  87338. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87339. zId = pExpr->u.zToken;
  87340. pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
  87341. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  87342. if( pDef==0 && pParse->explain ){
  87343. pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
  87344. }
  87345. #endif
  87346. if( pDef==0 || pDef->xFinalize!=0 ){
  87347. sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
  87348. break;
  87349. }
  87350. /* Attempt a direct implementation of the built-in COALESCE() and
  87351. ** IFNULL() functions. This avoids unnecessary evaluation of
  87352. ** arguments past the first non-NULL argument.
  87353. */
  87354. if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
  87355. int endCoalesce = sqlite3VdbeMakeLabel(v);
  87356. assert( nFarg>=2 );
  87357. sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
  87358. for(i=1; i<nFarg; i++){
  87359. sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
  87360. VdbeCoverage(v);
  87361. sqlite3ExprCacheRemove(pParse, target, 1);
  87362. sqlite3ExprCachePush(pParse);
  87363. sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
  87364. sqlite3ExprCachePop(pParse);
  87365. }
  87366. sqlite3VdbeResolveLabel(v, endCoalesce);
  87367. break;
  87368. }
  87369. /* The UNLIKELY() function is a no-op. The result is the value
  87370. ** of the first argument.
  87371. */
  87372. if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
  87373. assert( nFarg>=1 );
  87374. return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
  87375. }
  87376. for(i=0; i<nFarg; i++){
  87377. if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
  87378. testcase( i==31 );
  87379. constMask |= MASKBIT32(i);
  87380. }
  87381. if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
  87382. pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
  87383. }
  87384. }
  87385. if( pFarg ){
  87386. if( constMask ){
  87387. r1 = pParse->nMem+1;
  87388. pParse->nMem += nFarg;
  87389. }else{
  87390. r1 = sqlite3GetTempRange(pParse, nFarg);
  87391. }
  87392. /* For length() and typeof() functions with a column argument,
  87393. ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
  87394. ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
  87395. ** loading.
  87396. */
  87397. if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
  87398. u8 exprOp;
  87399. assert( nFarg==1 );
  87400. assert( pFarg->a[0].pExpr!=0 );
  87401. exprOp = pFarg->a[0].pExpr->op;
  87402. if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
  87403. assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
  87404. assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
  87405. testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
  87406. pFarg->a[0].pExpr->op2 =
  87407. pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
  87408. }
  87409. }
  87410. sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
  87411. sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
  87412. SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
  87413. sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
  87414. }else{
  87415. r1 = 0;
  87416. }
  87417. #ifndef SQLITE_OMIT_VIRTUALTABLE
  87418. /* Possibly overload the function if the first argument is
  87419. ** a virtual table column.
  87420. **
  87421. ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
  87422. ** second argument, not the first, as the argument to test to
  87423. ** see if it is a column in a virtual table. This is done because
  87424. ** the left operand of infix functions (the operand we want to
  87425. ** control overloading) ends up as the second argument to the
  87426. ** function. The expression "A glob B" is equivalent to
  87427. ** "glob(B,A). We want to use the A in "A glob B" to test
  87428. ** for function overloading. But we use the B term in "glob(B,A)".
  87429. */
  87430. if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
  87431. pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
  87432. }else if( nFarg>0 ){
  87433. pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
  87434. }
  87435. #endif
  87436. if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
  87437. if( !pColl ) pColl = db->pDfltColl;
  87438. sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
  87439. }
  87440. sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
  87441. (char*)pDef, P4_FUNCDEF);
  87442. sqlite3VdbeChangeP5(v, (u8)nFarg);
  87443. if( nFarg && constMask==0 ){
  87444. sqlite3ReleaseTempRange(pParse, r1, nFarg);
  87445. }
  87446. return target;
  87447. }
  87448. #ifndef SQLITE_OMIT_SUBQUERY
  87449. case TK_EXISTS:
  87450. case TK_SELECT: {
  87451. int nCol;
  87452. testcase( op==TK_EXISTS );
  87453. testcase( op==TK_SELECT );
  87454. if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
  87455. sqlite3SubselectError(pParse, nCol, 1);
  87456. }else{
  87457. return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
  87458. }
  87459. break;
  87460. }
  87461. case TK_SELECT_COLUMN: {
  87462. if( pExpr->pLeft->iTable==0 ){
  87463. pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
  87464. }
  87465. return pExpr->pLeft->iTable + pExpr->iColumn;
  87466. }
  87467. case TK_IN: {
  87468. int destIfFalse = sqlite3VdbeMakeLabel(v);
  87469. int destIfNull = sqlite3VdbeMakeLabel(v);
  87470. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  87471. sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
  87472. sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
  87473. sqlite3VdbeResolveLabel(v, destIfFalse);
  87474. sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
  87475. sqlite3VdbeResolveLabel(v, destIfNull);
  87476. return target;
  87477. }
  87478. #endif /* SQLITE_OMIT_SUBQUERY */
  87479. /*
  87480. ** x BETWEEN y AND z
  87481. **
  87482. ** This is equivalent to
  87483. **
  87484. ** x>=y AND x<=z
  87485. **
  87486. ** X is stored in pExpr->pLeft.
  87487. ** Y is stored in pExpr->pList->a[0].pExpr.
  87488. ** Z is stored in pExpr->pList->a[1].pExpr.
  87489. */
  87490. case TK_BETWEEN: {
  87491. exprCodeBetween(pParse, pExpr, target, 0, 0);
  87492. return target;
  87493. }
  87494. case TK_SPAN:
  87495. case TK_COLLATE:
  87496. case TK_UPLUS: {
  87497. return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
  87498. }
  87499. case TK_TRIGGER: {
  87500. /* If the opcode is TK_TRIGGER, then the expression is a reference
  87501. ** to a column in the new.* or old.* pseudo-tables available to
  87502. ** trigger programs. In this case Expr.iTable is set to 1 for the
  87503. ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
  87504. ** is set to the column of the pseudo-table to read, or to -1 to
  87505. ** read the rowid field.
  87506. **
  87507. ** The expression is implemented using an OP_Param opcode. The p1
  87508. ** parameter is set to 0 for an old.rowid reference, or to (i+1)
  87509. ** to reference another column of the old.* pseudo-table, where
  87510. ** i is the index of the column. For a new.rowid reference, p1 is
  87511. ** set to (n+1), where n is the number of columns in each pseudo-table.
  87512. ** For a reference to any other column in the new.* pseudo-table, p1
  87513. ** is set to (n+2+i), where n and i are as defined previously. For
  87514. ** example, if the table on which triggers are being fired is
  87515. ** declared as:
  87516. **
  87517. ** CREATE TABLE t1(a, b);
  87518. **
  87519. ** Then p1 is interpreted as follows:
  87520. **
  87521. ** p1==0 -> old.rowid p1==3 -> new.rowid
  87522. ** p1==1 -> old.a p1==4 -> new.a
  87523. ** p1==2 -> old.b p1==5 -> new.b
  87524. */
  87525. Table *pTab = pExpr->pTab;
  87526. int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
  87527. assert( pExpr->iTable==0 || pExpr->iTable==1 );
  87528. assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
  87529. assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
  87530. assert( p1>=0 && p1<(pTab->nCol*2+2) );
  87531. sqlite3VdbeAddOp2(v, OP_Param, p1, target);
  87532. VdbeComment((v, "%s.%s -> $%d",
  87533. (pExpr->iTable ? "new" : "old"),
  87534. (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
  87535. target
  87536. ));
  87537. #ifndef SQLITE_OMIT_FLOATING_POINT
  87538. /* If the column has REAL affinity, it may currently be stored as an
  87539. ** integer. Use OP_RealAffinity to make sure it is really real.
  87540. **
  87541. ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
  87542. ** floating point when extracting it from the record. */
  87543. if( pExpr->iColumn>=0
  87544. && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
  87545. ){
  87546. sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
  87547. }
  87548. #endif
  87549. break;
  87550. }
  87551. case TK_VECTOR: {
  87552. sqlite3ErrorMsg(pParse, "row value misused");
  87553. break;
  87554. }
  87555. /*
  87556. ** Form A:
  87557. ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
  87558. **
  87559. ** Form B:
  87560. ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
  87561. **
  87562. ** Form A is can be transformed into the equivalent form B as follows:
  87563. ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
  87564. ** WHEN x=eN THEN rN ELSE y END
  87565. **
  87566. ** X (if it exists) is in pExpr->pLeft.
  87567. ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
  87568. ** odd. The Y is also optional. If the number of elements in x.pList
  87569. ** is even, then Y is omitted and the "otherwise" result is NULL.
  87570. ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
  87571. **
  87572. ** The result of the expression is the Ri for the first matching Ei,
  87573. ** or if there is no matching Ei, the ELSE term Y, or if there is
  87574. ** no ELSE term, NULL.
  87575. */
  87576. default: assert( op==TK_CASE ); {
  87577. int endLabel; /* GOTO label for end of CASE stmt */
  87578. int nextCase; /* GOTO label for next WHEN clause */
  87579. int nExpr; /* 2x number of WHEN terms */
  87580. int i; /* Loop counter */
  87581. ExprList *pEList; /* List of WHEN terms */
  87582. struct ExprList_item *aListelem; /* Array of WHEN terms */
  87583. Expr opCompare; /* The X==Ei expression */
  87584. Expr *pX; /* The X expression */
  87585. Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
  87586. VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
  87587. assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
  87588. assert(pExpr->x.pList->nExpr > 0);
  87589. pEList = pExpr->x.pList;
  87590. aListelem = pEList->a;
  87591. nExpr = pEList->nExpr;
  87592. endLabel = sqlite3VdbeMakeLabel(v);
  87593. if( (pX = pExpr->pLeft)!=0 ){
  87594. tempX = *pX;
  87595. testcase( pX->op==TK_COLUMN );
  87596. exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
  87597. testcase( regFree1==0 );
  87598. memset(&opCompare, 0, sizeof(opCompare));
  87599. opCompare.op = TK_EQ;
  87600. opCompare.pLeft = &tempX;
  87601. pTest = &opCompare;
  87602. /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
  87603. ** The value in regFree1 might get SCopy-ed into the file result.
  87604. ** So make sure that the regFree1 register is not reused for other
  87605. ** purposes and possibly overwritten. */
  87606. regFree1 = 0;
  87607. }
  87608. for(i=0; i<nExpr-1; i=i+2){
  87609. sqlite3ExprCachePush(pParse);
  87610. if( pX ){
  87611. assert( pTest!=0 );
  87612. opCompare.pRight = aListelem[i].pExpr;
  87613. }else{
  87614. pTest = aListelem[i].pExpr;
  87615. }
  87616. nextCase = sqlite3VdbeMakeLabel(v);
  87617. testcase( pTest->op==TK_COLUMN );
  87618. sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
  87619. testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
  87620. sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
  87621. sqlite3VdbeGoto(v, endLabel);
  87622. sqlite3ExprCachePop(pParse);
  87623. sqlite3VdbeResolveLabel(v, nextCase);
  87624. }
  87625. if( (nExpr&1)!=0 ){
  87626. sqlite3ExprCachePush(pParse);
  87627. sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
  87628. sqlite3ExprCachePop(pParse);
  87629. }else{
  87630. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  87631. }
  87632. assert( pParse->db->mallocFailed || pParse->nErr>0
  87633. || pParse->iCacheLevel==iCacheLevel );
  87634. sqlite3VdbeResolveLabel(v, endLabel);
  87635. break;
  87636. }
  87637. #ifndef SQLITE_OMIT_TRIGGER
  87638. case TK_RAISE: {
  87639. assert( pExpr->affinity==OE_Rollback
  87640. || pExpr->affinity==OE_Abort
  87641. || pExpr->affinity==OE_Fail
  87642. || pExpr->affinity==OE_Ignore
  87643. );
  87644. if( !pParse->pTriggerTab ){
  87645. sqlite3ErrorMsg(pParse,
  87646. "RAISE() may only be used within a trigger-program");
  87647. return 0;
  87648. }
  87649. if( pExpr->affinity==OE_Abort ){
  87650. sqlite3MayAbort(pParse);
  87651. }
  87652. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  87653. if( pExpr->affinity==OE_Ignore ){
  87654. sqlite3VdbeAddOp4(
  87655. v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
  87656. VdbeCoverage(v);
  87657. }else{
  87658. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
  87659. pExpr->affinity, pExpr->u.zToken, 0, 0);
  87660. }
  87661. break;
  87662. }
  87663. #endif
  87664. }
  87665. sqlite3ReleaseTempReg(pParse, regFree1);
  87666. sqlite3ReleaseTempReg(pParse, regFree2);
  87667. return inReg;
  87668. }
  87669. /*
  87670. ** Factor out the code of the given expression to initialization time.
  87671. */
  87672. SQLITE_PRIVATE void sqlite3ExprCodeAtInit(
  87673. Parse *pParse, /* Parsing context */
  87674. Expr *pExpr, /* The expression to code when the VDBE initializes */
  87675. int regDest, /* Store the value in this register */
  87676. u8 reusable /* True if this expression is reusable */
  87677. ){
  87678. ExprList *p;
  87679. assert( ConstFactorOk(pParse) );
  87680. p = pParse->pConstExpr;
  87681. pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
  87682. p = sqlite3ExprListAppend(pParse, p, pExpr);
  87683. if( p ){
  87684. struct ExprList_item *pItem = &p->a[p->nExpr-1];
  87685. pItem->u.iConstExprReg = regDest;
  87686. pItem->reusable = reusable;
  87687. }
  87688. pParse->pConstExpr = p;
  87689. }
  87690. /*
  87691. ** Generate code to evaluate an expression and store the results
  87692. ** into a register. Return the register number where the results
  87693. ** are stored.
  87694. **
  87695. ** If the register is a temporary register that can be deallocated,
  87696. ** then write its number into *pReg. If the result register is not
  87697. ** a temporary, then set *pReg to zero.
  87698. **
  87699. ** If pExpr is a constant, then this routine might generate this
  87700. ** code to fill the register in the initialization section of the
  87701. ** VDBE program, in order to factor it out of the evaluation loop.
  87702. */
  87703. SQLITE_PRIVATE int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
  87704. int r2;
  87705. pExpr = sqlite3ExprSkipCollate(pExpr);
  87706. if( ConstFactorOk(pParse)
  87707. && pExpr->op!=TK_REGISTER
  87708. && sqlite3ExprIsConstantNotJoin(pExpr)
  87709. ){
  87710. ExprList *p = pParse->pConstExpr;
  87711. int i;
  87712. *pReg = 0;
  87713. if( p ){
  87714. struct ExprList_item *pItem;
  87715. for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
  87716. if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
  87717. return pItem->u.iConstExprReg;
  87718. }
  87719. }
  87720. }
  87721. r2 = ++pParse->nMem;
  87722. sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
  87723. }else{
  87724. int r1 = sqlite3GetTempReg(pParse);
  87725. r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
  87726. if( r2==r1 ){
  87727. *pReg = r1;
  87728. }else{
  87729. sqlite3ReleaseTempReg(pParse, r1);
  87730. *pReg = 0;
  87731. }
  87732. }
  87733. return r2;
  87734. }
  87735. /*
  87736. ** Generate code that will evaluate expression pExpr and store the
  87737. ** results in register target. The results are guaranteed to appear
  87738. ** in register target.
  87739. */
  87740. SQLITE_PRIVATE void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
  87741. int inReg;
  87742. assert( target>0 && target<=pParse->nMem );
  87743. if( pExpr && pExpr->op==TK_REGISTER ){
  87744. sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
  87745. }else{
  87746. inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
  87747. assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
  87748. if( inReg!=target && pParse->pVdbe ){
  87749. sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
  87750. }
  87751. }
  87752. }
  87753. /*
  87754. ** Make a transient copy of expression pExpr and then code it using
  87755. ** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
  87756. ** except that the input expression is guaranteed to be unchanged.
  87757. */
  87758. SQLITE_PRIVATE void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
  87759. sqlite3 *db = pParse->db;
  87760. pExpr = sqlite3ExprDup(db, pExpr, 0);
  87761. if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
  87762. sqlite3ExprDelete(db, pExpr);
  87763. }
  87764. /*
  87765. ** Generate code that will evaluate expression pExpr and store the
  87766. ** results in register target. The results are guaranteed to appear
  87767. ** in register target. If the expression is constant, then this routine
  87768. ** might choose to code the expression at initialization time.
  87769. */
  87770. SQLITE_PRIVATE void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
  87771. if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
  87772. sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
  87773. }else{
  87774. sqlite3ExprCode(pParse, pExpr, target);
  87775. }
  87776. }
  87777. /*
  87778. ** Generate code that evaluates the given expression and puts the result
  87779. ** in register target.
  87780. **
  87781. ** Also make a copy of the expression results into another "cache" register
  87782. ** and modify the expression so that the next time it is evaluated,
  87783. ** the result is a copy of the cache register.
  87784. **
  87785. ** This routine is used for expressions that are used multiple
  87786. ** times. They are evaluated once and the results of the expression
  87787. ** are reused.
  87788. */
  87789. SQLITE_PRIVATE void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
  87790. Vdbe *v = pParse->pVdbe;
  87791. int iMem;
  87792. assert( target>0 );
  87793. assert( pExpr->op!=TK_REGISTER );
  87794. sqlite3ExprCode(pParse, pExpr, target);
  87795. iMem = ++pParse->nMem;
  87796. sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
  87797. exprToRegister(pExpr, iMem);
  87798. }
  87799. /*
  87800. ** Generate code that pushes the value of every element of the given
  87801. ** expression list into a sequence of registers beginning at target.
  87802. **
  87803. ** Return the number of elements evaluated.
  87804. **
  87805. ** The SQLITE_ECEL_DUP flag prevents the arguments from being
  87806. ** filled using OP_SCopy. OP_Copy must be used instead.
  87807. **
  87808. ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
  87809. ** factored out into initialization code.
  87810. **
  87811. ** The SQLITE_ECEL_REF flag means that expressions in the list with
  87812. ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
  87813. ** in registers at srcReg, and so the value can be copied from there.
  87814. */
  87815. SQLITE_PRIVATE int sqlite3ExprCodeExprList(
  87816. Parse *pParse, /* Parsing context */
  87817. ExprList *pList, /* The expression list to be coded */
  87818. int target, /* Where to write results */
  87819. int srcReg, /* Source registers if SQLITE_ECEL_REF */
  87820. u8 flags /* SQLITE_ECEL_* flags */
  87821. ){
  87822. struct ExprList_item *pItem;
  87823. int i, j, n;
  87824. u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
  87825. Vdbe *v = pParse->pVdbe;
  87826. assert( pList!=0 );
  87827. assert( target>0 );
  87828. assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
  87829. n = pList->nExpr;
  87830. if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
  87831. for(pItem=pList->a, i=0; i<n; i++, pItem++){
  87832. Expr *pExpr = pItem->pExpr;
  87833. if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
  87834. sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
  87835. }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
  87836. sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
  87837. }else{
  87838. int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
  87839. if( inReg!=target+i ){
  87840. VdbeOp *pOp;
  87841. if( copyOp==OP_Copy
  87842. && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
  87843. && pOp->p1+pOp->p3+1==inReg
  87844. && pOp->p2+pOp->p3+1==target+i
  87845. ){
  87846. pOp->p3++;
  87847. }else{
  87848. sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
  87849. }
  87850. }
  87851. }
  87852. }
  87853. return n;
  87854. }
  87855. /*
  87856. ** Generate code for a BETWEEN operator.
  87857. **
  87858. ** x BETWEEN y AND z
  87859. **
  87860. ** The above is equivalent to
  87861. **
  87862. ** x>=y AND x<=z
  87863. **
  87864. ** Code it as such, taking care to do the common subexpression
  87865. ** elimination of x.
  87866. **
  87867. ** The xJumpIf parameter determines details:
  87868. **
  87869. ** NULL: Store the boolean result in reg[dest]
  87870. ** sqlite3ExprIfTrue: Jump to dest if true
  87871. ** sqlite3ExprIfFalse: Jump to dest if false
  87872. **
  87873. ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
  87874. */
  87875. static void exprCodeBetween(
  87876. Parse *pParse, /* Parsing and code generating context */
  87877. Expr *pExpr, /* The BETWEEN expression */
  87878. int dest, /* Jump destination or storage location */
  87879. void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
  87880. int jumpIfNull /* Take the jump if the BETWEEN is NULL */
  87881. ){
  87882. Expr exprAnd; /* The AND operator in x>=y AND x<=z */
  87883. Expr compLeft; /* The x>=y term */
  87884. Expr compRight; /* The x<=z term */
  87885. Expr exprX; /* The x subexpression */
  87886. int regFree1 = 0; /* Temporary use register */
  87887. memset(&compLeft, 0, sizeof(Expr));
  87888. memset(&compRight, 0, sizeof(Expr));
  87889. memset(&exprAnd, 0, sizeof(Expr));
  87890. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  87891. exprX = *pExpr->pLeft;
  87892. exprAnd.op = TK_AND;
  87893. exprAnd.pLeft = &compLeft;
  87894. exprAnd.pRight = &compRight;
  87895. compLeft.op = TK_GE;
  87896. compLeft.pLeft = &exprX;
  87897. compLeft.pRight = pExpr->x.pList->a[0].pExpr;
  87898. compRight.op = TK_LE;
  87899. compRight.pLeft = &exprX;
  87900. compRight.pRight = pExpr->x.pList->a[1].pExpr;
  87901. exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
  87902. if( xJump ){
  87903. xJump(pParse, &exprAnd, dest, jumpIfNull);
  87904. }else{
  87905. exprX.flags |= EP_FromJoin;
  87906. sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
  87907. }
  87908. sqlite3ReleaseTempReg(pParse, regFree1);
  87909. /* Ensure adequate test coverage */
  87910. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
  87911. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
  87912. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
  87913. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
  87914. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
  87915. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
  87916. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
  87917. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
  87918. testcase( xJump==0 );
  87919. }
  87920. /*
  87921. ** Generate code for a boolean expression such that a jump is made
  87922. ** to the label "dest" if the expression is true but execution
  87923. ** continues straight thru if the expression is false.
  87924. **
  87925. ** If the expression evaluates to NULL (neither true nor false), then
  87926. ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
  87927. **
  87928. ** This code depends on the fact that certain token values (ex: TK_EQ)
  87929. ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
  87930. ** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
  87931. ** the make process cause these values to align. Assert()s in the code
  87932. ** below verify that the numbers are aligned correctly.
  87933. */
  87934. SQLITE_PRIVATE void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
  87935. Vdbe *v = pParse->pVdbe;
  87936. int op = 0;
  87937. int regFree1 = 0;
  87938. int regFree2 = 0;
  87939. int r1, r2;
  87940. assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
  87941. if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
  87942. if( NEVER(pExpr==0) ) return; /* No way this can happen */
  87943. op = pExpr->op;
  87944. switch( op ){
  87945. case TK_AND: {
  87946. int d2 = sqlite3VdbeMakeLabel(v);
  87947. testcase( jumpIfNull==0 );
  87948. sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
  87949. sqlite3ExprCachePush(pParse);
  87950. sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
  87951. sqlite3VdbeResolveLabel(v, d2);
  87952. sqlite3ExprCachePop(pParse);
  87953. break;
  87954. }
  87955. case TK_OR: {
  87956. testcase( jumpIfNull==0 );
  87957. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
  87958. sqlite3ExprCachePush(pParse);
  87959. sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
  87960. sqlite3ExprCachePop(pParse);
  87961. break;
  87962. }
  87963. case TK_NOT: {
  87964. testcase( jumpIfNull==0 );
  87965. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
  87966. break;
  87967. }
  87968. case TK_IS:
  87969. case TK_ISNOT:
  87970. testcase( op==TK_IS );
  87971. testcase( op==TK_ISNOT );
  87972. op = (op==TK_IS) ? TK_EQ : TK_NE;
  87973. jumpIfNull = SQLITE_NULLEQ;
  87974. /* Fall thru */
  87975. case TK_LT:
  87976. case TK_LE:
  87977. case TK_GT:
  87978. case TK_GE:
  87979. case TK_NE:
  87980. case TK_EQ: {
  87981. if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
  87982. testcase( jumpIfNull==0 );
  87983. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  87984. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  87985. codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
  87986. r1, r2, dest, jumpIfNull);
  87987. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  87988. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  87989. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  87990. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  87991. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
  87992. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
  87993. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
  87994. assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
  87995. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
  87996. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
  87997. testcase( regFree1==0 );
  87998. testcase( regFree2==0 );
  87999. break;
  88000. }
  88001. case TK_ISNULL:
  88002. case TK_NOTNULL: {
  88003. assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
  88004. assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
  88005. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  88006. sqlite3VdbeAddOp2(v, op, r1, dest);
  88007. VdbeCoverageIf(v, op==TK_ISNULL);
  88008. VdbeCoverageIf(v, op==TK_NOTNULL);
  88009. testcase( regFree1==0 );
  88010. break;
  88011. }
  88012. case TK_BETWEEN: {
  88013. testcase( jumpIfNull==0 );
  88014. exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
  88015. break;
  88016. }
  88017. #ifndef SQLITE_OMIT_SUBQUERY
  88018. case TK_IN: {
  88019. int destIfFalse = sqlite3VdbeMakeLabel(v);
  88020. int destIfNull = jumpIfNull ? dest : destIfFalse;
  88021. sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
  88022. sqlite3VdbeGoto(v, dest);
  88023. sqlite3VdbeResolveLabel(v, destIfFalse);
  88024. break;
  88025. }
  88026. #endif
  88027. default: {
  88028. default_expr:
  88029. if( exprAlwaysTrue(pExpr) ){
  88030. sqlite3VdbeGoto(v, dest);
  88031. }else if( exprAlwaysFalse(pExpr) ){
  88032. /* No-op */
  88033. }else{
  88034. r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
  88035. sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
  88036. VdbeCoverage(v);
  88037. testcase( regFree1==0 );
  88038. testcase( jumpIfNull==0 );
  88039. }
  88040. break;
  88041. }
  88042. }
  88043. sqlite3ReleaseTempReg(pParse, regFree1);
  88044. sqlite3ReleaseTempReg(pParse, regFree2);
  88045. }
  88046. /*
  88047. ** Generate code for a boolean expression such that a jump is made
  88048. ** to the label "dest" if the expression is false but execution
  88049. ** continues straight thru if the expression is true.
  88050. **
  88051. ** If the expression evaluates to NULL (neither true nor false) then
  88052. ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
  88053. ** is 0.
  88054. */
  88055. SQLITE_PRIVATE void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
  88056. Vdbe *v = pParse->pVdbe;
  88057. int op = 0;
  88058. int regFree1 = 0;
  88059. int regFree2 = 0;
  88060. int r1, r2;
  88061. assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
  88062. if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
  88063. if( pExpr==0 ) return;
  88064. /* The value of pExpr->op and op are related as follows:
  88065. **
  88066. ** pExpr->op op
  88067. ** --------- ----------
  88068. ** TK_ISNULL OP_NotNull
  88069. ** TK_NOTNULL OP_IsNull
  88070. ** TK_NE OP_Eq
  88071. ** TK_EQ OP_Ne
  88072. ** TK_GT OP_Le
  88073. ** TK_LE OP_Gt
  88074. ** TK_GE OP_Lt
  88075. ** TK_LT OP_Ge
  88076. **
  88077. ** For other values of pExpr->op, op is undefined and unused.
  88078. ** The value of TK_ and OP_ constants are arranged such that we
  88079. ** can compute the mapping above using the following expression.
  88080. ** Assert()s verify that the computation is correct.
  88081. */
  88082. op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
  88083. /* Verify correct alignment of TK_ and OP_ constants
  88084. */
  88085. assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
  88086. assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
  88087. assert( pExpr->op!=TK_NE || op==OP_Eq );
  88088. assert( pExpr->op!=TK_EQ || op==OP_Ne );
  88089. assert( pExpr->op!=TK_LT || op==OP_Ge );
  88090. assert( pExpr->op!=TK_LE || op==OP_Gt );
  88091. assert( pExpr->op!=TK_GT || op==OP_Le );
  88092. assert( pExpr->op!=TK_GE || op==OP_Lt );
  88093. switch( pExpr->op ){
  88094. case TK_AND: {
  88095. testcase( jumpIfNull==0 );
  88096. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
  88097. sqlite3ExprCachePush(pParse);
  88098. sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
  88099. sqlite3ExprCachePop(pParse);
  88100. break;
  88101. }
  88102. case TK_OR: {
  88103. int d2 = sqlite3VdbeMakeLabel(v);
  88104. testcase( jumpIfNull==0 );
  88105. sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
  88106. sqlite3ExprCachePush(pParse);
  88107. sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
  88108. sqlite3VdbeResolveLabel(v, d2);
  88109. sqlite3ExprCachePop(pParse);
  88110. break;
  88111. }
  88112. case TK_NOT: {
  88113. testcase( jumpIfNull==0 );
  88114. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
  88115. break;
  88116. }
  88117. case TK_IS:
  88118. case TK_ISNOT:
  88119. testcase( pExpr->op==TK_IS );
  88120. testcase( pExpr->op==TK_ISNOT );
  88121. op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
  88122. jumpIfNull = SQLITE_NULLEQ;
  88123. /* Fall thru */
  88124. case TK_LT:
  88125. case TK_LE:
  88126. case TK_GT:
  88127. case TK_GE:
  88128. case TK_NE:
  88129. case TK_EQ: {
  88130. if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
  88131. testcase( jumpIfNull==0 );
  88132. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  88133. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  88134. codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
  88135. r1, r2, dest, jumpIfNull);
  88136. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  88137. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  88138. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  88139. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  88140. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
  88141. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
  88142. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
  88143. assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
  88144. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
  88145. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
  88146. testcase( regFree1==0 );
  88147. testcase( regFree2==0 );
  88148. break;
  88149. }
  88150. case TK_ISNULL:
  88151. case TK_NOTNULL: {
  88152. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  88153. sqlite3VdbeAddOp2(v, op, r1, dest);
  88154. testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
  88155. testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
  88156. testcase( regFree1==0 );
  88157. break;
  88158. }
  88159. case TK_BETWEEN: {
  88160. testcase( jumpIfNull==0 );
  88161. exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
  88162. break;
  88163. }
  88164. #ifndef SQLITE_OMIT_SUBQUERY
  88165. case TK_IN: {
  88166. if( jumpIfNull ){
  88167. sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
  88168. }else{
  88169. int destIfNull = sqlite3VdbeMakeLabel(v);
  88170. sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
  88171. sqlite3VdbeResolveLabel(v, destIfNull);
  88172. }
  88173. break;
  88174. }
  88175. #endif
  88176. default: {
  88177. default_expr:
  88178. if( exprAlwaysFalse(pExpr) ){
  88179. sqlite3VdbeGoto(v, dest);
  88180. }else if( exprAlwaysTrue(pExpr) ){
  88181. /* no-op */
  88182. }else{
  88183. r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
  88184. sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
  88185. VdbeCoverage(v);
  88186. testcase( regFree1==0 );
  88187. testcase( jumpIfNull==0 );
  88188. }
  88189. break;
  88190. }
  88191. }
  88192. sqlite3ReleaseTempReg(pParse, regFree1);
  88193. sqlite3ReleaseTempReg(pParse, regFree2);
  88194. }
  88195. /*
  88196. ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
  88197. ** code generation, and that copy is deleted after code generation. This
  88198. ** ensures that the original pExpr is unchanged.
  88199. */
  88200. SQLITE_PRIVATE void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
  88201. sqlite3 *db = pParse->db;
  88202. Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
  88203. if( db->mallocFailed==0 ){
  88204. sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
  88205. }
  88206. sqlite3ExprDelete(db, pCopy);
  88207. }
  88208. /*
  88209. ** Do a deep comparison of two expression trees. Return 0 if the two
  88210. ** expressions are completely identical. Return 1 if they differ only
  88211. ** by a COLLATE operator at the top level. Return 2 if there are differences
  88212. ** other than the top-level COLLATE operator.
  88213. **
  88214. ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
  88215. ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
  88216. **
  88217. ** The pA side might be using TK_REGISTER. If that is the case and pB is
  88218. ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
  88219. **
  88220. ** Sometimes this routine will return 2 even if the two expressions
  88221. ** really are equivalent. If we cannot prove that the expressions are
  88222. ** identical, we return 2 just to be safe. So if this routine
  88223. ** returns 2, then you do not really know for certain if the two
  88224. ** expressions are the same. But if you get a 0 or 1 return, then you
  88225. ** can be sure the expressions are the same. In the places where
  88226. ** this routine is used, it does not hurt to get an extra 2 - that
  88227. ** just might result in some slightly slower code. But returning
  88228. ** an incorrect 0 or 1 could lead to a malfunction.
  88229. */
  88230. SQLITE_PRIVATE int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
  88231. u32 combinedFlags;
  88232. if( pA==0 || pB==0 ){
  88233. return pB==pA ? 0 : 2;
  88234. }
  88235. combinedFlags = pA->flags | pB->flags;
  88236. if( combinedFlags & EP_IntValue ){
  88237. if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
  88238. return 0;
  88239. }
  88240. return 2;
  88241. }
  88242. if( pA->op!=pB->op ){
  88243. if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
  88244. return 1;
  88245. }
  88246. if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
  88247. return 1;
  88248. }
  88249. return 2;
  88250. }
  88251. if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
  88252. if( pA->op==TK_FUNCTION ){
  88253. if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
  88254. }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
  88255. return pA->op==TK_COLLATE ? 1 : 2;
  88256. }
  88257. }
  88258. if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
  88259. if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
  88260. if( combinedFlags & EP_xIsSelect ) return 2;
  88261. if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
  88262. if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
  88263. if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
  88264. if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
  88265. if( pA->iColumn!=pB->iColumn ) return 2;
  88266. if( pA->iTable!=pB->iTable
  88267. && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
  88268. }
  88269. }
  88270. return 0;
  88271. }
  88272. /*
  88273. ** Compare two ExprList objects. Return 0 if they are identical and
  88274. ** non-zero if they differ in any way.
  88275. **
  88276. ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
  88277. ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
  88278. **
  88279. ** This routine might return non-zero for equivalent ExprLists. The
  88280. ** only consequence will be disabled optimizations. But this routine
  88281. ** must never return 0 if the two ExprList objects are different, or
  88282. ** a malfunction will result.
  88283. **
  88284. ** Two NULL pointers are considered to be the same. But a NULL pointer
  88285. ** always differs from a non-NULL pointer.
  88286. */
  88287. SQLITE_PRIVATE int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
  88288. int i;
  88289. if( pA==0 && pB==0 ) return 0;
  88290. if( pA==0 || pB==0 ) return 1;
  88291. if( pA->nExpr!=pB->nExpr ) return 1;
  88292. for(i=0; i<pA->nExpr; i++){
  88293. Expr *pExprA = pA->a[i].pExpr;
  88294. Expr *pExprB = pB->a[i].pExpr;
  88295. if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
  88296. if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
  88297. }
  88298. return 0;
  88299. }
  88300. /*
  88301. ** Return true if we can prove the pE2 will always be true if pE1 is
  88302. ** true. Return false if we cannot complete the proof or if pE2 might
  88303. ** be false. Examples:
  88304. **
  88305. ** pE1: x==5 pE2: x==5 Result: true
  88306. ** pE1: x>0 pE2: x==5 Result: false
  88307. ** pE1: x=21 pE2: x=21 OR y=43 Result: true
  88308. ** pE1: x!=123 pE2: x IS NOT NULL Result: true
  88309. ** pE1: x!=?1 pE2: x IS NOT NULL Result: true
  88310. ** pE1: x IS NULL pE2: x IS NOT NULL Result: false
  88311. ** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
  88312. **
  88313. ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
  88314. ** Expr.iTable<0 then assume a table number given by iTab.
  88315. **
  88316. ** When in doubt, return false. Returning true might give a performance
  88317. ** improvement. Returning false might cause a performance reduction, but
  88318. ** it will always give the correct answer and is hence always safe.
  88319. */
  88320. SQLITE_PRIVATE int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
  88321. if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
  88322. return 1;
  88323. }
  88324. if( pE2->op==TK_OR
  88325. && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
  88326. || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
  88327. ){
  88328. return 1;
  88329. }
  88330. if( pE2->op==TK_NOTNULL
  88331. && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
  88332. && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
  88333. ){
  88334. return 1;
  88335. }
  88336. return 0;
  88337. }
  88338. /*
  88339. ** An instance of the following structure is used by the tree walker
  88340. ** to determine if an expression can be evaluated by reference to the
  88341. ** index only, without having to do a search for the corresponding
  88342. ** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
  88343. ** is the cursor for the table.
  88344. */
  88345. struct IdxCover {
  88346. Index *pIdx; /* The index to be tested for coverage */
  88347. int iCur; /* Cursor number for the table corresponding to the index */
  88348. };
  88349. /*
  88350. ** Check to see if there are references to columns in table
  88351. ** pWalker->u.pIdxCover->iCur can be satisfied using the index
  88352. ** pWalker->u.pIdxCover->pIdx.
  88353. */
  88354. static int exprIdxCover(Walker *pWalker, Expr *pExpr){
  88355. if( pExpr->op==TK_COLUMN
  88356. && pExpr->iTable==pWalker->u.pIdxCover->iCur
  88357. && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
  88358. ){
  88359. pWalker->eCode = 1;
  88360. return WRC_Abort;
  88361. }
  88362. return WRC_Continue;
  88363. }
  88364. /*
  88365. ** Determine if an index pIdx on table with cursor iCur contains will
  88366. ** the expression pExpr. Return true if the index does cover the
  88367. ** expression and false if the pExpr expression references table columns
  88368. ** that are not found in the index pIdx.
  88369. **
  88370. ** An index covering an expression means that the expression can be
  88371. ** evaluated using only the index and without having to lookup the
  88372. ** corresponding table entry.
  88373. */
  88374. SQLITE_PRIVATE int sqlite3ExprCoveredByIndex(
  88375. Expr *pExpr, /* The index to be tested */
  88376. int iCur, /* The cursor number for the corresponding table */
  88377. Index *pIdx /* The index that might be used for coverage */
  88378. ){
  88379. Walker w;
  88380. struct IdxCover xcov;
  88381. memset(&w, 0, sizeof(w));
  88382. xcov.iCur = iCur;
  88383. xcov.pIdx = pIdx;
  88384. w.xExprCallback = exprIdxCover;
  88385. w.u.pIdxCover = &xcov;
  88386. sqlite3WalkExpr(&w, pExpr);
  88387. return !w.eCode;
  88388. }
  88389. /*
  88390. ** An instance of the following structure is used by the tree walker
  88391. ** to count references to table columns in the arguments of an
  88392. ** aggregate function, in order to implement the
  88393. ** sqlite3FunctionThisSrc() routine.
  88394. */
  88395. struct SrcCount {
  88396. SrcList *pSrc; /* One particular FROM clause in a nested query */
  88397. int nThis; /* Number of references to columns in pSrcList */
  88398. int nOther; /* Number of references to columns in other FROM clauses */
  88399. };
  88400. /*
  88401. ** Count the number of references to columns.
  88402. */
  88403. static int exprSrcCount(Walker *pWalker, Expr *pExpr){
  88404. /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
  88405. ** is always called before sqlite3ExprAnalyzeAggregates() and so the
  88406. ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
  88407. ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
  88408. ** NEVER() will need to be removed. */
  88409. if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
  88410. int i;
  88411. struct SrcCount *p = pWalker->u.pSrcCount;
  88412. SrcList *pSrc = p->pSrc;
  88413. int nSrc = pSrc ? pSrc->nSrc : 0;
  88414. for(i=0; i<nSrc; i++){
  88415. if( pExpr->iTable==pSrc->a[i].iCursor ) break;
  88416. }
  88417. if( i<nSrc ){
  88418. p->nThis++;
  88419. }else{
  88420. p->nOther++;
  88421. }
  88422. }
  88423. return WRC_Continue;
  88424. }
  88425. /*
  88426. ** Determine if any of the arguments to the pExpr Function reference
  88427. ** pSrcList. Return true if they do. Also return true if the function
  88428. ** has no arguments or has only constant arguments. Return false if pExpr
  88429. ** references columns but not columns of tables found in pSrcList.
  88430. */
  88431. SQLITE_PRIVATE int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
  88432. Walker w;
  88433. struct SrcCount cnt;
  88434. assert( pExpr->op==TK_AGG_FUNCTION );
  88435. memset(&w, 0, sizeof(w));
  88436. w.xExprCallback = exprSrcCount;
  88437. w.u.pSrcCount = &cnt;
  88438. cnt.pSrc = pSrcList;
  88439. cnt.nThis = 0;
  88440. cnt.nOther = 0;
  88441. sqlite3WalkExprList(&w, pExpr->x.pList);
  88442. return cnt.nThis>0 || cnt.nOther==0;
  88443. }
  88444. /*
  88445. ** Add a new element to the pAggInfo->aCol[] array. Return the index of
  88446. ** the new element. Return a negative number if malloc fails.
  88447. */
  88448. static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
  88449. int i;
  88450. pInfo->aCol = sqlite3ArrayAllocate(
  88451. db,
  88452. pInfo->aCol,
  88453. sizeof(pInfo->aCol[0]),
  88454. &pInfo->nColumn,
  88455. &i
  88456. );
  88457. return i;
  88458. }
  88459. /*
  88460. ** Add a new element to the pAggInfo->aFunc[] array. Return the index of
  88461. ** the new element. Return a negative number if malloc fails.
  88462. */
  88463. static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
  88464. int i;
  88465. pInfo->aFunc = sqlite3ArrayAllocate(
  88466. db,
  88467. pInfo->aFunc,
  88468. sizeof(pInfo->aFunc[0]),
  88469. &pInfo->nFunc,
  88470. &i
  88471. );
  88472. return i;
  88473. }
  88474. /*
  88475. ** This is the xExprCallback for a tree walker. It is used to
  88476. ** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
  88477. ** for additional information.
  88478. */
  88479. static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
  88480. int i;
  88481. NameContext *pNC = pWalker->u.pNC;
  88482. Parse *pParse = pNC->pParse;
  88483. SrcList *pSrcList = pNC->pSrcList;
  88484. AggInfo *pAggInfo = pNC->pAggInfo;
  88485. switch( pExpr->op ){
  88486. case TK_AGG_COLUMN:
  88487. case TK_COLUMN: {
  88488. testcase( pExpr->op==TK_AGG_COLUMN );
  88489. testcase( pExpr->op==TK_COLUMN );
  88490. /* Check to see if the column is in one of the tables in the FROM
  88491. ** clause of the aggregate query */
  88492. if( ALWAYS(pSrcList!=0) ){
  88493. struct SrcList_item *pItem = pSrcList->a;
  88494. for(i=0; i<pSrcList->nSrc; i++, pItem++){
  88495. struct AggInfo_col *pCol;
  88496. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  88497. if( pExpr->iTable==pItem->iCursor ){
  88498. /* If we reach this point, it means that pExpr refers to a table
  88499. ** that is in the FROM clause of the aggregate query.
  88500. **
  88501. ** Make an entry for the column in pAggInfo->aCol[] if there
  88502. ** is not an entry there already.
  88503. */
  88504. int k;
  88505. pCol = pAggInfo->aCol;
  88506. for(k=0; k<pAggInfo->nColumn; k++, pCol++){
  88507. if( pCol->iTable==pExpr->iTable &&
  88508. pCol->iColumn==pExpr->iColumn ){
  88509. break;
  88510. }
  88511. }
  88512. if( (k>=pAggInfo->nColumn)
  88513. && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
  88514. ){
  88515. pCol = &pAggInfo->aCol[k];
  88516. pCol->pTab = pExpr->pTab;
  88517. pCol->iTable = pExpr->iTable;
  88518. pCol->iColumn = pExpr->iColumn;
  88519. pCol->iMem = ++pParse->nMem;
  88520. pCol->iSorterColumn = -1;
  88521. pCol->pExpr = pExpr;
  88522. if( pAggInfo->pGroupBy ){
  88523. int j, n;
  88524. ExprList *pGB = pAggInfo->pGroupBy;
  88525. struct ExprList_item *pTerm = pGB->a;
  88526. n = pGB->nExpr;
  88527. for(j=0; j<n; j++, pTerm++){
  88528. Expr *pE = pTerm->pExpr;
  88529. if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
  88530. pE->iColumn==pExpr->iColumn ){
  88531. pCol->iSorterColumn = j;
  88532. break;
  88533. }
  88534. }
  88535. }
  88536. if( pCol->iSorterColumn<0 ){
  88537. pCol->iSorterColumn = pAggInfo->nSortingColumn++;
  88538. }
  88539. }
  88540. /* There is now an entry for pExpr in pAggInfo->aCol[] (either
  88541. ** because it was there before or because we just created it).
  88542. ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
  88543. ** pAggInfo->aCol[] entry.
  88544. */
  88545. ExprSetVVAProperty(pExpr, EP_NoReduce);
  88546. pExpr->pAggInfo = pAggInfo;
  88547. pExpr->op = TK_AGG_COLUMN;
  88548. pExpr->iAgg = (i16)k;
  88549. break;
  88550. } /* endif pExpr->iTable==pItem->iCursor */
  88551. } /* end loop over pSrcList */
  88552. }
  88553. return WRC_Prune;
  88554. }
  88555. case TK_AGG_FUNCTION: {
  88556. if( (pNC->ncFlags & NC_InAggFunc)==0
  88557. && pWalker->walkerDepth==pExpr->op2
  88558. ){
  88559. /* Check to see if pExpr is a duplicate of another aggregate
  88560. ** function that is already in the pAggInfo structure
  88561. */
  88562. struct AggInfo_func *pItem = pAggInfo->aFunc;
  88563. for(i=0; i<pAggInfo->nFunc; i++, pItem++){
  88564. if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
  88565. break;
  88566. }
  88567. }
  88568. if( i>=pAggInfo->nFunc ){
  88569. /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
  88570. */
  88571. u8 enc = ENC(pParse->db);
  88572. i = addAggInfoFunc(pParse->db, pAggInfo);
  88573. if( i>=0 ){
  88574. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  88575. pItem = &pAggInfo->aFunc[i];
  88576. pItem->pExpr = pExpr;
  88577. pItem->iMem = ++pParse->nMem;
  88578. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  88579. pItem->pFunc = sqlite3FindFunction(pParse->db,
  88580. pExpr->u.zToken,
  88581. pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
  88582. if( pExpr->flags & EP_Distinct ){
  88583. pItem->iDistinct = pParse->nTab++;
  88584. }else{
  88585. pItem->iDistinct = -1;
  88586. }
  88587. }
  88588. }
  88589. /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
  88590. */
  88591. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  88592. ExprSetVVAProperty(pExpr, EP_NoReduce);
  88593. pExpr->iAgg = (i16)i;
  88594. pExpr->pAggInfo = pAggInfo;
  88595. return WRC_Prune;
  88596. }else{
  88597. return WRC_Continue;
  88598. }
  88599. }
  88600. }
  88601. return WRC_Continue;
  88602. }
  88603. static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
  88604. UNUSED_PARAMETER(pWalker);
  88605. UNUSED_PARAMETER(pSelect);
  88606. return WRC_Continue;
  88607. }
  88608. /*
  88609. ** Analyze the pExpr expression looking for aggregate functions and
  88610. ** for variables that need to be added to AggInfo object that pNC->pAggInfo
  88611. ** points to. Additional entries are made on the AggInfo object as
  88612. ** necessary.
  88613. **
  88614. ** This routine should only be called after the expression has been
  88615. ** analyzed by sqlite3ResolveExprNames().
  88616. */
  88617. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
  88618. Walker w;
  88619. memset(&w, 0, sizeof(w));
  88620. w.xExprCallback = analyzeAggregate;
  88621. w.xSelectCallback = analyzeAggregatesInSelect;
  88622. w.u.pNC = pNC;
  88623. assert( pNC->pSrcList!=0 );
  88624. sqlite3WalkExpr(&w, pExpr);
  88625. }
  88626. /*
  88627. ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
  88628. ** expression list. Return the number of errors.
  88629. **
  88630. ** If an error is found, the analysis is cut short.
  88631. */
  88632. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
  88633. struct ExprList_item *pItem;
  88634. int i;
  88635. if( pList ){
  88636. for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
  88637. sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
  88638. }
  88639. }
  88640. }
  88641. /*
  88642. ** Allocate a single new register for use to hold some intermediate result.
  88643. */
  88644. SQLITE_PRIVATE int sqlite3GetTempReg(Parse *pParse){
  88645. if( pParse->nTempReg==0 ){
  88646. return ++pParse->nMem;
  88647. }
  88648. return pParse->aTempReg[--pParse->nTempReg];
  88649. }
  88650. /*
  88651. ** Deallocate a register, making available for reuse for some other
  88652. ** purpose.
  88653. **
  88654. ** If a register is currently being used by the column cache, then
  88655. ** the deallocation is deferred until the column cache line that uses
  88656. ** the register becomes stale.
  88657. */
  88658. SQLITE_PRIVATE void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
  88659. if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
  88660. int i;
  88661. struct yColCache *p;
  88662. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  88663. if( p->iReg==iReg ){
  88664. p->tempReg = 1;
  88665. return;
  88666. }
  88667. }
  88668. pParse->aTempReg[pParse->nTempReg++] = iReg;
  88669. }
  88670. }
  88671. /*
  88672. ** Allocate or deallocate a block of nReg consecutive registers.
  88673. */
  88674. SQLITE_PRIVATE int sqlite3GetTempRange(Parse *pParse, int nReg){
  88675. int i, n;
  88676. if( nReg==1 ) return sqlite3GetTempReg(pParse);
  88677. i = pParse->iRangeReg;
  88678. n = pParse->nRangeReg;
  88679. if( nReg<=n ){
  88680. assert( !usedAsColumnCache(pParse, i, i+n-1) );
  88681. pParse->iRangeReg += nReg;
  88682. pParse->nRangeReg -= nReg;
  88683. }else{
  88684. i = pParse->nMem+1;
  88685. pParse->nMem += nReg;
  88686. }
  88687. return i;
  88688. }
  88689. SQLITE_PRIVATE void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
  88690. if( nReg==1 ){
  88691. sqlite3ReleaseTempReg(pParse, iReg);
  88692. return;
  88693. }
  88694. sqlite3ExprCacheRemove(pParse, iReg, nReg);
  88695. if( nReg>pParse->nRangeReg ){
  88696. pParse->nRangeReg = nReg;
  88697. pParse->iRangeReg = iReg;
  88698. }
  88699. }
  88700. /*
  88701. ** Mark all temporary registers as being unavailable for reuse.
  88702. */
  88703. SQLITE_PRIVATE void sqlite3ClearTempRegCache(Parse *pParse){
  88704. pParse->nTempReg = 0;
  88705. pParse->nRangeReg = 0;
  88706. }
  88707. /*
  88708. ** Validate that no temporary register falls within the range of
  88709. ** iFirst..iLast, inclusive. This routine is only call from within assert()
  88710. ** statements.
  88711. */
  88712. #ifdef SQLITE_DEBUG
  88713. SQLITE_PRIVATE int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
  88714. int i;
  88715. if( pParse->nRangeReg>0
  88716. && pParse->iRangeReg+pParse->nRangeReg<iLast
  88717. && pParse->iRangeReg>=iFirst
  88718. ){
  88719. return 0;
  88720. }
  88721. for(i=0; i<pParse->nTempReg; i++){
  88722. if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
  88723. return 0;
  88724. }
  88725. }
  88726. return 1;
  88727. }
  88728. #endif /* SQLITE_DEBUG */
  88729. /************** End of expr.c ************************************************/
  88730. /************** Begin file alter.c *******************************************/
  88731. /*
  88732. ** 2005 February 15
  88733. **
  88734. ** The author disclaims copyright to this source code. In place of
  88735. ** a legal notice, here is a blessing:
  88736. **
  88737. ** May you do good and not evil.
  88738. ** May you find forgiveness for yourself and forgive others.
  88739. ** May you share freely, never taking more than you give.
  88740. **
  88741. *************************************************************************
  88742. ** This file contains C code routines that used to generate VDBE code
  88743. ** that implements the ALTER TABLE command.
  88744. */
  88745. /* #include "sqliteInt.h" */
  88746. /*
  88747. ** The code in this file only exists if we are not omitting the
  88748. ** ALTER TABLE logic from the build.
  88749. */
  88750. #ifndef SQLITE_OMIT_ALTERTABLE
  88751. /*
  88752. ** This function is used by SQL generated to implement the
  88753. ** ALTER TABLE command. The first argument is the text of a CREATE TABLE or
  88754. ** CREATE INDEX command. The second is a table name. The table name in
  88755. ** the CREATE TABLE or CREATE INDEX statement is replaced with the third
  88756. ** argument and the result returned. Examples:
  88757. **
  88758. ** sqlite_rename_table('CREATE TABLE abc(a, b, c)', 'def')
  88759. ** -> 'CREATE TABLE def(a, b, c)'
  88760. **
  88761. ** sqlite_rename_table('CREATE INDEX i ON abc(a)', 'def')
  88762. ** -> 'CREATE INDEX i ON def(a, b, c)'
  88763. */
  88764. static void renameTableFunc(
  88765. sqlite3_context *context,
  88766. int NotUsed,
  88767. sqlite3_value **argv
  88768. ){
  88769. unsigned char const *zSql = sqlite3_value_text(argv[0]);
  88770. unsigned char const *zTableName = sqlite3_value_text(argv[1]);
  88771. int token;
  88772. Token tname;
  88773. unsigned char const *zCsr = zSql;
  88774. int len = 0;
  88775. char *zRet;
  88776. sqlite3 *db = sqlite3_context_db_handle(context);
  88777. UNUSED_PARAMETER(NotUsed);
  88778. /* The principle used to locate the table name in the CREATE TABLE
  88779. ** statement is that the table name is the first non-space token that
  88780. ** is immediately followed by a TK_LP or TK_USING token.
  88781. */
  88782. if( zSql ){
  88783. do {
  88784. if( !*zCsr ){
  88785. /* Ran out of input before finding an opening bracket. Return NULL. */
  88786. return;
  88787. }
  88788. /* Store the token that zCsr points to in tname. */
  88789. tname.z = (char*)zCsr;
  88790. tname.n = len;
  88791. /* Advance zCsr to the next token. Store that token type in 'token',
  88792. ** and its length in 'len' (to be used next iteration of this loop).
  88793. */
  88794. do {
  88795. zCsr += len;
  88796. len = sqlite3GetToken(zCsr, &token);
  88797. } while( token==TK_SPACE );
  88798. assert( len>0 );
  88799. } while( token!=TK_LP && token!=TK_USING );
  88800. zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", (int)(((u8*)tname.z) - zSql),
  88801. zSql, zTableName, tname.z+tname.n);
  88802. sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
  88803. }
  88804. }
  88805. /*
  88806. ** This C function implements an SQL user function that is used by SQL code
  88807. ** generated by the ALTER TABLE ... RENAME command to modify the definition
  88808. ** of any foreign key constraints that use the table being renamed as the
  88809. ** parent table. It is passed three arguments:
  88810. **
  88811. ** 1) The complete text of the CREATE TABLE statement being modified,
  88812. ** 2) The old name of the table being renamed, and
  88813. ** 3) The new name of the table being renamed.
  88814. **
  88815. ** It returns the new CREATE TABLE statement. For example:
  88816. **
  88817. ** sqlite_rename_parent('CREATE TABLE t1(a REFERENCES t2)', 't2', 't3')
  88818. ** -> 'CREATE TABLE t1(a REFERENCES t3)'
  88819. */
  88820. #ifndef SQLITE_OMIT_FOREIGN_KEY
  88821. static void renameParentFunc(
  88822. sqlite3_context *context,
  88823. int NotUsed,
  88824. sqlite3_value **argv
  88825. ){
  88826. sqlite3 *db = sqlite3_context_db_handle(context);
  88827. char *zOutput = 0;
  88828. char *zResult;
  88829. unsigned char const *zInput = sqlite3_value_text(argv[0]);
  88830. unsigned char const *zOld = sqlite3_value_text(argv[1]);
  88831. unsigned char const *zNew = sqlite3_value_text(argv[2]);
  88832. unsigned const char *z; /* Pointer to token */
  88833. int n; /* Length of token z */
  88834. int token; /* Type of token */
  88835. UNUSED_PARAMETER(NotUsed);
  88836. if( zInput==0 || zOld==0 ) return;
  88837. for(z=zInput; *z; z=z+n){
  88838. n = sqlite3GetToken(z, &token);
  88839. if( token==TK_REFERENCES ){
  88840. char *zParent;
  88841. do {
  88842. z += n;
  88843. n = sqlite3GetToken(z, &token);
  88844. }while( token==TK_SPACE );
  88845. if( token==TK_ILLEGAL ) break;
  88846. zParent = sqlite3DbStrNDup(db, (const char *)z, n);
  88847. if( zParent==0 ) break;
  88848. sqlite3Dequote(zParent);
  88849. if( 0==sqlite3StrICmp((const char *)zOld, zParent) ){
  88850. char *zOut = sqlite3MPrintf(db, "%s%.*s\"%w\"",
  88851. (zOutput?zOutput:""), (int)(z-zInput), zInput, (const char *)zNew
  88852. );
  88853. sqlite3DbFree(db, zOutput);
  88854. zOutput = zOut;
  88855. zInput = &z[n];
  88856. }
  88857. sqlite3DbFree(db, zParent);
  88858. }
  88859. }
  88860. zResult = sqlite3MPrintf(db, "%s%s", (zOutput?zOutput:""), zInput),
  88861. sqlite3_result_text(context, zResult, -1, SQLITE_DYNAMIC);
  88862. sqlite3DbFree(db, zOutput);
  88863. }
  88864. #endif
  88865. #ifndef SQLITE_OMIT_TRIGGER
  88866. /* This function is used by SQL generated to implement the
  88867. ** ALTER TABLE command. The first argument is the text of a CREATE TRIGGER
  88868. ** statement. The second is a table name. The table name in the CREATE
  88869. ** TRIGGER statement is replaced with the third argument and the result
  88870. ** returned. This is analagous to renameTableFunc() above, except for CREATE
  88871. ** TRIGGER, not CREATE INDEX and CREATE TABLE.
  88872. */
  88873. static void renameTriggerFunc(
  88874. sqlite3_context *context,
  88875. int NotUsed,
  88876. sqlite3_value **argv
  88877. ){
  88878. unsigned char const *zSql = sqlite3_value_text(argv[0]);
  88879. unsigned char const *zTableName = sqlite3_value_text(argv[1]);
  88880. int token;
  88881. Token tname;
  88882. int dist = 3;
  88883. unsigned char const *zCsr = zSql;
  88884. int len = 0;
  88885. char *zRet;
  88886. sqlite3 *db = sqlite3_context_db_handle(context);
  88887. UNUSED_PARAMETER(NotUsed);
  88888. /* The principle used to locate the table name in the CREATE TRIGGER
  88889. ** statement is that the table name is the first token that is immediately
  88890. ** preceded by either TK_ON or TK_DOT and immediately followed by one
  88891. ** of TK_WHEN, TK_BEGIN or TK_FOR.
  88892. */
  88893. if( zSql ){
  88894. do {
  88895. if( !*zCsr ){
  88896. /* Ran out of input before finding the table name. Return NULL. */
  88897. return;
  88898. }
  88899. /* Store the token that zCsr points to in tname. */
  88900. tname.z = (char*)zCsr;
  88901. tname.n = len;
  88902. /* Advance zCsr to the next token. Store that token type in 'token',
  88903. ** and its length in 'len' (to be used next iteration of this loop).
  88904. */
  88905. do {
  88906. zCsr += len;
  88907. len = sqlite3GetToken(zCsr, &token);
  88908. }while( token==TK_SPACE );
  88909. assert( len>0 );
  88910. /* Variable 'dist' stores the number of tokens read since the most
  88911. ** recent TK_DOT or TK_ON. This means that when a WHEN, FOR or BEGIN
  88912. ** token is read and 'dist' equals 2, the condition stated above
  88913. ** to be met.
  88914. **
  88915. ** Note that ON cannot be a database, table or column name, so
  88916. ** there is no need to worry about syntax like
  88917. ** "CREATE TRIGGER ... ON ON.ON BEGIN ..." etc.
  88918. */
  88919. dist++;
  88920. if( token==TK_DOT || token==TK_ON ){
  88921. dist = 0;
  88922. }
  88923. } while( dist!=2 || (token!=TK_WHEN && token!=TK_FOR && token!=TK_BEGIN) );
  88924. /* Variable tname now contains the token that is the old table-name
  88925. ** in the CREATE TRIGGER statement.
  88926. */
  88927. zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", (int)(((u8*)tname.z) - zSql),
  88928. zSql, zTableName, tname.z+tname.n);
  88929. sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
  88930. }
  88931. }
  88932. #endif /* !SQLITE_OMIT_TRIGGER */
  88933. /*
  88934. ** Register built-in functions used to help implement ALTER TABLE
  88935. */
  88936. SQLITE_PRIVATE void sqlite3AlterFunctions(void){
  88937. static FuncDef aAlterTableFuncs[] = {
  88938. FUNCTION(sqlite_rename_table, 2, 0, 0, renameTableFunc),
  88939. #ifndef SQLITE_OMIT_TRIGGER
  88940. FUNCTION(sqlite_rename_trigger, 2, 0, 0, renameTriggerFunc),
  88941. #endif
  88942. #ifndef SQLITE_OMIT_FOREIGN_KEY
  88943. FUNCTION(sqlite_rename_parent, 3, 0, 0, renameParentFunc),
  88944. #endif
  88945. };
  88946. sqlite3InsertBuiltinFuncs(aAlterTableFuncs, ArraySize(aAlterTableFuncs));
  88947. }
  88948. /*
  88949. ** This function is used to create the text of expressions of the form:
  88950. **
  88951. ** name=<constant1> OR name=<constant2> OR ...
  88952. **
  88953. ** If argument zWhere is NULL, then a pointer string containing the text
  88954. ** "name=<constant>" is returned, where <constant> is the quoted version
  88955. ** of the string passed as argument zConstant. The returned buffer is
  88956. ** allocated using sqlite3DbMalloc(). It is the responsibility of the
  88957. ** caller to ensure that it is eventually freed.
  88958. **
  88959. ** If argument zWhere is not NULL, then the string returned is
  88960. ** "<where> OR name=<constant>", where <where> is the contents of zWhere.
  88961. ** In this case zWhere is passed to sqlite3DbFree() before returning.
  88962. **
  88963. */
  88964. static char *whereOrName(sqlite3 *db, char *zWhere, char *zConstant){
  88965. char *zNew;
  88966. if( !zWhere ){
  88967. zNew = sqlite3MPrintf(db, "name=%Q", zConstant);
  88968. }else{
  88969. zNew = sqlite3MPrintf(db, "%s OR name=%Q", zWhere, zConstant);
  88970. sqlite3DbFree(db, zWhere);
  88971. }
  88972. return zNew;
  88973. }
  88974. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  88975. /*
  88976. ** Generate the text of a WHERE expression which can be used to select all
  88977. ** tables that have foreign key constraints that refer to table pTab (i.e.
  88978. ** constraints for which pTab is the parent table) from the sqlite_master
  88979. ** table.
  88980. */
  88981. static char *whereForeignKeys(Parse *pParse, Table *pTab){
  88982. FKey *p;
  88983. char *zWhere = 0;
  88984. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  88985. zWhere = whereOrName(pParse->db, zWhere, p->pFrom->zName);
  88986. }
  88987. return zWhere;
  88988. }
  88989. #endif
  88990. /*
  88991. ** Generate the text of a WHERE expression which can be used to select all
  88992. ** temporary triggers on table pTab from the sqlite_temp_master table. If
  88993. ** table pTab has no temporary triggers, or is itself stored in the
  88994. ** temporary database, NULL is returned.
  88995. */
  88996. static char *whereTempTriggers(Parse *pParse, Table *pTab){
  88997. Trigger *pTrig;
  88998. char *zWhere = 0;
  88999. const Schema *pTempSchema = pParse->db->aDb[1].pSchema; /* Temp db schema */
  89000. /* If the table is not located in the temp-db (in which case NULL is
  89001. ** returned, loop through the tables list of triggers. For each trigger
  89002. ** that is not part of the temp-db schema, add a clause to the WHERE
  89003. ** expression being built up in zWhere.
  89004. */
  89005. if( pTab->pSchema!=pTempSchema ){
  89006. sqlite3 *db = pParse->db;
  89007. for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
  89008. if( pTrig->pSchema==pTempSchema ){
  89009. zWhere = whereOrName(db, zWhere, pTrig->zName);
  89010. }
  89011. }
  89012. }
  89013. if( zWhere ){
  89014. char *zNew = sqlite3MPrintf(pParse->db, "type='trigger' AND (%s)", zWhere);
  89015. sqlite3DbFree(pParse->db, zWhere);
  89016. zWhere = zNew;
  89017. }
  89018. return zWhere;
  89019. }
  89020. /*
  89021. ** Generate code to drop and reload the internal representation of table
  89022. ** pTab from the database, including triggers and temporary triggers.
  89023. ** Argument zName is the name of the table in the database schema at
  89024. ** the time the generated code is executed. This can be different from
  89025. ** pTab->zName if this function is being called to code part of an
  89026. ** "ALTER TABLE RENAME TO" statement.
  89027. */
  89028. static void reloadTableSchema(Parse *pParse, Table *pTab, const char *zName){
  89029. Vdbe *v;
  89030. char *zWhere;
  89031. int iDb; /* Index of database containing pTab */
  89032. #ifndef SQLITE_OMIT_TRIGGER
  89033. Trigger *pTrig;
  89034. #endif
  89035. v = sqlite3GetVdbe(pParse);
  89036. if( NEVER(v==0) ) return;
  89037. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  89038. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  89039. assert( iDb>=0 );
  89040. #ifndef SQLITE_OMIT_TRIGGER
  89041. /* Drop any table triggers from the internal schema. */
  89042. for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
  89043. int iTrigDb = sqlite3SchemaToIndex(pParse->db, pTrig->pSchema);
  89044. assert( iTrigDb==iDb || iTrigDb==1 );
  89045. sqlite3VdbeAddOp4(v, OP_DropTrigger, iTrigDb, 0, 0, pTrig->zName, 0);
  89046. }
  89047. #endif
  89048. /* Drop the table and index from the internal schema. */
  89049. sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
  89050. /* Reload the table, index and permanent trigger schemas. */
  89051. zWhere = sqlite3MPrintf(pParse->db, "tbl_name=%Q", zName);
  89052. if( !zWhere ) return;
  89053. sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere);
  89054. #ifndef SQLITE_OMIT_TRIGGER
  89055. /* Now, if the table is not stored in the temp database, reload any temp
  89056. ** triggers. Don't use IN(...) in case SQLITE_OMIT_SUBQUERY is defined.
  89057. */
  89058. if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
  89059. sqlite3VdbeAddParseSchemaOp(v, 1, zWhere);
  89060. }
  89061. #endif
  89062. }
  89063. /*
  89064. ** Parameter zName is the name of a table that is about to be altered
  89065. ** (either with ALTER TABLE ... RENAME TO or ALTER TABLE ... ADD COLUMN).
  89066. ** If the table is a system table, this function leaves an error message
  89067. ** in pParse->zErr (system tables may not be altered) and returns non-zero.
  89068. **
  89069. ** Or, if zName is not a system table, zero is returned.
  89070. */
  89071. static int isSystemTable(Parse *pParse, const char *zName){
  89072. if( sqlite3Strlen30(zName)>6 && 0==sqlite3StrNICmp(zName, "sqlite_", 7) ){
  89073. sqlite3ErrorMsg(pParse, "table %s may not be altered", zName);
  89074. return 1;
  89075. }
  89076. return 0;
  89077. }
  89078. /*
  89079. ** Generate code to implement the "ALTER TABLE xxx RENAME TO yyy"
  89080. ** command.
  89081. */
  89082. SQLITE_PRIVATE void sqlite3AlterRenameTable(
  89083. Parse *pParse, /* Parser context. */
  89084. SrcList *pSrc, /* The table to rename. */
  89085. Token *pName /* The new table name. */
  89086. ){
  89087. int iDb; /* Database that contains the table */
  89088. char *zDb; /* Name of database iDb */
  89089. Table *pTab; /* Table being renamed */
  89090. char *zName = 0; /* NULL-terminated version of pName */
  89091. sqlite3 *db = pParse->db; /* Database connection */
  89092. int nTabName; /* Number of UTF-8 characters in zTabName */
  89093. const char *zTabName; /* Original name of the table */
  89094. Vdbe *v;
  89095. #ifndef SQLITE_OMIT_TRIGGER
  89096. char *zWhere = 0; /* Where clause to locate temp triggers */
  89097. #endif
  89098. VTable *pVTab = 0; /* Non-zero if this is a v-tab with an xRename() */
  89099. int savedDbFlags; /* Saved value of db->flags */
  89100. savedDbFlags = db->flags;
  89101. if( NEVER(db->mallocFailed) ) goto exit_rename_table;
  89102. assert( pSrc->nSrc==1 );
  89103. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  89104. pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
  89105. if( !pTab ) goto exit_rename_table;
  89106. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  89107. zDb = db->aDb[iDb].zDbSName;
  89108. db->flags |= SQLITE_PreferBuiltin;
  89109. /* Get a NULL terminated version of the new table name. */
  89110. zName = sqlite3NameFromToken(db, pName);
  89111. if( !zName ) goto exit_rename_table;
  89112. /* Check that a table or index named 'zName' does not already exist
  89113. ** in database iDb. If so, this is an error.
  89114. */
  89115. if( sqlite3FindTable(db, zName, zDb) || sqlite3FindIndex(db, zName, zDb) ){
  89116. sqlite3ErrorMsg(pParse,
  89117. "there is already another table or index with this name: %s", zName);
  89118. goto exit_rename_table;
  89119. }
  89120. /* Make sure it is not a system table being altered, or a reserved name
  89121. ** that the table is being renamed to.
  89122. */
  89123. if( SQLITE_OK!=isSystemTable(pParse, pTab->zName) ){
  89124. goto exit_rename_table;
  89125. }
  89126. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){ goto
  89127. exit_rename_table;
  89128. }
  89129. #ifndef SQLITE_OMIT_VIEW
  89130. if( pTab->pSelect ){
  89131. sqlite3ErrorMsg(pParse, "view %s may not be altered", pTab->zName);
  89132. goto exit_rename_table;
  89133. }
  89134. #endif
  89135. #ifndef SQLITE_OMIT_AUTHORIZATION
  89136. /* Invoke the authorization callback. */
  89137. if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
  89138. goto exit_rename_table;
  89139. }
  89140. #endif
  89141. #ifndef SQLITE_OMIT_VIRTUALTABLE
  89142. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  89143. goto exit_rename_table;
  89144. }
  89145. if( IsVirtual(pTab) ){
  89146. pVTab = sqlite3GetVTable(db, pTab);
  89147. if( pVTab->pVtab->pModule->xRename==0 ){
  89148. pVTab = 0;
  89149. }
  89150. }
  89151. #endif
  89152. /* Begin a transaction for database iDb.
  89153. ** Then modify the schema cookie (since the ALTER TABLE modifies the
  89154. ** schema). Open a statement transaction if the table is a virtual
  89155. ** table.
  89156. */
  89157. v = sqlite3GetVdbe(pParse);
  89158. if( v==0 ){
  89159. goto exit_rename_table;
  89160. }
  89161. sqlite3BeginWriteOperation(pParse, pVTab!=0, iDb);
  89162. sqlite3ChangeCookie(pParse, iDb);
  89163. /* If this is a virtual table, invoke the xRename() function if
  89164. ** one is defined. The xRename() callback will modify the names
  89165. ** of any resources used by the v-table implementation (including other
  89166. ** SQLite tables) that are identified by the name of the virtual table.
  89167. */
  89168. #ifndef SQLITE_OMIT_VIRTUALTABLE
  89169. if( pVTab ){
  89170. int i = ++pParse->nMem;
  89171. sqlite3VdbeLoadString(v, i, zName);
  89172. sqlite3VdbeAddOp4(v, OP_VRename, i, 0, 0,(const char*)pVTab, P4_VTAB);
  89173. sqlite3MayAbort(pParse);
  89174. }
  89175. #endif
  89176. /* figure out how many UTF-8 characters are in zName */
  89177. zTabName = pTab->zName;
  89178. nTabName = sqlite3Utf8CharLen(zTabName, -1);
  89179. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  89180. if( db->flags&SQLITE_ForeignKeys ){
  89181. /* If foreign-key support is enabled, rewrite the CREATE TABLE
  89182. ** statements corresponding to all child tables of foreign key constraints
  89183. ** for which the renamed table is the parent table. */
  89184. if( (zWhere=whereForeignKeys(pParse, pTab))!=0 ){
  89185. sqlite3NestedParse(pParse,
  89186. "UPDATE \"%w\".%s SET "
  89187. "sql = sqlite_rename_parent(sql, %Q, %Q) "
  89188. "WHERE %s;", zDb, SCHEMA_TABLE(iDb), zTabName, zName, zWhere);
  89189. sqlite3DbFree(db, zWhere);
  89190. }
  89191. }
  89192. #endif
  89193. /* Modify the sqlite_master table to use the new table name. */
  89194. sqlite3NestedParse(pParse,
  89195. "UPDATE %Q.%s SET "
  89196. #ifdef SQLITE_OMIT_TRIGGER
  89197. "sql = sqlite_rename_table(sql, %Q), "
  89198. #else
  89199. "sql = CASE "
  89200. "WHEN type = 'trigger' THEN sqlite_rename_trigger(sql, %Q)"
  89201. "ELSE sqlite_rename_table(sql, %Q) END, "
  89202. #endif
  89203. "tbl_name = %Q, "
  89204. "name = CASE "
  89205. "WHEN type='table' THEN %Q "
  89206. "WHEN name LIKE 'sqlite_autoindex%%' AND type='index' THEN "
  89207. "'sqlite_autoindex_' || %Q || substr(name,%d+18) "
  89208. "ELSE name END "
  89209. "WHERE tbl_name=%Q COLLATE nocase AND "
  89210. "(type='table' OR type='index' OR type='trigger');",
  89211. zDb, SCHEMA_TABLE(iDb), zName, zName, zName,
  89212. #ifndef SQLITE_OMIT_TRIGGER
  89213. zName,
  89214. #endif
  89215. zName, nTabName, zTabName
  89216. );
  89217. #ifndef SQLITE_OMIT_AUTOINCREMENT
  89218. /* If the sqlite_sequence table exists in this database, then update
  89219. ** it with the new table name.
  89220. */
  89221. if( sqlite3FindTable(db, "sqlite_sequence", zDb) ){
  89222. sqlite3NestedParse(pParse,
  89223. "UPDATE \"%w\".sqlite_sequence set name = %Q WHERE name = %Q",
  89224. zDb, zName, pTab->zName);
  89225. }
  89226. #endif
  89227. #ifndef SQLITE_OMIT_TRIGGER
  89228. /* If there are TEMP triggers on this table, modify the sqlite_temp_master
  89229. ** table. Don't do this if the table being ALTERed is itself located in
  89230. ** the temp database.
  89231. */
  89232. if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
  89233. sqlite3NestedParse(pParse,
  89234. "UPDATE sqlite_temp_master SET "
  89235. "sql = sqlite_rename_trigger(sql, %Q), "
  89236. "tbl_name = %Q "
  89237. "WHERE %s;", zName, zName, zWhere);
  89238. sqlite3DbFree(db, zWhere);
  89239. }
  89240. #endif
  89241. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  89242. if( db->flags&SQLITE_ForeignKeys ){
  89243. FKey *p;
  89244. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  89245. Table *pFrom = p->pFrom;
  89246. if( pFrom!=pTab ){
  89247. reloadTableSchema(pParse, p->pFrom, pFrom->zName);
  89248. }
  89249. }
  89250. }
  89251. #endif
  89252. /* Drop and reload the internal table schema. */
  89253. reloadTableSchema(pParse, pTab, zName);
  89254. exit_rename_table:
  89255. sqlite3SrcListDelete(db, pSrc);
  89256. sqlite3DbFree(db, zName);
  89257. db->flags = savedDbFlags;
  89258. }
  89259. /*
  89260. ** This function is called after an "ALTER TABLE ... ADD" statement
  89261. ** has been parsed. Argument pColDef contains the text of the new
  89262. ** column definition.
  89263. **
  89264. ** The Table structure pParse->pNewTable was extended to include
  89265. ** the new column during parsing.
  89266. */
  89267. SQLITE_PRIVATE void sqlite3AlterFinishAddColumn(Parse *pParse, Token *pColDef){
  89268. Table *pNew; /* Copy of pParse->pNewTable */
  89269. Table *pTab; /* Table being altered */
  89270. int iDb; /* Database number */
  89271. const char *zDb; /* Database name */
  89272. const char *zTab; /* Table name */
  89273. char *zCol; /* Null-terminated column definition */
  89274. Column *pCol; /* The new column */
  89275. Expr *pDflt; /* Default value for the new column */
  89276. sqlite3 *db; /* The database connection; */
  89277. Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
  89278. int r1; /* Temporary registers */
  89279. db = pParse->db;
  89280. if( pParse->nErr || db->mallocFailed ) return;
  89281. assert( v!=0 );
  89282. pNew = pParse->pNewTable;
  89283. assert( pNew );
  89284. assert( sqlite3BtreeHoldsAllMutexes(db) );
  89285. iDb = sqlite3SchemaToIndex(db, pNew->pSchema);
  89286. zDb = db->aDb[iDb].zDbSName;
  89287. zTab = &pNew->zName[16]; /* Skip the "sqlite_altertab_" prefix on the name */
  89288. pCol = &pNew->aCol[pNew->nCol-1];
  89289. pDflt = pCol->pDflt;
  89290. pTab = sqlite3FindTable(db, zTab, zDb);
  89291. assert( pTab );
  89292. #ifndef SQLITE_OMIT_AUTHORIZATION
  89293. /* Invoke the authorization callback. */
  89294. if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
  89295. return;
  89296. }
  89297. #endif
  89298. /* If the default value for the new column was specified with a
  89299. ** literal NULL, then set pDflt to 0. This simplifies checking
  89300. ** for an SQL NULL default below.
  89301. */
  89302. assert( pDflt==0 || pDflt->op==TK_SPAN );
  89303. if( pDflt && pDflt->pLeft->op==TK_NULL ){
  89304. pDflt = 0;
  89305. }
  89306. /* Check that the new column is not specified as PRIMARY KEY or UNIQUE.
  89307. ** If there is a NOT NULL constraint, then the default value for the
  89308. ** column must not be NULL.
  89309. */
  89310. if( pCol->colFlags & COLFLAG_PRIMKEY ){
  89311. sqlite3ErrorMsg(pParse, "Cannot add a PRIMARY KEY column");
  89312. return;
  89313. }
  89314. if( pNew->pIndex ){
  89315. sqlite3ErrorMsg(pParse, "Cannot add a UNIQUE column");
  89316. return;
  89317. }
  89318. if( (db->flags&SQLITE_ForeignKeys) && pNew->pFKey && pDflt ){
  89319. sqlite3ErrorMsg(pParse,
  89320. "Cannot add a REFERENCES column with non-NULL default value");
  89321. return;
  89322. }
  89323. if( pCol->notNull && !pDflt ){
  89324. sqlite3ErrorMsg(pParse,
  89325. "Cannot add a NOT NULL column with default value NULL");
  89326. return;
  89327. }
  89328. /* Ensure the default expression is something that sqlite3ValueFromExpr()
  89329. ** can handle (i.e. not CURRENT_TIME etc.)
  89330. */
  89331. if( pDflt ){
  89332. sqlite3_value *pVal = 0;
  89333. int rc;
  89334. rc = sqlite3ValueFromExpr(db, pDflt, SQLITE_UTF8, SQLITE_AFF_BLOB, &pVal);
  89335. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  89336. if( rc!=SQLITE_OK ){
  89337. assert( db->mallocFailed == 1 );
  89338. return;
  89339. }
  89340. if( !pVal ){
  89341. sqlite3ErrorMsg(pParse, "Cannot add a column with non-constant default");
  89342. return;
  89343. }
  89344. sqlite3ValueFree(pVal);
  89345. }
  89346. /* Modify the CREATE TABLE statement. */
  89347. zCol = sqlite3DbStrNDup(db, (char*)pColDef->z, pColDef->n);
  89348. if( zCol ){
  89349. char *zEnd = &zCol[pColDef->n-1];
  89350. int savedDbFlags = db->flags;
  89351. while( zEnd>zCol && (*zEnd==';' || sqlite3Isspace(*zEnd)) ){
  89352. *zEnd-- = '\0';
  89353. }
  89354. db->flags |= SQLITE_PreferBuiltin;
  89355. sqlite3NestedParse(pParse,
  89356. "UPDATE \"%w\".%s SET "
  89357. "sql = substr(sql,1,%d) || ', ' || %Q || substr(sql,%d) "
  89358. "WHERE type = 'table' AND name = %Q",
  89359. zDb, SCHEMA_TABLE(iDb), pNew->addColOffset, zCol, pNew->addColOffset+1,
  89360. zTab
  89361. );
  89362. sqlite3DbFree(db, zCol);
  89363. db->flags = savedDbFlags;
  89364. }
  89365. /* Make sure the schema version is at least 3. But do not upgrade
  89366. ** from less than 3 to 4, as that will corrupt any preexisting DESC
  89367. ** index.
  89368. */
  89369. r1 = sqlite3GetTempReg(pParse);
  89370. sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, r1, BTREE_FILE_FORMAT);
  89371. sqlite3VdbeUsesBtree(v, iDb);
  89372. sqlite3VdbeAddOp2(v, OP_AddImm, r1, -2);
  89373. sqlite3VdbeAddOp2(v, OP_IfPos, r1, sqlite3VdbeCurrentAddr(v)+2);
  89374. VdbeCoverage(v);
  89375. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, 3);
  89376. sqlite3ReleaseTempReg(pParse, r1);
  89377. /* Reload the schema of the modified table. */
  89378. reloadTableSchema(pParse, pTab, pTab->zName);
  89379. }
  89380. /*
  89381. ** This function is called by the parser after the table-name in
  89382. ** an "ALTER TABLE <table-name> ADD" statement is parsed. Argument
  89383. ** pSrc is the full-name of the table being altered.
  89384. **
  89385. ** This routine makes a (partial) copy of the Table structure
  89386. ** for the table being altered and sets Parse.pNewTable to point
  89387. ** to it. Routines called by the parser as the column definition
  89388. ** is parsed (i.e. sqlite3AddColumn()) add the new Column data to
  89389. ** the copy. The copy of the Table structure is deleted by tokenize.c
  89390. ** after parsing is finished.
  89391. **
  89392. ** Routine sqlite3AlterFinishAddColumn() will be called to complete
  89393. ** coding the "ALTER TABLE ... ADD" statement.
  89394. */
  89395. SQLITE_PRIVATE void sqlite3AlterBeginAddColumn(Parse *pParse, SrcList *pSrc){
  89396. Table *pNew;
  89397. Table *pTab;
  89398. Vdbe *v;
  89399. int iDb;
  89400. int i;
  89401. int nAlloc;
  89402. sqlite3 *db = pParse->db;
  89403. /* Look up the table being altered. */
  89404. assert( pParse->pNewTable==0 );
  89405. assert( sqlite3BtreeHoldsAllMutexes(db) );
  89406. if( db->mallocFailed ) goto exit_begin_add_column;
  89407. pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
  89408. if( !pTab ) goto exit_begin_add_column;
  89409. #ifndef SQLITE_OMIT_VIRTUALTABLE
  89410. if( IsVirtual(pTab) ){
  89411. sqlite3ErrorMsg(pParse, "virtual tables may not be altered");
  89412. goto exit_begin_add_column;
  89413. }
  89414. #endif
  89415. /* Make sure this is not an attempt to ALTER a view. */
  89416. if( pTab->pSelect ){
  89417. sqlite3ErrorMsg(pParse, "Cannot add a column to a view");
  89418. goto exit_begin_add_column;
  89419. }
  89420. if( SQLITE_OK!=isSystemTable(pParse, pTab->zName) ){
  89421. goto exit_begin_add_column;
  89422. }
  89423. assert( pTab->addColOffset>0 );
  89424. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  89425. /* Put a copy of the Table struct in Parse.pNewTable for the
  89426. ** sqlite3AddColumn() function and friends to modify. But modify
  89427. ** the name by adding an "sqlite_altertab_" prefix. By adding this
  89428. ** prefix, we insure that the name will not collide with an existing
  89429. ** table because user table are not allowed to have the "sqlite_"
  89430. ** prefix on their name.
  89431. */
  89432. pNew = (Table*)sqlite3DbMallocZero(db, sizeof(Table));
  89433. if( !pNew ) goto exit_begin_add_column;
  89434. pParse->pNewTable = pNew;
  89435. pNew->nRef = 1;
  89436. pNew->nCol = pTab->nCol;
  89437. assert( pNew->nCol>0 );
  89438. nAlloc = (((pNew->nCol-1)/8)*8)+8;
  89439. assert( nAlloc>=pNew->nCol && nAlloc%8==0 && nAlloc-pNew->nCol<8 );
  89440. pNew->aCol = (Column*)sqlite3DbMallocZero(db, sizeof(Column)*nAlloc);
  89441. pNew->zName = sqlite3MPrintf(db, "sqlite_altertab_%s", pTab->zName);
  89442. if( !pNew->aCol || !pNew->zName ){
  89443. assert( db->mallocFailed );
  89444. goto exit_begin_add_column;
  89445. }
  89446. memcpy(pNew->aCol, pTab->aCol, sizeof(Column)*pNew->nCol);
  89447. for(i=0; i<pNew->nCol; i++){
  89448. Column *pCol = &pNew->aCol[i];
  89449. pCol->zName = sqlite3DbStrDup(db, pCol->zName);
  89450. pCol->zColl = 0;
  89451. pCol->pDflt = 0;
  89452. }
  89453. pNew->pSchema = db->aDb[iDb].pSchema;
  89454. pNew->addColOffset = pTab->addColOffset;
  89455. pNew->nRef = 1;
  89456. /* Begin a transaction and increment the schema cookie. */
  89457. sqlite3BeginWriteOperation(pParse, 0, iDb);
  89458. v = sqlite3GetVdbe(pParse);
  89459. if( !v ) goto exit_begin_add_column;
  89460. sqlite3ChangeCookie(pParse, iDb);
  89461. exit_begin_add_column:
  89462. sqlite3SrcListDelete(db, pSrc);
  89463. return;
  89464. }
  89465. #endif /* SQLITE_ALTER_TABLE */
  89466. /************** End of alter.c ***********************************************/
  89467. /************** Begin file analyze.c *****************************************/
  89468. /*
  89469. ** 2005-07-08
  89470. **
  89471. ** The author disclaims copyright to this source code. In place of
  89472. ** a legal notice, here is a blessing:
  89473. **
  89474. ** May you do good and not evil.
  89475. ** May you find forgiveness for yourself and forgive others.
  89476. ** May you share freely, never taking more than you give.
  89477. **
  89478. *************************************************************************
  89479. ** This file contains code associated with the ANALYZE command.
  89480. **
  89481. ** The ANALYZE command gather statistics about the content of tables
  89482. ** and indices. These statistics are made available to the query planner
  89483. ** to help it make better decisions about how to perform queries.
  89484. **
  89485. ** The following system tables are or have been supported:
  89486. **
  89487. ** CREATE TABLE sqlite_stat1(tbl, idx, stat);
  89488. ** CREATE TABLE sqlite_stat2(tbl, idx, sampleno, sample);
  89489. ** CREATE TABLE sqlite_stat3(tbl, idx, nEq, nLt, nDLt, sample);
  89490. ** CREATE TABLE sqlite_stat4(tbl, idx, nEq, nLt, nDLt, sample);
  89491. **
  89492. ** Additional tables might be added in future releases of SQLite.
  89493. ** The sqlite_stat2 table is not created or used unless the SQLite version
  89494. ** is between 3.6.18 and 3.7.8, inclusive, and unless SQLite is compiled
  89495. ** with SQLITE_ENABLE_STAT2. The sqlite_stat2 table is deprecated.
  89496. ** The sqlite_stat2 table is superseded by sqlite_stat3, which is only
  89497. ** created and used by SQLite versions 3.7.9 and later and with
  89498. ** SQLITE_ENABLE_STAT3 defined. The functionality of sqlite_stat3
  89499. ** is a superset of sqlite_stat2. The sqlite_stat4 is an enhanced
  89500. ** version of sqlite_stat3 and is only available when compiled with
  89501. ** SQLITE_ENABLE_STAT4 and in SQLite versions 3.8.1 and later. It is
  89502. ** not possible to enable both STAT3 and STAT4 at the same time. If they
  89503. ** are both enabled, then STAT4 takes precedence.
  89504. **
  89505. ** For most applications, sqlite_stat1 provides all the statistics required
  89506. ** for the query planner to make good choices.
  89507. **
  89508. ** Format of sqlite_stat1:
  89509. **
  89510. ** There is normally one row per index, with the index identified by the
  89511. ** name in the idx column. The tbl column is the name of the table to
  89512. ** which the index belongs. In each such row, the stat column will be
  89513. ** a string consisting of a list of integers. The first integer in this
  89514. ** list is the number of rows in the index. (This is the same as the
  89515. ** number of rows in the table, except for partial indices.) The second
  89516. ** integer is the average number of rows in the index that have the same
  89517. ** value in the first column of the index. The third integer is the average
  89518. ** number of rows in the index that have the same value for the first two
  89519. ** columns. The N-th integer (for N>1) is the average number of rows in
  89520. ** the index which have the same value for the first N-1 columns. For
  89521. ** a K-column index, there will be K+1 integers in the stat column. If
  89522. ** the index is unique, then the last integer will be 1.
  89523. **
  89524. ** The list of integers in the stat column can optionally be followed
  89525. ** by the keyword "unordered". The "unordered" keyword, if it is present,
  89526. ** must be separated from the last integer by a single space. If the
  89527. ** "unordered" keyword is present, then the query planner assumes that
  89528. ** the index is unordered and will not use the index for a range query.
  89529. **
  89530. ** If the sqlite_stat1.idx column is NULL, then the sqlite_stat1.stat
  89531. ** column contains a single integer which is the (estimated) number of
  89532. ** rows in the table identified by sqlite_stat1.tbl.
  89533. **
  89534. ** Format of sqlite_stat2:
  89535. **
  89536. ** The sqlite_stat2 is only created and is only used if SQLite is compiled
  89537. ** with SQLITE_ENABLE_STAT2 and if the SQLite version number is between
  89538. ** 3.6.18 and 3.7.8. The "stat2" table contains additional information
  89539. ** about the distribution of keys within an index. The index is identified by
  89540. ** the "idx" column and the "tbl" column is the name of the table to which
  89541. ** the index belongs. There are usually 10 rows in the sqlite_stat2
  89542. ** table for each index.
  89543. **
  89544. ** The sqlite_stat2 entries for an index that have sampleno between 0 and 9
  89545. ** inclusive are samples of the left-most key value in the index taken at
  89546. ** evenly spaced points along the index. Let the number of samples be S
  89547. ** (10 in the standard build) and let C be the number of rows in the index.
  89548. ** Then the sampled rows are given by:
  89549. **
  89550. ** rownumber = (i*C*2 + C)/(S*2)
  89551. **
  89552. ** For i between 0 and S-1. Conceptually, the index space is divided into
  89553. ** S uniform buckets and the samples are the middle row from each bucket.
  89554. **
  89555. ** The format for sqlite_stat2 is recorded here for legacy reference. This
  89556. ** version of SQLite does not support sqlite_stat2. It neither reads nor
  89557. ** writes the sqlite_stat2 table. This version of SQLite only supports
  89558. ** sqlite_stat3.
  89559. **
  89560. ** Format for sqlite_stat3:
  89561. **
  89562. ** The sqlite_stat3 format is a subset of sqlite_stat4. Hence, the
  89563. ** sqlite_stat4 format will be described first. Further information
  89564. ** about sqlite_stat3 follows the sqlite_stat4 description.
  89565. **
  89566. ** Format for sqlite_stat4:
  89567. **
  89568. ** As with sqlite_stat2, the sqlite_stat4 table contains histogram data
  89569. ** to aid the query planner in choosing good indices based on the values
  89570. ** that indexed columns are compared against in the WHERE clauses of
  89571. ** queries.
  89572. **
  89573. ** The sqlite_stat4 table contains multiple entries for each index.
  89574. ** The idx column names the index and the tbl column is the table of the
  89575. ** index. If the idx and tbl columns are the same, then the sample is
  89576. ** of the INTEGER PRIMARY KEY. The sample column is a blob which is the
  89577. ** binary encoding of a key from the index. The nEq column is a
  89578. ** list of integers. The first integer is the approximate number
  89579. ** of entries in the index whose left-most column exactly matches
  89580. ** the left-most column of the sample. The second integer in nEq
  89581. ** is the approximate number of entries in the index where the
  89582. ** first two columns match the first two columns of the sample.
  89583. ** And so forth. nLt is another list of integers that show the approximate
  89584. ** number of entries that are strictly less than the sample. The first
  89585. ** integer in nLt contains the number of entries in the index where the
  89586. ** left-most column is less than the left-most column of the sample.
  89587. ** The K-th integer in the nLt entry is the number of index entries
  89588. ** where the first K columns are less than the first K columns of the
  89589. ** sample. The nDLt column is like nLt except that it contains the
  89590. ** number of distinct entries in the index that are less than the
  89591. ** sample.
  89592. **
  89593. ** There can be an arbitrary number of sqlite_stat4 entries per index.
  89594. ** The ANALYZE command will typically generate sqlite_stat4 tables
  89595. ** that contain between 10 and 40 samples which are distributed across
  89596. ** the key space, though not uniformly, and which include samples with
  89597. ** large nEq values.
  89598. **
  89599. ** Format for sqlite_stat3 redux:
  89600. **
  89601. ** The sqlite_stat3 table is like sqlite_stat4 except that it only
  89602. ** looks at the left-most column of the index. The sqlite_stat3.sample
  89603. ** column contains the actual value of the left-most column instead
  89604. ** of a blob encoding of the complete index key as is found in
  89605. ** sqlite_stat4.sample. The nEq, nLt, and nDLt entries of sqlite_stat3
  89606. ** all contain just a single integer which is the same as the first
  89607. ** integer in the equivalent columns in sqlite_stat4.
  89608. */
  89609. #ifndef SQLITE_OMIT_ANALYZE
  89610. /* #include "sqliteInt.h" */
  89611. #if defined(SQLITE_ENABLE_STAT4)
  89612. # define IsStat4 1
  89613. # define IsStat3 0
  89614. #elif defined(SQLITE_ENABLE_STAT3)
  89615. # define IsStat4 0
  89616. # define IsStat3 1
  89617. #else
  89618. # define IsStat4 0
  89619. # define IsStat3 0
  89620. # undef SQLITE_STAT4_SAMPLES
  89621. # define SQLITE_STAT4_SAMPLES 1
  89622. #endif
  89623. #define IsStat34 (IsStat3+IsStat4) /* 1 for STAT3 or STAT4. 0 otherwise */
  89624. /*
  89625. ** This routine generates code that opens the sqlite_statN tables.
  89626. ** The sqlite_stat1 table is always relevant. sqlite_stat2 is now
  89627. ** obsolete. sqlite_stat3 and sqlite_stat4 are only opened when
  89628. ** appropriate compile-time options are provided.
  89629. **
  89630. ** If the sqlite_statN tables do not previously exist, it is created.
  89631. **
  89632. ** Argument zWhere may be a pointer to a buffer containing a table name,
  89633. ** or it may be a NULL pointer. If it is not NULL, then all entries in
  89634. ** the sqlite_statN tables associated with the named table are deleted.
  89635. ** If zWhere==0, then code is generated to delete all stat table entries.
  89636. */
  89637. static void openStatTable(
  89638. Parse *pParse, /* Parsing context */
  89639. int iDb, /* The database we are looking in */
  89640. int iStatCur, /* Open the sqlite_stat1 table on this cursor */
  89641. const char *zWhere, /* Delete entries for this table or index */
  89642. const char *zWhereType /* Either "tbl" or "idx" */
  89643. ){
  89644. static const struct {
  89645. const char *zName;
  89646. const char *zCols;
  89647. } aTable[] = {
  89648. { "sqlite_stat1", "tbl,idx,stat" },
  89649. #if defined(SQLITE_ENABLE_STAT4)
  89650. { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
  89651. { "sqlite_stat3", 0 },
  89652. #elif defined(SQLITE_ENABLE_STAT3)
  89653. { "sqlite_stat3", "tbl,idx,neq,nlt,ndlt,sample" },
  89654. { "sqlite_stat4", 0 },
  89655. #else
  89656. { "sqlite_stat3", 0 },
  89657. { "sqlite_stat4", 0 },
  89658. #endif
  89659. };
  89660. int i;
  89661. sqlite3 *db = pParse->db;
  89662. Db *pDb;
  89663. Vdbe *v = sqlite3GetVdbe(pParse);
  89664. int aRoot[ArraySize(aTable)];
  89665. u8 aCreateTbl[ArraySize(aTable)];
  89666. if( v==0 ) return;
  89667. assert( sqlite3BtreeHoldsAllMutexes(db) );
  89668. assert( sqlite3VdbeDb(v)==db );
  89669. pDb = &db->aDb[iDb];
  89670. /* Create new statistic tables if they do not exist, or clear them
  89671. ** if they do already exist.
  89672. */
  89673. for(i=0; i<ArraySize(aTable); i++){
  89674. const char *zTab = aTable[i].zName;
  89675. Table *pStat;
  89676. if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==0 ){
  89677. if( aTable[i].zCols ){
  89678. /* The sqlite_statN table does not exist. Create it. Note that a
  89679. ** side-effect of the CREATE TABLE statement is to leave the rootpage
  89680. ** of the new table in register pParse->regRoot. This is important
  89681. ** because the OpenWrite opcode below will be needing it. */
  89682. sqlite3NestedParse(pParse,
  89683. "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
  89684. );
  89685. aRoot[i] = pParse->regRoot;
  89686. aCreateTbl[i] = OPFLAG_P2ISREG;
  89687. }
  89688. }else{
  89689. /* The table already exists. If zWhere is not NULL, delete all entries
  89690. ** associated with the table zWhere. If zWhere is NULL, delete the
  89691. ** entire contents of the table. */
  89692. aRoot[i] = pStat->tnum;
  89693. aCreateTbl[i] = 0;
  89694. sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
  89695. if( zWhere ){
  89696. sqlite3NestedParse(pParse,
  89697. "DELETE FROM %Q.%s WHERE %s=%Q",
  89698. pDb->zDbSName, zTab, zWhereType, zWhere
  89699. );
  89700. }else{
  89701. /* The sqlite_stat[134] table already exists. Delete all rows. */
  89702. sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
  89703. }
  89704. }
  89705. }
  89706. /* Open the sqlite_stat[134] tables for writing. */
  89707. for(i=0; aTable[i].zCols; i++){
  89708. assert( i<ArraySize(aTable) );
  89709. sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
  89710. sqlite3VdbeChangeP5(v, aCreateTbl[i]);
  89711. VdbeComment((v, aTable[i].zName));
  89712. }
  89713. }
  89714. /*
  89715. ** Recommended number of samples for sqlite_stat4
  89716. */
  89717. #ifndef SQLITE_STAT4_SAMPLES
  89718. # define SQLITE_STAT4_SAMPLES 24
  89719. #endif
  89720. /*
  89721. ** Three SQL functions - stat_init(), stat_push(), and stat_get() -
  89722. ** share an instance of the following structure to hold their state
  89723. ** information.
  89724. */
  89725. typedef struct Stat4Accum Stat4Accum;
  89726. typedef struct Stat4Sample Stat4Sample;
  89727. struct Stat4Sample {
  89728. tRowcnt *anEq; /* sqlite_stat4.nEq */
  89729. tRowcnt *anDLt; /* sqlite_stat4.nDLt */
  89730. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89731. tRowcnt *anLt; /* sqlite_stat4.nLt */
  89732. union {
  89733. i64 iRowid; /* Rowid in main table of the key */
  89734. u8 *aRowid; /* Key for WITHOUT ROWID tables */
  89735. } u;
  89736. u32 nRowid; /* Sizeof aRowid[] */
  89737. u8 isPSample; /* True if a periodic sample */
  89738. int iCol; /* If !isPSample, the reason for inclusion */
  89739. u32 iHash; /* Tiebreaker hash */
  89740. #endif
  89741. };
  89742. struct Stat4Accum {
  89743. tRowcnt nRow; /* Number of rows in the entire table */
  89744. tRowcnt nPSample; /* How often to do a periodic sample */
  89745. int nCol; /* Number of columns in index + pk/rowid */
  89746. int nKeyCol; /* Number of index columns w/o the pk/rowid */
  89747. int mxSample; /* Maximum number of samples to accumulate */
  89748. Stat4Sample current; /* Current row as a Stat4Sample */
  89749. u32 iPrn; /* Pseudo-random number used for sampling */
  89750. Stat4Sample *aBest; /* Array of nCol best samples */
  89751. int iMin; /* Index in a[] of entry with minimum score */
  89752. int nSample; /* Current number of samples */
  89753. int iGet; /* Index of current sample accessed by stat_get() */
  89754. Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
  89755. sqlite3 *db; /* Database connection, for malloc() */
  89756. };
  89757. /* Reclaim memory used by a Stat4Sample
  89758. */
  89759. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89760. static void sampleClear(sqlite3 *db, Stat4Sample *p){
  89761. assert( db!=0 );
  89762. if( p->nRowid ){
  89763. sqlite3DbFree(db, p->u.aRowid);
  89764. p->nRowid = 0;
  89765. }
  89766. }
  89767. #endif
  89768. /* Initialize the BLOB value of a ROWID
  89769. */
  89770. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89771. static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
  89772. assert( db!=0 );
  89773. if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
  89774. p->u.aRowid = sqlite3DbMallocRawNN(db, n);
  89775. if( p->u.aRowid ){
  89776. p->nRowid = n;
  89777. memcpy(p->u.aRowid, pData, n);
  89778. }else{
  89779. p->nRowid = 0;
  89780. }
  89781. }
  89782. #endif
  89783. /* Initialize the INTEGER value of a ROWID.
  89784. */
  89785. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89786. static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
  89787. assert( db!=0 );
  89788. if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
  89789. p->nRowid = 0;
  89790. p->u.iRowid = iRowid;
  89791. }
  89792. #endif
  89793. /*
  89794. ** Copy the contents of object (*pFrom) into (*pTo).
  89795. */
  89796. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89797. static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
  89798. pTo->isPSample = pFrom->isPSample;
  89799. pTo->iCol = pFrom->iCol;
  89800. pTo->iHash = pFrom->iHash;
  89801. memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
  89802. memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
  89803. memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
  89804. if( pFrom->nRowid ){
  89805. sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
  89806. }else{
  89807. sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
  89808. }
  89809. }
  89810. #endif
  89811. /*
  89812. ** Reclaim all memory of a Stat4Accum structure.
  89813. */
  89814. static void stat4Destructor(void *pOld){
  89815. Stat4Accum *p = (Stat4Accum*)pOld;
  89816. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89817. int i;
  89818. for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
  89819. for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
  89820. sampleClear(p->db, &p->current);
  89821. #endif
  89822. sqlite3DbFree(p->db, p);
  89823. }
  89824. /*
  89825. ** Implementation of the stat_init(N,K,C) SQL function. The three parameters
  89826. ** are:
  89827. ** N: The number of columns in the index including the rowid/pk (note 1)
  89828. ** K: The number of columns in the index excluding the rowid/pk.
  89829. ** C: The number of rows in the index (note 2)
  89830. **
  89831. ** Note 1: In the special case of the covering index that implements a
  89832. ** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
  89833. ** total number of columns in the table.
  89834. **
  89835. ** Note 2: C is only used for STAT3 and STAT4.
  89836. **
  89837. ** For indexes on ordinary rowid tables, N==K+1. But for indexes on
  89838. ** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
  89839. ** PRIMARY KEY of the table. The covering index that implements the
  89840. ** original WITHOUT ROWID table as N==K as a special case.
  89841. **
  89842. ** This routine allocates the Stat4Accum object in heap memory. The return
  89843. ** value is a pointer to the Stat4Accum object. The datatype of the
  89844. ** return value is BLOB, but it is really just a pointer to the Stat4Accum
  89845. ** object.
  89846. */
  89847. static void statInit(
  89848. sqlite3_context *context,
  89849. int argc,
  89850. sqlite3_value **argv
  89851. ){
  89852. Stat4Accum *p;
  89853. int nCol; /* Number of columns in index being sampled */
  89854. int nKeyCol; /* Number of key columns */
  89855. int nColUp; /* nCol rounded up for alignment */
  89856. int n; /* Bytes of space to allocate */
  89857. sqlite3 *db; /* Database connection */
  89858. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89859. int mxSample = SQLITE_STAT4_SAMPLES;
  89860. #endif
  89861. /* Decode the three function arguments */
  89862. UNUSED_PARAMETER(argc);
  89863. nCol = sqlite3_value_int(argv[0]);
  89864. assert( nCol>0 );
  89865. nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
  89866. nKeyCol = sqlite3_value_int(argv[1]);
  89867. assert( nKeyCol<=nCol );
  89868. assert( nKeyCol>0 );
  89869. /* Allocate the space required for the Stat4Accum object */
  89870. n = sizeof(*p)
  89871. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
  89872. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
  89873. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89874. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
  89875. + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
  89876. + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
  89877. #endif
  89878. ;
  89879. db = sqlite3_context_db_handle(context);
  89880. p = sqlite3DbMallocZero(db, n);
  89881. if( p==0 ){
  89882. sqlite3_result_error_nomem(context);
  89883. return;
  89884. }
  89885. p->db = db;
  89886. p->nRow = 0;
  89887. p->nCol = nCol;
  89888. p->nKeyCol = nKeyCol;
  89889. p->current.anDLt = (tRowcnt*)&p[1];
  89890. p->current.anEq = &p->current.anDLt[nColUp];
  89891. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89892. {
  89893. u8 *pSpace; /* Allocated space not yet assigned */
  89894. int i; /* Used to iterate through p->aSample[] */
  89895. p->iGet = -1;
  89896. p->mxSample = mxSample;
  89897. p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
  89898. p->current.anLt = &p->current.anEq[nColUp];
  89899. p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
  89900. /* Set up the Stat4Accum.a[] and aBest[] arrays */
  89901. p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
  89902. p->aBest = &p->a[mxSample];
  89903. pSpace = (u8*)(&p->a[mxSample+nCol]);
  89904. for(i=0; i<(mxSample+nCol); i++){
  89905. p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  89906. p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  89907. p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  89908. }
  89909. assert( (pSpace - (u8*)p)==n );
  89910. for(i=0; i<nCol; i++){
  89911. p->aBest[i].iCol = i;
  89912. }
  89913. }
  89914. #endif
  89915. /* Return a pointer to the allocated object to the caller. Note that
  89916. ** only the pointer (the 2nd parameter) matters. The size of the object
  89917. ** (given by the 3rd parameter) is never used and can be any positive
  89918. ** value. */
  89919. sqlite3_result_blob(context, p, sizeof(*p), stat4Destructor);
  89920. }
  89921. static const FuncDef statInitFuncdef = {
  89922. 2+IsStat34, /* nArg */
  89923. SQLITE_UTF8, /* funcFlags */
  89924. 0, /* pUserData */
  89925. 0, /* pNext */
  89926. statInit, /* xSFunc */
  89927. 0, /* xFinalize */
  89928. "stat_init", /* zName */
  89929. {0}
  89930. };
  89931. #ifdef SQLITE_ENABLE_STAT4
  89932. /*
  89933. ** pNew and pOld are both candidate non-periodic samples selected for
  89934. ** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
  89935. ** considering only any trailing columns and the sample hash value, this
  89936. ** function returns true if sample pNew is to be preferred over pOld.
  89937. ** In other words, if we assume that the cardinalities of the selected
  89938. ** column for pNew and pOld are equal, is pNew to be preferred over pOld.
  89939. **
  89940. ** This function assumes that for each argument sample, the contents of
  89941. ** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
  89942. */
  89943. static int sampleIsBetterPost(
  89944. Stat4Accum *pAccum,
  89945. Stat4Sample *pNew,
  89946. Stat4Sample *pOld
  89947. ){
  89948. int nCol = pAccum->nCol;
  89949. int i;
  89950. assert( pNew->iCol==pOld->iCol );
  89951. for(i=pNew->iCol+1; i<nCol; i++){
  89952. if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
  89953. if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
  89954. }
  89955. if( pNew->iHash>pOld->iHash ) return 1;
  89956. return 0;
  89957. }
  89958. #endif
  89959. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  89960. /*
  89961. ** Return true if pNew is to be preferred over pOld.
  89962. **
  89963. ** This function assumes that for each argument sample, the contents of
  89964. ** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
  89965. */
  89966. static int sampleIsBetter(
  89967. Stat4Accum *pAccum,
  89968. Stat4Sample *pNew,
  89969. Stat4Sample *pOld
  89970. ){
  89971. tRowcnt nEqNew = pNew->anEq[pNew->iCol];
  89972. tRowcnt nEqOld = pOld->anEq[pOld->iCol];
  89973. assert( pOld->isPSample==0 && pNew->isPSample==0 );
  89974. assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
  89975. if( (nEqNew>nEqOld) ) return 1;
  89976. #ifdef SQLITE_ENABLE_STAT4
  89977. if( nEqNew==nEqOld ){
  89978. if( pNew->iCol<pOld->iCol ) return 1;
  89979. return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
  89980. }
  89981. return 0;
  89982. #else
  89983. return (nEqNew==nEqOld && pNew->iHash>pOld->iHash);
  89984. #endif
  89985. }
  89986. /*
  89987. ** Copy the contents of sample *pNew into the p->a[] array. If necessary,
  89988. ** remove the least desirable sample from p->a[] to make room.
  89989. */
  89990. static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
  89991. Stat4Sample *pSample = 0;
  89992. int i;
  89993. assert( IsStat4 || nEqZero==0 );
  89994. #ifdef SQLITE_ENABLE_STAT4
  89995. if( pNew->isPSample==0 ){
  89996. Stat4Sample *pUpgrade = 0;
  89997. assert( pNew->anEq[pNew->iCol]>0 );
  89998. /* This sample is being added because the prefix that ends in column
  89999. ** iCol occurs many times in the table. However, if we have already
  90000. ** added a sample that shares this prefix, there is no need to add
  90001. ** this one. Instead, upgrade the priority of the highest priority
  90002. ** existing sample that shares this prefix. */
  90003. for(i=p->nSample-1; i>=0; i--){
  90004. Stat4Sample *pOld = &p->a[i];
  90005. if( pOld->anEq[pNew->iCol]==0 ){
  90006. if( pOld->isPSample ) return;
  90007. assert( pOld->iCol>pNew->iCol );
  90008. assert( sampleIsBetter(p, pNew, pOld) );
  90009. if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
  90010. pUpgrade = pOld;
  90011. }
  90012. }
  90013. }
  90014. if( pUpgrade ){
  90015. pUpgrade->iCol = pNew->iCol;
  90016. pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
  90017. goto find_new_min;
  90018. }
  90019. }
  90020. #endif
  90021. /* If necessary, remove sample iMin to make room for the new sample. */
  90022. if( p->nSample>=p->mxSample ){
  90023. Stat4Sample *pMin = &p->a[p->iMin];
  90024. tRowcnt *anEq = pMin->anEq;
  90025. tRowcnt *anLt = pMin->anLt;
  90026. tRowcnt *anDLt = pMin->anDLt;
  90027. sampleClear(p->db, pMin);
  90028. memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
  90029. pSample = &p->a[p->nSample-1];
  90030. pSample->nRowid = 0;
  90031. pSample->anEq = anEq;
  90032. pSample->anDLt = anDLt;
  90033. pSample->anLt = anLt;
  90034. p->nSample = p->mxSample-1;
  90035. }
  90036. /* The "rows less-than" for the rowid column must be greater than that
  90037. ** for the last sample in the p->a[] array. Otherwise, the samples would
  90038. ** be out of order. */
  90039. #ifdef SQLITE_ENABLE_STAT4
  90040. assert( p->nSample==0
  90041. || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
  90042. #endif
  90043. /* Insert the new sample */
  90044. pSample = &p->a[p->nSample];
  90045. sampleCopy(p, pSample, pNew);
  90046. p->nSample++;
  90047. /* Zero the first nEqZero entries in the anEq[] array. */
  90048. memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
  90049. #ifdef SQLITE_ENABLE_STAT4
  90050. find_new_min:
  90051. #endif
  90052. if( p->nSample>=p->mxSample ){
  90053. int iMin = -1;
  90054. for(i=0; i<p->mxSample; i++){
  90055. if( p->a[i].isPSample ) continue;
  90056. if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
  90057. iMin = i;
  90058. }
  90059. }
  90060. assert( iMin>=0 );
  90061. p->iMin = iMin;
  90062. }
  90063. }
  90064. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  90065. /*
  90066. ** Field iChng of the index being scanned has changed. So at this point
  90067. ** p->current contains a sample that reflects the previous row of the
  90068. ** index. The value of anEq[iChng] and subsequent anEq[] elements are
  90069. ** correct at this point.
  90070. */
  90071. static void samplePushPrevious(Stat4Accum *p, int iChng){
  90072. #ifdef SQLITE_ENABLE_STAT4
  90073. int i;
  90074. /* Check if any samples from the aBest[] array should be pushed
  90075. ** into IndexSample.a[] at this point. */
  90076. for(i=(p->nCol-2); i>=iChng; i--){
  90077. Stat4Sample *pBest = &p->aBest[i];
  90078. pBest->anEq[i] = p->current.anEq[i];
  90079. if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
  90080. sampleInsert(p, pBest, i);
  90081. }
  90082. }
  90083. /* Update the anEq[] fields of any samples already collected. */
  90084. for(i=p->nSample-1; i>=0; i--){
  90085. int j;
  90086. for(j=iChng; j<p->nCol; j++){
  90087. if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
  90088. }
  90089. }
  90090. #endif
  90091. #if defined(SQLITE_ENABLE_STAT3) && !defined(SQLITE_ENABLE_STAT4)
  90092. if( iChng==0 ){
  90093. tRowcnt nLt = p->current.anLt[0];
  90094. tRowcnt nEq = p->current.anEq[0];
  90095. /* Check if this is to be a periodic sample. If so, add it. */
  90096. if( (nLt/p->nPSample)!=(nLt+nEq)/p->nPSample ){
  90097. p->current.isPSample = 1;
  90098. sampleInsert(p, &p->current, 0);
  90099. p->current.isPSample = 0;
  90100. }else
  90101. /* Or if it is a non-periodic sample. Add it in this case too. */
  90102. if( p->nSample<p->mxSample
  90103. || sampleIsBetter(p, &p->current, &p->a[p->iMin])
  90104. ){
  90105. sampleInsert(p, &p->current, 0);
  90106. }
  90107. }
  90108. #endif
  90109. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  90110. UNUSED_PARAMETER( p );
  90111. UNUSED_PARAMETER( iChng );
  90112. #endif
  90113. }
  90114. /*
  90115. ** Implementation of the stat_push SQL function: stat_push(P,C,R)
  90116. ** Arguments:
  90117. **
  90118. ** P Pointer to the Stat4Accum object created by stat_init()
  90119. ** C Index of left-most column to differ from previous row
  90120. ** R Rowid for the current row. Might be a key record for
  90121. ** WITHOUT ROWID tables.
  90122. **
  90123. ** This SQL function always returns NULL. It's purpose it to accumulate
  90124. ** statistical data and/or samples in the Stat4Accum object about the
  90125. ** index being analyzed. The stat_get() SQL function will later be used to
  90126. ** extract relevant information for constructing the sqlite_statN tables.
  90127. **
  90128. ** The R parameter is only used for STAT3 and STAT4
  90129. */
  90130. static void statPush(
  90131. sqlite3_context *context,
  90132. int argc,
  90133. sqlite3_value **argv
  90134. ){
  90135. int i;
  90136. /* The three function arguments */
  90137. Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
  90138. int iChng = sqlite3_value_int(argv[1]);
  90139. UNUSED_PARAMETER( argc );
  90140. UNUSED_PARAMETER( context );
  90141. assert( p->nCol>0 );
  90142. assert( iChng<p->nCol );
  90143. if( p->nRow==0 ){
  90144. /* This is the first call to this function. Do initialization. */
  90145. for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
  90146. }else{
  90147. /* Second and subsequent calls get processed here */
  90148. samplePushPrevious(p, iChng);
  90149. /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
  90150. ** to the current row of the index. */
  90151. for(i=0; i<iChng; i++){
  90152. p->current.anEq[i]++;
  90153. }
  90154. for(i=iChng; i<p->nCol; i++){
  90155. p->current.anDLt[i]++;
  90156. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90157. p->current.anLt[i] += p->current.anEq[i];
  90158. #endif
  90159. p->current.anEq[i] = 1;
  90160. }
  90161. }
  90162. p->nRow++;
  90163. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90164. if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
  90165. sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
  90166. }else{
  90167. sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
  90168. sqlite3_value_blob(argv[2]));
  90169. }
  90170. p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
  90171. #endif
  90172. #ifdef SQLITE_ENABLE_STAT4
  90173. {
  90174. tRowcnt nLt = p->current.anLt[p->nCol-1];
  90175. /* Check if this is to be a periodic sample. If so, add it. */
  90176. if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
  90177. p->current.isPSample = 1;
  90178. p->current.iCol = 0;
  90179. sampleInsert(p, &p->current, p->nCol-1);
  90180. p->current.isPSample = 0;
  90181. }
  90182. /* Update the aBest[] array. */
  90183. for(i=0; i<(p->nCol-1); i++){
  90184. p->current.iCol = i;
  90185. if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
  90186. sampleCopy(p, &p->aBest[i], &p->current);
  90187. }
  90188. }
  90189. }
  90190. #endif
  90191. }
  90192. static const FuncDef statPushFuncdef = {
  90193. 2+IsStat34, /* nArg */
  90194. SQLITE_UTF8, /* funcFlags */
  90195. 0, /* pUserData */
  90196. 0, /* pNext */
  90197. statPush, /* xSFunc */
  90198. 0, /* xFinalize */
  90199. "stat_push", /* zName */
  90200. {0}
  90201. };
  90202. #define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
  90203. #define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
  90204. #define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
  90205. #define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
  90206. #define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
  90207. /*
  90208. ** Implementation of the stat_get(P,J) SQL function. This routine is
  90209. ** used to query statistical information that has been gathered into
  90210. ** the Stat4Accum object by prior calls to stat_push(). The P parameter
  90211. ** has type BLOB but it is really just a pointer to the Stat4Accum object.
  90212. ** The content to returned is determined by the parameter J
  90213. ** which is one of the STAT_GET_xxxx values defined above.
  90214. **
  90215. ** If neither STAT3 nor STAT4 are enabled, then J is always
  90216. ** STAT_GET_STAT1 and is hence omitted and this routine becomes
  90217. ** a one-parameter function, stat_get(P), that always returns the
  90218. ** stat1 table entry information.
  90219. */
  90220. static void statGet(
  90221. sqlite3_context *context,
  90222. int argc,
  90223. sqlite3_value **argv
  90224. ){
  90225. Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
  90226. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90227. /* STAT3 and STAT4 have a parameter on this routine. */
  90228. int eCall = sqlite3_value_int(argv[1]);
  90229. assert( argc==2 );
  90230. assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
  90231. || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
  90232. || eCall==STAT_GET_NDLT
  90233. );
  90234. if( eCall==STAT_GET_STAT1 )
  90235. #else
  90236. assert( argc==1 );
  90237. #endif
  90238. {
  90239. /* Return the value to store in the "stat" column of the sqlite_stat1
  90240. ** table for this index.
  90241. **
  90242. ** The value is a string composed of a list of integers describing
  90243. ** the index. The first integer in the list is the total number of
  90244. ** entries in the index. There is one additional integer in the list
  90245. ** for each indexed column. This additional integer is an estimate of
  90246. ** the number of rows matched by a stabbing query on the index using
  90247. ** a key with the corresponding number of fields. In other words,
  90248. ** if the index is on columns (a,b) and the sqlite_stat1 value is
  90249. ** "100 10 2", then SQLite estimates that:
  90250. **
  90251. ** * the index contains 100 rows,
  90252. ** * "WHERE a=?" matches 10 rows, and
  90253. ** * "WHERE a=? AND b=?" matches 2 rows.
  90254. **
  90255. ** If D is the count of distinct values and K is the total number of
  90256. ** rows, then each estimate is computed as:
  90257. **
  90258. ** I = (K+D-1)/D
  90259. */
  90260. char *z;
  90261. int i;
  90262. char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
  90263. if( zRet==0 ){
  90264. sqlite3_result_error_nomem(context);
  90265. return;
  90266. }
  90267. sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
  90268. z = zRet + sqlite3Strlen30(zRet);
  90269. for(i=0; i<p->nKeyCol; i++){
  90270. u64 nDistinct = p->current.anDLt[i] + 1;
  90271. u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
  90272. sqlite3_snprintf(24, z, " %llu", iVal);
  90273. z += sqlite3Strlen30(z);
  90274. assert( p->current.anEq[i] );
  90275. }
  90276. assert( z[0]=='\0' && z>zRet );
  90277. sqlite3_result_text(context, zRet, -1, sqlite3_free);
  90278. }
  90279. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90280. else if( eCall==STAT_GET_ROWID ){
  90281. if( p->iGet<0 ){
  90282. samplePushPrevious(p, 0);
  90283. p->iGet = 0;
  90284. }
  90285. if( p->iGet<p->nSample ){
  90286. Stat4Sample *pS = p->a + p->iGet;
  90287. if( pS->nRowid==0 ){
  90288. sqlite3_result_int64(context, pS->u.iRowid);
  90289. }else{
  90290. sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
  90291. SQLITE_TRANSIENT);
  90292. }
  90293. }
  90294. }else{
  90295. tRowcnt *aCnt = 0;
  90296. assert( p->iGet<p->nSample );
  90297. switch( eCall ){
  90298. case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
  90299. case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
  90300. default: {
  90301. aCnt = p->a[p->iGet].anDLt;
  90302. p->iGet++;
  90303. break;
  90304. }
  90305. }
  90306. if( IsStat3 ){
  90307. sqlite3_result_int64(context, (i64)aCnt[0]);
  90308. }else{
  90309. char *zRet = sqlite3MallocZero(p->nCol * 25);
  90310. if( zRet==0 ){
  90311. sqlite3_result_error_nomem(context);
  90312. }else{
  90313. int i;
  90314. char *z = zRet;
  90315. for(i=0; i<p->nCol; i++){
  90316. sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
  90317. z += sqlite3Strlen30(z);
  90318. }
  90319. assert( z[0]=='\0' && z>zRet );
  90320. z[-1] = '\0';
  90321. sqlite3_result_text(context, zRet, -1, sqlite3_free);
  90322. }
  90323. }
  90324. }
  90325. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  90326. #ifndef SQLITE_DEBUG
  90327. UNUSED_PARAMETER( argc );
  90328. #endif
  90329. }
  90330. static const FuncDef statGetFuncdef = {
  90331. 1+IsStat34, /* nArg */
  90332. SQLITE_UTF8, /* funcFlags */
  90333. 0, /* pUserData */
  90334. 0, /* pNext */
  90335. statGet, /* xSFunc */
  90336. 0, /* xFinalize */
  90337. "stat_get", /* zName */
  90338. {0}
  90339. };
  90340. static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
  90341. assert( regOut!=regStat4 && regOut!=regStat4+1 );
  90342. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90343. sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
  90344. #elif SQLITE_DEBUG
  90345. assert( iParam==STAT_GET_STAT1 );
  90346. #else
  90347. UNUSED_PARAMETER( iParam );
  90348. #endif
  90349. sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4, regOut,
  90350. (char*)&statGetFuncdef, P4_FUNCDEF);
  90351. sqlite3VdbeChangeP5(v, 1 + IsStat34);
  90352. }
  90353. /*
  90354. ** Generate code to do an analysis of all indices associated with
  90355. ** a single table.
  90356. */
  90357. static void analyzeOneTable(
  90358. Parse *pParse, /* Parser context */
  90359. Table *pTab, /* Table whose indices are to be analyzed */
  90360. Index *pOnlyIdx, /* If not NULL, only analyze this one index */
  90361. int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
  90362. int iMem, /* Available memory locations begin here */
  90363. int iTab /* Next available cursor */
  90364. ){
  90365. sqlite3 *db = pParse->db; /* Database handle */
  90366. Index *pIdx; /* An index to being analyzed */
  90367. int iIdxCur; /* Cursor open on index being analyzed */
  90368. int iTabCur; /* Table cursor */
  90369. Vdbe *v; /* The virtual machine being built up */
  90370. int i; /* Loop counter */
  90371. int jZeroRows = -1; /* Jump from here if number of rows is zero */
  90372. int iDb; /* Index of database containing pTab */
  90373. u8 needTableCnt = 1; /* True to count the table */
  90374. int regNewRowid = iMem++; /* Rowid for the inserted record */
  90375. int regStat4 = iMem++; /* Register to hold Stat4Accum object */
  90376. int regChng = iMem++; /* Index of changed index field */
  90377. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90378. int regRowid = iMem++; /* Rowid argument passed to stat_push() */
  90379. #endif
  90380. int regTemp = iMem++; /* Temporary use register */
  90381. int regTabname = iMem++; /* Register containing table name */
  90382. int regIdxname = iMem++; /* Register containing index name */
  90383. int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
  90384. int regPrev = iMem; /* MUST BE LAST (see below) */
  90385. pParse->nMem = MAX(pParse->nMem, iMem);
  90386. v = sqlite3GetVdbe(pParse);
  90387. if( v==0 || NEVER(pTab==0) ){
  90388. return;
  90389. }
  90390. if( pTab->tnum==0 ){
  90391. /* Do not gather statistics on views or virtual tables */
  90392. return;
  90393. }
  90394. if( sqlite3_strlike("sqlite_%", pTab->zName, 0)==0 ){
  90395. /* Do not gather statistics on system tables */
  90396. return;
  90397. }
  90398. assert( sqlite3BtreeHoldsAllMutexes(db) );
  90399. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  90400. assert( iDb>=0 );
  90401. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  90402. #ifndef SQLITE_OMIT_AUTHORIZATION
  90403. if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
  90404. db->aDb[iDb].zDbSName ) ){
  90405. return;
  90406. }
  90407. #endif
  90408. /* Establish a read-lock on the table at the shared-cache level.
  90409. ** Open a read-only cursor on the table. Also allocate a cursor number
  90410. ** to use for scanning indexes (iIdxCur). No index cursor is opened at
  90411. ** this time though. */
  90412. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  90413. iTabCur = iTab++;
  90414. iIdxCur = iTab++;
  90415. pParse->nTab = MAX(pParse->nTab, iTab);
  90416. sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
  90417. sqlite3VdbeLoadString(v, regTabname, pTab->zName);
  90418. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  90419. int nCol; /* Number of columns in pIdx. "N" */
  90420. int addrRewind; /* Address of "OP_Rewind iIdxCur" */
  90421. int addrNextRow; /* Address of "next_row:" */
  90422. const char *zIdxName; /* Name of the index */
  90423. int nColTest; /* Number of columns to test for changes */
  90424. if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
  90425. if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
  90426. if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
  90427. nCol = pIdx->nKeyCol;
  90428. zIdxName = pTab->zName;
  90429. nColTest = nCol - 1;
  90430. }else{
  90431. nCol = pIdx->nColumn;
  90432. zIdxName = pIdx->zName;
  90433. nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
  90434. }
  90435. /* Populate the register containing the index name. */
  90436. sqlite3VdbeLoadString(v, regIdxname, zIdxName);
  90437. VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
  90438. /*
  90439. ** Pseudo-code for loop that calls stat_push():
  90440. **
  90441. ** Rewind csr
  90442. ** if eof(csr) goto end_of_scan;
  90443. ** regChng = 0
  90444. ** goto chng_addr_0;
  90445. **
  90446. ** next_row:
  90447. ** regChng = 0
  90448. ** if( idx(0) != regPrev(0) ) goto chng_addr_0
  90449. ** regChng = 1
  90450. ** if( idx(1) != regPrev(1) ) goto chng_addr_1
  90451. ** ...
  90452. ** regChng = N
  90453. ** goto chng_addr_N
  90454. **
  90455. ** chng_addr_0:
  90456. ** regPrev(0) = idx(0)
  90457. ** chng_addr_1:
  90458. ** regPrev(1) = idx(1)
  90459. ** ...
  90460. **
  90461. ** endDistinctTest:
  90462. ** regRowid = idx(rowid)
  90463. ** stat_push(P, regChng, regRowid)
  90464. ** Next csr
  90465. ** if !eof(csr) goto next_row;
  90466. **
  90467. ** end_of_scan:
  90468. */
  90469. /* Make sure there are enough memory cells allocated to accommodate
  90470. ** the regPrev array and a trailing rowid (the rowid slot is required
  90471. ** when building a record to insert into the sample column of
  90472. ** the sqlite_stat4 table. */
  90473. pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
  90474. /* Open a read-only cursor on the index being analyzed. */
  90475. assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
  90476. sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
  90477. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  90478. VdbeComment((v, "%s", pIdx->zName));
  90479. /* Invoke the stat_init() function. The arguments are:
  90480. **
  90481. ** (1) the number of columns in the index including the rowid
  90482. ** (or for a WITHOUT ROWID table, the number of PK columns),
  90483. ** (2) the number of columns in the key without the rowid/pk
  90484. ** (3) the number of rows in the index,
  90485. **
  90486. **
  90487. ** The third argument is only used for STAT3 and STAT4
  90488. */
  90489. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90490. sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
  90491. #endif
  90492. sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
  90493. sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
  90494. sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4+1, regStat4,
  90495. (char*)&statInitFuncdef, P4_FUNCDEF);
  90496. sqlite3VdbeChangeP5(v, 2+IsStat34);
  90497. /* Implementation of the following:
  90498. **
  90499. ** Rewind csr
  90500. ** if eof(csr) goto end_of_scan;
  90501. ** regChng = 0
  90502. ** goto next_push_0;
  90503. **
  90504. */
  90505. addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
  90506. VdbeCoverage(v);
  90507. sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
  90508. addrNextRow = sqlite3VdbeCurrentAddr(v);
  90509. if( nColTest>0 ){
  90510. int endDistinctTest = sqlite3VdbeMakeLabel(v);
  90511. int *aGotoChng; /* Array of jump instruction addresses */
  90512. aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
  90513. if( aGotoChng==0 ) continue;
  90514. /*
  90515. ** next_row:
  90516. ** regChng = 0
  90517. ** if( idx(0) != regPrev(0) ) goto chng_addr_0
  90518. ** regChng = 1
  90519. ** if( idx(1) != regPrev(1) ) goto chng_addr_1
  90520. ** ...
  90521. ** regChng = N
  90522. ** goto endDistinctTest
  90523. */
  90524. sqlite3VdbeAddOp0(v, OP_Goto);
  90525. addrNextRow = sqlite3VdbeCurrentAddr(v);
  90526. if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
  90527. /* For a single-column UNIQUE index, once we have found a non-NULL
  90528. ** row, we know that all the rest will be distinct, so skip
  90529. ** subsequent distinctness tests. */
  90530. sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
  90531. VdbeCoverage(v);
  90532. }
  90533. for(i=0; i<nColTest; i++){
  90534. char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
  90535. sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
  90536. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
  90537. aGotoChng[i] =
  90538. sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
  90539. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  90540. VdbeCoverage(v);
  90541. }
  90542. sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
  90543. sqlite3VdbeGoto(v, endDistinctTest);
  90544. /*
  90545. ** chng_addr_0:
  90546. ** regPrev(0) = idx(0)
  90547. ** chng_addr_1:
  90548. ** regPrev(1) = idx(1)
  90549. ** ...
  90550. */
  90551. sqlite3VdbeJumpHere(v, addrNextRow-1);
  90552. for(i=0; i<nColTest; i++){
  90553. sqlite3VdbeJumpHere(v, aGotoChng[i]);
  90554. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
  90555. }
  90556. sqlite3VdbeResolveLabel(v, endDistinctTest);
  90557. sqlite3DbFree(db, aGotoChng);
  90558. }
  90559. /*
  90560. ** chng_addr_N:
  90561. ** regRowid = idx(rowid) // STAT34 only
  90562. ** stat_push(P, regChng, regRowid) // 3rd parameter STAT34 only
  90563. ** Next csr
  90564. ** if !eof(csr) goto next_row;
  90565. */
  90566. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90567. assert( regRowid==(regStat4+2) );
  90568. if( HasRowid(pTab) ){
  90569. sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
  90570. }else{
  90571. Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
  90572. int j, k, regKey;
  90573. regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
  90574. for(j=0; j<pPk->nKeyCol; j++){
  90575. k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
  90576. assert( k>=0 && k<pTab->nCol );
  90577. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
  90578. VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
  90579. }
  90580. sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
  90581. sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
  90582. }
  90583. #endif
  90584. assert( regChng==(regStat4+1) );
  90585. sqlite3VdbeAddOp4(v, OP_Function0, 1, regStat4, regTemp,
  90586. (char*)&statPushFuncdef, P4_FUNCDEF);
  90587. sqlite3VdbeChangeP5(v, 2+IsStat34);
  90588. sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
  90589. /* Add the entry to the stat1 table. */
  90590. callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
  90591. assert( "BBB"[0]==SQLITE_AFF_TEXT );
  90592. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
  90593. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
  90594. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
  90595. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  90596. /* Add the entries to the stat3 or stat4 table. */
  90597. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90598. {
  90599. int regEq = regStat1;
  90600. int regLt = regStat1+1;
  90601. int regDLt = regStat1+2;
  90602. int regSample = regStat1+3;
  90603. int regCol = regStat1+4;
  90604. int regSampleRowid = regCol + nCol;
  90605. int addrNext;
  90606. int addrIsNull;
  90607. u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
  90608. pParse->nMem = MAX(pParse->nMem, regCol+nCol);
  90609. addrNext = sqlite3VdbeCurrentAddr(v);
  90610. callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
  90611. addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
  90612. VdbeCoverage(v);
  90613. callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
  90614. callStatGet(v, regStat4, STAT_GET_NLT, regLt);
  90615. callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
  90616. sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
  90617. /* We know that the regSampleRowid row exists because it was read by
  90618. ** the previous loop. Thus the not-found jump of seekOp will never
  90619. ** be taken */
  90620. VdbeCoverageNeverTaken(v);
  90621. #ifdef SQLITE_ENABLE_STAT3
  90622. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, 0, regSample);
  90623. #else
  90624. for(i=0; i<nCol; i++){
  90625. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
  90626. }
  90627. sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
  90628. #endif
  90629. sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
  90630. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
  90631. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
  90632. sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
  90633. sqlite3VdbeJumpHere(v, addrIsNull);
  90634. }
  90635. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  90636. /* End of analysis */
  90637. sqlite3VdbeJumpHere(v, addrRewind);
  90638. }
  90639. /* Create a single sqlite_stat1 entry containing NULL as the index
  90640. ** name and the row count as the content.
  90641. */
  90642. if( pOnlyIdx==0 && needTableCnt ){
  90643. VdbeComment((v, "%s", pTab->zName));
  90644. sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
  90645. jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
  90646. sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
  90647. assert( "BBB"[0]==SQLITE_AFF_TEXT );
  90648. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
  90649. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
  90650. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
  90651. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  90652. sqlite3VdbeJumpHere(v, jZeroRows);
  90653. }
  90654. }
  90655. /*
  90656. ** Generate code that will cause the most recent index analysis to
  90657. ** be loaded into internal hash tables where is can be used.
  90658. */
  90659. static void loadAnalysis(Parse *pParse, int iDb){
  90660. Vdbe *v = sqlite3GetVdbe(pParse);
  90661. if( v ){
  90662. sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
  90663. }
  90664. }
  90665. /*
  90666. ** Generate code that will do an analysis of an entire database
  90667. */
  90668. static void analyzeDatabase(Parse *pParse, int iDb){
  90669. sqlite3 *db = pParse->db;
  90670. Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
  90671. HashElem *k;
  90672. int iStatCur;
  90673. int iMem;
  90674. int iTab;
  90675. sqlite3BeginWriteOperation(pParse, 0, iDb);
  90676. iStatCur = pParse->nTab;
  90677. pParse->nTab += 3;
  90678. openStatTable(pParse, iDb, iStatCur, 0, 0);
  90679. iMem = pParse->nMem+1;
  90680. iTab = pParse->nTab;
  90681. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  90682. for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
  90683. Table *pTab = (Table*)sqliteHashData(k);
  90684. analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
  90685. }
  90686. loadAnalysis(pParse, iDb);
  90687. }
  90688. /*
  90689. ** Generate code that will do an analysis of a single table in
  90690. ** a database. If pOnlyIdx is not NULL then it is a single index
  90691. ** in pTab that should be analyzed.
  90692. */
  90693. static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
  90694. int iDb;
  90695. int iStatCur;
  90696. assert( pTab!=0 );
  90697. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  90698. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  90699. sqlite3BeginWriteOperation(pParse, 0, iDb);
  90700. iStatCur = pParse->nTab;
  90701. pParse->nTab += 3;
  90702. if( pOnlyIdx ){
  90703. openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
  90704. }else{
  90705. openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
  90706. }
  90707. analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
  90708. loadAnalysis(pParse, iDb);
  90709. }
  90710. /*
  90711. ** Generate code for the ANALYZE command. The parser calls this routine
  90712. ** when it recognizes an ANALYZE command.
  90713. **
  90714. ** ANALYZE -- 1
  90715. ** ANALYZE <database> -- 2
  90716. ** ANALYZE ?<database>.?<tablename> -- 3
  90717. **
  90718. ** Form 1 causes all indices in all attached databases to be analyzed.
  90719. ** Form 2 analyzes all indices the single database named.
  90720. ** Form 3 analyzes all indices associated with the named table.
  90721. */
  90722. SQLITE_PRIVATE void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
  90723. sqlite3 *db = pParse->db;
  90724. int iDb;
  90725. int i;
  90726. char *z, *zDb;
  90727. Table *pTab;
  90728. Index *pIdx;
  90729. Token *pTableName;
  90730. Vdbe *v;
  90731. /* Read the database schema. If an error occurs, leave an error message
  90732. ** and code in pParse and return NULL. */
  90733. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  90734. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  90735. return;
  90736. }
  90737. assert( pName2!=0 || pName1==0 );
  90738. if( pName1==0 ){
  90739. /* Form 1: Analyze everything */
  90740. for(i=0; i<db->nDb; i++){
  90741. if( i==1 ) continue; /* Do not analyze the TEMP database */
  90742. analyzeDatabase(pParse, i);
  90743. }
  90744. }else if( pName2->n==0 ){
  90745. /* Form 2: Analyze the database or table named */
  90746. iDb = sqlite3FindDb(db, pName1);
  90747. if( iDb>=0 ){
  90748. analyzeDatabase(pParse, iDb);
  90749. }else{
  90750. z = sqlite3NameFromToken(db, pName1);
  90751. if( z ){
  90752. if( (pIdx = sqlite3FindIndex(db, z, 0))!=0 ){
  90753. analyzeTable(pParse, pIdx->pTable, pIdx);
  90754. }else if( (pTab = sqlite3LocateTable(pParse, 0, z, 0))!=0 ){
  90755. analyzeTable(pParse, pTab, 0);
  90756. }
  90757. sqlite3DbFree(db, z);
  90758. }
  90759. }
  90760. }else{
  90761. /* Form 3: Analyze the fully qualified table name */
  90762. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
  90763. if( iDb>=0 ){
  90764. zDb = db->aDb[iDb].zDbSName;
  90765. z = sqlite3NameFromToken(db, pTableName);
  90766. if( z ){
  90767. if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
  90768. analyzeTable(pParse, pIdx->pTable, pIdx);
  90769. }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
  90770. analyzeTable(pParse, pTab, 0);
  90771. }
  90772. sqlite3DbFree(db, z);
  90773. }
  90774. }
  90775. }
  90776. v = sqlite3GetVdbe(pParse);
  90777. if( v ) sqlite3VdbeAddOp0(v, OP_Expire);
  90778. }
  90779. /*
  90780. ** Used to pass information from the analyzer reader through to the
  90781. ** callback routine.
  90782. */
  90783. typedef struct analysisInfo analysisInfo;
  90784. struct analysisInfo {
  90785. sqlite3 *db;
  90786. const char *zDatabase;
  90787. };
  90788. /*
  90789. ** The first argument points to a nul-terminated string containing a
  90790. ** list of space separated integers. Read the first nOut of these into
  90791. ** the array aOut[].
  90792. */
  90793. static void decodeIntArray(
  90794. char *zIntArray, /* String containing int array to decode */
  90795. int nOut, /* Number of slots in aOut[] */
  90796. tRowcnt *aOut, /* Store integers here */
  90797. LogEst *aLog, /* Or, if aOut==0, here */
  90798. Index *pIndex /* Handle extra flags for this index, if not NULL */
  90799. ){
  90800. char *z = zIntArray;
  90801. int c;
  90802. int i;
  90803. tRowcnt v;
  90804. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90805. if( z==0 ) z = "";
  90806. #else
  90807. assert( z!=0 );
  90808. #endif
  90809. for(i=0; *z && i<nOut; i++){
  90810. v = 0;
  90811. while( (c=z[0])>='0' && c<='9' ){
  90812. v = v*10 + c - '0';
  90813. z++;
  90814. }
  90815. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90816. if( aOut ) aOut[i] = v;
  90817. if( aLog ) aLog[i] = sqlite3LogEst(v);
  90818. #else
  90819. assert( aOut==0 );
  90820. UNUSED_PARAMETER(aOut);
  90821. assert( aLog!=0 );
  90822. aLog[i] = sqlite3LogEst(v);
  90823. #endif
  90824. if( *z==' ' ) z++;
  90825. }
  90826. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  90827. assert( pIndex!=0 ); {
  90828. #else
  90829. if( pIndex ){
  90830. #endif
  90831. pIndex->bUnordered = 0;
  90832. pIndex->noSkipScan = 0;
  90833. while( z[0] ){
  90834. if( sqlite3_strglob("unordered*", z)==0 ){
  90835. pIndex->bUnordered = 1;
  90836. }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
  90837. pIndex->szIdxRow = sqlite3LogEst(sqlite3Atoi(z+3));
  90838. }else if( sqlite3_strglob("noskipscan*", z)==0 ){
  90839. pIndex->noSkipScan = 1;
  90840. }
  90841. #ifdef SQLITE_ENABLE_COSTMULT
  90842. else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
  90843. pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
  90844. }
  90845. #endif
  90846. while( z[0]!=0 && z[0]!=' ' ) z++;
  90847. while( z[0]==' ' ) z++;
  90848. }
  90849. }
  90850. }
  90851. /*
  90852. ** This callback is invoked once for each index when reading the
  90853. ** sqlite_stat1 table.
  90854. **
  90855. ** argv[0] = name of the table
  90856. ** argv[1] = name of the index (might be NULL)
  90857. ** argv[2] = results of analysis - on integer for each column
  90858. **
  90859. ** Entries for which argv[1]==NULL simply record the number of rows in
  90860. ** the table.
  90861. */
  90862. static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
  90863. analysisInfo *pInfo = (analysisInfo*)pData;
  90864. Index *pIndex;
  90865. Table *pTable;
  90866. const char *z;
  90867. assert( argc==3 );
  90868. UNUSED_PARAMETER2(NotUsed, argc);
  90869. if( argv==0 || argv[0]==0 || argv[2]==0 ){
  90870. return 0;
  90871. }
  90872. pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
  90873. if( pTable==0 ){
  90874. return 0;
  90875. }
  90876. if( argv[1]==0 ){
  90877. pIndex = 0;
  90878. }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
  90879. pIndex = sqlite3PrimaryKeyIndex(pTable);
  90880. }else{
  90881. pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
  90882. }
  90883. z = argv[2];
  90884. if( pIndex ){
  90885. tRowcnt *aiRowEst = 0;
  90886. int nCol = pIndex->nKeyCol+1;
  90887. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90888. /* Index.aiRowEst may already be set here if there are duplicate
  90889. ** sqlite_stat1 entries for this index. In that case just clobber
  90890. ** the old data with the new instead of allocating a new array. */
  90891. if( pIndex->aiRowEst==0 ){
  90892. pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
  90893. if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
  90894. }
  90895. aiRowEst = pIndex->aiRowEst;
  90896. #endif
  90897. pIndex->bUnordered = 0;
  90898. decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
  90899. if( pIndex->pPartIdxWhere==0 ) pTable->nRowLogEst = pIndex->aiRowLogEst[0];
  90900. }else{
  90901. Index fakeIdx;
  90902. fakeIdx.szIdxRow = pTable->szTabRow;
  90903. #ifdef SQLITE_ENABLE_COSTMULT
  90904. fakeIdx.pTable = pTable;
  90905. #endif
  90906. decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
  90907. pTable->szTabRow = fakeIdx.szIdxRow;
  90908. }
  90909. return 0;
  90910. }
  90911. /*
  90912. ** If the Index.aSample variable is not NULL, delete the aSample[] array
  90913. ** and its contents.
  90914. */
  90915. SQLITE_PRIVATE void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
  90916. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90917. if( pIdx->aSample ){
  90918. int j;
  90919. for(j=0; j<pIdx->nSample; j++){
  90920. IndexSample *p = &pIdx->aSample[j];
  90921. sqlite3DbFree(db, p->p);
  90922. }
  90923. sqlite3DbFree(db, pIdx->aSample);
  90924. }
  90925. if( db && db->pnBytesFreed==0 ){
  90926. pIdx->nSample = 0;
  90927. pIdx->aSample = 0;
  90928. }
  90929. #else
  90930. UNUSED_PARAMETER(db);
  90931. UNUSED_PARAMETER(pIdx);
  90932. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  90933. }
  90934. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  90935. /*
  90936. ** Populate the pIdx->aAvgEq[] array based on the samples currently
  90937. ** stored in pIdx->aSample[].
  90938. */
  90939. static void initAvgEq(Index *pIdx){
  90940. if( pIdx ){
  90941. IndexSample *aSample = pIdx->aSample;
  90942. IndexSample *pFinal = &aSample[pIdx->nSample-1];
  90943. int iCol;
  90944. int nCol = 1;
  90945. if( pIdx->nSampleCol>1 ){
  90946. /* If this is stat4 data, then calculate aAvgEq[] values for all
  90947. ** sample columns except the last. The last is always set to 1, as
  90948. ** once the trailing PK fields are considered all index keys are
  90949. ** unique. */
  90950. nCol = pIdx->nSampleCol-1;
  90951. pIdx->aAvgEq[nCol] = 1;
  90952. }
  90953. for(iCol=0; iCol<nCol; iCol++){
  90954. int nSample = pIdx->nSample;
  90955. int i; /* Used to iterate through samples */
  90956. tRowcnt sumEq = 0; /* Sum of the nEq values */
  90957. tRowcnt avgEq = 0;
  90958. tRowcnt nRow; /* Number of rows in index */
  90959. i64 nSum100 = 0; /* Number of terms contributing to sumEq */
  90960. i64 nDist100; /* Number of distinct values in index */
  90961. if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
  90962. nRow = pFinal->anLt[iCol];
  90963. nDist100 = (i64)100 * pFinal->anDLt[iCol];
  90964. nSample--;
  90965. }else{
  90966. nRow = pIdx->aiRowEst[0];
  90967. nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
  90968. }
  90969. pIdx->nRowEst0 = nRow;
  90970. /* Set nSum to the number of distinct (iCol+1) field prefixes that
  90971. ** occur in the stat4 table for this index. Set sumEq to the sum of
  90972. ** the nEq values for column iCol for the same set (adding the value
  90973. ** only once where there exist duplicate prefixes). */
  90974. for(i=0; i<nSample; i++){
  90975. if( i==(pIdx->nSample-1)
  90976. || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
  90977. ){
  90978. sumEq += aSample[i].anEq[iCol];
  90979. nSum100 += 100;
  90980. }
  90981. }
  90982. if( nDist100>nSum100 ){
  90983. avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
  90984. }
  90985. if( avgEq==0 ) avgEq = 1;
  90986. pIdx->aAvgEq[iCol] = avgEq;
  90987. }
  90988. }
  90989. }
  90990. /*
  90991. ** Look up an index by name. Or, if the name of a WITHOUT ROWID table
  90992. ** is supplied instead, find the PRIMARY KEY index for that table.
  90993. */
  90994. static Index *findIndexOrPrimaryKey(
  90995. sqlite3 *db,
  90996. const char *zName,
  90997. const char *zDb
  90998. ){
  90999. Index *pIdx = sqlite3FindIndex(db, zName, zDb);
  91000. if( pIdx==0 ){
  91001. Table *pTab = sqlite3FindTable(db, zName, zDb);
  91002. if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
  91003. }
  91004. return pIdx;
  91005. }
  91006. /*
  91007. ** Load the content from either the sqlite_stat4 or sqlite_stat3 table
  91008. ** into the relevant Index.aSample[] arrays.
  91009. **
  91010. ** Arguments zSql1 and zSql2 must point to SQL statements that return
  91011. ** data equivalent to the following (statements are different for stat3,
  91012. ** see the caller of this function for details):
  91013. **
  91014. ** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
  91015. ** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
  91016. **
  91017. ** where %Q is replaced with the database name before the SQL is executed.
  91018. */
  91019. static int loadStatTbl(
  91020. sqlite3 *db, /* Database handle */
  91021. int bStat3, /* Assume single column records only */
  91022. const char *zSql1, /* SQL statement 1 (see above) */
  91023. const char *zSql2, /* SQL statement 2 (see above) */
  91024. const char *zDb /* Database name (e.g. "main") */
  91025. ){
  91026. int rc; /* Result codes from subroutines */
  91027. sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
  91028. char *zSql; /* Text of the SQL statement */
  91029. Index *pPrevIdx = 0; /* Previous index in the loop */
  91030. IndexSample *pSample; /* A slot in pIdx->aSample[] */
  91031. assert( db->lookaside.bDisable );
  91032. zSql = sqlite3MPrintf(db, zSql1, zDb);
  91033. if( !zSql ){
  91034. return SQLITE_NOMEM_BKPT;
  91035. }
  91036. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  91037. sqlite3DbFree(db, zSql);
  91038. if( rc ) return rc;
  91039. while( sqlite3_step(pStmt)==SQLITE_ROW ){
  91040. int nIdxCol = 1; /* Number of columns in stat4 records */
  91041. char *zIndex; /* Index name */
  91042. Index *pIdx; /* Pointer to the index object */
  91043. int nSample; /* Number of samples */
  91044. int nByte; /* Bytes of space required */
  91045. int i; /* Bytes of space required */
  91046. tRowcnt *pSpace;
  91047. zIndex = (char *)sqlite3_column_text(pStmt, 0);
  91048. if( zIndex==0 ) continue;
  91049. nSample = sqlite3_column_int(pStmt, 1);
  91050. pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
  91051. assert( pIdx==0 || bStat3 || pIdx->nSample==0 );
  91052. /* Index.nSample is non-zero at this point if data has already been
  91053. ** loaded from the stat4 table. In this case ignore stat3 data. */
  91054. if( pIdx==0 || pIdx->nSample ) continue;
  91055. if( bStat3==0 ){
  91056. assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
  91057. if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
  91058. nIdxCol = pIdx->nKeyCol;
  91059. }else{
  91060. nIdxCol = pIdx->nColumn;
  91061. }
  91062. }
  91063. pIdx->nSampleCol = nIdxCol;
  91064. nByte = sizeof(IndexSample) * nSample;
  91065. nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
  91066. nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
  91067. pIdx->aSample = sqlite3DbMallocZero(db, nByte);
  91068. if( pIdx->aSample==0 ){
  91069. sqlite3_finalize(pStmt);
  91070. return SQLITE_NOMEM_BKPT;
  91071. }
  91072. pSpace = (tRowcnt*)&pIdx->aSample[nSample];
  91073. pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
  91074. for(i=0; i<nSample; i++){
  91075. pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
  91076. pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
  91077. pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
  91078. }
  91079. assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
  91080. }
  91081. rc = sqlite3_finalize(pStmt);
  91082. if( rc ) return rc;
  91083. zSql = sqlite3MPrintf(db, zSql2, zDb);
  91084. if( !zSql ){
  91085. return SQLITE_NOMEM_BKPT;
  91086. }
  91087. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  91088. sqlite3DbFree(db, zSql);
  91089. if( rc ) return rc;
  91090. while( sqlite3_step(pStmt)==SQLITE_ROW ){
  91091. char *zIndex; /* Index name */
  91092. Index *pIdx; /* Pointer to the index object */
  91093. int nCol = 1; /* Number of columns in index */
  91094. zIndex = (char *)sqlite3_column_text(pStmt, 0);
  91095. if( zIndex==0 ) continue;
  91096. pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
  91097. if( pIdx==0 ) continue;
  91098. /* This next condition is true if data has already been loaded from
  91099. ** the sqlite_stat4 table. In this case ignore stat3 data. */
  91100. nCol = pIdx->nSampleCol;
  91101. if( bStat3 && nCol>1 ) continue;
  91102. if( pIdx!=pPrevIdx ){
  91103. initAvgEq(pPrevIdx);
  91104. pPrevIdx = pIdx;
  91105. }
  91106. pSample = &pIdx->aSample[pIdx->nSample];
  91107. decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
  91108. decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
  91109. decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
  91110. /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
  91111. ** This is in case the sample record is corrupted. In that case, the
  91112. ** sqlite3VdbeRecordCompare() may read up to two varints past the
  91113. ** end of the allocated buffer before it realizes it is dealing with
  91114. ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
  91115. ** a buffer overread. */
  91116. pSample->n = sqlite3_column_bytes(pStmt, 4);
  91117. pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
  91118. if( pSample->p==0 ){
  91119. sqlite3_finalize(pStmt);
  91120. return SQLITE_NOMEM_BKPT;
  91121. }
  91122. memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
  91123. pIdx->nSample++;
  91124. }
  91125. rc = sqlite3_finalize(pStmt);
  91126. if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
  91127. return rc;
  91128. }
  91129. /*
  91130. ** Load content from the sqlite_stat4 and sqlite_stat3 tables into
  91131. ** the Index.aSample[] arrays of all indices.
  91132. */
  91133. static int loadStat4(sqlite3 *db, const char *zDb){
  91134. int rc = SQLITE_OK; /* Result codes from subroutines */
  91135. assert( db->lookaside.bDisable );
  91136. if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
  91137. rc = loadStatTbl(db, 0,
  91138. "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
  91139. "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
  91140. zDb
  91141. );
  91142. }
  91143. if( rc==SQLITE_OK && sqlite3FindTable(db, "sqlite_stat3", zDb) ){
  91144. rc = loadStatTbl(db, 1,
  91145. "SELECT idx,count(*) FROM %Q.sqlite_stat3 GROUP BY idx",
  91146. "SELECT idx,neq,nlt,ndlt,sqlite_record(sample) FROM %Q.sqlite_stat3",
  91147. zDb
  91148. );
  91149. }
  91150. return rc;
  91151. }
  91152. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  91153. /*
  91154. ** Load the content of the sqlite_stat1 and sqlite_stat3/4 tables. The
  91155. ** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
  91156. ** arrays. The contents of sqlite_stat3/4 are used to populate the
  91157. ** Index.aSample[] arrays.
  91158. **
  91159. ** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
  91160. ** is returned. In this case, even if SQLITE_ENABLE_STAT3/4 was defined
  91161. ** during compilation and the sqlite_stat3/4 table is present, no data is
  91162. ** read from it.
  91163. **
  91164. ** If SQLITE_ENABLE_STAT3/4 was defined during compilation and the
  91165. ** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
  91166. ** returned. However, in this case, data is read from the sqlite_stat1
  91167. ** table (if it is present) before returning.
  91168. **
  91169. ** If an OOM error occurs, this function always sets db->mallocFailed.
  91170. ** This means if the caller does not care about other errors, the return
  91171. ** code may be ignored.
  91172. */
  91173. SQLITE_PRIVATE int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
  91174. analysisInfo sInfo;
  91175. HashElem *i;
  91176. char *zSql;
  91177. int rc = SQLITE_OK;
  91178. assert( iDb>=0 && iDb<db->nDb );
  91179. assert( db->aDb[iDb].pBt!=0 );
  91180. /* Clear any prior statistics */
  91181. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  91182. for(i=sqliteHashFirst(&db->aDb[iDb].pSchema->idxHash);i;i=sqliteHashNext(i)){
  91183. Index *pIdx = sqliteHashData(i);
  91184. pIdx->aiRowLogEst[0] = 0;
  91185. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  91186. sqlite3DeleteIndexSamples(db, pIdx);
  91187. pIdx->aSample = 0;
  91188. #endif
  91189. }
  91190. /* Load new statistics out of the sqlite_stat1 table */
  91191. sInfo.db = db;
  91192. sInfo.zDatabase = db->aDb[iDb].zDbSName;
  91193. if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
  91194. zSql = sqlite3MPrintf(db,
  91195. "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
  91196. if( zSql==0 ){
  91197. rc = SQLITE_NOMEM_BKPT;
  91198. }else{
  91199. rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
  91200. sqlite3DbFree(db, zSql);
  91201. }
  91202. }
  91203. /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
  91204. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  91205. for(i=sqliteHashFirst(&db->aDb[iDb].pSchema->idxHash);i;i=sqliteHashNext(i)){
  91206. Index *pIdx = sqliteHashData(i);
  91207. if( pIdx->aiRowLogEst[0]==0 ) sqlite3DefaultRowEst(pIdx);
  91208. }
  91209. /* Load the statistics from the sqlite_stat4 table. */
  91210. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  91211. if( rc==SQLITE_OK && OptimizationEnabled(db, SQLITE_Stat34) ){
  91212. db->lookaside.bDisable++;
  91213. rc = loadStat4(db, sInfo.zDatabase);
  91214. db->lookaside.bDisable--;
  91215. }
  91216. for(i=sqliteHashFirst(&db->aDb[iDb].pSchema->idxHash);i;i=sqliteHashNext(i)){
  91217. Index *pIdx = sqliteHashData(i);
  91218. sqlite3_free(pIdx->aiRowEst);
  91219. pIdx->aiRowEst = 0;
  91220. }
  91221. #endif
  91222. if( rc==SQLITE_NOMEM ){
  91223. sqlite3OomFault(db);
  91224. }
  91225. return rc;
  91226. }
  91227. #endif /* SQLITE_OMIT_ANALYZE */
  91228. /************** End of analyze.c *********************************************/
  91229. /************** Begin file attach.c ******************************************/
  91230. /*
  91231. ** 2003 April 6
  91232. **
  91233. ** The author disclaims copyright to this source code. In place of
  91234. ** a legal notice, here is a blessing:
  91235. **
  91236. ** May you do good and not evil.
  91237. ** May you find forgiveness for yourself and forgive others.
  91238. ** May you share freely, never taking more than you give.
  91239. **
  91240. *************************************************************************
  91241. ** This file contains code used to implement the ATTACH and DETACH commands.
  91242. */
  91243. /* #include "sqliteInt.h" */
  91244. #ifndef SQLITE_OMIT_ATTACH
  91245. /*
  91246. ** Resolve an expression that was part of an ATTACH or DETACH statement. This
  91247. ** is slightly different from resolving a normal SQL expression, because simple
  91248. ** identifiers are treated as strings, not possible column names or aliases.
  91249. **
  91250. ** i.e. if the parser sees:
  91251. **
  91252. ** ATTACH DATABASE abc AS def
  91253. **
  91254. ** it treats the two expressions as literal strings 'abc' and 'def' instead of
  91255. ** looking for columns of the same name.
  91256. **
  91257. ** This only applies to the root node of pExpr, so the statement:
  91258. **
  91259. ** ATTACH DATABASE abc||def AS 'db2'
  91260. **
  91261. ** will fail because neither abc or def can be resolved.
  91262. */
  91263. static int resolveAttachExpr(NameContext *pName, Expr *pExpr)
  91264. {
  91265. int rc = SQLITE_OK;
  91266. if( pExpr ){
  91267. if( pExpr->op!=TK_ID ){
  91268. rc = sqlite3ResolveExprNames(pName, pExpr);
  91269. }else{
  91270. pExpr->op = TK_STRING;
  91271. }
  91272. }
  91273. return rc;
  91274. }
  91275. /*
  91276. ** An SQL user-function registered to do the work of an ATTACH statement. The
  91277. ** three arguments to the function come directly from an attach statement:
  91278. **
  91279. ** ATTACH DATABASE x AS y KEY z
  91280. **
  91281. ** SELECT sqlite_attach(x, y, z)
  91282. **
  91283. ** If the optional "KEY z" syntax is omitted, an SQL NULL is passed as the
  91284. ** third argument.
  91285. */
  91286. static void attachFunc(
  91287. sqlite3_context *context,
  91288. int NotUsed,
  91289. sqlite3_value **argv
  91290. ){
  91291. int i;
  91292. int rc = 0;
  91293. sqlite3 *db = sqlite3_context_db_handle(context);
  91294. const char *zName;
  91295. const char *zFile;
  91296. char *zPath = 0;
  91297. char *zErr = 0;
  91298. unsigned int flags;
  91299. Db *aNew;
  91300. char *zErrDyn = 0;
  91301. sqlite3_vfs *pVfs;
  91302. UNUSED_PARAMETER(NotUsed);
  91303. zFile = (const char *)sqlite3_value_text(argv[0]);
  91304. zName = (const char *)sqlite3_value_text(argv[1]);
  91305. if( zFile==0 ) zFile = "";
  91306. if( zName==0 ) zName = "";
  91307. /* Check for the following errors:
  91308. **
  91309. ** * Too many attached databases,
  91310. ** * Transaction currently open
  91311. ** * Specified database name already being used.
  91312. */
  91313. if( db->nDb>=db->aLimit[SQLITE_LIMIT_ATTACHED]+2 ){
  91314. zErrDyn = sqlite3MPrintf(db, "too many attached databases - max %d",
  91315. db->aLimit[SQLITE_LIMIT_ATTACHED]
  91316. );
  91317. goto attach_error;
  91318. }
  91319. if( !db->autoCommit ){
  91320. zErrDyn = sqlite3MPrintf(db, "cannot ATTACH database within transaction");
  91321. goto attach_error;
  91322. }
  91323. for(i=0; i<db->nDb; i++){
  91324. char *z = db->aDb[i].zDbSName;
  91325. assert( z && zName );
  91326. if( sqlite3StrICmp(z, zName)==0 ){
  91327. zErrDyn = sqlite3MPrintf(db, "database %s is already in use", zName);
  91328. goto attach_error;
  91329. }
  91330. }
  91331. /* Allocate the new entry in the db->aDb[] array and initialize the schema
  91332. ** hash tables.
  91333. */
  91334. if( db->aDb==db->aDbStatic ){
  91335. aNew = sqlite3DbMallocRawNN(db, sizeof(db->aDb[0])*3 );
  91336. if( aNew==0 ) return;
  91337. memcpy(aNew, db->aDb, sizeof(db->aDb[0])*2);
  91338. }else{
  91339. aNew = sqlite3DbRealloc(db, db->aDb, sizeof(db->aDb[0])*(db->nDb+1) );
  91340. if( aNew==0 ) return;
  91341. }
  91342. db->aDb = aNew;
  91343. aNew = &db->aDb[db->nDb];
  91344. memset(aNew, 0, sizeof(*aNew));
  91345. /* Open the database file. If the btree is successfully opened, use
  91346. ** it to obtain the database schema. At this point the schema may
  91347. ** or may not be initialized.
  91348. */
  91349. flags = db->openFlags;
  91350. rc = sqlite3ParseUri(db->pVfs->zName, zFile, &flags, &pVfs, &zPath, &zErr);
  91351. if( rc!=SQLITE_OK ){
  91352. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  91353. sqlite3_result_error(context, zErr, -1);
  91354. sqlite3_free(zErr);
  91355. return;
  91356. }
  91357. assert( pVfs );
  91358. flags |= SQLITE_OPEN_MAIN_DB;
  91359. rc = sqlite3BtreeOpen(pVfs, zPath, db, &aNew->pBt, 0, flags);
  91360. sqlite3_free( zPath );
  91361. db->nDb++;
  91362. if( rc==SQLITE_CONSTRAINT ){
  91363. rc = SQLITE_ERROR;
  91364. zErrDyn = sqlite3MPrintf(db, "database is already attached");
  91365. }else if( rc==SQLITE_OK ){
  91366. Pager *pPager;
  91367. aNew->pSchema = sqlite3SchemaGet(db, aNew->pBt);
  91368. if( !aNew->pSchema ){
  91369. rc = SQLITE_NOMEM_BKPT;
  91370. }else if( aNew->pSchema->file_format && aNew->pSchema->enc!=ENC(db) ){
  91371. zErrDyn = sqlite3MPrintf(db,
  91372. "attached databases must use the same text encoding as main database");
  91373. rc = SQLITE_ERROR;
  91374. }
  91375. sqlite3BtreeEnter(aNew->pBt);
  91376. pPager = sqlite3BtreePager(aNew->pBt);
  91377. sqlite3PagerLockingMode(pPager, db->dfltLockMode);
  91378. sqlite3BtreeSecureDelete(aNew->pBt,
  91379. sqlite3BtreeSecureDelete(db->aDb[0].pBt,-1) );
  91380. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  91381. sqlite3BtreeSetPagerFlags(aNew->pBt,
  91382. PAGER_SYNCHRONOUS_FULL | (db->flags & PAGER_FLAGS_MASK));
  91383. #endif
  91384. sqlite3BtreeLeave(aNew->pBt);
  91385. }
  91386. aNew->safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
  91387. aNew->zDbSName = sqlite3DbStrDup(db, zName);
  91388. if( rc==SQLITE_OK && aNew->zDbSName==0 ){
  91389. rc = SQLITE_NOMEM_BKPT;
  91390. }
  91391. #ifdef SQLITE_HAS_CODEC
  91392. if( rc==SQLITE_OK ){
  91393. extern int sqlite3CodecAttach(sqlite3*, int, const void*, int);
  91394. extern void sqlite3CodecGetKey(sqlite3*, int, void**, int*);
  91395. int nKey;
  91396. char *zKey;
  91397. int t = sqlite3_value_type(argv[2]);
  91398. switch( t ){
  91399. case SQLITE_INTEGER:
  91400. case SQLITE_FLOAT:
  91401. zErrDyn = sqlite3DbStrDup(db, "Invalid key value");
  91402. rc = SQLITE_ERROR;
  91403. break;
  91404. case SQLITE_TEXT:
  91405. case SQLITE_BLOB:
  91406. nKey = sqlite3_value_bytes(argv[2]);
  91407. zKey = (char *)sqlite3_value_blob(argv[2]);
  91408. rc = sqlite3CodecAttach(db, db->nDb-1, zKey, nKey);
  91409. break;
  91410. case SQLITE_NULL:
  91411. /* No key specified. Use the key from the main database */
  91412. sqlite3CodecGetKey(db, 0, (void**)&zKey, &nKey);
  91413. if( nKey || sqlite3BtreeGetOptimalReserve(db->aDb[0].pBt)>0 ){
  91414. rc = sqlite3CodecAttach(db, db->nDb-1, zKey, nKey);
  91415. }
  91416. break;
  91417. }
  91418. }
  91419. #endif
  91420. /* If the file was opened successfully, read the schema for the new database.
  91421. ** If this fails, or if opening the file failed, then close the file and
  91422. ** remove the entry from the db->aDb[] array. i.e. put everything back the way
  91423. ** we found it.
  91424. */
  91425. if( rc==SQLITE_OK ){
  91426. sqlite3BtreeEnterAll(db);
  91427. rc = sqlite3Init(db, &zErrDyn);
  91428. sqlite3BtreeLeaveAll(db);
  91429. }
  91430. #ifdef SQLITE_USER_AUTHENTICATION
  91431. if( rc==SQLITE_OK ){
  91432. u8 newAuth = 0;
  91433. rc = sqlite3UserAuthCheckLogin(db, zName, &newAuth);
  91434. if( newAuth<db->auth.authLevel ){
  91435. rc = SQLITE_AUTH_USER;
  91436. }
  91437. }
  91438. #endif
  91439. if( rc ){
  91440. int iDb = db->nDb - 1;
  91441. assert( iDb>=2 );
  91442. if( db->aDb[iDb].pBt ){
  91443. sqlite3BtreeClose(db->aDb[iDb].pBt);
  91444. db->aDb[iDb].pBt = 0;
  91445. db->aDb[iDb].pSchema = 0;
  91446. }
  91447. sqlite3ResetAllSchemasOfConnection(db);
  91448. db->nDb = iDb;
  91449. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  91450. sqlite3OomFault(db);
  91451. sqlite3DbFree(db, zErrDyn);
  91452. zErrDyn = sqlite3MPrintf(db, "out of memory");
  91453. }else if( zErrDyn==0 ){
  91454. zErrDyn = sqlite3MPrintf(db, "unable to open database: %s", zFile);
  91455. }
  91456. goto attach_error;
  91457. }
  91458. return;
  91459. attach_error:
  91460. /* Return an error if we get here */
  91461. if( zErrDyn ){
  91462. sqlite3_result_error(context, zErrDyn, -1);
  91463. sqlite3DbFree(db, zErrDyn);
  91464. }
  91465. if( rc ) sqlite3_result_error_code(context, rc);
  91466. }
  91467. /*
  91468. ** An SQL user-function registered to do the work of an DETACH statement. The
  91469. ** three arguments to the function come directly from a detach statement:
  91470. **
  91471. ** DETACH DATABASE x
  91472. **
  91473. ** SELECT sqlite_detach(x)
  91474. */
  91475. static void detachFunc(
  91476. sqlite3_context *context,
  91477. int NotUsed,
  91478. sqlite3_value **argv
  91479. ){
  91480. const char *zName = (const char *)sqlite3_value_text(argv[0]);
  91481. sqlite3 *db = sqlite3_context_db_handle(context);
  91482. int i;
  91483. Db *pDb = 0;
  91484. char zErr[128];
  91485. UNUSED_PARAMETER(NotUsed);
  91486. if( zName==0 ) zName = "";
  91487. for(i=0; i<db->nDb; i++){
  91488. pDb = &db->aDb[i];
  91489. if( pDb->pBt==0 ) continue;
  91490. if( sqlite3StrICmp(pDb->zDbSName, zName)==0 ) break;
  91491. }
  91492. if( i>=db->nDb ){
  91493. sqlite3_snprintf(sizeof(zErr),zErr, "no such database: %s", zName);
  91494. goto detach_error;
  91495. }
  91496. if( i<2 ){
  91497. sqlite3_snprintf(sizeof(zErr),zErr, "cannot detach database %s", zName);
  91498. goto detach_error;
  91499. }
  91500. if( !db->autoCommit ){
  91501. sqlite3_snprintf(sizeof(zErr), zErr,
  91502. "cannot DETACH database within transaction");
  91503. goto detach_error;
  91504. }
  91505. if( sqlite3BtreeIsInReadTrans(pDb->pBt) || sqlite3BtreeIsInBackup(pDb->pBt) ){
  91506. sqlite3_snprintf(sizeof(zErr),zErr, "database %s is locked", zName);
  91507. goto detach_error;
  91508. }
  91509. sqlite3BtreeClose(pDb->pBt);
  91510. pDb->pBt = 0;
  91511. pDb->pSchema = 0;
  91512. sqlite3CollapseDatabaseArray(db);
  91513. return;
  91514. detach_error:
  91515. sqlite3_result_error(context, zErr, -1);
  91516. }
  91517. /*
  91518. ** This procedure generates VDBE code for a single invocation of either the
  91519. ** sqlite_detach() or sqlite_attach() SQL user functions.
  91520. */
  91521. static void codeAttach(
  91522. Parse *pParse, /* The parser context */
  91523. int type, /* Either SQLITE_ATTACH or SQLITE_DETACH */
  91524. FuncDef const *pFunc,/* FuncDef wrapper for detachFunc() or attachFunc() */
  91525. Expr *pAuthArg, /* Expression to pass to authorization callback */
  91526. Expr *pFilename, /* Name of database file */
  91527. Expr *pDbname, /* Name of the database to use internally */
  91528. Expr *pKey /* Database key for encryption extension */
  91529. ){
  91530. int rc;
  91531. NameContext sName;
  91532. Vdbe *v;
  91533. sqlite3* db = pParse->db;
  91534. int regArgs;
  91535. memset(&sName, 0, sizeof(NameContext));
  91536. sName.pParse = pParse;
  91537. if(
  91538. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pFilename)) ||
  91539. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pDbname)) ||
  91540. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pKey))
  91541. ){
  91542. goto attach_end;
  91543. }
  91544. #ifndef SQLITE_OMIT_AUTHORIZATION
  91545. if( pAuthArg ){
  91546. char *zAuthArg;
  91547. if( pAuthArg->op==TK_STRING ){
  91548. zAuthArg = pAuthArg->u.zToken;
  91549. }else{
  91550. zAuthArg = 0;
  91551. }
  91552. rc = sqlite3AuthCheck(pParse, type, zAuthArg, 0, 0);
  91553. if(rc!=SQLITE_OK ){
  91554. goto attach_end;
  91555. }
  91556. }
  91557. #endif /* SQLITE_OMIT_AUTHORIZATION */
  91558. v = sqlite3GetVdbe(pParse);
  91559. regArgs = sqlite3GetTempRange(pParse, 4);
  91560. sqlite3ExprCode(pParse, pFilename, regArgs);
  91561. sqlite3ExprCode(pParse, pDbname, regArgs+1);
  91562. sqlite3ExprCode(pParse, pKey, regArgs+2);
  91563. assert( v || db->mallocFailed );
  91564. if( v ){
  91565. sqlite3VdbeAddOp4(v, OP_Function0, 0, regArgs+3-pFunc->nArg, regArgs+3,
  91566. (char *)pFunc, P4_FUNCDEF);
  91567. assert( pFunc->nArg==-1 || (pFunc->nArg&0xff)==pFunc->nArg );
  91568. sqlite3VdbeChangeP5(v, (u8)(pFunc->nArg));
  91569. /* Code an OP_Expire. For an ATTACH statement, set P1 to true (expire this
  91570. ** statement only). For DETACH, set it to false (expire all existing
  91571. ** statements).
  91572. */
  91573. sqlite3VdbeAddOp1(v, OP_Expire, (type==SQLITE_ATTACH));
  91574. }
  91575. attach_end:
  91576. sqlite3ExprDelete(db, pFilename);
  91577. sqlite3ExprDelete(db, pDbname);
  91578. sqlite3ExprDelete(db, pKey);
  91579. }
  91580. /*
  91581. ** Called by the parser to compile a DETACH statement.
  91582. **
  91583. ** DETACH pDbname
  91584. */
  91585. SQLITE_PRIVATE void sqlite3Detach(Parse *pParse, Expr *pDbname){
  91586. static const FuncDef detach_func = {
  91587. 1, /* nArg */
  91588. SQLITE_UTF8, /* funcFlags */
  91589. 0, /* pUserData */
  91590. 0, /* pNext */
  91591. detachFunc, /* xSFunc */
  91592. 0, /* xFinalize */
  91593. "sqlite_detach", /* zName */
  91594. {0}
  91595. };
  91596. codeAttach(pParse, SQLITE_DETACH, &detach_func, pDbname, 0, 0, pDbname);
  91597. }
  91598. /*
  91599. ** Called by the parser to compile an ATTACH statement.
  91600. **
  91601. ** ATTACH p AS pDbname KEY pKey
  91602. */
  91603. SQLITE_PRIVATE void sqlite3Attach(Parse *pParse, Expr *p, Expr *pDbname, Expr *pKey){
  91604. static const FuncDef attach_func = {
  91605. 3, /* nArg */
  91606. SQLITE_UTF8, /* funcFlags */
  91607. 0, /* pUserData */
  91608. 0, /* pNext */
  91609. attachFunc, /* xSFunc */
  91610. 0, /* xFinalize */
  91611. "sqlite_attach", /* zName */
  91612. {0}
  91613. };
  91614. codeAttach(pParse, SQLITE_ATTACH, &attach_func, p, p, pDbname, pKey);
  91615. }
  91616. #endif /* SQLITE_OMIT_ATTACH */
  91617. /*
  91618. ** Initialize a DbFixer structure. This routine must be called prior
  91619. ** to passing the structure to one of the sqliteFixAAAA() routines below.
  91620. */
  91621. SQLITE_PRIVATE void sqlite3FixInit(
  91622. DbFixer *pFix, /* The fixer to be initialized */
  91623. Parse *pParse, /* Error messages will be written here */
  91624. int iDb, /* This is the database that must be used */
  91625. const char *zType, /* "view", "trigger", or "index" */
  91626. const Token *pName /* Name of the view, trigger, or index */
  91627. ){
  91628. sqlite3 *db;
  91629. db = pParse->db;
  91630. assert( db->nDb>iDb );
  91631. pFix->pParse = pParse;
  91632. pFix->zDb = db->aDb[iDb].zDbSName;
  91633. pFix->pSchema = db->aDb[iDb].pSchema;
  91634. pFix->zType = zType;
  91635. pFix->pName = pName;
  91636. pFix->bVarOnly = (iDb==1);
  91637. }
  91638. /*
  91639. ** The following set of routines walk through the parse tree and assign
  91640. ** a specific database to all table references where the database name
  91641. ** was left unspecified in the original SQL statement. The pFix structure
  91642. ** must have been initialized by a prior call to sqlite3FixInit().
  91643. **
  91644. ** These routines are used to make sure that an index, trigger, or
  91645. ** view in one database does not refer to objects in a different database.
  91646. ** (Exception: indices, triggers, and views in the TEMP database are
  91647. ** allowed to refer to anything.) If a reference is explicitly made
  91648. ** to an object in a different database, an error message is added to
  91649. ** pParse->zErrMsg and these routines return non-zero. If everything
  91650. ** checks out, these routines return 0.
  91651. */
  91652. SQLITE_PRIVATE int sqlite3FixSrcList(
  91653. DbFixer *pFix, /* Context of the fixation */
  91654. SrcList *pList /* The Source list to check and modify */
  91655. ){
  91656. int i;
  91657. const char *zDb;
  91658. struct SrcList_item *pItem;
  91659. if( NEVER(pList==0) ) return 0;
  91660. zDb = pFix->zDb;
  91661. for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
  91662. if( pFix->bVarOnly==0 ){
  91663. if( pItem->zDatabase && sqlite3StrICmp(pItem->zDatabase, zDb) ){
  91664. sqlite3ErrorMsg(pFix->pParse,
  91665. "%s %T cannot reference objects in database %s",
  91666. pFix->zType, pFix->pName, pItem->zDatabase);
  91667. return 1;
  91668. }
  91669. sqlite3DbFree(pFix->pParse->db, pItem->zDatabase);
  91670. pItem->zDatabase = 0;
  91671. pItem->pSchema = pFix->pSchema;
  91672. }
  91673. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER)
  91674. if( sqlite3FixSelect(pFix, pItem->pSelect) ) return 1;
  91675. if( sqlite3FixExpr(pFix, pItem->pOn) ) return 1;
  91676. #endif
  91677. }
  91678. return 0;
  91679. }
  91680. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER)
  91681. SQLITE_PRIVATE int sqlite3FixSelect(
  91682. DbFixer *pFix, /* Context of the fixation */
  91683. Select *pSelect /* The SELECT statement to be fixed to one database */
  91684. ){
  91685. while( pSelect ){
  91686. if( sqlite3FixExprList(pFix, pSelect->pEList) ){
  91687. return 1;
  91688. }
  91689. if( sqlite3FixSrcList(pFix, pSelect->pSrc) ){
  91690. return 1;
  91691. }
  91692. if( sqlite3FixExpr(pFix, pSelect->pWhere) ){
  91693. return 1;
  91694. }
  91695. if( sqlite3FixExprList(pFix, pSelect->pGroupBy) ){
  91696. return 1;
  91697. }
  91698. if( sqlite3FixExpr(pFix, pSelect->pHaving) ){
  91699. return 1;
  91700. }
  91701. if( sqlite3FixExprList(pFix, pSelect->pOrderBy) ){
  91702. return 1;
  91703. }
  91704. if( sqlite3FixExpr(pFix, pSelect->pLimit) ){
  91705. return 1;
  91706. }
  91707. if( sqlite3FixExpr(pFix, pSelect->pOffset) ){
  91708. return 1;
  91709. }
  91710. pSelect = pSelect->pPrior;
  91711. }
  91712. return 0;
  91713. }
  91714. SQLITE_PRIVATE int sqlite3FixExpr(
  91715. DbFixer *pFix, /* Context of the fixation */
  91716. Expr *pExpr /* The expression to be fixed to one database */
  91717. ){
  91718. while( pExpr ){
  91719. if( pExpr->op==TK_VARIABLE ){
  91720. if( pFix->pParse->db->init.busy ){
  91721. pExpr->op = TK_NULL;
  91722. }else{
  91723. sqlite3ErrorMsg(pFix->pParse, "%s cannot use variables", pFix->zType);
  91724. return 1;
  91725. }
  91726. }
  91727. if( ExprHasProperty(pExpr, EP_TokenOnly|EP_Leaf) ) break;
  91728. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  91729. if( sqlite3FixSelect(pFix, pExpr->x.pSelect) ) return 1;
  91730. }else{
  91731. if( sqlite3FixExprList(pFix, pExpr->x.pList) ) return 1;
  91732. }
  91733. if( sqlite3FixExpr(pFix, pExpr->pRight) ){
  91734. return 1;
  91735. }
  91736. pExpr = pExpr->pLeft;
  91737. }
  91738. return 0;
  91739. }
  91740. SQLITE_PRIVATE int sqlite3FixExprList(
  91741. DbFixer *pFix, /* Context of the fixation */
  91742. ExprList *pList /* The expression to be fixed to one database */
  91743. ){
  91744. int i;
  91745. struct ExprList_item *pItem;
  91746. if( pList==0 ) return 0;
  91747. for(i=0, pItem=pList->a; i<pList->nExpr; i++, pItem++){
  91748. if( sqlite3FixExpr(pFix, pItem->pExpr) ){
  91749. return 1;
  91750. }
  91751. }
  91752. return 0;
  91753. }
  91754. #endif
  91755. #ifndef SQLITE_OMIT_TRIGGER
  91756. SQLITE_PRIVATE int sqlite3FixTriggerStep(
  91757. DbFixer *pFix, /* Context of the fixation */
  91758. TriggerStep *pStep /* The trigger step be fixed to one database */
  91759. ){
  91760. while( pStep ){
  91761. if( sqlite3FixSelect(pFix, pStep->pSelect) ){
  91762. return 1;
  91763. }
  91764. if( sqlite3FixExpr(pFix, pStep->pWhere) ){
  91765. return 1;
  91766. }
  91767. if( sqlite3FixExprList(pFix, pStep->pExprList) ){
  91768. return 1;
  91769. }
  91770. pStep = pStep->pNext;
  91771. }
  91772. return 0;
  91773. }
  91774. #endif
  91775. /************** End of attach.c **********************************************/
  91776. /************** Begin file auth.c ********************************************/
  91777. /*
  91778. ** 2003 January 11
  91779. **
  91780. ** The author disclaims copyright to this source code. In place of
  91781. ** a legal notice, here is a blessing:
  91782. **
  91783. ** May you do good and not evil.
  91784. ** May you find forgiveness for yourself and forgive others.
  91785. ** May you share freely, never taking more than you give.
  91786. **
  91787. *************************************************************************
  91788. ** This file contains code used to implement the sqlite3_set_authorizer()
  91789. ** API. This facility is an optional feature of the library. Embedded
  91790. ** systems that do not need this facility may omit it by recompiling
  91791. ** the library with -DSQLITE_OMIT_AUTHORIZATION=1
  91792. */
  91793. /* #include "sqliteInt.h" */
  91794. /*
  91795. ** All of the code in this file may be omitted by defining a single
  91796. ** macro.
  91797. */
  91798. #ifndef SQLITE_OMIT_AUTHORIZATION
  91799. /*
  91800. ** Set or clear the access authorization function.
  91801. **
  91802. ** The access authorization function is be called during the compilation
  91803. ** phase to verify that the user has read and/or write access permission on
  91804. ** various fields of the database. The first argument to the auth function
  91805. ** is a copy of the 3rd argument to this routine. The second argument
  91806. ** to the auth function is one of these constants:
  91807. **
  91808. ** SQLITE_CREATE_INDEX
  91809. ** SQLITE_CREATE_TABLE
  91810. ** SQLITE_CREATE_TEMP_INDEX
  91811. ** SQLITE_CREATE_TEMP_TABLE
  91812. ** SQLITE_CREATE_TEMP_TRIGGER
  91813. ** SQLITE_CREATE_TEMP_VIEW
  91814. ** SQLITE_CREATE_TRIGGER
  91815. ** SQLITE_CREATE_VIEW
  91816. ** SQLITE_DELETE
  91817. ** SQLITE_DROP_INDEX
  91818. ** SQLITE_DROP_TABLE
  91819. ** SQLITE_DROP_TEMP_INDEX
  91820. ** SQLITE_DROP_TEMP_TABLE
  91821. ** SQLITE_DROP_TEMP_TRIGGER
  91822. ** SQLITE_DROP_TEMP_VIEW
  91823. ** SQLITE_DROP_TRIGGER
  91824. ** SQLITE_DROP_VIEW
  91825. ** SQLITE_INSERT
  91826. ** SQLITE_PRAGMA
  91827. ** SQLITE_READ
  91828. ** SQLITE_SELECT
  91829. ** SQLITE_TRANSACTION
  91830. ** SQLITE_UPDATE
  91831. **
  91832. ** The third and fourth arguments to the auth function are the name of
  91833. ** the table and the column that are being accessed. The auth function
  91834. ** should return either SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE. If
  91835. ** SQLITE_OK is returned, it means that access is allowed. SQLITE_DENY
  91836. ** means that the SQL statement will never-run - the sqlite3_exec() call
  91837. ** will return with an error. SQLITE_IGNORE means that the SQL statement
  91838. ** should run but attempts to read the specified column will return NULL
  91839. ** and attempts to write the column will be ignored.
  91840. **
  91841. ** Setting the auth function to NULL disables this hook. The default
  91842. ** setting of the auth function is NULL.
  91843. */
  91844. SQLITE_API int sqlite3_set_authorizer(
  91845. sqlite3 *db,
  91846. int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
  91847. void *pArg
  91848. ){
  91849. #ifdef SQLITE_ENABLE_API_ARMOR
  91850. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  91851. #endif
  91852. sqlite3_mutex_enter(db->mutex);
  91853. db->xAuth = (sqlite3_xauth)xAuth;
  91854. db->pAuthArg = pArg;
  91855. sqlite3ExpirePreparedStatements(db);
  91856. sqlite3_mutex_leave(db->mutex);
  91857. return SQLITE_OK;
  91858. }
  91859. /*
  91860. ** Write an error message into pParse->zErrMsg that explains that the
  91861. ** user-supplied authorization function returned an illegal value.
  91862. */
  91863. static void sqliteAuthBadReturnCode(Parse *pParse){
  91864. sqlite3ErrorMsg(pParse, "authorizer malfunction");
  91865. pParse->rc = SQLITE_ERROR;
  91866. }
  91867. /*
  91868. ** Invoke the authorization callback for permission to read column zCol from
  91869. ** table zTab in database zDb. This function assumes that an authorization
  91870. ** callback has been registered (i.e. that sqlite3.xAuth is not NULL).
  91871. **
  91872. ** If SQLITE_IGNORE is returned and pExpr is not NULL, then pExpr is changed
  91873. ** to an SQL NULL expression. Otherwise, if pExpr is NULL, then SQLITE_IGNORE
  91874. ** is treated as SQLITE_DENY. In this case an error is left in pParse.
  91875. */
  91876. SQLITE_PRIVATE int sqlite3AuthReadCol(
  91877. Parse *pParse, /* The parser context */
  91878. const char *zTab, /* Table name */
  91879. const char *zCol, /* Column name */
  91880. int iDb /* Index of containing database. */
  91881. ){
  91882. sqlite3 *db = pParse->db; /* Database handle */
  91883. char *zDb = db->aDb[iDb].zDbSName; /* Schema name of attached database */
  91884. int rc; /* Auth callback return code */
  91885. if( db->init.busy ) return SQLITE_OK;
  91886. rc = db->xAuth(db->pAuthArg, SQLITE_READ, zTab,zCol,zDb,pParse->zAuthContext
  91887. #ifdef SQLITE_USER_AUTHENTICATION
  91888. ,db->auth.zAuthUser
  91889. #endif
  91890. );
  91891. if( rc==SQLITE_DENY ){
  91892. if( db->nDb>2 || iDb!=0 ){
  91893. sqlite3ErrorMsg(pParse, "access to %s.%s.%s is prohibited",zDb,zTab,zCol);
  91894. }else{
  91895. sqlite3ErrorMsg(pParse, "access to %s.%s is prohibited", zTab, zCol);
  91896. }
  91897. pParse->rc = SQLITE_AUTH;
  91898. }else if( rc!=SQLITE_IGNORE && rc!=SQLITE_OK ){
  91899. sqliteAuthBadReturnCode(pParse);
  91900. }
  91901. return rc;
  91902. }
  91903. /*
  91904. ** The pExpr should be a TK_COLUMN expression. The table referred to
  91905. ** is in pTabList or else it is the NEW or OLD table of a trigger.
  91906. ** Check to see if it is OK to read this particular column.
  91907. **
  91908. ** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN
  91909. ** instruction into a TK_NULL. If the auth function returns SQLITE_DENY,
  91910. ** then generate an error.
  91911. */
  91912. SQLITE_PRIVATE void sqlite3AuthRead(
  91913. Parse *pParse, /* The parser context */
  91914. Expr *pExpr, /* The expression to check authorization on */
  91915. Schema *pSchema, /* The schema of the expression */
  91916. SrcList *pTabList /* All table that pExpr might refer to */
  91917. ){
  91918. sqlite3 *db = pParse->db;
  91919. Table *pTab = 0; /* The table being read */
  91920. const char *zCol; /* Name of the column of the table */
  91921. int iSrc; /* Index in pTabList->a[] of table being read */
  91922. int iDb; /* The index of the database the expression refers to */
  91923. int iCol; /* Index of column in table */
  91924. if( db->xAuth==0 ) return;
  91925. iDb = sqlite3SchemaToIndex(pParse->db, pSchema);
  91926. if( iDb<0 ){
  91927. /* An attempt to read a column out of a subquery or other
  91928. ** temporary table. */
  91929. return;
  91930. }
  91931. assert( pExpr->op==TK_COLUMN || pExpr->op==TK_TRIGGER );
  91932. if( pExpr->op==TK_TRIGGER ){
  91933. pTab = pParse->pTriggerTab;
  91934. }else{
  91935. assert( pTabList );
  91936. for(iSrc=0; ALWAYS(iSrc<pTabList->nSrc); iSrc++){
  91937. if( pExpr->iTable==pTabList->a[iSrc].iCursor ){
  91938. pTab = pTabList->a[iSrc].pTab;
  91939. break;
  91940. }
  91941. }
  91942. }
  91943. iCol = pExpr->iColumn;
  91944. if( NEVER(pTab==0) ) return;
  91945. if( iCol>=0 ){
  91946. assert( iCol<pTab->nCol );
  91947. zCol = pTab->aCol[iCol].zName;
  91948. }else if( pTab->iPKey>=0 ){
  91949. assert( pTab->iPKey<pTab->nCol );
  91950. zCol = pTab->aCol[pTab->iPKey].zName;
  91951. }else{
  91952. zCol = "ROWID";
  91953. }
  91954. assert( iDb>=0 && iDb<db->nDb );
  91955. if( SQLITE_IGNORE==sqlite3AuthReadCol(pParse, pTab->zName, zCol, iDb) ){
  91956. pExpr->op = TK_NULL;
  91957. }
  91958. }
  91959. /*
  91960. ** Do an authorization check using the code and arguments given. Return
  91961. ** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY
  91962. ** is returned, then the error count and error message in pParse are
  91963. ** modified appropriately.
  91964. */
  91965. SQLITE_PRIVATE int sqlite3AuthCheck(
  91966. Parse *pParse,
  91967. int code,
  91968. const char *zArg1,
  91969. const char *zArg2,
  91970. const char *zArg3
  91971. ){
  91972. sqlite3 *db = pParse->db;
  91973. int rc;
  91974. /* Don't do any authorization checks if the database is initialising
  91975. ** or if the parser is being invoked from within sqlite3_declare_vtab.
  91976. */
  91977. if( db->init.busy || IN_DECLARE_VTAB ){
  91978. return SQLITE_OK;
  91979. }
  91980. if( db->xAuth==0 ){
  91981. return SQLITE_OK;
  91982. }
  91983. rc = db->xAuth(db->pAuthArg, code, zArg1, zArg2, zArg3, pParse->zAuthContext
  91984. #ifdef SQLITE_USER_AUTHENTICATION
  91985. ,db->auth.zAuthUser
  91986. #endif
  91987. );
  91988. if( rc==SQLITE_DENY ){
  91989. sqlite3ErrorMsg(pParse, "not authorized");
  91990. pParse->rc = SQLITE_AUTH;
  91991. }else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){
  91992. rc = SQLITE_DENY;
  91993. sqliteAuthBadReturnCode(pParse);
  91994. }
  91995. return rc;
  91996. }
  91997. /*
  91998. ** Push an authorization context. After this routine is called, the
  91999. ** zArg3 argument to authorization callbacks will be zContext until
  92000. ** popped. Or if pParse==0, this routine is a no-op.
  92001. */
  92002. SQLITE_PRIVATE void sqlite3AuthContextPush(
  92003. Parse *pParse,
  92004. AuthContext *pContext,
  92005. const char *zContext
  92006. ){
  92007. assert( pParse );
  92008. pContext->pParse = pParse;
  92009. pContext->zAuthContext = pParse->zAuthContext;
  92010. pParse->zAuthContext = zContext;
  92011. }
  92012. /*
  92013. ** Pop an authorization context that was previously pushed
  92014. ** by sqlite3AuthContextPush
  92015. */
  92016. SQLITE_PRIVATE void sqlite3AuthContextPop(AuthContext *pContext){
  92017. if( pContext->pParse ){
  92018. pContext->pParse->zAuthContext = pContext->zAuthContext;
  92019. pContext->pParse = 0;
  92020. }
  92021. }
  92022. #endif /* SQLITE_OMIT_AUTHORIZATION */
  92023. /************** End of auth.c ************************************************/
  92024. /************** Begin file build.c *******************************************/
  92025. /*
  92026. ** 2001 September 15
  92027. **
  92028. ** The author disclaims copyright to this source code. In place of
  92029. ** a legal notice, here is a blessing:
  92030. **
  92031. ** May you do good and not evil.
  92032. ** May you find forgiveness for yourself and forgive others.
  92033. ** May you share freely, never taking more than you give.
  92034. **
  92035. *************************************************************************
  92036. ** This file contains C code routines that are called by the SQLite parser
  92037. ** when syntax rules are reduced. The routines in this file handle the
  92038. ** following kinds of SQL syntax:
  92039. **
  92040. ** CREATE TABLE
  92041. ** DROP TABLE
  92042. ** CREATE INDEX
  92043. ** DROP INDEX
  92044. ** creating ID lists
  92045. ** BEGIN TRANSACTION
  92046. ** COMMIT
  92047. ** ROLLBACK
  92048. */
  92049. /* #include "sqliteInt.h" */
  92050. #ifndef SQLITE_OMIT_SHARED_CACHE
  92051. /*
  92052. ** The TableLock structure is only used by the sqlite3TableLock() and
  92053. ** codeTableLocks() functions.
  92054. */
  92055. struct TableLock {
  92056. int iDb; /* The database containing the table to be locked */
  92057. int iTab; /* The root page of the table to be locked */
  92058. u8 isWriteLock; /* True for write lock. False for a read lock */
  92059. const char *zName; /* Name of the table */
  92060. };
  92061. /*
  92062. ** Record the fact that we want to lock a table at run-time.
  92063. **
  92064. ** The table to be locked has root page iTab and is found in database iDb.
  92065. ** A read or a write lock can be taken depending on isWritelock.
  92066. **
  92067. ** This routine just records the fact that the lock is desired. The
  92068. ** code to make the lock occur is generated by a later call to
  92069. ** codeTableLocks() which occurs during sqlite3FinishCoding().
  92070. */
  92071. SQLITE_PRIVATE void sqlite3TableLock(
  92072. Parse *pParse, /* Parsing context */
  92073. int iDb, /* Index of the database containing the table to lock */
  92074. int iTab, /* Root page number of the table to be locked */
  92075. u8 isWriteLock, /* True for a write lock */
  92076. const char *zName /* Name of the table to be locked */
  92077. ){
  92078. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  92079. int i;
  92080. int nBytes;
  92081. TableLock *p;
  92082. assert( iDb>=0 );
  92083. for(i=0; i<pToplevel->nTableLock; i++){
  92084. p = &pToplevel->aTableLock[i];
  92085. if( p->iDb==iDb && p->iTab==iTab ){
  92086. p->isWriteLock = (p->isWriteLock || isWriteLock);
  92087. return;
  92088. }
  92089. }
  92090. nBytes = sizeof(TableLock) * (pToplevel->nTableLock+1);
  92091. pToplevel->aTableLock =
  92092. sqlite3DbReallocOrFree(pToplevel->db, pToplevel->aTableLock, nBytes);
  92093. if( pToplevel->aTableLock ){
  92094. p = &pToplevel->aTableLock[pToplevel->nTableLock++];
  92095. p->iDb = iDb;
  92096. p->iTab = iTab;
  92097. p->isWriteLock = isWriteLock;
  92098. p->zName = zName;
  92099. }else{
  92100. pToplevel->nTableLock = 0;
  92101. sqlite3OomFault(pToplevel->db);
  92102. }
  92103. }
  92104. /*
  92105. ** Code an OP_TableLock instruction for each table locked by the
  92106. ** statement (configured by calls to sqlite3TableLock()).
  92107. */
  92108. static void codeTableLocks(Parse *pParse){
  92109. int i;
  92110. Vdbe *pVdbe;
  92111. pVdbe = sqlite3GetVdbe(pParse);
  92112. assert( pVdbe!=0 ); /* sqlite3GetVdbe cannot fail: VDBE already allocated */
  92113. for(i=0; i<pParse->nTableLock; i++){
  92114. TableLock *p = &pParse->aTableLock[i];
  92115. int p1 = p->iDb;
  92116. sqlite3VdbeAddOp4(pVdbe, OP_TableLock, p1, p->iTab, p->isWriteLock,
  92117. p->zName, P4_STATIC);
  92118. }
  92119. }
  92120. #else
  92121. #define codeTableLocks(x)
  92122. #endif
  92123. /*
  92124. ** Return TRUE if the given yDbMask object is empty - if it contains no
  92125. ** 1 bits. This routine is used by the DbMaskAllZero() and DbMaskNotZero()
  92126. ** macros when SQLITE_MAX_ATTACHED is greater than 30.
  92127. */
  92128. #if SQLITE_MAX_ATTACHED>30
  92129. SQLITE_PRIVATE int sqlite3DbMaskAllZero(yDbMask m){
  92130. int i;
  92131. for(i=0; i<sizeof(yDbMask); i++) if( m[i] ) return 0;
  92132. return 1;
  92133. }
  92134. #endif
  92135. /*
  92136. ** This routine is called after a single SQL statement has been
  92137. ** parsed and a VDBE program to execute that statement has been
  92138. ** prepared. This routine puts the finishing touches on the
  92139. ** VDBE program and resets the pParse structure for the next
  92140. ** parse.
  92141. **
  92142. ** Note that if an error occurred, it might be the case that
  92143. ** no VDBE code was generated.
  92144. */
  92145. SQLITE_PRIVATE void sqlite3FinishCoding(Parse *pParse){
  92146. sqlite3 *db;
  92147. Vdbe *v;
  92148. assert( pParse->pToplevel==0 );
  92149. db = pParse->db;
  92150. if( pParse->nested ) return;
  92151. if( db->mallocFailed || pParse->nErr ){
  92152. if( pParse->rc==SQLITE_OK ) pParse->rc = SQLITE_ERROR;
  92153. return;
  92154. }
  92155. /* Begin by generating some termination code at the end of the
  92156. ** vdbe program
  92157. */
  92158. v = sqlite3GetVdbe(pParse);
  92159. assert( !pParse->isMultiWrite
  92160. || sqlite3VdbeAssertMayAbort(v, pParse->mayAbort));
  92161. if( v ){
  92162. sqlite3VdbeAddOp0(v, OP_Halt);
  92163. #if SQLITE_USER_AUTHENTICATION
  92164. if( pParse->nTableLock>0 && db->init.busy==0 ){
  92165. sqlite3UserAuthInit(db);
  92166. if( db->auth.authLevel<UAUTH_User ){
  92167. sqlite3ErrorMsg(pParse, "user not authenticated");
  92168. pParse->rc = SQLITE_AUTH_USER;
  92169. return;
  92170. }
  92171. }
  92172. #endif
  92173. /* The cookie mask contains one bit for each database file open.
  92174. ** (Bit 0 is for main, bit 1 is for temp, and so forth.) Bits are
  92175. ** set for each database that is used. Generate code to start a
  92176. ** transaction on each used database and to verify the schema cookie
  92177. ** on each used database.
  92178. */
  92179. if( db->mallocFailed==0
  92180. && (DbMaskNonZero(pParse->cookieMask) || pParse->pConstExpr)
  92181. ){
  92182. int iDb, i;
  92183. assert( sqlite3VdbeGetOp(v, 0)->opcode==OP_Init );
  92184. sqlite3VdbeJumpHere(v, 0);
  92185. for(iDb=0; iDb<db->nDb; iDb++){
  92186. Schema *pSchema;
  92187. if( DbMaskTest(pParse->cookieMask, iDb)==0 ) continue;
  92188. sqlite3VdbeUsesBtree(v, iDb);
  92189. pSchema = db->aDb[iDb].pSchema;
  92190. sqlite3VdbeAddOp4Int(v,
  92191. OP_Transaction, /* Opcode */
  92192. iDb, /* P1 */
  92193. DbMaskTest(pParse->writeMask,iDb), /* P2 */
  92194. pSchema->schema_cookie, /* P3 */
  92195. pSchema->iGeneration /* P4 */
  92196. );
  92197. if( db->init.busy==0 ) sqlite3VdbeChangeP5(v, 1);
  92198. VdbeComment((v,
  92199. "usesStmtJournal=%d", pParse->mayAbort && pParse->isMultiWrite));
  92200. }
  92201. #ifndef SQLITE_OMIT_VIRTUALTABLE
  92202. for(i=0; i<pParse->nVtabLock; i++){
  92203. char *vtab = (char *)sqlite3GetVTable(db, pParse->apVtabLock[i]);
  92204. sqlite3VdbeAddOp4(v, OP_VBegin, 0, 0, 0, vtab, P4_VTAB);
  92205. }
  92206. pParse->nVtabLock = 0;
  92207. #endif
  92208. /* Once all the cookies have been verified and transactions opened,
  92209. ** obtain the required table-locks. This is a no-op unless the
  92210. ** shared-cache feature is enabled.
  92211. */
  92212. codeTableLocks(pParse);
  92213. /* Initialize any AUTOINCREMENT data structures required.
  92214. */
  92215. sqlite3AutoincrementBegin(pParse);
  92216. /* Code constant expressions that where factored out of inner loops */
  92217. if( pParse->pConstExpr ){
  92218. ExprList *pEL = pParse->pConstExpr;
  92219. pParse->okConstFactor = 0;
  92220. for(i=0; i<pEL->nExpr; i++){
  92221. sqlite3ExprCode(pParse, pEL->a[i].pExpr, pEL->a[i].u.iConstExprReg);
  92222. }
  92223. }
  92224. /* Finally, jump back to the beginning of the executable code. */
  92225. sqlite3VdbeGoto(v, 1);
  92226. }
  92227. }
  92228. /* Get the VDBE program ready for execution
  92229. */
  92230. if( v && pParse->nErr==0 && !db->mallocFailed ){
  92231. assert( pParse->iCacheLevel==0 ); /* Disables and re-enables match */
  92232. /* A minimum of one cursor is required if autoincrement is used
  92233. * See ticket [a696379c1f08866] */
  92234. if( pParse->pAinc!=0 && pParse->nTab==0 ) pParse->nTab = 1;
  92235. sqlite3VdbeMakeReady(v, pParse);
  92236. pParse->rc = SQLITE_DONE;
  92237. }else{
  92238. pParse->rc = SQLITE_ERROR;
  92239. }
  92240. }
  92241. /*
  92242. ** Run the parser and code generator recursively in order to generate
  92243. ** code for the SQL statement given onto the end of the pParse context
  92244. ** currently under construction. When the parser is run recursively
  92245. ** this way, the final OP_Halt is not appended and other initialization
  92246. ** and finalization steps are omitted because those are handling by the
  92247. ** outermost parser.
  92248. **
  92249. ** Not everything is nestable. This facility is designed to permit
  92250. ** INSERT, UPDATE, and DELETE operations against SQLITE_MASTER. Use
  92251. ** care if you decide to try to use this routine for some other purposes.
  92252. */
  92253. SQLITE_PRIVATE void sqlite3NestedParse(Parse *pParse, const char *zFormat, ...){
  92254. va_list ap;
  92255. char *zSql;
  92256. char *zErrMsg = 0;
  92257. sqlite3 *db = pParse->db;
  92258. char saveBuf[PARSE_TAIL_SZ];
  92259. if( pParse->nErr ) return;
  92260. assert( pParse->nested<10 ); /* Nesting should only be of limited depth */
  92261. va_start(ap, zFormat);
  92262. zSql = sqlite3VMPrintf(db, zFormat, ap);
  92263. va_end(ap);
  92264. if( zSql==0 ){
  92265. return; /* A malloc must have failed */
  92266. }
  92267. pParse->nested++;
  92268. memcpy(saveBuf, PARSE_TAIL(pParse), PARSE_TAIL_SZ);
  92269. memset(PARSE_TAIL(pParse), 0, PARSE_TAIL_SZ);
  92270. sqlite3RunParser(pParse, zSql, &zErrMsg);
  92271. sqlite3DbFree(db, zErrMsg);
  92272. sqlite3DbFree(db, zSql);
  92273. memcpy(PARSE_TAIL(pParse), saveBuf, PARSE_TAIL_SZ);
  92274. pParse->nested--;
  92275. }
  92276. #if SQLITE_USER_AUTHENTICATION
  92277. /*
  92278. ** Return TRUE if zTable is the name of the system table that stores the
  92279. ** list of users and their access credentials.
  92280. */
  92281. SQLITE_PRIVATE int sqlite3UserAuthTable(const char *zTable){
  92282. return sqlite3_stricmp(zTable, "sqlite_user")==0;
  92283. }
  92284. #endif
  92285. /*
  92286. ** Locate the in-memory structure that describes a particular database
  92287. ** table given the name of that table and (optionally) the name of the
  92288. ** database containing the table. Return NULL if not found.
  92289. **
  92290. ** If zDatabase is 0, all databases are searched for the table and the
  92291. ** first matching table is returned. (No checking for duplicate table
  92292. ** names is done.) The search order is TEMP first, then MAIN, then any
  92293. ** auxiliary databases added using the ATTACH command.
  92294. **
  92295. ** See also sqlite3LocateTable().
  92296. */
  92297. SQLITE_PRIVATE Table *sqlite3FindTable(sqlite3 *db, const char *zName, const char *zDatabase){
  92298. Table *p = 0;
  92299. int i;
  92300. /* All mutexes are required for schema access. Make sure we hold them. */
  92301. assert( zDatabase!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  92302. #if SQLITE_USER_AUTHENTICATION
  92303. /* Only the admin user is allowed to know that the sqlite_user table
  92304. ** exists */
  92305. if( db->auth.authLevel<UAUTH_Admin && sqlite3UserAuthTable(zName)!=0 ){
  92306. return 0;
  92307. }
  92308. #endif
  92309. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  92310. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  92311. if( zDatabase==0 || sqlite3StrICmp(zDatabase, db->aDb[j].zDbSName)==0 ){
  92312. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  92313. p = sqlite3HashFind(&db->aDb[j].pSchema->tblHash, zName);
  92314. if( p ) break;
  92315. }
  92316. }
  92317. return p;
  92318. }
  92319. /*
  92320. ** Locate the in-memory structure that describes a particular database
  92321. ** table given the name of that table and (optionally) the name of the
  92322. ** database containing the table. Return NULL if not found. Also leave an
  92323. ** error message in pParse->zErrMsg.
  92324. **
  92325. ** The difference between this routine and sqlite3FindTable() is that this
  92326. ** routine leaves an error message in pParse->zErrMsg where
  92327. ** sqlite3FindTable() does not.
  92328. */
  92329. SQLITE_PRIVATE Table *sqlite3LocateTable(
  92330. Parse *pParse, /* context in which to report errors */
  92331. u32 flags, /* LOCATE_VIEW or LOCATE_NOERR */
  92332. const char *zName, /* Name of the table we are looking for */
  92333. const char *zDbase /* Name of the database. Might be NULL */
  92334. ){
  92335. Table *p;
  92336. /* Read the database schema. If an error occurs, leave an error message
  92337. ** and code in pParse and return NULL. */
  92338. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  92339. return 0;
  92340. }
  92341. p = sqlite3FindTable(pParse->db, zName, zDbase);
  92342. if( p==0 ){
  92343. const char *zMsg = flags & LOCATE_VIEW ? "no such view" : "no such table";
  92344. #ifndef SQLITE_OMIT_VIRTUALTABLE
  92345. if( sqlite3FindDbName(pParse->db, zDbase)<1 ){
  92346. /* If zName is the not the name of a table in the schema created using
  92347. ** CREATE, then check to see if it is the name of an virtual table that
  92348. ** can be an eponymous virtual table. */
  92349. Module *pMod = (Module*)sqlite3HashFind(&pParse->db->aModule, zName);
  92350. if( pMod && sqlite3VtabEponymousTableInit(pParse, pMod) ){
  92351. return pMod->pEpoTab;
  92352. }
  92353. }
  92354. #endif
  92355. if( (flags & LOCATE_NOERR)==0 ){
  92356. if( zDbase ){
  92357. sqlite3ErrorMsg(pParse, "%s: %s.%s", zMsg, zDbase, zName);
  92358. }else{
  92359. sqlite3ErrorMsg(pParse, "%s: %s", zMsg, zName);
  92360. }
  92361. pParse->checkSchema = 1;
  92362. }
  92363. }
  92364. return p;
  92365. }
  92366. /*
  92367. ** Locate the table identified by *p.
  92368. **
  92369. ** This is a wrapper around sqlite3LocateTable(). The difference between
  92370. ** sqlite3LocateTable() and this function is that this function restricts
  92371. ** the search to schema (p->pSchema) if it is not NULL. p->pSchema may be
  92372. ** non-NULL if it is part of a view or trigger program definition. See
  92373. ** sqlite3FixSrcList() for details.
  92374. */
  92375. SQLITE_PRIVATE Table *sqlite3LocateTableItem(
  92376. Parse *pParse,
  92377. u32 flags,
  92378. struct SrcList_item *p
  92379. ){
  92380. const char *zDb;
  92381. assert( p->pSchema==0 || p->zDatabase==0 );
  92382. if( p->pSchema ){
  92383. int iDb = sqlite3SchemaToIndex(pParse->db, p->pSchema);
  92384. zDb = pParse->db->aDb[iDb].zDbSName;
  92385. }else{
  92386. zDb = p->zDatabase;
  92387. }
  92388. return sqlite3LocateTable(pParse, flags, p->zName, zDb);
  92389. }
  92390. /*
  92391. ** Locate the in-memory structure that describes
  92392. ** a particular index given the name of that index
  92393. ** and the name of the database that contains the index.
  92394. ** Return NULL if not found.
  92395. **
  92396. ** If zDatabase is 0, all databases are searched for the
  92397. ** table and the first matching index is returned. (No checking
  92398. ** for duplicate index names is done.) The search order is
  92399. ** TEMP first, then MAIN, then any auxiliary databases added
  92400. ** using the ATTACH command.
  92401. */
  92402. SQLITE_PRIVATE Index *sqlite3FindIndex(sqlite3 *db, const char *zName, const char *zDb){
  92403. Index *p = 0;
  92404. int i;
  92405. /* All mutexes are required for schema access. Make sure we hold them. */
  92406. assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  92407. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  92408. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  92409. Schema *pSchema = db->aDb[j].pSchema;
  92410. assert( pSchema );
  92411. if( zDb && sqlite3StrICmp(zDb, db->aDb[j].zDbSName) ) continue;
  92412. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  92413. p = sqlite3HashFind(&pSchema->idxHash, zName);
  92414. if( p ) break;
  92415. }
  92416. return p;
  92417. }
  92418. /*
  92419. ** Reclaim the memory used by an index
  92420. */
  92421. static void freeIndex(sqlite3 *db, Index *p){
  92422. #ifndef SQLITE_OMIT_ANALYZE
  92423. sqlite3DeleteIndexSamples(db, p);
  92424. #endif
  92425. sqlite3ExprDelete(db, p->pPartIdxWhere);
  92426. sqlite3ExprListDelete(db, p->aColExpr);
  92427. sqlite3DbFree(db, p->zColAff);
  92428. if( p->isResized ) sqlite3DbFree(db, (void *)p->azColl);
  92429. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  92430. sqlite3_free(p->aiRowEst);
  92431. #endif
  92432. sqlite3DbFree(db, p);
  92433. }
  92434. /*
  92435. ** For the index called zIdxName which is found in the database iDb,
  92436. ** unlike that index from its Table then remove the index from
  92437. ** the index hash table and free all memory structures associated
  92438. ** with the index.
  92439. */
  92440. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteIndex(sqlite3 *db, int iDb, const char *zIdxName){
  92441. Index *pIndex;
  92442. Hash *pHash;
  92443. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  92444. pHash = &db->aDb[iDb].pSchema->idxHash;
  92445. pIndex = sqlite3HashInsert(pHash, zIdxName, 0);
  92446. if( ALWAYS(pIndex) ){
  92447. if( pIndex->pTable->pIndex==pIndex ){
  92448. pIndex->pTable->pIndex = pIndex->pNext;
  92449. }else{
  92450. Index *p;
  92451. /* Justification of ALWAYS(); The index must be on the list of
  92452. ** indices. */
  92453. p = pIndex->pTable->pIndex;
  92454. while( ALWAYS(p) && p->pNext!=pIndex ){ p = p->pNext; }
  92455. if( ALWAYS(p && p->pNext==pIndex) ){
  92456. p->pNext = pIndex->pNext;
  92457. }
  92458. }
  92459. freeIndex(db, pIndex);
  92460. }
  92461. db->flags |= SQLITE_InternChanges;
  92462. }
  92463. /*
  92464. ** Look through the list of open database files in db->aDb[] and if
  92465. ** any have been closed, remove them from the list. Reallocate the
  92466. ** db->aDb[] structure to a smaller size, if possible.
  92467. **
  92468. ** Entry 0 (the "main" database) and entry 1 (the "temp" database)
  92469. ** are never candidates for being collapsed.
  92470. */
  92471. SQLITE_PRIVATE void sqlite3CollapseDatabaseArray(sqlite3 *db){
  92472. int i, j;
  92473. for(i=j=2; i<db->nDb; i++){
  92474. struct Db *pDb = &db->aDb[i];
  92475. if( pDb->pBt==0 ){
  92476. sqlite3DbFree(db, pDb->zDbSName);
  92477. pDb->zDbSName = 0;
  92478. continue;
  92479. }
  92480. if( j<i ){
  92481. db->aDb[j] = db->aDb[i];
  92482. }
  92483. j++;
  92484. }
  92485. db->nDb = j;
  92486. if( db->nDb<=2 && db->aDb!=db->aDbStatic ){
  92487. memcpy(db->aDbStatic, db->aDb, 2*sizeof(db->aDb[0]));
  92488. sqlite3DbFree(db, db->aDb);
  92489. db->aDb = db->aDbStatic;
  92490. }
  92491. }
  92492. /*
  92493. ** Reset the schema for the database at index iDb. Also reset the
  92494. ** TEMP schema.
  92495. */
  92496. SQLITE_PRIVATE void sqlite3ResetOneSchema(sqlite3 *db, int iDb){
  92497. Db *pDb;
  92498. assert( iDb<db->nDb );
  92499. /* Case 1: Reset the single schema identified by iDb */
  92500. pDb = &db->aDb[iDb];
  92501. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  92502. assert( pDb->pSchema!=0 );
  92503. sqlite3SchemaClear(pDb->pSchema);
  92504. /* If any database other than TEMP is reset, then also reset TEMP
  92505. ** since TEMP might be holding triggers that reference tables in the
  92506. ** other database.
  92507. */
  92508. if( iDb!=1 ){
  92509. pDb = &db->aDb[1];
  92510. assert( pDb->pSchema!=0 );
  92511. sqlite3SchemaClear(pDb->pSchema);
  92512. }
  92513. return;
  92514. }
  92515. /*
  92516. ** Erase all schema information from all attached databases (including
  92517. ** "main" and "temp") for a single database connection.
  92518. */
  92519. SQLITE_PRIVATE void sqlite3ResetAllSchemasOfConnection(sqlite3 *db){
  92520. int i;
  92521. sqlite3BtreeEnterAll(db);
  92522. for(i=0; i<db->nDb; i++){
  92523. Db *pDb = &db->aDb[i];
  92524. if( pDb->pSchema ){
  92525. sqlite3SchemaClear(pDb->pSchema);
  92526. }
  92527. }
  92528. db->flags &= ~SQLITE_InternChanges;
  92529. sqlite3VtabUnlockList(db);
  92530. sqlite3BtreeLeaveAll(db);
  92531. sqlite3CollapseDatabaseArray(db);
  92532. }
  92533. /*
  92534. ** This routine is called when a commit occurs.
  92535. */
  92536. SQLITE_PRIVATE void sqlite3CommitInternalChanges(sqlite3 *db){
  92537. db->flags &= ~SQLITE_InternChanges;
  92538. }
  92539. /*
  92540. ** Delete memory allocated for the column names of a table or view (the
  92541. ** Table.aCol[] array).
  92542. */
  92543. SQLITE_PRIVATE void sqlite3DeleteColumnNames(sqlite3 *db, Table *pTable){
  92544. int i;
  92545. Column *pCol;
  92546. assert( pTable!=0 );
  92547. if( (pCol = pTable->aCol)!=0 ){
  92548. for(i=0; i<pTable->nCol; i++, pCol++){
  92549. sqlite3DbFree(db, pCol->zName);
  92550. sqlite3ExprDelete(db, pCol->pDflt);
  92551. sqlite3DbFree(db, pCol->zColl);
  92552. }
  92553. sqlite3DbFree(db, pTable->aCol);
  92554. }
  92555. }
  92556. /*
  92557. ** Remove the memory data structures associated with the given
  92558. ** Table. No changes are made to disk by this routine.
  92559. **
  92560. ** This routine just deletes the data structure. It does not unlink
  92561. ** the table data structure from the hash table. But it does destroy
  92562. ** memory structures of the indices and foreign keys associated with
  92563. ** the table.
  92564. **
  92565. ** The db parameter is optional. It is needed if the Table object
  92566. ** contains lookaside memory. (Table objects in the schema do not use
  92567. ** lookaside memory, but some ephemeral Table objects do.) Or the
  92568. ** db parameter can be used with db->pnBytesFreed to measure the memory
  92569. ** used by the Table object.
  92570. */
  92571. static void SQLITE_NOINLINE deleteTable(sqlite3 *db, Table *pTable){
  92572. Index *pIndex, *pNext;
  92573. TESTONLY( int nLookaside; ) /* Used to verify lookaside not used for schema */
  92574. /* Record the number of outstanding lookaside allocations in schema Tables
  92575. ** prior to doing any free() operations. Since schema Tables do not use
  92576. ** lookaside, this number should not change. */
  92577. TESTONLY( nLookaside = (db && (pTable->tabFlags & TF_Ephemeral)==0) ?
  92578. db->lookaside.nOut : 0 );
  92579. /* Delete all indices associated with this table. */
  92580. for(pIndex = pTable->pIndex; pIndex; pIndex=pNext){
  92581. pNext = pIndex->pNext;
  92582. assert( pIndex->pSchema==pTable->pSchema
  92583. || (IsVirtual(pTable) && pIndex->idxType!=SQLITE_IDXTYPE_APPDEF) );
  92584. if( (db==0 || db->pnBytesFreed==0) && !IsVirtual(pTable) ){
  92585. char *zName = pIndex->zName;
  92586. TESTONLY ( Index *pOld = ) sqlite3HashInsert(
  92587. &pIndex->pSchema->idxHash, zName, 0
  92588. );
  92589. assert( db==0 || sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
  92590. assert( pOld==pIndex || pOld==0 );
  92591. }
  92592. freeIndex(db, pIndex);
  92593. }
  92594. /* Delete any foreign keys attached to this table. */
  92595. sqlite3FkDelete(db, pTable);
  92596. /* Delete the Table structure itself.
  92597. */
  92598. sqlite3DeleteColumnNames(db, pTable);
  92599. sqlite3DbFree(db, pTable->zName);
  92600. sqlite3DbFree(db, pTable->zColAff);
  92601. sqlite3SelectDelete(db, pTable->pSelect);
  92602. sqlite3ExprListDelete(db, pTable->pCheck);
  92603. #ifndef SQLITE_OMIT_VIRTUALTABLE
  92604. sqlite3VtabClear(db, pTable);
  92605. #endif
  92606. sqlite3DbFree(db, pTable);
  92607. /* Verify that no lookaside memory was used by schema tables */
  92608. assert( nLookaside==0 || nLookaside==db->lookaside.nOut );
  92609. }
  92610. SQLITE_PRIVATE void sqlite3DeleteTable(sqlite3 *db, Table *pTable){
  92611. /* Do not delete the table until the reference count reaches zero. */
  92612. if( !pTable ) return;
  92613. if( ((!db || db->pnBytesFreed==0) && (--pTable->nRef)>0) ) return;
  92614. deleteTable(db, pTable);
  92615. }
  92616. /*
  92617. ** Unlink the given table from the hash tables and the delete the
  92618. ** table structure with all its indices and foreign keys.
  92619. */
  92620. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTable(sqlite3 *db, int iDb, const char *zTabName){
  92621. Table *p;
  92622. Db *pDb;
  92623. assert( db!=0 );
  92624. assert( iDb>=0 && iDb<db->nDb );
  92625. assert( zTabName );
  92626. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  92627. testcase( zTabName[0]==0 ); /* Zero-length table names are allowed */
  92628. pDb = &db->aDb[iDb];
  92629. p = sqlite3HashInsert(&pDb->pSchema->tblHash, zTabName, 0);
  92630. sqlite3DeleteTable(db, p);
  92631. db->flags |= SQLITE_InternChanges;
  92632. }
  92633. /*
  92634. ** Given a token, return a string that consists of the text of that
  92635. ** token. Space to hold the returned string
  92636. ** is obtained from sqliteMalloc() and must be freed by the calling
  92637. ** function.
  92638. **
  92639. ** Any quotation marks (ex: "name", 'name', [name], or `name`) that
  92640. ** surround the body of the token are removed.
  92641. **
  92642. ** Tokens are often just pointers into the original SQL text and so
  92643. ** are not \000 terminated and are not persistent. The returned string
  92644. ** is \000 terminated and is persistent.
  92645. */
  92646. SQLITE_PRIVATE char *sqlite3NameFromToken(sqlite3 *db, Token *pName){
  92647. char *zName;
  92648. if( pName ){
  92649. zName = sqlite3DbStrNDup(db, (char*)pName->z, pName->n);
  92650. sqlite3Dequote(zName);
  92651. }else{
  92652. zName = 0;
  92653. }
  92654. return zName;
  92655. }
  92656. /*
  92657. ** Open the sqlite_master table stored in database number iDb for
  92658. ** writing. The table is opened using cursor 0.
  92659. */
  92660. SQLITE_PRIVATE void sqlite3OpenMasterTable(Parse *p, int iDb){
  92661. Vdbe *v = sqlite3GetVdbe(p);
  92662. sqlite3TableLock(p, iDb, MASTER_ROOT, 1, SCHEMA_TABLE(iDb));
  92663. sqlite3VdbeAddOp4Int(v, OP_OpenWrite, 0, MASTER_ROOT, iDb, 5);
  92664. if( p->nTab==0 ){
  92665. p->nTab = 1;
  92666. }
  92667. }
  92668. /*
  92669. ** Parameter zName points to a nul-terminated buffer containing the name
  92670. ** of a database ("main", "temp" or the name of an attached db). This
  92671. ** function returns the index of the named database in db->aDb[], or
  92672. ** -1 if the named db cannot be found.
  92673. */
  92674. SQLITE_PRIVATE int sqlite3FindDbName(sqlite3 *db, const char *zName){
  92675. int i = -1; /* Database number */
  92676. if( zName ){
  92677. Db *pDb;
  92678. for(i=(db->nDb-1), pDb=&db->aDb[i]; i>=0; i--, pDb--){
  92679. if( 0==sqlite3StrICmp(pDb->zDbSName, zName) ) break;
  92680. }
  92681. }
  92682. return i;
  92683. }
  92684. /*
  92685. ** The token *pName contains the name of a database (either "main" or
  92686. ** "temp" or the name of an attached db). This routine returns the
  92687. ** index of the named database in db->aDb[], or -1 if the named db
  92688. ** does not exist.
  92689. */
  92690. SQLITE_PRIVATE int sqlite3FindDb(sqlite3 *db, Token *pName){
  92691. int i; /* Database number */
  92692. char *zName; /* Name we are searching for */
  92693. zName = sqlite3NameFromToken(db, pName);
  92694. i = sqlite3FindDbName(db, zName);
  92695. sqlite3DbFree(db, zName);
  92696. return i;
  92697. }
  92698. /* The table or view or trigger name is passed to this routine via tokens
  92699. ** pName1 and pName2. If the table name was fully qualified, for example:
  92700. **
  92701. ** CREATE TABLE xxx.yyy (...);
  92702. **
  92703. ** Then pName1 is set to "xxx" and pName2 "yyy". On the other hand if
  92704. ** the table name is not fully qualified, i.e.:
  92705. **
  92706. ** CREATE TABLE yyy(...);
  92707. **
  92708. ** Then pName1 is set to "yyy" and pName2 is "".
  92709. **
  92710. ** This routine sets the *ppUnqual pointer to point at the token (pName1 or
  92711. ** pName2) that stores the unqualified table name. The index of the
  92712. ** database "xxx" is returned.
  92713. */
  92714. SQLITE_PRIVATE int sqlite3TwoPartName(
  92715. Parse *pParse, /* Parsing and code generating context */
  92716. Token *pName1, /* The "xxx" in the name "xxx.yyy" or "xxx" */
  92717. Token *pName2, /* The "yyy" in the name "xxx.yyy" */
  92718. Token **pUnqual /* Write the unqualified object name here */
  92719. ){
  92720. int iDb; /* Database holding the object */
  92721. sqlite3 *db = pParse->db;
  92722. assert( pName2!=0 );
  92723. if( pName2->n>0 ){
  92724. if( db->init.busy ) {
  92725. sqlite3ErrorMsg(pParse, "corrupt database");
  92726. return -1;
  92727. }
  92728. *pUnqual = pName2;
  92729. iDb = sqlite3FindDb(db, pName1);
  92730. if( iDb<0 ){
  92731. sqlite3ErrorMsg(pParse, "unknown database %T", pName1);
  92732. return -1;
  92733. }
  92734. }else{
  92735. assert( db->init.iDb==0 || db->init.busy || (db->flags & SQLITE_Vacuum)!=0);
  92736. iDb = db->init.iDb;
  92737. *pUnqual = pName1;
  92738. }
  92739. return iDb;
  92740. }
  92741. /*
  92742. ** This routine is used to check if the UTF-8 string zName is a legal
  92743. ** unqualified name for a new schema object (table, index, view or
  92744. ** trigger). All names are legal except those that begin with the string
  92745. ** "sqlite_" (in upper, lower or mixed case). This portion of the namespace
  92746. ** is reserved for internal use.
  92747. */
  92748. SQLITE_PRIVATE int sqlite3CheckObjectName(Parse *pParse, const char *zName){
  92749. if( !pParse->db->init.busy && pParse->nested==0
  92750. && (pParse->db->flags & SQLITE_WriteSchema)==0
  92751. && 0==sqlite3StrNICmp(zName, "sqlite_", 7) ){
  92752. sqlite3ErrorMsg(pParse, "object name reserved for internal use: %s", zName);
  92753. return SQLITE_ERROR;
  92754. }
  92755. return SQLITE_OK;
  92756. }
  92757. /*
  92758. ** Return the PRIMARY KEY index of a table
  92759. */
  92760. SQLITE_PRIVATE Index *sqlite3PrimaryKeyIndex(Table *pTab){
  92761. Index *p;
  92762. for(p=pTab->pIndex; p && !IsPrimaryKeyIndex(p); p=p->pNext){}
  92763. return p;
  92764. }
  92765. /*
  92766. ** Return the column of index pIdx that corresponds to table
  92767. ** column iCol. Return -1 if not found.
  92768. */
  92769. SQLITE_PRIVATE i16 sqlite3ColumnOfIndex(Index *pIdx, i16 iCol){
  92770. int i;
  92771. for(i=0; i<pIdx->nColumn; i++){
  92772. if( iCol==pIdx->aiColumn[i] ) return i;
  92773. }
  92774. return -1;
  92775. }
  92776. /*
  92777. ** Begin constructing a new table representation in memory. This is
  92778. ** the first of several action routines that get called in response
  92779. ** to a CREATE TABLE statement. In particular, this routine is called
  92780. ** after seeing tokens "CREATE" and "TABLE" and the table name. The isTemp
  92781. ** flag is true if the table should be stored in the auxiliary database
  92782. ** file instead of in the main database file. This is normally the case
  92783. ** when the "TEMP" or "TEMPORARY" keyword occurs in between
  92784. ** CREATE and TABLE.
  92785. **
  92786. ** The new table record is initialized and put in pParse->pNewTable.
  92787. ** As more of the CREATE TABLE statement is parsed, additional action
  92788. ** routines will be called to add more information to this record.
  92789. ** At the end of the CREATE TABLE statement, the sqlite3EndTable() routine
  92790. ** is called to complete the construction of the new table record.
  92791. */
  92792. SQLITE_PRIVATE void sqlite3StartTable(
  92793. Parse *pParse, /* Parser context */
  92794. Token *pName1, /* First part of the name of the table or view */
  92795. Token *pName2, /* Second part of the name of the table or view */
  92796. int isTemp, /* True if this is a TEMP table */
  92797. int isView, /* True if this is a VIEW */
  92798. int isVirtual, /* True if this is a VIRTUAL table */
  92799. int noErr /* Do nothing if table already exists */
  92800. ){
  92801. Table *pTable;
  92802. char *zName = 0; /* The name of the new table */
  92803. sqlite3 *db = pParse->db;
  92804. Vdbe *v;
  92805. int iDb; /* Database number to create the table in */
  92806. Token *pName; /* Unqualified name of the table to create */
  92807. if( db->init.busy && db->init.newTnum==1 ){
  92808. /* Special case: Parsing the sqlite_master or sqlite_temp_master schema */
  92809. iDb = db->init.iDb;
  92810. zName = sqlite3DbStrDup(db, SCHEMA_TABLE(iDb));
  92811. pName = pName1;
  92812. }else{
  92813. /* The common case */
  92814. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  92815. if( iDb<0 ) return;
  92816. if( !OMIT_TEMPDB && isTemp && pName2->n>0 && iDb!=1 ){
  92817. /* If creating a temp table, the name may not be qualified. Unless
  92818. ** the database name is "temp" anyway. */
  92819. sqlite3ErrorMsg(pParse, "temporary table name must be unqualified");
  92820. return;
  92821. }
  92822. if( !OMIT_TEMPDB && isTemp ) iDb = 1;
  92823. zName = sqlite3NameFromToken(db, pName);
  92824. }
  92825. pParse->sNameToken = *pName;
  92826. if( zName==0 ) return;
  92827. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  92828. goto begin_table_error;
  92829. }
  92830. if( db->init.iDb==1 ) isTemp = 1;
  92831. #ifndef SQLITE_OMIT_AUTHORIZATION
  92832. assert( isTemp==0 || isTemp==1 );
  92833. assert( isView==0 || isView==1 );
  92834. {
  92835. static const u8 aCode[] = {
  92836. SQLITE_CREATE_TABLE,
  92837. SQLITE_CREATE_TEMP_TABLE,
  92838. SQLITE_CREATE_VIEW,
  92839. SQLITE_CREATE_TEMP_VIEW
  92840. };
  92841. char *zDb = db->aDb[iDb].zDbSName;
  92842. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(isTemp), 0, zDb) ){
  92843. goto begin_table_error;
  92844. }
  92845. if( !isVirtual && sqlite3AuthCheck(pParse, (int)aCode[isTemp+2*isView],
  92846. zName, 0, zDb) ){
  92847. goto begin_table_error;
  92848. }
  92849. }
  92850. #endif
  92851. /* Make sure the new table name does not collide with an existing
  92852. ** index or table name in the same database. Issue an error message if
  92853. ** it does. The exception is if the statement being parsed was passed
  92854. ** to an sqlite3_declare_vtab() call. In that case only the column names
  92855. ** and types will be used, so there is no need to test for namespace
  92856. ** collisions.
  92857. */
  92858. if( !IN_DECLARE_VTAB ){
  92859. char *zDb = db->aDb[iDb].zDbSName;
  92860. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  92861. goto begin_table_error;
  92862. }
  92863. pTable = sqlite3FindTable(db, zName, zDb);
  92864. if( pTable ){
  92865. if( !noErr ){
  92866. sqlite3ErrorMsg(pParse, "table %T already exists", pName);
  92867. }else{
  92868. assert( !db->init.busy || CORRUPT_DB );
  92869. sqlite3CodeVerifySchema(pParse, iDb);
  92870. }
  92871. goto begin_table_error;
  92872. }
  92873. if( sqlite3FindIndex(db, zName, zDb)!=0 ){
  92874. sqlite3ErrorMsg(pParse, "there is already an index named %s", zName);
  92875. goto begin_table_error;
  92876. }
  92877. }
  92878. pTable = sqlite3DbMallocZero(db, sizeof(Table));
  92879. if( pTable==0 ){
  92880. assert( db->mallocFailed );
  92881. pParse->rc = SQLITE_NOMEM_BKPT;
  92882. pParse->nErr++;
  92883. goto begin_table_error;
  92884. }
  92885. pTable->zName = zName;
  92886. pTable->iPKey = -1;
  92887. pTable->pSchema = db->aDb[iDb].pSchema;
  92888. pTable->nRef = 1;
  92889. pTable->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  92890. assert( pParse->pNewTable==0 );
  92891. pParse->pNewTable = pTable;
  92892. /* If this is the magic sqlite_sequence table used by autoincrement,
  92893. ** then record a pointer to this table in the main database structure
  92894. ** so that INSERT can find the table easily.
  92895. */
  92896. #ifndef SQLITE_OMIT_AUTOINCREMENT
  92897. if( !pParse->nested && strcmp(zName, "sqlite_sequence")==0 ){
  92898. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  92899. pTable->pSchema->pSeqTab = pTable;
  92900. }
  92901. #endif
  92902. /* Begin generating the code that will insert the table record into
  92903. ** the SQLITE_MASTER table. Note in particular that we must go ahead
  92904. ** and allocate the record number for the table entry now. Before any
  92905. ** PRIMARY KEY or UNIQUE keywords are parsed. Those keywords will cause
  92906. ** indices to be created and the table record must come before the
  92907. ** indices. Hence, the record number for the table must be allocated
  92908. ** now.
  92909. */
  92910. if( !db->init.busy && (v = sqlite3GetVdbe(pParse))!=0 ){
  92911. int addr1;
  92912. int fileFormat;
  92913. int reg1, reg2, reg3;
  92914. /* nullRow[] is an OP_Record encoding of a row containing 5 NULLs */
  92915. static const char nullRow[] = { 6, 0, 0, 0, 0, 0 };
  92916. sqlite3BeginWriteOperation(pParse, 1, iDb);
  92917. #ifndef SQLITE_OMIT_VIRTUALTABLE
  92918. if( isVirtual ){
  92919. sqlite3VdbeAddOp0(v, OP_VBegin);
  92920. }
  92921. #endif
  92922. /* If the file format and encoding in the database have not been set,
  92923. ** set them now.
  92924. */
  92925. reg1 = pParse->regRowid = ++pParse->nMem;
  92926. reg2 = pParse->regRoot = ++pParse->nMem;
  92927. reg3 = ++pParse->nMem;
  92928. sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, reg3, BTREE_FILE_FORMAT);
  92929. sqlite3VdbeUsesBtree(v, iDb);
  92930. addr1 = sqlite3VdbeAddOp1(v, OP_If, reg3); VdbeCoverage(v);
  92931. fileFormat = (db->flags & SQLITE_LegacyFileFmt)!=0 ?
  92932. 1 : SQLITE_MAX_FILE_FORMAT;
  92933. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, fileFormat);
  92934. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_TEXT_ENCODING, ENC(db));
  92935. sqlite3VdbeJumpHere(v, addr1);
  92936. /* This just creates a place-holder record in the sqlite_master table.
  92937. ** The record created does not contain anything yet. It will be replaced
  92938. ** by the real entry in code generated at sqlite3EndTable().
  92939. **
  92940. ** The rowid for the new entry is left in register pParse->regRowid.
  92941. ** The root page number of the new table is left in reg pParse->regRoot.
  92942. ** The rowid and root page number values are needed by the code that
  92943. ** sqlite3EndTable will generate.
  92944. */
  92945. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  92946. if( isView || isVirtual ){
  92947. sqlite3VdbeAddOp2(v, OP_Integer, 0, reg2);
  92948. }else
  92949. #endif
  92950. {
  92951. pParse->addrCrTab = sqlite3VdbeAddOp2(v, OP_CreateTable, iDb, reg2);
  92952. }
  92953. sqlite3OpenMasterTable(pParse, iDb);
  92954. sqlite3VdbeAddOp2(v, OP_NewRowid, 0, reg1);
  92955. sqlite3VdbeAddOp4(v, OP_Blob, 6, reg3, 0, nullRow, P4_STATIC);
  92956. sqlite3VdbeAddOp3(v, OP_Insert, 0, reg3, reg1);
  92957. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  92958. sqlite3VdbeAddOp0(v, OP_Close);
  92959. }
  92960. /* Normal (non-error) return. */
  92961. return;
  92962. /* If an error occurs, we jump here */
  92963. begin_table_error:
  92964. sqlite3DbFree(db, zName);
  92965. return;
  92966. }
  92967. /* Set properties of a table column based on the (magical)
  92968. ** name of the column.
  92969. */
  92970. #if SQLITE_ENABLE_HIDDEN_COLUMNS
  92971. SQLITE_PRIVATE void sqlite3ColumnPropertiesFromName(Table *pTab, Column *pCol){
  92972. if( sqlite3_strnicmp(pCol->zName, "__hidden__", 10)==0 ){
  92973. pCol->colFlags |= COLFLAG_HIDDEN;
  92974. }else if( pTab && pCol!=pTab->aCol && (pCol[-1].colFlags & COLFLAG_HIDDEN) ){
  92975. pTab->tabFlags |= TF_OOOHidden;
  92976. }
  92977. }
  92978. #endif
  92979. /*
  92980. ** Add a new column to the table currently being constructed.
  92981. **
  92982. ** The parser calls this routine once for each column declaration
  92983. ** in a CREATE TABLE statement. sqlite3StartTable() gets called
  92984. ** first to get things going. Then this routine is called for each
  92985. ** column.
  92986. */
  92987. SQLITE_PRIVATE void sqlite3AddColumn(Parse *pParse, Token *pName, Token *pType){
  92988. Table *p;
  92989. int i;
  92990. char *z;
  92991. char *zType;
  92992. Column *pCol;
  92993. sqlite3 *db = pParse->db;
  92994. if( (p = pParse->pNewTable)==0 ) return;
  92995. #if SQLITE_MAX_COLUMN
  92996. if( p->nCol+1>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  92997. sqlite3ErrorMsg(pParse, "too many columns on %s", p->zName);
  92998. return;
  92999. }
  93000. #endif
  93001. z = sqlite3DbMallocRaw(db, pName->n + pType->n + 2);
  93002. if( z==0 ) return;
  93003. memcpy(z, pName->z, pName->n);
  93004. z[pName->n] = 0;
  93005. sqlite3Dequote(z);
  93006. for(i=0; i<p->nCol; i++){
  93007. if( sqlite3_stricmp(z, p->aCol[i].zName)==0 ){
  93008. sqlite3ErrorMsg(pParse, "duplicate column name: %s", z);
  93009. sqlite3DbFree(db, z);
  93010. return;
  93011. }
  93012. }
  93013. if( (p->nCol & 0x7)==0 ){
  93014. Column *aNew;
  93015. aNew = sqlite3DbRealloc(db,p->aCol,(p->nCol+8)*sizeof(p->aCol[0]));
  93016. if( aNew==0 ){
  93017. sqlite3DbFree(db, z);
  93018. return;
  93019. }
  93020. p->aCol = aNew;
  93021. }
  93022. pCol = &p->aCol[p->nCol];
  93023. memset(pCol, 0, sizeof(p->aCol[0]));
  93024. pCol->zName = z;
  93025. sqlite3ColumnPropertiesFromName(p, pCol);
  93026. if( pType->n==0 ){
  93027. /* If there is no type specified, columns have the default affinity
  93028. ** 'BLOB'. */
  93029. pCol->affinity = SQLITE_AFF_BLOB;
  93030. pCol->szEst = 1;
  93031. }else{
  93032. zType = z + sqlite3Strlen30(z) + 1;
  93033. memcpy(zType, pType->z, pType->n);
  93034. zType[pType->n] = 0;
  93035. sqlite3Dequote(zType);
  93036. pCol->affinity = sqlite3AffinityType(zType, &pCol->szEst);
  93037. pCol->colFlags |= COLFLAG_HASTYPE;
  93038. }
  93039. p->nCol++;
  93040. pParse->constraintName.n = 0;
  93041. }
  93042. /*
  93043. ** This routine is called by the parser while in the middle of
  93044. ** parsing a CREATE TABLE statement. A "NOT NULL" constraint has
  93045. ** been seen on a column. This routine sets the notNull flag on
  93046. ** the column currently under construction.
  93047. */
  93048. SQLITE_PRIVATE void sqlite3AddNotNull(Parse *pParse, int onError){
  93049. Table *p;
  93050. p = pParse->pNewTable;
  93051. if( p==0 || NEVER(p->nCol<1) ) return;
  93052. p->aCol[p->nCol-1].notNull = (u8)onError;
  93053. }
  93054. /*
  93055. ** Scan the column type name zType (length nType) and return the
  93056. ** associated affinity type.
  93057. **
  93058. ** This routine does a case-independent search of zType for the
  93059. ** substrings in the following table. If one of the substrings is
  93060. ** found, the corresponding affinity is returned. If zType contains
  93061. ** more than one of the substrings, entries toward the top of
  93062. ** the table take priority. For example, if zType is 'BLOBINT',
  93063. ** SQLITE_AFF_INTEGER is returned.
  93064. **
  93065. ** Substring | Affinity
  93066. ** --------------------------------
  93067. ** 'INT' | SQLITE_AFF_INTEGER
  93068. ** 'CHAR' | SQLITE_AFF_TEXT
  93069. ** 'CLOB' | SQLITE_AFF_TEXT
  93070. ** 'TEXT' | SQLITE_AFF_TEXT
  93071. ** 'BLOB' | SQLITE_AFF_BLOB
  93072. ** 'REAL' | SQLITE_AFF_REAL
  93073. ** 'FLOA' | SQLITE_AFF_REAL
  93074. ** 'DOUB' | SQLITE_AFF_REAL
  93075. **
  93076. ** If none of the substrings in the above table are found,
  93077. ** SQLITE_AFF_NUMERIC is returned.
  93078. */
  93079. SQLITE_PRIVATE char sqlite3AffinityType(const char *zIn, u8 *pszEst){
  93080. u32 h = 0;
  93081. char aff = SQLITE_AFF_NUMERIC;
  93082. const char *zChar = 0;
  93083. assert( zIn!=0 );
  93084. while( zIn[0] ){
  93085. h = (h<<8) + sqlite3UpperToLower[(*zIn)&0xff];
  93086. zIn++;
  93087. if( h==(('c'<<24)+('h'<<16)+('a'<<8)+'r') ){ /* CHAR */
  93088. aff = SQLITE_AFF_TEXT;
  93089. zChar = zIn;
  93090. }else if( h==(('c'<<24)+('l'<<16)+('o'<<8)+'b') ){ /* CLOB */
  93091. aff = SQLITE_AFF_TEXT;
  93092. }else if( h==(('t'<<24)+('e'<<16)+('x'<<8)+'t') ){ /* TEXT */
  93093. aff = SQLITE_AFF_TEXT;
  93094. }else if( h==(('b'<<24)+('l'<<16)+('o'<<8)+'b') /* BLOB */
  93095. && (aff==SQLITE_AFF_NUMERIC || aff==SQLITE_AFF_REAL) ){
  93096. aff = SQLITE_AFF_BLOB;
  93097. if( zIn[0]=='(' ) zChar = zIn;
  93098. #ifndef SQLITE_OMIT_FLOATING_POINT
  93099. }else if( h==(('r'<<24)+('e'<<16)+('a'<<8)+'l') /* REAL */
  93100. && aff==SQLITE_AFF_NUMERIC ){
  93101. aff = SQLITE_AFF_REAL;
  93102. }else if( h==(('f'<<24)+('l'<<16)+('o'<<8)+'a') /* FLOA */
  93103. && aff==SQLITE_AFF_NUMERIC ){
  93104. aff = SQLITE_AFF_REAL;
  93105. }else if( h==(('d'<<24)+('o'<<16)+('u'<<8)+'b') /* DOUB */
  93106. && aff==SQLITE_AFF_NUMERIC ){
  93107. aff = SQLITE_AFF_REAL;
  93108. #endif
  93109. }else if( (h&0x00FFFFFF)==(('i'<<16)+('n'<<8)+'t') ){ /* INT */
  93110. aff = SQLITE_AFF_INTEGER;
  93111. break;
  93112. }
  93113. }
  93114. /* If pszEst is not NULL, store an estimate of the field size. The
  93115. ** estimate is scaled so that the size of an integer is 1. */
  93116. if( pszEst ){
  93117. *pszEst = 1; /* default size is approx 4 bytes */
  93118. if( aff<SQLITE_AFF_NUMERIC ){
  93119. if( zChar ){
  93120. while( zChar[0] ){
  93121. if( sqlite3Isdigit(zChar[0]) ){
  93122. int v = 0;
  93123. sqlite3GetInt32(zChar, &v);
  93124. v = v/4 + 1;
  93125. if( v>255 ) v = 255;
  93126. *pszEst = v; /* BLOB(k), VARCHAR(k), CHAR(k) -> r=(k/4+1) */
  93127. break;
  93128. }
  93129. zChar++;
  93130. }
  93131. }else{
  93132. *pszEst = 5; /* BLOB, TEXT, CLOB -> r=5 (approx 20 bytes)*/
  93133. }
  93134. }
  93135. }
  93136. return aff;
  93137. }
  93138. /*
  93139. ** The expression is the default value for the most recently added column
  93140. ** of the table currently under construction.
  93141. **
  93142. ** Default value expressions must be constant. Raise an exception if this
  93143. ** is not the case.
  93144. **
  93145. ** This routine is called by the parser while in the middle of
  93146. ** parsing a CREATE TABLE statement.
  93147. */
  93148. SQLITE_PRIVATE void sqlite3AddDefaultValue(Parse *pParse, ExprSpan *pSpan){
  93149. Table *p;
  93150. Column *pCol;
  93151. sqlite3 *db = pParse->db;
  93152. p = pParse->pNewTable;
  93153. if( p!=0 ){
  93154. pCol = &(p->aCol[p->nCol-1]);
  93155. if( !sqlite3ExprIsConstantOrFunction(pSpan->pExpr, db->init.busy) ){
  93156. sqlite3ErrorMsg(pParse, "default value of column [%s] is not constant",
  93157. pCol->zName);
  93158. }else{
  93159. /* A copy of pExpr is used instead of the original, as pExpr contains
  93160. ** tokens that point to volatile memory. The 'span' of the expression
  93161. ** is required by pragma table_info.
  93162. */
  93163. Expr x;
  93164. sqlite3ExprDelete(db, pCol->pDflt);
  93165. memset(&x, 0, sizeof(x));
  93166. x.op = TK_SPAN;
  93167. x.u.zToken = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
  93168. (int)(pSpan->zEnd - pSpan->zStart));
  93169. x.pLeft = pSpan->pExpr;
  93170. x.flags = EP_Skip;
  93171. pCol->pDflt = sqlite3ExprDup(db, &x, EXPRDUP_REDUCE);
  93172. sqlite3DbFree(db, x.u.zToken);
  93173. }
  93174. }
  93175. sqlite3ExprDelete(db, pSpan->pExpr);
  93176. }
  93177. /*
  93178. ** Backwards Compatibility Hack:
  93179. **
  93180. ** Historical versions of SQLite accepted strings as column names in
  93181. ** indexes and PRIMARY KEY constraints and in UNIQUE constraints. Example:
  93182. **
  93183. ** CREATE TABLE xyz(a,b,c,d,e,PRIMARY KEY('a'),UNIQUE('b','c' COLLATE trim)
  93184. ** CREATE INDEX abc ON xyz('c','d' DESC,'e' COLLATE nocase DESC);
  93185. **
  93186. ** This is goofy. But to preserve backwards compatibility we continue to
  93187. ** accept it. This routine does the necessary conversion. It converts
  93188. ** the expression given in its argument from a TK_STRING into a TK_ID
  93189. ** if the expression is just a TK_STRING with an optional COLLATE clause.
  93190. ** If the epxression is anything other than TK_STRING, the expression is
  93191. ** unchanged.
  93192. */
  93193. static void sqlite3StringToId(Expr *p){
  93194. if( p->op==TK_STRING ){
  93195. p->op = TK_ID;
  93196. }else if( p->op==TK_COLLATE && p->pLeft->op==TK_STRING ){
  93197. p->pLeft->op = TK_ID;
  93198. }
  93199. }
  93200. /*
  93201. ** Designate the PRIMARY KEY for the table. pList is a list of names
  93202. ** of columns that form the primary key. If pList is NULL, then the
  93203. ** most recently added column of the table is the primary key.
  93204. **
  93205. ** A table can have at most one primary key. If the table already has
  93206. ** a primary key (and this is the second primary key) then create an
  93207. ** error.
  93208. **
  93209. ** If the PRIMARY KEY is on a single column whose datatype is INTEGER,
  93210. ** then we will try to use that column as the rowid. Set the Table.iPKey
  93211. ** field of the table under construction to be the index of the
  93212. ** INTEGER PRIMARY KEY column. Table.iPKey is set to -1 if there is
  93213. ** no INTEGER PRIMARY KEY.
  93214. **
  93215. ** If the key is not an INTEGER PRIMARY KEY, then create a unique
  93216. ** index for the key. No index is created for INTEGER PRIMARY KEYs.
  93217. */
  93218. SQLITE_PRIVATE void sqlite3AddPrimaryKey(
  93219. Parse *pParse, /* Parsing context */
  93220. ExprList *pList, /* List of field names to be indexed */
  93221. int onError, /* What to do with a uniqueness conflict */
  93222. int autoInc, /* True if the AUTOINCREMENT keyword is present */
  93223. int sortOrder /* SQLITE_SO_ASC or SQLITE_SO_DESC */
  93224. ){
  93225. Table *pTab = pParse->pNewTable;
  93226. Column *pCol = 0;
  93227. int iCol = -1, i;
  93228. int nTerm;
  93229. if( pTab==0 ) goto primary_key_exit;
  93230. if( pTab->tabFlags & TF_HasPrimaryKey ){
  93231. sqlite3ErrorMsg(pParse,
  93232. "table \"%s\" has more than one primary key", pTab->zName);
  93233. goto primary_key_exit;
  93234. }
  93235. pTab->tabFlags |= TF_HasPrimaryKey;
  93236. if( pList==0 ){
  93237. iCol = pTab->nCol - 1;
  93238. pCol = &pTab->aCol[iCol];
  93239. pCol->colFlags |= COLFLAG_PRIMKEY;
  93240. nTerm = 1;
  93241. }else{
  93242. nTerm = pList->nExpr;
  93243. for(i=0; i<nTerm; i++){
  93244. Expr *pCExpr = sqlite3ExprSkipCollate(pList->a[i].pExpr);
  93245. assert( pCExpr!=0 );
  93246. sqlite3StringToId(pCExpr);
  93247. if( pCExpr->op==TK_ID ){
  93248. const char *zCName = pCExpr->u.zToken;
  93249. for(iCol=0; iCol<pTab->nCol; iCol++){
  93250. if( sqlite3StrICmp(zCName, pTab->aCol[iCol].zName)==0 ){
  93251. pCol = &pTab->aCol[iCol];
  93252. pCol->colFlags |= COLFLAG_PRIMKEY;
  93253. break;
  93254. }
  93255. }
  93256. }
  93257. }
  93258. }
  93259. if( nTerm==1
  93260. && pCol
  93261. && sqlite3StrICmp(sqlite3ColumnType(pCol,""), "INTEGER")==0
  93262. && sortOrder!=SQLITE_SO_DESC
  93263. ){
  93264. pTab->iPKey = iCol;
  93265. pTab->keyConf = (u8)onError;
  93266. assert( autoInc==0 || autoInc==1 );
  93267. pTab->tabFlags |= autoInc*TF_Autoincrement;
  93268. if( pList ) pParse->iPkSortOrder = pList->a[0].sortOrder;
  93269. }else if( autoInc ){
  93270. #ifndef SQLITE_OMIT_AUTOINCREMENT
  93271. sqlite3ErrorMsg(pParse, "AUTOINCREMENT is only allowed on an "
  93272. "INTEGER PRIMARY KEY");
  93273. #endif
  93274. }else{
  93275. sqlite3CreateIndex(pParse, 0, 0, 0, pList, onError, 0,
  93276. 0, sortOrder, 0, SQLITE_IDXTYPE_PRIMARYKEY);
  93277. pList = 0;
  93278. }
  93279. primary_key_exit:
  93280. sqlite3ExprListDelete(pParse->db, pList);
  93281. return;
  93282. }
  93283. /*
  93284. ** Add a new CHECK constraint to the table currently under construction.
  93285. */
  93286. SQLITE_PRIVATE void sqlite3AddCheckConstraint(
  93287. Parse *pParse, /* Parsing context */
  93288. Expr *pCheckExpr /* The check expression */
  93289. ){
  93290. #ifndef SQLITE_OMIT_CHECK
  93291. Table *pTab = pParse->pNewTable;
  93292. sqlite3 *db = pParse->db;
  93293. if( pTab && !IN_DECLARE_VTAB
  93294. && !sqlite3BtreeIsReadonly(db->aDb[db->init.iDb].pBt)
  93295. ){
  93296. pTab->pCheck = sqlite3ExprListAppend(pParse, pTab->pCheck, pCheckExpr);
  93297. if( pParse->constraintName.n ){
  93298. sqlite3ExprListSetName(pParse, pTab->pCheck, &pParse->constraintName, 1);
  93299. }
  93300. }else
  93301. #endif
  93302. {
  93303. sqlite3ExprDelete(pParse->db, pCheckExpr);
  93304. }
  93305. }
  93306. /*
  93307. ** Set the collation function of the most recently parsed table column
  93308. ** to the CollSeq given.
  93309. */
  93310. SQLITE_PRIVATE void sqlite3AddCollateType(Parse *pParse, Token *pToken){
  93311. Table *p;
  93312. int i;
  93313. char *zColl; /* Dequoted name of collation sequence */
  93314. sqlite3 *db;
  93315. if( (p = pParse->pNewTable)==0 ) return;
  93316. i = p->nCol-1;
  93317. db = pParse->db;
  93318. zColl = sqlite3NameFromToken(db, pToken);
  93319. if( !zColl ) return;
  93320. if( sqlite3LocateCollSeq(pParse, zColl) ){
  93321. Index *pIdx;
  93322. sqlite3DbFree(db, p->aCol[i].zColl);
  93323. p->aCol[i].zColl = zColl;
  93324. /* If the column is declared as "<name> PRIMARY KEY COLLATE <type>",
  93325. ** then an index may have been created on this column before the
  93326. ** collation type was added. Correct this if it is the case.
  93327. */
  93328. for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
  93329. assert( pIdx->nKeyCol==1 );
  93330. if( pIdx->aiColumn[0]==i ){
  93331. pIdx->azColl[0] = p->aCol[i].zColl;
  93332. }
  93333. }
  93334. }else{
  93335. sqlite3DbFree(db, zColl);
  93336. }
  93337. }
  93338. /*
  93339. ** This function returns the collation sequence for database native text
  93340. ** encoding identified by the string zName, length nName.
  93341. **
  93342. ** If the requested collation sequence is not available, or not available
  93343. ** in the database native encoding, the collation factory is invoked to
  93344. ** request it. If the collation factory does not supply such a sequence,
  93345. ** and the sequence is available in another text encoding, then that is
  93346. ** returned instead.
  93347. **
  93348. ** If no versions of the requested collations sequence are available, or
  93349. ** another error occurs, NULL is returned and an error message written into
  93350. ** pParse.
  93351. **
  93352. ** This routine is a wrapper around sqlite3FindCollSeq(). This routine
  93353. ** invokes the collation factory if the named collation cannot be found
  93354. ** and generates an error message.
  93355. **
  93356. ** See also: sqlite3FindCollSeq(), sqlite3GetCollSeq()
  93357. */
  93358. SQLITE_PRIVATE CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName){
  93359. sqlite3 *db = pParse->db;
  93360. u8 enc = ENC(db);
  93361. u8 initbusy = db->init.busy;
  93362. CollSeq *pColl;
  93363. pColl = sqlite3FindCollSeq(db, enc, zName, initbusy);
  93364. if( !initbusy && (!pColl || !pColl->xCmp) ){
  93365. pColl = sqlite3GetCollSeq(pParse, enc, pColl, zName);
  93366. }
  93367. return pColl;
  93368. }
  93369. /*
  93370. ** Generate code that will increment the schema cookie.
  93371. **
  93372. ** The schema cookie is used to determine when the schema for the
  93373. ** database changes. After each schema change, the cookie value
  93374. ** changes. When a process first reads the schema it records the
  93375. ** cookie. Thereafter, whenever it goes to access the database,
  93376. ** it checks the cookie to make sure the schema has not changed
  93377. ** since it was last read.
  93378. **
  93379. ** This plan is not completely bullet-proof. It is possible for
  93380. ** the schema to change multiple times and for the cookie to be
  93381. ** set back to prior value. But schema changes are infrequent
  93382. ** and the probability of hitting the same cookie value is only
  93383. ** 1 chance in 2^32. So we're safe enough.
  93384. **
  93385. ** IMPLEMENTATION-OF: R-34230-56049 SQLite automatically increments
  93386. ** the schema-version whenever the schema changes.
  93387. */
  93388. SQLITE_PRIVATE void sqlite3ChangeCookie(Parse *pParse, int iDb){
  93389. sqlite3 *db = pParse->db;
  93390. Vdbe *v = pParse->pVdbe;
  93391. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  93392. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_SCHEMA_VERSION,
  93393. db->aDb[iDb].pSchema->schema_cookie+1);
  93394. }
  93395. /*
  93396. ** Measure the number of characters needed to output the given
  93397. ** identifier. The number returned includes any quotes used
  93398. ** but does not include the null terminator.
  93399. **
  93400. ** The estimate is conservative. It might be larger that what is
  93401. ** really needed.
  93402. */
  93403. static int identLength(const char *z){
  93404. int n;
  93405. for(n=0; *z; n++, z++){
  93406. if( *z=='"' ){ n++; }
  93407. }
  93408. return n + 2;
  93409. }
  93410. /*
  93411. ** The first parameter is a pointer to an output buffer. The second
  93412. ** parameter is a pointer to an integer that contains the offset at
  93413. ** which to write into the output buffer. This function copies the
  93414. ** nul-terminated string pointed to by the third parameter, zSignedIdent,
  93415. ** to the specified offset in the buffer and updates *pIdx to refer
  93416. ** to the first byte after the last byte written before returning.
  93417. **
  93418. ** If the string zSignedIdent consists entirely of alpha-numeric
  93419. ** characters, does not begin with a digit and is not an SQL keyword,
  93420. ** then it is copied to the output buffer exactly as it is. Otherwise,
  93421. ** it is quoted using double-quotes.
  93422. */
  93423. static void identPut(char *z, int *pIdx, char *zSignedIdent){
  93424. unsigned char *zIdent = (unsigned char*)zSignedIdent;
  93425. int i, j, needQuote;
  93426. i = *pIdx;
  93427. for(j=0; zIdent[j]; j++){
  93428. if( !sqlite3Isalnum(zIdent[j]) && zIdent[j]!='_' ) break;
  93429. }
  93430. needQuote = sqlite3Isdigit(zIdent[0])
  93431. || sqlite3KeywordCode(zIdent, j)!=TK_ID
  93432. || zIdent[j]!=0
  93433. || j==0;
  93434. if( needQuote ) z[i++] = '"';
  93435. for(j=0; zIdent[j]; j++){
  93436. z[i++] = zIdent[j];
  93437. if( zIdent[j]=='"' ) z[i++] = '"';
  93438. }
  93439. if( needQuote ) z[i++] = '"';
  93440. z[i] = 0;
  93441. *pIdx = i;
  93442. }
  93443. /*
  93444. ** Generate a CREATE TABLE statement appropriate for the given
  93445. ** table. Memory to hold the text of the statement is obtained
  93446. ** from sqliteMalloc() and must be freed by the calling function.
  93447. */
  93448. static char *createTableStmt(sqlite3 *db, Table *p){
  93449. int i, k, n;
  93450. char *zStmt;
  93451. char *zSep, *zSep2, *zEnd;
  93452. Column *pCol;
  93453. n = 0;
  93454. for(pCol = p->aCol, i=0; i<p->nCol; i++, pCol++){
  93455. n += identLength(pCol->zName) + 5;
  93456. }
  93457. n += identLength(p->zName);
  93458. if( n<50 ){
  93459. zSep = "";
  93460. zSep2 = ",";
  93461. zEnd = ")";
  93462. }else{
  93463. zSep = "\n ";
  93464. zSep2 = ",\n ";
  93465. zEnd = "\n)";
  93466. }
  93467. n += 35 + 6*p->nCol;
  93468. zStmt = sqlite3DbMallocRaw(0, n);
  93469. if( zStmt==0 ){
  93470. sqlite3OomFault(db);
  93471. return 0;
  93472. }
  93473. sqlite3_snprintf(n, zStmt, "CREATE TABLE ");
  93474. k = sqlite3Strlen30(zStmt);
  93475. identPut(zStmt, &k, p->zName);
  93476. zStmt[k++] = '(';
  93477. for(pCol=p->aCol, i=0; i<p->nCol; i++, pCol++){
  93478. static const char * const azType[] = {
  93479. /* SQLITE_AFF_BLOB */ "",
  93480. /* SQLITE_AFF_TEXT */ " TEXT",
  93481. /* SQLITE_AFF_NUMERIC */ " NUM",
  93482. /* SQLITE_AFF_INTEGER */ " INT",
  93483. /* SQLITE_AFF_REAL */ " REAL"
  93484. };
  93485. int len;
  93486. const char *zType;
  93487. sqlite3_snprintf(n-k, &zStmt[k], zSep);
  93488. k += sqlite3Strlen30(&zStmt[k]);
  93489. zSep = zSep2;
  93490. identPut(zStmt, &k, pCol->zName);
  93491. assert( pCol->affinity-SQLITE_AFF_BLOB >= 0 );
  93492. assert( pCol->affinity-SQLITE_AFF_BLOB < ArraySize(azType) );
  93493. testcase( pCol->affinity==SQLITE_AFF_BLOB );
  93494. testcase( pCol->affinity==SQLITE_AFF_TEXT );
  93495. testcase( pCol->affinity==SQLITE_AFF_NUMERIC );
  93496. testcase( pCol->affinity==SQLITE_AFF_INTEGER );
  93497. testcase( pCol->affinity==SQLITE_AFF_REAL );
  93498. zType = azType[pCol->affinity - SQLITE_AFF_BLOB];
  93499. len = sqlite3Strlen30(zType);
  93500. assert( pCol->affinity==SQLITE_AFF_BLOB
  93501. || pCol->affinity==sqlite3AffinityType(zType, 0) );
  93502. memcpy(&zStmt[k], zType, len);
  93503. k += len;
  93504. assert( k<=n );
  93505. }
  93506. sqlite3_snprintf(n-k, &zStmt[k], "%s", zEnd);
  93507. return zStmt;
  93508. }
  93509. /*
  93510. ** Resize an Index object to hold N columns total. Return SQLITE_OK
  93511. ** on success and SQLITE_NOMEM on an OOM error.
  93512. */
  93513. static int resizeIndexObject(sqlite3 *db, Index *pIdx, int N){
  93514. char *zExtra;
  93515. int nByte;
  93516. if( pIdx->nColumn>=N ) return SQLITE_OK;
  93517. assert( pIdx->isResized==0 );
  93518. nByte = (sizeof(char*) + sizeof(i16) + 1)*N;
  93519. zExtra = sqlite3DbMallocZero(db, nByte);
  93520. if( zExtra==0 ) return SQLITE_NOMEM_BKPT;
  93521. memcpy(zExtra, pIdx->azColl, sizeof(char*)*pIdx->nColumn);
  93522. pIdx->azColl = (const char**)zExtra;
  93523. zExtra += sizeof(char*)*N;
  93524. memcpy(zExtra, pIdx->aiColumn, sizeof(i16)*pIdx->nColumn);
  93525. pIdx->aiColumn = (i16*)zExtra;
  93526. zExtra += sizeof(i16)*N;
  93527. memcpy(zExtra, pIdx->aSortOrder, pIdx->nColumn);
  93528. pIdx->aSortOrder = (u8*)zExtra;
  93529. pIdx->nColumn = N;
  93530. pIdx->isResized = 1;
  93531. return SQLITE_OK;
  93532. }
  93533. /*
  93534. ** Estimate the total row width for a table.
  93535. */
  93536. static void estimateTableWidth(Table *pTab){
  93537. unsigned wTable = 0;
  93538. const Column *pTabCol;
  93539. int i;
  93540. for(i=pTab->nCol, pTabCol=pTab->aCol; i>0; i--, pTabCol++){
  93541. wTable += pTabCol->szEst;
  93542. }
  93543. if( pTab->iPKey<0 ) wTable++;
  93544. pTab->szTabRow = sqlite3LogEst(wTable*4);
  93545. }
  93546. /*
  93547. ** Estimate the average size of a row for an index.
  93548. */
  93549. static void estimateIndexWidth(Index *pIdx){
  93550. unsigned wIndex = 0;
  93551. int i;
  93552. const Column *aCol = pIdx->pTable->aCol;
  93553. for(i=0; i<pIdx->nColumn; i++){
  93554. i16 x = pIdx->aiColumn[i];
  93555. assert( x<pIdx->pTable->nCol );
  93556. wIndex += x<0 ? 1 : aCol[pIdx->aiColumn[i]].szEst;
  93557. }
  93558. pIdx->szIdxRow = sqlite3LogEst(wIndex*4);
  93559. }
  93560. /* Return true if value x is found any of the first nCol entries of aiCol[]
  93561. */
  93562. static int hasColumn(const i16 *aiCol, int nCol, int x){
  93563. while( nCol-- > 0 ) if( x==*(aiCol++) ) return 1;
  93564. return 0;
  93565. }
  93566. /*
  93567. ** This routine runs at the end of parsing a CREATE TABLE statement that
  93568. ** has a WITHOUT ROWID clause. The job of this routine is to convert both
  93569. ** internal schema data structures and the generated VDBE code so that they
  93570. ** are appropriate for a WITHOUT ROWID table instead of a rowid table.
  93571. ** Changes include:
  93572. **
  93573. ** (1) Set all columns of the PRIMARY KEY schema object to be NOT NULL.
  93574. ** (2) Convert the OP_CreateTable into an OP_CreateIndex. There is
  93575. ** no rowid btree for a WITHOUT ROWID. Instead, the canonical
  93576. ** data storage is a covering index btree.
  93577. ** (3) Bypass the creation of the sqlite_master table entry
  93578. ** for the PRIMARY KEY as the primary key index is now
  93579. ** identified by the sqlite_master table entry of the table itself.
  93580. ** (4) Set the Index.tnum of the PRIMARY KEY Index object in the
  93581. ** schema to the rootpage from the main table.
  93582. ** (5) Add all table columns to the PRIMARY KEY Index object
  93583. ** so that the PRIMARY KEY is a covering index. The surplus
  93584. ** columns are part of KeyInfo.nXField and are not used for
  93585. ** sorting or lookup or uniqueness checks.
  93586. ** (6) Replace the rowid tail on all automatically generated UNIQUE
  93587. ** indices with the PRIMARY KEY columns.
  93588. **
  93589. ** For virtual tables, only (1) is performed.
  93590. */
  93591. static void convertToWithoutRowidTable(Parse *pParse, Table *pTab){
  93592. Index *pIdx;
  93593. Index *pPk;
  93594. int nPk;
  93595. int i, j;
  93596. sqlite3 *db = pParse->db;
  93597. Vdbe *v = pParse->pVdbe;
  93598. /* Mark every PRIMARY KEY column as NOT NULL (except for imposter tables)
  93599. */
  93600. if( !db->init.imposterTable ){
  93601. for(i=0; i<pTab->nCol; i++){
  93602. if( (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0 ){
  93603. pTab->aCol[i].notNull = OE_Abort;
  93604. }
  93605. }
  93606. }
  93607. /* The remaining transformations only apply to b-tree tables, not to
  93608. ** virtual tables */
  93609. if( IN_DECLARE_VTAB ) return;
  93610. /* Convert the OP_CreateTable opcode that would normally create the
  93611. ** root-page for the table into an OP_CreateIndex opcode. The index
  93612. ** created will become the PRIMARY KEY index.
  93613. */
  93614. if( pParse->addrCrTab ){
  93615. assert( v );
  93616. sqlite3VdbeChangeOpcode(v, pParse->addrCrTab, OP_CreateIndex);
  93617. }
  93618. /* Locate the PRIMARY KEY index. Or, if this table was originally
  93619. ** an INTEGER PRIMARY KEY table, create a new PRIMARY KEY index.
  93620. */
  93621. if( pTab->iPKey>=0 ){
  93622. ExprList *pList;
  93623. Token ipkToken;
  93624. sqlite3TokenInit(&ipkToken, pTab->aCol[pTab->iPKey].zName);
  93625. pList = sqlite3ExprListAppend(pParse, 0,
  93626. sqlite3ExprAlloc(db, TK_ID, &ipkToken, 0));
  93627. if( pList==0 ) return;
  93628. pList->a[0].sortOrder = pParse->iPkSortOrder;
  93629. assert( pParse->pNewTable==pTab );
  93630. sqlite3CreateIndex(pParse, 0, 0, 0, pList, pTab->keyConf, 0, 0, 0, 0,
  93631. SQLITE_IDXTYPE_PRIMARYKEY);
  93632. if( db->mallocFailed ) return;
  93633. pPk = sqlite3PrimaryKeyIndex(pTab);
  93634. pTab->iPKey = -1;
  93635. }else{
  93636. pPk = sqlite3PrimaryKeyIndex(pTab);
  93637. /* Bypass the creation of the PRIMARY KEY btree and the sqlite_master
  93638. ** table entry. This is only required if currently generating VDBE
  93639. ** code for a CREATE TABLE (not when parsing one as part of reading
  93640. ** a database schema). */
  93641. if( v ){
  93642. assert( db->init.busy==0 );
  93643. sqlite3VdbeChangeOpcode(v, pPk->tnum, OP_Goto);
  93644. }
  93645. /*
  93646. ** Remove all redundant columns from the PRIMARY KEY. For example, change
  93647. ** "PRIMARY KEY(a,b,a,b,c,b,c,d)" into just "PRIMARY KEY(a,b,c,d)". Later
  93648. ** code assumes the PRIMARY KEY contains no repeated columns.
  93649. */
  93650. for(i=j=1; i<pPk->nKeyCol; i++){
  93651. if( hasColumn(pPk->aiColumn, j, pPk->aiColumn[i]) ){
  93652. pPk->nColumn--;
  93653. }else{
  93654. pPk->aiColumn[j++] = pPk->aiColumn[i];
  93655. }
  93656. }
  93657. pPk->nKeyCol = j;
  93658. }
  93659. assert( pPk!=0 );
  93660. pPk->isCovering = 1;
  93661. if( !db->init.imposterTable ) pPk->uniqNotNull = 1;
  93662. nPk = pPk->nKeyCol;
  93663. /* The root page of the PRIMARY KEY is the table root page */
  93664. pPk->tnum = pTab->tnum;
  93665. /* Update the in-memory representation of all UNIQUE indices by converting
  93666. ** the final rowid column into one or more columns of the PRIMARY KEY.
  93667. */
  93668. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  93669. int n;
  93670. if( IsPrimaryKeyIndex(pIdx) ) continue;
  93671. for(i=n=0; i<nPk; i++){
  93672. if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ) n++;
  93673. }
  93674. if( n==0 ){
  93675. /* This index is a superset of the primary key */
  93676. pIdx->nColumn = pIdx->nKeyCol;
  93677. continue;
  93678. }
  93679. if( resizeIndexObject(db, pIdx, pIdx->nKeyCol+n) ) return;
  93680. for(i=0, j=pIdx->nKeyCol; i<nPk; i++){
  93681. if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ){
  93682. pIdx->aiColumn[j] = pPk->aiColumn[i];
  93683. pIdx->azColl[j] = pPk->azColl[i];
  93684. j++;
  93685. }
  93686. }
  93687. assert( pIdx->nColumn>=pIdx->nKeyCol+n );
  93688. assert( pIdx->nColumn>=j );
  93689. }
  93690. /* Add all table columns to the PRIMARY KEY index
  93691. */
  93692. if( nPk<pTab->nCol ){
  93693. if( resizeIndexObject(db, pPk, pTab->nCol) ) return;
  93694. for(i=0, j=nPk; i<pTab->nCol; i++){
  93695. if( !hasColumn(pPk->aiColumn, j, i) ){
  93696. assert( j<pPk->nColumn );
  93697. pPk->aiColumn[j] = i;
  93698. pPk->azColl[j] = sqlite3StrBINARY;
  93699. j++;
  93700. }
  93701. }
  93702. assert( pPk->nColumn==j );
  93703. assert( pTab->nCol==j );
  93704. }else{
  93705. pPk->nColumn = pTab->nCol;
  93706. }
  93707. }
  93708. /*
  93709. ** This routine is called to report the final ")" that terminates
  93710. ** a CREATE TABLE statement.
  93711. **
  93712. ** The table structure that other action routines have been building
  93713. ** is added to the internal hash tables, assuming no errors have
  93714. ** occurred.
  93715. **
  93716. ** An entry for the table is made in the master table on disk, unless
  93717. ** this is a temporary table or db->init.busy==1. When db->init.busy==1
  93718. ** it means we are reading the sqlite_master table because we just
  93719. ** connected to the database or because the sqlite_master table has
  93720. ** recently changed, so the entry for this table already exists in
  93721. ** the sqlite_master table. We do not want to create it again.
  93722. **
  93723. ** If the pSelect argument is not NULL, it means that this routine
  93724. ** was called to create a table generated from a
  93725. ** "CREATE TABLE ... AS SELECT ..." statement. The column names of
  93726. ** the new table will match the result set of the SELECT.
  93727. */
  93728. SQLITE_PRIVATE void sqlite3EndTable(
  93729. Parse *pParse, /* Parse context */
  93730. Token *pCons, /* The ',' token after the last column defn. */
  93731. Token *pEnd, /* The ')' before options in the CREATE TABLE */
  93732. u8 tabOpts, /* Extra table options. Usually 0. */
  93733. Select *pSelect /* Select from a "CREATE ... AS SELECT" */
  93734. ){
  93735. Table *p; /* The new table */
  93736. sqlite3 *db = pParse->db; /* The database connection */
  93737. int iDb; /* Database in which the table lives */
  93738. Index *pIdx; /* An implied index of the table */
  93739. if( pEnd==0 && pSelect==0 ){
  93740. return;
  93741. }
  93742. assert( !db->mallocFailed );
  93743. p = pParse->pNewTable;
  93744. if( p==0 ) return;
  93745. assert( !db->init.busy || !pSelect );
  93746. /* If the db->init.busy is 1 it means we are reading the SQL off the
  93747. ** "sqlite_master" or "sqlite_temp_master" table on the disk.
  93748. ** So do not write to the disk again. Extract the root page number
  93749. ** for the table from the db->init.newTnum field. (The page number
  93750. ** should have been put there by the sqliteOpenCb routine.)
  93751. **
  93752. ** If the root page number is 1, that means this is the sqlite_master
  93753. ** table itself. So mark it read-only.
  93754. */
  93755. if( db->init.busy ){
  93756. p->tnum = db->init.newTnum;
  93757. if( p->tnum==1 ) p->tabFlags |= TF_Readonly;
  93758. }
  93759. /* Special processing for WITHOUT ROWID Tables */
  93760. if( tabOpts & TF_WithoutRowid ){
  93761. if( (p->tabFlags & TF_Autoincrement) ){
  93762. sqlite3ErrorMsg(pParse,
  93763. "AUTOINCREMENT not allowed on WITHOUT ROWID tables");
  93764. return;
  93765. }
  93766. if( (p->tabFlags & TF_HasPrimaryKey)==0 ){
  93767. sqlite3ErrorMsg(pParse, "PRIMARY KEY missing on table %s", p->zName);
  93768. }else{
  93769. p->tabFlags |= TF_WithoutRowid | TF_NoVisibleRowid;
  93770. convertToWithoutRowidTable(pParse, p);
  93771. }
  93772. }
  93773. iDb = sqlite3SchemaToIndex(db, p->pSchema);
  93774. #ifndef SQLITE_OMIT_CHECK
  93775. /* Resolve names in all CHECK constraint expressions.
  93776. */
  93777. if( p->pCheck ){
  93778. sqlite3ResolveSelfReference(pParse, p, NC_IsCheck, 0, p->pCheck);
  93779. }
  93780. #endif /* !defined(SQLITE_OMIT_CHECK) */
  93781. /* Estimate the average row size for the table and for all implied indices */
  93782. estimateTableWidth(p);
  93783. for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
  93784. estimateIndexWidth(pIdx);
  93785. }
  93786. /* If not initializing, then create a record for the new table
  93787. ** in the SQLITE_MASTER table of the database.
  93788. **
  93789. ** If this is a TEMPORARY table, write the entry into the auxiliary
  93790. ** file instead of into the main database file.
  93791. */
  93792. if( !db->init.busy ){
  93793. int n;
  93794. Vdbe *v;
  93795. char *zType; /* "view" or "table" */
  93796. char *zType2; /* "VIEW" or "TABLE" */
  93797. char *zStmt; /* Text of the CREATE TABLE or CREATE VIEW statement */
  93798. v = sqlite3GetVdbe(pParse);
  93799. if( NEVER(v==0) ) return;
  93800. sqlite3VdbeAddOp1(v, OP_Close, 0);
  93801. /*
  93802. ** Initialize zType for the new view or table.
  93803. */
  93804. if( p->pSelect==0 ){
  93805. /* A regular table */
  93806. zType = "table";
  93807. zType2 = "TABLE";
  93808. #ifndef SQLITE_OMIT_VIEW
  93809. }else{
  93810. /* A view */
  93811. zType = "view";
  93812. zType2 = "VIEW";
  93813. #endif
  93814. }
  93815. /* If this is a CREATE TABLE xx AS SELECT ..., execute the SELECT
  93816. ** statement to populate the new table. The root-page number for the
  93817. ** new table is in register pParse->regRoot.
  93818. **
  93819. ** Once the SELECT has been coded by sqlite3Select(), it is in a
  93820. ** suitable state to query for the column names and types to be used
  93821. ** by the new table.
  93822. **
  93823. ** A shared-cache write-lock is not required to write to the new table,
  93824. ** as a schema-lock must have already been obtained to create it. Since
  93825. ** a schema-lock excludes all other database users, the write-lock would
  93826. ** be redundant.
  93827. */
  93828. if( pSelect ){
  93829. SelectDest dest; /* Where the SELECT should store results */
  93830. int regYield; /* Register holding co-routine entry-point */
  93831. int addrTop; /* Top of the co-routine */
  93832. int regRec; /* A record to be insert into the new table */
  93833. int regRowid; /* Rowid of the next row to insert */
  93834. int addrInsLoop; /* Top of the loop for inserting rows */
  93835. Table *pSelTab; /* A table that describes the SELECT results */
  93836. regYield = ++pParse->nMem;
  93837. regRec = ++pParse->nMem;
  93838. regRowid = ++pParse->nMem;
  93839. assert(pParse->nTab==1);
  93840. sqlite3MayAbort(pParse);
  93841. sqlite3VdbeAddOp3(v, OP_OpenWrite, 1, pParse->regRoot, iDb);
  93842. sqlite3VdbeChangeP5(v, OPFLAG_P2ISREG);
  93843. pParse->nTab = 2;
  93844. addrTop = sqlite3VdbeCurrentAddr(v) + 1;
  93845. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
  93846. sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
  93847. sqlite3Select(pParse, pSelect, &dest);
  93848. sqlite3VdbeEndCoroutine(v, regYield);
  93849. sqlite3VdbeJumpHere(v, addrTop - 1);
  93850. if( pParse->nErr ) return;
  93851. pSelTab = sqlite3ResultSetOfSelect(pParse, pSelect);
  93852. if( pSelTab==0 ) return;
  93853. assert( p->aCol==0 );
  93854. p->nCol = pSelTab->nCol;
  93855. p->aCol = pSelTab->aCol;
  93856. pSelTab->nCol = 0;
  93857. pSelTab->aCol = 0;
  93858. sqlite3DeleteTable(db, pSelTab);
  93859. addrInsLoop = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
  93860. VdbeCoverage(v);
  93861. sqlite3VdbeAddOp3(v, OP_MakeRecord, dest.iSdst, dest.nSdst, regRec);
  93862. sqlite3TableAffinity(v, p, 0);
  93863. sqlite3VdbeAddOp2(v, OP_NewRowid, 1, regRowid);
  93864. sqlite3VdbeAddOp3(v, OP_Insert, 1, regRec, regRowid);
  93865. sqlite3VdbeGoto(v, addrInsLoop);
  93866. sqlite3VdbeJumpHere(v, addrInsLoop);
  93867. sqlite3VdbeAddOp1(v, OP_Close, 1);
  93868. }
  93869. /* Compute the complete text of the CREATE statement */
  93870. if( pSelect ){
  93871. zStmt = createTableStmt(db, p);
  93872. }else{
  93873. Token *pEnd2 = tabOpts ? &pParse->sLastToken : pEnd;
  93874. n = (int)(pEnd2->z - pParse->sNameToken.z);
  93875. if( pEnd2->z[0]!=';' ) n += pEnd2->n;
  93876. zStmt = sqlite3MPrintf(db,
  93877. "CREATE %s %.*s", zType2, n, pParse->sNameToken.z
  93878. );
  93879. }
  93880. /* A slot for the record has already been allocated in the
  93881. ** SQLITE_MASTER table. We just need to update that slot with all
  93882. ** the information we've collected.
  93883. */
  93884. sqlite3NestedParse(pParse,
  93885. "UPDATE %Q.%s "
  93886. "SET type='%s', name=%Q, tbl_name=%Q, rootpage=#%d, sql=%Q "
  93887. "WHERE rowid=#%d",
  93888. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb),
  93889. zType,
  93890. p->zName,
  93891. p->zName,
  93892. pParse->regRoot,
  93893. zStmt,
  93894. pParse->regRowid
  93895. );
  93896. sqlite3DbFree(db, zStmt);
  93897. sqlite3ChangeCookie(pParse, iDb);
  93898. #ifndef SQLITE_OMIT_AUTOINCREMENT
  93899. /* Check to see if we need to create an sqlite_sequence table for
  93900. ** keeping track of autoincrement keys.
  93901. */
  93902. if( (p->tabFlags & TF_Autoincrement)!=0 ){
  93903. Db *pDb = &db->aDb[iDb];
  93904. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  93905. if( pDb->pSchema->pSeqTab==0 ){
  93906. sqlite3NestedParse(pParse,
  93907. "CREATE TABLE %Q.sqlite_sequence(name,seq)",
  93908. pDb->zDbSName
  93909. );
  93910. }
  93911. }
  93912. #endif
  93913. /* Reparse everything to update our internal data structures */
  93914. sqlite3VdbeAddParseSchemaOp(v, iDb,
  93915. sqlite3MPrintf(db, "tbl_name='%q' AND type!='trigger'", p->zName));
  93916. }
  93917. /* Add the table to the in-memory representation of the database.
  93918. */
  93919. if( db->init.busy ){
  93920. Table *pOld;
  93921. Schema *pSchema = p->pSchema;
  93922. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  93923. pOld = sqlite3HashInsert(&pSchema->tblHash, p->zName, p);
  93924. if( pOld ){
  93925. assert( p==pOld ); /* Malloc must have failed inside HashInsert() */
  93926. sqlite3OomFault(db);
  93927. return;
  93928. }
  93929. pParse->pNewTable = 0;
  93930. db->flags |= SQLITE_InternChanges;
  93931. #ifndef SQLITE_OMIT_ALTERTABLE
  93932. if( !p->pSelect ){
  93933. const char *zName = (const char *)pParse->sNameToken.z;
  93934. int nName;
  93935. assert( !pSelect && pCons && pEnd );
  93936. if( pCons->z==0 ){
  93937. pCons = pEnd;
  93938. }
  93939. nName = (int)((const char *)pCons->z - zName);
  93940. p->addColOffset = 13 + sqlite3Utf8CharLen(zName, nName);
  93941. }
  93942. #endif
  93943. }
  93944. }
  93945. #ifndef SQLITE_OMIT_VIEW
  93946. /*
  93947. ** The parser calls this routine in order to create a new VIEW
  93948. */
  93949. SQLITE_PRIVATE void sqlite3CreateView(
  93950. Parse *pParse, /* The parsing context */
  93951. Token *pBegin, /* The CREATE token that begins the statement */
  93952. Token *pName1, /* The token that holds the name of the view */
  93953. Token *pName2, /* The token that holds the name of the view */
  93954. ExprList *pCNames, /* Optional list of view column names */
  93955. Select *pSelect, /* A SELECT statement that will become the new view */
  93956. int isTemp, /* TRUE for a TEMPORARY view */
  93957. int noErr /* Suppress error messages if VIEW already exists */
  93958. ){
  93959. Table *p;
  93960. int n;
  93961. const char *z;
  93962. Token sEnd;
  93963. DbFixer sFix;
  93964. Token *pName = 0;
  93965. int iDb;
  93966. sqlite3 *db = pParse->db;
  93967. if( pParse->nVar>0 ){
  93968. sqlite3ErrorMsg(pParse, "parameters are not allowed in views");
  93969. goto create_view_fail;
  93970. }
  93971. sqlite3StartTable(pParse, pName1, pName2, isTemp, 1, 0, noErr);
  93972. p = pParse->pNewTable;
  93973. if( p==0 || pParse->nErr ) goto create_view_fail;
  93974. sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  93975. iDb = sqlite3SchemaToIndex(db, p->pSchema);
  93976. sqlite3FixInit(&sFix, pParse, iDb, "view", pName);
  93977. if( sqlite3FixSelect(&sFix, pSelect) ) goto create_view_fail;
  93978. /* Make a copy of the entire SELECT statement that defines the view.
  93979. ** This will force all the Expr.token.z values to be dynamically
  93980. ** allocated rather than point to the input string - which means that
  93981. ** they will persist after the current sqlite3_exec() call returns.
  93982. */
  93983. p->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  93984. p->pCheck = sqlite3ExprListDup(db, pCNames, EXPRDUP_REDUCE);
  93985. if( db->mallocFailed ) goto create_view_fail;
  93986. /* Locate the end of the CREATE VIEW statement. Make sEnd point to
  93987. ** the end.
  93988. */
  93989. sEnd = pParse->sLastToken;
  93990. assert( sEnd.z[0]!=0 );
  93991. if( sEnd.z[0]!=';' ){
  93992. sEnd.z += sEnd.n;
  93993. }
  93994. sEnd.n = 0;
  93995. n = (int)(sEnd.z - pBegin->z);
  93996. assert( n>0 );
  93997. z = pBegin->z;
  93998. while( sqlite3Isspace(z[n-1]) ){ n--; }
  93999. sEnd.z = &z[n-1];
  94000. sEnd.n = 1;
  94001. /* Use sqlite3EndTable() to add the view to the SQLITE_MASTER table */
  94002. sqlite3EndTable(pParse, 0, &sEnd, 0, 0);
  94003. create_view_fail:
  94004. sqlite3SelectDelete(db, pSelect);
  94005. sqlite3ExprListDelete(db, pCNames);
  94006. return;
  94007. }
  94008. #endif /* SQLITE_OMIT_VIEW */
  94009. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  94010. /*
  94011. ** The Table structure pTable is really a VIEW. Fill in the names of
  94012. ** the columns of the view in the pTable structure. Return the number
  94013. ** of errors. If an error is seen leave an error message in pParse->zErrMsg.
  94014. */
  94015. SQLITE_PRIVATE int sqlite3ViewGetColumnNames(Parse *pParse, Table *pTable){
  94016. Table *pSelTab; /* A fake table from which we get the result set */
  94017. Select *pSel; /* Copy of the SELECT that implements the view */
  94018. int nErr = 0; /* Number of errors encountered */
  94019. int n; /* Temporarily holds the number of cursors assigned */
  94020. sqlite3 *db = pParse->db; /* Database connection for malloc errors */
  94021. #ifndef SQLITE_OMIT_AUTHORIZATION
  94022. sqlite3_xauth xAuth; /* Saved xAuth pointer */
  94023. #endif
  94024. assert( pTable );
  94025. #ifndef SQLITE_OMIT_VIRTUALTABLE
  94026. if( sqlite3VtabCallConnect(pParse, pTable) ){
  94027. return SQLITE_ERROR;
  94028. }
  94029. if( IsVirtual(pTable) ) return 0;
  94030. #endif
  94031. #ifndef SQLITE_OMIT_VIEW
  94032. /* A positive nCol means the columns names for this view are
  94033. ** already known.
  94034. */
  94035. if( pTable->nCol>0 ) return 0;
  94036. /* A negative nCol is a special marker meaning that we are currently
  94037. ** trying to compute the column names. If we enter this routine with
  94038. ** a negative nCol, it means two or more views form a loop, like this:
  94039. **
  94040. ** CREATE VIEW one AS SELECT * FROM two;
  94041. ** CREATE VIEW two AS SELECT * FROM one;
  94042. **
  94043. ** Actually, the error above is now caught prior to reaching this point.
  94044. ** But the following test is still important as it does come up
  94045. ** in the following:
  94046. **
  94047. ** CREATE TABLE main.ex1(a);
  94048. ** CREATE TEMP VIEW ex1 AS SELECT a FROM ex1;
  94049. ** SELECT * FROM temp.ex1;
  94050. */
  94051. if( pTable->nCol<0 ){
  94052. sqlite3ErrorMsg(pParse, "view %s is circularly defined", pTable->zName);
  94053. return 1;
  94054. }
  94055. assert( pTable->nCol>=0 );
  94056. /* If we get this far, it means we need to compute the table names.
  94057. ** Note that the call to sqlite3ResultSetOfSelect() will expand any
  94058. ** "*" elements in the results set of the view and will assign cursors
  94059. ** to the elements of the FROM clause. But we do not want these changes
  94060. ** to be permanent. So the computation is done on a copy of the SELECT
  94061. ** statement that defines the view.
  94062. */
  94063. assert( pTable->pSelect );
  94064. pSel = sqlite3SelectDup(db, pTable->pSelect, 0);
  94065. if( pSel ){
  94066. n = pParse->nTab;
  94067. sqlite3SrcListAssignCursors(pParse, pSel->pSrc);
  94068. pTable->nCol = -1;
  94069. db->lookaside.bDisable++;
  94070. #ifndef SQLITE_OMIT_AUTHORIZATION
  94071. xAuth = db->xAuth;
  94072. db->xAuth = 0;
  94073. pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
  94074. db->xAuth = xAuth;
  94075. #else
  94076. pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
  94077. #endif
  94078. pParse->nTab = n;
  94079. if( pTable->pCheck ){
  94080. /* CREATE VIEW name(arglist) AS ...
  94081. ** The names of the columns in the table are taken from
  94082. ** arglist which is stored in pTable->pCheck. The pCheck field
  94083. ** normally holds CHECK constraints on an ordinary table, but for
  94084. ** a VIEW it holds the list of column names.
  94085. */
  94086. sqlite3ColumnsFromExprList(pParse, pTable->pCheck,
  94087. &pTable->nCol, &pTable->aCol);
  94088. if( db->mallocFailed==0
  94089. && pParse->nErr==0
  94090. && pTable->nCol==pSel->pEList->nExpr
  94091. ){
  94092. sqlite3SelectAddColumnTypeAndCollation(pParse, pTable, pSel);
  94093. }
  94094. }else if( pSelTab ){
  94095. /* CREATE VIEW name AS... without an argument list. Construct
  94096. ** the column names from the SELECT statement that defines the view.
  94097. */
  94098. assert( pTable->aCol==0 );
  94099. pTable->nCol = pSelTab->nCol;
  94100. pTable->aCol = pSelTab->aCol;
  94101. pSelTab->nCol = 0;
  94102. pSelTab->aCol = 0;
  94103. assert( sqlite3SchemaMutexHeld(db, 0, pTable->pSchema) );
  94104. }else{
  94105. pTable->nCol = 0;
  94106. nErr++;
  94107. }
  94108. sqlite3DeleteTable(db, pSelTab);
  94109. sqlite3SelectDelete(db, pSel);
  94110. db->lookaside.bDisable--;
  94111. } else {
  94112. nErr++;
  94113. }
  94114. pTable->pSchema->schemaFlags |= DB_UnresetViews;
  94115. #endif /* SQLITE_OMIT_VIEW */
  94116. return nErr;
  94117. }
  94118. #endif /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
  94119. #ifndef SQLITE_OMIT_VIEW
  94120. /*
  94121. ** Clear the column names from every VIEW in database idx.
  94122. */
  94123. static void sqliteViewResetAll(sqlite3 *db, int idx){
  94124. HashElem *i;
  94125. assert( sqlite3SchemaMutexHeld(db, idx, 0) );
  94126. if( !DbHasProperty(db, idx, DB_UnresetViews) ) return;
  94127. for(i=sqliteHashFirst(&db->aDb[idx].pSchema->tblHash); i;i=sqliteHashNext(i)){
  94128. Table *pTab = sqliteHashData(i);
  94129. if( pTab->pSelect ){
  94130. sqlite3DeleteColumnNames(db, pTab);
  94131. pTab->aCol = 0;
  94132. pTab->nCol = 0;
  94133. }
  94134. }
  94135. DbClearProperty(db, idx, DB_UnresetViews);
  94136. }
  94137. #else
  94138. # define sqliteViewResetAll(A,B)
  94139. #endif /* SQLITE_OMIT_VIEW */
  94140. /*
  94141. ** This function is called by the VDBE to adjust the internal schema
  94142. ** used by SQLite when the btree layer moves a table root page. The
  94143. ** root-page of a table or index in database iDb has changed from iFrom
  94144. ** to iTo.
  94145. **
  94146. ** Ticket #1728: The symbol table might still contain information
  94147. ** on tables and/or indices that are the process of being deleted.
  94148. ** If you are unlucky, one of those deleted indices or tables might
  94149. ** have the same rootpage number as the real table or index that is
  94150. ** being moved. So we cannot stop searching after the first match
  94151. ** because the first match might be for one of the deleted indices
  94152. ** or tables and not the table/index that is actually being moved.
  94153. ** We must continue looping until all tables and indices with
  94154. ** rootpage==iFrom have been converted to have a rootpage of iTo
  94155. ** in order to be certain that we got the right one.
  94156. */
  94157. #ifndef SQLITE_OMIT_AUTOVACUUM
  94158. SQLITE_PRIVATE void sqlite3RootPageMoved(sqlite3 *db, int iDb, int iFrom, int iTo){
  94159. HashElem *pElem;
  94160. Hash *pHash;
  94161. Db *pDb;
  94162. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  94163. pDb = &db->aDb[iDb];
  94164. pHash = &pDb->pSchema->tblHash;
  94165. for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
  94166. Table *pTab = sqliteHashData(pElem);
  94167. if( pTab->tnum==iFrom ){
  94168. pTab->tnum = iTo;
  94169. }
  94170. }
  94171. pHash = &pDb->pSchema->idxHash;
  94172. for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
  94173. Index *pIdx = sqliteHashData(pElem);
  94174. if( pIdx->tnum==iFrom ){
  94175. pIdx->tnum = iTo;
  94176. }
  94177. }
  94178. }
  94179. #endif
  94180. /*
  94181. ** Write code to erase the table with root-page iTable from database iDb.
  94182. ** Also write code to modify the sqlite_master table and internal schema
  94183. ** if a root-page of another table is moved by the btree-layer whilst
  94184. ** erasing iTable (this can happen with an auto-vacuum database).
  94185. */
  94186. static void destroyRootPage(Parse *pParse, int iTable, int iDb){
  94187. Vdbe *v = sqlite3GetVdbe(pParse);
  94188. int r1 = sqlite3GetTempReg(pParse);
  94189. assert( iTable>1 );
  94190. sqlite3VdbeAddOp3(v, OP_Destroy, iTable, r1, iDb);
  94191. sqlite3MayAbort(pParse);
  94192. #ifndef SQLITE_OMIT_AUTOVACUUM
  94193. /* OP_Destroy stores an in integer r1. If this integer
  94194. ** is non-zero, then it is the root page number of a table moved to
  94195. ** location iTable. The following code modifies the sqlite_master table to
  94196. ** reflect this.
  94197. **
  94198. ** The "#NNN" in the SQL is a special constant that means whatever value
  94199. ** is in register NNN. See grammar rules associated with the TK_REGISTER
  94200. ** token for additional information.
  94201. */
  94202. sqlite3NestedParse(pParse,
  94203. "UPDATE %Q.%s SET rootpage=%d WHERE #%d AND rootpage=#%d",
  94204. pParse->db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb), iTable, r1, r1);
  94205. #endif
  94206. sqlite3ReleaseTempReg(pParse, r1);
  94207. }
  94208. /*
  94209. ** Write VDBE code to erase table pTab and all associated indices on disk.
  94210. ** Code to update the sqlite_master tables and internal schema definitions
  94211. ** in case a root-page belonging to another table is moved by the btree layer
  94212. ** is also added (this can happen with an auto-vacuum database).
  94213. */
  94214. static void destroyTable(Parse *pParse, Table *pTab){
  94215. #ifdef SQLITE_OMIT_AUTOVACUUM
  94216. Index *pIdx;
  94217. int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  94218. destroyRootPage(pParse, pTab->tnum, iDb);
  94219. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  94220. destroyRootPage(pParse, pIdx->tnum, iDb);
  94221. }
  94222. #else
  94223. /* If the database may be auto-vacuum capable (if SQLITE_OMIT_AUTOVACUUM
  94224. ** is not defined), then it is important to call OP_Destroy on the
  94225. ** table and index root-pages in order, starting with the numerically
  94226. ** largest root-page number. This guarantees that none of the root-pages
  94227. ** to be destroyed is relocated by an earlier OP_Destroy. i.e. if the
  94228. ** following were coded:
  94229. **
  94230. ** OP_Destroy 4 0
  94231. ** ...
  94232. ** OP_Destroy 5 0
  94233. **
  94234. ** and root page 5 happened to be the largest root-page number in the
  94235. ** database, then root page 5 would be moved to page 4 by the
  94236. ** "OP_Destroy 4 0" opcode. The subsequent "OP_Destroy 5 0" would hit
  94237. ** a free-list page.
  94238. */
  94239. int iTab = pTab->tnum;
  94240. int iDestroyed = 0;
  94241. while( 1 ){
  94242. Index *pIdx;
  94243. int iLargest = 0;
  94244. if( iDestroyed==0 || iTab<iDestroyed ){
  94245. iLargest = iTab;
  94246. }
  94247. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  94248. int iIdx = pIdx->tnum;
  94249. assert( pIdx->pSchema==pTab->pSchema );
  94250. if( (iDestroyed==0 || (iIdx<iDestroyed)) && iIdx>iLargest ){
  94251. iLargest = iIdx;
  94252. }
  94253. }
  94254. if( iLargest==0 ){
  94255. return;
  94256. }else{
  94257. int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  94258. assert( iDb>=0 && iDb<pParse->db->nDb );
  94259. destroyRootPage(pParse, iLargest, iDb);
  94260. iDestroyed = iLargest;
  94261. }
  94262. }
  94263. #endif
  94264. }
  94265. /*
  94266. ** Remove entries from the sqlite_statN tables (for N in (1,2,3))
  94267. ** after a DROP INDEX or DROP TABLE command.
  94268. */
  94269. static void sqlite3ClearStatTables(
  94270. Parse *pParse, /* The parsing context */
  94271. int iDb, /* The database number */
  94272. const char *zType, /* "idx" or "tbl" */
  94273. const char *zName /* Name of index or table */
  94274. ){
  94275. int i;
  94276. const char *zDbName = pParse->db->aDb[iDb].zDbSName;
  94277. for(i=1; i<=4; i++){
  94278. char zTab[24];
  94279. sqlite3_snprintf(sizeof(zTab),zTab,"sqlite_stat%d",i);
  94280. if( sqlite3FindTable(pParse->db, zTab, zDbName) ){
  94281. sqlite3NestedParse(pParse,
  94282. "DELETE FROM %Q.%s WHERE %s=%Q",
  94283. zDbName, zTab, zType, zName
  94284. );
  94285. }
  94286. }
  94287. }
  94288. /*
  94289. ** Generate code to drop a table.
  94290. */
  94291. SQLITE_PRIVATE void sqlite3CodeDropTable(Parse *pParse, Table *pTab, int iDb, int isView){
  94292. Vdbe *v;
  94293. sqlite3 *db = pParse->db;
  94294. Trigger *pTrigger;
  94295. Db *pDb = &db->aDb[iDb];
  94296. v = sqlite3GetVdbe(pParse);
  94297. assert( v!=0 );
  94298. sqlite3BeginWriteOperation(pParse, 1, iDb);
  94299. #ifndef SQLITE_OMIT_VIRTUALTABLE
  94300. if( IsVirtual(pTab) ){
  94301. sqlite3VdbeAddOp0(v, OP_VBegin);
  94302. }
  94303. #endif
  94304. /* Drop all triggers associated with the table being dropped. Code
  94305. ** is generated to remove entries from sqlite_master and/or
  94306. ** sqlite_temp_master if required.
  94307. */
  94308. pTrigger = sqlite3TriggerList(pParse, pTab);
  94309. while( pTrigger ){
  94310. assert( pTrigger->pSchema==pTab->pSchema ||
  94311. pTrigger->pSchema==db->aDb[1].pSchema );
  94312. sqlite3DropTriggerPtr(pParse, pTrigger);
  94313. pTrigger = pTrigger->pNext;
  94314. }
  94315. #ifndef SQLITE_OMIT_AUTOINCREMENT
  94316. /* Remove any entries of the sqlite_sequence table associated with
  94317. ** the table being dropped. This is done before the table is dropped
  94318. ** at the btree level, in case the sqlite_sequence table needs to
  94319. ** move as a result of the drop (can happen in auto-vacuum mode).
  94320. */
  94321. if( pTab->tabFlags & TF_Autoincrement ){
  94322. sqlite3NestedParse(pParse,
  94323. "DELETE FROM %Q.sqlite_sequence WHERE name=%Q",
  94324. pDb->zDbSName, pTab->zName
  94325. );
  94326. }
  94327. #endif
  94328. /* Drop all SQLITE_MASTER table and index entries that refer to the
  94329. ** table. The program name loops through the master table and deletes
  94330. ** every row that refers to a table of the same name as the one being
  94331. ** dropped. Triggers are handled separately because a trigger can be
  94332. ** created in the temp database that refers to a table in another
  94333. ** database.
  94334. */
  94335. sqlite3NestedParse(pParse,
  94336. "DELETE FROM %Q.%s WHERE tbl_name=%Q and type!='trigger'",
  94337. pDb->zDbSName, SCHEMA_TABLE(iDb), pTab->zName);
  94338. if( !isView && !IsVirtual(pTab) ){
  94339. destroyTable(pParse, pTab);
  94340. }
  94341. /* Remove the table entry from SQLite's internal schema and modify
  94342. ** the schema cookie.
  94343. */
  94344. if( IsVirtual(pTab) ){
  94345. sqlite3VdbeAddOp4(v, OP_VDestroy, iDb, 0, 0, pTab->zName, 0);
  94346. }
  94347. sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
  94348. sqlite3ChangeCookie(pParse, iDb);
  94349. sqliteViewResetAll(db, iDb);
  94350. }
  94351. /*
  94352. ** This routine is called to do the work of a DROP TABLE statement.
  94353. ** pName is the name of the table to be dropped.
  94354. */
  94355. SQLITE_PRIVATE void sqlite3DropTable(Parse *pParse, SrcList *pName, int isView, int noErr){
  94356. Table *pTab;
  94357. Vdbe *v;
  94358. sqlite3 *db = pParse->db;
  94359. int iDb;
  94360. if( db->mallocFailed ){
  94361. goto exit_drop_table;
  94362. }
  94363. assert( pParse->nErr==0 );
  94364. assert( pName->nSrc==1 );
  94365. if( sqlite3ReadSchema(pParse) ) goto exit_drop_table;
  94366. if( noErr ) db->suppressErr++;
  94367. assert( isView==0 || isView==LOCATE_VIEW );
  94368. pTab = sqlite3LocateTableItem(pParse, isView, &pName->a[0]);
  94369. if( noErr ) db->suppressErr--;
  94370. if( pTab==0 ){
  94371. if( noErr ) sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
  94372. goto exit_drop_table;
  94373. }
  94374. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  94375. assert( iDb>=0 && iDb<db->nDb );
  94376. /* If pTab is a virtual table, call ViewGetColumnNames() to ensure
  94377. ** it is initialized.
  94378. */
  94379. if( IsVirtual(pTab) && sqlite3ViewGetColumnNames(pParse, pTab) ){
  94380. goto exit_drop_table;
  94381. }
  94382. #ifndef SQLITE_OMIT_AUTHORIZATION
  94383. {
  94384. int code;
  94385. const char *zTab = SCHEMA_TABLE(iDb);
  94386. const char *zDb = db->aDb[iDb].zDbSName;
  94387. const char *zArg2 = 0;
  94388. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb)){
  94389. goto exit_drop_table;
  94390. }
  94391. if( isView ){
  94392. if( !OMIT_TEMPDB && iDb==1 ){
  94393. code = SQLITE_DROP_TEMP_VIEW;
  94394. }else{
  94395. code = SQLITE_DROP_VIEW;
  94396. }
  94397. #ifndef SQLITE_OMIT_VIRTUALTABLE
  94398. }else if( IsVirtual(pTab) ){
  94399. code = SQLITE_DROP_VTABLE;
  94400. zArg2 = sqlite3GetVTable(db, pTab)->pMod->zName;
  94401. #endif
  94402. }else{
  94403. if( !OMIT_TEMPDB && iDb==1 ){
  94404. code = SQLITE_DROP_TEMP_TABLE;
  94405. }else{
  94406. code = SQLITE_DROP_TABLE;
  94407. }
  94408. }
  94409. if( sqlite3AuthCheck(pParse, code, pTab->zName, zArg2, zDb) ){
  94410. goto exit_drop_table;
  94411. }
  94412. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0, zDb) ){
  94413. goto exit_drop_table;
  94414. }
  94415. }
  94416. #endif
  94417. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
  94418. && sqlite3StrNICmp(pTab->zName, "sqlite_stat", 11)!=0 ){
  94419. sqlite3ErrorMsg(pParse, "table %s may not be dropped", pTab->zName);
  94420. goto exit_drop_table;
  94421. }
  94422. #ifndef SQLITE_OMIT_VIEW
  94423. /* Ensure DROP TABLE is not used on a view, and DROP VIEW is not used
  94424. ** on a table.
  94425. */
  94426. if( isView && pTab->pSelect==0 ){
  94427. sqlite3ErrorMsg(pParse, "use DROP TABLE to delete table %s", pTab->zName);
  94428. goto exit_drop_table;
  94429. }
  94430. if( !isView && pTab->pSelect ){
  94431. sqlite3ErrorMsg(pParse, "use DROP VIEW to delete view %s", pTab->zName);
  94432. goto exit_drop_table;
  94433. }
  94434. #endif
  94435. /* Generate code to remove the table from the master table
  94436. ** on disk.
  94437. */
  94438. v = sqlite3GetVdbe(pParse);
  94439. if( v ){
  94440. sqlite3BeginWriteOperation(pParse, 1, iDb);
  94441. sqlite3ClearStatTables(pParse, iDb, "tbl", pTab->zName);
  94442. sqlite3FkDropTable(pParse, pName, pTab);
  94443. sqlite3CodeDropTable(pParse, pTab, iDb, isView);
  94444. }
  94445. exit_drop_table:
  94446. sqlite3SrcListDelete(db, pName);
  94447. }
  94448. /*
  94449. ** This routine is called to create a new foreign key on the table
  94450. ** currently under construction. pFromCol determines which columns
  94451. ** in the current table point to the foreign key. If pFromCol==0 then
  94452. ** connect the key to the last column inserted. pTo is the name of
  94453. ** the table referred to (a.k.a the "parent" table). pToCol is a list
  94454. ** of tables in the parent pTo table. flags contains all
  94455. ** information about the conflict resolution algorithms specified
  94456. ** in the ON DELETE, ON UPDATE and ON INSERT clauses.
  94457. **
  94458. ** An FKey structure is created and added to the table currently
  94459. ** under construction in the pParse->pNewTable field.
  94460. **
  94461. ** The foreign key is set for IMMEDIATE processing. A subsequent call
  94462. ** to sqlite3DeferForeignKey() might change this to DEFERRED.
  94463. */
  94464. SQLITE_PRIVATE void sqlite3CreateForeignKey(
  94465. Parse *pParse, /* Parsing context */
  94466. ExprList *pFromCol, /* Columns in this table that point to other table */
  94467. Token *pTo, /* Name of the other table */
  94468. ExprList *pToCol, /* Columns in the other table */
  94469. int flags /* Conflict resolution algorithms. */
  94470. ){
  94471. sqlite3 *db = pParse->db;
  94472. #ifndef SQLITE_OMIT_FOREIGN_KEY
  94473. FKey *pFKey = 0;
  94474. FKey *pNextTo;
  94475. Table *p = pParse->pNewTable;
  94476. int nByte;
  94477. int i;
  94478. int nCol;
  94479. char *z;
  94480. assert( pTo!=0 );
  94481. if( p==0 || IN_DECLARE_VTAB ) goto fk_end;
  94482. if( pFromCol==0 ){
  94483. int iCol = p->nCol-1;
  94484. if( NEVER(iCol<0) ) goto fk_end;
  94485. if( pToCol && pToCol->nExpr!=1 ){
  94486. sqlite3ErrorMsg(pParse, "foreign key on %s"
  94487. " should reference only one column of table %T",
  94488. p->aCol[iCol].zName, pTo);
  94489. goto fk_end;
  94490. }
  94491. nCol = 1;
  94492. }else if( pToCol && pToCol->nExpr!=pFromCol->nExpr ){
  94493. sqlite3ErrorMsg(pParse,
  94494. "number of columns in foreign key does not match the number of "
  94495. "columns in the referenced table");
  94496. goto fk_end;
  94497. }else{
  94498. nCol = pFromCol->nExpr;
  94499. }
  94500. nByte = sizeof(*pFKey) + (nCol-1)*sizeof(pFKey->aCol[0]) + pTo->n + 1;
  94501. if( pToCol ){
  94502. for(i=0; i<pToCol->nExpr; i++){
  94503. nByte += sqlite3Strlen30(pToCol->a[i].zName) + 1;
  94504. }
  94505. }
  94506. pFKey = sqlite3DbMallocZero(db, nByte );
  94507. if( pFKey==0 ){
  94508. goto fk_end;
  94509. }
  94510. pFKey->pFrom = p;
  94511. pFKey->pNextFrom = p->pFKey;
  94512. z = (char*)&pFKey->aCol[nCol];
  94513. pFKey->zTo = z;
  94514. memcpy(z, pTo->z, pTo->n);
  94515. z[pTo->n] = 0;
  94516. sqlite3Dequote(z);
  94517. z += pTo->n+1;
  94518. pFKey->nCol = nCol;
  94519. if( pFromCol==0 ){
  94520. pFKey->aCol[0].iFrom = p->nCol-1;
  94521. }else{
  94522. for(i=0; i<nCol; i++){
  94523. int j;
  94524. for(j=0; j<p->nCol; j++){
  94525. if( sqlite3StrICmp(p->aCol[j].zName, pFromCol->a[i].zName)==0 ){
  94526. pFKey->aCol[i].iFrom = j;
  94527. break;
  94528. }
  94529. }
  94530. if( j>=p->nCol ){
  94531. sqlite3ErrorMsg(pParse,
  94532. "unknown column \"%s\" in foreign key definition",
  94533. pFromCol->a[i].zName);
  94534. goto fk_end;
  94535. }
  94536. }
  94537. }
  94538. if( pToCol ){
  94539. for(i=0; i<nCol; i++){
  94540. int n = sqlite3Strlen30(pToCol->a[i].zName);
  94541. pFKey->aCol[i].zCol = z;
  94542. memcpy(z, pToCol->a[i].zName, n);
  94543. z[n] = 0;
  94544. z += n+1;
  94545. }
  94546. }
  94547. pFKey->isDeferred = 0;
  94548. pFKey->aAction[0] = (u8)(flags & 0xff); /* ON DELETE action */
  94549. pFKey->aAction[1] = (u8)((flags >> 8 ) & 0xff); /* ON UPDATE action */
  94550. assert( sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
  94551. pNextTo = (FKey *)sqlite3HashInsert(&p->pSchema->fkeyHash,
  94552. pFKey->zTo, (void *)pFKey
  94553. );
  94554. if( pNextTo==pFKey ){
  94555. sqlite3OomFault(db);
  94556. goto fk_end;
  94557. }
  94558. if( pNextTo ){
  94559. assert( pNextTo->pPrevTo==0 );
  94560. pFKey->pNextTo = pNextTo;
  94561. pNextTo->pPrevTo = pFKey;
  94562. }
  94563. /* Link the foreign key to the table as the last step.
  94564. */
  94565. p->pFKey = pFKey;
  94566. pFKey = 0;
  94567. fk_end:
  94568. sqlite3DbFree(db, pFKey);
  94569. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  94570. sqlite3ExprListDelete(db, pFromCol);
  94571. sqlite3ExprListDelete(db, pToCol);
  94572. }
  94573. /*
  94574. ** This routine is called when an INITIALLY IMMEDIATE or INITIALLY DEFERRED
  94575. ** clause is seen as part of a foreign key definition. The isDeferred
  94576. ** parameter is 1 for INITIALLY DEFERRED and 0 for INITIALLY IMMEDIATE.
  94577. ** The behavior of the most recently created foreign key is adjusted
  94578. ** accordingly.
  94579. */
  94580. SQLITE_PRIVATE void sqlite3DeferForeignKey(Parse *pParse, int isDeferred){
  94581. #ifndef SQLITE_OMIT_FOREIGN_KEY
  94582. Table *pTab;
  94583. FKey *pFKey;
  94584. if( (pTab = pParse->pNewTable)==0 || (pFKey = pTab->pFKey)==0 ) return;
  94585. assert( isDeferred==0 || isDeferred==1 ); /* EV: R-30323-21917 */
  94586. pFKey->isDeferred = (u8)isDeferred;
  94587. #endif
  94588. }
  94589. /*
  94590. ** Generate code that will erase and refill index *pIdx. This is
  94591. ** used to initialize a newly created index or to recompute the
  94592. ** content of an index in response to a REINDEX command.
  94593. **
  94594. ** if memRootPage is not negative, it means that the index is newly
  94595. ** created. The register specified by memRootPage contains the
  94596. ** root page number of the index. If memRootPage is negative, then
  94597. ** the index already exists and must be cleared before being refilled and
  94598. ** the root page number of the index is taken from pIndex->tnum.
  94599. */
  94600. static void sqlite3RefillIndex(Parse *pParse, Index *pIndex, int memRootPage){
  94601. Table *pTab = pIndex->pTable; /* The table that is indexed */
  94602. int iTab = pParse->nTab++; /* Btree cursor used for pTab */
  94603. int iIdx = pParse->nTab++; /* Btree cursor used for pIndex */
  94604. int iSorter; /* Cursor opened by OpenSorter (if in use) */
  94605. int addr1; /* Address of top of loop */
  94606. int addr2; /* Address to jump to for next iteration */
  94607. int tnum; /* Root page of index */
  94608. int iPartIdxLabel; /* Jump to this label to skip a row */
  94609. Vdbe *v; /* Generate code into this virtual machine */
  94610. KeyInfo *pKey; /* KeyInfo for index */
  94611. int regRecord; /* Register holding assembled index record */
  94612. sqlite3 *db = pParse->db; /* The database connection */
  94613. int iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
  94614. #ifndef SQLITE_OMIT_AUTHORIZATION
  94615. if( sqlite3AuthCheck(pParse, SQLITE_REINDEX, pIndex->zName, 0,
  94616. db->aDb[iDb].zDbSName ) ){
  94617. return;
  94618. }
  94619. #endif
  94620. /* Require a write-lock on the table to perform this operation */
  94621. sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
  94622. v = sqlite3GetVdbe(pParse);
  94623. if( v==0 ) return;
  94624. if( memRootPage>=0 ){
  94625. tnum = memRootPage;
  94626. }else{
  94627. tnum = pIndex->tnum;
  94628. }
  94629. pKey = sqlite3KeyInfoOfIndex(pParse, pIndex);
  94630. assert( pKey!=0 || db->mallocFailed || pParse->nErr );
  94631. /* Open the sorter cursor if we are to use one. */
  94632. iSorter = pParse->nTab++;
  94633. sqlite3VdbeAddOp4(v, OP_SorterOpen, iSorter, 0, pIndex->nKeyCol, (char*)
  94634. sqlite3KeyInfoRef(pKey), P4_KEYINFO);
  94635. /* Open the table. Loop through all rows of the table, inserting index
  94636. ** records into the sorter. */
  94637. sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
  94638. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0); VdbeCoverage(v);
  94639. regRecord = sqlite3GetTempReg(pParse);
  94640. sqlite3GenerateIndexKey(pParse,pIndex,iTab,regRecord,0,&iPartIdxLabel,0,0);
  94641. sqlite3VdbeAddOp2(v, OP_SorterInsert, iSorter, regRecord);
  94642. sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
  94643. sqlite3VdbeAddOp2(v, OP_Next, iTab, addr1+1); VdbeCoverage(v);
  94644. sqlite3VdbeJumpHere(v, addr1);
  94645. if( memRootPage<0 ) sqlite3VdbeAddOp2(v, OP_Clear, tnum, iDb);
  94646. sqlite3VdbeAddOp4(v, OP_OpenWrite, iIdx, tnum, iDb,
  94647. (char *)pKey, P4_KEYINFO);
  94648. sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR|((memRootPage>=0)?OPFLAG_P2ISREG:0));
  94649. addr1 = sqlite3VdbeAddOp2(v, OP_SorterSort, iSorter, 0); VdbeCoverage(v);
  94650. if( IsUniqueIndex(pIndex) ){
  94651. int j2 = sqlite3VdbeCurrentAddr(v) + 3;
  94652. sqlite3VdbeGoto(v, j2);
  94653. addr2 = sqlite3VdbeCurrentAddr(v);
  94654. sqlite3VdbeAddOp4Int(v, OP_SorterCompare, iSorter, j2, regRecord,
  94655. pIndex->nKeyCol); VdbeCoverage(v);
  94656. sqlite3UniqueConstraint(pParse, OE_Abort, pIndex);
  94657. }else{
  94658. addr2 = sqlite3VdbeCurrentAddr(v);
  94659. }
  94660. sqlite3VdbeAddOp3(v, OP_SorterData, iSorter, regRecord, iIdx);
  94661. sqlite3VdbeAddOp3(v, OP_Last, iIdx, 0, -1);
  94662. sqlite3VdbeAddOp3(v, OP_IdxInsert, iIdx, regRecord, 0);
  94663. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  94664. sqlite3ReleaseTempReg(pParse, regRecord);
  94665. sqlite3VdbeAddOp2(v, OP_SorterNext, iSorter, addr2); VdbeCoverage(v);
  94666. sqlite3VdbeJumpHere(v, addr1);
  94667. sqlite3VdbeAddOp1(v, OP_Close, iTab);
  94668. sqlite3VdbeAddOp1(v, OP_Close, iIdx);
  94669. sqlite3VdbeAddOp1(v, OP_Close, iSorter);
  94670. }
  94671. /*
  94672. ** Allocate heap space to hold an Index object with nCol columns.
  94673. **
  94674. ** Increase the allocation size to provide an extra nExtra bytes
  94675. ** of 8-byte aligned space after the Index object and return a
  94676. ** pointer to this extra space in *ppExtra.
  94677. */
  94678. SQLITE_PRIVATE Index *sqlite3AllocateIndexObject(
  94679. sqlite3 *db, /* Database connection */
  94680. i16 nCol, /* Total number of columns in the index */
  94681. int nExtra, /* Number of bytes of extra space to alloc */
  94682. char **ppExtra /* Pointer to the "extra" space */
  94683. ){
  94684. Index *p; /* Allocated index object */
  94685. int nByte; /* Bytes of space for Index object + arrays */
  94686. nByte = ROUND8(sizeof(Index)) + /* Index structure */
  94687. ROUND8(sizeof(char*)*nCol) + /* Index.azColl */
  94688. ROUND8(sizeof(LogEst)*(nCol+1) + /* Index.aiRowLogEst */
  94689. sizeof(i16)*nCol + /* Index.aiColumn */
  94690. sizeof(u8)*nCol); /* Index.aSortOrder */
  94691. p = sqlite3DbMallocZero(db, nByte + nExtra);
  94692. if( p ){
  94693. char *pExtra = ((char*)p)+ROUND8(sizeof(Index));
  94694. p->azColl = (const char**)pExtra; pExtra += ROUND8(sizeof(char*)*nCol);
  94695. p->aiRowLogEst = (LogEst*)pExtra; pExtra += sizeof(LogEst)*(nCol+1);
  94696. p->aiColumn = (i16*)pExtra; pExtra += sizeof(i16)*nCol;
  94697. p->aSortOrder = (u8*)pExtra;
  94698. p->nColumn = nCol;
  94699. p->nKeyCol = nCol - 1;
  94700. *ppExtra = ((char*)p) + nByte;
  94701. }
  94702. return p;
  94703. }
  94704. /*
  94705. ** Create a new index for an SQL table. pName1.pName2 is the name of the index
  94706. ** and pTblList is the name of the table that is to be indexed. Both will
  94707. ** be NULL for a primary key or an index that is created to satisfy a
  94708. ** UNIQUE constraint. If pTable and pIndex are NULL, use pParse->pNewTable
  94709. ** as the table to be indexed. pParse->pNewTable is a table that is
  94710. ** currently being constructed by a CREATE TABLE statement.
  94711. **
  94712. ** pList is a list of columns to be indexed. pList will be NULL if this
  94713. ** is a primary key or unique-constraint on the most recent column added
  94714. ** to the table currently under construction.
  94715. */
  94716. SQLITE_PRIVATE void sqlite3CreateIndex(
  94717. Parse *pParse, /* All information about this parse */
  94718. Token *pName1, /* First part of index name. May be NULL */
  94719. Token *pName2, /* Second part of index name. May be NULL */
  94720. SrcList *pTblName, /* Table to index. Use pParse->pNewTable if 0 */
  94721. ExprList *pList, /* A list of columns to be indexed */
  94722. int onError, /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
  94723. Token *pStart, /* The CREATE token that begins this statement */
  94724. Expr *pPIWhere, /* WHERE clause for partial indices */
  94725. int sortOrder, /* Sort order of primary key when pList==NULL */
  94726. int ifNotExist, /* Omit error if index already exists */
  94727. u8 idxType /* The index type */
  94728. ){
  94729. Table *pTab = 0; /* Table to be indexed */
  94730. Index *pIndex = 0; /* The index to be created */
  94731. char *zName = 0; /* Name of the index */
  94732. int nName; /* Number of characters in zName */
  94733. int i, j;
  94734. DbFixer sFix; /* For assigning database names to pTable */
  94735. int sortOrderMask; /* 1 to honor DESC in index. 0 to ignore. */
  94736. sqlite3 *db = pParse->db;
  94737. Db *pDb; /* The specific table containing the indexed database */
  94738. int iDb; /* Index of the database that is being written */
  94739. Token *pName = 0; /* Unqualified name of the index to create */
  94740. struct ExprList_item *pListItem; /* For looping over pList */
  94741. int nExtra = 0; /* Space allocated for zExtra[] */
  94742. int nExtraCol; /* Number of extra columns needed */
  94743. char *zExtra = 0; /* Extra space after the Index object */
  94744. Index *pPk = 0; /* PRIMARY KEY index for WITHOUT ROWID tables */
  94745. if( db->mallocFailed || pParse->nErr>0 ){
  94746. goto exit_create_index;
  94747. }
  94748. if( IN_DECLARE_VTAB && idxType!=SQLITE_IDXTYPE_PRIMARYKEY ){
  94749. goto exit_create_index;
  94750. }
  94751. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  94752. goto exit_create_index;
  94753. }
  94754. /*
  94755. ** Find the table that is to be indexed. Return early if not found.
  94756. */
  94757. if( pTblName!=0 ){
  94758. /* Use the two-part index name to determine the database
  94759. ** to search for the table. 'Fix' the table name to this db
  94760. ** before looking up the table.
  94761. */
  94762. assert( pName1 && pName2 );
  94763. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  94764. if( iDb<0 ) goto exit_create_index;
  94765. assert( pName && pName->z );
  94766. #ifndef SQLITE_OMIT_TEMPDB
  94767. /* If the index name was unqualified, check if the table
  94768. ** is a temp table. If so, set the database to 1. Do not do this
  94769. ** if initialising a database schema.
  94770. */
  94771. if( !db->init.busy ){
  94772. pTab = sqlite3SrcListLookup(pParse, pTblName);
  94773. if( pName2->n==0 && pTab && pTab->pSchema==db->aDb[1].pSchema ){
  94774. iDb = 1;
  94775. }
  94776. }
  94777. #endif
  94778. sqlite3FixInit(&sFix, pParse, iDb, "index", pName);
  94779. if( sqlite3FixSrcList(&sFix, pTblName) ){
  94780. /* Because the parser constructs pTblName from a single identifier,
  94781. ** sqlite3FixSrcList can never fail. */
  94782. assert(0);
  94783. }
  94784. pTab = sqlite3LocateTableItem(pParse, 0, &pTblName->a[0]);
  94785. assert( db->mallocFailed==0 || pTab==0 );
  94786. if( pTab==0 ) goto exit_create_index;
  94787. if( iDb==1 && db->aDb[iDb].pSchema!=pTab->pSchema ){
  94788. sqlite3ErrorMsg(pParse,
  94789. "cannot create a TEMP index on non-TEMP table \"%s\"",
  94790. pTab->zName);
  94791. goto exit_create_index;
  94792. }
  94793. if( !HasRowid(pTab) ) pPk = sqlite3PrimaryKeyIndex(pTab);
  94794. }else{
  94795. assert( pName==0 );
  94796. assert( pStart==0 );
  94797. pTab = pParse->pNewTable;
  94798. if( !pTab ) goto exit_create_index;
  94799. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  94800. }
  94801. pDb = &db->aDb[iDb];
  94802. assert( pTab!=0 );
  94803. assert( pParse->nErr==0 );
  94804. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
  94805. && db->init.busy==0
  94806. #if SQLITE_USER_AUTHENTICATION
  94807. && sqlite3UserAuthTable(pTab->zName)==0
  94808. #endif
  94809. && sqlite3StrNICmp(&pTab->zName[7],"altertab_",9)!=0 ){
  94810. sqlite3ErrorMsg(pParse, "table %s may not be indexed", pTab->zName);
  94811. goto exit_create_index;
  94812. }
  94813. #ifndef SQLITE_OMIT_VIEW
  94814. if( pTab->pSelect ){
  94815. sqlite3ErrorMsg(pParse, "views may not be indexed");
  94816. goto exit_create_index;
  94817. }
  94818. #endif
  94819. #ifndef SQLITE_OMIT_VIRTUALTABLE
  94820. if( IsVirtual(pTab) ){
  94821. sqlite3ErrorMsg(pParse, "virtual tables may not be indexed");
  94822. goto exit_create_index;
  94823. }
  94824. #endif
  94825. /*
  94826. ** Find the name of the index. Make sure there is not already another
  94827. ** index or table with the same name.
  94828. **
  94829. ** Exception: If we are reading the names of permanent indices from the
  94830. ** sqlite_master table (because some other process changed the schema) and
  94831. ** one of the index names collides with the name of a temporary table or
  94832. ** index, then we will continue to process this index.
  94833. **
  94834. ** If pName==0 it means that we are
  94835. ** dealing with a primary key or UNIQUE constraint. We have to invent our
  94836. ** own name.
  94837. */
  94838. if( pName ){
  94839. zName = sqlite3NameFromToken(db, pName);
  94840. if( zName==0 ) goto exit_create_index;
  94841. assert( pName->z!=0 );
  94842. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  94843. goto exit_create_index;
  94844. }
  94845. if( !db->init.busy ){
  94846. if( sqlite3FindTable(db, zName, 0)!=0 ){
  94847. sqlite3ErrorMsg(pParse, "there is already a table named %s", zName);
  94848. goto exit_create_index;
  94849. }
  94850. }
  94851. if( sqlite3FindIndex(db, zName, pDb->zDbSName)!=0 ){
  94852. if( !ifNotExist ){
  94853. sqlite3ErrorMsg(pParse, "index %s already exists", zName);
  94854. }else{
  94855. assert( !db->init.busy );
  94856. sqlite3CodeVerifySchema(pParse, iDb);
  94857. }
  94858. goto exit_create_index;
  94859. }
  94860. }else{
  94861. int n;
  94862. Index *pLoop;
  94863. for(pLoop=pTab->pIndex, n=1; pLoop; pLoop=pLoop->pNext, n++){}
  94864. zName = sqlite3MPrintf(db, "sqlite_autoindex_%s_%d", pTab->zName, n);
  94865. if( zName==0 ){
  94866. goto exit_create_index;
  94867. }
  94868. /* Automatic index names generated from within sqlite3_declare_vtab()
  94869. ** must have names that are distinct from normal automatic index names.
  94870. ** The following statement converts "sqlite3_autoindex..." into
  94871. ** "sqlite3_butoindex..." in order to make the names distinct.
  94872. ** The "vtab_err.test" test demonstrates the need of this statement. */
  94873. if( IN_DECLARE_VTAB ) zName[7]++;
  94874. }
  94875. /* Check for authorization to create an index.
  94876. */
  94877. #ifndef SQLITE_OMIT_AUTHORIZATION
  94878. {
  94879. const char *zDb = pDb->zDbSName;
  94880. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iDb), 0, zDb) ){
  94881. goto exit_create_index;
  94882. }
  94883. i = SQLITE_CREATE_INDEX;
  94884. if( !OMIT_TEMPDB && iDb==1 ) i = SQLITE_CREATE_TEMP_INDEX;
  94885. if( sqlite3AuthCheck(pParse, i, zName, pTab->zName, zDb) ){
  94886. goto exit_create_index;
  94887. }
  94888. }
  94889. #endif
  94890. /* If pList==0, it means this routine was called to make a primary
  94891. ** key out of the last column added to the table under construction.
  94892. ** So create a fake list to simulate this.
  94893. */
  94894. if( pList==0 ){
  94895. Token prevCol;
  94896. sqlite3TokenInit(&prevCol, pTab->aCol[pTab->nCol-1].zName);
  94897. pList = sqlite3ExprListAppend(pParse, 0,
  94898. sqlite3ExprAlloc(db, TK_ID, &prevCol, 0));
  94899. if( pList==0 ) goto exit_create_index;
  94900. assert( pList->nExpr==1 );
  94901. sqlite3ExprListSetSortOrder(pList, sortOrder);
  94902. }else{
  94903. sqlite3ExprListCheckLength(pParse, pList, "index");
  94904. }
  94905. /* Figure out how many bytes of space are required to store explicitly
  94906. ** specified collation sequence names.
  94907. */
  94908. for(i=0; i<pList->nExpr; i++){
  94909. Expr *pExpr = pList->a[i].pExpr;
  94910. assert( pExpr!=0 );
  94911. if( pExpr->op==TK_COLLATE ){
  94912. nExtra += (1 + sqlite3Strlen30(pExpr->u.zToken));
  94913. }
  94914. }
  94915. /*
  94916. ** Allocate the index structure.
  94917. */
  94918. nName = sqlite3Strlen30(zName);
  94919. nExtraCol = pPk ? pPk->nKeyCol : 1;
  94920. pIndex = sqlite3AllocateIndexObject(db, pList->nExpr + nExtraCol,
  94921. nName + nExtra + 1, &zExtra);
  94922. if( db->mallocFailed ){
  94923. goto exit_create_index;
  94924. }
  94925. assert( EIGHT_BYTE_ALIGNMENT(pIndex->aiRowLogEst) );
  94926. assert( EIGHT_BYTE_ALIGNMENT(pIndex->azColl) );
  94927. pIndex->zName = zExtra;
  94928. zExtra += nName + 1;
  94929. memcpy(pIndex->zName, zName, nName+1);
  94930. pIndex->pTable = pTab;
  94931. pIndex->onError = (u8)onError;
  94932. pIndex->uniqNotNull = onError!=OE_None;
  94933. pIndex->idxType = idxType;
  94934. pIndex->pSchema = db->aDb[iDb].pSchema;
  94935. pIndex->nKeyCol = pList->nExpr;
  94936. if( pPIWhere ){
  94937. sqlite3ResolveSelfReference(pParse, pTab, NC_PartIdx, pPIWhere, 0);
  94938. pIndex->pPartIdxWhere = pPIWhere;
  94939. pPIWhere = 0;
  94940. }
  94941. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  94942. /* Check to see if we should honor DESC requests on index columns
  94943. */
  94944. if( pDb->pSchema->file_format>=4 ){
  94945. sortOrderMask = -1; /* Honor DESC */
  94946. }else{
  94947. sortOrderMask = 0; /* Ignore DESC */
  94948. }
  94949. /* Analyze the list of expressions that form the terms of the index and
  94950. ** report any errors. In the common case where the expression is exactly
  94951. ** a table column, store that column in aiColumn[]. For general expressions,
  94952. ** populate pIndex->aColExpr and store XN_EXPR (-2) in aiColumn[].
  94953. **
  94954. ** TODO: Issue a warning if two or more columns of the index are identical.
  94955. ** TODO: Issue a warning if the table primary key is used as part of the
  94956. ** index key.
  94957. */
  94958. for(i=0, pListItem=pList->a; i<pList->nExpr; i++, pListItem++){
  94959. Expr *pCExpr; /* The i-th index expression */
  94960. int requestedSortOrder; /* ASC or DESC on the i-th expression */
  94961. const char *zColl; /* Collation sequence name */
  94962. sqlite3StringToId(pListItem->pExpr);
  94963. sqlite3ResolveSelfReference(pParse, pTab, NC_IdxExpr, pListItem->pExpr, 0);
  94964. if( pParse->nErr ) goto exit_create_index;
  94965. pCExpr = sqlite3ExprSkipCollate(pListItem->pExpr);
  94966. if( pCExpr->op!=TK_COLUMN ){
  94967. if( pTab==pParse->pNewTable ){
  94968. sqlite3ErrorMsg(pParse, "expressions prohibited in PRIMARY KEY and "
  94969. "UNIQUE constraints");
  94970. goto exit_create_index;
  94971. }
  94972. if( pIndex->aColExpr==0 ){
  94973. ExprList *pCopy = sqlite3ExprListDup(db, pList, 0);
  94974. pIndex->aColExpr = pCopy;
  94975. if( !db->mallocFailed ){
  94976. assert( pCopy!=0 );
  94977. pListItem = &pCopy->a[i];
  94978. }
  94979. }
  94980. j = XN_EXPR;
  94981. pIndex->aiColumn[i] = XN_EXPR;
  94982. pIndex->uniqNotNull = 0;
  94983. }else{
  94984. j = pCExpr->iColumn;
  94985. assert( j<=0x7fff );
  94986. if( j<0 ){
  94987. j = pTab->iPKey;
  94988. }else if( pTab->aCol[j].notNull==0 ){
  94989. pIndex->uniqNotNull = 0;
  94990. }
  94991. pIndex->aiColumn[i] = (i16)j;
  94992. }
  94993. zColl = 0;
  94994. if( pListItem->pExpr->op==TK_COLLATE ){
  94995. int nColl;
  94996. zColl = pListItem->pExpr->u.zToken;
  94997. nColl = sqlite3Strlen30(zColl) + 1;
  94998. assert( nExtra>=nColl );
  94999. memcpy(zExtra, zColl, nColl);
  95000. zColl = zExtra;
  95001. zExtra += nColl;
  95002. nExtra -= nColl;
  95003. }else if( j>=0 ){
  95004. zColl = pTab->aCol[j].zColl;
  95005. }
  95006. if( !zColl ) zColl = sqlite3StrBINARY;
  95007. if( !db->init.busy && !sqlite3LocateCollSeq(pParse, zColl) ){
  95008. goto exit_create_index;
  95009. }
  95010. pIndex->azColl[i] = zColl;
  95011. requestedSortOrder = pListItem->sortOrder & sortOrderMask;
  95012. pIndex->aSortOrder[i] = (u8)requestedSortOrder;
  95013. }
  95014. /* Append the table key to the end of the index. For WITHOUT ROWID
  95015. ** tables (when pPk!=0) this will be the declared PRIMARY KEY. For
  95016. ** normal tables (when pPk==0) this will be the rowid.
  95017. */
  95018. if( pPk ){
  95019. for(j=0; j<pPk->nKeyCol; j++){
  95020. int x = pPk->aiColumn[j];
  95021. assert( x>=0 );
  95022. if( hasColumn(pIndex->aiColumn, pIndex->nKeyCol, x) ){
  95023. pIndex->nColumn--;
  95024. }else{
  95025. pIndex->aiColumn[i] = x;
  95026. pIndex->azColl[i] = pPk->azColl[j];
  95027. pIndex->aSortOrder[i] = pPk->aSortOrder[j];
  95028. i++;
  95029. }
  95030. }
  95031. assert( i==pIndex->nColumn );
  95032. }else{
  95033. pIndex->aiColumn[i] = XN_ROWID;
  95034. pIndex->azColl[i] = sqlite3StrBINARY;
  95035. }
  95036. sqlite3DefaultRowEst(pIndex);
  95037. if( pParse->pNewTable==0 ) estimateIndexWidth(pIndex);
  95038. /* If this index contains every column of its table, then mark
  95039. ** it as a covering index */
  95040. assert( HasRowid(pTab)
  95041. || pTab->iPKey<0 || sqlite3ColumnOfIndex(pIndex, pTab->iPKey)>=0 );
  95042. if( pTblName!=0 && pIndex->nColumn>=pTab->nCol ){
  95043. pIndex->isCovering = 1;
  95044. for(j=0; j<pTab->nCol; j++){
  95045. if( j==pTab->iPKey ) continue;
  95046. if( sqlite3ColumnOfIndex(pIndex,j)>=0 ) continue;
  95047. pIndex->isCovering = 0;
  95048. break;
  95049. }
  95050. }
  95051. if( pTab==pParse->pNewTable ){
  95052. /* This routine has been called to create an automatic index as a
  95053. ** result of a PRIMARY KEY or UNIQUE clause on a column definition, or
  95054. ** a PRIMARY KEY or UNIQUE clause following the column definitions.
  95055. ** i.e. one of:
  95056. **
  95057. ** CREATE TABLE t(x PRIMARY KEY, y);
  95058. ** CREATE TABLE t(x, y, UNIQUE(x, y));
  95059. **
  95060. ** Either way, check to see if the table already has such an index. If
  95061. ** so, don't bother creating this one. This only applies to
  95062. ** automatically created indices. Users can do as they wish with
  95063. ** explicit indices.
  95064. **
  95065. ** Two UNIQUE or PRIMARY KEY constraints are considered equivalent
  95066. ** (and thus suppressing the second one) even if they have different
  95067. ** sort orders.
  95068. **
  95069. ** If there are different collating sequences or if the columns of
  95070. ** the constraint occur in different orders, then the constraints are
  95071. ** considered distinct and both result in separate indices.
  95072. */
  95073. Index *pIdx;
  95074. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  95075. int k;
  95076. assert( IsUniqueIndex(pIdx) );
  95077. assert( pIdx->idxType!=SQLITE_IDXTYPE_APPDEF );
  95078. assert( IsUniqueIndex(pIndex) );
  95079. if( pIdx->nKeyCol!=pIndex->nKeyCol ) continue;
  95080. for(k=0; k<pIdx->nKeyCol; k++){
  95081. const char *z1;
  95082. const char *z2;
  95083. assert( pIdx->aiColumn[k]>=0 );
  95084. if( pIdx->aiColumn[k]!=pIndex->aiColumn[k] ) break;
  95085. z1 = pIdx->azColl[k];
  95086. z2 = pIndex->azColl[k];
  95087. if( sqlite3StrICmp(z1, z2) ) break;
  95088. }
  95089. if( k==pIdx->nKeyCol ){
  95090. if( pIdx->onError!=pIndex->onError ){
  95091. /* This constraint creates the same index as a previous
  95092. ** constraint specified somewhere in the CREATE TABLE statement.
  95093. ** However the ON CONFLICT clauses are different. If both this
  95094. ** constraint and the previous equivalent constraint have explicit
  95095. ** ON CONFLICT clauses this is an error. Otherwise, use the
  95096. ** explicitly specified behavior for the index.
  95097. */
  95098. if( !(pIdx->onError==OE_Default || pIndex->onError==OE_Default) ){
  95099. sqlite3ErrorMsg(pParse,
  95100. "conflicting ON CONFLICT clauses specified", 0);
  95101. }
  95102. if( pIdx->onError==OE_Default ){
  95103. pIdx->onError = pIndex->onError;
  95104. }
  95105. }
  95106. if( idxType==SQLITE_IDXTYPE_PRIMARYKEY ) pIdx->idxType = idxType;
  95107. goto exit_create_index;
  95108. }
  95109. }
  95110. }
  95111. /* Link the new Index structure to its table and to the other
  95112. ** in-memory database structures.
  95113. */
  95114. assert( pParse->nErr==0 );
  95115. if( db->init.busy ){
  95116. Index *p;
  95117. assert( !IN_DECLARE_VTAB );
  95118. assert( sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
  95119. p = sqlite3HashInsert(&pIndex->pSchema->idxHash,
  95120. pIndex->zName, pIndex);
  95121. if( p ){
  95122. assert( p==pIndex ); /* Malloc must have failed */
  95123. sqlite3OomFault(db);
  95124. goto exit_create_index;
  95125. }
  95126. db->flags |= SQLITE_InternChanges;
  95127. if( pTblName!=0 ){
  95128. pIndex->tnum = db->init.newTnum;
  95129. }
  95130. }
  95131. /* If this is the initial CREATE INDEX statement (or CREATE TABLE if the
  95132. ** index is an implied index for a UNIQUE or PRIMARY KEY constraint) then
  95133. ** emit code to allocate the index rootpage on disk and make an entry for
  95134. ** the index in the sqlite_master table and populate the index with
  95135. ** content. But, do not do this if we are simply reading the sqlite_master
  95136. ** table to parse the schema, or if this index is the PRIMARY KEY index
  95137. ** of a WITHOUT ROWID table.
  95138. **
  95139. ** If pTblName==0 it means this index is generated as an implied PRIMARY KEY
  95140. ** or UNIQUE index in a CREATE TABLE statement. Since the table
  95141. ** has just been created, it contains no data and the index initialization
  95142. ** step can be skipped.
  95143. */
  95144. else if( HasRowid(pTab) || pTblName!=0 ){
  95145. Vdbe *v;
  95146. char *zStmt;
  95147. int iMem = ++pParse->nMem;
  95148. v = sqlite3GetVdbe(pParse);
  95149. if( v==0 ) goto exit_create_index;
  95150. sqlite3BeginWriteOperation(pParse, 1, iDb);
  95151. /* Create the rootpage for the index using CreateIndex. But before
  95152. ** doing so, code a Noop instruction and store its address in
  95153. ** Index.tnum. This is required in case this index is actually a
  95154. ** PRIMARY KEY and the table is actually a WITHOUT ROWID table. In
  95155. ** that case the convertToWithoutRowidTable() routine will replace
  95156. ** the Noop with a Goto to jump over the VDBE code generated below. */
  95157. pIndex->tnum = sqlite3VdbeAddOp0(v, OP_Noop);
  95158. sqlite3VdbeAddOp2(v, OP_CreateIndex, iDb, iMem);
  95159. /* Gather the complete text of the CREATE INDEX statement into
  95160. ** the zStmt variable
  95161. */
  95162. if( pStart ){
  95163. int n = (int)(pParse->sLastToken.z - pName->z) + pParse->sLastToken.n;
  95164. if( pName->z[n-1]==';' ) n--;
  95165. /* A named index with an explicit CREATE INDEX statement */
  95166. zStmt = sqlite3MPrintf(db, "CREATE%s INDEX %.*s",
  95167. onError==OE_None ? "" : " UNIQUE", n, pName->z);
  95168. }else{
  95169. /* An automatic index created by a PRIMARY KEY or UNIQUE constraint */
  95170. /* zStmt = sqlite3MPrintf(""); */
  95171. zStmt = 0;
  95172. }
  95173. /* Add an entry in sqlite_master for this index
  95174. */
  95175. sqlite3NestedParse(pParse,
  95176. "INSERT INTO %Q.%s VALUES('index',%Q,%Q,#%d,%Q);",
  95177. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb),
  95178. pIndex->zName,
  95179. pTab->zName,
  95180. iMem,
  95181. zStmt
  95182. );
  95183. sqlite3DbFree(db, zStmt);
  95184. /* Fill the index with data and reparse the schema. Code an OP_Expire
  95185. ** to invalidate all pre-compiled statements.
  95186. */
  95187. if( pTblName ){
  95188. sqlite3RefillIndex(pParse, pIndex, iMem);
  95189. sqlite3ChangeCookie(pParse, iDb);
  95190. sqlite3VdbeAddParseSchemaOp(v, iDb,
  95191. sqlite3MPrintf(db, "name='%q' AND type='index'", pIndex->zName));
  95192. sqlite3VdbeAddOp0(v, OP_Expire);
  95193. }
  95194. sqlite3VdbeJumpHere(v, pIndex->tnum);
  95195. }
  95196. /* When adding an index to the list of indices for a table, make
  95197. ** sure all indices labeled OE_Replace come after all those labeled
  95198. ** OE_Ignore. This is necessary for the correct constraint check
  95199. ** processing (in sqlite3GenerateConstraintChecks()) as part of
  95200. ** UPDATE and INSERT statements.
  95201. */
  95202. if( db->init.busy || pTblName==0 ){
  95203. if( onError!=OE_Replace || pTab->pIndex==0
  95204. || pTab->pIndex->onError==OE_Replace){
  95205. pIndex->pNext = pTab->pIndex;
  95206. pTab->pIndex = pIndex;
  95207. }else{
  95208. Index *pOther = pTab->pIndex;
  95209. while( pOther->pNext && pOther->pNext->onError!=OE_Replace ){
  95210. pOther = pOther->pNext;
  95211. }
  95212. pIndex->pNext = pOther->pNext;
  95213. pOther->pNext = pIndex;
  95214. }
  95215. pIndex = 0;
  95216. }
  95217. /* Clean up before exiting */
  95218. exit_create_index:
  95219. if( pIndex ) freeIndex(db, pIndex);
  95220. sqlite3ExprDelete(db, pPIWhere);
  95221. sqlite3ExprListDelete(db, pList);
  95222. sqlite3SrcListDelete(db, pTblName);
  95223. sqlite3DbFree(db, zName);
  95224. }
  95225. /*
  95226. ** Fill the Index.aiRowEst[] array with default information - information
  95227. ** to be used when we have not run the ANALYZE command.
  95228. **
  95229. ** aiRowEst[0] is supposed to contain the number of elements in the index.
  95230. ** Since we do not know, guess 1 million. aiRowEst[1] is an estimate of the
  95231. ** number of rows in the table that match any particular value of the
  95232. ** first column of the index. aiRowEst[2] is an estimate of the number
  95233. ** of rows that match any particular combination of the first 2 columns
  95234. ** of the index. And so forth. It must always be the case that
  95235. *
  95236. ** aiRowEst[N]<=aiRowEst[N-1]
  95237. ** aiRowEst[N]>=1
  95238. **
  95239. ** Apart from that, we have little to go on besides intuition as to
  95240. ** how aiRowEst[] should be initialized. The numbers generated here
  95241. ** are based on typical values found in actual indices.
  95242. */
  95243. SQLITE_PRIVATE void sqlite3DefaultRowEst(Index *pIdx){
  95244. /* 10, 9, 8, 7, 6 */
  95245. LogEst aVal[] = { 33, 32, 30, 28, 26 };
  95246. LogEst *a = pIdx->aiRowLogEst;
  95247. int nCopy = MIN(ArraySize(aVal), pIdx->nKeyCol);
  95248. int i;
  95249. /* Set the first entry (number of rows in the index) to the estimated
  95250. ** number of rows in the table, or half the number of rows in the table
  95251. ** for a partial index. But do not let the estimate drop below 10. */
  95252. a[0] = pIdx->pTable->nRowLogEst;
  95253. if( pIdx->pPartIdxWhere!=0 ) a[0] -= 10; assert( 10==sqlite3LogEst(2) );
  95254. if( a[0]<33 ) a[0] = 33; assert( 33==sqlite3LogEst(10) );
  95255. /* Estimate that a[1] is 10, a[2] is 9, a[3] is 8, a[4] is 7, a[5] is
  95256. ** 6 and each subsequent value (if any) is 5. */
  95257. memcpy(&a[1], aVal, nCopy*sizeof(LogEst));
  95258. for(i=nCopy+1; i<=pIdx->nKeyCol; i++){
  95259. a[i] = 23; assert( 23==sqlite3LogEst(5) );
  95260. }
  95261. assert( 0==sqlite3LogEst(1) );
  95262. if( IsUniqueIndex(pIdx) ) a[pIdx->nKeyCol] = 0;
  95263. }
  95264. /*
  95265. ** This routine will drop an existing named index. This routine
  95266. ** implements the DROP INDEX statement.
  95267. */
  95268. SQLITE_PRIVATE void sqlite3DropIndex(Parse *pParse, SrcList *pName, int ifExists){
  95269. Index *pIndex;
  95270. Vdbe *v;
  95271. sqlite3 *db = pParse->db;
  95272. int iDb;
  95273. assert( pParse->nErr==0 ); /* Never called with prior errors */
  95274. if( db->mallocFailed ){
  95275. goto exit_drop_index;
  95276. }
  95277. assert( pName->nSrc==1 );
  95278. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  95279. goto exit_drop_index;
  95280. }
  95281. pIndex = sqlite3FindIndex(db, pName->a[0].zName, pName->a[0].zDatabase);
  95282. if( pIndex==0 ){
  95283. if( !ifExists ){
  95284. sqlite3ErrorMsg(pParse, "no such index: %S", pName, 0);
  95285. }else{
  95286. sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
  95287. }
  95288. pParse->checkSchema = 1;
  95289. goto exit_drop_index;
  95290. }
  95291. if( pIndex->idxType!=SQLITE_IDXTYPE_APPDEF ){
  95292. sqlite3ErrorMsg(pParse, "index associated with UNIQUE "
  95293. "or PRIMARY KEY constraint cannot be dropped", 0);
  95294. goto exit_drop_index;
  95295. }
  95296. iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
  95297. #ifndef SQLITE_OMIT_AUTHORIZATION
  95298. {
  95299. int code = SQLITE_DROP_INDEX;
  95300. Table *pTab = pIndex->pTable;
  95301. const char *zDb = db->aDb[iDb].zDbSName;
  95302. const char *zTab = SCHEMA_TABLE(iDb);
  95303. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
  95304. goto exit_drop_index;
  95305. }
  95306. if( !OMIT_TEMPDB && iDb ) code = SQLITE_DROP_TEMP_INDEX;
  95307. if( sqlite3AuthCheck(pParse, code, pIndex->zName, pTab->zName, zDb) ){
  95308. goto exit_drop_index;
  95309. }
  95310. }
  95311. #endif
  95312. /* Generate code to remove the index and from the master table */
  95313. v = sqlite3GetVdbe(pParse);
  95314. if( v ){
  95315. sqlite3BeginWriteOperation(pParse, 1, iDb);
  95316. sqlite3NestedParse(pParse,
  95317. "DELETE FROM %Q.%s WHERE name=%Q AND type='index'",
  95318. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb), pIndex->zName
  95319. );
  95320. sqlite3ClearStatTables(pParse, iDb, "idx", pIndex->zName);
  95321. sqlite3ChangeCookie(pParse, iDb);
  95322. destroyRootPage(pParse, pIndex->tnum, iDb);
  95323. sqlite3VdbeAddOp4(v, OP_DropIndex, iDb, 0, 0, pIndex->zName, 0);
  95324. }
  95325. exit_drop_index:
  95326. sqlite3SrcListDelete(db, pName);
  95327. }
  95328. /*
  95329. ** pArray is a pointer to an array of objects. Each object in the
  95330. ** array is szEntry bytes in size. This routine uses sqlite3DbRealloc()
  95331. ** to extend the array so that there is space for a new object at the end.
  95332. **
  95333. ** When this function is called, *pnEntry contains the current size of
  95334. ** the array (in entries - so the allocation is ((*pnEntry) * szEntry) bytes
  95335. ** in total).
  95336. **
  95337. ** If the realloc() is successful (i.e. if no OOM condition occurs), the
  95338. ** space allocated for the new object is zeroed, *pnEntry updated to
  95339. ** reflect the new size of the array and a pointer to the new allocation
  95340. ** returned. *pIdx is set to the index of the new array entry in this case.
  95341. **
  95342. ** Otherwise, if the realloc() fails, *pIdx is set to -1, *pnEntry remains
  95343. ** unchanged and a copy of pArray returned.
  95344. */
  95345. SQLITE_PRIVATE void *sqlite3ArrayAllocate(
  95346. sqlite3 *db, /* Connection to notify of malloc failures */
  95347. void *pArray, /* Array of objects. Might be reallocated */
  95348. int szEntry, /* Size of each object in the array */
  95349. int *pnEntry, /* Number of objects currently in use */
  95350. int *pIdx /* Write the index of a new slot here */
  95351. ){
  95352. char *z;
  95353. int n = *pnEntry;
  95354. if( (n & (n-1))==0 ){
  95355. int sz = (n==0) ? 1 : 2*n;
  95356. void *pNew = sqlite3DbRealloc(db, pArray, sz*szEntry);
  95357. if( pNew==0 ){
  95358. *pIdx = -1;
  95359. return pArray;
  95360. }
  95361. pArray = pNew;
  95362. }
  95363. z = (char*)pArray;
  95364. memset(&z[n * szEntry], 0, szEntry);
  95365. *pIdx = n;
  95366. ++*pnEntry;
  95367. return pArray;
  95368. }
  95369. /*
  95370. ** Append a new element to the given IdList. Create a new IdList if
  95371. ** need be.
  95372. **
  95373. ** A new IdList is returned, or NULL if malloc() fails.
  95374. */
  95375. SQLITE_PRIVATE IdList *sqlite3IdListAppend(sqlite3 *db, IdList *pList, Token *pToken){
  95376. int i;
  95377. if( pList==0 ){
  95378. pList = sqlite3DbMallocZero(db, sizeof(IdList) );
  95379. if( pList==0 ) return 0;
  95380. }
  95381. pList->a = sqlite3ArrayAllocate(
  95382. db,
  95383. pList->a,
  95384. sizeof(pList->a[0]),
  95385. &pList->nId,
  95386. &i
  95387. );
  95388. if( i<0 ){
  95389. sqlite3IdListDelete(db, pList);
  95390. return 0;
  95391. }
  95392. pList->a[i].zName = sqlite3NameFromToken(db, pToken);
  95393. return pList;
  95394. }
  95395. /*
  95396. ** Delete an IdList.
  95397. */
  95398. SQLITE_PRIVATE void sqlite3IdListDelete(sqlite3 *db, IdList *pList){
  95399. int i;
  95400. if( pList==0 ) return;
  95401. for(i=0; i<pList->nId; i++){
  95402. sqlite3DbFree(db, pList->a[i].zName);
  95403. }
  95404. sqlite3DbFree(db, pList->a);
  95405. sqlite3DbFree(db, pList);
  95406. }
  95407. /*
  95408. ** Return the index in pList of the identifier named zId. Return -1
  95409. ** if not found.
  95410. */
  95411. SQLITE_PRIVATE int sqlite3IdListIndex(IdList *pList, const char *zName){
  95412. int i;
  95413. if( pList==0 ) return -1;
  95414. for(i=0; i<pList->nId; i++){
  95415. if( sqlite3StrICmp(pList->a[i].zName, zName)==0 ) return i;
  95416. }
  95417. return -1;
  95418. }
  95419. /*
  95420. ** Expand the space allocated for the given SrcList object by
  95421. ** creating nExtra new slots beginning at iStart. iStart is zero based.
  95422. ** New slots are zeroed.
  95423. **
  95424. ** For example, suppose a SrcList initially contains two entries: A,B.
  95425. ** To append 3 new entries onto the end, do this:
  95426. **
  95427. ** sqlite3SrcListEnlarge(db, pSrclist, 3, 2);
  95428. **
  95429. ** After the call above it would contain: A, B, nil, nil, nil.
  95430. ** If the iStart argument had been 1 instead of 2, then the result
  95431. ** would have been: A, nil, nil, nil, B. To prepend the new slots,
  95432. ** the iStart value would be 0. The result then would
  95433. ** be: nil, nil, nil, A, B.
  95434. **
  95435. ** If a memory allocation fails the SrcList is unchanged. The
  95436. ** db->mallocFailed flag will be set to true.
  95437. */
  95438. SQLITE_PRIVATE SrcList *sqlite3SrcListEnlarge(
  95439. sqlite3 *db, /* Database connection to notify of OOM errors */
  95440. SrcList *pSrc, /* The SrcList to be enlarged */
  95441. int nExtra, /* Number of new slots to add to pSrc->a[] */
  95442. int iStart /* Index in pSrc->a[] of first new slot */
  95443. ){
  95444. int i;
  95445. /* Sanity checking on calling parameters */
  95446. assert( iStart>=0 );
  95447. assert( nExtra>=1 );
  95448. assert( pSrc!=0 );
  95449. assert( iStart<=pSrc->nSrc );
  95450. /* Allocate additional space if needed */
  95451. if( (u32)pSrc->nSrc+nExtra>pSrc->nAlloc ){
  95452. SrcList *pNew;
  95453. int nAlloc = pSrc->nSrc+nExtra;
  95454. int nGot;
  95455. pNew = sqlite3DbRealloc(db, pSrc,
  95456. sizeof(*pSrc) + (nAlloc-1)*sizeof(pSrc->a[0]) );
  95457. if( pNew==0 ){
  95458. assert( db->mallocFailed );
  95459. return pSrc;
  95460. }
  95461. pSrc = pNew;
  95462. nGot = (sqlite3DbMallocSize(db, pNew) - sizeof(*pSrc))/sizeof(pSrc->a[0])+1;
  95463. pSrc->nAlloc = nGot;
  95464. }
  95465. /* Move existing slots that come after the newly inserted slots
  95466. ** out of the way */
  95467. for(i=pSrc->nSrc-1; i>=iStart; i--){
  95468. pSrc->a[i+nExtra] = pSrc->a[i];
  95469. }
  95470. pSrc->nSrc += nExtra;
  95471. /* Zero the newly allocated slots */
  95472. memset(&pSrc->a[iStart], 0, sizeof(pSrc->a[0])*nExtra);
  95473. for(i=iStart; i<iStart+nExtra; i++){
  95474. pSrc->a[i].iCursor = -1;
  95475. }
  95476. /* Return a pointer to the enlarged SrcList */
  95477. return pSrc;
  95478. }
  95479. /*
  95480. ** Append a new table name to the given SrcList. Create a new SrcList if
  95481. ** need be. A new entry is created in the SrcList even if pTable is NULL.
  95482. **
  95483. ** A SrcList is returned, or NULL if there is an OOM error. The returned
  95484. ** SrcList might be the same as the SrcList that was input or it might be
  95485. ** a new one. If an OOM error does occurs, then the prior value of pList
  95486. ** that is input to this routine is automatically freed.
  95487. **
  95488. ** If pDatabase is not null, it means that the table has an optional
  95489. ** database name prefix. Like this: "database.table". The pDatabase
  95490. ** points to the table name and the pTable points to the database name.
  95491. ** The SrcList.a[].zName field is filled with the table name which might
  95492. ** come from pTable (if pDatabase is NULL) or from pDatabase.
  95493. ** SrcList.a[].zDatabase is filled with the database name from pTable,
  95494. ** or with NULL if no database is specified.
  95495. **
  95496. ** In other words, if call like this:
  95497. **
  95498. ** sqlite3SrcListAppend(D,A,B,0);
  95499. **
  95500. ** Then B is a table name and the database name is unspecified. If called
  95501. ** like this:
  95502. **
  95503. ** sqlite3SrcListAppend(D,A,B,C);
  95504. **
  95505. ** Then C is the table name and B is the database name. If C is defined
  95506. ** then so is B. In other words, we never have a case where:
  95507. **
  95508. ** sqlite3SrcListAppend(D,A,0,C);
  95509. **
  95510. ** Both pTable and pDatabase are assumed to be quoted. They are dequoted
  95511. ** before being added to the SrcList.
  95512. */
  95513. SQLITE_PRIVATE SrcList *sqlite3SrcListAppend(
  95514. sqlite3 *db, /* Connection to notify of malloc failures */
  95515. SrcList *pList, /* Append to this SrcList. NULL creates a new SrcList */
  95516. Token *pTable, /* Table to append */
  95517. Token *pDatabase /* Database of the table */
  95518. ){
  95519. struct SrcList_item *pItem;
  95520. assert( pDatabase==0 || pTable!=0 ); /* Cannot have C without B */
  95521. assert( db!=0 );
  95522. if( pList==0 ){
  95523. pList = sqlite3DbMallocRawNN(db, sizeof(SrcList) );
  95524. if( pList==0 ) return 0;
  95525. pList->nAlloc = 1;
  95526. pList->nSrc = 0;
  95527. }
  95528. pList = sqlite3SrcListEnlarge(db, pList, 1, pList->nSrc);
  95529. if( db->mallocFailed ){
  95530. sqlite3SrcListDelete(db, pList);
  95531. return 0;
  95532. }
  95533. pItem = &pList->a[pList->nSrc-1];
  95534. if( pDatabase && pDatabase->z==0 ){
  95535. pDatabase = 0;
  95536. }
  95537. if( pDatabase ){
  95538. Token *pTemp = pDatabase;
  95539. pDatabase = pTable;
  95540. pTable = pTemp;
  95541. }
  95542. pItem->zName = sqlite3NameFromToken(db, pTable);
  95543. pItem->zDatabase = sqlite3NameFromToken(db, pDatabase);
  95544. return pList;
  95545. }
  95546. /*
  95547. ** Assign VdbeCursor index numbers to all tables in a SrcList
  95548. */
  95549. SQLITE_PRIVATE void sqlite3SrcListAssignCursors(Parse *pParse, SrcList *pList){
  95550. int i;
  95551. struct SrcList_item *pItem;
  95552. assert(pList || pParse->db->mallocFailed );
  95553. if( pList ){
  95554. for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
  95555. if( pItem->iCursor>=0 ) break;
  95556. pItem->iCursor = pParse->nTab++;
  95557. if( pItem->pSelect ){
  95558. sqlite3SrcListAssignCursors(pParse, pItem->pSelect->pSrc);
  95559. }
  95560. }
  95561. }
  95562. }
  95563. /*
  95564. ** Delete an entire SrcList including all its substructure.
  95565. */
  95566. SQLITE_PRIVATE void sqlite3SrcListDelete(sqlite3 *db, SrcList *pList){
  95567. int i;
  95568. struct SrcList_item *pItem;
  95569. if( pList==0 ) return;
  95570. for(pItem=pList->a, i=0; i<pList->nSrc; i++, pItem++){
  95571. sqlite3DbFree(db, pItem->zDatabase);
  95572. sqlite3DbFree(db, pItem->zName);
  95573. sqlite3DbFree(db, pItem->zAlias);
  95574. if( pItem->fg.isIndexedBy ) sqlite3DbFree(db, pItem->u1.zIndexedBy);
  95575. if( pItem->fg.isTabFunc ) sqlite3ExprListDelete(db, pItem->u1.pFuncArg);
  95576. sqlite3DeleteTable(db, pItem->pTab);
  95577. sqlite3SelectDelete(db, pItem->pSelect);
  95578. sqlite3ExprDelete(db, pItem->pOn);
  95579. sqlite3IdListDelete(db, pItem->pUsing);
  95580. }
  95581. sqlite3DbFree(db, pList);
  95582. }
  95583. /*
  95584. ** This routine is called by the parser to add a new term to the
  95585. ** end of a growing FROM clause. The "p" parameter is the part of
  95586. ** the FROM clause that has already been constructed. "p" is NULL
  95587. ** if this is the first term of the FROM clause. pTable and pDatabase
  95588. ** are the name of the table and database named in the FROM clause term.
  95589. ** pDatabase is NULL if the database name qualifier is missing - the
  95590. ** usual case. If the term has an alias, then pAlias points to the
  95591. ** alias token. If the term is a subquery, then pSubquery is the
  95592. ** SELECT statement that the subquery encodes. The pTable and
  95593. ** pDatabase parameters are NULL for subqueries. The pOn and pUsing
  95594. ** parameters are the content of the ON and USING clauses.
  95595. **
  95596. ** Return a new SrcList which encodes is the FROM with the new
  95597. ** term added.
  95598. */
  95599. SQLITE_PRIVATE SrcList *sqlite3SrcListAppendFromTerm(
  95600. Parse *pParse, /* Parsing context */
  95601. SrcList *p, /* The left part of the FROM clause already seen */
  95602. Token *pTable, /* Name of the table to add to the FROM clause */
  95603. Token *pDatabase, /* Name of the database containing pTable */
  95604. Token *pAlias, /* The right-hand side of the AS subexpression */
  95605. Select *pSubquery, /* A subquery used in place of a table name */
  95606. Expr *pOn, /* The ON clause of a join */
  95607. IdList *pUsing /* The USING clause of a join */
  95608. ){
  95609. struct SrcList_item *pItem;
  95610. sqlite3 *db = pParse->db;
  95611. if( !p && (pOn || pUsing) ){
  95612. sqlite3ErrorMsg(pParse, "a JOIN clause is required before %s",
  95613. (pOn ? "ON" : "USING")
  95614. );
  95615. goto append_from_error;
  95616. }
  95617. p = sqlite3SrcListAppend(db, p, pTable, pDatabase);
  95618. if( p==0 || NEVER(p->nSrc==0) ){
  95619. goto append_from_error;
  95620. }
  95621. pItem = &p->a[p->nSrc-1];
  95622. assert( pAlias!=0 );
  95623. if( pAlias->n ){
  95624. pItem->zAlias = sqlite3NameFromToken(db, pAlias);
  95625. }
  95626. pItem->pSelect = pSubquery;
  95627. pItem->pOn = pOn;
  95628. pItem->pUsing = pUsing;
  95629. return p;
  95630. append_from_error:
  95631. assert( p==0 );
  95632. sqlite3ExprDelete(db, pOn);
  95633. sqlite3IdListDelete(db, pUsing);
  95634. sqlite3SelectDelete(db, pSubquery);
  95635. return 0;
  95636. }
  95637. /*
  95638. ** Add an INDEXED BY or NOT INDEXED clause to the most recently added
  95639. ** element of the source-list passed as the second argument.
  95640. */
  95641. SQLITE_PRIVATE void sqlite3SrcListIndexedBy(Parse *pParse, SrcList *p, Token *pIndexedBy){
  95642. assert( pIndexedBy!=0 );
  95643. if( p && ALWAYS(p->nSrc>0) ){
  95644. struct SrcList_item *pItem = &p->a[p->nSrc-1];
  95645. assert( pItem->fg.notIndexed==0 );
  95646. assert( pItem->fg.isIndexedBy==0 );
  95647. assert( pItem->fg.isTabFunc==0 );
  95648. if( pIndexedBy->n==1 && !pIndexedBy->z ){
  95649. /* A "NOT INDEXED" clause was supplied. See parse.y
  95650. ** construct "indexed_opt" for details. */
  95651. pItem->fg.notIndexed = 1;
  95652. }else{
  95653. pItem->u1.zIndexedBy = sqlite3NameFromToken(pParse->db, pIndexedBy);
  95654. pItem->fg.isIndexedBy = (pItem->u1.zIndexedBy!=0);
  95655. }
  95656. }
  95657. }
  95658. /*
  95659. ** Add the list of function arguments to the SrcList entry for a
  95660. ** table-valued-function.
  95661. */
  95662. SQLITE_PRIVATE void sqlite3SrcListFuncArgs(Parse *pParse, SrcList *p, ExprList *pList){
  95663. if( p ){
  95664. struct SrcList_item *pItem = &p->a[p->nSrc-1];
  95665. assert( pItem->fg.notIndexed==0 );
  95666. assert( pItem->fg.isIndexedBy==0 );
  95667. assert( pItem->fg.isTabFunc==0 );
  95668. pItem->u1.pFuncArg = pList;
  95669. pItem->fg.isTabFunc = 1;
  95670. }else{
  95671. sqlite3ExprListDelete(pParse->db, pList);
  95672. }
  95673. }
  95674. /*
  95675. ** When building up a FROM clause in the parser, the join operator
  95676. ** is initially attached to the left operand. But the code generator
  95677. ** expects the join operator to be on the right operand. This routine
  95678. ** Shifts all join operators from left to right for an entire FROM
  95679. ** clause.
  95680. **
  95681. ** Example: Suppose the join is like this:
  95682. **
  95683. ** A natural cross join B
  95684. **
  95685. ** The operator is "natural cross join". The A and B operands are stored
  95686. ** in p->a[0] and p->a[1], respectively. The parser initially stores the
  95687. ** operator with A. This routine shifts that operator over to B.
  95688. */
  95689. SQLITE_PRIVATE void sqlite3SrcListShiftJoinType(SrcList *p){
  95690. if( p ){
  95691. int i;
  95692. for(i=p->nSrc-1; i>0; i--){
  95693. p->a[i].fg.jointype = p->a[i-1].fg.jointype;
  95694. }
  95695. p->a[0].fg.jointype = 0;
  95696. }
  95697. }
  95698. /*
  95699. ** Generate VDBE code for a BEGIN statement.
  95700. */
  95701. SQLITE_PRIVATE void sqlite3BeginTransaction(Parse *pParse, int type){
  95702. sqlite3 *db;
  95703. Vdbe *v;
  95704. int i;
  95705. assert( pParse!=0 );
  95706. db = pParse->db;
  95707. assert( db!=0 );
  95708. if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "BEGIN", 0, 0) ){
  95709. return;
  95710. }
  95711. v = sqlite3GetVdbe(pParse);
  95712. if( !v ) return;
  95713. if( type!=TK_DEFERRED ){
  95714. for(i=0; i<db->nDb; i++){
  95715. sqlite3VdbeAddOp2(v, OP_Transaction, i, (type==TK_EXCLUSIVE)+1);
  95716. sqlite3VdbeUsesBtree(v, i);
  95717. }
  95718. }
  95719. sqlite3VdbeAddOp0(v, OP_AutoCommit);
  95720. }
  95721. /*
  95722. ** Generate VDBE code for a COMMIT statement.
  95723. */
  95724. SQLITE_PRIVATE void sqlite3CommitTransaction(Parse *pParse){
  95725. Vdbe *v;
  95726. assert( pParse!=0 );
  95727. assert( pParse->db!=0 );
  95728. if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "COMMIT", 0, 0) ){
  95729. return;
  95730. }
  95731. v = sqlite3GetVdbe(pParse);
  95732. if( v ){
  95733. sqlite3VdbeAddOp1(v, OP_AutoCommit, 1);
  95734. }
  95735. }
  95736. /*
  95737. ** Generate VDBE code for a ROLLBACK statement.
  95738. */
  95739. SQLITE_PRIVATE void sqlite3RollbackTransaction(Parse *pParse){
  95740. Vdbe *v;
  95741. assert( pParse!=0 );
  95742. assert( pParse->db!=0 );
  95743. if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "ROLLBACK", 0, 0) ){
  95744. return;
  95745. }
  95746. v = sqlite3GetVdbe(pParse);
  95747. if( v ){
  95748. sqlite3VdbeAddOp2(v, OP_AutoCommit, 1, 1);
  95749. }
  95750. }
  95751. /*
  95752. ** This function is called by the parser when it parses a command to create,
  95753. ** release or rollback an SQL savepoint.
  95754. */
  95755. SQLITE_PRIVATE void sqlite3Savepoint(Parse *pParse, int op, Token *pName){
  95756. char *zName = sqlite3NameFromToken(pParse->db, pName);
  95757. if( zName ){
  95758. Vdbe *v = sqlite3GetVdbe(pParse);
  95759. #ifndef SQLITE_OMIT_AUTHORIZATION
  95760. static const char * const az[] = { "BEGIN", "RELEASE", "ROLLBACK" };
  95761. assert( !SAVEPOINT_BEGIN && SAVEPOINT_RELEASE==1 && SAVEPOINT_ROLLBACK==2 );
  95762. #endif
  95763. if( !v || sqlite3AuthCheck(pParse, SQLITE_SAVEPOINT, az[op], zName, 0) ){
  95764. sqlite3DbFree(pParse->db, zName);
  95765. return;
  95766. }
  95767. sqlite3VdbeAddOp4(v, OP_Savepoint, op, 0, 0, zName, P4_DYNAMIC);
  95768. }
  95769. }
  95770. /*
  95771. ** Make sure the TEMP database is open and available for use. Return
  95772. ** the number of errors. Leave any error messages in the pParse structure.
  95773. */
  95774. SQLITE_PRIVATE int sqlite3OpenTempDatabase(Parse *pParse){
  95775. sqlite3 *db = pParse->db;
  95776. if( db->aDb[1].pBt==0 && !pParse->explain ){
  95777. int rc;
  95778. Btree *pBt;
  95779. static const int flags =
  95780. SQLITE_OPEN_READWRITE |
  95781. SQLITE_OPEN_CREATE |
  95782. SQLITE_OPEN_EXCLUSIVE |
  95783. SQLITE_OPEN_DELETEONCLOSE |
  95784. SQLITE_OPEN_TEMP_DB;
  95785. rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pBt, 0, flags);
  95786. if( rc!=SQLITE_OK ){
  95787. sqlite3ErrorMsg(pParse, "unable to open a temporary database "
  95788. "file for storing temporary tables");
  95789. pParse->rc = rc;
  95790. return 1;
  95791. }
  95792. db->aDb[1].pBt = pBt;
  95793. assert( db->aDb[1].pSchema );
  95794. if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize, -1, 0) ){
  95795. sqlite3OomFault(db);
  95796. return 1;
  95797. }
  95798. }
  95799. return 0;
  95800. }
  95801. /*
  95802. ** Record the fact that the schema cookie will need to be verified
  95803. ** for database iDb. The code to actually verify the schema cookie
  95804. ** will occur at the end of the top-level VDBE and will be generated
  95805. ** later, by sqlite3FinishCoding().
  95806. */
  95807. SQLITE_PRIVATE void sqlite3CodeVerifySchema(Parse *pParse, int iDb){
  95808. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  95809. assert( iDb>=0 && iDb<pParse->db->nDb );
  95810. assert( pParse->db->aDb[iDb].pBt!=0 || iDb==1 );
  95811. assert( iDb<SQLITE_MAX_ATTACHED+2 );
  95812. assert( sqlite3SchemaMutexHeld(pParse->db, iDb, 0) );
  95813. if( DbMaskTest(pToplevel->cookieMask, iDb)==0 ){
  95814. DbMaskSet(pToplevel->cookieMask, iDb);
  95815. if( !OMIT_TEMPDB && iDb==1 ){
  95816. sqlite3OpenTempDatabase(pToplevel);
  95817. }
  95818. }
  95819. }
  95820. /*
  95821. ** If argument zDb is NULL, then call sqlite3CodeVerifySchema() for each
  95822. ** attached database. Otherwise, invoke it for the database named zDb only.
  95823. */
  95824. SQLITE_PRIVATE void sqlite3CodeVerifyNamedSchema(Parse *pParse, const char *zDb){
  95825. sqlite3 *db = pParse->db;
  95826. int i;
  95827. for(i=0; i<db->nDb; i++){
  95828. Db *pDb = &db->aDb[i];
  95829. if( pDb->pBt && (!zDb || 0==sqlite3StrICmp(zDb, pDb->zDbSName)) ){
  95830. sqlite3CodeVerifySchema(pParse, i);
  95831. }
  95832. }
  95833. }
  95834. /*
  95835. ** Generate VDBE code that prepares for doing an operation that
  95836. ** might change the database.
  95837. **
  95838. ** This routine starts a new transaction if we are not already within
  95839. ** a transaction. If we are already within a transaction, then a checkpoint
  95840. ** is set if the setStatement parameter is true. A checkpoint should
  95841. ** be set for operations that might fail (due to a constraint) part of
  95842. ** the way through and which will need to undo some writes without having to
  95843. ** rollback the whole transaction. For operations where all constraints
  95844. ** can be checked before any changes are made to the database, it is never
  95845. ** necessary to undo a write and the checkpoint should not be set.
  95846. */
  95847. SQLITE_PRIVATE void sqlite3BeginWriteOperation(Parse *pParse, int setStatement, int iDb){
  95848. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  95849. sqlite3CodeVerifySchema(pParse, iDb);
  95850. DbMaskSet(pToplevel->writeMask, iDb);
  95851. pToplevel->isMultiWrite |= setStatement;
  95852. }
  95853. /*
  95854. ** Indicate that the statement currently under construction might write
  95855. ** more than one entry (example: deleting one row then inserting another,
  95856. ** inserting multiple rows in a table, or inserting a row and index entries.)
  95857. ** If an abort occurs after some of these writes have completed, then it will
  95858. ** be necessary to undo the completed writes.
  95859. */
  95860. SQLITE_PRIVATE void sqlite3MultiWrite(Parse *pParse){
  95861. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  95862. pToplevel->isMultiWrite = 1;
  95863. }
  95864. /*
  95865. ** The code generator calls this routine if is discovers that it is
  95866. ** possible to abort a statement prior to completion. In order to
  95867. ** perform this abort without corrupting the database, we need to make
  95868. ** sure that the statement is protected by a statement transaction.
  95869. **
  95870. ** Technically, we only need to set the mayAbort flag if the
  95871. ** isMultiWrite flag was previously set. There is a time dependency
  95872. ** such that the abort must occur after the multiwrite. This makes
  95873. ** some statements involving the REPLACE conflict resolution algorithm
  95874. ** go a little faster. But taking advantage of this time dependency
  95875. ** makes it more difficult to prove that the code is correct (in
  95876. ** particular, it prevents us from writing an effective
  95877. ** implementation of sqlite3AssertMayAbort()) and so we have chosen
  95878. ** to take the safe route and skip the optimization.
  95879. */
  95880. SQLITE_PRIVATE void sqlite3MayAbort(Parse *pParse){
  95881. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  95882. pToplevel->mayAbort = 1;
  95883. }
  95884. /*
  95885. ** Code an OP_Halt that causes the vdbe to return an SQLITE_CONSTRAINT
  95886. ** error. The onError parameter determines which (if any) of the statement
  95887. ** and/or current transaction is rolled back.
  95888. */
  95889. SQLITE_PRIVATE void sqlite3HaltConstraint(
  95890. Parse *pParse, /* Parsing context */
  95891. int errCode, /* extended error code */
  95892. int onError, /* Constraint type */
  95893. char *p4, /* Error message */
  95894. i8 p4type, /* P4_STATIC or P4_TRANSIENT */
  95895. u8 p5Errmsg /* P5_ErrMsg type */
  95896. ){
  95897. Vdbe *v = sqlite3GetVdbe(pParse);
  95898. assert( (errCode&0xff)==SQLITE_CONSTRAINT );
  95899. if( onError==OE_Abort ){
  95900. sqlite3MayAbort(pParse);
  95901. }
  95902. sqlite3VdbeAddOp4(v, OP_Halt, errCode, onError, 0, p4, p4type);
  95903. sqlite3VdbeChangeP5(v, p5Errmsg);
  95904. }
  95905. /*
  95906. ** Code an OP_Halt due to UNIQUE or PRIMARY KEY constraint violation.
  95907. */
  95908. SQLITE_PRIVATE void sqlite3UniqueConstraint(
  95909. Parse *pParse, /* Parsing context */
  95910. int onError, /* Constraint type */
  95911. Index *pIdx /* The index that triggers the constraint */
  95912. ){
  95913. char *zErr;
  95914. int j;
  95915. StrAccum errMsg;
  95916. Table *pTab = pIdx->pTable;
  95917. sqlite3StrAccumInit(&errMsg, pParse->db, 0, 0, 200);
  95918. if( pIdx->aColExpr ){
  95919. sqlite3XPrintf(&errMsg, "index '%q'", pIdx->zName);
  95920. }else{
  95921. for(j=0; j<pIdx->nKeyCol; j++){
  95922. char *zCol;
  95923. assert( pIdx->aiColumn[j]>=0 );
  95924. zCol = pTab->aCol[pIdx->aiColumn[j]].zName;
  95925. if( j ) sqlite3StrAccumAppend(&errMsg, ", ", 2);
  95926. sqlite3XPrintf(&errMsg, "%s.%s", pTab->zName, zCol);
  95927. }
  95928. }
  95929. zErr = sqlite3StrAccumFinish(&errMsg);
  95930. sqlite3HaltConstraint(pParse,
  95931. IsPrimaryKeyIndex(pIdx) ? SQLITE_CONSTRAINT_PRIMARYKEY
  95932. : SQLITE_CONSTRAINT_UNIQUE,
  95933. onError, zErr, P4_DYNAMIC, P5_ConstraintUnique);
  95934. }
  95935. /*
  95936. ** Code an OP_Halt due to non-unique rowid.
  95937. */
  95938. SQLITE_PRIVATE void sqlite3RowidConstraint(
  95939. Parse *pParse, /* Parsing context */
  95940. int onError, /* Conflict resolution algorithm */
  95941. Table *pTab /* The table with the non-unique rowid */
  95942. ){
  95943. char *zMsg;
  95944. int rc;
  95945. if( pTab->iPKey>=0 ){
  95946. zMsg = sqlite3MPrintf(pParse->db, "%s.%s", pTab->zName,
  95947. pTab->aCol[pTab->iPKey].zName);
  95948. rc = SQLITE_CONSTRAINT_PRIMARYKEY;
  95949. }else{
  95950. zMsg = sqlite3MPrintf(pParse->db, "%s.rowid", pTab->zName);
  95951. rc = SQLITE_CONSTRAINT_ROWID;
  95952. }
  95953. sqlite3HaltConstraint(pParse, rc, onError, zMsg, P4_DYNAMIC,
  95954. P5_ConstraintUnique);
  95955. }
  95956. /*
  95957. ** Check to see if pIndex uses the collating sequence pColl. Return
  95958. ** true if it does and false if it does not.
  95959. */
  95960. #ifndef SQLITE_OMIT_REINDEX
  95961. static int collationMatch(const char *zColl, Index *pIndex){
  95962. int i;
  95963. assert( zColl!=0 );
  95964. for(i=0; i<pIndex->nColumn; i++){
  95965. const char *z = pIndex->azColl[i];
  95966. assert( z!=0 || pIndex->aiColumn[i]<0 );
  95967. if( pIndex->aiColumn[i]>=0 && 0==sqlite3StrICmp(z, zColl) ){
  95968. return 1;
  95969. }
  95970. }
  95971. return 0;
  95972. }
  95973. #endif
  95974. /*
  95975. ** Recompute all indices of pTab that use the collating sequence pColl.
  95976. ** If pColl==0 then recompute all indices of pTab.
  95977. */
  95978. #ifndef SQLITE_OMIT_REINDEX
  95979. static void reindexTable(Parse *pParse, Table *pTab, char const *zColl){
  95980. Index *pIndex; /* An index associated with pTab */
  95981. for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
  95982. if( zColl==0 || collationMatch(zColl, pIndex) ){
  95983. int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  95984. sqlite3BeginWriteOperation(pParse, 0, iDb);
  95985. sqlite3RefillIndex(pParse, pIndex, -1);
  95986. }
  95987. }
  95988. }
  95989. #endif
  95990. /*
  95991. ** Recompute all indices of all tables in all databases where the
  95992. ** indices use the collating sequence pColl. If pColl==0 then recompute
  95993. ** all indices everywhere.
  95994. */
  95995. #ifndef SQLITE_OMIT_REINDEX
  95996. static void reindexDatabases(Parse *pParse, char const *zColl){
  95997. Db *pDb; /* A single database */
  95998. int iDb; /* The database index number */
  95999. sqlite3 *db = pParse->db; /* The database connection */
  96000. HashElem *k; /* For looping over tables in pDb */
  96001. Table *pTab; /* A table in the database */
  96002. assert( sqlite3BtreeHoldsAllMutexes(db) ); /* Needed for schema access */
  96003. for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
  96004. assert( pDb!=0 );
  96005. for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
  96006. pTab = (Table*)sqliteHashData(k);
  96007. reindexTable(pParse, pTab, zColl);
  96008. }
  96009. }
  96010. }
  96011. #endif
  96012. /*
  96013. ** Generate code for the REINDEX command.
  96014. **
  96015. ** REINDEX -- 1
  96016. ** REINDEX <collation> -- 2
  96017. ** REINDEX ?<database>.?<tablename> -- 3
  96018. ** REINDEX ?<database>.?<indexname> -- 4
  96019. **
  96020. ** Form 1 causes all indices in all attached databases to be rebuilt.
  96021. ** Form 2 rebuilds all indices in all databases that use the named
  96022. ** collating function. Forms 3 and 4 rebuild the named index or all
  96023. ** indices associated with the named table.
  96024. */
  96025. #ifndef SQLITE_OMIT_REINDEX
  96026. SQLITE_PRIVATE void sqlite3Reindex(Parse *pParse, Token *pName1, Token *pName2){
  96027. CollSeq *pColl; /* Collating sequence to be reindexed, or NULL */
  96028. char *z; /* Name of a table or index */
  96029. const char *zDb; /* Name of the database */
  96030. Table *pTab; /* A table in the database */
  96031. Index *pIndex; /* An index associated with pTab */
  96032. int iDb; /* The database index number */
  96033. sqlite3 *db = pParse->db; /* The database connection */
  96034. Token *pObjName; /* Name of the table or index to be reindexed */
  96035. /* Read the database schema. If an error occurs, leave an error message
  96036. ** and code in pParse and return NULL. */
  96037. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  96038. return;
  96039. }
  96040. if( pName1==0 ){
  96041. reindexDatabases(pParse, 0);
  96042. return;
  96043. }else if( NEVER(pName2==0) || pName2->z==0 ){
  96044. char *zColl;
  96045. assert( pName1->z );
  96046. zColl = sqlite3NameFromToken(pParse->db, pName1);
  96047. if( !zColl ) return;
  96048. pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
  96049. if( pColl ){
  96050. reindexDatabases(pParse, zColl);
  96051. sqlite3DbFree(db, zColl);
  96052. return;
  96053. }
  96054. sqlite3DbFree(db, zColl);
  96055. }
  96056. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pObjName);
  96057. if( iDb<0 ) return;
  96058. z = sqlite3NameFromToken(db, pObjName);
  96059. if( z==0 ) return;
  96060. zDb = db->aDb[iDb].zDbSName;
  96061. pTab = sqlite3FindTable(db, z, zDb);
  96062. if( pTab ){
  96063. reindexTable(pParse, pTab, 0);
  96064. sqlite3DbFree(db, z);
  96065. return;
  96066. }
  96067. pIndex = sqlite3FindIndex(db, z, zDb);
  96068. sqlite3DbFree(db, z);
  96069. if( pIndex ){
  96070. sqlite3BeginWriteOperation(pParse, 0, iDb);
  96071. sqlite3RefillIndex(pParse, pIndex, -1);
  96072. return;
  96073. }
  96074. sqlite3ErrorMsg(pParse, "unable to identify the object to be reindexed");
  96075. }
  96076. #endif
  96077. /*
  96078. ** Return a KeyInfo structure that is appropriate for the given Index.
  96079. **
  96080. ** The caller should invoke sqlite3KeyInfoUnref() on the returned object
  96081. ** when it has finished using it.
  96082. */
  96083. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoOfIndex(Parse *pParse, Index *pIdx){
  96084. int i;
  96085. int nCol = pIdx->nColumn;
  96086. int nKey = pIdx->nKeyCol;
  96087. KeyInfo *pKey;
  96088. if( pParse->nErr ) return 0;
  96089. if( pIdx->uniqNotNull ){
  96090. pKey = sqlite3KeyInfoAlloc(pParse->db, nKey, nCol-nKey);
  96091. }else{
  96092. pKey = sqlite3KeyInfoAlloc(pParse->db, nCol, 0);
  96093. }
  96094. if( pKey ){
  96095. assert( sqlite3KeyInfoIsWriteable(pKey) );
  96096. for(i=0; i<nCol; i++){
  96097. const char *zColl = pIdx->azColl[i];
  96098. pKey->aColl[i] = zColl==sqlite3StrBINARY ? 0 :
  96099. sqlite3LocateCollSeq(pParse, zColl);
  96100. pKey->aSortOrder[i] = pIdx->aSortOrder[i];
  96101. }
  96102. if( pParse->nErr ){
  96103. sqlite3KeyInfoUnref(pKey);
  96104. pKey = 0;
  96105. }
  96106. }
  96107. return pKey;
  96108. }
  96109. #ifndef SQLITE_OMIT_CTE
  96110. /*
  96111. ** This routine is invoked once per CTE by the parser while parsing a
  96112. ** WITH clause.
  96113. */
  96114. SQLITE_PRIVATE With *sqlite3WithAdd(
  96115. Parse *pParse, /* Parsing context */
  96116. With *pWith, /* Existing WITH clause, or NULL */
  96117. Token *pName, /* Name of the common-table */
  96118. ExprList *pArglist, /* Optional column name list for the table */
  96119. Select *pQuery /* Query used to initialize the table */
  96120. ){
  96121. sqlite3 *db = pParse->db;
  96122. With *pNew;
  96123. char *zName;
  96124. /* Check that the CTE name is unique within this WITH clause. If
  96125. ** not, store an error in the Parse structure. */
  96126. zName = sqlite3NameFromToken(pParse->db, pName);
  96127. if( zName && pWith ){
  96128. int i;
  96129. for(i=0; i<pWith->nCte; i++){
  96130. if( sqlite3StrICmp(zName, pWith->a[i].zName)==0 ){
  96131. sqlite3ErrorMsg(pParse, "duplicate WITH table name: %s", zName);
  96132. }
  96133. }
  96134. }
  96135. if( pWith ){
  96136. int nByte = sizeof(*pWith) + (sizeof(pWith->a[1]) * pWith->nCte);
  96137. pNew = sqlite3DbRealloc(db, pWith, nByte);
  96138. }else{
  96139. pNew = sqlite3DbMallocZero(db, sizeof(*pWith));
  96140. }
  96141. assert( (pNew!=0 && zName!=0) || db->mallocFailed );
  96142. if( db->mallocFailed ){
  96143. sqlite3ExprListDelete(db, pArglist);
  96144. sqlite3SelectDelete(db, pQuery);
  96145. sqlite3DbFree(db, zName);
  96146. pNew = pWith;
  96147. }else{
  96148. pNew->a[pNew->nCte].pSelect = pQuery;
  96149. pNew->a[pNew->nCte].pCols = pArglist;
  96150. pNew->a[pNew->nCte].zName = zName;
  96151. pNew->a[pNew->nCte].zCteErr = 0;
  96152. pNew->nCte++;
  96153. }
  96154. return pNew;
  96155. }
  96156. /*
  96157. ** Free the contents of the With object passed as the second argument.
  96158. */
  96159. SQLITE_PRIVATE void sqlite3WithDelete(sqlite3 *db, With *pWith){
  96160. if( pWith ){
  96161. int i;
  96162. for(i=0; i<pWith->nCte; i++){
  96163. struct Cte *pCte = &pWith->a[i];
  96164. sqlite3ExprListDelete(db, pCte->pCols);
  96165. sqlite3SelectDelete(db, pCte->pSelect);
  96166. sqlite3DbFree(db, pCte->zName);
  96167. }
  96168. sqlite3DbFree(db, pWith);
  96169. }
  96170. }
  96171. #endif /* !defined(SQLITE_OMIT_CTE) */
  96172. /************** End of build.c ***********************************************/
  96173. /************** Begin file callback.c ****************************************/
  96174. /*
  96175. ** 2005 May 23
  96176. **
  96177. ** The author disclaims copyright to this source code. In place of
  96178. ** a legal notice, here is a blessing:
  96179. **
  96180. ** May you do good and not evil.
  96181. ** May you find forgiveness for yourself and forgive others.
  96182. ** May you share freely, never taking more than you give.
  96183. **
  96184. *************************************************************************
  96185. **
  96186. ** This file contains functions used to access the internal hash tables
  96187. ** of user defined functions and collation sequences.
  96188. */
  96189. /* #include "sqliteInt.h" */
  96190. /*
  96191. ** Invoke the 'collation needed' callback to request a collation sequence
  96192. ** in the encoding enc of name zName, length nName.
  96193. */
  96194. static void callCollNeeded(sqlite3 *db, int enc, const char *zName){
  96195. assert( !db->xCollNeeded || !db->xCollNeeded16 );
  96196. if( db->xCollNeeded ){
  96197. char *zExternal = sqlite3DbStrDup(db, zName);
  96198. if( !zExternal ) return;
  96199. db->xCollNeeded(db->pCollNeededArg, db, enc, zExternal);
  96200. sqlite3DbFree(db, zExternal);
  96201. }
  96202. #ifndef SQLITE_OMIT_UTF16
  96203. if( db->xCollNeeded16 ){
  96204. char const *zExternal;
  96205. sqlite3_value *pTmp = sqlite3ValueNew(db);
  96206. sqlite3ValueSetStr(pTmp, -1, zName, SQLITE_UTF8, SQLITE_STATIC);
  96207. zExternal = sqlite3ValueText(pTmp, SQLITE_UTF16NATIVE);
  96208. if( zExternal ){
  96209. db->xCollNeeded16(db->pCollNeededArg, db, (int)ENC(db), zExternal);
  96210. }
  96211. sqlite3ValueFree(pTmp);
  96212. }
  96213. #endif
  96214. }
  96215. /*
  96216. ** This routine is called if the collation factory fails to deliver a
  96217. ** collation function in the best encoding but there may be other versions
  96218. ** of this collation function (for other text encodings) available. Use one
  96219. ** of these instead if they exist. Avoid a UTF-8 <-> UTF-16 conversion if
  96220. ** possible.
  96221. */
  96222. static int synthCollSeq(sqlite3 *db, CollSeq *pColl){
  96223. CollSeq *pColl2;
  96224. char *z = pColl->zName;
  96225. int i;
  96226. static const u8 aEnc[] = { SQLITE_UTF16BE, SQLITE_UTF16LE, SQLITE_UTF8 };
  96227. for(i=0; i<3; i++){
  96228. pColl2 = sqlite3FindCollSeq(db, aEnc[i], z, 0);
  96229. if( pColl2->xCmp!=0 ){
  96230. memcpy(pColl, pColl2, sizeof(CollSeq));
  96231. pColl->xDel = 0; /* Do not copy the destructor */
  96232. return SQLITE_OK;
  96233. }
  96234. }
  96235. return SQLITE_ERROR;
  96236. }
  96237. /*
  96238. ** This function is responsible for invoking the collation factory callback
  96239. ** or substituting a collation sequence of a different encoding when the
  96240. ** requested collation sequence is not available in the desired encoding.
  96241. **
  96242. ** If it is not NULL, then pColl must point to the database native encoding
  96243. ** collation sequence with name zName, length nName.
  96244. **
  96245. ** The return value is either the collation sequence to be used in database
  96246. ** db for collation type name zName, length nName, or NULL, if no collation
  96247. ** sequence can be found. If no collation is found, leave an error message.
  96248. **
  96249. ** See also: sqlite3LocateCollSeq(), sqlite3FindCollSeq()
  96250. */
  96251. SQLITE_PRIVATE CollSeq *sqlite3GetCollSeq(
  96252. Parse *pParse, /* Parsing context */
  96253. u8 enc, /* The desired encoding for the collating sequence */
  96254. CollSeq *pColl, /* Collating sequence with native encoding, or NULL */
  96255. const char *zName /* Collating sequence name */
  96256. ){
  96257. CollSeq *p;
  96258. sqlite3 *db = pParse->db;
  96259. p = pColl;
  96260. if( !p ){
  96261. p = sqlite3FindCollSeq(db, enc, zName, 0);
  96262. }
  96263. if( !p || !p->xCmp ){
  96264. /* No collation sequence of this type for this encoding is registered.
  96265. ** Call the collation factory to see if it can supply us with one.
  96266. */
  96267. callCollNeeded(db, enc, zName);
  96268. p = sqlite3FindCollSeq(db, enc, zName, 0);
  96269. }
  96270. if( p && !p->xCmp && synthCollSeq(db, p) ){
  96271. p = 0;
  96272. }
  96273. assert( !p || p->xCmp );
  96274. if( p==0 ){
  96275. sqlite3ErrorMsg(pParse, "no such collation sequence: %s", zName);
  96276. }
  96277. return p;
  96278. }
  96279. /*
  96280. ** This routine is called on a collation sequence before it is used to
  96281. ** check that it is defined. An undefined collation sequence exists when
  96282. ** a database is loaded that contains references to collation sequences
  96283. ** that have not been defined by sqlite3_create_collation() etc.
  96284. **
  96285. ** If required, this routine calls the 'collation needed' callback to
  96286. ** request a definition of the collating sequence. If this doesn't work,
  96287. ** an equivalent collating sequence that uses a text encoding different
  96288. ** from the main database is substituted, if one is available.
  96289. */
  96290. SQLITE_PRIVATE int sqlite3CheckCollSeq(Parse *pParse, CollSeq *pColl){
  96291. if( pColl ){
  96292. const char *zName = pColl->zName;
  96293. sqlite3 *db = pParse->db;
  96294. CollSeq *p = sqlite3GetCollSeq(pParse, ENC(db), pColl, zName);
  96295. if( !p ){
  96296. return SQLITE_ERROR;
  96297. }
  96298. assert( p==pColl );
  96299. }
  96300. return SQLITE_OK;
  96301. }
  96302. /*
  96303. ** Locate and return an entry from the db.aCollSeq hash table. If the entry
  96304. ** specified by zName and nName is not found and parameter 'create' is
  96305. ** true, then create a new entry. Otherwise return NULL.
  96306. **
  96307. ** Each pointer stored in the sqlite3.aCollSeq hash table contains an
  96308. ** array of three CollSeq structures. The first is the collation sequence
  96309. ** preferred for UTF-8, the second UTF-16le, and the third UTF-16be.
  96310. **
  96311. ** Stored immediately after the three collation sequences is a copy of
  96312. ** the collation sequence name. A pointer to this string is stored in
  96313. ** each collation sequence structure.
  96314. */
  96315. static CollSeq *findCollSeqEntry(
  96316. sqlite3 *db, /* Database connection */
  96317. const char *zName, /* Name of the collating sequence */
  96318. int create /* Create a new entry if true */
  96319. ){
  96320. CollSeq *pColl;
  96321. pColl = sqlite3HashFind(&db->aCollSeq, zName);
  96322. if( 0==pColl && create ){
  96323. int nName = sqlite3Strlen30(zName);
  96324. pColl = sqlite3DbMallocZero(db, 3*sizeof(*pColl) + nName + 1);
  96325. if( pColl ){
  96326. CollSeq *pDel = 0;
  96327. pColl[0].zName = (char*)&pColl[3];
  96328. pColl[0].enc = SQLITE_UTF8;
  96329. pColl[1].zName = (char*)&pColl[3];
  96330. pColl[1].enc = SQLITE_UTF16LE;
  96331. pColl[2].zName = (char*)&pColl[3];
  96332. pColl[2].enc = SQLITE_UTF16BE;
  96333. memcpy(pColl[0].zName, zName, nName);
  96334. pColl[0].zName[nName] = 0;
  96335. pDel = sqlite3HashInsert(&db->aCollSeq, pColl[0].zName, pColl);
  96336. /* If a malloc() failure occurred in sqlite3HashInsert(), it will
  96337. ** return the pColl pointer to be deleted (because it wasn't added
  96338. ** to the hash table).
  96339. */
  96340. assert( pDel==0 || pDel==pColl );
  96341. if( pDel!=0 ){
  96342. sqlite3OomFault(db);
  96343. sqlite3DbFree(db, pDel);
  96344. pColl = 0;
  96345. }
  96346. }
  96347. }
  96348. return pColl;
  96349. }
  96350. /*
  96351. ** Parameter zName points to a UTF-8 encoded string nName bytes long.
  96352. ** Return the CollSeq* pointer for the collation sequence named zName
  96353. ** for the encoding 'enc' from the database 'db'.
  96354. **
  96355. ** If the entry specified is not found and 'create' is true, then create a
  96356. ** new entry. Otherwise return NULL.
  96357. **
  96358. ** A separate function sqlite3LocateCollSeq() is a wrapper around
  96359. ** this routine. sqlite3LocateCollSeq() invokes the collation factory
  96360. ** if necessary and generates an error message if the collating sequence
  96361. ** cannot be found.
  96362. **
  96363. ** See also: sqlite3LocateCollSeq(), sqlite3GetCollSeq()
  96364. */
  96365. SQLITE_PRIVATE CollSeq *sqlite3FindCollSeq(
  96366. sqlite3 *db,
  96367. u8 enc,
  96368. const char *zName,
  96369. int create
  96370. ){
  96371. CollSeq *pColl;
  96372. if( zName ){
  96373. pColl = findCollSeqEntry(db, zName, create);
  96374. }else{
  96375. pColl = db->pDfltColl;
  96376. }
  96377. assert( SQLITE_UTF8==1 && SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  96378. assert( enc>=SQLITE_UTF8 && enc<=SQLITE_UTF16BE );
  96379. if( pColl ) pColl += enc-1;
  96380. return pColl;
  96381. }
  96382. /* During the search for the best function definition, this procedure
  96383. ** is called to test how well the function passed as the first argument
  96384. ** matches the request for a function with nArg arguments in a system
  96385. ** that uses encoding enc. The value returned indicates how well the
  96386. ** request is matched. A higher value indicates a better match.
  96387. **
  96388. ** If nArg is -1 that means to only return a match (non-zero) if p->nArg
  96389. ** is also -1. In other words, we are searching for a function that
  96390. ** takes a variable number of arguments.
  96391. **
  96392. ** If nArg is -2 that means that we are searching for any function
  96393. ** regardless of the number of arguments it uses, so return a positive
  96394. ** match score for any
  96395. **
  96396. ** The returned value is always between 0 and 6, as follows:
  96397. **
  96398. ** 0: Not a match.
  96399. ** 1: UTF8/16 conversion required and function takes any number of arguments.
  96400. ** 2: UTF16 byte order change required and function takes any number of args.
  96401. ** 3: encoding matches and function takes any number of arguments
  96402. ** 4: UTF8/16 conversion required - argument count matches exactly
  96403. ** 5: UTF16 byte order conversion required - argument count matches exactly
  96404. ** 6: Perfect match: encoding and argument count match exactly.
  96405. **
  96406. ** If nArg==(-2) then any function with a non-null xSFunc is
  96407. ** a perfect match and any function with xSFunc NULL is
  96408. ** a non-match.
  96409. */
  96410. #define FUNC_PERFECT_MATCH 6 /* The score for a perfect match */
  96411. static int matchQuality(
  96412. FuncDef *p, /* The function we are evaluating for match quality */
  96413. int nArg, /* Desired number of arguments. (-1)==any */
  96414. u8 enc /* Desired text encoding */
  96415. ){
  96416. int match;
  96417. /* nArg of -2 is a special case */
  96418. if( nArg==(-2) ) return (p->xSFunc==0) ? 0 : FUNC_PERFECT_MATCH;
  96419. /* Wrong number of arguments means "no match" */
  96420. if( p->nArg!=nArg && p->nArg>=0 ) return 0;
  96421. /* Give a better score to a function with a specific number of arguments
  96422. ** than to function that accepts any number of arguments. */
  96423. if( p->nArg==nArg ){
  96424. match = 4;
  96425. }else{
  96426. match = 1;
  96427. }
  96428. /* Bonus points if the text encoding matches */
  96429. if( enc==(p->funcFlags & SQLITE_FUNC_ENCMASK) ){
  96430. match += 2; /* Exact encoding match */
  96431. }else if( (enc & p->funcFlags & 2)!=0 ){
  96432. match += 1; /* Both are UTF16, but with different byte orders */
  96433. }
  96434. return match;
  96435. }
  96436. /*
  96437. ** Search a FuncDefHash for a function with the given name. Return
  96438. ** a pointer to the matching FuncDef if found, or 0 if there is no match.
  96439. */
  96440. static FuncDef *functionSearch(
  96441. int h, /* Hash of the name */
  96442. const char *zFunc /* Name of function */
  96443. ){
  96444. FuncDef *p;
  96445. for(p=sqlite3BuiltinFunctions.a[h]; p; p=p->u.pHash){
  96446. if( sqlite3StrICmp(p->zName, zFunc)==0 ){
  96447. return p;
  96448. }
  96449. }
  96450. return 0;
  96451. }
  96452. /*
  96453. ** Insert a new FuncDef into a FuncDefHash hash table.
  96454. */
  96455. SQLITE_PRIVATE void sqlite3InsertBuiltinFuncs(
  96456. FuncDef *aDef, /* List of global functions to be inserted */
  96457. int nDef /* Length of the apDef[] list */
  96458. ){
  96459. int i;
  96460. for(i=0; i<nDef; i++){
  96461. FuncDef *pOther;
  96462. const char *zName = aDef[i].zName;
  96463. int nName = sqlite3Strlen30(zName);
  96464. int h = (sqlite3UpperToLower[(u8)zName[0]] + nName) % SQLITE_FUNC_HASH_SZ;
  96465. pOther = functionSearch(h, zName);
  96466. if( pOther ){
  96467. assert( pOther!=&aDef[i] && pOther->pNext!=&aDef[i] );
  96468. aDef[i].pNext = pOther->pNext;
  96469. pOther->pNext = &aDef[i];
  96470. }else{
  96471. aDef[i].pNext = 0;
  96472. aDef[i].u.pHash = sqlite3BuiltinFunctions.a[h];
  96473. sqlite3BuiltinFunctions.a[h] = &aDef[i];
  96474. }
  96475. }
  96476. }
  96477. /*
  96478. ** Locate a user function given a name, a number of arguments and a flag
  96479. ** indicating whether the function prefers UTF-16 over UTF-8. Return a
  96480. ** pointer to the FuncDef structure that defines that function, or return
  96481. ** NULL if the function does not exist.
  96482. **
  96483. ** If the createFlag argument is true, then a new (blank) FuncDef
  96484. ** structure is created and liked into the "db" structure if a
  96485. ** no matching function previously existed.
  96486. **
  96487. ** If nArg is -2, then the first valid function found is returned. A
  96488. ** function is valid if xSFunc is non-zero. The nArg==(-2)
  96489. ** case is used to see if zName is a valid function name for some number
  96490. ** of arguments. If nArg is -2, then createFlag must be 0.
  96491. **
  96492. ** If createFlag is false, then a function with the required name and
  96493. ** number of arguments may be returned even if the eTextRep flag does not
  96494. ** match that requested.
  96495. */
  96496. SQLITE_PRIVATE FuncDef *sqlite3FindFunction(
  96497. sqlite3 *db, /* An open database */
  96498. const char *zName, /* Name of the function. zero-terminated */
  96499. int nArg, /* Number of arguments. -1 means any number */
  96500. u8 enc, /* Preferred text encoding */
  96501. u8 createFlag /* Create new entry if true and does not otherwise exist */
  96502. ){
  96503. FuncDef *p; /* Iterator variable */
  96504. FuncDef *pBest = 0; /* Best match found so far */
  96505. int bestScore = 0; /* Score of best match */
  96506. int h; /* Hash value */
  96507. int nName; /* Length of the name */
  96508. assert( nArg>=(-2) );
  96509. assert( nArg>=(-1) || createFlag==0 );
  96510. nName = sqlite3Strlen30(zName);
  96511. /* First search for a match amongst the application-defined functions.
  96512. */
  96513. p = (FuncDef*)sqlite3HashFind(&db->aFunc, zName);
  96514. while( p ){
  96515. int score = matchQuality(p, nArg, enc);
  96516. if( score>bestScore ){
  96517. pBest = p;
  96518. bestScore = score;
  96519. }
  96520. p = p->pNext;
  96521. }
  96522. /* If no match is found, search the built-in functions.
  96523. **
  96524. ** If the SQLITE_PreferBuiltin flag is set, then search the built-in
  96525. ** functions even if a prior app-defined function was found. And give
  96526. ** priority to built-in functions.
  96527. **
  96528. ** Except, if createFlag is true, that means that we are trying to
  96529. ** install a new function. Whatever FuncDef structure is returned it will
  96530. ** have fields overwritten with new information appropriate for the
  96531. ** new function. But the FuncDefs for built-in functions are read-only.
  96532. ** So we must not search for built-ins when creating a new function.
  96533. */
  96534. if( !createFlag && (pBest==0 || (db->flags & SQLITE_PreferBuiltin)!=0) ){
  96535. bestScore = 0;
  96536. h = (sqlite3UpperToLower[(u8)zName[0]] + nName) % SQLITE_FUNC_HASH_SZ;
  96537. p = functionSearch(h, zName);
  96538. while( p ){
  96539. int score = matchQuality(p, nArg, enc);
  96540. if( score>bestScore ){
  96541. pBest = p;
  96542. bestScore = score;
  96543. }
  96544. p = p->pNext;
  96545. }
  96546. }
  96547. /* If the createFlag parameter is true and the search did not reveal an
  96548. ** exact match for the name, number of arguments and encoding, then add a
  96549. ** new entry to the hash table and return it.
  96550. */
  96551. if( createFlag && bestScore<FUNC_PERFECT_MATCH &&
  96552. (pBest = sqlite3DbMallocZero(db, sizeof(*pBest)+nName+1))!=0 ){
  96553. FuncDef *pOther;
  96554. pBest->zName = (const char*)&pBest[1];
  96555. pBest->nArg = (u16)nArg;
  96556. pBest->funcFlags = enc;
  96557. memcpy((char*)&pBest[1], zName, nName+1);
  96558. pOther = (FuncDef*)sqlite3HashInsert(&db->aFunc, pBest->zName, pBest);
  96559. if( pOther==pBest ){
  96560. sqlite3DbFree(db, pBest);
  96561. sqlite3OomFault(db);
  96562. return 0;
  96563. }else{
  96564. pBest->pNext = pOther;
  96565. }
  96566. }
  96567. if( pBest && (pBest->xSFunc || createFlag) ){
  96568. return pBest;
  96569. }
  96570. return 0;
  96571. }
  96572. /*
  96573. ** Free all resources held by the schema structure. The void* argument points
  96574. ** at a Schema struct. This function does not call sqlite3DbFree(db, ) on the
  96575. ** pointer itself, it just cleans up subsidiary resources (i.e. the contents
  96576. ** of the schema hash tables).
  96577. **
  96578. ** The Schema.cache_size variable is not cleared.
  96579. */
  96580. SQLITE_PRIVATE void sqlite3SchemaClear(void *p){
  96581. Hash temp1;
  96582. Hash temp2;
  96583. HashElem *pElem;
  96584. Schema *pSchema = (Schema *)p;
  96585. temp1 = pSchema->tblHash;
  96586. temp2 = pSchema->trigHash;
  96587. sqlite3HashInit(&pSchema->trigHash);
  96588. sqlite3HashClear(&pSchema->idxHash);
  96589. for(pElem=sqliteHashFirst(&temp2); pElem; pElem=sqliteHashNext(pElem)){
  96590. sqlite3DeleteTrigger(0, (Trigger*)sqliteHashData(pElem));
  96591. }
  96592. sqlite3HashClear(&temp2);
  96593. sqlite3HashInit(&pSchema->tblHash);
  96594. for(pElem=sqliteHashFirst(&temp1); pElem; pElem=sqliteHashNext(pElem)){
  96595. Table *pTab = sqliteHashData(pElem);
  96596. sqlite3DeleteTable(0, pTab);
  96597. }
  96598. sqlite3HashClear(&temp1);
  96599. sqlite3HashClear(&pSchema->fkeyHash);
  96600. pSchema->pSeqTab = 0;
  96601. if( pSchema->schemaFlags & DB_SchemaLoaded ){
  96602. pSchema->iGeneration++;
  96603. pSchema->schemaFlags &= ~DB_SchemaLoaded;
  96604. }
  96605. }
  96606. /*
  96607. ** Find and return the schema associated with a BTree. Create
  96608. ** a new one if necessary.
  96609. */
  96610. SQLITE_PRIVATE Schema *sqlite3SchemaGet(sqlite3 *db, Btree *pBt){
  96611. Schema * p;
  96612. if( pBt ){
  96613. p = (Schema *)sqlite3BtreeSchema(pBt, sizeof(Schema), sqlite3SchemaClear);
  96614. }else{
  96615. p = (Schema *)sqlite3DbMallocZero(0, sizeof(Schema));
  96616. }
  96617. if( !p ){
  96618. sqlite3OomFault(db);
  96619. }else if ( 0==p->file_format ){
  96620. sqlite3HashInit(&p->tblHash);
  96621. sqlite3HashInit(&p->idxHash);
  96622. sqlite3HashInit(&p->trigHash);
  96623. sqlite3HashInit(&p->fkeyHash);
  96624. p->enc = SQLITE_UTF8;
  96625. }
  96626. return p;
  96627. }
  96628. /************** End of callback.c ********************************************/
  96629. /************** Begin file delete.c ******************************************/
  96630. /*
  96631. ** 2001 September 15
  96632. **
  96633. ** The author disclaims copyright to this source code. In place of
  96634. ** a legal notice, here is a blessing:
  96635. **
  96636. ** May you do good and not evil.
  96637. ** May you find forgiveness for yourself and forgive others.
  96638. ** May you share freely, never taking more than you give.
  96639. **
  96640. *************************************************************************
  96641. ** This file contains C code routines that are called by the parser
  96642. ** in order to generate code for DELETE FROM statements.
  96643. */
  96644. /* #include "sqliteInt.h" */
  96645. /*
  96646. ** While a SrcList can in general represent multiple tables and subqueries
  96647. ** (as in the FROM clause of a SELECT statement) in this case it contains
  96648. ** the name of a single table, as one might find in an INSERT, DELETE,
  96649. ** or UPDATE statement. Look up that table in the symbol table and
  96650. ** return a pointer. Set an error message and return NULL if the table
  96651. ** name is not found or if any other error occurs.
  96652. **
  96653. ** The following fields are initialized appropriate in pSrc:
  96654. **
  96655. ** pSrc->a[0].pTab Pointer to the Table object
  96656. ** pSrc->a[0].pIndex Pointer to the INDEXED BY index, if there is one
  96657. **
  96658. */
  96659. SQLITE_PRIVATE Table *sqlite3SrcListLookup(Parse *pParse, SrcList *pSrc){
  96660. struct SrcList_item *pItem = pSrc->a;
  96661. Table *pTab;
  96662. assert( pItem && pSrc->nSrc==1 );
  96663. pTab = sqlite3LocateTableItem(pParse, 0, pItem);
  96664. sqlite3DeleteTable(pParse->db, pItem->pTab);
  96665. pItem->pTab = pTab;
  96666. if( pTab ){
  96667. pTab->nRef++;
  96668. }
  96669. if( sqlite3IndexedByLookup(pParse, pItem) ){
  96670. pTab = 0;
  96671. }
  96672. return pTab;
  96673. }
  96674. /*
  96675. ** Check to make sure the given table is writable. If it is not
  96676. ** writable, generate an error message and return 1. If it is
  96677. ** writable return 0;
  96678. */
  96679. SQLITE_PRIVATE int sqlite3IsReadOnly(Parse *pParse, Table *pTab, int viewOk){
  96680. /* A table is not writable under the following circumstances:
  96681. **
  96682. ** 1) It is a virtual table and no implementation of the xUpdate method
  96683. ** has been provided, or
  96684. ** 2) It is a system table (i.e. sqlite_master), this call is not
  96685. ** part of a nested parse and writable_schema pragma has not
  96686. ** been specified.
  96687. **
  96688. ** In either case leave an error message in pParse and return non-zero.
  96689. */
  96690. if( ( IsVirtual(pTab)
  96691. && sqlite3GetVTable(pParse->db, pTab)->pMod->pModule->xUpdate==0 )
  96692. || ( (pTab->tabFlags & TF_Readonly)!=0
  96693. && (pParse->db->flags & SQLITE_WriteSchema)==0
  96694. && pParse->nested==0 )
  96695. ){
  96696. sqlite3ErrorMsg(pParse, "table %s may not be modified", pTab->zName);
  96697. return 1;
  96698. }
  96699. #ifndef SQLITE_OMIT_VIEW
  96700. if( !viewOk && pTab->pSelect ){
  96701. sqlite3ErrorMsg(pParse,"cannot modify %s because it is a view",pTab->zName);
  96702. return 1;
  96703. }
  96704. #endif
  96705. return 0;
  96706. }
  96707. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  96708. /*
  96709. ** Evaluate a view and store its result in an ephemeral table. The
  96710. ** pWhere argument is an optional WHERE clause that restricts the
  96711. ** set of rows in the view that are to be added to the ephemeral table.
  96712. */
  96713. SQLITE_PRIVATE void sqlite3MaterializeView(
  96714. Parse *pParse, /* Parsing context */
  96715. Table *pView, /* View definition */
  96716. Expr *pWhere, /* Optional WHERE clause to be added */
  96717. int iCur /* Cursor number for ephemeral table */
  96718. ){
  96719. SelectDest dest;
  96720. Select *pSel;
  96721. SrcList *pFrom;
  96722. sqlite3 *db = pParse->db;
  96723. int iDb = sqlite3SchemaToIndex(db, pView->pSchema);
  96724. pWhere = sqlite3ExprDup(db, pWhere, 0);
  96725. pFrom = sqlite3SrcListAppend(db, 0, 0, 0);
  96726. if( pFrom ){
  96727. assert( pFrom->nSrc==1 );
  96728. pFrom->a[0].zName = sqlite3DbStrDup(db, pView->zName);
  96729. pFrom->a[0].zDatabase = sqlite3DbStrDup(db, db->aDb[iDb].zDbSName);
  96730. assert( pFrom->a[0].pOn==0 );
  96731. assert( pFrom->a[0].pUsing==0 );
  96732. }
  96733. pSel = sqlite3SelectNew(pParse, 0, pFrom, pWhere, 0, 0, 0,
  96734. SF_IncludeHidden, 0, 0);
  96735. sqlite3SelectDestInit(&dest, SRT_EphemTab, iCur);
  96736. sqlite3Select(pParse, pSel, &dest);
  96737. sqlite3SelectDelete(db, pSel);
  96738. }
  96739. #endif /* !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) */
  96740. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  96741. /*
  96742. ** Generate an expression tree to implement the WHERE, ORDER BY,
  96743. ** and LIMIT/OFFSET portion of DELETE and UPDATE statements.
  96744. **
  96745. ** DELETE FROM table_wxyz WHERE a<5 ORDER BY a LIMIT 1;
  96746. ** \__________________________/
  96747. ** pLimitWhere (pInClause)
  96748. */
  96749. SQLITE_PRIVATE Expr *sqlite3LimitWhere(
  96750. Parse *pParse, /* The parser context */
  96751. SrcList *pSrc, /* the FROM clause -- which tables to scan */
  96752. Expr *pWhere, /* The WHERE clause. May be null */
  96753. ExprList *pOrderBy, /* The ORDER BY clause. May be null */
  96754. Expr *pLimit, /* The LIMIT clause. May be null */
  96755. Expr *pOffset, /* The OFFSET clause. May be null */
  96756. char *zStmtType /* Either DELETE or UPDATE. For err msgs. */
  96757. ){
  96758. Expr *pWhereRowid = NULL; /* WHERE rowid .. */
  96759. Expr *pInClause = NULL; /* WHERE rowid IN ( select ) */
  96760. Expr *pSelectRowid = NULL; /* SELECT rowid ... */
  96761. ExprList *pEList = NULL; /* Expression list contaning only pSelectRowid */
  96762. SrcList *pSelectSrc = NULL; /* SELECT rowid FROM x ... (dup of pSrc) */
  96763. Select *pSelect = NULL; /* Complete SELECT tree */
  96764. /* Check that there isn't an ORDER BY without a LIMIT clause.
  96765. */
  96766. if( pOrderBy && (pLimit == 0) ) {
  96767. sqlite3ErrorMsg(pParse, "ORDER BY without LIMIT on %s", zStmtType);
  96768. goto limit_where_cleanup;
  96769. }
  96770. /* We only need to generate a select expression if there
  96771. ** is a limit/offset term to enforce.
  96772. */
  96773. if( pLimit == 0 ) {
  96774. /* if pLimit is null, pOffset will always be null as well. */
  96775. assert( pOffset == 0 );
  96776. return pWhere;
  96777. }
  96778. /* Generate a select expression tree to enforce the limit/offset
  96779. ** term for the DELETE or UPDATE statement. For example:
  96780. ** DELETE FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
  96781. ** becomes:
  96782. ** DELETE FROM table_a WHERE rowid IN (
  96783. ** SELECT rowid FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
  96784. ** );
  96785. */
  96786. pSelectRowid = sqlite3PExpr(pParse, TK_ROW, 0, 0, 0);
  96787. if( pSelectRowid == 0 ) goto limit_where_cleanup;
  96788. pEList = sqlite3ExprListAppend(pParse, 0, pSelectRowid);
  96789. if( pEList == 0 ) goto limit_where_cleanup;
  96790. /* duplicate the FROM clause as it is needed by both the DELETE/UPDATE tree
  96791. ** and the SELECT subtree. */
  96792. pSelectSrc = sqlite3SrcListDup(pParse->db, pSrc, 0);
  96793. if( pSelectSrc == 0 ) {
  96794. sqlite3ExprListDelete(pParse->db, pEList);
  96795. goto limit_where_cleanup;
  96796. }
  96797. /* generate the SELECT expression tree. */
  96798. pSelect = sqlite3SelectNew(pParse,pEList,pSelectSrc,pWhere,0,0,
  96799. pOrderBy,0,pLimit,pOffset);
  96800. if( pSelect == 0 ) return 0;
  96801. /* now generate the new WHERE rowid IN clause for the DELETE/UDPATE */
  96802. pWhereRowid = sqlite3PExpr(pParse, TK_ROW, 0, 0, 0);
  96803. pInClause = pWhereRowid ? sqlite3PExpr(pParse, TK_IN, pWhereRowid, 0, 0) : 0;
  96804. sqlite3PExprAddSelect(pParse, pInClause, pSelect);
  96805. return pInClause;
  96806. limit_where_cleanup:
  96807. sqlite3ExprDelete(pParse->db, pWhere);
  96808. sqlite3ExprListDelete(pParse->db, pOrderBy);
  96809. sqlite3ExprDelete(pParse->db, pLimit);
  96810. sqlite3ExprDelete(pParse->db, pOffset);
  96811. return 0;
  96812. }
  96813. #endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) */
  96814. /* && !defined(SQLITE_OMIT_SUBQUERY) */
  96815. /*
  96816. ** Generate code for a DELETE FROM statement.
  96817. **
  96818. ** DELETE FROM table_wxyz WHERE a<5 AND b NOT NULL;
  96819. ** \________/ \________________/
  96820. ** pTabList pWhere
  96821. */
  96822. SQLITE_PRIVATE void sqlite3DeleteFrom(
  96823. Parse *pParse, /* The parser context */
  96824. SrcList *pTabList, /* The table from which we should delete things */
  96825. Expr *pWhere /* The WHERE clause. May be null */
  96826. ){
  96827. Vdbe *v; /* The virtual database engine */
  96828. Table *pTab; /* The table from which records will be deleted */
  96829. int i; /* Loop counter */
  96830. WhereInfo *pWInfo; /* Information about the WHERE clause */
  96831. Index *pIdx; /* For looping over indices of the table */
  96832. int iTabCur; /* Cursor number for the table */
  96833. int iDataCur = 0; /* VDBE cursor for the canonical data source */
  96834. int iIdxCur = 0; /* Cursor number of the first index */
  96835. int nIdx; /* Number of indices */
  96836. sqlite3 *db; /* Main database structure */
  96837. AuthContext sContext; /* Authorization context */
  96838. NameContext sNC; /* Name context to resolve expressions in */
  96839. int iDb; /* Database number */
  96840. int memCnt = -1; /* Memory cell used for change counting */
  96841. int rcauth; /* Value returned by authorization callback */
  96842. int eOnePass; /* ONEPASS_OFF or _SINGLE or _MULTI */
  96843. int aiCurOnePass[2]; /* The write cursors opened by WHERE_ONEPASS */
  96844. u8 *aToOpen = 0; /* Open cursor iTabCur+j if aToOpen[j] is true */
  96845. Index *pPk; /* The PRIMARY KEY index on the table */
  96846. int iPk = 0; /* First of nPk registers holding PRIMARY KEY value */
  96847. i16 nPk = 1; /* Number of columns in the PRIMARY KEY */
  96848. int iKey; /* Memory cell holding key of row to be deleted */
  96849. i16 nKey; /* Number of memory cells in the row key */
  96850. int iEphCur = 0; /* Ephemeral table holding all primary key values */
  96851. int iRowSet = 0; /* Register for rowset of rows to delete */
  96852. int addrBypass = 0; /* Address of jump over the delete logic */
  96853. int addrLoop = 0; /* Top of the delete loop */
  96854. int addrEphOpen = 0; /* Instruction to open the Ephemeral table */
  96855. int bComplex; /* True if there are triggers or FKs or
  96856. ** subqueries in the WHERE clause */
  96857. #ifndef SQLITE_OMIT_TRIGGER
  96858. int isView; /* True if attempting to delete from a view */
  96859. Trigger *pTrigger; /* List of table triggers, if required */
  96860. #endif
  96861. memset(&sContext, 0, sizeof(sContext));
  96862. db = pParse->db;
  96863. if( pParse->nErr || db->mallocFailed ){
  96864. goto delete_from_cleanup;
  96865. }
  96866. assert( pTabList->nSrc==1 );
  96867. /* Locate the table which we want to delete. This table has to be
  96868. ** put in an SrcList structure because some of the subroutines we
  96869. ** will be calling are designed to work with multiple tables and expect
  96870. ** an SrcList* parameter instead of just a Table* parameter.
  96871. */
  96872. pTab = sqlite3SrcListLookup(pParse, pTabList);
  96873. if( pTab==0 ) goto delete_from_cleanup;
  96874. /* Figure out if we have any triggers and if the table being
  96875. ** deleted from is a view
  96876. */
  96877. #ifndef SQLITE_OMIT_TRIGGER
  96878. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  96879. isView = pTab->pSelect!=0;
  96880. bComplex = pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0);
  96881. #else
  96882. # define pTrigger 0
  96883. # define isView 0
  96884. #endif
  96885. #ifdef SQLITE_OMIT_VIEW
  96886. # undef isView
  96887. # define isView 0
  96888. #endif
  96889. /* If pTab is really a view, make sure it has been initialized.
  96890. */
  96891. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  96892. goto delete_from_cleanup;
  96893. }
  96894. if( sqlite3IsReadOnly(pParse, pTab, (pTrigger?1:0)) ){
  96895. goto delete_from_cleanup;
  96896. }
  96897. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  96898. assert( iDb<db->nDb );
  96899. rcauth = sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0,
  96900. db->aDb[iDb].zDbSName);
  96901. assert( rcauth==SQLITE_OK || rcauth==SQLITE_DENY || rcauth==SQLITE_IGNORE );
  96902. if( rcauth==SQLITE_DENY ){
  96903. goto delete_from_cleanup;
  96904. }
  96905. assert(!isView || pTrigger);
  96906. /* Assign cursor numbers to the table and all its indices.
  96907. */
  96908. assert( pTabList->nSrc==1 );
  96909. iTabCur = pTabList->a[0].iCursor = pParse->nTab++;
  96910. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
  96911. pParse->nTab++;
  96912. }
  96913. /* Start the view context
  96914. */
  96915. if( isView ){
  96916. sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
  96917. }
  96918. /* Begin generating code.
  96919. */
  96920. v = sqlite3GetVdbe(pParse);
  96921. if( v==0 ){
  96922. goto delete_from_cleanup;
  96923. }
  96924. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  96925. sqlite3BeginWriteOperation(pParse, 1, iDb);
  96926. /* If we are trying to delete from a view, realize that view into
  96927. ** an ephemeral table.
  96928. */
  96929. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  96930. if( isView ){
  96931. sqlite3MaterializeView(pParse, pTab, pWhere, iTabCur);
  96932. iDataCur = iIdxCur = iTabCur;
  96933. }
  96934. #endif
  96935. /* Resolve the column names in the WHERE clause.
  96936. */
  96937. memset(&sNC, 0, sizeof(sNC));
  96938. sNC.pParse = pParse;
  96939. sNC.pSrcList = pTabList;
  96940. if( sqlite3ResolveExprNames(&sNC, pWhere) ){
  96941. goto delete_from_cleanup;
  96942. }
  96943. /* Initialize the counter of the number of rows deleted, if
  96944. ** we are counting rows.
  96945. */
  96946. if( db->flags & SQLITE_CountRows ){
  96947. memCnt = ++pParse->nMem;
  96948. sqlite3VdbeAddOp2(v, OP_Integer, 0, memCnt);
  96949. }
  96950. #ifndef SQLITE_OMIT_TRUNCATE_OPTIMIZATION
  96951. /* Special case: A DELETE without a WHERE clause deletes everything.
  96952. ** It is easier just to erase the whole table. Prior to version 3.6.5,
  96953. ** this optimization caused the row change count (the value returned by
  96954. ** API function sqlite3_count_changes) to be set incorrectly. */
  96955. if( rcauth==SQLITE_OK
  96956. && pWhere==0
  96957. && !bComplex
  96958. && !IsVirtual(pTab)
  96959. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  96960. && db->xPreUpdateCallback==0
  96961. #endif
  96962. ){
  96963. assert( !isView );
  96964. sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
  96965. if( HasRowid(pTab) ){
  96966. sqlite3VdbeAddOp4(v, OP_Clear, pTab->tnum, iDb, memCnt,
  96967. pTab->zName, P4_STATIC);
  96968. }
  96969. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  96970. assert( pIdx->pSchema==pTab->pSchema );
  96971. sqlite3VdbeAddOp2(v, OP_Clear, pIdx->tnum, iDb);
  96972. }
  96973. }else
  96974. #endif /* SQLITE_OMIT_TRUNCATE_OPTIMIZATION */
  96975. {
  96976. u16 wcf = WHERE_ONEPASS_DESIRED|WHERE_DUPLICATES_OK|WHERE_SEEK_TABLE;
  96977. if( sNC.ncFlags & NC_VarSelect ) bComplex = 1;
  96978. wcf |= (bComplex ? 0 : WHERE_ONEPASS_MULTIROW);
  96979. if( HasRowid(pTab) ){
  96980. /* For a rowid table, initialize the RowSet to an empty set */
  96981. pPk = 0;
  96982. nPk = 1;
  96983. iRowSet = ++pParse->nMem;
  96984. sqlite3VdbeAddOp2(v, OP_Null, 0, iRowSet);
  96985. }else{
  96986. /* For a WITHOUT ROWID table, create an ephemeral table used to
  96987. ** hold all primary keys for rows to be deleted. */
  96988. pPk = sqlite3PrimaryKeyIndex(pTab);
  96989. assert( pPk!=0 );
  96990. nPk = pPk->nKeyCol;
  96991. iPk = pParse->nMem+1;
  96992. pParse->nMem += nPk;
  96993. iEphCur = pParse->nTab++;
  96994. addrEphOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEphCur, nPk);
  96995. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  96996. }
  96997. /* Construct a query to find the rowid or primary key for every row
  96998. ** to be deleted, based on the WHERE clause. Set variable eOnePass
  96999. ** to indicate the strategy used to implement this delete:
  97000. **
  97001. ** ONEPASS_OFF: Two-pass approach - use a FIFO for rowids/PK values.
  97002. ** ONEPASS_SINGLE: One-pass approach - at most one row deleted.
  97003. ** ONEPASS_MULTI: One-pass approach - any number of rows may be deleted.
  97004. */
  97005. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0, wcf, iTabCur+1);
  97006. if( pWInfo==0 ) goto delete_from_cleanup;
  97007. eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
  97008. assert( IsVirtual(pTab)==0 || eOnePass!=ONEPASS_MULTI );
  97009. assert( IsVirtual(pTab) || bComplex || eOnePass!=ONEPASS_OFF );
  97010. /* Keep track of the number of rows to be deleted */
  97011. if( db->flags & SQLITE_CountRows ){
  97012. sqlite3VdbeAddOp2(v, OP_AddImm, memCnt, 1);
  97013. }
  97014. /* Extract the rowid or primary key for the current row */
  97015. if( pPk ){
  97016. for(i=0; i<nPk; i++){
  97017. assert( pPk->aiColumn[i]>=0 );
  97018. sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur,
  97019. pPk->aiColumn[i], iPk+i);
  97020. }
  97021. iKey = iPk;
  97022. }else{
  97023. iKey = pParse->nMem + 1;
  97024. iKey = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iTabCur, iKey, 0);
  97025. if( iKey>pParse->nMem ) pParse->nMem = iKey;
  97026. }
  97027. if( eOnePass!=ONEPASS_OFF ){
  97028. /* For ONEPASS, no need to store the rowid/primary-key. There is only
  97029. ** one, so just keep it in its register(s) and fall through to the
  97030. ** delete code. */
  97031. nKey = nPk; /* OP_Found will use an unpacked key */
  97032. aToOpen = sqlite3DbMallocRawNN(db, nIdx+2);
  97033. if( aToOpen==0 ){
  97034. sqlite3WhereEnd(pWInfo);
  97035. goto delete_from_cleanup;
  97036. }
  97037. memset(aToOpen, 1, nIdx+1);
  97038. aToOpen[nIdx+1] = 0;
  97039. if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iTabCur] = 0;
  97040. if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iTabCur] = 0;
  97041. if( addrEphOpen ) sqlite3VdbeChangeToNoop(v, addrEphOpen);
  97042. }else{
  97043. if( pPk ){
  97044. /* Add the PK key for this row to the temporary table */
  97045. iKey = ++pParse->nMem;
  97046. nKey = 0; /* Zero tells OP_Found to use a composite key */
  97047. sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, iKey,
  97048. sqlite3IndexAffinityStr(pParse->db, pPk), nPk);
  97049. sqlite3VdbeAddOp2(v, OP_IdxInsert, iEphCur, iKey);
  97050. }else{
  97051. /* Add the rowid of the row to be deleted to the RowSet */
  97052. nKey = 1; /* OP_Seek always uses a single rowid */
  97053. sqlite3VdbeAddOp2(v, OP_RowSetAdd, iRowSet, iKey);
  97054. }
  97055. }
  97056. /* If this DELETE cannot use the ONEPASS strategy, this is the
  97057. ** end of the WHERE loop */
  97058. if( eOnePass!=ONEPASS_OFF ){
  97059. addrBypass = sqlite3VdbeMakeLabel(v);
  97060. }else{
  97061. sqlite3WhereEnd(pWInfo);
  97062. }
  97063. /* Unless this is a view, open cursors for the table we are
  97064. ** deleting from and all its indices. If this is a view, then the
  97065. ** only effect this statement has is to fire the INSTEAD OF
  97066. ** triggers.
  97067. */
  97068. if( !isView ){
  97069. int iAddrOnce = 0;
  97070. if( eOnePass==ONEPASS_MULTI ){
  97071. iAddrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  97072. }
  97073. testcase( IsVirtual(pTab) );
  97074. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, OPFLAG_FORDELETE,
  97075. iTabCur, aToOpen, &iDataCur, &iIdxCur);
  97076. assert( pPk || IsVirtual(pTab) || iDataCur==iTabCur );
  97077. assert( pPk || IsVirtual(pTab) || iIdxCur==iDataCur+1 );
  97078. if( eOnePass==ONEPASS_MULTI ) sqlite3VdbeJumpHere(v, iAddrOnce);
  97079. }
  97080. /* Set up a loop over the rowids/primary-keys that were found in the
  97081. ** where-clause loop above.
  97082. */
  97083. if( eOnePass!=ONEPASS_OFF ){
  97084. assert( nKey==nPk ); /* OP_Found will use an unpacked key */
  97085. if( !IsVirtual(pTab) && aToOpen[iDataCur-iTabCur] ){
  97086. assert( pPk!=0 || pTab->pSelect!=0 );
  97087. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, addrBypass, iKey, nKey);
  97088. VdbeCoverage(v);
  97089. }
  97090. }else if( pPk ){
  97091. addrLoop = sqlite3VdbeAddOp1(v, OP_Rewind, iEphCur); VdbeCoverage(v);
  97092. sqlite3VdbeAddOp2(v, OP_RowKey, iEphCur, iKey);
  97093. assert( nKey==0 ); /* OP_Found will use a composite key */
  97094. }else{
  97095. addrLoop = sqlite3VdbeAddOp3(v, OP_RowSetRead, iRowSet, 0, iKey);
  97096. VdbeCoverage(v);
  97097. assert( nKey==1 );
  97098. }
  97099. /* Delete the row */
  97100. #ifndef SQLITE_OMIT_VIRTUALTABLE
  97101. if( IsVirtual(pTab) ){
  97102. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  97103. sqlite3VtabMakeWritable(pParse, pTab);
  97104. sqlite3VdbeAddOp4(v, OP_VUpdate, 0, 1, iKey, pVTab, P4_VTAB);
  97105. sqlite3VdbeChangeP5(v, OE_Abort);
  97106. assert( eOnePass==ONEPASS_OFF || eOnePass==ONEPASS_SINGLE );
  97107. sqlite3MayAbort(pParse);
  97108. if( eOnePass==ONEPASS_SINGLE && sqlite3IsToplevel(pParse) ){
  97109. pParse->isMultiWrite = 0;
  97110. }
  97111. }else
  97112. #endif
  97113. {
  97114. int count = (pParse->nested==0); /* True to count changes */
  97115. int iIdxNoSeek = -1;
  97116. if( bComplex==0 && aiCurOnePass[1]!=iDataCur ){
  97117. iIdxNoSeek = aiCurOnePass[1];
  97118. }
  97119. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  97120. iKey, nKey, count, OE_Default, eOnePass, iIdxNoSeek);
  97121. }
  97122. /* End of the loop over all rowids/primary-keys. */
  97123. if( eOnePass!=ONEPASS_OFF ){
  97124. sqlite3VdbeResolveLabel(v, addrBypass);
  97125. sqlite3WhereEnd(pWInfo);
  97126. }else if( pPk ){
  97127. sqlite3VdbeAddOp2(v, OP_Next, iEphCur, addrLoop+1); VdbeCoverage(v);
  97128. sqlite3VdbeJumpHere(v, addrLoop);
  97129. }else{
  97130. sqlite3VdbeGoto(v, addrLoop);
  97131. sqlite3VdbeJumpHere(v, addrLoop);
  97132. }
  97133. /* Close the cursors open on the table and its indexes. */
  97134. if( !isView && !IsVirtual(pTab) ){
  97135. if( !pPk ) sqlite3VdbeAddOp1(v, OP_Close, iDataCur);
  97136. for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
  97137. sqlite3VdbeAddOp1(v, OP_Close, iIdxCur + i);
  97138. }
  97139. }
  97140. } /* End non-truncate path */
  97141. /* Update the sqlite_sequence table by storing the content of the
  97142. ** maximum rowid counter values recorded while inserting into
  97143. ** autoincrement tables.
  97144. */
  97145. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  97146. sqlite3AutoincrementEnd(pParse);
  97147. }
  97148. /* Return the number of rows that were deleted. If this routine is
  97149. ** generating code because of a call to sqlite3NestedParse(), do not
  97150. ** invoke the callback function.
  97151. */
  97152. if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
  97153. sqlite3VdbeAddOp2(v, OP_ResultRow, memCnt, 1);
  97154. sqlite3VdbeSetNumCols(v, 1);
  97155. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows deleted", SQLITE_STATIC);
  97156. }
  97157. delete_from_cleanup:
  97158. sqlite3AuthContextPop(&sContext);
  97159. sqlite3SrcListDelete(db, pTabList);
  97160. sqlite3ExprDelete(db, pWhere);
  97161. sqlite3DbFree(db, aToOpen);
  97162. return;
  97163. }
  97164. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  97165. ** they may interfere with compilation of other functions in this file
  97166. ** (or in another file, if this file becomes part of the amalgamation). */
  97167. #ifdef isView
  97168. #undef isView
  97169. #endif
  97170. #ifdef pTrigger
  97171. #undef pTrigger
  97172. #endif
  97173. /*
  97174. ** This routine generates VDBE code that causes a single row of a
  97175. ** single table to be deleted. Both the original table entry and
  97176. ** all indices are removed.
  97177. **
  97178. ** Preconditions:
  97179. **
  97180. ** 1. iDataCur is an open cursor on the btree that is the canonical data
  97181. ** store for the table. (This will be either the table itself,
  97182. ** in the case of a rowid table, or the PRIMARY KEY index in the case
  97183. ** of a WITHOUT ROWID table.)
  97184. **
  97185. ** 2. Read/write cursors for all indices of pTab must be open as
  97186. ** cursor number iIdxCur+i for the i-th index.
  97187. **
  97188. ** 3. The primary key for the row to be deleted must be stored in a
  97189. ** sequence of nPk memory cells starting at iPk. If nPk==0 that means
  97190. ** that a search record formed from OP_MakeRecord is contained in the
  97191. ** single memory location iPk.
  97192. **
  97193. ** eMode:
  97194. ** Parameter eMode may be passed either ONEPASS_OFF (0), ONEPASS_SINGLE, or
  97195. ** ONEPASS_MULTI. If eMode is not ONEPASS_OFF, then the cursor
  97196. ** iDataCur already points to the row to delete. If eMode is ONEPASS_OFF
  97197. ** then this function must seek iDataCur to the entry identified by iPk
  97198. ** and nPk before reading from it.
  97199. **
  97200. ** If eMode is ONEPASS_MULTI, then this call is being made as part
  97201. ** of a ONEPASS delete that affects multiple rows. In this case, if
  97202. ** iIdxNoSeek is a valid cursor number (>=0), then its position should
  97203. ** be preserved following the delete operation. Or, if iIdxNoSeek is not
  97204. ** a valid cursor number, the position of iDataCur should be preserved
  97205. ** instead.
  97206. **
  97207. ** iIdxNoSeek:
  97208. ** If iIdxNoSeek is a valid cursor number (>=0), then it identifies an
  97209. ** index cursor (from within array of cursors starting at iIdxCur) that
  97210. ** already points to the index entry to be deleted.
  97211. */
  97212. SQLITE_PRIVATE void sqlite3GenerateRowDelete(
  97213. Parse *pParse, /* Parsing context */
  97214. Table *pTab, /* Table containing the row to be deleted */
  97215. Trigger *pTrigger, /* List of triggers to (potentially) fire */
  97216. int iDataCur, /* Cursor from which column data is extracted */
  97217. int iIdxCur, /* First index cursor */
  97218. int iPk, /* First memory cell containing the PRIMARY KEY */
  97219. i16 nPk, /* Number of PRIMARY KEY memory cells */
  97220. u8 count, /* If non-zero, increment the row change counter */
  97221. u8 onconf, /* Default ON CONFLICT policy for triggers */
  97222. u8 eMode, /* ONEPASS_OFF, _SINGLE, or _MULTI. See above */
  97223. int iIdxNoSeek /* Cursor number of cursor that does not need seeking */
  97224. ){
  97225. Vdbe *v = pParse->pVdbe; /* Vdbe */
  97226. int iOld = 0; /* First register in OLD.* array */
  97227. int iLabel; /* Label resolved to end of generated code */
  97228. u8 opSeek; /* Seek opcode */
  97229. /* Vdbe is guaranteed to have been allocated by this stage. */
  97230. assert( v );
  97231. VdbeModuleComment((v, "BEGIN: GenRowDel(%d,%d,%d,%d)",
  97232. iDataCur, iIdxCur, iPk, (int)nPk));
  97233. /* Seek cursor iCur to the row to delete. If this row no longer exists
  97234. ** (this can happen if a trigger program has already deleted it), do
  97235. ** not attempt to delete it or fire any DELETE triggers. */
  97236. iLabel = sqlite3VdbeMakeLabel(v);
  97237. opSeek = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
  97238. if( eMode==ONEPASS_OFF ){
  97239. sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
  97240. VdbeCoverageIf(v, opSeek==OP_NotExists);
  97241. VdbeCoverageIf(v, opSeek==OP_NotFound);
  97242. }
  97243. /* If there are any triggers to fire, allocate a range of registers to
  97244. ** use for the old.* references in the triggers. */
  97245. if( sqlite3FkRequired(pParse, pTab, 0, 0) || pTrigger ){
  97246. u32 mask; /* Mask of OLD.* columns in use */
  97247. int iCol; /* Iterator used while populating OLD.* */
  97248. int addrStart; /* Start of BEFORE trigger programs */
  97249. /* TODO: Could use temporary registers here. Also could attempt to
  97250. ** avoid copying the contents of the rowid register. */
  97251. mask = sqlite3TriggerColmask(
  97252. pParse, pTrigger, 0, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onconf
  97253. );
  97254. mask |= sqlite3FkOldmask(pParse, pTab);
  97255. iOld = pParse->nMem+1;
  97256. pParse->nMem += (1 + pTab->nCol);
  97257. /* Populate the OLD.* pseudo-table register array. These values will be
  97258. ** used by any BEFORE and AFTER triggers that exist. */
  97259. sqlite3VdbeAddOp2(v, OP_Copy, iPk, iOld);
  97260. for(iCol=0; iCol<pTab->nCol; iCol++){
  97261. testcase( mask!=0xffffffff && iCol==31 );
  97262. testcase( mask!=0xffffffff && iCol==32 );
  97263. if( mask==0xffffffff || (iCol<=31 && (mask & MASKBIT32(iCol))!=0) ){
  97264. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, iCol, iOld+iCol+1);
  97265. }
  97266. }
  97267. /* Invoke BEFORE DELETE trigger programs. */
  97268. addrStart = sqlite3VdbeCurrentAddr(v);
  97269. sqlite3CodeRowTrigger(pParse, pTrigger,
  97270. TK_DELETE, 0, TRIGGER_BEFORE, pTab, iOld, onconf, iLabel
  97271. );
  97272. /* If any BEFORE triggers were coded, then seek the cursor to the
  97273. ** row to be deleted again. It may be that the BEFORE triggers moved
  97274. ** the cursor or of already deleted the row that the cursor was
  97275. ** pointing to.
  97276. */
  97277. if( addrStart<sqlite3VdbeCurrentAddr(v) ){
  97278. sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
  97279. VdbeCoverageIf(v, opSeek==OP_NotExists);
  97280. VdbeCoverageIf(v, opSeek==OP_NotFound);
  97281. }
  97282. /* Do FK processing. This call checks that any FK constraints that
  97283. ** refer to this table (i.e. constraints attached to other tables)
  97284. ** are not violated by deleting this row. */
  97285. sqlite3FkCheck(pParse, pTab, iOld, 0, 0, 0);
  97286. }
  97287. /* Delete the index and table entries. Skip this step if pTab is really
  97288. ** a view (in which case the only effect of the DELETE statement is to
  97289. ** fire the INSTEAD OF triggers).
  97290. **
  97291. ** If variable 'count' is non-zero, then this OP_Delete instruction should
  97292. ** invoke the update-hook. The pre-update-hook, on the other hand should
  97293. ** be invoked unless table pTab is a system table. The difference is that
  97294. ** the update-hook is not invoked for rows removed by REPLACE, but the
  97295. ** pre-update-hook is.
  97296. */
  97297. if( pTab->pSelect==0 ){
  97298. u8 p5 = 0;
  97299. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,iIdxNoSeek);
  97300. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, (count?OPFLAG_NCHANGE:0));
  97301. sqlite3VdbeChangeP4(v, -1, (char*)pTab, P4_TABLE);
  97302. if( eMode!=ONEPASS_OFF ){
  97303. sqlite3VdbeChangeP5(v, OPFLAG_AUXDELETE);
  97304. }
  97305. if( iIdxNoSeek>=0 ){
  97306. sqlite3VdbeAddOp1(v, OP_Delete, iIdxNoSeek);
  97307. }
  97308. if( eMode==ONEPASS_MULTI ) p5 |= OPFLAG_SAVEPOSITION;
  97309. sqlite3VdbeChangeP5(v, p5);
  97310. }
  97311. /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
  97312. ** handle rows (possibly in other tables) that refer via a foreign key
  97313. ** to the row just deleted. */
  97314. sqlite3FkActions(pParse, pTab, 0, iOld, 0, 0);
  97315. /* Invoke AFTER DELETE trigger programs. */
  97316. sqlite3CodeRowTrigger(pParse, pTrigger,
  97317. TK_DELETE, 0, TRIGGER_AFTER, pTab, iOld, onconf, iLabel
  97318. );
  97319. /* Jump here if the row had already been deleted before any BEFORE
  97320. ** trigger programs were invoked. Or if a trigger program throws a
  97321. ** RAISE(IGNORE) exception. */
  97322. sqlite3VdbeResolveLabel(v, iLabel);
  97323. VdbeModuleComment((v, "END: GenRowDel()"));
  97324. }
  97325. /*
  97326. ** This routine generates VDBE code that causes the deletion of all
  97327. ** index entries associated with a single row of a single table, pTab
  97328. **
  97329. ** Preconditions:
  97330. **
  97331. ** 1. A read/write cursor "iDataCur" must be open on the canonical storage
  97332. ** btree for the table pTab. (This will be either the table itself
  97333. ** for rowid tables or to the primary key index for WITHOUT ROWID
  97334. ** tables.)
  97335. **
  97336. ** 2. Read/write cursors for all indices of pTab must be open as
  97337. ** cursor number iIdxCur+i for the i-th index. (The pTab->pIndex
  97338. ** index is the 0-th index.)
  97339. **
  97340. ** 3. The "iDataCur" cursor must be already be positioned on the row
  97341. ** that is to be deleted.
  97342. */
  97343. SQLITE_PRIVATE void sqlite3GenerateRowIndexDelete(
  97344. Parse *pParse, /* Parsing and code generating context */
  97345. Table *pTab, /* Table containing the row to be deleted */
  97346. int iDataCur, /* Cursor of table holding data. */
  97347. int iIdxCur, /* First index cursor */
  97348. int *aRegIdx, /* Only delete if aRegIdx!=0 && aRegIdx[i]>0 */
  97349. int iIdxNoSeek /* Do not delete from this cursor */
  97350. ){
  97351. int i; /* Index loop counter */
  97352. int r1 = -1; /* Register holding an index key */
  97353. int iPartIdxLabel; /* Jump destination for skipping partial index entries */
  97354. Index *pIdx; /* Current index */
  97355. Index *pPrior = 0; /* Prior index */
  97356. Vdbe *v; /* The prepared statement under construction */
  97357. Index *pPk; /* PRIMARY KEY index, or NULL for rowid tables */
  97358. v = pParse->pVdbe;
  97359. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  97360. for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
  97361. assert( iIdxCur+i!=iDataCur || pPk==pIdx );
  97362. if( aRegIdx!=0 && aRegIdx[i]==0 ) continue;
  97363. if( pIdx==pPk ) continue;
  97364. if( iIdxCur+i==iIdxNoSeek ) continue;
  97365. VdbeModuleComment((v, "GenRowIdxDel for %s", pIdx->zName));
  97366. r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 1,
  97367. &iPartIdxLabel, pPrior, r1);
  97368. sqlite3VdbeAddOp3(v, OP_IdxDelete, iIdxCur+i, r1,
  97369. pIdx->uniqNotNull ? pIdx->nKeyCol : pIdx->nColumn);
  97370. sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
  97371. pPrior = pIdx;
  97372. }
  97373. }
  97374. /*
  97375. ** Generate code that will assemble an index key and stores it in register
  97376. ** regOut. The key with be for index pIdx which is an index on pTab.
  97377. ** iCur is the index of a cursor open on the pTab table and pointing to
  97378. ** the entry that needs indexing. If pTab is a WITHOUT ROWID table, then
  97379. ** iCur must be the cursor of the PRIMARY KEY index.
  97380. **
  97381. ** Return a register number which is the first in a block of
  97382. ** registers that holds the elements of the index key. The
  97383. ** block of registers has already been deallocated by the time
  97384. ** this routine returns.
  97385. **
  97386. ** If *piPartIdxLabel is not NULL, fill it in with a label and jump
  97387. ** to that label if pIdx is a partial index that should be skipped.
  97388. ** The label should be resolved using sqlite3ResolvePartIdxLabel().
  97389. ** A partial index should be skipped if its WHERE clause evaluates
  97390. ** to false or null. If pIdx is not a partial index, *piPartIdxLabel
  97391. ** will be set to zero which is an empty label that is ignored by
  97392. ** sqlite3ResolvePartIdxLabel().
  97393. **
  97394. ** The pPrior and regPrior parameters are used to implement a cache to
  97395. ** avoid unnecessary register loads. If pPrior is not NULL, then it is
  97396. ** a pointer to a different index for which an index key has just been
  97397. ** computed into register regPrior. If the current pIdx index is generating
  97398. ** its key into the same sequence of registers and if pPrior and pIdx share
  97399. ** a column in common, then the register corresponding to that column already
  97400. ** holds the correct value and the loading of that register is skipped.
  97401. ** This optimization is helpful when doing a DELETE or an INTEGRITY_CHECK
  97402. ** on a table with multiple indices, and especially with the ROWID or
  97403. ** PRIMARY KEY columns of the index.
  97404. */
  97405. SQLITE_PRIVATE int sqlite3GenerateIndexKey(
  97406. Parse *pParse, /* Parsing context */
  97407. Index *pIdx, /* The index for which to generate a key */
  97408. int iDataCur, /* Cursor number from which to take column data */
  97409. int regOut, /* Put the new key into this register if not 0 */
  97410. int prefixOnly, /* Compute only a unique prefix of the key */
  97411. int *piPartIdxLabel, /* OUT: Jump to this label to skip partial index */
  97412. Index *pPrior, /* Previously generated index key */
  97413. int regPrior /* Register holding previous generated key */
  97414. ){
  97415. Vdbe *v = pParse->pVdbe;
  97416. int j;
  97417. int regBase;
  97418. int nCol;
  97419. if( piPartIdxLabel ){
  97420. if( pIdx->pPartIdxWhere ){
  97421. *piPartIdxLabel = sqlite3VdbeMakeLabel(v);
  97422. pParse->iSelfTab = iDataCur;
  97423. sqlite3ExprCachePush(pParse);
  97424. sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, *piPartIdxLabel,
  97425. SQLITE_JUMPIFNULL);
  97426. }else{
  97427. *piPartIdxLabel = 0;
  97428. }
  97429. }
  97430. nCol = (prefixOnly && pIdx->uniqNotNull) ? pIdx->nKeyCol : pIdx->nColumn;
  97431. regBase = sqlite3GetTempRange(pParse, nCol);
  97432. if( pPrior && (regBase!=regPrior || pPrior->pPartIdxWhere) ) pPrior = 0;
  97433. for(j=0; j<nCol; j++){
  97434. if( pPrior
  97435. && pPrior->aiColumn[j]==pIdx->aiColumn[j]
  97436. && pPrior->aiColumn[j]!=XN_EXPR
  97437. ){
  97438. /* This column was already computed by the previous index */
  97439. continue;
  97440. }
  97441. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iDataCur, j, regBase+j);
  97442. /* If the column affinity is REAL but the number is an integer, then it
  97443. ** might be stored in the table as an integer (using a compact
  97444. ** representation) then converted to REAL by an OP_RealAffinity opcode.
  97445. ** But we are getting ready to store this value back into an index, where
  97446. ** it should be converted by to INTEGER again. So omit the OP_RealAffinity
  97447. ** opcode if it is present */
  97448. sqlite3VdbeDeletePriorOpcode(v, OP_RealAffinity);
  97449. }
  97450. if( regOut ){
  97451. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regOut);
  97452. }
  97453. sqlite3ReleaseTempRange(pParse, regBase, nCol);
  97454. return regBase;
  97455. }
  97456. /*
  97457. ** If a prior call to sqlite3GenerateIndexKey() generated a jump-over label
  97458. ** because it was a partial index, then this routine should be called to
  97459. ** resolve that label.
  97460. */
  97461. SQLITE_PRIVATE void sqlite3ResolvePartIdxLabel(Parse *pParse, int iLabel){
  97462. if( iLabel ){
  97463. sqlite3VdbeResolveLabel(pParse->pVdbe, iLabel);
  97464. sqlite3ExprCachePop(pParse);
  97465. }
  97466. }
  97467. /************** End of delete.c **********************************************/
  97468. /************** Begin file func.c ********************************************/
  97469. /*
  97470. ** 2002 February 23
  97471. **
  97472. ** The author disclaims copyright to this source code. In place of
  97473. ** a legal notice, here is a blessing:
  97474. **
  97475. ** May you do good and not evil.
  97476. ** May you find forgiveness for yourself and forgive others.
  97477. ** May you share freely, never taking more than you give.
  97478. **
  97479. *************************************************************************
  97480. ** This file contains the C-language implementations for many of the SQL
  97481. ** functions of SQLite. (Some function, and in particular the date and
  97482. ** time functions, are implemented separately.)
  97483. */
  97484. /* #include "sqliteInt.h" */
  97485. /* #include <stdlib.h> */
  97486. /* #include <assert.h> */
  97487. /* #include "vdbeInt.h" */
  97488. /*
  97489. ** Return the collating function associated with a function.
  97490. */
  97491. static CollSeq *sqlite3GetFuncCollSeq(sqlite3_context *context){
  97492. VdbeOp *pOp;
  97493. assert( context->pVdbe!=0 );
  97494. pOp = &context->pVdbe->aOp[context->iOp-1];
  97495. assert( pOp->opcode==OP_CollSeq );
  97496. assert( pOp->p4type==P4_COLLSEQ );
  97497. return pOp->p4.pColl;
  97498. }
  97499. /*
  97500. ** Indicate that the accumulator load should be skipped on this
  97501. ** iteration of the aggregate loop.
  97502. */
  97503. static void sqlite3SkipAccumulatorLoad(sqlite3_context *context){
  97504. context->skipFlag = 1;
  97505. }
  97506. /*
  97507. ** Implementation of the non-aggregate min() and max() functions
  97508. */
  97509. static void minmaxFunc(
  97510. sqlite3_context *context,
  97511. int argc,
  97512. sqlite3_value **argv
  97513. ){
  97514. int i;
  97515. int mask; /* 0 for min() or 0xffffffff for max() */
  97516. int iBest;
  97517. CollSeq *pColl;
  97518. assert( argc>1 );
  97519. mask = sqlite3_user_data(context)==0 ? 0 : -1;
  97520. pColl = sqlite3GetFuncCollSeq(context);
  97521. assert( pColl );
  97522. assert( mask==-1 || mask==0 );
  97523. iBest = 0;
  97524. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  97525. for(i=1; i<argc; i++){
  97526. if( sqlite3_value_type(argv[i])==SQLITE_NULL ) return;
  97527. if( (sqlite3MemCompare(argv[iBest], argv[i], pColl)^mask)>=0 ){
  97528. testcase( mask==0 );
  97529. iBest = i;
  97530. }
  97531. }
  97532. sqlite3_result_value(context, argv[iBest]);
  97533. }
  97534. /*
  97535. ** Return the type of the argument.
  97536. */
  97537. static void typeofFunc(
  97538. sqlite3_context *context,
  97539. int NotUsed,
  97540. sqlite3_value **argv
  97541. ){
  97542. const char *z = 0;
  97543. UNUSED_PARAMETER(NotUsed);
  97544. switch( sqlite3_value_type(argv[0]) ){
  97545. case SQLITE_INTEGER: z = "integer"; break;
  97546. case SQLITE_TEXT: z = "text"; break;
  97547. case SQLITE_FLOAT: z = "real"; break;
  97548. case SQLITE_BLOB: z = "blob"; break;
  97549. default: z = "null"; break;
  97550. }
  97551. sqlite3_result_text(context, z, -1, SQLITE_STATIC);
  97552. }
  97553. /*
  97554. ** Implementation of the length() function
  97555. */
  97556. static void lengthFunc(
  97557. sqlite3_context *context,
  97558. int argc,
  97559. sqlite3_value **argv
  97560. ){
  97561. int len;
  97562. assert( argc==1 );
  97563. UNUSED_PARAMETER(argc);
  97564. switch( sqlite3_value_type(argv[0]) ){
  97565. case SQLITE_BLOB:
  97566. case SQLITE_INTEGER:
  97567. case SQLITE_FLOAT: {
  97568. sqlite3_result_int(context, sqlite3_value_bytes(argv[0]));
  97569. break;
  97570. }
  97571. case SQLITE_TEXT: {
  97572. const unsigned char *z = sqlite3_value_text(argv[0]);
  97573. if( z==0 ) return;
  97574. len = 0;
  97575. while( *z ){
  97576. len++;
  97577. SQLITE_SKIP_UTF8(z);
  97578. }
  97579. sqlite3_result_int(context, len);
  97580. break;
  97581. }
  97582. default: {
  97583. sqlite3_result_null(context);
  97584. break;
  97585. }
  97586. }
  97587. }
  97588. /*
  97589. ** Implementation of the abs() function.
  97590. **
  97591. ** IMP: R-23979-26855 The abs(X) function returns the absolute value of
  97592. ** the numeric argument X.
  97593. */
  97594. static void absFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  97595. assert( argc==1 );
  97596. UNUSED_PARAMETER(argc);
  97597. switch( sqlite3_value_type(argv[0]) ){
  97598. case SQLITE_INTEGER: {
  97599. i64 iVal = sqlite3_value_int64(argv[0]);
  97600. if( iVal<0 ){
  97601. if( iVal==SMALLEST_INT64 ){
  97602. /* IMP: R-31676-45509 If X is the integer -9223372036854775808
  97603. ** then abs(X) throws an integer overflow error since there is no
  97604. ** equivalent positive 64-bit two complement value. */
  97605. sqlite3_result_error(context, "integer overflow", -1);
  97606. return;
  97607. }
  97608. iVal = -iVal;
  97609. }
  97610. sqlite3_result_int64(context, iVal);
  97611. break;
  97612. }
  97613. case SQLITE_NULL: {
  97614. /* IMP: R-37434-19929 Abs(X) returns NULL if X is NULL. */
  97615. sqlite3_result_null(context);
  97616. break;
  97617. }
  97618. default: {
  97619. /* Because sqlite3_value_double() returns 0.0 if the argument is not
  97620. ** something that can be converted into a number, we have:
  97621. ** IMP: R-01992-00519 Abs(X) returns 0.0 if X is a string or blob
  97622. ** that cannot be converted to a numeric value.
  97623. */
  97624. double rVal = sqlite3_value_double(argv[0]);
  97625. if( rVal<0 ) rVal = -rVal;
  97626. sqlite3_result_double(context, rVal);
  97627. break;
  97628. }
  97629. }
  97630. }
  97631. /*
  97632. ** Implementation of the instr() function.
  97633. **
  97634. ** instr(haystack,needle) finds the first occurrence of needle
  97635. ** in haystack and returns the number of previous characters plus 1,
  97636. ** or 0 if needle does not occur within haystack.
  97637. **
  97638. ** If both haystack and needle are BLOBs, then the result is one more than
  97639. ** the number of bytes in haystack prior to the first occurrence of needle,
  97640. ** or 0 if needle never occurs in haystack.
  97641. */
  97642. static void instrFunc(
  97643. sqlite3_context *context,
  97644. int argc,
  97645. sqlite3_value **argv
  97646. ){
  97647. const unsigned char *zHaystack;
  97648. const unsigned char *zNeedle;
  97649. int nHaystack;
  97650. int nNeedle;
  97651. int typeHaystack, typeNeedle;
  97652. int N = 1;
  97653. int isText;
  97654. UNUSED_PARAMETER(argc);
  97655. typeHaystack = sqlite3_value_type(argv[0]);
  97656. typeNeedle = sqlite3_value_type(argv[1]);
  97657. if( typeHaystack==SQLITE_NULL || typeNeedle==SQLITE_NULL ) return;
  97658. nHaystack = sqlite3_value_bytes(argv[0]);
  97659. nNeedle = sqlite3_value_bytes(argv[1]);
  97660. if( typeHaystack==SQLITE_BLOB && typeNeedle==SQLITE_BLOB ){
  97661. zHaystack = sqlite3_value_blob(argv[0]);
  97662. zNeedle = sqlite3_value_blob(argv[1]);
  97663. isText = 0;
  97664. }else{
  97665. zHaystack = sqlite3_value_text(argv[0]);
  97666. zNeedle = sqlite3_value_text(argv[1]);
  97667. isText = 1;
  97668. }
  97669. while( nNeedle<=nHaystack && memcmp(zHaystack, zNeedle, nNeedle)!=0 ){
  97670. N++;
  97671. do{
  97672. nHaystack--;
  97673. zHaystack++;
  97674. }while( isText && (zHaystack[0]&0xc0)==0x80 );
  97675. }
  97676. if( nNeedle>nHaystack ) N = 0;
  97677. sqlite3_result_int(context, N);
  97678. }
  97679. /*
  97680. ** Implementation of the printf() function.
  97681. */
  97682. static void printfFunc(
  97683. sqlite3_context *context,
  97684. int argc,
  97685. sqlite3_value **argv
  97686. ){
  97687. PrintfArguments x;
  97688. StrAccum str;
  97689. const char *zFormat;
  97690. int n;
  97691. sqlite3 *db = sqlite3_context_db_handle(context);
  97692. if( argc>=1 && (zFormat = (const char*)sqlite3_value_text(argv[0]))!=0 ){
  97693. x.nArg = argc-1;
  97694. x.nUsed = 0;
  97695. x.apArg = argv+1;
  97696. sqlite3StrAccumInit(&str, db, 0, 0, db->aLimit[SQLITE_LIMIT_LENGTH]);
  97697. str.printfFlags = SQLITE_PRINTF_SQLFUNC;
  97698. sqlite3XPrintf(&str, zFormat, &x);
  97699. n = str.nChar;
  97700. sqlite3_result_text(context, sqlite3StrAccumFinish(&str), n,
  97701. SQLITE_DYNAMIC);
  97702. }
  97703. }
  97704. /*
  97705. ** Implementation of the substr() function.
  97706. **
  97707. ** substr(x,p1,p2) returns p2 characters of x[] beginning with p1.
  97708. ** p1 is 1-indexed. So substr(x,1,1) returns the first character
  97709. ** of x. If x is text, then we actually count UTF-8 characters.
  97710. ** If x is a blob, then we count bytes.
  97711. **
  97712. ** If p1 is negative, then we begin abs(p1) from the end of x[].
  97713. **
  97714. ** If p2 is negative, return the p2 characters preceding p1.
  97715. */
  97716. static void substrFunc(
  97717. sqlite3_context *context,
  97718. int argc,
  97719. sqlite3_value **argv
  97720. ){
  97721. const unsigned char *z;
  97722. const unsigned char *z2;
  97723. int len;
  97724. int p0type;
  97725. i64 p1, p2;
  97726. int negP2 = 0;
  97727. assert( argc==3 || argc==2 );
  97728. if( sqlite3_value_type(argv[1])==SQLITE_NULL
  97729. || (argc==3 && sqlite3_value_type(argv[2])==SQLITE_NULL)
  97730. ){
  97731. return;
  97732. }
  97733. p0type = sqlite3_value_type(argv[0]);
  97734. p1 = sqlite3_value_int(argv[1]);
  97735. if( p0type==SQLITE_BLOB ){
  97736. len = sqlite3_value_bytes(argv[0]);
  97737. z = sqlite3_value_blob(argv[0]);
  97738. if( z==0 ) return;
  97739. assert( len==sqlite3_value_bytes(argv[0]) );
  97740. }else{
  97741. z = sqlite3_value_text(argv[0]);
  97742. if( z==0 ) return;
  97743. len = 0;
  97744. if( p1<0 ){
  97745. for(z2=z; *z2; len++){
  97746. SQLITE_SKIP_UTF8(z2);
  97747. }
  97748. }
  97749. }
  97750. #ifdef SQLITE_SUBSTR_COMPATIBILITY
  97751. /* If SUBSTR_COMPATIBILITY is defined then substr(X,0,N) work the same as
  97752. ** as substr(X,1,N) - it returns the first N characters of X. This
  97753. ** is essentially a back-out of the bug-fix in check-in [5fc125d362df4b8]
  97754. ** from 2009-02-02 for compatibility of applications that exploited the
  97755. ** old buggy behavior. */
  97756. if( p1==0 ) p1 = 1; /* <rdar://problem/6778339> */
  97757. #endif
  97758. if( argc==3 ){
  97759. p2 = sqlite3_value_int(argv[2]);
  97760. if( p2<0 ){
  97761. p2 = -p2;
  97762. negP2 = 1;
  97763. }
  97764. }else{
  97765. p2 = sqlite3_context_db_handle(context)->aLimit[SQLITE_LIMIT_LENGTH];
  97766. }
  97767. if( p1<0 ){
  97768. p1 += len;
  97769. if( p1<0 ){
  97770. p2 += p1;
  97771. if( p2<0 ) p2 = 0;
  97772. p1 = 0;
  97773. }
  97774. }else if( p1>0 ){
  97775. p1--;
  97776. }else if( p2>0 ){
  97777. p2--;
  97778. }
  97779. if( negP2 ){
  97780. p1 -= p2;
  97781. if( p1<0 ){
  97782. p2 += p1;
  97783. p1 = 0;
  97784. }
  97785. }
  97786. assert( p1>=0 && p2>=0 );
  97787. if( p0type!=SQLITE_BLOB ){
  97788. while( *z && p1 ){
  97789. SQLITE_SKIP_UTF8(z);
  97790. p1--;
  97791. }
  97792. for(z2=z; *z2 && p2; p2--){
  97793. SQLITE_SKIP_UTF8(z2);
  97794. }
  97795. sqlite3_result_text64(context, (char*)z, z2-z, SQLITE_TRANSIENT,
  97796. SQLITE_UTF8);
  97797. }else{
  97798. if( p1+p2>len ){
  97799. p2 = len-p1;
  97800. if( p2<0 ) p2 = 0;
  97801. }
  97802. sqlite3_result_blob64(context, (char*)&z[p1], (u64)p2, SQLITE_TRANSIENT);
  97803. }
  97804. }
  97805. /*
  97806. ** Implementation of the round() function
  97807. */
  97808. #ifndef SQLITE_OMIT_FLOATING_POINT
  97809. static void roundFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  97810. int n = 0;
  97811. double r;
  97812. char *zBuf;
  97813. assert( argc==1 || argc==2 );
  97814. if( argc==2 ){
  97815. if( SQLITE_NULL==sqlite3_value_type(argv[1]) ) return;
  97816. n = sqlite3_value_int(argv[1]);
  97817. if( n>30 ) n = 30;
  97818. if( n<0 ) n = 0;
  97819. }
  97820. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  97821. r = sqlite3_value_double(argv[0]);
  97822. /* If Y==0 and X will fit in a 64-bit int,
  97823. ** handle the rounding directly,
  97824. ** otherwise use printf.
  97825. */
  97826. if( n==0 && r>=0 && r<LARGEST_INT64-1 ){
  97827. r = (double)((sqlite_int64)(r+0.5));
  97828. }else if( n==0 && r<0 && (-r)<LARGEST_INT64-1 ){
  97829. r = -(double)((sqlite_int64)((-r)+0.5));
  97830. }else{
  97831. zBuf = sqlite3_mprintf("%.*f",n,r);
  97832. if( zBuf==0 ){
  97833. sqlite3_result_error_nomem(context);
  97834. return;
  97835. }
  97836. sqlite3AtoF(zBuf, &r, sqlite3Strlen30(zBuf), SQLITE_UTF8);
  97837. sqlite3_free(zBuf);
  97838. }
  97839. sqlite3_result_double(context, r);
  97840. }
  97841. #endif
  97842. /*
  97843. ** Allocate nByte bytes of space using sqlite3Malloc(). If the
  97844. ** allocation fails, call sqlite3_result_error_nomem() to notify
  97845. ** the database handle that malloc() has failed and return NULL.
  97846. ** If nByte is larger than the maximum string or blob length, then
  97847. ** raise an SQLITE_TOOBIG exception and return NULL.
  97848. */
  97849. static void *contextMalloc(sqlite3_context *context, i64 nByte){
  97850. char *z;
  97851. sqlite3 *db = sqlite3_context_db_handle(context);
  97852. assert( nByte>0 );
  97853. testcase( nByte==db->aLimit[SQLITE_LIMIT_LENGTH] );
  97854. testcase( nByte==db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
  97855. if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  97856. sqlite3_result_error_toobig(context);
  97857. z = 0;
  97858. }else{
  97859. z = sqlite3Malloc(nByte);
  97860. if( !z ){
  97861. sqlite3_result_error_nomem(context);
  97862. }
  97863. }
  97864. return z;
  97865. }
  97866. /*
  97867. ** Implementation of the upper() and lower() SQL functions.
  97868. */
  97869. static void upperFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  97870. char *z1;
  97871. const char *z2;
  97872. int i, n;
  97873. UNUSED_PARAMETER(argc);
  97874. z2 = (char*)sqlite3_value_text(argv[0]);
  97875. n = sqlite3_value_bytes(argv[0]);
  97876. /* Verify that the call to _bytes() does not invalidate the _text() pointer */
  97877. assert( z2==(char*)sqlite3_value_text(argv[0]) );
  97878. if( z2 ){
  97879. z1 = contextMalloc(context, ((i64)n)+1);
  97880. if( z1 ){
  97881. for(i=0; i<n; i++){
  97882. z1[i] = (char)sqlite3Toupper(z2[i]);
  97883. }
  97884. sqlite3_result_text(context, z1, n, sqlite3_free);
  97885. }
  97886. }
  97887. }
  97888. static void lowerFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  97889. char *z1;
  97890. const char *z2;
  97891. int i, n;
  97892. UNUSED_PARAMETER(argc);
  97893. z2 = (char*)sqlite3_value_text(argv[0]);
  97894. n = sqlite3_value_bytes(argv[0]);
  97895. /* Verify that the call to _bytes() does not invalidate the _text() pointer */
  97896. assert( z2==(char*)sqlite3_value_text(argv[0]) );
  97897. if( z2 ){
  97898. z1 = contextMalloc(context, ((i64)n)+1);
  97899. if( z1 ){
  97900. for(i=0; i<n; i++){
  97901. z1[i] = sqlite3Tolower(z2[i]);
  97902. }
  97903. sqlite3_result_text(context, z1, n, sqlite3_free);
  97904. }
  97905. }
  97906. }
  97907. /*
  97908. ** Some functions like COALESCE() and IFNULL() and UNLIKELY() are implemented
  97909. ** as VDBE code so that unused argument values do not have to be computed.
  97910. ** However, we still need some kind of function implementation for this
  97911. ** routines in the function table. The noopFunc macro provides this.
  97912. ** noopFunc will never be called so it doesn't matter what the implementation
  97913. ** is. We might as well use the "version()" function as a substitute.
  97914. */
  97915. #define noopFunc versionFunc /* Substitute function - never called */
  97916. /*
  97917. ** Implementation of random(). Return a random integer.
  97918. */
  97919. static void randomFunc(
  97920. sqlite3_context *context,
  97921. int NotUsed,
  97922. sqlite3_value **NotUsed2
  97923. ){
  97924. sqlite_int64 r;
  97925. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  97926. sqlite3_randomness(sizeof(r), &r);
  97927. if( r<0 ){
  97928. /* We need to prevent a random number of 0x8000000000000000
  97929. ** (or -9223372036854775808) since when you do abs() of that
  97930. ** number of you get the same value back again. To do this
  97931. ** in a way that is testable, mask the sign bit off of negative
  97932. ** values, resulting in a positive value. Then take the
  97933. ** 2s complement of that positive value. The end result can
  97934. ** therefore be no less than -9223372036854775807.
  97935. */
  97936. r = -(r & LARGEST_INT64);
  97937. }
  97938. sqlite3_result_int64(context, r);
  97939. }
  97940. /*
  97941. ** Implementation of randomblob(N). Return a random blob
  97942. ** that is N bytes long.
  97943. */
  97944. static void randomBlob(
  97945. sqlite3_context *context,
  97946. int argc,
  97947. sqlite3_value **argv
  97948. ){
  97949. int n;
  97950. unsigned char *p;
  97951. assert( argc==1 );
  97952. UNUSED_PARAMETER(argc);
  97953. n = sqlite3_value_int(argv[0]);
  97954. if( n<1 ){
  97955. n = 1;
  97956. }
  97957. p = contextMalloc(context, n);
  97958. if( p ){
  97959. sqlite3_randomness(n, p);
  97960. sqlite3_result_blob(context, (char*)p, n, sqlite3_free);
  97961. }
  97962. }
  97963. /*
  97964. ** Implementation of the last_insert_rowid() SQL function. The return
  97965. ** value is the same as the sqlite3_last_insert_rowid() API function.
  97966. */
  97967. static void last_insert_rowid(
  97968. sqlite3_context *context,
  97969. int NotUsed,
  97970. sqlite3_value **NotUsed2
  97971. ){
  97972. sqlite3 *db = sqlite3_context_db_handle(context);
  97973. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  97974. /* IMP: R-51513-12026 The last_insert_rowid() SQL function is a
  97975. ** wrapper around the sqlite3_last_insert_rowid() C/C++ interface
  97976. ** function. */
  97977. sqlite3_result_int64(context, sqlite3_last_insert_rowid(db));
  97978. }
  97979. /*
  97980. ** Implementation of the changes() SQL function.
  97981. **
  97982. ** IMP: R-62073-11209 The changes() SQL function is a wrapper
  97983. ** around the sqlite3_changes() C/C++ function and hence follows the same
  97984. ** rules for counting changes.
  97985. */
  97986. static void changes(
  97987. sqlite3_context *context,
  97988. int NotUsed,
  97989. sqlite3_value **NotUsed2
  97990. ){
  97991. sqlite3 *db = sqlite3_context_db_handle(context);
  97992. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  97993. sqlite3_result_int(context, sqlite3_changes(db));
  97994. }
  97995. /*
  97996. ** Implementation of the total_changes() SQL function. The return value is
  97997. ** the same as the sqlite3_total_changes() API function.
  97998. */
  97999. static void total_changes(
  98000. sqlite3_context *context,
  98001. int NotUsed,
  98002. sqlite3_value **NotUsed2
  98003. ){
  98004. sqlite3 *db = sqlite3_context_db_handle(context);
  98005. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  98006. /* IMP: R-52756-41993 This function is a wrapper around the
  98007. ** sqlite3_total_changes() C/C++ interface. */
  98008. sqlite3_result_int(context, sqlite3_total_changes(db));
  98009. }
  98010. /*
  98011. ** A structure defining how to do GLOB-style comparisons.
  98012. */
  98013. struct compareInfo {
  98014. u8 matchAll; /* "*" or "%" */
  98015. u8 matchOne; /* "?" or "_" */
  98016. u8 matchSet; /* "[" or 0 */
  98017. u8 noCase; /* true to ignore case differences */
  98018. };
  98019. /*
  98020. ** For LIKE and GLOB matching on EBCDIC machines, assume that every
  98021. ** character is exactly one byte in size. Also, provde the Utf8Read()
  98022. ** macro for fast reading of the next character in the common case where
  98023. ** the next character is ASCII.
  98024. */
  98025. #if defined(SQLITE_EBCDIC)
  98026. # define sqlite3Utf8Read(A) (*((*A)++))
  98027. # define Utf8Read(A) (*(A++))
  98028. #else
  98029. # define Utf8Read(A) (A[0]<0x80?*(A++):sqlite3Utf8Read(&A))
  98030. #endif
  98031. static const struct compareInfo globInfo = { '*', '?', '[', 0 };
  98032. /* The correct SQL-92 behavior is for the LIKE operator to ignore
  98033. ** case. Thus 'a' LIKE 'A' would be true. */
  98034. static const struct compareInfo likeInfoNorm = { '%', '_', 0, 1 };
  98035. /* If SQLITE_CASE_SENSITIVE_LIKE is defined, then the LIKE operator
  98036. ** is case sensitive causing 'a' LIKE 'A' to be false */
  98037. static const struct compareInfo likeInfoAlt = { '%', '_', 0, 0 };
  98038. /*
  98039. ** Compare two UTF-8 strings for equality where the first string can
  98040. ** potentially be a "glob" or "like" expression. Return true (1) if they
  98041. ** are the same and false (0) if they are different.
  98042. **
  98043. ** Globbing rules:
  98044. **
  98045. ** '*' Matches any sequence of zero or more characters.
  98046. **
  98047. ** '?' Matches exactly one character.
  98048. **
  98049. ** [...] Matches one character from the enclosed list of
  98050. ** characters.
  98051. **
  98052. ** [^...] Matches one character not in the enclosed list.
  98053. **
  98054. ** With the [...] and [^...] matching, a ']' character can be included
  98055. ** in the list by making it the first character after '[' or '^'. A
  98056. ** range of characters can be specified using '-'. Example:
  98057. ** "[a-z]" matches any single lower-case letter. To match a '-', make
  98058. ** it the last character in the list.
  98059. **
  98060. ** Like matching rules:
  98061. **
  98062. ** '%' Matches any sequence of zero or more characters
  98063. **
  98064. *** '_' Matches any one character
  98065. **
  98066. ** Ec Where E is the "esc" character and c is any other
  98067. ** character, including '%', '_', and esc, match exactly c.
  98068. **
  98069. ** The comments within this routine usually assume glob matching.
  98070. **
  98071. ** This routine is usually quick, but can be N**2 in the worst case.
  98072. */
  98073. static int patternCompare(
  98074. const u8 *zPattern, /* The glob pattern */
  98075. const u8 *zString, /* The string to compare against the glob */
  98076. const struct compareInfo *pInfo, /* Information about how to do the compare */
  98077. u32 matchOther /* The escape char (LIKE) or '[' (GLOB) */
  98078. ){
  98079. u32 c, c2; /* Next pattern and input string chars */
  98080. u32 matchOne = pInfo->matchOne; /* "?" or "_" */
  98081. u32 matchAll = pInfo->matchAll; /* "*" or "%" */
  98082. u8 noCase = pInfo->noCase; /* True if uppercase==lowercase */
  98083. const u8 *zEscaped = 0; /* One past the last escaped input char */
  98084. while( (c = Utf8Read(zPattern))!=0 ){
  98085. if( c==matchAll ){ /* Match "*" */
  98086. /* Skip over multiple "*" characters in the pattern. If there
  98087. ** are also "?" characters, skip those as well, but consume a
  98088. ** single character of the input string for each "?" skipped */
  98089. while( (c=Utf8Read(zPattern)) == matchAll || c == matchOne ){
  98090. if( c==matchOne && sqlite3Utf8Read(&zString)==0 ){
  98091. return 0;
  98092. }
  98093. }
  98094. if( c==0 ){
  98095. return 1; /* "*" at the end of the pattern matches */
  98096. }else if( c==matchOther ){
  98097. if( pInfo->matchSet==0 ){
  98098. c = sqlite3Utf8Read(&zPattern);
  98099. if( c==0 ) return 0;
  98100. }else{
  98101. /* "[...]" immediately follows the "*". We have to do a slow
  98102. ** recursive search in this case, but it is an unusual case. */
  98103. assert( matchOther<0x80 ); /* '[' is a single-byte character */
  98104. while( *zString
  98105. && patternCompare(&zPattern[-1],zString,pInfo,matchOther)==0 ){
  98106. SQLITE_SKIP_UTF8(zString);
  98107. }
  98108. return *zString!=0;
  98109. }
  98110. }
  98111. /* At this point variable c contains the first character of the
  98112. ** pattern string past the "*". Search in the input string for the
  98113. ** first matching character and recursively contine the match from
  98114. ** that point.
  98115. **
  98116. ** For a case-insensitive search, set variable cx to be the same as
  98117. ** c but in the other case and search the input string for either
  98118. ** c or cx.
  98119. */
  98120. if( c<=0x80 ){
  98121. u32 cx;
  98122. if( noCase ){
  98123. cx = sqlite3Toupper(c);
  98124. c = sqlite3Tolower(c);
  98125. }else{
  98126. cx = c;
  98127. }
  98128. while( (c2 = *(zString++))!=0 ){
  98129. if( c2!=c && c2!=cx ) continue;
  98130. if( patternCompare(zPattern,zString,pInfo,matchOther) ) return 1;
  98131. }
  98132. }else{
  98133. while( (c2 = Utf8Read(zString))!=0 ){
  98134. if( c2!=c ) continue;
  98135. if( patternCompare(zPattern,zString,pInfo,matchOther) ) return 1;
  98136. }
  98137. }
  98138. return 0;
  98139. }
  98140. if( c==matchOther ){
  98141. if( pInfo->matchSet==0 ){
  98142. c = sqlite3Utf8Read(&zPattern);
  98143. if( c==0 ) return 0;
  98144. zEscaped = zPattern;
  98145. }else{
  98146. u32 prior_c = 0;
  98147. int seen = 0;
  98148. int invert = 0;
  98149. c = sqlite3Utf8Read(&zString);
  98150. if( c==0 ) return 0;
  98151. c2 = sqlite3Utf8Read(&zPattern);
  98152. if( c2=='^' ){
  98153. invert = 1;
  98154. c2 = sqlite3Utf8Read(&zPattern);
  98155. }
  98156. if( c2==']' ){
  98157. if( c==']' ) seen = 1;
  98158. c2 = sqlite3Utf8Read(&zPattern);
  98159. }
  98160. while( c2 && c2!=']' ){
  98161. if( c2=='-' && zPattern[0]!=']' && zPattern[0]!=0 && prior_c>0 ){
  98162. c2 = sqlite3Utf8Read(&zPattern);
  98163. if( c>=prior_c && c<=c2 ) seen = 1;
  98164. prior_c = 0;
  98165. }else{
  98166. if( c==c2 ){
  98167. seen = 1;
  98168. }
  98169. prior_c = c2;
  98170. }
  98171. c2 = sqlite3Utf8Read(&zPattern);
  98172. }
  98173. if( c2==0 || (seen ^ invert)==0 ){
  98174. return 0;
  98175. }
  98176. continue;
  98177. }
  98178. }
  98179. c2 = Utf8Read(zString);
  98180. if( c==c2 ) continue;
  98181. if( noCase && sqlite3Tolower(c)==sqlite3Tolower(c2) && c<0x80 && c2<0x80 ){
  98182. continue;
  98183. }
  98184. if( c==matchOne && zPattern!=zEscaped && c2!=0 ) continue;
  98185. return 0;
  98186. }
  98187. return *zString==0;
  98188. }
  98189. /*
  98190. ** The sqlite3_strglob() interface.
  98191. */
  98192. SQLITE_API int sqlite3_strglob(const char *zGlobPattern, const char *zString){
  98193. return patternCompare((u8*)zGlobPattern, (u8*)zString, &globInfo, '[')==0;
  98194. }
  98195. /*
  98196. ** The sqlite3_strlike() interface.
  98197. */
  98198. SQLITE_API int sqlite3_strlike(const char *zPattern, const char *zStr, unsigned int esc){
  98199. return patternCompare((u8*)zPattern, (u8*)zStr, &likeInfoNorm, esc)==0;
  98200. }
  98201. /*
  98202. ** Count the number of times that the LIKE operator (or GLOB which is
  98203. ** just a variation of LIKE) gets called. This is used for testing
  98204. ** only.
  98205. */
  98206. #ifdef SQLITE_TEST
  98207. SQLITE_API int sqlite3_like_count = 0;
  98208. #endif
  98209. /*
  98210. ** Implementation of the like() SQL function. This function implements
  98211. ** the build-in LIKE operator. The first argument to the function is the
  98212. ** pattern and the second argument is the string. So, the SQL statements:
  98213. **
  98214. ** A LIKE B
  98215. **
  98216. ** is implemented as like(B,A).
  98217. **
  98218. ** This same function (with a different compareInfo structure) computes
  98219. ** the GLOB operator.
  98220. */
  98221. static void likeFunc(
  98222. sqlite3_context *context,
  98223. int argc,
  98224. sqlite3_value **argv
  98225. ){
  98226. const unsigned char *zA, *zB;
  98227. u32 escape;
  98228. int nPat;
  98229. sqlite3 *db = sqlite3_context_db_handle(context);
  98230. struct compareInfo *pInfo = sqlite3_user_data(context);
  98231. #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  98232. if( sqlite3_value_type(argv[0])==SQLITE_BLOB
  98233. || sqlite3_value_type(argv[1])==SQLITE_BLOB
  98234. ){
  98235. #ifdef SQLITE_TEST
  98236. sqlite3_like_count++;
  98237. #endif
  98238. sqlite3_result_int(context, 0);
  98239. return;
  98240. }
  98241. #endif
  98242. zB = sqlite3_value_text(argv[0]);
  98243. zA = sqlite3_value_text(argv[1]);
  98244. /* Limit the length of the LIKE or GLOB pattern to avoid problems
  98245. ** of deep recursion and N*N behavior in patternCompare().
  98246. */
  98247. nPat = sqlite3_value_bytes(argv[0]);
  98248. testcase( nPat==db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH] );
  98249. testcase( nPat==db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]+1 );
  98250. if( nPat > db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH] ){
  98251. sqlite3_result_error(context, "LIKE or GLOB pattern too complex", -1);
  98252. return;
  98253. }
  98254. assert( zB==sqlite3_value_text(argv[0]) ); /* Encoding did not change */
  98255. if( argc==3 ){
  98256. /* The escape character string must consist of a single UTF-8 character.
  98257. ** Otherwise, return an error.
  98258. */
  98259. const unsigned char *zEsc = sqlite3_value_text(argv[2]);
  98260. if( zEsc==0 ) return;
  98261. if( sqlite3Utf8CharLen((char*)zEsc, -1)!=1 ){
  98262. sqlite3_result_error(context,
  98263. "ESCAPE expression must be a single character", -1);
  98264. return;
  98265. }
  98266. escape = sqlite3Utf8Read(&zEsc);
  98267. }else{
  98268. escape = pInfo->matchSet;
  98269. }
  98270. if( zA && zB ){
  98271. #ifdef SQLITE_TEST
  98272. sqlite3_like_count++;
  98273. #endif
  98274. sqlite3_result_int(context, patternCompare(zB, zA, pInfo, escape));
  98275. }
  98276. }
  98277. /*
  98278. ** Implementation of the NULLIF(x,y) function. The result is the first
  98279. ** argument if the arguments are different. The result is NULL if the
  98280. ** arguments are equal to each other.
  98281. */
  98282. static void nullifFunc(
  98283. sqlite3_context *context,
  98284. int NotUsed,
  98285. sqlite3_value **argv
  98286. ){
  98287. CollSeq *pColl = sqlite3GetFuncCollSeq(context);
  98288. UNUSED_PARAMETER(NotUsed);
  98289. if( sqlite3MemCompare(argv[0], argv[1], pColl)!=0 ){
  98290. sqlite3_result_value(context, argv[0]);
  98291. }
  98292. }
  98293. /*
  98294. ** Implementation of the sqlite_version() function. The result is the version
  98295. ** of the SQLite library that is running.
  98296. */
  98297. static void versionFunc(
  98298. sqlite3_context *context,
  98299. int NotUsed,
  98300. sqlite3_value **NotUsed2
  98301. ){
  98302. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  98303. /* IMP: R-48699-48617 This function is an SQL wrapper around the
  98304. ** sqlite3_libversion() C-interface. */
  98305. sqlite3_result_text(context, sqlite3_libversion(), -1, SQLITE_STATIC);
  98306. }
  98307. /*
  98308. ** Implementation of the sqlite_source_id() function. The result is a string
  98309. ** that identifies the particular version of the source code used to build
  98310. ** SQLite.
  98311. */
  98312. static void sourceidFunc(
  98313. sqlite3_context *context,
  98314. int NotUsed,
  98315. sqlite3_value **NotUsed2
  98316. ){
  98317. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  98318. /* IMP: R-24470-31136 This function is an SQL wrapper around the
  98319. ** sqlite3_sourceid() C interface. */
  98320. sqlite3_result_text(context, sqlite3_sourceid(), -1, SQLITE_STATIC);
  98321. }
  98322. /*
  98323. ** Implementation of the sqlite_log() function. This is a wrapper around
  98324. ** sqlite3_log(). The return value is NULL. The function exists purely for
  98325. ** its side-effects.
  98326. */
  98327. static void errlogFunc(
  98328. sqlite3_context *context,
  98329. int argc,
  98330. sqlite3_value **argv
  98331. ){
  98332. UNUSED_PARAMETER(argc);
  98333. UNUSED_PARAMETER(context);
  98334. sqlite3_log(sqlite3_value_int(argv[0]), "%s", sqlite3_value_text(argv[1]));
  98335. }
  98336. /*
  98337. ** Implementation of the sqlite_compileoption_used() function.
  98338. ** The result is an integer that identifies if the compiler option
  98339. ** was used to build SQLite.
  98340. */
  98341. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  98342. static void compileoptionusedFunc(
  98343. sqlite3_context *context,
  98344. int argc,
  98345. sqlite3_value **argv
  98346. ){
  98347. const char *zOptName;
  98348. assert( argc==1 );
  98349. UNUSED_PARAMETER(argc);
  98350. /* IMP: R-39564-36305 The sqlite_compileoption_used() SQL
  98351. ** function is a wrapper around the sqlite3_compileoption_used() C/C++
  98352. ** function.
  98353. */
  98354. if( (zOptName = (const char*)sqlite3_value_text(argv[0]))!=0 ){
  98355. sqlite3_result_int(context, sqlite3_compileoption_used(zOptName));
  98356. }
  98357. }
  98358. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  98359. /*
  98360. ** Implementation of the sqlite_compileoption_get() function.
  98361. ** The result is a string that identifies the compiler options
  98362. ** used to build SQLite.
  98363. */
  98364. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  98365. static void compileoptiongetFunc(
  98366. sqlite3_context *context,
  98367. int argc,
  98368. sqlite3_value **argv
  98369. ){
  98370. int n;
  98371. assert( argc==1 );
  98372. UNUSED_PARAMETER(argc);
  98373. /* IMP: R-04922-24076 The sqlite_compileoption_get() SQL function
  98374. ** is a wrapper around the sqlite3_compileoption_get() C/C++ function.
  98375. */
  98376. n = sqlite3_value_int(argv[0]);
  98377. sqlite3_result_text(context, sqlite3_compileoption_get(n), -1, SQLITE_STATIC);
  98378. }
  98379. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  98380. /* Array for converting from half-bytes (nybbles) into ASCII hex
  98381. ** digits. */
  98382. static const char hexdigits[] = {
  98383. '0', '1', '2', '3', '4', '5', '6', '7',
  98384. '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
  98385. };
  98386. /*
  98387. ** Implementation of the QUOTE() function. This function takes a single
  98388. ** argument. If the argument is numeric, the return value is the same as
  98389. ** the argument. If the argument is NULL, the return value is the string
  98390. ** "NULL". Otherwise, the argument is enclosed in single quotes with
  98391. ** single-quote escapes.
  98392. */
  98393. static void quoteFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  98394. assert( argc==1 );
  98395. UNUSED_PARAMETER(argc);
  98396. switch( sqlite3_value_type(argv[0]) ){
  98397. case SQLITE_FLOAT: {
  98398. double r1, r2;
  98399. char zBuf[50];
  98400. r1 = sqlite3_value_double(argv[0]);
  98401. sqlite3_snprintf(sizeof(zBuf), zBuf, "%!.15g", r1);
  98402. sqlite3AtoF(zBuf, &r2, 20, SQLITE_UTF8);
  98403. if( r1!=r2 ){
  98404. sqlite3_snprintf(sizeof(zBuf), zBuf, "%!.20e", r1);
  98405. }
  98406. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  98407. break;
  98408. }
  98409. case SQLITE_INTEGER: {
  98410. sqlite3_result_value(context, argv[0]);
  98411. break;
  98412. }
  98413. case SQLITE_BLOB: {
  98414. char *zText = 0;
  98415. char const *zBlob = sqlite3_value_blob(argv[0]);
  98416. int nBlob = sqlite3_value_bytes(argv[0]);
  98417. assert( zBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
  98418. zText = (char *)contextMalloc(context, (2*(i64)nBlob)+4);
  98419. if( zText ){
  98420. int i;
  98421. for(i=0; i<nBlob; i++){
  98422. zText[(i*2)+2] = hexdigits[(zBlob[i]>>4)&0x0F];
  98423. zText[(i*2)+3] = hexdigits[(zBlob[i])&0x0F];
  98424. }
  98425. zText[(nBlob*2)+2] = '\'';
  98426. zText[(nBlob*2)+3] = '\0';
  98427. zText[0] = 'X';
  98428. zText[1] = '\'';
  98429. sqlite3_result_text(context, zText, -1, SQLITE_TRANSIENT);
  98430. sqlite3_free(zText);
  98431. }
  98432. break;
  98433. }
  98434. case SQLITE_TEXT: {
  98435. int i,j;
  98436. u64 n;
  98437. const unsigned char *zArg = sqlite3_value_text(argv[0]);
  98438. char *z;
  98439. if( zArg==0 ) return;
  98440. for(i=0, n=0; zArg[i]; i++){ if( zArg[i]=='\'' ) n++; }
  98441. z = contextMalloc(context, ((i64)i)+((i64)n)+3);
  98442. if( z ){
  98443. z[0] = '\'';
  98444. for(i=0, j=1; zArg[i]; i++){
  98445. z[j++] = zArg[i];
  98446. if( zArg[i]=='\'' ){
  98447. z[j++] = '\'';
  98448. }
  98449. }
  98450. z[j++] = '\'';
  98451. z[j] = 0;
  98452. sqlite3_result_text(context, z, j, sqlite3_free);
  98453. }
  98454. break;
  98455. }
  98456. default: {
  98457. assert( sqlite3_value_type(argv[0])==SQLITE_NULL );
  98458. sqlite3_result_text(context, "NULL", 4, SQLITE_STATIC);
  98459. break;
  98460. }
  98461. }
  98462. }
  98463. /*
  98464. ** The unicode() function. Return the integer unicode code-point value
  98465. ** for the first character of the input string.
  98466. */
  98467. static void unicodeFunc(
  98468. sqlite3_context *context,
  98469. int argc,
  98470. sqlite3_value **argv
  98471. ){
  98472. const unsigned char *z = sqlite3_value_text(argv[0]);
  98473. (void)argc;
  98474. if( z && z[0] ) sqlite3_result_int(context, sqlite3Utf8Read(&z));
  98475. }
  98476. /*
  98477. ** The char() function takes zero or more arguments, each of which is
  98478. ** an integer. It constructs a string where each character of the string
  98479. ** is the unicode character for the corresponding integer argument.
  98480. */
  98481. static void charFunc(
  98482. sqlite3_context *context,
  98483. int argc,
  98484. sqlite3_value **argv
  98485. ){
  98486. unsigned char *z, *zOut;
  98487. int i;
  98488. zOut = z = sqlite3_malloc64( argc*4+1 );
  98489. if( z==0 ){
  98490. sqlite3_result_error_nomem(context);
  98491. return;
  98492. }
  98493. for(i=0; i<argc; i++){
  98494. sqlite3_int64 x;
  98495. unsigned c;
  98496. x = sqlite3_value_int64(argv[i]);
  98497. if( x<0 || x>0x10ffff ) x = 0xfffd;
  98498. c = (unsigned)(x & 0x1fffff);
  98499. if( c<0x00080 ){
  98500. *zOut++ = (u8)(c&0xFF);
  98501. }else if( c<0x00800 ){
  98502. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F);
  98503. *zOut++ = 0x80 + (u8)(c & 0x3F);
  98504. }else if( c<0x10000 ){
  98505. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F);
  98506. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F);
  98507. *zOut++ = 0x80 + (u8)(c & 0x3F);
  98508. }else{
  98509. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07);
  98510. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F);
  98511. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F);
  98512. *zOut++ = 0x80 + (u8)(c & 0x3F);
  98513. } \
  98514. }
  98515. sqlite3_result_text64(context, (char*)z, zOut-z, sqlite3_free, SQLITE_UTF8);
  98516. }
  98517. /*
  98518. ** The hex() function. Interpret the argument as a blob. Return
  98519. ** a hexadecimal rendering as text.
  98520. */
  98521. static void hexFunc(
  98522. sqlite3_context *context,
  98523. int argc,
  98524. sqlite3_value **argv
  98525. ){
  98526. int i, n;
  98527. const unsigned char *pBlob;
  98528. char *zHex, *z;
  98529. assert( argc==1 );
  98530. UNUSED_PARAMETER(argc);
  98531. pBlob = sqlite3_value_blob(argv[0]);
  98532. n = sqlite3_value_bytes(argv[0]);
  98533. assert( pBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
  98534. z = zHex = contextMalloc(context, ((i64)n)*2 + 1);
  98535. if( zHex ){
  98536. for(i=0; i<n; i++, pBlob++){
  98537. unsigned char c = *pBlob;
  98538. *(z++) = hexdigits[(c>>4)&0xf];
  98539. *(z++) = hexdigits[c&0xf];
  98540. }
  98541. *z = 0;
  98542. sqlite3_result_text(context, zHex, n*2, sqlite3_free);
  98543. }
  98544. }
  98545. /*
  98546. ** The zeroblob(N) function returns a zero-filled blob of size N bytes.
  98547. */
  98548. static void zeroblobFunc(
  98549. sqlite3_context *context,
  98550. int argc,
  98551. sqlite3_value **argv
  98552. ){
  98553. i64 n;
  98554. int rc;
  98555. assert( argc==1 );
  98556. UNUSED_PARAMETER(argc);
  98557. n = sqlite3_value_int64(argv[0]);
  98558. if( n<0 ) n = 0;
  98559. rc = sqlite3_result_zeroblob64(context, n); /* IMP: R-00293-64994 */
  98560. if( rc ){
  98561. sqlite3_result_error_code(context, rc);
  98562. }
  98563. }
  98564. /*
  98565. ** The replace() function. Three arguments are all strings: call
  98566. ** them A, B, and C. The result is also a string which is derived
  98567. ** from A by replacing every occurrence of B with C. The match
  98568. ** must be exact. Collating sequences are not used.
  98569. */
  98570. static void replaceFunc(
  98571. sqlite3_context *context,
  98572. int argc,
  98573. sqlite3_value **argv
  98574. ){
  98575. const unsigned char *zStr; /* The input string A */
  98576. const unsigned char *zPattern; /* The pattern string B */
  98577. const unsigned char *zRep; /* The replacement string C */
  98578. unsigned char *zOut; /* The output */
  98579. int nStr; /* Size of zStr */
  98580. int nPattern; /* Size of zPattern */
  98581. int nRep; /* Size of zRep */
  98582. i64 nOut; /* Maximum size of zOut */
  98583. int loopLimit; /* Last zStr[] that might match zPattern[] */
  98584. int i, j; /* Loop counters */
  98585. assert( argc==3 );
  98586. UNUSED_PARAMETER(argc);
  98587. zStr = sqlite3_value_text(argv[0]);
  98588. if( zStr==0 ) return;
  98589. nStr = sqlite3_value_bytes(argv[0]);
  98590. assert( zStr==sqlite3_value_text(argv[0]) ); /* No encoding change */
  98591. zPattern = sqlite3_value_text(argv[1]);
  98592. if( zPattern==0 ){
  98593. assert( sqlite3_value_type(argv[1])==SQLITE_NULL
  98594. || sqlite3_context_db_handle(context)->mallocFailed );
  98595. return;
  98596. }
  98597. if( zPattern[0]==0 ){
  98598. assert( sqlite3_value_type(argv[1])!=SQLITE_NULL );
  98599. sqlite3_result_value(context, argv[0]);
  98600. return;
  98601. }
  98602. nPattern = sqlite3_value_bytes(argv[1]);
  98603. assert( zPattern==sqlite3_value_text(argv[1]) ); /* No encoding change */
  98604. zRep = sqlite3_value_text(argv[2]);
  98605. if( zRep==0 ) return;
  98606. nRep = sqlite3_value_bytes(argv[2]);
  98607. assert( zRep==sqlite3_value_text(argv[2]) );
  98608. nOut = nStr + 1;
  98609. assert( nOut<SQLITE_MAX_LENGTH );
  98610. zOut = contextMalloc(context, (i64)nOut);
  98611. if( zOut==0 ){
  98612. return;
  98613. }
  98614. loopLimit = nStr - nPattern;
  98615. for(i=j=0; i<=loopLimit; i++){
  98616. if( zStr[i]!=zPattern[0] || memcmp(&zStr[i], zPattern, nPattern) ){
  98617. zOut[j++] = zStr[i];
  98618. }else{
  98619. u8 *zOld;
  98620. sqlite3 *db = sqlite3_context_db_handle(context);
  98621. nOut += nRep - nPattern;
  98622. testcase( nOut-1==db->aLimit[SQLITE_LIMIT_LENGTH] );
  98623. testcase( nOut-2==db->aLimit[SQLITE_LIMIT_LENGTH] );
  98624. if( nOut-1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  98625. sqlite3_result_error_toobig(context);
  98626. sqlite3_free(zOut);
  98627. return;
  98628. }
  98629. zOld = zOut;
  98630. zOut = sqlite3_realloc64(zOut, (int)nOut);
  98631. if( zOut==0 ){
  98632. sqlite3_result_error_nomem(context);
  98633. sqlite3_free(zOld);
  98634. return;
  98635. }
  98636. memcpy(&zOut[j], zRep, nRep);
  98637. j += nRep;
  98638. i += nPattern-1;
  98639. }
  98640. }
  98641. assert( j+nStr-i+1==nOut );
  98642. memcpy(&zOut[j], &zStr[i], nStr-i);
  98643. j += nStr - i;
  98644. assert( j<=nOut );
  98645. zOut[j] = 0;
  98646. sqlite3_result_text(context, (char*)zOut, j, sqlite3_free);
  98647. }
  98648. /*
  98649. ** Implementation of the TRIM(), LTRIM(), and RTRIM() functions.
  98650. ** The userdata is 0x1 for left trim, 0x2 for right trim, 0x3 for both.
  98651. */
  98652. static void trimFunc(
  98653. sqlite3_context *context,
  98654. int argc,
  98655. sqlite3_value **argv
  98656. ){
  98657. const unsigned char *zIn; /* Input string */
  98658. const unsigned char *zCharSet; /* Set of characters to trim */
  98659. int nIn; /* Number of bytes in input */
  98660. int flags; /* 1: trimleft 2: trimright 3: trim */
  98661. int i; /* Loop counter */
  98662. unsigned char *aLen = 0; /* Length of each character in zCharSet */
  98663. unsigned char **azChar = 0; /* Individual characters in zCharSet */
  98664. int nChar; /* Number of characters in zCharSet */
  98665. if( sqlite3_value_type(argv[0])==SQLITE_NULL ){
  98666. return;
  98667. }
  98668. zIn = sqlite3_value_text(argv[0]);
  98669. if( zIn==0 ) return;
  98670. nIn = sqlite3_value_bytes(argv[0]);
  98671. assert( zIn==sqlite3_value_text(argv[0]) );
  98672. if( argc==1 ){
  98673. static const unsigned char lenOne[] = { 1 };
  98674. static unsigned char * const azOne[] = { (u8*)" " };
  98675. nChar = 1;
  98676. aLen = (u8*)lenOne;
  98677. azChar = (unsigned char **)azOne;
  98678. zCharSet = 0;
  98679. }else if( (zCharSet = sqlite3_value_text(argv[1]))==0 ){
  98680. return;
  98681. }else{
  98682. const unsigned char *z;
  98683. for(z=zCharSet, nChar=0; *z; nChar++){
  98684. SQLITE_SKIP_UTF8(z);
  98685. }
  98686. if( nChar>0 ){
  98687. azChar = contextMalloc(context, ((i64)nChar)*(sizeof(char*)+1));
  98688. if( azChar==0 ){
  98689. return;
  98690. }
  98691. aLen = (unsigned char*)&azChar[nChar];
  98692. for(z=zCharSet, nChar=0; *z; nChar++){
  98693. azChar[nChar] = (unsigned char *)z;
  98694. SQLITE_SKIP_UTF8(z);
  98695. aLen[nChar] = (u8)(z - azChar[nChar]);
  98696. }
  98697. }
  98698. }
  98699. if( nChar>0 ){
  98700. flags = SQLITE_PTR_TO_INT(sqlite3_user_data(context));
  98701. if( flags & 1 ){
  98702. while( nIn>0 ){
  98703. int len = 0;
  98704. for(i=0; i<nChar; i++){
  98705. len = aLen[i];
  98706. if( len<=nIn && memcmp(zIn, azChar[i], len)==0 ) break;
  98707. }
  98708. if( i>=nChar ) break;
  98709. zIn += len;
  98710. nIn -= len;
  98711. }
  98712. }
  98713. if( flags & 2 ){
  98714. while( nIn>0 ){
  98715. int len = 0;
  98716. for(i=0; i<nChar; i++){
  98717. len = aLen[i];
  98718. if( len<=nIn && memcmp(&zIn[nIn-len],azChar[i],len)==0 ) break;
  98719. }
  98720. if( i>=nChar ) break;
  98721. nIn -= len;
  98722. }
  98723. }
  98724. if( zCharSet ){
  98725. sqlite3_free(azChar);
  98726. }
  98727. }
  98728. sqlite3_result_text(context, (char*)zIn, nIn, SQLITE_TRANSIENT);
  98729. }
  98730. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  98731. /*
  98732. ** The "unknown" function is automatically substituted in place of
  98733. ** any unrecognized function name when doing an EXPLAIN or EXPLAIN QUERY PLAN
  98734. ** when the SQLITE_ENABLE_UNKNOWN_FUNCTION compile-time option is used.
  98735. ** When the "sqlite3" command-line shell is built using this functionality,
  98736. ** that allows an EXPLAIN or EXPLAIN QUERY PLAN for complex queries
  98737. ** involving application-defined functions to be examined in a generic
  98738. ** sqlite3 shell.
  98739. */
  98740. static void unknownFunc(
  98741. sqlite3_context *context,
  98742. int argc,
  98743. sqlite3_value **argv
  98744. ){
  98745. /* no-op */
  98746. }
  98747. #endif /*SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION*/
  98748. /* IMP: R-25361-16150 This function is omitted from SQLite by default. It
  98749. ** is only available if the SQLITE_SOUNDEX compile-time option is used
  98750. ** when SQLite is built.
  98751. */
  98752. #ifdef SQLITE_SOUNDEX
  98753. /*
  98754. ** Compute the soundex encoding of a word.
  98755. **
  98756. ** IMP: R-59782-00072 The soundex(X) function returns a string that is the
  98757. ** soundex encoding of the string X.
  98758. */
  98759. static void soundexFunc(
  98760. sqlite3_context *context,
  98761. int argc,
  98762. sqlite3_value **argv
  98763. ){
  98764. char zResult[8];
  98765. const u8 *zIn;
  98766. int i, j;
  98767. static const unsigned char iCode[] = {
  98768. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  98769. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  98770. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  98771. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  98772. 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
  98773. 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
  98774. 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
  98775. 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
  98776. };
  98777. assert( argc==1 );
  98778. zIn = (u8*)sqlite3_value_text(argv[0]);
  98779. if( zIn==0 ) zIn = (u8*)"";
  98780. for(i=0; zIn[i] && !sqlite3Isalpha(zIn[i]); i++){}
  98781. if( zIn[i] ){
  98782. u8 prevcode = iCode[zIn[i]&0x7f];
  98783. zResult[0] = sqlite3Toupper(zIn[i]);
  98784. for(j=1; j<4 && zIn[i]; i++){
  98785. int code = iCode[zIn[i]&0x7f];
  98786. if( code>0 ){
  98787. if( code!=prevcode ){
  98788. prevcode = code;
  98789. zResult[j++] = code + '0';
  98790. }
  98791. }else{
  98792. prevcode = 0;
  98793. }
  98794. }
  98795. while( j<4 ){
  98796. zResult[j++] = '0';
  98797. }
  98798. zResult[j] = 0;
  98799. sqlite3_result_text(context, zResult, 4, SQLITE_TRANSIENT);
  98800. }else{
  98801. /* IMP: R-64894-50321 The string "?000" is returned if the argument
  98802. ** is NULL or contains no ASCII alphabetic characters. */
  98803. sqlite3_result_text(context, "?000", 4, SQLITE_STATIC);
  98804. }
  98805. }
  98806. #endif /* SQLITE_SOUNDEX */
  98807. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  98808. /*
  98809. ** A function that loads a shared-library extension then returns NULL.
  98810. */
  98811. static void loadExt(sqlite3_context *context, int argc, sqlite3_value **argv){
  98812. const char *zFile = (const char *)sqlite3_value_text(argv[0]);
  98813. const char *zProc;
  98814. sqlite3 *db = sqlite3_context_db_handle(context);
  98815. char *zErrMsg = 0;
  98816. /* Disallow the load_extension() SQL function unless the SQLITE_LoadExtFunc
  98817. ** flag is set. See the sqlite3_enable_load_extension() API.
  98818. */
  98819. if( (db->flags & SQLITE_LoadExtFunc)==0 ){
  98820. sqlite3_result_error(context, "not authorized", -1);
  98821. return;
  98822. }
  98823. if( argc==2 ){
  98824. zProc = (const char *)sqlite3_value_text(argv[1]);
  98825. }else{
  98826. zProc = 0;
  98827. }
  98828. if( zFile && sqlite3_load_extension(db, zFile, zProc, &zErrMsg) ){
  98829. sqlite3_result_error(context, zErrMsg, -1);
  98830. sqlite3_free(zErrMsg);
  98831. }
  98832. }
  98833. #endif
  98834. /*
  98835. ** An instance of the following structure holds the context of a
  98836. ** sum() or avg() aggregate computation.
  98837. */
  98838. typedef struct SumCtx SumCtx;
  98839. struct SumCtx {
  98840. double rSum; /* Floating point sum */
  98841. i64 iSum; /* Integer sum */
  98842. i64 cnt; /* Number of elements summed */
  98843. u8 overflow; /* True if integer overflow seen */
  98844. u8 approx; /* True if non-integer value was input to the sum */
  98845. };
  98846. /*
  98847. ** Routines used to compute the sum, average, and total.
  98848. **
  98849. ** The SUM() function follows the (broken) SQL standard which means
  98850. ** that it returns NULL if it sums over no inputs. TOTAL returns
  98851. ** 0.0 in that case. In addition, TOTAL always returns a float where
  98852. ** SUM might return an integer if it never encounters a floating point
  98853. ** value. TOTAL never fails, but SUM might through an exception if
  98854. ** it overflows an integer.
  98855. */
  98856. static void sumStep(sqlite3_context *context, int argc, sqlite3_value **argv){
  98857. SumCtx *p;
  98858. int type;
  98859. assert( argc==1 );
  98860. UNUSED_PARAMETER(argc);
  98861. p = sqlite3_aggregate_context(context, sizeof(*p));
  98862. type = sqlite3_value_numeric_type(argv[0]);
  98863. if( p && type!=SQLITE_NULL ){
  98864. p->cnt++;
  98865. if( type==SQLITE_INTEGER ){
  98866. i64 v = sqlite3_value_int64(argv[0]);
  98867. p->rSum += v;
  98868. if( (p->approx|p->overflow)==0 && sqlite3AddInt64(&p->iSum, v) ){
  98869. p->overflow = 1;
  98870. }
  98871. }else{
  98872. p->rSum += sqlite3_value_double(argv[0]);
  98873. p->approx = 1;
  98874. }
  98875. }
  98876. }
  98877. static void sumFinalize(sqlite3_context *context){
  98878. SumCtx *p;
  98879. p = sqlite3_aggregate_context(context, 0);
  98880. if( p && p->cnt>0 ){
  98881. if( p->overflow ){
  98882. sqlite3_result_error(context,"integer overflow",-1);
  98883. }else if( p->approx ){
  98884. sqlite3_result_double(context, p->rSum);
  98885. }else{
  98886. sqlite3_result_int64(context, p->iSum);
  98887. }
  98888. }
  98889. }
  98890. static void avgFinalize(sqlite3_context *context){
  98891. SumCtx *p;
  98892. p = sqlite3_aggregate_context(context, 0);
  98893. if( p && p->cnt>0 ){
  98894. sqlite3_result_double(context, p->rSum/(double)p->cnt);
  98895. }
  98896. }
  98897. static void totalFinalize(sqlite3_context *context){
  98898. SumCtx *p;
  98899. p = sqlite3_aggregate_context(context, 0);
  98900. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  98901. sqlite3_result_double(context, p ? p->rSum : (double)0);
  98902. }
  98903. /*
  98904. ** The following structure keeps track of state information for the
  98905. ** count() aggregate function.
  98906. */
  98907. typedef struct CountCtx CountCtx;
  98908. struct CountCtx {
  98909. i64 n;
  98910. };
  98911. /*
  98912. ** Routines to implement the count() aggregate function.
  98913. */
  98914. static void countStep(sqlite3_context *context, int argc, sqlite3_value **argv){
  98915. CountCtx *p;
  98916. p = sqlite3_aggregate_context(context, sizeof(*p));
  98917. if( (argc==0 || SQLITE_NULL!=sqlite3_value_type(argv[0])) && p ){
  98918. p->n++;
  98919. }
  98920. #ifndef SQLITE_OMIT_DEPRECATED
  98921. /* The sqlite3_aggregate_count() function is deprecated. But just to make
  98922. ** sure it still operates correctly, verify that its count agrees with our
  98923. ** internal count when using count(*) and when the total count can be
  98924. ** expressed as a 32-bit integer. */
  98925. assert( argc==1 || p==0 || p->n>0x7fffffff
  98926. || p->n==sqlite3_aggregate_count(context) );
  98927. #endif
  98928. }
  98929. static void countFinalize(sqlite3_context *context){
  98930. CountCtx *p;
  98931. p = sqlite3_aggregate_context(context, 0);
  98932. sqlite3_result_int64(context, p ? p->n : 0);
  98933. }
  98934. /*
  98935. ** Routines to implement min() and max() aggregate functions.
  98936. */
  98937. static void minmaxStep(
  98938. sqlite3_context *context,
  98939. int NotUsed,
  98940. sqlite3_value **argv
  98941. ){
  98942. Mem *pArg = (Mem *)argv[0];
  98943. Mem *pBest;
  98944. UNUSED_PARAMETER(NotUsed);
  98945. pBest = (Mem *)sqlite3_aggregate_context(context, sizeof(*pBest));
  98946. if( !pBest ) return;
  98947. if( sqlite3_value_type(argv[0])==SQLITE_NULL ){
  98948. if( pBest->flags ) sqlite3SkipAccumulatorLoad(context);
  98949. }else if( pBest->flags ){
  98950. int max;
  98951. int cmp;
  98952. CollSeq *pColl = sqlite3GetFuncCollSeq(context);
  98953. /* This step function is used for both the min() and max() aggregates,
  98954. ** the only difference between the two being that the sense of the
  98955. ** comparison is inverted. For the max() aggregate, the
  98956. ** sqlite3_user_data() function returns (void *)-1. For min() it
  98957. ** returns (void *)db, where db is the sqlite3* database pointer.
  98958. ** Therefore the next statement sets variable 'max' to 1 for the max()
  98959. ** aggregate, or 0 for min().
  98960. */
  98961. max = sqlite3_user_data(context)!=0;
  98962. cmp = sqlite3MemCompare(pBest, pArg, pColl);
  98963. if( (max && cmp<0) || (!max && cmp>0) ){
  98964. sqlite3VdbeMemCopy(pBest, pArg);
  98965. }else{
  98966. sqlite3SkipAccumulatorLoad(context);
  98967. }
  98968. }else{
  98969. pBest->db = sqlite3_context_db_handle(context);
  98970. sqlite3VdbeMemCopy(pBest, pArg);
  98971. }
  98972. }
  98973. static void minMaxFinalize(sqlite3_context *context){
  98974. sqlite3_value *pRes;
  98975. pRes = (sqlite3_value *)sqlite3_aggregate_context(context, 0);
  98976. if( pRes ){
  98977. if( pRes->flags ){
  98978. sqlite3_result_value(context, pRes);
  98979. }
  98980. sqlite3VdbeMemRelease(pRes);
  98981. }
  98982. }
  98983. /*
  98984. ** group_concat(EXPR, ?SEPARATOR?)
  98985. */
  98986. static void groupConcatStep(
  98987. sqlite3_context *context,
  98988. int argc,
  98989. sqlite3_value **argv
  98990. ){
  98991. const char *zVal;
  98992. StrAccum *pAccum;
  98993. const char *zSep;
  98994. int nVal, nSep;
  98995. assert( argc==1 || argc==2 );
  98996. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  98997. pAccum = (StrAccum*)sqlite3_aggregate_context(context, sizeof(*pAccum));
  98998. if( pAccum ){
  98999. sqlite3 *db = sqlite3_context_db_handle(context);
  99000. int firstTerm = pAccum->mxAlloc==0;
  99001. pAccum->mxAlloc = db->aLimit[SQLITE_LIMIT_LENGTH];
  99002. if( !firstTerm ){
  99003. if( argc==2 ){
  99004. zSep = (char*)sqlite3_value_text(argv[1]);
  99005. nSep = sqlite3_value_bytes(argv[1]);
  99006. }else{
  99007. zSep = ",";
  99008. nSep = 1;
  99009. }
  99010. if( nSep ) sqlite3StrAccumAppend(pAccum, zSep, nSep);
  99011. }
  99012. zVal = (char*)sqlite3_value_text(argv[0]);
  99013. nVal = sqlite3_value_bytes(argv[0]);
  99014. if( zVal ) sqlite3StrAccumAppend(pAccum, zVal, nVal);
  99015. }
  99016. }
  99017. static void groupConcatFinalize(sqlite3_context *context){
  99018. StrAccum *pAccum;
  99019. pAccum = sqlite3_aggregate_context(context, 0);
  99020. if( pAccum ){
  99021. if( pAccum->accError==STRACCUM_TOOBIG ){
  99022. sqlite3_result_error_toobig(context);
  99023. }else if( pAccum->accError==STRACCUM_NOMEM ){
  99024. sqlite3_result_error_nomem(context);
  99025. }else{
  99026. sqlite3_result_text(context, sqlite3StrAccumFinish(pAccum), -1,
  99027. sqlite3_free);
  99028. }
  99029. }
  99030. }
  99031. /*
  99032. ** This routine does per-connection function registration. Most
  99033. ** of the built-in functions above are part of the global function set.
  99034. ** This routine only deals with those that are not global.
  99035. */
  99036. SQLITE_PRIVATE void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3 *db){
  99037. int rc = sqlite3_overload_function(db, "MATCH", 2);
  99038. assert( rc==SQLITE_NOMEM || rc==SQLITE_OK );
  99039. if( rc==SQLITE_NOMEM ){
  99040. sqlite3OomFault(db);
  99041. }
  99042. }
  99043. /*
  99044. ** Set the LIKEOPT flag on the 2-argument function with the given name.
  99045. */
  99046. static void setLikeOptFlag(sqlite3 *db, const char *zName, u8 flagVal){
  99047. FuncDef *pDef;
  99048. pDef = sqlite3FindFunction(db, zName, 2, SQLITE_UTF8, 0);
  99049. if( ALWAYS(pDef) ){
  99050. pDef->funcFlags |= flagVal;
  99051. }
  99052. }
  99053. /*
  99054. ** Register the built-in LIKE and GLOB functions. The caseSensitive
  99055. ** parameter determines whether or not the LIKE operator is case
  99056. ** sensitive. GLOB is always case sensitive.
  99057. */
  99058. SQLITE_PRIVATE void sqlite3RegisterLikeFunctions(sqlite3 *db, int caseSensitive){
  99059. struct compareInfo *pInfo;
  99060. if( caseSensitive ){
  99061. pInfo = (struct compareInfo*)&likeInfoAlt;
  99062. }else{
  99063. pInfo = (struct compareInfo*)&likeInfoNorm;
  99064. }
  99065. sqlite3CreateFunc(db, "like", 2, SQLITE_UTF8, pInfo, likeFunc, 0, 0, 0);
  99066. sqlite3CreateFunc(db, "like", 3, SQLITE_UTF8, pInfo, likeFunc, 0, 0, 0);
  99067. sqlite3CreateFunc(db, "glob", 2, SQLITE_UTF8,
  99068. (struct compareInfo*)&globInfo, likeFunc, 0, 0, 0);
  99069. setLikeOptFlag(db, "glob", SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE);
  99070. setLikeOptFlag(db, "like",
  99071. caseSensitive ? (SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE) : SQLITE_FUNC_LIKE);
  99072. }
  99073. /*
  99074. ** pExpr points to an expression which implements a function. If
  99075. ** it is appropriate to apply the LIKE optimization to that function
  99076. ** then set aWc[0] through aWc[2] to the wildcard characters and
  99077. ** return TRUE. If the function is not a LIKE-style function then
  99078. ** return FALSE.
  99079. **
  99080. ** *pIsNocase is set to true if uppercase and lowercase are equivalent for
  99081. ** the function (default for LIKE). If the function makes the distinction
  99082. ** between uppercase and lowercase (as does GLOB) then *pIsNocase is set to
  99083. ** false.
  99084. */
  99085. SQLITE_PRIVATE int sqlite3IsLikeFunction(sqlite3 *db, Expr *pExpr, int *pIsNocase, char *aWc){
  99086. FuncDef *pDef;
  99087. if( pExpr->op!=TK_FUNCTION
  99088. || !pExpr->x.pList
  99089. || pExpr->x.pList->nExpr!=2
  99090. ){
  99091. return 0;
  99092. }
  99093. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  99094. pDef = sqlite3FindFunction(db, pExpr->u.zToken, 2, SQLITE_UTF8, 0);
  99095. if( NEVER(pDef==0) || (pDef->funcFlags & SQLITE_FUNC_LIKE)==0 ){
  99096. return 0;
  99097. }
  99098. /* The memcpy() statement assumes that the wildcard characters are
  99099. ** the first three statements in the compareInfo structure. The
  99100. ** asserts() that follow verify that assumption
  99101. */
  99102. memcpy(aWc, pDef->pUserData, 3);
  99103. assert( (char*)&likeInfoAlt == (char*)&likeInfoAlt.matchAll );
  99104. assert( &((char*)&likeInfoAlt)[1] == (char*)&likeInfoAlt.matchOne );
  99105. assert( &((char*)&likeInfoAlt)[2] == (char*)&likeInfoAlt.matchSet );
  99106. *pIsNocase = (pDef->funcFlags & SQLITE_FUNC_CASE)==0;
  99107. return 1;
  99108. }
  99109. /*
  99110. ** All of the FuncDef structures in the aBuiltinFunc[] array above
  99111. ** to the global function hash table. This occurs at start-time (as
  99112. ** a consequence of calling sqlite3_initialize()).
  99113. **
  99114. ** After this routine runs
  99115. */
  99116. SQLITE_PRIVATE void sqlite3RegisterBuiltinFunctions(void){
  99117. /*
  99118. ** The following array holds FuncDef structures for all of the functions
  99119. ** defined in this file.
  99120. **
  99121. ** The array cannot be constant since changes are made to the
  99122. ** FuncDef.pHash elements at start-time. The elements of this array
  99123. ** are read-only after initialization is complete.
  99124. **
  99125. ** For peak efficiency, put the most frequently used function last.
  99126. */
  99127. static FuncDef aBuiltinFunc[] = {
  99128. #ifdef SQLITE_SOUNDEX
  99129. FUNCTION(soundex, 1, 0, 0, soundexFunc ),
  99130. #endif
  99131. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  99132. VFUNCTION(load_extension, 1, 0, 0, loadExt ),
  99133. VFUNCTION(load_extension, 2, 0, 0, loadExt ),
  99134. #endif
  99135. #if SQLITE_USER_AUTHENTICATION
  99136. FUNCTION(sqlite_crypt, 2, 0, 0, sqlite3CryptFunc ),
  99137. #endif
  99138. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  99139. DFUNCTION(sqlite_compileoption_used,1, 0, 0, compileoptionusedFunc ),
  99140. DFUNCTION(sqlite_compileoption_get, 1, 0, 0, compileoptiongetFunc ),
  99141. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  99142. FUNCTION2(unlikely, 1, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  99143. FUNCTION2(likelihood, 2, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  99144. FUNCTION2(likely, 1, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  99145. FUNCTION(ltrim, 1, 1, 0, trimFunc ),
  99146. FUNCTION(ltrim, 2, 1, 0, trimFunc ),
  99147. FUNCTION(rtrim, 1, 2, 0, trimFunc ),
  99148. FUNCTION(rtrim, 2, 2, 0, trimFunc ),
  99149. FUNCTION(trim, 1, 3, 0, trimFunc ),
  99150. FUNCTION(trim, 2, 3, 0, trimFunc ),
  99151. FUNCTION(min, -1, 0, 1, minmaxFunc ),
  99152. FUNCTION(min, 0, 0, 1, 0 ),
  99153. AGGREGATE2(min, 1, 0, 1, minmaxStep, minMaxFinalize,
  99154. SQLITE_FUNC_MINMAX ),
  99155. FUNCTION(max, -1, 1, 1, minmaxFunc ),
  99156. FUNCTION(max, 0, 1, 1, 0 ),
  99157. AGGREGATE2(max, 1, 1, 1, minmaxStep, minMaxFinalize,
  99158. SQLITE_FUNC_MINMAX ),
  99159. FUNCTION2(typeof, 1, 0, 0, typeofFunc, SQLITE_FUNC_TYPEOF),
  99160. FUNCTION2(length, 1, 0, 0, lengthFunc, SQLITE_FUNC_LENGTH),
  99161. FUNCTION(instr, 2, 0, 0, instrFunc ),
  99162. FUNCTION(printf, -1, 0, 0, printfFunc ),
  99163. FUNCTION(unicode, 1, 0, 0, unicodeFunc ),
  99164. FUNCTION(char, -1, 0, 0, charFunc ),
  99165. FUNCTION(abs, 1, 0, 0, absFunc ),
  99166. #ifndef SQLITE_OMIT_FLOATING_POINT
  99167. FUNCTION(round, 1, 0, 0, roundFunc ),
  99168. FUNCTION(round, 2, 0, 0, roundFunc ),
  99169. #endif
  99170. FUNCTION(upper, 1, 0, 0, upperFunc ),
  99171. FUNCTION(lower, 1, 0, 0, lowerFunc ),
  99172. FUNCTION(hex, 1, 0, 0, hexFunc ),
  99173. FUNCTION2(ifnull, 2, 0, 0, noopFunc, SQLITE_FUNC_COALESCE),
  99174. VFUNCTION(random, 0, 0, 0, randomFunc ),
  99175. VFUNCTION(randomblob, 1, 0, 0, randomBlob ),
  99176. FUNCTION(nullif, 2, 0, 1, nullifFunc ),
  99177. DFUNCTION(sqlite_version, 0, 0, 0, versionFunc ),
  99178. DFUNCTION(sqlite_source_id, 0, 0, 0, sourceidFunc ),
  99179. FUNCTION(sqlite_log, 2, 0, 0, errlogFunc ),
  99180. FUNCTION(quote, 1, 0, 0, quoteFunc ),
  99181. VFUNCTION(last_insert_rowid, 0, 0, 0, last_insert_rowid),
  99182. VFUNCTION(changes, 0, 0, 0, changes ),
  99183. VFUNCTION(total_changes, 0, 0, 0, total_changes ),
  99184. FUNCTION(replace, 3, 0, 0, replaceFunc ),
  99185. FUNCTION(zeroblob, 1, 0, 0, zeroblobFunc ),
  99186. FUNCTION(substr, 2, 0, 0, substrFunc ),
  99187. FUNCTION(substr, 3, 0, 0, substrFunc ),
  99188. AGGREGATE(sum, 1, 0, 0, sumStep, sumFinalize ),
  99189. AGGREGATE(total, 1, 0, 0, sumStep, totalFinalize ),
  99190. AGGREGATE(avg, 1, 0, 0, sumStep, avgFinalize ),
  99191. AGGREGATE2(count, 0, 0, 0, countStep, countFinalize,
  99192. SQLITE_FUNC_COUNT ),
  99193. AGGREGATE(count, 1, 0, 0, countStep, countFinalize ),
  99194. AGGREGATE(group_concat, 1, 0, 0, groupConcatStep, groupConcatFinalize),
  99195. AGGREGATE(group_concat, 2, 0, 0, groupConcatStep, groupConcatFinalize),
  99196. LIKEFUNC(glob, 2, &globInfo, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  99197. #ifdef SQLITE_CASE_SENSITIVE_LIKE
  99198. LIKEFUNC(like, 2, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  99199. LIKEFUNC(like, 3, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  99200. #else
  99201. LIKEFUNC(like, 2, &likeInfoNorm, SQLITE_FUNC_LIKE),
  99202. LIKEFUNC(like, 3, &likeInfoNorm, SQLITE_FUNC_LIKE),
  99203. #endif
  99204. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  99205. FUNCTION(unknown, -1, 0, 0, unknownFunc ),
  99206. #endif
  99207. FUNCTION(coalesce, 1, 0, 0, 0 ),
  99208. FUNCTION(coalesce, 0, 0, 0, 0 ),
  99209. FUNCTION2(coalesce, -1, 0, 0, noopFunc, SQLITE_FUNC_COALESCE),
  99210. };
  99211. #ifndef SQLITE_OMIT_ALTERTABLE
  99212. sqlite3AlterFunctions();
  99213. #endif
  99214. #if defined(SQLITE_ENABLE_STAT3) || defined(SQLITE_ENABLE_STAT4)
  99215. sqlite3AnalyzeFunctions();
  99216. #endif
  99217. sqlite3RegisterDateTimeFunctions();
  99218. sqlite3InsertBuiltinFuncs(aBuiltinFunc, ArraySize(aBuiltinFunc));
  99219. #if 0 /* Enable to print out how the built-in functions are hashed */
  99220. {
  99221. int i;
  99222. FuncDef *p;
  99223. for(i=0; i<SQLITE_FUNC_HASH_SZ; i++){
  99224. printf("FUNC-HASH %02d:", i);
  99225. for(p=sqlite3BuiltinFunctions.a[i]; p; p=p->u.pHash){
  99226. int n = sqlite3Strlen30(p->zName);
  99227. int h = p->zName[0] + n;
  99228. printf(" %s(%d)", p->zName, h);
  99229. }
  99230. printf("\n");
  99231. }
  99232. }
  99233. #endif
  99234. }
  99235. /************** End of func.c ************************************************/
  99236. /************** Begin file fkey.c ********************************************/
  99237. /*
  99238. **
  99239. ** The author disclaims copyright to this source code. In place of
  99240. ** a legal notice, here is a blessing:
  99241. **
  99242. ** May you do good and not evil.
  99243. ** May you find forgiveness for yourself and forgive others.
  99244. ** May you share freely, never taking more than you give.
  99245. **
  99246. *************************************************************************
  99247. ** This file contains code used by the compiler to add foreign key
  99248. ** support to compiled SQL statements.
  99249. */
  99250. /* #include "sqliteInt.h" */
  99251. #ifndef SQLITE_OMIT_FOREIGN_KEY
  99252. #ifndef SQLITE_OMIT_TRIGGER
  99253. /*
  99254. ** Deferred and Immediate FKs
  99255. ** --------------------------
  99256. **
  99257. ** Foreign keys in SQLite come in two flavours: deferred and immediate.
  99258. ** If an immediate foreign key constraint is violated,
  99259. ** SQLITE_CONSTRAINT_FOREIGNKEY is returned and the current
  99260. ** statement transaction rolled back. If a
  99261. ** deferred foreign key constraint is violated, no action is taken
  99262. ** immediately. However if the application attempts to commit the
  99263. ** transaction before fixing the constraint violation, the attempt fails.
  99264. **
  99265. ** Deferred constraints are implemented using a simple counter associated
  99266. ** with the database handle. The counter is set to zero each time a
  99267. ** database transaction is opened. Each time a statement is executed
  99268. ** that causes a foreign key violation, the counter is incremented. Each
  99269. ** time a statement is executed that removes an existing violation from
  99270. ** the database, the counter is decremented. When the transaction is
  99271. ** committed, the commit fails if the current value of the counter is
  99272. ** greater than zero. This scheme has two big drawbacks:
  99273. **
  99274. ** * When a commit fails due to a deferred foreign key constraint,
  99275. ** there is no way to tell which foreign constraint is not satisfied,
  99276. ** or which row it is not satisfied for.
  99277. **
  99278. ** * If the database contains foreign key violations when the
  99279. ** transaction is opened, this may cause the mechanism to malfunction.
  99280. **
  99281. ** Despite these problems, this approach is adopted as it seems simpler
  99282. ** than the alternatives.
  99283. **
  99284. ** INSERT operations:
  99285. **
  99286. ** I.1) For each FK for which the table is the child table, search
  99287. ** the parent table for a match. If none is found increment the
  99288. ** constraint counter.
  99289. **
  99290. ** I.2) For each FK for which the table is the parent table,
  99291. ** search the child table for rows that correspond to the new
  99292. ** row in the parent table. Decrement the counter for each row
  99293. ** found (as the constraint is now satisfied).
  99294. **
  99295. ** DELETE operations:
  99296. **
  99297. ** D.1) For each FK for which the table is the child table,
  99298. ** search the parent table for a row that corresponds to the
  99299. ** deleted row in the child table. If such a row is not found,
  99300. ** decrement the counter.
  99301. **
  99302. ** D.2) For each FK for which the table is the parent table, search
  99303. ** the child table for rows that correspond to the deleted row
  99304. ** in the parent table. For each found increment the counter.
  99305. **
  99306. ** UPDATE operations:
  99307. **
  99308. ** An UPDATE command requires that all 4 steps above are taken, but only
  99309. ** for FK constraints for which the affected columns are actually
  99310. ** modified (values must be compared at runtime).
  99311. **
  99312. ** Note that I.1 and D.1 are very similar operations, as are I.2 and D.2.
  99313. ** This simplifies the implementation a bit.
  99314. **
  99315. ** For the purposes of immediate FK constraints, the OR REPLACE conflict
  99316. ** resolution is considered to delete rows before the new row is inserted.
  99317. ** If a delete caused by OR REPLACE violates an FK constraint, an exception
  99318. ** is thrown, even if the FK constraint would be satisfied after the new
  99319. ** row is inserted.
  99320. **
  99321. ** Immediate constraints are usually handled similarly. The only difference
  99322. ** is that the counter used is stored as part of each individual statement
  99323. ** object (struct Vdbe). If, after the statement has run, its immediate
  99324. ** constraint counter is greater than zero,
  99325. ** it returns SQLITE_CONSTRAINT_FOREIGNKEY
  99326. ** and the statement transaction is rolled back. An exception is an INSERT
  99327. ** statement that inserts a single row only (no triggers). In this case,
  99328. ** instead of using a counter, an exception is thrown immediately if the
  99329. ** INSERT violates a foreign key constraint. This is necessary as such
  99330. ** an INSERT does not open a statement transaction.
  99331. **
  99332. ** TODO: How should dropping a table be handled? How should renaming a
  99333. ** table be handled?
  99334. **
  99335. **
  99336. ** Query API Notes
  99337. ** ---------------
  99338. **
  99339. ** Before coding an UPDATE or DELETE row operation, the code-generator
  99340. ** for those two operations needs to know whether or not the operation
  99341. ** requires any FK processing and, if so, which columns of the original
  99342. ** row are required by the FK processing VDBE code (i.e. if FKs were
  99343. ** implemented using triggers, which of the old.* columns would be
  99344. ** accessed). No information is required by the code-generator before
  99345. ** coding an INSERT operation. The functions used by the UPDATE/DELETE
  99346. ** generation code to query for this information are:
  99347. **
  99348. ** sqlite3FkRequired() - Test to see if FK processing is required.
  99349. ** sqlite3FkOldmask() - Query for the set of required old.* columns.
  99350. **
  99351. **
  99352. ** Externally accessible module functions
  99353. ** --------------------------------------
  99354. **
  99355. ** sqlite3FkCheck() - Check for foreign key violations.
  99356. ** sqlite3FkActions() - Code triggers for ON UPDATE/ON DELETE actions.
  99357. ** sqlite3FkDelete() - Delete an FKey structure.
  99358. */
  99359. /*
  99360. ** VDBE Calling Convention
  99361. ** -----------------------
  99362. **
  99363. ** Example:
  99364. **
  99365. ** For the following INSERT statement:
  99366. **
  99367. ** CREATE TABLE t1(a, b INTEGER PRIMARY KEY, c);
  99368. ** INSERT INTO t1 VALUES(1, 2, 3.1);
  99369. **
  99370. ** Register (x): 2 (type integer)
  99371. ** Register (x+1): 1 (type integer)
  99372. ** Register (x+2): NULL (type NULL)
  99373. ** Register (x+3): 3.1 (type real)
  99374. */
  99375. /*
  99376. ** A foreign key constraint requires that the key columns in the parent
  99377. ** table are collectively subject to a UNIQUE or PRIMARY KEY constraint.
  99378. ** Given that pParent is the parent table for foreign key constraint pFKey,
  99379. ** search the schema for a unique index on the parent key columns.
  99380. **
  99381. ** If successful, zero is returned. If the parent key is an INTEGER PRIMARY
  99382. ** KEY column, then output variable *ppIdx is set to NULL. Otherwise, *ppIdx
  99383. ** is set to point to the unique index.
  99384. **
  99385. ** If the parent key consists of a single column (the foreign key constraint
  99386. ** is not a composite foreign key), output variable *paiCol is set to NULL.
  99387. ** Otherwise, it is set to point to an allocated array of size N, where
  99388. ** N is the number of columns in the parent key. The first element of the
  99389. ** array is the index of the child table column that is mapped by the FK
  99390. ** constraint to the parent table column stored in the left-most column
  99391. ** of index *ppIdx. The second element of the array is the index of the
  99392. ** child table column that corresponds to the second left-most column of
  99393. ** *ppIdx, and so on.
  99394. **
  99395. ** If the required index cannot be found, either because:
  99396. **
  99397. ** 1) The named parent key columns do not exist, or
  99398. **
  99399. ** 2) The named parent key columns do exist, but are not subject to a
  99400. ** UNIQUE or PRIMARY KEY constraint, or
  99401. **
  99402. ** 3) No parent key columns were provided explicitly as part of the
  99403. ** foreign key definition, and the parent table does not have a
  99404. ** PRIMARY KEY, or
  99405. **
  99406. ** 4) No parent key columns were provided explicitly as part of the
  99407. ** foreign key definition, and the PRIMARY KEY of the parent table
  99408. ** consists of a different number of columns to the child key in
  99409. ** the child table.
  99410. **
  99411. ** then non-zero is returned, and a "foreign key mismatch" error loaded
  99412. ** into pParse. If an OOM error occurs, non-zero is returned and the
  99413. ** pParse->db->mallocFailed flag is set.
  99414. */
  99415. SQLITE_PRIVATE int sqlite3FkLocateIndex(
  99416. Parse *pParse, /* Parse context to store any error in */
  99417. Table *pParent, /* Parent table of FK constraint pFKey */
  99418. FKey *pFKey, /* Foreign key to find index for */
  99419. Index **ppIdx, /* OUT: Unique index on parent table */
  99420. int **paiCol /* OUT: Map of index columns in pFKey */
  99421. ){
  99422. Index *pIdx = 0; /* Value to return via *ppIdx */
  99423. int *aiCol = 0; /* Value to return via *paiCol */
  99424. int nCol = pFKey->nCol; /* Number of columns in parent key */
  99425. char *zKey = pFKey->aCol[0].zCol; /* Name of left-most parent key column */
  99426. /* The caller is responsible for zeroing output parameters. */
  99427. assert( ppIdx && *ppIdx==0 );
  99428. assert( !paiCol || *paiCol==0 );
  99429. assert( pParse );
  99430. /* If this is a non-composite (single column) foreign key, check if it
  99431. ** maps to the INTEGER PRIMARY KEY of table pParent. If so, leave *ppIdx
  99432. ** and *paiCol set to zero and return early.
  99433. **
  99434. ** Otherwise, for a composite foreign key (more than one column), allocate
  99435. ** space for the aiCol array (returned via output parameter *paiCol).
  99436. ** Non-composite foreign keys do not require the aiCol array.
  99437. */
  99438. if( nCol==1 ){
  99439. /* The FK maps to the IPK if any of the following are true:
  99440. **
  99441. ** 1) There is an INTEGER PRIMARY KEY column and the FK is implicitly
  99442. ** mapped to the primary key of table pParent, or
  99443. ** 2) The FK is explicitly mapped to a column declared as INTEGER
  99444. ** PRIMARY KEY.
  99445. */
  99446. if( pParent->iPKey>=0 ){
  99447. if( !zKey ) return 0;
  99448. if( !sqlite3StrICmp(pParent->aCol[pParent->iPKey].zName, zKey) ) return 0;
  99449. }
  99450. }else if( paiCol ){
  99451. assert( nCol>1 );
  99452. aiCol = (int *)sqlite3DbMallocRawNN(pParse->db, nCol*sizeof(int));
  99453. if( !aiCol ) return 1;
  99454. *paiCol = aiCol;
  99455. }
  99456. for(pIdx=pParent->pIndex; pIdx; pIdx=pIdx->pNext){
  99457. if( pIdx->nKeyCol==nCol && IsUniqueIndex(pIdx) ){
  99458. /* pIdx is a UNIQUE index (or a PRIMARY KEY) and has the right number
  99459. ** of columns. If each indexed column corresponds to a foreign key
  99460. ** column of pFKey, then this index is a winner. */
  99461. if( zKey==0 ){
  99462. /* If zKey is NULL, then this foreign key is implicitly mapped to
  99463. ** the PRIMARY KEY of table pParent. The PRIMARY KEY index may be
  99464. ** identified by the test. */
  99465. if( IsPrimaryKeyIndex(pIdx) ){
  99466. if( aiCol ){
  99467. int i;
  99468. for(i=0; i<nCol; i++) aiCol[i] = pFKey->aCol[i].iFrom;
  99469. }
  99470. break;
  99471. }
  99472. }else{
  99473. /* If zKey is non-NULL, then this foreign key was declared to
  99474. ** map to an explicit list of columns in table pParent. Check if this
  99475. ** index matches those columns. Also, check that the index uses
  99476. ** the default collation sequences for each column. */
  99477. int i, j;
  99478. for(i=0; i<nCol; i++){
  99479. i16 iCol = pIdx->aiColumn[i]; /* Index of column in parent tbl */
  99480. const char *zDfltColl; /* Def. collation for column */
  99481. char *zIdxCol; /* Name of indexed column */
  99482. if( iCol<0 ) break; /* No foreign keys against expression indexes */
  99483. /* If the index uses a collation sequence that is different from
  99484. ** the default collation sequence for the column, this index is
  99485. ** unusable. Bail out early in this case. */
  99486. zDfltColl = pParent->aCol[iCol].zColl;
  99487. if( !zDfltColl ) zDfltColl = sqlite3StrBINARY;
  99488. if( sqlite3StrICmp(pIdx->azColl[i], zDfltColl) ) break;
  99489. zIdxCol = pParent->aCol[iCol].zName;
  99490. for(j=0; j<nCol; j++){
  99491. if( sqlite3StrICmp(pFKey->aCol[j].zCol, zIdxCol)==0 ){
  99492. if( aiCol ) aiCol[i] = pFKey->aCol[j].iFrom;
  99493. break;
  99494. }
  99495. }
  99496. if( j==nCol ) break;
  99497. }
  99498. if( i==nCol ) break; /* pIdx is usable */
  99499. }
  99500. }
  99501. }
  99502. if( !pIdx ){
  99503. if( !pParse->disableTriggers ){
  99504. sqlite3ErrorMsg(pParse,
  99505. "foreign key mismatch - \"%w\" referencing \"%w\"",
  99506. pFKey->pFrom->zName, pFKey->zTo);
  99507. }
  99508. sqlite3DbFree(pParse->db, aiCol);
  99509. return 1;
  99510. }
  99511. *ppIdx = pIdx;
  99512. return 0;
  99513. }
  99514. /*
  99515. ** This function is called when a row is inserted into or deleted from the
  99516. ** child table of foreign key constraint pFKey. If an SQL UPDATE is executed
  99517. ** on the child table of pFKey, this function is invoked twice for each row
  99518. ** affected - once to "delete" the old row, and then again to "insert" the
  99519. ** new row.
  99520. **
  99521. ** Each time it is called, this function generates VDBE code to locate the
  99522. ** row in the parent table that corresponds to the row being inserted into
  99523. ** or deleted from the child table. If the parent row can be found, no
  99524. ** special action is taken. Otherwise, if the parent row can *not* be
  99525. ** found in the parent table:
  99526. **
  99527. ** Operation | FK type | Action taken
  99528. ** --------------------------------------------------------------------------
  99529. ** INSERT immediate Increment the "immediate constraint counter".
  99530. **
  99531. ** DELETE immediate Decrement the "immediate constraint counter".
  99532. **
  99533. ** INSERT deferred Increment the "deferred constraint counter".
  99534. **
  99535. ** DELETE deferred Decrement the "deferred constraint counter".
  99536. **
  99537. ** These operations are identified in the comment at the top of this file
  99538. ** (fkey.c) as "I.1" and "D.1".
  99539. */
  99540. static void fkLookupParent(
  99541. Parse *pParse, /* Parse context */
  99542. int iDb, /* Index of database housing pTab */
  99543. Table *pTab, /* Parent table of FK pFKey */
  99544. Index *pIdx, /* Unique index on parent key columns in pTab */
  99545. FKey *pFKey, /* Foreign key constraint */
  99546. int *aiCol, /* Map from parent key columns to child table columns */
  99547. int regData, /* Address of array containing child table row */
  99548. int nIncr, /* Increment constraint counter by this */
  99549. int isIgnore /* If true, pretend pTab contains all NULL values */
  99550. ){
  99551. int i; /* Iterator variable */
  99552. Vdbe *v = sqlite3GetVdbe(pParse); /* Vdbe to add code to */
  99553. int iCur = pParse->nTab - 1; /* Cursor number to use */
  99554. int iOk = sqlite3VdbeMakeLabel(v); /* jump here if parent key found */
  99555. /* If nIncr is less than zero, then check at runtime if there are any
  99556. ** outstanding constraints to resolve. If there are not, there is no need
  99557. ** to check if deleting this row resolves any outstanding violations.
  99558. **
  99559. ** Check if any of the key columns in the child table row are NULL. If
  99560. ** any are, then the constraint is considered satisfied. No need to
  99561. ** search for a matching row in the parent table. */
  99562. if( nIncr<0 ){
  99563. sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, iOk);
  99564. VdbeCoverage(v);
  99565. }
  99566. for(i=0; i<pFKey->nCol; i++){
  99567. int iReg = aiCol[i] + regData + 1;
  99568. sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iOk); VdbeCoverage(v);
  99569. }
  99570. if( isIgnore==0 ){
  99571. if( pIdx==0 ){
  99572. /* If pIdx is NULL, then the parent key is the INTEGER PRIMARY KEY
  99573. ** column of the parent table (table pTab). */
  99574. int iMustBeInt; /* Address of MustBeInt instruction */
  99575. int regTemp = sqlite3GetTempReg(pParse);
  99576. /* Invoke MustBeInt to coerce the child key value to an integer (i.e.
  99577. ** apply the affinity of the parent key). If this fails, then there
  99578. ** is no matching parent key. Before using MustBeInt, make a copy of
  99579. ** the value. Otherwise, the value inserted into the child key column
  99580. ** will have INTEGER affinity applied to it, which may not be correct. */
  99581. sqlite3VdbeAddOp2(v, OP_SCopy, aiCol[0]+1+regData, regTemp);
  99582. iMustBeInt = sqlite3VdbeAddOp2(v, OP_MustBeInt, regTemp, 0);
  99583. VdbeCoverage(v);
  99584. /* If the parent table is the same as the child table, and we are about
  99585. ** to increment the constraint-counter (i.e. this is an INSERT operation),
  99586. ** then check if the row being inserted matches itself. If so, do not
  99587. ** increment the constraint-counter. */
  99588. if( pTab==pFKey->pFrom && nIncr==1 ){
  99589. sqlite3VdbeAddOp3(v, OP_Eq, regData, iOk, regTemp); VdbeCoverage(v);
  99590. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  99591. }
  99592. sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenRead);
  99593. sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, regTemp); VdbeCoverage(v);
  99594. sqlite3VdbeGoto(v, iOk);
  99595. sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
  99596. sqlite3VdbeJumpHere(v, iMustBeInt);
  99597. sqlite3ReleaseTempReg(pParse, regTemp);
  99598. }else{
  99599. int nCol = pFKey->nCol;
  99600. int regTemp = sqlite3GetTempRange(pParse, nCol);
  99601. int regRec = sqlite3GetTempReg(pParse);
  99602. sqlite3VdbeAddOp3(v, OP_OpenRead, iCur, pIdx->tnum, iDb);
  99603. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  99604. for(i=0; i<nCol; i++){
  99605. sqlite3VdbeAddOp2(v, OP_Copy, aiCol[i]+1+regData, regTemp+i);
  99606. }
  99607. /* If the parent table is the same as the child table, and we are about
  99608. ** to increment the constraint-counter (i.e. this is an INSERT operation),
  99609. ** then check if the row being inserted matches itself. If so, do not
  99610. ** increment the constraint-counter.
  99611. **
  99612. ** If any of the parent-key values are NULL, then the row cannot match
  99613. ** itself. So set JUMPIFNULL to make sure we do the OP_Found if any
  99614. ** of the parent-key values are NULL (at this point it is known that
  99615. ** none of the child key values are).
  99616. */
  99617. if( pTab==pFKey->pFrom && nIncr==1 ){
  99618. int iJump = sqlite3VdbeCurrentAddr(v) + nCol + 1;
  99619. for(i=0; i<nCol; i++){
  99620. int iChild = aiCol[i]+1+regData;
  99621. int iParent = pIdx->aiColumn[i]+1+regData;
  99622. assert( pIdx->aiColumn[i]>=0 );
  99623. assert( aiCol[i]!=pTab->iPKey );
  99624. if( pIdx->aiColumn[i]==pTab->iPKey ){
  99625. /* The parent key is a composite key that includes the IPK column */
  99626. iParent = regData;
  99627. }
  99628. sqlite3VdbeAddOp3(v, OP_Ne, iChild, iJump, iParent); VdbeCoverage(v);
  99629. sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
  99630. }
  99631. sqlite3VdbeGoto(v, iOk);
  99632. }
  99633. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTemp, nCol, regRec,
  99634. sqlite3IndexAffinityStr(pParse->db,pIdx), nCol);
  99635. sqlite3VdbeAddOp4Int(v, OP_Found, iCur, iOk, regRec, 0); VdbeCoverage(v);
  99636. sqlite3ReleaseTempReg(pParse, regRec);
  99637. sqlite3ReleaseTempRange(pParse, regTemp, nCol);
  99638. }
  99639. }
  99640. if( !pFKey->isDeferred && !(pParse->db->flags & SQLITE_DeferFKs)
  99641. && !pParse->pToplevel
  99642. && !pParse->isMultiWrite
  99643. ){
  99644. /* Special case: If this is an INSERT statement that will insert exactly
  99645. ** one row into the table, raise a constraint immediately instead of
  99646. ** incrementing a counter. This is necessary as the VM code is being
  99647. ** generated for will not open a statement transaction. */
  99648. assert( nIncr==1 );
  99649. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
  99650. OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
  99651. }else{
  99652. if( nIncr>0 && pFKey->isDeferred==0 ){
  99653. sqlite3MayAbort(pParse);
  99654. }
  99655. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
  99656. }
  99657. sqlite3VdbeResolveLabel(v, iOk);
  99658. sqlite3VdbeAddOp1(v, OP_Close, iCur);
  99659. }
  99660. /*
  99661. ** Return an Expr object that refers to a memory register corresponding
  99662. ** to column iCol of table pTab.
  99663. **
  99664. ** regBase is the first of an array of register that contains the data
  99665. ** for pTab. regBase itself holds the rowid. regBase+1 holds the first
  99666. ** column. regBase+2 holds the second column, and so forth.
  99667. */
  99668. static Expr *exprTableRegister(
  99669. Parse *pParse, /* Parsing and code generating context */
  99670. Table *pTab, /* The table whose content is at r[regBase]... */
  99671. int regBase, /* Contents of table pTab */
  99672. i16 iCol /* Which column of pTab is desired */
  99673. ){
  99674. Expr *pExpr;
  99675. Column *pCol;
  99676. const char *zColl;
  99677. sqlite3 *db = pParse->db;
  99678. pExpr = sqlite3Expr(db, TK_REGISTER, 0);
  99679. if( pExpr ){
  99680. if( iCol>=0 && iCol!=pTab->iPKey ){
  99681. pCol = &pTab->aCol[iCol];
  99682. pExpr->iTable = regBase + iCol + 1;
  99683. pExpr->affinity = pCol->affinity;
  99684. zColl = pCol->zColl;
  99685. if( zColl==0 ) zColl = db->pDfltColl->zName;
  99686. pExpr = sqlite3ExprAddCollateString(pParse, pExpr, zColl);
  99687. }else{
  99688. pExpr->iTable = regBase;
  99689. pExpr->affinity = SQLITE_AFF_INTEGER;
  99690. }
  99691. }
  99692. return pExpr;
  99693. }
  99694. /*
  99695. ** Return an Expr object that refers to column iCol of table pTab which
  99696. ** has cursor iCur.
  99697. */
  99698. static Expr *exprTableColumn(
  99699. sqlite3 *db, /* The database connection */
  99700. Table *pTab, /* The table whose column is desired */
  99701. int iCursor, /* The open cursor on the table */
  99702. i16 iCol /* The column that is wanted */
  99703. ){
  99704. Expr *pExpr = sqlite3Expr(db, TK_COLUMN, 0);
  99705. if( pExpr ){
  99706. pExpr->pTab = pTab;
  99707. pExpr->iTable = iCursor;
  99708. pExpr->iColumn = iCol;
  99709. }
  99710. return pExpr;
  99711. }
  99712. /*
  99713. ** This function is called to generate code executed when a row is deleted
  99714. ** from the parent table of foreign key constraint pFKey and, if pFKey is
  99715. ** deferred, when a row is inserted into the same table. When generating
  99716. ** code for an SQL UPDATE operation, this function may be called twice -
  99717. ** once to "delete" the old row and once to "insert" the new row.
  99718. **
  99719. ** Parameter nIncr is passed -1 when inserting a row (as this may decrease
  99720. ** the number of FK violations in the db) or +1 when deleting one (as this
  99721. ** may increase the number of FK constraint problems).
  99722. **
  99723. ** The code generated by this function scans through the rows in the child
  99724. ** table that correspond to the parent table row being deleted or inserted.
  99725. ** For each child row found, one of the following actions is taken:
  99726. **
  99727. ** Operation | FK type | Action taken
  99728. ** --------------------------------------------------------------------------
  99729. ** DELETE immediate Increment the "immediate constraint counter".
  99730. ** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
  99731. ** throw a "FOREIGN KEY constraint failed" exception.
  99732. **
  99733. ** INSERT immediate Decrement the "immediate constraint counter".
  99734. **
  99735. ** DELETE deferred Increment the "deferred constraint counter".
  99736. ** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
  99737. ** throw a "FOREIGN KEY constraint failed" exception.
  99738. **
  99739. ** INSERT deferred Decrement the "deferred constraint counter".
  99740. **
  99741. ** These operations are identified in the comment at the top of this file
  99742. ** (fkey.c) as "I.2" and "D.2".
  99743. */
  99744. static void fkScanChildren(
  99745. Parse *pParse, /* Parse context */
  99746. SrcList *pSrc, /* The child table to be scanned */
  99747. Table *pTab, /* The parent table */
  99748. Index *pIdx, /* Index on parent covering the foreign key */
  99749. FKey *pFKey, /* The foreign key linking pSrc to pTab */
  99750. int *aiCol, /* Map from pIdx cols to child table cols */
  99751. int regData, /* Parent row data starts here */
  99752. int nIncr /* Amount to increment deferred counter by */
  99753. ){
  99754. sqlite3 *db = pParse->db; /* Database handle */
  99755. int i; /* Iterator variable */
  99756. Expr *pWhere = 0; /* WHERE clause to scan with */
  99757. NameContext sNameContext; /* Context used to resolve WHERE clause */
  99758. WhereInfo *pWInfo; /* Context used by sqlite3WhereXXX() */
  99759. int iFkIfZero = 0; /* Address of OP_FkIfZero */
  99760. Vdbe *v = sqlite3GetVdbe(pParse);
  99761. assert( pIdx==0 || pIdx->pTable==pTab );
  99762. assert( pIdx==0 || pIdx->nKeyCol==pFKey->nCol );
  99763. assert( pIdx!=0 || pFKey->nCol==1 );
  99764. assert( pIdx!=0 || HasRowid(pTab) );
  99765. if( nIncr<0 ){
  99766. iFkIfZero = sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, 0);
  99767. VdbeCoverage(v);
  99768. }
  99769. /* Create an Expr object representing an SQL expression like:
  99770. **
  99771. ** <parent-key1> = <child-key1> AND <parent-key2> = <child-key2> ...
  99772. **
  99773. ** The collation sequence used for the comparison should be that of
  99774. ** the parent key columns. The affinity of the parent key column should
  99775. ** be applied to each child key value before the comparison takes place.
  99776. */
  99777. for(i=0; i<pFKey->nCol; i++){
  99778. Expr *pLeft; /* Value from parent table row */
  99779. Expr *pRight; /* Column ref to child table */
  99780. Expr *pEq; /* Expression (pLeft = pRight) */
  99781. i16 iCol; /* Index of column in child table */
  99782. const char *zCol; /* Name of column in child table */
  99783. iCol = pIdx ? pIdx->aiColumn[i] : -1;
  99784. pLeft = exprTableRegister(pParse, pTab, regData, iCol);
  99785. iCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
  99786. assert( iCol>=0 );
  99787. zCol = pFKey->pFrom->aCol[iCol].zName;
  99788. pRight = sqlite3Expr(db, TK_ID, zCol);
  99789. pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight, 0);
  99790. pWhere = sqlite3ExprAnd(db, pWhere, pEq);
  99791. }
  99792. /* If the child table is the same as the parent table, then add terms
  99793. ** to the WHERE clause that prevent this entry from being scanned.
  99794. ** The added WHERE clause terms are like this:
  99795. **
  99796. ** $current_rowid!=rowid
  99797. ** NOT( $current_a==a AND $current_b==b AND ... )
  99798. **
  99799. ** The first form is used for rowid tables. The second form is used
  99800. ** for WITHOUT ROWID tables. In the second form, the primary key is
  99801. ** (a,b,...)
  99802. */
  99803. if( pTab==pFKey->pFrom && nIncr>0 ){
  99804. Expr *pNe; /* Expression (pLeft != pRight) */
  99805. Expr *pLeft; /* Value from parent table row */
  99806. Expr *pRight; /* Column ref to child table */
  99807. if( HasRowid(pTab) ){
  99808. pLeft = exprTableRegister(pParse, pTab, regData, -1);
  99809. pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, -1);
  99810. pNe = sqlite3PExpr(pParse, TK_NE, pLeft, pRight, 0);
  99811. }else{
  99812. Expr *pEq, *pAll = 0;
  99813. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  99814. assert( pIdx!=0 );
  99815. for(i=0; i<pPk->nKeyCol; i++){
  99816. i16 iCol = pIdx->aiColumn[i];
  99817. assert( iCol>=0 );
  99818. pLeft = exprTableRegister(pParse, pTab, regData, iCol);
  99819. pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, iCol);
  99820. pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight, 0);
  99821. pAll = sqlite3ExprAnd(db, pAll, pEq);
  99822. }
  99823. pNe = sqlite3PExpr(pParse, TK_NOT, pAll, 0, 0);
  99824. }
  99825. pWhere = sqlite3ExprAnd(db, pWhere, pNe);
  99826. }
  99827. /* Resolve the references in the WHERE clause. */
  99828. memset(&sNameContext, 0, sizeof(NameContext));
  99829. sNameContext.pSrcList = pSrc;
  99830. sNameContext.pParse = pParse;
  99831. sqlite3ResolveExprNames(&sNameContext, pWhere);
  99832. /* Create VDBE to loop through the entries in pSrc that match the WHERE
  99833. ** clause. For each row found, increment either the deferred or immediate
  99834. ** foreign key constraint counter. */
  99835. pWInfo = sqlite3WhereBegin(pParse, pSrc, pWhere, 0, 0, 0, 0);
  99836. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
  99837. if( pWInfo ){
  99838. sqlite3WhereEnd(pWInfo);
  99839. }
  99840. /* Clean up the WHERE clause constructed above. */
  99841. sqlite3ExprDelete(db, pWhere);
  99842. if( iFkIfZero ){
  99843. sqlite3VdbeJumpHere(v, iFkIfZero);
  99844. }
  99845. }
  99846. /*
  99847. ** This function returns a linked list of FKey objects (connected by
  99848. ** FKey.pNextTo) holding all children of table pTab. For example,
  99849. ** given the following schema:
  99850. **
  99851. ** CREATE TABLE t1(a PRIMARY KEY);
  99852. ** CREATE TABLE t2(b REFERENCES t1(a);
  99853. **
  99854. ** Calling this function with table "t1" as an argument returns a pointer
  99855. ** to the FKey structure representing the foreign key constraint on table
  99856. ** "t2". Calling this function with "t2" as the argument would return a
  99857. ** NULL pointer (as there are no FK constraints for which t2 is the parent
  99858. ** table).
  99859. */
  99860. SQLITE_PRIVATE FKey *sqlite3FkReferences(Table *pTab){
  99861. return (FKey *)sqlite3HashFind(&pTab->pSchema->fkeyHash, pTab->zName);
  99862. }
  99863. /*
  99864. ** The second argument is a Trigger structure allocated by the
  99865. ** fkActionTrigger() routine. This function deletes the Trigger structure
  99866. ** and all of its sub-components.
  99867. **
  99868. ** The Trigger structure or any of its sub-components may be allocated from
  99869. ** the lookaside buffer belonging to database handle dbMem.
  99870. */
  99871. static void fkTriggerDelete(sqlite3 *dbMem, Trigger *p){
  99872. if( p ){
  99873. TriggerStep *pStep = p->step_list;
  99874. sqlite3ExprDelete(dbMem, pStep->pWhere);
  99875. sqlite3ExprListDelete(dbMem, pStep->pExprList);
  99876. sqlite3SelectDelete(dbMem, pStep->pSelect);
  99877. sqlite3ExprDelete(dbMem, p->pWhen);
  99878. sqlite3DbFree(dbMem, p);
  99879. }
  99880. }
  99881. /*
  99882. ** This function is called to generate code that runs when table pTab is
  99883. ** being dropped from the database. The SrcList passed as the second argument
  99884. ** to this function contains a single entry guaranteed to resolve to
  99885. ** table pTab.
  99886. **
  99887. ** Normally, no code is required. However, if either
  99888. **
  99889. ** (a) The table is the parent table of a FK constraint, or
  99890. ** (b) The table is the child table of a deferred FK constraint and it is
  99891. ** determined at runtime that there are outstanding deferred FK
  99892. ** constraint violations in the database,
  99893. **
  99894. ** then the equivalent of "DELETE FROM <tbl>" is executed before dropping
  99895. ** the table from the database. Triggers are disabled while running this
  99896. ** DELETE, but foreign key actions are not.
  99897. */
  99898. SQLITE_PRIVATE void sqlite3FkDropTable(Parse *pParse, SrcList *pName, Table *pTab){
  99899. sqlite3 *db = pParse->db;
  99900. if( (db->flags&SQLITE_ForeignKeys) && !IsVirtual(pTab) && !pTab->pSelect ){
  99901. int iSkip = 0;
  99902. Vdbe *v = sqlite3GetVdbe(pParse);
  99903. assert( v ); /* VDBE has already been allocated */
  99904. if( sqlite3FkReferences(pTab)==0 ){
  99905. /* Search for a deferred foreign key constraint for which this table
  99906. ** is the child table. If one cannot be found, return without
  99907. ** generating any VDBE code. If one can be found, then jump over
  99908. ** the entire DELETE if there are no outstanding deferred constraints
  99909. ** when this statement is run. */
  99910. FKey *p;
  99911. for(p=pTab->pFKey; p; p=p->pNextFrom){
  99912. if( p->isDeferred || (db->flags & SQLITE_DeferFKs) ) break;
  99913. }
  99914. if( !p ) return;
  99915. iSkip = sqlite3VdbeMakeLabel(v);
  99916. sqlite3VdbeAddOp2(v, OP_FkIfZero, 1, iSkip); VdbeCoverage(v);
  99917. }
  99918. pParse->disableTriggers = 1;
  99919. sqlite3DeleteFrom(pParse, sqlite3SrcListDup(db, pName, 0), 0);
  99920. pParse->disableTriggers = 0;
  99921. /* If the DELETE has generated immediate foreign key constraint
  99922. ** violations, halt the VDBE and return an error at this point, before
  99923. ** any modifications to the schema are made. This is because statement
  99924. ** transactions are not able to rollback schema changes.
  99925. **
  99926. ** If the SQLITE_DeferFKs flag is set, then this is not required, as
  99927. ** the statement transaction will not be rolled back even if FK
  99928. ** constraints are violated.
  99929. */
  99930. if( (db->flags & SQLITE_DeferFKs)==0 ){
  99931. sqlite3VdbeAddOp2(v, OP_FkIfZero, 0, sqlite3VdbeCurrentAddr(v)+2);
  99932. VdbeCoverage(v);
  99933. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
  99934. OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
  99935. }
  99936. if( iSkip ){
  99937. sqlite3VdbeResolveLabel(v, iSkip);
  99938. }
  99939. }
  99940. }
  99941. /*
  99942. ** The second argument points to an FKey object representing a foreign key
  99943. ** for which pTab is the child table. An UPDATE statement against pTab
  99944. ** is currently being processed. For each column of the table that is
  99945. ** actually updated, the corresponding element in the aChange[] array
  99946. ** is zero or greater (if a column is unmodified the corresponding element
  99947. ** is set to -1). If the rowid column is modified by the UPDATE statement
  99948. ** the bChngRowid argument is non-zero.
  99949. **
  99950. ** This function returns true if any of the columns that are part of the
  99951. ** child key for FK constraint *p are modified.
  99952. */
  99953. static int fkChildIsModified(
  99954. Table *pTab, /* Table being updated */
  99955. FKey *p, /* Foreign key for which pTab is the child */
  99956. int *aChange, /* Array indicating modified columns */
  99957. int bChngRowid /* True if rowid is modified by this update */
  99958. ){
  99959. int i;
  99960. for(i=0; i<p->nCol; i++){
  99961. int iChildKey = p->aCol[i].iFrom;
  99962. if( aChange[iChildKey]>=0 ) return 1;
  99963. if( iChildKey==pTab->iPKey && bChngRowid ) return 1;
  99964. }
  99965. return 0;
  99966. }
  99967. /*
  99968. ** The second argument points to an FKey object representing a foreign key
  99969. ** for which pTab is the parent table. An UPDATE statement against pTab
  99970. ** is currently being processed. For each column of the table that is
  99971. ** actually updated, the corresponding element in the aChange[] array
  99972. ** is zero or greater (if a column is unmodified the corresponding element
  99973. ** is set to -1). If the rowid column is modified by the UPDATE statement
  99974. ** the bChngRowid argument is non-zero.
  99975. **
  99976. ** This function returns true if any of the columns that are part of the
  99977. ** parent key for FK constraint *p are modified.
  99978. */
  99979. static int fkParentIsModified(
  99980. Table *pTab,
  99981. FKey *p,
  99982. int *aChange,
  99983. int bChngRowid
  99984. ){
  99985. int i;
  99986. for(i=0; i<p->nCol; i++){
  99987. char *zKey = p->aCol[i].zCol;
  99988. int iKey;
  99989. for(iKey=0; iKey<pTab->nCol; iKey++){
  99990. if( aChange[iKey]>=0 || (iKey==pTab->iPKey && bChngRowid) ){
  99991. Column *pCol = &pTab->aCol[iKey];
  99992. if( zKey ){
  99993. if( 0==sqlite3StrICmp(pCol->zName, zKey) ) return 1;
  99994. }else if( pCol->colFlags & COLFLAG_PRIMKEY ){
  99995. return 1;
  99996. }
  99997. }
  99998. }
  99999. }
  100000. return 0;
  100001. }
  100002. /*
  100003. ** Return true if the parser passed as the first argument is being
  100004. ** used to code a trigger that is really a "SET NULL" action belonging
  100005. ** to trigger pFKey.
  100006. */
  100007. static int isSetNullAction(Parse *pParse, FKey *pFKey){
  100008. Parse *pTop = sqlite3ParseToplevel(pParse);
  100009. if( pTop->pTriggerPrg ){
  100010. Trigger *p = pTop->pTriggerPrg->pTrigger;
  100011. if( (p==pFKey->apTrigger[0] && pFKey->aAction[0]==OE_SetNull)
  100012. || (p==pFKey->apTrigger[1] && pFKey->aAction[1]==OE_SetNull)
  100013. ){
  100014. return 1;
  100015. }
  100016. }
  100017. return 0;
  100018. }
  100019. /*
  100020. ** This function is called when inserting, deleting or updating a row of
  100021. ** table pTab to generate VDBE code to perform foreign key constraint
  100022. ** processing for the operation.
  100023. **
  100024. ** For a DELETE operation, parameter regOld is passed the index of the
  100025. ** first register in an array of (pTab->nCol+1) registers containing the
  100026. ** rowid of the row being deleted, followed by each of the column values
  100027. ** of the row being deleted, from left to right. Parameter regNew is passed
  100028. ** zero in this case.
  100029. **
  100030. ** For an INSERT operation, regOld is passed zero and regNew is passed the
  100031. ** first register of an array of (pTab->nCol+1) registers containing the new
  100032. ** row data.
  100033. **
  100034. ** For an UPDATE operation, this function is called twice. Once before
  100035. ** the original record is deleted from the table using the calling convention
  100036. ** described for DELETE. Then again after the original record is deleted
  100037. ** but before the new record is inserted using the INSERT convention.
  100038. */
  100039. SQLITE_PRIVATE void sqlite3FkCheck(
  100040. Parse *pParse, /* Parse context */
  100041. Table *pTab, /* Row is being deleted from this table */
  100042. int regOld, /* Previous row data is stored here */
  100043. int regNew, /* New row data is stored here */
  100044. int *aChange, /* Array indicating UPDATEd columns (or 0) */
  100045. int bChngRowid /* True if rowid is UPDATEd */
  100046. ){
  100047. sqlite3 *db = pParse->db; /* Database handle */
  100048. FKey *pFKey; /* Used to iterate through FKs */
  100049. int iDb; /* Index of database containing pTab */
  100050. const char *zDb; /* Name of database containing pTab */
  100051. int isIgnoreErrors = pParse->disableTriggers;
  100052. /* Exactly one of regOld and regNew should be non-zero. */
  100053. assert( (regOld==0)!=(regNew==0) );
  100054. /* If foreign-keys are disabled, this function is a no-op. */
  100055. if( (db->flags&SQLITE_ForeignKeys)==0 ) return;
  100056. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  100057. zDb = db->aDb[iDb].zDbSName;
  100058. /* Loop through all the foreign key constraints for which pTab is the
  100059. ** child table (the table that the foreign key definition is part of). */
  100060. for(pFKey=pTab->pFKey; pFKey; pFKey=pFKey->pNextFrom){
  100061. Table *pTo; /* Parent table of foreign key pFKey */
  100062. Index *pIdx = 0; /* Index on key columns in pTo */
  100063. int *aiFree = 0;
  100064. int *aiCol;
  100065. int iCol;
  100066. int i;
  100067. int bIgnore = 0;
  100068. if( aChange
  100069. && sqlite3_stricmp(pTab->zName, pFKey->zTo)!=0
  100070. && fkChildIsModified(pTab, pFKey, aChange, bChngRowid)==0
  100071. ){
  100072. continue;
  100073. }
  100074. /* Find the parent table of this foreign key. Also find a unique index
  100075. ** on the parent key columns in the parent table. If either of these
  100076. ** schema items cannot be located, set an error in pParse and return
  100077. ** early. */
  100078. if( pParse->disableTriggers ){
  100079. pTo = sqlite3FindTable(db, pFKey->zTo, zDb);
  100080. }else{
  100081. pTo = sqlite3LocateTable(pParse, 0, pFKey->zTo, zDb);
  100082. }
  100083. if( !pTo || sqlite3FkLocateIndex(pParse, pTo, pFKey, &pIdx, &aiFree) ){
  100084. assert( isIgnoreErrors==0 || (regOld!=0 && regNew==0) );
  100085. if( !isIgnoreErrors || db->mallocFailed ) return;
  100086. if( pTo==0 ){
  100087. /* If isIgnoreErrors is true, then a table is being dropped. In this
  100088. ** case SQLite runs a "DELETE FROM xxx" on the table being dropped
  100089. ** before actually dropping it in order to check FK constraints.
  100090. ** If the parent table of an FK constraint on the current table is
  100091. ** missing, behave as if it is empty. i.e. decrement the relevant
  100092. ** FK counter for each row of the current table with non-NULL keys.
  100093. */
  100094. Vdbe *v = sqlite3GetVdbe(pParse);
  100095. int iJump = sqlite3VdbeCurrentAddr(v) + pFKey->nCol + 1;
  100096. for(i=0; i<pFKey->nCol; i++){
  100097. int iReg = pFKey->aCol[i].iFrom + regOld + 1;
  100098. sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iJump); VdbeCoverage(v);
  100099. }
  100100. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, -1);
  100101. }
  100102. continue;
  100103. }
  100104. assert( pFKey->nCol==1 || (aiFree && pIdx) );
  100105. if( aiFree ){
  100106. aiCol = aiFree;
  100107. }else{
  100108. iCol = pFKey->aCol[0].iFrom;
  100109. aiCol = &iCol;
  100110. }
  100111. for(i=0; i<pFKey->nCol; i++){
  100112. if( aiCol[i]==pTab->iPKey ){
  100113. aiCol[i] = -1;
  100114. }
  100115. assert( pIdx==0 || pIdx->aiColumn[i]>=0 );
  100116. #ifndef SQLITE_OMIT_AUTHORIZATION
  100117. /* Request permission to read the parent key columns. If the
  100118. ** authorization callback returns SQLITE_IGNORE, behave as if any
  100119. ** values read from the parent table are NULL. */
  100120. if( db->xAuth ){
  100121. int rcauth;
  100122. char *zCol = pTo->aCol[pIdx ? pIdx->aiColumn[i] : pTo->iPKey].zName;
  100123. rcauth = sqlite3AuthReadCol(pParse, pTo->zName, zCol, iDb);
  100124. bIgnore = (rcauth==SQLITE_IGNORE);
  100125. }
  100126. #endif
  100127. }
  100128. /* Take a shared-cache advisory read-lock on the parent table. Allocate
  100129. ** a cursor to use to search the unique index on the parent key columns
  100130. ** in the parent table. */
  100131. sqlite3TableLock(pParse, iDb, pTo->tnum, 0, pTo->zName);
  100132. pParse->nTab++;
  100133. if( regOld!=0 ){
  100134. /* A row is being removed from the child table. Search for the parent.
  100135. ** If the parent does not exist, removing the child row resolves an
  100136. ** outstanding foreign key constraint violation. */
  100137. fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regOld, -1, bIgnore);
  100138. }
  100139. if( regNew!=0 && !isSetNullAction(pParse, pFKey) ){
  100140. /* A row is being added to the child table. If a parent row cannot
  100141. ** be found, adding the child row has violated the FK constraint.
  100142. **
  100143. ** If this operation is being performed as part of a trigger program
  100144. ** that is actually a "SET NULL" action belonging to this very
  100145. ** foreign key, then omit this scan altogether. As all child key
  100146. ** values are guaranteed to be NULL, it is not possible for adding
  100147. ** this row to cause an FK violation. */
  100148. fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regNew, +1, bIgnore);
  100149. }
  100150. sqlite3DbFree(db, aiFree);
  100151. }
  100152. /* Loop through all the foreign key constraints that refer to this table.
  100153. ** (the "child" constraints) */
  100154. for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
  100155. Index *pIdx = 0; /* Foreign key index for pFKey */
  100156. SrcList *pSrc;
  100157. int *aiCol = 0;
  100158. if( aChange && fkParentIsModified(pTab, pFKey, aChange, bChngRowid)==0 ){
  100159. continue;
  100160. }
  100161. if( !pFKey->isDeferred && !(db->flags & SQLITE_DeferFKs)
  100162. && !pParse->pToplevel && !pParse->isMultiWrite
  100163. ){
  100164. assert( regOld==0 && regNew!=0 );
  100165. /* Inserting a single row into a parent table cannot cause (or fix)
  100166. ** an immediate foreign key violation. So do nothing in this case. */
  100167. continue;
  100168. }
  100169. if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ){
  100170. if( !isIgnoreErrors || db->mallocFailed ) return;
  100171. continue;
  100172. }
  100173. assert( aiCol || pFKey->nCol==1 );
  100174. /* Create a SrcList structure containing the child table. We need the
  100175. ** child table as a SrcList for sqlite3WhereBegin() */
  100176. pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  100177. if( pSrc ){
  100178. struct SrcList_item *pItem = pSrc->a;
  100179. pItem->pTab = pFKey->pFrom;
  100180. pItem->zName = pFKey->pFrom->zName;
  100181. pItem->pTab->nRef++;
  100182. pItem->iCursor = pParse->nTab++;
  100183. if( regNew!=0 ){
  100184. fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regNew, -1);
  100185. }
  100186. if( regOld!=0 ){
  100187. int eAction = pFKey->aAction[aChange!=0];
  100188. fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regOld, 1);
  100189. /* If this is a deferred FK constraint, or a CASCADE or SET NULL
  100190. ** action applies, then any foreign key violations caused by
  100191. ** removing the parent key will be rectified by the action trigger.
  100192. ** So do not set the "may-abort" flag in this case.
  100193. **
  100194. ** Note 1: If the FK is declared "ON UPDATE CASCADE", then the
  100195. ** may-abort flag will eventually be set on this statement anyway
  100196. ** (when this function is called as part of processing the UPDATE
  100197. ** within the action trigger).
  100198. **
  100199. ** Note 2: At first glance it may seem like SQLite could simply omit
  100200. ** all OP_FkCounter related scans when either CASCADE or SET NULL
  100201. ** applies. The trouble starts if the CASCADE or SET NULL action
  100202. ** trigger causes other triggers or action rules attached to the
  100203. ** child table to fire. In these cases the fk constraint counters
  100204. ** might be set incorrectly if any OP_FkCounter related scans are
  100205. ** omitted. */
  100206. if( !pFKey->isDeferred && eAction!=OE_Cascade && eAction!=OE_SetNull ){
  100207. sqlite3MayAbort(pParse);
  100208. }
  100209. }
  100210. pItem->zName = 0;
  100211. sqlite3SrcListDelete(db, pSrc);
  100212. }
  100213. sqlite3DbFree(db, aiCol);
  100214. }
  100215. }
  100216. #define COLUMN_MASK(x) (((x)>31) ? 0xffffffff : ((u32)1<<(x)))
  100217. /*
  100218. ** This function is called before generating code to update or delete a
  100219. ** row contained in table pTab.
  100220. */
  100221. SQLITE_PRIVATE u32 sqlite3FkOldmask(
  100222. Parse *pParse, /* Parse context */
  100223. Table *pTab /* Table being modified */
  100224. ){
  100225. u32 mask = 0;
  100226. if( pParse->db->flags&SQLITE_ForeignKeys ){
  100227. FKey *p;
  100228. int i;
  100229. for(p=pTab->pFKey; p; p=p->pNextFrom){
  100230. for(i=0; i<p->nCol; i++) mask |= COLUMN_MASK(p->aCol[i].iFrom);
  100231. }
  100232. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  100233. Index *pIdx = 0;
  100234. sqlite3FkLocateIndex(pParse, pTab, p, &pIdx, 0);
  100235. if( pIdx ){
  100236. for(i=0; i<pIdx->nKeyCol; i++){
  100237. assert( pIdx->aiColumn[i]>=0 );
  100238. mask |= COLUMN_MASK(pIdx->aiColumn[i]);
  100239. }
  100240. }
  100241. }
  100242. }
  100243. return mask;
  100244. }
  100245. /*
  100246. ** This function is called before generating code to update or delete a
  100247. ** row contained in table pTab. If the operation is a DELETE, then
  100248. ** parameter aChange is passed a NULL value. For an UPDATE, aChange points
  100249. ** to an array of size N, where N is the number of columns in table pTab.
  100250. ** If the i'th column is not modified by the UPDATE, then the corresponding
  100251. ** entry in the aChange[] array is set to -1. If the column is modified,
  100252. ** the value is 0 or greater. Parameter chngRowid is set to true if the
  100253. ** UPDATE statement modifies the rowid fields of the table.
  100254. **
  100255. ** If any foreign key processing will be required, this function returns
  100256. ** true. If there is no foreign key related processing, this function
  100257. ** returns false.
  100258. */
  100259. SQLITE_PRIVATE int sqlite3FkRequired(
  100260. Parse *pParse, /* Parse context */
  100261. Table *pTab, /* Table being modified */
  100262. int *aChange, /* Non-NULL for UPDATE operations */
  100263. int chngRowid /* True for UPDATE that affects rowid */
  100264. ){
  100265. if( pParse->db->flags&SQLITE_ForeignKeys ){
  100266. if( !aChange ){
  100267. /* A DELETE operation. Foreign key processing is required if the
  100268. ** table in question is either the child or parent table for any
  100269. ** foreign key constraint. */
  100270. return (sqlite3FkReferences(pTab) || pTab->pFKey);
  100271. }else{
  100272. /* This is an UPDATE. Foreign key processing is only required if the
  100273. ** operation modifies one or more child or parent key columns. */
  100274. FKey *p;
  100275. /* Check if any child key columns are being modified. */
  100276. for(p=pTab->pFKey; p; p=p->pNextFrom){
  100277. if( fkChildIsModified(pTab, p, aChange, chngRowid) ) return 1;
  100278. }
  100279. /* Check if any parent key columns are being modified. */
  100280. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  100281. if( fkParentIsModified(pTab, p, aChange, chngRowid) ) return 1;
  100282. }
  100283. }
  100284. }
  100285. return 0;
  100286. }
  100287. /*
  100288. ** This function is called when an UPDATE or DELETE operation is being
  100289. ** compiled on table pTab, which is the parent table of foreign-key pFKey.
  100290. ** If the current operation is an UPDATE, then the pChanges parameter is
  100291. ** passed a pointer to the list of columns being modified. If it is a
  100292. ** DELETE, pChanges is passed a NULL pointer.
  100293. **
  100294. ** It returns a pointer to a Trigger structure containing a trigger
  100295. ** equivalent to the ON UPDATE or ON DELETE action specified by pFKey.
  100296. ** If the action is "NO ACTION" or "RESTRICT", then a NULL pointer is
  100297. ** returned (these actions require no special handling by the triggers
  100298. ** sub-system, code for them is created by fkScanChildren()).
  100299. **
  100300. ** For example, if pFKey is the foreign key and pTab is table "p" in
  100301. ** the following schema:
  100302. **
  100303. ** CREATE TABLE p(pk PRIMARY KEY);
  100304. ** CREATE TABLE c(ck REFERENCES p ON DELETE CASCADE);
  100305. **
  100306. ** then the returned trigger structure is equivalent to:
  100307. **
  100308. ** CREATE TRIGGER ... DELETE ON p BEGIN
  100309. ** DELETE FROM c WHERE ck = old.pk;
  100310. ** END;
  100311. **
  100312. ** The returned pointer is cached as part of the foreign key object. It
  100313. ** is eventually freed along with the rest of the foreign key object by
  100314. ** sqlite3FkDelete().
  100315. */
  100316. static Trigger *fkActionTrigger(
  100317. Parse *pParse, /* Parse context */
  100318. Table *pTab, /* Table being updated or deleted from */
  100319. FKey *pFKey, /* Foreign key to get action for */
  100320. ExprList *pChanges /* Change-list for UPDATE, NULL for DELETE */
  100321. ){
  100322. sqlite3 *db = pParse->db; /* Database handle */
  100323. int action; /* One of OE_None, OE_Cascade etc. */
  100324. Trigger *pTrigger; /* Trigger definition to return */
  100325. int iAction = (pChanges!=0); /* 1 for UPDATE, 0 for DELETE */
  100326. action = pFKey->aAction[iAction];
  100327. if( action==OE_Restrict && (db->flags & SQLITE_DeferFKs) ){
  100328. return 0;
  100329. }
  100330. pTrigger = pFKey->apTrigger[iAction];
  100331. if( action!=OE_None && !pTrigger ){
  100332. char const *zFrom; /* Name of child table */
  100333. int nFrom; /* Length in bytes of zFrom */
  100334. Index *pIdx = 0; /* Parent key index for this FK */
  100335. int *aiCol = 0; /* child table cols -> parent key cols */
  100336. TriggerStep *pStep = 0; /* First (only) step of trigger program */
  100337. Expr *pWhere = 0; /* WHERE clause of trigger step */
  100338. ExprList *pList = 0; /* Changes list if ON UPDATE CASCADE */
  100339. Select *pSelect = 0; /* If RESTRICT, "SELECT RAISE(...)" */
  100340. int i; /* Iterator variable */
  100341. Expr *pWhen = 0; /* WHEN clause for the trigger */
  100342. if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ) return 0;
  100343. assert( aiCol || pFKey->nCol==1 );
  100344. for(i=0; i<pFKey->nCol; i++){
  100345. Token tOld = { "old", 3 }; /* Literal "old" token */
  100346. Token tNew = { "new", 3 }; /* Literal "new" token */
  100347. Token tFromCol; /* Name of column in child table */
  100348. Token tToCol; /* Name of column in parent table */
  100349. int iFromCol; /* Idx of column in child table */
  100350. Expr *pEq; /* tFromCol = OLD.tToCol */
  100351. iFromCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
  100352. assert( iFromCol>=0 );
  100353. assert( pIdx!=0 || (pTab->iPKey>=0 && pTab->iPKey<pTab->nCol) );
  100354. assert( pIdx==0 || pIdx->aiColumn[i]>=0 );
  100355. sqlite3TokenInit(&tToCol,
  100356. pTab->aCol[pIdx ? pIdx->aiColumn[i] : pTab->iPKey].zName);
  100357. sqlite3TokenInit(&tFromCol, pFKey->pFrom->aCol[iFromCol].zName);
  100358. /* Create the expression "OLD.zToCol = zFromCol". It is important
  100359. ** that the "OLD.zToCol" term is on the LHS of the = operator, so
  100360. ** that the affinity and collation sequence associated with the
  100361. ** parent table are used for the comparison. */
  100362. pEq = sqlite3PExpr(pParse, TK_EQ,
  100363. sqlite3PExpr(pParse, TK_DOT,
  100364. sqlite3ExprAlloc(db, TK_ID, &tOld, 0),
  100365. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0)
  100366. , 0),
  100367. sqlite3ExprAlloc(db, TK_ID, &tFromCol, 0)
  100368. , 0);
  100369. pWhere = sqlite3ExprAnd(db, pWhere, pEq);
  100370. /* For ON UPDATE, construct the next term of the WHEN clause.
  100371. ** The final WHEN clause will be like this:
  100372. **
  100373. ** WHEN NOT(old.col1 IS new.col1 AND ... AND old.colN IS new.colN)
  100374. */
  100375. if( pChanges ){
  100376. pEq = sqlite3PExpr(pParse, TK_IS,
  100377. sqlite3PExpr(pParse, TK_DOT,
  100378. sqlite3ExprAlloc(db, TK_ID, &tOld, 0),
  100379. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0),
  100380. 0),
  100381. sqlite3PExpr(pParse, TK_DOT,
  100382. sqlite3ExprAlloc(db, TK_ID, &tNew, 0),
  100383. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0),
  100384. 0),
  100385. 0);
  100386. pWhen = sqlite3ExprAnd(db, pWhen, pEq);
  100387. }
  100388. if( action!=OE_Restrict && (action!=OE_Cascade || pChanges) ){
  100389. Expr *pNew;
  100390. if( action==OE_Cascade ){
  100391. pNew = sqlite3PExpr(pParse, TK_DOT,
  100392. sqlite3ExprAlloc(db, TK_ID, &tNew, 0),
  100393. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0)
  100394. , 0);
  100395. }else if( action==OE_SetDflt ){
  100396. Expr *pDflt = pFKey->pFrom->aCol[iFromCol].pDflt;
  100397. if( pDflt ){
  100398. pNew = sqlite3ExprDup(db, pDflt, 0);
  100399. }else{
  100400. pNew = sqlite3ExprAlloc(db, TK_NULL, 0, 0);
  100401. }
  100402. }else{
  100403. pNew = sqlite3ExprAlloc(db, TK_NULL, 0, 0);
  100404. }
  100405. pList = sqlite3ExprListAppend(pParse, pList, pNew);
  100406. sqlite3ExprListSetName(pParse, pList, &tFromCol, 0);
  100407. }
  100408. }
  100409. sqlite3DbFree(db, aiCol);
  100410. zFrom = pFKey->pFrom->zName;
  100411. nFrom = sqlite3Strlen30(zFrom);
  100412. if( action==OE_Restrict ){
  100413. Token tFrom;
  100414. Expr *pRaise;
  100415. tFrom.z = zFrom;
  100416. tFrom.n = nFrom;
  100417. pRaise = sqlite3Expr(db, TK_RAISE, "FOREIGN KEY constraint failed");
  100418. if( pRaise ){
  100419. pRaise->affinity = OE_Abort;
  100420. }
  100421. pSelect = sqlite3SelectNew(pParse,
  100422. sqlite3ExprListAppend(pParse, 0, pRaise),
  100423. sqlite3SrcListAppend(db, 0, &tFrom, 0),
  100424. pWhere,
  100425. 0, 0, 0, 0, 0, 0
  100426. );
  100427. pWhere = 0;
  100428. }
  100429. /* Disable lookaside memory allocation */
  100430. db->lookaside.bDisable++;
  100431. pTrigger = (Trigger *)sqlite3DbMallocZero(db,
  100432. sizeof(Trigger) + /* struct Trigger */
  100433. sizeof(TriggerStep) + /* Single step in trigger program */
  100434. nFrom + 1 /* Space for pStep->zTarget */
  100435. );
  100436. if( pTrigger ){
  100437. pStep = pTrigger->step_list = (TriggerStep *)&pTrigger[1];
  100438. pStep->zTarget = (char *)&pStep[1];
  100439. memcpy((char *)pStep->zTarget, zFrom, nFrom);
  100440. pStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  100441. pStep->pExprList = sqlite3ExprListDup(db, pList, EXPRDUP_REDUCE);
  100442. pStep->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  100443. if( pWhen ){
  100444. pWhen = sqlite3PExpr(pParse, TK_NOT, pWhen, 0, 0);
  100445. pTrigger->pWhen = sqlite3ExprDup(db, pWhen, EXPRDUP_REDUCE);
  100446. }
  100447. }
  100448. /* Re-enable the lookaside buffer, if it was disabled earlier. */
  100449. db->lookaside.bDisable--;
  100450. sqlite3ExprDelete(db, pWhere);
  100451. sqlite3ExprDelete(db, pWhen);
  100452. sqlite3ExprListDelete(db, pList);
  100453. sqlite3SelectDelete(db, pSelect);
  100454. if( db->mallocFailed==1 ){
  100455. fkTriggerDelete(db, pTrigger);
  100456. return 0;
  100457. }
  100458. assert( pStep!=0 );
  100459. switch( action ){
  100460. case OE_Restrict:
  100461. pStep->op = TK_SELECT;
  100462. break;
  100463. case OE_Cascade:
  100464. if( !pChanges ){
  100465. pStep->op = TK_DELETE;
  100466. break;
  100467. }
  100468. default:
  100469. pStep->op = TK_UPDATE;
  100470. }
  100471. pStep->pTrig = pTrigger;
  100472. pTrigger->pSchema = pTab->pSchema;
  100473. pTrigger->pTabSchema = pTab->pSchema;
  100474. pFKey->apTrigger[iAction] = pTrigger;
  100475. pTrigger->op = (pChanges ? TK_UPDATE : TK_DELETE);
  100476. }
  100477. return pTrigger;
  100478. }
  100479. /*
  100480. ** This function is called when deleting or updating a row to implement
  100481. ** any required CASCADE, SET NULL or SET DEFAULT actions.
  100482. */
  100483. SQLITE_PRIVATE void sqlite3FkActions(
  100484. Parse *pParse, /* Parse context */
  100485. Table *pTab, /* Table being updated or deleted from */
  100486. ExprList *pChanges, /* Change-list for UPDATE, NULL for DELETE */
  100487. int regOld, /* Address of array containing old row */
  100488. int *aChange, /* Array indicating UPDATEd columns (or 0) */
  100489. int bChngRowid /* True if rowid is UPDATEd */
  100490. ){
  100491. /* If foreign-key support is enabled, iterate through all FKs that
  100492. ** refer to table pTab. If there is an action associated with the FK
  100493. ** for this operation (either update or delete), invoke the associated
  100494. ** trigger sub-program. */
  100495. if( pParse->db->flags&SQLITE_ForeignKeys ){
  100496. FKey *pFKey; /* Iterator variable */
  100497. for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
  100498. if( aChange==0 || fkParentIsModified(pTab, pFKey, aChange, bChngRowid) ){
  100499. Trigger *pAct = fkActionTrigger(pParse, pTab, pFKey, pChanges);
  100500. if( pAct ){
  100501. sqlite3CodeRowTriggerDirect(pParse, pAct, pTab, regOld, OE_Abort, 0);
  100502. }
  100503. }
  100504. }
  100505. }
  100506. }
  100507. #endif /* ifndef SQLITE_OMIT_TRIGGER */
  100508. /*
  100509. ** Free all memory associated with foreign key definitions attached to
  100510. ** table pTab. Remove the deleted foreign keys from the Schema.fkeyHash
  100511. ** hash table.
  100512. */
  100513. SQLITE_PRIVATE void sqlite3FkDelete(sqlite3 *db, Table *pTab){
  100514. FKey *pFKey; /* Iterator variable */
  100515. FKey *pNext; /* Copy of pFKey->pNextFrom */
  100516. assert( db==0 || IsVirtual(pTab)
  100517. || sqlite3SchemaMutexHeld(db, 0, pTab->pSchema) );
  100518. for(pFKey=pTab->pFKey; pFKey; pFKey=pNext){
  100519. /* Remove the FK from the fkeyHash hash table. */
  100520. if( !db || db->pnBytesFreed==0 ){
  100521. if( pFKey->pPrevTo ){
  100522. pFKey->pPrevTo->pNextTo = pFKey->pNextTo;
  100523. }else{
  100524. void *p = (void *)pFKey->pNextTo;
  100525. const char *z = (p ? pFKey->pNextTo->zTo : pFKey->zTo);
  100526. sqlite3HashInsert(&pTab->pSchema->fkeyHash, z, p);
  100527. }
  100528. if( pFKey->pNextTo ){
  100529. pFKey->pNextTo->pPrevTo = pFKey->pPrevTo;
  100530. }
  100531. }
  100532. /* EV: R-30323-21917 Each foreign key constraint in SQLite is
  100533. ** classified as either immediate or deferred.
  100534. */
  100535. assert( pFKey->isDeferred==0 || pFKey->isDeferred==1 );
  100536. /* Delete any triggers created to implement actions for this FK. */
  100537. #ifndef SQLITE_OMIT_TRIGGER
  100538. fkTriggerDelete(db, pFKey->apTrigger[0]);
  100539. fkTriggerDelete(db, pFKey->apTrigger[1]);
  100540. #endif
  100541. pNext = pFKey->pNextFrom;
  100542. sqlite3DbFree(db, pFKey);
  100543. }
  100544. }
  100545. #endif /* ifndef SQLITE_OMIT_FOREIGN_KEY */
  100546. /************** End of fkey.c ************************************************/
  100547. /************** Begin file insert.c ******************************************/
  100548. /*
  100549. ** 2001 September 15
  100550. **
  100551. ** The author disclaims copyright to this source code. In place of
  100552. ** a legal notice, here is a blessing:
  100553. **
  100554. ** May you do good and not evil.
  100555. ** May you find forgiveness for yourself and forgive others.
  100556. ** May you share freely, never taking more than you give.
  100557. **
  100558. *************************************************************************
  100559. ** This file contains C code routines that are called by the parser
  100560. ** to handle INSERT statements in SQLite.
  100561. */
  100562. /* #include "sqliteInt.h" */
  100563. /*
  100564. ** Generate code that will
  100565. **
  100566. ** (1) acquire a lock for table pTab then
  100567. ** (2) open pTab as cursor iCur.
  100568. **
  100569. ** If pTab is a WITHOUT ROWID table, then it is the PRIMARY KEY index
  100570. ** for that table that is actually opened.
  100571. */
  100572. SQLITE_PRIVATE void sqlite3OpenTable(
  100573. Parse *pParse, /* Generate code into this VDBE */
  100574. int iCur, /* The cursor number of the table */
  100575. int iDb, /* The database index in sqlite3.aDb[] */
  100576. Table *pTab, /* The table to be opened */
  100577. int opcode /* OP_OpenRead or OP_OpenWrite */
  100578. ){
  100579. Vdbe *v;
  100580. assert( !IsVirtual(pTab) );
  100581. v = sqlite3GetVdbe(pParse);
  100582. assert( opcode==OP_OpenWrite || opcode==OP_OpenRead );
  100583. sqlite3TableLock(pParse, iDb, pTab->tnum,
  100584. (opcode==OP_OpenWrite)?1:0, pTab->zName);
  100585. if( HasRowid(pTab) ){
  100586. sqlite3VdbeAddOp4Int(v, opcode, iCur, pTab->tnum, iDb, pTab->nCol);
  100587. VdbeComment((v, "%s", pTab->zName));
  100588. }else{
  100589. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  100590. assert( pPk!=0 );
  100591. assert( pPk->tnum==pTab->tnum );
  100592. sqlite3VdbeAddOp3(v, opcode, iCur, pPk->tnum, iDb);
  100593. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  100594. VdbeComment((v, "%s", pTab->zName));
  100595. }
  100596. }
  100597. /*
  100598. ** Return a pointer to the column affinity string associated with index
  100599. ** pIdx. A column affinity string has one character for each column in
  100600. ** the table, according to the affinity of the column:
  100601. **
  100602. ** Character Column affinity
  100603. ** ------------------------------
  100604. ** 'A' BLOB
  100605. ** 'B' TEXT
  100606. ** 'C' NUMERIC
  100607. ** 'D' INTEGER
  100608. ** 'F' REAL
  100609. **
  100610. ** An extra 'D' is appended to the end of the string to cover the
  100611. ** rowid that appears as the last column in every index.
  100612. **
  100613. ** Memory for the buffer containing the column index affinity string
  100614. ** is managed along with the rest of the Index structure. It will be
  100615. ** released when sqlite3DeleteIndex() is called.
  100616. */
  100617. SQLITE_PRIVATE const char *sqlite3IndexAffinityStr(sqlite3 *db, Index *pIdx){
  100618. if( !pIdx->zColAff ){
  100619. /* The first time a column affinity string for a particular index is
  100620. ** required, it is allocated and populated here. It is then stored as
  100621. ** a member of the Index structure for subsequent use.
  100622. **
  100623. ** The column affinity string will eventually be deleted by
  100624. ** sqliteDeleteIndex() when the Index structure itself is cleaned
  100625. ** up.
  100626. */
  100627. int n;
  100628. Table *pTab = pIdx->pTable;
  100629. pIdx->zColAff = (char *)sqlite3DbMallocRaw(0, pIdx->nColumn+1);
  100630. if( !pIdx->zColAff ){
  100631. sqlite3OomFault(db);
  100632. return 0;
  100633. }
  100634. for(n=0; n<pIdx->nColumn; n++){
  100635. i16 x = pIdx->aiColumn[n];
  100636. if( x>=0 ){
  100637. pIdx->zColAff[n] = pTab->aCol[x].affinity;
  100638. }else if( x==XN_ROWID ){
  100639. pIdx->zColAff[n] = SQLITE_AFF_INTEGER;
  100640. }else{
  100641. char aff;
  100642. assert( x==XN_EXPR );
  100643. assert( pIdx->aColExpr!=0 );
  100644. aff = sqlite3ExprAffinity(pIdx->aColExpr->a[n].pExpr);
  100645. if( aff==0 ) aff = SQLITE_AFF_BLOB;
  100646. pIdx->zColAff[n] = aff;
  100647. }
  100648. }
  100649. pIdx->zColAff[n] = 0;
  100650. }
  100651. return pIdx->zColAff;
  100652. }
  100653. /*
  100654. ** Compute the affinity string for table pTab, if it has not already been
  100655. ** computed. As an optimization, omit trailing SQLITE_AFF_BLOB affinities.
  100656. **
  100657. ** If the affinity exists (if it is no entirely SQLITE_AFF_BLOB values) and
  100658. ** if iReg>0 then code an OP_Affinity opcode that will set the affinities
  100659. ** for register iReg and following. Or if affinities exists and iReg==0,
  100660. ** then just set the P4 operand of the previous opcode (which should be
  100661. ** an OP_MakeRecord) to the affinity string.
  100662. **
  100663. ** A column affinity string has one character per column:
  100664. **
  100665. ** Character Column affinity
  100666. ** ------------------------------
  100667. ** 'A' BLOB
  100668. ** 'B' TEXT
  100669. ** 'C' NUMERIC
  100670. ** 'D' INTEGER
  100671. ** 'E' REAL
  100672. */
  100673. SQLITE_PRIVATE void sqlite3TableAffinity(Vdbe *v, Table *pTab, int iReg){
  100674. int i;
  100675. char *zColAff = pTab->zColAff;
  100676. if( zColAff==0 ){
  100677. sqlite3 *db = sqlite3VdbeDb(v);
  100678. zColAff = (char *)sqlite3DbMallocRaw(0, pTab->nCol+1);
  100679. if( !zColAff ){
  100680. sqlite3OomFault(db);
  100681. return;
  100682. }
  100683. for(i=0; i<pTab->nCol; i++){
  100684. zColAff[i] = pTab->aCol[i].affinity;
  100685. }
  100686. do{
  100687. zColAff[i--] = 0;
  100688. }while( i>=0 && zColAff[i]==SQLITE_AFF_BLOB );
  100689. pTab->zColAff = zColAff;
  100690. }
  100691. i = sqlite3Strlen30(zColAff);
  100692. if( i ){
  100693. if( iReg ){
  100694. sqlite3VdbeAddOp4(v, OP_Affinity, iReg, i, 0, zColAff, i);
  100695. }else{
  100696. sqlite3VdbeChangeP4(v, -1, zColAff, i);
  100697. }
  100698. }
  100699. }
  100700. /*
  100701. ** Return non-zero if the table pTab in database iDb or any of its indices
  100702. ** have been opened at any point in the VDBE program. This is used to see if
  100703. ** a statement of the form "INSERT INTO <iDb, pTab> SELECT ..." can
  100704. ** run without using a temporary table for the results of the SELECT.
  100705. */
  100706. static int readsTable(Parse *p, int iDb, Table *pTab){
  100707. Vdbe *v = sqlite3GetVdbe(p);
  100708. int i;
  100709. int iEnd = sqlite3VdbeCurrentAddr(v);
  100710. #ifndef SQLITE_OMIT_VIRTUALTABLE
  100711. VTable *pVTab = IsVirtual(pTab) ? sqlite3GetVTable(p->db, pTab) : 0;
  100712. #endif
  100713. for(i=1; i<iEnd; i++){
  100714. VdbeOp *pOp = sqlite3VdbeGetOp(v, i);
  100715. assert( pOp!=0 );
  100716. if( pOp->opcode==OP_OpenRead && pOp->p3==iDb ){
  100717. Index *pIndex;
  100718. int tnum = pOp->p2;
  100719. if( tnum==pTab->tnum ){
  100720. return 1;
  100721. }
  100722. for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
  100723. if( tnum==pIndex->tnum ){
  100724. return 1;
  100725. }
  100726. }
  100727. }
  100728. #ifndef SQLITE_OMIT_VIRTUALTABLE
  100729. if( pOp->opcode==OP_VOpen && pOp->p4.pVtab==pVTab ){
  100730. assert( pOp->p4.pVtab!=0 );
  100731. assert( pOp->p4type==P4_VTAB );
  100732. return 1;
  100733. }
  100734. #endif
  100735. }
  100736. return 0;
  100737. }
  100738. #ifndef SQLITE_OMIT_AUTOINCREMENT
  100739. /*
  100740. ** Locate or create an AutoincInfo structure associated with table pTab
  100741. ** which is in database iDb. Return the register number for the register
  100742. ** that holds the maximum rowid. Return zero if pTab is not an AUTOINCREMENT
  100743. ** table. (Also return zero when doing a VACUUM since we do not want to
  100744. ** update the AUTOINCREMENT counters during a VACUUM.)
  100745. **
  100746. ** There is at most one AutoincInfo structure per table even if the
  100747. ** same table is autoincremented multiple times due to inserts within
  100748. ** triggers. A new AutoincInfo structure is created if this is the
  100749. ** first use of table pTab. On 2nd and subsequent uses, the original
  100750. ** AutoincInfo structure is used.
  100751. **
  100752. ** Three memory locations are allocated:
  100753. **
  100754. ** (1) Register to hold the name of the pTab table.
  100755. ** (2) Register to hold the maximum ROWID of pTab.
  100756. ** (3) Register to hold the rowid in sqlite_sequence of pTab
  100757. **
  100758. ** The 2nd register is the one that is returned. That is all the
  100759. ** insert routine needs to know about.
  100760. */
  100761. static int autoIncBegin(
  100762. Parse *pParse, /* Parsing context */
  100763. int iDb, /* Index of the database holding pTab */
  100764. Table *pTab /* The table we are writing to */
  100765. ){
  100766. int memId = 0; /* Register holding maximum rowid */
  100767. if( (pTab->tabFlags & TF_Autoincrement)!=0
  100768. && (pParse->db->flags & SQLITE_Vacuum)==0
  100769. ){
  100770. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  100771. AutoincInfo *pInfo;
  100772. pInfo = pToplevel->pAinc;
  100773. while( pInfo && pInfo->pTab!=pTab ){ pInfo = pInfo->pNext; }
  100774. if( pInfo==0 ){
  100775. pInfo = sqlite3DbMallocRawNN(pParse->db, sizeof(*pInfo));
  100776. if( pInfo==0 ) return 0;
  100777. pInfo->pNext = pToplevel->pAinc;
  100778. pToplevel->pAinc = pInfo;
  100779. pInfo->pTab = pTab;
  100780. pInfo->iDb = iDb;
  100781. pToplevel->nMem++; /* Register to hold name of table */
  100782. pInfo->regCtr = ++pToplevel->nMem; /* Max rowid register */
  100783. pToplevel->nMem++; /* Rowid in sqlite_sequence */
  100784. }
  100785. memId = pInfo->regCtr;
  100786. }
  100787. return memId;
  100788. }
  100789. /*
  100790. ** This routine generates code that will initialize all of the
  100791. ** register used by the autoincrement tracker.
  100792. */
  100793. SQLITE_PRIVATE void sqlite3AutoincrementBegin(Parse *pParse){
  100794. AutoincInfo *p; /* Information about an AUTOINCREMENT */
  100795. sqlite3 *db = pParse->db; /* The database connection */
  100796. Db *pDb; /* Database only autoinc table */
  100797. int memId; /* Register holding max rowid */
  100798. Vdbe *v = pParse->pVdbe; /* VDBE under construction */
  100799. /* This routine is never called during trigger-generation. It is
  100800. ** only called from the top-level */
  100801. assert( pParse->pTriggerTab==0 );
  100802. assert( sqlite3IsToplevel(pParse) );
  100803. assert( v ); /* We failed long ago if this is not so */
  100804. for(p = pParse->pAinc; p; p = p->pNext){
  100805. static const int iLn = VDBE_OFFSET_LINENO(2);
  100806. static const VdbeOpList autoInc[] = {
  100807. /* 0 */ {OP_Null, 0, 0, 0},
  100808. /* 1 */ {OP_Rewind, 0, 9, 0},
  100809. /* 2 */ {OP_Column, 0, 0, 0},
  100810. /* 3 */ {OP_Ne, 0, 7, 0},
  100811. /* 4 */ {OP_Rowid, 0, 0, 0},
  100812. /* 5 */ {OP_Column, 0, 1, 0},
  100813. /* 6 */ {OP_Goto, 0, 9, 0},
  100814. /* 7 */ {OP_Next, 0, 2, 0},
  100815. /* 8 */ {OP_Integer, 0, 0, 0},
  100816. /* 9 */ {OP_Close, 0, 0, 0}
  100817. };
  100818. VdbeOp *aOp;
  100819. pDb = &db->aDb[p->iDb];
  100820. memId = p->regCtr;
  100821. assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
  100822. sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenRead);
  100823. sqlite3VdbeLoadString(v, memId-1, p->pTab->zName);
  100824. aOp = sqlite3VdbeAddOpList(v, ArraySize(autoInc), autoInc, iLn);
  100825. if( aOp==0 ) break;
  100826. aOp[0].p2 = memId;
  100827. aOp[0].p3 = memId+1;
  100828. aOp[2].p3 = memId;
  100829. aOp[3].p1 = memId-1;
  100830. aOp[3].p3 = memId;
  100831. aOp[3].p5 = SQLITE_JUMPIFNULL;
  100832. aOp[4].p2 = memId+1;
  100833. aOp[5].p3 = memId;
  100834. aOp[8].p2 = memId;
  100835. }
  100836. }
  100837. /*
  100838. ** Update the maximum rowid for an autoincrement calculation.
  100839. **
  100840. ** This routine should be called when the regRowid register holds a
  100841. ** new rowid that is about to be inserted. If that new rowid is
  100842. ** larger than the maximum rowid in the memId memory cell, then the
  100843. ** memory cell is updated.
  100844. */
  100845. static void autoIncStep(Parse *pParse, int memId, int regRowid){
  100846. if( memId>0 ){
  100847. sqlite3VdbeAddOp2(pParse->pVdbe, OP_MemMax, memId, regRowid);
  100848. }
  100849. }
  100850. /*
  100851. ** This routine generates the code needed to write autoincrement
  100852. ** maximum rowid values back into the sqlite_sequence register.
  100853. ** Every statement that might do an INSERT into an autoincrement
  100854. ** table (either directly or through triggers) needs to call this
  100855. ** routine just before the "exit" code.
  100856. */
  100857. static SQLITE_NOINLINE void autoIncrementEnd(Parse *pParse){
  100858. AutoincInfo *p;
  100859. Vdbe *v = pParse->pVdbe;
  100860. sqlite3 *db = pParse->db;
  100861. assert( v );
  100862. for(p = pParse->pAinc; p; p = p->pNext){
  100863. static const int iLn = VDBE_OFFSET_LINENO(2);
  100864. static const VdbeOpList autoIncEnd[] = {
  100865. /* 0 */ {OP_NotNull, 0, 2, 0},
  100866. /* 1 */ {OP_NewRowid, 0, 0, 0},
  100867. /* 2 */ {OP_MakeRecord, 0, 2, 0},
  100868. /* 3 */ {OP_Insert, 0, 0, 0},
  100869. /* 4 */ {OP_Close, 0, 0, 0}
  100870. };
  100871. VdbeOp *aOp;
  100872. Db *pDb = &db->aDb[p->iDb];
  100873. int iRec;
  100874. int memId = p->regCtr;
  100875. iRec = sqlite3GetTempReg(pParse);
  100876. assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
  100877. sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenWrite);
  100878. aOp = sqlite3VdbeAddOpList(v, ArraySize(autoIncEnd), autoIncEnd, iLn);
  100879. if( aOp==0 ) break;
  100880. aOp[0].p1 = memId+1;
  100881. aOp[1].p2 = memId+1;
  100882. aOp[2].p1 = memId-1;
  100883. aOp[2].p3 = iRec;
  100884. aOp[3].p2 = iRec;
  100885. aOp[3].p3 = memId+1;
  100886. aOp[3].p5 = OPFLAG_APPEND;
  100887. sqlite3ReleaseTempReg(pParse, iRec);
  100888. }
  100889. }
  100890. SQLITE_PRIVATE void sqlite3AutoincrementEnd(Parse *pParse){
  100891. if( pParse->pAinc ) autoIncrementEnd(pParse);
  100892. }
  100893. #else
  100894. /*
  100895. ** If SQLITE_OMIT_AUTOINCREMENT is defined, then the three routines
  100896. ** above are all no-ops
  100897. */
  100898. # define autoIncBegin(A,B,C) (0)
  100899. # define autoIncStep(A,B,C)
  100900. #endif /* SQLITE_OMIT_AUTOINCREMENT */
  100901. /* Forward declaration */
  100902. static int xferOptimization(
  100903. Parse *pParse, /* Parser context */
  100904. Table *pDest, /* The table we are inserting into */
  100905. Select *pSelect, /* A SELECT statement to use as the data source */
  100906. int onError, /* How to handle constraint errors */
  100907. int iDbDest /* The database of pDest */
  100908. );
  100909. /*
  100910. ** This routine is called to handle SQL of the following forms:
  100911. **
  100912. ** insert into TABLE (IDLIST) values(EXPRLIST),(EXPRLIST),...
  100913. ** insert into TABLE (IDLIST) select
  100914. ** insert into TABLE (IDLIST) default values
  100915. **
  100916. ** The IDLIST following the table name is always optional. If omitted,
  100917. ** then a list of all (non-hidden) columns for the table is substituted.
  100918. ** The IDLIST appears in the pColumn parameter. pColumn is NULL if IDLIST
  100919. ** is omitted.
  100920. **
  100921. ** For the pSelect parameter holds the values to be inserted for the
  100922. ** first two forms shown above. A VALUES clause is really just short-hand
  100923. ** for a SELECT statement that omits the FROM clause and everything else
  100924. ** that follows. If the pSelect parameter is NULL, that means that the
  100925. ** DEFAULT VALUES form of the INSERT statement is intended.
  100926. **
  100927. ** The code generated follows one of four templates. For a simple
  100928. ** insert with data coming from a single-row VALUES clause, the code executes
  100929. ** once straight down through. Pseudo-code follows (we call this
  100930. ** the "1st template"):
  100931. **
  100932. ** open write cursor to <table> and its indices
  100933. ** put VALUES clause expressions into registers
  100934. ** write the resulting record into <table>
  100935. ** cleanup
  100936. **
  100937. ** The three remaining templates assume the statement is of the form
  100938. **
  100939. ** INSERT INTO <table> SELECT ...
  100940. **
  100941. ** If the SELECT clause is of the restricted form "SELECT * FROM <table2>" -
  100942. ** in other words if the SELECT pulls all columns from a single table
  100943. ** and there is no WHERE or LIMIT or GROUP BY or ORDER BY clauses, and
  100944. ** if <table2> and <table1> are distinct tables but have identical
  100945. ** schemas, including all the same indices, then a special optimization
  100946. ** is invoked that copies raw records from <table2> over to <table1>.
  100947. ** See the xferOptimization() function for the implementation of this
  100948. ** template. This is the 2nd template.
  100949. **
  100950. ** open a write cursor to <table>
  100951. ** open read cursor on <table2>
  100952. ** transfer all records in <table2> over to <table>
  100953. ** close cursors
  100954. ** foreach index on <table>
  100955. ** open a write cursor on the <table> index
  100956. ** open a read cursor on the corresponding <table2> index
  100957. ** transfer all records from the read to the write cursors
  100958. ** close cursors
  100959. ** end foreach
  100960. **
  100961. ** The 3rd template is for when the second template does not apply
  100962. ** and the SELECT clause does not read from <table> at any time.
  100963. ** The generated code follows this template:
  100964. **
  100965. ** X <- A
  100966. ** goto B
  100967. ** A: setup for the SELECT
  100968. ** loop over the rows in the SELECT
  100969. ** load values into registers R..R+n
  100970. ** yield X
  100971. ** end loop
  100972. ** cleanup after the SELECT
  100973. ** end-coroutine X
  100974. ** B: open write cursor to <table> and its indices
  100975. ** C: yield X, at EOF goto D
  100976. ** insert the select result into <table> from R..R+n
  100977. ** goto C
  100978. ** D: cleanup
  100979. **
  100980. ** The 4th template is used if the insert statement takes its
  100981. ** values from a SELECT but the data is being inserted into a table
  100982. ** that is also read as part of the SELECT. In the third form,
  100983. ** we have to use an intermediate table to store the results of
  100984. ** the select. The template is like this:
  100985. **
  100986. ** X <- A
  100987. ** goto B
  100988. ** A: setup for the SELECT
  100989. ** loop over the tables in the SELECT
  100990. ** load value into register R..R+n
  100991. ** yield X
  100992. ** end loop
  100993. ** cleanup after the SELECT
  100994. ** end co-routine R
  100995. ** B: open temp table
  100996. ** L: yield X, at EOF goto M
  100997. ** insert row from R..R+n into temp table
  100998. ** goto L
  100999. ** M: open write cursor to <table> and its indices
  101000. ** rewind temp table
  101001. ** C: loop over rows of intermediate table
  101002. ** transfer values form intermediate table into <table>
  101003. ** end loop
  101004. ** D: cleanup
  101005. */
  101006. SQLITE_PRIVATE void sqlite3Insert(
  101007. Parse *pParse, /* Parser context */
  101008. SrcList *pTabList, /* Name of table into which we are inserting */
  101009. Select *pSelect, /* A SELECT statement to use as the data source */
  101010. IdList *pColumn, /* Column names corresponding to IDLIST. */
  101011. int onError /* How to handle constraint errors */
  101012. ){
  101013. sqlite3 *db; /* The main database structure */
  101014. Table *pTab; /* The table to insert into. aka TABLE */
  101015. char *zTab; /* Name of the table into which we are inserting */
  101016. int i, j, idx; /* Loop counters */
  101017. Vdbe *v; /* Generate code into this virtual machine */
  101018. Index *pIdx; /* For looping over indices of the table */
  101019. int nColumn; /* Number of columns in the data */
  101020. int nHidden = 0; /* Number of hidden columns if TABLE is virtual */
  101021. int iDataCur = 0; /* VDBE cursor that is the main data repository */
  101022. int iIdxCur = 0; /* First index cursor */
  101023. int ipkColumn = -1; /* Column that is the INTEGER PRIMARY KEY */
  101024. int endOfLoop; /* Label for the end of the insertion loop */
  101025. int srcTab = 0; /* Data comes from this temporary cursor if >=0 */
  101026. int addrInsTop = 0; /* Jump to label "D" */
  101027. int addrCont = 0; /* Top of insert loop. Label "C" in templates 3 and 4 */
  101028. SelectDest dest; /* Destination for SELECT on rhs of INSERT */
  101029. int iDb; /* Index of database holding TABLE */
  101030. u8 useTempTable = 0; /* Store SELECT results in intermediate table */
  101031. u8 appendFlag = 0; /* True if the insert is likely to be an append */
  101032. u8 withoutRowid; /* 0 for normal table. 1 for WITHOUT ROWID table */
  101033. u8 bIdListInOrder; /* True if IDLIST is in table order */
  101034. ExprList *pList = 0; /* List of VALUES() to be inserted */
  101035. /* Register allocations */
  101036. int regFromSelect = 0;/* Base register for data coming from SELECT */
  101037. int regAutoinc = 0; /* Register holding the AUTOINCREMENT counter */
  101038. int regRowCount = 0; /* Memory cell used for the row counter */
  101039. int regIns; /* Block of regs holding rowid+data being inserted */
  101040. int regRowid; /* registers holding insert rowid */
  101041. int regData; /* register holding first column to insert */
  101042. int *aRegIdx = 0; /* One register allocated to each index */
  101043. #ifndef SQLITE_OMIT_TRIGGER
  101044. int isView; /* True if attempting to insert into a view */
  101045. Trigger *pTrigger; /* List of triggers on pTab, if required */
  101046. int tmask; /* Mask of trigger times */
  101047. #endif
  101048. db = pParse->db;
  101049. memset(&dest, 0, sizeof(dest));
  101050. if( pParse->nErr || db->mallocFailed ){
  101051. goto insert_cleanup;
  101052. }
  101053. /* If the Select object is really just a simple VALUES() list with a
  101054. ** single row (the common case) then keep that one row of values
  101055. ** and discard the other (unused) parts of the pSelect object
  101056. */
  101057. if( pSelect && (pSelect->selFlags & SF_Values)!=0 && pSelect->pPrior==0 ){
  101058. pList = pSelect->pEList;
  101059. pSelect->pEList = 0;
  101060. sqlite3SelectDelete(db, pSelect);
  101061. pSelect = 0;
  101062. }
  101063. /* Locate the table into which we will be inserting new information.
  101064. */
  101065. assert( pTabList->nSrc==1 );
  101066. zTab = pTabList->a[0].zName;
  101067. if( NEVER(zTab==0) ) goto insert_cleanup;
  101068. pTab = sqlite3SrcListLookup(pParse, pTabList);
  101069. if( pTab==0 ){
  101070. goto insert_cleanup;
  101071. }
  101072. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  101073. assert( iDb<db->nDb );
  101074. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, pTab->zName, 0,
  101075. db->aDb[iDb].zDbSName) ){
  101076. goto insert_cleanup;
  101077. }
  101078. withoutRowid = !HasRowid(pTab);
  101079. /* Figure out if we have any triggers and if the table being
  101080. ** inserted into is a view
  101081. */
  101082. #ifndef SQLITE_OMIT_TRIGGER
  101083. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_INSERT, 0, &tmask);
  101084. isView = pTab->pSelect!=0;
  101085. #else
  101086. # define pTrigger 0
  101087. # define tmask 0
  101088. # define isView 0
  101089. #endif
  101090. #ifdef SQLITE_OMIT_VIEW
  101091. # undef isView
  101092. # define isView 0
  101093. #endif
  101094. assert( (pTrigger && tmask) || (pTrigger==0 && tmask==0) );
  101095. /* If pTab is really a view, make sure it has been initialized.
  101096. ** ViewGetColumnNames() is a no-op if pTab is not a view.
  101097. */
  101098. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  101099. goto insert_cleanup;
  101100. }
  101101. /* Cannot insert into a read-only table.
  101102. */
  101103. if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
  101104. goto insert_cleanup;
  101105. }
  101106. /* Allocate a VDBE
  101107. */
  101108. v = sqlite3GetVdbe(pParse);
  101109. if( v==0 ) goto insert_cleanup;
  101110. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  101111. sqlite3BeginWriteOperation(pParse, pSelect || pTrigger, iDb);
  101112. #ifndef SQLITE_OMIT_XFER_OPT
  101113. /* If the statement is of the form
  101114. **
  101115. ** INSERT INTO <table1> SELECT * FROM <table2>;
  101116. **
  101117. ** Then special optimizations can be applied that make the transfer
  101118. ** very fast and which reduce fragmentation of indices.
  101119. **
  101120. ** This is the 2nd template.
  101121. */
  101122. if( pColumn==0 && xferOptimization(pParse, pTab, pSelect, onError, iDb) ){
  101123. assert( !pTrigger );
  101124. assert( pList==0 );
  101125. goto insert_end;
  101126. }
  101127. #endif /* SQLITE_OMIT_XFER_OPT */
  101128. /* If this is an AUTOINCREMENT table, look up the sequence number in the
  101129. ** sqlite_sequence table and store it in memory cell regAutoinc.
  101130. */
  101131. regAutoinc = autoIncBegin(pParse, iDb, pTab);
  101132. /* Allocate registers for holding the rowid of the new row,
  101133. ** the content of the new row, and the assembled row record.
  101134. */
  101135. regRowid = regIns = pParse->nMem+1;
  101136. pParse->nMem += pTab->nCol + 1;
  101137. if( IsVirtual(pTab) ){
  101138. regRowid++;
  101139. pParse->nMem++;
  101140. }
  101141. regData = regRowid+1;
  101142. /* If the INSERT statement included an IDLIST term, then make sure
  101143. ** all elements of the IDLIST really are columns of the table and
  101144. ** remember the column indices.
  101145. **
  101146. ** If the table has an INTEGER PRIMARY KEY column and that column
  101147. ** is named in the IDLIST, then record in the ipkColumn variable
  101148. ** the index into IDLIST of the primary key column. ipkColumn is
  101149. ** the index of the primary key as it appears in IDLIST, not as
  101150. ** is appears in the original table. (The index of the INTEGER
  101151. ** PRIMARY KEY in the original table is pTab->iPKey.)
  101152. */
  101153. bIdListInOrder = (pTab->tabFlags & TF_OOOHidden)==0;
  101154. if( pColumn ){
  101155. for(i=0; i<pColumn->nId; i++){
  101156. pColumn->a[i].idx = -1;
  101157. }
  101158. for(i=0; i<pColumn->nId; i++){
  101159. for(j=0; j<pTab->nCol; j++){
  101160. if( sqlite3StrICmp(pColumn->a[i].zName, pTab->aCol[j].zName)==0 ){
  101161. pColumn->a[i].idx = j;
  101162. if( i!=j ) bIdListInOrder = 0;
  101163. if( j==pTab->iPKey ){
  101164. ipkColumn = i; assert( !withoutRowid );
  101165. }
  101166. break;
  101167. }
  101168. }
  101169. if( j>=pTab->nCol ){
  101170. if( sqlite3IsRowid(pColumn->a[i].zName) && !withoutRowid ){
  101171. ipkColumn = i;
  101172. bIdListInOrder = 0;
  101173. }else{
  101174. sqlite3ErrorMsg(pParse, "table %S has no column named %s",
  101175. pTabList, 0, pColumn->a[i].zName);
  101176. pParse->checkSchema = 1;
  101177. goto insert_cleanup;
  101178. }
  101179. }
  101180. }
  101181. }
  101182. /* Figure out how many columns of data are supplied. If the data
  101183. ** is coming from a SELECT statement, then generate a co-routine that
  101184. ** produces a single row of the SELECT on each invocation. The
  101185. ** co-routine is the common header to the 3rd and 4th templates.
  101186. */
  101187. if( pSelect ){
  101188. /* Data is coming from a SELECT or from a multi-row VALUES clause.
  101189. ** Generate a co-routine to run the SELECT. */
  101190. int regYield; /* Register holding co-routine entry-point */
  101191. int addrTop; /* Top of the co-routine */
  101192. int rc; /* Result code */
  101193. regYield = ++pParse->nMem;
  101194. addrTop = sqlite3VdbeCurrentAddr(v) + 1;
  101195. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
  101196. sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
  101197. dest.iSdst = bIdListInOrder ? regData : 0;
  101198. dest.nSdst = pTab->nCol;
  101199. rc = sqlite3Select(pParse, pSelect, &dest);
  101200. regFromSelect = dest.iSdst;
  101201. if( rc || db->mallocFailed || pParse->nErr ) goto insert_cleanup;
  101202. sqlite3VdbeEndCoroutine(v, regYield);
  101203. sqlite3VdbeJumpHere(v, addrTop - 1); /* label B: */
  101204. assert( pSelect->pEList );
  101205. nColumn = pSelect->pEList->nExpr;
  101206. /* Set useTempTable to TRUE if the result of the SELECT statement
  101207. ** should be written into a temporary table (template 4). Set to
  101208. ** FALSE if each output row of the SELECT can be written directly into
  101209. ** the destination table (template 3).
  101210. **
  101211. ** A temp table must be used if the table being updated is also one
  101212. ** of the tables being read by the SELECT statement. Also use a
  101213. ** temp table in the case of row triggers.
  101214. */
  101215. if( pTrigger || readsTable(pParse, iDb, pTab) ){
  101216. useTempTable = 1;
  101217. }
  101218. if( useTempTable ){
  101219. /* Invoke the coroutine to extract information from the SELECT
  101220. ** and add it to a transient table srcTab. The code generated
  101221. ** here is from the 4th template:
  101222. **
  101223. ** B: open temp table
  101224. ** L: yield X, goto M at EOF
  101225. ** insert row from R..R+n into temp table
  101226. ** goto L
  101227. ** M: ...
  101228. */
  101229. int regRec; /* Register to hold packed record */
  101230. int regTempRowid; /* Register to hold temp table ROWID */
  101231. int addrL; /* Label "L" */
  101232. srcTab = pParse->nTab++;
  101233. regRec = sqlite3GetTempReg(pParse);
  101234. regTempRowid = sqlite3GetTempReg(pParse);
  101235. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, srcTab, nColumn);
  101236. addrL = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm); VdbeCoverage(v);
  101237. sqlite3VdbeAddOp3(v, OP_MakeRecord, regFromSelect, nColumn, regRec);
  101238. sqlite3VdbeAddOp2(v, OP_NewRowid, srcTab, regTempRowid);
  101239. sqlite3VdbeAddOp3(v, OP_Insert, srcTab, regRec, regTempRowid);
  101240. sqlite3VdbeGoto(v, addrL);
  101241. sqlite3VdbeJumpHere(v, addrL);
  101242. sqlite3ReleaseTempReg(pParse, regRec);
  101243. sqlite3ReleaseTempReg(pParse, regTempRowid);
  101244. }
  101245. }else{
  101246. /* This is the case if the data for the INSERT is coming from a
  101247. ** single-row VALUES clause
  101248. */
  101249. NameContext sNC;
  101250. memset(&sNC, 0, sizeof(sNC));
  101251. sNC.pParse = pParse;
  101252. srcTab = -1;
  101253. assert( useTempTable==0 );
  101254. if( pList ){
  101255. nColumn = pList->nExpr;
  101256. if( sqlite3ResolveExprListNames(&sNC, pList) ){
  101257. goto insert_cleanup;
  101258. }
  101259. }else{
  101260. nColumn = 0;
  101261. }
  101262. }
  101263. /* If there is no IDLIST term but the table has an integer primary
  101264. ** key, the set the ipkColumn variable to the integer primary key
  101265. ** column index in the original table definition.
  101266. */
  101267. if( pColumn==0 && nColumn>0 ){
  101268. ipkColumn = pTab->iPKey;
  101269. }
  101270. /* Make sure the number of columns in the source data matches the number
  101271. ** of columns to be inserted into the table.
  101272. */
  101273. for(i=0; i<pTab->nCol; i++){
  101274. nHidden += (IsHiddenColumn(&pTab->aCol[i]) ? 1 : 0);
  101275. }
  101276. if( pColumn==0 && nColumn && nColumn!=(pTab->nCol-nHidden) ){
  101277. sqlite3ErrorMsg(pParse,
  101278. "table %S has %d columns but %d values were supplied",
  101279. pTabList, 0, pTab->nCol-nHidden, nColumn);
  101280. goto insert_cleanup;
  101281. }
  101282. if( pColumn!=0 && nColumn!=pColumn->nId ){
  101283. sqlite3ErrorMsg(pParse, "%d values for %d columns", nColumn, pColumn->nId);
  101284. goto insert_cleanup;
  101285. }
  101286. /* Initialize the count of rows to be inserted
  101287. */
  101288. if( db->flags & SQLITE_CountRows ){
  101289. regRowCount = ++pParse->nMem;
  101290. sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
  101291. }
  101292. /* If this is not a view, open the table and and all indices */
  101293. if( !isView ){
  101294. int nIdx;
  101295. nIdx = sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, -1, 0,
  101296. &iDataCur, &iIdxCur);
  101297. aRegIdx = sqlite3DbMallocRawNN(db, sizeof(int)*(nIdx+1));
  101298. if( aRegIdx==0 ){
  101299. goto insert_cleanup;
  101300. }
  101301. for(i=0; i<nIdx; i++){
  101302. aRegIdx[i] = ++pParse->nMem;
  101303. }
  101304. }
  101305. /* This is the top of the main insertion loop */
  101306. if( useTempTable ){
  101307. /* This block codes the top of loop only. The complete loop is the
  101308. ** following pseudocode (template 4):
  101309. **
  101310. ** rewind temp table, if empty goto D
  101311. ** C: loop over rows of intermediate table
  101312. ** transfer values form intermediate table into <table>
  101313. ** end loop
  101314. ** D: ...
  101315. */
  101316. addrInsTop = sqlite3VdbeAddOp1(v, OP_Rewind, srcTab); VdbeCoverage(v);
  101317. addrCont = sqlite3VdbeCurrentAddr(v);
  101318. }else if( pSelect ){
  101319. /* This block codes the top of loop only. The complete loop is the
  101320. ** following pseudocode (template 3):
  101321. **
  101322. ** C: yield X, at EOF goto D
  101323. ** insert the select result into <table> from R..R+n
  101324. ** goto C
  101325. ** D: ...
  101326. */
  101327. addrInsTop = addrCont = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
  101328. VdbeCoverage(v);
  101329. }
  101330. /* Run the BEFORE and INSTEAD OF triggers, if there are any
  101331. */
  101332. endOfLoop = sqlite3VdbeMakeLabel(v);
  101333. if( tmask & TRIGGER_BEFORE ){
  101334. int regCols = sqlite3GetTempRange(pParse, pTab->nCol+1);
  101335. /* build the NEW.* reference row. Note that if there is an INTEGER
  101336. ** PRIMARY KEY into which a NULL is being inserted, that NULL will be
  101337. ** translated into a unique ID for the row. But on a BEFORE trigger,
  101338. ** we do not know what the unique ID will be (because the insert has
  101339. ** not happened yet) so we substitute a rowid of -1
  101340. */
  101341. if( ipkColumn<0 ){
  101342. sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
  101343. }else{
  101344. int addr1;
  101345. assert( !withoutRowid );
  101346. if( useTempTable ){
  101347. sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regCols);
  101348. }else{
  101349. assert( pSelect==0 ); /* Otherwise useTempTable is true */
  101350. sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regCols);
  101351. }
  101352. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regCols); VdbeCoverage(v);
  101353. sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
  101354. sqlite3VdbeJumpHere(v, addr1);
  101355. sqlite3VdbeAddOp1(v, OP_MustBeInt, regCols); VdbeCoverage(v);
  101356. }
  101357. /* Cannot have triggers on a virtual table. If it were possible,
  101358. ** this block would have to account for hidden column.
  101359. */
  101360. assert( !IsVirtual(pTab) );
  101361. /* Create the new column data
  101362. */
  101363. for(i=j=0; i<pTab->nCol; i++){
  101364. if( pColumn ){
  101365. for(j=0; j<pColumn->nId; j++){
  101366. if( pColumn->a[j].idx==i ) break;
  101367. }
  101368. }
  101369. if( (!useTempTable && !pList) || (pColumn && j>=pColumn->nId)
  101370. || (pColumn==0 && IsOrdinaryHiddenColumn(&pTab->aCol[i])) ){
  101371. sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regCols+i+1);
  101372. }else if( useTempTable ){
  101373. sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, regCols+i+1);
  101374. }else{
  101375. assert( pSelect==0 ); /* Otherwise useTempTable is true */
  101376. sqlite3ExprCodeAndCache(pParse, pList->a[j].pExpr, regCols+i+1);
  101377. }
  101378. if( pColumn==0 && !IsOrdinaryHiddenColumn(&pTab->aCol[i]) ) j++;
  101379. }
  101380. /* If this is an INSERT on a view with an INSTEAD OF INSERT trigger,
  101381. ** do not attempt any conversions before assembling the record.
  101382. ** If this is a real table, attempt conversions as required by the
  101383. ** table column affinities.
  101384. */
  101385. if( !isView ){
  101386. sqlite3TableAffinity(v, pTab, regCols+1);
  101387. }
  101388. /* Fire BEFORE or INSTEAD OF triggers */
  101389. sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_BEFORE,
  101390. pTab, regCols-pTab->nCol-1, onError, endOfLoop);
  101391. sqlite3ReleaseTempRange(pParse, regCols, pTab->nCol+1);
  101392. }
  101393. /* Compute the content of the next row to insert into a range of
  101394. ** registers beginning at regIns.
  101395. */
  101396. if( !isView ){
  101397. if( IsVirtual(pTab) ){
  101398. /* The row that the VUpdate opcode will delete: none */
  101399. sqlite3VdbeAddOp2(v, OP_Null, 0, regIns);
  101400. }
  101401. if( ipkColumn>=0 ){
  101402. if( useTempTable ){
  101403. sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regRowid);
  101404. }else if( pSelect ){
  101405. sqlite3VdbeAddOp2(v, OP_Copy, regFromSelect+ipkColumn, regRowid);
  101406. }else{
  101407. VdbeOp *pOp;
  101408. sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regRowid);
  101409. pOp = sqlite3VdbeGetOp(v, -1);
  101410. if( ALWAYS(pOp) && pOp->opcode==OP_Null && !IsVirtual(pTab) ){
  101411. appendFlag = 1;
  101412. pOp->opcode = OP_NewRowid;
  101413. pOp->p1 = iDataCur;
  101414. pOp->p2 = regRowid;
  101415. pOp->p3 = regAutoinc;
  101416. }
  101417. }
  101418. /* If the PRIMARY KEY expression is NULL, then use OP_NewRowid
  101419. ** to generate a unique primary key value.
  101420. */
  101421. if( !appendFlag ){
  101422. int addr1;
  101423. if( !IsVirtual(pTab) ){
  101424. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regRowid); VdbeCoverage(v);
  101425. sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
  101426. sqlite3VdbeJumpHere(v, addr1);
  101427. }else{
  101428. addr1 = sqlite3VdbeCurrentAddr(v);
  101429. sqlite3VdbeAddOp2(v, OP_IsNull, regRowid, addr1+2); VdbeCoverage(v);
  101430. }
  101431. sqlite3VdbeAddOp1(v, OP_MustBeInt, regRowid); VdbeCoverage(v);
  101432. }
  101433. }else if( IsVirtual(pTab) || withoutRowid ){
  101434. sqlite3VdbeAddOp2(v, OP_Null, 0, regRowid);
  101435. }else{
  101436. sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
  101437. appendFlag = 1;
  101438. }
  101439. autoIncStep(pParse, regAutoinc, regRowid);
  101440. /* Compute data for all columns of the new entry, beginning
  101441. ** with the first column.
  101442. */
  101443. nHidden = 0;
  101444. for(i=0; i<pTab->nCol; i++){
  101445. int iRegStore = regRowid+1+i;
  101446. if( i==pTab->iPKey ){
  101447. /* The value of the INTEGER PRIMARY KEY column is always a NULL.
  101448. ** Whenever this column is read, the rowid will be substituted
  101449. ** in its place. Hence, fill this column with a NULL to avoid
  101450. ** taking up data space with information that will never be used.
  101451. ** As there may be shallow copies of this value, make it a soft-NULL */
  101452. sqlite3VdbeAddOp1(v, OP_SoftNull, iRegStore);
  101453. continue;
  101454. }
  101455. if( pColumn==0 ){
  101456. if( IsHiddenColumn(&pTab->aCol[i]) ){
  101457. j = -1;
  101458. nHidden++;
  101459. }else{
  101460. j = i - nHidden;
  101461. }
  101462. }else{
  101463. for(j=0; j<pColumn->nId; j++){
  101464. if( pColumn->a[j].idx==i ) break;
  101465. }
  101466. }
  101467. if( j<0 || nColumn==0 || (pColumn && j>=pColumn->nId) ){
  101468. sqlite3ExprCodeFactorable(pParse, pTab->aCol[i].pDflt, iRegStore);
  101469. }else if( useTempTable ){
  101470. sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, iRegStore);
  101471. }else if( pSelect ){
  101472. if( regFromSelect!=regData ){
  101473. sqlite3VdbeAddOp2(v, OP_SCopy, regFromSelect+j, iRegStore);
  101474. }
  101475. }else{
  101476. sqlite3ExprCode(pParse, pList->a[j].pExpr, iRegStore);
  101477. }
  101478. }
  101479. /* Generate code to check constraints and generate index keys and
  101480. ** do the insertion.
  101481. */
  101482. #ifndef SQLITE_OMIT_VIRTUALTABLE
  101483. if( IsVirtual(pTab) ){
  101484. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  101485. sqlite3VtabMakeWritable(pParse, pTab);
  101486. sqlite3VdbeAddOp4(v, OP_VUpdate, 1, pTab->nCol+2, regIns, pVTab, P4_VTAB);
  101487. sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
  101488. sqlite3MayAbort(pParse);
  101489. }else
  101490. #endif
  101491. {
  101492. int isReplace; /* Set to true if constraints may cause a replace */
  101493. sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
  101494. regIns, 0, ipkColumn>=0, onError, endOfLoop, &isReplace, 0
  101495. );
  101496. sqlite3FkCheck(pParse, pTab, 0, regIns, 0, 0);
  101497. sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
  101498. regIns, aRegIdx, 0, appendFlag, isReplace==0);
  101499. }
  101500. }
  101501. /* Update the count of rows that are inserted
  101502. */
  101503. if( (db->flags & SQLITE_CountRows)!=0 ){
  101504. sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
  101505. }
  101506. if( pTrigger ){
  101507. /* Code AFTER triggers */
  101508. sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_AFTER,
  101509. pTab, regData-2-pTab->nCol, onError, endOfLoop);
  101510. }
  101511. /* The bottom of the main insertion loop, if the data source
  101512. ** is a SELECT statement.
  101513. */
  101514. sqlite3VdbeResolveLabel(v, endOfLoop);
  101515. if( useTempTable ){
  101516. sqlite3VdbeAddOp2(v, OP_Next, srcTab, addrCont); VdbeCoverage(v);
  101517. sqlite3VdbeJumpHere(v, addrInsTop);
  101518. sqlite3VdbeAddOp1(v, OP_Close, srcTab);
  101519. }else if( pSelect ){
  101520. sqlite3VdbeGoto(v, addrCont);
  101521. sqlite3VdbeJumpHere(v, addrInsTop);
  101522. }
  101523. if( !IsVirtual(pTab) && !isView ){
  101524. /* Close all tables opened */
  101525. if( iDataCur<iIdxCur ) sqlite3VdbeAddOp1(v, OP_Close, iDataCur);
  101526. for(idx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, idx++){
  101527. sqlite3VdbeAddOp1(v, OP_Close, idx+iIdxCur);
  101528. }
  101529. }
  101530. insert_end:
  101531. /* Update the sqlite_sequence table by storing the content of the
  101532. ** maximum rowid counter values recorded while inserting into
  101533. ** autoincrement tables.
  101534. */
  101535. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  101536. sqlite3AutoincrementEnd(pParse);
  101537. }
  101538. /*
  101539. ** Return the number of rows inserted. If this routine is
  101540. ** generating code because of a call to sqlite3NestedParse(), do not
  101541. ** invoke the callback function.
  101542. */
  101543. if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
  101544. sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
  101545. sqlite3VdbeSetNumCols(v, 1);
  101546. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows inserted", SQLITE_STATIC);
  101547. }
  101548. insert_cleanup:
  101549. sqlite3SrcListDelete(db, pTabList);
  101550. sqlite3ExprListDelete(db, pList);
  101551. sqlite3SelectDelete(db, pSelect);
  101552. sqlite3IdListDelete(db, pColumn);
  101553. sqlite3DbFree(db, aRegIdx);
  101554. }
  101555. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  101556. ** they may interfere with compilation of other functions in this file
  101557. ** (or in another file, if this file becomes part of the amalgamation). */
  101558. #ifdef isView
  101559. #undef isView
  101560. #endif
  101561. #ifdef pTrigger
  101562. #undef pTrigger
  101563. #endif
  101564. #ifdef tmask
  101565. #undef tmask
  101566. #endif
  101567. /*
  101568. ** Meanings of bits in of pWalker->eCode for checkConstraintUnchanged()
  101569. */
  101570. #define CKCNSTRNT_COLUMN 0x01 /* CHECK constraint uses a changing column */
  101571. #define CKCNSTRNT_ROWID 0x02 /* CHECK constraint references the ROWID */
  101572. /* This is the Walker callback from checkConstraintUnchanged(). Set
  101573. ** bit 0x01 of pWalker->eCode if
  101574. ** pWalker->eCode to 0 if this expression node references any of the
  101575. ** columns that are being modifed by an UPDATE statement.
  101576. */
  101577. static int checkConstraintExprNode(Walker *pWalker, Expr *pExpr){
  101578. if( pExpr->op==TK_COLUMN ){
  101579. assert( pExpr->iColumn>=0 || pExpr->iColumn==-1 );
  101580. if( pExpr->iColumn>=0 ){
  101581. if( pWalker->u.aiCol[pExpr->iColumn]>=0 ){
  101582. pWalker->eCode |= CKCNSTRNT_COLUMN;
  101583. }
  101584. }else{
  101585. pWalker->eCode |= CKCNSTRNT_ROWID;
  101586. }
  101587. }
  101588. return WRC_Continue;
  101589. }
  101590. /*
  101591. ** pExpr is a CHECK constraint on a row that is being UPDATE-ed. The
  101592. ** only columns that are modified by the UPDATE are those for which
  101593. ** aiChng[i]>=0, and also the ROWID is modified if chngRowid is true.
  101594. **
  101595. ** Return true if CHECK constraint pExpr does not use any of the
  101596. ** changing columns (or the rowid if it is changing). In other words,
  101597. ** return true if this CHECK constraint can be skipped when validating
  101598. ** the new row in the UPDATE statement.
  101599. */
  101600. static int checkConstraintUnchanged(Expr *pExpr, int *aiChng, int chngRowid){
  101601. Walker w;
  101602. memset(&w, 0, sizeof(w));
  101603. w.eCode = 0;
  101604. w.xExprCallback = checkConstraintExprNode;
  101605. w.u.aiCol = aiChng;
  101606. sqlite3WalkExpr(&w, pExpr);
  101607. if( !chngRowid ){
  101608. testcase( (w.eCode & CKCNSTRNT_ROWID)!=0 );
  101609. w.eCode &= ~CKCNSTRNT_ROWID;
  101610. }
  101611. testcase( w.eCode==0 );
  101612. testcase( w.eCode==CKCNSTRNT_COLUMN );
  101613. testcase( w.eCode==CKCNSTRNT_ROWID );
  101614. testcase( w.eCode==(CKCNSTRNT_ROWID|CKCNSTRNT_COLUMN) );
  101615. return !w.eCode;
  101616. }
  101617. /*
  101618. ** Generate code to do constraint checks prior to an INSERT or an UPDATE
  101619. ** on table pTab.
  101620. **
  101621. ** The regNewData parameter is the first register in a range that contains
  101622. ** the data to be inserted or the data after the update. There will be
  101623. ** pTab->nCol+1 registers in this range. The first register (the one
  101624. ** that regNewData points to) will contain the new rowid, or NULL in the
  101625. ** case of a WITHOUT ROWID table. The second register in the range will
  101626. ** contain the content of the first table column. The third register will
  101627. ** contain the content of the second table column. And so forth.
  101628. **
  101629. ** The regOldData parameter is similar to regNewData except that it contains
  101630. ** the data prior to an UPDATE rather than afterwards. regOldData is zero
  101631. ** for an INSERT. This routine can distinguish between UPDATE and INSERT by
  101632. ** checking regOldData for zero.
  101633. **
  101634. ** For an UPDATE, the pkChng boolean is true if the true primary key (the
  101635. ** rowid for a normal table or the PRIMARY KEY for a WITHOUT ROWID table)
  101636. ** might be modified by the UPDATE. If pkChng is false, then the key of
  101637. ** the iDataCur content table is guaranteed to be unchanged by the UPDATE.
  101638. **
  101639. ** For an INSERT, the pkChng boolean indicates whether or not the rowid
  101640. ** was explicitly specified as part of the INSERT statement. If pkChng
  101641. ** is zero, it means that the either rowid is computed automatically or
  101642. ** that the table is a WITHOUT ROWID table and has no rowid. On an INSERT,
  101643. ** pkChng will only be true if the INSERT statement provides an integer
  101644. ** value for either the rowid column or its INTEGER PRIMARY KEY alias.
  101645. **
  101646. ** The code generated by this routine will store new index entries into
  101647. ** registers identified by aRegIdx[]. No index entry is created for
  101648. ** indices where aRegIdx[i]==0. The order of indices in aRegIdx[] is
  101649. ** the same as the order of indices on the linked list of indices
  101650. ** at pTab->pIndex.
  101651. **
  101652. ** The caller must have already opened writeable cursors on the main
  101653. ** table and all applicable indices (that is to say, all indices for which
  101654. ** aRegIdx[] is not zero). iDataCur is the cursor for the main table when
  101655. ** inserting or updating a rowid table, or the cursor for the PRIMARY KEY
  101656. ** index when operating on a WITHOUT ROWID table. iIdxCur is the cursor
  101657. ** for the first index in the pTab->pIndex list. Cursors for other indices
  101658. ** are at iIdxCur+N for the N-th element of the pTab->pIndex list.
  101659. **
  101660. ** This routine also generates code to check constraints. NOT NULL,
  101661. ** CHECK, and UNIQUE constraints are all checked. If a constraint fails,
  101662. ** then the appropriate action is performed. There are five possible
  101663. ** actions: ROLLBACK, ABORT, FAIL, REPLACE, and IGNORE.
  101664. **
  101665. ** Constraint type Action What Happens
  101666. ** --------------- ---------- ----------------------------------------
  101667. ** any ROLLBACK The current transaction is rolled back and
  101668. ** sqlite3_step() returns immediately with a
  101669. ** return code of SQLITE_CONSTRAINT.
  101670. **
  101671. ** any ABORT Back out changes from the current command
  101672. ** only (do not do a complete rollback) then
  101673. ** cause sqlite3_step() to return immediately
  101674. ** with SQLITE_CONSTRAINT.
  101675. **
  101676. ** any FAIL Sqlite3_step() returns immediately with a
  101677. ** return code of SQLITE_CONSTRAINT. The
  101678. ** transaction is not rolled back and any
  101679. ** changes to prior rows are retained.
  101680. **
  101681. ** any IGNORE The attempt in insert or update the current
  101682. ** row is skipped, without throwing an error.
  101683. ** Processing continues with the next row.
  101684. ** (There is an immediate jump to ignoreDest.)
  101685. **
  101686. ** NOT NULL REPLACE The NULL value is replace by the default
  101687. ** value for that column. If the default value
  101688. ** is NULL, the action is the same as ABORT.
  101689. **
  101690. ** UNIQUE REPLACE The other row that conflicts with the row
  101691. ** being inserted is removed.
  101692. **
  101693. ** CHECK REPLACE Illegal. The results in an exception.
  101694. **
  101695. ** Which action to take is determined by the overrideError parameter.
  101696. ** Or if overrideError==OE_Default, then the pParse->onError parameter
  101697. ** is used. Or if pParse->onError==OE_Default then the onError value
  101698. ** for the constraint is used.
  101699. */
  101700. SQLITE_PRIVATE void sqlite3GenerateConstraintChecks(
  101701. Parse *pParse, /* The parser context */
  101702. Table *pTab, /* The table being inserted or updated */
  101703. int *aRegIdx, /* Use register aRegIdx[i] for index i. 0 for unused */
  101704. int iDataCur, /* Canonical data cursor (main table or PK index) */
  101705. int iIdxCur, /* First index cursor */
  101706. int regNewData, /* First register in a range holding values to insert */
  101707. int regOldData, /* Previous content. 0 for INSERTs */
  101708. u8 pkChng, /* Non-zero if the rowid or PRIMARY KEY changed */
  101709. u8 overrideError, /* Override onError to this if not OE_Default */
  101710. int ignoreDest, /* Jump to this label on an OE_Ignore resolution */
  101711. int *pbMayReplace, /* OUT: Set to true if constraint may cause a replace */
  101712. int *aiChng /* column i is unchanged if aiChng[i]<0 */
  101713. ){
  101714. Vdbe *v; /* VDBE under constrution */
  101715. Index *pIdx; /* Pointer to one of the indices */
  101716. Index *pPk = 0; /* The PRIMARY KEY index */
  101717. sqlite3 *db; /* Database connection */
  101718. int i; /* loop counter */
  101719. int ix; /* Index loop counter */
  101720. int nCol; /* Number of columns */
  101721. int onError; /* Conflict resolution strategy */
  101722. int addr1; /* Address of jump instruction */
  101723. int seenReplace = 0; /* True if REPLACE is used to resolve INT PK conflict */
  101724. int nPkField; /* Number of fields in PRIMARY KEY. 1 for ROWID tables */
  101725. int ipkTop = 0; /* Top of the rowid change constraint check */
  101726. int ipkBottom = 0; /* Bottom of the rowid change constraint check */
  101727. u8 isUpdate; /* True if this is an UPDATE operation */
  101728. u8 bAffinityDone = 0; /* True if the OP_Affinity operation has been run */
  101729. int regRowid = -1; /* Register holding ROWID value */
  101730. isUpdate = regOldData!=0;
  101731. db = pParse->db;
  101732. v = sqlite3GetVdbe(pParse);
  101733. assert( v!=0 );
  101734. assert( pTab->pSelect==0 ); /* This table is not a VIEW */
  101735. nCol = pTab->nCol;
  101736. /* pPk is the PRIMARY KEY index for WITHOUT ROWID tables and NULL for
  101737. ** normal rowid tables. nPkField is the number of key fields in the
  101738. ** pPk index or 1 for a rowid table. In other words, nPkField is the
  101739. ** number of fields in the true primary key of the table. */
  101740. if( HasRowid(pTab) ){
  101741. pPk = 0;
  101742. nPkField = 1;
  101743. }else{
  101744. pPk = sqlite3PrimaryKeyIndex(pTab);
  101745. nPkField = pPk->nKeyCol;
  101746. }
  101747. /* Record that this module has started */
  101748. VdbeModuleComment((v, "BEGIN: GenCnstCks(%d,%d,%d,%d,%d)",
  101749. iDataCur, iIdxCur, regNewData, regOldData, pkChng));
  101750. /* Test all NOT NULL constraints.
  101751. */
  101752. for(i=0; i<nCol; i++){
  101753. if( i==pTab->iPKey ){
  101754. continue; /* ROWID is never NULL */
  101755. }
  101756. if( aiChng && aiChng[i]<0 ){
  101757. /* Don't bother checking for NOT NULL on columns that do not change */
  101758. continue;
  101759. }
  101760. onError = pTab->aCol[i].notNull;
  101761. if( onError==OE_None ) continue; /* This column is allowed to be NULL */
  101762. if( overrideError!=OE_Default ){
  101763. onError = overrideError;
  101764. }else if( onError==OE_Default ){
  101765. onError = OE_Abort;
  101766. }
  101767. if( onError==OE_Replace && pTab->aCol[i].pDflt==0 ){
  101768. onError = OE_Abort;
  101769. }
  101770. assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
  101771. || onError==OE_Ignore || onError==OE_Replace );
  101772. switch( onError ){
  101773. case OE_Abort:
  101774. sqlite3MayAbort(pParse);
  101775. /* Fall through */
  101776. case OE_Rollback:
  101777. case OE_Fail: {
  101778. char *zMsg = sqlite3MPrintf(db, "%s.%s", pTab->zName,
  101779. pTab->aCol[i].zName);
  101780. sqlite3VdbeAddOp4(v, OP_HaltIfNull, SQLITE_CONSTRAINT_NOTNULL, onError,
  101781. regNewData+1+i, zMsg, P4_DYNAMIC);
  101782. sqlite3VdbeChangeP5(v, P5_ConstraintNotNull);
  101783. VdbeCoverage(v);
  101784. break;
  101785. }
  101786. case OE_Ignore: {
  101787. sqlite3VdbeAddOp2(v, OP_IsNull, regNewData+1+i, ignoreDest);
  101788. VdbeCoverage(v);
  101789. break;
  101790. }
  101791. default: {
  101792. assert( onError==OE_Replace );
  101793. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regNewData+1+i);
  101794. VdbeCoverage(v);
  101795. sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regNewData+1+i);
  101796. sqlite3VdbeJumpHere(v, addr1);
  101797. break;
  101798. }
  101799. }
  101800. }
  101801. /* Test all CHECK constraints
  101802. */
  101803. #ifndef SQLITE_OMIT_CHECK
  101804. if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
  101805. ExprList *pCheck = pTab->pCheck;
  101806. pParse->ckBase = regNewData+1;
  101807. onError = overrideError!=OE_Default ? overrideError : OE_Abort;
  101808. for(i=0; i<pCheck->nExpr; i++){
  101809. int allOk;
  101810. Expr *pExpr = pCheck->a[i].pExpr;
  101811. if( aiChng && checkConstraintUnchanged(pExpr, aiChng, pkChng) ) continue;
  101812. allOk = sqlite3VdbeMakeLabel(v);
  101813. sqlite3ExprIfTrue(pParse, pExpr, allOk, SQLITE_JUMPIFNULL);
  101814. if( onError==OE_Ignore ){
  101815. sqlite3VdbeGoto(v, ignoreDest);
  101816. }else{
  101817. char *zName = pCheck->a[i].zName;
  101818. if( zName==0 ) zName = pTab->zName;
  101819. if( onError==OE_Replace ) onError = OE_Abort; /* IMP: R-15569-63625 */
  101820. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_CHECK,
  101821. onError, zName, P4_TRANSIENT,
  101822. P5_ConstraintCheck);
  101823. }
  101824. sqlite3VdbeResolveLabel(v, allOk);
  101825. }
  101826. }
  101827. #endif /* !defined(SQLITE_OMIT_CHECK) */
  101828. /* If rowid is changing, make sure the new rowid does not previously
  101829. ** exist in the table.
  101830. */
  101831. if( pkChng && pPk==0 ){
  101832. int addrRowidOk = sqlite3VdbeMakeLabel(v);
  101833. /* Figure out what action to take in case of a rowid collision */
  101834. onError = pTab->keyConf;
  101835. if( overrideError!=OE_Default ){
  101836. onError = overrideError;
  101837. }else if( onError==OE_Default ){
  101838. onError = OE_Abort;
  101839. }
  101840. if( isUpdate ){
  101841. /* pkChng!=0 does not mean that the rowid has change, only that
  101842. ** it might have changed. Skip the conflict logic below if the rowid
  101843. ** is unchanged. */
  101844. sqlite3VdbeAddOp3(v, OP_Eq, regNewData, addrRowidOk, regOldData);
  101845. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  101846. VdbeCoverage(v);
  101847. }
  101848. /* If the response to a rowid conflict is REPLACE but the response
  101849. ** to some other UNIQUE constraint is FAIL or IGNORE, then we need
  101850. ** to defer the running of the rowid conflict checking until after
  101851. ** the UNIQUE constraints have run.
  101852. */
  101853. if( onError==OE_Replace && overrideError!=OE_Replace ){
  101854. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  101855. if( pIdx->onError==OE_Ignore || pIdx->onError==OE_Fail ){
  101856. ipkTop = sqlite3VdbeAddOp0(v, OP_Goto);
  101857. break;
  101858. }
  101859. }
  101860. }
  101861. /* Check to see if the new rowid already exists in the table. Skip
  101862. ** the following conflict logic if it does not. */
  101863. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, addrRowidOk, regNewData);
  101864. VdbeCoverage(v);
  101865. /* Generate code that deals with a rowid collision */
  101866. switch( onError ){
  101867. default: {
  101868. onError = OE_Abort;
  101869. /* Fall thru into the next case */
  101870. }
  101871. case OE_Rollback:
  101872. case OE_Abort:
  101873. case OE_Fail: {
  101874. sqlite3RowidConstraint(pParse, onError, pTab);
  101875. break;
  101876. }
  101877. case OE_Replace: {
  101878. /* If there are DELETE triggers on this table and the
  101879. ** recursive-triggers flag is set, call GenerateRowDelete() to
  101880. ** remove the conflicting row from the table. This will fire
  101881. ** the triggers and remove both the table and index b-tree entries.
  101882. **
  101883. ** Otherwise, if there are no triggers or the recursive-triggers
  101884. ** flag is not set, but the table has one or more indexes, call
  101885. ** GenerateRowIndexDelete(). This removes the index b-tree entries
  101886. ** only. The table b-tree entry will be replaced by the new entry
  101887. ** when it is inserted.
  101888. **
  101889. ** If either GenerateRowDelete() or GenerateRowIndexDelete() is called,
  101890. ** also invoke MultiWrite() to indicate that this VDBE may require
  101891. ** statement rollback (if the statement is aborted after the delete
  101892. ** takes place). Earlier versions called sqlite3MultiWrite() regardless,
  101893. ** but being more selective here allows statements like:
  101894. **
  101895. ** REPLACE INTO t(rowid) VALUES($newrowid)
  101896. **
  101897. ** to run without a statement journal if there are no indexes on the
  101898. ** table.
  101899. */
  101900. Trigger *pTrigger = 0;
  101901. if( db->flags&SQLITE_RecTriggers ){
  101902. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  101903. }
  101904. if( pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0) ){
  101905. sqlite3MultiWrite(pParse);
  101906. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  101907. regNewData, 1, 0, OE_Replace, 1, -1);
  101908. }else{
  101909. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  101910. if( HasRowid(pTab) ){
  101911. /* This OP_Delete opcode fires the pre-update-hook only. It does
  101912. ** not modify the b-tree. It is more efficient to let the coming
  101913. ** OP_Insert replace the existing entry than it is to delete the
  101914. ** existing entry and then insert a new one. */
  101915. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, OPFLAG_ISNOOP);
  101916. sqlite3VdbeChangeP4(v, -1, (char *)pTab, P4_TABLE);
  101917. }
  101918. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  101919. if( pTab->pIndex ){
  101920. sqlite3MultiWrite(pParse);
  101921. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,-1);
  101922. }
  101923. }
  101924. seenReplace = 1;
  101925. break;
  101926. }
  101927. case OE_Ignore: {
  101928. /*assert( seenReplace==0 );*/
  101929. sqlite3VdbeGoto(v, ignoreDest);
  101930. break;
  101931. }
  101932. }
  101933. sqlite3VdbeResolveLabel(v, addrRowidOk);
  101934. if( ipkTop ){
  101935. ipkBottom = sqlite3VdbeAddOp0(v, OP_Goto);
  101936. sqlite3VdbeJumpHere(v, ipkTop);
  101937. }
  101938. }
  101939. /* Test all UNIQUE constraints by creating entries for each UNIQUE
  101940. ** index and making sure that duplicate entries do not already exist.
  101941. ** Compute the revised record entries for indices as we go.
  101942. **
  101943. ** This loop also handles the case of the PRIMARY KEY index for a
  101944. ** WITHOUT ROWID table.
  101945. */
  101946. for(ix=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, ix++){
  101947. int regIdx; /* Range of registers hold conent for pIdx */
  101948. int regR; /* Range of registers holding conflicting PK */
  101949. int iThisCur; /* Cursor for this UNIQUE index */
  101950. int addrUniqueOk; /* Jump here if the UNIQUE constraint is satisfied */
  101951. if( aRegIdx[ix]==0 ) continue; /* Skip indices that do not change */
  101952. if( bAffinityDone==0 ){
  101953. sqlite3TableAffinity(v, pTab, regNewData+1);
  101954. bAffinityDone = 1;
  101955. }
  101956. iThisCur = iIdxCur+ix;
  101957. addrUniqueOk = sqlite3VdbeMakeLabel(v);
  101958. /* Skip partial indices for which the WHERE clause is not true */
  101959. if( pIdx->pPartIdxWhere ){
  101960. sqlite3VdbeAddOp2(v, OP_Null, 0, aRegIdx[ix]);
  101961. pParse->ckBase = regNewData+1;
  101962. sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, addrUniqueOk,
  101963. SQLITE_JUMPIFNULL);
  101964. pParse->ckBase = 0;
  101965. }
  101966. /* Create a record for this index entry as it should appear after
  101967. ** the insert or update. Store that record in the aRegIdx[ix] register
  101968. */
  101969. regIdx = sqlite3GetTempRange(pParse, pIdx->nColumn);
  101970. for(i=0; i<pIdx->nColumn; i++){
  101971. int iField = pIdx->aiColumn[i];
  101972. int x;
  101973. if( iField==XN_EXPR ){
  101974. pParse->ckBase = regNewData+1;
  101975. sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[i].pExpr, regIdx+i);
  101976. pParse->ckBase = 0;
  101977. VdbeComment((v, "%s column %d", pIdx->zName, i));
  101978. }else{
  101979. if( iField==XN_ROWID || iField==pTab->iPKey ){
  101980. if( regRowid==regIdx+i ) continue; /* ROWID already in regIdx+i */
  101981. x = regNewData;
  101982. regRowid = pIdx->pPartIdxWhere ? -1 : regIdx+i;
  101983. }else{
  101984. x = iField + regNewData + 1;
  101985. }
  101986. sqlite3VdbeAddOp2(v, iField<0 ? OP_IntCopy : OP_SCopy, x, regIdx+i);
  101987. VdbeComment((v, "%s", iField<0 ? "rowid" : pTab->aCol[iField].zName));
  101988. }
  101989. }
  101990. sqlite3VdbeAddOp3(v, OP_MakeRecord, regIdx, pIdx->nColumn, aRegIdx[ix]);
  101991. VdbeComment((v, "for %s", pIdx->zName));
  101992. sqlite3ExprCacheAffinityChange(pParse, regIdx, pIdx->nColumn);
  101993. /* In an UPDATE operation, if this index is the PRIMARY KEY index
  101994. ** of a WITHOUT ROWID table and there has been no change the
  101995. ** primary key, then no collision is possible. The collision detection
  101996. ** logic below can all be skipped. */
  101997. if( isUpdate && pPk==pIdx && pkChng==0 ){
  101998. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  101999. continue;
  102000. }
  102001. /* Find out what action to take in case there is a uniqueness conflict */
  102002. onError = pIdx->onError;
  102003. if( onError==OE_None ){
  102004. sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
  102005. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  102006. continue; /* pIdx is not a UNIQUE index */
  102007. }
  102008. if( overrideError!=OE_Default ){
  102009. onError = overrideError;
  102010. }else if( onError==OE_Default ){
  102011. onError = OE_Abort;
  102012. }
  102013. /* Check to see if the new index entry will be unique */
  102014. sqlite3VdbeAddOp4Int(v, OP_NoConflict, iThisCur, addrUniqueOk,
  102015. regIdx, pIdx->nKeyCol); VdbeCoverage(v);
  102016. /* Generate code to handle collisions */
  102017. regR = (pIdx==pPk) ? regIdx : sqlite3GetTempRange(pParse, nPkField);
  102018. if( isUpdate || onError==OE_Replace ){
  102019. if( HasRowid(pTab) ){
  102020. sqlite3VdbeAddOp2(v, OP_IdxRowid, iThisCur, regR);
  102021. /* Conflict only if the rowid of the existing index entry
  102022. ** is different from old-rowid */
  102023. if( isUpdate ){
  102024. sqlite3VdbeAddOp3(v, OP_Eq, regR, addrUniqueOk, regOldData);
  102025. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  102026. VdbeCoverage(v);
  102027. }
  102028. }else{
  102029. int x;
  102030. /* Extract the PRIMARY KEY from the end of the index entry and
  102031. ** store it in registers regR..regR+nPk-1 */
  102032. if( pIdx!=pPk ){
  102033. for(i=0; i<pPk->nKeyCol; i++){
  102034. assert( pPk->aiColumn[i]>=0 );
  102035. x = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[i]);
  102036. sqlite3VdbeAddOp3(v, OP_Column, iThisCur, x, regR+i);
  102037. VdbeComment((v, "%s.%s", pTab->zName,
  102038. pTab->aCol[pPk->aiColumn[i]].zName));
  102039. }
  102040. }
  102041. if( isUpdate ){
  102042. /* If currently processing the PRIMARY KEY of a WITHOUT ROWID
  102043. ** table, only conflict if the new PRIMARY KEY values are actually
  102044. ** different from the old.
  102045. **
  102046. ** For a UNIQUE index, only conflict if the PRIMARY KEY values
  102047. ** of the matched index row are different from the original PRIMARY
  102048. ** KEY values of this row before the update. */
  102049. int addrJump = sqlite3VdbeCurrentAddr(v)+pPk->nKeyCol;
  102050. int op = OP_Ne;
  102051. int regCmp = (IsPrimaryKeyIndex(pIdx) ? regIdx : regR);
  102052. for(i=0; i<pPk->nKeyCol; i++){
  102053. char *p4 = (char*)sqlite3LocateCollSeq(pParse, pPk->azColl[i]);
  102054. x = pPk->aiColumn[i];
  102055. assert( x>=0 );
  102056. if( i==(pPk->nKeyCol-1) ){
  102057. addrJump = addrUniqueOk;
  102058. op = OP_Eq;
  102059. }
  102060. sqlite3VdbeAddOp4(v, op,
  102061. regOldData+1+x, addrJump, regCmp+i, p4, P4_COLLSEQ
  102062. );
  102063. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  102064. VdbeCoverageIf(v, op==OP_Eq);
  102065. VdbeCoverageIf(v, op==OP_Ne);
  102066. }
  102067. }
  102068. }
  102069. }
  102070. /* Generate code that executes if the new index entry is not unique */
  102071. assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
  102072. || onError==OE_Ignore || onError==OE_Replace );
  102073. switch( onError ){
  102074. case OE_Rollback:
  102075. case OE_Abort:
  102076. case OE_Fail: {
  102077. sqlite3UniqueConstraint(pParse, onError, pIdx);
  102078. break;
  102079. }
  102080. case OE_Ignore: {
  102081. sqlite3VdbeGoto(v, ignoreDest);
  102082. break;
  102083. }
  102084. default: {
  102085. Trigger *pTrigger = 0;
  102086. assert( onError==OE_Replace );
  102087. sqlite3MultiWrite(pParse);
  102088. if( db->flags&SQLITE_RecTriggers ){
  102089. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  102090. }
  102091. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  102092. regR, nPkField, 0, OE_Replace,
  102093. (pIdx==pPk ? ONEPASS_SINGLE : ONEPASS_OFF), -1);
  102094. seenReplace = 1;
  102095. break;
  102096. }
  102097. }
  102098. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  102099. sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
  102100. if( regR!=regIdx ) sqlite3ReleaseTempRange(pParse, regR, nPkField);
  102101. }
  102102. if( ipkTop ){
  102103. sqlite3VdbeGoto(v, ipkTop+1);
  102104. sqlite3VdbeJumpHere(v, ipkBottom);
  102105. }
  102106. *pbMayReplace = seenReplace;
  102107. VdbeModuleComment((v, "END: GenCnstCks(%d)", seenReplace));
  102108. }
  102109. /*
  102110. ** This routine generates code to finish the INSERT or UPDATE operation
  102111. ** that was started by a prior call to sqlite3GenerateConstraintChecks.
  102112. ** A consecutive range of registers starting at regNewData contains the
  102113. ** rowid and the content to be inserted.
  102114. **
  102115. ** The arguments to this routine should be the same as the first six
  102116. ** arguments to sqlite3GenerateConstraintChecks.
  102117. */
  102118. SQLITE_PRIVATE void sqlite3CompleteInsertion(
  102119. Parse *pParse, /* The parser context */
  102120. Table *pTab, /* the table into which we are inserting */
  102121. int iDataCur, /* Cursor of the canonical data source */
  102122. int iIdxCur, /* First index cursor */
  102123. int regNewData, /* Range of content */
  102124. int *aRegIdx, /* Register used by each index. 0 for unused indices */
  102125. int isUpdate, /* True for UPDATE, False for INSERT */
  102126. int appendBias, /* True if this is likely to be an append */
  102127. int useSeekResult /* True to set the USESEEKRESULT flag on OP_[Idx]Insert */
  102128. ){
  102129. Vdbe *v; /* Prepared statements under construction */
  102130. Index *pIdx; /* An index being inserted or updated */
  102131. u8 pik_flags; /* flag values passed to the btree insert */
  102132. int regData; /* Content registers (after the rowid) */
  102133. int regRec; /* Register holding assembled record for the table */
  102134. int i; /* Loop counter */
  102135. u8 bAffinityDone = 0; /* True if OP_Affinity has been run already */
  102136. v = sqlite3GetVdbe(pParse);
  102137. assert( v!=0 );
  102138. assert( pTab->pSelect==0 ); /* This table is not a VIEW */
  102139. for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
  102140. if( aRegIdx[i]==0 ) continue;
  102141. bAffinityDone = 1;
  102142. if( pIdx->pPartIdxWhere ){
  102143. sqlite3VdbeAddOp2(v, OP_IsNull, aRegIdx[i], sqlite3VdbeCurrentAddr(v)+2);
  102144. VdbeCoverage(v);
  102145. }
  102146. sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdxCur+i, aRegIdx[i]);
  102147. pik_flags = 0;
  102148. if( useSeekResult ) pik_flags = OPFLAG_USESEEKRESULT;
  102149. if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
  102150. assert( pParse->nested==0 );
  102151. pik_flags |= OPFLAG_NCHANGE;
  102152. }
  102153. sqlite3VdbeChangeP5(v, pik_flags);
  102154. }
  102155. if( !HasRowid(pTab) ) return;
  102156. regData = regNewData + 1;
  102157. regRec = sqlite3GetTempReg(pParse);
  102158. sqlite3VdbeAddOp3(v, OP_MakeRecord, regData, pTab->nCol, regRec);
  102159. if( !bAffinityDone ) sqlite3TableAffinity(v, pTab, 0);
  102160. sqlite3ExprCacheAffinityChange(pParse, regData, pTab->nCol);
  102161. if( pParse->nested ){
  102162. pik_flags = 0;
  102163. }else{
  102164. pik_flags = OPFLAG_NCHANGE;
  102165. pik_flags |= (isUpdate?OPFLAG_ISUPDATE:OPFLAG_LASTROWID);
  102166. }
  102167. if( appendBias ){
  102168. pik_flags |= OPFLAG_APPEND;
  102169. }
  102170. if( useSeekResult ){
  102171. pik_flags |= OPFLAG_USESEEKRESULT;
  102172. }
  102173. sqlite3VdbeAddOp3(v, OP_Insert, iDataCur, regRec, regNewData);
  102174. if( !pParse->nested ){
  102175. sqlite3VdbeChangeP4(v, -1, (char *)pTab, P4_TABLE);
  102176. }
  102177. sqlite3VdbeChangeP5(v, pik_flags);
  102178. }
  102179. /*
  102180. ** Allocate cursors for the pTab table and all its indices and generate
  102181. ** code to open and initialized those cursors.
  102182. **
  102183. ** The cursor for the object that contains the complete data (normally
  102184. ** the table itself, but the PRIMARY KEY index in the case of a WITHOUT
  102185. ** ROWID table) is returned in *piDataCur. The first index cursor is
  102186. ** returned in *piIdxCur. The number of indices is returned.
  102187. **
  102188. ** Use iBase as the first cursor (either the *piDataCur for rowid tables
  102189. ** or the first index for WITHOUT ROWID tables) if it is non-negative.
  102190. ** If iBase is negative, then allocate the next available cursor.
  102191. **
  102192. ** For a rowid table, *piDataCur will be exactly one less than *piIdxCur.
  102193. ** For a WITHOUT ROWID table, *piDataCur will be somewhere in the range
  102194. ** of *piIdxCurs, depending on where the PRIMARY KEY index appears on the
  102195. ** pTab->pIndex list.
  102196. **
  102197. ** If pTab is a virtual table, then this routine is a no-op and the
  102198. ** *piDataCur and *piIdxCur values are left uninitialized.
  102199. */
  102200. SQLITE_PRIVATE int sqlite3OpenTableAndIndices(
  102201. Parse *pParse, /* Parsing context */
  102202. Table *pTab, /* Table to be opened */
  102203. int op, /* OP_OpenRead or OP_OpenWrite */
  102204. u8 p5, /* P5 value for OP_Open* opcodes (except on WITHOUT ROWID) */
  102205. int iBase, /* Use this for the table cursor, if there is one */
  102206. u8 *aToOpen, /* If not NULL: boolean for each table and index */
  102207. int *piDataCur, /* Write the database source cursor number here */
  102208. int *piIdxCur /* Write the first index cursor number here */
  102209. ){
  102210. int i;
  102211. int iDb;
  102212. int iDataCur;
  102213. Index *pIdx;
  102214. Vdbe *v;
  102215. assert( op==OP_OpenRead || op==OP_OpenWrite );
  102216. assert( op==OP_OpenWrite || p5==0 );
  102217. if( IsVirtual(pTab) ){
  102218. /* This routine is a no-op for virtual tables. Leave the output
  102219. ** variables *piDataCur and *piIdxCur uninitialized so that valgrind
  102220. ** can detect if they are used by mistake in the caller. */
  102221. return 0;
  102222. }
  102223. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  102224. v = sqlite3GetVdbe(pParse);
  102225. assert( v!=0 );
  102226. if( iBase<0 ) iBase = pParse->nTab;
  102227. iDataCur = iBase++;
  102228. if( piDataCur ) *piDataCur = iDataCur;
  102229. if( HasRowid(pTab) && (aToOpen==0 || aToOpen[0]) ){
  102230. sqlite3OpenTable(pParse, iDataCur, iDb, pTab, op);
  102231. }else{
  102232. sqlite3TableLock(pParse, iDb, pTab->tnum, op==OP_OpenWrite, pTab->zName);
  102233. }
  102234. if( piIdxCur ) *piIdxCur = iBase;
  102235. for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
  102236. int iIdxCur = iBase++;
  102237. assert( pIdx->pSchema==pTab->pSchema );
  102238. if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
  102239. if( piDataCur ) *piDataCur = iIdxCur;
  102240. p5 = 0;
  102241. }
  102242. if( aToOpen==0 || aToOpen[i+1] ){
  102243. sqlite3VdbeAddOp3(v, op, iIdxCur, pIdx->tnum, iDb);
  102244. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  102245. sqlite3VdbeChangeP5(v, p5);
  102246. VdbeComment((v, "%s", pIdx->zName));
  102247. }
  102248. }
  102249. if( iBase>pParse->nTab ) pParse->nTab = iBase;
  102250. return i;
  102251. }
  102252. #ifdef SQLITE_TEST
  102253. /*
  102254. ** The following global variable is incremented whenever the
  102255. ** transfer optimization is used. This is used for testing
  102256. ** purposes only - to make sure the transfer optimization really
  102257. ** is happening when it is supposed to.
  102258. */
  102259. SQLITE_API int sqlite3_xferopt_count;
  102260. #endif /* SQLITE_TEST */
  102261. #ifndef SQLITE_OMIT_XFER_OPT
  102262. /*
  102263. ** Check to see if index pSrc is compatible as a source of data
  102264. ** for index pDest in an insert transfer optimization. The rules
  102265. ** for a compatible index:
  102266. **
  102267. ** * The index is over the same set of columns
  102268. ** * The same DESC and ASC markings occurs on all columns
  102269. ** * The same onError processing (OE_Abort, OE_Ignore, etc)
  102270. ** * The same collating sequence on each column
  102271. ** * The index has the exact same WHERE clause
  102272. */
  102273. static int xferCompatibleIndex(Index *pDest, Index *pSrc){
  102274. int i;
  102275. assert( pDest && pSrc );
  102276. assert( pDest->pTable!=pSrc->pTable );
  102277. if( pDest->nKeyCol!=pSrc->nKeyCol ){
  102278. return 0; /* Different number of columns */
  102279. }
  102280. if( pDest->onError!=pSrc->onError ){
  102281. return 0; /* Different conflict resolution strategies */
  102282. }
  102283. for(i=0; i<pSrc->nKeyCol; i++){
  102284. if( pSrc->aiColumn[i]!=pDest->aiColumn[i] ){
  102285. return 0; /* Different columns indexed */
  102286. }
  102287. if( pSrc->aiColumn[i]==XN_EXPR ){
  102288. assert( pSrc->aColExpr!=0 && pDest->aColExpr!=0 );
  102289. if( sqlite3ExprCompare(pSrc->aColExpr->a[i].pExpr,
  102290. pDest->aColExpr->a[i].pExpr, -1)!=0 ){
  102291. return 0; /* Different expressions in the index */
  102292. }
  102293. }
  102294. if( pSrc->aSortOrder[i]!=pDest->aSortOrder[i] ){
  102295. return 0; /* Different sort orders */
  102296. }
  102297. if( sqlite3_stricmp(pSrc->azColl[i],pDest->azColl[i])!=0 ){
  102298. return 0; /* Different collating sequences */
  102299. }
  102300. }
  102301. if( sqlite3ExprCompare(pSrc->pPartIdxWhere, pDest->pPartIdxWhere, -1) ){
  102302. return 0; /* Different WHERE clauses */
  102303. }
  102304. /* If no test above fails then the indices must be compatible */
  102305. return 1;
  102306. }
  102307. /*
  102308. ** Attempt the transfer optimization on INSERTs of the form
  102309. **
  102310. ** INSERT INTO tab1 SELECT * FROM tab2;
  102311. **
  102312. ** The xfer optimization transfers raw records from tab2 over to tab1.
  102313. ** Columns are not decoded and reassembled, which greatly improves
  102314. ** performance. Raw index records are transferred in the same way.
  102315. **
  102316. ** The xfer optimization is only attempted if tab1 and tab2 are compatible.
  102317. ** There are lots of rules for determining compatibility - see comments
  102318. ** embedded in the code for details.
  102319. **
  102320. ** This routine returns TRUE if the optimization is guaranteed to be used.
  102321. ** Sometimes the xfer optimization will only work if the destination table
  102322. ** is empty - a factor that can only be determined at run-time. In that
  102323. ** case, this routine generates code for the xfer optimization but also
  102324. ** does a test to see if the destination table is empty and jumps over the
  102325. ** xfer optimization code if the test fails. In that case, this routine
  102326. ** returns FALSE so that the caller will know to go ahead and generate
  102327. ** an unoptimized transfer. This routine also returns FALSE if there
  102328. ** is no chance that the xfer optimization can be applied.
  102329. **
  102330. ** This optimization is particularly useful at making VACUUM run faster.
  102331. */
  102332. static int xferOptimization(
  102333. Parse *pParse, /* Parser context */
  102334. Table *pDest, /* The table we are inserting into */
  102335. Select *pSelect, /* A SELECT statement to use as the data source */
  102336. int onError, /* How to handle constraint errors */
  102337. int iDbDest /* The database of pDest */
  102338. ){
  102339. sqlite3 *db = pParse->db;
  102340. ExprList *pEList; /* The result set of the SELECT */
  102341. Table *pSrc; /* The table in the FROM clause of SELECT */
  102342. Index *pSrcIdx, *pDestIdx; /* Source and destination indices */
  102343. struct SrcList_item *pItem; /* An element of pSelect->pSrc */
  102344. int i; /* Loop counter */
  102345. int iDbSrc; /* The database of pSrc */
  102346. int iSrc, iDest; /* Cursors from source and destination */
  102347. int addr1, addr2; /* Loop addresses */
  102348. int emptyDestTest = 0; /* Address of test for empty pDest */
  102349. int emptySrcTest = 0; /* Address of test for empty pSrc */
  102350. Vdbe *v; /* The VDBE we are building */
  102351. int regAutoinc; /* Memory register used by AUTOINC */
  102352. int destHasUniqueIdx = 0; /* True if pDest has a UNIQUE index */
  102353. int regData, regRowid; /* Registers holding data and rowid */
  102354. if( pSelect==0 ){
  102355. return 0; /* Must be of the form INSERT INTO ... SELECT ... */
  102356. }
  102357. if( pParse->pWith || pSelect->pWith ){
  102358. /* Do not attempt to process this query if there are an WITH clauses
  102359. ** attached to it. Proceeding may generate a false "no such table: xxx"
  102360. ** error if pSelect reads from a CTE named "xxx". */
  102361. return 0;
  102362. }
  102363. if( sqlite3TriggerList(pParse, pDest) ){
  102364. return 0; /* tab1 must not have triggers */
  102365. }
  102366. #ifndef SQLITE_OMIT_VIRTUALTABLE
  102367. if( pDest->tabFlags & TF_Virtual ){
  102368. return 0; /* tab1 must not be a virtual table */
  102369. }
  102370. #endif
  102371. if( onError==OE_Default ){
  102372. if( pDest->iPKey>=0 ) onError = pDest->keyConf;
  102373. if( onError==OE_Default ) onError = OE_Abort;
  102374. }
  102375. assert(pSelect->pSrc); /* allocated even if there is no FROM clause */
  102376. if( pSelect->pSrc->nSrc!=1 ){
  102377. return 0; /* FROM clause must have exactly one term */
  102378. }
  102379. if( pSelect->pSrc->a[0].pSelect ){
  102380. return 0; /* FROM clause cannot contain a subquery */
  102381. }
  102382. if( pSelect->pWhere ){
  102383. return 0; /* SELECT may not have a WHERE clause */
  102384. }
  102385. if( pSelect->pOrderBy ){
  102386. return 0; /* SELECT may not have an ORDER BY clause */
  102387. }
  102388. /* Do not need to test for a HAVING clause. If HAVING is present but
  102389. ** there is no ORDER BY, we will get an error. */
  102390. if( pSelect->pGroupBy ){
  102391. return 0; /* SELECT may not have a GROUP BY clause */
  102392. }
  102393. if( pSelect->pLimit ){
  102394. return 0; /* SELECT may not have a LIMIT clause */
  102395. }
  102396. assert( pSelect->pOffset==0 ); /* Must be so if pLimit==0 */
  102397. if( pSelect->pPrior ){
  102398. return 0; /* SELECT may not be a compound query */
  102399. }
  102400. if( pSelect->selFlags & SF_Distinct ){
  102401. return 0; /* SELECT may not be DISTINCT */
  102402. }
  102403. pEList = pSelect->pEList;
  102404. assert( pEList!=0 );
  102405. if( pEList->nExpr!=1 ){
  102406. return 0; /* The result set must have exactly one column */
  102407. }
  102408. assert( pEList->a[0].pExpr );
  102409. if( pEList->a[0].pExpr->op!=TK_ASTERISK ){
  102410. return 0; /* The result set must be the special operator "*" */
  102411. }
  102412. /* At this point we have established that the statement is of the
  102413. ** correct syntactic form to participate in this optimization. Now
  102414. ** we have to check the semantics.
  102415. */
  102416. pItem = pSelect->pSrc->a;
  102417. pSrc = sqlite3LocateTableItem(pParse, 0, pItem);
  102418. if( pSrc==0 ){
  102419. return 0; /* FROM clause does not contain a real table */
  102420. }
  102421. if( pSrc==pDest ){
  102422. return 0; /* tab1 and tab2 may not be the same table */
  102423. }
  102424. if( HasRowid(pDest)!=HasRowid(pSrc) ){
  102425. return 0; /* source and destination must both be WITHOUT ROWID or not */
  102426. }
  102427. #ifndef SQLITE_OMIT_VIRTUALTABLE
  102428. if( pSrc->tabFlags & TF_Virtual ){
  102429. return 0; /* tab2 must not be a virtual table */
  102430. }
  102431. #endif
  102432. if( pSrc->pSelect ){
  102433. return 0; /* tab2 may not be a view */
  102434. }
  102435. if( pDest->nCol!=pSrc->nCol ){
  102436. return 0; /* Number of columns must be the same in tab1 and tab2 */
  102437. }
  102438. if( pDest->iPKey!=pSrc->iPKey ){
  102439. return 0; /* Both tables must have the same INTEGER PRIMARY KEY */
  102440. }
  102441. for(i=0; i<pDest->nCol; i++){
  102442. Column *pDestCol = &pDest->aCol[i];
  102443. Column *pSrcCol = &pSrc->aCol[i];
  102444. #ifdef SQLITE_ENABLE_HIDDEN_COLUMNS
  102445. if( (db->flags & SQLITE_Vacuum)==0
  102446. && (pDestCol->colFlags | pSrcCol->colFlags) & COLFLAG_HIDDEN
  102447. ){
  102448. return 0; /* Neither table may have __hidden__ columns */
  102449. }
  102450. #endif
  102451. if( pDestCol->affinity!=pSrcCol->affinity ){
  102452. return 0; /* Affinity must be the same on all columns */
  102453. }
  102454. if( sqlite3_stricmp(pDestCol->zColl, pSrcCol->zColl)!=0 ){
  102455. return 0; /* Collating sequence must be the same on all columns */
  102456. }
  102457. if( pDestCol->notNull && !pSrcCol->notNull ){
  102458. return 0; /* tab2 must be NOT NULL if tab1 is */
  102459. }
  102460. /* Default values for second and subsequent columns need to match. */
  102461. if( i>0 ){
  102462. assert( pDestCol->pDflt==0 || pDestCol->pDflt->op==TK_SPAN );
  102463. assert( pSrcCol->pDflt==0 || pSrcCol->pDflt->op==TK_SPAN );
  102464. if( (pDestCol->pDflt==0)!=(pSrcCol->pDflt==0)
  102465. || (pDestCol->pDflt && strcmp(pDestCol->pDflt->u.zToken,
  102466. pSrcCol->pDflt->u.zToken)!=0)
  102467. ){
  102468. return 0; /* Default values must be the same for all columns */
  102469. }
  102470. }
  102471. }
  102472. for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
  102473. if( IsUniqueIndex(pDestIdx) ){
  102474. destHasUniqueIdx = 1;
  102475. }
  102476. for(pSrcIdx=pSrc->pIndex; pSrcIdx; pSrcIdx=pSrcIdx->pNext){
  102477. if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
  102478. }
  102479. if( pSrcIdx==0 ){
  102480. return 0; /* pDestIdx has no corresponding index in pSrc */
  102481. }
  102482. }
  102483. #ifndef SQLITE_OMIT_CHECK
  102484. if( pDest->pCheck && sqlite3ExprListCompare(pSrc->pCheck,pDest->pCheck,-1) ){
  102485. return 0; /* Tables have different CHECK constraints. Ticket #2252 */
  102486. }
  102487. #endif
  102488. #ifndef SQLITE_OMIT_FOREIGN_KEY
  102489. /* Disallow the transfer optimization if the destination table constains
  102490. ** any foreign key constraints. This is more restrictive than necessary.
  102491. ** But the main beneficiary of the transfer optimization is the VACUUM
  102492. ** command, and the VACUUM command disables foreign key constraints. So
  102493. ** the extra complication to make this rule less restrictive is probably
  102494. ** not worth the effort. Ticket [6284df89debdfa61db8073e062908af0c9b6118e]
  102495. */
  102496. if( (db->flags & SQLITE_ForeignKeys)!=0 && pDest->pFKey!=0 ){
  102497. return 0;
  102498. }
  102499. #endif
  102500. if( (db->flags & SQLITE_CountRows)!=0 ){
  102501. return 0; /* xfer opt does not play well with PRAGMA count_changes */
  102502. }
  102503. /* If we get this far, it means that the xfer optimization is at
  102504. ** least a possibility, though it might only work if the destination
  102505. ** table (tab1) is initially empty.
  102506. */
  102507. #ifdef SQLITE_TEST
  102508. sqlite3_xferopt_count++;
  102509. #endif
  102510. iDbSrc = sqlite3SchemaToIndex(db, pSrc->pSchema);
  102511. v = sqlite3GetVdbe(pParse);
  102512. sqlite3CodeVerifySchema(pParse, iDbSrc);
  102513. iSrc = pParse->nTab++;
  102514. iDest = pParse->nTab++;
  102515. regAutoinc = autoIncBegin(pParse, iDbDest, pDest);
  102516. regData = sqlite3GetTempReg(pParse);
  102517. regRowid = sqlite3GetTempReg(pParse);
  102518. sqlite3OpenTable(pParse, iDest, iDbDest, pDest, OP_OpenWrite);
  102519. assert( HasRowid(pDest) || destHasUniqueIdx );
  102520. if( (db->flags & SQLITE_Vacuum)==0 && (
  102521. (pDest->iPKey<0 && pDest->pIndex!=0) /* (1) */
  102522. || destHasUniqueIdx /* (2) */
  102523. || (onError!=OE_Abort && onError!=OE_Rollback) /* (3) */
  102524. )){
  102525. /* In some circumstances, we are able to run the xfer optimization
  102526. ** only if the destination table is initially empty. Unless the
  102527. ** SQLITE_Vacuum flag is set, this block generates code to make
  102528. ** that determination. If SQLITE_Vacuum is set, then the destination
  102529. ** table is always empty.
  102530. **
  102531. ** Conditions under which the destination must be empty:
  102532. **
  102533. ** (1) There is no INTEGER PRIMARY KEY but there are indices.
  102534. ** (If the destination is not initially empty, the rowid fields
  102535. ** of index entries might need to change.)
  102536. **
  102537. ** (2) The destination has a unique index. (The xfer optimization
  102538. ** is unable to test uniqueness.)
  102539. **
  102540. ** (3) onError is something other than OE_Abort and OE_Rollback.
  102541. */
  102542. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iDest, 0); VdbeCoverage(v);
  102543. emptyDestTest = sqlite3VdbeAddOp0(v, OP_Goto);
  102544. sqlite3VdbeJumpHere(v, addr1);
  102545. }
  102546. if( HasRowid(pSrc) ){
  102547. sqlite3OpenTable(pParse, iSrc, iDbSrc, pSrc, OP_OpenRead);
  102548. emptySrcTest = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
  102549. if( pDest->iPKey>=0 ){
  102550. addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
  102551. addr2 = sqlite3VdbeAddOp3(v, OP_NotExists, iDest, 0, regRowid);
  102552. VdbeCoverage(v);
  102553. sqlite3RowidConstraint(pParse, onError, pDest);
  102554. sqlite3VdbeJumpHere(v, addr2);
  102555. autoIncStep(pParse, regAutoinc, regRowid);
  102556. }else if( pDest->pIndex==0 ){
  102557. addr1 = sqlite3VdbeAddOp2(v, OP_NewRowid, iDest, regRowid);
  102558. }else{
  102559. addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
  102560. assert( (pDest->tabFlags & TF_Autoincrement)==0 );
  102561. }
  102562. sqlite3VdbeAddOp2(v, OP_RowData, iSrc, regData);
  102563. sqlite3VdbeAddOp4(v, OP_Insert, iDest, regData, regRowid,
  102564. (char*)pDest, P4_TABLE);
  102565. sqlite3VdbeChangeP5(v, OPFLAG_NCHANGE|OPFLAG_LASTROWID|OPFLAG_APPEND);
  102566. sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1); VdbeCoverage(v);
  102567. sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
  102568. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  102569. }else{
  102570. sqlite3TableLock(pParse, iDbDest, pDest->tnum, 1, pDest->zName);
  102571. sqlite3TableLock(pParse, iDbSrc, pSrc->tnum, 0, pSrc->zName);
  102572. }
  102573. for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
  102574. u8 idxInsFlags = 0;
  102575. for(pSrcIdx=pSrc->pIndex; ALWAYS(pSrcIdx); pSrcIdx=pSrcIdx->pNext){
  102576. if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
  102577. }
  102578. assert( pSrcIdx );
  102579. sqlite3VdbeAddOp3(v, OP_OpenRead, iSrc, pSrcIdx->tnum, iDbSrc);
  102580. sqlite3VdbeSetP4KeyInfo(pParse, pSrcIdx);
  102581. VdbeComment((v, "%s", pSrcIdx->zName));
  102582. sqlite3VdbeAddOp3(v, OP_OpenWrite, iDest, pDestIdx->tnum, iDbDest);
  102583. sqlite3VdbeSetP4KeyInfo(pParse, pDestIdx);
  102584. sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR);
  102585. VdbeComment((v, "%s", pDestIdx->zName));
  102586. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
  102587. sqlite3VdbeAddOp2(v, OP_RowKey, iSrc, regData);
  102588. if( db->flags & SQLITE_Vacuum ){
  102589. /* This INSERT command is part of a VACUUM operation, which guarantees
  102590. ** that the destination table is empty. If all indexed columns use
  102591. ** collation sequence BINARY, then it can also be assumed that the
  102592. ** index will be populated by inserting keys in strictly sorted
  102593. ** order. In this case, instead of seeking within the b-tree as part
  102594. ** of every OP_IdxInsert opcode, an OP_Last is added before the
  102595. ** OP_IdxInsert to seek to the point within the b-tree where each key
  102596. ** should be inserted. This is faster.
  102597. **
  102598. ** If any of the indexed columns use a collation sequence other than
  102599. ** BINARY, this optimization is disabled. This is because the user
  102600. ** might change the definition of a collation sequence and then run
  102601. ** a VACUUM command. In that case keys may not be written in strictly
  102602. ** sorted order. */
  102603. for(i=0; i<pSrcIdx->nColumn; i++){
  102604. const char *zColl = pSrcIdx->azColl[i];
  102605. assert( sqlite3_stricmp(sqlite3StrBINARY, zColl)!=0
  102606. || sqlite3StrBINARY==zColl );
  102607. if( sqlite3_stricmp(sqlite3StrBINARY, zColl) ) break;
  102608. }
  102609. if( i==pSrcIdx->nColumn ){
  102610. idxInsFlags = OPFLAG_USESEEKRESULT;
  102611. sqlite3VdbeAddOp3(v, OP_Last, iDest, 0, -1);
  102612. }
  102613. }
  102614. if( !HasRowid(pSrc) && pDestIdx->idxType==2 ){
  102615. idxInsFlags |= OPFLAG_NCHANGE;
  102616. }
  102617. sqlite3VdbeAddOp3(v, OP_IdxInsert, iDest, regData, 1);
  102618. sqlite3VdbeChangeP5(v, idxInsFlags);
  102619. sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1+1); VdbeCoverage(v);
  102620. sqlite3VdbeJumpHere(v, addr1);
  102621. sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
  102622. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  102623. }
  102624. if( emptySrcTest ) sqlite3VdbeJumpHere(v, emptySrcTest);
  102625. sqlite3ReleaseTempReg(pParse, regRowid);
  102626. sqlite3ReleaseTempReg(pParse, regData);
  102627. if( emptyDestTest ){
  102628. sqlite3AutoincrementEnd(pParse);
  102629. sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_OK, 0);
  102630. sqlite3VdbeJumpHere(v, emptyDestTest);
  102631. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  102632. return 0;
  102633. }else{
  102634. return 1;
  102635. }
  102636. }
  102637. #endif /* SQLITE_OMIT_XFER_OPT */
  102638. /************** End of insert.c **********************************************/
  102639. /************** Begin file legacy.c ******************************************/
  102640. /*
  102641. ** 2001 September 15
  102642. **
  102643. ** The author disclaims copyright to this source code. In place of
  102644. ** a legal notice, here is a blessing:
  102645. **
  102646. ** May you do good and not evil.
  102647. ** May you find forgiveness for yourself and forgive others.
  102648. ** May you share freely, never taking more than you give.
  102649. **
  102650. *************************************************************************
  102651. ** Main file for the SQLite library. The routines in this file
  102652. ** implement the programmer interface to the library. Routines in
  102653. ** other files are for internal use by SQLite and should not be
  102654. ** accessed by users of the library.
  102655. */
  102656. /* #include "sqliteInt.h" */
  102657. /*
  102658. ** Execute SQL code. Return one of the SQLITE_ success/failure
  102659. ** codes. Also write an error message into memory obtained from
  102660. ** malloc() and make *pzErrMsg point to that message.
  102661. **
  102662. ** If the SQL is a query, then for each row in the query result
  102663. ** the xCallback() function is called. pArg becomes the first
  102664. ** argument to xCallback(). If xCallback=NULL then no callback
  102665. ** is invoked, even for queries.
  102666. */
  102667. SQLITE_API int sqlite3_exec(
  102668. sqlite3 *db, /* The database on which the SQL executes */
  102669. const char *zSql, /* The SQL to be executed */
  102670. sqlite3_callback xCallback, /* Invoke this callback routine */
  102671. void *pArg, /* First argument to xCallback() */
  102672. char **pzErrMsg /* Write error messages here */
  102673. ){
  102674. int rc = SQLITE_OK; /* Return code */
  102675. const char *zLeftover; /* Tail of unprocessed SQL */
  102676. sqlite3_stmt *pStmt = 0; /* The current SQL statement */
  102677. char **azCols = 0; /* Names of result columns */
  102678. int callbackIsInit; /* True if callback data is initialized */
  102679. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  102680. if( zSql==0 ) zSql = "";
  102681. sqlite3_mutex_enter(db->mutex);
  102682. sqlite3Error(db, SQLITE_OK);
  102683. while( rc==SQLITE_OK && zSql[0] ){
  102684. int nCol;
  102685. char **azVals = 0;
  102686. pStmt = 0;
  102687. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, &zLeftover);
  102688. assert( rc==SQLITE_OK || pStmt==0 );
  102689. if( rc!=SQLITE_OK ){
  102690. continue;
  102691. }
  102692. if( !pStmt ){
  102693. /* this happens for a comment or white-space */
  102694. zSql = zLeftover;
  102695. continue;
  102696. }
  102697. callbackIsInit = 0;
  102698. nCol = sqlite3_column_count(pStmt);
  102699. while( 1 ){
  102700. int i;
  102701. rc = sqlite3_step(pStmt);
  102702. /* Invoke the callback function if required */
  102703. if( xCallback && (SQLITE_ROW==rc ||
  102704. (SQLITE_DONE==rc && !callbackIsInit
  102705. && db->flags&SQLITE_NullCallback)) ){
  102706. if( !callbackIsInit ){
  102707. azCols = sqlite3DbMallocZero(db, 2*nCol*sizeof(const char*) + 1);
  102708. if( azCols==0 ){
  102709. goto exec_out;
  102710. }
  102711. for(i=0; i<nCol; i++){
  102712. azCols[i] = (char *)sqlite3_column_name(pStmt, i);
  102713. /* sqlite3VdbeSetColName() installs column names as UTF8
  102714. ** strings so there is no way for sqlite3_column_name() to fail. */
  102715. assert( azCols[i]!=0 );
  102716. }
  102717. callbackIsInit = 1;
  102718. }
  102719. if( rc==SQLITE_ROW ){
  102720. azVals = &azCols[nCol];
  102721. for(i=0; i<nCol; i++){
  102722. azVals[i] = (char *)sqlite3_column_text(pStmt, i);
  102723. if( !azVals[i] && sqlite3_column_type(pStmt, i)!=SQLITE_NULL ){
  102724. sqlite3OomFault(db);
  102725. goto exec_out;
  102726. }
  102727. }
  102728. }
  102729. if( xCallback(pArg, nCol, azVals, azCols) ){
  102730. /* EVIDENCE-OF: R-38229-40159 If the callback function to
  102731. ** sqlite3_exec() returns non-zero, then sqlite3_exec() will
  102732. ** return SQLITE_ABORT. */
  102733. rc = SQLITE_ABORT;
  102734. sqlite3VdbeFinalize((Vdbe *)pStmt);
  102735. pStmt = 0;
  102736. sqlite3Error(db, SQLITE_ABORT);
  102737. goto exec_out;
  102738. }
  102739. }
  102740. if( rc!=SQLITE_ROW ){
  102741. rc = sqlite3VdbeFinalize((Vdbe *)pStmt);
  102742. pStmt = 0;
  102743. zSql = zLeftover;
  102744. while( sqlite3Isspace(zSql[0]) ) zSql++;
  102745. break;
  102746. }
  102747. }
  102748. sqlite3DbFree(db, azCols);
  102749. azCols = 0;
  102750. }
  102751. exec_out:
  102752. if( pStmt ) sqlite3VdbeFinalize((Vdbe *)pStmt);
  102753. sqlite3DbFree(db, azCols);
  102754. rc = sqlite3ApiExit(db, rc);
  102755. if( rc!=SQLITE_OK && pzErrMsg ){
  102756. int nErrMsg = 1 + sqlite3Strlen30(sqlite3_errmsg(db));
  102757. *pzErrMsg = sqlite3Malloc(nErrMsg);
  102758. if( *pzErrMsg ){
  102759. memcpy(*pzErrMsg, sqlite3_errmsg(db), nErrMsg);
  102760. }else{
  102761. rc = SQLITE_NOMEM_BKPT;
  102762. sqlite3Error(db, SQLITE_NOMEM);
  102763. }
  102764. }else if( pzErrMsg ){
  102765. *pzErrMsg = 0;
  102766. }
  102767. assert( (rc&db->errMask)==rc );
  102768. sqlite3_mutex_leave(db->mutex);
  102769. return rc;
  102770. }
  102771. /************** End of legacy.c **********************************************/
  102772. /************** Begin file loadext.c *****************************************/
  102773. /*
  102774. ** 2006 June 7
  102775. **
  102776. ** The author disclaims copyright to this source code. In place of
  102777. ** a legal notice, here is a blessing:
  102778. **
  102779. ** May you do good and not evil.
  102780. ** May you find forgiveness for yourself and forgive others.
  102781. ** May you share freely, never taking more than you give.
  102782. **
  102783. *************************************************************************
  102784. ** This file contains code used to dynamically load extensions into
  102785. ** the SQLite library.
  102786. */
  102787. #ifndef SQLITE_CORE
  102788. #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */
  102789. #endif
  102790. /************** Include sqlite3ext.h in the middle of loadext.c **************/
  102791. /************** Begin file sqlite3ext.h **************************************/
  102792. /*
  102793. ** 2006 June 7
  102794. **
  102795. ** The author disclaims copyright to this source code. In place of
  102796. ** a legal notice, here is a blessing:
  102797. **
  102798. ** May you do good and not evil.
  102799. ** May you find forgiveness for yourself and forgive others.
  102800. ** May you share freely, never taking more than you give.
  102801. **
  102802. *************************************************************************
  102803. ** This header file defines the SQLite interface for use by
  102804. ** shared libraries that want to be imported as extensions into
  102805. ** an SQLite instance. Shared libraries that intend to be loaded
  102806. ** as extensions by SQLite should #include this file instead of
  102807. ** sqlite3.h.
  102808. */
  102809. #ifndef SQLITE3EXT_H
  102810. #define SQLITE3EXT_H
  102811. /* #include "sqlite3.h" */
  102812. /*
  102813. ** The following structure holds pointers to all of the SQLite API
  102814. ** routines.
  102815. **
  102816. ** WARNING: In order to maintain backwards compatibility, add new
  102817. ** interfaces to the end of this structure only. If you insert new
  102818. ** interfaces in the middle of this structure, then older different
  102819. ** versions of SQLite will not be able to load each other's shared
  102820. ** libraries!
  102821. */
  102822. struct sqlite3_api_routines {
  102823. void * (*aggregate_context)(sqlite3_context*,int nBytes);
  102824. int (*aggregate_count)(sqlite3_context*);
  102825. int (*bind_blob)(sqlite3_stmt*,int,const void*,int n,void(*)(void*));
  102826. int (*bind_double)(sqlite3_stmt*,int,double);
  102827. int (*bind_int)(sqlite3_stmt*,int,int);
  102828. int (*bind_int64)(sqlite3_stmt*,int,sqlite_int64);
  102829. int (*bind_null)(sqlite3_stmt*,int);
  102830. int (*bind_parameter_count)(sqlite3_stmt*);
  102831. int (*bind_parameter_index)(sqlite3_stmt*,const char*zName);
  102832. const char * (*bind_parameter_name)(sqlite3_stmt*,int);
  102833. int (*bind_text)(sqlite3_stmt*,int,const char*,int n,void(*)(void*));
  102834. int (*bind_text16)(sqlite3_stmt*,int,const void*,int,void(*)(void*));
  102835. int (*bind_value)(sqlite3_stmt*,int,const sqlite3_value*);
  102836. int (*busy_handler)(sqlite3*,int(*)(void*,int),void*);
  102837. int (*busy_timeout)(sqlite3*,int ms);
  102838. int (*changes)(sqlite3*);
  102839. int (*close)(sqlite3*);
  102840. int (*collation_needed)(sqlite3*,void*,void(*)(void*,sqlite3*,
  102841. int eTextRep,const char*));
  102842. int (*collation_needed16)(sqlite3*,void*,void(*)(void*,sqlite3*,
  102843. int eTextRep,const void*));
  102844. const void * (*column_blob)(sqlite3_stmt*,int iCol);
  102845. int (*column_bytes)(sqlite3_stmt*,int iCol);
  102846. int (*column_bytes16)(sqlite3_stmt*,int iCol);
  102847. int (*column_count)(sqlite3_stmt*pStmt);
  102848. const char * (*column_database_name)(sqlite3_stmt*,int);
  102849. const void * (*column_database_name16)(sqlite3_stmt*,int);
  102850. const char * (*column_decltype)(sqlite3_stmt*,int i);
  102851. const void * (*column_decltype16)(sqlite3_stmt*,int);
  102852. double (*column_double)(sqlite3_stmt*,int iCol);
  102853. int (*column_int)(sqlite3_stmt*,int iCol);
  102854. sqlite_int64 (*column_int64)(sqlite3_stmt*,int iCol);
  102855. const char * (*column_name)(sqlite3_stmt*,int);
  102856. const void * (*column_name16)(sqlite3_stmt*,int);
  102857. const char * (*column_origin_name)(sqlite3_stmt*,int);
  102858. const void * (*column_origin_name16)(sqlite3_stmt*,int);
  102859. const char * (*column_table_name)(sqlite3_stmt*,int);
  102860. const void * (*column_table_name16)(sqlite3_stmt*,int);
  102861. const unsigned char * (*column_text)(sqlite3_stmt*,int iCol);
  102862. const void * (*column_text16)(sqlite3_stmt*,int iCol);
  102863. int (*column_type)(sqlite3_stmt*,int iCol);
  102864. sqlite3_value* (*column_value)(sqlite3_stmt*,int iCol);
  102865. void * (*commit_hook)(sqlite3*,int(*)(void*),void*);
  102866. int (*complete)(const char*sql);
  102867. int (*complete16)(const void*sql);
  102868. int (*create_collation)(sqlite3*,const char*,int,void*,
  102869. int(*)(void*,int,const void*,int,const void*));
  102870. int (*create_collation16)(sqlite3*,const void*,int,void*,
  102871. int(*)(void*,int,const void*,int,const void*));
  102872. int (*create_function)(sqlite3*,const char*,int,int,void*,
  102873. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  102874. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  102875. void (*xFinal)(sqlite3_context*));
  102876. int (*create_function16)(sqlite3*,const void*,int,int,void*,
  102877. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  102878. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  102879. void (*xFinal)(sqlite3_context*));
  102880. int (*create_module)(sqlite3*,const char*,const sqlite3_module*,void*);
  102881. int (*data_count)(sqlite3_stmt*pStmt);
  102882. sqlite3 * (*db_handle)(sqlite3_stmt*);
  102883. int (*declare_vtab)(sqlite3*,const char*);
  102884. int (*enable_shared_cache)(int);
  102885. int (*errcode)(sqlite3*db);
  102886. const char * (*errmsg)(sqlite3*);
  102887. const void * (*errmsg16)(sqlite3*);
  102888. int (*exec)(sqlite3*,const char*,sqlite3_callback,void*,char**);
  102889. int (*expired)(sqlite3_stmt*);
  102890. int (*finalize)(sqlite3_stmt*pStmt);
  102891. void (*free)(void*);
  102892. void (*free_table)(char**result);
  102893. int (*get_autocommit)(sqlite3*);
  102894. void * (*get_auxdata)(sqlite3_context*,int);
  102895. int (*get_table)(sqlite3*,const char*,char***,int*,int*,char**);
  102896. int (*global_recover)(void);
  102897. void (*interruptx)(sqlite3*);
  102898. sqlite_int64 (*last_insert_rowid)(sqlite3*);
  102899. const char * (*libversion)(void);
  102900. int (*libversion_number)(void);
  102901. void *(*malloc)(int);
  102902. char * (*mprintf)(const char*,...);
  102903. int (*open)(const char*,sqlite3**);
  102904. int (*open16)(const void*,sqlite3**);
  102905. int (*prepare)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
  102906. int (*prepare16)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
  102907. void * (*profile)(sqlite3*,void(*)(void*,const char*,sqlite_uint64),void*);
  102908. void (*progress_handler)(sqlite3*,int,int(*)(void*),void*);
  102909. void *(*realloc)(void*,int);
  102910. int (*reset)(sqlite3_stmt*pStmt);
  102911. void (*result_blob)(sqlite3_context*,const void*,int,void(*)(void*));
  102912. void (*result_double)(sqlite3_context*,double);
  102913. void (*result_error)(sqlite3_context*,const char*,int);
  102914. void (*result_error16)(sqlite3_context*,const void*,int);
  102915. void (*result_int)(sqlite3_context*,int);
  102916. void (*result_int64)(sqlite3_context*,sqlite_int64);
  102917. void (*result_null)(sqlite3_context*);
  102918. void (*result_text)(sqlite3_context*,const char*,int,void(*)(void*));
  102919. void (*result_text16)(sqlite3_context*,const void*,int,void(*)(void*));
  102920. void (*result_text16be)(sqlite3_context*,const void*,int,void(*)(void*));
  102921. void (*result_text16le)(sqlite3_context*,const void*,int,void(*)(void*));
  102922. void (*result_value)(sqlite3_context*,sqlite3_value*);
  102923. void * (*rollback_hook)(sqlite3*,void(*)(void*),void*);
  102924. int (*set_authorizer)(sqlite3*,int(*)(void*,int,const char*,const char*,
  102925. const char*,const char*),void*);
  102926. void (*set_auxdata)(sqlite3_context*,int,void*,void (*)(void*));
  102927. char * (*snprintf)(int,char*,const char*,...);
  102928. int (*step)(sqlite3_stmt*);
  102929. int (*table_column_metadata)(sqlite3*,const char*,const char*,const char*,
  102930. char const**,char const**,int*,int*,int*);
  102931. void (*thread_cleanup)(void);
  102932. int (*total_changes)(sqlite3*);
  102933. void * (*trace)(sqlite3*,void(*xTrace)(void*,const char*),void*);
  102934. int (*transfer_bindings)(sqlite3_stmt*,sqlite3_stmt*);
  102935. void * (*update_hook)(sqlite3*,void(*)(void*,int ,char const*,char const*,
  102936. sqlite_int64),void*);
  102937. void * (*user_data)(sqlite3_context*);
  102938. const void * (*value_blob)(sqlite3_value*);
  102939. int (*value_bytes)(sqlite3_value*);
  102940. int (*value_bytes16)(sqlite3_value*);
  102941. double (*value_double)(sqlite3_value*);
  102942. int (*value_int)(sqlite3_value*);
  102943. sqlite_int64 (*value_int64)(sqlite3_value*);
  102944. int (*value_numeric_type)(sqlite3_value*);
  102945. const unsigned char * (*value_text)(sqlite3_value*);
  102946. const void * (*value_text16)(sqlite3_value*);
  102947. const void * (*value_text16be)(sqlite3_value*);
  102948. const void * (*value_text16le)(sqlite3_value*);
  102949. int (*value_type)(sqlite3_value*);
  102950. char *(*vmprintf)(const char*,va_list);
  102951. /* Added ??? */
  102952. int (*overload_function)(sqlite3*, const char *zFuncName, int nArg);
  102953. /* Added by 3.3.13 */
  102954. int (*prepare_v2)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
  102955. int (*prepare16_v2)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
  102956. int (*clear_bindings)(sqlite3_stmt*);
  102957. /* Added by 3.4.1 */
  102958. int (*create_module_v2)(sqlite3*,const char*,const sqlite3_module*,void*,
  102959. void (*xDestroy)(void *));
  102960. /* Added by 3.5.0 */
  102961. int (*bind_zeroblob)(sqlite3_stmt*,int,int);
  102962. int (*blob_bytes)(sqlite3_blob*);
  102963. int (*blob_close)(sqlite3_blob*);
  102964. int (*blob_open)(sqlite3*,const char*,const char*,const char*,sqlite3_int64,
  102965. int,sqlite3_blob**);
  102966. int (*blob_read)(sqlite3_blob*,void*,int,int);
  102967. int (*blob_write)(sqlite3_blob*,const void*,int,int);
  102968. int (*create_collation_v2)(sqlite3*,const char*,int,void*,
  102969. int(*)(void*,int,const void*,int,const void*),
  102970. void(*)(void*));
  102971. int (*file_control)(sqlite3*,const char*,int,void*);
  102972. sqlite3_int64 (*memory_highwater)(int);
  102973. sqlite3_int64 (*memory_used)(void);
  102974. sqlite3_mutex *(*mutex_alloc)(int);
  102975. void (*mutex_enter)(sqlite3_mutex*);
  102976. void (*mutex_free)(sqlite3_mutex*);
  102977. void (*mutex_leave)(sqlite3_mutex*);
  102978. int (*mutex_try)(sqlite3_mutex*);
  102979. int (*open_v2)(const char*,sqlite3**,int,const char*);
  102980. int (*release_memory)(int);
  102981. void (*result_error_nomem)(sqlite3_context*);
  102982. void (*result_error_toobig)(sqlite3_context*);
  102983. int (*sleep)(int);
  102984. void (*soft_heap_limit)(int);
  102985. sqlite3_vfs *(*vfs_find)(const char*);
  102986. int (*vfs_register)(sqlite3_vfs*,int);
  102987. int (*vfs_unregister)(sqlite3_vfs*);
  102988. int (*xthreadsafe)(void);
  102989. void (*result_zeroblob)(sqlite3_context*,int);
  102990. void (*result_error_code)(sqlite3_context*,int);
  102991. int (*test_control)(int, ...);
  102992. void (*randomness)(int,void*);
  102993. sqlite3 *(*context_db_handle)(sqlite3_context*);
  102994. int (*extended_result_codes)(sqlite3*,int);
  102995. int (*limit)(sqlite3*,int,int);
  102996. sqlite3_stmt *(*next_stmt)(sqlite3*,sqlite3_stmt*);
  102997. const char *(*sql)(sqlite3_stmt*);
  102998. int (*status)(int,int*,int*,int);
  102999. int (*backup_finish)(sqlite3_backup*);
  103000. sqlite3_backup *(*backup_init)(sqlite3*,const char*,sqlite3*,const char*);
  103001. int (*backup_pagecount)(sqlite3_backup*);
  103002. int (*backup_remaining)(sqlite3_backup*);
  103003. int (*backup_step)(sqlite3_backup*,int);
  103004. const char *(*compileoption_get)(int);
  103005. int (*compileoption_used)(const char*);
  103006. int (*create_function_v2)(sqlite3*,const char*,int,int,void*,
  103007. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  103008. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  103009. void (*xFinal)(sqlite3_context*),
  103010. void(*xDestroy)(void*));
  103011. int (*db_config)(sqlite3*,int,...);
  103012. sqlite3_mutex *(*db_mutex)(sqlite3*);
  103013. int (*db_status)(sqlite3*,int,int*,int*,int);
  103014. int (*extended_errcode)(sqlite3*);
  103015. void (*log)(int,const char*,...);
  103016. sqlite3_int64 (*soft_heap_limit64)(sqlite3_int64);
  103017. const char *(*sourceid)(void);
  103018. int (*stmt_status)(sqlite3_stmt*,int,int);
  103019. int (*strnicmp)(const char*,const char*,int);
  103020. int (*unlock_notify)(sqlite3*,void(*)(void**,int),void*);
  103021. int (*wal_autocheckpoint)(sqlite3*,int);
  103022. int (*wal_checkpoint)(sqlite3*,const char*);
  103023. void *(*wal_hook)(sqlite3*,int(*)(void*,sqlite3*,const char*,int),void*);
  103024. int (*blob_reopen)(sqlite3_blob*,sqlite3_int64);
  103025. int (*vtab_config)(sqlite3*,int op,...);
  103026. int (*vtab_on_conflict)(sqlite3*);
  103027. /* Version 3.7.16 and later */
  103028. int (*close_v2)(sqlite3*);
  103029. const char *(*db_filename)(sqlite3*,const char*);
  103030. int (*db_readonly)(sqlite3*,const char*);
  103031. int (*db_release_memory)(sqlite3*);
  103032. const char *(*errstr)(int);
  103033. int (*stmt_busy)(sqlite3_stmt*);
  103034. int (*stmt_readonly)(sqlite3_stmt*);
  103035. int (*stricmp)(const char*,const char*);
  103036. int (*uri_boolean)(const char*,const char*,int);
  103037. sqlite3_int64 (*uri_int64)(const char*,const char*,sqlite3_int64);
  103038. const char *(*uri_parameter)(const char*,const char*);
  103039. char *(*vsnprintf)(int,char*,const char*,va_list);
  103040. int (*wal_checkpoint_v2)(sqlite3*,const char*,int,int*,int*);
  103041. /* Version 3.8.7 and later */
  103042. int (*auto_extension)(void(*)(void));
  103043. int (*bind_blob64)(sqlite3_stmt*,int,const void*,sqlite3_uint64,
  103044. void(*)(void*));
  103045. int (*bind_text64)(sqlite3_stmt*,int,const char*,sqlite3_uint64,
  103046. void(*)(void*),unsigned char);
  103047. int (*cancel_auto_extension)(void(*)(void));
  103048. int (*load_extension)(sqlite3*,const char*,const char*,char**);
  103049. void *(*malloc64)(sqlite3_uint64);
  103050. sqlite3_uint64 (*msize)(void*);
  103051. void *(*realloc64)(void*,sqlite3_uint64);
  103052. void (*reset_auto_extension)(void);
  103053. void (*result_blob64)(sqlite3_context*,const void*,sqlite3_uint64,
  103054. void(*)(void*));
  103055. void (*result_text64)(sqlite3_context*,const char*,sqlite3_uint64,
  103056. void(*)(void*), unsigned char);
  103057. int (*strglob)(const char*,const char*);
  103058. /* Version 3.8.11 and later */
  103059. sqlite3_value *(*value_dup)(const sqlite3_value*);
  103060. void (*value_free)(sqlite3_value*);
  103061. int (*result_zeroblob64)(sqlite3_context*,sqlite3_uint64);
  103062. int (*bind_zeroblob64)(sqlite3_stmt*, int, sqlite3_uint64);
  103063. /* Version 3.9.0 and later */
  103064. unsigned int (*value_subtype)(sqlite3_value*);
  103065. void (*result_subtype)(sqlite3_context*,unsigned int);
  103066. /* Version 3.10.0 and later */
  103067. int (*status64)(int,sqlite3_int64*,sqlite3_int64*,int);
  103068. int (*strlike)(const char*,const char*,unsigned int);
  103069. int (*db_cacheflush)(sqlite3*);
  103070. /* Version 3.12.0 and later */
  103071. int (*system_errno)(sqlite3*);
  103072. /* Version 3.14.0 and later */
  103073. int (*trace_v2)(sqlite3*,unsigned,int(*)(unsigned,void*,void*,void*),void*);
  103074. char *(*expanded_sql)(sqlite3_stmt*);
  103075. };
  103076. /*
  103077. ** This is the function signature used for all extension entry points. It
  103078. ** is also defined in the file "loadext.c".
  103079. */
  103080. typedef int (*sqlite3_loadext_entry)(
  103081. sqlite3 *db, /* Handle to the database. */
  103082. char **pzErrMsg, /* Used to set error string on failure. */
  103083. const sqlite3_api_routines *pThunk /* Extension API function pointers. */
  103084. );
  103085. /*
  103086. ** The following macros redefine the API routines so that they are
  103087. ** redirected through the global sqlite3_api structure.
  103088. **
  103089. ** This header file is also used by the loadext.c source file
  103090. ** (part of the main SQLite library - not an extension) so that
  103091. ** it can get access to the sqlite3_api_routines structure
  103092. ** definition. But the main library does not want to redefine
  103093. ** the API. So the redefinition macros are only valid if the
  103094. ** SQLITE_CORE macros is undefined.
  103095. */
  103096. #if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  103097. #define sqlite3_aggregate_context sqlite3_api->aggregate_context
  103098. #ifndef SQLITE_OMIT_DEPRECATED
  103099. #define sqlite3_aggregate_count sqlite3_api->aggregate_count
  103100. #endif
  103101. #define sqlite3_bind_blob sqlite3_api->bind_blob
  103102. #define sqlite3_bind_double sqlite3_api->bind_double
  103103. #define sqlite3_bind_int sqlite3_api->bind_int
  103104. #define sqlite3_bind_int64 sqlite3_api->bind_int64
  103105. #define sqlite3_bind_null sqlite3_api->bind_null
  103106. #define sqlite3_bind_parameter_count sqlite3_api->bind_parameter_count
  103107. #define sqlite3_bind_parameter_index sqlite3_api->bind_parameter_index
  103108. #define sqlite3_bind_parameter_name sqlite3_api->bind_parameter_name
  103109. #define sqlite3_bind_text sqlite3_api->bind_text
  103110. #define sqlite3_bind_text16 sqlite3_api->bind_text16
  103111. #define sqlite3_bind_value sqlite3_api->bind_value
  103112. #define sqlite3_busy_handler sqlite3_api->busy_handler
  103113. #define sqlite3_busy_timeout sqlite3_api->busy_timeout
  103114. #define sqlite3_changes sqlite3_api->changes
  103115. #define sqlite3_close sqlite3_api->close
  103116. #define sqlite3_collation_needed sqlite3_api->collation_needed
  103117. #define sqlite3_collation_needed16 sqlite3_api->collation_needed16
  103118. #define sqlite3_column_blob sqlite3_api->column_blob
  103119. #define sqlite3_column_bytes sqlite3_api->column_bytes
  103120. #define sqlite3_column_bytes16 sqlite3_api->column_bytes16
  103121. #define sqlite3_column_count sqlite3_api->column_count
  103122. #define sqlite3_column_database_name sqlite3_api->column_database_name
  103123. #define sqlite3_column_database_name16 sqlite3_api->column_database_name16
  103124. #define sqlite3_column_decltype sqlite3_api->column_decltype
  103125. #define sqlite3_column_decltype16 sqlite3_api->column_decltype16
  103126. #define sqlite3_column_double sqlite3_api->column_double
  103127. #define sqlite3_column_int sqlite3_api->column_int
  103128. #define sqlite3_column_int64 sqlite3_api->column_int64
  103129. #define sqlite3_column_name sqlite3_api->column_name
  103130. #define sqlite3_column_name16 sqlite3_api->column_name16
  103131. #define sqlite3_column_origin_name sqlite3_api->column_origin_name
  103132. #define sqlite3_column_origin_name16 sqlite3_api->column_origin_name16
  103133. #define sqlite3_column_table_name sqlite3_api->column_table_name
  103134. #define sqlite3_column_table_name16 sqlite3_api->column_table_name16
  103135. #define sqlite3_column_text sqlite3_api->column_text
  103136. #define sqlite3_column_text16 sqlite3_api->column_text16
  103137. #define sqlite3_column_type sqlite3_api->column_type
  103138. #define sqlite3_column_value sqlite3_api->column_value
  103139. #define sqlite3_commit_hook sqlite3_api->commit_hook
  103140. #define sqlite3_complete sqlite3_api->complete
  103141. #define sqlite3_complete16 sqlite3_api->complete16
  103142. #define sqlite3_create_collation sqlite3_api->create_collation
  103143. #define sqlite3_create_collation16 sqlite3_api->create_collation16
  103144. #define sqlite3_create_function sqlite3_api->create_function
  103145. #define sqlite3_create_function16 sqlite3_api->create_function16
  103146. #define sqlite3_create_module sqlite3_api->create_module
  103147. #define sqlite3_create_module_v2 sqlite3_api->create_module_v2
  103148. #define sqlite3_data_count sqlite3_api->data_count
  103149. #define sqlite3_db_handle sqlite3_api->db_handle
  103150. #define sqlite3_declare_vtab sqlite3_api->declare_vtab
  103151. #define sqlite3_enable_shared_cache sqlite3_api->enable_shared_cache
  103152. #define sqlite3_errcode sqlite3_api->errcode
  103153. #define sqlite3_errmsg sqlite3_api->errmsg
  103154. #define sqlite3_errmsg16 sqlite3_api->errmsg16
  103155. #define sqlite3_exec sqlite3_api->exec
  103156. #ifndef SQLITE_OMIT_DEPRECATED
  103157. #define sqlite3_expired sqlite3_api->expired
  103158. #endif
  103159. #define sqlite3_finalize sqlite3_api->finalize
  103160. #define sqlite3_free sqlite3_api->free
  103161. #define sqlite3_free_table sqlite3_api->free_table
  103162. #define sqlite3_get_autocommit sqlite3_api->get_autocommit
  103163. #define sqlite3_get_auxdata sqlite3_api->get_auxdata
  103164. #define sqlite3_get_table sqlite3_api->get_table
  103165. #ifndef SQLITE_OMIT_DEPRECATED
  103166. #define sqlite3_global_recover sqlite3_api->global_recover
  103167. #endif
  103168. #define sqlite3_interrupt sqlite3_api->interruptx
  103169. #define sqlite3_last_insert_rowid sqlite3_api->last_insert_rowid
  103170. #define sqlite3_libversion sqlite3_api->libversion
  103171. #define sqlite3_libversion_number sqlite3_api->libversion_number
  103172. #define sqlite3_malloc sqlite3_api->malloc
  103173. #define sqlite3_mprintf sqlite3_api->mprintf
  103174. #define sqlite3_open sqlite3_api->open
  103175. #define sqlite3_open16 sqlite3_api->open16
  103176. #define sqlite3_prepare sqlite3_api->prepare
  103177. #define sqlite3_prepare16 sqlite3_api->prepare16
  103178. #define sqlite3_prepare_v2 sqlite3_api->prepare_v2
  103179. #define sqlite3_prepare16_v2 sqlite3_api->prepare16_v2
  103180. #define sqlite3_profile sqlite3_api->profile
  103181. #define sqlite3_progress_handler sqlite3_api->progress_handler
  103182. #define sqlite3_realloc sqlite3_api->realloc
  103183. #define sqlite3_reset sqlite3_api->reset
  103184. #define sqlite3_result_blob sqlite3_api->result_blob
  103185. #define sqlite3_result_double sqlite3_api->result_double
  103186. #define sqlite3_result_error sqlite3_api->result_error
  103187. #define sqlite3_result_error16 sqlite3_api->result_error16
  103188. #define sqlite3_result_int sqlite3_api->result_int
  103189. #define sqlite3_result_int64 sqlite3_api->result_int64
  103190. #define sqlite3_result_null sqlite3_api->result_null
  103191. #define sqlite3_result_text sqlite3_api->result_text
  103192. #define sqlite3_result_text16 sqlite3_api->result_text16
  103193. #define sqlite3_result_text16be sqlite3_api->result_text16be
  103194. #define sqlite3_result_text16le sqlite3_api->result_text16le
  103195. #define sqlite3_result_value sqlite3_api->result_value
  103196. #define sqlite3_rollback_hook sqlite3_api->rollback_hook
  103197. #define sqlite3_set_authorizer sqlite3_api->set_authorizer
  103198. #define sqlite3_set_auxdata sqlite3_api->set_auxdata
  103199. #define sqlite3_snprintf sqlite3_api->snprintf
  103200. #define sqlite3_step sqlite3_api->step
  103201. #define sqlite3_table_column_metadata sqlite3_api->table_column_metadata
  103202. #define sqlite3_thread_cleanup sqlite3_api->thread_cleanup
  103203. #define sqlite3_total_changes sqlite3_api->total_changes
  103204. #define sqlite3_trace sqlite3_api->trace
  103205. #ifndef SQLITE_OMIT_DEPRECATED
  103206. #define sqlite3_transfer_bindings sqlite3_api->transfer_bindings
  103207. #endif
  103208. #define sqlite3_update_hook sqlite3_api->update_hook
  103209. #define sqlite3_user_data sqlite3_api->user_data
  103210. #define sqlite3_value_blob sqlite3_api->value_blob
  103211. #define sqlite3_value_bytes sqlite3_api->value_bytes
  103212. #define sqlite3_value_bytes16 sqlite3_api->value_bytes16
  103213. #define sqlite3_value_double sqlite3_api->value_double
  103214. #define sqlite3_value_int sqlite3_api->value_int
  103215. #define sqlite3_value_int64 sqlite3_api->value_int64
  103216. #define sqlite3_value_numeric_type sqlite3_api->value_numeric_type
  103217. #define sqlite3_value_text sqlite3_api->value_text
  103218. #define sqlite3_value_text16 sqlite3_api->value_text16
  103219. #define sqlite3_value_text16be sqlite3_api->value_text16be
  103220. #define sqlite3_value_text16le sqlite3_api->value_text16le
  103221. #define sqlite3_value_type sqlite3_api->value_type
  103222. #define sqlite3_vmprintf sqlite3_api->vmprintf
  103223. #define sqlite3_vsnprintf sqlite3_api->vsnprintf
  103224. #define sqlite3_overload_function sqlite3_api->overload_function
  103225. #define sqlite3_prepare_v2 sqlite3_api->prepare_v2
  103226. #define sqlite3_prepare16_v2 sqlite3_api->prepare16_v2
  103227. #define sqlite3_clear_bindings sqlite3_api->clear_bindings
  103228. #define sqlite3_bind_zeroblob sqlite3_api->bind_zeroblob
  103229. #define sqlite3_blob_bytes sqlite3_api->blob_bytes
  103230. #define sqlite3_blob_close sqlite3_api->blob_close
  103231. #define sqlite3_blob_open sqlite3_api->blob_open
  103232. #define sqlite3_blob_read sqlite3_api->blob_read
  103233. #define sqlite3_blob_write sqlite3_api->blob_write
  103234. #define sqlite3_create_collation_v2 sqlite3_api->create_collation_v2
  103235. #define sqlite3_file_control sqlite3_api->file_control
  103236. #define sqlite3_memory_highwater sqlite3_api->memory_highwater
  103237. #define sqlite3_memory_used sqlite3_api->memory_used
  103238. #define sqlite3_mutex_alloc sqlite3_api->mutex_alloc
  103239. #define sqlite3_mutex_enter sqlite3_api->mutex_enter
  103240. #define sqlite3_mutex_free sqlite3_api->mutex_free
  103241. #define sqlite3_mutex_leave sqlite3_api->mutex_leave
  103242. #define sqlite3_mutex_try sqlite3_api->mutex_try
  103243. #define sqlite3_open_v2 sqlite3_api->open_v2
  103244. #define sqlite3_release_memory sqlite3_api->release_memory
  103245. #define sqlite3_result_error_nomem sqlite3_api->result_error_nomem
  103246. #define sqlite3_result_error_toobig sqlite3_api->result_error_toobig
  103247. #define sqlite3_sleep sqlite3_api->sleep
  103248. #define sqlite3_soft_heap_limit sqlite3_api->soft_heap_limit
  103249. #define sqlite3_vfs_find sqlite3_api->vfs_find
  103250. #define sqlite3_vfs_register sqlite3_api->vfs_register
  103251. #define sqlite3_vfs_unregister sqlite3_api->vfs_unregister
  103252. #define sqlite3_threadsafe sqlite3_api->xthreadsafe
  103253. #define sqlite3_result_zeroblob sqlite3_api->result_zeroblob
  103254. #define sqlite3_result_error_code sqlite3_api->result_error_code
  103255. #define sqlite3_test_control sqlite3_api->test_control
  103256. #define sqlite3_randomness sqlite3_api->randomness
  103257. #define sqlite3_context_db_handle sqlite3_api->context_db_handle
  103258. #define sqlite3_extended_result_codes sqlite3_api->extended_result_codes
  103259. #define sqlite3_limit sqlite3_api->limit
  103260. #define sqlite3_next_stmt sqlite3_api->next_stmt
  103261. #define sqlite3_sql sqlite3_api->sql
  103262. #define sqlite3_status sqlite3_api->status
  103263. #define sqlite3_backup_finish sqlite3_api->backup_finish
  103264. #define sqlite3_backup_init sqlite3_api->backup_init
  103265. #define sqlite3_backup_pagecount sqlite3_api->backup_pagecount
  103266. #define sqlite3_backup_remaining sqlite3_api->backup_remaining
  103267. #define sqlite3_backup_step sqlite3_api->backup_step
  103268. #define sqlite3_compileoption_get sqlite3_api->compileoption_get
  103269. #define sqlite3_compileoption_used sqlite3_api->compileoption_used
  103270. #define sqlite3_create_function_v2 sqlite3_api->create_function_v2
  103271. #define sqlite3_db_config sqlite3_api->db_config
  103272. #define sqlite3_db_mutex sqlite3_api->db_mutex
  103273. #define sqlite3_db_status sqlite3_api->db_status
  103274. #define sqlite3_extended_errcode sqlite3_api->extended_errcode
  103275. #define sqlite3_log sqlite3_api->log
  103276. #define sqlite3_soft_heap_limit64 sqlite3_api->soft_heap_limit64
  103277. #define sqlite3_sourceid sqlite3_api->sourceid
  103278. #define sqlite3_stmt_status sqlite3_api->stmt_status
  103279. #define sqlite3_strnicmp sqlite3_api->strnicmp
  103280. #define sqlite3_unlock_notify sqlite3_api->unlock_notify
  103281. #define sqlite3_wal_autocheckpoint sqlite3_api->wal_autocheckpoint
  103282. #define sqlite3_wal_checkpoint sqlite3_api->wal_checkpoint
  103283. #define sqlite3_wal_hook sqlite3_api->wal_hook
  103284. #define sqlite3_blob_reopen sqlite3_api->blob_reopen
  103285. #define sqlite3_vtab_config sqlite3_api->vtab_config
  103286. #define sqlite3_vtab_on_conflict sqlite3_api->vtab_on_conflict
  103287. /* Version 3.7.16 and later */
  103288. #define sqlite3_close_v2 sqlite3_api->close_v2
  103289. #define sqlite3_db_filename sqlite3_api->db_filename
  103290. #define sqlite3_db_readonly sqlite3_api->db_readonly
  103291. #define sqlite3_db_release_memory sqlite3_api->db_release_memory
  103292. #define sqlite3_errstr sqlite3_api->errstr
  103293. #define sqlite3_stmt_busy sqlite3_api->stmt_busy
  103294. #define sqlite3_stmt_readonly sqlite3_api->stmt_readonly
  103295. #define sqlite3_stricmp sqlite3_api->stricmp
  103296. #define sqlite3_uri_boolean sqlite3_api->uri_boolean
  103297. #define sqlite3_uri_int64 sqlite3_api->uri_int64
  103298. #define sqlite3_uri_parameter sqlite3_api->uri_parameter
  103299. #define sqlite3_uri_vsnprintf sqlite3_api->vsnprintf
  103300. #define sqlite3_wal_checkpoint_v2 sqlite3_api->wal_checkpoint_v2
  103301. /* Version 3.8.7 and later */
  103302. #define sqlite3_auto_extension sqlite3_api->auto_extension
  103303. #define sqlite3_bind_blob64 sqlite3_api->bind_blob64
  103304. #define sqlite3_bind_text64 sqlite3_api->bind_text64
  103305. #define sqlite3_cancel_auto_extension sqlite3_api->cancel_auto_extension
  103306. #define sqlite3_load_extension sqlite3_api->load_extension
  103307. #define sqlite3_malloc64 sqlite3_api->malloc64
  103308. #define sqlite3_msize sqlite3_api->msize
  103309. #define sqlite3_realloc64 sqlite3_api->realloc64
  103310. #define sqlite3_reset_auto_extension sqlite3_api->reset_auto_extension
  103311. #define sqlite3_result_blob64 sqlite3_api->result_blob64
  103312. #define sqlite3_result_text64 sqlite3_api->result_text64
  103313. #define sqlite3_strglob sqlite3_api->strglob
  103314. /* Version 3.8.11 and later */
  103315. #define sqlite3_value_dup sqlite3_api->value_dup
  103316. #define sqlite3_value_free sqlite3_api->value_free
  103317. #define sqlite3_result_zeroblob64 sqlite3_api->result_zeroblob64
  103318. #define sqlite3_bind_zeroblob64 sqlite3_api->bind_zeroblob64
  103319. /* Version 3.9.0 and later */
  103320. #define sqlite3_value_subtype sqlite3_api->value_subtype
  103321. #define sqlite3_result_subtype sqlite3_api->result_subtype
  103322. /* Version 3.10.0 and later */
  103323. #define sqlite3_status64 sqlite3_api->status64
  103324. #define sqlite3_strlike sqlite3_api->strlike
  103325. #define sqlite3_db_cacheflush sqlite3_api->db_cacheflush
  103326. /* Version 3.12.0 and later */
  103327. #define sqlite3_system_errno sqlite3_api->system_errno
  103328. /* Version 3.14.0 and later */
  103329. #define sqlite3_trace_v2 sqlite3_api->trace_v2
  103330. #define sqlite3_expanded_sql sqlite3_api->expanded_sql
  103331. #endif /* !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) */
  103332. #if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  103333. /* This case when the file really is being compiled as a loadable
  103334. ** extension */
  103335. # define SQLITE_EXTENSION_INIT1 const sqlite3_api_routines *sqlite3_api=0;
  103336. # define SQLITE_EXTENSION_INIT2(v) sqlite3_api=v;
  103337. # define SQLITE_EXTENSION_INIT3 \
  103338. extern const sqlite3_api_routines *sqlite3_api;
  103339. #else
  103340. /* This case when the file is being statically linked into the
  103341. ** application */
  103342. # define SQLITE_EXTENSION_INIT1 /*no-op*/
  103343. # define SQLITE_EXTENSION_INIT2(v) (void)v; /* unused parameter */
  103344. # define SQLITE_EXTENSION_INIT3 /*no-op*/
  103345. #endif
  103346. #endif /* SQLITE3EXT_H */
  103347. /************** End of sqlite3ext.h ******************************************/
  103348. /************** Continuing where we left off in loadext.c ********************/
  103349. /* #include "sqliteInt.h" */
  103350. /* #include <string.h> */
  103351. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  103352. /*
  103353. ** Some API routines are omitted when various features are
  103354. ** excluded from a build of SQLite. Substitute a NULL pointer
  103355. ** for any missing APIs.
  103356. */
  103357. #ifndef SQLITE_ENABLE_COLUMN_METADATA
  103358. # define sqlite3_column_database_name 0
  103359. # define sqlite3_column_database_name16 0
  103360. # define sqlite3_column_table_name 0
  103361. # define sqlite3_column_table_name16 0
  103362. # define sqlite3_column_origin_name 0
  103363. # define sqlite3_column_origin_name16 0
  103364. #endif
  103365. #ifdef SQLITE_OMIT_AUTHORIZATION
  103366. # define sqlite3_set_authorizer 0
  103367. #endif
  103368. #ifdef SQLITE_OMIT_UTF16
  103369. # define sqlite3_bind_text16 0
  103370. # define sqlite3_collation_needed16 0
  103371. # define sqlite3_column_decltype16 0
  103372. # define sqlite3_column_name16 0
  103373. # define sqlite3_column_text16 0
  103374. # define sqlite3_complete16 0
  103375. # define sqlite3_create_collation16 0
  103376. # define sqlite3_create_function16 0
  103377. # define sqlite3_errmsg16 0
  103378. # define sqlite3_open16 0
  103379. # define sqlite3_prepare16 0
  103380. # define sqlite3_prepare16_v2 0
  103381. # define sqlite3_result_error16 0
  103382. # define sqlite3_result_text16 0
  103383. # define sqlite3_result_text16be 0
  103384. # define sqlite3_result_text16le 0
  103385. # define sqlite3_value_text16 0
  103386. # define sqlite3_value_text16be 0
  103387. # define sqlite3_value_text16le 0
  103388. # define sqlite3_column_database_name16 0
  103389. # define sqlite3_column_table_name16 0
  103390. # define sqlite3_column_origin_name16 0
  103391. #endif
  103392. #ifdef SQLITE_OMIT_COMPLETE
  103393. # define sqlite3_complete 0
  103394. # define sqlite3_complete16 0
  103395. #endif
  103396. #ifdef SQLITE_OMIT_DECLTYPE
  103397. # define sqlite3_column_decltype16 0
  103398. # define sqlite3_column_decltype 0
  103399. #endif
  103400. #ifdef SQLITE_OMIT_PROGRESS_CALLBACK
  103401. # define sqlite3_progress_handler 0
  103402. #endif
  103403. #ifdef SQLITE_OMIT_VIRTUALTABLE
  103404. # define sqlite3_create_module 0
  103405. # define sqlite3_create_module_v2 0
  103406. # define sqlite3_declare_vtab 0
  103407. # define sqlite3_vtab_config 0
  103408. # define sqlite3_vtab_on_conflict 0
  103409. #endif
  103410. #ifdef SQLITE_OMIT_SHARED_CACHE
  103411. # define sqlite3_enable_shared_cache 0
  103412. #endif
  103413. #if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
  103414. # define sqlite3_profile 0
  103415. # define sqlite3_trace 0
  103416. #endif
  103417. #ifdef SQLITE_OMIT_GET_TABLE
  103418. # define sqlite3_free_table 0
  103419. # define sqlite3_get_table 0
  103420. #endif
  103421. #ifdef SQLITE_OMIT_INCRBLOB
  103422. #define sqlite3_bind_zeroblob 0
  103423. #define sqlite3_blob_bytes 0
  103424. #define sqlite3_blob_close 0
  103425. #define sqlite3_blob_open 0
  103426. #define sqlite3_blob_read 0
  103427. #define sqlite3_blob_write 0
  103428. #define sqlite3_blob_reopen 0
  103429. #endif
  103430. #if defined(SQLITE_OMIT_TRACE)
  103431. # define sqlite3_trace_v2 0
  103432. #endif
  103433. /*
  103434. ** The following structure contains pointers to all SQLite API routines.
  103435. ** A pointer to this structure is passed into extensions when they are
  103436. ** loaded so that the extension can make calls back into the SQLite
  103437. ** library.
  103438. **
  103439. ** When adding new APIs, add them to the bottom of this structure
  103440. ** in order to preserve backwards compatibility.
  103441. **
  103442. ** Extensions that use newer APIs should first call the
  103443. ** sqlite3_libversion_number() to make sure that the API they
  103444. ** intend to use is supported by the library. Extensions should
  103445. ** also check to make sure that the pointer to the function is
  103446. ** not NULL before calling it.
  103447. */
  103448. static const sqlite3_api_routines sqlite3Apis = {
  103449. sqlite3_aggregate_context,
  103450. #ifndef SQLITE_OMIT_DEPRECATED
  103451. sqlite3_aggregate_count,
  103452. #else
  103453. 0,
  103454. #endif
  103455. sqlite3_bind_blob,
  103456. sqlite3_bind_double,
  103457. sqlite3_bind_int,
  103458. sqlite3_bind_int64,
  103459. sqlite3_bind_null,
  103460. sqlite3_bind_parameter_count,
  103461. sqlite3_bind_parameter_index,
  103462. sqlite3_bind_parameter_name,
  103463. sqlite3_bind_text,
  103464. sqlite3_bind_text16,
  103465. sqlite3_bind_value,
  103466. sqlite3_busy_handler,
  103467. sqlite3_busy_timeout,
  103468. sqlite3_changes,
  103469. sqlite3_close,
  103470. sqlite3_collation_needed,
  103471. sqlite3_collation_needed16,
  103472. sqlite3_column_blob,
  103473. sqlite3_column_bytes,
  103474. sqlite3_column_bytes16,
  103475. sqlite3_column_count,
  103476. sqlite3_column_database_name,
  103477. sqlite3_column_database_name16,
  103478. sqlite3_column_decltype,
  103479. sqlite3_column_decltype16,
  103480. sqlite3_column_double,
  103481. sqlite3_column_int,
  103482. sqlite3_column_int64,
  103483. sqlite3_column_name,
  103484. sqlite3_column_name16,
  103485. sqlite3_column_origin_name,
  103486. sqlite3_column_origin_name16,
  103487. sqlite3_column_table_name,
  103488. sqlite3_column_table_name16,
  103489. sqlite3_column_text,
  103490. sqlite3_column_text16,
  103491. sqlite3_column_type,
  103492. sqlite3_column_value,
  103493. sqlite3_commit_hook,
  103494. sqlite3_complete,
  103495. sqlite3_complete16,
  103496. sqlite3_create_collation,
  103497. sqlite3_create_collation16,
  103498. sqlite3_create_function,
  103499. sqlite3_create_function16,
  103500. sqlite3_create_module,
  103501. sqlite3_data_count,
  103502. sqlite3_db_handle,
  103503. sqlite3_declare_vtab,
  103504. sqlite3_enable_shared_cache,
  103505. sqlite3_errcode,
  103506. sqlite3_errmsg,
  103507. sqlite3_errmsg16,
  103508. sqlite3_exec,
  103509. #ifndef SQLITE_OMIT_DEPRECATED
  103510. sqlite3_expired,
  103511. #else
  103512. 0,
  103513. #endif
  103514. sqlite3_finalize,
  103515. sqlite3_free,
  103516. sqlite3_free_table,
  103517. sqlite3_get_autocommit,
  103518. sqlite3_get_auxdata,
  103519. sqlite3_get_table,
  103520. 0, /* Was sqlite3_global_recover(), but that function is deprecated */
  103521. sqlite3_interrupt,
  103522. sqlite3_last_insert_rowid,
  103523. sqlite3_libversion,
  103524. sqlite3_libversion_number,
  103525. sqlite3_malloc,
  103526. sqlite3_mprintf,
  103527. sqlite3_open,
  103528. sqlite3_open16,
  103529. sqlite3_prepare,
  103530. sqlite3_prepare16,
  103531. sqlite3_profile,
  103532. sqlite3_progress_handler,
  103533. sqlite3_realloc,
  103534. sqlite3_reset,
  103535. sqlite3_result_blob,
  103536. sqlite3_result_double,
  103537. sqlite3_result_error,
  103538. sqlite3_result_error16,
  103539. sqlite3_result_int,
  103540. sqlite3_result_int64,
  103541. sqlite3_result_null,
  103542. sqlite3_result_text,
  103543. sqlite3_result_text16,
  103544. sqlite3_result_text16be,
  103545. sqlite3_result_text16le,
  103546. sqlite3_result_value,
  103547. sqlite3_rollback_hook,
  103548. sqlite3_set_authorizer,
  103549. sqlite3_set_auxdata,
  103550. sqlite3_snprintf,
  103551. sqlite3_step,
  103552. sqlite3_table_column_metadata,
  103553. #ifndef SQLITE_OMIT_DEPRECATED
  103554. sqlite3_thread_cleanup,
  103555. #else
  103556. 0,
  103557. #endif
  103558. sqlite3_total_changes,
  103559. sqlite3_trace,
  103560. #ifndef SQLITE_OMIT_DEPRECATED
  103561. sqlite3_transfer_bindings,
  103562. #else
  103563. 0,
  103564. #endif
  103565. sqlite3_update_hook,
  103566. sqlite3_user_data,
  103567. sqlite3_value_blob,
  103568. sqlite3_value_bytes,
  103569. sqlite3_value_bytes16,
  103570. sqlite3_value_double,
  103571. sqlite3_value_int,
  103572. sqlite3_value_int64,
  103573. sqlite3_value_numeric_type,
  103574. sqlite3_value_text,
  103575. sqlite3_value_text16,
  103576. sqlite3_value_text16be,
  103577. sqlite3_value_text16le,
  103578. sqlite3_value_type,
  103579. sqlite3_vmprintf,
  103580. /*
  103581. ** The original API set ends here. All extensions can call any
  103582. ** of the APIs above provided that the pointer is not NULL. But
  103583. ** before calling APIs that follow, extension should check the
  103584. ** sqlite3_libversion_number() to make sure they are dealing with
  103585. ** a library that is new enough to support that API.
  103586. *************************************************************************
  103587. */
  103588. sqlite3_overload_function,
  103589. /*
  103590. ** Added after 3.3.13
  103591. */
  103592. sqlite3_prepare_v2,
  103593. sqlite3_prepare16_v2,
  103594. sqlite3_clear_bindings,
  103595. /*
  103596. ** Added for 3.4.1
  103597. */
  103598. sqlite3_create_module_v2,
  103599. /*
  103600. ** Added for 3.5.0
  103601. */
  103602. sqlite3_bind_zeroblob,
  103603. sqlite3_blob_bytes,
  103604. sqlite3_blob_close,
  103605. sqlite3_blob_open,
  103606. sqlite3_blob_read,
  103607. sqlite3_blob_write,
  103608. sqlite3_create_collation_v2,
  103609. sqlite3_file_control,
  103610. sqlite3_memory_highwater,
  103611. sqlite3_memory_used,
  103612. #ifdef SQLITE_MUTEX_OMIT
  103613. 0,
  103614. 0,
  103615. 0,
  103616. 0,
  103617. 0,
  103618. #else
  103619. sqlite3_mutex_alloc,
  103620. sqlite3_mutex_enter,
  103621. sqlite3_mutex_free,
  103622. sqlite3_mutex_leave,
  103623. sqlite3_mutex_try,
  103624. #endif
  103625. sqlite3_open_v2,
  103626. sqlite3_release_memory,
  103627. sqlite3_result_error_nomem,
  103628. sqlite3_result_error_toobig,
  103629. sqlite3_sleep,
  103630. sqlite3_soft_heap_limit,
  103631. sqlite3_vfs_find,
  103632. sqlite3_vfs_register,
  103633. sqlite3_vfs_unregister,
  103634. /*
  103635. ** Added for 3.5.8
  103636. */
  103637. sqlite3_threadsafe,
  103638. sqlite3_result_zeroblob,
  103639. sqlite3_result_error_code,
  103640. sqlite3_test_control,
  103641. sqlite3_randomness,
  103642. sqlite3_context_db_handle,
  103643. /*
  103644. ** Added for 3.6.0
  103645. */
  103646. sqlite3_extended_result_codes,
  103647. sqlite3_limit,
  103648. sqlite3_next_stmt,
  103649. sqlite3_sql,
  103650. sqlite3_status,
  103651. /*
  103652. ** Added for 3.7.4
  103653. */
  103654. sqlite3_backup_finish,
  103655. sqlite3_backup_init,
  103656. sqlite3_backup_pagecount,
  103657. sqlite3_backup_remaining,
  103658. sqlite3_backup_step,
  103659. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  103660. sqlite3_compileoption_get,
  103661. sqlite3_compileoption_used,
  103662. #else
  103663. 0,
  103664. 0,
  103665. #endif
  103666. sqlite3_create_function_v2,
  103667. sqlite3_db_config,
  103668. sqlite3_db_mutex,
  103669. sqlite3_db_status,
  103670. sqlite3_extended_errcode,
  103671. sqlite3_log,
  103672. sqlite3_soft_heap_limit64,
  103673. sqlite3_sourceid,
  103674. sqlite3_stmt_status,
  103675. sqlite3_strnicmp,
  103676. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  103677. sqlite3_unlock_notify,
  103678. #else
  103679. 0,
  103680. #endif
  103681. #ifndef SQLITE_OMIT_WAL
  103682. sqlite3_wal_autocheckpoint,
  103683. sqlite3_wal_checkpoint,
  103684. sqlite3_wal_hook,
  103685. #else
  103686. 0,
  103687. 0,
  103688. 0,
  103689. #endif
  103690. sqlite3_blob_reopen,
  103691. sqlite3_vtab_config,
  103692. sqlite3_vtab_on_conflict,
  103693. sqlite3_close_v2,
  103694. sqlite3_db_filename,
  103695. sqlite3_db_readonly,
  103696. sqlite3_db_release_memory,
  103697. sqlite3_errstr,
  103698. sqlite3_stmt_busy,
  103699. sqlite3_stmt_readonly,
  103700. sqlite3_stricmp,
  103701. sqlite3_uri_boolean,
  103702. sqlite3_uri_int64,
  103703. sqlite3_uri_parameter,
  103704. sqlite3_vsnprintf,
  103705. sqlite3_wal_checkpoint_v2,
  103706. /* Version 3.8.7 and later */
  103707. sqlite3_auto_extension,
  103708. sqlite3_bind_blob64,
  103709. sqlite3_bind_text64,
  103710. sqlite3_cancel_auto_extension,
  103711. sqlite3_load_extension,
  103712. sqlite3_malloc64,
  103713. sqlite3_msize,
  103714. sqlite3_realloc64,
  103715. sqlite3_reset_auto_extension,
  103716. sqlite3_result_blob64,
  103717. sqlite3_result_text64,
  103718. sqlite3_strglob,
  103719. /* Version 3.8.11 and later */
  103720. (sqlite3_value*(*)(const sqlite3_value*))sqlite3_value_dup,
  103721. sqlite3_value_free,
  103722. sqlite3_result_zeroblob64,
  103723. sqlite3_bind_zeroblob64,
  103724. /* Version 3.9.0 and later */
  103725. sqlite3_value_subtype,
  103726. sqlite3_result_subtype,
  103727. /* Version 3.10.0 and later */
  103728. sqlite3_status64,
  103729. sqlite3_strlike,
  103730. sqlite3_db_cacheflush,
  103731. /* Version 3.12.0 and later */
  103732. sqlite3_system_errno,
  103733. /* Version 3.14.0 and later */
  103734. sqlite3_trace_v2,
  103735. sqlite3_expanded_sql
  103736. };
  103737. /*
  103738. ** Attempt to load an SQLite extension library contained in the file
  103739. ** zFile. The entry point is zProc. zProc may be 0 in which case a
  103740. ** default entry point name (sqlite3_extension_init) is used. Use
  103741. ** of the default name is recommended.
  103742. **
  103743. ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
  103744. **
  103745. ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
  103746. ** error message text. The calling function should free this memory
  103747. ** by calling sqlite3DbFree(db, ).
  103748. */
  103749. static int sqlite3LoadExtension(
  103750. sqlite3 *db, /* Load the extension into this database connection */
  103751. const char *zFile, /* Name of the shared library containing extension */
  103752. const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
  103753. char **pzErrMsg /* Put error message here if not 0 */
  103754. ){
  103755. sqlite3_vfs *pVfs = db->pVfs;
  103756. void *handle;
  103757. sqlite3_loadext_entry xInit;
  103758. char *zErrmsg = 0;
  103759. const char *zEntry;
  103760. char *zAltEntry = 0;
  103761. void **aHandle;
  103762. u64 nMsg = 300 + sqlite3Strlen30(zFile);
  103763. int ii;
  103764. int rc;
  103765. /* Shared library endings to try if zFile cannot be loaded as written */
  103766. static const char *azEndings[] = {
  103767. #if SQLITE_OS_WIN
  103768. "dll"
  103769. #elif defined(__APPLE__)
  103770. "dylib"
  103771. #else
  103772. "so"
  103773. #endif
  103774. };
  103775. if( pzErrMsg ) *pzErrMsg = 0;
  103776. /* Ticket #1863. To avoid a creating security problems for older
  103777. ** applications that relink against newer versions of SQLite, the
  103778. ** ability to run load_extension is turned off by default. One
  103779. ** must call either sqlite3_enable_load_extension(db) or
  103780. ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
  103781. ** to turn on extension loading.
  103782. */
  103783. if( (db->flags & SQLITE_LoadExtension)==0 ){
  103784. if( pzErrMsg ){
  103785. *pzErrMsg = sqlite3_mprintf("not authorized");
  103786. }
  103787. return SQLITE_ERROR;
  103788. }
  103789. zEntry = zProc ? zProc : "sqlite3_extension_init";
  103790. handle = sqlite3OsDlOpen(pVfs, zFile);
  103791. #if SQLITE_OS_UNIX || SQLITE_OS_WIN
  103792. for(ii=0; ii<ArraySize(azEndings) && handle==0; ii++){
  103793. char *zAltFile = sqlite3_mprintf("%s.%s", zFile, azEndings[ii]);
  103794. if( zAltFile==0 ) return SQLITE_NOMEM_BKPT;
  103795. handle = sqlite3OsDlOpen(pVfs, zAltFile);
  103796. sqlite3_free(zAltFile);
  103797. }
  103798. #endif
  103799. if( handle==0 ){
  103800. if( pzErrMsg ){
  103801. *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
  103802. if( zErrmsg ){
  103803. sqlite3_snprintf(nMsg, zErrmsg,
  103804. "unable to open shared library [%s]", zFile);
  103805. sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
  103806. }
  103807. }
  103808. return SQLITE_ERROR;
  103809. }
  103810. xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
  103811. /* If no entry point was specified and the default legacy
  103812. ** entry point name "sqlite3_extension_init" was not found, then
  103813. ** construct an entry point name "sqlite3_X_init" where the X is
  103814. ** replaced by the lowercase value of every ASCII alphabetic
  103815. ** character in the filename after the last "/" upto the first ".",
  103816. ** and eliding the first three characters if they are "lib".
  103817. ** Examples:
  103818. **
  103819. ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
  103820. ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
  103821. */
  103822. if( xInit==0 && zProc==0 ){
  103823. int iFile, iEntry, c;
  103824. int ncFile = sqlite3Strlen30(zFile);
  103825. zAltEntry = sqlite3_malloc64(ncFile+30);
  103826. if( zAltEntry==0 ){
  103827. sqlite3OsDlClose(pVfs, handle);
  103828. return SQLITE_NOMEM_BKPT;
  103829. }
  103830. memcpy(zAltEntry, "sqlite3_", 8);
  103831. for(iFile=ncFile-1; iFile>=0 && zFile[iFile]!='/'; iFile--){}
  103832. iFile++;
  103833. if( sqlite3_strnicmp(zFile+iFile, "lib", 3)==0 ) iFile += 3;
  103834. for(iEntry=8; (c = zFile[iFile])!=0 && c!='.'; iFile++){
  103835. if( sqlite3Isalpha(c) ){
  103836. zAltEntry[iEntry++] = (char)sqlite3UpperToLower[(unsigned)c];
  103837. }
  103838. }
  103839. memcpy(zAltEntry+iEntry, "_init", 6);
  103840. zEntry = zAltEntry;
  103841. xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
  103842. }
  103843. if( xInit==0 ){
  103844. if( pzErrMsg ){
  103845. nMsg += sqlite3Strlen30(zEntry);
  103846. *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
  103847. if( zErrmsg ){
  103848. sqlite3_snprintf(nMsg, zErrmsg,
  103849. "no entry point [%s] in shared library [%s]", zEntry, zFile);
  103850. sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
  103851. }
  103852. }
  103853. sqlite3OsDlClose(pVfs, handle);
  103854. sqlite3_free(zAltEntry);
  103855. return SQLITE_ERROR;
  103856. }
  103857. sqlite3_free(zAltEntry);
  103858. rc = xInit(db, &zErrmsg, &sqlite3Apis);
  103859. if( rc ){
  103860. if( rc==SQLITE_OK_LOAD_PERMANENTLY ) return SQLITE_OK;
  103861. if( pzErrMsg ){
  103862. *pzErrMsg = sqlite3_mprintf("error during initialization: %s", zErrmsg);
  103863. }
  103864. sqlite3_free(zErrmsg);
  103865. sqlite3OsDlClose(pVfs, handle);
  103866. return SQLITE_ERROR;
  103867. }
  103868. /* Append the new shared library handle to the db->aExtension array. */
  103869. aHandle = sqlite3DbMallocZero(db, sizeof(handle)*(db->nExtension+1));
  103870. if( aHandle==0 ){
  103871. return SQLITE_NOMEM_BKPT;
  103872. }
  103873. if( db->nExtension>0 ){
  103874. memcpy(aHandle, db->aExtension, sizeof(handle)*db->nExtension);
  103875. }
  103876. sqlite3DbFree(db, db->aExtension);
  103877. db->aExtension = aHandle;
  103878. db->aExtension[db->nExtension++] = handle;
  103879. return SQLITE_OK;
  103880. }
  103881. SQLITE_API int sqlite3_load_extension(
  103882. sqlite3 *db, /* Load the extension into this database connection */
  103883. const char *zFile, /* Name of the shared library containing extension */
  103884. const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
  103885. char **pzErrMsg /* Put error message here if not 0 */
  103886. ){
  103887. int rc;
  103888. sqlite3_mutex_enter(db->mutex);
  103889. rc = sqlite3LoadExtension(db, zFile, zProc, pzErrMsg);
  103890. rc = sqlite3ApiExit(db, rc);
  103891. sqlite3_mutex_leave(db->mutex);
  103892. return rc;
  103893. }
  103894. /*
  103895. ** Call this routine when the database connection is closing in order
  103896. ** to clean up loaded extensions
  103897. */
  103898. SQLITE_PRIVATE void sqlite3CloseExtensions(sqlite3 *db){
  103899. int i;
  103900. assert( sqlite3_mutex_held(db->mutex) );
  103901. for(i=0; i<db->nExtension; i++){
  103902. sqlite3OsDlClose(db->pVfs, db->aExtension[i]);
  103903. }
  103904. sqlite3DbFree(db, db->aExtension);
  103905. }
  103906. /*
  103907. ** Enable or disable extension loading. Extension loading is disabled by
  103908. ** default so as not to open security holes in older applications.
  103909. */
  103910. SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff){
  103911. sqlite3_mutex_enter(db->mutex);
  103912. if( onoff ){
  103913. db->flags |= SQLITE_LoadExtension|SQLITE_LoadExtFunc;
  103914. }else{
  103915. db->flags &= ~(SQLITE_LoadExtension|SQLITE_LoadExtFunc);
  103916. }
  103917. sqlite3_mutex_leave(db->mutex);
  103918. return SQLITE_OK;
  103919. }
  103920. #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
  103921. /*
  103922. ** The following object holds the list of automatically loaded
  103923. ** extensions.
  103924. **
  103925. ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
  103926. ** mutex must be held while accessing this list.
  103927. */
  103928. typedef struct sqlite3AutoExtList sqlite3AutoExtList;
  103929. static SQLITE_WSD struct sqlite3AutoExtList {
  103930. u32 nExt; /* Number of entries in aExt[] */
  103931. void (**aExt)(void); /* Pointers to the extension init functions */
  103932. } sqlite3Autoext = { 0, 0 };
  103933. /* The "wsdAutoext" macro will resolve to the autoextension
  103934. ** state vector. If writable static data is unsupported on the target,
  103935. ** we have to locate the state vector at run-time. In the more common
  103936. ** case where writable static data is supported, wsdStat can refer directly
  103937. ** to the "sqlite3Autoext" state vector declared above.
  103938. */
  103939. #ifdef SQLITE_OMIT_WSD
  103940. # define wsdAutoextInit \
  103941. sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
  103942. # define wsdAutoext x[0]
  103943. #else
  103944. # define wsdAutoextInit
  103945. # define wsdAutoext sqlite3Autoext
  103946. #endif
  103947. /*
  103948. ** Register a statically linked extension that is automatically
  103949. ** loaded by every new database connection.
  103950. */
  103951. SQLITE_API int sqlite3_auto_extension(
  103952. void (*xInit)(void)
  103953. ){
  103954. int rc = SQLITE_OK;
  103955. #ifndef SQLITE_OMIT_AUTOINIT
  103956. rc = sqlite3_initialize();
  103957. if( rc ){
  103958. return rc;
  103959. }else
  103960. #endif
  103961. {
  103962. u32 i;
  103963. #if SQLITE_THREADSAFE
  103964. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  103965. #endif
  103966. wsdAutoextInit;
  103967. sqlite3_mutex_enter(mutex);
  103968. for(i=0; i<wsdAutoext.nExt; i++){
  103969. if( wsdAutoext.aExt[i]==xInit ) break;
  103970. }
  103971. if( i==wsdAutoext.nExt ){
  103972. u64 nByte = (wsdAutoext.nExt+1)*sizeof(wsdAutoext.aExt[0]);
  103973. void (**aNew)(void);
  103974. aNew = sqlite3_realloc64(wsdAutoext.aExt, nByte);
  103975. if( aNew==0 ){
  103976. rc = SQLITE_NOMEM_BKPT;
  103977. }else{
  103978. wsdAutoext.aExt = aNew;
  103979. wsdAutoext.aExt[wsdAutoext.nExt] = xInit;
  103980. wsdAutoext.nExt++;
  103981. }
  103982. }
  103983. sqlite3_mutex_leave(mutex);
  103984. assert( (rc&0xff)==rc );
  103985. return rc;
  103986. }
  103987. }
  103988. /*
  103989. ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
  103990. ** set of routines that is invoked for each new database connection, if it
  103991. ** is currently on the list. If xInit is not on the list, then this
  103992. ** routine is a no-op.
  103993. **
  103994. ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
  103995. ** was not on the list.
  103996. */
  103997. SQLITE_API int sqlite3_cancel_auto_extension(
  103998. void (*xInit)(void)
  103999. ){
  104000. #if SQLITE_THREADSAFE
  104001. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  104002. #endif
  104003. int i;
  104004. int n = 0;
  104005. wsdAutoextInit;
  104006. sqlite3_mutex_enter(mutex);
  104007. for(i=(int)wsdAutoext.nExt-1; i>=0; i--){
  104008. if( wsdAutoext.aExt[i]==xInit ){
  104009. wsdAutoext.nExt--;
  104010. wsdAutoext.aExt[i] = wsdAutoext.aExt[wsdAutoext.nExt];
  104011. n++;
  104012. break;
  104013. }
  104014. }
  104015. sqlite3_mutex_leave(mutex);
  104016. return n;
  104017. }
  104018. /*
  104019. ** Reset the automatic extension loading mechanism.
  104020. */
  104021. SQLITE_API void sqlite3_reset_auto_extension(void){
  104022. #ifndef SQLITE_OMIT_AUTOINIT
  104023. if( sqlite3_initialize()==SQLITE_OK )
  104024. #endif
  104025. {
  104026. #if SQLITE_THREADSAFE
  104027. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  104028. #endif
  104029. wsdAutoextInit;
  104030. sqlite3_mutex_enter(mutex);
  104031. sqlite3_free(wsdAutoext.aExt);
  104032. wsdAutoext.aExt = 0;
  104033. wsdAutoext.nExt = 0;
  104034. sqlite3_mutex_leave(mutex);
  104035. }
  104036. }
  104037. /*
  104038. ** Load all automatic extensions.
  104039. **
  104040. ** If anything goes wrong, set an error in the database connection.
  104041. */
  104042. SQLITE_PRIVATE void sqlite3AutoLoadExtensions(sqlite3 *db){
  104043. u32 i;
  104044. int go = 1;
  104045. int rc;
  104046. sqlite3_loadext_entry xInit;
  104047. wsdAutoextInit;
  104048. if( wsdAutoext.nExt==0 ){
  104049. /* Common case: early out without every having to acquire a mutex */
  104050. return;
  104051. }
  104052. for(i=0; go; i++){
  104053. char *zErrmsg;
  104054. #if SQLITE_THREADSAFE
  104055. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  104056. #endif
  104057. #ifdef SQLITE_OMIT_LOAD_EXTENSION
  104058. const sqlite3_api_routines *pThunk = 0;
  104059. #else
  104060. const sqlite3_api_routines *pThunk = &sqlite3Apis;
  104061. #endif
  104062. sqlite3_mutex_enter(mutex);
  104063. if( i>=wsdAutoext.nExt ){
  104064. xInit = 0;
  104065. go = 0;
  104066. }else{
  104067. xInit = (sqlite3_loadext_entry)wsdAutoext.aExt[i];
  104068. }
  104069. sqlite3_mutex_leave(mutex);
  104070. zErrmsg = 0;
  104071. if( xInit && (rc = xInit(db, &zErrmsg, pThunk))!=0 ){
  104072. sqlite3ErrorWithMsg(db, rc,
  104073. "automatic extension loading failed: %s", zErrmsg);
  104074. go = 0;
  104075. }
  104076. sqlite3_free(zErrmsg);
  104077. }
  104078. }
  104079. /************** End of loadext.c *********************************************/
  104080. /************** Begin file pragma.c ******************************************/
  104081. /*
  104082. ** 2003 April 6
  104083. **
  104084. ** The author disclaims copyright to this source code. In place of
  104085. ** a legal notice, here is a blessing:
  104086. **
  104087. ** May you do good and not evil.
  104088. ** May you find forgiveness for yourself and forgive others.
  104089. ** May you share freely, never taking more than you give.
  104090. **
  104091. *************************************************************************
  104092. ** This file contains code used to implement the PRAGMA command.
  104093. */
  104094. /* #include "sqliteInt.h" */
  104095. #if !defined(SQLITE_ENABLE_LOCKING_STYLE)
  104096. # if defined(__APPLE__)
  104097. # define SQLITE_ENABLE_LOCKING_STYLE 1
  104098. # else
  104099. # define SQLITE_ENABLE_LOCKING_STYLE 0
  104100. # endif
  104101. #endif
  104102. /***************************************************************************
  104103. ** The "pragma.h" include file is an automatically generated file that
  104104. ** that includes the PragType_XXXX macro definitions and the aPragmaName[]
  104105. ** object. This ensures that the aPragmaName[] table is arranged in
  104106. ** lexicographical order to facility a binary search of the pragma name.
  104107. ** Do not edit pragma.h directly. Edit and rerun the script in at
  104108. ** ../tool/mkpragmatab.tcl. */
  104109. /************** Include pragma.h in the middle of pragma.c *******************/
  104110. /************** Begin file pragma.h ******************************************/
  104111. /* DO NOT EDIT!
  104112. ** This file is automatically generated by the script at
  104113. ** ../tool/mkpragmatab.tcl. To update the set of pragmas, edit
  104114. ** that script and rerun it.
  104115. */
  104116. #define PragTyp_HEADER_VALUE 0
  104117. #define PragTyp_AUTO_VACUUM 1
  104118. #define PragTyp_FLAG 2
  104119. #define PragTyp_BUSY_TIMEOUT 3
  104120. #define PragTyp_CACHE_SIZE 4
  104121. #define PragTyp_CACHE_SPILL 5
  104122. #define PragTyp_CASE_SENSITIVE_LIKE 6
  104123. #define PragTyp_COLLATION_LIST 7
  104124. #define PragTyp_COMPILE_OPTIONS 8
  104125. #define PragTyp_DATA_STORE_DIRECTORY 9
  104126. #define PragTyp_DATABASE_LIST 10
  104127. #define PragTyp_DEFAULT_CACHE_SIZE 11
  104128. #define PragTyp_ENCODING 12
  104129. #define PragTyp_FOREIGN_KEY_CHECK 13
  104130. #define PragTyp_FOREIGN_KEY_LIST 14
  104131. #define PragTyp_INCREMENTAL_VACUUM 15
  104132. #define PragTyp_INDEX_INFO 16
  104133. #define PragTyp_INDEX_LIST 17
  104134. #define PragTyp_INTEGRITY_CHECK 18
  104135. #define PragTyp_JOURNAL_MODE 19
  104136. #define PragTyp_JOURNAL_SIZE_LIMIT 20
  104137. #define PragTyp_LOCK_PROXY_FILE 21
  104138. #define PragTyp_LOCKING_MODE 22
  104139. #define PragTyp_PAGE_COUNT 23
  104140. #define PragTyp_MMAP_SIZE 24
  104141. #define PragTyp_PAGE_SIZE 25
  104142. #define PragTyp_SECURE_DELETE 26
  104143. #define PragTyp_SHRINK_MEMORY 27
  104144. #define PragTyp_SOFT_HEAP_LIMIT 28
  104145. #define PragTyp_STATS 29
  104146. #define PragTyp_SYNCHRONOUS 30
  104147. #define PragTyp_TABLE_INFO 31
  104148. #define PragTyp_TEMP_STORE 32
  104149. #define PragTyp_TEMP_STORE_DIRECTORY 33
  104150. #define PragTyp_THREADS 34
  104151. #define PragTyp_WAL_AUTOCHECKPOINT 35
  104152. #define PragTyp_WAL_CHECKPOINT 36
  104153. #define PragTyp_ACTIVATE_EXTENSIONS 37
  104154. #define PragTyp_HEXKEY 38
  104155. #define PragTyp_KEY 39
  104156. #define PragTyp_REKEY 40
  104157. #define PragTyp_LOCK_STATUS 41
  104158. #define PragTyp_PARSER_TRACE 42
  104159. #define PragFlag_NeedSchema 0x01
  104160. #define PragFlag_ReadOnly 0x02
  104161. static const struct sPragmaNames {
  104162. const char *const zName; /* Name of pragma */
  104163. u8 ePragTyp; /* PragTyp_XXX value */
  104164. u8 mPragFlag; /* Zero or more PragFlag_XXX values */
  104165. u32 iArg; /* Extra argument */
  104166. } aPragmaNames[] = {
  104167. #if defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
  104168. { /* zName: */ "activate_extensions",
  104169. /* ePragTyp: */ PragTyp_ACTIVATE_EXTENSIONS,
  104170. /* ePragFlag: */ 0,
  104171. /* iArg: */ 0 },
  104172. #endif
  104173. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  104174. { /* zName: */ "application_id",
  104175. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  104176. /* ePragFlag: */ 0,
  104177. /* iArg: */ BTREE_APPLICATION_ID },
  104178. #endif
  104179. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  104180. { /* zName: */ "auto_vacuum",
  104181. /* ePragTyp: */ PragTyp_AUTO_VACUUM,
  104182. /* ePragFlag: */ PragFlag_NeedSchema,
  104183. /* iArg: */ 0 },
  104184. #endif
  104185. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104186. #if !defined(SQLITE_OMIT_AUTOMATIC_INDEX)
  104187. { /* zName: */ "automatic_index",
  104188. /* ePragTyp: */ PragTyp_FLAG,
  104189. /* ePragFlag: */ 0,
  104190. /* iArg: */ SQLITE_AutoIndex },
  104191. #endif
  104192. #endif
  104193. { /* zName: */ "busy_timeout",
  104194. /* ePragTyp: */ PragTyp_BUSY_TIMEOUT,
  104195. /* ePragFlag: */ 0,
  104196. /* iArg: */ 0 },
  104197. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104198. { /* zName: */ "cache_size",
  104199. /* ePragTyp: */ PragTyp_CACHE_SIZE,
  104200. /* ePragFlag: */ PragFlag_NeedSchema,
  104201. /* iArg: */ 0 },
  104202. #endif
  104203. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104204. { /* zName: */ "cache_spill",
  104205. /* ePragTyp: */ PragTyp_CACHE_SPILL,
  104206. /* ePragFlag: */ 0,
  104207. /* iArg: */ 0 },
  104208. #endif
  104209. { /* zName: */ "case_sensitive_like",
  104210. /* ePragTyp: */ PragTyp_CASE_SENSITIVE_LIKE,
  104211. /* ePragFlag: */ 0,
  104212. /* iArg: */ 0 },
  104213. { /* zName: */ "cell_size_check",
  104214. /* ePragTyp: */ PragTyp_FLAG,
  104215. /* ePragFlag: */ 0,
  104216. /* iArg: */ SQLITE_CellSizeCk },
  104217. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104218. { /* zName: */ "checkpoint_fullfsync",
  104219. /* ePragTyp: */ PragTyp_FLAG,
  104220. /* ePragFlag: */ 0,
  104221. /* iArg: */ SQLITE_CkptFullFSync },
  104222. #endif
  104223. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  104224. { /* zName: */ "collation_list",
  104225. /* ePragTyp: */ PragTyp_COLLATION_LIST,
  104226. /* ePragFlag: */ 0,
  104227. /* iArg: */ 0 },
  104228. #endif
  104229. #if !defined(SQLITE_OMIT_COMPILEOPTION_DIAGS)
  104230. { /* zName: */ "compile_options",
  104231. /* ePragTyp: */ PragTyp_COMPILE_OPTIONS,
  104232. /* ePragFlag: */ 0,
  104233. /* iArg: */ 0 },
  104234. #endif
  104235. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104236. { /* zName: */ "count_changes",
  104237. /* ePragTyp: */ PragTyp_FLAG,
  104238. /* ePragFlag: */ 0,
  104239. /* iArg: */ SQLITE_CountRows },
  104240. #endif
  104241. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_OS_WIN
  104242. { /* zName: */ "data_store_directory",
  104243. /* ePragTyp: */ PragTyp_DATA_STORE_DIRECTORY,
  104244. /* ePragFlag: */ 0,
  104245. /* iArg: */ 0 },
  104246. #endif
  104247. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  104248. { /* zName: */ "data_version",
  104249. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  104250. /* ePragFlag: */ PragFlag_ReadOnly,
  104251. /* iArg: */ BTREE_DATA_VERSION },
  104252. #endif
  104253. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  104254. { /* zName: */ "database_list",
  104255. /* ePragTyp: */ PragTyp_DATABASE_LIST,
  104256. /* ePragFlag: */ PragFlag_NeedSchema,
  104257. /* iArg: */ 0 },
  104258. #endif
  104259. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
  104260. { /* zName: */ "default_cache_size",
  104261. /* ePragTyp: */ PragTyp_DEFAULT_CACHE_SIZE,
  104262. /* ePragFlag: */ PragFlag_NeedSchema,
  104263. /* iArg: */ 0 },
  104264. #endif
  104265. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104266. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  104267. { /* zName: */ "defer_foreign_keys",
  104268. /* ePragTyp: */ PragTyp_FLAG,
  104269. /* ePragFlag: */ 0,
  104270. /* iArg: */ SQLITE_DeferFKs },
  104271. #endif
  104272. #endif
  104273. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104274. { /* zName: */ "empty_result_callbacks",
  104275. /* ePragTyp: */ PragTyp_FLAG,
  104276. /* ePragFlag: */ 0,
  104277. /* iArg: */ SQLITE_NullCallback },
  104278. #endif
  104279. #if !defined(SQLITE_OMIT_UTF16)
  104280. { /* zName: */ "encoding",
  104281. /* ePragTyp: */ PragTyp_ENCODING,
  104282. /* ePragFlag: */ 0,
  104283. /* iArg: */ 0 },
  104284. #endif
  104285. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  104286. { /* zName: */ "foreign_key_check",
  104287. /* ePragTyp: */ PragTyp_FOREIGN_KEY_CHECK,
  104288. /* ePragFlag: */ PragFlag_NeedSchema,
  104289. /* iArg: */ 0 },
  104290. #endif
  104291. #if !defined(SQLITE_OMIT_FOREIGN_KEY)
  104292. { /* zName: */ "foreign_key_list",
  104293. /* ePragTyp: */ PragTyp_FOREIGN_KEY_LIST,
  104294. /* ePragFlag: */ PragFlag_NeedSchema,
  104295. /* iArg: */ 0 },
  104296. #endif
  104297. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104298. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  104299. { /* zName: */ "foreign_keys",
  104300. /* ePragTyp: */ PragTyp_FLAG,
  104301. /* ePragFlag: */ 0,
  104302. /* iArg: */ SQLITE_ForeignKeys },
  104303. #endif
  104304. #endif
  104305. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  104306. { /* zName: */ "freelist_count",
  104307. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  104308. /* ePragFlag: */ PragFlag_ReadOnly,
  104309. /* iArg: */ BTREE_FREE_PAGE_COUNT },
  104310. #endif
  104311. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104312. { /* zName: */ "full_column_names",
  104313. /* ePragTyp: */ PragTyp_FLAG,
  104314. /* ePragFlag: */ 0,
  104315. /* iArg: */ SQLITE_FullColNames },
  104316. { /* zName: */ "fullfsync",
  104317. /* ePragTyp: */ PragTyp_FLAG,
  104318. /* ePragFlag: */ 0,
  104319. /* iArg: */ SQLITE_FullFSync },
  104320. #endif
  104321. #if defined(SQLITE_HAS_CODEC)
  104322. { /* zName: */ "hexkey",
  104323. /* ePragTyp: */ PragTyp_HEXKEY,
  104324. /* ePragFlag: */ 0,
  104325. /* iArg: */ 0 },
  104326. { /* zName: */ "hexrekey",
  104327. /* ePragTyp: */ PragTyp_HEXKEY,
  104328. /* ePragFlag: */ 0,
  104329. /* iArg: */ 0 },
  104330. #endif
  104331. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104332. #if !defined(SQLITE_OMIT_CHECK)
  104333. { /* zName: */ "ignore_check_constraints",
  104334. /* ePragTyp: */ PragTyp_FLAG,
  104335. /* ePragFlag: */ 0,
  104336. /* iArg: */ SQLITE_IgnoreChecks },
  104337. #endif
  104338. #endif
  104339. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  104340. { /* zName: */ "incremental_vacuum",
  104341. /* ePragTyp: */ PragTyp_INCREMENTAL_VACUUM,
  104342. /* ePragFlag: */ PragFlag_NeedSchema,
  104343. /* iArg: */ 0 },
  104344. #endif
  104345. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  104346. { /* zName: */ "index_info",
  104347. /* ePragTyp: */ PragTyp_INDEX_INFO,
  104348. /* ePragFlag: */ PragFlag_NeedSchema,
  104349. /* iArg: */ 0 },
  104350. { /* zName: */ "index_list",
  104351. /* ePragTyp: */ PragTyp_INDEX_LIST,
  104352. /* ePragFlag: */ PragFlag_NeedSchema,
  104353. /* iArg: */ 0 },
  104354. { /* zName: */ "index_xinfo",
  104355. /* ePragTyp: */ PragTyp_INDEX_INFO,
  104356. /* ePragFlag: */ PragFlag_NeedSchema,
  104357. /* iArg: */ 1 },
  104358. #endif
  104359. #if !defined(SQLITE_OMIT_INTEGRITY_CHECK)
  104360. { /* zName: */ "integrity_check",
  104361. /* ePragTyp: */ PragTyp_INTEGRITY_CHECK,
  104362. /* ePragFlag: */ PragFlag_NeedSchema,
  104363. /* iArg: */ 0 },
  104364. #endif
  104365. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104366. { /* zName: */ "journal_mode",
  104367. /* ePragTyp: */ PragTyp_JOURNAL_MODE,
  104368. /* ePragFlag: */ PragFlag_NeedSchema,
  104369. /* iArg: */ 0 },
  104370. { /* zName: */ "journal_size_limit",
  104371. /* ePragTyp: */ PragTyp_JOURNAL_SIZE_LIMIT,
  104372. /* ePragFlag: */ 0,
  104373. /* iArg: */ 0 },
  104374. #endif
  104375. #if defined(SQLITE_HAS_CODEC)
  104376. { /* zName: */ "key",
  104377. /* ePragTyp: */ PragTyp_KEY,
  104378. /* ePragFlag: */ 0,
  104379. /* iArg: */ 0 },
  104380. #endif
  104381. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104382. { /* zName: */ "legacy_file_format",
  104383. /* ePragTyp: */ PragTyp_FLAG,
  104384. /* ePragFlag: */ 0,
  104385. /* iArg: */ SQLITE_LegacyFileFmt },
  104386. #endif
  104387. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_ENABLE_LOCKING_STYLE
  104388. { /* zName: */ "lock_proxy_file",
  104389. /* ePragTyp: */ PragTyp_LOCK_PROXY_FILE,
  104390. /* ePragFlag: */ 0,
  104391. /* iArg: */ 0 },
  104392. #endif
  104393. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  104394. { /* zName: */ "lock_status",
  104395. /* ePragTyp: */ PragTyp_LOCK_STATUS,
  104396. /* ePragFlag: */ 0,
  104397. /* iArg: */ 0 },
  104398. #endif
  104399. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104400. { /* zName: */ "locking_mode",
  104401. /* ePragTyp: */ PragTyp_LOCKING_MODE,
  104402. /* ePragFlag: */ 0,
  104403. /* iArg: */ 0 },
  104404. { /* zName: */ "max_page_count",
  104405. /* ePragTyp: */ PragTyp_PAGE_COUNT,
  104406. /* ePragFlag: */ PragFlag_NeedSchema,
  104407. /* iArg: */ 0 },
  104408. { /* zName: */ "mmap_size",
  104409. /* ePragTyp: */ PragTyp_MMAP_SIZE,
  104410. /* ePragFlag: */ 0,
  104411. /* iArg: */ 0 },
  104412. { /* zName: */ "page_count",
  104413. /* ePragTyp: */ PragTyp_PAGE_COUNT,
  104414. /* ePragFlag: */ PragFlag_NeedSchema,
  104415. /* iArg: */ 0 },
  104416. { /* zName: */ "page_size",
  104417. /* ePragTyp: */ PragTyp_PAGE_SIZE,
  104418. /* ePragFlag: */ 0,
  104419. /* iArg: */ 0 },
  104420. #endif
  104421. #if defined(SQLITE_DEBUG) && !defined(SQLITE_OMIT_PARSER_TRACE)
  104422. { /* zName: */ "parser_trace",
  104423. /* ePragTyp: */ PragTyp_PARSER_TRACE,
  104424. /* ePragFlag: */ 0,
  104425. /* iArg: */ 0 },
  104426. #endif
  104427. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104428. { /* zName: */ "query_only",
  104429. /* ePragTyp: */ PragTyp_FLAG,
  104430. /* ePragFlag: */ 0,
  104431. /* iArg: */ SQLITE_QueryOnly },
  104432. #endif
  104433. #if !defined(SQLITE_OMIT_INTEGRITY_CHECK)
  104434. { /* zName: */ "quick_check",
  104435. /* ePragTyp: */ PragTyp_INTEGRITY_CHECK,
  104436. /* ePragFlag: */ PragFlag_NeedSchema,
  104437. /* iArg: */ 0 },
  104438. #endif
  104439. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104440. { /* zName: */ "read_uncommitted",
  104441. /* ePragTyp: */ PragTyp_FLAG,
  104442. /* ePragFlag: */ 0,
  104443. /* iArg: */ SQLITE_ReadUncommitted },
  104444. { /* zName: */ "recursive_triggers",
  104445. /* ePragTyp: */ PragTyp_FLAG,
  104446. /* ePragFlag: */ 0,
  104447. /* iArg: */ SQLITE_RecTriggers },
  104448. #endif
  104449. #if defined(SQLITE_HAS_CODEC)
  104450. { /* zName: */ "rekey",
  104451. /* ePragTyp: */ PragTyp_REKEY,
  104452. /* ePragFlag: */ 0,
  104453. /* iArg: */ 0 },
  104454. #endif
  104455. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104456. { /* zName: */ "reverse_unordered_selects",
  104457. /* ePragTyp: */ PragTyp_FLAG,
  104458. /* ePragFlag: */ 0,
  104459. /* iArg: */ SQLITE_ReverseOrder },
  104460. #endif
  104461. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  104462. { /* zName: */ "schema_version",
  104463. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  104464. /* ePragFlag: */ 0,
  104465. /* iArg: */ BTREE_SCHEMA_VERSION },
  104466. #endif
  104467. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104468. { /* zName: */ "secure_delete",
  104469. /* ePragTyp: */ PragTyp_SECURE_DELETE,
  104470. /* ePragFlag: */ 0,
  104471. /* iArg: */ 0 },
  104472. #endif
  104473. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104474. { /* zName: */ "short_column_names",
  104475. /* ePragTyp: */ PragTyp_FLAG,
  104476. /* ePragFlag: */ 0,
  104477. /* iArg: */ SQLITE_ShortColNames },
  104478. #endif
  104479. { /* zName: */ "shrink_memory",
  104480. /* ePragTyp: */ PragTyp_SHRINK_MEMORY,
  104481. /* ePragFlag: */ 0,
  104482. /* iArg: */ 0 },
  104483. { /* zName: */ "soft_heap_limit",
  104484. /* ePragTyp: */ PragTyp_SOFT_HEAP_LIMIT,
  104485. /* ePragFlag: */ 0,
  104486. /* iArg: */ 0 },
  104487. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104488. #if defined(SQLITE_DEBUG)
  104489. { /* zName: */ "sql_trace",
  104490. /* ePragTyp: */ PragTyp_FLAG,
  104491. /* ePragFlag: */ 0,
  104492. /* iArg: */ SQLITE_SqlTrace },
  104493. #endif
  104494. #endif
  104495. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  104496. { /* zName: */ "stats",
  104497. /* ePragTyp: */ PragTyp_STATS,
  104498. /* ePragFlag: */ PragFlag_NeedSchema,
  104499. /* iArg: */ 0 },
  104500. #endif
  104501. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104502. { /* zName: */ "synchronous",
  104503. /* ePragTyp: */ PragTyp_SYNCHRONOUS,
  104504. /* ePragFlag: */ PragFlag_NeedSchema,
  104505. /* iArg: */ 0 },
  104506. #endif
  104507. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  104508. { /* zName: */ "table_info",
  104509. /* ePragTyp: */ PragTyp_TABLE_INFO,
  104510. /* ePragFlag: */ PragFlag_NeedSchema,
  104511. /* iArg: */ 0 },
  104512. #endif
  104513. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104514. { /* zName: */ "temp_store",
  104515. /* ePragTyp: */ PragTyp_TEMP_STORE,
  104516. /* ePragFlag: */ 0,
  104517. /* iArg: */ 0 },
  104518. { /* zName: */ "temp_store_directory",
  104519. /* ePragTyp: */ PragTyp_TEMP_STORE_DIRECTORY,
  104520. /* ePragFlag: */ 0,
  104521. /* iArg: */ 0 },
  104522. #endif
  104523. { /* zName: */ "threads",
  104524. /* ePragTyp: */ PragTyp_THREADS,
  104525. /* ePragFlag: */ 0,
  104526. /* iArg: */ 0 },
  104527. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  104528. { /* zName: */ "user_version",
  104529. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  104530. /* ePragFlag: */ 0,
  104531. /* iArg: */ BTREE_USER_VERSION },
  104532. #endif
  104533. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104534. #if defined(SQLITE_DEBUG)
  104535. { /* zName: */ "vdbe_addoptrace",
  104536. /* ePragTyp: */ PragTyp_FLAG,
  104537. /* ePragFlag: */ 0,
  104538. /* iArg: */ SQLITE_VdbeAddopTrace },
  104539. { /* zName: */ "vdbe_debug",
  104540. /* ePragTyp: */ PragTyp_FLAG,
  104541. /* ePragFlag: */ 0,
  104542. /* iArg: */ SQLITE_SqlTrace|SQLITE_VdbeListing|SQLITE_VdbeTrace },
  104543. { /* zName: */ "vdbe_eqp",
  104544. /* ePragTyp: */ PragTyp_FLAG,
  104545. /* ePragFlag: */ 0,
  104546. /* iArg: */ SQLITE_VdbeEQP },
  104547. { /* zName: */ "vdbe_listing",
  104548. /* ePragTyp: */ PragTyp_FLAG,
  104549. /* ePragFlag: */ 0,
  104550. /* iArg: */ SQLITE_VdbeListing },
  104551. { /* zName: */ "vdbe_trace",
  104552. /* ePragTyp: */ PragTyp_FLAG,
  104553. /* ePragFlag: */ 0,
  104554. /* iArg: */ SQLITE_VdbeTrace },
  104555. #endif
  104556. #endif
  104557. #if !defined(SQLITE_OMIT_WAL)
  104558. { /* zName: */ "wal_autocheckpoint",
  104559. /* ePragTyp: */ PragTyp_WAL_AUTOCHECKPOINT,
  104560. /* ePragFlag: */ 0,
  104561. /* iArg: */ 0 },
  104562. { /* zName: */ "wal_checkpoint",
  104563. /* ePragTyp: */ PragTyp_WAL_CHECKPOINT,
  104564. /* ePragFlag: */ PragFlag_NeedSchema,
  104565. /* iArg: */ 0 },
  104566. #endif
  104567. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  104568. { /* zName: */ "writable_schema",
  104569. /* ePragTyp: */ PragTyp_FLAG,
  104570. /* ePragFlag: */ 0,
  104571. /* iArg: */ SQLITE_WriteSchema|SQLITE_RecoveryMode },
  104572. #endif
  104573. };
  104574. /* Number of pragmas: 60 on by default, 73 total. */
  104575. /************** End of pragma.h **********************************************/
  104576. /************** Continuing where we left off in pragma.c *********************/
  104577. /*
  104578. ** Interpret the given string as a safety level. Return 0 for OFF,
  104579. ** 1 for ON or NORMAL, 2 for FULL, and 3 for EXTRA. Return 1 for an empty or
  104580. ** unrecognized string argument. The FULL and EXTRA option is disallowed
  104581. ** if the omitFull parameter it 1.
  104582. **
  104583. ** Note that the values returned are one less that the values that
  104584. ** should be passed into sqlite3BtreeSetSafetyLevel(). The is done
  104585. ** to support legacy SQL code. The safety level used to be boolean
  104586. ** and older scripts may have used numbers 0 for OFF and 1 for ON.
  104587. */
  104588. static u8 getSafetyLevel(const char *z, int omitFull, u8 dflt){
  104589. /* 123456789 123456789 123 */
  104590. static const char zText[] = "onoffalseyestruextrafull";
  104591. static const u8 iOffset[] = {0, 1, 2, 4, 9, 12, 15, 20};
  104592. static const u8 iLength[] = {2, 2, 3, 5, 3, 4, 5, 4};
  104593. static const u8 iValue[] = {1, 0, 0, 0, 1, 1, 3, 2};
  104594. /* on no off false yes true extra full */
  104595. int i, n;
  104596. if( sqlite3Isdigit(*z) ){
  104597. return (u8)sqlite3Atoi(z);
  104598. }
  104599. n = sqlite3Strlen30(z);
  104600. for(i=0; i<ArraySize(iLength); i++){
  104601. if( iLength[i]==n && sqlite3StrNICmp(&zText[iOffset[i]],z,n)==0
  104602. && (!omitFull || iValue[i]<=1)
  104603. ){
  104604. return iValue[i];
  104605. }
  104606. }
  104607. return dflt;
  104608. }
  104609. /*
  104610. ** Interpret the given string as a boolean value.
  104611. */
  104612. SQLITE_PRIVATE u8 sqlite3GetBoolean(const char *z, u8 dflt){
  104613. return getSafetyLevel(z,1,dflt)!=0;
  104614. }
  104615. /* The sqlite3GetBoolean() function is used by other modules but the
  104616. ** remainder of this file is specific to PRAGMA processing. So omit
  104617. ** the rest of the file if PRAGMAs are omitted from the build.
  104618. */
  104619. #if !defined(SQLITE_OMIT_PRAGMA)
  104620. /*
  104621. ** Interpret the given string as a locking mode value.
  104622. */
  104623. static int getLockingMode(const char *z){
  104624. if( z ){
  104625. if( 0==sqlite3StrICmp(z, "exclusive") ) return PAGER_LOCKINGMODE_EXCLUSIVE;
  104626. if( 0==sqlite3StrICmp(z, "normal") ) return PAGER_LOCKINGMODE_NORMAL;
  104627. }
  104628. return PAGER_LOCKINGMODE_QUERY;
  104629. }
  104630. #ifndef SQLITE_OMIT_AUTOVACUUM
  104631. /*
  104632. ** Interpret the given string as an auto-vacuum mode value.
  104633. **
  104634. ** The following strings, "none", "full" and "incremental" are
  104635. ** acceptable, as are their numeric equivalents: 0, 1 and 2 respectively.
  104636. */
  104637. static int getAutoVacuum(const char *z){
  104638. int i;
  104639. if( 0==sqlite3StrICmp(z, "none") ) return BTREE_AUTOVACUUM_NONE;
  104640. if( 0==sqlite3StrICmp(z, "full") ) return BTREE_AUTOVACUUM_FULL;
  104641. if( 0==sqlite3StrICmp(z, "incremental") ) return BTREE_AUTOVACUUM_INCR;
  104642. i = sqlite3Atoi(z);
  104643. return (u8)((i>=0&&i<=2)?i:0);
  104644. }
  104645. #endif /* ifndef SQLITE_OMIT_AUTOVACUUM */
  104646. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  104647. /*
  104648. ** Interpret the given string as a temp db location. Return 1 for file
  104649. ** backed temporary databases, 2 for the Red-Black tree in memory database
  104650. ** and 0 to use the compile-time default.
  104651. */
  104652. static int getTempStore(const char *z){
  104653. if( z[0]>='0' && z[0]<='2' ){
  104654. return z[0] - '0';
  104655. }else if( sqlite3StrICmp(z, "file")==0 ){
  104656. return 1;
  104657. }else if( sqlite3StrICmp(z, "memory")==0 ){
  104658. return 2;
  104659. }else{
  104660. return 0;
  104661. }
  104662. }
  104663. #endif /* SQLITE_PAGER_PRAGMAS */
  104664. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  104665. /*
  104666. ** Invalidate temp storage, either when the temp storage is changed
  104667. ** from default, or when 'file' and the temp_store_directory has changed
  104668. */
  104669. static int invalidateTempStorage(Parse *pParse){
  104670. sqlite3 *db = pParse->db;
  104671. if( db->aDb[1].pBt!=0 ){
  104672. if( !db->autoCommit || sqlite3BtreeIsInReadTrans(db->aDb[1].pBt) ){
  104673. sqlite3ErrorMsg(pParse, "temporary storage cannot be changed "
  104674. "from within a transaction");
  104675. return SQLITE_ERROR;
  104676. }
  104677. sqlite3BtreeClose(db->aDb[1].pBt);
  104678. db->aDb[1].pBt = 0;
  104679. sqlite3ResetAllSchemasOfConnection(db);
  104680. }
  104681. return SQLITE_OK;
  104682. }
  104683. #endif /* SQLITE_PAGER_PRAGMAS */
  104684. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  104685. /*
  104686. ** If the TEMP database is open, close it and mark the database schema
  104687. ** as needing reloading. This must be done when using the SQLITE_TEMP_STORE
  104688. ** or DEFAULT_TEMP_STORE pragmas.
  104689. */
  104690. static int changeTempStorage(Parse *pParse, const char *zStorageType){
  104691. int ts = getTempStore(zStorageType);
  104692. sqlite3 *db = pParse->db;
  104693. if( db->temp_store==ts ) return SQLITE_OK;
  104694. if( invalidateTempStorage( pParse ) != SQLITE_OK ){
  104695. return SQLITE_ERROR;
  104696. }
  104697. db->temp_store = (u8)ts;
  104698. return SQLITE_OK;
  104699. }
  104700. #endif /* SQLITE_PAGER_PRAGMAS */
  104701. /*
  104702. ** Set the names of the first N columns to the values in azCol[]
  104703. */
  104704. static void setAllColumnNames(
  104705. Vdbe *v, /* The query under construction */
  104706. int N, /* Number of columns */
  104707. const char **azCol /* Names of columns */
  104708. ){
  104709. int i;
  104710. sqlite3VdbeSetNumCols(v, N);
  104711. for(i=0; i<N; i++){
  104712. sqlite3VdbeSetColName(v, i, COLNAME_NAME, azCol[i], SQLITE_STATIC);
  104713. }
  104714. }
  104715. static void setOneColumnName(Vdbe *v, const char *z){
  104716. setAllColumnNames(v, 1, &z);
  104717. }
  104718. /*
  104719. ** Generate code to return a single integer value.
  104720. */
  104721. static void returnSingleInt(Vdbe *v, const char *zLabel, i64 value){
  104722. sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, 1, 0, (const u8*)&value, P4_INT64);
  104723. setOneColumnName(v, zLabel);
  104724. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  104725. }
  104726. /*
  104727. ** Generate code to return a single text value.
  104728. */
  104729. static void returnSingleText(
  104730. Vdbe *v, /* Prepared statement under construction */
  104731. const char *zLabel, /* Name of the result column */
  104732. const char *zValue /* Value to be returned */
  104733. ){
  104734. if( zValue ){
  104735. sqlite3VdbeLoadString(v, 1, (const char*)zValue);
  104736. setOneColumnName(v, zLabel);
  104737. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  104738. }
  104739. }
  104740. /*
  104741. ** Set the safety_level and pager flags for pager iDb. Or if iDb<0
  104742. ** set these values for all pagers.
  104743. */
  104744. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  104745. static void setAllPagerFlags(sqlite3 *db){
  104746. if( db->autoCommit ){
  104747. Db *pDb = db->aDb;
  104748. int n = db->nDb;
  104749. assert( SQLITE_FullFSync==PAGER_FULLFSYNC );
  104750. assert( SQLITE_CkptFullFSync==PAGER_CKPT_FULLFSYNC );
  104751. assert( SQLITE_CacheSpill==PAGER_CACHESPILL );
  104752. assert( (PAGER_FULLFSYNC | PAGER_CKPT_FULLFSYNC | PAGER_CACHESPILL)
  104753. == PAGER_FLAGS_MASK );
  104754. assert( (pDb->safety_level & PAGER_SYNCHRONOUS_MASK)==pDb->safety_level );
  104755. while( (n--) > 0 ){
  104756. if( pDb->pBt ){
  104757. sqlite3BtreeSetPagerFlags(pDb->pBt,
  104758. pDb->safety_level | (db->flags & PAGER_FLAGS_MASK) );
  104759. }
  104760. pDb++;
  104761. }
  104762. }
  104763. }
  104764. #else
  104765. # define setAllPagerFlags(X) /* no-op */
  104766. #endif
  104767. /*
  104768. ** Return a human-readable name for a constraint resolution action.
  104769. */
  104770. #ifndef SQLITE_OMIT_FOREIGN_KEY
  104771. static const char *actionName(u8 action){
  104772. const char *zName;
  104773. switch( action ){
  104774. case OE_SetNull: zName = "SET NULL"; break;
  104775. case OE_SetDflt: zName = "SET DEFAULT"; break;
  104776. case OE_Cascade: zName = "CASCADE"; break;
  104777. case OE_Restrict: zName = "RESTRICT"; break;
  104778. default: zName = "NO ACTION";
  104779. assert( action==OE_None ); break;
  104780. }
  104781. return zName;
  104782. }
  104783. #endif
  104784. /*
  104785. ** Parameter eMode must be one of the PAGER_JOURNALMODE_XXX constants
  104786. ** defined in pager.h. This function returns the associated lowercase
  104787. ** journal-mode name.
  104788. */
  104789. SQLITE_PRIVATE const char *sqlite3JournalModename(int eMode){
  104790. static char * const azModeName[] = {
  104791. "delete", "persist", "off", "truncate", "memory"
  104792. #ifndef SQLITE_OMIT_WAL
  104793. , "wal"
  104794. #endif
  104795. };
  104796. assert( PAGER_JOURNALMODE_DELETE==0 );
  104797. assert( PAGER_JOURNALMODE_PERSIST==1 );
  104798. assert( PAGER_JOURNALMODE_OFF==2 );
  104799. assert( PAGER_JOURNALMODE_TRUNCATE==3 );
  104800. assert( PAGER_JOURNALMODE_MEMORY==4 );
  104801. assert( PAGER_JOURNALMODE_WAL==5 );
  104802. assert( eMode>=0 && eMode<=ArraySize(azModeName) );
  104803. if( eMode==ArraySize(azModeName) ) return 0;
  104804. return azModeName[eMode];
  104805. }
  104806. /*
  104807. ** Process a pragma statement.
  104808. **
  104809. ** Pragmas are of this form:
  104810. **
  104811. ** PRAGMA [schema.]id [= value]
  104812. **
  104813. ** The identifier might also be a string. The value is a string, and
  104814. ** identifier, or a number. If minusFlag is true, then the value is
  104815. ** a number that was preceded by a minus sign.
  104816. **
  104817. ** If the left side is "database.id" then pId1 is the database name
  104818. ** and pId2 is the id. If the left side is just "id" then pId1 is the
  104819. ** id and pId2 is any empty string.
  104820. */
  104821. SQLITE_PRIVATE void sqlite3Pragma(
  104822. Parse *pParse,
  104823. Token *pId1, /* First part of [schema.]id field */
  104824. Token *pId2, /* Second part of [schema.]id field, or NULL */
  104825. Token *pValue, /* Token for <value>, or NULL */
  104826. int minusFlag /* True if a '-' sign preceded <value> */
  104827. ){
  104828. char *zLeft = 0; /* Nul-terminated UTF-8 string <id> */
  104829. char *zRight = 0; /* Nul-terminated UTF-8 string <value>, or NULL */
  104830. const char *zDb = 0; /* The database name */
  104831. Token *pId; /* Pointer to <id> token */
  104832. char *aFcntl[4]; /* Argument to SQLITE_FCNTL_PRAGMA */
  104833. int iDb; /* Database index for <database> */
  104834. int lwr, upr, mid = 0; /* Binary search bounds */
  104835. int rc; /* return value form SQLITE_FCNTL_PRAGMA */
  104836. sqlite3 *db = pParse->db; /* The database connection */
  104837. Db *pDb; /* The specific database being pragmaed */
  104838. Vdbe *v = sqlite3GetVdbe(pParse); /* Prepared statement */
  104839. const struct sPragmaNames *pPragma;
  104840. if( v==0 ) return;
  104841. sqlite3VdbeRunOnlyOnce(v);
  104842. pParse->nMem = 2;
  104843. /* Interpret the [schema.] part of the pragma statement. iDb is the
  104844. ** index of the database this pragma is being applied to in db.aDb[]. */
  104845. iDb = sqlite3TwoPartName(pParse, pId1, pId2, &pId);
  104846. if( iDb<0 ) return;
  104847. pDb = &db->aDb[iDb];
  104848. /* If the temp database has been explicitly named as part of the
  104849. ** pragma, make sure it is open.
  104850. */
  104851. if( iDb==1 && sqlite3OpenTempDatabase(pParse) ){
  104852. return;
  104853. }
  104854. zLeft = sqlite3NameFromToken(db, pId);
  104855. if( !zLeft ) return;
  104856. if( minusFlag ){
  104857. zRight = sqlite3MPrintf(db, "-%T", pValue);
  104858. }else{
  104859. zRight = sqlite3NameFromToken(db, pValue);
  104860. }
  104861. assert( pId2 );
  104862. zDb = pId2->n>0 ? pDb->zDbSName : 0;
  104863. if( sqlite3AuthCheck(pParse, SQLITE_PRAGMA, zLeft, zRight, zDb) ){
  104864. goto pragma_out;
  104865. }
  104866. /* Send an SQLITE_FCNTL_PRAGMA file-control to the underlying VFS
  104867. ** connection. If it returns SQLITE_OK, then assume that the VFS
  104868. ** handled the pragma and generate a no-op prepared statement.
  104869. **
  104870. ** IMPLEMENTATION-OF: R-12238-55120 Whenever a PRAGMA statement is parsed,
  104871. ** an SQLITE_FCNTL_PRAGMA file control is sent to the open sqlite3_file
  104872. ** object corresponding to the database file to which the pragma
  104873. ** statement refers.
  104874. **
  104875. ** IMPLEMENTATION-OF: R-29875-31678 The argument to the SQLITE_FCNTL_PRAGMA
  104876. ** file control is an array of pointers to strings (char**) in which the
  104877. ** second element of the array is the name of the pragma and the third
  104878. ** element is the argument to the pragma or NULL if the pragma has no
  104879. ** argument.
  104880. */
  104881. aFcntl[0] = 0;
  104882. aFcntl[1] = zLeft;
  104883. aFcntl[2] = zRight;
  104884. aFcntl[3] = 0;
  104885. db->busyHandler.nBusy = 0;
  104886. rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_PRAGMA, (void*)aFcntl);
  104887. if( rc==SQLITE_OK ){
  104888. returnSingleText(v, "result", aFcntl[0]);
  104889. sqlite3_free(aFcntl[0]);
  104890. goto pragma_out;
  104891. }
  104892. if( rc!=SQLITE_NOTFOUND ){
  104893. if( aFcntl[0] ){
  104894. sqlite3ErrorMsg(pParse, "%s", aFcntl[0]);
  104895. sqlite3_free(aFcntl[0]);
  104896. }
  104897. pParse->nErr++;
  104898. pParse->rc = rc;
  104899. goto pragma_out;
  104900. }
  104901. /* Locate the pragma in the lookup table */
  104902. lwr = 0;
  104903. upr = ArraySize(aPragmaNames)-1;
  104904. while( lwr<=upr ){
  104905. mid = (lwr+upr)/2;
  104906. rc = sqlite3_stricmp(zLeft, aPragmaNames[mid].zName);
  104907. if( rc==0 ) break;
  104908. if( rc<0 ){
  104909. upr = mid - 1;
  104910. }else{
  104911. lwr = mid + 1;
  104912. }
  104913. }
  104914. if( lwr>upr ) goto pragma_out;
  104915. pPragma = &aPragmaNames[mid];
  104916. /* Make sure the database schema is loaded if the pragma requires that */
  104917. if( (pPragma->mPragFlag & PragFlag_NeedSchema)!=0 ){
  104918. if( sqlite3ReadSchema(pParse) ) goto pragma_out;
  104919. }
  104920. /* Jump to the appropriate pragma handler */
  104921. switch( pPragma->ePragTyp ){
  104922. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
  104923. /*
  104924. ** PRAGMA [schema.]default_cache_size
  104925. ** PRAGMA [schema.]default_cache_size=N
  104926. **
  104927. ** The first form reports the current persistent setting for the
  104928. ** page cache size. The value returned is the maximum number of
  104929. ** pages in the page cache. The second form sets both the current
  104930. ** page cache size value and the persistent page cache size value
  104931. ** stored in the database file.
  104932. **
  104933. ** Older versions of SQLite would set the default cache size to a
  104934. ** negative number to indicate synchronous=OFF. These days, synchronous
  104935. ** is always on by default regardless of the sign of the default cache
  104936. ** size. But continue to take the absolute value of the default cache
  104937. ** size of historical compatibility.
  104938. */
  104939. case PragTyp_DEFAULT_CACHE_SIZE: {
  104940. static const int iLn = VDBE_OFFSET_LINENO(2);
  104941. static const VdbeOpList getCacheSize[] = {
  104942. { OP_Transaction, 0, 0, 0}, /* 0 */
  104943. { OP_ReadCookie, 0, 1, BTREE_DEFAULT_CACHE_SIZE}, /* 1 */
  104944. { OP_IfPos, 1, 8, 0},
  104945. { OP_Integer, 0, 2, 0},
  104946. { OP_Subtract, 1, 2, 1},
  104947. { OP_IfPos, 1, 8, 0},
  104948. { OP_Integer, 0, 1, 0}, /* 6 */
  104949. { OP_Noop, 0, 0, 0},
  104950. { OP_ResultRow, 1, 1, 0},
  104951. };
  104952. VdbeOp *aOp;
  104953. sqlite3VdbeUsesBtree(v, iDb);
  104954. if( !zRight ){
  104955. setOneColumnName(v, "cache_size");
  104956. pParse->nMem += 2;
  104957. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(getCacheSize));
  104958. aOp = sqlite3VdbeAddOpList(v, ArraySize(getCacheSize), getCacheSize, iLn);
  104959. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  104960. aOp[0].p1 = iDb;
  104961. aOp[1].p1 = iDb;
  104962. aOp[6].p1 = SQLITE_DEFAULT_CACHE_SIZE;
  104963. }else{
  104964. int size = sqlite3AbsInt32(sqlite3Atoi(zRight));
  104965. sqlite3BeginWriteOperation(pParse, 0, iDb);
  104966. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_DEFAULT_CACHE_SIZE, size);
  104967. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  104968. pDb->pSchema->cache_size = size;
  104969. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  104970. }
  104971. break;
  104972. }
  104973. #endif /* !SQLITE_OMIT_PAGER_PRAGMAS && !SQLITE_OMIT_DEPRECATED */
  104974. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  104975. /*
  104976. ** PRAGMA [schema.]page_size
  104977. ** PRAGMA [schema.]page_size=N
  104978. **
  104979. ** The first form reports the current setting for the
  104980. ** database page size in bytes. The second form sets the
  104981. ** database page size value. The value can only be set if
  104982. ** the database has not yet been created.
  104983. */
  104984. case PragTyp_PAGE_SIZE: {
  104985. Btree *pBt = pDb->pBt;
  104986. assert( pBt!=0 );
  104987. if( !zRight ){
  104988. int size = ALWAYS(pBt) ? sqlite3BtreeGetPageSize(pBt) : 0;
  104989. returnSingleInt(v, "page_size", size);
  104990. }else{
  104991. /* Malloc may fail when setting the page-size, as there is an internal
  104992. ** buffer that the pager module resizes using sqlite3_realloc().
  104993. */
  104994. db->nextPagesize = sqlite3Atoi(zRight);
  104995. if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize,-1,0) ){
  104996. sqlite3OomFault(db);
  104997. }
  104998. }
  104999. break;
  105000. }
  105001. /*
  105002. ** PRAGMA [schema.]secure_delete
  105003. ** PRAGMA [schema.]secure_delete=ON/OFF
  105004. **
  105005. ** The first form reports the current setting for the
  105006. ** secure_delete flag. The second form changes the secure_delete
  105007. ** flag setting and reports thenew value.
  105008. */
  105009. case PragTyp_SECURE_DELETE: {
  105010. Btree *pBt = pDb->pBt;
  105011. int b = -1;
  105012. assert( pBt!=0 );
  105013. if( zRight ){
  105014. b = sqlite3GetBoolean(zRight, 0);
  105015. }
  105016. if( pId2->n==0 && b>=0 ){
  105017. int ii;
  105018. for(ii=0; ii<db->nDb; ii++){
  105019. sqlite3BtreeSecureDelete(db->aDb[ii].pBt, b);
  105020. }
  105021. }
  105022. b = sqlite3BtreeSecureDelete(pBt, b);
  105023. returnSingleInt(v, "secure_delete", b);
  105024. break;
  105025. }
  105026. /*
  105027. ** PRAGMA [schema.]max_page_count
  105028. ** PRAGMA [schema.]max_page_count=N
  105029. **
  105030. ** The first form reports the current setting for the
  105031. ** maximum number of pages in the database file. The
  105032. ** second form attempts to change this setting. Both
  105033. ** forms return the current setting.
  105034. **
  105035. ** The absolute value of N is used. This is undocumented and might
  105036. ** change. The only purpose is to provide an easy way to test
  105037. ** the sqlite3AbsInt32() function.
  105038. **
  105039. ** PRAGMA [schema.]page_count
  105040. **
  105041. ** Return the number of pages in the specified database.
  105042. */
  105043. case PragTyp_PAGE_COUNT: {
  105044. int iReg;
  105045. sqlite3CodeVerifySchema(pParse, iDb);
  105046. iReg = ++pParse->nMem;
  105047. if( sqlite3Tolower(zLeft[0])=='p' ){
  105048. sqlite3VdbeAddOp2(v, OP_Pagecount, iDb, iReg);
  105049. }else{
  105050. sqlite3VdbeAddOp3(v, OP_MaxPgcnt, iDb, iReg,
  105051. sqlite3AbsInt32(sqlite3Atoi(zRight)));
  105052. }
  105053. sqlite3VdbeAddOp2(v, OP_ResultRow, iReg, 1);
  105054. sqlite3VdbeSetNumCols(v, 1);
  105055. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, zLeft, SQLITE_TRANSIENT);
  105056. break;
  105057. }
  105058. /*
  105059. ** PRAGMA [schema.]locking_mode
  105060. ** PRAGMA [schema.]locking_mode = (normal|exclusive)
  105061. */
  105062. case PragTyp_LOCKING_MODE: {
  105063. const char *zRet = "normal";
  105064. int eMode = getLockingMode(zRight);
  105065. if( pId2->n==0 && eMode==PAGER_LOCKINGMODE_QUERY ){
  105066. /* Simple "PRAGMA locking_mode;" statement. This is a query for
  105067. ** the current default locking mode (which may be different to
  105068. ** the locking-mode of the main database).
  105069. */
  105070. eMode = db->dfltLockMode;
  105071. }else{
  105072. Pager *pPager;
  105073. if( pId2->n==0 ){
  105074. /* This indicates that no database name was specified as part
  105075. ** of the PRAGMA command. In this case the locking-mode must be
  105076. ** set on all attached databases, as well as the main db file.
  105077. **
  105078. ** Also, the sqlite3.dfltLockMode variable is set so that
  105079. ** any subsequently attached databases also use the specified
  105080. ** locking mode.
  105081. */
  105082. int ii;
  105083. assert(pDb==&db->aDb[0]);
  105084. for(ii=2; ii<db->nDb; ii++){
  105085. pPager = sqlite3BtreePager(db->aDb[ii].pBt);
  105086. sqlite3PagerLockingMode(pPager, eMode);
  105087. }
  105088. db->dfltLockMode = (u8)eMode;
  105089. }
  105090. pPager = sqlite3BtreePager(pDb->pBt);
  105091. eMode = sqlite3PagerLockingMode(pPager, eMode);
  105092. }
  105093. assert( eMode==PAGER_LOCKINGMODE_NORMAL
  105094. || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
  105095. if( eMode==PAGER_LOCKINGMODE_EXCLUSIVE ){
  105096. zRet = "exclusive";
  105097. }
  105098. returnSingleText(v, "locking_mode", zRet);
  105099. break;
  105100. }
  105101. /*
  105102. ** PRAGMA [schema.]journal_mode
  105103. ** PRAGMA [schema.]journal_mode =
  105104. ** (delete|persist|off|truncate|memory|wal|off)
  105105. */
  105106. case PragTyp_JOURNAL_MODE: {
  105107. int eMode; /* One of the PAGER_JOURNALMODE_XXX symbols */
  105108. int ii; /* Loop counter */
  105109. setOneColumnName(v, "journal_mode");
  105110. if( zRight==0 ){
  105111. /* If there is no "=MODE" part of the pragma, do a query for the
  105112. ** current mode */
  105113. eMode = PAGER_JOURNALMODE_QUERY;
  105114. }else{
  105115. const char *zMode;
  105116. int n = sqlite3Strlen30(zRight);
  105117. for(eMode=0; (zMode = sqlite3JournalModename(eMode))!=0; eMode++){
  105118. if( sqlite3StrNICmp(zRight, zMode, n)==0 ) break;
  105119. }
  105120. if( !zMode ){
  105121. /* If the "=MODE" part does not match any known journal mode,
  105122. ** then do a query */
  105123. eMode = PAGER_JOURNALMODE_QUERY;
  105124. }
  105125. }
  105126. if( eMode==PAGER_JOURNALMODE_QUERY && pId2->n==0 ){
  105127. /* Convert "PRAGMA journal_mode" into "PRAGMA main.journal_mode" */
  105128. iDb = 0;
  105129. pId2->n = 1;
  105130. }
  105131. for(ii=db->nDb-1; ii>=0; ii--){
  105132. if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
  105133. sqlite3VdbeUsesBtree(v, ii);
  105134. sqlite3VdbeAddOp3(v, OP_JournalMode, ii, 1, eMode);
  105135. }
  105136. }
  105137. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  105138. break;
  105139. }
  105140. /*
  105141. ** PRAGMA [schema.]journal_size_limit
  105142. ** PRAGMA [schema.]journal_size_limit=N
  105143. **
  105144. ** Get or set the size limit on rollback journal files.
  105145. */
  105146. case PragTyp_JOURNAL_SIZE_LIMIT: {
  105147. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  105148. i64 iLimit = -2;
  105149. if( zRight ){
  105150. sqlite3DecOrHexToI64(zRight, &iLimit);
  105151. if( iLimit<-1 ) iLimit = -1;
  105152. }
  105153. iLimit = sqlite3PagerJournalSizeLimit(pPager, iLimit);
  105154. returnSingleInt(v, "journal_size_limit", iLimit);
  105155. break;
  105156. }
  105157. #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
  105158. /*
  105159. ** PRAGMA [schema.]auto_vacuum
  105160. ** PRAGMA [schema.]auto_vacuum=N
  105161. **
  105162. ** Get or set the value of the database 'auto-vacuum' parameter.
  105163. ** The value is one of: 0 NONE 1 FULL 2 INCREMENTAL
  105164. */
  105165. #ifndef SQLITE_OMIT_AUTOVACUUM
  105166. case PragTyp_AUTO_VACUUM: {
  105167. Btree *pBt = pDb->pBt;
  105168. assert( pBt!=0 );
  105169. if( !zRight ){
  105170. returnSingleInt(v, "auto_vacuum", sqlite3BtreeGetAutoVacuum(pBt));
  105171. }else{
  105172. int eAuto = getAutoVacuum(zRight);
  105173. assert( eAuto>=0 && eAuto<=2 );
  105174. db->nextAutovac = (u8)eAuto;
  105175. /* Call SetAutoVacuum() to set initialize the internal auto and
  105176. ** incr-vacuum flags. This is required in case this connection
  105177. ** creates the database file. It is important that it is created
  105178. ** as an auto-vacuum capable db.
  105179. */
  105180. rc = sqlite3BtreeSetAutoVacuum(pBt, eAuto);
  105181. if( rc==SQLITE_OK && (eAuto==1 || eAuto==2) ){
  105182. /* When setting the auto_vacuum mode to either "full" or
  105183. ** "incremental", write the value of meta[6] in the database
  105184. ** file. Before writing to meta[6], check that meta[3] indicates
  105185. ** that this really is an auto-vacuum capable database.
  105186. */
  105187. static const int iLn = VDBE_OFFSET_LINENO(2);
  105188. static const VdbeOpList setMeta6[] = {
  105189. { OP_Transaction, 0, 1, 0}, /* 0 */
  105190. { OP_ReadCookie, 0, 1, BTREE_LARGEST_ROOT_PAGE},
  105191. { OP_If, 1, 0, 0}, /* 2 */
  105192. { OP_Halt, SQLITE_OK, OE_Abort, 0}, /* 3 */
  105193. { OP_SetCookie, 0, BTREE_INCR_VACUUM, 0}, /* 4 */
  105194. };
  105195. VdbeOp *aOp;
  105196. int iAddr = sqlite3VdbeCurrentAddr(v);
  105197. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setMeta6));
  105198. aOp = sqlite3VdbeAddOpList(v, ArraySize(setMeta6), setMeta6, iLn);
  105199. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  105200. aOp[0].p1 = iDb;
  105201. aOp[1].p1 = iDb;
  105202. aOp[2].p2 = iAddr+4;
  105203. aOp[4].p1 = iDb;
  105204. aOp[4].p3 = eAuto - 1;
  105205. sqlite3VdbeUsesBtree(v, iDb);
  105206. }
  105207. }
  105208. break;
  105209. }
  105210. #endif
  105211. /*
  105212. ** PRAGMA [schema.]incremental_vacuum(N)
  105213. **
  105214. ** Do N steps of incremental vacuuming on a database.
  105215. */
  105216. #ifndef SQLITE_OMIT_AUTOVACUUM
  105217. case PragTyp_INCREMENTAL_VACUUM: {
  105218. int iLimit, addr;
  105219. if( zRight==0 || !sqlite3GetInt32(zRight, &iLimit) || iLimit<=0 ){
  105220. iLimit = 0x7fffffff;
  105221. }
  105222. sqlite3BeginWriteOperation(pParse, 0, iDb);
  105223. sqlite3VdbeAddOp2(v, OP_Integer, iLimit, 1);
  105224. addr = sqlite3VdbeAddOp1(v, OP_IncrVacuum, iDb); VdbeCoverage(v);
  105225. sqlite3VdbeAddOp1(v, OP_ResultRow, 1);
  105226. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1);
  105227. sqlite3VdbeAddOp2(v, OP_IfPos, 1, addr); VdbeCoverage(v);
  105228. sqlite3VdbeJumpHere(v, addr);
  105229. break;
  105230. }
  105231. #endif
  105232. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  105233. /*
  105234. ** PRAGMA [schema.]cache_size
  105235. ** PRAGMA [schema.]cache_size=N
  105236. **
  105237. ** The first form reports the current local setting for the
  105238. ** page cache size. The second form sets the local
  105239. ** page cache size value. If N is positive then that is the
  105240. ** number of pages in the cache. If N is negative, then the
  105241. ** number of pages is adjusted so that the cache uses -N kibibytes
  105242. ** of memory.
  105243. */
  105244. case PragTyp_CACHE_SIZE: {
  105245. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  105246. if( !zRight ){
  105247. returnSingleInt(v, "cache_size", pDb->pSchema->cache_size);
  105248. }else{
  105249. int size = sqlite3Atoi(zRight);
  105250. pDb->pSchema->cache_size = size;
  105251. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  105252. }
  105253. break;
  105254. }
  105255. /*
  105256. ** PRAGMA [schema.]cache_spill
  105257. ** PRAGMA cache_spill=BOOLEAN
  105258. ** PRAGMA [schema.]cache_spill=N
  105259. **
  105260. ** The first form reports the current local setting for the
  105261. ** page cache spill size. The second form turns cache spill on
  105262. ** or off. When turnning cache spill on, the size is set to the
  105263. ** current cache_size. The third form sets a spill size that
  105264. ** may be different form the cache size.
  105265. ** If N is positive then that is the
  105266. ** number of pages in the cache. If N is negative, then the
  105267. ** number of pages is adjusted so that the cache uses -N kibibytes
  105268. ** of memory.
  105269. **
  105270. ** If the number of cache_spill pages is less then the number of
  105271. ** cache_size pages, no spilling occurs until the page count exceeds
  105272. ** the number of cache_size pages.
  105273. **
  105274. ** The cache_spill=BOOLEAN setting applies to all attached schemas,
  105275. ** not just the schema specified.
  105276. */
  105277. case PragTyp_CACHE_SPILL: {
  105278. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  105279. if( !zRight ){
  105280. returnSingleInt(v, "cache_spill",
  105281. (db->flags & SQLITE_CacheSpill)==0 ? 0 :
  105282. sqlite3BtreeSetSpillSize(pDb->pBt,0));
  105283. }else{
  105284. int size = 1;
  105285. if( sqlite3GetInt32(zRight, &size) ){
  105286. sqlite3BtreeSetSpillSize(pDb->pBt, size);
  105287. }
  105288. if( sqlite3GetBoolean(zRight, size!=0) ){
  105289. db->flags |= SQLITE_CacheSpill;
  105290. }else{
  105291. db->flags &= ~SQLITE_CacheSpill;
  105292. }
  105293. setAllPagerFlags(db);
  105294. }
  105295. break;
  105296. }
  105297. /*
  105298. ** PRAGMA [schema.]mmap_size(N)
  105299. **
  105300. ** Used to set mapping size limit. The mapping size limit is
  105301. ** used to limit the aggregate size of all memory mapped regions of the
  105302. ** database file. If this parameter is set to zero, then memory mapping
  105303. ** is not used at all. If N is negative, then the default memory map
  105304. ** limit determined by sqlite3_config(SQLITE_CONFIG_MMAP_SIZE) is set.
  105305. ** The parameter N is measured in bytes.
  105306. **
  105307. ** This value is advisory. The underlying VFS is free to memory map
  105308. ** as little or as much as it wants. Except, if N is set to 0 then the
  105309. ** upper layers will never invoke the xFetch interfaces to the VFS.
  105310. */
  105311. case PragTyp_MMAP_SIZE: {
  105312. sqlite3_int64 sz;
  105313. #if SQLITE_MAX_MMAP_SIZE>0
  105314. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  105315. if( zRight ){
  105316. int ii;
  105317. sqlite3DecOrHexToI64(zRight, &sz);
  105318. if( sz<0 ) sz = sqlite3GlobalConfig.szMmap;
  105319. if( pId2->n==0 ) db->szMmap = sz;
  105320. for(ii=db->nDb-1; ii>=0; ii--){
  105321. if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
  105322. sqlite3BtreeSetMmapLimit(db->aDb[ii].pBt, sz);
  105323. }
  105324. }
  105325. }
  105326. sz = -1;
  105327. rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_MMAP_SIZE, &sz);
  105328. #else
  105329. sz = 0;
  105330. rc = SQLITE_OK;
  105331. #endif
  105332. if( rc==SQLITE_OK ){
  105333. returnSingleInt(v, "mmap_size", sz);
  105334. }else if( rc!=SQLITE_NOTFOUND ){
  105335. pParse->nErr++;
  105336. pParse->rc = rc;
  105337. }
  105338. break;
  105339. }
  105340. /*
  105341. ** PRAGMA temp_store
  105342. ** PRAGMA temp_store = "default"|"memory"|"file"
  105343. **
  105344. ** Return or set the local value of the temp_store flag. Changing
  105345. ** the local value does not make changes to the disk file and the default
  105346. ** value will be restored the next time the database is opened.
  105347. **
  105348. ** Note that it is possible for the library compile-time options to
  105349. ** override this setting
  105350. */
  105351. case PragTyp_TEMP_STORE: {
  105352. if( !zRight ){
  105353. returnSingleInt(v, "temp_store", db->temp_store);
  105354. }else{
  105355. changeTempStorage(pParse, zRight);
  105356. }
  105357. break;
  105358. }
  105359. /*
  105360. ** PRAGMA temp_store_directory
  105361. ** PRAGMA temp_store_directory = ""|"directory_name"
  105362. **
  105363. ** Return or set the local value of the temp_store_directory flag. Changing
  105364. ** the value sets a specific directory to be used for temporary files.
  105365. ** Setting to a null string reverts to the default temporary directory search.
  105366. ** If temporary directory is changed, then invalidateTempStorage.
  105367. **
  105368. */
  105369. case PragTyp_TEMP_STORE_DIRECTORY: {
  105370. if( !zRight ){
  105371. returnSingleText(v, "temp_store_directory", sqlite3_temp_directory);
  105372. }else{
  105373. #ifndef SQLITE_OMIT_WSD
  105374. if( zRight[0] ){
  105375. int res;
  105376. rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
  105377. if( rc!=SQLITE_OK || res==0 ){
  105378. sqlite3ErrorMsg(pParse, "not a writable directory");
  105379. goto pragma_out;
  105380. }
  105381. }
  105382. if( SQLITE_TEMP_STORE==0
  105383. || (SQLITE_TEMP_STORE==1 && db->temp_store<=1)
  105384. || (SQLITE_TEMP_STORE==2 && db->temp_store==1)
  105385. ){
  105386. invalidateTempStorage(pParse);
  105387. }
  105388. sqlite3_free(sqlite3_temp_directory);
  105389. if( zRight[0] ){
  105390. sqlite3_temp_directory = sqlite3_mprintf("%s", zRight);
  105391. }else{
  105392. sqlite3_temp_directory = 0;
  105393. }
  105394. #endif /* SQLITE_OMIT_WSD */
  105395. }
  105396. break;
  105397. }
  105398. #if SQLITE_OS_WIN
  105399. /*
  105400. ** PRAGMA data_store_directory
  105401. ** PRAGMA data_store_directory = ""|"directory_name"
  105402. **
  105403. ** Return or set the local value of the data_store_directory flag. Changing
  105404. ** the value sets a specific directory to be used for database files that
  105405. ** were specified with a relative pathname. Setting to a null string reverts
  105406. ** to the default database directory, which for database files specified with
  105407. ** a relative path will probably be based on the current directory for the
  105408. ** process. Database file specified with an absolute path are not impacted
  105409. ** by this setting, regardless of its value.
  105410. **
  105411. */
  105412. case PragTyp_DATA_STORE_DIRECTORY: {
  105413. if( !zRight ){
  105414. returnSingleText(v, "data_store_directory", sqlite3_data_directory);
  105415. }else{
  105416. #ifndef SQLITE_OMIT_WSD
  105417. if( zRight[0] ){
  105418. int res;
  105419. rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
  105420. if( rc!=SQLITE_OK || res==0 ){
  105421. sqlite3ErrorMsg(pParse, "not a writable directory");
  105422. goto pragma_out;
  105423. }
  105424. }
  105425. sqlite3_free(sqlite3_data_directory);
  105426. if( zRight[0] ){
  105427. sqlite3_data_directory = sqlite3_mprintf("%s", zRight);
  105428. }else{
  105429. sqlite3_data_directory = 0;
  105430. }
  105431. #endif /* SQLITE_OMIT_WSD */
  105432. }
  105433. break;
  105434. }
  105435. #endif
  105436. #if SQLITE_ENABLE_LOCKING_STYLE
  105437. /*
  105438. ** PRAGMA [schema.]lock_proxy_file
  105439. ** PRAGMA [schema.]lock_proxy_file = ":auto:"|"lock_file_path"
  105440. **
  105441. ** Return or set the value of the lock_proxy_file flag. Changing
  105442. ** the value sets a specific file to be used for database access locks.
  105443. **
  105444. */
  105445. case PragTyp_LOCK_PROXY_FILE: {
  105446. if( !zRight ){
  105447. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  105448. char *proxy_file_path = NULL;
  105449. sqlite3_file *pFile = sqlite3PagerFile(pPager);
  105450. sqlite3OsFileControlHint(pFile, SQLITE_GET_LOCKPROXYFILE,
  105451. &proxy_file_path);
  105452. returnSingleText(v, "lock_proxy_file", proxy_file_path);
  105453. }else{
  105454. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  105455. sqlite3_file *pFile = sqlite3PagerFile(pPager);
  105456. int res;
  105457. if( zRight[0] ){
  105458. res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
  105459. zRight);
  105460. } else {
  105461. res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
  105462. NULL);
  105463. }
  105464. if( res!=SQLITE_OK ){
  105465. sqlite3ErrorMsg(pParse, "failed to set lock proxy file");
  105466. goto pragma_out;
  105467. }
  105468. }
  105469. break;
  105470. }
  105471. #endif /* SQLITE_ENABLE_LOCKING_STYLE */
  105472. /*
  105473. ** PRAGMA [schema.]synchronous
  105474. ** PRAGMA [schema.]synchronous=OFF|ON|NORMAL|FULL|EXTRA
  105475. **
  105476. ** Return or set the local value of the synchronous flag. Changing
  105477. ** the local value does not make changes to the disk file and the
  105478. ** default value will be restored the next time the database is
  105479. ** opened.
  105480. */
  105481. case PragTyp_SYNCHRONOUS: {
  105482. if( !zRight ){
  105483. returnSingleInt(v, "synchronous", pDb->safety_level-1);
  105484. }else{
  105485. if( !db->autoCommit ){
  105486. sqlite3ErrorMsg(pParse,
  105487. "Safety level may not be changed inside a transaction");
  105488. }else{
  105489. int iLevel = (getSafetyLevel(zRight,0,1)+1) & PAGER_SYNCHRONOUS_MASK;
  105490. if( iLevel==0 ) iLevel = 1;
  105491. pDb->safety_level = iLevel;
  105492. pDb->bSyncSet = 1;
  105493. setAllPagerFlags(db);
  105494. }
  105495. }
  105496. break;
  105497. }
  105498. #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
  105499. #ifndef SQLITE_OMIT_FLAG_PRAGMAS
  105500. case PragTyp_FLAG: {
  105501. if( zRight==0 ){
  105502. returnSingleInt(v, pPragma->zName, (db->flags & pPragma->iArg)!=0 );
  105503. }else{
  105504. int mask = pPragma->iArg; /* Mask of bits to set or clear. */
  105505. if( db->autoCommit==0 ){
  105506. /* Foreign key support may not be enabled or disabled while not
  105507. ** in auto-commit mode. */
  105508. mask &= ~(SQLITE_ForeignKeys);
  105509. }
  105510. #if SQLITE_USER_AUTHENTICATION
  105511. if( db->auth.authLevel==UAUTH_User ){
  105512. /* Do not allow non-admin users to modify the schema arbitrarily */
  105513. mask &= ~(SQLITE_WriteSchema);
  105514. }
  105515. #endif
  105516. if( sqlite3GetBoolean(zRight, 0) ){
  105517. db->flags |= mask;
  105518. }else{
  105519. db->flags &= ~mask;
  105520. if( mask==SQLITE_DeferFKs ) db->nDeferredImmCons = 0;
  105521. }
  105522. /* Many of the flag-pragmas modify the code generated by the SQL
  105523. ** compiler (eg. count_changes). So add an opcode to expire all
  105524. ** compiled SQL statements after modifying a pragma value.
  105525. */
  105526. sqlite3VdbeAddOp0(v, OP_Expire);
  105527. setAllPagerFlags(db);
  105528. }
  105529. break;
  105530. }
  105531. #endif /* SQLITE_OMIT_FLAG_PRAGMAS */
  105532. #ifndef SQLITE_OMIT_SCHEMA_PRAGMAS
  105533. /*
  105534. ** PRAGMA table_info(<table>)
  105535. **
  105536. ** Return a single row for each column of the named table. The columns of
  105537. ** the returned data set are:
  105538. **
  105539. ** cid: Column id (numbered from left to right, starting at 0)
  105540. ** name: Column name
  105541. ** type: Column declaration type.
  105542. ** notnull: True if 'NOT NULL' is part of column declaration
  105543. ** dflt_value: The default value for the column, if any.
  105544. */
  105545. case PragTyp_TABLE_INFO: if( zRight ){
  105546. Table *pTab;
  105547. pTab = sqlite3LocateTable(pParse, LOCATE_NOERR, zRight, zDb);
  105548. if( pTab ){
  105549. static const char *azCol[] = {
  105550. "cid", "name", "type", "notnull", "dflt_value", "pk"
  105551. };
  105552. int i, k;
  105553. int nHidden = 0;
  105554. Column *pCol;
  105555. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  105556. pParse->nMem = 6;
  105557. sqlite3CodeVerifySchema(pParse, iDb);
  105558. setAllColumnNames(v, 6, azCol); assert( 6==ArraySize(azCol) );
  105559. sqlite3ViewGetColumnNames(pParse, pTab);
  105560. for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
  105561. if( IsHiddenColumn(pCol) ){
  105562. nHidden++;
  105563. continue;
  105564. }
  105565. if( (pCol->colFlags & COLFLAG_PRIMKEY)==0 ){
  105566. k = 0;
  105567. }else if( pPk==0 ){
  105568. k = 1;
  105569. }else{
  105570. for(k=1; k<=pTab->nCol && pPk->aiColumn[k-1]!=i; k++){}
  105571. }
  105572. assert( pCol->pDflt==0 || pCol->pDflt->op==TK_SPAN );
  105573. sqlite3VdbeMultiLoad(v, 1, "issisi",
  105574. i-nHidden,
  105575. pCol->zName,
  105576. sqlite3ColumnType(pCol,""),
  105577. pCol->notNull ? 1 : 0,
  105578. pCol->pDflt ? pCol->pDflt->u.zToken : 0,
  105579. k);
  105580. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 6);
  105581. }
  105582. }
  105583. }
  105584. break;
  105585. case PragTyp_STATS: {
  105586. static const char *azCol[] = { "table", "index", "width", "height" };
  105587. Index *pIdx;
  105588. HashElem *i;
  105589. v = sqlite3GetVdbe(pParse);
  105590. pParse->nMem = 4;
  105591. sqlite3CodeVerifySchema(pParse, iDb);
  105592. setAllColumnNames(v, 4, azCol); assert( 4==ArraySize(azCol) );
  105593. for(i=sqliteHashFirst(&pDb->pSchema->tblHash); i; i=sqliteHashNext(i)){
  105594. Table *pTab = sqliteHashData(i);
  105595. sqlite3VdbeMultiLoad(v, 1, "ssii",
  105596. pTab->zName,
  105597. 0,
  105598. pTab->szTabRow,
  105599. pTab->nRowLogEst);
  105600. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 4);
  105601. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  105602. sqlite3VdbeMultiLoad(v, 2, "sii",
  105603. pIdx->zName,
  105604. pIdx->szIdxRow,
  105605. pIdx->aiRowLogEst[0]);
  105606. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 4);
  105607. }
  105608. }
  105609. }
  105610. break;
  105611. case PragTyp_INDEX_INFO: if( zRight ){
  105612. Index *pIdx;
  105613. Table *pTab;
  105614. pIdx = sqlite3FindIndex(db, zRight, zDb);
  105615. if( pIdx ){
  105616. static const char *azCol[] = {
  105617. "seqno", "cid", "name", "desc", "coll", "key"
  105618. };
  105619. int i;
  105620. int mx;
  105621. if( pPragma->iArg ){
  105622. /* PRAGMA index_xinfo (newer version with more rows and columns) */
  105623. mx = pIdx->nColumn;
  105624. pParse->nMem = 6;
  105625. }else{
  105626. /* PRAGMA index_info (legacy version) */
  105627. mx = pIdx->nKeyCol;
  105628. pParse->nMem = 3;
  105629. }
  105630. pTab = pIdx->pTable;
  105631. sqlite3CodeVerifySchema(pParse, iDb);
  105632. assert( pParse->nMem<=ArraySize(azCol) );
  105633. setAllColumnNames(v, pParse->nMem, azCol);
  105634. for(i=0; i<mx; i++){
  105635. i16 cnum = pIdx->aiColumn[i];
  105636. sqlite3VdbeMultiLoad(v, 1, "iis", i, cnum,
  105637. cnum<0 ? 0 : pTab->aCol[cnum].zName);
  105638. if( pPragma->iArg ){
  105639. sqlite3VdbeMultiLoad(v, 4, "isi",
  105640. pIdx->aSortOrder[i],
  105641. pIdx->azColl[i],
  105642. i<pIdx->nKeyCol);
  105643. }
  105644. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, pParse->nMem);
  105645. }
  105646. }
  105647. }
  105648. break;
  105649. case PragTyp_INDEX_LIST: if( zRight ){
  105650. Index *pIdx;
  105651. Table *pTab;
  105652. int i;
  105653. pTab = sqlite3FindTable(db, zRight, zDb);
  105654. if( pTab ){
  105655. static const char *azCol[] = {
  105656. "seq", "name", "unique", "origin", "partial"
  105657. };
  105658. v = sqlite3GetVdbe(pParse);
  105659. pParse->nMem = 5;
  105660. sqlite3CodeVerifySchema(pParse, iDb);
  105661. setAllColumnNames(v, 5, azCol); assert( 5==ArraySize(azCol) );
  105662. for(pIdx=pTab->pIndex, i=0; pIdx; pIdx=pIdx->pNext, i++){
  105663. const char *azOrigin[] = { "c", "u", "pk" };
  105664. sqlite3VdbeMultiLoad(v, 1, "isisi",
  105665. i,
  105666. pIdx->zName,
  105667. IsUniqueIndex(pIdx),
  105668. azOrigin[pIdx->idxType],
  105669. pIdx->pPartIdxWhere!=0);
  105670. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
  105671. }
  105672. }
  105673. }
  105674. break;
  105675. case PragTyp_DATABASE_LIST: {
  105676. static const char *azCol[] = { "seq", "name", "file" };
  105677. int i;
  105678. pParse->nMem = 3;
  105679. setAllColumnNames(v, 3, azCol); assert( 3==ArraySize(azCol) );
  105680. for(i=0; i<db->nDb; i++){
  105681. if( db->aDb[i].pBt==0 ) continue;
  105682. assert( db->aDb[i].zDbSName!=0 );
  105683. sqlite3VdbeMultiLoad(v, 1, "iss",
  105684. i,
  105685. db->aDb[i].zDbSName,
  105686. sqlite3BtreeGetFilename(db->aDb[i].pBt));
  105687. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
  105688. }
  105689. }
  105690. break;
  105691. case PragTyp_COLLATION_LIST: {
  105692. static const char *azCol[] = { "seq", "name" };
  105693. int i = 0;
  105694. HashElem *p;
  105695. pParse->nMem = 2;
  105696. setAllColumnNames(v, 2, azCol); assert( 2==ArraySize(azCol) );
  105697. for(p=sqliteHashFirst(&db->aCollSeq); p; p=sqliteHashNext(p)){
  105698. CollSeq *pColl = (CollSeq *)sqliteHashData(p);
  105699. sqlite3VdbeMultiLoad(v, 1, "is", i++, pColl->zName);
  105700. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 2);
  105701. }
  105702. }
  105703. break;
  105704. #endif /* SQLITE_OMIT_SCHEMA_PRAGMAS */
  105705. #ifndef SQLITE_OMIT_FOREIGN_KEY
  105706. case PragTyp_FOREIGN_KEY_LIST: if( zRight ){
  105707. FKey *pFK;
  105708. Table *pTab;
  105709. pTab = sqlite3FindTable(db, zRight, zDb);
  105710. if( pTab ){
  105711. v = sqlite3GetVdbe(pParse);
  105712. pFK = pTab->pFKey;
  105713. if( pFK ){
  105714. static const char *azCol[] = {
  105715. "id", "seq", "table", "from", "to", "on_update", "on_delete",
  105716. "match"
  105717. };
  105718. int i = 0;
  105719. pParse->nMem = 8;
  105720. sqlite3CodeVerifySchema(pParse, iDb);
  105721. setAllColumnNames(v, 8, azCol); assert( 8==ArraySize(azCol) );
  105722. while(pFK){
  105723. int j;
  105724. for(j=0; j<pFK->nCol; j++){
  105725. sqlite3VdbeMultiLoad(v, 1, "iissssss",
  105726. i,
  105727. j,
  105728. pFK->zTo,
  105729. pTab->aCol[pFK->aCol[j].iFrom].zName,
  105730. pFK->aCol[j].zCol,
  105731. actionName(pFK->aAction[1]), /* ON UPDATE */
  105732. actionName(pFK->aAction[0]), /* ON DELETE */
  105733. "NONE");
  105734. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 8);
  105735. }
  105736. ++i;
  105737. pFK = pFK->pNextFrom;
  105738. }
  105739. }
  105740. }
  105741. }
  105742. break;
  105743. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  105744. #ifndef SQLITE_OMIT_FOREIGN_KEY
  105745. #ifndef SQLITE_OMIT_TRIGGER
  105746. case PragTyp_FOREIGN_KEY_CHECK: {
  105747. FKey *pFK; /* A foreign key constraint */
  105748. Table *pTab; /* Child table contain "REFERENCES" keyword */
  105749. Table *pParent; /* Parent table that child points to */
  105750. Index *pIdx; /* Index in the parent table */
  105751. int i; /* Loop counter: Foreign key number for pTab */
  105752. int j; /* Loop counter: Field of the foreign key */
  105753. HashElem *k; /* Loop counter: Next table in schema */
  105754. int x; /* result variable */
  105755. int regResult; /* 3 registers to hold a result row */
  105756. int regKey; /* Register to hold key for checking the FK */
  105757. int regRow; /* Registers to hold a row from pTab */
  105758. int addrTop; /* Top of a loop checking foreign keys */
  105759. int addrOk; /* Jump here if the key is OK */
  105760. int *aiCols; /* child to parent column mapping */
  105761. static const char *azCol[] = { "table", "rowid", "parent", "fkid" };
  105762. regResult = pParse->nMem+1;
  105763. pParse->nMem += 4;
  105764. regKey = ++pParse->nMem;
  105765. regRow = ++pParse->nMem;
  105766. v = sqlite3GetVdbe(pParse);
  105767. setAllColumnNames(v, 4, azCol); assert( 4==ArraySize(azCol) );
  105768. sqlite3CodeVerifySchema(pParse, iDb);
  105769. k = sqliteHashFirst(&db->aDb[iDb].pSchema->tblHash);
  105770. while( k ){
  105771. if( zRight ){
  105772. pTab = sqlite3LocateTable(pParse, 0, zRight, zDb);
  105773. k = 0;
  105774. }else{
  105775. pTab = (Table*)sqliteHashData(k);
  105776. k = sqliteHashNext(k);
  105777. }
  105778. if( pTab==0 || pTab->pFKey==0 ) continue;
  105779. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  105780. if( pTab->nCol+regRow>pParse->nMem ) pParse->nMem = pTab->nCol + regRow;
  105781. sqlite3OpenTable(pParse, 0, iDb, pTab, OP_OpenRead);
  105782. sqlite3VdbeLoadString(v, regResult, pTab->zName);
  105783. for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
  105784. pParent = sqlite3FindTable(db, pFK->zTo, zDb);
  105785. if( pParent==0 ) continue;
  105786. pIdx = 0;
  105787. sqlite3TableLock(pParse, iDb, pParent->tnum, 0, pParent->zName);
  105788. x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, 0);
  105789. if( x==0 ){
  105790. if( pIdx==0 ){
  105791. sqlite3OpenTable(pParse, i, iDb, pParent, OP_OpenRead);
  105792. }else{
  105793. sqlite3VdbeAddOp3(v, OP_OpenRead, i, pIdx->tnum, iDb);
  105794. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  105795. }
  105796. }else{
  105797. k = 0;
  105798. break;
  105799. }
  105800. }
  105801. assert( pParse->nErr>0 || pFK==0 );
  105802. if( pFK ) break;
  105803. if( pParse->nTab<i ) pParse->nTab = i;
  105804. addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, 0); VdbeCoverage(v);
  105805. for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
  105806. pParent = sqlite3FindTable(db, pFK->zTo, zDb);
  105807. pIdx = 0;
  105808. aiCols = 0;
  105809. if( pParent ){
  105810. x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, &aiCols);
  105811. assert( x==0 );
  105812. }
  105813. addrOk = sqlite3VdbeMakeLabel(v);
  105814. if( pParent && pIdx==0 ){
  105815. int iKey = pFK->aCol[0].iFrom;
  105816. assert( iKey>=0 && iKey<pTab->nCol );
  105817. if( iKey!=pTab->iPKey ){
  105818. sqlite3VdbeAddOp3(v, OP_Column, 0, iKey, regRow);
  105819. sqlite3ColumnDefault(v, pTab, iKey, regRow);
  105820. sqlite3VdbeAddOp2(v, OP_IsNull, regRow, addrOk); VdbeCoverage(v);
  105821. }else{
  105822. sqlite3VdbeAddOp2(v, OP_Rowid, 0, regRow);
  105823. }
  105824. sqlite3VdbeAddOp3(v, OP_SeekRowid, i, 0, regRow); VdbeCoverage(v);
  105825. sqlite3VdbeGoto(v, addrOk);
  105826. sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
  105827. }else{
  105828. for(j=0; j<pFK->nCol; j++){
  105829. sqlite3ExprCodeGetColumnOfTable(v, pTab, 0,
  105830. aiCols ? aiCols[j] : pFK->aCol[j].iFrom, regRow+j);
  105831. sqlite3VdbeAddOp2(v, OP_IsNull, regRow+j, addrOk); VdbeCoverage(v);
  105832. }
  105833. if( pParent ){
  105834. sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, pFK->nCol, regKey,
  105835. sqlite3IndexAffinityStr(db,pIdx), pFK->nCol);
  105836. sqlite3VdbeAddOp4Int(v, OP_Found, i, addrOk, regKey, 0);
  105837. VdbeCoverage(v);
  105838. }
  105839. }
  105840. sqlite3VdbeAddOp2(v, OP_Rowid, 0, regResult+1);
  105841. sqlite3VdbeMultiLoad(v, regResult+2, "si", pFK->zTo, i-1);
  105842. sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, 4);
  105843. sqlite3VdbeResolveLabel(v, addrOk);
  105844. sqlite3DbFree(db, aiCols);
  105845. }
  105846. sqlite3VdbeAddOp2(v, OP_Next, 0, addrTop+1); VdbeCoverage(v);
  105847. sqlite3VdbeJumpHere(v, addrTop);
  105848. }
  105849. }
  105850. break;
  105851. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  105852. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  105853. #ifndef NDEBUG
  105854. case PragTyp_PARSER_TRACE: {
  105855. if( zRight ){
  105856. if( sqlite3GetBoolean(zRight, 0) ){
  105857. sqlite3ParserTrace(stdout, "parser: ");
  105858. }else{
  105859. sqlite3ParserTrace(0, 0);
  105860. }
  105861. }
  105862. }
  105863. break;
  105864. #endif
  105865. /* Reinstall the LIKE and GLOB functions. The variant of LIKE
  105866. ** used will be case sensitive or not depending on the RHS.
  105867. */
  105868. case PragTyp_CASE_SENSITIVE_LIKE: {
  105869. if( zRight ){
  105870. sqlite3RegisterLikeFunctions(db, sqlite3GetBoolean(zRight, 0));
  105871. }
  105872. }
  105873. break;
  105874. #ifndef SQLITE_INTEGRITY_CHECK_ERROR_MAX
  105875. # define SQLITE_INTEGRITY_CHECK_ERROR_MAX 100
  105876. #endif
  105877. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  105878. /* Pragma "quick_check" is reduced version of
  105879. ** integrity_check designed to detect most database corruption
  105880. ** without most of the overhead of a full integrity-check.
  105881. */
  105882. case PragTyp_INTEGRITY_CHECK: {
  105883. int i, j, addr, mxErr;
  105884. int isQuick = (sqlite3Tolower(zLeft[0])=='q');
  105885. /* If the PRAGMA command was of the form "PRAGMA <db>.integrity_check",
  105886. ** then iDb is set to the index of the database identified by <db>.
  105887. ** In this case, the integrity of database iDb only is verified by
  105888. ** the VDBE created below.
  105889. **
  105890. ** Otherwise, if the command was simply "PRAGMA integrity_check" (or
  105891. ** "PRAGMA quick_check"), then iDb is set to 0. In this case, set iDb
  105892. ** to -1 here, to indicate that the VDBE should verify the integrity
  105893. ** of all attached databases. */
  105894. assert( iDb>=0 );
  105895. assert( iDb==0 || pId2->z );
  105896. if( pId2->z==0 ) iDb = -1;
  105897. /* Initialize the VDBE program */
  105898. pParse->nMem = 6;
  105899. setOneColumnName(v, "integrity_check");
  105900. /* Set the maximum error count */
  105901. mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
  105902. if( zRight ){
  105903. sqlite3GetInt32(zRight, &mxErr);
  105904. if( mxErr<=0 ){
  105905. mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
  105906. }
  105907. }
  105908. sqlite3VdbeAddOp2(v, OP_Integer, mxErr, 1); /* reg[1] holds errors left */
  105909. /* Do an integrity check on each database file */
  105910. for(i=0; i<db->nDb; i++){
  105911. HashElem *x;
  105912. Hash *pTbls;
  105913. int *aRoot;
  105914. int cnt = 0;
  105915. int mxIdx = 0;
  105916. int nIdx;
  105917. if( OMIT_TEMPDB && i==1 ) continue;
  105918. if( iDb>=0 && i!=iDb ) continue;
  105919. sqlite3CodeVerifySchema(pParse, i);
  105920. addr = sqlite3VdbeAddOp1(v, OP_IfPos, 1); /* Halt if out of errors */
  105921. VdbeCoverage(v);
  105922. sqlite3VdbeAddOp2(v, OP_Halt, 0, 0);
  105923. sqlite3VdbeJumpHere(v, addr);
  105924. /* Do an integrity check of the B-Tree
  105925. **
  105926. ** Begin by finding the root pages numbers
  105927. ** for all tables and indices in the database.
  105928. */
  105929. assert( sqlite3SchemaMutexHeld(db, i, 0) );
  105930. pTbls = &db->aDb[i].pSchema->tblHash;
  105931. for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
  105932. Table *pTab = sqliteHashData(x);
  105933. Index *pIdx;
  105934. if( HasRowid(pTab) ) cnt++;
  105935. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){ cnt++; }
  105936. if( nIdx>mxIdx ) mxIdx = nIdx;
  105937. }
  105938. aRoot = sqlite3DbMallocRawNN(db, sizeof(int)*(cnt+1));
  105939. if( aRoot==0 ) break;
  105940. for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
  105941. Table *pTab = sqliteHashData(x);
  105942. Index *pIdx;
  105943. if( HasRowid(pTab) ) aRoot[cnt++] = pTab->tnum;
  105944. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  105945. aRoot[cnt++] = pIdx->tnum;
  105946. }
  105947. }
  105948. aRoot[cnt] = 0;
  105949. /* Make sure sufficient number of registers have been allocated */
  105950. pParse->nMem = MAX( pParse->nMem, 8+mxIdx );
  105951. /* Do the b-tree integrity checks */
  105952. sqlite3VdbeAddOp4(v, OP_IntegrityCk, 2, cnt, 1, (char*)aRoot,P4_INTARRAY);
  105953. sqlite3VdbeChangeP5(v, (u8)i);
  105954. addr = sqlite3VdbeAddOp1(v, OP_IsNull, 2); VdbeCoverage(v);
  105955. sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0,
  105956. sqlite3MPrintf(db, "*** in database %s ***\n", db->aDb[i].zDbSName),
  105957. P4_DYNAMIC);
  105958. sqlite3VdbeAddOp3(v, OP_Move, 2, 4, 1);
  105959. sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 2);
  105960. sqlite3VdbeAddOp2(v, OP_ResultRow, 2, 1);
  105961. sqlite3VdbeJumpHere(v, addr);
  105962. /* Make sure all the indices are constructed correctly.
  105963. */
  105964. for(x=sqliteHashFirst(pTbls); x && !isQuick; x=sqliteHashNext(x)){
  105965. Table *pTab = sqliteHashData(x);
  105966. Index *pIdx, *pPk;
  105967. Index *pPrior = 0;
  105968. int loopTop;
  105969. int iDataCur, iIdxCur;
  105970. int r1 = -1;
  105971. if( pTab->pIndex==0 ) continue;
  105972. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  105973. addr = sqlite3VdbeAddOp1(v, OP_IfPos, 1); /* Stop if out of errors */
  105974. VdbeCoverage(v);
  105975. sqlite3VdbeAddOp2(v, OP_Halt, 0, 0);
  105976. sqlite3VdbeJumpHere(v, addr);
  105977. sqlite3ExprCacheClear(pParse);
  105978. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenRead, 0,
  105979. 1, 0, &iDataCur, &iIdxCur);
  105980. sqlite3VdbeAddOp2(v, OP_Integer, 0, 7);
  105981. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  105982. sqlite3VdbeAddOp2(v, OP_Integer, 0, 8+j); /* index entries counter */
  105983. }
  105984. assert( pParse->nMem>=8+j );
  105985. assert( sqlite3NoTempsInRange(pParse,1,7+j) );
  105986. sqlite3VdbeAddOp2(v, OP_Rewind, iDataCur, 0); VdbeCoverage(v);
  105987. loopTop = sqlite3VdbeAddOp2(v, OP_AddImm, 7, 1);
  105988. /* Verify that all NOT NULL columns really are NOT NULL */
  105989. for(j=0; j<pTab->nCol; j++){
  105990. char *zErr;
  105991. int jmp2, jmp3;
  105992. if( j==pTab->iPKey ) continue;
  105993. if( pTab->aCol[j].notNull==0 ) continue;
  105994. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, j, 3);
  105995. sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
  105996. jmp2 = sqlite3VdbeAddOp1(v, OP_NotNull, 3); VdbeCoverage(v);
  105997. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1); /* Decrement error limit */
  105998. zErr = sqlite3MPrintf(db, "NULL value in %s.%s", pTab->zName,
  105999. pTab->aCol[j].zName);
  106000. sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
  106001. sqlite3VdbeAddOp2(v, OP_ResultRow, 3, 1);
  106002. jmp3 = sqlite3VdbeAddOp1(v, OP_IfPos, 1); VdbeCoverage(v);
  106003. sqlite3VdbeAddOp0(v, OP_Halt);
  106004. sqlite3VdbeJumpHere(v, jmp2);
  106005. sqlite3VdbeJumpHere(v, jmp3);
  106006. }
  106007. /* Validate index entries for the current row */
  106008. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  106009. int jmp2, jmp3, jmp4, jmp5;
  106010. int ckUniq = sqlite3VdbeMakeLabel(v);
  106011. if( pPk==pIdx ) continue;
  106012. r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 0, &jmp3,
  106013. pPrior, r1);
  106014. pPrior = pIdx;
  106015. sqlite3VdbeAddOp2(v, OP_AddImm, 8+j, 1); /* increment entry count */
  106016. /* Verify that an index entry exists for the current table row */
  106017. jmp2 = sqlite3VdbeAddOp4Int(v, OP_Found, iIdxCur+j, ckUniq, r1,
  106018. pIdx->nColumn); VdbeCoverage(v);
  106019. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1); /* Decrement error limit */
  106020. sqlite3VdbeLoadString(v, 3, "row ");
  106021. sqlite3VdbeAddOp3(v, OP_Concat, 7, 3, 3);
  106022. sqlite3VdbeLoadString(v, 4, " missing from index ");
  106023. sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
  106024. jmp5 = sqlite3VdbeLoadString(v, 4, pIdx->zName);
  106025. sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
  106026. sqlite3VdbeAddOp2(v, OP_ResultRow, 3, 1);
  106027. jmp4 = sqlite3VdbeAddOp1(v, OP_IfPos, 1); VdbeCoverage(v);
  106028. sqlite3VdbeAddOp0(v, OP_Halt);
  106029. sqlite3VdbeJumpHere(v, jmp2);
  106030. /* For UNIQUE indexes, verify that only one entry exists with the
  106031. ** current key. The entry is unique if (1) any column is NULL
  106032. ** or (2) the next entry has a different key */
  106033. if( IsUniqueIndex(pIdx) ){
  106034. int uniqOk = sqlite3VdbeMakeLabel(v);
  106035. int jmp6;
  106036. int kk;
  106037. for(kk=0; kk<pIdx->nKeyCol; kk++){
  106038. int iCol = pIdx->aiColumn[kk];
  106039. assert( iCol!=XN_ROWID && iCol<pTab->nCol );
  106040. if( iCol>=0 && pTab->aCol[iCol].notNull ) continue;
  106041. sqlite3VdbeAddOp2(v, OP_IsNull, r1+kk, uniqOk);
  106042. VdbeCoverage(v);
  106043. }
  106044. jmp6 = sqlite3VdbeAddOp1(v, OP_Next, iIdxCur+j); VdbeCoverage(v);
  106045. sqlite3VdbeGoto(v, uniqOk);
  106046. sqlite3VdbeJumpHere(v, jmp6);
  106047. sqlite3VdbeAddOp4Int(v, OP_IdxGT, iIdxCur+j, uniqOk, r1,
  106048. pIdx->nKeyCol); VdbeCoverage(v);
  106049. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1); /* Decrement error limit */
  106050. sqlite3VdbeLoadString(v, 3, "non-unique entry in index ");
  106051. sqlite3VdbeGoto(v, jmp5);
  106052. sqlite3VdbeResolveLabel(v, uniqOk);
  106053. }
  106054. sqlite3VdbeJumpHere(v, jmp4);
  106055. sqlite3ResolvePartIdxLabel(pParse, jmp3);
  106056. }
  106057. sqlite3VdbeAddOp2(v, OP_Next, iDataCur, loopTop); VdbeCoverage(v);
  106058. sqlite3VdbeJumpHere(v, loopTop-1);
  106059. #ifndef SQLITE_OMIT_BTREECOUNT
  106060. sqlite3VdbeLoadString(v, 2, "wrong # of entries in index ");
  106061. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  106062. if( pPk==pIdx ) continue;
  106063. addr = sqlite3VdbeCurrentAddr(v);
  106064. sqlite3VdbeAddOp2(v, OP_IfPos, 1, addr+2); VdbeCoverage(v);
  106065. sqlite3VdbeAddOp2(v, OP_Halt, 0, 0);
  106066. sqlite3VdbeAddOp2(v, OP_Count, iIdxCur+j, 3);
  106067. sqlite3VdbeAddOp3(v, OP_Eq, 8+j, addr+8, 3); VdbeCoverage(v);
  106068. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  106069. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1);
  106070. sqlite3VdbeLoadString(v, 3, pIdx->zName);
  106071. sqlite3VdbeAddOp3(v, OP_Concat, 3, 2, 7);
  106072. sqlite3VdbeAddOp2(v, OP_ResultRow, 7, 1);
  106073. }
  106074. #endif /* SQLITE_OMIT_BTREECOUNT */
  106075. }
  106076. }
  106077. {
  106078. static const int iLn = VDBE_OFFSET_LINENO(2);
  106079. static const VdbeOpList endCode[] = {
  106080. { OP_AddImm, 1, 0, 0}, /* 0 */
  106081. { OP_If, 1, 4, 0}, /* 1 */
  106082. { OP_String8, 0, 3, 0}, /* 2 */
  106083. { OP_ResultRow, 3, 1, 0}, /* 3 */
  106084. };
  106085. VdbeOp *aOp;
  106086. aOp = sqlite3VdbeAddOpList(v, ArraySize(endCode), endCode, iLn);
  106087. if( aOp ){
  106088. aOp[0].p2 = -mxErr;
  106089. aOp[2].p4type = P4_STATIC;
  106090. aOp[2].p4.z = "ok";
  106091. }
  106092. }
  106093. }
  106094. break;
  106095. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  106096. #ifndef SQLITE_OMIT_UTF16
  106097. /*
  106098. ** PRAGMA encoding
  106099. ** PRAGMA encoding = "utf-8"|"utf-16"|"utf-16le"|"utf-16be"
  106100. **
  106101. ** In its first form, this pragma returns the encoding of the main
  106102. ** database. If the database is not initialized, it is initialized now.
  106103. **
  106104. ** The second form of this pragma is a no-op if the main database file
  106105. ** has not already been initialized. In this case it sets the default
  106106. ** encoding that will be used for the main database file if a new file
  106107. ** is created. If an existing main database file is opened, then the
  106108. ** default text encoding for the existing database is used.
  106109. **
  106110. ** In all cases new databases created using the ATTACH command are
  106111. ** created to use the same default text encoding as the main database. If
  106112. ** the main database has not been initialized and/or created when ATTACH
  106113. ** is executed, this is done before the ATTACH operation.
  106114. **
  106115. ** In the second form this pragma sets the text encoding to be used in
  106116. ** new database files created using this database handle. It is only
  106117. ** useful if invoked immediately after the main database i
  106118. */
  106119. case PragTyp_ENCODING: {
  106120. static const struct EncName {
  106121. char *zName;
  106122. u8 enc;
  106123. } encnames[] = {
  106124. { "UTF8", SQLITE_UTF8 },
  106125. { "UTF-8", SQLITE_UTF8 }, /* Must be element [1] */
  106126. { "UTF-16le", SQLITE_UTF16LE }, /* Must be element [2] */
  106127. { "UTF-16be", SQLITE_UTF16BE }, /* Must be element [3] */
  106128. { "UTF16le", SQLITE_UTF16LE },
  106129. { "UTF16be", SQLITE_UTF16BE },
  106130. { "UTF-16", 0 }, /* SQLITE_UTF16NATIVE */
  106131. { "UTF16", 0 }, /* SQLITE_UTF16NATIVE */
  106132. { 0, 0 }
  106133. };
  106134. const struct EncName *pEnc;
  106135. if( !zRight ){ /* "PRAGMA encoding" */
  106136. if( sqlite3ReadSchema(pParse) ) goto pragma_out;
  106137. assert( encnames[SQLITE_UTF8].enc==SQLITE_UTF8 );
  106138. assert( encnames[SQLITE_UTF16LE].enc==SQLITE_UTF16LE );
  106139. assert( encnames[SQLITE_UTF16BE].enc==SQLITE_UTF16BE );
  106140. returnSingleText(v, "encoding", encnames[ENC(pParse->db)].zName);
  106141. }else{ /* "PRAGMA encoding = XXX" */
  106142. /* Only change the value of sqlite.enc if the database handle is not
  106143. ** initialized. If the main database exists, the new sqlite.enc value
  106144. ** will be overwritten when the schema is next loaded. If it does not
  106145. ** already exists, it will be created to use the new encoding value.
  106146. */
  106147. if(
  106148. !(DbHasProperty(db, 0, DB_SchemaLoaded)) ||
  106149. DbHasProperty(db, 0, DB_Empty)
  106150. ){
  106151. for(pEnc=&encnames[0]; pEnc->zName; pEnc++){
  106152. if( 0==sqlite3StrICmp(zRight, pEnc->zName) ){
  106153. SCHEMA_ENC(db) = ENC(db) =
  106154. pEnc->enc ? pEnc->enc : SQLITE_UTF16NATIVE;
  106155. break;
  106156. }
  106157. }
  106158. if( !pEnc->zName ){
  106159. sqlite3ErrorMsg(pParse, "unsupported encoding: %s", zRight);
  106160. }
  106161. }
  106162. }
  106163. }
  106164. break;
  106165. #endif /* SQLITE_OMIT_UTF16 */
  106166. #ifndef SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
  106167. /*
  106168. ** PRAGMA [schema.]schema_version
  106169. ** PRAGMA [schema.]schema_version = <integer>
  106170. **
  106171. ** PRAGMA [schema.]user_version
  106172. ** PRAGMA [schema.]user_version = <integer>
  106173. **
  106174. ** PRAGMA [schema.]freelist_count
  106175. **
  106176. ** PRAGMA [schema.]data_version
  106177. **
  106178. ** PRAGMA [schema.]application_id
  106179. ** PRAGMA [schema.]application_id = <integer>
  106180. **
  106181. ** The pragma's schema_version and user_version are used to set or get
  106182. ** the value of the schema-version and user-version, respectively. Both
  106183. ** the schema-version and the user-version are 32-bit signed integers
  106184. ** stored in the database header.
  106185. **
  106186. ** The schema-cookie is usually only manipulated internally by SQLite. It
  106187. ** is incremented by SQLite whenever the database schema is modified (by
  106188. ** creating or dropping a table or index). The schema version is used by
  106189. ** SQLite each time a query is executed to ensure that the internal cache
  106190. ** of the schema used when compiling the SQL query matches the schema of
  106191. ** the database against which the compiled query is actually executed.
  106192. ** Subverting this mechanism by using "PRAGMA schema_version" to modify
  106193. ** the schema-version is potentially dangerous and may lead to program
  106194. ** crashes or database corruption. Use with caution!
  106195. **
  106196. ** The user-version is not used internally by SQLite. It may be used by
  106197. ** applications for any purpose.
  106198. */
  106199. case PragTyp_HEADER_VALUE: {
  106200. int iCookie = pPragma->iArg; /* Which cookie to read or write */
  106201. sqlite3VdbeUsesBtree(v, iDb);
  106202. if( zRight && (pPragma->mPragFlag & PragFlag_ReadOnly)==0 ){
  106203. /* Write the specified cookie value */
  106204. static const VdbeOpList setCookie[] = {
  106205. { OP_Transaction, 0, 1, 0}, /* 0 */
  106206. { OP_SetCookie, 0, 0, 0}, /* 1 */
  106207. };
  106208. VdbeOp *aOp;
  106209. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setCookie));
  106210. aOp = sqlite3VdbeAddOpList(v, ArraySize(setCookie), setCookie, 0);
  106211. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  106212. aOp[0].p1 = iDb;
  106213. aOp[1].p1 = iDb;
  106214. aOp[1].p2 = iCookie;
  106215. aOp[1].p3 = sqlite3Atoi(zRight);
  106216. }else{
  106217. /* Read the specified cookie value */
  106218. static const VdbeOpList readCookie[] = {
  106219. { OP_Transaction, 0, 0, 0}, /* 0 */
  106220. { OP_ReadCookie, 0, 1, 0}, /* 1 */
  106221. { OP_ResultRow, 1, 1, 0}
  106222. };
  106223. VdbeOp *aOp;
  106224. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(readCookie));
  106225. aOp = sqlite3VdbeAddOpList(v, ArraySize(readCookie),readCookie,0);
  106226. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  106227. aOp[0].p1 = iDb;
  106228. aOp[1].p1 = iDb;
  106229. aOp[1].p3 = iCookie;
  106230. sqlite3VdbeSetNumCols(v, 1);
  106231. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, zLeft, SQLITE_TRANSIENT);
  106232. sqlite3VdbeReusable(v);
  106233. }
  106234. }
  106235. break;
  106236. #endif /* SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS */
  106237. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  106238. /*
  106239. ** PRAGMA compile_options
  106240. **
  106241. ** Return the names of all compile-time options used in this build,
  106242. ** one option per row.
  106243. */
  106244. case PragTyp_COMPILE_OPTIONS: {
  106245. int i = 0;
  106246. const char *zOpt;
  106247. pParse->nMem = 1;
  106248. setOneColumnName(v, "compile_option");
  106249. while( (zOpt = sqlite3_compileoption_get(i++))!=0 ){
  106250. sqlite3VdbeLoadString(v, 1, zOpt);
  106251. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  106252. }
  106253. sqlite3VdbeReusable(v);
  106254. }
  106255. break;
  106256. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  106257. #ifndef SQLITE_OMIT_WAL
  106258. /*
  106259. ** PRAGMA [schema.]wal_checkpoint = passive|full|restart|truncate
  106260. **
  106261. ** Checkpoint the database.
  106262. */
  106263. case PragTyp_WAL_CHECKPOINT: {
  106264. static const char *azCol[] = { "busy", "log", "checkpointed" };
  106265. int iBt = (pId2->z?iDb:SQLITE_MAX_ATTACHED);
  106266. int eMode = SQLITE_CHECKPOINT_PASSIVE;
  106267. if( zRight ){
  106268. if( sqlite3StrICmp(zRight, "full")==0 ){
  106269. eMode = SQLITE_CHECKPOINT_FULL;
  106270. }else if( sqlite3StrICmp(zRight, "restart")==0 ){
  106271. eMode = SQLITE_CHECKPOINT_RESTART;
  106272. }else if( sqlite3StrICmp(zRight, "truncate")==0 ){
  106273. eMode = SQLITE_CHECKPOINT_TRUNCATE;
  106274. }
  106275. }
  106276. setAllColumnNames(v, 3, azCol); assert( 3==ArraySize(azCol) );
  106277. pParse->nMem = 3;
  106278. sqlite3VdbeAddOp3(v, OP_Checkpoint, iBt, eMode, 1);
  106279. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
  106280. }
  106281. break;
  106282. /*
  106283. ** PRAGMA wal_autocheckpoint
  106284. ** PRAGMA wal_autocheckpoint = N
  106285. **
  106286. ** Configure a database connection to automatically checkpoint a database
  106287. ** after accumulating N frames in the log. Or query for the current value
  106288. ** of N.
  106289. */
  106290. case PragTyp_WAL_AUTOCHECKPOINT: {
  106291. if( zRight ){
  106292. sqlite3_wal_autocheckpoint(db, sqlite3Atoi(zRight));
  106293. }
  106294. returnSingleInt(v, "wal_autocheckpoint",
  106295. db->xWalCallback==sqlite3WalDefaultHook ?
  106296. SQLITE_PTR_TO_INT(db->pWalArg) : 0);
  106297. }
  106298. break;
  106299. #endif
  106300. /*
  106301. ** PRAGMA shrink_memory
  106302. **
  106303. ** IMPLEMENTATION-OF: R-23445-46109 This pragma causes the database
  106304. ** connection on which it is invoked to free up as much memory as it
  106305. ** can, by calling sqlite3_db_release_memory().
  106306. */
  106307. case PragTyp_SHRINK_MEMORY: {
  106308. sqlite3_db_release_memory(db);
  106309. break;
  106310. }
  106311. /*
  106312. ** PRAGMA busy_timeout
  106313. ** PRAGMA busy_timeout = N
  106314. **
  106315. ** Call sqlite3_busy_timeout(db, N). Return the current timeout value
  106316. ** if one is set. If no busy handler or a different busy handler is set
  106317. ** then 0 is returned. Setting the busy_timeout to 0 or negative
  106318. ** disables the timeout.
  106319. */
  106320. /*case PragTyp_BUSY_TIMEOUT*/ default: {
  106321. assert( pPragma->ePragTyp==PragTyp_BUSY_TIMEOUT );
  106322. if( zRight ){
  106323. sqlite3_busy_timeout(db, sqlite3Atoi(zRight));
  106324. }
  106325. returnSingleInt(v, "timeout", db->busyTimeout);
  106326. break;
  106327. }
  106328. /*
  106329. ** PRAGMA soft_heap_limit
  106330. ** PRAGMA soft_heap_limit = N
  106331. **
  106332. ** IMPLEMENTATION-OF: R-26343-45930 This pragma invokes the
  106333. ** sqlite3_soft_heap_limit64() interface with the argument N, if N is
  106334. ** specified and is a non-negative integer.
  106335. ** IMPLEMENTATION-OF: R-64451-07163 The soft_heap_limit pragma always
  106336. ** returns the same integer that would be returned by the
  106337. ** sqlite3_soft_heap_limit64(-1) C-language function.
  106338. */
  106339. case PragTyp_SOFT_HEAP_LIMIT: {
  106340. sqlite3_int64 N;
  106341. if( zRight && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK ){
  106342. sqlite3_soft_heap_limit64(N);
  106343. }
  106344. returnSingleInt(v, "soft_heap_limit", sqlite3_soft_heap_limit64(-1));
  106345. break;
  106346. }
  106347. /*
  106348. ** PRAGMA threads
  106349. ** PRAGMA threads = N
  106350. **
  106351. ** Configure the maximum number of worker threads. Return the new
  106352. ** maximum, which might be less than requested.
  106353. */
  106354. case PragTyp_THREADS: {
  106355. sqlite3_int64 N;
  106356. if( zRight
  106357. && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK
  106358. && N>=0
  106359. ){
  106360. sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, (int)(N&0x7fffffff));
  106361. }
  106362. returnSingleInt(v, "threads",
  106363. sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, -1));
  106364. break;
  106365. }
  106366. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  106367. /*
  106368. ** Report the current state of file logs for all databases
  106369. */
  106370. case PragTyp_LOCK_STATUS: {
  106371. static const char *const azLockName[] = {
  106372. "unlocked", "shared", "reserved", "pending", "exclusive"
  106373. };
  106374. static const char *azCol[] = { "database", "status" };
  106375. int i;
  106376. setAllColumnNames(v, 2, azCol); assert( 2==ArraySize(azCol) );
  106377. pParse->nMem = 2;
  106378. for(i=0; i<db->nDb; i++){
  106379. Btree *pBt;
  106380. const char *zState = "unknown";
  106381. int j;
  106382. if( db->aDb[i].zDbSName==0 ) continue;
  106383. pBt = db->aDb[i].pBt;
  106384. if( pBt==0 || sqlite3BtreePager(pBt)==0 ){
  106385. zState = "closed";
  106386. }else if( sqlite3_file_control(db, i ? db->aDb[i].zDbSName : 0,
  106387. SQLITE_FCNTL_LOCKSTATE, &j)==SQLITE_OK ){
  106388. zState = azLockName[j];
  106389. }
  106390. sqlite3VdbeMultiLoad(v, 1, "ss", db->aDb[i].zDbSName, zState);
  106391. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 2);
  106392. }
  106393. break;
  106394. }
  106395. #endif
  106396. #ifdef SQLITE_HAS_CODEC
  106397. case PragTyp_KEY: {
  106398. if( zRight ) sqlite3_key_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
  106399. break;
  106400. }
  106401. case PragTyp_REKEY: {
  106402. if( zRight ) sqlite3_rekey_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
  106403. break;
  106404. }
  106405. case PragTyp_HEXKEY: {
  106406. if( zRight ){
  106407. u8 iByte;
  106408. int i;
  106409. char zKey[40];
  106410. for(i=0, iByte=0; i<sizeof(zKey)*2 && sqlite3Isxdigit(zRight[i]); i++){
  106411. iByte = (iByte<<4) + sqlite3HexToInt(zRight[i]);
  106412. if( (i&1)!=0 ) zKey[i/2] = iByte;
  106413. }
  106414. if( (zLeft[3] & 0xf)==0xb ){
  106415. sqlite3_key_v2(db, zDb, zKey, i/2);
  106416. }else{
  106417. sqlite3_rekey_v2(db, zDb, zKey, i/2);
  106418. }
  106419. }
  106420. break;
  106421. }
  106422. #endif
  106423. #if defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
  106424. case PragTyp_ACTIVATE_EXTENSIONS: if( zRight ){
  106425. #ifdef SQLITE_HAS_CODEC
  106426. if( sqlite3StrNICmp(zRight, "see-", 4)==0 ){
  106427. sqlite3_activate_see(&zRight[4]);
  106428. }
  106429. #endif
  106430. #ifdef SQLITE_ENABLE_CEROD
  106431. if( sqlite3StrNICmp(zRight, "cerod-", 6)==0 ){
  106432. sqlite3_activate_cerod(&zRight[6]);
  106433. }
  106434. #endif
  106435. }
  106436. break;
  106437. #endif
  106438. } /* End of the PRAGMA switch */
  106439. pragma_out:
  106440. sqlite3DbFree(db, zLeft);
  106441. sqlite3DbFree(db, zRight);
  106442. }
  106443. #endif /* SQLITE_OMIT_PRAGMA */
  106444. /************** End of pragma.c **********************************************/
  106445. /************** Begin file prepare.c *****************************************/
  106446. /*
  106447. ** 2005 May 25
  106448. **
  106449. ** The author disclaims copyright to this source code. In place of
  106450. ** a legal notice, here is a blessing:
  106451. **
  106452. ** May you do good and not evil.
  106453. ** May you find forgiveness for yourself and forgive others.
  106454. ** May you share freely, never taking more than you give.
  106455. **
  106456. *************************************************************************
  106457. ** This file contains the implementation of the sqlite3_prepare()
  106458. ** interface, and routines that contribute to loading the database schema
  106459. ** from disk.
  106460. */
  106461. /* #include "sqliteInt.h" */
  106462. /*
  106463. ** Fill the InitData structure with an error message that indicates
  106464. ** that the database is corrupt.
  106465. */
  106466. static void corruptSchema(
  106467. InitData *pData, /* Initialization context */
  106468. const char *zObj, /* Object being parsed at the point of error */
  106469. const char *zExtra /* Error information */
  106470. ){
  106471. sqlite3 *db = pData->db;
  106472. if( !db->mallocFailed && (db->flags & SQLITE_RecoveryMode)==0 ){
  106473. char *z;
  106474. if( zObj==0 ) zObj = "?";
  106475. z = sqlite3MPrintf(db, "malformed database schema (%s)", zObj);
  106476. if( zExtra ) z = sqlite3MPrintf(db, "%z - %s", z, zExtra);
  106477. sqlite3DbFree(db, *pData->pzErrMsg);
  106478. *pData->pzErrMsg = z;
  106479. }
  106480. pData->rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_CORRUPT_BKPT;
  106481. }
  106482. /*
  106483. ** This is the callback routine for the code that initializes the
  106484. ** database. See sqlite3Init() below for additional information.
  106485. ** This routine is also called from the OP_ParseSchema opcode of the VDBE.
  106486. **
  106487. ** Each callback contains the following information:
  106488. **
  106489. ** argv[0] = name of thing being created
  106490. ** argv[1] = root page number for table or index. 0 for trigger or view.
  106491. ** argv[2] = SQL text for the CREATE statement.
  106492. **
  106493. */
  106494. SQLITE_PRIVATE int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
  106495. InitData *pData = (InitData*)pInit;
  106496. sqlite3 *db = pData->db;
  106497. int iDb = pData->iDb;
  106498. assert( argc==3 );
  106499. UNUSED_PARAMETER2(NotUsed, argc);
  106500. assert( sqlite3_mutex_held(db->mutex) );
  106501. DbClearProperty(db, iDb, DB_Empty);
  106502. if( db->mallocFailed ){
  106503. corruptSchema(pData, argv[0], 0);
  106504. return 1;
  106505. }
  106506. assert( iDb>=0 && iDb<db->nDb );
  106507. if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
  106508. if( argv[1]==0 ){
  106509. corruptSchema(pData, argv[0], 0);
  106510. }else if( sqlite3_strnicmp(argv[2],"create ",7)==0 ){
  106511. /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
  106512. ** But because db->init.busy is set to 1, no VDBE code is generated
  106513. ** or executed. All the parser does is build the internal data
  106514. ** structures that describe the table, index, or view.
  106515. */
  106516. int rc;
  106517. u8 saved_iDb = db->init.iDb;
  106518. sqlite3_stmt *pStmt;
  106519. TESTONLY(int rcp); /* Return code from sqlite3_prepare() */
  106520. assert( db->init.busy );
  106521. db->init.iDb = iDb;
  106522. db->init.newTnum = sqlite3Atoi(argv[1]);
  106523. db->init.orphanTrigger = 0;
  106524. TESTONLY(rcp = ) sqlite3_prepare(db, argv[2], -1, &pStmt, 0);
  106525. rc = db->errCode;
  106526. assert( (rc&0xFF)==(rcp&0xFF) );
  106527. db->init.iDb = saved_iDb;
  106528. assert( saved_iDb==0 || (db->flags & SQLITE_Vacuum)!=0 );
  106529. if( SQLITE_OK!=rc ){
  106530. if( db->init.orphanTrigger ){
  106531. assert( iDb==1 );
  106532. }else{
  106533. pData->rc = rc;
  106534. if( rc==SQLITE_NOMEM ){
  106535. sqlite3OomFault(db);
  106536. }else if( rc!=SQLITE_INTERRUPT && (rc&0xFF)!=SQLITE_LOCKED ){
  106537. corruptSchema(pData, argv[0], sqlite3_errmsg(db));
  106538. }
  106539. }
  106540. }
  106541. sqlite3_finalize(pStmt);
  106542. }else if( argv[0]==0 || (argv[2]!=0 && argv[2][0]!=0) ){
  106543. corruptSchema(pData, argv[0], 0);
  106544. }else{
  106545. /* If the SQL column is blank it means this is an index that
  106546. ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
  106547. ** constraint for a CREATE TABLE. The index should have already
  106548. ** been created when we processed the CREATE TABLE. All we have
  106549. ** to do here is record the root page number for that index.
  106550. */
  106551. Index *pIndex;
  106552. pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zDbSName);
  106553. if( pIndex==0 ){
  106554. /* This can occur if there exists an index on a TEMP table which
  106555. ** has the same name as another index on a permanent index. Since
  106556. ** the permanent table is hidden by the TEMP table, we can also
  106557. ** safely ignore the index on the permanent table.
  106558. */
  106559. /* Do Nothing */;
  106560. }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
  106561. corruptSchema(pData, argv[0], "invalid rootpage");
  106562. }
  106563. }
  106564. return 0;
  106565. }
  106566. /*
  106567. ** Attempt to read the database schema and initialize internal
  106568. ** data structures for a single database file. The index of the
  106569. ** database file is given by iDb. iDb==0 is used for the main
  106570. ** database. iDb==1 should never be used. iDb>=2 is used for
  106571. ** auxiliary databases. Return one of the SQLITE_ error codes to
  106572. ** indicate success or failure.
  106573. */
  106574. static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
  106575. int rc;
  106576. int i;
  106577. #ifndef SQLITE_OMIT_DEPRECATED
  106578. int size;
  106579. #endif
  106580. Db *pDb;
  106581. char const *azArg[4];
  106582. int meta[5];
  106583. InitData initData;
  106584. const char *zMasterName;
  106585. int openedTransaction = 0;
  106586. assert( iDb>=0 && iDb<db->nDb );
  106587. assert( db->aDb[iDb].pSchema );
  106588. assert( sqlite3_mutex_held(db->mutex) );
  106589. assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
  106590. /* Construct the in-memory representation schema tables (sqlite_master or
  106591. ** sqlite_temp_master) by invoking the parser directly. The appropriate
  106592. ** table name will be inserted automatically by the parser so we can just
  106593. ** use the abbreviation "x" here. The parser will also automatically tag
  106594. ** the schema table as read-only. */
  106595. azArg[0] = zMasterName = SCHEMA_TABLE(iDb);
  106596. azArg[1] = "1";
  106597. azArg[2] = "CREATE TABLE x(type text,name text,tbl_name text,"
  106598. "rootpage integer,sql text)";
  106599. azArg[3] = 0;
  106600. initData.db = db;
  106601. initData.iDb = iDb;
  106602. initData.rc = SQLITE_OK;
  106603. initData.pzErrMsg = pzErrMsg;
  106604. sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
  106605. if( initData.rc ){
  106606. rc = initData.rc;
  106607. goto error_out;
  106608. }
  106609. /* Create a cursor to hold the database open
  106610. */
  106611. pDb = &db->aDb[iDb];
  106612. if( pDb->pBt==0 ){
  106613. if( !OMIT_TEMPDB && ALWAYS(iDb==1) ){
  106614. DbSetProperty(db, 1, DB_SchemaLoaded);
  106615. }
  106616. return SQLITE_OK;
  106617. }
  106618. /* If there is not already a read-only (or read-write) transaction opened
  106619. ** on the b-tree database, open one now. If a transaction is opened, it
  106620. ** will be closed before this function returns. */
  106621. sqlite3BtreeEnter(pDb->pBt);
  106622. if( !sqlite3BtreeIsInReadTrans(pDb->pBt) ){
  106623. rc = sqlite3BtreeBeginTrans(pDb->pBt, 0);
  106624. if( rc!=SQLITE_OK ){
  106625. sqlite3SetString(pzErrMsg, db, sqlite3ErrStr(rc));
  106626. goto initone_error_out;
  106627. }
  106628. openedTransaction = 1;
  106629. }
  106630. /* Get the database meta information.
  106631. **
  106632. ** Meta values are as follows:
  106633. ** meta[0] Schema cookie. Changes with each schema change.
  106634. ** meta[1] File format of schema layer.
  106635. ** meta[2] Size of the page cache.
  106636. ** meta[3] Largest rootpage (auto/incr_vacuum mode)
  106637. ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
  106638. ** meta[5] User version
  106639. ** meta[6] Incremental vacuum mode
  106640. ** meta[7] unused
  106641. ** meta[8] unused
  106642. ** meta[9] unused
  106643. **
  106644. ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
  106645. ** the possible values of meta[4].
  106646. */
  106647. for(i=0; i<ArraySize(meta); i++){
  106648. sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
  106649. }
  106650. pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
  106651. /* If opening a non-empty database, check the text encoding. For the
  106652. ** main database, set sqlite3.enc to the encoding of the main database.
  106653. ** For an attached db, it is an error if the encoding is not the same
  106654. ** as sqlite3.enc.
  106655. */
  106656. if( meta[BTREE_TEXT_ENCODING-1] ){ /* text encoding */
  106657. if( iDb==0 ){
  106658. #ifndef SQLITE_OMIT_UTF16
  106659. u8 encoding;
  106660. /* If opening the main database, set ENC(db). */
  106661. encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
  106662. if( encoding==0 ) encoding = SQLITE_UTF8;
  106663. ENC(db) = encoding;
  106664. #else
  106665. ENC(db) = SQLITE_UTF8;
  106666. #endif
  106667. }else{
  106668. /* If opening an attached database, the encoding much match ENC(db) */
  106669. if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
  106670. sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
  106671. " text encoding as main database");
  106672. rc = SQLITE_ERROR;
  106673. goto initone_error_out;
  106674. }
  106675. }
  106676. }else{
  106677. DbSetProperty(db, iDb, DB_Empty);
  106678. }
  106679. pDb->pSchema->enc = ENC(db);
  106680. if( pDb->pSchema->cache_size==0 ){
  106681. #ifndef SQLITE_OMIT_DEPRECATED
  106682. size = sqlite3AbsInt32(meta[BTREE_DEFAULT_CACHE_SIZE-1]);
  106683. if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
  106684. pDb->pSchema->cache_size = size;
  106685. #else
  106686. pDb->pSchema->cache_size = SQLITE_DEFAULT_CACHE_SIZE;
  106687. #endif
  106688. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  106689. }
  106690. /*
  106691. ** file_format==1 Version 3.0.0.
  106692. ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
  106693. ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
  106694. ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
  106695. */
  106696. pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
  106697. if( pDb->pSchema->file_format==0 ){
  106698. pDb->pSchema->file_format = 1;
  106699. }
  106700. if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
  106701. sqlite3SetString(pzErrMsg, db, "unsupported file format");
  106702. rc = SQLITE_ERROR;
  106703. goto initone_error_out;
  106704. }
  106705. /* Ticket #2804: When we open a database in the newer file format,
  106706. ** clear the legacy_file_format pragma flag so that a VACUUM will
  106707. ** not downgrade the database and thus invalidate any descending
  106708. ** indices that the user might have created.
  106709. */
  106710. if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
  106711. db->flags &= ~SQLITE_LegacyFileFmt;
  106712. }
  106713. /* Read the schema information out of the schema tables
  106714. */
  106715. assert( db->init.busy );
  106716. {
  106717. char *zSql;
  106718. zSql = sqlite3MPrintf(db,
  106719. "SELECT name, rootpage, sql FROM \"%w\".%s ORDER BY rowid",
  106720. db->aDb[iDb].zDbSName, zMasterName);
  106721. #ifndef SQLITE_OMIT_AUTHORIZATION
  106722. {
  106723. sqlite3_xauth xAuth;
  106724. xAuth = db->xAuth;
  106725. db->xAuth = 0;
  106726. #endif
  106727. rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
  106728. #ifndef SQLITE_OMIT_AUTHORIZATION
  106729. db->xAuth = xAuth;
  106730. }
  106731. #endif
  106732. if( rc==SQLITE_OK ) rc = initData.rc;
  106733. sqlite3DbFree(db, zSql);
  106734. #ifndef SQLITE_OMIT_ANALYZE
  106735. if( rc==SQLITE_OK ){
  106736. sqlite3AnalysisLoad(db, iDb);
  106737. }
  106738. #endif
  106739. }
  106740. if( db->mallocFailed ){
  106741. rc = SQLITE_NOMEM_BKPT;
  106742. sqlite3ResetAllSchemasOfConnection(db);
  106743. }
  106744. if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
  106745. /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
  106746. ** the schema loaded, even if errors occurred. In this situation the
  106747. ** current sqlite3_prepare() operation will fail, but the following one
  106748. ** will attempt to compile the supplied statement against whatever subset
  106749. ** of the schema was loaded before the error occurred. The primary
  106750. ** purpose of this is to allow access to the sqlite_master table
  106751. ** even when its contents have been corrupted.
  106752. */
  106753. DbSetProperty(db, iDb, DB_SchemaLoaded);
  106754. rc = SQLITE_OK;
  106755. }
  106756. /* Jump here for an error that occurs after successfully allocating
  106757. ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
  106758. ** before that point, jump to error_out.
  106759. */
  106760. initone_error_out:
  106761. if( openedTransaction ){
  106762. sqlite3BtreeCommit(pDb->pBt);
  106763. }
  106764. sqlite3BtreeLeave(pDb->pBt);
  106765. error_out:
  106766. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  106767. sqlite3OomFault(db);
  106768. }
  106769. return rc;
  106770. }
  106771. /*
  106772. ** Initialize all database files - the main database file, the file
  106773. ** used to store temporary tables, and any additional database files
  106774. ** created using ATTACH statements. Return a success code. If an
  106775. ** error occurs, write an error message into *pzErrMsg.
  106776. **
  106777. ** After a database is initialized, the DB_SchemaLoaded bit is set
  106778. ** bit is set in the flags field of the Db structure. If the database
  106779. ** file was of zero-length, then the DB_Empty flag is also set.
  106780. */
  106781. SQLITE_PRIVATE int sqlite3Init(sqlite3 *db, char **pzErrMsg){
  106782. int i, rc;
  106783. int commit_internal = !(db->flags&SQLITE_InternChanges);
  106784. assert( sqlite3_mutex_held(db->mutex) );
  106785. assert( sqlite3BtreeHoldsMutex(db->aDb[0].pBt) );
  106786. assert( db->init.busy==0 );
  106787. rc = SQLITE_OK;
  106788. db->init.busy = 1;
  106789. ENC(db) = SCHEMA_ENC(db);
  106790. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  106791. if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
  106792. rc = sqlite3InitOne(db, i, pzErrMsg);
  106793. if( rc ){
  106794. sqlite3ResetOneSchema(db, i);
  106795. }
  106796. }
  106797. /* Once all the other databases have been initialized, load the schema
  106798. ** for the TEMP database. This is loaded last, as the TEMP database
  106799. ** schema may contain references to objects in other databases.
  106800. */
  106801. #ifndef SQLITE_OMIT_TEMPDB
  106802. assert( db->nDb>1 );
  106803. if( rc==SQLITE_OK && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
  106804. rc = sqlite3InitOne(db, 1, pzErrMsg);
  106805. if( rc ){
  106806. sqlite3ResetOneSchema(db, 1);
  106807. }
  106808. }
  106809. #endif
  106810. db->init.busy = 0;
  106811. if( rc==SQLITE_OK && commit_internal ){
  106812. sqlite3CommitInternalChanges(db);
  106813. }
  106814. return rc;
  106815. }
  106816. /*
  106817. ** This routine is a no-op if the database schema is already initialized.
  106818. ** Otherwise, the schema is loaded. An error code is returned.
  106819. */
  106820. SQLITE_PRIVATE int sqlite3ReadSchema(Parse *pParse){
  106821. int rc = SQLITE_OK;
  106822. sqlite3 *db = pParse->db;
  106823. assert( sqlite3_mutex_held(db->mutex) );
  106824. if( !db->init.busy ){
  106825. rc = sqlite3Init(db, &pParse->zErrMsg);
  106826. }
  106827. if( rc!=SQLITE_OK ){
  106828. pParse->rc = rc;
  106829. pParse->nErr++;
  106830. }
  106831. return rc;
  106832. }
  106833. /*
  106834. ** Check schema cookies in all databases. If any cookie is out
  106835. ** of date set pParse->rc to SQLITE_SCHEMA. If all schema cookies
  106836. ** make no changes to pParse->rc.
  106837. */
  106838. static void schemaIsValid(Parse *pParse){
  106839. sqlite3 *db = pParse->db;
  106840. int iDb;
  106841. int rc;
  106842. int cookie;
  106843. assert( pParse->checkSchema );
  106844. assert( sqlite3_mutex_held(db->mutex) );
  106845. for(iDb=0; iDb<db->nDb; iDb++){
  106846. int openedTransaction = 0; /* True if a transaction is opened */
  106847. Btree *pBt = db->aDb[iDb].pBt; /* Btree database to read cookie from */
  106848. if( pBt==0 ) continue;
  106849. /* If there is not already a read-only (or read-write) transaction opened
  106850. ** on the b-tree database, open one now. If a transaction is opened, it
  106851. ** will be closed immediately after reading the meta-value. */
  106852. if( !sqlite3BtreeIsInReadTrans(pBt) ){
  106853. rc = sqlite3BtreeBeginTrans(pBt, 0);
  106854. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  106855. sqlite3OomFault(db);
  106856. }
  106857. if( rc!=SQLITE_OK ) return;
  106858. openedTransaction = 1;
  106859. }
  106860. /* Read the schema cookie from the database. If it does not match the
  106861. ** value stored as part of the in-memory schema representation,
  106862. ** set Parse.rc to SQLITE_SCHEMA. */
  106863. sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
  106864. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  106865. if( cookie!=db->aDb[iDb].pSchema->schema_cookie ){
  106866. sqlite3ResetOneSchema(db, iDb);
  106867. pParse->rc = SQLITE_SCHEMA;
  106868. }
  106869. /* Close the transaction, if one was opened. */
  106870. if( openedTransaction ){
  106871. sqlite3BtreeCommit(pBt);
  106872. }
  106873. }
  106874. }
  106875. /*
  106876. ** Convert a schema pointer into the iDb index that indicates
  106877. ** which database file in db->aDb[] the schema refers to.
  106878. **
  106879. ** If the same database is attached more than once, the first
  106880. ** attached database is returned.
  106881. */
  106882. SQLITE_PRIVATE int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
  106883. int i = -1000000;
  106884. /* If pSchema is NULL, then return -1000000. This happens when code in
  106885. ** expr.c is trying to resolve a reference to a transient table (i.e. one
  106886. ** created by a sub-select). In this case the return value of this
  106887. ** function should never be used.
  106888. **
  106889. ** We return -1000000 instead of the more usual -1 simply because using
  106890. ** -1000000 as the incorrect index into db->aDb[] is much
  106891. ** more likely to cause a segfault than -1 (of course there are assert()
  106892. ** statements too, but it never hurts to play the odds).
  106893. */
  106894. assert( sqlite3_mutex_held(db->mutex) );
  106895. if( pSchema ){
  106896. for(i=0; ALWAYS(i<db->nDb); i++){
  106897. if( db->aDb[i].pSchema==pSchema ){
  106898. break;
  106899. }
  106900. }
  106901. assert( i>=0 && i<db->nDb );
  106902. }
  106903. return i;
  106904. }
  106905. /*
  106906. ** Free all memory allocations in the pParse object
  106907. */
  106908. SQLITE_PRIVATE void sqlite3ParserReset(Parse *pParse){
  106909. if( pParse ){
  106910. sqlite3 *db = pParse->db;
  106911. sqlite3DbFree(db, pParse->aLabel);
  106912. sqlite3ExprListDelete(db, pParse->pConstExpr);
  106913. if( db ){
  106914. assert( db->lookaside.bDisable >= pParse->disableLookaside );
  106915. db->lookaside.bDisable -= pParse->disableLookaside;
  106916. }
  106917. pParse->disableLookaside = 0;
  106918. }
  106919. }
  106920. /*
  106921. ** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
  106922. */
  106923. static int sqlite3Prepare(
  106924. sqlite3 *db, /* Database handle. */
  106925. const char *zSql, /* UTF-8 encoded SQL statement. */
  106926. int nBytes, /* Length of zSql in bytes. */
  106927. int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
  106928. Vdbe *pReprepare, /* VM being reprepared */
  106929. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  106930. const char **pzTail /* OUT: End of parsed string */
  106931. ){
  106932. char *zErrMsg = 0; /* Error message */
  106933. int rc = SQLITE_OK; /* Result code */
  106934. int i; /* Loop counter */
  106935. Parse sParse; /* Parsing context */
  106936. memset(&sParse, 0, PARSE_HDR_SZ);
  106937. memset(PARSE_TAIL(&sParse), 0, PARSE_TAIL_SZ);
  106938. sParse.pReprepare = pReprepare;
  106939. assert( ppStmt && *ppStmt==0 );
  106940. /* assert( !db->mallocFailed ); // not true with SQLITE_USE_ALLOCA */
  106941. assert( sqlite3_mutex_held(db->mutex) );
  106942. /* Check to verify that it is possible to get a read lock on all
  106943. ** database schemas. The inability to get a read lock indicates that
  106944. ** some other database connection is holding a write-lock, which in
  106945. ** turn means that the other connection has made uncommitted changes
  106946. ** to the schema.
  106947. **
  106948. ** Were we to proceed and prepare the statement against the uncommitted
  106949. ** schema changes and if those schema changes are subsequently rolled
  106950. ** back and different changes are made in their place, then when this
  106951. ** prepared statement goes to run the schema cookie would fail to detect
  106952. ** the schema change. Disaster would follow.
  106953. **
  106954. ** This thread is currently holding mutexes on all Btrees (because
  106955. ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
  106956. ** is not possible for another thread to start a new schema change
  106957. ** while this routine is running. Hence, we do not need to hold
  106958. ** locks on the schema, we just need to make sure nobody else is
  106959. ** holding them.
  106960. **
  106961. ** Note that setting READ_UNCOMMITTED overrides most lock detection,
  106962. ** but it does *not* override schema lock detection, so this all still
  106963. ** works even if READ_UNCOMMITTED is set.
  106964. */
  106965. for(i=0; i<db->nDb; i++) {
  106966. Btree *pBt = db->aDb[i].pBt;
  106967. if( pBt ){
  106968. assert( sqlite3BtreeHoldsMutex(pBt) );
  106969. rc = sqlite3BtreeSchemaLocked(pBt);
  106970. if( rc ){
  106971. const char *zDb = db->aDb[i].zDbSName;
  106972. sqlite3ErrorWithMsg(db, rc, "database schema is locked: %s", zDb);
  106973. testcase( db->flags & SQLITE_ReadUncommitted );
  106974. goto end_prepare;
  106975. }
  106976. }
  106977. }
  106978. sqlite3VtabUnlockList(db);
  106979. sParse.db = db;
  106980. if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
  106981. char *zSqlCopy;
  106982. int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
  106983. testcase( nBytes==mxLen );
  106984. testcase( nBytes==mxLen+1 );
  106985. if( nBytes>mxLen ){
  106986. sqlite3ErrorWithMsg(db, SQLITE_TOOBIG, "statement too long");
  106987. rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
  106988. goto end_prepare;
  106989. }
  106990. zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
  106991. if( zSqlCopy ){
  106992. sqlite3RunParser(&sParse, zSqlCopy, &zErrMsg);
  106993. sParse.zTail = &zSql[sParse.zTail-zSqlCopy];
  106994. sqlite3DbFree(db, zSqlCopy);
  106995. }else{
  106996. sParse.zTail = &zSql[nBytes];
  106997. }
  106998. }else{
  106999. sqlite3RunParser(&sParse, zSql, &zErrMsg);
  107000. }
  107001. assert( 0==sParse.nQueryLoop );
  107002. if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
  107003. if( sParse.checkSchema ){
  107004. schemaIsValid(&sParse);
  107005. }
  107006. if( db->mallocFailed ){
  107007. sParse.rc = SQLITE_NOMEM_BKPT;
  107008. }
  107009. if( pzTail ){
  107010. *pzTail = sParse.zTail;
  107011. }
  107012. rc = sParse.rc;
  107013. #ifndef SQLITE_OMIT_EXPLAIN
  107014. if( rc==SQLITE_OK && sParse.pVdbe && sParse.explain ){
  107015. static const char * const azColName[] = {
  107016. "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
  107017. "selectid", "order", "from", "detail"
  107018. };
  107019. int iFirst, mx;
  107020. if( sParse.explain==2 ){
  107021. sqlite3VdbeSetNumCols(sParse.pVdbe, 4);
  107022. iFirst = 8;
  107023. mx = 12;
  107024. }else{
  107025. sqlite3VdbeSetNumCols(sParse.pVdbe, 8);
  107026. iFirst = 0;
  107027. mx = 8;
  107028. }
  107029. for(i=iFirst; i<mx; i++){
  107030. sqlite3VdbeSetColName(sParse.pVdbe, i-iFirst, COLNAME_NAME,
  107031. azColName[i], SQLITE_STATIC);
  107032. }
  107033. }
  107034. #endif
  107035. if( db->init.busy==0 ){
  107036. Vdbe *pVdbe = sParse.pVdbe;
  107037. sqlite3VdbeSetSql(pVdbe, zSql, (int)(sParse.zTail-zSql), saveSqlFlag);
  107038. }
  107039. if( sParse.pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
  107040. sqlite3VdbeFinalize(sParse.pVdbe);
  107041. assert(!(*ppStmt));
  107042. }else{
  107043. *ppStmt = (sqlite3_stmt*)sParse.pVdbe;
  107044. }
  107045. if( zErrMsg ){
  107046. sqlite3ErrorWithMsg(db, rc, "%s", zErrMsg);
  107047. sqlite3DbFree(db, zErrMsg);
  107048. }else{
  107049. sqlite3Error(db, rc);
  107050. }
  107051. /* Delete any TriggerPrg structures allocated while parsing this statement. */
  107052. while( sParse.pTriggerPrg ){
  107053. TriggerPrg *pT = sParse.pTriggerPrg;
  107054. sParse.pTriggerPrg = pT->pNext;
  107055. sqlite3DbFree(db, pT);
  107056. }
  107057. end_prepare:
  107058. sqlite3ParserReset(&sParse);
  107059. rc = sqlite3ApiExit(db, rc);
  107060. assert( (rc&db->errMask)==rc );
  107061. return rc;
  107062. }
  107063. static int sqlite3LockAndPrepare(
  107064. sqlite3 *db, /* Database handle. */
  107065. const char *zSql, /* UTF-8 encoded SQL statement. */
  107066. int nBytes, /* Length of zSql in bytes. */
  107067. int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
  107068. Vdbe *pOld, /* VM being reprepared */
  107069. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107070. const char **pzTail /* OUT: End of parsed string */
  107071. ){
  107072. int rc;
  107073. #ifdef SQLITE_ENABLE_API_ARMOR
  107074. if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
  107075. #endif
  107076. *ppStmt = 0;
  107077. if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
  107078. return SQLITE_MISUSE_BKPT;
  107079. }
  107080. sqlite3_mutex_enter(db->mutex);
  107081. sqlite3BtreeEnterAll(db);
  107082. rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
  107083. if( rc==SQLITE_SCHEMA ){
  107084. sqlite3_finalize(*ppStmt);
  107085. rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
  107086. }
  107087. sqlite3BtreeLeaveAll(db);
  107088. sqlite3_mutex_leave(db->mutex);
  107089. assert( rc==SQLITE_OK || *ppStmt==0 );
  107090. return rc;
  107091. }
  107092. /*
  107093. ** Rerun the compilation of a statement after a schema change.
  107094. **
  107095. ** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
  107096. ** if the statement cannot be recompiled because another connection has
  107097. ** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
  107098. ** occurs, return SQLITE_SCHEMA.
  107099. */
  107100. SQLITE_PRIVATE int sqlite3Reprepare(Vdbe *p){
  107101. int rc;
  107102. sqlite3_stmt *pNew;
  107103. const char *zSql;
  107104. sqlite3 *db;
  107105. assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
  107106. zSql = sqlite3_sql((sqlite3_stmt *)p);
  107107. assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
  107108. db = sqlite3VdbeDb(p);
  107109. assert( sqlite3_mutex_held(db->mutex) );
  107110. rc = sqlite3LockAndPrepare(db, zSql, -1, 0, p, &pNew, 0);
  107111. if( rc ){
  107112. if( rc==SQLITE_NOMEM ){
  107113. sqlite3OomFault(db);
  107114. }
  107115. assert( pNew==0 );
  107116. return rc;
  107117. }else{
  107118. assert( pNew!=0 );
  107119. }
  107120. sqlite3VdbeSwap((Vdbe*)pNew, p);
  107121. sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
  107122. sqlite3VdbeResetStepResult((Vdbe*)pNew);
  107123. sqlite3VdbeFinalize((Vdbe*)pNew);
  107124. return SQLITE_OK;
  107125. }
  107126. /*
  107127. ** Two versions of the official API. Legacy and new use. In the legacy
  107128. ** version, the original SQL text is not saved in the prepared statement
  107129. ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
  107130. ** sqlite3_step(). In the new version, the original SQL text is retained
  107131. ** and the statement is automatically recompiled if an schema change
  107132. ** occurs.
  107133. */
  107134. SQLITE_API int sqlite3_prepare(
  107135. sqlite3 *db, /* Database handle. */
  107136. const char *zSql, /* UTF-8 encoded SQL statement. */
  107137. int nBytes, /* Length of zSql in bytes. */
  107138. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107139. const char **pzTail /* OUT: End of parsed string */
  107140. ){
  107141. int rc;
  107142. rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,0,ppStmt,pzTail);
  107143. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  107144. return rc;
  107145. }
  107146. SQLITE_API int sqlite3_prepare_v2(
  107147. sqlite3 *db, /* Database handle. */
  107148. const char *zSql, /* UTF-8 encoded SQL statement. */
  107149. int nBytes, /* Length of zSql in bytes. */
  107150. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107151. const char **pzTail /* OUT: End of parsed string */
  107152. ){
  107153. int rc;
  107154. rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,0,ppStmt,pzTail);
  107155. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  107156. return rc;
  107157. }
  107158. #ifndef SQLITE_OMIT_UTF16
  107159. /*
  107160. ** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
  107161. */
  107162. static int sqlite3Prepare16(
  107163. sqlite3 *db, /* Database handle. */
  107164. const void *zSql, /* UTF-16 encoded SQL statement. */
  107165. int nBytes, /* Length of zSql in bytes. */
  107166. int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
  107167. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107168. const void **pzTail /* OUT: End of parsed string */
  107169. ){
  107170. /* This function currently works by first transforming the UTF-16
  107171. ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
  107172. ** tricky bit is figuring out the pointer to return in *pzTail.
  107173. */
  107174. char *zSql8;
  107175. const char *zTail8 = 0;
  107176. int rc = SQLITE_OK;
  107177. #ifdef SQLITE_ENABLE_API_ARMOR
  107178. if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
  107179. #endif
  107180. *ppStmt = 0;
  107181. if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
  107182. return SQLITE_MISUSE_BKPT;
  107183. }
  107184. if( nBytes>=0 ){
  107185. int sz;
  107186. const char *z = (const char*)zSql;
  107187. for(sz=0; sz<nBytes && (z[sz]!=0 || z[sz+1]!=0); sz += 2){}
  107188. nBytes = sz;
  107189. }
  107190. sqlite3_mutex_enter(db->mutex);
  107191. zSql8 = sqlite3Utf16to8(db, zSql, nBytes, SQLITE_UTF16NATIVE);
  107192. if( zSql8 ){
  107193. rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, 0, ppStmt, &zTail8);
  107194. }
  107195. if( zTail8 && pzTail ){
  107196. /* If sqlite3_prepare returns a tail pointer, we calculate the
  107197. ** equivalent pointer into the UTF-16 string by counting the unicode
  107198. ** characters between zSql8 and zTail8, and then returning a pointer
  107199. ** the same number of characters into the UTF-16 string.
  107200. */
  107201. int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
  107202. *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
  107203. }
  107204. sqlite3DbFree(db, zSql8);
  107205. rc = sqlite3ApiExit(db, rc);
  107206. sqlite3_mutex_leave(db->mutex);
  107207. return rc;
  107208. }
  107209. /*
  107210. ** Two versions of the official API. Legacy and new use. In the legacy
  107211. ** version, the original SQL text is not saved in the prepared statement
  107212. ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
  107213. ** sqlite3_step(). In the new version, the original SQL text is retained
  107214. ** and the statement is automatically recompiled if an schema change
  107215. ** occurs.
  107216. */
  107217. SQLITE_API int sqlite3_prepare16(
  107218. sqlite3 *db, /* Database handle. */
  107219. const void *zSql, /* UTF-16 encoded SQL statement. */
  107220. int nBytes, /* Length of zSql in bytes. */
  107221. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107222. const void **pzTail /* OUT: End of parsed string */
  107223. ){
  107224. int rc;
  107225. rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
  107226. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  107227. return rc;
  107228. }
  107229. SQLITE_API int sqlite3_prepare16_v2(
  107230. sqlite3 *db, /* Database handle. */
  107231. const void *zSql, /* UTF-16 encoded SQL statement. */
  107232. int nBytes, /* Length of zSql in bytes. */
  107233. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  107234. const void **pzTail /* OUT: End of parsed string */
  107235. ){
  107236. int rc;
  107237. rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
  107238. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  107239. return rc;
  107240. }
  107241. #endif /* SQLITE_OMIT_UTF16 */
  107242. /************** End of prepare.c *********************************************/
  107243. /************** Begin file select.c ******************************************/
  107244. /*
  107245. ** 2001 September 15
  107246. **
  107247. ** The author disclaims copyright to this source code. In place of
  107248. ** a legal notice, here is a blessing:
  107249. **
  107250. ** May you do good and not evil.
  107251. ** May you find forgiveness for yourself and forgive others.
  107252. ** May you share freely, never taking more than you give.
  107253. **
  107254. *************************************************************************
  107255. ** This file contains C code routines that are called by the parser
  107256. ** to handle SELECT statements in SQLite.
  107257. */
  107258. /* #include "sqliteInt.h" */
  107259. /*
  107260. ** Trace output macros
  107261. */
  107262. #if SELECTTRACE_ENABLED
  107263. /***/ int sqlite3SelectTrace = 0;
  107264. # define SELECTTRACE(K,P,S,X) \
  107265. if(sqlite3SelectTrace&(K)) \
  107266. sqlite3DebugPrintf("%*s%s.%p: ",(P)->nSelectIndent*2-2,"",\
  107267. (S)->zSelName,(S)),\
  107268. sqlite3DebugPrintf X
  107269. #else
  107270. # define SELECTTRACE(K,P,S,X)
  107271. #endif
  107272. /*
  107273. ** An instance of the following object is used to record information about
  107274. ** how to process the DISTINCT keyword, to simplify passing that information
  107275. ** into the selectInnerLoop() routine.
  107276. */
  107277. typedef struct DistinctCtx DistinctCtx;
  107278. struct DistinctCtx {
  107279. u8 isTnct; /* True if the DISTINCT keyword is present */
  107280. u8 eTnctType; /* One of the WHERE_DISTINCT_* operators */
  107281. int tabTnct; /* Ephemeral table used for DISTINCT processing */
  107282. int addrTnct; /* Address of OP_OpenEphemeral opcode for tabTnct */
  107283. };
  107284. /*
  107285. ** An instance of the following object is used to record information about
  107286. ** the ORDER BY (or GROUP BY) clause of query is being coded.
  107287. */
  107288. typedef struct SortCtx SortCtx;
  107289. struct SortCtx {
  107290. ExprList *pOrderBy; /* The ORDER BY (or GROUP BY clause) */
  107291. int nOBSat; /* Number of ORDER BY terms satisfied by indices */
  107292. int iECursor; /* Cursor number for the sorter */
  107293. int regReturn; /* Register holding block-output return address */
  107294. int labelBkOut; /* Start label for the block-output subroutine */
  107295. int addrSortIndex; /* Address of the OP_SorterOpen or OP_OpenEphemeral */
  107296. int labelDone; /* Jump here when done, ex: LIMIT reached */
  107297. u8 sortFlags; /* Zero or more SORTFLAG_* bits */
  107298. u8 bOrderedInnerLoop; /* ORDER BY correctly sorts the inner loop */
  107299. };
  107300. #define SORTFLAG_UseSorter 0x01 /* Use SorterOpen instead of OpenEphemeral */
  107301. /*
  107302. ** Delete all the content of a Select structure. Deallocate the structure
  107303. ** itself only if bFree is true.
  107304. */
  107305. static void clearSelect(sqlite3 *db, Select *p, int bFree){
  107306. while( p ){
  107307. Select *pPrior = p->pPrior;
  107308. sqlite3ExprListDelete(db, p->pEList);
  107309. sqlite3SrcListDelete(db, p->pSrc);
  107310. sqlite3ExprDelete(db, p->pWhere);
  107311. sqlite3ExprListDelete(db, p->pGroupBy);
  107312. sqlite3ExprDelete(db, p->pHaving);
  107313. sqlite3ExprListDelete(db, p->pOrderBy);
  107314. sqlite3ExprDelete(db, p->pLimit);
  107315. sqlite3ExprDelete(db, p->pOffset);
  107316. if( p->pWith ) sqlite3WithDelete(db, p->pWith);
  107317. if( bFree ) sqlite3DbFree(db, p);
  107318. p = pPrior;
  107319. bFree = 1;
  107320. }
  107321. }
  107322. /*
  107323. ** Initialize a SelectDest structure.
  107324. */
  107325. SQLITE_PRIVATE void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
  107326. pDest->eDest = (u8)eDest;
  107327. pDest->iSDParm = iParm;
  107328. pDest->zAffSdst = 0;
  107329. pDest->iSdst = 0;
  107330. pDest->nSdst = 0;
  107331. }
  107332. /*
  107333. ** Allocate a new Select structure and return a pointer to that
  107334. ** structure.
  107335. */
  107336. SQLITE_PRIVATE Select *sqlite3SelectNew(
  107337. Parse *pParse, /* Parsing context */
  107338. ExprList *pEList, /* which columns to include in the result */
  107339. SrcList *pSrc, /* the FROM clause -- which tables to scan */
  107340. Expr *pWhere, /* the WHERE clause */
  107341. ExprList *pGroupBy, /* the GROUP BY clause */
  107342. Expr *pHaving, /* the HAVING clause */
  107343. ExprList *pOrderBy, /* the ORDER BY clause */
  107344. u32 selFlags, /* Flag parameters, such as SF_Distinct */
  107345. Expr *pLimit, /* LIMIT value. NULL means not used */
  107346. Expr *pOffset /* OFFSET value. NULL means no offset */
  107347. ){
  107348. Select *pNew;
  107349. Select standin;
  107350. sqlite3 *db = pParse->db;
  107351. pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
  107352. if( pNew==0 ){
  107353. assert( db->mallocFailed );
  107354. pNew = &standin;
  107355. }
  107356. if( pEList==0 ){
  107357. pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db,TK_ASTERISK,0));
  107358. }
  107359. pNew->pEList = pEList;
  107360. pNew->op = TK_SELECT;
  107361. pNew->selFlags = selFlags;
  107362. pNew->iLimit = 0;
  107363. pNew->iOffset = 0;
  107364. #if SELECTTRACE_ENABLED
  107365. pNew->zSelName[0] = 0;
  107366. #endif
  107367. pNew->addrOpenEphm[0] = -1;
  107368. pNew->addrOpenEphm[1] = -1;
  107369. pNew->nSelectRow = 0;
  107370. if( pSrc==0 ) pSrc = sqlite3DbMallocZero(db, sizeof(*pSrc));
  107371. pNew->pSrc = pSrc;
  107372. pNew->pWhere = pWhere;
  107373. pNew->pGroupBy = pGroupBy;
  107374. pNew->pHaving = pHaving;
  107375. pNew->pOrderBy = pOrderBy;
  107376. pNew->pPrior = 0;
  107377. pNew->pNext = 0;
  107378. pNew->pLimit = pLimit;
  107379. pNew->pOffset = pOffset;
  107380. pNew->pWith = 0;
  107381. assert( pOffset==0 || pLimit!=0 || pParse->nErr>0 || db->mallocFailed!=0 );
  107382. if( db->mallocFailed ) {
  107383. clearSelect(db, pNew, pNew!=&standin);
  107384. pNew = 0;
  107385. }else{
  107386. assert( pNew->pSrc!=0 || pParse->nErr>0 );
  107387. }
  107388. assert( pNew!=&standin );
  107389. return pNew;
  107390. }
  107391. #if SELECTTRACE_ENABLED
  107392. /*
  107393. ** Set the name of a Select object
  107394. */
  107395. SQLITE_PRIVATE void sqlite3SelectSetName(Select *p, const char *zName){
  107396. if( p && zName ){
  107397. sqlite3_snprintf(sizeof(p->zSelName), p->zSelName, "%s", zName);
  107398. }
  107399. }
  107400. #endif
  107401. /*
  107402. ** Delete the given Select structure and all of its substructures.
  107403. */
  107404. SQLITE_PRIVATE void sqlite3SelectDelete(sqlite3 *db, Select *p){
  107405. if( p ) clearSelect(db, p, 1);
  107406. }
  107407. /*
  107408. ** Return a pointer to the right-most SELECT statement in a compound.
  107409. */
  107410. static Select *findRightmost(Select *p){
  107411. while( p->pNext ) p = p->pNext;
  107412. return p;
  107413. }
  107414. /*
  107415. ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
  107416. ** type of join. Return an integer constant that expresses that type
  107417. ** in terms of the following bit values:
  107418. **
  107419. ** JT_INNER
  107420. ** JT_CROSS
  107421. ** JT_OUTER
  107422. ** JT_NATURAL
  107423. ** JT_LEFT
  107424. ** JT_RIGHT
  107425. **
  107426. ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
  107427. **
  107428. ** If an illegal or unsupported join type is seen, then still return
  107429. ** a join type, but put an error in the pParse structure.
  107430. */
  107431. SQLITE_PRIVATE int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
  107432. int jointype = 0;
  107433. Token *apAll[3];
  107434. Token *p;
  107435. /* 0123456789 123456789 123456789 123 */
  107436. static const char zKeyText[] = "naturaleftouterightfullinnercross";
  107437. static const struct {
  107438. u8 i; /* Beginning of keyword text in zKeyText[] */
  107439. u8 nChar; /* Length of the keyword in characters */
  107440. u8 code; /* Join type mask */
  107441. } aKeyword[] = {
  107442. /* natural */ { 0, 7, JT_NATURAL },
  107443. /* left */ { 6, 4, JT_LEFT|JT_OUTER },
  107444. /* outer */ { 10, 5, JT_OUTER },
  107445. /* right */ { 14, 5, JT_RIGHT|JT_OUTER },
  107446. /* full */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
  107447. /* inner */ { 23, 5, JT_INNER },
  107448. /* cross */ { 28, 5, JT_INNER|JT_CROSS },
  107449. };
  107450. int i, j;
  107451. apAll[0] = pA;
  107452. apAll[1] = pB;
  107453. apAll[2] = pC;
  107454. for(i=0; i<3 && apAll[i]; i++){
  107455. p = apAll[i];
  107456. for(j=0; j<ArraySize(aKeyword); j++){
  107457. if( p->n==aKeyword[j].nChar
  107458. && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
  107459. jointype |= aKeyword[j].code;
  107460. break;
  107461. }
  107462. }
  107463. testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
  107464. if( j>=ArraySize(aKeyword) ){
  107465. jointype |= JT_ERROR;
  107466. break;
  107467. }
  107468. }
  107469. if(
  107470. (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
  107471. (jointype & JT_ERROR)!=0
  107472. ){
  107473. const char *zSp = " ";
  107474. assert( pB!=0 );
  107475. if( pC==0 ){ zSp++; }
  107476. sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
  107477. "%T %T%s%T", pA, pB, zSp, pC);
  107478. jointype = JT_INNER;
  107479. }else if( (jointype & JT_OUTER)!=0
  107480. && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
  107481. sqlite3ErrorMsg(pParse,
  107482. "RIGHT and FULL OUTER JOINs are not currently supported");
  107483. jointype = JT_INNER;
  107484. }
  107485. return jointype;
  107486. }
  107487. /*
  107488. ** Return the index of a column in a table. Return -1 if the column
  107489. ** is not contained in the table.
  107490. */
  107491. static int columnIndex(Table *pTab, const char *zCol){
  107492. int i;
  107493. for(i=0; i<pTab->nCol; i++){
  107494. if( sqlite3StrICmp(pTab->aCol[i].zName, zCol)==0 ) return i;
  107495. }
  107496. return -1;
  107497. }
  107498. /*
  107499. ** Search the first N tables in pSrc, from left to right, looking for a
  107500. ** table that has a column named zCol.
  107501. **
  107502. ** When found, set *piTab and *piCol to the table index and column index
  107503. ** of the matching column and return TRUE.
  107504. **
  107505. ** If not found, return FALSE.
  107506. */
  107507. static int tableAndColumnIndex(
  107508. SrcList *pSrc, /* Array of tables to search */
  107509. int N, /* Number of tables in pSrc->a[] to search */
  107510. const char *zCol, /* Name of the column we are looking for */
  107511. int *piTab, /* Write index of pSrc->a[] here */
  107512. int *piCol /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
  107513. ){
  107514. int i; /* For looping over tables in pSrc */
  107515. int iCol; /* Index of column matching zCol */
  107516. assert( (piTab==0)==(piCol==0) ); /* Both or neither are NULL */
  107517. for(i=0; i<N; i++){
  107518. iCol = columnIndex(pSrc->a[i].pTab, zCol);
  107519. if( iCol>=0 ){
  107520. if( piTab ){
  107521. *piTab = i;
  107522. *piCol = iCol;
  107523. }
  107524. return 1;
  107525. }
  107526. }
  107527. return 0;
  107528. }
  107529. /*
  107530. ** This function is used to add terms implied by JOIN syntax to the
  107531. ** WHERE clause expression of a SELECT statement. The new term, which
  107532. ** is ANDed with the existing WHERE clause, is of the form:
  107533. **
  107534. ** (tab1.col1 = tab2.col2)
  107535. **
  107536. ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
  107537. ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
  107538. ** column iColRight of tab2.
  107539. */
  107540. static void addWhereTerm(
  107541. Parse *pParse, /* Parsing context */
  107542. SrcList *pSrc, /* List of tables in FROM clause */
  107543. int iLeft, /* Index of first table to join in pSrc */
  107544. int iColLeft, /* Index of column in first table */
  107545. int iRight, /* Index of second table in pSrc */
  107546. int iColRight, /* Index of column in second table */
  107547. int isOuterJoin, /* True if this is an OUTER join */
  107548. Expr **ppWhere /* IN/OUT: The WHERE clause to add to */
  107549. ){
  107550. sqlite3 *db = pParse->db;
  107551. Expr *pE1;
  107552. Expr *pE2;
  107553. Expr *pEq;
  107554. assert( iLeft<iRight );
  107555. assert( pSrc->nSrc>iRight );
  107556. assert( pSrc->a[iLeft].pTab );
  107557. assert( pSrc->a[iRight].pTab );
  107558. pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
  107559. pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
  107560. pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2, 0);
  107561. if( pEq && isOuterJoin ){
  107562. ExprSetProperty(pEq, EP_FromJoin);
  107563. assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
  107564. ExprSetVVAProperty(pEq, EP_NoReduce);
  107565. pEq->iRightJoinTable = (i16)pE2->iTable;
  107566. }
  107567. *ppWhere = sqlite3ExprAnd(db, *ppWhere, pEq);
  107568. }
  107569. /*
  107570. ** Set the EP_FromJoin property on all terms of the given expression.
  107571. ** And set the Expr.iRightJoinTable to iTable for every term in the
  107572. ** expression.
  107573. **
  107574. ** The EP_FromJoin property is used on terms of an expression to tell
  107575. ** the LEFT OUTER JOIN processing logic that this term is part of the
  107576. ** join restriction specified in the ON or USING clause and not a part
  107577. ** of the more general WHERE clause. These terms are moved over to the
  107578. ** WHERE clause during join processing but we need to remember that they
  107579. ** originated in the ON or USING clause.
  107580. **
  107581. ** The Expr.iRightJoinTable tells the WHERE clause processing that the
  107582. ** expression depends on table iRightJoinTable even if that table is not
  107583. ** explicitly mentioned in the expression. That information is needed
  107584. ** for cases like this:
  107585. **
  107586. ** SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
  107587. **
  107588. ** The where clause needs to defer the handling of the t1.x=5
  107589. ** term until after the t2 loop of the join. In that way, a
  107590. ** NULL t2 row will be inserted whenever t1.x!=5. If we do not
  107591. ** defer the handling of t1.x=5, it will be processed immediately
  107592. ** after the t1 loop and rows with t1.x!=5 will never appear in
  107593. ** the output, which is incorrect.
  107594. */
  107595. static void setJoinExpr(Expr *p, int iTable){
  107596. while( p ){
  107597. ExprSetProperty(p, EP_FromJoin);
  107598. assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
  107599. ExprSetVVAProperty(p, EP_NoReduce);
  107600. p->iRightJoinTable = (i16)iTable;
  107601. if( p->op==TK_FUNCTION && p->x.pList ){
  107602. int i;
  107603. for(i=0; i<p->x.pList->nExpr; i++){
  107604. setJoinExpr(p->x.pList->a[i].pExpr, iTable);
  107605. }
  107606. }
  107607. setJoinExpr(p->pLeft, iTable);
  107608. p = p->pRight;
  107609. }
  107610. }
  107611. /*
  107612. ** This routine processes the join information for a SELECT statement.
  107613. ** ON and USING clauses are converted into extra terms of the WHERE clause.
  107614. ** NATURAL joins also create extra WHERE clause terms.
  107615. **
  107616. ** The terms of a FROM clause are contained in the Select.pSrc structure.
  107617. ** The left most table is the first entry in Select.pSrc. The right-most
  107618. ** table is the last entry. The join operator is held in the entry to
  107619. ** the left. Thus entry 0 contains the join operator for the join between
  107620. ** entries 0 and 1. Any ON or USING clauses associated with the join are
  107621. ** also attached to the left entry.
  107622. **
  107623. ** This routine returns the number of errors encountered.
  107624. */
  107625. static int sqliteProcessJoin(Parse *pParse, Select *p){
  107626. SrcList *pSrc; /* All tables in the FROM clause */
  107627. int i, j; /* Loop counters */
  107628. struct SrcList_item *pLeft; /* Left table being joined */
  107629. struct SrcList_item *pRight; /* Right table being joined */
  107630. pSrc = p->pSrc;
  107631. pLeft = &pSrc->a[0];
  107632. pRight = &pLeft[1];
  107633. for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
  107634. Table *pLeftTab = pLeft->pTab;
  107635. Table *pRightTab = pRight->pTab;
  107636. int isOuter;
  107637. if( NEVER(pLeftTab==0 || pRightTab==0) ) continue;
  107638. isOuter = (pRight->fg.jointype & JT_OUTER)!=0;
  107639. /* When the NATURAL keyword is present, add WHERE clause terms for
  107640. ** every column that the two tables have in common.
  107641. */
  107642. if( pRight->fg.jointype & JT_NATURAL ){
  107643. if( pRight->pOn || pRight->pUsing ){
  107644. sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
  107645. "an ON or USING clause", 0);
  107646. return 1;
  107647. }
  107648. for(j=0; j<pRightTab->nCol; j++){
  107649. char *zName; /* Name of column in the right table */
  107650. int iLeft; /* Matching left table */
  107651. int iLeftCol; /* Matching column in the left table */
  107652. zName = pRightTab->aCol[j].zName;
  107653. if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol) ){
  107654. addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
  107655. isOuter, &p->pWhere);
  107656. }
  107657. }
  107658. }
  107659. /* Disallow both ON and USING clauses in the same join
  107660. */
  107661. if( pRight->pOn && pRight->pUsing ){
  107662. sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
  107663. "clauses in the same join");
  107664. return 1;
  107665. }
  107666. /* Add the ON clause to the end of the WHERE clause, connected by
  107667. ** an AND operator.
  107668. */
  107669. if( pRight->pOn ){
  107670. if( isOuter ) setJoinExpr(pRight->pOn, pRight->iCursor);
  107671. p->pWhere = sqlite3ExprAnd(pParse->db, p->pWhere, pRight->pOn);
  107672. pRight->pOn = 0;
  107673. }
  107674. /* Create extra terms on the WHERE clause for each column named
  107675. ** in the USING clause. Example: If the two tables to be joined are
  107676. ** A and B and the USING clause names X, Y, and Z, then add this
  107677. ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
  107678. ** Report an error if any column mentioned in the USING clause is
  107679. ** not contained in both tables to be joined.
  107680. */
  107681. if( pRight->pUsing ){
  107682. IdList *pList = pRight->pUsing;
  107683. for(j=0; j<pList->nId; j++){
  107684. char *zName; /* Name of the term in the USING clause */
  107685. int iLeft; /* Table on the left with matching column name */
  107686. int iLeftCol; /* Column number of matching column on the left */
  107687. int iRightCol; /* Column number of matching column on the right */
  107688. zName = pList->a[j].zName;
  107689. iRightCol = columnIndex(pRightTab, zName);
  107690. if( iRightCol<0
  107691. || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol)
  107692. ){
  107693. sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
  107694. "not present in both tables", zName);
  107695. return 1;
  107696. }
  107697. addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
  107698. isOuter, &p->pWhere);
  107699. }
  107700. }
  107701. }
  107702. return 0;
  107703. }
  107704. /* Forward reference */
  107705. static KeyInfo *keyInfoFromExprList(
  107706. Parse *pParse, /* Parsing context */
  107707. ExprList *pList, /* Form the KeyInfo object from this ExprList */
  107708. int iStart, /* Begin with this column of pList */
  107709. int nExtra /* Add this many extra columns to the end */
  107710. );
  107711. /*
  107712. ** Generate code that will push the record in registers regData
  107713. ** through regData+nData-1 onto the sorter.
  107714. */
  107715. static void pushOntoSorter(
  107716. Parse *pParse, /* Parser context */
  107717. SortCtx *pSort, /* Information about the ORDER BY clause */
  107718. Select *pSelect, /* The whole SELECT statement */
  107719. int regData, /* First register holding data to be sorted */
  107720. int regOrigData, /* First register holding data before packing */
  107721. int nData, /* Number of elements in the data array */
  107722. int nPrefixReg /* No. of reg prior to regData available for use */
  107723. ){
  107724. Vdbe *v = pParse->pVdbe; /* Stmt under construction */
  107725. int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
  107726. int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
  107727. int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
  107728. int regBase; /* Regs for sorter record */
  107729. int regRecord = ++pParse->nMem; /* Assembled sorter record */
  107730. int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
  107731. int op; /* Opcode to add sorter record to sorter */
  107732. int iLimit; /* LIMIT counter */
  107733. assert( bSeq==0 || bSeq==1 );
  107734. assert( nData==1 || regData==regOrigData );
  107735. if( nPrefixReg ){
  107736. assert( nPrefixReg==nExpr+bSeq );
  107737. regBase = regData - nExpr - bSeq;
  107738. }else{
  107739. regBase = pParse->nMem + 1;
  107740. pParse->nMem += nBase;
  107741. }
  107742. assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
  107743. iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
  107744. pSort->labelDone = sqlite3VdbeMakeLabel(v);
  107745. sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
  107746. SQLITE_ECEL_DUP|SQLITE_ECEL_REF);
  107747. if( bSeq ){
  107748. sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
  107749. }
  107750. if( nPrefixReg==0 ){
  107751. sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
  107752. }
  107753. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regRecord);
  107754. if( nOBSat>0 ){
  107755. int regPrevKey; /* The first nOBSat columns of the previous row */
  107756. int addrFirst; /* Address of the OP_IfNot opcode */
  107757. int addrJmp; /* Address of the OP_Jump opcode */
  107758. VdbeOp *pOp; /* Opcode that opens the sorter */
  107759. int nKey; /* Number of sorting key columns, including OP_Sequence */
  107760. KeyInfo *pKI; /* Original KeyInfo on the sorter table */
  107761. regPrevKey = pParse->nMem+1;
  107762. pParse->nMem += pSort->nOBSat;
  107763. nKey = nExpr - pSort->nOBSat + bSeq;
  107764. if( bSeq ){
  107765. addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
  107766. }else{
  107767. addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
  107768. }
  107769. VdbeCoverage(v);
  107770. sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
  107771. pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
  107772. if( pParse->db->mallocFailed ) return;
  107773. pOp->p2 = nKey + nData;
  107774. pKI = pOp->p4.pKeyInfo;
  107775. memset(pKI->aSortOrder, 0, pKI->nField); /* Makes OP_Jump below testable */
  107776. sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
  107777. testcase( pKI->nXField>2 );
  107778. pOp->p4.pKeyInfo = keyInfoFromExprList(pParse, pSort->pOrderBy, nOBSat,
  107779. pKI->nXField-1);
  107780. addrJmp = sqlite3VdbeCurrentAddr(v);
  107781. sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
  107782. pSort->labelBkOut = sqlite3VdbeMakeLabel(v);
  107783. pSort->regReturn = ++pParse->nMem;
  107784. sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
  107785. sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
  107786. if( iLimit ){
  107787. sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
  107788. VdbeCoverage(v);
  107789. }
  107790. sqlite3VdbeJumpHere(v, addrFirst);
  107791. sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
  107792. sqlite3VdbeJumpHere(v, addrJmp);
  107793. }
  107794. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  107795. op = OP_SorterInsert;
  107796. }else{
  107797. op = OP_IdxInsert;
  107798. }
  107799. sqlite3VdbeAddOp2(v, op, pSort->iECursor, regRecord);
  107800. if( iLimit ){
  107801. int addr;
  107802. int r1 = 0;
  107803. /* Fill the sorter until it contains LIMIT+OFFSET entries. (The iLimit
  107804. ** register is initialized with value of LIMIT+OFFSET.) After the sorter
  107805. ** fills up, delete the least entry in the sorter after each insert.
  107806. ** Thus we never hold more than the LIMIT+OFFSET rows in memory at once */
  107807. addr = sqlite3VdbeAddOp3(v, OP_IfNotZero, iLimit, 0, 1); VdbeCoverage(v);
  107808. sqlite3VdbeAddOp1(v, OP_Last, pSort->iECursor);
  107809. if( pSort->bOrderedInnerLoop ){
  107810. r1 = ++pParse->nMem;
  107811. sqlite3VdbeAddOp3(v, OP_Column, pSort->iECursor, nExpr, r1);
  107812. VdbeComment((v, "seq"));
  107813. }
  107814. sqlite3VdbeAddOp1(v, OP_Delete, pSort->iECursor);
  107815. if( pSort->bOrderedInnerLoop ){
  107816. /* If the inner loop is driven by an index such that values from
  107817. ** the same iteration of the inner loop are in sorted order, then
  107818. ** immediately jump to the next iteration of an inner loop if the
  107819. ** entry from the current iteration does not fit into the top
  107820. ** LIMIT+OFFSET entries of the sorter. */
  107821. int iBrk = sqlite3VdbeCurrentAddr(v) + 2;
  107822. sqlite3VdbeAddOp3(v, OP_Eq, regBase+nExpr, iBrk, r1);
  107823. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  107824. VdbeCoverage(v);
  107825. }
  107826. sqlite3VdbeJumpHere(v, addr);
  107827. }
  107828. }
  107829. /*
  107830. ** Add code to implement the OFFSET
  107831. */
  107832. static void codeOffset(
  107833. Vdbe *v, /* Generate code into this VM */
  107834. int iOffset, /* Register holding the offset counter */
  107835. int iContinue /* Jump here to skip the current record */
  107836. ){
  107837. if( iOffset>0 ){
  107838. sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
  107839. VdbeComment((v, "OFFSET"));
  107840. }
  107841. }
  107842. /*
  107843. ** Add code that will check to make sure the N registers starting at iMem
  107844. ** form a distinct entry. iTab is a sorting index that holds previously
  107845. ** seen combinations of the N values. A new entry is made in iTab
  107846. ** if the current N values are new.
  107847. **
  107848. ** A jump to addrRepeat is made and the N+1 values are popped from the
  107849. ** stack if the top N elements are not distinct.
  107850. */
  107851. static void codeDistinct(
  107852. Parse *pParse, /* Parsing and code generating context */
  107853. int iTab, /* A sorting index used to test for distinctness */
  107854. int addrRepeat, /* Jump to here if not distinct */
  107855. int N, /* Number of elements */
  107856. int iMem /* First element */
  107857. ){
  107858. Vdbe *v;
  107859. int r1;
  107860. v = pParse->pVdbe;
  107861. r1 = sqlite3GetTempReg(pParse);
  107862. sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, iMem, N); VdbeCoverage(v);
  107863. sqlite3VdbeAddOp3(v, OP_MakeRecord, iMem, N, r1);
  107864. sqlite3VdbeAddOp2(v, OP_IdxInsert, iTab, r1);
  107865. sqlite3ReleaseTempReg(pParse, r1);
  107866. }
  107867. /*
  107868. ** This routine generates the code for the inside of the inner loop
  107869. ** of a SELECT.
  107870. **
  107871. ** If srcTab is negative, then the pEList expressions
  107872. ** are evaluated in order to get the data for this row. If srcTab is
  107873. ** zero or more, then data is pulled from srcTab and pEList is used only
  107874. ** to get number columns and the datatype for each column.
  107875. */
  107876. static void selectInnerLoop(
  107877. Parse *pParse, /* The parser context */
  107878. Select *p, /* The complete select statement being coded */
  107879. ExprList *pEList, /* List of values being extracted */
  107880. int srcTab, /* Pull data from this table */
  107881. SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
  107882. DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
  107883. SelectDest *pDest, /* How to dispose of the results */
  107884. int iContinue, /* Jump here to continue with next row */
  107885. int iBreak /* Jump here to break out of the inner loop */
  107886. ){
  107887. Vdbe *v = pParse->pVdbe;
  107888. int i;
  107889. int hasDistinct; /* True if the DISTINCT keyword is present */
  107890. int regResult; /* Start of memory holding result set */
  107891. int eDest = pDest->eDest; /* How to dispose of results */
  107892. int iParm = pDest->iSDParm; /* First argument to disposal method */
  107893. int nResultCol; /* Number of result columns */
  107894. int nPrefixReg = 0; /* Number of extra registers before regResult */
  107895. assert( v );
  107896. assert( pEList!=0 );
  107897. hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
  107898. if( pSort && pSort->pOrderBy==0 ) pSort = 0;
  107899. if( pSort==0 && !hasDistinct ){
  107900. assert( iContinue!=0 );
  107901. codeOffset(v, p->iOffset, iContinue);
  107902. }
  107903. /* Pull the requested columns.
  107904. */
  107905. nResultCol = pEList->nExpr;
  107906. if( pDest->iSdst==0 ){
  107907. if( pSort ){
  107908. nPrefixReg = pSort->pOrderBy->nExpr;
  107909. if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
  107910. pParse->nMem += nPrefixReg;
  107911. }
  107912. pDest->iSdst = pParse->nMem+1;
  107913. pParse->nMem += nResultCol;
  107914. }else if( pDest->iSdst+nResultCol > pParse->nMem ){
  107915. /* This is an error condition that can result, for example, when a SELECT
  107916. ** on the right-hand side of an INSERT contains more result columns than
  107917. ** there are columns in the table on the left. The error will be caught
  107918. ** and reported later. But we need to make sure enough memory is allocated
  107919. ** to avoid other spurious errors in the meantime. */
  107920. pParse->nMem += nResultCol;
  107921. }
  107922. pDest->nSdst = nResultCol;
  107923. regResult = pDest->iSdst;
  107924. if( srcTab>=0 ){
  107925. for(i=0; i<nResultCol; i++){
  107926. sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
  107927. VdbeComment((v, "%s", pEList->a[i].zName));
  107928. }
  107929. }else if( eDest!=SRT_Exists ){
  107930. /* If the destination is an EXISTS(...) expression, the actual
  107931. ** values returned by the SELECT are not required.
  107932. */
  107933. u8 ecelFlags;
  107934. if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
  107935. ecelFlags = SQLITE_ECEL_DUP;
  107936. }else{
  107937. ecelFlags = 0;
  107938. }
  107939. sqlite3ExprCodeExprList(pParse, pEList, regResult, 0, ecelFlags);
  107940. }
  107941. /* If the DISTINCT keyword was present on the SELECT statement
  107942. ** and this row has been seen before, then do not make this row
  107943. ** part of the result.
  107944. */
  107945. if( hasDistinct ){
  107946. switch( pDistinct->eTnctType ){
  107947. case WHERE_DISTINCT_ORDERED: {
  107948. VdbeOp *pOp; /* No longer required OpenEphemeral instr. */
  107949. int iJump; /* Jump destination */
  107950. int regPrev; /* Previous row content */
  107951. /* Allocate space for the previous row */
  107952. regPrev = pParse->nMem+1;
  107953. pParse->nMem += nResultCol;
  107954. /* Change the OP_OpenEphemeral coded earlier to an OP_Null
  107955. ** sets the MEM_Cleared bit on the first register of the
  107956. ** previous value. This will cause the OP_Ne below to always
  107957. ** fail on the first iteration of the loop even if the first
  107958. ** row is all NULLs.
  107959. */
  107960. sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
  107961. pOp = sqlite3VdbeGetOp(v, pDistinct->addrTnct);
  107962. pOp->opcode = OP_Null;
  107963. pOp->p1 = 1;
  107964. pOp->p2 = regPrev;
  107965. iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
  107966. for(i=0; i<nResultCol; i++){
  107967. CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
  107968. if( i<nResultCol-1 ){
  107969. sqlite3VdbeAddOp3(v, OP_Ne, regResult+i, iJump, regPrev+i);
  107970. VdbeCoverage(v);
  107971. }else{
  107972. sqlite3VdbeAddOp3(v, OP_Eq, regResult+i, iContinue, regPrev+i);
  107973. VdbeCoverage(v);
  107974. }
  107975. sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
  107976. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  107977. }
  107978. assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
  107979. sqlite3VdbeAddOp3(v, OP_Copy, regResult, regPrev, nResultCol-1);
  107980. break;
  107981. }
  107982. case WHERE_DISTINCT_UNIQUE: {
  107983. sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
  107984. break;
  107985. }
  107986. default: {
  107987. assert( pDistinct->eTnctType==WHERE_DISTINCT_UNORDERED );
  107988. codeDistinct(pParse, pDistinct->tabTnct, iContinue, nResultCol,
  107989. regResult);
  107990. break;
  107991. }
  107992. }
  107993. if( pSort==0 ){
  107994. codeOffset(v, p->iOffset, iContinue);
  107995. }
  107996. }
  107997. switch( eDest ){
  107998. /* In this mode, write each query result to the key of the temporary
  107999. ** table iParm.
  108000. */
  108001. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  108002. case SRT_Union: {
  108003. int r1;
  108004. r1 = sqlite3GetTempReg(pParse);
  108005. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
  108006. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
  108007. sqlite3ReleaseTempReg(pParse, r1);
  108008. break;
  108009. }
  108010. /* Construct a record from the query result, but instead of
  108011. ** saving that record, use it as a key to delete elements from
  108012. ** the temporary table iParm.
  108013. */
  108014. case SRT_Except: {
  108015. sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
  108016. break;
  108017. }
  108018. #endif /* SQLITE_OMIT_COMPOUND_SELECT */
  108019. /* Store the result as data using a unique key.
  108020. */
  108021. case SRT_Fifo:
  108022. case SRT_DistFifo:
  108023. case SRT_Table:
  108024. case SRT_EphemTab: {
  108025. int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
  108026. testcase( eDest==SRT_Table );
  108027. testcase( eDest==SRT_EphemTab );
  108028. testcase( eDest==SRT_Fifo );
  108029. testcase( eDest==SRT_DistFifo );
  108030. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
  108031. #ifndef SQLITE_OMIT_CTE
  108032. if( eDest==SRT_DistFifo ){
  108033. /* If the destination is DistFifo, then cursor (iParm+1) is open
  108034. ** on an ephemeral index. If the current row is already present
  108035. ** in the index, do not write it to the output. If not, add the
  108036. ** current row to the index and proceed with writing it to the
  108037. ** output table as well. */
  108038. int addr = sqlite3VdbeCurrentAddr(v) + 4;
  108039. sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
  108040. VdbeCoverage(v);
  108041. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r1);
  108042. assert( pSort==0 );
  108043. }
  108044. #endif
  108045. if( pSort ){
  108046. pushOntoSorter(pParse, pSort, p, r1+nPrefixReg,regResult,1,nPrefixReg);
  108047. }else{
  108048. int r2 = sqlite3GetTempReg(pParse);
  108049. sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
  108050. sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
  108051. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  108052. sqlite3ReleaseTempReg(pParse, r2);
  108053. }
  108054. sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
  108055. break;
  108056. }
  108057. #ifndef SQLITE_OMIT_SUBQUERY
  108058. /* If we are creating a set for an "expr IN (SELECT ...)" construct,
  108059. ** then there should be a single item on the stack. Write this
  108060. ** item into the set table with bogus data.
  108061. */
  108062. case SRT_Set: {
  108063. if( pSort ){
  108064. /* At first glance you would think we could optimize out the
  108065. ** ORDER BY in this case since the order of entries in the set
  108066. ** does not matter. But there might be a LIMIT clause, in which
  108067. ** case the order does matter */
  108068. pushOntoSorter(
  108069. pParse, pSort, p, regResult, regResult, nResultCol, nPrefixReg);
  108070. }else{
  108071. int r1 = sqlite3GetTempReg(pParse);
  108072. assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
  108073. sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
  108074. r1, pDest->zAffSdst, nResultCol);
  108075. sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
  108076. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
  108077. sqlite3ReleaseTempReg(pParse, r1);
  108078. }
  108079. break;
  108080. }
  108081. /* If any row exist in the result set, record that fact and abort.
  108082. */
  108083. case SRT_Exists: {
  108084. sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
  108085. /* The LIMIT clause will terminate the loop for us */
  108086. break;
  108087. }
  108088. /* If this is a scalar select that is part of an expression, then
  108089. ** store the results in the appropriate memory cell or array of
  108090. ** memory cells and break out of the scan loop.
  108091. */
  108092. case SRT_Mem: {
  108093. assert( nResultCol==pDest->nSdst );
  108094. if( pSort ){
  108095. pushOntoSorter(
  108096. pParse, pSort, p, regResult, regResult, nResultCol, nPrefixReg);
  108097. }else{
  108098. assert( regResult==iParm );
  108099. /* The LIMIT clause will jump out of the loop for us */
  108100. }
  108101. break;
  108102. }
  108103. #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
  108104. case SRT_Coroutine: /* Send data to a co-routine */
  108105. case SRT_Output: { /* Return the results */
  108106. testcase( eDest==SRT_Coroutine );
  108107. testcase( eDest==SRT_Output );
  108108. if( pSort ){
  108109. pushOntoSorter(pParse, pSort, p, regResult, regResult, nResultCol,
  108110. nPrefixReg);
  108111. }else if( eDest==SRT_Coroutine ){
  108112. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  108113. }else{
  108114. sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
  108115. sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
  108116. }
  108117. break;
  108118. }
  108119. #ifndef SQLITE_OMIT_CTE
  108120. /* Write the results into a priority queue that is order according to
  108121. ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
  108122. ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
  108123. ** pSO->nExpr columns, then make sure all keys are unique by adding a
  108124. ** final OP_Sequence column. The last column is the record as a blob.
  108125. */
  108126. case SRT_DistQueue:
  108127. case SRT_Queue: {
  108128. int nKey;
  108129. int r1, r2, r3;
  108130. int addrTest = 0;
  108131. ExprList *pSO;
  108132. pSO = pDest->pOrderBy;
  108133. assert( pSO );
  108134. nKey = pSO->nExpr;
  108135. r1 = sqlite3GetTempReg(pParse);
  108136. r2 = sqlite3GetTempRange(pParse, nKey+2);
  108137. r3 = r2+nKey+1;
  108138. if( eDest==SRT_DistQueue ){
  108139. /* If the destination is DistQueue, then cursor (iParm+1) is open
  108140. ** on a second ephemeral index that holds all values every previously
  108141. ** added to the queue. */
  108142. addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
  108143. regResult, nResultCol);
  108144. VdbeCoverage(v);
  108145. }
  108146. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
  108147. if( eDest==SRT_DistQueue ){
  108148. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
  108149. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  108150. }
  108151. for(i=0; i<nKey; i++){
  108152. sqlite3VdbeAddOp2(v, OP_SCopy,
  108153. regResult + pSO->a[i].u.x.iOrderByCol - 1,
  108154. r2+i);
  108155. }
  108156. sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
  108157. sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
  108158. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
  108159. if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
  108160. sqlite3ReleaseTempReg(pParse, r1);
  108161. sqlite3ReleaseTempRange(pParse, r2, nKey+2);
  108162. break;
  108163. }
  108164. #endif /* SQLITE_OMIT_CTE */
  108165. #if !defined(SQLITE_OMIT_TRIGGER)
  108166. /* Discard the results. This is used for SELECT statements inside
  108167. ** the body of a TRIGGER. The purpose of such selects is to call
  108168. ** user-defined functions that have side effects. We do not care
  108169. ** about the actual results of the select.
  108170. */
  108171. default: {
  108172. assert( eDest==SRT_Discard );
  108173. break;
  108174. }
  108175. #endif
  108176. }
  108177. /* Jump to the end of the loop if the LIMIT is reached. Except, if
  108178. ** there is a sorter, in which case the sorter has already limited
  108179. ** the output for us.
  108180. */
  108181. if( pSort==0 && p->iLimit ){
  108182. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
  108183. }
  108184. }
  108185. /*
  108186. ** Allocate a KeyInfo object sufficient for an index of N key columns and
  108187. ** X extra columns.
  108188. */
  108189. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
  108190. int nExtra = (N+X)*(sizeof(CollSeq*)+1);
  108191. KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
  108192. if( p ){
  108193. p->aSortOrder = (u8*)&p->aColl[N+X];
  108194. p->nField = (u16)N;
  108195. p->nXField = (u16)X;
  108196. p->enc = ENC(db);
  108197. p->db = db;
  108198. p->nRef = 1;
  108199. memset(&p[1], 0, nExtra);
  108200. }else{
  108201. sqlite3OomFault(db);
  108202. }
  108203. return p;
  108204. }
  108205. /*
  108206. ** Deallocate a KeyInfo object
  108207. */
  108208. SQLITE_PRIVATE void sqlite3KeyInfoUnref(KeyInfo *p){
  108209. if( p ){
  108210. assert( p->nRef>0 );
  108211. p->nRef--;
  108212. if( p->nRef==0 ) sqlite3DbFree(p->db, p);
  108213. }
  108214. }
  108215. /*
  108216. ** Make a new pointer to a KeyInfo object
  108217. */
  108218. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
  108219. if( p ){
  108220. assert( p->nRef>0 );
  108221. p->nRef++;
  108222. }
  108223. return p;
  108224. }
  108225. #ifdef SQLITE_DEBUG
  108226. /*
  108227. ** Return TRUE if a KeyInfo object can be change. The KeyInfo object
  108228. ** can only be changed if this is just a single reference to the object.
  108229. **
  108230. ** This routine is used only inside of assert() statements.
  108231. */
  108232. SQLITE_PRIVATE int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
  108233. #endif /* SQLITE_DEBUG */
  108234. /*
  108235. ** Given an expression list, generate a KeyInfo structure that records
  108236. ** the collating sequence for each expression in that expression list.
  108237. **
  108238. ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
  108239. ** KeyInfo structure is appropriate for initializing a virtual index to
  108240. ** implement that clause. If the ExprList is the result set of a SELECT
  108241. ** then the KeyInfo structure is appropriate for initializing a virtual
  108242. ** index to implement a DISTINCT test.
  108243. **
  108244. ** Space to hold the KeyInfo structure is obtained from malloc. The calling
  108245. ** function is responsible for seeing that this structure is eventually
  108246. ** freed.
  108247. */
  108248. static KeyInfo *keyInfoFromExprList(
  108249. Parse *pParse, /* Parsing context */
  108250. ExprList *pList, /* Form the KeyInfo object from this ExprList */
  108251. int iStart, /* Begin with this column of pList */
  108252. int nExtra /* Add this many extra columns to the end */
  108253. ){
  108254. int nExpr;
  108255. KeyInfo *pInfo;
  108256. struct ExprList_item *pItem;
  108257. sqlite3 *db = pParse->db;
  108258. int i;
  108259. nExpr = pList->nExpr;
  108260. pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
  108261. if( pInfo ){
  108262. assert( sqlite3KeyInfoIsWriteable(pInfo) );
  108263. for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
  108264. CollSeq *pColl;
  108265. pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
  108266. if( !pColl ) pColl = db->pDfltColl;
  108267. pInfo->aColl[i-iStart] = pColl;
  108268. pInfo->aSortOrder[i-iStart] = pItem->sortOrder;
  108269. }
  108270. }
  108271. return pInfo;
  108272. }
  108273. /*
  108274. ** Name of the connection operator, used for error messages.
  108275. */
  108276. static const char *selectOpName(int id){
  108277. char *z;
  108278. switch( id ){
  108279. case TK_ALL: z = "UNION ALL"; break;
  108280. case TK_INTERSECT: z = "INTERSECT"; break;
  108281. case TK_EXCEPT: z = "EXCEPT"; break;
  108282. default: z = "UNION"; break;
  108283. }
  108284. return z;
  108285. }
  108286. #ifndef SQLITE_OMIT_EXPLAIN
  108287. /*
  108288. ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
  108289. ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
  108290. ** where the caption is of the form:
  108291. **
  108292. ** "USE TEMP B-TREE FOR xxx"
  108293. **
  108294. ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
  108295. ** is determined by the zUsage argument.
  108296. */
  108297. static void explainTempTable(Parse *pParse, const char *zUsage){
  108298. if( pParse->explain==2 ){
  108299. Vdbe *v = pParse->pVdbe;
  108300. char *zMsg = sqlite3MPrintf(pParse->db, "USE TEMP B-TREE FOR %s", zUsage);
  108301. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  108302. }
  108303. }
  108304. /*
  108305. ** Assign expression b to lvalue a. A second, no-op, version of this macro
  108306. ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
  108307. ** in sqlite3Select() to assign values to structure member variables that
  108308. ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
  108309. ** code with #ifndef directives.
  108310. */
  108311. # define explainSetInteger(a, b) a = b
  108312. #else
  108313. /* No-op versions of the explainXXX() functions and macros. */
  108314. # define explainTempTable(y,z)
  108315. # define explainSetInteger(y,z)
  108316. #endif
  108317. #if !defined(SQLITE_OMIT_EXPLAIN) && !defined(SQLITE_OMIT_COMPOUND_SELECT)
  108318. /*
  108319. ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
  108320. ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
  108321. ** where the caption is of one of the two forms:
  108322. **
  108323. ** "COMPOSITE SUBQUERIES iSub1 and iSub2 (op)"
  108324. ** "COMPOSITE SUBQUERIES iSub1 and iSub2 USING TEMP B-TREE (op)"
  108325. **
  108326. ** where iSub1 and iSub2 are the integers passed as the corresponding
  108327. ** function parameters, and op is the text representation of the parameter
  108328. ** of the same name. The parameter "op" must be one of TK_UNION, TK_EXCEPT,
  108329. ** TK_INTERSECT or TK_ALL. The first form is used if argument bUseTmp is
  108330. ** false, or the second form if it is true.
  108331. */
  108332. static void explainComposite(
  108333. Parse *pParse, /* Parse context */
  108334. int op, /* One of TK_UNION, TK_EXCEPT etc. */
  108335. int iSub1, /* Subquery id 1 */
  108336. int iSub2, /* Subquery id 2 */
  108337. int bUseTmp /* True if a temp table was used */
  108338. ){
  108339. assert( op==TK_UNION || op==TK_EXCEPT || op==TK_INTERSECT || op==TK_ALL );
  108340. if( pParse->explain==2 ){
  108341. Vdbe *v = pParse->pVdbe;
  108342. char *zMsg = sqlite3MPrintf(
  108343. pParse->db, "COMPOUND SUBQUERIES %d AND %d %s(%s)", iSub1, iSub2,
  108344. bUseTmp?"USING TEMP B-TREE ":"", selectOpName(op)
  108345. );
  108346. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  108347. }
  108348. }
  108349. #else
  108350. /* No-op versions of the explainXXX() functions and macros. */
  108351. # define explainComposite(v,w,x,y,z)
  108352. #endif
  108353. /*
  108354. ** If the inner loop was generated using a non-null pOrderBy argument,
  108355. ** then the results were placed in a sorter. After the loop is terminated
  108356. ** we need to run the sorter and output the results. The following
  108357. ** routine generates the code needed to do that.
  108358. */
  108359. static void generateSortTail(
  108360. Parse *pParse, /* Parsing context */
  108361. Select *p, /* The SELECT statement */
  108362. SortCtx *pSort, /* Information on the ORDER BY clause */
  108363. int nColumn, /* Number of columns of data */
  108364. SelectDest *pDest /* Write the sorted results here */
  108365. ){
  108366. Vdbe *v = pParse->pVdbe; /* The prepared statement */
  108367. int addrBreak = pSort->labelDone; /* Jump here to exit loop */
  108368. int addrContinue = sqlite3VdbeMakeLabel(v); /* Jump here for next cycle */
  108369. int addr;
  108370. int addrOnce = 0;
  108371. int iTab;
  108372. ExprList *pOrderBy = pSort->pOrderBy;
  108373. int eDest = pDest->eDest;
  108374. int iParm = pDest->iSDParm;
  108375. int regRow;
  108376. int regRowid;
  108377. int nKey;
  108378. int iSortTab; /* Sorter cursor to read from */
  108379. int nSortData; /* Trailing values to read from sorter */
  108380. int i;
  108381. int bSeq; /* True if sorter record includes seq. no. */
  108382. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  108383. struct ExprList_item *aOutEx = p->pEList->a;
  108384. #endif
  108385. assert( addrBreak<0 );
  108386. if( pSort->labelBkOut ){
  108387. sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
  108388. sqlite3VdbeGoto(v, addrBreak);
  108389. sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
  108390. }
  108391. iTab = pSort->iECursor;
  108392. if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
  108393. regRowid = 0;
  108394. regRow = pDest->iSdst;
  108395. nSortData = nColumn;
  108396. }else{
  108397. regRowid = sqlite3GetTempReg(pParse);
  108398. regRow = sqlite3GetTempRange(pParse, nColumn);
  108399. nSortData = nColumn;
  108400. }
  108401. nKey = pOrderBy->nExpr - pSort->nOBSat;
  108402. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  108403. int regSortOut = ++pParse->nMem;
  108404. iSortTab = pParse->nTab++;
  108405. if( pSort->labelBkOut ){
  108406. addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  108407. }
  108408. sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut, nKey+1+nSortData);
  108409. if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
  108410. addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
  108411. VdbeCoverage(v);
  108412. codeOffset(v, p->iOffset, addrContinue);
  108413. sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
  108414. bSeq = 0;
  108415. }else{
  108416. addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
  108417. codeOffset(v, p->iOffset, addrContinue);
  108418. iSortTab = iTab;
  108419. bSeq = 1;
  108420. }
  108421. for(i=0; i<nSortData; i++){
  108422. sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq+i, regRow+i);
  108423. VdbeComment((v, "%s", aOutEx[i].zName ? aOutEx[i].zName : aOutEx[i].zSpan));
  108424. }
  108425. switch( eDest ){
  108426. case SRT_EphemTab: {
  108427. sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
  108428. sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
  108429. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  108430. break;
  108431. }
  108432. #ifndef SQLITE_OMIT_SUBQUERY
  108433. case SRT_Set: {
  108434. assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
  108435. sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
  108436. pDest->zAffSdst, nColumn);
  108437. sqlite3ExprCacheAffinityChange(pParse, regRow, nColumn);
  108438. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, regRowid);
  108439. break;
  108440. }
  108441. case SRT_Mem: {
  108442. /* The LIMIT clause will terminate the loop for us */
  108443. break;
  108444. }
  108445. #endif
  108446. default: {
  108447. assert( eDest==SRT_Output || eDest==SRT_Coroutine );
  108448. testcase( eDest==SRT_Output );
  108449. testcase( eDest==SRT_Coroutine );
  108450. if( eDest==SRT_Output ){
  108451. sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
  108452. sqlite3ExprCacheAffinityChange(pParse, pDest->iSdst, nColumn);
  108453. }else{
  108454. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  108455. }
  108456. break;
  108457. }
  108458. }
  108459. if( regRowid ){
  108460. if( eDest==SRT_Set ){
  108461. sqlite3ReleaseTempRange(pParse, regRow, nColumn);
  108462. }else{
  108463. sqlite3ReleaseTempReg(pParse, regRow);
  108464. }
  108465. sqlite3ReleaseTempReg(pParse, regRowid);
  108466. }
  108467. /* The bottom of the loop
  108468. */
  108469. sqlite3VdbeResolveLabel(v, addrContinue);
  108470. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  108471. sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
  108472. }else{
  108473. sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
  108474. }
  108475. if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
  108476. sqlite3VdbeResolveLabel(v, addrBreak);
  108477. }
  108478. /*
  108479. ** Return a pointer to a string containing the 'declaration type' of the
  108480. ** expression pExpr. The string may be treated as static by the caller.
  108481. **
  108482. ** Also try to estimate the size of the returned value and return that
  108483. ** result in *pEstWidth.
  108484. **
  108485. ** The declaration type is the exact datatype definition extracted from the
  108486. ** original CREATE TABLE statement if the expression is a column. The
  108487. ** declaration type for a ROWID field is INTEGER. Exactly when an expression
  108488. ** is considered a column can be complex in the presence of subqueries. The
  108489. ** result-set expression in all of the following SELECT statements is
  108490. ** considered a column by this function.
  108491. **
  108492. ** SELECT col FROM tbl;
  108493. ** SELECT (SELECT col FROM tbl;
  108494. ** SELECT (SELECT col FROM tbl);
  108495. ** SELECT abc FROM (SELECT col AS abc FROM tbl);
  108496. **
  108497. ** The declaration type for any expression other than a column is NULL.
  108498. **
  108499. ** This routine has either 3 or 6 parameters depending on whether or not
  108500. ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
  108501. */
  108502. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108503. # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,C,D,E,F)
  108504. #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
  108505. # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,F)
  108506. #endif
  108507. static const char *columnTypeImpl(
  108508. NameContext *pNC,
  108509. Expr *pExpr,
  108510. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108511. const char **pzOrigDb,
  108512. const char **pzOrigTab,
  108513. const char **pzOrigCol,
  108514. #endif
  108515. u8 *pEstWidth
  108516. ){
  108517. char const *zType = 0;
  108518. int j;
  108519. u8 estWidth = 1;
  108520. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108521. char const *zOrigDb = 0;
  108522. char const *zOrigTab = 0;
  108523. char const *zOrigCol = 0;
  108524. #endif
  108525. assert( pExpr!=0 );
  108526. assert( pNC->pSrcList!=0 );
  108527. switch( pExpr->op ){
  108528. case TK_AGG_COLUMN:
  108529. case TK_COLUMN: {
  108530. /* The expression is a column. Locate the table the column is being
  108531. ** extracted from in NameContext.pSrcList. This table may be real
  108532. ** database table or a subquery.
  108533. */
  108534. Table *pTab = 0; /* Table structure column is extracted from */
  108535. Select *pS = 0; /* Select the column is extracted from */
  108536. int iCol = pExpr->iColumn; /* Index of column in pTab */
  108537. testcase( pExpr->op==TK_AGG_COLUMN );
  108538. testcase( pExpr->op==TK_COLUMN );
  108539. while( pNC && !pTab ){
  108540. SrcList *pTabList = pNC->pSrcList;
  108541. for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
  108542. if( j<pTabList->nSrc ){
  108543. pTab = pTabList->a[j].pTab;
  108544. pS = pTabList->a[j].pSelect;
  108545. }else{
  108546. pNC = pNC->pNext;
  108547. }
  108548. }
  108549. if( pTab==0 ){
  108550. /* At one time, code such as "SELECT new.x" within a trigger would
  108551. ** cause this condition to run. Since then, we have restructured how
  108552. ** trigger code is generated and so this condition is no longer
  108553. ** possible. However, it can still be true for statements like
  108554. ** the following:
  108555. **
  108556. ** CREATE TABLE t1(col INTEGER);
  108557. ** SELECT (SELECT t1.col) FROM FROM t1;
  108558. **
  108559. ** when columnType() is called on the expression "t1.col" in the
  108560. ** sub-select. In this case, set the column type to NULL, even
  108561. ** though it should really be "INTEGER".
  108562. **
  108563. ** This is not a problem, as the column type of "t1.col" is never
  108564. ** used. When columnType() is called on the expression
  108565. ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
  108566. ** branch below. */
  108567. break;
  108568. }
  108569. assert( pTab && pExpr->pTab==pTab );
  108570. if( pS ){
  108571. /* The "table" is actually a sub-select or a view in the FROM clause
  108572. ** of the SELECT statement. Return the declaration type and origin
  108573. ** data for the result-set column of the sub-select.
  108574. */
  108575. if( iCol>=0 && ALWAYS(iCol<pS->pEList->nExpr) ){
  108576. /* If iCol is less than zero, then the expression requests the
  108577. ** rowid of the sub-select or view. This expression is legal (see
  108578. ** test case misc2.2.2) - it always evaluates to NULL.
  108579. **
  108580. ** The ALWAYS() is because iCol>=pS->pEList->nExpr will have been
  108581. ** caught already by name resolution.
  108582. */
  108583. NameContext sNC;
  108584. Expr *p = pS->pEList->a[iCol].pExpr;
  108585. sNC.pSrcList = pS->pSrc;
  108586. sNC.pNext = pNC;
  108587. sNC.pParse = pNC->pParse;
  108588. zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol, &estWidth);
  108589. }
  108590. }else if( pTab->pSchema ){
  108591. /* A real table */
  108592. assert( !pS );
  108593. if( iCol<0 ) iCol = pTab->iPKey;
  108594. assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
  108595. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108596. if( iCol<0 ){
  108597. zType = "INTEGER";
  108598. zOrigCol = "rowid";
  108599. }else{
  108600. zOrigCol = pTab->aCol[iCol].zName;
  108601. zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
  108602. estWidth = pTab->aCol[iCol].szEst;
  108603. }
  108604. zOrigTab = pTab->zName;
  108605. if( pNC->pParse ){
  108606. int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
  108607. zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
  108608. }
  108609. #else
  108610. if( iCol<0 ){
  108611. zType = "INTEGER";
  108612. }else{
  108613. zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
  108614. estWidth = pTab->aCol[iCol].szEst;
  108615. }
  108616. #endif
  108617. }
  108618. break;
  108619. }
  108620. #ifndef SQLITE_OMIT_SUBQUERY
  108621. case TK_SELECT: {
  108622. /* The expression is a sub-select. Return the declaration type and
  108623. ** origin info for the single column in the result set of the SELECT
  108624. ** statement.
  108625. */
  108626. NameContext sNC;
  108627. Select *pS = pExpr->x.pSelect;
  108628. Expr *p = pS->pEList->a[0].pExpr;
  108629. assert( ExprHasProperty(pExpr, EP_xIsSelect) );
  108630. sNC.pSrcList = pS->pSrc;
  108631. sNC.pNext = pNC;
  108632. sNC.pParse = pNC->pParse;
  108633. zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, &estWidth);
  108634. break;
  108635. }
  108636. #endif
  108637. }
  108638. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108639. if( pzOrigDb ){
  108640. assert( pzOrigTab && pzOrigCol );
  108641. *pzOrigDb = zOrigDb;
  108642. *pzOrigTab = zOrigTab;
  108643. *pzOrigCol = zOrigCol;
  108644. }
  108645. #endif
  108646. if( pEstWidth ) *pEstWidth = estWidth;
  108647. return zType;
  108648. }
  108649. /*
  108650. ** Generate code that will tell the VDBE the declaration types of columns
  108651. ** in the result set.
  108652. */
  108653. static void generateColumnTypes(
  108654. Parse *pParse, /* Parser context */
  108655. SrcList *pTabList, /* List of tables */
  108656. ExprList *pEList /* Expressions defining the result set */
  108657. ){
  108658. #ifndef SQLITE_OMIT_DECLTYPE
  108659. Vdbe *v = pParse->pVdbe;
  108660. int i;
  108661. NameContext sNC;
  108662. sNC.pSrcList = pTabList;
  108663. sNC.pParse = pParse;
  108664. for(i=0; i<pEList->nExpr; i++){
  108665. Expr *p = pEList->a[i].pExpr;
  108666. const char *zType;
  108667. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  108668. const char *zOrigDb = 0;
  108669. const char *zOrigTab = 0;
  108670. const char *zOrigCol = 0;
  108671. zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, 0);
  108672. /* The vdbe must make its own copy of the column-type and other
  108673. ** column specific strings, in case the schema is reset before this
  108674. ** virtual machine is deleted.
  108675. */
  108676. sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
  108677. sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
  108678. sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
  108679. #else
  108680. zType = columnType(&sNC, p, 0, 0, 0, 0);
  108681. #endif
  108682. sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
  108683. }
  108684. #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
  108685. }
  108686. /*
  108687. ** Generate code that will tell the VDBE the names of columns
  108688. ** in the result set. This information is used to provide the
  108689. ** azCol[] values in the callback.
  108690. */
  108691. static void generateColumnNames(
  108692. Parse *pParse, /* Parser context */
  108693. SrcList *pTabList, /* List of tables */
  108694. ExprList *pEList /* Expressions defining the result set */
  108695. ){
  108696. Vdbe *v = pParse->pVdbe;
  108697. int i, j;
  108698. sqlite3 *db = pParse->db;
  108699. int fullNames, shortNames;
  108700. #ifndef SQLITE_OMIT_EXPLAIN
  108701. /* If this is an EXPLAIN, skip this step */
  108702. if( pParse->explain ){
  108703. return;
  108704. }
  108705. #endif
  108706. if( pParse->colNamesSet || db->mallocFailed ) return;
  108707. assert( v!=0 );
  108708. assert( pTabList!=0 );
  108709. pParse->colNamesSet = 1;
  108710. fullNames = (db->flags & SQLITE_FullColNames)!=0;
  108711. shortNames = (db->flags & SQLITE_ShortColNames)!=0;
  108712. sqlite3VdbeSetNumCols(v, pEList->nExpr);
  108713. for(i=0; i<pEList->nExpr; i++){
  108714. Expr *p;
  108715. p = pEList->a[i].pExpr;
  108716. if( NEVER(p==0) ) continue;
  108717. if( pEList->a[i].zName ){
  108718. char *zName = pEList->a[i].zName;
  108719. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
  108720. }else if( p->op==TK_COLUMN || p->op==TK_AGG_COLUMN ){
  108721. Table *pTab;
  108722. char *zCol;
  108723. int iCol = p->iColumn;
  108724. for(j=0; ALWAYS(j<pTabList->nSrc); j++){
  108725. if( pTabList->a[j].iCursor==p->iTable ) break;
  108726. }
  108727. assert( j<pTabList->nSrc );
  108728. pTab = pTabList->a[j].pTab;
  108729. if( iCol<0 ) iCol = pTab->iPKey;
  108730. assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
  108731. if( iCol<0 ){
  108732. zCol = "rowid";
  108733. }else{
  108734. zCol = pTab->aCol[iCol].zName;
  108735. }
  108736. if( !shortNames && !fullNames ){
  108737. sqlite3VdbeSetColName(v, i, COLNAME_NAME,
  108738. sqlite3DbStrDup(db, pEList->a[i].zSpan), SQLITE_DYNAMIC);
  108739. }else if( fullNames ){
  108740. char *zName = 0;
  108741. zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
  108742. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
  108743. }else{
  108744. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
  108745. }
  108746. }else{
  108747. const char *z = pEList->a[i].zSpan;
  108748. z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
  108749. sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
  108750. }
  108751. }
  108752. generateColumnTypes(pParse, pTabList, pEList);
  108753. }
  108754. /*
  108755. ** Given an expression list (which is really the list of expressions
  108756. ** that form the result set of a SELECT statement) compute appropriate
  108757. ** column names for a table that would hold the expression list.
  108758. **
  108759. ** All column names will be unique.
  108760. **
  108761. ** Only the column names are computed. Column.zType, Column.zColl,
  108762. ** and other fields of Column are zeroed.
  108763. **
  108764. ** Return SQLITE_OK on success. If a memory allocation error occurs,
  108765. ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
  108766. */
  108767. SQLITE_PRIVATE int sqlite3ColumnsFromExprList(
  108768. Parse *pParse, /* Parsing context */
  108769. ExprList *pEList, /* Expr list from which to derive column names */
  108770. i16 *pnCol, /* Write the number of columns here */
  108771. Column **paCol /* Write the new column list here */
  108772. ){
  108773. sqlite3 *db = pParse->db; /* Database connection */
  108774. int i, j; /* Loop counters */
  108775. u32 cnt; /* Index added to make the name unique */
  108776. Column *aCol, *pCol; /* For looping over result columns */
  108777. int nCol; /* Number of columns in the result set */
  108778. Expr *p; /* Expression for a single result column */
  108779. char *zName; /* Column name */
  108780. int nName; /* Size of name in zName[] */
  108781. Hash ht; /* Hash table of column names */
  108782. sqlite3HashInit(&ht);
  108783. if( pEList ){
  108784. nCol = pEList->nExpr;
  108785. aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
  108786. testcase( aCol==0 );
  108787. }else{
  108788. nCol = 0;
  108789. aCol = 0;
  108790. }
  108791. assert( nCol==(i16)nCol );
  108792. *pnCol = nCol;
  108793. *paCol = aCol;
  108794. for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
  108795. /* Get an appropriate name for the column
  108796. */
  108797. p = sqlite3ExprSkipCollate(pEList->a[i].pExpr);
  108798. if( (zName = pEList->a[i].zName)!=0 ){
  108799. /* If the column contains an "AS <name>" phrase, use <name> as the name */
  108800. }else{
  108801. Expr *pColExpr = p; /* The expression that is the result column name */
  108802. Table *pTab; /* Table associated with this expression */
  108803. while( pColExpr->op==TK_DOT ){
  108804. pColExpr = pColExpr->pRight;
  108805. assert( pColExpr!=0 );
  108806. }
  108807. if( pColExpr->op==TK_COLUMN && ALWAYS(pColExpr->pTab!=0) ){
  108808. /* For columns use the column name name */
  108809. int iCol = pColExpr->iColumn;
  108810. pTab = pColExpr->pTab;
  108811. if( iCol<0 ) iCol = pTab->iPKey;
  108812. zName = iCol>=0 ? pTab->aCol[iCol].zName : "rowid";
  108813. }else if( pColExpr->op==TK_ID ){
  108814. assert( !ExprHasProperty(pColExpr, EP_IntValue) );
  108815. zName = pColExpr->u.zToken;
  108816. }else{
  108817. /* Use the original text of the column expression as its name */
  108818. zName = pEList->a[i].zSpan;
  108819. }
  108820. }
  108821. zName = sqlite3MPrintf(db, "%s", zName);
  108822. /* Make sure the column name is unique. If the name is not unique,
  108823. ** append an integer to the name so that it becomes unique.
  108824. */
  108825. cnt = 0;
  108826. while( zName && sqlite3HashFind(&ht, zName)!=0 ){
  108827. nName = sqlite3Strlen30(zName);
  108828. if( nName>0 ){
  108829. for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
  108830. if( zName[j]==':' ) nName = j;
  108831. }
  108832. zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
  108833. if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
  108834. }
  108835. pCol->zName = zName;
  108836. sqlite3ColumnPropertiesFromName(0, pCol);
  108837. if( zName && sqlite3HashInsert(&ht, zName, pCol)==pCol ){
  108838. sqlite3OomFault(db);
  108839. }
  108840. }
  108841. sqlite3HashClear(&ht);
  108842. if( db->mallocFailed ){
  108843. for(j=0; j<i; j++){
  108844. sqlite3DbFree(db, aCol[j].zName);
  108845. }
  108846. sqlite3DbFree(db, aCol);
  108847. *paCol = 0;
  108848. *pnCol = 0;
  108849. return SQLITE_NOMEM_BKPT;
  108850. }
  108851. return SQLITE_OK;
  108852. }
  108853. /*
  108854. ** Add type and collation information to a column list based on
  108855. ** a SELECT statement.
  108856. **
  108857. ** The column list presumably came from selectColumnNamesFromExprList().
  108858. ** The column list has only names, not types or collations. This
  108859. ** routine goes through and adds the types and collations.
  108860. **
  108861. ** This routine requires that all identifiers in the SELECT
  108862. ** statement be resolved.
  108863. */
  108864. SQLITE_PRIVATE void sqlite3SelectAddColumnTypeAndCollation(
  108865. Parse *pParse, /* Parsing contexts */
  108866. Table *pTab, /* Add column type information to this table */
  108867. Select *pSelect /* SELECT used to determine types and collations */
  108868. ){
  108869. sqlite3 *db = pParse->db;
  108870. NameContext sNC;
  108871. Column *pCol;
  108872. CollSeq *pColl;
  108873. int i;
  108874. Expr *p;
  108875. struct ExprList_item *a;
  108876. u64 szAll = 0;
  108877. assert( pSelect!=0 );
  108878. assert( (pSelect->selFlags & SF_Resolved)!=0 );
  108879. assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
  108880. if( db->mallocFailed ) return;
  108881. memset(&sNC, 0, sizeof(sNC));
  108882. sNC.pSrcList = pSelect->pSrc;
  108883. a = pSelect->pEList->a;
  108884. for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
  108885. const char *zType;
  108886. int n, m;
  108887. p = a[i].pExpr;
  108888. zType = columnType(&sNC, p, 0, 0, 0, &pCol->szEst);
  108889. szAll += pCol->szEst;
  108890. pCol->affinity = sqlite3ExprAffinity(p);
  108891. if( zType && (m = sqlite3Strlen30(zType))>0 ){
  108892. n = sqlite3Strlen30(pCol->zName);
  108893. pCol->zName = sqlite3DbReallocOrFree(db, pCol->zName, n+m+2);
  108894. if( pCol->zName ){
  108895. memcpy(&pCol->zName[n+1], zType, m+1);
  108896. pCol->colFlags |= COLFLAG_HASTYPE;
  108897. }
  108898. }
  108899. if( pCol->affinity==0 ) pCol->affinity = SQLITE_AFF_BLOB;
  108900. pColl = sqlite3ExprCollSeq(pParse, p);
  108901. if( pColl && pCol->zColl==0 ){
  108902. pCol->zColl = sqlite3DbStrDup(db, pColl->zName);
  108903. }
  108904. }
  108905. pTab->szTabRow = sqlite3LogEst(szAll*4);
  108906. }
  108907. /*
  108908. ** Given a SELECT statement, generate a Table structure that describes
  108909. ** the result set of that SELECT.
  108910. */
  108911. SQLITE_PRIVATE Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect){
  108912. Table *pTab;
  108913. sqlite3 *db = pParse->db;
  108914. int savedFlags;
  108915. savedFlags = db->flags;
  108916. db->flags &= ~SQLITE_FullColNames;
  108917. db->flags |= SQLITE_ShortColNames;
  108918. sqlite3SelectPrep(pParse, pSelect, 0);
  108919. if( pParse->nErr ) return 0;
  108920. while( pSelect->pPrior ) pSelect = pSelect->pPrior;
  108921. db->flags = savedFlags;
  108922. pTab = sqlite3DbMallocZero(db, sizeof(Table) );
  108923. if( pTab==0 ){
  108924. return 0;
  108925. }
  108926. /* The sqlite3ResultSetOfSelect() is only used n contexts where lookaside
  108927. ** is disabled */
  108928. assert( db->lookaside.bDisable );
  108929. pTab->nRef = 1;
  108930. pTab->zName = 0;
  108931. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  108932. sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
  108933. sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect);
  108934. pTab->iPKey = -1;
  108935. if( db->mallocFailed ){
  108936. sqlite3DeleteTable(db, pTab);
  108937. return 0;
  108938. }
  108939. return pTab;
  108940. }
  108941. /*
  108942. ** Get a VDBE for the given parser context. Create a new one if necessary.
  108943. ** If an error occurs, return NULL and leave a message in pParse.
  108944. */
  108945. static SQLITE_NOINLINE Vdbe *allocVdbe(Parse *pParse){
  108946. Vdbe *v = pParse->pVdbe = sqlite3VdbeCreate(pParse);
  108947. if( v ) sqlite3VdbeAddOp2(v, OP_Init, 0, 1);
  108948. if( pParse->pToplevel==0
  108949. && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
  108950. ){
  108951. pParse->okConstFactor = 1;
  108952. }
  108953. return v;
  108954. }
  108955. SQLITE_PRIVATE Vdbe *sqlite3GetVdbe(Parse *pParse){
  108956. Vdbe *v = pParse->pVdbe;
  108957. return v ? v : allocVdbe(pParse);
  108958. }
  108959. /*
  108960. ** Compute the iLimit and iOffset fields of the SELECT based on the
  108961. ** pLimit and pOffset expressions. pLimit and pOffset hold the expressions
  108962. ** that appear in the original SQL statement after the LIMIT and OFFSET
  108963. ** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
  108964. ** are the integer memory register numbers for counters used to compute
  108965. ** the limit and offset. If there is no limit and/or offset, then
  108966. ** iLimit and iOffset are negative.
  108967. **
  108968. ** This routine changes the values of iLimit and iOffset only if
  108969. ** a limit or offset is defined by pLimit and pOffset. iLimit and
  108970. ** iOffset should have been preset to appropriate default values (zero)
  108971. ** prior to calling this routine.
  108972. **
  108973. ** The iOffset register (if it exists) is initialized to the value
  108974. ** of the OFFSET. The iLimit register is initialized to LIMIT. Register
  108975. ** iOffset+1 is initialized to LIMIT+OFFSET.
  108976. **
  108977. ** Only if pLimit!=0 or pOffset!=0 do the limit registers get
  108978. ** redefined. The UNION ALL operator uses this property to force
  108979. ** the reuse of the same limit and offset registers across multiple
  108980. ** SELECT statements.
  108981. */
  108982. static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
  108983. Vdbe *v = 0;
  108984. int iLimit = 0;
  108985. int iOffset;
  108986. int n;
  108987. if( p->iLimit ) return;
  108988. /*
  108989. ** "LIMIT -1" always shows all rows. There is some
  108990. ** controversy about what the correct behavior should be.
  108991. ** The current implementation interprets "LIMIT 0" to mean
  108992. ** no rows.
  108993. */
  108994. sqlite3ExprCacheClear(pParse);
  108995. assert( p->pOffset==0 || p->pLimit!=0 );
  108996. if( p->pLimit ){
  108997. p->iLimit = iLimit = ++pParse->nMem;
  108998. v = sqlite3GetVdbe(pParse);
  108999. assert( v!=0 );
  109000. if( sqlite3ExprIsInteger(p->pLimit, &n) ){
  109001. sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
  109002. VdbeComment((v, "LIMIT counter"));
  109003. if( n==0 ){
  109004. sqlite3VdbeGoto(v, iBreak);
  109005. }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
  109006. p->nSelectRow = sqlite3LogEst((u64)n);
  109007. p->selFlags |= SF_FixedLimit;
  109008. }
  109009. }else{
  109010. sqlite3ExprCode(pParse, p->pLimit, iLimit);
  109011. sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
  109012. VdbeComment((v, "LIMIT counter"));
  109013. sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
  109014. }
  109015. if( p->pOffset ){
  109016. p->iOffset = iOffset = ++pParse->nMem;
  109017. pParse->nMem++; /* Allocate an extra register for limit+offset */
  109018. sqlite3ExprCode(pParse, p->pOffset, iOffset);
  109019. sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
  109020. VdbeComment((v, "OFFSET counter"));
  109021. sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
  109022. VdbeComment((v, "LIMIT+OFFSET"));
  109023. }
  109024. }
  109025. }
  109026. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  109027. /*
  109028. ** Return the appropriate collating sequence for the iCol-th column of
  109029. ** the result set for the compound-select statement "p". Return NULL if
  109030. ** the column has no default collating sequence.
  109031. **
  109032. ** The collating sequence for the compound select is taken from the
  109033. ** left-most term of the select that has a collating sequence.
  109034. */
  109035. static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
  109036. CollSeq *pRet;
  109037. if( p->pPrior ){
  109038. pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
  109039. }else{
  109040. pRet = 0;
  109041. }
  109042. assert( iCol>=0 );
  109043. /* iCol must be less than p->pEList->nExpr. Otherwise an error would
  109044. ** have been thrown during name resolution and we would not have gotten
  109045. ** this far */
  109046. if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
  109047. pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
  109048. }
  109049. return pRet;
  109050. }
  109051. /*
  109052. ** The select statement passed as the second parameter is a compound SELECT
  109053. ** with an ORDER BY clause. This function allocates and returns a KeyInfo
  109054. ** structure suitable for implementing the ORDER BY.
  109055. **
  109056. ** Space to hold the KeyInfo structure is obtained from malloc. The calling
  109057. ** function is responsible for ensuring that this structure is eventually
  109058. ** freed.
  109059. */
  109060. static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
  109061. ExprList *pOrderBy = p->pOrderBy;
  109062. int nOrderBy = p->pOrderBy->nExpr;
  109063. sqlite3 *db = pParse->db;
  109064. KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
  109065. if( pRet ){
  109066. int i;
  109067. for(i=0; i<nOrderBy; i++){
  109068. struct ExprList_item *pItem = &pOrderBy->a[i];
  109069. Expr *pTerm = pItem->pExpr;
  109070. CollSeq *pColl;
  109071. if( pTerm->flags & EP_Collate ){
  109072. pColl = sqlite3ExprCollSeq(pParse, pTerm);
  109073. }else{
  109074. pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
  109075. if( pColl==0 ) pColl = db->pDfltColl;
  109076. pOrderBy->a[i].pExpr =
  109077. sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
  109078. }
  109079. assert( sqlite3KeyInfoIsWriteable(pRet) );
  109080. pRet->aColl[i] = pColl;
  109081. pRet->aSortOrder[i] = pOrderBy->a[i].sortOrder;
  109082. }
  109083. }
  109084. return pRet;
  109085. }
  109086. #ifndef SQLITE_OMIT_CTE
  109087. /*
  109088. ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
  109089. ** query of the form:
  109090. **
  109091. ** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
  109092. ** \___________/ \_______________/
  109093. ** p->pPrior p
  109094. **
  109095. **
  109096. ** There is exactly one reference to the recursive-table in the FROM clause
  109097. ** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
  109098. **
  109099. ** The setup-query runs once to generate an initial set of rows that go
  109100. ** into a Queue table. Rows are extracted from the Queue table one by
  109101. ** one. Each row extracted from Queue is output to pDest. Then the single
  109102. ** extracted row (now in the iCurrent table) becomes the content of the
  109103. ** recursive-table for a recursive-query run. The output of the recursive-query
  109104. ** is added back into the Queue table. Then another row is extracted from Queue
  109105. ** and the iteration continues until the Queue table is empty.
  109106. **
  109107. ** If the compound query operator is UNION then no duplicate rows are ever
  109108. ** inserted into the Queue table. The iDistinct table keeps a copy of all rows
  109109. ** that have ever been inserted into Queue and causes duplicates to be
  109110. ** discarded. If the operator is UNION ALL, then duplicates are allowed.
  109111. **
  109112. ** If the query has an ORDER BY, then entries in the Queue table are kept in
  109113. ** ORDER BY order and the first entry is extracted for each cycle. Without
  109114. ** an ORDER BY, the Queue table is just a FIFO.
  109115. **
  109116. ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
  109117. ** have been output to pDest. A LIMIT of zero means to output no rows and a
  109118. ** negative LIMIT means to output all rows. If there is also an OFFSET clause
  109119. ** with a positive value, then the first OFFSET outputs are discarded rather
  109120. ** than being sent to pDest. The LIMIT count does not begin until after OFFSET
  109121. ** rows have been skipped.
  109122. */
  109123. static void generateWithRecursiveQuery(
  109124. Parse *pParse, /* Parsing context */
  109125. Select *p, /* The recursive SELECT to be coded */
  109126. SelectDest *pDest /* What to do with query results */
  109127. ){
  109128. SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
  109129. int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
  109130. Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
  109131. Select *pSetup = p->pPrior; /* The setup query */
  109132. int addrTop; /* Top of the loop */
  109133. int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
  109134. int iCurrent = 0; /* The Current table */
  109135. int regCurrent; /* Register holding Current table */
  109136. int iQueue; /* The Queue table */
  109137. int iDistinct = 0; /* To ensure unique results if UNION */
  109138. int eDest = SRT_Fifo; /* How to write to Queue */
  109139. SelectDest destQueue; /* SelectDest targetting the Queue table */
  109140. int i; /* Loop counter */
  109141. int rc; /* Result code */
  109142. ExprList *pOrderBy; /* The ORDER BY clause */
  109143. Expr *pLimit, *pOffset; /* Saved LIMIT and OFFSET */
  109144. int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
  109145. /* Obtain authorization to do a recursive query */
  109146. if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
  109147. /* Process the LIMIT and OFFSET clauses, if they exist */
  109148. addrBreak = sqlite3VdbeMakeLabel(v);
  109149. computeLimitRegisters(pParse, p, addrBreak);
  109150. pLimit = p->pLimit;
  109151. pOffset = p->pOffset;
  109152. regLimit = p->iLimit;
  109153. regOffset = p->iOffset;
  109154. p->pLimit = p->pOffset = 0;
  109155. p->iLimit = p->iOffset = 0;
  109156. pOrderBy = p->pOrderBy;
  109157. /* Locate the cursor number of the Current table */
  109158. for(i=0; ALWAYS(i<pSrc->nSrc); i++){
  109159. if( pSrc->a[i].fg.isRecursive ){
  109160. iCurrent = pSrc->a[i].iCursor;
  109161. break;
  109162. }
  109163. }
  109164. /* Allocate cursors numbers for Queue and Distinct. The cursor number for
  109165. ** the Distinct table must be exactly one greater than Queue in order
  109166. ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
  109167. iQueue = pParse->nTab++;
  109168. if( p->op==TK_UNION ){
  109169. eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
  109170. iDistinct = pParse->nTab++;
  109171. }else{
  109172. eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
  109173. }
  109174. sqlite3SelectDestInit(&destQueue, eDest, iQueue);
  109175. /* Allocate cursors for Current, Queue, and Distinct. */
  109176. regCurrent = ++pParse->nMem;
  109177. sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
  109178. if( pOrderBy ){
  109179. KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
  109180. sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
  109181. (char*)pKeyInfo, P4_KEYINFO);
  109182. destQueue.pOrderBy = pOrderBy;
  109183. }else{
  109184. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
  109185. }
  109186. VdbeComment((v, "Queue table"));
  109187. if( iDistinct ){
  109188. p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
  109189. p->selFlags |= SF_UsesEphemeral;
  109190. }
  109191. /* Detach the ORDER BY clause from the compound SELECT */
  109192. p->pOrderBy = 0;
  109193. /* Store the results of the setup-query in Queue. */
  109194. pSetup->pNext = 0;
  109195. rc = sqlite3Select(pParse, pSetup, &destQueue);
  109196. pSetup->pNext = p;
  109197. if( rc ) goto end_of_recursive_query;
  109198. /* Find the next row in the Queue and output that row */
  109199. addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
  109200. /* Transfer the next row in Queue over to Current */
  109201. sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
  109202. if( pOrderBy ){
  109203. sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
  109204. }else{
  109205. sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
  109206. }
  109207. sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
  109208. /* Output the single row in Current */
  109209. addrCont = sqlite3VdbeMakeLabel(v);
  109210. codeOffset(v, regOffset, addrCont);
  109211. selectInnerLoop(pParse, p, p->pEList, iCurrent,
  109212. 0, 0, pDest, addrCont, addrBreak);
  109213. if( regLimit ){
  109214. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
  109215. VdbeCoverage(v);
  109216. }
  109217. sqlite3VdbeResolveLabel(v, addrCont);
  109218. /* Execute the recursive SELECT taking the single row in Current as
  109219. ** the value for the recursive-table. Store the results in the Queue.
  109220. */
  109221. if( p->selFlags & SF_Aggregate ){
  109222. sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
  109223. }else{
  109224. p->pPrior = 0;
  109225. sqlite3Select(pParse, p, &destQueue);
  109226. assert( p->pPrior==0 );
  109227. p->pPrior = pSetup;
  109228. }
  109229. /* Keep running the loop until the Queue is empty */
  109230. sqlite3VdbeGoto(v, addrTop);
  109231. sqlite3VdbeResolveLabel(v, addrBreak);
  109232. end_of_recursive_query:
  109233. sqlite3ExprListDelete(pParse->db, p->pOrderBy);
  109234. p->pOrderBy = pOrderBy;
  109235. p->pLimit = pLimit;
  109236. p->pOffset = pOffset;
  109237. return;
  109238. }
  109239. #endif /* SQLITE_OMIT_CTE */
  109240. /* Forward references */
  109241. static int multiSelectOrderBy(
  109242. Parse *pParse, /* Parsing context */
  109243. Select *p, /* The right-most of SELECTs to be coded */
  109244. SelectDest *pDest /* What to do with query results */
  109245. );
  109246. /*
  109247. ** Handle the special case of a compound-select that originates from a
  109248. ** VALUES clause. By handling this as a special case, we avoid deep
  109249. ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
  109250. ** on a VALUES clause.
  109251. **
  109252. ** Because the Select object originates from a VALUES clause:
  109253. ** (1) It has no LIMIT or OFFSET
  109254. ** (2) All terms are UNION ALL
  109255. ** (3) There is no ORDER BY clause
  109256. */
  109257. static int multiSelectValues(
  109258. Parse *pParse, /* Parsing context */
  109259. Select *p, /* The right-most of SELECTs to be coded */
  109260. SelectDest *pDest /* What to do with query results */
  109261. ){
  109262. Select *pPrior;
  109263. int nRow = 1;
  109264. int rc = 0;
  109265. assert( p->selFlags & SF_MultiValue );
  109266. do{
  109267. assert( p->selFlags & SF_Values );
  109268. assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
  109269. assert( p->pLimit==0 );
  109270. assert( p->pOffset==0 );
  109271. assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
  109272. if( p->pPrior==0 ) break;
  109273. assert( p->pPrior->pNext==p );
  109274. p = p->pPrior;
  109275. nRow++;
  109276. }while(1);
  109277. while( p ){
  109278. pPrior = p->pPrior;
  109279. p->pPrior = 0;
  109280. rc = sqlite3Select(pParse, p, pDest);
  109281. p->pPrior = pPrior;
  109282. if( rc ) break;
  109283. p->nSelectRow = nRow;
  109284. p = p->pNext;
  109285. }
  109286. return rc;
  109287. }
  109288. /*
  109289. ** This routine is called to process a compound query form from
  109290. ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
  109291. ** INTERSECT
  109292. **
  109293. ** "p" points to the right-most of the two queries. the query on the
  109294. ** left is p->pPrior. The left query could also be a compound query
  109295. ** in which case this routine will be called recursively.
  109296. **
  109297. ** The results of the total query are to be written into a destination
  109298. ** of type eDest with parameter iParm.
  109299. **
  109300. ** Example 1: Consider a three-way compound SQL statement.
  109301. **
  109302. ** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
  109303. **
  109304. ** This statement is parsed up as follows:
  109305. **
  109306. ** SELECT c FROM t3
  109307. ** |
  109308. ** `-----> SELECT b FROM t2
  109309. ** |
  109310. ** `------> SELECT a FROM t1
  109311. **
  109312. ** The arrows in the diagram above represent the Select.pPrior pointer.
  109313. ** So if this routine is called with p equal to the t3 query, then
  109314. ** pPrior will be the t2 query. p->op will be TK_UNION in this case.
  109315. **
  109316. ** Notice that because of the way SQLite parses compound SELECTs, the
  109317. ** individual selects always group from left to right.
  109318. */
  109319. static int multiSelect(
  109320. Parse *pParse, /* Parsing context */
  109321. Select *p, /* The right-most of SELECTs to be coded */
  109322. SelectDest *pDest /* What to do with query results */
  109323. ){
  109324. int rc = SQLITE_OK; /* Success code from a subroutine */
  109325. Select *pPrior; /* Another SELECT immediately to our left */
  109326. Vdbe *v; /* Generate code to this VDBE */
  109327. SelectDest dest; /* Alternative data destination */
  109328. Select *pDelete = 0; /* Chain of simple selects to delete */
  109329. sqlite3 *db; /* Database connection */
  109330. #ifndef SQLITE_OMIT_EXPLAIN
  109331. int iSub1 = 0; /* EQP id of left-hand query */
  109332. int iSub2 = 0; /* EQP id of right-hand query */
  109333. #endif
  109334. /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
  109335. ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
  109336. */
  109337. assert( p && p->pPrior ); /* Calling function guarantees this much */
  109338. assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
  109339. db = pParse->db;
  109340. pPrior = p->pPrior;
  109341. dest = *pDest;
  109342. if( pPrior->pOrderBy ){
  109343. sqlite3ErrorMsg(pParse,"ORDER BY clause should come after %s not before",
  109344. selectOpName(p->op));
  109345. rc = 1;
  109346. goto multi_select_end;
  109347. }
  109348. if( pPrior->pLimit ){
  109349. sqlite3ErrorMsg(pParse,"LIMIT clause should come after %s not before",
  109350. selectOpName(p->op));
  109351. rc = 1;
  109352. goto multi_select_end;
  109353. }
  109354. v = sqlite3GetVdbe(pParse);
  109355. assert( v!=0 ); /* The VDBE already created by calling function */
  109356. /* Create the destination temporary table if necessary
  109357. */
  109358. if( dest.eDest==SRT_EphemTab ){
  109359. assert( p->pEList );
  109360. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
  109361. dest.eDest = SRT_Table;
  109362. }
  109363. /* Special handling for a compound-select that originates as a VALUES clause.
  109364. */
  109365. if( p->selFlags & SF_MultiValue ){
  109366. rc = multiSelectValues(pParse, p, &dest);
  109367. goto multi_select_end;
  109368. }
  109369. /* Make sure all SELECTs in the statement have the same number of elements
  109370. ** in their result sets.
  109371. */
  109372. assert( p->pEList && pPrior->pEList );
  109373. assert( p->pEList->nExpr==pPrior->pEList->nExpr );
  109374. #ifndef SQLITE_OMIT_CTE
  109375. if( p->selFlags & SF_Recursive ){
  109376. generateWithRecursiveQuery(pParse, p, &dest);
  109377. }else
  109378. #endif
  109379. /* Compound SELECTs that have an ORDER BY clause are handled separately.
  109380. */
  109381. if( p->pOrderBy ){
  109382. return multiSelectOrderBy(pParse, p, pDest);
  109383. }else
  109384. /* Generate code for the left and right SELECT statements.
  109385. */
  109386. switch( p->op ){
  109387. case TK_ALL: {
  109388. int addr = 0;
  109389. int nLimit;
  109390. assert( !pPrior->pLimit );
  109391. pPrior->iLimit = p->iLimit;
  109392. pPrior->iOffset = p->iOffset;
  109393. pPrior->pLimit = p->pLimit;
  109394. pPrior->pOffset = p->pOffset;
  109395. explainSetInteger(iSub1, pParse->iNextSelectId);
  109396. rc = sqlite3Select(pParse, pPrior, &dest);
  109397. p->pLimit = 0;
  109398. p->pOffset = 0;
  109399. if( rc ){
  109400. goto multi_select_end;
  109401. }
  109402. p->pPrior = 0;
  109403. p->iLimit = pPrior->iLimit;
  109404. p->iOffset = pPrior->iOffset;
  109405. if( p->iLimit ){
  109406. addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
  109407. VdbeComment((v, "Jump ahead if LIMIT reached"));
  109408. if( p->iOffset ){
  109409. sqlite3VdbeAddOp3(v, OP_OffsetLimit,
  109410. p->iLimit, p->iOffset+1, p->iOffset);
  109411. }
  109412. }
  109413. explainSetInteger(iSub2, pParse->iNextSelectId);
  109414. rc = sqlite3Select(pParse, p, &dest);
  109415. testcase( rc!=SQLITE_OK );
  109416. pDelete = p->pPrior;
  109417. p->pPrior = pPrior;
  109418. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  109419. if( pPrior->pLimit
  109420. && sqlite3ExprIsInteger(pPrior->pLimit, &nLimit)
  109421. && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
  109422. ){
  109423. p->nSelectRow = sqlite3LogEst((u64)nLimit);
  109424. }
  109425. if( addr ){
  109426. sqlite3VdbeJumpHere(v, addr);
  109427. }
  109428. break;
  109429. }
  109430. case TK_EXCEPT:
  109431. case TK_UNION: {
  109432. int unionTab; /* Cursor number of the temporary table holding result */
  109433. u8 op = 0; /* One of the SRT_ operations to apply to self */
  109434. int priorOp; /* The SRT_ operation to apply to prior selects */
  109435. Expr *pLimit, *pOffset; /* Saved values of p->nLimit and p->nOffset */
  109436. int addr;
  109437. SelectDest uniondest;
  109438. testcase( p->op==TK_EXCEPT );
  109439. testcase( p->op==TK_UNION );
  109440. priorOp = SRT_Union;
  109441. if( dest.eDest==priorOp ){
  109442. /* We can reuse a temporary table generated by a SELECT to our
  109443. ** right.
  109444. */
  109445. assert( p->pLimit==0 ); /* Not allowed on leftward elements */
  109446. assert( p->pOffset==0 ); /* Not allowed on leftward elements */
  109447. unionTab = dest.iSDParm;
  109448. }else{
  109449. /* We will need to create our own temporary table to hold the
  109450. ** intermediate results.
  109451. */
  109452. unionTab = pParse->nTab++;
  109453. assert( p->pOrderBy==0 );
  109454. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
  109455. assert( p->addrOpenEphm[0] == -1 );
  109456. p->addrOpenEphm[0] = addr;
  109457. findRightmost(p)->selFlags |= SF_UsesEphemeral;
  109458. assert( p->pEList );
  109459. }
  109460. /* Code the SELECT statements to our left
  109461. */
  109462. assert( !pPrior->pOrderBy );
  109463. sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
  109464. explainSetInteger(iSub1, pParse->iNextSelectId);
  109465. rc = sqlite3Select(pParse, pPrior, &uniondest);
  109466. if( rc ){
  109467. goto multi_select_end;
  109468. }
  109469. /* Code the current SELECT statement
  109470. */
  109471. if( p->op==TK_EXCEPT ){
  109472. op = SRT_Except;
  109473. }else{
  109474. assert( p->op==TK_UNION );
  109475. op = SRT_Union;
  109476. }
  109477. p->pPrior = 0;
  109478. pLimit = p->pLimit;
  109479. p->pLimit = 0;
  109480. pOffset = p->pOffset;
  109481. p->pOffset = 0;
  109482. uniondest.eDest = op;
  109483. explainSetInteger(iSub2, pParse->iNextSelectId);
  109484. rc = sqlite3Select(pParse, p, &uniondest);
  109485. testcase( rc!=SQLITE_OK );
  109486. /* Query flattening in sqlite3Select() might refill p->pOrderBy.
  109487. ** Be sure to delete p->pOrderBy, therefore, to avoid a memory leak. */
  109488. sqlite3ExprListDelete(db, p->pOrderBy);
  109489. pDelete = p->pPrior;
  109490. p->pPrior = pPrior;
  109491. p->pOrderBy = 0;
  109492. if( p->op==TK_UNION ){
  109493. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  109494. }
  109495. sqlite3ExprDelete(db, p->pLimit);
  109496. p->pLimit = pLimit;
  109497. p->pOffset = pOffset;
  109498. p->iLimit = 0;
  109499. p->iOffset = 0;
  109500. /* Convert the data in the temporary table into whatever form
  109501. ** it is that we currently need.
  109502. */
  109503. assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
  109504. if( dest.eDest!=priorOp ){
  109505. int iCont, iBreak, iStart;
  109506. assert( p->pEList );
  109507. if( dest.eDest==SRT_Output ){
  109508. Select *pFirst = p;
  109509. while( pFirst->pPrior ) pFirst = pFirst->pPrior;
  109510. generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
  109511. }
  109512. iBreak = sqlite3VdbeMakeLabel(v);
  109513. iCont = sqlite3VdbeMakeLabel(v);
  109514. computeLimitRegisters(pParse, p, iBreak);
  109515. sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
  109516. iStart = sqlite3VdbeCurrentAddr(v);
  109517. selectInnerLoop(pParse, p, p->pEList, unionTab,
  109518. 0, 0, &dest, iCont, iBreak);
  109519. sqlite3VdbeResolveLabel(v, iCont);
  109520. sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
  109521. sqlite3VdbeResolveLabel(v, iBreak);
  109522. sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
  109523. }
  109524. break;
  109525. }
  109526. default: assert( p->op==TK_INTERSECT ); {
  109527. int tab1, tab2;
  109528. int iCont, iBreak, iStart;
  109529. Expr *pLimit, *pOffset;
  109530. int addr;
  109531. SelectDest intersectdest;
  109532. int r1;
  109533. /* INTERSECT is different from the others since it requires
  109534. ** two temporary tables. Hence it has its own case. Begin
  109535. ** by allocating the tables we will need.
  109536. */
  109537. tab1 = pParse->nTab++;
  109538. tab2 = pParse->nTab++;
  109539. assert( p->pOrderBy==0 );
  109540. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
  109541. assert( p->addrOpenEphm[0] == -1 );
  109542. p->addrOpenEphm[0] = addr;
  109543. findRightmost(p)->selFlags |= SF_UsesEphemeral;
  109544. assert( p->pEList );
  109545. /* Code the SELECTs to our left into temporary table "tab1".
  109546. */
  109547. sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
  109548. explainSetInteger(iSub1, pParse->iNextSelectId);
  109549. rc = sqlite3Select(pParse, pPrior, &intersectdest);
  109550. if( rc ){
  109551. goto multi_select_end;
  109552. }
  109553. /* Code the current SELECT into temporary table "tab2"
  109554. */
  109555. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
  109556. assert( p->addrOpenEphm[1] == -1 );
  109557. p->addrOpenEphm[1] = addr;
  109558. p->pPrior = 0;
  109559. pLimit = p->pLimit;
  109560. p->pLimit = 0;
  109561. pOffset = p->pOffset;
  109562. p->pOffset = 0;
  109563. intersectdest.iSDParm = tab2;
  109564. explainSetInteger(iSub2, pParse->iNextSelectId);
  109565. rc = sqlite3Select(pParse, p, &intersectdest);
  109566. testcase( rc!=SQLITE_OK );
  109567. pDelete = p->pPrior;
  109568. p->pPrior = pPrior;
  109569. if( p->nSelectRow>pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
  109570. sqlite3ExprDelete(db, p->pLimit);
  109571. p->pLimit = pLimit;
  109572. p->pOffset = pOffset;
  109573. /* Generate code to take the intersection of the two temporary
  109574. ** tables.
  109575. */
  109576. assert( p->pEList );
  109577. if( dest.eDest==SRT_Output ){
  109578. Select *pFirst = p;
  109579. while( pFirst->pPrior ) pFirst = pFirst->pPrior;
  109580. generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
  109581. }
  109582. iBreak = sqlite3VdbeMakeLabel(v);
  109583. iCont = sqlite3VdbeMakeLabel(v);
  109584. computeLimitRegisters(pParse, p, iBreak);
  109585. sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
  109586. r1 = sqlite3GetTempReg(pParse);
  109587. iStart = sqlite3VdbeAddOp2(v, OP_RowKey, tab1, r1);
  109588. sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0); VdbeCoverage(v);
  109589. sqlite3ReleaseTempReg(pParse, r1);
  109590. selectInnerLoop(pParse, p, p->pEList, tab1,
  109591. 0, 0, &dest, iCont, iBreak);
  109592. sqlite3VdbeResolveLabel(v, iCont);
  109593. sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
  109594. sqlite3VdbeResolveLabel(v, iBreak);
  109595. sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
  109596. sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
  109597. break;
  109598. }
  109599. }
  109600. explainComposite(pParse, p->op, iSub1, iSub2, p->op!=TK_ALL);
  109601. /* Compute collating sequences used by
  109602. ** temporary tables needed to implement the compound select.
  109603. ** Attach the KeyInfo structure to all temporary tables.
  109604. **
  109605. ** This section is run by the right-most SELECT statement only.
  109606. ** SELECT statements to the left always skip this part. The right-most
  109607. ** SELECT might also skip this part if it has no ORDER BY clause and
  109608. ** no temp tables are required.
  109609. */
  109610. if( p->selFlags & SF_UsesEphemeral ){
  109611. int i; /* Loop counter */
  109612. KeyInfo *pKeyInfo; /* Collating sequence for the result set */
  109613. Select *pLoop; /* For looping through SELECT statements */
  109614. CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
  109615. int nCol; /* Number of columns in result set */
  109616. assert( p->pNext==0 );
  109617. nCol = p->pEList->nExpr;
  109618. pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
  109619. if( !pKeyInfo ){
  109620. rc = SQLITE_NOMEM_BKPT;
  109621. goto multi_select_end;
  109622. }
  109623. for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
  109624. *apColl = multiSelectCollSeq(pParse, p, i);
  109625. if( 0==*apColl ){
  109626. *apColl = db->pDfltColl;
  109627. }
  109628. }
  109629. for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
  109630. for(i=0; i<2; i++){
  109631. int addr = pLoop->addrOpenEphm[i];
  109632. if( addr<0 ){
  109633. /* If [0] is unused then [1] is also unused. So we can
  109634. ** always safely abort as soon as the first unused slot is found */
  109635. assert( pLoop->addrOpenEphm[1]<0 );
  109636. break;
  109637. }
  109638. sqlite3VdbeChangeP2(v, addr, nCol);
  109639. sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
  109640. P4_KEYINFO);
  109641. pLoop->addrOpenEphm[i] = -1;
  109642. }
  109643. }
  109644. sqlite3KeyInfoUnref(pKeyInfo);
  109645. }
  109646. multi_select_end:
  109647. pDest->iSdst = dest.iSdst;
  109648. pDest->nSdst = dest.nSdst;
  109649. sqlite3SelectDelete(db, pDelete);
  109650. return rc;
  109651. }
  109652. #endif /* SQLITE_OMIT_COMPOUND_SELECT */
  109653. /*
  109654. ** Error message for when two or more terms of a compound select have different
  109655. ** size result sets.
  109656. */
  109657. SQLITE_PRIVATE void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
  109658. if( p->selFlags & SF_Values ){
  109659. sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
  109660. }else{
  109661. sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
  109662. " do not have the same number of result columns", selectOpName(p->op));
  109663. }
  109664. }
  109665. /*
  109666. ** Code an output subroutine for a coroutine implementation of a
  109667. ** SELECT statment.
  109668. **
  109669. ** The data to be output is contained in pIn->iSdst. There are
  109670. ** pIn->nSdst columns to be output. pDest is where the output should
  109671. ** be sent.
  109672. **
  109673. ** regReturn is the number of the register holding the subroutine
  109674. ** return address.
  109675. **
  109676. ** If regPrev>0 then it is the first register in a vector that
  109677. ** records the previous output. mem[regPrev] is a flag that is false
  109678. ** if there has been no previous output. If regPrev>0 then code is
  109679. ** generated to suppress duplicates. pKeyInfo is used for comparing
  109680. ** keys.
  109681. **
  109682. ** If the LIMIT found in p->iLimit is reached, jump immediately to
  109683. ** iBreak.
  109684. */
  109685. static int generateOutputSubroutine(
  109686. Parse *pParse, /* Parsing context */
  109687. Select *p, /* The SELECT statement */
  109688. SelectDest *pIn, /* Coroutine supplying data */
  109689. SelectDest *pDest, /* Where to send the data */
  109690. int regReturn, /* The return address register */
  109691. int regPrev, /* Previous result register. No uniqueness if 0 */
  109692. KeyInfo *pKeyInfo, /* For comparing with previous entry */
  109693. int iBreak /* Jump here if we hit the LIMIT */
  109694. ){
  109695. Vdbe *v = pParse->pVdbe;
  109696. int iContinue;
  109697. int addr;
  109698. addr = sqlite3VdbeCurrentAddr(v);
  109699. iContinue = sqlite3VdbeMakeLabel(v);
  109700. /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
  109701. */
  109702. if( regPrev ){
  109703. int addr1, addr2;
  109704. addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
  109705. addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
  109706. (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
  109707. sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
  109708. sqlite3VdbeJumpHere(v, addr1);
  109709. sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
  109710. sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
  109711. }
  109712. if( pParse->db->mallocFailed ) return 0;
  109713. /* Suppress the first OFFSET entries if there is an OFFSET clause
  109714. */
  109715. codeOffset(v, p->iOffset, iContinue);
  109716. assert( pDest->eDest!=SRT_Exists );
  109717. assert( pDest->eDest!=SRT_Table );
  109718. switch( pDest->eDest ){
  109719. /* Store the result as data using a unique key.
  109720. */
  109721. case SRT_EphemTab: {
  109722. int r1 = sqlite3GetTempReg(pParse);
  109723. int r2 = sqlite3GetTempReg(pParse);
  109724. sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
  109725. sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
  109726. sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
  109727. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  109728. sqlite3ReleaseTempReg(pParse, r2);
  109729. sqlite3ReleaseTempReg(pParse, r1);
  109730. break;
  109731. }
  109732. #ifndef SQLITE_OMIT_SUBQUERY
  109733. /* If we are creating a set for an "expr IN (SELECT ...)".
  109734. */
  109735. case SRT_Set: {
  109736. int r1;
  109737. testcase( pIn->nSdst>1 );
  109738. r1 = sqlite3GetTempReg(pParse);
  109739. sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
  109740. r1, pDest->zAffSdst, pIn->nSdst);
  109741. sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
  109742. sqlite3VdbeAddOp2(v, OP_IdxInsert, pDest->iSDParm, r1);
  109743. sqlite3ReleaseTempReg(pParse, r1);
  109744. break;
  109745. }
  109746. /* If this is a scalar select that is part of an expression, then
  109747. ** store the results in the appropriate memory cell and break out
  109748. ** of the scan loop.
  109749. */
  109750. case SRT_Mem: {
  109751. assert( pIn->nSdst==1 || pParse->nErr>0 ); testcase( pIn->nSdst!=1 );
  109752. sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, 1);
  109753. /* The LIMIT clause will jump out of the loop for us */
  109754. break;
  109755. }
  109756. #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
  109757. /* The results are stored in a sequence of registers
  109758. ** starting at pDest->iSdst. Then the co-routine yields.
  109759. */
  109760. case SRT_Coroutine: {
  109761. if( pDest->iSdst==0 ){
  109762. pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
  109763. pDest->nSdst = pIn->nSdst;
  109764. }
  109765. sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
  109766. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  109767. break;
  109768. }
  109769. /* If none of the above, then the result destination must be
  109770. ** SRT_Output. This routine is never called with any other
  109771. ** destination other than the ones handled above or SRT_Output.
  109772. **
  109773. ** For SRT_Output, results are stored in a sequence of registers.
  109774. ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
  109775. ** return the next row of result.
  109776. */
  109777. default: {
  109778. assert( pDest->eDest==SRT_Output );
  109779. sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
  109780. sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
  109781. break;
  109782. }
  109783. }
  109784. /* Jump to the end of the loop if the LIMIT is reached.
  109785. */
  109786. if( p->iLimit ){
  109787. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
  109788. }
  109789. /* Generate the subroutine return
  109790. */
  109791. sqlite3VdbeResolveLabel(v, iContinue);
  109792. sqlite3VdbeAddOp1(v, OP_Return, regReturn);
  109793. return addr;
  109794. }
  109795. /*
  109796. ** Alternative compound select code generator for cases when there
  109797. ** is an ORDER BY clause.
  109798. **
  109799. ** We assume a query of the following form:
  109800. **
  109801. ** <selectA> <operator> <selectB> ORDER BY <orderbylist>
  109802. **
  109803. ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
  109804. ** is to code both <selectA> and <selectB> with the ORDER BY clause as
  109805. ** co-routines. Then run the co-routines in parallel and merge the results
  109806. ** into the output. In addition to the two coroutines (called selectA and
  109807. ** selectB) there are 7 subroutines:
  109808. **
  109809. ** outA: Move the output of the selectA coroutine into the output
  109810. ** of the compound query.
  109811. **
  109812. ** outB: Move the output of the selectB coroutine into the output
  109813. ** of the compound query. (Only generated for UNION and
  109814. ** UNION ALL. EXCEPT and INSERTSECT never output a row that
  109815. ** appears only in B.)
  109816. **
  109817. ** AltB: Called when there is data from both coroutines and A<B.
  109818. **
  109819. ** AeqB: Called when there is data from both coroutines and A==B.
  109820. **
  109821. ** AgtB: Called when there is data from both coroutines and A>B.
  109822. **
  109823. ** EofA: Called when data is exhausted from selectA.
  109824. **
  109825. ** EofB: Called when data is exhausted from selectB.
  109826. **
  109827. ** The implementation of the latter five subroutines depend on which
  109828. ** <operator> is used:
  109829. **
  109830. **
  109831. ** UNION ALL UNION EXCEPT INTERSECT
  109832. ** ------------- ----------------- -------------- -----------------
  109833. ** AltB: outA, nextA outA, nextA outA, nextA nextA
  109834. **
  109835. ** AeqB: outA, nextA nextA nextA outA, nextA
  109836. **
  109837. ** AgtB: outB, nextB outB, nextB nextB nextB
  109838. **
  109839. ** EofA: outB, nextB outB, nextB halt halt
  109840. **
  109841. ** EofB: outA, nextA outA, nextA outA, nextA halt
  109842. **
  109843. ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
  109844. ** causes an immediate jump to EofA and an EOF on B following nextB causes
  109845. ** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
  109846. ** following nextX causes a jump to the end of the select processing.
  109847. **
  109848. ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
  109849. ** within the output subroutine. The regPrev register set holds the previously
  109850. ** output value. A comparison is made against this value and the output
  109851. ** is skipped if the next results would be the same as the previous.
  109852. **
  109853. ** The implementation plan is to implement the two coroutines and seven
  109854. ** subroutines first, then put the control logic at the bottom. Like this:
  109855. **
  109856. ** goto Init
  109857. ** coA: coroutine for left query (A)
  109858. ** coB: coroutine for right query (B)
  109859. ** outA: output one row of A
  109860. ** outB: output one row of B (UNION and UNION ALL only)
  109861. ** EofA: ...
  109862. ** EofB: ...
  109863. ** AltB: ...
  109864. ** AeqB: ...
  109865. ** AgtB: ...
  109866. ** Init: initialize coroutine registers
  109867. ** yield coA
  109868. ** if eof(A) goto EofA
  109869. ** yield coB
  109870. ** if eof(B) goto EofB
  109871. ** Cmpr: Compare A, B
  109872. ** Jump AltB, AeqB, AgtB
  109873. ** End: ...
  109874. **
  109875. ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
  109876. ** actually called using Gosub and they do not Return. EofA and EofB loop
  109877. ** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
  109878. ** and AgtB jump to either L2 or to one of EofA or EofB.
  109879. */
  109880. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  109881. static int multiSelectOrderBy(
  109882. Parse *pParse, /* Parsing context */
  109883. Select *p, /* The right-most of SELECTs to be coded */
  109884. SelectDest *pDest /* What to do with query results */
  109885. ){
  109886. int i, j; /* Loop counters */
  109887. Select *pPrior; /* Another SELECT immediately to our left */
  109888. Vdbe *v; /* Generate code to this VDBE */
  109889. SelectDest destA; /* Destination for coroutine A */
  109890. SelectDest destB; /* Destination for coroutine B */
  109891. int regAddrA; /* Address register for select-A coroutine */
  109892. int regAddrB; /* Address register for select-B coroutine */
  109893. int addrSelectA; /* Address of the select-A coroutine */
  109894. int addrSelectB; /* Address of the select-B coroutine */
  109895. int regOutA; /* Address register for the output-A subroutine */
  109896. int regOutB; /* Address register for the output-B subroutine */
  109897. int addrOutA; /* Address of the output-A subroutine */
  109898. int addrOutB = 0; /* Address of the output-B subroutine */
  109899. int addrEofA; /* Address of the select-A-exhausted subroutine */
  109900. int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
  109901. int addrEofB; /* Address of the select-B-exhausted subroutine */
  109902. int addrAltB; /* Address of the A<B subroutine */
  109903. int addrAeqB; /* Address of the A==B subroutine */
  109904. int addrAgtB; /* Address of the A>B subroutine */
  109905. int regLimitA; /* Limit register for select-A */
  109906. int regLimitB; /* Limit register for select-A */
  109907. int regPrev; /* A range of registers to hold previous output */
  109908. int savedLimit; /* Saved value of p->iLimit */
  109909. int savedOffset; /* Saved value of p->iOffset */
  109910. int labelCmpr; /* Label for the start of the merge algorithm */
  109911. int labelEnd; /* Label for the end of the overall SELECT stmt */
  109912. int addr1; /* Jump instructions that get retargetted */
  109913. int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
  109914. KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
  109915. KeyInfo *pKeyMerge; /* Comparison information for merging rows */
  109916. sqlite3 *db; /* Database connection */
  109917. ExprList *pOrderBy; /* The ORDER BY clause */
  109918. int nOrderBy; /* Number of terms in the ORDER BY clause */
  109919. int *aPermute; /* Mapping from ORDER BY terms to result set columns */
  109920. #ifndef SQLITE_OMIT_EXPLAIN
  109921. int iSub1; /* EQP id of left-hand query */
  109922. int iSub2; /* EQP id of right-hand query */
  109923. #endif
  109924. assert( p->pOrderBy!=0 );
  109925. assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
  109926. db = pParse->db;
  109927. v = pParse->pVdbe;
  109928. assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
  109929. labelEnd = sqlite3VdbeMakeLabel(v);
  109930. labelCmpr = sqlite3VdbeMakeLabel(v);
  109931. /* Patch up the ORDER BY clause
  109932. */
  109933. op = p->op;
  109934. pPrior = p->pPrior;
  109935. assert( pPrior->pOrderBy==0 );
  109936. pOrderBy = p->pOrderBy;
  109937. assert( pOrderBy );
  109938. nOrderBy = pOrderBy->nExpr;
  109939. /* For operators other than UNION ALL we have to make sure that
  109940. ** the ORDER BY clause covers every term of the result set. Add
  109941. ** terms to the ORDER BY clause as necessary.
  109942. */
  109943. if( op!=TK_ALL ){
  109944. for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
  109945. struct ExprList_item *pItem;
  109946. for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
  109947. assert( pItem->u.x.iOrderByCol>0 );
  109948. if( pItem->u.x.iOrderByCol==i ) break;
  109949. }
  109950. if( j==nOrderBy ){
  109951. Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
  109952. if( pNew==0 ) return SQLITE_NOMEM_BKPT;
  109953. pNew->flags |= EP_IntValue;
  109954. pNew->u.iValue = i;
  109955. pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
  109956. if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
  109957. }
  109958. }
  109959. }
  109960. /* Compute the comparison permutation and keyinfo that is used with
  109961. ** the permutation used to determine if the next
  109962. ** row of results comes from selectA or selectB. Also add explicit
  109963. ** collations to the ORDER BY clause terms so that when the subqueries
  109964. ** to the right and the left are evaluated, they use the correct
  109965. ** collation.
  109966. */
  109967. aPermute = sqlite3DbMallocRawNN(db, sizeof(int)*(nOrderBy + 1));
  109968. if( aPermute ){
  109969. struct ExprList_item *pItem;
  109970. aPermute[0] = nOrderBy;
  109971. for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
  109972. assert( pItem->u.x.iOrderByCol>0 );
  109973. assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
  109974. aPermute[i] = pItem->u.x.iOrderByCol - 1;
  109975. }
  109976. pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
  109977. }else{
  109978. pKeyMerge = 0;
  109979. }
  109980. /* Reattach the ORDER BY clause to the query.
  109981. */
  109982. p->pOrderBy = pOrderBy;
  109983. pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
  109984. /* Allocate a range of temporary registers and the KeyInfo needed
  109985. ** for the logic that removes duplicate result rows when the
  109986. ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
  109987. */
  109988. if( op==TK_ALL ){
  109989. regPrev = 0;
  109990. }else{
  109991. int nExpr = p->pEList->nExpr;
  109992. assert( nOrderBy>=nExpr || db->mallocFailed );
  109993. regPrev = pParse->nMem+1;
  109994. pParse->nMem += nExpr+1;
  109995. sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
  109996. pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
  109997. if( pKeyDup ){
  109998. assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
  109999. for(i=0; i<nExpr; i++){
  110000. pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
  110001. pKeyDup->aSortOrder[i] = 0;
  110002. }
  110003. }
  110004. }
  110005. /* Separate the left and the right query from one another
  110006. */
  110007. p->pPrior = 0;
  110008. pPrior->pNext = 0;
  110009. sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
  110010. if( pPrior->pPrior==0 ){
  110011. sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
  110012. }
  110013. /* Compute the limit registers */
  110014. computeLimitRegisters(pParse, p, labelEnd);
  110015. if( p->iLimit && op==TK_ALL ){
  110016. regLimitA = ++pParse->nMem;
  110017. regLimitB = ++pParse->nMem;
  110018. sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
  110019. regLimitA);
  110020. sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
  110021. }else{
  110022. regLimitA = regLimitB = 0;
  110023. }
  110024. sqlite3ExprDelete(db, p->pLimit);
  110025. p->pLimit = 0;
  110026. sqlite3ExprDelete(db, p->pOffset);
  110027. p->pOffset = 0;
  110028. regAddrA = ++pParse->nMem;
  110029. regAddrB = ++pParse->nMem;
  110030. regOutA = ++pParse->nMem;
  110031. regOutB = ++pParse->nMem;
  110032. sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
  110033. sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
  110034. /* Generate a coroutine to evaluate the SELECT statement to the
  110035. ** left of the compound operator - the "A" select.
  110036. */
  110037. addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
  110038. addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
  110039. VdbeComment((v, "left SELECT"));
  110040. pPrior->iLimit = regLimitA;
  110041. explainSetInteger(iSub1, pParse->iNextSelectId);
  110042. sqlite3Select(pParse, pPrior, &destA);
  110043. sqlite3VdbeEndCoroutine(v, regAddrA);
  110044. sqlite3VdbeJumpHere(v, addr1);
  110045. /* Generate a coroutine to evaluate the SELECT statement on
  110046. ** the right - the "B" select
  110047. */
  110048. addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
  110049. addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
  110050. VdbeComment((v, "right SELECT"));
  110051. savedLimit = p->iLimit;
  110052. savedOffset = p->iOffset;
  110053. p->iLimit = regLimitB;
  110054. p->iOffset = 0;
  110055. explainSetInteger(iSub2, pParse->iNextSelectId);
  110056. sqlite3Select(pParse, p, &destB);
  110057. p->iLimit = savedLimit;
  110058. p->iOffset = savedOffset;
  110059. sqlite3VdbeEndCoroutine(v, regAddrB);
  110060. /* Generate a subroutine that outputs the current row of the A
  110061. ** select as the next output row of the compound select.
  110062. */
  110063. VdbeNoopComment((v, "Output routine for A"));
  110064. addrOutA = generateOutputSubroutine(pParse,
  110065. p, &destA, pDest, regOutA,
  110066. regPrev, pKeyDup, labelEnd);
  110067. /* Generate a subroutine that outputs the current row of the B
  110068. ** select as the next output row of the compound select.
  110069. */
  110070. if( op==TK_ALL || op==TK_UNION ){
  110071. VdbeNoopComment((v, "Output routine for B"));
  110072. addrOutB = generateOutputSubroutine(pParse,
  110073. p, &destB, pDest, regOutB,
  110074. regPrev, pKeyDup, labelEnd);
  110075. }
  110076. sqlite3KeyInfoUnref(pKeyDup);
  110077. /* Generate a subroutine to run when the results from select A
  110078. ** are exhausted and only data in select B remains.
  110079. */
  110080. if( op==TK_EXCEPT || op==TK_INTERSECT ){
  110081. addrEofA_noB = addrEofA = labelEnd;
  110082. }else{
  110083. VdbeNoopComment((v, "eof-A subroutine"));
  110084. addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
  110085. addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
  110086. VdbeCoverage(v);
  110087. sqlite3VdbeGoto(v, addrEofA);
  110088. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  110089. }
  110090. /* Generate a subroutine to run when the results from select B
  110091. ** are exhausted and only data in select A remains.
  110092. */
  110093. if( op==TK_INTERSECT ){
  110094. addrEofB = addrEofA;
  110095. if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
  110096. }else{
  110097. VdbeNoopComment((v, "eof-B subroutine"));
  110098. addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
  110099. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
  110100. sqlite3VdbeGoto(v, addrEofB);
  110101. }
  110102. /* Generate code to handle the case of A<B
  110103. */
  110104. VdbeNoopComment((v, "A-lt-B subroutine"));
  110105. addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
  110106. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
  110107. sqlite3VdbeGoto(v, labelCmpr);
  110108. /* Generate code to handle the case of A==B
  110109. */
  110110. if( op==TK_ALL ){
  110111. addrAeqB = addrAltB;
  110112. }else if( op==TK_INTERSECT ){
  110113. addrAeqB = addrAltB;
  110114. addrAltB++;
  110115. }else{
  110116. VdbeNoopComment((v, "A-eq-B subroutine"));
  110117. addrAeqB =
  110118. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
  110119. sqlite3VdbeGoto(v, labelCmpr);
  110120. }
  110121. /* Generate code to handle the case of A>B
  110122. */
  110123. VdbeNoopComment((v, "A-gt-B subroutine"));
  110124. addrAgtB = sqlite3VdbeCurrentAddr(v);
  110125. if( op==TK_ALL || op==TK_UNION ){
  110126. sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
  110127. }
  110128. sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
  110129. sqlite3VdbeGoto(v, labelCmpr);
  110130. /* This code runs once to initialize everything.
  110131. */
  110132. sqlite3VdbeJumpHere(v, addr1);
  110133. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
  110134. sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
  110135. /* Implement the main merge loop
  110136. */
  110137. sqlite3VdbeResolveLabel(v, labelCmpr);
  110138. sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
  110139. sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
  110140. (char*)pKeyMerge, P4_KEYINFO);
  110141. sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
  110142. sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
  110143. /* Jump to the this point in order to terminate the query.
  110144. */
  110145. sqlite3VdbeResolveLabel(v, labelEnd);
  110146. /* Set the number of output columns
  110147. */
  110148. if( pDest->eDest==SRT_Output ){
  110149. Select *pFirst = pPrior;
  110150. while( pFirst->pPrior ) pFirst = pFirst->pPrior;
  110151. generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
  110152. }
  110153. /* Reassembly the compound query so that it will be freed correctly
  110154. ** by the calling function */
  110155. if( p->pPrior ){
  110156. sqlite3SelectDelete(db, p->pPrior);
  110157. }
  110158. p->pPrior = pPrior;
  110159. pPrior->pNext = p;
  110160. /*** TBD: Insert subroutine calls to close cursors on incomplete
  110161. **** subqueries ****/
  110162. explainComposite(pParse, p->op, iSub1, iSub2, 0);
  110163. return pParse->nErr!=0;
  110164. }
  110165. #endif
  110166. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  110167. /* Forward Declarations */
  110168. static void substExprList(sqlite3*, ExprList*, int, ExprList*);
  110169. static void substSelect(sqlite3*, Select *, int, ExprList*, int);
  110170. /*
  110171. ** Scan through the expression pExpr. Replace every reference to
  110172. ** a column in table number iTable with a copy of the iColumn-th
  110173. ** entry in pEList. (But leave references to the ROWID column
  110174. ** unchanged.)
  110175. **
  110176. ** This routine is part of the flattening procedure. A subquery
  110177. ** whose result set is defined by pEList appears as entry in the
  110178. ** FROM clause of a SELECT such that the VDBE cursor assigned to that
  110179. ** FORM clause entry is iTable. This routine make the necessary
  110180. ** changes to pExpr so that it refers directly to the source table
  110181. ** of the subquery rather the result set of the subquery.
  110182. */
  110183. static Expr *substExpr(
  110184. sqlite3 *db, /* Report malloc errors to this connection */
  110185. Expr *pExpr, /* Expr in which substitution occurs */
  110186. int iTable, /* Table to be substituted */
  110187. ExprList *pEList /* Substitute expressions */
  110188. ){
  110189. if( pExpr==0 ) return 0;
  110190. if( pExpr->op==TK_COLUMN && pExpr->iTable==iTable ){
  110191. if( pExpr->iColumn<0 ){
  110192. pExpr->op = TK_NULL;
  110193. }else{
  110194. Expr *pNew;
  110195. assert( pEList!=0 && pExpr->iColumn<pEList->nExpr );
  110196. assert( pExpr->pLeft==0 && pExpr->pRight==0 );
  110197. pNew = sqlite3ExprDup(db, pEList->a[pExpr->iColumn].pExpr, 0);
  110198. sqlite3ExprDelete(db, pExpr);
  110199. pExpr = pNew;
  110200. }
  110201. }else{
  110202. pExpr->pLeft = substExpr(db, pExpr->pLeft, iTable, pEList);
  110203. pExpr->pRight = substExpr(db, pExpr->pRight, iTable, pEList);
  110204. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  110205. substSelect(db, pExpr->x.pSelect, iTable, pEList, 1);
  110206. }else{
  110207. substExprList(db, pExpr->x.pList, iTable, pEList);
  110208. }
  110209. }
  110210. return pExpr;
  110211. }
  110212. static void substExprList(
  110213. sqlite3 *db, /* Report malloc errors here */
  110214. ExprList *pList, /* List to scan and in which to make substitutes */
  110215. int iTable, /* Table to be substituted */
  110216. ExprList *pEList /* Substitute values */
  110217. ){
  110218. int i;
  110219. if( pList==0 ) return;
  110220. for(i=0; i<pList->nExpr; i++){
  110221. pList->a[i].pExpr = substExpr(db, pList->a[i].pExpr, iTable, pEList);
  110222. }
  110223. }
  110224. static void substSelect(
  110225. sqlite3 *db, /* Report malloc errors here */
  110226. Select *p, /* SELECT statement in which to make substitutions */
  110227. int iTable, /* Table to be replaced */
  110228. ExprList *pEList, /* Substitute values */
  110229. int doPrior /* Do substitutes on p->pPrior too */
  110230. ){
  110231. SrcList *pSrc;
  110232. struct SrcList_item *pItem;
  110233. int i;
  110234. if( !p ) return;
  110235. do{
  110236. substExprList(db, p->pEList, iTable, pEList);
  110237. substExprList(db, p->pGroupBy, iTable, pEList);
  110238. substExprList(db, p->pOrderBy, iTable, pEList);
  110239. p->pHaving = substExpr(db, p->pHaving, iTable, pEList);
  110240. p->pWhere = substExpr(db, p->pWhere, iTable, pEList);
  110241. pSrc = p->pSrc;
  110242. assert( pSrc!=0 );
  110243. for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
  110244. substSelect(db, pItem->pSelect, iTable, pEList, 1);
  110245. if( pItem->fg.isTabFunc ){
  110246. substExprList(db, pItem->u1.pFuncArg, iTable, pEList);
  110247. }
  110248. }
  110249. }while( doPrior && (p = p->pPrior)!=0 );
  110250. }
  110251. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  110252. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  110253. /*
  110254. ** This routine attempts to flatten subqueries as a performance optimization.
  110255. ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
  110256. **
  110257. ** To understand the concept of flattening, consider the following
  110258. ** query:
  110259. **
  110260. ** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
  110261. **
  110262. ** The default way of implementing this query is to execute the
  110263. ** subquery first and store the results in a temporary table, then
  110264. ** run the outer query on that temporary table. This requires two
  110265. ** passes over the data. Furthermore, because the temporary table
  110266. ** has no indices, the WHERE clause on the outer query cannot be
  110267. ** optimized.
  110268. **
  110269. ** This routine attempts to rewrite queries such as the above into
  110270. ** a single flat select, like this:
  110271. **
  110272. ** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
  110273. **
  110274. ** The code generated for this simplification gives the same result
  110275. ** but only has to scan the data once. And because indices might
  110276. ** exist on the table t1, a complete scan of the data might be
  110277. ** avoided.
  110278. **
  110279. ** Flattening is only attempted if all of the following are true:
  110280. **
  110281. ** (1) The subquery and the outer query do not both use aggregates.
  110282. **
  110283. ** (2) The subquery is not an aggregate or (2a) the outer query is not a join
  110284. ** and (2b) the outer query does not use subqueries other than the one
  110285. ** FROM-clause subquery that is a candidate for flattening. (2b is
  110286. ** due to ticket [2f7170d73bf9abf80] from 2015-02-09.)
  110287. **
  110288. ** (3) The subquery is not the right operand of a left outer join
  110289. ** (Originally ticket #306. Strengthened by ticket #3300)
  110290. **
  110291. ** (4) The subquery is not DISTINCT.
  110292. **
  110293. ** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
  110294. ** sub-queries that were excluded from this optimization. Restriction
  110295. ** (4) has since been expanded to exclude all DISTINCT subqueries.
  110296. **
  110297. ** (6) The subquery does not use aggregates or the outer query is not
  110298. ** DISTINCT.
  110299. **
  110300. ** (7) The subquery has a FROM clause. TODO: For subqueries without
  110301. ** A FROM clause, consider adding a FROM close with the special
  110302. ** table sqlite_once that consists of a single row containing a
  110303. ** single NULL.
  110304. **
  110305. ** (8) The subquery does not use LIMIT or the outer query is not a join.
  110306. **
  110307. ** (9) The subquery does not use LIMIT or the outer query does not use
  110308. ** aggregates.
  110309. **
  110310. ** (**) Restriction (10) was removed from the code on 2005-02-05 but we
  110311. ** accidently carried the comment forward until 2014-09-15. Original
  110312. ** text: "The subquery does not use aggregates or the outer query
  110313. ** does not use LIMIT."
  110314. **
  110315. ** (11) The subquery and the outer query do not both have ORDER BY clauses.
  110316. **
  110317. ** (**) Not implemented. Subsumed into restriction (3). Was previously
  110318. ** a separate restriction deriving from ticket #350.
  110319. **
  110320. ** (13) The subquery and outer query do not both use LIMIT.
  110321. **
  110322. ** (14) The subquery does not use OFFSET.
  110323. **
  110324. ** (15) The outer query is not part of a compound select or the
  110325. ** subquery does not have a LIMIT clause.
  110326. ** (See ticket #2339 and ticket [02a8e81d44]).
  110327. **
  110328. ** (16) The outer query is not an aggregate or the subquery does
  110329. ** not contain ORDER BY. (Ticket #2942) This used to not matter
  110330. ** until we introduced the group_concat() function.
  110331. **
  110332. ** (17) The sub-query is not a compound select, or it is a UNION ALL
  110333. ** compound clause made up entirely of non-aggregate queries, and
  110334. ** the parent query:
  110335. **
  110336. ** * is not itself part of a compound select,
  110337. ** * is not an aggregate or DISTINCT query, and
  110338. ** * is not a join
  110339. **
  110340. ** The parent and sub-query may contain WHERE clauses. Subject to
  110341. ** rules (11), (13) and (14), they may also contain ORDER BY,
  110342. ** LIMIT and OFFSET clauses. The subquery cannot use any compound
  110343. ** operator other than UNION ALL because all the other compound
  110344. ** operators have an implied DISTINCT which is disallowed by
  110345. ** restriction (4).
  110346. **
  110347. ** Also, each component of the sub-query must return the same number
  110348. ** of result columns. This is actually a requirement for any compound
  110349. ** SELECT statement, but all the code here does is make sure that no
  110350. ** such (illegal) sub-query is flattened. The caller will detect the
  110351. ** syntax error and return a detailed message.
  110352. **
  110353. ** (18) If the sub-query is a compound select, then all terms of the
  110354. ** ORDER by clause of the parent must be simple references to
  110355. ** columns of the sub-query.
  110356. **
  110357. ** (19) The subquery does not use LIMIT or the outer query does not
  110358. ** have a WHERE clause.
  110359. **
  110360. ** (20) If the sub-query is a compound select, then it must not use
  110361. ** an ORDER BY clause. Ticket #3773. We could relax this constraint
  110362. ** somewhat by saying that the terms of the ORDER BY clause must
  110363. ** appear as unmodified result columns in the outer query. But we
  110364. ** have other optimizations in mind to deal with that case.
  110365. **
  110366. ** (21) The subquery does not use LIMIT or the outer query is not
  110367. ** DISTINCT. (See ticket [752e1646fc]).
  110368. **
  110369. ** (22) The subquery is not a recursive CTE.
  110370. **
  110371. ** (23) The parent is not a recursive CTE, or the sub-query is not a
  110372. ** compound query. This restriction is because transforming the
  110373. ** parent to a compound query confuses the code that handles
  110374. ** recursive queries in multiSelect().
  110375. **
  110376. ** (24) The subquery is not an aggregate that uses the built-in min() or
  110377. ** or max() functions. (Without this restriction, a query like:
  110378. ** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
  110379. ** return the value X for which Y was maximal.)
  110380. **
  110381. **
  110382. ** In this routine, the "p" parameter is a pointer to the outer query.
  110383. ** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
  110384. ** uses aggregates and subqueryIsAgg is true if the subquery uses aggregates.
  110385. **
  110386. ** If flattening is not attempted, this routine is a no-op and returns 0.
  110387. ** If flattening is attempted this routine returns 1.
  110388. **
  110389. ** All of the expression analysis must occur on both the outer query and
  110390. ** the subquery before this routine runs.
  110391. */
  110392. static int flattenSubquery(
  110393. Parse *pParse, /* Parsing context */
  110394. Select *p, /* The parent or outer SELECT statement */
  110395. int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
  110396. int isAgg, /* True if outer SELECT uses aggregate functions */
  110397. int subqueryIsAgg /* True if the subquery uses aggregate functions */
  110398. ){
  110399. const char *zSavedAuthContext = pParse->zAuthContext;
  110400. Select *pParent; /* Current UNION ALL term of the other query */
  110401. Select *pSub; /* The inner query or "subquery" */
  110402. Select *pSub1; /* Pointer to the rightmost select in sub-query */
  110403. SrcList *pSrc; /* The FROM clause of the outer query */
  110404. SrcList *pSubSrc; /* The FROM clause of the subquery */
  110405. ExprList *pList; /* The result set of the outer query */
  110406. int iParent; /* VDBE cursor number of the pSub result set temp table */
  110407. int i; /* Loop counter */
  110408. Expr *pWhere; /* The WHERE clause */
  110409. struct SrcList_item *pSubitem; /* The subquery */
  110410. sqlite3 *db = pParse->db;
  110411. /* Check to see if flattening is permitted. Return 0 if not.
  110412. */
  110413. assert( p!=0 );
  110414. assert( p->pPrior==0 ); /* Unable to flatten compound queries */
  110415. if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
  110416. pSrc = p->pSrc;
  110417. assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
  110418. pSubitem = &pSrc->a[iFrom];
  110419. iParent = pSubitem->iCursor;
  110420. pSub = pSubitem->pSelect;
  110421. assert( pSub!=0 );
  110422. if( subqueryIsAgg ){
  110423. if( isAgg ) return 0; /* Restriction (1) */
  110424. if( pSrc->nSrc>1 ) return 0; /* Restriction (2a) */
  110425. if( (p->pWhere && ExprHasProperty(p->pWhere,EP_Subquery))
  110426. || (sqlite3ExprListFlags(p->pEList) & EP_Subquery)!=0
  110427. || (sqlite3ExprListFlags(p->pOrderBy) & EP_Subquery)!=0
  110428. ){
  110429. return 0; /* Restriction (2b) */
  110430. }
  110431. }
  110432. pSubSrc = pSub->pSrc;
  110433. assert( pSubSrc );
  110434. /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
  110435. ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
  110436. ** because they could be computed at compile-time. But when LIMIT and OFFSET
  110437. ** became arbitrary expressions, we were forced to add restrictions (13)
  110438. ** and (14). */
  110439. if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
  110440. if( pSub->pOffset ) return 0; /* Restriction (14) */
  110441. if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
  110442. return 0; /* Restriction (15) */
  110443. }
  110444. if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
  110445. if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (5) */
  110446. if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
  110447. return 0; /* Restrictions (8)(9) */
  110448. }
  110449. if( (p->selFlags & SF_Distinct)!=0 && subqueryIsAgg ){
  110450. return 0; /* Restriction (6) */
  110451. }
  110452. if( p->pOrderBy && pSub->pOrderBy ){
  110453. return 0; /* Restriction (11) */
  110454. }
  110455. if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
  110456. if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
  110457. if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
  110458. return 0; /* Restriction (21) */
  110459. }
  110460. testcase( pSub->selFlags & SF_Recursive );
  110461. testcase( pSub->selFlags & SF_MinMaxAgg );
  110462. if( pSub->selFlags & (SF_Recursive|SF_MinMaxAgg) ){
  110463. return 0; /* Restrictions (22) and (24) */
  110464. }
  110465. if( (p->selFlags & SF_Recursive) && pSub->pPrior ){
  110466. return 0; /* Restriction (23) */
  110467. }
  110468. /* OBSOLETE COMMENT 1:
  110469. ** Restriction 3: If the subquery is a join, make sure the subquery is
  110470. ** not used as the right operand of an outer join. Examples of why this
  110471. ** is not allowed:
  110472. **
  110473. ** t1 LEFT OUTER JOIN (t2 JOIN t3)
  110474. **
  110475. ** If we flatten the above, we would get
  110476. **
  110477. ** (t1 LEFT OUTER JOIN t2) JOIN t3
  110478. **
  110479. ** which is not at all the same thing.
  110480. **
  110481. ** OBSOLETE COMMENT 2:
  110482. ** Restriction 12: If the subquery is the right operand of a left outer
  110483. ** join, make sure the subquery has no WHERE clause.
  110484. ** An examples of why this is not allowed:
  110485. **
  110486. ** t1 LEFT OUTER JOIN (SELECT * FROM t2 WHERE t2.x>0)
  110487. **
  110488. ** If we flatten the above, we would get
  110489. **
  110490. ** (t1 LEFT OUTER JOIN t2) WHERE t2.x>0
  110491. **
  110492. ** But the t2.x>0 test will always fail on a NULL row of t2, which
  110493. ** effectively converts the OUTER JOIN into an INNER JOIN.
  110494. **
  110495. ** THIS OVERRIDES OBSOLETE COMMENTS 1 AND 2 ABOVE:
  110496. ** Ticket #3300 shows that flattening the right term of a LEFT JOIN
  110497. ** is fraught with danger. Best to avoid the whole thing. If the
  110498. ** subquery is the right term of a LEFT JOIN, then do not flatten.
  110499. */
  110500. if( (pSubitem->fg.jointype & JT_OUTER)!=0 ){
  110501. return 0;
  110502. }
  110503. /* Restriction 17: If the sub-query is a compound SELECT, then it must
  110504. ** use only the UNION ALL operator. And none of the simple select queries
  110505. ** that make up the compound SELECT are allowed to be aggregate or distinct
  110506. ** queries.
  110507. */
  110508. if( pSub->pPrior ){
  110509. if( pSub->pOrderBy ){
  110510. return 0; /* Restriction 20 */
  110511. }
  110512. if( isAgg || (p->selFlags & SF_Distinct)!=0 || pSrc->nSrc!=1 ){
  110513. return 0;
  110514. }
  110515. for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
  110516. testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
  110517. testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
  110518. assert( pSub->pSrc!=0 );
  110519. assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
  110520. if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0
  110521. || (pSub1->pPrior && pSub1->op!=TK_ALL)
  110522. || pSub1->pSrc->nSrc<1
  110523. ){
  110524. return 0;
  110525. }
  110526. testcase( pSub1->pSrc->nSrc>1 );
  110527. }
  110528. /* Restriction 18. */
  110529. if( p->pOrderBy ){
  110530. int ii;
  110531. for(ii=0; ii<p->pOrderBy->nExpr; ii++){
  110532. if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
  110533. }
  110534. }
  110535. }
  110536. /***** If we reach this point, flattening is permitted. *****/
  110537. SELECTTRACE(1,pParse,p,("flatten %s.%p from term %d\n",
  110538. pSub->zSelName, pSub, iFrom));
  110539. /* Authorize the subquery */
  110540. pParse->zAuthContext = pSubitem->zName;
  110541. TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
  110542. testcase( i==SQLITE_DENY );
  110543. pParse->zAuthContext = zSavedAuthContext;
  110544. /* If the sub-query is a compound SELECT statement, then (by restrictions
  110545. ** 17 and 18 above) it must be a UNION ALL and the parent query must
  110546. ** be of the form:
  110547. **
  110548. ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
  110549. **
  110550. ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
  110551. ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
  110552. ** OFFSET clauses and joins them to the left-hand-side of the original
  110553. ** using UNION ALL operators. In this case N is the number of simple
  110554. ** select statements in the compound sub-query.
  110555. **
  110556. ** Example:
  110557. **
  110558. ** SELECT a+1 FROM (
  110559. ** SELECT x FROM tab
  110560. ** UNION ALL
  110561. ** SELECT y FROM tab
  110562. ** UNION ALL
  110563. ** SELECT abs(z*2) FROM tab2
  110564. ** ) WHERE a!=5 ORDER BY 1
  110565. **
  110566. ** Transformed into:
  110567. **
  110568. ** SELECT x+1 FROM tab WHERE x+1!=5
  110569. ** UNION ALL
  110570. ** SELECT y+1 FROM tab WHERE y+1!=5
  110571. ** UNION ALL
  110572. ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
  110573. ** ORDER BY 1
  110574. **
  110575. ** We call this the "compound-subquery flattening".
  110576. */
  110577. for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
  110578. Select *pNew;
  110579. ExprList *pOrderBy = p->pOrderBy;
  110580. Expr *pLimit = p->pLimit;
  110581. Expr *pOffset = p->pOffset;
  110582. Select *pPrior = p->pPrior;
  110583. p->pOrderBy = 0;
  110584. p->pSrc = 0;
  110585. p->pPrior = 0;
  110586. p->pLimit = 0;
  110587. p->pOffset = 0;
  110588. pNew = sqlite3SelectDup(db, p, 0);
  110589. sqlite3SelectSetName(pNew, pSub->zSelName);
  110590. p->pOffset = pOffset;
  110591. p->pLimit = pLimit;
  110592. p->pOrderBy = pOrderBy;
  110593. p->pSrc = pSrc;
  110594. p->op = TK_ALL;
  110595. if( pNew==0 ){
  110596. p->pPrior = pPrior;
  110597. }else{
  110598. pNew->pPrior = pPrior;
  110599. if( pPrior ) pPrior->pNext = pNew;
  110600. pNew->pNext = p;
  110601. p->pPrior = pNew;
  110602. SELECTTRACE(2,pParse,p,
  110603. ("compound-subquery flattener creates %s.%p as peer\n",
  110604. pNew->zSelName, pNew));
  110605. }
  110606. if( db->mallocFailed ) return 1;
  110607. }
  110608. /* Begin flattening the iFrom-th entry of the FROM clause
  110609. ** in the outer query.
  110610. */
  110611. pSub = pSub1 = pSubitem->pSelect;
  110612. /* Delete the transient table structure associated with the
  110613. ** subquery
  110614. */
  110615. sqlite3DbFree(db, pSubitem->zDatabase);
  110616. sqlite3DbFree(db, pSubitem->zName);
  110617. sqlite3DbFree(db, pSubitem->zAlias);
  110618. pSubitem->zDatabase = 0;
  110619. pSubitem->zName = 0;
  110620. pSubitem->zAlias = 0;
  110621. pSubitem->pSelect = 0;
  110622. /* Defer deleting the Table object associated with the
  110623. ** subquery until code generation is
  110624. ** complete, since there may still exist Expr.pTab entries that
  110625. ** refer to the subquery even after flattening. Ticket #3346.
  110626. **
  110627. ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
  110628. */
  110629. if( ALWAYS(pSubitem->pTab!=0) ){
  110630. Table *pTabToDel = pSubitem->pTab;
  110631. if( pTabToDel->nRef==1 ){
  110632. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  110633. pTabToDel->pNextZombie = pToplevel->pZombieTab;
  110634. pToplevel->pZombieTab = pTabToDel;
  110635. }else{
  110636. pTabToDel->nRef--;
  110637. }
  110638. pSubitem->pTab = 0;
  110639. }
  110640. /* The following loop runs once for each term in a compound-subquery
  110641. ** flattening (as described above). If we are doing a different kind
  110642. ** of flattening - a flattening other than a compound-subquery flattening -
  110643. ** then this loop only runs once.
  110644. **
  110645. ** This loop moves all of the FROM elements of the subquery into the
  110646. ** the FROM clause of the outer query. Before doing this, remember
  110647. ** the cursor number for the original outer query FROM element in
  110648. ** iParent. The iParent cursor will never be used. Subsequent code
  110649. ** will scan expressions looking for iParent references and replace
  110650. ** those references with expressions that resolve to the subquery FROM
  110651. ** elements we are now copying in.
  110652. */
  110653. for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
  110654. int nSubSrc;
  110655. u8 jointype = 0;
  110656. pSubSrc = pSub->pSrc; /* FROM clause of subquery */
  110657. nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
  110658. pSrc = pParent->pSrc; /* FROM clause of the outer query */
  110659. if( pSrc ){
  110660. assert( pParent==p ); /* First time through the loop */
  110661. jointype = pSubitem->fg.jointype;
  110662. }else{
  110663. assert( pParent!=p ); /* 2nd and subsequent times through the loop */
  110664. pSrc = pParent->pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  110665. if( pSrc==0 ){
  110666. assert( db->mallocFailed );
  110667. break;
  110668. }
  110669. }
  110670. /* The subquery uses a single slot of the FROM clause of the outer
  110671. ** query. If the subquery has more than one element in its FROM clause,
  110672. ** then expand the outer query to make space for it to hold all elements
  110673. ** of the subquery.
  110674. **
  110675. ** Example:
  110676. **
  110677. ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
  110678. **
  110679. ** The outer query has 3 slots in its FROM clause. One slot of the
  110680. ** outer query (the middle slot) is used by the subquery. The next
  110681. ** block of code will expand the outer query FROM clause to 4 slots.
  110682. ** The middle slot is expanded to two slots in order to make space
  110683. ** for the two elements in the FROM clause of the subquery.
  110684. */
  110685. if( nSubSrc>1 ){
  110686. pParent->pSrc = pSrc = sqlite3SrcListEnlarge(db, pSrc, nSubSrc-1,iFrom+1);
  110687. if( db->mallocFailed ){
  110688. break;
  110689. }
  110690. }
  110691. /* Transfer the FROM clause terms from the subquery into the
  110692. ** outer query.
  110693. */
  110694. for(i=0; i<nSubSrc; i++){
  110695. sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
  110696. assert( pSrc->a[i+iFrom].fg.isTabFunc==0 );
  110697. pSrc->a[i+iFrom] = pSubSrc->a[i];
  110698. memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
  110699. }
  110700. pSrc->a[iFrom].fg.jointype = jointype;
  110701. /* Now begin substituting subquery result set expressions for
  110702. ** references to the iParent in the outer query.
  110703. **
  110704. ** Example:
  110705. **
  110706. ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
  110707. ** \ \_____________ subquery __________/ /
  110708. ** \_____________________ outer query ______________________________/
  110709. **
  110710. ** We look at every expression in the outer query and every place we see
  110711. ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
  110712. */
  110713. pList = pParent->pEList;
  110714. for(i=0; i<pList->nExpr; i++){
  110715. if( pList->a[i].zName==0 ){
  110716. char *zName = sqlite3DbStrDup(db, pList->a[i].zSpan);
  110717. sqlite3Dequote(zName);
  110718. pList->a[i].zName = zName;
  110719. }
  110720. }
  110721. if( pSub->pOrderBy ){
  110722. /* At this point, any non-zero iOrderByCol values indicate that the
  110723. ** ORDER BY column expression is identical to the iOrderByCol'th
  110724. ** expression returned by SELECT statement pSub. Since these values
  110725. ** do not necessarily correspond to columns in SELECT statement pParent,
  110726. ** zero them before transfering the ORDER BY clause.
  110727. **
  110728. ** Not doing this may cause an error if a subsequent call to this
  110729. ** function attempts to flatten a compound sub-query into pParent
  110730. ** (the only way this can happen is if the compound sub-query is
  110731. ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
  110732. ExprList *pOrderBy = pSub->pOrderBy;
  110733. for(i=0; i<pOrderBy->nExpr; i++){
  110734. pOrderBy->a[i].u.x.iOrderByCol = 0;
  110735. }
  110736. assert( pParent->pOrderBy==0 );
  110737. assert( pSub->pPrior==0 );
  110738. pParent->pOrderBy = pOrderBy;
  110739. pSub->pOrderBy = 0;
  110740. }
  110741. pWhere = sqlite3ExprDup(db, pSub->pWhere, 0);
  110742. if( subqueryIsAgg ){
  110743. assert( pParent->pHaving==0 );
  110744. pParent->pHaving = pParent->pWhere;
  110745. pParent->pWhere = pWhere;
  110746. pParent->pHaving = sqlite3ExprAnd(db,
  110747. sqlite3ExprDup(db, pSub->pHaving, 0), pParent->pHaving
  110748. );
  110749. assert( pParent->pGroupBy==0 );
  110750. pParent->pGroupBy = sqlite3ExprListDup(db, pSub->pGroupBy, 0);
  110751. }else{
  110752. pParent->pWhere = sqlite3ExprAnd(db, pWhere, pParent->pWhere);
  110753. }
  110754. substSelect(db, pParent, iParent, pSub->pEList, 0);
  110755. /* The flattened query is distinct if either the inner or the
  110756. ** outer query is distinct.
  110757. */
  110758. pParent->selFlags |= pSub->selFlags & SF_Distinct;
  110759. /*
  110760. ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
  110761. **
  110762. ** One is tempted to try to add a and b to combine the limits. But this
  110763. ** does not work if either limit is negative.
  110764. */
  110765. if( pSub->pLimit ){
  110766. pParent->pLimit = pSub->pLimit;
  110767. pSub->pLimit = 0;
  110768. }
  110769. }
  110770. /* Finially, delete what is left of the subquery and return
  110771. ** success.
  110772. */
  110773. sqlite3SelectDelete(db, pSub1);
  110774. #if SELECTTRACE_ENABLED
  110775. if( sqlite3SelectTrace & 0x100 ){
  110776. SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
  110777. sqlite3TreeViewSelect(0, p, 0);
  110778. }
  110779. #endif
  110780. return 1;
  110781. }
  110782. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  110783. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  110784. /*
  110785. ** Make copies of relevant WHERE clause terms of the outer query into
  110786. ** the WHERE clause of subquery. Example:
  110787. **
  110788. ** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
  110789. **
  110790. ** Transformed into:
  110791. **
  110792. ** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
  110793. ** WHERE x=5 AND y=10;
  110794. **
  110795. ** The hope is that the terms added to the inner query will make it more
  110796. ** efficient.
  110797. **
  110798. ** Do not attempt this optimization if:
  110799. **
  110800. ** (1) The inner query is an aggregate. (In that case, we'd really want
  110801. ** to copy the outer WHERE-clause terms onto the HAVING clause of the
  110802. ** inner query. But they probably won't help there so do not bother.)
  110803. **
  110804. ** (2) The inner query is the recursive part of a common table expression.
  110805. **
  110806. ** (3) The inner query has a LIMIT clause (since the changes to the WHERE
  110807. ** close would change the meaning of the LIMIT).
  110808. **
  110809. ** (4) The inner query is the right operand of a LEFT JOIN. (The caller
  110810. ** enforces this restriction since this routine does not have enough
  110811. ** information to know.)
  110812. **
  110813. ** (5) The WHERE clause expression originates in the ON or USING clause
  110814. ** of a LEFT JOIN.
  110815. **
  110816. ** Return 0 if no changes are made and non-zero if one or more WHERE clause
  110817. ** terms are duplicated into the subquery.
  110818. */
  110819. static int pushDownWhereTerms(
  110820. sqlite3 *db, /* The database connection (for malloc()) */
  110821. Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
  110822. Expr *pWhere, /* The WHERE clause of the outer query */
  110823. int iCursor /* Cursor number of the subquery */
  110824. ){
  110825. Expr *pNew;
  110826. int nChng = 0;
  110827. Select *pX; /* For looping over compound SELECTs in pSubq */
  110828. if( pWhere==0 ) return 0;
  110829. for(pX=pSubq; pX; pX=pX->pPrior){
  110830. if( (pX->selFlags & (SF_Aggregate|SF_Recursive))!=0 ){
  110831. testcase( pX->selFlags & SF_Aggregate );
  110832. testcase( pX->selFlags & SF_Recursive );
  110833. testcase( pX!=pSubq );
  110834. return 0; /* restrictions (1) and (2) */
  110835. }
  110836. }
  110837. if( pSubq->pLimit!=0 ){
  110838. return 0; /* restriction (3) */
  110839. }
  110840. while( pWhere->op==TK_AND ){
  110841. nChng += pushDownWhereTerms(db, pSubq, pWhere->pRight, iCursor);
  110842. pWhere = pWhere->pLeft;
  110843. }
  110844. if( ExprHasProperty(pWhere,EP_FromJoin) ) return 0; /* restriction 5 */
  110845. if( sqlite3ExprIsTableConstant(pWhere, iCursor) ){
  110846. nChng++;
  110847. while( pSubq ){
  110848. pNew = sqlite3ExprDup(db, pWhere, 0);
  110849. pNew = substExpr(db, pNew, iCursor, pSubq->pEList);
  110850. pSubq->pWhere = sqlite3ExprAnd(db, pSubq->pWhere, pNew);
  110851. pSubq = pSubq->pPrior;
  110852. }
  110853. }
  110854. return nChng;
  110855. }
  110856. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  110857. /*
  110858. ** Based on the contents of the AggInfo structure indicated by the first
  110859. ** argument, this function checks if the following are true:
  110860. **
  110861. ** * the query contains just a single aggregate function,
  110862. ** * the aggregate function is either min() or max(), and
  110863. ** * the argument to the aggregate function is a column value.
  110864. **
  110865. ** If all of the above are true, then WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX
  110866. ** is returned as appropriate. Also, *ppMinMax is set to point to the
  110867. ** list of arguments passed to the aggregate before returning.
  110868. **
  110869. ** Or, if the conditions above are not met, *ppMinMax is set to 0 and
  110870. ** WHERE_ORDERBY_NORMAL is returned.
  110871. */
  110872. static u8 minMaxQuery(AggInfo *pAggInfo, ExprList **ppMinMax){
  110873. int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
  110874. *ppMinMax = 0;
  110875. if( pAggInfo->nFunc==1 ){
  110876. Expr *pExpr = pAggInfo->aFunc[0].pExpr; /* Aggregate function */
  110877. ExprList *pEList = pExpr->x.pList; /* Arguments to agg function */
  110878. assert( pExpr->op==TK_AGG_FUNCTION );
  110879. if( pEList && pEList->nExpr==1 && pEList->a[0].pExpr->op==TK_AGG_COLUMN ){
  110880. const char *zFunc = pExpr->u.zToken;
  110881. if( sqlite3StrICmp(zFunc, "min")==0 ){
  110882. eRet = WHERE_ORDERBY_MIN;
  110883. *ppMinMax = pEList;
  110884. }else if( sqlite3StrICmp(zFunc, "max")==0 ){
  110885. eRet = WHERE_ORDERBY_MAX;
  110886. *ppMinMax = pEList;
  110887. }
  110888. }
  110889. }
  110890. assert( *ppMinMax==0 || (*ppMinMax)->nExpr==1 );
  110891. return eRet;
  110892. }
  110893. /*
  110894. ** The select statement passed as the first argument is an aggregate query.
  110895. ** The second argument is the associated aggregate-info object. This
  110896. ** function tests if the SELECT is of the form:
  110897. **
  110898. ** SELECT count(*) FROM <tbl>
  110899. **
  110900. ** where table is a database table, not a sub-select or view. If the query
  110901. ** does match this pattern, then a pointer to the Table object representing
  110902. ** <tbl> is returned. Otherwise, 0 is returned.
  110903. */
  110904. static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
  110905. Table *pTab;
  110906. Expr *pExpr;
  110907. assert( !p->pGroupBy );
  110908. if( p->pWhere || p->pEList->nExpr!=1
  110909. || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
  110910. ){
  110911. return 0;
  110912. }
  110913. pTab = p->pSrc->a[0].pTab;
  110914. pExpr = p->pEList->a[0].pExpr;
  110915. assert( pTab && !pTab->pSelect && pExpr );
  110916. if( IsVirtual(pTab) ) return 0;
  110917. if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
  110918. if( NEVER(pAggInfo->nFunc==0) ) return 0;
  110919. if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
  110920. if( pExpr->flags&EP_Distinct ) return 0;
  110921. return pTab;
  110922. }
  110923. /*
  110924. ** If the source-list item passed as an argument was augmented with an
  110925. ** INDEXED BY clause, then try to locate the specified index. If there
  110926. ** was such a clause and the named index cannot be found, return
  110927. ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
  110928. ** pFrom->pIndex and return SQLITE_OK.
  110929. */
  110930. SQLITE_PRIVATE int sqlite3IndexedByLookup(Parse *pParse, struct SrcList_item *pFrom){
  110931. if( pFrom->pTab && pFrom->fg.isIndexedBy ){
  110932. Table *pTab = pFrom->pTab;
  110933. char *zIndexedBy = pFrom->u1.zIndexedBy;
  110934. Index *pIdx;
  110935. for(pIdx=pTab->pIndex;
  110936. pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
  110937. pIdx=pIdx->pNext
  110938. );
  110939. if( !pIdx ){
  110940. sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
  110941. pParse->checkSchema = 1;
  110942. return SQLITE_ERROR;
  110943. }
  110944. pFrom->pIBIndex = pIdx;
  110945. }
  110946. return SQLITE_OK;
  110947. }
  110948. /*
  110949. ** Detect compound SELECT statements that use an ORDER BY clause with
  110950. ** an alternative collating sequence.
  110951. **
  110952. ** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
  110953. **
  110954. ** These are rewritten as a subquery:
  110955. **
  110956. ** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
  110957. ** ORDER BY ... COLLATE ...
  110958. **
  110959. ** This transformation is necessary because the multiSelectOrderBy() routine
  110960. ** above that generates the code for a compound SELECT with an ORDER BY clause
  110961. ** uses a merge algorithm that requires the same collating sequence on the
  110962. ** result columns as on the ORDER BY clause. See ticket
  110963. ** http://www.sqlite.org/src/info/6709574d2a
  110964. **
  110965. ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
  110966. ** The UNION ALL operator works fine with multiSelectOrderBy() even when
  110967. ** there are COLLATE terms in the ORDER BY.
  110968. */
  110969. static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
  110970. int i;
  110971. Select *pNew;
  110972. Select *pX;
  110973. sqlite3 *db;
  110974. struct ExprList_item *a;
  110975. SrcList *pNewSrc;
  110976. Parse *pParse;
  110977. Token dummy;
  110978. if( p->pPrior==0 ) return WRC_Continue;
  110979. if( p->pOrderBy==0 ) return WRC_Continue;
  110980. for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
  110981. if( pX==0 ) return WRC_Continue;
  110982. a = p->pOrderBy->a;
  110983. for(i=p->pOrderBy->nExpr-1; i>=0; i--){
  110984. if( a[i].pExpr->flags & EP_Collate ) break;
  110985. }
  110986. if( i<0 ) return WRC_Continue;
  110987. /* If we reach this point, that means the transformation is required. */
  110988. pParse = pWalker->pParse;
  110989. db = pParse->db;
  110990. pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
  110991. if( pNew==0 ) return WRC_Abort;
  110992. memset(&dummy, 0, sizeof(dummy));
  110993. pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
  110994. if( pNewSrc==0 ) return WRC_Abort;
  110995. *pNew = *p;
  110996. p->pSrc = pNewSrc;
  110997. p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
  110998. p->op = TK_SELECT;
  110999. p->pWhere = 0;
  111000. pNew->pGroupBy = 0;
  111001. pNew->pHaving = 0;
  111002. pNew->pOrderBy = 0;
  111003. p->pPrior = 0;
  111004. p->pNext = 0;
  111005. p->pWith = 0;
  111006. p->selFlags &= ~SF_Compound;
  111007. assert( (p->selFlags & SF_Converted)==0 );
  111008. p->selFlags |= SF_Converted;
  111009. assert( pNew->pPrior!=0 );
  111010. pNew->pPrior->pNext = pNew;
  111011. pNew->pLimit = 0;
  111012. pNew->pOffset = 0;
  111013. return WRC_Continue;
  111014. }
  111015. /*
  111016. ** Check to see if the FROM clause term pFrom has table-valued function
  111017. ** arguments. If it does, leave an error message in pParse and return
  111018. ** non-zero, since pFrom is not allowed to be a table-valued function.
  111019. */
  111020. static int cannotBeFunction(Parse *pParse, struct SrcList_item *pFrom){
  111021. if( pFrom->fg.isTabFunc ){
  111022. sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
  111023. return 1;
  111024. }
  111025. return 0;
  111026. }
  111027. #ifndef SQLITE_OMIT_CTE
  111028. /*
  111029. ** Argument pWith (which may be NULL) points to a linked list of nested
  111030. ** WITH contexts, from inner to outermost. If the table identified by
  111031. ** FROM clause element pItem is really a common-table-expression (CTE)
  111032. ** then return a pointer to the CTE definition for that table. Otherwise
  111033. ** return NULL.
  111034. **
  111035. ** If a non-NULL value is returned, set *ppContext to point to the With
  111036. ** object that the returned CTE belongs to.
  111037. */
  111038. static struct Cte *searchWith(
  111039. With *pWith, /* Current innermost WITH clause */
  111040. struct SrcList_item *pItem, /* FROM clause element to resolve */
  111041. With **ppContext /* OUT: WITH clause return value belongs to */
  111042. ){
  111043. const char *zName;
  111044. if( pItem->zDatabase==0 && (zName = pItem->zName)!=0 ){
  111045. With *p;
  111046. for(p=pWith; p; p=p->pOuter){
  111047. int i;
  111048. for(i=0; i<p->nCte; i++){
  111049. if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
  111050. *ppContext = p;
  111051. return &p->a[i];
  111052. }
  111053. }
  111054. }
  111055. }
  111056. return 0;
  111057. }
  111058. /* The code generator maintains a stack of active WITH clauses
  111059. ** with the inner-most WITH clause being at the top of the stack.
  111060. **
  111061. ** This routine pushes the WITH clause passed as the second argument
  111062. ** onto the top of the stack. If argument bFree is true, then this
  111063. ** WITH clause will never be popped from the stack. In this case it
  111064. ** should be freed along with the Parse object. In other cases, when
  111065. ** bFree==0, the With object will be freed along with the SELECT
  111066. ** statement with which it is associated.
  111067. */
  111068. SQLITE_PRIVATE void sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
  111069. assert( bFree==0 || (pParse->pWith==0 && pParse->pWithToFree==0) );
  111070. if( pWith ){
  111071. assert( pParse->pWith!=pWith );
  111072. pWith->pOuter = pParse->pWith;
  111073. pParse->pWith = pWith;
  111074. if( bFree ) pParse->pWithToFree = pWith;
  111075. }
  111076. }
  111077. /*
  111078. ** This function checks if argument pFrom refers to a CTE declared by
  111079. ** a WITH clause on the stack currently maintained by the parser. And,
  111080. ** if currently processing a CTE expression, if it is a recursive
  111081. ** reference to the current CTE.
  111082. **
  111083. ** If pFrom falls into either of the two categories above, pFrom->pTab
  111084. ** and other fields are populated accordingly. The caller should check
  111085. ** (pFrom->pTab!=0) to determine whether or not a successful match
  111086. ** was found.
  111087. **
  111088. ** Whether or not a match is found, SQLITE_OK is returned if no error
  111089. ** occurs. If an error does occur, an error message is stored in the
  111090. ** parser and some error code other than SQLITE_OK returned.
  111091. */
  111092. static int withExpand(
  111093. Walker *pWalker,
  111094. struct SrcList_item *pFrom
  111095. ){
  111096. Parse *pParse = pWalker->pParse;
  111097. sqlite3 *db = pParse->db;
  111098. struct Cte *pCte; /* Matched CTE (or NULL if no match) */
  111099. With *pWith; /* WITH clause that pCte belongs to */
  111100. assert( pFrom->pTab==0 );
  111101. pCte = searchWith(pParse->pWith, pFrom, &pWith);
  111102. if( pCte ){
  111103. Table *pTab;
  111104. ExprList *pEList;
  111105. Select *pSel;
  111106. Select *pLeft; /* Left-most SELECT statement */
  111107. int bMayRecursive; /* True if compound joined by UNION [ALL] */
  111108. With *pSavedWith; /* Initial value of pParse->pWith */
  111109. /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
  111110. ** recursive reference to CTE pCte. Leave an error in pParse and return
  111111. ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
  111112. ** In this case, proceed. */
  111113. if( pCte->zCteErr ){
  111114. sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
  111115. return SQLITE_ERROR;
  111116. }
  111117. if( cannotBeFunction(pParse, pFrom) ) return SQLITE_ERROR;
  111118. assert( pFrom->pTab==0 );
  111119. pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
  111120. if( pTab==0 ) return WRC_Abort;
  111121. pTab->nRef = 1;
  111122. pTab->zName = sqlite3DbStrDup(db, pCte->zName);
  111123. pTab->iPKey = -1;
  111124. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  111125. pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
  111126. pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
  111127. if( db->mallocFailed ) return SQLITE_NOMEM_BKPT;
  111128. assert( pFrom->pSelect );
  111129. /* Check if this is a recursive CTE. */
  111130. pSel = pFrom->pSelect;
  111131. bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
  111132. if( bMayRecursive ){
  111133. int i;
  111134. SrcList *pSrc = pFrom->pSelect->pSrc;
  111135. for(i=0; i<pSrc->nSrc; i++){
  111136. struct SrcList_item *pItem = &pSrc->a[i];
  111137. if( pItem->zDatabase==0
  111138. && pItem->zName!=0
  111139. && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
  111140. ){
  111141. pItem->pTab = pTab;
  111142. pItem->fg.isRecursive = 1;
  111143. pTab->nRef++;
  111144. pSel->selFlags |= SF_Recursive;
  111145. }
  111146. }
  111147. }
  111148. /* Only one recursive reference is permitted. */
  111149. if( pTab->nRef>2 ){
  111150. sqlite3ErrorMsg(
  111151. pParse, "multiple references to recursive table: %s", pCte->zName
  111152. );
  111153. return SQLITE_ERROR;
  111154. }
  111155. assert( pTab->nRef==1 || ((pSel->selFlags&SF_Recursive) && pTab->nRef==2 ));
  111156. pCte->zCteErr = "circular reference: %s";
  111157. pSavedWith = pParse->pWith;
  111158. pParse->pWith = pWith;
  111159. sqlite3WalkSelect(pWalker, bMayRecursive ? pSel->pPrior : pSel);
  111160. pParse->pWith = pWith;
  111161. for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
  111162. pEList = pLeft->pEList;
  111163. if( pCte->pCols ){
  111164. if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
  111165. sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
  111166. pCte->zName, pEList->nExpr, pCte->pCols->nExpr
  111167. );
  111168. pParse->pWith = pSavedWith;
  111169. return SQLITE_ERROR;
  111170. }
  111171. pEList = pCte->pCols;
  111172. }
  111173. sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
  111174. if( bMayRecursive ){
  111175. if( pSel->selFlags & SF_Recursive ){
  111176. pCte->zCteErr = "multiple recursive references: %s";
  111177. }else{
  111178. pCte->zCteErr = "recursive reference in a subquery: %s";
  111179. }
  111180. sqlite3WalkSelect(pWalker, pSel);
  111181. }
  111182. pCte->zCteErr = 0;
  111183. pParse->pWith = pSavedWith;
  111184. }
  111185. return SQLITE_OK;
  111186. }
  111187. #endif
  111188. #ifndef SQLITE_OMIT_CTE
  111189. /*
  111190. ** If the SELECT passed as the second argument has an associated WITH
  111191. ** clause, pop it from the stack stored as part of the Parse object.
  111192. **
  111193. ** This function is used as the xSelectCallback2() callback by
  111194. ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
  111195. ** names and other FROM clause elements.
  111196. */
  111197. static void selectPopWith(Walker *pWalker, Select *p){
  111198. Parse *pParse = pWalker->pParse;
  111199. With *pWith = findRightmost(p)->pWith;
  111200. if( pWith!=0 ){
  111201. assert( pParse->pWith==pWith );
  111202. pParse->pWith = pWith->pOuter;
  111203. }
  111204. }
  111205. #else
  111206. #define selectPopWith 0
  111207. #endif
  111208. /*
  111209. ** This routine is a Walker callback for "expanding" a SELECT statement.
  111210. ** "Expanding" means to do the following:
  111211. **
  111212. ** (1) Make sure VDBE cursor numbers have been assigned to every
  111213. ** element of the FROM clause.
  111214. **
  111215. ** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
  111216. ** defines FROM clause. When views appear in the FROM clause,
  111217. ** fill pTabList->a[].pSelect with a copy of the SELECT statement
  111218. ** that implements the view. A copy is made of the view's SELECT
  111219. ** statement so that we can freely modify or delete that statement
  111220. ** without worrying about messing up the persistent representation
  111221. ** of the view.
  111222. **
  111223. ** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
  111224. ** on joins and the ON and USING clause of joins.
  111225. **
  111226. ** (4) Scan the list of columns in the result set (pEList) looking
  111227. ** for instances of the "*" operator or the TABLE.* operator.
  111228. ** If found, expand each "*" to be every column in every table
  111229. ** and TABLE.* to be every column in TABLE.
  111230. **
  111231. */
  111232. static int selectExpander(Walker *pWalker, Select *p){
  111233. Parse *pParse = pWalker->pParse;
  111234. int i, j, k;
  111235. SrcList *pTabList;
  111236. ExprList *pEList;
  111237. struct SrcList_item *pFrom;
  111238. sqlite3 *db = pParse->db;
  111239. Expr *pE, *pRight, *pExpr;
  111240. u16 selFlags = p->selFlags;
  111241. p->selFlags |= SF_Expanded;
  111242. if( db->mallocFailed ){
  111243. return WRC_Abort;
  111244. }
  111245. if( NEVER(p->pSrc==0) || (selFlags & SF_Expanded)!=0 ){
  111246. return WRC_Prune;
  111247. }
  111248. pTabList = p->pSrc;
  111249. pEList = p->pEList;
  111250. if( pWalker->xSelectCallback2==selectPopWith ){
  111251. sqlite3WithPush(pParse, findRightmost(p)->pWith, 0);
  111252. }
  111253. /* Make sure cursor numbers have been assigned to all entries in
  111254. ** the FROM clause of the SELECT statement.
  111255. */
  111256. sqlite3SrcListAssignCursors(pParse, pTabList);
  111257. /* Look up every table named in the FROM clause of the select. If
  111258. ** an entry of the FROM clause is a subquery instead of a table or view,
  111259. ** then create a transient table structure to describe the subquery.
  111260. */
  111261. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  111262. Table *pTab;
  111263. assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
  111264. if( pFrom->fg.isRecursive ) continue;
  111265. assert( pFrom->pTab==0 );
  111266. #ifndef SQLITE_OMIT_CTE
  111267. if( withExpand(pWalker, pFrom) ) return WRC_Abort;
  111268. if( pFrom->pTab ) {} else
  111269. #endif
  111270. if( pFrom->zName==0 ){
  111271. #ifndef SQLITE_OMIT_SUBQUERY
  111272. Select *pSel = pFrom->pSelect;
  111273. /* A sub-query in the FROM clause of a SELECT */
  111274. assert( pSel!=0 );
  111275. assert( pFrom->pTab==0 );
  111276. if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
  111277. pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
  111278. if( pTab==0 ) return WRC_Abort;
  111279. pTab->nRef = 1;
  111280. pTab->zName = sqlite3MPrintf(db, "sqlite_sq_%p", (void*)pTab);
  111281. while( pSel->pPrior ){ pSel = pSel->pPrior; }
  111282. sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
  111283. pTab->iPKey = -1;
  111284. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  111285. pTab->tabFlags |= TF_Ephemeral;
  111286. #endif
  111287. }else{
  111288. /* An ordinary table or view name in the FROM clause */
  111289. assert( pFrom->pTab==0 );
  111290. pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
  111291. if( pTab==0 ) return WRC_Abort;
  111292. if( pTab->nRef==0xffff ){
  111293. sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
  111294. pTab->zName);
  111295. pFrom->pTab = 0;
  111296. return WRC_Abort;
  111297. }
  111298. pTab->nRef++;
  111299. if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
  111300. return WRC_Abort;
  111301. }
  111302. #if !defined(SQLITE_OMIT_VIEW) || !defined (SQLITE_OMIT_VIRTUALTABLE)
  111303. if( IsVirtual(pTab) || pTab->pSelect ){
  111304. i16 nCol;
  111305. if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
  111306. assert( pFrom->pSelect==0 );
  111307. pFrom->pSelect = sqlite3SelectDup(db, pTab->pSelect, 0);
  111308. sqlite3SelectSetName(pFrom->pSelect, pTab->zName);
  111309. nCol = pTab->nCol;
  111310. pTab->nCol = -1;
  111311. sqlite3WalkSelect(pWalker, pFrom->pSelect);
  111312. pTab->nCol = nCol;
  111313. }
  111314. #endif
  111315. }
  111316. /* Locate the index named by the INDEXED BY clause, if any. */
  111317. if( sqlite3IndexedByLookup(pParse, pFrom) ){
  111318. return WRC_Abort;
  111319. }
  111320. }
  111321. /* Process NATURAL keywords, and ON and USING clauses of joins.
  111322. */
  111323. if( db->mallocFailed || sqliteProcessJoin(pParse, p) ){
  111324. return WRC_Abort;
  111325. }
  111326. /* For every "*" that occurs in the column list, insert the names of
  111327. ** all columns in all tables. And for every TABLE.* insert the names
  111328. ** of all columns in TABLE. The parser inserted a special expression
  111329. ** with the TK_ASTERISK operator for each "*" that it found in the column
  111330. ** list. The following code just has to locate the TK_ASTERISK
  111331. ** expressions and expand each one to the list of all columns in
  111332. ** all tables.
  111333. **
  111334. ** The first loop just checks to see if there are any "*" operators
  111335. ** that need expanding.
  111336. */
  111337. for(k=0; k<pEList->nExpr; k++){
  111338. pE = pEList->a[k].pExpr;
  111339. if( pE->op==TK_ASTERISK ) break;
  111340. assert( pE->op!=TK_DOT || pE->pRight!=0 );
  111341. assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
  111342. if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
  111343. }
  111344. if( k<pEList->nExpr ){
  111345. /*
  111346. ** If we get here it means the result set contains one or more "*"
  111347. ** operators that need to be expanded. Loop through each expression
  111348. ** in the result set and expand them one by one.
  111349. */
  111350. struct ExprList_item *a = pEList->a;
  111351. ExprList *pNew = 0;
  111352. int flags = pParse->db->flags;
  111353. int longNames = (flags & SQLITE_FullColNames)!=0
  111354. && (flags & SQLITE_ShortColNames)==0;
  111355. for(k=0; k<pEList->nExpr; k++){
  111356. pE = a[k].pExpr;
  111357. pRight = pE->pRight;
  111358. assert( pE->op!=TK_DOT || pRight!=0 );
  111359. if( pE->op!=TK_ASTERISK
  111360. && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
  111361. ){
  111362. /* This particular expression does not need to be expanded.
  111363. */
  111364. pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
  111365. if( pNew ){
  111366. pNew->a[pNew->nExpr-1].zName = a[k].zName;
  111367. pNew->a[pNew->nExpr-1].zSpan = a[k].zSpan;
  111368. a[k].zName = 0;
  111369. a[k].zSpan = 0;
  111370. }
  111371. a[k].pExpr = 0;
  111372. }else{
  111373. /* This expression is a "*" or a "TABLE.*" and needs to be
  111374. ** expanded. */
  111375. int tableSeen = 0; /* Set to 1 when TABLE matches */
  111376. char *zTName = 0; /* text of name of TABLE */
  111377. if( pE->op==TK_DOT ){
  111378. assert( pE->pLeft!=0 );
  111379. assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
  111380. zTName = pE->pLeft->u.zToken;
  111381. }
  111382. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  111383. Table *pTab = pFrom->pTab;
  111384. Select *pSub = pFrom->pSelect;
  111385. char *zTabName = pFrom->zAlias;
  111386. const char *zSchemaName = 0;
  111387. int iDb;
  111388. if( zTabName==0 ){
  111389. zTabName = pTab->zName;
  111390. }
  111391. if( db->mallocFailed ) break;
  111392. if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
  111393. pSub = 0;
  111394. if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
  111395. continue;
  111396. }
  111397. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  111398. zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
  111399. }
  111400. for(j=0; j<pTab->nCol; j++){
  111401. char *zName = pTab->aCol[j].zName;
  111402. char *zColname; /* The computed column name */
  111403. char *zToFree; /* Malloced string that needs to be freed */
  111404. Token sColname; /* Computed column name as a token */
  111405. assert( zName );
  111406. if( zTName && pSub
  111407. && sqlite3MatchSpanName(pSub->pEList->a[j].zSpan, 0, zTName, 0)==0
  111408. ){
  111409. continue;
  111410. }
  111411. /* If a column is marked as 'hidden', omit it from the expanded
  111412. ** result-set list unless the SELECT has the SF_IncludeHidden
  111413. ** bit set.
  111414. */
  111415. if( (p->selFlags & SF_IncludeHidden)==0
  111416. && IsHiddenColumn(&pTab->aCol[j])
  111417. ){
  111418. continue;
  111419. }
  111420. tableSeen = 1;
  111421. if( i>0 && zTName==0 ){
  111422. if( (pFrom->fg.jointype & JT_NATURAL)!=0
  111423. && tableAndColumnIndex(pTabList, i, zName, 0, 0)
  111424. ){
  111425. /* In a NATURAL join, omit the join columns from the
  111426. ** table to the right of the join */
  111427. continue;
  111428. }
  111429. if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
  111430. /* In a join with a USING clause, omit columns in the
  111431. ** using clause from the table on the right. */
  111432. continue;
  111433. }
  111434. }
  111435. pRight = sqlite3Expr(db, TK_ID, zName);
  111436. zColname = zName;
  111437. zToFree = 0;
  111438. if( longNames || pTabList->nSrc>1 ){
  111439. Expr *pLeft;
  111440. pLeft = sqlite3Expr(db, TK_ID, zTabName);
  111441. pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight, 0);
  111442. if( zSchemaName ){
  111443. pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
  111444. pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr, 0);
  111445. }
  111446. if( longNames ){
  111447. zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
  111448. zToFree = zColname;
  111449. }
  111450. }else{
  111451. pExpr = pRight;
  111452. }
  111453. pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
  111454. sqlite3TokenInit(&sColname, zColname);
  111455. sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
  111456. if( pNew && (p->selFlags & SF_NestedFrom)!=0 ){
  111457. struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
  111458. if( pSub ){
  111459. pX->zSpan = sqlite3DbStrDup(db, pSub->pEList->a[j].zSpan);
  111460. testcase( pX->zSpan==0 );
  111461. }else{
  111462. pX->zSpan = sqlite3MPrintf(db, "%s.%s.%s",
  111463. zSchemaName, zTabName, zColname);
  111464. testcase( pX->zSpan==0 );
  111465. }
  111466. pX->bSpanIsTab = 1;
  111467. }
  111468. sqlite3DbFree(db, zToFree);
  111469. }
  111470. }
  111471. if( !tableSeen ){
  111472. if( zTName ){
  111473. sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
  111474. }else{
  111475. sqlite3ErrorMsg(pParse, "no tables specified");
  111476. }
  111477. }
  111478. }
  111479. }
  111480. sqlite3ExprListDelete(db, pEList);
  111481. p->pEList = pNew;
  111482. }
  111483. #if SQLITE_MAX_COLUMN
  111484. if( p->pEList && p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  111485. sqlite3ErrorMsg(pParse, "too many columns in result set");
  111486. return WRC_Abort;
  111487. }
  111488. #endif
  111489. return WRC_Continue;
  111490. }
  111491. /*
  111492. ** No-op routine for the parse-tree walker.
  111493. **
  111494. ** When this routine is the Walker.xExprCallback then expression trees
  111495. ** are walked without any actions being taken at each node. Presumably,
  111496. ** when this routine is used for Walker.xExprCallback then
  111497. ** Walker.xSelectCallback is set to do something useful for every
  111498. ** subquery in the parser tree.
  111499. */
  111500. SQLITE_PRIVATE int sqlite3ExprWalkNoop(Walker *NotUsed, Expr *NotUsed2){
  111501. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  111502. return WRC_Continue;
  111503. }
  111504. /*
  111505. ** This routine "expands" a SELECT statement and all of its subqueries.
  111506. ** For additional information on what it means to "expand" a SELECT
  111507. ** statement, see the comment on the selectExpand worker callback above.
  111508. **
  111509. ** Expanding a SELECT statement is the first step in processing a
  111510. ** SELECT statement. The SELECT statement must be expanded before
  111511. ** name resolution is performed.
  111512. **
  111513. ** If anything goes wrong, an error message is written into pParse.
  111514. ** The calling function can detect the problem by looking at pParse->nErr
  111515. ** and/or pParse->db->mallocFailed.
  111516. */
  111517. static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
  111518. Walker w;
  111519. memset(&w, 0, sizeof(w));
  111520. w.xExprCallback = sqlite3ExprWalkNoop;
  111521. w.pParse = pParse;
  111522. if( pParse->hasCompound ){
  111523. w.xSelectCallback = convertCompoundSelectToSubquery;
  111524. sqlite3WalkSelect(&w, pSelect);
  111525. }
  111526. w.xSelectCallback = selectExpander;
  111527. if( (pSelect->selFlags & SF_MultiValue)==0 ){
  111528. w.xSelectCallback2 = selectPopWith;
  111529. }
  111530. sqlite3WalkSelect(&w, pSelect);
  111531. }
  111532. #ifndef SQLITE_OMIT_SUBQUERY
  111533. /*
  111534. ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
  111535. ** interface.
  111536. **
  111537. ** For each FROM-clause subquery, add Column.zType and Column.zColl
  111538. ** information to the Table structure that represents the result set
  111539. ** of that subquery.
  111540. **
  111541. ** The Table structure that represents the result set was constructed
  111542. ** by selectExpander() but the type and collation information was omitted
  111543. ** at that point because identifiers had not yet been resolved. This
  111544. ** routine is called after identifier resolution.
  111545. */
  111546. static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
  111547. Parse *pParse;
  111548. int i;
  111549. SrcList *pTabList;
  111550. struct SrcList_item *pFrom;
  111551. assert( p->selFlags & SF_Resolved );
  111552. assert( (p->selFlags & SF_HasTypeInfo)==0 );
  111553. p->selFlags |= SF_HasTypeInfo;
  111554. pParse = pWalker->pParse;
  111555. pTabList = p->pSrc;
  111556. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  111557. Table *pTab = pFrom->pTab;
  111558. assert( pTab!=0 );
  111559. if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
  111560. /* A sub-query in the FROM clause of a SELECT */
  111561. Select *pSel = pFrom->pSelect;
  111562. if( pSel ){
  111563. while( pSel->pPrior ) pSel = pSel->pPrior;
  111564. sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel);
  111565. }
  111566. }
  111567. }
  111568. }
  111569. #endif
  111570. /*
  111571. ** This routine adds datatype and collating sequence information to
  111572. ** the Table structures of all FROM-clause subqueries in a
  111573. ** SELECT statement.
  111574. **
  111575. ** Use this routine after name resolution.
  111576. */
  111577. static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
  111578. #ifndef SQLITE_OMIT_SUBQUERY
  111579. Walker w;
  111580. memset(&w, 0, sizeof(w));
  111581. w.xSelectCallback2 = selectAddSubqueryTypeInfo;
  111582. w.xExprCallback = sqlite3ExprWalkNoop;
  111583. w.pParse = pParse;
  111584. sqlite3WalkSelect(&w, pSelect);
  111585. #endif
  111586. }
  111587. /*
  111588. ** This routine sets up a SELECT statement for processing. The
  111589. ** following is accomplished:
  111590. **
  111591. ** * VDBE Cursor numbers are assigned to all FROM-clause terms.
  111592. ** * Ephemeral Table objects are created for all FROM-clause subqueries.
  111593. ** * ON and USING clauses are shifted into WHERE statements
  111594. ** * Wildcards "*" and "TABLE.*" in result sets are expanded.
  111595. ** * Identifiers in expression are matched to tables.
  111596. **
  111597. ** This routine acts recursively on all subqueries within the SELECT.
  111598. */
  111599. SQLITE_PRIVATE void sqlite3SelectPrep(
  111600. Parse *pParse, /* The parser context */
  111601. Select *p, /* The SELECT statement being coded. */
  111602. NameContext *pOuterNC /* Name context for container */
  111603. ){
  111604. sqlite3 *db;
  111605. if( NEVER(p==0) ) return;
  111606. db = pParse->db;
  111607. if( db->mallocFailed ) return;
  111608. if( p->selFlags & SF_HasTypeInfo ) return;
  111609. sqlite3SelectExpand(pParse, p);
  111610. if( pParse->nErr || db->mallocFailed ) return;
  111611. sqlite3ResolveSelectNames(pParse, p, pOuterNC);
  111612. if( pParse->nErr || db->mallocFailed ) return;
  111613. sqlite3SelectAddTypeInfo(pParse, p);
  111614. }
  111615. /*
  111616. ** Reset the aggregate accumulator.
  111617. **
  111618. ** The aggregate accumulator is a set of memory cells that hold
  111619. ** intermediate results while calculating an aggregate. This
  111620. ** routine generates code that stores NULLs in all of those memory
  111621. ** cells.
  111622. */
  111623. static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
  111624. Vdbe *v = pParse->pVdbe;
  111625. int i;
  111626. struct AggInfo_func *pFunc;
  111627. int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
  111628. if( nReg==0 ) return;
  111629. #ifdef SQLITE_DEBUG
  111630. /* Verify that all AggInfo registers are within the range specified by
  111631. ** AggInfo.mnReg..AggInfo.mxReg */
  111632. assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
  111633. for(i=0; i<pAggInfo->nColumn; i++){
  111634. assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
  111635. && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
  111636. }
  111637. for(i=0; i<pAggInfo->nFunc; i++){
  111638. assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
  111639. && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
  111640. }
  111641. #endif
  111642. sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
  111643. for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
  111644. if( pFunc->iDistinct>=0 ){
  111645. Expr *pE = pFunc->pExpr;
  111646. assert( !ExprHasProperty(pE, EP_xIsSelect) );
  111647. if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
  111648. sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
  111649. "argument");
  111650. pFunc->iDistinct = -1;
  111651. }else{
  111652. KeyInfo *pKeyInfo = keyInfoFromExprList(pParse, pE->x.pList, 0, 0);
  111653. sqlite3VdbeAddOp4(v, OP_OpenEphemeral, pFunc->iDistinct, 0, 0,
  111654. (char*)pKeyInfo, P4_KEYINFO);
  111655. }
  111656. }
  111657. }
  111658. }
  111659. /*
  111660. ** Invoke the OP_AggFinalize opcode for every aggregate function
  111661. ** in the AggInfo structure.
  111662. */
  111663. static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
  111664. Vdbe *v = pParse->pVdbe;
  111665. int i;
  111666. struct AggInfo_func *pF;
  111667. for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
  111668. ExprList *pList = pF->pExpr->x.pList;
  111669. assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
  111670. sqlite3VdbeAddOp4(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0, 0,
  111671. (void*)pF->pFunc, P4_FUNCDEF);
  111672. }
  111673. }
  111674. /*
  111675. ** Update the accumulator memory cells for an aggregate based on
  111676. ** the current cursor position.
  111677. */
  111678. static void updateAccumulator(Parse *pParse, AggInfo *pAggInfo){
  111679. Vdbe *v = pParse->pVdbe;
  111680. int i;
  111681. int regHit = 0;
  111682. int addrHitTest = 0;
  111683. struct AggInfo_func *pF;
  111684. struct AggInfo_col *pC;
  111685. pAggInfo->directMode = 1;
  111686. for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
  111687. int nArg;
  111688. int addrNext = 0;
  111689. int regAgg;
  111690. ExprList *pList = pF->pExpr->x.pList;
  111691. assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
  111692. if( pList ){
  111693. nArg = pList->nExpr;
  111694. regAgg = sqlite3GetTempRange(pParse, nArg);
  111695. sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
  111696. }else{
  111697. nArg = 0;
  111698. regAgg = 0;
  111699. }
  111700. if( pF->iDistinct>=0 ){
  111701. addrNext = sqlite3VdbeMakeLabel(v);
  111702. testcase( nArg==0 ); /* Error condition */
  111703. testcase( nArg>1 ); /* Also an error */
  111704. codeDistinct(pParse, pF->iDistinct, addrNext, 1, regAgg);
  111705. }
  111706. if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
  111707. CollSeq *pColl = 0;
  111708. struct ExprList_item *pItem;
  111709. int j;
  111710. assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
  111711. for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
  111712. pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
  111713. }
  111714. if( !pColl ){
  111715. pColl = pParse->db->pDfltColl;
  111716. }
  111717. if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
  111718. sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
  111719. }
  111720. sqlite3VdbeAddOp4(v, OP_AggStep0, 0, regAgg, pF->iMem,
  111721. (void*)pF->pFunc, P4_FUNCDEF);
  111722. sqlite3VdbeChangeP5(v, (u8)nArg);
  111723. sqlite3ExprCacheAffinityChange(pParse, regAgg, nArg);
  111724. sqlite3ReleaseTempRange(pParse, regAgg, nArg);
  111725. if( addrNext ){
  111726. sqlite3VdbeResolveLabel(v, addrNext);
  111727. sqlite3ExprCacheClear(pParse);
  111728. }
  111729. }
  111730. /* Before populating the accumulator registers, clear the column cache.
  111731. ** Otherwise, if any of the required column values are already present
  111732. ** in registers, sqlite3ExprCode() may use OP_SCopy to copy the value
  111733. ** to pC->iMem. But by the time the value is used, the original register
  111734. ** may have been used, invalidating the underlying buffer holding the
  111735. ** text or blob value. See ticket [883034dcb5].
  111736. **
  111737. ** Another solution would be to change the OP_SCopy used to copy cached
  111738. ** values to an OP_Copy.
  111739. */
  111740. if( regHit ){
  111741. addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
  111742. }
  111743. sqlite3ExprCacheClear(pParse);
  111744. for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
  111745. sqlite3ExprCode(pParse, pC->pExpr, pC->iMem);
  111746. }
  111747. pAggInfo->directMode = 0;
  111748. sqlite3ExprCacheClear(pParse);
  111749. if( addrHitTest ){
  111750. sqlite3VdbeJumpHere(v, addrHitTest);
  111751. }
  111752. }
  111753. /*
  111754. ** Add a single OP_Explain instruction to the VDBE to explain a simple
  111755. ** count(*) query ("SELECT count(*) FROM pTab").
  111756. */
  111757. #ifndef SQLITE_OMIT_EXPLAIN
  111758. static void explainSimpleCount(
  111759. Parse *pParse, /* Parse context */
  111760. Table *pTab, /* Table being queried */
  111761. Index *pIdx /* Index used to optimize scan, or NULL */
  111762. ){
  111763. if( pParse->explain==2 ){
  111764. int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
  111765. char *zEqp = sqlite3MPrintf(pParse->db, "SCAN TABLE %s%s%s",
  111766. pTab->zName,
  111767. bCover ? " USING COVERING INDEX " : "",
  111768. bCover ? pIdx->zName : ""
  111769. );
  111770. sqlite3VdbeAddOp4(
  111771. pParse->pVdbe, OP_Explain, pParse->iSelectId, 0, 0, zEqp, P4_DYNAMIC
  111772. );
  111773. }
  111774. }
  111775. #else
  111776. # define explainSimpleCount(a,b,c)
  111777. #endif
  111778. /*
  111779. ** Generate code for the SELECT statement given in the p argument.
  111780. **
  111781. ** The results are returned according to the SelectDest structure.
  111782. ** See comments in sqliteInt.h for further information.
  111783. **
  111784. ** This routine returns the number of errors. If any errors are
  111785. ** encountered, then an appropriate error message is left in
  111786. ** pParse->zErrMsg.
  111787. **
  111788. ** This routine does NOT free the Select structure passed in. The
  111789. ** calling function needs to do that.
  111790. */
  111791. SQLITE_PRIVATE int sqlite3Select(
  111792. Parse *pParse, /* The parser context */
  111793. Select *p, /* The SELECT statement being coded. */
  111794. SelectDest *pDest /* What to do with the query results */
  111795. ){
  111796. int i, j; /* Loop counters */
  111797. WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
  111798. Vdbe *v; /* The virtual machine under construction */
  111799. int isAgg; /* True for select lists like "count(*)" */
  111800. ExprList *pEList = 0; /* List of columns to extract. */
  111801. SrcList *pTabList; /* List of tables to select from */
  111802. Expr *pWhere; /* The WHERE clause. May be NULL */
  111803. ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
  111804. Expr *pHaving; /* The HAVING clause. May be NULL */
  111805. int rc = 1; /* Value to return from this function */
  111806. DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
  111807. SortCtx sSort; /* Info on how to code the ORDER BY clause */
  111808. AggInfo sAggInfo; /* Information used by aggregate queries */
  111809. int iEnd; /* Address of the end of the query */
  111810. sqlite3 *db; /* The database connection */
  111811. #ifndef SQLITE_OMIT_EXPLAIN
  111812. int iRestoreSelectId = pParse->iSelectId;
  111813. pParse->iSelectId = pParse->iNextSelectId++;
  111814. #endif
  111815. db = pParse->db;
  111816. if( p==0 || db->mallocFailed || pParse->nErr ){
  111817. return 1;
  111818. }
  111819. if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
  111820. memset(&sAggInfo, 0, sizeof(sAggInfo));
  111821. #if SELECTTRACE_ENABLED
  111822. pParse->nSelectIndent++;
  111823. SELECTTRACE(1,pParse,p, ("begin processing:\n"));
  111824. if( sqlite3SelectTrace & 0x100 ){
  111825. sqlite3TreeViewSelect(0, p, 0);
  111826. }
  111827. #endif
  111828. assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
  111829. assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
  111830. assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
  111831. assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
  111832. if( IgnorableOrderby(pDest) ){
  111833. assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
  111834. pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
  111835. pDest->eDest==SRT_Queue || pDest->eDest==SRT_DistFifo ||
  111836. pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_Fifo);
  111837. /* If ORDER BY makes no difference in the output then neither does
  111838. ** DISTINCT so it can be removed too. */
  111839. sqlite3ExprListDelete(db, p->pOrderBy);
  111840. p->pOrderBy = 0;
  111841. p->selFlags &= ~SF_Distinct;
  111842. }
  111843. sqlite3SelectPrep(pParse, p, 0);
  111844. memset(&sSort, 0, sizeof(sSort));
  111845. sSort.pOrderBy = p->pOrderBy;
  111846. pTabList = p->pSrc;
  111847. if( pParse->nErr || db->mallocFailed ){
  111848. goto select_end;
  111849. }
  111850. assert( p->pEList!=0 );
  111851. isAgg = (p->selFlags & SF_Aggregate)!=0;
  111852. #if SELECTTRACE_ENABLED
  111853. if( sqlite3SelectTrace & 0x100 ){
  111854. SELECTTRACE(0x100,pParse,p, ("after name resolution:\n"));
  111855. sqlite3TreeViewSelect(0, p, 0);
  111856. }
  111857. #endif
  111858. /* Try to flatten subqueries in the FROM clause up into the main query
  111859. */
  111860. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  111861. for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
  111862. struct SrcList_item *pItem = &pTabList->a[i];
  111863. Select *pSub = pItem->pSelect;
  111864. int isAggSub;
  111865. Table *pTab = pItem->pTab;
  111866. if( pSub==0 ) continue;
  111867. /* Catch mismatch in the declared columns of a view and the number of
  111868. ** columns in the SELECT on the RHS */
  111869. if( pTab->nCol!=pSub->pEList->nExpr ){
  111870. sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
  111871. pTab->nCol, pTab->zName, pSub->pEList->nExpr);
  111872. goto select_end;
  111873. }
  111874. isAggSub = (pSub->selFlags & SF_Aggregate)!=0;
  111875. if( flattenSubquery(pParse, p, i, isAgg, isAggSub) ){
  111876. /* This subquery can be absorbed into its parent. */
  111877. if( isAggSub ){
  111878. isAgg = 1;
  111879. p->selFlags |= SF_Aggregate;
  111880. }
  111881. i = -1;
  111882. }
  111883. pTabList = p->pSrc;
  111884. if( db->mallocFailed ) goto select_end;
  111885. if( !IgnorableOrderby(pDest) ){
  111886. sSort.pOrderBy = p->pOrderBy;
  111887. }
  111888. }
  111889. #endif
  111890. /* Get a pointer the VDBE under construction, allocating a new VDBE if one
  111891. ** does not already exist */
  111892. v = sqlite3GetVdbe(pParse);
  111893. if( v==0 ) goto select_end;
  111894. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  111895. /* Handle compound SELECT statements using the separate multiSelect()
  111896. ** procedure.
  111897. */
  111898. if( p->pPrior ){
  111899. rc = multiSelect(pParse, p, pDest);
  111900. explainSetInteger(pParse->iSelectId, iRestoreSelectId);
  111901. #if SELECTTRACE_ENABLED
  111902. SELECTTRACE(1,pParse,p,("end compound-select processing\n"));
  111903. pParse->nSelectIndent--;
  111904. #endif
  111905. return rc;
  111906. }
  111907. #endif
  111908. /* Generate code for all sub-queries in the FROM clause
  111909. */
  111910. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  111911. for(i=0; i<pTabList->nSrc; i++){
  111912. struct SrcList_item *pItem = &pTabList->a[i];
  111913. SelectDest dest;
  111914. Select *pSub = pItem->pSelect;
  111915. if( pSub==0 ) continue;
  111916. /* Sometimes the code for a subquery will be generated more than
  111917. ** once, if the subquery is part of the WHERE clause in a LEFT JOIN,
  111918. ** for example. In that case, do not regenerate the code to manifest
  111919. ** a view or the co-routine to implement a view. The first instance
  111920. ** is sufficient, though the subroutine to manifest the view does need
  111921. ** to be invoked again. */
  111922. if( pItem->addrFillSub ){
  111923. if( pItem->fg.viaCoroutine==0 ){
  111924. sqlite3VdbeAddOp2(v, OP_Gosub, pItem->regReturn, pItem->addrFillSub);
  111925. }
  111926. continue;
  111927. }
  111928. /* Increment Parse.nHeight by the height of the largest expression
  111929. ** tree referred to by this, the parent select. The child select
  111930. ** may contain expression trees of at most
  111931. ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
  111932. ** more conservative than necessary, but much easier than enforcing
  111933. ** an exact limit.
  111934. */
  111935. pParse->nHeight += sqlite3SelectExprHeight(p);
  111936. /* Make copies of constant WHERE-clause terms in the outer query down
  111937. ** inside the subquery. This can help the subquery to run more efficiently.
  111938. */
  111939. if( (pItem->fg.jointype & JT_OUTER)==0
  111940. && pushDownWhereTerms(db, pSub, p->pWhere, pItem->iCursor)
  111941. ){
  111942. #if SELECTTRACE_ENABLED
  111943. if( sqlite3SelectTrace & 0x100 ){
  111944. SELECTTRACE(0x100,pParse,p,("After WHERE-clause push-down:\n"));
  111945. sqlite3TreeViewSelect(0, p, 0);
  111946. }
  111947. #endif
  111948. }
  111949. /* Generate code to implement the subquery
  111950. **
  111951. ** The subquery is implemented as a co-routine if all of these are true:
  111952. ** (1) The subquery is guaranteed to be the outer loop (so that it
  111953. ** does not need to be computed more than once)
  111954. ** (2) The ALL keyword after SELECT is omitted. (Applications are
  111955. ** allowed to say "SELECT ALL" instead of just "SELECT" to disable
  111956. ** the use of co-routines.)
  111957. ** (3) Co-routines are not disabled using sqlite3_test_control()
  111958. ** with SQLITE_TESTCTRL_OPTIMIZATIONS.
  111959. **
  111960. ** TODO: Are there other reasons beside (1) to use a co-routine
  111961. ** implementation?
  111962. */
  111963. if( i==0
  111964. && (pTabList->nSrc==1
  111965. || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0) /* (1) */
  111966. && (p->selFlags & SF_All)==0 /* (2) */
  111967. && OptimizationEnabled(db, SQLITE_SubqCoroutine) /* (3) */
  111968. ){
  111969. /* Implement a co-routine that will return a single row of the result
  111970. ** set on each invocation.
  111971. */
  111972. int addrTop = sqlite3VdbeCurrentAddr(v)+1;
  111973. pItem->regReturn = ++pParse->nMem;
  111974. sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
  111975. VdbeComment((v, "%s", pItem->pTab->zName));
  111976. pItem->addrFillSub = addrTop;
  111977. sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
  111978. explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
  111979. sqlite3Select(pParse, pSub, &dest);
  111980. pItem->pTab->nRowLogEst = pSub->nSelectRow;
  111981. pItem->fg.viaCoroutine = 1;
  111982. pItem->regResult = dest.iSdst;
  111983. sqlite3VdbeEndCoroutine(v, pItem->regReturn);
  111984. sqlite3VdbeJumpHere(v, addrTop-1);
  111985. sqlite3ClearTempRegCache(pParse);
  111986. }else{
  111987. /* Generate a subroutine that will fill an ephemeral table with
  111988. ** the content of this subquery. pItem->addrFillSub will point
  111989. ** to the address of the generated subroutine. pItem->regReturn
  111990. ** is a register allocated to hold the subroutine return address
  111991. */
  111992. int topAddr;
  111993. int onceAddr = 0;
  111994. int retAddr;
  111995. assert( pItem->addrFillSub==0 );
  111996. pItem->regReturn = ++pParse->nMem;
  111997. topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
  111998. pItem->addrFillSub = topAddr+1;
  111999. if( pItem->fg.isCorrelated==0 ){
  112000. /* If the subquery is not correlated and if we are not inside of
  112001. ** a trigger, then we only need to compute the value of the subquery
  112002. ** once. */
  112003. onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  112004. VdbeComment((v, "materialize \"%s\"", pItem->pTab->zName));
  112005. }else{
  112006. VdbeNoopComment((v, "materialize \"%s\"", pItem->pTab->zName));
  112007. }
  112008. sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
  112009. explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
  112010. sqlite3Select(pParse, pSub, &dest);
  112011. pItem->pTab->nRowLogEst = pSub->nSelectRow;
  112012. if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
  112013. retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
  112014. VdbeComment((v, "end %s", pItem->pTab->zName));
  112015. sqlite3VdbeChangeP1(v, topAddr, retAddr);
  112016. sqlite3ClearTempRegCache(pParse);
  112017. }
  112018. if( db->mallocFailed ) goto select_end;
  112019. pParse->nHeight -= sqlite3SelectExprHeight(p);
  112020. }
  112021. #endif
  112022. /* Various elements of the SELECT copied into local variables for
  112023. ** convenience */
  112024. pEList = p->pEList;
  112025. pWhere = p->pWhere;
  112026. pGroupBy = p->pGroupBy;
  112027. pHaving = p->pHaving;
  112028. sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
  112029. #if SELECTTRACE_ENABLED
  112030. if( sqlite3SelectTrace & 0x400 ){
  112031. SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
  112032. sqlite3TreeViewSelect(0, p, 0);
  112033. }
  112034. #endif
  112035. /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
  112036. ** if the select-list is the same as the ORDER BY list, then this query
  112037. ** can be rewritten as a GROUP BY. In other words, this:
  112038. **
  112039. ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
  112040. **
  112041. ** is transformed to:
  112042. **
  112043. ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
  112044. **
  112045. ** The second form is preferred as a single index (or temp-table) may be
  112046. ** used for both the ORDER BY and DISTINCT processing. As originally
  112047. ** written the query must use a temp-table for at least one of the ORDER
  112048. ** BY and DISTINCT, and an index or separate temp-table for the other.
  112049. */
  112050. if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
  112051. && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
  112052. ){
  112053. p->selFlags &= ~SF_Distinct;
  112054. pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
  112055. /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
  112056. ** the sDistinct.isTnct is still set. Hence, isTnct represents the
  112057. ** original setting of the SF_Distinct flag, not the current setting */
  112058. assert( sDistinct.isTnct );
  112059. #if SELECTTRACE_ENABLED
  112060. if( sqlite3SelectTrace & 0x400 ){
  112061. SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
  112062. sqlite3TreeViewSelect(0, p, 0);
  112063. }
  112064. #endif
  112065. }
  112066. /* If there is an ORDER BY clause, then create an ephemeral index to
  112067. ** do the sorting. But this sorting ephemeral index might end up
  112068. ** being unused if the data can be extracted in pre-sorted order.
  112069. ** If that is the case, then the OP_OpenEphemeral instruction will be
  112070. ** changed to an OP_Noop once we figure out that the sorting index is
  112071. ** not needed. The sSort.addrSortIndex variable is used to facilitate
  112072. ** that change.
  112073. */
  112074. if( sSort.pOrderBy ){
  112075. KeyInfo *pKeyInfo;
  112076. pKeyInfo = keyInfoFromExprList(pParse, sSort.pOrderBy, 0, pEList->nExpr);
  112077. sSort.iECursor = pParse->nTab++;
  112078. sSort.addrSortIndex =
  112079. sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
  112080. sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
  112081. (char*)pKeyInfo, P4_KEYINFO
  112082. );
  112083. }else{
  112084. sSort.addrSortIndex = -1;
  112085. }
  112086. /* If the output is destined for a temporary table, open that table.
  112087. */
  112088. if( pDest->eDest==SRT_EphemTab ){
  112089. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
  112090. }
  112091. /* Set the limiter.
  112092. */
  112093. iEnd = sqlite3VdbeMakeLabel(v);
  112094. p->nSelectRow = 320; /* 4 billion rows */
  112095. computeLimitRegisters(pParse, p, iEnd);
  112096. if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
  112097. sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
  112098. sSort.sortFlags |= SORTFLAG_UseSorter;
  112099. }
  112100. /* Open an ephemeral index to use for the distinct set.
  112101. */
  112102. if( p->selFlags & SF_Distinct ){
  112103. sDistinct.tabTnct = pParse->nTab++;
  112104. sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
  112105. sDistinct.tabTnct, 0, 0,
  112106. (char*)keyInfoFromExprList(pParse, p->pEList,0,0),
  112107. P4_KEYINFO);
  112108. sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
  112109. sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
  112110. }else{
  112111. sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
  112112. }
  112113. if( !isAgg && pGroupBy==0 ){
  112114. /* No aggregate functions and no GROUP BY clause */
  112115. u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0);
  112116. assert( WHERE_USE_LIMIT==SF_FixedLimit );
  112117. wctrlFlags |= p->selFlags & SF_FixedLimit;
  112118. /* Begin the database scan. */
  112119. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
  112120. p->pEList, wctrlFlags, p->nSelectRow);
  112121. if( pWInfo==0 ) goto select_end;
  112122. if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
  112123. p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
  112124. }
  112125. if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
  112126. sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
  112127. }
  112128. if( sSort.pOrderBy ){
  112129. sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
  112130. sSort.bOrderedInnerLoop = sqlite3WhereOrderedInnerLoop(pWInfo);
  112131. if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
  112132. sSort.pOrderBy = 0;
  112133. }
  112134. }
  112135. /* If sorting index that was created by a prior OP_OpenEphemeral
  112136. ** instruction ended up not being needed, then change the OP_OpenEphemeral
  112137. ** into an OP_Noop.
  112138. */
  112139. if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
  112140. sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
  112141. }
  112142. /* Use the standard inner loop. */
  112143. selectInnerLoop(pParse, p, pEList, -1, &sSort, &sDistinct, pDest,
  112144. sqlite3WhereContinueLabel(pWInfo),
  112145. sqlite3WhereBreakLabel(pWInfo));
  112146. /* End the database scan loop.
  112147. */
  112148. sqlite3WhereEnd(pWInfo);
  112149. }else{
  112150. /* This case when there exist aggregate functions or a GROUP BY clause
  112151. ** or both */
  112152. NameContext sNC; /* Name context for processing aggregate information */
  112153. int iAMem; /* First Mem address for storing current GROUP BY */
  112154. int iBMem; /* First Mem address for previous GROUP BY */
  112155. int iUseFlag; /* Mem address holding flag indicating that at least
  112156. ** one row of the input to the aggregator has been
  112157. ** processed */
  112158. int iAbortFlag; /* Mem address which causes query abort if positive */
  112159. int groupBySort; /* Rows come from source in GROUP BY order */
  112160. int addrEnd; /* End of processing for this SELECT */
  112161. int sortPTab = 0; /* Pseudotable used to decode sorting results */
  112162. int sortOut = 0; /* Output register from the sorter */
  112163. int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
  112164. /* Remove any and all aliases between the result set and the
  112165. ** GROUP BY clause.
  112166. */
  112167. if( pGroupBy ){
  112168. int k; /* Loop counter */
  112169. struct ExprList_item *pItem; /* For looping over expression in a list */
  112170. for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
  112171. pItem->u.x.iAlias = 0;
  112172. }
  112173. for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
  112174. pItem->u.x.iAlias = 0;
  112175. }
  112176. assert( 66==sqlite3LogEst(100) );
  112177. if( p->nSelectRow>66 ) p->nSelectRow = 66;
  112178. }else{
  112179. assert( 0==sqlite3LogEst(1) );
  112180. p->nSelectRow = 0;
  112181. }
  112182. /* If there is both a GROUP BY and an ORDER BY clause and they are
  112183. ** identical, then it may be possible to disable the ORDER BY clause
  112184. ** on the grounds that the GROUP BY will cause elements to come out
  112185. ** in the correct order. It also may not - the GROUP BY might use a
  112186. ** database index that causes rows to be grouped together as required
  112187. ** but not actually sorted. Either way, record the fact that the
  112188. ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
  112189. ** variable. */
  112190. if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
  112191. orderByGrp = 1;
  112192. }
  112193. /* Create a label to jump to when we want to abort the query */
  112194. addrEnd = sqlite3VdbeMakeLabel(v);
  112195. /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
  112196. ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
  112197. ** SELECT statement.
  112198. */
  112199. memset(&sNC, 0, sizeof(sNC));
  112200. sNC.pParse = pParse;
  112201. sNC.pSrcList = pTabList;
  112202. sNC.pAggInfo = &sAggInfo;
  112203. sAggInfo.mnReg = pParse->nMem+1;
  112204. sAggInfo.nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
  112205. sAggInfo.pGroupBy = pGroupBy;
  112206. sqlite3ExprAnalyzeAggList(&sNC, pEList);
  112207. sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
  112208. if( pHaving ){
  112209. sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
  112210. }
  112211. sAggInfo.nAccumulator = sAggInfo.nColumn;
  112212. for(i=0; i<sAggInfo.nFunc; i++){
  112213. assert( !ExprHasProperty(sAggInfo.aFunc[i].pExpr, EP_xIsSelect) );
  112214. sNC.ncFlags |= NC_InAggFunc;
  112215. sqlite3ExprAnalyzeAggList(&sNC, sAggInfo.aFunc[i].pExpr->x.pList);
  112216. sNC.ncFlags &= ~NC_InAggFunc;
  112217. }
  112218. sAggInfo.mxReg = pParse->nMem;
  112219. if( db->mallocFailed ) goto select_end;
  112220. /* Processing for aggregates with GROUP BY is very different and
  112221. ** much more complex than aggregates without a GROUP BY.
  112222. */
  112223. if( pGroupBy ){
  112224. KeyInfo *pKeyInfo; /* Keying information for the group by clause */
  112225. int addr1; /* A-vs-B comparision jump */
  112226. int addrOutputRow; /* Start of subroutine that outputs a result row */
  112227. int regOutputRow; /* Return address register for output subroutine */
  112228. int addrSetAbort; /* Set the abort flag and return */
  112229. int addrTopOfLoop; /* Top of the input loop */
  112230. int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
  112231. int addrReset; /* Subroutine for resetting the accumulator */
  112232. int regReset; /* Return address register for reset subroutine */
  112233. /* If there is a GROUP BY clause we might need a sorting index to
  112234. ** implement it. Allocate that sorting index now. If it turns out
  112235. ** that we do not need it after all, the OP_SorterOpen instruction
  112236. ** will be converted into a Noop.
  112237. */
  112238. sAggInfo.sortingIdx = pParse->nTab++;
  112239. pKeyInfo = keyInfoFromExprList(pParse, pGroupBy, 0, sAggInfo.nColumn);
  112240. addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
  112241. sAggInfo.sortingIdx, sAggInfo.nSortingColumn,
  112242. 0, (char*)pKeyInfo, P4_KEYINFO);
  112243. /* Initialize memory locations used by GROUP BY aggregate processing
  112244. */
  112245. iUseFlag = ++pParse->nMem;
  112246. iAbortFlag = ++pParse->nMem;
  112247. regOutputRow = ++pParse->nMem;
  112248. addrOutputRow = sqlite3VdbeMakeLabel(v);
  112249. regReset = ++pParse->nMem;
  112250. addrReset = sqlite3VdbeMakeLabel(v);
  112251. iAMem = pParse->nMem + 1;
  112252. pParse->nMem += pGroupBy->nExpr;
  112253. iBMem = pParse->nMem + 1;
  112254. pParse->nMem += pGroupBy->nExpr;
  112255. sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
  112256. VdbeComment((v, "clear abort flag"));
  112257. sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
  112258. VdbeComment((v, "indicate accumulator empty"));
  112259. sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
  112260. /* Begin a loop that will extract all source rows in GROUP BY order.
  112261. ** This might involve two separate loops with an OP_Sort in between, or
  112262. ** it might be a single loop that uses an index to extract information
  112263. ** in the right order to begin with.
  112264. */
  112265. sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
  112266. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, 0,
  112267. WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0), 0
  112268. );
  112269. if( pWInfo==0 ) goto select_end;
  112270. if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
  112271. /* The optimizer is able to deliver rows in group by order so
  112272. ** we do not have to sort. The OP_OpenEphemeral table will be
  112273. ** cancelled later because we still need to use the pKeyInfo
  112274. */
  112275. groupBySort = 0;
  112276. }else{
  112277. /* Rows are coming out in undetermined order. We have to push
  112278. ** each row into a sorting index, terminate the first loop,
  112279. ** then loop over the sorting index in order to get the output
  112280. ** in sorted order
  112281. */
  112282. int regBase;
  112283. int regRecord;
  112284. int nCol;
  112285. int nGroupBy;
  112286. explainTempTable(pParse,
  112287. (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
  112288. "DISTINCT" : "GROUP BY");
  112289. groupBySort = 1;
  112290. nGroupBy = pGroupBy->nExpr;
  112291. nCol = nGroupBy;
  112292. j = nGroupBy;
  112293. for(i=0; i<sAggInfo.nColumn; i++){
  112294. if( sAggInfo.aCol[i].iSorterColumn>=j ){
  112295. nCol++;
  112296. j++;
  112297. }
  112298. }
  112299. regBase = sqlite3GetTempRange(pParse, nCol);
  112300. sqlite3ExprCacheClear(pParse);
  112301. sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
  112302. j = nGroupBy;
  112303. for(i=0; i<sAggInfo.nColumn; i++){
  112304. struct AggInfo_col *pCol = &sAggInfo.aCol[i];
  112305. if( pCol->iSorterColumn>=j ){
  112306. int r1 = j + regBase;
  112307. sqlite3ExprCodeGetColumnToReg(pParse,
  112308. pCol->pTab, pCol->iColumn, pCol->iTable, r1);
  112309. j++;
  112310. }
  112311. }
  112312. regRecord = sqlite3GetTempReg(pParse);
  112313. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
  112314. sqlite3VdbeAddOp2(v, OP_SorterInsert, sAggInfo.sortingIdx, regRecord);
  112315. sqlite3ReleaseTempReg(pParse, regRecord);
  112316. sqlite3ReleaseTempRange(pParse, regBase, nCol);
  112317. sqlite3WhereEnd(pWInfo);
  112318. sAggInfo.sortingIdxPTab = sortPTab = pParse->nTab++;
  112319. sortOut = sqlite3GetTempReg(pParse);
  112320. sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
  112321. sqlite3VdbeAddOp2(v, OP_SorterSort, sAggInfo.sortingIdx, addrEnd);
  112322. VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
  112323. sAggInfo.useSortingIdx = 1;
  112324. sqlite3ExprCacheClear(pParse);
  112325. }
  112326. /* If the index or temporary table used by the GROUP BY sort
  112327. ** will naturally deliver rows in the order required by the ORDER BY
  112328. ** clause, cancel the ephemeral table open coded earlier.
  112329. **
  112330. ** This is an optimization - the correct answer should result regardless.
  112331. ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
  112332. ** disable this optimization for testing purposes. */
  112333. if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
  112334. && (groupBySort || sqlite3WhereIsSorted(pWInfo))
  112335. ){
  112336. sSort.pOrderBy = 0;
  112337. sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
  112338. }
  112339. /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
  112340. ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
  112341. ** Then compare the current GROUP BY terms against the GROUP BY terms
  112342. ** from the previous row currently stored in a0, a1, a2...
  112343. */
  112344. addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
  112345. sqlite3ExprCacheClear(pParse);
  112346. if( groupBySort ){
  112347. sqlite3VdbeAddOp3(v, OP_SorterData, sAggInfo.sortingIdx,
  112348. sortOut, sortPTab);
  112349. }
  112350. for(j=0; j<pGroupBy->nExpr; j++){
  112351. if( groupBySort ){
  112352. sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
  112353. }else{
  112354. sAggInfo.directMode = 1;
  112355. sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
  112356. }
  112357. }
  112358. sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
  112359. (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
  112360. addr1 = sqlite3VdbeCurrentAddr(v);
  112361. sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
  112362. /* Generate code that runs whenever the GROUP BY changes.
  112363. ** Changes in the GROUP BY are detected by the previous code
  112364. ** block. If there were no changes, this block is skipped.
  112365. **
  112366. ** This code copies current group by terms in b0,b1,b2,...
  112367. ** over to a0,a1,a2. It then calls the output subroutine
  112368. ** and resets the aggregate accumulator registers in preparation
  112369. ** for the next GROUP BY batch.
  112370. */
  112371. sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
  112372. sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
  112373. VdbeComment((v, "output one row"));
  112374. sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
  112375. VdbeComment((v, "check abort flag"));
  112376. sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
  112377. VdbeComment((v, "reset accumulator"));
  112378. /* Update the aggregate accumulators based on the content of
  112379. ** the current row
  112380. */
  112381. sqlite3VdbeJumpHere(v, addr1);
  112382. updateAccumulator(pParse, &sAggInfo);
  112383. sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
  112384. VdbeComment((v, "indicate data in accumulator"));
  112385. /* End of the loop
  112386. */
  112387. if( groupBySort ){
  112388. sqlite3VdbeAddOp2(v, OP_SorterNext, sAggInfo.sortingIdx, addrTopOfLoop);
  112389. VdbeCoverage(v);
  112390. }else{
  112391. sqlite3WhereEnd(pWInfo);
  112392. sqlite3VdbeChangeToNoop(v, addrSortingIdx);
  112393. }
  112394. /* Output the final row of result
  112395. */
  112396. sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
  112397. VdbeComment((v, "output final row"));
  112398. /* Jump over the subroutines
  112399. */
  112400. sqlite3VdbeGoto(v, addrEnd);
  112401. /* Generate a subroutine that outputs a single row of the result
  112402. ** set. This subroutine first looks at the iUseFlag. If iUseFlag
  112403. ** is less than or equal to zero, the subroutine is a no-op. If
  112404. ** the processing calls for the query to abort, this subroutine
  112405. ** increments the iAbortFlag memory location before returning in
  112406. ** order to signal the caller to abort.
  112407. */
  112408. addrSetAbort = sqlite3VdbeCurrentAddr(v);
  112409. sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
  112410. VdbeComment((v, "set abort flag"));
  112411. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  112412. sqlite3VdbeResolveLabel(v, addrOutputRow);
  112413. addrOutputRow = sqlite3VdbeCurrentAddr(v);
  112414. sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
  112415. VdbeCoverage(v);
  112416. VdbeComment((v, "Groupby result generator entry point"));
  112417. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  112418. finalizeAggFunctions(pParse, &sAggInfo);
  112419. sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
  112420. selectInnerLoop(pParse, p, p->pEList, -1, &sSort,
  112421. &sDistinct, pDest,
  112422. addrOutputRow+1, addrSetAbort);
  112423. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  112424. VdbeComment((v, "end groupby result generator"));
  112425. /* Generate a subroutine that will reset the group-by accumulator
  112426. */
  112427. sqlite3VdbeResolveLabel(v, addrReset);
  112428. resetAccumulator(pParse, &sAggInfo);
  112429. sqlite3VdbeAddOp1(v, OP_Return, regReset);
  112430. } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
  112431. else {
  112432. ExprList *pDel = 0;
  112433. #ifndef SQLITE_OMIT_BTREECOUNT
  112434. Table *pTab;
  112435. if( (pTab = isSimpleCount(p, &sAggInfo))!=0 ){
  112436. /* If isSimpleCount() returns a pointer to a Table structure, then
  112437. ** the SQL statement is of the form:
  112438. **
  112439. ** SELECT count(*) FROM <tbl>
  112440. **
  112441. ** where the Table structure returned represents table <tbl>.
  112442. **
  112443. ** This statement is so common that it is optimized specially. The
  112444. ** OP_Count instruction is executed either on the intkey table that
  112445. ** contains the data for table <tbl> or on one of its indexes. It
  112446. ** is better to execute the op on an index, as indexes are almost
  112447. ** always spread across less pages than their corresponding tables.
  112448. */
  112449. const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  112450. const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
  112451. Index *pIdx; /* Iterator variable */
  112452. KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
  112453. Index *pBest = 0; /* Best index found so far */
  112454. int iRoot = pTab->tnum; /* Root page of scanned b-tree */
  112455. sqlite3CodeVerifySchema(pParse, iDb);
  112456. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  112457. /* Search for the index that has the lowest scan cost.
  112458. **
  112459. ** (2011-04-15) Do not do a full scan of an unordered index.
  112460. **
  112461. ** (2013-10-03) Do not count the entries in a partial index.
  112462. **
  112463. ** In practice the KeyInfo structure will not be used. It is only
  112464. ** passed to keep OP_OpenRead happy.
  112465. */
  112466. if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
  112467. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  112468. if( pIdx->bUnordered==0
  112469. && pIdx->szIdxRow<pTab->szTabRow
  112470. && pIdx->pPartIdxWhere==0
  112471. && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
  112472. ){
  112473. pBest = pIdx;
  112474. }
  112475. }
  112476. if( pBest ){
  112477. iRoot = pBest->tnum;
  112478. pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
  112479. }
  112480. /* Open a read-only cursor, execute the OP_Count, close the cursor. */
  112481. sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, iRoot, iDb, 1);
  112482. if( pKeyInfo ){
  112483. sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
  112484. }
  112485. sqlite3VdbeAddOp2(v, OP_Count, iCsr, sAggInfo.aFunc[0].iMem);
  112486. sqlite3VdbeAddOp1(v, OP_Close, iCsr);
  112487. explainSimpleCount(pParse, pTab, pBest);
  112488. }else
  112489. #endif /* SQLITE_OMIT_BTREECOUNT */
  112490. {
  112491. /* Check if the query is of one of the following forms:
  112492. **
  112493. ** SELECT min(x) FROM ...
  112494. ** SELECT max(x) FROM ...
  112495. **
  112496. ** If it is, then ask the code in where.c to attempt to sort results
  112497. ** as if there was an "ORDER ON x" or "ORDER ON x DESC" clause.
  112498. ** If where.c is able to produce results sorted in this order, then
  112499. ** add vdbe code to break out of the processing loop after the
  112500. ** first iteration (since the first iteration of the loop is
  112501. ** guaranteed to operate on the row with the minimum or maximum
  112502. ** value of x, the only row required).
  112503. **
  112504. ** A special flag must be passed to sqlite3WhereBegin() to slightly
  112505. ** modify behavior as follows:
  112506. **
  112507. ** + If the query is a "SELECT min(x)", then the loop coded by
  112508. ** where.c should not iterate over any values with a NULL value
  112509. ** for x.
  112510. **
  112511. ** + The optimizer code in where.c (the thing that decides which
  112512. ** index or indices to use) should place a different priority on
  112513. ** satisfying the 'ORDER BY' clause than it does in other cases.
  112514. ** Refer to code and comments in where.c for details.
  112515. */
  112516. ExprList *pMinMax = 0;
  112517. u8 flag = WHERE_ORDERBY_NORMAL;
  112518. assert( p->pGroupBy==0 );
  112519. assert( flag==0 );
  112520. if( p->pHaving==0 ){
  112521. flag = minMaxQuery(&sAggInfo, &pMinMax);
  112522. }
  112523. assert( flag==0 || (pMinMax!=0 && pMinMax->nExpr==1) );
  112524. if( flag ){
  112525. pMinMax = sqlite3ExprListDup(db, pMinMax, 0);
  112526. pDel = pMinMax;
  112527. assert( db->mallocFailed || pMinMax!=0 );
  112528. if( !db->mallocFailed ){
  112529. pMinMax->a[0].sortOrder = flag!=WHERE_ORDERBY_MIN ?1:0;
  112530. pMinMax->a[0].pExpr->op = TK_COLUMN;
  112531. }
  112532. }
  112533. /* This case runs if the aggregate has no GROUP BY clause. The
  112534. ** processing is much simpler since there is only a single row
  112535. ** of output.
  112536. */
  112537. resetAccumulator(pParse, &sAggInfo);
  112538. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMax,0,flag,0);
  112539. if( pWInfo==0 ){
  112540. sqlite3ExprListDelete(db, pDel);
  112541. goto select_end;
  112542. }
  112543. updateAccumulator(pParse, &sAggInfo);
  112544. assert( pMinMax==0 || pMinMax->nExpr==1 );
  112545. if( sqlite3WhereIsOrdered(pWInfo)>0 ){
  112546. sqlite3VdbeGoto(v, sqlite3WhereBreakLabel(pWInfo));
  112547. VdbeComment((v, "%s() by index",
  112548. (flag==WHERE_ORDERBY_MIN?"min":"max")));
  112549. }
  112550. sqlite3WhereEnd(pWInfo);
  112551. finalizeAggFunctions(pParse, &sAggInfo);
  112552. }
  112553. sSort.pOrderBy = 0;
  112554. sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
  112555. selectInnerLoop(pParse, p, p->pEList, -1, 0, 0,
  112556. pDest, addrEnd, addrEnd);
  112557. sqlite3ExprListDelete(db, pDel);
  112558. }
  112559. sqlite3VdbeResolveLabel(v, addrEnd);
  112560. } /* endif aggregate query */
  112561. if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
  112562. explainTempTable(pParse, "DISTINCT");
  112563. }
  112564. /* If there is an ORDER BY clause, then we need to sort the results
  112565. ** and send them to the callback one by one.
  112566. */
  112567. if( sSort.pOrderBy ){
  112568. explainTempTable(pParse,
  112569. sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
  112570. generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
  112571. }
  112572. /* Jump here to skip this query
  112573. */
  112574. sqlite3VdbeResolveLabel(v, iEnd);
  112575. /* The SELECT has been coded. If there is an error in the Parse structure,
  112576. ** set the return code to 1. Otherwise 0. */
  112577. rc = (pParse->nErr>0);
  112578. /* Control jumps to here if an error is encountered above, or upon
  112579. ** successful coding of the SELECT.
  112580. */
  112581. select_end:
  112582. explainSetInteger(pParse->iSelectId, iRestoreSelectId);
  112583. /* Identify column names if results of the SELECT are to be output.
  112584. */
  112585. if( rc==SQLITE_OK && pDest->eDest==SRT_Output ){
  112586. generateColumnNames(pParse, pTabList, pEList);
  112587. }
  112588. sqlite3DbFree(db, sAggInfo.aCol);
  112589. sqlite3DbFree(db, sAggInfo.aFunc);
  112590. #if SELECTTRACE_ENABLED
  112591. SELECTTRACE(1,pParse,p,("end processing\n"));
  112592. pParse->nSelectIndent--;
  112593. #endif
  112594. return rc;
  112595. }
  112596. /************** End of select.c **********************************************/
  112597. /************** Begin file table.c *******************************************/
  112598. /*
  112599. ** 2001 September 15
  112600. **
  112601. ** The author disclaims copyright to this source code. In place of
  112602. ** a legal notice, here is a blessing:
  112603. **
  112604. ** May you do good and not evil.
  112605. ** May you find forgiveness for yourself and forgive others.
  112606. ** May you share freely, never taking more than you give.
  112607. **
  112608. *************************************************************************
  112609. ** This file contains the sqlite3_get_table() and sqlite3_free_table()
  112610. ** interface routines. These are just wrappers around the main
  112611. ** interface routine of sqlite3_exec().
  112612. **
  112613. ** These routines are in a separate files so that they will not be linked
  112614. ** if they are not used.
  112615. */
  112616. /* #include "sqliteInt.h" */
  112617. /* #include <stdlib.h> */
  112618. /* #include <string.h> */
  112619. #ifndef SQLITE_OMIT_GET_TABLE
  112620. /*
  112621. ** This structure is used to pass data from sqlite3_get_table() through
  112622. ** to the callback function is uses to build the result.
  112623. */
  112624. typedef struct TabResult {
  112625. char **azResult; /* Accumulated output */
  112626. char *zErrMsg; /* Error message text, if an error occurs */
  112627. u32 nAlloc; /* Slots allocated for azResult[] */
  112628. u32 nRow; /* Number of rows in the result */
  112629. u32 nColumn; /* Number of columns in the result */
  112630. u32 nData; /* Slots used in azResult[]. (nRow+1)*nColumn */
  112631. int rc; /* Return code from sqlite3_exec() */
  112632. } TabResult;
  112633. /*
  112634. ** This routine is called once for each row in the result table. Its job
  112635. ** is to fill in the TabResult structure appropriately, allocating new
  112636. ** memory as necessary.
  112637. */
  112638. static int sqlite3_get_table_cb(void *pArg, int nCol, char **argv, char **colv){
  112639. TabResult *p = (TabResult*)pArg; /* Result accumulator */
  112640. int need; /* Slots needed in p->azResult[] */
  112641. int i; /* Loop counter */
  112642. char *z; /* A single column of result */
  112643. /* Make sure there is enough space in p->azResult to hold everything
  112644. ** we need to remember from this invocation of the callback.
  112645. */
  112646. if( p->nRow==0 && argv!=0 ){
  112647. need = nCol*2;
  112648. }else{
  112649. need = nCol;
  112650. }
  112651. if( p->nData + need > p->nAlloc ){
  112652. char **azNew;
  112653. p->nAlloc = p->nAlloc*2 + need;
  112654. azNew = sqlite3_realloc64( p->azResult, sizeof(char*)*p->nAlloc );
  112655. if( azNew==0 ) goto malloc_failed;
  112656. p->azResult = azNew;
  112657. }
  112658. /* If this is the first row, then generate an extra row containing
  112659. ** the names of all columns.
  112660. */
  112661. if( p->nRow==0 ){
  112662. p->nColumn = nCol;
  112663. for(i=0; i<nCol; i++){
  112664. z = sqlite3_mprintf("%s", colv[i]);
  112665. if( z==0 ) goto malloc_failed;
  112666. p->azResult[p->nData++] = z;
  112667. }
  112668. }else if( (int)p->nColumn!=nCol ){
  112669. sqlite3_free(p->zErrMsg);
  112670. p->zErrMsg = sqlite3_mprintf(
  112671. "sqlite3_get_table() called with two or more incompatible queries"
  112672. );
  112673. p->rc = SQLITE_ERROR;
  112674. return 1;
  112675. }
  112676. /* Copy over the row data
  112677. */
  112678. if( argv!=0 ){
  112679. for(i=0; i<nCol; i++){
  112680. if( argv[i]==0 ){
  112681. z = 0;
  112682. }else{
  112683. int n = sqlite3Strlen30(argv[i])+1;
  112684. z = sqlite3_malloc64( n );
  112685. if( z==0 ) goto malloc_failed;
  112686. memcpy(z, argv[i], n);
  112687. }
  112688. p->azResult[p->nData++] = z;
  112689. }
  112690. p->nRow++;
  112691. }
  112692. return 0;
  112693. malloc_failed:
  112694. p->rc = SQLITE_NOMEM_BKPT;
  112695. return 1;
  112696. }
  112697. /*
  112698. ** Query the database. But instead of invoking a callback for each row,
  112699. ** malloc() for space to hold the result and return the entire results
  112700. ** at the conclusion of the call.
  112701. **
  112702. ** The result that is written to ***pazResult is held in memory obtained
  112703. ** from malloc(). But the caller cannot free this memory directly.
  112704. ** Instead, the entire table should be passed to sqlite3_free_table() when
  112705. ** the calling procedure is finished using it.
  112706. */
  112707. SQLITE_API int sqlite3_get_table(
  112708. sqlite3 *db, /* The database on which the SQL executes */
  112709. const char *zSql, /* The SQL to be executed */
  112710. char ***pazResult, /* Write the result table here */
  112711. int *pnRow, /* Write the number of rows in the result here */
  112712. int *pnColumn, /* Write the number of columns of result here */
  112713. char **pzErrMsg /* Write error messages here */
  112714. ){
  112715. int rc;
  112716. TabResult res;
  112717. #ifdef SQLITE_ENABLE_API_ARMOR
  112718. if( !sqlite3SafetyCheckOk(db) || pazResult==0 ) return SQLITE_MISUSE_BKPT;
  112719. #endif
  112720. *pazResult = 0;
  112721. if( pnColumn ) *pnColumn = 0;
  112722. if( pnRow ) *pnRow = 0;
  112723. if( pzErrMsg ) *pzErrMsg = 0;
  112724. res.zErrMsg = 0;
  112725. res.nRow = 0;
  112726. res.nColumn = 0;
  112727. res.nData = 1;
  112728. res.nAlloc = 20;
  112729. res.rc = SQLITE_OK;
  112730. res.azResult = sqlite3_malloc64(sizeof(char*)*res.nAlloc );
  112731. if( res.azResult==0 ){
  112732. db->errCode = SQLITE_NOMEM;
  112733. return SQLITE_NOMEM_BKPT;
  112734. }
  112735. res.azResult[0] = 0;
  112736. rc = sqlite3_exec(db, zSql, sqlite3_get_table_cb, &res, pzErrMsg);
  112737. assert( sizeof(res.azResult[0])>= sizeof(res.nData) );
  112738. res.azResult[0] = SQLITE_INT_TO_PTR(res.nData);
  112739. if( (rc&0xff)==SQLITE_ABORT ){
  112740. sqlite3_free_table(&res.azResult[1]);
  112741. if( res.zErrMsg ){
  112742. if( pzErrMsg ){
  112743. sqlite3_free(*pzErrMsg);
  112744. *pzErrMsg = sqlite3_mprintf("%s",res.zErrMsg);
  112745. }
  112746. sqlite3_free(res.zErrMsg);
  112747. }
  112748. db->errCode = res.rc; /* Assume 32-bit assignment is atomic */
  112749. return res.rc;
  112750. }
  112751. sqlite3_free(res.zErrMsg);
  112752. if( rc!=SQLITE_OK ){
  112753. sqlite3_free_table(&res.azResult[1]);
  112754. return rc;
  112755. }
  112756. if( res.nAlloc>res.nData ){
  112757. char **azNew;
  112758. azNew = sqlite3_realloc64( res.azResult, sizeof(char*)*res.nData );
  112759. if( azNew==0 ){
  112760. sqlite3_free_table(&res.azResult[1]);
  112761. db->errCode = SQLITE_NOMEM;
  112762. return SQLITE_NOMEM_BKPT;
  112763. }
  112764. res.azResult = azNew;
  112765. }
  112766. *pazResult = &res.azResult[1];
  112767. if( pnColumn ) *pnColumn = res.nColumn;
  112768. if( pnRow ) *pnRow = res.nRow;
  112769. return rc;
  112770. }
  112771. /*
  112772. ** This routine frees the space the sqlite3_get_table() malloced.
  112773. */
  112774. SQLITE_API void sqlite3_free_table(
  112775. char **azResult /* Result returned from sqlite3_get_table() */
  112776. ){
  112777. if( azResult ){
  112778. int i, n;
  112779. azResult--;
  112780. assert( azResult!=0 );
  112781. n = SQLITE_PTR_TO_INT(azResult[0]);
  112782. for(i=1; i<n; i++){ if( azResult[i] ) sqlite3_free(azResult[i]); }
  112783. sqlite3_free(azResult);
  112784. }
  112785. }
  112786. #endif /* SQLITE_OMIT_GET_TABLE */
  112787. /************** End of table.c ***********************************************/
  112788. /************** Begin file trigger.c *****************************************/
  112789. /*
  112790. **
  112791. ** The author disclaims copyright to this source code. In place of
  112792. ** a legal notice, here is a blessing:
  112793. **
  112794. ** May you do good and not evil.
  112795. ** May you find forgiveness for yourself and forgive others.
  112796. ** May you share freely, never taking more than you give.
  112797. **
  112798. *************************************************************************
  112799. ** This file contains the implementation for TRIGGERs
  112800. */
  112801. /* #include "sqliteInt.h" */
  112802. #ifndef SQLITE_OMIT_TRIGGER
  112803. /*
  112804. ** Delete a linked list of TriggerStep structures.
  112805. */
  112806. SQLITE_PRIVATE void sqlite3DeleteTriggerStep(sqlite3 *db, TriggerStep *pTriggerStep){
  112807. while( pTriggerStep ){
  112808. TriggerStep * pTmp = pTriggerStep;
  112809. pTriggerStep = pTriggerStep->pNext;
  112810. sqlite3ExprDelete(db, pTmp->pWhere);
  112811. sqlite3ExprListDelete(db, pTmp->pExprList);
  112812. sqlite3SelectDelete(db, pTmp->pSelect);
  112813. sqlite3IdListDelete(db, pTmp->pIdList);
  112814. sqlite3DbFree(db, pTmp);
  112815. }
  112816. }
  112817. /*
  112818. ** Given table pTab, return a list of all the triggers attached to
  112819. ** the table. The list is connected by Trigger.pNext pointers.
  112820. **
  112821. ** All of the triggers on pTab that are in the same database as pTab
  112822. ** are already attached to pTab->pTrigger. But there might be additional
  112823. ** triggers on pTab in the TEMP schema. This routine prepends all
  112824. ** TEMP triggers on pTab to the beginning of the pTab->pTrigger list
  112825. ** and returns the combined list.
  112826. **
  112827. ** To state it another way: This routine returns a list of all triggers
  112828. ** that fire off of pTab. The list will include any TEMP triggers on
  112829. ** pTab as well as the triggers lised in pTab->pTrigger.
  112830. */
  112831. SQLITE_PRIVATE Trigger *sqlite3TriggerList(Parse *pParse, Table *pTab){
  112832. Schema * const pTmpSchema = pParse->db->aDb[1].pSchema;
  112833. Trigger *pList = 0; /* List of triggers to return */
  112834. if( pParse->disableTriggers ){
  112835. return 0;
  112836. }
  112837. if( pTmpSchema!=pTab->pSchema ){
  112838. HashElem *p;
  112839. assert( sqlite3SchemaMutexHeld(pParse->db, 0, pTmpSchema) );
  112840. for(p=sqliteHashFirst(&pTmpSchema->trigHash); p; p=sqliteHashNext(p)){
  112841. Trigger *pTrig = (Trigger *)sqliteHashData(p);
  112842. if( pTrig->pTabSchema==pTab->pSchema
  112843. && 0==sqlite3StrICmp(pTrig->table, pTab->zName)
  112844. ){
  112845. pTrig->pNext = (pList ? pList : pTab->pTrigger);
  112846. pList = pTrig;
  112847. }
  112848. }
  112849. }
  112850. return (pList ? pList : pTab->pTrigger);
  112851. }
  112852. /*
  112853. ** This is called by the parser when it sees a CREATE TRIGGER statement
  112854. ** up to the point of the BEGIN before the trigger actions. A Trigger
  112855. ** structure is generated based on the information available and stored
  112856. ** in pParse->pNewTrigger. After the trigger actions have been parsed, the
  112857. ** sqlite3FinishTrigger() function is called to complete the trigger
  112858. ** construction process.
  112859. */
  112860. SQLITE_PRIVATE void sqlite3BeginTrigger(
  112861. Parse *pParse, /* The parse context of the CREATE TRIGGER statement */
  112862. Token *pName1, /* The name of the trigger */
  112863. Token *pName2, /* The name of the trigger */
  112864. int tr_tm, /* One of TK_BEFORE, TK_AFTER, TK_INSTEAD */
  112865. int op, /* One of TK_INSERT, TK_UPDATE, TK_DELETE */
  112866. IdList *pColumns, /* column list if this is an UPDATE OF trigger */
  112867. SrcList *pTableName,/* The name of the table/view the trigger applies to */
  112868. Expr *pWhen, /* WHEN clause */
  112869. int isTemp, /* True if the TEMPORARY keyword is present */
  112870. int noErr /* Suppress errors if the trigger already exists */
  112871. ){
  112872. Trigger *pTrigger = 0; /* The new trigger */
  112873. Table *pTab; /* Table that the trigger fires off of */
  112874. char *zName = 0; /* Name of the trigger */
  112875. sqlite3 *db = pParse->db; /* The database connection */
  112876. int iDb; /* The database to store the trigger in */
  112877. Token *pName; /* The unqualified db name */
  112878. DbFixer sFix; /* State vector for the DB fixer */
  112879. assert( pName1!=0 ); /* pName1->z might be NULL, but not pName1 itself */
  112880. assert( pName2!=0 );
  112881. assert( op==TK_INSERT || op==TK_UPDATE || op==TK_DELETE );
  112882. assert( op>0 && op<0xff );
  112883. if( isTemp ){
  112884. /* If TEMP was specified, then the trigger name may not be qualified. */
  112885. if( pName2->n>0 ){
  112886. sqlite3ErrorMsg(pParse, "temporary trigger may not have qualified name");
  112887. goto trigger_cleanup;
  112888. }
  112889. iDb = 1;
  112890. pName = pName1;
  112891. }else{
  112892. /* Figure out the db that the trigger will be created in */
  112893. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  112894. if( iDb<0 ){
  112895. goto trigger_cleanup;
  112896. }
  112897. }
  112898. if( !pTableName || db->mallocFailed ){
  112899. goto trigger_cleanup;
  112900. }
  112901. /* A long-standing parser bug is that this syntax was allowed:
  112902. **
  112903. ** CREATE TRIGGER attached.demo AFTER INSERT ON attached.tab ....
  112904. ** ^^^^^^^^
  112905. **
  112906. ** To maintain backwards compatibility, ignore the database
  112907. ** name on pTableName if we are reparsing out of SQLITE_MASTER.
  112908. */
  112909. if( db->init.busy && iDb!=1 ){
  112910. sqlite3DbFree(db, pTableName->a[0].zDatabase);
  112911. pTableName->a[0].zDatabase = 0;
  112912. }
  112913. /* If the trigger name was unqualified, and the table is a temp table,
  112914. ** then set iDb to 1 to create the trigger in the temporary database.
  112915. ** If sqlite3SrcListLookup() returns 0, indicating the table does not
  112916. ** exist, the error is caught by the block below.
  112917. */
  112918. pTab = sqlite3SrcListLookup(pParse, pTableName);
  112919. if( db->init.busy==0 && pName2->n==0 && pTab
  112920. && pTab->pSchema==db->aDb[1].pSchema ){
  112921. iDb = 1;
  112922. }
  112923. /* Ensure the table name matches database name and that the table exists */
  112924. if( db->mallocFailed ) goto trigger_cleanup;
  112925. assert( pTableName->nSrc==1 );
  112926. sqlite3FixInit(&sFix, pParse, iDb, "trigger", pName);
  112927. if( sqlite3FixSrcList(&sFix, pTableName) ){
  112928. goto trigger_cleanup;
  112929. }
  112930. pTab = sqlite3SrcListLookup(pParse, pTableName);
  112931. if( !pTab ){
  112932. /* The table does not exist. */
  112933. if( db->init.iDb==1 ){
  112934. /* Ticket #3810.
  112935. ** Normally, whenever a table is dropped, all associated triggers are
  112936. ** dropped too. But if a TEMP trigger is created on a non-TEMP table
  112937. ** and the table is dropped by a different database connection, the
  112938. ** trigger is not visible to the database connection that does the
  112939. ** drop so the trigger cannot be dropped. This results in an
  112940. ** "orphaned trigger" - a trigger whose associated table is missing.
  112941. */
  112942. db->init.orphanTrigger = 1;
  112943. }
  112944. goto trigger_cleanup;
  112945. }
  112946. if( IsVirtual(pTab) ){
  112947. sqlite3ErrorMsg(pParse, "cannot create triggers on virtual tables");
  112948. goto trigger_cleanup;
  112949. }
  112950. /* Check that the trigger name is not reserved and that no trigger of the
  112951. ** specified name exists */
  112952. zName = sqlite3NameFromToken(db, pName);
  112953. if( !zName || SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  112954. goto trigger_cleanup;
  112955. }
  112956. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  112957. if( sqlite3HashFind(&(db->aDb[iDb].pSchema->trigHash),zName) ){
  112958. if( !noErr ){
  112959. sqlite3ErrorMsg(pParse, "trigger %T already exists", pName);
  112960. }else{
  112961. assert( !db->init.busy );
  112962. sqlite3CodeVerifySchema(pParse, iDb);
  112963. }
  112964. goto trigger_cleanup;
  112965. }
  112966. /* Do not create a trigger on a system table */
  112967. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0 ){
  112968. sqlite3ErrorMsg(pParse, "cannot create trigger on system table");
  112969. goto trigger_cleanup;
  112970. }
  112971. /* INSTEAD of triggers are only for views and views only support INSTEAD
  112972. ** of triggers.
  112973. */
  112974. if( pTab->pSelect && tr_tm!=TK_INSTEAD ){
  112975. sqlite3ErrorMsg(pParse, "cannot create %s trigger on view: %S",
  112976. (tr_tm == TK_BEFORE)?"BEFORE":"AFTER", pTableName, 0);
  112977. goto trigger_cleanup;
  112978. }
  112979. if( !pTab->pSelect && tr_tm==TK_INSTEAD ){
  112980. sqlite3ErrorMsg(pParse, "cannot create INSTEAD OF"
  112981. " trigger on table: %S", pTableName, 0);
  112982. goto trigger_cleanup;
  112983. }
  112984. #ifndef SQLITE_OMIT_AUTHORIZATION
  112985. {
  112986. int iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  112987. int code = SQLITE_CREATE_TRIGGER;
  112988. const char *zDb = db->aDb[iTabDb].zDbSName;
  112989. const char *zDbTrig = isTemp ? db->aDb[1].zDbSName : zDb;
  112990. if( iTabDb==1 || isTemp ) code = SQLITE_CREATE_TEMP_TRIGGER;
  112991. if( sqlite3AuthCheck(pParse, code, zName, pTab->zName, zDbTrig) ){
  112992. goto trigger_cleanup;
  112993. }
  112994. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iTabDb),0,zDb)){
  112995. goto trigger_cleanup;
  112996. }
  112997. }
  112998. #endif
  112999. /* INSTEAD OF triggers can only appear on views and BEFORE triggers
  113000. ** cannot appear on views. So we might as well translate every
  113001. ** INSTEAD OF trigger into a BEFORE trigger. It simplifies code
  113002. ** elsewhere.
  113003. */
  113004. if (tr_tm == TK_INSTEAD){
  113005. tr_tm = TK_BEFORE;
  113006. }
  113007. /* Build the Trigger object */
  113008. pTrigger = (Trigger*)sqlite3DbMallocZero(db, sizeof(Trigger));
  113009. if( pTrigger==0 ) goto trigger_cleanup;
  113010. pTrigger->zName = zName;
  113011. zName = 0;
  113012. pTrigger->table = sqlite3DbStrDup(db, pTableName->a[0].zName);
  113013. pTrigger->pSchema = db->aDb[iDb].pSchema;
  113014. pTrigger->pTabSchema = pTab->pSchema;
  113015. pTrigger->op = (u8)op;
  113016. pTrigger->tr_tm = tr_tm==TK_BEFORE ? TRIGGER_BEFORE : TRIGGER_AFTER;
  113017. pTrigger->pWhen = sqlite3ExprDup(db, pWhen, EXPRDUP_REDUCE);
  113018. pTrigger->pColumns = sqlite3IdListDup(db, pColumns);
  113019. assert( pParse->pNewTrigger==0 );
  113020. pParse->pNewTrigger = pTrigger;
  113021. trigger_cleanup:
  113022. sqlite3DbFree(db, zName);
  113023. sqlite3SrcListDelete(db, pTableName);
  113024. sqlite3IdListDelete(db, pColumns);
  113025. sqlite3ExprDelete(db, pWhen);
  113026. if( !pParse->pNewTrigger ){
  113027. sqlite3DeleteTrigger(db, pTrigger);
  113028. }else{
  113029. assert( pParse->pNewTrigger==pTrigger );
  113030. }
  113031. }
  113032. /*
  113033. ** This routine is called after all of the trigger actions have been parsed
  113034. ** in order to complete the process of building the trigger.
  113035. */
  113036. SQLITE_PRIVATE void sqlite3FinishTrigger(
  113037. Parse *pParse, /* Parser context */
  113038. TriggerStep *pStepList, /* The triggered program */
  113039. Token *pAll /* Token that describes the complete CREATE TRIGGER */
  113040. ){
  113041. Trigger *pTrig = pParse->pNewTrigger; /* Trigger being finished */
  113042. char *zName; /* Name of trigger */
  113043. sqlite3 *db = pParse->db; /* The database */
  113044. DbFixer sFix; /* Fixer object */
  113045. int iDb; /* Database containing the trigger */
  113046. Token nameToken; /* Trigger name for error reporting */
  113047. pParse->pNewTrigger = 0;
  113048. if( NEVER(pParse->nErr) || !pTrig ) goto triggerfinish_cleanup;
  113049. zName = pTrig->zName;
  113050. iDb = sqlite3SchemaToIndex(pParse->db, pTrig->pSchema);
  113051. pTrig->step_list = pStepList;
  113052. while( pStepList ){
  113053. pStepList->pTrig = pTrig;
  113054. pStepList = pStepList->pNext;
  113055. }
  113056. sqlite3TokenInit(&nameToken, pTrig->zName);
  113057. sqlite3FixInit(&sFix, pParse, iDb, "trigger", &nameToken);
  113058. if( sqlite3FixTriggerStep(&sFix, pTrig->step_list)
  113059. || sqlite3FixExpr(&sFix, pTrig->pWhen)
  113060. ){
  113061. goto triggerfinish_cleanup;
  113062. }
  113063. /* if we are not initializing,
  113064. ** build the sqlite_master entry
  113065. */
  113066. if( !db->init.busy ){
  113067. Vdbe *v;
  113068. char *z;
  113069. /* Make an entry in the sqlite_master table */
  113070. v = sqlite3GetVdbe(pParse);
  113071. if( v==0 ) goto triggerfinish_cleanup;
  113072. sqlite3BeginWriteOperation(pParse, 0, iDb);
  113073. z = sqlite3DbStrNDup(db, (char*)pAll->z, pAll->n);
  113074. sqlite3NestedParse(pParse,
  113075. "INSERT INTO %Q.%s VALUES('trigger',%Q,%Q,0,'CREATE TRIGGER %q')",
  113076. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb), zName,
  113077. pTrig->table, z);
  113078. sqlite3DbFree(db, z);
  113079. sqlite3ChangeCookie(pParse, iDb);
  113080. sqlite3VdbeAddParseSchemaOp(v, iDb,
  113081. sqlite3MPrintf(db, "type='trigger' AND name='%q'", zName));
  113082. }
  113083. if( db->init.busy ){
  113084. Trigger *pLink = pTrig;
  113085. Hash *pHash = &db->aDb[iDb].pSchema->trigHash;
  113086. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  113087. pTrig = sqlite3HashInsert(pHash, zName, pTrig);
  113088. if( pTrig ){
  113089. sqlite3OomFault(db);
  113090. }else if( pLink->pSchema==pLink->pTabSchema ){
  113091. Table *pTab;
  113092. pTab = sqlite3HashFind(&pLink->pTabSchema->tblHash, pLink->table);
  113093. assert( pTab!=0 );
  113094. pLink->pNext = pTab->pTrigger;
  113095. pTab->pTrigger = pLink;
  113096. }
  113097. }
  113098. triggerfinish_cleanup:
  113099. sqlite3DeleteTrigger(db, pTrig);
  113100. assert( !pParse->pNewTrigger );
  113101. sqlite3DeleteTriggerStep(db, pStepList);
  113102. }
  113103. /*
  113104. ** Turn a SELECT statement (that the pSelect parameter points to) into
  113105. ** a trigger step. Return a pointer to a TriggerStep structure.
  113106. **
  113107. ** The parser calls this routine when it finds a SELECT statement in
  113108. ** body of a TRIGGER.
  113109. */
  113110. SQLITE_PRIVATE TriggerStep *sqlite3TriggerSelectStep(sqlite3 *db, Select *pSelect){
  113111. TriggerStep *pTriggerStep = sqlite3DbMallocZero(db, sizeof(TriggerStep));
  113112. if( pTriggerStep==0 ) {
  113113. sqlite3SelectDelete(db, pSelect);
  113114. return 0;
  113115. }
  113116. pTriggerStep->op = TK_SELECT;
  113117. pTriggerStep->pSelect = pSelect;
  113118. pTriggerStep->orconf = OE_Default;
  113119. return pTriggerStep;
  113120. }
  113121. /*
  113122. ** Allocate space to hold a new trigger step. The allocated space
  113123. ** holds both the TriggerStep object and the TriggerStep.target.z string.
  113124. **
  113125. ** If an OOM error occurs, NULL is returned and db->mallocFailed is set.
  113126. */
  113127. static TriggerStep *triggerStepAllocate(
  113128. sqlite3 *db, /* Database connection */
  113129. u8 op, /* Trigger opcode */
  113130. Token *pName /* The target name */
  113131. ){
  113132. TriggerStep *pTriggerStep;
  113133. pTriggerStep = sqlite3DbMallocZero(db, sizeof(TriggerStep) + pName->n + 1);
  113134. if( pTriggerStep ){
  113135. char *z = (char*)&pTriggerStep[1];
  113136. memcpy(z, pName->z, pName->n);
  113137. sqlite3Dequote(z);
  113138. pTriggerStep->zTarget = z;
  113139. pTriggerStep->op = op;
  113140. }
  113141. return pTriggerStep;
  113142. }
  113143. /*
  113144. ** Build a trigger step out of an INSERT statement. Return a pointer
  113145. ** to the new trigger step.
  113146. **
  113147. ** The parser calls this routine when it sees an INSERT inside the
  113148. ** body of a trigger.
  113149. */
  113150. SQLITE_PRIVATE TriggerStep *sqlite3TriggerInsertStep(
  113151. sqlite3 *db, /* The database connection */
  113152. Token *pTableName, /* Name of the table into which we insert */
  113153. IdList *pColumn, /* List of columns in pTableName to insert into */
  113154. Select *pSelect, /* A SELECT statement that supplies values */
  113155. u8 orconf /* The conflict algorithm (OE_Abort, OE_Replace, etc.) */
  113156. ){
  113157. TriggerStep *pTriggerStep;
  113158. assert(pSelect != 0 || db->mallocFailed);
  113159. pTriggerStep = triggerStepAllocate(db, TK_INSERT, pTableName);
  113160. if( pTriggerStep ){
  113161. pTriggerStep->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  113162. pTriggerStep->pIdList = pColumn;
  113163. pTriggerStep->orconf = orconf;
  113164. }else{
  113165. sqlite3IdListDelete(db, pColumn);
  113166. }
  113167. sqlite3SelectDelete(db, pSelect);
  113168. return pTriggerStep;
  113169. }
  113170. /*
  113171. ** Construct a trigger step that implements an UPDATE statement and return
  113172. ** a pointer to that trigger step. The parser calls this routine when it
  113173. ** sees an UPDATE statement inside the body of a CREATE TRIGGER.
  113174. */
  113175. SQLITE_PRIVATE TriggerStep *sqlite3TriggerUpdateStep(
  113176. sqlite3 *db, /* The database connection */
  113177. Token *pTableName, /* Name of the table to be updated */
  113178. ExprList *pEList, /* The SET clause: list of column and new values */
  113179. Expr *pWhere, /* The WHERE clause */
  113180. u8 orconf /* The conflict algorithm. (OE_Abort, OE_Ignore, etc) */
  113181. ){
  113182. TriggerStep *pTriggerStep;
  113183. pTriggerStep = triggerStepAllocate(db, TK_UPDATE, pTableName);
  113184. if( pTriggerStep ){
  113185. pTriggerStep->pExprList = sqlite3ExprListDup(db, pEList, EXPRDUP_REDUCE);
  113186. pTriggerStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  113187. pTriggerStep->orconf = orconf;
  113188. }
  113189. sqlite3ExprListDelete(db, pEList);
  113190. sqlite3ExprDelete(db, pWhere);
  113191. return pTriggerStep;
  113192. }
  113193. /*
  113194. ** Construct a trigger step that implements a DELETE statement and return
  113195. ** a pointer to that trigger step. The parser calls this routine when it
  113196. ** sees a DELETE statement inside the body of a CREATE TRIGGER.
  113197. */
  113198. SQLITE_PRIVATE TriggerStep *sqlite3TriggerDeleteStep(
  113199. sqlite3 *db, /* Database connection */
  113200. Token *pTableName, /* The table from which rows are deleted */
  113201. Expr *pWhere /* The WHERE clause */
  113202. ){
  113203. TriggerStep *pTriggerStep;
  113204. pTriggerStep = triggerStepAllocate(db, TK_DELETE, pTableName);
  113205. if( pTriggerStep ){
  113206. pTriggerStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  113207. pTriggerStep->orconf = OE_Default;
  113208. }
  113209. sqlite3ExprDelete(db, pWhere);
  113210. return pTriggerStep;
  113211. }
  113212. /*
  113213. ** Recursively delete a Trigger structure
  113214. */
  113215. SQLITE_PRIVATE void sqlite3DeleteTrigger(sqlite3 *db, Trigger *pTrigger){
  113216. if( pTrigger==0 ) return;
  113217. sqlite3DeleteTriggerStep(db, pTrigger->step_list);
  113218. sqlite3DbFree(db, pTrigger->zName);
  113219. sqlite3DbFree(db, pTrigger->table);
  113220. sqlite3ExprDelete(db, pTrigger->pWhen);
  113221. sqlite3IdListDelete(db, pTrigger->pColumns);
  113222. sqlite3DbFree(db, pTrigger);
  113223. }
  113224. /*
  113225. ** This function is called to drop a trigger from the database schema.
  113226. **
  113227. ** This may be called directly from the parser and therefore identifies
  113228. ** the trigger by name. The sqlite3DropTriggerPtr() routine does the
  113229. ** same job as this routine except it takes a pointer to the trigger
  113230. ** instead of the trigger name.
  113231. **/
  113232. SQLITE_PRIVATE void sqlite3DropTrigger(Parse *pParse, SrcList *pName, int noErr){
  113233. Trigger *pTrigger = 0;
  113234. int i;
  113235. const char *zDb;
  113236. const char *zName;
  113237. sqlite3 *db = pParse->db;
  113238. if( db->mallocFailed ) goto drop_trigger_cleanup;
  113239. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  113240. goto drop_trigger_cleanup;
  113241. }
  113242. assert( pName->nSrc==1 );
  113243. zDb = pName->a[0].zDatabase;
  113244. zName = pName->a[0].zName;
  113245. assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  113246. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  113247. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  113248. if( zDb && sqlite3StrICmp(db->aDb[j].zDbSName, zDb) ) continue;
  113249. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  113250. pTrigger = sqlite3HashFind(&(db->aDb[j].pSchema->trigHash), zName);
  113251. if( pTrigger ) break;
  113252. }
  113253. if( !pTrigger ){
  113254. if( !noErr ){
  113255. sqlite3ErrorMsg(pParse, "no such trigger: %S", pName, 0);
  113256. }else{
  113257. sqlite3CodeVerifyNamedSchema(pParse, zDb);
  113258. }
  113259. pParse->checkSchema = 1;
  113260. goto drop_trigger_cleanup;
  113261. }
  113262. sqlite3DropTriggerPtr(pParse, pTrigger);
  113263. drop_trigger_cleanup:
  113264. sqlite3SrcListDelete(db, pName);
  113265. }
  113266. /*
  113267. ** Return a pointer to the Table structure for the table that a trigger
  113268. ** is set on.
  113269. */
  113270. static Table *tableOfTrigger(Trigger *pTrigger){
  113271. return sqlite3HashFind(&pTrigger->pTabSchema->tblHash, pTrigger->table);
  113272. }
  113273. /*
  113274. ** Drop a trigger given a pointer to that trigger.
  113275. */
  113276. SQLITE_PRIVATE void sqlite3DropTriggerPtr(Parse *pParse, Trigger *pTrigger){
  113277. Table *pTable;
  113278. Vdbe *v;
  113279. sqlite3 *db = pParse->db;
  113280. int iDb;
  113281. iDb = sqlite3SchemaToIndex(pParse->db, pTrigger->pSchema);
  113282. assert( iDb>=0 && iDb<db->nDb );
  113283. pTable = tableOfTrigger(pTrigger);
  113284. assert( pTable );
  113285. assert( pTable->pSchema==pTrigger->pSchema || iDb==1 );
  113286. #ifndef SQLITE_OMIT_AUTHORIZATION
  113287. {
  113288. int code = SQLITE_DROP_TRIGGER;
  113289. const char *zDb = db->aDb[iDb].zDbSName;
  113290. const char *zTab = SCHEMA_TABLE(iDb);
  113291. if( iDb==1 ) code = SQLITE_DROP_TEMP_TRIGGER;
  113292. if( sqlite3AuthCheck(pParse, code, pTrigger->zName, pTable->zName, zDb) ||
  113293. sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
  113294. return;
  113295. }
  113296. }
  113297. #endif
  113298. /* Generate code to destroy the database record of the trigger.
  113299. */
  113300. assert( pTable!=0 );
  113301. if( (v = sqlite3GetVdbe(pParse))!=0 ){
  113302. sqlite3NestedParse(pParse,
  113303. "DELETE FROM %Q.%s WHERE name=%Q AND type='trigger'",
  113304. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb), pTrigger->zName
  113305. );
  113306. sqlite3ChangeCookie(pParse, iDb);
  113307. sqlite3VdbeAddOp4(v, OP_DropTrigger, iDb, 0, 0, pTrigger->zName, 0);
  113308. }
  113309. }
  113310. /*
  113311. ** Remove a trigger from the hash tables of the sqlite* pointer.
  113312. */
  113313. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTrigger(sqlite3 *db, int iDb, const char *zName){
  113314. Trigger *pTrigger;
  113315. Hash *pHash;
  113316. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  113317. pHash = &(db->aDb[iDb].pSchema->trigHash);
  113318. pTrigger = sqlite3HashInsert(pHash, zName, 0);
  113319. if( ALWAYS(pTrigger) ){
  113320. if( pTrigger->pSchema==pTrigger->pTabSchema ){
  113321. Table *pTab = tableOfTrigger(pTrigger);
  113322. Trigger **pp;
  113323. for(pp=&pTab->pTrigger; *pp!=pTrigger; pp=&((*pp)->pNext));
  113324. *pp = (*pp)->pNext;
  113325. }
  113326. sqlite3DeleteTrigger(db, pTrigger);
  113327. db->flags |= SQLITE_InternChanges;
  113328. }
  113329. }
  113330. /*
  113331. ** pEList is the SET clause of an UPDATE statement. Each entry
  113332. ** in pEList is of the format <id>=<expr>. If any of the entries
  113333. ** in pEList have an <id> which matches an identifier in pIdList,
  113334. ** then return TRUE. If pIdList==NULL, then it is considered a
  113335. ** wildcard that matches anything. Likewise if pEList==NULL then
  113336. ** it matches anything so always return true. Return false only
  113337. ** if there is no match.
  113338. */
  113339. static int checkColumnOverlap(IdList *pIdList, ExprList *pEList){
  113340. int e;
  113341. if( pIdList==0 || NEVER(pEList==0) ) return 1;
  113342. for(e=0; e<pEList->nExpr; e++){
  113343. if( sqlite3IdListIndex(pIdList, pEList->a[e].zName)>=0 ) return 1;
  113344. }
  113345. return 0;
  113346. }
  113347. /*
  113348. ** Return a list of all triggers on table pTab if there exists at least
  113349. ** one trigger that must be fired when an operation of type 'op' is
  113350. ** performed on the table, and, if that operation is an UPDATE, if at
  113351. ** least one of the columns in pChanges is being modified.
  113352. */
  113353. SQLITE_PRIVATE Trigger *sqlite3TriggersExist(
  113354. Parse *pParse, /* Parse context */
  113355. Table *pTab, /* The table the contains the triggers */
  113356. int op, /* one of TK_DELETE, TK_INSERT, TK_UPDATE */
  113357. ExprList *pChanges, /* Columns that change in an UPDATE statement */
  113358. int *pMask /* OUT: Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  113359. ){
  113360. int mask = 0;
  113361. Trigger *pList = 0;
  113362. Trigger *p;
  113363. if( (pParse->db->flags & SQLITE_EnableTrigger)!=0 ){
  113364. pList = sqlite3TriggerList(pParse, pTab);
  113365. }
  113366. assert( pList==0 || IsVirtual(pTab)==0 );
  113367. for(p=pList; p; p=p->pNext){
  113368. if( p->op==op && checkColumnOverlap(p->pColumns, pChanges) ){
  113369. mask |= p->tr_tm;
  113370. }
  113371. }
  113372. if( pMask ){
  113373. *pMask = mask;
  113374. }
  113375. return (mask ? pList : 0);
  113376. }
  113377. /*
  113378. ** Convert the pStep->zTarget string into a SrcList and return a pointer
  113379. ** to that SrcList.
  113380. **
  113381. ** This routine adds a specific database name, if needed, to the target when
  113382. ** forming the SrcList. This prevents a trigger in one database from
  113383. ** referring to a target in another database. An exception is when the
  113384. ** trigger is in TEMP in which case it can refer to any other database it
  113385. ** wants.
  113386. */
  113387. static SrcList *targetSrcList(
  113388. Parse *pParse, /* The parsing context */
  113389. TriggerStep *pStep /* The trigger containing the target token */
  113390. ){
  113391. sqlite3 *db = pParse->db;
  113392. int iDb; /* Index of the database to use */
  113393. SrcList *pSrc; /* SrcList to be returned */
  113394. pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  113395. if( pSrc ){
  113396. assert( pSrc->nSrc>0 );
  113397. pSrc->a[pSrc->nSrc-1].zName = sqlite3DbStrDup(db, pStep->zTarget);
  113398. iDb = sqlite3SchemaToIndex(db, pStep->pTrig->pSchema);
  113399. if( iDb==0 || iDb>=2 ){
  113400. const char *zDb;
  113401. assert( iDb<db->nDb );
  113402. zDb = db->aDb[iDb].zDbSName;
  113403. pSrc->a[pSrc->nSrc-1].zDatabase = sqlite3DbStrDup(db, zDb);
  113404. }
  113405. }
  113406. return pSrc;
  113407. }
  113408. /*
  113409. ** Generate VDBE code for the statements inside the body of a single
  113410. ** trigger.
  113411. */
  113412. static int codeTriggerProgram(
  113413. Parse *pParse, /* The parser context */
  113414. TriggerStep *pStepList, /* List of statements inside the trigger body */
  113415. int orconf /* Conflict algorithm. (OE_Abort, etc) */
  113416. ){
  113417. TriggerStep *pStep;
  113418. Vdbe *v = pParse->pVdbe;
  113419. sqlite3 *db = pParse->db;
  113420. assert( pParse->pTriggerTab && pParse->pToplevel );
  113421. assert( pStepList );
  113422. assert( v!=0 );
  113423. for(pStep=pStepList; pStep; pStep=pStep->pNext){
  113424. /* Figure out the ON CONFLICT policy that will be used for this step
  113425. ** of the trigger program. If the statement that caused this trigger
  113426. ** to fire had an explicit ON CONFLICT, then use it. Otherwise, use
  113427. ** the ON CONFLICT policy that was specified as part of the trigger
  113428. ** step statement. Example:
  113429. **
  113430. ** CREATE TRIGGER AFTER INSERT ON t1 BEGIN;
  113431. ** INSERT OR REPLACE INTO t2 VALUES(new.a, new.b);
  113432. ** END;
  113433. **
  113434. ** INSERT INTO t1 ... ; -- insert into t2 uses REPLACE policy
  113435. ** INSERT OR IGNORE INTO t1 ... ; -- insert into t2 uses IGNORE policy
  113436. */
  113437. pParse->eOrconf = (orconf==OE_Default)?pStep->orconf:(u8)orconf;
  113438. assert( pParse->okConstFactor==0 );
  113439. switch( pStep->op ){
  113440. case TK_UPDATE: {
  113441. sqlite3Update(pParse,
  113442. targetSrcList(pParse, pStep),
  113443. sqlite3ExprListDup(db, pStep->pExprList, 0),
  113444. sqlite3ExprDup(db, pStep->pWhere, 0),
  113445. pParse->eOrconf
  113446. );
  113447. break;
  113448. }
  113449. case TK_INSERT: {
  113450. sqlite3Insert(pParse,
  113451. targetSrcList(pParse, pStep),
  113452. sqlite3SelectDup(db, pStep->pSelect, 0),
  113453. sqlite3IdListDup(db, pStep->pIdList),
  113454. pParse->eOrconf
  113455. );
  113456. break;
  113457. }
  113458. case TK_DELETE: {
  113459. sqlite3DeleteFrom(pParse,
  113460. targetSrcList(pParse, pStep),
  113461. sqlite3ExprDup(db, pStep->pWhere, 0)
  113462. );
  113463. break;
  113464. }
  113465. default: assert( pStep->op==TK_SELECT ); {
  113466. SelectDest sDest;
  113467. Select *pSelect = sqlite3SelectDup(db, pStep->pSelect, 0);
  113468. sqlite3SelectDestInit(&sDest, SRT_Discard, 0);
  113469. sqlite3Select(pParse, pSelect, &sDest);
  113470. sqlite3SelectDelete(db, pSelect);
  113471. break;
  113472. }
  113473. }
  113474. if( pStep->op!=TK_SELECT ){
  113475. sqlite3VdbeAddOp0(v, OP_ResetCount);
  113476. }
  113477. }
  113478. return 0;
  113479. }
  113480. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  113481. /*
  113482. ** This function is used to add VdbeComment() annotations to a VDBE
  113483. ** program. It is not used in production code, only for debugging.
  113484. */
  113485. static const char *onErrorText(int onError){
  113486. switch( onError ){
  113487. case OE_Abort: return "abort";
  113488. case OE_Rollback: return "rollback";
  113489. case OE_Fail: return "fail";
  113490. case OE_Replace: return "replace";
  113491. case OE_Ignore: return "ignore";
  113492. case OE_Default: return "default";
  113493. }
  113494. return "n/a";
  113495. }
  113496. #endif
  113497. /*
  113498. ** Parse context structure pFrom has just been used to create a sub-vdbe
  113499. ** (trigger program). If an error has occurred, transfer error information
  113500. ** from pFrom to pTo.
  113501. */
  113502. static void transferParseError(Parse *pTo, Parse *pFrom){
  113503. assert( pFrom->zErrMsg==0 || pFrom->nErr );
  113504. assert( pTo->zErrMsg==0 || pTo->nErr );
  113505. if( pTo->nErr==0 ){
  113506. pTo->zErrMsg = pFrom->zErrMsg;
  113507. pTo->nErr = pFrom->nErr;
  113508. pTo->rc = pFrom->rc;
  113509. }else{
  113510. sqlite3DbFree(pFrom->db, pFrom->zErrMsg);
  113511. }
  113512. }
  113513. /*
  113514. ** Create and populate a new TriggerPrg object with a sub-program
  113515. ** implementing trigger pTrigger with ON CONFLICT policy orconf.
  113516. */
  113517. static TriggerPrg *codeRowTrigger(
  113518. Parse *pParse, /* Current parse context */
  113519. Trigger *pTrigger, /* Trigger to code */
  113520. Table *pTab, /* The table pTrigger is attached to */
  113521. int orconf /* ON CONFLICT policy to code trigger program with */
  113522. ){
  113523. Parse *pTop = sqlite3ParseToplevel(pParse);
  113524. sqlite3 *db = pParse->db; /* Database handle */
  113525. TriggerPrg *pPrg; /* Value to return */
  113526. Expr *pWhen = 0; /* Duplicate of trigger WHEN expression */
  113527. Vdbe *v; /* Temporary VM */
  113528. NameContext sNC; /* Name context for sub-vdbe */
  113529. SubProgram *pProgram = 0; /* Sub-vdbe for trigger program */
  113530. Parse *pSubParse; /* Parse context for sub-vdbe */
  113531. int iEndTrigger = 0; /* Label to jump to if WHEN is false */
  113532. assert( pTrigger->zName==0 || pTab==tableOfTrigger(pTrigger) );
  113533. assert( pTop->pVdbe );
  113534. /* Allocate the TriggerPrg and SubProgram objects. To ensure that they
  113535. ** are freed if an error occurs, link them into the Parse.pTriggerPrg
  113536. ** list of the top-level Parse object sooner rather than later. */
  113537. pPrg = sqlite3DbMallocZero(db, sizeof(TriggerPrg));
  113538. if( !pPrg ) return 0;
  113539. pPrg->pNext = pTop->pTriggerPrg;
  113540. pTop->pTriggerPrg = pPrg;
  113541. pPrg->pProgram = pProgram = sqlite3DbMallocZero(db, sizeof(SubProgram));
  113542. if( !pProgram ) return 0;
  113543. sqlite3VdbeLinkSubProgram(pTop->pVdbe, pProgram);
  113544. pPrg->pTrigger = pTrigger;
  113545. pPrg->orconf = orconf;
  113546. pPrg->aColmask[0] = 0xffffffff;
  113547. pPrg->aColmask[1] = 0xffffffff;
  113548. /* Allocate and populate a new Parse context to use for coding the
  113549. ** trigger sub-program. */
  113550. pSubParse = sqlite3StackAllocZero(db, sizeof(Parse));
  113551. if( !pSubParse ) return 0;
  113552. memset(&sNC, 0, sizeof(sNC));
  113553. sNC.pParse = pSubParse;
  113554. pSubParse->db = db;
  113555. pSubParse->pTriggerTab = pTab;
  113556. pSubParse->pToplevel = pTop;
  113557. pSubParse->zAuthContext = pTrigger->zName;
  113558. pSubParse->eTriggerOp = pTrigger->op;
  113559. pSubParse->nQueryLoop = pParse->nQueryLoop;
  113560. v = sqlite3GetVdbe(pSubParse);
  113561. if( v ){
  113562. VdbeComment((v, "Start: %s.%s (%s %s%s%s ON %s)",
  113563. pTrigger->zName, onErrorText(orconf),
  113564. (pTrigger->tr_tm==TRIGGER_BEFORE ? "BEFORE" : "AFTER"),
  113565. (pTrigger->op==TK_UPDATE ? "UPDATE" : ""),
  113566. (pTrigger->op==TK_INSERT ? "INSERT" : ""),
  113567. (pTrigger->op==TK_DELETE ? "DELETE" : ""),
  113568. pTab->zName
  113569. ));
  113570. #ifndef SQLITE_OMIT_TRACE
  113571. sqlite3VdbeChangeP4(v, -1,
  113572. sqlite3MPrintf(db, "-- TRIGGER %s", pTrigger->zName), P4_DYNAMIC
  113573. );
  113574. #endif
  113575. /* If one was specified, code the WHEN clause. If it evaluates to false
  113576. ** (or NULL) the sub-vdbe is immediately halted by jumping to the
  113577. ** OP_Halt inserted at the end of the program. */
  113578. if( pTrigger->pWhen ){
  113579. pWhen = sqlite3ExprDup(db, pTrigger->pWhen, 0);
  113580. if( SQLITE_OK==sqlite3ResolveExprNames(&sNC, pWhen)
  113581. && db->mallocFailed==0
  113582. ){
  113583. iEndTrigger = sqlite3VdbeMakeLabel(v);
  113584. sqlite3ExprIfFalse(pSubParse, pWhen, iEndTrigger, SQLITE_JUMPIFNULL);
  113585. }
  113586. sqlite3ExprDelete(db, pWhen);
  113587. }
  113588. /* Code the trigger program into the sub-vdbe. */
  113589. codeTriggerProgram(pSubParse, pTrigger->step_list, orconf);
  113590. /* Insert an OP_Halt at the end of the sub-program. */
  113591. if( iEndTrigger ){
  113592. sqlite3VdbeResolveLabel(v, iEndTrigger);
  113593. }
  113594. sqlite3VdbeAddOp0(v, OP_Halt);
  113595. VdbeComment((v, "End: %s.%s", pTrigger->zName, onErrorText(orconf)));
  113596. transferParseError(pParse, pSubParse);
  113597. if( db->mallocFailed==0 ){
  113598. pProgram->aOp = sqlite3VdbeTakeOpArray(v, &pProgram->nOp, &pTop->nMaxArg);
  113599. }
  113600. pProgram->nMem = pSubParse->nMem;
  113601. pProgram->nCsr = pSubParse->nTab;
  113602. pProgram->token = (void *)pTrigger;
  113603. pPrg->aColmask[0] = pSubParse->oldmask;
  113604. pPrg->aColmask[1] = pSubParse->newmask;
  113605. sqlite3VdbeDelete(v);
  113606. }
  113607. assert( !pSubParse->pAinc && !pSubParse->pZombieTab );
  113608. assert( !pSubParse->pTriggerPrg && !pSubParse->nMaxArg );
  113609. sqlite3ParserReset(pSubParse);
  113610. sqlite3StackFree(db, pSubParse);
  113611. return pPrg;
  113612. }
  113613. /*
  113614. ** Return a pointer to a TriggerPrg object containing the sub-program for
  113615. ** trigger pTrigger with default ON CONFLICT algorithm orconf. If no such
  113616. ** TriggerPrg object exists, a new object is allocated and populated before
  113617. ** being returned.
  113618. */
  113619. static TriggerPrg *getRowTrigger(
  113620. Parse *pParse, /* Current parse context */
  113621. Trigger *pTrigger, /* Trigger to code */
  113622. Table *pTab, /* The table trigger pTrigger is attached to */
  113623. int orconf /* ON CONFLICT algorithm. */
  113624. ){
  113625. Parse *pRoot = sqlite3ParseToplevel(pParse);
  113626. TriggerPrg *pPrg;
  113627. assert( pTrigger->zName==0 || pTab==tableOfTrigger(pTrigger) );
  113628. /* It may be that this trigger has already been coded (or is in the
  113629. ** process of being coded). If this is the case, then an entry with
  113630. ** a matching TriggerPrg.pTrigger field will be present somewhere
  113631. ** in the Parse.pTriggerPrg list. Search for such an entry. */
  113632. for(pPrg=pRoot->pTriggerPrg;
  113633. pPrg && (pPrg->pTrigger!=pTrigger || pPrg->orconf!=orconf);
  113634. pPrg=pPrg->pNext
  113635. );
  113636. /* If an existing TriggerPrg could not be located, create a new one. */
  113637. if( !pPrg ){
  113638. pPrg = codeRowTrigger(pParse, pTrigger, pTab, orconf);
  113639. }
  113640. return pPrg;
  113641. }
  113642. /*
  113643. ** Generate code for the trigger program associated with trigger p on
  113644. ** table pTab. The reg, orconf and ignoreJump parameters passed to this
  113645. ** function are the same as those described in the header function for
  113646. ** sqlite3CodeRowTrigger()
  113647. */
  113648. SQLITE_PRIVATE void sqlite3CodeRowTriggerDirect(
  113649. Parse *pParse, /* Parse context */
  113650. Trigger *p, /* Trigger to code */
  113651. Table *pTab, /* The table to code triggers from */
  113652. int reg, /* Reg array containing OLD.* and NEW.* values */
  113653. int orconf, /* ON CONFLICT policy */
  113654. int ignoreJump /* Instruction to jump to for RAISE(IGNORE) */
  113655. ){
  113656. Vdbe *v = sqlite3GetVdbe(pParse); /* Main VM */
  113657. TriggerPrg *pPrg;
  113658. pPrg = getRowTrigger(pParse, p, pTab, orconf);
  113659. assert( pPrg || pParse->nErr || pParse->db->mallocFailed );
  113660. /* Code the OP_Program opcode in the parent VDBE. P4 of the OP_Program
  113661. ** is a pointer to the sub-vdbe containing the trigger program. */
  113662. if( pPrg ){
  113663. int bRecursive = (p->zName && 0==(pParse->db->flags&SQLITE_RecTriggers));
  113664. sqlite3VdbeAddOp4(v, OP_Program, reg, ignoreJump, ++pParse->nMem,
  113665. (const char *)pPrg->pProgram, P4_SUBPROGRAM);
  113666. VdbeComment(
  113667. (v, "Call: %s.%s", (p->zName?p->zName:"fkey"), onErrorText(orconf)));
  113668. /* Set the P5 operand of the OP_Program instruction to non-zero if
  113669. ** recursive invocation of this trigger program is disallowed. Recursive
  113670. ** invocation is disallowed if (a) the sub-program is really a trigger,
  113671. ** not a foreign key action, and (b) the flag to enable recursive triggers
  113672. ** is clear. */
  113673. sqlite3VdbeChangeP5(v, (u8)bRecursive);
  113674. }
  113675. }
  113676. /*
  113677. ** This is called to code the required FOR EACH ROW triggers for an operation
  113678. ** on table pTab. The operation to code triggers for (INSERT, UPDATE or DELETE)
  113679. ** is given by the op parameter. The tr_tm parameter determines whether the
  113680. ** BEFORE or AFTER triggers are coded. If the operation is an UPDATE, then
  113681. ** parameter pChanges is passed the list of columns being modified.
  113682. **
  113683. ** If there are no triggers that fire at the specified time for the specified
  113684. ** operation on pTab, this function is a no-op.
  113685. **
  113686. ** The reg argument is the address of the first in an array of registers
  113687. ** that contain the values substituted for the new.* and old.* references
  113688. ** in the trigger program. If N is the number of columns in table pTab
  113689. ** (a copy of pTab->nCol), then registers are populated as follows:
  113690. **
  113691. ** Register Contains
  113692. ** ------------------------------------------------------
  113693. ** reg+0 OLD.rowid
  113694. ** reg+1 OLD.* value of left-most column of pTab
  113695. ** ... ...
  113696. ** reg+N OLD.* value of right-most column of pTab
  113697. ** reg+N+1 NEW.rowid
  113698. ** reg+N+2 OLD.* value of left-most column of pTab
  113699. ** ... ...
  113700. ** reg+N+N+1 NEW.* value of right-most column of pTab
  113701. **
  113702. ** For ON DELETE triggers, the registers containing the NEW.* values will
  113703. ** never be accessed by the trigger program, so they are not allocated or
  113704. ** populated by the caller (there is no data to populate them with anyway).
  113705. ** Similarly, for ON INSERT triggers the values stored in the OLD.* registers
  113706. ** are never accessed, and so are not allocated by the caller. So, for an
  113707. ** ON INSERT trigger, the value passed to this function as parameter reg
  113708. ** is not a readable register, although registers (reg+N) through
  113709. ** (reg+N+N+1) are.
  113710. **
  113711. ** Parameter orconf is the default conflict resolution algorithm for the
  113712. ** trigger program to use (REPLACE, IGNORE etc.). Parameter ignoreJump
  113713. ** is the instruction that control should jump to if a trigger program
  113714. ** raises an IGNORE exception.
  113715. */
  113716. SQLITE_PRIVATE void sqlite3CodeRowTrigger(
  113717. Parse *pParse, /* Parse context */
  113718. Trigger *pTrigger, /* List of triggers on table pTab */
  113719. int op, /* One of TK_UPDATE, TK_INSERT, TK_DELETE */
  113720. ExprList *pChanges, /* Changes list for any UPDATE OF triggers */
  113721. int tr_tm, /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
  113722. Table *pTab, /* The table to code triggers from */
  113723. int reg, /* The first in an array of registers (see above) */
  113724. int orconf, /* ON CONFLICT policy */
  113725. int ignoreJump /* Instruction to jump to for RAISE(IGNORE) */
  113726. ){
  113727. Trigger *p; /* Used to iterate through pTrigger list */
  113728. assert( op==TK_UPDATE || op==TK_INSERT || op==TK_DELETE );
  113729. assert( tr_tm==TRIGGER_BEFORE || tr_tm==TRIGGER_AFTER );
  113730. assert( (op==TK_UPDATE)==(pChanges!=0) );
  113731. for(p=pTrigger; p; p=p->pNext){
  113732. /* Sanity checking: The schema for the trigger and for the table are
  113733. ** always defined. The trigger must be in the same schema as the table
  113734. ** or else it must be a TEMP trigger. */
  113735. assert( p->pSchema!=0 );
  113736. assert( p->pTabSchema!=0 );
  113737. assert( p->pSchema==p->pTabSchema
  113738. || p->pSchema==pParse->db->aDb[1].pSchema );
  113739. /* Determine whether we should code this trigger */
  113740. if( p->op==op
  113741. && p->tr_tm==tr_tm
  113742. && checkColumnOverlap(p->pColumns, pChanges)
  113743. ){
  113744. sqlite3CodeRowTriggerDirect(pParse, p, pTab, reg, orconf, ignoreJump);
  113745. }
  113746. }
  113747. }
  113748. /*
  113749. ** Triggers may access values stored in the old.* or new.* pseudo-table.
  113750. ** This function returns a 32-bit bitmask indicating which columns of the
  113751. ** old.* or new.* tables actually are used by triggers. This information
  113752. ** may be used by the caller, for example, to avoid having to load the entire
  113753. ** old.* record into memory when executing an UPDATE or DELETE command.
  113754. **
  113755. ** Bit 0 of the returned mask is set if the left-most column of the
  113756. ** table may be accessed using an [old|new].<col> reference. Bit 1 is set if
  113757. ** the second leftmost column value is required, and so on. If there
  113758. ** are more than 32 columns in the table, and at least one of the columns
  113759. ** with an index greater than 32 may be accessed, 0xffffffff is returned.
  113760. **
  113761. ** It is not possible to determine if the old.rowid or new.rowid column is
  113762. ** accessed by triggers. The caller must always assume that it is.
  113763. **
  113764. ** Parameter isNew must be either 1 or 0. If it is 0, then the mask returned
  113765. ** applies to the old.* table. If 1, the new.* table.
  113766. **
  113767. ** Parameter tr_tm must be a mask with one or both of the TRIGGER_BEFORE
  113768. ** and TRIGGER_AFTER bits set. Values accessed by BEFORE triggers are only
  113769. ** included in the returned mask if the TRIGGER_BEFORE bit is set in the
  113770. ** tr_tm parameter. Similarly, values accessed by AFTER triggers are only
  113771. ** included in the returned mask if the TRIGGER_AFTER bit is set in tr_tm.
  113772. */
  113773. SQLITE_PRIVATE u32 sqlite3TriggerColmask(
  113774. Parse *pParse, /* Parse context */
  113775. Trigger *pTrigger, /* List of triggers on table pTab */
  113776. ExprList *pChanges, /* Changes list for any UPDATE OF triggers */
  113777. int isNew, /* 1 for new.* ref mask, 0 for old.* ref mask */
  113778. int tr_tm, /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  113779. Table *pTab, /* The table to code triggers from */
  113780. int orconf /* Default ON CONFLICT policy for trigger steps */
  113781. ){
  113782. const int op = pChanges ? TK_UPDATE : TK_DELETE;
  113783. u32 mask = 0;
  113784. Trigger *p;
  113785. assert( isNew==1 || isNew==0 );
  113786. for(p=pTrigger; p; p=p->pNext){
  113787. if( p->op==op && (tr_tm&p->tr_tm)
  113788. && checkColumnOverlap(p->pColumns,pChanges)
  113789. ){
  113790. TriggerPrg *pPrg;
  113791. pPrg = getRowTrigger(pParse, p, pTab, orconf);
  113792. if( pPrg ){
  113793. mask |= pPrg->aColmask[isNew];
  113794. }
  113795. }
  113796. }
  113797. return mask;
  113798. }
  113799. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  113800. /************** End of trigger.c *********************************************/
  113801. /************** Begin file update.c ******************************************/
  113802. /*
  113803. ** 2001 September 15
  113804. **
  113805. ** The author disclaims copyright to this source code. In place of
  113806. ** a legal notice, here is a blessing:
  113807. **
  113808. ** May you do good and not evil.
  113809. ** May you find forgiveness for yourself and forgive others.
  113810. ** May you share freely, never taking more than you give.
  113811. **
  113812. *************************************************************************
  113813. ** This file contains C code routines that are called by the parser
  113814. ** to handle UPDATE statements.
  113815. */
  113816. /* #include "sqliteInt.h" */
  113817. #ifndef SQLITE_OMIT_VIRTUALTABLE
  113818. /* Forward declaration */
  113819. static void updateVirtualTable(
  113820. Parse *pParse, /* The parsing context */
  113821. SrcList *pSrc, /* The virtual table to be modified */
  113822. Table *pTab, /* The virtual table */
  113823. ExprList *pChanges, /* The columns to change in the UPDATE statement */
  113824. Expr *pRowidExpr, /* Expression used to recompute the rowid */
  113825. int *aXRef, /* Mapping from columns of pTab to entries in pChanges */
  113826. Expr *pWhere, /* WHERE clause of the UPDATE statement */
  113827. int onError /* ON CONFLICT strategy */
  113828. );
  113829. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  113830. /*
  113831. ** The most recently coded instruction was an OP_Column to retrieve the
  113832. ** i-th column of table pTab. This routine sets the P4 parameter of the
  113833. ** OP_Column to the default value, if any.
  113834. **
  113835. ** The default value of a column is specified by a DEFAULT clause in the
  113836. ** column definition. This was either supplied by the user when the table
  113837. ** was created, or added later to the table definition by an ALTER TABLE
  113838. ** command. If the latter, then the row-records in the table btree on disk
  113839. ** may not contain a value for the column and the default value, taken
  113840. ** from the P4 parameter of the OP_Column instruction, is returned instead.
  113841. ** If the former, then all row-records are guaranteed to include a value
  113842. ** for the column and the P4 value is not required.
  113843. **
  113844. ** Column definitions created by an ALTER TABLE command may only have
  113845. ** literal default values specified: a number, null or a string. (If a more
  113846. ** complicated default expression value was provided, it is evaluated
  113847. ** when the ALTER TABLE is executed and one of the literal values written
  113848. ** into the sqlite_master table.)
  113849. **
  113850. ** Therefore, the P4 parameter is only required if the default value for
  113851. ** the column is a literal number, string or null. The sqlite3ValueFromExpr()
  113852. ** function is capable of transforming these types of expressions into
  113853. ** sqlite3_value objects.
  113854. **
  113855. ** If parameter iReg is not negative, code an OP_RealAffinity instruction
  113856. ** on register iReg. This is used when an equivalent integer value is
  113857. ** stored in place of an 8-byte floating point value in order to save
  113858. ** space.
  113859. */
  113860. SQLITE_PRIVATE void sqlite3ColumnDefault(Vdbe *v, Table *pTab, int i, int iReg){
  113861. assert( pTab!=0 );
  113862. if( !pTab->pSelect ){
  113863. sqlite3_value *pValue = 0;
  113864. u8 enc = ENC(sqlite3VdbeDb(v));
  113865. Column *pCol = &pTab->aCol[i];
  113866. VdbeComment((v, "%s.%s", pTab->zName, pCol->zName));
  113867. assert( i<pTab->nCol );
  113868. sqlite3ValueFromExpr(sqlite3VdbeDb(v), pCol->pDflt, enc,
  113869. pCol->affinity, &pValue);
  113870. if( pValue ){
  113871. sqlite3VdbeChangeP4(v, -1, (const char *)pValue, P4_MEM);
  113872. }
  113873. #ifndef SQLITE_OMIT_FLOATING_POINT
  113874. if( pTab->aCol[i].affinity==SQLITE_AFF_REAL ){
  113875. sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
  113876. }
  113877. #endif
  113878. }
  113879. }
  113880. /*
  113881. ** Process an UPDATE statement.
  113882. **
  113883. ** UPDATE OR IGNORE table_wxyz SET a=b, c=d WHERE e<5 AND f NOT NULL;
  113884. ** \_______/ \________/ \______/ \________________/
  113885. * onError pTabList pChanges pWhere
  113886. */
  113887. SQLITE_PRIVATE void sqlite3Update(
  113888. Parse *pParse, /* The parser context */
  113889. SrcList *pTabList, /* The table in which we should change things */
  113890. ExprList *pChanges, /* Things to be changed */
  113891. Expr *pWhere, /* The WHERE clause. May be null */
  113892. int onError /* How to handle constraint errors */
  113893. ){
  113894. int i, j; /* Loop counters */
  113895. Table *pTab; /* The table to be updated */
  113896. int addrTop = 0; /* VDBE instruction address of the start of the loop */
  113897. WhereInfo *pWInfo; /* Information about the WHERE clause */
  113898. Vdbe *v; /* The virtual database engine */
  113899. Index *pIdx; /* For looping over indices */
  113900. Index *pPk; /* The PRIMARY KEY index for WITHOUT ROWID tables */
  113901. int nIdx; /* Number of indices that need updating */
  113902. int iBaseCur; /* Base cursor number */
  113903. int iDataCur; /* Cursor for the canonical data btree */
  113904. int iIdxCur; /* Cursor for the first index */
  113905. sqlite3 *db; /* The database structure */
  113906. int *aRegIdx = 0; /* One register assigned to each index to be updated */
  113907. int *aXRef = 0; /* aXRef[i] is the index in pChanges->a[] of the
  113908. ** an expression for the i-th column of the table.
  113909. ** aXRef[i]==-1 if the i-th column is not changed. */
  113910. u8 *aToOpen; /* 1 for tables and indices to be opened */
  113911. u8 chngPk; /* PRIMARY KEY changed in a WITHOUT ROWID table */
  113912. u8 chngRowid; /* Rowid changed in a normal table */
  113913. u8 chngKey; /* Either chngPk or chngRowid */
  113914. Expr *pRowidExpr = 0; /* Expression defining the new record number */
  113915. AuthContext sContext; /* The authorization context */
  113916. NameContext sNC; /* The name-context to resolve expressions in */
  113917. int iDb; /* Database containing the table being updated */
  113918. int okOnePass; /* True for one-pass algorithm without the FIFO */
  113919. int hasFK; /* True if foreign key processing is required */
  113920. int labelBreak; /* Jump here to break out of UPDATE loop */
  113921. int labelContinue; /* Jump here to continue next step of UPDATE loop */
  113922. #ifndef SQLITE_OMIT_TRIGGER
  113923. int isView; /* True when updating a view (INSTEAD OF trigger) */
  113924. Trigger *pTrigger; /* List of triggers on pTab, if required */
  113925. int tmask; /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  113926. #endif
  113927. int newmask; /* Mask of NEW.* columns accessed by BEFORE triggers */
  113928. int iEph = 0; /* Ephemeral table holding all primary key values */
  113929. int nKey = 0; /* Number of elements in regKey for WITHOUT ROWID */
  113930. int aiCurOnePass[2]; /* The write cursors opened by WHERE_ONEPASS */
  113931. /* Register Allocations */
  113932. int regRowCount = 0; /* A count of rows changed */
  113933. int regOldRowid = 0; /* The old rowid */
  113934. int regNewRowid = 0; /* The new rowid */
  113935. int regNew = 0; /* Content of the NEW.* table in triggers */
  113936. int regOld = 0; /* Content of OLD.* table in triggers */
  113937. int regRowSet = 0; /* Rowset of rows to be updated */
  113938. int regKey = 0; /* composite PRIMARY KEY value */
  113939. memset(&sContext, 0, sizeof(sContext));
  113940. db = pParse->db;
  113941. if( pParse->nErr || db->mallocFailed ){
  113942. goto update_cleanup;
  113943. }
  113944. assert( pTabList->nSrc==1 );
  113945. /* Locate the table which we want to update.
  113946. */
  113947. pTab = sqlite3SrcListLookup(pParse, pTabList);
  113948. if( pTab==0 ) goto update_cleanup;
  113949. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  113950. /* Figure out if we have any triggers and if the table being
  113951. ** updated is a view.
  113952. */
  113953. #ifndef SQLITE_OMIT_TRIGGER
  113954. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_UPDATE, pChanges, &tmask);
  113955. isView = pTab->pSelect!=0;
  113956. assert( pTrigger || tmask==0 );
  113957. #else
  113958. # define pTrigger 0
  113959. # define isView 0
  113960. # define tmask 0
  113961. #endif
  113962. #ifdef SQLITE_OMIT_VIEW
  113963. # undef isView
  113964. # define isView 0
  113965. #endif
  113966. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  113967. goto update_cleanup;
  113968. }
  113969. if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
  113970. goto update_cleanup;
  113971. }
  113972. /* Allocate a cursors for the main database table and for all indices.
  113973. ** The index cursors might not be used, but if they are used they
  113974. ** need to occur right after the database cursor. So go ahead and
  113975. ** allocate enough space, just in case.
  113976. */
  113977. pTabList->a[0].iCursor = iBaseCur = iDataCur = pParse->nTab++;
  113978. iIdxCur = iDataCur+1;
  113979. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  113980. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
  113981. if( IsPrimaryKeyIndex(pIdx) && pPk!=0 ){
  113982. iDataCur = pParse->nTab;
  113983. pTabList->a[0].iCursor = iDataCur;
  113984. }
  113985. pParse->nTab++;
  113986. }
  113987. /* Allocate space for aXRef[], aRegIdx[], and aToOpen[].
  113988. ** Initialize aXRef[] and aToOpen[] to their default values.
  113989. */
  113990. aXRef = sqlite3DbMallocRawNN(db, sizeof(int) * (pTab->nCol+nIdx) + nIdx+2 );
  113991. if( aXRef==0 ) goto update_cleanup;
  113992. aRegIdx = aXRef+pTab->nCol;
  113993. aToOpen = (u8*)(aRegIdx+nIdx);
  113994. memset(aToOpen, 1, nIdx+1);
  113995. aToOpen[nIdx+1] = 0;
  113996. for(i=0; i<pTab->nCol; i++) aXRef[i] = -1;
  113997. /* Initialize the name-context */
  113998. memset(&sNC, 0, sizeof(sNC));
  113999. sNC.pParse = pParse;
  114000. sNC.pSrcList = pTabList;
  114001. /* Resolve the column names in all the expressions of the
  114002. ** of the UPDATE statement. Also find the column index
  114003. ** for each column to be updated in the pChanges array. For each
  114004. ** column to be updated, make sure we have authorization to change
  114005. ** that column.
  114006. */
  114007. chngRowid = chngPk = 0;
  114008. for(i=0; i<pChanges->nExpr; i++){
  114009. if( sqlite3ResolveExprNames(&sNC, pChanges->a[i].pExpr) ){
  114010. goto update_cleanup;
  114011. }
  114012. for(j=0; j<pTab->nCol; j++){
  114013. if( sqlite3StrICmp(pTab->aCol[j].zName, pChanges->a[i].zName)==0 ){
  114014. if( j==pTab->iPKey ){
  114015. chngRowid = 1;
  114016. pRowidExpr = pChanges->a[i].pExpr;
  114017. }else if( pPk && (pTab->aCol[j].colFlags & COLFLAG_PRIMKEY)!=0 ){
  114018. chngPk = 1;
  114019. }
  114020. aXRef[j] = i;
  114021. break;
  114022. }
  114023. }
  114024. if( j>=pTab->nCol ){
  114025. if( pPk==0 && sqlite3IsRowid(pChanges->a[i].zName) ){
  114026. j = -1;
  114027. chngRowid = 1;
  114028. pRowidExpr = pChanges->a[i].pExpr;
  114029. }else{
  114030. sqlite3ErrorMsg(pParse, "no such column: %s", pChanges->a[i].zName);
  114031. pParse->checkSchema = 1;
  114032. goto update_cleanup;
  114033. }
  114034. }
  114035. #ifndef SQLITE_OMIT_AUTHORIZATION
  114036. {
  114037. int rc;
  114038. rc = sqlite3AuthCheck(pParse, SQLITE_UPDATE, pTab->zName,
  114039. j<0 ? "ROWID" : pTab->aCol[j].zName,
  114040. db->aDb[iDb].zDbSName);
  114041. if( rc==SQLITE_DENY ){
  114042. goto update_cleanup;
  114043. }else if( rc==SQLITE_IGNORE ){
  114044. aXRef[j] = -1;
  114045. }
  114046. }
  114047. #endif
  114048. }
  114049. assert( (chngRowid & chngPk)==0 );
  114050. assert( chngRowid==0 || chngRowid==1 );
  114051. assert( chngPk==0 || chngPk==1 );
  114052. chngKey = chngRowid + chngPk;
  114053. /* The SET expressions are not actually used inside the WHERE loop.
  114054. ** So reset the colUsed mask. Unless this is a virtual table. In that
  114055. ** case, set all bits of the colUsed mask (to ensure that the virtual
  114056. ** table implementation makes all columns available).
  114057. */
  114058. pTabList->a[0].colUsed = IsVirtual(pTab) ? ALLBITS : 0;
  114059. hasFK = sqlite3FkRequired(pParse, pTab, aXRef, chngKey);
  114060. /* There is one entry in the aRegIdx[] array for each index on the table
  114061. ** being updated. Fill in aRegIdx[] with a register number that will hold
  114062. ** the key for accessing each index.
  114063. **
  114064. ** FIXME: Be smarter about omitting indexes that use expressions.
  114065. */
  114066. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  114067. int reg;
  114068. if( chngKey || hasFK || pIdx->pPartIdxWhere || pIdx==pPk ){
  114069. reg = ++pParse->nMem;
  114070. }else{
  114071. reg = 0;
  114072. for(i=0; i<pIdx->nKeyCol; i++){
  114073. i16 iIdxCol = pIdx->aiColumn[i];
  114074. if( iIdxCol<0 || aXRef[iIdxCol]>=0 ){
  114075. reg = ++pParse->nMem;
  114076. break;
  114077. }
  114078. }
  114079. }
  114080. if( reg==0 ) aToOpen[j+1] = 0;
  114081. aRegIdx[j] = reg;
  114082. }
  114083. /* Begin generating code. */
  114084. v = sqlite3GetVdbe(pParse);
  114085. if( v==0 ) goto update_cleanup;
  114086. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  114087. sqlite3BeginWriteOperation(pParse, 1, iDb);
  114088. /* Allocate required registers. */
  114089. if( !IsVirtual(pTab) ){
  114090. regRowSet = ++pParse->nMem;
  114091. regOldRowid = regNewRowid = ++pParse->nMem;
  114092. if( chngPk || pTrigger || hasFK ){
  114093. regOld = pParse->nMem + 1;
  114094. pParse->nMem += pTab->nCol;
  114095. }
  114096. if( chngKey || pTrigger || hasFK ){
  114097. regNewRowid = ++pParse->nMem;
  114098. }
  114099. regNew = pParse->nMem + 1;
  114100. pParse->nMem += pTab->nCol;
  114101. }
  114102. /* Start the view context. */
  114103. if( isView ){
  114104. sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
  114105. }
  114106. /* If we are trying to update a view, realize that view into
  114107. ** an ephemeral table.
  114108. */
  114109. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  114110. if( isView ){
  114111. sqlite3MaterializeView(pParse, pTab, pWhere, iDataCur);
  114112. }
  114113. #endif
  114114. /* Resolve the column names in all the expressions in the
  114115. ** WHERE clause.
  114116. */
  114117. if( sqlite3ResolveExprNames(&sNC, pWhere) ){
  114118. goto update_cleanup;
  114119. }
  114120. #ifndef SQLITE_OMIT_VIRTUALTABLE
  114121. /* Virtual tables must be handled separately */
  114122. if( IsVirtual(pTab) ){
  114123. updateVirtualTable(pParse, pTabList, pTab, pChanges, pRowidExpr, aXRef,
  114124. pWhere, onError);
  114125. goto update_cleanup;
  114126. }
  114127. #endif
  114128. /* Begin the database scan
  114129. */
  114130. if( HasRowid(pTab) ){
  114131. sqlite3VdbeAddOp3(v, OP_Null, 0, regRowSet, regOldRowid);
  114132. pWInfo = sqlite3WhereBegin(
  114133. pParse, pTabList, pWhere, 0, 0,
  114134. WHERE_ONEPASS_DESIRED | WHERE_SEEK_TABLE, iIdxCur
  114135. );
  114136. if( pWInfo==0 ) goto update_cleanup;
  114137. okOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
  114138. /* Remember the rowid of every item to be updated.
  114139. */
  114140. sqlite3VdbeAddOp2(v, OP_Rowid, iDataCur, regOldRowid);
  114141. if( !okOnePass ){
  114142. sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, regOldRowid);
  114143. }
  114144. /* End the database scan loop.
  114145. */
  114146. sqlite3WhereEnd(pWInfo);
  114147. }else{
  114148. int iPk; /* First of nPk memory cells holding PRIMARY KEY value */
  114149. i16 nPk; /* Number of components of the PRIMARY KEY */
  114150. int addrOpen; /* Address of the OpenEphemeral instruction */
  114151. assert( pPk!=0 );
  114152. nPk = pPk->nKeyCol;
  114153. iPk = pParse->nMem+1;
  114154. pParse->nMem += nPk;
  114155. regKey = ++pParse->nMem;
  114156. iEph = pParse->nTab++;
  114157. sqlite3VdbeAddOp2(v, OP_Null, 0, iPk);
  114158. addrOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEph, nPk);
  114159. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  114160. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0,
  114161. WHERE_ONEPASS_DESIRED, iIdxCur);
  114162. if( pWInfo==0 ) goto update_cleanup;
  114163. okOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
  114164. for(i=0; i<nPk; i++){
  114165. assert( pPk->aiColumn[i]>=0 );
  114166. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, pPk->aiColumn[i],
  114167. iPk+i);
  114168. }
  114169. if( okOnePass ){
  114170. sqlite3VdbeChangeToNoop(v, addrOpen);
  114171. nKey = nPk;
  114172. regKey = iPk;
  114173. }else{
  114174. sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, regKey,
  114175. sqlite3IndexAffinityStr(db, pPk), nPk);
  114176. sqlite3VdbeAddOp2(v, OP_IdxInsert, iEph, regKey);
  114177. }
  114178. sqlite3WhereEnd(pWInfo);
  114179. }
  114180. /* Initialize the count of updated rows
  114181. */
  114182. if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab ){
  114183. regRowCount = ++pParse->nMem;
  114184. sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
  114185. }
  114186. labelBreak = sqlite3VdbeMakeLabel(v);
  114187. if( !isView ){
  114188. /*
  114189. ** Open every index that needs updating. Note that if any
  114190. ** index could potentially invoke a REPLACE conflict resolution
  114191. ** action, then we need to open all indices because we might need
  114192. ** to be deleting some records.
  114193. */
  114194. if( onError==OE_Replace ){
  114195. memset(aToOpen, 1, nIdx+1);
  114196. }else{
  114197. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  114198. if( pIdx->onError==OE_Replace ){
  114199. memset(aToOpen, 1, nIdx+1);
  114200. break;
  114201. }
  114202. }
  114203. }
  114204. if( okOnePass ){
  114205. if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iBaseCur] = 0;
  114206. if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iBaseCur] = 0;
  114207. }
  114208. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, iBaseCur, aToOpen,
  114209. 0, 0);
  114210. }
  114211. /* Top of the update loop */
  114212. if( okOnePass ){
  114213. if( aToOpen[iDataCur-iBaseCur] && !isView ){
  114214. assert( pPk );
  114215. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelBreak, regKey, nKey);
  114216. VdbeCoverageNeverTaken(v);
  114217. }
  114218. labelContinue = labelBreak;
  114219. sqlite3VdbeAddOp2(v, OP_IsNull, pPk ? regKey : regOldRowid, labelBreak);
  114220. VdbeCoverageIf(v, pPk==0);
  114221. VdbeCoverageIf(v, pPk!=0);
  114222. }else if( pPk ){
  114223. labelContinue = sqlite3VdbeMakeLabel(v);
  114224. sqlite3VdbeAddOp2(v, OP_Rewind, iEph, labelBreak); VdbeCoverage(v);
  114225. addrTop = sqlite3VdbeAddOp2(v, OP_RowKey, iEph, regKey);
  114226. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue, regKey, 0);
  114227. VdbeCoverage(v);
  114228. }else{
  114229. labelContinue = sqlite3VdbeAddOp3(v, OP_RowSetRead, regRowSet, labelBreak,
  114230. regOldRowid);
  114231. VdbeCoverage(v);
  114232. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
  114233. VdbeCoverage(v);
  114234. }
  114235. /* If the record number will change, set register regNewRowid to
  114236. ** contain the new value. If the record number is not being modified,
  114237. ** then regNewRowid is the same register as regOldRowid, which is
  114238. ** already populated. */
  114239. assert( chngKey || pTrigger || hasFK || regOldRowid==regNewRowid );
  114240. if( chngRowid ){
  114241. sqlite3ExprCode(pParse, pRowidExpr, regNewRowid);
  114242. sqlite3VdbeAddOp1(v, OP_MustBeInt, regNewRowid); VdbeCoverage(v);
  114243. }
  114244. /* Compute the old pre-UPDATE content of the row being changed, if that
  114245. ** information is needed */
  114246. if( chngPk || hasFK || pTrigger ){
  114247. u32 oldmask = (hasFK ? sqlite3FkOldmask(pParse, pTab) : 0);
  114248. oldmask |= sqlite3TriggerColmask(pParse,
  114249. pTrigger, pChanges, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onError
  114250. );
  114251. for(i=0; i<pTab->nCol; i++){
  114252. if( oldmask==0xffffffff
  114253. || (i<32 && (oldmask & MASKBIT32(i))!=0)
  114254. || (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0
  114255. ){
  114256. testcase( oldmask!=0xffffffff && i==31 );
  114257. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regOld+i);
  114258. }else{
  114259. sqlite3VdbeAddOp2(v, OP_Null, 0, regOld+i);
  114260. }
  114261. }
  114262. if( chngRowid==0 && pPk==0 ){
  114263. sqlite3VdbeAddOp2(v, OP_Copy, regOldRowid, regNewRowid);
  114264. }
  114265. }
  114266. /* Populate the array of registers beginning at regNew with the new
  114267. ** row data. This array is used to check constants, create the new
  114268. ** table and index records, and as the values for any new.* references
  114269. ** made by triggers.
  114270. **
  114271. ** If there are one or more BEFORE triggers, then do not populate the
  114272. ** registers associated with columns that are (a) not modified by
  114273. ** this UPDATE statement and (b) not accessed by new.* references. The
  114274. ** values for registers not modified by the UPDATE must be reloaded from
  114275. ** the database after the BEFORE triggers are fired anyway (as the trigger
  114276. ** may have modified them). So not loading those that are not going to
  114277. ** be used eliminates some redundant opcodes.
  114278. */
  114279. newmask = sqlite3TriggerColmask(
  114280. pParse, pTrigger, pChanges, 1, TRIGGER_BEFORE, pTab, onError
  114281. );
  114282. for(i=0; i<pTab->nCol; i++){
  114283. if( i==pTab->iPKey ){
  114284. sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
  114285. }else{
  114286. j = aXRef[i];
  114287. if( j>=0 ){
  114288. sqlite3ExprCode(pParse, pChanges->a[j].pExpr, regNew+i);
  114289. }else if( 0==(tmask&TRIGGER_BEFORE) || i>31 || (newmask & MASKBIT32(i)) ){
  114290. /* This branch loads the value of a column that will not be changed
  114291. ** into a register. This is done if there are no BEFORE triggers, or
  114292. ** if there are one or more BEFORE triggers that use this value via
  114293. ** a new.* reference in a trigger program.
  114294. */
  114295. testcase( i==31 );
  114296. testcase( i==32 );
  114297. sqlite3ExprCodeGetColumnToReg(pParse, pTab, i, iDataCur, regNew+i);
  114298. }else{
  114299. sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
  114300. }
  114301. }
  114302. }
  114303. /* Fire any BEFORE UPDATE triggers. This happens before constraints are
  114304. ** verified. One could argue that this is wrong.
  114305. */
  114306. if( tmask&TRIGGER_BEFORE ){
  114307. sqlite3TableAffinity(v, pTab, regNew);
  114308. sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
  114309. TRIGGER_BEFORE, pTab, regOldRowid, onError, labelContinue);
  114310. /* The row-trigger may have deleted the row being updated. In this
  114311. ** case, jump to the next row. No updates or AFTER triggers are
  114312. ** required. This behavior - what happens when the row being updated
  114313. ** is deleted or renamed by a BEFORE trigger - is left undefined in the
  114314. ** documentation.
  114315. */
  114316. if( pPk ){
  114317. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue,regKey,nKey);
  114318. VdbeCoverage(v);
  114319. }else{
  114320. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
  114321. VdbeCoverage(v);
  114322. }
  114323. /* If it did not delete it, the row-trigger may still have modified
  114324. ** some of the columns of the row being updated. Load the values for
  114325. ** all columns not modified by the update statement into their
  114326. ** registers in case this has happened.
  114327. */
  114328. for(i=0; i<pTab->nCol; i++){
  114329. if( aXRef[i]<0 && i!=pTab->iPKey ){
  114330. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regNew+i);
  114331. }
  114332. }
  114333. }
  114334. if( !isView ){
  114335. int addr1 = 0; /* Address of jump instruction */
  114336. int bReplace = 0; /* True if REPLACE conflict resolution might happen */
  114337. /* Do constraint checks. */
  114338. assert( regOldRowid>0 );
  114339. sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
  114340. regNewRowid, regOldRowid, chngKey, onError, labelContinue, &bReplace,
  114341. aXRef);
  114342. /* Do FK constraint checks. */
  114343. if( hasFK ){
  114344. sqlite3FkCheck(pParse, pTab, regOldRowid, 0, aXRef, chngKey);
  114345. }
  114346. /* Delete the index entries associated with the current record. */
  114347. if( bReplace || chngKey ){
  114348. if( pPk ){
  114349. addr1 = sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, 0, regKey, nKey);
  114350. }else{
  114351. addr1 = sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, 0, regOldRowid);
  114352. }
  114353. VdbeCoverageNeverTaken(v);
  114354. }
  114355. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur, aRegIdx, -1);
  114356. /* If changing the rowid value, or if there are foreign key constraints
  114357. ** to process, delete the old record. Otherwise, add a noop OP_Delete
  114358. ** to invoke the pre-update hook.
  114359. **
  114360. ** That (regNew==regnewRowid+1) is true is also important for the
  114361. ** pre-update hook. If the caller invokes preupdate_new(), the returned
  114362. ** value is copied from memory cell (regNewRowid+1+iCol), where iCol
  114363. ** is the column index supplied by the user.
  114364. */
  114365. assert( regNew==regNewRowid+1 );
  114366. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  114367. sqlite3VdbeAddOp3(v, OP_Delete, iDataCur,
  114368. OPFLAG_ISUPDATE | ((hasFK || chngKey || pPk!=0) ? 0 : OPFLAG_ISNOOP),
  114369. regNewRowid
  114370. );
  114371. if( !pParse->nested ){
  114372. sqlite3VdbeChangeP4(v, -1, (char*)pTab, P4_TABLE);
  114373. }
  114374. #else
  114375. if( hasFK || chngKey || pPk!=0 ){
  114376. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, 0);
  114377. }
  114378. #endif
  114379. if( bReplace || chngKey ){
  114380. sqlite3VdbeJumpHere(v, addr1);
  114381. }
  114382. if( hasFK ){
  114383. sqlite3FkCheck(pParse, pTab, 0, regNewRowid, aXRef, chngKey);
  114384. }
  114385. /* Insert the new index entries and the new record. */
  114386. sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
  114387. regNewRowid, aRegIdx, 1, 0, 0);
  114388. /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
  114389. ** handle rows (possibly in other tables) that refer via a foreign key
  114390. ** to the row just updated. */
  114391. if( hasFK ){
  114392. sqlite3FkActions(pParse, pTab, pChanges, regOldRowid, aXRef, chngKey);
  114393. }
  114394. }
  114395. /* Increment the row counter
  114396. */
  114397. if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab){
  114398. sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
  114399. }
  114400. sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
  114401. TRIGGER_AFTER, pTab, regOldRowid, onError, labelContinue);
  114402. /* Repeat the above with the next record to be updated, until
  114403. ** all record selected by the WHERE clause have been updated.
  114404. */
  114405. if( okOnePass ){
  114406. /* Nothing to do at end-of-loop for a single-pass */
  114407. }else if( pPk ){
  114408. sqlite3VdbeResolveLabel(v, labelContinue);
  114409. sqlite3VdbeAddOp2(v, OP_Next, iEph, addrTop); VdbeCoverage(v);
  114410. }else{
  114411. sqlite3VdbeGoto(v, labelContinue);
  114412. }
  114413. sqlite3VdbeResolveLabel(v, labelBreak);
  114414. /* Close all tables */
  114415. for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
  114416. assert( aRegIdx );
  114417. if( aToOpen[i+1] ){
  114418. sqlite3VdbeAddOp2(v, OP_Close, iIdxCur+i, 0);
  114419. }
  114420. }
  114421. if( iDataCur<iIdxCur ) sqlite3VdbeAddOp2(v, OP_Close, iDataCur, 0);
  114422. /* Update the sqlite_sequence table by storing the content of the
  114423. ** maximum rowid counter values recorded while inserting into
  114424. ** autoincrement tables.
  114425. */
  114426. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  114427. sqlite3AutoincrementEnd(pParse);
  114428. }
  114429. /*
  114430. ** Return the number of rows that were changed. If this routine is
  114431. ** generating code because of a call to sqlite3NestedParse(), do not
  114432. ** invoke the callback function.
  114433. */
  114434. if( (db->flags&SQLITE_CountRows) && !pParse->pTriggerTab && !pParse->nested ){
  114435. sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
  114436. sqlite3VdbeSetNumCols(v, 1);
  114437. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows updated", SQLITE_STATIC);
  114438. }
  114439. update_cleanup:
  114440. sqlite3AuthContextPop(&sContext);
  114441. sqlite3DbFree(db, aXRef); /* Also frees aRegIdx[] and aToOpen[] */
  114442. sqlite3SrcListDelete(db, pTabList);
  114443. sqlite3ExprListDelete(db, pChanges);
  114444. sqlite3ExprDelete(db, pWhere);
  114445. return;
  114446. }
  114447. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  114448. ** they may interfere with compilation of other functions in this file
  114449. ** (or in another file, if this file becomes part of the amalgamation). */
  114450. #ifdef isView
  114451. #undef isView
  114452. #endif
  114453. #ifdef pTrigger
  114454. #undef pTrigger
  114455. #endif
  114456. #ifndef SQLITE_OMIT_VIRTUALTABLE
  114457. /*
  114458. ** Generate code for an UPDATE of a virtual table.
  114459. **
  114460. ** There are two possible strategies - the default and the special
  114461. ** "onepass" strategy. Onepass is only used if the virtual table
  114462. ** implementation indicates that pWhere may match at most one row.
  114463. **
  114464. ** The default strategy is to create an ephemeral table that contains
  114465. ** for each row to be changed:
  114466. **
  114467. ** (A) The original rowid of that row.
  114468. ** (B) The revised rowid for the row.
  114469. ** (C) The content of every column in the row.
  114470. **
  114471. ** Then loop through the contents of this ephemeral table executing a
  114472. ** VUpdate for each row. When finished, drop the ephemeral table.
  114473. **
  114474. ** The "onepass" strategy does not use an ephemeral table. Instead, it
  114475. ** stores the same values (A, B and C above) in a register array and
  114476. ** makes a single invocation of VUpdate.
  114477. */
  114478. static void updateVirtualTable(
  114479. Parse *pParse, /* The parsing context */
  114480. SrcList *pSrc, /* The virtual table to be modified */
  114481. Table *pTab, /* The virtual table */
  114482. ExprList *pChanges, /* The columns to change in the UPDATE statement */
  114483. Expr *pRowid, /* Expression used to recompute the rowid */
  114484. int *aXRef, /* Mapping from columns of pTab to entries in pChanges */
  114485. Expr *pWhere, /* WHERE clause of the UPDATE statement */
  114486. int onError /* ON CONFLICT strategy */
  114487. ){
  114488. Vdbe *v = pParse->pVdbe; /* Virtual machine under construction */
  114489. int ephemTab; /* Table holding the result of the SELECT */
  114490. int i; /* Loop counter */
  114491. sqlite3 *db = pParse->db; /* Database connection */
  114492. const char *pVTab = (const char*)sqlite3GetVTable(db, pTab);
  114493. WhereInfo *pWInfo;
  114494. int nArg = 2 + pTab->nCol; /* Number of arguments to VUpdate */
  114495. int regArg; /* First register in VUpdate arg array */
  114496. int regRec; /* Register in which to assemble record */
  114497. int regRowid; /* Register for ephem table rowid */
  114498. int iCsr = pSrc->a[0].iCursor; /* Cursor used for virtual table scan */
  114499. int aDummy[2]; /* Unused arg for sqlite3WhereOkOnePass() */
  114500. int bOnePass; /* True to use onepass strategy */
  114501. int addr; /* Address of OP_OpenEphemeral */
  114502. /* Allocate nArg registers to martial the arguments to VUpdate. Then
  114503. ** create and open the ephemeral table in which the records created from
  114504. ** these arguments will be temporarily stored. */
  114505. assert( v );
  114506. ephemTab = pParse->nTab++;
  114507. addr= sqlite3VdbeAddOp2(v, OP_OpenEphemeral, ephemTab, nArg);
  114508. regArg = pParse->nMem + 1;
  114509. pParse->nMem += nArg;
  114510. regRec = ++pParse->nMem;
  114511. regRowid = ++pParse->nMem;
  114512. /* Start scanning the virtual table */
  114513. pWInfo = sqlite3WhereBegin(pParse, pSrc, pWhere, 0,0,WHERE_ONEPASS_DESIRED,0);
  114514. if( pWInfo==0 ) return;
  114515. /* Populate the argument registers. */
  114516. sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg);
  114517. if( pRowid ){
  114518. sqlite3ExprCode(pParse, pRowid, regArg+1);
  114519. }else{
  114520. sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg+1);
  114521. }
  114522. for(i=0; i<pTab->nCol; i++){
  114523. if( aXRef[i]>=0 ){
  114524. sqlite3ExprCode(pParse, pChanges->a[aXRef[i]].pExpr, regArg+2+i);
  114525. }else{
  114526. sqlite3VdbeAddOp3(v, OP_VColumn, iCsr, i, regArg+2+i);
  114527. }
  114528. }
  114529. bOnePass = sqlite3WhereOkOnePass(pWInfo, aDummy);
  114530. if( bOnePass ){
  114531. /* If using the onepass strategy, no-op out the OP_OpenEphemeral coded
  114532. ** above. Also, if this is a top-level parse (not a trigger), clear the
  114533. ** multi-write flag so that the VM does not open a statement journal */
  114534. sqlite3VdbeChangeToNoop(v, addr);
  114535. if( sqlite3IsToplevel(pParse) ){
  114536. pParse->isMultiWrite = 0;
  114537. }
  114538. }else{
  114539. /* Create a record from the argument register contents and insert it into
  114540. ** the ephemeral table. */
  114541. sqlite3VdbeAddOp3(v, OP_MakeRecord, regArg, nArg, regRec);
  114542. sqlite3VdbeAddOp2(v, OP_NewRowid, ephemTab, regRowid);
  114543. sqlite3VdbeAddOp3(v, OP_Insert, ephemTab, regRec, regRowid);
  114544. }
  114545. if( bOnePass==0 ){
  114546. /* End the virtual table scan */
  114547. sqlite3WhereEnd(pWInfo);
  114548. /* Begin scannning through the ephemeral table. */
  114549. addr = sqlite3VdbeAddOp1(v, OP_Rewind, ephemTab); VdbeCoverage(v);
  114550. /* Extract arguments from the current row of the ephemeral table and
  114551. ** invoke the VUpdate method. */
  114552. for(i=0; i<nArg; i++){
  114553. sqlite3VdbeAddOp3(v, OP_Column, ephemTab, i, regArg+i);
  114554. }
  114555. }
  114556. sqlite3VtabMakeWritable(pParse, pTab);
  114557. sqlite3VdbeAddOp4(v, OP_VUpdate, 0, nArg, regArg, pVTab, P4_VTAB);
  114558. sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
  114559. sqlite3MayAbort(pParse);
  114560. /* End of the ephemeral table scan. Or, if using the onepass strategy,
  114561. ** jump to here if the scan visited zero rows. */
  114562. if( bOnePass==0 ){
  114563. sqlite3VdbeAddOp2(v, OP_Next, ephemTab, addr+1); VdbeCoverage(v);
  114564. sqlite3VdbeJumpHere(v, addr);
  114565. sqlite3VdbeAddOp2(v, OP_Close, ephemTab, 0);
  114566. }else{
  114567. sqlite3WhereEnd(pWInfo);
  114568. }
  114569. }
  114570. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  114571. /************** End of update.c **********************************************/
  114572. /************** Begin file vacuum.c ******************************************/
  114573. /*
  114574. ** 2003 April 6
  114575. **
  114576. ** The author disclaims copyright to this source code. In place of
  114577. ** a legal notice, here is a blessing:
  114578. **
  114579. ** May you do good and not evil.
  114580. ** May you find forgiveness for yourself and forgive others.
  114581. ** May you share freely, never taking more than you give.
  114582. **
  114583. *************************************************************************
  114584. ** This file contains code used to implement the VACUUM command.
  114585. **
  114586. ** Most of the code in this file may be omitted by defining the
  114587. ** SQLITE_OMIT_VACUUM macro.
  114588. */
  114589. /* #include "sqliteInt.h" */
  114590. /* #include "vdbeInt.h" */
  114591. #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
  114592. /*
  114593. ** Execute zSql on database db.
  114594. **
  114595. ** If zSql returns rows, then each row will have exactly one
  114596. ** column. (This will only happen if zSql begins with "SELECT".)
  114597. ** Take each row of result and call execSql() again recursively.
  114598. **
  114599. ** The execSqlF() routine does the same thing, except it accepts
  114600. ** a format string as its third argument
  114601. */
  114602. static int execSql(sqlite3 *db, char **pzErrMsg, const char *zSql){
  114603. sqlite3_stmt *pStmt;
  114604. int rc;
  114605. /* printf("SQL: [%s]\n", zSql); fflush(stdout); */
  114606. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  114607. if( rc!=SQLITE_OK ) return rc;
  114608. while( SQLITE_ROW==(rc = sqlite3_step(pStmt)) ){
  114609. const char *zSubSql = (const char*)sqlite3_column_text(pStmt,0);
  114610. assert( sqlite3_strnicmp(zSql,"SELECT",6)==0 );
  114611. if( zSubSql ){
  114612. assert( zSubSql[0]!='S' );
  114613. rc = execSql(db, pzErrMsg, zSubSql);
  114614. if( rc!=SQLITE_OK ) break;
  114615. }
  114616. }
  114617. assert( rc!=SQLITE_ROW );
  114618. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  114619. if( rc ){
  114620. sqlite3SetString(pzErrMsg, db, sqlite3_errmsg(db));
  114621. }
  114622. (void)sqlite3_finalize(pStmt);
  114623. return rc;
  114624. }
  114625. static int execSqlF(sqlite3 *db, char **pzErrMsg, const char *zSql, ...){
  114626. char *z;
  114627. va_list ap;
  114628. int rc;
  114629. va_start(ap, zSql);
  114630. z = sqlite3VMPrintf(db, zSql, ap);
  114631. va_end(ap);
  114632. if( z==0 ) return SQLITE_NOMEM;
  114633. rc = execSql(db, pzErrMsg, z);
  114634. sqlite3DbFree(db, z);
  114635. return rc;
  114636. }
  114637. /*
  114638. ** The VACUUM command is used to clean up the database,
  114639. ** collapse free space, etc. It is modelled after the VACUUM command
  114640. ** in PostgreSQL. The VACUUM command works as follows:
  114641. **
  114642. ** (1) Create a new transient database file
  114643. ** (2) Copy all content from the database being vacuumed into
  114644. ** the new transient database file
  114645. ** (3) Copy content from the transient database back into the
  114646. ** original database.
  114647. **
  114648. ** The transient database requires temporary disk space approximately
  114649. ** equal to the size of the original database. The copy operation of
  114650. ** step (3) requires additional temporary disk space approximately equal
  114651. ** to the size of the original database for the rollback journal.
  114652. ** Hence, temporary disk space that is approximately 2x the size of the
  114653. ** original database is required. Every page of the database is written
  114654. ** approximately 3 times: Once for step (2) and twice for step (3).
  114655. ** Two writes per page are required in step (3) because the original
  114656. ** database content must be written into the rollback journal prior to
  114657. ** overwriting the database with the vacuumed content.
  114658. **
  114659. ** Only 1x temporary space and only 1x writes would be required if
  114660. ** the copy of step (3) were replaced by deleting the original database
  114661. ** and renaming the transient database as the original. But that will
  114662. ** not work if other processes are attached to the original database.
  114663. ** And a power loss in between deleting the original and renaming the
  114664. ** transient would cause the database file to appear to be deleted
  114665. ** following reboot.
  114666. */
  114667. SQLITE_PRIVATE void sqlite3Vacuum(Parse *pParse, Token *pNm){
  114668. Vdbe *v = sqlite3GetVdbe(pParse);
  114669. int iDb = pNm ? sqlite3TwoPartName(pParse, pNm, pNm, &pNm) : 0;
  114670. if( v && (iDb>=2 || iDb==0) ){
  114671. sqlite3VdbeAddOp1(v, OP_Vacuum, iDb);
  114672. sqlite3VdbeUsesBtree(v, iDb);
  114673. }
  114674. return;
  114675. }
  114676. /*
  114677. ** This routine implements the OP_Vacuum opcode of the VDBE.
  114678. */
  114679. SQLITE_PRIVATE int sqlite3RunVacuum(char **pzErrMsg, sqlite3 *db, int iDb){
  114680. int rc = SQLITE_OK; /* Return code from service routines */
  114681. Btree *pMain; /* The database being vacuumed */
  114682. Btree *pTemp; /* The temporary database we vacuum into */
  114683. int saved_flags; /* Saved value of the db->flags */
  114684. int saved_nChange; /* Saved value of db->nChange */
  114685. int saved_nTotalChange; /* Saved value of db->nTotalChange */
  114686. u8 saved_mTrace; /* Saved trace settings */
  114687. Db *pDb = 0; /* Database to detach at end of vacuum */
  114688. int isMemDb; /* True if vacuuming a :memory: database */
  114689. int nRes; /* Bytes of reserved space at the end of each page */
  114690. int nDb; /* Number of attached databases */
  114691. const char *zDbMain; /* Schema name of database to vacuum */
  114692. if( !db->autoCommit ){
  114693. sqlite3SetString(pzErrMsg, db, "cannot VACUUM from within a transaction");
  114694. return SQLITE_ERROR;
  114695. }
  114696. if( db->nVdbeActive>1 ){
  114697. sqlite3SetString(pzErrMsg, db,"cannot VACUUM - SQL statements in progress");
  114698. return SQLITE_ERROR;
  114699. }
  114700. /* Save the current value of the database flags so that it can be
  114701. ** restored before returning. Then set the writable-schema flag, and
  114702. ** disable CHECK and foreign key constraints. */
  114703. saved_flags = db->flags;
  114704. saved_nChange = db->nChange;
  114705. saved_nTotalChange = db->nTotalChange;
  114706. saved_mTrace = db->mTrace;
  114707. db->flags |= (SQLITE_WriteSchema | SQLITE_IgnoreChecks
  114708. | SQLITE_PreferBuiltin | SQLITE_Vacuum);
  114709. db->flags &= ~(SQLITE_ForeignKeys | SQLITE_ReverseOrder | SQLITE_CountRows);
  114710. db->mTrace = 0;
  114711. zDbMain = db->aDb[iDb].zDbSName;
  114712. pMain = db->aDb[iDb].pBt;
  114713. isMemDb = sqlite3PagerIsMemdb(sqlite3BtreePager(pMain));
  114714. /* Attach the temporary database as 'vacuum_db'. The synchronous pragma
  114715. ** can be set to 'off' for this file, as it is not recovered if a crash
  114716. ** occurs anyway. The integrity of the database is maintained by a
  114717. ** (possibly synchronous) transaction opened on the main database before
  114718. ** sqlite3BtreeCopyFile() is called.
  114719. **
  114720. ** An optimisation would be to use a non-journaled pager.
  114721. ** (Later:) I tried setting "PRAGMA vacuum_db.journal_mode=OFF" but
  114722. ** that actually made the VACUUM run slower. Very little journalling
  114723. ** actually occurs when doing a vacuum since the vacuum_db is initially
  114724. ** empty. Only the journal header is written. Apparently it takes more
  114725. ** time to parse and run the PRAGMA to turn journalling off than it does
  114726. ** to write the journal header file.
  114727. */
  114728. nDb = db->nDb;
  114729. rc = execSql(db, pzErrMsg, "ATTACH''AS vacuum_db");
  114730. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114731. assert( (db->nDb-1)==nDb );
  114732. pDb = &db->aDb[nDb];
  114733. assert( strcmp(pDb->zDbSName,"vacuum_db")==0 );
  114734. pTemp = pDb->pBt;
  114735. /* The call to execSql() to attach the temp database has left the file
  114736. ** locked (as there was more than one active statement when the transaction
  114737. ** to read the schema was concluded. Unlock it here so that this doesn't
  114738. ** cause problems for the call to BtreeSetPageSize() below. */
  114739. sqlite3BtreeCommit(pTemp);
  114740. nRes = sqlite3BtreeGetOptimalReserve(pMain);
  114741. /* A VACUUM cannot change the pagesize of an encrypted database. */
  114742. #ifdef SQLITE_HAS_CODEC
  114743. if( db->nextPagesize ){
  114744. extern void sqlite3CodecGetKey(sqlite3*, int, void**, int*);
  114745. int nKey;
  114746. char *zKey;
  114747. sqlite3CodecGetKey(db, 0, (void**)&zKey, &nKey);
  114748. if( nKey ) db->nextPagesize = 0;
  114749. }
  114750. #endif
  114751. sqlite3BtreeSetCacheSize(pTemp, db->aDb[iDb].pSchema->cache_size);
  114752. sqlite3BtreeSetSpillSize(pTemp, sqlite3BtreeSetSpillSize(pMain,0));
  114753. sqlite3BtreeSetPagerFlags(pTemp, PAGER_SYNCHRONOUS_OFF|PAGER_CACHESPILL);
  114754. /* Begin a transaction and take an exclusive lock on the main database
  114755. ** file. This is done before the sqlite3BtreeGetPageSize(pMain) call below,
  114756. ** to ensure that we do not try to change the page-size on a WAL database.
  114757. */
  114758. rc = execSql(db, pzErrMsg, "BEGIN");
  114759. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114760. rc = sqlite3BtreeBeginTrans(pMain, 2);
  114761. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114762. /* Do not attempt to change the page size for a WAL database */
  114763. if( sqlite3PagerGetJournalMode(sqlite3BtreePager(pMain))
  114764. ==PAGER_JOURNALMODE_WAL ){
  114765. db->nextPagesize = 0;
  114766. }
  114767. if( sqlite3BtreeSetPageSize(pTemp, sqlite3BtreeGetPageSize(pMain), nRes, 0)
  114768. || (!isMemDb && sqlite3BtreeSetPageSize(pTemp, db->nextPagesize, nRes, 0))
  114769. || NEVER(db->mallocFailed)
  114770. ){
  114771. rc = SQLITE_NOMEM_BKPT;
  114772. goto end_of_vacuum;
  114773. }
  114774. #ifndef SQLITE_OMIT_AUTOVACUUM
  114775. sqlite3BtreeSetAutoVacuum(pTemp, db->nextAutovac>=0 ? db->nextAutovac :
  114776. sqlite3BtreeGetAutoVacuum(pMain));
  114777. #endif
  114778. /* Query the schema of the main database. Create a mirror schema
  114779. ** in the temporary database.
  114780. */
  114781. db->init.iDb = nDb; /* force new CREATE statements into vacuum_db */
  114782. rc = execSqlF(db, pzErrMsg,
  114783. "SELECT sql FROM \"%w\".sqlite_master"
  114784. " WHERE type='table'AND name<>'sqlite_sequence'"
  114785. " AND coalesce(rootpage,1)>0",
  114786. zDbMain
  114787. );
  114788. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114789. rc = execSqlF(db, pzErrMsg,
  114790. "SELECT sql FROM \"%w\".sqlite_master"
  114791. " WHERE type='index' AND length(sql)>10",
  114792. zDbMain
  114793. );
  114794. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114795. db->init.iDb = 0;
  114796. /* Loop through the tables in the main database. For each, do
  114797. ** an "INSERT INTO vacuum_db.xxx SELECT * FROM main.xxx;" to copy
  114798. ** the contents to the temporary database.
  114799. */
  114800. rc = execSqlF(db, pzErrMsg,
  114801. "SELECT'INSERT INTO vacuum_db.'||quote(name)"
  114802. "||' SELECT*FROM\"%w\".'||quote(name)"
  114803. "FROM vacuum_db.sqlite_master "
  114804. "WHERE type='table'AND coalesce(rootpage,1)>0",
  114805. zDbMain
  114806. );
  114807. assert( (db->flags & SQLITE_Vacuum)!=0 );
  114808. db->flags &= ~SQLITE_Vacuum;
  114809. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114810. /* Copy the triggers, views, and virtual tables from the main database
  114811. ** over to the temporary database. None of these objects has any
  114812. ** associated storage, so all we have to do is copy their entries
  114813. ** from the SQLITE_MASTER table.
  114814. */
  114815. rc = execSqlF(db, pzErrMsg,
  114816. "INSERT INTO vacuum_db.sqlite_master"
  114817. " SELECT*FROM \"%w\".sqlite_master"
  114818. " WHERE type IN('view','trigger')"
  114819. " OR(type='table'AND rootpage=0)",
  114820. zDbMain
  114821. );
  114822. if( rc ) goto end_of_vacuum;
  114823. /* At this point, there is a write transaction open on both the
  114824. ** vacuum database and the main database. Assuming no error occurs,
  114825. ** both transactions are closed by this block - the main database
  114826. ** transaction by sqlite3BtreeCopyFile() and the other by an explicit
  114827. ** call to sqlite3BtreeCommit().
  114828. */
  114829. {
  114830. u32 meta;
  114831. int i;
  114832. /* This array determines which meta meta values are preserved in the
  114833. ** vacuum. Even entries are the meta value number and odd entries
  114834. ** are an increment to apply to the meta value after the vacuum.
  114835. ** The increment is used to increase the schema cookie so that other
  114836. ** connections to the same database will know to reread the schema.
  114837. */
  114838. static const unsigned char aCopy[] = {
  114839. BTREE_SCHEMA_VERSION, 1, /* Add one to the old schema cookie */
  114840. BTREE_DEFAULT_CACHE_SIZE, 0, /* Preserve the default page cache size */
  114841. BTREE_TEXT_ENCODING, 0, /* Preserve the text encoding */
  114842. BTREE_USER_VERSION, 0, /* Preserve the user version */
  114843. BTREE_APPLICATION_ID, 0, /* Preserve the application id */
  114844. };
  114845. assert( 1==sqlite3BtreeIsInTrans(pTemp) );
  114846. assert( 1==sqlite3BtreeIsInTrans(pMain) );
  114847. /* Copy Btree meta values */
  114848. for(i=0; i<ArraySize(aCopy); i+=2){
  114849. /* GetMeta() and UpdateMeta() cannot fail in this context because
  114850. ** we already have page 1 loaded into cache and marked dirty. */
  114851. sqlite3BtreeGetMeta(pMain, aCopy[i], &meta);
  114852. rc = sqlite3BtreeUpdateMeta(pTemp, aCopy[i], meta+aCopy[i+1]);
  114853. if( NEVER(rc!=SQLITE_OK) ) goto end_of_vacuum;
  114854. }
  114855. rc = sqlite3BtreeCopyFile(pMain, pTemp);
  114856. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114857. rc = sqlite3BtreeCommit(pTemp);
  114858. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  114859. #ifndef SQLITE_OMIT_AUTOVACUUM
  114860. sqlite3BtreeSetAutoVacuum(pMain, sqlite3BtreeGetAutoVacuum(pTemp));
  114861. #endif
  114862. }
  114863. assert( rc==SQLITE_OK );
  114864. rc = sqlite3BtreeSetPageSize(pMain, sqlite3BtreeGetPageSize(pTemp), nRes,1);
  114865. end_of_vacuum:
  114866. /* Restore the original value of db->flags */
  114867. db->init.iDb = 0;
  114868. db->flags = saved_flags;
  114869. db->nChange = saved_nChange;
  114870. db->nTotalChange = saved_nTotalChange;
  114871. db->mTrace = saved_mTrace;
  114872. sqlite3BtreeSetPageSize(pMain, -1, -1, 1);
  114873. /* Currently there is an SQL level transaction open on the vacuum
  114874. ** database. No locks are held on any other files (since the main file
  114875. ** was committed at the btree level). So it safe to end the transaction
  114876. ** by manually setting the autoCommit flag to true and detaching the
  114877. ** vacuum database. The vacuum_db journal file is deleted when the pager
  114878. ** is closed by the DETACH.
  114879. */
  114880. db->autoCommit = 1;
  114881. if( pDb ){
  114882. sqlite3BtreeClose(pDb->pBt);
  114883. pDb->pBt = 0;
  114884. pDb->pSchema = 0;
  114885. }
  114886. /* This both clears the schemas and reduces the size of the db->aDb[]
  114887. ** array. */
  114888. sqlite3ResetAllSchemasOfConnection(db);
  114889. return rc;
  114890. }
  114891. #endif /* SQLITE_OMIT_VACUUM && SQLITE_OMIT_ATTACH */
  114892. /************** End of vacuum.c **********************************************/
  114893. /************** Begin file vtab.c ********************************************/
  114894. /*
  114895. ** 2006 June 10
  114896. **
  114897. ** The author disclaims copyright to this source code. In place of
  114898. ** a legal notice, here is a blessing:
  114899. **
  114900. ** May you do good and not evil.
  114901. ** May you find forgiveness for yourself and forgive others.
  114902. ** May you share freely, never taking more than you give.
  114903. **
  114904. *************************************************************************
  114905. ** This file contains code used to help implement virtual tables.
  114906. */
  114907. #ifndef SQLITE_OMIT_VIRTUALTABLE
  114908. /* #include "sqliteInt.h" */
  114909. /*
  114910. ** Before a virtual table xCreate() or xConnect() method is invoked, the
  114911. ** sqlite3.pVtabCtx member variable is set to point to an instance of
  114912. ** this struct allocated on the stack. It is used by the implementation of
  114913. ** the sqlite3_declare_vtab() and sqlite3_vtab_config() APIs, both of which
  114914. ** are invoked only from within xCreate and xConnect methods.
  114915. */
  114916. struct VtabCtx {
  114917. VTable *pVTable; /* The virtual table being constructed */
  114918. Table *pTab; /* The Table object to which the virtual table belongs */
  114919. VtabCtx *pPrior; /* Parent context (if any) */
  114920. int bDeclared; /* True after sqlite3_declare_vtab() is called */
  114921. };
  114922. /*
  114923. ** The actual function that does the work of creating a new module.
  114924. ** This function implements the sqlite3_create_module() and
  114925. ** sqlite3_create_module_v2() interfaces.
  114926. */
  114927. static int createModule(
  114928. sqlite3 *db, /* Database in which module is registered */
  114929. const char *zName, /* Name assigned to this module */
  114930. const sqlite3_module *pModule, /* The definition of the module */
  114931. void *pAux, /* Context pointer for xCreate/xConnect */
  114932. void (*xDestroy)(void *) /* Module destructor function */
  114933. ){
  114934. int rc = SQLITE_OK;
  114935. int nName;
  114936. sqlite3_mutex_enter(db->mutex);
  114937. nName = sqlite3Strlen30(zName);
  114938. if( sqlite3HashFind(&db->aModule, zName) ){
  114939. rc = SQLITE_MISUSE_BKPT;
  114940. }else{
  114941. Module *pMod;
  114942. pMod = (Module *)sqlite3DbMallocRawNN(db, sizeof(Module) + nName + 1);
  114943. if( pMod ){
  114944. Module *pDel;
  114945. char *zCopy = (char *)(&pMod[1]);
  114946. memcpy(zCopy, zName, nName+1);
  114947. pMod->zName = zCopy;
  114948. pMod->pModule = pModule;
  114949. pMod->pAux = pAux;
  114950. pMod->xDestroy = xDestroy;
  114951. pMod->pEpoTab = 0;
  114952. pDel = (Module *)sqlite3HashInsert(&db->aModule,zCopy,(void*)pMod);
  114953. assert( pDel==0 || pDel==pMod );
  114954. if( pDel ){
  114955. sqlite3OomFault(db);
  114956. sqlite3DbFree(db, pDel);
  114957. }
  114958. }
  114959. }
  114960. rc = sqlite3ApiExit(db, rc);
  114961. if( rc!=SQLITE_OK && xDestroy ) xDestroy(pAux);
  114962. sqlite3_mutex_leave(db->mutex);
  114963. return rc;
  114964. }
  114965. /*
  114966. ** External API function used to create a new virtual-table module.
  114967. */
  114968. SQLITE_API int sqlite3_create_module(
  114969. sqlite3 *db, /* Database in which module is registered */
  114970. const char *zName, /* Name assigned to this module */
  114971. const sqlite3_module *pModule, /* The definition of the module */
  114972. void *pAux /* Context pointer for xCreate/xConnect */
  114973. ){
  114974. #ifdef SQLITE_ENABLE_API_ARMOR
  114975. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  114976. #endif
  114977. return createModule(db, zName, pModule, pAux, 0);
  114978. }
  114979. /*
  114980. ** External API function used to create a new virtual-table module.
  114981. */
  114982. SQLITE_API int sqlite3_create_module_v2(
  114983. sqlite3 *db, /* Database in which module is registered */
  114984. const char *zName, /* Name assigned to this module */
  114985. const sqlite3_module *pModule, /* The definition of the module */
  114986. void *pAux, /* Context pointer for xCreate/xConnect */
  114987. void (*xDestroy)(void *) /* Module destructor function */
  114988. ){
  114989. #ifdef SQLITE_ENABLE_API_ARMOR
  114990. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  114991. #endif
  114992. return createModule(db, zName, pModule, pAux, xDestroy);
  114993. }
  114994. /*
  114995. ** Lock the virtual table so that it cannot be disconnected.
  114996. ** Locks nest. Every lock should have a corresponding unlock.
  114997. ** If an unlock is omitted, resources leaks will occur.
  114998. **
  114999. ** If a disconnect is attempted while a virtual table is locked,
  115000. ** the disconnect is deferred until all locks have been removed.
  115001. */
  115002. SQLITE_PRIVATE void sqlite3VtabLock(VTable *pVTab){
  115003. pVTab->nRef++;
  115004. }
  115005. /*
  115006. ** pTab is a pointer to a Table structure representing a virtual-table.
  115007. ** Return a pointer to the VTable object used by connection db to access
  115008. ** this virtual-table, if one has been created, or NULL otherwise.
  115009. */
  115010. SQLITE_PRIVATE VTable *sqlite3GetVTable(sqlite3 *db, Table *pTab){
  115011. VTable *pVtab;
  115012. assert( IsVirtual(pTab) );
  115013. for(pVtab=pTab->pVTable; pVtab && pVtab->db!=db; pVtab=pVtab->pNext);
  115014. return pVtab;
  115015. }
  115016. /*
  115017. ** Decrement the ref-count on a virtual table object. When the ref-count
  115018. ** reaches zero, call the xDisconnect() method to delete the object.
  115019. */
  115020. SQLITE_PRIVATE void sqlite3VtabUnlock(VTable *pVTab){
  115021. sqlite3 *db = pVTab->db;
  115022. assert( db );
  115023. assert( pVTab->nRef>0 );
  115024. assert( db->magic==SQLITE_MAGIC_OPEN || db->magic==SQLITE_MAGIC_ZOMBIE );
  115025. pVTab->nRef--;
  115026. if( pVTab->nRef==0 ){
  115027. sqlite3_vtab *p = pVTab->pVtab;
  115028. if( p ){
  115029. p->pModule->xDisconnect(p);
  115030. }
  115031. sqlite3DbFree(db, pVTab);
  115032. }
  115033. }
  115034. /*
  115035. ** Table p is a virtual table. This function moves all elements in the
  115036. ** p->pVTable list to the sqlite3.pDisconnect lists of their associated
  115037. ** database connections to be disconnected at the next opportunity.
  115038. ** Except, if argument db is not NULL, then the entry associated with
  115039. ** connection db is left in the p->pVTable list.
  115040. */
  115041. static VTable *vtabDisconnectAll(sqlite3 *db, Table *p){
  115042. VTable *pRet = 0;
  115043. VTable *pVTable = p->pVTable;
  115044. p->pVTable = 0;
  115045. /* Assert that the mutex (if any) associated with the BtShared database
  115046. ** that contains table p is held by the caller. See header comments
  115047. ** above function sqlite3VtabUnlockList() for an explanation of why
  115048. ** this makes it safe to access the sqlite3.pDisconnect list of any
  115049. ** database connection that may have an entry in the p->pVTable list.
  115050. */
  115051. assert( db==0 || sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
  115052. while( pVTable ){
  115053. sqlite3 *db2 = pVTable->db;
  115054. VTable *pNext = pVTable->pNext;
  115055. assert( db2 );
  115056. if( db2==db ){
  115057. pRet = pVTable;
  115058. p->pVTable = pRet;
  115059. pRet->pNext = 0;
  115060. }else{
  115061. pVTable->pNext = db2->pDisconnect;
  115062. db2->pDisconnect = pVTable;
  115063. }
  115064. pVTable = pNext;
  115065. }
  115066. assert( !db || pRet );
  115067. return pRet;
  115068. }
  115069. /*
  115070. ** Table *p is a virtual table. This function removes the VTable object
  115071. ** for table *p associated with database connection db from the linked
  115072. ** list in p->pVTab. It also decrements the VTable ref count. This is
  115073. ** used when closing database connection db to free all of its VTable
  115074. ** objects without disturbing the rest of the Schema object (which may
  115075. ** be being used by other shared-cache connections).
  115076. */
  115077. SQLITE_PRIVATE void sqlite3VtabDisconnect(sqlite3 *db, Table *p){
  115078. VTable **ppVTab;
  115079. assert( IsVirtual(p) );
  115080. assert( sqlite3BtreeHoldsAllMutexes(db) );
  115081. assert( sqlite3_mutex_held(db->mutex) );
  115082. for(ppVTab=&p->pVTable; *ppVTab; ppVTab=&(*ppVTab)->pNext){
  115083. if( (*ppVTab)->db==db ){
  115084. VTable *pVTab = *ppVTab;
  115085. *ppVTab = pVTab->pNext;
  115086. sqlite3VtabUnlock(pVTab);
  115087. break;
  115088. }
  115089. }
  115090. }
  115091. /*
  115092. ** Disconnect all the virtual table objects in the sqlite3.pDisconnect list.
  115093. **
  115094. ** This function may only be called when the mutexes associated with all
  115095. ** shared b-tree databases opened using connection db are held by the
  115096. ** caller. This is done to protect the sqlite3.pDisconnect list. The
  115097. ** sqlite3.pDisconnect list is accessed only as follows:
  115098. **
  115099. ** 1) By this function. In this case, all BtShared mutexes and the mutex
  115100. ** associated with the database handle itself must be held.
  115101. **
  115102. ** 2) By function vtabDisconnectAll(), when it adds a VTable entry to
  115103. ** the sqlite3.pDisconnect list. In this case either the BtShared mutex
  115104. ** associated with the database the virtual table is stored in is held
  115105. ** or, if the virtual table is stored in a non-sharable database, then
  115106. ** the database handle mutex is held.
  115107. **
  115108. ** As a result, a sqlite3.pDisconnect cannot be accessed simultaneously
  115109. ** by multiple threads. It is thread-safe.
  115110. */
  115111. SQLITE_PRIVATE void sqlite3VtabUnlockList(sqlite3 *db){
  115112. VTable *p = db->pDisconnect;
  115113. db->pDisconnect = 0;
  115114. assert( sqlite3BtreeHoldsAllMutexes(db) );
  115115. assert( sqlite3_mutex_held(db->mutex) );
  115116. if( p ){
  115117. sqlite3ExpirePreparedStatements(db);
  115118. do {
  115119. VTable *pNext = p->pNext;
  115120. sqlite3VtabUnlock(p);
  115121. p = pNext;
  115122. }while( p );
  115123. }
  115124. }
  115125. /*
  115126. ** Clear any and all virtual-table information from the Table record.
  115127. ** This routine is called, for example, just before deleting the Table
  115128. ** record.
  115129. **
  115130. ** Since it is a virtual-table, the Table structure contains a pointer
  115131. ** to the head of a linked list of VTable structures. Each VTable
  115132. ** structure is associated with a single sqlite3* user of the schema.
  115133. ** The reference count of the VTable structure associated with database
  115134. ** connection db is decremented immediately (which may lead to the
  115135. ** structure being xDisconnected and free). Any other VTable structures
  115136. ** in the list are moved to the sqlite3.pDisconnect list of the associated
  115137. ** database connection.
  115138. */
  115139. SQLITE_PRIVATE void sqlite3VtabClear(sqlite3 *db, Table *p){
  115140. if( !db || db->pnBytesFreed==0 ) vtabDisconnectAll(0, p);
  115141. if( p->azModuleArg ){
  115142. int i;
  115143. for(i=0; i<p->nModuleArg; i++){
  115144. if( i!=1 ) sqlite3DbFree(db, p->azModuleArg[i]);
  115145. }
  115146. sqlite3DbFree(db, p->azModuleArg);
  115147. }
  115148. }
  115149. /*
  115150. ** Add a new module argument to pTable->azModuleArg[].
  115151. ** The string is not copied - the pointer is stored. The
  115152. ** string will be freed automatically when the table is
  115153. ** deleted.
  115154. */
  115155. static void addModuleArgument(sqlite3 *db, Table *pTable, char *zArg){
  115156. int nBytes = sizeof(char *)*(2+pTable->nModuleArg);
  115157. char **azModuleArg;
  115158. azModuleArg = sqlite3DbRealloc(db, pTable->azModuleArg, nBytes);
  115159. if( azModuleArg==0 ){
  115160. sqlite3DbFree(db, zArg);
  115161. }else{
  115162. int i = pTable->nModuleArg++;
  115163. azModuleArg[i] = zArg;
  115164. azModuleArg[i+1] = 0;
  115165. pTable->azModuleArg = azModuleArg;
  115166. }
  115167. }
  115168. /*
  115169. ** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
  115170. ** statement. The module name has been parsed, but the optional list
  115171. ** of parameters that follow the module name are still pending.
  115172. */
  115173. SQLITE_PRIVATE void sqlite3VtabBeginParse(
  115174. Parse *pParse, /* Parsing context */
  115175. Token *pName1, /* Name of new table, or database name */
  115176. Token *pName2, /* Name of new table or NULL */
  115177. Token *pModuleName, /* Name of the module for the virtual table */
  115178. int ifNotExists /* No error if the table already exists */
  115179. ){
  115180. int iDb; /* The database the table is being created in */
  115181. Table *pTable; /* The new virtual table */
  115182. sqlite3 *db; /* Database connection */
  115183. sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, ifNotExists);
  115184. pTable = pParse->pNewTable;
  115185. if( pTable==0 ) return;
  115186. assert( 0==pTable->pIndex );
  115187. db = pParse->db;
  115188. iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
  115189. assert( iDb>=0 );
  115190. pTable->tabFlags |= TF_Virtual;
  115191. pTable->nModuleArg = 0;
  115192. addModuleArgument(db, pTable, sqlite3NameFromToken(db, pModuleName));
  115193. addModuleArgument(db, pTable, 0);
  115194. addModuleArgument(db, pTable, sqlite3DbStrDup(db, pTable->zName));
  115195. assert( (pParse->sNameToken.z==pName2->z && pName2->z!=0)
  115196. || (pParse->sNameToken.z==pName1->z && pName2->z==0)
  115197. );
  115198. pParse->sNameToken.n = (int)(
  115199. &pModuleName->z[pModuleName->n] - pParse->sNameToken.z
  115200. );
  115201. #ifndef SQLITE_OMIT_AUTHORIZATION
  115202. /* Creating a virtual table invokes the authorization callback twice.
  115203. ** The first invocation, to obtain permission to INSERT a row into the
  115204. ** sqlite_master table, has already been made by sqlite3StartTable().
  115205. ** The second call, to obtain permission to create the table, is made now.
  115206. */
  115207. if( pTable->azModuleArg ){
  115208. sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName,
  115209. pTable->azModuleArg[0], pParse->db->aDb[iDb].zDbSName);
  115210. }
  115211. #endif
  115212. }
  115213. /*
  115214. ** This routine takes the module argument that has been accumulating
  115215. ** in pParse->zArg[] and appends it to the list of arguments on the
  115216. ** virtual table currently under construction in pParse->pTable.
  115217. */
  115218. static void addArgumentToVtab(Parse *pParse){
  115219. if( pParse->sArg.z && pParse->pNewTable ){
  115220. const char *z = (const char*)pParse->sArg.z;
  115221. int n = pParse->sArg.n;
  115222. sqlite3 *db = pParse->db;
  115223. addModuleArgument(db, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
  115224. }
  115225. }
  115226. /*
  115227. ** The parser calls this routine after the CREATE VIRTUAL TABLE statement
  115228. ** has been completely parsed.
  115229. */
  115230. SQLITE_PRIVATE void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
  115231. Table *pTab = pParse->pNewTable; /* The table being constructed */
  115232. sqlite3 *db = pParse->db; /* The database connection */
  115233. if( pTab==0 ) return;
  115234. addArgumentToVtab(pParse);
  115235. pParse->sArg.z = 0;
  115236. if( pTab->nModuleArg<1 ) return;
  115237. /* If the CREATE VIRTUAL TABLE statement is being entered for the
  115238. ** first time (in other words if the virtual table is actually being
  115239. ** created now instead of just being read out of sqlite_master) then
  115240. ** do additional initialization work and store the statement text
  115241. ** in the sqlite_master table.
  115242. */
  115243. if( !db->init.busy ){
  115244. char *zStmt;
  115245. char *zWhere;
  115246. int iDb;
  115247. int iReg;
  115248. Vdbe *v;
  115249. /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
  115250. if( pEnd ){
  115251. pParse->sNameToken.n = (int)(pEnd->z - pParse->sNameToken.z) + pEnd->n;
  115252. }
  115253. zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
  115254. /* A slot for the record has already been allocated in the
  115255. ** SQLITE_MASTER table. We just need to update that slot with all
  115256. ** the information we've collected.
  115257. **
  115258. ** The VM register number pParse->regRowid holds the rowid of an
  115259. ** entry in the sqlite_master table tht was created for this vtab
  115260. ** by sqlite3StartTable().
  115261. */
  115262. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  115263. sqlite3NestedParse(pParse,
  115264. "UPDATE %Q.%s "
  115265. "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
  115266. "WHERE rowid=#%d",
  115267. db->aDb[iDb].zDbSName, SCHEMA_TABLE(iDb),
  115268. pTab->zName,
  115269. pTab->zName,
  115270. zStmt,
  115271. pParse->regRowid
  115272. );
  115273. sqlite3DbFree(db, zStmt);
  115274. v = sqlite3GetVdbe(pParse);
  115275. sqlite3ChangeCookie(pParse, iDb);
  115276. sqlite3VdbeAddOp0(v, OP_Expire);
  115277. zWhere = sqlite3MPrintf(db, "name='%q' AND type='table'", pTab->zName);
  115278. sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere);
  115279. iReg = ++pParse->nMem;
  115280. sqlite3VdbeLoadString(v, iReg, pTab->zName);
  115281. sqlite3VdbeAddOp2(v, OP_VCreate, iDb, iReg);
  115282. }
  115283. /* If we are rereading the sqlite_master table create the in-memory
  115284. ** record of the table. The xConnect() method is not called until
  115285. ** the first time the virtual table is used in an SQL statement. This
  115286. ** allows a schema that contains virtual tables to be loaded before
  115287. ** the required virtual table implementations are registered. */
  115288. else {
  115289. Table *pOld;
  115290. Schema *pSchema = pTab->pSchema;
  115291. const char *zName = pTab->zName;
  115292. assert( sqlite3SchemaMutexHeld(db, 0, pSchema) );
  115293. pOld = sqlite3HashInsert(&pSchema->tblHash, zName, pTab);
  115294. if( pOld ){
  115295. sqlite3OomFault(db);
  115296. assert( pTab==pOld ); /* Malloc must have failed inside HashInsert() */
  115297. return;
  115298. }
  115299. pParse->pNewTable = 0;
  115300. }
  115301. }
  115302. /*
  115303. ** The parser calls this routine when it sees the first token
  115304. ** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
  115305. */
  115306. SQLITE_PRIVATE void sqlite3VtabArgInit(Parse *pParse){
  115307. addArgumentToVtab(pParse);
  115308. pParse->sArg.z = 0;
  115309. pParse->sArg.n = 0;
  115310. }
  115311. /*
  115312. ** The parser calls this routine for each token after the first token
  115313. ** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
  115314. */
  115315. SQLITE_PRIVATE void sqlite3VtabArgExtend(Parse *pParse, Token *p){
  115316. Token *pArg = &pParse->sArg;
  115317. if( pArg->z==0 ){
  115318. pArg->z = p->z;
  115319. pArg->n = p->n;
  115320. }else{
  115321. assert(pArg->z <= p->z);
  115322. pArg->n = (int)(&p->z[p->n] - pArg->z);
  115323. }
  115324. }
  115325. /*
  115326. ** Invoke a virtual table constructor (either xCreate or xConnect). The
  115327. ** pointer to the function to invoke is passed as the fourth parameter
  115328. ** to this procedure.
  115329. */
  115330. static int vtabCallConstructor(
  115331. sqlite3 *db,
  115332. Table *pTab,
  115333. Module *pMod,
  115334. int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
  115335. char **pzErr
  115336. ){
  115337. VtabCtx sCtx;
  115338. VTable *pVTable;
  115339. int rc;
  115340. const char *const*azArg = (const char *const*)pTab->azModuleArg;
  115341. int nArg = pTab->nModuleArg;
  115342. char *zErr = 0;
  115343. char *zModuleName;
  115344. int iDb;
  115345. VtabCtx *pCtx;
  115346. /* Check that the virtual-table is not already being initialized */
  115347. for(pCtx=db->pVtabCtx; pCtx; pCtx=pCtx->pPrior){
  115348. if( pCtx->pTab==pTab ){
  115349. *pzErr = sqlite3MPrintf(db,
  115350. "vtable constructor called recursively: %s", pTab->zName
  115351. );
  115352. return SQLITE_LOCKED;
  115353. }
  115354. }
  115355. zModuleName = sqlite3MPrintf(db, "%s", pTab->zName);
  115356. if( !zModuleName ){
  115357. return SQLITE_NOMEM_BKPT;
  115358. }
  115359. pVTable = sqlite3DbMallocZero(db, sizeof(VTable));
  115360. if( !pVTable ){
  115361. sqlite3DbFree(db, zModuleName);
  115362. return SQLITE_NOMEM_BKPT;
  115363. }
  115364. pVTable->db = db;
  115365. pVTable->pMod = pMod;
  115366. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  115367. pTab->azModuleArg[1] = db->aDb[iDb].zDbSName;
  115368. /* Invoke the virtual table constructor */
  115369. assert( &db->pVtabCtx );
  115370. assert( xConstruct );
  115371. sCtx.pTab = pTab;
  115372. sCtx.pVTable = pVTable;
  115373. sCtx.pPrior = db->pVtabCtx;
  115374. sCtx.bDeclared = 0;
  115375. db->pVtabCtx = &sCtx;
  115376. rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVTable->pVtab, &zErr);
  115377. db->pVtabCtx = sCtx.pPrior;
  115378. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  115379. assert( sCtx.pTab==pTab );
  115380. if( SQLITE_OK!=rc ){
  115381. if( zErr==0 ){
  115382. *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
  115383. }else {
  115384. *pzErr = sqlite3MPrintf(db, "%s", zErr);
  115385. sqlite3_free(zErr);
  115386. }
  115387. sqlite3DbFree(db, pVTable);
  115388. }else if( ALWAYS(pVTable->pVtab) ){
  115389. /* Justification of ALWAYS(): A correct vtab constructor must allocate
  115390. ** the sqlite3_vtab object if successful. */
  115391. memset(pVTable->pVtab, 0, sizeof(pVTable->pVtab[0]));
  115392. pVTable->pVtab->pModule = pMod->pModule;
  115393. pVTable->nRef = 1;
  115394. if( sCtx.bDeclared==0 ){
  115395. const char *zFormat = "vtable constructor did not declare schema: %s";
  115396. *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
  115397. sqlite3VtabUnlock(pVTable);
  115398. rc = SQLITE_ERROR;
  115399. }else{
  115400. int iCol;
  115401. u8 oooHidden = 0;
  115402. /* If everything went according to plan, link the new VTable structure
  115403. ** into the linked list headed by pTab->pVTable. Then loop through the
  115404. ** columns of the table to see if any of them contain the token "hidden".
  115405. ** If so, set the Column COLFLAG_HIDDEN flag and remove the token from
  115406. ** the type string. */
  115407. pVTable->pNext = pTab->pVTable;
  115408. pTab->pVTable = pVTable;
  115409. for(iCol=0; iCol<pTab->nCol; iCol++){
  115410. char *zType = sqlite3ColumnType(&pTab->aCol[iCol], "");
  115411. int nType;
  115412. int i = 0;
  115413. nType = sqlite3Strlen30(zType);
  115414. for(i=0; i<nType; i++){
  115415. if( 0==sqlite3StrNICmp("hidden", &zType[i], 6)
  115416. && (i==0 || zType[i-1]==' ')
  115417. && (zType[i+6]=='\0' || zType[i+6]==' ')
  115418. ){
  115419. break;
  115420. }
  115421. }
  115422. if( i<nType ){
  115423. int j;
  115424. int nDel = 6 + (zType[i+6] ? 1 : 0);
  115425. for(j=i; (j+nDel)<=nType; j++){
  115426. zType[j] = zType[j+nDel];
  115427. }
  115428. if( zType[i]=='\0' && i>0 ){
  115429. assert(zType[i-1]==' ');
  115430. zType[i-1] = '\0';
  115431. }
  115432. pTab->aCol[iCol].colFlags |= COLFLAG_HIDDEN;
  115433. oooHidden = TF_OOOHidden;
  115434. }else{
  115435. pTab->tabFlags |= oooHidden;
  115436. }
  115437. }
  115438. }
  115439. }
  115440. sqlite3DbFree(db, zModuleName);
  115441. return rc;
  115442. }
  115443. /*
  115444. ** This function is invoked by the parser to call the xConnect() method
  115445. ** of the virtual table pTab. If an error occurs, an error code is returned
  115446. ** and an error left in pParse.
  115447. **
  115448. ** This call is a no-op if table pTab is not a virtual table.
  115449. */
  115450. SQLITE_PRIVATE int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
  115451. sqlite3 *db = pParse->db;
  115452. const char *zMod;
  115453. Module *pMod;
  115454. int rc;
  115455. assert( pTab );
  115456. if( (pTab->tabFlags & TF_Virtual)==0 || sqlite3GetVTable(db, pTab) ){
  115457. return SQLITE_OK;
  115458. }
  115459. /* Locate the required virtual table module */
  115460. zMod = pTab->azModuleArg[0];
  115461. pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
  115462. if( !pMod ){
  115463. const char *zModule = pTab->azModuleArg[0];
  115464. sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
  115465. rc = SQLITE_ERROR;
  115466. }else{
  115467. char *zErr = 0;
  115468. rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
  115469. if( rc!=SQLITE_OK ){
  115470. sqlite3ErrorMsg(pParse, "%s", zErr);
  115471. }
  115472. sqlite3DbFree(db, zErr);
  115473. }
  115474. return rc;
  115475. }
  115476. /*
  115477. ** Grow the db->aVTrans[] array so that there is room for at least one
  115478. ** more v-table. Return SQLITE_NOMEM if a malloc fails, or SQLITE_OK otherwise.
  115479. */
  115480. static int growVTrans(sqlite3 *db){
  115481. const int ARRAY_INCR = 5;
  115482. /* Grow the sqlite3.aVTrans array if required */
  115483. if( (db->nVTrans%ARRAY_INCR)==0 ){
  115484. VTable **aVTrans;
  115485. int nBytes = sizeof(sqlite3_vtab *) * (db->nVTrans + ARRAY_INCR);
  115486. aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
  115487. if( !aVTrans ){
  115488. return SQLITE_NOMEM_BKPT;
  115489. }
  115490. memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
  115491. db->aVTrans = aVTrans;
  115492. }
  115493. return SQLITE_OK;
  115494. }
  115495. /*
  115496. ** Add the virtual table pVTab to the array sqlite3.aVTrans[]. Space should
  115497. ** have already been reserved using growVTrans().
  115498. */
  115499. static void addToVTrans(sqlite3 *db, VTable *pVTab){
  115500. /* Add pVtab to the end of sqlite3.aVTrans */
  115501. db->aVTrans[db->nVTrans++] = pVTab;
  115502. sqlite3VtabLock(pVTab);
  115503. }
  115504. /*
  115505. ** This function is invoked by the vdbe to call the xCreate method
  115506. ** of the virtual table named zTab in database iDb.
  115507. **
  115508. ** If an error occurs, *pzErr is set to point to an English language
  115509. ** description of the error and an SQLITE_XXX error code is returned.
  115510. ** In this case the caller must call sqlite3DbFree(db, ) on *pzErr.
  115511. */
  115512. SQLITE_PRIVATE int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
  115513. int rc = SQLITE_OK;
  115514. Table *pTab;
  115515. Module *pMod;
  115516. const char *zMod;
  115517. pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
  115518. assert( pTab && (pTab->tabFlags & TF_Virtual)!=0 && !pTab->pVTable );
  115519. /* Locate the required virtual table module */
  115520. zMod = pTab->azModuleArg[0];
  115521. pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
  115522. /* If the module has been registered and includes a Create method,
  115523. ** invoke it now. If the module has not been registered, return an
  115524. ** error. Otherwise, do nothing.
  115525. */
  115526. if( pMod==0 || pMod->pModule->xCreate==0 || pMod->pModule->xDestroy==0 ){
  115527. *pzErr = sqlite3MPrintf(db, "no such module: %s", zMod);
  115528. rc = SQLITE_ERROR;
  115529. }else{
  115530. rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
  115531. }
  115532. /* Justification of ALWAYS(): The xConstructor method is required to
  115533. ** create a valid sqlite3_vtab if it returns SQLITE_OK. */
  115534. if( rc==SQLITE_OK && ALWAYS(sqlite3GetVTable(db, pTab)) ){
  115535. rc = growVTrans(db);
  115536. if( rc==SQLITE_OK ){
  115537. addToVTrans(db, sqlite3GetVTable(db, pTab));
  115538. }
  115539. }
  115540. return rc;
  115541. }
  115542. /*
  115543. ** This function is used to set the schema of a virtual table. It is only
  115544. ** valid to call this function from within the xCreate() or xConnect() of a
  115545. ** virtual table module.
  115546. */
  115547. SQLITE_API int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
  115548. VtabCtx *pCtx;
  115549. Parse *pParse;
  115550. int rc = SQLITE_OK;
  115551. Table *pTab;
  115552. char *zErr = 0;
  115553. #ifdef SQLITE_ENABLE_API_ARMOR
  115554. if( !sqlite3SafetyCheckOk(db) || zCreateTable==0 ){
  115555. return SQLITE_MISUSE_BKPT;
  115556. }
  115557. #endif
  115558. sqlite3_mutex_enter(db->mutex);
  115559. pCtx = db->pVtabCtx;
  115560. if( !pCtx || pCtx->bDeclared ){
  115561. sqlite3Error(db, SQLITE_MISUSE);
  115562. sqlite3_mutex_leave(db->mutex);
  115563. return SQLITE_MISUSE_BKPT;
  115564. }
  115565. pTab = pCtx->pTab;
  115566. assert( (pTab->tabFlags & TF_Virtual)!=0 );
  115567. pParse = sqlite3StackAllocZero(db, sizeof(*pParse));
  115568. if( pParse==0 ){
  115569. rc = SQLITE_NOMEM_BKPT;
  115570. }else{
  115571. pParse->declareVtab = 1;
  115572. pParse->db = db;
  115573. pParse->nQueryLoop = 1;
  115574. if( SQLITE_OK==sqlite3RunParser(pParse, zCreateTable, &zErr)
  115575. && pParse->pNewTable
  115576. && !db->mallocFailed
  115577. && !pParse->pNewTable->pSelect
  115578. && (pParse->pNewTable->tabFlags & TF_Virtual)==0
  115579. ){
  115580. if( !pTab->aCol ){
  115581. Table *pNew = pParse->pNewTable;
  115582. Index *pIdx;
  115583. pTab->aCol = pNew->aCol;
  115584. pTab->nCol = pNew->nCol;
  115585. pTab->tabFlags |= pNew->tabFlags & (TF_WithoutRowid|TF_NoVisibleRowid);
  115586. pNew->nCol = 0;
  115587. pNew->aCol = 0;
  115588. assert( pTab->pIndex==0 );
  115589. if( !HasRowid(pNew) && pCtx->pVTable->pMod->pModule->xUpdate!=0 ){
  115590. rc = SQLITE_ERROR;
  115591. }
  115592. pIdx = pNew->pIndex;
  115593. if( pIdx ){
  115594. assert( pIdx->pNext==0 );
  115595. pTab->pIndex = pIdx;
  115596. pNew->pIndex = 0;
  115597. pIdx->pTable = pTab;
  115598. }
  115599. }
  115600. pCtx->bDeclared = 1;
  115601. }else{
  115602. sqlite3ErrorWithMsg(db, SQLITE_ERROR, (zErr ? "%s" : 0), zErr);
  115603. sqlite3DbFree(db, zErr);
  115604. rc = SQLITE_ERROR;
  115605. }
  115606. pParse->declareVtab = 0;
  115607. if( pParse->pVdbe ){
  115608. sqlite3VdbeFinalize(pParse->pVdbe);
  115609. }
  115610. sqlite3DeleteTable(db, pParse->pNewTable);
  115611. sqlite3ParserReset(pParse);
  115612. sqlite3StackFree(db, pParse);
  115613. }
  115614. assert( (rc&0xff)==rc );
  115615. rc = sqlite3ApiExit(db, rc);
  115616. sqlite3_mutex_leave(db->mutex);
  115617. return rc;
  115618. }
  115619. /*
  115620. ** This function is invoked by the vdbe to call the xDestroy method
  115621. ** of the virtual table named zTab in database iDb. This occurs
  115622. ** when a DROP TABLE is mentioned.
  115623. **
  115624. ** This call is a no-op if zTab is not a virtual table.
  115625. */
  115626. SQLITE_PRIVATE int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab){
  115627. int rc = SQLITE_OK;
  115628. Table *pTab;
  115629. pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
  115630. if( pTab!=0 && ALWAYS(pTab->pVTable!=0) ){
  115631. VTable *p;
  115632. int (*xDestroy)(sqlite3_vtab *);
  115633. for(p=pTab->pVTable; p; p=p->pNext){
  115634. assert( p->pVtab );
  115635. if( p->pVtab->nRef>0 ){
  115636. return SQLITE_LOCKED;
  115637. }
  115638. }
  115639. p = vtabDisconnectAll(db, pTab);
  115640. xDestroy = p->pMod->pModule->xDestroy;
  115641. assert( xDestroy!=0 ); /* Checked before the virtual table is created */
  115642. rc = xDestroy(p->pVtab);
  115643. /* Remove the sqlite3_vtab* from the aVTrans[] array, if applicable */
  115644. if( rc==SQLITE_OK ){
  115645. assert( pTab->pVTable==p && p->pNext==0 );
  115646. p->pVtab = 0;
  115647. pTab->pVTable = 0;
  115648. sqlite3VtabUnlock(p);
  115649. }
  115650. }
  115651. return rc;
  115652. }
  115653. /*
  115654. ** This function invokes either the xRollback or xCommit method
  115655. ** of each of the virtual tables in the sqlite3.aVTrans array. The method
  115656. ** called is identified by the second argument, "offset", which is
  115657. ** the offset of the method to call in the sqlite3_module structure.
  115658. **
  115659. ** The array is cleared after invoking the callbacks.
  115660. */
  115661. static void callFinaliser(sqlite3 *db, int offset){
  115662. int i;
  115663. if( db->aVTrans ){
  115664. VTable **aVTrans = db->aVTrans;
  115665. db->aVTrans = 0;
  115666. for(i=0; i<db->nVTrans; i++){
  115667. VTable *pVTab = aVTrans[i];
  115668. sqlite3_vtab *p = pVTab->pVtab;
  115669. if( p ){
  115670. int (*x)(sqlite3_vtab *);
  115671. x = *(int (**)(sqlite3_vtab *))((char *)p->pModule + offset);
  115672. if( x ) x(p);
  115673. }
  115674. pVTab->iSavepoint = 0;
  115675. sqlite3VtabUnlock(pVTab);
  115676. }
  115677. sqlite3DbFree(db, aVTrans);
  115678. db->nVTrans = 0;
  115679. }
  115680. }
  115681. /*
  115682. ** Invoke the xSync method of all virtual tables in the sqlite3.aVTrans
  115683. ** array. Return the error code for the first error that occurs, or
  115684. ** SQLITE_OK if all xSync operations are successful.
  115685. **
  115686. ** If an error message is available, leave it in p->zErrMsg.
  115687. */
  115688. SQLITE_PRIVATE int sqlite3VtabSync(sqlite3 *db, Vdbe *p){
  115689. int i;
  115690. int rc = SQLITE_OK;
  115691. VTable **aVTrans = db->aVTrans;
  115692. db->aVTrans = 0;
  115693. for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
  115694. int (*x)(sqlite3_vtab *);
  115695. sqlite3_vtab *pVtab = aVTrans[i]->pVtab;
  115696. if( pVtab && (x = pVtab->pModule->xSync)!=0 ){
  115697. rc = x(pVtab);
  115698. sqlite3VtabImportErrmsg(p, pVtab);
  115699. }
  115700. }
  115701. db->aVTrans = aVTrans;
  115702. return rc;
  115703. }
  115704. /*
  115705. ** Invoke the xRollback method of all virtual tables in the
  115706. ** sqlite3.aVTrans array. Then clear the array itself.
  115707. */
  115708. SQLITE_PRIVATE int sqlite3VtabRollback(sqlite3 *db){
  115709. callFinaliser(db, offsetof(sqlite3_module,xRollback));
  115710. return SQLITE_OK;
  115711. }
  115712. /*
  115713. ** Invoke the xCommit method of all virtual tables in the
  115714. ** sqlite3.aVTrans array. Then clear the array itself.
  115715. */
  115716. SQLITE_PRIVATE int sqlite3VtabCommit(sqlite3 *db){
  115717. callFinaliser(db, offsetof(sqlite3_module,xCommit));
  115718. return SQLITE_OK;
  115719. }
  115720. /*
  115721. ** If the virtual table pVtab supports the transaction interface
  115722. ** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
  115723. ** not currently open, invoke the xBegin method now.
  115724. **
  115725. ** If the xBegin call is successful, place the sqlite3_vtab pointer
  115726. ** in the sqlite3.aVTrans array.
  115727. */
  115728. SQLITE_PRIVATE int sqlite3VtabBegin(sqlite3 *db, VTable *pVTab){
  115729. int rc = SQLITE_OK;
  115730. const sqlite3_module *pModule;
  115731. /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
  115732. ** than zero, then this function is being called from within a
  115733. ** virtual module xSync() callback. It is illegal to write to
  115734. ** virtual module tables in this case, so return SQLITE_LOCKED.
  115735. */
  115736. if( sqlite3VtabInSync(db) ){
  115737. return SQLITE_LOCKED;
  115738. }
  115739. if( !pVTab ){
  115740. return SQLITE_OK;
  115741. }
  115742. pModule = pVTab->pVtab->pModule;
  115743. if( pModule->xBegin ){
  115744. int i;
  115745. /* If pVtab is already in the aVTrans array, return early */
  115746. for(i=0; i<db->nVTrans; i++){
  115747. if( db->aVTrans[i]==pVTab ){
  115748. return SQLITE_OK;
  115749. }
  115750. }
  115751. /* Invoke the xBegin method. If successful, add the vtab to the
  115752. ** sqlite3.aVTrans[] array. */
  115753. rc = growVTrans(db);
  115754. if( rc==SQLITE_OK ){
  115755. rc = pModule->xBegin(pVTab->pVtab);
  115756. if( rc==SQLITE_OK ){
  115757. int iSvpt = db->nStatement + db->nSavepoint;
  115758. addToVTrans(db, pVTab);
  115759. if( iSvpt && pModule->xSavepoint ){
  115760. pVTab->iSavepoint = iSvpt;
  115761. rc = pModule->xSavepoint(pVTab->pVtab, iSvpt-1);
  115762. }
  115763. }
  115764. }
  115765. }
  115766. return rc;
  115767. }
  115768. /*
  115769. ** Invoke either the xSavepoint, xRollbackTo or xRelease method of all
  115770. ** virtual tables that currently have an open transaction. Pass iSavepoint
  115771. ** as the second argument to the virtual table method invoked.
  115772. **
  115773. ** If op is SAVEPOINT_BEGIN, the xSavepoint method is invoked. If it is
  115774. ** SAVEPOINT_ROLLBACK, the xRollbackTo method. Otherwise, if op is
  115775. ** SAVEPOINT_RELEASE, then the xRelease method of each virtual table with
  115776. ** an open transaction is invoked.
  115777. **
  115778. ** If any virtual table method returns an error code other than SQLITE_OK,
  115779. ** processing is abandoned and the error returned to the caller of this
  115780. ** function immediately. If all calls to virtual table methods are successful,
  115781. ** SQLITE_OK is returned.
  115782. */
  115783. SQLITE_PRIVATE int sqlite3VtabSavepoint(sqlite3 *db, int op, int iSavepoint){
  115784. int rc = SQLITE_OK;
  115785. assert( op==SAVEPOINT_RELEASE||op==SAVEPOINT_ROLLBACK||op==SAVEPOINT_BEGIN );
  115786. assert( iSavepoint>=-1 );
  115787. if( db->aVTrans ){
  115788. int i;
  115789. for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
  115790. VTable *pVTab = db->aVTrans[i];
  115791. const sqlite3_module *pMod = pVTab->pMod->pModule;
  115792. if( pVTab->pVtab && pMod->iVersion>=2 ){
  115793. int (*xMethod)(sqlite3_vtab *, int);
  115794. switch( op ){
  115795. case SAVEPOINT_BEGIN:
  115796. xMethod = pMod->xSavepoint;
  115797. pVTab->iSavepoint = iSavepoint+1;
  115798. break;
  115799. case SAVEPOINT_ROLLBACK:
  115800. xMethod = pMod->xRollbackTo;
  115801. break;
  115802. default:
  115803. xMethod = pMod->xRelease;
  115804. break;
  115805. }
  115806. if( xMethod && pVTab->iSavepoint>iSavepoint ){
  115807. rc = xMethod(pVTab->pVtab, iSavepoint);
  115808. }
  115809. }
  115810. }
  115811. }
  115812. return rc;
  115813. }
  115814. /*
  115815. ** The first parameter (pDef) is a function implementation. The
  115816. ** second parameter (pExpr) is the first argument to this function.
  115817. ** If pExpr is a column in a virtual table, then let the virtual
  115818. ** table implementation have an opportunity to overload the function.
  115819. **
  115820. ** This routine is used to allow virtual table implementations to
  115821. ** overload MATCH, LIKE, GLOB, and REGEXP operators.
  115822. **
  115823. ** Return either the pDef argument (indicating no change) or a
  115824. ** new FuncDef structure that is marked as ephemeral using the
  115825. ** SQLITE_FUNC_EPHEM flag.
  115826. */
  115827. SQLITE_PRIVATE FuncDef *sqlite3VtabOverloadFunction(
  115828. sqlite3 *db, /* Database connection for reporting malloc problems */
  115829. FuncDef *pDef, /* Function to possibly overload */
  115830. int nArg, /* Number of arguments to the function */
  115831. Expr *pExpr /* First argument to the function */
  115832. ){
  115833. Table *pTab;
  115834. sqlite3_vtab *pVtab;
  115835. sqlite3_module *pMod;
  115836. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**) = 0;
  115837. void *pArg = 0;
  115838. FuncDef *pNew;
  115839. int rc = 0;
  115840. char *zLowerName;
  115841. unsigned char *z;
  115842. /* Check to see the left operand is a column in a virtual table */
  115843. if( NEVER(pExpr==0) ) return pDef;
  115844. if( pExpr->op!=TK_COLUMN ) return pDef;
  115845. pTab = pExpr->pTab;
  115846. if( NEVER(pTab==0) ) return pDef;
  115847. if( (pTab->tabFlags & TF_Virtual)==0 ) return pDef;
  115848. pVtab = sqlite3GetVTable(db, pTab)->pVtab;
  115849. assert( pVtab!=0 );
  115850. assert( pVtab->pModule!=0 );
  115851. pMod = (sqlite3_module *)pVtab->pModule;
  115852. if( pMod->xFindFunction==0 ) return pDef;
  115853. /* Call the xFindFunction method on the virtual table implementation
  115854. ** to see if the implementation wants to overload this function
  115855. */
  115856. zLowerName = sqlite3DbStrDup(db, pDef->zName);
  115857. if( zLowerName ){
  115858. for(z=(unsigned char*)zLowerName; *z; z++){
  115859. *z = sqlite3UpperToLower[*z];
  115860. }
  115861. rc = pMod->xFindFunction(pVtab, nArg, zLowerName, &xSFunc, &pArg);
  115862. sqlite3DbFree(db, zLowerName);
  115863. }
  115864. if( rc==0 ){
  115865. return pDef;
  115866. }
  115867. /* Create a new ephemeral function definition for the overloaded
  115868. ** function */
  115869. pNew = sqlite3DbMallocZero(db, sizeof(*pNew)
  115870. + sqlite3Strlen30(pDef->zName) + 1);
  115871. if( pNew==0 ){
  115872. return pDef;
  115873. }
  115874. *pNew = *pDef;
  115875. pNew->zName = (const char*)&pNew[1];
  115876. memcpy((char*)&pNew[1], pDef->zName, sqlite3Strlen30(pDef->zName)+1);
  115877. pNew->xSFunc = xSFunc;
  115878. pNew->pUserData = pArg;
  115879. pNew->funcFlags |= SQLITE_FUNC_EPHEM;
  115880. return pNew;
  115881. }
  115882. /*
  115883. ** Make sure virtual table pTab is contained in the pParse->apVirtualLock[]
  115884. ** array so that an OP_VBegin will get generated for it. Add pTab to the
  115885. ** array if it is missing. If pTab is already in the array, this routine
  115886. ** is a no-op.
  115887. */
  115888. SQLITE_PRIVATE void sqlite3VtabMakeWritable(Parse *pParse, Table *pTab){
  115889. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  115890. int i, n;
  115891. Table **apVtabLock;
  115892. assert( IsVirtual(pTab) );
  115893. for(i=0; i<pToplevel->nVtabLock; i++){
  115894. if( pTab==pToplevel->apVtabLock[i] ) return;
  115895. }
  115896. n = (pToplevel->nVtabLock+1)*sizeof(pToplevel->apVtabLock[0]);
  115897. apVtabLock = sqlite3_realloc64(pToplevel->apVtabLock, n);
  115898. if( apVtabLock ){
  115899. pToplevel->apVtabLock = apVtabLock;
  115900. pToplevel->apVtabLock[pToplevel->nVtabLock++] = pTab;
  115901. }else{
  115902. sqlite3OomFault(pToplevel->db);
  115903. }
  115904. }
  115905. /*
  115906. ** Check to see if virtual table module pMod can be have an eponymous
  115907. ** virtual table instance. If it can, create one if one does not already
  115908. ** exist. Return non-zero if the eponymous virtual table instance exists
  115909. ** when this routine returns, and return zero if it does not exist.
  115910. **
  115911. ** An eponymous virtual table instance is one that is named after its
  115912. ** module, and more importantly, does not require a CREATE VIRTUAL TABLE
  115913. ** statement in order to come into existance. Eponymous virtual table
  115914. ** instances always exist. They cannot be DROP-ed.
  115915. **
  115916. ** Any virtual table module for which xConnect and xCreate are the same
  115917. ** method can have an eponymous virtual table instance.
  115918. */
  115919. SQLITE_PRIVATE int sqlite3VtabEponymousTableInit(Parse *pParse, Module *pMod){
  115920. const sqlite3_module *pModule = pMod->pModule;
  115921. Table *pTab;
  115922. char *zErr = 0;
  115923. int rc;
  115924. sqlite3 *db = pParse->db;
  115925. if( pMod->pEpoTab ) return 1;
  115926. if( pModule->xCreate!=0 && pModule->xCreate!=pModule->xConnect ) return 0;
  115927. pTab = sqlite3DbMallocZero(db, sizeof(Table));
  115928. if( pTab==0 ) return 0;
  115929. pTab->zName = sqlite3DbStrDup(db, pMod->zName);
  115930. if( pTab->zName==0 ){
  115931. sqlite3DbFree(db, pTab);
  115932. return 0;
  115933. }
  115934. pMod->pEpoTab = pTab;
  115935. pTab->nRef = 1;
  115936. pTab->pSchema = db->aDb[0].pSchema;
  115937. pTab->tabFlags |= TF_Virtual;
  115938. pTab->nModuleArg = 0;
  115939. pTab->iPKey = -1;
  115940. addModuleArgument(db, pTab, sqlite3DbStrDup(db, pTab->zName));
  115941. addModuleArgument(db, pTab, 0);
  115942. addModuleArgument(db, pTab, sqlite3DbStrDup(db, pTab->zName));
  115943. rc = vtabCallConstructor(db, pTab, pMod, pModule->xConnect, &zErr);
  115944. if( rc ){
  115945. sqlite3ErrorMsg(pParse, "%s", zErr);
  115946. sqlite3DbFree(db, zErr);
  115947. sqlite3VtabEponymousTableClear(db, pMod);
  115948. return 0;
  115949. }
  115950. return 1;
  115951. }
  115952. /*
  115953. ** Erase the eponymous virtual table instance associated with
  115954. ** virtual table module pMod, if it exists.
  115955. */
  115956. SQLITE_PRIVATE void sqlite3VtabEponymousTableClear(sqlite3 *db, Module *pMod){
  115957. Table *pTab = pMod->pEpoTab;
  115958. if( pTab!=0 ){
  115959. /* Mark the table as Ephemeral prior to deleting it, so that the
  115960. ** sqlite3DeleteTable() routine will know that it is not stored in
  115961. ** the schema. */
  115962. pTab->tabFlags |= TF_Ephemeral;
  115963. sqlite3DeleteTable(db, pTab);
  115964. pMod->pEpoTab = 0;
  115965. }
  115966. }
  115967. /*
  115968. ** Return the ON CONFLICT resolution mode in effect for the virtual
  115969. ** table update operation currently in progress.
  115970. **
  115971. ** The results of this routine are undefined unless it is called from
  115972. ** within an xUpdate method.
  115973. */
  115974. SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *db){
  115975. static const unsigned char aMap[] = {
  115976. SQLITE_ROLLBACK, SQLITE_ABORT, SQLITE_FAIL, SQLITE_IGNORE, SQLITE_REPLACE
  115977. };
  115978. #ifdef SQLITE_ENABLE_API_ARMOR
  115979. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  115980. #endif
  115981. assert( OE_Rollback==1 && OE_Abort==2 && OE_Fail==3 );
  115982. assert( OE_Ignore==4 && OE_Replace==5 );
  115983. assert( db->vtabOnConflict>=1 && db->vtabOnConflict<=5 );
  115984. return (int)aMap[db->vtabOnConflict-1];
  115985. }
  115986. /*
  115987. ** Call from within the xCreate() or xConnect() methods to provide
  115988. ** the SQLite core with additional information about the behavior
  115989. ** of the virtual table being implemented.
  115990. */
  115991. SQLITE_API int sqlite3_vtab_config(sqlite3 *db, int op, ...){
  115992. va_list ap;
  115993. int rc = SQLITE_OK;
  115994. #ifdef SQLITE_ENABLE_API_ARMOR
  115995. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  115996. #endif
  115997. sqlite3_mutex_enter(db->mutex);
  115998. va_start(ap, op);
  115999. switch( op ){
  116000. case SQLITE_VTAB_CONSTRAINT_SUPPORT: {
  116001. VtabCtx *p = db->pVtabCtx;
  116002. if( !p ){
  116003. rc = SQLITE_MISUSE_BKPT;
  116004. }else{
  116005. assert( p->pTab==0 || (p->pTab->tabFlags & TF_Virtual)!=0 );
  116006. p->pVTable->bConstraint = (u8)va_arg(ap, int);
  116007. }
  116008. break;
  116009. }
  116010. default:
  116011. rc = SQLITE_MISUSE_BKPT;
  116012. break;
  116013. }
  116014. va_end(ap);
  116015. if( rc!=SQLITE_OK ) sqlite3Error(db, rc);
  116016. sqlite3_mutex_leave(db->mutex);
  116017. return rc;
  116018. }
  116019. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  116020. /************** End of vtab.c ************************************************/
  116021. /************** Begin file wherecode.c ***************************************/
  116022. /*
  116023. ** 2015-06-06
  116024. **
  116025. ** The author disclaims copyright to this source code. In place of
  116026. ** a legal notice, here is a blessing:
  116027. **
  116028. ** May you do good and not evil.
  116029. ** May you find forgiveness for yourself and forgive others.
  116030. ** May you share freely, never taking more than you give.
  116031. **
  116032. *************************************************************************
  116033. ** This module contains C code that generates VDBE code used to process
  116034. ** the WHERE clause of SQL statements.
  116035. **
  116036. ** This file was split off from where.c on 2015-06-06 in order to reduce the
  116037. ** size of where.c and make it easier to edit. This file contains the routines
  116038. ** that actually generate the bulk of the WHERE loop code. The original where.c
  116039. ** file retains the code that does query planning and analysis.
  116040. */
  116041. /* #include "sqliteInt.h" */
  116042. /************** Include whereInt.h in the middle of wherecode.c **************/
  116043. /************** Begin file whereInt.h ****************************************/
  116044. /*
  116045. ** 2013-11-12
  116046. **
  116047. ** The author disclaims copyright to this source code. In place of
  116048. ** a legal notice, here is a blessing:
  116049. **
  116050. ** May you do good and not evil.
  116051. ** May you find forgiveness for yourself and forgive others.
  116052. ** May you share freely, never taking more than you give.
  116053. **
  116054. *************************************************************************
  116055. **
  116056. ** This file contains structure and macro definitions for the query
  116057. ** planner logic in "where.c". These definitions are broken out into
  116058. ** a separate source file for easier editing.
  116059. */
  116060. /*
  116061. ** Trace output macros
  116062. */
  116063. #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
  116064. /***/ int sqlite3WhereTrace;
  116065. #endif
  116066. #if defined(SQLITE_DEBUG) \
  116067. && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
  116068. # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X
  116069. # define WHERETRACE_ENABLED 1
  116070. #else
  116071. # define WHERETRACE(K,X)
  116072. #endif
  116073. /* Forward references
  116074. */
  116075. typedef struct WhereClause WhereClause;
  116076. typedef struct WhereMaskSet WhereMaskSet;
  116077. typedef struct WhereOrInfo WhereOrInfo;
  116078. typedef struct WhereAndInfo WhereAndInfo;
  116079. typedef struct WhereLevel WhereLevel;
  116080. typedef struct WhereLoop WhereLoop;
  116081. typedef struct WherePath WherePath;
  116082. typedef struct WhereTerm WhereTerm;
  116083. typedef struct WhereLoopBuilder WhereLoopBuilder;
  116084. typedef struct WhereScan WhereScan;
  116085. typedef struct WhereOrCost WhereOrCost;
  116086. typedef struct WhereOrSet WhereOrSet;
  116087. /*
  116088. ** This object contains information needed to implement a single nested
  116089. ** loop in WHERE clause.
  116090. **
  116091. ** Contrast this object with WhereLoop. This object describes the
  116092. ** implementation of the loop. WhereLoop describes the algorithm.
  116093. ** This object contains a pointer to the WhereLoop algorithm as one of
  116094. ** its elements.
  116095. **
  116096. ** The WhereInfo object contains a single instance of this object for
  116097. ** each term in the FROM clause (which is to say, for each of the
  116098. ** nested loops as implemented). The order of WhereLevel objects determines
  116099. ** the loop nested order, with WhereInfo.a[0] being the outer loop and
  116100. ** WhereInfo.a[WhereInfo.nLevel-1] being the inner loop.
  116101. */
  116102. struct WhereLevel {
  116103. int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
  116104. int iTabCur; /* The VDBE cursor used to access the table */
  116105. int iIdxCur; /* The VDBE cursor used to access pIdx */
  116106. int addrBrk; /* Jump here to break out of the loop */
  116107. int addrNxt; /* Jump here to start the next IN combination */
  116108. int addrSkip; /* Jump here for next iteration of skip-scan */
  116109. int addrCont; /* Jump here to continue with the next loop cycle */
  116110. int addrFirst; /* First instruction of interior of the loop */
  116111. int addrBody; /* Beginning of the body of this loop */
  116112. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  116113. u32 iLikeRepCntr; /* LIKE range processing counter register (times 2) */
  116114. int addrLikeRep; /* LIKE range processing address */
  116115. #endif
  116116. u8 iFrom; /* Which entry in the FROM clause */
  116117. u8 op, p3, p5; /* Opcode, P3 & P5 of the opcode that ends the loop */
  116118. int p1, p2; /* Operands of the opcode used to ends the loop */
  116119. union { /* Information that depends on pWLoop->wsFlags */
  116120. struct {
  116121. int nIn; /* Number of entries in aInLoop[] */
  116122. struct InLoop {
  116123. int iCur; /* The VDBE cursor used by this IN operator */
  116124. int addrInTop; /* Top of the IN loop */
  116125. u8 eEndLoopOp; /* IN Loop terminator. OP_Next or OP_Prev */
  116126. } *aInLoop; /* Information about each nested IN operator */
  116127. } in; /* Used when pWLoop->wsFlags&WHERE_IN_ABLE */
  116128. Index *pCovidx; /* Possible covering index for WHERE_MULTI_OR */
  116129. } u;
  116130. struct WhereLoop *pWLoop; /* The selected WhereLoop object */
  116131. Bitmask notReady; /* FROM entries not usable at this level */
  116132. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  116133. int addrVisit; /* Address at which row is visited */
  116134. #endif
  116135. };
  116136. /*
  116137. ** Each instance of this object represents an algorithm for evaluating one
  116138. ** term of a join. Every term of the FROM clause will have at least
  116139. ** one corresponding WhereLoop object (unless INDEXED BY constraints
  116140. ** prevent a query solution - which is an error) and many terms of the
  116141. ** FROM clause will have multiple WhereLoop objects, each describing a
  116142. ** potential way of implementing that FROM-clause term, together with
  116143. ** dependencies and cost estimates for using the chosen algorithm.
  116144. **
  116145. ** Query planning consists of building up a collection of these WhereLoop
  116146. ** objects, then computing a particular sequence of WhereLoop objects, with
  116147. ** one WhereLoop object per FROM clause term, that satisfy all dependencies
  116148. ** and that minimize the overall cost.
  116149. */
  116150. struct WhereLoop {
  116151. Bitmask prereq; /* Bitmask of other loops that must run first */
  116152. Bitmask maskSelf; /* Bitmask identifying table iTab */
  116153. #ifdef SQLITE_DEBUG
  116154. char cId; /* Symbolic ID of this loop for debugging use */
  116155. #endif
  116156. u8 iTab; /* Position in FROM clause of table for this loop */
  116157. u8 iSortIdx; /* Sorting index number. 0==None */
  116158. LogEst rSetup; /* One-time setup cost (ex: create transient index) */
  116159. LogEst rRun; /* Cost of running each loop */
  116160. LogEst nOut; /* Estimated number of output rows */
  116161. union {
  116162. struct { /* Information for internal btree tables */
  116163. u16 nEq; /* Number of equality constraints */
  116164. u16 nBtm; /* Size of BTM vector */
  116165. u16 nTop; /* Size of TOP vector */
  116166. Index *pIndex; /* Index used, or NULL */
  116167. } btree;
  116168. struct { /* Information for virtual tables */
  116169. int idxNum; /* Index number */
  116170. u8 needFree; /* True if sqlite3_free(idxStr) is needed */
  116171. i8 isOrdered; /* True if satisfies ORDER BY */
  116172. u16 omitMask; /* Terms that may be omitted */
  116173. char *idxStr; /* Index identifier string */
  116174. } vtab;
  116175. } u;
  116176. u32 wsFlags; /* WHERE_* flags describing the plan */
  116177. u16 nLTerm; /* Number of entries in aLTerm[] */
  116178. u16 nSkip; /* Number of NULL aLTerm[] entries */
  116179. /**** whereLoopXfer() copies fields above ***********************/
  116180. # define WHERE_LOOP_XFER_SZ offsetof(WhereLoop,nLSlot)
  116181. u16 nLSlot; /* Number of slots allocated for aLTerm[] */
  116182. WhereTerm **aLTerm; /* WhereTerms used */
  116183. WhereLoop *pNextLoop; /* Next WhereLoop object in the WhereClause */
  116184. WhereTerm *aLTermSpace[3]; /* Initial aLTerm[] space */
  116185. };
  116186. /* This object holds the prerequisites and the cost of running a
  116187. ** subquery on one operand of an OR operator in the WHERE clause.
  116188. ** See WhereOrSet for additional information
  116189. */
  116190. struct WhereOrCost {
  116191. Bitmask prereq; /* Prerequisites */
  116192. LogEst rRun; /* Cost of running this subquery */
  116193. LogEst nOut; /* Number of outputs for this subquery */
  116194. };
  116195. /* The WhereOrSet object holds a set of possible WhereOrCosts that
  116196. ** correspond to the subquery(s) of OR-clause processing. Only the
  116197. ** best N_OR_COST elements are retained.
  116198. */
  116199. #define N_OR_COST 3
  116200. struct WhereOrSet {
  116201. u16 n; /* Number of valid a[] entries */
  116202. WhereOrCost a[N_OR_COST]; /* Set of best costs */
  116203. };
  116204. /*
  116205. ** Each instance of this object holds a sequence of WhereLoop objects
  116206. ** that implement some or all of a query plan.
  116207. **
  116208. ** Think of each WhereLoop object as a node in a graph with arcs
  116209. ** showing dependencies and costs for travelling between nodes. (That is
  116210. ** not a completely accurate description because WhereLoop costs are a
  116211. ** vector, not a scalar, and because dependencies are many-to-one, not
  116212. ** one-to-one as are graph nodes. But it is a useful visualization aid.)
  116213. ** Then a WherePath object is a path through the graph that visits some
  116214. ** or all of the WhereLoop objects once.
  116215. **
  116216. ** The "solver" works by creating the N best WherePath objects of length
  116217. ** 1. Then using those as a basis to compute the N best WherePath objects
  116218. ** of length 2. And so forth until the length of WherePaths equals the
  116219. ** number of nodes in the FROM clause. The best (lowest cost) WherePath
  116220. ** at the end is the chosen query plan.
  116221. */
  116222. struct WherePath {
  116223. Bitmask maskLoop; /* Bitmask of all WhereLoop objects in this path */
  116224. Bitmask revLoop; /* aLoop[]s that should be reversed for ORDER BY */
  116225. LogEst nRow; /* Estimated number of rows generated by this path */
  116226. LogEst rCost; /* Total cost of this path */
  116227. LogEst rUnsorted; /* Total cost of this path ignoring sorting costs */
  116228. i8 isOrdered; /* No. of ORDER BY terms satisfied. -1 for unknown */
  116229. WhereLoop **aLoop; /* Array of WhereLoop objects implementing this path */
  116230. };
  116231. /*
  116232. ** The query generator uses an array of instances of this structure to
  116233. ** help it analyze the subexpressions of the WHERE clause. Each WHERE
  116234. ** clause subexpression is separated from the others by AND operators,
  116235. ** usually, or sometimes subexpressions separated by OR.
  116236. **
  116237. ** All WhereTerms are collected into a single WhereClause structure.
  116238. ** The following identity holds:
  116239. **
  116240. ** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
  116241. **
  116242. ** When a term is of the form:
  116243. **
  116244. ** X <op> <expr>
  116245. **
  116246. ** where X is a column name and <op> is one of certain operators,
  116247. ** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
  116248. ** cursor number and column number for X. WhereTerm.eOperator records
  116249. ** the <op> using a bitmask encoding defined by WO_xxx below. The
  116250. ** use of a bitmask encoding for the operator allows us to search
  116251. ** quickly for terms that match any of several different operators.
  116252. **
  116253. ** A WhereTerm might also be two or more subterms connected by OR:
  116254. **
  116255. ** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
  116256. **
  116257. ** In this second case, wtFlag has the TERM_ORINFO bit set and eOperator==WO_OR
  116258. ** and the WhereTerm.u.pOrInfo field points to auxiliary information that
  116259. ** is collected about the OR clause.
  116260. **
  116261. ** If a term in the WHERE clause does not match either of the two previous
  116262. ** categories, then eOperator==0. The WhereTerm.pExpr field is still set
  116263. ** to the original subexpression content and wtFlags is set up appropriately
  116264. ** but no other fields in the WhereTerm object are meaningful.
  116265. **
  116266. ** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
  116267. ** but they do so indirectly. A single WhereMaskSet structure translates
  116268. ** cursor number into bits and the translated bit is stored in the prereq
  116269. ** fields. The translation is used in order to maximize the number of
  116270. ** bits that will fit in a Bitmask. The VDBE cursor numbers might be
  116271. ** spread out over the non-negative integers. For example, the cursor
  116272. ** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
  116273. ** translates these sparse cursor numbers into consecutive integers
  116274. ** beginning with 0 in order to make the best possible use of the available
  116275. ** bits in the Bitmask. So, in the example above, the cursor numbers
  116276. ** would be mapped into integers 0 through 7.
  116277. **
  116278. ** The number of terms in a join is limited by the number of bits
  116279. ** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
  116280. ** is only able to process joins with 64 or fewer tables.
  116281. */
  116282. struct WhereTerm {
  116283. Expr *pExpr; /* Pointer to the subexpression that is this term */
  116284. WhereClause *pWC; /* The clause this term is part of */
  116285. LogEst truthProb; /* Probability of truth for this expression */
  116286. u16 wtFlags; /* TERM_xxx bit flags. See below */
  116287. u16 eOperator; /* A WO_xx value describing <op> */
  116288. u8 nChild; /* Number of children that must disable us */
  116289. u8 eMatchOp; /* Op for vtab MATCH/LIKE/GLOB/REGEXP terms */
  116290. int iParent; /* Disable pWC->a[iParent] when this term disabled */
  116291. int leftCursor; /* Cursor number of X in "X <op> <expr>" */
  116292. int iField; /* Field in (?,?,?) IN (SELECT...) vector */
  116293. union {
  116294. int leftColumn; /* Column number of X in "X <op> <expr>" */
  116295. WhereOrInfo *pOrInfo; /* Extra information if (eOperator & WO_OR)!=0 */
  116296. WhereAndInfo *pAndInfo; /* Extra information if (eOperator& WO_AND)!=0 */
  116297. } u;
  116298. Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
  116299. Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
  116300. };
  116301. /*
  116302. ** Allowed values of WhereTerm.wtFlags
  116303. */
  116304. #define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
  116305. #define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
  116306. #define TERM_CODED 0x04 /* This term is already coded */
  116307. #define TERM_COPIED 0x08 /* Has a child */
  116308. #define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
  116309. #define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
  116310. #define TERM_OR_OK 0x40 /* Used during OR-clause processing */
  116311. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  116312. # define TERM_VNULL 0x80 /* Manufactured x>NULL or x<=NULL term */
  116313. #else
  116314. # define TERM_VNULL 0x00 /* Disabled if not using stat3 */
  116315. #endif
  116316. #define TERM_LIKEOPT 0x100 /* Virtual terms from the LIKE optimization */
  116317. #define TERM_LIKECOND 0x200 /* Conditionally this LIKE operator term */
  116318. #define TERM_LIKE 0x400 /* The original LIKE operator */
  116319. #define TERM_IS 0x800 /* Term.pExpr is an IS operator */
  116320. /*
  116321. ** An instance of the WhereScan object is used as an iterator for locating
  116322. ** terms in the WHERE clause that are useful to the query planner.
  116323. */
  116324. struct WhereScan {
  116325. WhereClause *pOrigWC; /* Original, innermost WhereClause */
  116326. WhereClause *pWC; /* WhereClause currently being scanned */
  116327. const char *zCollName; /* Required collating sequence, if not NULL */
  116328. Expr *pIdxExpr; /* Search for this index expression */
  116329. char idxaff; /* Must match this affinity, if zCollName!=NULL */
  116330. unsigned char nEquiv; /* Number of entries in aEquiv[] */
  116331. unsigned char iEquiv; /* Next unused slot in aEquiv[] */
  116332. u32 opMask; /* Acceptable operators */
  116333. int k; /* Resume scanning at this->pWC->a[this->k] */
  116334. int aiCur[11]; /* Cursors in the equivalence class */
  116335. i16 aiColumn[11]; /* Corresponding column number in the eq-class */
  116336. };
  116337. /*
  116338. ** An instance of the following structure holds all information about a
  116339. ** WHERE clause. Mostly this is a container for one or more WhereTerms.
  116340. **
  116341. ** Explanation of pOuter: For a WHERE clause of the form
  116342. **
  116343. ** a AND ((b AND c) OR (d AND e)) AND f
  116344. **
  116345. ** There are separate WhereClause objects for the whole clause and for
  116346. ** the subclauses "(b AND c)" and "(d AND e)". The pOuter field of the
  116347. ** subclauses points to the WhereClause object for the whole clause.
  116348. */
  116349. struct WhereClause {
  116350. WhereInfo *pWInfo; /* WHERE clause processing context */
  116351. WhereClause *pOuter; /* Outer conjunction */
  116352. u8 op; /* Split operator. TK_AND or TK_OR */
  116353. int nTerm; /* Number of terms */
  116354. int nSlot; /* Number of entries in a[] */
  116355. WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
  116356. #if defined(SQLITE_SMALL_STACK)
  116357. WhereTerm aStatic[1]; /* Initial static space for a[] */
  116358. #else
  116359. WhereTerm aStatic[8]; /* Initial static space for a[] */
  116360. #endif
  116361. };
  116362. /*
  116363. ** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
  116364. ** a dynamically allocated instance of the following structure.
  116365. */
  116366. struct WhereOrInfo {
  116367. WhereClause wc; /* Decomposition into subterms */
  116368. Bitmask indexable; /* Bitmask of all indexable tables in the clause */
  116369. };
  116370. /*
  116371. ** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
  116372. ** a dynamically allocated instance of the following structure.
  116373. */
  116374. struct WhereAndInfo {
  116375. WhereClause wc; /* The subexpression broken out */
  116376. };
  116377. /*
  116378. ** An instance of the following structure keeps track of a mapping
  116379. ** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
  116380. **
  116381. ** The VDBE cursor numbers are small integers contained in
  116382. ** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
  116383. ** clause, the cursor numbers might not begin with 0 and they might
  116384. ** contain gaps in the numbering sequence. But we want to make maximum
  116385. ** use of the bits in our bitmasks. This structure provides a mapping
  116386. ** from the sparse cursor numbers into consecutive integers beginning
  116387. ** with 0.
  116388. **
  116389. ** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
  116390. ** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
  116391. **
  116392. ** For example, if the WHERE clause expression used these VDBE
  116393. ** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
  116394. ** would map those cursor numbers into bits 0 through 5.
  116395. **
  116396. ** Note that the mapping is not necessarily ordered. In the example
  116397. ** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
  116398. ** 57->5, 73->4. Or one of 719 other combinations might be used. It
  116399. ** does not really matter. What is important is that sparse cursor
  116400. ** numbers all get mapped into bit numbers that begin with 0 and contain
  116401. ** no gaps.
  116402. */
  116403. struct WhereMaskSet {
  116404. int n; /* Number of assigned cursor values */
  116405. int ix[BMS]; /* Cursor assigned to each bit */
  116406. };
  116407. /*
  116408. ** Initialize a WhereMaskSet object
  116409. */
  116410. #define initMaskSet(P) (P)->n=0
  116411. /*
  116412. ** This object is a convenience wrapper holding all information needed
  116413. ** to construct WhereLoop objects for a particular query.
  116414. */
  116415. struct WhereLoopBuilder {
  116416. WhereInfo *pWInfo; /* Information about this WHERE */
  116417. WhereClause *pWC; /* WHERE clause terms */
  116418. ExprList *pOrderBy; /* ORDER BY clause */
  116419. WhereLoop *pNew; /* Template WhereLoop */
  116420. WhereOrSet *pOrSet; /* Record best loops here, if not NULL */
  116421. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  116422. UnpackedRecord *pRec; /* Probe for stat4 (if required) */
  116423. int nRecValid; /* Number of valid fields currently in pRec */
  116424. #endif
  116425. };
  116426. /*
  116427. ** The WHERE clause processing routine has two halves. The
  116428. ** first part does the start of the WHERE loop and the second
  116429. ** half does the tail of the WHERE loop. An instance of
  116430. ** this structure is returned by the first half and passed
  116431. ** into the second half to give some continuity.
  116432. **
  116433. ** An instance of this object holds the complete state of the query
  116434. ** planner.
  116435. */
  116436. struct WhereInfo {
  116437. Parse *pParse; /* Parsing and code generating context */
  116438. SrcList *pTabList; /* List of tables in the join */
  116439. ExprList *pOrderBy; /* The ORDER BY clause or NULL */
  116440. ExprList *pDistinctSet; /* DISTINCT over all these values */
  116441. LogEst iLimit; /* LIMIT if wctrlFlags has WHERE_USE_LIMIT */
  116442. int aiCurOnePass[2]; /* OP_OpenWrite cursors for the ONEPASS opt */
  116443. int iContinue; /* Jump here to continue with next record */
  116444. int iBreak; /* Jump here to break out of the loop */
  116445. int savedNQueryLoop; /* pParse->nQueryLoop outside the WHERE loop */
  116446. u16 wctrlFlags; /* Flags originally passed to sqlite3WhereBegin() */
  116447. u8 nLevel; /* Number of nested loop */
  116448. i8 nOBSat; /* Number of ORDER BY terms satisfied by indices */
  116449. u8 sorted; /* True if really sorted (not just grouped) */
  116450. u8 eOnePass; /* ONEPASS_OFF, or _SINGLE, or _MULTI */
  116451. u8 untestedTerms; /* Not all WHERE terms resolved by outer loop */
  116452. u8 eDistinct; /* One of the WHERE_DISTINCT_* values */
  116453. u8 bOrderedInnerLoop; /* True if only the inner-most loop is ordered */
  116454. int iTop; /* The very beginning of the WHERE loop */
  116455. WhereLoop *pLoops; /* List of all WhereLoop objects */
  116456. Bitmask revMask; /* Mask of ORDER BY terms that need reversing */
  116457. LogEst nRowOut; /* Estimated number of output rows */
  116458. WhereClause sWC; /* Decomposition of the WHERE clause */
  116459. WhereMaskSet sMaskSet; /* Map cursor numbers to bitmasks */
  116460. WhereLevel a[1]; /* Information about each nest loop in WHERE */
  116461. };
  116462. /*
  116463. ** Private interfaces - callable only by other where.c routines.
  116464. **
  116465. ** where.c:
  116466. */
  116467. SQLITE_PRIVATE Bitmask sqlite3WhereGetMask(WhereMaskSet*,int);
  116468. #ifdef WHERETRACE_ENABLED
  116469. SQLITE_PRIVATE void sqlite3WhereClausePrint(WhereClause *pWC);
  116470. #endif
  116471. SQLITE_PRIVATE WhereTerm *sqlite3WhereFindTerm(
  116472. WhereClause *pWC, /* The WHERE clause to be searched */
  116473. int iCur, /* Cursor number of LHS */
  116474. int iColumn, /* Column number of LHS */
  116475. Bitmask notReady, /* RHS must not overlap with this mask */
  116476. u32 op, /* Mask of WO_xx values describing operator */
  116477. Index *pIdx /* Must be compatible with this index, if not NULL */
  116478. );
  116479. /* wherecode.c: */
  116480. #ifndef SQLITE_OMIT_EXPLAIN
  116481. SQLITE_PRIVATE int sqlite3WhereExplainOneScan(
  116482. Parse *pParse, /* Parse context */
  116483. SrcList *pTabList, /* Table list this loop refers to */
  116484. WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
  116485. int iLevel, /* Value for "level" column of output */
  116486. int iFrom, /* Value for "from" column of output */
  116487. u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
  116488. );
  116489. #else
  116490. # define sqlite3WhereExplainOneScan(u,v,w,x,y,z) 0
  116491. #endif /* SQLITE_OMIT_EXPLAIN */
  116492. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  116493. SQLITE_PRIVATE void sqlite3WhereAddScanStatus(
  116494. Vdbe *v, /* Vdbe to add scanstatus entry to */
  116495. SrcList *pSrclist, /* FROM clause pLvl reads data from */
  116496. WhereLevel *pLvl, /* Level to add scanstatus() entry for */
  116497. int addrExplain /* Address of OP_Explain (or 0) */
  116498. );
  116499. #else
  116500. # define sqlite3WhereAddScanStatus(a, b, c, d) ((void)d)
  116501. #endif
  116502. SQLITE_PRIVATE Bitmask sqlite3WhereCodeOneLoopStart(
  116503. WhereInfo *pWInfo, /* Complete information about the WHERE clause */
  116504. int iLevel, /* Which level of pWInfo->a[] should be coded */
  116505. Bitmask notReady /* Which tables are currently available */
  116506. );
  116507. /* whereexpr.c: */
  116508. SQLITE_PRIVATE void sqlite3WhereClauseInit(WhereClause*,WhereInfo*);
  116509. SQLITE_PRIVATE void sqlite3WhereClauseClear(WhereClause*);
  116510. SQLITE_PRIVATE void sqlite3WhereSplit(WhereClause*,Expr*,u8);
  116511. SQLITE_PRIVATE Bitmask sqlite3WhereExprUsage(WhereMaskSet*, Expr*);
  116512. SQLITE_PRIVATE Bitmask sqlite3WhereExprListUsage(WhereMaskSet*, ExprList*);
  116513. SQLITE_PRIVATE void sqlite3WhereExprAnalyze(SrcList*, WhereClause*);
  116514. SQLITE_PRIVATE void sqlite3WhereTabFuncArgs(Parse*, struct SrcList_item*, WhereClause*);
  116515. /*
  116516. ** Bitmasks for the operators on WhereTerm objects. These are all
  116517. ** operators that are of interest to the query planner. An
  116518. ** OR-ed combination of these values can be used when searching for
  116519. ** particular WhereTerms within a WhereClause.
  116520. **
  116521. ** Value constraints:
  116522. ** WO_EQ == SQLITE_INDEX_CONSTRAINT_EQ
  116523. ** WO_LT == SQLITE_INDEX_CONSTRAINT_LT
  116524. ** WO_LE == SQLITE_INDEX_CONSTRAINT_LE
  116525. ** WO_GT == SQLITE_INDEX_CONSTRAINT_GT
  116526. ** WO_GE == SQLITE_INDEX_CONSTRAINT_GE
  116527. ** WO_MATCH == SQLITE_INDEX_CONSTRAINT_MATCH
  116528. */
  116529. #define WO_IN 0x0001
  116530. #define WO_EQ 0x0002
  116531. #define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
  116532. #define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
  116533. #define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
  116534. #define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
  116535. #define WO_MATCH 0x0040
  116536. #define WO_IS 0x0080
  116537. #define WO_ISNULL 0x0100
  116538. #define WO_OR 0x0200 /* Two or more OR-connected terms */
  116539. #define WO_AND 0x0400 /* Two or more AND-connected terms */
  116540. #define WO_EQUIV 0x0800 /* Of the form A==B, both columns */
  116541. #define WO_NOOP 0x1000 /* This term does not restrict search space */
  116542. #define WO_ALL 0x1fff /* Mask of all possible WO_* values */
  116543. #define WO_SINGLE 0x01ff /* Mask of all non-compound WO_* values */
  116544. /*
  116545. ** These are definitions of bits in the WhereLoop.wsFlags field.
  116546. ** The particular combination of bits in each WhereLoop help to
  116547. ** determine the algorithm that WhereLoop represents.
  116548. */
  116549. #define WHERE_COLUMN_EQ 0x00000001 /* x=EXPR */
  116550. #define WHERE_COLUMN_RANGE 0x00000002 /* x<EXPR and/or x>EXPR */
  116551. #define WHERE_COLUMN_IN 0x00000004 /* x IN (...) */
  116552. #define WHERE_COLUMN_NULL 0x00000008 /* x IS NULL */
  116553. #define WHERE_CONSTRAINT 0x0000000f /* Any of the WHERE_COLUMN_xxx values */
  116554. #define WHERE_TOP_LIMIT 0x00000010 /* x<EXPR or x<=EXPR constraint */
  116555. #define WHERE_BTM_LIMIT 0x00000020 /* x>EXPR or x>=EXPR constraint */
  116556. #define WHERE_BOTH_LIMIT 0x00000030 /* Both x>EXPR and x<EXPR */
  116557. #define WHERE_IDX_ONLY 0x00000040 /* Use index only - omit table */
  116558. #define WHERE_IPK 0x00000100 /* x is the INTEGER PRIMARY KEY */
  116559. #define WHERE_INDEXED 0x00000200 /* WhereLoop.u.btree.pIndex is valid */
  116560. #define WHERE_VIRTUALTABLE 0x00000400 /* WhereLoop.u.vtab is valid */
  116561. #define WHERE_IN_ABLE 0x00000800 /* Able to support an IN operator */
  116562. #define WHERE_ONEROW 0x00001000 /* Selects no more than one row */
  116563. #define WHERE_MULTI_OR 0x00002000 /* OR using multiple indices */
  116564. #define WHERE_AUTO_INDEX 0x00004000 /* Uses an ephemeral index */
  116565. #define WHERE_SKIPSCAN 0x00008000 /* Uses the skip-scan algorithm */
  116566. #define WHERE_UNQ_WANTED 0x00010000 /* WHERE_ONEROW would have been helpful*/
  116567. #define WHERE_PARTIALIDX 0x00020000 /* The automatic index is partial */
  116568. /************** End of whereInt.h ********************************************/
  116569. /************** Continuing where we left off in wherecode.c ******************/
  116570. #ifndef SQLITE_OMIT_EXPLAIN
  116571. /*
  116572. ** Return the name of the i-th column of the pIdx index.
  116573. */
  116574. static const char *explainIndexColumnName(Index *pIdx, int i){
  116575. i = pIdx->aiColumn[i];
  116576. if( i==XN_EXPR ) return "<expr>";
  116577. if( i==XN_ROWID ) return "rowid";
  116578. return pIdx->pTable->aCol[i].zName;
  116579. }
  116580. /*
  116581. ** This routine is a helper for explainIndexRange() below
  116582. **
  116583. ** pStr holds the text of an expression that we are building up one term
  116584. ** at a time. This routine adds a new term to the end of the expression.
  116585. ** Terms are separated by AND so add the "AND" text for second and subsequent
  116586. ** terms only.
  116587. */
  116588. static void explainAppendTerm(
  116589. StrAccum *pStr, /* The text expression being built */
  116590. Index *pIdx, /* Index to read column names from */
  116591. int nTerm, /* Number of terms */
  116592. int iTerm, /* Zero-based index of first term. */
  116593. int bAnd, /* Non-zero to append " AND " */
  116594. const char *zOp /* Name of the operator */
  116595. ){
  116596. int i;
  116597. assert( nTerm>=1 );
  116598. if( bAnd ) sqlite3StrAccumAppend(pStr, " AND ", 5);
  116599. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, "(", 1);
  116600. for(i=0; i<nTerm; i++){
  116601. if( i ) sqlite3StrAccumAppend(pStr, ",", 1);
  116602. sqlite3StrAccumAppendAll(pStr, explainIndexColumnName(pIdx, iTerm+i));
  116603. }
  116604. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, ")", 1);
  116605. sqlite3StrAccumAppend(pStr, zOp, 1);
  116606. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, "(", 1);
  116607. for(i=0; i<nTerm; i++){
  116608. if( i ) sqlite3StrAccumAppend(pStr, ",", 1);
  116609. sqlite3StrAccumAppend(pStr, "?", 1);
  116610. }
  116611. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, ")", 1);
  116612. }
  116613. /*
  116614. ** Argument pLevel describes a strategy for scanning table pTab. This
  116615. ** function appends text to pStr that describes the subset of table
  116616. ** rows scanned by the strategy in the form of an SQL expression.
  116617. **
  116618. ** For example, if the query:
  116619. **
  116620. ** SELECT * FROM t1 WHERE a=1 AND b>2;
  116621. **
  116622. ** is run and there is an index on (a, b), then this function returns a
  116623. ** string similar to:
  116624. **
  116625. ** "a=? AND b>?"
  116626. */
  116627. static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
  116628. Index *pIndex = pLoop->u.btree.pIndex;
  116629. u16 nEq = pLoop->u.btree.nEq;
  116630. u16 nSkip = pLoop->nSkip;
  116631. int i, j;
  116632. if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
  116633. sqlite3StrAccumAppend(pStr, " (", 2);
  116634. for(i=0; i<nEq; i++){
  116635. const char *z = explainIndexColumnName(pIndex, i);
  116636. if( i ) sqlite3StrAccumAppend(pStr, " AND ", 5);
  116637. sqlite3XPrintf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
  116638. }
  116639. j = i;
  116640. if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
  116641. explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
  116642. i = 1;
  116643. }
  116644. if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
  116645. explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
  116646. }
  116647. sqlite3StrAccumAppend(pStr, ")", 1);
  116648. }
  116649. /*
  116650. ** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
  116651. ** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
  116652. ** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
  116653. ** is added to the output to describe the table scan strategy in pLevel.
  116654. **
  116655. ** If an OP_Explain opcode is added to the VM, its address is returned.
  116656. ** Otherwise, if no OP_Explain is coded, zero is returned.
  116657. */
  116658. SQLITE_PRIVATE int sqlite3WhereExplainOneScan(
  116659. Parse *pParse, /* Parse context */
  116660. SrcList *pTabList, /* Table list this loop refers to */
  116661. WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
  116662. int iLevel, /* Value for "level" column of output */
  116663. int iFrom, /* Value for "from" column of output */
  116664. u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
  116665. ){
  116666. int ret = 0;
  116667. #if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
  116668. if( pParse->explain==2 )
  116669. #endif
  116670. {
  116671. struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
  116672. Vdbe *v = pParse->pVdbe; /* VM being constructed */
  116673. sqlite3 *db = pParse->db; /* Database handle */
  116674. int iId = pParse->iSelectId; /* Select id (left-most output column) */
  116675. int isSearch; /* True for a SEARCH. False for SCAN. */
  116676. WhereLoop *pLoop; /* The controlling WhereLoop object */
  116677. u32 flags; /* Flags that describe this loop */
  116678. char *zMsg; /* Text to add to EQP output */
  116679. StrAccum str; /* EQP output string */
  116680. char zBuf[100]; /* Initial space for EQP output string */
  116681. pLoop = pLevel->pWLoop;
  116682. flags = pLoop->wsFlags;
  116683. if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
  116684. isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
  116685. || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
  116686. || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
  116687. sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
  116688. sqlite3StrAccumAppendAll(&str, isSearch ? "SEARCH" : "SCAN");
  116689. if( pItem->pSelect ){
  116690. sqlite3XPrintf(&str, " SUBQUERY %d", pItem->iSelectId);
  116691. }else{
  116692. sqlite3XPrintf(&str, " TABLE %s", pItem->zName);
  116693. }
  116694. if( pItem->zAlias ){
  116695. sqlite3XPrintf(&str, " AS %s", pItem->zAlias);
  116696. }
  116697. if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
  116698. const char *zFmt = 0;
  116699. Index *pIdx;
  116700. assert( pLoop->u.btree.pIndex!=0 );
  116701. pIdx = pLoop->u.btree.pIndex;
  116702. assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
  116703. if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
  116704. if( isSearch ){
  116705. zFmt = "PRIMARY KEY";
  116706. }
  116707. }else if( flags & WHERE_PARTIALIDX ){
  116708. zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
  116709. }else if( flags & WHERE_AUTO_INDEX ){
  116710. zFmt = "AUTOMATIC COVERING INDEX";
  116711. }else if( flags & WHERE_IDX_ONLY ){
  116712. zFmt = "COVERING INDEX %s";
  116713. }else{
  116714. zFmt = "INDEX %s";
  116715. }
  116716. if( zFmt ){
  116717. sqlite3StrAccumAppend(&str, " USING ", 7);
  116718. sqlite3XPrintf(&str, zFmt, pIdx->zName);
  116719. explainIndexRange(&str, pLoop);
  116720. }
  116721. }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
  116722. const char *zRangeOp;
  116723. if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
  116724. zRangeOp = "=";
  116725. }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
  116726. zRangeOp = ">? AND rowid<";
  116727. }else if( flags&WHERE_BTM_LIMIT ){
  116728. zRangeOp = ">";
  116729. }else{
  116730. assert( flags&WHERE_TOP_LIMIT);
  116731. zRangeOp = "<";
  116732. }
  116733. sqlite3XPrintf(&str, " USING INTEGER PRIMARY KEY (rowid%s?)",zRangeOp);
  116734. }
  116735. #ifndef SQLITE_OMIT_VIRTUALTABLE
  116736. else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
  116737. sqlite3XPrintf(&str, " VIRTUAL TABLE INDEX %d:%s",
  116738. pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
  116739. }
  116740. #endif
  116741. #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
  116742. if( pLoop->nOut>=10 ){
  116743. sqlite3XPrintf(&str, " (~%llu rows)", sqlite3LogEstToInt(pLoop->nOut));
  116744. }else{
  116745. sqlite3StrAccumAppend(&str, " (~1 row)", 9);
  116746. }
  116747. #endif
  116748. zMsg = sqlite3StrAccumFinish(&str);
  116749. ret = sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg,P4_DYNAMIC);
  116750. }
  116751. return ret;
  116752. }
  116753. #endif /* SQLITE_OMIT_EXPLAIN */
  116754. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  116755. /*
  116756. ** Configure the VM passed as the first argument with an
  116757. ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
  116758. ** implement level pLvl. Argument pSrclist is a pointer to the FROM
  116759. ** clause that the scan reads data from.
  116760. **
  116761. ** If argument addrExplain is not 0, it must be the address of an
  116762. ** OP_Explain instruction that describes the same loop.
  116763. */
  116764. SQLITE_PRIVATE void sqlite3WhereAddScanStatus(
  116765. Vdbe *v, /* Vdbe to add scanstatus entry to */
  116766. SrcList *pSrclist, /* FROM clause pLvl reads data from */
  116767. WhereLevel *pLvl, /* Level to add scanstatus() entry for */
  116768. int addrExplain /* Address of OP_Explain (or 0) */
  116769. ){
  116770. const char *zObj = 0;
  116771. WhereLoop *pLoop = pLvl->pWLoop;
  116772. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
  116773. zObj = pLoop->u.btree.pIndex->zName;
  116774. }else{
  116775. zObj = pSrclist->a[pLvl->iFrom].zName;
  116776. }
  116777. sqlite3VdbeScanStatus(
  116778. v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
  116779. );
  116780. }
  116781. #endif
  116782. /*
  116783. ** Disable a term in the WHERE clause. Except, do not disable the term
  116784. ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
  116785. ** or USING clause of that join.
  116786. **
  116787. ** Consider the term t2.z='ok' in the following queries:
  116788. **
  116789. ** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
  116790. ** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
  116791. ** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
  116792. **
  116793. ** The t2.z='ok' is disabled in the in (2) because it originates
  116794. ** in the ON clause. The term is disabled in (3) because it is not part
  116795. ** of a LEFT OUTER JOIN. In (1), the term is not disabled.
  116796. **
  116797. ** Disabling a term causes that term to not be tested in the inner loop
  116798. ** of the join. Disabling is an optimization. When terms are satisfied
  116799. ** by indices, we disable them to prevent redundant tests in the inner
  116800. ** loop. We would get the correct results if nothing were ever disabled,
  116801. ** but joins might run a little slower. The trick is to disable as much
  116802. ** as we can without disabling too much. If we disabled in (1), we'd get
  116803. ** the wrong answer. See ticket #813.
  116804. **
  116805. ** If all the children of a term are disabled, then that term is also
  116806. ** automatically disabled. In this way, terms get disabled if derived
  116807. ** virtual terms are tested first. For example:
  116808. **
  116809. ** x GLOB 'abc*' AND x>='abc' AND x<'acd'
  116810. ** \___________/ \______/ \_____/
  116811. ** parent child1 child2
  116812. **
  116813. ** Only the parent term was in the original WHERE clause. The child1
  116814. ** and child2 terms were added by the LIKE optimization. If both of
  116815. ** the virtual child terms are valid, then testing of the parent can be
  116816. ** skipped.
  116817. **
  116818. ** Usually the parent term is marked as TERM_CODED. But if the parent
  116819. ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
  116820. ** The TERM_LIKECOND marking indicates that the term should be coded inside
  116821. ** a conditional such that is only evaluated on the second pass of a
  116822. ** LIKE-optimization loop, when scanning BLOBs instead of strings.
  116823. */
  116824. static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
  116825. int nLoop = 0;
  116826. while( ALWAYS(pTerm!=0)
  116827. && (pTerm->wtFlags & TERM_CODED)==0
  116828. && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
  116829. && (pLevel->notReady & pTerm->prereqAll)==0
  116830. ){
  116831. if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
  116832. pTerm->wtFlags |= TERM_LIKECOND;
  116833. }else{
  116834. pTerm->wtFlags |= TERM_CODED;
  116835. }
  116836. if( pTerm->iParent<0 ) break;
  116837. pTerm = &pTerm->pWC->a[pTerm->iParent];
  116838. pTerm->nChild--;
  116839. if( pTerm->nChild!=0 ) break;
  116840. nLoop++;
  116841. }
  116842. }
  116843. /*
  116844. ** Code an OP_Affinity opcode to apply the column affinity string zAff
  116845. ** to the n registers starting at base.
  116846. **
  116847. ** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
  116848. ** beginning and end of zAff are ignored. If all entries in zAff are
  116849. ** SQLITE_AFF_BLOB, then no code gets generated.
  116850. **
  116851. ** This routine makes its own copy of zAff so that the caller is free
  116852. ** to modify zAff after this routine returns.
  116853. */
  116854. static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
  116855. Vdbe *v = pParse->pVdbe;
  116856. if( zAff==0 ){
  116857. assert( pParse->db->mallocFailed );
  116858. return;
  116859. }
  116860. assert( v!=0 );
  116861. /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
  116862. ** and end of the affinity string.
  116863. */
  116864. while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
  116865. n--;
  116866. base++;
  116867. zAff++;
  116868. }
  116869. while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
  116870. n--;
  116871. }
  116872. /* Code the OP_Affinity opcode if there is anything left to do. */
  116873. if( n>0 ){
  116874. sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
  116875. sqlite3ExprCacheAffinityChange(pParse, base, n);
  116876. }
  116877. }
  116878. /*
  116879. ** Expression pRight, which is the RHS of a comparison operation, is
  116880. ** either a vector of n elements or, if n==1, a scalar expression.
  116881. ** Before the comparison operation, affinity zAff is to be applied
  116882. ** to the pRight values. This function modifies characters within the
  116883. ** affinity string to SQLITE_AFF_BLOB if either:
  116884. **
  116885. ** * the comparison will be performed with no affinity, or
  116886. ** * the affinity change in zAff is guaranteed not to change the value.
  116887. */
  116888. static void updateRangeAffinityStr(
  116889. Expr *pRight, /* RHS of comparison */
  116890. int n, /* Number of vector elements in comparison */
  116891. char *zAff /* Affinity string to modify */
  116892. ){
  116893. int i;
  116894. for(i=0; i<n; i++){
  116895. Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
  116896. if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
  116897. || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
  116898. ){
  116899. zAff[i] = SQLITE_AFF_BLOB;
  116900. }
  116901. }
  116902. }
  116903. /*
  116904. ** Generate code for a single equality term of the WHERE clause. An equality
  116905. ** term can be either X=expr or X IN (...). pTerm is the term to be
  116906. ** coded.
  116907. **
  116908. ** The current value for the constraint is left in a register, the index
  116909. ** of which is returned. An attempt is made store the result in iTarget but
  116910. ** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
  116911. ** constraint is a TK_EQ or TK_IS, then the current value might be left in
  116912. ** some other register and it is the caller's responsibility to compensate.
  116913. **
  116914. ** For a constraint of the form X=expr, the expression is evaluated in
  116915. ** straight-line code. For constraints of the form X IN (...)
  116916. ** this routine sets up a loop that will iterate over all values of X.
  116917. */
  116918. static int codeEqualityTerm(
  116919. Parse *pParse, /* The parsing context */
  116920. WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
  116921. WhereLevel *pLevel, /* The level of the FROM clause we are working on */
  116922. int iEq, /* Index of the equality term within this level */
  116923. int bRev, /* True for reverse-order IN operations */
  116924. int iTarget /* Attempt to leave results in this register */
  116925. ){
  116926. Expr *pX = pTerm->pExpr;
  116927. Vdbe *v = pParse->pVdbe;
  116928. int iReg; /* Register holding results */
  116929. assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
  116930. assert( iTarget>0 );
  116931. if( pX->op==TK_EQ || pX->op==TK_IS ){
  116932. iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
  116933. }else if( pX->op==TK_ISNULL ){
  116934. iReg = iTarget;
  116935. sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
  116936. #ifndef SQLITE_OMIT_SUBQUERY
  116937. }else{
  116938. int eType = IN_INDEX_NOOP;
  116939. int iTab;
  116940. struct InLoop *pIn;
  116941. WhereLoop *pLoop = pLevel->pWLoop;
  116942. int i;
  116943. int nEq = 0;
  116944. int *aiMap = 0;
  116945. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
  116946. && pLoop->u.btree.pIndex!=0
  116947. && pLoop->u.btree.pIndex->aSortOrder[iEq]
  116948. ){
  116949. testcase( iEq==0 );
  116950. testcase( bRev );
  116951. bRev = !bRev;
  116952. }
  116953. assert( pX->op==TK_IN );
  116954. iReg = iTarget;
  116955. for(i=0; i<iEq; i++){
  116956. if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
  116957. disableTerm(pLevel, pTerm);
  116958. return iTarget;
  116959. }
  116960. }
  116961. for(i=iEq;i<pLoop->nLTerm; i++){
  116962. if( ALWAYS(pLoop->aLTerm[i]) && pLoop->aLTerm[i]->pExpr==pX ) nEq++;
  116963. }
  116964. if( (pX->flags & EP_xIsSelect)==0 || pX->x.pSelect->pEList->nExpr==1 ){
  116965. eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0);
  116966. }else{
  116967. Select *pSelect = pX->x.pSelect;
  116968. sqlite3 *db = pParse->db;
  116969. ExprList *pOrigRhs = pSelect->pEList;
  116970. ExprList *pOrigLhs = pX->pLeft->x.pList;
  116971. ExprList *pRhs = 0; /* New Select.pEList for RHS */
  116972. ExprList *pLhs = 0; /* New pX->pLeft vector */
  116973. for(i=iEq;i<pLoop->nLTerm; i++){
  116974. if( pLoop->aLTerm[i]->pExpr==pX ){
  116975. int iField = pLoop->aLTerm[i]->iField - 1;
  116976. Expr *pNewRhs = sqlite3ExprDup(db, pOrigRhs->a[iField].pExpr, 0);
  116977. Expr *pNewLhs = sqlite3ExprDup(db, pOrigLhs->a[iField].pExpr, 0);
  116978. pRhs = sqlite3ExprListAppend(pParse, pRhs, pNewRhs);
  116979. pLhs = sqlite3ExprListAppend(pParse, pLhs, pNewLhs);
  116980. }
  116981. }
  116982. if( !db->mallocFailed ){
  116983. Expr *pLeft = pX->pLeft;
  116984. if( pSelect->pOrderBy ){
  116985. /* If the SELECT statement has an ORDER BY clause, zero the
  116986. ** iOrderByCol variables. These are set to non-zero when an
  116987. ** ORDER BY term exactly matches one of the terms of the
  116988. ** result-set. Since the result-set of the SELECT statement may
  116989. ** have been modified or reordered, these variables are no longer
  116990. ** set correctly. Since setting them is just an optimization,
  116991. ** it's easiest just to zero them here. */
  116992. ExprList *pOrderBy = pSelect->pOrderBy;
  116993. for(i=0; i<pOrderBy->nExpr; i++){
  116994. pOrderBy->a[i].u.x.iOrderByCol = 0;
  116995. }
  116996. }
  116997. /* Take care here not to generate a TK_VECTOR containing only a
  116998. ** single value. Since the parser never creates such a vector, some
  116999. ** of the subroutines do not handle this case. */
  117000. if( pLhs->nExpr==1 ){
  117001. pX->pLeft = pLhs->a[0].pExpr;
  117002. }else{
  117003. pLeft->x.pList = pLhs;
  117004. aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int) * nEq);
  117005. testcase( aiMap==0 );
  117006. }
  117007. pSelect->pEList = pRhs;
  117008. eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap);
  117009. testcase( aiMap!=0 && aiMap[0]!=0 );
  117010. pSelect->pEList = pOrigRhs;
  117011. pLeft->x.pList = pOrigLhs;
  117012. pX->pLeft = pLeft;
  117013. }
  117014. sqlite3ExprListDelete(pParse->db, pLhs);
  117015. sqlite3ExprListDelete(pParse->db, pRhs);
  117016. }
  117017. if( eType==IN_INDEX_INDEX_DESC ){
  117018. testcase( bRev );
  117019. bRev = !bRev;
  117020. }
  117021. iTab = pX->iTable;
  117022. sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
  117023. VdbeCoverageIf(v, bRev);
  117024. VdbeCoverageIf(v, !bRev);
  117025. assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
  117026. pLoop->wsFlags |= WHERE_IN_ABLE;
  117027. if( pLevel->u.in.nIn==0 ){
  117028. pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
  117029. }
  117030. i = pLevel->u.in.nIn;
  117031. pLevel->u.in.nIn += nEq;
  117032. pLevel->u.in.aInLoop =
  117033. sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
  117034. sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
  117035. pIn = pLevel->u.in.aInLoop;
  117036. if( pIn ){
  117037. int iMap = 0; /* Index in aiMap[] */
  117038. pIn += i;
  117039. for(i=iEq;i<pLoop->nLTerm; i++){
  117040. if( pLoop->aLTerm[i]->pExpr==pX ){
  117041. int iOut = iReg + i - iEq;
  117042. if( eType==IN_INDEX_ROWID ){
  117043. testcase( nEq>1 ); /* Happens with a UNIQUE index on ROWID */
  117044. pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
  117045. }else{
  117046. int iCol = aiMap ? aiMap[iMap++] : 0;
  117047. pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
  117048. }
  117049. sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
  117050. if( i==iEq ){
  117051. pIn->iCur = iTab;
  117052. pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
  117053. }else{
  117054. pIn->eEndLoopOp = OP_Noop;
  117055. }
  117056. pIn++;
  117057. }
  117058. }
  117059. }else{
  117060. pLevel->u.in.nIn = 0;
  117061. }
  117062. sqlite3DbFree(pParse->db, aiMap);
  117063. #endif
  117064. }
  117065. disableTerm(pLevel, pTerm);
  117066. return iReg;
  117067. }
  117068. /*
  117069. ** Generate code that will evaluate all == and IN constraints for an
  117070. ** index scan.
  117071. **
  117072. ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
  117073. ** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
  117074. ** The index has as many as three equality constraints, but in this
  117075. ** example, the third "c" value is an inequality. So only two
  117076. ** constraints are coded. This routine will generate code to evaluate
  117077. ** a==5 and b IN (1,2,3). The current values for a and b will be stored
  117078. ** in consecutive registers and the index of the first register is returned.
  117079. **
  117080. ** In the example above nEq==2. But this subroutine works for any value
  117081. ** of nEq including 0. If nEq==0, this routine is nearly a no-op.
  117082. ** The only thing it does is allocate the pLevel->iMem memory cell and
  117083. ** compute the affinity string.
  117084. **
  117085. ** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
  117086. ** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
  117087. ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
  117088. ** occurs after the nEq quality constraints.
  117089. **
  117090. ** This routine allocates a range of nEq+nExtraReg memory cells and returns
  117091. ** the index of the first memory cell in that range. The code that
  117092. ** calls this routine will use that memory range to store keys for
  117093. ** start and termination conditions of the loop.
  117094. ** key value of the loop. If one or more IN operators appear, then
  117095. ** this routine allocates an additional nEq memory cells for internal
  117096. ** use.
  117097. **
  117098. ** Before returning, *pzAff is set to point to a buffer containing a
  117099. ** copy of the column affinity string of the index allocated using
  117100. ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
  117101. ** with equality constraints that use BLOB or NONE affinity are set to
  117102. ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
  117103. **
  117104. ** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
  117105. ** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
  117106. **
  117107. ** In the example above, the index on t1(a) has TEXT affinity. But since
  117108. ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
  117109. ** no conversion should be attempted before using a t2.b value as part of
  117110. ** a key to search the index. Hence the first byte in the returned affinity
  117111. ** string in this example would be set to SQLITE_AFF_BLOB.
  117112. */
  117113. static int codeAllEqualityTerms(
  117114. Parse *pParse, /* Parsing context */
  117115. WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
  117116. int bRev, /* Reverse the order of IN operators */
  117117. int nExtraReg, /* Number of extra registers to allocate */
  117118. char **pzAff /* OUT: Set to point to affinity string */
  117119. ){
  117120. u16 nEq; /* The number of == or IN constraints to code */
  117121. u16 nSkip; /* Number of left-most columns to skip */
  117122. Vdbe *v = pParse->pVdbe; /* The vm under construction */
  117123. Index *pIdx; /* The index being used for this loop */
  117124. WhereTerm *pTerm; /* A single constraint term */
  117125. WhereLoop *pLoop; /* The WhereLoop object */
  117126. int j; /* Loop counter */
  117127. int regBase; /* Base register */
  117128. int nReg; /* Number of registers to allocate */
  117129. char *zAff; /* Affinity string to return */
  117130. /* This module is only called on query plans that use an index. */
  117131. pLoop = pLevel->pWLoop;
  117132. assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
  117133. nEq = pLoop->u.btree.nEq;
  117134. nSkip = pLoop->nSkip;
  117135. pIdx = pLoop->u.btree.pIndex;
  117136. assert( pIdx!=0 );
  117137. /* Figure out how many memory cells we will need then allocate them.
  117138. */
  117139. regBase = pParse->nMem + 1;
  117140. nReg = pLoop->u.btree.nEq + nExtraReg;
  117141. pParse->nMem += nReg;
  117142. zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
  117143. assert( zAff!=0 || pParse->db->mallocFailed );
  117144. if( nSkip ){
  117145. int iIdxCur = pLevel->iIdxCur;
  117146. sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
  117147. VdbeCoverageIf(v, bRev==0);
  117148. VdbeCoverageIf(v, bRev!=0);
  117149. VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
  117150. j = sqlite3VdbeAddOp0(v, OP_Goto);
  117151. pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
  117152. iIdxCur, 0, regBase, nSkip);
  117153. VdbeCoverageIf(v, bRev==0);
  117154. VdbeCoverageIf(v, bRev!=0);
  117155. sqlite3VdbeJumpHere(v, j);
  117156. for(j=0; j<nSkip; j++){
  117157. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
  117158. testcase( pIdx->aiColumn[j]==XN_EXPR );
  117159. VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
  117160. }
  117161. }
  117162. /* Evaluate the equality constraints
  117163. */
  117164. assert( zAff==0 || (int)strlen(zAff)>=nEq );
  117165. for(j=nSkip; j<nEq; j++){
  117166. int r1;
  117167. pTerm = pLoop->aLTerm[j];
  117168. assert( pTerm!=0 );
  117169. /* The following testcase is true for indices with redundant columns.
  117170. ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
  117171. testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
  117172. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  117173. r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
  117174. if( r1!=regBase+j ){
  117175. if( nReg==1 ){
  117176. sqlite3ReleaseTempReg(pParse, regBase);
  117177. regBase = r1;
  117178. }else{
  117179. sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
  117180. }
  117181. }
  117182. if( pTerm->eOperator & WO_IN ){
  117183. if( pTerm->pExpr->flags & EP_xIsSelect ){
  117184. /* No affinity ever needs to be (or should be) applied to a value
  117185. ** from the RHS of an "? IN (SELECT ...)" expression. The
  117186. ** sqlite3FindInIndex() routine has already ensured that the
  117187. ** affinity of the comparison has been applied to the value. */
  117188. if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
  117189. }
  117190. }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
  117191. Expr *pRight = pTerm->pExpr->pRight;
  117192. if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
  117193. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
  117194. VdbeCoverage(v);
  117195. }
  117196. if( zAff ){
  117197. if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
  117198. zAff[j] = SQLITE_AFF_BLOB;
  117199. }
  117200. if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
  117201. zAff[j] = SQLITE_AFF_BLOB;
  117202. }
  117203. }
  117204. }
  117205. }
  117206. *pzAff = zAff;
  117207. return regBase;
  117208. }
  117209. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  117210. /*
  117211. ** If the most recently coded instruction is a constant range constraint
  117212. ** (a string literal) that originated from the LIKE optimization, then
  117213. ** set P3 and P5 on the OP_String opcode so that the string will be cast
  117214. ** to a BLOB at appropriate times.
  117215. **
  117216. ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
  117217. ** expression: "x>='ABC' AND x<'abd'". But this requires that the range
  117218. ** scan loop run twice, once for strings and a second time for BLOBs.
  117219. ** The OP_String opcodes on the second pass convert the upper and lower
  117220. ** bound string constants to blobs. This routine makes the necessary changes
  117221. ** to the OP_String opcodes for that to happen.
  117222. **
  117223. ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
  117224. ** only the one pass through the string space is required, so this routine
  117225. ** becomes a no-op.
  117226. */
  117227. static void whereLikeOptimizationStringFixup(
  117228. Vdbe *v, /* prepared statement under construction */
  117229. WhereLevel *pLevel, /* The loop that contains the LIKE operator */
  117230. WhereTerm *pTerm /* The upper or lower bound just coded */
  117231. ){
  117232. if( pTerm->wtFlags & TERM_LIKEOPT ){
  117233. VdbeOp *pOp;
  117234. assert( pLevel->iLikeRepCntr>0 );
  117235. pOp = sqlite3VdbeGetOp(v, -1);
  117236. assert( pOp!=0 );
  117237. assert( pOp->opcode==OP_String8
  117238. || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
  117239. pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
  117240. pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
  117241. }
  117242. }
  117243. #else
  117244. # define whereLikeOptimizationStringFixup(A,B,C)
  117245. #endif
  117246. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  117247. /*
  117248. ** Information is passed from codeCursorHint() down to individual nodes of
  117249. ** the expression tree (by sqlite3WalkExpr()) using an instance of this
  117250. ** structure.
  117251. */
  117252. struct CCurHint {
  117253. int iTabCur; /* Cursor for the main table */
  117254. int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
  117255. Index *pIdx; /* The index used to access the table */
  117256. };
  117257. /*
  117258. ** This function is called for every node of an expression that is a candidate
  117259. ** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
  117260. ** the table CCurHint.iTabCur, verify that the same column can be
  117261. ** accessed through the index. If it cannot, then set pWalker->eCode to 1.
  117262. */
  117263. static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
  117264. struct CCurHint *pHint = pWalker->u.pCCurHint;
  117265. assert( pHint->pIdx!=0 );
  117266. if( pExpr->op==TK_COLUMN
  117267. && pExpr->iTable==pHint->iTabCur
  117268. && sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn)<0
  117269. ){
  117270. pWalker->eCode = 1;
  117271. }
  117272. return WRC_Continue;
  117273. }
  117274. /*
  117275. ** Test whether or not expression pExpr, which was part of a WHERE clause,
  117276. ** should be included in the cursor-hint for a table that is on the rhs
  117277. ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
  117278. ** expression is not suitable.
  117279. **
  117280. ** An expression is unsuitable if it might evaluate to non NULL even if
  117281. ** a TK_COLUMN node that does affect the value of the expression is set
  117282. ** to NULL. For example:
  117283. **
  117284. ** col IS NULL
  117285. ** col IS NOT NULL
  117286. ** coalesce(col, 1)
  117287. ** CASE WHEN col THEN 0 ELSE 1 END
  117288. */
  117289. static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
  117290. if( pExpr->op==TK_IS
  117291. || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
  117292. || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
  117293. ){
  117294. pWalker->eCode = 1;
  117295. }else if( pExpr->op==TK_FUNCTION ){
  117296. int d1;
  117297. char d2[3];
  117298. if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
  117299. pWalker->eCode = 1;
  117300. }
  117301. }
  117302. return WRC_Continue;
  117303. }
  117304. /*
  117305. ** This function is called on every node of an expression tree used as an
  117306. ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
  117307. ** that accesses any table other than the one identified by
  117308. ** CCurHint.iTabCur, then do the following:
  117309. **
  117310. ** 1) allocate a register and code an OP_Column instruction to read
  117311. ** the specified column into the new register, and
  117312. **
  117313. ** 2) transform the expression node to a TK_REGISTER node that reads
  117314. ** from the newly populated register.
  117315. **
  117316. ** Also, if the node is a TK_COLUMN that does access the table idenified
  117317. ** by pCCurHint.iTabCur, and an index is being used (which we will
  117318. ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
  117319. ** an access of the index rather than the original table.
  117320. */
  117321. static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
  117322. int rc = WRC_Continue;
  117323. struct CCurHint *pHint = pWalker->u.pCCurHint;
  117324. if( pExpr->op==TK_COLUMN ){
  117325. if( pExpr->iTable!=pHint->iTabCur ){
  117326. Vdbe *v = pWalker->pParse->pVdbe;
  117327. int reg = ++pWalker->pParse->nMem; /* Register for column value */
  117328. sqlite3ExprCodeGetColumnOfTable(
  117329. v, pExpr->pTab, pExpr->iTable, pExpr->iColumn, reg
  117330. );
  117331. pExpr->op = TK_REGISTER;
  117332. pExpr->iTable = reg;
  117333. }else if( pHint->pIdx!=0 ){
  117334. pExpr->iTable = pHint->iIdxCur;
  117335. pExpr->iColumn = sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn);
  117336. assert( pExpr->iColumn>=0 );
  117337. }
  117338. }else if( pExpr->op==TK_AGG_FUNCTION ){
  117339. /* An aggregate function in the WHERE clause of a query means this must
  117340. ** be a correlated sub-query, and expression pExpr is an aggregate from
  117341. ** the parent context. Do not walk the function arguments in this case.
  117342. **
  117343. ** todo: It should be possible to replace this node with a TK_REGISTER
  117344. ** expression, as the result of the expression must be stored in a
  117345. ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
  117346. rc = WRC_Prune;
  117347. }
  117348. return rc;
  117349. }
  117350. /*
  117351. ** Insert an OP_CursorHint instruction if it is appropriate to do so.
  117352. */
  117353. static void codeCursorHint(
  117354. struct SrcList_item *pTabItem, /* FROM clause item */
  117355. WhereInfo *pWInfo, /* The where clause */
  117356. WhereLevel *pLevel, /* Which loop to provide hints for */
  117357. WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
  117358. ){
  117359. Parse *pParse = pWInfo->pParse;
  117360. sqlite3 *db = pParse->db;
  117361. Vdbe *v = pParse->pVdbe;
  117362. Expr *pExpr = 0;
  117363. WhereLoop *pLoop = pLevel->pWLoop;
  117364. int iCur;
  117365. WhereClause *pWC;
  117366. WhereTerm *pTerm;
  117367. int i, j;
  117368. struct CCurHint sHint;
  117369. Walker sWalker;
  117370. if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
  117371. iCur = pLevel->iTabCur;
  117372. assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
  117373. sHint.iTabCur = iCur;
  117374. sHint.iIdxCur = pLevel->iIdxCur;
  117375. sHint.pIdx = pLoop->u.btree.pIndex;
  117376. memset(&sWalker, 0, sizeof(sWalker));
  117377. sWalker.pParse = pParse;
  117378. sWalker.u.pCCurHint = &sHint;
  117379. pWC = &pWInfo->sWC;
  117380. for(i=0; i<pWC->nTerm; i++){
  117381. pTerm = &pWC->a[i];
  117382. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  117383. if( pTerm->prereqAll & pLevel->notReady ) continue;
  117384. /* Any terms specified as part of the ON(...) clause for any LEFT
  117385. ** JOIN for which the current table is not the rhs are omitted
  117386. ** from the cursor-hint.
  117387. **
  117388. ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
  117389. ** that were specified as part of the WHERE clause must be excluded.
  117390. ** This is to address the following:
  117391. **
  117392. ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
  117393. **
  117394. ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
  117395. ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
  117396. ** pushed down to the cursor, this row is filtered out, causing
  117397. ** SQLite to synthesize a row of NULL values. Which does match the
  117398. ** WHERE clause, and so the query returns a row. Which is incorrect.
  117399. **
  117400. ** For the same reason, WHERE terms such as:
  117401. **
  117402. ** WHERE 1 = (t2.c IS NULL)
  117403. **
  117404. ** are also excluded. See codeCursorHintIsOrFunction() for details.
  117405. */
  117406. if( pTabItem->fg.jointype & JT_LEFT ){
  117407. Expr *pExpr = pTerm->pExpr;
  117408. if( !ExprHasProperty(pExpr, EP_FromJoin)
  117409. || pExpr->iRightJoinTable!=pTabItem->iCursor
  117410. ){
  117411. sWalker.eCode = 0;
  117412. sWalker.xExprCallback = codeCursorHintIsOrFunction;
  117413. sqlite3WalkExpr(&sWalker, pTerm->pExpr);
  117414. if( sWalker.eCode ) continue;
  117415. }
  117416. }else{
  117417. if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
  117418. }
  117419. /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
  117420. ** the cursor. These terms are not needed as hints for a pure range
  117421. ** scan (that has no == terms) so omit them. */
  117422. if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
  117423. for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
  117424. if( j<pLoop->nLTerm ) continue;
  117425. }
  117426. /* No subqueries or non-deterministic functions allowed */
  117427. if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
  117428. /* For an index scan, make sure referenced columns are actually in
  117429. ** the index. */
  117430. if( sHint.pIdx!=0 ){
  117431. sWalker.eCode = 0;
  117432. sWalker.xExprCallback = codeCursorHintCheckExpr;
  117433. sqlite3WalkExpr(&sWalker, pTerm->pExpr);
  117434. if( sWalker.eCode ) continue;
  117435. }
  117436. /* If we survive all prior tests, that means this term is worth hinting */
  117437. pExpr = sqlite3ExprAnd(db, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
  117438. }
  117439. if( pExpr!=0 ){
  117440. sWalker.xExprCallback = codeCursorHintFixExpr;
  117441. sqlite3WalkExpr(&sWalker, pExpr);
  117442. sqlite3VdbeAddOp4(v, OP_CursorHint,
  117443. (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
  117444. (const char*)pExpr, P4_EXPR);
  117445. }
  117446. }
  117447. #else
  117448. # define codeCursorHint(A,B,C,D) /* No-op */
  117449. #endif /* SQLITE_ENABLE_CURSOR_HINTS */
  117450. /*
  117451. ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
  117452. ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
  117453. ** function generates code to do a deferred seek of cursor iCur to the
  117454. ** rowid stored in register iRowid.
  117455. **
  117456. ** Normally, this is just:
  117457. **
  117458. ** OP_Seek $iCur $iRowid
  117459. **
  117460. ** However, if the scan currently being coded is a branch of an OR-loop and
  117461. ** the statement currently being coded is a SELECT, then P3 of the OP_Seek
  117462. ** is set to iIdxCur and P4 is set to point to an array of integers
  117463. ** containing one entry for each column of the table cursor iCur is open
  117464. ** on. For each table column, if the column is the i'th column of the
  117465. ** index, then the corresponding array entry is set to (i+1). If the column
  117466. ** does not appear in the index at all, the array entry is set to 0.
  117467. */
  117468. static void codeDeferredSeek(
  117469. WhereInfo *pWInfo, /* Where clause context */
  117470. Index *pIdx, /* Index scan is using */
  117471. int iCur, /* Cursor for IPK b-tree */
  117472. int iIdxCur /* Index cursor */
  117473. ){
  117474. Parse *pParse = pWInfo->pParse; /* Parse context */
  117475. Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
  117476. assert( iIdxCur>0 );
  117477. assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
  117478. sqlite3VdbeAddOp3(v, OP_Seek, iIdxCur, 0, iCur);
  117479. if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
  117480. && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
  117481. ){
  117482. int i;
  117483. Table *pTab = pIdx->pTable;
  117484. int *ai = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*(pTab->nCol+1));
  117485. if( ai ){
  117486. ai[0] = pTab->nCol;
  117487. for(i=0; i<pIdx->nColumn-1; i++){
  117488. assert( pIdx->aiColumn[i]<pTab->nCol );
  117489. if( pIdx->aiColumn[i]>=0 ) ai[pIdx->aiColumn[i]+1] = i+1;
  117490. }
  117491. sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
  117492. }
  117493. }
  117494. }
  117495. /*
  117496. ** If the expression passed as the second argument is a vector, generate
  117497. ** code to write the first nReg elements of the vector into an array
  117498. ** of registers starting with iReg.
  117499. **
  117500. ** If the expression is not a vector, then nReg must be passed 1. In
  117501. ** this case, generate code to evaluate the expression and leave the
  117502. ** result in register iReg.
  117503. */
  117504. static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
  117505. assert( nReg>0 );
  117506. if( sqlite3ExprIsVector(p) ){
  117507. #ifndef SQLITE_OMIT_SUBQUERY
  117508. if( (p->flags & EP_xIsSelect) ){
  117509. Vdbe *v = pParse->pVdbe;
  117510. int iSelect = sqlite3CodeSubselect(pParse, p, 0, 0);
  117511. sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
  117512. }else
  117513. #endif
  117514. {
  117515. int i;
  117516. ExprList *pList = p->x.pList;
  117517. assert( nReg<=pList->nExpr );
  117518. for(i=0; i<nReg; i++){
  117519. sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
  117520. }
  117521. }
  117522. }else{
  117523. assert( nReg==1 );
  117524. sqlite3ExprCode(pParse, p, iReg);
  117525. }
  117526. }
  117527. /*
  117528. ** Generate code for the start of the iLevel-th loop in the WHERE clause
  117529. ** implementation described by pWInfo.
  117530. */
  117531. SQLITE_PRIVATE Bitmask sqlite3WhereCodeOneLoopStart(
  117532. WhereInfo *pWInfo, /* Complete information about the WHERE clause */
  117533. int iLevel, /* Which level of pWInfo->a[] should be coded */
  117534. Bitmask notReady /* Which tables are currently available */
  117535. ){
  117536. int j, k; /* Loop counters */
  117537. int iCur; /* The VDBE cursor for the table */
  117538. int addrNxt; /* Where to jump to continue with the next IN case */
  117539. int omitTable; /* True if we use the index only */
  117540. int bRev; /* True if we need to scan in reverse order */
  117541. WhereLevel *pLevel; /* The where level to be coded */
  117542. WhereLoop *pLoop; /* The WhereLoop object being coded */
  117543. WhereClause *pWC; /* Decomposition of the entire WHERE clause */
  117544. WhereTerm *pTerm; /* A WHERE clause term */
  117545. Parse *pParse; /* Parsing context */
  117546. sqlite3 *db; /* Database connection */
  117547. Vdbe *v; /* The prepared stmt under constructions */
  117548. struct SrcList_item *pTabItem; /* FROM clause term being coded */
  117549. int addrBrk; /* Jump here to break out of the loop */
  117550. int addrCont; /* Jump here to continue with next cycle */
  117551. int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
  117552. int iReleaseReg = 0; /* Temp register to free before returning */
  117553. pParse = pWInfo->pParse;
  117554. v = pParse->pVdbe;
  117555. pWC = &pWInfo->sWC;
  117556. db = pParse->db;
  117557. pLevel = &pWInfo->a[iLevel];
  117558. pLoop = pLevel->pWLoop;
  117559. pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
  117560. iCur = pTabItem->iCursor;
  117561. pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
  117562. bRev = (pWInfo->revMask>>iLevel)&1;
  117563. omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
  117564. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
  117565. VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
  117566. /* Create labels for the "break" and "continue" instructions
  117567. ** for the current loop. Jump to addrBrk to break out of a loop.
  117568. ** Jump to cont to go immediately to the next iteration of the
  117569. ** loop.
  117570. **
  117571. ** When there is an IN operator, we also have a "addrNxt" label that
  117572. ** means to continue with the next IN value combination. When
  117573. ** there are no IN operators in the constraints, the "addrNxt" label
  117574. ** is the same as "addrBrk".
  117575. */
  117576. addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
  117577. addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
  117578. /* If this is the right table of a LEFT OUTER JOIN, allocate and
  117579. ** initialize a memory cell that records if this table matches any
  117580. ** row of the left table of the join.
  117581. */
  117582. if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
  117583. pLevel->iLeftJoin = ++pParse->nMem;
  117584. sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
  117585. VdbeComment((v, "init LEFT JOIN no-match flag"));
  117586. }
  117587. /* Special case of a FROM clause subquery implemented as a co-routine */
  117588. if( pTabItem->fg.viaCoroutine ){
  117589. int regYield = pTabItem->regReturn;
  117590. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
  117591. pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
  117592. VdbeCoverage(v);
  117593. VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
  117594. pLevel->op = OP_Goto;
  117595. }else
  117596. #ifndef SQLITE_OMIT_VIRTUALTABLE
  117597. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
  117598. /* Case 1: The table is a virtual-table. Use the VFilter and VNext
  117599. ** to access the data.
  117600. */
  117601. int iReg; /* P3 Value for OP_VFilter */
  117602. int addrNotFound;
  117603. int nConstraint = pLoop->nLTerm;
  117604. int iIn; /* Counter for IN constraints */
  117605. sqlite3ExprCachePush(pParse);
  117606. iReg = sqlite3GetTempRange(pParse, nConstraint+2);
  117607. addrNotFound = pLevel->addrBrk;
  117608. for(j=0; j<nConstraint; j++){
  117609. int iTarget = iReg+j+2;
  117610. pTerm = pLoop->aLTerm[j];
  117611. if( NEVER(pTerm==0) ) continue;
  117612. if( pTerm->eOperator & WO_IN ){
  117613. codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
  117614. addrNotFound = pLevel->addrNxt;
  117615. }else{
  117616. Expr *pRight = pTerm->pExpr->pRight;
  117617. codeExprOrVector(pParse, pRight, iTarget, 1);
  117618. }
  117619. }
  117620. sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
  117621. sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
  117622. sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
  117623. pLoop->u.vtab.idxStr,
  117624. pLoop->u.vtab.needFree ? P4_MPRINTF : P4_STATIC);
  117625. VdbeCoverage(v);
  117626. pLoop->u.vtab.needFree = 0;
  117627. pLevel->p1 = iCur;
  117628. pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
  117629. pLevel->p2 = sqlite3VdbeCurrentAddr(v);
  117630. iIn = pLevel->u.in.nIn;
  117631. for(j=nConstraint-1; j>=0; j--){
  117632. pTerm = pLoop->aLTerm[j];
  117633. if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
  117634. disableTerm(pLevel, pTerm);
  117635. }else if( (pTerm->eOperator & WO_IN)!=0 ){
  117636. Expr *pCompare; /* The comparison operator */
  117637. Expr *pRight; /* RHS of the comparison */
  117638. VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
  117639. /* Reload the constraint value into reg[iReg+j+2]. The same value
  117640. ** was loaded into the same register prior to the OP_VFilter, but
  117641. ** the xFilter implementation might have changed the datatype or
  117642. ** encoding of the value in the register, so it *must* be reloaded. */
  117643. assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
  117644. if( !db->mallocFailed ){
  117645. assert( iIn>0 );
  117646. pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[--iIn].addrInTop);
  117647. assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
  117648. assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
  117649. assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
  117650. testcase( pOp->opcode==OP_Rowid );
  117651. sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
  117652. }
  117653. /* Generate code that will continue to the next row if
  117654. ** the IN constraint is not satisfied */
  117655. pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0, 0);
  117656. assert( pCompare!=0 || db->mallocFailed );
  117657. if( pCompare ){
  117658. pCompare->pLeft = pTerm->pExpr->pLeft;
  117659. pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
  117660. if( pRight ){
  117661. pRight->iTable = iReg+j+2;
  117662. sqlite3ExprIfFalse(pParse, pCompare, pLevel->addrCont, 0);
  117663. }
  117664. pCompare->pLeft = 0;
  117665. sqlite3ExprDelete(db, pCompare);
  117666. }
  117667. }
  117668. }
  117669. /* These registers need to be preserved in case there is an IN operator
  117670. ** loop. So we could deallocate the registers here (and potentially
  117671. ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
  117672. ** simpler and safer to simply not reuse the registers.
  117673. **
  117674. ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
  117675. */
  117676. sqlite3ExprCachePop(pParse);
  117677. }else
  117678. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  117679. if( (pLoop->wsFlags & WHERE_IPK)!=0
  117680. && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
  117681. ){
  117682. /* Case 2: We can directly reference a single row using an
  117683. ** equality comparison against the ROWID field. Or
  117684. ** we reference multiple rows using a "rowid IN (...)"
  117685. ** construct.
  117686. */
  117687. assert( pLoop->u.btree.nEq==1 );
  117688. pTerm = pLoop->aLTerm[0];
  117689. assert( pTerm!=0 );
  117690. assert( pTerm->pExpr!=0 );
  117691. assert( omitTable==0 );
  117692. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  117693. iReleaseReg = ++pParse->nMem;
  117694. iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
  117695. if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
  117696. addrNxt = pLevel->addrNxt;
  117697. sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
  117698. VdbeCoverage(v);
  117699. sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
  117700. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  117701. VdbeComment((v, "pk"));
  117702. pLevel->op = OP_Noop;
  117703. }else if( (pLoop->wsFlags & WHERE_IPK)!=0
  117704. && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
  117705. ){
  117706. /* Case 3: We have an inequality comparison against the ROWID field.
  117707. */
  117708. int testOp = OP_Noop;
  117709. int start;
  117710. int memEndValue = 0;
  117711. WhereTerm *pStart, *pEnd;
  117712. assert( omitTable==0 );
  117713. j = 0;
  117714. pStart = pEnd = 0;
  117715. if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
  117716. if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
  117717. assert( pStart!=0 || pEnd!=0 );
  117718. if( bRev ){
  117719. pTerm = pStart;
  117720. pStart = pEnd;
  117721. pEnd = pTerm;
  117722. }
  117723. codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
  117724. if( pStart ){
  117725. Expr *pX; /* The expression that defines the start bound */
  117726. int r1, rTemp; /* Registers for holding the start boundary */
  117727. int op; /* Cursor seek operation */
  117728. /* The following constant maps TK_xx codes into corresponding
  117729. ** seek opcodes. It depends on a particular ordering of TK_xx
  117730. */
  117731. const u8 aMoveOp[] = {
  117732. /* TK_GT */ OP_SeekGT,
  117733. /* TK_LE */ OP_SeekLE,
  117734. /* TK_LT */ OP_SeekLT,
  117735. /* TK_GE */ OP_SeekGE
  117736. };
  117737. assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
  117738. assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
  117739. assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
  117740. assert( (pStart->wtFlags & TERM_VNULL)==0 );
  117741. testcase( pStart->wtFlags & TERM_VIRTUAL );
  117742. pX = pStart->pExpr;
  117743. assert( pX!=0 );
  117744. testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
  117745. if( sqlite3ExprIsVector(pX->pRight) ){
  117746. r1 = rTemp = sqlite3GetTempReg(pParse);
  117747. codeExprOrVector(pParse, pX->pRight, r1, 1);
  117748. op = aMoveOp[(pX->op - TK_GT) | 0x0001];
  117749. }else{
  117750. r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
  117751. disableTerm(pLevel, pStart);
  117752. op = aMoveOp[(pX->op - TK_GT)];
  117753. }
  117754. sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
  117755. VdbeComment((v, "pk"));
  117756. VdbeCoverageIf(v, pX->op==TK_GT);
  117757. VdbeCoverageIf(v, pX->op==TK_LE);
  117758. VdbeCoverageIf(v, pX->op==TK_LT);
  117759. VdbeCoverageIf(v, pX->op==TK_GE);
  117760. sqlite3ExprCacheAffinityChange(pParse, r1, 1);
  117761. sqlite3ReleaseTempReg(pParse, rTemp);
  117762. }else{
  117763. sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
  117764. VdbeCoverageIf(v, bRev==0);
  117765. VdbeCoverageIf(v, bRev!=0);
  117766. }
  117767. if( pEnd ){
  117768. Expr *pX;
  117769. pX = pEnd->pExpr;
  117770. assert( pX!=0 );
  117771. assert( (pEnd->wtFlags & TERM_VNULL)==0 );
  117772. testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
  117773. testcase( pEnd->wtFlags & TERM_VIRTUAL );
  117774. memEndValue = ++pParse->nMem;
  117775. codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
  117776. if( 0==sqlite3ExprIsVector(pX->pRight)
  117777. && (pX->op==TK_LT || pX->op==TK_GT)
  117778. ){
  117779. testOp = bRev ? OP_Le : OP_Ge;
  117780. }else{
  117781. testOp = bRev ? OP_Lt : OP_Gt;
  117782. }
  117783. if( 0==sqlite3ExprIsVector(pX->pRight) ){
  117784. disableTerm(pLevel, pEnd);
  117785. }
  117786. }
  117787. start = sqlite3VdbeCurrentAddr(v);
  117788. pLevel->op = bRev ? OP_Prev : OP_Next;
  117789. pLevel->p1 = iCur;
  117790. pLevel->p2 = start;
  117791. assert( pLevel->p5==0 );
  117792. if( testOp!=OP_Noop ){
  117793. iRowidReg = ++pParse->nMem;
  117794. sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
  117795. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  117796. sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
  117797. VdbeCoverageIf(v, testOp==OP_Le);
  117798. VdbeCoverageIf(v, testOp==OP_Lt);
  117799. VdbeCoverageIf(v, testOp==OP_Ge);
  117800. VdbeCoverageIf(v, testOp==OP_Gt);
  117801. sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
  117802. }
  117803. }else if( pLoop->wsFlags & WHERE_INDEXED ){
  117804. /* Case 4: A scan using an index.
  117805. **
  117806. ** The WHERE clause may contain zero or more equality
  117807. ** terms ("==" or "IN" operators) that refer to the N
  117808. ** left-most columns of the index. It may also contain
  117809. ** inequality constraints (>, <, >= or <=) on the indexed
  117810. ** column that immediately follows the N equalities. Only
  117811. ** the right-most column can be an inequality - the rest must
  117812. ** use the "==" and "IN" operators. For example, if the
  117813. ** index is on (x,y,z), then the following clauses are all
  117814. ** optimized:
  117815. **
  117816. ** x=5
  117817. ** x=5 AND y=10
  117818. ** x=5 AND y<10
  117819. ** x=5 AND y>5 AND y<10
  117820. ** x=5 AND y=5 AND z<=10
  117821. **
  117822. ** The z<10 term of the following cannot be used, only
  117823. ** the x=5 term:
  117824. **
  117825. ** x=5 AND z<10
  117826. **
  117827. ** N may be zero if there are inequality constraints.
  117828. ** If there are no inequality constraints, then N is at
  117829. ** least one.
  117830. **
  117831. ** This case is also used when there are no WHERE clause
  117832. ** constraints but an index is selected anyway, in order
  117833. ** to force the output order to conform to an ORDER BY.
  117834. */
  117835. static const u8 aStartOp[] = {
  117836. 0,
  117837. 0,
  117838. OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
  117839. OP_Last, /* 3: (!start_constraints && startEq && bRev) */
  117840. OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
  117841. OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
  117842. OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
  117843. OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
  117844. };
  117845. static const u8 aEndOp[] = {
  117846. OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
  117847. OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
  117848. OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
  117849. OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
  117850. };
  117851. u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
  117852. u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
  117853. u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
  117854. int regBase; /* Base register holding constraint values */
  117855. WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
  117856. WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
  117857. int startEq; /* True if range start uses ==, >= or <= */
  117858. int endEq; /* True if range end uses ==, >= or <= */
  117859. int start_constraints; /* Start of range is constrained */
  117860. int nConstraint; /* Number of constraint terms */
  117861. Index *pIdx; /* The index we will be using */
  117862. int iIdxCur; /* The VDBE cursor for the index */
  117863. int nExtraReg = 0; /* Number of extra registers needed */
  117864. int op; /* Instruction opcode */
  117865. char *zStartAff; /* Affinity for start of range constraint */
  117866. char *zEndAff = 0; /* Affinity for end of range constraint */
  117867. u8 bSeekPastNull = 0; /* True to seek past initial nulls */
  117868. u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
  117869. pIdx = pLoop->u.btree.pIndex;
  117870. iIdxCur = pLevel->iIdxCur;
  117871. assert( nEq>=pLoop->nSkip );
  117872. /* If this loop satisfies a sort order (pOrderBy) request that
  117873. ** was passed to this function to implement a "SELECT min(x) ..."
  117874. ** query, then the caller will only allow the loop to run for
  117875. ** a single iteration. This means that the first row returned
  117876. ** should not have a NULL value stored in 'x'. If column 'x' is
  117877. ** the first one after the nEq equality constraints in the index,
  117878. ** this requires some special handling.
  117879. */
  117880. assert( pWInfo->pOrderBy==0
  117881. || pWInfo->pOrderBy->nExpr==1
  117882. || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
  117883. if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
  117884. && pWInfo->nOBSat>0
  117885. && (pIdx->nKeyCol>nEq)
  117886. ){
  117887. assert( pLoop->nSkip==0 );
  117888. bSeekPastNull = 1;
  117889. nExtraReg = 1;
  117890. }
  117891. /* Find any inequality constraint terms for the start and end
  117892. ** of the range.
  117893. */
  117894. j = nEq;
  117895. if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
  117896. pRangeStart = pLoop->aLTerm[j++];
  117897. nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
  117898. /* Like optimization range constraints always occur in pairs */
  117899. assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
  117900. (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
  117901. }
  117902. if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
  117903. pRangeEnd = pLoop->aLTerm[j++];
  117904. nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
  117905. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  117906. if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
  117907. assert( pRangeStart!=0 ); /* LIKE opt constraints */
  117908. assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
  117909. pLevel->iLikeRepCntr = (u32)++pParse->nMem;
  117910. sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
  117911. VdbeComment((v, "LIKE loop counter"));
  117912. pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
  117913. /* iLikeRepCntr actually stores 2x the counter register number. The
  117914. ** bottom bit indicates whether the search order is ASC or DESC. */
  117915. testcase( bRev );
  117916. testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
  117917. assert( (bRev & ~1)==0 );
  117918. pLevel->iLikeRepCntr <<=1;
  117919. pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
  117920. }
  117921. #endif
  117922. if( pRangeStart==0 ){
  117923. j = pIdx->aiColumn[nEq];
  117924. if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
  117925. bSeekPastNull = 1;
  117926. }
  117927. }
  117928. }
  117929. assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
  117930. /* If we are doing a reverse order scan on an ascending index, or
  117931. ** a forward order scan on a descending index, interchange the
  117932. ** start and end terms (pRangeStart and pRangeEnd).
  117933. */
  117934. if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
  117935. || (bRev && pIdx->nKeyCol==nEq)
  117936. ){
  117937. SWAP(WhereTerm *, pRangeEnd, pRangeStart);
  117938. SWAP(u8, bSeekPastNull, bStopAtNull);
  117939. SWAP(u8, nBtm, nTop);
  117940. }
  117941. /* Generate code to evaluate all constraint terms using == or IN
  117942. ** and store the values of those terms in an array of registers
  117943. ** starting at regBase.
  117944. */
  117945. codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
  117946. regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
  117947. assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
  117948. if( zStartAff && nTop ){
  117949. zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
  117950. }
  117951. addrNxt = pLevel->addrNxt;
  117952. testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
  117953. testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
  117954. testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
  117955. testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
  117956. startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
  117957. endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
  117958. start_constraints = pRangeStart || nEq>0;
  117959. /* Seek the index cursor to the start of the range. */
  117960. nConstraint = nEq;
  117961. if( pRangeStart ){
  117962. Expr *pRight = pRangeStart->pExpr->pRight;
  117963. codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
  117964. whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
  117965. if( (pRangeStart->wtFlags & TERM_VNULL)==0
  117966. && sqlite3ExprCanBeNull(pRight)
  117967. ){
  117968. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
  117969. VdbeCoverage(v);
  117970. }
  117971. if( zStartAff ){
  117972. updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
  117973. }
  117974. nConstraint += nBtm;
  117975. testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
  117976. if( sqlite3ExprIsVector(pRight)==0 ){
  117977. disableTerm(pLevel, pRangeStart);
  117978. }else{
  117979. startEq = 1;
  117980. }
  117981. bSeekPastNull = 0;
  117982. }else if( bSeekPastNull ){
  117983. sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
  117984. nConstraint++;
  117985. startEq = 0;
  117986. start_constraints = 1;
  117987. }
  117988. codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
  117989. if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
  117990. /* The skip-scan logic inside the call to codeAllEqualityConstraints()
  117991. ** above has already left the cursor sitting on the correct row,
  117992. ** so no further seeking is needed */
  117993. }else{
  117994. op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
  117995. assert( op!=0 );
  117996. sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
  117997. VdbeCoverage(v);
  117998. VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
  117999. VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
  118000. VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
  118001. VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
  118002. VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
  118003. VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
  118004. }
  118005. /* Load the value for the inequality constraint at the end of the
  118006. ** range (if any).
  118007. */
  118008. nConstraint = nEq;
  118009. if( pRangeEnd ){
  118010. Expr *pRight = pRangeEnd->pExpr->pRight;
  118011. sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
  118012. codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
  118013. whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
  118014. if( (pRangeEnd->wtFlags & TERM_VNULL)==0
  118015. && sqlite3ExprCanBeNull(pRight)
  118016. ){
  118017. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
  118018. VdbeCoverage(v);
  118019. }
  118020. if( zEndAff ){
  118021. updateRangeAffinityStr(pRight, nTop, zEndAff);
  118022. codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
  118023. }else{
  118024. assert( pParse->db->mallocFailed );
  118025. }
  118026. nConstraint += nTop;
  118027. testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
  118028. if( sqlite3ExprIsVector(pRight)==0 ){
  118029. disableTerm(pLevel, pRangeEnd);
  118030. }else{
  118031. endEq = 1;
  118032. }
  118033. }else if( bStopAtNull ){
  118034. sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
  118035. endEq = 0;
  118036. nConstraint++;
  118037. }
  118038. sqlite3DbFree(db, zStartAff);
  118039. sqlite3DbFree(db, zEndAff);
  118040. /* Top of the loop body */
  118041. pLevel->p2 = sqlite3VdbeCurrentAddr(v);
  118042. /* Check if the index cursor is past the end of the range. */
  118043. if( nConstraint ){
  118044. op = aEndOp[bRev*2 + endEq];
  118045. sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
  118046. testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
  118047. testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
  118048. testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
  118049. testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
  118050. }
  118051. /* Seek the table cursor, if required */
  118052. if( omitTable ){
  118053. /* pIdx is a covering index. No need to access the main table. */
  118054. }else if( HasRowid(pIdx->pTable) ){
  118055. if( (pWInfo->wctrlFlags & WHERE_SEEK_TABLE)!=0 ){
  118056. iRowidReg = ++pParse->nMem;
  118057. sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
  118058. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  118059. sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, iRowidReg);
  118060. VdbeCoverage(v);
  118061. }else{
  118062. codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
  118063. }
  118064. }else if( iCur!=iIdxCur ){
  118065. Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
  118066. iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
  118067. for(j=0; j<pPk->nKeyCol; j++){
  118068. k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
  118069. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
  118070. }
  118071. sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
  118072. iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
  118073. }
  118074. /* Record the instruction used to terminate the loop. */
  118075. if( pLoop->wsFlags & WHERE_ONEROW ){
  118076. pLevel->op = OP_Noop;
  118077. }else if( bRev ){
  118078. pLevel->op = OP_Prev;
  118079. }else{
  118080. pLevel->op = OP_Next;
  118081. }
  118082. pLevel->p1 = iIdxCur;
  118083. pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
  118084. if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
  118085. pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
  118086. }else{
  118087. assert( pLevel->p5==0 );
  118088. }
  118089. }else
  118090. #ifndef SQLITE_OMIT_OR_OPTIMIZATION
  118091. if( pLoop->wsFlags & WHERE_MULTI_OR ){
  118092. /* Case 5: Two or more separately indexed terms connected by OR
  118093. **
  118094. ** Example:
  118095. **
  118096. ** CREATE TABLE t1(a,b,c,d);
  118097. ** CREATE INDEX i1 ON t1(a);
  118098. ** CREATE INDEX i2 ON t1(b);
  118099. ** CREATE INDEX i3 ON t1(c);
  118100. **
  118101. ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
  118102. **
  118103. ** In the example, there are three indexed terms connected by OR.
  118104. ** The top of the loop looks like this:
  118105. **
  118106. ** Null 1 # Zero the rowset in reg 1
  118107. **
  118108. ** Then, for each indexed term, the following. The arguments to
  118109. ** RowSetTest are such that the rowid of the current row is inserted
  118110. ** into the RowSet. If it is already present, control skips the
  118111. ** Gosub opcode and jumps straight to the code generated by WhereEnd().
  118112. **
  118113. ** sqlite3WhereBegin(<term>)
  118114. ** RowSetTest # Insert rowid into rowset
  118115. ** Gosub 2 A
  118116. ** sqlite3WhereEnd()
  118117. **
  118118. ** Following the above, code to terminate the loop. Label A, the target
  118119. ** of the Gosub above, jumps to the instruction right after the Goto.
  118120. **
  118121. ** Null 1 # Zero the rowset in reg 1
  118122. ** Goto B # The loop is finished.
  118123. **
  118124. ** A: <loop body> # Return data, whatever.
  118125. **
  118126. ** Return 2 # Jump back to the Gosub
  118127. **
  118128. ** B: <after the loop>
  118129. **
  118130. ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
  118131. ** use an ephemeral index instead of a RowSet to record the primary
  118132. ** keys of the rows we have already seen.
  118133. **
  118134. */
  118135. WhereClause *pOrWc; /* The OR-clause broken out into subterms */
  118136. SrcList *pOrTab; /* Shortened table list or OR-clause generation */
  118137. Index *pCov = 0; /* Potential covering index (or NULL) */
  118138. int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
  118139. int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
  118140. int regRowset = 0; /* Register for RowSet object */
  118141. int regRowid = 0; /* Register holding rowid */
  118142. int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
  118143. int iRetInit; /* Address of regReturn init */
  118144. int untestedTerms = 0; /* Some terms not completely tested */
  118145. int ii; /* Loop counter */
  118146. u16 wctrlFlags; /* Flags for sub-WHERE clause */
  118147. Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
  118148. Table *pTab = pTabItem->pTab;
  118149. pTerm = pLoop->aLTerm[0];
  118150. assert( pTerm!=0 );
  118151. assert( pTerm->eOperator & WO_OR );
  118152. assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
  118153. pOrWc = &pTerm->u.pOrInfo->wc;
  118154. pLevel->op = OP_Return;
  118155. pLevel->p1 = regReturn;
  118156. /* Set up a new SrcList in pOrTab containing the table being scanned
  118157. ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
  118158. ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
  118159. */
  118160. if( pWInfo->nLevel>1 ){
  118161. int nNotReady; /* The number of notReady tables */
  118162. struct SrcList_item *origSrc; /* Original list of tables */
  118163. nNotReady = pWInfo->nLevel - iLevel - 1;
  118164. pOrTab = sqlite3StackAllocRaw(db,
  118165. sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
  118166. if( pOrTab==0 ) return notReady;
  118167. pOrTab->nAlloc = (u8)(nNotReady + 1);
  118168. pOrTab->nSrc = pOrTab->nAlloc;
  118169. memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
  118170. origSrc = pWInfo->pTabList->a;
  118171. for(k=1; k<=nNotReady; k++){
  118172. memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
  118173. }
  118174. }else{
  118175. pOrTab = pWInfo->pTabList;
  118176. }
  118177. /* Initialize the rowset register to contain NULL. An SQL NULL is
  118178. ** equivalent to an empty rowset. Or, create an ephemeral index
  118179. ** capable of holding primary keys in the case of a WITHOUT ROWID.
  118180. **
  118181. ** Also initialize regReturn to contain the address of the instruction
  118182. ** immediately following the OP_Return at the bottom of the loop. This
  118183. ** is required in a few obscure LEFT JOIN cases where control jumps
  118184. ** over the top of the loop into the body of it. In this case the
  118185. ** correct response for the end-of-loop code (the OP_Return) is to
  118186. ** fall through to the next instruction, just as an OP_Next does if
  118187. ** called on an uninitialized cursor.
  118188. */
  118189. if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
  118190. if( HasRowid(pTab) ){
  118191. regRowset = ++pParse->nMem;
  118192. sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
  118193. }else{
  118194. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  118195. regRowset = pParse->nTab++;
  118196. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
  118197. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  118198. }
  118199. regRowid = ++pParse->nMem;
  118200. }
  118201. iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
  118202. /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
  118203. ** Then for every term xN, evaluate as the subexpression: xN AND z
  118204. ** That way, terms in y that are factored into the disjunction will
  118205. ** be picked up by the recursive calls to sqlite3WhereBegin() below.
  118206. **
  118207. ** Actually, each subexpression is converted to "xN AND w" where w is
  118208. ** the "interesting" terms of z - terms that did not originate in the
  118209. ** ON or USING clause of a LEFT JOIN, and terms that are usable as
  118210. ** indices.
  118211. **
  118212. ** This optimization also only applies if the (x1 OR x2 OR ...) term
  118213. ** is not contained in the ON clause of a LEFT JOIN.
  118214. ** See ticket http://www.sqlite.org/src/info/f2369304e4
  118215. */
  118216. if( pWC->nTerm>1 ){
  118217. int iTerm;
  118218. for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
  118219. Expr *pExpr = pWC->a[iTerm].pExpr;
  118220. if( &pWC->a[iTerm] == pTerm ) continue;
  118221. if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
  118222. testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
  118223. testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
  118224. if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
  118225. if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
  118226. testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
  118227. pExpr = sqlite3ExprDup(db, pExpr, 0);
  118228. pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
  118229. }
  118230. if( pAndExpr ){
  118231. pAndExpr = sqlite3PExpr(pParse, TK_AND|TKFLG_DONTFOLD, 0, pAndExpr, 0);
  118232. }
  118233. }
  118234. /* Run a separate WHERE clause for each term of the OR clause. After
  118235. ** eliminating duplicates from other WHERE clauses, the action for each
  118236. ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
  118237. */
  118238. wctrlFlags = WHERE_OR_SUBCLAUSE | (pWInfo->wctrlFlags & WHERE_SEEK_TABLE);
  118239. for(ii=0; ii<pOrWc->nTerm; ii++){
  118240. WhereTerm *pOrTerm = &pOrWc->a[ii];
  118241. if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
  118242. WhereInfo *pSubWInfo; /* Info for single OR-term scan */
  118243. Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
  118244. int jmp1 = 0; /* Address of jump operation */
  118245. if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
  118246. pAndExpr->pLeft = pOrExpr;
  118247. pOrExpr = pAndExpr;
  118248. }
  118249. /* Loop through table entries that match term pOrTerm. */
  118250. WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
  118251. pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
  118252. wctrlFlags, iCovCur);
  118253. assert( pSubWInfo || pParse->nErr || db->mallocFailed );
  118254. if( pSubWInfo ){
  118255. WhereLoop *pSubLoop;
  118256. int addrExplain = sqlite3WhereExplainOneScan(
  118257. pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
  118258. );
  118259. sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
  118260. /* This is the sub-WHERE clause body. First skip over
  118261. ** duplicate rows from prior sub-WHERE clauses, and record the
  118262. ** rowid (or PRIMARY KEY) for the current row so that the same
  118263. ** row will be skipped in subsequent sub-WHERE clauses.
  118264. */
  118265. if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
  118266. int r;
  118267. int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
  118268. if( HasRowid(pTab) ){
  118269. r = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iCur, regRowid, 0);
  118270. jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
  118271. r,iSet);
  118272. VdbeCoverage(v);
  118273. }else{
  118274. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  118275. int nPk = pPk->nKeyCol;
  118276. int iPk;
  118277. /* Read the PK into an array of temp registers. */
  118278. r = sqlite3GetTempRange(pParse, nPk);
  118279. for(iPk=0; iPk<nPk; iPk++){
  118280. int iCol = pPk->aiColumn[iPk];
  118281. sqlite3ExprCodeGetColumnToReg(pParse, pTab, iCol, iCur, r+iPk);
  118282. }
  118283. /* Check if the temp table already contains this key. If so,
  118284. ** the row has already been included in the result set and
  118285. ** can be ignored (by jumping past the Gosub below). Otherwise,
  118286. ** insert the key into the temp table and proceed with processing
  118287. ** the row.
  118288. **
  118289. ** Use some of the same optimizations as OP_RowSetTest: If iSet
  118290. ** is zero, assume that the key cannot already be present in
  118291. ** the temp table. And if iSet is -1, assume that there is no
  118292. ** need to insert the key into the temp table, as it will never
  118293. ** be tested for. */
  118294. if( iSet ){
  118295. jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
  118296. VdbeCoverage(v);
  118297. }
  118298. if( iSet>=0 ){
  118299. sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
  118300. sqlite3VdbeAddOp3(v, OP_IdxInsert, regRowset, regRowid, 0);
  118301. if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  118302. }
  118303. /* Release the array of temp registers */
  118304. sqlite3ReleaseTempRange(pParse, r, nPk);
  118305. }
  118306. }
  118307. /* Invoke the main loop body as a subroutine */
  118308. sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
  118309. /* Jump here (skipping the main loop body subroutine) if the
  118310. ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
  118311. if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
  118312. /* The pSubWInfo->untestedTerms flag means that this OR term
  118313. ** contained one or more AND term from a notReady table. The
  118314. ** terms from the notReady table could not be tested and will
  118315. ** need to be tested later.
  118316. */
  118317. if( pSubWInfo->untestedTerms ) untestedTerms = 1;
  118318. /* If all of the OR-connected terms are optimized using the same
  118319. ** index, and the index is opened using the same cursor number
  118320. ** by each call to sqlite3WhereBegin() made by this loop, it may
  118321. ** be possible to use that index as a covering index.
  118322. **
  118323. ** If the call to sqlite3WhereBegin() above resulted in a scan that
  118324. ** uses an index, and this is either the first OR-connected term
  118325. ** processed or the index is the same as that used by all previous
  118326. ** terms, set pCov to the candidate covering index. Otherwise, set
  118327. ** pCov to NULL to indicate that no candidate covering index will
  118328. ** be available.
  118329. */
  118330. pSubLoop = pSubWInfo->a[0].pWLoop;
  118331. assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
  118332. if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
  118333. && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
  118334. && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
  118335. ){
  118336. assert( pSubWInfo->a[0].iIdxCur==iCovCur );
  118337. pCov = pSubLoop->u.btree.pIndex;
  118338. }else{
  118339. pCov = 0;
  118340. }
  118341. /* Finish the loop through table entries that match term pOrTerm. */
  118342. sqlite3WhereEnd(pSubWInfo);
  118343. }
  118344. }
  118345. }
  118346. pLevel->u.pCovidx = pCov;
  118347. if( pCov ) pLevel->iIdxCur = iCovCur;
  118348. if( pAndExpr ){
  118349. pAndExpr->pLeft = 0;
  118350. sqlite3ExprDelete(db, pAndExpr);
  118351. }
  118352. sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
  118353. sqlite3VdbeGoto(v, pLevel->addrBrk);
  118354. sqlite3VdbeResolveLabel(v, iLoopBody);
  118355. if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
  118356. if( !untestedTerms ) disableTerm(pLevel, pTerm);
  118357. }else
  118358. #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
  118359. {
  118360. /* Case 6: There is no usable index. We must do a complete
  118361. ** scan of the entire table.
  118362. */
  118363. static const u8 aStep[] = { OP_Next, OP_Prev };
  118364. static const u8 aStart[] = { OP_Rewind, OP_Last };
  118365. assert( bRev==0 || bRev==1 );
  118366. if( pTabItem->fg.isRecursive ){
  118367. /* Tables marked isRecursive have only a single row that is stored in
  118368. ** a pseudo-cursor. No need to Rewind or Next such cursors. */
  118369. pLevel->op = OP_Noop;
  118370. }else{
  118371. codeCursorHint(pTabItem, pWInfo, pLevel, 0);
  118372. pLevel->op = aStep[bRev];
  118373. pLevel->p1 = iCur;
  118374. pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
  118375. VdbeCoverageIf(v, bRev==0);
  118376. VdbeCoverageIf(v, bRev!=0);
  118377. pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
  118378. }
  118379. }
  118380. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  118381. pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
  118382. #endif
  118383. /* Insert code to test every subexpression that can be completely
  118384. ** computed using the current set of tables.
  118385. */
  118386. for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
  118387. Expr *pE;
  118388. int skipLikeAddr = 0;
  118389. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  118390. testcase( pTerm->wtFlags & TERM_CODED );
  118391. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  118392. if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
  118393. testcase( pWInfo->untestedTerms==0
  118394. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
  118395. pWInfo->untestedTerms = 1;
  118396. continue;
  118397. }
  118398. pE = pTerm->pExpr;
  118399. assert( pE!=0 );
  118400. if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
  118401. continue;
  118402. }
  118403. if( pTerm->wtFlags & TERM_LIKECOND ){
  118404. /* If the TERM_LIKECOND flag is set, that means that the range search
  118405. ** is sufficient to guarantee that the LIKE operator is true, so we
  118406. ** can skip the call to the like(A,B) function. But this only works
  118407. ** for strings. So do not skip the call to the function on the pass
  118408. ** that compares BLOBs. */
  118409. #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  118410. continue;
  118411. #else
  118412. u32 x = pLevel->iLikeRepCntr;
  118413. assert( x>0 );
  118414. skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)? OP_IfNot : OP_If, (int)(x>>1));
  118415. VdbeCoverage(v);
  118416. #endif
  118417. }
  118418. sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
  118419. if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
  118420. pTerm->wtFlags |= TERM_CODED;
  118421. }
  118422. /* Insert code to test for implied constraints based on transitivity
  118423. ** of the "==" operator.
  118424. **
  118425. ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
  118426. ** and we are coding the t1 loop and the t2 loop has not yet coded,
  118427. ** then we cannot use the "t1.a=t2.b" constraint, but we can code
  118428. ** the implied "t1.a=123" constraint.
  118429. */
  118430. for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
  118431. Expr *pE, sEAlt;
  118432. WhereTerm *pAlt;
  118433. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  118434. if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
  118435. if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
  118436. if( pTerm->leftCursor!=iCur ) continue;
  118437. if( pLevel->iLeftJoin ) continue;
  118438. pE = pTerm->pExpr;
  118439. assert( !ExprHasProperty(pE, EP_FromJoin) );
  118440. assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
  118441. pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
  118442. WO_EQ|WO_IN|WO_IS, 0);
  118443. if( pAlt==0 ) continue;
  118444. if( pAlt->wtFlags & (TERM_CODED) ) continue;
  118445. testcase( pAlt->eOperator & WO_EQ );
  118446. testcase( pAlt->eOperator & WO_IS );
  118447. testcase( pAlt->eOperator & WO_IN );
  118448. VdbeModuleComment((v, "begin transitive constraint"));
  118449. sEAlt = *pAlt->pExpr;
  118450. sEAlt.pLeft = pE->pLeft;
  118451. sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
  118452. }
  118453. /* For a LEFT OUTER JOIN, generate code that will record the fact that
  118454. ** at least one row of the right table has matched the left table.
  118455. */
  118456. if( pLevel->iLeftJoin ){
  118457. pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
  118458. sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
  118459. VdbeComment((v, "record LEFT JOIN hit"));
  118460. sqlite3ExprCacheClear(pParse);
  118461. for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
  118462. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  118463. testcase( pTerm->wtFlags & TERM_CODED );
  118464. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  118465. if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
  118466. assert( pWInfo->untestedTerms );
  118467. continue;
  118468. }
  118469. assert( pTerm->pExpr );
  118470. sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
  118471. pTerm->wtFlags |= TERM_CODED;
  118472. }
  118473. }
  118474. return pLevel->notReady;
  118475. }
  118476. /************** End of wherecode.c *******************************************/
  118477. /************** Begin file whereexpr.c ***************************************/
  118478. /*
  118479. ** 2015-06-08
  118480. **
  118481. ** The author disclaims copyright to this source code. In place of
  118482. ** a legal notice, here is a blessing:
  118483. **
  118484. ** May you do good and not evil.
  118485. ** May you find forgiveness for yourself and forgive others.
  118486. ** May you share freely, never taking more than you give.
  118487. **
  118488. *************************************************************************
  118489. ** This module contains C code that generates VDBE code used to process
  118490. ** the WHERE clause of SQL statements.
  118491. **
  118492. ** This file was originally part of where.c but was split out to improve
  118493. ** readability and editabiliity. This file contains utility routines for
  118494. ** analyzing Expr objects in the WHERE clause.
  118495. */
  118496. /* #include "sqliteInt.h" */
  118497. /* #include "whereInt.h" */
  118498. /* Forward declarations */
  118499. static void exprAnalyze(SrcList*, WhereClause*, int);
  118500. /*
  118501. ** Deallocate all memory associated with a WhereOrInfo object.
  118502. */
  118503. static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
  118504. sqlite3WhereClauseClear(&p->wc);
  118505. sqlite3DbFree(db, p);
  118506. }
  118507. /*
  118508. ** Deallocate all memory associated with a WhereAndInfo object.
  118509. */
  118510. static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
  118511. sqlite3WhereClauseClear(&p->wc);
  118512. sqlite3DbFree(db, p);
  118513. }
  118514. /*
  118515. ** Add a single new WhereTerm entry to the WhereClause object pWC.
  118516. ** The new WhereTerm object is constructed from Expr p and with wtFlags.
  118517. ** The index in pWC->a[] of the new WhereTerm is returned on success.
  118518. ** 0 is returned if the new WhereTerm could not be added due to a memory
  118519. ** allocation error. The memory allocation failure will be recorded in
  118520. ** the db->mallocFailed flag so that higher-level functions can detect it.
  118521. **
  118522. ** This routine will increase the size of the pWC->a[] array as necessary.
  118523. **
  118524. ** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
  118525. ** for freeing the expression p is assumed by the WhereClause object pWC.
  118526. ** This is true even if this routine fails to allocate a new WhereTerm.
  118527. **
  118528. ** WARNING: This routine might reallocate the space used to store
  118529. ** WhereTerms. All pointers to WhereTerms should be invalidated after
  118530. ** calling this routine. Such pointers may be reinitialized by referencing
  118531. ** the pWC->a[] array.
  118532. */
  118533. static int whereClauseInsert(WhereClause *pWC, Expr *p, u16 wtFlags){
  118534. WhereTerm *pTerm;
  118535. int idx;
  118536. testcase( wtFlags & TERM_VIRTUAL );
  118537. if( pWC->nTerm>=pWC->nSlot ){
  118538. WhereTerm *pOld = pWC->a;
  118539. sqlite3 *db = pWC->pWInfo->pParse->db;
  118540. pWC->a = sqlite3DbMallocRawNN(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
  118541. if( pWC->a==0 ){
  118542. if( wtFlags & TERM_DYNAMIC ){
  118543. sqlite3ExprDelete(db, p);
  118544. }
  118545. pWC->a = pOld;
  118546. return 0;
  118547. }
  118548. memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
  118549. if( pOld!=pWC->aStatic ){
  118550. sqlite3DbFree(db, pOld);
  118551. }
  118552. pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
  118553. }
  118554. pTerm = &pWC->a[idx = pWC->nTerm++];
  118555. if( p && ExprHasProperty(p, EP_Unlikely) ){
  118556. pTerm->truthProb = sqlite3LogEst(p->iTable) - 270;
  118557. }else{
  118558. pTerm->truthProb = 1;
  118559. }
  118560. pTerm->pExpr = sqlite3ExprSkipCollate(p);
  118561. pTerm->wtFlags = wtFlags;
  118562. pTerm->pWC = pWC;
  118563. pTerm->iParent = -1;
  118564. memset(&pTerm->eOperator, 0,
  118565. sizeof(WhereTerm) - offsetof(WhereTerm,eOperator));
  118566. return idx;
  118567. }
  118568. /*
  118569. ** Return TRUE if the given operator is one of the operators that is
  118570. ** allowed for an indexable WHERE clause term. The allowed operators are
  118571. ** "=", "<", ">", "<=", ">=", "IN", "IS", and "IS NULL"
  118572. */
  118573. static int allowedOp(int op){
  118574. assert( TK_GT>TK_EQ && TK_GT<TK_GE );
  118575. assert( TK_LT>TK_EQ && TK_LT<TK_GE );
  118576. assert( TK_LE>TK_EQ && TK_LE<TK_GE );
  118577. assert( TK_GE==TK_EQ+4 );
  118578. return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL || op==TK_IS;
  118579. }
  118580. /*
  118581. ** Commute a comparison operator. Expressions of the form "X op Y"
  118582. ** are converted into "Y op X".
  118583. **
  118584. ** If left/right precedence rules come into play when determining the
  118585. ** collating sequence, then COLLATE operators are adjusted to ensure
  118586. ** that the collating sequence does not change. For example:
  118587. ** "Y collate NOCASE op X" becomes "X op Y" because any collation sequence on
  118588. ** the left hand side of a comparison overrides any collation sequence
  118589. ** attached to the right. For the same reason the EP_Collate flag
  118590. ** is not commuted.
  118591. */
  118592. static void exprCommute(Parse *pParse, Expr *pExpr){
  118593. u16 expRight = (pExpr->pRight->flags & EP_Collate);
  118594. u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
  118595. assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
  118596. if( expRight==expLeft ){
  118597. /* Either X and Y both have COLLATE operator or neither do */
  118598. if( expRight ){
  118599. /* Both X and Y have COLLATE operators. Make sure X is always
  118600. ** used by clearing the EP_Collate flag from Y. */
  118601. pExpr->pRight->flags &= ~EP_Collate;
  118602. }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
  118603. /* Neither X nor Y have COLLATE operators, but X has a non-default
  118604. ** collating sequence. So add the EP_Collate marker on X to cause
  118605. ** it to be searched first. */
  118606. pExpr->pLeft->flags |= EP_Collate;
  118607. }
  118608. }
  118609. SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
  118610. if( pExpr->op>=TK_GT ){
  118611. assert( TK_LT==TK_GT+2 );
  118612. assert( TK_GE==TK_LE+2 );
  118613. assert( TK_GT>TK_EQ );
  118614. assert( TK_GT<TK_LE );
  118615. assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
  118616. pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
  118617. }
  118618. }
  118619. /*
  118620. ** Translate from TK_xx operator to WO_xx bitmask.
  118621. */
  118622. static u16 operatorMask(int op){
  118623. u16 c;
  118624. assert( allowedOp(op) );
  118625. if( op==TK_IN ){
  118626. c = WO_IN;
  118627. }else if( op==TK_ISNULL ){
  118628. c = WO_ISNULL;
  118629. }else if( op==TK_IS ){
  118630. c = WO_IS;
  118631. }else{
  118632. assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
  118633. c = (u16)(WO_EQ<<(op-TK_EQ));
  118634. }
  118635. assert( op!=TK_ISNULL || c==WO_ISNULL );
  118636. assert( op!=TK_IN || c==WO_IN );
  118637. assert( op!=TK_EQ || c==WO_EQ );
  118638. assert( op!=TK_LT || c==WO_LT );
  118639. assert( op!=TK_LE || c==WO_LE );
  118640. assert( op!=TK_GT || c==WO_GT );
  118641. assert( op!=TK_GE || c==WO_GE );
  118642. assert( op!=TK_IS || c==WO_IS );
  118643. return c;
  118644. }
  118645. #ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
  118646. /*
  118647. ** Check to see if the given expression is a LIKE or GLOB operator that
  118648. ** can be optimized using inequality constraints. Return TRUE if it is
  118649. ** so and false if not.
  118650. **
  118651. ** In order for the operator to be optimizible, the RHS must be a string
  118652. ** literal that does not begin with a wildcard. The LHS must be a column
  118653. ** that may only be NULL, a string, or a BLOB, never a number. (This means
  118654. ** that virtual tables cannot participate in the LIKE optimization.) The
  118655. ** collating sequence for the column on the LHS must be appropriate for
  118656. ** the operator.
  118657. */
  118658. static int isLikeOrGlob(
  118659. Parse *pParse, /* Parsing and code generating context */
  118660. Expr *pExpr, /* Test this expression */
  118661. Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
  118662. int *pisComplete, /* True if the only wildcard is % in the last character */
  118663. int *pnoCase /* True if uppercase is equivalent to lowercase */
  118664. ){
  118665. const char *z = 0; /* String on RHS of LIKE operator */
  118666. Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
  118667. ExprList *pList; /* List of operands to the LIKE operator */
  118668. int c; /* One character in z[] */
  118669. int cnt; /* Number of non-wildcard prefix characters */
  118670. char wc[3]; /* Wildcard characters */
  118671. sqlite3 *db = pParse->db; /* Database connection */
  118672. sqlite3_value *pVal = 0;
  118673. int op; /* Opcode of pRight */
  118674. int rc; /* Result code to return */
  118675. if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
  118676. return 0;
  118677. }
  118678. #ifdef SQLITE_EBCDIC
  118679. if( *pnoCase ) return 0;
  118680. #endif
  118681. pList = pExpr->x.pList;
  118682. pLeft = pList->a[1].pExpr;
  118683. if( pLeft->op!=TK_COLUMN
  118684. || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
  118685. || IsVirtual(pLeft->pTab) /* Value might be numeric */
  118686. ){
  118687. /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
  118688. ** be the name of an indexed column with TEXT affinity. */
  118689. return 0;
  118690. }
  118691. assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
  118692. pRight = sqlite3ExprSkipCollate(pList->a[0].pExpr);
  118693. op = pRight->op;
  118694. if( op==TK_VARIABLE ){
  118695. Vdbe *pReprepare = pParse->pReprepare;
  118696. int iCol = pRight->iColumn;
  118697. pVal = sqlite3VdbeGetBoundValue(pReprepare, iCol, SQLITE_AFF_BLOB);
  118698. if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
  118699. z = (char *)sqlite3_value_text(pVal);
  118700. }
  118701. sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
  118702. assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
  118703. }else if( op==TK_STRING ){
  118704. z = pRight->u.zToken;
  118705. }
  118706. if( z ){
  118707. cnt = 0;
  118708. while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
  118709. cnt++;
  118710. }
  118711. if( cnt!=0 && 255!=(u8)z[cnt-1] ){
  118712. Expr *pPrefix;
  118713. *pisComplete = c==wc[0] && z[cnt+1]==0;
  118714. pPrefix = sqlite3Expr(db, TK_STRING, z);
  118715. if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
  118716. *ppPrefix = pPrefix;
  118717. if( op==TK_VARIABLE ){
  118718. Vdbe *v = pParse->pVdbe;
  118719. sqlite3VdbeSetVarmask(v, pRight->iColumn);
  118720. if( *pisComplete && pRight->u.zToken[1] ){
  118721. /* If the rhs of the LIKE expression is a variable, and the current
  118722. ** value of the variable means there is no need to invoke the LIKE
  118723. ** function, then no OP_Variable will be added to the program.
  118724. ** This causes problems for the sqlite3_bind_parameter_name()
  118725. ** API. To work around them, add a dummy OP_Variable here.
  118726. */
  118727. int r1 = sqlite3GetTempReg(pParse);
  118728. sqlite3ExprCodeTarget(pParse, pRight, r1);
  118729. sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
  118730. sqlite3ReleaseTempReg(pParse, r1);
  118731. }
  118732. }
  118733. }else{
  118734. z = 0;
  118735. }
  118736. }
  118737. rc = (z!=0);
  118738. sqlite3ValueFree(pVal);
  118739. return rc;
  118740. }
  118741. #endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
  118742. #ifndef SQLITE_OMIT_VIRTUALTABLE
  118743. /*
  118744. ** Check to see if the given expression is of the form
  118745. **
  118746. ** column OP expr
  118747. **
  118748. ** where OP is one of MATCH, GLOB, LIKE or REGEXP and "column" is a
  118749. ** column of a virtual table.
  118750. **
  118751. ** If it is then return TRUE. If not, return FALSE.
  118752. */
  118753. static int isMatchOfColumn(
  118754. Expr *pExpr, /* Test this expression */
  118755. unsigned char *peOp2 /* OUT: 0 for MATCH, or else an op2 value */
  118756. ){
  118757. static const struct Op2 {
  118758. const char *zOp;
  118759. unsigned char eOp2;
  118760. } aOp[] = {
  118761. { "match", SQLITE_INDEX_CONSTRAINT_MATCH },
  118762. { "glob", SQLITE_INDEX_CONSTRAINT_GLOB },
  118763. { "like", SQLITE_INDEX_CONSTRAINT_LIKE },
  118764. { "regexp", SQLITE_INDEX_CONSTRAINT_REGEXP }
  118765. };
  118766. ExprList *pList;
  118767. Expr *pCol; /* Column reference */
  118768. int i;
  118769. if( pExpr->op!=TK_FUNCTION ){
  118770. return 0;
  118771. }
  118772. pList = pExpr->x.pList;
  118773. if( pList==0 || pList->nExpr!=2 ){
  118774. return 0;
  118775. }
  118776. pCol = pList->a[1].pExpr;
  118777. if( pCol->op!=TK_COLUMN || !IsVirtual(pCol->pTab) ){
  118778. return 0;
  118779. }
  118780. for(i=0; i<ArraySize(aOp); i++){
  118781. if( sqlite3StrICmp(pExpr->u.zToken, aOp[i].zOp)==0 ){
  118782. *peOp2 = aOp[i].eOp2;
  118783. return 1;
  118784. }
  118785. }
  118786. return 0;
  118787. }
  118788. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  118789. /*
  118790. ** If the pBase expression originated in the ON or USING clause of
  118791. ** a join, then transfer the appropriate markings over to derived.
  118792. */
  118793. static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
  118794. if( pDerived ){
  118795. pDerived->flags |= pBase->flags & EP_FromJoin;
  118796. pDerived->iRightJoinTable = pBase->iRightJoinTable;
  118797. }
  118798. }
  118799. /*
  118800. ** Mark term iChild as being a child of term iParent
  118801. */
  118802. static void markTermAsChild(WhereClause *pWC, int iChild, int iParent){
  118803. pWC->a[iChild].iParent = iParent;
  118804. pWC->a[iChild].truthProb = pWC->a[iParent].truthProb;
  118805. pWC->a[iParent].nChild++;
  118806. }
  118807. /*
  118808. ** Return the N-th AND-connected subterm of pTerm. Or if pTerm is not
  118809. ** a conjunction, then return just pTerm when N==0. If N is exceeds
  118810. ** the number of available subterms, return NULL.
  118811. */
  118812. static WhereTerm *whereNthSubterm(WhereTerm *pTerm, int N){
  118813. if( pTerm->eOperator!=WO_AND ){
  118814. return N==0 ? pTerm : 0;
  118815. }
  118816. if( N<pTerm->u.pAndInfo->wc.nTerm ){
  118817. return &pTerm->u.pAndInfo->wc.a[N];
  118818. }
  118819. return 0;
  118820. }
  118821. /*
  118822. ** Subterms pOne and pTwo are contained within WHERE clause pWC. The
  118823. ** two subterms are in disjunction - they are OR-ed together.
  118824. **
  118825. ** If these two terms are both of the form: "A op B" with the same
  118826. ** A and B values but different operators and if the operators are
  118827. ** compatible (if one is = and the other is <, for example) then
  118828. ** add a new virtual AND term to pWC that is the combination of the
  118829. ** two.
  118830. **
  118831. ** Some examples:
  118832. **
  118833. ** x<y OR x=y --> x<=y
  118834. ** x=y OR x=y --> x=y
  118835. ** x<=y OR x<y --> x<=y
  118836. **
  118837. ** The following is NOT generated:
  118838. **
  118839. ** x<y OR x>y --> x!=y
  118840. */
  118841. static void whereCombineDisjuncts(
  118842. SrcList *pSrc, /* the FROM clause */
  118843. WhereClause *pWC, /* The complete WHERE clause */
  118844. WhereTerm *pOne, /* First disjunct */
  118845. WhereTerm *pTwo /* Second disjunct */
  118846. ){
  118847. u16 eOp = pOne->eOperator | pTwo->eOperator;
  118848. sqlite3 *db; /* Database connection (for malloc) */
  118849. Expr *pNew; /* New virtual expression */
  118850. int op; /* Operator for the combined expression */
  118851. int idxNew; /* Index in pWC of the next virtual term */
  118852. if( (pOne->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
  118853. if( (pTwo->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
  118854. if( (eOp & (WO_EQ|WO_LT|WO_LE))!=eOp
  118855. && (eOp & (WO_EQ|WO_GT|WO_GE))!=eOp ) return;
  118856. assert( pOne->pExpr->pLeft!=0 && pOne->pExpr->pRight!=0 );
  118857. assert( pTwo->pExpr->pLeft!=0 && pTwo->pExpr->pRight!=0 );
  118858. if( sqlite3ExprCompare(pOne->pExpr->pLeft, pTwo->pExpr->pLeft, -1) ) return;
  118859. if( sqlite3ExprCompare(pOne->pExpr->pRight, pTwo->pExpr->pRight, -1) )return;
  118860. /* If we reach this point, it means the two subterms can be combined */
  118861. if( (eOp & (eOp-1))!=0 ){
  118862. if( eOp & (WO_LT|WO_LE) ){
  118863. eOp = WO_LE;
  118864. }else{
  118865. assert( eOp & (WO_GT|WO_GE) );
  118866. eOp = WO_GE;
  118867. }
  118868. }
  118869. db = pWC->pWInfo->pParse->db;
  118870. pNew = sqlite3ExprDup(db, pOne->pExpr, 0);
  118871. if( pNew==0 ) return;
  118872. for(op=TK_EQ; eOp!=(WO_EQ<<(op-TK_EQ)); op++){ assert( op<TK_GE ); }
  118873. pNew->op = op;
  118874. idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
  118875. exprAnalyze(pSrc, pWC, idxNew);
  118876. }
  118877. #if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
  118878. /*
  118879. ** Analyze a term that consists of two or more OR-connected
  118880. ** subterms. So in:
  118881. **
  118882. ** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
  118883. ** ^^^^^^^^^^^^^^^^^^^^
  118884. **
  118885. ** This routine analyzes terms such as the middle term in the above example.
  118886. ** A WhereOrTerm object is computed and attached to the term under
  118887. ** analysis, regardless of the outcome of the analysis. Hence:
  118888. **
  118889. ** WhereTerm.wtFlags |= TERM_ORINFO
  118890. ** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
  118891. **
  118892. ** The term being analyzed must have two or more of OR-connected subterms.
  118893. ** A single subterm might be a set of AND-connected sub-subterms.
  118894. ** Examples of terms under analysis:
  118895. **
  118896. ** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
  118897. ** (B) x=expr1 OR expr2=x OR x=expr3
  118898. ** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
  118899. ** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
  118900. ** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
  118901. ** (F) x>A OR (x=A AND y>=B)
  118902. **
  118903. ** CASE 1:
  118904. **
  118905. ** If all subterms are of the form T.C=expr for some single column of C and
  118906. ** a single table T (as shown in example B above) then create a new virtual
  118907. ** term that is an equivalent IN expression. In other words, if the term
  118908. ** being analyzed is:
  118909. **
  118910. ** x = expr1 OR expr2 = x OR x = expr3
  118911. **
  118912. ** then create a new virtual term like this:
  118913. **
  118914. ** x IN (expr1,expr2,expr3)
  118915. **
  118916. ** CASE 2:
  118917. **
  118918. ** If there are exactly two disjuncts and one side has x>A and the other side
  118919. ** has x=A (for the same x and A) then add a new virtual conjunct term to the
  118920. ** WHERE clause of the form "x>=A". Example:
  118921. **
  118922. ** x>A OR (x=A AND y>B) adds: x>=A
  118923. **
  118924. ** The added conjunct can sometimes be helpful in query planning.
  118925. **
  118926. ** CASE 3:
  118927. **
  118928. ** If all subterms are indexable by a single table T, then set
  118929. **
  118930. ** WhereTerm.eOperator = WO_OR
  118931. ** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
  118932. **
  118933. ** A subterm is "indexable" if it is of the form
  118934. ** "T.C <op> <expr>" where C is any column of table T and
  118935. ** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
  118936. ** A subterm is also indexable if it is an AND of two or more
  118937. ** subsubterms at least one of which is indexable. Indexable AND
  118938. ** subterms have their eOperator set to WO_AND and they have
  118939. ** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
  118940. **
  118941. ** From another point of view, "indexable" means that the subterm could
  118942. ** potentially be used with an index if an appropriate index exists.
  118943. ** This analysis does not consider whether or not the index exists; that
  118944. ** is decided elsewhere. This analysis only looks at whether subterms
  118945. ** appropriate for indexing exist.
  118946. **
  118947. ** All examples A through E above satisfy case 3. But if a term
  118948. ** also satisfies case 1 (such as B) we know that the optimizer will
  118949. ** always prefer case 1, so in that case we pretend that case 3 is not
  118950. ** satisfied.
  118951. **
  118952. ** It might be the case that multiple tables are indexable. For example,
  118953. ** (E) above is indexable on tables P, Q, and R.
  118954. **
  118955. ** Terms that satisfy case 3 are candidates for lookup by using
  118956. ** separate indices to find rowids for each subterm and composing
  118957. ** the union of all rowids using a RowSet object. This is similar
  118958. ** to "bitmap indices" in other database engines.
  118959. **
  118960. ** OTHERWISE:
  118961. **
  118962. ** If none of cases 1, 2, or 3 apply, then leave the eOperator set to
  118963. ** zero. This term is not useful for search.
  118964. */
  118965. static void exprAnalyzeOrTerm(
  118966. SrcList *pSrc, /* the FROM clause */
  118967. WhereClause *pWC, /* the complete WHERE clause */
  118968. int idxTerm /* Index of the OR-term to be analyzed */
  118969. ){
  118970. WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
  118971. Parse *pParse = pWInfo->pParse; /* Parser context */
  118972. sqlite3 *db = pParse->db; /* Database connection */
  118973. WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
  118974. Expr *pExpr = pTerm->pExpr; /* The expression of the term */
  118975. int i; /* Loop counters */
  118976. WhereClause *pOrWc; /* Breakup of pTerm into subterms */
  118977. WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
  118978. WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
  118979. Bitmask chngToIN; /* Tables that might satisfy case 1 */
  118980. Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
  118981. /*
  118982. ** Break the OR clause into its separate subterms. The subterms are
  118983. ** stored in a WhereClause structure containing within the WhereOrInfo
  118984. ** object that is attached to the original OR clause term.
  118985. */
  118986. assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
  118987. assert( pExpr->op==TK_OR );
  118988. pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
  118989. if( pOrInfo==0 ) return;
  118990. pTerm->wtFlags |= TERM_ORINFO;
  118991. pOrWc = &pOrInfo->wc;
  118992. memset(pOrWc->aStatic, 0, sizeof(pOrWc->aStatic));
  118993. sqlite3WhereClauseInit(pOrWc, pWInfo);
  118994. sqlite3WhereSplit(pOrWc, pExpr, TK_OR);
  118995. sqlite3WhereExprAnalyze(pSrc, pOrWc);
  118996. if( db->mallocFailed ) return;
  118997. assert( pOrWc->nTerm>=2 );
  118998. /*
  118999. ** Compute the set of tables that might satisfy cases 1 or 3.
  119000. */
  119001. indexable = ~(Bitmask)0;
  119002. chngToIN = ~(Bitmask)0;
  119003. for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
  119004. if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
  119005. WhereAndInfo *pAndInfo;
  119006. assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
  119007. chngToIN = 0;
  119008. pAndInfo = sqlite3DbMallocRawNN(db, sizeof(*pAndInfo));
  119009. if( pAndInfo ){
  119010. WhereClause *pAndWC;
  119011. WhereTerm *pAndTerm;
  119012. int j;
  119013. Bitmask b = 0;
  119014. pOrTerm->u.pAndInfo = pAndInfo;
  119015. pOrTerm->wtFlags |= TERM_ANDINFO;
  119016. pOrTerm->eOperator = WO_AND;
  119017. pAndWC = &pAndInfo->wc;
  119018. memset(pAndWC->aStatic, 0, sizeof(pAndWC->aStatic));
  119019. sqlite3WhereClauseInit(pAndWC, pWC->pWInfo);
  119020. sqlite3WhereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
  119021. sqlite3WhereExprAnalyze(pSrc, pAndWC);
  119022. pAndWC->pOuter = pWC;
  119023. if( !db->mallocFailed ){
  119024. for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
  119025. assert( pAndTerm->pExpr );
  119026. if( allowedOp(pAndTerm->pExpr->op)
  119027. || pAndTerm->eOperator==WO_MATCH
  119028. ){
  119029. b |= sqlite3WhereGetMask(&pWInfo->sMaskSet, pAndTerm->leftCursor);
  119030. }
  119031. }
  119032. }
  119033. indexable &= b;
  119034. }
  119035. }else if( pOrTerm->wtFlags & TERM_COPIED ){
  119036. /* Skip this term for now. We revisit it when we process the
  119037. ** corresponding TERM_VIRTUAL term */
  119038. }else{
  119039. Bitmask b;
  119040. b = sqlite3WhereGetMask(&pWInfo->sMaskSet, pOrTerm->leftCursor);
  119041. if( pOrTerm->wtFlags & TERM_VIRTUAL ){
  119042. WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
  119043. b |= sqlite3WhereGetMask(&pWInfo->sMaskSet, pOther->leftCursor);
  119044. }
  119045. indexable &= b;
  119046. if( (pOrTerm->eOperator & WO_EQ)==0 ){
  119047. chngToIN = 0;
  119048. }else{
  119049. chngToIN &= b;
  119050. }
  119051. }
  119052. }
  119053. /*
  119054. ** Record the set of tables that satisfy case 3. The set might be
  119055. ** empty.
  119056. */
  119057. pOrInfo->indexable = indexable;
  119058. pTerm->eOperator = indexable==0 ? 0 : WO_OR;
  119059. /* For a two-way OR, attempt to implementation case 2.
  119060. */
  119061. if( indexable && pOrWc->nTerm==2 ){
  119062. int iOne = 0;
  119063. WhereTerm *pOne;
  119064. while( (pOne = whereNthSubterm(&pOrWc->a[0],iOne++))!=0 ){
  119065. int iTwo = 0;
  119066. WhereTerm *pTwo;
  119067. while( (pTwo = whereNthSubterm(&pOrWc->a[1],iTwo++))!=0 ){
  119068. whereCombineDisjuncts(pSrc, pWC, pOne, pTwo);
  119069. }
  119070. }
  119071. }
  119072. /*
  119073. ** chngToIN holds a set of tables that *might* satisfy case 1. But
  119074. ** we have to do some additional checking to see if case 1 really
  119075. ** is satisfied.
  119076. **
  119077. ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
  119078. ** that there is no possibility of transforming the OR clause into an
  119079. ** IN operator because one or more terms in the OR clause contain
  119080. ** something other than == on a column in the single table. The 1-bit
  119081. ** case means that every term of the OR clause is of the form
  119082. ** "table.column=expr" for some single table. The one bit that is set
  119083. ** will correspond to the common table. We still need to check to make
  119084. ** sure the same column is used on all terms. The 2-bit case is when
  119085. ** the all terms are of the form "table1.column=table2.column". It
  119086. ** might be possible to form an IN operator with either table1.column
  119087. ** or table2.column as the LHS if either is common to every term of
  119088. ** the OR clause.
  119089. **
  119090. ** Note that terms of the form "table.column1=table.column2" (the
  119091. ** same table on both sizes of the ==) cannot be optimized.
  119092. */
  119093. if( chngToIN ){
  119094. int okToChngToIN = 0; /* True if the conversion to IN is valid */
  119095. int iColumn = -1; /* Column index on lhs of IN operator */
  119096. int iCursor = -1; /* Table cursor common to all terms */
  119097. int j = 0; /* Loop counter */
  119098. /* Search for a table and column that appears on one side or the
  119099. ** other of the == operator in every subterm. That table and column
  119100. ** will be recorded in iCursor and iColumn. There might not be any
  119101. ** such table and column. Set okToChngToIN if an appropriate table
  119102. ** and column is found but leave okToChngToIN false if not found.
  119103. */
  119104. for(j=0; j<2 && !okToChngToIN; j++){
  119105. pOrTerm = pOrWc->a;
  119106. for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
  119107. assert( pOrTerm->eOperator & WO_EQ );
  119108. pOrTerm->wtFlags &= ~TERM_OR_OK;
  119109. if( pOrTerm->leftCursor==iCursor ){
  119110. /* This is the 2-bit case and we are on the second iteration and
  119111. ** current term is from the first iteration. So skip this term. */
  119112. assert( j==1 );
  119113. continue;
  119114. }
  119115. if( (chngToIN & sqlite3WhereGetMask(&pWInfo->sMaskSet,
  119116. pOrTerm->leftCursor))==0 ){
  119117. /* This term must be of the form t1.a==t2.b where t2 is in the
  119118. ** chngToIN set but t1 is not. This term will be either preceded
  119119. ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
  119120. ** and use its inversion. */
  119121. testcase( pOrTerm->wtFlags & TERM_COPIED );
  119122. testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
  119123. assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
  119124. continue;
  119125. }
  119126. iColumn = pOrTerm->u.leftColumn;
  119127. iCursor = pOrTerm->leftCursor;
  119128. break;
  119129. }
  119130. if( i<0 ){
  119131. /* No candidate table+column was found. This can only occur
  119132. ** on the second iteration */
  119133. assert( j==1 );
  119134. assert( IsPowerOfTwo(chngToIN) );
  119135. assert( chngToIN==sqlite3WhereGetMask(&pWInfo->sMaskSet, iCursor) );
  119136. break;
  119137. }
  119138. testcase( j==1 );
  119139. /* We have found a candidate table and column. Check to see if that
  119140. ** table and column is common to every term in the OR clause */
  119141. okToChngToIN = 1;
  119142. for(; i>=0 && okToChngToIN; i--, pOrTerm++){
  119143. assert( pOrTerm->eOperator & WO_EQ );
  119144. if( pOrTerm->leftCursor!=iCursor ){
  119145. pOrTerm->wtFlags &= ~TERM_OR_OK;
  119146. }else if( pOrTerm->u.leftColumn!=iColumn ){
  119147. okToChngToIN = 0;
  119148. }else{
  119149. int affLeft, affRight;
  119150. /* If the right-hand side is also a column, then the affinities
  119151. ** of both right and left sides must be such that no type
  119152. ** conversions are required on the right. (Ticket #2249)
  119153. */
  119154. affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
  119155. affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
  119156. if( affRight!=0 && affRight!=affLeft ){
  119157. okToChngToIN = 0;
  119158. }else{
  119159. pOrTerm->wtFlags |= TERM_OR_OK;
  119160. }
  119161. }
  119162. }
  119163. }
  119164. /* At this point, okToChngToIN is true if original pTerm satisfies
  119165. ** case 1. In that case, construct a new virtual term that is
  119166. ** pTerm converted into an IN operator.
  119167. */
  119168. if( okToChngToIN ){
  119169. Expr *pDup; /* A transient duplicate expression */
  119170. ExprList *pList = 0; /* The RHS of the IN operator */
  119171. Expr *pLeft = 0; /* The LHS of the IN operator */
  119172. Expr *pNew; /* The complete IN operator */
  119173. for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
  119174. if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
  119175. assert( pOrTerm->eOperator & WO_EQ );
  119176. assert( pOrTerm->leftCursor==iCursor );
  119177. assert( pOrTerm->u.leftColumn==iColumn );
  119178. pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
  119179. pList = sqlite3ExprListAppend(pWInfo->pParse, pList, pDup);
  119180. pLeft = pOrTerm->pExpr->pLeft;
  119181. }
  119182. assert( pLeft!=0 );
  119183. pDup = sqlite3ExprDup(db, pLeft, 0);
  119184. pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
  119185. if( pNew ){
  119186. int idxNew;
  119187. transferJoinMarkings(pNew, pExpr);
  119188. assert( !ExprHasProperty(pNew, EP_xIsSelect) );
  119189. pNew->x.pList = pList;
  119190. idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
  119191. testcase( idxNew==0 );
  119192. exprAnalyze(pSrc, pWC, idxNew);
  119193. pTerm = &pWC->a[idxTerm];
  119194. markTermAsChild(pWC, idxNew, idxTerm);
  119195. }else{
  119196. sqlite3ExprListDelete(db, pList);
  119197. }
  119198. pTerm->eOperator = WO_NOOP; /* case 1 trumps case 3 */
  119199. }
  119200. }
  119201. }
  119202. #endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
  119203. /*
  119204. ** We already know that pExpr is a binary operator where both operands are
  119205. ** column references. This routine checks to see if pExpr is an equivalence
  119206. ** relation:
  119207. ** 1. The SQLITE_Transitive optimization must be enabled
  119208. ** 2. Must be either an == or an IS operator
  119209. ** 3. Not originating in the ON clause of an OUTER JOIN
  119210. ** 4. The affinities of A and B must be compatible
  119211. ** 5a. Both operands use the same collating sequence OR
  119212. ** 5b. The overall collating sequence is BINARY
  119213. ** If this routine returns TRUE, that means that the RHS can be substituted
  119214. ** for the LHS anyplace else in the WHERE clause where the LHS column occurs.
  119215. ** This is an optimization. No harm comes from returning 0. But if 1 is
  119216. ** returned when it should not be, then incorrect answers might result.
  119217. */
  119218. static int termIsEquivalence(Parse *pParse, Expr *pExpr){
  119219. char aff1, aff2;
  119220. CollSeq *pColl;
  119221. const char *zColl1, *zColl2;
  119222. if( !OptimizationEnabled(pParse->db, SQLITE_Transitive) ) return 0;
  119223. if( pExpr->op!=TK_EQ && pExpr->op!=TK_IS ) return 0;
  119224. if( ExprHasProperty(pExpr, EP_FromJoin) ) return 0;
  119225. aff1 = sqlite3ExprAffinity(pExpr->pLeft);
  119226. aff2 = sqlite3ExprAffinity(pExpr->pRight);
  119227. if( aff1!=aff2
  119228. && (!sqlite3IsNumericAffinity(aff1) || !sqlite3IsNumericAffinity(aff2))
  119229. ){
  119230. return 0;
  119231. }
  119232. pColl = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft, pExpr->pRight);
  119233. if( pColl==0 || sqlite3StrICmp(pColl->zName, "BINARY")==0 ) return 1;
  119234. pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
  119235. zColl1 = pColl ? pColl->zName : 0;
  119236. pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
  119237. zColl2 = pColl ? pColl->zName : 0;
  119238. return sqlite3_stricmp(zColl1, zColl2)==0;
  119239. }
  119240. /*
  119241. ** Recursively walk the expressions of a SELECT statement and generate
  119242. ** a bitmask indicating which tables are used in that expression
  119243. ** tree.
  119244. */
  119245. static Bitmask exprSelectUsage(WhereMaskSet *pMaskSet, Select *pS){
  119246. Bitmask mask = 0;
  119247. while( pS ){
  119248. SrcList *pSrc = pS->pSrc;
  119249. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pEList);
  119250. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pGroupBy);
  119251. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pOrderBy);
  119252. mask |= sqlite3WhereExprUsage(pMaskSet, pS->pWhere);
  119253. mask |= sqlite3WhereExprUsage(pMaskSet, pS->pHaving);
  119254. if( ALWAYS(pSrc!=0) ){
  119255. int i;
  119256. for(i=0; i<pSrc->nSrc; i++){
  119257. mask |= exprSelectUsage(pMaskSet, pSrc->a[i].pSelect);
  119258. mask |= sqlite3WhereExprUsage(pMaskSet, pSrc->a[i].pOn);
  119259. }
  119260. }
  119261. pS = pS->pPrior;
  119262. }
  119263. return mask;
  119264. }
  119265. /*
  119266. ** Expression pExpr is one operand of a comparison operator that might
  119267. ** be useful for indexing. This routine checks to see if pExpr appears
  119268. ** in any index. Return TRUE (1) if pExpr is an indexed term and return
  119269. ** FALSE (0) if not. If TRUE is returned, also set *piCur to the cursor
  119270. ** number of the table that is indexed and *piColumn to the column number
  119271. ** of the column that is indexed, or XN_EXPR (-2) if an expression is being
  119272. ** indexed.
  119273. **
  119274. ** If pExpr is a TK_COLUMN column reference, then this routine always returns
  119275. ** true even if that particular column is not indexed, because the column
  119276. ** might be added to an automatic index later.
  119277. */
  119278. static int exprMightBeIndexed(
  119279. SrcList *pFrom, /* The FROM clause */
  119280. int op, /* The specific comparison operator */
  119281. Bitmask mPrereq, /* Bitmask of FROM clause terms referenced by pExpr */
  119282. Expr *pExpr, /* An operand of a comparison operator */
  119283. int *piCur, /* Write the referenced table cursor number here */
  119284. int *piColumn /* Write the referenced table column number here */
  119285. ){
  119286. Index *pIdx;
  119287. int i;
  119288. int iCur;
  119289. /* If this expression is a vector to the left or right of a
  119290. ** inequality constraint (>, <, >= or <=), perform the processing
  119291. ** on the first element of the vector. */
  119292. assert( TK_GT+1==TK_LE && TK_GT+2==TK_LT && TK_GT+3==TK_GE );
  119293. assert( TK_IS<TK_GE && TK_ISNULL<TK_GE && TK_IN<TK_GE );
  119294. assert( op<=TK_GE );
  119295. if( pExpr->op==TK_VECTOR && (op>=TK_GT && ALWAYS(op<=TK_GE)) ){
  119296. pExpr = pExpr->x.pList->a[0].pExpr;
  119297. }
  119298. if( pExpr->op==TK_COLUMN ){
  119299. *piCur = pExpr->iTable;
  119300. *piColumn = pExpr->iColumn;
  119301. return 1;
  119302. }
  119303. if( mPrereq==0 ) return 0; /* No table references */
  119304. if( (mPrereq&(mPrereq-1))!=0 ) return 0; /* Refs more than one table */
  119305. for(i=0; mPrereq>1; i++, mPrereq>>=1){}
  119306. iCur = pFrom->a[i].iCursor;
  119307. for(pIdx=pFrom->a[i].pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  119308. if( pIdx->aColExpr==0 ) continue;
  119309. for(i=0; i<pIdx->nKeyCol; i++){
  119310. if( pIdx->aiColumn[i]!=XN_EXPR ) continue;
  119311. if( sqlite3ExprCompare(pExpr, pIdx->aColExpr->a[i].pExpr, iCur)==0 ){
  119312. *piCur = iCur;
  119313. *piColumn = XN_EXPR;
  119314. return 1;
  119315. }
  119316. }
  119317. }
  119318. return 0;
  119319. }
  119320. /*
  119321. ** The input to this routine is an WhereTerm structure with only the
  119322. ** "pExpr" field filled in. The job of this routine is to analyze the
  119323. ** subexpression and populate all the other fields of the WhereTerm
  119324. ** structure.
  119325. **
  119326. ** If the expression is of the form "<expr> <op> X" it gets commuted
  119327. ** to the standard form of "X <op> <expr>".
  119328. **
  119329. ** If the expression is of the form "X <op> Y" where both X and Y are
  119330. ** columns, then the original expression is unchanged and a new virtual
  119331. ** term of the form "Y <op> X" is added to the WHERE clause and
  119332. ** analyzed separately. The original term is marked with TERM_COPIED
  119333. ** and the new term is marked with TERM_DYNAMIC (because it's pExpr
  119334. ** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
  119335. ** is a commuted copy of a prior term.) The original term has nChild=1
  119336. ** and the copy has idxParent set to the index of the original term.
  119337. */
  119338. static void exprAnalyze(
  119339. SrcList *pSrc, /* the FROM clause */
  119340. WhereClause *pWC, /* the WHERE clause */
  119341. int idxTerm /* Index of the term to be analyzed */
  119342. ){
  119343. WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
  119344. WhereTerm *pTerm; /* The term to be analyzed */
  119345. WhereMaskSet *pMaskSet; /* Set of table index masks */
  119346. Expr *pExpr; /* The expression to be analyzed */
  119347. Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
  119348. Bitmask prereqAll; /* Prerequesites of pExpr */
  119349. Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
  119350. Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
  119351. int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
  119352. int noCase = 0; /* uppercase equivalent to lowercase */
  119353. int op; /* Top-level operator. pExpr->op */
  119354. Parse *pParse = pWInfo->pParse; /* Parsing context */
  119355. sqlite3 *db = pParse->db; /* Database connection */
  119356. unsigned char eOp2; /* op2 value for LIKE/REGEXP/GLOB */
  119357. if( db->mallocFailed ){
  119358. return;
  119359. }
  119360. pTerm = &pWC->a[idxTerm];
  119361. pMaskSet = &pWInfo->sMaskSet;
  119362. pExpr = pTerm->pExpr;
  119363. assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
  119364. prereqLeft = sqlite3WhereExprUsage(pMaskSet, pExpr->pLeft);
  119365. op = pExpr->op;
  119366. if( op==TK_IN ){
  119367. assert( pExpr->pRight==0 );
  119368. if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
  119369. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  119370. pTerm->prereqRight = exprSelectUsage(pMaskSet, pExpr->x.pSelect);
  119371. }else{
  119372. pTerm->prereqRight = sqlite3WhereExprListUsage(pMaskSet, pExpr->x.pList);
  119373. }
  119374. }else if( op==TK_ISNULL ){
  119375. pTerm->prereqRight = 0;
  119376. }else{
  119377. pTerm->prereqRight = sqlite3WhereExprUsage(pMaskSet, pExpr->pRight);
  119378. }
  119379. prereqAll = sqlite3WhereExprUsage(pMaskSet, pExpr);
  119380. if( ExprHasProperty(pExpr, EP_FromJoin) ){
  119381. Bitmask x = sqlite3WhereGetMask(pMaskSet, pExpr->iRightJoinTable);
  119382. prereqAll |= x;
  119383. extraRight = x-1; /* ON clause terms may not be used with an index
  119384. ** on left table of a LEFT JOIN. Ticket #3015 */
  119385. }
  119386. pTerm->prereqAll = prereqAll;
  119387. pTerm->leftCursor = -1;
  119388. pTerm->iParent = -1;
  119389. pTerm->eOperator = 0;
  119390. if( allowedOp(op) ){
  119391. int iCur, iColumn;
  119392. Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
  119393. Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
  119394. u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
  119395. if( pTerm->iField>0 ){
  119396. assert( op==TK_IN );
  119397. assert( pLeft->op==TK_VECTOR );
  119398. pLeft = pLeft->x.pList->a[pTerm->iField-1].pExpr;
  119399. }
  119400. if( exprMightBeIndexed(pSrc, op, prereqLeft, pLeft, &iCur, &iColumn) ){
  119401. pTerm->leftCursor = iCur;
  119402. pTerm->u.leftColumn = iColumn;
  119403. pTerm->eOperator = operatorMask(op) & opMask;
  119404. }
  119405. if( op==TK_IS ) pTerm->wtFlags |= TERM_IS;
  119406. if( pRight
  119407. && exprMightBeIndexed(pSrc, op, pTerm->prereqRight, pRight, &iCur,&iColumn)
  119408. ){
  119409. WhereTerm *pNew;
  119410. Expr *pDup;
  119411. u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
  119412. assert( pTerm->iField==0 );
  119413. if( pTerm->leftCursor>=0 ){
  119414. int idxNew;
  119415. pDup = sqlite3ExprDup(db, pExpr, 0);
  119416. if( db->mallocFailed ){
  119417. sqlite3ExprDelete(db, pDup);
  119418. return;
  119419. }
  119420. idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
  119421. if( idxNew==0 ) return;
  119422. pNew = &pWC->a[idxNew];
  119423. markTermAsChild(pWC, idxNew, idxTerm);
  119424. if( op==TK_IS ) pNew->wtFlags |= TERM_IS;
  119425. pTerm = &pWC->a[idxTerm];
  119426. pTerm->wtFlags |= TERM_COPIED;
  119427. if( termIsEquivalence(pParse, pDup) ){
  119428. pTerm->eOperator |= WO_EQUIV;
  119429. eExtraOp = WO_EQUIV;
  119430. }
  119431. }else{
  119432. pDup = pExpr;
  119433. pNew = pTerm;
  119434. }
  119435. exprCommute(pParse, pDup);
  119436. pNew->leftCursor = iCur;
  119437. pNew->u.leftColumn = iColumn;
  119438. testcase( (prereqLeft | extraRight) != prereqLeft );
  119439. pNew->prereqRight = prereqLeft | extraRight;
  119440. pNew->prereqAll = prereqAll;
  119441. pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
  119442. }
  119443. }
  119444. #ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
  119445. /* If a term is the BETWEEN operator, create two new virtual terms
  119446. ** that define the range that the BETWEEN implements. For example:
  119447. **
  119448. ** a BETWEEN b AND c
  119449. **
  119450. ** is converted into:
  119451. **
  119452. ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
  119453. **
  119454. ** The two new terms are added onto the end of the WhereClause object.
  119455. ** The new terms are "dynamic" and are children of the original BETWEEN
  119456. ** term. That means that if the BETWEEN term is coded, the children are
  119457. ** skipped. Or, if the children are satisfied by an index, the original
  119458. ** BETWEEN term is skipped.
  119459. */
  119460. else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
  119461. ExprList *pList = pExpr->x.pList;
  119462. int i;
  119463. static const u8 ops[] = {TK_GE, TK_LE};
  119464. assert( pList!=0 );
  119465. assert( pList->nExpr==2 );
  119466. for(i=0; i<2; i++){
  119467. Expr *pNewExpr;
  119468. int idxNew;
  119469. pNewExpr = sqlite3PExpr(pParse, ops[i],
  119470. sqlite3ExprDup(db, pExpr->pLeft, 0),
  119471. sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
  119472. transferJoinMarkings(pNewExpr, pExpr);
  119473. idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
  119474. testcase( idxNew==0 );
  119475. exprAnalyze(pSrc, pWC, idxNew);
  119476. pTerm = &pWC->a[idxTerm];
  119477. markTermAsChild(pWC, idxNew, idxTerm);
  119478. }
  119479. }
  119480. #endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
  119481. #if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
  119482. /* Analyze a term that is composed of two or more subterms connected by
  119483. ** an OR operator.
  119484. */
  119485. else if( pExpr->op==TK_OR ){
  119486. assert( pWC->op==TK_AND );
  119487. exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
  119488. pTerm = &pWC->a[idxTerm];
  119489. }
  119490. #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
  119491. #ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
  119492. /* Add constraints to reduce the search space on a LIKE or GLOB
  119493. ** operator.
  119494. **
  119495. ** A like pattern of the form "x LIKE 'aBc%'" is changed into constraints
  119496. **
  119497. ** x>='ABC' AND x<'abd' AND x LIKE 'aBc%'
  119498. **
  119499. ** The last character of the prefix "abc" is incremented to form the
  119500. ** termination condition "abd". If case is not significant (the default
  119501. ** for LIKE) then the lower-bound is made all uppercase and the upper-
  119502. ** bound is made all lowercase so that the bounds also work when comparing
  119503. ** BLOBs.
  119504. */
  119505. if( pWC->op==TK_AND
  119506. && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
  119507. ){
  119508. Expr *pLeft; /* LHS of LIKE/GLOB operator */
  119509. Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
  119510. Expr *pNewExpr1;
  119511. Expr *pNewExpr2;
  119512. int idxNew1;
  119513. int idxNew2;
  119514. const char *zCollSeqName; /* Name of collating sequence */
  119515. const u16 wtFlags = TERM_LIKEOPT | TERM_VIRTUAL | TERM_DYNAMIC;
  119516. pLeft = pExpr->x.pList->a[1].pExpr;
  119517. pStr2 = sqlite3ExprDup(db, pStr1, 0);
  119518. /* Convert the lower bound to upper-case and the upper bound to
  119519. ** lower-case (upper-case is less than lower-case in ASCII) so that
  119520. ** the range constraints also work for BLOBs
  119521. */
  119522. if( noCase && !pParse->db->mallocFailed ){
  119523. int i;
  119524. char c;
  119525. pTerm->wtFlags |= TERM_LIKE;
  119526. for(i=0; (c = pStr1->u.zToken[i])!=0; i++){
  119527. pStr1->u.zToken[i] = sqlite3Toupper(c);
  119528. pStr2->u.zToken[i] = sqlite3Tolower(c);
  119529. }
  119530. }
  119531. if( !db->mallocFailed ){
  119532. u8 c, *pC; /* Last character before the first wildcard */
  119533. pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
  119534. c = *pC;
  119535. if( noCase ){
  119536. /* The point is to increment the last character before the first
  119537. ** wildcard. But if we increment '@', that will push it into the
  119538. ** alphabetic range where case conversions will mess up the
  119539. ** inequality. To avoid this, make sure to also run the full
  119540. ** LIKE on all candidate expressions by clearing the isComplete flag
  119541. */
  119542. if( c=='A'-1 ) isComplete = 0;
  119543. c = sqlite3UpperToLower[c];
  119544. }
  119545. *pC = c + 1;
  119546. }
  119547. zCollSeqName = noCase ? "NOCASE" : "BINARY";
  119548. pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
  119549. pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
  119550. sqlite3ExprAddCollateString(pParse,pNewExpr1,zCollSeqName),
  119551. pStr1, 0);
  119552. transferJoinMarkings(pNewExpr1, pExpr);
  119553. idxNew1 = whereClauseInsert(pWC, pNewExpr1, wtFlags);
  119554. testcase( idxNew1==0 );
  119555. exprAnalyze(pSrc, pWC, idxNew1);
  119556. pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
  119557. pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
  119558. sqlite3ExprAddCollateString(pParse,pNewExpr2,zCollSeqName),
  119559. pStr2, 0);
  119560. transferJoinMarkings(pNewExpr2, pExpr);
  119561. idxNew2 = whereClauseInsert(pWC, pNewExpr2, wtFlags);
  119562. testcase( idxNew2==0 );
  119563. exprAnalyze(pSrc, pWC, idxNew2);
  119564. pTerm = &pWC->a[idxTerm];
  119565. if( isComplete ){
  119566. markTermAsChild(pWC, idxNew1, idxTerm);
  119567. markTermAsChild(pWC, idxNew2, idxTerm);
  119568. }
  119569. }
  119570. #endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
  119571. #ifndef SQLITE_OMIT_VIRTUALTABLE
  119572. /* Add a WO_MATCH auxiliary term to the constraint set if the
  119573. ** current expression is of the form: column MATCH expr.
  119574. ** This information is used by the xBestIndex methods of
  119575. ** virtual tables. The native query optimizer does not attempt
  119576. ** to do anything with MATCH functions.
  119577. */
  119578. if( pWC->op==TK_AND && isMatchOfColumn(pExpr, &eOp2) ){
  119579. int idxNew;
  119580. Expr *pRight, *pLeft;
  119581. WhereTerm *pNewTerm;
  119582. Bitmask prereqColumn, prereqExpr;
  119583. pRight = pExpr->x.pList->a[0].pExpr;
  119584. pLeft = pExpr->x.pList->a[1].pExpr;
  119585. prereqExpr = sqlite3WhereExprUsage(pMaskSet, pRight);
  119586. prereqColumn = sqlite3WhereExprUsage(pMaskSet, pLeft);
  119587. if( (prereqExpr & prereqColumn)==0 ){
  119588. Expr *pNewExpr;
  119589. pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
  119590. 0, sqlite3ExprDup(db, pRight, 0), 0);
  119591. idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
  119592. testcase( idxNew==0 );
  119593. pNewTerm = &pWC->a[idxNew];
  119594. pNewTerm->prereqRight = prereqExpr;
  119595. pNewTerm->leftCursor = pLeft->iTable;
  119596. pNewTerm->u.leftColumn = pLeft->iColumn;
  119597. pNewTerm->eOperator = WO_MATCH;
  119598. pNewTerm->eMatchOp = eOp2;
  119599. markTermAsChild(pWC, idxNew, idxTerm);
  119600. pTerm = &pWC->a[idxTerm];
  119601. pTerm->wtFlags |= TERM_COPIED;
  119602. pNewTerm->prereqAll = pTerm->prereqAll;
  119603. }
  119604. }
  119605. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  119606. /* If there is a vector == or IS term - e.g. "(a, b) == (?, ?)" - create
  119607. ** new terms for each component comparison - "a = ?" and "b = ?". The
  119608. ** new terms completely replace the original vector comparison, which is
  119609. ** no longer used.
  119610. **
  119611. ** This is only required if at least one side of the comparison operation
  119612. ** is not a sub-select. */
  119613. if( pWC->op==TK_AND
  119614. && (pExpr->op==TK_EQ || pExpr->op==TK_IS)
  119615. && sqlite3ExprIsVector(pExpr->pLeft)
  119616. && ( (pExpr->pLeft->flags & EP_xIsSelect)==0
  119617. || (pExpr->pRight->flags & EP_xIsSelect)==0
  119618. )){
  119619. int nLeft = sqlite3ExprVectorSize(pExpr->pLeft);
  119620. int i;
  119621. assert( nLeft==sqlite3ExprVectorSize(pExpr->pRight) );
  119622. for(i=0; i<nLeft; i++){
  119623. int idxNew;
  119624. Expr *pNew;
  119625. Expr *pLeft = sqlite3ExprForVectorField(pParse, pExpr->pLeft, i);
  119626. Expr *pRight = sqlite3ExprForVectorField(pParse, pExpr->pRight, i);
  119627. pNew = sqlite3PExpr(pParse, pExpr->op, pLeft, pRight, 0);
  119628. transferJoinMarkings(pNew, pExpr);
  119629. idxNew = whereClauseInsert(pWC, pNew, TERM_DYNAMIC);
  119630. exprAnalyze(pSrc, pWC, idxNew);
  119631. }
  119632. pTerm = &pWC->a[idxTerm];
  119633. pTerm->wtFlags = TERM_CODED|TERM_VIRTUAL; /* Disable the original */
  119634. pTerm->eOperator = 0;
  119635. }
  119636. /* If there is a vector IN term - e.g. "(a, b) IN (SELECT ...)" - create
  119637. ** a virtual term for each vector component. The expression object
  119638. ** used by each such virtual term is pExpr (the full vector IN(...)
  119639. ** expression). The WhereTerm.iField variable identifies the index within
  119640. ** the vector on the LHS that the virtual term represents.
  119641. **
  119642. ** This only works if the RHS is a simple SELECT, not a compound
  119643. */
  119644. if( pWC->op==TK_AND && pExpr->op==TK_IN && pTerm->iField==0
  119645. && pExpr->pLeft->op==TK_VECTOR
  119646. && pExpr->x.pSelect->pPrior==0
  119647. ){
  119648. int i;
  119649. for(i=0; i<sqlite3ExprVectorSize(pExpr->pLeft); i++){
  119650. int idxNew;
  119651. idxNew = whereClauseInsert(pWC, pExpr, TERM_VIRTUAL);
  119652. pWC->a[idxNew].iField = i+1;
  119653. exprAnalyze(pSrc, pWC, idxNew);
  119654. markTermAsChild(pWC, idxNew, idxTerm);
  119655. }
  119656. }
  119657. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  119658. /* When sqlite_stat3 histogram data is available an operator of the
  119659. ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
  119660. ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
  119661. ** virtual term of that form.
  119662. **
  119663. ** Note that the virtual term must be tagged with TERM_VNULL.
  119664. */
  119665. if( pExpr->op==TK_NOTNULL
  119666. && pExpr->pLeft->op==TK_COLUMN
  119667. && pExpr->pLeft->iColumn>=0
  119668. && OptimizationEnabled(db, SQLITE_Stat34)
  119669. ){
  119670. Expr *pNewExpr;
  119671. Expr *pLeft = pExpr->pLeft;
  119672. int idxNew;
  119673. WhereTerm *pNewTerm;
  119674. pNewExpr = sqlite3PExpr(pParse, TK_GT,
  119675. sqlite3ExprDup(db, pLeft, 0),
  119676. sqlite3ExprAlloc(db, TK_NULL, 0, 0), 0);
  119677. idxNew = whereClauseInsert(pWC, pNewExpr,
  119678. TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
  119679. if( idxNew ){
  119680. pNewTerm = &pWC->a[idxNew];
  119681. pNewTerm->prereqRight = 0;
  119682. pNewTerm->leftCursor = pLeft->iTable;
  119683. pNewTerm->u.leftColumn = pLeft->iColumn;
  119684. pNewTerm->eOperator = WO_GT;
  119685. markTermAsChild(pWC, idxNew, idxTerm);
  119686. pTerm = &pWC->a[idxTerm];
  119687. pTerm->wtFlags |= TERM_COPIED;
  119688. pNewTerm->prereqAll = pTerm->prereqAll;
  119689. }
  119690. }
  119691. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  119692. /* Prevent ON clause terms of a LEFT JOIN from being used to drive
  119693. ** an index for tables to the left of the join.
  119694. */
  119695. pTerm->prereqRight |= extraRight;
  119696. }
  119697. /***************************************************************************
  119698. ** Routines with file scope above. Interface to the rest of the where.c
  119699. ** subsystem follows.
  119700. ***************************************************************************/
  119701. /*
  119702. ** This routine identifies subexpressions in the WHERE clause where
  119703. ** each subexpression is separated by the AND operator or some other
  119704. ** operator specified in the op parameter. The WhereClause structure
  119705. ** is filled with pointers to subexpressions. For example:
  119706. **
  119707. ** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
  119708. ** \________/ \_______________/ \________________/
  119709. ** slot[0] slot[1] slot[2]
  119710. **
  119711. ** The original WHERE clause in pExpr is unaltered. All this routine
  119712. ** does is make slot[] entries point to substructure within pExpr.
  119713. **
  119714. ** In the previous sentence and in the diagram, "slot[]" refers to
  119715. ** the WhereClause.a[] array. The slot[] array grows as needed to contain
  119716. ** all terms of the WHERE clause.
  119717. */
  119718. SQLITE_PRIVATE void sqlite3WhereSplit(WhereClause *pWC, Expr *pExpr, u8 op){
  119719. Expr *pE2 = sqlite3ExprSkipCollate(pExpr);
  119720. pWC->op = op;
  119721. if( pE2==0 ) return;
  119722. if( pE2->op!=op ){
  119723. whereClauseInsert(pWC, pExpr, 0);
  119724. }else{
  119725. sqlite3WhereSplit(pWC, pE2->pLeft, op);
  119726. sqlite3WhereSplit(pWC, pE2->pRight, op);
  119727. }
  119728. }
  119729. /*
  119730. ** Initialize a preallocated WhereClause structure.
  119731. */
  119732. SQLITE_PRIVATE void sqlite3WhereClauseInit(
  119733. WhereClause *pWC, /* The WhereClause to be initialized */
  119734. WhereInfo *pWInfo /* The WHERE processing context */
  119735. ){
  119736. pWC->pWInfo = pWInfo;
  119737. pWC->pOuter = 0;
  119738. pWC->nTerm = 0;
  119739. pWC->nSlot = ArraySize(pWC->aStatic);
  119740. pWC->a = pWC->aStatic;
  119741. }
  119742. /*
  119743. ** Deallocate a WhereClause structure. The WhereClause structure
  119744. ** itself is not freed. This routine is the inverse of
  119745. ** sqlite3WhereClauseInit().
  119746. */
  119747. SQLITE_PRIVATE void sqlite3WhereClauseClear(WhereClause *pWC){
  119748. int i;
  119749. WhereTerm *a;
  119750. sqlite3 *db = pWC->pWInfo->pParse->db;
  119751. for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
  119752. if( a->wtFlags & TERM_DYNAMIC ){
  119753. sqlite3ExprDelete(db, a->pExpr);
  119754. }
  119755. if( a->wtFlags & TERM_ORINFO ){
  119756. whereOrInfoDelete(db, a->u.pOrInfo);
  119757. }else if( a->wtFlags & TERM_ANDINFO ){
  119758. whereAndInfoDelete(db, a->u.pAndInfo);
  119759. }
  119760. }
  119761. if( pWC->a!=pWC->aStatic ){
  119762. sqlite3DbFree(db, pWC->a);
  119763. }
  119764. }
  119765. /*
  119766. ** These routines walk (recursively) an expression tree and generate
  119767. ** a bitmask indicating which tables are used in that expression
  119768. ** tree.
  119769. */
  119770. SQLITE_PRIVATE Bitmask sqlite3WhereExprUsage(WhereMaskSet *pMaskSet, Expr *p){
  119771. Bitmask mask;
  119772. if( p==0 ) return 0;
  119773. if( p->op==TK_COLUMN ){
  119774. mask = sqlite3WhereGetMask(pMaskSet, p->iTable);
  119775. return mask;
  119776. }
  119777. assert( !ExprHasProperty(p, EP_TokenOnly) );
  119778. mask = p->pRight ? sqlite3WhereExprUsage(pMaskSet, p->pRight) : 0;
  119779. if( p->pLeft ) mask |= sqlite3WhereExprUsage(pMaskSet, p->pLeft);
  119780. if( ExprHasProperty(p, EP_xIsSelect) ){
  119781. mask |= exprSelectUsage(pMaskSet, p->x.pSelect);
  119782. }else if( p->x.pList ){
  119783. mask |= sqlite3WhereExprListUsage(pMaskSet, p->x.pList);
  119784. }
  119785. return mask;
  119786. }
  119787. SQLITE_PRIVATE Bitmask sqlite3WhereExprListUsage(WhereMaskSet *pMaskSet, ExprList *pList){
  119788. int i;
  119789. Bitmask mask = 0;
  119790. if( pList ){
  119791. for(i=0; i<pList->nExpr; i++){
  119792. mask |= sqlite3WhereExprUsage(pMaskSet, pList->a[i].pExpr);
  119793. }
  119794. }
  119795. return mask;
  119796. }
  119797. /*
  119798. ** Call exprAnalyze on all terms in a WHERE clause.
  119799. **
  119800. ** Note that exprAnalyze() might add new virtual terms onto the
  119801. ** end of the WHERE clause. We do not want to analyze these new
  119802. ** virtual terms, so start analyzing at the end and work forward
  119803. ** so that the added virtual terms are never processed.
  119804. */
  119805. SQLITE_PRIVATE void sqlite3WhereExprAnalyze(
  119806. SrcList *pTabList, /* the FROM clause */
  119807. WhereClause *pWC /* the WHERE clause to be analyzed */
  119808. ){
  119809. int i;
  119810. for(i=pWC->nTerm-1; i>=0; i--){
  119811. exprAnalyze(pTabList, pWC, i);
  119812. }
  119813. }
  119814. /*
  119815. ** For table-valued-functions, transform the function arguments into
  119816. ** new WHERE clause terms.
  119817. **
  119818. ** Each function argument translates into an equality constraint against
  119819. ** a HIDDEN column in the table.
  119820. */
  119821. SQLITE_PRIVATE void sqlite3WhereTabFuncArgs(
  119822. Parse *pParse, /* Parsing context */
  119823. struct SrcList_item *pItem, /* The FROM clause term to process */
  119824. WhereClause *pWC /* Xfer function arguments to here */
  119825. ){
  119826. Table *pTab;
  119827. int j, k;
  119828. ExprList *pArgs;
  119829. Expr *pColRef;
  119830. Expr *pTerm;
  119831. if( pItem->fg.isTabFunc==0 ) return;
  119832. pTab = pItem->pTab;
  119833. assert( pTab!=0 );
  119834. pArgs = pItem->u1.pFuncArg;
  119835. if( pArgs==0 ) return;
  119836. for(j=k=0; j<pArgs->nExpr; j++){
  119837. while( k<pTab->nCol && (pTab->aCol[k].colFlags & COLFLAG_HIDDEN)==0 ){k++;}
  119838. if( k>=pTab->nCol ){
  119839. sqlite3ErrorMsg(pParse, "too many arguments on %s() - max %d",
  119840. pTab->zName, j);
  119841. return;
  119842. }
  119843. pColRef = sqlite3ExprAlloc(pParse->db, TK_COLUMN, 0, 0);
  119844. if( pColRef==0 ) return;
  119845. pColRef->iTable = pItem->iCursor;
  119846. pColRef->iColumn = k++;
  119847. pColRef->pTab = pTab;
  119848. pTerm = sqlite3PExpr(pParse, TK_EQ, pColRef,
  119849. sqlite3ExprDup(pParse->db, pArgs->a[j].pExpr, 0), 0);
  119850. whereClauseInsert(pWC, pTerm, TERM_DYNAMIC);
  119851. }
  119852. }
  119853. /************** End of whereexpr.c *******************************************/
  119854. /************** Begin file where.c *******************************************/
  119855. /*
  119856. ** 2001 September 15
  119857. **
  119858. ** The author disclaims copyright to this source code. In place of
  119859. ** a legal notice, here is a blessing:
  119860. **
  119861. ** May you do good and not evil.
  119862. ** May you find forgiveness for yourself and forgive others.
  119863. ** May you share freely, never taking more than you give.
  119864. **
  119865. *************************************************************************
  119866. ** This module contains C code that generates VDBE code used to process
  119867. ** the WHERE clause of SQL statements. This module is responsible for
  119868. ** generating the code that loops through a table looking for applicable
  119869. ** rows. Indices are selected and used to speed the search when doing
  119870. ** so is applicable. Because this module is responsible for selecting
  119871. ** indices, you might also think of this module as the "query optimizer".
  119872. */
  119873. /* #include "sqliteInt.h" */
  119874. /* #include "whereInt.h" */
  119875. /* Forward declaration of methods */
  119876. static int whereLoopResize(sqlite3*, WhereLoop*, int);
  119877. /* Test variable that can be set to enable WHERE tracing */
  119878. #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
  119879. /***/ int sqlite3WhereTrace = 0;
  119880. #endif
  119881. /*
  119882. ** Return the estimated number of output rows from a WHERE clause
  119883. */
  119884. SQLITE_PRIVATE LogEst sqlite3WhereOutputRowCount(WhereInfo *pWInfo){
  119885. return pWInfo->nRowOut;
  119886. }
  119887. /*
  119888. ** Return one of the WHERE_DISTINCT_xxxxx values to indicate how this
  119889. ** WHERE clause returns outputs for DISTINCT processing.
  119890. */
  119891. SQLITE_PRIVATE int sqlite3WhereIsDistinct(WhereInfo *pWInfo){
  119892. return pWInfo->eDistinct;
  119893. }
  119894. /*
  119895. ** Return TRUE if the WHERE clause returns rows in ORDER BY order.
  119896. ** Return FALSE if the output needs to be sorted.
  119897. */
  119898. SQLITE_PRIVATE int sqlite3WhereIsOrdered(WhereInfo *pWInfo){
  119899. return pWInfo->nOBSat;
  119900. }
  119901. /*
  119902. ** Return TRUE if the innermost loop of the WHERE clause implementation
  119903. ** returns rows in ORDER BY order for complete run of the inner loop.
  119904. **
  119905. ** Across multiple iterations of outer loops, the output rows need not be
  119906. ** sorted. As long as rows are sorted for just the innermost loop, this
  119907. ** routine can return TRUE.
  119908. */
  119909. SQLITE_PRIVATE int sqlite3WhereOrderedInnerLoop(WhereInfo *pWInfo){
  119910. return pWInfo->bOrderedInnerLoop;
  119911. }
  119912. /*
  119913. ** Return the VDBE address or label to jump to in order to continue
  119914. ** immediately with the next row of a WHERE clause.
  119915. */
  119916. SQLITE_PRIVATE int sqlite3WhereContinueLabel(WhereInfo *pWInfo){
  119917. assert( pWInfo->iContinue!=0 );
  119918. return pWInfo->iContinue;
  119919. }
  119920. /*
  119921. ** Return the VDBE address or label to jump to in order to break
  119922. ** out of a WHERE loop.
  119923. */
  119924. SQLITE_PRIVATE int sqlite3WhereBreakLabel(WhereInfo *pWInfo){
  119925. return pWInfo->iBreak;
  119926. }
  119927. /*
  119928. ** Return ONEPASS_OFF (0) if an UPDATE or DELETE statement is unable to
  119929. ** operate directly on the rowis returned by a WHERE clause. Return
  119930. ** ONEPASS_SINGLE (1) if the statement can operation directly because only
  119931. ** a single row is to be changed. Return ONEPASS_MULTI (2) if the one-pass
  119932. ** optimization can be used on multiple
  119933. **
  119934. ** If the ONEPASS optimization is used (if this routine returns true)
  119935. ** then also write the indices of open cursors used by ONEPASS
  119936. ** into aiCur[0] and aiCur[1]. iaCur[0] gets the cursor of the data
  119937. ** table and iaCur[1] gets the cursor used by an auxiliary index.
  119938. ** Either value may be -1, indicating that cursor is not used.
  119939. ** Any cursors returned will have been opened for writing.
  119940. **
  119941. ** aiCur[0] and aiCur[1] both get -1 if the where-clause logic is
  119942. ** unable to use the ONEPASS optimization.
  119943. */
  119944. SQLITE_PRIVATE int sqlite3WhereOkOnePass(WhereInfo *pWInfo, int *aiCur){
  119945. memcpy(aiCur, pWInfo->aiCurOnePass, sizeof(int)*2);
  119946. #ifdef WHERETRACE_ENABLED
  119947. if( sqlite3WhereTrace && pWInfo->eOnePass!=ONEPASS_OFF ){
  119948. sqlite3DebugPrintf("%s cursors: %d %d\n",
  119949. pWInfo->eOnePass==ONEPASS_SINGLE ? "ONEPASS_SINGLE" : "ONEPASS_MULTI",
  119950. aiCur[0], aiCur[1]);
  119951. }
  119952. #endif
  119953. return pWInfo->eOnePass;
  119954. }
  119955. /*
  119956. ** Move the content of pSrc into pDest
  119957. */
  119958. static void whereOrMove(WhereOrSet *pDest, WhereOrSet *pSrc){
  119959. pDest->n = pSrc->n;
  119960. memcpy(pDest->a, pSrc->a, pDest->n*sizeof(pDest->a[0]));
  119961. }
  119962. /*
  119963. ** Try to insert a new prerequisite/cost entry into the WhereOrSet pSet.
  119964. **
  119965. ** The new entry might overwrite an existing entry, or it might be
  119966. ** appended, or it might be discarded. Do whatever is the right thing
  119967. ** so that pSet keeps the N_OR_COST best entries seen so far.
  119968. */
  119969. static int whereOrInsert(
  119970. WhereOrSet *pSet, /* The WhereOrSet to be updated */
  119971. Bitmask prereq, /* Prerequisites of the new entry */
  119972. LogEst rRun, /* Run-cost of the new entry */
  119973. LogEst nOut /* Number of outputs for the new entry */
  119974. ){
  119975. u16 i;
  119976. WhereOrCost *p;
  119977. for(i=pSet->n, p=pSet->a; i>0; i--, p++){
  119978. if( rRun<=p->rRun && (prereq & p->prereq)==prereq ){
  119979. goto whereOrInsert_done;
  119980. }
  119981. if( p->rRun<=rRun && (p->prereq & prereq)==p->prereq ){
  119982. return 0;
  119983. }
  119984. }
  119985. if( pSet->n<N_OR_COST ){
  119986. p = &pSet->a[pSet->n++];
  119987. p->nOut = nOut;
  119988. }else{
  119989. p = pSet->a;
  119990. for(i=1; i<pSet->n; i++){
  119991. if( p->rRun>pSet->a[i].rRun ) p = pSet->a + i;
  119992. }
  119993. if( p->rRun<=rRun ) return 0;
  119994. }
  119995. whereOrInsert_done:
  119996. p->prereq = prereq;
  119997. p->rRun = rRun;
  119998. if( p->nOut>nOut ) p->nOut = nOut;
  119999. return 1;
  120000. }
  120001. /*
  120002. ** Return the bitmask for the given cursor number. Return 0 if
  120003. ** iCursor is not in the set.
  120004. */
  120005. SQLITE_PRIVATE Bitmask sqlite3WhereGetMask(WhereMaskSet *pMaskSet, int iCursor){
  120006. int i;
  120007. assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
  120008. for(i=0; i<pMaskSet->n; i++){
  120009. if( pMaskSet->ix[i]==iCursor ){
  120010. return MASKBIT(i);
  120011. }
  120012. }
  120013. return 0;
  120014. }
  120015. /*
  120016. ** Create a new mask for cursor iCursor.
  120017. **
  120018. ** There is one cursor per table in the FROM clause. The number of
  120019. ** tables in the FROM clause is limited by a test early in the
  120020. ** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
  120021. ** array will never overflow.
  120022. */
  120023. static void createMask(WhereMaskSet *pMaskSet, int iCursor){
  120024. assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
  120025. pMaskSet->ix[pMaskSet->n++] = iCursor;
  120026. }
  120027. /*
  120028. ** Advance to the next WhereTerm that matches according to the criteria
  120029. ** established when the pScan object was initialized by whereScanInit().
  120030. ** Return NULL if there are no more matching WhereTerms.
  120031. */
  120032. static WhereTerm *whereScanNext(WhereScan *pScan){
  120033. int iCur; /* The cursor on the LHS of the term */
  120034. i16 iColumn; /* The column on the LHS of the term. -1 for IPK */
  120035. Expr *pX; /* An expression being tested */
  120036. WhereClause *pWC; /* Shorthand for pScan->pWC */
  120037. WhereTerm *pTerm; /* The term being tested */
  120038. int k = pScan->k; /* Where to start scanning */
  120039. while( pScan->iEquiv<=pScan->nEquiv ){
  120040. iCur = pScan->aiCur[pScan->iEquiv-1];
  120041. iColumn = pScan->aiColumn[pScan->iEquiv-1];
  120042. if( iColumn==XN_EXPR && pScan->pIdxExpr==0 ) return 0;
  120043. while( (pWC = pScan->pWC)!=0 ){
  120044. for(pTerm=pWC->a+k; k<pWC->nTerm; k++, pTerm++){
  120045. if( pTerm->leftCursor==iCur
  120046. && pTerm->u.leftColumn==iColumn
  120047. && (iColumn!=XN_EXPR
  120048. || sqlite3ExprCompare(pTerm->pExpr->pLeft,pScan->pIdxExpr,iCur)==0)
  120049. && (pScan->iEquiv<=1 || !ExprHasProperty(pTerm->pExpr, EP_FromJoin))
  120050. ){
  120051. if( (pTerm->eOperator & WO_EQUIV)!=0
  120052. && pScan->nEquiv<ArraySize(pScan->aiCur)
  120053. && (pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight))->op==TK_COLUMN
  120054. ){
  120055. int j;
  120056. for(j=0; j<pScan->nEquiv; j++){
  120057. if( pScan->aiCur[j]==pX->iTable
  120058. && pScan->aiColumn[j]==pX->iColumn ){
  120059. break;
  120060. }
  120061. }
  120062. if( j==pScan->nEquiv ){
  120063. pScan->aiCur[j] = pX->iTable;
  120064. pScan->aiColumn[j] = pX->iColumn;
  120065. pScan->nEquiv++;
  120066. }
  120067. }
  120068. if( (pTerm->eOperator & pScan->opMask)!=0 ){
  120069. /* Verify the affinity and collating sequence match */
  120070. if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
  120071. CollSeq *pColl;
  120072. Parse *pParse = pWC->pWInfo->pParse;
  120073. pX = pTerm->pExpr;
  120074. if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
  120075. continue;
  120076. }
  120077. assert(pX->pLeft);
  120078. pColl = sqlite3BinaryCompareCollSeq(pParse,
  120079. pX->pLeft, pX->pRight);
  120080. if( pColl==0 ) pColl = pParse->db->pDfltColl;
  120081. if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
  120082. continue;
  120083. }
  120084. }
  120085. if( (pTerm->eOperator & (WO_EQ|WO_IS))!=0
  120086. && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
  120087. && pX->iTable==pScan->aiCur[0]
  120088. && pX->iColumn==pScan->aiColumn[0]
  120089. ){
  120090. testcase( pTerm->eOperator & WO_IS );
  120091. continue;
  120092. }
  120093. pScan->k = k+1;
  120094. return pTerm;
  120095. }
  120096. }
  120097. }
  120098. pScan->pWC = pScan->pWC->pOuter;
  120099. k = 0;
  120100. }
  120101. pScan->pWC = pScan->pOrigWC;
  120102. k = 0;
  120103. pScan->iEquiv++;
  120104. }
  120105. return 0;
  120106. }
  120107. /*
  120108. ** Initialize a WHERE clause scanner object. Return a pointer to the
  120109. ** first match. Return NULL if there are no matches.
  120110. **
  120111. ** The scanner will be searching the WHERE clause pWC. It will look
  120112. ** for terms of the form "X <op> <expr>" where X is column iColumn of table
  120113. ** iCur. Or if pIdx!=0 then X is column iColumn of index pIdx. pIdx
  120114. ** must be one of the indexes of table iCur.
  120115. **
  120116. ** The <op> must be one of the operators described by opMask.
  120117. **
  120118. ** If the search is for X and the WHERE clause contains terms of the
  120119. ** form X=Y then this routine might also return terms of the form
  120120. ** "Y <op> <expr>". The number of levels of transitivity is limited,
  120121. ** but is enough to handle most commonly occurring SQL statements.
  120122. **
  120123. ** If X is not the INTEGER PRIMARY KEY then X must be compatible with
  120124. ** index pIdx.
  120125. */
  120126. static WhereTerm *whereScanInit(
  120127. WhereScan *pScan, /* The WhereScan object being initialized */
  120128. WhereClause *pWC, /* The WHERE clause to be scanned */
  120129. int iCur, /* Cursor to scan for */
  120130. int iColumn, /* Column to scan for */
  120131. u32 opMask, /* Operator(s) to scan for */
  120132. Index *pIdx /* Must be compatible with this index */
  120133. ){
  120134. int j = 0;
  120135. /* memset(pScan, 0, sizeof(*pScan)); */
  120136. pScan->pOrigWC = pWC;
  120137. pScan->pWC = pWC;
  120138. pScan->pIdxExpr = 0;
  120139. if( pIdx ){
  120140. j = iColumn;
  120141. iColumn = pIdx->aiColumn[j];
  120142. if( iColumn==XN_EXPR ) pScan->pIdxExpr = pIdx->aColExpr->a[j].pExpr;
  120143. if( iColumn==pIdx->pTable->iPKey ) iColumn = XN_ROWID;
  120144. }
  120145. if( pIdx && iColumn>=0 ){
  120146. pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
  120147. pScan->zCollName = pIdx->azColl[j];
  120148. }else{
  120149. pScan->idxaff = 0;
  120150. pScan->zCollName = 0;
  120151. }
  120152. pScan->opMask = opMask;
  120153. pScan->k = 0;
  120154. pScan->aiCur[0] = iCur;
  120155. pScan->aiColumn[0] = iColumn;
  120156. pScan->nEquiv = 1;
  120157. pScan->iEquiv = 1;
  120158. return whereScanNext(pScan);
  120159. }
  120160. /*
  120161. ** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
  120162. ** where X is a reference to the iColumn of table iCur or of index pIdx
  120163. ** if pIdx!=0 and <op> is one of the WO_xx operator codes specified by
  120164. ** the op parameter. Return a pointer to the term. Return 0 if not found.
  120165. **
  120166. ** If pIdx!=0 then it must be one of the indexes of table iCur.
  120167. ** Search for terms matching the iColumn-th column of pIdx
  120168. ** rather than the iColumn-th column of table iCur.
  120169. **
  120170. ** The term returned might by Y=<expr> if there is another constraint in
  120171. ** the WHERE clause that specifies that X=Y. Any such constraints will be
  120172. ** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
  120173. ** aiCur[]/iaColumn[] arrays hold X and all its equivalents. There are 11
  120174. ** slots in aiCur[]/aiColumn[] so that means we can look for X plus up to 10
  120175. ** other equivalent values. Hence a search for X will return <expr> if X=A1
  120176. ** and A1=A2 and A2=A3 and ... and A9=A10 and A10=<expr>.
  120177. **
  120178. ** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
  120179. ** then try for the one with no dependencies on <expr> - in other words where
  120180. ** <expr> is a constant expression of some kind. Only return entries of
  120181. ** the form "X <op> Y" where Y is a column in another table if no terms of
  120182. ** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
  120183. ** exist, try to return a term that does not use WO_EQUIV.
  120184. */
  120185. SQLITE_PRIVATE WhereTerm *sqlite3WhereFindTerm(
  120186. WhereClause *pWC, /* The WHERE clause to be searched */
  120187. int iCur, /* Cursor number of LHS */
  120188. int iColumn, /* Column number of LHS */
  120189. Bitmask notReady, /* RHS must not overlap with this mask */
  120190. u32 op, /* Mask of WO_xx values describing operator */
  120191. Index *pIdx /* Must be compatible with this index, if not NULL */
  120192. ){
  120193. WhereTerm *pResult = 0;
  120194. WhereTerm *p;
  120195. WhereScan scan;
  120196. p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
  120197. op &= WO_EQ|WO_IS;
  120198. while( p ){
  120199. if( (p->prereqRight & notReady)==0 ){
  120200. if( p->prereqRight==0 && (p->eOperator&op)!=0 ){
  120201. testcase( p->eOperator & WO_IS );
  120202. return p;
  120203. }
  120204. if( pResult==0 ) pResult = p;
  120205. }
  120206. p = whereScanNext(&scan);
  120207. }
  120208. return pResult;
  120209. }
  120210. /*
  120211. ** This function searches pList for an entry that matches the iCol-th column
  120212. ** of index pIdx.
  120213. **
  120214. ** If such an expression is found, its index in pList->a[] is returned. If
  120215. ** no expression is found, -1 is returned.
  120216. */
  120217. static int findIndexCol(
  120218. Parse *pParse, /* Parse context */
  120219. ExprList *pList, /* Expression list to search */
  120220. int iBase, /* Cursor for table associated with pIdx */
  120221. Index *pIdx, /* Index to match column of */
  120222. int iCol /* Column of index to match */
  120223. ){
  120224. int i;
  120225. const char *zColl = pIdx->azColl[iCol];
  120226. for(i=0; i<pList->nExpr; i++){
  120227. Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
  120228. if( p->op==TK_COLUMN
  120229. && p->iColumn==pIdx->aiColumn[iCol]
  120230. && p->iTable==iBase
  120231. ){
  120232. CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
  120233. if( pColl && 0==sqlite3StrICmp(pColl->zName, zColl) ){
  120234. return i;
  120235. }
  120236. }
  120237. }
  120238. return -1;
  120239. }
  120240. /*
  120241. ** Return TRUE if the iCol-th column of index pIdx is NOT NULL
  120242. */
  120243. static int indexColumnNotNull(Index *pIdx, int iCol){
  120244. int j;
  120245. assert( pIdx!=0 );
  120246. assert( iCol>=0 && iCol<pIdx->nColumn );
  120247. j = pIdx->aiColumn[iCol];
  120248. if( j>=0 ){
  120249. return pIdx->pTable->aCol[j].notNull;
  120250. }else if( j==(-1) ){
  120251. return 1;
  120252. }else{
  120253. assert( j==(-2) );
  120254. return 0; /* Assume an indexed expression can always yield a NULL */
  120255. }
  120256. }
  120257. /*
  120258. ** Return true if the DISTINCT expression-list passed as the third argument
  120259. ** is redundant.
  120260. **
  120261. ** A DISTINCT list is redundant if any subset of the columns in the
  120262. ** DISTINCT list are collectively unique and individually non-null.
  120263. */
  120264. static int isDistinctRedundant(
  120265. Parse *pParse, /* Parsing context */
  120266. SrcList *pTabList, /* The FROM clause */
  120267. WhereClause *pWC, /* The WHERE clause */
  120268. ExprList *pDistinct /* The result set that needs to be DISTINCT */
  120269. ){
  120270. Table *pTab;
  120271. Index *pIdx;
  120272. int i;
  120273. int iBase;
  120274. /* If there is more than one table or sub-select in the FROM clause of
  120275. ** this query, then it will not be possible to show that the DISTINCT
  120276. ** clause is redundant. */
  120277. if( pTabList->nSrc!=1 ) return 0;
  120278. iBase = pTabList->a[0].iCursor;
  120279. pTab = pTabList->a[0].pTab;
  120280. /* If any of the expressions is an IPK column on table iBase, then return
  120281. ** true. Note: The (p->iTable==iBase) part of this test may be false if the
  120282. ** current SELECT is a correlated sub-query.
  120283. */
  120284. for(i=0; i<pDistinct->nExpr; i++){
  120285. Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
  120286. if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
  120287. }
  120288. /* Loop through all indices on the table, checking each to see if it makes
  120289. ** the DISTINCT qualifier redundant. It does so if:
  120290. **
  120291. ** 1. The index is itself UNIQUE, and
  120292. **
  120293. ** 2. All of the columns in the index are either part of the pDistinct
  120294. ** list, or else the WHERE clause contains a term of the form "col=X",
  120295. ** where X is a constant value. The collation sequences of the
  120296. ** comparison and select-list expressions must match those of the index.
  120297. **
  120298. ** 3. All of those index columns for which the WHERE clause does not
  120299. ** contain a "col=X" term are subject to a NOT NULL constraint.
  120300. */
  120301. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  120302. if( !IsUniqueIndex(pIdx) ) continue;
  120303. for(i=0; i<pIdx->nKeyCol; i++){
  120304. if( 0==sqlite3WhereFindTerm(pWC, iBase, i, ~(Bitmask)0, WO_EQ, pIdx) ){
  120305. if( findIndexCol(pParse, pDistinct, iBase, pIdx, i)<0 ) break;
  120306. if( indexColumnNotNull(pIdx, i)==0 ) break;
  120307. }
  120308. }
  120309. if( i==pIdx->nKeyCol ){
  120310. /* This index implies that the DISTINCT qualifier is redundant. */
  120311. return 1;
  120312. }
  120313. }
  120314. return 0;
  120315. }
  120316. /*
  120317. ** Estimate the logarithm of the input value to base 2.
  120318. */
  120319. static LogEst estLog(LogEst N){
  120320. return N<=10 ? 0 : sqlite3LogEst(N) - 33;
  120321. }
  120322. /*
  120323. ** Convert OP_Column opcodes to OP_Copy in previously generated code.
  120324. **
  120325. ** This routine runs over generated VDBE code and translates OP_Column
  120326. ** opcodes into OP_Copy when the table is being accessed via co-routine
  120327. ** instead of via table lookup.
  120328. **
  120329. ** If the bIncrRowid parameter is 0, then any OP_Rowid instructions on
  120330. ** cursor iTabCur are transformed into OP_Null. Or, if bIncrRowid is non-zero,
  120331. ** then each OP_Rowid is transformed into an instruction to increment the
  120332. ** value stored in its output register.
  120333. */
  120334. static void translateColumnToCopy(
  120335. Vdbe *v, /* The VDBE containing code to translate */
  120336. int iStart, /* Translate from this opcode to the end */
  120337. int iTabCur, /* OP_Column/OP_Rowid references to this table */
  120338. int iRegister, /* The first column is in this register */
  120339. int bIncrRowid /* If non-zero, transform OP_rowid to OP_AddImm(1) */
  120340. ){
  120341. VdbeOp *pOp = sqlite3VdbeGetOp(v, iStart);
  120342. int iEnd = sqlite3VdbeCurrentAddr(v);
  120343. for(; iStart<iEnd; iStart++, pOp++){
  120344. if( pOp->p1!=iTabCur ) continue;
  120345. if( pOp->opcode==OP_Column ){
  120346. pOp->opcode = OP_Copy;
  120347. pOp->p1 = pOp->p2 + iRegister;
  120348. pOp->p2 = pOp->p3;
  120349. pOp->p3 = 0;
  120350. }else if( pOp->opcode==OP_Rowid ){
  120351. if( bIncrRowid ){
  120352. /* Increment the value stored in the P2 operand of the OP_Rowid. */
  120353. pOp->opcode = OP_AddImm;
  120354. pOp->p1 = pOp->p2;
  120355. pOp->p2 = 1;
  120356. }else{
  120357. pOp->opcode = OP_Null;
  120358. pOp->p1 = 0;
  120359. pOp->p3 = 0;
  120360. }
  120361. }
  120362. }
  120363. }
  120364. /*
  120365. ** Two routines for printing the content of an sqlite3_index_info
  120366. ** structure. Used for testing and debugging only. If neither
  120367. ** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
  120368. ** are no-ops.
  120369. */
  120370. #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(WHERETRACE_ENABLED)
  120371. static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
  120372. int i;
  120373. if( !sqlite3WhereTrace ) return;
  120374. for(i=0; i<p->nConstraint; i++){
  120375. sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
  120376. i,
  120377. p->aConstraint[i].iColumn,
  120378. p->aConstraint[i].iTermOffset,
  120379. p->aConstraint[i].op,
  120380. p->aConstraint[i].usable);
  120381. }
  120382. for(i=0; i<p->nOrderBy; i++){
  120383. sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
  120384. i,
  120385. p->aOrderBy[i].iColumn,
  120386. p->aOrderBy[i].desc);
  120387. }
  120388. }
  120389. static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
  120390. int i;
  120391. if( !sqlite3WhereTrace ) return;
  120392. for(i=0; i<p->nConstraint; i++){
  120393. sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
  120394. i,
  120395. p->aConstraintUsage[i].argvIndex,
  120396. p->aConstraintUsage[i].omit);
  120397. }
  120398. sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
  120399. sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
  120400. sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
  120401. sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
  120402. sqlite3DebugPrintf(" estimatedRows=%lld\n", p->estimatedRows);
  120403. }
  120404. #else
  120405. #define TRACE_IDX_INPUTS(A)
  120406. #define TRACE_IDX_OUTPUTS(A)
  120407. #endif
  120408. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  120409. /*
  120410. ** Return TRUE if the WHERE clause term pTerm is of a form where it
  120411. ** could be used with an index to access pSrc, assuming an appropriate
  120412. ** index existed.
  120413. */
  120414. static int termCanDriveIndex(
  120415. WhereTerm *pTerm, /* WHERE clause term to check */
  120416. struct SrcList_item *pSrc, /* Table we are trying to access */
  120417. Bitmask notReady /* Tables in outer loops of the join */
  120418. ){
  120419. char aff;
  120420. if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
  120421. if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) return 0;
  120422. if( (pTerm->prereqRight & notReady)!=0 ) return 0;
  120423. if( pTerm->u.leftColumn<0 ) return 0;
  120424. aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
  120425. if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
  120426. testcase( pTerm->pExpr->op==TK_IS );
  120427. return 1;
  120428. }
  120429. #endif
  120430. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  120431. /*
  120432. ** Generate code to construct the Index object for an automatic index
  120433. ** and to set up the WhereLevel object pLevel so that the code generator
  120434. ** makes use of the automatic index.
  120435. */
  120436. static void constructAutomaticIndex(
  120437. Parse *pParse, /* The parsing context */
  120438. WhereClause *pWC, /* The WHERE clause */
  120439. struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
  120440. Bitmask notReady, /* Mask of cursors that are not available */
  120441. WhereLevel *pLevel /* Write new index here */
  120442. ){
  120443. int nKeyCol; /* Number of columns in the constructed index */
  120444. WhereTerm *pTerm; /* A single term of the WHERE clause */
  120445. WhereTerm *pWCEnd; /* End of pWC->a[] */
  120446. Index *pIdx; /* Object describing the transient index */
  120447. Vdbe *v; /* Prepared statement under construction */
  120448. int addrInit; /* Address of the initialization bypass jump */
  120449. Table *pTable; /* The table being indexed */
  120450. int addrTop; /* Top of the index fill loop */
  120451. int regRecord; /* Register holding an index record */
  120452. int n; /* Column counter */
  120453. int i; /* Loop counter */
  120454. int mxBitCol; /* Maximum column in pSrc->colUsed */
  120455. CollSeq *pColl; /* Collating sequence to on a column */
  120456. WhereLoop *pLoop; /* The Loop object */
  120457. char *zNotUsed; /* Extra space on the end of pIdx */
  120458. Bitmask idxCols; /* Bitmap of columns used for indexing */
  120459. Bitmask extraCols; /* Bitmap of additional columns */
  120460. u8 sentWarning = 0; /* True if a warnning has been issued */
  120461. Expr *pPartial = 0; /* Partial Index Expression */
  120462. int iContinue = 0; /* Jump here to skip excluded rows */
  120463. struct SrcList_item *pTabItem; /* FROM clause term being indexed */
  120464. int addrCounter = 0; /* Address where integer counter is initialized */
  120465. int regBase; /* Array of registers where record is assembled */
  120466. /* Generate code to skip over the creation and initialization of the
  120467. ** transient index on 2nd and subsequent iterations of the loop. */
  120468. v = pParse->pVdbe;
  120469. assert( v!=0 );
  120470. addrInit = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  120471. /* Count the number of columns that will be added to the index
  120472. ** and used to match WHERE clause constraints */
  120473. nKeyCol = 0;
  120474. pTable = pSrc->pTab;
  120475. pWCEnd = &pWC->a[pWC->nTerm];
  120476. pLoop = pLevel->pWLoop;
  120477. idxCols = 0;
  120478. for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
  120479. Expr *pExpr = pTerm->pExpr;
  120480. assert( !ExprHasProperty(pExpr, EP_FromJoin) /* prereq always non-zero */
  120481. || pExpr->iRightJoinTable!=pSrc->iCursor /* for the right-hand */
  120482. || pLoop->prereq!=0 ); /* table of a LEFT JOIN */
  120483. if( pLoop->prereq==0
  120484. && (pTerm->wtFlags & TERM_VIRTUAL)==0
  120485. && !ExprHasProperty(pExpr, EP_FromJoin)
  120486. && sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor) ){
  120487. pPartial = sqlite3ExprAnd(pParse->db, pPartial,
  120488. sqlite3ExprDup(pParse->db, pExpr, 0));
  120489. }
  120490. if( termCanDriveIndex(pTerm, pSrc, notReady) ){
  120491. int iCol = pTerm->u.leftColumn;
  120492. Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
  120493. testcase( iCol==BMS );
  120494. testcase( iCol==BMS-1 );
  120495. if( !sentWarning ){
  120496. sqlite3_log(SQLITE_WARNING_AUTOINDEX,
  120497. "automatic index on %s(%s)", pTable->zName,
  120498. pTable->aCol[iCol].zName);
  120499. sentWarning = 1;
  120500. }
  120501. if( (idxCols & cMask)==0 ){
  120502. if( whereLoopResize(pParse->db, pLoop, nKeyCol+1) ){
  120503. goto end_auto_index_create;
  120504. }
  120505. pLoop->aLTerm[nKeyCol++] = pTerm;
  120506. idxCols |= cMask;
  120507. }
  120508. }
  120509. }
  120510. assert( nKeyCol>0 );
  120511. pLoop->u.btree.nEq = pLoop->nLTerm = nKeyCol;
  120512. pLoop->wsFlags = WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WHERE_INDEXED
  120513. | WHERE_AUTO_INDEX;
  120514. /* Count the number of additional columns needed to create a
  120515. ** covering index. A "covering index" is an index that contains all
  120516. ** columns that are needed by the query. With a covering index, the
  120517. ** original table never needs to be accessed. Automatic indices must
  120518. ** be a covering index because the index will not be updated if the
  120519. ** original table changes and the index and table cannot both be used
  120520. ** if they go out of sync.
  120521. */
  120522. extraCols = pSrc->colUsed & (~idxCols | MASKBIT(BMS-1));
  120523. mxBitCol = MIN(BMS-1,pTable->nCol);
  120524. testcase( pTable->nCol==BMS-1 );
  120525. testcase( pTable->nCol==BMS-2 );
  120526. for(i=0; i<mxBitCol; i++){
  120527. if( extraCols & MASKBIT(i) ) nKeyCol++;
  120528. }
  120529. if( pSrc->colUsed & MASKBIT(BMS-1) ){
  120530. nKeyCol += pTable->nCol - BMS + 1;
  120531. }
  120532. /* Construct the Index object to describe this index */
  120533. pIdx = sqlite3AllocateIndexObject(pParse->db, nKeyCol+1, 0, &zNotUsed);
  120534. if( pIdx==0 ) goto end_auto_index_create;
  120535. pLoop->u.btree.pIndex = pIdx;
  120536. pIdx->zName = "auto-index";
  120537. pIdx->pTable = pTable;
  120538. n = 0;
  120539. idxCols = 0;
  120540. for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
  120541. if( termCanDriveIndex(pTerm, pSrc, notReady) ){
  120542. int iCol = pTerm->u.leftColumn;
  120543. Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
  120544. testcase( iCol==BMS-1 );
  120545. testcase( iCol==BMS );
  120546. if( (idxCols & cMask)==0 ){
  120547. Expr *pX = pTerm->pExpr;
  120548. idxCols |= cMask;
  120549. pIdx->aiColumn[n] = pTerm->u.leftColumn;
  120550. pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
  120551. pIdx->azColl[n] = pColl ? pColl->zName : sqlite3StrBINARY;
  120552. n++;
  120553. }
  120554. }
  120555. }
  120556. assert( (u32)n==pLoop->u.btree.nEq );
  120557. /* Add additional columns needed to make the automatic index into
  120558. ** a covering index */
  120559. for(i=0; i<mxBitCol; i++){
  120560. if( extraCols & MASKBIT(i) ){
  120561. pIdx->aiColumn[n] = i;
  120562. pIdx->azColl[n] = sqlite3StrBINARY;
  120563. n++;
  120564. }
  120565. }
  120566. if( pSrc->colUsed & MASKBIT(BMS-1) ){
  120567. for(i=BMS-1; i<pTable->nCol; i++){
  120568. pIdx->aiColumn[n] = i;
  120569. pIdx->azColl[n] = sqlite3StrBINARY;
  120570. n++;
  120571. }
  120572. }
  120573. assert( n==nKeyCol );
  120574. pIdx->aiColumn[n] = XN_ROWID;
  120575. pIdx->azColl[n] = sqlite3StrBINARY;
  120576. /* Create the automatic index */
  120577. assert( pLevel->iIdxCur>=0 );
  120578. pLevel->iIdxCur = pParse->nTab++;
  120579. sqlite3VdbeAddOp2(v, OP_OpenAutoindex, pLevel->iIdxCur, nKeyCol+1);
  120580. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  120581. VdbeComment((v, "for %s", pTable->zName));
  120582. /* Fill the automatic index with content */
  120583. sqlite3ExprCachePush(pParse);
  120584. pTabItem = &pWC->pWInfo->pTabList->a[pLevel->iFrom];
  120585. if( pTabItem->fg.viaCoroutine ){
  120586. int regYield = pTabItem->regReturn;
  120587. addrCounter = sqlite3VdbeAddOp2(v, OP_Integer, 0, 0);
  120588. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
  120589. addrTop = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
  120590. VdbeCoverage(v);
  120591. VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
  120592. }else{
  120593. addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur); VdbeCoverage(v);
  120594. }
  120595. if( pPartial ){
  120596. iContinue = sqlite3VdbeMakeLabel(v);
  120597. sqlite3ExprIfFalse(pParse, pPartial, iContinue, SQLITE_JUMPIFNULL);
  120598. pLoop->wsFlags |= WHERE_PARTIALIDX;
  120599. }
  120600. regRecord = sqlite3GetTempReg(pParse);
  120601. regBase = sqlite3GenerateIndexKey(
  120602. pParse, pIdx, pLevel->iTabCur, regRecord, 0, 0, 0, 0
  120603. );
  120604. sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
  120605. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  120606. if( pPartial ) sqlite3VdbeResolveLabel(v, iContinue);
  120607. if( pTabItem->fg.viaCoroutine ){
  120608. sqlite3VdbeChangeP2(v, addrCounter, regBase+n);
  120609. translateColumnToCopy(v, addrTop, pLevel->iTabCur, pTabItem->regResult, 1);
  120610. sqlite3VdbeGoto(v, addrTop);
  120611. pTabItem->fg.viaCoroutine = 0;
  120612. }else{
  120613. sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1); VdbeCoverage(v);
  120614. }
  120615. sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
  120616. sqlite3VdbeJumpHere(v, addrTop);
  120617. sqlite3ReleaseTempReg(pParse, regRecord);
  120618. sqlite3ExprCachePop(pParse);
  120619. /* Jump here when skipping the initialization */
  120620. sqlite3VdbeJumpHere(v, addrInit);
  120621. end_auto_index_create:
  120622. sqlite3ExprDelete(pParse->db, pPartial);
  120623. }
  120624. #endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
  120625. #ifndef SQLITE_OMIT_VIRTUALTABLE
  120626. /*
  120627. ** Allocate and populate an sqlite3_index_info structure. It is the
  120628. ** responsibility of the caller to eventually release the structure
  120629. ** by passing the pointer returned by this function to sqlite3_free().
  120630. */
  120631. static sqlite3_index_info *allocateIndexInfo(
  120632. Parse *pParse,
  120633. WhereClause *pWC,
  120634. Bitmask mUnusable, /* Ignore terms with these prereqs */
  120635. struct SrcList_item *pSrc,
  120636. ExprList *pOrderBy,
  120637. u16 *pmNoOmit /* Mask of terms not to omit */
  120638. ){
  120639. int i, j;
  120640. int nTerm;
  120641. struct sqlite3_index_constraint *pIdxCons;
  120642. struct sqlite3_index_orderby *pIdxOrderBy;
  120643. struct sqlite3_index_constraint_usage *pUsage;
  120644. WhereTerm *pTerm;
  120645. int nOrderBy;
  120646. sqlite3_index_info *pIdxInfo;
  120647. u16 mNoOmit = 0;
  120648. /* Count the number of possible WHERE clause constraints referring
  120649. ** to this virtual table */
  120650. for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  120651. if( pTerm->leftCursor != pSrc->iCursor ) continue;
  120652. if( pTerm->prereqRight & mUnusable ) continue;
  120653. assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
  120654. testcase( pTerm->eOperator & WO_IN );
  120655. testcase( pTerm->eOperator & WO_ISNULL );
  120656. testcase( pTerm->eOperator & WO_IS );
  120657. testcase( pTerm->eOperator & WO_ALL );
  120658. if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV|WO_IS))==0 ) continue;
  120659. if( pTerm->wtFlags & TERM_VNULL ) continue;
  120660. assert( pTerm->u.leftColumn>=(-1) );
  120661. nTerm++;
  120662. }
  120663. /* If the ORDER BY clause contains only columns in the current
  120664. ** virtual table then allocate space for the aOrderBy part of
  120665. ** the sqlite3_index_info structure.
  120666. */
  120667. nOrderBy = 0;
  120668. if( pOrderBy ){
  120669. int n = pOrderBy->nExpr;
  120670. for(i=0; i<n; i++){
  120671. Expr *pExpr = pOrderBy->a[i].pExpr;
  120672. if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
  120673. }
  120674. if( i==n){
  120675. nOrderBy = n;
  120676. }
  120677. }
  120678. /* Allocate the sqlite3_index_info structure
  120679. */
  120680. pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
  120681. + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
  120682. + sizeof(*pIdxOrderBy)*nOrderBy );
  120683. if( pIdxInfo==0 ){
  120684. sqlite3ErrorMsg(pParse, "out of memory");
  120685. return 0;
  120686. }
  120687. /* Initialize the structure. The sqlite3_index_info structure contains
  120688. ** many fields that are declared "const" to prevent xBestIndex from
  120689. ** changing them. We have to do some funky casting in order to
  120690. ** initialize those fields.
  120691. */
  120692. pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
  120693. pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
  120694. pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
  120695. *(int*)&pIdxInfo->nConstraint = nTerm;
  120696. *(int*)&pIdxInfo->nOrderBy = nOrderBy;
  120697. *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
  120698. *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
  120699. *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
  120700. pUsage;
  120701. for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  120702. u8 op;
  120703. if( pTerm->leftCursor != pSrc->iCursor ) continue;
  120704. if( pTerm->prereqRight & mUnusable ) continue;
  120705. assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
  120706. testcase( pTerm->eOperator & WO_IN );
  120707. testcase( pTerm->eOperator & WO_IS );
  120708. testcase( pTerm->eOperator & WO_ISNULL );
  120709. testcase( pTerm->eOperator & WO_ALL );
  120710. if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV|WO_IS))==0 ) continue;
  120711. if( pTerm->wtFlags & TERM_VNULL ) continue;
  120712. assert( pTerm->u.leftColumn>=(-1) );
  120713. pIdxCons[j].iColumn = pTerm->u.leftColumn;
  120714. pIdxCons[j].iTermOffset = i;
  120715. op = (u8)pTerm->eOperator & WO_ALL;
  120716. if( op==WO_IN ) op = WO_EQ;
  120717. if( op==WO_MATCH ){
  120718. op = pTerm->eMatchOp;
  120719. }
  120720. pIdxCons[j].op = op;
  120721. /* The direct assignment in the previous line is possible only because
  120722. ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
  120723. ** following asserts verify this fact. */
  120724. assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
  120725. assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
  120726. assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
  120727. assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
  120728. assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
  120729. assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
  120730. assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
  120731. if( op & (WO_LT|WO_LE|WO_GT|WO_GE)
  120732. && sqlite3ExprIsVector(pTerm->pExpr->pRight)
  120733. ){
  120734. if( i<16 ) mNoOmit |= (1 << i);
  120735. if( op==WO_LT ) pIdxCons[j].op = WO_LE;
  120736. if( op==WO_GT ) pIdxCons[j].op = WO_GE;
  120737. }
  120738. j++;
  120739. }
  120740. for(i=0; i<nOrderBy; i++){
  120741. Expr *pExpr = pOrderBy->a[i].pExpr;
  120742. pIdxOrderBy[i].iColumn = pExpr->iColumn;
  120743. pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
  120744. }
  120745. *pmNoOmit = mNoOmit;
  120746. return pIdxInfo;
  120747. }
  120748. /*
  120749. ** The table object reference passed as the second argument to this function
  120750. ** must represent a virtual table. This function invokes the xBestIndex()
  120751. ** method of the virtual table with the sqlite3_index_info object that
  120752. ** comes in as the 3rd argument to this function.
  120753. **
  120754. ** If an error occurs, pParse is populated with an error message and a
  120755. ** non-zero value is returned. Otherwise, 0 is returned and the output
  120756. ** part of the sqlite3_index_info structure is left populated.
  120757. **
  120758. ** Whether or not an error is returned, it is the responsibility of the
  120759. ** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
  120760. ** that this is required.
  120761. */
  120762. static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
  120763. sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
  120764. int rc;
  120765. TRACE_IDX_INPUTS(p);
  120766. rc = pVtab->pModule->xBestIndex(pVtab, p);
  120767. TRACE_IDX_OUTPUTS(p);
  120768. if( rc!=SQLITE_OK ){
  120769. if( rc==SQLITE_NOMEM ){
  120770. sqlite3OomFault(pParse->db);
  120771. }else if( !pVtab->zErrMsg ){
  120772. sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
  120773. }else{
  120774. sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
  120775. }
  120776. }
  120777. sqlite3_free(pVtab->zErrMsg);
  120778. pVtab->zErrMsg = 0;
  120779. #if 0
  120780. /* This error is now caught by the caller.
  120781. ** Search for "xBestIndex malfunction" below */
  120782. for(i=0; i<p->nConstraint; i++){
  120783. if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
  120784. sqlite3ErrorMsg(pParse,
  120785. "table %s: xBestIndex returned an invalid plan", pTab->zName);
  120786. }
  120787. }
  120788. #endif
  120789. return pParse->nErr;
  120790. }
  120791. #endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) */
  120792. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  120793. /*
  120794. ** Estimate the location of a particular key among all keys in an
  120795. ** index. Store the results in aStat as follows:
  120796. **
  120797. ** aStat[0] Est. number of rows less than pRec
  120798. ** aStat[1] Est. number of rows equal to pRec
  120799. **
  120800. ** Return the index of the sample that is the smallest sample that
  120801. ** is greater than or equal to pRec. Note that this index is not an index
  120802. ** into the aSample[] array - it is an index into a virtual set of samples
  120803. ** based on the contents of aSample[] and the number of fields in record
  120804. ** pRec.
  120805. */
  120806. static int whereKeyStats(
  120807. Parse *pParse, /* Database connection */
  120808. Index *pIdx, /* Index to consider domain of */
  120809. UnpackedRecord *pRec, /* Vector of values to consider */
  120810. int roundUp, /* Round up if true. Round down if false */
  120811. tRowcnt *aStat /* OUT: stats written here */
  120812. ){
  120813. IndexSample *aSample = pIdx->aSample;
  120814. int iCol; /* Index of required stats in anEq[] etc. */
  120815. int i; /* Index of first sample >= pRec */
  120816. int iSample; /* Smallest sample larger than or equal to pRec */
  120817. int iMin = 0; /* Smallest sample not yet tested */
  120818. int iTest; /* Next sample to test */
  120819. int res; /* Result of comparison operation */
  120820. int nField; /* Number of fields in pRec */
  120821. tRowcnt iLower = 0; /* anLt[] + anEq[] of largest sample pRec is > */
  120822. #ifndef SQLITE_DEBUG
  120823. UNUSED_PARAMETER( pParse );
  120824. #endif
  120825. assert( pRec!=0 );
  120826. assert( pIdx->nSample>0 );
  120827. assert( pRec->nField>0 && pRec->nField<=pIdx->nSampleCol );
  120828. /* Do a binary search to find the first sample greater than or equal
  120829. ** to pRec. If pRec contains a single field, the set of samples to search
  120830. ** is simply the aSample[] array. If the samples in aSample[] contain more
  120831. ** than one fields, all fields following the first are ignored.
  120832. **
  120833. ** If pRec contains N fields, where N is more than one, then as well as the
  120834. ** samples in aSample[] (truncated to N fields), the search also has to
  120835. ** consider prefixes of those samples. For example, if the set of samples
  120836. ** in aSample is:
  120837. **
  120838. ** aSample[0] = (a, 5)
  120839. ** aSample[1] = (a, 10)
  120840. ** aSample[2] = (b, 5)
  120841. ** aSample[3] = (c, 100)
  120842. ** aSample[4] = (c, 105)
  120843. **
  120844. ** Then the search space should ideally be the samples above and the
  120845. ** unique prefixes [a], [b] and [c]. But since that is hard to organize,
  120846. ** the code actually searches this set:
  120847. **
  120848. ** 0: (a)
  120849. ** 1: (a, 5)
  120850. ** 2: (a, 10)
  120851. ** 3: (a, 10)
  120852. ** 4: (b)
  120853. ** 5: (b, 5)
  120854. ** 6: (c)
  120855. ** 7: (c, 100)
  120856. ** 8: (c, 105)
  120857. ** 9: (c, 105)
  120858. **
  120859. ** For each sample in the aSample[] array, N samples are present in the
  120860. ** effective sample array. In the above, samples 0 and 1 are based on
  120861. ** sample aSample[0]. Samples 2 and 3 on aSample[1] etc.
  120862. **
  120863. ** Often, sample i of each block of N effective samples has (i+1) fields.
  120864. ** Except, each sample may be extended to ensure that it is greater than or
  120865. ** equal to the previous sample in the array. For example, in the above,
  120866. ** sample 2 is the first sample of a block of N samples, so at first it
  120867. ** appears that it should be 1 field in size. However, that would make it
  120868. ** smaller than sample 1, so the binary search would not work. As a result,
  120869. ** it is extended to two fields. The duplicates that this creates do not
  120870. ** cause any problems.
  120871. */
  120872. nField = pRec->nField;
  120873. iCol = 0;
  120874. iSample = pIdx->nSample * nField;
  120875. do{
  120876. int iSamp; /* Index in aSample[] of test sample */
  120877. int n; /* Number of fields in test sample */
  120878. iTest = (iMin+iSample)/2;
  120879. iSamp = iTest / nField;
  120880. if( iSamp>0 ){
  120881. /* The proposed effective sample is a prefix of sample aSample[iSamp].
  120882. ** Specifically, the shortest prefix of at least (1 + iTest%nField)
  120883. ** fields that is greater than the previous effective sample. */
  120884. for(n=(iTest % nField) + 1; n<nField; n++){
  120885. if( aSample[iSamp-1].anLt[n-1]!=aSample[iSamp].anLt[n-1] ) break;
  120886. }
  120887. }else{
  120888. n = iTest + 1;
  120889. }
  120890. pRec->nField = n;
  120891. res = sqlite3VdbeRecordCompare(aSample[iSamp].n, aSample[iSamp].p, pRec);
  120892. if( res<0 ){
  120893. iLower = aSample[iSamp].anLt[n-1] + aSample[iSamp].anEq[n-1];
  120894. iMin = iTest+1;
  120895. }else if( res==0 && n<nField ){
  120896. iLower = aSample[iSamp].anLt[n-1];
  120897. iMin = iTest+1;
  120898. res = -1;
  120899. }else{
  120900. iSample = iTest;
  120901. iCol = n-1;
  120902. }
  120903. }while( res && iMin<iSample );
  120904. i = iSample / nField;
  120905. #ifdef SQLITE_DEBUG
  120906. /* The following assert statements check that the binary search code
  120907. ** above found the right answer. This block serves no purpose other
  120908. ** than to invoke the asserts. */
  120909. if( pParse->db->mallocFailed==0 ){
  120910. if( res==0 ){
  120911. /* If (res==0) is true, then pRec must be equal to sample i. */
  120912. assert( i<pIdx->nSample );
  120913. assert( iCol==nField-1 );
  120914. pRec->nField = nField;
  120915. assert( 0==sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)
  120916. || pParse->db->mallocFailed
  120917. );
  120918. }else{
  120919. /* Unless i==pIdx->nSample, indicating that pRec is larger than
  120920. ** all samples in the aSample[] array, pRec must be smaller than the
  120921. ** (iCol+1) field prefix of sample i. */
  120922. assert( i<=pIdx->nSample && i>=0 );
  120923. pRec->nField = iCol+1;
  120924. assert( i==pIdx->nSample
  120925. || sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)>0
  120926. || pParse->db->mallocFailed );
  120927. /* if i==0 and iCol==0, then record pRec is smaller than all samples
  120928. ** in the aSample[] array. Otherwise, if (iCol>0) then pRec must
  120929. ** be greater than or equal to the (iCol) field prefix of sample i.
  120930. ** If (i>0), then pRec must also be greater than sample (i-1). */
  120931. if( iCol>0 ){
  120932. pRec->nField = iCol;
  120933. assert( sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)<=0
  120934. || pParse->db->mallocFailed );
  120935. }
  120936. if( i>0 ){
  120937. pRec->nField = nField;
  120938. assert( sqlite3VdbeRecordCompare(aSample[i-1].n, aSample[i-1].p, pRec)<0
  120939. || pParse->db->mallocFailed );
  120940. }
  120941. }
  120942. }
  120943. #endif /* ifdef SQLITE_DEBUG */
  120944. if( res==0 ){
  120945. /* Record pRec is equal to sample i */
  120946. assert( iCol==nField-1 );
  120947. aStat[0] = aSample[i].anLt[iCol];
  120948. aStat[1] = aSample[i].anEq[iCol];
  120949. }else{
  120950. /* At this point, the (iCol+1) field prefix of aSample[i] is the first
  120951. ** sample that is greater than pRec. Or, if i==pIdx->nSample then pRec
  120952. ** is larger than all samples in the array. */
  120953. tRowcnt iUpper, iGap;
  120954. if( i>=pIdx->nSample ){
  120955. iUpper = sqlite3LogEstToInt(pIdx->aiRowLogEst[0]);
  120956. }else{
  120957. iUpper = aSample[i].anLt[iCol];
  120958. }
  120959. if( iLower>=iUpper ){
  120960. iGap = 0;
  120961. }else{
  120962. iGap = iUpper - iLower;
  120963. }
  120964. if( roundUp ){
  120965. iGap = (iGap*2)/3;
  120966. }else{
  120967. iGap = iGap/3;
  120968. }
  120969. aStat[0] = iLower + iGap;
  120970. aStat[1] = pIdx->aAvgEq[iCol];
  120971. }
  120972. /* Restore the pRec->nField value before returning. */
  120973. pRec->nField = nField;
  120974. return i;
  120975. }
  120976. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  120977. /*
  120978. ** If it is not NULL, pTerm is a term that provides an upper or lower
  120979. ** bound on a range scan. Without considering pTerm, it is estimated
  120980. ** that the scan will visit nNew rows. This function returns the number
  120981. ** estimated to be visited after taking pTerm into account.
  120982. **
  120983. ** If the user explicitly specified a likelihood() value for this term,
  120984. ** then the return value is the likelihood multiplied by the number of
  120985. ** input rows. Otherwise, this function assumes that an "IS NOT NULL" term
  120986. ** has a likelihood of 0.50, and any other term a likelihood of 0.25.
  120987. */
  120988. static LogEst whereRangeAdjust(WhereTerm *pTerm, LogEst nNew){
  120989. LogEst nRet = nNew;
  120990. if( pTerm ){
  120991. if( pTerm->truthProb<=0 ){
  120992. nRet += pTerm->truthProb;
  120993. }else if( (pTerm->wtFlags & TERM_VNULL)==0 ){
  120994. nRet -= 20; assert( 20==sqlite3LogEst(4) );
  120995. }
  120996. }
  120997. return nRet;
  120998. }
  120999. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  121000. /*
  121001. ** Return the affinity for a single column of an index.
  121002. */
  121003. SQLITE_PRIVATE char sqlite3IndexColumnAffinity(sqlite3 *db, Index *pIdx, int iCol){
  121004. assert( iCol>=0 && iCol<pIdx->nColumn );
  121005. if( !pIdx->zColAff ){
  121006. if( sqlite3IndexAffinityStr(db, pIdx)==0 ) return SQLITE_AFF_BLOB;
  121007. }
  121008. return pIdx->zColAff[iCol];
  121009. }
  121010. #endif
  121011. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  121012. /*
  121013. ** This function is called to estimate the number of rows visited by a
  121014. ** range-scan on a skip-scan index. For example:
  121015. **
  121016. ** CREATE INDEX i1 ON t1(a, b, c);
  121017. ** SELECT * FROM t1 WHERE a=? AND c BETWEEN ? AND ?;
  121018. **
  121019. ** Value pLoop->nOut is currently set to the estimated number of rows
  121020. ** visited for scanning (a=? AND b=?). This function reduces that estimate
  121021. ** by some factor to account for the (c BETWEEN ? AND ?) expression based
  121022. ** on the stat4 data for the index. this scan will be peformed multiple
  121023. ** times (once for each (a,b) combination that matches a=?) is dealt with
  121024. ** by the caller.
  121025. **
  121026. ** It does this by scanning through all stat4 samples, comparing values
  121027. ** extracted from pLower and pUpper with the corresponding column in each
  121028. ** sample. If L and U are the number of samples found to be less than or
  121029. ** equal to the values extracted from pLower and pUpper respectively, and
  121030. ** N is the total number of samples, the pLoop->nOut value is adjusted
  121031. ** as follows:
  121032. **
  121033. ** nOut = nOut * ( min(U - L, 1) / N )
  121034. **
  121035. ** If pLower is NULL, or a value cannot be extracted from the term, L is
  121036. ** set to zero. If pUpper is NULL, or a value cannot be extracted from it,
  121037. ** U is set to N.
  121038. **
  121039. ** Normally, this function sets *pbDone to 1 before returning. However,
  121040. ** if no value can be extracted from either pLower or pUpper (and so the
  121041. ** estimate of the number of rows delivered remains unchanged), *pbDone
  121042. ** is left as is.
  121043. **
  121044. ** If an error occurs, an SQLite error code is returned. Otherwise,
  121045. ** SQLITE_OK.
  121046. */
  121047. static int whereRangeSkipScanEst(
  121048. Parse *pParse, /* Parsing & code generating context */
  121049. WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
  121050. WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
  121051. WhereLoop *pLoop, /* Update the .nOut value of this loop */
  121052. int *pbDone /* Set to true if at least one expr. value extracted */
  121053. ){
  121054. Index *p = pLoop->u.btree.pIndex;
  121055. int nEq = pLoop->u.btree.nEq;
  121056. sqlite3 *db = pParse->db;
  121057. int nLower = -1;
  121058. int nUpper = p->nSample+1;
  121059. int rc = SQLITE_OK;
  121060. u8 aff = sqlite3IndexColumnAffinity(db, p, nEq);
  121061. CollSeq *pColl;
  121062. sqlite3_value *p1 = 0; /* Value extracted from pLower */
  121063. sqlite3_value *p2 = 0; /* Value extracted from pUpper */
  121064. sqlite3_value *pVal = 0; /* Value extracted from record */
  121065. pColl = sqlite3LocateCollSeq(pParse, p->azColl[nEq]);
  121066. if( pLower ){
  121067. rc = sqlite3Stat4ValueFromExpr(pParse, pLower->pExpr->pRight, aff, &p1);
  121068. nLower = 0;
  121069. }
  121070. if( pUpper && rc==SQLITE_OK ){
  121071. rc = sqlite3Stat4ValueFromExpr(pParse, pUpper->pExpr->pRight, aff, &p2);
  121072. nUpper = p2 ? 0 : p->nSample;
  121073. }
  121074. if( p1 || p2 ){
  121075. int i;
  121076. int nDiff;
  121077. for(i=0; rc==SQLITE_OK && i<p->nSample; i++){
  121078. rc = sqlite3Stat4Column(db, p->aSample[i].p, p->aSample[i].n, nEq, &pVal);
  121079. if( rc==SQLITE_OK && p1 ){
  121080. int res = sqlite3MemCompare(p1, pVal, pColl);
  121081. if( res>=0 ) nLower++;
  121082. }
  121083. if( rc==SQLITE_OK && p2 ){
  121084. int res = sqlite3MemCompare(p2, pVal, pColl);
  121085. if( res>=0 ) nUpper++;
  121086. }
  121087. }
  121088. nDiff = (nUpper - nLower);
  121089. if( nDiff<=0 ) nDiff = 1;
  121090. /* If there is both an upper and lower bound specified, and the
  121091. ** comparisons indicate that they are close together, use the fallback
  121092. ** method (assume that the scan visits 1/64 of the rows) for estimating
  121093. ** the number of rows visited. Otherwise, estimate the number of rows
  121094. ** using the method described in the header comment for this function. */
  121095. if( nDiff!=1 || pUpper==0 || pLower==0 ){
  121096. int nAdjust = (sqlite3LogEst(p->nSample) - sqlite3LogEst(nDiff));
  121097. pLoop->nOut -= nAdjust;
  121098. *pbDone = 1;
  121099. WHERETRACE(0x10, ("range skip-scan regions: %u..%u adjust=%d est=%d\n",
  121100. nLower, nUpper, nAdjust*-1, pLoop->nOut));
  121101. }
  121102. }else{
  121103. assert( *pbDone==0 );
  121104. }
  121105. sqlite3ValueFree(p1);
  121106. sqlite3ValueFree(p2);
  121107. sqlite3ValueFree(pVal);
  121108. return rc;
  121109. }
  121110. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  121111. /*
  121112. ** This function is used to estimate the number of rows that will be visited
  121113. ** by scanning an index for a range of values. The range may have an upper
  121114. ** bound, a lower bound, or both. The WHERE clause terms that set the upper
  121115. ** and lower bounds are represented by pLower and pUpper respectively. For
  121116. ** example, assuming that index p is on t1(a):
  121117. **
  121118. ** ... FROM t1 WHERE a > ? AND a < ? ...
  121119. ** |_____| |_____|
  121120. ** | |
  121121. ** pLower pUpper
  121122. **
  121123. ** If either of the upper or lower bound is not present, then NULL is passed in
  121124. ** place of the corresponding WhereTerm.
  121125. **
  121126. ** The value in (pBuilder->pNew->u.btree.nEq) is the number of the index
  121127. ** column subject to the range constraint. Or, equivalently, the number of
  121128. ** equality constraints optimized by the proposed index scan. For example,
  121129. ** assuming index p is on t1(a, b), and the SQL query is:
  121130. **
  121131. ** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
  121132. **
  121133. ** then nEq is set to 1 (as the range restricted column, b, is the second
  121134. ** left-most column of the index). Or, if the query is:
  121135. **
  121136. ** ... FROM t1 WHERE a > ? AND a < ? ...
  121137. **
  121138. ** then nEq is set to 0.
  121139. **
  121140. ** When this function is called, *pnOut is set to the sqlite3LogEst() of the
  121141. ** number of rows that the index scan is expected to visit without
  121142. ** considering the range constraints. If nEq is 0, then *pnOut is the number of
  121143. ** rows in the index. Assuming no error occurs, *pnOut is adjusted (reduced)
  121144. ** to account for the range constraints pLower and pUpper.
  121145. **
  121146. ** In the absence of sqlite_stat4 ANALYZE data, or if such data cannot be
  121147. ** used, a single range inequality reduces the search space by a factor of 4.
  121148. ** and a pair of constraints (x>? AND x<?) reduces the expected number of
  121149. ** rows visited by a factor of 64.
  121150. */
  121151. static int whereRangeScanEst(
  121152. Parse *pParse, /* Parsing & code generating context */
  121153. WhereLoopBuilder *pBuilder,
  121154. WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
  121155. WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
  121156. WhereLoop *pLoop /* Modify the .nOut and maybe .rRun fields */
  121157. ){
  121158. int rc = SQLITE_OK;
  121159. int nOut = pLoop->nOut;
  121160. LogEst nNew;
  121161. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  121162. Index *p = pLoop->u.btree.pIndex;
  121163. int nEq = pLoop->u.btree.nEq;
  121164. if( p->nSample>0 && nEq<p->nSampleCol ){
  121165. if( nEq==pBuilder->nRecValid ){
  121166. UnpackedRecord *pRec = pBuilder->pRec;
  121167. tRowcnt a[2];
  121168. int nBtm = pLoop->u.btree.nBtm;
  121169. int nTop = pLoop->u.btree.nTop;
  121170. /* Variable iLower will be set to the estimate of the number of rows in
  121171. ** the index that are less than the lower bound of the range query. The
  121172. ** lower bound being the concatenation of $P and $L, where $P is the
  121173. ** key-prefix formed by the nEq values matched against the nEq left-most
  121174. ** columns of the index, and $L is the value in pLower.
  121175. **
  121176. ** Or, if pLower is NULL or $L cannot be extracted from it (because it
  121177. ** is not a simple variable or literal value), the lower bound of the
  121178. ** range is $P. Due to a quirk in the way whereKeyStats() works, even
  121179. ** if $L is available, whereKeyStats() is called for both ($P) and
  121180. ** ($P:$L) and the larger of the two returned values is used.
  121181. **
  121182. ** Similarly, iUpper is to be set to the estimate of the number of rows
  121183. ** less than the upper bound of the range query. Where the upper bound
  121184. ** is either ($P) or ($P:$U). Again, even if $U is available, both values
  121185. ** of iUpper are requested of whereKeyStats() and the smaller used.
  121186. **
  121187. ** The number of rows between the two bounds is then just iUpper-iLower.
  121188. */
  121189. tRowcnt iLower; /* Rows less than the lower bound */
  121190. tRowcnt iUpper; /* Rows less than the upper bound */
  121191. int iLwrIdx = -2; /* aSample[] for the lower bound */
  121192. int iUprIdx = -1; /* aSample[] for the upper bound */
  121193. if( pRec ){
  121194. testcase( pRec->nField!=pBuilder->nRecValid );
  121195. pRec->nField = pBuilder->nRecValid;
  121196. }
  121197. /* Determine iLower and iUpper using ($P) only. */
  121198. if( nEq==0 ){
  121199. iLower = 0;
  121200. iUpper = p->nRowEst0;
  121201. }else{
  121202. /* Note: this call could be optimized away - since the same values must
  121203. ** have been requested when testing key $P in whereEqualScanEst(). */
  121204. whereKeyStats(pParse, p, pRec, 0, a);
  121205. iLower = a[0];
  121206. iUpper = a[0] + a[1];
  121207. }
  121208. assert( pLower==0 || (pLower->eOperator & (WO_GT|WO_GE))!=0 );
  121209. assert( pUpper==0 || (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
  121210. assert( p->aSortOrder!=0 );
  121211. if( p->aSortOrder[nEq] ){
  121212. /* The roles of pLower and pUpper are swapped for a DESC index */
  121213. SWAP(WhereTerm*, pLower, pUpper);
  121214. SWAP(int, nBtm, nTop);
  121215. }
  121216. /* If possible, improve on the iLower estimate using ($P:$L). */
  121217. if( pLower ){
  121218. int n; /* Values extracted from pExpr */
  121219. Expr *pExpr = pLower->pExpr->pRight;
  121220. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, nBtm, nEq, &n);
  121221. if( rc==SQLITE_OK && n ){
  121222. tRowcnt iNew;
  121223. u16 mask = WO_GT|WO_LE;
  121224. if( sqlite3ExprVectorSize(pExpr)>n ) mask = (WO_LE|WO_LT);
  121225. iLwrIdx = whereKeyStats(pParse, p, pRec, 0, a);
  121226. iNew = a[0] + ((pLower->eOperator & mask) ? a[1] : 0);
  121227. if( iNew>iLower ) iLower = iNew;
  121228. nOut--;
  121229. pLower = 0;
  121230. }
  121231. }
  121232. /* If possible, improve on the iUpper estimate using ($P:$U). */
  121233. if( pUpper ){
  121234. int n; /* Values extracted from pExpr */
  121235. Expr *pExpr = pUpper->pExpr->pRight;
  121236. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, nTop, nEq, &n);
  121237. if( rc==SQLITE_OK && n ){
  121238. tRowcnt iNew;
  121239. u16 mask = WO_GT|WO_LE;
  121240. if( sqlite3ExprVectorSize(pExpr)>n ) mask = (WO_LE|WO_LT);
  121241. iUprIdx = whereKeyStats(pParse, p, pRec, 1, a);
  121242. iNew = a[0] + ((pUpper->eOperator & mask) ? a[1] : 0);
  121243. if( iNew<iUpper ) iUpper = iNew;
  121244. nOut--;
  121245. pUpper = 0;
  121246. }
  121247. }
  121248. pBuilder->pRec = pRec;
  121249. if( rc==SQLITE_OK ){
  121250. if( iUpper>iLower ){
  121251. nNew = sqlite3LogEst(iUpper - iLower);
  121252. /* TUNING: If both iUpper and iLower are derived from the same
  121253. ** sample, then assume they are 4x more selective. This brings
  121254. ** the estimated selectivity more in line with what it would be
  121255. ** if estimated without the use of STAT3/4 tables. */
  121256. if( iLwrIdx==iUprIdx ) nNew -= 20; assert( 20==sqlite3LogEst(4) );
  121257. }else{
  121258. nNew = 10; assert( 10==sqlite3LogEst(2) );
  121259. }
  121260. if( nNew<nOut ){
  121261. nOut = nNew;
  121262. }
  121263. WHERETRACE(0x10, ("STAT4 range scan: %u..%u est=%d\n",
  121264. (u32)iLower, (u32)iUpper, nOut));
  121265. }
  121266. }else{
  121267. int bDone = 0;
  121268. rc = whereRangeSkipScanEst(pParse, pLower, pUpper, pLoop, &bDone);
  121269. if( bDone ) return rc;
  121270. }
  121271. }
  121272. #else
  121273. UNUSED_PARAMETER(pParse);
  121274. UNUSED_PARAMETER(pBuilder);
  121275. assert( pLower || pUpper );
  121276. #endif
  121277. assert( pUpper==0 || (pUpper->wtFlags & TERM_VNULL)==0 );
  121278. nNew = whereRangeAdjust(pLower, nOut);
  121279. nNew = whereRangeAdjust(pUpper, nNew);
  121280. /* TUNING: If there is both an upper and lower limit and neither limit
  121281. ** has an application-defined likelihood(), assume the range is
  121282. ** reduced by an additional 75%. This means that, by default, an open-ended
  121283. ** range query (e.g. col > ?) is assumed to match 1/4 of the rows in the
  121284. ** index. While a closed range (e.g. col BETWEEN ? AND ?) is estimated to
  121285. ** match 1/64 of the index. */
  121286. if( pLower && pLower->truthProb>0 && pUpper && pUpper->truthProb>0 ){
  121287. nNew -= 20;
  121288. }
  121289. nOut -= (pLower!=0) + (pUpper!=0);
  121290. if( nNew<10 ) nNew = 10;
  121291. if( nNew<nOut ) nOut = nNew;
  121292. #if defined(WHERETRACE_ENABLED)
  121293. if( pLoop->nOut>nOut ){
  121294. WHERETRACE(0x10,("Range scan lowers nOut from %d to %d\n",
  121295. pLoop->nOut, nOut));
  121296. }
  121297. #endif
  121298. pLoop->nOut = (LogEst)nOut;
  121299. return rc;
  121300. }
  121301. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  121302. /*
  121303. ** Estimate the number of rows that will be returned based on
  121304. ** an equality constraint x=VALUE and where that VALUE occurs in
  121305. ** the histogram data. This only works when x is the left-most
  121306. ** column of an index and sqlite_stat3 histogram data is available
  121307. ** for that index. When pExpr==NULL that means the constraint is
  121308. ** "x IS NULL" instead of "x=VALUE".
  121309. **
  121310. ** Write the estimated row count into *pnRow and return SQLITE_OK.
  121311. ** If unable to make an estimate, leave *pnRow unchanged and return
  121312. ** non-zero.
  121313. **
  121314. ** This routine can fail if it is unable to load a collating sequence
  121315. ** required for string comparison, or if unable to allocate memory
  121316. ** for a UTF conversion required for comparison. The error is stored
  121317. ** in the pParse structure.
  121318. */
  121319. static int whereEqualScanEst(
  121320. Parse *pParse, /* Parsing & code generating context */
  121321. WhereLoopBuilder *pBuilder,
  121322. Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
  121323. tRowcnt *pnRow /* Write the revised row estimate here */
  121324. ){
  121325. Index *p = pBuilder->pNew->u.btree.pIndex;
  121326. int nEq = pBuilder->pNew->u.btree.nEq;
  121327. UnpackedRecord *pRec = pBuilder->pRec;
  121328. int rc; /* Subfunction return code */
  121329. tRowcnt a[2]; /* Statistics */
  121330. int bOk;
  121331. assert( nEq>=1 );
  121332. assert( nEq<=p->nColumn );
  121333. assert( p->aSample!=0 );
  121334. assert( p->nSample>0 );
  121335. assert( pBuilder->nRecValid<nEq );
  121336. /* If values are not available for all fields of the index to the left
  121337. ** of this one, no estimate can be made. Return SQLITE_NOTFOUND. */
  121338. if( pBuilder->nRecValid<(nEq-1) ){
  121339. return SQLITE_NOTFOUND;
  121340. }
  121341. /* This is an optimization only. The call to sqlite3Stat4ProbeSetValue()
  121342. ** below would return the same value. */
  121343. if( nEq>=p->nColumn ){
  121344. *pnRow = 1;
  121345. return SQLITE_OK;
  121346. }
  121347. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, 1, nEq-1, &bOk);
  121348. pBuilder->pRec = pRec;
  121349. if( rc!=SQLITE_OK ) return rc;
  121350. if( bOk==0 ) return SQLITE_NOTFOUND;
  121351. pBuilder->nRecValid = nEq;
  121352. whereKeyStats(pParse, p, pRec, 0, a);
  121353. WHERETRACE(0x10,("equality scan regions %s(%d): %d\n",
  121354. p->zName, nEq-1, (int)a[1]));
  121355. *pnRow = a[1];
  121356. return rc;
  121357. }
  121358. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  121359. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  121360. /*
  121361. ** Estimate the number of rows that will be returned based on
  121362. ** an IN constraint where the right-hand side of the IN operator
  121363. ** is a list of values. Example:
  121364. **
  121365. ** WHERE x IN (1,2,3,4)
  121366. **
  121367. ** Write the estimated row count into *pnRow and return SQLITE_OK.
  121368. ** If unable to make an estimate, leave *pnRow unchanged and return
  121369. ** non-zero.
  121370. **
  121371. ** This routine can fail if it is unable to load a collating sequence
  121372. ** required for string comparison, or if unable to allocate memory
  121373. ** for a UTF conversion required for comparison. The error is stored
  121374. ** in the pParse structure.
  121375. */
  121376. static int whereInScanEst(
  121377. Parse *pParse, /* Parsing & code generating context */
  121378. WhereLoopBuilder *pBuilder,
  121379. ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
  121380. tRowcnt *pnRow /* Write the revised row estimate here */
  121381. ){
  121382. Index *p = pBuilder->pNew->u.btree.pIndex;
  121383. i64 nRow0 = sqlite3LogEstToInt(p->aiRowLogEst[0]);
  121384. int nRecValid = pBuilder->nRecValid;
  121385. int rc = SQLITE_OK; /* Subfunction return code */
  121386. tRowcnt nEst; /* Number of rows for a single term */
  121387. tRowcnt nRowEst = 0; /* New estimate of the number of rows */
  121388. int i; /* Loop counter */
  121389. assert( p->aSample!=0 );
  121390. for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
  121391. nEst = nRow0;
  121392. rc = whereEqualScanEst(pParse, pBuilder, pList->a[i].pExpr, &nEst);
  121393. nRowEst += nEst;
  121394. pBuilder->nRecValid = nRecValid;
  121395. }
  121396. if( rc==SQLITE_OK ){
  121397. if( nRowEst > nRow0 ) nRowEst = nRow0;
  121398. *pnRow = nRowEst;
  121399. WHERETRACE(0x10,("IN row estimate: est=%d\n", nRowEst));
  121400. }
  121401. assert( pBuilder->nRecValid==nRecValid );
  121402. return rc;
  121403. }
  121404. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  121405. #ifdef WHERETRACE_ENABLED
  121406. /*
  121407. ** Print the content of a WhereTerm object
  121408. */
  121409. static void whereTermPrint(WhereTerm *pTerm, int iTerm){
  121410. if( pTerm==0 ){
  121411. sqlite3DebugPrintf("TERM-%-3d NULL\n", iTerm);
  121412. }else{
  121413. char zType[4];
  121414. char zLeft[50];
  121415. memcpy(zType, "...", 4);
  121416. if( pTerm->wtFlags & TERM_VIRTUAL ) zType[0] = 'V';
  121417. if( pTerm->eOperator & WO_EQUIV ) zType[1] = 'E';
  121418. if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) zType[2] = 'L';
  121419. if( pTerm->eOperator & WO_SINGLE ){
  121420. sqlite3_snprintf(sizeof(zLeft),zLeft,"left={%d:%d}",
  121421. pTerm->leftCursor, pTerm->u.leftColumn);
  121422. }else if( (pTerm->eOperator & WO_OR)!=0 && pTerm->u.pOrInfo!=0 ){
  121423. sqlite3_snprintf(sizeof(zLeft),zLeft,"indexable=0x%lld",
  121424. pTerm->u.pOrInfo->indexable);
  121425. }else{
  121426. sqlite3_snprintf(sizeof(zLeft),zLeft,"left=%d", pTerm->leftCursor);
  121427. }
  121428. sqlite3DebugPrintf(
  121429. "TERM-%-3d %p %s %-12s prob=%-3d op=0x%03x wtFlags=0x%04x",
  121430. iTerm, pTerm, zType, zLeft, pTerm->truthProb,
  121431. pTerm->eOperator, pTerm->wtFlags);
  121432. if( pTerm->iField ){
  121433. sqlite3DebugPrintf(" iField=%d\n", pTerm->iField);
  121434. }else{
  121435. sqlite3DebugPrintf("\n");
  121436. }
  121437. sqlite3TreeViewExpr(0, pTerm->pExpr, 0);
  121438. }
  121439. }
  121440. #endif
  121441. #ifdef WHERETRACE_ENABLED
  121442. /*
  121443. ** Show the complete content of a WhereClause
  121444. */
  121445. SQLITE_PRIVATE void sqlite3WhereClausePrint(WhereClause *pWC){
  121446. int i;
  121447. for(i=0; i<pWC->nTerm; i++){
  121448. whereTermPrint(&pWC->a[i], i);
  121449. }
  121450. }
  121451. #endif
  121452. #ifdef WHERETRACE_ENABLED
  121453. /*
  121454. ** Print a WhereLoop object for debugging purposes
  121455. */
  121456. static void whereLoopPrint(WhereLoop *p, WhereClause *pWC){
  121457. WhereInfo *pWInfo = pWC->pWInfo;
  121458. int nb = 1+(pWInfo->pTabList->nSrc+3)/4;
  121459. struct SrcList_item *pItem = pWInfo->pTabList->a + p->iTab;
  121460. Table *pTab = pItem->pTab;
  121461. Bitmask mAll = (((Bitmask)1)<<(nb*4)) - 1;
  121462. sqlite3DebugPrintf("%c%2d.%0*llx.%0*llx", p->cId,
  121463. p->iTab, nb, p->maskSelf, nb, p->prereq & mAll);
  121464. sqlite3DebugPrintf(" %12s",
  121465. pItem->zAlias ? pItem->zAlias : pTab->zName);
  121466. if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
  121467. const char *zName;
  121468. if( p->u.btree.pIndex && (zName = p->u.btree.pIndex->zName)!=0 ){
  121469. if( strncmp(zName, "sqlite_autoindex_", 17)==0 ){
  121470. int i = sqlite3Strlen30(zName) - 1;
  121471. while( zName[i]!='_' ) i--;
  121472. zName += i;
  121473. }
  121474. sqlite3DebugPrintf(".%-16s %2d", zName, p->u.btree.nEq);
  121475. }else{
  121476. sqlite3DebugPrintf("%20s","");
  121477. }
  121478. }else{
  121479. char *z;
  121480. if( p->u.vtab.idxStr ){
  121481. z = sqlite3_mprintf("(%d,\"%s\",%x)",
  121482. p->u.vtab.idxNum, p->u.vtab.idxStr, p->u.vtab.omitMask);
  121483. }else{
  121484. z = sqlite3_mprintf("(%d,%x)", p->u.vtab.idxNum, p->u.vtab.omitMask);
  121485. }
  121486. sqlite3DebugPrintf(" %-19s", z);
  121487. sqlite3_free(z);
  121488. }
  121489. if( p->wsFlags & WHERE_SKIPSCAN ){
  121490. sqlite3DebugPrintf(" f %05x %d-%d", p->wsFlags, p->nLTerm,p->nSkip);
  121491. }else{
  121492. sqlite3DebugPrintf(" f %05x N %d", p->wsFlags, p->nLTerm);
  121493. }
  121494. sqlite3DebugPrintf(" cost %d,%d,%d\n", p->rSetup, p->rRun, p->nOut);
  121495. if( p->nLTerm && (sqlite3WhereTrace & 0x100)!=0 ){
  121496. int i;
  121497. for(i=0; i<p->nLTerm; i++){
  121498. whereTermPrint(p->aLTerm[i], i);
  121499. }
  121500. }
  121501. }
  121502. #endif
  121503. /*
  121504. ** Convert bulk memory into a valid WhereLoop that can be passed
  121505. ** to whereLoopClear harmlessly.
  121506. */
  121507. static void whereLoopInit(WhereLoop *p){
  121508. p->aLTerm = p->aLTermSpace;
  121509. p->nLTerm = 0;
  121510. p->nLSlot = ArraySize(p->aLTermSpace);
  121511. p->wsFlags = 0;
  121512. }
  121513. /*
  121514. ** Clear the WhereLoop.u union. Leave WhereLoop.pLTerm intact.
  121515. */
  121516. static void whereLoopClearUnion(sqlite3 *db, WhereLoop *p){
  121517. if( p->wsFlags & (WHERE_VIRTUALTABLE|WHERE_AUTO_INDEX) ){
  121518. if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 && p->u.vtab.needFree ){
  121519. sqlite3_free(p->u.vtab.idxStr);
  121520. p->u.vtab.needFree = 0;
  121521. p->u.vtab.idxStr = 0;
  121522. }else if( (p->wsFlags & WHERE_AUTO_INDEX)!=0 && p->u.btree.pIndex!=0 ){
  121523. sqlite3DbFree(db, p->u.btree.pIndex->zColAff);
  121524. sqlite3DbFree(db, p->u.btree.pIndex);
  121525. p->u.btree.pIndex = 0;
  121526. }
  121527. }
  121528. }
  121529. /*
  121530. ** Deallocate internal memory used by a WhereLoop object
  121531. */
  121532. static void whereLoopClear(sqlite3 *db, WhereLoop *p){
  121533. if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
  121534. whereLoopClearUnion(db, p);
  121535. whereLoopInit(p);
  121536. }
  121537. /*
  121538. ** Increase the memory allocation for pLoop->aLTerm[] to be at least n.
  121539. */
  121540. static int whereLoopResize(sqlite3 *db, WhereLoop *p, int n){
  121541. WhereTerm **paNew;
  121542. if( p->nLSlot>=n ) return SQLITE_OK;
  121543. n = (n+7)&~7;
  121544. paNew = sqlite3DbMallocRawNN(db, sizeof(p->aLTerm[0])*n);
  121545. if( paNew==0 ) return SQLITE_NOMEM_BKPT;
  121546. memcpy(paNew, p->aLTerm, sizeof(p->aLTerm[0])*p->nLSlot);
  121547. if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
  121548. p->aLTerm = paNew;
  121549. p->nLSlot = n;
  121550. return SQLITE_OK;
  121551. }
  121552. /*
  121553. ** Transfer content from the second pLoop into the first.
  121554. */
  121555. static int whereLoopXfer(sqlite3 *db, WhereLoop *pTo, WhereLoop *pFrom){
  121556. whereLoopClearUnion(db, pTo);
  121557. if( whereLoopResize(db, pTo, pFrom->nLTerm) ){
  121558. memset(&pTo->u, 0, sizeof(pTo->u));
  121559. return SQLITE_NOMEM_BKPT;
  121560. }
  121561. memcpy(pTo, pFrom, WHERE_LOOP_XFER_SZ);
  121562. memcpy(pTo->aLTerm, pFrom->aLTerm, pTo->nLTerm*sizeof(pTo->aLTerm[0]));
  121563. if( pFrom->wsFlags & WHERE_VIRTUALTABLE ){
  121564. pFrom->u.vtab.needFree = 0;
  121565. }else if( (pFrom->wsFlags & WHERE_AUTO_INDEX)!=0 ){
  121566. pFrom->u.btree.pIndex = 0;
  121567. }
  121568. return SQLITE_OK;
  121569. }
  121570. /*
  121571. ** Delete a WhereLoop object
  121572. */
  121573. static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
  121574. whereLoopClear(db, p);
  121575. sqlite3DbFree(db, p);
  121576. }
  121577. /*
  121578. ** Free a WhereInfo structure
  121579. */
  121580. static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
  121581. if( ALWAYS(pWInfo) ){
  121582. int i;
  121583. for(i=0; i<pWInfo->nLevel; i++){
  121584. WhereLevel *pLevel = &pWInfo->a[i];
  121585. if( pLevel->pWLoop && (pLevel->pWLoop->wsFlags & WHERE_IN_ABLE) ){
  121586. sqlite3DbFree(db, pLevel->u.in.aInLoop);
  121587. }
  121588. }
  121589. sqlite3WhereClauseClear(&pWInfo->sWC);
  121590. while( pWInfo->pLoops ){
  121591. WhereLoop *p = pWInfo->pLoops;
  121592. pWInfo->pLoops = p->pNextLoop;
  121593. whereLoopDelete(db, p);
  121594. }
  121595. sqlite3DbFree(db, pWInfo);
  121596. }
  121597. }
  121598. /*
  121599. ** Return TRUE if all of the following are true:
  121600. **
  121601. ** (1) X has the same or lower cost that Y
  121602. ** (2) X is a proper subset of Y
  121603. ** (3) X skips at least as many columns as Y
  121604. **
  121605. ** By "proper subset" we mean that X uses fewer WHERE clause terms
  121606. ** than Y and that every WHERE clause term used by X is also used
  121607. ** by Y.
  121608. **
  121609. ** If X is a proper subset of Y then Y is a better choice and ought
  121610. ** to have a lower cost. This routine returns TRUE when that cost
  121611. ** relationship is inverted and needs to be adjusted. The third rule
  121612. ** was added because if X uses skip-scan less than Y it still might
  121613. ** deserve a lower cost even if it is a proper subset of Y.
  121614. */
  121615. static int whereLoopCheaperProperSubset(
  121616. const WhereLoop *pX, /* First WhereLoop to compare */
  121617. const WhereLoop *pY /* Compare against this WhereLoop */
  121618. ){
  121619. int i, j;
  121620. if( pX->nLTerm-pX->nSkip >= pY->nLTerm-pY->nSkip ){
  121621. return 0; /* X is not a subset of Y */
  121622. }
  121623. if( pY->nSkip > pX->nSkip ) return 0;
  121624. if( pX->rRun >= pY->rRun ){
  121625. if( pX->rRun > pY->rRun ) return 0; /* X costs more than Y */
  121626. if( pX->nOut > pY->nOut ) return 0; /* X costs more than Y */
  121627. }
  121628. for(i=pX->nLTerm-1; i>=0; i--){
  121629. if( pX->aLTerm[i]==0 ) continue;
  121630. for(j=pY->nLTerm-1; j>=0; j--){
  121631. if( pY->aLTerm[j]==pX->aLTerm[i] ) break;
  121632. }
  121633. if( j<0 ) return 0; /* X not a subset of Y since term X[i] not used by Y */
  121634. }
  121635. return 1; /* All conditions meet */
  121636. }
  121637. /*
  121638. ** Try to adjust the cost of WhereLoop pTemplate upwards or downwards so
  121639. ** that:
  121640. **
  121641. ** (1) pTemplate costs less than any other WhereLoops that are a proper
  121642. ** subset of pTemplate
  121643. **
  121644. ** (2) pTemplate costs more than any other WhereLoops for which pTemplate
  121645. ** is a proper subset.
  121646. **
  121647. ** To say "WhereLoop X is a proper subset of Y" means that X uses fewer
  121648. ** WHERE clause terms than Y and that every WHERE clause term used by X is
  121649. ** also used by Y.
  121650. */
  121651. static void whereLoopAdjustCost(const WhereLoop *p, WhereLoop *pTemplate){
  121652. if( (pTemplate->wsFlags & WHERE_INDEXED)==0 ) return;
  121653. for(; p; p=p->pNextLoop){
  121654. if( p->iTab!=pTemplate->iTab ) continue;
  121655. if( (p->wsFlags & WHERE_INDEXED)==0 ) continue;
  121656. if( whereLoopCheaperProperSubset(p, pTemplate) ){
  121657. /* Adjust pTemplate cost downward so that it is cheaper than its
  121658. ** subset p. */
  121659. WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
  121660. pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut-1));
  121661. pTemplate->rRun = p->rRun;
  121662. pTemplate->nOut = p->nOut - 1;
  121663. }else if( whereLoopCheaperProperSubset(pTemplate, p) ){
  121664. /* Adjust pTemplate cost upward so that it is costlier than p since
  121665. ** pTemplate is a proper subset of p */
  121666. WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
  121667. pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut+1));
  121668. pTemplate->rRun = p->rRun;
  121669. pTemplate->nOut = p->nOut + 1;
  121670. }
  121671. }
  121672. }
  121673. /*
  121674. ** Search the list of WhereLoops in *ppPrev looking for one that can be
  121675. ** supplanted by pTemplate.
  121676. **
  121677. ** Return NULL if the WhereLoop list contains an entry that can supplant
  121678. ** pTemplate, in other words if pTemplate does not belong on the list.
  121679. **
  121680. ** If pX is a WhereLoop that pTemplate can supplant, then return the
  121681. ** link that points to pX.
  121682. **
  121683. ** If pTemplate cannot supplant any existing element of the list but needs
  121684. ** to be added to the list, then return a pointer to the tail of the list.
  121685. */
  121686. static WhereLoop **whereLoopFindLesser(
  121687. WhereLoop **ppPrev,
  121688. const WhereLoop *pTemplate
  121689. ){
  121690. WhereLoop *p;
  121691. for(p=(*ppPrev); p; ppPrev=&p->pNextLoop, p=*ppPrev){
  121692. if( p->iTab!=pTemplate->iTab || p->iSortIdx!=pTemplate->iSortIdx ){
  121693. /* If either the iTab or iSortIdx values for two WhereLoop are different
  121694. ** then those WhereLoops need to be considered separately. Neither is
  121695. ** a candidate to replace the other. */
  121696. continue;
  121697. }
  121698. /* In the current implementation, the rSetup value is either zero
  121699. ** or the cost of building an automatic index (NlogN) and the NlogN
  121700. ** is the same for compatible WhereLoops. */
  121701. assert( p->rSetup==0 || pTemplate->rSetup==0
  121702. || p->rSetup==pTemplate->rSetup );
  121703. /* whereLoopAddBtree() always generates and inserts the automatic index
  121704. ** case first. Hence compatible candidate WhereLoops never have a larger
  121705. ** rSetup. Call this SETUP-INVARIANT */
  121706. assert( p->rSetup>=pTemplate->rSetup );
  121707. /* Any loop using an appliation-defined index (or PRIMARY KEY or
  121708. ** UNIQUE constraint) with one or more == constraints is better
  121709. ** than an automatic index. Unless it is a skip-scan. */
  121710. if( (p->wsFlags & WHERE_AUTO_INDEX)!=0
  121711. && (pTemplate->nSkip)==0
  121712. && (pTemplate->wsFlags & WHERE_INDEXED)!=0
  121713. && (pTemplate->wsFlags & WHERE_COLUMN_EQ)!=0
  121714. && (p->prereq & pTemplate->prereq)==pTemplate->prereq
  121715. ){
  121716. break;
  121717. }
  121718. /* If existing WhereLoop p is better than pTemplate, pTemplate can be
  121719. ** discarded. WhereLoop p is better if:
  121720. ** (1) p has no more dependencies than pTemplate, and
  121721. ** (2) p has an equal or lower cost than pTemplate
  121722. */
  121723. if( (p->prereq & pTemplate->prereq)==p->prereq /* (1) */
  121724. && p->rSetup<=pTemplate->rSetup /* (2a) */
  121725. && p->rRun<=pTemplate->rRun /* (2b) */
  121726. && p->nOut<=pTemplate->nOut /* (2c) */
  121727. ){
  121728. return 0; /* Discard pTemplate */
  121729. }
  121730. /* If pTemplate is always better than p, then cause p to be overwritten
  121731. ** with pTemplate. pTemplate is better than p if:
  121732. ** (1) pTemplate has no more dependences than p, and
  121733. ** (2) pTemplate has an equal or lower cost than p.
  121734. */
  121735. if( (p->prereq & pTemplate->prereq)==pTemplate->prereq /* (1) */
  121736. && p->rRun>=pTemplate->rRun /* (2a) */
  121737. && p->nOut>=pTemplate->nOut /* (2b) */
  121738. ){
  121739. assert( p->rSetup>=pTemplate->rSetup ); /* SETUP-INVARIANT above */
  121740. break; /* Cause p to be overwritten by pTemplate */
  121741. }
  121742. }
  121743. return ppPrev;
  121744. }
  121745. /*
  121746. ** Insert or replace a WhereLoop entry using the template supplied.
  121747. **
  121748. ** An existing WhereLoop entry might be overwritten if the new template
  121749. ** is better and has fewer dependencies. Or the template will be ignored
  121750. ** and no insert will occur if an existing WhereLoop is faster and has
  121751. ** fewer dependencies than the template. Otherwise a new WhereLoop is
  121752. ** added based on the template.
  121753. **
  121754. ** If pBuilder->pOrSet is not NULL then we care about only the
  121755. ** prerequisites and rRun and nOut costs of the N best loops. That
  121756. ** information is gathered in the pBuilder->pOrSet object. This special
  121757. ** processing mode is used only for OR clause processing.
  121758. **
  121759. ** When accumulating multiple loops (when pBuilder->pOrSet is NULL) we
  121760. ** still might overwrite similar loops with the new template if the
  121761. ** new template is better. Loops may be overwritten if the following
  121762. ** conditions are met:
  121763. **
  121764. ** (1) They have the same iTab.
  121765. ** (2) They have the same iSortIdx.
  121766. ** (3) The template has same or fewer dependencies than the current loop
  121767. ** (4) The template has the same or lower cost than the current loop
  121768. */
  121769. static int whereLoopInsert(WhereLoopBuilder *pBuilder, WhereLoop *pTemplate){
  121770. WhereLoop **ppPrev, *p;
  121771. WhereInfo *pWInfo = pBuilder->pWInfo;
  121772. sqlite3 *db = pWInfo->pParse->db;
  121773. int rc;
  121774. /* If pBuilder->pOrSet is defined, then only keep track of the costs
  121775. ** and prereqs.
  121776. */
  121777. if( pBuilder->pOrSet!=0 ){
  121778. if( pTemplate->nLTerm ){
  121779. #if WHERETRACE_ENABLED
  121780. u16 n = pBuilder->pOrSet->n;
  121781. int x =
  121782. #endif
  121783. whereOrInsert(pBuilder->pOrSet, pTemplate->prereq, pTemplate->rRun,
  121784. pTemplate->nOut);
  121785. #if WHERETRACE_ENABLED /* 0x8 */
  121786. if( sqlite3WhereTrace & 0x8 ){
  121787. sqlite3DebugPrintf(x?" or-%d: ":" or-X: ", n);
  121788. whereLoopPrint(pTemplate, pBuilder->pWC);
  121789. }
  121790. #endif
  121791. }
  121792. return SQLITE_OK;
  121793. }
  121794. /* Look for an existing WhereLoop to replace with pTemplate
  121795. */
  121796. whereLoopAdjustCost(pWInfo->pLoops, pTemplate);
  121797. ppPrev = whereLoopFindLesser(&pWInfo->pLoops, pTemplate);
  121798. if( ppPrev==0 ){
  121799. /* There already exists a WhereLoop on the list that is better
  121800. ** than pTemplate, so just ignore pTemplate */
  121801. #if WHERETRACE_ENABLED /* 0x8 */
  121802. if( sqlite3WhereTrace & 0x8 ){
  121803. sqlite3DebugPrintf(" skip: ");
  121804. whereLoopPrint(pTemplate, pBuilder->pWC);
  121805. }
  121806. #endif
  121807. return SQLITE_OK;
  121808. }else{
  121809. p = *ppPrev;
  121810. }
  121811. /* If we reach this point it means that either p[] should be overwritten
  121812. ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
  121813. ** WhereLoop and insert it.
  121814. */
  121815. #if WHERETRACE_ENABLED /* 0x8 */
  121816. if( sqlite3WhereTrace & 0x8 ){
  121817. if( p!=0 ){
  121818. sqlite3DebugPrintf("replace: ");
  121819. whereLoopPrint(p, pBuilder->pWC);
  121820. }
  121821. sqlite3DebugPrintf(" add: ");
  121822. whereLoopPrint(pTemplate, pBuilder->pWC);
  121823. }
  121824. #endif
  121825. if( p==0 ){
  121826. /* Allocate a new WhereLoop to add to the end of the list */
  121827. *ppPrev = p = sqlite3DbMallocRawNN(db, sizeof(WhereLoop));
  121828. if( p==0 ) return SQLITE_NOMEM_BKPT;
  121829. whereLoopInit(p);
  121830. p->pNextLoop = 0;
  121831. }else{
  121832. /* We will be overwriting WhereLoop p[]. But before we do, first
  121833. ** go through the rest of the list and delete any other entries besides
  121834. ** p[] that are also supplated by pTemplate */
  121835. WhereLoop **ppTail = &p->pNextLoop;
  121836. WhereLoop *pToDel;
  121837. while( *ppTail ){
  121838. ppTail = whereLoopFindLesser(ppTail, pTemplate);
  121839. if( ppTail==0 ) break;
  121840. pToDel = *ppTail;
  121841. if( pToDel==0 ) break;
  121842. *ppTail = pToDel->pNextLoop;
  121843. #if WHERETRACE_ENABLED /* 0x8 */
  121844. if( sqlite3WhereTrace & 0x8 ){
  121845. sqlite3DebugPrintf(" delete: ");
  121846. whereLoopPrint(pToDel, pBuilder->pWC);
  121847. }
  121848. #endif
  121849. whereLoopDelete(db, pToDel);
  121850. }
  121851. }
  121852. rc = whereLoopXfer(db, p, pTemplate);
  121853. if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
  121854. Index *pIndex = p->u.btree.pIndex;
  121855. if( pIndex && pIndex->tnum==0 ){
  121856. p->u.btree.pIndex = 0;
  121857. }
  121858. }
  121859. return rc;
  121860. }
  121861. /*
  121862. ** Adjust the WhereLoop.nOut value downward to account for terms of the
  121863. ** WHERE clause that reference the loop but which are not used by an
  121864. ** index.
  121865. *
  121866. ** For every WHERE clause term that is not used by the index
  121867. ** and which has a truth probability assigned by one of the likelihood(),
  121868. ** likely(), or unlikely() SQL functions, reduce the estimated number
  121869. ** of output rows by the probability specified.
  121870. **
  121871. ** TUNING: For every WHERE clause term that is not used by the index
  121872. ** and which does not have an assigned truth probability, heuristics
  121873. ** described below are used to try to estimate the truth probability.
  121874. ** TODO --> Perhaps this is something that could be improved by better
  121875. ** table statistics.
  121876. **
  121877. ** Heuristic 1: Estimate the truth probability as 93.75%. The 93.75%
  121878. ** value corresponds to -1 in LogEst notation, so this means decrement
  121879. ** the WhereLoop.nOut field for every such WHERE clause term.
  121880. **
  121881. ** Heuristic 2: If there exists one or more WHERE clause terms of the
  121882. ** form "x==EXPR" and EXPR is not a constant 0 or 1, then make sure the
  121883. ** final output row estimate is no greater than 1/4 of the total number
  121884. ** of rows in the table. In other words, assume that x==EXPR will filter
  121885. ** out at least 3 out of 4 rows. If EXPR is -1 or 0 or 1, then maybe the
  121886. ** "x" column is boolean or else -1 or 0 or 1 is a common default value
  121887. ** on the "x" column and so in that case only cap the output row estimate
  121888. ** at 1/2 instead of 1/4.
  121889. */
  121890. static void whereLoopOutputAdjust(
  121891. WhereClause *pWC, /* The WHERE clause */
  121892. WhereLoop *pLoop, /* The loop to adjust downward */
  121893. LogEst nRow /* Number of rows in the entire table */
  121894. ){
  121895. WhereTerm *pTerm, *pX;
  121896. Bitmask notAllowed = ~(pLoop->prereq|pLoop->maskSelf);
  121897. int i, j, k;
  121898. LogEst iReduce = 0; /* pLoop->nOut should not exceed nRow-iReduce */
  121899. assert( (pLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
  121900. for(i=pWC->nTerm, pTerm=pWC->a; i>0; i--, pTerm++){
  121901. if( (pTerm->wtFlags & TERM_VIRTUAL)!=0 ) break;
  121902. if( (pTerm->prereqAll & pLoop->maskSelf)==0 ) continue;
  121903. if( (pTerm->prereqAll & notAllowed)!=0 ) continue;
  121904. for(j=pLoop->nLTerm-1; j>=0; j--){
  121905. pX = pLoop->aLTerm[j];
  121906. if( pX==0 ) continue;
  121907. if( pX==pTerm ) break;
  121908. if( pX->iParent>=0 && (&pWC->a[pX->iParent])==pTerm ) break;
  121909. }
  121910. if( j<0 ){
  121911. if( pTerm->truthProb<=0 ){
  121912. /* If a truth probability is specified using the likelihood() hints,
  121913. ** then use the probability provided by the application. */
  121914. pLoop->nOut += pTerm->truthProb;
  121915. }else{
  121916. /* In the absence of explicit truth probabilities, use heuristics to
  121917. ** guess a reasonable truth probability. */
  121918. pLoop->nOut--;
  121919. if( pTerm->eOperator&(WO_EQ|WO_IS) ){
  121920. Expr *pRight = pTerm->pExpr->pRight;
  121921. testcase( pTerm->pExpr->op==TK_IS );
  121922. if( sqlite3ExprIsInteger(pRight, &k) && k>=(-1) && k<=1 ){
  121923. k = 10;
  121924. }else{
  121925. k = 20;
  121926. }
  121927. if( iReduce<k ) iReduce = k;
  121928. }
  121929. }
  121930. }
  121931. }
  121932. if( pLoop->nOut > nRow-iReduce ) pLoop->nOut = nRow - iReduce;
  121933. }
  121934. /*
  121935. ** Term pTerm is a vector range comparison operation. The first comparison
  121936. ** in the vector can be optimized using column nEq of the index. This
  121937. ** function returns the total number of vector elements that can be used
  121938. ** as part of the range comparison.
  121939. **
  121940. ** For example, if the query is:
  121941. **
  121942. ** WHERE a = ? AND (b, c, d) > (?, ?, ?)
  121943. **
  121944. ** and the index:
  121945. **
  121946. ** CREATE INDEX ... ON (a, b, c, d, e)
  121947. **
  121948. ** then this function would be invoked with nEq=1. The value returned in
  121949. ** this case is 3.
  121950. */
  121951. static int whereRangeVectorLen(
  121952. Parse *pParse, /* Parsing context */
  121953. int iCur, /* Cursor open on pIdx */
  121954. Index *pIdx, /* The index to be used for a inequality constraint */
  121955. int nEq, /* Number of prior equality constraints on same index */
  121956. WhereTerm *pTerm /* The vector inequality constraint */
  121957. ){
  121958. int nCmp = sqlite3ExprVectorSize(pTerm->pExpr->pLeft);
  121959. int i;
  121960. nCmp = MIN(nCmp, (pIdx->nColumn - nEq));
  121961. for(i=1; i<nCmp; i++){
  121962. /* Test if comparison i of pTerm is compatible with column (i+nEq)
  121963. ** of the index. If not, exit the loop. */
  121964. char aff; /* Comparison affinity */
  121965. char idxaff = 0; /* Indexed columns affinity */
  121966. CollSeq *pColl; /* Comparison collation sequence */
  121967. Expr *pLhs = pTerm->pExpr->pLeft->x.pList->a[i].pExpr;
  121968. Expr *pRhs = pTerm->pExpr->pRight;
  121969. if( pRhs->flags & EP_xIsSelect ){
  121970. pRhs = pRhs->x.pSelect->pEList->a[i].pExpr;
  121971. }else{
  121972. pRhs = pRhs->x.pList->a[i].pExpr;
  121973. }
  121974. /* Check that the LHS of the comparison is a column reference to
  121975. ** the right column of the right source table. And that the sort
  121976. ** order of the index column is the same as the sort order of the
  121977. ** leftmost index column. */
  121978. if( pLhs->op!=TK_COLUMN
  121979. || pLhs->iTable!=iCur
  121980. || pLhs->iColumn!=pIdx->aiColumn[i+nEq]
  121981. || pIdx->aSortOrder[i+nEq]!=pIdx->aSortOrder[nEq]
  121982. ){
  121983. break;
  121984. }
  121985. testcase( pLhs->iColumn==XN_ROWID );
  121986. aff = sqlite3CompareAffinity(pRhs, sqlite3ExprAffinity(pLhs));
  121987. idxaff = sqlite3TableColumnAffinity(pIdx->pTable, pLhs->iColumn);
  121988. if( aff!=idxaff ) break;
  121989. pColl = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
  121990. if( pColl==0 ) break;
  121991. if( sqlite3StrICmp(pColl->zName, pIdx->azColl[i+nEq]) ) break;
  121992. }
  121993. return i;
  121994. }
  121995. /*
  121996. ** Adjust the cost C by the costMult facter T. This only occurs if
  121997. ** compiled with -DSQLITE_ENABLE_COSTMULT
  121998. */
  121999. #ifdef SQLITE_ENABLE_COSTMULT
  122000. # define ApplyCostMultiplier(C,T) C += T
  122001. #else
  122002. # define ApplyCostMultiplier(C,T)
  122003. #endif
  122004. /*
  122005. ** We have so far matched pBuilder->pNew->u.btree.nEq terms of the
  122006. ** index pIndex. Try to match one more.
  122007. **
  122008. ** When this function is called, pBuilder->pNew->nOut contains the
  122009. ** number of rows expected to be visited by filtering using the nEq
  122010. ** terms only. If it is modified, this value is restored before this
  122011. ** function returns.
  122012. **
  122013. ** If pProbe->tnum==0, that means pIndex is a fake index used for the
  122014. ** INTEGER PRIMARY KEY.
  122015. */
  122016. static int whereLoopAddBtreeIndex(
  122017. WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
  122018. struct SrcList_item *pSrc, /* FROM clause term being analyzed */
  122019. Index *pProbe, /* An index on pSrc */
  122020. LogEst nInMul /* log(Number of iterations due to IN) */
  122021. ){
  122022. WhereInfo *pWInfo = pBuilder->pWInfo; /* WHERE analyse context */
  122023. Parse *pParse = pWInfo->pParse; /* Parsing context */
  122024. sqlite3 *db = pParse->db; /* Database connection malloc context */
  122025. WhereLoop *pNew; /* Template WhereLoop under construction */
  122026. WhereTerm *pTerm; /* A WhereTerm under consideration */
  122027. int opMask; /* Valid operators for constraints */
  122028. WhereScan scan; /* Iterator for WHERE terms */
  122029. Bitmask saved_prereq; /* Original value of pNew->prereq */
  122030. u16 saved_nLTerm; /* Original value of pNew->nLTerm */
  122031. u16 saved_nEq; /* Original value of pNew->u.btree.nEq */
  122032. u16 saved_nBtm; /* Original value of pNew->u.btree.nBtm */
  122033. u16 saved_nTop; /* Original value of pNew->u.btree.nTop */
  122034. u16 saved_nSkip; /* Original value of pNew->nSkip */
  122035. u32 saved_wsFlags; /* Original value of pNew->wsFlags */
  122036. LogEst saved_nOut; /* Original value of pNew->nOut */
  122037. int rc = SQLITE_OK; /* Return code */
  122038. LogEst rSize; /* Number of rows in the table */
  122039. LogEst rLogSize; /* Logarithm of table size */
  122040. WhereTerm *pTop = 0, *pBtm = 0; /* Top and bottom range constraints */
  122041. pNew = pBuilder->pNew;
  122042. if( db->mallocFailed ) return SQLITE_NOMEM_BKPT;
  122043. WHERETRACE(0x800, ("BEGIN addBtreeIdx(%s), nEq=%d\n",
  122044. pProbe->zName, pNew->u.btree.nEq));
  122045. assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
  122046. assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
  122047. if( pNew->wsFlags & WHERE_BTM_LIMIT ){
  122048. opMask = WO_LT|WO_LE;
  122049. }else{
  122050. assert( pNew->u.btree.nBtm==0 );
  122051. opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE|WO_ISNULL|WO_IS;
  122052. }
  122053. if( pProbe->bUnordered ) opMask &= ~(WO_GT|WO_GE|WO_LT|WO_LE);
  122054. assert( pNew->u.btree.nEq<pProbe->nColumn );
  122055. saved_nEq = pNew->u.btree.nEq;
  122056. saved_nBtm = pNew->u.btree.nBtm;
  122057. saved_nTop = pNew->u.btree.nTop;
  122058. saved_nSkip = pNew->nSkip;
  122059. saved_nLTerm = pNew->nLTerm;
  122060. saved_wsFlags = pNew->wsFlags;
  122061. saved_prereq = pNew->prereq;
  122062. saved_nOut = pNew->nOut;
  122063. pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, saved_nEq,
  122064. opMask, pProbe);
  122065. pNew->rSetup = 0;
  122066. rSize = pProbe->aiRowLogEst[0];
  122067. rLogSize = estLog(rSize);
  122068. for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
  122069. u16 eOp = pTerm->eOperator; /* Shorthand for pTerm->eOperator */
  122070. LogEst rCostIdx;
  122071. LogEst nOutUnadjusted; /* nOut before IN() and WHERE adjustments */
  122072. int nIn = 0;
  122073. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122074. int nRecValid = pBuilder->nRecValid;
  122075. #endif
  122076. if( (eOp==WO_ISNULL || (pTerm->wtFlags&TERM_VNULL)!=0)
  122077. && indexColumnNotNull(pProbe, saved_nEq)
  122078. ){
  122079. continue; /* ignore IS [NOT] NULL constraints on NOT NULL columns */
  122080. }
  122081. if( pTerm->prereqRight & pNew->maskSelf ) continue;
  122082. /* Do not allow the upper bound of a LIKE optimization range constraint
  122083. ** to mix with a lower range bound from some other source */
  122084. if( pTerm->wtFlags & TERM_LIKEOPT && pTerm->eOperator==WO_LT ) continue;
  122085. /* Do not allow IS constraints from the WHERE clause to be used by the
  122086. ** right table of a LEFT JOIN. Only constraints in the ON clause are
  122087. ** allowed */
  122088. if( (pSrc->fg.jointype & JT_LEFT)!=0
  122089. && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
  122090. && (eOp & (WO_IS|WO_ISNULL))!=0
  122091. ){
  122092. testcase( eOp & WO_IS );
  122093. testcase( eOp & WO_ISNULL );
  122094. continue;
  122095. }
  122096. pNew->wsFlags = saved_wsFlags;
  122097. pNew->u.btree.nEq = saved_nEq;
  122098. pNew->u.btree.nBtm = saved_nBtm;
  122099. pNew->u.btree.nTop = saved_nTop;
  122100. pNew->nLTerm = saved_nLTerm;
  122101. if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
  122102. pNew->aLTerm[pNew->nLTerm++] = pTerm;
  122103. pNew->prereq = (saved_prereq | pTerm->prereqRight) & ~pNew->maskSelf;
  122104. assert( nInMul==0
  122105. || (pNew->wsFlags & WHERE_COLUMN_NULL)!=0
  122106. || (pNew->wsFlags & WHERE_COLUMN_IN)!=0
  122107. || (pNew->wsFlags & WHERE_SKIPSCAN)!=0
  122108. );
  122109. if( eOp & WO_IN ){
  122110. Expr *pExpr = pTerm->pExpr;
  122111. pNew->wsFlags |= WHERE_COLUMN_IN;
  122112. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  122113. /* "x IN (SELECT ...)": TUNING: the SELECT returns 25 rows */
  122114. int i;
  122115. nIn = 46; assert( 46==sqlite3LogEst(25) );
  122116. /* The expression may actually be of the form (x, y) IN (SELECT...).
  122117. ** In this case there is a separate term for each of (x) and (y).
  122118. ** However, the nIn multiplier should only be applied once, not once
  122119. ** for each such term. The following loop checks that pTerm is the
  122120. ** first such term in use, and sets nIn back to 0 if it is not. */
  122121. for(i=0; i<pNew->nLTerm-1; i++){
  122122. if( pNew->aLTerm[i] && pNew->aLTerm[i]->pExpr==pExpr ) nIn = 0;
  122123. }
  122124. }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
  122125. /* "x IN (value, value, ...)" */
  122126. nIn = sqlite3LogEst(pExpr->x.pList->nExpr);
  122127. assert( nIn>0 ); /* RHS always has 2 or more terms... The parser
  122128. ** changes "x IN (?)" into "x=?". */
  122129. }
  122130. }else if( eOp & (WO_EQ|WO_IS) ){
  122131. int iCol = pProbe->aiColumn[saved_nEq];
  122132. pNew->wsFlags |= WHERE_COLUMN_EQ;
  122133. assert( saved_nEq==pNew->u.btree.nEq );
  122134. if( iCol==XN_ROWID
  122135. || (iCol>0 && nInMul==0 && saved_nEq==pProbe->nKeyCol-1)
  122136. ){
  122137. if( iCol>=0 && pProbe->uniqNotNull==0 ){
  122138. pNew->wsFlags |= WHERE_UNQ_WANTED;
  122139. }else{
  122140. pNew->wsFlags |= WHERE_ONEROW;
  122141. }
  122142. }
  122143. }else if( eOp & WO_ISNULL ){
  122144. pNew->wsFlags |= WHERE_COLUMN_NULL;
  122145. }else if( eOp & (WO_GT|WO_GE) ){
  122146. testcase( eOp & WO_GT );
  122147. testcase( eOp & WO_GE );
  122148. pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
  122149. pNew->u.btree.nBtm = whereRangeVectorLen(
  122150. pParse, pSrc->iCursor, pProbe, saved_nEq, pTerm
  122151. );
  122152. pBtm = pTerm;
  122153. pTop = 0;
  122154. if( pTerm->wtFlags & TERM_LIKEOPT ){
  122155. /* Range contraints that come from the LIKE optimization are
  122156. ** always used in pairs. */
  122157. pTop = &pTerm[1];
  122158. assert( (pTop-(pTerm->pWC->a))<pTerm->pWC->nTerm );
  122159. assert( pTop->wtFlags & TERM_LIKEOPT );
  122160. assert( pTop->eOperator==WO_LT );
  122161. if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
  122162. pNew->aLTerm[pNew->nLTerm++] = pTop;
  122163. pNew->wsFlags |= WHERE_TOP_LIMIT;
  122164. pNew->u.btree.nTop = 1;
  122165. }
  122166. }else{
  122167. assert( eOp & (WO_LT|WO_LE) );
  122168. testcase( eOp & WO_LT );
  122169. testcase( eOp & WO_LE );
  122170. pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
  122171. pNew->u.btree.nTop = whereRangeVectorLen(
  122172. pParse, pSrc->iCursor, pProbe, saved_nEq, pTerm
  122173. );
  122174. pTop = pTerm;
  122175. pBtm = (pNew->wsFlags & WHERE_BTM_LIMIT)!=0 ?
  122176. pNew->aLTerm[pNew->nLTerm-2] : 0;
  122177. }
  122178. /* At this point pNew->nOut is set to the number of rows expected to
  122179. ** be visited by the index scan before considering term pTerm, or the
  122180. ** values of nIn and nInMul. In other words, assuming that all
  122181. ** "x IN(...)" terms are replaced with "x = ?". This block updates
  122182. ** the value of pNew->nOut to account for pTerm (but not nIn/nInMul). */
  122183. assert( pNew->nOut==saved_nOut );
  122184. if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
  122185. /* Adjust nOut using stat3/stat4 data. Or, if there is no stat3/stat4
  122186. ** data, using some other estimate. */
  122187. whereRangeScanEst(pParse, pBuilder, pBtm, pTop, pNew);
  122188. }else{
  122189. int nEq = ++pNew->u.btree.nEq;
  122190. assert( eOp & (WO_ISNULL|WO_EQ|WO_IN|WO_IS) );
  122191. assert( pNew->nOut==saved_nOut );
  122192. if( pTerm->truthProb<=0 && pProbe->aiColumn[saved_nEq]>=0 ){
  122193. assert( (eOp & WO_IN) || nIn==0 );
  122194. testcase( eOp & WO_IN );
  122195. pNew->nOut += pTerm->truthProb;
  122196. pNew->nOut -= nIn;
  122197. }else{
  122198. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122199. tRowcnt nOut = 0;
  122200. if( nInMul==0
  122201. && pProbe->nSample
  122202. && pNew->u.btree.nEq<=pProbe->nSampleCol
  122203. && ((eOp & WO_IN)==0 || !ExprHasProperty(pTerm->pExpr, EP_xIsSelect))
  122204. ){
  122205. Expr *pExpr = pTerm->pExpr;
  122206. if( (eOp & (WO_EQ|WO_ISNULL|WO_IS))!=0 ){
  122207. testcase( eOp & WO_EQ );
  122208. testcase( eOp & WO_IS );
  122209. testcase( eOp & WO_ISNULL );
  122210. rc = whereEqualScanEst(pParse, pBuilder, pExpr->pRight, &nOut);
  122211. }else{
  122212. rc = whereInScanEst(pParse, pBuilder, pExpr->x.pList, &nOut);
  122213. }
  122214. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  122215. if( rc!=SQLITE_OK ) break; /* Jump out of the pTerm loop */
  122216. if( nOut ){
  122217. pNew->nOut = sqlite3LogEst(nOut);
  122218. if( pNew->nOut>saved_nOut ) pNew->nOut = saved_nOut;
  122219. pNew->nOut -= nIn;
  122220. }
  122221. }
  122222. if( nOut==0 )
  122223. #endif
  122224. {
  122225. pNew->nOut += (pProbe->aiRowLogEst[nEq] - pProbe->aiRowLogEst[nEq-1]);
  122226. if( eOp & WO_ISNULL ){
  122227. /* TUNING: If there is no likelihood() value, assume that a
  122228. ** "col IS NULL" expression matches twice as many rows
  122229. ** as (col=?). */
  122230. pNew->nOut += 10;
  122231. }
  122232. }
  122233. }
  122234. }
  122235. /* Set rCostIdx to the cost of visiting selected rows in index. Add
  122236. ** it to pNew->rRun, which is currently set to the cost of the index
  122237. ** seek only. Then, if this is a non-covering index, add the cost of
  122238. ** visiting the rows in the main table. */
  122239. rCostIdx = pNew->nOut + 1 + (15*pProbe->szIdxRow)/pSrc->pTab->szTabRow;
  122240. pNew->rRun = sqlite3LogEstAdd(rLogSize, rCostIdx);
  122241. if( (pNew->wsFlags & (WHERE_IDX_ONLY|WHERE_IPK))==0 ){
  122242. pNew->rRun = sqlite3LogEstAdd(pNew->rRun, pNew->nOut + 16);
  122243. }
  122244. ApplyCostMultiplier(pNew->rRun, pProbe->pTable->costMult);
  122245. nOutUnadjusted = pNew->nOut;
  122246. pNew->rRun += nInMul + nIn;
  122247. pNew->nOut += nInMul + nIn;
  122248. whereLoopOutputAdjust(pBuilder->pWC, pNew, rSize);
  122249. rc = whereLoopInsert(pBuilder, pNew);
  122250. if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
  122251. pNew->nOut = saved_nOut;
  122252. }else{
  122253. pNew->nOut = nOutUnadjusted;
  122254. }
  122255. if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
  122256. && pNew->u.btree.nEq<pProbe->nColumn
  122257. ){
  122258. whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul+nIn);
  122259. }
  122260. pNew->nOut = saved_nOut;
  122261. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122262. pBuilder->nRecValid = nRecValid;
  122263. #endif
  122264. }
  122265. pNew->prereq = saved_prereq;
  122266. pNew->u.btree.nEq = saved_nEq;
  122267. pNew->u.btree.nBtm = saved_nBtm;
  122268. pNew->u.btree.nTop = saved_nTop;
  122269. pNew->nSkip = saved_nSkip;
  122270. pNew->wsFlags = saved_wsFlags;
  122271. pNew->nOut = saved_nOut;
  122272. pNew->nLTerm = saved_nLTerm;
  122273. /* Consider using a skip-scan if there are no WHERE clause constraints
  122274. ** available for the left-most terms of the index, and if the average
  122275. ** number of repeats in the left-most terms is at least 18.
  122276. **
  122277. ** The magic number 18 is selected on the basis that scanning 17 rows
  122278. ** is almost always quicker than an index seek (even though if the index
  122279. ** contains fewer than 2^17 rows we assume otherwise in other parts of
  122280. ** the code). And, even if it is not, it should not be too much slower.
  122281. ** On the other hand, the extra seeks could end up being significantly
  122282. ** more expensive. */
  122283. assert( 42==sqlite3LogEst(18) );
  122284. if( saved_nEq==saved_nSkip
  122285. && saved_nEq+1<pProbe->nKeyCol
  122286. && pProbe->noSkipScan==0
  122287. && pProbe->aiRowLogEst[saved_nEq+1]>=42 /* TUNING: Minimum for skip-scan */
  122288. && (rc = whereLoopResize(db, pNew, pNew->nLTerm+1))==SQLITE_OK
  122289. ){
  122290. LogEst nIter;
  122291. pNew->u.btree.nEq++;
  122292. pNew->nSkip++;
  122293. pNew->aLTerm[pNew->nLTerm++] = 0;
  122294. pNew->wsFlags |= WHERE_SKIPSCAN;
  122295. nIter = pProbe->aiRowLogEst[saved_nEq] - pProbe->aiRowLogEst[saved_nEq+1];
  122296. pNew->nOut -= nIter;
  122297. /* TUNING: Because uncertainties in the estimates for skip-scan queries,
  122298. ** add a 1.375 fudge factor to make skip-scan slightly less likely. */
  122299. nIter += 5;
  122300. whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nIter + nInMul);
  122301. pNew->nOut = saved_nOut;
  122302. pNew->u.btree.nEq = saved_nEq;
  122303. pNew->nSkip = saved_nSkip;
  122304. pNew->wsFlags = saved_wsFlags;
  122305. }
  122306. WHERETRACE(0x800, ("END addBtreeIdx(%s), nEq=%d, rc=%d\n",
  122307. pProbe->zName, saved_nEq, rc));
  122308. return rc;
  122309. }
  122310. /*
  122311. ** Return True if it is possible that pIndex might be useful in
  122312. ** implementing the ORDER BY clause in pBuilder.
  122313. **
  122314. ** Return False if pBuilder does not contain an ORDER BY clause or
  122315. ** if there is no way for pIndex to be useful in implementing that
  122316. ** ORDER BY clause.
  122317. */
  122318. static int indexMightHelpWithOrderBy(
  122319. WhereLoopBuilder *pBuilder,
  122320. Index *pIndex,
  122321. int iCursor
  122322. ){
  122323. ExprList *pOB;
  122324. ExprList *aColExpr;
  122325. int ii, jj;
  122326. if( pIndex->bUnordered ) return 0;
  122327. if( (pOB = pBuilder->pWInfo->pOrderBy)==0 ) return 0;
  122328. for(ii=0; ii<pOB->nExpr; ii++){
  122329. Expr *pExpr = sqlite3ExprSkipCollate(pOB->a[ii].pExpr);
  122330. if( pExpr->op==TK_COLUMN && pExpr->iTable==iCursor ){
  122331. if( pExpr->iColumn<0 ) return 1;
  122332. for(jj=0; jj<pIndex->nKeyCol; jj++){
  122333. if( pExpr->iColumn==pIndex->aiColumn[jj] ) return 1;
  122334. }
  122335. }else if( (aColExpr = pIndex->aColExpr)!=0 ){
  122336. for(jj=0; jj<pIndex->nKeyCol; jj++){
  122337. if( pIndex->aiColumn[jj]!=XN_EXPR ) continue;
  122338. if( sqlite3ExprCompare(pExpr,aColExpr->a[jj].pExpr,iCursor)==0 ){
  122339. return 1;
  122340. }
  122341. }
  122342. }
  122343. }
  122344. return 0;
  122345. }
  122346. /*
  122347. ** Return a bitmask where 1s indicate that the corresponding column of
  122348. ** the table is used by an index. Only the first 63 columns are considered.
  122349. */
  122350. static Bitmask columnsInIndex(Index *pIdx){
  122351. Bitmask m = 0;
  122352. int j;
  122353. for(j=pIdx->nColumn-1; j>=0; j--){
  122354. int x = pIdx->aiColumn[j];
  122355. if( x>=0 ){
  122356. testcase( x==BMS-1 );
  122357. testcase( x==BMS-2 );
  122358. if( x<BMS-1 ) m |= MASKBIT(x);
  122359. }
  122360. }
  122361. return m;
  122362. }
  122363. /* Check to see if a partial index with pPartIndexWhere can be used
  122364. ** in the current query. Return true if it can be and false if not.
  122365. */
  122366. static int whereUsablePartialIndex(int iTab, WhereClause *pWC, Expr *pWhere){
  122367. int i;
  122368. WhereTerm *pTerm;
  122369. while( pWhere->op==TK_AND ){
  122370. if( !whereUsablePartialIndex(iTab,pWC,pWhere->pLeft) ) return 0;
  122371. pWhere = pWhere->pRight;
  122372. }
  122373. for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  122374. Expr *pExpr = pTerm->pExpr;
  122375. if( sqlite3ExprImpliesExpr(pExpr, pWhere, iTab)
  122376. && (!ExprHasProperty(pExpr, EP_FromJoin) || pExpr->iRightJoinTable==iTab)
  122377. ){
  122378. return 1;
  122379. }
  122380. }
  122381. return 0;
  122382. }
  122383. /*
  122384. ** Add all WhereLoop objects for a single table of the join where the table
  122385. ** is identified by pBuilder->pNew->iTab. That table is guaranteed to be
  122386. ** a b-tree table, not a virtual table.
  122387. **
  122388. ** The costs (WhereLoop.rRun) of the b-tree loops added by this function
  122389. ** are calculated as follows:
  122390. **
  122391. ** For a full scan, assuming the table (or index) contains nRow rows:
  122392. **
  122393. ** cost = nRow * 3.0 // full-table scan
  122394. ** cost = nRow * K // scan of covering index
  122395. ** cost = nRow * (K+3.0) // scan of non-covering index
  122396. **
  122397. ** where K is a value between 1.1 and 3.0 set based on the relative
  122398. ** estimated average size of the index and table records.
  122399. **
  122400. ** For an index scan, where nVisit is the number of index rows visited
  122401. ** by the scan, and nSeek is the number of seek operations required on
  122402. ** the index b-tree:
  122403. **
  122404. ** cost = nSeek * (log(nRow) + K * nVisit) // covering index
  122405. ** cost = nSeek * (log(nRow) + (K+3.0) * nVisit) // non-covering index
  122406. **
  122407. ** Normally, nSeek is 1. nSeek values greater than 1 come about if the
  122408. ** WHERE clause includes "x IN (....)" terms used in place of "x=?". Or when
  122409. ** implicit "x IN (SELECT x FROM tbl)" terms are added for skip-scans.
  122410. **
  122411. ** The estimated values (nRow, nVisit, nSeek) often contain a large amount
  122412. ** of uncertainty. For this reason, scoring is designed to pick plans that
  122413. ** "do the least harm" if the estimates are inaccurate. For example, a
  122414. ** log(nRow) factor is omitted from a non-covering index scan in order to
  122415. ** bias the scoring in favor of using an index, since the worst-case
  122416. ** performance of using an index is far better than the worst-case performance
  122417. ** of a full table scan.
  122418. */
  122419. static int whereLoopAddBtree(
  122420. WhereLoopBuilder *pBuilder, /* WHERE clause information */
  122421. Bitmask mPrereq /* Extra prerequesites for using this table */
  122422. ){
  122423. WhereInfo *pWInfo; /* WHERE analysis context */
  122424. Index *pProbe; /* An index we are evaluating */
  122425. Index sPk; /* A fake index object for the primary key */
  122426. LogEst aiRowEstPk[2]; /* The aiRowLogEst[] value for the sPk index */
  122427. i16 aiColumnPk = -1; /* The aColumn[] value for the sPk index */
  122428. SrcList *pTabList; /* The FROM clause */
  122429. struct SrcList_item *pSrc; /* The FROM clause btree term to add */
  122430. WhereLoop *pNew; /* Template WhereLoop object */
  122431. int rc = SQLITE_OK; /* Return code */
  122432. int iSortIdx = 1; /* Index number */
  122433. int b; /* A boolean value */
  122434. LogEst rSize; /* number of rows in the table */
  122435. LogEst rLogSize; /* Logarithm of the number of rows in the table */
  122436. WhereClause *pWC; /* The parsed WHERE clause */
  122437. Table *pTab; /* Table being queried */
  122438. pNew = pBuilder->pNew;
  122439. pWInfo = pBuilder->pWInfo;
  122440. pTabList = pWInfo->pTabList;
  122441. pSrc = pTabList->a + pNew->iTab;
  122442. pTab = pSrc->pTab;
  122443. pWC = pBuilder->pWC;
  122444. assert( !IsVirtual(pSrc->pTab) );
  122445. if( pSrc->pIBIndex ){
  122446. /* An INDEXED BY clause specifies a particular index to use */
  122447. pProbe = pSrc->pIBIndex;
  122448. }else if( !HasRowid(pTab) ){
  122449. pProbe = pTab->pIndex;
  122450. }else{
  122451. /* There is no INDEXED BY clause. Create a fake Index object in local
  122452. ** variable sPk to represent the rowid primary key index. Make this
  122453. ** fake index the first in a chain of Index objects with all of the real
  122454. ** indices to follow */
  122455. Index *pFirst; /* First of real indices on the table */
  122456. memset(&sPk, 0, sizeof(Index));
  122457. sPk.nKeyCol = 1;
  122458. sPk.nColumn = 1;
  122459. sPk.aiColumn = &aiColumnPk;
  122460. sPk.aiRowLogEst = aiRowEstPk;
  122461. sPk.onError = OE_Replace;
  122462. sPk.pTable = pTab;
  122463. sPk.szIdxRow = pTab->szTabRow;
  122464. aiRowEstPk[0] = pTab->nRowLogEst;
  122465. aiRowEstPk[1] = 0;
  122466. pFirst = pSrc->pTab->pIndex;
  122467. if( pSrc->fg.notIndexed==0 ){
  122468. /* The real indices of the table are only considered if the
  122469. ** NOT INDEXED qualifier is omitted from the FROM clause */
  122470. sPk.pNext = pFirst;
  122471. }
  122472. pProbe = &sPk;
  122473. }
  122474. rSize = pTab->nRowLogEst;
  122475. rLogSize = estLog(rSize);
  122476. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  122477. /* Automatic indexes */
  122478. if( !pBuilder->pOrSet /* Not part of an OR optimization */
  122479. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  122480. && (pWInfo->pParse->db->flags & SQLITE_AutoIndex)!=0
  122481. && pSrc->pIBIndex==0 /* Has no INDEXED BY clause */
  122482. && !pSrc->fg.notIndexed /* Has no NOT INDEXED clause */
  122483. && HasRowid(pTab) /* Not WITHOUT ROWID table. (FIXME: Why not?) */
  122484. && !pSrc->fg.isCorrelated /* Not a correlated subquery */
  122485. && !pSrc->fg.isRecursive /* Not a recursive common table expression. */
  122486. ){
  122487. /* Generate auto-index WhereLoops */
  122488. WhereTerm *pTerm;
  122489. WhereTerm *pWCEnd = pWC->a + pWC->nTerm;
  122490. for(pTerm=pWC->a; rc==SQLITE_OK && pTerm<pWCEnd; pTerm++){
  122491. if( pTerm->prereqRight & pNew->maskSelf ) continue;
  122492. if( termCanDriveIndex(pTerm, pSrc, 0) ){
  122493. pNew->u.btree.nEq = 1;
  122494. pNew->nSkip = 0;
  122495. pNew->u.btree.pIndex = 0;
  122496. pNew->nLTerm = 1;
  122497. pNew->aLTerm[0] = pTerm;
  122498. /* TUNING: One-time cost for computing the automatic index is
  122499. ** estimated to be X*N*log2(N) where N is the number of rows in
  122500. ** the table being indexed and where X is 7 (LogEst=28) for normal
  122501. ** tables or 1.375 (LogEst=4) for views and subqueries. The value
  122502. ** of X is smaller for views and subqueries so that the query planner
  122503. ** will be more aggressive about generating automatic indexes for
  122504. ** those objects, since there is no opportunity to add schema
  122505. ** indexes on subqueries and views. */
  122506. pNew->rSetup = rLogSize + rSize + 4;
  122507. if( pTab->pSelect==0 && (pTab->tabFlags & TF_Ephemeral)==0 ){
  122508. pNew->rSetup += 24;
  122509. }
  122510. ApplyCostMultiplier(pNew->rSetup, pTab->costMult);
  122511. if( pNew->rSetup<0 ) pNew->rSetup = 0;
  122512. /* TUNING: Each index lookup yields 20 rows in the table. This
  122513. ** is more than the usual guess of 10 rows, since we have no way
  122514. ** of knowing how selective the index will ultimately be. It would
  122515. ** not be unreasonable to make this value much larger. */
  122516. pNew->nOut = 43; assert( 43==sqlite3LogEst(20) );
  122517. pNew->rRun = sqlite3LogEstAdd(rLogSize,pNew->nOut);
  122518. pNew->wsFlags = WHERE_AUTO_INDEX;
  122519. pNew->prereq = mPrereq | pTerm->prereqRight;
  122520. rc = whereLoopInsert(pBuilder, pNew);
  122521. }
  122522. }
  122523. }
  122524. #endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
  122525. /* Loop over all indices
  122526. */
  122527. for(; rc==SQLITE_OK && pProbe; pProbe=pProbe->pNext, iSortIdx++){
  122528. if( pProbe->pPartIdxWhere!=0
  122529. && !whereUsablePartialIndex(pSrc->iCursor, pWC, pProbe->pPartIdxWhere) ){
  122530. testcase( pNew->iTab!=pSrc->iCursor ); /* See ticket [98d973b8f5] */
  122531. continue; /* Partial index inappropriate for this query */
  122532. }
  122533. rSize = pProbe->aiRowLogEst[0];
  122534. pNew->u.btree.nEq = 0;
  122535. pNew->u.btree.nBtm = 0;
  122536. pNew->u.btree.nTop = 0;
  122537. pNew->nSkip = 0;
  122538. pNew->nLTerm = 0;
  122539. pNew->iSortIdx = 0;
  122540. pNew->rSetup = 0;
  122541. pNew->prereq = mPrereq;
  122542. pNew->nOut = rSize;
  122543. pNew->u.btree.pIndex = pProbe;
  122544. b = indexMightHelpWithOrderBy(pBuilder, pProbe, pSrc->iCursor);
  122545. /* The ONEPASS_DESIRED flags never occurs together with ORDER BY */
  122546. assert( (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || b==0 );
  122547. if( pProbe->tnum<=0 ){
  122548. /* Integer primary key index */
  122549. pNew->wsFlags = WHERE_IPK;
  122550. /* Full table scan */
  122551. pNew->iSortIdx = b ? iSortIdx : 0;
  122552. /* TUNING: Cost of full table scan is (N*3.0). */
  122553. pNew->rRun = rSize + 16;
  122554. ApplyCostMultiplier(pNew->rRun, pTab->costMult);
  122555. whereLoopOutputAdjust(pWC, pNew, rSize);
  122556. rc = whereLoopInsert(pBuilder, pNew);
  122557. pNew->nOut = rSize;
  122558. if( rc ) break;
  122559. }else{
  122560. Bitmask m;
  122561. if( pProbe->isCovering ){
  122562. pNew->wsFlags = WHERE_IDX_ONLY | WHERE_INDEXED;
  122563. m = 0;
  122564. }else{
  122565. m = pSrc->colUsed & ~columnsInIndex(pProbe);
  122566. pNew->wsFlags = (m==0) ? (WHERE_IDX_ONLY|WHERE_INDEXED) : WHERE_INDEXED;
  122567. }
  122568. /* Full scan via index */
  122569. if( b
  122570. || !HasRowid(pTab)
  122571. || pProbe->pPartIdxWhere!=0
  122572. || ( m==0
  122573. && pProbe->bUnordered==0
  122574. && (pProbe->szIdxRow<pTab->szTabRow)
  122575. && (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
  122576. && sqlite3GlobalConfig.bUseCis
  122577. && OptimizationEnabled(pWInfo->pParse->db, SQLITE_CoverIdxScan)
  122578. )
  122579. ){
  122580. pNew->iSortIdx = b ? iSortIdx : 0;
  122581. /* The cost of visiting the index rows is N*K, where K is
  122582. ** between 1.1 and 3.0, depending on the relative sizes of the
  122583. ** index and table rows. */
  122584. pNew->rRun = rSize + 1 + (15*pProbe->szIdxRow)/pTab->szTabRow;
  122585. if( m!=0 ){
  122586. /* If this is a non-covering index scan, add in the cost of
  122587. ** doing table lookups. The cost will be 3x the number of
  122588. ** lookups. Take into account WHERE clause terms that can be
  122589. ** satisfied using just the index, and that do not require a
  122590. ** table lookup. */
  122591. LogEst nLookup = rSize + 16; /* Base cost: N*3 */
  122592. int ii;
  122593. int iCur = pSrc->iCursor;
  122594. WhereClause *pWC2 = &pWInfo->sWC;
  122595. for(ii=0; ii<pWC2->nTerm; ii++){
  122596. WhereTerm *pTerm = &pWC2->a[ii];
  122597. if( !sqlite3ExprCoveredByIndex(pTerm->pExpr, iCur, pProbe) ){
  122598. break;
  122599. }
  122600. /* pTerm can be evaluated using just the index. So reduce
  122601. ** the expected number of table lookups accordingly */
  122602. if( pTerm->truthProb<=0 ){
  122603. nLookup += pTerm->truthProb;
  122604. }else{
  122605. nLookup--;
  122606. if( pTerm->eOperator & (WO_EQ|WO_IS) ) nLookup -= 19;
  122607. }
  122608. }
  122609. pNew->rRun = sqlite3LogEstAdd(pNew->rRun, nLookup);
  122610. }
  122611. ApplyCostMultiplier(pNew->rRun, pTab->costMult);
  122612. whereLoopOutputAdjust(pWC, pNew, rSize);
  122613. rc = whereLoopInsert(pBuilder, pNew);
  122614. pNew->nOut = rSize;
  122615. if( rc ) break;
  122616. }
  122617. }
  122618. rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 0);
  122619. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122620. sqlite3Stat4ProbeFree(pBuilder->pRec);
  122621. pBuilder->nRecValid = 0;
  122622. pBuilder->pRec = 0;
  122623. #endif
  122624. /* If there was an INDEXED BY clause, then only that one index is
  122625. ** considered. */
  122626. if( pSrc->pIBIndex ) break;
  122627. }
  122628. return rc;
  122629. }
  122630. #ifndef SQLITE_OMIT_VIRTUALTABLE
  122631. /*
  122632. ** Argument pIdxInfo is already populated with all constraints that may
  122633. ** be used by the virtual table identified by pBuilder->pNew->iTab. This
  122634. ** function marks a subset of those constraints usable, invokes the
  122635. ** xBestIndex method and adds the returned plan to pBuilder.
  122636. **
  122637. ** A constraint is marked usable if:
  122638. **
  122639. ** * Argument mUsable indicates that its prerequisites are available, and
  122640. **
  122641. ** * It is not one of the operators specified in the mExclude mask passed
  122642. ** as the fourth argument (which in practice is either WO_IN or 0).
  122643. **
  122644. ** Argument mPrereq is a mask of tables that must be scanned before the
  122645. ** virtual table in question. These are added to the plans prerequisites
  122646. ** before it is added to pBuilder.
  122647. **
  122648. ** Output parameter *pbIn is set to true if the plan added to pBuilder
  122649. ** uses one or more WO_IN terms, or false otherwise.
  122650. */
  122651. static int whereLoopAddVirtualOne(
  122652. WhereLoopBuilder *pBuilder,
  122653. Bitmask mPrereq, /* Mask of tables that must be used. */
  122654. Bitmask mUsable, /* Mask of usable tables */
  122655. u16 mExclude, /* Exclude terms using these operators */
  122656. sqlite3_index_info *pIdxInfo, /* Populated object for xBestIndex */
  122657. u16 mNoOmit, /* Do not omit these constraints */
  122658. int *pbIn /* OUT: True if plan uses an IN(...) op */
  122659. ){
  122660. WhereClause *pWC = pBuilder->pWC;
  122661. struct sqlite3_index_constraint *pIdxCons;
  122662. struct sqlite3_index_constraint_usage *pUsage = pIdxInfo->aConstraintUsage;
  122663. int i;
  122664. int mxTerm;
  122665. int rc = SQLITE_OK;
  122666. WhereLoop *pNew = pBuilder->pNew;
  122667. Parse *pParse = pBuilder->pWInfo->pParse;
  122668. struct SrcList_item *pSrc = &pBuilder->pWInfo->pTabList->a[pNew->iTab];
  122669. int nConstraint = pIdxInfo->nConstraint;
  122670. assert( (mUsable & mPrereq)==mPrereq );
  122671. *pbIn = 0;
  122672. pNew->prereq = mPrereq;
  122673. /* Set the usable flag on the subset of constraints identified by
  122674. ** arguments mUsable and mExclude. */
  122675. pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
  122676. for(i=0; i<nConstraint; i++, pIdxCons++){
  122677. WhereTerm *pTerm = &pWC->a[pIdxCons->iTermOffset];
  122678. pIdxCons->usable = 0;
  122679. if( (pTerm->prereqRight & mUsable)==pTerm->prereqRight
  122680. && (pTerm->eOperator & mExclude)==0
  122681. ){
  122682. pIdxCons->usable = 1;
  122683. }
  122684. }
  122685. /* Initialize the output fields of the sqlite3_index_info structure */
  122686. memset(pUsage, 0, sizeof(pUsage[0])*nConstraint);
  122687. assert( pIdxInfo->needToFreeIdxStr==0 );
  122688. pIdxInfo->idxStr = 0;
  122689. pIdxInfo->idxNum = 0;
  122690. pIdxInfo->orderByConsumed = 0;
  122691. pIdxInfo->estimatedCost = SQLITE_BIG_DBL / (double)2;
  122692. pIdxInfo->estimatedRows = 25;
  122693. pIdxInfo->idxFlags = 0;
  122694. pIdxInfo->colUsed = (sqlite3_int64)pSrc->colUsed;
  122695. /* Invoke the virtual table xBestIndex() method */
  122696. rc = vtabBestIndex(pParse, pSrc->pTab, pIdxInfo);
  122697. if( rc ) return rc;
  122698. mxTerm = -1;
  122699. assert( pNew->nLSlot>=nConstraint );
  122700. for(i=0; i<nConstraint; i++) pNew->aLTerm[i] = 0;
  122701. pNew->u.vtab.omitMask = 0;
  122702. pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
  122703. for(i=0; i<nConstraint; i++, pIdxCons++){
  122704. int iTerm;
  122705. if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
  122706. WhereTerm *pTerm;
  122707. int j = pIdxCons->iTermOffset;
  122708. if( iTerm>=nConstraint
  122709. || j<0
  122710. || j>=pWC->nTerm
  122711. || pNew->aLTerm[iTerm]!=0
  122712. || pIdxCons->usable==0
  122713. ){
  122714. rc = SQLITE_ERROR;
  122715. sqlite3ErrorMsg(pParse,"%s.xBestIndex malfunction",pSrc->pTab->zName);
  122716. return rc;
  122717. }
  122718. testcase( iTerm==nConstraint-1 );
  122719. testcase( j==0 );
  122720. testcase( j==pWC->nTerm-1 );
  122721. pTerm = &pWC->a[j];
  122722. pNew->prereq |= pTerm->prereqRight;
  122723. assert( iTerm<pNew->nLSlot );
  122724. pNew->aLTerm[iTerm] = pTerm;
  122725. if( iTerm>mxTerm ) mxTerm = iTerm;
  122726. testcase( iTerm==15 );
  122727. testcase( iTerm==16 );
  122728. if( iTerm<16 && pUsage[i].omit ) pNew->u.vtab.omitMask |= 1<<iTerm;
  122729. if( (pTerm->eOperator & WO_IN)!=0 ){
  122730. /* A virtual table that is constrained by an IN clause may not
  122731. ** consume the ORDER BY clause because (1) the order of IN terms
  122732. ** is not necessarily related to the order of output terms and
  122733. ** (2) Multiple outputs from a single IN value will not merge
  122734. ** together. */
  122735. pIdxInfo->orderByConsumed = 0;
  122736. pIdxInfo->idxFlags &= ~SQLITE_INDEX_SCAN_UNIQUE;
  122737. *pbIn = 1; assert( (mExclude & WO_IN)==0 );
  122738. }
  122739. }
  122740. }
  122741. pNew->u.vtab.omitMask &= ~mNoOmit;
  122742. pNew->nLTerm = mxTerm+1;
  122743. assert( pNew->nLTerm<=pNew->nLSlot );
  122744. pNew->u.vtab.idxNum = pIdxInfo->idxNum;
  122745. pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
  122746. pIdxInfo->needToFreeIdxStr = 0;
  122747. pNew->u.vtab.idxStr = pIdxInfo->idxStr;
  122748. pNew->u.vtab.isOrdered = (i8)(pIdxInfo->orderByConsumed ?
  122749. pIdxInfo->nOrderBy : 0);
  122750. pNew->rSetup = 0;
  122751. pNew->rRun = sqlite3LogEstFromDouble(pIdxInfo->estimatedCost);
  122752. pNew->nOut = sqlite3LogEst(pIdxInfo->estimatedRows);
  122753. /* Set the WHERE_ONEROW flag if the xBestIndex() method indicated
  122754. ** that the scan will visit at most one row. Clear it otherwise. */
  122755. if( pIdxInfo->idxFlags & SQLITE_INDEX_SCAN_UNIQUE ){
  122756. pNew->wsFlags |= WHERE_ONEROW;
  122757. }else{
  122758. pNew->wsFlags &= ~WHERE_ONEROW;
  122759. }
  122760. rc = whereLoopInsert(pBuilder, pNew);
  122761. if( pNew->u.vtab.needFree ){
  122762. sqlite3_free(pNew->u.vtab.idxStr);
  122763. pNew->u.vtab.needFree = 0;
  122764. }
  122765. WHERETRACE(0xffff, (" bIn=%d prereqIn=%04llx prereqOut=%04llx\n",
  122766. *pbIn, (sqlite3_uint64)mPrereq,
  122767. (sqlite3_uint64)(pNew->prereq & ~mPrereq)));
  122768. return rc;
  122769. }
  122770. /*
  122771. ** Add all WhereLoop objects for a table of the join identified by
  122772. ** pBuilder->pNew->iTab. That table is guaranteed to be a virtual table.
  122773. **
  122774. ** If there are no LEFT or CROSS JOIN joins in the query, both mPrereq and
  122775. ** mUnusable are set to 0. Otherwise, mPrereq is a mask of all FROM clause
  122776. ** entries that occur before the virtual table in the FROM clause and are
  122777. ** separated from it by at least one LEFT or CROSS JOIN. Similarly, the
  122778. ** mUnusable mask contains all FROM clause entries that occur after the
  122779. ** virtual table and are separated from it by at least one LEFT or
  122780. ** CROSS JOIN.
  122781. **
  122782. ** For example, if the query were:
  122783. **
  122784. ** ... FROM t1, t2 LEFT JOIN t3, t4, vt CROSS JOIN t5, t6;
  122785. **
  122786. ** then mPrereq corresponds to (t1, t2) and mUnusable to (t5, t6).
  122787. **
  122788. ** All the tables in mPrereq must be scanned before the current virtual
  122789. ** table. So any terms for which all prerequisites are satisfied by
  122790. ** mPrereq may be specified as "usable" in all calls to xBestIndex.
  122791. ** Conversely, all tables in mUnusable must be scanned after the current
  122792. ** virtual table, so any terms for which the prerequisites overlap with
  122793. ** mUnusable should always be configured as "not-usable" for xBestIndex.
  122794. */
  122795. static int whereLoopAddVirtual(
  122796. WhereLoopBuilder *pBuilder, /* WHERE clause information */
  122797. Bitmask mPrereq, /* Tables that must be scanned before this one */
  122798. Bitmask mUnusable /* Tables that must be scanned after this one */
  122799. ){
  122800. int rc = SQLITE_OK; /* Return code */
  122801. WhereInfo *pWInfo; /* WHERE analysis context */
  122802. Parse *pParse; /* The parsing context */
  122803. WhereClause *pWC; /* The WHERE clause */
  122804. struct SrcList_item *pSrc; /* The FROM clause term to search */
  122805. sqlite3_index_info *p; /* Object to pass to xBestIndex() */
  122806. int nConstraint; /* Number of constraints in p */
  122807. int bIn; /* True if plan uses IN(...) operator */
  122808. WhereLoop *pNew;
  122809. Bitmask mBest; /* Tables used by best possible plan */
  122810. u16 mNoOmit;
  122811. assert( (mPrereq & mUnusable)==0 );
  122812. pWInfo = pBuilder->pWInfo;
  122813. pParse = pWInfo->pParse;
  122814. pWC = pBuilder->pWC;
  122815. pNew = pBuilder->pNew;
  122816. pSrc = &pWInfo->pTabList->a[pNew->iTab];
  122817. assert( IsVirtual(pSrc->pTab) );
  122818. p = allocateIndexInfo(pParse, pWC, mUnusable, pSrc, pBuilder->pOrderBy,
  122819. &mNoOmit);
  122820. if( p==0 ) return SQLITE_NOMEM_BKPT;
  122821. pNew->rSetup = 0;
  122822. pNew->wsFlags = WHERE_VIRTUALTABLE;
  122823. pNew->nLTerm = 0;
  122824. pNew->u.vtab.needFree = 0;
  122825. nConstraint = p->nConstraint;
  122826. if( whereLoopResize(pParse->db, pNew, nConstraint) ){
  122827. sqlite3DbFree(pParse->db, p);
  122828. return SQLITE_NOMEM_BKPT;
  122829. }
  122830. /* First call xBestIndex() with all constraints usable. */
  122831. WHERETRACE(0x40, (" VirtualOne: all usable\n"));
  122832. rc = whereLoopAddVirtualOne(pBuilder, mPrereq, ALLBITS, 0, p, mNoOmit, &bIn);
  122833. /* If the call to xBestIndex() with all terms enabled produced a plan
  122834. ** that does not require any source tables (IOW: a plan with mBest==0),
  122835. ** then there is no point in making any further calls to xBestIndex()
  122836. ** since they will all return the same result (if the xBestIndex()
  122837. ** implementation is sane). */
  122838. if( rc==SQLITE_OK && (mBest = (pNew->prereq & ~mPrereq))!=0 ){
  122839. int seenZero = 0; /* True if a plan with no prereqs seen */
  122840. int seenZeroNoIN = 0; /* Plan with no prereqs and no IN(...) seen */
  122841. Bitmask mPrev = 0;
  122842. Bitmask mBestNoIn = 0;
  122843. /* If the plan produced by the earlier call uses an IN(...) term, call
  122844. ** xBestIndex again, this time with IN(...) terms disabled. */
  122845. if( bIn ){
  122846. WHERETRACE(0x40, (" VirtualOne: all usable w/o IN\n"));
  122847. rc = whereLoopAddVirtualOne(
  122848. pBuilder, mPrereq, ALLBITS, WO_IN, p, mNoOmit, &bIn);
  122849. assert( bIn==0 );
  122850. mBestNoIn = pNew->prereq & ~mPrereq;
  122851. if( mBestNoIn==0 ){
  122852. seenZero = 1;
  122853. seenZeroNoIN = 1;
  122854. }
  122855. }
  122856. /* Call xBestIndex once for each distinct value of (prereqRight & ~mPrereq)
  122857. ** in the set of terms that apply to the current virtual table. */
  122858. while( rc==SQLITE_OK ){
  122859. int i;
  122860. Bitmask mNext = ALLBITS;
  122861. assert( mNext>0 );
  122862. for(i=0; i<nConstraint; i++){
  122863. Bitmask mThis = (
  122864. pWC->a[p->aConstraint[i].iTermOffset].prereqRight & ~mPrereq
  122865. );
  122866. if( mThis>mPrev && mThis<mNext ) mNext = mThis;
  122867. }
  122868. mPrev = mNext;
  122869. if( mNext==ALLBITS ) break;
  122870. if( mNext==mBest || mNext==mBestNoIn ) continue;
  122871. WHERETRACE(0x40, (" VirtualOne: mPrev=%04llx mNext=%04llx\n",
  122872. (sqlite3_uint64)mPrev, (sqlite3_uint64)mNext));
  122873. rc = whereLoopAddVirtualOne(
  122874. pBuilder, mPrereq, mNext|mPrereq, 0, p, mNoOmit, &bIn);
  122875. if( pNew->prereq==mPrereq ){
  122876. seenZero = 1;
  122877. if( bIn==0 ) seenZeroNoIN = 1;
  122878. }
  122879. }
  122880. /* If the calls to xBestIndex() in the above loop did not find a plan
  122881. ** that requires no source tables at all (i.e. one guaranteed to be
  122882. ** usable), make a call here with all source tables disabled */
  122883. if( rc==SQLITE_OK && seenZero==0 ){
  122884. WHERETRACE(0x40, (" VirtualOne: all disabled\n"));
  122885. rc = whereLoopAddVirtualOne(
  122886. pBuilder, mPrereq, mPrereq, 0, p, mNoOmit, &bIn);
  122887. if( bIn==0 ) seenZeroNoIN = 1;
  122888. }
  122889. /* If the calls to xBestIndex() have so far failed to find a plan
  122890. ** that requires no source tables at all and does not use an IN(...)
  122891. ** operator, make a final call to obtain one here. */
  122892. if( rc==SQLITE_OK && seenZeroNoIN==0 ){
  122893. WHERETRACE(0x40, (" VirtualOne: all disabled and w/o IN\n"));
  122894. rc = whereLoopAddVirtualOne(
  122895. pBuilder, mPrereq, mPrereq, WO_IN, p, mNoOmit, &bIn);
  122896. }
  122897. }
  122898. if( p->needToFreeIdxStr ) sqlite3_free(p->idxStr);
  122899. sqlite3DbFree(pParse->db, p);
  122900. return rc;
  122901. }
  122902. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  122903. /*
  122904. ** Add WhereLoop entries to handle OR terms. This works for either
  122905. ** btrees or virtual tables.
  122906. */
  122907. static int whereLoopAddOr(
  122908. WhereLoopBuilder *pBuilder,
  122909. Bitmask mPrereq,
  122910. Bitmask mUnusable
  122911. ){
  122912. WhereInfo *pWInfo = pBuilder->pWInfo;
  122913. WhereClause *pWC;
  122914. WhereLoop *pNew;
  122915. WhereTerm *pTerm, *pWCEnd;
  122916. int rc = SQLITE_OK;
  122917. int iCur;
  122918. WhereClause tempWC;
  122919. WhereLoopBuilder sSubBuild;
  122920. WhereOrSet sSum, sCur;
  122921. struct SrcList_item *pItem;
  122922. pWC = pBuilder->pWC;
  122923. pWCEnd = pWC->a + pWC->nTerm;
  122924. pNew = pBuilder->pNew;
  122925. memset(&sSum, 0, sizeof(sSum));
  122926. pItem = pWInfo->pTabList->a + pNew->iTab;
  122927. iCur = pItem->iCursor;
  122928. for(pTerm=pWC->a; pTerm<pWCEnd && rc==SQLITE_OK; pTerm++){
  122929. if( (pTerm->eOperator & WO_OR)!=0
  122930. && (pTerm->u.pOrInfo->indexable & pNew->maskSelf)!=0
  122931. ){
  122932. WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
  122933. WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
  122934. WhereTerm *pOrTerm;
  122935. int once = 1;
  122936. int i, j;
  122937. sSubBuild = *pBuilder;
  122938. sSubBuild.pOrderBy = 0;
  122939. sSubBuild.pOrSet = &sCur;
  122940. WHERETRACE(0x200, ("Begin processing OR-clause %p\n", pTerm));
  122941. for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
  122942. if( (pOrTerm->eOperator & WO_AND)!=0 ){
  122943. sSubBuild.pWC = &pOrTerm->u.pAndInfo->wc;
  122944. }else if( pOrTerm->leftCursor==iCur ){
  122945. tempWC.pWInfo = pWC->pWInfo;
  122946. tempWC.pOuter = pWC;
  122947. tempWC.op = TK_AND;
  122948. tempWC.nTerm = 1;
  122949. tempWC.a = pOrTerm;
  122950. sSubBuild.pWC = &tempWC;
  122951. }else{
  122952. continue;
  122953. }
  122954. sCur.n = 0;
  122955. #ifdef WHERETRACE_ENABLED
  122956. WHERETRACE(0x200, ("OR-term %d of %p has %d subterms:\n",
  122957. (int)(pOrTerm-pOrWC->a), pTerm, sSubBuild.pWC->nTerm));
  122958. if( sqlite3WhereTrace & 0x400 ){
  122959. sqlite3WhereClausePrint(sSubBuild.pWC);
  122960. }
  122961. #endif
  122962. #ifndef SQLITE_OMIT_VIRTUALTABLE
  122963. if( IsVirtual(pItem->pTab) ){
  122964. rc = whereLoopAddVirtual(&sSubBuild, mPrereq, mUnusable);
  122965. }else
  122966. #endif
  122967. {
  122968. rc = whereLoopAddBtree(&sSubBuild, mPrereq);
  122969. }
  122970. if( rc==SQLITE_OK ){
  122971. rc = whereLoopAddOr(&sSubBuild, mPrereq, mUnusable);
  122972. }
  122973. assert( rc==SQLITE_OK || sCur.n==0 );
  122974. if( sCur.n==0 ){
  122975. sSum.n = 0;
  122976. break;
  122977. }else if( once ){
  122978. whereOrMove(&sSum, &sCur);
  122979. once = 0;
  122980. }else{
  122981. WhereOrSet sPrev;
  122982. whereOrMove(&sPrev, &sSum);
  122983. sSum.n = 0;
  122984. for(i=0; i<sPrev.n; i++){
  122985. for(j=0; j<sCur.n; j++){
  122986. whereOrInsert(&sSum, sPrev.a[i].prereq | sCur.a[j].prereq,
  122987. sqlite3LogEstAdd(sPrev.a[i].rRun, sCur.a[j].rRun),
  122988. sqlite3LogEstAdd(sPrev.a[i].nOut, sCur.a[j].nOut));
  122989. }
  122990. }
  122991. }
  122992. }
  122993. pNew->nLTerm = 1;
  122994. pNew->aLTerm[0] = pTerm;
  122995. pNew->wsFlags = WHERE_MULTI_OR;
  122996. pNew->rSetup = 0;
  122997. pNew->iSortIdx = 0;
  122998. memset(&pNew->u, 0, sizeof(pNew->u));
  122999. for(i=0; rc==SQLITE_OK && i<sSum.n; i++){
  123000. /* TUNING: Currently sSum.a[i].rRun is set to the sum of the costs
  123001. ** of all sub-scans required by the OR-scan. However, due to rounding
  123002. ** errors, it may be that the cost of the OR-scan is equal to its
  123003. ** most expensive sub-scan. Add the smallest possible penalty
  123004. ** (equivalent to multiplying the cost by 1.07) to ensure that
  123005. ** this does not happen. Otherwise, for WHERE clauses such as the
  123006. ** following where there is an index on "y":
  123007. **
  123008. ** WHERE likelihood(x=?, 0.99) OR y=?
  123009. **
  123010. ** the planner may elect to "OR" together a full-table scan and an
  123011. ** index lookup. And other similarly odd results. */
  123012. pNew->rRun = sSum.a[i].rRun + 1;
  123013. pNew->nOut = sSum.a[i].nOut;
  123014. pNew->prereq = sSum.a[i].prereq;
  123015. rc = whereLoopInsert(pBuilder, pNew);
  123016. }
  123017. WHERETRACE(0x200, ("End processing OR-clause %p\n", pTerm));
  123018. }
  123019. }
  123020. return rc;
  123021. }
  123022. /*
  123023. ** Add all WhereLoop objects for all tables
  123024. */
  123025. static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
  123026. WhereInfo *pWInfo = pBuilder->pWInfo;
  123027. Bitmask mPrereq = 0;
  123028. Bitmask mPrior = 0;
  123029. int iTab;
  123030. SrcList *pTabList = pWInfo->pTabList;
  123031. struct SrcList_item *pItem;
  123032. struct SrcList_item *pEnd = &pTabList->a[pWInfo->nLevel];
  123033. sqlite3 *db = pWInfo->pParse->db;
  123034. int rc = SQLITE_OK;
  123035. WhereLoop *pNew;
  123036. u8 priorJointype = 0;
  123037. /* Loop over the tables in the join, from left to right */
  123038. pNew = pBuilder->pNew;
  123039. whereLoopInit(pNew);
  123040. for(iTab=0, pItem=pTabList->a; pItem<pEnd; iTab++, pItem++){
  123041. Bitmask mUnusable = 0;
  123042. pNew->iTab = iTab;
  123043. pNew->maskSelf = sqlite3WhereGetMask(&pWInfo->sMaskSet, pItem->iCursor);
  123044. if( ((pItem->fg.jointype|priorJointype) & (JT_LEFT|JT_CROSS))!=0 ){
  123045. /* This condition is true when pItem is the FROM clause term on the
  123046. ** right-hand-side of a LEFT or CROSS JOIN. */
  123047. mPrereq = mPrior;
  123048. }
  123049. priorJointype = pItem->fg.jointype;
  123050. #ifndef SQLITE_OMIT_VIRTUALTABLE
  123051. if( IsVirtual(pItem->pTab) ){
  123052. struct SrcList_item *p;
  123053. for(p=&pItem[1]; p<pEnd; p++){
  123054. if( mUnusable || (p->fg.jointype & (JT_LEFT|JT_CROSS)) ){
  123055. mUnusable |= sqlite3WhereGetMask(&pWInfo->sMaskSet, p->iCursor);
  123056. }
  123057. }
  123058. rc = whereLoopAddVirtual(pBuilder, mPrereq, mUnusable);
  123059. }else
  123060. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  123061. {
  123062. rc = whereLoopAddBtree(pBuilder, mPrereq);
  123063. }
  123064. if( rc==SQLITE_OK ){
  123065. rc = whereLoopAddOr(pBuilder, mPrereq, mUnusable);
  123066. }
  123067. mPrior |= pNew->maskSelf;
  123068. if( rc || db->mallocFailed ) break;
  123069. }
  123070. whereLoopClear(db, pNew);
  123071. return rc;
  123072. }
  123073. /*
  123074. ** Examine a WherePath (with the addition of the extra WhereLoop of the 5th
  123075. ** parameters) to see if it outputs rows in the requested ORDER BY
  123076. ** (or GROUP BY) without requiring a separate sort operation. Return N:
  123077. **
  123078. ** N>0: N terms of the ORDER BY clause are satisfied
  123079. ** N==0: No terms of the ORDER BY clause are satisfied
  123080. ** N<0: Unknown yet how many terms of ORDER BY might be satisfied.
  123081. **
  123082. ** Note that processing for WHERE_GROUPBY and WHERE_DISTINCTBY is not as
  123083. ** strict. With GROUP BY and DISTINCT the only requirement is that
  123084. ** equivalent rows appear immediately adjacent to one another. GROUP BY
  123085. ** and DISTINCT do not require rows to appear in any particular order as long
  123086. ** as equivalent rows are grouped together. Thus for GROUP BY and DISTINCT
  123087. ** the pOrderBy terms can be matched in any order. With ORDER BY, the
  123088. ** pOrderBy terms must be matched in strict left-to-right order.
  123089. */
  123090. static i8 wherePathSatisfiesOrderBy(
  123091. WhereInfo *pWInfo, /* The WHERE clause */
  123092. ExprList *pOrderBy, /* ORDER BY or GROUP BY or DISTINCT clause to check */
  123093. WherePath *pPath, /* The WherePath to check */
  123094. u16 wctrlFlags, /* WHERE_GROUPBY or _DISTINCTBY or _ORDERBY_LIMIT */
  123095. u16 nLoop, /* Number of entries in pPath->aLoop[] */
  123096. WhereLoop *pLast, /* Add this WhereLoop to the end of pPath->aLoop[] */
  123097. Bitmask *pRevMask /* OUT: Mask of WhereLoops to run in reverse order */
  123098. ){
  123099. u8 revSet; /* True if rev is known */
  123100. u8 rev; /* Composite sort order */
  123101. u8 revIdx; /* Index sort order */
  123102. u8 isOrderDistinct; /* All prior WhereLoops are order-distinct */
  123103. u8 distinctColumns; /* True if the loop has UNIQUE NOT NULL columns */
  123104. u8 isMatch; /* iColumn matches a term of the ORDER BY clause */
  123105. u16 eqOpMask; /* Allowed equality operators */
  123106. u16 nKeyCol; /* Number of key columns in pIndex */
  123107. u16 nColumn; /* Total number of ordered columns in the index */
  123108. u16 nOrderBy; /* Number terms in the ORDER BY clause */
  123109. int iLoop; /* Index of WhereLoop in pPath being processed */
  123110. int i, j; /* Loop counters */
  123111. int iCur; /* Cursor number for current WhereLoop */
  123112. int iColumn; /* A column number within table iCur */
  123113. WhereLoop *pLoop = 0; /* Current WhereLoop being processed. */
  123114. WhereTerm *pTerm; /* A single term of the WHERE clause */
  123115. Expr *pOBExpr; /* An expression from the ORDER BY clause */
  123116. CollSeq *pColl; /* COLLATE function from an ORDER BY clause term */
  123117. Index *pIndex; /* The index associated with pLoop */
  123118. sqlite3 *db = pWInfo->pParse->db; /* Database connection */
  123119. Bitmask obSat = 0; /* Mask of ORDER BY terms satisfied so far */
  123120. Bitmask obDone; /* Mask of all ORDER BY terms */
  123121. Bitmask orderDistinctMask; /* Mask of all well-ordered loops */
  123122. Bitmask ready; /* Mask of inner loops */
  123123. /*
  123124. ** We say the WhereLoop is "one-row" if it generates no more than one
  123125. ** row of output. A WhereLoop is one-row if all of the following are true:
  123126. ** (a) All index columns match with WHERE_COLUMN_EQ.
  123127. ** (b) The index is unique
  123128. ** Any WhereLoop with an WHERE_COLUMN_EQ constraint on the rowid is one-row.
  123129. ** Every one-row WhereLoop will have the WHERE_ONEROW bit set in wsFlags.
  123130. **
  123131. ** We say the WhereLoop is "order-distinct" if the set of columns from
  123132. ** that WhereLoop that are in the ORDER BY clause are different for every
  123133. ** row of the WhereLoop. Every one-row WhereLoop is automatically
  123134. ** order-distinct. A WhereLoop that has no columns in the ORDER BY clause
  123135. ** is not order-distinct. To be order-distinct is not quite the same as being
  123136. ** UNIQUE since a UNIQUE column or index can have multiple rows that
  123137. ** are NULL and NULL values are equivalent for the purpose of order-distinct.
  123138. ** To be order-distinct, the columns must be UNIQUE and NOT NULL.
  123139. **
  123140. ** The rowid for a table is always UNIQUE and NOT NULL so whenever the
  123141. ** rowid appears in the ORDER BY clause, the corresponding WhereLoop is
  123142. ** automatically order-distinct.
  123143. */
  123144. assert( pOrderBy!=0 );
  123145. if( nLoop && OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ) return 0;
  123146. nOrderBy = pOrderBy->nExpr;
  123147. testcase( nOrderBy==BMS-1 );
  123148. if( nOrderBy>BMS-1 ) return 0; /* Cannot optimize overly large ORDER BYs */
  123149. isOrderDistinct = 1;
  123150. obDone = MASKBIT(nOrderBy)-1;
  123151. orderDistinctMask = 0;
  123152. ready = 0;
  123153. eqOpMask = WO_EQ | WO_IS | WO_ISNULL;
  123154. if( wctrlFlags & WHERE_ORDERBY_LIMIT ) eqOpMask |= WO_IN;
  123155. for(iLoop=0; isOrderDistinct && obSat<obDone && iLoop<=nLoop; iLoop++){
  123156. if( iLoop>0 ) ready |= pLoop->maskSelf;
  123157. if( iLoop<nLoop ){
  123158. pLoop = pPath->aLoop[iLoop];
  123159. if( wctrlFlags & WHERE_ORDERBY_LIMIT ) continue;
  123160. }else{
  123161. pLoop = pLast;
  123162. }
  123163. if( pLoop->wsFlags & WHERE_VIRTUALTABLE ){
  123164. if( pLoop->u.vtab.isOrdered ) obSat = obDone;
  123165. break;
  123166. }
  123167. iCur = pWInfo->pTabList->a[pLoop->iTab].iCursor;
  123168. /* Mark off any ORDER BY term X that is a column in the table of
  123169. ** the current loop for which there is term in the WHERE
  123170. ** clause of the form X IS NULL or X=? that reference only outer
  123171. ** loops.
  123172. */
  123173. for(i=0; i<nOrderBy; i++){
  123174. if( MASKBIT(i) & obSat ) continue;
  123175. pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
  123176. if( pOBExpr->op!=TK_COLUMN ) continue;
  123177. if( pOBExpr->iTable!=iCur ) continue;
  123178. pTerm = sqlite3WhereFindTerm(&pWInfo->sWC, iCur, pOBExpr->iColumn,
  123179. ~ready, eqOpMask, 0);
  123180. if( pTerm==0 ) continue;
  123181. if( pTerm->eOperator==WO_IN ){
  123182. /* IN terms are only valid for sorting in the ORDER BY LIMIT
  123183. ** optimization, and then only if they are actually used
  123184. ** by the query plan */
  123185. assert( wctrlFlags & WHERE_ORDERBY_LIMIT );
  123186. for(j=0; j<pLoop->nLTerm && pTerm!=pLoop->aLTerm[j]; j++){}
  123187. if( j>=pLoop->nLTerm ) continue;
  123188. }
  123189. if( (pTerm->eOperator&(WO_EQ|WO_IS))!=0 && pOBExpr->iColumn>=0 ){
  123190. const char *z1, *z2;
  123191. pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
  123192. if( !pColl ) pColl = db->pDfltColl;
  123193. z1 = pColl->zName;
  123194. pColl = sqlite3ExprCollSeq(pWInfo->pParse, pTerm->pExpr);
  123195. if( !pColl ) pColl = db->pDfltColl;
  123196. z2 = pColl->zName;
  123197. if( sqlite3StrICmp(z1, z2)!=0 ) continue;
  123198. testcase( pTerm->pExpr->op==TK_IS );
  123199. }
  123200. obSat |= MASKBIT(i);
  123201. }
  123202. if( (pLoop->wsFlags & WHERE_ONEROW)==0 ){
  123203. if( pLoop->wsFlags & WHERE_IPK ){
  123204. pIndex = 0;
  123205. nKeyCol = 0;
  123206. nColumn = 1;
  123207. }else if( (pIndex = pLoop->u.btree.pIndex)==0 || pIndex->bUnordered ){
  123208. return 0;
  123209. }else{
  123210. nKeyCol = pIndex->nKeyCol;
  123211. nColumn = pIndex->nColumn;
  123212. assert( nColumn==nKeyCol+1 || !HasRowid(pIndex->pTable) );
  123213. assert( pIndex->aiColumn[nColumn-1]==XN_ROWID
  123214. || !HasRowid(pIndex->pTable));
  123215. isOrderDistinct = IsUniqueIndex(pIndex);
  123216. }
  123217. /* Loop through all columns of the index and deal with the ones
  123218. ** that are not constrained by == or IN.
  123219. */
  123220. rev = revSet = 0;
  123221. distinctColumns = 0;
  123222. for(j=0; j<nColumn; j++){
  123223. u8 bOnce = 1; /* True to run the ORDER BY search loop */
  123224. assert( j>=pLoop->u.btree.nEq
  123225. || (pLoop->aLTerm[j]==0)==(j<pLoop->nSkip)
  123226. );
  123227. if( j<pLoop->u.btree.nEq && j>=pLoop->nSkip ){
  123228. u16 eOp = pLoop->aLTerm[j]->eOperator;
  123229. /* Skip over == and IS and ISNULL terms. (Also skip IN terms when
  123230. ** doing WHERE_ORDERBY_LIMIT processing).
  123231. **
  123232. ** If the current term is a column of an ((?,?) IN (SELECT...))
  123233. ** expression for which the SELECT returns more than one column,
  123234. ** check that it is the only column used by this loop. Otherwise,
  123235. ** if it is one of two or more, none of the columns can be
  123236. ** considered to match an ORDER BY term. */
  123237. if( (eOp & eqOpMask)!=0 ){
  123238. if( eOp & WO_ISNULL ){
  123239. testcase( isOrderDistinct );
  123240. isOrderDistinct = 0;
  123241. }
  123242. continue;
  123243. }else if( ALWAYS(eOp & WO_IN) ){
  123244. /* ALWAYS() justification: eOp is an equality operator due to the
  123245. ** j<pLoop->u.btree.nEq constraint above. Any equality other
  123246. ** than WO_IN is captured by the previous "if". So this one
  123247. ** always has to be WO_IN. */
  123248. Expr *pX = pLoop->aLTerm[j]->pExpr;
  123249. for(i=j+1; i<pLoop->u.btree.nEq; i++){
  123250. if( pLoop->aLTerm[i]->pExpr==pX ){
  123251. assert( (pLoop->aLTerm[i]->eOperator & WO_IN) );
  123252. bOnce = 0;
  123253. break;
  123254. }
  123255. }
  123256. }
  123257. }
  123258. /* Get the column number in the table (iColumn) and sort order
  123259. ** (revIdx) for the j-th column of the index.
  123260. */
  123261. if( pIndex ){
  123262. iColumn = pIndex->aiColumn[j];
  123263. revIdx = pIndex->aSortOrder[j];
  123264. if( iColumn==pIndex->pTable->iPKey ) iColumn = -1;
  123265. }else{
  123266. iColumn = XN_ROWID;
  123267. revIdx = 0;
  123268. }
  123269. /* An unconstrained column that might be NULL means that this
  123270. ** WhereLoop is not well-ordered
  123271. */
  123272. if( isOrderDistinct
  123273. && iColumn>=0
  123274. && j>=pLoop->u.btree.nEq
  123275. && pIndex->pTable->aCol[iColumn].notNull==0
  123276. ){
  123277. isOrderDistinct = 0;
  123278. }
  123279. /* Find the ORDER BY term that corresponds to the j-th column
  123280. ** of the index and mark that ORDER BY term off
  123281. */
  123282. isMatch = 0;
  123283. for(i=0; bOnce && i<nOrderBy; i++){
  123284. if( MASKBIT(i) & obSat ) continue;
  123285. pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
  123286. testcase( wctrlFlags & WHERE_GROUPBY );
  123287. testcase( wctrlFlags & WHERE_DISTINCTBY );
  123288. if( (wctrlFlags & (WHERE_GROUPBY|WHERE_DISTINCTBY))==0 ) bOnce = 0;
  123289. if( iColumn>=(-1) ){
  123290. if( pOBExpr->op!=TK_COLUMN ) continue;
  123291. if( pOBExpr->iTable!=iCur ) continue;
  123292. if( pOBExpr->iColumn!=iColumn ) continue;
  123293. }else{
  123294. if( sqlite3ExprCompare(pOBExpr,pIndex->aColExpr->a[j].pExpr,iCur) ){
  123295. continue;
  123296. }
  123297. }
  123298. if( iColumn>=0 ){
  123299. pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
  123300. if( !pColl ) pColl = db->pDfltColl;
  123301. if( sqlite3StrICmp(pColl->zName, pIndex->azColl[j])!=0 ) continue;
  123302. }
  123303. isMatch = 1;
  123304. break;
  123305. }
  123306. if( isMatch && (wctrlFlags & WHERE_GROUPBY)==0 ){
  123307. /* Make sure the sort order is compatible in an ORDER BY clause.
  123308. ** Sort order is irrelevant for a GROUP BY clause. */
  123309. if( revSet ){
  123310. if( (rev ^ revIdx)!=pOrderBy->a[i].sortOrder ) isMatch = 0;
  123311. }else{
  123312. rev = revIdx ^ pOrderBy->a[i].sortOrder;
  123313. if( rev ) *pRevMask |= MASKBIT(iLoop);
  123314. revSet = 1;
  123315. }
  123316. }
  123317. if( isMatch ){
  123318. if( iColumn==XN_ROWID ){
  123319. testcase( distinctColumns==0 );
  123320. distinctColumns = 1;
  123321. }
  123322. obSat |= MASKBIT(i);
  123323. }else{
  123324. /* No match found */
  123325. if( j==0 || j<nKeyCol ){
  123326. testcase( isOrderDistinct!=0 );
  123327. isOrderDistinct = 0;
  123328. }
  123329. break;
  123330. }
  123331. } /* end Loop over all index columns */
  123332. if( distinctColumns ){
  123333. testcase( isOrderDistinct==0 );
  123334. isOrderDistinct = 1;
  123335. }
  123336. } /* end-if not one-row */
  123337. /* Mark off any other ORDER BY terms that reference pLoop */
  123338. if( isOrderDistinct ){
  123339. orderDistinctMask |= pLoop->maskSelf;
  123340. for(i=0; i<nOrderBy; i++){
  123341. Expr *p;
  123342. Bitmask mTerm;
  123343. if( MASKBIT(i) & obSat ) continue;
  123344. p = pOrderBy->a[i].pExpr;
  123345. mTerm = sqlite3WhereExprUsage(&pWInfo->sMaskSet,p);
  123346. if( mTerm==0 && !sqlite3ExprIsConstant(p) ) continue;
  123347. if( (mTerm&~orderDistinctMask)==0 ){
  123348. obSat |= MASKBIT(i);
  123349. }
  123350. }
  123351. }
  123352. } /* End the loop over all WhereLoops from outer-most down to inner-most */
  123353. if( obSat==obDone ) return (i8)nOrderBy;
  123354. if( !isOrderDistinct ){
  123355. for(i=nOrderBy-1; i>0; i--){
  123356. Bitmask m = MASKBIT(i) - 1;
  123357. if( (obSat&m)==m ) return i;
  123358. }
  123359. return 0;
  123360. }
  123361. return -1;
  123362. }
  123363. /*
  123364. ** If the WHERE_GROUPBY flag is set in the mask passed to sqlite3WhereBegin(),
  123365. ** the planner assumes that the specified pOrderBy list is actually a GROUP
  123366. ** BY clause - and so any order that groups rows as required satisfies the
  123367. ** request.
  123368. **
  123369. ** Normally, in this case it is not possible for the caller to determine
  123370. ** whether or not the rows are really being delivered in sorted order, or
  123371. ** just in some other order that provides the required grouping. However,
  123372. ** if the WHERE_SORTBYGROUP flag is also passed to sqlite3WhereBegin(), then
  123373. ** this function may be called on the returned WhereInfo object. It returns
  123374. ** true if the rows really will be sorted in the specified order, or false
  123375. ** otherwise.
  123376. **
  123377. ** For example, assuming:
  123378. **
  123379. ** CREATE INDEX i1 ON t1(x, Y);
  123380. **
  123381. ** then
  123382. **
  123383. ** SELECT * FROM t1 GROUP BY x,y ORDER BY x,y; -- IsSorted()==1
  123384. ** SELECT * FROM t1 GROUP BY y,x ORDER BY y,x; -- IsSorted()==0
  123385. */
  123386. SQLITE_PRIVATE int sqlite3WhereIsSorted(WhereInfo *pWInfo){
  123387. assert( pWInfo->wctrlFlags & WHERE_GROUPBY );
  123388. assert( pWInfo->wctrlFlags & WHERE_SORTBYGROUP );
  123389. return pWInfo->sorted;
  123390. }
  123391. #ifdef WHERETRACE_ENABLED
  123392. /* For debugging use only: */
  123393. static const char *wherePathName(WherePath *pPath, int nLoop, WhereLoop *pLast){
  123394. static char zName[65];
  123395. int i;
  123396. for(i=0; i<nLoop; i++){ zName[i] = pPath->aLoop[i]->cId; }
  123397. if( pLast ) zName[i++] = pLast->cId;
  123398. zName[i] = 0;
  123399. return zName;
  123400. }
  123401. #endif
  123402. /*
  123403. ** Return the cost of sorting nRow rows, assuming that the keys have
  123404. ** nOrderby columns and that the first nSorted columns are already in
  123405. ** order.
  123406. */
  123407. static LogEst whereSortingCost(
  123408. WhereInfo *pWInfo,
  123409. LogEst nRow,
  123410. int nOrderBy,
  123411. int nSorted
  123412. ){
  123413. /* TUNING: Estimated cost of a full external sort, where N is
  123414. ** the number of rows to sort is:
  123415. **
  123416. ** cost = (3.0 * N * log(N)).
  123417. **
  123418. ** Or, if the order-by clause has X terms but only the last Y
  123419. ** terms are out of order, then block-sorting will reduce the
  123420. ** sorting cost to:
  123421. **
  123422. ** cost = (3.0 * N * log(N)) * (Y/X)
  123423. **
  123424. ** The (Y/X) term is implemented using stack variable rScale
  123425. ** below. */
  123426. LogEst rScale, rSortCost;
  123427. assert( nOrderBy>0 && 66==sqlite3LogEst(100) );
  123428. rScale = sqlite3LogEst((nOrderBy-nSorted)*100/nOrderBy) - 66;
  123429. rSortCost = nRow + rScale + 16;
  123430. /* Multiple by log(M) where M is the number of output rows.
  123431. ** Use the LIMIT for M if it is smaller */
  123432. if( (pWInfo->wctrlFlags & WHERE_USE_LIMIT)!=0 && pWInfo->iLimit<nRow ){
  123433. nRow = pWInfo->iLimit;
  123434. }
  123435. rSortCost += estLog(nRow);
  123436. return rSortCost;
  123437. }
  123438. /*
  123439. ** Given the list of WhereLoop objects at pWInfo->pLoops, this routine
  123440. ** attempts to find the lowest cost path that visits each WhereLoop
  123441. ** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
  123442. **
  123443. ** Assume that the total number of output rows that will need to be sorted
  123444. ** will be nRowEst (in the 10*log2 representation). Or, ignore sorting
  123445. ** costs if nRowEst==0.
  123446. **
  123447. ** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
  123448. ** error occurs.
  123449. */
  123450. static int wherePathSolver(WhereInfo *pWInfo, LogEst nRowEst){
  123451. int mxChoice; /* Maximum number of simultaneous paths tracked */
  123452. int nLoop; /* Number of terms in the join */
  123453. Parse *pParse; /* Parsing context */
  123454. sqlite3 *db; /* The database connection */
  123455. int iLoop; /* Loop counter over the terms of the join */
  123456. int ii, jj; /* Loop counters */
  123457. int mxI = 0; /* Index of next entry to replace */
  123458. int nOrderBy; /* Number of ORDER BY clause terms */
  123459. LogEst mxCost = 0; /* Maximum cost of a set of paths */
  123460. LogEst mxUnsorted = 0; /* Maximum unsorted cost of a set of path */
  123461. int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
  123462. WherePath *aFrom; /* All nFrom paths at the previous level */
  123463. WherePath *aTo; /* The nTo best paths at the current level */
  123464. WherePath *pFrom; /* An element of aFrom[] that we are working on */
  123465. WherePath *pTo; /* An element of aTo[] that we are working on */
  123466. WhereLoop *pWLoop; /* One of the WhereLoop objects */
  123467. WhereLoop **pX; /* Used to divy up the pSpace memory */
  123468. LogEst *aSortCost = 0; /* Sorting and partial sorting costs */
  123469. char *pSpace; /* Temporary memory used by this routine */
  123470. int nSpace; /* Bytes of space allocated at pSpace */
  123471. pParse = pWInfo->pParse;
  123472. db = pParse->db;
  123473. nLoop = pWInfo->nLevel;
  123474. /* TUNING: For simple queries, only the best path is tracked.
  123475. ** For 2-way joins, the 5 best paths are followed.
  123476. ** For joins of 3 or more tables, track the 10 best paths */
  123477. mxChoice = (nLoop<=1) ? 1 : (nLoop==2 ? 5 : 10);
  123478. assert( nLoop<=pWInfo->pTabList->nSrc );
  123479. WHERETRACE(0x002, ("---- begin solver. (nRowEst=%d)\n", nRowEst));
  123480. /* If nRowEst is zero and there is an ORDER BY clause, ignore it. In this
  123481. ** case the purpose of this call is to estimate the number of rows returned
  123482. ** by the overall query. Once this estimate has been obtained, the caller
  123483. ** will invoke this function a second time, passing the estimate as the
  123484. ** nRowEst parameter. */
  123485. if( pWInfo->pOrderBy==0 || nRowEst==0 ){
  123486. nOrderBy = 0;
  123487. }else{
  123488. nOrderBy = pWInfo->pOrderBy->nExpr;
  123489. }
  123490. /* Allocate and initialize space for aTo, aFrom and aSortCost[] */
  123491. nSpace = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
  123492. nSpace += sizeof(LogEst) * nOrderBy;
  123493. pSpace = sqlite3DbMallocRawNN(db, nSpace);
  123494. if( pSpace==0 ) return SQLITE_NOMEM_BKPT;
  123495. aTo = (WherePath*)pSpace;
  123496. aFrom = aTo+mxChoice;
  123497. memset(aFrom, 0, sizeof(aFrom[0]));
  123498. pX = (WhereLoop**)(aFrom+mxChoice);
  123499. for(ii=mxChoice*2, pFrom=aTo; ii>0; ii--, pFrom++, pX += nLoop){
  123500. pFrom->aLoop = pX;
  123501. }
  123502. if( nOrderBy ){
  123503. /* If there is an ORDER BY clause and it is not being ignored, set up
  123504. ** space for the aSortCost[] array. Each element of the aSortCost array
  123505. ** is either zero - meaning it has not yet been initialized - or the
  123506. ** cost of sorting nRowEst rows of data where the first X terms of
  123507. ** the ORDER BY clause are already in order, where X is the array
  123508. ** index. */
  123509. aSortCost = (LogEst*)pX;
  123510. memset(aSortCost, 0, sizeof(LogEst) * nOrderBy);
  123511. }
  123512. assert( aSortCost==0 || &pSpace[nSpace]==(char*)&aSortCost[nOrderBy] );
  123513. assert( aSortCost!=0 || &pSpace[nSpace]==(char*)pX );
  123514. /* Seed the search with a single WherePath containing zero WhereLoops.
  123515. **
  123516. ** TUNING: Do not let the number of iterations go above 28. If the cost
  123517. ** of computing an automatic index is not paid back within the first 28
  123518. ** rows, then do not use the automatic index. */
  123519. aFrom[0].nRow = MIN(pParse->nQueryLoop, 48); assert( 48==sqlite3LogEst(28) );
  123520. nFrom = 1;
  123521. assert( aFrom[0].isOrdered==0 );
  123522. if( nOrderBy ){
  123523. /* If nLoop is zero, then there are no FROM terms in the query. Since
  123524. ** in this case the query may return a maximum of one row, the results
  123525. ** are already in the requested order. Set isOrdered to nOrderBy to
  123526. ** indicate this. Or, if nLoop is greater than zero, set isOrdered to
  123527. ** -1, indicating that the result set may or may not be ordered,
  123528. ** depending on the loops added to the current plan. */
  123529. aFrom[0].isOrdered = nLoop>0 ? -1 : nOrderBy;
  123530. }
  123531. /* Compute successively longer WherePaths using the previous generation
  123532. ** of WherePaths as the basis for the next. Keep track of the mxChoice
  123533. ** best paths at each generation */
  123534. for(iLoop=0; iLoop<nLoop; iLoop++){
  123535. nTo = 0;
  123536. for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
  123537. for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
  123538. LogEst nOut; /* Rows visited by (pFrom+pWLoop) */
  123539. LogEst rCost; /* Cost of path (pFrom+pWLoop) */
  123540. LogEst rUnsorted; /* Unsorted cost of (pFrom+pWLoop) */
  123541. i8 isOrdered = pFrom->isOrdered; /* isOrdered for (pFrom+pWLoop) */
  123542. Bitmask maskNew; /* Mask of src visited by (..) */
  123543. Bitmask revMask = 0; /* Mask of rev-order loops for (..) */
  123544. if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
  123545. if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
  123546. if( (pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 && pFrom->nRow<10 ){
  123547. /* Do not use an automatic index if the this loop is expected
  123548. ** to run less than 2 times. */
  123549. assert( 10==sqlite3LogEst(2) );
  123550. continue;
  123551. }
  123552. /* At this point, pWLoop is a candidate to be the next loop.
  123553. ** Compute its cost */
  123554. rUnsorted = sqlite3LogEstAdd(pWLoop->rSetup,pWLoop->rRun + pFrom->nRow);
  123555. rUnsorted = sqlite3LogEstAdd(rUnsorted, pFrom->rUnsorted);
  123556. nOut = pFrom->nRow + pWLoop->nOut;
  123557. maskNew = pFrom->maskLoop | pWLoop->maskSelf;
  123558. if( isOrdered<0 ){
  123559. isOrdered = wherePathSatisfiesOrderBy(pWInfo,
  123560. pWInfo->pOrderBy, pFrom, pWInfo->wctrlFlags,
  123561. iLoop, pWLoop, &revMask);
  123562. }else{
  123563. revMask = pFrom->revLoop;
  123564. }
  123565. if( isOrdered>=0 && isOrdered<nOrderBy ){
  123566. if( aSortCost[isOrdered]==0 ){
  123567. aSortCost[isOrdered] = whereSortingCost(
  123568. pWInfo, nRowEst, nOrderBy, isOrdered
  123569. );
  123570. }
  123571. rCost = sqlite3LogEstAdd(rUnsorted, aSortCost[isOrdered]);
  123572. WHERETRACE(0x002,
  123573. ("---- sort cost=%-3d (%d/%d) increases cost %3d to %-3d\n",
  123574. aSortCost[isOrdered], (nOrderBy-isOrdered), nOrderBy,
  123575. rUnsorted, rCost));
  123576. }else{
  123577. rCost = rUnsorted;
  123578. }
  123579. /* Check to see if pWLoop should be added to the set of
  123580. ** mxChoice best-so-far paths.
  123581. **
  123582. ** First look for an existing path among best-so-far paths
  123583. ** that covers the same set of loops and has the same isOrdered
  123584. ** setting as the current path candidate.
  123585. **
  123586. ** The term "((pTo->isOrdered^isOrdered)&0x80)==0" is equivalent
  123587. ** to (pTo->isOrdered==(-1))==(isOrdered==(-1))" for the range
  123588. ** of legal values for isOrdered, -1..64.
  123589. */
  123590. for(jj=0, pTo=aTo; jj<nTo; jj++, pTo++){
  123591. if( pTo->maskLoop==maskNew
  123592. && ((pTo->isOrdered^isOrdered)&0x80)==0
  123593. ){
  123594. testcase( jj==nTo-1 );
  123595. break;
  123596. }
  123597. }
  123598. if( jj>=nTo ){
  123599. /* None of the existing best-so-far paths match the candidate. */
  123600. if( nTo>=mxChoice
  123601. && (rCost>mxCost || (rCost==mxCost && rUnsorted>=mxUnsorted))
  123602. ){
  123603. /* The current candidate is no better than any of the mxChoice
  123604. ** paths currently in the best-so-far buffer. So discard
  123605. ** this candidate as not viable. */
  123606. #ifdef WHERETRACE_ENABLED /* 0x4 */
  123607. if( sqlite3WhereTrace&0x4 ){
  123608. sqlite3DebugPrintf("Skip %s cost=%-3d,%3d order=%c\n",
  123609. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
  123610. isOrdered>=0 ? isOrdered+'0' : '?');
  123611. }
  123612. #endif
  123613. continue;
  123614. }
  123615. /* If we reach this points it means that the new candidate path
  123616. ** needs to be added to the set of best-so-far paths. */
  123617. if( nTo<mxChoice ){
  123618. /* Increase the size of the aTo set by one */
  123619. jj = nTo++;
  123620. }else{
  123621. /* New path replaces the prior worst to keep count below mxChoice */
  123622. jj = mxI;
  123623. }
  123624. pTo = &aTo[jj];
  123625. #ifdef WHERETRACE_ENABLED /* 0x4 */
  123626. if( sqlite3WhereTrace&0x4 ){
  123627. sqlite3DebugPrintf("New %s cost=%-3d,%3d order=%c\n",
  123628. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
  123629. isOrdered>=0 ? isOrdered+'0' : '?');
  123630. }
  123631. #endif
  123632. }else{
  123633. /* Control reaches here if best-so-far path pTo=aTo[jj] covers the
  123634. ** same set of loops and has the sam isOrdered setting as the
  123635. ** candidate path. Check to see if the candidate should replace
  123636. ** pTo or if the candidate should be skipped */
  123637. if( pTo->rCost<rCost || (pTo->rCost==rCost && pTo->nRow<=nOut) ){
  123638. #ifdef WHERETRACE_ENABLED /* 0x4 */
  123639. if( sqlite3WhereTrace&0x4 ){
  123640. sqlite3DebugPrintf(
  123641. "Skip %s cost=%-3d,%3d order=%c",
  123642. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
  123643. isOrdered>=0 ? isOrdered+'0' : '?');
  123644. sqlite3DebugPrintf(" vs %s cost=%-3d,%d order=%c\n",
  123645. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  123646. pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
  123647. }
  123648. #endif
  123649. /* Discard the candidate path from further consideration */
  123650. testcase( pTo->rCost==rCost );
  123651. continue;
  123652. }
  123653. testcase( pTo->rCost==rCost+1 );
  123654. /* Control reaches here if the candidate path is better than the
  123655. ** pTo path. Replace pTo with the candidate. */
  123656. #ifdef WHERETRACE_ENABLED /* 0x4 */
  123657. if( sqlite3WhereTrace&0x4 ){
  123658. sqlite3DebugPrintf(
  123659. "Update %s cost=%-3d,%3d order=%c",
  123660. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
  123661. isOrdered>=0 ? isOrdered+'0' : '?');
  123662. sqlite3DebugPrintf(" was %s cost=%-3d,%3d order=%c\n",
  123663. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  123664. pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
  123665. }
  123666. #endif
  123667. }
  123668. /* pWLoop is a winner. Add it to the set of best so far */
  123669. pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
  123670. pTo->revLoop = revMask;
  123671. pTo->nRow = nOut;
  123672. pTo->rCost = rCost;
  123673. pTo->rUnsorted = rUnsorted;
  123674. pTo->isOrdered = isOrdered;
  123675. memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
  123676. pTo->aLoop[iLoop] = pWLoop;
  123677. if( nTo>=mxChoice ){
  123678. mxI = 0;
  123679. mxCost = aTo[0].rCost;
  123680. mxUnsorted = aTo[0].nRow;
  123681. for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
  123682. if( pTo->rCost>mxCost
  123683. || (pTo->rCost==mxCost && pTo->rUnsorted>mxUnsorted)
  123684. ){
  123685. mxCost = pTo->rCost;
  123686. mxUnsorted = pTo->rUnsorted;
  123687. mxI = jj;
  123688. }
  123689. }
  123690. }
  123691. }
  123692. }
  123693. #ifdef WHERETRACE_ENABLED /* >=2 */
  123694. if( sqlite3WhereTrace & 0x02 ){
  123695. sqlite3DebugPrintf("---- after round %d ----\n", iLoop);
  123696. for(ii=0, pTo=aTo; ii<nTo; ii++, pTo++){
  123697. sqlite3DebugPrintf(" %s cost=%-3d nrow=%-3d order=%c",
  123698. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  123699. pTo->isOrdered>=0 ? (pTo->isOrdered+'0') : '?');
  123700. if( pTo->isOrdered>0 ){
  123701. sqlite3DebugPrintf(" rev=0x%llx\n", pTo->revLoop);
  123702. }else{
  123703. sqlite3DebugPrintf("\n");
  123704. }
  123705. }
  123706. }
  123707. #endif
  123708. /* Swap the roles of aFrom and aTo for the next generation */
  123709. pFrom = aTo;
  123710. aTo = aFrom;
  123711. aFrom = pFrom;
  123712. nFrom = nTo;
  123713. }
  123714. if( nFrom==0 ){
  123715. sqlite3ErrorMsg(pParse, "no query solution");
  123716. sqlite3DbFree(db, pSpace);
  123717. return SQLITE_ERROR;
  123718. }
  123719. /* Find the lowest cost path. pFrom will be left pointing to that path */
  123720. pFrom = aFrom;
  123721. for(ii=1; ii<nFrom; ii++){
  123722. if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
  123723. }
  123724. assert( pWInfo->nLevel==nLoop );
  123725. /* Load the lowest cost path into pWInfo */
  123726. for(iLoop=0; iLoop<nLoop; iLoop++){
  123727. WhereLevel *pLevel = pWInfo->a + iLoop;
  123728. pLevel->pWLoop = pWLoop = pFrom->aLoop[iLoop];
  123729. pLevel->iFrom = pWLoop->iTab;
  123730. pLevel->iTabCur = pWInfo->pTabList->a[pLevel->iFrom].iCursor;
  123731. }
  123732. if( (pWInfo->wctrlFlags & WHERE_WANT_DISTINCT)!=0
  123733. && (pWInfo->wctrlFlags & WHERE_DISTINCTBY)==0
  123734. && pWInfo->eDistinct==WHERE_DISTINCT_NOOP
  123735. && nRowEst
  123736. ){
  123737. Bitmask notUsed;
  123738. int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pDistinctSet, pFrom,
  123739. WHERE_DISTINCTBY, nLoop-1, pFrom->aLoop[nLoop-1], &notUsed);
  123740. if( rc==pWInfo->pDistinctSet->nExpr ){
  123741. pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
  123742. }
  123743. }
  123744. if( pWInfo->pOrderBy ){
  123745. if( pWInfo->wctrlFlags & WHERE_DISTINCTBY ){
  123746. if( pFrom->isOrdered==pWInfo->pOrderBy->nExpr ){
  123747. pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
  123748. }
  123749. }else{
  123750. pWInfo->nOBSat = pFrom->isOrdered;
  123751. pWInfo->revMask = pFrom->revLoop;
  123752. if( pWInfo->nOBSat<=0 ){
  123753. pWInfo->nOBSat = 0;
  123754. if( nLoop>0 ){
  123755. u32 wsFlags = pFrom->aLoop[nLoop-1]->wsFlags;
  123756. if( (wsFlags & WHERE_ONEROW)==0
  123757. && (wsFlags&(WHERE_IPK|WHERE_COLUMN_IN))!=(WHERE_IPK|WHERE_COLUMN_IN)
  123758. ){
  123759. Bitmask m = 0;
  123760. int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pOrderBy, pFrom,
  123761. WHERE_ORDERBY_LIMIT, nLoop-1, pFrom->aLoop[nLoop-1], &m);
  123762. testcase( wsFlags & WHERE_IPK );
  123763. testcase( wsFlags & WHERE_COLUMN_IN );
  123764. if( rc==pWInfo->pOrderBy->nExpr ){
  123765. pWInfo->bOrderedInnerLoop = 1;
  123766. pWInfo->revMask = m;
  123767. }
  123768. }
  123769. }
  123770. }
  123771. }
  123772. if( (pWInfo->wctrlFlags & WHERE_SORTBYGROUP)
  123773. && pWInfo->nOBSat==pWInfo->pOrderBy->nExpr && nLoop>0
  123774. ){
  123775. Bitmask revMask = 0;
  123776. int nOrder = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pOrderBy,
  123777. pFrom, 0, nLoop-1, pFrom->aLoop[nLoop-1], &revMask
  123778. );
  123779. assert( pWInfo->sorted==0 );
  123780. if( nOrder==pWInfo->pOrderBy->nExpr ){
  123781. pWInfo->sorted = 1;
  123782. pWInfo->revMask = revMask;
  123783. }
  123784. }
  123785. }
  123786. pWInfo->nRowOut = pFrom->nRow;
  123787. /* Free temporary memory and return success */
  123788. sqlite3DbFree(db, pSpace);
  123789. return SQLITE_OK;
  123790. }
  123791. /*
  123792. ** Most queries use only a single table (they are not joins) and have
  123793. ** simple == constraints against indexed fields. This routine attempts
  123794. ** to plan those simple cases using much less ceremony than the
  123795. ** general-purpose query planner, and thereby yield faster sqlite3_prepare()
  123796. ** times for the common case.
  123797. **
  123798. ** Return non-zero on success, if this query can be handled by this
  123799. ** no-frills query planner. Return zero if this query needs the
  123800. ** general-purpose query planner.
  123801. */
  123802. static int whereShortCut(WhereLoopBuilder *pBuilder){
  123803. WhereInfo *pWInfo;
  123804. struct SrcList_item *pItem;
  123805. WhereClause *pWC;
  123806. WhereTerm *pTerm;
  123807. WhereLoop *pLoop;
  123808. int iCur;
  123809. int j;
  123810. Table *pTab;
  123811. Index *pIdx;
  123812. pWInfo = pBuilder->pWInfo;
  123813. if( pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE ) return 0;
  123814. assert( pWInfo->pTabList->nSrc>=1 );
  123815. pItem = pWInfo->pTabList->a;
  123816. pTab = pItem->pTab;
  123817. if( IsVirtual(pTab) ) return 0;
  123818. if( pItem->fg.isIndexedBy ) return 0;
  123819. iCur = pItem->iCursor;
  123820. pWC = &pWInfo->sWC;
  123821. pLoop = pBuilder->pNew;
  123822. pLoop->wsFlags = 0;
  123823. pLoop->nSkip = 0;
  123824. pTerm = sqlite3WhereFindTerm(pWC, iCur, -1, 0, WO_EQ|WO_IS, 0);
  123825. if( pTerm ){
  123826. testcase( pTerm->eOperator & WO_IS );
  123827. pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_IPK|WHERE_ONEROW;
  123828. pLoop->aLTerm[0] = pTerm;
  123829. pLoop->nLTerm = 1;
  123830. pLoop->u.btree.nEq = 1;
  123831. /* TUNING: Cost of a rowid lookup is 10 */
  123832. pLoop->rRun = 33; /* 33==sqlite3LogEst(10) */
  123833. }else{
  123834. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  123835. int opMask;
  123836. assert( pLoop->aLTermSpace==pLoop->aLTerm );
  123837. if( !IsUniqueIndex(pIdx)
  123838. || pIdx->pPartIdxWhere!=0
  123839. || pIdx->nKeyCol>ArraySize(pLoop->aLTermSpace)
  123840. ) continue;
  123841. opMask = pIdx->uniqNotNull ? (WO_EQ|WO_IS) : WO_EQ;
  123842. for(j=0; j<pIdx->nKeyCol; j++){
  123843. pTerm = sqlite3WhereFindTerm(pWC, iCur, j, 0, opMask, pIdx);
  123844. if( pTerm==0 ) break;
  123845. testcase( pTerm->eOperator & WO_IS );
  123846. pLoop->aLTerm[j] = pTerm;
  123847. }
  123848. if( j!=pIdx->nKeyCol ) continue;
  123849. pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_ONEROW|WHERE_INDEXED;
  123850. if( pIdx->isCovering || (pItem->colUsed & ~columnsInIndex(pIdx))==0 ){
  123851. pLoop->wsFlags |= WHERE_IDX_ONLY;
  123852. }
  123853. pLoop->nLTerm = j;
  123854. pLoop->u.btree.nEq = j;
  123855. pLoop->u.btree.pIndex = pIdx;
  123856. /* TUNING: Cost of a unique index lookup is 15 */
  123857. pLoop->rRun = 39; /* 39==sqlite3LogEst(15) */
  123858. break;
  123859. }
  123860. }
  123861. if( pLoop->wsFlags ){
  123862. pLoop->nOut = (LogEst)1;
  123863. pWInfo->a[0].pWLoop = pLoop;
  123864. pLoop->maskSelf = sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
  123865. pWInfo->a[0].iTabCur = iCur;
  123866. pWInfo->nRowOut = 1;
  123867. if( pWInfo->pOrderBy ) pWInfo->nOBSat = pWInfo->pOrderBy->nExpr;
  123868. if( pWInfo->wctrlFlags & WHERE_WANT_DISTINCT ){
  123869. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  123870. }
  123871. #ifdef SQLITE_DEBUG
  123872. pLoop->cId = '0';
  123873. #endif
  123874. return 1;
  123875. }
  123876. return 0;
  123877. }
  123878. /*
  123879. ** Generate the beginning of the loop used for WHERE clause processing.
  123880. ** The return value is a pointer to an opaque structure that contains
  123881. ** information needed to terminate the loop. Later, the calling routine
  123882. ** should invoke sqlite3WhereEnd() with the return value of this function
  123883. ** in order to complete the WHERE clause processing.
  123884. **
  123885. ** If an error occurs, this routine returns NULL.
  123886. **
  123887. ** The basic idea is to do a nested loop, one loop for each table in
  123888. ** the FROM clause of a select. (INSERT and UPDATE statements are the
  123889. ** same as a SELECT with only a single table in the FROM clause.) For
  123890. ** example, if the SQL is this:
  123891. **
  123892. ** SELECT * FROM t1, t2, t3 WHERE ...;
  123893. **
  123894. ** Then the code generated is conceptually like the following:
  123895. **
  123896. ** foreach row1 in t1 do \ Code generated
  123897. ** foreach row2 in t2 do |-- by sqlite3WhereBegin()
  123898. ** foreach row3 in t3 do /
  123899. ** ...
  123900. ** end \ Code generated
  123901. ** end |-- by sqlite3WhereEnd()
  123902. ** end /
  123903. **
  123904. ** Note that the loops might not be nested in the order in which they
  123905. ** appear in the FROM clause if a different order is better able to make
  123906. ** use of indices. Note also that when the IN operator appears in
  123907. ** the WHERE clause, it might result in additional nested loops for
  123908. ** scanning through all values on the right-hand side of the IN.
  123909. **
  123910. ** There are Btree cursors associated with each table. t1 uses cursor
  123911. ** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
  123912. ** And so forth. This routine generates code to open those VDBE cursors
  123913. ** and sqlite3WhereEnd() generates the code to close them.
  123914. **
  123915. ** The code that sqlite3WhereBegin() generates leaves the cursors named
  123916. ** in pTabList pointing at their appropriate entries. The [...] code
  123917. ** can use OP_Column and OP_Rowid opcodes on these cursors to extract
  123918. ** data from the various tables of the loop.
  123919. **
  123920. ** If the WHERE clause is empty, the foreach loops must each scan their
  123921. ** entire tables. Thus a three-way join is an O(N^3) operation. But if
  123922. ** the tables have indices and there are terms in the WHERE clause that
  123923. ** refer to those indices, a complete table scan can be avoided and the
  123924. ** code will run much faster. Most of the work of this routine is checking
  123925. ** to see if there are indices that can be used to speed up the loop.
  123926. **
  123927. ** Terms of the WHERE clause are also used to limit which rows actually
  123928. ** make it to the "..." in the middle of the loop. After each "foreach",
  123929. ** terms of the WHERE clause that use only terms in that loop and outer
  123930. ** loops are evaluated and if false a jump is made around all subsequent
  123931. ** inner loops (or around the "..." if the test occurs within the inner-
  123932. ** most loop)
  123933. **
  123934. ** OUTER JOINS
  123935. **
  123936. ** An outer join of tables t1 and t2 is conceptally coded as follows:
  123937. **
  123938. ** foreach row1 in t1 do
  123939. ** flag = 0
  123940. ** foreach row2 in t2 do
  123941. ** start:
  123942. ** ...
  123943. ** flag = 1
  123944. ** end
  123945. ** if flag==0 then
  123946. ** move the row2 cursor to a null row
  123947. ** goto start
  123948. ** fi
  123949. ** end
  123950. **
  123951. ** ORDER BY CLAUSE PROCESSING
  123952. **
  123953. ** pOrderBy is a pointer to the ORDER BY clause (or the GROUP BY clause
  123954. ** if the WHERE_GROUPBY flag is set in wctrlFlags) of a SELECT statement
  123955. ** if there is one. If there is no ORDER BY clause or if this routine
  123956. ** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
  123957. **
  123958. ** The iIdxCur parameter is the cursor number of an index. If
  123959. ** WHERE_OR_SUBCLAUSE is set, iIdxCur is the cursor number of an index
  123960. ** to use for OR clause processing. The WHERE clause should use this
  123961. ** specific cursor. If WHERE_ONEPASS_DESIRED is set, then iIdxCur is
  123962. ** the first cursor in an array of cursors for all indices. iIdxCur should
  123963. ** be used to compute the appropriate cursor depending on which index is
  123964. ** used.
  123965. */
  123966. SQLITE_PRIVATE WhereInfo *sqlite3WhereBegin(
  123967. Parse *pParse, /* The parser context */
  123968. SrcList *pTabList, /* FROM clause: A list of all tables to be scanned */
  123969. Expr *pWhere, /* The WHERE clause */
  123970. ExprList *pOrderBy, /* An ORDER BY (or GROUP BY) clause, or NULL */
  123971. ExprList *pDistinctSet, /* Try not to output two rows that duplicate these */
  123972. u16 wctrlFlags, /* The WHERE_* flags defined in sqliteInt.h */
  123973. int iAuxArg /* If WHERE_OR_SUBCLAUSE is set, index cursor number
  123974. ** If WHERE_USE_LIMIT, then the limit amount */
  123975. ){
  123976. int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
  123977. int nTabList; /* Number of elements in pTabList */
  123978. WhereInfo *pWInfo; /* Will become the return value of this function */
  123979. Vdbe *v = pParse->pVdbe; /* The virtual database engine */
  123980. Bitmask notReady; /* Cursors that are not yet positioned */
  123981. WhereLoopBuilder sWLB; /* The WhereLoop builder */
  123982. WhereMaskSet *pMaskSet; /* The expression mask set */
  123983. WhereLevel *pLevel; /* A single level in pWInfo->a[] */
  123984. WhereLoop *pLoop; /* Pointer to a single WhereLoop object */
  123985. int ii; /* Loop counter */
  123986. sqlite3 *db; /* Database connection */
  123987. int rc; /* Return code */
  123988. u8 bFordelete = 0; /* OPFLAG_FORDELETE or zero, as appropriate */
  123989. assert( (wctrlFlags & WHERE_ONEPASS_MULTIROW)==0 || (
  123990. (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0
  123991. && (wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  123992. ));
  123993. /* Only one of WHERE_OR_SUBCLAUSE or WHERE_USE_LIMIT */
  123994. assert( (wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  123995. || (wctrlFlags & WHERE_USE_LIMIT)==0 );
  123996. /* Variable initialization */
  123997. db = pParse->db;
  123998. memset(&sWLB, 0, sizeof(sWLB));
  123999. /* An ORDER/GROUP BY clause of more than 63 terms cannot be optimized */
  124000. testcase( pOrderBy && pOrderBy->nExpr==BMS-1 );
  124001. if( pOrderBy && pOrderBy->nExpr>=BMS ) pOrderBy = 0;
  124002. sWLB.pOrderBy = pOrderBy;
  124003. /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
  124004. ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
  124005. if( OptimizationDisabled(db, SQLITE_DistinctOpt) ){
  124006. wctrlFlags &= ~WHERE_WANT_DISTINCT;
  124007. }
  124008. /* The number of tables in the FROM clause is limited by the number of
  124009. ** bits in a Bitmask
  124010. */
  124011. testcase( pTabList->nSrc==BMS );
  124012. if( pTabList->nSrc>BMS ){
  124013. sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
  124014. return 0;
  124015. }
  124016. /* This function normally generates a nested loop for all tables in
  124017. ** pTabList. But if the WHERE_OR_SUBCLAUSE flag is set, then we should
  124018. ** only generate code for the first table in pTabList and assume that
  124019. ** any cursors associated with subsequent tables are uninitialized.
  124020. */
  124021. nTabList = (wctrlFlags & WHERE_OR_SUBCLAUSE) ? 1 : pTabList->nSrc;
  124022. /* Allocate and initialize the WhereInfo structure that will become the
  124023. ** return value. A single allocation is used to store the WhereInfo
  124024. ** struct, the contents of WhereInfo.a[], the WhereClause structure
  124025. ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
  124026. ** field (type Bitmask) it must be aligned on an 8-byte boundary on
  124027. ** some architectures. Hence the ROUND8() below.
  124028. */
  124029. nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
  124030. pWInfo = sqlite3DbMallocRawNN(db, nByteWInfo + sizeof(WhereLoop));
  124031. if( db->mallocFailed ){
  124032. sqlite3DbFree(db, pWInfo);
  124033. pWInfo = 0;
  124034. goto whereBeginError;
  124035. }
  124036. pWInfo->pParse = pParse;
  124037. pWInfo->pTabList = pTabList;
  124038. pWInfo->pOrderBy = pOrderBy;
  124039. pWInfo->pDistinctSet = pDistinctSet;
  124040. pWInfo->aiCurOnePass[0] = pWInfo->aiCurOnePass[1] = -1;
  124041. pWInfo->nLevel = nTabList;
  124042. pWInfo->iBreak = pWInfo->iContinue = sqlite3VdbeMakeLabel(v);
  124043. pWInfo->wctrlFlags = wctrlFlags;
  124044. pWInfo->iLimit = iAuxArg;
  124045. pWInfo->savedNQueryLoop = pParse->nQueryLoop;
  124046. memset(&pWInfo->nOBSat, 0,
  124047. offsetof(WhereInfo,sWC) - offsetof(WhereInfo,nOBSat));
  124048. memset(&pWInfo->a[0], 0, sizeof(WhereLoop)+nTabList*sizeof(WhereLevel));
  124049. assert( pWInfo->eOnePass==ONEPASS_OFF ); /* ONEPASS defaults to OFF */
  124050. pMaskSet = &pWInfo->sMaskSet;
  124051. sWLB.pWInfo = pWInfo;
  124052. sWLB.pWC = &pWInfo->sWC;
  124053. sWLB.pNew = (WhereLoop*)(((char*)pWInfo)+nByteWInfo);
  124054. assert( EIGHT_BYTE_ALIGNMENT(sWLB.pNew) );
  124055. whereLoopInit(sWLB.pNew);
  124056. #ifdef SQLITE_DEBUG
  124057. sWLB.pNew->cId = '*';
  124058. #endif
  124059. /* Split the WHERE clause into separate subexpressions where each
  124060. ** subexpression is separated by an AND operator.
  124061. */
  124062. initMaskSet(pMaskSet);
  124063. sqlite3WhereClauseInit(&pWInfo->sWC, pWInfo);
  124064. sqlite3WhereSplit(&pWInfo->sWC, pWhere, TK_AND);
  124065. /* Special case: a WHERE clause that is constant. Evaluate the
  124066. ** expression and either jump over all of the code or fall thru.
  124067. */
  124068. for(ii=0; ii<sWLB.pWC->nTerm; ii++){
  124069. if( nTabList==0 || sqlite3ExprIsConstantNotJoin(sWLB.pWC->a[ii].pExpr) ){
  124070. sqlite3ExprIfFalse(pParse, sWLB.pWC->a[ii].pExpr, pWInfo->iBreak,
  124071. SQLITE_JUMPIFNULL);
  124072. sWLB.pWC->a[ii].wtFlags |= TERM_CODED;
  124073. }
  124074. }
  124075. /* Special case: No FROM clause
  124076. */
  124077. if( nTabList==0 ){
  124078. if( pOrderBy ) pWInfo->nOBSat = pOrderBy->nExpr;
  124079. if( wctrlFlags & WHERE_WANT_DISTINCT ){
  124080. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  124081. }
  124082. }
  124083. /* Assign a bit from the bitmask to every term in the FROM clause.
  124084. **
  124085. ** The N-th term of the FROM clause is assigned a bitmask of 1<<N.
  124086. **
  124087. ** The rule of the previous sentence ensures thta if X is the bitmask for
  124088. ** a table T, then X-1 is the bitmask for all other tables to the left of T.
  124089. ** Knowing the bitmask for all tables to the left of a left join is
  124090. ** important. Ticket #3015.
  124091. **
  124092. ** Note that bitmasks are created for all pTabList->nSrc tables in
  124093. ** pTabList, not just the first nTabList tables. nTabList is normally
  124094. ** equal to pTabList->nSrc but might be shortened to 1 if the
  124095. ** WHERE_OR_SUBCLAUSE flag is set.
  124096. */
  124097. for(ii=0; ii<pTabList->nSrc; ii++){
  124098. createMask(pMaskSet, pTabList->a[ii].iCursor);
  124099. sqlite3WhereTabFuncArgs(pParse, &pTabList->a[ii], &pWInfo->sWC);
  124100. }
  124101. #ifdef SQLITE_DEBUG
  124102. for(ii=0; ii<pTabList->nSrc; ii++){
  124103. Bitmask m = sqlite3WhereGetMask(pMaskSet, pTabList->a[ii].iCursor);
  124104. assert( m==MASKBIT(ii) );
  124105. }
  124106. #endif
  124107. /* Analyze all of the subexpressions. */
  124108. sqlite3WhereExprAnalyze(pTabList, &pWInfo->sWC);
  124109. if( db->mallocFailed ) goto whereBeginError;
  124110. if( wctrlFlags & WHERE_WANT_DISTINCT ){
  124111. if( isDistinctRedundant(pParse, pTabList, &pWInfo->sWC, pDistinctSet) ){
  124112. /* The DISTINCT marking is pointless. Ignore it. */
  124113. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  124114. }else if( pOrderBy==0 ){
  124115. /* Try to ORDER BY the result set to make distinct processing easier */
  124116. pWInfo->wctrlFlags |= WHERE_DISTINCTBY;
  124117. pWInfo->pOrderBy = pDistinctSet;
  124118. }
  124119. }
  124120. /* Construct the WhereLoop objects */
  124121. #if defined(WHERETRACE_ENABLED)
  124122. if( sqlite3WhereTrace & 0xffff ){
  124123. sqlite3DebugPrintf("*** Optimizer Start *** (wctrlFlags: 0x%x",wctrlFlags);
  124124. if( wctrlFlags & WHERE_USE_LIMIT ){
  124125. sqlite3DebugPrintf(", limit: %d", iAuxArg);
  124126. }
  124127. sqlite3DebugPrintf(")\n");
  124128. }
  124129. if( sqlite3WhereTrace & 0x100 ){ /* Display all terms of the WHERE clause */
  124130. sqlite3WhereClausePrint(sWLB.pWC);
  124131. }
  124132. #endif
  124133. if( nTabList!=1 || whereShortCut(&sWLB)==0 ){
  124134. rc = whereLoopAddAll(&sWLB);
  124135. if( rc ) goto whereBeginError;
  124136. #ifdef WHERETRACE_ENABLED
  124137. if( sqlite3WhereTrace ){ /* Display all of the WhereLoop objects */
  124138. WhereLoop *p;
  124139. int i;
  124140. static const char zLabel[] = "0123456789abcdefghijklmnopqrstuvwyxz"
  124141. "ABCDEFGHIJKLMNOPQRSTUVWYXZ";
  124142. for(p=pWInfo->pLoops, i=0; p; p=p->pNextLoop, i++){
  124143. p->cId = zLabel[i%sizeof(zLabel)];
  124144. whereLoopPrint(p, sWLB.pWC);
  124145. }
  124146. }
  124147. #endif
  124148. wherePathSolver(pWInfo, 0);
  124149. if( db->mallocFailed ) goto whereBeginError;
  124150. if( pWInfo->pOrderBy ){
  124151. wherePathSolver(pWInfo, pWInfo->nRowOut+1);
  124152. if( db->mallocFailed ) goto whereBeginError;
  124153. }
  124154. }
  124155. if( pWInfo->pOrderBy==0 && (db->flags & SQLITE_ReverseOrder)!=0 ){
  124156. pWInfo->revMask = ALLBITS;
  124157. }
  124158. if( pParse->nErr || NEVER(db->mallocFailed) ){
  124159. goto whereBeginError;
  124160. }
  124161. #ifdef WHERETRACE_ENABLED
  124162. if( sqlite3WhereTrace ){
  124163. sqlite3DebugPrintf("---- Solution nRow=%d", pWInfo->nRowOut);
  124164. if( pWInfo->nOBSat>0 ){
  124165. sqlite3DebugPrintf(" ORDERBY=%d,0x%llx", pWInfo->nOBSat, pWInfo->revMask);
  124166. }
  124167. switch( pWInfo->eDistinct ){
  124168. case WHERE_DISTINCT_UNIQUE: {
  124169. sqlite3DebugPrintf(" DISTINCT=unique");
  124170. break;
  124171. }
  124172. case WHERE_DISTINCT_ORDERED: {
  124173. sqlite3DebugPrintf(" DISTINCT=ordered");
  124174. break;
  124175. }
  124176. case WHERE_DISTINCT_UNORDERED: {
  124177. sqlite3DebugPrintf(" DISTINCT=unordered");
  124178. break;
  124179. }
  124180. }
  124181. sqlite3DebugPrintf("\n");
  124182. for(ii=0; ii<pWInfo->nLevel; ii++){
  124183. whereLoopPrint(pWInfo->a[ii].pWLoop, sWLB.pWC);
  124184. }
  124185. }
  124186. #endif
  124187. /* Attempt to omit tables from the join that do not effect the result */
  124188. if( pWInfo->nLevel>=2
  124189. && pDistinctSet!=0
  124190. && OptimizationEnabled(db, SQLITE_OmitNoopJoin)
  124191. ){
  124192. Bitmask tabUsed = sqlite3WhereExprListUsage(pMaskSet, pDistinctSet);
  124193. if( sWLB.pOrderBy ){
  124194. tabUsed |= sqlite3WhereExprListUsage(pMaskSet, sWLB.pOrderBy);
  124195. }
  124196. while( pWInfo->nLevel>=2 ){
  124197. WhereTerm *pTerm, *pEnd;
  124198. pLoop = pWInfo->a[pWInfo->nLevel-1].pWLoop;
  124199. if( (pWInfo->pTabList->a[pLoop->iTab].fg.jointype & JT_LEFT)==0 ) break;
  124200. if( (wctrlFlags & WHERE_WANT_DISTINCT)==0
  124201. && (pLoop->wsFlags & WHERE_ONEROW)==0
  124202. ){
  124203. break;
  124204. }
  124205. if( (tabUsed & pLoop->maskSelf)!=0 ) break;
  124206. pEnd = sWLB.pWC->a + sWLB.pWC->nTerm;
  124207. for(pTerm=sWLB.pWC->a; pTerm<pEnd; pTerm++){
  124208. if( (pTerm->prereqAll & pLoop->maskSelf)!=0
  124209. && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
  124210. ){
  124211. break;
  124212. }
  124213. }
  124214. if( pTerm<pEnd ) break;
  124215. WHERETRACE(0xffff, ("-> drop loop %c not used\n", pLoop->cId));
  124216. pWInfo->nLevel--;
  124217. nTabList--;
  124218. }
  124219. }
  124220. WHERETRACE(0xffff,("*** Optimizer Finished ***\n"));
  124221. pWInfo->pParse->nQueryLoop += pWInfo->nRowOut;
  124222. /* If the caller is an UPDATE or DELETE statement that is requesting
  124223. ** to use a one-pass algorithm, determine if this is appropriate.
  124224. */
  124225. assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
  124226. if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 ){
  124227. int wsFlags = pWInfo->a[0].pWLoop->wsFlags;
  124228. int bOnerow = (wsFlags & WHERE_ONEROW)!=0;
  124229. if( bOnerow
  124230. || ((wctrlFlags & WHERE_ONEPASS_MULTIROW)!=0
  124231. && 0==(wsFlags & WHERE_VIRTUALTABLE))
  124232. ){
  124233. pWInfo->eOnePass = bOnerow ? ONEPASS_SINGLE : ONEPASS_MULTI;
  124234. if( HasRowid(pTabList->a[0].pTab) && (wsFlags & WHERE_IDX_ONLY) ){
  124235. if( wctrlFlags & WHERE_ONEPASS_MULTIROW ){
  124236. bFordelete = OPFLAG_FORDELETE;
  124237. }
  124238. pWInfo->a[0].pWLoop->wsFlags = (wsFlags & ~WHERE_IDX_ONLY);
  124239. }
  124240. }
  124241. }
  124242. /* Open all tables in the pTabList and any indices selected for
  124243. ** searching those tables.
  124244. */
  124245. for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
  124246. Table *pTab; /* Table to open */
  124247. int iDb; /* Index of database containing table/index */
  124248. struct SrcList_item *pTabItem;
  124249. pTabItem = &pTabList->a[pLevel->iFrom];
  124250. pTab = pTabItem->pTab;
  124251. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  124252. pLoop = pLevel->pWLoop;
  124253. if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
  124254. /* Do nothing */
  124255. }else
  124256. #ifndef SQLITE_OMIT_VIRTUALTABLE
  124257. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
  124258. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  124259. int iCur = pTabItem->iCursor;
  124260. sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
  124261. }else if( IsVirtual(pTab) ){
  124262. /* noop */
  124263. }else
  124264. #endif
  124265. if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
  124266. && (wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
  124267. int op = OP_OpenRead;
  124268. if( pWInfo->eOnePass!=ONEPASS_OFF ){
  124269. op = OP_OpenWrite;
  124270. pWInfo->aiCurOnePass[0] = pTabItem->iCursor;
  124271. };
  124272. sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
  124273. assert( pTabItem->iCursor==pLevel->iTabCur );
  124274. testcase( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol==BMS-1 );
  124275. testcase( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol==BMS );
  124276. if( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol<BMS && HasRowid(pTab) ){
  124277. Bitmask b = pTabItem->colUsed;
  124278. int n = 0;
  124279. for(; b; b=b>>1, n++){}
  124280. sqlite3VdbeChangeP4(v, -1, SQLITE_INT_TO_PTR(n), P4_INT32);
  124281. assert( n<=pTab->nCol );
  124282. }
  124283. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  124284. if( pLoop->u.btree.pIndex!=0 ){
  124285. sqlite3VdbeChangeP5(v, OPFLAG_SEEKEQ|bFordelete);
  124286. }else
  124287. #endif
  124288. {
  124289. sqlite3VdbeChangeP5(v, bFordelete);
  124290. }
  124291. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  124292. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed, pTabItem->iCursor, 0, 0,
  124293. (const u8*)&pTabItem->colUsed, P4_INT64);
  124294. #endif
  124295. }else{
  124296. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  124297. }
  124298. if( pLoop->wsFlags & WHERE_INDEXED ){
  124299. Index *pIx = pLoop->u.btree.pIndex;
  124300. int iIndexCur;
  124301. int op = OP_OpenRead;
  124302. /* iAuxArg is always set if to a positive value if ONEPASS is possible */
  124303. assert( iAuxArg!=0 || (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 );
  124304. if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIx)
  124305. && (wctrlFlags & WHERE_OR_SUBCLAUSE)!=0
  124306. ){
  124307. /* This is one term of an OR-optimization using the PRIMARY KEY of a
  124308. ** WITHOUT ROWID table. No need for a separate index */
  124309. iIndexCur = pLevel->iTabCur;
  124310. op = 0;
  124311. }else if( pWInfo->eOnePass!=ONEPASS_OFF ){
  124312. Index *pJ = pTabItem->pTab->pIndex;
  124313. iIndexCur = iAuxArg;
  124314. assert( wctrlFlags & WHERE_ONEPASS_DESIRED );
  124315. while( ALWAYS(pJ) && pJ!=pIx ){
  124316. iIndexCur++;
  124317. pJ = pJ->pNext;
  124318. }
  124319. op = OP_OpenWrite;
  124320. pWInfo->aiCurOnePass[1] = iIndexCur;
  124321. }else if( iAuxArg && (wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 ){
  124322. iIndexCur = iAuxArg;
  124323. op = OP_ReopenIdx;
  124324. }else{
  124325. iIndexCur = pParse->nTab++;
  124326. }
  124327. pLevel->iIdxCur = iIndexCur;
  124328. assert( pIx->pSchema==pTab->pSchema );
  124329. assert( iIndexCur>=0 );
  124330. if( op ){
  124331. sqlite3VdbeAddOp3(v, op, iIndexCur, pIx->tnum, iDb);
  124332. sqlite3VdbeSetP4KeyInfo(pParse, pIx);
  124333. if( (pLoop->wsFlags & WHERE_CONSTRAINT)!=0
  124334. && (pLoop->wsFlags & (WHERE_COLUMN_RANGE|WHERE_SKIPSCAN))==0
  124335. && (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0
  124336. ){
  124337. sqlite3VdbeChangeP5(v, OPFLAG_SEEKEQ); /* Hint to COMDB2 */
  124338. }
  124339. VdbeComment((v, "%s", pIx->zName));
  124340. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  124341. {
  124342. u64 colUsed = 0;
  124343. int ii, jj;
  124344. for(ii=0; ii<pIx->nColumn; ii++){
  124345. jj = pIx->aiColumn[ii];
  124346. if( jj<0 ) continue;
  124347. if( jj>63 ) jj = 63;
  124348. if( (pTabItem->colUsed & MASKBIT(jj))==0 ) continue;
  124349. colUsed |= ((u64)1)<<(ii<63 ? ii : 63);
  124350. }
  124351. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed, iIndexCur, 0, 0,
  124352. (u8*)&colUsed, P4_INT64);
  124353. }
  124354. #endif /* SQLITE_ENABLE_COLUMN_USED_MASK */
  124355. }
  124356. }
  124357. if( iDb>=0 ) sqlite3CodeVerifySchema(pParse, iDb);
  124358. }
  124359. pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
  124360. if( db->mallocFailed ) goto whereBeginError;
  124361. /* Generate the code to do the search. Each iteration of the for
  124362. ** loop below generates code for a single nested loop of the VM
  124363. ** program.
  124364. */
  124365. notReady = ~(Bitmask)0;
  124366. for(ii=0; ii<nTabList; ii++){
  124367. int addrExplain;
  124368. int wsFlags;
  124369. pLevel = &pWInfo->a[ii];
  124370. wsFlags = pLevel->pWLoop->wsFlags;
  124371. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  124372. if( (pLevel->pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 ){
  124373. constructAutomaticIndex(pParse, &pWInfo->sWC,
  124374. &pTabList->a[pLevel->iFrom], notReady, pLevel);
  124375. if( db->mallocFailed ) goto whereBeginError;
  124376. }
  124377. #endif
  124378. addrExplain = sqlite3WhereExplainOneScan(
  124379. pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags
  124380. );
  124381. pLevel->addrBody = sqlite3VdbeCurrentAddr(v);
  124382. notReady = sqlite3WhereCodeOneLoopStart(pWInfo, ii, notReady);
  124383. pWInfo->iContinue = pLevel->addrCont;
  124384. if( (wsFlags&WHERE_MULTI_OR)==0 && (wctrlFlags&WHERE_OR_SUBCLAUSE)==0 ){
  124385. sqlite3WhereAddScanStatus(v, pTabList, pLevel, addrExplain);
  124386. }
  124387. }
  124388. /* Done. */
  124389. VdbeModuleComment((v, "Begin WHERE-core"));
  124390. return pWInfo;
  124391. /* Jump here if malloc fails */
  124392. whereBeginError:
  124393. if( pWInfo ){
  124394. pParse->nQueryLoop = pWInfo->savedNQueryLoop;
  124395. whereInfoFree(db, pWInfo);
  124396. }
  124397. return 0;
  124398. }
  124399. /*
  124400. ** Generate the end of the WHERE loop. See comments on
  124401. ** sqlite3WhereBegin() for additional information.
  124402. */
  124403. SQLITE_PRIVATE void sqlite3WhereEnd(WhereInfo *pWInfo){
  124404. Parse *pParse = pWInfo->pParse;
  124405. Vdbe *v = pParse->pVdbe;
  124406. int i;
  124407. WhereLevel *pLevel;
  124408. WhereLoop *pLoop;
  124409. SrcList *pTabList = pWInfo->pTabList;
  124410. sqlite3 *db = pParse->db;
  124411. /* Generate loop termination code.
  124412. */
  124413. VdbeModuleComment((v, "End WHERE-core"));
  124414. sqlite3ExprCacheClear(pParse);
  124415. for(i=pWInfo->nLevel-1; i>=0; i--){
  124416. int addr;
  124417. pLevel = &pWInfo->a[i];
  124418. pLoop = pLevel->pWLoop;
  124419. sqlite3VdbeResolveLabel(v, pLevel->addrCont);
  124420. if( pLevel->op!=OP_Noop ){
  124421. sqlite3VdbeAddOp3(v, pLevel->op, pLevel->p1, pLevel->p2, pLevel->p3);
  124422. sqlite3VdbeChangeP5(v, pLevel->p5);
  124423. VdbeCoverage(v);
  124424. VdbeCoverageIf(v, pLevel->op==OP_Next);
  124425. VdbeCoverageIf(v, pLevel->op==OP_Prev);
  124426. VdbeCoverageIf(v, pLevel->op==OP_VNext);
  124427. }
  124428. if( pLoop->wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
  124429. struct InLoop *pIn;
  124430. int j;
  124431. sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
  124432. for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
  124433. sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
  124434. if( pIn->eEndLoopOp!=OP_Noop ){
  124435. sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
  124436. VdbeCoverage(v);
  124437. VdbeCoverageIf(v, pIn->eEndLoopOp==OP_PrevIfOpen);
  124438. VdbeCoverageIf(v, pIn->eEndLoopOp==OP_NextIfOpen);
  124439. }
  124440. sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
  124441. }
  124442. }
  124443. sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
  124444. if( pLevel->addrSkip ){
  124445. sqlite3VdbeGoto(v, pLevel->addrSkip);
  124446. VdbeComment((v, "next skip-scan on %s", pLoop->u.btree.pIndex->zName));
  124447. sqlite3VdbeJumpHere(v, pLevel->addrSkip);
  124448. sqlite3VdbeJumpHere(v, pLevel->addrSkip-2);
  124449. }
  124450. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  124451. if( pLevel->addrLikeRep ){
  124452. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, (int)(pLevel->iLikeRepCntr>>1),
  124453. pLevel->addrLikeRep);
  124454. VdbeCoverage(v);
  124455. }
  124456. #endif
  124457. if( pLevel->iLeftJoin ){
  124458. int ws = pLoop->wsFlags;
  124459. addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin); VdbeCoverage(v);
  124460. assert( (ws & WHERE_IDX_ONLY)==0 || (ws & WHERE_INDEXED)!=0 );
  124461. if( (ws & WHERE_IDX_ONLY)==0 ){
  124462. sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
  124463. }
  124464. if( (ws & WHERE_INDEXED)
  124465. || ((ws & WHERE_MULTI_OR) && pLevel->u.pCovidx)
  124466. ){
  124467. sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
  124468. }
  124469. if( pLevel->op==OP_Return ){
  124470. sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
  124471. }else{
  124472. sqlite3VdbeGoto(v, pLevel->addrFirst);
  124473. }
  124474. sqlite3VdbeJumpHere(v, addr);
  124475. }
  124476. VdbeModuleComment((v, "End WHERE-loop%d: %s", i,
  124477. pWInfo->pTabList->a[pLevel->iFrom].pTab->zName));
  124478. }
  124479. /* The "break" point is here, just past the end of the outer loop.
  124480. ** Set it.
  124481. */
  124482. sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
  124483. assert( pWInfo->nLevel<=pTabList->nSrc );
  124484. for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
  124485. int k, last;
  124486. VdbeOp *pOp;
  124487. Index *pIdx = 0;
  124488. struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
  124489. Table *pTab = pTabItem->pTab;
  124490. assert( pTab!=0 );
  124491. pLoop = pLevel->pWLoop;
  124492. /* For a co-routine, change all OP_Column references to the table of
  124493. ** the co-routine into OP_Copy of result contained in a register.
  124494. ** OP_Rowid becomes OP_Null.
  124495. */
  124496. if( pTabItem->fg.viaCoroutine && !db->mallocFailed ){
  124497. translateColumnToCopy(v, pLevel->addrBody, pLevel->iTabCur,
  124498. pTabItem->regResult, 0);
  124499. continue;
  124500. }
  124501. /* Close all of the cursors that were opened by sqlite3WhereBegin.
  124502. ** Except, do not close cursors that will be reused by the OR optimization
  124503. ** (WHERE_OR_SUBCLAUSE). And do not close the OP_OpenWrite cursors
  124504. ** created for the ONEPASS optimization.
  124505. */
  124506. if( (pTab->tabFlags & TF_Ephemeral)==0
  124507. && pTab->pSelect==0
  124508. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  124509. ){
  124510. int ws = pLoop->wsFlags;
  124511. if( pWInfo->eOnePass==ONEPASS_OFF && (ws & WHERE_IDX_ONLY)==0 ){
  124512. sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
  124513. }
  124514. if( (ws & WHERE_INDEXED)!=0
  124515. && (ws & (WHERE_IPK|WHERE_AUTO_INDEX))==0
  124516. && pLevel->iIdxCur!=pWInfo->aiCurOnePass[1]
  124517. ){
  124518. sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
  124519. }
  124520. }
  124521. /* If this scan uses an index, make VDBE code substitutions to read data
  124522. ** from the index instead of from the table where possible. In some cases
  124523. ** this optimization prevents the table from ever being read, which can
  124524. ** yield a significant performance boost.
  124525. **
  124526. ** Calls to the code generator in between sqlite3WhereBegin and
  124527. ** sqlite3WhereEnd will have created code that references the table
  124528. ** directly. This loop scans all that code looking for opcodes
  124529. ** that reference the table and converts them into opcodes that
  124530. ** reference the index.
  124531. */
  124532. if( pLoop->wsFlags & (WHERE_INDEXED|WHERE_IDX_ONLY) ){
  124533. pIdx = pLoop->u.btree.pIndex;
  124534. }else if( pLoop->wsFlags & WHERE_MULTI_OR ){
  124535. pIdx = pLevel->u.pCovidx;
  124536. }
  124537. if( pIdx
  124538. && (pWInfo->eOnePass==ONEPASS_OFF || !HasRowid(pIdx->pTable))
  124539. && !db->mallocFailed
  124540. ){
  124541. last = sqlite3VdbeCurrentAddr(v);
  124542. k = pLevel->addrBody;
  124543. pOp = sqlite3VdbeGetOp(v, k);
  124544. for(; k<last; k++, pOp++){
  124545. if( pOp->p1!=pLevel->iTabCur ) continue;
  124546. if( pOp->opcode==OP_Column ){
  124547. int x = pOp->p2;
  124548. assert( pIdx->pTable==pTab );
  124549. if( !HasRowid(pTab) ){
  124550. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  124551. x = pPk->aiColumn[x];
  124552. assert( x>=0 );
  124553. }
  124554. x = sqlite3ColumnOfIndex(pIdx, x);
  124555. if( x>=0 ){
  124556. pOp->p2 = x;
  124557. pOp->p1 = pLevel->iIdxCur;
  124558. }
  124559. assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 || x>=0 );
  124560. }else if( pOp->opcode==OP_Rowid ){
  124561. pOp->p1 = pLevel->iIdxCur;
  124562. pOp->opcode = OP_IdxRowid;
  124563. }
  124564. }
  124565. }
  124566. }
  124567. /* Final cleanup
  124568. */
  124569. pParse->nQueryLoop = pWInfo->savedNQueryLoop;
  124570. whereInfoFree(db, pWInfo);
  124571. return;
  124572. }
  124573. /************** End of where.c ***********************************************/
  124574. /************** Begin file parse.c *******************************************/
  124575. /*
  124576. ** 2000-05-29
  124577. **
  124578. ** The author disclaims copyright to this source code. In place of
  124579. ** a legal notice, here is a blessing:
  124580. **
  124581. ** May you do good and not evil.
  124582. ** May you find forgiveness for yourself and forgive others.
  124583. ** May you share freely, never taking more than you give.
  124584. **
  124585. *************************************************************************
  124586. ** Driver template for the LEMON parser generator.
  124587. **
  124588. ** The "lemon" program processes an LALR(1) input grammar file, then uses
  124589. ** this template to construct a parser. The "lemon" program inserts text
  124590. ** at each "%%" line. Also, any "P-a-r-s-e" identifer prefix (without the
  124591. ** interstitial "-" characters) contained in this template is changed into
  124592. ** the value of the %name directive from the grammar. Otherwise, the content
  124593. ** of this template is copied straight through into the generate parser
  124594. ** source file.
  124595. **
  124596. ** The following is the concatenation of all %include directives from the
  124597. ** input grammar file:
  124598. */
  124599. /* #include <stdio.h> */
  124600. /************ Begin %include sections from the grammar ************************/
  124601. /* #include "sqliteInt.h" */
  124602. /*
  124603. ** Disable all error recovery processing in the parser push-down
  124604. ** automaton.
  124605. */
  124606. #define YYNOERRORRECOVERY 1
  124607. /*
  124608. ** Make yytestcase() the same as testcase()
  124609. */
  124610. #define yytestcase(X) testcase(X)
  124611. /*
  124612. ** Indicate that sqlite3ParserFree() will never be called with a null
  124613. ** pointer.
  124614. */
  124615. #define YYPARSEFREENEVERNULL 1
  124616. /*
  124617. ** Alternative datatype for the argument to the malloc() routine passed
  124618. ** into sqlite3ParserAlloc(). The default is size_t.
  124619. */
  124620. #define YYMALLOCARGTYPE u64
  124621. /*
  124622. ** An instance of this structure holds information about the
  124623. ** LIMIT clause of a SELECT statement.
  124624. */
  124625. struct LimitVal {
  124626. Expr *pLimit; /* The LIMIT expression. NULL if there is no limit */
  124627. Expr *pOffset; /* The OFFSET expression. NULL if there is none */
  124628. };
  124629. /*
  124630. ** An instance of the following structure describes the event of a
  124631. ** TRIGGER. "a" is the event type, one of TK_UPDATE, TK_INSERT,
  124632. ** TK_DELETE, or TK_INSTEAD. If the event is of the form
  124633. **
  124634. ** UPDATE ON (a,b,c)
  124635. **
  124636. ** Then the "b" IdList records the list "a,b,c".
  124637. */
  124638. struct TrigEvent { int a; IdList * b; };
  124639. /*
  124640. ** Disable lookaside memory allocation for objects that might be
  124641. ** shared across database connections.
  124642. */
  124643. static void disableLookaside(Parse *pParse){
  124644. pParse->disableLookaside++;
  124645. pParse->db->lookaside.bDisable++;
  124646. }
  124647. /*
  124648. ** For a compound SELECT statement, make sure p->pPrior->pNext==p for
  124649. ** all elements in the list. And make sure list length does not exceed
  124650. ** SQLITE_LIMIT_COMPOUND_SELECT.
  124651. */
  124652. static void parserDoubleLinkSelect(Parse *pParse, Select *p){
  124653. if( p->pPrior ){
  124654. Select *pNext = 0, *pLoop;
  124655. int mxSelect, cnt = 0;
  124656. for(pLoop=p; pLoop; pNext=pLoop, pLoop=pLoop->pPrior, cnt++){
  124657. pLoop->pNext = pNext;
  124658. pLoop->selFlags |= SF_Compound;
  124659. }
  124660. if( (p->selFlags & SF_MultiValue)==0 &&
  124661. (mxSelect = pParse->db->aLimit[SQLITE_LIMIT_COMPOUND_SELECT])>0 &&
  124662. cnt>mxSelect
  124663. ){
  124664. sqlite3ErrorMsg(pParse, "too many terms in compound SELECT");
  124665. }
  124666. }
  124667. }
  124668. /* This is a utility routine used to set the ExprSpan.zStart and
  124669. ** ExprSpan.zEnd values of pOut so that the span covers the complete
  124670. ** range of text beginning with pStart and going to the end of pEnd.
  124671. */
  124672. static void spanSet(ExprSpan *pOut, Token *pStart, Token *pEnd){
  124673. pOut->zStart = pStart->z;
  124674. pOut->zEnd = &pEnd->z[pEnd->n];
  124675. }
  124676. /* Construct a new Expr object from a single identifier. Use the
  124677. ** new Expr to populate pOut. Set the span of pOut to be the identifier
  124678. ** that created the expression.
  124679. */
  124680. static void spanExpr(ExprSpan *pOut, Parse *pParse, int op, Token t){
  124681. Expr *p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr)+t.n+1);
  124682. if( p ){
  124683. memset(p, 0, sizeof(Expr));
  124684. p->op = (u8)op;
  124685. p->flags = EP_Leaf;
  124686. p->iAgg = -1;
  124687. p->u.zToken = (char*)&p[1];
  124688. memcpy(p->u.zToken, t.z, t.n);
  124689. p->u.zToken[t.n] = 0;
  124690. if( sqlite3Isquote(p->u.zToken[0]) ){
  124691. if( p->u.zToken[0]=='"' ) p->flags |= EP_DblQuoted;
  124692. sqlite3Dequote(p->u.zToken);
  124693. }
  124694. #if SQLITE_MAX_EXPR_DEPTH>0
  124695. p->nHeight = 1;
  124696. #endif
  124697. }
  124698. pOut->pExpr = p;
  124699. pOut->zStart = t.z;
  124700. pOut->zEnd = &t.z[t.n];
  124701. }
  124702. /* This routine constructs a binary expression node out of two ExprSpan
  124703. ** objects and uses the result to populate a new ExprSpan object.
  124704. */
  124705. static void spanBinaryExpr(
  124706. Parse *pParse, /* The parsing context. Errors accumulate here */
  124707. int op, /* The binary operation */
  124708. ExprSpan *pLeft, /* The left operand, and output */
  124709. ExprSpan *pRight /* The right operand */
  124710. ){
  124711. pLeft->pExpr = sqlite3PExpr(pParse, op, pLeft->pExpr, pRight->pExpr, 0);
  124712. pLeft->zEnd = pRight->zEnd;
  124713. }
  124714. /* If doNot is true, then add a TK_NOT Expr-node wrapper around the
  124715. ** outside of *ppExpr.
  124716. */
  124717. static void exprNot(Parse *pParse, int doNot, ExprSpan *pSpan){
  124718. if( doNot ){
  124719. pSpan->pExpr = sqlite3PExpr(pParse, TK_NOT, pSpan->pExpr, 0, 0);
  124720. }
  124721. }
  124722. /* Construct an expression node for a unary postfix operator
  124723. */
  124724. static void spanUnaryPostfix(
  124725. Parse *pParse, /* Parsing context to record errors */
  124726. int op, /* The operator */
  124727. ExprSpan *pOperand, /* The operand, and output */
  124728. Token *pPostOp /* The operand token for setting the span */
  124729. ){
  124730. pOperand->pExpr = sqlite3PExpr(pParse, op, pOperand->pExpr, 0, 0);
  124731. pOperand->zEnd = &pPostOp->z[pPostOp->n];
  124732. }
  124733. /* A routine to convert a binary TK_IS or TK_ISNOT expression into a
  124734. ** unary TK_ISNULL or TK_NOTNULL expression. */
  124735. static void binaryToUnaryIfNull(Parse *pParse, Expr *pY, Expr *pA, int op){
  124736. sqlite3 *db = pParse->db;
  124737. if( pA && pY && pY->op==TK_NULL ){
  124738. pA->op = (u8)op;
  124739. sqlite3ExprDelete(db, pA->pRight);
  124740. pA->pRight = 0;
  124741. }
  124742. }
  124743. /* Construct an expression node for a unary prefix operator
  124744. */
  124745. static void spanUnaryPrefix(
  124746. ExprSpan *pOut, /* Write the new expression node here */
  124747. Parse *pParse, /* Parsing context to record errors */
  124748. int op, /* The operator */
  124749. ExprSpan *pOperand, /* The operand */
  124750. Token *pPreOp /* The operand token for setting the span */
  124751. ){
  124752. pOut->zStart = pPreOp->z;
  124753. pOut->pExpr = sqlite3PExpr(pParse, op, pOperand->pExpr, 0, 0);
  124754. pOut->zEnd = pOperand->zEnd;
  124755. }
  124756. /* Add a single new term to an ExprList that is used to store a
  124757. ** list of identifiers. Report an error if the ID list contains
  124758. ** a COLLATE clause or an ASC or DESC keyword, except ignore the
  124759. ** error while parsing a legacy schema.
  124760. */
  124761. static ExprList *parserAddExprIdListTerm(
  124762. Parse *pParse,
  124763. ExprList *pPrior,
  124764. Token *pIdToken,
  124765. int hasCollate,
  124766. int sortOrder
  124767. ){
  124768. ExprList *p = sqlite3ExprListAppend(pParse, pPrior, 0);
  124769. if( (hasCollate || sortOrder!=SQLITE_SO_UNDEFINED)
  124770. && pParse->db->init.busy==0
  124771. ){
  124772. sqlite3ErrorMsg(pParse, "syntax error after column name \"%.*s\"",
  124773. pIdToken->n, pIdToken->z);
  124774. }
  124775. sqlite3ExprListSetName(pParse, p, pIdToken, 1);
  124776. return p;
  124777. }
  124778. /**************** End of %include directives **********************************/
  124779. /* These constants specify the various numeric values for terminal symbols
  124780. ** in a format understandable to "makeheaders". This section is blank unless
  124781. ** "lemon" is run with the "-m" command-line option.
  124782. ***************** Begin makeheaders token definitions *************************/
  124783. /**************** End makeheaders token definitions ***************************/
  124784. /* The next sections is a series of control #defines.
  124785. ** various aspects of the generated parser.
  124786. ** YYCODETYPE is the data type used to store the integer codes
  124787. ** that represent terminal and non-terminal symbols.
  124788. ** "unsigned char" is used if there are fewer than
  124789. ** 256 symbols. Larger types otherwise.
  124790. ** YYNOCODE is a number of type YYCODETYPE that is not used for
  124791. ** any terminal or nonterminal symbol.
  124792. ** YYFALLBACK If defined, this indicates that one or more tokens
  124793. ** (also known as: "terminal symbols") have fall-back
  124794. ** values which should be used if the original symbol
  124795. ** would not parse. This permits keywords to sometimes
  124796. ** be used as identifiers, for example.
  124797. ** YYACTIONTYPE is the data type used for "action codes" - numbers
  124798. ** that indicate what to do in response to the next
  124799. ** token.
  124800. ** sqlite3ParserTOKENTYPE is the data type used for minor type for terminal
  124801. ** symbols. Background: A "minor type" is a semantic
  124802. ** value associated with a terminal or non-terminal
  124803. ** symbols. For example, for an "ID" terminal symbol,
  124804. ** the minor type might be the name of the identifier.
  124805. ** Each non-terminal can have a different minor type.
  124806. ** Terminal symbols all have the same minor type, though.
  124807. ** This macros defines the minor type for terminal
  124808. ** symbols.
  124809. ** YYMINORTYPE is the data type used for all minor types.
  124810. ** This is typically a union of many types, one of
  124811. ** which is sqlite3ParserTOKENTYPE. The entry in the union
  124812. ** for terminal symbols is called "yy0".
  124813. ** YYSTACKDEPTH is the maximum depth of the parser's stack. If
  124814. ** zero the stack is dynamically sized using realloc()
  124815. ** sqlite3ParserARG_SDECL A static variable declaration for the %extra_argument
  124816. ** sqlite3ParserARG_PDECL A parameter declaration for the %extra_argument
  124817. ** sqlite3ParserARG_STORE Code to store %extra_argument into yypParser
  124818. ** sqlite3ParserARG_FETCH Code to extract %extra_argument from yypParser
  124819. ** YYERRORSYMBOL is the code number of the error symbol. If not
  124820. ** defined, then do no error processing.
  124821. ** YYNSTATE the combined number of states.
  124822. ** YYNRULE the number of rules in the grammar
  124823. ** YY_MAX_SHIFT Maximum value for shift actions
  124824. ** YY_MIN_SHIFTREDUCE Minimum value for shift-reduce actions
  124825. ** YY_MAX_SHIFTREDUCE Maximum value for shift-reduce actions
  124826. ** YY_MIN_REDUCE Maximum value for reduce actions
  124827. ** YY_ERROR_ACTION The yy_action[] code for syntax error
  124828. ** YY_ACCEPT_ACTION The yy_action[] code for accept
  124829. ** YY_NO_ACTION The yy_action[] code for no-op
  124830. */
  124831. #ifndef INTERFACE
  124832. # define INTERFACE 1
  124833. #endif
  124834. /************* Begin control #defines *****************************************/
  124835. #define YYCODETYPE unsigned char
  124836. #define YYNOCODE 252
  124837. #define YYACTIONTYPE unsigned short int
  124838. #define YYWILDCARD 96
  124839. #define sqlite3ParserTOKENTYPE Token
  124840. typedef union {
  124841. int yyinit;
  124842. sqlite3ParserTOKENTYPE yy0;
  124843. Expr* yy72;
  124844. TriggerStep* yy145;
  124845. ExprList* yy148;
  124846. SrcList* yy185;
  124847. ExprSpan yy190;
  124848. int yy194;
  124849. Select* yy243;
  124850. IdList* yy254;
  124851. With* yy285;
  124852. struct TrigEvent yy332;
  124853. struct LimitVal yy354;
  124854. struct {int value; int mask;} yy497;
  124855. } YYMINORTYPE;
  124856. #ifndef YYSTACKDEPTH
  124857. #define YYSTACKDEPTH 100
  124858. #endif
  124859. #define sqlite3ParserARG_SDECL Parse *pParse;
  124860. #define sqlite3ParserARG_PDECL ,Parse *pParse
  124861. #define sqlite3ParserARG_FETCH Parse *pParse = yypParser->pParse
  124862. #define sqlite3ParserARG_STORE yypParser->pParse = pParse
  124863. #define YYFALLBACK 1
  124864. #define YYNSTATE 456
  124865. #define YYNRULE 332
  124866. #define YY_MAX_SHIFT 455
  124867. #define YY_MIN_SHIFTREDUCE 668
  124868. #define YY_MAX_SHIFTREDUCE 999
  124869. #define YY_MIN_REDUCE 1000
  124870. #define YY_MAX_REDUCE 1331
  124871. #define YY_ERROR_ACTION 1332
  124872. #define YY_ACCEPT_ACTION 1333
  124873. #define YY_NO_ACTION 1334
  124874. /************* End control #defines *******************************************/
  124875. /* Define the yytestcase() macro to be a no-op if is not already defined
  124876. ** otherwise.
  124877. **
  124878. ** Applications can choose to define yytestcase() in the %include section
  124879. ** to a macro that can assist in verifying code coverage. For production
  124880. ** code the yytestcase() macro should be turned off. But it is useful
  124881. ** for testing.
  124882. */
  124883. #ifndef yytestcase
  124884. # define yytestcase(X)
  124885. #endif
  124886. /* Next are the tables used to determine what action to take based on the
  124887. ** current state and lookahead token. These tables are used to implement
  124888. ** functions that take a state number and lookahead value and return an
  124889. ** action integer.
  124890. **
  124891. ** Suppose the action integer is N. Then the action is determined as
  124892. ** follows
  124893. **
  124894. ** 0 <= N <= YY_MAX_SHIFT Shift N. That is, push the lookahead
  124895. ** token onto the stack and goto state N.
  124896. **
  124897. ** N between YY_MIN_SHIFTREDUCE Shift to an arbitrary state then
  124898. ** and YY_MAX_SHIFTREDUCE reduce by rule N-YY_MIN_SHIFTREDUCE.
  124899. **
  124900. ** N between YY_MIN_REDUCE Reduce by rule N-YY_MIN_REDUCE
  124901. ** and YY_MAX_REDUCE
  124902. **
  124903. ** N == YY_ERROR_ACTION A syntax error has occurred.
  124904. **
  124905. ** N == YY_ACCEPT_ACTION The parser accepts its input.
  124906. **
  124907. ** N == YY_NO_ACTION No such action. Denotes unused
  124908. ** slots in the yy_action[] table.
  124909. **
  124910. ** The action table is constructed as a single large table named yy_action[].
  124911. ** Given state S and lookahead X, the action is computed as either:
  124912. **
  124913. ** (A) N = yy_action[ yy_shift_ofst[S] + X ]
  124914. ** (B) N = yy_default[S]
  124915. **
  124916. ** The (A) formula is preferred. The B formula is used instead if:
  124917. ** (1) The yy_shift_ofst[S]+X value is out of range, or
  124918. ** (2) yy_lookahead[yy_shift_ofst[S]+X] is not equal to X, or
  124919. ** (3) yy_shift_ofst[S] equal YY_SHIFT_USE_DFLT.
  124920. ** (Implementation note: YY_SHIFT_USE_DFLT is chosen so that
  124921. ** YY_SHIFT_USE_DFLT+X will be out of range for all possible lookaheads X.
  124922. ** Hence only tests (1) and (2) need to be evaluated.)
  124923. **
  124924. ** The formulas above are for computing the action when the lookahead is
  124925. ** a terminal symbol. If the lookahead is a non-terminal (as occurs after
  124926. ** a reduce action) then the yy_reduce_ofst[] array is used in place of
  124927. ** the yy_shift_ofst[] array and YY_REDUCE_USE_DFLT is used in place of
  124928. ** YY_SHIFT_USE_DFLT.
  124929. **
  124930. ** The following are the tables generated in this section:
  124931. **
  124932. ** yy_action[] A single table containing all actions.
  124933. ** yy_lookahead[] A table containing the lookahead for each entry in
  124934. ** yy_action. Used to detect hash collisions.
  124935. ** yy_shift_ofst[] For each state, the offset into yy_action for
  124936. ** shifting terminals.
  124937. ** yy_reduce_ofst[] For each state, the offset into yy_action for
  124938. ** shifting non-terminals after a reduce.
  124939. ** yy_default[] Default action for each state.
  124940. **
  124941. *********** Begin parsing tables **********************************************/
  124942. #define YY_ACTTAB_COUNT (1567)
  124943. static const YYACTIONTYPE yy_action[] = {
  124944. /* 0 */ 325, 832, 351, 825, 5, 203, 203, 819, 99, 100,
  124945. /* 10 */ 90, 842, 842, 854, 857, 846, 846, 97, 97, 98,
  124946. /* 20 */ 98, 98, 98, 301, 96, 96, 96, 96, 95, 95,
  124947. /* 30 */ 94, 94, 94, 93, 351, 325, 977, 977, 824, 824,
  124948. /* 40 */ 826, 947, 354, 99, 100, 90, 842, 842, 854, 857,
  124949. /* 50 */ 846, 846, 97, 97, 98, 98, 98, 98, 338, 96,
  124950. /* 60 */ 96, 96, 96, 95, 95, 94, 94, 94, 93, 351,
  124951. /* 70 */ 95, 95, 94, 94, 94, 93, 351, 791, 977, 977,
  124952. /* 80 */ 325, 94, 94, 94, 93, 351, 792, 75, 99, 100,
  124953. /* 90 */ 90, 842, 842, 854, 857, 846, 846, 97, 97, 98,
  124954. /* 100 */ 98, 98, 98, 450, 96, 96, 96, 96, 95, 95,
  124955. /* 110 */ 94, 94, 94, 93, 351, 1333, 155, 155, 2, 325,
  124956. /* 120 */ 275, 146, 132, 52, 52, 93, 351, 99, 100, 90,
  124957. /* 130 */ 842, 842, 854, 857, 846, 846, 97, 97, 98, 98,
  124958. /* 140 */ 98, 98, 101, 96, 96, 96, 96, 95, 95, 94,
  124959. /* 150 */ 94, 94, 93, 351, 958, 958, 325, 268, 428, 413,
  124960. /* 160 */ 411, 61, 752, 752, 99, 100, 90, 842, 842, 854,
  124961. /* 170 */ 857, 846, 846, 97, 97, 98, 98, 98, 98, 60,
  124962. /* 180 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  124963. /* 190 */ 351, 325, 270, 329, 273, 277, 959, 960, 250, 99,
  124964. /* 200 */ 100, 90, 842, 842, 854, 857, 846, 846, 97, 97,
  124965. /* 210 */ 98, 98, 98, 98, 301, 96, 96, 96, 96, 95,
  124966. /* 220 */ 95, 94, 94, 94, 93, 351, 325, 938, 1326, 698,
  124967. /* 230 */ 706, 1326, 242, 412, 99, 100, 90, 842, 842, 854,
  124968. /* 240 */ 857, 846, 846, 97, 97, 98, 98, 98, 98, 347,
  124969. /* 250 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  124970. /* 260 */ 351, 325, 938, 1327, 384, 699, 1327, 381, 379, 99,
  124971. /* 270 */ 100, 90, 842, 842, 854, 857, 846, 846, 97, 97,
  124972. /* 280 */ 98, 98, 98, 98, 701, 96, 96, 96, 96, 95,
  124973. /* 290 */ 95, 94, 94, 94, 93, 351, 325, 92, 89, 178,
  124974. /* 300 */ 833, 936, 373, 700, 99, 100, 90, 842, 842, 854,
  124975. /* 310 */ 857, 846, 846, 97, 97, 98, 98, 98, 98, 375,
  124976. /* 320 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  124977. /* 330 */ 351, 325, 1276, 947, 354, 818, 936, 739, 739, 99,
  124978. /* 340 */ 100, 90, 842, 842, 854, 857, 846, 846, 97, 97,
  124979. /* 350 */ 98, 98, 98, 98, 230, 96, 96, 96, 96, 95,
  124980. /* 360 */ 95, 94, 94, 94, 93, 351, 325, 969, 227, 92,
  124981. /* 370 */ 89, 178, 373, 300, 99, 100, 90, 842, 842, 854,
  124982. /* 380 */ 857, 846, 846, 97, 97, 98, 98, 98, 98, 921,
  124983. /* 390 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  124984. /* 400 */ 351, 325, 449, 447, 447, 447, 147, 737, 737, 99,
  124985. /* 410 */ 100, 90, 842, 842, 854, 857, 846, 846, 97, 97,
  124986. /* 420 */ 98, 98, 98, 98, 296, 96, 96, 96, 96, 95,
  124987. /* 430 */ 95, 94, 94, 94, 93, 351, 325, 419, 231, 958,
  124988. /* 440 */ 958, 158, 25, 422, 99, 100, 90, 842, 842, 854,
  124989. /* 450 */ 857, 846, 846, 97, 97, 98, 98, 98, 98, 450,
  124990. /* 460 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  124991. /* 470 */ 351, 443, 224, 224, 420, 958, 958, 962, 325, 52,
  124992. /* 480 */ 52, 959, 960, 176, 415, 78, 99, 100, 90, 842,
  124993. /* 490 */ 842, 854, 857, 846, 846, 97, 97, 98, 98, 98,
  124994. /* 500 */ 98, 379, 96, 96, 96, 96, 95, 95, 94, 94,
  124995. /* 510 */ 94, 93, 351, 325, 428, 418, 298, 959, 960, 962,
  124996. /* 520 */ 81, 99, 88, 90, 842, 842, 854, 857, 846, 846,
  124997. /* 530 */ 97, 97, 98, 98, 98, 98, 717, 96, 96, 96,
  124998. /* 540 */ 96, 95, 95, 94, 94, 94, 93, 351, 325, 843,
  124999. /* 550 */ 843, 855, 858, 996, 318, 343, 379, 100, 90, 842,
  125000. /* 560 */ 842, 854, 857, 846, 846, 97, 97, 98, 98, 98,
  125001. /* 570 */ 98, 450, 96, 96, 96, 96, 95, 95, 94, 94,
  125002. /* 580 */ 94, 93, 351, 325, 350, 350, 350, 260, 377, 340,
  125003. /* 590 */ 929, 52, 52, 90, 842, 842, 854, 857, 846, 846,
  125004. /* 600 */ 97, 97, 98, 98, 98, 98, 361, 96, 96, 96,
  125005. /* 610 */ 96, 95, 95, 94, 94, 94, 93, 351, 86, 445,
  125006. /* 620 */ 847, 3, 1203, 361, 360, 378, 344, 813, 958, 958,
  125007. /* 630 */ 1300, 86, 445, 729, 3, 212, 169, 287, 405, 282,
  125008. /* 640 */ 404, 199, 232, 450, 300, 760, 83, 84, 280, 245,
  125009. /* 650 */ 262, 365, 251, 85, 352, 352, 92, 89, 178, 83,
  125010. /* 660 */ 84, 242, 412, 52, 52, 448, 85, 352, 352, 246,
  125011. /* 670 */ 959, 960, 194, 455, 670, 402, 399, 398, 448, 243,
  125012. /* 680 */ 221, 114, 434, 776, 361, 450, 397, 268, 747, 224,
  125013. /* 690 */ 224, 132, 132, 198, 832, 434, 452, 451, 428, 427,
  125014. /* 700 */ 819, 415, 734, 713, 132, 52, 52, 832, 268, 452,
  125015. /* 710 */ 451, 734, 194, 819, 363, 402, 399, 398, 450, 1271,
  125016. /* 720 */ 1271, 23, 958, 958, 86, 445, 397, 3, 228, 429,
  125017. /* 730 */ 895, 824, 824, 826, 827, 19, 203, 720, 52, 52,
  125018. /* 740 */ 428, 408, 439, 249, 824, 824, 826, 827, 19, 229,
  125019. /* 750 */ 403, 153, 83, 84, 761, 177, 241, 450, 721, 85,
  125020. /* 760 */ 352, 352, 120, 157, 959, 960, 58, 977, 409, 355,
  125021. /* 770 */ 330, 448, 268, 428, 430, 320, 790, 32, 32, 86,
  125022. /* 780 */ 445, 776, 3, 341, 98, 98, 98, 98, 434, 96,
  125023. /* 790 */ 96, 96, 96, 95, 95, 94, 94, 94, 93, 351,
  125024. /* 800 */ 832, 120, 452, 451, 813, 887, 819, 83, 84, 977,
  125025. /* 810 */ 813, 132, 410, 920, 85, 352, 352, 132, 407, 789,
  125026. /* 820 */ 958, 958, 92, 89, 178, 917, 448, 262, 370, 261,
  125027. /* 830 */ 82, 914, 80, 262, 370, 261, 776, 824, 824, 826,
  125028. /* 840 */ 827, 19, 934, 434, 96, 96, 96, 96, 95, 95,
  125029. /* 850 */ 94, 94, 94, 93, 351, 832, 74, 452, 451, 958,
  125030. /* 860 */ 958, 819, 959, 960, 120, 92, 89, 178, 945, 2,
  125031. /* 870 */ 918, 965, 268, 1, 976, 76, 445, 762, 3, 708,
  125032. /* 880 */ 901, 901, 387, 958, 958, 757, 919, 371, 740, 778,
  125033. /* 890 */ 756, 257, 824, 824, 826, 827, 19, 417, 741, 450,
  125034. /* 900 */ 24, 959, 960, 83, 84, 369, 958, 958, 177, 226,
  125035. /* 910 */ 85, 352, 352, 885, 315, 314, 313, 215, 311, 10,
  125036. /* 920 */ 10, 683, 448, 349, 348, 959, 960, 909, 777, 157,
  125037. /* 930 */ 120, 958, 958, 337, 776, 416, 711, 310, 450, 434,
  125038. /* 940 */ 450, 321, 450, 791, 103, 200, 175, 450, 959, 960,
  125039. /* 950 */ 908, 832, 792, 452, 451, 9, 9, 819, 10, 10,
  125040. /* 960 */ 52, 52, 51, 51, 180, 716, 248, 10, 10, 171,
  125041. /* 970 */ 170, 167, 339, 959, 960, 247, 984, 702, 702, 450,
  125042. /* 980 */ 715, 233, 686, 982, 889, 983, 182, 914, 824, 824,
  125043. /* 990 */ 826, 827, 19, 183, 256, 423, 132, 181, 394, 10,
  125044. /* 1000 */ 10, 889, 891, 749, 958, 958, 917, 268, 985, 198,
  125045. /* 1010 */ 985, 349, 348, 425, 415, 299, 817, 832, 326, 825,
  125046. /* 1020 */ 120, 332, 133, 819, 268, 98, 98, 98, 98, 91,
  125047. /* 1030 */ 96, 96, 96, 96, 95, 95, 94, 94, 94, 93,
  125048. /* 1040 */ 351, 157, 810, 371, 382, 359, 959, 960, 358, 268,
  125049. /* 1050 */ 450, 918, 368, 324, 824, 824, 826, 450, 709, 450,
  125050. /* 1060 */ 264, 380, 889, 450, 877, 746, 253, 919, 255, 433,
  125051. /* 1070 */ 36, 36, 234, 450, 234, 120, 269, 37, 37, 12,
  125052. /* 1080 */ 12, 334, 272, 27, 27, 450, 330, 118, 450, 162,
  125053. /* 1090 */ 742, 280, 450, 38, 38, 450, 985, 356, 985, 450,
  125054. /* 1100 */ 709, 1210, 450, 132, 450, 39, 39, 450, 40, 40,
  125055. /* 1110 */ 450, 362, 41, 41, 450, 42, 42, 450, 254, 28,
  125056. /* 1120 */ 28, 450, 29, 29, 31, 31, 450, 43, 43, 450,
  125057. /* 1130 */ 44, 44, 450, 714, 45, 45, 450, 11, 11, 767,
  125058. /* 1140 */ 450, 46, 46, 450, 268, 450, 105, 105, 450, 47,
  125059. /* 1150 */ 47, 450, 48, 48, 450, 237, 33, 33, 450, 172,
  125060. /* 1160 */ 49, 49, 450, 50, 50, 34, 34, 274, 122, 122,
  125061. /* 1170 */ 450, 123, 123, 450, 124, 124, 450, 898, 56, 56,
  125062. /* 1180 */ 450, 897, 35, 35, 450, 267, 450, 817, 450, 817,
  125063. /* 1190 */ 106, 106, 450, 53, 53, 385, 107, 107, 450, 817,
  125064. /* 1200 */ 108, 108, 817, 450, 104, 104, 121, 121, 119, 119,
  125065. /* 1210 */ 450, 117, 112, 112, 450, 276, 450, 225, 111, 111,
  125066. /* 1220 */ 450, 730, 450, 109, 109, 450, 673, 674, 675, 912,
  125067. /* 1230 */ 110, 110, 317, 998, 55, 55, 57, 57, 692, 331,
  125068. /* 1240 */ 54, 54, 26, 26, 696, 30, 30, 317, 937, 197,
  125069. /* 1250 */ 196, 195, 335, 281, 336, 446, 331, 745, 689, 436,
  125070. /* 1260 */ 440, 444, 120, 72, 386, 223, 175, 345, 757, 933,
  125071. /* 1270 */ 20, 286, 319, 756, 815, 372, 374, 202, 202, 202,
  125072. /* 1280 */ 263, 395, 285, 74, 208, 21, 696, 719, 718, 884,
  125073. /* 1290 */ 120, 120, 120, 120, 120, 754, 278, 828, 77, 74,
  125074. /* 1300 */ 726, 727, 785, 783, 880, 202, 999, 208, 894, 893,
  125075. /* 1310 */ 894, 893, 694, 816, 763, 116, 774, 1290, 431, 432,
  125076. /* 1320 */ 302, 999, 390, 303, 823, 697, 691, 680, 159, 289,
  125077. /* 1330 */ 679, 884, 681, 952, 291, 218, 293, 7, 316, 828,
  125078. /* 1340 */ 173, 805, 259, 364, 252, 911, 376, 713, 295, 435,
  125079. /* 1350 */ 308, 168, 955, 993, 135, 400, 990, 284, 882, 881,
  125080. /* 1360 */ 205, 928, 926, 59, 333, 62, 144, 156, 130, 72,
  125081. /* 1370 */ 802, 366, 367, 393, 137, 185, 189, 160, 139, 383,
  125082. /* 1380 */ 67, 896, 140, 141, 142, 148, 389, 812, 775, 266,
  125083. /* 1390 */ 219, 190, 154, 391, 913, 876, 271, 406, 191, 322,
  125084. /* 1400 */ 682, 733, 192, 342, 732, 724, 731, 711, 723, 421,
  125085. /* 1410 */ 705, 71, 323, 6, 204, 771, 288, 79, 297, 346,
  125086. /* 1420 */ 772, 704, 290, 283, 703, 770, 292, 294, 967, 239,
  125087. /* 1430 */ 769, 102, 862, 438, 426, 240, 424, 442, 73, 213,
  125088. /* 1440 */ 688, 238, 22, 453, 953, 214, 217, 216, 454, 677,
  125089. /* 1450 */ 676, 671, 753, 125, 115, 235, 126, 669, 353, 166,
  125090. /* 1460 */ 127, 244, 179, 357, 306, 304, 305, 307, 113, 892,
  125091. /* 1470 */ 327, 890, 811, 328, 134, 128, 136, 138, 743, 258,
  125092. /* 1480 */ 907, 184, 143, 129, 910, 186, 63, 64, 145, 187,
  125093. /* 1490 */ 906, 65, 8, 66, 13, 188, 202, 899, 265, 149,
  125094. /* 1500 */ 987, 388, 150, 685, 161, 392, 285, 193, 279, 396,
  125095. /* 1510 */ 151, 401, 68, 14, 15, 722, 69, 236, 831, 131,
  125096. /* 1520 */ 830, 860, 70, 751, 16, 414, 755, 4, 174, 220,
  125097. /* 1530 */ 222, 784, 201, 152, 779, 77, 74, 17, 18, 875,
  125098. /* 1540 */ 861, 859, 916, 864, 915, 207, 206, 942, 163, 437,
  125099. /* 1550 */ 948, 943, 164, 209, 1002, 441, 863, 165, 210, 829,
  125100. /* 1560 */ 695, 87, 312, 211, 1292, 1291, 309,
  125101. };
  125102. static const YYCODETYPE yy_lookahead[] = {
  125103. /* 0 */ 19, 95, 53, 97, 22, 24, 24, 101, 27, 28,
  125104. /* 10 */ 29, 30, 31, 32, 33, 34, 35, 36, 37, 38,
  125105. /* 20 */ 39, 40, 41, 152, 43, 44, 45, 46, 47, 48,
  125106. /* 30 */ 49, 50, 51, 52, 53, 19, 55, 55, 132, 133,
  125107. /* 40 */ 134, 1, 2, 27, 28, 29, 30, 31, 32, 33,
  125108. /* 50 */ 34, 35, 36, 37, 38, 39, 40, 41, 187, 43,
  125109. /* 60 */ 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  125110. /* 70 */ 47, 48, 49, 50, 51, 52, 53, 61, 97, 97,
  125111. /* 80 */ 19, 49, 50, 51, 52, 53, 70, 26, 27, 28,
  125112. /* 90 */ 29, 30, 31, 32, 33, 34, 35, 36, 37, 38,
  125113. /* 100 */ 39, 40, 41, 152, 43, 44, 45, 46, 47, 48,
  125114. /* 110 */ 49, 50, 51, 52, 53, 144, 145, 146, 147, 19,
  125115. /* 120 */ 16, 22, 92, 172, 173, 52, 53, 27, 28, 29,
  125116. /* 130 */ 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,
  125117. /* 140 */ 40, 41, 81, 43, 44, 45, 46, 47, 48, 49,
  125118. /* 150 */ 50, 51, 52, 53, 55, 56, 19, 152, 207, 208,
  125119. /* 160 */ 115, 24, 117, 118, 27, 28, 29, 30, 31, 32,
  125120. /* 170 */ 33, 34, 35, 36, 37, 38, 39, 40, 41, 79,
  125121. /* 180 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125122. /* 190 */ 53, 19, 88, 157, 90, 23, 97, 98, 193, 27,
  125123. /* 200 */ 28, 29, 30, 31, 32, 33, 34, 35, 36, 37,
  125124. /* 210 */ 38, 39, 40, 41, 152, 43, 44, 45, 46, 47,
  125125. /* 220 */ 48, 49, 50, 51, 52, 53, 19, 22, 23, 172,
  125126. /* 230 */ 23, 26, 119, 120, 27, 28, 29, 30, 31, 32,
  125127. /* 240 */ 33, 34, 35, 36, 37, 38, 39, 40, 41, 187,
  125128. /* 250 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125129. /* 260 */ 53, 19, 22, 23, 228, 23, 26, 231, 152, 27,
  125130. /* 270 */ 28, 29, 30, 31, 32, 33, 34, 35, 36, 37,
  125131. /* 280 */ 38, 39, 40, 41, 172, 43, 44, 45, 46, 47,
  125132. /* 290 */ 48, 49, 50, 51, 52, 53, 19, 221, 222, 223,
  125133. /* 300 */ 23, 96, 152, 172, 27, 28, 29, 30, 31, 32,
  125134. /* 310 */ 33, 34, 35, 36, 37, 38, 39, 40, 41, 152,
  125135. /* 320 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125136. /* 330 */ 53, 19, 0, 1, 2, 23, 96, 190, 191, 27,
  125137. /* 340 */ 28, 29, 30, 31, 32, 33, 34, 35, 36, 37,
  125138. /* 350 */ 38, 39, 40, 41, 238, 43, 44, 45, 46, 47,
  125139. /* 360 */ 48, 49, 50, 51, 52, 53, 19, 185, 218, 221,
  125140. /* 370 */ 222, 223, 152, 152, 27, 28, 29, 30, 31, 32,
  125141. /* 380 */ 33, 34, 35, 36, 37, 38, 39, 40, 41, 241,
  125142. /* 390 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125143. /* 400 */ 53, 19, 152, 168, 169, 170, 22, 190, 191, 27,
  125144. /* 410 */ 28, 29, 30, 31, 32, 33, 34, 35, 36, 37,
  125145. /* 420 */ 38, 39, 40, 41, 152, 43, 44, 45, 46, 47,
  125146. /* 430 */ 48, 49, 50, 51, 52, 53, 19, 19, 218, 55,
  125147. /* 440 */ 56, 24, 22, 152, 27, 28, 29, 30, 31, 32,
  125148. /* 450 */ 33, 34, 35, 36, 37, 38, 39, 40, 41, 152,
  125149. /* 460 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125150. /* 470 */ 53, 250, 194, 195, 56, 55, 56, 55, 19, 172,
  125151. /* 480 */ 173, 97, 98, 152, 206, 138, 27, 28, 29, 30,
  125152. /* 490 */ 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
  125153. /* 500 */ 41, 152, 43, 44, 45, 46, 47, 48, 49, 50,
  125154. /* 510 */ 51, 52, 53, 19, 207, 208, 152, 97, 98, 97,
  125155. /* 520 */ 138, 27, 28, 29, 30, 31, 32, 33, 34, 35,
  125156. /* 530 */ 36, 37, 38, 39, 40, 41, 181, 43, 44, 45,
  125157. /* 540 */ 46, 47, 48, 49, 50, 51, 52, 53, 19, 30,
  125158. /* 550 */ 31, 32, 33, 247, 248, 19, 152, 28, 29, 30,
  125159. /* 560 */ 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
  125160. /* 570 */ 41, 152, 43, 44, 45, 46, 47, 48, 49, 50,
  125161. /* 580 */ 51, 52, 53, 19, 168, 169, 170, 238, 19, 53,
  125162. /* 590 */ 152, 172, 173, 29, 30, 31, 32, 33, 34, 35,
  125163. /* 600 */ 36, 37, 38, 39, 40, 41, 152, 43, 44, 45,
  125164. /* 610 */ 46, 47, 48, 49, 50, 51, 52, 53, 19, 20,
  125165. /* 620 */ 101, 22, 23, 169, 170, 56, 207, 85, 55, 56,
  125166. /* 630 */ 23, 19, 20, 26, 22, 99, 100, 101, 102, 103,
  125167. /* 640 */ 104, 105, 238, 152, 152, 210, 47, 48, 112, 152,
  125168. /* 650 */ 108, 109, 110, 54, 55, 56, 221, 222, 223, 47,
  125169. /* 660 */ 48, 119, 120, 172, 173, 66, 54, 55, 56, 152,
  125170. /* 670 */ 97, 98, 99, 148, 149, 102, 103, 104, 66, 154,
  125171. /* 680 */ 23, 156, 83, 26, 230, 152, 113, 152, 163, 194,
  125172. /* 690 */ 195, 92, 92, 30, 95, 83, 97, 98, 207, 208,
  125173. /* 700 */ 101, 206, 179, 180, 92, 172, 173, 95, 152, 97,
  125174. /* 710 */ 98, 188, 99, 101, 219, 102, 103, 104, 152, 119,
  125175. /* 720 */ 120, 196, 55, 56, 19, 20, 113, 22, 193, 163,
  125176. /* 730 */ 11, 132, 133, 134, 135, 136, 24, 65, 172, 173,
  125177. /* 740 */ 207, 208, 250, 152, 132, 133, 134, 135, 136, 193,
  125178. /* 750 */ 78, 84, 47, 48, 49, 98, 199, 152, 86, 54,
  125179. /* 760 */ 55, 56, 196, 152, 97, 98, 209, 55, 163, 244,
  125180. /* 770 */ 107, 66, 152, 207, 208, 164, 175, 172, 173, 19,
  125181. /* 780 */ 20, 124, 22, 111, 38, 39, 40, 41, 83, 43,
  125182. /* 790 */ 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  125183. /* 800 */ 95, 196, 97, 98, 85, 152, 101, 47, 48, 97,
  125184. /* 810 */ 85, 92, 207, 193, 54, 55, 56, 92, 49, 175,
  125185. /* 820 */ 55, 56, 221, 222, 223, 12, 66, 108, 109, 110,
  125186. /* 830 */ 137, 163, 139, 108, 109, 110, 26, 132, 133, 134,
  125187. /* 840 */ 135, 136, 152, 83, 43, 44, 45, 46, 47, 48,
  125188. /* 850 */ 49, 50, 51, 52, 53, 95, 26, 97, 98, 55,
  125189. /* 860 */ 56, 101, 97, 98, 196, 221, 222, 223, 146, 147,
  125190. /* 870 */ 57, 171, 152, 22, 26, 19, 20, 49, 22, 179,
  125191. /* 880 */ 108, 109, 110, 55, 56, 116, 73, 219, 75, 124,
  125192. /* 890 */ 121, 152, 132, 133, 134, 135, 136, 163, 85, 152,
  125193. /* 900 */ 232, 97, 98, 47, 48, 237, 55, 56, 98, 5,
  125194. /* 910 */ 54, 55, 56, 193, 10, 11, 12, 13, 14, 172,
  125195. /* 920 */ 173, 17, 66, 47, 48, 97, 98, 152, 124, 152,
  125196. /* 930 */ 196, 55, 56, 186, 124, 152, 106, 160, 152, 83,
  125197. /* 940 */ 152, 164, 152, 61, 22, 211, 212, 152, 97, 98,
  125198. /* 950 */ 152, 95, 70, 97, 98, 172, 173, 101, 172, 173,
  125199. /* 960 */ 172, 173, 172, 173, 60, 181, 62, 172, 173, 47,
  125200. /* 970 */ 48, 123, 186, 97, 98, 71, 100, 55, 56, 152,
  125201. /* 980 */ 181, 186, 21, 107, 152, 109, 82, 163, 132, 133,
  125202. /* 990 */ 134, 135, 136, 89, 16, 207, 92, 93, 19, 172,
  125203. /* 1000 */ 173, 169, 170, 195, 55, 56, 12, 152, 132, 30,
  125204. /* 1010 */ 134, 47, 48, 186, 206, 225, 152, 95, 114, 97,
  125205. /* 1020 */ 196, 245, 246, 101, 152, 38, 39, 40, 41, 42,
  125206. /* 1030 */ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52,
  125207. /* 1040 */ 53, 152, 163, 219, 152, 141, 97, 98, 193, 152,
  125208. /* 1050 */ 152, 57, 91, 164, 132, 133, 134, 152, 55, 152,
  125209. /* 1060 */ 152, 237, 230, 152, 103, 193, 88, 73, 90, 75,
  125210. /* 1070 */ 172, 173, 183, 152, 185, 196, 152, 172, 173, 172,
  125211. /* 1080 */ 173, 217, 152, 172, 173, 152, 107, 22, 152, 24,
  125212. /* 1090 */ 193, 112, 152, 172, 173, 152, 132, 242, 134, 152,
  125213. /* 1100 */ 97, 140, 152, 92, 152, 172, 173, 152, 172, 173,
  125214. /* 1110 */ 152, 100, 172, 173, 152, 172, 173, 152, 140, 172,
  125215. /* 1120 */ 173, 152, 172, 173, 172, 173, 152, 172, 173, 152,
  125216. /* 1130 */ 172, 173, 152, 152, 172, 173, 152, 172, 173, 213,
  125217. /* 1140 */ 152, 172, 173, 152, 152, 152, 172, 173, 152, 172,
  125218. /* 1150 */ 173, 152, 172, 173, 152, 210, 172, 173, 152, 26,
  125219. /* 1160 */ 172, 173, 152, 172, 173, 172, 173, 152, 172, 173,
  125220. /* 1170 */ 152, 172, 173, 152, 172, 173, 152, 59, 172, 173,
  125221. /* 1180 */ 152, 63, 172, 173, 152, 193, 152, 152, 152, 152,
  125222. /* 1190 */ 172, 173, 152, 172, 173, 77, 172, 173, 152, 152,
  125223. /* 1200 */ 172, 173, 152, 152, 172, 173, 172, 173, 172, 173,
  125224. /* 1210 */ 152, 22, 172, 173, 152, 152, 152, 22, 172, 173,
  125225. /* 1220 */ 152, 152, 152, 172, 173, 152, 7, 8, 9, 163,
  125226. /* 1230 */ 172, 173, 22, 23, 172, 173, 172, 173, 166, 167,
  125227. /* 1240 */ 172, 173, 172, 173, 55, 172, 173, 22, 23, 108,
  125228. /* 1250 */ 109, 110, 217, 152, 217, 166, 167, 163, 163, 163,
  125229. /* 1260 */ 163, 163, 196, 130, 217, 211, 212, 217, 116, 23,
  125230. /* 1270 */ 22, 101, 26, 121, 23, 23, 23, 26, 26, 26,
  125231. /* 1280 */ 23, 23, 112, 26, 26, 37, 97, 100, 101, 55,
  125232. /* 1290 */ 196, 196, 196, 196, 196, 23, 23, 55, 26, 26,
  125233. /* 1300 */ 7, 8, 23, 152, 23, 26, 96, 26, 132, 132,
  125234. /* 1310 */ 134, 134, 23, 152, 152, 26, 152, 122, 152, 191,
  125235. /* 1320 */ 152, 96, 234, 152, 152, 152, 152, 152, 197, 210,
  125236. /* 1330 */ 152, 97, 152, 152, 210, 233, 210, 198, 150, 97,
  125237. /* 1340 */ 184, 201, 239, 214, 214, 201, 239, 180, 214, 227,
  125238. /* 1350 */ 200, 198, 155, 67, 243, 176, 69, 175, 175, 175,
  125239. /* 1360 */ 122, 159, 159, 240, 159, 240, 22, 220, 27, 130,
  125240. /* 1370 */ 201, 18, 159, 18, 189, 158, 158, 220, 192, 159,
  125241. /* 1380 */ 137, 236, 192, 192, 192, 189, 74, 189, 159, 235,
  125242. /* 1390 */ 159, 158, 22, 177, 201, 201, 159, 107, 158, 177,
  125243. /* 1400 */ 159, 174, 158, 76, 174, 182, 174, 106, 182, 125,
  125244. /* 1410 */ 174, 107, 177, 22, 159, 216, 215, 137, 159, 53,
  125245. /* 1420 */ 216, 176, 215, 174, 174, 216, 215, 215, 174, 229,
  125246. /* 1430 */ 216, 129, 224, 177, 126, 229, 127, 177, 128, 25,
  125247. /* 1440 */ 162, 226, 26, 161, 13, 153, 6, 153, 151, 151,
  125248. /* 1450 */ 151, 151, 205, 165, 178, 178, 165, 4, 3, 22,
  125249. /* 1460 */ 165, 142, 15, 94, 202, 204, 203, 201, 16, 23,
  125250. /* 1470 */ 249, 23, 120, 249, 246, 111, 131, 123, 20, 16,
  125251. /* 1480 */ 1, 125, 123, 111, 56, 64, 37, 37, 131, 122,
  125252. /* 1490 */ 1, 37, 5, 37, 22, 107, 26, 80, 140, 80,
  125253. /* 1500 */ 87, 72, 107, 20, 24, 19, 112, 105, 23, 79,
  125254. /* 1510 */ 22, 79, 22, 22, 22, 58, 22, 79, 23, 68,
  125255. /* 1520 */ 23, 23, 26, 116, 22, 26, 23, 22, 122, 23,
  125256. /* 1530 */ 23, 56, 64, 22, 124, 26, 26, 64, 64, 23,
  125257. /* 1540 */ 23, 23, 23, 11, 23, 22, 26, 23, 22, 24,
  125258. /* 1550 */ 1, 23, 22, 26, 251, 24, 23, 22, 122, 23,
  125259. /* 1560 */ 23, 22, 15, 122, 122, 122, 23,
  125260. };
  125261. #define YY_SHIFT_USE_DFLT (1567)
  125262. #define YY_SHIFT_COUNT (455)
  125263. #define YY_SHIFT_MIN (-94)
  125264. #define YY_SHIFT_MAX (1549)
  125265. static const short yy_shift_ofst[] = {
  125266. /* 0 */ 40, 599, 904, 612, 760, 760, 760, 760, 725, -19,
  125267. /* 10 */ 16, 16, 100, 760, 760, 760, 760, 760, 760, 760,
  125268. /* 20 */ 876, 876, 573, 542, 719, 600, 61, 137, 172, 207,
  125269. /* 30 */ 242, 277, 312, 347, 382, 417, 459, 459, 459, 459,
  125270. /* 40 */ 459, 459, 459, 459, 459, 459, 459, 459, 459, 459,
  125271. /* 50 */ 459, 459, 459, 494, 459, 529, 564, 564, 705, 760,
  125272. /* 60 */ 760, 760, 760, 760, 760, 760, 760, 760, 760, 760,
  125273. /* 70 */ 760, 760, 760, 760, 760, 760, 760, 760, 760, 760,
  125274. /* 80 */ 760, 760, 760, 760, 760, 760, 760, 760, 760, 760,
  125275. /* 90 */ 856, 760, 760, 760, 760, 760, 760, 760, 760, 760,
  125276. /* 100 */ 760, 760, 760, 760, 987, 746, 746, 746, 746, 746,
  125277. /* 110 */ 801, 23, 32, 949, 961, 979, 964, 964, 949, 73,
  125278. /* 120 */ 113, -51, 1567, 1567, 1567, 536, 536, 536, 99, 99,
  125279. /* 130 */ 813, 813, 667, 205, 240, 949, 949, 949, 949, 949,
  125280. /* 140 */ 949, 949, 949, 949, 949, 949, 949, 949, 949, 949,
  125281. /* 150 */ 949, 949, 949, 949, 949, 332, 1011, 422, 422, 113,
  125282. /* 160 */ 30, 30, 30, 30, 30, 30, 1567, 1567, 1567, 922,
  125283. /* 170 */ -94, -94, 384, 613, 828, 420, 765, 804, 851, 949,
  125284. /* 180 */ 949, 949, 949, 949, 949, 949, 949, 949, 949, 949,
  125285. /* 190 */ 949, 949, 949, 949, 949, 672, 672, 672, 949, 949,
  125286. /* 200 */ 657, 949, 949, 949, -18, 949, 949, 994, 949, 949,
  125287. /* 210 */ 949, 949, 949, 949, 949, 949, 949, 949, 772, 1118,
  125288. /* 220 */ 712, 712, 712, 810, 45, 769, 1219, 1133, 418, 418,
  125289. /* 230 */ 569, 1133, 569, 830, 607, 663, 882, 418, 693, 882,
  125290. /* 240 */ 882, 848, 1152, 1065, 1286, 1238, 1238, 1287, 1287, 1238,
  125291. /* 250 */ 1344, 1341, 1239, 1353, 1353, 1353, 1353, 1238, 1355, 1239,
  125292. /* 260 */ 1344, 1341, 1341, 1239, 1238, 1355, 1243, 1312, 1238, 1238,
  125293. /* 270 */ 1355, 1370, 1238, 1355, 1238, 1355, 1370, 1290, 1290, 1290,
  125294. /* 280 */ 1327, 1370, 1290, 1301, 1290, 1327, 1290, 1290, 1284, 1304,
  125295. /* 290 */ 1284, 1304, 1284, 1304, 1284, 1304, 1238, 1391, 1238, 1280,
  125296. /* 300 */ 1370, 1366, 1366, 1370, 1302, 1308, 1310, 1309, 1239, 1414,
  125297. /* 310 */ 1416, 1431, 1431, 1440, 1440, 1440, 1440, 1567, 1567, 1567,
  125298. /* 320 */ 1567, 1567, 1567, 1567, 1567, 519, 978, 1210, 1225, 104,
  125299. /* 330 */ 1141, 1189, 1246, 1248, 1251, 1252, 1253, 1257, 1258, 1273,
  125300. /* 340 */ 1003, 1187, 1293, 1170, 1272, 1279, 1234, 1281, 1176, 1177,
  125301. /* 350 */ 1289, 1242, 1195, 1453, 1455, 1437, 1319, 1447, 1369, 1452,
  125302. /* 360 */ 1446, 1448, 1352, 1345, 1364, 1354, 1458, 1356, 1463, 1479,
  125303. /* 370 */ 1359, 1357, 1449, 1450, 1454, 1456, 1372, 1428, 1421, 1367,
  125304. /* 380 */ 1489, 1487, 1472, 1388, 1358, 1417, 1470, 1419, 1413, 1429,
  125305. /* 390 */ 1395, 1480, 1483, 1486, 1394, 1402, 1488, 1430, 1490, 1491,
  125306. /* 400 */ 1485, 1492, 1432, 1457, 1494, 1438, 1451, 1495, 1497, 1498,
  125307. /* 410 */ 1496, 1407, 1502, 1503, 1505, 1499, 1406, 1506, 1507, 1475,
  125308. /* 420 */ 1468, 1511, 1410, 1509, 1473, 1510, 1474, 1516, 1509, 1517,
  125309. /* 430 */ 1518, 1519, 1520, 1521, 1523, 1532, 1524, 1526, 1525, 1527,
  125310. /* 440 */ 1528, 1530, 1531, 1527, 1533, 1535, 1536, 1537, 1539, 1436,
  125311. /* 450 */ 1441, 1442, 1443, 1543, 1547, 1549,
  125312. };
  125313. #define YY_REDUCE_USE_DFLT (-130)
  125314. #define YY_REDUCE_COUNT (324)
  125315. #define YY_REDUCE_MIN (-129)
  125316. #define YY_REDUCE_MAX (1300)
  125317. static const short yy_reduce_ofst[] = {
  125318. /* 0 */ -29, 566, 525, 605, -49, 307, 491, 533, 668, 435,
  125319. /* 10 */ 601, 644, 148, 747, 786, 795, 419, 788, 827, 790,
  125320. /* 20 */ 454, 832, 889, 495, 824, 734, 76, 76, 76, 76,
  125321. /* 30 */ 76, 76, 76, 76, 76, 76, 76, 76, 76, 76,
  125322. /* 40 */ 76, 76, 76, 76, 76, 76, 76, 76, 76, 76,
  125323. /* 50 */ 76, 76, 76, 76, 76, 76, 76, 76, 783, 898,
  125324. /* 60 */ 905, 907, 911, 921, 933, 936, 940, 943, 947, 950,
  125325. /* 70 */ 952, 955, 958, 962, 965, 969, 974, 977, 980, 984,
  125326. /* 80 */ 988, 991, 993, 996, 999, 1002, 1006, 1010, 1018, 1021,
  125327. /* 90 */ 1024, 1028, 1032, 1034, 1036, 1040, 1046, 1051, 1058, 1062,
  125328. /* 100 */ 1064, 1068, 1070, 1073, 76, 76, 76, 76, 76, 76,
  125329. /* 110 */ 76, 76, 76, 855, 36, 523, 235, 416, 777, 76,
  125330. /* 120 */ 278, 76, 76, 76, 76, 700, 700, 700, 150, 220,
  125331. /* 130 */ 147, 217, 221, 306, 306, 611, 5, 535, 556, 620,
  125332. /* 140 */ 720, 872, 897, 116, 864, 349, 1035, 1037, 404, 1047,
  125333. /* 150 */ 992, -129, 1050, 492, 62, 722, 879, 1072, 1089, 808,
  125334. /* 160 */ 1066, 1094, 1095, 1096, 1097, 1098, 776, 1054, 557, 57,
  125335. /* 170 */ 112, 131, 167, 182, 250, 272, 291, 331, 364, 438,
  125336. /* 180 */ 497, 517, 591, 653, 690, 739, 775, 798, 892, 908,
  125337. /* 190 */ 924, 930, 1015, 1063, 1069, 355, 784, 799, 981, 1101,
  125338. /* 200 */ 926, 1151, 1161, 1162, 945, 1164, 1166, 1128, 1168, 1171,
  125339. /* 210 */ 1172, 250, 1173, 1174, 1175, 1178, 1180, 1181, 1088, 1102,
  125340. /* 220 */ 1119, 1124, 1126, 926, 1131, 1139, 1188, 1140, 1129, 1130,
  125341. /* 230 */ 1103, 1144, 1107, 1179, 1156, 1167, 1182, 1134, 1122, 1183,
  125342. /* 240 */ 1184, 1150, 1153, 1197, 1111, 1202, 1203, 1123, 1125, 1205,
  125343. /* 250 */ 1147, 1185, 1169, 1186, 1190, 1191, 1192, 1213, 1217, 1193,
  125344. /* 260 */ 1157, 1196, 1198, 1194, 1220, 1218, 1145, 1154, 1229, 1231,
  125345. /* 270 */ 1233, 1216, 1237, 1240, 1241, 1244, 1222, 1227, 1230, 1232,
  125346. /* 280 */ 1223, 1235, 1236, 1245, 1249, 1226, 1250, 1254, 1199, 1201,
  125347. /* 290 */ 1204, 1207, 1209, 1211, 1214, 1212, 1255, 1208, 1259, 1215,
  125348. /* 300 */ 1256, 1200, 1206, 1260, 1247, 1261, 1263, 1262, 1266, 1278,
  125349. /* 310 */ 1282, 1292, 1294, 1297, 1298, 1299, 1300, 1221, 1224, 1228,
  125350. /* 320 */ 1288, 1291, 1276, 1277, 1295,
  125351. };
  125352. static const YYACTIONTYPE yy_default[] = {
  125353. /* 0 */ 1281, 1271, 1271, 1271, 1203, 1203, 1203, 1203, 1271, 1096,
  125354. /* 10 */ 1125, 1125, 1255, 1332, 1332, 1332, 1332, 1332, 1332, 1202,
  125355. /* 20 */ 1332, 1332, 1332, 1332, 1271, 1100, 1131, 1332, 1332, 1332,
  125356. /* 30 */ 1332, 1204, 1205, 1332, 1332, 1332, 1254, 1256, 1141, 1140,
  125357. /* 40 */ 1139, 1138, 1237, 1112, 1136, 1129, 1133, 1204, 1198, 1199,
  125358. /* 50 */ 1197, 1201, 1205, 1332, 1132, 1167, 1182, 1166, 1332, 1332,
  125359. /* 60 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125360. /* 70 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125361. /* 80 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125362. /* 90 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125363. /* 100 */ 1332, 1332, 1332, 1332, 1176, 1181, 1188, 1180, 1177, 1169,
  125364. /* 110 */ 1168, 1170, 1171, 1332, 1019, 1067, 1332, 1332, 1332, 1172,
  125365. /* 120 */ 1332, 1173, 1185, 1184, 1183, 1262, 1289, 1288, 1332, 1332,
  125366. /* 130 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125367. /* 140 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125368. /* 150 */ 1332, 1332, 1332, 1332, 1332, 1281, 1271, 1025, 1025, 1332,
  125369. /* 160 */ 1271, 1271, 1271, 1271, 1271, 1271, 1267, 1100, 1091, 1332,
  125370. /* 170 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125371. /* 180 */ 1259, 1257, 1332, 1218, 1332, 1332, 1332, 1332, 1332, 1332,
  125372. /* 190 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125373. /* 200 */ 1332, 1332, 1332, 1332, 1096, 1332, 1332, 1332, 1332, 1332,
  125374. /* 210 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1283, 1332, 1232,
  125375. /* 220 */ 1096, 1096, 1096, 1098, 1080, 1090, 1004, 1135, 1114, 1114,
  125376. /* 230 */ 1321, 1135, 1321, 1042, 1303, 1039, 1125, 1114, 1200, 1125,
  125377. /* 240 */ 1125, 1097, 1090, 1332, 1324, 1105, 1105, 1323, 1323, 1105,
  125378. /* 250 */ 1146, 1070, 1135, 1076, 1076, 1076, 1076, 1105, 1016, 1135,
  125379. /* 260 */ 1146, 1070, 1070, 1135, 1105, 1016, 1236, 1318, 1105, 1105,
  125380. /* 270 */ 1016, 1211, 1105, 1016, 1105, 1016, 1211, 1068, 1068, 1068,
  125381. /* 280 */ 1057, 1211, 1068, 1042, 1068, 1057, 1068, 1068, 1118, 1113,
  125382. /* 290 */ 1118, 1113, 1118, 1113, 1118, 1113, 1105, 1206, 1105, 1332,
  125383. /* 300 */ 1211, 1215, 1215, 1211, 1130, 1119, 1128, 1126, 1135, 1022,
  125384. /* 310 */ 1060, 1286, 1286, 1282, 1282, 1282, 1282, 1329, 1329, 1267,
  125385. /* 320 */ 1298, 1298, 1044, 1044, 1298, 1332, 1332, 1332, 1332, 1332,
  125386. /* 330 */ 1332, 1293, 1332, 1220, 1332, 1332, 1332, 1332, 1332, 1332,
  125387. /* 340 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125388. /* 350 */ 1332, 1332, 1152, 1332, 1000, 1264, 1332, 1332, 1263, 1332,
  125389. /* 360 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125390. /* 370 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1320,
  125391. /* 380 */ 1332, 1332, 1332, 1332, 1332, 1332, 1235, 1234, 1332, 1332,
  125392. /* 390 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125393. /* 400 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332,
  125394. /* 410 */ 1332, 1082, 1332, 1332, 1332, 1307, 1332, 1332, 1332, 1332,
  125395. /* 420 */ 1332, 1332, 1332, 1127, 1332, 1120, 1332, 1332, 1311, 1332,
  125396. /* 430 */ 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1332, 1273,
  125397. /* 440 */ 1332, 1332, 1332, 1272, 1332, 1332, 1332, 1332, 1332, 1154,
  125398. /* 450 */ 1332, 1153, 1157, 1332, 1010, 1332,
  125399. };
  125400. /********** End of lemon-generated parsing tables *****************************/
  125401. /* The next table maps tokens (terminal symbols) into fallback tokens.
  125402. ** If a construct like the following:
  125403. **
  125404. ** %fallback ID X Y Z.
  125405. **
  125406. ** appears in the grammar, then ID becomes a fallback token for X, Y,
  125407. ** and Z. Whenever one of the tokens X, Y, or Z is input to the parser
  125408. ** but it does not parse, the type of the token is changed to ID and
  125409. ** the parse is retried before an error is thrown.
  125410. **
  125411. ** This feature can be used, for example, to cause some keywords in a language
  125412. ** to revert to identifiers if they keyword does not apply in the context where
  125413. ** it appears.
  125414. */
  125415. #ifdef YYFALLBACK
  125416. static const YYCODETYPE yyFallback[] = {
  125417. 0, /* $ => nothing */
  125418. 0, /* SEMI => nothing */
  125419. 55, /* EXPLAIN => ID */
  125420. 55, /* QUERY => ID */
  125421. 55, /* PLAN => ID */
  125422. 55, /* BEGIN => ID */
  125423. 0, /* TRANSACTION => nothing */
  125424. 55, /* DEFERRED => ID */
  125425. 55, /* IMMEDIATE => ID */
  125426. 55, /* EXCLUSIVE => ID */
  125427. 0, /* COMMIT => nothing */
  125428. 55, /* END => ID */
  125429. 55, /* ROLLBACK => ID */
  125430. 55, /* SAVEPOINT => ID */
  125431. 55, /* RELEASE => ID */
  125432. 0, /* TO => nothing */
  125433. 0, /* TABLE => nothing */
  125434. 0, /* CREATE => nothing */
  125435. 55, /* IF => ID */
  125436. 0, /* NOT => nothing */
  125437. 0, /* EXISTS => nothing */
  125438. 55, /* TEMP => ID */
  125439. 0, /* LP => nothing */
  125440. 0, /* RP => nothing */
  125441. 0, /* AS => nothing */
  125442. 55, /* WITHOUT => ID */
  125443. 0, /* COMMA => nothing */
  125444. 0, /* OR => nothing */
  125445. 0, /* AND => nothing */
  125446. 0, /* IS => nothing */
  125447. 55, /* MATCH => ID */
  125448. 55, /* LIKE_KW => ID */
  125449. 0, /* BETWEEN => nothing */
  125450. 0, /* IN => nothing */
  125451. 0, /* ISNULL => nothing */
  125452. 0, /* NOTNULL => nothing */
  125453. 0, /* NE => nothing */
  125454. 0, /* EQ => nothing */
  125455. 0, /* GT => nothing */
  125456. 0, /* LE => nothing */
  125457. 0, /* LT => nothing */
  125458. 0, /* GE => nothing */
  125459. 0, /* ESCAPE => nothing */
  125460. 0, /* BITAND => nothing */
  125461. 0, /* BITOR => nothing */
  125462. 0, /* LSHIFT => nothing */
  125463. 0, /* RSHIFT => nothing */
  125464. 0, /* PLUS => nothing */
  125465. 0, /* MINUS => nothing */
  125466. 0, /* STAR => nothing */
  125467. 0, /* SLASH => nothing */
  125468. 0, /* REM => nothing */
  125469. 0, /* CONCAT => nothing */
  125470. 0, /* COLLATE => nothing */
  125471. 0, /* BITNOT => nothing */
  125472. 0, /* ID => nothing */
  125473. 0, /* INDEXED => nothing */
  125474. 55, /* ABORT => ID */
  125475. 55, /* ACTION => ID */
  125476. 55, /* AFTER => ID */
  125477. 55, /* ANALYZE => ID */
  125478. 55, /* ASC => ID */
  125479. 55, /* ATTACH => ID */
  125480. 55, /* BEFORE => ID */
  125481. 55, /* BY => ID */
  125482. 55, /* CASCADE => ID */
  125483. 55, /* CAST => ID */
  125484. 55, /* COLUMNKW => ID */
  125485. 55, /* CONFLICT => ID */
  125486. 55, /* DATABASE => ID */
  125487. 55, /* DESC => ID */
  125488. 55, /* DETACH => ID */
  125489. 55, /* EACH => ID */
  125490. 55, /* FAIL => ID */
  125491. 55, /* FOR => ID */
  125492. 55, /* IGNORE => ID */
  125493. 55, /* INITIALLY => ID */
  125494. 55, /* INSTEAD => ID */
  125495. 55, /* NO => ID */
  125496. 55, /* KEY => ID */
  125497. 55, /* OF => ID */
  125498. 55, /* OFFSET => ID */
  125499. 55, /* PRAGMA => ID */
  125500. 55, /* RAISE => ID */
  125501. 55, /* RECURSIVE => ID */
  125502. 55, /* REPLACE => ID */
  125503. 55, /* RESTRICT => ID */
  125504. 55, /* ROW => ID */
  125505. 55, /* TRIGGER => ID */
  125506. 55, /* VACUUM => ID */
  125507. 55, /* VIEW => ID */
  125508. 55, /* VIRTUAL => ID */
  125509. 55, /* WITH => ID */
  125510. 55, /* REINDEX => ID */
  125511. 55, /* RENAME => ID */
  125512. 55, /* CTIME_KW => ID */
  125513. };
  125514. #endif /* YYFALLBACK */
  125515. /* The following structure represents a single element of the
  125516. ** parser's stack. Information stored includes:
  125517. **
  125518. ** + The state number for the parser at this level of the stack.
  125519. **
  125520. ** + The value of the token stored at this level of the stack.
  125521. ** (In other words, the "major" token.)
  125522. **
  125523. ** + The semantic value stored at this level of the stack. This is
  125524. ** the information used by the action routines in the grammar.
  125525. ** It is sometimes called the "minor" token.
  125526. **
  125527. ** After the "shift" half of a SHIFTREDUCE action, the stateno field
  125528. ** actually contains the reduce action for the second half of the
  125529. ** SHIFTREDUCE.
  125530. */
  125531. struct yyStackEntry {
  125532. YYACTIONTYPE stateno; /* The state-number, or reduce action in SHIFTREDUCE */
  125533. YYCODETYPE major; /* The major token value. This is the code
  125534. ** number for the token at this stack level */
  125535. YYMINORTYPE minor; /* The user-supplied minor token value. This
  125536. ** is the value of the token */
  125537. };
  125538. typedef struct yyStackEntry yyStackEntry;
  125539. /* The state of the parser is completely contained in an instance of
  125540. ** the following structure */
  125541. struct yyParser {
  125542. yyStackEntry *yytos; /* Pointer to top element of the stack */
  125543. #ifdef YYTRACKMAXSTACKDEPTH
  125544. int yyhwm; /* High-water mark of the stack */
  125545. #endif
  125546. #ifndef YYNOERRORRECOVERY
  125547. int yyerrcnt; /* Shifts left before out of the error */
  125548. #endif
  125549. sqlite3ParserARG_SDECL /* A place to hold %extra_argument */
  125550. #if YYSTACKDEPTH<=0
  125551. int yystksz; /* Current side of the stack */
  125552. yyStackEntry *yystack; /* The parser's stack */
  125553. yyStackEntry yystk0; /* First stack entry */
  125554. #else
  125555. yyStackEntry yystack[YYSTACKDEPTH]; /* The parser's stack */
  125556. #endif
  125557. };
  125558. typedef struct yyParser yyParser;
  125559. #ifndef NDEBUG
  125560. /* #include <stdio.h> */
  125561. static FILE *yyTraceFILE = 0;
  125562. static char *yyTracePrompt = 0;
  125563. #endif /* NDEBUG */
  125564. #ifndef NDEBUG
  125565. /*
  125566. ** Turn parser tracing on by giving a stream to which to write the trace
  125567. ** and a prompt to preface each trace message. Tracing is turned off
  125568. ** by making either argument NULL
  125569. **
  125570. ** Inputs:
  125571. ** <ul>
  125572. ** <li> A FILE* to which trace output should be written.
  125573. ** If NULL, then tracing is turned off.
  125574. ** <li> A prefix string written at the beginning of every
  125575. ** line of trace output. If NULL, then tracing is
  125576. ** turned off.
  125577. ** </ul>
  125578. **
  125579. ** Outputs:
  125580. ** None.
  125581. */
  125582. SQLITE_PRIVATE void sqlite3ParserTrace(FILE *TraceFILE, char *zTracePrompt){
  125583. yyTraceFILE = TraceFILE;
  125584. yyTracePrompt = zTracePrompt;
  125585. if( yyTraceFILE==0 ) yyTracePrompt = 0;
  125586. else if( yyTracePrompt==0 ) yyTraceFILE = 0;
  125587. }
  125588. #endif /* NDEBUG */
  125589. #ifndef NDEBUG
  125590. /* For tracing shifts, the names of all terminals and nonterminals
  125591. ** are required. The following table supplies these names */
  125592. static const char *const yyTokenName[] = {
  125593. "$", "SEMI", "EXPLAIN", "QUERY",
  125594. "PLAN", "BEGIN", "TRANSACTION", "DEFERRED",
  125595. "IMMEDIATE", "EXCLUSIVE", "COMMIT", "END",
  125596. "ROLLBACK", "SAVEPOINT", "RELEASE", "TO",
  125597. "TABLE", "CREATE", "IF", "NOT",
  125598. "EXISTS", "TEMP", "LP", "RP",
  125599. "AS", "WITHOUT", "COMMA", "OR",
  125600. "AND", "IS", "MATCH", "LIKE_KW",
  125601. "BETWEEN", "IN", "ISNULL", "NOTNULL",
  125602. "NE", "EQ", "GT", "LE",
  125603. "LT", "GE", "ESCAPE", "BITAND",
  125604. "BITOR", "LSHIFT", "RSHIFT", "PLUS",
  125605. "MINUS", "STAR", "SLASH", "REM",
  125606. "CONCAT", "COLLATE", "BITNOT", "ID",
  125607. "INDEXED", "ABORT", "ACTION", "AFTER",
  125608. "ANALYZE", "ASC", "ATTACH", "BEFORE",
  125609. "BY", "CASCADE", "CAST", "COLUMNKW",
  125610. "CONFLICT", "DATABASE", "DESC", "DETACH",
  125611. "EACH", "FAIL", "FOR", "IGNORE",
  125612. "INITIALLY", "INSTEAD", "NO", "KEY",
  125613. "OF", "OFFSET", "PRAGMA", "RAISE",
  125614. "RECURSIVE", "REPLACE", "RESTRICT", "ROW",
  125615. "TRIGGER", "VACUUM", "VIEW", "VIRTUAL",
  125616. "WITH", "REINDEX", "RENAME", "CTIME_KW",
  125617. "ANY", "STRING", "JOIN_KW", "CONSTRAINT",
  125618. "DEFAULT", "NULL", "PRIMARY", "UNIQUE",
  125619. "CHECK", "REFERENCES", "AUTOINCR", "ON",
  125620. "INSERT", "DELETE", "UPDATE", "SET",
  125621. "DEFERRABLE", "FOREIGN", "DROP", "UNION",
  125622. "ALL", "EXCEPT", "INTERSECT", "SELECT",
  125623. "VALUES", "DISTINCT", "DOT", "FROM",
  125624. "JOIN", "USING", "ORDER", "GROUP",
  125625. "HAVING", "LIMIT", "WHERE", "INTO",
  125626. "FLOAT", "BLOB", "INTEGER", "VARIABLE",
  125627. "CASE", "WHEN", "THEN", "ELSE",
  125628. "INDEX", "ALTER", "ADD", "error",
  125629. "input", "cmdlist", "ecmd", "explain",
  125630. "cmdx", "cmd", "transtype", "trans_opt",
  125631. "nm", "savepoint_opt", "create_table", "create_table_args",
  125632. "createkw", "temp", "ifnotexists", "dbnm",
  125633. "columnlist", "conslist_opt", "table_options", "select",
  125634. "columnname", "carglist", "typetoken", "typename",
  125635. "signed", "plus_num", "minus_num", "ccons",
  125636. "term", "expr", "onconf", "sortorder",
  125637. "autoinc", "eidlist_opt", "refargs", "defer_subclause",
  125638. "refarg", "refact", "init_deferred_pred_opt", "conslist",
  125639. "tconscomma", "tcons", "sortlist", "eidlist",
  125640. "defer_subclause_opt", "orconf", "resolvetype", "raisetype",
  125641. "ifexists", "fullname", "selectnowith", "oneselect",
  125642. "with", "multiselect_op", "distinct", "selcollist",
  125643. "from", "where_opt", "groupby_opt", "having_opt",
  125644. "orderby_opt", "limit_opt", "values", "nexprlist",
  125645. "exprlist", "sclp", "as", "seltablist",
  125646. "stl_prefix", "joinop", "indexed_opt", "on_opt",
  125647. "using_opt", "idlist", "setlist", "insert_cmd",
  125648. "idlist_opt", "likeop", "between_op", "in_op",
  125649. "paren_exprlist", "case_operand", "case_exprlist", "case_else",
  125650. "uniqueflag", "collate", "nmnum", "trigger_decl",
  125651. "trigger_cmd_list", "trigger_time", "trigger_event", "foreach_clause",
  125652. "when_clause", "trigger_cmd", "trnm", "tridxby",
  125653. "database_kw_opt", "key_opt", "add_column_fullname", "kwcolumn_opt",
  125654. "create_vtab", "vtabarglist", "vtabarg", "vtabargtoken",
  125655. "lp", "anylist", "wqlist",
  125656. };
  125657. #endif /* NDEBUG */
  125658. #ifndef NDEBUG
  125659. /* For tracing reduce actions, the names of all rules are required.
  125660. */
  125661. static const char *const yyRuleName[] = {
  125662. /* 0 */ "explain ::= EXPLAIN",
  125663. /* 1 */ "explain ::= EXPLAIN QUERY PLAN",
  125664. /* 2 */ "cmdx ::= cmd",
  125665. /* 3 */ "cmd ::= BEGIN transtype trans_opt",
  125666. /* 4 */ "transtype ::=",
  125667. /* 5 */ "transtype ::= DEFERRED",
  125668. /* 6 */ "transtype ::= IMMEDIATE",
  125669. /* 7 */ "transtype ::= EXCLUSIVE",
  125670. /* 8 */ "cmd ::= COMMIT trans_opt",
  125671. /* 9 */ "cmd ::= END trans_opt",
  125672. /* 10 */ "cmd ::= ROLLBACK trans_opt",
  125673. /* 11 */ "cmd ::= SAVEPOINT nm",
  125674. /* 12 */ "cmd ::= RELEASE savepoint_opt nm",
  125675. /* 13 */ "cmd ::= ROLLBACK trans_opt TO savepoint_opt nm",
  125676. /* 14 */ "create_table ::= createkw temp TABLE ifnotexists nm dbnm",
  125677. /* 15 */ "createkw ::= CREATE",
  125678. /* 16 */ "ifnotexists ::=",
  125679. /* 17 */ "ifnotexists ::= IF NOT EXISTS",
  125680. /* 18 */ "temp ::= TEMP",
  125681. /* 19 */ "temp ::=",
  125682. /* 20 */ "create_table_args ::= LP columnlist conslist_opt RP table_options",
  125683. /* 21 */ "create_table_args ::= AS select",
  125684. /* 22 */ "table_options ::=",
  125685. /* 23 */ "table_options ::= WITHOUT nm",
  125686. /* 24 */ "columnname ::= nm typetoken",
  125687. /* 25 */ "typetoken ::=",
  125688. /* 26 */ "typetoken ::= typename LP signed RP",
  125689. /* 27 */ "typetoken ::= typename LP signed COMMA signed RP",
  125690. /* 28 */ "typename ::= typename ID|STRING",
  125691. /* 29 */ "ccons ::= CONSTRAINT nm",
  125692. /* 30 */ "ccons ::= DEFAULT term",
  125693. /* 31 */ "ccons ::= DEFAULT LP expr RP",
  125694. /* 32 */ "ccons ::= DEFAULT PLUS term",
  125695. /* 33 */ "ccons ::= DEFAULT MINUS term",
  125696. /* 34 */ "ccons ::= DEFAULT ID|INDEXED",
  125697. /* 35 */ "ccons ::= NOT NULL onconf",
  125698. /* 36 */ "ccons ::= PRIMARY KEY sortorder onconf autoinc",
  125699. /* 37 */ "ccons ::= UNIQUE onconf",
  125700. /* 38 */ "ccons ::= CHECK LP expr RP",
  125701. /* 39 */ "ccons ::= REFERENCES nm eidlist_opt refargs",
  125702. /* 40 */ "ccons ::= defer_subclause",
  125703. /* 41 */ "ccons ::= COLLATE ID|STRING",
  125704. /* 42 */ "autoinc ::=",
  125705. /* 43 */ "autoinc ::= AUTOINCR",
  125706. /* 44 */ "refargs ::=",
  125707. /* 45 */ "refargs ::= refargs refarg",
  125708. /* 46 */ "refarg ::= MATCH nm",
  125709. /* 47 */ "refarg ::= ON INSERT refact",
  125710. /* 48 */ "refarg ::= ON DELETE refact",
  125711. /* 49 */ "refarg ::= ON UPDATE refact",
  125712. /* 50 */ "refact ::= SET NULL",
  125713. /* 51 */ "refact ::= SET DEFAULT",
  125714. /* 52 */ "refact ::= CASCADE",
  125715. /* 53 */ "refact ::= RESTRICT",
  125716. /* 54 */ "refact ::= NO ACTION",
  125717. /* 55 */ "defer_subclause ::= NOT DEFERRABLE init_deferred_pred_opt",
  125718. /* 56 */ "defer_subclause ::= DEFERRABLE init_deferred_pred_opt",
  125719. /* 57 */ "init_deferred_pred_opt ::=",
  125720. /* 58 */ "init_deferred_pred_opt ::= INITIALLY DEFERRED",
  125721. /* 59 */ "init_deferred_pred_opt ::= INITIALLY IMMEDIATE",
  125722. /* 60 */ "conslist_opt ::=",
  125723. /* 61 */ "tconscomma ::= COMMA",
  125724. /* 62 */ "tcons ::= CONSTRAINT nm",
  125725. /* 63 */ "tcons ::= PRIMARY KEY LP sortlist autoinc RP onconf",
  125726. /* 64 */ "tcons ::= UNIQUE LP sortlist RP onconf",
  125727. /* 65 */ "tcons ::= CHECK LP expr RP onconf",
  125728. /* 66 */ "tcons ::= FOREIGN KEY LP eidlist RP REFERENCES nm eidlist_opt refargs defer_subclause_opt",
  125729. /* 67 */ "defer_subclause_opt ::=",
  125730. /* 68 */ "onconf ::=",
  125731. /* 69 */ "onconf ::= ON CONFLICT resolvetype",
  125732. /* 70 */ "orconf ::=",
  125733. /* 71 */ "orconf ::= OR resolvetype",
  125734. /* 72 */ "resolvetype ::= IGNORE",
  125735. /* 73 */ "resolvetype ::= REPLACE",
  125736. /* 74 */ "cmd ::= DROP TABLE ifexists fullname",
  125737. /* 75 */ "ifexists ::= IF EXISTS",
  125738. /* 76 */ "ifexists ::=",
  125739. /* 77 */ "cmd ::= createkw temp VIEW ifnotexists nm dbnm eidlist_opt AS select",
  125740. /* 78 */ "cmd ::= DROP VIEW ifexists fullname",
  125741. /* 79 */ "cmd ::= select",
  125742. /* 80 */ "select ::= with selectnowith",
  125743. /* 81 */ "selectnowith ::= selectnowith multiselect_op oneselect",
  125744. /* 82 */ "multiselect_op ::= UNION",
  125745. /* 83 */ "multiselect_op ::= UNION ALL",
  125746. /* 84 */ "multiselect_op ::= EXCEPT|INTERSECT",
  125747. /* 85 */ "oneselect ::= SELECT distinct selcollist from where_opt groupby_opt having_opt orderby_opt limit_opt",
  125748. /* 86 */ "values ::= VALUES LP nexprlist RP",
  125749. /* 87 */ "values ::= values COMMA LP exprlist RP",
  125750. /* 88 */ "distinct ::= DISTINCT",
  125751. /* 89 */ "distinct ::= ALL",
  125752. /* 90 */ "distinct ::=",
  125753. /* 91 */ "sclp ::=",
  125754. /* 92 */ "selcollist ::= sclp expr as",
  125755. /* 93 */ "selcollist ::= sclp STAR",
  125756. /* 94 */ "selcollist ::= sclp nm DOT STAR",
  125757. /* 95 */ "as ::= AS nm",
  125758. /* 96 */ "as ::=",
  125759. /* 97 */ "from ::=",
  125760. /* 98 */ "from ::= FROM seltablist",
  125761. /* 99 */ "stl_prefix ::= seltablist joinop",
  125762. /* 100 */ "stl_prefix ::=",
  125763. /* 101 */ "seltablist ::= stl_prefix nm dbnm as indexed_opt on_opt using_opt",
  125764. /* 102 */ "seltablist ::= stl_prefix nm dbnm LP exprlist RP as on_opt using_opt",
  125765. /* 103 */ "seltablist ::= stl_prefix LP select RP as on_opt using_opt",
  125766. /* 104 */ "seltablist ::= stl_prefix LP seltablist RP as on_opt using_opt",
  125767. /* 105 */ "dbnm ::=",
  125768. /* 106 */ "dbnm ::= DOT nm",
  125769. /* 107 */ "fullname ::= nm dbnm",
  125770. /* 108 */ "joinop ::= COMMA|JOIN",
  125771. /* 109 */ "joinop ::= JOIN_KW JOIN",
  125772. /* 110 */ "joinop ::= JOIN_KW nm JOIN",
  125773. /* 111 */ "joinop ::= JOIN_KW nm nm JOIN",
  125774. /* 112 */ "on_opt ::= ON expr",
  125775. /* 113 */ "on_opt ::=",
  125776. /* 114 */ "indexed_opt ::=",
  125777. /* 115 */ "indexed_opt ::= INDEXED BY nm",
  125778. /* 116 */ "indexed_opt ::= NOT INDEXED",
  125779. /* 117 */ "using_opt ::= USING LP idlist RP",
  125780. /* 118 */ "using_opt ::=",
  125781. /* 119 */ "orderby_opt ::=",
  125782. /* 120 */ "orderby_opt ::= ORDER BY sortlist",
  125783. /* 121 */ "sortlist ::= sortlist COMMA expr sortorder",
  125784. /* 122 */ "sortlist ::= expr sortorder",
  125785. /* 123 */ "sortorder ::= ASC",
  125786. /* 124 */ "sortorder ::= DESC",
  125787. /* 125 */ "sortorder ::=",
  125788. /* 126 */ "groupby_opt ::=",
  125789. /* 127 */ "groupby_opt ::= GROUP BY nexprlist",
  125790. /* 128 */ "having_opt ::=",
  125791. /* 129 */ "having_opt ::= HAVING expr",
  125792. /* 130 */ "limit_opt ::=",
  125793. /* 131 */ "limit_opt ::= LIMIT expr",
  125794. /* 132 */ "limit_opt ::= LIMIT expr OFFSET expr",
  125795. /* 133 */ "limit_opt ::= LIMIT expr COMMA expr",
  125796. /* 134 */ "cmd ::= with DELETE FROM fullname indexed_opt where_opt",
  125797. /* 135 */ "where_opt ::=",
  125798. /* 136 */ "where_opt ::= WHERE expr",
  125799. /* 137 */ "cmd ::= with UPDATE orconf fullname indexed_opt SET setlist where_opt",
  125800. /* 138 */ "setlist ::= setlist COMMA nm EQ expr",
  125801. /* 139 */ "setlist ::= setlist COMMA LP idlist RP EQ expr",
  125802. /* 140 */ "setlist ::= nm EQ expr",
  125803. /* 141 */ "setlist ::= LP idlist RP EQ expr",
  125804. /* 142 */ "cmd ::= with insert_cmd INTO fullname idlist_opt select",
  125805. /* 143 */ "cmd ::= with insert_cmd INTO fullname idlist_opt DEFAULT VALUES",
  125806. /* 144 */ "insert_cmd ::= INSERT orconf",
  125807. /* 145 */ "insert_cmd ::= REPLACE",
  125808. /* 146 */ "idlist_opt ::=",
  125809. /* 147 */ "idlist_opt ::= LP idlist RP",
  125810. /* 148 */ "idlist ::= idlist COMMA nm",
  125811. /* 149 */ "idlist ::= nm",
  125812. /* 150 */ "expr ::= LP expr RP",
  125813. /* 151 */ "term ::= NULL",
  125814. /* 152 */ "expr ::= ID|INDEXED",
  125815. /* 153 */ "expr ::= JOIN_KW",
  125816. /* 154 */ "expr ::= nm DOT nm",
  125817. /* 155 */ "expr ::= nm DOT nm DOT nm",
  125818. /* 156 */ "term ::= FLOAT|BLOB",
  125819. /* 157 */ "term ::= STRING",
  125820. /* 158 */ "term ::= INTEGER",
  125821. /* 159 */ "expr ::= VARIABLE",
  125822. /* 160 */ "expr ::= expr COLLATE ID|STRING",
  125823. /* 161 */ "expr ::= CAST LP expr AS typetoken RP",
  125824. /* 162 */ "expr ::= ID|INDEXED LP distinct exprlist RP",
  125825. /* 163 */ "expr ::= ID|INDEXED LP STAR RP",
  125826. /* 164 */ "term ::= CTIME_KW",
  125827. /* 165 */ "expr ::= LP nexprlist COMMA expr RP",
  125828. /* 166 */ "expr ::= expr AND expr",
  125829. /* 167 */ "expr ::= expr OR expr",
  125830. /* 168 */ "expr ::= expr LT|GT|GE|LE expr",
  125831. /* 169 */ "expr ::= expr EQ|NE expr",
  125832. /* 170 */ "expr ::= expr BITAND|BITOR|LSHIFT|RSHIFT expr",
  125833. /* 171 */ "expr ::= expr PLUS|MINUS expr",
  125834. /* 172 */ "expr ::= expr STAR|SLASH|REM expr",
  125835. /* 173 */ "expr ::= expr CONCAT expr",
  125836. /* 174 */ "likeop ::= LIKE_KW|MATCH",
  125837. /* 175 */ "likeop ::= NOT LIKE_KW|MATCH",
  125838. /* 176 */ "expr ::= expr likeop expr",
  125839. /* 177 */ "expr ::= expr likeop expr ESCAPE expr",
  125840. /* 178 */ "expr ::= expr ISNULL|NOTNULL",
  125841. /* 179 */ "expr ::= expr NOT NULL",
  125842. /* 180 */ "expr ::= expr IS expr",
  125843. /* 181 */ "expr ::= expr IS NOT expr",
  125844. /* 182 */ "expr ::= NOT expr",
  125845. /* 183 */ "expr ::= BITNOT expr",
  125846. /* 184 */ "expr ::= MINUS expr",
  125847. /* 185 */ "expr ::= PLUS expr",
  125848. /* 186 */ "between_op ::= BETWEEN",
  125849. /* 187 */ "between_op ::= NOT BETWEEN",
  125850. /* 188 */ "expr ::= expr between_op expr AND expr",
  125851. /* 189 */ "in_op ::= IN",
  125852. /* 190 */ "in_op ::= NOT IN",
  125853. /* 191 */ "expr ::= expr in_op LP exprlist RP",
  125854. /* 192 */ "expr ::= LP select RP",
  125855. /* 193 */ "expr ::= expr in_op LP select RP",
  125856. /* 194 */ "expr ::= expr in_op nm dbnm paren_exprlist",
  125857. /* 195 */ "expr ::= EXISTS LP select RP",
  125858. /* 196 */ "expr ::= CASE case_operand case_exprlist case_else END",
  125859. /* 197 */ "case_exprlist ::= case_exprlist WHEN expr THEN expr",
  125860. /* 198 */ "case_exprlist ::= WHEN expr THEN expr",
  125861. /* 199 */ "case_else ::= ELSE expr",
  125862. /* 200 */ "case_else ::=",
  125863. /* 201 */ "case_operand ::= expr",
  125864. /* 202 */ "case_operand ::=",
  125865. /* 203 */ "exprlist ::=",
  125866. /* 204 */ "nexprlist ::= nexprlist COMMA expr",
  125867. /* 205 */ "nexprlist ::= expr",
  125868. /* 206 */ "paren_exprlist ::=",
  125869. /* 207 */ "paren_exprlist ::= LP exprlist RP",
  125870. /* 208 */ "cmd ::= createkw uniqueflag INDEX ifnotexists nm dbnm ON nm LP sortlist RP where_opt",
  125871. /* 209 */ "uniqueflag ::= UNIQUE",
  125872. /* 210 */ "uniqueflag ::=",
  125873. /* 211 */ "eidlist_opt ::=",
  125874. /* 212 */ "eidlist_opt ::= LP eidlist RP",
  125875. /* 213 */ "eidlist ::= eidlist COMMA nm collate sortorder",
  125876. /* 214 */ "eidlist ::= nm collate sortorder",
  125877. /* 215 */ "collate ::=",
  125878. /* 216 */ "collate ::= COLLATE ID|STRING",
  125879. /* 217 */ "cmd ::= DROP INDEX ifexists fullname",
  125880. /* 218 */ "cmd ::= VACUUM",
  125881. /* 219 */ "cmd ::= VACUUM nm",
  125882. /* 220 */ "cmd ::= PRAGMA nm dbnm",
  125883. /* 221 */ "cmd ::= PRAGMA nm dbnm EQ nmnum",
  125884. /* 222 */ "cmd ::= PRAGMA nm dbnm LP nmnum RP",
  125885. /* 223 */ "cmd ::= PRAGMA nm dbnm EQ minus_num",
  125886. /* 224 */ "cmd ::= PRAGMA nm dbnm LP minus_num RP",
  125887. /* 225 */ "plus_num ::= PLUS INTEGER|FLOAT",
  125888. /* 226 */ "minus_num ::= MINUS INTEGER|FLOAT",
  125889. /* 227 */ "cmd ::= createkw trigger_decl BEGIN trigger_cmd_list END",
  125890. /* 228 */ "trigger_decl ::= temp TRIGGER ifnotexists nm dbnm trigger_time trigger_event ON fullname foreach_clause when_clause",
  125891. /* 229 */ "trigger_time ::= BEFORE",
  125892. /* 230 */ "trigger_time ::= AFTER",
  125893. /* 231 */ "trigger_time ::= INSTEAD OF",
  125894. /* 232 */ "trigger_time ::=",
  125895. /* 233 */ "trigger_event ::= DELETE|INSERT",
  125896. /* 234 */ "trigger_event ::= UPDATE",
  125897. /* 235 */ "trigger_event ::= UPDATE OF idlist",
  125898. /* 236 */ "when_clause ::=",
  125899. /* 237 */ "when_clause ::= WHEN expr",
  125900. /* 238 */ "trigger_cmd_list ::= trigger_cmd_list trigger_cmd SEMI",
  125901. /* 239 */ "trigger_cmd_list ::= trigger_cmd SEMI",
  125902. /* 240 */ "trnm ::= nm DOT nm",
  125903. /* 241 */ "tridxby ::= INDEXED BY nm",
  125904. /* 242 */ "tridxby ::= NOT INDEXED",
  125905. /* 243 */ "trigger_cmd ::= UPDATE orconf trnm tridxby SET setlist where_opt",
  125906. /* 244 */ "trigger_cmd ::= insert_cmd INTO trnm idlist_opt select",
  125907. /* 245 */ "trigger_cmd ::= DELETE FROM trnm tridxby where_opt",
  125908. /* 246 */ "trigger_cmd ::= select",
  125909. /* 247 */ "expr ::= RAISE LP IGNORE RP",
  125910. /* 248 */ "expr ::= RAISE LP raisetype COMMA nm RP",
  125911. /* 249 */ "raisetype ::= ROLLBACK",
  125912. /* 250 */ "raisetype ::= ABORT",
  125913. /* 251 */ "raisetype ::= FAIL",
  125914. /* 252 */ "cmd ::= DROP TRIGGER ifexists fullname",
  125915. /* 253 */ "cmd ::= ATTACH database_kw_opt expr AS expr key_opt",
  125916. /* 254 */ "cmd ::= DETACH database_kw_opt expr",
  125917. /* 255 */ "key_opt ::=",
  125918. /* 256 */ "key_opt ::= KEY expr",
  125919. /* 257 */ "cmd ::= REINDEX",
  125920. /* 258 */ "cmd ::= REINDEX nm dbnm",
  125921. /* 259 */ "cmd ::= ANALYZE",
  125922. /* 260 */ "cmd ::= ANALYZE nm dbnm",
  125923. /* 261 */ "cmd ::= ALTER TABLE fullname RENAME TO nm",
  125924. /* 262 */ "cmd ::= ALTER TABLE add_column_fullname ADD kwcolumn_opt columnname carglist",
  125925. /* 263 */ "add_column_fullname ::= fullname",
  125926. /* 264 */ "cmd ::= create_vtab",
  125927. /* 265 */ "cmd ::= create_vtab LP vtabarglist RP",
  125928. /* 266 */ "create_vtab ::= createkw VIRTUAL TABLE ifnotexists nm dbnm USING nm",
  125929. /* 267 */ "vtabarg ::=",
  125930. /* 268 */ "vtabargtoken ::= ANY",
  125931. /* 269 */ "vtabargtoken ::= lp anylist RP",
  125932. /* 270 */ "lp ::= LP",
  125933. /* 271 */ "with ::=",
  125934. /* 272 */ "with ::= WITH wqlist",
  125935. /* 273 */ "with ::= WITH RECURSIVE wqlist",
  125936. /* 274 */ "wqlist ::= nm eidlist_opt AS LP select RP",
  125937. /* 275 */ "wqlist ::= wqlist COMMA nm eidlist_opt AS LP select RP",
  125938. /* 276 */ "input ::= cmdlist",
  125939. /* 277 */ "cmdlist ::= cmdlist ecmd",
  125940. /* 278 */ "cmdlist ::= ecmd",
  125941. /* 279 */ "ecmd ::= SEMI",
  125942. /* 280 */ "ecmd ::= explain cmdx SEMI",
  125943. /* 281 */ "explain ::=",
  125944. /* 282 */ "trans_opt ::=",
  125945. /* 283 */ "trans_opt ::= TRANSACTION",
  125946. /* 284 */ "trans_opt ::= TRANSACTION nm",
  125947. /* 285 */ "savepoint_opt ::= SAVEPOINT",
  125948. /* 286 */ "savepoint_opt ::=",
  125949. /* 287 */ "cmd ::= create_table create_table_args",
  125950. /* 288 */ "columnlist ::= columnlist COMMA columnname carglist",
  125951. /* 289 */ "columnlist ::= columnname carglist",
  125952. /* 290 */ "nm ::= ID|INDEXED",
  125953. /* 291 */ "nm ::= STRING",
  125954. /* 292 */ "nm ::= JOIN_KW",
  125955. /* 293 */ "typetoken ::= typename",
  125956. /* 294 */ "typename ::= ID|STRING",
  125957. /* 295 */ "signed ::= plus_num",
  125958. /* 296 */ "signed ::= minus_num",
  125959. /* 297 */ "carglist ::= carglist ccons",
  125960. /* 298 */ "carglist ::=",
  125961. /* 299 */ "ccons ::= NULL onconf",
  125962. /* 300 */ "conslist_opt ::= COMMA conslist",
  125963. /* 301 */ "conslist ::= conslist tconscomma tcons",
  125964. /* 302 */ "conslist ::= tcons",
  125965. /* 303 */ "tconscomma ::=",
  125966. /* 304 */ "defer_subclause_opt ::= defer_subclause",
  125967. /* 305 */ "resolvetype ::= raisetype",
  125968. /* 306 */ "selectnowith ::= oneselect",
  125969. /* 307 */ "oneselect ::= values",
  125970. /* 308 */ "sclp ::= selcollist COMMA",
  125971. /* 309 */ "as ::= ID|STRING",
  125972. /* 310 */ "expr ::= term",
  125973. /* 311 */ "exprlist ::= nexprlist",
  125974. /* 312 */ "nmnum ::= plus_num",
  125975. /* 313 */ "nmnum ::= nm",
  125976. /* 314 */ "nmnum ::= ON",
  125977. /* 315 */ "nmnum ::= DELETE",
  125978. /* 316 */ "nmnum ::= DEFAULT",
  125979. /* 317 */ "plus_num ::= INTEGER|FLOAT",
  125980. /* 318 */ "foreach_clause ::=",
  125981. /* 319 */ "foreach_clause ::= FOR EACH ROW",
  125982. /* 320 */ "trnm ::= nm",
  125983. /* 321 */ "tridxby ::=",
  125984. /* 322 */ "database_kw_opt ::= DATABASE",
  125985. /* 323 */ "database_kw_opt ::=",
  125986. /* 324 */ "kwcolumn_opt ::=",
  125987. /* 325 */ "kwcolumn_opt ::= COLUMNKW",
  125988. /* 326 */ "vtabarglist ::= vtabarg",
  125989. /* 327 */ "vtabarglist ::= vtabarglist COMMA vtabarg",
  125990. /* 328 */ "vtabarg ::= vtabarg vtabargtoken",
  125991. /* 329 */ "anylist ::=",
  125992. /* 330 */ "anylist ::= anylist LP anylist RP",
  125993. /* 331 */ "anylist ::= anylist ANY",
  125994. };
  125995. #endif /* NDEBUG */
  125996. #if YYSTACKDEPTH<=0
  125997. /*
  125998. ** Try to increase the size of the parser stack. Return the number
  125999. ** of errors. Return 0 on success.
  126000. */
  126001. static int yyGrowStack(yyParser *p){
  126002. int newSize;
  126003. int idx;
  126004. yyStackEntry *pNew;
  126005. newSize = p->yystksz*2 + 100;
  126006. idx = p->yytos ? (int)(p->yytos - p->yystack) : 0;
  126007. if( p->yystack==&p->yystk0 ){
  126008. pNew = malloc(newSize*sizeof(pNew[0]));
  126009. if( pNew ) pNew[0] = p->yystk0;
  126010. }else{
  126011. pNew = realloc(p->yystack, newSize*sizeof(pNew[0]));
  126012. }
  126013. if( pNew ){
  126014. p->yystack = pNew;
  126015. p->yytos = &p->yystack[idx];
  126016. #ifndef NDEBUG
  126017. if( yyTraceFILE ){
  126018. fprintf(yyTraceFILE,"%sStack grows from %d to %d entries.\n",
  126019. yyTracePrompt, p->yystksz, newSize);
  126020. }
  126021. #endif
  126022. p->yystksz = newSize;
  126023. }
  126024. return pNew==0;
  126025. }
  126026. #endif
  126027. /* Datatype of the argument to the memory allocated passed as the
  126028. ** second argument to sqlite3ParserAlloc() below. This can be changed by
  126029. ** putting an appropriate #define in the %include section of the input
  126030. ** grammar.
  126031. */
  126032. #ifndef YYMALLOCARGTYPE
  126033. # define YYMALLOCARGTYPE size_t
  126034. #endif
  126035. /*
  126036. ** This function allocates a new parser.
  126037. ** The only argument is a pointer to a function which works like
  126038. ** malloc.
  126039. **
  126040. ** Inputs:
  126041. ** A pointer to the function used to allocate memory.
  126042. **
  126043. ** Outputs:
  126044. ** A pointer to a parser. This pointer is used in subsequent calls
  126045. ** to sqlite3Parser and sqlite3ParserFree.
  126046. */
  126047. SQLITE_PRIVATE void *sqlite3ParserAlloc(void *(*mallocProc)(YYMALLOCARGTYPE)){
  126048. yyParser *pParser;
  126049. pParser = (yyParser*)(*mallocProc)( (YYMALLOCARGTYPE)sizeof(yyParser) );
  126050. if( pParser ){
  126051. #ifdef YYTRACKMAXSTACKDEPTH
  126052. pParser->yyhwm = 0;
  126053. #endif
  126054. #if YYSTACKDEPTH<=0
  126055. pParser->yytos = NULL;
  126056. pParser->yystack = NULL;
  126057. pParser->yystksz = 0;
  126058. if( yyGrowStack(pParser) ){
  126059. pParser->yystack = &pParser->yystk0;
  126060. pParser->yystksz = 1;
  126061. }
  126062. #endif
  126063. #ifndef YYNOERRORRECOVERY
  126064. pParser->yyerrcnt = -1;
  126065. #endif
  126066. pParser->yytos = pParser->yystack;
  126067. pParser->yystack[0].stateno = 0;
  126068. pParser->yystack[0].major = 0;
  126069. }
  126070. return pParser;
  126071. }
  126072. /* The following function deletes the "minor type" or semantic value
  126073. ** associated with a symbol. The symbol can be either a terminal
  126074. ** or nonterminal. "yymajor" is the symbol code, and "yypminor" is
  126075. ** a pointer to the value to be deleted. The code used to do the
  126076. ** deletions is derived from the %destructor and/or %token_destructor
  126077. ** directives of the input grammar.
  126078. */
  126079. static void yy_destructor(
  126080. yyParser *yypParser, /* The parser */
  126081. YYCODETYPE yymajor, /* Type code for object to destroy */
  126082. YYMINORTYPE *yypminor /* The object to be destroyed */
  126083. ){
  126084. sqlite3ParserARG_FETCH;
  126085. switch( yymajor ){
  126086. /* Here is inserted the actions which take place when a
  126087. ** terminal or non-terminal is destroyed. This can happen
  126088. ** when the symbol is popped from the stack during a
  126089. ** reduce or during error processing or when a parser is
  126090. ** being destroyed before it is finished parsing.
  126091. **
  126092. ** Note: during a reduce, the only symbols destroyed are those
  126093. ** which appear on the RHS of the rule, but which are *not* used
  126094. ** inside the C code.
  126095. */
  126096. /********* Begin destructor definitions ***************************************/
  126097. case 163: /* select */
  126098. case 194: /* selectnowith */
  126099. case 195: /* oneselect */
  126100. case 206: /* values */
  126101. {
  126102. sqlite3SelectDelete(pParse->db, (yypminor->yy243));
  126103. }
  126104. break;
  126105. case 172: /* term */
  126106. case 173: /* expr */
  126107. {
  126108. sqlite3ExprDelete(pParse->db, (yypminor->yy190).pExpr);
  126109. }
  126110. break;
  126111. case 177: /* eidlist_opt */
  126112. case 186: /* sortlist */
  126113. case 187: /* eidlist */
  126114. case 199: /* selcollist */
  126115. case 202: /* groupby_opt */
  126116. case 204: /* orderby_opt */
  126117. case 207: /* nexprlist */
  126118. case 208: /* exprlist */
  126119. case 209: /* sclp */
  126120. case 218: /* setlist */
  126121. case 224: /* paren_exprlist */
  126122. case 226: /* case_exprlist */
  126123. {
  126124. sqlite3ExprListDelete(pParse->db, (yypminor->yy148));
  126125. }
  126126. break;
  126127. case 193: /* fullname */
  126128. case 200: /* from */
  126129. case 211: /* seltablist */
  126130. case 212: /* stl_prefix */
  126131. {
  126132. sqlite3SrcListDelete(pParse->db, (yypminor->yy185));
  126133. }
  126134. break;
  126135. case 196: /* with */
  126136. case 250: /* wqlist */
  126137. {
  126138. sqlite3WithDelete(pParse->db, (yypminor->yy285));
  126139. }
  126140. break;
  126141. case 201: /* where_opt */
  126142. case 203: /* having_opt */
  126143. case 215: /* on_opt */
  126144. case 225: /* case_operand */
  126145. case 227: /* case_else */
  126146. case 236: /* when_clause */
  126147. case 241: /* key_opt */
  126148. {
  126149. sqlite3ExprDelete(pParse->db, (yypminor->yy72));
  126150. }
  126151. break;
  126152. case 216: /* using_opt */
  126153. case 217: /* idlist */
  126154. case 220: /* idlist_opt */
  126155. {
  126156. sqlite3IdListDelete(pParse->db, (yypminor->yy254));
  126157. }
  126158. break;
  126159. case 232: /* trigger_cmd_list */
  126160. case 237: /* trigger_cmd */
  126161. {
  126162. sqlite3DeleteTriggerStep(pParse->db, (yypminor->yy145));
  126163. }
  126164. break;
  126165. case 234: /* trigger_event */
  126166. {
  126167. sqlite3IdListDelete(pParse->db, (yypminor->yy332).b);
  126168. }
  126169. break;
  126170. /********* End destructor definitions *****************************************/
  126171. default: break; /* If no destructor action specified: do nothing */
  126172. }
  126173. }
  126174. /*
  126175. ** Pop the parser's stack once.
  126176. **
  126177. ** If there is a destructor routine associated with the token which
  126178. ** is popped from the stack, then call it.
  126179. */
  126180. static void yy_pop_parser_stack(yyParser *pParser){
  126181. yyStackEntry *yytos;
  126182. assert( pParser->yytos!=0 );
  126183. assert( pParser->yytos > pParser->yystack );
  126184. yytos = pParser->yytos--;
  126185. #ifndef NDEBUG
  126186. if( yyTraceFILE ){
  126187. fprintf(yyTraceFILE,"%sPopping %s\n",
  126188. yyTracePrompt,
  126189. yyTokenName[yytos->major]);
  126190. }
  126191. #endif
  126192. yy_destructor(pParser, yytos->major, &yytos->minor);
  126193. }
  126194. /*
  126195. ** Deallocate and destroy a parser. Destructors are called for
  126196. ** all stack elements before shutting the parser down.
  126197. **
  126198. ** If the YYPARSEFREENEVERNULL macro exists (for example because it
  126199. ** is defined in a %include section of the input grammar) then it is
  126200. ** assumed that the input pointer is never NULL.
  126201. */
  126202. SQLITE_PRIVATE void sqlite3ParserFree(
  126203. void *p, /* The parser to be deleted */
  126204. void (*freeProc)(void*) /* Function used to reclaim memory */
  126205. ){
  126206. yyParser *pParser = (yyParser*)p;
  126207. #ifndef YYPARSEFREENEVERNULL
  126208. if( pParser==0 ) return;
  126209. #endif
  126210. while( pParser->yytos>pParser->yystack ) yy_pop_parser_stack(pParser);
  126211. #if YYSTACKDEPTH<=0
  126212. if( pParser->yystack!=&pParser->yystk0 ) free(pParser->yystack);
  126213. #endif
  126214. (*freeProc)((void*)pParser);
  126215. }
  126216. /*
  126217. ** Return the peak depth of the stack for a parser.
  126218. */
  126219. #ifdef YYTRACKMAXSTACKDEPTH
  126220. SQLITE_PRIVATE int sqlite3ParserStackPeak(void *p){
  126221. yyParser *pParser = (yyParser*)p;
  126222. return pParser->yyhwm;
  126223. }
  126224. #endif
  126225. /*
  126226. ** Find the appropriate action for a parser given the terminal
  126227. ** look-ahead token iLookAhead.
  126228. */
  126229. static unsigned int yy_find_shift_action(
  126230. yyParser *pParser, /* The parser */
  126231. YYCODETYPE iLookAhead /* The look-ahead token */
  126232. ){
  126233. int i;
  126234. int stateno = pParser->yytos->stateno;
  126235. if( stateno>=YY_MIN_REDUCE ) return stateno;
  126236. assert( stateno <= YY_SHIFT_COUNT );
  126237. do{
  126238. i = yy_shift_ofst[stateno];
  126239. assert( iLookAhead!=YYNOCODE );
  126240. i += iLookAhead;
  126241. if( i<0 || i>=YY_ACTTAB_COUNT || yy_lookahead[i]!=iLookAhead ){
  126242. #ifdef YYFALLBACK
  126243. YYCODETYPE iFallback; /* Fallback token */
  126244. if( iLookAhead<sizeof(yyFallback)/sizeof(yyFallback[0])
  126245. && (iFallback = yyFallback[iLookAhead])!=0 ){
  126246. #ifndef NDEBUG
  126247. if( yyTraceFILE ){
  126248. fprintf(yyTraceFILE, "%sFALLBACK %s => %s\n",
  126249. yyTracePrompt, yyTokenName[iLookAhead], yyTokenName[iFallback]);
  126250. }
  126251. #endif
  126252. assert( yyFallback[iFallback]==0 ); /* Fallback loop must terminate */
  126253. iLookAhead = iFallback;
  126254. continue;
  126255. }
  126256. #endif
  126257. #ifdef YYWILDCARD
  126258. {
  126259. int j = i - iLookAhead + YYWILDCARD;
  126260. if(
  126261. #if YY_SHIFT_MIN+YYWILDCARD<0
  126262. j>=0 &&
  126263. #endif
  126264. #if YY_SHIFT_MAX+YYWILDCARD>=YY_ACTTAB_COUNT
  126265. j<YY_ACTTAB_COUNT &&
  126266. #endif
  126267. yy_lookahead[j]==YYWILDCARD && iLookAhead>0
  126268. ){
  126269. #ifndef NDEBUG
  126270. if( yyTraceFILE ){
  126271. fprintf(yyTraceFILE, "%sWILDCARD %s => %s\n",
  126272. yyTracePrompt, yyTokenName[iLookAhead],
  126273. yyTokenName[YYWILDCARD]);
  126274. }
  126275. #endif /* NDEBUG */
  126276. return yy_action[j];
  126277. }
  126278. }
  126279. #endif /* YYWILDCARD */
  126280. return yy_default[stateno];
  126281. }else{
  126282. return yy_action[i];
  126283. }
  126284. }while(1);
  126285. }
  126286. /*
  126287. ** Find the appropriate action for a parser given the non-terminal
  126288. ** look-ahead token iLookAhead.
  126289. */
  126290. static int yy_find_reduce_action(
  126291. int stateno, /* Current state number */
  126292. YYCODETYPE iLookAhead /* The look-ahead token */
  126293. ){
  126294. int i;
  126295. #ifdef YYERRORSYMBOL
  126296. if( stateno>YY_REDUCE_COUNT ){
  126297. return yy_default[stateno];
  126298. }
  126299. #else
  126300. assert( stateno<=YY_REDUCE_COUNT );
  126301. #endif
  126302. i = yy_reduce_ofst[stateno];
  126303. assert( i!=YY_REDUCE_USE_DFLT );
  126304. assert( iLookAhead!=YYNOCODE );
  126305. i += iLookAhead;
  126306. #ifdef YYERRORSYMBOL
  126307. if( i<0 || i>=YY_ACTTAB_COUNT || yy_lookahead[i]!=iLookAhead ){
  126308. return yy_default[stateno];
  126309. }
  126310. #else
  126311. assert( i>=0 && i<YY_ACTTAB_COUNT );
  126312. assert( yy_lookahead[i]==iLookAhead );
  126313. #endif
  126314. return yy_action[i];
  126315. }
  126316. /*
  126317. ** The following routine is called if the stack overflows.
  126318. */
  126319. static void yyStackOverflow(yyParser *yypParser){
  126320. sqlite3ParserARG_FETCH;
  126321. yypParser->yytos--;
  126322. #ifndef NDEBUG
  126323. if( yyTraceFILE ){
  126324. fprintf(yyTraceFILE,"%sStack Overflow!\n",yyTracePrompt);
  126325. }
  126326. #endif
  126327. while( yypParser->yytos>yypParser->yystack ) yy_pop_parser_stack(yypParser);
  126328. /* Here code is inserted which will execute if the parser
  126329. ** stack every overflows */
  126330. /******** Begin %stack_overflow code ******************************************/
  126331. sqlite3ErrorMsg(pParse, "parser stack overflow");
  126332. /******** End %stack_overflow code ********************************************/
  126333. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument var */
  126334. }
  126335. /*
  126336. ** Print tracing information for a SHIFT action
  126337. */
  126338. #ifndef NDEBUG
  126339. static void yyTraceShift(yyParser *yypParser, int yyNewState){
  126340. if( yyTraceFILE ){
  126341. if( yyNewState<YYNSTATE ){
  126342. fprintf(yyTraceFILE,"%sShift '%s', go to state %d\n",
  126343. yyTracePrompt,yyTokenName[yypParser->yytos->major],
  126344. yyNewState);
  126345. }else{
  126346. fprintf(yyTraceFILE,"%sShift '%s'\n",
  126347. yyTracePrompt,yyTokenName[yypParser->yytos->major]);
  126348. }
  126349. }
  126350. }
  126351. #else
  126352. # define yyTraceShift(X,Y)
  126353. #endif
  126354. /*
  126355. ** Perform a shift action.
  126356. */
  126357. static void yy_shift(
  126358. yyParser *yypParser, /* The parser to be shifted */
  126359. int yyNewState, /* The new state to shift in */
  126360. int yyMajor, /* The major token to shift in */
  126361. sqlite3ParserTOKENTYPE yyMinor /* The minor token to shift in */
  126362. ){
  126363. yyStackEntry *yytos;
  126364. yypParser->yytos++;
  126365. #ifdef YYTRACKMAXSTACKDEPTH
  126366. if( (int)(yypParser->yytos - yypParser->yystack)>yypParser->yyhwm ){
  126367. yypParser->yyhwm++;
  126368. assert( yypParser->yyhwm == (int)(yypParser->yytos - yypParser->yystack) );
  126369. }
  126370. #endif
  126371. #if YYSTACKDEPTH>0
  126372. if( yypParser->yytos>=&yypParser->yystack[YYSTACKDEPTH] ){
  126373. yyStackOverflow(yypParser);
  126374. return;
  126375. }
  126376. #else
  126377. if( yypParser->yytos>=&yypParser->yystack[yypParser->yystksz] ){
  126378. if( yyGrowStack(yypParser) ){
  126379. yyStackOverflow(yypParser);
  126380. return;
  126381. }
  126382. }
  126383. #endif
  126384. if( yyNewState > YY_MAX_SHIFT ){
  126385. yyNewState += YY_MIN_REDUCE - YY_MIN_SHIFTREDUCE;
  126386. }
  126387. yytos = yypParser->yytos;
  126388. yytos->stateno = (YYACTIONTYPE)yyNewState;
  126389. yytos->major = (YYCODETYPE)yyMajor;
  126390. yytos->minor.yy0 = yyMinor;
  126391. yyTraceShift(yypParser, yyNewState);
  126392. }
  126393. /* The following table contains information about every rule that
  126394. ** is used during the reduce.
  126395. */
  126396. static const struct {
  126397. YYCODETYPE lhs; /* Symbol on the left-hand side of the rule */
  126398. unsigned char nrhs; /* Number of right-hand side symbols in the rule */
  126399. } yyRuleInfo[] = {
  126400. { 147, 1 },
  126401. { 147, 3 },
  126402. { 148, 1 },
  126403. { 149, 3 },
  126404. { 150, 0 },
  126405. { 150, 1 },
  126406. { 150, 1 },
  126407. { 150, 1 },
  126408. { 149, 2 },
  126409. { 149, 2 },
  126410. { 149, 2 },
  126411. { 149, 2 },
  126412. { 149, 3 },
  126413. { 149, 5 },
  126414. { 154, 6 },
  126415. { 156, 1 },
  126416. { 158, 0 },
  126417. { 158, 3 },
  126418. { 157, 1 },
  126419. { 157, 0 },
  126420. { 155, 5 },
  126421. { 155, 2 },
  126422. { 162, 0 },
  126423. { 162, 2 },
  126424. { 164, 2 },
  126425. { 166, 0 },
  126426. { 166, 4 },
  126427. { 166, 6 },
  126428. { 167, 2 },
  126429. { 171, 2 },
  126430. { 171, 2 },
  126431. { 171, 4 },
  126432. { 171, 3 },
  126433. { 171, 3 },
  126434. { 171, 2 },
  126435. { 171, 3 },
  126436. { 171, 5 },
  126437. { 171, 2 },
  126438. { 171, 4 },
  126439. { 171, 4 },
  126440. { 171, 1 },
  126441. { 171, 2 },
  126442. { 176, 0 },
  126443. { 176, 1 },
  126444. { 178, 0 },
  126445. { 178, 2 },
  126446. { 180, 2 },
  126447. { 180, 3 },
  126448. { 180, 3 },
  126449. { 180, 3 },
  126450. { 181, 2 },
  126451. { 181, 2 },
  126452. { 181, 1 },
  126453. { 181, 1 },
  126454. { 181, 2 },
  126455. { 179, 3 },
  126456. { 179, 2 },
  126457. { 182, 0 },
  126458. { 182, 2 },
  126459. { 182, 2 },
  126460. { 161, 0 },
  126461. { 184, 1 },
  126462. { 185, 2 },
  126463. { 185, 7 },
  126464. { 185, 5 },
  126465. { 185, 5 },
  126466. { 185, 10 },
  126467. { 188, 0 },
  126468. { 174, 0 },
  126469. { 174, 3 },
  126470. { 189, 0 },
  126471. { 189, 2 },
  126472. { 190, 1 },
  126473. { 190, 1 },
  126474. { 149, 4 },
  126475. { 192, 2 },
  126476. { 192, 0 },
  126477. { 149, 9 },
  126478. { 149, 4 },
  126479. { 149, 1 },
  126480. { 163, 2 },
  126481. { 194, 3 },
  126482. { 197, 1 },
  126483. { 197, 2 },
  126484. { 197, 1 },
  126485. { 195, 9 },
  126486. { 206, 4 },
  126487. { 206, 5 },
  126488. { 198, 1 },
  126489. { 198, 1 },
  126490. { 198, 0 },
  126491. { 209, 0 },
  126492. { 199, 3 },
  126493. { 199, 2 },
  126494. { 199, 4 },
  126495. { 210, 2 },
  126496. { 210, 0 },
  126497. { 200, 0 },
  126498. { 200, 2 },
  126499. { 212, 2 },
  126500. { 212, 0 },
  126501. { 211, 7 },
  126502. { 211, 9 },
  126503. { 211, 7 },
  126504. { 211, 7 },
  126505. { 159, 0 },
  126506. { 159, 2 },
  126507. { 193, 2 },
  126508. { 213, 1 },
  126509. { 213, 2 },
  126510. { 213, 3 },
  126511. { 213, 4 },
  126512. { 215, 2 },
  126513. { 215, 0 },
  126514. { 214, 0 },
  126515. { 214, 3 },
  126516. { 214, 2 },
  126517. { 216, 4 },
  126518. { 216, 0 },
  126519. { 204, 0 },
  126520. { 204, 3 },
  126521. { 186, 4 },
  126522. { 186, 2 },
  126523. { 175, 1 },
  126524. { 175, 1 },
  126525. { 175, 0 },
  126526. { 202, 0 },
  126527. { 202, 3 },
  126528. { 203, 0 },
  126529. { 203, 2 },
  126530. { 205, 0 },
  126531. { 205, 2 },
  126532. { 205, 4 },
  126533. { 205, 4 },
  126534. { 149, 6 },
  126535. { 201, 0 },
  126536. { 201, 2 },
  126537. { 149, 8 },
  126538. { 218, 5 },
  126539. { 218, 7 },
  126540. { 218, 3 },
  126541. { 218, 5 },
  126542. { 149, 6 },
  126543. { 149, 7 },
  126544. { 219, 2 },
  126545. { 219, 1 },
  126546. { 220, 0 },
  126547. { 220, 3 },
  126548. { 217, 3 },
  126549. { 217, 1 },
  126550. { 173, 3 },
  126551. { 172, 1 },
  126552. { 173, 1 },
  126553. { 173, 1 },
  126554. { 173, 3 },
  126555. { 173, 5 },
  126556. { 172, 1 },
  126557. { 172, 1 },
  126558. { 172, 1 },
  126559. { 173, 1 },
  126560. { 173, 3 },
  126561. { 173, 6 },
  126562. { 173, 5 },
  126563. { 173, 4 },
  126564. { 172, 1 },
  126565. { 173, 5 },
  126566. { 173, 3 },
  126567. { 173, 3 },
  126568. { 173, 3 },
  126569. { 173, 3 },
  126570. { 173, 3 },
  126571. { 173, 3 },
  126572. { 173, 3 },
  126573. { 173, 3 },
  126574. { 221, 1 },
  126575. { 221, 2 },
  126576. { 173, 3 },
  126577. { 173, 5 },
  126578. { 173, 2 },
  126579. { 173, 3 },
  126580. { 173, 3 },
  126581. { 173, 4 },
  126582. { 173, 2 },
  126583. { 173, 2 },
  126584. { 173, 2 },
  126585. { 173, 2 },
  126586. { 222, 1 },
  126587. { 222, 2 },
  126588. { 173, 5 },
  126589. { 223, 1 },
  126590. { 223, 2 },
  126591. { 173, 5 },
  126592. { 173, 3 },
  126593. { 173, 5 },
  126594. { 173, 5 },
  126595. { 173, 4 },
  126596. { 173, 5 },
  126597. { 226, 5 },
  126598. { 226, 4 },
  126599. { 227, 2 },
  126600. { 227, 0 },
  126601. { 225, 1 },
  126602. { 225, 0 },
  126603. { 208, 0 },
  126604. { 207, 3 },
  126605. { 207, 1 },
  126606. { 224, 0 },
  126607. { 224, 3 },
  126608. { 149, 12 },
  126609. { 228, 1 },
  126610. { 228, 0 },
  126611. { 177, 0 },
  126612. { 177, 3 },
  126613. { 187, 5 },
  126614. { 187, 3 },
  126615. { 229, 0 },
  126616. { 229, 2 },
  126617. { 149, 4 },
  126618. { 149, 1 },
  126619. { 149, 2 },
  126620. { 149, 3 },
  126621. { 149, 5 },
  126622. { 149, 6 },
  126623. { 149, 5 },
  126624. { 149, 6 },
  126625. { 169, 2 },
  126626. { 170, 2 },
  126627. { 149, 5 },
  126628. { 231, 11 },
  126629. { 233, 1 },
  126630. { 233, 1 },
  126631. { 233, 2 },
  126632. { 233, 0 },
  126633. { 234, 1 },
  126634. { 234, 1 },
  126635. { 234, 3 },
  126636. { 236, 0 },
  126637. { 236, 2 },
  126638. { 232, 3 },
  126639. { 232, 2 },
  126640. { 238, 3 },
  126641. { 239, 3 },
  126642. { 239, 2 },
  126643. { 237, 7 },
  126644. { 237, 5 },
  126645. { 237, 5 },
  126646. { 237, 1 },
  126647. { 173, 4 },
  126648. { 173, 6 },
  126649. { 191, 1 },
  126650. { 191, 1 },
  126651. { 191, 1 },
  126652. { 149, 4 },
  126653. { 149, 6 },
  126654. { 149, 3 },
  126655. { 241, 0 },
  126656. { 241, 2 },
  126657. { 149, 1 },
  126658. { 149, 3 },
  126659. { 149, 1 },
  126660. { 149, 3 },
  126661. { 149, 6 },
  126662. { 149, 7 },
  126663. { 242, 1 },
  126664. { 149, 1 },
  126665. { 149, 4 },
  126666. { 244, 8 },
  126667. { 246, 0 },
  126668. { 247, 1 },
  126669. { 247, 3 },
  126670. { 248, 1 },
  126671. { 196, 0 },
  126672. { 196, 2 },
  126673. { 196, 3 },
  126674. { 250, 6 },
  126675. { 250, 8 },
  126676. { 144, 1 },
  126677. { 145, 2 },
  126678. { 145, 1 },
  126679. { 146, 1 },
  126680. { 146, 3 },
  126681. { 147, 0 },
  126682. { 151, 0 },
  126683. { 151, 1 },
  126684. { 151, 2 },
  126685. { 153, 1 },
  126686. { 153, 0 },
  126687. { 149, 2 },
  126688. { 160, 4 },
  126689. { 160, 2 },
  126690. { 152, 1 },
  126691. { 152, 1 },
  126692. { 152, 1 },
  126693. { 166, 1 },
  126694. { 167, 1 },
  126695. { 168, 1 },
  126696. { 168, 1 },
  126697. { 165, 2 },
  126698. { 165, 0 },
  126699. { 171, 2 },
  126700. { 161, 2 },
  126701. { 183, 3 },
  126702. { 183, 1 },
  126703. { 184, 0 },
  126704. { 188, 1 },
  126705. { 190, 1 },
  126706. { 194, 1 },
  126707. { 195, 1 },
  126708. { 209, 2 },
  126709. { 210, 1 },
  126710. { 173, 1 },
  126711. { 208, 1 },
  126712. { 230, 1 },
  126713. { 230, 1 },
  126714. { 230, 1 },
  126715. { 230, 1 },
  126716. { 230, 1 },
  126717. { 169, 1 },
  126718. { 235, 0 },
  126719. { 235, 3 },
  126720. { 238, 1 },
  126721. { 239, 0 },
  126722. { 240, 1 },
  126723. { 240, 0 },
  126724. { 243, 0 },
  126725. { 243, 1 },
  126726. { 245, 1 },
  126727. { 245, 3 },
  126728. { 246, 2 },
  126729. { 249, 0 },
  126730. { 249, 4 },
  126731. { 249, 2 },
  126732. };
  126733. static void yy_accept(yyParser*); /* Forward Declaration */
  126734. /*
  126735. ** Perform a reduce action and the shift that must immediately
  126736. ** follow the reduce.
  126737. */
  126738. static void yy_reduce(
  126739. yyParser *yypParser, /* The parser */
  126740. unsigned int yyruleno /* Number of the rule by which to reduce */
  126741. ){
  126742. int yygoto; /* The next state */
  126743. int yyact; /* The next action */
  126744. yyStackEntry *yymsp; /* The top of the parser's stack */
  126745. int yysize; /* Amount to pop the stack */
  126746. sqlite3ParserARG_FETCH;
  126747. yymsp = yypParser->yytos;
  126748. #ifndef NDEBUG
  126749. if( yyTraceFILE && yyruleno<(int)(sizeof(yyRuleName)/sizeof(yyRuleName[0])) ){
  126750. yysize = yyRuleInfo[yyruleno].nrhs;
  126751. fprintf(yyTraceFILE, "%sReduce [%s], go to state %d.\n", yyTracePrompt,
  126752. yyRuleName[yyruleno], yymsp[-yysize].stateno);
  126753. }
  126754. #endif /* NDEBUG */
  126755. /* Check that the stack is large enough to grow by a single entry
  126756. ** if the RHS of the rule is empty. This ensures that there is room
  126757. ** enough on the stack to push the LHS value */
  126758. if( yyRuleInfo[yyruleno].nrhs==0 ){
  126759. #ifdef YYTRACKMAXSTACKDEPTH
  126760. if( (int)(yypParser->yytos - yypParser->yystack)>yypParser->yyhwm ){
  126761. yypParser->yyhwm++;
  126762. assert( yypParser->yyhwm == (int)(yypParser->yytos - yypParser->yystack));
  126763. }
  126764. #endif
  126765. #if YYSTACKDEPTH>0
  126766. if( yypParser->yytos>=&yypParser->yystack[YYSTACKDEPTH-1] ){
  126767. yyStackOverflow(yypParser);
  126768. return;
  126769. }
  126770. #else
  126771. if( yypParser->yytos>=&yypParser->yystack[yypParser->yystksz-1] ){
  126772. if( yyGrowStack(yypParser) ){
  126773. yyStackOverflow(yypParser);
  126774. return;
  126775. }
  126776. yymsp = yypParser->yytos;
  126777. }
  126778. #endif
  126779. }
  126780. switch( yyruleno ){
  126781. /* Beginning here are the reduction cases. A typical example
  126782. ** follows:
  126783. ** case 0:
  126784. ** #line <lineno> <grammarfile>
  126785. ** { ... } // User supplied code
  126786. ** #line <lineno> <thisfile>
  126787. ** break;
  126788. */
  126789. /********** Begin reduce actions **********************************************/
  126790. YYMINORTYPE yylhsminor;
  126791. case 0: /* explain ::= EXPLAIN */
  126792. { pParse->explain = 1; }
  126793. break;
  126794. case 1: /* explain ::= EXPLAIN QUERY PLAN */
  126795. { pParse->explain = 2; }
  126796. break;
  126797. case 2: /* cmdx ::= cmd */
  126798. { sqlite3FinishCoding(pParse); }
  126799. break;
  126800. case 3: /* cmd ::= BEGIN transtype trans_opt */
  126801. {sqlite3BeginTransaction(pParse, yymsp[-1].minor.yy194);}
  126802. break;
  126803. case 4: /* transtype ::= */
  126804. {yymsp[1].minor.yy194 = TK_DEFERRED;}
  126805. break;
  126806. case 5: /* transtype ::= DEFERRED */
  126807. case 6: /* transtype ::= IMMEDIATE */ yytestcase(yyruleno==6);
  126808. case 7: /* transtype ::= EXCLUSIVE */ yytestcase(yyruleno==7);
  126809. {yymsp[0].minor.yy194 = yymsp[0].major; /*A-overwrites-X*/}
  126810. break;
  126811. case 8: /* cmd ::= COMMIT trans_opt */
  126812. case 9: /* cmd ::= END trans_opt */ yytestcase(yyruleno==9);
  126813. {sqlite3CommitTransaction(pParse);}
  126814. break;
  126815. case 10: /* cmd ::= ROLLBACK trans_opt */
  126816. {sqlite3RollbackTransaction(pParse);}
  126817. break;
  126818. case 11: /* cmd ::= SAVEPOINT nm */
  126819. {
  126820. sqlite3Savepoint(pParse, SAVEPOINT_BEGIN, &yymsp[0].minor.yy0);
  126821. }
  126822. break;
  126823. case 12: /* cmd ::= RELEASE savepoint_opt nm */
  126824. {
  126825. sqlite3Savepoint(pParse, SAVEPOINT_RELEASE, &yymsp[0].minor.yy0);
  126826. }
  126827. break;
  126828. case 13: /* cmd ::= ROLLBACK trans_opt TO savepoint_opt nm */
  126829. {
  126830. sqlite3Savepoint(pParse, SAVEPOINT_ROLLBACK, &yymsp[0].minor.yy0);
  126831. }
  126832. break;
  126833. case 14: /* create_table ::= createkw temp TABLE ifnotexists nm dbnm */
  126834. {
  126835. sqlite3StartTable(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0,yymsp[-4].minor.yy194,0,0,yymsp[-2].minor.yy194);
  126836. }
  126837. break;
  126838. case 15: /* createkw ::= CREATE */
  126839. {disableLookaside(pParse);}
  126840. break;
  126841. case 16: /* ifnotexists ::= */
  126842. case 19: /* temp ::= */ yytestcase(yyruleno==19);
  126843. case 22: /* table_options ::= */ yytestcase(yyruleno==22);
  126844. case 42: /* autoinc ::= */ yytestcase(yyruleno==42);
  126845. case 57: /* init_deferred_pred_opt ::= */ yytestcase(yyruleno==57);
  126846. case 67: /* defer_subclause_opt ::= */ yytestcase(yyruleno==67);
  126847. case 76: /* ifexists ::= */ yytestcase(yyruleno==76);
  126848. case 90: /* distinct ::= */ yytestcase(yyruleno==90);
  126849. case 215: /* collate ::= */ yytestcase(yyruleno==215);
  126850. {yymsp[1].minor.yy194 = 0;}
  126851. break;
  126852. case 17: /* ifnotexists ::= IF NOT EXISTS */
  126853. {yymsp[-2].minor.yy194 = 1;}
  126854. break;
  126855. case 18: /* temp ::= TEMP */
  126856. case 43: /* autoinc ::= AUTOINCR */ yytestcase(yyruleno==43);
  126857. {yymsp[0].minor.yy194 = 1;}
  126858. break;
  126859. case 20: /* create_table_args ::= LP columnlist conslist_opt RP table_options */
  126860. {
  126861. sqlite3EndTable(pParse,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0,yymsp[0].minor.yy194,0);
  126862. }
  126863. break;
  126864. case 21: /* create_table_args ::= AS select */
  126865. {
  126866. sqlite3EndTable(pParse,0,0,0,yymsp[0].minor.yy243);
  126867. sqlite3SelectDelete(pParse->db, yymsp[0].minor.yy243);
  126868. }
  126869. break;
  126870. case 23: /* table_options ::= WITHOUT nm */
  126871. {
  126872. if( yymsp[0].minor.yy0.n==5 && sqlite3_strnicmp(yymsp[0].minor.yy0.z,"rowid",5)==0 ){
  126873. yymsp[-1].minor.yy194 = TF_WithoutRowid | TF_NoVisibleRowid;
  126874. }else{
  126875. yymsp[-1].minor.yy194 = 0;
  126876. sqlite3ErrorMsg(pParse, "unknown table option: %.*s", yymsp[0].minor.yy0.n, yymsp[0].minor.yy0.z);
  126877. }
  126878. }
  126879. break;
  126880. case 24: /* columnname ::= nm typetoken */
  126881. {sqlite3AddColumn(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0);}
  126882. break;
  126883. case 25: /* typetoken ::= */
  126884. case 60: /* conslist_opt ::= */ yytestcase(yyruleno==60);
  126885. case 96: /* as ::= */ yytestcase(yyruleno==96);
  126886. {yymsp[1].minor.yy0.n = 0; yymsp[1].minor.yy0.z = 0;}
  126887. break;
  126888. case 26: /* typetoken ::= typename LP signed RP */
  126889. {
  126890. yymsp[-3].minor.yy0.n = (int)(&yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n] - yymsp[-3].minor.yy0.z);
  126891. }
  126892. break;
  126893. case 27: /* typetoken ::= typename LP signed COMMA signed RP */
  126894. {
  126895. yymsp[-5].minor.yy0.n = (int)(&yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n] - yymsp[-5].minor.yy0.z);
  126896. }
  126897. break;
  126898. case 28: /* typename ::= typename ID|STRING */
  126899. {yymsp[-1].minor.yy0.n=yymsp[0].minor.yy0.n+(int)(yymsp[0].minor.yy0.z-yymsp[-1].minor.yy0.z);}
  126900. break;
  126901. case 29: /* ccons ::= CONSTRAINT nm */
  126902. case 62: /* tcons ::= CONSTRAINT nm */ yytestcase(yyruleno==62);
  126903. {pParse->constraintName = yymsp[0].minor.yy0;}
  126904. break;
  126905. case 30: /* ccons ::= DEFAULT term */
  126906. case 32: /* ccons ::= DEFAULT PLUS term */ yytestcase(yyruleno==32);
  126907. {sqlite3AddDefaultValue(pParse,&yymsp[0].minor.yy190);}
  126908. break;
  126909. case 31: /* ccons ::= DEFAULT LP expr RP */
  126910. {sqlite3AddDefaultValue(pParse,&yymsp[-1].minor.yy190);}
  126911. break;
  126912. case 33: /* ccons ::= DEFAULT MINUS term */
  126913. {
  126914. ExprSpan v;
  126915. v.pExpr = sqlite3PExpr(pParse, TK_UMINUS, yymsp[0].minor.yy190.pExpr, 0, 0);
  126916. v.zStart = yymsp[-1].minor.yy0.z;
  126917. v.zEnd = yymsp[0].minor.yy190.zEnd;
  126918. sqlite3AddDefaultValue(pParse,&v);
  126919. }
  126920. break;
  126921. case 34: /* ccons ::= DEFAULT ID|INDEXED */
  126922. {
  126923. ExprSpan v;
  126924. spanExpr(&v, pParse, TK_STRING, yymsp[0].minor.yy0);
  126925. sqlite3AddDefaultValue(pParse,&v);
  126926. }
  126927. break;
  126928. case 35: /* ccons ::= NOT NULL onconf */
  126929. {sqlite3AddNotNull(pParse, yymsp[0].minor.yy194);}
  126930. break;
  126931. case 36: /* ccons ::= PRIMARY KEY sortorder onconf autoinc */
  126932. {sqlite3AddPrimaryKey(pParse,0,yymsp[-1].minor.yy194,yymsp[0].minor.yy194,yymsp[-2].minor.yy194);}
  126933. break;
  126934. case 37: /* ccons ::= UNIQUE onconf */
  126935. {sqlite3CreateIndex(pParse,0,0,0,0,yymsp[0].minor.yy194,0,0,0,0,
  126936. SQLITE_IDXTYPE_UNIQUE);}
  126937. break;
  126938. case 38: /* ccons ::= CHECK LP expr RP */
  126939. {sqlite3AddCheckConstraint(pParse,yymsp[-1].minor.yy190.pExpr);}
  126940. break;
  126941. case 39: /* ccons ::= REFERENCES nm eidlist_opt refargs */
  126942. {sqlite3CreateForeignKey(pParse,0,&yymsp[-2].minor.yy0,yymsp[-1].minor.yy148,yymsp[0].minor.yy194);}
  126943. break;
  126944. case 40: /* ccons ::= defer_subclause */
  126945. {sqlite3DeferForeignKey(pParse,yymsp[0].minor.yy194);}
  126946. break;
  126947. case 41: /* ccons ::= COLLATE ID|STRING */
  126948. {sqlite3AddCollateType(pParse, &yymsp[0].minor.yy0);}
  126949. break;
  126950. case 44: /* refargs ::= */
  126951. { yymsp[1].minor.yy194 = OE_None*0x0101; /* EV: R-19803-45884 */}
  126952. break;
  126953. case 45: /* refargs ::= refargs refarg */
  126954. { yymsp[-1].minor.yy194 = (yymsp[-1].minor.yy194 & ~yymsp[0].minor.yy497.mask) | yymsp[0].minor.yy497.value; }
  126955. break;
  126956. case 46: /* refarg ::= MATCH nm */
  126957. { yymsp[-1].minor.yy497.value = 0; yymsp[-1].minor.yy497.mask = 0x000000; }
  126958. break;
  126959. case 47: /* refarg ::= ON INSERT refact */
  126960. { yymsp[-2].minor.yy497.value = 0; yymsp[-2].minor.yy497.mask = 0x000000; }
  126961. break;
  126962. case 48: /* refarg ::= ON DELETE refact */
  126963. { yymsp[-2].minor.yy497.value = yymsp[0].minor.yy194; yymsp[-2].minor.yy497.mask = 0x0000ff; }
  126964. break;
  126965. case 49: /* refarg ::= ON UPDATE refact */
  126966. { yymsp[-2].minor.yy497.value = yymsp[0].minor.yy194<<8; yymsp[-2].minor.yy497.mask = 0x00ff00; }
  126967. break;
  126968. case 50: /* refact ::= SET NULL */
  126969. { yymsp[-1].minor.yy194 = OE_SetNull; /* EV: R-33326-45252 */}
  126970. break;
  126971. case 51: /* refact ::= SET DEFAULT */
  126972. { yymsp[-1].minor.yy194 = OE_SetDflt; /* EV: R-33326-45252 */}
  126973. break;
  126974. case 52: /* refact ::= CASCADE */
  126975. { yymsp[0].minor.yy194 = OE_Cascade; /* EV: R-33326-45252 */}
  126976. break;
  126977. case 53: /* refact ::= RESTRICT */
  126978. { yymsp[0].minor.yy194 = OE_Restrict; /* EV: R-33326-45252 */}
  126979. break;
  126980. case 54: /* refact ::= NO ACTION */
  126981. { yymsp[-1].minor.yy194 = OE_None; /* EV: R-33326-45252 */}
  126982. break;
  126983. case 55: /* defer_subclause ::= NOT DEFERRABLE init_deferred_pred_opt */
  126984. {yymsp[-2].minor.yy194 = 0;}
  126985. break;
  126986. case 56: /* defer_subclause ::= DEFERRABLE init_deferred_pred_opt */
  126987. case 71: /* orconf ::= OR resolvetype */ yytestcase(yyruleno==71);
  126988. case 144: /* insert_cmd ::= INSERT orconf */ yytestcase(yyruleno==144);
  126989. {yymsp[-1].minor.yy194 = yymsp[0].minor.yy194;}
  126990. break;
  126991. case 58: /* init_deferred_pred_opt ::= INITIALLY DEFERRED */
  126992. case 75: /* ifexists ::= IF EXISTS */ yytestcase(yyruleno==75);
  126993. case 187: /* between_op ::= NOT BETWEEN */ yytestcase(yyruleno==187);
  126994. case 190: /* in_op ::= NOT IN */ yytestcase(yyruleno==190);
  126995. case 216: /* collate ::= COLLATE ID|STRING */ yytestcase(yyruleno==216);
  126996. {yymsp[-1].minor.yy194 = 1;}
  126997. break;
  126998. case 59: /* init_deferred_pred_opt ::= INITIALLY IMMEDIATE */
  126999. {yymsp[-1].minor.yy194 = 0;}
  127000. break;
  127001. case 61: /* tconscomma ::= COMMA */
  127002. {pParse->constraintName.n = 0;}
  127003. break;
  127004. case 63: /* tcons ::= PRIMARY KEY LP sortlist autoinc RP onconf */
  127005. {sqlite3AddPrimaryKey(pParse,yymsp[-3].minor.yy148,yymsp[0].minor.yy194,yymsp[-2].minor.yy194,0);}
  127006. break;
  127007. case 64: /* tcons ::= UNIQUE LP sortlist RP onconf */
  127008. {sqlite3CreateIndex(pParse,0,0,0,yymsp[-2].minor.yy148,yymsp[0].minor.yy194,0,0,0,0,
  127009. SQLITE_IDXTYPE_UNIQUE);}
  127010. break;
  127011. case 65: /* tcons ::= CHECK LP expr RP onconf */
  127012. {sqlite3AddCheckConstraint(pParse,yymsp[-2].minor.yy190.pExpr);}
  127013. break;
  127014. case 66: /* tcons ::= FOREIGN KEY LP eidlist RP REFERENCES nm eidlist_opt refargs defer_subclause_opt */
  127015. {
  127016. sqlite3CreateForeignKey(pParse, yymsp[-6].minor.yy148, &yymsp[-3].minor.yy0, yymsp[-2].minor.yy148, yymsp[-1].minor.yy194);
  127017. sqlite3DeferForeignKey(pParse, yymsp[0].minor.yy194);
  127018. }
  127019. break;
  127020. case 68: /* onconf ::= */
  127021. case 70: /* orconf ::= */ yytestcase(yyruleno==70);
  127022. {yymsp[1].minor.yy194 = OE_Default;}
  127023. break;
  127024. case 69: /* onconf ::= ON CONFLICT resolvetype */
  127025. {yymsp[-2].minor.yy194 = yymsp[0].minor.yy194;}
  127026. break;
  127027. case 72: /* resolvetype ::= IGNORE */
  127028. {yymsp[0].minor.yy194 = OE_Ignore;}
  127029. break;
  127030. case 73: /* resolvetype ::= REPLACE */
  127031. case 145: /* insert_cmd ::= REPLACE */ yytestcase(yyruleno==145);
  127032. {yymsp[0].minor.yy194 = OE_Replace;}
  127033. break;
  127034. case 74: /* cmd ::= DROP TABLE ifexists fullname */
  127035. {
  127036. sqlite3DropTable(pParse, yymsp[0].minor.yy185, 0, yymsp[-1].minor.yy194);
  127037. }
  127038. break;
  127039. case 77: /* cmd ::= createkw temp VIEW ifnotexists nm dbnm eidlist_opt AS select */
  127040. {
  127041. sqlite3CreateView(pParse, &yymsp[-8].minor.yy0, &yymsp[-4].minor.yy0, &yymsp[-3].minor.yy0, yymsp[-2].minor.yy148, yymsp[0].minor.yy243, yymsp[-7].minor.yy194, yymsp[-5].minor.yy194);
  127042. }
  127043. break;
  127044. case 78: /* cmd ::= DROP VIEW ifexists fullname */
  127045. {
  127046. sqlite3DropTable(pParse, yymsp[0].minor.yy185, 1, yymsp[-1].minor.yy194);
  127047. }
  127048. break;
  127049. case 79: /* cmd ::= select */
  127050. {
  127051. SelectDest dest = {SRT_Output, 0, 0, 0, 0, 0};
  127052. sqlite3Select(pParse, yymsp[0].minor.yy243, &dest);
  127053. sqlite3SelectDelete(pParse->db, yymsp[0].minor.yy243);
  127054. }
  127055. break;
  127056. case 80: /* select ::= with selectnowith */
  127057. {
  127058. Select *p = yymsp[0].minor.yy243;
  127059. if( p ){
  127060. p->pWith = yymsp[-1].minor.yy285;
  127061. parserDoubleLinkSelect(pParse, p);
  127062. }else{
  127063. sqlite3WithDelete(pParse->db, yymsp[-1].minor.yy285);
  127064. }
  127065. yymsp[-1].minor.yy243 = p; /*A-overwrites-W*/
  127066. }
  127067. break;
  127068. case 81: /* selectnowith ::= selectnowith multiselect_op oneselect */
  127069. {
  127070. Select *pRhs = yymsp[0].minor.yy243;
  127071. Select *pLhs = yymsp[-2].minor.yy243;
  127072. if( pRhs && pRhs->pPrior ){
  127073. SrcList *pFrom;
  127074. Token x;
  127075. x.n = 0;
  127076. parserDoubleLinkSelect(pParse, pRhs);
  127077. pFrom = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&x,pRhs,0,0);
  127078. pRhs = sqlite3SelectNew(pParse,0,pFrom,0,0,0,0,0,0,0);
  127079. }
  127080. if( pRhs ){
  127081. pRhs->op = (u8)yymsp[-1].minor.yy194;
  127082. pRhs->pPrior = pLhs;
  127083. if( ALWAYS(pLhs) ) pLhs->selFlags &= ~SF_MultiValue;
  127084. pRhs->selFlags &= ~SF_MultiValue;
  127085. if( yymsp[-1].minor.yy194!=TK_ALL ) pParse->hasCompound = 1;
  127086. }else{
  127087. sqlite3SelectDelete(pParse->db, pLhs);
  127088. }
  127089. yymsp[-2].minor.yy243 = pRhs;
  127090. }
  127091. break;
  127092. case 82: /* multiselect_op ::= UNION */
  127093. case 84: /* multiselect_op ::= EXCEPT|INTERSECT */ yytestcase(yyruleno==84);
  127094. {yymsp[0].minor.yy194 = yymsp[0].major; /*A-overwrites-OP*/}
  127095. break;
  127096. case 83: /* multiselect_op ::= UNION ALL */
  127097. {yymsp[-1].minor.yy194 = TK_ALL;}
  127098. break;
  127099. case 85: /* oneselect ::= SELECT distinct selcollist from where_opt groupby_opt having_opt orderby_opt limit_opt */
  127100. {
  127101. #if SELECTTRACE_ENABLED
  127102. Token s = yymsp[-8].minor.yy0; /*A-overwrites-S*/
  127103. #endif
  127104. yymsp[-8].minor.yy243 = sqlite3SelectNew(pParse,yymsp[-6].minor.yy148,yymsp[-5].minor.yy185,yymsp[-4].minor.yy72,yymsp[-3].minor.yy148,yymsp[-2].minor.yy72,yymsp[-1].minor.yy148,yymsp[-7].minor.yy194,yymsp[0].minor.yy354.pLimit,yymsp[0].minor.yy354.pOffset);
  127105. #if SELECTTRACE_ENABLED
  127106. /* Populate the Select.zSelName[] string that is used to help with
  127107. ** query planner debugging, to differentiate between multiple Select
  127108. ** objects in a complex query.
  127109. **
  127110. ** If the SELECT keyword is immediately followed by a C-style comment
  127111. ** then extract the first few alphanumeric characters from within that
  127112. ** comment to be the zSelName value. Otherwise, the label is #N where
  127113. ** is an integer that is incremented with each SELECT statement seen.
  127114. */
  127115. if( yymsp[-8].minor.yy243!=0 ){
  127116. const char *z = s.z+6;
  127117. int i;
  127118. sqlite3_snprintf(sizeof(yymsp[-8].minor.yy243->zSelName), yymsp[-8].minor.yy243->zSelName, "#%d",
  127119. ++pParse->nSelect);
  127120. while( z[0]==' ' ) z++;
  127121. if( z[0]=='/' && z[1]=='*' ){
  127122. z += 2;
  127123. while( z[0]==' ' ) z++;
  127124. for(i=0; sqlite3Isalnum(z[i]); i++){}
  127125. sqlite3_snprintf(sizeof(yymsp[-8].minor.yy243->zSelName), yymsp[-8].minor.yy243->zSelName, "%.*s", i, z);
  127126. }
  127127. }
  127128. #endif /* SELECTRACE_ENABLED */
  127129. }
  127130. break;
  127131. case 86: /* values ::= VALUES LP nexprlist RP */
  127132. {
  127133. yymsp[-3].minor.yy243 = sqlite3SelectNew(pParse,yymsp[-1].minor.yy148,0,0,0,0,0,SF_Values,0,0);
  127134. }
  127135. break;
  127136. case 87: /* values ::= values COMMA LP exprlist RP */
  127137. {
  127138. Select *pRight, *pLeft = yymsp[-4].minor.yy243;
  127139. pRight = sqlite3SelectNew(pParse,yymsp[-1].minor.yy148,0,0,0,0,0,SF_Values|SF_MultiValue,0,0);
  127140. if( ALWAYS(pLeft) ) pLeft->selFlags &= ~SF_MultiValue;
  127141. if( pRight ){
  127142. pRight->op = TK_ALL;
  127143. pRight->pPrior = pLeft;
  127144. yymsp[-4].minor.yy243 = pRight;
  127145. }else{
  127146. yymsp[-4].minor.yy243 = pLeft;
  127147. }
  127148. }
  127149. break;
  127150. case 88: /* distinct ::= DISTINCT */
  127151. {yymsp[0].minor.yy194 = SF_Distinct;}
  127152. break;
  127153. case 89: /* distinct ::= ALL */
  127154. {yymsp[0].minor.yy194 = SF_All;}
  127155. break;
  127156. case 91: /* sclp ::= */
  127157. case 119: /* orderby_opt ::= */ yytestcase(yyruleno==119);
  127158. case 126: /* groupby_opt ::= */ yytestcase(yyruleno==126);
  127159. case 203: /* exprlist ::= */ yytestcase(yyruleno==203);
  127160. case 206: /* paren_exprlist ::= */ yytestcase(yyruleno==206);
  127161. case 211: /* eidlist_opt ::= */ yytestcase(yyruleno==211);
  127162. {yymsp[1].minor.yy148 = 0;}
  127163. break;
  127164. case 92: /* selcollist ::= sclp expr as */
  127165. {
  127166. yymsp[-2].minor.yy148 = sqlite3ExprListAppend(pParse, yymsp[-2].minor.yy148, yymsp[-1].minor.yy190.pExpr);
  127167. if( yymsp[0].minor.yy0.n>0 ) sqlite3ExprListSetName(pParse, yymsp[-2].minor.yy148, &yymsp[0].minor.yy0, 1);
  127168. sqlite3ExprListSetSpan(pParse,yymsp[-2].minor.yy148,&yymsp[-1].minor.yy190);
  127169. }
  127170. break;
  127171. case 93: /* selcollist ::= sclp STAR */
  127172. {
  127173. Expr *p = sqlite3Expr(pParse->db, TK_ASTERISK, 0);
  127174. yymsp[-1].minor.yy148 = sqlite3ExprListAppend(pParse, yymsp[-1].minor.yy148, p);
  127175. }
  127176. break;
  127177. case 94: /* selcollist ::= sclp nm DOT STAR */
  127178. {
  127179. Expr *pRight = sqlite3PExpr(pParse, TK_ASTERISK, 0, 0, 0);
  127180. Expr *pLeft = sqlite3PExpr(pParse, TK_ID, 0, 0, &yymsp[-2].minor.yy0);
  127181. Expr *pDot = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight, 0);
  127182. yymsp[-3].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-3].minor.yy148, pDot);
  127183. }
  127184. break;
  127185. case 95: /* as ::= AS nm */
  127186. case 106: /* dbnm ::= DOT nm */ yytestcase(yyruleno==106);
  127187. case 225: /* plus_num ::= PLUS INTEGER|FLOAT */ yytestcase(yyruleno==225);
  127188. case 226: /* minus_num ::= MINUS INTEGER|FLOAT */ yytestcase(yyruleno==226);
  127189. {yymsp[-1].minor.yy0 = yymsp[0].minor.yy0;}
  127190. break;
  127191. case 97: /* from ::= */
  127192. {yymsp[1].minor.yy185 = sqlite3DbMallocZero(pParse->db, sizeof(*yymsp[1].minor.yy185));}
  127193. break;
  127194. case 98: /* from ::= FROM seltablist */
  127195. {
  127196. yymsp[-1].minor.yy185 = yymsp[0].minor.yy185;
  127197. sqlite3SrcListShiftJoinType(yymsp[-1].minor.yy185);
  127198. }
  127199. break;
  127200. case 99: /* stl_prefix ::= seltablist joinop */
  127201. {
  127202. if( ALWAYS(yymsp[-1].minor.yy185 && yymsp[-1].minor.yy185->nSrc>0) ) yymsp[-1].minor.yy185->a[yymsp[-1].minor.yy185->nSrc-1].fg.jointype = (u8)yymsp[0].minor.yy194;
  127203. }
  127204. break;
  127205. case 100: /* stl_prefix ::= */
  127206. {yymsp[1].minor.yy185 = 0;}
  127207. break;
  127208. case 101: /* seltablist ::= stl_prefix nm dbnm as indexed_opt on_opt using_opt */
  127209. {
  127210. yymsp[-6].minor.yy185 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy185,&yymsp[-5].minor.yy0,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,0,yymsp[-1].minor.yy72,yymsp[0].minor.yy254);
  127211. sqlite3SrcListIndexedBy(pParse, yymsp[-6].minor.yy185, &yymsp[-2].minor.yy0);
  127212. }
  127213. break;
  127214. case 102: /* seltablist ::= stl_prefix nm dbnm LP exprlist RP as on_opt using_opt */
  127215. {
  127216. yymsp[-8].minor.yy185 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-8].minor.yy185,&yymsp[-7].minor.yy0,&yymsp[-6].minor.yy0,&yymsp[-2].minor.yy0,0,yymsp[-1].minor.yy72,yymsp[0].minor.yy254);
  127217. sqlite3SrcListFuncArgs(pParse, yymsp[-8].minor.yy185, yymsp[-4].minor.yy148);
  127218. }
  127219. break;
  127220. case 103: /* seltablist ::= stl_prefix LP select RP as on_opt using_opt */
  127221. {
  127222. yymsp[-6].minor.yy185 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy185,0,0,&yymsp[-2].minor.yy0,yymsp[-4].minor.yy243,yymsp[-1].minor.yy72,yymsp[0].minor.yy254);
  127223. }
  127224. break;
  127225. case 104: /* seltablist ::= stl_prefix LP seltablist RP as on_opt using_opt */
  127226. {
  127227. if( yymsp[-6].minor.yy185==0 && yymsp[-2].minor.yy0.n==0 && yymsp[-1].minor.yy72==0 && yymsp[0].minor.yy254==0 ){
  127228. yymsp[-6].minor.yy185 = yymsp[-4].minor.yy185;
  127229. }else if( yymsp[-4].minor.yy185->nSrc==1 ){
  127230. yymsp[-6].minor.yy185 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy185,0,0,&yymsp[-2].minor.yy0,0,yymsp[-1].minor.yy72,yymsp[0].minor.yy254);
  127231. if( yymsp[-6].minor.yy185 ){
  127232. struct SrcList_item *pNew = &yymsp[-6].minor.yy185->a[yymsp[-6].minor.yy185->nSrc-1];
  127233. struct SrcList_item *pOld = yymsp[-4].minor.yy185->a;
  127234. pNew->zName = pOld->zName;
  127235. pNew->zDatabase = pOld->zDatabase;
  127236. pNew->pSelect = pOld->pSelect;
  127237. pOld->zName = pOld->zDatabase = 0;
  127238. pOld->pSelect = 0;
  127239. }
  127240. sqlite3SrcListDelete(pParse->db, yymsp[-4].minor.yy185);
  127241. }else{
  127242. Select *pSubquery;
  127243. sqlite3SrcListShiftJoinType(yymsp[-4].minor.yy185);
  127244. pSubquery = sqlite3SelectNew(pParse,0,yymsp[-4].minor.yy185,0,0,0,0,SF_NestedFrom,0,0);
  127245. yymsp[-6].minor.yy185 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy185,0,0,&yymsp[-2].minor.yy0,pSubquery,yymsp[-1].minor.yy72,yymsp[0].minor.yy254);
  127246. }
  127247. }
  127248. break;
  127249. case 105: /* dbnm ::= */
  127250. case 114: /* indexed_opt ::= */ yytestcase(yyruleno==114);
  127251. {yymsp[1].minor.yy0.z=0; yymsp[1].minor.yy0.n=0;}
  127252. break;
  127253. case 107: /* fullname ::= nm dbnm */
  127254. {yymsp[-1].minor.yy185 = sqlite3SrcListAppend(pParse->db,0,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/}
  127255. break;
  127256. case 108: /* joinop ::= COMMA|JOIN */
  127257. { yymsp[0].minor.yy194 = JT_INNER; }
  127258. break;
  127259. case 109: /* joinop ::= JOIN_KW JOIN */
  127260. {yymsp[-1].minor.yy194 = sqlite3JoinType(pParse,&yymsp[-1].minor.yy0,0,0); /*X-overwrites-A*/}
  127261. break;
  127262. case 110: /* joinop ::= JOIN_KW nm JOIN */
  127263. {yymsp[-2].minor.yy194 = sqlite3JoinType(pParse,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0,0); /*X-overwrites-A*/}
  127264. break;
  127265. case 111: /* joinop ::= JOIN_KW nm nm JOIN */
  127266. {yymsp[-3].minor.yy194 = sqlite3JoinType(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0);/*X-overwrites-A*/}
  127267. break;
  127268. case 112: /* on_opt ::= ON expr */
  127269. case 129: /* having_opt ::= HAVING expr */ yytestcase(yyruleno==129);
  127270. case 136: /* where_opt ::= WHERE expr */ yytestcase(yyruleno==136);
  127271. case 199: /* case_else ::= ELSE expr */ yytestcase(yyruleno==199);
  127272. {yymsp[-1].minor.yy72 = yymsp[0].minor.yy190.pExpr;}
  127273. break;
  127274. case 113: /* on_opt ::= */
  127275. case 128: /* having_opt ::= */ yytestcase(yyruleno==128);
  127276. case 135: /* where_opt ::= */ yytestcase(yyruleno==135);
  127277. case 200: /* case_else ::= */ yytestcase(yyruleno==200);
  127278. case 202: /* case_operand ::= */ yytestcase(yyruleno==202);
  127279. {yymsp[1].minor.yy72 = 0;}
  127280. break;
  127281. case 115: /* indexed_opt ::= INDEXED BY nm */
  127282. {yymsp[-2].minor.yy0 = yymsp[0].minor.yy0;}
  127283. break;
  127284. case 116: /* indexed_opt ::= NOT INDEXED */
  127285. {yymsp[-1].minor.yy0.z=0; yymsp[-1].minor.yy0.n=1;}
  127286. break;
  127287. case 117: /* using_opt ::= USING LP idlist RP */
  127288. {yymsp[-3].minor.yy254 = yymsp[-1].minor.yy254;}
  127289. break;
  127290. case 118: /* using_opt ::= */
  127291. case 146: /* idlist_opt ::= */ yytestcase(yyruleno==146);
  127292. {yymsp[1].minor.yy254 = 0;}
  127293. break;
  127294. case 120: /* orderby_opt ::= ORDER BY sortlist */
  127295. case 127: /* groupby_opt ::= GROUP BY nexprlist */ yytestcase(yyruleno==127);
  127296. {yymsp[-2].minor.yy148 = yymsp[0].minor.yy148;}
  127297. break;
  127298. case 121: /* sortlist ::= sortlist COMMA expr sortorder */
  127299. {
  127300. yymsp[-3].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-3].minor.yy148,yymsp[-1].minor.yy190.pExpr);
  127301. sqlite3ExprListSetSortOrder(yymsp[-3].minor.yy148,yymsp[0].minor.yy194);
  127302. }
  127303. break;
  127304. case 122: /* sortlist ::= expr sortorder */
  127305. {
  127306. yymsp[-1].minor.yy148 = sqlite3ExprListAppend(pParse,0,yymsp[-1].minor.yy190.pExpr); /*A-overwrites-Y*/
  127307. sqlite3ExprListSetSortOrder(yymsp[-1].minor.yy148,yymsp[0].minor.yy194);
  127308. }
  127309. break;
  127310. case 123: /* sortorder ::= ASC */
  127311. {yymsp[0].minor.yy194 = SQLITE_SO_ASC;}
  127312. break;
  127313. case 124: /* sortorder ::= DESC */
  127314. {yymsp[0].minor.yy194 = SQLITE_SO_DESC;}
  127315. break;
  127316. case 125: /* sortorder ::= */
  127317. {yymsp[1].minor.yy194 = SQLITE_SO_UNDEFINED;}
  127318. break;
  127319. case 130: /* limit_opt ::= */
  127320. {yymsp[1].minor.yy354.pLimit = 0; yymsp[1].minor.yy354.pOffset = 0;}
  127321. break;
  127322. case 131: /* limit_opt ::= LIMIT expr */
  127323. {yymsp[-1].minor.yy354.pLimit = yymsp[0].minor.yy190.pExpr; yymsp[-1].minor.yy354.pOffset = 0;}
  127324. break;
  127325. case 132: /* limit_opt ::= LIMIT expr OFFSET expr */
  127326. {yymsp[-3].minor.yy354.pLimit = yymsp[-2].minor.yy190.pExpr; yymsp[-3].minor.yy354.pOffset = yymsp[0].minor.yy190.pExpr;}
  127327. break;
  127328. case 133: /* limit_opt ::= LIMIT expr COMMA expr */
  127329. {yymsp[-3].minor.yy354.pOffset = yymsp[-2].minor.yy190.pExpr; yymsp[-3].minor.yy354.pLimit = yymsp[0].minor.yy190.pExpr;}
  127330. break;
  127331. case 134: /* cmd ::= with DELETE FROM fullname indexed_opt where_opt */
  127332. {
  127333. sqlite3WithPush(pParse, yymsp[-5].minor.yy285, 1);
  127334. sqlite3SrcListIndexedBy(pParse, yymsp[-2].minor.yy185, &yymsp[-1].minor.yy0);
  127335. sqlite3DeleteFrom(pParse,yymsp[-2].minor.yy185,yymsp[0].minor.yy72);
  127336. }
  127337. break;
  127338. case 137: /* cmd ::= with UPDATE orconf fullname indexed_opt SET setlist where_opt */
  127339. {
  127340. sqlite3WithPush(pParse, yymsp[-7].minor.yy285, 1);
  127341. sqlite3SrcListIndexedBy(pParse, yymsp[-4].minor.yy185, &yymsp[-3].minor.yy0);
  127342. sqlite3ExprListCheckLength(pParse,yymsp[-1].minor.yy148,"set list");
  127343. sqlite3Update(pParse,yymsp[-4].minor.yy185,yymsp[-1].minor.yy148,yymsp[0].minor.yy72,yymsp[-5].minor.yy194);
  127344. }
  127345. break;
  127346. case 138: /* setlist ::= setlist COMMA nm EQ expr */
  127347. {
  127348. yymsp[-4].minor.yy148 = sqlite3ExprListAppend(pParse, yymsp[-4].minor.yy148, yymsp[0].minor.yy190.pExpr);
  127349. sqlite3ExprListSetName(pParse, yymsp[-4].minor.yy148, &yymsp[-2].minor.yy0, 1);
  127350. }
  127351. break;
  127352. case 139: /* setlist ::= setlist COMMA LP idlist RP EQ expr */
  127353. {
  127354. yymsp[-6].minor.yy148 = sqlite3ExprListAppendVector(pParse, yymsp[-6].minor.yy148, yymsp[-3].minor.yy254, yymsp[0].minor.yy190.pExpr);
  127355. }
  127356. break;
  127357. case 140: /* setlist ::= nm EQ expr */
  127358. {
  127359. yylhsminor.yy148 = sqlite3ExprListAppend(pParse, 0, yymsp[0].minor.yy190.pExpr);
  127360. sqlite3ExprListSetName(pParse, yylhsminor.yy148, &yymsp[-2].minor.yy0, 1);
  127361. }
  127362. yymsp[-2].minor.yy148 = yylhsminor.yy148;
  127363. break;
  127364. case 141: /* setlist ::= LP idlist RP EQ expr */
  127365. {
  127366. yymsp[-4].minor.yy148 = sqlite3ExprListAppendVector(pParse, 0, yymsp[-3].minor.yy254, yymsp[0].minor.yy190.pExpr);
  127367. }
  127368. break;
  127369. case 142: /* cmd ::= with insert_cmd INTO fullname idlist_opt select */
  127370. {
  127371. sqlite3WithPush(pParse, yymsp[-5].minor.yy285, 1);
  127372. sqlite3Insert(pParse, yymsp[-2].minor.yy185, yymsp[0].minor.yy243, yymsp[-1].minor.yy254, yymsp[-4].minor.yy194);
  127373. }
  127374. break;
  127375. case 143: /* cmd ::= with insert_cmd INTO fullname idlist_opt DEFAULT VALUES */
  127376. {
  127377. sqlite3WithPush(pParse, yymsp[-6].minor.yy285, 1);
  127378. sqlite3Insert(pParse, yymsp[-3].minor.yy185, 0, yymsp[-2].minor.yy254, yymsp[-5].minor.yy194);
  127379. }
  127380. break;
  127381. case 147: /* idlist_opt ::= LP idlist RP */
  127382. {yymsp[-2].minor.yy254 = yymsp[-1].minor.yy254;}
  127383. break;
  127384. case 148: /* idlist ::= idlist COMMA nm */
  127385. {yymsp[-2].minor.yy254 = sqlite3IdListAppend(pParse->db,yymsp[-2].minor.yy254,&yymsp[0].minor.yy0);}
  127386. break;
  127387. case 149: /* idlist ::= nm */
  127388. {yymsp[0].minor.yy254 = sqlite3IdListAppend(pParse->db,0,&yymsp[0].minor.yy0); /*A-overwrites-Y*/}
  127389. break;
  127390. case 150: /* expr ::= LP expr RP */
  127391. {spanSet(&yymsp[-2].minor.yy190,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-B*/ yymsp[-2].minor.yy190.pExpr = yymsp[-1].minor.yy190.pExpr;}
  127392. break;
  127393. case 151: /* term ::= NULL */
  127394. case 156: /* term ::= FLOAT|BLOB */ yytestcase(yyruleno==156);
  127395. case 157: /* term ::= STRING */ yytestcase(yyruleno==157);
  127396. {spanExpr(&yymsp[0].minor.yy190,pParse,yymsp[0].major,yymsp[0].minor.yy0);/*A-overwrites-X*/}
  127397. break;
  127398. case 152: /* expr ::= ID|INDEXED */
  127399. case 153: /* expr ::= JOIN_KW */ yytestcase(yyruleno==153);
  127400. {spanExpr(&yymsp[0].minor.yy190,pParse,TK_ID,yymsp[0].minor.yy0); /*A-overwrites-X*/}
  127401. break;
  127402. case 154: /* expr ::= nm DOT nm */
  127403. {
  127404. Expr *temp1 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-2].minor.yy0, 1);
  127405. Expr *temp2 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[0].minor.yy0, 1);
  127406. spanSet(&yymsp[-2].minor.yy190,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/
  127407. yymsp[-2].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_DOT, temp1, temp2, 0);
  127408. }
  127409. break;
  127410. case 155: /* expr ::= nm DOT nm DOT nm */
  127411. {
  127412. Expr *temp1 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-4].minor.yy0, 1);
  127413. Expr *temp2 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-2].minor.yy0, 1);
  127414. Expr *temp3 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[0].minor.yy0, 1);
  127415. Expr *temp4 = sqlite3PExpr(pParse, TK_DOT, temp2, temp3, 0);
  127416. spanSet(&yymsp[-4].minor.yy190,&yymsp[-4].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/
  127417. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_DOT, temp1, temp4, 0);
  127418. }
  127419. break;
  127420. case 158: /* term ::= INTEGER */
  127421. {
  127422. yylhsminor.yy190.pExpr = sqlite3ExprAlloc(pParse->db, TK_INTEGER, &yymsp[0].minor.yy0, 1);
  127423. yylhsminor.yy190.zStart = yymsp[0].minor.yy0.z;
  127424. yylhsminor.yy190.zEnd = yymsp[0].minor.yy0.z + yymsp[0].minor.yy0.n;
  127425. if( yylhsminor.yy190.pExpr ) yylhsminor.yy190.pExpr->flags |= EP_Leaf;
  127426. }
  127427. yymsp[0].minor.yy190 = yylhsminor.yy190;
  127428. break;
  127429. case 159: /* expr ::= VARIABLE */
  127430. {
  127431. if( !(yymsp[0].minor.yy0.z[0]=='#' && sqlite3Isdigit(yymsp[0].minor.yy0.z[1])) ){
  127432. u32 n = yymsp[0].minor.yy0.n;
  127433. spanExpr(&yymsp[0].minor.yy190, pParse, TK_VARIABLE, yymsp[0].minor.yy0);
  127434. sqlite3ExprAssignVarNumber(pParse, yymsp[0].minor.yy190.pExpr, n);
  127435. }else{
  127436. /* When doing a nested parse, one can include terms in an expression
  127437. ** that look like this: #1 #2 ... These terms refer to registers
  127438. ** in the virtual machine. #N is the N-th register. */
  127439. Token t = yymsp[0].minor.yy0; /*A-overwrites-X*/
  127440. assert( t.n>=2 );
  127441. spanSet(&yymsp[0].minor.yy190, &t, &t);
  127442. if( pParse->nested==0 ){
  127443. sqlite3ErrorMsg(pParse, "near \"%T\": syntax error", &t);
  127444. yymsp[0].minor.yy190.pExpr = 0;
  127445. }else{
  127446. yymsp[0].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_REGISTER, 0, 0, 0);
  127447. if( yymsp[0].minor.yy190.pExpr ) sqlite3GetInt32(&t.z[1], &yymsp[0].minor.yy190.pExpr->iTable);
  127448. }
  127449. }
  127450. }
  127451. break;
  127452. case 160: /* expr ::= expr COLLATE ID|STRING */
  127453. {
  127454. yymsp[-2].minor.yy190.pExpr = sqlite3ExprAddCollateToken(pParse, yymsp[-2].minor.yy190.pExpr, &yymsp[0].minor.yy0, 1);
  127455. yymsp[-2].minor.yy190.zEnd = &yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n];
  127456. }
  127457. break;
  127458. case 161: /* expr ::= CAST LP expr AS typetoken RP */
  127459. {
  127460. spanSet(&yymsp[-5].minor.yy190,&yymsp[-5].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/
  127461. yymsp[-5].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_CAST, yymsp[-3].minor.yy190.pExpr, 0, &yymsp[-1].minor.yy0);
  127462. }
  127463. break;
  127464. case 162: /* expr ::= ID|INDEXED LP distinct exprlist RP */
  127465. {
  127466. if( yymsp[-1].minor.yy148 && yymsp[-1].minor.yy148->nExpr>pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
  127467. sqlite3ErrorMsg(pParse, "too many arguments on function %T", &yymsp[-4].minor.yy0);
  127468. }
  127469. yylhsminor.yy190.pExpr = sqlite3ExprFunction(pParse, yymsp[-1].minor.yy148, &yymsp[-4].minor.yy0);
  127470. spanSet(&yylhsminor.yy190,&yymsp[-4].minor.yy0,&yymsp[0].minor.yy0);
  127471. if( yymsp[-2].minor.yy194==SF_Distinct && yylhsminor.yy190.pExpr ){
  127472. yylhsminor.yy190.pExpr->flags |= EP_Distinct;
  127473. }
  127474. }
  127475. yymsp[-4].minor.yy190 = yylhsminor.yy190;
  127476. break;
  127477. case 163: /* expr ::= ID|INDEXED LP STAR RP */
  127478. {
  127479. yylhsminor.yy190.pExpr = sqlite3ExprFunction(pParse, 0, &yymsp[-3].minor.yy0);
  127480. spanSet(&yylhsminor.yy190,&yymsp[-3].minor.yy0,&yymsp[0].minor.yy0);
  127481. }
  127482. yymsp[-3].minor.yy190 = yylhsminor.yy190;
  127483. break;
  127484. case 164: /* term ::= CTIME_KW */
  127485. {
  127486. yylhsminor.yy190.pExpr = sqlite3ExprFunction(pParse, 0, &yymsp[0].minor.yy0);
  127487. spanSet(&yylhsminor.yy190, &yymsp[0].minor.yy0, &yymsp[0].minor.yy0);
  127488. }
  127489. yymsp[0].minor.yy190 = yylhsminor.yy190;
  127490. break;
  127491. case 165: /* expr ::= LP nexprlist COMMA expr RP */
  127492. {
  127493. ExprList *pList = sqlite3ExprListAppend(pParse, yymsp[-3].minor.yy148, yymsp[-1].minor.yy190.pExpr);
  127494. yylhsminor.yy190.pExpr = sqlite3PExpr(pParse, TK_VECTOR, 0, 0, 0);
  127495. if( yylhsminor.yy190.pExpr ){
  127496. yylhsminor.yy190.pExpr->x.pList = pList;
  127497. spanSet(&yylhsminor.yy190, &yymsp[-4].minor.yy0, &yymsp[0].minor.yy0);
  127498. }else{
  127499. sqlite3ExprListDelete(pParse->db, pList);
  127500. }
  127501. }
  127502. yymsp[-4].minor.yy190 = yylhsminor.yy190;
  127503. break;
  127504. case 166: /* expr ::= expr AND expr */
  127505. case 167: /* expr ::= expr OR expr */ yytestcase(yyruleno==167);
  127506. case 168: /* expr ::= expr LT|GT|GE|LE expr */ yytestcase(yyruleno==168);
  127507. case 169: /* expr ::= expr EQ|NE expr */ yytestcase(yyruleno==169);
  127508. case 170: /* expr ::= expr BITAND|BITOR|LSHIFT|RSHIFT expr */ yytestcase(yyruleno==170);
  127509. case 171: /* expr ::= expr PLUS|MINUS expr */ yytestcase(yyruleno==171);
  127510. case 172: /* expr ::= expr STAR|SLASH|REM expr */ yytestcase(yyruleno==172);
  127511. case 173: /* expr ::= expr CONCAT expr */ yytestcase(yyruleno==173);
  127512. {spanBinaryExpr(pParse,yymsp[-1].major,&yymsp[-2].minor.yy190,&yymsp[0].minor.yy190);}
  127513. break;
  127514. case 174: /* likeop ::= LIKE_KW|MATCH */
  127515. {yymsp[0].minor.yy0=yymsp[0].minor.yy0;/*A-overwrites-X*/}
  127516. break;
  127517. case 175: /* likeop ::= NOT LIKE_KW|MATCH */
  127518. {yymsp[-1].minor.yy0=yymsp[0].minor.yy0; yymsp[-1].minor.yy0.n|=0x80000000; /*yymsp[-1].minor.yy0-overwrite-yymsp[0].minor.yy0*/}
  127519. break;
  127520. case 176: /* expr ::= expr likeop expr */
  127521. {
  127522. ExprList *pList;
  127523. int bNot = yymsp[-1].minor.yy0.n & 0x80000000;
  127524. yymsp[-1].minor.yy0.n &= 0x7fffffff;
  127525. pList = sqlite3ExprListAppend(pParse,0, yymsp[0].minor.yy190.pExpr);
  127526. pList = sqlite3ExprListAppend(pParse,pList, yymsp[-2].minor.yy190.pExpr);
  127527. yymsp[-2].minor.yy190.pExpr = sqlite3ExprFunction(pParse, pList, &yymsp[-1].minor.yy0);
  127528. exprNot(pParse, bNot, &yymsp[-2].minor.yy190);
  127529. yymsp[-2].minor.yy190.zEnd = yymsp[0].minor.yy190.zEnd;
  127530. if( yymsp[-2].minor.yy190.pExpr ) yymsp[-2].minor.yy190.pExpr->flags |= EP_InfixFunc;
  127531. }
  127532. break;
  127533. case 177: /* expr ::= expr likeop expr ESCAPE expr */
  127534. {
  127535. ExprList *pList;
  127536. int bNot = yymsp[-3].minor.yy0.n & 0x80000000;
  127537. yymsp[-3].minor.yy0.n &= 0x7fffffff;
  127538. pList = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy190.pExpr);
  127539. pList = sqlite3ExprListAppend(pParse,pList, yymsp[-4].minor.yy190.pExpr);
  127540. pList = sqlite3ExprListAppend(pParse,pList, yymsp[0].minor.yy190.pExpr);
  127541. yymsp[-4].minor.yy190.pExpr = sqlite3ExprFunction(pParse, pList, &yymsp[-3].minor.yy0);
  127542. exprNot(pParse, bNot, &yymsp[-4].minor.yy190);
  127543. yymsp[-4].minor.yy190.zEnd = yymsp[0].minor.yy190.zEnd;
  127544. if( yymsp[-4].minor.yy190.pExpr ) yymsp[-4].minor.yy190.pExpr->flags |= EP_InfixFunc;
  127545. }
  127546. break;
  127547. case 178: /* expr ::= expr ISNULL|NOTNULL */
  127548. {spanUnaryPostfix(pParse,yymsp[0].major,&yymsp[-1].minor.yy190,&yymsp[0].minor.yy0);}
  127549. break;
  127550. case 179: /* expr ::= expr NOT NULL */
  127551. {spanUnaryPostfix(pParse,TK_NOTNULL,&yymsp[-2].minor.yy190,&yymsp[0].minor.yy0);}
  127552. break;
  127553. case 180: /* expr ::= expr IS expr */
  127554. {
  127555. spanBinaryExpr(pParse,TK_IS,&yymsp[-2].minor.yy190,&yymsp[0].minor.yy190);
  127556. binaryToUnaryIfNull(pParse, yymsp[0].minor.yy190.pExpr, yymsp[-2].minor.yy190.pExpr, TK_ISNULL);
  127557. }
  127558. break;
  127559. case 181: /* expr ::= expr IS NOT expr */
  127560. {
  127561. spanBinaryExpr(pParse,TK_ISNOT,&yymsp[-3].minor.yy190,&yymsp[0].minor.yy190);
  127562. binaryToUnaryIfNull(pParse, yymsp[0].minor.yy190.pExpr, yymsp[-3].minor.yy190.pExpr, TK_NOTNULL);
  127563. }
  127564. break;
  127565. case 182: /* expr ::= NOT expr */
  127566. case 183: /* expr ::= BITNOT expr */ yytestcase(yyruleno==183);
  127567. {spanUnaryPrefix(&yymsp[-1].minor.yy190,pParse,yymsp[-1].major,&yymsp[0].minor.yy190,&yymsp[-1].minor.yy0);/*A-overwrites-B*/}
  127568. break;
  127569. case 184: /* expr ::= MINUS expr */
  127570. {spanUnaryPrefix(&yymsp[-1].minor.yy190,pParse,TK_UMINUS,&yymsp[0].minor.yy190,&yymsp[-1].minor.yy0);/*A-overwrites-B*/}
  127571. break;
  127572. case 185: /* expr ::= PLUS expr */
  127573. {spanUnaryPrefix(&yymsp[-1].minor.yy190,pParse,TK_UPLUS,&yymsp[0].minor.yy190,&yymsp[-1].minor.yy0);/*A-overwrites-B*/}
  127574. break;
  127575. case 186: /* between_op ::= BETWEEN */
  127576. case 189: /* in_op ::= IN */ yytestcase(yyruleno==189);
  127577. {yymsp[0].minor.yy194 = 0;}
  127578. break;
  127579. case 188: /* expr ::= expr between_op expr AND expr */
  127580. {
  127581. ExprList *pList = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy190.pExpr);
  127582. pList = sqlite3ExprListAppend(pParse,pList, yymsp[0].minor.yy190.pExpr);
  127583. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_BETWEEN, yymsp[-4].minor.yy190.pExpr, 0, 0);
  127584. if( yymsp[-4].minor.yy190.pExpr ){
  127585. yymsp[-4].minor.yy190.pExpr->x.pList = pList;
  127586. }else{
  127587. sqlite3ExprListDelete(pParse->db, pList);
  127588. }
  127589. exprNot(pParse, yymsp[-3].minor.yy194, &yymsp[-4].minor.yy190);
  127590. yymsp[-4].minor.yy190.zEnd = yymsp[0].minor.yy190.zEnd;
  127591. }
  127592. break;
  127593. case 191: /* expr ::= expr in_op LP exprlist RP */
  127594. {
  127595. if( yymsp[-1].minor.yy148==0 ){
  127596. /* Expressions of the form
  127597. **
  127598. ** expr1 IN ()
  127599. ** expr1 NOT IN ()
  127600. **
  127601. ** simplify to constants 0 (false) and 1 (true), respectively,
  127602. ** regardless of the value of expr1.
  127603. */
  127604. sqlite3ExprDelete(pParse->db, yymsp[-4].minor.yy190.pExpr);
  127605. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_INTEGER, 0, 0, &sqlite3IntTokens[yymsp[-3].minor.yy194]);
  127606. }else if( yymsp[-1].minor.yy148->nExpr==1 ){
  127607. /* Expressions of the form:
  127608. **
  127609. ** expr1 IN (?1)
  127610. ** expr1 NOT IN (?2)
  127611. **
  127612. ** with exactly one value on the RHS can be simplified to something
  127613. ** like this:
  127614. **
  127615. ** expr1 == ?1
  127616. ** expr1 <> ?2
  127617. **
  127618. ** But, the RHS of the == or <> is marked with the EP_Generic flag
  127619. ** so that it may not contribute to the computation of comparison
  127620. ** affinity or the collating sequence to use for comparison. Otherwise,
  127621. ** the semantics would be subtly different from IN or NOT IN.
  127622. */
  127623. Expr *pRHS = yymsp[-1].minor.yy148->a[0].pExpr;
  127624. yymsp[-1].minor.yy148->a[0].pExpr = 0;
  127625. sqlite3ExprListDelete(pParse->db, yymsp[-1].minor.yy148);
  127626. /* pRHS cannot be NULL because a malloc error would have been detected
  127627. ** before now and control would have never reached this point */
  127628. if( ALWAYS(pRHS) ){
  127629. pRHS->flags &= ~EP_Collate;
  127630. pRHS->flags |= EP_Generic;
  127631. }
  127632. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, yymsp[-3].minor.yy194 ? TK_NE : TK_EQ, yymsp[-4].minor.yy190.pExpr, pRHS, 0);
  127633. }else{
  127634. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy190.pExpr, 0, 0);
  127635. if( yymsp[-4].minor.yy190.pExpr ){
  127636. yymsp[-4].minor.yy190.pExpr->x.pList = yymsp[-1].minor.yy148;
  127637. sqlite3ExprSetHeightAndFlags(pParse, yymsp[-4].minor.yy190.pExpr);
  127638. }else{
  127639. sqlite3ExprListDelete(pParse->db, yymsp[-1].minor.yy148);
  127640. }
  127641. exprNot(pParse, yymsp[-3].minor.yy194, &yymsp[-4].minor.yy190);
  127642. }
  127643. yymsp[-4].minor.yy190.zEnd = &yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n];
  127644. }
  127645. break;
  127646. case 192: /* expr ::= LP select RP */
  127647. {
  127648. spanSet(&yymsp[-2].minor.yy190,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-B*/
  127649. yymsp[-2].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_SELECT, 0, 0, 0);
  127650. sqlite3PExprAddSelect(pParse, yymsp[-2].minor.yy190.pExpr, yymsp[-1].minor.yy243);
  127651. }
  127652. break;
  127653. case 193: /* expr ::= expr in_op LP select RP */
  127654. {
  127655. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy190.pExpr, 0, 0);
  127656. sqlite3PExprAddSelect(pParse, yymsp[-4].minor.yy190.pExpr, yymsp[-1].minor.yy243);
  127657. exprNot(pParse, yymsp[-3].minor.yy194, &yymsp[-4].minor.yy190);
  127658. yymsp[-4].minor.yy190.zEnd = &yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n];
  127659. }
  127660. break;
  127661. case 194: /* expr ::= expr in_op nm dbnm paren_exprlist */
  127662. {
  127663. SrcList *pSrc = sqlite3SrcListAppend(pParse->db, 0,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0);
  127664. Select *pSelect = sqlite3SelectNew(pParse, 0,pSrc,0,0,0,0,0,0,0);
  127665. if( yymsp[0].minor.yy148 ) sqlite3SrcListFuncArgs(pParse, pSelect ? pSrc : 0, yymsp[0].minor.yy148);
  127666. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy190.pExpr, 0, 0);
  127667. sqlite3PExprAddSelect(pParse, yymsp[-4].minor.yy190.pExpr, pSelect);
  127668. exprNot(pParse, yymsp[-3].minor.yy194, &yymsp[-4].minor.yy190);
  127669. yymsp[-4].minor.yy190.zEnd = yymsp[-1].minor.yy0.z ? &yymsp[-1].minor.yy0.z[yymsp[-1].minor.yy0.n] : &yymsp[-2].minor.yy0.z[yymsp[-2].minor.yy0.n];
  127670. }
  127671. break;
  127672. case 195: /* expr ::= EXISTS LP select RP */
  127673. {
  127674. Expr *p;
  127675. spanSet(&yymsp[-3].minor.yy190,&yymsp[-3].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-B*/
  127676. p = yymsp[-3].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_EXISTS, 0, 0, 0);
  127677. sqlite3PExprAddSelect(pParse, p, yymsp[-1].minor.yy243);
  127678. }
  127679. break;
  127680. case 196: /* expr ::= CASE case_operand case_exprlist case_else END */
  127681. {
  127682. spanSet(&yymsp[-4].minor.yy190,&yymsp[-4].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-C*/
  127683. yymsp[-4].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_CASE, yymsp[-3].minor.yy72, 0, 0);
  127684. if( yymsp[-4].minor.yy190.pExpr ){
  127685. yymsp[-4].minor.yy190.pExpr->x.pList = yymsp[-1].minor.yy72 ? sqlite3ExprListAppend(pParse,yymsp[-2].minor.yy148,yymsp[-1].minor.yy72) : yymsp[-2].minor.yy148;
  127686. sqlite3ExprSetHeightAndFlags(pParse, yymsp[-4].minor.yy190.pExpr);
  127687. }else{
  127688. sqlite3ExprListDelete(pParse->db, yymsp[-2].minor.yy148);
  127689. sqlite3ExprDelete(pParse->db, yymsp[-1].minor.yy72);
  127690. }
  127691. }
  127692. break;
  127693. case 197: /* case_exprlist ::= case_exprlist WHEN expr THEN expr */
  127694. {
  127695. yymsp[-4].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-4].minor.yy148, yymsp[-2].minor.yy190.pExpr);
  127696. yymsp[-4].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-4].minor.yy148, yymsp[0].minor.yy190.pExpr);
  127697. }
  127698. break;
  127699. case 198: /* case_exprlist ::= WHEN expr THEN expr */
  127700. {
  127701. yymsp[-3].minor.yy148 = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy190.pExpr);
  127702. yymsp[-3].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-3].minor.yy148, yymsp[0].minor.yy190.pExpr);
  127703. }
  127704. break;
  127705. case 201: /* case_operand ::= expr */
  127706. {yymsp[0].minor.yy72 = yymsp[0].minor.yy190.pExpr; /*A-overwrites-X*/}
  127707. break;
  127708. case 204: /* nexprlist ::= nexprlist COMMA expr */
  127709. {yymsp[-2].minor.yy148 = sqlite3ExprListAppend(pParse,yymsp[-2].minor.yy148,yymsp[0].minor.yy190.pExpr);}
  127710. break;
  127711. case 205: /* nexprlist ::= expr */
  127712. {yymsp[0].minor.yy148 = sqlite3ExprListAppend(pParse,0,yymsp[0].minor.yy190.pExpr); /*A-overwrites-Y*/}
  127713. break;
  127714. case 207: /* paren_exprlist ::= LP exprlist RP */
  127715. case 212: /* eidlist_opt ::= LP eidlist RP */ yytestcase(yyruleno==212);
  127716. {yymsp[-2].minor.yy148 = yymsp[-1].minor.yy148;}
  127717. break;
  127718. case 208: /* cmd ::= createkw uniqueflag INDEX ifnotexists nm dbnm ON nm LP sortlist RP where_opt */
  127719. {
  127720. sqlite3CreateIndex(pParse, &yymsp[-7].minor.yy0, &yymsp[-6].minor.yy0,
  127721. sqlite3SrcListAppend(pParse->db,0,&yymsp[-4].minor.yy0,0), yymsp[-2].minor.yy148, yymsp[-10].minor.yy194,
  127722. &yymsp[-11].minor.yy0, yymsp[0].minor.yy72, SQLITE_SO_ASC, yymsp[-8].minor.yy194, SQLITE_IDXTYPE_APPDEF);
  127723. }
  127724. break;
  127725. case 209: /* uniqueflag ::= UNIQUE */
  127726. case 250: /* raisetype ::= ABORT */ yytestcase(yyruleno==250);
  127727. {yymsp[0].minor.yy194 = OE_Abort;}
  127728. break;
  127729. case 210: /* uniqueflag ::= */
  127730. {yymsp[1].minor.yy194 = OE_None;}
  127731. break;
  127732. case 213: /* eidlist ::= eidlist COMMA nm collate sortorder */
  127733. {
  127734. yymsp[-4].minor.yy148 = parserAddExprIdListTerm(pParse, yymsp[-4].minor.yy148, &yymsp[-2].minor.yy0, yymsp[-1].minor.yy194, yymsp[0].minor.yy194);
  127735. }
  127736. break;
  127737. case 214: /* eidlist ::= nm collate sortorder */
  127738. {
  127739. yymsp[-2].minor.yy148 = parserAddExprIdListTerm(pParse, 0, &yymsp[-2].minor.yy0, yymsp[-1].minor.yy194, yymsp[0].minor.yy194); /*A-overwrites-Y*/
  127740. }
  127741. break;
  127742. case 217: /* cmd ::= DROP INDEX ifexists fullname */
  127743. {sqlite3DropIndex(pParse, yymsp[0].minor.yy185, yymsp[-1].minor.yy194);}
  127744. break;
  127745. case 218: /* cmd ::= VACUUM */
  127746. {sqlite3Vacuum(pParse,0);}
  127747. break;
  127748. case 219: /* cmd ::= VACUUM nm */
  127749. {sqlite3Vacuum(pParse,&yymsp[0].minor.yy0);}
  127750. break;
  127751. case 220: /* cmd ::= PRAGMA nm dbnm */
  127752. {sqlite3Pragma(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0,0,0);}
  127753. break;
  127754. case 221: /* cmd ::= PRAGMA nm dbnm EQ nmnum */
  127755. {sqlite3Pragma(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0,0);}
  127756. break;
  127757. case 222: /* cmd ::= PRAGMA nm dbnm LP nmnum RP */
  127758. {sqlite3Pragma(pParse,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,&yymsp[-1].minor.yy0,0);}
  127759. break;
  127760. case 223: /* cmd ::= PRAGMA nm dbnm EQ minus_num */
  127761. {sqlite3Pragma(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0,1);}
  127762. break;
  127763. case 224: /* cmd ::= PRAGMA nm dbnm LP minus_num RP */
  127764. {sqlite3Pragma(pParse,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,&yymsp[-1].minor.yy0,1);}
  127765. break;
  127766. case 227: /* cmd ::= createkw trigger_decl BEGIN trigger_cmd_list END */
  127767. {
  127768. Token all;
  127769. all.z = yymsp[-3].minor.yy0.z;
  127770. all.n = (int)(yymsp[0].minor.yy0.z - yymsp[-3].minor.yy0.z) + yymsp[0].minor.yy0.n;
  127771. sqlite3FinishTrigger(pParse, yymsp[-1].minor.yy145, &all);
  127772. }
  127773. break;
  127774. case 228: /* trigger_decl ::= temp TRIGGER ifnotexists nm dbnm trigger_time trigger_event ON fullname foreach_clause when_clause */
  127775. {
  127776. sqlite3BeginTrigger(pParse, &yymsp[-7].minor.yy0, &yymsp[-6].minor.yy0, yymsp[-5].minor.yy194, yymsp[-4].minor.yy332.a, yymsp[-4].minor.yy332.b, yymsp[-2].minor.yy185, yymsp[0].minor.yy72, yymsp[-10].minor.yy194, yymsp[-8].minor.yy194);
  127777. yymsp[-10].minor.yy0 = (yymsp[-6].minor.yy0.n==0?yymsp[-7].minor.yy0:yymsp[-6].minor.yy0); /*A-overwrites-T*/
  127778. }
  127779. break;
  127780. case 229: /* trigger_time ::= BEFORE */
  127781. { yymsp[0].minor.yy194 = TK_BEFORE; }
  127782. break;
  127783. case 230: /* trigger_time ::= AFTER */
  127784. { yymsp[0].minor.yy194 = TK_AFTER; }
  127785. break;
  127786. case 231: /* trigger_time ::= INSTEAD OF */
  127787. { yymsp[-1].minor.yy194 = TK_INSTEAD;}
  127788. break;
  127789. case 232: /* trigger_time ::= */
  127790. { yymsp[1].minor.yy194 = TK_BEFORE; }
  127791. break;
  127792. case 233: /* trigger_event ::= DELETE|INSERT */
  127793. case 234: /* trigger_event ::= UPDATE */ yytestcase(yyruleno==234);
  127794. {yymsp[0].minor.yy332.a = yymsp[0].major; /*A-overwrites-X*/ yymsp[0].minor.yy332.b = 0;}
  127795. break;
  127796. case 235: /* trigger_event ::= UPDATE OF idlist */
  127797. {yymsp[-2].minor.yy332.a = TK_UPDATE; yymsp[-2].minor.yy332.b = yymsp[0].minor.yy254;}
  127798. break;
  127799. case 236: /* when_clause ::= */
  127800. case 255: /* key_opt ::= */ yytestcase(yyruleno==255);
  127801. { yymsp[1].minor.yy72 = 0; }
  127802. break;
  127803. case 237: /* when_clause ::= WHEN expr */
  127804. case 256: /* key_opt ::= KEY expr */ yytestcase(yyruleno==256);
  127805. { yymsp[-1].minor.yy72 = yymsp[0].minor.yy190.pExpr; }
  127806. break;
  127807. case 238: /* trigger_cmd_list ::= trigger_cmd_list trigger_cmd SEMI */
  127808. {
  127809. assert( yymsp[-2].minor.yy145!=0 );
  127810. yymsp[-2].minor.yy145->pLast->pNext = yymsp[-1].minor.yy145;
  127811. yymsp[-2].minor.yy145->pLast = yymsp[-1].minor.yy145;
  127812. }
  127813. break;
  127814. case 239: /* trigger_cmd_list ::= trigger_cmd SEMI */
  127815. {
  127816. assert( yymsp[-1].minor.yy145!=0 );
  127817. yymsp[-1].minor.yy145->pLast = yymsp[-1].minor.yy145;
  127818. }
  127819. break;
  127820. case 240: /* trnm ::= nm DOT nm */
  127821. {
  127822. yymsp[-2].minor.yy0 = yymsp[0].minor.yy0;
  127823. sqlite3ErrorMsg(pParse,
  127824. "qualified table names are not allowed on INSERT, UPDATE, and DELETE "
  127825. "statements within triggers");
  127826. }
  127827. break;
  127828. case 241: /* tridxby ::= INDEXED BY nm */
  127829. {
  127830. sqlite3ErrorMsg(pParse,
  127831. "the INDEXED BY clause is not allowed on UPDATE or DELETE statements "
  127832. "within triggers");
  127833. }
  127834. break;
  127835. case 242: /* tridxby ::= NOT INDEXED */
  127836. {
  127837. sqlite3ErrorMsg(pParse,
  127838. "the NOT INDEXED clause is not allowed on UPDATE or DELETE statements "
  127839. "within triggers");
  127840. }
  127841. break;
  127842. case 243: /* trigger_cmd ::= UPDATE orconf trnm tridxby SET setlist where_opt */
  127843. {yymsp[-6].minor.yy145 = sqlite3TriggerUpdateStep(pParse->db, &yymsp[-4].minor.yy0, yymsp[-1].minor.yy148, yymsp[0].minor.yy72, yymsp[-5].minor.yy194);}
  127844. break;
  127845. case 244: /* trigger_cmd ::= insert_cmd INTO trnm idlist_opt select */
  127846. {yymsp[-4].minor.yy145 = sqlite3TriggerInsertStep(pParse->db, &yymsp[-2].minor.yy0, yymsp[-1].minor.yy254, yymsp[0].minor.yy243, yymsp[-4].minor.yy194);/*A-overwrites-R*/}
  127847. break;
  127848. case 245: /* trigger_cmd ::= DELETE FROM trnm tridxby where_opt */
  127849. {yymsp[-4].minor.yy145 = sqlite3TriggerDeleteStep(pParse->db, &yymsp[-2].minor.yy0, yymsp[0].minor.yy72);}
  127850. break;
  127851. case 246: /* trigger_cmd ::= select */
  127852. {yymsp[0].minor.yy145 = sqlite3TriggerSelectStep(pParse->db, yymsp[0].minor.yy243); /*A-overwrites-X*/}
  127853. break;
  127854. case 247: /* expr ::= RAISE LP IGNORE RP */
  127855. {
  127856. spanSet(&yymsp[-3].minor.yy190,&yymsp[-3].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/
  127857. yymsp[-3].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_RAISE, 0, 0, 0);
  127858. if( yymsp[-3].minor.yy190.pExpr ){
  127859. yymsp[-3].minor.yy190.pExpr->affinity = OE_Ignore;
  127860. }
  127861. }
  127862. break;
  127863. case 248: /* expr ::= RAISE LP raisetype COMMA nm RP */
  127864. {
  127865. spanSet(&yymsp[-5].minor.yy190,&yymsp[-5].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/
  127866. yymsp[-5].minor.yy190.pExpr = sqlite3PExpr(pParse, TK_RAISE, 0, 0, &yymsp[-1].minor.yy0);
  127867. if( yymsp[-5].minor.yy190.pExpr ) {
  127868. yymsp[-5].minor.yy190.pExpr->affinity = (char)yymsp[-3].minor.yy194;
  127869. }
  127870. }
  127871. break;
  127872. case 249: /* raisetype ::= ROLLBACK */
  127873. {yymsp[0].minor.yy194 = OE_Rollback;}
  127874. break;
  127875. case 251: /* raisetype ::= FAIL */
  127876. {yymsp[0].minor.yy194 = OE_Fail;}
  127877. break;
  127878. case 252: /* cmd ::= DROP TRIGGER ifexists fullname */
  127879. {
  127880. sqlite3DropTrigger(pParse,yymsp[0].minor.yy185,yymsp[-1].minor.yy194);
  127881. }
  127882. break;
  127883. case 253: /* cmd ::= ATTACH database_kw_opt expr AS expr key_opt */
  127884. {
  127885. sqlite3Attach(pParse, yymsp[-3].minor.yy190.pExpr, yymsp[-1].minor.yy190.pExpr, yymsp[0].minor.yy72);
  127886. }
  127887. break;
  127888. case 254: /* cmd ::= DETACH database_kw_opt expr */
  127889. {
  127890. sqlite3Detach(pParse, yymsp[0].minor.yy190.pExpr);
  127891. }
  127892. break;
  127893. case 257: /* cmd ::= REINDEX */
  127894. {sqlite3Reindex(pParse, 0, 0);}
  127895. break;
  127896. case 258: /* cmd ::= REINDEX nm dbnm */
  127897. {sqlite3Reindex(pParse, &yymsp[-1].minor.yy0, &yymsp[0].minor.yy0);}
  127898. break;
  127899. case 259: /* cmd ::= ANALYZE */
  127900. {sqlite3Analyze(pParse, 0, 0);}
  127901. break;
  127902. case 260: /* cmd ::= ANALYZE nm dbnm */
  127903. {sqlite3Analyze(pParse, &yymsp[-1].minor.yy0, &yymsp[0].minor.yy0);}
  127904. break;
  127905. case 261: /* cmd ::= ALTER TABLE fullname RENAME TO nm */
  127906. {
  127907. sqlite3AlterRenameTable(pParse,yymsp[-3].minor.yy185,&yymsp[0].minor.yy0);
  127908. }
  127909. break;
  127910. case 262: /* cmd ::= ALTER TABLE add_column_fullname ADD kwcolumn_opt columnname carglist */
  127911. {
  127912. yymsp[-1].minor.yy0.n = (int)(pParse->sLastToken.z-yymsp[-1].minor.yy0.z) + pParse->sLastToken.n;
  127913. sqlite3AlterFinishAddColumn(pParse, &yymsp[-1].minor.yy0);
  127914. }
  127915. break;
  127916. case 263: /* add_column_fullname ::= fullname */
  127917. {
  127918. disableLookaside(pParse);
  127919. sqlite3AlterBeginAddColumn(pParse, yymsp[0].minor.yy185);
  127920. }
  127921. break;
  127922. case 264: /* cmd ::= create_vtab */
  127923. {sqlite3VtabFinishParse(pParse,0);}
  127924. break;
  127925. case 265: /* cmd ::= create_vtab LP vtabarglist RP */
  127926. {sqlite3VtabFinishParse(pParse,&yymsp[0].minor.yy0);}
  127927. break;
  127928. case 266: /* create_vtab ::= createkw VIRTUAL TABLE ifnotexists nm dbnm USING nm */
  127929. {
  127930. sqlite3VtabBeginParse(pParse, &yymsp[-3].minor.yy0, &yymsp[-2].minor.yy0, &yymsp[0].minor.yy0, yymsp[-4].minor.yy194);
  127931. }
  127932. break;
  127933. case 267: /* vtabarg ::= */
  127934. {sqlite3VtabArgInit(pParse);}
  127935. break;
  127936. case 268: /* vtabargtoken ::= ANY */
  127937. case 269: /* vtabargtoken ::= lp anylist RP */ yytestcase(yyruleno==269);
  127938. case 270: /* lp ::= LP */ yytestcase(yyruleno==270);
  127939. {sqlite3VtabArgExtend(pParse,&yymsp[0].minor.yy0);}
  127940. break;
  127941. case 271: /* with ::= */
  127942. {yymsp[1].minor.yy285 = 0;}
  127943. break;
  127944. case 272: /* with ::= WITH wqlist */
  127945. { yymsp[-1].minor.yy285 = yymsp[0].minor.yy285; }
  127946. break;
  127947. case 273: /* with ::= WITH RECURSIVE wqlist */
  127948. { yymsp[-2].minor.yy285 = yymsp[0].minor.yy285; }
  127949. break;
  127950. case 274: /* wqlist ::= nm eidlist_opt AS LP select RP */
  127951. {
  127952. yymsp[-5].minor.yy285 = sqlite3WithAdd(pParse, 0, &yymsp[-5].minor.yy0, yymsp[-4].minor.yy148, yymsp[-1].minor.yy243); /*A-overwrites-X*/
  127953. }
  127954. break;
  127955. case 275: /* wqlist ::= wqlist COMMA nm eidlist_opt AS LP select RP */
  127956. {
  127957. yymsp[-7].minor.yy285 = sqlite3WithAdd(pParse, yymsp[-7].minor.yy285, &yymsp[-5].minor.yy0, yymsp[-4].minor.yy148, yymsp[-1].minor.yy243);
  127958. }
  127959. break;
  127960. default:
  127961. /* (276) input ::= cmdlist */ yytestcase(yyruleno==276);
  127962. /* (277) cmdlist ::= cmdlist ecmd */ yytestcase(yyruleno==277);
  127963. /* (278) cmdlist ::= ecmd (OPTIMIZED OUT) */ assert(yyruleno!=278);
  127964. /* (279) ecmd ::= SEMI */ yytestcase(yyruleno==279);
  127965. /* (280) ecmd ::= explain cmdx SEMI */ yytestcase(yyruleno==280);
  127966. /* (281) explain ::= */ yytestcase(yyruleno==281);
  127967. /* (282) trans_opt ::= */ yytestcase(yyruleno==282);
  127968. /* (283) trans_opt ::= TRANSACTION */ yytestcase(yyruleno==283);
  127969. /* (284) trans_opt ::= TRANSACTION nm */ yytestcase(yyruleno==284);
  127970. /* (285) savepoint_opt ::= SAVEPOINT */ yytestcase(yyruleno==285);
  127971. /* (286) savepoint_opt ::= */ yytestcase(yyruleno==286);
  127972. /* (287) cmd ::= create_table create_table_args */ yytestcase(yyruleno==287);
  127973. /* (288) columnlist ::= columnlist COMMA columnname carglist */ yytestcase(yyruleno==288);
  127974. /* (289) columnlist ::= columnname carglist */ yytestcase(yyruleno==289);
  127975. /* (290) nm ::= ID|INDEXED */ yytestcase(yyruleno==290);
  127976. /* (291) nm ::= STRING */ yytestcase(yyruleno==291);
  127977. /* (292) nm ::= JOIN_KW */ yytestcase(yyruleno==292);
  127978. /* (293) typetoken ::= typename */ yytestcase(yyruleno==293);
  127979. /* (294) typename ::= ID|STRING */ yytestcase(yyruleno==294);
  127980. /* (295) signed ::= plus_num (OPTIMIZED OUT) */ assert(yyruleno!=295);
  127981. /* (296) signed ::= minus_num (OPTIMIZED OUT) */ assert(yyruleno!=296);
  127982. /* (297) carglist ::= carglist ccons */ yytestcase(yyruleno==297);
  127983. /* (298) carglist ::= */ yytestcase(yyruleno==298);
  127984. /* (299) ccons ::= NULL onconf */ yytestcase(yyruleno==299);
  127985. /* (300) conslist_opt ::= COMMA conslist */ yytestcase(yyruleno==300);
  127986. /* (301) conslist ::= conslist tconscomma tcons */ yytestcase(yyruleno==301);
  127987. /* (302) conslist ::= tcons (OPTIMIZED OUT) */ assert(yyruleno!=302);
  127988. /* (303) tconscomma ::= */ yytestcase(yyruleno==303);
  127989. /* (304) defer_subclause_opt ::= defer_subclause (OPTIMIZED OUT) */ assert(yyruleno!=304);
  127990. /* (305) resolvetype ::= raisetype (OPTIMIZED OUT) */ assert(yyruleno!=305);
  127991. /* (306) selectnowith ::= oneselect (OPTIMIZED OUT) */ assert(yyruleno!=306);
  127992. /* (307) oneselect ::= values */ yytestcase(yyruleno==307);
  127993. /* (308) sclp ::= selcollist COMMA */ yytestcase(yyruleno==308);
  127994. /* (309) as ::= ID|STRING */ yytestcase(yyruleno==309);
  127995. /* (310) expr ::= term (OPTIMIZED OUT) */ assert(yyruleno!=310);
  127996. /* (311) exprlist ::= nexprlist */ yytestcase(yyruleno==311);
  127997. /* (312) nmnum ::= plus_num (OPTIMIZED OUT) */ assert(yyruleno!=312);
  127998. /* (313) nmnum ::= nm (OPTIMIZED OUT) */ assert(yyruleno!=313);
  127999. /* (314) nmnum ::= ON */ yytestcase(yyruleno==314);
  128000. /* (315) nmnum ::= DELETE */ yytestcase(yyruleno==315);
  128001. /* (316) nmnum ::= DEFAULT */ yytestcase(yyruleno==316);
  128002. /* (317) plus_num ::= INTEGER|FLOAT */ yytestcase(yyruleno==317);
  128003. /* (318) foreach_clause ::= */ yytestcase(yyruleno==318);
  128004. /* (319) foreach_clause ::= FOR EACH ROW */ yytestcase(yyruleno==319);
  128005. /* (320) trnm ::= nm */ yytestcase(yyruleno==320);
  128006. /* (321) tridxby ::= */ yytestcase(yyruleno==321);
  128007. /* (322) database_kw_opt ::= DATABASE */ yytestcase(yyruleno==322);
  128008. /* (323) database_kw_opt ::= */ yytestcase(yyruleno==323);
  128009. /* (324) kwcolumn_opt ::= */ yytestcase(yyruleno==324);
  128010. /* (325) kwcolumn_opt ::= COLUMNKW */ yytestcase(yyruleno==325);
  128011. /* (326) vtabarglist ::= vtabarg */ yytestcase(yyruleno==326);
  128012. /* (327) vtabarglist ::= vtabarglist COMMA vtabarg */ yytestcase(yyruleno==327);
  128013. /* (328) vtabarg ::= vtabarg vtabargtoken */ yytestcase(yyruleno==328);
  128014. /* (329) anylist ::= */ yytestcase(yyruleno==329);
  128015. /* (330) anylist ::= anylist LP anylist RP */ yytestcase(yyruleno==330);
  128016. /* (331) anylist ::= anylist ANY */ yytestcase(yyruleno==331);
  128017. break;
  128018. /********** End reduce actions ************************************************/
  128019. };
  128020. assert( yyruleno<sizeof(yyRuleInfo)/sizeof(yyRuleInfo[0]) );
  128021. yygoto = yyRuleInfo[yyruleno].lhs;
  128022. yysize = yyRuleInfo[yyruleno].nrhs;
  128023. yyact = yy_find_reduce_action(yymsp[-yysize].stateno,(YYCODETYPE)yygoto);
  128024. if( yyact <= YY_MAX_SHIFTREDUCE ){
  128025. if( yyact>YY_MAX_SHIFT ){
  128026. yyact += YY_MIN_REDUCE - YY_MIN_SHIFTREDUCE;
  128027. }
  128028. yymsp -= yysize-1;
  128029. yypParser->yytos = yymsp;
  128030. yymsp->stateno = (YYACTIONTYPE)yyact;
  128031. yymsp->major = (YYCODETYPE)yygoto;
  128032. yyTraceShift(yypParser, yyact);
  128033. }else{
  128034. assert( yyact == YY_ACCEPT_ACTION );
  128035. yypParser->yytos -= yysize;
  128036. yy_accept(yypParser);
  128037. }
  128038. }
  128039. /*
  128040. ** The following code executes when the parse fails
  128041. */
  128042. #ifndef YYNOERRORRECOVERY
  128043. static void yy_parse_failed(
  128044. yyParser *yypParser /* The parser */
  128045. ){
  128046. sqlite3ParserARG_FETCH;
  128047. #ifndef NDEBUG
  128048. if( yyTraceFILE ){
  128049. fprintf(yyTraceFILE,"%sFail!\n",yyTracePrompt);
  128050. }
  128051. #endif
  128052. while( yypParser->yytos>yypParser->yystack ) yy_pop_parser_stack(yypParser);
  128053. /* Here code is inserted which will be executed whenever the
  128054. ** parser fails */
  128055. /************ Begin %parse_failure code ***************************************/
  128056. /************ End %parse_failure code *****************************************/
  128057. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  128058. }
  128059. #endif /* YYNOERRORRECOVERY */
  128060. /*
  128061. ** The following code executes when a syntax error first occurs.
  128062. */
  128063. static void yy_syntax_error(
  128064. yyParser *yypParser, /* The parser */
  128065. int yymajor, /* The major type of the error token */
  128066. sqlite3ParserTOKENTYPE yyminor /* The minor type of the error token */
  128067. ){
  128068. sqlite3ParserARG_FETCH;
  128069. #define TOKEN yyminor
  128070. /************ Begin %syntax_error code ****************************************/
  128071. UNUSED_PARAMETER(yymajor); /* Silence some compiler warnings */
  128072. assert( TOKEN.z[0] ); /* The tokenizer always gives us a token */
  128073. sqlite3ErrorMsg(pParse, "near \"%T\": syntax error", &TOKEN);
  128074. /************ End %syntax_error code ******************************************/
  128075. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  128076. }
  128077. /*
  128078. ** The following is executed when the parser accepts
  128079. */
  128080. static void yy_accept(
  128081. yyParser *yypParser /* The parser */
  128082. ){
  128083. sqlite3ParserARG_FETCH;
  128084. #ifndef NDEBUG
  128085. if( yyTraceFILE ){
  128086. fprintf(yyTraceFILE,"%sAccept!\n",yyTracePrompt);
  128087. }
  128088. #endif
  128089. #ifndef YYNOERRORRECOVERY
  128090. yypParser->yyerrcnt = -1;
  128091. #endif
  128092. assert( yypParser->yytos==yypParser->yystack );
  128093. /* Here code is inserted which will be executed whenever the
  128094. ** parser accepts */
  128095. /*********** Begin %parse_accept code *****************************************/
  128096. /*********** End %parse_accept code *******************************************/
  128097. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  128098. }
  128099. /* The main parser program.
  128100. ** The first argument is a pointer to a structure obtained from
  128101. ** "sqlite3ParserAlloc" which describes the current state of the parser.
  128102. ** The second argument is the major token number. The third is
  128103. ** the minor token. The fourth optional argument is whatever the
  128104. ** user wants (and specified in the grammar) and is available for
  128105. ** use by the action routines.
  128106. **
  128107. ** Inputs:
  128108. ** <ul>
  128109. ** <li> A pointer to the parser (an opaque structure.)
  128110. ** <li> The major token number.
  128111. ** <li> The minor token number.
  128112. ** <li> An option argument of a grammar-specified type.
  128113. ** </ul>
  128114. **
  128115. ** Outputs:
  128116. ** None.
  128117. */
  128118. SQLITE_PRIVATE void sqlite3Parser(
  128119. void *yyp, /* The parser */
  128120. int yymajor, /* The major token code number */
  128121. sqlite3ParserTOKENTYPE yyminor /* The value for the token */
  128122. sqlite3ParserARG_PDECL /* Optional %extra_argument parameter */
  128123. ){
  128124. YYMINORTYPE yyminorunion;
  128125. unsigned int yyact; /* The parser action. */
  128126. #if !defined(YYERRORSYMBOL) && !defined(YYNOERRORRECOVERY)
  128127. int yyendofinput; /* True if we are at the end of input */
  128128. #endif
  128129. #ifdef YYERRORSYMBOL
  128130. int yyerrorhit = 0; /* True if yymajor has invoked an error */
  128131. #endif
  128132. yyParser *yypParser; /* The parser */
  128133. yypParser = (yyParser*)yyp;
  128134. assert( yypParser->yytos!=0 );
  128135. #if !defined(YYERRORSYMBOL) && !defined(YYNOERRORRECOVERY)
  128136. yyendofinput = (yymajor==0);
  128137. #endif
  128138. sqlite3ParserARG_STORE;
  128139. #ifndef NDEBUG
  128140. if( yyTraceFILE ){
  128141. fprintf(yyTraceFILE,"%sInput '%s'\n",yyTracePrompt,yyTokenName[yymajor]);
  128142. }
  128143. #endif
  128144. do{
  128145. yyact = yy_find_shift_action(yypParser,(YYCODETYPE)yymajor);
  128146. if( yyact <= YY_MAX_SHIFTREDUCE ){
  128147. yy_shift(yypParser,yyact,yymajor,yyminor);
  128148. #ifndef YYNOERRORRECOVERY
  128149. yypParser->yyerrcnt--;
  128150. #endif
  128151. yymajor = YYNOCODE;
  128152. }else if( yyact <= YY_MAX_REDUCE ){
  128153. yy_reduce(yypParser,yyact-YY_MIN_REDUCE);
  128154. }else{
  128155. assert( yyact == YY_ERROR_ACTION );
  128156. yyminorunion.yy0 = yyminor;
  128157. #ifdef YYERRORSYMBOL
  128158. int yymx;
  128159. #endif
  128160. #ifndef NDEBUG
  128161. if( yyTraceFILE ){
  128162. fprintf(yyTraceFILE,"%sSyntax Error!\n",yyTracePrompt);
  128163. }
  128164. #endif
  128165. #ifdef YYERRORSYMBOL
  128166. /* A syntax error has occurred.
  128167. ** The response to an error depends upon whether or not the
  128168. ** grammar defines an error token "ERROR".
  128169. **
  128170. ** This is what we do if the grammar does define ERROR:
  128171. **
  128172. ** * Call the %syntax_error function.
  128173. **
  128174. ** * Begin popping the stack until we enter a state where
  128175. ** it is legal to shift the error symbol, then shift
  128176. ** the error symbol.
  128177. **
  128178. ** * Set the error count to three.
  128179. **
  128180. ** * Begin accepting and shifting new tokens. No new error
  128181. ** processing will occur until three tokens have been
  128182. ** shifted successfully.
  128183. **
  128184. */
  128185. if( yypParser->yyerrcnt<0 ){
  128186. yy_syntax_error(yypParser,yymajor,yyminor);
  128187. }
  128188. yymx = yypParser->yytos->major;
  128189. if( yymx==YYERRORSYMBOL || yyerrorhit ){
  128190. #ifndef NDEBUG
  128191. if( yyTraceFILE ){
  128192. fprintf(yyTraceFILE,"%sDiscard input token %s\n",
  128193. yyTracePrompt,yyTokenName[yymajor]);
  128194. }
  128195. #endif
  128196. yy_destructor(yypParser, (YYCODETYPE)yymajor, &yyminorunion);
  128197. yymajor = YYNOCODE;
  128198. }else{
  128199. while( yypParser->yytos >= yypParser->yystack
  128200. && yymx != YYERRORSYMBOL
  128201. && (yyact = yy_find_reduce_action(
  128202. yypParser->yytos->stateno,
  128203. YYERRORSYMBOL)) >= YY_MIN_REDUCE
  128204. ){
  128205. yy_pop_parser_stack(yypParser);
  128206. }
  128207. if( yypParser->yytos < yypParser->yystack || yymajor==0 ){
  128208. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  128209. yy_parse_failed(yypParser);
  128210. #ifndef YYNOERRORRECOVERY
  128211. yypParser->yyerrcnt = -1;
  128212. #endif
  128213. yymajor = YYNOCODE;
  128214. }else if( yymx!=YYERRORSYMBOL ){
  128215. yy_shift(yypParser,yyact,YYERRORSYMBOL,yyminor);
  128216. }
  128217. }
  128218. yypParser->yyerrcnt = 3;
  128219. yyerrorhit = 1;
  128220. #elif defined(YYNOERRORRECOVERY)
  128221. /* If the YYNOERRORRECOVERY macro is defined, then do not attempt to
  128222. ** do any kind of error recovery. Instead, simply invoke the syntax
  128223. ** error routine and continue going as if nothing had happened.
  128224. **
  128225. ** Applications can set this macro (for example inside %include) if
  128226. ** they intend to abandon the parse upon the first syntax error seen.
  128227. */
  128228. yy_syntax_error(yypParser,yymajor, yyminor);
  128229. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  128230. yymajor = YYNOCODE;
  128231. #else /* YYERRORSYMBOL is not defined */
  128232. /* This is what we do if the grammar does not define ERROR:
  128233. **
  128234. ** * Report an error message, and throw away the input token.
  128235. **
  128236. ** * If the input token is $, then fail the parse.
  128237. **
  128238. ** As before, subsequent error messages are suppressed until
  128239. ** three input tokens have been successfully shifted.
  128240. */
  128241. if( yypParser->yyerrcnt<=0 ){
  128242. yy_syntax_error(yypParser,yymajor, yyminor);
  128243. }
  128244. yypParser->yyerrcnt = 3;
  128245. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  128246. if( yyendofinput ){
  128247. yy_parse_failed(yypParser);
  128248. #ifndef YYNOERRORRECOVERY
  128249. yypParser->yyerrcnt = -1;
  128250. #endif
  128251. }
  128252. yymajor = YYNOCODE;
  128253. #endif
  128254. }
  128255. }while( yymajor!=YYNOCODE && yypParser->yytos>yypParser->yystack );
  128256. #ifndef NDEBUG
  128257. if( yyTraceFILE ){
  128258. yyStackEntry *i;
  128259. char cDiv = '[';
  128260. fprintf(yyTraceFILE,"%sReturn. Stack=",yyTracePrompt);
  128261. for(i=&yypParser->yystack[1]; i<=yypParser->yytos; i++){
  128262. fprintf(yyTraceFILE,"%c%s", cDiv, yyTokenName[i->major]);
  128263. cDiv = ' ';
  128264. }
  128265. fprintf(yyTraceFILE,"]\n");
  128266. }
  128267. #endif
  128268. return;
  128269. }
  128270. /************** End of parse.c ***********************************************/
  128271. /************** Begin file tokenize.c ****************************************/
  128272. /*
  128273. ** 2001 September 15
  128274. **
  128275. ** The author disclaims copyright to this source code. In place of
  128276. ** a legal notice, here is a blessing:
  128277. **
  128278. ** May you do good and not evil.
  128279. ** May you find forgiveness for yourself and forgive others.
  128280. ** May you share freely, never taking more than you give.
  128281. **
  128282. *************************************************************************
  128283. ** An tokenizer for SQL
  128284. **
  128285. ** This file contains C code that splits an SQL input string up into
  128286. ** individual tokens and sends those tokens one-by-one over to the
  128287. ** parser for analysis.
  128288. */
  128289. /* #include "sqliteInt.h" */
  128290. /* #include <stdlib.h> */
  128291. /* Character classes for tokenizing
  128292. **
  128293. ** In the sqlite3GetToken() function, a switch() on aiClass[c] is implemented
  128294. ** using a lookup table, whereas a switch() directly on c uses a binary search.
  128295. ** The lookup table is much faster. To maximize speed, and to ensure that
  128296. ** a lookup table is used, all of the classes need to be small integers and
  128297. ** all of them need to be used within the switch.
  128298. */
  128299. #define CC_X 0 /* The letter 'x', or start of BLOB literal */
  128300. #define CC_KYWD 1 /* Alphabetics or '_'. Usable in a keyword */
  128301. #define CC_ID 2 /* unicode characters usable in IDs */
  128302. #define CC_DIGIT 3 /* Digits */
  128303. #define CC_DOLLAR 4 /* '$' */
  128304. #define CC_VARALPHA 5 /* '@', '#', ':'. Alphabetic SQL variables */
  128305. #define CC_VARNUM 6 /* '?'. Numeric SQL variables */
  128306. #define CC_SPACE 7 /* Space characters */
  128307. #define CC_QUOTE 8 /* '"', '\'', or '`'. String literals, quoted ids */
  128308. #define CC_QUOTE2 9 /* '['. [...] style quoted ids */
  128309. #define CC_PIPE 10 /* '|'. Bitwise OR or concatenate */
  128310. #define CC_MINUS 11 /* '-'. Minus or SQL-style comment */
  128311. #define CC_LT 12 /* '<'. Part of < or <= or <> */
  128312. #define CC_GT 13 /* '>'. Part of > or >= */
  128313. #define CC_EQ 14 /* '='. Part of = or == */
  128314. #define CC_BANG 15 /* '!'. Part of != */
  128315. #define CC_SLASH 16 /* '/'. / or c-style comment */
  128316. #define CC_LP 17 /* '(' */
  128317. #define CC_RP 18 /* ')' */
  128318. #define CC_SEMI 19 /* ';' */
  128319. #define CC_PLUS 20 /* '+' */
  128320. #define CC_STAR 21 /* '*' */
  128321. #define CC_PERCENT 22 /* '%' */
  128322. #define CC_COMMA 23 /* ',' */
  128323. #define CC_AND 24 /* '&' */
  128324. #define CC_TILDA 25 /* '~' */
  128325. #define CC_DOT 26 /* '.' */
  128326. #define CC_ILLEGAL 27 /* Illegal character */
  128327. static const unsigned char aiClass[] = {
  128328. #ifdef SQLITE_ASCII
  128329. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
  128330. /* 0x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 7, 7, 27, 7, 7, 27, 27,
  128331. /* 1x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  128332. /* 2x */ 7, 15, 8, 5, 4, 22, 24, 8, 17, 18, 21, 20, 23, 11, 26, 16,
  128333. /* 3x */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 5, 19, 12, 14, 13, 6,
  128334. /* 4x */ 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  128335. /* 5x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 9, 27, 27, 27, 1,
  128336. /* 6x */ 8, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  128337. /* 7x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 27, 10, 27, 25, 27,
  128338. /* 8x */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128339. /* 9x */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128340. /* Ax */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128341. /* Bx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128342. /* Cx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128343. /* Dx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128344. /* Ex */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  128345. /* Fx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2
  128346. #endif
  128347. #ifdef SQLITE_EBCDIC
  128348. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
  128349. /* 0x */ 27, 27, 27, 27, 27, 7, 27, 27, 27, 27, 27, 27, 7, 7, 27, 27,
  128350. /* 1x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  128351. /* 2x */ 27, 27, 27, 27, 27, 7, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  128352. /* 3x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  128353. /* 4x */ 7, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 12, 17, 20, 10,
  128354. /* 5x */ 24, 27, 27, 27, 27, 27, 27, 27, 27, 27, 15, 4, 21, 18, 19, 27,
  128355. /* 6x */ 11, 16, 27, 27, 27, 27, 27, 27, 27, 27, 27, 23, 22, 1, 13, 7,
  128356. /* 7x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 8, 5, 5, 5, 8, 14, 8,
  128357. /* 8x */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  128358. /* 9x */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  128359. /* 9x */ 25, 1, 1, 1, 1, 1, 1, 0, 1, 1, 27, 27, 27, 27, 27, 27,
  128360. /* Bx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 9, 27, 27, 27, 27, 27,
  128361. /* Cx */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  128362. /* Dx */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  128363. /* Ex */ 27, 27, 1, 1, 1, 1, 1, 0, 1, 1, 27, 27, 27, 27, 27, 27,
  128364. /* Fx */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 27, 27, 27, 27, 27, 27,
  128365. #endif
  128366. };
  128367. /*
  128368. ** The charMap() macro maps alphabetic characters (only) into their
  128369. ** lower-case ASCII equivalent. On ASCII machines, this is just
  128370. ** an upper-to-lower case map. On EBCDIC machines we also need
  128371. ** to adjust the encoding. The mapping is only valid for alphabetics
  128372. ** which are the only characters for which this feature is used.
  128373. **
  128374. ** Used by keywordhash.h
  128375. */
  128376. #ifdef SQLITE_ASCII
  128377. # define charMap(X) sqlite3UpperToLower[(unsigned char)X]
  128378. #endif
  128379. #ifdef SQLITE_EBCDIC
  128380. # define charMap(X) ebcdicToAscii[(unsigned char)X]
  128381. const unsigned char ebcdicToAscii[] = {
  128382. /* 0 1 2 3 4 5 6 7 8 9 A B C D E F */
  128383. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x */
  128384. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 1x */
  128385. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 2x */
  128386. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 3x */
  128387. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 4x */
  128388. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 5x */
  128389. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 95, 0, 0, /* 6x */
  128390. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 7x */
  128391. 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* 8x */
  128392. 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* 9x */
  128393. 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ax */
  128394. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
  128395. 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* Cx */
  128396. 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* Dx */
  128397. 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ex */
  128398. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Fx */
  128399. };
  128400. #endif
  128401. /*
  128402. ** The sqlite3KeywordCode function looks up an identifier to determine if
  128403. ** it is a keyword. If it is a keyword, the token code of that keyword is
  128404. ** returned. If the input is not a keyword, TK_ID is returned.
  128405. **
  128406. ** The implementation of this routine was generated by a program,
  128407. ** mkkeywordhash.c, located in the tool subdirectory of the distribution.
  128408. ** The output of the mkkeywordhash.c program is written into a file
  128409. ** named keywordhash.h and then included into this source file by
  128410. ** the #include below.
  128411. */
  128412. /************** Include keywordhash.h in the middle of tokenize.c ************/
  128413. /************** Begin file keywordhash.h *************************************/
  128414. /***** This file contains automatically generated code ******
  128415. **
  128416. ** The code in this file has been automatically generated by
  128417. **
  128418. ** sqlite/tool/mkkeywordhash.c
  128419. **
  128420. ** The code in this file implements a function that determines whether
  128421. ** or not a given identifier is really an SQL keyword. The same thing
  128422. ** might be implemented more directly using a hand-written hash table.
  128423. ** But by using this automatically generated code, the size of the code
  128424. ** is substantially reduced. This is important for embedded applications
  128425. ** on platforms with limited memory.
  128426. */
  128427. /* Hash score: 182 */
  128428. static int keywordCode(const char *z, int n, int *pType){
  128429. /* zText[] encodes 834 bytes of keywords in 554 bytes */
  128430. /* REINDEXEDESCAPEACHECKEYBEFOREIGNOREGEXPLAINSTEADDATABASELECT */
  128431. /* ABLEFTHENDEFERRABLELSEXCEPTRANSACTIONATURALTERAISEXCLUSIVE */
  128432. /* XISTSAVEPOINTERSECTRIGGEREFERENCESCONSTRAINTOFFSETEMPORARY */
  128433. /* UNIQUERYWITHOUTERELEASEATTACHAVINGROUPDATEBEGINNERECURSIVE */
  128434. /* BETWEENOTNULLIKECASCADELETECASECOLLATECREATECURRENT_DATEDETACH */
  128435. /* IMMEDIATEJOINSERTMATCHPLANALYZEPRAGMABORTVALUESVIRTUALIMITWHEN */
  128436. /* WHERENAMEAFTEREPLACEANDEFAULTAUTOINCREMENTCASTCOLUMNCOMMIT */
  128437. /* CONFLICTCROSSCURRENT_TIMESTAMPRIMARYDEFERREDISTINCTDROPFAIL */
  128438. /* FROMFULLGLOBYIFISNULLORDERESTRICTRIGHTROLLBACKROWUNIONUSING */
  128439. /* VACUUMVIEWINITIALLY */
  128440. static const char zText[553] = {
  128441. 'R','E','I','N','D','E','X','E','D','E','S','C','A','P','E','A','C','H',
  128442. 'E','C','K','E','Y','B','E','F','O','R','E','I','G','N','O','R','E','G',
  128443. 'E','X','P','L','A','I','N','S','T','E','A','D','D','A','T','A','B','A',
  128444. 'S','E','L','E','C','T','A','B','L','E','F','T','H','E','N','D','E','F',
  128445. 'E','R','R','A','B','L','E','L','S','E','X','C','E','P','T','R','A','N',
  128446. 'S','A','C','T','I','O','N','A','T','U','R','A','L','T','E','R','A','I',
  128447. 'S','E','X','C','L','U','S','I','V','E','X','I','S','T','S','A','V','E',
  128448. 'P','O','I','N','T','E','R','S','E','C','T','R','I','G','G','E','R','E',
  128449. 'F','E','R','E','N','C','E','S','C','O','N','S','T','R','A','I','N','T',
  128450. 'O','F','F','S','E','T','E','M','P','O','R','A','R','Y','U','N','I','Q',
  128451. 'U','E','R','Y','W','I','T','H','O','U','T','E','R','E','L','E','A','S',
  128452. 'E','A','T','T','A','C','H','A','V','I','N','G','R','O','U','P','D','A',
  128453. 'T','E','B','E','G','I','N','N','E','R','E','C','U','R','S','I','V','E',
  128454. 'B','E','T','W','E','E','N','O','T','N','U','L','L','I','K','E','C','A',
  128455. 'S','C','A','D','E','L','E','T','E','C','A','S','E','C','O','L','L','A',
  128456. 'T','E','C','R','E','A','T','E','C','U','R','R','E','N','T','_','D','A',
  128457. 'T','E','D','E','T','A','C','H','I','M','M','E','D','I','A','T','E','J',
  128458. 'O','I','N','S','E','R','T','M','A','T','C','H','P','L','A','N','A','L',
  128459. 'Y','Z','E','P','R','A','G','M','A','B','O','R','T','V','A','L','U','E',
  128460. 'S','V','I','R','T','U','A','L','I','M','I','T','W','H','E','N','W','H',
  128461. 'E','R','E','N','A','M','E','A','F','T','E','R','E','P','L','A','C','E',
  128462. 'A','N','D','E','F','A','U','L','T','A','U','T','O','I','N','C','R','E',
  128463. 'M','E','N','T','C','A','S','T','C','O','L','U','M','N','C','O','M','M',
  128464. 'I','T','C','O','N','F','L','I','C','T','C','R','O','S','S','C','U','R',
  128465. 'R','E','N','T','_','T','I','M','E','S','T','A','M','P','R','I','M','A',
  128466. 'R','Y','D','E','F','E','R','R','E','D','I','S','T','I','N','C','T','D',
  128467. 'R','O','P','F','A','I','L','F','R','O','M','F','U','L','L','G','L','O',
  128468. 'B','Y','I','F','I','S','N','U','L','L','O','R','D','E','R','E','S','T',
  128469. 'R','I','C','T','R','I','G','H','T','R','O','L','L','B','A','C','K','R',
  128470. 'O','W','U','N','I','O','N','U','S','I','N','G','V','A','C','U','U','M',
  128471. 'V','I','E','W','I','N','I','T','I','A','L','L','Y',
  128472. };
  128473. static const unsigned char aHash[127] = {
  128474. 76, 105, 117, 74, 0, 45, 0, 0, 82, 0, 77, 0, 0,
  128475. 42, 12, 78, 15, 0, 116, 85, 54, 112, 0, 19, 0, 0,
  128476. 121, 0, 119, 115, 0, 22, 93, 0, 9, 0, 0, 70, 71,
  128477. 0, 69, 6, 0, 48, 90, 102, 0, 118, 101, 0, 0, 44,
  128478. 0, 103, 24, 0, 17, 0, 122, 53, 23, 0, 5, 110, 25,
  128479. 96, 0, 0, 124, 106, 60, 123, 57, 28, 55, 0, 91, 0,
  128480. 100, 26, 0, 99, 0, 0, 0, 95, 92, 97, 88, 109, 14,
  128481. 39, 108, 0, 81, 0, 18, 89, 111, 32, 0, 120, 80, 113,
  128482. 62, 46, 84, 0, 0, 94, 40, 59, 114, 0, 36, 0, 0,
  128483. 29, 0, 86, 63, 64, 0, 20, 61, 0, 56,
  128484. };
  128485. static const unsigned char aNext[124] = {
  128486. 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0,
  128487. 0, 2, 0, 0, 0, 0, 0, 0, 13, 0, 0, 0, 0,
  128488. 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  128489. 0, 0, 0, 0, 33, 0, 21, 0, 0, 0, 0, 0, 50,
  128490. 0, 43, 3, 47, 0, 0, 0, 0, 30, 0, 58, 0, 38,
  128491. 0, 0, 0, 1, 66, 0, 0, 67, 0, 41, 0, 0, 0,
  128492. 0, 0, 0, 49, 65, 0, 0, 0, 0, 31, 52, 16, 34,
  128493. 10, 0, 0, 0, 0, 0, 0, 0, 11, 72, 79, 0, 8,
  128494. 0, 104, 98, 0, 107, 0, 87, 0, 75, 51, 0, 27, 37,
  128495. 73, 83, 0, 35, 68, 0, 0,
  128496. };
  128497. static const unsigned char aLen[124] = {
  128498. 7, 7, 5, 4, 6, 4, 5, 3, 6, 7, 3, 6, 6,
  128499. 7, 7, 3, 8, 2, 6, 5, 4, 4, 3, 10, 4, 6,
  128500. 11, 6, 2, 7, 5, 5, 9, 6, 9, 9, 7, 10, 10,
  128501. 4, 6, 2, 3, 9, 4, 2, 6, 5, 7, 4, 5, 7,
  128502. 6, 6, 5, 6, 5, 5, 9, 7, 7, 3, 2, 4, 4,
  128503. 7, 3, 6, 4, 7, 6, 12, 6, 9, 4, 6, 5, 4,
  128504. 7, 6, 5, 6, 7, 5, 4, 5, 6, 5, 7, 3, 7,
  128505. 13, 2, 2, 4, 6, 6, 8, 5, 17, 12, 7, 8, 8,
  128506. 2, 4, 4, 4, 4, 4, 2, 2, 6, 5, 8, 5, 8,
  128507. 3, 5, 5, 6, 4, 9, 3,
  128508. };
  128509. static const unsigned short int aOffset[124] = {
  128510. 0, 2, 2, 8, 9, 14, 16, 20, 23, 25, 25, 29, 33,
  128511. 36, 41, 46, 48, 53, 54, 59, 62, 65, 67, 69, 78, 81,
  128512. 86, 91, 95, 96, 101, 105, 109, 117, 122, 128, 136, 142, 152,
  128513. 159, 162, 162, 165, 167, 167, 171, 176, 179, 184, 184, 188, 192,
  128514. 199, 204, 209, 212, 218, 221, 225, 234, 240, 240, 240, 243, 246,
  128515. 250, 251, 255, 261, 265, 272, 278, 290, 296, 305, 307, 313, 318,
  128516. 320, 327, 332, 337, 343, 349, 354, 358, 361, 367, 371, 378, 380,
  128517. 387, 389, 391, 400, 404, 410, 416, 424, 429, 429, 445, 452, 459,
  128518. 460, 467, 471, 475, 479, 483, 486, 488, 490, 496, 500, 508, 513,
  128519. 521, 524, 529, 534, 540, 544, 549,
  128520. };
  128521. static const unsigned char aCode[124] = {
  128522. TK_REINDEX, TK_INDEXED, TK_INDEX, TK_DESC, TK_ESCAPE,
  128523. TK_EACH, TK_CHECK, TK_KEY, TK_BEFORE, TK_FOREIGN,
  128524. TK_FOR, TK_IGNORE, TK_LIKE_KW, TK_EXPLAIN, TK_INSTEAD,
  128525. TK_ADD, TK_DATABASE, TK_AS, TK_SELECT, TK_TABLE,
  128526. TK_JOIN_KW, TK_THEN, TK_END, TK_DEFERRABLE, TK_ELSE,
  128527. TK_EXCEPT, TK_TRANSACTION,TK_ACTION, TK_ON, TK_JOIN_KW,
  128528. TK_ALTER, TK_RAISE, TK_EXCLUSIVE, TK_EXISTS, TK_SAVEPOINT,
  128529. TK_INTERSECT, TK_TRIGGER, TK_REFERENCES, TK_CONSTRAINT, TK_INTO,
  128530. TK_OFFSET, TK_OF, TK_SET, TK_TEMP, TK_TEMP,
  128531. TK_OR, TK_UNIQUE, TK_QUERY, TK_WITHOUT, TK_WITH,
  128532. TK_JOIN_KW, TK_RELEASE, TK_ATTACH, TK_HAVING, TK_GROUP,
  128533. TK_UPDATE, TK_BEGIN, TK_JOIN_KW, TK_RECURSIVE, TK_BETWEEN,
  128534. TK_NOTNULL, TK_NOT, TK_NO, TK_NULL, TK_LIKE_KW,
  128535. TK_CASCADE, TK_ASC, TK_DELETE, TK_CASE, TK_COLLATE,
  128536. TK_CREATE, TK_CTIME_KW, TK_DETACH, TK_IMMEDIATE, TK_JOIN,
  128537. TK_INSERT, TK_MATCH, TK_PLAN, TK_ANALYZE, TK_PRAGMA,
  128538. TK_ABORT, TK_VALUES, TK_VIRTUAL, TK_LIMIT, TK_WHEN,
  128539. TK_WHERE, TK_RENAME, TK_AFTER, TK_REPLACE, TK_AND,
  128540. TK_DEFAULT, TK_AUTOINCR, TK_TO, TK_IN, TK_CAST,
  128541. TK_COLUMNKW, TK_COMMIT, TK_CONFLICT, TK_JOIN_KW, TK_CTIME_KW,
  128542. TK_CTIME_KW, TK_PRIMARY, TK_DEFERRED, TK_DISTINCT, TK_IS,
  128543. TK_DROP, TK_FAIL, TK_FROM, TK_JOIN_KW, TK_LIKE_KW,
  128544. TK_BY, TK_IF, TK_ISNULL, TK_ORDER, TK_RESTRICT,
  128545. TK_JOIN_KW, TK_ROLLBACK, TK_ROW, TK_UNION, TK_USING,
  128546. TK_VACUUM, TK_VIEW, TK_INITIALLY, TK_ALL,
  128547. };
  128548. int i, j;
  128549. const char *zKW;
  128550. if( n>=2 ){
  128551. i = ((charMap(z[0])*4) ^ (charMap(z[n-1])*3) ^ n) % 127;
  128552. for(i=((int)aHash[i])-1; i>=0; i=((int)aNext[i])-1){
  128553. if( aLen[i]!=n ) continue;
  128554. j = 0;
  128555. zKW = &zText[aOffset[i]];
  128556. #ifdef SQLITE_ASCII
  128557. while( j<n && (z[j]&~0x20)==zKW[j] ){ j++; }
  128558. #endif
  128559. #ifdef SQLITE_EBCDIC
  128560. while( j<n && toupper(z[j])==zKW[j] ){ j++; }
  128561. #endif
  128562. if( j<n ) continue;
  128563. testcase( i==0 ); /* REINDEX */
  128564. testcase( i==1 ); /* INDEXED */
  128565. testcase( i==2 ); /* INDEX */
  128566. testcase( i==3 ); /* DESC */
  128567. testcase( i==4 ); /* ESCAPE */
  128568. testcase( i==5 ); /* EACH */
  128569. testcase( i==6 ); /* CHECK */
  128570. testcase( i==7 ); /* KEY */
  128571. testcase( i==8 ); /* BEFORE */
  128572. testcase( i==9 ); /* FOREIGN */
  128573. testcase( i==10 ); /* FOR */
  128574. testcase( i==11 ); /* IGNORE */
  128575. testcase( i==12 ); /* REGEXP */
  128576. testcase( i==13 ); /* EXPLAIN */
  128577. testcase( i==14 ); /* INSTEAD */
  128578. testcase( i==15 ); /* ADD */
  128579. testcase( i==16 ); /* DATABASE */
  128580. testcase( i==17 ); /* AS */
  128581. testcase( i==18 ); /* SELECT */
  128582. testcase( i==19 ); /* TABLE */
  128583. testcase( i==20 ); /* LEFT */
  128584. testcase( i==21 ); /* THEN */
  128585. testcase( i==22 ); /* END */
  128586. testcase( i==23 ); /* DEFERRABLE */
  128587. testcase( i==24 ); /* ELSE */
  128588. testcase( i==25 ); /* EXCEPT */
  128589. testcase( i==26 ); /* TRANSACTION */
  128590. testcase( i==27 ); /* ACTION */
  128591. testcase( i==28 ); /* ON */
  128592. testcase( i==29 ); /* NATURAL */
  128593. testcase( i==30 ); /* ALTER */
  128594. testcase( i==31 ); /* RAISE */
  128595. testcase( i==32 ); /* EXCLUSIVE */
  128596. testcase( i==33 ); /* EXISTS */
  128597. testcase( i==34 ); /* SAVEPOINT */
  128598. testcase( i==35 ); /* INTERSECT */
  128599. testcase( i==36 ); /* TRIGGER */
  128600. testcase( i==37 ); /* REFERENCES */
  128601. testcase( i==38 ); /* CONSTRAINT */
  128602. testcase( i==39 ); /* INTO */
  128603. testcase( i==40 ); /* OFFSET */
  128604. testcase( i==41 ); /* OF */
  128605. testcase( i==42 ); /* SET */
  128606. testcase( i==43 ); /* TEMPORARY */
  128607. testcase( i==44 ); /* TEMP */
  128608. testcase( i==45 ); /* OR */
  128609. testcase( i==46 ); /* UNIQUE */
  128610. testcase( i==47 ); /* QUERY */
  128611. testcase( i==48 ); /* WITHOUT */
  128612. testcase( i==49 ); /* WITH */
  128613. testcase( i==50 ); /* OUTER */
  128614. testcase( i==51 ); /* RELEASE */
  128615. testcase( i==52 ); /* ATTACH */
  128616. testcase( i==53 ); /* HAVING */
  128617. testcase( i==54 ); /* GROUP */
  128618. testcase( i==55 ); /* UPDATE */
  128619. testcase( i==56 ); /* BEGIN */
  128620. testcase( i==57 ); /* INNER */
  128621. testcase( i==58 ); /* RECURSIVE */
  128622. testcase( i==59 ); /* BETWEEN */
  128623. testcase( i==60 ); /* NOTNULL */
  128624. testcase( i==61 ); /* NOT */
  128625. testcase( i==62 ); /* NO */
  128626. testcase( i==63 ); /* NULL */
  128627. testcase( i==64 ); /* LIKE */
  128628. testcase( i==65 ); /* CASCADE */
  128629. testcase( i==66 ); /* ASC */
  128630. testcase( i==67 ); /* DELETE */
  128631. testcase( i==68 ); /* CASE */
  128632. testcase( i==69 ); /* COLLATE */
  128633. testcase( i==70 ); /* CREATE */
  128634. testcase( i==71 ); /* CURRENT_DATE */
  128635. testcase( i==72 ); /* DETACH */
  128636. testcase( i==73 ); /* IMMEDIATE */
  128637. testcase( i==74 ); /* JOIN */
  128638. testcase( i==75 ); /* INSERT */
  128639. testcase( i==76 ); /* MATCH */
  128640. testcase( i==77 ); /* PLAN */
  128641. testcase( i==78 ); /* ANALYZE */
  128642. testcase( i==79 ); /* PRAGMA */
  128643. testcase( i==80 ); /* ABORT */
  128644. testcase( i==81 ); /* VALUES */
  128645. testcase( i==82 ); /* VIRTUAL */
  128646. testcase( i==83 ); /* LIMIT */
  128647. testcase( i==84 ); /* WHEN */
  128648. testcase( i==85 ); /* WHERE */
  128649. testcase( i==86 ); /* RENAME */
  128650. testcase( i==87 ); /* AFTER */
  128651. testcase( i==88 ); /* REPLACE */
  128652. testcase( i==89 ); /* AND */
  128653. testcase( i==90 ); /* DEFAULT */
  128654. testcase( i==91 ); /* AUTOINCREMENT */
  128655. testcase( i==92 ); /* TO */
  128656. testcase( i==93 ); /* IN */
  128657. testcase( i==94 ); /* CAST */
  128658. testcase( i==95 ); /* COLUMN */
  128659. testcase( i==96 ); /* COMMIT */
  128660. testcase( i==97 ); /* CONFLICT */
  128661. testcase( i==98 ); /* CROSS */
  128662. testcase( i==99 ); /* CURRENT_TIMESTAMP */
  128663. testcase( i==100 ); /* CURRENT_TIME */
  128664. testcase( i==101 ); /* PRIMARY */
  128665. testcase( i==102 ); /* DEFERRED */
  128666. testcase( i==103 ); /* DISTINCT */
  128667. testcase( i==104 ); /* IS */
  128668. testcase( i==105 ); /* DROP */
  128669. testcase( i==106 ); /* FAIL */
  128670. testcase( i==107 ); /* FROM */
  128671. testcase( i==108 ); /* FULL */
  128672. testcase( i==109 ); /* GLOB */
  128673. testcase( i==110 ); /* BY */
  128674. testcase( i==111 ); /* IF */
  128675. testcase( i==112 ); /* ISNULL */
  128676. testcase( i==113 ); /* ORDER */
  128677. testcase( i==114 ); /* RESTRICT */
  128678. testcase( i==115 ); /* RIGHT */
  128679. testcase( i==116 ); /* ROLLBACK */
  128680. testcase( i==117 ); /* ROW */
  128681. testcase( i==118 ); /* UNION */
  128682. testcase( i==119 ); /* USING */
  128683. testcase( i==120 ); /* VACUUM */
  128684. testcase( i==121 ); /* VIEW */
  128685. testcase( i==122 ); /* INITIALLY */
  128686. testcase( i==123 ); /* ALL */
  128687. *pType = aCode[i];
  128688. break;
  128689. }
  128690. }
  128691. return n;
  128692. }
  128693. SQLITE_PRIVATE int sqlite3KeywordCode(const unsigned char *z, int n){
  128694. int id = TK_ID;
  128695. keywordCode((char*)z, n, &id);
  128696. return id;
  128697. }
  128698. #define SQLITE_N_KEYWORD 124
  128699. /************** End of keywordhash.h *****************************************/
  128700. /************** Continuing where we left off in tokenize.c *******************/
  128701. /*
  128702. ** If X is a character that can be used in an identifier then
  128703. ** IdChar(X) will be true. Otherwise it is false.
  128704. **
  128705. ** For ASCII, any character with the high-order bit set is
  128706. ** allowed in an identifier. For 7-bit characters,
  128707. ** sqlite3IsIdChar[X] must be 1.
  128708. **
  128709. ** For EBCDIC, the rules are more complex but have the same
  128710. ** end result.
  128711. **
  128712. ** Ticket #1066. the SQL standard does not allow '$' in the
  128713. ** middle of identifiers. But many SQL implementations do.
  128714. ** SQLite will allow '$' in identifiers for compatibility.
  128715. ** But the feature is undocumented.
  128716. */
  128717. #ifdef SQLITE_ASCII
  128718. #define IdChar(C) ((sqlite3CtypeMap[(unsigned char)C]&0x46)!=0)
  128719. #endif
  128720. #ifdef SQLITE_EBCDIC
  128721. SQLITE_PRIVATE const char sqlite3IsEbcdicIdChar[] = {
  128722. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
  128723. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 4x */
  128724. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 0, /* 5x */
  128725. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, /* 6x */
  128726. 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, /* 7x */
  128727. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, /* 8x */
  128728. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 1, 0, /* 9x */
  128729. 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, /* Ax */
  128730. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
  128731. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Cx */
  128732. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Dx */
  128733. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Ex */
  128734. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 0, /* Fx */
  128735. };
  128736. #define IdChar(C) (((c=C)>=0x42 && sqlite3IsEbcdicIdChar[c-0x40]))
  128737. #endif
  128738. /* Make the IdChar function accessible from ctime.c */
  128739. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  128740. SQLITE_PRIVATE int sqlite3IsIdChar(u8 c){ return IdChar(c); }
  128741. #endif
  128742. /*
  128743. ** Return the length (in bytes) of the token that begins at z[0].
  128744. ** Store the token type in *tokenType before returning.
  128745. */
  128746. SQLITE_PRIVATE int sqlite3GetToken(const unsigned char *z, int *tokenType){
  128747. int i, c;
  128748. switch( aiClass[*z] ){ /* Switch on the character-class of the first byte
  128749. ** of the token. See the comment on the CC_ defines
  128750. ** above. */
  128751. case CC_SPACE: {
  128752. testcase( z[0]==' ' );
  128753. testcase( z[0]=='\t' );
  128754. testcase( z[0]=='\n' );
  128755. testcase( z[0]=='\f' );
  128756. testcase( z[0]=='\r' );
  128757. for(i=1; sqlite3Isspace(z[i]); i++){}
  128758. *tokenType = TK_SPACE;
  128759. return i;
  128760. }
  128761. case CC_MINUS: {
  128762. if( z[1]=='-' ){
  128763. for(i=2; (c=z[i])!=0 && c!='\n'; i++){}
  128764. *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
  128765. return i;
  128766. }
  128767. *tokenType = TK_MINUS;
  128768. return 1;
  128769. }
  128770. case CC_LP: {
  128771. *tokenType = TK_LP;
  128772. return 1;
  128773. }
  128774. case CC_RP: {
  128775. *tokenType = TK_RP;
  128776. return 1;
  128777. }
  128778. case CC_SEMI: {
  128779. *tokenType = TK_SEMI;
  128780. return 1;
  128781. }
  128782. case CC_PLUS: {
  128783. *tokenType = TK_PLUS;
  128784. return 1;
  128785. }
  128786. case CC_STAR: {
  128787. *tokenType = TK_STAR;
  128788. return 1;
  128789. }
  128790. case CC_SLASH: {
  128791. if( z[1]!='*' || z[2]==0 ){
  128792. *tokenType = TK_SLASH;
  128793. return 1;
  128794. }
  128795. for(i=3, c=z[2]; (c!='*' || z[i]!='/') && (c=z[i])!=0; i++){}
  128796. if( c ) i++;
  128797. *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
  128798. return i;
  128799. }
  128800. case CC_PERCENT: {
  128801. *tokenType = TK_REM;
  128802. return 1;
  128803. }
  128804. case CC_EQ: {
  128805. *tokenType = TK_EQ;
  128806. return 1 + (z[1]=='=');
  128807. }
  128808. case CC_LT: {
  128809. if( (c=z[1])=='=' ){
  128810. *tokenType = TK_LE;
  128811. return 2;
  128812. }else if( c=='>' ){
  128813. *tokenType = TK_NE;
  128814. return 2;
  128815. }else if( c=='<' ){
  128816. *tokenType = TK_LSHIFT;
  128817. return 2;
  128818. }else{
  128819. *tokenType = TK_LT;
  128820. return 1;
  128821. }
  128822. }
  128823. case CC_GT: {
  128824. if( (c=z[1])=='=' ){
  128825. *tokenType = TK_GE;
  128826. return 2;
  128827. }else if( c=='>' ){
  128828. *tokenType = TK_RSHIFT;
  128829. return 2;
  128830. }else{
  128831. *tokenType = TK_GT;
  128832. return 1;
  128833. }
  128834. }
  128835. case CC_BANG: {
  128836. if( z[1]!='=' ){
  128837. *tokenType = TK_ILLEGAL;
  128838. return 1;
  128839. }else{
  128840. *tokenType = TK_NE;
  128841. return 2;
  128842. }
  128843. }
  128844. case CC_PIPE: {
  128845. if( z[1]!='|' ){
  128846. *tokenType = TK_BITOR;
  128847. return 1;
  128848. }else{
  128849. *tokenType = TK_CONCAT;
  128850. return 2;
  128851. }
  128852. }
  128853. case CC_COMMA: {
  128854. *tokenType = TK_COMMA;
  128855. return 1;
  128856. }
  128857. case CC_AND: {
  128858. *tokenType = TK_BITAND;
  128859. return 1;
  128860. }
  128861. case CC_TILDA: {
  128862. *tokenType = TK_BITNOT;
  128863. return 1;
  128864. }
  128865. case CC_QUOTE: {
  128866. int delim = z[0];
  128867. testcase( delim=='`' );
  128868. testcase( delim=='\'' );
  128869. testcase( delim=='"' );
  128870. for(i=1; (c=z[i])!=0; i++){
  128871. if( c==delim ){
  128872. if( z[i+1]==delim ){
  128873. i++;
  128874. }else{
  128875. break;
  128876. }
  128877. }
  128878. }
  128879. if( c=='\'' ){
  128880. *tokenType = TK_STRING;
  128881. return i+1;
  128882. }else if( c!=0 ){
  128883. *tokenType = TK_ID;
  128884. return i+1;
  128885. }else{
  128886. *tokenType = TK_ILLEGAL;
  128887. return i;
  128888. }
  128889. }
  128890. case CC_DOT: {
  128891. #ifndef SQLITE_OMIT_FLOATING_POINT
  128892. if( !sqlite3Isdigit(z[1]) )
  128893. #endif
  128894. {
  128895. *tokenType = TK_DOT;
  128896. return 1;
  128897. }
  128898. /* If the next character is a digit, this is a floating point
  128899. ** number that begins with ".". Fall thru into the next case */
  128900. }
  128901. case CC_DIGIT: {
  128902. testcase( z[0]=='0' ); testcase( z[0]=='1' ); testcase( z[0]=='2' );
  128903. testcase( z[0]=='3' ); testcase( z[0]=='4' ); testcase( z[0]=='5' );
  128904. testcase( z[0]=='6' ); testcase( z[0]=='7' ); testcase( z[0]=='8' );
  128905. testcase( z[0]=='9' );
  128906. *tokenType = TK_INTEGER;
  128907. #ifndef SQLITE_OMIT_HEX_INTEGER
  128908. if( z[0]=='0' && (z[1]=='x' || z[1]=='X') && sqlite3Isxdigit(z[2]) ){
  128909. for(i=3; sqlite3Isxdigit(z[i]); i++){}
  128910. return i;
  128911. }
  128912. #endif
  128913. for(i=0; sqlite3Isdigit(z[i]); i++){}
  128914. #ifndef SQLITE_OMIT_FLOATING_POINT
  128915. if( z[i]=='.' ){
  128916. i++;
  128917. while( sqlite3Isdigit(z[i]) ){ i++; }
  128918. *tokenType = TK_FLOAT;
  128919. }
  128920. if( (z[i]=='e' || z[i]=='E') &&
  128921. ( sqlite3Isdigit(z[i+1])
  128922. || ((z[i+1]=='+' || z[i+1]=='-') && sqlite3Isdigit(z[i+2]))
  128923. )
  128924. ){
  128925. i += 2;
  128926. while( sqlite3Isdigit(z[i]) ){ i++; }
  128927. *tokenType = TK_FLOAT;
  128928. }
  128929. #endif
  128930. while( IdChar(z[i]) ){
  128931. *tokenType = TK_ILLEGAL;
  128932. i++;
  128933. }
  128934. return i;
  128935. }
  128936. case CC_QUOTE2: {
  128937. for(i=1, c=z[0]; c!=']' && (c=z[i])!=0; i++){}
  128938. *tokenType = c==']' ? TK_ID : TK_ILLEGAL;
  128939. return i;
  128940. }
  128941. case CC_VARNUM: {
  128942. *tokenType = TK_VARIABLE;
  128943. for(i=1; sqlite3Isdigit(z[i]); i++){}
  128944. return i;
  128945. }
  128946. case CC_DOLLAR:
  128947. case CC_VARALPHA: {
  128948. int n = 0;
  128949. testcase( z[0]=='$' ); testcase( z[0]=='@' );
  128950. testcase( z[0]==':' ); testcase( z[0]=='#' );
  128951. *tokenType = TK_VARIABLE;
  128952. for(i=1; (c=z[i])!=0; i++){
  128953. if( IdChar(c) ){
  128954. n++;
  128955. #ifndef SQLITE_OMIT_TCL_VARIABLE
  128956. }else if( c=='(' && n>0 ){
  128957. do{
  128958. i++;
  128959. }while( (c=z[i])!=0 && !sqlite3Isspace(c) && c!=')' );
  128960. if( c==')' ){
  128961. i++;
  128962. }else{
  128963. *tokenType = TK_ILLEGAL;
  128964. }
  128965. break;
  128966. }else if( c==':' && z[i+1]==':' ){
  128967. i++;
  128968. #endif
  128969. }else{
  128970. break;
  128971. }
  128972. }
  128973. if( n==0 ) *tokenType = TK_ILLEGAL;
  128974. return i;
  128975. }
  128976. case CC_KYWD: {
  128977. for(i=1; aiClass[z[i]]<=CC_KYWD; i++){}
  128978. if( IdChar(z[i]) ){
  128979. /* This token started out using characters that can appear in keywords,
  128980. ** but z[i] is a character not allowed within keywords, so this must
  128981. ** be an identifier instead */
  128982. i++;
  128983. break;
  128984. }
  128985. *tokenType = TK_ID;
  128986. return keywordCode((char*)z, i, tokenType);
  128987. }
  128988. case CC_X: {
  128989. #ifndef SQLITE_OMIT_BLOB_LITERAL
  128990. testcase( z[0]=='x' ); testcase( z[0]=='X' );
  128991. if( z[1]=='\'' ){
  128992. *tokenType = TK_BLOB;
  128993. for(i=2; sqlite3Isxdigit(z[i]); i++){}
  128994. if( z[i]!='\'' || i%2 ){
  128995. *tokenType = TK_ILLEGAL;
  128996. while( z[i] && z[i]!='\'' ){ i++; }
  128997. }
  128998. if( z[i] ) i++;
  128999. return i;
  129000. }
  129001. #endif
  129002. /* If it is not a BLOB literal, then it must be an ID, since no
  129003. ** SQL keywords start with the letter 'x'. Fall through */
  129004. }
  129005. case CC_ID: {
  129006. i = 1;
  129007. break;
  129008. }
  129009. default: {
  129010. *tokenType = TK_ILLEGAL;
  129011. return 1;
  129012. }
  129013. }
  129014. while( IdChar(z[i]) ){ i++; }
  129015. *tokenType = TK_ID;
  129016. return i;
  129017. }
  129018. /*
  129019. ** Run the parser on the given SQL string. The parser structure is
  129020. ** passed in. An SQLITE_ status code is returned. If an error occurs
  129021. ** then an and attempt is made to write an error message into
  129022. ** memory obtained from sqlite3_malloc() and to make *pzErrMsg point to that
  129023. ** error message.
  129024. */
  129025. SQLITE_PRIVATE int sqlite3RunParser(Parse *pParse, const char *zSql, char **pzErrMsg){
  129026. int nErr = 0; /* Number of errors encountered */
  129027. int i; /* Loop counter */
  129028. void *pEngine; /* The LEMON-generated LALR(1) parser */
  129029. int tokenType; /* type of the next token */
  129030. int lastTokenParsed = -1; /* type of the previous token */
  129031. sqlite3 *db = pParse->db; /* The database connection */
  129032. int mxSqlLen; /* Max length of an SQL string */
  129033. assert( zSql!=0 );
  129034. mxSqlLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
  129035. if( db->nVdbeActive==0 ){
  129036. db->u1.isInterrupted = 0;
  129037. }
  129038. pParse->rc = SQLITE_OK;
  129039. pParse->zTail = zSql;
  129040. i = 0;
  129041. assert( pzErrMsg!=0 );
  129042. /* sqlite3ParserTrace(stdout, "parser: "); */
  129043. pEngine = sqlite3ParserAlloc(sqlite3Malloc);
  129044. if( pEngine==0 ){
  129045. sqlite3OomFault(db);
  129046. return SQLITE_NOMEM_BKPT;
  129047. }
  129048. assert( pParse->pNewTable==0 );
  129049. assert( pParse->pNewTrigger==0 );
  129050. assert( pParse->nVar==0 );
  129051. assert( pParse->nzVar==0 );
  129052. assert( pParse->azVar==0 );
  129053. while( 1 ){
  129054. assert( i>=0 );
  129055. if( zSql[i]!=0 ){
  129056. pParse->sLastToken.z = &zSql[i];
  129057. pParse->sLastToken.n = sqlite3GetToken((u8*)&zSql[i],&tokenType);
  129058. i += pParse->sLastToken.n;
  129059. if( i>mxSqlLen ){
  129060. pParse->rc = SQLITE_TOOBIG;
  129061. break;
  129062. }
  129063. }else{
  129064. /* Upon reaching the end of input, call the parser two more times
  129065. ** with tokens TK_SEMI and 0, in that order. */
  129066. if( lastTokenParsed==TK_SEMI ){
  129067. tokenType = 0;
  129068. }else if( lastTokenParsed==0 ){
  129069. break;
  129070. }else{
  129071. tokenType = TK_SEMI;
  129072. }
  129073. }
  129074. if( tokenType>=TK_SPACE ){
  129075. assert( tokenType==TK_SPACE || tokenType==TK_ILLEGAL );
  129076. if( db->u1.isInterrupted ){
  129077. pParse->rc = SQLITE_INTERRUPT;
  129078. break;
  129079. }
  129080. if( tokenType==TK_ILLEGAL ){
  129081. sqlite3ErrorMsg(pParse, "unrecognized token: \"%T\"",
  129082. &pParse->sLastToken);
  129083. break;
  129084. }
  129085. }else{
  129086. sqlite3Parser(pEngine, tokenType, pParse->sLastToken, pParse);
  129087. lastTokenParsed = tokenType;
  129088. if( pParse->rc!=SQLITE_OK || db->mallocFailed ) break;
  129089. }
  129090. }
  129091. assert( nErr==0 );
  129092. pParse->zTail = &zSql[i];
  129093. #ifdef YYTRACKMAXSTACKDEPTH
  129094. sqlite3_mutex_enter(sqlite3MallocMutex());
  129095. sqlite3StatusHighwater(SQLITE_STATUS_PARSER_STACK,
  129096. sqlite3ParserStackPeak(pEngine)
  129097. );
  129098. sqlite3_mutex_leave(sqlite3MallocMutex());
  129099. #endif /* YYDEBUG */
  129100. sqlite3ParserFree(pEngine, sqlite3_free);
  129101. if( db->mallocFailed ){
  129102. pParse->rc = SQLITE_NOMEM_BKPT;
  129103. }
  129104. if( pParse->rc!=SQLITE_OK && pParse->rc!=SQLITE_DONE && pParse->zErrMsg==0 ){
  129105. pParse->zErrMsg = sqlite3MPrintf(db, "%s", sqlite3ErrStr(pParse->rc));
  129106. }
  129107. assert( pzErrMsg!=0 );
  129108. if( pParse->zErrMsg ){
  129109. *pzErrMsg = pParse->zErrMsg;
  129110. sqlite3_log(pParse->rc, "%s", *pzErrMsg);
  129111. pParse->zErrMsg = 0;
  129112. nErr++;
  129113. }
  129114. if( pParse->pVdbe && pParse->nErr>0 && pParse->nested==0 ){
  129115. sqlite3VdbeDelete(pParse->pVdbe);
  129116. pParse->pVdbe = 0;
  129117. }
  129118. #ifndef SQLITE_OMIT_SHARED_CACHE
  129119. if( pParse->nested==0 ){
  129120. sqlite3DbFree(db, pParse->aTableLock);
  129121. pParse->aTableLock = 0;
  129122. pParse->nTableLock = 0;
  129123. }
  129124. #endif
  129125. #ifndef SQLITE_OMIT_VIRTUALTABLE
  129126. sqlite3_free(pParse->apVtabLock);
  129127. #endif
  129128. if( !IN_DECLARE_VTAB ){
  129129. /* If the pParse->declareVtab flag is set, do not delete any table
  129130. ** structure built up in pParse->pNewTable. The calling code (see vtab.c)
  129131. ** will take responsibility for freeing the Table structure.
  129132. */
  129133. sqlite3DeleteTable(db, pParse->pNewTable);
  129134. }
  129135. if( pParse->pWithToFree ) sqlite3WithDelete(db, pParse->pWithToFree);
  129136. sqlite3DeleteTrigger(db, pParse->pNewTrigger);
  129137. for(i=pParse->nzVar-1; i>=0; i--) sqlite3DbFree(db, pParse->azVar[i]);
  129138. sqlite3DbFree(db, pParse->azVar);
  129139. while( pParse->pAinc ){
  129140. AutoincInfo *p = pParse->pAinc;
  129141. pParse->pAinc = p->pNext;
  129142. sqlite3DbFree(db, p);
  129143. }
  129144. while( pParse->pZombieTab ){
  129145. Table *p = pParse->pZombieTab;
  129146. pParse->pZombieTab = p->pNextZombie;
  129147. sqlite3DeleteTable(db, p);
  129148. }
  129149. assert( nErr==0 || pParse->rc!=SQLITE_OK );
  129150. return nErr;
  129151. }
  129152. /************** End of tokenize.c ********************************************/
  129153. /************** Begin file complete.c ****************************************/
  129154. /*
  129155. ** 2001 September 15
  129156. **
  129157. ** The author disclaims copyright to this source code. In place of
  129158. ** a legal notice, here is a blessing:
  129159. **
  129160. ** May you do good and not evil.
  129161. ** May you find forgiveness for yourself and forgive others.
  129162. ** May you share freely, never taking more than you give.
  129163. **
  129164. *************************************************************************
  129165. ** An tokenizer for SQL
  129166. **
  129167. ** This file contains C code that implements the sqlite3_complete() API.
  129168. ** This code used to be part of the tokenizer.c source file. But by
  129169. ** separating it out, the code will be automatically omitted from
  129170. ** static links that do not use it.
  129171. */
  129172. /* #include "sqliteInt.h" */
  129173. #ifndef SQLITE_OMIT_COMPLETE
  129174. /*
  129175. ** This is defined in tokenize.c. We just have to import the definition.
  129176. */
  129177. #ifndef SQLITE_AMALGAMATION
  129178. #ifdef SQLITE_ASCII
  129179. #define IdChar(C) ((sqlite3CtypeMap[(unsigned char)C]&0x46)!=0)
  129180. #endif
  129181. #ifdef SQLITE_EBCDIC
  129182. SQLITE_PRIVATE const char sqlite3IsEbcdicIdChar[];
  129183. #define IdChar(C) (((c=C)>=0x42 && sqlite3IsEbcdicIdChar[c-0x40]))
  129184. #endif
  129185. #endif /* SQLITE_AMALGAMATION */
  129186. /*
  129187. ** Token types used by the sqlite3_complete() routine. See the header
  129188. ** comments on that procedure for additional information.
  129189. */
  129190. #define tkSEMI 0
  129191. #define tkWS 1
  129192. #define tkOTHER 2
  129193. #ifndef SQLITE_OMIT_TRIGGER
  129194. #define tkEXPLAIN 3
  129195. #define tkCREATE 4
  129196. #define tkTEMP 5
  129197. #define tkTRIGGER 6
  129198. #define tkEND 7
  129199. #endif
  129200. /*
  129201. ** Return TRUE if the given SQL string ends in a semicolon.
  129202. **
  129203. ** Special handling is require for CREATE TRIGGER statements.
  129204. ** Whenever the CREATE TRIGGER keywords are seen, the statement
  129205. ** must end with ";END;".
  129206. **
  129207. ** This implementation uses a state machine with 8 states:
  129208. **
  129209. ** (0) INVALID We have not yet seen a non-whitespace character.
  129210. **
  129211. ** (1) START At the beginning or end of an SQL statement. This routine
  129212. ** returns 1 if it ends in the START state and 0 if it ends
  129213. ** in any other state.
  129214. **
  129215. ** (2) NORMAL We are in the middle of statement which ends with a single
  129216. ** semicolon.
  129217. **
  129218. ** (3) EXPLAIN The keyword EXPLAIN has been seen at the beginning of
  129219. ** a statement.
  129220. **
  129221. ** (4) CREATE The keyword CREATE has been seen at the beginning of a
  129222. ** statement, possibly preceded by EXPLAIN and/or followed by
  129223. ** TEMP or TEMPORARY
  129224. **
  129225. ** (5) TRIGGER We are in the middle of a trigger definition that must be
  129226. ** ended by a semicolon, the keyword END, and another semicolon.
  129227. **
  129228. ** (6) SEMI We've seen the first semicolon in the ";END;" that occurs at
  129229. ** the end of a trigger definition.
  129230. **
  129231. ** (7) END We've seen the ";END" of the ";END;" that occurs at the end
  129232. ** of a trigger definition.
  129233. **
  129234. ** Transitions between states above are determined by tokens extracted
  129235. ** from the input. The following tokens are significant:
  129236. **
  129237. ** (0) tkSEMI A semicolon.
  129238. ** (1) tkWS Whitespace.
  129239. ** (2) tkOTHER Any other SQL token.
  129240. ** (3) tkEXPLAIN The "explain" keyword.
  129241. ** (4) tkCREATE The "create" keyword.
  129242. ** (5) tkTEMP The "temp" or "temporary" keyword.
  129243. ** (6) tkTRIGGER The "trigger" keyword.
  129244. ** (7) tkEND The "end" keyword.
  129245. **
  129246. ** Whitespace never causes a state transition and is always ignored.
  129247. ** This means that a SQL string of all whitespace is invalid.
  129248. **
  129249. ** If we compile with SQLITE_OMIT_TRIGGER, all of the computation needed
  129250. ** to recognize the end of a trigger can be omitted. All we have to do
  129251. ** is look for a semicolon that is not part of an string or comment.
  129252. */
  129253. SQLITE_API int sqlite3_complete(const char *zSql){
  129254. u8 state = 0; /* Current state, using numbers defined in header comment */
  129255. u8 token; /* Value of the next token */
  129256. #ifndef SQLITE_OMIT_TRIGGER
  129257. /* A complex statement machine used to detect the end of a CREATE TRIGGER
  129258. ** statement. This is the normal case.
  129259. */
  129260. static const u8 trans[8][8] = {
  129261. /* Token: */
  129262. /* State: ** SEMI WS OTHER EXPLAIN CREATE TEMP TRIGGER END */
  129263. /* 0 INVALID: */ { 1, 0, 2, 3, 4, 2, 2, 2, },
  129264. /* 1 START: */ { 1, 1, 2, 3, 4, 2, 2, 2, },
  129265. /* 2 NORMAL: */ { 1, 2, 2, 2, 2, 2, 2, 2, },
  129266. /* 3 EXPLAIN: */ { 1, 3, 3, 2, 4, 2, 2, 2, },
  129267. /* 4 CREATE: */ { 1, 4, 2, 2, 2, 4, 5, 2, },
  129268. /* 5 TRIGGER: */ { 6, 5, 5, 5, 5, 5, 5, 5, },
  129269. /* 6 SEMI: */ { 6, 6, 5, 5, 5, 5, 5, 7, },
  129270. /* 7 END: */ { 1, 7, 5, 5, 5, 5, 5, 5, },
  129271. };
  129272. #else
  129273. /* If triggers are not supported by this compile then the statement machine
  129274. ** used to detect the end of a statement is much simpler
  129275. */
  129276. static const u8 trans[3][3] = {
  129277. /* Token: */
  129278. /* State: ** SEMI WS OTHER */
  129279. /* 0 INVALID: */ { 1, 0, 2, },
  129280. /* 1 START: */ { 1, 1, 2, },
  129281. /* 2 NORMAL: */ { 1, 2, 2, },
  129282. };
  129283. #endif /* SQLITE_OMIT_TRIGGER */
  129284. #ifdef SQLITE_ENABLE_API_ARMOR
  129285. if( zSql==0 ){
  129286. (void)SQLITE_MISUSE_BKPT;
  129287. return 0;
  129288. }
  129289. #endif
  129290. while( *zSql ){
  129291. switch( *zSql ){
  129292. case ';': { /* A semicolon */
  129293. token = tkSEMI;
  129294. break;
  129295. }
  129296. case ' ':
  129297. case '\r':
  129298. case '\t':
  129299. case '\n':
  129300. case '\f': { /* White space is ignored */
  129301. token = tkWS;
  129302. break;
  129303. }
  129304. case '/': { /* C-style comments */
  129305. if( zSql[1]!='*' ){
  129306. token = tkOTHER;
  129307. break;
  129308. }
  129309. zSql += 2;
  129310. while( zSql[0] && (zSql[0]!='*' || zSql[1]!='/') ){ zSql++; }
  129311. if( zSql[0]==0 ) return 0;
  129312. zSql++;
  129313. token = tkWS;
  129314. break;
  129315. }
  129316. case '-': { /* SQL-style comments from "--" to end of line */
  129317. if( zSql[1]!='-' ){
  129318. token = tkOTHER;
  129319. break;
  129320. }
  129321. while( *zSql && *zSql!='\n' ){ zSql++; }
  129322. if( *zSql==0 ) return state==1;
  129323. token = tkWS;
  129324. break;
  129325. }
  129326. case '[': { /* Microsoft-style identifiers in [...] */
  129327. zSql++;
  129328. while( *zSql && *zSql!=']' ){ zSql++; }
  129329. if( *zSql==0 ) return 0;
  129330. token = tkOTHER;
  129331. break;
  129332. }
  129333. case '`': /* Grave-accent quoted symbols used by MySQL */
  129334. case '"': /* single- and double-quoted strings */
  129335. case '\'': {
  129336. int c = *zSql;
  129337. zSql++;
  129338. while( *zSql && *zSql!=c ){ zSql++; }
  129339. if( *zSql==0 ) return 0;
  129340. token = tkOTHER;
  129341. break;
  129342. }
  129343. default: {
  129344. #ifdef SQLITE_EBCDIC
  129345. unsigned char c;
  129346. #endif
  129347. if( IdChar((u8)*zSql) ){
  129348. /* Keywords and unquoted identifiers */
  129349. int nId;
  129350. for(nId=1; IdChar(zSql[nId]); nId++){}
  129351. #ifdef SQLITE_OMIT_TRIGGER
  129352. token = tkOTHER;
  129353. #else
  129354. switch( *zSql ){
  129355. case 'c': case 'C': {
  129356. if( nId==6 && sqlite3StrNICmp(zSql, "create", 6)==0 ){
  129357. token = tkCREATE;
  129358. }else{
  129359. token = tkOTHER;
  129360. }
  129361. break;
  129362. }
  129363. case 't': case 'T': {
  129364. if( nId==7 && sqlite3StrNICmp(zSql, "trigger", 7)==0 ){
  129365. token = tkTRIGGER;
  129366. }else if( nId==4 && sqlite3StrNICmp(zSql, "temp", 4)==0 ){
  129367. token = tkTEMP;
  129368. }else if( nId==9 && sqlite3StrNICmp(zSql, "temporary", 9)==0 ){
  129369. token = tkTEMP;
  129370. }else{
  129371. token = tkOTHER;
  129372. }
  129373. break;
  129374. }
  129375. case 'e': case 'E': {
  129376. if( nId==3 && sqlite3StrNICmp(zSql, "end", 3)==0 ){
  129377. token = tkEND;
  129378. }else
  129379. #ifndef SQLITE_OMIT_EXPLAIN
  129380. if( nId==7 && sqlite3StrNICmp(zSql, "explain", 7)==0 ){
  129381. token = tkEXPLAIN;
  129382. }else
  129383. #endif
  129384. {
  129385. token = tkOTHER;
  129386. }
  129387. break;
  129388. }
  129389. default: {
  129390. token = tkOTHER;
  129391. break;
  129392. }
  129393. }
  129394. #endif /* SQLITE_OMIT_TRIGGER */
  129395. zSql += nId-1;
  129396. }else{
  129397. /* Operators and special symbols */
  129398. token = tkOTHER;
  129399. }
  129400. break;
  129401. }
  129402. }
  129403. state = trans[state][token];
  129404. zSql++;
  129405. }
  129406. return state==1;
  129407. }
  129408. #ifndef SQLITE_OMIT_UTF16
  129409. /*
  129410. ** This routine is the same as the sqlite3_complete() routine described
  129411. ** above, except that the parameter is required to be UTF-16 encoded, not
  129412. ** UTF-8.
  129413. */
  129414. SQLITE_API int sqlite3_complete16(const void *zSql){
  129415. sqlite3_value *pVal;
  129416. char const *zSql8;
  129417. int rc;
  129418. #ifndef SQLITE_OMIT_AUTOINIT
  129419. rc = sqlite3_initialize();
  129420. if( rc ) return rc;
  129421. #endif
  129422. pVal = sqlite3ValueNew(0);
  129423. sqlite3ValueSetStr(pVal, -1, zSql, SQLITE_UTF16NATIVE, SQLITE_STATIC);
  129424. zSql8 = sqlite3ValueText(pVal, SQLITE_UTF8);
  129425. if( zSql8 ){
  129426. rc = sqlite3_complete(zSql8);
  129427. }else{
  129428. rc = SQLITE_NOMEM_BKPT;
  129429. }
  129430. sqlite3ValueFree(pVal);
  129431. return rc & 0xff;
  129432. }
  129433. #endif /* SQLITE_OMIT_UTF16 */
  129434. #endif /* SQLITE_OMIT_COMPLETE */
  129435. /************** End of complete.c ********************************************/
  129436. /************** Begin file main.c ********************************************/
  129437. /*
  129438. ** 2001 September 15
  129439. **
  129440. ** The author disclaims copyright to this source code. In place of
  129441. ** a legal notice, here is a blessing:
  129442. **
  129443. ** May you do good and not evil.
  129444. ** May you find forgiveness for yourself and forgive others.
  129445. ** May you share freely, never taking more than you give.
  129446. **
  129447. *************************************************************************
  129448. ** Main file for the SQLite library. The routines in this file
  129449. ** implement the programmer interface to the library. Routines in
  129450. ** other files are for internal use by SQLite and should not be
  129451. ** accessed by users of the library.
  129452. */
  129453. /* #include "sqliteInt.h" */
  129454. #ifdef SQLITE_ENABLE_FTS3
  129455. /************** Include fts3.h in the middle of main.c ***********************/
  129456. /************** Begin file fts3.h ********************************************/
  129457. /*
  129458. ** 2006 Oct 10
  129459. **
  129460. ** The author disclaims copyright to this source code. In place of
  129461. ** a legal notice, here is a blessing:
  129462. **
  129463. ** May you do good and not evil.
  129464. ** May you find forgiveness for yourself and forgive others.
  129465. ** May you share freely, never taking more than you give.
  129466. **
  129467. ******************************************************************************
  129468. **
  129469. ** This header file is used by programs that want to link against the
  129470. ** FTS3 library. All it does is declare the sqlite3Fts3Init() interface.
  129471. */
  129472. /* #include "sqlite3.h" */
  129473. #if 0
  129474. extern "C" {
  129475. #endif /* __cplusplus */
  129476. SQLITE_PRIVATE int sqlite3Fts3Init(sqlite3 *db);
  129477. #if 0
  129478. } /* extern "C" */
  129479. #endif /* __cplusplus */
  129480. /************** End of fts3.h ************************************************/
  129481. /************** Continuing where we left off in main.c ***********************/
  129482. #endif
  129483. #ifdef SQLITE_ENABLE_RTREE
  129484. /************** Include rtree.h in the middle of main.c **********************/
  129485. /************** Begin file rtree.h *******************************************/
  129486. /*
  129487. ** 2008 May 26
  129488. **
  129489. ** The author disclaims copyright to this source code. In place of
  129490. ** a legal notice, here is a blessing:
  129491. **
  129492. ** May you do good and not evil.
  129493. ** May you find forgiveness for yourself and forgive others.
  129494. ** May you share freely, never taking more than you give.
  129495. **
  129496. ******************************************************************************
  129497. **
  129498. ** This header file is used by programs that want to link against the
  129499. ** RTREE library. All it does is declare the sqlite3RtreeInit() interface.
  129500. */
  129501. /* #include "sqlite3.h" */
  129502. #if 0
  129503. extern "C" {
  129504. #endif /* __cplusplus */
  129505. SQLITE_PRIVATE int sqlite3RtreeInit(sqlite3 *db);
  129506. #if 0
  129507. } /* extern "C" */
  129508. #endif /* __cplusplus */
  129509. /************** End of rtree.h ***********************************************/
  129510. /************** Continuing where we left off in main.c ***********************/
  129511. #endif
  129512. #ifdef SQLITE_ENABLE_ICU
  129513. /************** Include sqliteicu.h in the middle of main.c ******************/
  129514. /************** Begin file sqliteicu.h ***************************************/
  129515. /*
  129516. ** 2008 May 26
  129517. **
  129518. ** The author disclaims copyright to this source code. In place of
  129519. ** a legal notice, here is a blessing:
  129520. **
  129521. ** May you do good and not evil.
  129522. ** May you find forgiveness for yourself and forgive others.
  129523. ** May you share freely, never taking more than you give.
  129524. **
  129525. ******************************************************************************
  129526. **
  129527. ** This header file is used by programs that want to link against the
  129528. ** ICU extension. All it does is declare the sqlite3IcuInit() interface.
  129529. */
  129530. /* #include "sqlite3.h" */
  129531. #if 0
  129532. extern "C" {
  129533. #endif /* __cplusplus */
  129534. SQLITE_PRIVATE int sqlite3IcuInit(sqlite3 *db);
  129535. #if 0
  129536. } /* extern "C" */
  129537. #endif /* __cplusplus */
  129538. /************** End of sqliteicu.h *******************************************/
  129539. /************** Continuing where we left off in main.c ***********************/
  129540. #endif
  129541. #ifdef SQLITE_ENABLE_JSON1
  129542. SQLITE_PRIVATE int sqlite3Json1Init(sqlite3*);
  129543. #endif
  129544. #ifdef SQLITE_ENABLE_FTS5
  129545. SQLITE_PRIVATE int sqlite3Fts5Init(sqlite3*);
  129546. #endif
  129547. #ifndef SQLITE_AMALGAMATION
  129548. /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
  129549. ** contains the text of SQLITE_VERSION macro.
  129550. */
  129551. SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
  129552. #endif
  129553. /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
  129554. ** a pointer to the to the sqlite3_version[] string constant.
  129555. */
  129556. SQLITE_API const char *sqlite3_libversion(void){ return sqlite3_version; }
  129557. /* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
  129558. ** pointer to a string constant whose value is the same as the
  129559. ** SQLITE_SOURCE_ID C preprocessor macro.
  129560. */
  129561. SQLITE_API const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
  129562. /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
  129563. ** returns an integer equal to SQLITE_VERSION_NUMBER.
  129564. */
  129565. SQLITE_API int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
  129566. /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
  129567. ** zero if and only if SQLite was compiled with mutexing code omitted due to
  129568. ** the SQLITE_THREADSAFE compile-time option being set to 0.
  129569. */
  129570. SQLITE_API int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
  129571. /*
  129572. ** When compiling the test fixture or with debugging enabled (on Win32),
  129573. ** this variable being set to non-zero will cause OSTRACE macros to emit
  129574. ** extra diagnostic information.
  129575. */
  129576. #ifdef SQLITE_HAVE_OS_TRACE
  129577. # ifndef SQLITE_DEBUG_OS_TRACE
  129578. # define SQLITE_DEBUG_OS_TRACE 0
  129579. # endif
  129580. int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
  129581. #endif
  129582. #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
  129583. /*
  129584. ** If the following function pointer is not NULL and if
  129585. ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
  129586. ** I/O active are written using this function. These messages
  129587. ** are intended for debugging activity only.
  129588. */
  129589. SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
  129590. #endif
  129591. /*
  129592. ** If the following global variable points to a string which is the
  129593. ** name of a directory, then that directory will be used to store
  129594. ** temporary files.
  129595. **
  129596. ** See also the "PRAGMA temp_store_directory" SQL command.
  129597. */
  129598. SQLITE_API char *sqlite3_temp_directory = 0;
  129599. /*
  129600. ** If the following global variable points to a string which is the
  129601. ** name of a directory, then that directory will be used to store
  129602. ** all database files specified with a relative pathname.
  129603. **
  129604. ** See also the "PRAGMA data_store_directory" SQL command.
  129605. */
  129606. SQLITE_API char *sqlite3_data_directory = 0;
  129607. /*
  129608. ** Initialize SQLite.
  129609. **
  129610. ** This routine must be called to initialize the memory allocation,
  129611. ** VFS, and mutex subsystems prior to doing any serious work with
  129612. ** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
  129613. ** this routine will be called automatically by key routines such as
  129614. ** sqlite3_open().
  129615. **
  129616. ** This routine is a no-op except on its very first call for the process,
  129617. ** or for the first call after a call to sqlite3_shutdown.
  129618. **
  129619. ** The first thread to call this routine runs the initialization to
  129620. ** completion. If subsequent threads call this routine before the first
  129621. ** thread has finished the initialization process, then the subsequent
  129622. ** threads must block until the first thread finishes with the initialization.
  129623. **
  129624. ** The first thread might call this routine recursively. Recursive
  129625. ** calls to this routine should not block, of course. Otherwise the
  129626. ** initialization process would never complete.
  129627. **
  129628. ** Let X be the first thread to enter this routine. Let Y be some other
  129629. ** thread. Then while the initial invocation of this routine by X is
  129630. ** incomplete, it is required that:
  129631. **
  129632. ** * Calls to this routine from Y must block until the outer-most
  129633. ** call by X completes.
  129634. **
  129635. ** * Recursive calls to this routine from thread X return immediately
  129636. ** without blocking.
  129637. */
  129638. SQLITE_API int sqlite3_initialize(void){
  129639. MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
  129640. int rc; /* Result code */
  129641. #ifdef SQLITE_EXTRA_INIT
  129642. int bRunExtraInit = 0; /* Extra initialization needed */
  129643. #endif
  129644. #ifdef SQLITE_OMIT_WSD
  129645. rc = sqlite3_wsd_init(4096, 24);
  129646. if( rc!=SQLITE_OK ){
  129647. return rc;
  129648. }
  129649. #endif
  129650. /* If the following assert() fails on some obscure processor/compiler
  129651. ** combination, the work-around is to set the correct pointer
  129652. ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
  129653. assert( SQLITE_PTRSIZE==sizeof(char*) );
  129654. /* If SQLite is already completely initialized, then this call
  129655. ** to sqlite3_initialize() should be a no-op. But the initialization
  129656. ** must be complete. So isInit must not be set until the very end
  129657. ** of this routine.
  129658. */
  129659. if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
  129660. /* Make sure the mutex subsystem is initialized. If unable to
  129661. ** initialize the mutex subsystem, return early with the error.
  129662. ** If the system is so sick that we are unable to allocate a mutex,
  129663. ** there is not much SQLite is going to be able to do.
  129664. **
  129665. ** The mutex subsystem must take care of serializing its own
  129666. ** initialization.
  129667. */
  129668. rc = sqlite3MutexInit();
  129669. if( rc ) return rc;
  129670. /* Initialize the malloc() system and the recursive pInitMutex mutex.
  129671. ** This operation is protected by the STATIC_MASTER mutex. Note that
  129672. ** MutexAlloc() is called for a static mutex prior to initializing the
  129673. ** malloc subsystem - this implies that the allocation of a static
  129674. ** mutex must not require support from the malloc subsystem.
  129675. */
  129676. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  129677. sqlite3_mutex_enter(pMaster);
  129678. sqlite3GlobalConfig.isMutexInit = 1;
  129679. if( !sqlite3GlobalConfig.isMallocInit ){
  129680. rc = sqlite3MallocInit();
  129681. }
  129682. if( rc==SQLITE_OK ){
  129683. sqlite3GlobalConfig.isMallocInit = 1;
  129684. if( !sqlite3GlobalConfig.pInitMutex ){
  129685. sqlite3GlobalConfig.pInitMutex =
  129686. sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
  129687. if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
  129688. rc = SQLITE_NOMEM_BKPT;
  129689. }
  129690. }
  129691. }
  129692. if( rc==SQLITE_OK ){
  129693. sqlite3GlobalConfig.nRefInitMutex++;
  129694. }
  129695. sqlite3_mutex_leave(pMaster);
  129696. /* If rc is not SQLITE_OK at this point, then either the malloc
  129697. ** subsystem could not be initialized or the system failed to allocate
  129698. ** the pInitMutex mutex. Return an error in either case. */
  129699. if( rc!=SQLITE_OK ){
  129700. return rc;
  129701. }
  129702. /* Do the rest of the initialization under the recursive mutex so
  129703. ** that we will be able to handle recursive calls into
  129704. ** sqlite3_initialize(). The recursive calls normally come through
  129705. ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
  129706. ** recursive calls might also be possible.
  129707. **
  129708. ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
  129709. ** to the xInit method, so the xInit method need not be threadsafe.
  129710. **
  129711. ** The following mutex is what serializes access to the appdef pcache xInit
  129712. ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
  129713. ** call to sqlite3PcacheInitialize().
  129714. */
  129715. sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
  129716. if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
  129717. sqlite3GlobalConfig.inProgress = 1;
  129718. #ifdef SQLITE_ENABLE_SQLLOG
  129719. {
  129720. extern void sqlite3_init_sqllog(void);
  129721. sqlite3_init_sqllog();
  129722. }
  129723. #endif
  129724. memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
  129725. sqlite3RegisterBuiltinFunctions();
  129726. if( sqlite3GlobalConfig.isPCacheInit==0 ){
  129727. rc = sqlite3PcacheInitialize();
  129728. }
  129729. if( rc==SQLITE_OK ){
  129730. sqlite3GlobalConfig.isPCacheInit = 1;
  129731. rc = sqlite3OsInit();
  129732. }
  129733. if( rc==SQLITE_OK ){
  129734. sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
  129735. sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
  129736. sqlite3GlobalConfig.isInit = 1;
  129737. #ifdef SQLITE_EXTRA_INIT
  129738. bRunExtraInit = 1;
  129739. #endif
  129740. }
  129741. sqlite3GlobalConfig.inProgress = 0;
  129742. }
  129743. sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
  129744. /* Go back under the static mutex and clean up the recursive
  129745. ** mutex to prevent a resource leak.
  129746. */
  129747. sqlite3_mutex_enter(pMaster);
  129748. sqlite3GlobalConfig.nRefInitMutex--;
  129749. if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
  129750. assert( sqlite3GlobalConfig.nRefInitMutex==0 );
  129751. sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
  129752. sqlite3GlobalConfig.pInitMutex = 0;
  129753. }
  129754. sqlite3_mutex_leave(pMaster);
  129755. /* The following is just a sanity check to make sure SQLite has
  129756. ** been compiled correctly. It is important to run this code, but
  129757. ** we don't want to run it too often and soak up CPU cycles for no
  129758. ** reason. So we run it once during initialization.
  129759. */
  129760. #ifndef NDEBUG
  129761. #ifndef SQLITE_OMIT_FLOATING_POINT
  129762. /* This section of code's only "output" is via assert() statements. */
  129763. if ( rc==SQLITE_OK ){
  129764. u64 x = (((u64)1)<<63)-1;
  129765. double y;
  129766. assert(sizeof(x)==8);
  129767. assert(sizeof(x)==sizeof(y));
  129768. memcpy(&y, &x, 8);
  129769. assert( sqlite3IsNaN(y) );
  129770. }
  129771. #endif
  129772. #endif
  129773. /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
  129774. ** compile-time option.
  129775. */
  129776. #ifdef SQLITE_EXTRA_INIT
  129777. if( bRunExtraInit ){
  129778. int SQLITE_EXTRA_INIT(const char*);
  129779. rc = SQLITE_EXTRA_INIT(0);
  129780. }
  129781. #endif
  129782. return rc;
  129783. }
  129784. /*
  129785. ** Undo the effects of sqlite3_initialize(). Must not be called while
  129786. ** there are outstanding database connections or memory allocations or
  129787. ** while any part of SQLite is otherwise in use in any thread. This
  129788. ** routine is not threadsafe. But it is safe to invoke this routine
  129789. ** on when SQLite is already shut down. If SQLite is already shut down
  129790. ** when this routine is invoked, then this routine is a harmless no-op.
  129791. */
  129792. SQLITE_API int sqlite3_shutdown(void){
  129793. #ifdef SQLITE_OMIT_WSD
  129794. int rc = sqlite3_wsd_init(4096, 24);
  129795. if( rc!=SQLITE_OK ){
  129796. return rc;
  129797. }
  129798. #endif
  129799. if( sqlite3GlobalConfig.isInit ){
  129800. #ifdef SQLITE_EXTRA_SHUTDOWN
  129801. void SQLITE_EXTRA_SHUTDOWN(void);
  129802. SQLITE_EXTRA_SHUTDOWN();
  129803. #endif
  129804. sqlite3_os_end();
  129805. sqlite3_reset_auto_extension();
  129806. sqlite3GlobalConfig.isInit = 0;
  129807. }
  129808. if( sqlite3GlobalConfig.isPCacheInit ){
  129809. sqlite3PcacheShutdown();
  129810. sqlite3GlobalConfig.isPCacheInit = 0;
  129811. }
  129812. if( sqlite3GlobalConfig.isMallocInit ){
  129813. sqlite3MallocEnd();
  129814. sqlite3GlobalConfig.isMallocInit = 0;
  129815. #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
  129816. /* The heap subsystem has now been shutdown and these values are supposed
  129817. ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
  129818. ** which would rely on that heap subsystem; therefore, make sure these
  129819. ** values cannot refer to heap memory that was just invalidated when the
  129820. ** heap subsystem was shutdown. This is only done if the current call to
  129821. ** this function resulted in the heap subsystem actually being shutdown.
  129822. */
  129823. sqlite3_data_directory = 0;
  129824. sqlite3_temp_directory = 0;
  129825. #endif
  129826. }
  129827. if( sqlite3GlobalConfig.isMutexInit ){
  129828. sqlite3MutexEnd();
  129829. sqlite3GlobalConfig.isMutexInit = 0;
  129830. }
  129831. return SQLITE_OK;
  129832. }
  129833. /*
  129834. ** This API allows applications to modify the global configuration of
  129835. ** the SQLite library at run-time.
  129836. **
  129837. ** This routine should only be called when there are no outstanding
  129838. ** database connections or memory allocations. This routine is not
  129839. ** threadsafe. Failure to heed these warnings can lead to unpredictable
  129840. ** behavior.
  129841. */
  129842. SQLITE_API int sqlite3_config(int op, ...){
  129843. va_list ap;
  129844. int rc = SQLITE_OK;
  129845. /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
  129846. ** the SQLite library is in use. */
  129847. if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
  129848. va_start(ap, op);
  129849. switch( op ){
  129850. /* Mutex configuration options are only available in a threadsafe
  129851. ** compile.
  129852. */
  129853. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
  129854. case SQLITE_CONFIG_SINGLETHREAD: {
  129855. /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
  129856. ** Single-thread. */
  129857. sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
  129858. sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
  129859. break;
  129860. }
  129861. #endif
  129862. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
  129863. case SQLITE_CONFIG_MULTITHREAD: {
  129864. /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
  129865. ** Multi-thread. */
  129866. sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
  129867. sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
  129868. break;
  129869. }
  129870. #endif
  129871. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
  129872. case SQLITE_CONFIG_SERIALIZED: {
  129873. /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
  129874. ** Serialized. */
  129875. sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
  129876. sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
  129877. break;
  129878. }
  129879. #endif
  129880. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
  129881. case SQLITE_CONFIG_MUTEX: {
  129882. /* Specify an alternative mutex implementation */
  129883. sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
  129884. break;
  129885. }
  129886. #endif
  129887. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
  129888. case SQLITE_CONFIG_GETMUTEX: {
  129889. /* Retrieve the current mutex implementation */
  129890. *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
  129891. break;
  129892. }
  129893. #endif
  129894. case SQLITE_CONFIG_MALLOC: {
  129895. /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
  129896. ** single argument which is a pointer to an instance of the
  129897. ** sqlite3_mem_methods structure. The argument specifies alternative
  129898. ** low-level memory allocation routines to be used in place of the memory
  129899. ** allocation routines built into SQLite. */
  129900. sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
  129901. break;
  129902. }
  129903. case SQLITE_CONFIG_GETMALLOC: {
  129904. /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
  129905. ** single argument which is a pointer to an instance of the
  129906. ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
  129907. ** filled with the currently defined memory allocation routines. */
  129908. if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
  129909. *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
  129910. break;
  129911. }
  129912. case SQLITE_CONFIG_MEMSTATUS: {
  129913. /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
  129914. ** single argument of type int, interpreted as a boolean, which enables
  129915. ** or disables the collection of memory allocation statistics. */
  129916. sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
  129917. break;
  129918. }
  129919. case SQLITE_CONFIG_SCRATCH: {
  129920. /* EVIDENCE-OF: R-08404-60887 There are three arguments to
  129921. ** SQLITE_CONFIG_SCRATCH: A pointer an 8-byte aligned memory buffer from
  129922. ** which the scratch allocations will be drawn, the size of each scratch
  129923. ** allocation (sz), and the maximum number of scratch allocations (N). */
  129924. sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
  129925. sqlite3GlobalConfig.szScratch = va_arg(ap, int);
  129926. sqlite3GlobalConfig.nScratch = va_arg(ap, int);
  129927. break;
  129928. }
  129929. case SQLITE_CONFIG_PAGECACHE: {
  129930. /* EVIDENCE-OF: R-18761-36601 There are three arguments to
  129931. ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
  129932. ** the size of each page cache line (sz), and the number of cache lines
  129933. ** (N). */
  129934. sqlite3GlobalConfig.pPage = va_arg(ap, void*);
  129935. sqlite3GlobalConfig.szPage = va_arg(ap, int);
  129936. sqlite3GlobalConfig.nPage = va_arg(ap, int);
  129937. break;
  129938. }
  129939. case SQLITE_CONFIG_PCACHE_HDRSZ: {
  129940. /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
  129941. ** a single parameter which is a pointer to an integer and writes into
  129942. ** that integer the number of extra bytes per page required for each page
  129943. ** in SQLITE_CONFIG_PAGECACHE. */
  129944. *va_arg(ap, int*) =
  129945. sqlite3HeaderSizeBtree() +
  129946. sqlite3HeaderSizePcache() +
  129947. sqlite3HeaderSizePcache1();
  129948. break;
  129949. }
  129950. case SQLITE_CONFIG_PCACHE: {
  129951. /* no-op */
  129952. break;
  129953. }
  129954. case SQLITE_CONFIG_GETPCACHE: {
  129955. /* now an error */
  129956. rc = SQLITE_ERROR;
  129957. break;
  129958. }
  129959. case SQLITE_CONFIG_PCACHE2: {
  129960. /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
  129961. ** single argument which is a pointer to an sqlite3_pcache_methods2
  129962. ** object. This object specifies the interface to a custom page cache
  129963. ** implementation. */
  129964. sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
  129965. break;
  129966. }
  129967. case SQLITE_CONFIG_GETPCACHE2: {
  129968. /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
  129969. ** single argument which is a pointer to an sqlite3_pcache_methods2
  129970. ** object. SQLite copies of the current page cache implementation into
  129971. ** that object. */
  129972. if( sqlite3GlobalConfig.pcache2.xInit==0 ){
  129973. sqlite3PCacheSetDefault();
  129974. }
  129975. *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
  129976. break;
  129977. }
  129978. /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
  129979. ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
  129980. ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
  129981. #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
  129982. case SQLITE_CONFIG_HEAP: {
  129983. /* EVIDENCE-OF: R-19854-42126 There are three arguments to
  129984. ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
  129985. ** number of bytes in the memory buffer, and the minimum allocation size.
  129986. */
  129987. sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
  129988. sqlite3GlobalConfig.nHeap = va_arg(ap, int);
  129989. sqlite3GlobalConfig.mnReq = va_arg(ap, int);
  129990. if( sqlite3GlobalConfig.mnReq<1 ){
  129991. sqlite3GlobalConfig.mnReq = 1;
  129992. }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
  129993. /* cap min request size at 2^12 */
  129994. sqlite3GlobalConfig.mnReq = (1<<12);
  129995. }
  129996. if( sqlite3GlobalConfig.pHeap==0 ){
  129997. /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
  129998. ** is NULL, then SQLite reverts to using its default memory allocator
  129999. ** (the system malloc() implementation), undoing any prior invocation of
  130000. ** SQLITE_CONFIG_MALLOC.
  130001. **
  130002. ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
  130003. ** revert to its default implementation when sqlite3_initialize() is run
  130004. */
  130005. memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
  130006. }else{
  130007. /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
  130008. ** alternative memory allocator is engaged to handle all of SQLites
  130009. ** memory allocation needs. */
  130010. #ifdef SQLITE_ENABLE_MEMSYS3
  130011. sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
  130012. #endif
  130013. #ifdef SQLITE_ENABLE_MEMSYS5
  130014. sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
  130015. #endif
  130016. }
  130017. break;
  130018. }
  130019. #endif
  130020. case SQLITE_CONFIG_LOOKASIDE: {
  130021. sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
  130022. sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
  130023. break;
  130024. }
  130025. /* Record a pointer to the logger function and its first argument.
  130026. ** The default is NULL. Logging is disabled if the function pointer is
  130027. ** NULL.
  130028. */
  130029. case SQLITE_CONFIG_LOG: {
  130030. /* MSVC is picky about pulling func ptrs from va lists.
  130031. ** http://support.microsoft.com/kb/47961
  130032. ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
  130033. */
  130034. typedef void(*LOGFUNC_t)(void*,int,const char*);
  130035. sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
  130036. sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
  130037. break;
  130038. }
  130039. /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
  130040. ** can be changed at start-time using the
  130041. ** sqlite3_config(SQLITE_CONFIG_URI,1) or
  130042. ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
  130043. */
  130044. case SQLITE_CONFIG_URI: {
  130045. /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
  130046. ** argument of type int. If non-zero, then URI handling is globally
  130047. ** enabled. If the parameter is zero, then URI handling is globally
  130048. ** disabled. */
  130049. sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
  130050. break;
  130051. }
  130052. case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
  130053. /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
  130054. ** option takes a single integer argument which is interpreted as a
  130055. ** boolean in order to enable or disable the use of covering indices for
  130056. ** full table scans in the query optimizer. */
  130057. sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
  130058. break;
  130059. }
  130060. #ifdef SQLITE_ENABLE_SQLLOG
  130061. case SQLITE_CONFIG_SQLLOG: {
  130062. typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
  130063. sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
  130064. sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
  130065. break;
  130066. }
  130067. #endif
  130068. case SQLITE_CONFIG_MMAP_SIZE: {
  130069. /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
  130070. ** integer (sqlite3_int64) values that are the default mmap size limit
  130071. ** (the default setting for PRAGMA mmap_size) and the maximum allowed
  130072. ** mmap size limit. */
  130073. sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
  130074. sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
  130075. /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
  130076. ** negative, then that argument is changed to its compile-time default.
  130077. **
  130078. ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
  130079. ** silently truncated if necessary so that it does not exceed the
  130080. ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
  130081. ** compile-time option.
  130082. */
  130083. if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
  130084. mxMmap = SQLITE_MAX_MMAP_SIZE;
  130085. }
  130086. if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
  130087. if( szMmap>mxMmap) szMmap = mxMmap;
  130088. sqlite3GlobalConfig.mxMmap = mxMmap;
  130089. sqlite3GlobalConfig.szMmap = szMmap;
  130090. break;
  130091. }
  130092. #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
  130093. case SQLITE_CONFIG_WIN32_HEAPSIZE: {
  130094. /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
  130095. ** unsigned integer value that specifies the maximum size of the created
  130096. ** heap. */
  130097. sqlite3GlobalConfig.nHeap = va_arg(ap, int);
  130098. break;
  130099. }
  130100. #endif
  130101. case SQLITE_CONFIG_PMASZ: {
  130102. sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
  130103. break;
  130104. }
  130105. case SQLITE_CONFIG_STMTJRNL_SPILL: {
  130106. sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
  130107. break;
  130108. }
  130109. default: {
  130110. rc = SQLITE_ERROR;
  130111. break;
  130112. }
  130113. }
  130114. va_end(ap);
  130115. return rc;
  130116. }
  130117. /*
  130118. ** Set up the lookaside buffers for a database connection.
  130119. ** Return SQLITE_OK on success.
  130120. ** If lookaside is already active, return SQLITE_BUSY.
  130121. **
  130122. ** The sz parameter is the number of bytes in each lookaside slot.
  130123. ** The cnt parameter is the number of slots. If pStart is NULL the
  130124. ** space for the lookaside memory is obtained from sqlite3_malloc().
  130125. ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
  130126. ** the lookaside memory.
  130127. */
  130128. static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
  130129. #ifndef SQLITE_OMIT_LOOKASIDE
  130130. void *pStart;
  130131. if( db->lookaside.nOut ){
  130132. return SQLITE_BUSY;
  130133. }
  130134. /* Free any existing lookaside buffer for this handle before
  130135. ** allocating a new one so we don't have to have space for
  130136. ** both at the same time.
  130137. */
  130138. if( db->lookaside.bMalloced ){
  130139. sqlite3_free(db->lookaside.pStart);
  130140. }
  130141. /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
  130142. ** than a pointer to be useful.
  130143. */
  130144. sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
  130145. if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
  130146. if( cnt<0 ) cnt = 0;
  130147. if( sz==0 || cnt==0 ){
  130148. sz = 0;
  130149. pStart = 0;
  130150. }else if( pBuf==0 ){
  130151. sqlite3BeginBenignMalloc();
  130152. pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
  130153. sqlite3EndBenignMalloc();
  130154. if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
  130155. }else{
  130156. pStart = pBuf;
  130157. }
  130158. db->lookaside.pStart = pStart;
  130159. db->lookaside.pFree = 0;
  130160. db->lookaside.sz = (u16)sz;
  130161. if( pStart ){
  130162. int i;
  130163. LookasideSlot *p;
  130164. assert( sz > (int)sizeof(LookasideSlot*) );
  130165. p = (LookasideSlot*)pStart;
  130166. for(i=cnt-1; i>=0; i--){
  130167. p->pNext = db->lookaside.pFree;
  130168. db->lookaside.pFree = p;
  130169. p = (LookasideSlot*)&((u8*)p)[sz];
  130170. }
  130171. db->lookaside.pEnd = p;
  130172. db->lookaside.bDisable = 0;
  130173. db->lookaside.bMalloced = pBuf==0 ?1:0;
  130174. }else{
  130175. db->lookaside.pStart = db;
  130176. db->lookaside.pEnd = db;
  130177. db->lookaside.bDisable = 1;
  130178. db->lookaside.bMalloced = 0;
  130179. }
  130180. #endif /* SQLITE_OMIT_LOOKASIDE */
  130181. return SQLITE_OK;
  130182. }
  130183. /*
  130184. ** Return the mutex associated with a database connection.
  130185. */
  130186. SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
  130187. #ifdef SQLITE_ENABLE_API_ARMOR
  130188. if( !sqlite3SafetyCheckOk(db) ){
  130189. (void)SQLITE_MISUSE_BKPT;
  130190. return 0;
  130191. }
  130192. #endif
  130193. return db->mutex;
  130194. }
  130195. /*
  130196. ** Free up as much memory as we can from the given database
  130197. ** connection.
  130198. */
  130199. SQLITE_API int sqlite3_db_release_memory(sqlite3 *db){
  130200. int i;
  130201. #ifdef SQLITE_ENABLE_API_ARMOR
  130202. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  130203. #endif
  130204. sqlite3_mutex_enter(db->mutex);
  130205. sqlite3BtreeEnterAll(db);
  130206. for(i=0; i<db->nDb; i++){
  130207. Btree *pBt = db->aDb[i].pBt;
  130208. if( pBt ){
  130209. Pager *pPager = sqlite3BtreePager(pBt);
  130210. sqlite3PagerShrink(pPager);
  130211. }
  130212. }
  130213. sqlite3BtreeLeaveAll(db);
  130214. sqlite3_mutex_leave(db->mutex);
  130215. return SQLITE_OK;
  130216. }
  130217. /*
  130218. ** Flush any dirty pages in the pager-cache for any attached database
  130219. ** to disk.
  130220. */
  130221. SQLITE_API int sqlite3_db_cacheflush(sqlite3 *db){
  130222. int i;
  130223. int rc = SQLITE_OK;
  130224. int bSeenBusy = 0;
  130225. #ifdef SQLITE_ENABLE_API_ARMOR
  130226. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  130227. #endif
  130228. sqlite3_mutex_enter(db->mutex);
  130229. sqlite3BtreeEnterAll(db);
  130230. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  130231. Btree *pBt = db->aDb[i].pBt;
  130232. if( pBt && sqlite3BtreeIsInTrans(pBt) ){
  130233. Pager *pPager = sqlite3BtreePager(pBt);
  130234. rc = sqlite3PagerFlush(pPager);
  130235. if( rc==SQLITE_BUSY ){
  130236. bSeenBusy = 1;
  130237. rc = SQLITE_OK;
  130238. }
  130239. }
  130240. }
  130241. sqlite3BtreeLeaveAll(db);
  130242. sqlite3_mutex_leave(db->mutex);
  130243. return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
  130244. }
  130245. /*
  130246. ** Configuration settings for an individual database connection
  130247. */
  130248. SQLITE_API int sqlite3_db_config(sqlite3 *db, int op, ...){
  130249. va_list ap;
  130250. int rc;
  130251. va_start(ap, op);
  130252. switch( op ){
  130253. case SQLITE_DBCONFIG_MAINDBNAME: {
  130254. db->aDb[0].zDbSName = va_arg(ap,char*);
  130255. rc = SQLITE_OK;
  130256. break;
  130257. }
  130258. case SQLITE_DBCONFIG_LOOKASIDE: {
  130259. void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
  130260. int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
  130261. int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
  130262. rc = setupLookaside(db, pBuf, sz, cnt);
  130263. break;
  130264. }
  130265. default: {
  130266. static const struct {
  130267. int op; /* The opcode */
  130268. u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
  130269. } aFlagOp[] = {
  130270. { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
  130271. { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
  130272. { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
  130273. { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
  130274. };
  130275. unsigned int i;
  130276. rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
  130277. for(i=0; i<ArraySize(aFlagOp); i++){
  130278. if( aFlagOp[i].op==op ){
  130279. int onoff = va_arg(ap, int);
  130280. int *pRes = va_arg(ap, int*);
  130281. int oldFlags = db->flags;
  130282. if( onoff>0 ){
  130283. db->flags |= aFlagOp[i].mask;
  130284. }else if( onoff==0 ){
  130285. db->flags &= ~aFlagOp[i].mask;
  130286. }
  130287. if( oldFlags!=db->flags ){
  130288. sqlite3ExpirePreparedStatements(db);
  130289. }
  130290. if( pRes ){
  130291. *pRes = (db->flags & aFlagOp[i].mask)!=0;
  130292. }
  130293. rc = SQLITE_OK;
  130294. break;
  130295. }
  130296. }
  130297. break;
  130298. }
  130299. }
  130300. va_end(ap);
  130301. return rc;
  130302. }
  130303. /*
  130304. ** Return true if the buffer z[0..n-1] contains all spaces.
  130305. */
  130306. static int allSpaces(const char *z, int n){
  130307. while( n>0 && z[n-1]==' ' ){ n--; }
  130308. return n==0;
  130309. }
  130310. /*
  130311. ** This is the default collating function named "BINARY" which is always
  130312. ** available.
  130313. **
  130314. ** If the padFlag argument is not NULL then space padding at the end
  130315. ** of strings is ignored. This implements the RTRIM collation.
  130316. */
  130317. static int binCollFunc(
  130318. void *padFlag,
  130319. int nKey1, const void *pKey1,
  130320. int nKey2, const void *pKey2
  130321. ){
  130322. int rc, n;
  130323. n = nKey1<nKey2 ? nKey1 : nKey2;
  130324. /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
  130325. ** strings byte by byte using the memcmp() function from the standard C
  130326. ** library. */
  130327. rc = memcmp(pKey1, pKey2, n);
  130328. if( rc==0 ){
  130329. if( padFlag
  130330. && allSpaces(((char*)pKey1)+n, nKey1-n)
  130331. && allSpaces(((char*)pKey2)+n, nKey2-n)
  130332. ){
  130333. /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
  130334. ** spaces at the end of either string do not change the result. In other
  130335. ** words, strings will compare equal to one another as long as they
  130336. ** differ only in the number of spaces at the end.
  130337. */
  130338. }else{
  130339. rc = nKey1 - nKey2;
  130340. }
  130341. }
  130342. return rc;
  130343. }
  130344. /*
  130345. ** Another built-in collating sequence: NOCASE.
  130346. **
  130347. ** This collating sequence is intended to be used for "case independent
  130348. ** comparison". SQLite's knowledge of upper and lower case equivalents
  130349. ** extends only to the 26 characters used in the English language.
  130350. **
  130351. ** At the moment there is only a UTF-8 implementation.
  130352. */
  130353. static int nocaseCollatingFunc(
  130354. void *NotUsed,
  130355. int nKey1, const void *pKey1,
  130356. int nKey2, const void *pKey2
  130357. ){
  130358. int r = sqlite3StrNICmp(
  130359. (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
  130360. UNUSED_PARAMETER(NotUsed);
  130361. if( 0==r ){
  130362. r = nKey1-nKey2;
  130363. }
  130364. return r;
  130365. }
  130366. /*
  130367. ** Return the ROWID of the most recent insert
  130368. */
  130369. SQLITE_API sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
  130370. #ifdef SQLITE_ENABLE_API_ARMOR
  130371. if( !sqlite3SafetyCheckOk(db) ){
  130372. (void)SQLITE_MISUSE_BKPT;
  130373. return 0;
  130374. }
  130375. #endif
  130376. return db->lastRowid;
  130377. }
  130378. /*
  130379. ** Return the number of changes in the most recent call to sqlite3_exec().
  130380. */
  130381. SQLITE_API int sqlite3_changes(sqlite3 *db){
  130382. #ifdef SQLITE_ENABLE_API_ARMOR
  130383. if( !sqlite3SafetyCheckOk(db) ){
  130384. (void)SQLITE_MISUSE_BKPT;
  130385. return 0;
  130386. }
  130387. #endif
  130388. return db->nChange;
  130389. }
  130390. /*
  130391. ** Return the number of changes since the database handle was opened.
  130392. */
  130393. SQLITE_API int sqlite3_total_changes(sqlite3 *db){
  130394. #ifdef SQLITE_ENABLE_API_ARMOR
  130395. if( !sqlite3SafetyCheckOk(db) ){
  130396. (void)SQLITE_MISUSE_BKPT;
  130397. return 0;
  130398. }
  130399. #endif
  130400. return db->nTotalChange;
  130401. }
  130402. /*
  130403. ** Close all open savepoints. This function only manipulates fields of the
  130404. ** database handle object, it does not close any savepoints that may be open
  130405. ** at the b-tree/pager level.
  130406. */
  130407. SQLITE_PRIVATE void sqlite3CloseSavepoints(sqlite3 *db){
  130408. while( db->pSavepoint ){
  130409. Savepoint *pTmp = db->pSavepoint;
  130410. db->pSavepoint = pTmp->pNext;
  130411. sqlite3DbFree(db, pTmp);
  130412. }
  130413. db->nSavepoint = 0;
  130414. db->nStatement = 0;
  130415. db->isTransactionSavepoint = 0;
  130416. }
  130417. /*
  130418. ** Invoke the destructor function associated with FuncDef p, if any. Except,
  130419. ** if this is not the last copy of the function, do not invoke it. Multiple
  130420. ** copies of a single function are created when create_function() is called
  130421. ** with SQLITE_ANY as the encoding.
  130422. */
  130423. static void functionDestroy(sqlite3 *db, FuncDef *p){
  130424. FuncDestructor *pDestructor = p->u.pDestructor;
  130425. if( pDestructor ){
  130426. pDestructor->nRef--;
  130427. if( pDestructor->nRef==0 ){
  130428. pDestructor->xDestroy(pDestructor->pUserData);
  130429. sqlite3DbFree(db, pDestructor);
  130430. }
  130431. }
  130432. }
  130433. /*
  130434. ** Disconnect all sqlite3_vtab objects that belong to database connection
  130435. ** db. This is called when db is being closed.
  130436. */
  130437. static void disconnectAllVtab(sqlite3 *db){
  130438. #ifndef SQLITE_OMIT_VIRTUALTABLE
  130439. int i;
  130440. HashElem *p;
  130441. sqlite3BtreeEnterAll(db);
  130442. for(i=0; i<db->nDb; i++){
  130443. Schema *pSchema = db->aDb[i].pSchema;
  130444. if( db->aDb[i].pSchema ){
  130445. for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
  130446. Table *pTab = (Table *)sqliteHashData(p);
  130447. if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
  130448. }
  130449. }
  130450. }
  130451. for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
  130452. Module *pMod = (Module *)sqliteHashData(p);
  130453. if( pMod->pEpoTab ){
  130454. sqlite3VtabDisconnect(db, pMod->pEpoTab);
  130455. }
  130456. }
  130457. sqlite3VtabUnlockList(db);
  130458. sqlite3BtreeLeaveAll(db);
  130459. #else
  130460. UNUSED_PARAMETER(db);
  130461. #endif
  130462. }
  130463. /*
  130464. ** Return TRUE if database connection db has unfinalized prepared
  130465. ** statements or unfinished sqlite3_backup objects.
  130466. */
  130467. static int connectionIsBusy(sqlite3 *db){
  130468. int j;
  130469. assert( sqlite3_mutex_held(db->mutex) );
  130470. if( db->pVdbe ) return 1;
  130471. for(j=0; j<db->nDb; j++){
  130472. Btree *pBt = db->aDb[j].pBt;
  130473. if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
  130474. }
  130475. return 0;
  130476. }
  130477. /*
  130478. ** Close an existing SQLite database
  130479. */
  130480. static int sqlite3Close(sqlite3 *db, int forceZombie){
  130481. if( !db ){
  130482. /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
  130483. ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
  130484. return SQLITE_OK;
  130485. }
  130486. if( !sqlite3SafetyCheckSickOrOk(db) ){
  130487. return SQLITE_MISUSE_BKPT;
  130488. }
  130489. sqlite3_mutex_enter(db->mutex);
  130490. if( db->mTrace & SQLITE_TRACE_CLOSE ){
  130491. db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
  130492. }
  130493. /* Force xDisconnect calls on all virtual tables */
  130494. disconnectAllVtab(db);
  130495. /* If a transaction is open, the disconnectAllVtab() call above
  130496. ** will not have called the xDisconnect() method on any virtual
  130497. ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
  130498. ** call will do so. We need to do this before the check for active
  130499. ** SQL statements below, as the v-table implementation may be storing
  130500. ** some prepared statements internally.
  130501. */
  130502. sqlite3VtabRollback(db);
  130503. /* Legacy behavior (sqlite3_close() behavior) is to return
  130504. ** SQLITE_BUSY if the connection can not be closed immediately.
  130505. */
  130506. if( !forceZombie && connectionIsBusy(db) ){
  130507. sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
  130508. "statements or unfinished backups");
  130509. sqlite3_mutex_leave(db->mutex);
  130510. return SQLITE_BUSY;
  130511. }
  130512. #ifdef SQLITE_ENABLE_SQLLOG
  130513. if( sqlite3GlobalConfig.xSqllog ){
  130514. /* Closing the handle. Fourth parameter is passed the value 2. */
  130515. sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
  130516. }
  130517. #endif
  130518. /* Convert the connection into a zombie and then close it.
  130519. */
  130520. db->magic = SQLITE_MAGIC_ZOMBIE;
  130521. sqlite3LeaveMutexAndCloseZombie(db);
  130522. return SQLITE_OK;
  130523. }
  130524. /*
  130525. ** Two variations on the public interface for closing a database
  130526. ** connection. The sqlite3_close() version returns SQLITE_BUSY and
  130527. ** leaves the connection option if there are unfinalized prepared
  130528. ** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
  130529. ** version forces the connection to become a zombie if there are
  130530. ** unclosed resources, and arranges for deallocation when the last
  130531. ** prepare statement or sqlite3_backup closes.
  130532. */
  130533. SQLITE_API int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
  130534. SQLITE_API int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
  130535. /*
  130536. ** Close the mutex on database connection db.
  130537. **
  130538. ** Furthermore, if database connection db is a zombie (meaning that there
  130539. ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
  130540. ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
  130541. ** finished, then free all resources.
  130542. */
  130543. SQLITE_PRIVATE void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
  130544. HashElem *i; /* Hash table iterator */
  130545. int j;
  130546. /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
  130547. ** or if the connection has not yet been closed by sqlite3_close_v2(),
  130548. ** then just leave the mutex and return.
  130549. */
  130550. if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
  130551. sqlite3_mutex_leave(db->mutex);
  130552. return;
  130553. }
  130554. /* If we reach this point, it means that the database connection has
  130555. ** closed all sqlite3_stmt and sqlite3_backup objects and has been
  130556. ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
  130557. ** go ahead and free all resources.
  130558. */
  130559. /* If a transaction is open, roll it back. This also ensures that if
  130560. ** any database schemas have been modified by an uncommitted transaction
  130561. ** they are reset. And that the required b-tree mutex is held to make
  130562. ** the pager rollback and schema reset an atomic operation. */
  130563. sqlite3RollbackAll(db, SQLITE_OK);
  130564. /* Free any outstanding Savepoint structures. */
  130565. sqlite3CloseSavepoints(db);
  130566. /* Close all database connections */
  130567. for(j=0; j<db->nDb; j++){
  130568. struct Db *pDb = &db->aDb[j];
  130569. if( pDb->pBt ){
  130570. sqlite3BtreeClose(pDb->pBt);
  130571. pDb->pBt = 0;
  130572. if( j!=1 ){
  130573. pDb->pSchema = 0;
  130574. }
  130575. }
  130576. }
  130577. /* Clear the TEMP schema separately and last */
  130578. if( db->aDb[1].pSchema ){
  130579. sqlite3SchemaClear(db->aDb[1].pSchema);
  130580. }
  130581. sqlite3VtabUnlockList(db);
  130582. /* Free up the array of auxiliary databases */
  130583. sqlite3CollapseDatabaseArray(db);
  130584. assert( db->nDb<=2 );
  130585. assert( db->aDb==db->aDbStatic );
  130586. /* Tell the code in notify.c that the connection no longer holds any
  130587. ** locks and does not require any further unlock-notify callbacks.
  130588. */
  130589. sqlite3ConnectionClosed(db);
  130590. for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
  130591. FuncDef *pNext, *p;
  130592. p = sqliteHashData(i);
  130593. do{
  130594. functionDestroy(db, p);
  130595. pNext = p->pNext;
  130596. sqlite3DbFree(db, p);
  130597. p = pNext;
  130598. }while( p );
  130599. }
  130600. sqlite3HashClear(&db->aFunc);
  130601. for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
  130602. CollSeq *pColl = (CollSeq *)sqliteHashData(i);
  130603. /* Invoke any destructors registered for collation sequence user data. */
  130604. for(j=0; j<3; j++){
  130605. if( pColl[j].xDel ){
  130606. pColl[j].xDel(pColl[j].pUser);
  130607. }
  130608. }
  130609. sqlite3DbFree(db, pColl);
  130610. }
  130611. sqlite3HashClear(&db->aCollSeq);
  130612. #ifndef SQLITE_OMIT_VIRTUALTABLE
  130613. for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
  130614. Module *pMod = (Module *)sqliteHashData(i);
  130615. if( pMod->xDestroy ){
  130616. pMod->xDestroy(pMod->pAux);
  130617. }
  130618. sqlite3VtabEponymousTableClear(db, pMod);
  130619. sqlite3DbFree(db, pMod);
  130620. }
  130621. sqlite3HashClear(&db->aModule);
  130622. #endif
  130623. sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
  130624. sqlite3ValueFree(db->pErr);
  130625. sqlite3CloseExtensions(db);
  130626. #if SQLITE_USER_AUTHENTICATION
  130627. sqlite3_free(db->auth.zAuthUser);
  130628. sqlite3_free(db->auth.zAuthPW);
  130629. #endif
  130630. db->magic = SQLITE_MAGIC_ERROR;
  130631. /* The temp-database schema is allocated differently from the other schema
  130632. ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
  130633. ** So it needs to be freed here. Todo: Why not roll the temp schema into
  130634. ** the same sqliteMalloc() as the one that allocates the database
  130635. ** structure?
  130636. */
  130637. sqlite3DbFree(db, db->aDb[1].pSchema);
  130638. sqlite3_mutex_leave(db->mutex);
  130639. db->magic = SQLITE_MAGIC_CLOSED;
  130640. sqlite3_mutex_free(db->mutex);
  130641. assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
  130642. if( db->lookaside.bMalloced ){
  130643. sqlite3_free(db->lookaside.pStart);
  130644. }
  130645. sqlite3_free(db);
  130646. }
  130647. /*
  130648. ** Rollback all database files. If tripCode is not SQLITE_OK, then
  130649. ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
  130650. ** breaker") and made to return tripCode if there are any further
  130651. ** attempts to use that cursor. Read cursors remain open and valid
  130652. ** but are "saved" in case the table pages are moved around.
  130653. */
  130654. SQLITE_PRIVATE void sqlite3RollbackAll(sqlite3 *db, int tripCode){
  130655. int i;
  130656. int inTrans = 0;
  130657. int schemaChange;
  130658. assert( sqlite3_mutex_held(db->mutex) );
  130659. sqlite3BeginBenignMalloc();
  130660. /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
  130661. ** This is important in case the transaction being rolled back has
  130662. ** modified the database schema. If the b-tree mutexes are not taken
  130663. ** here, then another shared-cache connection might sneak in between
  130664. ** the database rollback and schema reset, which can cause false
  130665. ** corruption reports in some cases. */
  130666. sqlite3BtreeEnterAll(db);
  130667. schemaChange = (db->flags & SQLITE_InternChanges)!=0 && db->init.busy==0;
  130668. for(i=0; i<db->nDb; i++){
  130669. Btree *p = db->aDb[i].pBt;
  130670. if( p ){
  130671. if( sqlite3BtreeIsInTrans(p) ){
  130672. inTrans = 1;
  130673. }
  130674. sqlite3BtreeRollback(p, tripCode, !schemaChange);
  130675. }
  130676. }
  130677. sqlite3VtabRollback(db);
  130678. sqlite3EndBenignMalloc();
  130679. if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
  130680. sqlite3ExpirePreparedStatements(db);
  130681. sqlite3ResetAllSchemasOfConnection(db);
  130682. }
  130683. sqlite3BtreeLeaveAll(db);
  130684. /* Any deferred constraint violations have now been resolved. */
  130685. db->nDeferredCons = 0;
  130686. db->nDeferredImmCons = 0;
  130687. db->flags &= ~SQLITE_DeferFKs;
  130688. /* If one has been configured, invoke the rollback-hook callback */
  130689. if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
  130690. db->xRollbackCallback(db->pRollbackArg);
  130691. }
  130692. }
  130693. /*
  130694. ** Return a static string containing the name corresponding to the error code
  130695. ** specified in the argument.
  130696. */
  130697. #if defined(SQLITE_NEED_ERR_NAME)
  130698. SQLITE_PRIVATE const char *sqlite3ErrName(int rc){
  130699. const char *zName = 0;
  130700. int i, origRc = rc;
  130701. for(i=0; i<2 && zName==0; i++, rc &= 0xff){
  130702. switch( rc ){
  130703. case SQLITE_OK: zName = "SQLITE_OK"; break;
  130704. case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
  130705. case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
  130706. case SQLITE_PERM: zName = "SQLITE_PERM"; break;
  130707. case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
  130708. case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
  130709. case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
  130710. case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
  130711. case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
  130712. case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
  130713. case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
  130714. case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
  130715. case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
  130716. case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
  130717. case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
  130718. case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
  130719. case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
  130720. case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
  130721. case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
  130722. case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
  130723. case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
  130724. case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
  130725. case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
  130726. case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
  130727. case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
  130728. case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
  130729. case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
  130730. case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
  130731. case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
  130732. case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
  130733. case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
  130734. case SQLITE_IOERR_CHECKRESERVEDLOCK:
  130735. zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
  130736. case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
  130737. case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
  130738. case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
  130739. case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
  130740. case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
  130741. case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
  130742. case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
  130743. case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
  130744. case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
  130745. case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
  130746. case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
  130747. case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
  130748. case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
  130749. case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
  130750. case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
  130751. case SQLITE_FULL: zName = "SQLITE_FULL"; break;
  130752. case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
  130753. case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
  130754. case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
  130755. case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
  130756. case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
  130757. case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
  130758. case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
  130759. case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
  130760. case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
  130761. case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
  130762. case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
  130763. case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
  130764. case SQLITE_CONSTRAINT_FOREIGNKEY:
  130765. zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
  130766. case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
  130767. case SQLITE_CONSTRAINT_PRIMARYKEY:
  130768. zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
  130769. case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
  130770. case SQLITE_CONSTRAINT_COMMITHOOK:
  130771. zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
  130772. case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
  130773. case SQLITE_CONSTRAINT_FUNCTION:
  130774. zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
  130775. case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
  130776. case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
  130777. case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
  130778. case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
  130779. case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
  130780. case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
  130781. case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
  130782. case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
  130783. case SQLITE_ROW: zName = "SQLITE_ROW"; break;
  130784. case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
  130785. case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
  130786. case SQLITE_NOTICE_RECOVER_ROLLBACK:
  130787. zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
  130788. case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
  130789. case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
  130790. case SQLITE_DONE: zName = "SQLITE_DONE"; break;
  130791. }
  130792. }
  130793. if( zName==0 ){
  130794. static char zBuf[50];
  130795. sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
  130796. zName = zBuf;
  130797. }
  130798. return zName;
  130799. }
  130800. #endif
  130801. /*
  130802. ** Return a static string that describes the kind of error specified in the
  130803. ** argument.
  130804. */
  130805. SQLITE_PRIVATE const char *sqlite3ErrStr(int rc){
  130806. static const char* const aMsg[] = {
  130807. /* SQLITE_OK */ "not an error",
  130808. /* SQLITE_ERROR */ "SQL logic error or missing database",
  130809. /* SQLITE_INTERNAL */ 0,
  130810. /* SQLITE_PERM */ "access permission denied",
  130811. /* SQLITE_ABORT */ "callback requested query abort",
  130812. /* SQLITE_BUSY */ "database is locked",
  130813. /* SQLITE_LOCKED */ "database table is locked",
  130814. /* SQLITE_NOMEM */ "out of memory",
  130815. /* SQLITE_READONLY */ "attempt to write a readonly database",
  130816. /* SQLITE_INTERRUPT */ "interrupted",
  130817. /* SQLITE_IOERR */ "disk I/O error",
  130818. /* SQLITE_CORRUPT */ "database disk image is malformed",
  130819. /* SQLITE_NOTFOUND */ "unknown operation",
  130820. /* SQLITE_FULL */ "database or disk is full",
  130821. /* SQLITE_CANTOPEN */ "unable to open database file",
  130822. /* SQLITE_PROTOCOL */ "locking protocol",
  130823. /* SQLITE_EMPTY */ "table contains no data",
  130824. /* SQLITE_SCHEMA */ "database schema has changed",
  130825. /* SQLITE_TOOBIG */ "string or blob too big",
  130826. /* SQLITE_CONSTRAINT */ "constraint failed",
  130827. /* SQLITE_MISMATCH */ "datatype mismatch",
  130828. /* SQLITE_MISUSE */ "library routine called out of sequence",
  130829. /* SQLITE_NOLFS */ "large file support is disabled",
  130830. /* SQLITE_AUTH */ "authorization denied",
  130831. /* SQLITE_FORMAT */ "auxiliary database format error",
  130832. /* SQLITE_RANGE */ "bind or column index out of range",
  130833. /* SQLITE_NOTADB */ "file is encrypted or is not a database",
  130834. };
  130835. const char *zErr = "unknown error";
  130836. switch( rc ){
  130837. case SQLITE_ABORT_ROLLBACK: {
  130838. zErr = "abort due to ROLLBACK";
  130839. break;
  130840. }
  130841. default: {
  130842. rc &= 0xff;
  130843. if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
  130844. zErr = aMsg[rc];
  130845. }
  130846. break;
  130847. }
  130848. }
  130849. return zErr;
  130850. }
  130851. /*
  130852. ** This routine implements a busy callback that sleeps and tries
  130853. ** again until a timeout value is reached. The timeout value is
  130854. ** an integer number of milliseconds passed in as the first
  130855. ** argument.
  130856. */
  130857. static int sqliteDefaultBusyCallback(
  130858. void *ptr, /* Database connection */
  130859. int count /* Number of times table has been busy */
  130860. ){
  130861. #if SQLITE_OS_WIN || HAVE_USLEEP
  130862. static const u8 delays[] =
  130863. { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
  130864. static const u8 totals[] =
  130865. { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
  130866. # define NDELAY ArraySize(delays)
  130867. sqlite3 *db = (sqlite3 *)ptr;
  130868. int timeout = db->busyTimeout;
  130869. int delay, prior;
  130870. assert( count>=0 );
  130871. if( count < NDELAY ){
  130872. delay = delays[count];
  130873. prior = totals[count];
  130874. }else{
  130875. delay = delays[NDELAY-1];
  130876. prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
  130877. }
  130878. if( prior + delay > timeout ){
  130879. delay = timeout - prior;
  130880. if( delay<=0 ) return 0;
  130881. }
  130882. sqlite3OsSleep(db->pVfs, delay*1000);
  130883. return 1;
  130884. #else
  130885. sqlite3 *db = (sqlite3 *)ptr;
  130886. int timeout = ((sqlite3 *)ptr)->busyTimeout;
  130887. if( (count+1)*1000 > timeout ){
  130888. return 0;
  130889. }
  130890. sqlite3OsSleep(db->pVfs, 1000000);
  130891. return 1;
  130892. #endif
  130893. }
  130894. /*
  130895. ** Invoke the given busy handler.
  130896. **
  130897. ** This routine is called when an operation failed with a lock.
  130898. ** If this routine returns non-zero, the lock is retried. If it
  130899. ** returns 0, the operation aborts with an SQLITE_BUSY error.
  130900. */
  130901. SQLITE_PRIVATE int sqlite3InvokeBusyHandler(BusyHandler *p){
  130902. int rc;
  130903. if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
  130904. rc = p->xFunc(p->pArg, p->nBusy);
  130905. if( rc==0 ){
  130906. p->nBusy = -1;
  130907. }else{
  130908. p->nBusy++;
  130909. }
  130910. return rc;
  130911. }
  130912. /*
  130913. ** This routine sets the busy callback for an Sqlite database to the
  130914. ** given callback function with the given argument.
  130915. */
  130916. SQLITE_API int sqlite3_busy_handler(
  130917. sqlite3 *db,
  130918. int (*xBusy)(void*,int),
  130919. void *pArg
  130920. ){
  130921. #ifdef SQLITE_ENABLE_API_ARMOR
  130922. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  130923. #endif
  130924. sqlite3_mutex_enter(db->mutex);
  130925. db->busyHandler.xFunc = xBusy;
  130926. db->busyHandler.pArg = pArg;
  130927. db->busyHandler.nBusy = 0;
  130928. db->busyTimeout = 0;
  130929. sqlite3_mutex_leave(db->mutex);
  130930. return SQLITE_OK;
  130931. }
  130932. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  130933. /*
  130934. ** This routine sets the progress callback for an Sqlite database to the
  130935. ** given callback function with the given argument. The progress callback will
  130936. ** be invoked every nOps opcodes.
  130937. */
  130938. SQLITE_API void sqlite3_progress_handler(
  130939. sqlite3 *db,
  130940. int nOps,
  130941. int (*xProgress)(void*),
  130942. void *pArg
  130943. ){
  130944. #ifdef SQLITE_ENABLE_API_ARMOR
  130945. if( !sqlite3SafetyCheckOk(db) ){
  130946. (void)SQLITE_MISUSE_BKPT;
  130947. return;
  130948. }
  130949. #endif
  130950. sqlite3_mutex_enter(db->mutex);
  130951. if( nOps>0 ){
  130952. db->xProgress = xProgress;
  130953. db->nProgressOps = (unsigned)nOps;
  130954. db->pProgressArg = pArg;
  130955. }else{
  130956. db->xProgress = 0;
  130957. db->nProgressOps = 0;
  130958. db->pProgressArg = 0;
  130959. }
  130960. sqlite3_mutex_leave(db->mutex);
  130961. }
  130962. #endif
  130963. /*
  130964. ** This routine installs a default busy handler that waits for the
  130965. ** specified number of milliseconds before returning 0.
  130966. */
  130967. SQLITE_API int sqlite3_busy_timeout(sqlite3 *db, int ms){
  130968. #ifdef SQLITE_ENABLE_API_ARMOR
  130969. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  130970. #endif
  130971. if( ms>0 ){
  130972. sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
  130973. db->busyTimeout = ms;
  130974. }else{
  130975. sqlite3_busy_handler(db, 0, 0);
  130976. }
  130977. return SQLITE_OK;
  130978. }
  130979. /*
  130980. ** Cause any pending operation to stop at its earliest opportunity.
  130981. */
  130982. SQLITE_API void sqlite3_interrupt(sqlite3 *db){
  130983. #ifdef SQLITE_ENABLE_API_ARMOR
  130984. if( !sqlite3SafetyCheckOk(db) ){
  130985. (void)SQLITE_MISUSE_BKPT;
  130986. return;
  130987. }
  130988. #endif
  130989. db->u1.isInterrupted = 1;
  130990. }
  130991. /*
  130992. ** This function is exactly the same as sqlite3_create_function(), except
  130993. ** that it is designed to be called by internal code. The difference is
  130994. ** that if a malloc() fails in sqlite3_create_function(), an error code
  130995. ** is returned and the mallocFailed flag cleared.
  130996. */
  130997. SQLITE_PRIVATE int sqlite3CreateFunc(
  130998. sqlite3 *db,
  130999. const char *zFunctionName,
  131000. int nArg,
  131001. int enc,
  131002. void *pUserData,
  131003. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  131004. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  131005. void (*xFinal)(sqlite3_context*),
  131006. FuncDestructor *pDestructor
  131007. ){
  131008. FuncDef *p;
  131009. int nName;
  131010. int extraFlags;
  131011. assert( sqlite3_mutex_held(db->mutex) );
  131012. if( zFunctionName==0 ||
  131013. (xSFunc && (xFinal || xStep)) ||
  131014. (!xSFunc && (xFinal && !xStep)) ||
  131015. (!xSFunc && (!xFinal && xStep)) ||
  131016. (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
  131017. (255<(nName = sqlite3Strlen30( zFunctionName))) ){
  131018. return SQLITE_MISUSE_BKPT;
  131019. }
  131020. assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
  131021. extraFlags = enc & SQLITE_DETERMINISTIC;
  131022. enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
  131023. #ifndef SQLITE_OMIT_UTF16
  131024. /* If SQLITE_UTF16 is specified as the encoding type, transform this
  131025. ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
  131026. ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
  131027. **
  131028. ** If SQLITE_ANY is specified, add three versions of the function
  131029. ** to the hash table.
  131030. */
  131031. if( enc==SQLITE_UTF16 ){
  131032. enc = SQLITE_UTF16NATIVE;
  131033. }else if( enc==SQLITE_ANY ){
  131034. int rc;
  131035. rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
  131036. pUserData, xSFunc, xStep, xFinal, pDestructor);
  131037. if( rc==SQLITE_OK ){
  131038. rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
  131039. pUserData, xSFunc, xStep, xFinal, pDestructor);
  131040. }
  131041. if( rc!=SQLITE_OK ){
  131042. return rc;
  131043. }
  131044. enc = SQLITE_UTF16BE;
  131045. }
  131046. #else
  131047. enc = SQLITE_UTF8;
  131048. #endif
  131049. /* Check if an existing function is being overridden or deleted. If so,
  131050. ** and there are active VMs, then return SQLITE_BUSY. If a function
  131051. ** is being overridden/deleted but there are no active VMs, allow the
  131052. ** operation to continue but invalidate all precompiled statements.
  131053. */
  131054. p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
  131055. if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
  131056. if( db->nVdbeActive ){
  131057. sqlite3ErrorWithMsg(db, SQLITE_BUSY,
  131058. "unable to delete/modify user-function due to active statements");
  131059. assert( !db->mallocFailed );
  131060. return SQLITE_BUSY;
  131061. }else{
  131062. sqlite3ExpirePreparedStatements(db);
  131063. }
  131064. }
  131065. p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
  131066. assert(p || db->mallocFailed);
  131067. if( !p ){
  131068. return SQLITE_NOMEM_BKPT;
  131069. }
  131070. /* If an older version of the function with a configured destructor is
  131071. ** being replaced invoke the destructor function here. */
  131072. functionDestroy(db, p);
  131073. if( pDestructor ){
  131074. pDestructor->nRef++;
  131075. }
  131076. p->u.pDestructor = pDestructor;
  131077. p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
  131078. testcase( p->funcFlags & SQLITE_DETERMINISTIC );
  131079. p->xSFunc = xSFunc ? xSFunc : xStep;
  131080. p->xFinalize = xFinal;
  131081. p->pUserData = pUserData;
  131082. p->nArg = (u16)nArg;
  131083. return SQLITE_OK;
  131084. }
  131085. /*
  131086. ** Create new user functions.
  131087. */
  131088. SQLITE_API int sqlite3_create_function(
  131089. sqlite3 *db,
  131090. const char *zFunc,
  131091. int nArg,
  131092. int enc,
  131093. void *p,
  131094. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  131095. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  131096. void (*xFinal)(sqlite3_context*)
  131097. ){
  131098. return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xSFunc, xStep,
  131099. xFinal, 0);
  131100. }
  131101. SQLITE_API int sqlite3_create_function_v2(
  131102. sqlite3 *db,
  131103. const char *zFunc,
  131104. int nArg,
  131105. int enc,
  131106. void *p,
  131107. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  131108. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  131109. void (*xFinal)(sqlite3_context*),
  131110. void (*xDestroy)(void *)
  131111. ){
  131112. int rc = SQLITE_ERROR;
  131113. FuncDestructor *pArg = 0;
  131114. #ifdef SQLITE_ENABLE_API_ARMOR
  131115. if( !sqlite3SafetyCheckOk(db) ){
  131116. return SQLITE_MISUSE_BKPT;
  131117. }
  131118. #endif
  131119. sqlite3_mutex_enter(db->mutex);
  131120. if( xDestroy ){
  131121. pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
  131122. if( !pArg ){
  131123. xDestroy(p);
  131124. goto out;
  131125. }
  131126. pArg->xDestroy = xDestroy;
  131127. pArg->pUserData = p;
  131128. }
  131129. rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xSFunc, xStep, xFinal, pArg);
  131130. if( pArg && pArg->nRef==0 ){
  131131. assert( rc!=SQLITE_OK );
  131132. xDestroy(p);
  131133. sqlite3DbFree(db, pArg);
  131134. }
  131135. out:
  131136. rc = sqlite3ApiExit(db, rc);
  131137. sqlite3_mutex_leave(db->mutex);
  131138. return rc;
  131139. }
  131140. #ifndef SQLITE_OMIT_UTF16
  131141. SQLITE_API int sqlite3_create_function16(
  131142. sqlite3 *db,
  131143. const void *zFunctionName,
  131144. int nArg,
  131145. int eTextRep,
  131146. void *p,
  131147. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
  131148. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  131149. void (*xFinal)(sqlite3_context*)
  131150. ){
  131151. int rc;
  131152. char *zFunc8;
  131153. #ifdef SQLITE_ENABLE_API_ARMOR
  131154. if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
  131155. #endif
  131156. sqlite3_mutex_enter(db->mutex);
  131157. assert( !db->mallocFailed );
  131158. zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
  131159. rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0);
  131160. sqlite3DbFree(db, zFunc8);
  131161. rc = sqlite3ApiExit(db, rc);
  131162. sqlite3_mutex_leave(db->mutex);
  131163. return rc;
  131164. }
  131165. #endif
  131166. /*
  131167. ** Declare that a function has been overloaded by a virtual table.
  131168. **
  131169. ** If the function already exists as a regular global function, then
  131170. ** this routine is a no-op. If the function does not exist, then create
  131171. ** a new one that always throws a run-time error.
  131172. **
  131173. ** When virtual tables intend to provide an overloaded function, they
  131174. ** should call this routine to make sure the global function exists.
  131175. ** A global function must exist in order for name resolution to work
  131176. ** properly.
  131177. */
  131178. SQLITE_API int sqlite3_overload_function(
  131179. sqlite3 *db,
  131180. const char *zName,
  131181. int nArg
  131182. ){
  131183. int rc = SQLITE_OK;
  131184. #ifdef SQLITE_ENABLE_API_ARMOR
  131185. if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
  131186. return SQLITE_MISUSE_BKPT;
  131187. }
  131188. #endif
  131189. sqlite3_mutex_enter(db->mutex);
  131190. if( sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)==0 ){
  131191. rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
  131192. 0, sqlite3InvalidFunction, 0, 0, 0);
  131193. }
  131194. rc = sqlite3ApiExit(db, rc);
  131195. sqlite3_mutex_leave(db->mutex);
  131196. return rc;
  131197. }
  131198. #ifndef SQLITE_OMIT_TRACE
  131199. /*
  131200. ** Register a trace function. The pArg from the previously registered trace
  131201. ** is returned.
  131202. **
  131203. ** A NULL trace function means that no tracing is executes. A non-NULL
  131204. ** trace is a pointer to a function that is invoked at the start of each
  131205. ** SQL statement.
  131206. */
  131207. #ifndef SQLITE_OMIT_DEPRECATED
  131208. SQLITE_API void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
  131209. void *pOld;
  131210. #ifdef SQLITE_ENABLE_API_ARMOR
  131211. if( !sqlite3SafetyCheckOk(db) ){
  131212. (void)SQLITE_MISUSE_BKPT;
  131213. return 0;
  131214. }
  131215. #endif
  131216. sqlite3_mutex_enter(db->mutex);
  131217. pOld = db->pTraceArg;
  131218. db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
  131219. db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
  131220. db->pTraceArg = pArg;
  131221. sqlite3_mutex_leave(db->mutex);
  131222. return pOld;
  131223. }
  131224. #endif /* SQLITE_OMIT_DEPRECATED */
  131225. /* Register a trace callback using the version-2 interface.
  131226. */
  131227. SQLITE_API int sqlite3_trace_v2(
  131228. sqlite3 *db, /* Trace this connection */
  131229. unsigned mTrace, /* Mask of events to be traced */
  131230. int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
  131231. void *pArg /* Context */
  131232. ){
  131233. #ifdef SQLITE_ENABLE_API_ARMOR
  131234. if( !sqlite3SafetyCheckOk(db) ){
  131235. return SQLITE_MISUSE_BKPT;
  131236. }
  131237. #endif
  131238. sqlite3_mutex_enter(db->mutex);
  131239. if( mTrace==0 ) xTrace = 0;
  131240. if( xTrace==0 ) mTrace = 0;
  131241. db->mTrace = mTrace;
  131242. db->xTrace = xTrace;
  131243. db->pTraceArg = pArg;
  131244. sqlite3_mutex_leave(db->mutex);
  131245. return SQLITE_OK;
  131246. }
  131247. #ifndef SQLITE_OMIT_DEPRECATED
  131248. /*
  131249. ** Register a profile function. The pArg from the previously registered
  131250. ** profile function is returned.
  131251. **
  131252. ** A NULL profile function means that no profiling is executes. A non-NULL
  131253. ** profile is a pointer to a function that is invoked at the conclusion of
  131254. ** each SQL statement that is run.
  131255. */
  131256. SQLITE_API void *sqlite3_profile(
  131257. sqlite3 *db,
  131258. void (*xProfile)(void*,const char*,sqlite_uint64),
  131259. void *pArg
  131260. ){
  131261. void *pOld;
  131262. #ifdef SQLITE_ENABLE_API_ARMOR
  131263. if( !sqlite3SafetyCheckOk(db) ){
  131264. (void)SQLITE_MISUSE_BKPT;
  131265. return 0;
  131266. }
  131267. #endif
  131268. sqlite3_mutex_enter(db->mutex);
  131269. pOld = db->pProfileArg;
  131270. db->xProfile = xProfile;
  131271. db->pProfileArg = pArg;
  131272. sqlite3_mutex_leave(db->mutex);
  131273. return pOld;
  131274. }
  131275. #endif /* SQLITE_OMIT_DEPRECATED */
  131276. #endif /* SQLITE_OMIT_TRACE */
  131277. /*
  131278. ** Register a function to be invoked when a transaction commits.
  131279. ** If the invoked function returns non-zero, then the commit becomes a
  131280. ** rollback.
  131281. */
  131282. SQLITE_API void *sqlite3_commit_hook(
  131283. sqlite3 *db, /* Attach the hook to this database */
  131284. int (*xCallback)(void*), /* Function to invoke on each commit */
  131285. void *pArg /* Argument to the function */
  131286. ){
  131287. void *pOld;
  131288. #ifdef SQLITE_ENABLE_API_ARMOR
  131289. if( !sqlite3SafetyCheckOk(db) ){
  131290. (void)SQLITE_MISUSE_BKPT;
  131291. return 0;
  131292. }
  131293. #endif
  131294. sqlite3_mutex_enter(db->mutex);
  131295. pOld = db->pCommitArg;
  131296. db->xCommitCallback = xCallback;
  131297. db->pCommitArg = pArg;
  131298. sqlite3_mutex_leave(db->mutex);
  131299. return pOld;
  131300. }
  131301. /*
  131302. ** Register a callback to be invoked each time a row is updated,
  131303. ** inserted or deleted using this database connection.
  131304. */
  131305. SQLITE_API void *sqlite3_update_hook(
  131306. sqlite3 *db, /* Attach the hook to this database */
  131307. void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
  131308. void *pArg /* Argument to the function */
  131309. ){
  131310. void *pRet;
  131311. #ifdef SQLITE_ENABLE_API_ARMOR
  131312. if( !sqlite3SafetyCheckOk(db) ){
  131313. (void)SQLITE_MISUSE_BKPT;
  131314. return 0;
  131315. }
  131316. #endif
  131317. sqlite3_mutex_enter(db->mutex);
  131318. pRet = db->pUpdateArg;
  131319. db->xUpdateCallback = xCallback;
  131320. db->pUpdateArg = pArg;
  131321. sqlite3_mutex_leave(db->mutex);
  131322. return pRet;
  131323. }
  131324. /*
  131325. ** Register a callback to be invoked each time a transaction is rolled
  131326. ** back by this database connection.
  131327. */
  131328. SQLITE_API void *sqlite3_rollback_hook(
  131329. sqlite3 *db, /* Attach the hook to this database */
  131330. void (*xCallback)(void*), /* Callback function */
  131331. void *pArg /* Argument to the function */
  131332. ){
  131333. void *pRet;
  131334. #ifdef SQLITE_ENABLE_API_ARMOR
  131335. if( !sqlite3SafetyCheckOk(db) ){
  131336. (void)SQLITE_MISUSE_BKPT;
  131337. return 0;
  131338. }
  131339. #endif
  131340. sqlite3_mutex_enter(db->mutex);
  131341. pRet = db->pRollbackArg;
  131342. db->xRollbackCallback = xCallback;
  131343. db->pRollbackArg = pArg;
  131344. sqlite3_mutex_leave(db->mutex);
  131345. return pRet;
  131346. }
  131347. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  131348. /*
  131349. ** Register a callback to be invoked each time a row is updated,
  131350. ** inserted or deleted using this database connection.
  131351. */
  131352. SQLITE_API void *sqlite3_preupdate_hook(
  131353. sqlite3 *db, /* Attach the hook to this database */
  131354. void(*xCallback)( /* Callback function */
  131355. void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
  131356. void *pArg /* First callback argument */
  131357. ){
  131358. void *pRet;
  131359. sqlite3_mutex_enter(db->mutex);
  131360. pRet = db->pPreUpdateArg;
  131361. db->xPreUpdateCallback = xCallback;
  131362. db->pPreUpdateArg = pArg;
  131363. sqlite3_mutex_leave(db->mutex);
  131364. return pRet;
  131365. }
  131366. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  131367. #ifndef SQLITE_OMIT_WAL
  131368. /*
  131369. ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
  131370. ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
  131371. ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
  131372. ** wal_autocheckpoint()).
  131373. */
  131374. SQLITE_PRIVATE int sqlite3WalDefaultHook(
  131375. void *pClientData, /* Argument */
  131376. sqlite3 *db, /* Connection */
  131377. const char *zDb, /* Database */
  131378. int nFrame /* Size of WAL */
  131379. ){
  131380. if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
  131381. sqlite3BeginBenignMalloc();
  131382. sqlite3_wal_checkpoint(db, zDb);
  131383. sqlite3EndBenignMalloc();
  131384. }
  131385. return SQLITE_OK;
  131386. }
  131387. #endif /* SQLITE_OMIT_WAL */
  131388. /*
  131389. ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
  131390. ** a database after committing a transaction if there are nFrame or
  131391. ** more frames in the log file. Passing zero or a negative value as the
  131392. ** nFrame parameter disables automatic checkpoints entirely.
  131393. **
  131394. ** The callback registered by this function replaces any existing callback
  131395. ** registered using sqlite3_wal_hook(). Likewise, registering a callback
  131396. ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
  131397. ** configured by this function.
  131398. */
  131399. SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
  131400. #ifdef SQLITE_OMIT_WAL
  131401. UNUSED_PARAMETER(db);
  131402. UNUSED_PARAMETER(nFrame);
  131403. #else
  131404. #ifdef SQLITE_ENABLE_API_ARMOR
  131405. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  131406. #endif
  131407. if( nFrame>0 ){
  131408. sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
  131409. }else{
  131410. sqlite3_wal_hook(db, 0, 0);
  131411. }
  131412. #endif
  131413. return SQLITE_OK;
  131414. }
  131415. /*
  131416. ** Register a callback to be invoked each time a transaction is written
  131417. ** into the write-ahead-log by this database connection.
  131418. */
  131419. SQLITE_API void *sqlite3_wal_hook(
  131420. sqlite3 *db, /* Attach the hook to this db handle */
  131421. int(*xCallback)(void *, sqlite3*, const char*, int),
  131422. void *pArg /* First argument passed to xCallback() */
  131423. ){
  131424. #ifndef SQLITE_OMIT_WAL
  131425. void *pRet;
  131426. #ifdef SQLITE_ENABLE_API_ARMOR
  131427. if( !sqlite3SafetyCheckOk(db) ){
  131428. (void)SQLITE_MISUSE_BKPT;
  131429. return 0;
  131430. }
  131431. #endif
  131432. sqlite3_mutex_enter(db->mutex);
  131433. pRet = db->pWalArg;
  131434. db->xWalCallback = xCallback;
  131435. db->pWalArg = pArg;
  131436. sqlite3_mutex_leave(db->mutex);
  131437. return pRet;
  131438. #else
  131439. return 0;
  131440. #endif
  131441. }
  131442. /*
  131443. ** Checkpoint database zDb.
  131444. */
  131445. SQLITE_API int sqlite3_wal_checkpoint_v2(
  131446. sqlite3 *db, /* Database handle */
  131447. const char *zDb, /* Name of attached database (or NULL) */
  131448. int eMode, /* SQLITE_CHECKPOINT_* value */
  131449. int *pnLog, /* OUT: Size of WAL log in frames */
  131450. int *pnCkpt /* OUT: Total number of frames checkpointed */
  131451. ){
  131452. #ifdef SQLITE_OMIT_WAL
  131453. return SQLITE_OK;
  131454. #else
  131455. int rc; /* Return code */
  131456. int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
  131457. #ifdef SQLITE_ENABLE_API_ARMOR
  131458. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  131459. #endif
  131460. /* Initialize the output variables to -1 in case an error occurs. */
  131461. if( pnLog ) *pnLog = -1;
  131462. if( pnCkpt ) *pnCkpt = -1;
  131463. assert( SQLITE_CHECKPOINT_PASSIVE==0 );
  131464. assert( SQLITE_CHECKPOINT_FULL==1 );
  131465. assert( SQLITE_CHECKPOINT_RESTART==2 );
  131466. assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
  131467. if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
  131468. /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
  131469. ** mode: */
  131470. return SQLITE_MISUSE;
  131471. }
  131472. sqlite3_mutex_enter(db->mutex);
  131473. if( zDb && zDb[0] ){
  131474. iDb = sqlite3FindDbName(db, zDb);
  131475. }
  131476. if( iDb<0 ){
  131477. rc = SQLITE_ERROR;
  131478. sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
  131479. }else{
  131480. db->busyHandler.nBusy = 0;
  131481. rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
  131482. sqlite3Error(db, rc);
  131483. }
  131484. rc = sqlite3ApiExit(db, rc);
  131485. sqlite3_mutex_leave(db->mutex);
  131486. return rc;
  131487. #endif
  131488. }
  131489. /*
  131490. ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
  131491. ** to contains a zero-length string, all attached databases are
  131492. ** checkpointed.
  131493. */
  131494. SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
  131495. /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
  131496. ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
  131497. return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
  131498. }
  131499. #ifndef SQLITE_OMIT_WAL
  131500. /*
  131501. ** Run a checkpoint on database iDb. This is a no-op if database iDb is
  131502. ** not currently open in WAL mode.
  131503. **
  131504. ** If a transaction is open on the database being checkpointed, this
  131505. ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
  131506. ** an error occurs while running the checkpoint, an SQLite error code is
  131507. ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
  131508. **
  131509. ** The mutex on database handle db should be held by the caller. The mutex
  131510. ** associated with the specific b-tree being checkpointed is taken by
  131511. ** this function while the checkpoint is running.
  131512. **
  131513. ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
  131514. ** checkpointed. If an error is encountered it is returned immediately -
  131515. ** no attempt is made to checkpoint any remaining databases.
  131516. **
  131517. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
  131518. */
  131519. SQLITE_PRIVATE int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
  131520. int rc = SQLITE_OK; /* Return code */
  131521. int i; /* Used to iterate through attached dbs */
  131522. int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
  131523. assert( sqlite3_mutex_held(db->mutex) );
  131524. assert( !pnLog || *pnLog==-1 );
  131525. assert( !pnCkpt || *pnCkpt==-1 );
  131526. for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
  131527. if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
  131528. rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
  131529. pnLog = 0;
  131530. pnCkpt = 0;
  131531. if( rc==SQLITE_BUSY ){
  131532. bBusy = 1;
  131533. rc = SQLITE_OK;
  131534. }
  131535. }
  131536. }
  131537. return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
  131538. }
  131539. #endif /* SQLITE_OMIT_WAL */
  131540. /*
  131541. ** This function returns true if main-memory should be used instead of
  131542. ** a temporary file for transient pager files and statement journals.
  131543. ** The value returned depends on the value of db->temp_store (runtime
  131544. ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
  131545. ** following table describes the relationship between these two values
  131546. ** and this functions return value.
  131547. **
  131548. ** SQLITE_TEMP_STORE db->temp_store Location of temporary database
  131549. ** ----------------- -------------- ------------------------------
  131550. ** 0 any file (return 0)
  131551. ** 1 1 file (return 0)
  131552. ** 1 2 memory (return 1)
  131553. ** 1 0 file (return 0)
  131554. ** 2 1 file (return 0)
  131555. ** 2 2 memory (return 1)
  131556. ** 2 0 memory (return 1)
  131557. ** 3 any memory (return 1)
  131558. */
  131559. SQLITE_PRIVATE int sqlite3TempInMemory(const sqlite3 *db){
  131560. #if SQLITE_TEMP_STORE==1
  131561. return ( db->temp_store==2 );
  131562. #endif
  131563. #if SQLITE_TEMP_STORE==2
  131564. return ( db->temp_store!=1 );
  131565. #endif
  131566. #if SQLITE_TEMP_STORE==3
  131567. UNUSED_PARAMETER(db);
  131568. return 1;
  131569. #endif
  131570. #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
  131571. UNUSED_PARAMETER(db);
  131572. return 0;
  131573. #endif
  131574. }
  131575. /*
  131576. ** Return UTF-8 encoded English language explanation of the most recent
  131577. ** error.
  131578. */
  131579. SQLITE_API const char *sqlite3_errmsg(sqlite3 *db){
  131580. const char *z;
  131581. if( !db ){
  131582. return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
  131583. }
  131584. if( !sqlite3SafetyCheckSickOrOk(db) ){
  131585. return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
  131586. }
  131587. sqlite3_mutex_enter(db->mutex);
  131588. if( db->mallocFailed ){
  131589. z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
  131590. }else{
  131591. testcase( db->pErr==0 );
  131592. z = (char*)sqlite3_value_text(db->pErr);
  131593. assert( !db->mallocFailed );
  131594. if( z==0 ){
  131595. z = sqlite3ErrStr(db->errCode);
  131596. }
  131597. }
  131598. sqlite3_mutex_leave(db->mutex);
  131599. return z;
  131600. }
  131601. #ifndef SQLITE_OMIT_UTF16
  131602. /*
  131603. ** Return UTF-16 encoded English language explanation of the most recent
  131604. ** error.
  131605. */
  131606. SQLITE_API const void *sqlite3_errmsg16(sqlite3 *db){
  131607. static const u16 outOfMem[] = {
  131608. 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
  131609. };
  131610. static const u16 misuse[] = {
  131611. 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
  131612. 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
  131613. 'c', 'a', 'l', 'l', 'e', 'd', ' ',
  131614. 'o', 'u', 't', ' ',
  131615. 'o', 'f', ' ',
  131616. 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
  131617. };
  131618. const void *z;
  131619. if( !db ){
  131620. return (void *)outOfMem;
  131621. }
  131622. if( !sqlite3SafetyCheckSickOrOk(db) ){
  131623. return (void *)misuse;
  131624. }
  131625. sqlite3_mutex_enter(db->mutex);
  131626. if( db->mallocFailed ){
  131627. z = (void *)outOfMem;
  131628. }else{
  131629. z = sqlite3_value_text16(db->pErr);
  131630. if( z==0 ){
  131631. sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
  131632. z = sqlite3_value_text16(db->pErr);
  131633. }
  131634. /* A malloc() may have failed within the call to sqlite3_value_text16()
  131635. ** above. If this is the case, then the db->mallocFailed flag needs to
  131636. ** be cleared before returning. Do this directly, instead of via
  131637. ** sqlite3ApiExit(), to avoid setting the database handle error message.
  131638. */
  131639. sqlite3OomClear(db);
  131640. }
  131641. sqlite3_mutex_leave(db->mutex);
  131642. return z;
  131643. }
  131644. #endif /* SQLITE_OMIT_UTF16 */
  131645. /*
  131646. ** Return the most recent error code generated by an SQLite routine. If NULL is
  131647. ** passed to this function, we assume a malloc() failed during sqlite3_open().
  131648. */
  131649. SQLITE_API int sqlite3_errcode(sqlite3 *db){
  131650. if( db && !sqlite3SafetyCheckSickOrOk(db) ){
  131651. return SQLITE_MISUSE_BKPT;
  131652. }
  131653. if( !db || db->mallocFailed ){
  131654. return SQLITE_NOMEM_BKPT;
  131655. }
  131656. return db->errCode & db->errMask;
  131657. }
  131658. SQLITE_API int sqlite3_extended_errcode(sqlite3 *db){
  131659. if( db && !sqlite3SafetyCheckSickOrOk(db) ){
  131660. return SQLITE_MISUSE_BKPT;
  131661. }
  131662. if( !db || db->mallocFailed ){
  131663. return SQLITE_NOMEM_BKPT;
  131664. }
  131665. return db->errCode;
  131666. }
  131667. SQLITE_API int sqlite3_system_errno(sqlite3 *db){
  131668. return db ? db->iSysErrno : 0;
  131669. }
  131670. /*
  131671. ** Return a string that describes the kind of error specified in the
  131672. ** argument. For now, this simply calls the internal sqlite3ErrStr()
  131673. ** function.
  131674. */
  131675. SQLITE_API const char *sqlite3_errstr(int rc){
  131676. return sqlite3ErrStr(rc);
  131677. }
  131678. /*
  131679. ** Create a new collating function for database "db". The name is zName
  131680. ** and the encoding is enc.
  131681. */
  131682. static int createCollation(
  131683. sqlite3* db,
  131684. const char *zName,
  131685. u8 enc,
  131686. void* pCtx,
  131687. int(*xCompare)(void*,int,const void*,int,const void*),
  131688. void(*xDel)(void*)
  131689. ){
  131690. CollSeq *pColl;
  131691. int enc2;
  131692. assert( sqlite3_mutex_held(db->mutex) );
  131693. /* If SQLITE_UTF16 is specified as the encoding type, transform this
  131694. ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
  131695. ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
  131696. */
  131697. enc2 = enc;
  131698. testcase( enc2==SQLITE_UTF16 );
  131699. testcase( enc2==SQLITE_UTF16_ALIGNED );
  131700. if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
  131701. enc2 = SQLITE_UTF16NATIVE;
  131702. }
  131703. if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
  131704. return SQLITE_MISUSE_BKPT;
  131705. }
  131706. /* Check if this call is removing or replacing an existing collation
  131707. ** sequence. If so, and there are active VMs, return busy. If there
  131708. ** are no active VMs, invalidate any pre-compiled statements.
  131709. */
  131710. pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
  131711. if( pColl && pColl->xCmp ){
  131712. if( db->nVdbeActive ){
  131713. sqlite3ErrorWithMsg(db, SQLITE_BUSY,
  131714. "unable to delete/modify collation sequence due to active statements");
  131715. return SQLITE_BUSY;
  131716. }
  131717. sqlite3ExpirePreparedStatements(db);
  131718. /* If collation sequence pColl was created directly by a call to
  131719. ** sqlite3_create_collation, and not generated by synthCollSeq(),
  131720. ** then any copies made by synthCollSeq() need to be invalidated.
  131721. ** Also, collation destructor - CollSeq.xDel() - function may need
  131722. ** to be called.
  131723. */
  131724. if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
  131725. CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
  131726. int j;
  131727. for(j=0; j<3; j++){
  131728. CollSeq *p = &aColl[j];
  131729. if( p->enc==pColl->enc ){
  131730. if( p->xDel ){
  131731. p->xDel(p->pUser);
  131732. }
  131733. p->xCmp = 0;
  131734. }
  131735. }
  131736. }
  131737. }
  131738. pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
  131739. if( pColl==0 ) return SQLITE_NOMEM_BKPT;
  131740. pColl->xCmp = xCompare;
  131741. pColl->pUser = pCtx;
  131742. pColl->xDel = xDel;
  131743. pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
  131744. sqlite3Error(db, SQLITE_OK);
  131745. return SQLITE_OK;
  131746. }
  131747. /*
  131748. ** This array defines hard upper bounds on limit values. The
  131749. ** initializer must be kept in sync with the SQLITE_LIMIT_*
  131750. ** #defines in sqlite3.h.
  131751. */
  131752. static const int aHardLimit[] = {
  131753. SQLITE_MAX_LENGTH,
  131754. SQLITE_MAX_SQL_LENGTH,
  131755. SQLITE_MAX_COLUMN,
  131756. SQLITE_MAX_EXPR_DEPTH,
  131757. SQLITE_MAX_COMPOUND_SELECT,
  131758. SQLITE_MAX_VDBE_OP,
  131759. SQLITE_MAX_FUNCTION_ARG,
  131760. SQLITE_MAX_ATTACHED,
  131761. SQLITE_MAX_LIKE_PATTERN_LENGTH,
  131762. SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
  131763. SQLITE_MAX_TRIGGER_DEPTH,
  131764. SQLITE_MAX_WORKER_THREADS,
  131765. };
  131766. /*
  131767. ** Make sure the hard limits are set to reasonable values
  131768. */
  131769. #if SQLITE_MAX_LENGTH<100
  131770. # error SQLITE_MAX_LENGTH must be at least 100
  131771. #endif
  131772. #if SQLITE_MAX_SQL_LENGTH<100
  131773. # error SQLITE_MAX_SQL_LENGTH must be at least 100
  131774. #endif
  131775. #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
  131776. # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
  131777. #endif
  131778. #if SQLITE_MAX_COMPOUND_SELECT<2
  131779. # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
  131780. #endif
  131781. #if SQLITE_MAX_VDBE_OP<40
  131782. # error SQLITE_MAX_VDBE_OP must be at least 40
  131783. #endif
  131784. #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
  131785. # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
  131786. #endif
  131787. #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
  131788. # error SQLITE_MAX_ATTACHED must be between 0 and 125
  131789. #endif
  131790. #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
  131791. # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
  131792. #endif
  131793. #if SQLITE_MAX_COLUMN>32767
  131794. # error SQLITE_MAX_COLUMN must not exceed 32767
  131795. #endif
  131796. #if SQLITE_MAX_TRIGGER_DEPTH<1
  131797. # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
  131798. #endif
  131799. #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
  131800. # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
  131801. #endif
  131802. /*
  131803. ** Change the value of a limit. Report the old value.
  131804. ** If an invalid limit index is supplied, report -1.
  131805. ** Make no changes but still report the old value if the
  131806. ** new limit is negative.
  131807. **
  131808. ** A new lower limit does not shrink existing constructs.
  131809. ** It merely prevents new constructs that exceed the limit
  131810. ** from forming.
  131811. */
  131812. SQLITE_API int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
  131813. int oldLimit;
  131814. #ifdef SQLITE_ENABLE_API_ARMOR
  131815. if( !sqlite3SafetyCheckOk(db) ){
  131816. (void)SQLITE_MISUSE_BKPT;
  131817. return -1;
  131818. }
  131819. #endif
  131820. /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
  131821. ** there is a hard upper bound set at compile-time by a C preprocessor
  131822. ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
  131823. ** "_MAX_".)
  131824. */
  131825. assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
  131826. assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
  131827. assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
  131828. assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
  131829. assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
  131830. assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
  131831. assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
  131832. assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
  131833. assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
  131834. SQLITE_MAX_LIKE_PATTERN_LENGTH );
  131835. assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
  131836. assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
  131837. assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
  131838. assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
  131839. if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
  131840. return -1;
  131841. }
  131842. oldLimit = db->aLimit[limitId];
  131843. if( newLimit>=0 ){ /* IMP: R-52476-28732 */
  131844. if( newLimit>aHardLimit[limitId] ){
  131845. newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
  131846. }
  131847. db->aLimit[limitId] = newLimit;
  131848. }
  131849. return oldLimit; /* IMP: R-53341-35419 */
  131850. }
  131851. /*
  131852. ** This function is used to parse both URIs and non-URI filenames passed by the
  131853. ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
  131854. ** URIs specified as part of ATTACH statements.
  131855. **
  131856. ** The first argument to this function is the name of the VFS to use (or
  131857. ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
  131858. ** query parameter. The second argument contains the URI (or non-URI filename)
  131859. ** itself. When this function is called the *pFlags variable should contain
  131860. ** the default flags to open the database handle with. The value stored in
  131861. ** *pFlags may be updated before returning if the URI filename contains
  131862. ** "cache=xxx" or "mode=xxx" query parameters.
  131863. **
  131864. ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
  131865. ** the VFS that should be used to open the database file. *pzFile is set to
  131866. ** point to a buffer containing the name of the file to open. It is the
  131867. ** responsibility of the caller to eventually call sqlite3_free() to release
  131868. ** this buffer.
  131869. **
  131870. ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
  131871. ** may be set to point to a buffer containing an English language error
  131872. ** message. It is the responsibility of the caller to eventually release
  131873. ** this buffer by calling sqlite3_free().
  131874. */
  131875. SQLITE_PRIVATE int sqlite3ParseUri(
  131876. const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
  131877. const char *zUri, /* Nul-terminated URI to parse */
  131878. unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
  131879. sqlite3_vfs **ppVfs, /* OUT: VFS to use */
  131880. char **pzFile, /* OUT: Filename component of URI */
  131881. char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
  131882. ){
  131883. int rc = SQLITE_OK;
  131884. unsigned int flags = *pFlags;
  131885. const char *zVfs = zDefaultVfs;
  131886. char *zFile;
  131887. char c;
  131888. int nUri = sqlite3Strlen30(zUri);
  131889. assert( *pzErrMsg==0 );
  131890. if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
  131891. || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
  131892. && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
  131893. ){
  131894. char *zOpt;
  131895. int eState; /* Parser state when parsing URI */
  131896. int iIn; /* Input character index */
  131897. int iOut = 0; /* Output character index */
  131898. u64 nByte = nUri+2; /* Bytes of space to allocate */
  131899. /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
  131900. ** method that there may be extra parameters following the file-name. */
  131901. flags |= SQLITE_OPEN_URI;
  131902. for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
  131903. zFile = sqlite3_malloc64(nByte);
  131904. if( !zFile ) return SQLITE_NOMEM_BKPT;
  131905. iIn = 5;
  131906. #ifdef SQLITE_ALLOW_URI_AUTHORITY
  131907. if( strncmp(zUri+5, "///", 3)==0 ){
  131908. iIn = 7;
  131909. /* The following condition causes URIs with five leading / characters
  131910. ** like file://///host/path to be converted into UNCs like //host/path.
  131911. ** The correct URI for that UNC has only two or four leading / characters
  131912. ** file://host/path or file:////host/path. But 5 leading slashes is a
  131913. ** common error, we are told, so we handle it as a special case. */
  131914. if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
  131915. }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
  131916. iIn = 16;
  131917. }
  131918. #else
  131919. /* Discard the scheme and authority segments of the URI. */
  131920. if( zUri[5]=='/' && zUri[6]=='/' ){
  131921. iIn = 7;
  131922. while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
  131923. if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
  131924. *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
  131925. iIn-7, &zUri[7]);
  131926. rc = SQLITE_ERROR;
  131927. goto parse_uri_out;
  131928. }
  131929. }
  131930. #endif
  131931. /* Copy the filename and any query parameters into the zFile buffer.
  131932. ** Decode %HH escape codes along the way.
  131933. **
  131934. ** Within this loop, variable eState may be set to 0, 1 or 2, depending
  131935. ** on the parsing context. As follows:
  131936. **
  131937. ** 0: Parsing file-name.
  131938. ** 1: Parsing name section of a name=value query parameter.
  131939. ** 2: Parsing value section of a name=value query parameter.
  131940. */
  131941. eState = 0;
  131942. while( (c = zUri[iIn])!=0 && c!='#' ){
  131943. iIn++;
  131944. if( c=='%'
  131945. && sqlite3Isxdigit(zUri[iIn])
  131946. && sqlite3Isxdigit(zUri[iIn+1])
  131947. ){
  131948. int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
  131949. octet += sqlite3HexToInt(zUri[iIn++]);
  131950. assert( octet>=0 && octet<256 );
  131951. if( octet==0 ){
  131952. /* This branch is taken when "%00" appears within the URI. In this
  131953. ** case we ignore all text in the remainder of the path, name or
  131954. ** value currently being parsed. So ignore the current character
  131955. ** and skip to the next "?", "=" or "&", as appropriate. */
  131956. while( (c = zUri[iIn])!=0 && c!='#'
  131957. && (eState!=0 || c!='?')
  131958. && (eState!=1 || (c!='=' && c!='&'))
  131959. && (eState!=2 || c!='&')
  131960. ){
  131961. iIn++;
  131962. }
  131963. continue;
  131964. }
  131965. c = octet;
  131966. }else if( eState==1 && (c=='&' || c=='=') ){
  131967. if( zFile[iOut-1]==0 ){
  131968. /* An empty option name. Ignore this option altogether. */
  131969. while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
  131970. continue;
  131971. }
  131972. if( c=='&' ){
  131973. zFile[iOut++] = '\0';
  131974. }else{
  131975. eState = 2;
  131976. }
  131977. c = 0;
  131978. }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
  131979. c = 0;
  131980. eState = 1;
  131981. }
  131982. zFile[iOut++] = c;
  131983. }
  131984. if( eState==1 ) zFile[iOut++] = '\0';
  131985. zFile[iOut++] = '\0';
  131986. zFile[iOut++] = '\0';
  131987. /* Check if there were any options specified that should be interpreted
  131988. ** here. Options that are interpreted here include "vfs" and those that
  131989. ** correspond to flags that may be passed to the sqlite3_open_v2()
  131990. ** method. */
  131991. zOpt = &zFile[sqlite3Strlen30(zFile)+1];
  131992. while( zOpt[0] ){
  131993. int nOpt = sqlite3Strlen30(zOpt);
  131994. char *zVal = &zOpt[nOpt+1];
  131995. int nVal = sqlite3Strlen30(zVal);
  131996. if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
  131997. zVfs = zVal;
  131998. }else{
  131999. struct OpenMode {
  132000. const char *z;
  132001. int mode;
  132002. } *aMode = 0;
  132003. char *zModeType = 0;
  132004. int mask = 0;
  132005. int limit = 0;
  132006. if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
  132007. static struct OpenMode aCacheMode[] = {
  132008. { "shared", SQLITE_OPEN_SHAREDCACHE },
  132009. { "private", SQLITE_OPEN_PRIVATECACHE },
  132010. { 0, 0 }
  132011. };
  132012. mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
  132013. aMode = aCacheMode;
  132014. limit = mask;
  132015. zModeType = "cache";
  132016. }
  132017. if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
  132018. static struct OpenMode aOpenMode[] = {
  132019. { "ro", SQLITE_OPEN_READONLY },
  132020. { "rw", SQLITE_OPEN_READWRITE },
  132021. { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
  132022. { "memory", SQLITE_OPEN_MEMORY },
  132023. { 0, 0 }
  132024. };
  132025. mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
  132026. | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
  132027. aMode = aOpenMode;
  132028. limit = mask & flags;
  132029. zModeType = "access";
  132030. }
  132031. if( aMode ){
  132032. int i;
  132033. int mode = 0;
  132034. for(i=0; aMode[i].z; i++){
  132035. const char *z = aMode[i].z;
  132036. if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
  132037. mode = aMode[i].mode;
  132038. break;
  132039. }
  132040. }
  132041. if( mode==0 ){
  132042. *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
  132043. rc = SQLITE_ERROR;
  132044. goto parse_uri_out;
  132045. }
  132046. if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
  132047. *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
  132048. zModeType, zVal);
  132049. rc = SQLITE_PERM;
  132050. goto parse_uri_out;
  132051. }
  132052. flags = (flags & ~mask) | mode;
  132053. }
  132054. }
  132055. zOpt = &zVal[nVal+1];
  132056. }
  132057. }else{
  132058. zFile = sqlite3_malloc64(nUri+2);
  132059. if( !zFile ) return SQLITE_NOMEM_BKPT;
  132060. memcpy(zFile, zUri, nUri);
  132061. zFile[nUri] = '\0';
  132062. zFile[nUri+1] = '\0';
  132063. flags &= ~SQLITE_OPEN_URI;
  132064. }
  132065. *ppVfs = sqlite3_vfs_find(zVfs);
  132066. if( *ppVfs==0 ){
  132067. *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
  132068. rc = SQLITE_ERROR;
  132069. }
  132070. parse_uri_out:
  132071. if( rc!=SQLITE_OK ){
  132072. sqlite3_free(zFile);
  132073. zFile = 0;
  132074. }
  132075. *pFlags = flags;
  132076. *pzFile = zFile;
  132077. return rc;
  132078. }
  132079. /*
  132080. ** This routine does the work of opening a database on behalf of
  132081. ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
  132082. ** is UTF-8 encoded.
  132083. */
  132084. static int openDatabase(
  132085. const char *zFilename, /* Database filename UTF-8 encoded */
  132086. sqlite3 **ppDb, /* OUT: Returned database handle */
  132087. unsigned int flags, /* Operational flags */
  132088. const char *zVfs /* Name of the VFS to use */
  132089. ){
  132090. sqlite3 *db; /* Store allocated handle here */
  132091. int rc; /* Return code */
  132092. int isThreadsafe; /* True for threadsafe connections */
  132093. char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
  132094. char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
  132095. #ifdef SQLITE_ENABLE_API_ARMOR
  132096. if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
  132097. #endif
  132098. *ppDb = 0;
  132099. #ifndef SQLITE_OMIT_AUTOINIT
  132100. rc = sqlite3_initialize();
  132101. if( rc ) return rc;
  132102. #endif
  132103. /* Only allow sensible combinations of bits in the flags argument.
  132104. ** Throw an error if any non-sense combination is used. If we
  132105. ** do not block illegal combinations here, it could trigger
  132106. ** assert() statements in deeper layers. Sensible combinations
  132107. ** are:
  132108. **
  132109. ** 1: SQLITE_OPEN_READONLY
  132110. ** 2: SQLITE_OPEN_READWRITE
  132111. ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
  132112. */
  132113. assert( SQLITE_OPEN_READONLY == 0x01 );
  132114. assert( SQLITE_OPEN_READWRITE == 0x02 );
  132115. assert( SQLITE_OPEN_CREATE == 0x04 );
  132116. testcase( (1<<(flags&7))==0x02 ); /* READONLY */
  132117. testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
  132118. testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
  132119. if( ((1<<(flags&7)) & 0x46)==0 ){
  132120. return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
  132121. }
  132122. if( sqlite3GlobalConfig.bCoreMutex==0 ){
  132123. isThreadsafe = 0;
  132124. }else if( flags & SQLITE_OPEN_NOMUTEX ){
  132125. isThreadsafe = 0;
  132126. }else if( flags & SQLITE_OPEN_FULLMUTEX ){
  132127. isThreadsafe = 1;
  132128. }else{
  132129. isThreadsafe = sqlite3GlobalConfig.bFullMutex;
  132130. }
  132131. if( flags & SQLITE_OPEN_PRIVATECACHE ){
  132132. flags &= ~SQLITE_OPEN_SHAREDCACHE;
  132133. }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
  132134. flags |= SQLITE_OPEN_SHAREDCACHE;
  132135. }
  132136. /* Remove harmful bits from the flags parameter
  132137. **
  132138. ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
  132139. ** dealt with in the previous code block. Besides these, the only
  132140. ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
  132141. ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
  132142. ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
  132143. ** off all other flags.
  132144. */
  132145. flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
  132146. SQLITE_OPEN_EXCLUSIVE |
  132147. SQLITE_OPEN_MAIN_DB |
  132148. SQLITE_OPEN_TEMP_DB |
  132149. SQLITE_OPEN_TRANSIENT_DB |
  132150. SQLITE_OPEN_MAIN_JOURNAL |
  132151. SQLITE_OPEN_TEMP_JOURNAL |
  132152. SQLITE_OPEN_SUBJOURNAL |
  132153. SQLITE_OPEN_MASTER_JOURNAL |
  132154. SQLITE_OPEN_NOMUTEX |
  132155. SQLITE_OPEN_FULLMUTEX |
  132156. SQLITE_OPEN_WAL
  132157. );
  132158. /* Allocate the sqlite data structure */
  132159. db = sqlite3MallocZero( sizeof(sqlite3) );
  132160. if( db==0 ) goto opendb_out;
  132161. if( isThreadsafe ){
  132162. db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
  132163. if( db->mutex==0 ){
  132164. sqlite3_free(db);
  132165. db = 0;
  132166. goto opendb_out;
  132167. }
  132168. }
  132169. sqlite3_mutex_enter(db->mutex);
  132170. db->errMask = 0xff;
  132171. db->nDb = 2;
  132172. db->magic = SQLITE_MAGIC_BUSY;
  132173. db->aDb = db->aDbStatic;
  132174. assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
  132175. memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
  132176. db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
  132177. db->autoCommit = 1;
  132178. db->nextAutovac = -1;
  132179. db->szMmap = sqlite3GlobalConfig.szMmap;
  132180. db->nextPagesize = 0;
  132181. db->nMaxSorterMmap = 0x7FFFFFFF;
  132182. db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
  132183. #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
  132184. | SQLITE_AutoIndex
  132185. #endif
  132186. #if SQLITE_DEFAULT_CKPTFULLFSYNC
  132187. | SQLITE_CkptFullFSync
  132188. #endif
  132189. #if SQLITE_DEFAULT_FILE_FORMAT<4
  132190. | SQLITE_LegacyFileFmt
  132191. #endif
  132192. #ifdef SQLITE_ENABLE_LOAD_EXTENSION
  132193. | SQLITE_LoadExtension
  132194. #endif
  132195. #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
  132196. | SQLITE_RecTriggers
  132197. #endif
  132198. #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
  132199. | SQLITE_ForeignKeys
  132200. #endif
  132201. #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
  132202. | SQLITE_ReverseOrder
  132203. #endif
  132204. #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
  132205. | SQLITE_CellSizeCk
  132206. #endif
  132207. #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
  132208. | SQLITE_Fts3Tokenizer
  132209. #endif
  132210. ;
  132211. sqlite3HashInit(&db->aCollSeq);
  132212. #ifndef SQLITE_OMIT_VIRTUALTABLE
  132213. sqlite3HashInit(&db->aModule);
  132214. #endif
  132215. /* Add the default collation sequence BINARY. BINARY works for both UTF-8
  132216. ** and UTF-16, so add a version for each to avoid any unnecessary
  132217. ** conversions. The only error that can occur here is a malloc() failure.
  132218. **
  132219. ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
  132220. ** functions:
  132221. */
  132222. createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
  132223. createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
  132224. createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
  132225. createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
  132226. createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
  132227. if( db->mallocFailed ){
  132228. goto opendb_out;
  132229. }
  132230. /* EVIDENCE-OF: R-08308-17224 The default collating function for all
  132231. ** strings is BINARY.
  132232. */
  132233. db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
  132234. assert( db->pDfltColl!=0 );
  132235. /* Parse the filename/URI argument. */
  132236. db->openFlags = flags;
  132237. rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
  132238. if( rc!=SQLITE_OK ){
  132239. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  132240. sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
  132241. sqlite3_free(zErrMsg);
  132242. goto opendb_out;
  132243. }
  132244. /* Open the backend database driver */
  132245. rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
  132246. flags | SQLITE_OPEN_MAIN_DB);
  132247. if( rc!=SQLITE_OK ){
  132248. if( rc==SQLITE_IOERR_NOMEM ){
  132249. rc = SQLITE_NOMEM_BKPT;
  132250. }
  132251. sqlite3Error(db, rc);
  132252. goto opendb_out;
  132253. }
  132254. sqlite3BtreeEnter(db->aDb[0].pBt);
  132255. db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
  132256. if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
  132257. sqlite3BtreeLeave(db->aDb[0].pBt);
  132258. db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
  132259. /* The default safety_level for the main database is FULL; for the temp
  132260. ** database it is OFF. This matches the pager layer defaults.
  132261. */
  132262. db->aDb[0].zDbSName = "main";
  132263. db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
  132264. db->aDb[1].zDbSName = "temp";
  132265. db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
  132266. db->magic = SQLITE_MAGIC_OPEN;
  132267. if( db->mallocFailed ){
  132268. goto opendb_out;
  132269. }
  132270. /* Register all built-in functions, but do not attempt to read the
  132271. ** database schema yet. This is delayed until the first time the database
  132272. ** is accessed.
  132273. */
  132274. sqlite3Error(db, SQLITE_OK);
  132275. sqlite3RegisterPerConnectionBuiltinFunctions(db);
  132276. rc = sqlite3_errcode(db);
  132277. #ifdef SQLITE_ENABLE_FTS5
  132278. /* Register any built-in FTS5 module before loading the automatic
  132279. ** extensions. This allows automatic extensions to register FTS5
  132280. ** tokenizers and auxiliary functions. */
  132281. if( !db->mallocFailed && rc==SQLITE_OK ){
  132282. rc = sqlite3Fts5Init(db);
  132283. }
  132284. #endif
  132285. /* Load automatic extensions - extensions that have been registered
  132286. ** using the sqlite3_automatic_extension() API.
  132287. */
  132288. if( rc==SQLITE_OK ){
  132289. sqlite3AutoLoadExtensions(db);
  132290. rc = sqlite3_errcode(db);
  132291. if( rc!=SQLITE_OK ){
  132292. goto opendb_out;
  132293. }
  132294. }
  132295. #ifdef SQLITE_ENABLE_FTS1
  132296. if( !db->mallocFailed ){
  132297. extern int sqlite3Fts1Init(sqlite3*);
  132298. rc = sqlite3Fts1Init(db);
  132299. }
  132300. #endif
  132301. #ifdef SQLITE_ENABLE_FTS2
  132302. if( !db->mallocFailed && rc==SQLITE_OK ){
  132303. extern int sqlite3Fts2Init(sqlite3*);
  132304. rc = sqlite3Fts2Init(db);
  132305. }
  132306. #endif
  132307. #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
  132308. if( !db->mallocFailed && rc==SQLITE_OK ){
  132309. rc = sqlite3Fts3Init(db);
  132310. }
  132311. #endif
  132312. #ifdef SQLITE_ENABLE_ICU
  132313. if( !db->mallocFailed && rc==SQLITE_OK ){
  132314. rc = sqlite3IcuInit(db);
  132315. }
  132316. #endif
  132317. #ifdef SQLITE_ENABLE_RTREE
  132318. if( !db->mallocFailed && rc==SQLITE_OK){
  132319. rc = sqlite3RtreeInit(db);
  132320. }
  132321. #endif
  132322. #ifdef SQLITE_ENABLE_DBSTAT_VTAB
  132323. if( !db->mallocFailed && rc==SQLITE_OK){
  132324. rc = sqlite3DbstatRegister(db);
  132325. }
  132326. #endif
  132327. #ifdef SQLITE_ENABLE_JSON1
  132328. if( !db->mallocFailed && rc==SQLITE_OK){
  132329. rc = sqlite3Json1Init(db);
  132330. }
  132331. #endif
  132332. /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
  132333. ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
  132334. ** mode. Doing nothing at all also makes NORMAL the default.
  132335. */
  132336. #ifdef SQLITE_DEFAULT_LOCKING_MODE
  132337. db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
  132338. sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
  132339. SQLITE_DEFAULT_LOCKING_MODE);
  132340. #endif
  132341. if( rc ) sqlite3Error(db, rc);
  132342. /* Enable the lookaside-malloc subsystem */
  132343. setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
  132344. sqlite3GlobalConfig.nLookaside);
  132345. sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
  132346. opendb_out:
  132347. if( db ){
  132348. assert( db->mutex!=0 || isThreadsafe==0
  132349. || sqlite3GlobalConfig.bFullMutex==0 );
  132350. sqlite3_mutex_leave(db->mutex);
  132351. }
  132352. rc = sqlite3_errcode(db);
  132353. assert( db!=0 || rc==SQLITE_NOMEM );
  132354. if( rc==SQLITE_NOMEM ){
  132355. sqlite3_close(db);
  132356. db = 0;
  132357. }else if( rc!=SQLITE_OK ){
  132358. db->magic = SQLITE_MAGIC_SICK;
  132359. }
  132360. *ppDb = db;
  132361. #ifdef SQLITE_ENABLE_SQLLOG
  132362. if( sqlite3GlobalConfig.xSqllog ){
  132363. /* Opening a db handle. Fourth parameter is passed 0. */
  132364. void *pArg = sqlite3GlobalConfig.pSqllogArg;
  132365. sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
  132366. }
  132367. #endif
  132368. #if defined(SQLITE_HAS_CODEC)
  132369. if( rc==SQLITE_OK ){
  132370. const char *zHexKey = sqlite3_uri_parameter(zOpen, "hexkey");
  132371. if( zHexKey && zHexKey[0] ){
  132372. u8 iByte;
  132373. int i;
  132374. char zKey[40];
  132375. for(i=0, iByte=0; i<sizeof(zKey)*2 && sqlite3Isxdigit(zHexKey[i]); i++){
  132376. iByte = (iByte<<4) + sqlite3HexToInt(zHexKey[i]);
  132377. if( (i&1)!=0 ) zKey[i/2] = iByte;
  132378. }
  132379. sqlite3_key_v2(db, 0, zKey, i/2);
  132380. }
  132381. }
  132382. #endif
  132383. sqlite3_free(zOpen);
  132384. return rc & 0xff;
  132385. }
  132386. /*
  132387. ** Open a new database handle.
  132388. */
  132389. SQLITE_API int sqlite3_open(
  132390. const char *zFilename,
  132391. sqlite3 **ppDb
  132392. ){
  132393. return openDatabase(zFilename, ppDb,
  132394. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
  132395. }
  132396. SQLITE_API int sqlite3_open_v2(
  132397. const char *filename, /* Database filename (UTF-8) */
  132398. sqlite3 **ppDb, /* OUT: SQLite db handle */
  132399. int flags, /* Flags */
  132400. const char *zVfs /* Name of VFS module to use */
  132401. ){
  132402. return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
  132403. }
  132404. #ifndef SQLITE_OMIT_UTF16
  132405. /*
  132406. ** Open a new database handle.
  132407. */
  132408. SQLITE_API int sqlite3_open16(
  132409. const void *zFilename,
  132410. sqlite3 **ppDb
  132411. ){
  132412. char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
  132413. sqlite3_value *pVal;
  132414. int rc;
  132415. #ifdef SQLITE_ENABLE_API_ARMOR
  132416. if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
  132417. #endif
  132418. *ppDb = 0;
  132419. #ifndef SQLITE_OMIT_AUTOINIT
  132420. rc = sqlite3_initialize();
  132421. if( rc ) return rc;
  132422. #endif
  132423. if( zFilename==0 ) zFilename = "\000\000";
  132424. pVal = sqlite3ValueNew(0);
  132425. sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
  132426. zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
  132427. if( zFilename8 ){
  132428. rc = openDatabase(zFilename8, ppDb,
  132429. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
  132430. assert( *ppDb || rc==SQLITE_NOMEM );
  132431. if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
  132432. SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
  132433. }
  132434. }else{
  132435. rc = SQLITE_NOMEM_BKPT;
  132436. }
  132437. sqlite3ValueFree(pVal);
  132438. return rc & 0xff;
  132439. }
  132440. #endif /* SQLITE_OMIT_UTF16 */
  132441. /*
  132442. ** Register a new collation sequence with the database handle db.
  132443. */
  132444. SQLITE_API int sqlite3_create_collation(
  132445. sqlite3* db,
  132446. const char *zName,
  132447. int enc,
  132448. void* pCtx,
  132449. int(*xCompare)(void*,int,const void*,int,const void*)
  132450. ){
  132451. return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
  132452. }
  132453. /*
  132454. ** Register a new collation sequence with the database handle db.
  132455. */
  132456. SQLITE_API int sqlite3_create_collation_v2(
  132457. sqlite3* db,
  132458. const char *zName,
  132459. int enc,
  132460. void* pCtx,
  132461. int(*xCompare)(void*,int,const void*,int,const void*),
  132462. void(*xDel)(void*)
  132463. ){
  132464. int rc;
  132465. #ifdef SQLITE_ENABLE_API_ARMOR
  132466. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  132467. #endif
  132468. sqlite3_mutex_enter(db->mutex);
  132469. assert( !db->mallocFailed );
  132470. rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
  132471. rc = sqlite3ApiExit(db, rc);
  132472. sqlite3_mutex_leave(db->mutex);
  132473. return rc;
  132474. }
  132475. #ifndef SQLITE_OMIT_UTF16
  132476. /*
  132477. ** Register a new collation sequence with the database handle db.
  132478. */
  132479. SQLITE_API int sqlite3_create_collation16(
  132480. sqlite3* db,
  132481. const void *zName,
  132482. int enc,
  132483. void* pCtx,
  132484. int(*xCompare)(void*,int,const void*,int,const void*)
  132485. ){
  132486. int rc = SQLITE_OK;
  132487. char *zName8;
  132488. #ifdef SQLITE_ENABLE_API_ARMOR
  132489. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  132490. #endif
  132491. sqlite3_mutex_enter(db->mutex);
  132492. assert( !db->mallocFailed );
  132493. zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
  132494. if( zName8 ){
  132495. rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
  132496. sqlite3DbFree(db, zName8);
  132497. }
  132498. rc = sqlite3ApiExit(db, rc);
  132499. sqlite3_mutex_leave(db->mutex);
  132500. return rc;
  132501. }
  132502. #endif /* SQLITE_OMIT_UTF16 */
  132503. /*
  132504. ** Register a collation sequence factory callback with the database handle
  132505. ** db. Replace any previously installed collation sequence factory.
  132506. */
  132507. SQLITE_API int sqlite3_collation_needed(
  132508. sqlite3 *db,
  132509. void *pCollNeededArg,
  132510. void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
  132511. ){
  132512. #ifdef SQLITE_ENABLE_API_ARMOR
  132513. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  132514. #endif
  132515. sqlite3_mutex_enter(db->mutex);
  132516. db->xCollNeeded = xCollNeeded;
  132517. db->xCollNeeded16 = 0;
  132518. db->pCollNeededArg = pCollNeededArg;
  132519. sqlite3_mutex_leave(db->mutex);
  132520. return SQLITE_OK;
  132521. }
  132522. #ifndef SQLITE_OMIT_UTF16
  132523. /*
  132524. ** Register a collation sequence factory callback with the database handle
  132525. ** db. Replace any previously installed collation sequence factory.
  132526. */
  132527. SQLITE_API int sqlite3_collation_needed16(
  132528. sqlite3 *db,
  132529. void *pCollNeededArg,
  132530. void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
  132531. ){
  132532. #ifdef SQLITE_ENABLE_API_ARMOR
  132533. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  132534. #endif
  132535. sqlite3_mutex_enter(db->mutex);
  132536. db->xCollNeeded = 0;
  132537. db->xCollNeeded16 = xCollNeeded16;
  132538. db->pCollNeededArg = pCollNeededArg;
  132539. sqlite3_mutex_leave(db->mutex);
  132540. return SQLITE_OK;
  132541. }
  132542. #endif /* SQLITE_OMIT_UTF16 */
  132543. #ifndef SQLITE_OMIT_DEPRECATED
  132544. /*
  132545. ** This function is now an anachronism. It used to be used to recover from a
  132546. ** malloc() failure, but SQLite now does this automatically.
  132547. */
  132548. SQLITE_API int sqlite3_global_recover(void){
  132549. return SQLITE_OK;
  132550. }
  132551. #endif
  132552. /*
  132553. ** Test to see whether or not the database connection is in autocommit
  132554. ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
  132555. ** by default. Autocommit is disabled by a BEGIN statement and reenabled
  132556. ** by the next COMMIT or ROLLBACK.
  132557. */
  132558. SQLITE_API int sqlite3_get_autocommit(sqlite3 *db){
  132559. #ifdef SQLITE_ENABLE_API_ARMOR
  132560. if( !sqlite3SafetyCheckOk(db) ){
  132561. (void)SQLITE_MISUSE_BKPT;
  132562. return 0;
  132563. }
  132564. #endif
  132565. return db->autoCommit;
  132566. }
  132567. /*
  132568. ** The following routines are substitutes for constants SQLITE_CORRUPT,
  132569. ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
  132570. ** constants. They serve two purposes:
  132571. **
  132572. ** 1. Serve as a convenient place to set a breakpoint in a debugger
  132573. ** to detect when version error conditions occurs.
  132574. **
  132575. ** 2. Invoke sqlite3_log() to provide the source code location where
  132576. ** a low-level error is first detected.
  132577. */
  132578. static int reportError(int iErr, int lineno, const char *zType){
  132579. sqlite3_log(iErr, "%s at line %d of [%.10s]",
  132580. zType, lineno, 20+sqlite3_sourceid());
  132581. return iErr;
  132582. }
  132583. SQLITE_PRIVATE int sqlite3CorruptError(int lineno){
  132584. testcase( sqlite3GlobalConfig.xLog!=0 );
  132585. return reportError(SQLITE_CORRUPT, lineno, "database corruption");
  132586. }
  132587. SQLITE_PRIVATE int sqlite3MisuseError(int lineno){
  132588. testcase( sqlite3GlobalConfig.xLog!=0 );
  132589. return reportError(SQLITE_MISUSE, lineno, "misuse");
  132590. }
  132591. SQLITE_PRIVATE int sqlite3CantopenError(int lineno){
  132592. testcase( sqlite3GlobalConfig.xLog!=0 );
  132593. return reportError(SQLITE_CANTOPEN, lineno, "cannot open file");
  132594. }
  132595. #ifdef SQLITE_DEBUG
  132596. SQLITE_PRIVATE int sqlite3NomemError(int lineno){
  132597. testcase( sqlite3GlobalConfig.xLog!=0 );
  132598. return reportError(SQLITE_NOMEM, lineno, "OOM");
  132599. }
  132600. SQLITE_PRIVATE int sqlite3IoerrnomemError(int lineno){
  132601. testcase( sqlite3GlobalConfig.xLog!=0 );
  132602. return reportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
  132603. }
  132604. #endif
  132605. #ifndef SQLITE_OMIT_DEPRECATED
  132606. /*
  132607. ** This is a convenience routine that makes sure that all thread-specific
  132608. ** data for this thread has been deallocated.
  132609. **
  132610. ** SQLite no longer uses thread-specific data so this routine is now a
  132611. ** no-op. It is retained for historical compatibility.
  132612. */
  132613. SQLITE_API void sqlite3_thread_cleanup(void){
  132614. }
  132615. #endif
  132616. /*
  132617. ** Return meta information about a specific column of a database table.
  132618. ** See comment in sqlite3.h (sqlite.h.in) for details.
  132619. */
  132620. SQLITE_API int sqlite3_table_column_metadata(
  132621. sqlite3 *db, /* Connection handle */
  132622. const char *zDbName, /* Database name or NULL */
  132623. const char *zTableName, /* Table name */
  132624. const char *zColumnName, /* Column name */
  132625. char const **pzDataType, /* OUTPUT: Declared data type */
  132626. char const **pzCollSeq, /* OUTPUT: Collation sequence name */
  132627. int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
  132628. int *pPrimaryKey, /* OUTPUT: True if column part of PK */
  132629. int *pAutoinc /* OUTPUT: True if column is auto-increment */
  132630. ){
  132631. int rc;
  132632. char *zErrMsg = 0;
  132633. Table *pTab = 0;
  132634. Column *pCol = 0;
  132635. int iCol = 0;
  132636. char const *zDataType = 0;
  132637. char const *zCollSeq = 0;
  132638. int notnull = 0;
  132639. int primarykey = 0;
  132640. int autoinc = 0;
  132641. #ifdef SQLITE_ENABLE_API_ARMOR
  132642. if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
  132643. return SQLITE_MISUSE_BKPT;
  132644. }
  132645. #endif
  132646. /* Ensure the database schema has been loaded */
  132647. sqlite3_mutex_enter(db->mutex);
  132648. sqlite3BtreeEnterAll(db);
  132649. rc = sqlite3Init(db, &zErrMsg);
  132650. if( SQLITE_OK!=rc ){
  132651. goto error_out;
  132652. }
  132653. /* Locate the table in question */
  132654. pTab = sqlite3FindTable(db, zTableName, zDbName);
  132655. if( !pTab || pTab->pSelect ){
  132656. pTab = 0;
  132657. goto error_out;
  132658. }
  132659. /* Find the column for which info is requested */
  132660. if( zColumnName==0 ){
  132661. /* Query for existance of table only */
  132662. }else{
  132663. for(iCol=0; iCol<pTab->nCol; iCol++){
  132664. pCol = &pTab->aCol[iCol];
  132665. if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
  132666. break;
  132667. }
  132668. }
  132669. if( iCol==pTab->nCol ){
  132670. if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
  132671. iCol = pTab->iPKey;
  132672. pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
  132673. }else{
  132674. pTab = 0;
  132675. goto error_out;
  132676. }
  132677. }
  132678. }
  132679. /* The following block stores the meta information that will be returned
  132680. ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
  132681. ** and autoinc. At this point there are two possibilities:
  132682. **
  132683. ** 1. The specified column name was rowid", "oid" or "_rowid_"
  132684. ** and there is no explicitly declared IPK column.
  132685. **
  132686. ** 2. The table is not a view and the column name identified an
  132687. ** explicitly declared column. Copy meta information from *pCol.
  132688. */
  132689. if( pCol ){
  132690. zDataType = sqlite3ColumnType(pCol,0);
  132691. zCollSeq = pCol->zColl;
  132692. notnull = pCol->notNull!=0;
  132693. primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
  132694. autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
  132695. }else{
  132696. zDataType = "INTEGER";
  132697. primarykey = 1;
  132698. }
  132699. if( !zCollSeq ){
  132700. zCollSeq = sqlite3StrBINARY;
  132701. }
  132702. error_out:
  132703. sqlite3BtreeLeaveAll(db);
  132704. /* Whether the function call succeeded or failed, set the output parameters
  132705. ** to whatever their local counterparts contain. If an error did occur,
  132706. ** this has the effect of zeroing all output parameters.
  132707. */
  132708. if( pzDataType ) *pzDataType = zDataType;
  132709. if( pzCollSeq ) *pzCollSeq = zCollSeq;
  132710. if( pNotNull ) *pNotNull = notnull;
  132711. if( pPrimaryKey ) *pPrimaryKey = primarykey;
  132712. if( pAutoinc ) *pAutoinc = autoinc;
  132713. if( SQLITE_OK==rc && !pTab ){
  132714. sqlite3DbFree(db, zErrMsg);
  132715. zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
  132716. zColumnName);
  132717. rc = SQLITE_ERROR;
  132718. }
  132719. sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
  132720. sqlite3DbFree(db, zErrMsg);
  132721. rc = sqlite3ApiExit(db, rc);
  132722. sqlite3_mutex_leave(db->mutex);
  132723. return rc;
  132724. }
  132725. /*
  132726. ** Sleep for a little while. Return the amount of time slept.
  132727. */
  132728. SQLITE_API int sqlite3_sleep(int ms){
  132729. sqlite3_vfs *pVfs;
  132730. int rc;
  132731. pVfs = sqlite3_vfs_find(0);
  132732. if( pVfs==0 ) return 0;
  132733. /* This function works in milliseconds, but the underlying OsSleep()
  132734. ** API uses microseconds. Hence the 1000's.
  132735. */
  132736. rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
  132737. return rc;
  132738. }
  132739. /*
  132740. ** Enable or disable the extended result codes.
  132741. */
  132742. SQLITE_API int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
  132743. #ifdef SQLITE_ENABLE_API_ARMOR
  132744. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  132745. #endif
  132746. sqlite3_mutex_enter(db->mutex);
  132747. db->errMask = onoff ? 0xffffffff : 0xff;
  132748. sqlite3_mutex_leave(db->mutex);
  132749. return SQLITE_OK;
  132750. }
  132751. /*
  132752. ** Invoke the xFileControl method on a particular database.
  132753. */
  132754. SQLITE_API int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
  132755. int rc = SQLITE_ERROR;
  132756. Btree *pBtree;
  132757. #ifdef SQLITE_ENABLE_API_ARMOR
  132758. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  132759. #endif
  132760. sqlite3_mutex_enter(db->mutex);
  132761. pBtree = sqlite3DbNameToBtree(db, zDbName);
  132762. if( pBtree ){
  132763. Pager *pPager;
  132764. sqlite3_file *fd;
  132765. sqlite3BtreeEnter(pBtree);
  132766. pPager = sqlite3BtreePager(pBtree);
  132767. assert( pPager!=0 );
  132768. fd = sqlite3PagerFile(pPager);
  132769. assert( fd!=0 );
  132770. if( op==SQLITE_FCNTL_FILE_POINTER ){
  132771. *(sqlite3_file**)pArg = fd;
  132772. rc = SQLITE_OK;
  132773. }else if( op==SQLITE_FCNTL_VFS_POINTER ){
  132774. *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
  132775. rc = SQLITE_OK;
  132776. }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
  132777. *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
  132778. rc = SQLITE_OK;
  132779. }else if( fd->pMethods ){
  132780. rc = sqlite3OsFileControl(fd, op, pArg);
  132781. }else{
  132782. rc = SQLITE_NOTFOUND;
  132783. }
  132784. sqlite3BtreeLeave(pBtree);
  132785. }
  132786. sqlite3_mutex_leave(db->mutex);
  132787. return rc;
  132788. }
  132789. /*
  132790. ** Interface to the testing logic.
  132791. */
  132792. SQLITE_API int sqlite3_test_control(int op, ...){
  132793. int rc = 0;
  132794. #ifdef SQLITE_OMIT_BUILTIN_TEST
  132795. UNUSED_PARAMETER(op);
  132796. #else
  132797. va_list ap;
  132798. va_start(ap, op);
  132799. switch( op ){
  132800. /*
  132801. ** Save the current state of the PRNG.
  132802. */
  132803. case SQLITE_TESTCTRL_PRNG_SAVE: {
  132804. sqlite3PrngSaveState();
  132805. break;
  132806. }
  132807. /*
  132808. ** Restore the state of the PRNG to the last state saved using
  132809. ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
  132810. ** this verb acts like PRNG_RESET.
  132811. */
  132812. case SQLITE_TESTCTRL_PRNG_RESTORE: {
  132813. sqlite3PrngRestoreState();
  132814. break;
  132815. }
  132816. /*
  132817. ** Reset the PRNG back to its uninitialized state. The next call
  132818. ** to sqlite3_randomness() will reseed the PRNG using a single call
  132819. ** to the xRandomness method of the default VFS.
  132820. */
  132821. case SQLITE_TESTCTRL_PRNG_RESET: {
  132822. sqlite3_randomness(0,0);
  132823. break;
  132824. }
  132825. /*
  132826. ** sqlite3_test_control(BITVEC_TEST, size, program)
  132827. **
  132828. ** Run a test against a Bitvec object of size. The program argument
  132829. ** is an array of integers that defines the test. Return -1 on a
  132830. ** memory allocation error, 0 on success, or non-zero for an error.
  132831. ** See the sqlite3BitvecBuiltinTest() for additional information.
  132832. */
  132833. case SQLITE_TESTCTRL_BITVEC_TEST: {
  132834. int sz = va_arg(ap, int);
  132835. int *aProg = va_arg(ap, int*);
  132836. rc = sqlite3BitvecBuiltinTest(sz, aProg);
  132837. break;
  132838. }
  132839. /*
  132840. ** sqlite3_test_control(FAULT_INSTALL, xCallback)
  132841. **
  132842. ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
  132843. ** if xCallback is not NULL.
  132844. **
  132845. ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
  132846. ** is called immediately after installing the new callback and the return
  132847. ** value from sqlite3FaultSim(0) becomes the return from
  132848. ** sqlite3_test_control().
  132849. */
  132850. case SQLITE_TESTCTRL_FAULT_INSTALL: {
  132851. /* MSVC is picky about pulling func ptrs from va lists.
  132852. ** http://support.microsoft.com/kb/47961
  132853. ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
  132854. */
  132855. typedef int(*TESTCALLBACKFUNC_t)(int);
  132856. sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
  132857. rc = sqlite3FaultSim(0);
  132858. break;
  132859. }
  132860. /*
  132861. ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
  132862. **
  132863. ** Register hooks to call to indicate which malloc() failures
  132864. ** are benign.
  132865. */
  132866. case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
  132867. typedef void (*void_function)(void);
  132868. void_function xBenignBegin;
  132869. void_function xBenignEnd;
  132870. xBenignBegin = va_arg(ap, void_function);
  132871. xBenignEnd = va_arg(ap, void_function);
  132872. sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
  132873. break;
  132874. }
  132875. /*
  132876. ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
  132877. **
  132878. ** Set the PENDING byte to the value in the argument, if X>0.
  132879. ** Make no changes if X==0. Return the value of the pending byte
  132880. ** as it existing before this routine was called.
  132881. **
  132882. ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
  132883. ** an incompatible database file format. Changing the PENDING byte
  132884. ** while any database connection is open results in undefined and
  132885. ** deleterious behavior.
  132886. */
  132887. case SQLITE_TESTCTRL_PENDING_BYTE: {
  132888. rc = PENDING_BYTE;
  132889. #ifndef SQLITE_OMIT_WSD
  132890. {
  132891. unsigned int newVal = va_arg(ap, unsigned int);
  132892. if( newVal ) sqlite3PendingByte = newVal;
  132893. }
  132894. #endif
  132895. break;
  132896. }
  132897. /*
  132898. ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
  132899. **
  132900. ** This action provides a run-time test to see whether or not
  132901. ** assert() was enabled at compile-time. If X is true and assert()
  132902. ** is enabled, then the return value is true. If X is true and
  132903. ** assert() is disabled, then the return value is zero. If X is
  132904. ** false and assert() is enabled, then the assertion fires and the
  132905. ** process aborts. If X is false and assert() is disabled, then the
  132906. ** return value is zero.
  132907. */
  132908. case SQLITE_TESTCTRL_ASSERT: {
  132909. volatile int x = 0;
  132910. assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
  132911. rc = x;
  132912. break;
  132913. }
  132914. /*
  132915. ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
  132916. **
  132917. ** This action provides a run-time test to see how the ALWAYS and
  132918. ** NEVER macros were defined at compile-time.
  132919. **
  132920. ** The return value is ALWAYS(X).
  132921. **
  132922. ** The recommended test is X==2. If the return value is 2, that means
  132923. ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
  132924. ** default setting. If the return value is 1, then ALWAYS() is either
  132925. ** hard-coded to true or else it asserts if its argument is false.
  132926. ** The first behavior (hard-coded to true) is the case if
  132927. ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
  132928. ** behavior (assert if the argument to ALWAYS() is false) is the case if
  132929. ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
  132930. **
  132931. ** The run-time test procedure might look something like this:
  132932. **
  132933. ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
  132934. ** // ALWAYS() and NEVER() are no-op pass-through macros
  132935. ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
  132936. ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
  132937. ** }else{
  132938. ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
  132939. ** }
  132940. */
  132941. case SQLITE_TESTCTRL_ALWAYS: {
  132942. int x = va_arg(ap,int);
  132943. rc = ALWAYS(x);
  132944. break;
  132945. }
  132946. /*
  132947. ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
  132948. **
  132949. ** The integer returned reveals the byte-order of the computer on which
  132950. ** SQLite is running:
  132951. **
  132952. ** 1 big-endian, determined at run-time
  132953. ** 10 little-endian, determined at run-time
  132954. ** 432101 big-endian, determined at compile-time
  132955. ** 123410 little-endian, determined at compile-time
  132956. */
  132957. case SQLITE_TESTCTRL_BYTEORDER: {
  132958. rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
  132959. break;
  132960. }
  132961. /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
  132962. **
  132963. ** Set the nReserve size to N for the main database on the database
  132964. ** connection db.
  132965. */
  132966. case SQLITE_TESTCTRL_RESERVE: {
  132967. sqlite3 *db = va_arg(ap, sqlite3*);
  132968. int x = va_arg(ap,int);
  132969. sqlite3_mutex_enter(db->mutex);
  132970. sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
  132971. sqlite3_mutex_leave(db->mutex);
  132972. break;
  132973. }
  132974. /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
  132975. **
  132976. ** Enable or disable various optimizations for testing purposes. The
  132977. ** argument N is a bitmask of optimizations to be disabled. For normal
  132978. ** operation N should be 0. The idea is that a test program (like the
  132979. ** SQL Logic Test or SLT test module) can run the same SQL multiple times
  132980. ** with various optimizations disabled to verify that the same answer
  132981. ** is obtained in every case.
  132982. */
  132983. case SQLITE_TESTCTRL_OPTIMIZATIONS: {
  132984. sqlite3 *db = va_arg(ap, sqlite3*);
  132985. db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
  132986. break;
  132987. }
  132988. #ifdef SQLITE_N_KEYWORD
  132989. /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
  132990. **
  132991. ** If zWord is a keyword recognized by the parser, then return the
  132992. ** number of keywords. Or if zWord is not a keyword, return 0.
  132993. **
  132994. ** This test feature is only available in the amalgamation since
  132995. ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
  132996. ** is built using separate source files.
  132997. */
  132998. case SQLITE_TESTCTRL_ISKEYWORD: {
  132999. const char *zWord = va_arg(ap, const char*);
  133000. int n = sqlite3Strlen30(zWord);
  133001. rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
  133002. break;
  133003. }
  133004. #endif
  133005. /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
  133006. **
  133007. ** Pass pFree into sqlite3ScratchFree().
  133008. ** If sz>0 then allocate a scratch buffer into pNew.
  133009. */
  133010. case SQLITE_TESTCTRL_SCRATCHMALLOC: {
  133011. void *pFree, **ppNew;
  133012. int sz;
  133013. sz = va_arg(ap, int);
  133014. ppNew = va_arg(ap, void**);
  133015. pFree = va_arg(ap, void*);
  133016. if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
  133017. sqlite3ScratchFree(pFree);
  133018. break;
  133019. }
  133020. /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
  133021. **
  133022. ** If parameter onoff is non-zero, configure the wrappers so that all
  133023. ** subsequent calls to localtime() and variants fail. If onoff is zero,
  133024. ** undo this setting.
  133025. */
  133026. case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
  133027. sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
  133028. break;
  133029. }
  133030. /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
  133031. **
  133032. ** Set or clear a flag that indicates that the database file is always well-
  133033. ** formed and never corrupt. This flag is clear by default, indicating that
  133034. ** database files might have arbitrary corruption. Setting the flag during
  133035. ** testing causes certain assert() statements in the code to be activated
  133036. ** that demonstrat invariants on well-formed database files.
  133037. */
  133038. case SQLITE_TESTCTRL_NEVER_CORRUPT: {
  133039. sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
  133040. break;
  133041. }
  133042. /* Set the threshold at which OP_Once counters reset back to zero.
  133043. ** By default this is 0x7ffffffe (over 2 billion), but that value is
  133044. ** too big to test in a reasonable amount of time, so this control is
  133045. ** provided to set a small and easily reachable reset value.
  133046. */
  133047. case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
  133048. sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
  133049. break;
  133050. }
  133051. /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
  133052. **
  133053. ** Set the VDBE coverage callback function to xCallback with context
  133054. ** pointer ptr.
  133055. */
  133056. case SQLITE_TESTCTRL_VDBE_COVERAGE: {
  133057. #ifdef SQLITE_VDBE_COVERAGE
  133058. typedef void (*branch_callback)(void*,int,u8,u8);
  133059. sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
  133060. sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
  133061. #endif
  133062. break;
  133063. }
  133064. /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
  133065. case SQLITE_TESTCTRL_SORTER_MMAP: {
  133066. sqlite3 *db = va_arg(ap, sqlite3*);
  133067. db->nMaxSorterMmap = va_arg(ap, int);
  133068. break;
  133069. }
  133070. /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
  133071. **
  133072. ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
  133073. ** not.
  133074. */
  133075. case SQLITE_TESTCTRL_ISINIT: {
  133076. if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
  133077. break;
  133078. }
  133079. /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
  133080. **
  133081. ** This test control is used to create imposter tables. "db" is a pointer
  133082. ** to the database connection. dbName is the database name (ex: "main" or
  133083. ** "temp") which will receive the imposter. "onOff" turns imposter mode on
  133084. ** or off. "tnum" is the root page of the b-tree to which the imposter
  133085. ** table should connect.
  133086. **
  133087. ** Enable imposter mode only when the schema has already been parsed. Then
  133088. ** run a single CREATE TABLE statement to construct the imposter table in
  133089. ** the parsed schema. Then turn imposter mode back off again.
  133090. **
  133091. ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
  133092. ** the schema to be reparsed the next time it is needed. This has the
  133093. ** effect of erasing all imposter tables.
  133094. */
  133095. case SQLITE_TESTCTRL_IMPOSTER: {
  133096. sqlite3 *db = va_arg(ap, sqlite3*);
  133097. sqlite3_mutex_enter(db->mutex);
  133098. db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
  133099. db->init.busy = db->init.imposterTable = va_arg(ap,int);
  133100. db->init.newTnum = va_arg(ap,int);
  133101. if( db->init.busy==0 && db->init.newTnum>0 ){
  133102. sqlite3ResetAllSchemasOfConnection(db);
  133103. }
  133104. sqlite3_mutex_leave(db->mutex);
  133105. break;
  133106. }
  133107. }
  133108. va_end(ap);
  133109. #endif /* SQLITE_OMIT_BUILTIN_TEST */
  133110. return rc;
  133111. }
  133112. /*
  133113. ** This is a utility routine, useful to VFS implementations, that checks
  133114. ** to see if a database file was a URI that contained a specific query
  133115. ** parameter, and if so obtains the value of the query parameter.
  133116. **
  133117. ** The zFilename argument is the filename pointer passed into the xOpen()
  133118. ** method of a VFS implementation. The zParam argument is the name of the
  133119. ** query parameter we seek. This routine returns the value of the zParam
  133120. ** parameter if it exists. If the parameter does not exist, this routine
  133121. ** returns a NULL pointer.
  133122. */
  133123. SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
  133124. if( zFilename==0 || zParam==0 ) return 0;
  133125. zFilename += sqlite3Strlen30(zFilename) + 1;
  133126. while( zFilename[0] ){
  133127. int x = strcmp(zFilename, zParam);
  133128. zFilename += sqlite3Strlen30(zFilename) + 1;
  133129. if( x==0 ) return zFilename;
  133130. zFilename += sqlite3Strlen30(zFilename) + 1;
  133131. }
  133132. return 0;
  133133. }
  133134. /*
  133135. ** Return a boolean value for a query parameter.
  133136. */
  133137. SQLITE_API int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
  133138. const char *z = sqlite3_uri_parameter(zFilename, zParam);
  133139. bDflt = bDflt!=0;
  133140. return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
  133141. }
  133142. /*
  133143. ** Return a 64-bit integer value for a query parameter.
  133144. */
  133145. SQLITE_API sqlite3_int64 sqlite3_uri_int64(
  133146. const char *zFilename, /* Filename as passed to xOpen */
  133147. const char *zParam, /* URI parameter sought */
  133148. sqlite3_int64 bDflt /* return if parameter is missing */
  133149. ){
  133150. const char *z = sqlite3_uri_parameter(zFilename, zParam);
  133151. sqlite3_int64 v;
  133152. if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
  133153. bDflt = v;
  133154. }
  133155. return bDflt;
  133156. }
  133157. /*
  133158. ** Return the Btree pointer identified by zDbName. Return NULL if not found.
  133159. */
  133160. SQLITE_PRIVATE Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
  133161. int i;
  133162. for(i=0; i<db->nDb; i++){
  133163. if( db->aDb[i].pBt
  133164. && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zDbSName)==0)
  133165. ){
  133166. return db->aDb[i].pBt;
  133167. }
  133168. }
  133169. return 0;
  133170. }
  133171. /*
  133172. ** Return the filename of the database associated with a database
  133173. ** connection.
  133174. */
  133175. SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
  133176. Btree *pBt;
  133177. #ifdef SQLITE_ENABLE_API_ARMOR
  133178. if( !sqlite3SafetyCheckOk(db) ){
  133179. (void)SQLITE_MISUSE_BKPT;
  133180. return 0;
  133181. }
  133182. #endif
  133183. pBt = sqlite3DbNameToBtree(db, zDbName);
  133184. return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
  133185. }
  133186. /*
  133187. ** Return 1 if database is read-only or 0 if read/write. Return -1 if
  133188. ** no such database exists.
  133189. */
  133190. SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
  133191. Btree *pBt;
  133192. #ifdef SQLITE_ENABLE_API_ARMOR
  133193. if( !sqlite3SafetyCheckOk(db) ){
  133194. (void)SQLITE_MISUSE_BKPT;
  133195. return -1;
  133196. }
  133197. #endif
  133198. pBt = sqlite3DbNameToBtree(db, zDbName);
  133199. return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
  133200. }
  133201. #ifdef SQLITE_ENABLE_SNAPSHOT
  133202. /*
  133203. ** Obtain a snapshot handle for the snapshot of database zDb currently
  133204. ** being read by handle db.
  133205. */
  133206. SQLITE_API int sqlite3_snapshot_get(
  133207. sqlite3 *db,
  133208. const char *zDb,
  133209. sqlite3_snapshot **ppSnapshot
  133210. ){
  133211. int rc = SQLITE_ERROR;
  133212. #ifndef SQLITE_OMIT_WAL
  133213. int iDb;
  133214. #ifdef SQLITE_ENABLE_API_ARMOR
  133215. if( !sqlite3SafetyCheckOk(db) ){
  133216. return SQLITE_MISUSE_BKPT;
  133217. }
  133218. #endif
  133219. sqlite3_mutex_enter(db->mutex);
  133220. iDb = sqlite3FindDbName(db, zDb);
  133221. if( iDb==0 || iDb>1 ){
  133222. Btree *pBt = db->aDb[iDb].pBt;
  133223. if( 0==sqlite3BtreeIsInTrans(pBt) ){
  133224. rc = sqlite3BtreeBeginTrans(pBt, 0);
  133225. if( rc==SQLITE_OK ){
  133226. rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
  133227. }
  133228. }
  133229. }
  133230. sqlite3_mutex_leave(db->mutex);
  133231. #endif /* SQLITE_OMIT_WAL */
  133232. return rc;
  133233. }
  133234. /*
  133235. ** Open a read-transaction on the snapshot idendified by pSnapshot.
  133236. */
  133237. SQLITE_API int sqlite3_snapshot_open(
  133238. sqlite3 *db,
  133239. const char *zDb,
  133240. sqlite3_snapshot *pSnapshot
  133241. ){
  133242. int rc = SQLITE_ERROR;
  133243. #ifndef SQLITE_OMIT_WAL
  133244. #ifdef SQLITE_ENABLE_API_ARMOR
  133245. if( !sqlite3SafetyCheckOk(db) ){
  133246. return SQLITE_MISUSE_BKPT;
  133247. }
  133248. #endif
  133249. sqlite3_mutex_enter(db->mutex);
  133250. if( db->autoCommit==0 ){
  133251. int iDb;
  133252. iDb = sqlite3FindDbName(db, zDb);
  133253. if( iDb==0 || iDb>1 ){
  133254. Btree *pBt = db->aDb[iDb].pBt;
  133255. if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
  133256. rc = sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), pSnapshot);
  133257. if( rc==SQLITE_OK ){
  133258. rc = sqlite3BtreeBeginTrans(pBt, 0);
  133259. sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), 0);
  133260. }
  133261. }
  133262. }
  133263. }
  133264. sqlite3_mutex_leave(db->mutex);
  133265. #endif /* SQLITE_OMIT_WAL */
  133266. return rc;
  133267. }
  133268. /*
  133269. ** Free a snapshot handle obtained from sqlite3_snapshot_get().
  133270. */
  133271. SQLITE_API void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
  133272. sqlite3_free(pSnapshot);
  133273. }
  133274. #endif /* SQLITE_ENABLE_SNAPSHOT */
  133275. /************** End of main.c ************************************************/
  133276. /************** Begin file notify.c ******************************************/
  133277. /*
  133278. ** 2009 March 3
  133279. **
  133280. ** The author disclaims copyright to this source code. In place of
  133281. ** a legal notice, here is a blessing:
  133282. **
  133283. ** May you do good and not evil.
  133284. ** May you find forgiveness for yourself and forgive others.
  133285. ** May you share freely, never taking more than you give.
  133286. **
  133287. *************************************************************************
  133288. **
  133289. ** This file contains the implementation of the sqlite3_unlock_notify()
  133290. ** API method and its associated functionality.
  133291. */
  133292. /* #include "sqliteInt.h" */
  133293. /* #include "btreeInt.h" */
  133294. /* Omit this entire file if SQLITE_ENABLE_UNLOCK_NOTIFY is not defined. */
  133295. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  133296. /*
  133297. ** Public interfaces:
  133298. **
  133299. ** sqlite3ConnectionBlocked()
  133300. ** sqlite3ConnectionUnlocked()
  133301. ** sqlite3ConnectionClosed()
  133302. ** sqlite3_unlock_notify()
  133303. */
  133304. #define assertMutexHeld() \
  133305. assert( sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER)) )
  133306. /*
  133307. ** Head of a linked list of all sqlite3 objects created by this process
  133308. ** for which either sqlite3.pBlockingConnection or sqlite3.pUnlockConnection
  133309. ** is not NULL. This variable may only accessed while the STATIC_MASTER
  133310. ** mutex is held.
  133311. */
  133312. static sqlite3 *SQLITE_WSD sqlite3BlockedList = 0;
  133313. #ifndef NDEBUG
  133314. /*
  133315. ** This function is a complex assert() that verifies the following
  133316. ** properties of the blocked connections list:
  133317. **
  133318. ** 1) Each entry in the list has a non-NULL value for either
  133319. ** pUnlockConnection or pBlockingConnection, or both.
  133320. **
  133321. ** 2) All entries in the list that share a common value for
  133322. ** xUnlockNotify are grouped together.
  133323. **
  133324. ** 3) If the argument db is not NULL, then none of the entries in the
  133325. ** blocked connections list have pUnlockConnection or pBlockingConnection
  133326. ** set to db. This is used when closing connection db.
  133327. */
  133328. static void checkListProperties(sqlite3 *db){
  133329. sqlite3 *p;
  133330. for(p=sqlite3BlockedList; p; p=p->pNextBlocked){
  133331. int seen = 0;
  133332. sqlite3 *p2;
  133333. /* Verify property (1) */
  133334. assert( p->pUnlockConnection || p->pBlockingConnection );
  133335. /* Verify property (2) */
  133336. for(p2=sqlite3BlockedList; p2!=p; p2=p2->pNextBlocked){
  133337. if( p2->xUnlockNotify==p->xUnlockNotify ) seen = 1;
  133338. assert( p2->xUnlockNotify==p->xUnlockNotify || !seen );
  133339. assert( db==0 || p->pUnlockConnection!=db );
  133340. assert( db==0 || p->pBlockingConnection!=db );
  133341. }
  133342. }
  133343. }
  133344. #else
  133345. # define checkListProperties(x)
  133346. #endif
  133347. /*
  133348. ** Remove connection db from the blocked connections list. If connection
  133349. ** db is not currently a part of the list, this function is a no-op.
  133350. */
  133351. static void removeFromBlockedList(sqlite3 *db){
  133352. sqlite3 **pp;
  133353. assertMutexHeld();
  133354. for(pp=&sqlite3BlockedList; *pp; pp = &(*pp)->pNextBlocked){
  133355. if( *pp==db ){
  133356. *pp = (*pp)->pNextBlocked;
  133357. break;
  133358. }
  133359. }
  133360. }
  133361. /*
  133362. ** Add connection db to the blocked connections list. It is assumed
  133363. ** that it is not already a part of the list.
  133364. */
  133365. static void addToBlockedList(sqlite3 *db){
  133366. sqlite3 **pp;
  133367. assertMutexHeld();
  133368. for(
  133369. pp=&sqlite3BlockedList;
  133370. *pp && (*pp)->xUnlockNotify!=db->xUnlockNotify;
  133371. pp=&(*pp)->pNextBlocked
  133372. );
  133373. db->pNextBlocked = *pp;
  133374. *pp = db;
  133375. }
  133376. /*
  133377. ** Obtain the STATIC_MASTER mutex.
  133378. */
  133379. static void enterMutex(void){
  133380. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  133381. checkListProperties(0);
  133382. }
  133383. /*
  133384. ** Release the STATIC_MASTER mutex.
  133385. */
  133386. static void leaveMutex(void){
  133387. assertMutexHeld();
  133388. checkListProperties(0);
  133389. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  133390. }
  133391. /*
  133392. ** Register an unlock-notify callback.
  133393. **
  133394. ** This is called after connection "db" has attempted some operation
  133395. ** but has received an SQLITE_LOCKED error because another connection
  133396. ** (call it pOther) in the same process was busy using the same shared
  133397. ** cache. pOther is found by looking at db->pBlockingConnection.
  133398. **
  133399. ** If there is no blocking connection, the callback is invoked immediately,
  133400. ** before this routine returns.
  133401. **
  133402. ** If pOther is already blocked on db, then report SQLITE_LOCKED, to indicate
  133403. ** a deadlock.
  133404. **
  133405. ** Otherwise, make arrangements to invoke xNotify when pOther drops
  133406. ** its locks.
  133407. **
  133408. ** Each call to this routine overrides any prior callbacks registered
  133409. ** on the same "db". If xNotify==0 then any prior callbacks are immediately
  133410. ** cancelled.
  133411. */
  133412. SQLITE_API int sqlite3_unlock_notify(
  133413. sqlite3 *db,
  133414. void (*xNotify)(void **, int),
  133415. void *pArg
  133416. ){
  133417. int rc = SQLITE_OK;
  133418. sqlite3_mutex_enter(db->mutex);
  133419. enterMutex();
  133420. if( xNotify==0 ){
  133421. removeFromBlockedList(db);
  133422. db->pBlockingConnection = 0;
  133423. db->pUnlockConnection = 0;
  133424. db->xUnlockNotify = 0;
  133425. db->pUnlockArg = 0;
  133426. }else if( 0==db->pBlockingConnection ){
  133427. /* The blocking transaction has been concluded. Or there never was a
  133428. ** blocking transaction. In either case, invoke the notify callback
  133429. ** immediately.
  133430. */
  133431. xNotify(&pArg, 1);
  133432. }else{
  133433. sqlite3 *p;
  133434. for(p=db->pBlockingConnection; p && p!=db; p=p->pUnlockConnection){}
  133435. if( p ){
  133436. rc = SQLITE_LOCKED; /* Deadlock detected. */
  133437. }else{
  133438. db->pUnlockConnection = db->pBlockingConnection;
  133439. db->xUnlockNotify = xNotify;
  133440. db->pUnlockArg = pArg;
  133441. removeFromBlockedList(db);
  133442. addToBlockedList(db);
  133443. }
  133444. }
  133445. leaveMutex();
  133446. assert( !db->mallocFailed );
  133447. sqlite3ErrorWithMsg(db, rc, (rc?"database is deadlocked":0));
  133448. sqlite3_mutex_leave(db->mutex);
  133449. return rc;
  133450. }
  133451. /*
  133452. ** This function is called while stepping or preparing a statement
  133453. ** associated with connection db. The operation will return SQLITE_LOCKED
  133454. ** to the user because it requires a lock that will not be available
  133455. ** until connection pBlocker concludes its current transaction.
  133456. */
  133457. SQLITE_PRIVATE void sqlite3ConnectionBlocked(sqlite3 *db, sqlite3 *pBlocker){
  133458. enterMutex();
  133459. if( db->pBlockingConnection==0 && db->pUnlockConnection==0 ){
  133460. addToBlockedList(db);
  133461. }
  133462. db->pBlockingConnection = pBlocker;
  133463. leaveMutex();
  133464. }
  133465. /*
  133466. ** This function is called when
  133467. ** the transaction opened by database db has just finished. Locks held
  133468. ** by database connection db have been released.
  133469. **
  133470. ** This function loops through each entry in the blocked connections
  133471. ** list and does the following:
  133472. **
  133473. ** 1) If the sqlite3.pBlockingConnection member of a list entry is
  133474. ** set to db, then set pBlockingConnection=0.
  133475. **
  133476. ** 2) If the sqlite3.pUnlockConnection member of a list entry is
  133477. ** set to db, then invoke the configured unlock-notify callback and
  133478. ** set pUnlockConnection=0.
  133479. **
  133480. ** 3) If the two steps above mean that pBlockingConnection==0 and
  133481. ** pUnlockConnection==0, remove the entry from the blocked connections
  133482. ** list.
  133483. */
  133484. SQLITE_PRIVATE void sqlite3ConnectionUnlocked(sqlite3 *db){
  133485. void (*xUnlockNotify)(void **, int) = 0; /* Unlock-notify cb to invoke */
  133486. int nArg = 0; /* Number of entries in aArg[] */
  133487. sqlite3 **pp; /* Iterator variable */
  133488. void **aArg; /* Arguments to the unlock callback */
  133489. void **aDyn = 0; /* Dynamically allocated space for aArg[] */
  133490. void *aStatic[16]; /* Starter space for aArg[]. No malloc required */
  133491. aArg = aStatic;
  133492. enterMutex(); /* Enter STATIC_MASTER mutex */
  133493. /* This loop runs once for each entry in the blocked-connections list. */
  133494. for(pp=&sqlite3BlockedList; *pp; /* no-op */ ){
  133495. sqlite3 *p = *pp;
  133496. /* Step 1. */
  133497. if( p->pBlockingConnection==db ){
  133498. p->pBlockingConnection = 0;
  133499. }
  133500. /* Step 2. */
  133501. if( p->pUnlockConnection==db ){
  133502. assert( p->xUnlockNotify );
  133503. if( p->xUnlockNotify!=xUnlockNotify && nArg!=0 ){
  133504. xUnlockNotify(aArg, nArg);
  133505. nArg = 0;
  133506. }
  133507. sqlite3BeginBenignMalloc();
  133508. assert( aArg==aDyn || (aDyn==0 && aArg==aStatic) );
  133509. assert( nArg<=(int)ArraySize(aStatic) || aArg==aDyn );
  133510. if( (!aDyn && nArg==(int)ArraySize(aStatic))
  133511. || (aDyn && nArg==(int)(sqlite3MallocSize(aDyn)/sizeof(void*)))
  133512. ){
  133513. /* The aArg[] array needs to grow. */
  133514. void **pNew = (void **)sqlite3Malloc(nArg*sizeof(void *)*2);
  133515. if( pNew ){
  133516. memcpy(pNew, aArg, nArg*sizeof(void *));
  133517. sqlite3_free(aDyn);
  133518. aDyn = aArg = pNew;
  133519. }else{
  133520. /* This occurs when the array of context pointers that need to
  133521. ** be passed to the unlock-notify callback is larger than the
  133522. ** aStatic[] array allocated on the stack and the attempt to
  133523. ** allocate a larger array from the heap has failed.
  133524. **
  133525. ** This is a difficult situation to handle. Returning an error
  133526. ** code to the caller is insufficient, as even if an error code
  133527. ** is returned the transaction on connection db will still be
  133528. ** closed and the unlock-notify callbacks on blocked connections
  133529. ** will go unissued. This might cause the application to wait
  133530. ** indefinitely for an unlock-notify callback that will never
  133531. ** arrive.
  133532. **
  133533. ** Instead, invoke the unlock-notify callback with the context
  133534. ** array already accumulated. We can then clear the array and
  133535. ** begin accumulating any further context pointers without
  133536. ** requiring any dynamic allocation. This is sub-optimal because
  133537. ** it means that instead of one callback with a large array of
  133538. ** context pointers the application will receive two or more
  133539. ** callbacks with smaller arrays of context pointers, which will
  133540. ** reduce the applications ability to prioritize multiple
  133541. ** connections. But it is the best that can be done under the
  133542. ** circumstances.
  133543. */
  133544. xUnlockNotify(aArg, nArg);
  133545. nArg = 0;
  133546. }
  133547. }
  133548. sqlite3EndBenignMalloc();
  133549. aArg[nArg++] = p->pUnlockArg;
  133550. xUnlockNotify = p->xUnlockNotify;
  133551. p->pUnlockConnection = 0;
  133552. p->xUnlockNotify = 0;
  133553. p->pUnlockArg = 0;
  133554. }
  133555. /* Step 3. */
  133556. if( p->pBlockingConnection==0 && p->pUnlockConnection==0 ){
  133557. /* Remove connection p from the blocked connections list. */
  133558. *pp = p->pNextBlocked;
  133559. p->pNextBlocked = 0;
  133560. }else{
  133561. pp = &p->pNextBlocked;
  133562. }
  133563. }
  133564. if( nArg!=0 ){
  133565. xUnlockNotify(aArg, nArg);
  133566. }
  133567. sqlite3_free(aDyn);
  133568. leaveMutex(); /* Leave STATIC_MASTER mutex */
  133569. }
  133570. /*
  133571. ** This is called when the database connection passed as an argument is
  133572. ** being closed. The connection is removed from the blocked list.
  133573. */
  133574. SQLITE_PRIVATE void sqlite3ConnectionClosed(sqlite3 *db){
  133575. sqlite3ConnectionUnlocked(db);
  133576. enterMutex();
  133577. removeFromBlockedList(db);
  133578. checkListProperties(db);
  133579. leaveMutex();
  133580. }
  133581. #endif
  133582. /************** End of notify.c **********************************************/
  133583. /************** Begin file fts3.c ********************************************/
  133584. /*
  133585. ** 2006 Oct 10
  133586. **
  133587. ** The author disclaims copyright to this source code. In place of
  133588. ** a legal notice, here is a blessing:
  133589. **
  133590. ** May you do good and not evil.
  133591. ** May you find forgiveness for yourself and forgive others.
  133592. ** May you share freely, never taking more than you give.
  133593. **
  133594. ******************************************************************************
  133595. **
  133596. ** This is an SQLite module implementing full-text search.
  133597. */
  133598. /*
  133599. ** The code in this file is only compiled if:
  133600. **
  133601. ** * The FTS3 module is being built as an extension
  133602. ** (in which case SQLITE_CORE is not defined), or
  133603. **
  133604. ** * The FTS3 module is being built into the core of
  133605. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  133606. */
  133607. /* The full-text index is stored in a series of b+tree (-like)
  133608. ** structures called segments which map terms to doclists. The
  133609. ** structures are like b+trees in layout, but are constructed from the
  133610. ** bottom up in optimal fashion and are not updatable. Since trees
  133611. ** are built from the bottom up, things will be described from the
  133612. ** bottom up.
  133613. **
  133614. **
  133615. **** Varints ****
  133616. ** The basic unit of encoding is a variable-length integer called a
  133617. ** varint. We encode variable-length integers in little-endian order
  133618. ** using seven bits * per byte as follows:
  133619. **
  133620. ** KEY:
  133621. ** A = 0xxxxxxx 7 bits of data and one flag bit
  133622. ** B = 1xxxxxxx 7 bits of data and one flag bit
  133623. **
  133624. ** 7 bits - A
  133625. ** 14 bits - BA
  133626. ** 21 bits - BBA
  133627. ** and so on.
  133628. **
  133629. ** This is similar in concept to how sqlite encodes "varints" but
  133630. ** the encoding is not the same. SQLite varints are big-endian
  133631. ** are are limited to 9 bytes in length whereas FTS3 varints are
  133632. ** little-endian and can be up to 10 bytes in length (in theory).
  133633. **
  133634. ** Example encodings:
  133635. **
  133636. ** 1: 0x01
  133637. ** 127: 0x7f
  133638. ** 128: 0x81 0x00
  133639. **
  133640. **
  133641. **** Document lists ****
  133642. ** A doclist (document list) holds a docid-sorted list of hits for a
  133643. ** given term. Doclists hold docids and associated token positions.
  133644. ** A docid is the unique integer identifier for a single document.
  133645. ** A position is the index of a word within the document. The first
  133646. ** word of the document has a position of 0.
  133647. **
  133648. ** FTS3 used to optionally store character offsets using a compile-time
  133649. ** option. But that functionality is no longer supported.
  133650. **
  133651. ** A doclist is stored like this:
  133652. **
  133653. ** array {
  133654. ** varint docid; (delta from previous doclist)
  133655. ** array { (position list for column 0)
  133656. ** varint position; (2 more than the delta from previous position)
  133657. ** }
  133658. ** array {
  133659. ** varint POS_COLUMN; (marks start of position list for new column)
  133660. ** varint column; (index of new column)
  133661. ** array {
  133662. ** varint position; (2 more than the delta from previous position)
  133663. ** }
  133664. ** }
  133665. ** varint POS_END; (marks end of positions for this document.
  133666. ** }
  133667. **
  133668. ** Here, array { X } means zero or more occurrences of X, adjacent in
  133669. ** memory. A "position" is an index of a token in the token stream
  133670. ** generated by the tokenizer. Note that POS_END and POS_COLUMN occur
  133671. ** in the same logical place as the position element, and act as sentinals
  133672. ** ending a position list array. POS_END is 0. POS_COLUMN is 1.
  133673. ** The positions numbers are not stored literally but rather as two more
  133674. ** than the difference from the prior position, or the just the position plus
  133675. ** 2 for the first position. Example:
  133676. **
  133677. ** label: A B C D E F G H I J K
  133678. ** value: 123 5 9 1 1 14 35 0 234 72 0
  133679. **
  133680. ** The 123 value is the first docid. For column zero in this document
  133681. ** there are two matches at positions 3 and 10 (5-2 and 9-2+3). The 1
  133682. ** at D signals the start of a new column; the 1 at E indicates that the
  133683. ** new column is column number 1. There are two positions at 12 and 45
  133684. ** (14-2 and 35-2+12). The 0 at H indicate the end-of-document. The
  133685. ** 234 at I is the delta to next docid (357). It has one position 70
  133686. ** (72-2) and then terminates with the 0 at K.
  133687. **
  133688. ** A "position-list" is the list of positions for multiple columns for
  133689. ** a single docid. A "column-list" is the set of positions for a single
  133690. ** column. Hence, a position-list consists of one or more column-lists,
  133691. ** a document record consists of a docid followed by a position-list and
  133692. ** a doclist consists of one or more document records.
  133693. **
  133694. ** A bare doclist omits the position information, becoming an
  133695. ** array of varint-encoded docids.
  133696. **
  133697. **** Segment leaf nodes ****
  133698. ** Segment leaf nodes store terms and doclists, ordered by term. Leaf
  133699. ** nodes are written using LeafWriter, and read using LeafReader (to
  133700. ** iterate through a single leaf node's data) and LeavesReader (to
  133701. ** iterate through a segment's entire leaf layer). Leaf nodes have
  133702. ** the format:
  133703. **
  133704. ** varint iHeight; (height from leaf level, always 0)
  133705. ** varint nTerm; (length of first term)
  133706. ** char pTerm[nTerm]; (content of first term)
  133707. ** varint nDoclist; (length of term's associated doclist)
  133708. ** char pDoclist[nDoclist]; (content of doclist)
  133709. ** array {
  133710. ** (further terms are delta-encoded)
  133711. ** varint nPrefix; (length of prefix shared with previous term)
  133712. ** varint nSuffix; (length of unshared suffix)
  133713. ** char pTermSuffix[nSuffix];(unshared suffix of next term)
  133714. ** varint nDoclist; (length of term's associated doclist)
  133715. ** char pDoclist[nDoclist]; (content of doclist)
  133716. ** }
  133717. **
  133718. ** Here, array { X } means zero or more occurrences of X, adjacent in
  133719. ** memory.
  133720. **
  133721. ** Leaf nodes are broken into blocks which are stored contiguously in
  133722. ** the %_segments table in sorted order. This means that when the end
  133723. ** of a node is reached, the next term is in the node with the next
  133724. ** greater node id.
  133725. **
  133726. ** New data is spilled to a new leaf node when the current node
  133727. ** exceeds LEAF_MAX bytes (default 2048). New data which itself is
  133728. ** larger than STANDALONE_MIN (default 1024) is placed in a standalone
  133729. ** node (a leaf node with a single term and doclist). The goal of
  133730. ** these settings is to pack together groups of small doclists while
  133731. ** making it efficient to directly access large doclists. The
  133732. ** assumption is that large doclists represent terms which are more
  133733. ** likely to be query targets.
  133734. **
  133735. ** TODO(shess) It may be useful for blocking decisions to be more
  133736. ** dynamic. For instance, it may make more sense to have a 2.5k leaf
  133737. ** node rather than splitting into 2k and .5k nodes. My intuition is
  133738. ** that this might extend through 2x or 4x the pagesize.
  133739. **
  133740. **
  133741. **** Segment interior nodes ****
  133742. ** Segment interior nodes store blockids for subtree nodes and terms
  133743. ** to describe what data is stored by the each subtree. Interior
  133744. ** nodes are written using InteriorWriter, and read using
  133745. ** InteriorReader. InteriorWriters are created as needed when
  133746. ** SegmentWriter creates new leaf nodes, or when an interior node
  133747. ** itself grows too big and must be split. The format of interior
  133748. ** nodes:
  133749. **
  133750. ** varint iHeight; (height from leaf level, always >0)
  133751. ** varint iBlockid; (block id of node's leftmost subtree)
  133752. ** optional {
  133753. ** varint nTerm; (length of first term)
  133754. ** char pTerm[nTerm]; (content of first term)
  133755. ** array {
  133756. ** (further terms are delta-encoded)
  133757. ** varint nPrefix; (length of shared prefix with previous term)
  133758. ** varint nSuffix; (length of unshared suffix)
  133759. ** char pTermSuffix[nSuffix]; (unshared suffix of next term)
  133760. ** }
  133761. ** }
  133762. **
  133763. ** Here, optional { X } means an optional element, while array { X }
  133764. ** means zero or more occurrences of X, adjacent in memory.
  133765. **
  133766. ** An interior node encodes n terms separating n+1 subtrees. The
  133767. ** subtree blocks are contiguous, so only the first subtree's blockid
  133768. ** is encoded. The subtree at iBlockid will contain all terms less
  133769. ** than the first term encoded (or all terms if no term is encoded).
  133770. ** Otherwise, for terms greater than or equal to pTerm[i] but less
  133771. ** than pTerm[i+1], the subtree for that term will be rooted at
  133772. ** iBlockid+i. Interior nodes only store enough term data to
  133773. ** distinguish adjacent children (if the rightmost term of the left
  133774. ** child is "something", and the leftmost term of the right child is
  133775. ** "wicked", only "w" is stored).
  133776. **
  133777. ** New data is spilled to a new interior node at the same height when
  133778. ** the current node exceeds INTERIOR_MAX bytes (default 2048).
  133779. ** INTERIOR_MIN_TERMS (default 7) keeps large terms from monopolizing
  133780. ** interior nodes and making the tree too skinny. The interior nodes
  133781. ** at a given height are naturally tracked by interior nodes at
  133782. ** height+1, and so on.
  133783. **
  133784. **
  133785. **** Segment directory ****
  133786. ** The segment directory in table %_segdir stores meta-information for
  133787. ** merging and deleting segments, and also the root node of the
  133788. ** segment's tree.
  133789. **
  133790. ** The root node is the top node of the segment's tree after encoding
  133791. ** the entire segment, restricted to ROOT_MAX bytes (default 1024).
  133792. ** This could be either a leaf node or an interior node. If the top
  133793. ** node requires more than ROOT_MAX bytes, it is flushed to %_segments
  133794. ** and a new root interior node is generated (which should always fit
  133795. ** within ROOT_MAX because it only needs space for 2 varints, the
  133796. ** height and the blockid of the previous root).
  133797. **
  133798. ** The meta-information in the segment directory is:
  133799. ** level - segment level (see below)
  133800. ** idx - index within level
  133801. ** - (level,idx uniquely identify a segment)
  133802. ** start_block - first leaf node
  133803. ** leaves_end_block - last leaf node
  133804. ** end_block - last block (including interior nodes)
  133805. ** root - contents of root node
  133806. **
  133807. ** If the root node is a leaf node, then start_block,
  133808. ** leaves_end_block, and end_block are all 0.
  133809. **
  133810. **
  133811. **** Segment merging ****
  133812. ** To amortize update costs, segments are grouped into levels and
  133813. ** merged in batches. Each increase in level represents exponentially
  133814. ** more documents.
  133815. **
  133816. ** New documents (actually, document updates) are tokenized and
  133817. ** written individually (using LeafWriter) to a level 0 segment, with
  133818. ** incrementing idx. When idx reaches MERGE_COUNT (default 16), all
  133819. ** level 0 segments are merged into a single level 1 segment. Level 1
  133820. ** is populated like level 0, and eventually MERGE_COUNT level 1
  133821. ** segments are merged to a single level 2 segment (representing
  133822. ** MERGE_COUNT^2 updates), and so on.
  133823. **
  133824. ** A segment merge traverses all segments at a given level in
  133825. ** parallel, performing a straightforward sorted merge. Since segment
  133826. ** leaf nodes are written in to the %_segments table in order, this
  133827. ** merge traverses the underlying sqlite disk structures efficiently.
  133828. ** After the merge, all segment blocks from the merged level are
  133829. ** deleted.
  133830. **
  133831. ** MERGE_COUNT controls how often we merge segments. 16 seems to be
  133832. ** somewhat of a sweet spot for insertion performance. 32 and 64 show
  133833. ** very similar performance numbers to 16 on insertion, though they're
  133834. ** a tiny bit slower (perhaps due to more overhead in merge-time
  133835. ** sorting). 8 is about 20% slower than 16, 4 about 50% slower than
  133836. ** 16, 2 about 66% slower than 16.
  133837. **
  133838. ** At query time, high MERGE_COUNT increases the number of segments
  133839. ** which need to be scanned and merged. For instance, with 100k docs
  133840. ** inserted:
  133841. **
  133842. ** MERGE_COUNT segments
  133843. ** 16 25
  133844. ** 8 12
  133845. ** 4 10
  133846. ** 2 6
  133847. **
  133848. ** This appears to have only a moderate impact on queries for very
  133849. ** frequent terms (which are somewhat dominated by segment merge
  133850. ** costs), and infrequent and non-existent terms still seem to be fast
  133851. ** even with many segments.
  133852. **
  133853. ** TODO(shess) That said, it would be nice to have a better query-side
  133854. ** argument for MERGE_COUNT of 16. Also, it is possible/likely that
  133855. ** optimizations to things like doclist merging will swing the sweet
  133856. ** spot around.
  133857. **
  133858. **
  133859. **
  133860. **** Handling of deletions and updates ****
  133861. ** Since we're using a segmented structure, with no docid-oriented
  133862. ** index into the term index, we clearly cannot simply update the term
  133863. ** index when a document is deleted or updated. For deletions, we
  133864. ** write an empty doclist (varint(docid) varint(POS_END)), for updates
  133865. ** we simply write the new doclist. Segment merges overwrite older
  133866. ** data for a particular docid with newer data, so deletes or updates
  133867. ** will eventually overtake the earlier data and knock it out. The
  133868. ** query logic likewise merges doclists so that newer data knocks out
  133869. ** older data.
  133870. */
  133871. /************** Include fts3Int.h in the middle of fts3.c ********************/
  133872. /************** Begin file fts3Int.h *****************************************/
  133873. /*
  133874. ** 2009 Nov 12
  133875. **
  133876. ** The author disclaims copyright to this source code. In place of
  133877. ** a legal notice, here is a blessing:
  133878. **
  133879. ** May you do good and not evil.
  133880. ** May you find forgiveness for yourself and forgive others.
  133881. ** May you share freely, never taking more than you give.
  133882. **
  133883. ******************************************************************************
  133884. **
  133885. */
  133886. #ifndef _FTSINT_H
  133887. #define _FTSINT_H
  133888. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  133889. # define NDEBUG 1
  133890. #endif
  133891. /* FTS3/FTS4 require virtual tables */
  133892. #ifdef SQLITE_OMIT_VIRTUALTABLE
  133893. # undef SQLITE_ENABLE_FTS3
  133894. # undef SQLITE_ENABLE_FTS4
  133895. #endif
  133896. /*
  133897. ** FTS4 is really an extension for FTS3. It is enabled using the
  133898. ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also all
  133899. ** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3.
  133900. */
  133901. #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
  133902. # define SQLITE_ENABLE_FTS3
  133903. #endif
  133904. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  133905. /* If not building as part of the core, include sqlite3ext.h. */
  133906. #ifndef SQLITE_CORE
  133907. /* # include "sqlite3ext.h" */
  133908. SQLITE_EXTENSION_INIT3
  133909. #endif
  133910. /* #include "sqlite3.h" */
  133911. /************** Include fts3_tokenizer.h in the middle of fts3Int.h **********/
  133912. /************** Begin file fts3_tokenizer.h **********************************/
  133913. /*
  133914. ** 2006 July 10
  133915. **
  133916. ** The author disclaims copyright to this source code.
  133917. **
  133918. *************************************************************************
  133919. ** Defines the interface to tokenizers used by fulltext-search. There
  133920. ** are three basic components:
  133921. **
  133922. ** sqlite3_tokenizer_module is a singleton defining the tokenizer
  133923. ** interface functions. This is essentially the class structure for
  133924. ** tokenizers.
  133925. **
  133926. ** sqlite3_tokenizer is used to define a particular tokenizer, perhaps
  133927. ** including customization information defined at creation time.
  133928. **
  133929. ** sqlite3_tokenizer_cursor is generated by a tokenizer to generate
  133930. ** tokens from a particular input.
  133931. */
  133932. #ifndef _FTS3_TOKENIZER_H_
  133933. #define _FTS3_TOKENIZER_H_
  133934. /* TODO(shess) Only used for SQLITE_OK and SQLITE_DONE at this time.
  133935. ** If tokenizers are to be allowed to call sqlite3_*() functions, then
  133936. ** we will need a way to register the API consistently.
  133937. */
  133938. /* #include "sqlite3.h" */
  133939. /*
  133940. ** Structures used by the tokenizer interface. When a new tokenizer
  133941. ** implementation is registered, the caller provides a pointer to
  133942. ** an sqlite3_tokenizer_module containing pointers to the callback
  133943. ** functions that make up an implementation.
  133944. **
  133945. ** When an fts3 table is created, it passes any arguments passed to
  133946. ** the tokenizer clause of the CREATE VIRTUAL TABLE statement to the
  133947. ** sqlite3_tokenizer_module.xCreate() function of the requested tokenizer
  133948. ** implementation. The xCreate() function in turn returns an
  133949. ** sqlite3_tokenizer structure representing the specific tokenizer to
  133950. ** be used for the fts3 table (customized by the tokenizer clause arguments).
  133951. **
  133952. ** To tokenize an input buffer, the sqlite3_tokenizer_module.xOpen()
  133953. ** method is called. It returns an sqlite3_tokenizer_cursor object
  133954. ** that may be used to tokenize a specific input buffer based on
  133955. ** the tokenization rules supplied by a specific sqlite3_tokenizer
  133956. ** object.
  133957. */
  133958. typedef struct sqlite3_tokenizer_module sqlite3_tokenizer_module;
  133959. typedef struct sqlite3_tokenizer sqlite3_tokenizer;
  133960. typedef struct sqlite3_tokenizer_cursor sqlite3_tokenizer_cursor;
  133961. struct sqlite3_tokenizer_module {
  133962. /*
  133963. ** Structure version. Should always be set to 0 or 1.
  133964. */
  133965. int iVersion;
  133966. /*
  133967. ** Create a new tokenizer. The values in the argv[] array are the
  133968. ** arguments passed to the "tokenizer" clause of the CREATE VIRTUAL
  133969. ** TABLE statement that created the fts3 table. For example, if
  133970. ** the following SQL is executed:
  133971. **
  133972. ** CREATE .. USING fts3( ... , tokenizer <tokenizer-name> arg1 arg2)
  133973. **
  133974. ** then argc is set to 2, and the argv[] array contains pointers
  133975. ** to the strings "arg1" and "arg2".
  133976. **
  133977. ** This method should return either SQLITE_OK (0), or an SQLite error
  133978. ** code. If SQLITE_OK is returned, then *ppTokenizer should be set
  133979. ** to point at the newly created tokenizer structure. The generic
  133980. ** sqlite3_tokenizer.pModule variable should not be initialized by
  133981. ** this callback. The caller will do so.
  133982. */
  133983. int (*xCreate)(
  133984. int argc, /* Size of argv array */
  133985. const char *const*argv, /* Tokenizer argument strings */
  133986. sqlite3_tokenizer **ppTokenizer /* OUT: Created tokenizer */
  133987. );
  133988. /*
  133989. ** Destroy an existing tokenizer. The fts3 module calls this method
  133990. ** exactly once for each successful call to xCreate().
  133991. */
  133992. int (*xDestroy)(sqlite3_tokenizer *pTokenizer);
  133993. /*
  133994. ** Create a tokenizer cursor to tokenize an input buffer. The caller
  133995. ** is responsible for ensuring that the input buffer remains valid
  133996. ** until the cursor is closed (using the xClose() method).
  133997. */
  133998. int (*xOpen)(
  133999. sqlite3_tokenizer *pTokenizer, /* Tokenizer object */
  134000. const char *pInput, int nBytes, /* Input buffer */
  134001. sqlite3_tokenizer_cursor **ppCursor /* OUT: Created tokenizer cursor */
  134002. );
  134003. /*
  134004. ** Destroy an existing tokenizer cursor. The fts3 module calls this
  134005. ** method exactly once for each successful call to xOpen().
  134006. */
  134007. int (*xClose)(sqlite3_tokenizer_cursor *pCursor);
  134008. /*
  134009. ** Retrieve the next token from the tokenizer cursor pCursor. This
  134010. ** method should either return SQLITE_OK and set the values of the
  134011. ** "OUT" variables identified below, or SQLITE_DONE to indicate that
  134012. ** the end of the buffer has been reached, or an SQLite error code.
  134013. **
  134014. ** *ppToken should be set to point at a buffer containing the
  134015. ** normalized version of the token (i.e. after any case-folding and/or
  134016. ** stemming has been performed). *pnBytes should be set to the length
  134017. ** of this buffer in bytes. The input text that generated the token is
  134018. ** identified by the byte offsets returned in *piStartOffset and
  134019. ** *piEndOffset. *piStartOffset should be set to the index of the first
  134020. ** byte of the token in the input buffer. *piEndOffset should be set
  134021. ** to the index of the first byte just past the end of the token in
  134022. ** the input buffer.
  134023. **
  134024. ** The buffer *ppToken is set to point at is managed by the tokenizer
  134025. ** implementation. It is only required to be valid until the next call
  134026. ** to xNext() or xClose().
  134027. */
  134028. /* TODO(shess) current implementation requires pInput to be
  134029. ** nul-terminated. This should either be fixed, or pInput/nBytes
  134030. ** should be converted to zInput.
  134031. */
  134032. int (*xNext)(
  134033. sqlite3_tokenizer_cursor *pCursor, /* Tokenizer cursor */
  134034. const char **ppToken, int *pnBytes, /* OUT: Normalized text for token */
  134035. int *piStartOffset, /* OUT: Byte offset of token in input buffer */
  134036. int *piEndOffset, /* OUT: Byte offset of end of token in input buffer */
  134037. int *piPosition /* OUT: Number of tokens returned before this one */
  134038. );
  134039. /***********************************************************************
  134040. ** Methods below this point are only available if iVersion>=1.
  134041. */
  134042. /*
  134043. ** Configure the language id of a tokenizer cursor.
  134044. */
  134045. int (*xLanguageid)(sqlite3_tokenizer_cursor *pCsr, int iLangid);
  134046. };
  134047. struct sqlite3_tokenizer {
  134048. const sqlite3_tokenizer_module *pModule; /* The module for this tokenizer */
  134049. /* Tokenizer implementations will typically add additional fields */
  134050. };
  134051. struct sqlite3_tokenizer_cursor {
  134052. sqlite3_tokenizer *pTokenizer; /* Tokenizer for this cursor. */
  134053. /* Tokenizer implementations will typically add additional fields */
  134054. };
  134055. int fts3_global_term_cnt(int iTerm, int iCol);
  134056. int fts3_term_cnt(int iTerm, int iCol);
  134057. #endif /* _FTS3_TOKENIZER_H_ */
  134058. /************** End of fts3_tokenizer.h **************************************/
  134059. /************** Continuing where we left off in fts3Int.h ********************/
  134060. /************** Include fts3_hash.h in the middle of fts3Int.h ***************/
  134061. /************** Begin file fts3_hash.h ***************************************/
  134062. /*
  134063. ** 2001 September 22
  134064. **
  134065. ** The author disclaims copyright to this source code. In place of
  134066. ** a legal notice, here is a blessing:
  134067. **
  134068. ** May you do good and not evil.
  134069. ** May you find forgiveness for yourself and forgive others.
  134070. ** May you share freely, never taking more than you give.
  134071. **
  134072. *************************************************************************
  134073. ** This is the header file for the generic hash-table implementation
  134074. ** used in SQLite. We've modified it slightly to serve as a standalone
  134075. ** hash table implementation for the full-text indexing module.
  134076. **
  134077. */
  134078. #ifndef _FTS3_HASH_H_
  134079. #define _FTS3_HASH_H_
  134080. /* Forward declarations of structures. */
  134081. typedef struct Fts3Hash Fts3Hash;
  134082. typedef struct Fts3HashElem Fts3HashElem;
  134083. /* A complete hash table is an instance of the following structure.
  134084. ** The internals of this structure are intended to be opaque -- client
  134085. ** code should not attempt to access or modify the fields of this structure
  134086. ** directly. Change this structure only by using the routines below.
  134087. ** However, many of the "procedures" and "functions" for modifying and
  134088. ** accessing this structure are really macros, so we can't really make
  134089. ** this structure opaque.
  134090. */
  134091. struct Fts3Hash {
  134092. char keyClass; /* HASH_INT, _POINTER, _STRING, _BINARY */
  134093. char copyKey; /* True if copy of key made on insert */
  134094. int count; /* Number of entries in this table */
  134095. Fts3HashElem *first; /* The first element of the array */
  134096. int htsize; /* Number of buckets in the hash table */
  134097. struct _fts3ht { /* the hash table */
  134098. int count; /* Number of entries with this hash */
  134099. Fts3HashElem *chain; /* Pointer to first entry with this hash */
  134100. } *ht;
  134101. };
  134102. /* Each element in the hash table is an instance of the following
  134103. ** structure. All elements are stored on a single doubly-linked list.
  134104. **
  134105. ** Again, this structure is intended to be opaque, but it can't really
  134106. ** be opaque because it is used by macros.
  134107. */
  134108. struct Fts3HashElem {
  134109. Fts3HashElem *next, *prev; /* Next and previous elements in the table */
  134110. void *data; /* Data associated with this element */
  134111. void *pKey; int nKey; /* Key associated with this element */
  134112. };
  134113. /*
  134114. ** There are 2 different modes of operation for a hash table:
  134115. **
  134116. ** FTS3_HASH_STRING pKey points to a string that is nKey bytes long
  134117. ** (including the null-terminator, if any). Case
  134118. ** is respected in comparisons.
  134119. **
  134120. ** FTS3_HASH_BINARY pKey points to binary data nKey bytes long.
  134121. ** memcmp() is used to compare keys.
  134122. **
  134123. ** A copy of the key is made if the copyKey parameter to fts3HashInit is 1.
  134124. */
  134125. #define FTS3_HASH_STRING 1
  134126. #define FTS3_HASH_BINARY 2
  134127. /*
  134128. ** Access routines. To delete, insert a NULL pointer.
  134129. */
  134130. SQLITE_PRIVATE void sqlite3Fts3HashInit(Fts3Hash *pNew, char keyClass, char copyKey);
  134131. SQLITE_PRIVATE void *sqlite3Fts3HashInsert(Fts3Hash*, const void *pKey, int nKey, void *pData);
  134132. SQLITE_PRIVATE void *sqlite3Fts3HashFind(const Fts3Hash*, const void *pKey, int nKey);
  134133. SQLITE_PRIVATE void sqlite3Fts3HashClear(Fts3Hash*);
  134134. SQLITE_PRIVATE Fts3HashElem *sqlite3Fts3HashFindElem(const Fts3Hash *, const void *, int);
  134135. /*
  134136. ** Shorthand for the functions above
  134137. */
  134138. #define fts3HashInit sqlite3Fts3HashInit
  134139. #define fts3HashInsert sqlite3Fts3HashInsert
  134140. #define fts3HashFind sqlite3Fts3HashFind
  134141. #define fts3HashClear sqlite3Fts3HashClear
  134142. #define fts3HashFindElem sqlite3Fts3HashFindElem
  134143. /*
  134144. ** Macros for looping over all elements of a hash table. The idiom is
  134145. ** like this:
  134146. **
  134147. ** Fts3Hash h;
  134148. ** Fts3HashElem *p;
  134149. ** ...
  134150. ** for(p=fts3HashFirst(&h); p; p=fts3HashNext(p)){
  134151. ** SomeStructure *pData = fts3HashData(p);
  134152. ** // do something with pData
  134153. ** }
  134154. */
  134155. #define fts3HashFirst(H) ((H)->first)
  134156. #define fts3HashNext(E) ((E)->next)
  134157. #define fts3HashData(E) ((E)->data)
  134158. #define fts3HashKey(E) ((E)->pKey)
  134159. #define fts3HashKeysize(E) ((E)->nKey)
  134160. /*
  134161. ** Number of entries in a hash table
  134162. */
  134163. #define fts3HashCount(H) ((H)->count)
  134164. #endif /* _FTS3_HASH_H_ */
  134165. /************** End of fts3_hash.h *******************************************/
  134166. /************** Continuing where we left off in fts3Int.h ********************/
  134167. /*
  134168. ** This constant determines the maximum depth of an FTS expression tree
  134169. ** that the library will create and use. FTS uses recursion to perform
  134170. ** various operations on the query tree, so the disadvantage of a large
  134171. ** limit is that it may allow very large queries to use large amounts
  134172. ** of stack space (perhaps causing a stack overflow).
  134173. */
  134174. #ifndef SQLITE_FTS3_MAX_EXPR_DEPTH
  134175. # define SQLITE_FTS3_MAX_EXPR_DEPTH 12
  134176. #endif
  134177. /*
  134178. ** This constant controls how often segments are merged. Once there are
  134179. ** FTS3_MERGE_COUNT segments of level N, they are merged into a single
  134180. ** segment of level N+1.
  134181. */
  134182. #define FTS3_MERGE_COUNT 16
  134183. /*
  134184. ** This is the maximum amount of data (in bytes) to store in the
  134185. ** Fts3Table.pendingTerms hash table. Normally, the hash table is
  134186. ** populated as documents are inserted/updated/deleted in a transaction
  134187. ** and used to create a new segment when the transaction is committed.
  134188. ** However if this limit is reached midway through a transaction, a new
  134189. ** segment is created and the hash table cleared immediately.
  134190. */
  134191. #define FTS3_MAX_PENDING_DATA (1*1024*1024)
  134192. /*
  134193. ** Macro to return the number of elements in an array. SQLite has a
  134194. ** similar macro called ArraySize(). Use a different name to avoid
  134195. ** a collision when building an amalgamation with built-in FTS3.
  134196. */
  134197. #define SizeofArray(X) ((int)(sizeof(X)/sizeof(X[0])))
  134198. #ifndef MIN
  134199. # define MIN(x,y) ((x)<(y)?(x):(y))
  134200. #endif
  134201. #ifndef MAX
  134202. # define MAX(x,y) ((x)>(y)?(x):(y))
  134203. #endif
  134204. /*
  134205. ** Maximum length of a varint encoded integer. The varint format is different
  134206. ** from that used by SQLite, so the maximum length is 10, not 9.
  134207. */
  134208. #define FTS3_VARINT_MAX 10
  134209. /*
  134210. ** FTS4 virtual tables may maintain multiple indexes - one index of all terms
  134211. ** in the document set and zero or more prefix indexes. All indexes are stored
  134212. ** as one or more b+-trees in the %_segments and %_segdir tables.
  134213. **
  134214. ** It is possible to determine which index a b+-tree belongs to based on the
  134215. ** value stored in the "%_segdir.level" column. Given this value L, the index
  134216. ** that the b+-tree belongs to is (L<<10). In other words, all b+-trees with
  134217. ** level values between 0 and 1023 (inclusive) belong to index 0, all levels
  134218. ** between 1024 and 2047 to index 1, and so on.
  134219. **
  134220. ** It is considered impossible for an index to use more than 1024 levels. In
  134221. ** theory though this may happen, but only after at least
  134222. ** (FTS3_MERGE_COUNT^1024) separate flushes of the pending-terms tables.
  134223. */
  134224. #define FTS3_SEGDIR_MAXLEVEL 1024
  134225. #define FTS3_SEGDIR_MAXLEVEL_STR "1024"
  134226. /*
  134227. ** The testcase() macro is only used by the amalgamation. If undefined,
  134228. ** make it a no-op.
  134229. */
  134230. #ifndef testcase
  134231. # define testcase(X)
  134232. #endif
  134233. /*
  134234. ** Terminator values for position-lists and column-lists.
  134235. */
  134236. #define POS_COLUMN (1) /* Column-list terminator */
  134237. #define POS_END (0) /* Position-list terminator */
  134238. /*
  134239. ** This section provides definitions to allow the
  134240. ** FTS3 extension to be compiled outside of the
  134241. ** amalgamation.
  134242. */
  134243. #ifndef SQLITE_AMALGAMATION
  134244. /*
  134245. ** Macros indicating that conditional expressions are always true or
  134246. ** false.
  134247. */
  134248. #ifdef SQLITE_COVERAGE_TEST
  134249. # define ALWAYS(x) (1)
  134250. # define NEVER(X) (0)
  134251. #elif defined(SQLITE_DEBUG)
  134252. # define ALWAYS(x) sqlite3Fts3Always((x)!=0)
  134253. # define NEVER(x) sqlite3Fts3Never((x)!=0)
  134254. SQLITE_PRIVATE int sqlite3Fts3Always(int b);
  134255. SQLITE_PRIVATE int sqlite3Fts3Never(int b);
  134256. #else
  134257. # define ALWAYS(x) (x)
  134258. # define NEVER(x) (x)
  134259. #endif
  134260. /*
  134261. ** Internal types used by SQLite.
  134262. */
  134263. typedef unsigned char u8; /* 1-byte (or larger) unsigned integer */
  134264. typedef short int i16; /* 2-byte (or larger) signed integer */
  134265. typedef unsigned int u32; /* 4-byte unsigned integer */
  134266. typedef sqlite3_uint64 u64; /* 8-byte unsigned integer */
  134267. typedef sqlite3_int64 i64; /* 8-byte signed integer */
  134268. /*
  134269. ** Macro used to suppress compiler warnings for unused parameters.
  134270. */
  134271. #define UNUSED_PARAMETER(x) (void)(x)
  134272. /*
  134273. ** Activate assert() only if SQLITE_TEST is enabled.
  134274. */
  134275. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  134276. # define NDEBUG 1
  134277. #endif
  134278. /*
  134279. ** The TESTONLY macro is used to enclose variable declarations or
  134280. ** other bits of code that are needed to support the arguments
  134281. ** within testcase() and assert() macros.
  134282. */
  134283. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  134284. # define TESTONLY(X) X
  134285. #else
  134286. # define TESTONLY(X)
  134287. #endif
  134288. #endif /* SQLITE_AMALGAMATION */
  134289. #ifdef SQLITE_DEBUG
  134290. SQLITE_PRIVATE int sqlite3Fts3Corrupt(void);
  134291. # define FTS_CORRUPT_VTAB sqlite3Fts3Corrupt()
  134292. #else
  134293. # define FTS_CORRUPT_VTAB SQLITE_CORRUPT_VTAB
  134294. #endif
  134295. typedef struct Fts3Table Fts3Table;
  134296. typedef struct Fts3Cursor Fts3Cursor;
  134297. typedef struct Fts3Expr Fts3Expr;
  134298. typedef struct Fts3Phrase Fts3Phrase;
  134299. typedef struct Fts3PhraseToken Fts3PhraseToken;
  134300. typedef struct Fts3Doclist Fts3Doclist;
  134301. typedef struct Fts3SegFilter Fts3SegFilter;
  134302. typedef struct Fts3DeferredToken Fts3DeferredToken;
  134303. typedef struct Fts3SegReader Fts3SegReader;
  134304. typedef struct Fts3MultiSegReader Fts3MultiSegReader;
  134305. typedef struct MatchinfoBuffer MatchinfoBuffer;
  134306. /*
  134307. ** A connection to a fulltext index is an instance of the following
  134308. ** structure. The xCreate and xConnect methods create an instance
  134309. ** of this structure and xDestroy and xDisconnect free that instance.
  134310. ** All other methods receive a pointer to the structure as one of their
  134311. ** arguments.
  134312. */
  134313. struct Fts3Table {
  134314. sqlite3_vtab base; /* Base class used by SQLite core */
  134315. sqlite3 *db; /* The database connection */
  134316. const char *zDb; /* logical database name */
  134317. const char *zName; /* virtual table name */
  134318. int nColumn; /* number of named columns in virtual table */
  134319. char **azColumn; /* column names. malloced */
  134320. u8 *abNotindexed; /* True for 'notindexed' columns */
  134321. sqlite3_tokenizer *pTokenizer; /* tokenizer for inserts and queries */
  134322. char *zContentTbl; /* content=xxx option, or NULL */
  134323. char *zLanguageid; /* languageid=xxx option, or NULL */
  134324. int nAutoincrmerge; /* Value configured by 'automerge' */
  134325. u32 nLeafAdd; /* Number of leaf blocks added this trans */
  134326. /* Precompiled statements used by the implementation. Each of these
  134327. ** statements is run and reset within a single virtual table API call.
  134328. */
  134329. sqlite3_stmt *aStmt[40];
  134330. char *zReadExprlist;
  134331. char *zWriteExprlist;
  134332. int nNodeSize; /* Soft limit for node size */
  134333. u8 bFts4; /* True for FTS4, false for FTS3 */
  134334. u8 bHasStat; /* True if %_stat table exists (2==unknown) */
  134335. u8 bHasDocsize; /* True if %_docsize table exists */
  134336. u8 bDescIdx; /* True if doclists are in reverse order */
  134337. u8 bIgnoreSavepoint; /* True to ignore xSavepoint invocations */
  134338. int nPgsz; /* Page size for host database */
  134339. char *zSegmentsTbl; /* Name of %_segments table */
  134340. sqlite3_blob *pSegments; /* Blob handle open on %_segments table */
  134341. /*
  134342. ** The following array of hash tables is used to buffer pending index
  134343. ** updates during transactions. All pending updates buffered at any one
  134344. ** time must share a common language-id (see the FTS4 langid= feature).
  134345. ** The current language id is stored in variable iPrevLangid.
  134346. **
  134347. ** A single FTS4 table may have multiple full-text indexes. For each index
  134348. ** there is an entry in the aIndex[] array. Index 0 is an index of all the
  134349. ** terms that appear in the document set. Each subsequent index in aIndex[]
  134350. ** is an index of prefixes of a specific length.
  134351. **
  134352. ** Variable nPendingData contains an estimate the memory consumed by the
  134353. ** pending data structures, including hash table overhead, but not including
  134354. ** malloc overhead. When nPendingData exceeds nMaxPendingData, all hash
  134355. ** tables are flushed to disk. Variable iPrevDocid is the docid of the most
  134356. ** recently inserted record.
  134357. */
  134358. int nIndex; /* Size of aIndex[] */
  134359. struct Fts3Index {
  134360. int nPrefix; /* Prefix length (0 for main terms index) */
  134361. Fts3Hash hPending; /* Pending terms table for this index */
  134362. } *aIndex;
  134363. int nMaxPendingData; /* Max pending data before flush to disk */
  134364. int nPendingData; /* Current bytes of pending data */
  134365. sqlite_int64 iPrevDocid; /* Docid of most recently inserted document */
  134366. int iPrevLangid; /* Langid of recently inserted document */
  134367. int bPrevDelete; /* True if last operation was a delete */
  134368. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  134369. /* State variables used for validating that the transaction control
  134370. ** methods of the virtual table are called at appropriate times. These
  134371. ** values do not contribute to FTS functionality; they are used for
  134372. ** verifying the operation of the SQLite core.
  134373. */
  134374. int inTransaction; /* True after xBegin but before xCommit/xRollback */
  134375. int mxSavepoint; /* Largest valid xSavepoint integer */
  134376. #endif
  134377. #ifdef SQLITE_TEST
  134378. /* True to disable the incremental doclist optimization. This is controled
  134379. ** by special insert command 'test-no-incr-doclist'. */
  134380. int bNoIncrDoclist;
  134381. #endif
  134382. };
  134383. /*
  134384. ** When the core wants to read from the virtual table, it creates a
  134385. ** virtual table cursor (an instance of the following structure) using
  134386. ** the xOpen method. Cursors are destroyed using the xClose method.
  134387. */
  134388. struct Fts3Cursor {
  134389. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  134390. i16 eSearch; /* Search strategy (see below) */
  134391. u8 isEof; /* True if at End Of Results */
  134392. u8 isRequireSeek; /* True if must seek pStmt to %_content row */
  134393. sqlite3_stmt *pStmt; /* Prepared statement in use by the cursor */
  134394. Fts3Expr *pExpr; /* Parsed MATCH query string */
  134395. int iLangid; /* Language being queried for */
  134396. int nPhrase; /* Number of matchable phrases in query */
  134397. Fts3DeferredToken *pDeferred; /* Deferred search tokens, if any */
  134398. sqlite3_int64 iPrevId; /* Previous id read from aDoclist */
  134399. char *pNextId; /* Pointer into the body of aDoclist */
  134400. char *aDoclist; /* List of docids for full-text queries */
  134401. int nDoclist; /* Size of buffer at aDoclist */
  134402. u8 bDesc; /* True to sort in descending order */
  134403. int eEvalmode; /* An FTS3_EVAL_XX constant */
  134404. int nRowAvg; /* Average size of database rows, in pages */
  134405. sqlite3_int64 nDoc; /* Documents in table */
  134406. i64 iMinDocid; /* Minimum docid to return */
  134407. i64 iMaxDocid; /* Maximum docid to return */
  134408. int isMatchinfoNeeded; /* True when aMatchinfo[] needs filling in */
  134409. MatchinfoBuffer *pMIBuffer; /* Buffer for matchinfo data */
  134410. };
  134411. #define FTS3_EVAL_FILTER 0
  134412. #define FTS3_EVAL_NEXT 1
  134413. #define FTS3_EVAL_MATCHINFO 2
  134414. /*
  134415. ** The Fts3Cursor.eSearch member is always set to one of the following.
  134416. ** Actualy, Fts3Cursor.eSearch can be greater than or equal to
  134417. ** FTS3_FULLTEXT_SEARCH. If so, then Fts3Cursor.eSearch - 2 is the index
  134418. ** of the column to be searched. For example, in
  134419. **
  134420. ** CREATE VIRTUAL TABLE ex1 USING fts3(a,b,c,d);
  134421. ** SELECT docid FROM ex1 WHERE b MATCH 'one two three';
  134422. **
  134423. ** Because the LHS of the MATCH operator is 2nd column "b",
  134424. ** Fts3Cursor.eSearch will be set to FTS3_FULLTEXT_SEARCH+1. (+0 for a,
  134425. ** +1 for b, +2 for c, +3 for d.) If the LHS of MATCH were "ex1"
  134426. ** indicating that all columns should be searched,
  134427. ** then eSearch would be set to FTS3_FULLTEXT_SEARCH+4.
  134428. */
  134429. #define FTS3_FULLSCAN_SEARCH 0 /* Linear scan of %_content table */
  134430. #define FTS3_DOCID_SEARCH 1 /* Lookup by rowid on %_content table */
  134431. #define FTS3_FULLTEXT_SEARCH 2 /* Full-text index search */
  134432. /*
  134433. ** The lower 16-bits of the sqlite3_index_info.idxNum value set by
  134434. ** the xBestIndex() method contains the Fts3Cursor.eSearch value described
  134435. ** above. The upper 16-bits contain a combination of the following
  134436. ** bits, used to describe extra constraints on full-text searches.
  134437. */
  134438. #define FTS3_HAVE_LANGID 0x00010000 /* languageid=? */
  134439. #define FTS3_HAVE_DOCID_GE 0x00020000 /* docid>=? */
  134440. #define FTS3_HAVE_DOCID_LE 0x00040000 /* docid<=? */
  134441. struct Fts3Doclist {
  134442. char *aAll; /* Array containing doclist (or NULL) */
  134443. int nAll; /* Size of a[] in bytes */
  134444. char *pNextDocid; /* Pointer to next docid */
  134445. sqlite3_int64 iDocid; /* Current docid (if pList!=0) */
  134446. int bFreeList; /* True if pList should be sqlite3_free()d */
  134447. char *pList; /* Pointer to position list following iDocid */
  134448. int nList; /* Length of position list */
  134449. };
  134450. /*
  134451. ** A "phrase" is a sequence of one or more tokens that must match in
  134452. ** sequence. A single token is the base case and the most common case.
  134453. ** For a sequence of tokens contained in double-quotes (i.e. "one two three")
  134454. ** nToken will be the number of tokens in the string.
  134455. */
  134456. struct Fts3PhraseToken {
  134457. char *z; /* Text of the token */
  134458. int n; /* Number of bytes in buffer z */
  134459. int isPrefix; /* True if token ends with a "*" character */
  134460. int bFirst; /* True if token must appear at position 0 */
  134461. /* Variables above this point are populated when the expression is
  134462. ** parsed (by code in fts3_expr.c). Below this point the variables are
  134463. ** used when evaluating the expression. */
  134464. Fts3DeferredToken *pDeferred; /* Deferred token object for this token */
  134465. Fts3MultiSegReader *pSegcsr; /* Segment-reader for this token */
  134466. };
  134467. struct Fts3Phrase {
  134468. /* Cache of doclist for this phrase. */
  134469. Fts3Doclist doclist;
  134470. int bIncr; /* True if doclist is loaded incrementally */
  134471. int iDoclistToken;
  134472. /* Used by sqlite3Fts3EvalPhrasePoslist() if this is a descendent of an
  134473. ** OR condition. */
  134474. char *pOrPoslist;
  134475. i64 iOrDocid;
  134476. /* Variables below this point are populated by fts3_expr.c when parsing
  134477. ** a MATCH expression. Everything above is part of the evaluation phase.
  134478. */
  134479. int nToken; /* Number of tokens in the phrase */
  134480. int iColumn; /* Index of column this phrase must match */
  134481. Fts3PhraseToken aToken[1]; /* One entry for each token in the phrase */
  134482. };
  134483. /*
  134484. ** A tree of these objects forms the RHS of a MATCH operator.
  134485. **
  134486. ** If Fts3Expr.eType is FTSQUERY_PHRASE and isLoaded is true, then aDoclist
  134487. ** points to a malloced buffer, size nDoclist bytes, containing the results
  134488. ** of this phrase query in FTS3 doclist format. As usual, the initial
  134489. ** "Length" field found in doclists stored on disk is omitted from this
  134490. ** buffer.
  134491. **
  134492. ** Variable aMI is used only for FTSQUERY_NEAR nodes to store the global
  134493. ** matchinfo data. If it is not NULL, it points to an array of size nCol*3,
  134494. ** where nCol is the number of columns in the queried FTS table. The array
  134495. ** is populated as follows:
  134496. **
  134497. ** aMI[iCol*3 + 0] = Undefined
  134498. ** aMI[iCol*3 + 1] = Number of occurrences
  134499. ** aMI[iCol*3 + 2] = Number of rows containing at least one instance
  134500. **
  134501. ** The aMI array is allocated using sqlite3_malloc(). It should be freed
  134502. ** when the expression node is.
  134503. */
  134504. struct Fts3Expr {
  134505. int eType; /* One of the FTSQUERY_XXX values defined below */
  134506. int nNear; /* Valid if eType==FTSQUERY_NEAR */
  134507. Fts3Expr *pParent; /* pParent->pLeft==this or pParent->pRight==this */
  134508. Fts3Expr *pLeft; /* Left operand */
  134509. Fts3Expr *pRight; /* Right operand */
  134510. Fts3Phrase *pPhrase; /* Valid if eType==FTSQUERY_PHRASE */
  134511. /* The following are used by the fts3_eval.c module. */
  134512. sqlite3_int64 iDocid; /* Current docid */
  134513. u8 bEof; /* True this expression is at EOF already */
  134514. u8 bStart; /* True if iDocid is valid */
  134515. u8 bDeferred; /* True if this expression is entirely deferred */
  134516. /* The following are used by the fts3_snippet.c module. */
  134517. int iPhrase; /* Index of this phrase in matchinfo() results */
  134518. u32 *aMI; /* See above */
  134519. };
  134520. /*
  134521. ** Candidate values for Fts3Query.eType. Note that the order of the first
  134522. ** four values is in order of precedence when parsing expressions. For
  134523. ** example, the following:
  134524. **
  134525. ** "a OR b AND c NOT d NEAR e"
  134526. **
  134527. ** is equivalent to:
  134528. **
  134529. ** "a OR (b AND (c NOT (d NEAR e)))"
  134530. */
  134531. #define FTSQUERY_NEAR 1
  134532. #define FTSQUERY_NOT 2
  134533. #define FTSQUERY_AND 3
  134534. #define FTSQUERY_OR 4
  134535. #define FTSQUERY_PHRASE 5
  134536. /* fts3_write.c */
  134537. SQLITE_PRIVATE int sqlite3Fts3UpdateMethod(sqlite3_vtab*,int,sqlite3_value**,sqlite3_int64*);
  134538. SQLITE_PRIVATE int sqlite3Fts3PendingTermsFlush(Fts3Table *);
  134539. SQLITE_PRIVATE void sqlite3Fts3PendingTermsClear(Fts3Table *);
  134540. SQLITE_PRIVATE int sqlite3Fts3Optimize(Fts3Table *);
  134541. SQLITE_PRIVATE int sqlite3Fts3SegReaderNew(int, int, sqlite3_int64,
  134542. sqlite3_int64, sqlite3_int64, const char *, int, Fts3SegReader**);
  134543. SQLITE_PRIVATE int sqlite3Fts3SegReaderPending(
  134544. Fts3Table*,int,const char*,int,int,Fts3SegReader**);
  134545. SQLITE_PRIVATE void sqlite3Fts3SegReaderFree(Fts3SegReader *);
  134546. SQLITE_PRIVATE int sqlite3Fts3AllSegdirs(Fts3Table*, int, int, int, sqlite3_stmt **);
  134547. SQLITE_PRIVATE int sqlite3Fts3ReadBlock(Fts3Table*, sqlite3_int64, char **, int*, int*);
  134548. SQLITE_PRIVATE int sqlite3Fts3SelectDoctotal(Fts3Table *, sqlite3_stmt **);
  134549. SQLITE_PRIVATE int sqlite3Fts3SelectDocsize(Fts3Table *, sqlite3_int64, sqlite3_stmt **);
  134550. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  134551. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredTokens(Fts3Cursor *);
  134552. SQLITE_PRIVATE int sqlite3Fts3DeferToken(Fts3Cursor *, Fts3PhraseToken *, int);
  134553. SQLITE_PRIVATE int sqlite3Fts3CacheDeferredDoclists(Fts3Cursor *);
  134554. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredDoclists(Fts3Cursor *);
  134555. SQLITE_PRIVATE int sqlite3Fts3DeferredTokenList(Fts3DeferredToken *, char **, int *);
  134556. #else
  134557. # define sqlite3Fts3FreeDeferredTokens(x)
  134558. # define sqlite3Fts3DeferToken(x,y,z) SQLITE_OK
  134559. # define sqlite3Fts3CacheDeferredDoclists(x) SQLITE_OK
  134560. # define sqlite3Fts3FreeDeferredDoclists(x)
  134561. # define sqlite3Fts3DeferredTokenList(x,y,z) SQLITE_OK
  134562. #endif
  134563. SQLITE_PRIVATE void sqlite3Fts3SegmentsClose(Fts3Table *);
  134564. SQLITE_PRIVATE int sqlite3Fts3MaxLevel(Fts3Table *, int *);
  134565. /* Special values interpreted by sqlite3SegReaderCursor() */
  134566. #define FTS3_SEGCURSOR_PENDING -1
  134567. #define FTS3_SEGCURSOR_ALL -2
  134568. SQLITE_PRIVATE int sqlite3Fts3SegReaderStart(Fts3Table*, Fts3MultiSegReader*, Fts3SegFilter*);
  134569. SQLITE_PRIVATE int sqlite3Fts3SegReaderStep(Fts3Table *, Fts3MultiSegReader *);
  134570. SQLITE_PRIVATE void sqlite3Fts3SegReaderFinish(Fts3MultiSegReader *);
  134571. SQLITE_PRIVATE int sqlite3Fts3SegReaderCursor(Fts3Table *,
  134572. int, int, int, const char *, int, int, int, Fts3MultiSegReader *);
  134573. /* Flags allowed as part of the 4th argument to SegmentReaderIterate() */
  134574. #define FTS3_SEGMENT_REQUIRE_POS 0x00000001
  134575. #define FTS3_SEGMENT_IGNORE_EMPTY 0x00000002
  134576. #define FTS3_SEGMENT_COLUMN_FILTER 0x00000004
  134577. #define FTS3_SEGMENT_PREFIX 0x00000008
  134578. #define FTS3_SEGMENT_SCAN 0x00000010
  134579. #define FTS3_SEGMENT_FIRST 0x00000020
  134580. /* Type passed as 4th argument to SegmentReaderIterate() */
  134581. struct Fts3SegFilter {
  134582. const char *zTerm;
  134583. int nTerm;
  134584. int iCol;
  134585. int flags;
  134586. };
  134587. struct Fts3MultiSegReader {
  134588. /* Used internally by sqlite3Fts3SegReaderXXX() calls */
  134589. Fts3SegReader **apSegment; /* Array of Fts3SegReader objects */
  134590. int nSegment; /* Size of apSegment array */
  134591. int nAdvance; /* How many seg-readers to advance */
  134592. Fts3SegFilter *pFilter; /* Pointer to filter object */
  134593. char *aBuffer; /* Buffer to merge doclists in */
  134594. int nBuffer; /* Allocated size of aBuffer[] in bytes */
  134595. int iColFilter; /* If >=0, filter for this column */
  134596. int bRestart;
  134597. /* Used by fts3.c only. */
  134598. int nCost; /* Cost of running iterator */
  134599. int bLookup; /* True if a lookup of a single entry. */
  134600. /* Output values. Valid only after Fts3SegReaderStep() returns SQLITE_ROW. */
  134601. char *zTerm; /* Pointer to term buffer */
  134602. int nTerm; /* Size of zTerm in bytes */
  134603. char *aDoclist; /* Pointer to doclist buffer */
  134604. int nDoclist; /* Size of aDoclist[] in bytes */
  134605. };
  134606. SQLITE_PRIVATE int sqlite3Fts3Incrmerge(Fts3Table*,int,int);
  134607. #define fts3GetVarint32(p, piVal) ( \
  134608. (*(u8*)(p)&0x80) ? sqlite3Fts3GetVarint32(p, piVal) : (*piVal=*(u8*)(p), 1) \
  134609. )
  134610. /* fts3.c */
  134611. SQLITE_PRIVATE void sqlite3Fts3ErrMsg(char**,const char*,...);
  134612. SQLITE_PRIVATE int sqlite3Fts3PutVarint(char *, sqlite3_int64);
  134613. SQLITE_PRIVATE int sqlite3Fts3GetVarint(const char *, sqlite_int64 *);
  134614. SQLITE_PRIVATE int sqlite3Fts3GetVarint32(const char *, int *);
  134615. SQLITE_PRIVATE int sqlite3Fts3VarintLen(sqlite3_uint64);
  134616. SQLITE_PRIVATE void sqlite3Fts3Dequote(char *);
  134617. SQLITE_PRIVATE void sqlite3Fts3DoclistPrev(int,char*,int,char**,sqlite3_int64*,int*,u8*);
  134618. SQLITE_PRIVATE int sqlite3Fts3EvalPhraseStats(Fts3Cursor *, Fts3Expr *, u32 *);
  134619. SQLITE_PRIVATE int sqlite3Fts3FirstFilter(sqlite3_int64, char *, int, char *);
  134620. SQLITE_PRIVATE void sqlite3Fts3CreateStatTable(int*, Fts3Table*);
  134621. SQLITE_PRIVATE int sqlite3Fts3EvalTestDeferred(Fts3Cursor *pCsr, int *pRc);
  134622. /* fts3_tokenizer.c */
  134623. SQLITE_PRIVATE const char *sqlite3Fts3NextToken(const char *, int *);
  134624. SQLITE_PRIVATE int sqlite3Fts3InitHashTable(sqlite3 *, Fts3Hash *, const char *);
  134625. SQLITE_PRIVATE int sqlite3Fts3InitTokenizer(Fts3Hash *pHash, const char *,
  134626. sqlite3_tokenizer **, char **
  134627. );
  134628. SQLITE_PRIVATE int sqlite3Fts3IsIdChar(char);
  134629. /* fts3_snippet.c */
  134630. SQLITE_PRIVATE void sqlite3Fts3Offsets(sqlite3_context*, Fts3Cursor*);
  134631. SQLITE_PRIVATE void sqlite3Fts3Snippet(sqlite3_context *, Fts3Cursor *, const char *,
  134632. const char *, const char *, int, int
  134633. );
  134634. SQLITE_PRIVATE void sqlite3Fts3Matchinfo(sqlite3_context *, Fts3Cursor *, const char *);
  134635. SQLITE_PRIVATE void sqlite3Fts3MIBufferFree(MatchinfoBuffer *p);
  134636. /* fts3_expr.c */
  134637. SQLITE_PRIVATE int sqlite3Fts3ExprParse(sqlite3_tokenizer *, int,
  134638. char **, int, int, int, const char *, int, Fts3Expr **, char **
  134639. );
  134640. SQLITE_PRIVATE void sqlite3Fts3ExprFree(Fts3Expr *);
  134641. #ifdef SQLITE_TEST
  134642. SQLITE_PRIVATE int sqlite3Fts3ExprInitTestInterface(sqlite3 *db);
  134643. SQLITE_PRIVATE int sqlite3Fts3InitTerm(sqlite3 *db);
  134644. #endif
  134645. SQLITE_PRIVATE int sqlite3Fts3OpenTokenizer(sqlite3_tokenizer *, int, const char *, int,
  134646. sqlite3_tokenizer_cursor **
  134647. );
  134648. /* fts3_aux.c */
  134649. SQLITE_PRIVATE int sqlite3Fts3InitAux(sqlite3 *db);
  134650. SQLITE_PRIVATE void sqlite3Fts3EvalPhraseCleanup(Fts3Phrase *);
  134651. SQLITE_PRIVATE int sqlite3Fts3MsrIncrStart(
  134652. Fts3Table*, Fts3MultiSegReader*, int, const char*, int);
  134653. SQLITE_PRIVATE int sqlite3Fts3MsrIncrNext(
  134654. Fts3Table *, Fts3MultiSegReader *, sqlite3_int64 *, char **, int *);
  134655. SQLITE_PRIVATE int sqlite3Fts3EvalPhrasePoslist(Fts3Cursor *, Fts3Expr *, int iCol, char **);
  134656. SQLITE_PRIVATE int sqlite3Fts3MsrOvfl(Fts3Cursor *, Fts3MultiSegReader *, int *);
  134657. SQLITE_PRIVATE int sqlite3Fts3MsrIncrRestart(Fts3MultiSegReader *pCsr);
  134658. /* fts3_tokenize_vtab.c */
  134659. SQLITE_PRIVATE int sqlite3Fts3InitTok(sqlite3*, Fts3Hash *);
  134660. /* fts3_unicode2.c (functions generated by parsing unicode text files) */
  134661. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  134662. SQLITE_PRIVATE int sqlite3FtsUnicodeFold(int, int);
  134663. SQLITE_PRIVATE int sqlite3FtsUnicodeIsalnum(int);
  134664. SQLITE_PRIVATE int sqlite3FtsUnicodeIsdiacritic(int);
  134665. #endif
  134666. #endif /* !SQLITE_CORE || SQLITE_ENABLE_FTS3 */
  134667. #endif /* _FTSINT_H */
  134668. /************** End of fts3Int.h *********************************************/
  134669. /************** Continuing where we left off in fts3.c ***********************/
  134670. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  134671. #if defined(SQLITE_ENABLE_FTS3) && !defined(SQLITE_CORE)
  134672. # define SQLITE_CORE 1
  134673. #endif
  134674. /* #include <assert.h> */
  134675. /* #include <stdlib.h> */
  134676. /* #include <stddef.h> */
  134677. /* #include <stdio.h> */
  134678. /* #include <string.h> */
  134679. /* #include <stdarg.h> */
  134680. /* #include "fts3.h" */
  134681. #ifndef SQLITE_CORE
  134682. /* # include "sqlite3ext.h" */
  134683. SQLITE_EXTENSION_INIT1
  134684. #endif
  134685. static int fts3EvalNext(Fts3Cursor *pCsr);
  134686. static int fts3EvalStart(Fts3Cursor *pCsr);
  134687. static int fts3TermSegReaderCursor(
  134688. Fts3Cursor *, const char *, int, int, Fts3MultiSegReader **);
  134689. #ifndef SQLITE_AMALGAMATION
  134690. # if defined(SQLITE_DEBUG)
  134691. SQLITE_PRIVATE int sqlite3Fts3Always(int b) { assert( b ); return b; }
  134692. SQLITE_PRIVATE int sqlite3Fts3Never(int b) { assert( !b ); return b; }
  134693. # endif
  134694. #endif
  134695. /*
  134696. ** Write a 64-bit variable-length integer to memory starting at p[0].
  134697. ** The length of data written will be between 1 and FTS3_VARINT_MAX bytes.
  134698. ** The number of bytes written is returned.
  134699. */
  134700. SQLITE_PRIVATE int sqlite3Fts3PutVarint(char *p, sqlite_int64 v){
  134701. unsigned char *q = (unsigned char *) p;
  134702. sqlite_uint64 vu = v;
  134703. do{
  134704. *q++ = (unsigned char) ((vu & 0x7f) | 0x80);
  134705. vu >>= 7;
  134706. }while( vu!=0 );
  134707. q[-1] &= 0x7f; /* turn off high bit in final byte */
  134708. assert( q - (unsigned char *)p <= FTS3_VARINT_MAX );
  134709. return (int) (q - (unsigned char *)p);
  134710. }
  134711. #define GETVARINT_STEP(v, ptr, shift, mask1, mask2, var, ret) \
  134712. v = (v & mask1) | ( (*ptr++) << shift ); \
  134713. if( (v & mask2)==0 ){ var = v; return ret; }
  134714. #define GETVARINT_INIT(v, ptr, shift, mask1, mask2, var, ret) \
  134715. v = (*ptr++); \
  134716. if( (v & mask2)==0 ){ var = v; return ret; }
  134717. /*
  134718. ** Read a 64-bit variable-length integer from memory starting at p[0].
  134719. ** Return the number of bytes read, or 0 on error.
  134720. ** The value is stored in *v.
  134721. */
  134722. SQLITE_PRIVATE int sqlite3Fts3GetVarint(const char *p, sqlite_int64 *v){
  134723. const char *pStart = p;
  134724. u32 a;
  134725. u64 b;
  134726. int shift;
  134727. GETVARINT_INIT(a, p, 0, 0x00, 0x80, *v, 1);
  134728. GETVARINT_STEP(a, p, 7, 0x7F, 0x4000, *v, 2);
  134729. GETVARINT_STEP(a, p, 14, 0x3FFF, 0x200000, *v, 3);
  134730. GETVARINT_STEP(a, p, 21, 0x1FFFFF, 0x10000000, *v, 4);
  134731. b = (a & 0x0FFFFFFF );
  134732. for(shift=28; shift<=63; shift+=7){
  134733. u64 c = *p++;
  134734. b += (c&0x7F) << shift;
  134735. if( (c & 0x80)==0 ) break;
  134736. }
  134737. *v = b;
  134738. return (int)(p - pStart);
  134739. }
  134740. /*
  134741. ** Similar to sqlite3Fts3GetVarint(), except that the output is truncated to a
  134742. ** 32-bit integer before it is returned.
  134743. */
  134744. SQLITE_PRIVATE int sqlite3Fts3GetVarint32(const char *p, int *pi){
  134745. u32 a;
  134746. #ifndef fts3GetVarint32
  134747. GETVARINT_INIT(a, p, 0, 0x00, 0x80, *pi, 1);
  134748. #else
  134749. a = (*p++);
  134750. assert( a & 0x80 );
  134751. #endif
  134752. GETVARINT_STEP(a, p, 7, 0x7F, 0x4000, *pi, 2);
  134753. GETVARINT_STEP(a, p, 14, 0x3FFF, 0x200000, *pi, 3);
  134754. GETVARINT_STEP(a, p, 21, 0x1FFFFF, 0x10000000, *pi, 4);
  134755. a = (a & 0x0FFFFFFF );
  134756. *pi = (int)(a | ((u32)(*p & 0x0F) << 28));
  134757. return 5;
  134758. }
  134759. /*
  134760. ** Return the number of bytes required to encode v as a varint
  134761. */
  134762. SQLITE_PRIVATE int sqlite3Fts3VarintLen(sqlite3_uint64 v){
  134763. int i = 0;
  134764. do{
  134765. i++;
  134766. v >>= 7;
  134767. }while( v!=0 );
  134768. return i;
  134769. }
  134770. /*
  134771. ** Convert an SQL-style quoted string into a normal string by removing
  134772. ** the quote characters. The conversion is done in-place. If the
  134773. ** input does not begin with a quote character, then this routine
  134774. ** is a no-op.
  134775. **
  134776. ** Examples:
  134777. **
  134778. ** "abc" becomes abc
  134779. ** 'xyz' becomes xyz
  134780. ** [pqr] becomes pqr
  134781. ** `mno` becomes mno
  134782. **
  134783. */
  134784. SQLITE_PRIVATE void sqlite3Fts3Dequote(char *z){
  134785. char quote; /* Quote character (if any ) */
  134786. quote = z[0];
  134787. if( quote=='[' || quote=='\'' || quote=='"' || quote=='`' ){
  134788. int iIn = 1; /* Index of next byte to read from input */
  134789. int iOut = 0; /* Index of next byte to write to output */
  134790. /* If the first byte was a '[', then the close-quote character is a ']' */
  134791. if( quote=='[' ) quote = ']';
  134792. while( z[iIn] ){
  134793. if( z[iIn]==quote ){
  134794. if( z[iIn+1]!=quote ) break;
  134795. z[iOut++] = quote;
  134796. iIn += 2;
  134797. }else{
  134798. z[iOut++] = z[iIn++];
  134799. }
  134800. }
  134801. z[iOut] = '\0';
  134802. }
  134803. }
  134804. /*
  134805. ** Read a single varint from the doclist at *pp and advance *pp to point
  134806. ** to the first byte past the end of the varint. Add the value of the varint
  134807. ** to *pVal.
  134808. */
  134809. static void fts3GetDeltaVarint(char **pp, sqlite3_int64 *pVal){
  134810. sqlite3_int64 iVal;
  134811. *pp += sqlite3Fts3GetVarint(*pp, &iVal);
  134812. *pVal += iVal;
  134813. }
  134814. /*
  134815. ** When this function is called, *pp points to the first byte following a
  134816. ** varint that is part of a doclist (or position-list, or any other list
  134817. ** of varints). This function moves *pp to point to the start of that varint,
  134818. ** and sets *pVal by the varint value.
  134819. **
  134820. ** Argument pStart points to the first byte of the doclist that the
  134821. ** varint is part of.
  134822. */
  134823. static void fts3GetReverseVarint(
  134824. char **pp,
  134825. char *pStart,
  134826. sqlite3_int64 *pVal
  134827. ){
  134828. sqlite3_int64 iVal;
  134829. char *p;
  134830. /* Pointer p now points at the first byte past the varint we are
  134831. ** interested in. So, unless the doclist is corrupt, the 0x80 bit is
  134832. ** clear on character p[-1]. */
  134833. for(p = (*pp)-2; p>=pStart && *p&0x80; p--);
  134834. p++;
  134835. *pp = p;
  134836. sqlite3Fts3GetVarint(p, &iVal);
  134837. *pVal = iVal;
  134838. }
  134839. /*
  134840. ** The xDisconnect() virtual table method.
  134841. */
  134842. static int fts3DisconnectMethod(sqlite3_vtab *pVtab){
  134843. Fts3Table *p = (Fts3Table *)pVtab;
  134844. int i;
  134845. assert( p->nPendingData==0 );
  134846. assert( p->pSegments==0 );
  134847. /* Free any prepared statements held */
  134848. for(i=0; i<SizeofArray(p->aStmt); i++){
  134849. sqlite3_finalize(p->aStmt[i]);
  134850. }
  134851. sqlite3_free(p->zSegmentsTbl);
  134852. sqlite3_free(p->zReadExprlist);
  134853. sqlite3_free(p->zWriteExprlist);
  134854. sqlite3_free(p->zContentTbl);
  134855. sqlite3_free(p->zLanguageid);
  134856. /* Invoke the tokenizer destructor to free the tokenizer. */
  134857. p->pTokenizer->pModule->xDestroy(p->pTokenizer);
  134858. sqlite3_free(p);
  134859. return SQLITE_OK;
  134860. }
  134861. /*
  134862. ** Write an error message into *pzErr
  134863. */
  134864. SQLITE_PRIVATE void sqlite3Fts3ErrMsg(char **pzErr, const char *zFormat, ...){
  134865. va_list ap;
  134866. sqlite3_free(*pzErr);
  134867. va_start(ap, zFormat);
  134868. *pzErr = sqlite3_vmprintf(zFormat, ap);
  134869. va_end(ap);
  134870. }
  134871. /*
  134872. ** Construct one or more SQL statements from the format string given
  134873. ** and then evaluate those statements. The success code is written
  134874. ** into *pRc.
  134875. **
  134876. ** If *pRc is initially non-zero then this routine is a no-op.
  134877. */
  134878. static void fts3DbExec(
  134879. int *pRc, /* Success code */
  134880. sqlite3 *db, /* Database in which to run SQL */
  134881. const char *zFormat, /* Format string for SQL */
  134882. ... /* Arguments to the format string */
  134883. ){
  134884. va_list ap;
  134885. char *zSql;
  134886. if( *pRc ) return;
  134887. va_start(ap, zFormat);
  134888. zSql = sqlite3_vmprintf(zFormat, ap);
  134889. va_end(ap);
  134890. if( zSql==0 ){
  134891. *pRc = SQLITE_NOMEM;
  134892. }else{
  134893. *pRc = sqlite3_exec(db, zSql, 0, 0, 0);
  134894. sqlite3_free(zSql);
  134895. }
  134896. }
  134897. /*
  134898. ** The xDestroy() virtual table method.
  134899. */
  134900. static int fts3DestroyMethod(sqlite3_vtab *pVtab){
  134901. Fts3Table *p = (Fts3Table *)pVtab;
  134902. int rc = SQLITE_OK; /* Return code */
  134903. const char *zDb = p->zDb; /* Name of database (e.g. "main", "temp") */
  134904. sqlite3 *db = p->db; /* Database handle */
  134905. /* Drop the shadow tables */
  134906. if( p->zContentTbl==0 ){
  134907. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_content'", zDb, p->zName);
  134908. }
  134909. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_segments'", zDb,p->zName);
  134910. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_segdir'", zDb, p->zName);
  134911. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_docsize'", zDb, p->zName);
  134912. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_stat'", zDb, p->zName);
  134913. /* If everything has worked, invoke fts3DisconnectMethod() to free the
  134914. ** memory associated with the Fts3Table structure and return SQLITE_OK.
  134915. ** Otherwise, return an SQLite error code.
  134916. */
  134917. return (rc==SQLITE_OK ? fts3DisconnectMethod(pVtab) : rc);
  134918. }
  134919. /*
  134920. ** Invoke sqlite3_declare_vtab() to declare the schema for the FTS3 table
  134921. ** passed as the first argument. This is done as part of the xConnect()
  134922. ** and xCreate() methods.
  134923. **
  134924. ** If *pRc is non-zero when this function is called, it is a no-op.
  134925. ** Otherwise, if an error occurs, an SQLite error code is stored in *pRc
  134926. ** before returning.
  134927. */
  134928. static void fts3DeclareVtab(int *pRc, Fts3Table *p){
  134929. if( *pRc==SQLITE_OK ){
  134930. int i; /* Iterator variable */
  134931. int rc; /* Return code */
  134932. char *zSql; /* SQL statement passed to declare_vtab() */
  134933. char *zCols; /* List of user defined columns */
  134934. const char *zLanguageid;
  134935. zLanguageid = (p->zLanguageid ? p->zLanguageid : "__langid");
  134936. sqlite3_vtab_config(p->db, SQLITE_VTAB_CONSTRAINT_SUPPORT, 1);
  134937. /* Create a list of user columns for the virtual table */
  134938. zCols = sqlite3_mprintf("%Q, ", p->azColumn[0]);
  134939. for(i=1; zCols && i<p->nColumn; i++){
  134940. zCols = sqlite3_mprintf("%z%Q, ", zCols, p->azColumn[i]);
  134941. }
  134942. /* Create the whole "CREATE TABLE" statement to pass to SQLite */
  134943. zSql = sqlite3_mprintf(
  134944. "CREATE TABLE x(%s %Q HIDDEN, docid HIDDEN, %Q HIDDEN)",
  134945. zCols, p->zName, zLanguageid
  134946. );
  134947. if( !zCols || !zSql ){
  134948. rc = SQLITE_NOMEM;
  134949. }else{
  134950. rc = sqlite3_declare_vtab(p->db, zSql);
  134951. }
  134952. sqlite3_free(zSql);
  134953. sqlite3_free(zCols);
  134954. *pRc = rc;
  134955. }
  134956. }
  134957. /*
  134958. ** Create the %_stat table if it does not already exist.
  134959. */
  134960. SQLITE_PRIVATE void sqlite3Fts3CreateStatTable(int *pRc, Fts3Table *p){
  134961. fts3DbExec(pRc, p->db,
  134962. "CREATE TABLE IF NOT EXISTS %Q.'%q_stat'"
  134963. "(id INTEGER PRIMARY KEY, value BLOB);",
  134964. p->zDb, p->zName
  134965. );
  134966. if( (*pRc)==SQLITE_OK ) p->bHasStat = 1;
  134967. }
  134968. /*
  134969. ** Create the backing store tables (%_content, %_segments and %_segdir)
  134970. ** required by the FTS3 table passed as the only argument. This is done
  134971. ** as part of the vtab xCreate() method.
  134972. **
  134973. ** If the p->bHasDocsize boolean is true (indicating that this is an
  134974. ** FTS4 table, not an FTS3 table) then also create the %_docsize and
  134975. ** %_stat tables required by FTS4.
  134976. */
  134977. static int fts3CreateTables(Fts3Table *p){
  134978. int rc = SQLITE_OK; /* Return code */
  134979. int i; /* Iterator variable */
  134980. sqlite3 *db = p->db; /* The database connection */
  134981. if( p->zContentTbl==0 ){
  134982. const char *zLanguageid = p->zLanguageid;
  134983. char *zContentCols; /* Columns of %_content table */
  134984. /* Create a list of user columns for the content table */
  134985. zContentCols = sqlite3_mprintf("docid INTEGER PRIMARY KEY");
  134986. for(i=0; zContentCols && i<p->nColumn; i++){
  134987. char *z = p->azColumn[i];
  134988. zContentCols = sqlite3_mprintf("%z, 'c%d%q'", zContentCols, i, z);
  134989. }
  134990. if( zLanguageid && zContentCols ){
  134991. zContentCols = sqlite3_mprintf("%z, langid", zContentCols, zLanguageid);
  134992. }
  134993. if( zContentCols==0 ) rc = SQLITE_NOMEM;
  134994. /* Create the content table */
  134995. fts3DbExec(&rc, db,
  134996. "CREATE TABLE %Q.'%q_content'(%s)",
  134997. p->zDb, p->zName, zContentCols
  134998. );
  134999. sqlite3_free(zContentCols);
  135000. }
  135001. /* Create other tables */
  135002. fts3DbExec(&rc, db,
  135003. "CREATE TABLE %Q.'%q_segments'(blockid INTEGER PRIMARY KEY, block BLOB);",
  135004. p->zDb, p->zName
  135005. );
  135006. fts3DbExec(&rc, db,
  135007. "CREATE TABLE %Q.'%q_segdir'("
  135008. "level INTEGER,"
  135009. "idx INTEGER,"
  135010. "start_block INTEGER,"
  135011. "leaves_end_block INTEGER,"
  135012. "end_block INTEGER,"
  135013. "root BLOB,"
  135014. "PRIMARY KEY(level, idx)"
  135015. ");",
  135016. p->zDb, p->zName
  135017. );
  135018. if( p->bHasDocsize ){
  135019. fts3DbExec(&rc, db,
  135020. "CREATE TABLE %Q.'%q_docsize'(docid INTEGER PRIMARY KEY, size BLOB);",
  135021. p->zDb, p->zName
  135022. );
  135023. }
  135024. assert( p->bHasStat==p->bFts4 );
  135025. if( p->bHasStat ){
  135026. sqlite3Fts3CreateStatTable(&rc, p);
  135027. }
  135028. return rc;
  135029. }
  135030. /*
  135031. ** Store the current database page-size in bytes in p->nPgsz.
  135032. **
  135033. ** If *pRc is non-zero when this function is called, it is a no-op.
  135034. ** Otherwise, if an error occurs, an SQLite error code is stored in *pRc
  135035. ** before returning.
  135036. */
  135037. static void fts3DatabasePageSize(int *pRc, Fts3Table *p){
  135038. if( *pRc==SQLITE_OK ){
  135039. int rc; /* Return code */
  135040. char *zSql; /* SQL text "PRAGMA %Q.page_size" */
  135041. sqlite3_stmt *pStmt; /* Compiled "PRAGMA %Q.page_size" statement */
  135042. zSql = sqlite3_mprintf("PRAGMA %Q.page_size", p->zDb);
  135043. if( !zSql ){
  135044. rc = SQLITE_NOMEM;
  135045. }else{
  135046. rc = sqlite3_prepare(p->db, zSql, -1, &pStmt, 0);
  135047. if( rc==SQLITE_OK ){
  135048. sqlite3_step(pStmt);
  135049. p->nPgsz = sqlite3_column_int(pStmt, 0);
  135050. rc = sqlite3_finalize(pStmt);
  135051. }else if( rc==SQLITE_AUTH ){
  135052. p->nPgsz = 1024;
  135053. rc = SQLITE_OK;
  135054. }
  135055. }
  135056. assert( p->nPgsz>0 || rc!=SQLITE_OK );
  135057. sqlite3_free(zSql);
  135058. *pRc = rc;
  135059. }
  135060. }
  135061. /*
  135062. ** "Special" FTS4 arguments are column specifications of the following form:
  135063. **
  135064. ** <key> = <value>
  135065. **
  135066. ** There may not be whitespace surrounding the "=" character. The <value>
  135067. ** term may be quoted, but the <key> may not.
  135068. */
  135069. static int fts3IsSpecialColumn(
  135070. const char *z,
  135071. int *pnKey,
  135072. char **pzValue
  135073. ){
  135074. char *zValue;
  135075. const char *zCsr = z;
  135076. while( *zCsr!='=' ){
  135077. if( *zCsr=='\0' ) return 0;
  135078. zCsr++;
  135079. }
  135080. *pnKey = (int)(zCsr-z);
  135081. zValue = sqlite3_mprintf("%s", &zCsr[1]);
  135082. if( zValue ){
  135083. sqlite3Fts3Dequote(zValue);
  135084. }
  135085. *pzValue = zValue;
  135086. return 1;
  135087. }
  135088. /*
  135089. ** Append the output of a printf() style formatting to an existing string.
  135090. */
  135091. static void fts3Appendf(
  135092. int *pRc, /* IN/OUT: Error code */
  135093. char **pz, /* IN/OUT: Pointer to string buffer */
  135094. const char *zFormat, /* Printf format string to append */
  135095. ... /* Arguments for printf format string */
  135096. ){
  135097. if( *pRc==SQLITE_OK ){
  135098. va_list ap;
  135099. char *z;
  135100. va_start(ap, zFormat);
  135101. z = sqlite3_vmprintf(zFormat, ap);
  135102. va_end(ap);
  135103. if( z && *pz ){
  135104. char *z2 = sqlite3_mprintf("%s%s", *pz, z);
  135105. sqlite3_free(z);
  135106. z = z2;
  135107. }
  135108. if( z==0 ) *pRc = SQLITE_NOMEM;
  135109. sqlite3_free(*pz);
  135110. *pz = z;
  135111. }
  135112. }
  135113. /*
  135114. ** Return a copy of input string zInput enclosed in double-quotes (") and
  135115. ** with all double quote characters escaped. For example:
  135116. **
  135117. ** fts3QuoteId("un \"zip\"") -> "un \"\"zip\"\""
  135118. **
  135119. ** The pointer returned points to memory obtained from sqlite3_malloc(). It
  135120. ** is the callers responsibility to call sqlite3_free() to release this
  135121. ** memory.
  135122. */
  135123. static char *fts3QuoteId(char const *zInput){
  135124. int nRet;
  135125. char *zRet;
  135126. nRet = 2 + (int)strlen(zInput)*2 + 1;
  135127. zRet = sqlite3_malloc(nRet);
  135128. if( zRet ){
  135129. int i;
  135130. char *z = zRet;
  135131. *(z++) = '"';
  135132. for(i=0; zInput[i]; i++){
  135133. if( zInput[i]=='"' ) *(z++) = '"';
  135134. *(z++) = zInput[i];
  135135. }
  135136. *(z++) = '"';
  135137. *(z++) = '\0';
  135138. }
  135139. return zRet;
  135140. }
  135141. /*
  135142. ** Return a list of comma separated SQL expressions and a FROM clause that
  135143. ** could be used in a SELECT statement such as the following:
  135144. **
  135145. ** SELECT <list of expressions> FROM %_content AS x ...
  135146. **
  135147. ** to return the docid, followed by each column of text data in order
  135148. ** from left to write. If parameter zFunc is not NULL, then instead of
  135149. ** being returned directly each column of text data is passed to an SQL
  135150. ** function named zFunc first. For example, if zFunc is "unzip" and the
  135151. ** table has the three user-defined columns "a", "b", and "c", the following
  135152. ** string is returned:
  135153. **
  135154. ** "docid, unzip(x.'a'), unzip(x.'b'), unzip(x.'c') FROM %_content AS x"
  135155. **
  135156. ** The pointer returned points to a buffer allocated by sqlite3_malloc(). It
  135157. ** is the responsibility of the caller to eventually free it.
  135158. **
  135159. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op (and
  135160. ** a NULL pointer is returned). Otherwise, if an OOM error is encountered
  135161. ** by this function, NULL is returned and *pRc is set to SQLITE_NOMEM. If
  135162. ** no error occurs, *pRc is left unmodified.
  135163. */
  135164. static char *fts3ReadExprList(Fts3Table *p, const char *zFunc, int *pRc){
  135165. char *zRet = 0;
  135166. char *zFree = 0;
  135167. char *zFunction;
  135168. int i;
  135169. if( p->zContentTbl==0 ){
  135170. if( !zFunc ){
  135171. zFunction = "";
  135172. }else{
  135173. zFree = zFunction = fts3QuoteId(zFunc);
  135174. }
  135175. fts3Appendf(pRc, &zRet, "docid");
  135176. for(i=0; i<p->nColumn; i++){
  135177. fts3Appendf(pRc, &zRet, ",%s(x.'c%d%q')", zFunction, i, p->azColumn[i]);
  135178. }
  135179. if( p->zLanguageid ){
  135180. fts3Appendf(pRc, &zRet, ", x.%Q", "langid");
  135181. }
  135182. sqlite3_free(zFree);
  135183. }else{
  135184. fts3Appendf(pRc, &zRet, "rowid");
  135185. for(i=0; i<p->nColumn; i++){
  135186. fts3Appendf(pRc, &zRet, ", x.'%q'", p->azColumn[i]);
  135187. }
  135188. if( p->zLanguageid ){
  135189. fts3Appendf(pRc, &zRet, ", x.%Q", p->zLanguageid);
  135190. }
  135191. }
  135192. fts3Appendf(pRc, &zRet, " FROM '%q'.'%q%s' AS x",
  135193. p->zDb,
  135194. (p->zContentTbl ? p->zContentTbl : p->zName),
  135195. (p->zContentTbl ? "" : "_content")
  135196. );
  135197. return zRet;
  135198. }
  135199. /*
  135200. ** Return a list of N comma separated question marks, where N is the number
  135201. ** of columns in the %_content table (one for the docid plus one for each
  135202. ** user-defined text column).
  135203. **
  135204. ** If argument zFunc is not NULL, then all but the first question mark
  135205. ** is preceded by zFunc and an open bracket, and followed by a closed
  135206. ** bracket. For example, if zFunc is "zip" and the FTS3 table has three
  135207. ** user-defined text columns, the following string is returned:
  135208. **
  135209. ** "?, zip(?), zip(?), zip(?)"
  135210. **
  135211. ** The pointer returned points to a buffer allocated by sqlite3_malloc(). It
  135212. ** is the responsibility of the caller to eventually free it.
  135213. **
  135214. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op (and
  135215. ** a NULL pointer is returned). Otherwise, if an OOM error is encountered
  135216. ** by this function, NULL is returned and *pRc is set to SQLITE_NOMEM. If
  135217. ** no error occurs, *pRc is left unmodified.
  135218. */
  135219. static char *fts3WriteExprList(Fts3Table *p, const char *zFunc, int *pRc){
  135220. char *zRet = 0;
  135221. char *zFree = 0;
  135222. char *zFunction;
  135223. int i;
  135224. if( !zFunc ){
  135225. zFunction = "";
  135226. }else{
  135227. zFree = zFunction = fts3QuoteId(zFunc);
  135228. }
  135229. fts3Appendf(pRc, &zRet, "?");
  135230. for(i=0; i<p->nColumn; i++){
  135231. fts3Appendf(pRc, &zRet, ",%s(?)", zFunction);
  135232. }
  135233. if( p->zLanguageid ){
  135234. fts3Appendf(pRc, &zRet, ", ?");
  135235. }
  135236. sqlite3_free(zFree);
  135237. return zRet;
  135238. }
  135239. /*
  135240. ** This function interprets the string at (*pp) as a non-negative integer
  135241. ** value. It reads the integer and sets *pnOut to the value read, then
  135242. ** sets *pp to point to the byte immediately following the last byte of
  135243. ** the integer value.
  135244. **
  135245. ** Only decimal digits ('0'..'9') may be part of an integer value.
  135246. **
  135247. ** If *pp does not being with a decimal digit SQLITE_ERROR is returned and
  135248. ** the output value undefined. Otherwise SQLITE_OK is returned.
  135249. **
  135250. ** This function is used when parsing the "prefix=" FTS4 parameter.
  135251. */
  135252. static int fts3GobbleInt(const char **pp, int *pnOut){
  135253. const int MAX_NPREFIX = 10000000;
  135254. const char *p; /* Iterator pointer */
  135255. int nInt = 0; /* Output value */
  135256. for(p=*pp; p[0]>='0' && p[0]<='9'; p++){
  135257. nInt = nInt * 10 + (p[0] - '0');
  135258. if( nInt>MAX_NPREFIX ){
  135259. nInt = 0;
  135260. break;
  135261. }
  135262. }
  135263. if( p==*pp ) return SQLITE_ERROR;
  135264. *pnOut = nInt;
  135265. *pp = p;
  135266. return SQLITE_OK;
  135267. }
  135268. /*
  135269. ** This function is called to allocate an array of Fts3Index structures
  135270. ** representing the indexes maintained by the current FTS table. FTS tables
  135271. ** always maintain the main "terms" index, but may also maintain one or
  135272. ** more "prefix" indexes, depending on the value of the "prefix=" parameter
  135273. ** (if any) specified as part of the CREATE VIRTUAL TABLE statement.
  135274. **
  135275. ** Argument zParam is passed the value of the "prefix=" option if one was
  135276. ** specified, or NULL otherwise.
  135277. **
  135278. ** If no error occurs, SQLITE_OK is returned and *apIndex set to point to
  135279. ** the allocated array. *pnIndex is set to the number of elements in the
  135280. ** array. If an error does occur, an SQLite error code is returned.
  135281. **
  135282. ** Regardless of whether or not an error is returned, it is the responsibility
  135283. ** of the caller to call sqlite3_free() on the output array to free it.
  135284. */
  135285. static int fts3PrefixParameter(
  135286. const char *zParam, /* ABC in prefix=ABC parameter to parse */
  135287. int *pnIndex, /* OUT: size of *apIndex[] array */
  135288. struct Fts3Index **apIndex /* OUT: Array of indexes for this table */
  135289. ){
  135290. struct Fts3Index *aIndex; /* Allocated array */
  135291. int nIndex = 1; /* Number of entries in array */
  135292. if( zParam && zParam[0] ){
  135293. const char *p;
  135294. nIndex++;
  135295. for(p=zParam; *p; p++){
  135296. if( *p==',' ) nIndex++;
  135297. }
  135298. }
  135299. aIndex = sqlite3_malloc(sizeof(struct Fts3Index) * nIndex);
  135300. *apIndex = aIndex;
  135301. if( !aIndex ){
  135302. return SQLITE_NOMEM;
  135303. }
  135304. memset(aIndex, 0, sizeof(struct Fts3Index) * nIndex);
  135305. if( zParam ){
  135306. const char *p = zParam;
  135307. int i;
  135308. for(i=1; i<nIndex; i++){
  135309. int nPrefix = 0;
  135310. if( fts3GobbleInt(&p, &nPrefix) ) return SQLITE_ERROR;
  135311. assert( nPrefix>=0 );
  135312. if( nPrefix==0 ){
  135313. nIndex--;
  135314. i--;
  135315. }else{
  135316. aIndex[i].nPrefix = nPrefix;
  135317. }
  135318. p++;
  135319. }
  135320. }
  135321. *pnIndex = nIndex;
  135322. return SQLITE_OK;
  135323. }
  135324. /*
  135325. ** This function is called when initializing an FTS4 table that uses the
  135326. ** content=xxx option. It determines the number of and names of the columns
  135327. ** of the new FTS4 table.
  135328. **
  135329. ** The third argument passed to this function is the value passed to the
  135330. ** config=xxx option (i.e. "xxx"). This function queries the database for
  135331. ** a table of that name. If found, the output variables are populated
  135332. ** as follows:
  135333. **
  135334. ** *pnCol: Set to the number of columns table xxx has,
  135335. **
  135336. ** *pnStr: Set to the total amount of space required to store a copy
  135337. ** of each columns name, including the nul-terminator.
  135338. **
  135339. ** *pazCol: Set to point to an array of *pnCol strings. Each string is
  135340. ** the name of the corresponding column in table xxx. The array
  135341. ** and its contents are allocated using a single allocation. It
  135342. ** is the responsibility of the caller to free this allocation
  135343. ** by eventually passing the *pazCol value to sqlite3_free().
  135344. **
  135345. ** If the table cannot be found, an error code is returned and the output
  135346. ** variables are undefined. Or, if an OOM is encountered, SQLITE_NOMEM is
  135347. ** returned (and the output variables are undefined).
  135348. */
  135349. static int fts3ContentColumns(
  135350. sqlite3 *db, /* Database handle */
  135351. const char *zDb, /* Name of db (i.e. "main", "temp" etc.) */
  135352. const char *zTbl, /* Name of content table */
  135353. const char ***pazCol, /* OUT: Malloc'd array of column names */
  135354. int *pnCol, /* OUT: Size of array *pazCol */
  135355. int *pnStr, /* OUT: Bytes of string content */
  135356. char **pzErr /* OUT: error message */
  135357. ){
  135358. int rc = SQLITE_OK; /* Return code */
  135359. char *zSql; /* "SELECT *" statement on zTbl */
  135360. sqlite3_stmt *pStmt = 0; /* Compiled version of zSql */
  135361. zSql = sqlite3_mprintf("SELECT * FROM %Q.%Q", zDb, zTbl);
  135362. if( !zSql ){
  135363. rc = SQLITE_NOMEM;
  135364. }else{
  135365. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  135366. if( rc!=SQLITE_OK ){
  135367. sqlite3Fts3ErrMsg(pzErr, "%s", sqlite3_errmsg(db));
  135368. }
  135369. }
  135370. sqlite3_free(zSql);
  135371. if( rc==SQLITE_OK ){
  135372. const char **azCol; /* Output array */
  135373. int nStr = 0; /* Size of all column names (incl. 0x00) */
  135374. int nCol; /* Number of table columns */
  135375. int i; /* Used to iterate through columns */
  135376. /* Loop through the returned columns. Set nStr to the number of bytes of
  135377. ** space required to store a copy of each column name, including the
  135378. ** nul-terminator byte. */
  135379. nCol = sqlite3_column_count(pStmt);
  135380. for(i=0; i<nCol; i++){
  135381. const char *zCol = sqlite3_column_name(pStmt, i);
  135382. nStr += (int)strlen(zCol) + 1;
  135383. }
  135384. /* Allocate and populate the array to return. */
  135385. azCol = (const char **)sqlite3_malloc(sizeof(char *) * nCol + nStr);
  135386. if( azCol==0 ){
  135387. rc = SQLITE_NOMEM;
  135388. }else{
  135389. char *p = (char *)&azCol[nCol];
  135390. for(i=0; i<nCol; i++){
  135391. const char *zCol = sqlite3_column_name(pStmt, i);
  135392. int n = (int)strlen(zCol)+1;
  135393. memcpy(p, zCol, n);
  135394. azCol[i] = p;
  135395. p += n;
  135396. }
  135397. }
  135398. sqlite3_finalize(pStmt);
  135399. /* Set the output variables. */
  135400. *pnCol = nCol;
  135401. *pnStr = nStr;
  135402. *pazCol = azCol;
  135403. }
  135404. return rc;
  135405. }
  135406. /*
  135407. ** This function is the implementation of both the xConnect and xCreate
  135408. ** methods of the FTS3 virtual table.
  135409. **
  135410. ** The argv[] array contains the following:
  135411. **
  135412. ** argv[0] -> module name ("fts3" or "fts4")
  135413. ** argv[1] -> database name
  135414. ** argv[2] -> table name
  135415. ** argv[...] -> "column name" and other module argument fields.
  135416. */
  135417. static int fts3InitVtab(
  135418. int isCreate, /* True for xCreate, false for xConnect */
  135419. sqlite3 *db, /* The SQLite database connection */
  135420. void *pAux, /* Hash table containing tokenizers */
  135421. int argc, /* Number of elements in argv array */
  135422. const char * const *argv, /* xCreate/xConnect argument array */
  135423. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  135424. char **pzErr /* Write any error message here */
  135425. ){
  135426. Fts3Hash *pHash = (Fts3Hash *)pAux;
  135427. Fts3Table *p = 0; /* Pointer to allocated vtab */
  135428. int rc = SQLITE_OK; /* Return code */
  135429. int i; /* Iterator variable */
  135430. int nByte; /* Size of allocation used for *p */
  135431. int iCol; /* Column index */
  135432. int nString = 0; /* Bytes required to hold all column names */
  135433. int nCol = 0; /* Number of columns in the FTS table */
  135434. char *zCsr; /* Space for holding column names */
  135435. int nDb; /* Bytes required to hold database name */
  135436. int nName; /* Bytes required to hold table name */
  135437. int isFts4 = (argv[0][3]=='4'); /* True for FTS4, false for FTS3 */
  135438. const char **aCol; /* Array of column names */
  135439. sqlite3_tokenizer *pTokenizer = 0; /* Tokenizer for this table */
  135440. int nIndex = 0; /* Size of aIndex[] array */
  135441. struct Fts3Index *aIndex = 0; /* Array of indexes for this table */
  135442. /* The results of parsing supported FTS4 key=value options: */
  135443. int bNoDocsize = 0; /* True to omit %_docsize table */
  135444. int bDescIdx = 0; /* True to store descending indexes */
  135445. char *zPrefix = 0; /* Prefix parameter value (or NULL) */
  135446. char *zCompress = 0; /* compress=? parameter (or NULL) */
  135447. char *zUncompress = 0; /* uncompress=? parameter (or NULL) */
  135448. char *zContent = 0; /* content=? parameter (or NULL) */
  135449. char *zLanguageid = 0; /* languageid=? parameter (or NULL) */
  135450. char **azNotindexed = 0; /* The set of notindexed= columns */
  135451. int nNotindexed = 0; /* Size of azNotindexed[] array */
  135452. assert( strlen(argv[0])==4 );
  135453. assert( (sqlite3_strnicmp(argv[0], "fts4", 4)==0 && isFts4)
  135454. || (sqlite3_strnicmp(argv[0], "fts3", 4)==0 && !isFts4)
  135455. );
  135456. nDb = (int)strlen(argv[1]) + 1;
  135457. nName = (int)strlen(argv[2]) + 1;
  135458. nByte = sizeof(const char *) * (argc-2);
  135459. aCol = (const char **)sqlite3_malloc(nByte);
  135460. if( aCol ){
  135461. memset((void*)aCol, 0, nByte);
  135462. azNotindexed = (char **)sqlite3_malloc(nByte);
  135463. }
  135464. if( azNotindexed ){
  135465. memset(azNotindexed, 0, nByte);
  135466. }
  135467. if( !aCol || !azNotindexed ){
  135468. rc = SQLITE_NOMEM;
  135469. goto fts3_init_out;
  135470. }
  135471. /* Loop through all of the arguments passed by the user to the FTS3/4
  135472. ** module (i.e. all the column names and special arguments). This loop
  135473. ** does the following:
  135474. **
  135475. ** + Figures out the number of columns the FTSX table will have, and
  135476. ** the number of bytes of space that must be allocated to store copies
  135477. ** of the column names.
  135478. **
  135479. ** + If there is a tokenizer specification included in the arguments,
  135480. ** initializes the tokenizer pTokenizer.
  135481. */
  135482. for(i=3; rc==SQLITE_OK && i<argc; i++){
  135483. char const *z = argv[i];
  135484. int nKey;
  135485. char *zVal;
  135486. /* Check if this is a tokenizer specification */
  135487. if( !pTokenizer
  135488. && strlen(z)>8
  135489. && 0==sqlite3_strnicmp(z, "tokenize", 8)
  135490. && 0==sqlite3Fts3IsIdChar(z[8])
  135491. ){
  135492. rc = sqlite3Fts3InitTokenizer(pHash, &z[9], &pTokenizer, pzErr);
  135493. }
  135494. /* Check if it is an FTS4 special argument. */
  135495. else if( isFts4 && fts3IsSpecialColumn(z, &nKey, &zVal) ){
  135496. struct Fts4Option {
  135497. const char *zOpt;
  135498. int nOpt;
  135499. } aFts4Opt[] = {
  135500. { "matchinfo", 9 }, /* 0 -> MATCHINFO */
  135501. { "prefix", 6 }, /* 1 -> PREFIX */
  135502. { "compress", 8 }, /* 2 -> COMPRESS */
  135503. { "uncompress", 10 }, /* 3 -> UNCOMPRESS */
  135504. { "order", 5 }, /* 4 -> ORDER */
  135505. { "content", 7 }, /* 5 -> CONTENT */
  135506. { "languageid", 10 }, /* 6 -> LANGUAGEID */
  135507. { "notindexed", 10 } /* 7 -> NOTINDEXED */
  135508. };
  135509. int iOpt;
  135510. if( !zVal ){
  135511. rc = SQLITE_NOMEM;
  135512. }else{
  135513. for(iOpt=0; iOpt<SizeofArray(aFts4Opt); iOpt++){
  135514. struct Fts4Option *pOp = &aFts4Opt[iOpt];
  135515. if( nKey==pOp->nOpt && !sqlite3_strnicmp(z, pOp->zOpt, pOp->nOpt) ){
  135516. break;
  135517. }
  135518. }
  135519. if( iOpt==SizeofArray(aFts4Opt) ){
  135520. sqlite3Fts3ErrMsg(pzErr, "unrecognized parameter: %s", z);
  135521. rc = SQLITE_ERROR;
  135522. }else{
  135523. switch( iOpt ){
  135524. case 0: /* MATCHINFO */
  135525. if( strlen(zVal)!=4 || sqlite3_strnicmp(zVal, "fts3", 4) ){
  135526. sqlite3Fts3ErrMsg(pzErr, "unrecognized matchinfo: %s", zVal);
  135527. rc = SQLITE_ERROR;
  135528. }
  135529. bNoDocsize = 1;
  135530. break;
  135531. case 1: /* PREFIX */
  135532. sqlite3_free(zPrefix);
  135533. zPrefix = zVal;
  135534. zVal = 0;
  135535. break;
  135536. case 2: /* COMPRESS */
  135537. sqlite3_free(zCompress);
  135538. zCompress = zVal;
  135539. zVal = 0;
  135540. break;
  135541. case 3: /* UNCOMPRESS */
  135542. sqlite3_free(zUncompress);
  135543. zUncompress = zVal;
  135544. zVal = 0;
  135545. break;
  135546. case 4: /* ORDER */
  135547. if( (strlen(zVal)!=3 || sqlite3_strnicmp(zVal, "asc", 3))
  135548. && (strlen(zVal)!=4 || sqlite3_strnicmp(zVal, "desc", 4))
  135549. ){
  135550. sqlite3Fts3ErrMsg(pzErr, "unrecognized order: %s", zVal);
  135551. rc = SQLITE_ERROR;
  135552. }
  135553. bDescIdx = (zVal[0]=='d' || zVal[0]=='D');
  135554. break;
  135555. case 5: /* CONTENT */
  135556. sqlite3_free(zContent);
  135557. zContent = zVal;
  135558. zVal = 0;
  135559. break;
  135560. case 6: /* LANGUAGEID */
  135561. assert( iOpt==6 );
  135562. sqlite3_free(zLanguageid);
  135563. zLanguageid = zVal;
  135564. zVal = 0;
  135565. break;
  135566. case 7: /* NOTINDEXED */
  135567. azNotindexed[nNotindexed++] = zVal;
  135568. zVal = 0;
  135569. break;
  135570. }
  135571. }
  135572. sqlite3_free(zVal);
  135573. }
  135574. }
  135575. /* Otherwise, the argument is a column name. */
  135576. else {
  135577. nString += (int)(strlen(z) + 1);
  135578. aCol[nCol++] = z;
  135579. }
  135580. }
  135581. /* If a content=xxx option was specified, the following:
  135582. **
  135583. ** 1. Ignore any compress= and uncompress= options.
  135584. **
  135585. ** 2. If no column names were specified as part of the CREATE VIRTUAL
  135586. ** TABLE statement, use all columns from the content table.
  135587. */
  135588. if( rc==SQLITE_OK && zContent ){
  135589. sqlite3_free(zCompress);
  135590. sqlite3_free(zUncompress);
  135591. zCompress = 0;
  135592. zUncompress = 0;
  135593. if( nCol==0 ){
  135594. sqlite3_free((void*)aCol);
  135595. aCol = 0;
  135596. rc = fts3ContentColumns(db, argv[1], zContent,&aCol,&nCol,&nString,pzErr);
  135597. /* If a languageid= option was specified, remove the language id
  135598. ** column from the aCol[] array. */
  135599. if( rc==SQLITE_OK && zLanguageid ){
  135600. int j;
  135601. for(j=0; j<nCol; j++){
  135602. if( sqlite3_stricmp(zLanguageid, aCol[j])==0 ){
  135603. int k;
  135604. for(k=j; k<nCol; k++) aCol[k] = aCol[k+1];
  135605. nCol--;
  135606. break;
  135607. }
  135608. }
  135609. }
  135610. }
  135611. }
  135612. if( rc!=SQLITE_OK ) goto fts3_init_out;
  135613. if( nCol==0 ){
  135614. assert( nString==0 );
  135615. aCol[0] = "content";
  135616. nString = 8;
  135617. nCol = 1;
  135618. }
  135619. if( pTokenizer==0 ){
  135620. rc = sqlite3Fts3InitTokenizer(pHash, "simple", &pTokenizer, pzErr);
  135621. if( rc!=SQLITE_OK ) goto fts3_init_out;
  135622. }
  135623. assert( pTokenizer );
  135624. rc = fts3PrefixParameter(zPrefix, &nIndex, &aIndex);
  135625. if( rc==SQLITE_ERROR ){
  135626. assert( zPrefix );
  135627. sqlite3Fts3ErrMsg(pzErr, "error parsing prefix parameter: %s", zPrefix);
  135628. }
  135629. if( rc!=SQLITE_OK ) goto fts3_init_out;
  135630. /* Allocate and populate the Fts3Table structure. */
  135631. nByte = sizeof(Fts3Table) + /* Fts3Table */
  135632. nCol * sizeof(char *) + /* azColumn */
  135633. nIndex * sizeof(struct Fts3Index) + /* aIndex */
  135634. nCol * sizeof(u8) + /* abNotindexed */
  135635. nName + /* zName */
  135636. nDb + /* zDb */
  135637. nString; /* Space for azColumn strings */
  135638. p = (Fts3Table*)sqlite3_malloc(nByte);
  135639. if( p==0 ){
  135640. rc = SQLITE_NOMEM;
  135641. goto fts3_init_out;
  135642. }
  135643. memset(p, 0, nByte);
  135644. p->db = db;
  135645. p->nColumn = nCol;
  135646. p->nPendingData = 0;
  135647. p->azColumn = (char **)&p[1];
  135648. p->pTokenizer = pTokenizer;
  135649. p->nMaxPendingData = FTS3_MAX_PENDING_DATA;
  135650. p->bHasDocsize = (isFts4 && bNoDocsize==0);
  135651. p->bHasStat = isFts4;
  135652. p->bFts4 = isFts4;
  135653. p->bDescIdx = bDescIdx;
  135654. p->nAutoincrmerge = 0xff; /* 0xff means setting unknown */
  135655. p->zContentTbl = zContent;
  135656. p->zLanguageid = zLanguageid;
  135657. zContent = 0;
  135658. zLanguageid = 0;
  135659. TESTONLY( p->inTransaction = -1 );
  135660. TESTONLY( p->mxSavepoint = -1 );
  135661. p->aIndex = (struct Fts3Index *)&p->azColumn[nCol];
  135662. memcpy(p->aIndex, aIndex, sizeof(struct Fts3Index) * nIndex);
  135663. p->nIndex = nIndex;
  135664. for(i=0; i<nIndex; i++){
  135665. fts3HashInit(&p->aIndex[i].hPending, FTS3_HASH_STRING, 1);
  135666. }
  135667. p->abNotindexed = (u8 *)&p->aIndex[nIndex];
  135668. /* Fill in the zName and zDb fields of the vtab structure. */
  135669. zCsr = (char *)&p->abNotindexed[nCol];
  135670. p->zName = zCsr;
  135671. memcpy(zCsr, argv[2], nName);
  135672. zCsr += nName;
  135673. p->zDb = zCsr;
  135674. memcpy(zCsr, argv[1], nDb);
  135675. zCsr += nDb;
  135676. /* Fill in the azColumn array */
  135677. for(iCol=0; iCol<nCol; iCol++){
  135678. char *z;
  135679. int n = 0;
  135680. z = (char *)sqlite3Fts3NextToken(aCol[iCol], &n);
  135681. memcpy(zCsr, z, n);
  135682. zCsr[n] = '\0';
  135683. sqlite3Fts3Dequote(zCsr);
  135684. p->azColumn[iCol] = zCsr;
  135685. zCsr += n+1;
  135686. assert( zCsr <= &((char *)p)[nByte] );
  135687. }
  135688. /* Fill in the abNotindexed array */
  135689. for(iCol=0; iCol<nCol; iCol++){
  135690. int n = (int)strlen(p->azColumn[iCol]);
  135691. for(i=0; i<nNotindexed; i++){
  135692. char *zNot = azNotindexed[i];
  135693. if( zNot && n==(int)strlen(zNot)
  135694. && 0==sqlite3_strnicmp(p->azColumn[iCol], zNot, n)
  135695. ){
  135696. p->abNotindexed[iCol] = 1;
  135697. sqlite3_free(zNot);
  135698. azNotindexed[i] = 0;
  135699. }
  135700. }
  135701. }
  135702. for(i=0; i<nNotindexed; i++){
  135703. if( azNotindexed[i] ){
  135704. sqlite3Fts3ErrMsg(pzErr, "no such column: %s", azNotindexed[i]);
  135705. rc = SQLITE_ERROR;
  135706. }
  135707. }
  135708. if( rc==SQLITE_OK && (zCompress==0)!=(zUncompress==0) ){
  135709. char const *zMiss = (zCompress==0 ? "compress" : "uncompress");
  135710. rc = SQLITE_ERROR;
  135711. sqlite3Fts3ErrMsg(pzErr, "missing %s parameter in fts4 constructor", zMiss);
  135712. }
  135713. p->zReadExprlist = fts3ReadExprList(p, zUncompress, &rc);
  135714. p->zWriteExprlist = fts3WriteExprList(p, zCompress, &rc);
  135715. if( rc!=SQLITE_OK ) goto fts3_init_out;
  135716. /* If this is an xCreate call, create the underlying tables in the
  135717. ** database. TODO: For xConnect(), it could verify that said tables exist.
  135718. */
  135719. if( isCreate ){
  135720. rc = fts3CreateTables(p);
  135721. }
  135722. /* Check to see if a legacy fts3 table has been "upgraded" by the
  135723. ** addition of a %_stat table so that it can use incremental merge.
  135724. */
  135725. if( !isFts4 && !isCreate ){
  135726. p->bHasStat = 2;
  135727. }
  135728. /* Figure out the page-size for the database. This is required in order to
  135729. ** estimate the cost of loading large doclists from the database. */
  135730. fts3DatabasePageSize(&rc, p);
  135731. p->nNodeSize = p->nPgsz-35;
  135732. /* Declare the table schema to SQLite. */
  135733. fts3DeclareVtab(&rc, p);
  135734. fts3_init_out:
  135735. sqlite3_free(zPrefix);
  135736. sqlite3_free(aIndex);
  135737. sqlite3_free(zCompress);
  135738. sqlite3_free(zUncompress);
  135739. sqlite3_free(zContent);
  135740. sqlite3_free(zLanguageid);
  135741. for(i=0; i<nNotindexed; i++) sqlite3_free(azNotindexed[i]);
  135742. sqlite3_free((void *)aCol);
  135743. sqlite3_free((void *)azNotindexed);
  135744. if( rc!=SQLITE_OK ){
  135745. if( p ){
  135746. fts3DisconnectMethod((sqlite3_vtab *)p);
  135747. }else if( pTokenizer ){
  135748. pTokenizer->pModule->xDestroy(pTokenizer);
  135749. }
  135750. }else{
  135751. assert( p->pSegments==0 );
  135752. *ppVTab = &p->base;
  135753. }
  135754. return rc;
  135755. }
  135756. /*
  135757. ** The xConnect() and xCreate() methods for the virtual table. All the
  135758. ** work is done in function fts3InitVtab().
  135759. */
  135760. static int fts3ConnectMethod(
  135761. sqlite3 *db, /* Database connection */
  135762. void *pAux, /* Pointer to tokenizer hash table */
  135763. int argc, /* Number of elements in argv array */
  135764. const char * const *argv, /* xCreate/xConnect argument array */
  135765. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  135766. char **pzErr /* OUT: sqlite3_malloc'd error message */
  135767. ){
  135768. return fts3InitVtab(0, db, pAux, argc, argv, ppVtab, pzErr);
  135769. }
  135770. static int fts3CreateMethod(
  135771. sqlite3 *db, /* Database connection */
  135772. void *pAux, /* Pointer to tokenizer hash table */
  135773. int argc, /* Number of elements in argv array */
  135774. const char * const *argv, /* xCreate/xConnect argument array */
  135775. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  135776. char **pzErr /* OUT: sqlite3_malloc'd error message */
  135777. ){
  135778. return fts3InitVtab(1, db, pAux, argc, argv, ppVtab, pzErr);
  135779. }
  135780. /*
  135781. ** Set the pIdxInfo->estimatedRows variable to nRow. Unless this
  135782. ** extension is currently being used by a version of SQLite too old to
  135783. ** support estimatedRows. In that case this function is a no-op.
  135784. */
  135785. static void fts3SetEstimatedRows(sqlite3_index_info *pIdxInfo, i64 nRow){
  135786. #if SQLITE_VERSION_NUMBER>=3008002
  135787. if( sqlite3_libversion_number()>=3008002 ){
  135788. pIdxInfo->estimatedRows = nRow;
  135789. }
  135790. #endif
  135791. }
  135792. /*
  135793. ** Set the SQLITE_INDEX_SCAN_UNIQUE flag in pIdxInfo->flags. Unless this
  135794. ** extension is currently being used by a version of SQLite too old to
  135795. ** support index-info flags. In that case this function is a no-op.
  135796. */
  135797. static void fts3SetUniqueFlag(sqlite3_index_info *pIdxInfo){
  135798. #if SQLITE_VERSION_NUMBER>=3008012
  135799. if( sqlite3_libversion_number()>=3008012 ){
  135800. pIdxInfo->idxFlags |= SQLITE_INDEX_SCAN_UNIQUE;
  135801. }
  135802. #endif
  135803. }
  135804. /*
  135805. ** Implementation of the xBestIndex method for FTS3 tables. There
  135806. ** are three possible strategies, in order of preference:
  135807. **
  135808. ** 1. Direct lookup by rowid or docid.
  135809. ** 2. Full-text search using a MATCH operator on a non-docid column.
  135810. ** 3. Linear scan of %_content table.
  135811. */
  135812. static int fts3BestIndexMethod(sqlite3_vtab *pVTab, sqlite3_index_info *pInfo){
  135813. Fts3Table *p = (Fts3Table *)pVTab;
  135814. int i; /* Iterator variable */
  135815. int iCons = -1; /* Index of constraint to use */
  135816. int iLangidCons = -1; /* Index of langid=x constraint, if present */
  135817. int iDocidGe = -1; /* Index of docid>=x constraint, if present */
  135818. int iDocidLe = -1; /* Index of docid<=x constraint, if present */
  135819. int iIdx;
  135820. /* By default use a full table scan. This is an expensive option,
  135821. ** so search through the constraints to see if a more efficient
  135822. ** strategy is possible.
  135823. */
  135824. pInfo->idxNum = FTS3_FULLSCAN_SEARCH;
  135825. pInfo->estimatedCost = 5000000;
  135826. for(i=0; i<pInfo->nConstraint; i++){
  135827. int bDocid; /* True if this constraint is on docid */
  135828. struct sqlite3_index_constraint *pCons = &pInfo->aConstraint[i];
  135829. if( pCons->usable==0 ){
  135830. if( pCons->op==SQLITE_INDEX_CONSTRAINT_MATCH ){
  135831. /* There exists an unusable MATCH constraint. This means that if
  135832. ** the planner does elect to use the results of this call as part
  135833. ** of the overall query plan the user will see an "unable to use
  135834. ** function MATCH in the requested context" error. To discourage
  135835. ** this, return a very high cost here. */
  135836. pInfo->idxNum = FTS3_FULLSCAN_SEARCH;
  135837. pInfo->estimatedCost = 1e50;
  135838. fts3SetEstimatedRows(pInfo, ((sqlite3_int64)1) << 50);
  135839. return SQLITE_OK;
  135840. }
  135841. continue;
  135842. }
  135843. bDocid = (pCons->iColumn<0 || pCons->iColumn==p->nColumn+1);
  135844. /* A direct lookup on the rowid or docid column. Assign a cost of 1.0. */
  135845. if( iCons<0 && pCons->op==SQLITE_INDEX_CONSTRAINT_EQ && bDocid ){
  135846. pInfo->idxNum = FTS3_DOCID_SEARCH;
  135847. pInfo->estimatedCost = 1.0;
  135848. iCons = i;
  135849. }
  135850. /* A MATCH constraint. Use a full-text search.
  135851. **
  135852. ** If there is more than one MATCH constraint available, use the first
  135853. ** one encountered. If there is both a MATCH constraint and a direct
  135854. ** rowid/docid lookup, prefer the MATCH strategy. This is done even
  135855. ** though the rowid/docid lookup is faster than a MATCH query, selecting
  135856. ** it would lead to an "unable to use function MATCH in the requested
  135857. ** context" error.
  135858. */
  135859. if( pCons->op==SQLITE_INDEX_CONSTRAINT_MATCH
  135860. && pCons->iColumn>=0 && pCons->iColumn<=p->nColumn
  135861. ){
  135862. pInfo->idxNum = FTS3_FULLTEXT_SEARCH + pCons->iColumn;
  135863. pInfo->estimatedCost = 2.0;
  135864. iCons = i;
  135865. }
  135866. /* Equality constraint on the langid column */
  135867. if( pCons->op==SQLITE_INDEX_CONSTRAINT_EQ
  135868. && pCons->iColumn==p->nColumn + 2
  135869. ){
  135870. iLangidCons = i;
  135871. }
  135872. if( bDocid ){
  135873. switch( pCons->op ){
  135874. case SQLITE_INDEX_CONSTRAINT_GE:
  135875. case SQLITE_INDEX_CONSTRAINT_GT:
  135876. iDocidGe = i;
  135877. break;
  135878. case SQLITE_INDEX_CONSTRAINT_LE:
  135879. case SQLITE_INDEX_CONSTRAINT_LT:
  135880. iDocidLe = i;
  135881. break;
  135882. }
  135883. }
  135884. }
  135885. /* If using a docid=? or rowid=? strategy, set the UNIQUE flag. */
  135886. if( pInfo->idxNum==FTS3_DOCID_SEARCH ) fts3SetUniqueFlag(pInfo);
  135887. iIdx = 1;
  135888. if( iCons>=0 ){
  135889. pInfo->aConstraintUsage[iCons].argvIndex = iIdx++;
  135890. pInfo->aConstraintUsage[iCons].omit = 1;
  135891. }
  135892. if( iLangidCons>=0 ){
  135893. pInfo->idxNum |= FTS3_HAVE_LANGID;
  135894. pInfo->aConstraintUsage[iLangidCons].argvIndex = iIdx++;
  135895. }
  135896. if( iDocidGe>=0 ){
  135897. pInfo->idxNum |= FTS3_HAVE_DOCID_GE;
  135898. pInfo->aConstraintUsage[iDocidGe].argvIndex = iIdx++;
  135899. }
  135900. if( iDocidLe>=0 ){
  135901. pInfo->idxNum |= FTS3_HAVE_DOCID_LE;
  135902. pInfo->aConstraintUsage[iDocidLe].argvIndex = iIdx++;
  135903. }
  135904. /* Regardless of the strategy selected, FTS can deliver rows in rowid (or
  135905. ** docid) order. Both ascending and descending are possible.
  135906. */
  135907. if( pInfo->nOrderBy==1 ){
  135908. struct sqlite3_index_orderby *pOrder = &pInfo->aOrderBy[0];
  135909. if( pOrder->iColumn<0 || pOrder->iColumn==p->nColumn+1 ){
  135910. if( pOrder->desc ){
  135911. pInfo->idxStr = "DESC";
  135912. }else{
  135913. pInfo->idxStr = "ASC";
  135914. }
  135915. pInfo->orderByConsumed = 1;
  135916. }
  135917. }
  135918. assert( p->pSegments==0 );
  135919. return SQLITE_OK;
  135920. }
  135921. /*
  135922. ** Implementation of xOpen method.
  135923. */
  135924. static int fts3OpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  135925. sqlite3_vtab_cursor *pCsr; /* Allocated cursor */
  135926. UNUSED_PARAMETER(pVTab);
  135927. /* Allocate a buffer large enough for an Fts3Cursor structure. If the
  135928. ** allocation succeeds, zero it and return SQLITE_OK. Otherwise,
  135929. ** if the allocation fails, return SQLITE_NOMEM.
  135930. */
  135931. *ppCsr = pCsr = (sqlite3_vtab_cursor *)sqlite3_malloc(sizeof(Fts3Cursor));
  135932. if( !pCsr ){
  135933. return SQLITE_NOMEM;
  135934. }
  135935. memset(pCsr, 0, sizeof(Fts3Cursor));
  135936. return SQLITE_OK;
  135937. }
  135938. /*
  135939. ** Close the cursor. For additional information see the documentation
  135940. ** on the xClose method of the virtual table interface.
  135941. */
  135942. static int fts3CloseMethod(sqlite3_vtab_cursor *pCursor){
  135943. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  135944. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  135945. sqlite3_finalize(pCsr->pStmt);
  135946. sqlite3Fts3ExprFree(pCsr->pExpr);
  135947. sqlite3Fts3FreeDeferredTokens(pCsr);
  135948. sqlite3_free(pCsr->aDoclist);
  135949. sqlite3Fts3MIBufferFree(pCsr->pMIBuffer);
  135950. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  135951. sqlite3_free(pCsr);
  135952. return SQLITE_OK;
  135953. }
  135954. /*
  135955. ** If pCsr->pStmt has not been prepared (i.e. if pCsr->pStmt==0), then
  135956. ** compose and prepare an SQL statement of the form:
  135957. **
  135958. ** "SELECT <columns> FROM %_content WHERE rowid = ?"
  135959. **
  135960. ** (or the equivalent for a content=xxx table) and set pCsr->pStmt to
  135961. ** it. If an error occurs, return an SQLite error code.
  135962. **
  135963. ** Otherwise, set *ppStmt to point to pCsr->pStmt and return SQLITE_OK.
  135964. */
  135965. static int fts3CursorSeekStmt(Fts3Cursor *pCsr, sqlite3_stmt **ppStmt){
  135966. int rc = SQLITE_OK;
  135967. if( pCsr->pStmt==0 ){
  135968. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  135969. char *zSql;
  135970. zSql = sqlite3_mprintf("SELECT %s WHERE rowid = ?", p->zReadExprlist);
  135971. if( !zSql ) return SQLITE_NOMEM;
  135972. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pCsr->pStmt, 0);
  135973. sqlite3_free(zSql);
  135974. }
  135975. *ppStmt = pCsr->pStmt;
  135976. return rc;
  135977. }
  135978. /*
  135979. ** Position the pCsr->pStmt statement so that it is on the row
  135980. ** of the %_content table that contains the last match. Return
  135981. ** SQLITE_OK on success.
  135982. */
  135983. static int fts3CursorSeek(sqlite3_context *pContext, Fts3Cursor *pCsr){
  135984. int rc = SQLITE_OK;
  135985. if( pCsr->isRequireSeek ){
  135986. sqlite3_stmt *pStmt = 0;
  135987. rc = fts3CursorSeekStmt(pCsr, &pStmt);
  135988. if( rc==SQLITE_OK ){
  135989. sqlite3_bind_int64(pCsr->pStmt, 1, pCsr->iPrevId);
  135990. pCsr->isRequireSeek = 0;
  135991. if( SQLITE_ROW==sqlite3_step(pCsr->pStmt) ){
  135992. return SQLITE_OK;
  135993. }else{
  135994. rc = sqlite3_reset(pCsr->pStmt);
  135995. if( rc==SQLITE_OK && ((Fts3Table *)pCsr->base.pVtab)->zContentTbl==0 ){
  135996. /* If no row was found and no error has occurred, then the %_content
  135997. ** table is missing a row that is present in the full-text index.
  135998. ** The data structures are corrupt. */
  135999. rc = FTS_CORRUPT_VTAB;
  136000. pCsr->isEof = 1;
  136001. }
  136002. }
  136003. }
  136004. }
  136005. if( rc!=SQLITE_OK && pContext ){
  136006. sqlite3_result_error_code(pContext, rc);
  136007. }
  136008. return rc;
  136009. }
  136010. /*
  136011. ** This function is used to process a single interior node when searching
  136012. ** a b-tree for a term or term prefix. The node data is passed to this
  136013. ** function via the zNode/nNode parameters. The term to search for is
  136014. ** passed in zTerm/nTerm.
  136015. **
  136016. ** If piFirst is not NULL, then this function sets *piFirst to the blockid
  136017. ** of the child node that heads the sub-tree that may contain the term.
  136018. **
  136019. ** If piLast is not NULL, then *piLast is set to the right-most child node
  136020. ** that heads a sub-tree that may contain a term for which zTerm/nTerm is
  136021. ** a prefix.
  136022. **
  136023. ** If an OOM error occurs, SQLITE_NOMEM is returned. Otherwise, SQLITE_OK.
  136024. */
  136025. static int fts3ScanInteriorNode(
  136026. const char *zTerm, /* Term to select leaves for */
  136027. int nTerm, /* Size of term zTerm in bytes */
  136028. const char *zNode, /* Buffer containing segment interior node */
  136029. int nNode, /* Size of buffer at zNode */
  136030. sqlite3_int64 *piFirst, /* OUT: Selected child node */
  136031. sqlite3_int64 *piLast /* OUT: Selected child node */
  136032. ){
  136033. int rc = SQLITE_OK; /* Return code */
  136034. const char *zCsr = zNode; /* Cursor to iterate through node */
  136035. const char *zEnd = &zCsr[nNode];/* End of interior node buffer */
  136036. char *zBuffer = 0; /* Buffer to load terms into */
  136037. int nAlloc = 0; /* Size of allocated buffer */
  136038. int isFirstTerm = 1; /* True when processing first term on page */
  136039. sqlite3_int64 iChild; /* Block id of child node to descend to */
  136040. /* Skip over the 'height' varint that occurs at the start of every
  136041. ** interior node. Then load the blockid of the left-child of the b-tree
  136042. ** node into variable iChild.
  136043. **
  136044. ** Even if the data structure on disk is corrupted, this (reading two
  136045. ** varints from the buffer) does not risk an overread. If zNode is a
  136046. ** root node, then the buffer comes from a SELECT statement. SQLite does
  136047. ** not make this guarantee explicitly, but in practice there are always
  136048. ** either more than 20 bytes of allocated space following the nNode bytes of
  136049. ** contents, or two zero bytes. Or, if the node is read from the %_segments
  136050. ** table, then there are always 20 bytes of zeroed padding following the
  136051. ** nNode bytes of content (see sqlite3Fts3ReadBlock() for details).
  136052. */
  136053. zCsr += sqlite3Fts3GetVarint(zCsr, &iChild);
  136054. zCsr += sqlite3Fts3GetVarint(zCsr, &iChild);
  136055. if( zCsr>zEnd ){
  136056. return FTS_CORRUPT_VTAB;
  136057. }
  136058. while( zCsr<zEnd && (piFirst || piLast) ){
  136059. int cmp; /* memcmp() result */
  136060. int nSuffix; /* Size of term suffix */
  136061. int nPrefix = 0; /* Size of term prefix */
  136062. int nBuffer; /* Total term size */
  136063. /* Load the next term on the node into zBuffer. Use realloc() to expand
  136064. ** the size of zBuffer if required. */
  136065. if( !isFirstTerm ){
  136066. zCsr += fts3GetVarint32(zCsr, &nPrefix);
  136067. }
  136068. isFirstTerm = 0;
  136069. zCsr += fts3GetVarint32(zCsr, &nSuffix);
  136070. if( nPrefix<0 || nSuffix<0 || &zCsr[nSuffix]>zEnd ){
  136071. rc = FTS_CORRUPT_VTAB;
  136072. goto finish_scan;
  136073. }
  136074. if( nPrefix+nSuffix>nAlloc ){
  136075. char *zNew;
  136076. nAlloc = (nPrefix+nSuffix) * 2;
  136077. zNew = (char *)sqlite3_realloc(zBuffer, nAlloc);
  136078. if( !zNew ){
  136079. rc = SQLITE_NOMEM;
  136080. goto finish_scan;
  136081. }
  136082. zBuffer = zNew;
  136083. }
  136084. assert( zBuffer );
  136085. memcpy(&zBuffer[nPrefix], zCsr, nSuffix);
  136086. nBuffer = nPrefix + nSuffix;
  136087. zCsr += nSuffix;
  136088. /* Compare the term we are searching for with the term just loaded from
  136089. ** the interior node. If the specified term is greater than or equal
  136090. ** to the term from the interior node, then all terms on the sub-tree
  136091. ** headed by node iChild are smaller than zTerm. No need to search
  136092. ** iChild.
  136093. **
  136094. ** If the interior node term is larger than the specified term, then
  136095. ** the tree headed by iChild may contain the specified term.
  136096. */
  136097. cmp = memcmp(zTerm, zBuffer, (nBuffer>nTerm ? nTerm : nBuffer));
  136098. if( piFirst && (cmp<0 || (cmp==0 && nBuffer>nTerm)) ){
  136099. *piFirst = iChild;
  136100. piFirst = 0;
  136101. }
  136102. if( piLast && cmp<0 ){
  136103. *piLast = iChild;
  136104. piLast = 0;
  136105. }
  136106. iChild++;
  136107. };
  136108. if( piFirst ) *piFirst = iChild;
  136109. if( piLast ) *piLast = iChild;
  136110. finish_scan:
  136111. sqlite3_free(zBuffer);
  136112. return rc;
  136113. }
  136114. /*
  136115. ** The buffer pointed to by argument zNode (size nNode bytes) contains an
  136116. ** interior node of a b-tree segment. The zTerm buffer (size nTerm bytes)
  136117. ** contains a term. This function searches the sub-tree headed by the zNode
  136118. ** node for the range of leaf nodes that may contain the specified term
  136119. ** or terms for which the specified term is a prefix.
  136120. **
  136121. ** If piLeaf is not NULL, then *piLeaf is set to the blockid of the
  136122. ** left-most leaf node in the tree that may contain the specified term.
  136123. ** If piLeaf2 is not NULL, then *piLeaf2 is set to the blockid of the
  136124. ** right-most leaf node that may contain a term for which the specified
  136125. ** term is a prefix.
  136126. **
  136127. ** It is possible that the range of returned leaf nodes does not contain
  136128. ** the specified term or any terms for which it is a prefix. However, if the
  136129. ** segment does contain any such terms, they are stored within the identified
  136130. ** range. Because this function only inspects interior segment nodes (and
  136131. ** never loads leaf nodes into memory), it is not possible to be sure.
  136132. **
  136133. ** If an error occurs, an error code other than SQLITE_OK is returned.
  136134. */
  136135. static int fts3SelectLeaf(
  136136. Fts3Table *p, /* Virtual table handle */
  136137. const char *zTerm, /* Term to select leaves for */
  136138. int nTerm, /* Size of term zTerm in bytes */
  136139. const char *zNode, /* Buffer containing segment interior node */
  136140. int nNode, /* Size of buffer at zNode */
  136141. sqlite3_int64 *piLeaf, /* Selected leaf node */
  136142. sqlite3_int64 *piLeaf2 /* Selected leaf node */
  136143. ){
  136144. int rc = SQLITE_OK; /* Return code */
  136145. int iHeight; /* Height of this node in tree */
  136146. assert( piLeaf || piLeaf2 );
  136147. fts3GetVarint32(zNode, &iHeight);
  136148. rc = fts3ScanInteriorNode(zTerm, nTerm, zNode, nNode, piLeaf, piLeaf2);
  136149. assert( !piLeaf2 || !piLeaf || rc!=SQLITE_OK || (*piLeaf<=*piLeaf2) );
  136150. if( rc==SQLITE_OK && iHeight>1 ){
  136151. char *zBlob = 0; /* Blob read from %_segments table */
  136152. int nBlob = 0; /* Size of zBlob in bytes */
  136153. if( piLeaf && piLeaf2 && (*piLeaf!=*piLeaf2) ){
  136154. rc = sqlite3Fts3ReadBlock(p, *piLeaf, &zBlob, &nBlob, 0);
  136155. if( rc==SQLITE_OK ){
  136156. rc = fts3SelectLeaf(p, zTerm, nTerm, zBlob, nBlob, piLeaf, 0);
  136157. }
  136158. sqlite3_free(zBlob);
  136159. piLeaf = 0;
  136160. zBlob = 0;
  136161. }
  136162. if( rc==SQLITE_OK ){
  136163. rc = sqlite3Fts3ReadBlock(p, piLeaf?*piLeaf:*piLeaf2, &zBlob, &nBlob, 0);
  136164. }
  136165. if( rc==SQLITE_OK ){
  136166. rc = fts3SelectLeaf(p, zTerm, nTerm, zBlob, nBlob, piLeaf, piLeaf2);
  136167. }
  136168. sqlite3_free(zBlob);
  136169. }
  136170. return rc;
  136171. }
  136172. /*
  136173. ** This function is used to create delta-encoded serialized lists of FTS3
  136174. ** varints. Each call to this function appends a single varint to a list.
  136175. */
  136176. static void fts3PutDeltaVarint(
  136177. char **pp, /* IN/OUT: Output pointer */
  136178. sqlite3_int64 *piPrev, /* IN/OUT: Previous value written to list */
  136179. sqlite3_int64 iVal /* Write this value to the list */
  136180. ){
  136181. assert( iVal-*piPrev > 0 || (*piPrev==0 && iVal==0) );
  136182. *pp += sqlite3Fts3PutVarint(*pp, iVal-*piPrev);
  136183. *piPrev = iVal;
  136184. }
  136185. /*
  136186. ** When this function is called, *ppPoslist is assumed to point to the
  136187. ** start of a position-list. After it returns, *ppPoslist points to the
  136188. ** first byte after the position-list.
  136189. **
  136190. ** A position list is list of positions (delta encoded) and columns for
  136191. ** a single document record of a doclist. So, in other words, this
  136192. ** routine advances *ppPoslist so that it points to the next docid in
  136193. ** the doclist, or to the first byte past the end of the doclist.
  136194. **
  136195. ** If pp is not NULL, then the contents of the position list are copied
  136196. ** to *pp. *pp is set to point to the first byte past the last byte copied
  136197. ** before this function returns.
  136198. */
  136199. static void fts3PoslistCopy(char **pp, char **ppPoslist){
  136200. char *pEnd = *ppPoslist;
  136201. char c = 0;
  136202. /* The end of a position list is marked by a zero encoded as an FTS3
  136203. ** varint. A single POS_END (0) byte. Except, if the 0 byte is preceded by
  136204. ** a byte with the 0x80 bit set, then it is not a varint 0, but the tail
  136205. ** of some other, multi-byte, value.
  136206. **
  136207. ** The following while-loop moves pEnd to point to the first byte that is not
  136208. ** immediately preceded by a byte with the 0x80 bit set. Then increments
  136209. ** pEnd once more so that it points to the byte immediately following the
  136210. ** last byte in the position-list.
  136211. */
  136212. while( *pEnd | c ){
  136213. c = *pEnd++ & 0x80;
  136214. testcase( c!=0 && (*pEnd)==0 );
  136215. }
  136216. pEnd++; /* Advance past the POS_END terminator byte */
  136217. if( pp ){
  136218. int n = (int)(pEnd - *ppPoslist);
  136219. char *p = *pp;
  136220. memcpy(p, *ppPoslist, n);
  136221. p += n;
  136222. *pp = p;
  136223. }
  136224. *ppPoslist = pEnd;
  136225. }
  136226. /*
  136227. ** When this function is called, *ppPoslist is assumed to point to the
  136228. ** start of a column-list. After it returns, *ppPoslist points to the
  136229. ** to the terminator (POS_COLUMN or POS_END) byte of the column-list.
  136230. **
  136231. ** A column-list is list of delta-encoded positions for a single column
  136232. ** within a single document within a doclist.
  136233. **
  136234. ** The column-list is terminated either by a POS_COLUMN varint (1) or
  136235. ** a POS_END varint (0). This routine leaves *ppPoslist pointing to
  136236. ** the POS_COLUMN or POS_END that terminates the column-list.
  136237. **
  136238. ** If pp is not NULL, then the contents of the column-list are copied
  136239. ** to *pp. *pp is set to point to the first byte past the last byte copied
  136240. ** before this function returns. The POS_COLUMN or POS_END terminator
  136241. ** is not copied into *pp.
  136242. */
  136243. static void fts3ColumnlistCopy(char **pp, char **ppPoslist){
  136244. char *pEnd = *ppPoslist;
  136245. char c = 0;
  136246. /* A column-list is terminated by either a 0x01 or 0x00 byte that is
  136247. ** not part of a multi-byte varint.
  136248. */
  136249. while( 0xFE & (*pEnd | c) ){
  136250. c = *pEnd++ & 0x80;
  136251. testcase( c!=0 && ((*pEnd)&0xfe)==0 );
  136252. }
  136253. if( pp ){
  136254. int n = (int)(pEnd - *ppPoslist);
  136255. char *p = *pp;
  136256. memcpy(p, *ppPoslist, n);
  136257. p += n;
  136258. *pp = p;
  136259. }
  136260. *ppPoslist = pEnd;
  136261. }
  136262. /*
  136263. ** Value used to signify the end of an position-list. This is safe because
  136264. ** it is not possible to have a document with 2^31 terms.
  136265. */
  136266. #define POSITION_LIST_END 0x7fffffff
  136267. /*
  136268. ** This function is used to help parse position-lists. When this function is
  136269. ** called, *pp may point to the start of the next varint in the position-list
  136270. ** being parsed, or it may point to 1 byte past the end of the position-list
  136271. ** (in which case **pp will be a terminator bytes POS_END (0) or
  136272. ** (1)).
  136273. **
  136274. ** If *pp points past the end of the current position-list, set *pi to
  136275. ** POSITION_LIST_END and return. Otherwise, read the next varint from *pp,
  136276. ** increment the current value of *pi by the value read, and set *pp to
  136277. ** point to the next value before returning.
  136278. **
  136279. ** Before calling this routine *pi must be initialized to the value of
  136280. ** the previous position, or zero if we are reading the first position
  136281. ** in the position-list. Because positions are delta-encoded, the value
  136282. ** of the previous position is needed in order to compute the value of
  136283. ** the next position.
  136284. */
  136285. static void fts3ReadNextPos(
  136286. char **pp, /* IN/OUT: Pointer into position-list buffer */
  136287. sqlite3_int64 *pi /* IN/OUT: Value read from position-list */
  136288. ){
  136289. if( (**pp)&0xFE ){
  136290. fts3GetDeltaVarint(pp, pi);
  136291. *pi -= 2;
  136292. }else{
  136293. *pi = POSITION_LIST_END;
  136294. }
  136295. }
  136296. /*
  136297. ** If parameter iCol is not 0, write an POS_COLUMN (1) byte followed by
  136298. ** the value of iCol encoded as a varint to *pp. This will start a new
  136299. ** column list.
  136300. **
  136301. ** Set *pp to point to the byte just after the last byte written before
  136302. ** returning (do not modify it if iCol==0). Return the total number of bytes
  136303. ** written (0 if iCol==0).
  136304. */
  136305. static int fts3PutColNumber(char **pp, int iCol){
  136306. int n = 0; /* Number of bytes written */
  136307. if( iCol ){
  136308. char *p = *pp; /* Output pointer */
  136309. n = 1 + sqlite3Fts3PutVarint(&p[1], iCol);
  136310. *p = 0x01;
  136311. *pp = &p[n];
  136312. }
  136313. return n;
  136314. }
  136315. /*
  136316. ** Compute the union of two position lists. The output written
  136317. ** into *pp contains all positions of both *pp1 and *pp2 in sorted
  136318. ** order and with any duplicates removed. All pointers are
  136319. ** updated appropriately. The caller is responsible for insuring
  136320. ** that there is enough space in *pp to hold the complete output.
  136321. */
  136322. static void fts3PoslistMerge(
  136323. char **pp, /* Output buffer */
  136324. char **pp1, /* Left input list */
  136325. char **pp2 /* Right input list */
  136326. ){
  136327. char *p = *pp;
  136328. char *p1 = *pp1;
  136329. char *p2 = *pp2;
  136330. while( *p1 || *p2 ){
  136331. int iCol1; /* The current column index in pp1 */
  136332. int iCol2; /* The current column index in pp2 */
  136333. if( *p1==POS_COLUMN ) fts3GetVarint32(&p1[1], &iCol1);
  136334. else if( *p1==POS_END ) iCol1 = POSITION_LIST_END;
  136335. else iCol1 = 0;
  136336. if( *p2==POS_COLUMN ) fts3GetVarint32(&p2[1], &iCol2);
  136337. else if( *p2==POS_END ) iCol2 = POSITION_LIST_END;
  136338. else iCol2 = 0;
  136339. if( iCol1==iCol2 ){
  136340. sqlite3_int64 i1 = 0; /* Last position from pp1 */
  136341. sqlite3_int64 i2 = 0; /* Last position from pp2 */
  136342. sqlite3_int64 iPrev = 0;
  136343. int n = fts3PutColNumber(&p, iCol1);
  136344. p1 += n;
  136345. p2 += n;
  136346. /* At this point, both p1 and p2 point to the start of column-lists
  136347. ** for the same column (the column with index iCol1 and iCol2).
  136348. ** A column-list is a list of non-negative delta-encoded varints, each
  136349. ** incremented by 2 before being stored. Each list is terminated by a
  136350. ** POS_END (0) or POS_COLUMN (1). The following block merges the two lists
  136351. ** and writes the results to buffer p. p is left pointing to the byte
  136352. ** after the list written. No terminator (POS_END or POS_COLUMN) is
  136353. ** written to the output.
  136354. */
  136355. fts3GetDeltaVarint(&p1, &i1);
  136356. fts3GetDeltaVarint(&p2, &i2);
  136357. do {
  136358. fts3PutDeltaVarint(&p, &iPrev, (i1<i2) ? i1 : i2);
  136359. iPrev -= 2;
  136360. if( i1==i2 ){
  136361. fts3ReadNextPos(&p1, &i1);
  136362. fts3ReadNextPos(&p2, &i2);
  136363. }else if( i1<i2 ){
  136364. fts3ReadNextPos(&p1, &i1);
  136365. }else{
  136366. fts3ReadNextPos(&p2, &i2);
  136367. }
  136368. }while( i1!=POSITION_LIST_END || i2!=POSITION_LIST_END );
  136369. }else if( iCol1<iCol2 ){
  136370. p1 += fts3PutColNumber(&p, iCol1);
  136371. fts3ColumnlistCopy(&p, &p1);
  136372. }else{
  136373. p2 += fts3PutColNumber(&p, iCol2);
  136374. fts3ColumnlistCopy(&p, &p2);
  136375. }
  136376. }
  136377. *p++ = POS_END;
  136378. *pp = p;
  136379. *pp1 = p1 + 1;
  136380. *pp2 = p2 + 1;
  136381. }
  136382. /*
  136383. ** This function is used to merge two position lists into one. When it is
  136384. ** called, *pp1 and *pp2 must both point to position lists. A position-list is
  136385. ** the part of a doclist that follows each document id. For example, if a row
  136386. ** contains:
  136387. **
  136388. ** 'a b c'|'x y z'|'a b b a'
  136389. **
  136390. ** Then the position list for this row for token 'b' would consist of:
  136391. **
  136392. ** 0x02 0x01 0x02 0x03 0x03 0x00
  136393. **
  136394. ** When this function returns, both *pp1 and *pp2 are left pointing to the
  136395. ** byte following the 0x00 terminator of their respective position lists.
  136396. **
  136397. ** If isSaveLeft is 0, an entry is added to the output position list for
  136398. ** each position in *pp2 for which there exists one or more positions in
  136399. ** *pp1 so that (pos(*pp2)>pos(*pp1) && pos(*pp2)-pos(*pp1)<=nToken). i.e.
  136400. ** when the *pp1 token appears before the *pp2 token, but not more than nToken
  136401. ** slots before it.
  136402. **
  136403. ** e.g. nToken==1 searches for adjacent positions.
  136404. */
  136405. static int fts3PoslistPhraseMerge(
  136406. char **pp, /* IN/OUT: Preallocated output buffer */
  136407. int nToken, /* Maximum difference in token positions */
  136408. int isSaveLeft, /* Save the left position */
  136409. int isExact, /* If *pp1 is exactly nTokens before *pp2 */
  136410. char **pp1, /* IN/OUT: Left input list */
  136411. char **pp2 /* IN/OUT: Right input list */
  136412. ){
  136413. char *p = *pp;
  136414. char *p1 = *pp1;
  136415. char *p2 = *pp2;
  136416. int iCol1 = 0;
  136417. int iCol2 = 0;
  136418. /* Never set both isSaveLeft and isExact for the same invocation. */
  136419. assert( isSaveLeft==0 || isExact==0 );
  136420. assert( p!=0 && *p1!=0 && *p2!=0 );
  136421. if( *p1==POS_COLUMN ){
  136422. p1++;
  136423. p1 += fts3GetVarint32(p1, &iCol1);
  136424. }
  136425. if( *p2==POS_COLUMN ){
  136426. p2++;
  136427. p2 += fts3GetVarint32(p2, &iCol2);
  136428. }
  136429. while( 1 ){
  136430. if( iCol1==iCol2 ){
  136431. char *pSave = p;
  136432. sqlite3_int64 iPrev = 0;
  136433. sqlite3_int64 iPos1 = 0;
  136434. sqlite3_int64 iPos2 = 0;
  136435. if( iCol1 ){
  136436. *p++ = POS_COLUMN;
  136437. p += sqlite3Fts3PutVarint(p, iCol1);
  136438. }
  136439. assert( *p1!=POS_END && *p1!=POS_COLUMN );
  136440. assert( *p2!=POS_END && *p2!=POS_COLUMN );
  136441. fts3GetDeltaVarint(&p1, &iPos1); iPos1 -= 2;
  136442. fts3GetDeltaVarint(&p2, &iPos2); iPos2 -= 2;
  136443. while( 1 ){
  136444. if( iPos2==iPos1+nToken
  136445. || (isExact==0 && iPos2>iPos1 && iPos2<=iPos1+nToken)
  136446. ){
  136447. sqlite3_int64 iSave;
  136448. iSave = isSaveLeft ? iPos1 : iPos2;
  136449. fts3PutDeltaVarint(&p, &iPrev, iSave+2); iPrev -= 2;
  136450. pSave = 0;
  136451. assert( p );
  136452. }
  136453. if( (!isSaveLeft && iPos2<=(iPos1+nToken)) || iPos2<=iPos1 ){
  136454. if( (*p2&0xFE)==0 ) break;
  136455. fts3GetDeltaVarint(&p2, &iPos2); iPos2 -= 2;
  136456. }else{
  136457. if( (*p1&0xFE)==0 ) break;
  136458. fts3GetDeltaVarint(&p1, &iPos1); iPos1 -= 2;
  136459. }
  136460. }
  136461. if( pSave ){
  136462. assert( pp && p );
  136463. p = pSave;
  136464. }
  136465. fts3ColumnlistCopy(0, &p1);
  136466. fts3ColumnlistCopy(0, &p2);
  136467. assert( (*p1&0xFE)==0 && (*p2&0xFE)==0 );
  136468. if( 0==*p1 || 0==*p2 ) break;
  136469. p1++;
  136470. p1 += fts3GetVarint32(p1, &iCol1);
  136471. p2++;
  136472. p2 += fts3GetVarint32(p2, &iCol2);
  136473. }
  136474. /* Advance pointer p1 or p2 (whichever corresponds to the smaller of
  136475. ** iCol1 and iCol2) so that it points to either the 0x00 that marks the
  136476. ** end of the position list, or the 0x01 that precedes the next
  136477. ** column-number in the position list.
  136478. */
  136479. else if( iCol1<iCol2 ){
  136480. fts3ColumnlistCopy(0, &p1);
  136481. if( 0==*p1 ) break;
  136482. p1++;
  136483. p1 += fts3GetVarint32(p1, &iCol1);
  136484. }else{
  136485. fts3ColumnlistCopy(0, &p2);
  136486. if( 0==*p2 ) break;
  136487. p2++;
  136488. p2 += fts3GetVarint32(p2, &iCol2);
  136489. }
  136490. }
  136491. fts3PoslistCopy(0, &p2);
  136492. fts3PoslistCopy(0, &p1);
  136493. *pp1 = p1;
  136494. *pp2 = p2;
  136495. if( *pp==p ){
  136496. return 0;
  136497. }
  136498. *p++ = 0x00;
  136499. *pp = p;
  136500. return 1;
  136501. }
  136502. /*
  136503. ** Merge two position-lists as required by the NEAR operator. The argument
  136504. ** position lists correspond to the left and right phrases of an expression
  136505. ** like:
  136506. **
  136507. ** "phrase 1" NEAR "phrase number 2"
  136508. **
  136509. ** Position list *pp1 corresponds to the left-hand side of the NEAR
  136510. ** expression and *pp2 to the right. As usual, the indexes in the position
  136511. ** lists are the offsets of the last token in each phrase (tokens "1" and "2"
  136512. ** in the example above).
  136513. **
  136514. ** The output position list - written to *pp - is a copy of *pp2 with those
  136515. ** entries that are not sufficiently NEAR entries in *pp1 removed.
  136516. */
  136517. static int fts3PoslistNearMerge(
  136518. char **pp, /* Output buffer */
  136519. char *aTmp, /* Temporary buffer space */
  136520. int nRight, /* Maximum difference in token positions */
  136521. int nLeft, /* Maximum difference in token positions */
  136522. char **pp1, /* IN/OUT: Left input list */
  136523. char **pp2 /* IN/OUT: Right input list */
  136524. ){
  136525. char *p1 = *pp1;
  136526. char *p2 = *pp2;
  136527. char *pTmp1 = aTmp;
  136528. char *pTmp2;
  136529. char *aTmp2;
  136530. int res = 1;
  136531. fts3PoslistPhraseMerge(&pTmp1, nRight, 0, 0, pp1, pp2);
  136532. aTmp2 = pTmp2 = pTmp1;
  136533. *pp1 = p1;
  136534. *pp2 = p2;
  136535. fts3PoslistPhraseMerge(&pTmp2, nLeft, 1, 0, pp2, pp1);
  136536. if( pTmp1!=aTmp && pTmp2!=aTmp2 ){
  136537. fts3PoslistMerge(pp, &aTmp, &aTmp2);
  136538. }else if( pTmp1!=aTmp ){
  136539. fts3PoslistCopy(pp, &aTmp);
  136540. }else if( pTmp2!=aTmp2 ){
  136541. fts3PoslistCopy(pp, &aTmp2);
  136542. }else{
  136543. res = 0;
  136544. }
  136545. return res;
  136546. }
  136547. /*
  136548. ** An instance of this function is used to merge together the (potentially
  136549. ** large number of) doclists for each term that matches a prefix query.
  136550. ** See function fts3TermSelectMerge() for details.
  136551. */
  136552. typedef struct TermSelect TermSelect;
  136553. struct TermSelect {
  136554. char *aaOutput[16]; /* Malloc'd output buffers */
  136555. int anOutput[16]; /* Size each output buffer in bytes */
  136556. };
  136557. /*
  136558. ** This function is used to read a single varint from a buffer. Parameter
  136559. ** pEnd points 1 byte past the end of the buffer. When this function is
  136560. ** called, if *pp points to pEnd or greater, then the end of the buffer
  136561. ** has been reached. In this case *pp is set to 0 and the function returns.
  136562. **
  136563. ** If *pp does not point to or past pEnd, then a single varint is read
  136564. ** from *pp. *pp is then set to point 1 byte past the end of the read varint.
  136565. **
  136566. ** If bDescIdx is false, the value read is added to *pVal before returning.
  136567. ** If it is true, the value read is subtracted from *pVal before this
  136568. ** function returns.
  136569. */
  136570. static void fts3GetDeltaVarint3(
  136571. char **pp, /* IN/OUT: Point to read varint from */
  136572. char *pEnd, /* End of buffer */
  136573. int bDescIdx, /* True if docids are descending */
  136574. sqlite3_int64 *pVal /* IN/OUT: Integer value */
  136575. ){
  136576. if( *pp>=pEnd ){
  136577. *pp = 0;
  136578. }else{
  136579. sqlite3_int64 iVal;
  136580. *pp += sqlite3Fts3GetVarint(*pp, &iVal);
  136581. if( bDescIdx ){
  136582. *pVal -= iVal;
  136583. }else{
  136584. *pVal += iVal;
  136585. }
  136586. }
  136587. }
  136588. /*
  136589. ** This function is used to write a single varint to a buffer. The varint
  136590. ** is written to *pp. Before returning, *pp is set to point 1 byte past the
  136591. ** end of the value written.
  136592. **
  136593. ** If *pbFirst is zero when this function is called, the value written to
  136594. ** the buffer is that of parameter iVal.
  136595. **
  136596. ** If *pbFirst is non-zero when this function is called, then the value
  136597. ** written is either (iVal-*piPrev) (if bDescIdx is zero) or (*piPrev-iVal)
  136598. ** (if bDescIdx is non-zero).
  136599. **
  136600. ** Before returning, this function always sets *pbFirst to 1 and *piPrev
  136601. ** to the value of parameter iVal.
  136602. */
  136603. static void fts3PutDeltaVarint3(
  136604. char **pp, /* IN/OUT: Output pointer */
  136605. int bDescIdx, /* True for descending docids */
  136606. sqlite3_int64 *piPrev, /* IN/OUT: Previous value written to list */
  136607. int *pbFirst, /* IN/OUT: True after first int written */
  136608. sqlite3_int64 iVal /* Write this value to the list */
  136609. ){
  136610. sqlite3_int64 iWrite;
  136611. if( bDescIdx==0 || *pbFirst==0 ){
  136612. iWrite = iVal - *piPrev;
  136613. }else{
  136614. iWrite = *piPrev - iVal;
  136615. }
  136616. assert( *pbFirst || *piPrev==0 );
  136617. assert( *pbFirst==0 || iWrite>0 );
  136618. *pp += sqlite3Fts3PutVarint(*pp, iWrite);
  136619. *piPrev = iVal;
  136620. *pbFirst = 1;
  136621. }
  136622. /*
  136623. ** This macro is used by various functions that merge doclists. The two
  136624. ** arguments are 64-bit docid values. If the value of the stack variable
  136625. ** bDescDoclist is 0 when this macro is invoked, then it returns (i1-i2).
  136626. ** Otherwise, (i2-i1).
  136627. **
  136628. ** Using this makes it easier to write code that can merge doclists that are
  136629. ** sorted in either ascending or descending order.
  136630. */
  136631. #define DOCID_CMP(i1, i2) ((bDescDoclist?-1:1) * (i1-i2))
  136632. /*
  136633. ** This function does an "OR" merge of two doclists (output contains all
  136634. ** positions contained in either argument doclist). If the docids in the
  136635. ** input doclists are sorted in ascending order, parameter bDescDoclist
  136636. ** should be false. If they are sorted in ascending order, it should be
  136637. ** passed a non-zero value.
  136638. **
  136639. ** If no error occurs, *paOut is set to point at an sqlite3_malloc'd buffer
  136640. ** containing the output doclist and SQLITE_OK is returned. In this case
  136641. ** *pnOut is set to the number of bytes in the output doclist.
  136642. **
  136643. ** If an error occurs, an SQLite error code is returned. The output values
  136644. ** are undefined in this case.
  136645. */
  136646. static int fts3DoclistOrMerge(
  136647. int bDescDoclist, /* True if arguments are desc */
  136648. char *a1, int n1, /* First doclist */
  136649. char *a2, int n2, /* Second doclist */
  136650. char **paOut, int *pnOut /* OUT: Malloc'd doclist */
  136651. ){
  136652. sqlite3_int64 i1 = 0;
  136653. sqlite3_int64 i2 = 0;
  136654. sqlite3_int64 iPrev = 0;
  136655. char *pEnd1 = &a1[n1];
  136656. char *pEnd2 = &a2[n2];
  136657. char *p1 = a1;
  136658. char *p2 = a2;
  136659. char *p;
  136660. char *aOut;
  136661. int bFirstOut = 0;
  136662. *paOut = 0;
  136663. *pnOut = 0;
  136664. /* Allocate space for the output. Both the input and output doclists
  136665. ** are delta encoded. If they are in ascending order (bDescDoclist==0),
  136666. ** then the first docid in each list is simply encoded as a varint. For
  136667. ** each subsequent docid, the varint stored is the difference between the
  136668. ** current and previous docid (a positive number - since the list is in
  136669. ** ascending order).
  136670. **
  136671. ** The first docid written to the output is therefore encoded using the
  136672. ** same number of bytes as it is in whichever of the input lists it is
  136673. ** read from. And each subsequent docid read from the same input list
  136674. ** consumes either the same or less bytes as it did in the input (since
  136675. ** the difference between it and the previous value in the output must
  136676. ** be a positive value less than or equal to the delta value read from
  136677. ** the input list). The same argument applies to all but the first docid
  136678. ** read from the 'other' list. And to the contents of all position lists
  136679. ** that will be copied and merged from the input to the output.
  136680. **
  136681. ** However, if the first docid copied to the output is a negative number,
  136682. ** then the encoding of the first docid from the 'other' input list may
  136683. ** be larger in the output than it was in the input (since the delta value
  136684. ** may be a larger positive integer than the actual docid).
  136685. **
  136686. ** The space required to store the output is therefore the sum of the
  136687. ** sizes of the two inputs, plus enough space for exactly one of the input
  136688. ** docids to grow.
  136689. **
  136690. ** A symetric argument may be made if the doclists are in descending
  136691. ** order.
  136692. */
  136693. aOut = sqlite3_malloc(n1+n2+FTS3_VARINT_MAX-1);
  136694. if( !aOut ) return SQLITE_NOMEM;
  136695. p = aOut;
  136696. fts3GetDeltaVarint3(&p1, pEnd1, 0, &i1);
  136697. fts3GetDeltaVarint3(&p2, pEnd2, 0, &i2);
  136698. while( p1 || p2 ){
  136699. sqlite3_int64 iDiff = DOCID_CMP(i1, i2);
  136700. if( p2 && p1 && iDiff==0 ){
  136701. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  136702. fts3PoslistMerge(&p, &p1, &p2);
  136703. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  136704. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  136705. }else if( !p2 || (p1 && iDiff<0) ){
  136706. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  136707. fts3PoslistCopy(&p, &p1);
  136708. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  136709. }else{
  136710. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i2);
  136711. fts3PoslistCopy(&p, &p2);
  136712. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  136713. }
  136714. }
  136715. *paOut = aOut;
  136716. *pnOut = (int)(p-aOut);
  136717. assert( *pnOut<=n1+n2+FTS3_VARINT_MAX-1 );
  136718. return SQLITE_OK;
  136719. }
  136720. /*
  136721. ** This function does a "phrase" merge of two doclists. In a phrase merge,
  136722. ** the output contains a copy of each position from the right-hand input
  136723. ** doclist for which there is a position in the left-hand input doclist
  136724. ** exactly nDist tokens before it.
  136725. **
  136726. ** If the docids in the input doclists are sorted in ascending order,
  136727. ** parameter bDescDoclist should be false. If they are sorted in ascending
  136728. ** order, it should be passed a non-zero value.
  136729. **
  136730. ** The right-hand input doclist is overwritten by this function.
  136731. */
  136732. static int fts3DoclistPhraseMerge(
  136733. int bDescDoclist, /* True if arguments are desc */
  136734. int nDist, /* Distance from left to right (1=adjacent) */
  136735. char *aLeft, int nLeft, /* Left doclist */
  136736. char **paRight, int *pnRight /* IN/OUT: Right/output doclist */
  136737. ){
  136738. sqlite3_int64 i1 = 0;
  136739. sqlite3_int64 i2 = 0;
  136740. sqlite3_int64 iPrev = 0;
  136741. char *aRight = *paRight;
  136742. char *pEnd1 = &aLeft[nLeft];
  136743. char *pEnd2 = &aRight[*pnRight];
  136744. char *p1 = aLeft;
  136745. char *p2 = aRight;
  136746. char *p;
  136747. int bFirstOut = 0;
  136748. char *aOut;
  136749. assert( nDist>0 );
  136750. if( bDescDoclist ){
  136751. aOut = sqlite3_malloc(*pnRight + FTS3_VARINT_MAX);
  136752. if( aOut==0 ) return SQLITE_NOMEM;
  136753. }else{
  136754. aOut = aRight;
  136755. }
  136756. p = aOut;
  136757. fts3GetDeltaVarint3(&p1, pEnd1, 0, &i1);
  136758. fts3GetDeltaVarint3(&p2, pEnd2, 0, &i2);
  136759. while( p1 && p2 ){
  136760. sqlite3_int64 iDiff = DOCID_CMP(i1, i2);
  136761. if( iDiff==0 ){
  136762. char *pSave = p;
  136763. sqlite3_int64 iPrevSave = iPrev;
  136764. int bFirstOutSave = bFirstOut;
  136765. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  136766. if( 0==fts3PoslistPhraseMerge(&p, nDist, 0, 1, &p1, &p2) ){
  136767. p = pSave;
  136768. iPrev = iPrevSave;
  136769. bFirstOut = bFirstOutSave;
  136770. }
  136771. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  136772. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  136773. }else if( iDiff<0 ){
  136774. fts3PoslistCopy(0, &p1);
  136775. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  136776. }else{
  136777. fts3PoslistCopy(0, &p2);
  136778. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  136779. }
  136780. }
  136781. *pnRight = (int)(p - aOut);
  136782. if( bDescDoclist ){
  136783. sqlite3_free(aRight);
  136784. *paRight = aOut;
  136785. }
  136786. return SQLITE_OK;
  136787. }
  136788. /*
  136789. ** Argument pList points to a position list nList bytes in size. This
  136790. ** function checks to see if the position list contains any entries for
  136791. ** a token in position 0 (of any column). If so, it writes argument iDelta
  136792. ** to the output buffer pOut, followed by a position list consisting only
  136793. ** of the entries from pList at position 0, and terminated by an 0x00 byte.
  136794. ** The value returned is the number of bytes written to pOut (if any).
  136795. */
  136796. SQLITE_PRIVATE int sqlite3Fts3FirstFilter(
  136797. sqlite3_int64 iDelta, /* Varint that may be written to pOut */
  136798. char *pList, /* Position list (no 0x00 term) */
  136799. int nList, /* Size of pList in bytes */
  136800. char *pOut /* Write output here */
  136801. ){
  136802. int nOut = 0;
  136803. int bWritten = 0; /* True once iDelta has been written */
  136804. char *p = pList;
  136805. char *pEnd = &pList[nList];
  136806. if( *p!=0x01 ){
  136807. if( *p==0x02 ){
  136808. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iDelta);
  136809. pOut[nOut++] = 0x02;
  136810. bWritten = 1;
  136811. }
  136812. fts3ColumnlistCopy(0, &p);
  136813. }
  136814. while( p<pEnd && *p==0x01 ){
  136815. sqlite3_int64 iCol;
  136816. p++;
  136817. p += sqlite3Fts3GetVarint(p, &iCol);
  136818. if( *p==0x02 ){
  136819. if( bWritten==0 ){
  136820. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iDelta);
  136821. bWritten = 1;
  136822. }
  136823. pOut[nOut++] = 0x01;
  136824. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iCol);
  136825. pOut[nOut++] = 0x02;
  136826. }
  136827. fts3ColumnlistCopy(0, &p);
  136828. }
  136829. if( bWritten ){
  136830. pOut[nOut++] = 0x00;
  136831. }
  136832. return nOut;
  136833. }
  136834. /*
  136835. ** Merge all doclists in the TermSelect.aaOutput[] array into a single
  136836. ** doclist stored in TermSelect.aaOutput[0]. If successful, delete all
  136837. ** other doclists (except the aaOutput[0] one) and return SQLITE_OK.
  136838. **
  136839. ** If an OOM error occurs, return SQLITE_NOMEM. In this case it is
  136840. ** the responsibility of the caller to free any doclists left in the
  136841. ** TermSelect.aaOutput[] array.
  136842. */
  136843. static int fts3TermSelectFinishMerge(Fts3Table *p, TermSelect *pTS){
  136844. char *aOut = 0;
  136845. int nOut = 0;
  136846. int i;
  136847. /* Loop through the doclists in the aaOutput[] array. Merge them all
  136848. ** into a single doclist.
  136849. */
  136850. for(i=0; i<SizeofArray(pTS->aaOutput); i++){
  136851. if( pTS->aaOutput[i] ){
  136852. if( !aOut ){
  136853. aOut = pTS->aaOutput[i];
  136854. nOut = pTS->anOutput[i];
  136855. pTS->aaOutput[i] = 0;
  136856. }else{
  136857. int nNew;
  136858. char *aNew;
  136859. int rc = fts3DoclistOrMerge(p->bDescIdx,
  136860. pTS->aaOutput[i], pTS->anOutput[i], aOut, nOut, &aNew, &nNew
  136861. );
  136862. if( rc!=SQLITE_OK ){
  136863. sqlite3_free(aOut);
  136864. return rc;
  136865. }
  136866. sqlite3_free(pTS->aaOutput[i]);
  136867. sqlite3_free(aOut);
  136868. pTS->aaOutput[i] = 0;
  136869. aOut = aNew;
  136870. nOut = nNew;
  136871. }
  136872. }
  136873. }
  136874. pTS->aaOutput[0] = aOut;
  136875. pTS->anOutput[0] = nOut;
  136876. return SQLITE_OK;
  136877. }
  136878. /*
  136879. ** Merge the doclist aDoclist/nDoclist into the TermSelect object passed
  136880. ** as the first argument. The merge is an "OR" merge (see function
  136881. ** fts3DoclistOrMerge() for details).
  136882. **
  136883. ** This function is called with the doclist for each term that matches
  136884. ** a queried prefix. It merges all these doclists into one, the doclist
  136885. ** for the specified prefix. Since there can be a very large number of
  136886. ** doclists to merge, the merging is done pair-wise using the TermSelect
  136887. ** object.
  136888. **
  136889. ** This function returns SQLITE_OK if the merge is successful, or an
  136890. ** SQLite error code (SQLITE_NOMEM) if an error occurs.
  136891. */
  136892. static int fts3TermSelectMerge(
  136893. Fts3Table *p, /* FTS table handle */
  136894. TermSelect *pTS, /* TermSelect object to merge into */
  136895. char *aDoclist, /* Pointer to doclist */
  136896. int nDoclist /* Size of aDoclist in bytes */
  136897. ){
  136898. if( pTS->aaOutput[0]==0 ){
  136899. /* If this is the first term selected, copy the doclist to the output
  136900. ** buffer using memcpy().
  136901. **
  136902. ** Add FTS3_VARINT_MAX bytes of unused space to the end of the
  136903. ** allocation. This is so as to ensure that the buffer is big enough
  136904. ** to hold the current doclist AND'd with any other doclist. If the
  136905. ** doclists are stored in order=ASC order, this padding would not be
  136906. ** required (since the size of [doclistA AND doclistB] is always less
  136907. ** than or equal to the size of [doclistA] in that case). But this is
  136908. ** not true for order=DESC. For example, a doclist containing (1, -1)
  136909. ** may be smaller than (-1), as in the first example the -1 may be stored
  136910. ** as a single-byte delta, whereas in the second it must be stored as a
  136911. ** FTS3_VARINT_MAX byte varint.
  136912. **
  136913. ** Similar padding is added in the fts3DoclistOrMerge() function.
  136914. */
  136915. pTS->aaOutput[0] = sqlite3_malloc(nDoclist + FTS3_VARINT_MAX + 1);
  136916. pTS->anOutput[0] = nDoclist;
  136917. if( pTS->aaOutput[0] ){
  136918. memcpy(pTS->aaOutput[0], aDoclist, nDoclist);
  136919. }else{
  136920. return SQLITE_NOMEM;
  136921. }
  136922. }else{
  136923. char *aMerge = aDoclist;
  136924. int nMerge = nDoclist;
  136925. int iOut;
  136926. for(iOut=0; iOut<SizeofArray(pTS->aaOutput); iOut++){
  136927. if( pTS->aaOutput[iOut]==0 ){
  136928. assert( iOut>0 );
  136929. pTS->aaOutput[iOut] = aMerge;
  136930. pTS->anOutput[iOut] = nMerge;
  136931. break;
  136932. }else{
  136933. char *aNew;
  136934. int nNew;
  136935. int rc = fts3DoclistOrMerge(p->bDescIdx, aMerge, nMerge,
  136936. pTS->aaOutput[iOut], pTS->anOutput[iOut], &aNew, &nNew
  136937. );
  136938. if( rc!=SQLITE_OK ){
  136939. if( aMerge!=aDoclist ) sqlite3_free(aMerge);
  136940. return rc;
  136941. }
  136942. if( aMerge!=aDoclist ) sqlite3_free(aMerge);
  136943. sqlite3_free(pTS->aaOutput[iOut]);
  136944. pTS->aaOutput[iOut] = 0;
  136945. aMerge = aNew;
  136946. nMerge = nNew;
  136947. if( (iOut+1)==SizeofArray(pTS->aaOutput) ){
  136948. pTS->aaOutput[iOut] = aMerge;
  136949. pTS->anOutput[iOut] = nMerge;
  136950. }
  136951. }
  136952. }
  136953. }
  136954. return SQLITE_OK;
  136955. }
  136956. /*
  136957. ** Append SegReader object pNew to the end of the pCsr->apSegment[] array.
  136958. */
  136959. static int fts3SegReaderCursorAppend(
  136960. Fts3MultiSegReader *pCsr,
  136961. Fts3SegReader *pNew
  136962. ){
  136963. if( (pCsr->nSegment%16)==0 ){
  136964. Fts3SegReader **apNew;
  136965. int nByte = (pCsr->nSegment + 16)*sizeof(Fts3SegReader*);
  136966. apNew = (Fts3SegReader **)sqlite3_realloc(pCsr->apSegment, nByte);
  136967. if( !apNew ){
  136968. sqlite3Fts3SegReaderFree(pNew);
  136969. return SQLITE_NOMEM;
  136970. }
  136971. pCsr->apSegment = apNew;
  136972. }
  136973. pCsr->apSegment[pCsr->nSegment++] = pNew;
  136974. return SQLITE_OK;
  136975. }
  136976. /*
  136977. ** Add seg-reader objects to the Fts3MultiSegReader object passed as the
  136978. ** 8th argument.
  136979. **
  136980. ** This function returns SQLITE_OK if successful, or an SQLite error code
  136981. ** otherwise.
  136982. */
  136983. static int fts3SegReaderCursor(
  136984. Fts3Table *p, /* FTS3 table handle */
  136985. int iLangid, /* Language id */
  136986. int iIndex, /* Index to search (from 0 to p->nIndex-1) */
  136987. int iLevel, /* Level of segments to scan */
  136988. const char *zTerm, /* Term to query for */
  136989. int nTerm, /* Size of zTerm in bytes */
  136990. int isPrefix, /* True for a prefix search */
  136991. int isScan, /* True to scan from zTerm to EOF */
  136992. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  136993. ){
  136994. int rc = SQLITE_OK; /* Error code */
  136995. sqlite3_stmt *pStmt = 0; /* Statement to iterate through segments */
  136996. int rc2; /* Result of sqlite3_reset() */
  136997. /* If iLevel is less than 0 and this is not a scan, include a seg-reader
  136998. ** for the pending-terms. If this is a scan, then this call must be being
  136999. ** made by an fts4aux module, not an FTS table. In this case calling
  137000. ** Fts3SegReaderPending might segfault, as the data structures used by
  137001. ** fts4aux are not completely populated. So it's easiest to filter these
  137002. ** calls out here. */
  137003. if( iLevel<0 && p->aIndex ){
  137004. Fts3SegReader *pSeg = 0;
  137005. rc = sqlite3Fts3SegReaderPending(p, iIndex, zTerm, nTerm, isPrefix||isScan, &pSeg);
  137006. if( rc==SQLITE_OK && pSeg ){
  137007. rc = fts3SegReaderCursorAppend(pCsr, pSeg);
  137008. }
  137009. }
  137010. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  137011. if( rc==SQLITE_OK ){
  137012. rc = sqlite3Fts3AllSegdirs(p, iLangid, iIndex, iLevel, &pStmt);
  137013. }
  137014. while( rc==SQLITE_OK && SQLITE_ROW==(rc = sqlite3_step(pStmt)) ){
  137015. Fts3SegReader *pSeg = 0;
  137016. /* Read the values returned by the SELECT into local variables. */
  137017. sqlite3_int64 iStartBlock = sqlite3_column_int64(pStmt, 1);
  137018. sqlite3_int64 iLeavesEndBlock = sqlite3_column_int64(pStmt, 2);
  137019. sqlite3_int64 iEndBlock = sqlite3_column_int64(pStmt, 3);
  137020. int nRoot = sqlite3_column_bytes(pStmt, 4);
  137021. char const *zRoot = sqlite3_column_blob(pStmt, 4);
  137022. /* If zTerm is not NULL, and this segment is not stored entirely on its
  137023. ** root node, the range of leaves scanned can be reduced. Do this. */
  137024. if( iStartBlock && zTerm ){
  137025. sqlite3_int64 *pi = (isPrefix ? &iLeavesEndBlock : 0);
  137026. rc = fts3SelectLeaf(p, zTerm, nTerm, zRoot, nRoot, &iStartBlock, pi);
  137027. if( rc!=SQLITE_OK ) goto finished;
  137028. if( isPrefix==0 && isScan==0 ) iLeavesEndBlock = iStartBlock;
  137029. }
  137030. rc = sqlite3Fts3SegReaderNew(pCsr->nSegment+1,
  137031. (isPrefix==0 && isScan==0),
  137032. iStartBlock, iLeavesEndBlock,
  137033. iEndBlock, zRoot, nRoot, &pSeg
  137034. );
  137035. if( rc!=SQLITE_OK ) goto finished;
  137036. rc = fts3SegReaderCursorAppend(pCsr, pSeg);
  137037. }
  137038. }
  137039. finished:
  137040. rc2 = sqlite3_reset(pStmt);
  137041. if( rc==SQLITE_DONE ) rc = rc2;
  137042. return rc;
  137043. }
  137044. /*
  137045. ** Set up a cursor object for iterating through a full-text index or a
  137046. ** single level therein.
  137047. */
  137048. SQLITE_PRIVATE int sqlite3Fts3SegReaderCursor(
  137049. Fts3Table *p, /* FTS3 table handle */
  137050. int iLangid, /* Language-id to search */
  137051. int iIndex, /* Index to search (from 0 to p->nIndex-1) */
  137052. int iLevel, /* Level of segments to scan */
  137053. const char *zTerm, /* Term to query for */
  137054. int nTerm, /* Size of zTerm in bytes */
  137055. int isPrefix, /* True for a prefix search */
  137056. int isScan, /* True to scan from zTerm to EOF */
  137057. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  137058. ){
  137059. assert( iIndex>=0 && iIndex<p->nIndex );
  137060. assert( iLevel==FTS3_SEGCURSOR_ALL
  137061. || iLevel==FTS3_SEGCURSOR_PENDING
  137062. || iLevel>=0
  137063. );
  137064. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  137065. assert( FTS3_SEGCURSOR_ALL<0 && FTS3_SEGCURSOR_PENDING<0 );
  137066. assert( isPrefix==0 || isScan==0 );
  137067. memset(pCsr, 0, sizeof(Fts3MultiSegReader));
  137068. return fts3SegReaderCursor(
  137069. p, iLangid, iIndex, iLevel, zTerm, nTerm, isPrefix, isScan, pCsr
  137070. );
  137071. }
  137072. /*
  137073. ** In addition to its current configuration, have the Fts3MultiSegReader
  137074. ** passed as the 4th argument also scan the doclist for term zTerm/nTerm.
  137075. **
  137076. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  137077. */
  137078. static int fts3SegReaderCursorAddZero(
  137079. Fts3Table *p, /* FTS virtual table handle */
  137080. int iLangid,
  137081. const char *zTerm, /* Term to scan doclist of */
  137082. int nTerm, /* Number of bytes in zTerm */
  137083. Fts3MultiSegReader *pCsr /* Fts3MultiSegReader to modify */
  137084. ){
  137085. return fts3SegReaderCursor(p,
  137086. iLangid, 0, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 0, 0,pCsr
  137087. );
  137088. }
  137089. /*
  137090. ** Open an Fts3MultiSegReader to scan the doclist for term zTerm/nTerm. Or,
  137091. ** if isPrefix is true, to scan the doclist for all terms for which
  137092. ** zTerm/nTerm is a prefix. If successful, return SQLITE_OK and write
  137093. ** a pointer to the new Fts3MultiSegReader to *ppSegcsr. Otherwise, return
  137094. ** an SQLite error code.
  137095. **
  137096. ** It is the responsibility of the caller to free this object by eventually
  137097. ** passing it to fts3SegReaderCursorFree()
  137098. **
  137099. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  137100. ** Output parameter *ppSegcsr is set to 0 if an error occurs.
  137101. */
  137102. static int fts3TermSegReaderCursor(
  137103. Fts3Cursor *pCsr, /* Virtual table cursor handle */
  137104. const char *zTerm, /* Term to query for */
  137105. int nTerm, /* Size of zTerm in bytes */
  137106. int isPrefix, /* True for a prefix search */
  137107. Fts3MultiSegReader **ppSegcsr /* OUT: Allocated seg-reader cursor */
  137108. ){
  137109. Fts3MultiSegReader *pSegcsr; /* Object to allocate and return */
  137110. int rc = SQLITE_NOMEM; /* Return code */
  137111. pSegcsr = sqlite3_malloc(sizeof(Fts3MultiSegReader));
  137112. if( pSegcsr ){
  137113. int i;
  137114. int bFound = 0; /* True once an index has been found */
  137115. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  137116. if( isPrefix ){
  137117. for(i=1; bFound==0 && i<p->nIndex; i++){
  137118. if( p->aIndex[i].nPrefix==nTerm ){
  137119. bFound = 1;
  137120. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  137121. i, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 0, 0, pSegcsr
  137122. );
  137123. pSegcsr->bLookup = 1;
  137124. }
  137125. }
  137126. for(i=1; bFound==0 && i<p->nIndex; i++){
  137127. if( p->aIndex[i].nPrefix==nTerm+1 ){
  137128. bFound = 1;
  137129. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  137130. i, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 1, 0, pSegcsr
  137131. );
  137132. if( rc==SQLITE_OK ){
  137133. rc = fts3SegReaderCursorAddZero(
  137134. p, pCsr->iLangid, zTerm, nTerm, pSegcsr
  137135. );
  137136. }
  137137. }
  137138. }
  137139. }
  137140. if( bFound==0 ){
  137141. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  137142. 0, FTS3_SEGCURSOR_ALL, zTerm, nTerm, isPrefix, 0, pSegcsr
  137143. );
  137144. pSegcsr->bLookup = !isPrefix;
  137145. }
  137146. }
  137147. *ppSegcsr = pSegcsr;
  137148. return rc;
  137149. }
  137150. /*
  137151. ** Free an Fts3MultiSegReader allocated by fts3TermSegReaderCursor().
  137152. */
  137153. static void fts3SegReaderCursorFree(Fts3MultiSegReader *pSegcsr){
  137154. sqlite3Fts3SegReaderFinish(pSegcsr);
  137155. sqlite3_free(pSegcsr);
  137156. }
  137157. /*
  137158. ** This function retrieves the doclist for the specified term (or term
  137159. ** prefix) from the database.
  137160. */
  137161. static int fts3TermSelect(
  137162. Fts3Table *p, /* Virtual table handle */
  137163. Fts3PhraseToken *pTok, /* Token to query for */
  137164. int iColumn, /* Column to query (or -ve for all columns) */
  137165. int *pnOut, /* OUT: Size of buffer at *ppOut */
  137166. char **ppOut /* OUT: Malloced result buffer */
  137167. ){
  137168. int rc; /* Return code */
  137169. Fts3MultiSegReader *pSegcsr; /* Seg-reader cursor for this term */
  137170. TermSelect tsc; /* Object for pair-wise doclist merging */
  137171. Fts3SegFilter filter; /* Segment term filter configuration */
  137172. pSegcsr = pTok->pSegcsr;
  137173. memset(&tsc, 0, sizeof(TermSelect));
  137174. filter.flags = FTS3_SEGMENT_IGNORE_EMPTY | FTS3_SEGMENT_REQUIRE_POS
  137175. | (pTok->isPrefix ? FTS3_SEGMENT_PREFIX : 0)
  137176. | (pTok->bFirst ? FTS3_SEGMENT_FIRST : 0)
  137177. | (iColumn<p->nColumn ? FTS3_SEGMENT_COLUMN_FILTER : 0);
  137178. filter.iCol = iColumn;
  137179. filter.zTerm = pTok->z;
  137180. filter.nTerm = pTok->n;
  137181. rc = sqlite3Fts3SegReaderStart(p, pSegcsr, &filter);
  137182. while( SQLITE_OK==rc
  137183. && SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, pSegcsr))
  137184. ){
  137185. rc = fts3TermSelectMerge(p, &tsc, pSegcsr->aDoclist, pSegcsr->nDoclist);
  137186. }
  137187. if( rc==SQLITE_OK ){
  137188. rc = fts3TermSelectFinishMerge(p, &tsc);
  137189. }
  137190. if( rc==SQLITE_OK ){
  137191. *ppOut = tsc.aaOutput[0];
  137192. *pnOut = tsc.anOutput[0];
  137193. }else{
  137194. int i;
  137195. for(i=0; i<SizeofArray(tsc.aaOutput); i++){
  137196. sqlite3_free(tsc.aaOutput[i]);
  137197. }
  137198. }
  137199. fts3SegReaderCursorFree(pSegcsr);
  137200. pTok->pSegcsr = 0;
  137201. return rc;
  137202. }
  137203. /*
  137204. ** This function counts the total number of docids in the doclist stored
  137205. ** in buffer aList[], size nList bytes.
  137206. **
  137207. ** If the isPoslist argument is true, then it is assumed that the doclist
  137208. ** contains a position-list following each docid. Otherwise, it is assumed
  137209. ** that the doclist is simply a list of docids stored as delta encoded
  137210. ** varints.
  137211. */
  137212. static int fts3DoclistCountDocids(char *aList, int nList){
  137213. int nDoc = 0; /* Return value */
  137214. if( aList ){
  137215. char *aEnd = &aList[nList]; /* Pointer to one byte after EOF */
  137216. char *p = aList; /* Cursor */
  137217. while( p<aEnd ){
  137218. nDoc++;
  137219. while( (*p++)&0x80 ); /* Skip docid varint */
  137220. fts3PoslistCopy(0, &p); /* Skip over position list */
  137221. }
  137222. }
  137223. return nDoc;
  137224. }
  137225. /*
  137226. ** Advance the cursor to the next row in the %_content table that
  137227. ** matches the search criteria. For a MATCH search, this will be
  137228. ** the next row that matches. For a full-table scan, this will be
  137229. ** simply the next row in the %_content table. For a docid lookup,
  137230. ** this routine simply sets the EOF flag.
  137231. **
  137232. ** Return SQLITE_OK if nothing goes wrong. SQLITE_OK is returned
  137233. ** even if we reach end-of-file. The fts3EofMethod() will be called
  137234. ** subsequently to determine whether or not an EOF was hit.
  137235. */
  137236. static int fts3NextMethod(sqlite3_vtab_cursor *pCursor){
  137237. int rc;
  137238. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  137239. if( pCsr->eSearch==FTS3_DOCID_SEARCH || pCsr->eSearch==FTS3_FULLSCAN_SEARCH ){
  137240. if( SQLITE_ROW!=sqlite3_step(pCsr->pStmt) ){
  137241. pCsr->isEof = 1;
  137242. rc = sqlite3_reset(pCsr->pStmt);
  137243. }else{
  137244. pCsr->iPrevId = sqlite3_column_int64(pCsr->pStmt, 0);
  137245. rc = SQLITE_OK;
  137246. }
  137247. }else{
  137248. rc = fts3EvalNext((Fts3Cursor *)pCursor);
  137249. }
  137250. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  137251. return rc;
  137252. }
  137253. /*
  137254. ** The following are copied from sqliteInt.h.
  137255. **
  137256. ** Constants for the largest and smallest possible 64-bit signed integers.
  137257. ** These macros are designed to work correctly on both 32-bit and 64-bit
  137258. ** compilers.
  137259. */
  137260. #ifndef SQLITE_AMALGAMATION
  137261. # define LARGEST_INT64 (0xffffffff|(((sqlite3_int64)0x7fffffff)<<32))
  137262. # define SMALLEST_INT64 (((sqlite3_int64)-1) - LARGEST_INT64)
  137263. #endif
  137264. /*
  137265. ** If the numeric type of argument pVal is "integer", then return it
  137266. ** converted to a 64-bit signed integer. Otherwise, return a copy of
  137267. ** the second parameter, iDefault.
  137268. */
  137269. static sqlite3_int64 fts3DocidRange(sqlite3_value *pVal, i64 iDefault){
  137270. if( pVal ){
  137271. int eType = sqlite3_value_numeric_type(pVal);
  137272. if( eType==SQLITE_INTEGER ){
  137273. return sqlite3_value_int64(pVal);
  137274. }
  137275. }
  137276. return iDefault;
  137277. }
  137278. /*
  137279. ** This is the xFilter interface for the virtual table. See
  137280. ** the virtual table xFilter method documentation for additional
  137281. ** information.
  137282. **
  137283. ** If idxNum==FTS3_FULLSCAN_SEARCH then do a full table scan against
  137284. ** the %_content table.
  137285. **
  137286. ** If idxNum==FTS3_DOCID_SEARCH then do a docid lookup for a single entry
  137287. ** in the %_content table.
  137288. **
  137289. ** If idxNum>=FTS3_FULLTEXT_SEARCH then use the full text index. The
  137290. ** column on the left-hand side of the MATCH operator is column
  137291. ** number idxNum-FTS3_FULLTEXT_SEARCH, 0 indexed. argv[0] is the right-hand
  137292. ** side of the MATCH operator.
  137293. */
  137294. static int fts3FilterMethod(
  137295. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  137296. int idxNum, /* Strategy index */
  137297. const char *idxStr, /* Unused */
  137298. int nVal, /* Number of elements in apVal */
  137299. sqlite3_value **apVal /* Arguments for the indexing scheme */
  137300. ){
  137301. int rc = SQLITE_OK;
  137302. char *zSql; /* SQL statement used to access %_content */
  137303. int eSearch;
  137304. Fts3Table *p = (Fts3Table *)pCursor->pVtab;
  137305. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  137306. sqlite3_value *pCons = 0; /* The MATCH or rowid constraint, if any */
  137307. sqlite3_value *pLangid = 0; /* The "langid = ?" constraint, if any */
  137308. sqlite3_value *pDocidGe = 0; /* The "docid >= ?" constraint, if any */
  137309. sqlite3_value *pDocidLe = 0; /* The "docid <= ?" constraint, if any */
  137310. int iIdx;
  137311. UNUSED_PARAMETER(idxStr);
  137312. UNUSED_PARAMETER(nVal);
  137313. eSearch = (idxNum & 0x0000FFFF);
  137314. assert( eSearch>=0 && eSearch<=(FTS3_FULLTEXT_SEARCH+p->nColumn) );
  137315. assert( p->pSegments==0 );
  137316. /* Collect arguments into local variables */
  137317. iIdx = 0;
  137318. if( eSearch!=FTS3_FULLSCAN_SEARCH ) pCons = apVal[iIdx++];
  137319. if( idxNum & FTS3_HAVE_LANGID ) pLangid = apVal[iIdx++];
  137320. if( idxNum & FTS3_HAVE_DOCID_GE ) pDocidGe = apVal[iIdx++];
  137321. if( idxNum & FTS3_HAVE_DOCID_LE ) pDocidLe = apVal[iIdx++];
  137322. assert( iIdx==nVal );
  137323. /* In case the cursor has been used before, clear it now. */
  137324. sqlite3_finalize(pCsr->pStmt);
  137325. sqlite3_free(pCsr->aDoclist);
  137326. sqlite3Fts3MIBufferFree(pCsr->pMIBuffer);
  137327. sqlite3Fts3ExprFree(pCsr->pExpr);
  137328. memset(&pCursor[1], 0, sizeof(Fts3Cursor)-sizeof(sqlite3_vtab_cursor));
  137329. /* Set the lower and upper bounds on docids to return */
  137330. pCsr->iMinDocid = fts3DocidRange(pDocidGe, SMALLEST_INT64);
  137331. pCsr->iMaxDocid = fts3DocidRange(pDocidLe, LARGEST_INT64);
  137332. if( idxStr ){
  137333. pCsr->bDesc = (idxStr[0]=='D');
  137334. }else{
  137335. pCsr->bDesc = p->bDescIdx;
  137336. }
  137337. pCsr->eSearch = (i16)eSearch;
  137338. if( eSearch!=FTS3_DOCID_SEARCH && eSearch!=FTS3_FULLSCAN_SEARCH ){
  137339. int iCol = eSearch-FTS3_FULLTEXT_SEARCH;
  137340. const char *zQuery = (const char *)sqlite3_value_text(pCons);
  137341. if( zQuery==0 && sqlite3_value_type(pCons)!=SQLITE_NULL ){
  137342. return SQLITE_NOMEM;
  137343. }
  137344. pCsr->iLangid = 0;
  137345. if( pLangid ) pCsr->iLangid = sqlite3_value_int(pLangid);
  137346. assert( p->base.zErrMsg==0 );
  137347. rc = sqlite3Fts3ExprParse(p->pTokenizer, pCsr->iLangid,
  137348. p->azColumn, p->bFts4, p->nColumn, iCol, zQuery, -1, &pCsr->pExpr,
  137349. &p->base.zErrMsg
  137350. );
  137351. if( rc!=SQLITE_OK ){
  137352. return rc;
  137353. }
  137354. rc = fts3EvalStart(pCsr);
  137355. sqlite3Fts3SegmentsClose(p);
  137356. if( rc!=SQLITE_OK ) return rc;
  137357. pCsr->pNextId = pCsr->aDoclist;
  137358. pCsr->iPrevId = 0;
  137359. }
  137360. /* Compile a SELECT statement for this cursor. For a full-table-scan, the
  137361. ** statement loops through all rows of the %_content table. For a
  137362. ** full-text query or docid lookup, the statement retrieves a single
  137363. ** row by docid.
  137364. */
  137365. if( eSearch==FTS3_FULLSCAN_SEARCH ){
  137366. if( pDocidGe || pDocidLe ){
  137367. zSql = sqlite3_mprintf(
  137368. "SELECT %s WHERE rowid BETWEEN %lld AND %lld ORDER BY rowid %s",
  137369. p->zReadExprlist, pCsr->iMinDocid, pCsr->iMaxDocid,
  137370. (pCsr->bDesc ? "DESC" : "ASC")
  137371. );
  137372. }else{
  137373. zSql = sqlite3_mprintf("SELECT %s ORDER BY rowid %s",
  137374. p->zReadExprlist, (pCsr->bDesc ? "DESC" : "ASC")
  137375. );
  137376. }
  137377. if( zSql ){
  137378. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pCsr->pStmt, 0);
  137379. sqlite3_free(zSql);
  137380. }else{
  137381. rc = SQLITE_NOMEM;
  137382. }
  137383. }else if( eSearch==FTS3_DOCID_SEARCH ){
  137384. rc = fts3CursorSeekStmt(pCsr, &pCsr->pStmt);
  137385. if( rc==SQLITE_OK ){
  137386. rc = sqlite3_bind_value(pCsr->pStmt, 1, pCons);
  137387. }
  137388. }
  137389. if( rc!=SQLITE_OK ) return rc;
  137390. return fts3NextMethod(pCursor);
  137391. }
  137392. /*
  137393. ** This is the xEof method of the virtual table. SQLite calls this
  137394. ** routine to find out if it has reached the end of a result set.
  137395. */
  137396. static int fts3EofMethod(sqlite3_vtab_cursor *pCursor){
  137397. return ((Fts3Cursor *)pCursor)->isEof;
  137398. }
  137399. /*
  137400. ** This is the xRowid method. The SQLite core calls this routine to
  137401. ** retrieve the rowid for the current row of the result set. fts3
  137402. ** exposes %_content.docid as the rowid for the virtual table. The
  137403. ** rowid should be written to *pRowid.
  137404. */
  137405. static int fts3RowidMethod(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  137406. Fts3Cursor *pCsr = (Fts3Cursor *) pCursor;
  137407. *pRowid = pCsr->iPrevId;
  137408. return SQLITE_OK;
  137409. }
  137410. /*
  137411. ** This is the xColumn method, called by SQLite to request a value from
  137412. ** the row that the supplied cursor currently points to.
  137413. **
  137414. ** If:
  137415. **
  137416. ** (iCol < p->nColumn) -> The value of the iCol'th user column.
  137417. ** (iCol == p->nColumn) -> Magic column with the same name as the table.
  137418. ** (iCol == p->nColumn+1) -> Docid column
  137419. ** (iCol == p->nColumn+2) -> Langid column
  137420. */
  137421. static int fts3ColumnMethod(
  137422. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  137423. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  137424. int iCol /* Index of column to read value from */
  137425. ){
  137426. int rc = SQLITE_OK; /* Return Code */
  137427. Fts3Cursor *pCsr = (Fts3Cursor *) pCursor;
  137428. Fts3Table *p = (Fts3Table *)pCursor->pVtab;
  137429. /* The column value supplied by SQLite must be in range. */
  137430. assert( iCol>=0 && iCol<=p->nColumn+2 );
  137431. if( iCol==p->nColumn+1 ){
  137432. /* This call is a request for the "docid" column. Since "docid" is an
  137433. ** alias for "rowid", use the xRowid() method to obtain the value.
  137434. */
  137435. sqlite3_result_int64(pCtx, pCsr->iPrevId);
  137436. }else if( iCol==p->nColumn ){
  137437. /* The extra column whose name is the same as the table.
  137438. ** Return a blob which is a pointer to the cursor. */
  137439. sqlite3_result_blob(pCtx, &pCsr, sizeof(pCsr), SQLITE_TRANSIENT);
  137440. }else if( iCol==p->nColumn+2 && pCsr->pExpr ){
  137441. sqlite3_result_int64(pCtx, pCsr->iLangid);
  137442. }else{
  137443. /* The requested column is either a user column (one that contains
  137444. ** indexed data), or the language-id column. */
  137445. rc = fts3CursorSeek(0, pCsr);
  137446. if( rc==SQLITE_OK ){
  137447. if( iCol==p->nColumn+2 ){
  137448. int iLangid = 0;
  137449. if( p->zLanguageid ){
  137450. iLangid = sqlite3_column_int(pCsr->pStmt, p->nColumn+1);
  137451. }
  137452. sqlite3_result_int(pCtx, iLangid);
  137453. }else if( sqlite3_data_count(pCsr->pStmt)>(iCol+1) ){
  137454. sqlite3_result_value(pCtx, sqlite3_column_value(pCsr->pStmt, iCol+1));
  137455. }
  137456. }
  137457. }
  137458. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  137459. return rc;
  137460. }
  137461. /*
  137462. ** This function is the implementation of the xUpdate callback used by
  137463. ** FTS3 virtual tables. It is invoked by SQLite each time a row is to be
  137464. ** inserted, updated or deleted.
  137465. */
  137466. static int fts3UpdateMethod(
  137467. sqlite3_vtab *pVtab, /* Virtual table handle */
  137468. int nArg, /* Size of argument array */
  137469. sqlite3_value **apVal, /* Array of arguments */
  137470. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  137471. ){
  137472. return sqlite3Fts3UpdateMethod(pVtab, nArg, apVal, pRowid);
  137473. }
  137474. /*
  137475. ** Implementation of xSync() method. Flush the contents of the pending-terms
  137476. ** hash-table to the database.
  137477. */
  137478. static int fts3SyncMethod(sqlite3_vtab *pVtab){
  137479. /* Following an incremental-merge operation, assuming that the input
  137480. ** segments are not completely consumed (the usual case), they are updated
  137481. ** in place to remove the entries that have already been merged. This
  137482. ** involves updating the leaf block that contains the smallest unmerged
  137483. ** entry and each block (if any) between the leaf and the root node. So
  137484. ** if the height of the input segment b-trees is N, and input segments
  137485. ** are merged eight at a time, updating the input segments at the end
  137486. ** of an incremental-merge requires writing (8*(1+N)) blocks. N is usually
  137487. ** small - often between 0 and 2. So the overhead of the incremental
  137488. ** merge is somewhere between 8 and 24 blocks. To avoid this overhead
  137489. ** dwarfing the actual productive work accomplished, the incremental merge
  137490. ** is only attempted if it will write at least 64 leaf blocks. Hence
  137491. ** nMinMerge.
  137492. **
  137493. ** Of course, updating the input segments also involves deleting a bunch
  137494. ** of blocks from the segments table. But this is not considered overhead
  137495. ** as it would also be required by a crisis-merge that used the same input
  137496. ** segments.
  137497. */
  137498. const u32 nMinMerge = 64; /* Minimum amount of incr-merge work to do */
  137499. Fts3Table *p = (Fts3Table*)pVtab;
  137500. int rc = sqlite3Fts3PendingTermsFlush(p);
  137501. if( rc==SQLITE_OK
  137502. && p->nLeafAdd>(nMinMerge/16)
  137503. && p->nAutoincrmerge && p->nAutoincrmerge!=0xff
  137504. ){
  137505. int mxLevel = 0; /* Maximum relative level value in db */
  137506. int A; /* Incr-merge parameter A */
  137507. rc = sqlite3Fts3MaxLevel(p, &mxLevel);
  137508. assert( rc==SQLITE_OK || mxLevel==0 );
  137509. A = p->nLeafAdd * mxLevel;
  137510. A += (A/2);
  137511. if( A>(int)nMinMerge ) rc = sqlite3Fts3Incrmerge(p, A, p->nAutoincrmerge);
  137512. }
  137513. sqlite3Fts3SegmentsClose(p);
  137514. return rc;
  137515. }
  137516. /*
  137517. ** If it is currently unknown whether or not the FTS table has an %_stat
  137518. ** table (if p->bHasStat==2), attempt to determine this (set p->bHasStat
  137519. ** to 0 or 1). Return SQLITE_OK if successful, or an SQLite error code
  137520. ** if an error occurs.
  137521. */
  137522. static int fts3SetHasStat(Fts3Table *p){
  137523. int rc = SQLITE_OK;
  137524. if( p->bHasStat==2 ){
  137525. const char *zFmt ="SELECT 1 FROM %Q.sqlite_master WHERE tbl_name='%q_stat'";
  137526. char *zSql = sqlite3_mprintf(zFmt, p->zDb, p->zName);
  137527. if( zSql ){
  137528. sqlite3_stmt *pStmt = 0;
  137529. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, 0);
  137530. if( rc==SQLITE_OK ){
  137531. int bHasStat = (sqlite3_step(pStmt)==SQLITE_ROW);
  137532. rc = sqlite3_finalize(pStmt);
  137533. if( rc==SQLITE_OK ) p->bHasStat = bHasStat;
  137534. }
  137535. sqlite3_free(zSql);
  137536. }else{
  137537. rc = SQLITE_NOMEM;
  137538. }
  137539. }
  137540. return rc;
  137541. }
  137542. /*
  137543. ** Implementation of xBegin() method.
  137544. */
  137545. static int fts3BeginMethod(sqlite3_vtab *pVtab){
  137546. Fts3Table *p = (Fts3Table*)pVtab;
  137547. UNUSED_PARAMETER(pVtab);
  137548. assert( p->pSegments==0 );
  137549. assert( p->nPendingData==0 );
  137550. assert( p->inTransaction!=1 );
  137551. TESTONLY( p->inTransaction = 1 );
  137552. TESTONLY( p->mxSavepoint = -1; );
  137553. p->nLeafAdd = 0;
  137554. return fts3SetHasStat(p);
  137555. }
  137556. /*
  137557. ** Implementation of xCommit() method. This is a no-op. The contents of
  137558. ** the pending-terms hash-table have already been flushed into the database
  137559. ** by fts3SyncMethod().
  137560. */
  137561. static int fts3CommitMethod(sqlite3_vtab *pVtab){
  137562. TESTONLY( Fts3Table *p = (Fts3Table*)pVtab );
  137563. UNUSED_PARAMETER(pVtab);
  137564. assert( p->nPendingData==0 );
  137565. assert( p->inTransaction!=0 );
  137566. assert( p->pSegments==0 );
  137567. TESTONLY( p->inTransaction = 0 );
  137568. TESTONLY( p->mxSavepoint = -1; );
  137569. return SQLITE_OK;
  137570. }
  137571. /*
  137572. ** Implementation of xRollback(). Discard the contents of the pending-terms
  137573. ** hash-table. Any changes made to the database are reverted by SQLite.
  137574. */
  137575. static int fts3RollbackMethod(sqlite3_vtab *pVtab){
  137576. Fts3Table *p = (Fts3Table*)pVtab;
  137577. sqlite3Fts3PendingTermsClear(p);
  137578. assert( p->inTransaction!=0 );
  137579. TESTONLY( p->inTransaction = 0 );
  137580. TESTONLY( p->mxSavepoint = -1; );
  137581. return SQLITE_OK;
  137582. }
  137583. /*
  137584. ** When called, *ppPoslist must point to the byte immediately following the
  137585. ** end of a position-list. i.e. ( (*ppPoslist)[-1]==POS_END ). This function
  137586. ** moves *ppPoslist so that it instead points to the first byte of the
  137587. ** same position list.
  137588. */
  137589. static void fts3ReversePoslist(char *pStart, char **ppPoslist){
  137590. char *p = &(*ppPoslist)[-2];
  137591. char c = 0;
  137592. /* Skip backwards passed any trailing 0x00 bytes added by NearTrim() */
  137593. while( p>pStart && (c=*p--)==0 );
  137594. /* Search backwards for a varint with value zero (the end of the previous
  137595. ** poslist). This is an 0x00 byte preceded by some byte that does not
  137596. ** have the 0x80 bit set. */
  137597. while( p>pStart && (*p & 0x80) | c ){
  137598. c = *p--;
  137599. }
  137600. assert( p==pStart || c==0 );
  137601. /* At this point p points to that preceding byte without the 0x80 bit
  137602. ** set. So to find the start of the poslist, skip forward 2 bytes then
  137603. ** over a varint.
  137604. **
  137605. ** Normally. The other case is that p==pStart and the poslist to return
  137606. ** is the first in the doclist. In this case do not skip forward 2 bytes.
  137607. ** The second part of the if condition (c==0 && *ppPoslist>&p[2])
  137608. ** is required for cases where the first byte of a doclist and the
  137609. ** doclist is empty. For example, if the first docid is 10, a doclist
  137610. ** that begins with:
  137611. **
  137612. ** 0x0A 0x00 <next docid delta varint>
  137613. */
  137614. if( p>pStart || (c==0 && *ppPoslist>&p[2]) ){ p = &p[2]; }
  137615. while( *p++&0x80 );
  137616. *ppPoslist = p;
  137617. }
  137618. /*
  137619. ** Helper function used by the implementation of the overloaded snippet(),
  137620. ** offsets() and optimize() SQL functions.
  137621. **
  137622. ** If the value passed as the third argument is a blob of size
  137623. ** sizeof(Fts3Cursor*), then the blob contents are copied to the
  137624. ** output variable *ppCsr and SQLITE_OK is returned. Otherwise, an error
  137625. ** message is written to context pContext and SQLITE_ERROR returned. The
  137626. ** string passed via zFunc is used as part of the error message.
  137627. */
  137628. static int fts3FunctionArg(
  137629. sqlite3_context *pContext, /* SQL function call context */
  137630. const char *zFunc, /* Function name */
  137631. sqlite3_value *pVal, /* argv[0] passed to function */
  137632. Fts3Cursor **ppCsr /* OUT: Store cursor handle here */
  137633. ){
  137634. Fts3Cursor *pRet;
  137635. if( sqlite3_value_type(pVal)!=SQLITE_BLOB
  137636. || sqlite3_value_bytes(pVal)!=sizeof(Fts3Cursor *)
  137637. ){
  137638. char *zErr = sqlite3_mprintf("illegal first argument to %s", zFunc);
  137639. sqlite3_result_error(pContext, zErr, -1);
  137640. sqlite3_free(zErr);
  137641. return SQLITE_ERROR;
  137642. }
  137643. memcpy(&pRet, sqlite3_value_blob(pVal), sizeof(Fts3Cursor *));
  137644. *ppCsr = pRet;
  137645. return SQLITE_OK;
  137646. }
  137647. /*
  137648. ** Implementation of the snippet() function for FTS3
  137649. */
  137650. static void fts3SnippetFunc(
  137651. sqlite3_context *pContext, /* SQLite function call context */
  137652. int nVal, /* Size of apVal[] array */
  137653. sqlite3_value **apVal /* Array of arguments */
  137654. ){
  137655. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  137656. const char *zStart = "<b>";
  137657. const char *zEnd = "</b>";
  137658. const char *zEllipsis = "<b>...</b>";
  137659. int iCol = -1;
  137660. int nToken = 15; /* Default number of tokens in snippet */
  137661. /* There must be at least one argument passed to this function (otherwise
  137662. ** the non-overloaded version would have been called instead of this one).
  137663. */
  137664. assert( nVal>=1 );
  137665. if( nVal>6 ){
  137666. sqlite3_result_error(pContext,
  137667. "wrong number of arguments to function snippet()", -1);
  137668. return;
  137669. }
  137670. if( fts3FunctionArg(pContext, "snippet", apVal[0], &pCsr) ) return;
  137671. switch( nVal ){
  137672. case 6: nToken = sqlite3_value_int(apVal[5]);
  137673. case 5: iCol = sqlite3_value_int(apVal[4]);
  137674. case 4: zEllipsis = (const char*)sqlite3_value_text(apVal[3]);
  137675. case 3: zEnd = (const char*)sqlite3_value_text(apVal[2]);
  137676. case 2: zStart = (const char*)sqlite3_value_text(apVal[1]);
  137677. }
  137678. if( !zEllipsis || !zEnd || !zStart ){
  137679. sqlite3_result_error_nomem(pContext);
  137680. }else if( nToken==0 ){
  137681. sqlite3_result_text(pContext, "", -1, SQLITE_STATIC);
  137682. }else if( SQLITE_OK==fts3CursorSeek(pContext, pCsr) ){
  137683. sqlite3Fts3Snippet(pContext, pCsr, zStart, zEnd, zEllipsis, iCol, nToken);
  137684. }
  137685. }
  137686. /*
  137687. ** Implementation of the offsets() function for FTS3
  137688. */
  137689. static void fts3OffsetsFunc(
  137690. sqlite3_context *pContext, /* SQLite function call context */
  137691. int nVal, /* Size of argument array */
  137692. sqlite3_value **apVal /* Array of arguments */
  137693. ){
  137694. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  137695. UNUSED_PARAMETER(nVal);
  137696. assert( nVal==1 );
  137697. if( fts3FunctionArg(pContext, "offsets", apVal[0], &pCsr) ) return;
  137698. assert( pCsr );
  137699. if( SQLITE_OK==fts3CursorSeek(pContext, pCsr) ){
  137700. sqlite3Fts3Offsets(pContext, pCsr);
  137701. }
  137702. }
  137703. /*
  137704. ** Implementation of the special optimize() function for FTS3. This
  137705. ** function merges all segments in the database to a single segment.
  137706. ** Example usage is:
  137707. **
  137708. ** SELECT optimize(t) FROM t LIMIT 1;
  137709. **
  137710. ** where 't' is the name of an FTS3 table.
  137711. */
  137712. static void fts3OptimizeFunc(
  137713. sqlite3_context *pContext, /* SQLite function call context */
  137714. int nVal, /* Size of argument array */
  137715. sqlite3_value **apVal /* Array of arguments */
  137716. ){
  137717. int rc; /* Return code */
  137718. Fts3Table *p; /* Virtual table handle */
  137719. Fts3Cursor *pCursor; /* Cursor handle passed through apVal[0] */
  137720. UNUSED_PARAMETER(nVal);
  137721. assert( nVal==1 );
  137722. if( fts3FunctionArg(pContext, "optimize", apVal[0], &pCursor) ) return;
  137723. p = (Fts3Table *)pCursor->base.pVtab;
  137724. assert( p );
  137725. rc = sqlite3Fts3Optimize(p);
  137726. switch( rc ){
  137727. case SQLITE_OK:
  137728. sqlite3_result_text(pContext, "Index optimized", -1, SQLITE_STATIC);
  137729. break;
  137730. case SQLITE_DONE:
  137731. sqlite3_result_text(pContext, "Index already optimal", -1, SQLITE_STATIC);
  137732. break;
  137733. default:
  137734. sqlite3_result_error_code(pContext, rc);
  137735. break;
  137736. }
  137737. }
  137738. /*
  137739. ** Implementation of the matchinfo() function for FTS3
  137740. */
  137741. static void fts3MatchinfoFunc(
  137742. sqlite3_context *pContext, /* SQLite function call context */
  137743. int nVal, /* Size of argument array */
  137744. sqlite3_value **apVal /* Array of arguments */
  137745. ){
  137746. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  137747. assert( nVal==1 || nVal==2 );
  137748. if( SQLITE_OK==fts3FunctionArg(pContext, "matchinfo", apVal[0], &pCsr) ){
  137749. const char *zArg = 0;
  137750. if( nVal>1 ){
  137751. zArg = (const char *)sqlite3_value_text(apVal[1]);
  137752. }
  137753. sqlite3Fts3Matchinfo(pContext, pCsr, zArg);
  137754. }
  137755. }
  137756. /*
  137757. ** This routine implements the xFindFunction method for the FTS3
  137758. ** virtual table.
  137759. */
  137760. static int fts3FindFunctionMethod(
  137761. sqlite3_vtab *pVtab, /* Virtual table handle */
  137762. int nArg, /* Number of SQL function arguments */
  137763. const char *zName, /* Name of SQL function */
  137764. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), /* OUT: Result */
  137765. void **ppArg /* Unused */
  137766. ){
  137767. struct Overloaded {
  137768. const char *zName;
  137769. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  137770. } aOverload[] = {
  137771. { "snippet", fts3SnippetFunc },
  137772. { "offsets", fts3OffsetsFunc },
  137773. { "optimize", fts3OptimizeFunc },
  137774. { "matchinfo", fts3MatchinfoFunc },
  137775. };
  137776. int i; /* Iterator variable */
  137777. UNUSED_PARAMETER(pVtab);
  137778. UNUSED_PARAMETER(nArg);
  137779. UNUSED_PARAMETER(ppArg);
  137780. for(i=0; i<SizeofArray(aOverload); i++){
  137781. if( strcmp(zName, aOverload[i].zName)==0 ){
  137782. *pxFunc = aOverload[i].xFunc;
  137783. return 1;
  137784. }
  137785. }
  137786. /* No function of the specified name was found. Return 0. */
  137787. return 0;
  137788. }
  137789. /*
  137790. ** Implementation of FTS3 xRename method. Rename an fts3 table.
  137791. */
  137792. static int fts3RenameMethod(
  137793. sqlite3_vtab *pVtab, /* Virtual table handle */
  137794. const char *zName /* New name of table */
  137795. ){
  137796. Fts3Table *p = (Fts3Table *)pVtab;
  137797. sqlite3 *db = p->db; /* Database connection */
  137798. int rc; /* Return Code */
  137799. /* At this point it must be known if the %_stat table exists or not.
  137800. ** So bHasStat may not be 2. */
  137801. rc = fts3SetHasStat(p);
  137802. /* As it happens, the pending terms table is always empty here. This is
  137803. ** because an "ALTER TABLE RENAME TABLE" statement inside a transaction
  137804. ** always opens a savepoint transaction. And the xSavepoint() method
  137805. ** flushes the pending terms table. But leave the (no-op) call to
  137806. ** PendingTermsFlush() in in case that changes.
  137807. */
  137808. assert( p->nPendingData==0 );
  137809. if( rc==SQLITE_OK ){
  137810. rc = sqlite3Fts3PendingTermsFlush(p);
  137811. }
  137812. if( p->zContentTbl==0 ){
  137813. fts3DbExec(&rc, db,
  137814. "ALTER TABLE %Q.'%q_content' RENAME TO '%q_content';",
  137815. p->zDb, p->zName, zName
  137816. );
  137817. }
  137818. if( p->bHasDocsize ){
  137819. fts3DbExec(&rc, db,
  137820. "ALTER TABLE %Q.'%q_docsize' RENAME TO '%q_docsize';",
  137821. p->zDb, p->zName, zName
  137822. );
  137823. }
  137824. if( p->bHasStat ){
  137825. fts3DbExec(&rc, db,
  137826. "ALTER TABLE %Q.'%q_stat' RENAME TO '%q_stat';",
  137827. p->zDb, p->zName, zName
  137828. );
  137829. }
  137830. fts3DbExec(&rc, db,
  137831. "ALTER TABLE %Q.'%q_segments' RENAME TO '%q_segments';",
  137832. p->zDb, p->zName, zName
  137833. );
  137834. fts3DbExec(&rc, db,
  137835. "ALTER TABLE %Q.'%q_segdir' RENAME TO '%q_segdir';",
  137836. p->zDb, p->zName, zName
  137837. );
  137838. return rc;
  137839. }
  137840. /*
  137841. ** The xSavepoint() method.
  137842. **
  137843. ** Flush the contents of the pending-terms table to disk.
  137844. */
  137845. static int fts3SavepointMethod(sqlite3_vtab *pVtab, int iSavepoint){
  137846. int rc = SQLITE_OK;
  137847. UNUSED_PARAMETER(iSavepoint);
  137848. assert( ((Fts3Table *)pVtab)->inTransaction );
  137849. assert( ((Fts3Table *)pVtab)->mxSavepoint < iSavepoint );
  137850. TESTONLY( ((Fts3Table *)pVtab)->mxSavepoint = iSavepoint );
  137851. if( ((Fts3Table *)pVtab)->bIgnoreSavepoint==0 ){
  137852. rc = fts3SyncMethod(pVtab);
  137853. }
  137854. return rc;
  137855. }
  137856. /*
  137857. ** The xRelease() method.
  137858. **
  137859. ** This is a no-op.
  137860. */
  137861. static int fts3ReleaseMethod(sqlite3_vtab *pVtab, int iSavepoint){
  137862. TESTONLY( Fts3Table *p = (Fts3Table*)pVtab );
  137863. UNUSED_PARAMETER(iSavepoint);
  137864. UNUSED_PARAMETER(pVtab);
  137865. assert( p->inTransaction );
  137866. assert( p->mxSavepoint >= iSavepoint );
  137867. TESTONLY( p->mxSavepoint = iSavepoint-1 );
  137868. return SQLITE_OK;
  137869. }
  137870. /*
  137871. ** The xRollbackTo() method.
  137872. **
  137873. ** Discard the contents of the pending terms table.
  137874. */
  137875. static int fts3RollbackToMethod(sqlite3_vtab *pVtab, int iSavepoint){
  137876. Fts3Table *p = (Fts3Table*)pVtab;
  137877. UNUSED_PARAMETER(iSavepoint);
  137878. assert( p->inTransaction );
  137879. assert( p->mxSavepoint >= iSavepoint );
  137880. TESTONLY( p->mxSavepoint = iSavepoint );
  137881. sqlite3Fts3PendingTermsClear(p);
  137882. return SQLITE_OK;
  137883. }
  137884. static const sqlite3_module fts3Module = {
  137885. /* iVersion */ 2,
  137886. /* xCreate */ fts3CreateMethod,
  137887. /* xConnect */ fts3ConnectMethod,
  137888. /* xBestIndex */ fts3BestIndexMethod,
  137889. /* xDisconnect */ fts3DisconnectMethod,
  137890. /* xDestroy */ fts3DestroyMethod,
  137891. /* xOpen */ fts3OpenMethod,
  137892. /* xClose */ fts3CloseMethod,
  137893. /* xFilter */ fts3FilterMethod,
  137894. /* xNext */ fts3NextMethod,
  137895. /* xEof */ fts3EofMethod,
  137896. /* xColumn */ fts3ColumnMethod,
  137897. /* xRowid */ fts3RowidMethod,
  137898. /* xUpdate */ fts3UpdateMethod,
  137899. /* xBegin */ fts3BeginMethod,
  137900. /* xSync */ fts3SyncMethod,
  137901. /* xCommit */ fts3CommitMethod,
  137902. /* xRollback */ fts3RollbackMethod,
  137903. /* xFindFunction */ fts3FindFunctionMethod,
  137904. /* xRename */ fts3RenameMethod,
  137905. /* xSavepoint */ fts3SavepointMethod,
  137906. /* xRelease */ fts3ReleaseMethod,
  137907. /* xRollbackTo */ fts3RollbackToMethod,
  137908. };
  137909. /*
  137910. ** This function is registered as the module destructor (called when an
  137911. ** FTS3 enabled database connection is closed). It frees the memory
  137912. ** allocated for the tokenizer hash table.
  137913. */
  137914. static void hashDestroy(void *p){
  137915. Fts3Hash *pHash = (Fts3Hash *)p;
  137916. sqlite3Fts3HashClear(pHash);
  137917. sqlite3_free(pHash);
  137918. }
  137919. /*
  137920. ** The fts3 built-in tokenizers - "simple", "porter" and "icu"- are
  137921. ** implemented in files fts3_tokenizer1.c, fts3_porter.c and fts3_icu.c
  137922. ** respectively. The following three forward declarations are for functions
  137923. ** declared in these files used to retrieve the respective implementations.
  137924. **
  137925. ** Calling sqlite3Fts3SimpleTokenizerModule() sets the value pointed
  137926. ** to by the argument to point to the "simple" tokenizer implementation.
  137927. ** And so on.
  137928. */
  137929. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  137930. SQLITE_PRIVATE void sqlite3Fts3PorterTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  137931. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  137932. SQLITE_PRIVATE void sqlite3Fts3UnicodeTokenizer(sqlite3_tokenizer_module const**ppModule);
  137933. #endif
  137934. #ifdef SQLITE_ENABLE_ICU
  137935. SQLITE_PRIVATE void sqlite3Fts3IcuTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  137936. #endif
  137937. /*
  137938. ** Initialize the fts3 extension. If this extension is built as part
  137939. ** of the sqlite library, then this function is called directly by
  137940. ** SQLite. If fts3 is built as a dynamically loadable extension, this
  137941. ** function is called by the sqlite3_extension_init() entry point.
  137942. */
  137943. SQLITE_PRIVATE int sqlite3Fts3Init(sqlite3 *db){
  137944. int rc = SQLITE_OK;
  137945. Fts3Hash *pHash = 0;
  137946. const sqlite3_tokenizer_module *pSimple = 0;
  137947. const sqlite3_tokenizer_module *pPorter = 0;
  137948. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  137949. const sqlite3_tokenizer_module *pUnicode = 0;
  137950. #endif
  137951. #ifdef SQLITE_ENABLE_ICU
  137952. const sqlite3_tokenizer_module *pIcu = 0;
  137953. sqlite3Fts3IcuTokenizerModule(&pIcu);
  137954. #endif
  137955. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  137956. sqlite3Fts3UnicodeTokenizer(&pUnicode);
  137957. #endif
  137958. #ifdef SQLITE_TEST
  137959. rc = sqlite3Fts3InitTerm(db);
  137960. if( rc!=SQLITE_OK ) return rc;
  137961. #endif
  137962. rc = sqlite3Fts3InitAux(db);
  137963. if( rc!=SQLITE_OK ) return rc;
  137964. sqlite3Fts3SimpleTokenizerModule(&pSimple);
  137965. sqlite3Fts3PorterTokenizerModule(&pPorter);
  137966. /* Allocate and initialize the hash-table used to store tokenizers. */
  137967. pHash = sqlite3_malloc(sizeof(Fts3Hash));
  137968. if( !pHash ){
  137969. rc = SQLITE_NOMEM;
  137970. }else{
  137971. sqlite3Fts3HashInit(pHash, FTS3_HASH_STRING, 1);
  137972. }
  137973. /* Load the built-in tokenizers into the hash table */
  137974. if( rc==SQLITE_OK ){
  137975. if( sqlite3Fts3HashInsert(pHash, "simple", 7, (void *)pSimple)
  137976. || sqlite3Fts3HashInsert(pHash, "porter", 7, (void *)pPorter)
  137977. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  137978. || sqlite3Fts3HashInsert(pHash, "unicode61", 10, (void *)pUnicode)
  137979. #endif
  137980. #ifdef SQLITE_ENABLE_ICU
  137981. || (pIcu && sqlite3Fts3HashInsert(pHash, "icu", 4, (void *)pIcu))
  137982. #endif
  137983. ){
  137984. rc = SQLITE_NOMEM;
  137985. }
  137986. }
  137987. #ifdef SQLITE_TEST
  137988. if( rc==SQLITE_OK ){
  137989. rc = sqlite3Fts3ExprInitTestInterface(db);
  137990. }
  137991. #endif
  137992. /* Create the virtual table wrapper around the hash-table and overload
  137993. ** the two scalar functions. If this is successful, register the
  137994. ** module with sqlite.
  137995. */
  137996. if( SQLITE_OK==rc
  137997. && SQLITE_OK==(rc = sqlite3Fts3InitHashTable(db, pHash, "fts3_tokenizer"))
  137998. && SQLITE_OK==(rc = sqlite3_overload_function(db, "snippet", -1))
  137999. && SQLITE_OK==(rc = sqlite3_overload_function(db, "offsets", 1))
  138000. && SQLITE_OK==(rc = sqlite3_overload_function(db, "matchinfo", 1))
  138001. && SQLITE_OK==(rc = sqlite3_overload_function(db, "matchinfo", 2))
  138002. && SQLITE_OK==(rc = sqlite3_overload_function(db, "optimize", 1))
  138003. ){
  138004. rc = sqlite3_create_module_v2(
  138005. db, "fts3", &fts3Module, (void *)pHash, hashDestroy
  138006. );
  138007. if( rc==SQLITE_OK ){
  138008. rc = sqlite3_create_module_v2(
  138009. db, "fts4", &fts3Module, (void *)pHash, 0
  138010. );
  138011. }
  138012. if( rc==SQLITE_OK ){
  138013. rc = sqlite3Fts3InitTok(db, (void *)pHash);
  138014. }
  138015. return rc;
  138016. }
  138017. /* An error has occurred. Delete the hash table and return the error code. */
  138018. assert( rc!=SQLITE_OK );
  138019. if( pHash ){
  138020. sqlite3Fts3HashClear(pHash);
  138021. sqlite3_free(pHash);
  138022. }
  138023. return rc;
  138024. }
  138025. /*
  138026. ** Allocate an Fts3MultiSegReader for each token in the expression headed
  138027. ** by pExpr.
  138028. **
  138029. ** An Fts3SegReader object is a cursor that can seek or scan a range of
  138030. ** entries within a single segment b-tree. An Fts3MultiSegReader uses multiple
  138031. ** Fts3SegReader objects internally to provide an interface to seek or scan
  138032. ** within the union of all segments of a b-tree. Hence the name.
  138033. **
  138034. ** If the allocated Fts3MultiSegReader just seeks to a single entry in a
  138035. ** segment b-tree (if the term is not a prefix or it is a prefix for which
  138036. ** there exists prefix b-tree of the right length) then it may be traversed
  138037. ** and merged incrementally. Otherwise, it has to be merged into an in-memory
  138038. ** doclist and then traversed.
  138039. */
  138040. static void fts3EvalAllocateReaders(
  138041. Fts3Cursor *pCsr, /* FTS cursor handle */
  138042. Fts3Expr *pExpr, /* Allocate readers for this expression */
  138043. int *pnToken, /* OUT: Total number of tokens in phrase. */
  138044. int *pnOr, /* OUT: Total number of OR nodes in expr. */
  138045. int *pRc /* IN/OUT: Error code */
  138046. ){
  138047. if( pExpr && SQLITE_OK==*pRc ){
  138048. if( pExpr->eType==FTSQUERY_PHRASE ){
  138049. int i;
  138050. int nToken = pExpr->pPhrase->nToken;
  138051. *pnToken += nToken;
  138052. for(i=0; i<nToken; i++){
  138053. Fts3PhraseToken *pToken = &pExpr->pPhrase->aToken[i];
  138054. int rc = fts3TermSegReaderCursor(pCsr,
  138055. pToken->z, pToken->n, pToken->isPrefix, &pToken->pSegcsr
  138056. );
  138057. if( rc!=SQLITE_OK ){
  138058. *pRc = rc;
  138059. return;
  138060. }
  138061. }
  138062. assert( pExpr->pPhrase->iDoclistToken==0 );
  138063. pExpr->pPhrase->iDoclistToken = -1;
  138064. }else{
  138065. *pnOr += (pExpr->eType==FTSQUERY_OR);
  138066. fts3EvalAllocateReaders(pCsr, pExpr->pLeft, pnToken, pnOr, pRc);
  138067. fts3EvalAllocateReaders(pCsr, pExpr->pRight, pnToken, pnOr, pRc);
  138068. }
  138069. }
  138070. }
  138071. /*
  138072. ** Arguments pList/nList contain the doclist for token iToken of phrase p.
  138073. ** It is merged into the main doclist stored in p->doclist.aAll/nAll.
  138074. **
  138075. ** This function assumes that pList points to a buffer allocated using
  138076. ** sqlite3_malloc(). This function takes responsibility for eventually
  138077. ** freeing the buffer.
  138078. **
  138079. ** SQLITE_OK is returned if successful, or SQLITE_NOMEM if an error occurs.
  138080. */
  138081. static int fts3EvalPhraseMergeToken(
  138082. Fts3Table *pTab, /* FTS Table pointer */
  138083. Fts3Phrase *p, /* Phrase to merge pList/nList into */
  138084. int iToken, /* Token pList/nList corresponds to */
  138085. char *pList, /* Pointer to doclist */
  138086. int nList /* Number of bytes in pList */
  138087. ){
  138088. int rc = SQLITE_OK;
  138089. assert( iToken!=p->iDoclistToken );
  138090. if( pList==0 ){
  138091. sqlite3_free(p->doclist.aAll);
  138092. p->doclist.aAll = 0;
  138093. p->doclist.nAll = 0;
  138094. }
  138095. else if( p->iDoclistToken<0 ){
  138096. p->doclist.aAll = pList;
  138097. p->doclist.nAll = nList;
  138098. }
  138099. else if( p->doclist.aAll==0 ){
  138100. sqlite3_free(pList);
  138101. }
  138102. else {
  138103. char *pLeft;
  138104. char *pRight;
  138105. int nLeft;
  138106. int nRight;
  138107. int nDiff;
  138108. if( p->iDoclistToken<iToken ){
  138109. pLeft = p->doclist.aAll;
  138110. nLeft = p->doclist.nAll;
  138111. pRight = pList;
  138112. nRight = nList;
  138113. nDiff = iToken - p->iDoclistToken;
  138114. }else{
  138115. pRight = p->doclist.aAll;
  138116. nRight = p->doclist.nAll;
  138117. pLeft = pList;
  138118. nLeft = nList;
  138119. nDiff = p->iDoclistToken - iToken;
  138120. }
  138121. rc = fts3DoclistPhraseMerge(
  138122. pTab->bDescIdx, nDiff, pLeft, nLeft, &pRight, &nRight
  138123. );
  138124. sqlite3_free(pLeft);
  138125. p->doclist.aAll = pRight;
  138126. p->doclist.nAll = nRight;
  138127. }
  138128. if( iToken>p->iDoclistToken ) p->iDoclistToken = iToken;
  138129. return rc;
  138130. }
  138131. /*
  138132. ** Load the doclist for phrase p into p->doclist.aAll/nAll. The loaded doclist
  138133. ** does not take deferred tokens into account.
  138134. **
  138135. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  138136. */
  138137. static int fts3EvalPhraseLoad(
  138138. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138139. Fts3Phrase *p /* Phrase object */
  138140. ){
  138141. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138142. int iToken;
  138143. int rc = SQLITE_OK;
  138144. for(iToken=0; rc==SQLITE_OK && iToken<p->nToken; iToken++){
  138145. Fts3PhraseToken *pToken = &p->aToken[iToken];
  138146. assert( pToken->pDeferred==0 || pToken->pSegcsr==0 );
  138147. if( pToken->pSegcsr ){
  138148. int nThis = 0;
  138149. char *pThis = 0;
  138150. rc = fts3TermSelect(pTab, pToken, p->iColumn, &nThis, &pThis);
  138151. if( rc==SQLITE_OK ){
  138152. rc = fts3EvalPhraseMergeToken(pTab, p, iToken, pThis, nThis);
  138153. }
  138154. }
  138155. assert( pToken->pSegcsr==0 );
  138156. }
  138157. return rc;
  138158. }
  138159. /*
  138160. ** This function is called on each phrase after the position lists for
  138161. ** any deferred tokens have been loaded into memory. It updates the phrases
  138162. ** current position list to include only those positions that are really
  138163. ** instances of the phrase (after considering deferred tokens). If this
  138164. ** means that the phrase does not appear in the current row, doclist.pList
  138165. ** and doclist.nList are both zeroed.
  138166. **
  138167. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  138168. */
  138169. static int fts3EvalDeferredPhrase(Fts3Cursor *pCsr, Fts3Phrase *pPhrase){
  138170. int iToken; /* Used to iterate through phrase tokens */
  138171. char *aPoslist = 0; /* Position list for deferred tokens */
  138172. int nPoslist = 0; /* Number of bytes in aPoslist */
  138173. int iPrev = -1; /* Token number of previous deferred token */
  138174. assert( pPhrase->doclist.bFreeList==0 );
  138175. for(iToken=0; iToken<pPhrase->nToken; iToken++){
  138176. Fts3PhraseToken *pToken = &pPhrase->aToken[iToken];
  138177. Fts3DeferredToken *pDeferred = pToken->pDeferred;
  138178. if( pDeferred ){
  138179. char *pList;
  138180. int nList;
  138181. int rc = sqlite3Fts3DeferredTokenList(pDeferred, &pList, &nList);
  138182. if( rc!=SQLITE_OK ) return rc;
  138183. if( pList==0 ){
  138184. sqlite3_free(aPoslist);
  138185. pPhrase->doclist.pList = 0;
  138186. pPhrase->doclist.nList = 0;
  138187. return SQLITE_OK;
  138188. }else if( aPoslist==0 ){
  138189. aPoslist = pList;
  138190. nPoslist = nList;
  138191. }else{
  138192. char *aOut = pList;
  138193. char *p1 = aPoslist;
  138194. char *p2 = aOut;
  138195. assert( iPrev>=0 );
  138196. fts3PoslistPhraseMerge(&aOut, iToken-iPrev, 0, 1, &p1, &p2);
  138197. sqlite3_free(aPoslist);
  138198. aPoslist = pList;
  138199. nPoslist = (int)(aOut - aPoslist);
  138200. if( nPoslist==0 ){
  138201. sqlite3_free(aPoslist);
  138202. pPhrase->doclist.pList = 0;
  138203. pPhrase->doclist.nList = 0;
  138204. return SQLITE_OK;
  138205. }
  138206. }
  138207. iPrev = iToken;
  138208. }
  138209. }
  138210. if( iPrev>=0 ){
  138211. int nMaxUndeferred = pPhrase->iDoclistToken;
  138212. if( nMaxUndeferred<0 ){
  138213. pPhrase->doclist.pList = aPoslist;
  138214. pPhrase->doclist.nList = nPoslist;
  138215. pPhrase->doclist.iDocid = pCsr->iPrevId;
  138216. pPhrase->doclist.bFreeList = 1;
  138217. }else{
  138218. int nDistance;
  138219. char *p1;
  138220. char *p2;
  138221. char *aOut;
  138222. if( nMaxUndeferred>iPrev ){
  138223. p1 = aPoslist;
  138224. p2 = pPhrase->doclist.pList;
  138225. nDistance = nMaxUndeferred - iPrev;
  138226. }else{
  138227. p1 = pPhrase->doclist.pList;
  138228. p2 = aPoslist;
  138229. nDistance = iPrev - nMaxUndeferred;
  138230. }
  138231. aOut = (char *)sqlite3_malloc(nPoslist+8);
  138232. if( !aOut ){
  138233. sqlite3_free(aPoslist);
  138234. return SQLITE_NOMEM;
  138235. }
  138236. pPhrase->doclist.pList = aOut;
  138237. if( fts3PoslistPhraseMerge(&aOut, nDistance, 0, 1, &p1, &p2) ){
  138238. pPhrase->doclist.bFreeList = 1;
  138239. pPhrase->doclist.nList = (int)(aOut - pPhrase->doclist.pList);
  138240. }else{
  138241. sqlite3_free(aOut);
  138242. pPhrase->doclist.pList = 0;
  138243. pPhrase->doclist.nList = 0;
  138244. }
  138245. sqlite3_free(aPoslist);
  138246. }
  138247. }
  138248. return SQLITE_OK;
  138249. }
  138250. /*
  138251. ** Maximum number of tokens a phrase may have to be considered for the
  138252. ** incremental doclists strategy.
  138253. */
  138254. #define MAX_INCR_PHRASE_TOKENS 4
  138255. /*
  138256. ** This function is called for each Fts3Phrase in a full-text query
  138257. ** expression to initialize the mechanism for returning rows. Once this
  138258. ** function has been called successfully on an Fts3Phrase, it may be
  138259. ** used with fts3EvalPhraseNext() to iterate through the matching docids.
  138260. **
  138261. ** If parameter bOptOk is true, then the phrase may (or may not) use the
  138262. ** incremental loading strategy. Otherwise, the entire doclist is loaded into
  138263. ** memory within this call.
  138264. **
  138265. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  138266. */
  138267. static int fts3EvalPhraseStart(Fts3Cursor *pCsr, int bOptOk, Fts3Phrase *p){
  138268. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138269. int rc = SQLITE_OK; /* Error code */
  138270. int i;
  138271. /* Determine if doclists may be loaded from disk incrementally. This is
  138272. ** possible if the bOptOk argument is true, the FTS doclists will be
  138273. ** scanned in forward order, and the phrase consists of
  138274. ** MAX_INCR_PHRASE_TOKENS or fewer tokens, none of which are are "^first"
  138275. ** tokens or prefix tokens that cannot use a prefix-index. */
  138276. int bHaveIncr = 0;
  138277. int bIncrOk = (bOptOk
  138278. && pCsr->bDesc==pTab->bDescIdx
  138279. && p->nToken<=MAX_INCR_PHRASE_TOKENS && p->nToken>0
  138280. #ifdef SQLITE_TEST
  138281. && pTab->bNoIncrDoclist==0
  138282. #endif
  138283. );
  138284. for(i=0; bIncrOk==1 && i<p->nToken; i++){
  138285. Fts3PhraseToken *pToken = &p->aToken[i];
  138286. if( pToken->bFirst || (pToken->pSegcsr!=0 && !pToken->pSegcsr->bLookup) ){
  138287. bIncrOk = 0;
  138288. }
  138289. if( pToken->pSegcsr ) bHaveIncr = 1;
  138290. }
  138291. if( bIncrOk && bHaveIncr ){
  138292. /* Use the incremental approach. */
  138293. int iCol = (p->iColumn >= pTab->nColumn ? -1 : p->iColumn);
  138294. for(i=0; rc==SQLITE_OK && i<p->nToken; i++){
  138295. Fts3PhraseToken *pToken = &p->aToken[i];
  138296. Fts3MultiSegReader *pSegcsr = pToken->pSegcsr;
  138297. if( pSegcsr ){
  138298. rc = sqlite3Fts3MsrIncrStart(pTab, pSegcsr, iCol, pToken->z, pToken->n);
  138299. }
  138300. }
  138301. p->bIncr = 1;
  138302. }else{
  138303. /* Load the full doclist for the phrase into memory. */
  138304. rc = fts3EvalPhraseLoad(pCsr, p);
  138305. p->bIncr = 0;
  138306. }
  138307. assert( rc!=SQLITE_OK || p->nToken<1 || p->aToken[0].pSegcsr==0 || p->bIncr );
  138308. return rc;
  138309. }
  138310. /*
  138311. ** This function is used to iterate backwards (from the end to start)
  138312. ** through doclists. It is used by this module to iterate through phrase
  138313. ** doclists in reverse and by the fts3_write.c module to iterate through
  138314. ** pending-terms lists when writing to databases with "order=desc".
  138315. **
  138316. ** The doclist may be sorted in ascending (parameter bDescIdx==0) or
  138317. ** descending (parameter bDescIdx==1) order of docid. Regardless, this
  138318. ** function iterates from the end of the doclist to the beginning.
  138319. */
  138320. SQLITE_PRIVATE void sqlite3Fts3DoclistPrev(
  138321. int bDescIdx, /* True if the doclist is desc */
  138322. char *aDoclist, /* Pointer to entire doclist */
  138323. int nDoclist, /* Length of aDoclist in bytes */
  138324. char **ppIter, /* IN/OUT: Iterator pointer */
  138325. sqlite3_int64 *piDocid, /* IN/OUT: Docid pointer */
  138326. int *pnList, /* OUT: List length pointer */
  138327. u8 *pbEof /* OUT: End-of-file flag */
  138328. ){
  138329. char *p = *ppIter;
  138330. assert( nDoclist>0 );
  138331. assert( *pbEof==0 );
  138332. assert( p || *piDocid==0 );
  138333. assert( !p || (p>aDoclist && p<&aDoclist[nDoclist]) );
  138334. if( p==0 ){
  138335. sqlite3_int64 iDocid = 0;
  138336. char *pNext = 0;
  138337. char *pDocid = aDoclist;
  138338. char *pEnd = &aDoclist[nDoclist];
  138339. int iMul = 1;
  138340. while( pDocid<pEnd ){
  138341. sqlite3_int64 iDelta;
  138342. pDocid += sqlite3Fts3GetVarint(pDocid, &iDelta);
  138343. iDocid += (iMul * iDelta);
  138344. pNext = pDocid;
  138345. fts3PoslistCopy(0, &pDocid);
  138346. while( pDocid<pEnd && *pDocid==0 ) pDocid++;
  138347. iMul = (bDescIdx ? -1 : 1);
  138348. }
  138349. *pnList = (int)(pEnd - pNext);
  138350. *ppIter = pNext;
  138351. *piDocid = iDocid;
  138352. }else{
  138353. int iMul = (bDescIdx ? -1 : 1);
  138354. sqlite3_int64 iDelta;
  138355. fts3GetReverseVarint(&p, aDoclist, &iDelta);
  138356. *piDocid -= (iMul * iDelta);
  138357. if( p==aDoclist ){
  138358. *pbEof = 1;
  138359. }else{
  138360. char *pSave = p;
  138361. fts3ReversePoslist(aDoclist, &p);
  138362. *pnList = (int)(pSave - p);
  138363. }
  138364. *ppIter = p;
  138365. }
  138366. }
  138367. /*
  138368. ** Iterate forwards through a doclist.
  138369. */
  138370. SQLITE_PRIVATE void sqlite3Fts3DoclistNext(
  138371. int bDescIdx, /* True if the doclist is desc */
  138372. char *aDoclist, /* Pointer to entire doclist */
  138373. int nDoclist, /* Length of aDoclist in bytes */
  138374. char **ppIter, /* IN/OUT: Iterator pointer */
  138375. sqlite3_int64 *piDocid, /* IN/OUT: Docid pointer */
  138376. u8 *pbEof /* OUT: End-of-file flag */
  138377. ){
  138378. char *p = *ppIter;
  138379. assert( nDoclist>0 );
  138380. assert( *pbEof==0 );
  138381. assert( p || *piDocid==0 );
  138382. assert( !p || (p>=aDoclist && p<=&aDoclist[nDoclist]) );
  138383. if( p==0 ){
  138384. p = aDoclist;
  138385. p += sqlite3Fts3GetVarint(p, piDocid);
  138386. }else{
  138387. fts3PoslistCopy(0, &p);
  138388. while( p<&aDoclist[nDoclist] && *p==0 ) p++;
  138389. if( p>=&aDoclist[nDoclist] ){
  138390. *pbEof = 1;
  138391. }else{
  138392. sqlite3_int64 iVar;
  138393. p += sqlite3Fts3GetVarint(p, &iVar);
  138394. *piDocid += ((bDescIdx ? -1 : 1) * iVar);
  138395. }
  138396. }
  138397. *ppIter = p;
  138398. }
  138399. /*
  138400. ** Advance the iterator pDL to the next entry in pDL->aAll/nAll. Set *pbEof
  138401. ** to true if EOF is reached.
  138402. */
  138403. static void fts3EvalDlPhraseNext(
  138404. Fts3Table *pTab,
  138405. Fts3Doclist *pDL,
  138406. u8 *pbEof
  138407. ){
  138408. char *pIter; /* Used to iterate through aAll */
  138409. char *pEnd = &pDL->aAll[pDL->nAll]; /* 1 byte past end of aAll */
  138410. if( pDL->pNextDocid ){
  138411. pIter = pDL->pNextDocid;
  138412. }else{
  138413. pIter = pDL->aAll;
  138414. }
  138415. if( pIter>=pEnd ){
  138416. /* We have already reached the end of this doclist. EOF. */
  138417. *pbEof = 1;
  138418. }else{
  138419. sqlite3_int64 iDelta;
  138420. pIter += sqlite3Fts3GetVarint(pIter, &iDelta);
  138421. if( pTab->bDescIdx==0 || pDL->pNextDocid==0 ){
  138422. pDL->iDocid += iDelta;
  138423. }else{
  138424. pDL->iDocid -= iDelta;
  138425. }
  138426. pDL->pList = pIter;
  138427. fts3PoslistCopy(0, &pIter);
  138428. pDL->nList = (int)(pIter - pDL->pList);
  138429. /* pIter now points just past the 0x00 that terminates the position-
  138430. ** list for document pDL->iDocid. However, if this position-list was
  138431. ** edited in place by fts3EvalNearTrim(), then pIter may not actually
  138432. ** point to the start of the next docid value. The following line deals
  138433. ** with this case by advancing pIter past the zero-padding added by
  138434. ** fts3EvalNearTrim(). */
  138435. while( pIter<pEnd && *pIter==0 ) pIter++;
  138436. pDL->pNextDocid = pIter;
  138437. assert( pIter>=&pDL->aAll[pDL->nAll] || *pIter );
  138438. *pbEof = 0;
  138439. }
  138440. }
  138441. /*
  138442. ** Helper type used by fts3EvalIncrPhraseNext() and incrPhraseTokenNext().
  138443. */
  138444. typedef struct TokenDoclist TokenDoclist;
  138445. struct TokenDoclist {
  138446. int bIgnore;
  138447. sqlite3_int64 iDocid;
  138448. char *pList;
  138449. int nList;
  138450. };
  138451. /*
  138452. ** Token pToken is an incrementally loaded token that is part of a
  138453. ** multi-token phrase. Advance it to the next matching document in the
  138454. ** database and populate output variable *p with the details of the new
  138455. ** entry. Or, if the iterator has reached EOF, set *pbEof to true.
  138456. **
  138457. ** If an error occurs, return an SQLite error code. Otherwise, return
  138458. ** SQLITE_OK.
  138459. */
  138460. static int incrPhraseTokenNext(
  138461. Fts3Table *pTab, /* Virtual table handle */
  138462. Fts3Phrase *pPhrase, /* Phrase to advance token of */
  138463. int iToken, /* Specific token to advance */
  138464. TokenDoclist *p, /* OUT: Docid and doclist for new entry */
  138465. u8 *pbEof /* OUT: True if iterator is at EOF */
  138466. ){
  138467. int rc = SQLITE_OK;
  138468. if( pPhrase->iDoclistToken==iToken ){
  138469. assert( p->bIgnore==0 );
  138470. assert( pPhrase->aToken[iToken].pSegcsr==0 );
  138471. fts3EvalDlPhraseNext(pTab, &pPhrase->doclist, pbEof);
  138472. p->pList = pPhrase->doclist.pList;
  138473. p->nList = pPhrase->doclist.nList;
  138474. p->iDocid = pPhrase->doclist.iDocid;
  138475. }else{
  138476. Fts3PhraseToken *pToken = &pPhrase->aToken[iToken];
  138477. assert( pToken->pDeferred==0 );
  138478. assert( pToken->pSegcsr || pPhrase->iDoclistToken>=0 );
  138479. if( pToken->pSegcsr ){
  138480. assert( p->bIgnore==0 );
  138481. rc = sqlite3Fts3MsrIncrNext(
  138482. pTab, pToken->pSegcsr, &p->iDocid, &p->pList, &p->nList
  138483. );
  138484. if( p->pList==0 ) *pbEof = 1;
  138485. }else{
  138486. p->bIgnore = 1;
  138487. }
  138488. }
  138489. return rc;
  138490. }
  138491. /*
  138492. ** The phrase iterator passed as the second argument:
  138493. **
  138494. ** * features at least one token that uses an incremental doclist, and
  138495. **
  138496. ** * does not contain any deferred tokens.
  138497. **
  138498. ** Advance it to the next matching documnent in the database and populate
  138499. ** the Fts3Doclist.pList and nList fields.
  138500. **
  138501. ** If there is no "next" entry and no error occurs, then *pbEof is set to
  138502. ** 1 before returning. Otherwise, if no error occurs and the iterator is
  138503. ** successfully advanced, *pbEof is set to 0.
  138504. **
  138505. ** If an error occurs, return an SQLite error code. Otherwise, return
  138506. ** SQLITE_OK.
  138507. */
  138508. static int fts3EvalIncrPhraseNext(
  138509. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138510. Fts3Phrase *p, /* Phrase object to advance to next docid */
  138511. u8 *pbEof /* OUT: Set to 1 if EOF */
  138512. ){
  138513. int rc = SQLITE_OK;
  138514. Fts3Doclist *pDL = &p->doclist;
  138515. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138516. u8 bEof = 0;
  138517. /* This is only called if it is guaranteed that the phrase has at least
  138518. ** one incremental token. In which case the bIncr flag is set. */
  138519. assert( p->bIncr==1 );
  138520. if( p->nToken==1 && p->bIncr ){
  138521. rc = sqlite3Fts3MsrIncrNext(pTab, p->aToken[0].pSegcsr,
  138522. &pDL->iDocid, &pDL->pList, &pDL->nList
  138523. );
  138524. if( pDL->pList==0 ) bEof = 1;
  138525. }else{
  138526. int bDescDoclist = pCsr->bDesc;
  138527. struct TokenDoclist a[MAX_INCR_PHRASE_TOKENS];
  138528. memset(a, 0, sizeof(a));
  138529. assert( p->nToken<=MAX_INCR_PHRASE_TOKENS );
  138530. assert( p->iDoclistToken<MAX_INCR_PHRASE_TOKENS );
  138531. while( bEof==0 ){
  138532. int bMaxSet = 0;
  138533. sqlite3_int64 iMax = 0; /* Largest docid for all iterators */
  138534. int i; /* Used to iterate through tokens */
  138535. /* Advance the iterator for each token in the phrase once. */
  138536. for(i=0; rc==SQLITE_OK && i<p->nToken && bEof==0; i++){
  138537. rc = incrPhraseTokenNext(pTab, p, i, &a[i], &bEof);
  138538. if( a[i].bIgnore==0 && (bMaxSet==0 || DOCID_CMP(iMax, a[i].iDocid)<0) ){
  138539. iMax = a[i].iDocid;
  138540. bMaxSet = 1;
  138541. }
  138542. }
  138543. assert( rc!=SQLITE_OK || (p->nToken>=1 && a[p->nToken-1].bIgnore==0) );
  138544. assert( rc!=SQLITE_OK || bMaxSet );
  138545. /* Keep advancing iterators until they all point to the same document */
  138546. for(i=0; i<p->nToken; i++){
  138547. while( rc==SQLITE_OK && bEof==0
  138548. && a[i].bIgnore==0 && DOCID_CMP(a[i].iDocid, iMax)<0
  138549. ){
  138550. rc = incrPhraseTokenNext(pTab, p, i, &a[i], &bEof);
  138551. if( DOCID_CMP(a[i].iDocid, iMax)>0 ){
  138552. iMax = a[i].iDocid;
  138553. i = 0;
  138554. }
  138555. }
  138556. }
  138557. /* Check if the current entries really are a phrase match */
  138558. if( bEof==0 ){
  138559. int nList = 0;
  138560. int nByte = a[p->nToken-1].nList;
  138561. char *aDoclist = sqlite3_malloc(nByte+1);
  138562. if( !aDoclist ) return SQLITE_NOMEM;
  138563. memcpy(aDoclist, a[p->nToken-1].pList, nByte+1);
  138564. for(i=0; i<(p->nToken-1); i++){
  138565. if( a[i].bIgnore==0 ){
  138566. char *pL = a[i].pList;
  138567. char *pR = aDoclist;
  138568. char *pOut = aDoclist;
  138569. int nDist = p->nToken-1-i;
  138570. int res = fts3PoslistPhraseMerge(&pOut, nDist, 0, 1, &pL, &pR);
  138571. if( res==0 ) break;
  138572. nList = (int)(pOut - aDoclist);
  138573. }
  138574. }
  138575. if( i==(p->nToken-1) ){
  138576. pDL->iDocid = iMax;
  138577. pDL->pList = aDoclist;
  138578. pDL->nList = nList;
  138579. pDL->bFreeList = 1;
  138580. break;
  138581. }
  138582. sqlite3_free(aDoclist);
  138583. }
  138584. }
  138585. }
  138586. *pbEof = bEof;
  138587. return rc;
  138588. }
  138589. /*
  138590. ** Attempt to move the phrase iterator to point to the next matching docid.
  138591. ** If an error occurs, return an SQLite error code. Otherwise, return
  138592. ** SQLITE_OK.
  138593. **
  138594. ** If there is no "next" entry and no error occurs, then *pbEof is set to
  138595. ** 1 before returning. Otherwise, if no error occurs and the iterator is
  138596. ** successfully advanced, *pbEof is set to 0.
  138597. */
  138598. static int fts3EvalPhraseNext(
  138599. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138600. Fts3Phrase *p, /* Phrase object to advance to next docid */
  138601. u8 *pbEof /* OUT: Set to 1 if EOF */
  138602. ){
  138603. int rc = SQLITE_OK;
  138604. Fts3Doclist *pDL = &p->doclist;
  138605. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138606. if( p->bIncr ){
  138607. rc = fts3EvalIncrPhraseNext(pCsr, p, pbEof);
  138608. }else if( pCsr->bDesc!=pTab->bDescIdx && pDL->nAll ){
  138609. sqlite3Fts3DoclistPrev(pTab->bDescIdx, pDL->aAll, pDL->nAll,
  138610. &pDL->pNextDocid, &pDL->iDocid, &pDL->nList, pbEof
  138611. );
  138612. pDL->pList = pDL->pNextDocid;
  138613. }else{
  138614. fts3EvalDlPhraseNext(pTab, pDL, pbEof);
  138615. }
  138616. return rc;
  138617. }
  138618. /*
  138619. **
  138620. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  138621. ** Otherwise, fts3EvalPhraseStart() is called on all phrases within the
  138622. ** expression. Also the Fts3Expr.bDeferred variable is set to true for any
  138623. ** expressions for which all descendent tokens are deferred.
  138624. **
  138625. ** If parameter bOptOk is zero, then it is guaranteed that the
  138626. ** Fts3Phrase.doclist.aAll/nAll variables contain the entire doclist for
  138627. ** each phrase in the expression (subject to deferred token processing).
  138628. ** Or, if bOptOk is non-zero, then one or more tokens within the expression
  138629. ** may be loaded incrementally, meaning doclist.aAll/nAll is not available.
  138630. **
  138631. ** If an error occurs within this function, *pRc is set to an SQLite error
  138632. ** code before returning.
  138633. */
  138634. static void fts3EvalStartReaders(
  138635. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138636. Fts3Expr *pExpr, /* Expression to initialize phrases in */
  138637. int *pRc /* IN/OUT: Error code */
  138638. ){
  138639. if( pExpr && SQLITE_OK==*pRc ){
  138640. if( pExpr->eType==FTSQUERY_PHRASE ){
  138641. int nToken = pExpr->pPhrase->nToken;
  138642. if( nToken ){
  138643. int i;
  138644. for(i=0; i<nToken; i++){
  138645. if( pExpr->pPhrase->aToken[i].pDeferred==0 ) break;
  138646. }
  138647. pExpr->bDeferred = (i==nToken);
  138648. }
  138649. *pRc = fts3EvalPhraseStart(pCsr, 1, pExpr->pPhrase);
  138650. }else{
  138651. fts3EvalStartReaders(pCsr, pExpr->pLeft, pRc);
  138652. fts3EvalStartReaders(pCsr, pExpr->pRight, pRc);
  138653. pExpr->bDeferred = (pExpr->pLeft->bDeferred && pExpr->pRight->bDeferred);
  138654. }
  138655. }
  138656. }
  138657. /*
  138658. ** An array of the following structures is assembled as part of the process
  138659. ** of selecting tokens to defer before the query starts executing (as part
  138660. ** of the xFilter() method). There is one element in the array for each
  138661. ** token in the FTS expression.
  138662. **
  138663. ** Tokens are divided into AND/NEAR clusters. All tokens in a cluster belong
  138664. ** to phrases that are connected only by AND and NEAR operators (not OR or
  138665. ** NOT). When determining tokens to defer, each AND/NEAR cluster is considered
  138666. ** separately. The root of a tokens AND/NEAR cluster is stored in
  138667. ** Fts3TokenAndCost.pRoot.
  138668. */
  138669. typedef struct Fts3TokenAndCost Fts3TokenAndCost;
  138670. struct Fts3TokenAndCost {
  138671. Fts3Phrase *pPhrase; /* The phrase the token belongs to */
  138672. int iToken; /* Position of token in phrase */
  138673. Fts3PhraseToken *pToken; /* The token itself */
  138674. Fts3Expr *pRoot; /* Root of NEAR/AND cluster */
  138675. int nOvfl; /* Number of overflow pages to load doclist */
  138676. int iCol; /* The column the token must match */
  138677. };
  138678. /*
  138679. ** This function is used to populate an allocated Fts3TokenAndCost array.
  138680. **
  138681. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  138682. ** Otherwise, if an error occurs during execution, *pRc is set to an
  138683. ** SQLite error code.
  138684. */
  138685. static void fts3EvalTokenCosts(
  138686. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138687. Fts3Expr *pRoot, /* Root of current AND/NEAR cluster */
  138688. Fts3Expr *pExpr, /* Expression to consider */
  138689. Fts3TokenAndCost **ppTC, /* Write new entries to *(*ppTC)++ */
  138690. Fts3Expr ***ppOr, /* Write new OR root to *(*ppOr)++ */
  138691. int *pRc /* IN/OUT: Error code */
  138692. ){
  138693. if( *pRc==SQLITE_OK ){
  138694. if( pExpr->eType==FTSQUERY_PHRASE ){
  138695. Fts3Phrase *pPhrase = pExpr->pPhrase;
  138696. int i;
  138697. for(i=0; *pRc==SQLITE_OK && i<pPhrase->nToken; i++){
  138698. Fts3TokenAndCost *pTC = (*ppTC)++;
  138699. pTC->pPhrase = pPhrase;
  138700. pTC->iToken = i;
  138701. pTC->pRoot = pRoot;
  138702. pTC->pToken = &pPhrase->aToken[i];
  138703. pTC->iCol = pPhrase->iColumn;
  138704. *pRc = sqlite3Fts3MsrOvfl(pCsr, pTC->pToken->pSegcsr, &pTC->nOvfl);
  138705. }
  138706. }else if( pExpr->eType!=FTSQUERY_NOT ){
  138707. assert( pExpr->eType==FTSQUERY_OR
  138708. || pExpr->eType==FTSQUERY_AND
  138709. || pExpr->eType==FTSQUERY_NEAR
  138710. );
  138711. assert( pExpr->pLeft && pExpr->pRight );
  138712. if( pExpr->eType==FTSQUERY_OR ){
  138713. pRoot = pExpr->pLeft;
  138714. **ppOr = pRoot;
  138715. (*ppOr)++;
  138716. }
  138717. fts3EvalTokenCosts(pCsr, pRoot, pExpr->pLeft, ppTC, ppOr, pRc);
  138718. if( pExpr->eType==FTSQUERY_OR ){
  138719. pRoot = pExpr->pRight;
  138720. **ppOr = pRoot;
  138721. (*ppOr)++;
  138722. }
  138723. fts3EvalTokenCosts(pCsr, pRoot, pExpr->pRight, ppTC, ppOr, pRc);
  138724. }
  138725. }
  138726. }
  138727. /*
  138728. ** Determine the average document (row) size in pages. If successful,
  138729. ** write this value to *pnPage and return SQLITE_OK. Otherwise, return
  138730. ** an SQLite error code.
  138731. **
  138732. ** The average document size in pages is calculated by first calculating
  138733. ** determining the average size in bytes, B. If B is less than the amount
  138734. ** of data that will fit on a single leaf page of an intkey table in
  138735. ** this database, then the average docsize is 1. Otherwise, it is 1 plus
  138736. ** the number of overflow pages consumed by a record B bytes in size.
  138737. */
  138738. static int fts3EvalAverageDocsize(Fts3Cursor *pCsr, int *pnPage){
  138739. if( pCsr->nRowAvg==0 ){
  138740. /* The average document size, which is required to calculate the cost
  138741. ** of each doclist, has not yet been determined. Read the required
  138742. ** data from the %_stat table to calculate it.
  138743. **
  138744. ** Entry 0 of the %_stat table is a blob containing (nCol+1) FTS3
  138745. ** varints, where nCol is the number of columns in the FTS3 table.
  138746. ** The first varint is the number of documents currently stored in
  138747. ** the table. The following nCol varints contain the total amount of
  138748. ** data stored in all rows of each column of the table, from left
  138749. ** to right.
  138750. */
  138751. int rc;
  138752. Fts3Table *p = (Fts3Table*)pCsr->base.pVtab;
  138753. sqlite3_stmt *pStmt;
  138754. sqlite3_int64 nDoc = 0;
  138755. sqlite3_int64 nByte = 0;
  138756. const char *pEnd;
  138757. const char *a;
  138758. rc = sqlite3Fts3SelectDoctotal(p, &pStmt);
  138759. if( rc!=SQLITE_OK ) return rc;
  138760. a = sqlite3_column_blob(pStmt, 0);
  138761. assert( a );
  138762. pEnd = &a[sqlite3_column_bytes(pStmt, 0)];
  138763. a += sqlite3Fts3GetVarint(a, &nDoc);
  138764. while( a<pEnd ){
  138765. a += sqlite3Fts3GetVarint(a, &nByte);
  138766. }
  138767. if( nDoc==0 || nByte==0 ){
  138768. sqlite3_reset(pStmt);
  138769. return FTS_CORRUPT_VTAB;
  138770. }
  138771. pCsr->nDoc = nDoc;
  138772. pCsr->nRowAvg = (int)(((nByte / nDoc) + p->nPgsz) / p->nPgsz);
  138773. assert( pCsr->nRowAvg>0 );
  138774. rc = sqlite3_reset(pStmt);
  138775. if( rc!=SQLITE_OK ) return rc;
  138776. }
  138777. *pnPage = pCsr->nRowAvg;
  138778. return SQLITE_OK;
  138779. }
  138780. /*
  138781. ** This function is called to select the tokens (if any) that will be
  138782. ** deferred. The array aTC[] has already been populated when this is
  138783. ** called.
  138784. **
  138785. ** This function is called once for each AND/NEAR cluster in the
  138786. ** expression. Each invocation determines which tokens to defer within
  138787. ** the cluster with root node pRoot. See comments above the definition
  138788. ** of struct Fts3TokenAndCost for more details.
  138789. **
  138790. ** If no error occurs, SQLITE_OK is returned and sqlite3Fts3DeferToken()
  138791. ** called on each token to defer. Otherwise, an SQLite error code is
  138792. ** returned.
  138793. */
  138794. static int fts3EvalSelectDeferred(
  138795. Fts3Cursor *pCsr, /* FTS Cursor handle */
  138796. Fts3Expr *pRoot, /* Consider tokens with this root node */
  138797. Fts3TokenAndCost *aTC, /* Array of expression tokens and costs */
  138798. int nTC /* Number of entries in aTC[] */
  138799. ){
  138800. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138801. int nDocSize = 0; /* Number of pages per doc loaded */
  138802. int rc = SQLITE_OK; /* Return code */
  138803. int ii; /* Iterator variable for various purposes */
  138804. int nOvfl = 0; /* Total overflow pages used by doclists */
  138805. int nToken = 0; /* Total number of tokens in cluster */
  138806. int nMinEst = 0; /* The minimum count for any phrase so far. */
  138807. int nLoad4 = 1; /* (Phrases that will be loaded)^4. */
  138808. /* Tokens are never deferred for FTS tables created using the content=xxx
  138809. ** option. The reason being that it is not guaranteed that the content
  138810. ** table actually contains the same data as the index. To prevent this from
  138811. ** causing any problems, the deferred token optimization is completely
  138812. ** disabled for content=xxx tables. */
  138813. if( pTab->zContentTbl ){
  138814. return SQLITE_OK;
  138815. }
  138816. /* Count the tokens in this AND/NEAR cluster. If none of the doclists
  138817. ** associated with the tokens spill onto overflow pages, or if there is
  138818. ** only 1 token, exit early. No tokens to defer in this case. */
  138819. for(ii=0; ii<nTC; ii++){
  138820. if( aTC[ii].pRoot==pRoot ){
  138821. nOvfl += aTC[ii].nOvfl;
  138822. nToken++;
  138823. }
  138824. }
  138825. if( nOvfl==0 || nToken<2 ) return SQLITE_OK;
  138826. /* Obtain the average docsize (in pages). */
  138827. rc = fts3EvalAverageDocsize(pCsr, &nDocSize);
  138828. assert( rc!=SQLITE_OK || nDocSize>0 );
  138829. /* Iterate through all tokens in this AND/NEAR cluster, in ascending order
  138830. ** of the number of overflow pages that will be loaded by the pager layer
  138831. ** to retrieve the entire doclist for the token from the full-text index.
  138832. ** Load the doclists for tokens that are either:
  138833. **
  138834. ** a. The cheapest token in the entire query (i.e. the one visited by the
  138835. ** first iteration of this loop), or
  138836. **
  138837. ** b. Part of a multi-token phrase.
  138838. **
  138839. ** After each token doclist is loaded, merge it with the others from the
  138840. ** same phrase and count the number of documents that the merged doclist
  138841. ** contains. Set variable "nMinEst" to the smallest number of documents in
  138842. ** any phrase doclist for which 1 or more token doclists have been loaded.
  138843. ** Let nOther be the number of other phrases for which it is certain that
  138844. ** one or more tokens will not be deferred.
  138845. **
  138846. ** Then, for each token, defer it if loading the doclist would result in
  138847. ** loading N or more overflow pages into memory, where N is computed as:
  138848. **
  138849. ** (nMinEst + 4^nOther - 1) / (4^nOther)
  138850. */
  138851. for(ii=0; ii<nToken && rc==SQLITE_OK; ii++){
  138852. int iTC; /* Used to iterate through aTC[] array. */
  138853. Fts3TokenAndCost *pTC = 0; /* Set to cheapest remaining token. */
  138854. /* Set pTC to point to the cheapest remaining token. */
  138855. for(iTC=0; iTC<nTC; iTC++){
  138856. if( aTC[iTC].pToken && aTC[iTC].pRoot==pRoot
  138857. && (!pTC || aTC[iTC].nOvfl<pTC->nOvfl)
  138858. ){
  138859. pTC = &aTC[iTC];
  138860. }
  138861. }
  138862. assert( pTC );
  138863. if( ii && pTC->nOvfl>=((nMinEst+(nLoad4/4)-1)/(nLoad4/4))*nDocSize ){
  138864. /* The number of overflow pages to load for this (and therefore all
  138865. ** subsequent) tokens is greater than the estimated number of pages
  138866. ** that will be loaded if all subsequent tokens are deferred.
  138867. */
  138868. Fts3PhraseToken *pToken = pTC->pToken;
  138869. rc = sqlite3Fts3DeferToken(pCsr, pToken, pTC->iCol);
  138870. fts3SegReaderCursorFree(pToken->pSegcsr);
  138871. pToken->pSegcsr = 0;
  138872. }else{
  138873. /* Set nLoad4 to the value of (4^nOther) for the next iteration of the
  138874. ** for-loop. Except, limit the value to 2^24 to prevent it from
  138875. ** overflowing the 32-bit integer it is stored in. */
  138876. if( ii<12 ) nLoad4 = nLoad4*4;
  138877. if( ii==0 || (pTC->pPhrase->nToken>1 && ii!=nToken-1) ){
  138878. /* Either this is the cheapest token in the entire query, or it is
  138879. ** part of a multi-token phrase. Either way, the entire doclist will
  138880. ** (eventually) be loaded into memory. It may as well be now. */
  138881. Fts3PhraseToken *pToken = pTC->pToken;
  138882. int nList = 0;
  138883. char *pList = 0;
  138884. rc = fts3TermSelect(pTab, pToken, pTC->iCol, &nList, &pList);
  138885. assert( rc==SQLITE_OK || pList==0 );
  138886. if( rc==SQLITE_OK ){
  138887. rc = fts3EvalPhraseMergeToken(
  138888. pTab, pTC->pPhrase, pTC->iToken,pList,nList
  138889. );
  138890. }
  138891. if( rc==SQLITE_OK ){
  138892. int nCount;
  138893. nCount = fts3DoclistCountDocids(
  138894. pTC->pPhrase->doclist.aAll, pTC->pPhrase->doclist.nAll
  138895. );
  138896. if( ii==0 || nCount<nMinEst ) nMinEst = nCount;
  138897. }
  138898. }
  138899. }
  138900. pTC->pToken = 0;
  138901. }
  138902. return rc;
  138903. }
  138904. /*
  138905. ** This function is called from within the xFilter method. It initializes
  138906. ** the full-text query currently stored in pCsr->pExpr. To iterate through
  138907. ** the results of a query, the caller does:
  138908. **
  138909. ** fts3EvalStart(pCsr);
  138910. ** while( 1 ){
  138911. ** fts3EvalNext(pCsr);
  138912. ** if( pCsr->bEof ) break;
  138913. ** ... return row pCsr->iPrevId to the caller ...
  138914. ** }
  138915. */
  138916. static int fts3EvalStart(Fts3Cursor *pCsr){
  138917. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  138918. int rc = SQLITE_OK;
  138919. int nToken = 0;
  138920. int nOr = 0;
  138921. /* Allocate a MultiSegReader for each token in the expression. */
  138922. fts3EvalAllocateReaders(pCsr, pCsr->pExpr, &nToken, &nOr, &rc);
  138923. /* Determine which, if any, tokens in the expression should be deferred. */
  138924. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  138925. if( rc==SQLITE_OK && nToken>1 && pTab->bFts4 ){
  138926. Fts3TokenAndCost *aTC;
  138927. Fts3Expr **apOr;
  138928. aTC = (Fts3TokenAndCost *)sqlite3_malloc(
  138929. sizeof(Fts3TokenAndCost) * nToken
  138930. + sizeof(Fts3Expr *) * nOr * 2
  138931. );
  138932. apOr = (Fts3Expr **)&aTC[nToken];
  138933. if( !aTC ){
  138934. rc = SQLITE_NOMEM;
  138935. }else{
  138936. int ii;
  138937. Fts3TokenAndCost *pTC = aTC;
  138938. Fts3Expr **ppOr = apOr;
  138939. fts3EvalTokenCosts(pCsr, 0, pCsr->pExpr, &pTC, &ppOr, &rc);
  138940. nToken = (int)(pTC-aTC);
  138941. nOr = (int)(ppOr-apOr);
  138942. if( rc==SQLITE_OK ){
  138943. rc = fts3EvalSelectDeferred(pCsr, 0, aTC, nToken);
  138944. for(ii=0; rc==SQLITE_OK && ii<nOr; ii++){
  138945. rc = fts3EvalSelectDeferred(pCsr, apOr[ii], aTC, nToken);
  138946. }
  138947. }
  138948. sqlite3_free(aTC);
  138949. }
  138950. }
  138951. #endif
  138952. fts3EvalStartReaders(pCsr, pCsr->pExpr, &rc);
  138953. return rc;
  138954. }
  138955. /*
  138956. ** Invalidate the current position list for phrase pPhrase.
  138957. */
  138958. static void fts3EvalInvalidatePoslist(Fts3Phrase *pPhrase){
  138959. if( pPhrase->doclist.bFreeList ){
  138960. sqlite3_free(pPhrase->doclist.pList);
  138961. }
  138962. pPhrase->doclist.pList = 0;
  138963. pPhrase->doclist.nList = 0;
  138964. pPhrase->doclist.bFreeList = 0;
  138965. }
  138966. /*
  138967. ** This function is called to edit the position list associated with
  138968. ** the phrase object passed as the fifth argument according to a NEAR
  138969. ** condition. For example:
  138970. **
  138971. ** abc NEAR/5 "def ghi"
  138972. **
  138973. ** Parameter nNear is passed the NEAR distance of the expression (5 in
  138974. ** the example above). When this function is called, *paPoslist points to
  138975. ** the position list, and *pnToken is the number of phrase tokens in, the
  138976. ** phrase on the other side of the NEAR operator to pPhrase. For example,
  138977. ** if pPhrase refers to the "def ghi" phrase, then *paPoslist points to
  138978. ** the position list associated with phrase "abc".
  138979. **
  138980. ** All positions in the pPhrase position list that are not sufficiently
  138981. ** close to a position in the *paPoslist position list are removed. If this
  138982. ** leaves 0 positions, zero is returned. Otherwise, non-zero.
  138983. **
  138984. ** Before returning, *paPoslist is set to point to the position lsit
  138985. ** associated with pPhrase. And *pnToken is set to the number of tokens in
  138986. ** pPhrase.
  138987. */
  138988. static int fts3EvalNearTrim(
  138989. int nNear, /* NEAR distance. As in "NEAR/nNear". */
  138990. char *aTmp, /* Temporary space to use */
  138991. char **paPoslist, /* IN/OUT: Position list */
  138992. int *pnToken, /* IN/OUT: Tokens in phrase of *paPoslist */
  138993. Fts3Phrase *pPhrase /* The phrase object to trim the doclist of */
  138994. ){
  138995. int nParam1 = nNear + pPhrase->nToken;
  138996. int nParam2 = nNear + *pnToken;
  138997. int nNew;
  138998. char *p2;
  138999. char *pOut;
  139000. int res;
  139001. assert( pPhrase->doclist.pList );
  139002. p2 = pOut = pPhrase->doclist.pList;
  139003. res = fts3PoslistNearMerge(
  139004. &pOut, aTmp, nParam1, nParam2, paPoslist, &p2
  139005. );
  139006. if( res ){
  139007. nNew = (int)(pOut - pPhrase->doclist.pList) - 1;
  139008. assert( pPhrase->doclist.pList[nNew]=='\0' );
  139009. assert( nNew<=pPhrase->doclist.nList && nNew>0 );
  139010. memset(&pPhrase->doclist.pList[nNew], 0, pPhrase->doclist.nList - nNew);
  139011. pPhrase->doclist.nList = nNew;
  139012. *paPoslist = pPhrase->doclist.pList;
  139013. *pnToken = pPhrase->nToken;
  139014. }
  139015. return res;
  139016. }
  139017. /*
  139018. ** This function is a no-op if *pRc is other than SQLITE_OK when it is called.
  139019. ** Otherwise, it advances the expression passed as the second argument to
  139020. ** point to the next matching row in the database. Expressions iterate through
  139021. ** matching rows in docid order. Ascending order if Fts3Cursor.bDesc is zero,
  139022. ** or descending if it is non-zero.
  139023. **
  139024. ** If an error occurs, *pRc is set to an SQLite error code. Otherwise, if
  139025. ** successful, the following variables in pExpr are set:
  139026. **
  139027. ** Fts3Expr.bEof (non-zero if EOF - there is no next row)
  139028. ** Fts3Expr.iDocid (valid if bEof==0. The docid of the next row)
  139029. **
  139030. ** If the expression is of type FTSQUERY_PHRASE, and the expression is not
  139031. ** at EOF, then the following variables are populated with the position list
  139032. ** for the phrase for the visited row:
  139033. **
  139034. ** FTs3Expr.pPhrase->doclist.nList (length of pList in bytes)
  139035. ** FTs3Expr.pPhrase->doclist.pList (pointer to position list)
  139036. **
  139037. ** It says above that this function advances the expression to the next
  139038. ** matching row. This is usually true, but there are the following exceptions:
  139039. **
  139040. ** 1. Deferred tokens are not taken into account. If a phrase consists
  139041. ** entirely of deferred tokens, it is assumed to match every row in
  139042. ** the db. In this case the position-list is not populated at all.
  139043. **
  139044. ** Or, if a phrase contains one or more deferred tokens and one or
  139045. ** more non-deferred tokens, then the expression is advanced to the
  139046. ** next possible match, considering only non-deferred tokens. In other
  139047. ** words, if the phrase is "A B C", and "B" is deferred, the expression
  139048. ** is advanced to the next row that contains an instance of "A * C",
  139049. ** where "*" may match any single token. The position list in this case
  139050. ** is populated as for "A * C" before returning.
  139051. **
  139052. ** 2. NEAR is treated as AND. If the expression is "x NEAR y", it is
  139053. ** advanced to point to the next row that matches "x AND y".
  139054. **
  139055. ** See sqlite3Fts3EvalTestDeferred() for details on testing if a row is
  139056. ** really a match, taking into account deferred tokens and NEAR operators.
  139057. */
  139058. static void fts3EvalNextRow(
  139059. Fts3Cursor *pCsr, /* FTS Cursor handle */
  139060. Fts3Expr *pExpr, /* Expr. to advance to next matching row */
  139061. int *pRc /* IN/OUT: Error code */
  139062. ){
  139063. if( *pRc==SQLITE_OK ){
  139064. int bDescDoclist = pCsr->bDesc; /* Used by DOCID_CMP() macro */
  139065. assert( pExpr->bEof==0 );
  139066. pExpr->bStart = 1;
  139067. switch( pExpr->eType ){
  139068. case FTSQUERY_NEAR:
  139069. case FTSQUERY_AND: {
  139070. Fts3Expr *pLeft = pExpr->pLeft;
  139071. Fts3Expr *pRight = pExpr->pRight;
  139072. assert( !pLeft->bDeferred || !pRight->bDeferred );
  139073. if( pLeft->bDeferred ){
  139074. /* LHS is entirely deferred. So we assume it matches every row.
  139075. ** Advance the RHS iterator to find the next row visited. */
  139076. fts3EvalNextRow(pCsr, pRight, pRc);
  139077. pExpr->iDocid = pRight->iDocid;
  139078. pExpr->bEof = pRight->bEof;
  139079. }else if( pRight->bDeferred ){
  139080. /* RHS is entirely deferred. So we assume it matches every row.
  139081. ** Advance the LHS iterator to find the next row visited. */
  139082. fts3EvalNextRow(pCsr, pLeft, pRc);
  139083. pExpr->iDocid = pLeft->iDocid;
  139084. pExpr->bEof = pLeft->bEof;
  139085. }else{
  139086. /* Neither the RHS or LHS are deferred. */
  139087. fts3EvalNextRow(pCsr, pLeft, pRc);
  139088. fts3EvalNextRow(pCsr, pRight, pRc);
  139089. while( !pLeft->bEof && !pRight->bEof && *pRc==SQLITE_OK ){
  139090. sqlite3_int64 iDiff = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  139091. if( iDiff==0 ) break;
  139092. if( iDiff<0 ){
  139093. fts3EvalNextRow(pCsr, pLeft, pRc);
  139094. }else{
  139095. fts3EvalNextRow(pCsr, pRight, pRc);
  139096. }
  139097. }
  139098. pExpr->iDocid = pLeft->iDocid;
  139099. pExpr->bEof = (pLeft->bEof || pRight->bEof);
  139100. if( pExpr->eType==FTSQUERY_NEAR && pExpr->bEof ){
  139101. if( pRight->pPhrase && pRight->pPhrase->doclist.aAll ){
  139102. Fts3Doclist *pDl = &pRight->pPhrase->doclist;
  139103. while( *pRc==SQLITE_OK && pRight->bEof==0 ){
  139104. memset(pDl->pList, 0, pDl->nList);
  139105. fts3EvalNextRow(pCsr, pRight, pRc);
  139106. }
  139107. }
  139108. if( pLeft->pPhrase && pLeft->pPhrase->doclist.aAll ){
  139109. Fts3Doclist *pDl = &pLeft->pPhrase->doclist;
  139110. while( *pRc==SQLITE_OK && pLeft->bEof==0 ){
  139111. memset(pDl->pList, 0, pDl->nList);
  139112. fts3EvalNextRow(pCsr, pLeft, pRc);
  139113. }
  139114. }
  139115. }
  139116. }
  139117. break;
  139118. }
  139119. case FTSQUERY_OR: {
  139120. Fts3Expr *pLeft = pExpr->pLeft;
  139121. Fts3Expr *pRight = pExpr->pRight;
  139122. sqlite3_int64 iCmp = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  139123. assert( pLeft->bStart || pLeft->iDocid==pRight->iDocid );
  139124. assert( pRight->bStart || pLeft->iDocid==pRight->iDocid );
  139125. if( pRight->bEof || (pLeft->bEof==0 && iCmp<0) ){
  139126. fts3EvalNextRow(pCsr, pLeft, pRc);
  139127. }else if( pLeft->bEof || (pRight->bEof==0 && iCmp>0) ){
  139128. fts3EvalNextRow(pCsr, pRight, pRc);
  139129. }else{
  139130. fts3EvalNextRow(pCsr, pLeft, pRc);
  139131. fts3EvalNextRow(pCsr, pRight, pRc);
  139132. }
  139133. pExpr->bEof = (pLeft->bEof && pRight->bEof);
  139134. iCmp = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  139135. if( pRight->bEof || (pLeft->bEof==0 && iCmp<0) ){
  139136. pExpr->iDocid = pLeft->iDocid;
  139137. }else{
  139138. pExpr->iDocid = pRight->iDocid;
  139139. }
  139140. break;
  139141. }
  139142. case FTSQUERY_NOT: {
  139143. Fts3Expr *pLeft = pExpr->pLeft;
  139144. Fts3Expr *pRight = pExpr->pRight;
  139145. if( pRight->bStart==0 ){
  139146. fts3EvalNextRow(pCsr, pRight, pRc);
  139147. assert( *pRc!=SQLITE_OK || pRight->bStart );
  139148. }
  139149. fts3EvalNextRow(pCsr, pLeft, pRc);
  139150. if( pLeft->bEof==0 ){
  139151. while( !*pRc
  139152. && !pRight->bEof
  139153. && DOCID_CMP(pLeft->iDocid, pRight->iDocid)>0
  139154. ){
  139155. fts3EvalNextRow(pCsr, pRight, pRc);
  139156. }
  139157. }
  139158. pExpr->iDocid = pLeft->iDocid;
  139159. pExpr->bEof = pLeft->bEof;
  139160. break;
  139161. }
  139162. default: {
  139163. Fts3Phrase *pPhrase = pExpr->pPhrase;
  139164. fts3EvalInvalidatePoslist(pPhrase);
  139165. *pRc = fts3EvalPhraseNext(pCsr, pPhrase, &pExpr->bEof);
  139166. pExpr->iDocid = pPhrase->doclist.iDocid;
  139167. break;
  139168. }
  139169. }
  139170. }
  139171. }
  139172. /*
  139173. ** If *pRc is not SQLITE_OK, or if pExpr is not the root node of a NEAR
  139174. ** cluster, then this function returns 1 immediately.
  139175. **
  139176. ** Otherwise, it checks if the current row really does match the NEAR
  139177. ** expression, using the data currently stored in the position lists
  139178. ** (Fts3Expr->pPhrase.doclist.pList/nList) for each phrase in the expression.
  139179. **
  139180. ** If the current row is a match, the position list associated with each
  139181. ** phrase in the NEAR expression is edited in place to contain only those
  139182. ** phrase instances sufficiently close to their peers to satisfy all NEAR
  139183. ** constraints. In this case it returns 1. If the NEAR expression does not
  139184. ** match the current row, 0 is returned. The position lists may or may not
  139185. ** be edited if 0 is returned.
  139186. */
  139187. static int fts3EvalNearTest(Fts3Expr *pExpr, int *pRc){
  139188. int res = 1;
  139189. /* The following block runs if pExpr is the root of a NEAR query.
  139190. ** For example, the query:
  139191. **
  139192. ** "w" NEAR "x" NEAR "y" NEAR "z"
  139193. **
  139194. ** which is represented in tree form as:
  139195. **
  139196. ** |
  139197. ** +--NEAR--+ <-- root of NEAR query
  139198. ** | |
  139199. ** +--NEAR--+ "z"
  139200. ** | |
  139201. ** +--NEAR--+ "y"
  139202. ** | |
  139203. ** "w" "x"
  139204. **
  139205. ** The right-hand child of a NEAR node is always a phrase. The
  139206. ** left-hand child may be either a phrase or a NEAR node. There are
  139207. ** no exceptions to this - it's the way the parser in fts3_expr.c works.
  139208. */
  139209. if( *pRc==SQLITE_OK
  139210. && pExpr->eType==FTSQUERY_NEAR
  139211. && pExpr->bEof==0
  139212. && (pExpr->pParent==0 || pExpr->pParent->eType!=FTSQUERY_NEAR)
  139213. ){
  139214. Fts3Expr *p;
  139215. int nTmp = 0; /* Bytes of temp space */
  139216. char *aTmp; /* Temp space for PoslistNearMerge() */
  139217. /* Allocate temporary working space. */
  139218. for(p=pExpr; p->pLeft; p=p->pLeft){
  139219. nTmp += p->pRight->pPhrase->doclist.nList;
  139220. }
  139221. nTmp += p->pPhrase->doclist.nList;
  139222. if( nTmp==0 ){
  139223. res = 0;
  139224. }else{
  139225. aTmp = sqlite3_malloc(nTmp*2);
  139226. if( !aTmp ){
  139227. *pRc = SQLITE_NOMEM;
  139228. res = 0;
  139229. }else{
  139230. char *aPoslist = p->pPhrase->doclist.pList;
  139231. int nToken = p->pPhrase->nToken;
  139232. for(p=p->pParent;res && p && p->eType==FTSQUERY_NEAR; p=p->pParent){
  139233. Fts3Phrase *pPhrase = p->pRight->pPhrase;
  139234. int nNear = p->nNear;
  139235. res = fts3EvalNearTrim(nNear, aTmp, &aPoslist, &nToken, pPhrase);
  139236. }
  139237. aPoslist = pExpr->pRight->pPhrase->doclist.pList;
  139238. nToken = pExpr->pRight->pPhrase->nToken;
  139239. for(p=pExpr->pLeft; p && res; p=p->pLeft){
  139240. int nNear;
  139241. Fts3Phrase *pPhrase;
  139242. assert( p->pParent && p->pParent->pLeft==p );
  139243. nNear = p->pParent->nNear;
  139244. pPhrase = (
  139245. p->eType==FTSQUERY_NEAR ? p->pRight->pPhrase : p->pPhrase
  139246. );
  139247. res = fts3EvalNearTrim(nNear, aTmp, &aPoslist, &nToken, pPhrase);
  139248. }
  139249. }
  139250. sqlite3_free(aTmp);
  139251. }
  139252. }
  139253. return res;
  139254. }
  139255. /*
  139256. ** This function is a helper function for sqlite3Fts3EvalTestDeferred().
  139257. ** Assuming no error occurs or has occurred, It returns non-zero if the
  139258. ** expression passed as the second argument matches the row that pCsr
  139259. ** currently points to, or zero if it does not.
  139260. **
  139261. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  139262. ** If an error occurs during execution of this function, *pRc is set to
  139263. ** the appropriate SQLite error code. In this case the returned value is
  139264. ** undefined.
  139265. */
  139266. static int fts3EvalTestExpr(
  139267. Fts3Cursor *pCsr, /* FTS cursor handle */
  139268. Fts3Expr *pExpr, /* Expr to test. May or may not be root. */
  139269. int *pRc /* IN/OUT: Error code */
  139270. ){
  139271. int bHit = 1; /* Return value */
  139272. if( *pRc==SQLITE_OK ){
  139273. switch( pExpr->eType ){
  139274. case FTSQUERY_NEAR:
  139275. case FTSQUERY_AND:
  139276. bHit = (
  139277. fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc)
  139278. && fts3EvalTestExpr(pCsr, pExpr->pRight, pRc)
  139279. && fts3EvalNearTest(pExpr, pRc)
  139280. );
  139281. /* If the NEAR expression does not match any rows, zero the doclist for
  139282. ** all phrases involved in the NEAR. This is because the snippet(),
  139283. ** offsets() and matchinfo() functions are not supposed to recognize
  139284. ** any instances of phrases that are part of unmatched NEAR queries.
  139285. ** For example if this expression:
  139286. **
  139287. ** ... MATCH 'a OR (b NEAR c)'
  139288. **
  139289. ** is matched against a row containing:
  139290. **
  139291. ** 'a b d e'
  139292. **
  139293. ** then any snippet() should ony highlight the "a" term, not the "b"
  139294. ** (as "b" is part of a non-matching NEAR clause).
  139295. */
  139296. if( bHit==0
  139297. && pExpr->eType==FTSQUERY_NEAR
  139298. && (pExpr->pParent==0 || pExpr->pParent->eType!=FTSQUERY_NEAR)
  139299. ){
  139300. Fts3Expr *p;
  139301. for(p=pExpr; p->pPhrase==0; p=p->pLeft){
  139302. if( p->pRight->iDocid==pCsr->iPrevId ){
  139303. fts3EvalInvalidatePoslist(p->pRight->pPhrase);
  139304. }
  139305. }
  139306. if( p->iDocid==pCsr->iPrevId ){
  139307. fts3EvalInvalidatePoslist(p->pPhrase);
  139308. }
  139309. }
  139310. break;
  139311. case FTSQUERY_OR: {
  139312. int bHit1 = fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc);
  139313. int bHit2 = fts3EvalTestExpr(pCsr, pExpr->pRight, pRc);
  139314. bHit = bHit1 || bHit2;
  139315. break;
  139316. }
  139317. case FTSQUERY_NOT:
  139318. bHit = (
  139319. fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc)
  139320. && !fts3EvalTestExpr(pCsr, pExpr->pRight, pRc)
  139321. );
  139322. break;
  139323. default: {
  139324. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  139325. if( pCsr->pDeferred
  139326. && (pExpr->iDocid==pCsr->iPrevId || pExpr->bDeferred)
  139327. ){
  139328. Fts3Phrase *pPhrase = pExpr->pPhrase;
  139329. assert( pExpr->bDeferred || pPhrase->doclist.bFreeList==0 );
  139330. if( pExpr->bDeferred ){
  139331. fts3EvalInvalidatePoslist(pPhrase);
  139332. }
  139333. *pRc = fts3EvalDeferredPhrase(pCsr, pPhrase);
  139334. bHit = (pPhrase->doclist.pList!=0);
  139335. pExpr->iDocid = pCsr->iPrevId;
  139336. }else
  139337. #endif
  139338. {
  139339. bHit = (pExpr->bEof==0 && pExpr->iDocid==pCsr->iPrevId);
  139340. }
  139341. break;
  139342. }
  139343. }
  139344. }
  139345. return bHit;
  139346. }
  139347. /*
  139348. ** This function is called as the second part of each xNext operation when
  139349. ** iterating through the results of a full-text query. At this point the
  139350. ** cursor points to a row that matches the query expression, with the
  139351. ** following caveats:
  139352. **
  139353. ** * Up until this point, "NEAR" operators in the expression have been
  139354. ** treated as "AND".
  139355. **
  139356. ** * Deferred tokens have not yet been considered.
  139357. **
  139358. ** If *pRc is not SQLITE_OK when this function is called, it immediately
  139359. ** returns 0. Otherwise, it tests whether or not after considering NEAR
  139360. ** operators and deferred tokens the current row is still a match for the
  139361. ** expression. It returns 1 if both of the following are true:
  139362. **
  139363. ** 1. *pRc is SQLITE_OK when this function returns, and
  139364. **
  139365. ** 2. After scanning the current FTS table row for the deferred tokens,
  139366. ** it is determined that the row does *not* match the query.
  139367. **
  139368. ** Or, if no error occurs and it seems the current row does match the FTS
  139369. ** query, return 0.
  139370. */
  139371. SQLITE_PRIVATE int sqlite3Fts3EvalTestDeferred(Fts3Cursor *pCsr, int *pRc){
  139372. int rc = *pRc;
  139373. int bMiss = 0;
  139374. if( rc==SQLITE_OK ){
  139375. /* If there are one or more deferred tokens, load the current row into
  139376. ** memory and scan it to determine the position list for each deferred
  139377. ** token. Then, see if this row is really a match, considering deferred
  139378. ** tokens and NEAR operators (neither of which were taken into account
  139379. ** earlier, by fts3EvalNextRow()).
  139380. */
  139381. if( pCsr->pDeferred ){
  139382. rc = fts3CursorSeek(0, pCsr);
  139383. if( rc==SQLITE_OK ){
  139384. rc = sqlite3Fts3CacheDeferredDoclists(pCsr);
  139385. }
  139386. }
  139387. bMiss = (0==fts3EvalTestExpr(pCsr, pCsr->pExpr, &rc));
  139388. /* Free the position-lists accumulated for each deferred token above. */
  139389. sqlite3Fts3FreeDeferredDoclists(pCsr);
  139390. *pRc = rc;
  139391. }
  139392. return (rc==SQLITE_OK && bMiss);
  139393. }
  139394. /*
  139395. ** Advance to the next document that matches the FTS expression in
  139396. ** Fts3Cursor.pExpr.
  139397. */
  139398. static int fts3EvalNext(Fts3Cursor *pCsr){
  139399. int rc = SQLITE_OK; /* Return Code */
  139400. Fts3Expr *pExpr = pCsr->pExpr;
  139401. assert( pCsr->isEof==0 );
  139402. if( pExpr==0 ){
  139403. pCsr->isEof = 1;
  139404. }else{
  139405. do {
  139406. if( pCsr->isRequireSeek==0 ){
  139407. sqlite3_reset(pCsr->pStmt);
  139408. }
  139409. assert( sqlite3_data_count(pCsr->pStmt)==0 );
  139410. fts3EvalNextRow(pCsr, pExpr, &rc);
  139411. pCsr->isEof = pExpr->bEof;
  139412. pCsr->isRequireSeek = 1;
  139413. pCsr->isMatchinfoNeeded = 1;
  139414. pCsr->iPrevId = pExpr->iDocid;
  139415. }while( pCsr->isEof==0 && sqlite3Fts3EvalTestDeferred(pCsr, &rc) );
  139416. }
  139417. /* Check if the cursor is past the end of the docid range specified
  139418. ** by Fts3Cursor.iMinDocid/iMaxDocid. If so, set the EOF flag. */
  139419. if( rc==SQLITE_OK && (
  139420. (pCsr->bDesc==0 && pCsr->iPrevId>pCsr->iMaxDocid)
  139421. || (pCsr->bDesc!=0 && pCsr->iPrevId<pCsr->iMinDocid)
  139422. )){
  139423. pCsr->isEof = 1;
  139424. }
  139425. return rc;
  139426. }
  139427. /*
  139428. ** Restart interation for expression pExpr so that the next call to
  139429. ** fts3EvalNext() visits the first row. Do not allow incremental
  139430. ** loading or merging of phrase doclists for this iteration.
  139431. **
  139432. ** If *pRc is other than SQLITE_OK when this function is called, it is
  139433. ** a no-op. If an error occurs within this function, *pRc is set to an
  139434. ** SQLite error code before returning.
  139435. */
  139436. static void fts3EvalRestart(
  139437. Fts3Cursor *pCsr,
  139438. Fts3Expr *pExpr,
  139439. int *pRc
  139440. ){
  139441. if( pExpr && *pRc==SQLITE_OK ){
  139442. Fts3Phrase *pPhrase = pExpr->pPhrase;
  139443. if( pPhrase ){
  139444. fts3EvalInvalidatePoslist(pPhrase);
  139445. if( pPhrase->bIncr ){
  139446. int i;
  139447. for(i=0; i<pPhrase->nToken; i++){
  139448. Fts3PhraseToken *pToken = &pPhrase->aToken[i];
  139449. assert( pToken->pDeferred==0 );
  139450. if( pToken->pSegcsr ){
  139451. sqlite3Fts3MsrIncrRestart(pToken->pSegcsr);
  139452. }
  139453. }
  139454. *pRc = fts3EvalPhraseStart(pCsr, 0, pPhrase);
  139455. }
  139456. pPhrase->doclist.pNextDocid = 0;
  139457. pPhrase->doclist.iDocid = 0;
  139458. pPhrase->pOrPoslist = 0;
  139459. }
  139460. pExpr->iDocid = 0;
  139461. pExpr->bEof = 0;
  139462. pExpr->bStart = 0;
  139463. fts3EvalRestart(pCsr, pExpr->pLeft, pRc);
  139464. fts3EvalRestart(pCsr, pExpr->pRight, pRc);
  139465. }
  139466. }
  139467. /*
  139468. ** After allocating the Fts3Expr.aMI[] array for each phrase in the
  139469. ** expression rooted at pExpr, the cursor iterates through all rows matched
  139470. ** by pExpr, calling this function for each row. This function increments
  139471. ** the values in Fts3Expr.aMI[] according to the position-list currently
  139472. ** found in Fts3Expr.pPhrase->doclist.pList for each of the phrase
  139473. ** expression nodes.
  139474. */
  139475. static void fts3EvalUpdateCounts(Fts3Expr *pExpr){
  139476. if( pExpr ){
  139477. Fts3Phrase *pPhrase = pExpr->pPhrase;
  139478. if( pPhrase && pPhrase->doclist.pList ){
  139479. int iCol = 0;
  139480. char *p = pPhrase->doclist.pList;
  139481. assert( *p );
  139482. while( 1 ){
  139483. u8 c = 0;
  139484. int iCnt = 0;
  139485. while( 0xFE & (*p | c) ){
  139486. if( (c&0x80)==0 ) iCnt++;
  139487. c = *p++ & 0x80;
  139488. }
  139489. /* aMI[iCol*3 + 1] = Number of occurrences
  139490. ** aMI[iCol*3 + 2] = Number of rows containing at least one instance
  139491. */
  139492. pExpr->aMI[iCol*3 + 1] += iCnt;
  139493. pExpr->aMI[iCol*3 + 2] += (iCnt>0);
  139494. if( *p==0x00 ) break;
  139495. p++;
  139496. p += fts3GetVarint32(p, &iCol);
  139497. }
  139498. }
  139499. fts3EvalUpdateCounts(pExpr->pLeft);
  139500. fts3EvalUpdateCounts(pExpr->pRight);
  139501. }
  139502. }
  139503. /*
  139504. ** Expression pExpr must be of type FTSQUERY_PHRASE.
  139505. **
  139506. ** If it is not already allocated and populated, this function allocates and
  139507. ** populates the Fts3Expr.aMI[] array for expression pExpr. If pExpr is part
  139508. ** of a NEAR expression, then it also allocates and populates the same array
  139509. ** for all other phrases that are part of the NEAR expression.
  139510. **
  139511. ** SQLITE_OK is returned if the aMI[] array is successfully allocated and
  139512. ** populated. Otherwise, if an error occurs, an SQLite error code is returned.
  139513. */
  139514. static int fts3EvalGatherStats(
  139515. Fts3Cursor *pCsr, /* Cursor object */
  139516. Fts3Expr *pExpr /* FTSQUERY_PHRASE expression */
  139517. ){
  139518. int rc = SQLITE_OK; /* Return code */
  139519. assert( pExpr->eType==FTSQUERY_PHRASE );
  139520. if( pExpr->aMI==0 ){
  139521. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  139522. Fts3Expr *pRoot; /* Root of NEAR expression */
  139523. Fts3Expr *p; /* Iterator used for several purposes */
  139524. sqlite3_int64 iPrevId = pCsr->iPrevId;
  139525. sqlite3_int64 iDocid;
  139526. u8 bEof;
  139527. /* Find the root of the NEAR expression */
  139528. pRoot = pExpr;
  139529. while( pRoot->pParent && pRoot->pParent->eType==FTSQUERY_NEAR ){
  139530. pRoot = pRoot->pParent;
  139531. }
  139532. iDocid = pRoot->iDocid;
  139533. bEof = pRoot->bEof;
  139534. assert( pRoot->bStart );
  139535. /* Allocate space for the aMSI[] array of each FTSQUERY_PHRASE node */
  139536. for(p=pRoot; p; p=p->pLeft){
  139537. Fts3Expr *pE = (p->eType==FTSQUERY_PHRASE?p:p->pRight);
  139538. assert( pE->aMI==0 );
  139539. pE->aMI = (u32 *)sqlite3_malloc(pTab->nColumn * 3 * sizeof(u32));
  139540. if( !pE->aMI ) return SQLITE_NOMEM;
  139541. memset(pE->aMI, 0, pTab->nColumn * 3 * sizeof(u32));
  139542. }
  139543. fts3EvalRestart(pCsr, pRoot, &rc);
  139544. while( pCsr->isEof==0 && rc==SQLITE_OK ){
  139545. do {
  139546. /* Ensure the %_content statement is reset. */
  139547. if( pCsr->isRequireSeek==0 ) sqlite3_reset(pCsr->pStmt);
  139548. assert( sqlite3_data_count(pCsr->pStmt)==0 );
  139549. /* Advance to the next document */
  139550. fts3EvalNextRow(pCsr, pRoot, &rc);
  139551. pCsr->isEof = pRoot->bEof;
  139552. pCsr->isRequireSeek = 1;
  139553. pCsr->isMatchinfoNeeded = 1;
  139554. pCsr->iPrevId = pRoot->iDocid;
  139555. }while( pCsr->isEof==0
  139556. && pRoot->eType==FTSQUERY_NEAR
  139557. && sqlite3Fts3EvalTestDeferred(pCsr, &rc)
  139558. );
  139559. if( rc==SQLITE_OK && pCsr->isEof==0 ){
  139560. fts3EvalUpdateCounts(pRoot);
  139561. }
  139562. }
  139563. pCsr->isEof = 0;
  139564. pCsr->iPrevId = iPrevId;
  139565. if( bEof ){
  139566. pRoot->bEof = bEof;
  139567. }else{
  139568. /* Caution: pRoot may iterate through docids in ascending or descending
  139569. ** order. For this reason, even though it seems more defensive, the
  139570. ** do loop can not be written:
  139571. **
  139572. ** do {...} while( pRoot->iDocid<iDocid && rc==SQLITE_OK );
  139573. */
  139574. fts3EvalRestart(pCsr, pRoot, &rc);
  139575. do {
  139576. fts3EvalNextRow(pCsr, pRoot, &rc);
  139577. assert( pRoot->bEof==0 );
  139578. }while( pRoot->iDocid!=iDocid && rc==SQLITE_OK );
  139579. }
  139580. }
  139581. return rc;
  139582. }
  139583. /*
  139584. ** This function is used by the matchinfo() module to query a phrase
  139585. ** expression node for the following information:
  139586. **
  139587. ** 1. The total number of occurrences of the phrase in each column of
  139588. ** the FTS table (considering all rows), and
  139589. **
  139590. ** 2. For each column, the number of rows in the table for which the
  139591. ** column contains at least one instance of the phrase.
  139592. **
  139593. ** If no error occurs, SQLITE_OK is returned and the values for each column
  139594. ** written into the array aiOut as follows:
  139595. **
  139596. ** aiOut[iCol*3 + 1] = Number of occurrences
  139597. ** aiOut[iCol*3 + 2] = Number of rows containing at least one instance
  139598. **
  139599. ** Caveats:
  139600. **
  139601. ** * If a phrase consists entirely of deferred tokens, then all output
  139602. ** values are set to the number of documents in the table. In other
  139603. ** words we assume that very common tokens occur exactly once in each
  139604. ** column of each row of the table.
  139605. **
  139606. ** * If a phrase contains some deferred tokens (and some non-deferred
  139607. ** tokens), count the potential occurrence identified by considering
  139608. ** the non-deferred tokens instead of actual phrase occurrences.
  139609. **
  139610. ** * If the phrase is part of a NEAR expression, then only phrase instances
  139611. ** that meet the NEAR constraint are included in the counts.
  139612. */
  139613. SQLITE_PRIVATE int sqlite3Fts3EvalPhraseStats(
  139614. Fts3Cursor *pCsr, /* FTS cursor handle */
  139615. Fts3Expr *pExpr, /* Phrase expression */
  139616. u32 *aiOut /* Array to write results into (see above) */
  139617. ){
  139618. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  139619. int rc = SQLITE_OK;
  139620. int iCol;
  139621. if( pExpr->bDeferred && pExpr->pParent->eType!=FTSQUERY_NEAR ){
  139622. assert( pCsr->nDoc>0 );
  139623. for(iCol=0; iCol<pTab->nColumn; iCol++){
  139624. aiOut[iCol*3 + 1] = (u32)pCsr->nDoc;
  139625. aiOut[iCol*3 + 2] = (u32)pCsr->nDoc;
  139626. }
  139627. }else{
  139628. rc = fts3EvalGatherStats(pCsr, pExpr);
  139629. if( rc==SQLITE_OK ){
  139630. assert( pExpr->aMI );
  139631. for(iCol=0; iCol<pTab->nColumn; iCol++){
  139632. aiOut[iCol*3 + 1] = pExpr->aMI[iCol*3 + 1];
  139633. aiOut[iCol*3 + 2] = pExpr->aMI[iCol*3 + 2];
  139634. }
  139635. }
  139636. }
  139637. return rc;
  139638. }
  139639. /*
  139640. ** The expression pExpr passed as the second argument to this function
  139641. ** must be of type FTSQUERY_PHRASE.
  139642. **
  139643. ** The returned value is either NULL or a pointer to a buffer containing
  139644. ** a position-list indicating the occurrences of the phrase in column iCol
  139645. ** of the current row.
  139646. **
  139647. ** More specifically, the returned buffer contains 1 varint for each
  139648. ** occurrence of the phrase in the column, stored using the normal (delta+2)
  139649. ** compression and is terminated by either an 0x01 or 0x00 byte. For example,
  139650. ** if the requested column contains "a b X c d X X" and the position-list
  139651. ** for 'X' is requested, the buffer returned may contain:
  139652. **
  139653. ** 0x04 0x05 0x03 0x01 or 0x04 0x05 0x03 0x00
  139654. **
  139655. ** This function works regardless of whether or not the phrase is deferred,
  139656. ** incremental, or neither.
  139657. */
  139658. SQLITE_PRIVATE int sqlite3Fts3EvalPhrasePoslist(
  139659. Fts3Cursor *pCsr, /* FTS3 cursor object */
  139660. Fts3Expr *pExpr, /* Phrase to return doclist for */
  139661. int iCol, /* Column to return position list for */
  139662. char **ppOut /* OUT: Pointer to position list */
  139663. ){
  139664. Fts3Phrase *pPhrase = pExpr->pPhrase;
  139665. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  139666. char *pIter;
  139667. int iThis;
  139668. sqlite3_int64 iDocid;
  139669. /* If this phrase is applies specifically to some column other than
  139670. ** column iCol, return a NULL pointer. */
  139671. *ppOut = 0;
  139672. assert( iCol>=0 && iCol<pTab->nColumn );
  139673. if( (pPhrase->iColumn<pTab->nColumn && pPhrase->iColumn!=iCol) ){
  139674. return SQLITE_OK;
  139675. }
  139676. iDocid = pExpr->iDocid;
  139677. pIter = pPhrase->doclist.pList;
  139678. if( iDocid!=pCsr->iPrevId || pExpr->bEof ){
  139679. int rc = SQLITE_OK;
  139680. int bDescDoclist = pTab->bDescIdx; /* For DOCID_CMP macro */
  139681. int bOr = 0;
  139682. u8 bTreeEof = 0;
  139683. Fts3Expr *p; /* Used to iterate from pExpr to root */
  139684. Fts3Expr *pNear; /* Most senior NEAR ancestor (or pExpr) */
  139685. int bMatch;
  139686. /* Check if this phrase descends from an OR expression node. If not,
  139687. ** return NULL. Otherwise, the entry that corresponds to docid
  139688. ** pCsr->iPrevId may lie earlier in the doclist buffer. Or, if the
  139689. ** tree that the node is part of has been marked as EOF, but the node
  139690. ** itself is not EOF, then it may point to an earlier entry. */
  139691. pNear = pExpr;
  139692. for(p=pExpr->pParent; p; p=p->pParent){
  139693. if( p->eType==FTSQUERY_OR ) bOr = 1;
  139694. if( p->eType==FTSQUERY_NEAR ) pNear = p;
  139695. if( p->bEof ) bTreeEof = 1;
  139696. }
  139697. if( bOr==0 ) return SQLITE_OK;
  139698. /* This is the descendent of an OR node. In this case we cannot use
  139699. ** an incremental phrase. Load the entire doclist for the phrase
  139700. ** into memory in this case. */
  139701. if( pPhrase->bIncr ){
  139702. int bEofSave = pNear->bEof;
  139703. fts3EvalRestart(pCsr, pNear, &rc);
  139704. while( rc==SQLITE_OK && !pNear->bEof ){
  139705. fts3EvalNextRow(pCsr, pNear, &rc);
  139706. if( bEofSave==0 && pNear->iDocid==iDocid ) break;
  139707. }
  139708. assert( rc!=SQLITE_OK || pPhrase->bIncr==0 );
  139709. }
  139710. if( bTreeEof ){
  139711. while( rc==SQLITE_OK && !pNear->bEof ){
  139712. fts3EvalNextRow(pCsr, pNear, &rc);
  139713. }
  139714. }
  139715. if( rc!=SQLITE_OK ) return rc;
  139716. bMatch = 1;
  139717. for(p=pNear; p; p=p->pLeft){
  139718. u8 bEof = 0;
  139719. Fts3Expr *pTest = p;
  139720. Fts3Phrase *pPh;
  139721. assert( pTest->eType==FTSQUERY_NEAR || pTest->eType==FTSQUERY_PHRASE );
  139722. if( pTest->eType==FTSQUERY_NEAR ) pTest = pTest->pRight;
  139723. assert( pTest->eType==FTSQUERY_PHRASE );
  139724. pPh = pTest->pPhrase;
  139725. pIter = pPh->pOrPoslist;
  139726. iDocid = pPh->iOrDocid;
  139727. if( pCsr->bDesc==bDescDoclist ){
  139728. bEof = !pPh->doclist.nAll ||
  139729. (pIter >= (pPh->doclist.aAll + pPh->doclist.nAll));
  139730. while( (pIter==0 || DOCID_CMP(iDocid, pCsr->iPrevId)<0 ) && bEof==0 ){
  139731. sqlite3Fts3DoclistNext(
  139732. bDescDoclist, pPh->doclist.aAll, pPh->doclist.nAll,
  139733. &pIter, &iDocid, &bEof
  139734. );
  139735. }
  139736. }else{
  139737. bEof = !pPh->doclist.nAll || (pIter && pIter<=pPh->doclist.aAll);
  139738. while( (pIter==0 || DOCID_CMP(iDocid, pCsr->iPrevId)>0 ) && bEof==0 ){
  139739. int dummy;
  139740. sqlite3Fts3DoclistPrev(
  139741. bDescDoclist, pPh->doclist.aAll, pPh->doclist.nAll,
  139742. &pIter, &iDocid, &dummy, &bEof
  139743. );
  139744. }
  139745. }
  139746. pPh->pOrPoslist = pIter;
  139747. pPh->iOrDocid = iDocid;
  139748. if( bEof || iDocid!=pCsr->iPrevId ) bMatch = 0;
  139749. }
  139750. if( bMatch ){
  139751. pIter = pPhrase->pOrPoslist;
  139752. }else{
  139753. pIter = 0;
  139754. }
  139755. }
  139756. if( pIter==0 ) return SQLITE_OK;
  139757. if( *pIter==0x01 ){
  139758. pIter++;
  139759. pIter += fts3GetVarint32(pIter, &iThis);
  139760. }else{
  139761. iThis = 0;
  139762. }
  139763. while( iThis<iCol ){
  139764. fts3ColumnlistCopy(0, &pIter);
  139765. if( *pIter==0x00 ) return SQLITE_OK;
  139766. pIter++;
  139767. pIter += fts3GetVarint32(pIter, &iThis);
  139768. }
  139769. if( *pIter==0x00 ){
  139770. pIter = 0;
  139771. }
  139772. *ppOut = ((iCol==iThis)?pIter:0);
  139773. return SQLITE_OK;
  139774. }
  139775. /*
  139776. ** Free all components of the Fts3Phrase structure that were allocated by
  139777. ** the eval module. Specifically, this means to free:
  139778. **
  139779. ** * the contents of pPhrase->doclist, and
  139780. ** * any Fts3MultiSegReader objects held by phrase tokens.
  139781. */
  139782. SQLITE_PRIVATE void sqlite3Fts3EvalPhraseCleanup(Fts3Phrase *pPhrase){
  139783. if( pPhrase ){
  139784. int i;
  139785. sqlite3_free(pPhrase->doclist.aAll);
  139786. fts3EvalInvalidatePoslist(pPhrase);
  139787. memset(&pPhrase->doclist, 0, sizeof(Fts3Doclist));
  139788. for(i=0; i<pPhrase->nToken; i++){
  139789. fts3SegReaderCursorFree(pPhrase->aToken[i].pSegcsr);
  139790. pPhrase->aToken[i].pSegcsr = 0;
  139791. }
  139792. }
  139793. }
  139794. /*
  139795. ** Return SQLITE_CORRUPT_VTAB.
  139796. */
  139797. #ifdef SQLITE_DEBUG
  139798. SQLITE_PRIVATE int sqlite3Fts3Corrupt(){
  139799. return SQLITE_CORRUPT_VTAB;
  139800. }
  139801. #endif
  139802. #if !SQLITE_CORE
  139803. /*
  139804. ** Initialize API pointer table, if required.
  139805. */
  139806. #ifdef _WIN32
  139807. __declspec(dllexport)
  139808. #endif
  139809. SQLITE_API int sqlite3_fts3_init(
  139810. sqlite3 *db,
  139811. char **pzErrMsg,
  139812. const sqlite3_api_routines *pApi
  139813. ){
  139814. SQLITE_EXTENSION_INIT2(pApi)
  139815. return sqlite3Fts3Init(db);
  139816. }
  139817. #endif
  139818. #endif
  139819. /************** End of fts3.c ************************************************/
  139820. /************** Begin file fts3_aux.c ****************************************/
  139821. /*
  139822. ** 2011 Jan 27
  139823. **
  139824. ** The author disclaims copyright to this source code. In place of
  139825. ** a legal notice, here is a blessing:
  139826. **
  139827. ** May you do good and not evil.
  139828. ** May you find forgiveness for yourself and forgive others.
  139829. ** May you share freely, never taking more than you give.
  139830. **
  139831. ******************************************************************************
  139832. **
  139833. */
  139834. /* #include "fts3Int.h" */
  139835. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  139836. /* #include <string.h> */
  139837. /* #include <assert.h> */
  139838. typedef struct Fts3auxTable Fts3auxTable;
  139839. typedef struct Fts3auxCursor Fts3auxCursor;
  139840. struct Fts3auxTable {
  139841. sqlite3_vtab base; /* Base class used by SQLite core */
  139842. Fts3Table *pFts3Tab;
  139843. };
  139844. struct Fts3auxCursor {
  139845. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  139846. Fts3MultiSegReader csr; /* Must be right after "base" */
  139847. Fts3SegFilter filter;
  139848. char *zStop;
  139849. int nStop; /* Byte-length of string zStop */
  139850. int iLangid; /* Language id to query */
  139851. int isEof; /* True if cursor is at EOF */
  139852. sqlite3_int64 iRowid; /* Current rowid */
  139853. int iCol; /* Current value of 'col' column */
  139854. int nStat; /* Size of aStat[] array */
  139855. struct Fts3auxColstats {
  139856. sqlite3_int64 nDoc; /* 'documents' values for current csr row */
  139857. sqlite3_int64 nOcc; /* 'occurrences' values for current csr row */
  139858. } *aStat;
  139859. };
  139860. /*
  139861. ** Schema of the terms table.
  139862. */
  139863. #define FTS3_AUX_SCHEMA \
  139864. "CREATE TABLE x(term, col, documents, occurrences, languageid HIDDEN)"
  139865. /*
  139866. ** This function does all the work for both the xConnect and xCreate methods.
  139867. ** These tables have no persistent representation of their own, so xConnect
  139868. ** and xCreate are identical operations.
  139869. */
  139870. static int fts3auxConnectMethod(
  139871. sqlite3 *db, /* Database connection */
  139872. void *pUnused, /* Unused */
  139873. int argc, /* Number of elements in argv array */
  139874. const char * const *argv, /* xCreate/xConnect argument array */
  139875. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  139876. char **pzErr /* OUT: sqlite3_malloc'd error message */
  139877. ){
  139878. char const *zDb; /* Name of database (e.g. "main") */
  139879. char const *zFts3; /* Name of fts3 table */
  139880. int nDb; /* Result of strlen(zDb) */
  139881. int nFts3; /* Result of strlen(zFts3) */
  139882. int nByte; /* Bytes of space to allocate here */
  139883. int rc; /* value returned by declare_vtab() */
  139884. Fts3auxTable *p; /* Virtual table object to return */
  139885. UNUSED_PARAMETER(pUnused);
  139886. /* The user should invoke this in one of two forms:
  139887. **
  139888. ** CREATE VIRTUAL TABLE xxx USING fts4aux(fts4-table);
  139889. ** CREATE VIRTUAL TABLE xxx USING fts4aux(fts4-table-db, fts4-table);
  139890. */
  139891. if( argc!=4 && argc!=5 ) goto bad_args;
  139892. zDb = argv[1];
  139893. nDb = (int)strlen(zDb);
  139894. if( argc==5 ){
  139895. if( nDb==4 && 0==sqlite3_strnicmp("temp", zDb, 4) ){
  139896. zDb = argv[3];
  139897. nDb = (int)strlen(zDb);
  139898. zFts3 = argv[4];
  139899. }else{
  139900. goto bad_args;
  139901. }
  139902. }else{
  139903. zFts3 = argv[3];
  139904. }
  139905. nFts3 = (int)strlen(zFts3);
  139906. rc = sqlite3_declare_vtab(db, FTS3_AUX_SCHEMA);
  139907. if( rc!=SQLITE_OK ) return rc;
  139908. nByte = sizeof(Fts3auxTable) + sizeof(Fts3Table) + nDb + nFts3 + 2;
  139909. p = (Fts3auxTable *)sqlite3_malloc(nByte);
  139910. if( !p ) return SQLITE_NOMEM;
  139911. memset(p, 0, nByte);
  139912. p->pFts3Tab = (Fts3Table *)&p[1];
  139913. p->pFts3Tab->zDb = (char *)&p->pFts3Tab[1];
  139914. p->pFts3Tab->zName = &p->pFts3Tab->zDb[nDb+1];
  139915. p->pFts3Tab->db = db;
  139916. p->pFts3Tab->nIndex = 1;
  139917. memcpy((char *)p->pFts3Tab->zDb, zDb, nDb);
  139918. memcpy((char *)p->pFts3Tab->zName, zFts3, nFts3);
  139919. sqlite3Fts3Dequote((char *)p->pFts3Tab->zName);
  139920. *ppVtab = (sqlite3_vtab *)p;
  139921. return SQLITE_OK;
  139922. bad_args:
  139923. sqlite3Fts3ErrMsg(pzErr, "invalid arguments to fts4aux constructor");
  139924. return SQLITE_ERROR;
  139925. }
  139926. /*
  139927. ** This function does the work for both the xDisconnect and xDestroy methods.
  139928. ** These tables have no persistent representation of their own, so xDisconnect
  139929. ** and xDestroy are identical operations.
  139930. */
  139931. static int fts3auxDisconnectMethod(sqlite3_vtab *pVtab){
  139932. Fts3auxTable *p = (Fts3auxTable *)pVtab;
  139933. Fts3Table *pFts3 = p->pFts3Tab;
  139934. int i;
  139935. /* Free any prepared statements held */
  139936. for(i=0; i<SizeofArray(pFts3->aStmt); i++){
  139937. sqlite3_finalize(pFts3->aStmt[i]);
  139938. }
  139939. sqlite3_free(pFts3->zSegmentsTbl);
  139940. sqlite3_free(p);
  139941. return SQLITE_OK;
  139942. }
  139943. #define FTS4AUX_EQ_CONSTRAINT 1
  139944. #define FTS4AUX_GE_CONSTRAINT 2
  139945. #define FTS4AUX_LE_CONSTRAINT 4
  139946. /*
  139947. ** xBestIndex - Analyze a WHERE and ORDER BY clause.
  139948. */
  139949. static int fts3auxBestIndexMethod(
  139950. sqlite3_vtab *pVTab,
  139951. sqlite3_index_info *pInfo
  139952. ){
  139953. int i;
  139954. int iEq = -1;
  139955. int iGe = -1;
  139956. int iLe = -1;
  139957. int iLangid = -1;
  139958. int iNext = 1; /* Next free argvIndex value */
  139959. UNUSED_PARAMETER(pVTab);
  139960. /* This vtab delivers always results in "ORDER BY term ASC" order. */
  139961. if( pInfo->nOrderBy==1
  139962. && pInfo->aOrderBy[0].iColumn==0
  139963. && pInfo->aOrderBy[0].desc==0
  139964. ){
  139965. pInfo->orderByConsumed = 1;
  139966. }
  139967. /* Search for equality and range constraints on the "term" column.
  139968. ** And equality constraints on the hidden "languageid" column. */
  139969. for(i=0; i<pInfo->nConstraint; i++){
  139970. if( pInfo->aConstraint[i].usable ){
  139971. int op = pInfo->aConstraint[i].op;
  139972. int iCol = pInfo->aConstraint[i].iColumn;
  139973. if( iCol==0 ){
  139974. if( op==SQLITE_INDEX_CONSTRAINT_EQ ) iEq = i;
  139975. if( op==SQLITE_INDEX_CONSTRAINT_LT ) iLe = i;
  139976. if( op==SQLITE_INDEX_CONSTRAINT_LE ) iLe = i;
  139977. if( op==SQLITE_INDEX_CONSTRAINT_GT ) iGe = i;
  139978. if( op==SQLITE_INDEX_CONSTRAINT_GE ) iGe = i;
  139979. }
  139980. if( iCol==4 ){
  139981. if( op==SQLITE_INDEX_CONSTRAINT_EQ ) iLangid = i;
  139982. }
  139983. }
  139984. }
  139985. if( iEq>=0 ){
  139986. pInfo->idxNum = FTS4AUX_EQ_CONSTRAINT;
  139987. pInfo->aConstraintUsage[iEq].argvIndex = iNext++;
  139988. pInfo->estimatedCost = 5;
  139989. }else{
  139990. pInfo->idxNum = 0;
  139991. pInfo->estimatedCost = 20000;
  139992. if( iGe>=0 ){
  139993. pInfo->idxNum += FTS4AUX_GE_CONSTRAINT;
  139994. pInfo->aConstraintUsage[iGe].argvIndex = iNext++;
  139995. pInfo->estimatedCost /= 2;
  139996. }
  139997. if( iLe>=0 ){
  139998. pInfo->idxNum += FTS4AUX_LE_CONSTRAINT;
  139999. pInfo->aConstraintUsage[iLe].argvIndex = iNext++;
  140000. pInfo->estimatedCost /= 2;
  140001. }
  140002. }
  140003. if( iLangid>=0 ){
  140004. pInfo->aConstraintUsage[iLangid].argvIndex = iNext++;
  140005. pInfo->estimatedCost--;
  140006. }
  140007. return SQLITE_OK;
  140008. }
  140009. /*
  140010. ** xOpen - Open a cursor.
  140011. */
  140012. static int fts3auxOpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  140013. Fts3auxCursor *pCsr; /* Pointer to cursor object to return */
  140014. UNUSED_PARAMETER(pVTab);
  140015. pCsr = (Fts3auxCursor *)sqlite3_malloc(sizeof(Fts3auxCursor));
  140016. if( !pCsr ) return SQLITE_NOMEM;
  140017. memset(pCsr, 0, sizeof(Fts3auxCursor));
  140018. *ppCsr = (sqlite3_vtab_cursor *)pCsr;
  140019. return SQLITE_OK;
  140020. }
  140021. /*
  140022. ** xClose - Close a cursor.
  140023. */
  140024. static int fts3auxCloseMethod(sqlite3_vtab_cursor *pCursor){
  140025. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  140026. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  140027. sqlite3Fts3SegmentsClose(pFts3);
  140028. sqlite3Fts3SegReaderFinish(&pCsr->csr);
  140029. sqlite3_free((void *)pCsr->filter.zTerm);
  140030. sqlite3_free(pCsr->zStop);
  140031. sqlite3_free(pCsr->aStat);
  140032. sqlite3_free(pCsr);
  140033. return SQLITE_OK;
  140034. }
  140035. static int fts3auxGrowStatArray(Fts3auxCursor *pCsr, int nSize){
  140036. if( nSize>pCsr->nStat ){
  140037. struct Fts3auxColstats *aNew;
  140038. aNew = (struct Fts3auxColstats *)sqlite3_realloc(pCsr->aStat,
  140039. sizeof(struct Fts3auxColstats) * nSize
  140040. );
  140041. if( aNew==0 ) return SQLITE_NOMEM;
  140042. memset(&aNew[pCsr->nStat], 0,
  140043. sizeof(struct Fts3auxColstats) * (nSize - pCsr->nStat)
  140044. );
  140045. pCsr->aStat = aNew;
  140046. pCsr->nStat = nSize;
  140047. }
  140048. return SQLITE_OK;
  140049. }
  140050. /*
  140051. ** xNext - Advance the cursor to the next row, if any.
  140052. */
  140053. static int fts3auxNextMethod(sqlite3_vtab_cursor *pCursor){
  140054. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  140055. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  140056. int rc;
  140057. /* Increment our pretend rowid value. */
  140058. pCsr->iRowid++;
  140059. for(pCsr->iCol++; pCsr->iCol<pCsr->nStat; pCsr->iCol++){
  140060. if( pCsr->aStat[pCsr->iCol].nDoc>0 ) return SQLITE_OK;
  140061. }
  140062. rc = sqlite3Fts3SegReaderStep(pFts3, &pCsr->csr);
  140063. if( rc==SQLITE_ROW ){
  140064. int i = 0;
  140065. int nDoclist = pCsr->csr.nDoclist;
  140066. char *aDoclist = pCsr->csr.aDoclist;
  140067. int iCol;
  140068. int eState = 0;
  140069. if( pCsr->zStop ){
  140070. int n = (pCsr->nStop<pCsr->csr.nTerm) ? pCsr->nStop : pCsr->csr.nTerm;
  140071. int mc = memcmp(pCsr->zStop, pCsr->csr.zTerm, n);
  140072. if( mc<0 || (mc==0 && pCsr->csr.nTerm>pCsr->nStop) ){
  140073. pCsr->isEof = 1;
  140074. return SQLITE_OK;
  140075. }
  140076. }
  140077. if( fts3auxGrowStatArray(pCsr, 2) ) return SQLITE_NOMEM;
  140078. memset(pCsr->aStat, 0, sizeof(struct Fts3auxColstats) * pCsr->nStat);
  140079. iCol = 0;
  140080. while( i<nDoclist ){
  140081. sqlite3_int64 v = 0;
  140082. i += sqlite3Fts3GetVarint(&aDoclist[i], &v);
  140083. switch( eState ){
  140084. /* State 0. In this state the integer just read was a docid. */
  140085. case 0:
  140086. pCsr->aStat[0].nDoc++;
  140087. eState = 1;
  140088. iCol = 0;
  140089. break;
  140090. /* State 1. In this state we are expecting either a 1, indicating
  140091. ** that the following integer will be a column number, or the
  140092. ** start of a position list for column 0.
  140093. **
  140094. ** The only difference between state 1 and state 2 is that if the
  140095. ** integer encountered in state 1 is not 0 or 1, then we need to
  140096. ** increment the column 0 "nDoc" count for this term.
  140097. */
  140098. case 1:
  140099. assert( iCol==0 );
  140100. if( v>1 ){
  140101. pCsr->aStat[1].nDoc++;
  140102. }
  140103. eState = 2;
  140104. /* fall through */
  140105. case 2:
  140106. if( v==0 ){ /* 0x00. Next integer will be a docid. */
  140107. eState = 0;
  140108. }else if( v==1 ){ /* 0x01. Next integer will be a column number. */
  140109. eState = 3;
  140110. }else{ /* 2 or greater. A position. */
  140111. pCsr->aStat[iCol+1].nOcc++;
  140112. pCsr->aStat[0].nOcc++;
  140113. }
  140114. break;
  140115. /* State 3. The integer just read is a column number. */
  140116. default: assert( eState==3 );
  140117. iCol = (int)v;
  140118. if( fts3auxGrowStatArray(pCsr, iCol+2) ) return SQLITE_NOMEM;
  140119. pCsr->aStat[iCol+1].nDoc++;
  140120. eState = 2;
  140121. break;
  140122. }
  140123. }
  140124. pCsr->iCol = 0;
  140125. rc = SQLITE_OK;
  140126. }else{
  140127. pCsr->isEof = 1;
  140128. }
  140129. return rc;
  140130. }
  140131. /*
  140132. ** xFilter - Initialize a cursor to point at the start of its data.
  140133. */
  140134. static int fts3auxFilterMethod(
  140135. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  140136. int idxNum, /* Strategy index */
  140137. const char *idxStr, /* Unused */
  140138. int nVal, /* Number of elements in apVal */
  140139. sqlite3_value **apVal /* Arguments for the indexing scheme */
  140140. ){
  140141. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  140142. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  140143. int rc;
  140144. int isScan = 0;
  140145. int iLangVal = 0; /* Language id to query */
  140146. int iEq = -1; /* Index of term=? value in apVal */
  140147. int iGe = -1; /* Index of term>=? value in apVal */
  140148. int iLe = -1; /* Index of term<=? value in apVal */
  140149. int iLangid = -1; /* Index of languageid=? value in apVal */
  140150. int iNext = 0;
  140151. UNUSED_PARAMETER(nVal);
  140152. UNUSED_PARAMETER(idxStr);
  140153. assert( idxStr==0 );
  140154. assert( idxNum==FTS4AUX_EQ_CONSTRAINT || idxNum==0
  140155. || idxNum==FTS4AUX_LE_CONSTRAINT || idxNum==FTS4AUX_GE_CONSTRAINT
  140156. || idxNum==(FTS4AUX_LE_CONSTRAINT|FTS4AUX_GE_CONSTRAINT)
  140157. );
  140158. if( idxNum==FTS4AUX_EQ_CONSTRAINT ){
  140159. iEq = iNext++;
  140160. }else{
  140161. isScan = 1;
  140162. if( idxNum & FTS4AUX_GE_CONSTRAINT ){
  140163. iGe = iNext++;
  140164. }
  140165. if( idxNum & FTS4AUX_LE_CONSTRAINT ){
  140166. iLe = iNext++;
  140167. }
  140168. }
  140169. if( iNext<nVal ){
  140170. iLangid = iNext++;
  140171. }
  140172. /* In case this cursor is being reused, close and zero it. */
  140173. testcase(pCsr->filter.zTerm);
  140174. sqlite3Fts3SegReaderFinish(&pCsr->csr);
  140175. sqlite3_free((void *)pCsr->filter.zTerm);
  140176. sqlite3_free(pCsr->aStat);
  140177. memset(&pCsr->csr, 0, ((u8*)&pCsr[1]) - (u8*)&pCsr->csr);
  140178. pCsr->filter.flags = FTS3_SEGMENT_REQUIRE_POS|FTS3_SEGMENT_IGNORE_EMPTY;
  140179. if( isScan ) pCsr->filter.flags |= FTS3_SEGMENT_SCAN;
  140180. if( iEq>=0 || iGe>=0 ){
  140181. const unsigned char *zStr = sqlite3_value_text(apVal[0]);
  140182. assert( (iEq==0 && iGe==-1) || (iEq==-1 && iGe==0) );
  140183. if( zStr ){
  140184. pCsr->filter.zTerm = sqlite3_mprintf("%s", zStr);
  140185. pCsr->filter.nTerm = sqlite3_value_bytes(apVal[0]);
  140186. if( pCsr->filter.zTerm==0 ) return SQLITE_NOMEM;
  140187. }
  140188. }
  140189. if( iLe>=0 ){
  140190. pCsr->zStop = sqlite3_mprintf("%s", sqlite3_value_text(apVal[iLe]));
  140191. pCsr->nStop = sqlite3_value_bytes(apVal[iLe]);
  140192. if( pCsr->zStop==0 ) return SQLITE_NOMEM;
  140193. }
  140194. if( iLangid>=0 ){
  140195. iLangVal = sqlite3_value_int(apVal[iLangid]);
  140196. /* If the user specified a negative value for the languageid, use zero
  140197. ** instead. This works, as the "languageid=?" constraint will also
  140198. ** be tested by the VDBE layer. The test will always be false (since
  140199. ** this module will not return a row with a negative languageid), and
  140200. ** so the overall query will return zero rows. */
  140201. if( iLangVal<0 ) iLangVal = 0;
  140202. }
  140203. pCsr->iLangid = iLangVal;
  140204. rc = sqlite3Fts3SegReaderCursor(pFts3, iLangVal, 0, FTS3_SEGCURSOR_ALL,
  140205. pCsr->filter.zTerm, pCsr->filter.nTerm, 0, isScan, &pCsr->csr
  140206. );
  140207. if( rc==SQLITE_OK ){
  140208. rc = sqlite3Fts3SegReaderStart(pFts3, &pCsr->csr, &pCsr->filter);
  140209. }
  140210. if( rc==SQLITE_OK ) rc = fts3auxNextMethod(pCursor);
  140211. return rc;
  140212. }
  140213. /*
  140214. ** xEof - Return true if the cursor is at EOF, or false otherwise.
  140215. */
  140216. static int fts3auxEofMethod(sqlite3_vtab_cursor *pCursor){
  140217. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  140218. return pCsr->isEof;
  140219. }
  140220. /*
  140221. ** xColumn - Return a column value.
  140222. */
  140223. static int fts3auxColumnMethod(
  140224. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  140225. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  140226. int iCol /* Index of column to read value from */
  140227. ){
  140228. Fts3auxCursor *p = (Fts3auxCursor *)pCursor;
  140229. assert( p->isEof==0 );
  140230. switch( iCol ){
  140231. case 0: /* term */
  140232. sqlite3_result_text(pCtx, p->csr.zTerm, p->csr.nTerm, SQLITE_TRANSIENT);
  140233. break;
  140234. case 1: /* col */
  140235. if( p->iCol ){
  140236. sqlite3_result_int(pCtx, p->iCol-1);
  140237. }else{
  140238. sqlite3_result_text(pCtx, "*", -1, SQLITE_STATIC);
  140239. }
  140240. break;
  140241. case 2: /* documents */
  140242. sqlite3_result_int64(pCtx, p->aStat[p->iCol].nDoc);
  140243. break;
  140244. case 3: /* occurrences */
  140245. sqlite3_result_int64(pCtx, p->aStat[p->iCol].nOcc);
  140246. break;
  140247. default: /* languageid */
  140248. assert( iCol==4 );
  140249. sqlite3_result_int(pCtx, p->iLangid);
  140250. break;
  140251. }
  140252. return SQLITE_OK;
  140253. }
  140254. /*
  140255. ** xRowid - Return the current rowid for the cursor.
  140256. */
  140257. static int fts3auxRowidMethod(
  140258. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  140259. sqlite_int64 *pRowid /* OUT: Rowid value */
  140260. ){
  140261. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  140262. *pRowid = pCsr->iRowid;
  140263. return SQLITE_OK;
  140264. }
  140265. /*
  140266. ** Register the fts3aux module with database connection db. Return SQLITE_OK
  140267. ** if successful or an error code if sqlite3_create_module() fails.
  140268. */
  140269. SQLITE_PRIVATE int sqlite3Fts3InitAux(sqlite3 *db){
  140270. static const sqlite3_module fts3aux_module = {
  140271. 0, /* iVersion */
  140272. fts3auxConnectMethod, /* xCreate */
  140273. fts3auxConnectMethod, /* xConnect */
  140274. fts3auxBestIndexMethod, /* xBestIndex */
  140275. fts3auxDisconnectMethod, /* xDisconnect */
  140276. fts3auxDisconnectMethod, /* xDestroy */
  140277. fts3auxOpenMethod, /* xOpen */
  140278. fts3auxCloseMethod, /* xClose */
  140279. fts3auxFilterMethod, /* xFilter */
  140280. fts3auxNextMethod, /* xNext */
  140281. fts3auxEofMethod, /* xEof */
  140282. fts3auxColumnMethod, /* xColumn */
  140283. fts3auxRowidMethod, /* xRowid */
  140284. 0, /* xUpdate */
  140285. 0, /* xBegin */
  140286. 0, /* xSync */
  140287. 0, /* xCommit */
  140288. 0, /* xRollback */
  140289. 0, /* xFindFunction */
  140290. 0, /* xRename */
  140291. 0, /* xSavepoint */
  140292. 0, /* xRelease */
  140293. 0 /* xRollbackTo */
  140294. };
  140295. int rc; /* Return code */
  140296. rc = sqlite3_create_module(db, "fts4aux", &fts3aux_module, 0);
  140297. return rc;
  140298. }
  140299. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  140300. /************** End of fts3_aux.c ********************************************/
  140301. /************** Begin file fts3_expr.c ***************************************/
  140302. /*
  140303. ** 2008 Nov 28
  140304. **
  140305. ** The author disclaims copyright to this source code. In place of
  140306. ** a legal notice, here is a blessing:
  140307. **
  140308. ** May you do good and not evil.
  140309. ** May you find forgiveness for yourself and forgive others.
  140310. ** May you share freely, never taking more than you give.
  140311. **
  140312. ******************************************************************************
  140313. **
  140314. ** This module contains code that implements a parser for fts3 query strings
  140315. ** (the right-hand argument to the MATCH operator). Because the supported
  140316. ** syntax is relatively simple, the whole tokenizer/parser system is
  140317. ** hand-coded.
  140318. */
  140319. /* #include "fts3Int.h" */
  140320. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  140321. /*
  140322. ** By default, this module parses the legacy syntax that has been
  140323. ** traditionally used by fts3. Or, if SQLITE_ENABLE_FTS3_PARENTHESIS
  140324. ** is defined, then it uses the new syntax. The differences between
  140325. ** the new and the old syntaxes are:
  140326. **
  140327. ** a) The new syntax supports parenthesis. The old does not.
  140328. **
  140329. ** b) The new syntax supports the AND and NOT operators. The old does not.
  140330. **
  140331. ** c) The old syntax supports the "-" token qualifier. This is not
  140332. ** supported by the new syntax (it is replaced by the NOT operator).
  140333. **
  140334. ** d) When using the old syntax, the OR operator has a greater precedence
  140335. ** than an implicit AND. When using the new, both implicity and explicit
  140336. ** AND operators have a higher precedence than OR.
  140337. **
  140338. ** If compiled with SQLITE_TEST defined, then this module exports the
  140339. ** symbol "int sqlite3_fts3_enable_parentheses". Setting this variable
  140340. ** to zero causes the module to use the old syntax. If it is set to
  140341. ** non-zero the new syntax is activated. This is so both syntaxes can
  140342. ** be tested using a single build of testfixture.
  140343. **
  140344. ** The following describes the syntax supported by the fts3 MATCH
  140345. ** operator in a similar format to that used by the lemon parser
  140346. ** generator. This module does not use actually lemon, it uses a
  140347. ** custom parser.
  140348. **
  140349. ** query ::= andexpr (OR andexpr)*.
  140350. **
  140351. ** andexpr ::= notexpr (AND? notexpr)*.
  140352. **
  140353. ** notexpr ::= nearexpr (NOT nearexpr|-TOKEN)*.
  140354. ** notexpr ::= LP query RP.
  140355. **
  140356. ** nearexpr ::= phrase (NEAR distance_opt nearexpr)*.
  140357. **
  140358. ** distance_opt ::= .
  140359. ** distance_opt ::= / INTEGER.
  140360. **
  140361. ** phrase ::= TOKEN.
  140362. ** phrase ::= COLUMN:TOKEN.
  140363. ** phrase ::= "TOKEN TOKEN TOKEN...".
  140364. */
  140365. #ifdef SQLITE_TEST
  140366. SQLITE_API int sqlite3_fts3_enable_parentheses = 0;
  140367. #else
  140368. # ifdef SQLITE_ENABLE_FTS3_PARENTHESIS
  140369. # define sqlite3_fts3_enable_parentheses 1
  140370. # else
  140371. # define sqlite3_fts3_enable_parentheses 0
  140372. # endif
  140373. #endif
  140374. /*
  140375. ** Default span for NEAR operators.
  140376. */
  140377. #define SQLITE_FTS3_DEFAULT_NEAR_PARAM 10
  140378. /* #include <string.h> */
  140379. /* #include <assert.h> */
  140380. /*
  140381. ** isNot:
  140382. ** This variable is used by function getNextNode(). When getNextNode() is
  140383. ** called, it sets ParseContext.isNot to true if the 'next node' is a
  140384. ** FTSQUERY_PHRASE with a unary "-" attached to it. i.e. "mysql" in the
  140385. ** FTS3 query "sqlite -mysql". Otherwise, ParseContext.isNot is set to
  140386. ** zero.
  140387. */
  140388. typedef struct ParseContext ParseContext;
  140389. struct ParseContext {
  140390. sqlite3_tokenizer *pTokenizer; /* Tokenizer module */
  140391. int iLangid; /* Language id used with tokenizer */
  140392. const char **azCol; /* Array of column names for fts3 table */
  140393. int bFts4; /* True to allow FTS4-only syntax */
  140394. int nCol; /* Number of entries in azCol[] */
  140395. int iDefaultCol; /* Default column to query */
  140396. int isNot; /* True if getNextNode() sees a unary - */
  140397. sqlite3_context *pCtx; /* Write error message here */
  140398. int nNest; /* Number of nested brackets */
  140399. };
  140400. /*
  140401. ** This function is equivalent to the standard isspace() function.
  140402. **
  140403. ** The standard isspace() can be awkward to use safely, because although it
  140404. ** is defined to accept an argument of type int, its behavior when passed
  140405. ** an integer that falls outside of the range of the unsigned char type
  140406. ** is undefined (and sometimes, "undefined" means segfault). This wrapper
  140407. ** is defined to accept an argument of type char, and always returns 0 for
  140408. ** any values that fall outside of the range of the unsigned char type (i.e.
  140409. ** negative values).
  140410. */
  140411. static int fts3isspace(char c){
  140412. return c==' ' || c=='\t' || c=='\n' || c=='\r' || c=='\v' || c=='\f';
  140413. }
  140414. /*
  140415. ** Allocate nByte bytes of memory using sqlite3_malloc(). If successful,
  140416. ** zero the memory before returning a pointer to it. If unsuccessful,
  140417. ** return NULL.
  140418. */
  140419. static void *fts3MallocZero(int nByte){
  140420. void *pRet = sqlite3_malloc(nByte);
  140421. if( pRet ) memset(pRet, 0, nByte);
  140422. return pRet;
  140423. }
  140424. SQLITE_PRIVATE int sqlite3Fts3OpenTokenizer(
  140425. sqlite3_tokenizer *pTokenizer,
  140426. int iLangid,
  140427. const char *z,
  140428. int n,
  140429. sqlite3_tokenizer_cursor **ppCsr
  140430. ){
  140431. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  140432. sqlite3_tokenizer_cursor *pCsr = 0;
  140433. int rc;
  140434. rc = pModule->xOpen(pTokenizer, z, n, &pCsr);
  140435. assert( rc==SQLITE_OK || pCsr==0 );
  140436. if( rc==SQLITE_OK ){
  140437. pCsr->pTokenizer = pTokenizer;
  140438. if( pModule->iVersion>=1 ){
  140439. rc = pModule->xLanguageid(pCsr, iLangid);
  140440. if( rc!=SQLITE_OK ){
  140441. pModule->xClose(pCsr);
  140442. pCsr = 0;
  140443. }
  140444. }
  140445. }
  140446. *ppCsr = pCsr;
  140447. return rc;
  140448. }
  140449. /*
  140450. ** Function getNextNode(), which is called by fts3ExprParse(), may itself
  140451. ** call fts3ExprParse(). So this forward declaration is required.
  140452. */
  140453. static int fts3ExprParse(ParseContext *, const char *, int, Fts3Expr **, int *);
  140454. /*
  140455. ** Extract the next token from buffer z (length n) using the tokenizer
  140456. ** and other information (column names etc.) in pParse. Create an Fts3Expr
  140457. ** structure of type FTSQUERY_PHRASE containing a phrase consisting of this
  140458. ** single token and set *ppExpr to point to it. If the end of the buffer is
  140459. ** reached before a token is found, set *ppExpr to zero. It is the
  140460. ** responsibility of the caller to eventually deallocate the allocated
  140461. ** Fts3Expr structure (if any) by passing it to sqlite3_free().
  140462. **
  140463. ** Return SQLITE_OK if successful, or SQLITE_NOMEM if a memory allocation
  140464. ** fails.
  140465. */
  140466. static int getNextToken(
  140467. ParseContext *pParse, /* fts3 query parse context */
  140468. int iCol, /* Value for Fts3Phrase.iColumn */
  140469. const char *z, int n, /* Input string */
  140470. Fts3Expr **ppExpr, /* OUT: expression */
  140471. int *pnConsumed /* OUT: Number of bytes consumed */
  140472. ){
  140473. sqlite3_tokenizer *pTokenizer = pParse->pTokenizer;
  140474. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  140475. int rc;
  140476. sqlite3_tokenizer_cursor *pCursor;
  140477. Fts3Expr *pRet = 0;
  140478. int i = 0;
  140479. /* Set variable i to the maximum number of bytes of input to tokenize. */
  140480. for(i=0; i<n; i++){
  140481. if( sqlite3_fts3_enable_parentheses && (z[i]=='(' || z[i]==')') ) break;
  140482. if( z[i]=='"' ) break;
  140483. }
  140484. *pnConsumed = i;
  140485. rc = sqlite3Fts3OpenTokenizer(pTokenizer, pParse->iLangid, z, i, &pCursor);
  140486. if( rc==SQLITE_OK ){
  140487. const char *zToken;
  140488. int nToken = 0, iStart = 0, iEnd = 0, iPosition = 0;
  140489. int nByte; /* total space to allocate */
  140490. rc = pModule->xNext(pCursor, &zToken, &nToken, &iStart, &iEnd, &iPosition);
  140491. if( rc==SQLITE_OK ){
  140492. nByte = sizeof(Fts3Expr) + sizeof(Fts3Phrase) + nToken;
  140493. pRet = (Fts3Expr *)fts3MallocZero(nByte);
  140494. if( !pRet ){
  140495. rc = SQLITE_NOMEM;
  140496. }else{
  140497. pRet->eType = FTSQUERY_PHRASE;
  140498. pRet->pPhrase = (Fts3Phrase *)&pRet[1];
  140499. pRet->pPhrase->nToken = 1;
  140500. pRet->pPhrase->iColumn = iCol;
  140501. pRet->pPhrase->aToken[0].n = nToken;
  140502. pRet->pPhrase->aToken[0].z = (char *)&pRet->pPhrase[1];
  140503. memcpy(pRet->pPhrase->aToken[0].z, zToken, nToken);
  140504. if( iEnd<n && z[iEnd]=='*' ){
  140505. pRet->pPhrase->aToken[0].isPrefix = 1;
  140506. iEnd++;
  140507. }
  140508. while( 1 ){
  140509. if( !sqlite3_fts3_enable_parentheses
  140510. && iStart>0 && z[iStart-1]=='-'
  140511. ){
  140512. pParse->isNot = 1;
  140513. iStart--;
  140514. }else if( pParse->bFts4 && iStart>0 && z[iStart-1]=='^' ){
  140515. pRet->pPhrase->aToken[0].bFirst = 1;
  140516. iStart--;
  140517. }else{
  140518. break;
  140519. }
  140520. }
  140521. }
  140522. *pnConsumed = iEnd;
  140523. }else if( i && rc==SQLITE_DONE ){
  140524. rc = SQLITE_OK;
  140525. }
  140526. pModule->xClose(pCursor);
  140527. }
  140528. *ppExpr = pRet;
  140529. return rc;
  140530. }
  140531. /*
  140532. ** Enlarge a memory allocation. If an out-of-memory allocation occurs,
  140533. ** then free the old allocation.
  140534. */
  140535. static void *fts3ReallocOrFree(void *pOrig, int nNew){
  140536. void *pRet = sqlite3_realloc(pOrig, nNew);
  140537. if( !pRet ){
  140538. sqlite3_free(pOrig);
  140539. }
  140540. return pRet;
  140541. }
  140542. /*
  140543. ** Buffer zInput, length nInput, contains the contents of a quoted string
  140544. ** that appeared as part of an fts3 query expression. Neither quote character
  140545. ** is included in the buffer. This function attempts to tokenize the entire
  140546. ** input buffer and create an Fts3Expr structure of type FTSQUERY_PHRASE
  140547. ** containing the results.
  140548. **
  140549. ** If successful, SQLITE_OK is returned and *ppExpr set to point at the
  140550. ** allocated Fts3Expr structure. Otherwise, either SQLITE_NOMEM (out of memory
  140551. ** error) or SQLITE_ERROR (tokenization error) is returned and *ppExpr set
  140552. ** to 0.
  140553. */
  140554. static int getNextString(
  140555. ParseContext *pParse, /* fts3 query parse context */
  140556. const char *zInput, int nInput, /* Input string */
  140557. Fts3Expr **ppExpr /* OUT: expression */
  140558. ){
  140559. sqlite3_tokenizer *pTokenizer = pParse->pTokenizer;
  140560. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  140561. int rc;
  140562. Fts3Expr *p = 0;
  140563. sqlite3_tokenizer_cursor *pCursor = 0;
  140564. char *zTemp = 0;
  140565. int nTemp = 0;
  140566. const int nSpace = sizeof(Fts3Expr) + sizeof(Fts3Phrase);
  140567. int nToken = 0;
  140568. /* The final Fts3Expr data structure, including the Fts3Phrase,
  140569. ** Fts3PhraseToken structures token buffers are all stored as a single
  140570. ** allocation so that the expression can be freed with a single call to
  140571. ** sqlite3_free(). Setting this up requires a two pass approach.
  140572. **
  140573. ** The first pass, in the block below, uses a tokenizer cursor to iterate
  140574. ** through the tokens in the expression. This pass uses fts3ReallocOrFree()
  140575. ** to assemble data in two dynamic buffers:
  140576. **
  140577. ** Buffer p: Points to the Fts3Expr structure, followed by the Fts3Phrase
  140578. ** structure, followed by the array of Fts3PhraseToken
  140579. ** structures. This pass only populates the Fts3PhraseToken array.
  140580. **
  140581. ** Buffer zTemp: Contains copies of all tokens.
  140582. **
  140583. ** The second pass, in the block that begins "if( rc==SQLITE_DONE )" below,
  140584. ** appends buffer zTemp to buffer p, and fills in the Fts3Expr and Fts3Phrase
  140585. ** structures.
  140586. */
  140587. rc = sqlite3Fts3OpenTokenizer(
  140588. pTokenizer, pParse->iLangid, zInput, nInput, &pCursor);
  140589. if( rc==SQLITE_OK ){
  140590. int ii;
  140591. for(ii=0; rc==SQLITE_OK; ii++){
  140592. const char *zByte;
  140593. int nByte = 0, iBegin = 0, iEnd = 0, iPos = 0;
  140594. rc = pModule->xNext(pCursor, &zByte, &nByte, &iBegin, &iEnd, &iPos);
  140595. if( rc==SQLITE_OK ){
  140596. Fts3PhraseToken *pToken;
  140597. p = fts3ReallocOrFree(p, nSpace + ii*sizeof(Fts3PhraseToken));
  140598. if( !p ) goto no_mem;
  140599. zTemp = fts3ReallocOrFree(zTemp, nTemp + nByte);
  140600. if( !zTemp ) goto no_mem;
  140601. assert( nToken==ii );
  140602. pToken = &((Fts3Phrase *)(&p[1]))->aToken[ii];
  140603. memset(pToken, 0, sizeof(Fts3PhraseToken));
  140604. memcpy(&zTemp[nTemp], zByte, nByte);
  140605. nTemp += nByte;
  140606. pToken->n = nByte;
  140607. pToken->isPrefix = (iEnd<nInput && zInput[iEnd]=='*');
  140608. pToken->bFirst = (iBegin>0 && zInput[iBegin-1]=='^');
  140609. nToken = ii+1;
  140610. }
  140611. }
  140612. pModule->xClose(pCursor);
  140613. pCursor = 0;
  140614. }
  140615. if( rc==SQLITE_DONE ){
  140616. int jj;
  140617. char *zBuf = 0;
  140618. p = fts3ReallocOrFree(p, nSpace + nToken*sizeof(Fts3PhraseToken) + nTemp);
  140619. if( !p ) goto no_mem;
  140620. memset(p, 0, (char *)&(((Fts3Phrase *)&p[1])->aToken[0])-(char *)p);
  140621. p->eType = FTSQUERY_PHRASE;
  140622. p->pPhrase = (Fts3Phrase *)&p[1];
  140623. p->pPhrase->iColumn = pParse->iDefaultCol;
  140624. p->pPhrase->nToken = nToken;
  140625. zBuf = (char *)&p->pPhrase->aToken[nToken];
  140626. if( zTemp ){
  140627. memcpy(zBuf, zTemp, nTemp);
  140628. sqlite3_free(zTemp);
  140629. }else{
  140630. assert( nTemp==0 );
  140631. }
  140632. for(jj=0; jj<p->pPhrase->nToken; jj++){
  140633. p->pPhrase->aToken[jj].z = zBuf;
  140634. zBuf += p->pPhrase->aToken[jj].n;
  140635. }
  140636. rc = SQLITE_OK;
  140637. }
  140638. *ppExpr = p;
  140639. return rc;
  140640. no_mem:
  140641. if( pCursor ){
  140642. pModule->xClose(pCursor);
  140643. }
  140644. sqlite3_free(zTemp);
  140645. sqlite3_free(p);
  140646. *ppExpr = 0;
  140647. return SQLITE_NOMEM;
  140648. }
  140649. /*
  140650. ** The output variable *ppExpr is populated with an allocated Fts3Expr
  140651. ** structure, or set to 0 if the end of the input buffer is reached.
  140652. **
  140653. ** Returns an SQLite error code. SQLITE_OK if everything works, SQLITE_NOMEM
  140654. ** if a malloc failure occurs, or SQLITE_ERROR if a parse error is encountered.
  140655. ** If SQLITE_ERROR is returned, pContext is populated with an error message.
  140656. */
  140657. static int getNextNode(
  140658. ParseContext *pParse, /* fts3 query parse context */
  140659. const char *z, int n, /* Input string */
  140660. Fts3Expr **ppExpr, /* OUT: expression */
  140661. int *pnConsumed /* OUT: Number of bytes consumed */
  140662. ){
  140663. static const struct Fts3Keyword {
  140664. char *z; /* Keyword text */
  140665. unsigned char n; /* Length of the keyword */
  140666. unsigned char parenOnly; /* Only valid in paren mode */
  140667. unsigned char eType; /* Keyword code */
  140668. } aKeyword[] = {
  140669. { "OR" , 2, 0, FTSQUERY_OR },
  140670. { "AND", 3, 1, FTSQUERY_AND },
  140671. { "NOT", 3, 1, FTSQUERY_NOT },
  140672. { "NEAR", 4, 0, FTSQUERY_NEAR }
  140673. };
  140674. int ii;
  140675. int iCol;
  140676. int iColLen;
  140677. int rc;
  140678. Fts3Expr *pRet = 0;
  140679. const char *zInput = z;
  140680. int nInput = n;
  140681. pParse->isNot = 0;
  140682. /* Skip over any whitespace before checking for a keyword, an open or
  140683. ** close bracket, or a quoted string.
  140684. */
  140685. while( nInput>0 && fts3isspace(*zInput) ){
  140686. nInput--;
  140687. zInput++;
  140688. }
  140689. if( nInput==0 ){
  140690. return SQLITE_DONE;
  140691. }
  140692. /* See if we are dealing with a keyword. */
  140693. for(ii=0; ii<(int)(sizeof(aKeyword)/sizeof(struct Fts3Keyword)); ii++){
  140694. const struct Fts3Keyword *pKey = &aKeyword[ii];
  140695. if( (pKey->parenOnly & ~sqlite3_fts3_enable_parentheses)!=0 ){
  140696. continue;
  140697. }
  140698. if( nInput>=pKey->n && 0==memcmp(zInput, pKey->z, pKey->n) ){
  140699. int nNear = SQLITE_FTS3_DEFAULT_NEAR_PARAM;
  140700. int nKey = pKey->n;
  140701. char cNext;
  140702. /* If this is a "NEAR" keyword, check for an explicit nearness. */
  140703. if( pKey->eType==FTSQUERY_NEAR ){
  140704. assert( nKey==4 );
  140705. if( zInput[4]=='/' && zInput[5]>='0' && zInput[5]<='9' ){
  140706. nNear = 0;
  140707. for(nKey=5; zInput[nKey]>='0' && zInput[nKey]<='9'; nKey++){
  140708. nNear = nNear * 10 + (zInput[nKey] - '0');
  140709. }
  140710. }
  140711. }
  140712. /* At this point this is probably a keyword. But for that to be true,
  140713. ** the next byte must contain either whitespace, an open or close
  140714. ** parenthesis, a quote character, or EOF.
  140715. */
  140716. cNext = zInput[nKey];
  140717. if( fts3isspace(cNext)
  140718. || cNext=='"' || cNext=='(' || cNext==')' || cNext==0
  140719. ){
  140720. pRet = (Fts3Expr *)fts3MallocZero(sizeof(Fts3Expr));
  140721. if( !pRet ){
  140722. return SQLITE_NOMEM;
  140723. }
  140724. pRet->eType = pKey->eType;
  140725. pRet->nNear = nNear;
  140726. *ppExpr = pRet;
  140727. *pnConsumed = (int)((zInput - z) + nKey);
  140728. return SQLITE_OK;
  140729. }
  140730. /* Turns out that wasn't a keyword after all. This happens if the
  140731. ** user has supplied a token such as "ORacle". Continue.
  140732. */
  140733. }
  140734. }
  140735. /* See if we are dealing with a quoted phrase. If this is the case, then
  140736. ** search for the closing quote and pass the whole string to getNextString()
  140737. ** for processing. This is easy to do, as fts3 has no syntax for escaping
  140738. ** a quote character embedded in a string.
  140739. */
  140740. if( *zInput=='"' ){
  140741. for(ii=1; ii<nInput && zInput[ii]!='"'; ii++);
  140742. *pnConsumed = (int)((zInput - z) + ii + 1);
  140743. if( ii==nInput ){
  140744. return SQLITE_ERROR;
  140745. }
  140746. return getNextString(pParse, &zInput[1], ii-1, ppExpr);
  140747. }
  140748. if( sqlite3_fts3_enable_parentheses ){
  140749. if( *zInput=='(' ){
  140750. int nConsumed = 0;
  140751. pParse->nNest++;
  140752. rc = fts3ExprParse(pParse, zInput+1, nInput-1, ppExpr, &nConsumed);
  140753. if( rc==SQLITE_OK && !*ppExpr ){ rc = SQLITE_DONE; }
  140754. *pnConsumed = (int)(zInput - z) + 1 + nConsumed;
  140755. return rc;
  140756. }else if( *zInput==')' ){
  140757. pParse->nNest--;
  140758. *pnConsumed = (int)((zInput - z) + 1);
  140759. *ppExpr = 0;
  140760. return SQLITE_DONE;
  140761. }
  140762. }
  140763. /* If control flows to this point, this must be a regular token, or
  140764. ** the end of the input. Read a regular token using the sqlite3_tokenizer
  140765. ** interface. Before doing so, figure out if there is an explicit
  140766. ** column specifier for the token.
  140767. **
  140768. ** TODO: Strangely, it is not possible to associate a column specifier
  140769. ** with a quoted phrase, only with a single token. Not sure if this was
  140770. ** an implementation artifact or an intentional decision when fts3 was
  140771. ** first implemented. Whichever it was, this module duplicates the
  140772. ** limitation.
  140773. */
  140774. iCol = pParse->iDefaultCol;
  140775. iColLen = 0;
  140776. for(ii=0; ii<pParse->nCol; ii++){
  140777. const char *zStr = pParse->azCol[ii];
  140778. int nStr = (int)strlen(zStr);
  140779. if( nInput>nStr && zInput[nStr]==':'
  140780. && sqlite3_strnicmp(zStr, zInput, nStr)==0
  140781. ){
  140782. iCol = ii;
  140783. iColLen = (int)((zInput - z) + nStr + 1);
  140784. break;
  140785. }
  140786. }
  140787. rc = getNextToken(pParse, iCol, &z[iColLen], n-iColLen, ppExpr, pnConsumed);
  140788. *pnConsumed += iColLen;
  140789. return rc;
  140790. }
  140791. /*
  140792. ** The argument is an Fts3Expr structure for a binary operator (any type
  140793. ** except an FTSQUERY_PHRASE). Return an integer value representing the
  140794. ** precedence of the operator. Lower values have a higher precedence (i.e.
  140795. ** group more tightly). For example, in the C language, the == operator
  140796. ** groups more tightly than ||, and would therefore have a higher precedence.
  140797. **
  140798. ** When using the new fts3 query syntax (when SQLITE_ENABLE_FTS3_PARENTHESIS
  140799. ** is defined), the order of the operators in precedence from highest to
  140800. ** lowest is:
  140801. **
  140802. ** NEAR
  140803. ** NOT
  140804. ** AND (including implicit ANDs)
  140805. ** OR
  140806. **
  140807. ** Note that when using the old query syntax, the OR operator has a higher
  140808. ** precedence than the AND operator.
  140809. */
  140810. static int opPrecedence(Fts3Expr *p){
  140811. assert( p->eType!=FTSQUERY_PHRASE );
  140812. if( sqlite3_fts3_enable_parentheses ){
  140813. return p->eType;
  140814. }else if( p->eType==FTSQUERY_NEAR ){
  140815. return 1;
  140816. }else if( p->eType==FTSQUERY_OR ){
  140817. return 2;
  140818. }
  140819. assert( p->eType==FTSQUERY_AND );
  140820. return 3;
  140821. }
  140822. /*
  140823. ** Argument ppHead contains a pointer to the current head of a query
  140824. ** expression tree being parsed. pPrev is the expression node most recently
  140825. ** inserted into the tree. This function adds pNew, which is always a binary
  140826. ** operator node, into the expression tree based on the relative precedence
  140827. ** of pNew and the existing nodes of the tree. This may result in the head
  140828. ** of the tree changing, in which case *ppHead is set to the new root node.
  140829. */
  140830. static void insertBinaryOperator(
  140831. Fts3Expr **ppHead, /* Pointer to the root node of a tree */
  140832. Fts3Expr *pPrev, /* Node most recently inserted into the tree */
  140833. Fts3Expr *pNew /* New binary node to insert into expression tree */
  140834. ){
  140835. Fts3Expr *pSplit = pPrev;
  140836. while( pSplit->pParent && opPrecedence(pSplit->pParent)<=opPrecedence(pNew) ){
  140837. pSplit = pSplit->pParent;
  140838. }
  140839. if( pSplit->pParent ){
  140840. assert( pSplit->pParent->pRight==pSplit );
  140841. pSplit->pParent->pRight = pNew;
  140842. pNew->pParent = pSplit->pParent;
  140843. }else{
  140844. *ppHead = pNew;
  140845. }
  140846. pNew->pLeft = pSplit;
  140847. pSplit->pParent = pNew;
  140848. }
  140849. /*
  140850. ** Parse the fts3 query expression found in buffer z, length n. This function
  140851. ** returns either when the end of the buffer is reached or an unmatched
  140852. ** closing bracket - ')' - is encountered.
  140853. **
  140854. ** If successful, SQLITE_OK is returned, *ppExpr is set to point to the
  140855. ** parsed form of the expression and *pnConsumed is set to the number of
  140856. ** bytes read from buffer z. Otherwise, *ppExpr is set to 0 and SQLITE_NOMEM
  140857. ** (out of memory error) or SQLITE_ERROR (parse error) is returned.
  140858. */
  140859. static int fts3ExprParse(
  140860. ParseContext *pParse, /* fts3 query parse context */
  140861. const char *z, int n, /* Text of MATCH query */
  140862. Fts3Expr **ppExpr, /* OUT: Parsed query structure */
  140863. int *pnConsumed /* OUT: Number of bytes consumed */
  140864. ){
  140865. Fts3Expr *pRet = 0;
  140866. Fts3Expr *pPrev = 0;
  140867. Fts3Expr *pNotBranch = 0; /* Only used in legacy parse mode */
  140868. int nIn = n;
  140869. const char *zIn = z;
  140870. int rc = SQLITE_OK;
  140871. int isRequirePhrase = 1;
  140872. while( rc==SQLITE_OK ){
  140873. Fts3Expr *p = 0;
  140874. int nByte = 0;
  140875. rc = getNextNode(pParse, zIn, nIn, &p, &nByte);
  140876. assert( nByte>0 || (rc!=SQLITE_OK && p==0) );
  140877. if( rc==SQLITE_OK ){
  140878. if( p ){
  140879. int isPhrase;
  140880. if( !sqlite3_fts3_enable_parentheses
  140881. && p->eType==FTSQUERY_PHRASE && pParse->isNot
  140882. ){
  140883. /* Create an implicit NOT operator. */
  140884. Fts3Expr *pNot = fts3MallocZero(sizeof(Fts3Expr));
  140885. if( !pNot ){
  140886. sqlite3Fts3ExprFree(p);
  140887. rc = SQLITE_NOMEM;
  140888. goto exprparse_out;
  140889. }
  140890. pNot->eType = FTSQUERY_NOT;
  140891. pNot->pRight = p;
  140892. p->pParent = pNot;
  140893. if( pNotBranch ){
  140894. pNot->pLeft = pNotBranch;
  140895. pNotBranch->pParent = pNot;
  140896. }
  140897. pNotBranch = pNot;
  140898. p = pPrev;
  140899. }else{
  140900. int eType = p->eType;
  140901. isPhrase = (eType==FTSQUERY_PHRASE || p->pLeft);
  140902. /* The isRequirePhrase variable is set to true if a phrase or
  140903. ** an expression contained in parenthesis is required. If a
  140904. ** binary operator (AND, OR, NOT or NEAR) is encounted when
  140905. ** isRequirePhrase is set, this is a syntax error.
  140906. */
  140907. if( !isPhrase && isRequirePhrase ){
  140908. sqlite3Fts3ExprFree(p);
  140909. rc = SQLITE_ERROR;
  140910. goto exprparse_out;
  140911. }
  140912. if( isPhrase && !isRequirePhrase ){
  140913. /* Insert an implicit AND operator. */
  140914. Fts3Expr *pAnd;
  140915. assert( pRet && pPrev );
  140916. pAnd = fts3MallocZero(sizeof(Fts3Expr));
  140917. if( !pAnd ){
  140918. sqlite3Fts3ExprFree(p);
  140919. rc = SQLITE_NOMEM;
  140920. goto exprparse_out;
  140921. }
  140922. pAnd->eType = FTSQUERY_AND;
  140923. insertBinaryOperator(&pRet, pPrev, pAnd);
  140924. pPrev = pAnd;
  140925. }
  140926. /* This test catches attempts to make either operand of a NEAR
  140927. ** operator something other than a phrase. For example, either of
  140928. ** the following:
  140929. **
  140930. ** (bracketed expression) NEAR phrase
  140931. ** phrase NEAR (bracketed expression)
  140932. **
  140933. ** Return an error in either case.
  140934. */
  140935. if( pPrev && (
  140936. (eType==FTSQUERY_NEAR && !isPhrase && pPrev->eType!=FTSQUERY_PHRASE)
  140937. || (eType!=FTSQUERY_PHRASE && isPhrase && pPrev->eType==FTSQUERY_NEAR)
  140938. )){
  140939. sqlite3Fts3ExprFree(p);
  140940. rc = SQLITE_ERROR;
  140941. goto exprparse_out;
  140942. }
  140943. if( isPhrase ){
  140944. if( pRet ){
  140945. assert( pPrev && pPrev->pLeft && pPrev->pRight==0 );
  140946. pPrev->pRight = p;
  140947. p->pParent = pPrev;
  140948. }else{
  140949. pRet = p;
  140950. }
  140951. }else{
  140952. insertBinaryOperator(&pRet, pPrev, p);
  140953. }
  140954. isRequirePhrase = !isPhrase;
  140955. }
  140956. pPrev = p;
  140957. }
  140958. assert( nByte>0 );
  140959. }
  140960. assert( rc!=SQLITE_OK || (nByte>0 && nByte<=nIn) );
  140961. nIn -= nByte;
  140962. zIn += nByte;
  140963. }
  140964. if( rc==SQLITE_DONE && pRet && isRequirePhrase ){
  140965. rc = SQLITE_ERROR;
  140966. }
  140967. if( rc==SQLITE_DONE ){
  140968. rc = SQLITE_OK;
  140969. if( !sqlite3_fts3_enable_parentheses && pNotBranch ){
  140970. if( !pRet ){
  140971. rc = SQLITE_ERROR;
  140972. }else{
  140973. Fts3Expr *pIter = pNotBranch;
  140974. while( pIter->pLeft ){
  140975. pIter = pIter->pLeft;
  140976. }
  140977. pIter->pLeft = pRet;
  140978. pRet->pParent = pIter;
  140979. pRet = pNotBranch;
  140980. }
  140981. }
  140982. }
  140983. *pnConsumed = n - nIn;
  140984. exprparse_out:
  140985. if( rc!=SQLITE_OK ){
  140986. sqlite3Fts3ExprFree(pRet);
  140987. sqlite3Fts3ExprFree(pNotBranch);
  140988. pRet = 0;
  140989. }
  140990. *ppExpr = pRet;
  140991. return rc;
  140992. }
  140993. /*
  140994. ** Return SQLITE_ERROR if the maximum depth of the expression tree passed
  140995. ** as the only argument is more than nMaxDepth.
  140996. */
  140997. static int fts3ExprCheckDepth(Fts3Expr *p, int nMaxDepth){
  140998. int rc = SQLITE_OK;
  140999. if( p ){
  141000. if( nMaxDepth<0 ){
  141001. rc = SQLITE_TOOBIG;
  141002. }else{
  141003. rc = fts3ExprCheckDepth(p->pLeft, nMaxDepth-1);
  141004. if( rc==SQLITE_OK ){
  141005. rc = fts3ExprCheckDepth(p->pRight, nMaxDepth-1);
  141006. }
  141007. }
  141008. }
  141009. return rc;
  141010. }
  141011. /*
  141012. ** This function attempts to transform the expression tree at (*pp) to
  141013. ** an equivalent but more balanced form. The tree is modified in place.
  141014. ** If successful, SQLITE_OK is returned and (*pp) set to point to the
  141015. ** new root expression node.
  141016. **
  141017. ** nMaxDepth is the maximum allowable depth of the balanced sub-tree.
  141018. **
  141019. ** Otherwise, if an error occurs, an SQLite error code is returned and
  141020. ** expression (*pp) freed.
  141021. */
  141022. static int fts3ExprBalance(Fts3Expr **pp, int nMaxDepth){
  141023. int rc = SQLITE_OK; /* Return code */
  141024. Fts3Expr *pRoot = *pp; /* Initial root node */
  141025. Fts3Expr *pFree = 0; /* List of free nodes. Linked by pParent. */
  141026. int eType = pRoot->eType; /* Type of node in this tree */
  141027. if( nMaxDepth==0 ){
  141028. rc = SQLITE_ERROR;
  141029. }
  141030. if( rc==SQLITE_OK ){
  141031. if( (eType==FTSQUERY_AND || eType==FTSQUERY_OR) ){
  141032. Fts3Expr **apLeaf;
  141033. apLeaf = (Fts3Expr **)sqlite3_malloc(sizeof(Fts3Expr *) * nMaxDepth);
  141034. if( 0==apLeaf ){
  141035. rc = SQLITE_NOMEM;
  141036. }else{
  141037. memset(apLeaf, 0, sizeof(Fts3Expr *) * nMaxDepth);
  141038. }
  141039. if( rc==SQLITE_OK ){
  141040. int i;
  141041. Fts3Expr *p;
  141042. /* Set $p to point to the left-most leaf in the tree of eType nodes. */
  141043. for(p=pRoot; p->eType==eType; p=p->pLeft){
  141044. assert( p->pParent==0 || p->pParent->pLeft==p );
  141045. assert( p->pLeft && p->pRight );
  141046. }
  141047. /* This loop runs once for each leaf in the tree of eType nodes. */
  141048. while( 1 ){
  141049. int iLvl;
  141050. Fts3Expr *pParent = p->pParent; /* Current parent of p */
  141051. assert( pParent==0 || pParent->pLeft==p );
  141052. p->pParent = 0;
  141053. if( pParent ){
  141054. pParent->pLeft = 0;
  141055. }else{
  141056. pRoot = 0;
  141057. }
  141058. rc = fts3ExprBalance(&p, nMaxDepth-1);
  141059. if( rc!=SQLITE_OK ) break;
  141060. for(iLvl=0; p && iLvl<nMaxDepth; iLvl++){
  141061. if( apLeaf[iLvl]==0 ){
  141062. apLeaf[iLvl] = p;
  141063. p = 0;
  141064. }else{
  141065. assert( pFree );
  141066. pFree->pLeft = apLeaf[iLvl];
  141067. pFree->pRight = p;
  141068. pFree->pLeft->pParent = pFree;
  141069. pFree->pRight->pParent = pFree;
  141070. p = pFree;
  141071. pFree = pFree->pParent;
  141072. p->pParent = 0;
  141073. apLeaf[iLvl] = 0;
  141074. }
  141075. }
  141076. if( p ){
  141077. sqlite3Fts3ExprFree(p);
  141078. rc = SQLITE_TOOBIG;
  141079. break;
  141080. }
  141081. /* If that was the last leaf node, break out of the loop */
  141082. if( pParent==0 ) break;
  141083. /* Set $p to point to the next leaf in the tree of eType nodes */
  141084. for(p=pParent->pRight; p->eType==eType; p=p->pLeft);
  141085. /* Remove pParent from the original tree. */
  141086. assert( pParent->pParent==0 || pParent->pParent->pLeft==pParent );
  141087. pParent->pRight->pParent = pParent->pParent;
  141088. if( pParent->pParent ){
  141089. pParent->pParent->pLeft = pParent->pRight;
  141090. }else{
  141091. assert( pParent==pRoot );
  141092. pRoot = pParent->pRight;
  141093. }
  141094. /* Link pParent into the free node list. It will be used as an
  141095. ** internal node of the new tree. */
  141096. pParent->pParent = pFree;
  141097. pFree = pParent;
  141098. }
  141099. if( rc==SQLITE_OK ){
  141100. p = 0;
  141101. for(i=0; i<nMaxDepth; i++){
  141102. if( apLeaf[i] ){
  141103. if( p==0 ){
  141104. p = apLeaf[i];
  141105. p->pParent = 0;
  141106. }else{
  141107. assert( pFree!=0 );
  141108. pFree->pRight = p;
  141109. pFree->pLeft = apLeaf[i];
  141110. pFree->pLeft->pParent = pFree;
  141111. pFree->pRight->pParent = pFree;
  141112. p = pFree;
  141113. pFree = pFree->pParent;
  141114. p->pParent = 0;
  141115. }
  141116. }
  141117. }
  141118. pRoot = p;
  141119. }else{
  141120. /* An error occurred. Delete the contents of the apLeaf[] array
  141121. ** and pFree list. Everything else is cleaned up by the call to
  141122. ** sqlite3Fts3ExprFree(pRoot) below. */
  141123. Fts3Expr *pDel;
  141124. for(i=0; i<nMaxDepth; i++){
  141125. sqlite3Fts3ExprFree(apLeaf[i]);
  141126. }
  141127. while( (pDel=pFree)!=0 ){
  141128. pFree = pDel->pParent;
  141129. sqlite3_free(pDel);
  141130. }
  141131. }
  141132. assert( pFree==0 );
  141133. sqlite3_free( apLeaf );
  141134. }
  141135. }else if( eType==FTSQUERY_NOT ){
  141136. Fts3Expr *pLeft = pRoot->pLeft;
  141137. Fts3Expr *pRight = pRoot->pRight;
  141138. pRoot->pLeft = 0;
  141139. pRoot->pRight = 0;
  141140. pLeft->pParent = 0;
  141141. pRight->pParent = 0;
  141142. rc = fts3ExprBalance(&pLeft, nMaxDepth-1);
  141143. if( rc==SQLITE_OK ){
  141144. rc = fts3ExprBalance(&pRight, nMaxDepth-1);
  141145. }
  141146. if( rc!=SQLITE_OK ){
  141147. sqlite3Fts3ExprFree(pRight);
  141148. sqlite3Fts3ExprFree(pLeft);
  141149. }else{
  141150. assert( pLeft && pRight );
  141151. pRoot->pLeft = pLeft;
  141152. pLeft->pParent = pRoot;
  141153. pRoot->pRight = pRight;
  141154. pRight->pParent = pRoot;
  141155. }
  141156. }
  141157. }
  141158. if( rc!=SQLITE_OK ){
  141159. sqlite3Fts3ExprFree(pRoot);
  141160. pRoot = 0;
  141161. }
  141162. *pp = pRoot;
  141163. return rc;
  141164. }
  141165. /*
  141166. ** This function is similar to sqlite3Fts3ExprParse(), with the following
  141167. ** differences:
  141168. **
  141169. ** 1. It does not do expression rebalancing.
  141170. ** 2. It does not check that the expression does not exceed the
  141171. ** maximum allowable depth.
  141172. ** 3. Even if it fails, *ppExpr may still be set to point to an
  141173. ** expression tree. It should be deleted using sqlite3Fts3ExprFree()
  141174. ** in this case.
  141175. */
  141176. static int fts3ExprParseUnbalanced(
  141177. sqlite3_tokenizer *pTokenizer, /* Tokenizer module */
  141178. int iLangid, /* Language id for tokenizer */
  141179. char **azCol, /* Array of column names for fts3 table */
  141180. int bFts4, /* True to allow FTS4-only syntax */
  141181. int nCol, /* Number of entries in azCol[] */
  141182. int iDefaultCol, /* Default column to query */
  141183. const char *z, int n, /* Text of MATCH query */
  141184. Fts3Expr **ppExpr /* OUT: Parsed query structure */
  141185. ){
  141186. int nParsed;
  141187. int rc;
  141188. ParseContext sParse;
  141189. memset(&sParse, 0, sizeof(ParseContext));
  141190. sParse.pTokenizer = pTokenizer;
  141191. sParse.iLangid = iLangid;
  141192. sParse.azCol = (const char **)azCol;
  141193. sParse.nCol = nCol;
  141194. sParse.iDefaultCol = iDefaultCol;
  141195. sParse.bFts4 = bFts4;
  141196. if( z==0 ){
  141197. *ppExpr = 0;
  141198. return SQLITE_OK;
  141199. }
  141200. if( n<0 ){
  141201. n = (int)strlen(z);
  141202. }
  141203. rc = fts3ExprParse(&sParse, z, n, ppExpr, &nParsed);
  141204. assert( rc==SQLITE_OK || *ppExpr==0 );
  141205. /* Check for mismatched parenthesis */
  141206. if( rc==SQLITE_OK && sParse.nNest ){
  141207. rc = SQLITE_ERROR;
  141208. }
  141209. return rc;
  141210. }
  141211. /*
  141212. ** Parameters z and n contain a pointer to and length of a buffer containing
  141213. ** an fts3 query expression, respectively. This function attempts to parse the
  141214. ** query expression and create a tree of Fts3Expr structures representing the
  141215. ** parsed expression. If successful, *ppExpr is set to point to the head
  141216. ** of the parsed expression tree and SQLITE_OK is returned. If an error
  141217. ** occurs, either SQLITE_NOMEM (out-of-memory error) or SQLITE_ERROR (parse
  141218. ** error) is returned and *ppExpr is set to 0.
  141219. **
  141220. ** If parameter n is a negative number, then z is assumed to point to a
  141221. ** nul-terminated string and the length is determined using strlen().
  141222. **
  141223. ** The first parameter, pTokenizer, is passed the fts3 tokenizer module to
  141224. ** use to normalize query tokens while parsing the expression. The azCol[]
  141225. ** array, which is assumed to contain nCol entries, should contain the names
  141226. ** of each column in the target fts3 table, in order from left to right.
  141227. ** Column names must be nul-terminated strings.
  141228. **
  141229. ** The iDefaultCol parameter should be passed the index of the table column
  141230. ** that appears on the left-hand-side of the MATCH operator (the default
  141231. ** column to match against for tokens for which a column name is not explicitly
  141232. ** specified as part of the query string), or -1 if tokens may by default
  141233. ** match any table column.
  141234. */
  141235. SQLITE_PRIVATE int sqlite3Fts3ExprParse(
  141236. sqlite3_tokenizer *pTokenizer, /* Tokenizer module */
  141237. int iLangid, /* Language id for tokenizer */
  141238. char **azCol, /* Array of column names for fts3 table */
  141239. int bFts4, /* True to allow FTS4-only syntax */
  141240. int nCol, /* Number of entries in azCol[] */
  141241. int iDefaultCol, /* Default column to query */
  141242. const char *z, int n, /* Text of MATCH query */
  141243. Fts3Expr **ppExpr, /* OUT: Parsed query structure */
  141244. char **pzErr /* OUT: Error message (sqlite3_malloc) */
  141245. ){
  141246. int rc = fts3ExprParseUnbalanced(
  141247. pTokenizer, iLangid, azCol, bFts4, nCol, iDefaultCol, z, n, ppExpr
  141248. );
  141249. /* Rebalance the expression. And check that its depth does not exceed
  141250. ** SQLITE_FTS3_MAX_EXPR_DEPTH. */
  141251. if( rc==SQLITE_OK && *ppExpr ){
  141252. rc = fts3ExprBalance(ppExpr, SQLITE_FTS3_MAX_EXPR_DEPTH);
  141253. if( rc==SQLITE_OK ){
  141254. rc = fts3ExprCheckDepth(*ppExpr, SQLITE_FTS3_MAX_EXPR_DEPTH);
  141255. }
  141256. }
  141257. if( rc!=SQLITE_OK ){
  141258. sqlite3Fts3ExprFree(*ppExpr);
  141259. *ppExpr = 0;
  141260. if( rc==SQLITE_TOOBIG ){
  141261. sqlite3Fts3ErrMsg(pzErr,
  141262. "FTS expression tree is too large (maximum depth %d)",
  141263. SQLITE_FTS3_MAX_EXPR_DEPTH
  141264. );
  141265. rc = SQLITE_ERROR;
  141266. }else if( rc==SQLITE_ERROR ){
  141267. sqlite3Fts3ErrMsg(pzErr, "malformed MATCH expression: [%s]", z);
  141268. }
  141269. }
  141270. return rc;
  141271. }
  141272. /*
  141273. ** Free a single node of an expression tree.
  141274. */
  141275. static void fts3FreeExprNode(Fts3Expr *p){
  141276. assert( p->eType==FTSQUERY_PHRASE || p->pPhrase==0 );
  141277. sqlite3Fts3EvalPhraseCleanup(p->pPhrase);
  141278. sqlite3_free(p->aMI);
  141279. sqlite3_free(p);
  141280. }
  141281. /*
  141282. ** Free a parsed fts3 query expression allocated by sqlite3Fts3ExprParse().
  141283. **
  141284. ** This function would be simpler if it recursively called itself. But
  141285. ** that would mean passing a sufficiently large expression to ExprParse()
  141286. ** could cause a stack overflow.
  141287. */
  141288. SQLITE_PRIVATE void sqlite3Fts3ExprFree(Fts3Expr *pDel){
  141289. Fts3Expr *p;
  141290. assert( pDel==0 || pDel->pParent==0 );
  141291. for(p=pDel; p && (p->pLeft||p->pRight); p=(p->pLeft ? p->pLeft : p->pRight)){
  141292. assert( p->pParent==0 || p==p->pParent->pRight || p==p->pParent->pLeft );
  141293. }
  141294. while( p ){
  141295. Fts3Expr *pParent = p->pParent;
  141296. fts3FreeExprNode(p);
  141297. if( pParent && p==pParent->pLeft && pParent->pRight ){
  141298. p = pParent->pRight;
  141299. while( p && (p->pLeft || p->pRight) ){
  141300. assert( p==p->pParent->pRight || p==p->pParent->pLeft );
  141301. p = (p->pLeft ? p->pLeft : p->pRight);
  141302. }
  141303. }else{
  141304. p = pParent;
  141305. }
  141306. }
  141307. }
  141308. /****************************************************************************
  141309. *****************************************************************************
  141310. ** Everything after this point is just test code.
  141311. */
  141312. #ifdef SQLITE_TEST
  141313. /* #include <stdio.h> */
  141314. /*
  141315. ** Function to query the hash-table of tokenizers (see README.tokenizers).
  141316. */
  141317. static int queryTestTokenizer(
  141318. sqlite3 *db,
  141319. const char *zName,
  141320. const sqlite3_tokenizer_module **pp
  141321. ){
  141322. int rc;
  141323. sqlite3_stmt *pStmt;
  141324. const char zSql[] = "SELECT fts3_tokenizer(?)";
  141325. *pp = 0;
  141326. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  141327. if( rc!=SQLITE_OK ){
  141328. return rc;
  141329. }
  141330. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  141331. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  141332. if( sqlite3_column_type(pStmt, 0)==SQLITE_BLOB ){
  141333. memcpy((void *)pp, sqlite3_column_blob(pStmt, 0), sizeof(*pp));
  141334. }
  141335. }
  141336. return sqlite3_finalize(pStmt);
  141337. }
  141338. /*
  141339. ** Return a pointer to a buffer containing a text representation of the
  141340. ** expression passed as the first argument. The buffer is obtained from
  141341. ** sqlite3_malloc(). It is the responsibility of the caller to use
  141342. ** sqlite3_free() to release the memory. If an OOM condition is encountered,
  141343. ** NULL is returned.
  141344. **
  141345. ** If the second argument is not NULL, then its contents are prepended to
  141346. ** the returned expression text and then freed using sqlite3_free().
  141347. */
  141348. static char *exprToString(Fts3Expr *pExpr, char *zBuf){
  141349. if( pExpr==0 ){
  141350. return sqlite3_mprintf("");
  141351. }
  141352. switch( pExpr->eType ){
  141353. case FTSQUERY_PHRASE: {
  141354. Fts3Phrase *pPhrase = pExpr->pPhrase;
  141355. int i;
  141356. zBuf = sqlite3_mprintf(
  141357. "%zPHRASE %d 0", zBuf, pPhrase->iColumn);
  141358. for(i=0; zBuf && i<pPhrase->nToken; i++){
  141359. zBuf = sqlite3_mprintf("%z %.*s%s", zBuf,
  141360. pPhrase->aToken[i].n, pPhrase->aToken[i].z,
  141361. (pPhrase->aToken[i].isPrefix?"+":"")
  141362. );
  141363. }
  141364. return zBuf;
  141365. }
  141366. case FTSQUERY_NEAR:
  141367. zBuf = sqlite3_mprintf("%zNEAR/%d ", zBuf, pExpr->nNear);
  141368. break;
  141369. case FTSQUERY_NOT:
  141370. zBuf = sqlite3_mprintf("%zNOT ", zBuf);
  141371. break;
  141372. case FTSQUERY_AND:
  141373. zBuf = sqlite3_mprintf("%zAND ", zBuf);
  141374. break;
  141375. case FTSQUERY_OR:
  141376. zBuf = sqlite3_mprintf("%zOR ", zBuf);
  141377. break;
  141378. }
  141379. if( zBuf ) zBuf = sqlite3_mprintf("%z{", zBuf);
  141380. if( zBuf ) zBuf = exprToString(pExpr->pLeft, zBuf);
  141381. if( zBuf ) zBuf = sqlite3_mprintf("%z} {", zBuf);
  141382. if( zBuf ) zBuf = exprToString(pExpr->pRight, zBuf);
  141383. if( zBuf ) zBuf = sqlite3_mprintf("%z}", zBuf);
  141384. return zBuf;
  141385. }
  141386. /*
  141387. ** This is the implementation of a scalar SQL function used to test the
  141388. ** expression parser. It should be called as follows:
  141389. **
  141390. ** fts3_exprtest(<tokenizer>, <expr>, <column 1>, ...);
  141391. **
  141392. ** The first argument, <tokenizer>, is the name of the fts3 tokenizer used
  141393. ** to parse the query expression (see README.tokenizers). The second argument
  141394. ** is the query expression to parse. Each subsequent argument is the name
  141395. ** of a column of the fts3 table that the query expression may refer to.
  141396. ** For example:
  141397. **
  141398. ** SELECT fts3_exprtest('simple', 'Bill col2:Bloggs', 'col1', 'col2');
  141399. */
  141400. static void fts3ExprTest(
  141401. sqlite3_context *context,
  141402. int argc,
  141403. sqlite3_value **argv
  141404. ){
  141405. sqlite3_tokenizer_module const *pModule = 0;
  141406. sqlite3_tokenizer *pTokenizer = 0;
  141407. int rc;
  141408. char **azCol = 0;
  141409. const char *zExpr;
  141410. int nExpr;
  141411. int nCol;
  141412. int ii;
  141413. Fts3Expr *pExpr;
  141414. char *zBuf = 0;
  141415. sqlite3 *db = sqlite3_context_db_handle(context);
  141416. if( argc<3 ){
  141417. sqlite3_result_error(context,
  141418. "Usage: fts3_exprtest(tokenizer, expr, col1, ...", -1
  141419. );
  141420. return;
  141421. }
  141422. rc = queryTestTokenizer(db,
  141423. (const char *)sqlite3_value_text(argv[0]), &pModule);
  141424. if( rc==SQLITE_NOMEM ){
  141425. sqlite3_result_error_nomem(context);
  141426. goto exprtest_out;
  141427. }else if( !pModule ){
  141428. sqlite3_result_error(context, "No such tokenizer module", -1);
  141429. goto exprtest_out;
  141430. }
  141431. rc = pModule->xCreate(0, 0, &pTokenizer);
  141432. assert( rc==SQLITE_NOMEM || rc==SQLITE_OK );
  141433. if( rc==SQLITE_NOMEM ){
  141434. sqlite3_result_error_nomem(context);
  141435. goto exprtest_out;
  141436. }
  141437. pTokenizer->pModule = pModule;
  141438. zExpr = (const char *)sqlite3_value_text(argv[1]);
  141439. nExpr = sqlite3_value_bytes(argv[1]);
  141440. nCol = argc-2;
  141441. azCol = (char **)sqlite3_malloc(nCol*sizeof(char *));
  141442. if( !azCol ){
  141443. sqlite3_result_error_nomem(context);
  141444. goto exprtest_out;
  141445. }
  141446. for(ii=0; ii<nCol; ii++){
  141447. azCol[ii] = (char *)sqlite3_value_text(argv[ii+2]);
  141448. }
  141449. if( sqlite3_user_data(context) ){
  141450. char *zDummy = 0;
  141451. rc = sqlite3Fts3ExprParse(
  141452. pTokenizer, 0, azCol, 0, nCol, nCol, zExpr, nExpr, &pExpr, &zDummy
  141453. );
  141454. assert( rc==SQLITE_OK || pExpr==0 );
  141455. sqlite3_free(zDummy);
  141456. }else{
  141457. rc = fts3ExprParseUnbalanced(
  141458. pTokenizer, 0, azCol, 0, nCol, nCol, zExpr, nExpr, &pExpr
  141459. );
  141460. }
  141461. if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
  141462. sqlite3Fts3ExprFree(pExpr);
  141463. sqlite3_result_error(context, "Error parsing expression", -1);
  141464. }else if( rc==SQLITE_NOMEM || !(zBuf = exprToString(pExpr, 0)) ){
  141465. sqlite3_result_error_nomem(context);
  141466. }else{
  141467. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  141468. sqlite3_free(zBuf);
  141469. }
  141470. sqlite3Fts3ExprFree(pExpr);
  141471. exprtest_out:
  141472. if( pModule && pTokenizer ){
  141473. rc = pModule->xDestroy(pTokenizer);
  141474. }
  141475. sqlite3_free(azCol);
  141476. }
  141477. /*
  141478. ** Register the query expression parser test function fts3_exprtest()
  141479. ** with database connection db.
  141480. */
  141481. SQLITE_PRIVATE int sqlite3Fts3ExprInitTestInterface(sqlite3* db){
  141482. int rc = sqlite3_create_function(
  141483. db, "fts3_exprtest", -1, SQLITE_UTF8, 0, fts3ExprTest, 0, 0
  141484. );
  141485. if( rc==SQLITE_OK ){
  141486. rc = sqlite3_create_function(db, "fts3_exprtest_rebalance",
  141487. -1, SQLITE_UTF8, (void *)1, fts3ExprTest, 0, 0
  141488. );
  141489. }
  141490. return rc;
  141491. }
  141492. #endif
  141493. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  141494. /************** End of fts3_expr.c *******************************************/
  141495. /************** Begin file fts3_hash.c ***************************************/
  141496. /*
  141497. ** 2001 September 22
  141498. **
  141499. ** The author disclaims copyright to this source code. In place of
  141500. ** a legal notice, here is a blessing:
  141501. **
  141502. ** May you do good and not evil.
  141503. ** May you find forgiveness for yourself and forgive others.
  141504. ** May you share freely, never taking more than you give.
  141505. **
  141506. *************************************************************************
  141507. ** This is the implementation of generic hash-tables used in SQLite.
  141508. ** We've modified it slightly to serve as a standalone hash table
  141509. ** implementation for the full-text indexing module.
  141510. */
  141511. /*
  141512. ** The code in this file is only compiled if:
  141513. **
  141514. ** * The FTS3 module is being built as an extension
  141515. ** (in which case SQLITE_CORE is not defined), or
  141516. **
  141517. ** * The FTS3 module is being built into the core of
  141518. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  141519. */
  141520. /* #include "fts3Int.h" */
  141521. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  141522. /* #include <assert.h> */
  141523. /* #include <stdlib.h> */
  141524. /* #include <string.h> */
  141525. /* #include "fts3_hash.h" */
  141526. /*
  141527. ** Malloc and Free functions
  141528. */
  141529. static void *fts3HashMalloc(int n){
  141530. void *p = sqlite3_malloc(n);
  141531. if( p ){
  141532. memset(p, 0, n);
  141533. }
  141534. return p;
  141535. }
  141536. static void fts3HashFree(void *p){
  141537. sqlite3_free(p);
  141538. }
  141539. /* Turn bulk memory into a hash table object by initializing the
  141540. ** fields of the Hash structure.
  141541. **
  141542. ** "pNew" is a pointer to the hash table that is to be initialized.
  141543. ** keyClass is one of the constants
  141544. ** FTS3_HASH_BINARY or FTS3_HASH_STRING. The value of keyClass
  141545. ** determines what kind of key the hash table will use. "copyKey" is
  141546. ** true if the hash table should make its own private copy of keys and
  141547. ** false if it should just use the supplied pointer.
  141548. */
  141549. SQLITE_PRIVATE void sqlite3Fts3HashInit(Fts3Hash *pNew, char keyClass, char copyKey){
  141550. assert( pNew!=0 );
  141551. assert( keyClass>=FTS3_HASH_STRING && keyClass<=FTS3_HASH_BINARY );
  141552. pNew->keyClass = keyClass;
  141553. pNew->copyKey = copyKey;
  141554. pNew->first = 0;
  141555. pNew->count = 0;
  141556. pNew->htsize = 0;
  141557. pNew->ht = 0;
  141558. }
  141559. /* Remove all entries from a hash table. Reclaim all memory.
  141560. ** Call this routine to delete a hash table or to reset a hash table
  141561. ** to the empty state.
  141562. */
  141563. SQLITE_PRIVATE void sqlite3Fts3HashClear(Fts3Hash *pH){
  141564. Fts3HashElem *elem; /* For looping over all elements of the table */
  141565. assert( pH!=0 );
  141566. elem = pH->first;
  141567. pH->first = 0;
  141568. fts3HashFree(pH->ht);
  141569. pH->ht = 0;
  141570. pH->htsize = 0;
  141571. while( elem ){
  141572. Fts3HashElem *next_elem = elem->next;
  141573. if( pH->copyKey && elem->pKey ){
  141574. fts3HashFree(elem->pKey);
  141575. }
  141576. fts3HashFree(elem);
  141577. elem = next_elem;
  141578. }
  141579. pH->count = 0;
  141580. }
  141581. /*
  141582. ** Hash and comparison functions when the mode is FTS3_HASH_STRING
  141583. */
  141584. static int fts3StrHash(const void *pKey, int nKey){
  141585. const char *z = (const char *)pKey;
  141586. unsigned h = 0;
  141587. if( nKey<=0 ) nKey = (int) strlen(z);
  141588. while( nKey > 0 ){
  141589. h = (h<<3) ^ h ^ *z++;
  141590. nKey--;
  141591. }
  141592. return (int)(h & 0x7fffffff);
  141593. }
  141594. static int fts3StrCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  141595. if( n1!=n2 ) return 1;
  141596. return strncmp((const char*)pKey1,(const char*)pKey2,n1);
  141597. }
  141598. /*
  141599. ** Hash and comparison functions when the mode is FTS3_HASH_BINARY
  141600. */
  141601. static int fts3BinHash(const void *pKey, int nKey){
  141602. int h = 0;
  141603. const char *z = (const char *)pKey;
  141604. while( nKey-- > 0 ){
  141605. h = (h<<3) ^ h ^ *(z++);
  141606. }
  141607. return h & 0x7fffffff;
  141608. }
  141609. static int fts3BinCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  141610. if( n1!=n2 ) return 1;
  141611. return memcmp(pKey1,pKey2,n1);
  141612. }
  141613. /*
  141614. ** Return a pointer to the appropriate hash function given the key class.
  141615. **
  141616. ** The C syntax in this function definition may be unfamilar to some
  141617. ** programmers, so we provide the following additional explanation:
  141618. **
  141619. ** The name of the function is "ftsHashFunction". The function takes a
  141620. ** single parameter "keyClass". The return value of ftsHashFunction()
  141621. ** is a pointer to another function. Specifically, the return value
  141622. ** of ftsHashFunction() is a pointer to a function that takes two parameters
  141623. ** with types "const void*" and "int" and returns an "int".
  141624. */
  141625. static int (*ftsHashFunction(int keyClass))(const void*,int){
  141626. if( keyClass==FTS3_HASH_STRING ){
  141627. return &fts3StrHash;
  141628. }else{
  141629. assert( keyClass==FTS3_HASH_BINARY );
  141630. return &fts3BinHash;
  141631. }
  141632. }
  141633. /*
  141634. ** Return a pointer to the appropriate hash function given the key class.
  141635. **
  141636. ** For help in interpreted the obscure C code in the function definition,
  141637. ** see the header comment on the previous function.
  141638. */
  141639. static int (*ftsCompareFunction(int keyClass))(const void*,int,const void*,int){
  141640. if( keyClass==FTS3_HASH_STRING ){
  141641. return &fts3StrCompare;
  141642. }else{
  141643. assert( keyClass==FTS3_HASH_BINARY );
  141644. return &fts3BinCompare;
  141645. }
  141646. }
  141647. /* Link an element into the hash table
  141648. */
  141649. static void fts3HashInsertElement(
  141650. Fts3Hash *pH, /* The complete hash table */
  141651. struct _fts3ht *pEntry, /* The entry into which pNew is inserted */
  141652. Fts3HashElem *pNew /* The element to be inserted */
  141653. ){
  141654. Fts3HashElem *pHead; /* First element already in pEntry */
  141655. pHead = pEntry->chain;
  141656. if( pHead ){
  141657. pNew->next = pHead;
  141658. pNew->prev = pHead->prev;
  141659. if( pHead->prev ){ pHead->prev->next = pNew; }
  141660. else { pH->first = pNew; }
  141661. pHead->prev = pNew;
  141662. }else{
  141663. pNew->next = pH->first;
  141664. if( pH->first ){ pH->first->prev = pNew; }
  141665. pNew->prev = 0;
  141666. pH->first = pNew;
  141667. }
  141668. pEntry->count++;
  141669. pEntry->chain = pNew;
  141670. }
  141671. /* Resize the hash table so that it cantains "new_size" buckets.
  141672. ** "new_size" must be a power of 2. The hash table might fail
  141673. ** to resize if sqliteMalloc() fails.
  141674. **
  141675. ** Return non-zero if a memory allocation error occurs.
  141676. */
  141677. static int fts3Rehash(Fts3Hash *pH, int new_size){
  141678. struct _fts3ht *new_ht; /* The new hash table */
  141679. Fts3HashElem *elem, *next_elem; /* For looping over existing elements */
  141680. int (*xHash)(const void*,int); /* The hash function */
  141681. assert( (new_size & (new_size-1))==0 );
  141682. new_ht = (struct _fts3ht *)fts3HashMalloc( new_size*sizeof(struct _fts3ht) );
  141683. if( new_ht==0 ) return 1;
  141684. fts3HashFree(pH->ht);
  141685. pH->ht = new_ht;
  141686. pH->htsize = new_size;
  141687. xHash = ftsHashFunction(pH->keyClass);
  141688. for(elem=pH->first, pH->first=0; elem; elem = next_elem){
  141689. int h = (*xHash)(elem->pKey, elem->nKey) & (new_size-1);
  141690. next_elem = elem->next;
  141691. fts3HashInsertElement(pH, &new_ht[h], elem);
  141692. }
  141693. return 0;
  141694. }
  141695. /* This function (for internal use only) locates an element in an
  141696. ** hash table that matches the given key. The hash for this key has
  141697. ** already been computed and is passed as the 4th parameter.
  141698. */
  141699. static Fts3HashElem *fts3FindElementByHash(
  141700. const Fts3Hash *pH, /* The pH to be searched */
  141701. const void *pKey, /* The key we are searching for */
  141702. int nKey,
  141703. int h /* The hash for this key. */
  141704. ){
  141705. Fts3HashElem *elem; /* Used to loop thru the element list */
  141706. int count; /* Number of elements left to test */
  141707. int (*xCompare)(const void*,int,const void*,int); /* comparison function */
  141708. if( pH->ht ){
  141709. struct _fts3ht *pEntry = &pH->ht[h];
  141710. elem = pEntry->chain;
  141711. count = pEntry->count;
  141712. xCompare = ftsCompareFunction(pH->keyClass);
  141713. while( count-- && elem ){
  141714. if( (*xCompare)(elem->pKey,elem->nKey,pKey,nKey)==0 ){
  141715. return elem;
  141716. }
  141717. elem = elem->next;
  141718. }
  141719. }
  141720. return 0;
  141721. }
  141722. /* Remove a single entry from the hash table given a pointer to that
  141723. ** element and a hash on the element's key.
  141724. */
  141725. static void fts3RemoveElementByHash(
  141726. Fts3Hash *pH, /* The pH containing "elem" */
  141727. Fts3HashElem* elem, /* The element to be removed from the pH */
  141728. int h /* Hash value for the element */
  141729. ){
  141730. struct _fts3ht *pEntry;
  141731. if( elem->prev ){
  141732. elem->prev->next = elem->next;
  141733. }else{
  141734. pH->first = elem->next;
  141735. }
  141736. if( elem->next ){
  141737. elem->next->prev = elem->prev;
  141738. }
  141739. pEntry = &pH->ht[h];
  141740. if( pEntry->chain==elem ){
  141741. pEntry->chain = elem->next;
  141742. }
  141743. pEntry->count--;
  141744. if( pEntry->count<=0 ){
  141745. pEntry->chain = 0;
  141746. }
  141747. if( pH->copyKey && elem->pKey ){
  141748. fts3HashFree(elem->pKey);
  141749. }
  141750. fts3HashFree( elem );
  141751. pH->count--;
  141752. if( pH->count<=0 ){
  141753. assert( pH->first==0 );
  141754. assert( pH->count==0 );
  141755. fts3HashClear(pH);
  141756. }
  141757. }
  141758. SQLITE_PRIVATE Fts3HashElem *sqlite3Fts3HashFindElem(
  141759. const Fts3Hash *pH,
  141760. const void *pKey,
  141761. int nKey
  141762. ){
  141763. int h; /* A hash on key */
  141764. int (*xHash)(const void*,int); /* The hash function */
  141765. if( pH==0 || pH->ht==0 ) return 0;
  141766. xHash = ftsHashFunction(pH->keyClass);
  141767. assert( xHash!=0 );
  141768. h = (*xHash)(pKey,nKey);
  141769. assert( (pH->htsize & (pH->htsize-1))==0 );
  141770. return fts3FindElementByHash(pH,pKey,nKey, h & (pH->htsize-1));
  141771. }
  141772. /*
  141773. ** Attempt to locate an element of the hash table pH with a key
  141774. ** that matches pKey,nKey. Return the data for this element if it is
  141775. ** found, or NULL if there is no match.
  141776. */
  141777. SQLITE_PRIVATE void *sqlite3Fts3HashFind(const Fts3Hash *pH, const void *pKey, int nKey){
  141778. Fts3HashElem *pElem; /* The element that matches key (if any) */
  141779. pElem = sqlite3Fts3HashFindElem(pH, pKey, nKey);
  141780. return pElem ? pElem->data : 0;
  141781. }
  141782. /* Insert an element into the hash table pH. The key is pKey,nKey
  141783. ** and the data is "data".
  141784. **
  141785. ** If no element exists with a matching key, then a new
  141786. ** element is created. A copy of the key is made if the copyKey
  141787. ** flag is set. NULL is returned.
  141788. **
  141789. ** If another element already exists with the same key, then the
  141790. ** new data replaces the old data and the old data is returned.
  141791. ** The key is not copied in this instance. If a malloc fails, then
  141792. ** the new data is returned and the hash table is unchanged.
  141793. **
  141794. ** If the "data" parameter to this function is NULL, then the
  141795. ** element corresponding to "key" is removed from the hash table.
  141796. */
  141797. SQLITE_PRIVATE void *sqlite3Fts3HashInsert(
  141798. Fts3Hash *pH, /* The hash table to insert into */
  141799. const void *pKey, /* The key */
  141800. int nKey, /* Number of bytes in the key */
  141801. void *data /* The data */
  141802. ){
  141803. int hraw; /* Raw hash value of the key */
  141804. int h; /* the hash of the key modulo hash table size */
  141805. Fts3HashElem *elem; /* Used to loop thru the element list */
  141806. Fts3HashElem *new_elem; /* New element added to the pH */
  141807. int (*xHash)(const void*,int); /* The hash function */
  141808. assert( pH!=0 );
  141809. xHash = ftsHashFunction(pH->keyClass);
  141810. assert( xHash!=0 );
  141811. hraw = (*xHash)(pKey, nKey);
  141812. assert( (pH->htsize & (pH->htsize-1))==0 );
  141813. h = hraw & (pH->htsize-1);
  141814. elem = fts3FindElementByHash(pH,pKey,nKey,h);
  141815. if( elem ){
  141816. void *old_data = elem->data;
  141817. if( data==0 ){
  141818. fts3RemoveElementByHash(pH,elem,h);
  141819. }else{
  141820. elem->data = data;
  141821. }
  141822. return old_data;
  141823. }
  141824. if( data==0 ) return 0;
  141825. if( (pH->htsize==0 && fts3Rehash(pH,8))
  141826. || (pH->count>=pH->htsize && fts3Rehash(pH, pH->htsize*2))
  141827. ){
  141828. pH->count = 0;
  141829. return data;
  141830. }
  141831. assert( pH->htsize>0 );
  141832. new_elem = (Fts3HashElem*)fts3HashMalloc( sizeof(Fts3HashElem) );
  141833. if( new_elem==0 ) return data;
  141834. if( pH->copyKey && pKey!=0 ){
  141835. new_elem->pKey = fts3HashMalloc( nKey );
  141836. if( new_elem->pKey==0 ){
  141837. fts3HashFree(new_elem);
  141838. return data;
  141839. }
  141840. memcpy((void*)new_elem->pKey, pKey, nKey);
  141841. }else{
  141842. new_elem->pKey = (void*)pKey;
  141843. }
  141844. new_elem->nKey = nKey;
  141845. pH->count++;
  141846. assert( pH->htsize>0 );
  141847. assert( (pH->htsize & (pH->htsize-1))==0 );
  141848. h = hraw & (pH->htsize-1);
  141849. fts3HashInsertElement(pH, &pH->ht[h], new_elem);
  141850. new_elem->data = data;
  141851. return 0;
  141852. }
  141853. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  141854. /************** End of fts3_hash.c *******************************************/
  141855. /************** Begin file fts3_porter.c *************************************/
  141856. /*
  141857. ** 2006 September 30
  141858. **
  141859. ** The author disclaims copyright to this source code. In place of
  141860. ** a legal notice, here is a blessing:
  141861. **
  141862. ** May you do good and not evil.
  141863. ** May you find forgiveness for yourself and forgive others.
  141864. ** May you share freely, never taking more than you give.
  141865. **
  141866. *************************************************************************
  141867. ** Implementation of the full-text-search tokenizer that implements
  141868. ** a Porter stemmer.
  141869. */
  141870. /*
  141871. ** The code in this file is only compiled if:
  141872. **
  141873. ** * The FTS3 module is being built as an extension
  141874. ** (in which case SQLITE_CORE is not defined), or
  141875. **
  141876. ** * The FTS3 module is being built into the core of
  141877. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  141878. */
  141879. /* #include "fts3Int.h" */
  141880. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  141881. /* #include <assert.h> */
  141882. /* #include <stdlib.h> */
  141883. /* #include <stdio.h> */
  141884. /* #include <string.h> */
  141885. /* #include "fts3_tokenizer.h" */
  141886. /*
  141887. ** Class derived from sqlite3_tokenizer
  141888. */
  141889. typedef struct porter_tokenizer {
  141890. sqlite3_tokenizer base; /* Base class */
  141891. } porter_tokenizer;
  141892. /*
  141893. ** Class derived from sqlite3_tokenizer_cursor
  141894. */
  141895. typedef struct porter_tokenizer_cursor {
  141896. sqlite3_tokenizer_cursor base;
  141897. const char *zInput; /* input we are tokenizing */
  141898. int nInput; /* size of the input */
  141899. int iOffset; /* current position in zInput */
  141900. int iToken; /* index of next token to be returned */
  141901. char *zToken; /* storage for current token */
  141902. int nAllocated; /* space allocated to zToken buffer */
  141903. } porter_tokenizer_cursor;
  141904. /*
  141905. ** Create a new tokenizer instance.
  141906. */
  141907. static int porterCreate(
  141908. int argc, const char * const *argv,
  141909. sqlite3_tokenizer **ppTokenizer
  141910. ){
  141911. porter_tokenizer *t;
  141912. UNUSED_PARAMETER(argc);
  141913. UNUSED_PARAMETER(argv);
  141914. t = (porter_tokenizer *) sqlite3_malloc(sizeof(*t));
  141915. if( t==NULL ) return SQLITE_NOMEM;
  141916. memset(t, 0, sizeof(*t));
  141917. *ppTokenizer = &t->base;
  141918. return SQLITE_OK;
  141919. }
  141920. /*
  141921. ** Destroy a tokenizer
  141922. */
  141923. static int porterDestroy(sqlite3_tokenizer *pTokenizer){
  141924. sqlite3_free(pTokenizer);
  141925. return SQLITE_OK;
  141926. }
  141927. /*
  141928. ** Prepare to begin tokenizing a particular string. The input
  141929. ** string to be tokenized is zInput[0..nInput-1]. A cursor
  141930. ** used to incrementally tokenize this string is returned in
  141931. ** *ppCursor.
  141932. */
  141933. static int porterOpen(
  141934. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  141935. const char *zInput, int nInput, /* String to be tokenized */
  141936. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  141937. ){
  141938. porter_tokenizer_cursor *c;
  141939. UNUSED_PARAMETER(pTokenizer);
  141940. c = (porter_tokenizer_cursor *) sqlite3_malloc(sizeof(*c));
  141941. if( c==NULL ) return SQLITE_NOMEM;
  141942. c->zInput = zInput;
  141943. if( zInput==0 ){
  141944. c->nInput = 0;
  141945. }else if( nInput<0 ){
  141946. c->nInput = (int)strlen(zInput);
  141947. }else{
  141948. c->nInput = nInput;
  141949. }
  141950. c->iOffset = 0; /* start tokenizing at the beginning */
  141951. c->iToken = 0;
  141952. c->zToken = NULL; /* no space allocated, yet. */
  141953. c->nAllocated = 0;
  141954. *ppCursor = &c->base;
  141955. return SQLITE_OK;
  141956. }
  141957. /*
  141958. ** Close a tokenization cursor previously opened by a call to
  141959. ** porterOpen() above.
  141960. */
  141961. static int porterClose(sqlite3_tokenizer_cursor *pCursor){
  141962. porter_tokenizer_cursor *c = (porter_tokenizer_cursor *) pCursor;
  141963. sqlite3_free(c->zToken);
  141964. sqlite3_free(c);
  141965. return SQLITE_OK;
  141966. }
  141967. /*
  141968. ** Vowel or consonant
  141969. */
  141970. static const char cType[] = {
  141971. 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0,
  141972. 1, 1, 1, 2, 1
  141973. };
  141974. /*
  141975. ** isConsonant() and isVowel() determine if their first character in
  141976. ** the string they point to is a consonant or a vowel, according
  141977. ** to Porter ruls.
  141978. **
  141979. ** A consonate is any letter other than 'a', 'e', 'i', 'o', or 'u'.
  141980. ** 'Y' is a consonant unless it follows another consonant,
  141981. ** in which case it is a vowel.
  141982. **
  141983. ** In these routine, the letters are in reverse order. So the 'y' rule
  141984. ** is that 'y' is a consonant unless it is followed by another
  141985. ** consonent.
  141986. */
  141987. static int isVowel(const char*);
  141988. static int isConsonant(const char *z){
  141989. int j;
  141990. char x = *z;
  141991. if( x==0 ) return 0;
  141992. assert( x>='a' && x<='z' );
  141993. j = cType[x-'a'];
  141994. if( j<2 ) return j;
  141995. return z[1]==0 || isVowel(z + 1);
  141996. }
  141997. static int isVowel(const char *z){
  141998. int j;
  141999. char x = *z;
  142000. if( x==0 ) return 0;
  142001. assert( x>='a' && x<='z' );
  142002. j = cType[x-'a'];
  142003. if( j<2 ) return 1-j;
  142004. return isConsonant(z + 1);
  142005. }
  142006. /*
  142007. ** Let any sequence of one or more vowels be represented by V and let
  142008. ** C be sequence of one or more consonants. Then every word can be
  142009. ** represented as:
  142010. **
  142011. ** [C] (VC){m} [V]
  142012. **
  142013. ** In prose: A word is an optional consonant followed by zero or
  142014. ** vowel-consonant pairs followed by an optional vowel. "m" is the
  142015. ** number of vowel consonant pairs. This routine computes the value
  142016. ** of m for the first i bytes of a word.
  142017. **
  142018. ** Return true if the m-value for z is 1 or more. In other words,
  142019. ** return true if z contains at least one vowel that is followed
  142020. ** by a consonant.
  142021. **
  142022. ** In this routine z[] is in reverse order. So we are really looking
  142023. ** for an instance of a consonant followed by a vowel.
  142024. */
  142025. static int m_gt_0(const char *z){
  142026. while( isVowel(z) ){ z++; }
  142027. if( *z==0 ) return 0;
  142028. while( isConsonant(z) ){ z++; }
  142029. return *z!=0;
  142030. }
  142031. /* Like mgt0 above except we are looking for a value of m which is
  142032. ** exactly 1
  142033. */
  142034. static int m_eq_1(const char *z){
  142035. while( isVowel(z) ){ z++; }
  142036. if( *z==0 ) return 0;
  142037. while( isConsonant(z) ){ z++; }
  142038. if( *z==0 ) return 0;
  142039. while( isVowel(z) ){ z++; }
  142040. if( *z==0 ) return 1;
  142041. while( isConsonant(z) ){ z++; }
  142042. return *z==0;
  142043. }
  142044. /* Like mgt0 above except we are looking for a value of m>1 instead
  142045. ** or m>0
  142046. */
  142047. static int m_gt_1(const char *z){
  142048. while( isVowel(z) ){ z++; }
  142049. if( *z==0 ) return 0;
  142050. while( isConsonant(z) ){ z++; }
  142051. if( *z==0 ) return 0;
  142052. while( isVowel(z) ){ z++; }
  142053. if( *z==0 ) return 0;
  142054. while( isConsonant(z) ){ z++; }
  142055. return *z!=0;
  142056. }
  142057. /*
  142058. ** Return TRUE if there is a vowel anywhere within z[0..n-1]
  142059. */
  142060. static int hasVowel(const char *z){
  142061. while( isConsonant(z) ){ z++; }
  142062. return *z!=0;
  142063. }
  142064. /*
  142065. ** Return TRUE if the word ends in a double consonant.
  142066. **
  142067. ** The text is reversed here. So we are really looking at
  142068. ** the first two characters of z[].
  142069. */
  142070. static int doubleConsonant(const char *z){
  142071. return isConsonant(z) && z[0]==z[1];
  142072. }
  142073. /*
  142074. ** Return TRUE if the word ends with three letters which
  142075. ** are consonant-vowel-consonent and where the final consonant
  142076. ** is not 'w', 'x', or 'y'.
  142077. **
  142078. ** The word is reversed here. So we are really checking the
  142079. ** first three letters and the first one cannot be in [wxy].
  142080. */
  142081. static int star_oh(const char *z){
  142082. return
  142083. isConsonant(z) &&
  142084. z[0]!='w' && z[0]!='x' && z[0]!='y' &&
  142085. isVowel(z+1) &&
  142086. isConsonant(z+2);
  142087. }
  142088. /*
  142089. ** If the word ends with zFrom and xCond() is true for the stem
  142090. ** of the word that preceeds the zFrom ending, then change the
  142091. ** ending to zTo.
  142092. **
  142093. ** The input word *pz and zFrom are both in reverse order. zTo
  142094. ** is in normal order.
  142095. **
  142096. ** Return TRUE if zFrom matches. Return FALSE if zFrom does not
  142097. ** match. Not that TRUE is returned even if xCond() fails and
  142098. ** no substitution occurs.
  142099. */
  142100. static int stem(
  142101. char **pz, /* The word being stemmed (Reversed) */
  142102. const char *zFrom, /* If the ending matches this... (Reversed) */
  142103. const char *zTo, /* ... change the ending to this (not reversed) */
  142104. int (*xCond)(const char*) /* Condition that must be true */
  142105. ){
  142106. char *z = *pz;
  142107. while( *zFrom && *zFrom==*z ){ z++; zFrom++; }
  142108. if( *zFrom!=0 ) return 0;
  142109. if( xCond && !xCond(z) ) return 1;
  142110. while( *zTo ){
  142111. *(--z) = *(zTo++);
  142112. }
  142113. *pz = z;
  142114. return 1;
  142115. }
  142116. /*
  142117. ** This is the fallback stemmer used when the porter stemmer is
  142118. ** inappropriate. The input word is copied into the output with
  142119. ** US-ASCII case folding. If the input word is too long (more
  142120. ** than 20 bytes if it contains no digits or more than 6 bytes if
  142121. ** it contains digits) then word is truncated to 20 or 6 bytes
  142122. ** by taking 10 or 3 bytes from the beginning and end.
  142123. */
  142124. static void copy_stemmer(const char *zIn, int nIn, char *zOut, int *pnOut){
  142125. int i, mx, j;
  142126. int hasDigit = 0;
  142127. for(i=0; i<nIn; i++){
  142128. char c = zIn[i];
  142129. if( c>='A' && c<='Z' ){
  142130. zOut[i] = c - 'A' + 'a';
  142131. }else{
  142132. if( c>='0' && c<='9' ) hasDigit = 1;
  142133. zOut[i] = c;
  142134. }
  142135. }
  142136. mx = hasDigit ? 3 : 10;
  142137. if( nIn>mx*2 ){
  142138. for(j=mx, i=nIn-mx; i<nIn; i++, j++){
  142139. zOut[j] = zOut[i];
  142140. }
  142141. i = j;
  142142. }
  142143. zOut[i] = 0;
  142144. *pnOut = i;
  142145. }
  142146. /*
  142147. ** Stem the input word zIn[0..nIn-1]. Store the output in zOut.
  142148. ** zOut is at least big enough to hold nIn bytes. Write the actual
  142149. ** size of the output word (exclusive of the '\0' terminator) into *pnOut.
  142150. **
  142151. ** Any upper-case characters in the US-ASCII character set ([A-Z])
  142152. ** are converted to lower case. Upper-case UTF characters are
  142153. ** unchanged.
  142154. **
  142155. ** Words that are longer than about 20 bytes are stemmed by retaining
  142156. ** a few bytes from the beginning and the end of the word. If the
  142157. ** word contains digits, 3 bytes are taken from the beginning and
  142158. ** 3 bytes from the end. For long words without digits, 10 bytes
  142159. ** are taken from each end. US-ASCII case folding still applies.
  142160. **
  142161. ** If the input word contains not digits but does characters not
  142162. ** in [a-zA-Z] then no stemming is attempted and this routine just
  142163. ** copies the input into the input into the output with US-ASCII
  142164. ** case folding.
  142165. **
  142166. ** Stemming never increases the length of the word. So there is
  142167. ** no chance of overflowing the zOut buffer.
  142168. */
  142169. static void porter_stemmer(const char *zIn, int nIn, char *zOut, int *pnOut){
  142170. int i, j;
  142171. char zReverse[28];
  142172. char *z, *z2;
  142173. if( nIn<3 || nIn>=(int)sizeof(zReverse)-7 ){
  142174. /* The word is too big or too small for the porter stemmer.
  142175. ** Fallback to the copy stemmer */
  142176. copy_stemmer(zIn, nIn, zOut, pnOut);
  142177. return;
  142178. }
  142179. for(i=0, j=sizeof(zReverse)-6; i<nIn; i++, j--){
  142180. char c = zIn[i];
  142181. if( c>='A' && c<='Z' ){
  142182. zReverse[j] = c + 'a' - 'A';
  142183. }else if( c>='a' && c<='z' ){
  142184. zReverse[j] = c;
  142185. }else{
  142186. /* The use of a character not in [a-zA-Z] means that we fallback
  142187. ** to the copy stemmer */
  142188. copy_stemmer(zIn, nIn, zOut, pnOut);
  142189. return;
  142190. }
  142191. }
  142192. memset(&zReverse[sizeof(zReverse)-5], 0, 5);
  142193. z = &zReverse[j+1];
  142194. /* Step 1a */
  142195. if( z[0]=='s' ){
  142196. if(
  142197. !stem(&z, "sess", "ss", 0) &&
  142198. !stem(&z, "sei", "i", 0) &&
  142199. !stem(&z, "ss", "ss", 0)
  142200. ){
  142201. z++;
  142202. }
  142203. }
  142204. /* Step 1b */
  142205. z2 = z;
  142206. if( stem(&z, "dee", "ee", m_gt_0) ){
  142207. /* Do nothing. The work was all in the test */
  142208. }else if(
  142209. (stem(&z, "gni", "", hasVowel) || stem(&z, "de", "", hasVowel))
  142210. && z!=z2
  142211. ){
  142212. if( stem(&z, "ta", "ate", 0) ||
  142213. stem(&z, "lb", "ble", 0) ||
  142214. stem(&z, "zi", "ize", 0) ){
  142215. /* Do nothing. The work was all in the test */
  142216. }else if( doubleConsonant(z) && (*z!='l' && *z!='s' && *z!='z') ){
  142217. z++;
  142218. }else if( m_eq_1(z) && star_oh(z) ){
  142219. *(--z) = 'e';
  142220. }
  142221. }
  142222. /* Step 1c */
  142223. if( z[0]=='y' && hasVowel(z+1) ){
  142224. z[0] = 'i';
  142225. }
  142226. /* Step 2 */
  142227. switch( z[1] ){
  142228. case 'a':
  142229. if( !stem(&z, "lanoita", "ate", m_gt_0) ){
  142230. stem(&z, "lanoit", "tion", m_gt_0);
  142231. }
  142232. break;
  142233. case 'c':
  142234. if( !stem(&z, "icne", "ence", m_gt_0) ){
  142235. stem(&z, "icna", "ance", m_gt_0);
  142236. }
  142237. break;
  142238. case 'e':
  142239. stem(&z, "rezi", "ize", m_gt_0);
  142240. break;
  142241. case 'g':
  142242. stem(&z, "igol", "log", m_gt_0);
  142243. break;
  142244. case 'l':
  142245. if( !stem(&z, "ilb", "ble", m_gt_0)
  142246. && !stem(&z, "illa", "al", m_gt_0)
  142247. && !stem(&z, "iltne", "ent", m_gt_0)
  142248. && !stem(&z, "ile", "e", m_gt_0)
  142249. ){
  142250. stem(&z, "ilsuo", "ous", m_gt_0);
  142251. }
  142252. break;
  142253. case 'o':
  142254. if( !stem(&z, "noitazi", "ize", m_gt_0)
  142255. && !stem(&z, "noita", "ate", m_gt_0)
  142256. ){
  142257. stem(&z, "rota", "ate", m_gt_0);
  142258. }
  142259. break;
  142260. case 's':
  142261. if( !stem(&z, "msila", "al", m_gt_0)
  142262. && !stem(&z, "ssenevi", "ive", m_gt_0)
  142263. && !stem(&z, "ssenluf", "ful", m_gt_0)
  142264. ){
  142265. stem(&z, "ssensuo", "ous", m_gt_0);
  142266. }
  142267. break;
  142268. case 't':
  142269. if( !stem(&z, "itila", "al", m_gt_0)
  142270. && !stem(&z, "itivi", "ive", m_gt_0)
  142271. ){
  142272. stem(&z, "itilib", "ble", m_gt_0);
  142273. }
  142274. break;
  142275. }
  142276. /* Step 3 */
  142277. switch( z[0] ){
  142278. case 'e':
  142279. if( !stem(&z, "etaci", "ic", m_gt_0)
  142280. && !stem(&z, "evita", "", m_gt_0)
  142281. ){
  142282. stem(&z, "ezila", "al", m_gt_0);
  142283. }
  142284. break;
  142285. case 'i':
  142286. stem(&z, "itici", "ic", m_gt_0);
  142287. break;
  142288. case 'l':
  142289. if( !stem(&z, "laci", "ic", m_gt_0) ){
  142290. stem(&z, "luf", "", m_gt_0);
  142291. }
  142292. break;
  142293. case 's':
  142294. stem(&z, "ssen", "", m_gt_0);
  142295. break;
  142296. }
  142297. /* Step 4 */
  142298. switch( z[1] ){
  142299. case 'a':
  142300. if( z[0]=='l' && m_gt_1(z+2) ){
  142301. z += 2;
  142302. }
  142303. break;
  142304. case 'c':
  142305. if( z[0]=='e' && z[2]=='n' && (z[3]=='a' || z[3]=='e') && m_gt_1(z+4) ){
  142306. z += 4;
  142307. }
  142308. break;
  142309. case 'e':
  142310. if( z[0]=='r' && m_gt_1(z+2) ){
  142311. z += 2;
  142312. }
  142313. break;
  142314. case 'i':
  142315. if( z[0]=='c' && m_gt_1(z+2) ){
  142316. z += 2;
  142317. }
  142318. break;
  142319. case 'l':
  142320. if( z[0]=='e' && z[2]=='b' && (z[3]=='a' || z[3]=='i') && m_gt_1(z+4) ){
  142321. z += 4;
  142322. }
  142323. break;
  142324. case 'n':
  142325. if( z[0]=='t' ){
  142326. if( z[2]=='a' ){
  142327. if( m_gt_1(z+3) ){
  142328. z += 3;
  142329. }
  142330. }else if( z[2]=='e' ){
  142331. if( !stem(&z, "tneme", "", m_gt_1)
  142332. && !stem(&z, "tnem", "", m_gt_1)
  142333. ){
  142334. stem(&z, "tne", "", m_gt_1);
  142335. }
  142336. }
  142337. }
  142338. break;
  142339. case 'o':
  142340. if( z[0]=='u' ){
  142341. if( m_gt_1(z+2) ){
  142342. z += 2;
  142343. }
  142344. }else if( z[3]=='s' || z[3]=='t' ){
  142345. stem(&z, "noi", "", m_gt_1);
  142346. }
  142347. break;
  142348. case 's':
  142349. if( z[0]=='m' && z[2]=='i' && m_gt_1(z+3) ){
  142350. z += 3;
  142351. }
  142352. break;
  142353. case 't':
  142354. if( !stem(&z, "eta", "", m_gt_1) ){
  142355. stem(&z, "iti", "", m_gt_1);
  142356. }
  142357. break;
  142358. case 'u':
  142359. if( z[0]=='s' && z[2]=='o' && m_gt_1(z+3) ){
  142360. z += 3;
  142361. }
  142362. break;
  142363. case 'v':
  142364. case 'z':
  142365. if( z[0]=='e' && z[2]=='i' && m_gt_1(z+3) ){
  142366. z += 3;
  142367. }
  142368. break;
  142369. }
  142370. /* Step 5a */
  142371. if( z[0]=='e' ){
  142372. if( m_gt_1(z+1) ){
  142373. z++;
  142374. }else if( m_eq_1(z+1) && !star_oh(z+1) ){
  142375. z++;
  142376. }
  142377. }
  142378. /* Step 5b */
  142379. if( m_gt_1(z) && z[0]=='l' && z[1]=='l' ){
  142380. z++;
  142381. }
  142382. /* z[] is now the stemmed word in reverse order. Flip it back
  142383. ** around into forward order and return.
  142384. */
  142385. *pnOut = i = (int)strlen(z);
  142386. zOut[i] = 0;
  142387. while( *z ){
  142388. zOut[--i] = *(z++);
  142389. }
  142390. }
  142391. /*
  142392. ** Characters that can be part of a token. We assume any character
  142393. ** whose value is greater than 0x80 (any UTF character) can be
  142394. ** part of a token. In other words, delimiters all must have
  142395. ** values of 0x7f or lower.
  142396. */
  142397. static const char porterIdChar[] = {
  142398. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
  142399. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 3x */
  142400. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 4x */
  142401. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 5x */
  142402. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 6x */
  142403. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 7x */
  142404. };
  142405. #define isDelim(C) (((ch=C)&0x80)==0 && (ch<0x30 || !porterIdChar[ch-0x30]))
  142406. /*
  142407. ** Extract the next token from a tokenization cursor. The cursor must
  142408. ** have been opened by a prior call to porterOpen().
  142409. */
  142410. static int porterNext(
  142411. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by porterOpen */
  142412. const char **pzToken, /* OUT: *pzToken is the token text */
  142413. int *pnBytes, /* OUT: Number of bytes in token */
  142414. int *piStartOffset, /* OUT: Starting offset of token */
  142415. int *piEndOffset, /* OUT: Ending offset of token */
  142416. int *piPosition /* OUT: Position integer of token */
  142417. ){
  142418. porter_tokenizer_cursor *c = (porter_tokenizer_cursor *) pCursor;
  142419. const char *z = c->zInput;
  142420. while( c->iOffset<c->nInput ){
  142421. int iStartOffset, ch;
  142422. /* Scan past delimiter characters */
  142423. while( c->iOffset<c->nInput && isDelim(z[c->iOffset]) ){
  142424. c->iOffset++;
  142425. }
  142426. /* Count non-delimiter characters. */
  142427. iStartOffset = c->iOffset;
  142428. while( c->iOffset<c->nInput && !isDelim(z[c->iOffset]) ){
  142429. c->iOffset++;
  142430. }
  142431. if( c->iOffset>iStartOffset ){
  142432. int n = c->iOffset-iStartOffset;
  142433. if( n>c->nAllocated ){
  142434. char *pNew;
  142435. c->nAllocated = n+20;
  142436. pNew = sqlite3_realloc(c->zToken, c->nAllocated);
  142437. if( !pNew ) return SQLITE_NOMEM;
  142438. c->zToken = pNew;
  142439. }
  142440. porter_stemmer(&z[iStartOffset], n, c->zToken, pnBytes);
  142441. *pzToken = c->zToken;
  142442. *piStartOffset = iStartOffset;
  142443. *piEndOffset = c->iOffset;
  142444. *piPosition = c->iToken++;
  142445. return SQLITE_OK;
  142446. }
  142447. }
  142448. return SQLITE_DONE;
  142449. }
  142450. /*
  142451. ** The set of routines that implement the porter-stemmer tokenizer
  142452. */
  142453. static const sqlite3_tokenizer_module porterTokenizerModule = {
  142454. 0,
  142455. porterCreate,
  142456. porterDestroy,
  142457. porterOpen,
  142458. porterClose,
  142459. porterNext,
  142460. 0
  142461. };
  142462. /*
  142463. ** Allocate a new porter tokenizer. Return a pointer to the new
  142464. ** tokenizer in *ppModule
  142465. */
  142466. SQLITE_PRIVATE void sqlite3Fts3PorterTokenizerModule(
  142467. sqlite3_tokenizer_module const**ppModule
  142468. ){
  142469. *ppModule = &porterTokenizerModule;
  142470. }
  142471. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  142472. /************** End of fts3_porter.c *****************************************/
  142473. /************** Begin file fts3_tokenizer.c **********************************/
  142474. /*
  142475. ** 2007 June 22
  142476. **
  142477. ** The author disclaims copyright to this source code. In place of
  142478. ** a legal notice, here is a blessing:
  142479. **
  142480. ** May you do good and not evil.
  142481. ** May you find forgiveness for yourself and forgive others.
  142482. ** May you share freely, never taking more than you give.
  142483. **
  142484. ******************************************************************************
  142485. **
  142486. ** This is part of an SQLite module implementing full-text search.
  142487. ** This particular file implements the generic tokenizer interface.
  142488. */
  142489. /*
  142490. ** The code in this file is only compiled if:
  142491. **
  142492. ** * The FTS3 module is being built as an extension
  142493. ** (in which case SQLITE_CORE is not defined), or
  142494. **
  142495. ** * The FTS3 module is being built into the core of
  142496. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  142497. */
  142498. /* #include "fts3Int.h" */
  142499. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  142500. /* #include <assert.h> */
  142501. /* #include <string.h> */
  142502. /*
  142503. ** Return true if the two-argument version of fts3_tokenizer()
  142504. ** has been activated via a prior call to sqlite3_db_config(db,
  142505. ** SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, 1, 0);
  142506. */
  142507. static int fts3TokenizerEnabled(sqlite3_context *context){
  142508. sqlite3 *db = sqlite3_context_db_handle(context);
  142509. int isEnabled = 0;
  142510. sqlite3_db_config(db,SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER,-1,&isEnabled);
  142511. return isEnabled;
  142512. }
  142513. /*
  142514. ** Implementation of the SQL scalar function for accessing the underlying
  142515. ** hash table. This function may be called as follows:
  142516. **
  142517. ** SELECT <function-name>(<key-name>);
  142518. ** SELECT <function-name>(<key-name>, <pointer>);
  142519. **
  142520. ** where <function-name> is the name passed as the second argument
  142521. ** to the sqlite3Fts3InitHashTable() function (e.g. 'fts3_tokenizer').
  142522. **
  142523. ** If the <pointer> argument is specified, it must be a blob value
  142524. ** containing a pointer to be stored as the hash data corresponding
  142525. ** to the string <key-name>. If <pointer> is not specified, then
  142526. ** the string <key-name> must already exist in the has table. Otherwise,
  142527. ** an error is returned.
  142528. **
  142529. ** Whether or not the <pointer> argument is specified, the value returned
  142530. ** is a blob containing the pointer stored as the hash data corresponding
  142531. ** to string <key-name> (after the hash-table is updated, if applicable).
  142532. */
  142533. static void fts3TokenizerFunc(
  142534. sqlite3_context *context,
  142535. int argc,
  142536. sqlite3_value **argv
  142537. ){
  142538. Fts3Hash *pHash;
  142539. void *pPtr = 0;
  142540. const unsigned char *zName;
  142541. int nName;
  142542. assert( argc==1 || argc==2 );
  142543. pHash = (Fts3Hash *)sqlite3_user_data(context);
  142544. zName = sqlite3_value_text(argv[0]);
  142545. nName = sqlite3_value_bytes(argv[0])+1;
  142546. if( argc==2 ){
  142547. if( fts3TokenizerEnabled(context) ){
  142548. void *pOld;
  142549. int n = sqlite3_value_bytes(argv[1]);
  142550. if( zName==0 || n!=sizeof(pPtr) ){
  142551. sqlite3_result_error(context, "argument type mismatch", -1);
  142552. return;
  142553. }
  142554. pPtr = *(void **)sqlite3_value_blob(argv[1]);
  142555. pOld = sqlite3Fts3HashInsert(pHash, (void *)zName, nName, pPtr);
  142556. if( pOld==pPtr ){
  142557. sqlite3_result_error(context, "out of memory", -1);
  142558. }
  142559. }else{
  142560. sqlite3_result_error(context, "fts3tokenize disabled", -1);
  142561. return;
  142562. }
  142563. }else{
  142564. if( zName ){
  142565. pPtr = sqlite3Fts3HashFind(pHash, zName, nName);
  142566. }
  142567. if( !pPtr ){
  142568. char *zErr = sqlite3_mprintf("unknown tokenizer: %s", zName);
  142569. sqlite3_result_error(context, zErr, -1);
  142570. sqlite3_free(zErr);
  142571. return;
  142572. }
  142573. }
  142574. sqlite3_result_blob(context, (void *)&pPtr, sizeof(pPtr), SQLITE_TRANSIENT);
  142575. }
  142576. SQLITE_PRIVATE int sqlite3Fts3IsIdChar(char c){
  142577. static const char isFtsIdChar[] = {
  142578. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x */
  142579. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 1x */
  142580. 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 2x */
  142581. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 3x */
  142582. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 4x */
  142583. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 5x */
  142584. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 6x */
  142585. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 7x */
  142586. };
  142587. return (c&0x80 || isFtsIdChar[(int)(c)]);
  142588. }
  142589. SQLITE_PRIVATE const char *sqlite3Fts3NextToken(const char *zStr, int *pn){
  142590. const char *z1;
  142591. const char *z2 = 0;
  142592. /* Find the start of the next token. */
  142593. z1 = zStr;
  142594. while( z2==0 ){
  142595. char c = *z1;
  142596. switch( c ){
  142597. case '\0': return 0; /* No more tokens here */
  142598. case '\'':
  142599. case '"':
  142600. case '`': {
  142601. z2 = z1;
  142602. while( *++z2 && (*z2!=c || *++z2==c) );
  142603. break;
  142604. }
  142605. case '[':
  142606. z2 = &z1[1];
  142607. while( *z2 && z2[0]!=']' ) z2++;
  142608. if( *z2 ) z2++;
  142609. break;
  142610. default:
  142611. if( sqlite3Fts3IsIdChar(*z1) ){
  142612. z2 = &z1[1];
  142613. while( sqlite3Fts3IsIdChar(*z2) ) z2++;
  142614. }else{
  142615. z1++;
  142616. }
  142617. }
  142618. }
  142619. *pn = (int)(z2-z1);
  142620. return z1;
  142621. }
  142622. SQLITE_PRIVATE int sqlite3Fts3InitTokenizer(
  142623. Fts3Hash *pHash, /* Tokenizer hash table */
  142624. const char *zArg, /* Tokenizer name */
  142625. sqlite3_tokenizer **ppTok, /* OUT: Tokenizer (if applicable) */
  142626. char **pzErr /* OUT: Set to malloced error message */
  142627. ){
  142628. int rc;
  142629. char *z = (char *)zArg;
  142630. int n = 0;
  142631. char *zCopy;
  142632. char *zEnd; /* Pointer to nul-term of zCopy */
  142633. sqlite3_tokenizer_module *m;
  142634. zCopy = sqlite3_mprintf("%s", zArg);
  142635. if( !zCopy ) return SQLITE_NOMEM;
  142636. zEnd = &zCopy[strlen(zCopy)];
  142637. z = (char *)sqlite3Fts3NextToken(zCopy, &n);
  142638. if( z==0 ){
  142639. assert( n==0 );
  142640. z = zCopy;
  142641. }
  142642. z[n] = '\0';
  142643. sqlite3Fts3Dequote(z);
  142644. m = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash,z,(int)strlen(z)+1);
  142645. if( !m ){
  142646. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer: %s", z);
  142647. rc = SQLITE_ERROR;
  142648. }else{
  142649. char const **aArg = 0;
  142650. int iArg = 0;
  142651. z = &z[n+1];
  142652. while( z<zEnd && (NULL!=(z = (char *)sqlite3Fts3NextToken(z, &n))) ){
  142653. int nNew = sizeof(char *)*(iArg+1);
  142654. char const **aNew = (const char **)sqlite3_realloc((void *)aArg, nNew);
  142655. if( !aNew ){
  142656. sqlite3_free(zCopy);
  142657. sqlite3_free((void *)aArg);
  142658. return SQLITE_NOMEM;
  142659. }
  142660. aArg = aNew;
  142661. aArg[iArg++] = z;
  142662. z[n] = '\0';
  142663. sqlite3Fts3Dequote(z);
  142664. z = &z[n+1];
  142665. }
  142666. rc = m->xCreate(iArg, aArg, ppTok);
  142667. assert( rc!=SQLITE_OK || *ppTok );
  142668. if( rc!=SQLITE_OK ){
  142669. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer");
  142670. }else{
  142671. (*ppTok)->pModule = m;
  142672. }
  142673. sqlite3_free((void *)aArg);
  142674. }
  142675. sqlite3_free(zCopy);
  142676. return rc;
  142677. }
  142678. #ifdef SQLITE_TEST
  142679. #if defined(INCLUDE_SQLITE_TCL_H)
  142680. # include "sqlite_tcl.h"
  142681. #else
  142682. # include "tcl.h"
  142683. #endif
  142684. /* #include <string.h> */
  142685. /*
  142686. ** Implementation of a special SQL scalar function for testing tokenizers
  142687. ** designed to be used in concert with the Tcl testing framework. This
  142688. ** function must be called with two or more arguments:
  142689. **
  142690. ** SELECT <function-name>(<key-name>, ..., <input-string>);
  142691. **
  142692. ** where <function-name> is the name passed as the second argument
  142693. ** to the sqlite3Fts3InitHashTable() function (e.g. 'fts3_tokenizer')
  142694. ** concatenated with the string '_test' (e.g. 'fts3_tokenizer_test').
  142695. **
  142696. ** The return value is a string that may be interpreted as a Tcl
  142697. ** list. For each token in the <input-string>, three elements are
  142698. ** added to the returned list. The first is the token position, the
  142699. ** second is the token text (folded, stemmed, etc.) and the third is the
  142700. ** substring of <input-string> associated with the token. For example,
  142701. ** using the built-in "simple" tokenizer:
  142702. **
  142703. ** SELECT fts_tokenizer_test('simple', 'I don't see how');
  142704. **
  142705. ** will return the string:
  142706. **
  142707. ** "{0 i I 1 dont don't 2 see see 3 how how}"
  142708. **
  142709. */
  142710. static void testFunc(
  142711. sqlite3_context *context,
  142712. int argc,
  142713. sqlite3_value **argv
  142714. ){
  142715. Fts3Hash *pHash;
  142716. sqlite3_tokenizer_module *p;
  142717. sqlite3_tokenizer *pTokenizer = 0;
  142718. sqlite3_tokenizer_cursor *pCsr = 0;
  142719. const char *zErr = 0;
  142720. const char *zName;
  142721. int nName;
  142722. const char *zInput;
  142723. int nInput;
  142724. const char *azArg[64];
  142725. const char *zToken;
  142726. int nToken = 0;
  142727. int iStart = 0;
  142728. int iEnd = 0;
  142729. int iPos = 0;
  142730. int i;
  142731. Tcl_Obj *pRet;
  142732. if( argc<2 ){
  142733. sqlite3_result_error(context, "insufficient arguments", -1);
  142734. return;
  142735. }
  142736. nName = sqlite3_value_bytes(argv[0]);
  142737. zName = (const char *)sqlite3_value_text(argv[0]);
  142738. nInput = sqlite3_value_bytes(argv[argc-1]);
  142739. zInput = (const char *)sqlite3_value_text(argv[argc-1]);
  142740. pHash = (Fts3Hash *)sqlite3_user_data(context);
  142741. p = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash, zName, nName+1);
  142742. if( !p ){
  142743. char *zErr2 = sqlite3_mprintf("unknown tokenizer: %s", zName);
  142744. sqlite3_result_error(context, zErr2, -1);
  142745. sqlite3_free(zErr2);
  142746. return;
  142747. }
  142748. pRet = Tcl_NewObj();
  142749. Tcl_IncrRefCount(pRet);
  142750. for(i=1; i<argc-1; i++){
  142751. azArg[i-1] = (const char *)sqlite3_value_text(argv[i]);
  142752. }
  142753. if( SQLITE_OK!=p->xCreate(argc-2, azArg, &pTokenizer) ){
  142754. zErr = "error in xCreate()";
  142755. goto finish;
  142756. }
  142757. pTokenizer->pModule = p;
  142758. if( sqlite3Fts3OpenTokenizer(pTokenizer, 0, zInput, nInput, &pCsr) ){
  142759. zErr = "error in xOpen()";
  142760. goto finish;
  142761. }
  142762. while( SQLITE_OK==p->xNext(pCsr, &zToken, &nToken, &iStart, &iEnd, &iPos) ){
  142763. Tcl_ListObjAppendElement(0, pRet, Tcl_NewIntObj(iPos));
  142764. Tcl_ListObjAppendElement(0, pRet, Tcl_NewStringObj(zToken, nToken));
  142765. zToken = &zInput[iStart];
  142766. nToken = iEnd-iStart;
  142767. Tcl_ListObjAppendElement(0, pRet, Tcl_NewStringObj(zToken, nToken));
  142768. }
  142769. if( SQLITE_OK!=p->xClose(pCsr) ){
  142770. zErr = "error in xClose()";
  142771. goto finish;
  142772. }
  142773. if( SQLITE_OK!=p->xDestroy(pTokenizer) ){
  142774. zErr = "error in xDestroy()";
  142775. goto finish;
  142776. }
  142777. finish:
  142778. if( zErr ){
  142779. sqlite3_result_error(context, zErr, -1);
  142780. }else{
  142781. sqlite3_result_text(context, Tcl_GetString(pRet), -1, SQLITE_TRANSIENT);
  142782. }
  142783. Tcl_DecrRefCount(pRet);
  142784. }
  142785. static
  142786. int registerTokenizer(
  142787. sqlite3 *db,
  142788. char *zName,
  142789. const sqlite3_tokenizer_module *p
  142790. ){
  142791. int rc;
  142792. sqlite3_stmt *pStmt;
  142793. const char zSql[] = "SELECT fts3_tokenizer(?, ?)";
  142794. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  142795. if( rc!=SQLITE_OK ){
  142796. return rc;
  142797. }
  142798. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  142799. sqlite3_bind_blob(pStmt, 2, &p, sizeof(p), SQLITE_STATIC);
  142800. sqlite3_step(pStmt);
  142801. return sqlite3_finalize(pStmt);
  142802. }
  142803. static
  142804. int queryTokenizer(
  142805. sqlite3 *db,
  142806. char *zName,
  142807. const sqlite3_tokenizer_module **pp
  142808. ){
  142809. int rc;
  142810. sqlite3_stmt *pStmt;
  142811. const char zSql[] = "SELECT fts3_tokenizer(?)";
  142812. *pp = 0;
  142813. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  142814. if( rc!=SQLITE_OK ){
  142815. return rc;
  142816. }
  142817. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  142818. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  142819. if( sqlite3_column_type(pStmt, 0)==SQLITE_BLOB ){
  142820. memcpy((void *)pp, sqlite3_column_blob(pStmt, 0), sizeof(*pp));
  142821. }
  142822. }
  142823. return sqlite3_finalize(pStmt);
  142824. }
  142825. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  142826. /*
  142827. ** Implementation of the scalar function fts3_tokenizer_internal_test().
  142828. ** This function is used for testing only, it is not included in the
  142829. ** build unless SQLITE_TEST is defined.
  142830. **
  142831. ** The purpose of this is to test that the fts3_tokenizer() function
  142832. ** can be used as designed by the C-code in the queryTokenizer and
  142833. ** registerTokenizer() functions above. These two functions are repeated
  142834. ** in the README.tokenizer file as an example, so it is important to
  142835. ** test them.
  142836. **
  142837. ** To run the tests, evaluate the fts3_tokenizer_internal_test() scalar
  142838. ** function with no arguments. An assert() will fail if a problem is
  142839. ** detected. i.e.:
  142840. **
  142841. ** SELECT fts3_tokenizer_internal_test();
  142842. **
  142843. */
  142844. static void intTestFunc(
  142845. sqlite3_context *context,
  142846. int argc,
  142847. sqlite3_value **argv
  142848. ){
  142849. int rc;
  142850. const sqlite3_tokenizer_module *p1;
  142851. const sqlite3_tokenizer_module *p2;
  142852. sqlite3 *db = (sqlite3 *)sqlite3_user_data(context);
  142853. UNUSED_PARAMETER(argc);
  142854. UNUSED_PARAMETER(argv);
  142855. /* Test the query function */
  142856. sqlite3Fts3SimpleTokenizerModule(&p1);
  142857. rc = queryTokenizer(db, "simple", &p2);
  142858. assert( rc==SQLITE_OK );
  142859. assert( p1==p2 );
  142860. rc = queryTokenizer(db, "nosuchtokenizer", &p2);
  142861. assert( rc==SQLITE_ERROR );
  142862. assert( p2==0 );
  142863. assert( 0==strcmp(sqlite3_errmsg(db), "unknown tokenizer: nosuchtokenizer") );
  142864. /* Test the storage function */
  142865. if( fts3TokenizerEnabled(context) ){
  142866. rc = registerTokenizer(db, "nosuchtokenizer", p1);
  142867. assert( rc==SQLITE_OK );
  142868. rc = queryTokenizer(db, "nosuchtokenizer", &p2);
  142869. assert( rc==SQLITE_OK );
  142870. assert( p2==p1 );
  142871. }
  142872. sqlite3_result_text(context, "ok", -1, SQLITE_STATIC);
  142873. }
  142874. #endif
  142875. /*
  142876. ** Set up SQL objects in database db used to access the contents of
  142877. ** the hash table pointed to by argument pHash. The hash table must
  142878. ** been initialized to use string keys, and to take a private copy
  142879. ** of the key when a value is inserted. i.e. by a call similar to:
  142880. **
  142881. ** sqlite3Fts3HashInit(pHash, FTS3_HASH_STRING, 1);
  142882. **
  142883. ** This function adds a scalar function (see header comment above
  142884. ** fts3TokenizerFunc() in this file for details) and, if ENABLE_TABLE is
  142885. ** defined at compilation time, a temporary virtual table (see header
  142886. ** comment above struct HashTableVtab) to the database schema. Both
  142887. ** provide read/write access to the contents of *pHash.
  142888. **
  142889. ** The third argument to this function, zName, is used as the name
  142890. ** of both the scalar and, if created, the virtual table.
  142891. */
  142892. SQLITE_PRIVATE int sqlite3Fts3InitHashTable(
  142893. sqlite3 *db,
  142894. Fts3Hash *pHash,
  142895. const char *zName
  142896. ){
  142897. int rc = SQLITE_OK;
  142898. void *p = (void *)pHash;
  142899. const int any = SQLITE_ANY;
  142900. #ifdef SQLITE_TEST
  142901. char *zTest = 0;
  142902. char *zTest2 = 0;
  142903. void *pdb = (void *)db;
  142904. zTest = sqlite3_mprintf("%s_test", zName);
  142905. zTest2 = sqlite3_mprintf("%s_internal_test", zName);
  142906. if( !zTest || !zTest2 ){
  142907. rc = SQLITE_NOMEM;
  142908. }
  142909. #endif
  142910. if( SQLITE_OK==rc ){
  142911. rc = sqlite3_create_function(db, zName, 1, any, p, fts3TokenizerFunc, 0, 0);
  142912. }
  142913. if( SQLITE_OK==rc ){
  142914. rc = sqlite3_create_function(db, zName, 2, any, p, fts3TokenizerFunc, 0, 0);
  142915. }
  142916. #ifdef SQLITE_TEST
  142917. if( SQLITE_OK==rc ){
  142918. rc = sqlite3_create_function(db, zTest, -1, any, p, testFunc, 0, 0);
  142919. }
  142920. if( SQLITE_OK==rc ){
  142921. rc = sqlite3_create_function(db, zTest2, 0, any, pdb, intTestFunc, 0, 0);
  142922. }
  142923. #endif
  142924. #ifdef SQLITE_TEST
  142925. sqlite3_free(zTest);
  142926. sqlite3_free(zTest2);
  142927. #endif
  142928. return rc;
  142929. }
  142930. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  142931. /************** End of fts3_tokenizer.c **************************************/
  142932. /************** Begin file fts3_tokenizer1.c *********************************/
  142933. /*
  142934. ** 2006 Oct 10
  142935. **
  142936. ** The author disclaims copyright to this source code. In place of
  142937. ** a legal notice, here is a blessing:
  142938. **
  142939. ** May you do good and not evil.
  142940. ** May you find forgiveness for yourself and forgive others.
  142941. ** May you share freely, never taking more than you give.
  142942. **
  142943. ******************************************************************************
  142944. **
  142945. ** Implementation of the "simple" full-text-search tokenizer.
  142946. */
  142947. /*
  142948. ** The code in this file is only compiled if:
  142949. **
  142950. ** * The FTS3 module is being built as an extension
  142951. ** (in which case SQLITE_CORE is not defined), or
  142952. **
  142953. ** * The FTS3 module is being built into the core of
  142954. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  142955. */
  142956. /* #include "fts3Int.h" */
  142957. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  142958. /* #include <assert.h> */
  142959. /* #include <stdlib.h> */
  142960. /* #include <stdio.h> */
  142961. /* #include <string.h> */
  142962. /* #include "fts3_tokenizer.h" */
  142963. typedef struct simple_tokenizer {
  142964. sqlite3_tokenizer base;
  142965. char delim[128]; /* flag ASCII delimiters */
  142966. } simple_tokenizer;
  142967. typedef struct simple_tokenizer_cursor {
  142968. sqlite3_tokenizer_cursor base;
  142969. const char *pInput; /* input we are tokenizing */
  142970. int nBytes; /* size of the input */
  142971. int iOffset; /* current position in pInput */
  142972. int iToken; /* index of next token to be returned */
  142973. char *pToken; /* storage for current token */
  142974. int nTokenAllocated; /* space allocated to zToken buffer */
  142975. } simple_tokenizer_cursor;
  142976. static int simpleDelim(simple_tokenizer *t, unsigned char c){
  142977. return c<0x80 && t->delim[c];
  142978. }
  142979. static int fts3_isalnum(int x){
  142980. return (x>='0' && x<='9') || (x>='A' && x<='Z') || (x>='a' && x<='z');
  142981. }
  142982. /*
  142983. ** Create a new tokenizer instance.
  142984. */
  142985. static int simpleCreate(
  142986. int argc, const char * const *argv,
  142987. sqlite3_tokenizer **ppTokenizer
  142988. ){
  142989. simple_tokenizer *t;
  142990. t = (simple_tokenizer *) sqlite3_malloc(sizeof(*t));
  142991. if( t==NULL ) return SQLITE_NOMEM;
  142992. memset(t, 0, sizeof(*t));
  142993. /* TODO(shess) Delimiters need to remain the same from run to run,
  142994. ** else we need to reindex. One solution would be a meta-table to
  142995. ** track such information in the database, then we'd only want this
  142996. ** information on the initial create.
  142997. */
  142998. if( argc>1 ){
  142999. int i, n = (int)strlen(argv[1]);
  143000. for(i=0; i<n; i++){
  143001. unsigned char ch = argv[1][i];
  143002. /* We explicitly don't support UTF-8 delimiters for now. */
  143003. if( ch>=0x80 ){
  143004. sqlite3_free(t);
  143005. return SQLITE_ERROR;
  143006. }
  143007. t->delim[ch] = 1;
  143008. }
  143009. } else {
  143010. /* Mark non-alphanumeric ASCII characters as delimiters */
  143011. int i;
  143012. for(i=1; i<0x80; i++){
  143013. t->delim[i] = !fts3_isalnum(i) ? -1 : 0;
  143014. }
  143015. }
  143016. *ppTokenizer = &t->base;
  143017. return SQLITE_OK;
  143018. }
  143019. /*
  143020. ** Destroy a tokenizer
  143021. */
  143022. static int simpleDestroy(sqlite3_tokenizer *pTokenizer){
  143023. sqlite3_free(pTokenizer);
  143024. return SQLITE_OK;
  143025. }
  143026. /*
  143027. ** Prepare to begin tokenizing a particular string. The input
  143028. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  143029. ** used to incrementally tokenize this string is returned in
  143030. ** *ppCursor.
  143031. */
  143032. static int simpleOpen(
  143033. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  143034. const char *pInput, int nBytes, /* String to be tokenized */
  143035. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  143036. ){
  143037. simple_tokenizer_cursor *c;
  143038. UNUSED_PARAMETER(pTokenizer);
  143039. c = (simple_tokenizer_cursor *) sqlite3_malloc(sizeof(*c));
  143040. if( c==NULL ) return SQLITE_NOMEM;
  143041. c->pInput = pInput;
  143042. if( pInput==0 ){
  143043. c->nBytes = 0;
  143044. }else if( nBytes<0 ){
  143045. c->nBytes = (int)strlen(pInput);
  143046. }else{
  143047. c->nBytes = nBytes;
  143048. }
  143049. c->iOffset = 0; /* start tokenizing at the beginning */
  143050. c->iToken = 0;
  143051. c->pToken = NULL; /* no space allocated, yet. */
  143052. c->nTokenAllocated = 0;
  143053. *ppCursor = &c->base;
  143054. return SQLITE_OK;
  143055. }
  143056. /*
  143057. ** Close a tokenization cursor previously opened by a call to
  143058. ** simpleOpen() above.
  143059. */
  143060. static int simpleClose(sqlite3_tokenizer_cursor *pCursor){
  143061. simple_tokenizer_cursor *c = (simple_tokenizer_cursor *) pCursor;
  143062. sqlite3_free(c->pToken);
  143063. sqlite3_free(c);
  143064. return SQLITE_OK;
  143065. }
  143066. /*
  143067. ** Extract the next token from a tokenization cursor. The cursor must
  143068. ** have been opened by a prior call to simpleOpen().
  143069. */
  143070. static int simpleNext(
  143071. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by simpleOpen */
  143072. const char **ppToken, /* OUT: *ppToken is the token text */
  143073. int *pnBytes, /* OUT: Number of bytes in token */
  143074. int *piStartOffset, /* OUT: Starting offset of token */
  143075. int *piEndOffset, /* OUT: Ending offset of token */
  143076. int *piPosition /* OUT: Position integer of token */
  143077. ){
  143078. simple_tokenizer_cursor *c = (simple_tokenizer_cursor *) pCursor;
  143079. simple_tokenizer *t = (simple_tokenizer *) pCursor->pTokenizer;
  143080. unsigned char *p = (unsigned char *)c->pInput;
  143081. while( c->iOffset<c->nBytes ){
  143082. int iStartOffset;
  143083. /* Scan past delimiter characters */
  143084. while( c->iOffset<c->nBytes && simpleDelim(t, p[c->iOffset]) ){
  143085. c->iOffset++;
  143086. }
  143087. /* Count non-delimiter characters. */
  143088. iStartOffset = c->iOffset;
  143089. while( c->iOffset<c->nBytes && !simpleDelim(t, p[c->iOffset]) ){
  143090. c->iOffset++;
  143091. }
  143092. if( c->iOffset>iStartOffset ){
  143093. int i, n = c->iOffset-iStartOffset;
  143094. if( n>c->nTokenAllocated ){
  143095. char *pNew;
  143096. c->nTokenAllocated = n+20;
  143097. pNew = sqlite3_realloc(c->pToken, c->nTokenAllocated);
  143098. if( !pNew ) return SQLITE_NOMEM;
  143099. c->pToken = pNew;
  143100. }
  143101. for(i=0; i<n; i++){
  143102. /* TODO(shess) This needs expansion to handle UTF-8
  143103. ** case-insensitivity.
  143104. */
  143105. unsigned char ch = p[iStartOffset+i];
  143106. c->pToken[i] = (char)((ch>='A' && ch<='Z') ? ch-'A'+'a' : ch);
  143107. }
  143108. *ppToken = c->pToken;
  143109. *pnBytes = n;
  143110. *piStartOffset = iStartOffset;
  143111. *piEndOffset = c->iOffset;
  143112. *piPosition = c->iToken++;
  143113. return SQLITE_OK;
  143114. }
  143115. }
  143116. return SQLITE_DONE;
  143117. }
  143118. /*
  143119. ** The set of routines that implement the simple tokenizer
  143120. */
  143121. static const sqlite3_tokenizer_module simpleTokenizerModule = {
  143122. 0,
  143123. simpleCreate,
  143124. simpleDestroy,
  143125. simpleOpen,
  143126. simpleClose,
  143127. simpleNext,
  143128. 0,
  143129. };
  143130. /*
  143131. ** Allocate a new simple tokenizer. Return a pointer to the new
  143132. ** tokenizer in *ppModule
  143133. */
  143134. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(
  143135. sqlite3_tokenizer_module const**ppModule
  143136. ){
  143137. *ppModule = &simpleTokenizerModule;
  143138. }
  143139. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  143140. /************** End of fts3_tokenizer1.c *************************************/
  143141. /************** Begin file fts3_tokenize_vtab.c ******************************/
  143142. /*
  143143. ** 2013 Apr 22
  143144. **
  143145. ** The author disclaims copyright to this source code. In place of
  143146. ** a legal notice, here is a blessing:
  143147. **
  143148. ** May you do good and not evil.
  143149. ** May you find forgiveness for yourself and forgive others.
  143150. ** May you share freely, never taking more than you give.
  143151. **
  143152. ******************************************************************************
  143153. **
  143154. ** This file contains code for the "fts3tokenize" virtual table module.
  143155. ** An fts3tokenize virtual table is created as follows:
  143156. **
  143157. ** CREATE VIRTUAL TABLE <tbl> USING fts3tokenize(
  143158. ** <tokenizer-name>, <arg-1>, ...
  143159. ** );
  143160. **
  143161. ** The table created has the following schema:
  143162. **
  143163. ** CREATE TABLE <tbl>(input, token, start, end, position)
  143164. **
  143165. ** When queried, the query must include a WHERE clause of type:
  143166. **
  143167. ** input = <string>
  143168. **
  143169. ** The virtual table module tokenizes this <string>, using the FTS3
  143170. ** tokenizer specified by the arguments to the CREATE VIRTUAL TABLE
  143171. ** statement and returns one row for each token in the result. With
  143172. ** fields set as follows:
  143173. **
  143174. ** input: Always set to a copy of <string>
  143175. ** token: A token from the input.
  143176. ** start: Byte offset of the token within the input <string>.
  143177. ** end: Byte offset of the byte immediately following the end of the
  143178. ** token within the input string.
  143179. ** pos: Token offset of token within input.
  143180. **
  143181. */
  143182. /* #include "fts3Int.h" */
  143183. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  143184. /* #include <string.h> */
  143185. /* #include <assert.h> */
  143186. typedef struct Fts3tokTable Fts3tokTable;
  143187. typedef struct Fts3tokCursor Fts3tokCursor;
  143188. /*
  143189. ** Virtual table structure.
  143190. */
  143191. struct Fts3tokTable {
  143192. sqlite3_vtab base; /* Base class used by SQLite core */
  143193. const sqlite3_tokenizer_module *pMod;
  143194. sqlite3_tokenizer *pTok;
  143195. };
  143196. /*
  143197. ** Virtual table cursor structure.
  143198. */
  143199. struct Fts3tokCursor {
  143200. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  143201. char *zInput; /* Input string */
  143202. sqlite3_tokenizer_cursor *pCsr; /* Cursor to iterate through zInput */
  143203. int iRowid; /* Current 'rowid' value */
  143204. const char *zToken; /* Current 'token' value */
  143205. int nToken; /* Size of zToken in bytes */
  143206. int iStart; /* Current 'start' value */
  143207. int iEnd; /* Current 'end' value */
  143208. int iPos; /* Current 'pos' value */
  143209. };
  143210. /*
  143211. ** Query FTS for the tokenizer implementation named zName.
  143212. */
  143213. static int fts3tokQueryTokenizer(
  143214. Fts3Hash *pHash,
  143215. const char *zName,
  143216. const sqlite3_tokenizer_module **pp,
  143217. char **pzErr
  143218. ){
  143219. sqlite3_tokenizer_module *p;
  143220. int nName = (int)strlen(zName);
  143221. p = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash, zName, nName+1);
  143222. if( !p ){
  143223. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer: %s", zName);
  143224. return SQLITE_ERROR;
  143225. }
  143226. *pp = p;
  143227. return SQLITE_OK;
  143228. }
  143229. /*
  143230. ** The second argument, argv[], is an array of pointers to nul-terminated
  143231. ** strings. This function makes a copy of the array and strings into a
  143232. ** single block of memory. It then dequotes any of the strings that appear
  143233. ** to be quoted.
  143234. **
  143235. ** If successful, output parameter *pazDequote is set to point at the
  143236. ** array of dequoted strings and SQLITE_OK is returned. The caller is
  143237. ** responsible for eventually calling sqlite3_free() to free the array
  143238. ** in this case. Or, if an error occurs, an SQLite error code is returned.
  143239. ** The final value of *pazDequote is undefined in this case.
  143240. */
  143241. static int fts3tokDequoteArray(
  143242. int argc, /* Number of elements in argv[] */
  143243. const char * const *argv, /* Input array */
  143244. char ***pazDequote /* Output array */
  143245. ){
  143246. int rc = SQLITE_OK; /* Return code */
  143247. if( argc==0 ){
  143248. *pazDequote = 0;
  143249. }else{
  143250. int i;
  143251. int nByte = 0;
  143252. char **azDequote;
  143253. for(i=0; i<argc; i++){
  143254. nByte += (int)(strlen(argv[i]) + 1);
  143255. }
  143256. *pazDequote = azDequote = sqlite3_malloc(sizeof(char *)*argc + nByte);
  143257. if( azDequote==0 ){
  143258. rc = SQLITE_NOMEM;
  143259. }else{
  143260. char *pSpace = (char *)&azDequote[argc];
  143261. for(i=0; i<argc; i++){
  143262. int n = (int)strlen(argv[i]);
  143263. azDequote[i] = pSpace;
  143264. memcpy(pSpace, argv[i], n+1);
  143265. sqlite3Fts3Dequote(pSpace);
  143266. pSpace += (n+1);
  143267. }
  143268. }
  143269. }
  143270. return rc;
  143271. }
  143272. /*
  143273. ** Schema of the tokenizer table.
  143274. */
  143275. #define FTS3_TOK_SCHEMA "CREATE TABLE x(input, token, start, end, position)"
  143276. /*
  143277. ** This function does all the work for both the xConnect and xCreate methods.
  143278. ** These tables have no persistent representation of their own, so xConnect
  143279. ** and xCreate are identical operations.
  143280. **
  143281. ** argv[0]: module name
  143282. ** argv[1]: database name
  143283. ** argv[2]: table name
  143284. ** argv[3]: first argument (tokenizer name)
  143285. */
  143286. static int fts3tokConnectMethod(
  143287. sqlite3 *db, /* Database connection */
  143288. void *pHash, /* Hash table of tokenizers */
  143289. int argc, /* Number of elements in argv array */
  143290. const char * const *argv, /* xCreate/xConnect argument array */
  143291. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  143292. char **pzErr /* OUT: sqlite3_malloc'd error message */
  143293. ){
  143294. Fts3tokTable *pTab = 0;
  143295. const sqlite3_tokenizer_module *pMod = 0;
  143296. sqlite3_tokenizer *pTok = 0;
  143297. int rc;
  143298. char **azDequote = 0;
  143299. int nDequote;
  143300. rc = sqlite3_declare_vtab(db, FTS3_TOK_SCHEMA);
  143301. if( rc!=SQLITE_OK ) return rc;
  143302. nDequote = argc-3;
  143303. rc = fts3tokDequoteArray(nDequote, &argv[3], &azDequote);
  143304. if( rc==SQLITE_OK ){
  143305. const char *zModule;
  143306. if( nDequote<1 ){
  143307. zModule = "simple";
  143308. }else{
  143309. zModule = azDequote[0];
  143310. }
  143311. rc = fts3tokQueryTokenizer((Fts3Hash*)pHash, zModule, &pMod, pzErr);
  143312. }
  143313. assert( (rc==SQLITE_OK)==(pMod!=0) );
  143314. if( rc==SQLITE_OK ){
  143315. const char * const *azArg = (const char * const *)&azDequote[1];
  143316. rc = pMod->xCreate((nDequote>1 ? nDequote-1 : 0), azArg, &pTok);
  143317. }
  143318. if( rc==SQLITE_OK ){
  143319. pTab = (Fts3tokTable *)sqlite3_malloc(sizeof(Fts3tokTable));
  143320. if( pTab==0 ){
  143321. rc = SQLITE_NOMEM;
  143322. }
  143323. }
  143324. if( rc==SQLITE_OK ){
  143325. memset(pTab, 0, sizeof(Fts3tokTable));
  143326. pTab->pMod = pMod;
  143327. pTab->pTok = pTok;
  143328. *ppVtab = &pTab->base;
  143329. }else{
  143330. if( pTok ){
  143331. pMod->xDestroy(pTok);
  143332. }
  143333. }
  143334. sqlite3_free(azDequote);
  143335. return rc;
  143336. }
  143337. /*
  143338. ** This function does the work for both the xDisconnect and xDestroy methods.
  143339. ** These tables have no persistent representation of their own, so xDisconnect
  143340. ** and xDestroy are identical operations.
  143341. */
  143342. static int fts3tokDisconnectMethod(sqlite3_vtab *pVtab){
  143343. Fts3tokTable *pTab = (Fts3tokTable *)pVtab;
  143344. pTab->pMod->xDestroy(pTab->pTok);
  143345. sqlite3_free(pTab);
  143346. return SQLITE_OK;
  143347. }
  143348. /*
  143349. ** xBestIndex - Analyze a WHERE and ORDER BY clause.
  143350. */
  143351. static int fts3tokBestIndexMethod(
  143352. sqlite3_vtab *pVTab,
  143353. sqlite3_index_info *pInfo
  143354. ){
  143355. int i;
  143356. UNUSED_PARAMETER(pVTab);
  143357. for(i=0; i<pInfo->nConstraint; i++){
  143358. if( pInfo->aConstraint[i].usable
  143359. && pInfo->aConstraint[i].iColumn==0
  143360. && pInfo->aConstraint[i].op==SQLITE_INDEX_CONSTRAINT_EQ
  143361. ){
  143362. pInfo->idxNum = 1;
  143363. pInfo->aConstraintUsage[i].argvIndex = 1;
  143364. pInfo->aConstraintUsage[i].omit = 1;
  143365. pInfo->estimatedCost = 1;
  143366. return SQLITE_OK;
  143367. }
  143368. }
  143369. pInfo->idxNum = 0;
  143370. assert( pInfo->estimatedCost>1000000.0 );
  143371. return SQLITE_OK;
  143372. }
  143373. /*
  143374. ** xOpen - Open a cursor.
  143375. */
  143376. static int fts3tokOpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  143377. Fts3tokCursor *pCsr;
  143378. UNUSED_PARAMETER(pVTab);
  143379. pCsr = (Fts3tokCursor *)sqlite3_malloc(sizeof(Fts3tokCursor));
  143380. if( pCsr==0 ){
  143381. return SQLITE_NOMEM;
  143382. }
  143383. memset(pCsr, 0, sizeof(Fts3tokCursor));
  143384. *ppCsr = (sqlite3_vtab_cursor *)pCsr;
  143385. return SQLITE_OK;
  143386. }
  143387. /*
  143388. ** Reset the tokenizer cursor passed as the only argument. As if it had
  143389. ** just been returned by fts3tokOpenMethod().
  143390. */
  143391. static void fts3tokResetCursor(Fts3tokCursor *pCsr){
  143392. if( pCsr->pCsr ){
  143393. Fts3tokTable *pTab = (Fts3tokTable *)(pCsr->base.pVtab);
  143394. pTab->pMod->xClose(pCsr->pCsr);
  143395. pCsr->pCsr = 0;
  143396. }
  143397. sqlite3_free(pCsr->zInput);
  143398. pCsr->zInput = 0;
  143399. pCsr->zToken = 0;
  143400. pCsr->nToken = 0;
  143401. pCsr->iStart = 0;
  143402. pCsr->iEnd = 0;
  143403. pCsr->iPos = 0;
  143404. pCsr->iRowid = 0;
  143405. }
  143406. /*
  143407. ** xClose - Close a cursor.
  143408. */
  143409. static int fts3tokCloseMethod(sqlite3_vtab_cursor *pCursor){
  143410. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143411. fts3tokResetCursor(pCsr);
  143412. sqlite3_free(pCsr);
  143413. return SQLITE_OK;
  143414. }
  143415. /*
  143416. ** xNext - Advance the cursor to the next row, if any.
  143417. */
  143418. static int fts3tokNextMethod(sqlite3_vtab_cursor *pCursor){
  143419. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143420. Fts3tokTable *pTab = (Fts3tokTable *)(pCursor->pVtab);
  143421. int rc; /* Return code */
  143422. pCsr->iRowid++;
  143423. rc = pTab->pMod->xNext(pCsr->pCsr,
  143424. &pCsr->zToken, &pCsr->nToken,
  143425. &pCsr->iStart, &pCsr->iEnd, &pCsr->iPos
  143426. );
  143427. if( rc!=SQLITE_OK ){
  143428. fts3tokResetCursor(pCsr);
  143429. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  143430. }
  143431. return rc;
  143432. }
  143433. /*
  143434. ** xFilter - Initialize a cursor to point at the start of its data.
  143435. */
  143436. static int fts3tokFilterMethod(
  143437. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  143438. int idxNum, /* Strategy index */
  143439. const char *idxStr, /* Unused */
  143440. int nVal, /* Number of elements in apVal */
  143441. sqlite3_value **apVal /* Arguments for the indexing scheme */
  143442. ){
  143443. int rc = SQLITE_ERROR;
  143444. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143445. Fts3tokTable *pTab = (Fts3tokTable *)(pCursor->pVtab);
  143446. UNUSED_PARAMETER(idxStr);
  143447. UNUSED_PARAMETER(nVal);
  143448. fts3tokResetCursor(pCsr);
  143449. if( idxNum==1 ){
  143450. const char *zByte = (const char *)sqlite3_value_text(apVal[0]);
  143451. int nByte = sqlite3_value_bytes(apVal[0]);
  143452. pCsr->zInput = sqlite3_malloc(nByte+1);
  143453. if( pCsr->zInput==0 ){
  143454. rc = SQLITE_NOMEM;
  143455. }else{
  143456. memcpy(pCsr->zInput, zByte, nByte);
  143457. pCsr->zInput[nByte] = 0;
  143458. rc = pTab->pMod->xOpen(pTab->pTok, pCsr->zInput, nByte, &pCsr->pCsr);
  143459. if( rc==SQLITE_OK ){
  143460. pCsr->pCsr->pTokenizer = pTab->pTok;
  143461. }
  143462. }
  143463. }
  143464. if( rc!=SQLITE_OK ) return rc;
  143465. return fts3tokNextMethod(pCursor);
  143466. }
  143467. /*
  143468. ** xEof - Return true if the cursor is at EOF, or false otherwise.
  143469. */
  143470. static int fts3tokEofMethod(sqlite3_vtab_cursor *pCursor){
  143471. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143472. return (pCsr->zToken==0);
  143473. }
  143474. /*
  143475. ** xColumn - Return a column value.
  143476. */
  143477. static int fts3tokColumnMethod(
  143478. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  143479. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  143480. int iCol /* Index of column to read value from */
  143481. ){
  143482. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143483. /* CREATE TABLE x(input, token, start, end, position) */
  143484. switch( iCol ){
  143485. case 0:
  143486. sqlite3_result_text(pCtx, pCsr->zInput, -1, SQLITE_TRANSIENT);
  143487. break;
  143488. case 1:
  143489. sqlite3_result_text(pCtx, pCsr->zToken, pCsr->nToken, SQLITE_TRANSIENT);
  143490. break;
  143491. case 2:
  143492. sqlite3_result_int(pCtx, pCsr->iStart);
  143493. break;
  143494. case 3:
  143495. sqlite3_result_int(pCtx, pCsr->iEnd);
  143496. break;
  143497. default:
  143498. assert( iCol==4 );
  143499. sqlite3_result_int(pCtx, pCsr->iPos);
  143500. break;
  143501. }
  143502. return SQLITE_OK;
  143503. }
  143504. /*
  143505. ** xRowid - Return the current rowid for the cursor.
  143506. */
  143507. static int fts3tokRowidMethod(
  143508. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  143509. sqlite_int64 *pRowid /* OUT: Rowid value */
  143510. ){
  143511. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  143512. *pRowid = (sqlite3_int64)pCsr->iRowid;
  143513. return SQLITE_OK;
  143514. }
  143515. /*
  143516. ** Register the fts3tok module with database connection db. Return SQLITE_OK
  143517. ** if successful or an error code if sqlite3_create_module() fails.
  143518. */
  143519. SQLITE_PRIVATE int sqlite3Fts3InitTok(sqlite3 *db, Fts3Hash *pHash){
  143520. static const sqlite3_module fts3tok_module = {
  143521. 0, /* iVersion */
  143522. fts3tokConnectMethod, /* xCreate */
  143523. fts3tokConnectMethod, /* xConnect */
  143524. fts3tokBestIndexMethod, /* xBestIndex */
  143525. fts3tokDisconnectMethod, /* xDisconnect */
  143526. fts3tokDisconnectMethod, /* xDestroy */
  143527. fts3tokOpenMethod, /* xOpen */
  143528. fts3tokCloseMethod, /* xClose */
  143529. fts3tokFilterMethod, /* xFilter */
  143530. fts3tokNextMethod, /* xNext */
  143531. fts3tokEofMethod, /* xEof */
  143532. fts3tokColumnMethod, /* xColumn */
  143533. fts3tokRowidMethod, /* xRowid */
  143534. 0, /* xUpdate */
  143535. 0, /* xBegin */
  143536. 0, /* xSync */
  143537. 0, /* xCommit */
  143538. 0, /* xRollback */
  143539. 0, /* xFindFunction */
  143540. 0, /* xRename */
  143541. 0, /* xSavepoint */
  143542. 0, /* xRelease */
  143543. 0 /* xRollbackTo */
  143544. };
  143545. int rc; /* Return code */
  143546. rc = sqlite3_create_module(db, "fts3tokenize", &fts3tok_module, (void*)pHash);
  143547. return rc;
  143548. }
  143549. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  143550. /************** End of fts3_tokenize_vtab.c **********************************/
  143551. /************** Begin file fts3_write.c **************************************/
  143552. /*
  143553. ** 2009 Oct 23
  143554. **
  143555. ** The author disclaims copyright to this source code. In place of
  143556. ** a legal notice, here is a blessing:
  143557. **
  143558. ** May you do good and not evil.
  143559. ** May you find forgiveness for yourself and forgive others.
  143560. ** May you share freely, never taking more than you give.
  143561. **
  143562. ******************************************************************************
  143563. **
  143564. ** This file is part of the SQLite FTS3 extension module. Specifically,
  143565. ** this file contains code to insert, update and delete rows from FTS3
  143566. ** tables. It also contains code to merge FTS3 b-tree segments. Some
  143567. ** of the sub-routines used to merge segments are also used by the query
  143568. ** code in fts3.c.
  143569. */
  143570. /* #include "fts3Int.h" */
  143571. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  143572. /* #include <string.h> */
  143573. /* #include <assert.h> */
  143574. /* #include <stdlib.h> */
  143575. #define FTS_MAX_APPENDABLE_HEIGHT 16
  143576. /*
  143577. ** When full-text index nodes are loaded from disk, the buffer that they
  143578. ** are loaded into has the following number of bytes of padding at the end
  143579. ** of it. i.e. if a full-text index node is 900 bytes in size, then a buffer
  143580. ** of 920 bytes is allocated for it.
  143581. **
  143582. ** This means that if we have a pointer into a buffer containing node data,
  143583. ** it is always safe to read up to two varints from it without risking an
  143584. ** overread, even if the node data is corrupted.
  143585. */
  143586. #define FTS3_NODE_PADDING (FTS3_VARINT_MAX*2)
  143587. /*
  143588. ** Under certain circumstances, b-tree nodes (doclists) can be loaded into
  143589. ** memory incrementally instead of all at once. This can be a big performance
  143590. ** win (reduced IO and CPU) if SQLite stops calling the virtual table xNext()
  143591. ** method before retrieving all query results (as may happen, for example,
  143592. ** if a query has a LIMIT clause).
  143593. **
  143594. ** Incremental loading is used for b-tree nodes FTS3_NODE_CHUNK_THRESHOLD
  143595. ** bytes and larger. Nodes are loaded in chunks of FTS3_NODE_CHUNKSIZE bytes.
  143596. ** The code is written so that the hard lower-limit for each of these values
  143597. ** is 1. Clearly such small values would be inefficient, but can be useful
  143598. ** for testing purposes.
  143599. **
  143600. ** If this module is built with SQLITE_TEST defined, these constants may
  143601. ** be overridden at runtime for testing purposes. File fts3_test.c contains
  143602. ** a Tcl interface to read and write the values.
  143603. */
  143604. #ifdef SQLITE_TEST
  143605. int test_fts3_node_chunksize = (4*1024);
  143606. int test_fts3_node_chunk_threshold = (4*1024)*4;
  143607. # define FTS3_NODE_CHUNKSIZE test_fts3_node_chunksize
  143608. # define FTS3_NODE_CHUNK_THRESHOLD test_fts3_node_chunk_threshold
  143609. #else
  143610. # define FTS3_NODE_CHUNKSIZE (4*1024)
  143611. # define FTS3_NODE_CHUNK_THRESHOLD (FTS3_NODE_CHUNKSIZE*4)
  143612. #endif
  143613. /*
  143614. ** The two values that may be meaningfully bound to the :1 parameter in
  143615. ** statements SQL_REPLACE_STAT and SQL_SELECT_STAT.
  143616. */
  143617. #define FTS_STAT_DOCTOTAL 0
  143618. #define FTS_STAT_INCRMERGEHINT 1
  143619. #define FTS_STAT_AUTOINCRMERGE 2
  143620. /*
  143621. ** If FTS_LOG_MERGES is defined, call sqlite3_log() to report each automatic
  143622. ** and incremental merge operation that takes place. This is used for
  143623. ** debugging FTS only, it should not usually be turned on in production
  143624. ** systems.
  143625. */
  143626. #ifdef FTS3_LOG_MERGES
  143627. static void fts3LogMerge(int nMerge, sqlite3_int64 iAbsLevel){
  143628. sqlite3_log(SQLITE_OK, "%d-way merge from level %d", nMerge, (int)iAbsLevel);
  143629. }
  143630. #else
  143631. #define fts3LogMerge(x, y)
  143632. #endif
  143633. typedef struct PendingList PendingList;
  143634. typedef struct SegmentNode SegmentNode;
  143635. typedef struct SegmentWriter SegmentWriter;
  143636. /*
  143637. ** An instance of the following data structure is used to build doclists
  143638. ** incrementally. See function fts3PendingListAppend() for details.
  143639. */
  143640. struct PendingList {
  143641. int nData;
  143642. char *aData;
  143643. int nSpace;
  143644. sqlite3_int64 iLastDocid;
  143645. sqlite3_int64 iLastCol;
  143646. sqlite3_int64 iLastPos;
  143647. };
  143648. /*
  143649. ** Each cursor has a (possibly empty) linked list of the following objects.
  143650. */
  143651. struct Fts3DeferredToken {
  143652. Fts3PhraseToken *pToken; /* Pointer to corresponding expr token */
  143653. int iCol; /* Column token must occur in */
  143654. Fts3DeferredToken *pNext; /* Next in list of deferred tokens */
  143655. PendingList *pList; /* Doclist is assembled here */
  143656. };
  143657. /*
  143658. ** An instance of this structure is used to iterate through the terms on
  143659. ** a contiguous set of segment b-tree leaf nodes. Although the details of
  143660. ** this structure are only manipulated by code in this file, opaque handles
  143661. ** of type Fts3SegReader* are also used by code in fts3.c to iterate through
  143662. ** terms when querying the full-text index. See functions:
  143663. **
  143664. ** sqlite3Fts3SegReaderNew()
  143665. ** sqlite3Fts3SegReaderFree()
  143666. ** sqlite3Fts3SegReaderIterate()
  143667. **
  143668. ** Methods used to manipulate Fts3SegReader structures:
  143669. **
  143670. ** fts3SegReaderNext()
  143671. ** fts3SegReaderFirstDocid()
  143672. ** fts3SegReaderNextDocid()
  143673. */
  143674. struct Fts3SegReader {
  143675. int iIdx; /* Index within level, or 0x7FFFFFFF for PT */
  143676. u8 bLookup; /* True for a lookup only */
  143677. u8 rootOnly; /* True for a root-only reader */
  143678. sqlite3_int64 iStartBlock; /* Rowid of first leaf block to traverse */
  143679. sqlite3_int64 iLeafEndBlock; /* Rowid of final leaf block to traverse */
  143680. sqlite3_int64 iEndBlock; /* Rowid of final block in segment (or 0) */
  143681. sqlite3_int64 iCurrentBlock; /* Current leaf block (or 0) */
  143682. char *aNode; /* Pointer to node data (or NULL) */
  143683. int nNode; /* Size of buffer at aNode (or 0) */
  143684. int nPopulate; /* If >0, bytes of buffer aNode[] loaded */
  143685. sqlite3_blob *pBlob; /* If not NULL, blob handle to read node */
  143686. Fts3HashElem **ppNextElem;
  143687. /* Variables set by fts3SegReaderNext(). These may be read directly
  143688. ** by the caller. They are valid from the time SegmentReaderNew() returns
  143689. ** until SegmentReaderNext() returns something other than SQLITE_OK
  143690. ** (i.e. SQLITE_DONE).
  143691. */
  143692. int nTerm; /* Number of bytes in current term */
  143693. char *zTerm; /* Pointer to current term */
  143694. int nTermAlloc; /* Allocated size of zTerm buffer */
  143695. char *aDoclist; /* Pointer to doclist of current entry */
  143696. int nDoclist; /* Size of doclist in current entry */
  143697. /* The following variables are used by fts3SegReaderNextDocid() to iterate
  143698. ** through the current doclist (aDoclist/nDoclist).
  143699. */
  143700. char *pOffsetList;
  143701. int nOffsetList; /* For descending pending seg-readers only */
  143702. sqlite3_int64 iDocid;
  143703. };
  143704. #define fts3SegReaderIsPending(p) ((p)->ppNextElem!=0)
  143705. #define fts3SegReaderIsRootOnly(p) ((p)->rootOnly!=0)
  143706. /*
  143707. ** An instance of this structure is used to create a segment b-tree in the
  143708. ** database. The internal details of this type are only accessed by the
  143709. ** following functions:
  143710. **
  143711. ** fts3SegWriterAdd()
  143712. ** fts3SegWriterFlush()
  143713. ** fts3SegWriterFree()
  143714. */
  143715. struct SegmentWriter {
  143716. SegmentNode *pTree; /* Pointer to interior tree structure */
  143717. sqlite3_int64 iFirst; /* First slot in %_segments written */
  143718. sqlite3_int64 iFree; /* Next free slot in %_segments */
  143719. char *zTerm; /* Pointer to previous term buffer */
  143720. int nTerm; /* Number of bytes in zTerm */
  143721. int nMalloc; /* Size of malloc'd buffer at zMalloc */
  143722. char *zMalloc; /* Malloc'd space (possibly) used for zTerm */
  143723. int nSize; /* Size of allocation at aData */
  143724. int nData; /* Bytes of data in aData */
  143725. char *aData; /* Pointer to block from malloc() */
  143726. i64 nLeafData; /* Number of bytes of leaf data written */
  143727. };
  143728. /*
  143729. ** Type SegmentNode is used by the following three functions to create
  143730. ** the interior part of the segment b+-tree structures (everything except
  143731. ** the leaf nodes). These functions and type are only ever used by code
  143732. ** within the fts3SegWriterXXX() family of functions described above.
  143733. **
  143734. ** fts3NodeAddTerm()
  143735. ** fts3NodeWrite()
  143736. ** fts3NodeFree()
  143737. **
  143738. ** When a b+tree is written to the database (either as a result of a merge
  143739. ** or the pending-terms table being flushed), leaves are written into the
  143740. ** database file as soon as they are completely populated. The interior of
  143741. ** the tree is assembled in memory and written out only once all leaves have
  143742. ** been populated and stored. This is Ok, as the b+-tree fanout is usually
  143743. ** very large, meaning that the interior of the tree consumes relatively
  143744. ** little memory.
  143745. */
  143746. struct SegmentNode {
  143747. SegmentNode *pParent; /* Parent node (or NULL for root node) */
  143748. SegmentNode *pRight; /* Pointer to right-sibling */
  143749. SegmentNode *pLeftmost; /* Pointer to left-most node of this depth */
  143750. int nEntry; /* Number of terms written to node so far */
  143751. char *zTerm; /* Pointer to previous term buffer */
  143752. int nTerm; /* Number of bytes in zTerm */
  143753. int nMalloc; /* Size of malloc'd buffer at zMalloc */
  143754. char *zMalloc; /* Malloc'd space (possibly) used for zTerm */
  143755. int nData; /* Bytes of valid data so far */
  143756. char *aData; /* Node data */
  143757. };
  143758. /*
  143759. ** Valid values for the second argument to fts3SqlStmt().
  143760. */
  143761. #define SQL_DELETE_CONTENT 0
  143762. #define SQL_IS_EMPTY 1
  143763. #define SQL_DELETE_ALL_CONTENT 2
  143764. #define SQL_DELETE_ALL_SEGMENTS 3
  143765. #define SQL_DELETE_ALL_SEGDIR 4
  143766. #define SQL_DELETE_ALL_DOCSIZE 5
  143767. #define SQL_DELETE_ALL_STAT 6
  143768. #define SQL_SELECT_CONTENT_BY_ROWID 7
  143769. #define SQL_NEXT_SEGMENT_INDEX 8
  143770. #define SQL_INSERT_SEGMENTS 9
  143771. #define SQL_NEXT_SEGMENTS_ID 10
  143772. #define SQL_INSERT_SEGDIR 11
  143773. #define SQL_SELECT_LEVEL 12
  143774. #define SQL_SELECT_LEVEL_RANGE 13
  143775. #define SQL_SELECT_LEVEL_COUNT 14
  143776. #define SQL_SELECT_SEGDIR_MAX_LEVEL 15
  143777. #define SQL_DELETE_SEGDIR_LEVEL 16
  143778. #define SQL_DELETE_SEGMENTS_RANGE 17
  143779. #define SQL_CONTENT_INSERT 18
  143780. #define SQL_DELETE_DOCSIZE 19
  143781. #define SQL_REPLACE_DOCSIZE 20
  143782. #define SQL_SELECT_DOCSIZE 21
  143783. #define SQL_SELECT_STAT 22
  143784. #define SQL_REPLACE_STAT 23
  143785. #define SQL_SELECT_ALL_PREFIX_LEVEL 24
  143786. #define SQL_DELETE_ALL_TERMS_SEGDIR 25
  143787. #define SQL_DELETE_SEGDIR_RANGE 26
  143788. #define SQL_SELECT_ALL_LANGID 27
  143789. #define SQL_FIND_MERGE_LEVEL 28
  143790. #define SQL_MAX_LEAF_NODE_ESTIMATE 29
  143791. #define SQL_DELETE_SEGDIR_ENTRY 30
  143792. #define SQL_SHIFT_SEGDIR_ENTRY 31
  143793. #define SQL_SELECT_SEGDIR 32
  143794. #define SQL_CHOMP_SEGDIR 33
  143795. #define SQL_SEGMENT_IS_APPENDABLE 34
  143796. #define SQL_SELECT_INDEXES 35
  143797. #define SQL_SELECT_MXLEVEL 36
  143798. #define SQL_SELECT_LEVEL_RANGE2 37
  143799. #define SQL_UPDATE_LEVEL_IDX 38
  143800. #define SQL_UPDATE_LEVEL 39
  143801. /*
  143802. ** This function is used to obtain an SQLite prepared statement handle
  143803. ** for the statement identified by the second argument. If successful,
  143804. ** *pp is set to the requested statement handle and SQLITE_OK returned.
  143805. ** Otherwise, an SQLite error code is returned and *pp is set to 0.
  143806. **
  143807. ** If argument apVal is not NULL, then it must point to an array with
  143808. ** at least as many entries as the requested statement has bound
  143809. ** parameters. The values are bound to the statements parameters before
  143810. ** returning.
  143811. */
  143812. static int fts3SqlStmt(
  143813. Fts3Table *p, /* Virtual table handle */
  143814. int eStmt, /* One of the SQL_XXX constants above */
  143815. sqlite3_stmt **pp, /* OUT: Statement handle */
  143816. sqlite3_value **apVal /* Values to bind to statement */
  143817. ){
  143818. const char *azSql[] = {
  143819. /* 0 */ "DELETE FROM %Q.'%q_content' WHERE rowid = ?",
  143820. /* 1 */ "SELECT NOT EXISTS(SELECT docid FROM %Q.'%q_content' WHERE rowid!=?)",
  143821. /* 2 */ "DELETE FROM %Q.'%q_content'",
  143822. /* 3 */ "DELETE FROM %Q.'%q_segments'",
  143823. /* 4 */ "DELETE FROM %Q.'%q_segdir'",
  143824. /* 5 */ "DELETE FROM %Q.'%q_docsize'",
  143825. /* 6 */ "DELETE FROM %Q.'%q_stat'",
  143826. /* 7 */ "SELECT %s WHERE rowid=?",
  143827. /* 8 */ "SELECT (SELECT max(idx) FROM %Q.'%q_segdir' WHERE level = ?) + 1",
  143828. /* 9 */ "REPLACE INTO %Q.'%q_segments'(blockid, block) VALUES(?, ?)",
  143829. /* 10 */ "SELECT coalesce((SELECT max(blockid) FROM %Q.'%q_segments') + 1, 1)",
  143830. /* 11 */ "REPLACE INTO %Q.'%q_segdir' VALUES(?,?,?,?,?,?)",
  143831. /* Return segments in order from oldest to newest.*/
  143832. /* 12 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  143833. "FROM %Q.'%q_segdir' WHERE level = ? ORDER BY idx ASC",
  143834. /* 13 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  143835. "FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?"
  143836. "ORDER BY level DESC, idx ASC",
  143837. /* 14 */ "SELECT count(*) FROM %Q.'%q_segdir' WHERE level = ?",
  143838. /* 15 */ "SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?",
  143839. /* 16 */ "DELETE FROM %Q.'%q_segdir' WHERE level = ?",
  143840. /* 17 */ "DELETE FROM %Q.'%q_segments' WHERE blockid BETWEEN ? AND ?",
  143841. /* 18 */ "INSERT INTO %Q.'%q_content' VALUES(%s)",
  143842. /* 19 */ "DELETE FROM %Q.'%q_docsize' WHERE docid = ?",
  143843. /* 20 */ "REPLACE INTO %Q.'%q_docsize' VALUES(?,?)",
  143844. /* 21 */ "SELECT size FROM %Q.'%q_docsize' WHERE docid=?",
  143845. /* 22 */ "SELECT value FROM %Q.'%q_stat' WHERE id=?",
  143846. /* 23 */ "REPLACE INTO %Q.'%q_stat' VALUES(?,?)",
  143847. /* 24 */ "",
  143848. /* 25 */ "",
  143849. /* 26 */ "DELETE FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?",
  143850. /* 27 */ "SELECT ? UNION SELECT level / (1024 * ?) FROM %Q.'%q_segdir'",
  143851. /* This statement is used to determine which level to read the input from
  143852. ** when performing an incremental merge. It returns the absolute level number
  143853. ** of the oldest level in the db that contains at least ? segments. Or,
  143854. ** if no level in the FTS index contains more than ? segments, the statement
  143855. ** returns zero rows. */
  143856. /* 28 */ "SELECT level, count(*) AS cnt FROM %Q.'%q_segdir' "
  143857. " GROUP BY level HAVING cnt>=?"
  143858. " ORDER BY (level %% 1024) ASC LIMIT 1",
  143859. /* Estimate the upper limit on the number of leaf nodes in a new segment
  143860. ** created by merging the oldest :2 segments from absolute level :1. See
  143861. ** function sqlite3Fts3Incrmerge() for details. */
  143862. /* 29 */ "SELECT 2 * total(1 + leaves_end_block - start_block) "
  143863. " FROM %Q.'%q_segdir' WHERE level = ? AND idx < ?",
  143864. /* SQL_DELETE_SEGDIR_ENTRY
  143865. ** Delete the %_segdir entry on absolute level :1 with index :2. */
  143866. /* 30 */ "DELETE FROM %Q.'%q_segdir' WHERE level = ? AND idx = ?",
  143867. /* SQL_SHIFT_SEGDIR_ENTRY
  143868. ** Modify the idx value for the segment with idx=:3 on absolute level :2
  143869. ** to :1. */
  143870. /* 31 */ "UPDATE %Q.'%q_segdir' SET idx = ? WHERE level=? AND idx=?",
  143871. /* SQL_SELECT_SEGDIR
  143872. ** Read a single entry from the %_segdir table. The entry from absolute
  143873. ** level :1 with index value :2. */
  143874. /* 32 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  143875. "FROM %Q.'%q_segdir' WHERE level = ? AND idx = ?",
  143876. /* SQL_CHOMP_SEGDIR
  143877. ** Update the start_block (:1) and root (:2) fields of the %_segdir
  143878. ** entry located on absolute level :3 with index :4. */
  143879. /* 33 */ "UPDATE %Q.'%q_segdir' SET start_block = ?, root = ?"
  143880. "WHERE level = ? AND idx = ?",
  143881. /* SQL_SEGMENT_IS_APPENDABLE
  143882. ** Return a single row if the segment with end_block=? is appendable. Or
  143883. ** no rows otherwise. */
  143884. /* 34 */ "SELECT 1 FROM %Q.'%q_segments' WHERE blockid=? AND block IS NULL",
  143885. /* SQL_SELECT_INDEXES
  143886. ** Return the list of valid segment indexes for absolute level ? */
  143887. /* 35 */ "SELECT idx FROM %Q.'%q_segdir' WHERE level=? ORDER BY 1 ASC",
  143888. /* SQL_SELECT_MXLEVEL
  143889. ** Return the largest relative level in the FTS index or indexes. */
  143890. /* 36 */ "SELECT max( level %% 1024 ) FROM %Q.'%q_segdir'",
  143891. /* Return segments in order from oldest to newest.*/
  143892. /* 37 */ "SELECT level, idx, end_block "
  143893. "FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ? "
  143894. "ORDER BY level DESC, idx ASC",
  143895. /* Update statements used while promoting segments */
  143896. /* 38 */ "UPDATE OR FAIL %Q.'%q_segdir' SET level=-1,idx=? "
  143897. "WHERE level=? AND idx=?",
  143898. /* 39 */ "UPDATE OR FAIL %Q.'%q_segdir' SET level=? WHERE level=-1"
  143899. };
  143900. int rc = SQLITE_OK;
  143901. sqlite3_stmt *pStmt;
  143902. assert( SizeofArray(azSql)==SizeofArray(p->aStmt) );
  143903. assert( eStmt<SizeofArray(azSql) && eStmt>=0 );
  143904. pStmt = p->aStmt[eStmt];
  143905. if( !pStmt ){
  143906. char *zSql;
  143907. if( eStmt==SQL_CONTENT_INSERT ){
  143908. zSql = sqlite3_mprintf(azSql[eStmt], p->zDb, p->zName, p->zWriteExprlist);
  143909. }else if( eStmt==SQL_SELECT_CONTENT_BY_ROWID ){
  143910. zSql = sqlite3_mprintf(azSql[eStmt], p->zReadExprlist);
  143911. }else{
  143912. zSql = sqlite3_mprintf(azSql[eStmt], p->zDb, p->zName);
  143913. }
  143914. if( !zSql ){
  143915. rc = SQLITE_NOMEM;
  143916. }else{
  143917. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, NULL);
  143918. sqlite3_free(zSql);
  143919. assert( rc==SQLITE_OK || pStmt==0 );
  143920. p->aStmt[eStmt] = pStmt;
  143921. }
  143922. }
  143923. if( apVal ){
  143924. int i;
  143925. int nParam = sqlite3_bind_parameter_count(pStmt);
  143926. for(i=0; rc==SQLITE_OK && i<nParam; i++){
  143927. rc = sqlite3_bind_value(pStmt, i+1, apVal[i]);
  143928. }
  143929. }
  143930. *pp = pStmt;
  143931. return rc;
  143932. }
  143933. static int fts3SelectDocsize(
  143934. Fts3Table *pTab, /* FTS3 table handle */
  143935. sqlite3_int64 iDocid, /* Docid to bind for SQL_SELECT_DOCSIZE */
  143936. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  143937. ){
  143938. sqlite3_stmt *pStmt = 0; /* Statement requested from fts3SqlStmt() */
  143939. int rc; /* Return code */
  143940. rc = fts3SqlStmt(pTab, SQL_SELECT_DOCSIZE, &pStmt, 0);
  143941. if( rc==SQLITE_OK ){
  143942. sqlite3_bind_int64(pStmt, 1, iDocid);
  143943. rc = sqlite3_step(pStmt);
  143944. if( rc!=SQLITE_ROW || sqlite3_column_type(pStmt, 0)!=SQLITE_BLOB ){
  143945. rc = sqlite3_reset(pStmt);
  143946. if( rc==SQLITE_OK ) rc = FTS_CORRUPT_VTAB;
  143947. pStmt = 0;
  143948. }else{
  143949. rc = SQLITE_OK;
  143950. }
  143951. }
  143952. *ppStmt = pStmt;
  143953. return rc;
  143954. }
  143955. SQLITE_PRIVATE int sqlite3Fts3SelectDoctotal(
  143956. Fts3Table *pTab, /* Fts3 table handle */
  143957. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  143958. ){
  143959. sqlite3_stmt *pStmt = 0;
  143960. int rc;
  143961. rc = fts3SqlStmt(pTab, SQL_SELECT_STAT, &pStmt, 0);
  143962. if( rc==SQLITE_OK ){
  143963. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  143964. if( sqlite3_step(pStmt)!=SQLITE_ROW
  143965. || sqlite3_column_type(pStmt, 0)!=SQLITE_BLOB
  143966. ){
  143967. rc = sqlite3_reset(pStmt);
  143968. if( rc==SQLITE_OK ) rc = FTS_CORRUPT_VTAB;
  143969. pStmt = 0;
  143970. }
  143971. }
  143972. *ppStmt = pStmt;
  143973. return rc;
  143974. }
  143975. SQLITE_PRIVATE int sqlite3Fts3SelectDocsize(
  143976. Fts3Table *pTab, /* Fts3 table handle */
  143977. sqlite3_int64 iDocid, /* Docid to read size data for */
  143978. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  143979. ){
  143980. return fts3SelectDocsize(pTab, iDocid, ppStmt);
  143981. }
  143982. /*
  143983. ** Similar to fts3SqlStmt(). Except, after binding the parameters in
  143984. ** array apVal[] to the SQL statement identified by eStmt, the statement
  143985. ** is executed.
  143986. **
  143987. ** Returns SQLITE_OK if the statement is successfully executed, or an
  143988. ** SQLite error code otherwise.
  143989. */
  143990. static void fts3SqlExec(
  143991. int *pRC, /* Result code */
  143992. Fts3Table *p, /* The FTS3 table */
  143993. int eStmt, /* Index of statement to evaluate */
  143994. sqlite3_value **apVal /* Parameters to bind */
  143995. ){
  143996. sqlite3_stmt *pStmt;
  143997. int rc;
  143998. if( *pRC ) return;
  143999. rc = fts3SqlStmt(p, eStmt, &pStmt, apVal);
  144000. if( rc==SQLITE_OK ){
  144001. sqlite3_step(pStmt);
  144002. rc = sqlite3_reset(pStmt);
  144003. }
  144004. *pRC = rc;
  144005. }
  144006. /*
  144007. ** This function ensures that the caller has obtained an exclusive
  144008. ** shared-cache table-lock on the %_segdir table. This is required before
  144009. ** writing data to the fts3 table. If this lock is not acquired first, then
  144010. ** the caller may end up attempting to take this lock as part of committing
  144011. ** a transaction, causing SQLite to return SQLITE_LOCKED or
  144012. ** LOCKED_SHAREDCACHEto a COMMIT command.
  144013. **
  144014. ** It is best to avoid this because if FTS3 returns any error when
  144015. ** committing a transaction, the whole transaction will be rolled back.
  144016. ** And this is not what users expect when they get SQLITE_LOCKED_SHAREDCACHE.
  144017. ** It can still happen if the user locks the underlying tables directly
  144018. ** instead of accessing them via FTS.
  144019. */
  144020. static int fts3Writelock(Fts3Table *p){
  144021. int rc = SQLITE_OK;
  144022. if( p->nPendingData==0 ){
  144023. sqlite3_stmt *pStmt;
  144024. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_LEVEL, &pStmt, 0);
  144025. if( rc==SQLITE_OK ){
  144026. sqlite3_bind_null(pStmt, 1);
  144027. sqlite3_step(pStmt);
  144028. rc = sqlite3_reset(pStmt);
  144029. }
  144030. }
  144031. return rc;
  144032. }
  144033. /*
  144034. ** FTS maintains a separate indexes for each language-id (a 32-bit integer).
  144035. ** Within each language id, a separate index is maintained to store the
  144036. ** document terms, and each configured prefix size (configured the FTS
  144037. ** "prefix=" option). And each index consists of multiple levels ("relative
  144038. ** levels").
  144039. **
  144040. ** All three of these values (the language id, the specific index and the
  144041. ** level within the index) are encoded in 64-bit integer values stored
  144042. ** in the %_segdir table on disk. This function is used to convert three
  144043. ** separate component values into the single 64-bit integer value that
  144044. ** can be used to query the %_segdir table.
  144045. **
  144046. ** Specifically, each language-id/index combination is allocated 1024
  144047. ** 64-bit integer level values ("absolute levels"). The main terms index
  144048. ** for language-id 0 is allocate values 0-1023. The first prefix index
  144049. ** (if any) for language-id 0 is allocated values 1024-2047. And so on.
  144050. ** Language 1 indexes are allocated immediately following language 0.
  144051. **
  144052. ** So, for a system with nPrefix prefix indexes configured, the block of
  144053. ** absolute levels that corresponds to language-id iLangid and index
  144054. ** iIndex starts at absolute level ((iLangid * (nPrefix+1) + iIndex) * 1024).
  144055. */
  144056. static sqlite3_int64 getAbsoluteLevel(
  144057. Fts3Table *p, /* FTS3 table handle */
  144058. int iLangid, /* Language id */
  144059. int iIndex, /* Index in p->aIndex[] */
  144060. int iLevel /* Level of segments */
  144061. ){
  144062. sqlite3_int64 iBase; /* First absolute level for iLangid/iIndex */
  144063. assert( iLangid>=0 );
  144064. assert( p->nIndex>0 );
  144065. assert( iIndex>=0 && iIndex<p->nIndex );
  144066. iBase = ((sqlite3_int64)iLangid * p->nIndex + iIndex) * FTS3_SEGDIR_MAXLEVEL;
  144067. return iBase + iLevel;
  144068. }
  144069. /*
  144070. ** Set *ppStmt to a statement handle that may be used to iterate through
  144071. ** all rows in the %_segdir table, from oldest to newest. If successful,
  144072. ** return SQLITE_OK. If an error occurs while preparing the statement,
  144073. ** return an SQLite error code.
  144074. **
  144075. ** There is only ever one instance of this SQL statement compiled for
  144076. ** each FTS3 table.
  144077. **
  144078. ** The statement returns the following columns from the %_segdir table:
  144079. **
  144080. ** 0: idx
  144081. ** 1: start_block
  144082. ** 2: leaves_end_block
  144083. ** 3: end_block
  144084. ** 4: root
  144085. */
  144086. SQLITE_PRIVATE int sqlite3Fts3AllSegdirs(
  144087. Fts3Table *p, /* FTS3 table */
  144088. int iLangid, /* Language being queried */
  144089. int iIndex, /* Index for p->aIndex[] */
  144090. int iLevel, /* Level to select (relative level) */
  144091. sqlite3_stmt **ppStmt /* OUT: Compiled statement */
  144092. ){
  144093. int rc;
  144094. sqlite3_stmt *pStmt = 0;
  144095. assert( iLevel==FTS3_SEGCURSOR_ALL || iLevel>=0 );
  144096. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  144097. assert( iIndex>=0 && iIndex<p->nIndex );
  144098. if( iLevel<0 ){
  144099. /* "SELECT * FROM %_segdir WHERE level BETWEEN ? AND ? ORDER BY ..." */
  144100. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL_RANGE, &pStmt, 0);
  144101. if( rc==SQLITE_OK ){
  144102. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  144103. sqlite3_bind_int64(pStmt, 2,
  144104. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  144105. );
  144106. }
  144107. }else{
  144108. /* "SELECT * FROM %_segdir WHERE level = ? ORDER BY ..." */
  144109. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL, &pStmt, 0);
  144110. if( rc==SQLITE_OK ){
  144111. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex,iLevel));
  144112. }
  144113. }
  144114. *ppStmt = pStmt;
  144115. return rc;
  144116. }
  144117. /*
  144118. ** Append a single varint to a PendingList buffer. SQLITE_OK is returned
  144119. ** if successful, or an SQLite error code otherwise.
  144120. **
  144121. ** This function also serves to allocate the PendingList structure itself.
  144122. ** For example, to create a new PendingList structure containing two
  144123. ** varints:
  144124. **
  144125. ** PendingList *p = 0;
  144126. ** fts3PendingListAppendVarint(&p, 1);
  144127. ** fts3PendingListAppendVarint(&p, 2);
  144128. */
  144129. static int fts3PendingListAppendVarint(
  144130. PendingList **pp, /* IN/OUT: Pointer to PendingList struct */
  144131. sqlite3_int64 i /* Value to append to data */
  144132. ){
  144133. PendingList *p = *pp;
  144134. /* Allocate or grow the PendingList as required. */
  144135. if( !p ){
  144136. p = sqlite3_malloc(sizeof(*p) + 100);
  144137. if( !p ){
  144138. return SQLITE_NOMEM;
  144139. }
  144140. p->nSpace = 100;
  144141. p->aData = (char *)&p[1];
  144142. p->nData = 0;
  144143. }
  144144. else if( p->nData+FTS3_VARINT_MAX+1>p->nSpace ){
  144145. int nNew = p->nSpace * 2;
  144146. p = sqlite3_realloc(p, sizeof(*p) + nNew);
  144147. if( !p ){
  144148. sqlite3_free(*pp);
  144149. *pp = 0;
  144150. return SQLITE_NOMEM;
  144151. }
  144152. p->nSpace = nNew;
  144153. p->aData = (char *)&p[1];
  144154. }
  144155. /* Append the new serialized varint to the end of the list. */
  144156. p->nData += sqlite3Fts3PutVarint(&p->aData[p->nData], i);
  144157. p->aData[p->nData] = '\0';
  144158. *pp = p;
  144159. return SQLITE_OK;
  144160. }
  144161. /*
  144162. ** Add a docid/column/position entry to a PendingList structure. Non-zero
  144163. ** is returned if the structure is sqlite3_realloced as part of adding
  144164. ** the entry. Otherwise, zero.
  144165. **
  144166. ** If an OOM error occurs, *pRc is set to SQLITE_NOMEM before returning.
  144167. ** Zero is always returned in this case. Otherwise, if no OOM error occurs,
  144168. ** it is set to SQLITE_OK.
  144169. */
  144170. static int fts3PendingListAppend(
  144171. PendingList **pp, /* IN/OUT: PendingList structure */
  144172. sqlite3_int64 iDocid, /* Docid for entry to add */
  144173. sqlite3_int64 iCol, /* Column for entry to add */
  144174. sqlite3_int64 iPos, /* Position of term for entry to add */
  144175. int *pRc /* OUT: Return code */
  144176. ){
  144177. PendingList *p = *pp;
  144178. int rc = SQLITE_OK;
  144179. assert( !p || p->iLastDocid<=iDocid );
  144180. if( !p || p->iLastDocid!=iDocid ){
  144181. sqlite3_int64 iDelta = iDocid - (p ? p->iLastDocid : 0);
  144182. if( p ){
  144183. assert( p->nData<p->nSpace );
  144184. assert( p->aData[p->nData]==0 );
  144185. p->nData++;
  144186. }
  144187. if( SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, iDelta)) ){
  144188. goto pendinglistappend_out;
  144189. }
  144190. p->iLastCol = -1;
  144191. p->iLastPos = 0;
  144192. p->iLastDocid = iDocid;
  144193. }
  144194. if( iCol>0 && p->iLastCol!=iCol ){
  144195. if( SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, 1))
  144196. || SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, iCol))
  144197. ){
  144198. goto pendinglistappend_out;
  144199. }
  144200. p->iLastCol = iCol;
  144201. p->iLastPos = 0;
  144202. }
  144203. if( iCol>=0 ){
  144204. assert( iPos>p->iLastPos || (iPos==0 && p->iLastPos==0) );
  144205. rc = fts3PendingListAppendVarint(&p, 2+iPos-p->iLastPos);
  144206. if( rc==SQLITE_OK ){
  144207. p->iLastPos = iPos;
  144208. }
  144209. }
  144210. pendinglistappend_out:
  144211. *pRc = rc;
  144212. if( p!=*pp ){
  144213. *pp = p;
  144214. return 1;
  144215. }
  144216. return 0;
  144217. }
  144218. /*
  144219. ** Free a PendingList object allocated by fts3PendingListAppend().
  144220. */
  144221. static void fts3PendingListDelete(PendingList *pList){
  144222. sqlite3_free(pList);
  144223. }
  144224. /*
  144225. ** Add an entry to one of the pending-terms hash tables.
  144226. */
  144227. static int fts3PendingTermsAddOne(
  144228. Fts3Table *p,
  144229. int iCol,
  144230. int iPos,
  144231. Fts3Hash *pHash, /* Pending terms hash table to add entry to */
  144232. const char *zToken,
  144233. int nToken
  144234. ){
  144235. PendingList *pList;
  144236. int rc = SQLITE_OK;
  144237. pList = (PendingList *)fts3HashFind(pHash, zToken, nToken);
  144238. if( pList ){
  144239. p->nPendingData -= (pList->nData + nToken + sizeof(Fts3HashElem));
  144240. }
  144241. if( fts3PendingListAppend(&pList, p->iPrevDocid, iCol, iPos, &rc) ){
  144242. if( pList==fts3HashInsert(pHash, zToken, nToken, pList) ){
  144243. /* Malloc failed while inserting the new entry. This can only
  144244. ** happen if there was no previous entry for this token.
  144245. */
  144246. assert( 0==fts3HashFind(pHash, zToken, nToken) );
  144247. sqlite3_free(pList);
  144248. rc = SQLITE_NOMEM;
  144249. }
  144250. }
  144251. if( rc==SQLITE_OK ){
  144252. p->nPendingData += (pList->nData + nToken + sizeof(Fts3HashElem));
  144253. }
  144254. return rc;
  144255. }
  144256. /*
  144257. ** Tokenize the nul-terminated string zText and add all tokens to the
  144258. ** pending-terms hash-table. The docid used is that currently stored in
  144259. ** p->iPrevDocid, and the column is specified by argument iCol.
  144260. **
  144261. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  144262. */
  144263. static int fts3PendingTermsAdd(
  144264. Fts3Table *p, /* Table into which text will be inserted */
  144265. int iLangid, /* Language id to use */
  144266. const char *zText, /* Text of document to be inserted */
  144267. int iCol, /* Column into which text is being inserted */
  144268. u32 *pnWord /* IN/OUT: Incr. by number tokens inserted */
  144269. ){
  144270. int rc;
  144271. int iStart = 0;
  144272. int iEnd = 0;
  144273. int iPos = 0;
  144274. int nWord = 0;
  144275. char const *zToken;
  144276. int nToken = 0;
  144277. sqlite3_tokenizer *pTokenizer = p->pTokenizer;
  144278. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  144279. sqlite3_tokenizer_cursor *pCsr;
  144280. int (*xNext)(sqlite3_tokenizer_cursor *pCursor,
  144281. const char**,int*,int*,int*,int*);
  144282. assert( pTokenizer && pModule );
  144283. /* If the user has inserted a NULL value, this function may be called with
  144284. ** zText==0. In this case, add zero token entries to the hash table and
  144285. ** return early. */
  144286. if( zText==0 ){
  144287. *pnWord = 0;
  144288. return SQLITE_OK;
  144289. }
  144290. rc = sqlite3Fts3OpenTokenizer(pTokenizer, iLangid, zText, -1, &pCsr);
  144291. if( rc!=SQLITE_OK ){
  144292. return rc;
  144293. }
  144294. xNext = pModule->xNext;
  144295. while( SQLITE_OK==rc
  144296. && SQLITE_OK==(rc = xNext(pCsr, &zToken, &nToken, &iStart, &iEnd, &iPos))
  144297. ){
  144298. int i;
  144299. if( iPos>=nWord ) nWord = iPos+1;
  144300. /* Positions cannot be negative; we use -1 as a terminator internally.
  144301. ** Tokens must have a non-zero length.
  144302. */
  144303. if( iPos<0 || !zToken || nToken<=0 ){
  144304. rc = SQLITE_ERROR;
  144305. break;
  144306. }
  144307. /* Add the term to the terms index */
  144308. rc = fts3PendingTermsAddOne(
  144309. p, iCol, iPos, &p->aIndex[0].hPending, zToken, nToken
  144310. );
  144311. /* Add the term to each of the prefix indexes that it is not too
  144312. ** short for. */
  144313. for(i=1; rc==SQLITE_OK && i<p->nIndex; i++){
  144314. struct Fts3Index *pIndex = &p->aIndex[i];
  144315. if( nToken<pIndex->nPrefix ) continue;
  144316. rc = fts3PendingTermsAddOne(
  144317. p, iCol, iPos, &pIndex->hPending, zToken, pIndex->nPrefix
  144318. );
  144319. }
  144320. }
  144321. pModule->xClose(pCsr);
  144322. *pnWord += nWord;
  144323. return (rc==SQLITE_DONE ? SQLITE_OK : rc);
  144324. }
  144325. /*
  144326. ** Calling this function indicates that subsequent calls to
  144327. ** fts3PendingTermsAdd() are to add term/position-list pairs for the
  144328. ** contents of the document with docid iDocid.
  144329. */
  144330. static int fts3PendingTermsDocid(
  144331. Fts3Table *p, /* Full-text table handle */
  144332. int bDelete, /* True if this op is a delete */
  144333. int iLangid, /* Language id of row being written */
  144334. sqlite_int64 iDocid /* Docid of row being written */
  144335. ){
  144336. assert( iLangid>=0 );
  144337. assert( bDelete==1 || bDelete==0 );
  144338. /* TODO(shess) Explore whether partially flushing the buffer on
  144339. ** forced-flush would provide better performance. I suspect that if
  144340. ** we ordered the doclists by size and flushed the largest until the
  144341. ** buffer was half empty, that would let the less frequent terms
  144342. ** generate longer doclists.
  144343. */
  144344. if( iDocid<p->iPrevDocid
  144345. || (iDocid==p->iPrevDocid && p->bPrevDelete==0)
  144346. || p->iPrevLangid!=iLangid
  144347. || p->nPendingData>p->nMaxPendingData
  144348. ){
  144349. int rc = sqlite3Fts3PendingTermsFlush(p);
  144350. if( rc!=SQLITE_OK ) return rc;
  144351. }
  144352. p->iPrevDocid = iDocid;
  144353. p->iPrevLangid = iLangid;
  144354. p->bPrevDelete = bDelete;
  144355. return SQLITE_OK;
  144356. }
  144357. /*
  144358. ** Discard the contents of the pending-terms hash tables.
  144359. */
  144360. SQLITE_PRIVATE void sqlite3Fts3PendingTermsClear(Fts3Table *p){
  144361. int i;
  144362. for(i=0; i<p->nIndex; i++){
  144363. Fts3HashElem *pElem;
  144364. Fts3Hash *pHash = &p->aIndex[i].hPending;
  144365. for(pElem=fts3HashFirst(pHash); pElem; pElem=fts3HashNext(pElem)){
  144366. PendingList *pList = (PendingList *)fts3HashData(pElem);
  144367. fts3PendingListDelete(pList);
  144368. }
  144369. fts3HashClear(pHash);
  144370. }
  144371. p->nPendingData = 0;
  144372. }
  144373. /*
  144374. ** This function is called by the xUpdate() method as part of an INSERT
  144375. ** operation. It adds entries for each term in the new record to the
  144376. ** pendingTerms hash table.
  144377. **
  144378. ** Argument apVal is the same as the similarly named argument passed to
  144379. ** fts3InsertData(). Parameter iDocid is the docid of the new row.
  144380. */
  144381. static int fts3InsertTerms(
  144382. Fts3Table *p,
  144383. int iLangid,
  144384. sqlite3_value **apVal,
  144385. u32 *aSz
  144386. ){
  144387. int i; /* Iterator variable */
  144388. for(i=2; i<p->nColumn+2; i++){
  144389. int iCol = i-2;
  144390. if( p->abNotindexed[iCol]==0 ){
  144391. const char *zText = (const char *)sqlite3_value_text(apVal[i]);
  144392. int rc = fts3PendingTermsAdd(p, iLangid, zText, iCol, &aSz[iCol]);
  144393. if( rc!=SQLITE_OK ){
  144394. return rc;
  144395. }
  144396. aSz[p->nColumn] += sqlite3_value_bytes(apVal[i]);
  144397. }
  144398. }
  144399. return SQLITE_OK;
  144400. }
  144401. /*
  144402. ** This function is called by the xUpdate() method for an INSERT operation.
  144403. ** The apVal parameter is passed a copy of the apVal argument passed by
  144404. ** SQLite to the xUpdate() method. i.e:
  144405. **
  144406. ** apVal[0] Not used for INSERT.
  144407. ** apVal[1] rowid
  144408. ** apVal[2] Left-most user-defined column
  144409. ** ...
  144410. ** apVal[p->nColumn+1] Right-most user-defined column
  144411. ** apVal[p->nColumn+2] Hidden column with same name as table
  144412. ** apVal[p->nColumn+3] Hidden "docid" column (alias for rowid)
  144413. ** apVal[p->nColumn+4] Hidden languageid column
  144414. */
  144415. static int fts3InsertData(
  144416. Fts3Table *p, /* Full-text table */
  144417. sqlite3_value **apVal, /* Array of values to insert */
  144418. sqlite3_int64 *piDocid /* OUT: Docid for row just inserted */
  144419. ){
  144420. int rc; /* Return code */
  144421. sqlite3_stmt *pContentInsert; /* INSERT INTO %_content VALUES(...) */
  144422. if( p->zContentTbl ){
  144423. sqlite3_value *pRowid = apVal[p->nColumn+3];
  144424. if( sqlite3_value_type(pRowid)==SQLITE_NULL ){
  144425. pRowid = apVal[1];
  144426. }
  144427. if( sqlite3_value_type(pRowid)!=SQLITE_INTEGER ){
  144428. return SQLITE_CONSTRAINT;
  144429. }
  144430. *piDocid = sqlite3_value_int64(pRowid);
  144431. return SQLITE_OK;
  144432. }
  144433. /* Locate the statement handle used to insert data into the %_content
  144434. ** table. The SQL for this statement is:
  144435. **
  144436. ** INSERT INTO %_content VALUES(?, ?, ?, ...)
  144437. **
  144438. ** The statement features N '?' variables, where N is the number of user
  144439. ** defined columns in the FTS3 table, plus one for the docid field.
  144440. */
  144441. rc = fts3SqlStmt(p, SQL_CONTENT_INSERT, &pContentInsert, &apVal[1]);
  144442. if( rc==SQLITE_OK && p->zLanguageid ){
  144443. rc = sqlite3_bind_int(
  144444. pContentInsert, p->nColumn+2,
  144445. sqlite3_value_int(apVal[p->nColumn+4])
  144446. );
  144447. }
  144448. if( rc!=SQLITE_OK ) return rc;
  144449. /* There is a quirk here. The users INSERT statement may have specified
  144450. ** a value for the "rowid" field, for the "docid" field, or for both.
  144451. ** Which is a problem, since "rowid" and "docid" are aliases for the
  144452. ** same value. For example:
  144453. **
  144454. ** INSERT INTO fts3tbl(rowid, docid) VALUES(1, 2);
  144455. **
  144456. ** In FTS3, this is an error. It is an error to specify non-NULL values
  144457. ** for both docid and some other rowid alias.
  144458. */
  144459. if( SQLITE_NULL!=sqlite3_value_type(apVal[3+p->nColumn]) ){
  144460. if( SQLITE_NULL==sqlite3_value_type(apVal[0])
  144461. && SQLITE_NULL!=sqlite3_value_type(apVal[1])
  144462. ){
  144463. /* A rowid/docid conflict. */
  144464. return SQLITE_ERROR;
  144465. }
  144466. rc = sqlite3_bind_value(pContentInsert, 1, apVal[3+p->nColumn]);
  144467. if( rc!=SQLITE_OK ) return rc;
  144468. }
  144469. /* Execute the statement to insert the record. Set *piDocid to the
  144470. ** new docid value.
  144471. */
  144472. sqlite3_step(pContentInsert);
  144473. rc = sqlite3_reset(pContentInsert);
  144474. *piDocid = sqlite3_last_insert_rowid(p->db);
  144475. return rc;
  144476. }
  144477. /*
  144478. ** Remove all data from the FTS3 table. Clear the hash table containing
  144479. ** pending terms.
  144480. */
  144481. static int fts3DeleteAll(Fts3Table *p, int bContent){
  144482. int rc = SQLITE_OK; /* Return code */
  144483. /* Discard the contents of the pending-terms hash table. */
  144484. sqlite3Fts3PendingTermsClear(p);
  144485. /* Delete everything from the shadow tables. Except, leave %_content as
  144486. ** is if bContent is false. */
  144487. assert( p->zContentTbl==0 || bContent==0 );
  144488. if( bContent ) fts3SqlExec(&rc, p, SQL_DELETE_ALL_CONTENT, 0);
  144489. fts3SqlExec(&rc, p, SQL_DELETE_ALL_SEGMENTS, 0);
  144490. fts3SqlExec(&rc, p, SQL_DELETE_ALL_SEGDIR, 0);
  144491. if( p->bHasDocsize ){
  144492. fts3SqlExec(&rc, p, SQL_DELETE_ALL_DOCSIZE, 0);
  144493. }
  144494. if( p->bHasStat ){
  144495. fts3SqlExec(&rc, p, SQL_DELETE_ALL_STAT, 0);
  144496. }
  144497. return rc;
  144498. }
  144499. /*
  144500. **
  144501. */
  144502. static int langidFromSelect(Fts3Table *p, sqlite3_stmt *pSelect){
  144503. int iLangid = 0;
  144504. if( p->zLanguageid ) iLangid = sqlite3_column_int(pSelect, p->nColumn+1);
  144505. return iLangid;
  144506. }
  144507. /*
  144508. ** The first element in the apVal[] array is assumed to contain the docid
  144509. ** (an integer) of a row about to be deleted. Remove all terms from the
  144510. ** full-text index.
  144511. */
  144512. static void fts3DeleteTerms(
  144513. int *pRC, /* Result code */
  144514. Fts3Table *p, /* The FTS table to delete from */
  144515. sqlite3_value *pRowid, /* The docid to be deleted */
  144516. u32 *aSz, /* Sizes of deleted document written here */
  144517. int *pbFound /* OUT: Set to true if row really does exist */
  144518. ){
  144519. int rc;
  144520. sqlite3_stmt *pSelect;
  144521. assert( *pbFound==0 );
  144522. if( *pRC ) return;
  144523. rc = fts3SqlStmt(p, SQL_SELECT_CONTENT_BY_ROWID, &pSelect, &pRowid);
  144524. if( rc==SQLITE_OK ){
  144525. if( SQLITE_ROW==sqlite3_step(pSelect) ){
  144526. int i;
  144527. int iLangid = langidFromSelect(p, pSelect);
  144528. i64 iDocid = sqlite3_column_int64(pSelect, 0);
  144529. rc = fts3PendingTermsDocid(p, 1, iLangid, iDocid);
  144530. for(i=1; rc==SQLITE_OK && i<=p->nColumn; i++){
  144531. int iCol = i-1;
  144532. if( p->abNotindexed[iCol]==0 ){
  144533. const char *zText = (const char *)sqlite3_column_text(pSelect, i);
  144534. rc = fts3PendingTermsAdd(p, iLangid, zText, -1, &aSz[iCol]);
  144535. aSz[p->nColumn] += sqlite3_column_bytes(pSelect, i);
  144536. }
  144537. }
  144538. if( rc!=SQLITE_OK ){
  144539. sqlite3_reset(pSelect);
  144540. *pRC = rc;
  144541. return;
  144542. }
  144543. *pbFound = 1;
  144544. }
  144545. rc = sqlite3_reset(pSelect);
  144546. }else{
  144547. sqlite3_reset(pSelect);
  144548. }
  144549. *pRC = rc;
  144550. }
  144551. /*
  144552. ** Forward declaration to account for the circular dependency between
  144553. ** functions fts3SegmentMerge() and fts3AllocateSegdirIdx().
  144554. */
  144555. static int fts3SegmentMerge(Fts3Table *, int, int, int);
  144556. /*
  144557. ** This function allocates a new level iLevel index in the segdir table.
  144558. ** Usually, indexes are allocated within a level sequentially starting
  144559. ** with 0, so the allocated index is one greater than the value returned
  144560. ** by:
  144561. **
  144562. ** SELECT max(idx) FROM %_segdir WHERE level = :iLevel
  144563. **
  144564. ** However, if there are already FTS3_MERGE_COUNT indexes at the requested
  144565. ** level, they are merged into a single level (iLevel+1) segment and the
  144566. ** allocated index is 0.
  144567. **
  144568. ** If successful, *piIdx is set to the allocated index slot and SQLITE_OK
  144569. ** returned. Otherwise, an SQLite error code is returned.
  144570. */
  144571. static int fts3AllocateSegdirIdx(
  144572. Fts3Table *p,
  144573. int iLangid, /* Language id */
  144574. int iIndex, /* Index for p->aIndex */
  144575. int iLevel,
  144576. int *piIdx
  144577. ){
  144578. int rc; /* Return Code */
  144579. sqlite3_stmt *pNextIdx; /* Query for next idx at level iLevel */
  144580. int iNext = 0; /* Result of query pNextIdx */
  144581. assert( iLangid>=0 );
  144582. assert( p->nIndex>=1 );
  144583. /* Set variable iNext to the next available segdir index at level iLevel. */
  144584. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENT_INDEX, &pNextIdx, 0);
  144585. if( rc==SQLITE_OK ){
  144586. sqlite3_bind_int64(
  144587. pNextIdx, 1, getAbsoluteLevel(p, iLangid, iIndex, iLevel)
  144588. );
  144589. if( SQLITE_ROW==sqlite3_step(pNextIdx) ){
  144590. iNext = sqlite3_column_int(pNextIdx, 0);
  144591. }
  144592. rc = sqlite3_reset(pNextIdx);
  144593. }
  144594. if( rc==SQLITE_OK ){
  144595. /* If iNext is FTS3_MERGE_COUNT, indicating that level iLevel is already
  144596. ** full, merge all segments in level iLevel into a single iLevel+1
  144597. ** segment and allocate (newly freed) index 0 at level iLevel. Otherwise,
  144598. ** if iNext is less than FTS3_MERGE_COUNT, allocate index iNext.
  144599. */
  144600. if( iNext>=FTS3_MERGE_COUNT ){
  144601. fts3LogMerge(16, getAbsoluteLevel(p, iLangid, iIndex, iLevel));
  144602. rc = fts3SegmentMerge(p, iLangid, iIndex, iLevel);
  144603. *piIdx = 0;
  144604. }else{
  144605. *piIdx = iNext;
  144606. }
  144607. }
  144608. return rc;
  144609. }
  144610. /*
  144611. ** The %_segments table is declared as follows:
  144612. **
  144613. ** CREATE TABLE %_segments(blockid INTEGER PRIMARY KEY, block BLOB)
  144614. **
  144615. ** This function reads data from a single row of the %_segments table. The
  144616. ** specific row is identified by the iBlockid parameter. If paBlob is not
  144617. ** NULL, then a buffer is allocated using sqlite3_malloc() and populated
  144618. ** with the contents of the blob stored in the "block" column of the
  144619. ** identified table row is. Whether or not paBlob is NULL, *pnBlob is set
  144620. ** to the size of the blob in bytes before returning.
  144621. **
  144622. ** If an error occurs, or the table does not contain the specified row,
  144623. ** an SQLite error code is returned. Otherwise, SQLITE_OK is returned. If
  144624. ** paBlob is non-NULL, then it is the responsibility of the caller to
  144625. ** eventually free the returned buffer.
  144626. **
  144627. ** This function may leave an open sqlite3_blob* handle in the
  144628. ** Fts3Table.pSegments variable. This handle is reused by subsequent calls
  144629. ** to this function. The handle may be closed by calling the
  144630. ** sqlite3Fts3SegmentsClose() function. Reusing a blob handle is a handy
  144631. ** performance improvement, but the blob handle should always be closed
  144632. ** before control is returned to the user (to prevent a lock being held
  144633. ** on the database file for longer than necessary). Thus, any virtual table
  144634. ** method (xFilter etc.) that may directly or indirectly call this function
  144635. ** must call sqlite3Fts3SegmentsClose() before returning.
  144636. */
  144637. SQLITE_PRIVATE int sqlite3Fts3ReadBlock(
  144638. Fts3Table *p, /* FTS3 table handle */
  144639. sqlite3_int64 iBlockid, /* Access the row with blockid=$iBlockid */
  144640. char **paBlob, /* OUT: Blob data in malloc'd buffer */
  144641. int *pnBlob, /* OUT: Size of blob data */
  144642. int *pnLoad /* OUT: Bytes actually loaded */
  144643. ){
  144644. int rc; /* Return code */
  144645. /* pnBlob must be non-NULL. paBlob may be NULL or non-NULL. */
  144646. assert( pnBlob );
  144647. if( p->pSegments ){
  144648. rc = sqlite3_blob_reopen(p->pSegments, iBlockid);
  144649. }else{
  144650. if( 0==p->zSegmentsTbl ){
  144651. p->zSegmentsTbl = sqlite3_mprintf("%s_segments", p->zName);
  144652. if( 0==p->zSegmentsTbl ) return SQLITE_NOMEM;
  144653. }
  144654. rc = sqlite3_blob_open(
  144655. p->db, p->zDb, p->zSegmentsTbl, "block", iBlockid, 0, &p->pSegments
  144656. );
  144657. }
  144658. if( rc==SQLITE_OK ){
  144659. int nByte = sqlite3_blob_bytes(p->pSegments);
  144660. *pnBlob = nByte;
  144661. if( paBlob ){
  144662. char *aByte = sqlite3_malloc(nByte + FTS3_NODE_PADDING);
  144663. if( !aByte ){
  144664. rc = SQLITE_NOMEM;
  144665. }else{
  144666. if( pnLoad && nByte>(FTS3_NODE_CHUNK_THRESHOLD) ){
  144667. nByte = FTS3_NODE_CHUNKSIZE;
  144668. *pnLoad = nByte;
  144669. }
  144670. rc = sqlite3_blob_read(p->pSegments, aByte, nByte, 0);
  144671. memset(&aByte[nByte], 0, FTS3_NODE_PADDING);
  144672. if( rc!=SQLITE_OK ){
  144673. sqlite3_free(aByte);
  144674. aByte = 0;
  144675. }
  144676. }
  144677. *paBlob = aByte;
  144678. }
  144679. }
  144680. return rc;
  144681. }
  144682. /*
  144683. ** Close the blob handle at p->pSegments, if it is open. See comments above
  144684. ** the sqlite3Fts3ReadBlock() function for details.
  144685. */
  144686. SQLITE_PRIVATE void sqlite3Fts3SegmentsClose(Fts3Table *p){
  144687. sqlite3_blob_close(p->pSegments);
  144688. p->pSegments = 0;
  144689. }
  144690. static int fts3SegReaderIncrRead(Fts3SegReader *pReader){
  144691. int nRead; /* Number of bytes to read */
  144692. int rc; /* Return code */
  144693. nRead = MIN(pReader->nNode - pReader->nPopulate, FTS3_NODE_CHUNKSIZE);
  144694. rc = sqlite3_blob_read(
  144695. pReader->pBlob,
  144696. &pReader->aNode[pReader->nPopulate],
  144697. nRead,
  144698. pReader->nPopulate
  144699. );
  144700. if( rc==SQLITE_OK ){
  144701. pReader->nPopulate += nRead;
  144702. memset(&pReader->aNode[pReader->nPopulate], 0, FTS3_NODE_PADDING);
  144703. if( pReader->nPopulate==pReader->nNode ){
  144704. sqlite3_blob_close(pReader->pBlob);
  144705. pReader->pBlob = 0;
  144706. pReader->nPopulate = 0;
  144707. }
  144708. }
  144709. return rc;
  144710. }
  144711. static int fts3SegReaderRequire(Fts3SegReader *pReader, char *pFrom, int nByte){
  144712. int rc = SQLITE_OK;
  144713. assert( !pReader->pBlob
  144714. || (pFrom>=pReader->aNode && pFrom<&pReader->aNode[pReader->nNode])
  144715. );
  144716. while( pReader->pBlob && rc==SQLITE_OK
  144717. && (pFrom - pReader->aNode + nByte)>pReader->nPopulate
  144718. ){
  144719. rc = fts3SegReaderIncrRead(pReader);
  144720. }
  144721. return rc;
  144722. }
  144723. /*
  144724. ** Set an Fts3SegReader cursor to point at EOF.
  144725. */
  144726. static void fts3SegReaderSetEof(Fts3SegReader *pSeg){
  144727. if( !fts3SegReaderIsRootOnly(pSeg) ){
  144728. sqlite3_free(pSeg->aNode);
  144729. sqlite3_blob_close(pSeg->pBlob);
  144730. pSeg->pBlob = 0;
  144731. }
  144732. pSeg->aNode = 0;
  144733. }
  144734. /*
  144735. ** Move the iterator passed as the first argument to the next term in the
  144736. ** segment. If successful, SQLITE_OK is returned. If there is no next term,
  144737. ** SQLITE_DONE. Otherwise, an SQLite error code.
  144738. */
  144739. static int fts3SegReaderNext(
  144740. Fts3Table *p,
  144741. Fts3SegReader *pReader,
  144742. int bIncr
  144743. ){
  144744. int rc; /* Return code of various sub-routines */
  144745. char *pNext; /* Cursor variable */
  144746. int nPrefix; /* Number of bytes in term prefix */
  144747. int nSuffix; /* Number of bytes in term suffix */
  144748. if( !pReader->aDoclist ){
  144749. pNext = pReader->aNode;
  144750. }else{
  144751. pNext = &pReader->aDoclist[pReader->nDoclist];
  144752. }
  144753. if( !pNext || pNext>=&pReader->aNode[pReader->nNode] ){
  144754. if( fts3SegReaderIsPending(pReader) ){
  144755. Fts3HashElem *pElem = *(pReader->ppNextElem);
  144756. sqlite3_free(pReader->aNode);
  144757. pReader->aNode = 0;
  144758. if( pElem ){
  144759. char *aCopy;
  144760. PendingList *pList = (PendingList *)fts3HashData(pElem);
  144761. int nCopy = pList->nData+1;
  144762. pReader->zTerm = (char *)fts3HashKey(pElem);
  144763. pReader->nTerm = fts3HashKeysize(pElem);
  144764. aCopy = (char*)sqlite3_malloc(nCopy);
  144765. if( !aCopy ) return SQLITE_NOMEM;
  144766. memcpy(aCopy, pList->aData, nCopy);
  144767. pReader->nNode = pReader->nDoclist = nCopy;
  144768. pReader->aNode = pReader->aDoclist = aCopy;
  144769. pReader->ppNextElem++;
  144770. assert( pReader->aNode );
  144771. }
  144772. return SQLITE_OK;
  144773. }
  144774. fts3SegReaderSetEof(pReader);
  144775. /* If iCurrentBlock>=iLeafEndBlock, this is an EOF condition. All leaf
  144776. ** blocks have already been traversed. */
  144777. assert( pReader->iCurrentBlock<=pReader->iLeafEndBlock );
  144778. if( pReader->iCurrentBlock>=pReader->iLeafEndBlock ){
  144779. return SQLITE_OK;
  144780. }
  144781. rc = sqlite3Fts3ReadBlock(
  144782. p, ++pReader->iCurrentBlock, &pReader->aNode, &pReader->nNode,
  144783. (bIncr ? &pReader->nPopulate : 0)
  144784. );
  144785. if( rc!=SQLITE_OK ) return rc;
  144786. assert( pReader->pBlob==0 );
  144787. if( bIncr && pReader->nPopulate<pReader->nNode ){
  144788. pReader->pBlob = p->pSegments;
  144789. p->pSegments = 0;
  144790. }
  144791. pNext = pReader->aNode;
  144792. }
  144793. assert( !fts3SegReaderIsPending(pReader) );
  144794. rc = fts3SegReaderRequire(pReader, pNext, FTS3_VARINT_MAX*2);
  144795. if( rc!=SQLITE_OK ) return rc;
  144796. /* Because of the FTS3_NODE_PADDING bytes of padding, the following is
  144797. ** safe (no risk of overread) even if the node data is corrupted. */
  144798. pNext += fts3GetVarint32(pNext, &nPrefix);
  144799. pNext += fts3GetVarint32(pNext, &nSuffix);
  144800. if( nPrefix<0 || nSuffix<=0
  144801. || &pNext[nSuffix]>&pReader->aNode[pReader->nNode]
  144802. ){
  144803. return FTS_CORRUPT_VTAB;
  144804. }
  144805. if( nPrefix+nSuffix>pReader->nTermAlloc ){
  144806. int nNew = (nPrefix+nSuffix)*2;
  144807. char *zNew = sqlite3_realloc(pReader->zTerm, nNew);
  144808. if( !zNew ){
  144809. return SQLITE_NOMEM;
  144810. }
  144811. pReader->zTerm = zNew;
  144812. pReader->nTermAlloc = nNew;
  144813. }
  144814. rc = fts3SegReaderRequire(pReader, pNext, nSuffix+FTS3_VARINT_MAX);
  144815. if( rc!=SQLITE_OK ) return rc;
  144816. memcpy(&pReader->zTerm[nPrefix], pNext, nSuffix);
  144817. pReader->nTerm = nPrefix+nSuffix;
  144818. pNext += nSuffix;
  144819. pNext += fts3GetVarint32(pNext, &pReader->nDoclist);
  144820. pReader->aDoclist = pNext;
  144821. pReader->pOffsetList = 0;
  144822. /* Check that the doclist does not appear to extend past the end of the
  144823. ** b-tree node. And that the final byte of the doclist is 0x00. If either
  144824. ** of these statements is untrue, then the data structure is corrupt.
  144825. */
  144826. if( &pReader->aDoclist[pReader->nDoclist]>&pReader->aNode[pReader->nNode]
  144827. || (pReader->nPopulate==0 && pReader->aDoclist[pReader->nDoclist-1])
  144828. ){
  144829. return FTS_CORRUPT_VTAB;
  144830. }
  144831. return SQLITE_OK;
  144832. }
  144833. /*
  144834. ** Set the SegReader to point to the first docid in the doclist associated
  144835. ** with the current term.
  144836. */
  144837. static int fts3SegReaderFirstDocid(Fts3Table *pTab, Fts3SegReader *pReader){
  144838. int rc = SQLITE_OK;
  144839. assert( pReader->aDoclist );
  144840. assert( !pReader->pOffsetList );
  144841. if( pTab->bDescIdx && fts3SegReaderIsPending(pReader) ){
  144842. u8 bEof = 0;
  144843. pReader->iDocid = 0;
  144844. pReader->nOffsetList = 0;
  144845. sqlite3Fts3DoclistPrev(0,
  144846. pReader->aDoclist, pReader->nDoclist, &pReader->pOffsetList,
  144847. &pReader->iDocid, &pReader->nOffsetList, &bEof
  144848. );
  144849. }else{
  144850. rc = fts3SegReaderRequire(pReader, pReader->aDoclist, FTS3_VARINT_MAX);
  144851. if( rc==SQLITE_OK ){
  144852. int n = sqlite3Fts3GetVarint(pReader->aDoclist, &pReader->iDocid);
  144853. pReader->pOffsetList = &pReader->aDoclist[n];
  144854. }
  144855. }
  144856. return rc;
  144857. }
  144858. /*
  144859. ** Advance the SegReader to point to the next docid in the doclist
  144860. ** associated with the current term.
  144861. **
  144862. ** If arguments ppOffsetList and pnOffsetList are not NULL, then
  144863. ** *ppOffsetList is set to point to the first column-offset list
  144864. ** in the doclist entry (i.e. immediately past the docid varint).
  144865. ** *pnOffsetList is set to the length of the set of column-offset
  144866. ** lists, not including the nul-terminator byte. For example:
  144867. */
  144868. static int fts3SegReaderNextDocid(
  144869. Fts3Table *pTab,
  144870. Fts3SegReader *pReader, /* Reader to advance to next docid */
  144871. char **ppOffsetList, /* OUT: Pointer to current position-list */
  144872. int *pnOffsetList /* OUT: Length of *ppOffsetList in bytes */
  144873. ){
  144874. int rc = SQLITE_OK;
  144875. char *p = pReader->pOffsetList;
  144876. char c = 0;
  144877. assert( p );
  144878. if( pTab->bDescIdx && fts3SegReaderIsPending(pReader) ){
  144879. /* A pending-terms seg-reader for an FTS4 table that uses order=desc.
  144880. ** Pending-terms doclists are always built up in ascending order, so
  144881. ** we have to iterate through them backwards here. */
  144882. u8 bEof = 0;
  144883. if( ppOffsetList ){
  144884. *ppOffsetList = pReader->pOffsetList;
  144885. *pnOffsetList = pReader->nOffsetList - 1;
  144886. }
  144887. sqlite3Fts3DoclistPrev(0,
  144888. pReader->aDoclist, pReader->nDoclist, &p, &pReader->iDocid,
  144889. &pReader->nOffsetList, &bEof
  144890. );
  144891. if( bEof ){
  144892. pReader->pOffsetList = 0;
  144893. }else{
  144894. pReader->pOffsetList = p;
  144895. }
  144896. }else{
  144897. char *pEnd = &pReader->aDoclist[pReader->nDoclist];
  144898. /* Pointer p currently points at the first byte of an offset list. The
  144899. ** following block advances it to point one byte past the end of
  144900. ** the same offset list. */
  144901. while( 1 ){
  144902. /* The following line of code (and the "p++" below the while() loop) is
  144903. ** normally all that is required to move pointer p to the desired
  144904. ** position. The exception is if this node is being loaded from disk
  144905. ** incrementally and pointer "p" now points to the first byte past
  144906. ** the populated part of pReader->aNode[].
  144907. */
  144908. while( *p | c ) c = *p++ & 0x80;
  144909. assert( *p==0 );
  144910. if( pReader->pBlob==0 || p<&pReader->aNode[pReader->nPopulate] ) break;
  144911. rc = fts3SegReaderIncrRead(pReader);
  144912. if( rc!=SQLITE_OK ) return rc;
  144913. }
  144914. p++;
  144915. /* If required, populate the output variables with a pointer to and the
  144916. ** size of the previous offset-list.
  144917. */
  144918. if( ppOffsetList ){
  144919. *ppOffsetList = pReader->pOffsetList;
  144920. *pnOffsetList = (int)(p - pReader->pOffsetList - 1);
  144921. }
  144922. /* List may have been edited in place by fts3EvalNearTrim() */
  144923. while( p<pEnd && *p==0 ) p++;
  144924. /* If there are no more entries in the doclist, set pOffsetList to
  144925. ** NULL. Otherwise, set Fts3SegReader.iDocid to the next docid and
  144926. ** Fts3SegReader.pOffsetList to point to the next offset list before
  144927. ** returning.
  144928. */
  144929. if( p>=pEnd ){
  144930. pReader->pOffsetList = 0;
  144931. }else{
  144932. rc = fts3SegReaderRequire(pReader, p, FTS3_VARINT_MAX);
  144933. if( rc==SQLITE_OK ){
  144934. sqlite3_int64 iDelta;
  144935. pReader->pOffsetList = p + sqlite3Fts3GetVarint(p, &iDelta);
  144936. if( pTab->bDescIdx ){
  144937. pReader->iDocid -= iDelta;
  144938. }else{
  144939. pReader->iDocid += iDelta;
  144940. }
  144941. }
  144942. }
  144943. }
  144944. return SQLITE_OK;
  144945. }
  144946. SQLITE_PRIVATE int sqlite3Fts3MsrOvfl(
  144947. Fts3Cursor *pCsr,
  144948. Fts3MultiSegReader *pMsr,
  144949. int *pnOvfl
  144950. ){
  144951. Fts3Table *p = (Fts3Table*)pCsr->base.pVtab;
  144952. int nOvfl = 0;
  144953. int ii;
  144954. int rc = SQLITE_OK;
  144955. int pgsz = p->nPgsz;
  144956. assert( p->bFts4 );
  144957. assert( pgsz>0 );
  144958. for(ii=0; rc==SQLITE_OK && ii<pMsr->nSegment; ii++){
  144959. Fts3SegReader *pReader = pMsr->apSegment[ii];
  144960. if( !fts3SegReaderIsPending(pReader)
  144961. && !fts3SegReaderIsRootOnly(pReader)
  144962. ){
  144963. sqlite3_int64 jj;
  144964. for(jj=pReader->iStartBlock; jj<=pReader->iLeafEndBlock; jj++){
  144965. int nBlob;
  144966. rc = sqlite3Fts3ReadBlock(p, jj, 0, &nBlob, 0);
  144967. if( rc!=SQLITE_OK ) break;
  144968. if( (nBlob+35)>pgsz ){
  144969. nOvfl += (nBlob + 34)/pgsz;
  144970. }
  144971. }
  144972. }
  144973. }
  144974. *pnOvfl = nOvfl;
  144975. return rc;
  144976. }
  144977. /*
  144978. ** Free all allocations associated with the iterator passed as the
  144979. ** second argument.
  144980. */
  144981. SQLITE_PRIVATE void sqlite3Fts3SegReaderFree(Fts3SegReader *pReader){
  144982. if( pReader ){
  144983. if( !fts3SegReaderIsPending(pReader) ){
  144984. sqlite3_free(pReader->zTerm);
  144985. }
  144986. if( !fts3SegReaderIsRootOnly(pReader) ){
  144987. sqlite3_free(pReader->aNode);
  144988. }
  144989. sqlite3_blob_close(pReader->pBlob);
  144990. }
  144991. sqlite3_free(pReader);
  144992. }
  144993. /*
  144994. ** Allocate a new SegReader object.
  144995. */
  144996. SQLITE_PRIVATE int sqlite3Fts3SegReaderNew(
  144997. int iAge, /* Segment "age". */
  144998. int bLookup, /* True for a lookup only */
  144999. sqlite3_int64 iStartLeaf, /* First leaf to traverse */
  145000. sqlite3_int64 iEndLeaf, /* Final leaf to traverse */
  145001. sqlite3_int64 iEndBlock, /* Final block of segment */
  145002. const char *zRoot, /* Buffer containing root node */
  145003. int nRoot, /* Size of buffer containing root node */
  145004. Fts3SegReader **ppReader /* OUT: Allocated Fts3SegReader */
  145005. ){
  145006. Fts3SegReader *pReader; /* Newly allocated SegReader object */
  145007. int nExtra = 0; /* Bytes to allocate segment root node */
  145008. assert( iStartLeaf<=iEndLeaf );
  145009. if( iStartLeaf==0 ){
  145010. nExtra = nRoot + FTS3_NODE_PADDING;
  145011. }
  145012. pReader = (Fts3SegReader *)sqlite3_malloc(sizeof(Fts3SegReader) + nExtra);
  145013. if( !pReader ){
  145014. return SQLITE_NOMEM;
  145015. }
  145016. memset(pReader, 0, sizeof(Fts3SegReader));
  145017. pReader->iIdx = iAge;
  145018. pReader->bLookup = bLookup!=0;
  145019. pReader->iStartBlock = iStartLeaf;
  145020. pReader->iLeafEndBlock = iEndLeaf;
  145021. pReader->iEndBlock = iEndBlock;
  145022. if( nExtra ){
  145023. /* The entire segment is stored in the root node. */
  145024. pReader->aNode = (char *)&pReader[1];
  145025. pReader->rootOnly = 1;
  145026. pReader->nNode = nRoot;
  145027. memcpy(pReader->aNode, zRoot, nRoot);
  145028. memset(&pReader->aNode[nRoot], 0, FTS3_NODE_PADDING);
  145029. }else{
  145030. pReader->iCurrentBlock = iStartLeaf-1;
  145031. }
  145032. *ppReader = pReader;
  145033. return SQLITE_OK;
  145034. }
  145035. /*
  145036. ** This is a comparison function used as a qsort() callback when sorting
  145037. ** an array of pending terms by term. This occurs as part of flushing
  145038. ** the contents of the pending-terms hash table to the database.
  145039. */
  145040. static int SQLITE_CDECL fts3CompareElemByTerm(
  145041. const void *lhs,
  145042. const void *rhs
  145043. ){
  145044. char *z1 = fts3HashKey(*(Fts3HashElem **)lhs);
  145045. char *z2 = fts3HashKey(*(Fts3HashElem **)rhs);
  145046. int n1 = fts3HashKeysize(*(Fts3HashElem **)lhs);
  145047. int n2 = fts3HashKeysize(*(Fts3HashElem **)rhs);
  145048. int n = (n1<n2 ? n1 : n2);
  145049. int c = memcmp(z1, z2, n);
  145050. if( c==0 ){
  145051. c = n1 - n2;
  145052. }
  145053. return c;
  145054. }
  145055. /*
  145056. ** This function is used to allocate an Fts3SegReader that iterates through
  145057. ** a subset of the terms stored in the Fts3Table.pendingTerms array.
  145058. **
  145059. ** If the isPrefixIter parameter is zero, then the returned SegReader iterates
  145060. ** through each term in the pending-terms table. Or, if isPrefixIter is
  145061. ** non-zero, it iterates through each term and its prefixes. For example, if
  145062. ** the pending terms hash table contains the terms "sqlite", "mysql" and
  145063. ** "firebird", then the iterator visits the following 'terms' (in the order
  145064. ** shown):
  145065. **
  145066. ** f fi fir fire fireb firebi firebir firebird
  145067. ** m my mys mysq mysql
  145068. ** s sq sql sqli sqlit sqlite
  145069. **
  145070. ** Whereas if isPrefixIter is zero, the terms visited are:
  145071. **
  145072. ** firebird mysql sqlite
  145073. */
  145074. SQLITE_PRIVATE int sqlite3Fts3SegReaderPending(
  145075. Fts3Table *p, /* Virtual table handle */
  145076. int iIndex, /* Index for p->aIndex */
  145077. const char *zTerm, /* Term to search for */
  145078. int nTerm, /* Size of buffer zTerm */
  145079. int bPrefix, /* True for a prefix iterator */
  145080. Fts3SegReader **ppReader /* OUT: SegReader for pending-terms */
  145081. ){
  145082. Fts3SegReader *pReader = 0; /* Fts3SegReader object to return */
  145083. Fts3HashElem *pE; /* Iterator variable */
  145084. Fts3HashElem **aElem = 0; /* Array of term hash entries to scan */
  145085. int nElem = 0; /* Size of array at aElem */
  145086. int rc = SQLITE_OK; /* Return Code */
  145087. Fts3Hash *pHash;
  145088. pHash = &p->aIndex[iIndex].hPending;
  145089. if( bPrefix ){
  145090. int nAlloc = 0; /* Size of allocated array at aElem */
  145091. for(pE=fts3HashFirst(pHash); pE; pE=fts3HashNext(pE)){
  145092. char *zKey = (char *)fts3HashKey(pE);
  145093. int nKey = fts3HashKeysize(pE);
  145094. if( nTerm==0 || (nKey>=nTerm && 0==memcmp(zKey, zTerm, nTerm)) ){
  145095. if( nElem==nAlloc ){
  145096. Fts3HashElem **aElem2;
  145097. nAlloc += 16;
  145098. aElem2 = (Fts3HashElem **)sqlite3_realloc(
  145099. aElem, nAlloc*sizeof(Fts3HashElem *)
  145100. );
  145101. if( !aElem2 ){
  145102. rc = SQLITE_NOMEM;
  145103. nElem = 0;
  145104. break;
  145105. }
  145106. aElem = aElem2;
  145107. }
  145108. aElem[nElem++] = pE;
  145109. }
  145110. }
  145111. /* If more than one term matches the prefix, sort the Fts3HashElem
  145112. ** objects in term order using qsort(). This uses the same comparison
  145113. ** callback as is used when flushing terms to disk.
  145114. */
  145115. if( nElem>1 ){
  145116. qsort(aElem, nElem, sizeof(Fts3HashElem *), fts3CompareElemByTerm);
  145117. }
  145118. }else{
  145119. /* The query is a simple term lookup that matches at most one term in
  145120. ** the index. All that is required is a straight hash-lookup.
  145121. **
  145122. ** Because the stack address of pE may be accessed via the aElem pointer
  145123. ** below, the "Fts3HashElem *pE" must be declared so that it is valid
  145124. ** within this entire function, not just this "else{...}" block.
  145125. */
  145126. pE = fts3HashFindElem(pHash, zTerm, nTerm);
  145127. if( pE ){
  145128. aElem = &pE;
  145129. nElem = 1;
  145130. }
  145131. }
  145132. if( nElem>0 ){
  145133. int nByte = sizeof(Fts3SegReader) + (nElem+1)*sizeof(Fts3HashElem *);
  145134. pReader = (Fts3SegReader *)sqlite3_malloc(nByte);
  145135. if( !pReader ){
  145136. rc = SQLITE_NOMEM;
  145137. }else{
  145138. memset(pReader, 0, nByte);
  145139. pReader->iIdx = 0x7FFFFFFF;
  145140. pReader->ppNextElem = (Fts3HashElem **)&pReader[1];
  145141. memcpy(pReader->ppNextElem, aElem, nElem*sizeof(Fts3HashElem *));
  145142. }
  145143. }
  145144. if( bPrefix ){
  145145. sqlite3_free(aElem);
  145146. }
  145147. *ppReader = pReader;
  145148. return rc;
  145149. }
  145150. /*
  145151. ** Compare the entries pointed to by two Fts3SegReader structures.
  145152. ** Comparison is as follows:
  145153. **
  145154. ** 1) EOF is greater than not EOF.
  145155. **
  145156. ** 2) The current terms (if any) are compared using memcmp(). If one
  145157. ** term is a prefix of another, the longer term is considered the
  145158. ** larger.
  145159. **
  145160. ** 3) By segment age. An older segment is considered larger.
  145161. */
  145162. static int fts3SegReaderCmp(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  145163. int rc;
  145164. if( pLhs->aNode && pRhs->aNode ){
  145165. int rc2 = pLhs->nTerm - pRhs->nTerm;
  145166. if( rc2<0 ){
  145167. rc = memcmp(pLhs->zTerm, pRhs->zTerm, pLhs->nTerm);
  145168. }else{
  145169. rc = memcmp(pLhs->zTerm, pRhs->zTerm, pRhs->nTerm);
  145170. }
  145171. if( rc==0 ){
  145172. rc = rc2;
  145173. }
  145174. }else{
  145175. rc = (pLhs->aNode==0) - (pRhs->aNode==0);
  145176. }
  145177. if( rc==0 ){
  145178. rc = pRhs->iIdx - pLhs->iIdx;
  145179. }
  145180. assert( rc!=0 );
  145181. return rc;
  145182. }
  145183. /*
  145184. ** A different comparison function for SegReader structures. In this
  145185. ** version, it is assumed that each SegReader points to an entry in
  145186. ** a doclist for identical terms. Comparison is made as follows:
  145187. **
  145188. ** 1) EOF (end of doclist in this case) is greater than not EOF.
  145189. **
  145190. ** 2) By current docid.
  145191. **
  145192. ** 3) By segment age. An older segment is considered larger.
  145193. */
  145194. static int fts3SegReaderDoclistCmp(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  145195. int rc = (pLhs->pOffsetList==0)-(pRhs->pOffsetList==0);
  145196. if( rc==0 ){
  145197. if( pLhs->iDocid==pRhs->iDocid ){
  145198. rc = pRhs->iIdx - pLhs->iIdx;
  145199. }else{
  145200. rc = (pLhs->iDocid > pRhs->iDocid) ? 1 : -1;
  145201. }
  145202. }
  145203. assert( pLhs->aNode && pRhs->aNode );
  145204. return rc;
  145205. }
  145206. static int fts3SegReaderDoclistCmpRev(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  145207. int rc = (pLhs->pOffsetList==0)-(pRhs->pOffsetList==0);
  145208. if( rc==0 ){
  145209. if( pLhs->iDocid==pRhs->iDocid ){
  145210. rc = pRhs->iIdx - pLhs->iIdx;
  145211. }else{
  145212. rc = (pLhs->iDocid < pRhs->iDocid) ? 1 : -1;
  145213. }
  145214. }
  145215. assert( pLhs->aNode && pRhs->aNode );
  145216. return rc;
  145217. }
  145218. /*
  145219. ** Compare the term that the Fts3SegReader object passed as the first argument
  145220. ** points to with the term specified by arguments zTerm and nTerm.
  145221. **
  145222. ** If the pSeg iterator is already at EOF, return 0. Otherwise, return
  145223. ** -ve if the pSeg term is less than zTerm/nTerm, 0 if the two terms are
  145224. ** equal, or +ve if the pSeg term is greater than zTerm/nTerm.
  145225. */
  145226. static int fts3SegReaderTermCmp(
  145227. Fts3SegReader *pSeg, /* Segment reader object */
  145228. const char *zTerm, /* Term to compare to */
  145229. int nTerm /* Size of term zTerm in bytes */
  145230. ){
  145231. int res = 0;
  145232. if( pSeg->aNode ){
  145233. if( pSeg->nTerm>nTerm ){
  145234. res = memcmp(pSeg->zTerm, zTerm, nTerm);
  145235. }else{
  145236. res = memcmp(pSeg->zTerm, zTerm, pSeg->nTerm);
  145237. }
  145238. if( res==0 ){
  145239. res = pSeg->nTerm-nTerm;
  145240. }
  145241. }
  145242. return res;
  145243. }
  145244. /*
  145245. ** Argument apSegment is an array of nSegment elements. It is known that
  145246. ** the final (nSegment-nSuspect) members are already in sorted order
  145247. ** (according to the comparison function provided). This function shuffles
  145248. ** the array around until all entries are in sorted order.
  145249. */
  145250. static void fts3SegReaderSort(
  145251. Fts3SegReader **apSegment, /* Array to sort entries of */
  145252. int nSegment, /* Size of apSegment array */
  145253. int nSuspect, /* Unsorted entry count */
  145254. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) /* Comparison function */
  145255. ){
  145256. int i; /* Iterator variable */
  145257. assert( nSuspect<=nSegment );
  145258. if( nSuspect==nSegment ) nSuspect--;
  145259. for(i=nSuspect-1; i>=0; i--){
  145260. int j;
  145261. for(j=i; j<(nSegment-1); j++){
  145262. Fts3SegReader *pTmp;
  145263. if( xCmp(apSegment[j], apSegment[j+1])<0 ) break;
  145264. pTmp = apSegment[j+1];
  145265. apSegment[j+1] = apSegment[j];
  145266. apSegment[j] = pTmp;
  145267. }
  145268. }
  145269. #ifndef NDEBUG
  145270. /* Check that the list really is sorted now. */
  145271. for(i=0; i<(nSuspect-1); i++){
  145272. assert( xCmp(apSegment[i], apSegment[i+1])<0 );
  145273. }
  145274. #endif
  145275. }
  145276. /*
  145277. ** Insert a record into the %_segments table.
  145278. */
  145279. static int fts3WriteSegment(
  145280. Fts3Table *p, /* Virtual table handle */
  145281. sqlite3_int64 iBlock, /* Block id for new block */
  145282. char *z, /* Pointer to buffer containing block data */
  145283. int n /* Size of buffer z in bytes */
  145284. ){
  145285. sqlite3_stmt *pStmt;
  145286. int rc = fts3SqlStmt(p, SQL_INSERT_SEGMENTS, &pStmt, 0);
  145287. if( rc==SQLITE_OK ){
  145288. sqlite3_bind_int64(pStmt, 1, iBlock);
  145289. sqlite3_bind_blob(pStmt, 2, z, n, SQLITE_STATIC);
  145290. sqlite3_step(pStmt);
  145291. rc = sqlite3_reset(pStmt);
  145292. }
  145293. return rc;
  145294. }
  145295. /*
  145296. ** Find the largest relative level number in the table. If successful, set
  145297. ** *pnMax to this value and return SQLITE_OK. Otherwise, if an error occurs,
  145298. ** set *pnMax to zero and return an SQLite error code.
  145299. */
  145300. SQLITE_PRIVATE int sqlite3Fts3MaxLevel(Fts3Table *p, int *pnMax){
  145301. int rc;
  145302. int mxLevel = 0;
  145303. sqlite3_stmt *pStmt = 0;
  145304. rc = fts3SqlStmt(p, SQL_SELECT_MXLEVEL, &pStmt, 0);
  145305. if( rc==SQLITE_OK ){
  145306. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  145307. mxLevel = sqlite3_column_int(pStmt, 0);
  145308. }
  145309. rc = sqlite3_reset(pStmt);
  145310. }
  145311. *pnMax = mxLevel;
  145312. return rc;
  145313. }
  145314. /*
  145315. ** Insert a record into the %_segdir table.
  145316. */
  145317. static int fts3WriteSegdir(
  145318. Fts3Table *p, /* Virtual table handle */
  145319. sqlite3_int64 iLevel, /* Value for "level" field (absolute level) */
  145320. int iIdx, /* Value for "idx" field */
  145321. sqlite3_int64 iStartBlock, /* Value for "start_block" field */
  145322. sqlite3_int64 iLeafEndBlock, /* Value for "leaves_end_block" field */
  145323. sqlite3_int64 iEndBlock, /* Value for "end_block" field */
  145324. sqlite3_int64 nLeafData, /* Bytes of leaf data in segment */
  145325. char *zRoot, /* Blob value for "root" field */
  145326. int nRoot /* Number of bytes in buffer zRoot */
  145327. ){
  145328. sqlite3_stmt *pStmt;
  145329. int rc = fts3SqlStmt(p, SQL_INSERT_SEGDIR, &pStmt, 0);
  145330. if( rc==SQLITE_OK ){
  145331. sqlite3_bind_int64(pStmt, 1, iLevel);
  145332. sqlite3_bind_int(pStmt, 2, iIdx);
  145333. sqlite3_bind_int64(pStmt, 3, iStartBlock);
  145334. sqlite3_bind_int64(pStmt, 4, iLeafEndBlock);
  145335. if( nLeafData==0 ){
  145336. sqlite3_bind_int64(pStmt, 5, iEndBlock);
  145337. }else{
  145338. char *zEnd = sqlite3_mprintf("%lld %lld", iEndBlock, nLeafData);
  145339. if( !zEnd ) return SQLITE_NOMEM;
  145340. sqlite3_bind_text(pStmt, 5, zEnd, -1, sqlite3_free);
  145341. }
  145342. sqlite3_bind_blob(pStmt, 6, zRoot, nRoot, SQLITE_STATIC);
  145343. sqlite3_step(pStmt);
  145344. rc = sqlite3_reset(pStmt);
  145345. }
  145346. return rc;
  145347. }
  145348. /*
  145349. ** Return the size of the common prefix (if any) shared by zPrev and
  145350. ** zNext, in bytes. For example,
  145351. **
  145352. ** fts3PrefixCompress("abc", 3, "abcdef", 6) // returns 3
  145353. ** fts3PrefixCompress("abX", 3, "abcdef", 6) // returns 2
  145354. ** fts3PrefixCompress("abX", 3, "Xbcdef", 6) // returns 0
  145355. */
  145356. static int fts3PrefixCompress(
  145357. const char *zPrev, /* Buffer containing previous term */
  145358. int nPrev, /* Size of buffer zPrev in bytes */
  145359. const char *zNext, /* Buffer containing next term */
  145360. int nNext /* Size of buffer zNext in bytes */
  145361. ){
  145362. int n;
  145363. UNUSED_PARAMETER(nNext);
  145364. for(n=0; n<nPrev && zPrev[n]==zNext[n]; n++);
  145365. return n;
  145366. }
  145367. /*
  145368. ** Add term zTerm to the SegmentNode. It is guaranteed that zTerm is larger
  145369. ** (according to memcmp) than the previous term.
  145370. */
  145371. static int fts3NodeAddTerm(
  145372. Fts3Table *p, /* Virtual table handle */
  145373. SegmentNode **ppTree, /* IN/OUT: SegmentNode handle */
  145374. int isCopyTerm, /* True if zTerm/nTerm is transient */
  145375. const char *zTerm, /* Pointer to buffer containing term */
  145376. int nTerm /* Size of term in bytes */
  145377. ){
  145378. SegmentNode *pTree = *ppTree;
  145379. int rc;
  145380. SegmentNode *pNew;
  145381. /* First try to append the term to the current node. Return early if
  145382. ** this is possible.
  145383. */
  145384. if( pTree ){
  145385. int nData = pTree->nData; /* Current size of node in bytes */
  145386. int nReq = nData; /* Required space after adding zTerm */
  145387. int nPrefix; /* Number of bytes of prefix compression */
  145388. int nSuffix; /* Suffix length */
  145389. nPrefix = fts3PrefixCompress(pTree->zTerm, pTree->nTerm, zTerm, nTerm);
  145390. nSuffix = nTerm-nPrefix;
  145391. nReq += sqlite3Fts3VarintLen(nPrefix)+sqlite3Fts3VarintLen(nSuffix)+nSuffix;
  145392. if( nReq<=p->nNodeSize || !pTree->zTerm ){
  145393. if( nReq>p->nNodeSize ){
  145394. /* An unusual case: this is the first term to be added to the node
  145395. ** and the static node buffer (p->nNodeSize bytes) is not large
  145396. ** enough. Use a separately malloced buffer instead This wastes
  145397. ** p->nNodeSize bytes, but since this scenario only comes about when
  145398. ** the database contain two terms that share a prefix of almost 2KB,
  145399. ** this is not expected to be a serious problem.
  145400. */
  145401. assert( pTree->aData==(char *)&pTree[1] );
  145402. pTree->aData = (char *)sqlite3_malloc(nReq);
  145403. if( !pTree->aData ){
  145404. return SQLITE_NOMEM;
  145405. }
  145406. }
  145407. if( pTree->zTerm ){
  145408. /* There is no prefix-length field for first term in a node */
  145409. nData += sqlite3Fts3PutVarint(&pTree->aData[nData], nPrefix);
  145410. }
  145411. nData += sqlite3Fts3PutVarint(&pTree->aData[nData], nSuffix);
  145412. memcpy(&pTree->aData[nData], &zTerm[nPrefix], nSuffix);
  145413. pTree->nData = nData + nSuffix;
  145414. pTree->nEntry++;
  145415. if( isCopyTerm ){
  145416. if( pTree->nMalloc<nTerm ){
  145417. char *zNew = sqlite3_realloc(pTree->zMalloc, nTerm*2);
  145418. if( !zNew ){
  145419. return SQLITE_NOMEM;
  145420. }
  145421. pTree->nMalloc = nTerm*2;
  145422. pTree->zMalloc = zNew;
  145423. }
  145424. pTree->zTerm = pTree->zMalloc;
  145425. memcpy(pTree->zTerm, zTerm, nTerm);
  145426. pTree->nTerm = nTerm;
  145427. }else{
  145428. pTree->zTerm = (char *)zTerm;
  145429. pTree->nTerm = nTerm;
  145430. }
  145431. return SQLITE_OK;
  145432. }
  145433. }
  145434. /* If control flows to here, it was not possible to append zTerm to the
  145435. ** current node. Create a new node (a right-sibling of the current node).
  145436. ** If this is the first node in the tree, the term is added to it.
  145437. **
  145438. ** Otherwise, the term is not added to the new node, it is left empty for
  145439. ** now. Instead, the term is inserted into the parent of pTree. If pTree
  145440. ** has no parent, one is created here.
  145441. */
  145442. pNew = (SegmentNode *)sqlite3_malloc(sizeof(SegmentNode) + p->nNodeSize);
  145443. if( !pNew ){
  145444. return SQLITE_NOMEM;
  145445. }
  145446. memset(pNew, 0, sizeof(SegmentNode));
  145447. pNew->nData = 1 + FTS3_VARINT_MAX;
  145448. pNew->aData = (char *)&pNew[1];
  145449. if( pTree ){
  145450. SegmentNode *pParent = pTree->pParent;
  145451. rc = fts3NodeAddTerm(p, &pParent, isCopyTerm, zTerm, nTerm);
  145452. if( pTree->pParent==0 ){
  145453. pTree->pParent = pParent;
  145454. }
  145455. pTree->pRight = pNew;
  145456. pNew->pLeftmost = pTree->pLeftmost;
  145457. pNew->pParent = pParent;
  145458. pNew->zMalloc = pTree->zMalloc;
  145459. pNew->nMalloc = pTree->nMalloc;
  145460. pTree->zMalloc = 0;
  145461. }else{
  145462. pNew->pLeftmost = pNew;
  145463. rc = fts3NodeAddTerm(p, &pNew, isCopyTerm, zTerm, nTerm);
  145464. }
  145465. *ppTree = pNew;
  145466. return rc;
  145467. }
  145468. /*
  145469. ** Helper function for fts3NodeWrite().
  145470. */
  145471. static int fts3TreeFinishNode(
  145472. SegmentNode *pTree,
  145473. int iHeight,
  145474. sqlite3_int64 iLeftChild
  145475. ){
  145476. int nStart;
  145477. assert( iHeight>=1 && iHeight<128 );
  145478. nStart = FTS3_VARINT_MAX - sqlite3Fts3VarintLen(iLeftChild);
  145479. pTree->aData[nStart] = (char)iHeight;
  145480. sqlite3Fts3PutVarint(&pTree->aData[nStart+1], iLeftChild);
  145481. return nStart;
  145482. }
  145483. /*
  145484. ** Write the buffer for the segment node pTree and all of its peers to the
  145485. ** database. Then call this function recursively to write the parent of
  145486. ** pTree and its peers to the database.
  145487. **
  145488. ** Except, if pTree is a root node, do not write it to the database. Instead,
  145489. ** set output variables *paRoot and *pnRoot to contain the root node.
  145490. **
  145491. ** If successful, SQLITE_OK is returned and output variable *piLast is
  145492. ** set to the largest blockid written to the database (or zero if no
  145493. ** blocks were written to the db). Otherwise, an SQLite error code is
  145494. ** returned.
  145495. */
  145496. static int fts3NodeWrite(
  145497. Fts3Table *p, /* Virtual table handle */
  145498. SegmentNode *pTree, /* SegmentNode handle */
  145499. int iHeight, /* Height of this node in tree */
  145500. sqlite3_int64 iLeaf, /* Block id of first leaf node */
  145501. sqlite3_int64 iFree, /* Block id of next free slot in %_segments */
  145502. sqlite3_int64 *piLast, /* OUT: Block id of last entry written */
  145503. char **paRoot, /* OUT: Data for root node */
  145504. int *pnRoot /* OUT: Size of root node in bytes */
  145505. ){
  145506. int rc = SQLITE_OK;
  145507. if( !pTree->pParent ){
  145508. /* Root node of the tree. */
  145509. int nStart = fts3TreeFinishNode(pTree, iHeight, iLeaf);
  145510. *piLast = iFree-1;
  145511. *pnRoot = pTree->nData - nStart;
  145512. *paRoot = &pTree->aData[nStart];
  145513. }else{
  145514. SegmentNode *pIter;
  145515. sqlite3_int64 iNextFree = iFree;
  145516. sqlite3_int64 iNextLeaf = iLeaf;
  145517. for(pIter=pTree->pLeftmost; pIter && rc==SQLITE_OK; pIter=pIter->pRight){
  145518. int nStart = fts3TreeFinishNode(pIter, iHeight, iNextLeaf);
  145519. int nWrite = pIter->nData - nStart;
  145520. rc = fts3WriteSegment(p, iNextFree, &pIter->aData[nStart], nWrite);
  145521. iNextFree++;
  145522. iNextLeaf += (pIter->nEntry+1);
  145523. }
  145524. if( rc==SQLITE_OK ){
  145525. assert( iNextLeaf==iFree );
  145526. rc = fts3NodeWrite(
  145527. p, pTree->pParent, iHeight+1, iFree, iNextFree, piLast, paRoot, pnRoot
  145528. );
  145529. }
  145530. }
  145531. return rc;
  145532. }
  145533. /*
  145534. ** Free all memory allocations associated with the tree pTree.
  145535. */
  145536. static void fts3NodeFree(SegmentNode *pTree){
  145537. if( pTree ){
  145538. SegmentNode *p = pTree->pLeftmost;
  145539. fts3NodeFree(p->pParent);
  145540. while( p ){
  145541. SegmentNode *pRight = p->pRight;
  145542. if( p->aData!=(char *)&p[1] ){
  145543. sqlite3_free(p->aData);
  145544. }
  145545. assert( pRight==0 || p->zMalloc==0 );
  145546. sqlite3_free(p->zMalloc);
  145547. sqlite3_free(p);
  145548. p = pRight;
  145549. }
  145550. }
  145551. }
  145552. /*
  145553. ** Add a term to the segment being constructed by the SegmentWriter object
  145554. ** *ppWriter. When adding the first term to a segment, *ppWriter should
  145555. ** be passed NULL. This function will allocate a new SegmentWriter object
  145556. ** and return it via the input/output variable *ppWriter in this case.
  145557. **
  145558. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  145559. */
  145560. static int fts3SegWriterAdd(
  145561. Fts3Table *p, /* Virtual table handle */
  145562. SegmentWriter **ppWriter, /* IN/OUT: SegmentWriter handle */
  145563. int isCopyTerm, /* True if buffer zTerm must be copied */
  145564. const char *zTerm, /* Pointer to buffer containing term */
  145565. int nTerm, /* Size of term in bytes */
  145566. const char *aDoclist, /* Pointer to buffer containing doclist */
  145567. int nDoclist /* Size of doclist in bytes */
  145568. ){
  145569. int nPrefix; /* Size of term prefix in bytes */
  145570. int nSuffix; /* Size of term suffix in bytes */
  145571. int nReq; /* Number of bytes required on leaf page */
  145572. int nData;
  145573. SegmentWriter *pWriter = *ppWriter;
  145574. if( !pWriter ){
  145575. int rc;
  145576. sqlite3_stmt *pStmt;
  145577. /* Allocate the SegmentWriter structure */
  145578. pWriter = (SegmentWriter *)sqlite3_malloc(sizeof(SegmentWriter));
  145579. if( !pWriter ) return SQLITE_NOMEM;
  145580. memset(pWriter, 0, sizeof(SegmentWriter));
  145581. *ppWriter = pWriter;
  145582. /* Allocate a buffer in which to accumulate data */
  145583. pWriter->aData = (char *)sqlite3_malloc(p->nNodeSize);
  145584. if( !pWriter->aData ) return SQLITE_NOMEM;
  145585. pWriter->nSize = p->nNodeSize;
  145586. /* Find the next free blockid in the %_segments table */
  145587. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENTS_ID, &pStmt, 0);
  145588. if( rc!=SQLITE_OK ) return rc;
  145589. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  145590. pWriter->iFree = sqlite3_column_int64(pStmt, 0);
  145591. pWriter->iFirst = pWriter->iFree;
  145592. }
  145593. rc = sqlite3_reset(pStmt);
  145594. if( rc!=SQLITE_OK ) return rc;
  145595. }
  145596. nData = pWriter->nData;
  145597. nPrefix = fts3PrefixCompress(pWriter->zTerm, pWriter->nTerm, zTerm, nTerm);
  145598. nSuffix = nTerm-nPrefix;
  145599. /* Figure out how many bytes are required by this new entry */
  145600. nReq = sqlite3Fts3VarintLen(nPrefix) + /* varint containing prefix size */
  145601. sqlite3Fts3VarintLen(nSuffix) + /* varint containing suffix size */
  145602. nSuffix + /* Term suffix */
  145603. sqlite3Fts3VarintLen(nDoclist) + /* Size of doclist */
  145604. nDoclist; /* Doclist data */
  145605. if( nData>0 && nData+nReq>p->nNodeSize ){
  145606. int rc;
  145607. /* The current leaf node is full. Write it out to the database. */
  145608. rc = fts3WriteSegment(p, pWriter->iFree++, pWriter->aData, nData);
  145609. if( rc!=SQLITE_OK ) return rc;
  145610. p->nLeafAdd++;
  145611. /* Add the current term to the interior node tree. The term added to
  145612. ** the interior tree must:
  145613. **
  145614. ** a) be greater than the largest term on the leaf node just written
  145615. ** to the database (still available in pWriter->zTerm), and
  145616. **
  145617. ** b) be less than or equal to the term about to be added to the new
  145618. ** leaf node (zTerm/nTerm).
  145619. **
  145620. ** In other words, it must be the prefix of zTerm 1 byte longer than
  145621. ** the common prefix (if any) of zTerm and pWriter->zTerm.
  145622. */
  145623. assert( nPrefix<nTerm );
  145624. rc = fts3NodeAddTerm(p, &pWriter->pTree, isCopyTerm, zTerm, nPrefix+1);
  145625. if( rc!=SQLITE_OK ) return rc;
  145626. nData = 0;
  145627. pWriter->nTerm = 0;
  145628. nPrefix = 0;
  145629. nSuffix = nTerm;
  145630. nReq = 1 + /* varint containing prefix size */
  145631. sqlite3Fts3VarintLen(nTerm) + /* varint containing suffix size */
  145632. nTerm + /* Term suffix */
  145633. sqlite3Fts3VarintLen(nDoclist) + /* Size of doclist */
  145634. nDoclist; /* Doclist data */
  145635. }
  145636. /* Increase the total number of bytes written to account for the new entry. */
  145637. pWriter->nLeafData += nReq;
  145638. /* If the buffer currently allocated is too small for this entry, realloc
  145639. ** the buffer to make it large enough.
  145640. */
  145641. if( nReq>pWriter->nSize ){
  145642. char *aNew = sqlite3_realloc(pWriter->aData, nReq);
  145643. if( !aNew ) return SQLITE_NOMEM;
  145644. pWriter->aData = aNew;
  145645. pWriter->nSize = nReq;
  145646. }
  145647. assert( nData+nReq<=pWriter->nSize );
  145648. /* Append the prefix-compressed term and doclist to the buffer. */
  145649. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nPrefix);
  145650. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nSuffix);
  145651. memcpy(&pWriter->aData[nData], &zTerm[nPrefix], nSuffix);
  145652. nData += nSuffix;
  145653. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nDoclist);
  145654. memcpy(&pWriter->aData[nData], aDoclist, nDoclist);
  145655. pWriter->nData = nData + nDoclist;
  145656. /* Save the current term so that it can be used to prefix-compress the next.
  145657. ** If the isCopyTerm parameter is true, then the buffer pointed to by
  145658. ** zTerm is transient, so take a copy of the term data. Otherwise, just
  145659. ** store a copy of the pointer.
  145660. */
  145661. if( isCopyTerm ){
  145662. if( nTerm>pWriter->nMalloc ){
  145663. char *zNew = sqlite3_realloc(pWriter->zMalloc, nTerm*2);
  145664. if( !zNew ){
  145665. return SQLITE_NOMEM;
  145666. }
  145667. pWriter->nMalloc = nTerm*2;
  145668. pWriter->zMalloc = zNew;
  145669. pWriter->zTerm = zNew;
  145670. }
  145671. assert( pWriter->zTerm==pWriter->zMalloc );
  145672. memcpy(pWriter->zTerm, zTerm, nTerm);
  145673. }else{
  145674. pWriter->zTerm = (char *)zTerm;
  145675. }
  145676. pWriter->nTerm = nTerm;
  145677. return SQLITE_OK;
  145678. }
  145679. /*
  145680. ** Flush all data associated with the SegmentWriter object pWriter to the
  145681. ** database. This function must be called after all terms have been added
  145682. ** to the segment using fts3SegWriterAdd(). If successful, SQLITE_OK is
  145683. ** returned. Otherwise, an SQLite error code.
  145684. */
  145685. static int fts3SegWriterFlush(
  145686. Fts3Table *p, /* Virtual table handle */
  145687. SegmentWriter *pWriter, /* SegmentWriter to flush to the db */
  145688. sqlite3_int64 iLevel, /* Value for 'level' column of %_segdir */
  145689. int iIdx /* Value for 'idx' column of %_segdir */
  145690. ){
  145691. int rc; /* Return code */
  145692. if( pWriter->pTree ){
  145693. sqlite3_int64 iLast = 0; /* Largest block id written to database */
  145694. sqlite3_int64 iLastLeaf; /* Largest leaf block id written to db */
  145695. char *zRoot = NULL; /* Pointer to buffer containing root node */
  145696. int nRoot = 0; /* Size of buffer zRoot */
  145697. iLastLeaf = pWriter->iFree;
  145698. rc = fts3WriteSegment(p, pWriter->iFree++, pWriter->aData, pWriter->nData);
  145699. if( rc==SQLITE_OK ){
  145700. rc = fts3NodeWrite(p, pWriter->pTree, 1,
  145701. pWriter->iFirst, pWriter->iFree, &iLast, &zRoot, &nRoot);
  145702. }
  145703. if( rc==SQLITE_OK ){
  145704. rc = fts3WriteSegdir(p, iLevel, iIdx,
  145705. pWriter->iFirst, iLastLeaf, iLast, pWriter->nLeafData, zRoot, nRoot);
  145706. }
  145707. }else{
  145708. /* The entire tree fits on the root node. Write it to the segdir table. */
  145709. rc = fts3WriteSegdir(p, iLevel, iIdx,
  145710. 0, 0, 0, pWriter->nLeafData, pWriter->aData, pWriter->nData);
  145711. }
  145712. p->nLeafAdd++;
  145713. return rc;
  145714. }
  145715. /*
  145716. ** Release all memory held by the SegmentWriter object passed as the
  145717. ** first argument.
  145718. */
  145719. static void fts3SegWriterFree(SegmentWriter *pWriter){
  145720. if( pWriter ){
  145721. sqlite3_free(pWriter->aData);
  145722. sqlite3_free(pWriter->zMalloc);
  145723. fts3NodeFree(pWriter->pTree);
  145724. sqlite3_free(pWriter);
  145725. }
  145726. }
  145727. /*
  145728. ** The first value in the apVal[] array is assumed to contain an integer.
  145729. ** This function tests if there exist any documents with docid values that
  145730. ** are different from that integer. i.e. if deleting the document with docid
  145731. ** pRowid would mean the FTS3 table were empty.
  145732. **
  145733. ** If successful, *pisEmpty is set to true if the table is empty except for
  145734. ** document pRowid, or false otherwise, and SQLITE_OK is returned. If an
  145735. ** error occurs, an SQLite error code is returned.
  145736. */
  145737. static int fts3IsEmpty(Fts3Table *p, sqlite3_value *pRowid, int *pisEmpty){
  145738. sqlite3_stmt *pStmt;
  145739. int rc;
  145740. if( p->zContentTbl ){
  145741. /* If using the content=xxx option, assume the table is never empty */
  145742. *pisEmpty = 0;
  145743. rc = SQLITE_OK;
  145744. }else{
  145745. rc = fts3SqlStmt(p, SQL_IS_EMPTY, &pStmt, &pRowid);
  145746. if( rc==SQLITE_OK ){
  145747. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  145748. *pisEmpty = sqlite3_column_int(pStmt, 0);
  145749. }
  145750. rc = sqlite3_reset(pStmt);
  145751. }
  145752. }
  145753. return rc;
  145754. }
  145755. /*
  145756. ** Set *pnMax to the largest segment level in the database for the index
  145757. ** iIndex.
  145758. **
  145759. ** Segment levels are stored in the 'level' column of the %_segdir table.
  145760. **
  145761. ** Return SQLITE_OK if successful, or an SQLite error code if not.
  145762. */
  145763. static int fts3SegmentMaxLevel(
  145764. Fts3Table *p,
  145765. int iLangid,
  145766. int iIndex,
  145767. sqlite3_int64 *pnMax
  145768. ){
  145769. sqlite3_stmt *pStmt;
  145770. int rc;
  145771. assert( iIndex>=0 && iIndex<p->nIndex );
  145772. /* Set pStmt to the compiled version of:
  145773. **
  145774. ** SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?
  145775. **
  145776. ** (1024 is actually the value of macro FTS3_SEGDIR_PREFIXLEVEL_STR).
  145777. */
  145778. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR_MAX_LEVEL, &pStmt, 0);
  145779. if( rc!=SQLITE_OK ) return rc;
  145780. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  145781. sqlite3_bind_int64(pStmt, 2,
  145782. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  145783. );
  145784. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  145785. *pnMax = sqlite3_column_int64(pStmt, 0);
  145786. }
  145787. return sqlite3_reset(pStmt);
  145788. }
  145789. /*
  145790. ** iAbsLevel is an absolute level that may be assumed to exist within
  145791. ** the database. This function checks if it is the largest level number
  145792. ** within its index. Assuming no error occurs, *pbMax is set to 1 if
  145793. ** iAbsLevel is indeed the largest level, or 0 otherwise, and SQLITE_OK
  145794. ** is returned. If an error occurs, an error code is returned and the
  145795. ** final value of *pbMax is undefined.
  145796. */
  145797. static int fts3SegmentIsMaxLevel(Fts3Table *p, i64 iAbsLevel, int *pbMax){
  145798. /* Set pStmt to the compiled version of:
  145799. **
  145800. ** SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?
  145801. **
  145802. ** (1024 is actually the value of macro FTS3_SEGDIR_PREFIXLEVEL_STR).
  145803. */
  145804. sqlite3_stmt *pStmt;
  145805. int rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR_MAX_LEVEL, &pStmt, 0);
  145806. if( rc!=SQLITE_OK ) return rc;
  145807. sqlite3_bind_int64(pStmt, 1, iAbsLevel+1);
  145808. sqlite3_bind_int64(pStmt, 2,
  145809. ((iAbsLevel/FTS3_SEGDIR_MAXLEVEL)+1) * FTS3_SEGDIR_MAXLEVEL
  145810. );
  145811. *pbMax = 0;
  145812. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  145813. *pbMax = sqlite3_column_type(pStmt, 0)==SQLITE_NULL;
  145814. }
  145815. return sqlite3_reset(pStmt);
  145816. }
  145817. /*
  145818. ** Delete all entries in the %_segments table associated with the segment
  145819. ** opened with seg-reader pSeg. This function does not affect the contents
  145820. ** of the %_segdir table.
  145821. */
  145822. static int fts3DeleteSegment(
  145823. Fts3Table *p, /* FTS table handle */
  145824. Fts3SegReader *pSeg /* Segment to delete */
  145825. ){
  145826. int rc = SQLITE_OK; /* Return code */
  145827. if( pSeg->iStartBlock ){
  145828. sqlite3_stmt *pDelete; /* SQL statement to delete rows */
  145829. rc = fts3SqlStmt(p, SQL_DELETE_SEGMENTS_RANGE, &pDelete, 0);
  145830. if( rc==SQLITE_OK ){
  145831. sqlite3_bind_int64(pDelete, 1, pSeg->iStartBlock);
  145832. sqlite3_bind_int64(pDelete, 2, pSeg->iEndBlock);
  145833. sqlite3_step(pDelete);
  145834. rc = sqlite3_reset(pDelete);
  145835. }
  145836. }
  145837. return rc;
  145838. }
  145839. /*
  145840. ** This function is used after merging multiple segments into a single large
  145841. ** segment to delete the old, now redundant, segment b-trees. Specifically,
  145842. ** it:
  145843. **
  145844. ** 1) Deletes all %_segments entries for the segments associated with
  145845. ** each of the SegReader objects in the array passed as the third
  145846. ** argument, and
  145847. **
  145848. ** 2) deletes all %_segdir entries with level iLevel, or all %_segdir
  145849. ** entries regardless of level if (iLevel<0).
  145850. **
  145851. ** SQLITE_OK is returned if successful, otherwise an SQLite error code.
  145852. */
  145853. static int fts3DeleteSegdir(
  145854. Fts3Table *p, /* Virtual table handle */
  145855. int iLangid, /* Language id */
  145856. int iIndex, /* Index for p->aIndex */
  145857. int iLevel, /* Level of %_segdir entries to delete */
  145858. Fts3SegReader **apSegment, /* Array of SegReader objects */
  145859. int nReader /* Size of array apSegment */
  145860. ){
  145861. int rc = SQLITE_OK; /* Return Code */
  145862. int i; /* Iterator variable */
  145863. sqlite3_stmt *pDelete = 0; /* SQL statement to delete rows */
  145864. for(i=0; rc==SQLITE_OK && i<nReader; i++){
  145865. rc = fts3DeleteSegment(p, apSegment[i]);
  145866. }
  145867. if( rc!=SQLITE_OK ){
  145868. return rc;
  145869. }
  145870. assert( iLevel>=0 || iLevel==FTS3_SEGCURSOR_ALL );
  145871. if( iLevel==FTS3_SEGCURSOR_ALL ){
  145872. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_RANGE, &pDelete, 0);
  145873. if( rc==SQLITE_OK ){
  145874. sqlite3_bind_int64(pDelete, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  145875. sqlite3_bind_int64(pDelete, 2,
  145876. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  145877. );
  145878. }
  145879. }else{
  145880. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_LEVEL, &pDelete, 0);
  145881. if( rc==SQLITE_OK ){
  145882. sqlite3_bind_int64(
  145883. pDelete, 1, getAbsoluteLevel(p, iLangid, iIndex, iLevel)
  145884. );
  145885. }
  145886. }
  145887. if( rc==SQLITE_OK ){
  145888. sqlite3_step(pDelete);
  145889. rc = sqlite3_reset(pDelete);
  145890. }
  145891. return rc;
  145892. }
  145893. /*
  145894. ** When this function is called, buffer *ppList (size *pnList bytes) contains
  145895. ** a position list that may (or may not) feature multiple columns. This
  145896. ** function adjusts the pointer *ppList and the length *pnList so that they
  145897. ** identify the subset of the position list that corresponds to column iCol.
  145898. **
  145899. ** If there are no entries in the input position list for column iCol, then
  145900. ** *pnList is set to zero before returning.
  145901. **
  145902. ** If parameter bZero is non-zero, then any part of the input list following
  145903. ** the end of the output list is zeroed before returning.
  145904. */
  145905. static void fts3ColumnFilter(
  145906. int iCol, /* Column to filter on */
  145907. int bZero, /* Zero out anything following *ppList */
  145908. char **ppList, /* IN/OUT: Pointer to position list */
  145909. int *pnList /* IN/OUT: Size of buffer *ppList in bytes */
  145910. ){
  145911. char *pList = *ppList;
  145912. int nList = *pnList;
  145913. char *pEnd = &pList[nList];
  145914. int iCurrent = 0;
  145915. char *p = pList;
  145916. assert( iCol>=0 );
  145917. while( 1 ){
  145918. char c = 0;
  145919. while( p<pEnd && (c | *p)&0xFE ) c = *p++ & 0x80;
  145920. if( iCol==iCurrent ){
  145921. nList = (int)(p - pList);
  145922. break;
  145923. }
  145924. nList -= (int)(p - pList);
  145925. pList = p;
  145926. if( nList==0 ){
  145927. break;
  145928. }
  145929. p = &pList[1];
  145930. p += fts3GetVarint32(p, &iCurrent);
  145931. }
  145932. if( bZero && &pList[nList]!=pEnd ){
  145933. memset(&pList[nList], 0, pEnd - &pList[nList]);
  145934. }
  145935. *ppList = pList;
  145936. *pnList = nList;
  145937. }
  145938. /*
  145939. ** Cache data in the Fts3MultiSegReader.aBuffer[] buffer (overwriting any
  145940. ** existing data). Grow the buffer if required.
  145941. **
  145942. ** If successful, return SQLITE_OK. Otherwise, if an OOM error is encountered
  145943. ** trying to resize the buffer, return SQLITE_NOMEM.
  145944. */
  145945. static int fts3MsrBufferData(
  145946. Fts3MultiSegReader *pMsr, /* Multi-segment-reader handle */
  145947. char *pList,
  145948. int nList
  145949. ){
  145950. if( nList>pMsr->nBuffer ){
  145951. char *pNew;
  145952. pMsr->nBuffer = nList*2;
  145953. pNew = (char *)sqlite3_realloc(pMsr->aBuffer, pMsr->nBuffer);
  145954. if( !pNew ) return SQLITE_NOMEM;
  145955. pMsr->aBuffer = pNew;
  145956. }
  145957. memcpy(pMsr->aBuffer, pList, nList);
  145958. return SQLITE_OK;
  145959. }
  145960. SQLITE_PRIVATE int sqlite3Fts3MsrIncrNext(
  145961. Fts3Table *p, /* Virtual table handle */
  145962. Fts3MultiSegReader *pMsr, /* Multi-segment-reader handle */
  145963. sqlite3_int64 *piDocid, /* OUT: Docid value */
  145964. char **paPoslist, /* OUT: Pointer to position list */
  145965. int *pnPoslist /* OUT: Size of position list in bytes */
  145966. ){
  145967. int nMerge = pMsr->nAdvance;
  145968. Fts3SegReader **apSegment = pMsr->apSegment;
  145969. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  145970. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  145971. );
  145972. if( nMerge==0 ){
  145973. *paPoslist = 0;
  145974. return SQLITE_OK;
  145975. }
  145976. while( 1 ){
  145977. Fts3SegReader *pSeg;
  145978. pSeg = pMsr->apSegment[0];
  145979. if( pSeg->pOffsetList==0 ){
  145980. *paPoslist = 0;
  145981. break;
  145982. }else{
  145983. int rc;
  145984. char *pList;
  145985. int nList;
  145986. int j;
  145987. sqlite3_int64 iDocid = apSegment[0]->iDocid;
  145988. rc = fts3SegReaderNextDocid(p, apSegment[0], &pList, &nList);
  145989. j = 1;
  145990. while( rc==SQLITE_OK
  145991. && j<nMerge
  145992. && apSegment[j]->pOffsetList
  145993. && apSegment[j]->iDocid==iDocid
  145994. ){
  145995. rc = fts3SegReaderNextDocid(p, apSegment[j], 0, 0);
  145996. j++;
  145997. }
  145998. if( rc!=SQLITE_OK ) return rc;
  145999. fts3SegReaderSort(pMsr->apSegment, nMerge, j, xCmp);
  146000. if( nList>0 && fts3SegReaderIsPending(apSegment[0]) ){
  146001. rc = fts3MsrBufferData(pMsr, pList, nList+1);
  146002. if( rc!=SQLITE_OK ) return rc;
  146003. assert( (pMsr->aBuffer[nList] & 0xFE)==0x00 );
  146004. pList = pMsr->aBuffer;
  146005. }
  146006. if( pMsr->iColFilter>=0 ){
  146007. fts3ColumnFilter(pMsr->iColFilter, 1, &pList, &nList);
  146008. }
  146009. if( nList>0 ){
  146010. *paPoslist = pList;
  146011. *piDocid = iDocid;
  146012. *pnPoslist = nList;
  146013. break;
  146014. }
  146015. }
  146016. }
  146017. return SQLITE_OK;
  146018. }
  146019. static int fts3SegReaderStart(
  146020. Fts3Table *p, /* Virtual table handle */
  146021. Fts3MultiSegReader *pCsr, /* Cursor object */
  146022. const char *zTerm, /* Term searched for (or NULL) */
  146023. int nTerm /* Length of zTerm in bytes */
  146024. ){
  146025. int i;
  146026. int nSeg = pCsr->nSegment;
  146027. /* If the Fts3SegFilter defines a specific term (or term prefix) to search
  146028. ** for, then advance each segment iterator until it points to a term of
  146029. ** equal or greater value than the specified term. This prevents many
  146030. ** unnecessary merge/sort operations for the case where single segment
  146031. ** b-tree leaf nodes contain more than one term.
  146032. */
  146033. for(i=0; pCsr->bRestart==0 && i<pCsr->nSegment; i++){
  146034. int res = 0;
  146035. Fts3SegReader *pSeg = pCsr->apSegment[i];
  146036. do {
  146037. int rc = fts3SegReaderNext(p, pSeg, 0);
  146038. if( rc!=SQLITE_OK ) return rc;
  146039. }while( zTerm && (res = fts3SegReaderTermCmp(pSeg, zTerm, nTerm))<0 );
  146040. if( pSeg->bLookup && res!=0 ){
  146041. fts3SegReaderSetEof(pSeg);
  146042. }
  146043. }
  146044. fts3SegReaderSort(pCsr->apSegment, nSeg, nSeg, fts3SegReaderCmp);
  146045. return SQLITE_OK;
  146046. }
  146047. SQLITE_PRIVATE int sqlite3Fts3SegReaderStart(
  146048. Fts3Table *p, /* Virtual table handle */
  146049. Fts3MultiSegReader *pCsr, /* Cursor object */
  146050. Fts3SegFilter *pFilter /* Restrictions on range of iteration */
  146051. ){
  146052. pCsr->pFilter = pFilter;
  146053. return fts3SegReaderStart(p, pCsr, pFilter->zTerm, pFilter->nTerm);
  146054. }
  146055. SQLITE_PRIVATE int sqlite3Fts3MsrIncrStart(
  146056. Fts3Table *p, /* Virtual table handle */
  146057. Fts3MultiSegReader *pCsr, /* Cursor object */
  146058. int iCol, /* Column to match on. */
  146059. const char *zTerm, /* Term to iterate through a doclist for */
  146060. int nTerm /* Number of bytes in zTerm */
  146061. ){
  146062. int i;
  146063. int rc;
  146064. int nSegment = pCsr->nSegment;
  146065. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  146066. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  146067. );
  146068. assert( pCsr->pFilter==0 );
  146069. assert( zTerm && nTerm>0 );
  146070. /* Advance each segment iterator until it points to the term zTerm/nTerm. */
  146071. rc = fts3SegReaderStart(p, pCsr, zTerm, nTerm);
  146072. if( rc!=SQLITE_OK ) return rc;
  146073. /* Determine how many of the segments actually point to zTerm/nTerm. */
  146074. for(i=0; i<nSegment; i++){
  146075. Fts3SegReader *pSeg = pCsr->apSegment[i];
  146076. if( !pSeg->aNode || fts3SegReaderTermCmp(pSeg, zTerm, nTerm) ){
  146077. break;
  146078. }
  146079. }
  146080. pCsr->nAdvance = i;
  146081. /* Advance each of the segments to point to the first docid. */
  146082. for(i=0; i<pCsr->nAdvance; i++){
  146083. rc = fts3SegReaderFirstDocid(p, pCsr->apSegment[i]);
  146084. if( rc!=SQLITE_OK ) return rc;
  146085. }
  146086. fts3SegReaderSort(pCsr->apSegment, i, i, xCmp);
  146087. assert( iCol<0 || iCol<p->nColumn );
  146088. pCsr->iColFilter = iCol;
  146089. return SQLITE_OK;
  146090. }
  146091. /*
  146092. ** This function is called on a MultiSegReader that has been started using
  146093. ** sqlite3Fts3MsrIncrStart(). One or more calls to MsrIncrNext() may also
  146094. ** have been made. Calling this function puts the MultiSegReader in such
  146095. ** a state that if the next two calls are:
  146096. **
  146097. ** sqlite3Fts3SegReaderStart()
  146098. ** sqlite3Fts3SegReaderStep()
  146099. **
  146100. ** then the entire doclist for the term is available in
  146101. ** MultiSegReader.aDoclist/nDoclist.
  146102. */
  146103. SQLITE_PRIVATE int sqlite3Fts3MsrIncrRestart(Fts3MultiSegReader *pCsr){
  146104. int i; /* Used to iterate through segment-readers */
  146105. assert( pCsr->zTerm==0 );
  146106. assert( pCsr->nTerm==0 );
  146107. assert( pCsr->aDoclist==0 );
  146108. assert( pCsr->nDoclist==0 );
  146109. pCsr->nAdvance = 0;
  146110. pCsr->bRestart = 1;
  146111. for(i=0; i<pCsr->nSegment; i++){
  146112. pCsr->apSegment[i]->pOffsetList = 0;
  146113. pCsr->apSegment[i]->nOffsetList = 0;
  146114. pCsr->apSegment[i]->iDocid = 0;
  146115. }
  146116. return SQLITE_OK;
  146117. }
  146118. SQLITE_PRIVATE int sqlite3Fts3SegReaderStep(
  146119. Fts3Table *p, /* Virtual table handle */
  146120. Fts3MultiSegReader *pCsr /* Cursor object */
  146121. ){
  146122. int rc = SQLITE_OK;
  146123. int isIgnoreEmpty = (pCsr->pFilter->flags & FTS3_SEGMENT_IGNORE_EMPTY);
  146124. int isRequirePos = (pCsr->pFilter->flags & FTS3_SEGMENT_REQUIRE_POS);
  146125. int isColFilter = (pCsr->pFilter->flags & FTS3_SEGMENT_COLUMN_FILTER);
  146126. int isPrefix = (pCsr->pFilter->flags & FTS3_SEGMENT_PREFIX);
  146127. int isScan = (pCsr->pFilter->flags & FTS3_SEGMENT_SCAN);
  146128. int isFirst = (pCsr->pFilter->flags & FTS3_SEGMENT_FIRST);
  146129. Fts3SegReader **apSegment = pCsr->apSegment;
  146130. int nSegment = pCsr->nSegment;
  146131. Fts3SegFilter *pFilter = pCsr->pFilter;
  146132. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  146133. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  146134. );
  146135. if( pCsr->nSegment==0 ) return SQLITE_OK;
  146136. do {
  146137. int nMerge;
  146138. int i;
  146139. /* Advance the first pCsr->nAdvance entries in the apSegment[] array
  146140. ** forward. Then sort the list in order of current term again.
  146141. */
  146142. for(i=0; i<pCsr->nAdvance; i++){
  146143. Fts3SegReader *pSeg = apSegment[i];
  146144. if( pSeg->bLookup ){
  146145. fts3SegReaderSetEof(pSeg);
  146146. }else{
  146147. rc = fts3SegReaderNext(p, pSeg, 0);
  146148. }
  146149. if( rc!=SQLITE_OK ) return rc;
  146150. }
  146151. fts3SegReaderSort(apSegment, nSegment, pCsr->nAdvance, fts3SegReaderCmp);
  146152. pCsr->nAdvance = 0;
  146153. /* If all the seg-readers are at EOF, we're finished. return SQLITE_OK. */
  146154. assert( rc==SQLITE_OK );
  146155. if( apSegment[0]->aNode==0 ) break;
  146156. pCsr->nTerm = apSegment[0]->nTerm;
  146157. pCsr->zTerm = apSegment[0]->zTerm;
  146158. /* If this is a prefix-search, and if the term that apSegment[0] points
  146159. ** to does not share a suffix with pFilter->zTerm/nTerm, then all
  146160. ** required callbacks have been made. In this case exit early.
  146161. **
  146162. ** Similarly, if this is a search for an exact match, and the first term
  146163. ** of segment apSegment[0] is not a match, exit early.
  146164. */
  146165. if( pFilter->zTerm && !isScan ){
  146166. if( pCsr->nTerm<pFilter->nTerm
  146167. || (!isPrefix && pCsr->nTerm>pFilter->nTerm)
  146168. || memcmp(pCsr->zTerm, pFilter->zTerm, pFilter->nTerm)
  146169. ){
  146170. break;
  146171. }
  146172. }
  146173. nMerge = 1;
  146174. while( nMerge<nSegment
  146175. && apSegment[nMerge]->aNode
  146176. && apSegment[nMerge]->nTerm==pCsr->nTerm
  146177. && 0==memcmp(pCsr->zTerm, apSegment[nMerge]->zTerm, pCsr->nTerm)
  146178. ){
  146179. nMerge++;
  146180. }
  146181. assert( isIgnoreEmpty || (isRequirePos && !isColFilter) );
  146182. if( nMerge==1
  146183. && !isIgnoreEmpty
  146184. && !isFirst
  146185. && (p->bDescIdx==0 || fts3SegReaderIsPending(apSegment[0])==0)
  146186. ){
  146187. pCsr->nDoclist = apSegment[0]->nDoclist;
  146188. if( fts3SegReaderIsPending(apSegment[0]) ){
  146189. rc = fts3MsrBufferData(pCsr, apSegment[0]->aDoclist, pCsr->nDoclist);
  146190. pCsr->aDoclist = pCsr->aBuffer;
  146191. }else{
  146192. pCsr->aDoclist = apSegment[0]->aDoclist;
  146193. }
  146194. if( rc==SQLITE_OK ) rc = SQLITE_ROW;
  146195. }else{
  146196. int nDoclist = 0; /* Size of doclist */
  146197. sqlite3_int64 iPrev = 0; /* Previous docid stored in doclist */
  146198. /* The current term of the first nMerge entries in the array
  146199. ** of Fts3SegReader objects is the same. The doclists must be merged
  146200. ** and a single term returned with the merged doclist.
  146201. */
  146202. for(i=0; i<nMerge; i++){
  146203. fts3SegReaderFirstDocid(p, apSegment[i]);
  146204. }
  146205. fts3SegReaderSort(apSegment, nMerge, nMerge, xCmp);
  146206. while( apSegment[0]->pOffsetList ){
  146207. int j; /* Number of segments that share a docid */
  146208. char *pList = 0;
  146209. int nList = 0;
  146210. int nByte;
  146211. sqlite3_int64 iDocid = apSegment[0]->iDocid;
  146212. fts3SegReaderNextDocid(p, apSegment[0], &pList, &nList);
  146213. j = 1;
  146214. while( j<nMerge
  146215. && apSegment[j]->pOffsetList
  146216. && apSegment[j]->iDocid==iDocid
  146217. ){
  146218. fts3SegReaderNextDocid(p, apSegment[j], 0, 0);
  146219. j++;
  146220. }
  146221. if( isColFilter ){
  146222. fts3ColumnFilter(pFilter->iCol, 0, &pList, &nList);
  146223. }
  146224. if( !isIgnoreEmpty || nList>0 ){
  146225. /* Calculate the 'docid' delta value to write into the merged
  146226. ** doclist. */
  146227. sqlite3_int64 iDelta;
  146228. if( p->bDescIdx && nDoclist>0 ){
  146229. iDelta = iPrev - iDocid;
  146230. }else{
  146231. iDelta = iDocid - iPrev;
  146232. }
  146233. assert( iDelta>0 || (nDoclist==0 && iDelta==iDocid) );
  146234. assert( nDoclist>0 || iDelta==iDocid );
  146235. nByte = sqlite3Fts3VarintLen(iDelta) + (isRequirePos?nList+1:0);
  146236. if( nDoclist+nByte>pCsr->nBuffer ){
  146237. char *aNew;
  146238. pCsr->nBuffer = (nDoclist+nByte)*2;
  146239. aNew = sqlite3_realloc(pCsr->aBuffer, pCsr->nBuffer);
  146240. if( !aNew ){
  146241. return SQLITE_NOMEM;
  146242. }
  146243. pCsr->aBuffer = aNew;
  146244. }
  146245. if( isFirst ){
  146246. char *a = &pCsr->aBuffer[nDoclist];
  146247. int nWrite;
  146248. nWrite = sqlite3Fts3FirstFilter(iDelta, pList, nList, a);
  146249. if( nWrite ){
  146250. iPrev = iDocid;
  146251. nDoclist += nWrite;
  146252. }
  146253. }else{
  146254. nDoclist += sqlite3Fts3PutVarint(&pCsr->aBuffer[nDoclist], iDelta);
  146255. iPrev = iDocid;
  146256. if( isRequirePos ){
  146257. memcpy(&pCsr->aBuffer[nDoclist], pList, nList);
  146258. nDoclist += nList;
  146259. pCsr->aBuffer[nDoclist++] = '\0';
  146260. }
  146261. }
  146262. }
  146263. fts3SegReaderSort(apSegment, nMerge, j, xCmp);
  146264. }
  146265. if( nDoclist>0 ){
  146266. pCsr->aDoclist = pCsr->aBuffer;
  146267. pCsr->nDoclist = nDoclist;
  146268. rc = SQLITE_ROW;
  146269. }
  146270. }
  146271. pCsr->nAdvance = nMerge;
  146272. }while( rc==SQLITE_OK );
  146273. return rc;
  146274. }
  146275. SQLITE_PRIVATE void sqlite3Fts3SegReaderFinish(
  146276. Fts3MultiSegReader *pCsr /* Cursor object */
  146277. ){
  146278. if( pCsr ){
  146279. int i;
  146280. for(i=0; i<pCsr->nSegment; i++){
  146281. sqlite3Fts3SegReaderFree(pCsr->apSegment[i]);
  146282. }
  146283. sqlite3_free(pCsr->apSegment);
  146284. sqlite3_free(pCsr->aBuffer);
  146285. pCsr->nSegment = 0;
  146286. pCsr->apSegment = 0;
  146287. pCsr->aBuffer = 0;
  146288. }
  146289. }
  146290. /*
  146291. ** Decode the "end_block" field, selected by column iCol of the SELECT
  146292. ** statement passed as the first argument.
  146293. **
  146294. ** The "end_block" field may contain either an integer, or a text field
  146295. ** containing the text representation of two non-negative integers separated
  146296. ** by one or more space (0x20) characters. In the first case, set *piEndBlock
  146297. ** to the integer value and *pnByte to zero before returning. In the second,
  146298. ** set *piEndBlock to the first value and *pnByte to the second.
  146299. */
  146300. static void fts3ReadEndBlockField(
  146301. sqlite3_stmt *pStmt,
  146302. int iCol,
  146303. i64 *piEndBlock,
  146304. i64 *pnByte
  146305. ){
  146306. const unsigned char *zText = sqlite3_column_text(pStmt, iCol);
  146307. if( zText ){
  146308. int i;
  146309. int iMul = 1;
  146310. i64 iVal = 0;
  146311. for(i=0; zText[i]>='0' && zText[i]<='9'; i++){
  146312. iVal = iVal*10 + (zText[i] - '0');
  146313. }
  146314. *piEndBlock = iVal;
  146315. while( zText[i]==' ' ) i++;
  146316. iVal = 0;
  146317. if( zText[i]=='-' ){
  146318. i++;
  146319. iMul = -1;
  146320. }
  146321. for(/* no-op */; zText[i]>='0' && zText[i]<='9'; i++){
  146322. iVal = iVal*10 + (zText[i] - '0');
  146323. }
  146324. *pnByte = (iVal * (i64)iMul);
  146325. }
  146326. }
  146327. /*
  146328. ** A segment of size nByte bytes has just been written to absolute level
  146329. ** iAbsLevel. Promote any segments that should be promoted as a result.
  146330. */
  146331. static int fts3PromoteSegments(
  146332. Fts3Table *p, /* FTS table handle */
  146333. sqlite3_int64 iAbsLevel, /* Absolute level just updated */
  146334. sqlite3_int64 nByte /* Size of new segment at iAbsLevel */
  146335. ){
  146336. int rc = SQLITE_OK;
  146337. sqlite3_stmt *pRange;
  146338. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL_RANGE2, &pRange, 0);
  146339. if( rc==SQLITE_OK ){
  146340. int bOk = 0;
  146341. i64 iLast = (iAbsLevel/FTS3_SEGDIR_MAXLEVEL + 1) * FTS3_SEGDIR_MAXLEVEL - 1;
  146342. i64 nLimit = (nByte*3)/2;
  146343. /* Loop through all entries in the %_segdir table corresponding to
  146344. ** segments in this index on levels greater than iAbsLevel. If there is
  146345. ** at least one such segment, and it is possible to determine that all
  146346. ** such segments are smaller than nLimit bytes in size, they will be
  146347. ** promoted to level iAbsLevel. */
  146348. sqlite3_bind_int64(pRange, 1, iAbsLevel+1);
  146349. sqlite3_bind_int64(pRange, 2, iLast);
  146350. while( SQLITE_ROW==sqlite3_step(pRange) ){
  146351. i64 nSize = 0, dummy;
  146352. fts3ReadEndBlockField(pRange, 2, &dummy, &nSize);
  146353. if( nSize<=0 || nSize>nLimit ){
  146354. /* If nSize==0, then the %_segdir.end_block field does not not
  146355. ** contain a size value. This happens if it was written by an
  146356. ** old version of FTS. In this case it is not possible to determine
  146357. ** the size of the segment, and so segment promotion does not
  146358. ** take place. */
  146359. bOk = 0;
  146360. break;
  146361. }
  146362. bOk = 1;
  146363. }
  146364. rc = sqlite3_reset(pRange);
  146365. if( bOk ){
  146366. int iIdx = 0;
  146367. sqlite3_stmt *pUpdate1 = 0;
  146368. sqlite3_stmt *pUpdate2 = 0;
  146369. if( rc==SQLITE_OK ){
  146370. rc = fts3SqlStmt(p, SQL_UPDATE_LEVEL_IDX, &pUpdate1, 0);
  146371. }
  146372. if( rc==SQLITE_OK ){
  146373. rc = fts3SqlStmt(p, SQL_UPDATE_LEVEL, &pUpdate2, 0);
  146374. }
  146375. if( rc==SQLITE_OK ){
  146376. /* Loop through all %_segdir entries for segments in this index with
  146377. ** levels equal to or greater than iAbsLevel. As each entry is visited,
  146378. ** updated it to set (level = -1) and (idx = N), where N is 0 for the
  146379. ** oldest segment in the range, 1 for the next oldest, and so on.
  146380. **
  146381. ** In other words, move all segments being promoted to level -1,
  146382. ** setting the "idx" fields as appropriate to keep them in the same
  146383. ** order. The contents of level -1 (which is never used, except
  146384. ** transiently here), will be moved back to level iAbsLevel below. */
  146385. sqlite3_bind_int64(pRange, 1, iAbsLevel);
  146386. while( SQLITE_ROW==sqlite3_step(pRange) ){
  146387. sqlite3_bind_int(pUpdate1, 1, iIdx++);
  146388. sqlite3_bind_int(pUpdate1, 2, sqlite3_column_int(pRange, 0));
  146389. sqlite3_bind_int(pUpdate1, 3, sqlite3_column_int(pRange, 1));
  146390. sqlite3_step(pUpdate1);
  146391. rc = sqlite3_reset(pUpdate1);
  146392. if( rc!=SQLITE_OK ){
  146393. sqlite3_reset(pRange);
  146394. break;
  146395. }
  146396. }
  146397. }
  146398. if( rc==SQLITE_OK ){
  146399. rc = sqlite3_reset(pRange);
  146400. }
  146401. /* Move level -1 to level iAbsLevel */
  146402. if( rc==SQLITE_OK ){
  146403. sqlite3_bind_int64(pUpdate2, 1, iAbsLevel);
  146404. sqlite3_step(pUpdate2);
  146405. rc = sqlite3_reset(pUpdate2);
  146406. }
  146407. }
  146408. }
  146409. return rc;
  146410. }
  146411. /*
  146412. ** Merge all level iLevel segments in the database into a single
  146413. ** iLevel+1 segment. Or, if iLevel<0, merge all segments into a
  146414. ** single segment with a level equal to the numerically largest level
  146415. ** currently present in the database.
  146416. **
  146417. ** If this function is called with iLevel<0, but there is only one
  146418. ** segment in the database, SQLITE_DONE is returned immediately.
  146419. ** Otherwise, if successful, SQLITE_OK is returned. If an error occurs,
  146420. ** an SQLite error code is returned.
  146421. */
  146422. static int fts3SegmentMerge(
  146423. Fts3Table *p,
  146424. int iLangid, /* Language id to merge */
  146425. int iIndex, /* Index in p->aIndex[] to merge */
  146426. int iLevel /* Level to merge */
  146427. ){
  146428. int rc; /* Return code */
  146429. int iIdx = 0; /* Index of new segment */
  146430. sqlite3_int64 iNewLevel = 0; /* Level/index to create new segment at */
  146431. SegmentWriter *pWriter = 0; /* Used to write the new, merged, segment */
  146432. Fts3SegFilter filter; /* Segment term filter condition */
  146433. Fts3MultiSegReader csr; /* Cursor to iterate through level(s) */
  146434. int bIgnoreEmpty = 0; /* True to ignore empty segments */
  146435. i64 iMaxLevel = 0; /* Max level number for this index/langid */
  146436. assert( iLevel==FTS3_SEGCURSOR_ALL
  146437. || iLevel==FTS3_SEGCURSOR_PENDING
  146438. || iLevel>=0
  146439. );
  146440. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  146441. assert( iIndex>=0 && iIndex<p->nIndex );
  146442. rc = sqlite3Fts3SegReaderCursor(p, iLangid, iIndex, iLevel, 0, 0, 1, 0, &csr);
  146443. if( rc!=SQLITE_OK || csr.nSegment==0 ) goto finished;
  146444. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  146445. rc = fts3SegmentMaxLevel(p, iLangid, iIndex, &iMaxLevel);
  146446. if( rc!=SQLITE_OK ) goto finished;
  146447. }
  146448. if( iLevel==FTS3_SEGCURSOR_ALL ){
  146449. /* This call is to merge all segments in the database to a single
  146450. ** segment. The level of the new segment is equal to the numerically
  146451. ** greatest segment level currently present in the database for this
  146452. ** index. The idx of the new segment is always 0. */
  146453. if( csr.nSegment==1 && 0==fts3SegReaderIsPending(csr.apSegment[0]) ){
  146454. rc = SQLITE_DONE;
  146455. goto finished;
  146456. }
  146457. iNewLevel = iMaxLevel;
  146458. bIgnoreEmpty = 1;
  146459. }else{
  146460. /* This call is to merge all segments at level iLevel. find the next
  146461. ** available segment index at level iLevel+1. The call to
  146462. ** fts3AllocateSegdirIdx() will merge the segments at level iLevel+1 to
  146463. ** a single iLevel+2 segment if necessary. */
  146464. assert( FTS3_SEGCURSOR_PENDING==-1 );
  146465. iNewLevel = getAbsoluteLevel(p, iLangid, iIndex, iLevel+1);
  146466. rc = fts3AllocateSegdirIdx(p, iLangid, iIndex, iLevel+1, &iIdx);
  146467. bIgnoreEmpty = (iLevel!=FTS3_SEGCURSOR_PENDING) && (iNewLevel>iMaxLevel);
  146468. }
  146469. if( rc!=SQLITE_OK ) goto finished;
  146470. assert( csr.nSegment>0 );
  146471. assert( iNewLevel>=getAbsoluteLevel(p, iLangid, iIndex, 0) );
  146472. assert( iNewLevel<getAbsoluteLevel(p, iLangid, iIndex,FTS3_SEGDIR_MAXLEVEL) );
  146473. memset(&filter, 0, sizeof(Fts3SegFilter));
  146474. filter.flags = FTS3_SEGMENT_REQUIRE_POS;
  146475. filter.flags |= (bIgnoreEmpty ? FTS3_SEGMENT_IGNORE_EMPTY : 0);
  146476. rc = sqlite3Fts3SegReaderStart(p, &csr, &filter);
  146477. while( SQLITE_OK==rc ){
  146478. rc = sqlite3Fts3SegReaderStep(p, &csr);
  146479. if( rc!=SQLITE_ROW ) break;
  146480. rc = fts3SegWriterAdd(p, &pWriter, 1,
  146481. csr.zTerm, csr.nTerm, csr.aDoclist, csr.nDoclist);
  146482. }
  146483. if( rc!=SQLITE_OK ) goto finished;
  146484. assert( pWriter || bIgnoreEmpty );
  146485. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  146486. rc = fts3DeleteSegdir(
  146487. p, iLangid, iIndex, iLevel, csr.apSegment, csr.nSegment
  146488. );
  146489. if( rc!=SQLITE_OK ) goto finished;
  146490. }
  146491. if( pWriter ){
  146492. rc = fts3SegWriterFlush(p, pWriter, iNewLevel, iIdx);
  146493. if( rc==SQLITE_OK ){
  146494. if( iLevel==FTS3_SEGCURSOR_PENDING || iNewLevel<iMaxLevel ){
  146495. rc = fts3PromoteSegments(p, iNewLevel, pWriter->nLeafData);
  146496. }
  146497. }
  146498. }
  146499. finished:
  146500. fts3SegWriterFree(pWriter);
  146501. sqlite3Fts3SegReaderFinish(&csr);
  146502. return rc;
  146503. }
  146504. /*
  146505. ** Flush the contents of pendingTerms to level 0 segments.
  146506. */
  146507. SQLITE_PRIVATE int sqlite3Fts3PendingTermsFlush(Fts3Table *p){
  146508. int rc = SQLITE_OK;
  146509. int i;
  146510. for(i=0; rc==SQLITE_OK && i<p->nIndex; i++){
  146511. rc = fts3SegmentMerge(p, p->iPrevLangid, i, FTS3_SEGCURSOR_PENDING);
  146512. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  146513. }
  146514. sqlite3Fts3PendingTermsClear(p);
  146515. /* Determine the auto-incr-merge setting if unknown. If enabled,
  146516. ** estimate the number of leaf blocks of content to be written
  146517. */
  146518. if( rc==SQLITE_OK && p->bHasStat
  146519. && p->nAutoincrmerge==0xff && p->nLeafAdd>0
  146520. ){
  146521. sqlite3_stmt *pStmt = 0;
  146522. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pStmt, 0);
  146523. if( rc==SQLITE_OK ){
  146524. sqlite3_bind_int(pStmt, 1, FTS_STAT_AUTOINCRMERGE);
  146525. rc = sqlite3_step(pStmt);
  146526. if( rc==SQLITE_ROW ){
  146527. p->nAutoincrmerge = sqlite3_column_int(pStmt, 0);
  146528. if( p->nAutoincrmerge==1 ) p->nAutoincrmerge = 8;
  146529. }else if( rc==SQLITE_DONE ){
  146530. p->nAutoincrmerge = 0;
  146531. }
  146532. rc = sqlite3_reset(pStmt);
  146533. }
  146534. }
  146535. return rc;
  146536. }
  146537. /*
  146538. ** Encode N integers as varints into a blob.
  146539. */
  146540. static void fts3EncodeIntArray(
  146541. int N, /* The number of integers to encode */
  146542. u32 *a, /* The integer values */
  146543. char *zBuf, /* Write the BLOB here */
  146544. int *pNBuf /* Write number of bytes if zBuf[] used here */
  146545. ){
  146546. int i, j;
  146547. for(i=j=0; i<N; i++){
  146548. j += sqlite3Fts3PutVarint(&zBuf[j], (sqlite3_int64)a[i]);
  146549. }
  146550. *pNBuf = j;
  146551. }
  146552. /*
  146553. ** Decode a blob of varints into N integers
  146554. */
  146555. static void fts3DecodeIntArray(
  146556. int N, /* The number of integers to decode */
  146557. u32 *a, /* Write the integer values */
  146558. const char *zBuf, /* The BLOB containing the varints */
  146559. int nBuf /* size of the BLOB */
  146560. ){
  146561. int i, j;
  146562. UNUSED_PARAMETER(nBuf);
  146563. for(i=j=0; i<N; i++){
  146564. sqlite3_int64 x;
  146565. j += sqlite3Fts3GetVarint(&zBuf[j], &x);
  146566. assert(j<=nBuf);
  146567. a[i] = (u32)(x & 0xffffffff);
  146568. }
  146569. }
  146570. /*
  146571. ** Insert the sizes (in tokens) for each column of the document
  146572. ** with docid equal to p->iPrevDocid. The sizes are encoded as
  146573. ** a blob of varints.
  146574. */
  146575. static void fts3InsertDocsize(
  146576. int *pRC, /* Result code */
  146577. Fts3Table *p, /* Table into which to insert */
  146578. u32 *aSz /* Sizes of each column, in tokens */
  146579. ){
  146580. char *pBlob; /* The BLOB encoding of the document size */
  146581. int nBlob; /* Number of bytes in the BLOB */
  146582. sqlite3_stmt *pStmt; /* Statement used to insert the encoding */
  146583. int rc; /* Result code from subfunctions */
  146584. if( *pRC ) return;
  146585. pBlob = sqlite3_malloc( 10*p->nColumn );
  146586. if( pBlob==0 ){
  146587. *pRC = SQLITE_NOMEM;
  146588. return;
  146589. }
  146590. fts3EncodeIntArray(p->nColumn, aSz, pBlob, &nBlob);
  146591. rc = fts3SqlStmt(p, SQL_REPLACE_DOCSIZE, &pStmt, 0);
  146592. if( rc ){
  146593. sqlite3_free(pBlob);
  146594. *pRC = rc;
  146595. return;
  146596. }
  146597. sqlite3_bind_int64(pStmt, 1, p->iPrevDocid);
  146598. sqlite3_bind_blob(pStmt, 2, pBlob, nBlob, sqlite3_free);
  146599. sqlite3_step(pStmt);
  146600. *pRC = sqlite3_reset(pStmt);
  146601. }
  146602. /*
  146603. ** Record 0 of the %_stat table contains a blob consisting of N varints,
  146604. ** where N is the number of user defined columns in the fts3 table plus
  146605. ** two. If nCol is the number of user defined columns, then values of the
  146606. ** varints are set as follows:
  146607. **
  146608. ** Varint 0: Total number of rows in the table.
  146609. **
  146610. ** Varint 1..nCol: For each column, the total number of tokens stored in
  146611. ** the column for all rows of the table.
  146612. **
  146613. ** Varint 1+nCol: The total size, in bytes, of all text values in all
  146614. ** columns of all rows of the table.
  146615. **
  146616. */
  146617. static void fts3UpdateDocTotals(
  146618. int *pRC, /* The result code */
  146619. Fts3Table *p, /* Table being updated */
  146620. u32 *aSzIns, /* Size increases */
  146621. u32 *aSzDel, /* Size decreases */
  146622. int nChng /* Change in the number of documents */
  146623. ){
  146624. char *pBlob; /* Storage for BLOB written into %_stat */
  146625. int nBlob; /* Size of BLOB written into %_stat */
  146626. u32 *a; /* Array of integers that becomes the BLOB */
  146627. sqlite3_stmt *pStmt; /* Statement for reading and writing */
  146628. int i; /* Loop counter */
  146629. int rc; /* Result code from subfunctions */
  146630. const int nStat = p->nColumn+2;
  146631. if( *pRC ) return;
  146632. a = sqlite3_malloc( (sizeof(u32)+10)*nStat );
  146633. if( a==0 ){
  146634. *pRC = SQLITE_NOMEM;
  146635. return;
  146636. }
  146637. pBlob = (char*)&a[nStat];
  146638. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pStmt, 0);
  146639. if( rc ){
  146640. sqlite3_free(a);
  146641. *pRC = rc;
  146642. return;
  146643. }
  146644. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  146645. if( sqlite3_step(pStmt)==SQLITE_ROW ){
  146646. fts3DecodeIntArray(nStat, a,
  146647. sqlite3_column_blob(pStmt, 0),
  146648. sqlite3_column_bytes(pStmt, 0));
  146649. }else{
  146650. memset(a, 0, sizeof(u32)*(nStat) );
  146651. }
  146652. rc = sqlite3_reset(pStmt);
  146653. if( rc!=SQLITE_OK ){
  146654. sqlite3_free(a);
  146655. *pRC = rc;
  146656. return;
  146657. }
  146658. if( nChng<0 && a[0]<(u32)(-nChng) ){
  146659. a[0] = 0;
  146660. }else{
  146661. a[0] += nChng;
  146662. }
  146663. for(i=0; i<p->nColumn+1; i++){
  146664. u32 x = a[i+1];
  146665. if( x+aSzIns[i] < aSzDel[i] ){
  146666. x = 0;
  146667. }else{
  146668. x = x + aSzIns[i] - aSzDel[i];
  146669. }
  146670. a[i+1] = x;
  146671. }
  146672. fts3EncodeIntArray(nStat, a, pBlob, &nBlob);
  146673. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pStmt, 0);
  146674. if( rc ){
  146675. sqlite3_free(a);
  146676. *pRC = rc;
  146677. return;
  146678. }
  146679. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  146680. sqlite3_bind_blob(pStmt, 2, pBlob, nBlob, SQLITE_STATIC);
  146681. sqlite3_step(pStmt);
  146682. *pRC = sqlite3_reset(pStmt);
  146683. sqlite3_free(a);
  146684. }
  146685. /*
  146686. ** Merge the entire database so that there is one segment for each
  146687. ** iIndex/iLangid combination.
  146688. */
  146689. static int fts3DoOptimize(Fts3Table *p, int bReturnDone){
  146690. int bSeenDone = 0;
  146691. int rc;
  146692. sqlite3_stmt *pAllLangid = 0;
  146693. rc = fts3SqlStmt(p, SQL_SELECT_ALL_LANGID, &pAllLangid, 0);
  146694. if( rc==SQLITE_OK ){
  146695. int rc2;
  146696. sqlite3_bind_int(pAllLangid, 1, p->iPrevLangid);
  146697. sqlite3_bind_int(pAllLangid, 2, p->nIndex);
  146698. while( sqlite3_step(pAllLangid)==SQLITE_ROW ){
  146699. int i;
  146700. int iLangid = sqlite3_column_int(pAllLangid, 0);
  146701. for(i=0; rc==SQLITE_OK && i<p->nIndex; i++){
  146702. rc = fts3SegmentMerge(p, iLangid, i, FTS3_SEGCURSOR_ALL);
  146703. if( rc==SQLITE_DONE ){
  146704. bSeenDone = 1;
  146705. rc = SQLITE_OK;
  146706. }
  146707. }
  146708. }
  146709. rc2 = sqlite3_reset(pAllLangid);
  146710. if( rc==SQLITE_OK ) rc = rc2;
  146711. }
  146712. sqlite3Fts3SegmentsClose(p);
  146713. sqlite3Fts3PendingTermsClear(p);
  146714. return (rc==SQLITE_OK && bReturnDone && bSeenDone) ? SQLITE_DONE : rc;
  146715. }
  146716. /*
  146717. ** This function is called when the user executes the following statement:
  146718. **
  146719. ** INSERT INTO <tbl>(<tbl>) VALUES('rebuild');
  146720. **
  146721. ** The entire FTS index is discarded and rebuilt. If the table is one
  146722. ** created using the content=xxx option, then the new index is based on
  146723. ** the current contents of the xxx table. Otherwise, it is rebuilt based
  146724. ** on the contents of the %_content table.
  146725. */
  146726. static int fts3DoRebuild(Fts3Table *p){
  146727. int rc; /* Return Code */
  146728. rc = fts3DeleteAll(p, 0);
  146729. if( rc==SQLITE_OK ){
  146730. u32 *aSz = 0;
  146731. u32 *aSzIns = 0;
  146732. u32 *aSzDel = 0;
  146733. sqlite3_stmt *pStmt = 0;
  146734. int nEntry = 0;
  146735. /* Compose and prepare an SQL statement to loop through the content table */
  146736. char *zSql = sqlite3_mprintf("SELECT %s" , p->zReadExprlist);
  146737. if( !zSql ){
  146738. rc = SQLITE_NOMEM;
  146739. }else{
  146740. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, 0);
  146741. sqlite3_free(zSql);
  146742. }
  146743. if( rc==SQLITE_OK ){
  146744. int nByte = sizeof(u32) * (p->nColumn+1)*3;
  146745. aSz = (u32 *)sqlite3_malloc(nByte);
  146746. if( aSz==0 ){
  146747. rc = SQLITE_NOMEM;
  146748. }else{
  146749. memset(aSz, 0, nByte);
  146750. aSzIns = &aSz[p->nColumn+1];
  146751. aSzDel = &aSzIns[p->nColumn+1];
  146752. }
  146753. }
  146754. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  146755. int iCol;
  146756. int iLangid = langidFromSelect(p, pStmt);
  146757. rc = fts3PendingTermsDocid(p, 0, iLangid, sqlite3_column_int64(pStmt, 0));
  146758. memset(aSz, 0, sizeof(aSz[0]) * (p->nColumn+1));
  146759. for(iCol=0; rc==SQLITE_OK && iCol<p->nColumn; iCol++){
  146760. if( p->abNotindexed[iCol]==0 ){
  146761. const char *z = (const char *) sqlite3_column_text(pStmt, iCol+1);
  146762. rc = fts3PendingTermsAdd(p, iLangid, z, iCol, &aSz[iCol]);
  146763. aSz[p->nColumn] += sqlite3_column_bytes(pStmt, iCol+1);
  146764. }
  146765. }
  146766. if( p->bHasDocsize ){
  146767. fts3InsertDocsize(&rc, p, aSz);
  146768. }
  146769. if( rc!=SQLITE_OK ){
  146770. sqlite3_finalize(pStmt);
  146771. pStmt = 0;
  146772. }else{
  146773. nEntry++;
  146774. for(iCol=0; iCol<=p->nColumn; iCol++){
  146775. aSzIns[iCol] += aSz[iCol];
  146776. }
  146777. }
  146778. }
  146779. if( p->bFts4 ){
  146780. fts3UpdateDocTotals(&rc, p, aSzIns, aSzDel, nEntry);
  146781. }
  146782. sqlite3_free(aSz);
  146783. if( pStmt ){
  146784. int rc2 = sqlite3_finalize(pStmt);
  146785. if( rc==SQLITE_OK ){
  146786. rc = rc2;
  146787. }
  146788. }
  146789. }
  146790. return rc;
  146791. }
  146792. /*
  146793. ** This function opens a cursor used to read the input data for an
  146794. ** incremental merge operation. Specifically, it opens a cursor to scan
  146795. ** the oldest nSeg segments (idx=0 through idx=(nSeg-1)) in absolute
  146796. ** level iAbsLevel.
  146797. */
  146798. static int fts3IncrmergeCsr(
  146799. Fts3Table *p, /* FTS3 table handle */
  146800. sqlite3_int64 iAbsLevel, /* Absolute level to open */
  146801. int nSeg, /* Number of segments to merge */
  146802. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  146803. ){
  146804. int rc; /* Return Code */
  146805. sqlite3_stmt *pStmt = 0; /* Statement used to read %_segdir entry */
  146806. int nByte; /* Bytes allocated at pCsr->apSegment[] */
  146807. /* Allocate space for the Fts3MultiSegReader.aCsr[] array */
  146808. memset(pCsr, 0, sizeof(*pCsr));
  146809. nByte = sizeof(Fts3SegReader *) * nSeg;
  146810. pCsr->apSegment = (Fts3SegReader **)sqlite3_malloc(nByte);
  146811. if( pCsr->apSegment==0 ){
  146812. rc = SQLITE_NOMEM;
  146813. }else{
  146814. memset(pCsr->apSegment, 0, nByte);
  146815. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL, &pStmt, 0);
  146816. }
  146817. if( rc==SQLITE_OK ){
  146818. int i;
  146819. int rc2;
  146820. sqlite3_bind_int64(pStmt, 1, iAbsLevel);
  146821. assert( pCsr->nSegment==0 );
  146822. for(i=0; rc==SQLITE_OK && sqlite3_step(pStmt)==SQLITE_ROW && i<nSeg; i++){
  146823. rc = sqlite3Fts3SegReaderNew(i, 0,
  146824. sqlite3_column_int64(pStmt, 1), /* segdir.start_block */
  146825. sqlite3_column_int64(pStmt, 2), /* segdir.leaves_end_block */
  146826. sqlite3_column_int64(pStmt, 3), /* segdir.end_block */
  146827. sqlite3_column_blob(pStmt, 4), /* segdir.root */
  146828. sqlite3_column_bytes(pStmt, 4), /* segdir.root */
  146829. &pCsr->apSegment[i]
  146830. );
  146831. pCsr->nSegment++;
  146832. }
  146833. rc2 = sqlite3_reset(pStmt);
  146834. if( rc==SQLITE_OK ) rc = rc2;
  146835. }
  146836. return rc;
  146837. }
  146838. typedef struct IncrmergeWriter IncrmergeWriter;
  146839. typedef struct NodeWriter NodeWriter;
  146840. typedef struct Blob Blob;
  146841. typedef struct NodeReader NodeReader;
  146842. /*
  146843. ** An instance of the following structure is used as a dynamic buffer
  146844. ** to build up nodes or other blobs of data in.
  146845. **
  146846. ** The function blobGrowBuffer() is used to extend the allocation.
  146847. */
  146848. struct Blob {
  146849. char *a; /* Pointer to allocation */
  146850. int n; /* Number of valid bytes of data in a[] */
  146851. int nAlloc; /* Allocated size of a[] (nAlloc>=n) */
  146852. };
  146853. /*
  146854. ** This structure is used to build up buffers containing segment b-tree
  146855. ** nodes (blocks).
  146856. */
  146857. struct NodeWriter {
  146858. sqlite3_int64 iBlock; /* Current block id */
  146859. Blob key; /* Last key written to the current block */
  146860. Blob block; /* Current block image */
  146861. };
  146862. /*
  146863. ** An object of this type contains the state required to create or append
  146864. ** to an appendable b-tree segment.
  146865. */
  146866. struct IncrmergeWriter {
  146867. int nLeafEst; /* Space allocated for leaf blocks */
  146868. int nWork; /* Number of leaf pages flushed */
  146869. sqlite3_int64 iAbsLevel; /* Absolute level of input segments */
  146870. int iIdx; /* Index of *output* segment in iAbsLevel+1 */
  146871. sqlite3_int64 iStart; /* Block number of first allocated block */
  146872. sqlite3_int64 iEnd; /* Block number of last allocated block */
  146873. sqlite3_int64 nLeafData; /* Bytes of leaf page data so far */
  146874. u8 bNoLeafData; /* If true, store 0 for segment size */
  146875. NodeWriter aNodeWriter[FTS_MAX_APPENDABLE_HEIGHT];
  146876. };
  146877. /*
  146878. ** An object of the following type is used to read data from a single
  146879. ** FTS segment node. See the following functions:
  146880. **
  146881. ** nodeReaderInit()
  146882. ** nodeReaderNext()
  146883. ** nodeReaderRelease()
  146884. */
  146885. struct NodeReader {
  146886. const char *aNode;
  146887. int nNode;
  146888. int iOff; /* Current offset within aNode[] */
  146889. /* Output variables. Containing the current node entry. */
  146890. sqlite3_int64 iChild; /* Pointer to child node */
  146891. Blob term; /* Current term */
  146892. const char *aDoclist; /* Pointer to doclist */
  146893. int nDoclist; /* Size of doclist in bytes */
  146894. };
  146895. /*
  146896. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  146897. ** Otherwise, if the allocation at pBlob->a is not already at least nMin
  146898. ** bytes in size, extend (realloc) it to be so.
  146899. **
  146900. ** If an OOM error occurs, set *pRc to SQLITE_NOMEM and leave pBlob->a
  146901. ** unmodified. Otherwise, if the allocation succeeds, update pBlob->nAlloc
  146902. ** to reflect the new size of the pBlob->a[] buffer.
  146903. */
  146904. static void blobGrowBuffer(Blob *pBlob, int nMin, int *pRc){
  146905. if( *pRc==SQLITE_OK && nMin>pBlob->nAlloc ){
  146906. int nAlloc = nMin;
  146907. char *a = (char *)sqlite3_realloc(pBlob->a, nAlloc);
  146908. if( a ){
  146909. pBlob->nAlloc = nAlloc;
  146910. pBlob->a = a;
  146911. }else{
  146912. *pRc = SQLITE_NOMEM;
  146913. }
  146914. }
  146915. }
  146916. /*
  146917. ** Attempt to advance the node-reader object passed as the first argument to
  146918. ** the next entry on the node.
  146919. **
  146920. ** Return an error code if an error occurs (SQLITE_NOMEM is possible).
  146921. ** Otherwise return SQLITE_OK. If there is no next entry on the node
  146922. ** (e.g. because the current entry is the last) set NodeReader->aNode to
  146923. ** NULL to indicate EOF. Otherwise, populate the NodeReader structure output
  146924. ** variables for the new entry.
  146925. */
  146926. static int nodeReaderNext(NodeReader *p){
  146927. int bFirst = (p->term.n==0); /* True for first term on the node */
  146928. int nPrefix = 0; /* Bytes to copy from previous term */
  146929. int nSuffix = 0; /* Bytes to append to the prefix */
  146930. int rc = SQLITE_OK; /* Return code */
  146931. assert( p->aNode );
  146932. if( p->iChild && bFirst==0 ) p->iChild++;
  146933. if( p->iOff>=p->nNode ){
  146934. /* EOF */
  146935. p->aNode = 0;
  146936. }else{
  146937. if( bFirst==0 ){
  146938. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &nPrefix);
  146939. }
  146940. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &nSuffix);
  146941. blobGrowBuffer(&p->term, nPrefix+nSuffix, &rc);
  146942. if( rc==SQLITE_OK ){
  146943. memcpy(&p->term.a[nPrefix], &p->aNode[p->iOff], nSuffix);
  146944. p->term.n = nPrefix+nSuffix;
  146945. p->iOff += nSuffix;
  146946. if( p->iChild==0 ){
  146947. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &p->nDoclist);
  146948. p->aDoclist = &p->aNode[p->iOff];
  146949. p->iOff += p->nDoclist;
  146950. }
  146951. }
  146952. }
  146953. assert( p->iOff<=p->nNode );
  146954. return rc;
  146955. }
  146956. /*
  146957. ** Release all dynamic resources held by node-reader object *p.
  146958. */
  146959. static void nodeReaderRelease(NodeReader *p){
  146960. sqlite3_free(p->term.a);
  146961. }
  146962. /*
  146963. ** Initialize a node-reader object to read the node in buffer aNode/nNode.
  146964. **
  146965. ** If successful, SQLITE_OK is returned and the NodeReader object set to
  146966. ** point to the first entry on the node (if any). Otherwise, an SQLite
  146967. ** error code is returned.
  146968. */
  146969. static int nodeReaderInit(NodeReader *p, const char *aNode, int nNode){
  146970. memset(p, 0, sizeof(NodeReader));
  146971. p->aNode = aNode;
  146972. p->nNode = nNode;
  146973. /* Figure out if this is a leaf or an internal node. */
  146974. if( p->aNode[0] ){
  146975. /* An internal node. */
  146976. p->iOff = 1 + sqlite3Fts3GetVarint(&p->aNode[1], &p->iChild);
  146977. }else{
  146978. p->iOff = 1;
  146979. }
  146980. return nodeReaderNext(p);
  146981. }
  146982. /*
  146983. ** This function is called while writing an FTS segment each time a leaf o
  146984. ** node is finished and written to disk. The key (zTerm/nTerm) is guaranteed
  146985. ** to be greater than the largest key on the node just written, but smaller
  146986. ** than or equal to the first key that will be written to the next leaf
  146987. ** node.
  146988. **
  146989. ** The block id of the leaf node just written to disk may be found in
  146990. ** (pWriter->aNodeWriter[0].iBlock) when this function is called.
  146991. */
  146992. static int fts3IncrmergePush(
  146993. Fts3Table *p, /* Fts3 table handle */
  146994. IncrmergeWriter *pWriter, /* Writer object */
  146995. const char *zTerm, /* Term to write to internal node */
  146996. int nTerm /* Bytes at zTerm */
  146997. ){
  146998. sqlite3_int64 iPtr = pWriter->aNodeWriter[0].iBlock;
  146999. int iLayer;
  147000. assert( nTerm>0 );
  147001. for(iLayer=1; ALWAYS(iLayer<FTS_MAX_APPENDABLE_HEIGHT); iLayer++){
  147002. sqlite3_int64 iNextPtr = 0;
  147003. NodeWriter *pNode = &pWriter->aNodeWriter[iLayer];
  147004. int rc = SQLITE_OK;
  147005. int nPrefix;
  147006. int nSuffix;
  147007. int nSpace;
  147008. /* Figure out how much space the key will consume if it is written to
  147009. ** the current node of layer iLayer. Due to the prefix compression,
  147010. ** the space required changes depending on which node the key is to
  147011. ** be added to. */
  147012. nPrefix = fts3PrefixCompress(pNode->key.a, pNode->key.n, zTerm, nTerm);
  147013. nSuffix = nTerm - nPrefix;
  147014. nSpace = sqlite3Fts3VarintLen(nPrefix);
  147015. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  147016. if( pNode->key.n==0 || (pNode->block.n + nSpace)<=p->nNodeSize ){
  147017. /* If the current node of layer iLayer contains zero keys, or if adding
  147018. ** the key to it will not cause it to grow to larger than nNodeSize
  147019. ** bytes in size, write the key here. */
  147020. Blob *pBlk = &pNode->block;
  147021. if( pBlk->n==0 ){
  147022. blobGrowBuffer(pBlk, p->nNodeSize, &rc);
  147023. if( rc==SQLITE_OK ){
  147024. pBlk->a[0] = (char)iLayer;
  147025. pBlk->n = 1 + sqlite3Fts3PutVarint(&pBlk->a[1], iPtr);
  147026. }
  147027. }
  147028. blobGrowBuffer(pBlk, pBlk->n + nSpace, &rc);
  147029. blobGrowBuffer(&pNode->key, nTerm, &rc);
  147030. if( rc==SQLITE_OK ){
  147031. if( pNode->key.n ){
  147032. pBlk->n += sqlite3Fts3PutVarint(&pBlk->a[pBlk->n], nPrefix);
  147033. }
  147034. pBlk->n += sqlite3Fts3PutVarint(&pBlk->a[pBlk->n], nSuffix);
  147035. memcpy(&pBlk->a[pBlk->n], &zTerm[nPrefix], nSuffix);
  147036. pBlk->n += nSuffix;
  147037. memcpy(pNode->key.a, zTerm, nTerm);
  147038. pNode->key.n = nTerm;
  147039. }
  147040. }else{
  147041. /* Otherwise, flush the current node of layer iLayer to disk.
  147042. ** Then allocate a new, empty sibling node. The key will be written
  147043. ** into the parent of this node. */
  147044. rc = fts3WriteSegment(p, pNode->iBlock, pNode->block.a, pNode->block.n);
  147045. assert( pNode->block.nAlloc>=p->nNodeSize );
  147046. pNode->block.a[0] = (char)iLayer;
  147047. pNode->block.n = 1 + sqlite3Fts3PutVarint(&pNode->block.a[1], iPtr+1);
  147048. iNextPtr = pNode->iBlock;
  147049. pNode->iBlock++;
  147050. pNode->key.n = 0;
  147051. }
  147052. if( rc!=SQLITE_OK || iNextPtr==0 ) return rc;
  147053. iPtr = iNextPtr;
  147054. }
  147055. assert( 0 );
  147056. return 0;
  147057. }
  147058. /*
  147059. ** Append a term and (optionally) doclist to the FTS segment node currently
  147060. ** stored in blob *pNode. The node need not contain any terms, but the
  147061. ** header must be written before this function is called.
  147062. **
  147063. ** A node header is a single 0x00 byte for a leaf node, or a height varint
  147064. ** followed by the left-hand-child varint for an internal node.
  147065. **
  147066. ** The term to be appended is passed via arguments zTerm/nTerm. For a
  147067. ** leaf node, the doclist is passed as aDoclist/nDoclist. For an internal
  147068. ** node, both aDoclist and nDoclist must be passed 0.
  147069. **
  147070. ** If the size of the value in blob pPrev is zero, then this is the first
  147071. ** term written to the node. Otherwise, pPrev contains a copy of the
  147072. ** previous term. Before this function returns, it is updated to contain a
  147073. ** copy of zTerm/nTerm.
  147074. **
  147075. ** It is assumed that the buffer associated with pNode is already large
  147076. ** enough to accommodate the new entry. The buffer associated with pPrev
  147077. ** is extended by this function if requrired.
  147078. **
  147079. ** If an error (i.e. OOM condition) occurs, an SQLite error code is
  147080. ** returned. Otherwise, SQLITE_OK.
  147081. */
  147082. static int fts3AppendToNode(
  147083. Blob *pNode, /* Current node image to append to */
  147084. Blob *pPrev, /* Buffer containing previous term written */
  147085. const char *zTerm, /* New term to write */
  147086. int nTerm, /* Size of zTerm in bytes */
  147087. const char *aDoclist, /* Doclist (or NULL) to write */
  147088. int nDoclist /* Size of aDoclist in bytes */
  147089. ){
  147090. int rc = SQLITE_OK; /* Return code */
  147091. int bFirst = (pPrev->n==0); /* True if this is the first term written */
  147092. int nPrefix; /* Size of term prefix in bytes */
  147093. int nSuffix; /* Size of term suffix in bytes */
  147094. /* Node must have already been started. There must be a doclist for a
  147095. ** leaf node, and there must not be a doclist for an internal node. */
  147096. assert( pNode->n>0 );
  147097. assert( (pNode->a[0]=='\0')==(aDoclist!=0) );
  147098. blobGrowBuffer(pPrev, nTerm, &rc);
  147099. if( rc!=SQLITE_OK ) return rc;
  147100. nPrefix = fts3PrefixCompress(pPrev->a, pPrev->n, zTerm, nTerm);
  147101. nSuffix = nTerm - nPrefix;
  147102. memcpy(pPrev->a, zTerm, nTerm);
  147103. pPrev->n = nTerm;
  147104. if( bFirst==0 ){
  147105. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nPrefix);
  147106. }
  147107. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nSuffix);
  147108. memcpy(&pNode->a[pNode->n], &zTerm[nPrefix], nSuffix);
  147109. pNode->n += nSuffix;
  147110. if( aDoclist ){
  147111. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nDoclist);
  147112. memcpy(&pNode->a[pNode->n], aDoclist, nDoclist);
  147113. pNode->n += nDoclist;
  147114. }
  147115. assert( pNode->n<=pNode->nAlloc );
  147116. return SQLITE_OK;
  147117. }
  147118. /*
  147119. ** Append the current term and doclist pointed to by cursor pCsr to the
  147120. ** appendable b-tree segment opened for writing by pWriter.
  147121. **
  147122. ** Return SQLITE_OK if successful, or an SQLite error code otherwise.
  147123. */
  147124. static int fts3IncrmergeAppend(
  147125. Fts3Table *p, /* Fts3 table handle */
  147126. IncrmergeWriter *pWriter, /* Writer object */
  147127. Fts3MultiSegReader *pCsr /* Cursor containing term and doclist */
  147128. ){
  147129. const char *zTerm = pCsr->zTerm;
  147130. int nTerm = pCsr->nTerm;
  147131. const char *aDoclist = pCsr->aDoclist;
  147132. int nDoclist = pCsr->nDoclist;
  147133. int rc = SQLITE_OK; /* Return code */
  147134. int nSpace; /* Total space in bytes required on leaf */
  147135. int nPrefix; /* Size of prefix shared with previous term */
  147136. int nSuffix; /* Size of suffix (nTerm - nPrefix) */
  147137. NodeWriter *pLeaf; /* Object used to write leaf nodes */
  147138. pLeaf = &pWriter->aNodeWriter[0];
  147139. nPrefix = fts3PrefixCompress(pLeaf->key.a, pLeaf->key.n, zTerm, nTerm);
  147140. nSuffix = nTerm - nPrefix;
  147141. nSpace = sqlite3Fts3VarintLen(nPrefix);
  147142. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  147143. nSpace += sqlite3Fts3VarintLen(nDoclist) + nDoclist;
  147144. /* If the current block is not empty, and if adding this term/doclist
  147145. ** to the current block would make it larger than Fts3Table.nNodeSize
  147146. ** bytes, write this block out to the database. */
  147147. if( pLeaf->block.n>0 && (pLeaf->block.n + nSpace)>p->nNodeSize ){
  147148. rc = fts3WriteSegment(p, pLeaf->iBlock, pLeaf->block.a, pLeaf->block.n);
  147149. pWriter->nWork++;
  147150. /* Add the current term to the parent node. The term added to the
  147151. ** parent must:
  147152. **
  147153. ** a) be greater than the largest term on the leaf node just written
  147154. ** to the database (still available in pLeaf->key), and
  147155. **
  147156. ** b) be less than or equal to the term about to be added to the new
  147157. ** leaf node (zTerm/nTerm).
  147158. **
  147159. ** In other words, it must be the prefix of zTerm 1 byte longer than
  147160. ** the common prefix (if any) of zTerm and pWriter->zTerm.
  147161. */
  147162. if( rc==SQLITE_OK ){
  147163. rc = fts3IncrmergePush(p, pWriter, zTerm, nPrefix+1);
  147164. }
  147165. /* Advance to the next output block */
  147166. pLeaf->iBlock++;
  147167. pLeaf->key.n = 0;
  147168. pLeaf->block.n = 0;
  147169. nSuffix = nTerm;
  147170. nSpace = 1;
  147171. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  147172. nSpace += sqlite3Fts3VarintLen(nDoclist) + nDoclist;
  147173. }
  147174. pWriter->nLeafData += nSpace;
  147175. blobGrowBuffer(&pLeaf->block, pLeaf->block.n + nSpace, &rc);
  147176. if( rc==SQLITE_OK ){
  147177. if( pLeaf->block.n==0 ){
  147178. pLeaf->block.n = 1;
  147179. pLeaf->block.a[0] = '\0';
  147180. }
  147181. rc = fts3AppendToNode(
  147182. &pLeaf->block, &pLeaf->key, zTerm, nTerm, aDoclist, nDoclist
  147183. );
  147184. }
  147185. return rc;
  147186. }
  147187. /*
  147188. ** This function is called to release all dynamic resources held by the
  147189. ** merge-writer object pWriter, and if no error has occurred, to flush
  147190. ** all outstanding node buffers held by pWriter to disk.
  147191. **
  147192. ** If *pRc is not SQLITE_OK when this function is called, then no attempt
  147193. ** is made to write any data to disk. Instead, this function serves only
  147194. ** to release outstanding resources.
  147195. **
  147196. ** Otherwise, if *pRc is initially SQLITE_OK and an error occurs while
  147197. ** flushing buffers to disk, *pRc is set to an SQLite error code before
  147198. ** returning.
  147199. */
  147200. static void fts3IncrmergeRelease(
  147201. Fts3Table *p, /* FTS3 table handle */
  147202. IncrmergeWriter *pWriter, /* Merge-writer object */
  147203. int *pRc /* IN/OUT: Error code */
  147204. ){
  147205. int i; /* Used to iterate through non-root layers */
  147206. int iRoot; /* Index of root in pWriter->aNodeWriter */
  147207. NodeWriter *pRoot; /* NodeWriter for root node */
  147208. int rc = *pRc; /* Error code */
  147209. /* Set iRoot to the index in pWriter->aNodeWriter[] of the output segment
  147210. ** root node. If the segment fits entirely on a single leaf node, iRoot
  147211. ** will be set to 0. If the root node is the parent of the leaves, iRoot
  147212. ** will be 1. And so on. */
  147213. for(iRoot=FTS_MAX_APPENDABLE_HEIGHT-1; iRoot>=0; iRoot--){
  147214. NodeWriter *pNode = &pWriter->aNodeWriter[iRoot];
  147215. if( pNode->block.n>0 ) break;
  147216. assert( *pRc || pNode->block.nAlloc==0 );
  147217. assert( *pRc || pNode->key.nAlloc==0 );
  147218. sqlite3_free(pNode->block.a);
  147219. sqlite3_free(pNode->key.a);
  147220. }
  147221. /* Empty output segment. This is a no-op. */
  147222. if( iRoot<0 ) return;
  147223. /* The entire output segment fits on a single node. Normally, this means
  147224. ** the node would be stored as a blob in the "root" column of the %_segdir
  147225. ** table. However, this is not permitted in this case. The problem is that
  147226. ** space has already been reserved in the %_segments table, and so the
  147227. ** start_block and end_block fields of the %_segdir table must be populated.
  147228. ** And, by design or by accident, released versions of FTS cannot handle
  147229. ** segments that fit entirely on the root node with start_block!=0.
  147230. **
  147231. ** Instead, create a synthetic root node that contains nothing but a
  147232. ** pointer to the single content node. So that the segment consists of a
  147233. ** single leaf and a single interior (root) node.
  147234. **
  147235. ** Todo: Better might be to defer allocating space in the %_segments
  147236. ** table until we are sure it is needed.
  147237. */
  147238. if( iRoot==0 ){
  147239. Blob *pBlock = &pWriter->aNodeWriter[1].block;
  147240. blobGrowBuffer(pBlock, 1 + FTS3_VARINT_MAX, &rc);
  147241. if( rc==SQLITE_OK ){
  147242. pBlock->a[0] = 0x01;
  147243. pBlock->n = 1 + sqlite3Fts3PutVarint(
  147244. &pBlock->a[1], pWriter->aNodeWriter[0].iBlock
  147245. );
  147246. }
  147247. iRoot = 1;
  147248. }
  147249. pRoot = &pWriter->aNodeWriter[iRoot];
  147250. /* Flush all currently outstanding nodes to disk. */
  147251. for(i=0; i<iRoot; i++){
  147252. NodeWriter *pNode = &pWriter->aNodeWriter[i];
  147253. if( pNode->block.n>0 && rc==SQLITE_OK ){
  147254. rc = fts3WriteSegment(p, pNode->iBlock, pNode->block.a, pNode->block.n);
  147255. }
  147256. sqlite3_free(pNode->block.a);
  147257. sqlite3_free(pNode->key.a);
  147258. }
  147259. /* Write the %_segdir record. */
  147260. if( rc==SQLITE_OK ){
  147261. rc = fts3WriteSegdir(p,
  147262. pWriter->iAbsLevel+1, /* level */
  147263. pWriter->iIdx, /* idx */
  147264. pWriter->iStart, /* start_block */
  147265. pWriter->aNodeWriter[0].iBlock, /* leaves_end_block */
  147266. pWriter->iEnd, /* end_block */
  147267. (pWriter->bNoLeafData==0 ? pWriter->nLeafData : 0), /* end_block */
  147268. pRoot->block.a, pRoot->block.n /* root */
  147269. );
  147270. }
  147271. sqlite3_free(pRoot->block.a);
  147272. sqlite3_free(pRoot->key.a);
  147273. *pRc = rc;
  147274. }
  147275. /*
  147276. ** Compare the term in buffer zLhs (size in bytes nLhs) with that in
  147277. ** zRhs (size in bytes nRhs) using memcmp. If one term is a prefix of
  147278. ** the other, it is considered to be smaller than the other.
  147279. **
  147280. ** Return -ve if zLhs is smaller than zRhs, 0 if it is equal, or +ve
  147281. ** if it is greater.
  147282. */
  147283. static int fts3TermCmp(
  147284. const char *zLhs, int nLhs, /* LHS of comparison */
  147285. const char *zRhs, int nRhs /* RHS of comparison */
  147286. ){
  147287. int nCmp = MIN(nLhs, nRhs);
  147288. int res;
  147289. res = memcmp(zLhs, zRhs, nCmp);
  147290. if( res==0 ) res = nLhs - nRhs;
  147291. return res;
  147292. }
  147293. /*
  147294. ** Query to see if the entry in the %_segments table with blockid iEnd is
  147295. ** NULL. If no error occurs and the entry is NULL, set *pbRes 1 before
  147296. ** returning. Otherwise, set *pbRes to 0.
  147297. **
  147298. ** Or, if an error occurs while querying the database, return an SQLite
  147299. ** error code. The final value of *pbRes is undefined in this case.
  147300. **
  147301. ** This is used to test if a segment is an "appendable" segment. If it
  147302. ** is, then a NULL entry has been inserted into the %_segments table
  147303. ** with blockid %_segdir.end_block.
  147304. */
  147305. static int fts3IsAppendable(Fts3Table *p, sqlite3_int64 iEnd, int *pbRes){
  147306. int bRes = 0; /* Result to set *pbRes to */
  147307. sqlite3_stmt *pCheck = 0; /* Statement to query database with */
  147308. int rc; /* Return code */
  147309. rc = fts3SqlStmt(p, SQL_SEGMENT_IS_APPENDABLE, &pCheck, 0);
  147310. if( rc==SQLITE_OK ){
  147311. sqlite3_bind_int64(pCheck, 1, iEnd);
  147312. if( SQLITE_ROW==sqlite3_step(pCheck) ) bRes = 1;
  147313. rc = sqlite3_reset(pCheck);
  147314. }
  147315. *pbRes = bRes;
  147316. return rc;
  147317. }
  147318. /*
  147319. ** This function is called when initializing an incremental-merge operation.
  147320. ** It checks if the existing segment with index value iIdx at absolute level
  147321. ** (iAbsLevel+1) can be appended to by the incremental merge. If it can, the
  147322. ** merge-writer object *pWriter is initialized to write to it.
  147323. **
  147324. ** An existing segment can be appended to by an incremental merge if:
  147325. **
  147326. ** * It was initially created as an appendable segment (with all required
  147327. ** space pre-allocated), and
  147328. **
  147329. ** * The first key read from the input (arguments zKey and nKey) is
  147330. ** greater than the largest key currently stored in the potential
  147331. ** output segment.
  147332. */
  147333. static int fts3IncrmergeLoad(
  147334. Fts3Table *p, /* Fts3 table handle */
  147335. sqlite3_int64 iAbsLevel, /* Absolute level of input segments */
  147336. int iIdx, /* Index of candidate output segment */
  147337. const char *zKey, /* First key to write */
  147338. int nKey, /* Number of bytes in nKey */
  147339. IncrmergeWriter *pWriter /* Populate this object */
  147340. ){
  147341. int rc; /* Return code */
  147342. sqlite3_stmt *pSelect = 0; /* SELECT to read %_segdir entry */
  147343. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR, &pSelect, 0);
  147344. if( rc==SQLITE_OK ){
  147345. sqlite3_int64 iStart = 0; /* Value of %_segdir.start_block */
  147346. sqlite3_int64 iLeafEnd = 0; /* Value of %_segdir.leaves_end_block */
  147347. sqlite3_int64 iEnd = 0; /* Value of %_segdir.end_block */
  147348. const char *aRoot = 0; /* Pointer to %_segdir.root buffer */
  147349. int nRoot = 0; /* Size of aRoot[] in bytes */
  147350. int rc2; /* Return code from sqlite3_reset() */
  147351. int bAppendable = 0; /* Set to true if segment is appendable */
  147352. /* Read the %_segdir entry for index iIdx absolute level (iAbsLevel+1) */
  147353. sqlite3_bind_int64(pSelect, 1, iAbsLevel+1);
  147354. sqlite3_bind_int(pSelect, 2, iIdx);
  147355. if( sqlite3_step(pSelect)==SQLITE_ROW ){
  147356. iStart = sqlite3_column_int64(pSelect, 1);
  147357. iLeafEnd = sqlite3_column_int64(pSelect, 2);
  147358. fts3ReadEndBlockField(pSelect, 3, &iEnd, &pWriter->nLeafData);
  147359. if( pWriter->nLeafData<0 ){
  147360. pWriter->nLeafData = pWriter->nLeafData * -1;
  147361. }
  147362. pWriter->bNoLeafData = (pWriter->nLeafData==0);
  147363. nRoot = sqlite3_column_bytes(pSelect, 4);
  147364. aRoot = sqlite3_column_blob(pSelect, 4);
  147365. }else{
  147366. return sqlite3_reset(pSelect);
  147367. }
  147368. /* Check for the zero-length marker in the %_segments table */
  147369. rc = fts3IsAppendable(p, iEnd, &bAppendable);
  147370. /* Check that zKey/nKey is larger than the largest key the candidate */
  147371. if( rc==SQLITE_OK && bAppendable ){
  147372. char *aLeaf = 0;
  147373. int nLeaf = 0;
  147374. rc = sqlite3Fts3ReadBlock(p, iLeafEnd, &aLeaf, &nLeaf, 0);
  147375. if( rc==SQLITE_OK ){
  147376. NodeReader reader;
  147377. for(rc = nodeReaderInit(&reader, aLeaf, nLeaf);
  147378. rc==SQLITE_OK && reader.aNode;
  147379. rc = nodeReaderNext(&reader)
  147380. ){
  147381. assert( reader.aNode );
  147382. }
  147383. if( fts3TermCmp(zKey, nKey, reader.term.a, reader.term.n)<=0 ){
  147384. bAppendable = 0;
  147385. }
  147386. nodeReaderRelease(&reader);
  147387. }
  147388. sqlite3_free(aLeaf);
  147389. }
  147390. if( rc==SQLITE_OK && bAppendable ){
  147391. /* It is possible to append to this segment. Set up the IncrmergeWriter
  147392. ** object to do so. */
  147393. int i;
  147394. int nHeight = (int)aRoot[0];
  147395. NodeWriter *pNode;
  147396. pWriter->nLeafEst = (int)((iEnd - iStart) + 1)/FTS_MAX_APPENDABLE_HEIGHT;
  147397. pWriter->iStart = iStart;
  147398. pWriter->iEnd = iEnd;
  147399. pWriter->iAbsLevel = iAbsLevel;
  147400. pWriter->iIdx = iIdx;
  147401. for(i=nHeight+1; i<FTS_MAX_APPENDABLE_HEIGHT; i++){
  147402. pWriter->aNodeWriter[i].iBlock = pWriter->iStart + i*pWriter->nLeafEst;
  147403. }
  147404. pNode = &pWriter->aNodeWriter[nHeight];
  147405. pNode->iBlock = pWriter->iStart + pWriter->nLeafEst*nHeight;
  147406. blobGrowBuffer(&pNode->block, MAX(nRoot, p->nNodeSize), &rc);
  147407. if( rc==SQLITE_OK ){
  147408. memcpy(pNode->block.a, aRoot, nRoot);
  147409. pNode->block.n = nRoot;
  147410. }
  147411. for(i=nHeight; i>=0 && rc==SQLITE_OK; i--){
  147412. NodeReader reader;
  147413. pNode = &pWriter->aNodeWriter[i];
  147414. rc = nodeReaderInit(&reader, pNode->block.a, pNode->block.n);
  147415. while( reader.aNode && rc==SQLITE_OK ) rc = nodeReaderNext(&reader);
  147416. blobGrowBuffer(&pNode->key, reader.term.n, &rc);
  147417. if( rc==SQLITE_OK ){
  147418. memcpy(pNode->key.a, reader.term.a, reader.term.n);
  147419. pNode->key.n = reader.term.n;
  147420. if( i>0 ){
  147421. char *aBlock = 0;
  147422. int nBlock = 0;
  147423. pNode = &pWriter->aNodeWriter[i-1];
  147424. pNode->iBlock = reader.iChild;
  147425. rc = sqlite3Fts3ReadBlock(p, reader.iChild, &aBlock, &nBlock, 0);
  147426. blobGrowBuffer(&pNode->block, MAX(nBlock, p->nNodeSize), &rc);
  147427. if( rc==SQLITE_OK ){
  147428. memcpy(pNode->block.a, aBlock, nBlock);
  147429. pNode->block.n = nBlock;
  147430. }
  147431. sqlite3_free(aBlock);
  147432. }
  147433. }
  147434. nodeReaderRelease(&reader);
  147435. }
  147436. }
  147437. rc2 = sqlite3_reset(pSelect);
  147438. if( rc==SQLITE_OK ) rc = rc2;
  147439. }
  147440. return rc;
  147441. }
  147442. /*
  147443. ** Determine the largest segment index value that exists within absolute
  147444. ** level iAbsLevel+1. If no error occurs, set *piIdx to this value plus
  147445. ** one before returning SQLITE_OK. Or, if there are no segments at all
  147446. ** within level iAbsLevel, set *piIdx to zero.
  147447. **
  147448. ** If an error occurs, return an SQLite error code. The final value of
  147449. ** *piIdx is undefined in this case.
  147450. */
  147451. static int fts3IncrmergeOutputIdx(
  147452. Fts3Table *p, /* FTS Table handle */
  147453. sqlite3_int64 iAbsLevel, /* Absolute index of input segments */
  147454. int *piIdx /* OUT: Next free index at iAbsLevel+1 */
  147455. ){
  147456. int rc;
  147457. sqlite3_stmt *pOutputIdx = 0; /* SQL used to find output index */
  147458. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENT_INDEX, &pOutputIdx, 0);
  147459. if( rc==SQLITE_OK ){
  147460. sqlite3_bind_int64(pOutputIdx, 1, iAbsLevel+1);
  147461. sqlite3_step(pOutputIdx);
  147462. *piIdx = sqlite3_column_int(pOutputIdx, 0);
  147463. rc = sqlite3_reset(pOutputIdx);
  147464. }
  147465. return rc;
  147466. }
  147467. /*
  147468. ** Allocate an appendable output segment on absolute level iAbsLevel+1
  147469. ** with idx value iIdx.
  147470. **
  147471. ** In the %_segdir table, a segment is defined by the values in three
  147472. ** columns:
  147473. **
  147474. ** start_block
  147475. ** leaves_end_block
  147476. ** end_block
  147477. **
  147478. ** When an appendable segment is allocated, it is estimated that the
  147479. ** maximum number of leaf blocks that may be required is the sum of the
  147480. ** number of leaf blocks consumed by the input segments, plus the number
  147481. ** of input segments, multiplied by two. This value is stored in stack
  147482. ** variable nLeafEst.
  147483. **
  147484. ** A total of 16*nLeafEst blocks are allocated when an appendable segment
  147485. ** is created ((1 + end_block - start_block)==16*nLeafEst). The contiguous
  147486. ** array of leaf nodes starts at the first block allocated. The array
  147487. ** of interior nodes that are parents of the leaf nodes start at block
  147488. ** (start_block + (1 + end_block - start_block) / 16). And so on.
  147489. **
  147490. ** In the actual code below, the value "16" is replaced with the
  147491. ** pre-processor macro FTS_MAX_APPENDABLE_HEIGHT.
  147492. */
  147493. static int fts3IncrmergeWriter(
  147494. Fts3Table *p, /* Fts3 table handle */
  147495. sqlite3_int64 iAbsLevel, /* Absolute level of input segments */
  147496. int iIdx, /* Index of new output segment */
  147497. Fts3MultiSegReader *pCsr, /* Cursor that data will be read from */
  147498. IncrmergeWriter *pWriter /* Populate this object */
  147499. ){
  147500. int rc; /* Return Code */
  147501. int i; /* Iterator variable */
  147502. int nLeafEst = 0; /* Blocks allocated for leaf nodes */
  147503. sqlite3_stmt *pLeafEst = 0; /* SQL used to determine nLeafEst */
  147504. sqlite3_stmt *pFirstBlock = 0; /* SQL used to determine first block */
  147505. /* Calculate nLeafEst. */
  147506. rc = fts3SqlStmt(p, SQL_MAX_LEAF_NODE_ESTIMATE, &pLeafEst, 0);
  147507. if( rc==SQLITE_OK ){
  147508. sqlite3_bind_int64(pLeafEst, 1, iAbsLevel);
  147509. sqlite3_bind_int64(pLeafEst, 2, pCsr->nSegment);
  147510. if( SQLITE_ROW==sqlite3_step(pLeafEst) ){
  147511. nLeafEst = sqlite3_column_int(pLeafEst, 0);
  147512. }
  147513. rc = sqlite3_reset(pLeafEst);
  147514. }
  147515. if( rc!=SQLITE_OK ) return rc;
  147516. /* Calculate the first block to use in the output segment */
  147517. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENTS_ID, &pFirstBlock, 0);
  147518. if( rc==SQLITE_OK ){
  147519. if( SQLITE_ROW==sqlite3_step(pFirstBlock) ){
  147520. pWriter->iStart = sqlite3_column_int64(pFirstBlock, 0);
  147521. pWriter->iEnd = pWriter->iStart - 1;
  147522. pWriter->iEnd += nLeafEst * FTS_MAX_APPENDABLE_HEIGHT;
  147523. }
  147524. rc = sqlite3_reset(pFirstBlock);
  147525. }
  147526. if( rc!=SQLITE_OK ) return rc;
  147527. /* Insert the marker in the %_segments table to make sure nobody tries
  147528. ** to steal the space just allocated. This is also used to identify
  147529. ** appendable segments. */
  147530. rc = fts3WriteSegment(p, pWriter->iEnd, 0, 0);
  147531. if( rc!=SQLITE_OK ) return rc;
  147532. pWriter->iAbsLevel = iAbsLevel;
  147533. pWriter->nLeafEst = nLeafEst;
  147534. pWriter->iIdx = iIdx;
  147535. /* Set up the array of NodeWriter objects */
  147536. for(i=0; i<FTS_MAX_APPENDABLE_HEIGHT; i++){
  147537. pWriter->aNodeWriter[i].iBlock = pWriter->iStart + i*pWriter->nLeafEst;
  147538. }
  147539. return SQLITE_OK;
  147540. }
  147541. /*
  147542. ** Remove an entry from the %_segdir table. This involves running the
  147543. ** following two statements:
  147544. **
  147545. ** DELETE FROM %_segdir WHERE level = :iAbsLevel AND idx = :iIdx
  147546. ** UPDATE %_segdir SET idx = idx - 1 WHERE level = :iAbsLevel AND idx > :iIdx
  147547. **
  147548. ** The DELETE statement removes the specific %_segdir level. The UPDATE
  147549. ** statement ensures that the remaining segments have contiguously allocated
  147550. ** idx values.
  147551. */
  147552. static int fts3RemoveSegdirEntry(
  147553. Fts3Table *p, /* FTS3 table handle */
  147554. sqlite3_int64 iAbsLevel, /* Absolute level to delete from */
  147555. int iIdx /* Index of %_segdir entry to delete */
  147556. ){
  147557. int rc; /* Return code */
  147558. sqlite3_stmt *pDelete = 0; /* DELETE statement */
  147559. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_ENTRY, &pDelete, 0);
  147560. if( rc==SQLITE_OK ){
  147561. sqlite3_bind_int64(pDelete, 1, iAbsLevel);
  147562. sqlite3_bind_int(pDelete, 2, iIdx);
  147563. sqlite3_step(pDelete);
  147564. rc = sqlite3_reset(pDelete);
  147565. }
  147566. return rc;
  147567. }
  147568. /*
  147569. ** One or more segments have just been removed from absolute level iAbsLevel.
  147570. ** Update the 'idx' values of the remaining segments in the level so that
  147571. ** the idx values are a contiguous sequence starting from 0.
  147572. */
  147573. static int fts3RepackSegdirLevel(
  147574. Fts3Table *p, /* FTS3 table handle */
  147575. sqlite3_int64 iAbsLevel /* Absolute level to repack */
  147576. ){
  147577. int rc; /* Return code */
  147578. int *aIdx = 0; /* Array of remaining idx values */
  147579. int nIdx = 0; /* Valid entries in aIdx[] */
  147580. int nAlloc = 0; /* Allocated size of aIdx[] */
  147581. int i; /* Iterator variable */
  147582. sqlite3_stmt *pSelect = 0; /* Select statement to read idx values */
  147583. sqlite3_stmt *pUpdate = 0; /* Update statement to modify idx values */
  147584. rc = fts3SqlStmt(p, SQL_SELECT_INDEXES, &pSelect, 0);
  147585. if( rc==SQLITE_OK ){
  147586. int rc2;
  147587. sqlite3_bind_int64(pSelect, 1, iAbsLevel);
  147588. while( SQLITE_ROW==sqlite3_step(pSelect) ){
  147589. if( nIdx>=nAlloc ){
  147590. int *aNew;
  147591. nAlloc += 16;
  147592. aNew = sqlite3_realloc(aIdx, nAlloc*sizeof(int));
  147593. if( !aNew ){
  147594. rc = SQLITE_NOMEM;
  147595. break;
  147596. }
  147597. aIdx = aNew;
  147598. }
  147599. aIdx[nIdx++] = sqlite3_column_int(pSelect, 0);
  147600. }
  147601. rc2 = sqlite3_reset(pSelect);
  147602. if( rc==SQLITE_OK ) rc = rc2;
  147603. }
  147604. if( rc==SQLITE_OK ){
  147605. rc = fts3SqlStmt(p, SQL_SHIFT_SEGDIR_ENTRY, &pUpdate, 0);
  147606. }
  147607. if( rc==SQLITE_OK ){
  147608. sqlite3_bind_int64(pUpdate, 2, iAbsLevel);
  147609. }
  147610. assert( p->bIgnoreSavepoint==0 );
  147611. p->bIgnoreSavepoint = 1;
  147612. for(i=0; rc==SQLITE_OK && i<nIdx; i++){
  147613. if( aIdx[i]!=i ){
  147614. sqlite3_bind_int(pUpdate, 3, aIdx[i]);
  147615. sqlite3_bind_int(pUpdate, 1, i);
  147616. sqlite3_step(pUpdate);
  147617. rc = sqlite3_reset(pUpdate);
  147618. }
  147619. }
  147620. p->bIgnoreSavepoint = 0;
  147621. sqlite3_free(aIdx);
  147622. return rc;
  147623. }
  147624. static void fts3StartNode(Blob *pNode, int iHeight, sqlite3_int64 iChild){
  147625. pNode->a[0] = (char)iHeight;
  147626. if( iChild ){
  147627. assert( pNode->nAlloc>=1+sqlite3Fts3VarintLen(iChild) );
  147628. pNode->n = 1 + sqlite3Fts3PutVarint(&pNode->a[1], iChild);
  147629. }else{
  147630. assert( pNode->nAlloc>=1 );
  147631. pNode->n = 1;
  147632. }
  147633. }
  147634. /*
  147635. ** The first two arguments are a pointer to and the size of a segment b-tree
  147636. ** node. The node may be a leaf or an internal node.
  147637. **
  147638. ** This function creates a new node image in blob object *pNew by copying
  147639. ** all terms that are greater than or equal to zTerm/nTerm (for leaf nodes)
  147640. ** or greater than zTerm/nTerm (for internal nodes) from aNode/nNode.
  147641. */
  147642. static int fts3TruncateNode(
  147643. const char *aNode, /* Current node image */
  147644. int nNode, /* Size of aNode in bytes */
  147645. Blob *pNew, /* OUT: Write new node image here */
  147646. const char *zTerm, /* Omit all terms smaller than this */
  147647. int nTerm, /* Size of zTerm in bytes */
  147648. sqlite3_int64 *piBlock /* OUT: Block number in next layer down */
  147649. ){
  147650. NodeReader reader; /* Reader object */
  147651. Blob prev = {0, 0, 0}; /* Previous term written to new node */
  147652. int rc = SQLITE_OK; /* Return code */
  147653. int bLeaf = aNode[0]=='\0'; /* True for a leaf node */
  147654. /* Allocate required output space */
  147655. blobGrowBuffer(pNew, nNode, &rc);
  147656. if( rc!=SQLITE_OK ) return rc;
  147657. pNew->n = 0;
  147658. /* Populate new node buffer */
  147659. for(rc = nodeReaderInit(&reader, aNode, nNode);
  147660. rc==SQLITE_OK && reader.aNode;
  147661. rc = nodeReaderNext(&reader)
  147662. ){
  147663. if( pNew->n==0 ){
  147664. int res = fts3TermCmp(reader.term.a, reader.term.n, zTerm, nTerm);
  147665. if( res<0 || (bLeaf==0 && res==0) ) continue;
  147666. fts3StartNode(pNew, (int)aNode[0], reader.iChild);
  147667. *piBlock = reader.iChild;
  147668. }
  147669. rc = fts3AppendToNode(
  147670. pNew, &prev, reader.term.a, reader.term.n,
  147671. reader.aDoclist, reader.nDoclist
  147672. );
  147673. if( rc!=SQLITE_OK ) break;
  147674. }
  147675. if( pNew->n==0 ){
  147676. fts3StartNode(pNew, (int)aNode[0], reader.iChild);
  147677. *piBlock = reader.iChild;
  147678. }
  147679. assert( pNew->n<=pNew->nAlloc );
  147680. nodeReaderRelease(&reader);
  147681. sqlite3_free(prev.a);
  147682. return rc;
  147683. }
  147684. /*
  147685. ** Remove all terms smaller than zTerm/nTerm from segment iIdx in absolute
  147686. ** level iAbsLevel. This may involve deleting entries from the %_segments
  147687. ** table, and modifying existing entries in both the %_segments and %_segdir
  147688. ** tables.
  147689. **
  147690. ** SQLITE_OK is returned if the segment is updated successfully. Or an
  147691. ** SQLite error code otherwise.
  147692. */
  147693. static int fts3TruncateSegment(
  147694. Fts3Table *p, /* FTS3 table handle */
  147695. sqlite3_int64 iAbsLevel, /* Absolute level of segment to modify */
  147696. int iIdx, /* Index within level of segment to modify */
  147697. const char *zTerm, /* Remove terms smaller than this */
  147698. int nTerm /* Number of bytes in buffer zTerm */
  147699. ){
  147700. int rc = SQLITE_OK; /* Return code */
  147701. Blob root = {0,0,0}; /* New root page image */
  147702. Blob block = {0,0,0}; /* Buffer used for any other block */
  147703. sqlite3_int64 iBlock = 0; /* Block id */
  147704. sqlite3_int64 iNewStart = 0; /* New value for iStartBlock */
  147705. sqlite3_int64 iOldStart = 0; /* Old value for iStartBlock */
  147706. sqlite3_stmt *pFetch = 0; /* Statement used to fetch segdir */
  147707. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR, &pFetch, 0);
  147708. if( rc==SQLITE_OK ){
  147709. int rc2; /* sqlite3_reset() return code */
  147710. sqlite3_bind_int64(pFetch, 1, iAbsLevel);
  147711. sqlite3_bind_int(pFetch, 2, iIdx);
  147712. if( SQLITE_ROW==sqlite3_step(pFetch) ){
  147713. const char *aRoot = sqlite3_column_blob(pFetch, 4);
  147714. int nRoot = sqlite3_column_bytes(pFetch, 4);
  147715. iOldStart = sqlite3_column_int64(pFetch, 1);
  147716. rc = fts3TruncateNode(aRoot, nRoot, &root, zTerm, nTerm, &iBlock);
  147717. }
  147718. rc2 = sqlite3_reset(pFetch);
  147719. if( rc==SQLITE_OK ) rc = rc2;
  147720. }
  147721. while( rc==SQLITE_OK && iBlock ){
  147722. char *aBlock = 0;
  147723. int nBlock = 0;
  147724. iNewStart = iBlock;
  147725. rc = sqlite3Fts3ReadBlock(p, iBlock, &aBlock, &nBlock, 0);
  147726. if( rc==SQLITE_OK ){
  147727. rc = fts3TruncateNode(aBlock, nBlock, &block, zTerm, nTerm, &iBlock);
  147728. }
  147729. if( rc==SQLITE_OK ){
  147730. rc = fts3WriteSegment(p, iNewStart, block.a, block.n);
  147731. }
  147732. sqlite3_free(aBlock);
  147733. }
  147734. /* Variable iNewStart now contains the first valid leaf node. */
  147735. if( rc==SQLITE_OK && iNewStart ){
  147736. sqlite3_stmt *pDel = 0;
  147737. rc = fts3SqlStmt(p, SQL_DELETE_SEGMENTS_RANGE, &pDel, 0);
  147738. if( rc==SQLITE_OK ){
  147739. sqlite3_bind_int64(pDel, 1, iOldStart);
  147740. sqlite3_bind_int64(pDel, 2, iNewStart-1);
  147741. sqlite3_step(pDel);
  147742. rc = sqlite3_reset(pDel);
  147743. }
  147744. }
  147745. if( rc==SQLITE_OK ){
  147746. sqlite3_stmt *pChomp = 0;
  147747. rc = fts3SqlStmt(p, SQL_CHOMP_SEGDIR, &pChomp, 0);
  147748. if( rc==SQLITE_OK ){
  147749. sqlite3_bind_int64(pChomp, 1, iNewStart);
  147750. sqlite3_bind_blob(pChomp, 2, root.a, root.n, SQLITE_STATIC);
  147751. sqlite3_bind_int64(pChomp, 3, iAbsLevel);
  147752. sqlite3_bind_int(pChomp, 4, iIdx);
  147753. sqlite3_step(pChomp);
  147754. rc = sqlite3_reset(pChomp);
  147755. }
  147756. }
  147757. sqlite3_free(root.a);
  147758. sqlite3_free(block.a);
  147759. return rc;
  147760. }
  147761. /*
  147762. ** This function is called after an incrmental-merge operation has run to
  147763. ** merge (or partially merge) two or more segments from absolute level
  147764. ** iAbsLevel.
  147765. **
  147766. ** Each input segment is either removed from the db completely (if all of
  147767. ** its data was copied to the output segment by the incrmerge operation)
  147768. ** or modified in place so that it no longer contains those entries that
  147769. ** have been duplicated in the output segment.
  147770. */
  147771. static int fts3IncrmergeChomp(
  147772. Fts3Table *p, /* FTS table handle */
  147773. sqlite3_int64 iAbsLevel, /* Absolute level containing segments */
  147774. Fts3MultiSegReader *pCsr, /* Chomp all segments opened by this cursor */
  147775. int *pnRem /* Number of segments not deleted */
  147776. ){
  147777. int i;
  147778. int nRem = 0;
  147779. int rc = SQLITE_OK;
  147780. for(i=pCsr->nSegment-1; i>=0 && rc==SQLITE_OK; i--){
  147781. Fts3SegReader *pSeg = 0;
  147782. int j;
  147783. /* Find the Fts3SegReader object with Fts3SegReader.iIdx==i. It is hiding
  147784. ** somewhere in the pCsr->apSegment[] array. */
  147785. for(j=0; ALWAYS(j<pCsr->nSegment); j++){
  147786. pSeg = pCsr->apSegment[j];
  147787. if( pSeg->iIdx==i ) break;
  147788. }
  147789. assert( j<pCsr->nSegment && pSeg->iIdx==i );
  147790. if( pSeg->aNode==0 ){
  147791. /* Seg-reader is at EOF. Remove the entire input segment. */
  147792. rc = fts3DeleteSegment(p, pSeg);
  147793. if( rc==SQLITE_OK ){
  147794. rc = fts3RemoveSegdirEntry(p, iAbsLevel, pSeg->iIdx);
  147795. }
  147796. *pnRem = 0;
  147797. }else{
  147798. /* The incremental merge did not copy all the data from this
  147799. ** segment to the upper level. The segment is modified in place
  147800. ** so that it contains no keys smaller than zTerm/nTerm. */
  147801. const char *zTerm = pSeg->zTerm;
  147802. int nTerm = pSeg->nTerm;
  147803. rc = fts3TruncateSegment(p, iAbsLevel, pSeg->iIdx, zTerm, nTerm);
  147804. nRem++;
  147805. }
  147806. }
  147807. if( rc==SQLITE_OK && nRem!=pCsr->nSegment ){
  147808. rc = fts3RepackSegdirLevel(p, iAbsLevel);
  147809. }
  147810. *pnRem = nRem;
  147811. return rc;
  147812. }
  147813. /*
  147814. ** Store an incr-merge hint in the database.
  147815. */
  147816. static int fts3IncrmergeHintStore(Fts3Table *p, Blob *pHint){
  147817. sqlite3_stmt *pReplace = 0;
  147818. int rc; /* Return code */
  147819. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pReplace, 0);
  147820. if( rc==SQLITE_OK ){
  147821. sqlite3_bind_int(pReplace, 1, FTS_STAT_INCRMERGEHINT);
  147822. sqlite3_bind_blob(pReplace, 2, pHint->a, pHint->n, SQLITE_STATIC);
  147823. sqlite3_step(pReplace);
  147824. rc = sqlite3_reset(pReplace);
  147825. }
  147826. return rc;
  147827. }
  147828. /*
  147829. ** Load an incr-merge hint from the database. The incr-merge hint, if one
  147830. ** exists, is stored in the rowid==1 row of the %_stat table.
  147831. **
  147832. ** If successful, populate blob *pHint with the value read from the %_stat
  147833. ** table and return SQLITE_OK. Otherwise, if an error occurs, return an
  147834. ** SQLite error code.
  147835. */
  147836. static int fts3IncrmergeHintLoad(Fts3Table *p, Blob *pHint){
  147837. sqlite3_stmt *pSelect = 0;
  147838. int rc;
  147839. pHint->n = 0;
  147840. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pSelect, 0);
  147841. if( rc==SQLITE_OK ){
  147842. int rc2;
  147843. sqlite3_bind_int(pSelect, 1, FTS_STAT_INCRMERGEHINT);
  147844. if( SQLITE_ROW==sqlite3_step(pSelect) ){
  147845. const char *aHint = sqlite3_column_blob(pSelect, 0);
  147846. int nHint = sqlite3_column_bytes(pSelect, 0);
  147847. if( aHint ){
  147848. blobGrowBuffer(pHint, nHint, &rc);
  147849. if( rc==SQLITE_OK ){
  147850. memcpy(pHint->a, aHint, nHint);
  147851. pHint->n = nHint;
  147852. }
  147853. }
  147854. }
  147855. rc2 = sqlite3_reset(pSelect);
  147856. if( rc==SQLITE_OK ) rc = rc2;
  147857. }
  147858. return rc;
  147859. }
  147860. /*
  147861. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  147862. ** Otherwise, append an entry to the hint stored in blob *pHint. Each entry
  147863. ** consists of two varints, the absolute level number of the input segments
  147864. ** and the number of input segments.
  147865. **
  147866. ** If successful, leave *pRc set to SQLITE_OK and return. If an error occurs,
  147867. ** set *pRc to an SQLite error code before returning.
  147868. */
  147869. static void fts3IncrmergeHintPush(
  147870. Blob *pHint, /* Hint blob to append to */
  147871. i64 iAbsLevel, /* First varint to store in hint */
  147872. int nInput, /* Second varint to store in hint */
  147873. int *pRc /* IN/OUT: Error code */
  147874. ){
  147875. blobGrowBuffer(pHint, pHint->n + 2*FTS3_VARINT_MAX, pRc);
  147876. if( *pRc==SQLITE_OK ){
  147877. pHint->n += sqlite3Fts3PutVarint(&pHint->a[pHint->n], iAbsLevel);
  147878. pHint->n += sqlite3Fts3PutVarint(&pHint->a[pHint->n], (i64)nInput);
  147879. }
  147880. }
  147881. /*
  147882. ** Read the last entry (most recently pushed) from the hint blob *pHint
  147883. ** and then remove the entry. Write the two values read to *piAbsLevel and
  147884. ** *pnInput before returning.
  147885. **
  147886. ** If no error occurs, return SQLITE_OK. If the hint blob in *pHint does
  147887. ** not contain at least two valid varints, return SQLITE_CORRUPT_VTAB.
  147888. */
  147889. static int fts3IncrmergeHintPop(Blob *pHint, i64 *piAbsLevel, int *pnInput){
  147890. const int nHint = pHint->n;
  147891. int i;
  147892. i = pHint->n-2;
  147893. while( i>0 && (pHint->a[i-1] & 0x80) ) i--;
  147894. while( i>0 && (pHint->a[i-1] & 0x80) ) i--;
  147895. pHint->n = i;
  147896. i += sqlite3Fts3GetVarint(&pHint->a[i], piAbsLevel);
  147897. i += fts3GetVarint32(&pHint->a[i], pnInput);
  147898. if( i!=nHint ) return FTS_CORRUPT_VTAB;
  147899. return SQLITE_OK;
  147900. }
  147901. /*
  147902. ** Attempt an incremental merge that writes nMerge leaf blocks.
  147903. **
  147904. ** Incremental merges happen nMin segments at a time. The segments
  147905. ** to be merged are the nMin oldest segments (the ones with the smallest
  147906. ** values for the _segdir.idx field) in the highest level that contains
  147907. ** at least nMin segments. Multiple merges might occur in an attempt to
  147908. ** write the quota of nMerge leaf blocks.
  147909. */
  147910. SQLITE_PRIVATE int sqlite3Fts3Incrmerge(Fts3Table *p, int nMerge, int nMin){
  147911. int rc; /* Return code */
  147912. int nRem = nMerge; /* Number of leaf pages yet to be written */
  147913. Fts3MultiSegReader *pCsr; /* Cursor used to read input data */
  147914. Fts3SegFilter *pFilter; /* Filter used with cursor pCsr */
  147915. IncrmergeWriter *pWriter; /* Writer object */
  147916. int nSeg = 0; /* Number of input segments */
  147917. sqlite3_int64 iAbsLevel = 0; /* Absolute level number to work on */
  147918. Blob hint = {0, 0, 0}; /* Hint read from %_stat table */
  147919. int bDirtyHint = 0; /* True if blob 'hint' has been modified */
  147920. /* Allocate space for the cursor, filter and writer objects */
  147921. const int nAlloc = sizeof(*pCsr) + sizeof(*pFilter) + sizeof(*pWriter);
  147922. pWriter = (IncrmergeWriter *)sqlite3_malloc(nAlloc);
  147923. if( !pWriter ) return SQLITE_NOMEM;
  147924. pFilter = (Fts3SegFilter *)&pWriter[1];
  147925. pCsr = (Fts3MultiSegReader *)&pFilter[1];
  147926. rc = fts3IncrmergeHintLoad(p, &hint);
  147927. while( rc==SQLITE_OK && nRem>0 ){
  147928. const i64 nMod = FTS3_SEGDIR_MAXLEVEL * p->nIndex;
  147929. sqlite3_stmt *pFindLevel = 0; /* SQL used to determine iAbsLevel */
  147930. int bUseHint = 0; /* True if attempting to append */
  147931. int iIdx = 0; /* Largest idx in level (iAbsLevel+1) */
  147932. /* Search the %_segdir table for the absolute level with the smallest
  147933. ** relative level number that contains at least nMin segments, if any.
  147934. ** If one is found, set iAbsLevel to the absolute level number and
  147935. ** nSeg to nMin. If no level with at least nMin segments can be found,
  147936. ** set nSeg to -1.
  147937. */
  147938. rc = fts3SqlStmt(p, SQL_FIND_MERGE_LEVEL, &pFindLevel, 0);
  147939. sqlite3_bind_int(pFindLevel, 1, MAX(2, nMin));
  147940. if( sqlite3_step(pFindLevel)==SQLITE_ROW ){
  147941. iAbsLevel = sqlite3_column_int64(pFindLevel, 0);
  147942. nSeg = sqlite3_column_int(pFindLevel, 1);
  147943. assert( nSeg>=2 );
  147944. }else{
  147945. nSeg = -1;
  147946. }
  147947. rc = sqlite3_reset(pFindLevel);
  147948. /* If the hint read from the %_stat table is not empty, check if the
  147949. ** last entry in it specifies a relative level smaller than or equal
  147950. ** to the level identified by the block above (if any). If so, this
  147951. ** iteration of the loop will work on merging at the hinted level.
  147952. */
  147953. if( rc==SQLITE_OK && hint.n ){
  147954. int nHint = hint.n;
  147955. sqlite3_int64 iHintAbsLevel = 0; /* Hint level */
  147956. int nHintSeg = 0; /* Hint number of segments */
  147957. rc = fts3IncrmergeHintPop(&hint, &iHintAbsLevel, &nHintSeg);
  147958. if( nSeg<0 || (iAbsLevel % nMod) >= (iHintAbsLevel % nMod) ){
  147959. iAbsLevel = iHintAbsLevel;
  147960. nSeg = nHintSeg;
  147961. bUseHint = 1;
  147962. bDirtyHint = 1;
  147963. }else{
  147964. /* This undoes the effect of the HintPop() above - so that no entry
  147965. ** is removed from the hint blob. */
  147966. hint.n = nHint;
  147967. }
  147968. }
  147969. /* If nSeg is less that zero, then there is no level with at least
  147970. ** nMin segments and no hint in the %_stat table. No work to do.
  147971. ** Exit early in this case. */
  147972. if( nSeg<0 ) break;
  147973. /* Open a cursor to iterate through the contents of the oldest nSeg
  147974. ** indexes of absolute level iAbsLevel. If this cursor is opened using
  147975. ** the 'hint' parameters, it is possible that there are less than nSeg
  147976. ** segments available in level iAbsLevel. In this case, no work is
  147977. ** done on iAbsLevel - fall through to the next iteration of the loop
  147978. ** to start work on some other level. */
  147979. memset(pWriter, 0, nAlloc);
  147980. pFilter->flags = FTS3_SEGMENT_REQUIRE_POS;
  147981. if( rc==SQLITE_OK ){
  147982. rc = fts3IncrmergeOutputIdx(p, iAbsLevel, &iIdx);
  147983. assert( bUseHint==1 || bUseHint==0 );
  147984. if( iIdx==0 || (bUseHint && iIdx==1) ){
  147985. int bIgnore = 0;
  147986. rc = fts3SegmentIsMaxLevel(p, iAbsLevel+1, &bIgnore);
  147987. if( bIgnore ){
  147988. pFilter->flags |= FTS3_SEGMENT_IGNORE_EMPTY;
  147989. }
  147990. }
  147991. }
  147992. if( rc==SQLITE_OK ){
  147993. rc = fts3IncrmergeCsr(p, iAbsLevel, nSeg, pCsr);
  147994. }
  147995. if( SQLITE_OK==rc && pCsr->nSegment==nSeg
  147996. && SQLITE_OK==(rc = sqlite3Fts3SegReaderStart(p, pCsr, pFilter))
  147997. && SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, pCsr))
  147998. ){
  147999. if( bUseHint && iIdx>0 ){
  148000. const char *zKey = pCsr->zTerm;
  148001. int nKey = pCsr->nTerm;
  148002. rc = fts3IncrmergeLoad(p, iAbsLevel, iIdx-1, zKey, nKey, pWriter);
  148003. }else{
  148004. rc = fts3IncrmergeWriter(p, iAbsLevel, iIdx, pCsr, pWriter);
  148005. }
  148006. if( rc==SQLITE_OK && pWriter->nLeafEst ){
  148007. fts3LogMerge(nSeg, iAbsLevel);
  148008. do {
  148009. rc = fts3IncrmergeAppend(p, pWriter, pCsr);
  148010. if( rc==SQLITE_OK ) rc = sqlite3Fts3SegReaderStep(p, pCsr);
  148011. if( pWriter->nWork>=nRem && rc==SQLITE_ROW ) rc = SQLITE_OK;
  148012. }while( rc==SQLITE_ROW );
  148013. /* Update or delete the input segments */
  148014. if( rc==SQLITE_OK ){
  148015. nRem -= (1 + pWriter->nWork);
  148016. rc = fts3IncrmergeChomp(p, iAbsLevel, pCsr, &nSeg);
  148017. if( nSeg!=0 ){
  148018. bDirtyHint = 1;
  148019. fts3IncrmergeHintPush(&hint, iAbsLevel, nSeg, &rc);
  148020. }
  148021. }
  148022. }
  148023. if( nSeg!=0 ){
  148024. pWriter->nLeafData = pWriter->nLeafData * -1;
  148025. }
  148026. fts3IncrmergeRelease(p, pWriter, &rc);
  148027. if( nSeg==0 && pWriter->bNoLeafData==0 ){
  148028. fts3PromoteSegments(p, iAbsLevel+1, pWriter->nLeafData);
  148029. }
  148030. }
  148031. sqlite3Fts3SegReaderFinish(pCsr);
  148032. }
  148033. /* Write the hint values into the %_stat table for the next incr-merger */
  148034. if( bDirtyHint && rc==SQLITE_OK ){
  148035. rc = fts3IncrmergeHintStore(p, &hint);
  148036. }
  148037. sqlite3_free(pWriter);
  148038. sqlite3_free(hint.a);
  148039. return rc;
  148040. }
  148041. /*
  148042. ** Convert the text beginning at *pz into an integer and return
  148043. ** its value. Advance *pz to point to the first character past
  148044. ** the integer.
  148045. */
  148046. static int fts3Getint(const char **pz){
  148047. const char *z = *pz;
  148048. int i = 0;
  148049. while( (*z)>='0' && (*z)<='9' ) i = 10*i + *(z++) - '0';
  148050. *pz = z;
  148051. return i;
  148052. }
  148053. /*
  148054. ** Process statements of the form:
  148055. **
  148056. ** INSERT INTO table(table) VALUES('merge=A,B');
  148057. **
  148058. ** A and B are integers that decode to be the number of leaf pages
  148059. ** written for the merge, and the minimum number of segments on a level
  148060. ** before it will be selected for a merge, respectively.
  148061. */
  148062. static int fts3DoIncrmerge(
  148063. Fts3Table *p, /* FTS3 table handle */
  148064. const char *zParam /* Nul-terminated string containing "A,B" */
  148065. ){
  148066. int rc;
  148067. int nMin = (FTS3_MERGE_COUNT / 2);
  148068. int nMerge = 0;
  148069. const char *z = zParam;
  148070. /* Read the first integer value */
  148071. nMerge = fts3Getint(&z);
  148072. /* If the first integer value is followed by a ',', read the second
  148073. ** integer value. */
  148074. if( z[0]==',' && z[1]!='\0' ){
  148075. z++;
  148076. nMin = fts3Getint(&z);
  148077. }
  148078. if( z[0]!='\0' || nMin<2 ){
  148079. rc = SQLITE_ERROR;
  148080. }else{
  148081. rc = SQLITE_OK;
  148082. if( !p->bHasStat ){
  148083. assert( p->bFts4==0 );
  148084. sqlite3Fts3CreateStatTable(&rc, p);
  148085. }
  148086. if( rc==SQLITE_OK ){
  148087. rc = sqlite3Fts3Incrmerge(p, nMerge, nMin);
  148088. }
  148089. sqlite3Fts3SegmentsClose(p);
  148090. }
  148091. return rc;
  148092. }
  148093. /*
  148094. ** Process statements of the form:
  148095. **
  148096. ** INSERT INTO table(table) VALUES('automerge=X');
  148097. **
  148098. ** where X is an integer. X==0 means to turn automerge off. X!=0 means
  148099. ** turn it on. The setting is persistent.
  148100. */
  148101. static int fts3DoAutoincrmerge(
  148102. Fts3Table *p, /* FTS3 table handle */
  148103. const char *zParam /* Nul-terminated string containing boolean */
  148104. ){
  148105. int rc = SQLITE_OK;
  148106. sqlite3_stmt *pStmt = 0;
  148107. p->nAutoincrmerge = fts3Getint(&zParam);
  148108. if( p->nAutoincrmerge==1 || p->nAutoincrmerge>FTS3_MERGE_COUNT ){
  148109. p->nAutoincrmerge = 8;
  148110. }
  148111. if( !p->bHasStat ){
  148112. assert( p->bFts4==0 );
  148113. sqlite3Fts3CreateStatTable(&rc, p);
  148114. if( rc ) return rc;
  148115. }
  148116. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pStmt, 0);
  148117. if( rc ) return rc;
  148118. sqlite3_bind_int(pStmt, 1, FTS_STAT_AUTOINCRMERGE);
  148119. sqlite3_bind_int(pStmt, 2, p->nAutoincrmerge);
  148120. sqlite3_step(pStmt);
  148121. rc = sqlite3_reset(pStmt);
  148122. return rc;
  148123. }
  148124. /*
  148125. ** Return a 64-bit checksum for the FTS index entry specified by the
  148126. ** arguments to this function.
  148127. */
  148128. static u64 fts3ChecksumEntry(
  148129. const char *zTerm, /* Pointer to buffer containing term */
  148130. int nTerm, /* Size of zTerm in bytes */
  148131. int iLangid, /* Language id for current row */
  148132. int iIndex, /* Index (0..Fts3Table.nIndex-1) */
  148133. i64 iDocid, /* Docid for current row. */
  148134. int iCol, /* Column number */
  148135. int iPos /* Position */
  148136. ){
  148137. int i;
  148138. u64 ret = (u64)iDocid;
  148139. ret += (ret<<3) + iLangid;
  148140. ret += (ret<<3) + iIndex;
  148141. ret += (ret<<3) + iCol;
  148142. ret += (ret<<3) + iPos;
  148143. for(i=0; i<nTerm; i++) ret += (ret<<3) + zTerm[i];
  148144. return ret;
  148145. }
  148146. /*
  148147. ** Return a checksum of all entries in the FTS index that correspond to
  148148. ** language id iLangid. The checksum is calculated by XORing the checksums
  148149. ** of each individual entry (see fts3ChecksumEntry()) together.
  148150. **
  148151. ** If successful, the checksum value is returned and *pRc set to SQLITE_OK.
  148152. ** Otherwise, if an error occurs, *pRc is set to an SQLite error code. The
  148153. ** return value is undefined in this case.
  148154. */
  148155. static u64 fts3ChecksumIndex(
  148156. Fts3Table *p, /* FTS3 table handle */
  148157. int iLangid, /* Language id to return cksum for */
  148158. int iIndex, /* Index to cksum (0..p->nIndex-1) */
  148159. int *pRc /* OUT: Return code */
  148160. ){
  148161. Fts3SegFilter filter;
  148162. Fts3MultiSegReader csr;
  148163. int rc;
  148164. u64 cksum = 0;
  148165. assert( *pRc==SQLITE_OK );
  148166. memset(&filter, 0, sizeof(filter));
  148167. memset(&csr, 0, sizeof(csr));
  148168. filter.flags = FTS3_SEGMENT_REQUIRE_POS|FTS3_SEGMENT_IGNORE_EMPTY;
  148169. filter.flags |= FTS3_SEGMENT_SCAN;
  148170. rc = sqlite3Fts3SegReaderCursor(
  148171. p, iLangid, iIndex, FTS3_SEGCURSOR_ALL, 0, 0, 0, 1,&csr
  148172. );
  148173. if( rc==SQLITE_OK ){
  148174. rc = sqlite3Fts3SegReaderStart(p, &csr, &filter);
  148175. }
  148176. if( rc==SQLITE_OK ){
  148177. while( SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, &csr)) ){
  148178. char *pCsr = csr.aDoclist;
  148179. char *pEnd = &pCsr[csr.nDoclist];
  148180. i64 iDocid = 0;
  148181. i64 iCol = 0;
  148182. i64 iPos = 0;
  148183. pCsr += sqlite3Fts3GetVarint(pCsr, &iDocid);
  148184. while( pCsr<pEnd ){
  148185. i64 iVal = 0;
  148186. pCsr += sqlite3Fts3GetVarint(pCsr, &iVal);
  148187. if( pCsr<pEnd ){
  148188. if( iVal==0 || iVal==1 ){
  148189. iCol = 0;
  148190. iPos = 0;
  148191. if( iVal ){
  148192. pCsr += sqlite3Fts3GetVarint(pCsr, &iCol);
  148193. }else{
  148194. pCsr += sqlite3Fts3GetVarint(pCsr, &iVal);
  148195. iDocid += iVal;
  148196. }
  148197. }else{
  148198. iPos += (iVal - 2);
  148199. cksum = cksum ^ fts3ChecksumEntry(
  148200. csr.zTerm, csr.nTerm, iLangid, iIndex, iDocid,
  148201. (int)iCol, (int)iPos
  148202. );
  148203. }
  148204. }
  148205. }
  148206. }
  148207. }
  148208. sqlite3Fts3SegReaderFinish(&csr);
  148209. *pRc = rc;
  148210. return cksum;
  148211. }
  148212. /*
  148213. ** Check if the contents of the FTS index match the current contents of the
  148214. ** content table. If no error occurs and the contents do match, set *pbOk
  148215. ** to true and return SQLITE_OK. Or if the contents do not match, set *pbOk
  148216. ** to false before returning.
  148217. **
  148218. ** If an error occurs (e.g. an OOM or IO error), return an SQLite error
  148219. ** code. The final value of *pbOk is undefined in this case.
  148220. */
  148221. static int fts3IntegrityCheck(Fts3Table *p, int *pbOk){
  148222. int rc = SQLITE_OK; /* Return code */
  148223. u64 cksum1 = 0; /* Checksum based on FTS index contents */
  148224. u64 cksum2 = 0; /* Checksum based on %_content contents */
  148225. sqlite3_stmt *pAllLangid = 0; /* Statement to return all language-ids */
  148226. /* This block calculates the checksum according to the FTS index. */
  148227. rc = fts3SqlStmt(p, SQL_SELECT_ALL_LANGID, &pAllLangid, 0);
  148228. if( rc==SQLITE_OK ){
  148229. int rc2;
  148230. sqlite3_bind_int(pAllLangid, 1, p->iPrevLangid);
  148231. sqlite3_bind_int(pAllLangid, 2, p->nIndex);
  148232. while( rc==SQLITE_OK && sqlite3_step(pAllLangid)==SQLITE_ROW ){
  148233. int iLangid = sqlite3_column_int(pAllLangid, 0);
  148234. int i;
  148235. for(i=0; i<p->nIndex; i++){
  148236. cksum1 = cksum1 ^ fts3ChecksumIndex(p, iLangid, i, &rc);
  148237. }
  148238. }
  148239. rc2 = sqlite3_reset(pAllLangid);
  148240. if( rc==SQLITE_OK ) rc = rc2;
  148241. }
  148242. /* This block calculates the checksum according to the %_content table */
  148243. if( rc==SQLITE_OK ){
  148244. sqlite3_tokenizer_module const *pModule = p->pTokenizer->pModule;
  148245. sqlite3_stmt *pStmt = 0;
  148246. char *zSql;
  148247. zSql = sqlite3_mprintf("SELECT %s" , p->zReadExprlist);
  148248. if( !zSql ){
  148249. rc = SQLITE_NOMEM;
  148250. }else{
  148251. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, 0);
  148252. sqlite3_free(zSql);
  148253. }
  148254. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  148255. i64 iDocid = sqlite3_column_int64(pStmt, 0);
  148256. int iLang = langidFromSelect(p, pStmt);
  148257. int iCol;
  148258. for(iCol=0; rc==SQLITE_OK && iCol<p->nColumn; iCol++){
  148259. if( p->abNotindexed[iCol]==0 ){
  148260. const char *zText = (const char *)sqlite3_column_text(pStmt, iCol+1);
  148261. int nText = sqlite3_column_bytes(pStmt, iCol+1);
  148262. sqlite3_tokenizer_cursor *pT = 0;
  148263. rc = sqlite3Fts3OpenTokenizer(p->pTokenizer, iLang, zText, nText,&pT);
  148264. while( rc==SQLITE_OK ){
  148265. char const *zToken; /* Buffer containing token */
  148266. int nToken = 0; /* Number of bytes in token */
  148267. int iDum1 = 0, iDum2 = 0; /* Dummy variables */
  148268. int iPos = 0; /* Position of token in zText */
  148269. rc = pModule->xNext(pT, &zToken, &nToken, &iDum1, &iDum2, &iPos);
  148270. if( rc==SQLITE_OK ){
  148271. int i;
  148272. cksum2 = cksum2 ^ fts3ChecksumEntry(
  148273. zToken, nToken, iLang, 0, iDocid, iCol, iPos
  148274. );
  148275. for(i=1; i<p->nIndex; i++){
  148276. if( p->aIndex[i].nPrefix<=nToken ){
  148277. cksum2 = cksum2 ^ fts3ChecksumEntry(
  148278. zToken, p->aIndex[i].nPrefix, iLang, i, iDocid, iCol, iPos
  148279. );
  148280. }
  148281. }
  148282. }
  148283. }
  148284. if( pT ) pModule->xClose(pT);
  148285. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  148286. }
  148287. }
  148288. }
  148289. sqlite3_finalize(pStmt);
  148290. }
  148291. *pbOk = (cksum1==cksum2);
  148292. return rc;
  148293. }
  148294. /*
  148295. ** Run the integrity-check. If no error occurs and the current contents of
  148296. ** the FTS index are correct, return SQLITE_OK. Or, if the contents of the
  148297. ** FTS index are incorrect, return SQLITE_CORRUPT_VTAB.
  148298. **
  148299. ** Or, if an error (e.g. an OOM or IO error) occurs, return an SQLite
  148300. ** error code.
  148301. **
  148302. ** The integrity-check works as follows. For each token and indexed token
  148303. ** prefix in the document set, a 64-bit checksum is calculated (by code
  148304. ** in fts3ChecksumEntry()) based on the following:
  148305. **
  148306. ** + The index number (0 for the main index, 1 for the first prefix
  148307. ** index etc.),
  148308. ** + The token (or token prefix) text itself,
  148309. ** + The language-id of the row it appears in,
  148310. ** + The docid of the row it appears in,
  148311. ** + The column it appears in, and
  148312. ** + The tokens position within that column.
  148313. **
  148314. ** The checksums for all entries in the index are XORed together to create
  148315. ** a single checksum for the entire index.
  148316. **
  148317. ** The integrity-check code calculates the same checksum in two ways:
  148318. **
  148319. ** 1. By scanning the contents of the FTS index, and
  148320. ** 2. By scanning and tokenizing the content table.
  148321. **
  148322. ** If the two checksums are identical, the integrity-check is deemed to have
  148323. ** passed.
  148324. */
  148325. static int fts3DoIntegrityCheck(
  148326. Fts3Table *p /* FTS3 table handle */
  148327. ){
  148328. int rc;
  148329. int bOk = 0;
  148330. rc = fts3IntegrityCheck(p, &bOk);
  148331. if( rc==SQLITE_OK && bOk==0 ) rc = FTS_CORRUPT_VTAB;
  148332. return rc;
  148333. }
  148334. /*
  148335. ** Handle a 'special' INSERT of the form:
  148336. **
  148337. ** "INSERT INTO tbl(tbl) VALUES(<expr>)"
  148338. **
  148339. ** Argument pVal contains the result of <expr>. Currently the only
  148340. ** meaningful value to insert is the text 'optimize'.
  148341. */
  148342. static int fts3SpecialInsert(Fts3Table *p, sqlite3_value *pVal){
  148343. int rc; /* Return Code */
  148344. const char *zVal = (const char *)sqlite3_value_text(pVal);
  148345. int nVal = sqlite3_value_bytes(pVal);
  148346. if( !zVal ){
  148347. return SQLITE_NOMEM;
  148348. }else if( nVal==8 && 0==sqlite3_strnicmp(zVal, "optimize", 8) ){
  148349. rc = fts3DoOptimize(p, 0);
  148350. }else if( nVal==7 && 0==sqlite3_strnicmp(zVal, "rebuild", 7) ){
  148351. rc = fts3DoRebuild(p);
  148352. }else if( nVal==15 && 0==sqlite3_strnicmp(zVal, "integrity-check", 15) ){
  148353. rc = fts3DoIntegrityCheck(p);
  148354. }else if( nVal>6 && 0==sqlite3_strnicmp(zVal, "merge=", 6) ){
  148355. rc = fts3DoIncrmerge(p, &zVal[6]);
  148356. }else if( nVal>10 && 0==sqlite3_strnicmp(zVal, "automerge=", 10) ){
  148357. rc = fts3DoAutoincrmerge(p, &zVal[10]);
  148358. #ifdef SQLITE_TEST
  148359. }else if( nVal>9 && 0==sqlite3_strnicmp(zVal, "nodesize=", 9) ){
  148360. p->nNodeSize = atoi(&zVal[9]);
  148361. rc = SQLITE_OK;
  148362. }else if( nVal>11 && 0==sqlite3_strnicmp(zVal, "maxpending=", 9) ){
  148363. p->nMaxPendingData = atoi(&zVal[11]);
  148364. rc = SQLITE_OK;
  148365. }else if( nVal>21 && 0==sqlite3_strnicmp(zVal, "test-no-incr-doclist=", 21) ){
  148366. p->bNoIncrDoclist = atoi(&zVal[21]);
  148367. rc = SQLITE_OK;
  148368. #endif
  148369. }else{
  148370. rc = SQLITE_ERROR;
  148371. }
  148372. return rc;
  148373. }
  148374. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  148375. /*
  148376. ** Delete all cached deferred doclists. Deferred doclists are cached
  148377. ** (allocated) by the sqlite3Fts3CacheDeferredDoclists() function.
  148378. */
  148379. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredDoclists(Fts3Cursor *pCsr){
  148380. Fts3DeferredToken *pDef;
  148381. for(pDef=pCsr->pDeferred; pDef; pDef=pDef->pNext){
  148382. fts3PendingListDelete(pDef->pList);
  148383. pDef->pList = 0;
  148384. }
  148385. }
  148386. /*
  148387. ** Free all entries in the pCsr->pDeffered list. Entries are added to
  148388. ** this list using sqlite3Fts3DeferToken().
  148389. */
  148390. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredTokens(Fts3Cursor *pCsr){
  148391. Fts3DeferredToken *pDef;
  148392. Fts3DeferredToken *pNext;
  148393. for(pDef=pCsr->pDeferred; pDef; pDef=pNext){
  148394. pNext = pDef->pNext;
  148395. fts3PendingListDelete(pDef->pList);
  148396. sqlite3_free(pDef);
  148397. }
  148398. pCsr->pDeferred = 0;
  148399. }
  148400. /*
  148401. ** Generate deferred-doclists for all tokens in the pCsr->pDeferred list
  148402. ** based on the row that pCsr currently points to.
  148403. **
  148404. ** A deferred-doclist is like any other doclist with position information
  148405. ** included, except that it only contains entries for a single row of the
  148406. ** table, not for all rows.
  148407. */
  148408. SQLITE_PRIVATE int sqlite3Fts3CacheDeferredDoclists(Fts3Cursor *pCsr){
  148409. int rc = SQLITE_OK; /* Return code */
  148410. if( pCsr->pDeferred ){
  148411. int i; /* Used to iterate through table columns */
  148412. sqlite3_int64 iDocid; /* Docid of the row pCsr points to */
  148413. Fts3DeferredToken *pDef; /* Used to iterate through deferred tokens */
  148414. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  148415. sqlite3_tokenizer *pT = p->pTokenizer;
  148416. sqlite3_tokenizer_module const *pModule = pT->pModule;
  148417. assert( pCsr->isRequireSeek==0 );
  148418. iDocid = sqlite3_column_int64(pCsr->pStmt, 0);
  148419. for(i=0; i<p->nColumn && rc==SQLITE_OK; i++){
  148420. if( p->abNotindexed[i]==0 ){
  148421. const char *zText = (const char *)sqlite3_column_text(pCsr->pStmt, i+1);
  148422. sqlite3_tokenizer_cursor *pTC = 0;
  148423. rc = sqlite3Fts3OpenTokenizer(pT, pCsr->iLangid, zText, -1, &pTC);
  148424. while( rc==SQLITE_OK ){
  148425. char const *zToken; /* Buffer containing token */
  148426. int nToken = 0; /* Number of bytes in token */
  148427. int iDum1 = 0, iDum2 = 0; /* Dummy variables */
  148428. int iPos = 0; /* Position of token in zText */
  148429. rc = pModule->xNext(pTC, &zToken, &nToken, &iDum1, &iDum2, &iPos);
  148430. for(pDef=pCsr->pDeferred; pDef && rc==SQLITE_OK; pDef=pDef->pNext){
  148431. Fts3PhraseToken *pPT = pDef->pToken;
  148432. if( (pDef->iCol>=p->nColumn || pDef->iCol==i)
  148433. && (pPT->bFirst==0 || iPos==0)
  148434. && (pPT->n==nToken || (pPT->isPrefix && pPT->n<nToken))
  148435. && (0==memcmp(zToken, pPT->z, pPT->n))
  148436. ){
  148437. fts3PendingListAppend(&pDef->pList, iDocid, i, iPos, &rc);
  148438. }
  148439. }
  148440. }
  148441. if( pTC ) pModule->xClose(pTC);
  148442. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  148443. }
  148444. }
  148445. for(pDef=pCsr->pDeferred; pDef && rc==SQLITE_OK; pDef=pDef->pNext){
  148446. if( pDef->pList ){
  148447. rc = fts3PendingListAppendVarint(&pDef->pList, 0);
  148448. }
  148449. }
  148450. }
  148451. return rc;
  148452. }
  148453. SQLITE_PRIVATE int sqlite3Fts3DeferredTokenList(
  148454. Fts3DeferredToken *p,
  148455. char **ppData,
  148456. int *pnData
  148457. ){
  148458. char *pRet;
  148459. int nSkip;
  148460. sqlite3_int64 dummy;
  148461. *ppData = 0;
  148462. *pnData = 0;
  148463. if( p->pList==0 ){
  148464. return SQLITE_OK;
  148465. }
  148466. pRet = (char *)sqlite3_malloc(p->pList->nData);
  148467. if( !pRet ) return SQLITE_NOMEM;
  148468. nSkip = sqlite3Fts3GetVarint(p->pList->aData, &dummy);
  148469. *pnData = p->pList->nData - nSkip;
  148470. *ppData = pRet;
  148471. memcpy(pRet, &p->pList->aData[nSkip], *pnData);
  148472. return SQLITE_OK;
  148473. }
  148474. /*
  148475. ** Add an entry for token pToken to the pCsr->pDeferred list.
  148476. */
  148477. SQLITE_PRIVATE int sqlite3Fts3DeferToken(
  148478. Fts3Cursor *pCsr, /* Fts3 table cursor */
  148479. Fts3PhraseToken *pToken, /* Token to defer */
  148480. int iCol /* Column that token must appear in (or -1) */
  148481. ){
  148482. Fts3DeferredToken *pDeferred;
  148483. pDeferred = sqlite3_malloc(sizeof(*pDeferred));
  148484. if( !pDeferred ){
  148485. return SQLITE_NOMEM;
  148486. }
  148487. memset(pDeferred, 0, sizeof(*pDeferred));
  148488. pDeferred->pToken = pToken;
  148489. pDeferred->pNext = pCsr->pDeferred;
  148490. pDeferred->iCol = iCol;
  148491. pCsr->pDeferred = pDeferred;
  148492. assert( pToken->pDeferred==0 );
  148493. pToken->pDeferred = pDeferred;
  148494. return SQLITE_OK;
  148495. }
  148496. #endif
  148497. /*
  148498. ** SQLite value pRowid contains the rowid of a row that may or may not be
  148499. ** present in the FTS3 table. If it is, delete it and adjust the contents
  148500. ** of subsiduary data structures accordingly.
  148501. */
  148502. static int fts3DeleteByRowid(
  148503. Fts3Table *p,
  148504. sqlite3_value *pRowid,
  148505. int *pnChng, /* IN/OUT: Decrement if row is deleted */
  148506. u32 *aSzDel
  148507. ){
  148508. int rc = SQLITE_OK; /* Return code */
  148509. int bFound = 0; /* True if *pRowid really is in the table */
  148510. fts3DeleteTerms(&rc, p, pRowid, aSzDel, &bFound);
  148511. if( bFound && rc==SQLITE_OK ){
  148512. int isEmpty = 0; /* Deleting *pRowid leaves the table empty */
  148513. rc = fts3IsEmpty(p, pRowid, &isEmpty);
  148514. if( rc==SQLITE_OK ){
  148515. if( isEmpty ){
  148516. /* Deleting this row means the whole table is empty. In this case
  148517. ** delete the contents of all three tables and throw away any
  148518. ** data in the pendingTerms hash table. */
  148519. rc = fts3DeleteAll(p, 1);
  148520. *pnChng = 0;
  148521. memset(aSzDel, 0, sizeof(u32) * (p->nColumn+1) * 2);
  148522. }else{
  148523. *pnChng = *pnChng - 1;
  148524. if( p->zContentTbl==0 ){
  148525. fts3SqlExec(&rc, p, SQL_DELETE_CONTENT, &pRowid);
  148526. }
  148527. if( p->bHasDocsize ){
  148528. fts3SqlExec(&rc, p, SQL_DELETE_DOCSIZE, &pRowid);
  148529. }
  148530. }
  148531. }
  148532. }
  148533. return rc;
  148534. }
  148535. /*
  148536. ** This function does the work for the xUpdate method of FTS3 virtual
  148537. ** tables. The schema of the virtual table being:
  148538. **
  148539. ** CREATE TABLE <table name>(
  148540. ** <user columns>,
  148541. ** <table name> HIDDEN,
  148542. ** docid HIDDEN,
  148543. ** <langid> HIDDEN
  148544. ** );
  148545. **
  148546. **
  148547. */
  148548. SQLITE_PRIVATE int sqlite3Fts3UpdateMethod(
  148549. sqlite3_vtab *pVtab, /* FTS3 vtab object */
  148550. int nArg, /* Size of argument array */
  148551. sqlite3_value **apVal, /* Array of arguments */
  148552. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  148553. ){
  148554. Fts3Table *p = (Fts3Table *)pVtab;
  148555. int rc = SQLITE_OK; /* Return Code */
  148556. int isRemove = 0; /* True for an UPDATE or DELETE */
  148557. u32 *aSzIns = 0; /* Sizes of inserted documents */
  148558. u32 *aSzDel = 0; /* Sizes of deleted documents */
  148559. int nChng = 0; /* Net change in number of documents */
  148560. int bInsertDone = 0;
  148561. /* At this point it must be known if the %_stat table exists or not.
  148562. ** So bHasStat may not be 2. */
  148563. assert( p->bHasStat==0 || p->bHasStat==1 );
  148564. assert( p->pSegments==0 );
  148565. assert(
  148566. nArg==1 /* DELETE operations */
  148567. || nArg==(2 + p->nColumn + 3) /* INSERT or UPDATE operations */
  148568. );
  148569. /* Check for a "special" INSERT operation. One of the form:
  148570. **
  148571. ** INSERT INTO xyz(xyz) VALUES('command');
  148572. */
  148573. if( nArg>1
  148574. && sqlite3_value_type(apVal[0])==SQLITE_NULL
  148575. && sqlite3_value_type(apVal[p->nColumn+2])!=SQLITE_NULL
  148576. ){
  148577. rc = fts3SpecialInsert(p, apVal[p->nColumn+2]);
  148578. goto update_out;
  148579. }
  148580. if( nArg>1 && sqlite3_value_int(apVal[2 + p->nColumn + 2])<0 ){
  148581. rc = SQLITE_CONSTRAINT;
  148582. goto update_out;
  148583. }
  148584. /* Allocate space to hold the change in document sizes */
  148585. aSzDel = sqlite3_malloc( sizeof(aSzDel[0])*(p->nColumn+1)*2 );
  148586. if( aSzDel==0 ){
  148587. rc = SQLITE_NOMEM;
  148588. goto update_out;
  148589. }
  148590. aSzIns = &aSzDel[p->nColumn+1];
  148591. memset(aSzDel, 0, sizeof(aSzDel[0])*(p->nColumn+1)*2);
  148592. rc = fts3Writelock(p);
  148593. if( rc!=SQLITE_OK ) goto update_out;
  148594. /* If this is an INSERT operation, or an UPDATE that modifies the rowid
  148595. ** value, then this operation requires constraint handling.
  148596. **
  148597. ** If the on-conflict mode is REPLACE, this means that the existing row
  148598. ** should be deleted from the database before inserting the new row. Or,
  148599. ** if the on-conflict mode is other than REPLACE, then this method must
  148600. ** detect the conflict and return SQLITE_CONSTRAINT before beginning to
  148601. ** modify the database file.
  148602. */
  148603. if( nArg>1 && p->zContentTbl==0 ){
  148604. /* Find the value object that holds the new rowid value. */
  148605. sqlite3_value *pNewRowid = apVal[3+p->nColumn];
  148606. if( sqlite3_value_type(pNewRowid)==SQLITE_NULL ){
  148607. pNewRowid = apVal[1];
  148608. }
  148609. if( sqlite3_value_type(pNewRowid)!=SQLITE_NULL && (
  148610. sqlite3_value_type(apVal[0])==SQLITE_NULL
  148611. || sqlite3_value_int64(apVal[0])!=sqlite3_value_int64(pNewRowid)
  148612. )){
  148613. /* The new rowid is not NULL (in this case the rowid will be
  148614. ** automatically assigned and there is no chance of a conflict), and
  148615. ** the statement is either an INSERT or an UPDATE that modifies the
  148616. ** rowid column. So if the conflict mode is REPLACE, then delete any
  148617. ** existing row with rowid=pNewRowid.
  148618. **
  148619. ** Or, if the conflict mode is not REPLACE, insert the new record into
  148620. ** the %_content table. If we hit the duplicate rowid constraint (or any
  148621. ** other error) while doing so, return immediately.
  148622. **
  148623. ** This branch may also run if pNewRowid contains a value that cannot
  148624. ** be losslessly converted to an integer. In this case, the eventual
  148625. ** call to fts3InsertData() (either just below or further on in this
  148626. ** function) will return SQLITE_MISMATCH. If fts3DeleteByRowid is
  148627. ** invoked, it will delete zero rows (since no row will have
  148628. ** docid=$pNewRowid if $pNewRowid is not an integer value).
  148629. */
  148630. if( sqlite3_vtab_on_conflict(p->db)==SQLITE_REPLACE ){
  148631. rc = fts3DeleteByRowid(p, pNewRowid, &nChng, aSzDel);
  148632. }else{
  148633. rc = fts3InsertData(p, apVal, pRowid);
  148634. bInsertDone = 1;
  148635. }
  148636. }
  148637. }
  148638. if( rc!=SQLITE_OK ){
  148639. goto update_out;
  148640. }
  148641. /* If this is a DELETE or UPDATE operation, remove the old record. */
  148642. if( sqlite3_value_type(apVal[0])!=SQLITE_NULL ){
  148643. assert( sqlite3_value_type(apVal[0])==SQLITE_INTEGER );
  148644. rc = fts3DeleteByRowid(p, apVal[0], &nChng, aSzDel);
  148645. isRemove = 1;
  148646. }
  148647. /* If this is an INSERT or UPDATE operation, insert the new record. */
  148648. if( nArg>1 && rc==SQLITE_OK ){
  148649. int iLangid = sqlite3_value_int(apVal[2 + p->nColumn + 2]);
  148650. if( bInsertDone==0 ){
  148651. rc = fts3InsertData(p, apVal, pRowid);
  148652. if( rc==SQLITE_CONSTRAINT && p->zContentTbl==0 ){
  148653. rc = FTS_CORRUPT_VTAB;
  148654. }
  148655. }
  148656. if( rc==SQLITE_OK && (!isRemove || *pRowid!=p->iPrevDocid ) ){
  148657. rc = fts3PendingTermsDocid(p, 0, iLangid, *pRowid);
  148658. }
  148659. if( rc==SQLITE_OK ){
  148660. assert( p->iPrevDocid==*pRowid );
  148661. rc = fts3InsertTerms(p, iLangid, apVal, aSzIns);
  148662. }
  148663. if( p->bHasDocsize ){
  148664. fts3InsertDocsize(&rc, p, aSzIns);
  148665. }
  148666. nChng++;
  148667. }
  148668. if( p->bFts4 ){
  148669. fts3UpdateDocTotals(&rc, p, aSzIns, aSzDel, nChng);
  148670. }
  148671. update_out:
  148672. sqlite3_free(aSzDel);
  148673. sqlite3Fts3SegmentsClose(p);
  148674. return rc;
  148675. }
  148676. /*
  148677. ** Flush any data in the pending-terms hash table to disk. If successful,
  148678. ** merge all segments in the database (including the new segment, if
  148679. ** there was any data to flush) into a single segment.
  148680. */
  148681. SQLITE_PRIVATE int sqlite3Fts3Optimize(Fts3Table *p){
  148682. int rc;
  148683. rc = sqlite3_exec(p->db, "SAVEPOINT fts3", 0, 0, 0);
  148684. if( rc==SQLITE_OK ){
  148685. rc = fts3DoOptimize(p, 1);
  148686. if( rc==SQLITE_OK || rc==SQLITE_DONE ){
  148687. int rc2 = sqlite3_exec(p->db, "RELEASE fts3", 0, 0, 0);
  148688. if( rc2!=SQLITE_OK ) rc = rc2;
  148689. }else{
  148690. sqlite3_exec(p->db, "ROLLBACK TO fts3", 0, 0, 0);
  148691. sqlite3_exec(p->db, "RELEASE fts3", 0, 0, 0);
  148692. }
  148693. }
  148694. sqlite3Fts3SegmentsClose(p);
  148695. return rc;
  148696. }
  148697. #endif
  148698. /************** End of fts3_write.c ******************************************/
  148699. /************** Begin file fts3_snippet.c ************************************/
  148700. /*
  148701. ** 2009 Oct 23
  148702. **
  148703. ** The author disclaims copyright to this source code. In place of
  148704. ** a legal notice, here is a blessing:
  148705. **
  148706. ** May you do good and not evil.
  148707. ** May you find forgiveness for yourself and forgive others.
  148708. ** May you share freely, never taking more than you give.
  148709. **
  148710. ******************************************************************************
  148711. */
  148712. /* #include "fts3Int.h" */
  148713. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  148714. /* #include <string.h> */
  148715. /* #include <assert.h> */
  148716. /*
  148717. ** Characters that may appear in the second argument to matchinfo().
  148718. */
  148719. #define FTS3_MATCHINFO_NPHRASE 'p' /* 1 value */
  148720. #define FTS3_MATCHINFO_NCOL 'c' /* 1 value */
  148721. #define FTS3_MATCHINFO_NDOC 'n' /* 1 value */
  148722. #define FTS3_MATCHINFO_AVGLENGTH 'a' /* nCol values */
  148723. #define FTS3_MATCHINFO_LENGTH 'l' /* nCol values */
  148724. #define FTS3_MATCHINFO_LCS 's' /* nCol values */
  148725. #define FTS3_MATCHINFO_HITS 'x' /* 3*nCol*nPhrase values */
  148726. #define FTS3_MATCHINFO_LHITS 'y' /* nCol*nPhrase values */
  148727. #define FTS3_MATCHINFO_LHITS_BM 'b' /* nCol*nPhrase values */
  148728. /*
  148729. ** The default value for the second argument to matchinfo().
  148730. */
  148731. #define FTS3_MATCHINFO_DEFAULT "pcx"
  148732. /*
  148733. ** Used as an fts3ExprIterate() context when loading phrase doclists to
  148734. ** Fts3Expr.aDoclist[]/nDoclist.
  148735. */
  148736. typedef struct LoadDoclistCtx LoadDoclistCtx;
  148737. struct LoadDoclistCtx {
  148738. Fts3Cursor *pCsr; /* FTS3 Cursor */
  148739. int nPhrase; /* Number of phrases seen so far */
  148740. int nToken; /* Number of tokens seen so far */
  148741. };
  148742. /*
  148743. ** The following types are used as part of the implementation of the
  148744. ** fts3BestSnippet() routine.
  148745. */
  148746. typedef struct SnippetIter SnippetIter;
  148747. typedef struct SnippetPhrase SnippetPhrase;
  148748. typedef struct SnippetFragment SnippetFragment;
  148749. struct SnippetIter {
  148750. Fts3Cursor *pCsr; /* Cursor snippet is being generated from */
  148751. int iCol; /* Extract snippet from this column */
  148752. int nSnippet; /* Requested snippet length (in tokens) */
  148753. int nPhrase; /* Number of phrases in query */
  148754. SnippetPhrase *aPhrase; /* Array of size nPhrase */
  148755. int iCurrent; /* First token of current snippet */
  148756. };
  148757. struct SnippetPhrase {
  148758. int nToken; /* Number of tokens in phrase */
  148759. char *pList; /* Pointer to start of phrase position list */
  148760. int iHead; /* Next value in position list */
  148761. char *pHead; /* Position list data following iHead */
  148762. int iTail; /* Next value in trailing position list */
  148763. char *pTail; /* Position list data following iTail */
  148764. };
  148765. struct SnippetFragment {
  148766. int iCol; /* Column snippet is extracted from */
  148767. int iPos; /* Index of first token in snippet */
  148768. u64 covered; /* Mask of query phrases covered */
  148769. u64 hlmask; /* Mask of snippet terms to highlight */
  148770. };
  148771. /*
  148772. ** This type is used as an fts3ExprIterate() context object while
  148773. ** accumulating the data returned by the matchinfo() function.
  148774. */
  148775. typedef struct MatchInfo MatchInfo;
  148776. struct MatchInfo {
  148777. Fts3Cursor *pCursor; /* FTS3 Cursor */
  148778. int nCol; /* Number of columns in table */
  148779. int nPhrase; /* Number of matchable phrases in query */
  148780. sqlite3_int64 nDoc; /* Number of docs in database */
  148781. char flag;
  148782. u32 *aMatchinfo; /* Pre-allocated buffer */
  148783. };
  148784. /*
  148785. ** An instance of this structure is used to manage a pair of buffers, each
  148786. ** (nElem * sizeof(u32)) bytes in size. See the MatchinfoBuffer code below
  148787. ** for details.
  148788. */
  148789. struct MatchinfoBuffer {
  148790. u8 aRef[3];
  148791. int nElem;
  148792. int bGlobal; /* Set if global data is loaded */
  148793. char *zMatchinfo;
  148794. u32 aMatchinfo[1];
  148795. };
  148796. /*
  148797. ** The snippet() and offsets() functions both return text values. An instance
  148798. ** of the following structure is used to accumulate those values while the
  148799. ** functions are running. See fts3StringAppend() for details.
  148800. */
  148801. typedef struct StrBuffer StrBuffer;
  148802. struct StrBuffer {
  148803. char *z; /* Pointer to buffer containing string */
  148804. int n; /* Length of z in bytes (excl. nul-term) */
  148805. int nAlloc; /* Allocated size of buffer z in bytes */
  148806. };
  148807. /*************************************************************************
  148808. ** Start of MatchinfoBuffer code.
  148809. */
  148810. /*
  148811. ** Allocate a two-slot MatchinfoBuffer object.
  148812. */
  148813. static MatchinfoBuffer *fts3MIBufferNew(int nElem, const char *zMatchinfo){
  148814. MatchinfoBuffer *pRet;
  148815. int nByte = sizeof(u32) * (2*nElem + 1) + sizeof(MatchinfoBuffer);
  148816. int nStr = (int)strlen(zMatchinfo);
  148817. pRet = sqlite3_malloc(nByte + nStr+1);
  148818. if( pRet ){
  148819. memset(pRet, 0, nByte);
  148820. pRet->aMatchinfo[0] = (u8*)(&pRet->aMatchinfo[1]) - (u8*)pRet;
  148821. pRet->aMatchinfo[1+nElem] = pRet->aMatchinfo[0] + sizeof(u32)*(nElem+1);
  148822. pRet->nElem = nElem;
  148823. pRet->zMatchinfo = ((char*)pRet) + nByte;
  148824. memcpy(pRet->zMatchinfo, zMatchinfo, nStr+1);
  148825. pRet->aRef[0] = 1;
  148826. }
  148827. return pRet;
  148828. }
  148829. static void fts3MIBufferFree(void *p){
  148830. MatchinfoBuffer *pBuf = (MatchinfoBuffer*)((u8*)p - ((u32*)p)[-1]);
  148831. assert( (u32*)p==&pBuf->aMatchinfo[1]
  148832. || (u32*)p==&pBuf->aMatchinfo[pBuf->nElem+2]
  148833. );
  148834. if( (u32*)p==&pBuf->aMatchinfo[1] ){
  148835. pBuf->aRef[1] = 0;
  148836. }else{
  148837. pBuf->aRef[2] = 0;
  148838. }
  148839. if( pBuf->aRef[0]==0 && pBuf->aRef[1]==0 && pBuf->aRef[2]==0 ){
  148840. sqlite3_free(pBuf);
  148841. }
  148842. }
  148843. static void (*fts3MIBufferAlloc(MatchinfoBuffer *p, u32 **paOut))(void*){
  148844. void (*xRet)(void*) = 0;
  148845. u32 *aOut = 0;
  148846. if( p->aRef[1]==0 ){
  148847. p->aRef[1] = 1;
  148848. aOut = &p->aMatchinfo[1];
  148849. xRet = fts3MIBufferFree;
  148850. }
  148851. else if( p->aRef[2]==0 ){
  148852. p->aRef[2] = 1;
  148853. aOut = &p->aMatchinfo[p->nElem+2];
  148854. xRet = fts3MIBufferFree;
  148855. }else{
  148856. aOut = (u32*)sqlite3_malloc(p->nElem * sizeof(u32));
  148857. if( aOut ){
  148858. xRet = sqlite3_free;
  148859. if( p->bGlobal ) memcpy(aOut, &p->aMatchinfo[1], p->nElem*sizeof(u32));
  148860. }
  148861. }
  148862. *paOut = aOut;
  148863. return xRet;
  148864. }
  148865. static void fts3MIBufferSetGlobal(MatchinfoBuffer *p){
  148866. p->bGlobal = 1;
  148867. memcpy(&p->aMatchinfo[2+p->nElem], &p->aMatchinfo[1], p->nElem*sizeof(u32));
  148868. }
  148869. /*
  148870. ** Free a MatchinfoBuffer object allocated using fts3MIBufferNew()
  148871. */
  148872. SQLITE_PRIVATE void sqlite3Fts3MIBufferFree(MatchinfoBuffer *p){
  148873. if( p ){
  148874. assert( p->aRef[0]==1 );
  148875. p->aRef[0] = 0;
  148876. if( p->aRef[0]==0 && p->aRef[1]==0 && p->aRef[2]==0 ){
  148877. sqlite3_free(p);
  148878. }
  148879. }
  148880. }
  148881. /*
  148882. ** End of MatchinfoBuffer code.
  148883. *************************************************************************/
  148884. /*
  148885. ** This function is used to help iterate through a position-list. A position
  148886. ** list is a list of unique integers, sorted from smallest to largest. Each
  148887. ** element of the list is represented by an FTS3 varint that takes the value
  148888. ** of the difference between the current element and the previous one plus
  148889. ** two. For example, to store the position-list:
  148890. **
  148891. ** 4 9 113
  148892. **
  148893. ** the three varints:
  148894. **
  148895. ** 6 7 106
  148896. **
  148897. ** are encoded.
  148898. **
  148899. ** When this function is called, *pp points to the start of an element of
  148900. ** the list. *piPos contains the value of the previous entry in the list.
  148901. ** After it returns, *piPos contains the value of the next element of the
  148902. ** list and *pp is advanced to the following varint.
  148903. */
  148904. static void fts3GetDeltaPosition(char **pp, int *piPos){
  148905. int iVal;
  148906. *pp += fts3GetVarint32(*pp, &iVal);
  148907. *piPos += (iVal-2);
  148908. }
  148909. /*
  148910. ** Helper function for fts3ExprIterate() (see below).
  148911. */
  148912. static int fts3ExprIterate2(
  148913. Fts3Expr *pExpr, /* Expression to iterate phrases of */
  148914. int *piPhrase, /* Pointer to phrase counter */
  148915. int (*x)(Fts3Expr*,int,void*), /* Callback function to invoke for phrases */
  148916. void *pCtx /* Second argument to pass to callback */
  148917. ){
  148918. int rc; /* Return code */
  148919. int eType = pExpr->eType; /* Type of expression node pExpr */
  148920. if( eType!=FTSQUERY_PHRASE ){
  148921. assert( pExpr->pLeft && pExpr->pRight );
  148922. rc = fts3ExprIterate2(pExpr->pLeft, piPhrase, x, pCtx);
  148923. if( rc==SQLITE_OK && eType!=FTSQUERY_NOT ){
  148924. rc = fts3ExprIterate2(pExpr->pRight, piPhrase, x, pCtx);
  148925. }
  148926. }else{
  148927. rc = x(pExpr, *piPhrase, pCtx);
  148928. (*piPhrase)++;
  148929. }
  148930. return rc;
  148931. }
  148932. /*
  148933. ** Iterate through all phrase nodes in an FTS3 query, except those that
  148934. ** are part of a sub-tree that is the right-hand-side of a NOT operator.
  148935. ** For each phrase node found, the supplied callback function is invoked.
  148936. **
  148937. ** If the callback function returns anything other than SQLITE_OK,
  148938. ** the iteration is abandoned and the error code returned immediately.
  148939. ** Otherwise, SQLITE_OK is returned after a callback has been made for
  148940. ** all eligible phrase nodes.
  148941. */
  148942. static int fts3ExprIterate(
  148943. Fts3Expr *pExpr, /* Expression to iterate phrases of */
  148944. int (*x)(Fts3Expr*,int,void*), /* Callback function to invoke for phrases */
  148945. void *pCtx /* Second argument to pass to callback */
  148946. ){
  148947. int iPhrase = 0; /* Variable used as the phrase counter */
  148948. return fts3ExprIterate2(pExpr, &iPhrase, x, pCtx);
  148949. }
  148950. /*
  148951. ** This is an fts3ExprIterate() callback used while loading the doclists
  148952. ** for each phrase into Fts3Expr.aDoclist[]/nDoclist. See also
  148953. ** fts3ExprLoadDoclists().
  148954. */
  148955. static int fts3ExprLoadDoclistsCb(Fts3Expr *pExpr, int iPhrase, void *ctx){
  148956. int rc = SQLITE_OK;
  148957. Fts3Phrase *pPhrase = pExpr->pPhrase;
  148958. LoadDoclistCtx *p = (LoadDoclistCtx *)ctx;
  148959. UNUSED_PARAMETER(iPhrase);
  148960. p->nPhrase++;
  148961. p->nToken += pPhrase->nToken;
  148962. return rc;
  148963. }
  148964. /*
  148965. ** Load the doclists for each phrase in the query associated with FTS3 cursor
  148966. ** pCsr.
  148967. **
  148968. ** If pnPhrase is not NULL, then *pnPhrase is set to the number of matchable
  148969. ** phrases in the expression (all phrases except those directly or
  148970. ** indirectly descended from the right-hand-side of a NOT operator). If
  148971. ** pnToken is not NULL, then it is set to the number of tokens in all
  148972. ** matchable phrases of the expression.
  148973. */
  148974. static int fts3ExprLoadDoclists(
  148975. Fts3Cursor *pCsr, /* Fts3 cursor for current query */
  148976. int *pnPhrase, /* OUT: Number of phrases in query */
  148977. int *pnToken /* OUT: Number of tokens in query */
  148978. ){
  148979. int rc; /* Return Code */
  148980. LoadDoclistCtx sCtx = {0,0,0}; /* Context for fts3ExprIterate() */
  148981. sCtx.pCsr = pCsr;
  148982. rc = fts3ExprIterate(pCsr->pExpr, fts3ExprLoadDoclistsCb, (void *)&sCtx);
  148983. if( pnPhrase ) *pnPhrase = sCtx.nPhrase;
  148984. if( pnToken ) *pnToken = sCtx.nToken;
  148985. return rc;
  148986. }
  148987. static int fts3ExprPhraseCountCb(Fts3Expr *pExpr, int iPhrase, void *ctx){
  148988. (*(int *)ctx)++;
  148989. pExpr->iPhrase = iPhrase;
  148990. return SQLITE_OK;
  148991. }
  148992. static int fts3ExprPhraseCount(Fts3Expr *pExpr){
  148993. int nPhrase = 0;
  148994. (void)fts3ExprIterate(pExpr, fts3ExprPhraseCountCb, (void *)&nPhrase);
  148995. return nPhrase;
  148996. }
  148997. /*
  148998. ** Advance the position list iterator specified by the first two
  148999. ** arguments so that it points to the first element with a value greater
  149000. ** than or equal to parameter iNext.
  149001. */
  149002. static void fts3SnippetAdvance(char **ppIter, int *piIter, int iNext){
  149003. char *pIter = *ppIter;
  149004. if( pIter ){
  149005. int iIter = *piIter;
  149006. while( iIter<iNext ){
  149007. if( 0==(*pIter & 0xFE) ){
  149008. iIter = -1;
  149009. pIter = 0;
  149010. break;
  149011. }
  149012. fts3GetDeltaPosition(&pIter, &iIter);
  149013. }
  149014. *piIter = iIter;
  149015. *ppIter = pIter;
  149016. }
  149017. }
  149018. /*
  149019. ** Advance the snippet iterator to the next candidate snippet.
  149020. */
  149021. static int fts3SnippetNextCandidate(SnippetIter *pIter){
  149022. int i; /* Loop counter */
  149023. if( pIter->iCurrent<0 ){
  149024. /* The SnippetIter object has just been initialized. The first snippet
  149025. ** candidate always starts at offset 0 (even if this candidate has a
  149026. ** score of 0.0).
  149027. */
  149028. pIter->iCurrent = 0;
  149029. /* Advance the 'head' iterator of each phrase to the first offset that
  149030. ** is greater than or equal to (iNext+nSnippet).
  149031. */
  149032. for(i=0; i<pIter->nPhrase; i++){
  149033. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  149034. fts3SnippetAdvance(&pPhrase->pHead, &pPhrase->iHead, pIter->nSnippet);
  149035. }
  149036. }else{
  149037. int iStart;
  149038. int iEnd = 0x7FFFFFFF;
  149039. for(i=0; i<pIter->nPhrase; i++){
  149040. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  149041. if( pPhrase->pHead && pPhrase->iHead<iEnd ){
  149042. iEnd = pPhrase->iHead;
  149043. }
  149044. }
  149045. if( iEnd==0x7FFFFFFF ){
  149046. return 1;
  149047. }
  149048. pIter->iCurrent = iStart = iEnd - pIter->nSnippet + 1;
  149049. for(i=0; i<pIter->nPhrase; i++){
  149050. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  149051. fts3SnippetAdvance(&pPhrase->pHead, &pPhrase->iHead, iEnd+1);
  149052. fts3SnippetAdvance(&pPhrase->pTail, &pPhrase->iTail, iStart);
  149053. }
  149054. }
  149055. return 0;
  149056. }
  149057. /*
  149058. ** Retrieve information about the current candidate snippet of snippet
  149059. ** iterator pIter.
  149060. */
  149061. static void fts3SnippetDetails(
  149062. SnippetIter *pIter, /* Snippet iterator */
  149063. u64 mCovered, /* Bitmask of phrases already covered */
  149064. int *piToken, /* OUT: First token of proposed snippet */
  149065. int *piScore, /* OUT: "Score" for this snippet */
  149066. u64 *pmCover, /* OUT: Bitmask of phrases covered */
  149067. u64 *pmHighlight /* OUT: Bitmask of terms to highlight */
  149068. ){
  149069. int iStart = pIter->iCurrent; /* First token of snippet */
  149070. int iScore = 0; /* Score of this snippet */
  149071. int i; /* Loop counter */
  149072. u64 mCover = 0; /* Mask of phrases covered by this snippet */
  149073. u64 mHighlight = 0; /* Mask of tokens to highlight in snippet */
  149074. for(i=0; i<pIter->nPhrase; i++){
  149075. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  149076. if( pPhrase->pTail ){
  149077. char *pCsr = pPhrase->pTail;
  149078. int iCsr = pPhrase->iTail;
  149079. while( iCsr<(iStart+pIter->nSnippet) ){
  149080. int j;
  149081. u64 mPhrase = (u64)1 << i;
  149082. u64 mPos = (u64)1 << (iCsr - iStart);
  149083. assert( iCsr>=iStart );
  149084. if( (mCover|mCovered)&mPhrase ){
  149085. iScore++;
  149086. }else{
  149087. iScore += 1000;
  149088. }
  149089. mCover |= mPhrase;
  149090. for(j=0; j<pPhrase->nToken; j++){
  149091. mHighlight |= (mPos>>j);
  149092. }
  149093. if( 0==(*pCsr & 0x0FE) ) break;
  149094. fts3GetDeltaPosition(&pCsr, &iCsr);
  149095. }
  149096. }
  149097. }
  149098. /* Set the output variables before returning. */
  149099. *piToken = iStart;
  149100. *piScore = iScore;
  149101. *pmCover = mCover;
  149102. *pmHighlight = mHighlight;
  149103. }
  149104. /*
  149105. ** This function is an fts3ExprIterate() callback used by fts3BestSnippet().
  149106. ** Each invocation populates an element of the SnippetIter.aPhrase[] array.
  149107. */
  149108. static int fts3SnippetFindPositions(Fts3Expr *pExpr, int iPhrase, void *ctx){
  149109. SnippetIter *p = (SnippetIter *)ctx;
  149110. SnippetPhrase *pPhrase = &p->aPhrase[iPhrase];
  149111. char *pCsr;
  149112. int rc;
  149113. pPhrase->nToken = pExpr->pPhrase->nToken;
  149114. rc = sqlite3Fts3EvalPhrasePoslist(p->pCsr, pExpr, p->iCol, &pCsr);
  149115. assert( rc==SQLITE_OK || pCsr==0 );
  149116. if( pCsr ){
  149117. int iFirst = 0;
  149118. pPhrase->pList = pCsr;
  149119. fts3GetDeltaPosition(&pCsr, &iFirst);
  149120. assert( iFirst>=0 );
  149121. pPhrase->pHead = pCsr;
  149122. pPhrase->pTail = pCsr;
  149123. pPhrase->iHead = iFirst;
  149124. pPhrase->iTail = iFirst;
  149125. }else{
  149126. assert( rc!=SQLITE_OK || (
  149127. pPhrase->pList==0 && pPhrase->pHead==0 && pPhrase->pTail==0
  149128. ));
  149129. }
  149130. return rc;
  149131. }
  149132. /*
  149133. ** Select the fragment of text consisting of nFragment contiguous tokens
  149134. ** from column iCol that represent the "best" snippet. The best snippet
  149135. ** is the snippet with the highest score, where scores are calculated
  149136. ** by adding:
  149137. **
  149138. ** (a) +1 point for each occurrence of a matchable phrase in the snippet.
  149139. **
  149140. ** (b) +1000 points for the first occurrence of each matchable phrase in
  149141. ** the snippet for which the corresponding mCovered bit is not set.
  149142. **
  149143. ** The selected snippet parameters are stored in structure *pFragment before
  149144. ** returning. The score of the selected snippet is stored in *piScore
  149145. ** before returning.
  149146. */
  149147. static int fts3BestSnippet(
  149148. int nSnippet, /* Desired snippet length */
  149149. Fts3Cursor *pCsr, /* Cursor to create snippet for */
  149150. int iCol, /* Index of column to create snippet from */
  149151. u64 mCovered, /* Mask of phrases already covered */
  149152. u64 *pmSeen, /* IN/OUT: Mask of phrases seen */
  149153. SnippetFragment *pFragment, /* OUT: Best snippet found */
  149154. int *piScore /* OUT: Score of snippet pFragment */
  149155. ){
  149156. int rc; /* Return Code */
  149157. int nList; /* Number of phrases in expression */
  149158. SnippetIter sIter; /* Iterates through snippet candidates */
  149159. int nByte; /* Number of bytes of space to allocate */
  149160. int iBestScore = -1; /* Best snippet score found so far */
  149161. int i; /* Loop counter */
  149162. memset(&sIter, 0, sizeof(sIter));
  149163. /* Iterate through the phrases in the expression to count them. The same
  149164. ** callback makes sure the doclists are loaded for each phrase.
  149165. */
  149166. rc = fts3ExprLoadDoclists(pCsr, &nList, 0);
  149167. if( rc!=SQLITE_OK ){
  149168. return rc;
  149169. }
  149170. /* Now that it is known how many phrases there are, allocate and zero
  149171. ** the required space using malloc().
  149172. */
  149173. nByte = sizeof(SnippetPhrase) * nList;
  149174. sIter.aPhrase = (SnippetPhrase *)sqlite3_malloc(nByte);
  149175. if( !sIter.aPhrase ){
  149176. return SQLITE_NOMEM;
  149177. }
  149178. memset(sIter.aPhrase, 0, nByte);
  149179. /* Initialize the contents of the SnippetIter object. Then iterate through
  149180. ** the set of phrases in the expression to populate the aPhrase[] array.
  149181. */
  149182. sIter.pCsr = pCsr;
  149183. sIter.iCol = iCol;
  149184. sIter.nSnippet = nSnippet;
  149185. sIter.nPhrase = nList;
  149186. sIter.iCurrent = -1;
  149187. rc = fts3ExprIterate(pCsr->pExpr, fts3SnippetFindPositions, (void*)&sIter);
  149188. if( rc==SQLITE_OK ){
  149189. /* Set the *pmSeen output variable. */
  149190. for(i=0; i<nList; i++){
  149191. if( sIter.aPhrase[i].pHead ){
  149192. *pmSeen |= (u64)1 << i;
  149193. }
  149194. }
  149195. /* Loop through all candidate snippets. Store the best snippet in
  149196. ** *pFragment. Store its associated 'score' in iBestScore.
  149197. */
  149198. pFragment->iCol = iCol;
  149199. while( !fts3SnippetNextCandidate(&sIter) ){
  149200. int iPos;
  149201. int iScore;
  149202. u64 mCover;
  149203. u64 mHighlite;
  149204. fts3SnippetDetails(&sIter, mCovered, &iPos, &iScore, &mCover,&mHighlite);
  149205. assert( iScore>=0 );
  149206. if( iScore>iBestScore ){
  149207. pFragment->iPos = iPos;
  149208. pFragment->hlmask = mHighlite;
  149209. pFragment->covered = mCover;
  149210. iBestScore = iScore;
  149211. }
  149212. }
  149213. *piScore = iBestScore;
  149214. }
  149215. sqlite3_free(sIter.aPhrase);
  149216. return rc;
  149217. }
  149218. /*
  149219. ** Append a string to the string-buffer passed as the first argument.
  149220. **
  149221. ** If nAppend is negative, then the length of the string zAppend is
  149222. ** determined using strlen().
  149223. */
  149224. static int fts3StringAppend(
  149225. StrBuffer *pStr, /* Buffer to append to */
  149226. const char *zAppend, /* Pointer to data to append to buffer */
  149227. int nAppend /* Size of zAppend in bytes (or -1) */
  149228. ){
  149229. if( nAppend<0 ){
  149230. nAppend = (int)strlen(zAppend);
  149231. }
  149232. /* If there is insufficient space allocated at StrBuffer.z, use realloc()
  149233. ** to grow the buffer until so that it is big enough to accomadate the
  149234. ** appended data.
  149235. */
  149236. if( pStr->n+nAppend+1>=pStr->nAlloc ){
  149237. int nAlloc = pStr->nAlloc+nAppend+100;
  149238. char *zNew = sqlite3_realloc(pStr->z, nAlloc);
  149239. if( !zNew ){
  149240. return SQLITE_NOMEM;
  149241. }
  149242. pStr->z = zNew;
  149243. pStr->nAlloc = nAlloc;
  149244. }
  149245. assert( pStr->z!=0 && (pStr->nAlloc >= pStr->n+nAppend+1) );
  149246. /* Append the data to the string buffer. */
  149247. memcpy(&pStr->z[pStr->n], zAppend, nAppend);
  149248. pStr->n += nAppend;
  149249. pStr->z[pStr->n] = '\0';
  149250. return SQLITE_OK;
  149251. }
  149252. /*
  149253. ** The fts3BestSnippet() function often selects snippets that end with a
  149254. ** query term. That is, the final term of the snippet is always a term
  149255. ** that requires highlighting. For example, if 'X' is a highlighted term
  149256. ** and '.' is a non-highlighted term, BestSnippet() may select:
  149257. **
  149258. ** ........X.....X
  149259. **
  149260. ** This function "shifts" the beginning of the snippet forward in the
  149261. ** document so that there are approximately the same number of
  149262. ** non-highlighted terms to the right of the final highlighted term as there
  149263. ** are to the left of the first highlighted term. For example, to this:
  149264. **
  149265. ** ....X.....X....
  149266. **
  149267. ** This is done as part of extracting the snippet text, not when selecting
  149268. ** the snippet. Snippet selection is done based on doclists only, so there
  149269. ** is no way for fts3BestSnippet() to know whether or not the document
  149270. ** actually contains terms that follow the final highlighted term.
  149271. */
  149272. static int fts3SnippetShift(
  149273. Fts3Table *pTab, /* FTS3 table snippet comes from */
  149274. int iLangid, /* Language id to use in tokenizing */
  149275. int nSnippet, /* Number of tokens desired for snippet */
  149276. const char *zDoc, /* Document text to extract snippet from */
  149277. int nDoc, /* Size of buffer zDoc in bytes */
  149278. int *piPos, /* IN/OUT: First token of snippet */
  149279. u64 *pHlmask /* IN/OUT: Mask of tokens to highlight */
  149280. ){
  149281. u64 hlmask = *pHlmask; /* Local copy of initial highlight-mask */
  149282. if( hlmask ){
  149283. int nLeft; /* Tokens to the left of first highlight */
  149284. int nRight; /* Tokens to the right of last highlight */
  149285. int nDesired; /* Ideal number of tokens to shift forward */
  149286. for(nLeft=0; !(hlmask & ((u64)1 << nLeft)); nLeft++);
  149287. for(nRight=0; !(hlmask & ((u64)1 << (nSnippet-1-nRight))); nRight++);
  149288. nDesired = (nLeft-nRight)/2;
  149289. /* Ideally, the start of the snippet should be pushed forward in the
  149290. ** document nDesired tokens. This block checks if there are actually
  149291. ** nDesired tokens to the right of the snippet. If so, *piPos and
  149292. ** *pHlMask are updated to shift the snippet nDesired tokens to the
  149293. ** right. Otherwise, the snippet is shifted by the number of tokens
  149294. ** available.
  149295. */
  149296. if( nDesired>0 ){
  149297. int nShift; /* Number of tokens to shift snippet by */
  149298. int iCurrent = 0; /* Token counter */
  149299. int rc; /* Return Code */
  149300. sqlite3_tokenizer_module *pMod;
  149301. sqlite3_tokenizer_cursor *pC;
  149302. pMod = (sqlite3_tokenizer_module *)pTab->pTokenizer->pModule;
  149303. /* Open a cursor on zDoc/nDoc. Check if there are (nSnippet+nDesired)
  149304. ** or more tokens in zDoc/nDoc.
  149305. */
  149306. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, iLangid, zDoc, nDoc, &pC);
  149307. if( rc!=SQLITE_OK ){
  149308. return rc;
  149309. }
  149310. while( rc==SQLITE_OK && iCurrent<(nSnippet+nDesired) ){
  149311. const char *ZDUMMY; int DUMMY1 = 0, DUMMY2 = 0, DUMMY3 = 0;
  149312. rc = pMod->xNext(pC, &ZDUMMY, &DUMMY1, &DUMMY2, &DUMMY3, &iCurrent);
  149313. }
  149314. pMod->xClose(pC);
  149315. if( rc!=SQLITE_OK && rc!=SQLITE_DONE ){ return rc; }
  149316. nShift = (rc==SQLITE_DONE)+iCurrent-nSnippet;
  149317. assert( nShift<=nDesired );
  149318. if( nShift>0 ){
  149319. *piPos += nShift;
  149320. *pHlmask = hlmask >> nShift;
  149321. }
  149322. }
  149323. }
  149324. return SQLITE_OK;
  149325. }
  149326. /*
  149327. ** Extract the snippet text for fragment pFragment from cursor pCsr and
  149328. ** append it to string buffer pOut.
  149329. */
  149330. static int fts3SnippetText(
  149331. Fts3Cursor *pCsr, /* FTS3 Cursor */
  149332. SnippetFragment *pFragment, /* Snippet to extract */
  149333. int iFragment, /* Fragment number */
  149334. int isLast, /* True for final fragment in snippet */
  149335. int nSnippet, /* Number of tokens in extracted snippet */
  149336. const char *zOpen, /* String inserted before highlighted term */
  149337. const char *zClose, /* String inserted after highlighted term */
  149338. const char *zEllipsis, /* String inserted between snippets */
  149339. StrBuffer *pOut /* Write output here */
  149340. ){
  149341. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  149342. int rc; /* Return code */
  149343. const char *zDoc; /* Document text to extract snippet from */
  149344. int nDoc; /* Size of zDoc in bytes */
  149345. int iCurrent = 0; /* Current token number of document */
  149346. int iEnd = 0; /* Byte offset of end of current token */
  149347. int isShiftDone = 0; /* True after snippet is shifted */
  149348. int iPos = pFragment->iPos; /* First token of snippet */
  149349. u64 hlmask = pFragment->hlmask; /* Highlight-mask for snippet */
  149350. int iCol = pFragment->iCol+1; /* Query column to extract text from */
  149351. sqlite3_tokenizer_module *pMod; /* Tokenizer module methods object */
  149352. sqlite3_tokenizer_cursor *pC; /* Tokenizer cursor open on zDoc/nDoc */
  149353. zDoc = (const char *)sqlite3_column_text(pCsr->pStmt, iCol);
  149354. if( zDoc==0 ){
  149355. if( sqlite3_column_type(pCsr->pStmt, iCol)!=SQLITE_NULL ){
  149356. return SQLITE_NOMEM;
  149357. }
  149358. return SQLITE_OK;
  149359. }
  149360. nDoc = sqlite3_column_bytes(pCsr->pStmt, iCol);
  149361. /* Open a token cursor on the document. */
  149362. pMod = (sqlite3_tokenizer_module *)pTab->pTokenizer->pModule;
  149363. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, pCsr->iLangid, zDoc,nDoc,&pC);
  149364. if( rc!=SQLITE_OK ){
  149365. return rc;
  149366. }
  149367. while( rc==SQLITE_OK ){
  149368. const char *ZDUMMY; /* Dummy argument used with tokenizer */
  149369. int DUMMY1 = -1; /* Dummy argument used with tokenizer */
  149370. int iBegin = 0; /* Offset in zDoc of start of token */
  149371. int iFin = 0; /* Offset in zDoc of end of token */
  149372. int isHighlight = 0; /* True for highlighted terms */
  149373. /* Variable DUMMY1 is initialized to a negative value above. Elsewhere
  149374. ** in the FTS code the variable that the third argument to xNext points to
  149375. ** is initialized to zero before the first (*but not necessarily
  149376. ** subsequent*) call to xNext(). This is done for a particular application
  149377. ** that needs to know whether or not the tokenizer is being used for
  149378. ** snippet generation or for some other purpose.
  149379. **
  149380. ** Extreme care is required when writing code to depend on this
  149381. ** initialization. It is not a documented part of the tokenizer interface.
  149382. ** If a tokenizer is used directly by any code outside of FTS, this
  149383. ** convention might not be respected. */
  149384. rc = pMod->xNext(pC, &ZDUMMY, &DUMMY1, &iBegin, &iFin, &iCurrent);
  149385. if( rc!=SQLITE_OK ){
  149386. if( rc==SQLITE_DONE ){
  149387. /* Special case - the last token of the snippet is also the last token
  149388. ** of the column. Append any punctuation that occurred between the end
  149389. ** of the previous token and the end of the document to the output.
  149390. ** Then break out of the loop. */
  149391. rc = fts3StringAppend(pOut, &zDoc[iEnd], -1);
  149392. }
  149393. break;
  149394. }
  149395. if( iCurrent<iPos ){ continue; }
  149396. if( !isShiftDone ){
  149397. int n = nDoc - iBegin;
  149398. rc = fts3SnippetShift(
  149399. pTab, pCsr->iLangid, nSnippet, &zDoc[iBegin], n, &iPos, &hlmask
  149400. );
  149401. isShiftDone = 1;
  149402. /* Now that the shift has been done, check if the initial "..." are
  149403. ** required. They are required if (a) this is not the first fragment,
  149404. ** or (b) this fragment does not begin at position 0 of its column.
  149405. */
  149406. if( rc==SQLITE_OK ){
  149407. if( iPos>0 || iFragment>0 ){
  149408. rc = fts3StringAppend(pOut, zEllipsis, -1);
  149409. }else if( iBegin ){
  149410. rc = fts3StringAppend(pOut, zDoc, iBegin);
  149411. }
  149412. }
  149413. if( rc!=SQLITE_OK || iCurrent<iPos ) continue;
  149414. }
  149415. if( iCurrent>=(iPos+nSnippet) ){
  149416. if( isLast ){
  149417. rc = fts3StringAppend(pOut, zEllipsis, -1);
  149418. }
  149419. break;
  149420. }
  149421. /* Set isHighlight to true if this term should be highlighted. */
  149422. isHighlight = (hlmask & ((u64)1 << (iCurrent-iPos)))!=0;
  149423. if( iCurrent>iPos ) rc = fts3StringAppend(pOut, &zDoc[iEnd], iBegin-iEnd);
  149424. if( rc==SQLITE_OK && isHighlight ) rc = fts3StringAppend(pOut, zOpen, -1);
  149425. if( rc==SQLITE_OK ) rc = fts3StringAppend(pOut, &zDoc[iBegin], iFin-iBegin);
  149426. if( rc==SQLITE_OK && isHighlight ) rc = fts3StringAppend(pOut, zClose, -1);
  149427. iEnd = iFin;
  149428. }
  149429. pMod->xClose(pC);
  149430. return rc;
  149431. }
  149432. /*
  149433. ** This function is used to count the entries in a column-list (a
  149434. ** delta-encoded list of term offsets within a single column of a single
  149435. ** row). When this function is called, *ppCollist should point to the
  149436. ** beginning of the first varint in the column-list (the varint that
  149437. ** contains the position of the first matching term in the column data).
  149438. ** Before returning, *ppCollist is set to point to the first byte after
  149439. ** the last varint in the column-list (either the 0x00 signifying the end
  149440. ** of the position-list, or the 0x01 that precedes the column number of
  149441. ** the next column in the position-list).
  149442. **
  149443. ** The number of elements in the column-list is returned.
  149444. */
  149445. static int fts3ColumnlistCount(char **ppCollist){
  149446. char *pEnd = *ppCollist;
  149447. char c = 0;
  149448. int nEntry = 0;
  149449. /* A column-list is terminated by either a 0x01 or 0x00. */
  149450. while( 0xFE & (*pEnd | c) ){
  149451. c = *pEnd++ & 0x80;
  149452. if( !c ) nEntry++;
  149453. }
  149454. *ppCollist = pEnd;
  149455. return nEntry;
  149456. }
  149457. /*
  149458. ** This function gathers 'y' or 'b' data for a single phrase.
  149459. */
  149460. static void fts3ExprLHits(
  149461. Fts3Expr *pExpr, /* Phrase expression node */
  149462. MatchInfo *p /* Matchinfo context */
  149463. ){
  149464. Fts3Table *pTab = (Fts3Table *)p->pCursor->base.pVtab;
  149465. int iStart;
  149466. Fts3Phrase *pPhrase = pExpr->pPhrase;
  149467. char *pIter = pPhrase->doclist.pList;
  149468. int iCol = 0;
  149469. assert( p->flag==FTS3_MATCHINFO_LHITS_BM || p->flag==FTS3_MATCHINFO_LHITS );
  149470. if( p->flag==FTS3_MATCHINFO_LHITS ){
  149471. iStart = pExpr->iPhrase * p->nCol;
  149472. }else{
  149473. iStart = pExpr->iPhrase * ((p->nCol + 31) / 32);
  149474. }
  149475. while( 1 ){
  149476. int nHit = fts3ColumnlistCount(&pIter);
  149477. if( (pPhrase->iColumn>=pTab->nColumn || pPhrase->iColumn==iCol) ){
  149478. if( p->flag==FTS3_MATCHINFO_LHITS ){
  149479. p->aMatchinfo[iStart + iCol] = (u32)nHit;
  149480. }else if( nHit ){
  149481. p->aMatchinfo[iStart + (iCol+1)/32] |= (1 << (iCol&0x1F));
  149482. }
  149483. }
  149484. assert( *pIter==0x00 || *pIter==0x01 );
  149485. if( *pIter!=0x01 ) break;
  149486. pIter++;
  149487. pIter += fts3GetVarint32(pIter, &iCol);
  149488. }
  149489. }
  149490. /*
  149491. ** Gather the results for matchinfo directives 'y' and 'b'.
  149492. */
  149493. static void fts3ExprLHitGather(
  149494. Fts3Expr *pExpr,
  149495. MatchInfo *p
  149496. ){
  149497. assert( (pExpr->pLeft==0)==(pExpr->pRight==0) );
  149498. if( pExpr->bEof==0 && pExpr->iDocid==p->pCursor->iPrevId ){
  149499. if( pExpr->pLeft ){
  149500. fts3ExprLHitGather(pExpr->pLeft, p);
  149501. fts3ExprLHitGather(pExpr->pRight, p);
  149502. }else{
  149503. fts3ExprLHits(pExpr, p);
  149504. }
  149505. }
  149506. }
  149507. /*
  149508. ** fts3ExprIterate() callback used to collect the "global" matchinfo stats
  149509. ** for a single query.
  149510. **
  149511. ** fts3ExprIterate() callback to load the 'global' elements of a
  149512. ** FTS3_MATCHINFO_HITS matchinfo array. The global stats are those elements
  149513. ** of the matchinfo array that are constant for all rows returned by the
  149514. ** current query.
  149515. **
  149516. ** Argument pCtx is actually a pointer to a struct of type MatchInfo. This
  149517. ** function populates Matchinfo.aMatchinfo[] as follows:
  149518. **
  149519. ** for(iCol=0; iCol<nCol; iCol++){
  149520. ** aMatchinfo[3*iPhrase*nCol + 3*iCol + 1] = X;
  149521. ** aMatchinfo[3*iPhrase*nCol + 3*iCol + 2] = Y;
  149522. ** }
  149523. **
  149524. ** where X is the number of matches for phrase iPhrase is column iCol of all
  149525. ** rows of the table. Y is the number of rows for which column iCol contains
  149526. ** at least one instance of phrase iPhrase.
  149527. **
  149528. ** If the phrase pExpr consists entirely of deferred tokens, then all X and
  149529. ** Y values are set to nDoc, where nDoc is the number of documents in the
  149530. ** file system. This is done because the full-text index doclist is required
  149531. ** to calculate these values properly, and the full-text index doclist is
  149532. ** not available for deferred tokens.
  149533. */
  149534. static int fts3ExprGlobalHitsCb(
  149535. Fts3Expr *pExpr, /* Phrase expression node */
  149536. int iPhrase, /* Phrase number (numbered from zero) */
  149537. void *pCtx /* Pointer to MatchInfo structure */
  149538. ){
  149539. MatchInfo *p = (MatchInfo *)pCtx;
  149540. return sqlite3Fts3EvalPhraseStats(
  149541. p->pCursor, pExpr, &p->aMatchinfo[3*iPhrase*p->nCol]
  149542. );
  149543. }
  149544. /*
  149545. ** fts3ExprIterate() callback used to collect the "local" part of the
  149546. ** FTS3_MATCHINFO_HITS array. The local stats are those elements of the
  149547. ** array that are different for each row returned by the query.
  149548. */
  149549. static int fts3ExprLocalHitsCb(
  149550. Fts3Expr *pExpr, /* Phrase expression node */
  149551. int iPhrase, /* Phrase number */
  149552. void *pCtx /* Pointer to MatchInfo structure */
  149553. ){
  149554. int rc = SQLITE_OK;
  149555. MatchInfo *p = (MatchInfo *)pCtx;
  149556. int iStart = iPhrase * p->nCol * 3;
  149557. int i;
  149558. for(i=0; i<p->nCol && rc==SQLITE_OK; i++){
  149559. char *pCsr;
  149560. rc = sqlite3Fts3EvalPhrasePoslist(p->pCursor, pExpr, i, &pCsr);
  149561. if( pCsr ){
  149562. p->aMatchinfo[iStart+i*3] = fts3ColumnlistCount(&pCsr);
  149563. }else{
  149564. p->aMatchinfo[iStart+i*3] = 0;
  149565. }
  149566. }
  149567. return rc;
  149568. }
  149569. static int fts3MatchinfoCheck(
  149570. Fts3Table *pTab,
  149571. char cArg,
  149572. char **pzErr
  149573. ){
  149574. if( (cArg==FTS3_MATCHINFO_NPHRASE)
  149575. || (cArg==FTS3_MATCHINFO_NCOL)
  149576. || (cArg==FTS3_MATCHINFO_NDOC && pTab->bFts4)
  149577. || (cArg==FTS3_MATCHINFO_AVGLENGTH && pTab->bFts4)
  149578. || (cArg==FTS3_MATCHINFO_LENGTH && pTab->bHasDocsize)
  149579. || (cArg==FTS3_MATCHINFO_LCS)
  149580. || (cArg==FTS3_MATCHINFO_HITS)
  149581. || (cArg==FTS3_MATCHINFO_LHITS)
  149582. || (cArg==FTS3_MATCHINFO_LHITS_BM)
  149583. ){
  149584. return SQLITE_OK;
  149585. }
  149586. sqlite3Fts3ErrMsg(pzErr, "unrecognized matchinfo request: %c", cArg);
  149587. return SQLITE_ERROR;
  149588. }
  149589. static int fts3MatchinfoSize(MatchInfo *pInfo, char cArg){
  149590. int nVal; /* Number of integers output by cArg */
  149591. switch( cArg ){
  149592. case FTS3_MATCHINFO_NDOC:
  149593. case FTS3_MATCHINFO_NPHRASE:
  149594. case FTS3_MATCHINFO_NCOL:
  149595. nVal = 1;
  149596. break;
  149597. case FTS3_MATCHINFO_AVGLENGTH:
  149598. case FTS3_MATCHINFO_LENGTH:
  149599. case FTS3_MATCHINFO_LCS:
  149600. nVal = pInfo->nCol;
  149601. break;
  149602. case FTS3_MATCHINFO_LHITS:
  149603. nVal = pInfo->nCol * pInfo->nPhrase;
  149604. break;
  149605. case FTS3_MATCHINFO_LHITS_BM:
  149606. nVal = pInfo->nPhrase * ((pInfo->nCol + 31) / 32);
  149607. break;
  149608. default:
  149609. assert( cArg==FTS3_MATCHINFO_HITS );
  149610. nVal = pInfo->nCol * pInfo->nPhrase * 3;
  149611. break;
  149612. }
  149613. return nVal;
  149614. }
  149615. static int fts3MatchinfoSelectDoctotal(
  149616. Fts3Table *pTab,
  149617. sqlite3_stmt **ppStmt,
  149618. sqlite3_int64 *pnDoc,
  149619. const char **paLen
  149620. ){
  149621. sqlite3_stmt *pStmt;
  149622. const char *a;
  149623. sqlite3_int64 nDoc;
  149624. if( !*ppStmt ){
  149625. int rc = sqlite3Fts3SelectDoctotal(pTab, ppStmt);
  149626. if( rc!=SQLITE_OK ) return rc;
  149627. }
  149628. pStmt = *ppStmt;
  149629. assert( sqlite3_data_count(pStmt)==1 );
  149630. a = sqlite3_column_blob(pStmt, 0);
  149631. a += sqlite3Fts3GetVarint(a, &nDoc);
  149632. if( nDoc==0 ) return FTS_CORRUPT_VTAB;
  149633. *pnDoc = (u32)nDoc;
  149634. if( paLen ) *paLen = a;
  149635. return SQLITE_OK;
  149636. }
  149637. /*
  149638. ** An instance of the following structure is used to store state while
  149639. ** iterating through a multi-column position-list corresponding to the
  149640. ** hits for a single phrase on a single row in order to calculate the
  149641. ** values for a matchinfo() FTS3_MATCHINFO_LCS request.
  149642. */
  149643. typedef struct LcsIterator LcsIterator;
  149644. struct LcsIterator {
  149645. Fts3Expr *pExpr; /* Pointer to phrase expression */
  149646. int iPosOffset; /* Tokens count up to end of this phrase */
  149647. char *pRead; /* Cursor used to iterate through aDoclist */
  149648. int iPos; /* Current position */
  149649. };
  149650. /*
  149651. ** If LcsIterator.iCol is set to the following value, the iterator has
  149652. ** finished iterating through all offsets for all columns.
  149653. */
  149654. #define LCS_ITERATOR_FINISHED 0x7FFFFFFF;
  149655. static int fts3MatchinfoLcsCb(
  149656. Fts3Expr *pExpr, /* Phrase expression node */
  149657. int iPhrase, /* Phrase number (numbered from zero) */
  149658. void *pCtx /* Pointer to MatchInfo structure */
  149659. ){
  149660. LcsIterator *aIter = (LcsIterator *)pCtx;
  149661. aIter[iPhrase].pExpr = pExpr;
  149662. return SQLITE_OK;
  149663. }
  149664. /*
  149665. ** Advance the iterator passed as an argument to the next position. Return
  149666. ** 1 if the iterator is at EOF or if it now points to the start of the
  149667. ** position list for the next column.
  149668. */
  149669. static int fts3LcsIteratorAdvance(LcsIterator *pIter){
  149670. char *pRead = pIter->pRead;
  149671. sqlite3_int64 iRead;
  149672. int rc = 0;
  149673. pRead += sqlite3Fts3GetVarint(pRead, &iRead);
  149674. if( iRead==0 || iRead==1 ){
  149675. pRead = 0;
  149676. rc = 1;
  149677. }else{
  149678. pIter->iPos += (int)(iRead-2);
  149679. }
  149680. pIter->pRead = pRead;
  149681. return rc;
  149682. }
  149683. /*
  149684. ** This function implements the FTS3_MATCHINFO_LCS matchinfo() flag.
  149685. **
  149686. ** If the call is successful, the longest-common-substring lengths for each
  149687. ** column are written into the first nCol elements of the pInfo->aMatchinfo[]
  149688. ** array before returning. SQLITE_OK is returned in this case.
  149689. **
  149690. ** Otherwise, if an error occurs, an SQLite error code is returned and the
  149691. ** data written to the first nCol elements of pInfo->aMatchinfo[] is
  149692. ** undefined.
  149693. */
  149694. static int fts3MatchinfoLcs(Fts3Cursor *pCsr, MatchInfo *pInfo){
  149695. LcsIterator *aIter;
  149696. int i;
  149697. int iCol;
  149698. int nToken = 0;
  149699. /* Allocate and populate the array of LcsIterator objects. The array
  149700. ** contains one element for each matchable phrase in the query.
  149701. **/
  149702. aIter = sqlite3_malloc(sizeof(LcsIterator) * pCsr->nPhrase);
  149703. if( !aIter ) return SQLITE_NOMEM;
  149704. memset(aIter, 0, sizeof(LcsIterator) * pCsr->nPhrase);
  149705. (void)fts3ExprIterate(pCsr->pExpr, fts3MatchinfoLcsCb, (void*)aIter);
  149706. for(i=0; i<pInfo->nPhrase; i++){
  149707. LcsIterator *pIter = &aIter[i];
  149708. nToken -= pIter->pExpr->pPhrase->nToken;
  149709. pIter->iPosOffset = nToken;
  149710. }
  149711. for(iCol=0; iCol<pInfo->nCol; iCol++){
  149712. int nLcs = 0; /* LCS value for this column */
  149713. int nLive = 0; /* Number of iterators in aIter not at EOF */
  149714. for(i=0; i<pInfo->nPhrase; i++){
  149715. int rc;
  149716. LcsIterator *pIt = &aIter[i];
  149717. rc = sqlite3Fts3EvalPhrasePoslist(pCsr, pIt->pExpr, iCol, &pIt->pRead);
  149718. if( rc!=SQLITE_OK ) return rc;
  149719. if( pIt->pRead ){
  149720. pIt->iPos = pIt->iPosOffset;
  149721. fts3LcsIteratorAdvance(&aIter[i]);
  149722. nLive++;
  149723. }
  149724. }
  149725. while( nLive>0 ){
  149726. LcsIterator *pAdv = 0; /* The iterator to advance by one position */
  149727. int nThisLcs = 0; /* LCS for the current iterator positions */
  149728. for(i=0; i<pInfo->nPhrase; i++){
  149729. LcsIterator *pIter = &aIter[i];
  149730. if( pIter->pRead==0 ){
  149731. /* This iterator is already at EOF for this column. */
  149732. nThisLcs = 0;
  149733. }else{
  149734. if( pAdv==0 || pIter->iPos<pAdv->iPos ){
  149735. pAdv = pIter;
  149736. }
  149737. if( nThisLcs==0 || pIter->iPos==pIter[-1].iPos ){
  149738. nThisLcs++;
  149739. }else{
  149740. nThisLcs = 1;
  149741. }
  149742. if( nThisLcs>nLcs ) nLcs = nThisLcs;
  149743. }
  149744. }
  149745. if( fts3LcsIteratorAdvance(pAdv) ) nLive--;
  149746. }
  149747. pInfo->aMatchinfo[iCol] = nLcs;
  149748. }
  149749. sqlite3_free(aIter);
  149750. return SQLITE_OK;
  149751. }
  149752. /*
  149753. ** Populate the buffer pInfo->aMatchinfo[] with an array of integers to
  149754. ** be returned by the matchinfo() function. Argument zArg contains the
  149755. ** format string passed as the second argument to matchinfo (or the
  149756. ** default value "pcx" if no second argument was specified). The format
  149757. ** string has already been validated and the pInfo->aMatchinfo[] array
  149758. ** is guaranteed to be large enough for the output.
  149759. **
  149760. ** If bGlobal is true, then populate all fields of the matchinfo() output.
  149761. ** If it is false, then assume that those fields that do not change between
  149762. ** rows (i.e. FTS3_MATCHINFO_NPHRASE, NCOL, NDOC, AVGLENGTH and part of HITS)
  149763. ** have already been populated.
  149764. **
  149765. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  149766. ** occurs. If a value other than SQLITE_OK is returned, the state the
  149767. ** pInfo->aMatchinfo[] buffer is left in is undefined.
  149768. */
  149769. static int fts3MatchinfoValues(
  149770. Fts3Cursor *pCsr, /* FTS3 cursor object */
  149771. int bGlobal, /* True to grab the global stats */
  149772. MatchInfo *pInfo, /* Matchinfo context object */
  149773. const char *zArg /* Matchinfo format string */
  149774. ){
  149775. int rc = SQLITE_OK;
  149776. int i;
  149777. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  149778. sqlite3_stmt *pSelect = 0;
  149779. for(i=0; rc==SQLITE_OK && zArg[i]; i++){
  149780. pInfo->flag = zArg[i];
  149781. switch( zArg[i] ){
  149782. case FTS3_MATCHINFO_NPHRASE:
  149783. if( bGlobal ) pInfo->aMatchinfo[0] = pInfo->nPhrase;
  149784. break;
  149785. case FTS3_MATCHINFO_NCOL:
  149786. if( bGlobal ) pInfo->aMatchinfo[0] = pInfo->nCol;
  149787. break;
  149788. case FTS3_MATCHINFO_NDOC:
  149789. if( bGlobal ){
  149790. sqlite3_int64 nDoc = 0;
  149791. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &nDoc, 0);
  149792. pInfo->aMatchinfo[0] = (u32)nDoc;
  149793. }
  149794. break;
  149795. case FTS3_MATCHINFO_AVGLENGTH:
  149796. if( bGlobal ){
  149797. sqlite3_int64 nDoc; /* Number of rows in table */
  149798. const char *a; /* Aggregate column length array */
  149799. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &nDoc, &a);
  149800. if( rc==SQLITE_OK ){
  149801. int iCol;
  149802. for(iCol=0; iCol<pInfo->nCol; iCol++){
  149803. u32 iVal;
  149804. sqlite3_int64 nToken;
  149805. a += sqlite3Fts3GetVarint(a, &nToken);
  149806. iVal = (u32)(((u32)(nToken&0xffffffff)+nDoc/2)/nDoc);
  149807. pInfo->aMatchinfo[iCol] = iVal;
  149808. }
  149809. }
  149810. }
  149811. break;
  149812. case FTS3_MATCHINFO_LENGTH: {
  149813. sqlite3_stmt *pSelectDocsize = 0;
  149814. rc = sqlite3Fts3SelectDocsize(pTab, pCsr->iPrevId, &pSelectDocsize);
  149815. if( rc==SQLITE_OK ){
  149816. int iCol;
  149817. const char *a = sqlite3_column_blob(pSelectDocsize, 0);
  149818. for(iCol=0; iCol<pInfo->nCol; iCol++){
  149819. sqlite3_int64 nToken;
  149820. a += sqlite3Fts3GetVarint(a, &nToken);
  149821. pInfo->aMatchinfo[iCol] = (u32)nToken;
  149822. }
  149823. }
  149824. sqlite3_reset(pSelectDocsize);
  149825. break;
  149826. }
  149827. case FTS3_MATCHINFO_LCS:
  149828. rc = fts3ExprLoadDoclists(pCsr, 0, 0);
  149829. if( rc==SQLITE_OK ){
  149830. rc = fts3MatchinfoLcs(pCsr, pInfo);
  149831. }
  149832. break;
  149833. case FTS3_MATCHINFO_LHITS_BM:
  149834. case FTS3_MATCHINFO_LHITS: {
  149835. int nZero = fts3MatchinfoSize(pInfo, zArg[i]) * sizeof(u32);
  149836. memset(pInfo->aMatchinfo, 0, nZero);
  149837. fts3ExprLHitGather(pCsr->pExpr, pInfo);
  149838. break;
  149839. }
  149840. default: {
  149841. Fts3Expr *pExpr;
  149842. assert( zArg[i]==FTS3_MATCHINFO_HITS );
  149843. pExpr = pCsr->pExpr;
  149844. rc = fts3ExprLoadDoclists(pCsr, 0, 0);
  149845. if( rc!=SQLITE_OK ) break;
  149846. if( bGlobal ){
  149847. if( pCsr->pDeferred ){
  149848. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &pInfo->nDoc, 0);
  149849. if( rc!=SQLITE_OK ) break;
  149850. }
  149851. rc = fts3ExprIterate(pExpr, fts3ExprGlobalHitsCb,(void*)pInfo);
  149852. sqlite3Fts3EvalTestDeferred(pCsr, &rc);
  149853. if( rc!=SQLITE_OK ) break;
  149854. }
  149855. (void)fts3ExprIterate(pExpr, fts3ExprLocalHitsCb,(void*)pInfo);
  149856. break;
  149857. }
  149858. }
  149859. pInfo->aMatchinfo += fts3MatchinfoSize(pInfo, zArg[i]);
  149860. }
  149861. sqlite3_reset(pSelect);
  149862. return rc;
  149863. }
  149864. /*
  149865. ** Populate pCsr->aMatchinfo[] with data for the current row. The
  149866. ** 'matchinfo' data is an array of 32-bit unsigned integers (C type u32).
  149867. */
  149868. static void fts3GetMatchinfo(
  149869. sqlite3_context *pCtx, /* Return results here */
  149870. Fts3Cursor *pCsr, /* FTS3 Cursor object */
  149871. const char *zArg /* Second argument to matchinfo() function */
  149872. ){
  149873. MatchInfo sInfo;
  149874. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  149875. int rc = SQLITE_OK;
  149876. int bGlobal = 0; /* Collect 'global' stats as well as local */
  149877. u32 *aOut = 0;
  149878. void (*xDestroyOut)(void*) = 0;
  149879. memset(&sInfo, 0, sizeof(MatchInfo));
  149880. sInfo.pCursor = pCsr;
  149881. sInfo.nCol = pTab->nColumn;
  149882. /* If there is cached matchinfo() data, but the format string for the
  149883. ** cache does not match the format string for this request, discard
  149884. ** the cached data. */
  149885. if( pCsr->pMIBuffer && strcmp(pCsr->pMIBuffer->zMatchinfo, zArg) ){
  149886. sqlite3Fts3MIBufferFree(pCsr->pMIBuffer);
  149887. pCsr->pMIBuffer = 0;
  149888. }
  149889. /* If Fts3Cursor.pMIBuffer is NULL, then this is the first time the
  149890. ** matchinfo function has been called for this query. In this case
  149891. ** allocate the array used to accumulate the matchinfo data and
  149892. ** initialize those elements that are constant for every row.
  149893. */
  149894. if( pCsr->pMIBuffer==0 ){
  149895. int nMatchinfo = 0; /* Number of u32 elements in match-info */
  149896. int i; /* Used to iterate through zArg */
  149897. /* Determine the number of phrases in the query */
  149898. pCsr->nPhrase = fts3ExprPhraseCount(pCsr->pExpr);
  149899. sInfo.nPhrase = pCsr->nPhrase;
  149900. /* Determine the number of integers in the buffer returned by this call. */
  149901. for(i=0; zArg[i]; i++){
  149902. char *zErr = 0;
  149903. if( fts3MatchinfoCheck(pTab, zArg[i], &zErr) ){
  149904. sqlite3_result_error(pCtx, zErr, -1);
  149905. sqlite3_free(zErr);
  149906. return;
  149907. }
  149908. nMatchinfo += fts3MatchinfoSize(&sInfo, zArg[i]);
  149909. }
  149910. /* Allocate space for Fts3Cursor.aMatchinfo[] and Fts3Cursor.zMatchinfo. */
  149911. pCsr->pMIBuffer = fts3MIBufferNew(nMatchinfo, zArg);
  149912. if( !pCsr->pMIBuffer ) rc = SQLITE_NOMEM;
  149913. pCsr->isMatchinfoNeeded = 1;
  149914. bGlobal = 1;
  149915. }
  149916. if( rc==SQLITE_OK ){
  149917. xDestroyOut = fts3MIBufferAlloc(pCsr->pMIBuffer, &aOut);
  149918. if( xDestroyOut==0 ){
  149919. rc = SQLITE_NOMEM;
  149920. }
  149921. }
  149922. if( rc==SQLITE_OK ){
  149923. sInfo.aMatchinfo = aOut;
  149924. sInfo.nPhrase = pCsr->nPhrase;
  149925. rc = fts3MatchinfoValues(pCsr, bGlobal, &sInfo, zArg);
  149926. if( bGlobal ){
  149927. fts3MIBufferSetGlobal(pCsr->pMIBuffer);
  149928. }
  149929. }
  149930. if( rc!=SQLITE_OK ){
  149931. sqlite3_result_error_code(pCtx, rc);
  149932. if( xDestroyOut ) xDestroyOut(aOut);
  149933. }else{
  149934. int n = pCsr->pMIBuffer->nElem * sizeof(u32);
  149935. sqlite3_result_blob(pCtx, aOut, n, xDestroyOut);
  149936. }
  149937. }
  149938. /*
  149939. ** Implementation of snippet() function.
  149940. */
  149941. SQLITE_PRIVATE void sqlite3Fts3Snippet(
  149942. sqlite3_context *pCtx, /* SQLite function call context */
  149943. Fts3Cursor *pCsr, /* Cursor object */
  149944. const char *zStart, /* Snippet start text - "<b>" */
  149945. const char *zEnd, /* Snippet end text - "</b>" */
  149946. const char *zEllipsis, /* Snippet ellipsis text - "<b>...</b>" */
  149947. int iCol, /* Extract snippet from this column */
  149948. int nToken /* Approximate number of tokens in snippet */
  149949. ){
  149950. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  149951. int rc = SQLITE_OK;
  149952. int i;
  149953. StrBuffer res = {0, 0, 0};
  149954. /* The returned text includes up to four fragments of text extracted from
  149955. ** the data in the current row. The first iteration of the for(...) loop
  149956. ** below attempts to locate a single fragment of text nToken tokens in
  149957. ** size that contains at least one instance of all phrases in the query
  149958. ** expression that appear in the current row. If such a fragment of text
  149959. ** cannot be found, the second iteration of the loop attempts to locate
  149960. ** a pair of fragments, and so on.
  149961. */
  149962. int nSnippet = 0; /* Number of fragments in this snippet */
  149963. SnippetFragment aSnippet[4]; /* Maximum of 4 fragments per snippet */
  149964. int nFToken = -1; /* Number of tokens in each fragment */
  149965. if( !pCsr->pExpr ){
  149966. sqlite3_result_text(pCtx, "", 0, SQLITE_STATIC);
  149967. return;
  149968. }
  149969. for(nSnippet=1; 1; nSnippet++){
  149970. int iSnip; /* Loop counter 0..nSnippet-1 */
  149971. u64 mCovered = 0; /* Bitmask of phrases covered by snippet */
  149972. u64 mSeen = 0; /* Bitmask of phrases seen by BestSnippet() */
  149973. if( nToken>=0 ){
  149974. nFToken = (nToken+nSnippet-1) / nSnippet;
  149975. }else{
  149976. nFToken = -1 * nToken;
  149977. }
  149978. for(iSnip=0; iSnip<nSnippet; iSnip++){
  149979. int iBestScore = -1; /* Best score of columns checked so far */
  149980. int iRead; /* Used to iterate through columns */
  149981. SnippetFragment *pFragment = &aSnippet[iSnip];
  149982. memset(pFragment, 0, sizeof(*pFragment));
  149983. /* Loop through all columns of the table being considered for snippets.
  149984. ** If the iCol argument to this function was negative, this means all
  149985. ** columns of the FTS3 table. Otherwise, only column iCol is considered.
  149986. */
  149987. for(iRead=0; iRead<pTab->nColumn; iRead++){
  149988. SnippetFragment sF = {0, 0, 0, 0};
  149989. int iS = 0;
  149990. if( iCol>=0 && iRead!=iCol ) continue;
  149991. /* Find the best snippet of nFToken tokens in column iRead. */
  149992. rc = fts3BestSnippet(nFToken, pCsr, iRead, mCovered, &mSeen, &sF, &iS);
  149993. if( rc!=SQLITE_OK ){
  149994. goto snippet_out;
  149995. }
  149996. if( iS>iBestScore ){
  149997. *pFragment = sF;
  149998. iBestScore = iS;
  149999. }
  150000. }
  150001. mCovered |= pFragment->covered;
  150002. }
  150003. /* If all query phrases seen by fts3BestSnippet() are present in at least
  150004. ** one of the nSnippet snippet fragments, break out of the loop.
  150005. */
  150006. assert( (mCovered&mSeen)==mCovered );
  150007. if( mSeen==mCovered || nSnippet==SizeofArray(aSnippet) ) break;
  150008. }
  150009. assert( nFToken>0 );
  150010. for(i=0; i<nSnippet && rc==SQLITE_OK; i++){
  150011. rc = fts3SnippetText(pCsr, &aSnippet[i],
  150012. i, (i==nSnippet-1), nFToken, zStart, zEnd, zEllipsis, &res
  150013. );
  150014. }
  150015. snippet_out:
  150016. sqlite3Fts3SegmentsClose(pTab);
  150017. if( rc!=SQLITE_OK ){
  150018. sqlite3_result_error_code(pCtx, rc);
  150019. sqlite3_free(res.z);
  150020. }else{
  150021. sqlite3_result_text(pCtx, res.z, -1, sqlite3_free);
  150022. }
  150023. }
  150024. typedef struct TermOffset TermOffset;
  150025. typedef struct TermOffsetCtx TermOffsetCtx;
  150026. struct TermOffset {
  150027. char *pList; /* Position-list */
  150028. int iPos; /* Position just read from pList */
  150029. int iOff; /* Offset of this term from read positions */
  150030. };
  150031. struct TermOffsetCtx {
  150032. Fts3Cursor *pCsr;
  150033. int iCol; /* Column of table to populate aTerm for */
  150034. int iTerm;
  150035. sqlite3_int64 iDocid;
  150036. TermOffset *aTerm;
  150037. };
  150038. /*
  150039. ** This function is an fts3ExprIterate() callback used by sqlite3Fts3Offsets().
  150040. */
  150041. static int fts3ExprTermOffsetInit(Fts3Expr *pExpr, int iPhrase, void *ctx){
  150042. TermOffsetCtx *p = (TermOffsetCtx *)ctx;
  150043. int nTerm; /* Number of tokens in phrase */
  150044. int iTerm; /* For looping through nTerm phrase terms */
  150045. char *pList; /* Pointer to position list for phrase */
  150046. int iPos = 0; /* First position in position-list */
  150047. int rc;
  150048. UNUSED_PARAMETER(iPhrase);
  150049. rc = sqlite3Fts3EvalPhrasePoslist(p->pCsr, pExpr, p->iCol, &pList);
  150050. nTerm = pExpr->pPhrase->nToken;
  150051. if( pList ){
  150052. fts3GetDeltaPosition(&pList, &iPos);
  150053. assert( iPos>=0 );
  150054. }
  150055. for(iTerm=0; iTerm<nTerm; iTerm++){
  150056. TermOffset *pT = &p->aTerm[p->iTerm++];
  150057. pT->iOff = nTerm-iTerm-1;
  150058. pT->pList = pList;
  150059. pT->iPos = iPos;
  150060. }
  150061. return rc;
  150062. }
  150063. /*
  150064. ** Implementation of offsets() function.
  150065. */
  150066. SQLITE_PRIVATE void sqlite3Fts3Offsets(
  150067. sqlite3_context *pCtx, /* SQLite function call context */
  150068. Fts3Cursor *pCsr /* Cursor object */
  150069. ){
  150070. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  150071. sqlite3_tokenizer_module const *pMod = pTab->pTokenizer->pModule;
  150072. int rc; /* Return Code */
  150073. int nToken; /* Number of tokens in query */
  150074. int iCol; /* Column currently being processed */
  150075. StrBuffer res = {0, 0, 0}; /* Result string */
  150076. TermOffsetCtx sCtx; /* Context for fts3ExprTermOffsetInit() */
  150077. if( !pCsr->pExpr ){
  150078. sqlite3_result_text(pCtx, "", 0, SQLITE_STATIC);
  150079. return;
  150080. }
  150081. memset(&sCtx, 0, sizeof(sCtx));
  150082. assert( pCsr->isRequireSeek==0 );
  150083. /* Count the number of terms in the query */
  150084. rc = fts3ExprLoadDoclists(pCsr, 0, &nToken);
  150085. if( rc!=SQLITE_OK ) goto offsets_out;
  150086. /* Allocate the array of TermOffset iterators. */
  150087. sCtx.aTerm = (TermOffset *)sqlite3_malloc(sizeof(TermOffset)*nToken);
  150088. if( 0==sCtx.aTerm ){
  150089. rc = SQLITE_NOMEM;
  150090. goto offsets_out;
  150091. }
  150092. sCtx.iDocid = pCsr->iPrevId;
  150093. sCtx.pCsr = pCsr;
  150094. /* Loop through the table columns, appending offset information to
  150095. ** string-buffer res for each column.
  150096. */
  150097. for(iCol=0; iCol<pTab->nColumn; iCol++){
  150098. sqlite3_tokenizer_cursor *pC; /* Tokenizer cursor */
  150099. const char *ZDUMMY; /* Dummy argument used with xNext() */
  150100. int NDUMMY = 0; /* Dummy argument used with xNext() */
  150101. int iStart = 0;
  150102. int iEnd = 0;
  150103. int iCurrent = 0;
  150104. const char *zDoc;
  150105. int nDoc;
  150106. /* Initialize the contents of sCtx.aTerm[] for column iCol. There is
  150107. ** no way that this operation can fail, so the return code from
  150108. ** fts3ExprIterate() can be discarded.
  150109. */
  150110. sCtx.iCol = iCol;
  150111. sCtx.iTerm = 0;
  150112. (void)fts3ExprIterate(pCsr->pExpr, fts3ExprTermOffsetInit, (void*)&sCtx);
  150113. /* Retreive the text stored in column iCol. If an SQL NULL is stored
  150114. ** in column iCol, jump immediately to the next iteration of the loop.
  150115. ** If an OOM occurs while retrieving the data (this can happen if SQLite
  150116. ** needs to transform the data from utf-16 to utf-8), return SQLITE_NOMEM
  150117. ** to the caller.
  150118. */
  150119. zDoc = (const char *)sqlite3_column_text(pCsr->pStmt, iCol+1);
  150120. nDoc = sqlite3_column_bytes(pCsr->pStmt, iCol+1);
  150121. if( zDoc==0 ){
  150122. if( sqlite3_column_type(pCsr->pStmt, iCol+1)==SQLITE_NULL ){
  150123. continue;
  150124. }
  150125. rc = SQLITE_NOMEM;
  150126. goto offsets_out;
  150127. }
  150128. /* Initialize a tokenizer iterator to iterate through column iCol. */
  150129. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, pCsr->iLangid,
  150130. zDoc, nDoc, &pC
  150131. );
  150132. if( rc!=SQLITE_OK ) goto offsets_out;
  150133. rc = pMod->xNext(pC, &ZDUMMY, &NDUMMY, &iStart, &iEnd, &iCurrent);
  150134. while( rc==SQLITE_OK ){
  150135. int i; /* Used to loop through terms */
  150136. int iMinPos = 0x7FFFFFFF; /* Position of next token */
  150137. TermOffset *pTerm = 0; /* TermOffset associated with next token */
  150138. for(i=0; i<nToken; i++){
  150139. TermOffset *pT = &sCtx.aTerm[i];
  150140. if( pT->pList && (pT->iPos-pT->iOff)<iMinPos ){
  150141. iMinPos = pT->iPos-pT->iOff;
  150142. pTerm = pT;
  150143. }
  150144. }
  150145. if( !pTerm ){
  150146. /* All offsets for this column have been gathered. */
  150147. rc = SQLITE_DONE;
  150148. }else{
  150149. assert( iCurrent<=iMinPos );
  150150. if( 0==(0xFE&*pTerm->pList) ){
  150151. pTerm->pList = 0;
  150152. }else{
  150153. fts3GetDeltaPosition(&pTerm->pList, &pTerm->iPos);
  150154. }
  150155. while( rc==SQLITE_OK && iCurrent<iMinPos ){
  150156. rc = pMod->xNext(pC, &ZDUMMY, &NDUMMY, &iStart, &iEnd, &iCurrent);
  150157. }
  150158. if( rc==SQLITE_OK ){
  150159. char aBuffer[64];
  150160. sqlite3_snprintf(sizeof(aBuffer), aBuffer,
  150161. "%d %d %d %d ", iCol, pTerm-sCtx.aTerm, iStart, iEnd-iStart
  150162. );
  150163. rc = fts3StringAppend(&res, aBuffer, -1);
  150164. }else if( rc==SQLITE_DONE && pTab->zContentTbl==0 ){
  150165. rc = FTS_CORRUPT_VTAB;
  150166. }
  150167. }
  150168. }
  150169. if( rc==SQLITE_DONE ){
  150170. rc = SQLITE_OK;
  150171. }
  150172. pMod->xClose(pC);
  150173. if( rc!=SQLITE_OK ) goto offsets_out;
  150174. }
  150175. offsets_out:
  150176. sqlite3_free(sCtx.aTerm);
  150177. assert( rc!=SQLITE_DONE );
  150178. sqlite3Fts3SegmentsClose(pTab);
  150179. if( rc!=SQLITE_OK ){
  150180. sqlite3_result_error_code(pCtx, rc);
  150181. sqlite3_free(res.z);
  150182. }else{
  150183. sqlite3_result_text(pCtx, res.z, res.n-1, sqlite3_free);
  150184. }
  150185. return;
  150186. }
  150187. /*
  150188. ** Implementation of matchinfo() function.
  150189. */
  150190. SQLITE_PRIVATE void sqlite3Fts3Matchinfo(
  150191. sqlite3_context *pContext, /* Function call context */
  150192. Fts3Cursor *pCsr, /* FTS3 table cursor */
  150193. const char *zArg /* Second arg to matchinfo() function */
  150194. ){
  150195. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  150196. const char *zFormat;
  150197. if( zArg ){
  150198. zFormat = zArg;
  150199. }else{
  150200. zFormat = FTS3_MATCHINFO_DEFAULT;
  150201. }
  150202. if( !pCsr->pExpr ){
  150203. sqlite3_result_blob(pContext, "", 0, SQLITE_STATIC);
  150204. return;
  150205. }else{
  150206. /* Retrieve matchinfo() data. */
  150207. fts3GetMatchinfo(pContext, pCsr, zFormat);
  150208. sqlite3Fts3SegmentsClose(pTab);
  150209. }
  150210. }
  150211. #endif
  150212. /************** End of fts3_snippet.c ****************************************/
  150213. /************** Begin file fts3_unicode.c ************************************/
  150214. /*
  150215. ** 2012 May 24
  150216. **
  150217. ** The author disclaims copyright to this source code. In place of
  150218. ** a legal notice, here is a blessing:
  150219. **
  150220. ** May you do good and not evil.
  150221. ** May you find forgiveness for yourself and forgive others.
  150222. ** May you share freely, never taking more than you give.
  150223. **
  150224. ******************************************************************************
  150225. **
  150226. ** Implementation of the "unicode" full-text-search tokenizer.
  150227. */
  150228. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  150229. /* #include "fts3Int.h" */
  150230. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  150231. /* #include <assert.h> */
  150232. /* #include <stdlib.h> */
  150233. /* #include <stdio.h> */
  150234. /* #include <string.h> */
  150235. /* #include "fts3_tokenizer.h" */
  150236. /*
  150237. ** The following two macros - READ_UTF8 and WRITE_UTF8 - have been copied
  150238. ** from the sqlite3 source file utf.c. If this file is compiled as part
  150239. ** of the amalgamation, they are not required.
  150240. */
  150241. #ifndef SQLITE_AMALGAMATION
  150242. static const unsigned char sqlite3Utf8Trans1[] = {
  150243. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  150244. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  150245. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  150246. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  150247. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  150248. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  150249. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  150250. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  150251. };
  150252. #define READ_UTF8(zIn, zTerm, c) \
  150253. c = *(zIn++); \
  150254. if( c>=0xc0 ){ \
  150255. c = sqlite3Utf8Trans1[c-0xc0]; \
  150256. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  150257. c = (c<<6) + (0x3f & *(zIn++)); \
  150258. } \
  150259. if( c<0x80 \
  150260. || (c&0xFFFFF800)==0xD800 \
  150261. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  150262. }
  150263. #define WRITE_UTF8(zOut, c) { \
  150264. if( c<0x00080 ){ \
  150265. *zOut++ = (u8)(c&0xFF); \
  150266. } \
  150267. else if( c<0x00800 ){ \
  150268. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F); \
  150269. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  150270. } \
  150271. else if( c<0x10000 ){ \
  150272. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F); \
  150273. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  150274. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  150275. }else{ \
  150276. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07); \
  150277. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F); \
  150278. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  150279. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  150280. } \
  150281. }
  150282. #endif /* ifndef SQLITE_AMALGAMATION */
  150283. typedef struct unicode_tokenizer unicode_tokenizer;
  150284. typedef struct unicode_cursor unicode_cursor;
  150285. struct unicode_tokenizer {
  150286. sqlite3_tokenizer base;
  150287. int bRemoveDiacritic;
  150288. int nException;
  150289. int *aiException;
  150290. };
  150291. struct unicode_cursor {
  150292. sqlite3_tokenizer_cursor base;
  150293. const unsigned char *aInput; /* Input text being tokenized */
  150294. int nInput; /* Size of aInput[] in bytes */
  150295. int iOff; /* Current offset within aInput[] */
  150296. int iToken; /* Index of next token to be returned */
  150297. char *zToken; /* storage for current token */
  150298. int nAlloc; /* space allocated at zToken */
  150299. };
  150300. /*
  150301. ** Destroy a tokenizer allocated by unicodeCreate().
  150302. */
  150303. static int unicodeDestroy(sqlite3_tokenizer *pTokenizer){
  150304. if( pTokenizer ){
  150305. unicode_tokenizer *p = (unicode_tokenizer *)pTokenizer;
  150306. sqlite3_free(p->aiException);
  150307. sqlite3_free(p);
  150308. }
  150309. return SQLITE_OK;
  150310. }
  150311. /*
  150312. ** As part of a tokenchars= or separators= option, the CREATE VIRTUAL TABLE
  150313. ** statement has specified that the tokenizer for this table shall consider
  150314. ** all characters in string zIn/nIn to be separators (if bAlnum==0) or
  150315. ** token characters (if bAlnum==1).
  150316. **
  150317. ** For each codepoint in the zIn/nIn string, this function checks if the
  150318. ** sqlite3FtsUnicodeIsalnum() function already returns the desired result.
  150319. ** If so, no action is taken. Otherwise, the codepoint is added to the
  150320. ** unicode_tokenizer.aiException[] array. For the purposes of tokenization,
  150321. ** the return value of sqlite3FtsUnicodeIsalnum() is inverted for all
  150322. ** codepoints in the aiException[] array.
  150323. **
  150324. ** If a standalone diacritic mark (one that sqlite3FtsUnicodeIsdiacritic()
  150325. ** identifies as a diacritic) occurs in the zIn/nIn string it is ignored.
  150326. ** It is not possible to change the behavior of the tokenizer with respect
  150327. ** to these codepoints.
  150328. */
  150329. static int unicodeAddExceptions(
  150330. unicode_tokenizer *p, /* Tokenizer to add exceptions to */
  150331. int bAlnum, /* Replace Isalnum() return value with this */
  150332. const char *zIn, /* Array of characters to make exceptions */
  150333. int nIn /* Length of z in bytes */
  150334. ){
  150335. const unsigned char *z = (const unsigned char *)zIn;
  150336. const unsigned char *zTerm = &z[nIn];
  150337. int iCode;
  150338. int nEntry = 0;
  150339. assert( bAlnum==0 || bAlnum==1 );
  150340. while( z<zTerm ){
  150341. READ_UTF8(z, zTerm, iCode);
  150342. assert( (sqlite3FtsUnicodeIsalnum(iCode) & 0xFFFFFFFE)==0 );
  150343. if( sqlite3FtsUnicodeIsalnum(iCode)!=bAlnum
  150344. && sqlite3FtsUnicodeIsdiacritic(iCode)==0
  150345. ){
  150346. nEntry++;
  150347. }
  150348. }
  150349. if( nEntry ){
  150350. int *aNew; /* New aiException[] array */
  150351. int nNew; /* Number of valid entries in array aNew[] */
  150352. aNew = sqlite3_realloc(p->aiException, (p->nException+nEntry)*sizeof(int));
  150353. if( aNew==0 ) return SQLITE_NOMEM;
  150354. nNew = p->nException;
  150355. z = (const unsigned char *)zIn;
  150356. while( z<zTerm ){
  150357. READ_UTF8(z, zTerm, iCode);
  150358. if( sqlite3FtsUnicodeIsalnum(iCode)!=bAlnum
  150359. && sqlite3FtsUnicodeIsdiacritic(iCode)==0
  150360. ){
  150361. int i, j;
  150362. for(i=0; i<nNew && aNew[i]<iCode; i++);
  150363. for(j=nNew; j>i; j--) aNew[j] = aNew[j-1];
  150364. aNew[i] = iCode;
  150365. nNew++;
  150366. }
  150367. }
  150368. p->aiException = aNew;
  150369. p->nException = nNew;
  150370. }
  150371. return SQLITE_OK;
  150372. }
  150373. /*
  150374. ** Return true if the p->aiException[] array contains the value iCode.
  150375. */
  150376. static int unicodeIsException(unicode_tokenizer *p, int iCode){
  150377. if( p->nException>0 ){
  150378. int *a = p->aiException;
  150379. int iLo = 0;
  150380. int iHi = p->nException-1;
  150381. while( iHi>=iLo ){
  150382. int iTest = (iHi + iLo) / 2;
  150383. if( iCode==a[iTest] ){
  150384. return 1;
  150385. }else if( iCode>a[iTest] ){
  150386. iLo = iTest+1;
  150387. }else{
  150388. iHi = iTest-1;
  150389. }
  150390. }
  150391. }
  150392. return 0;
  150393. }
  150394. /*
  150395. ** Return true if, for the purposes of tokenization, codepoint iCode is
  150396. ** considered a token character (not a separator).
  150397. */
  150398. static int unicodeIsAlnum(unicode_tokenizer *p, int iCode){
  150399. assert( (sqlite3FtsUnicodeIsalnum(iCode) & 0xFFFFFFFE)==0 );
  150400. return sqlite3FtsUnicodeIsalnum(iCode) ^ unicodeIsException(p, iCode);
  150401. }
  150402. /*
  150403. ** Create a new tokenizer instance.
  150404. */
  150405. static int unicodeCreate(
  150406. int nArg, /* Size of array argv[] */
  150407. const char * const *azArg, /* Tokenizer creation arguments */
  150408. sqlite3_tokenizer **pp /* OUT: New tokenizer handle */
  150409. ){
  150410. unicode_tokenizer *pNew; /* New tokenizer object */
  150411. int i;
  150412. int rc = SQLITE_OK;
  150413. pNew = (unicode_tokenizer *) sqlite3_malloc(sizeof(unicode_tokenizer));
  150414. if( pNew==NULL ) return SQLITE_NOMEM;
  150415. memset(pNew, 0, sizeof(unicode_tokenizer));
  150416. pNew->bRemoveDiacritic = 1;
  150417. for(i=0; rc==SQLITE_OK && i<nArg; i++){
  150418. const char *z = azArg[i];
  150419. int n = (int)strlen(z);
  150420. if( n==19 && memcmp("remove_diacritics=1", z, 19)==0 ){
  150421. pNew->bRemoveDiacritic = 1;
  150422. }
  150423. else if( n==19 && memcmp("remove_diacritics=0", z, 19)==0 ){
  150424. pNew->bRemoveDiacritic = 0;
  150425. }
  150426. else if( n>=11 && memcmp("tokenchars=", z, 11)==0 ){
  150427. rc = unicodeAddExceptions(pNew, 1, &z[11], n-11);
  150428. }
  150429. else if( n>=11 && memcmp("separators=", z, 11)==0 ){
  150430. rc = unicodeAddExceptions(pNew, 0, &z[11], n-11);
  150431. }
  150432. else{
  150433. /* Unrecognized argument */
  150434. rc = SQLITE_ERROR;
  150435. }
  150436. }
  150437. if( rc!=SQLITE_OK ){
  150438. unicodeDestroy((sqlite3_tokenizer *)pNew);
  150439. pNew = 0;
  150440. }
  150441. *pp = (sqlite3_tokenizer *)pNew;
  150442. return rc;
  150443. }
  150444. /*
  150445. ** Prepare to begin tokenizing a particular string. The input
  150446. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  150447. ** used to incrementally tokenize this string is returned in
  150448. ** *ppCursor.
  150449. */
  150450. static int unicodeOpen(
  150451. sqlite3_tokenizer *p, /* The tokenizer */
  150452. const char *aInput, /* Input string */
  150453. int nInput, /* Size of string aInput in bytes */
  150454. sqlite3_tokenizer_cursor **pp /* OUT: New cursor object */
  150455. ){
  150456. unicode_cursor *pCsr;
  150457. pCsr = (unicode_cursor *)sqlite3_malloc(sizeof(unicode_cursor));
  150458. if( pCsr==0 ){
  150459. return SQLITE_NOMEM;
  150460. }
  150461. memset(pCsr, 0, sizeof(unicode_cursor));
  150462. pCsr->aInput = (const unsigned char *)aInput;
  150463. if( aInput==0 ){
  150464. pCsr->nInput = 0;
  150465. }else if( nInput<0 ){
  150466. pCsr->nInput = (int)strlen(aInput);
  150467. }else{
  150468. pCsr->nInput = nInput;
  150469. }
  150470. *pp = &pCsr->base;
  150471. UNUSED_PARAMETER(p);
  150472. return SQLITE_OK;
  150473. }
  150474. /*
  150475. ** Close a tokenization cursor previously opened by a call to
  150476. ** simpleOpen() above.
  150477. */
  150478. static int unicodeClose(sqlite3_tokenizer_cursor *pCursor){
  150479. unicode_cursor *pCsr = (unicode_cursor *) pCursor;
  150480. sqlite3_free(pCsr->zToken);
  150481. sqlite3_free(pCsr);
  150482. return SQLITE_OK;
  150483. }
  150484. /*
  150485. ** Extract the next token from a tokenization cursor. The cursor must
  150486. ** have been opened by a prior call to simpleOpen().
  150487. */
  150488. static int unicodeNext(
  150489. sqlite3_tokenizer_cursor *pC, /* Cursor returned by simpleOpen */
  150490. const char **paToken, /* OUT: Token text */
  150491. int *pnToken, /* OUT: Number of bytes at *paToken */
  150492. int *piStart, /* OUT: Starting offset of token */
  150493. int *piEnd, /* OUT: Ending offset of token */
  150494. int *piPos /* OUT: Position integer of token */
  150495. ){
  150496. unicode_cursor *pCsr = (unicode_cursor *)pC;
  150497. unicode_tokenizer *p = ((unicode_tokenizer *)pCsr->base.pTokenizer);
  150498. int iCode = 0;
  150499. char *zOut;
  150500. const unsigned char *z = &pCsr->aInput[pCsr->iOff];
  150501. const unsigned char *zStart = z;
  150502. const unsigned char *zEnd;
  150503. const unsigned char *zTerm = &pCsr->aInput[pCsr->nInput];
  150504. /* Scan past any delimiter characters before the start of the next token.
  150505. ** Return SQLITE_DONE early if this takes us all the way to the end of
  150506. ** the input. */
  150507. while( z<zTerm ){
  150508. READ_UTF8(z, zTerm, iCode);
  150509. if( unicodeIsAlnum(p, iCode) ) break;
  150510. zStart = z;
  150511. }
  150512. if( zStart>=zTerm ) return SQLITE_DONE;
  150513. zOut = pCsr->zToken;
  150514. do {
  150515. int iOut;
  150516. /* Grow the output buffer if required. */
  150517. if( (zOut-pCsr->zToken)>=(pCsr->nAlloc-4) ){
  150518. char *zNew = sqlite3_realloc(pCsr->zToken, pCsr->nAlloc+64);
  150519. if( !zNew ) return SQLITE_NOMEM;
  150520. zOut = &zNew[zOut - pCsr->zToken];
  150521. pCsr->zToken = zNew;
  150522. pCsr->nAlloc += 64;
  150523. }
  150524. /* Write the folded case of the last character read to the output */
  150525. zEnd = z;
  150526. iOut = sqlite3FtsUnicodeFold(iCode, p->bRemoveDiacritic);
  150527. if( iOut ){
  150528. WRITE_UTF8(zOut, iOut);
  150529. }
  150530. /* If the cursor is not at EOF, read the next character */
  150531. if( z>=zTerm ) break;
  150532. READ_UTF8(z, zTerm, iCode);
  150533. }while( unicodeIsAlnum(p, iCode)
  150534. || sqlite3FtsUnicodeIsdiacritic(iCode)
  150535. );
  150536. /* Set the output variables and return. */
  150537. pCsr->iOff = (int)(z - pCsr->aInput);
  150538. *paToken = pCsr->zToken;
  150539. *pnToken = (int)(zOut - pCsr->zToken);
  150540. *piStart = (int)(zStart - pCsr->aInput);
  150541. *piEnd = (int)(zEnd - pCsr->aInput);
  150542. *piPos = pCsr->iToken++;
  150543. return SQLITE_OK;
  150544. }
  150545. /*
  150546. ** Set *ppModule to a pointer to the sqlite3_tokenizer_module
  150547. ** structure for the unicode tokenizer.
  150548. */
  150549. SQLITE_PRIVATE void sqlite3Fts3UnicodeTokenizer(sqlite3_tokenizer_module const **ppModule){
  150550. static const sqlite3_tokenizer_module module = {
  150551. 0,
  150552. unicodeCreate,
  150553. unicodeDestroy,
  150554. unicodeOpen,
  150555. unicodeClose,
  150556. unicodeNext,
  150557. 0,
  150558. };
  150559. *ppModule = &module;
  150560. }
  150561. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  150562. #endif /* ifndef SQLITE_DISABLE_FTS3_UNICODE */
  150563. /************** End of fts3_unicode.c ****************************************/
  150564. /************** Begin file fts3_unicode2.c ***********************************/
  150565. /*
  150566. ** 2012 May 25
  150567. **
  150568. ** The author disclaims copyright to this source code. In place of
  150569. ** a legal notice, here is a blessing:
  150570. **
  150571. ** May you do good and not evil.
  150572. ** May you find forgiveness for yourself and forgive others.
  150573. ** May you share freely, never taking more than you give.
  150574. **
  150575. ******************************************************************************
  150576. */
  150577. /*
  150578. ** DO NOT EDIT THIS MACHINE GENERATED FILE.
  150579. */
  150580. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  150581. #if defined(SQLITE_ENABLE_FTS3) || defined(SQLITE_ENABLE_FTS4)
  150582. /* #include <assert.h> */
  150583. /*
  150584. ** Return true if the argument corresponds to a unicode codepoint
  150585. ** classified as either a letter or a number. Otherwise false.
  150586. **
  150587. ** The results are undefined if the value passed to this function
  150588. ** is less than zero.
  150589. */
  150590. SQLITE_PRIVATE int sqlite3FtsUnicodeIsalnum(int c){
  150591. /* Each unsigned integer in the following array corresponds to a contiguous
  150592. ** range of unicode codepoints that are not either letters or numbers (i.e.
  150593. ** codepoints for which this function should return 0).
  150594. **
  150595. ** The most significant 22 bits in each 32-bit value contain the first
  150596. ** codepoint in the range. The least significant 10 bits are used to store
  150597. ** the size of the range (always at least 1). In other words, the value
  150598. ** ((C<<22) + N) represents a range of N codepoints starting with codepoint
  150599. ** C. It is not possible to represent a range larger than 1023 codepoints
  150600. ** using this format.
  150601. */
  150602. static const unsigned int aEntry[] = {
  150603. 0x00000030, 0x0000E807, 0x00016C06, 0x0001EC2F, 0x0002AC07,
  150604. 0x0002D001, 0x0002D803, 0x0002EC01, 0x0002FC01, 0x00035C01,
  150605. 0x0003DC01, 0x000B0804, 0x000B480E, 0x000B9407, 0x000BB401,
  150606. 0x000BBC81, 0x000DD401, 0x000DF801, 0x000E1002, 0x000E1C01,
  150607. 0x000FD801, 0x00120808, 0x00156806, 0x00162402, 0x00163C01,
  150608. 0x00164437, 0x0017CC02, 0x00180005, 0x00181816, 0x00187802,
  150609. 0x00192C15, 0x0019A804, 0x0019C001, 0x001B5001, 0x001B580F,
  150610. 0x001B9C07, 0x001BF402, 0x001C000E, 0x001C3C01, 0x001C4401,
  150611. 0x001CC01B, 0x001E980B, 0x001FAC09, 0x001FD804, 0x00205804,
  150612. 0x00206C09, 0x00209403, 0x0020A405, 0x0020C00F, 0x00216403,
  150613. 0x00217801, 0x0023901B, 0x00240004, 0x0024E803, 0x0024F812,
  150614. 0x00254407, 0x00258804, 0x0025C001, 0x00260403, 0x0026F001,
  150615. 0x0026F807, 0x00271C02, 0x00272C03, 0x00275C01, 0x00278802,
  150616. 0x0027C802, 0x0027E802, 0x00280403, 0x0028F001, 0x0028F805,
  150617. 0x00291C02, 0x00292C03, 0x00294401, 0x0029C002, 0x0029D401,
  150618. 0x002A0403, 0x002AF001, 0x002AF808, 0x002B1C03, 0x002B2C03,
  150619. 0x002B8802, 0x002BC002, 0x002C0403, 0x002CF001, 0x002CF807,
  150620. 0x002D1C02, 0x002D2C03, 0x002D5802, 0x002D8802, 0x002DC001,
  150621. 0x002E0801, 0x002EF805, 0x002F1803, 0x002F2804, 0x002F5C01,
  150622. 0x002FCC08, 0x00300403, 0x0030F807, 0x00311803, 0x00312804,
  150623. 0x00315402, 0x00318802, 0x0031FC01, 0x00320802, 0x0032F001,
  150624. 0x0032F807, 0x00331803, 0x00332804, 0x00335402, 0x00338802,
  150625. 0x00340802, 0x0034F807, 0x00351803, 0x00352804, 0x00355C01,
  150626. 0x00358802, 0x0035E401, 0x00360802, 0x00372801, 0x00373C06,
  150627. 0x00375801, 0x00376008, 0x0037C803, 0x0038C401, 0x0038D007,
  150628. 0x0038FC01, 0x00391C09, 0x00396802, 0x003AC401, 0x003AD006,
  150629. 0x003AEC02, 0x003B2006, 0x003C041F, 0x003CD00C, 0x003DC417,
  150630. 0x003E340B, 0x003E6424, 0x003EF80F, 0x003F380D, 0x0040AC14,
  150631. 0x00412806, 0x00415804, 0x00417803, 0x00418803, 0x00419C07,
  150632. 0x0041C404, 0x0042080C, 0x00423C01, 0x00426806, 0x0043EC01,
  150633. 0x004D740C, 0x004E400A, 0x00500001, 0x0059B402, 0x005A0001,
  150634. 0x005A6C02, 0x005BAC03, 0x005C4803, 0x005CC805, 0x005D4802,
  150635. 0x005DC802, 0x005ED023, 0x005F6004, 0x005F7401, 0x0060000F,
  150636. 0x0062A401, 0x0064800C, 0x0064C00C, 0x00650001, 0x00651002,
  150637. 0x0066C011, 0x00672002, 0x00677822, 0x00685C05, 0x00687802,
  150638. 0x0069540A, 0x0069801D, 0x0069FC01, 0x006A8007, 0x006AA006,
  150639. 0x006C0005, 0x006CD011, 0x006D6823, 0x006E0003, 0x006E840D,
  150640. 0x006F980E, 0x006FF004, 0x00709014, 0x0070EC05, 0x0071F802,
  150641. 0x00730008, 0x00734019, 0x0073B401, 0x0073C803, 0x00770027,
  150642. 0x0077F004, 0x007EF401, 0x007EFC03, 0x007F3403, 0x007F7403,
  150643. 0x007FB403, 0x007FF402, 0x00800065, 0x0081A806, 0x0081E805,
  150644. 0x00822805, 0x0082801A, 0x00834021, 0x00840002, 0x00840C04,
  150645. 0x00842002, 0x00845001, 0x00845803, 0x00847806, 0x00849401,
  150646. 0x00849C01, 0x0084A401, 0x0084B801, 0x0084E802, 0x00850005,
  150647. 0x00852804, 0x00853C01, 0x00864264, 0x00900027, 0x0091000B,
  150648. 0x0092704E, 0x00940200, 0x009C0475, 0x009E53B9, 0x00AD400A,
  150649. 0x00B39406, 0x00B3BC03, 0x00B3E404, 0x00B3F802, 0x00B5C001,
  150650. 0x00B5FC01, 0x00B7804F, 0x00B8C00C, 0x00BA001A, 0x00BA6C59,
  150651. 0x00BC00D6, 0x00BFC00C, 0x00C00005, 0x00C02019, 0x00C0A807,
  150652. 0x00C0D802, 0x00C0F403, 0x00C26404, 0x00C28001, 0x00C3EC01,
  150653. 0x00C64002, 0x00C6580A, 0x00C70024, 0x00C8001F, 0x00C8A81E,
  150654. 0x00C94001, 0x00C98020, 0x00CA2827, 0x00CB003F, 0x00CC0100,
  150655. 0x01370040, 0x02924037, 0x0293F802, 0x02983403, 0x0299BC10,
  150656. 0x029A7C01, 0x029BC008, 0x029C0017, 0x029C8002, 0x029E2402,
  150657. 0x02A00801, 0x02A01801, 0x02A02C01, 0x02A08C09, 0x02A0D804,
  150658. 0x02A1D004, 0x02A20002, 0x02A2D011, 0x02A33802, 0x02A38012,
  150659. 0x02A3E003, 0x02A4980A, 0x02A51C0D, 0x02A57C01, 0x02A60004,
  150660. 0x02A6CC1B, 0x02A77802, 0x02A8A40E, 0x02A90C01, 0x02A93002,
  150661. 0x02A97004, 0x02A9DC03, 0x02A9EC01, 0x02AAC001, 0x02AAC803,
  150662. 0x02AADC02, 0x02AAF802, 0x02AB0401, 0x02AB7802, 0x02ABAC07,
  150663. 0x02ABD402, 0x02AF8C0B, 0x03600001, 0x036DFC02, 0x036FFC02,
  150664. 0x037FFC01, 0x03EC7801, 0x03ECA401, 0x03EEC810, 0x03F4F802,
  150665. 0x03F7F002, 0x03F8001A, 0x03F88007, 0x03F8C023, 0x03F95013,
  150666. 0x03F9A004, 0x03FBFC01, 0x03FC040F, 0x03FC6807, 0x03FCEC06,
  150667. 0x03FD6C0B, 0x03FF8007, 0x03FFA007, 0x03FFE405, 0x04040003,
  150668. 0x0404DC09, 0x0405E411, 0x0406400C, 0x0407402E, 0x040E7C01,
  150669. 0x040F4001, 0x04215C01, 0x04247C01, 0x0424FC01, 0x04280403,
  150670. 0x04281402, 0x04283004, 0x0428E003, 0x0428FC01, 0x04294009,
  150671. 0x0429FC01, 0x042CE407, 0x04400003, 0x0440E016, 0x04420003,
  150672. 0x0442C012, 0x04440003, 0x04449C0E, 0x04450004, 0x04460003,
  150673. 0x0446CC0E, 0x04471404, 0x045AAC0D, 0x0491C004, 0x05BD442E,
  150674. 0x05BE3C04, 0x074000F6, 0x07440027, 0x0744A4B5, 0x07480046,
  150675. 0x074C0057, 0x075B0401, 0x075B6C01, 0x075BEC01, 0x075C5401,
  150676. 0x075CD401, 0x075D3C01, 0x075DBC01, 0x075E2401, 0x075EA401,
  150677. 0x075F0C01, 0x07BBC002, 0x07C0002C, 0x07C0C064, 0x07C2800F,
  150678. 0x07C2C40E, 0x07C3040F, 0x07C3440F, 0x07C4401F, 0x07C4C03C,
  150679. 0x07C5C02B, 0x07C7981D, 0x07C8402B, 0x07C90009, 0x07C94002,
  150680. 0x07CC0021, 0x07CCC006, 0x07CCDC46, 0x07CE0014, 0x07CE8025,
  150681. 0x07CF1805, 0x07CF8011, 0x07D0003F, 0x07D10001, 0x07D108B6,
  150682. 0x07D3E404, 0x07D4003E, 0x07D50004, 0x07D54018, 0x07D7EC46,
  150683. 0x07D9140B, 0x07DA0046, 0x07DC0074, 0x38000401, 0x38008060,
  150684. 0x380400F0,
  150685. };
  150686. static const unsigned int aAscii[4] = {
  150687. 0xFFFFFFFF, 0xFC00FFFF, 0xF8000001, 0xF8000001,
  150688. };
  150689. if( c<128 ){
  150690. return ( (aAscii[c >> 5] & (1 << (c & 0x001F)))==0 );
  150691. }else if( c<(1<<22) ){
  150692. unsigned int key = (((unsigned int)c)<<10) | 0x000003FF;
  150693. int iRes = 0;
  150694. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  150695. int iLo = 0;
  150696. while( iHi>=iLo ){
  150697. int iTest = (iHi + iLo) / 2;
  150698. if( key >= aEntry[iTest] ){
  150699. iRes = iTest;
  150700. iLo = iTest+1;
  150701. }else{
  150702. iHi = iTest-1;
  150703. }
  150704. }
  150705. assert( aEntry[0]<key );
  150706. assert( key>=aEntry[iRes] );
  150707. return (((unsigned int)c) >= ((aEntry[iRes]>>10) + (aEntry[iRes]&0x3FF)));
  150708. }
  150709. return 1;
  150710. }
  150711. /*
  150712. ** If the argument is a codepoint corresponding to a lowercase letter
  150713. ** in the ASCII range with a diacritic added, return the codepoint
  150714. ** of the ASCII letter only. For example, if passed 235 - "LATIN
  150715. ** SMALL LETTER E WITH DIAERESIS" - return 65 ("LATIN SMALL LETTER
  150716. ** E"). The resuls of passing a codepoint that corresponds to an
  150717. ** uppercase letter are undefined.
  150718. */
  150719. static int remove_diacritic(int c){
  150720. unsigned short aDia[] = {
  150721. 0, 1797, 1848, 1859, 1891, 1928, 1940, 1995,
  150722. 2024, 2040, 2060, 2110, 2168, 2206, 2264, 2286,
  150723. 2344, 2383, 2472, 2488, 2516, 2596, 2668, 2732,
  150724. 2782, 2842, 2894, 2954, 2984, 3000, 3028, 3336,
  150725. 3456, 3696, 3712, 3728, 3744, 3896, 3912, 3928,
  150726. 3968, 4008, 4040, 4106, 4138, 4170, 4202, 4234,
  150727. 4266, 4296, 4312, 4344, 4408, 4424, 4472, 4504,
  150728. 6148, 6198, 6264, 6280, 6360, 6429, 6505, 6529,
  150729. 61448, 61468, 61534, 61592, 61642, 61688, 61704, 61726,
  150730. 61784, 61800, 61836, 61880, 61914, 61948, 61998, 62122,
  150731. 62154, 62200, 62218, 62302, 62364, 62442, 62478, 62536,
  150732. 62554, 62584, 62604, 62640, 62648, 62656, 62664, 62730,
  150733. 62924, 63050, 63082, 63274, 63390,
  150734. };
  150735. char aChar[] = {
  150736. '\0', 'a', 'c', 'e', 'i', 'n', 'o', 'u', 'y', 'y', 'a', 'c',
  150737. 'd', 'e', 'e', 'g', 'h', 'i', 'j', 'k', 'l', 'n', 'o', 'r',
  150738. 's', 't', 'u', 'u', 'w', 'y', 'z', 'o', 'u', 'a', 'i', 'o',
  150739. 'u', 'g', 'k', 'o', 'j', 'g', 'n', 'a', 'e', 'i', 'o', 'r',
  150740. 'u', 's', 't', 'h', 'a', 'e', 'o', 'y', '\0', '\0', '\0', '\0',
  150741. '\0', '\0', '\0', '\0', 'a', 'b', 'd', 'd', 'e', 'f', 'g', 'h',
  150742. 'h', 'i', 'k', 'l', 'l', 'm', 'n', 'p', 'r', 'r', 's', 't',
  150743. 'u', 'v', 'w', 'w', 'x', 'y', 'z', 'h', 't', 'w', 'y', 'a',
  150744. 'e', 'i', 'o', 'u', 'y',
  150745. };
  150746. unsigned int key = (((unsigned int)c)<<3) | 0x00000007;
  150747. int iRes = 0;
  150748. int iHi = sizeof(aDia)/sizeof(aDia[0]) - 1;
  150749. int iLo = 0;
  150750. while( iHi>=iLo ){
  150751. int iTest = (iHi + iLo) / 2;
  150752. if( key >= aDia[iTest] ){
  150753. iRes = iTest;
  150754. iLo = iTest+1;
  150755. }else{
  150756. iHi = iTest-1;
  150757. }
  150758. }
  150759. assert( key>=aDia[iRes] );
  150760. return ((c > (aDia[iRes]>>3) + (aDia[iRes]&0x07)) ? c : (int)aChar[iRes]);
  150761. }
  150762. /*
  150763. ** Return true if the argument interpreted as a unicode codepoint
  150764. ** is a diacritical modifier character.
  150765. */
  150766. SQLITE_PRIVATE int sqlite3FtsUnicodeIsdiacritic(int c){
  150767. unsigned int mask0 = 0x08029FDF;
  150768. unsigned int mask1 = 0x000361F8;
  150769. if( c<768 || c>817 ) return 0;
  150770. return (c < 768+32) ?
  150771. (mask0 & (1 << (c-768))) :
  150772. (mask1 & (1 << (c-768-32)));
  150773. }
  150774. /*
  150775. ** Interpret the argument as a unicode codepoint. If the codepoint
  150776. ** is an upper case character that has a lower case equivalent,
  150777. ** return the codepoint corresponding to the lower case version.
  150778. ** Otherwise, return a copy of the argument.
  150779. **
  150780. ** The results are undefined if the value passed to this function
  150781. ** is less than zero.
  150782. */
  150783. SQLITE_PRIVATE int sqlite3FtsUnicodeFold(int c, int bRemoveDiacritic){
  150784. /* Each entry in the following array defines a rule for folding a range
  150785. ** of codepoints to lower case. The rule applies to a range of nRange
  150786. ** codepoints starting at codepoint iCode.
  150787. **
  150788. ** If the least significant bit in flags is clear, then the rule applies
  150789. ** to all nRange codepoints (i.e. all nRange codepoints are upper case and
  150790. ** need to be folded). Or, if it is set, then the rule only applies to
  150791. ** every second codepoint in the range, starting with codepoint C.
  150792. **
  150793. ** The 7 most significant bits in flags are an index into the aiOff[]
  150794. ** array. If a specific codepoint C does require folding, then its lower
  150795. ** case equivalent is ((C + aiOff[flags>>1]) & 0xFFFF).
  150796. **
  150797. ** The contents of this array are generated by parsing the CaseFolding.txt
  150798. ** file distributed as part of the "Unicode Character Database". See
  150799. ** http://www.unicode.org for details.
  150800. */
  150801. static const struct TableEntry {
  150802. unsigned short iCode;
  150803. unsigned char flags;
  150804. unsigned char nRange;
  150805. } aEntry[] = {
  150806. {65, 14, 26}, {181, 64, 1}, {192, 14, 23},
  150807. {216, 14, 7}, {256, 1, 48}, {306, 1, 6},
  150808. {313, 1, 16}, {330, 1, 46}, {376, 116, 1},
  150809. {377, 1, 6}, {383, 104, 1}, {385, 50, 1},
  150810. {386, 1, 4}, {390, 44, 1}, {391, 0, 1},
  150811. {393, 42, 2}, {395, 0, 1}, {398, 32, 1},
  150812. {399, 38, 1}, {400, 40, 1}, {401, 0, 1},
  150813. {403, 42, 1}, {404, 46, 1}, {406, 52, 1},
  150814. {407, 48, 1}, {408, 0, 1}, {412, 52, 1},
  150815. {413, 54, 1}, {415, 56, 1}, {416, 1, 6},
  150816. {422, 60, 1}, {423, 0, 1}, {425, 60, 1},
  150817. {428, 0, 1}, {430, 60, 1}, {431, 0, 1},
  150818. {433, 58, 2}, {435, 1, 4}, {439, 62, 1},
  150819. {440, 0, 1}, {444, 0, 1}, {452, 2, 1},
  150820. {453, 0, 1}, {455, 2, 1}, {456, 0, 1},
  150821. {458, 2, 1}, {459, 1, 18}, {478, 1, 18},
  150822. {497, 2, 1}, {498, 1, 4}, {502, 122, 1},
  150823. {503, 134, 1}, {504, 1, 40}, {544, 110, 1},
  150824. {546, 1, 18}, {570, 70, 1}, {571, 0, 1},
  150825. {573, 108, 1}, {574, 68, 1}, {577, 0, 1},
  150826. {579, 106, 1}, {580, 28, 1}, {581, 30, 1},
  150827. {582, 1, 10}, {837, 36, 1}, {880, 1, 4},
  150828. {886, 0, 1}, {902, 18, 1}, {904, 16, 3},
  150829. {908, 26, 1}, {910, 24, 2}, {913, 14, 17},
  150830. {931, 14, 9}, {962, 0, 1}, {975, 4, 1},
  150831. {976, 140, 1}, {977, 142, 1}, {981, 146, 1},
  150832. {982, 144, 1}, {984, 1, 24}, {1008, 136, 1},
  150833. {1009, 138, 1}, {1012, 130, 1}, {1013, 128, 1},
  150834. {1015, 0, 1}, {1017, 152, 1}, {1018, 0, 1},
  150835. {1021, 110, 3}, {1024, 34, 16}, {1040, 14, 32},
  150836. {1120, 1, 34}, {1162, 1, 54}, {1216, 6, 1},
  150837. {1217, 1, 14}, {1232, 1, 88}, {1329, 22, 38},
  150838. {4256, 66, 38}, {4295, 66, 1}, {4301, 66, 1},
  150839. {7680, 1, 150}, {7835, 132, 1}, {7838, 96, 1},
  150840. {7840, 1, 96}, {7944, 150, 8}, {7960, 150, 6},
  150841. {7976, 150, 8}, {7992, 150, 8}, {8008, 150, 6},
  150842. {8025, 151, 8}, {8040, 150, 8}, {8072, 150, 8},
  150843. {8088, 150, 8}, {8104, 150, 8}, {8120, 150, 2},
  150844. {8122, 126, 2}, {8124, 148, 1}, {8126, 100, 1},
  150845. {8136, 124, 4}, {8140, 148, 1}, {8152, 150, 2},
  150846. {8154, 120, 2}, {8168, 150, 2}, {8170, 118, 2},
  150847. {8172, 152, 1}, {8184, 112, 2}, {8186, 114, 2},
  150848. {8188, 148, 1}, {8486, 98, 1}, {8490, 92, 1},
  150849. {8491, 94, 1}, {8498, 12, 1}, {8544, 8, 16},
  150850. {8579, 0, 1}, {9398, 10, 26}, {11264, 22, 47},
  150851. {11360, 0, 1}, {11362, 88, 1}, {11363, 102, 1},
  150852. {11364, 90, 1}, {11367, 1, 6}, {11373, 84, 1},
  150853. {11374, 86, 1}, {11375, 80, 1}, {11376, 82, 1},
  150854. {11378, 0, 1}, {11381, 0, 1}, {11390, 78, 2},
  150855. {11392, 1, 100}, {11499, 1, 4}, {11506, 0, 1},
  150856. {42560, 1, 46}, {42624, 1, 24}, {42786, 1, 14},
  150857. {42802, 1, 62}, {42873, 1, 4}, {42877, 76, 1},
  150858. {42878, 1, 10}, {42891, 0, 1}, {42893, 74, 1},
  150859. {42896, 1, 4}, {42912, 1, 10}, {42922, 72, 1},
  150860. {65313, 14, 26},
  150861. };
  150862. static const unsigned short aiOff[] = {
  150863. 1, 2, 8, 15, 16, 26, 28, 32,
  150864. 37, 38, 40, 48, 63, 64, 69, 71,
  150865. 79, 80, 116, 202, 203, 205, 206, 207,
  150866. 209, 210, 211, 213, 214, 217, 218, 219,
  150867. 775, 7264, 10792, 10795, 23228, 23256, 30204, 54721,
  150868. 54753, 54754, 54756, 54787, 54793, 54809, 57153, 57274,
  150869. 57921, 58019, 58363, 61722, 65268, 65341, 65373, 65406,
  150870. 65408, 65410, 65415, 65424, 65436, 65439, 65450, 65462,
  150871. 65472, 65476, 65478, 65480, 65482, 65488, 65506, 65511,
  150872. 65514, 65521, 65527, 65528, 65529,
  150873. };
  150874. int ret = c;
  150875. assert( c>=0 );
  150876. assert( sizeof(unsigned short)==2 && sizeof(unsigned char)==1 );
  150877. if( c<128 ){
  150878. if( c>='A' && c<='Z' ) ret = c + ('a' - 'A');
  150879. }else if( c<65536 ){
  150880. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  150881. int iLo = 0;
  150882. int iRes = -1;
  150883. while( iHi>=iLo ){
  150884. int iTest = (iHi + iLo) / 2;
  150885. int cmp = (c - aEntry[iTest].iCode);
  150886. if( cmp>=0 ){
  150887. iRes = iTest;
  150888. iLo = iTest+1;
  150889. }else{
  150890. iHi = iTest-1;
  150891. }
  150892. }
  150893. assert( iRes<0 || c>=aEntry[iRes].iCode );
  150894. if( iRes>=0 ){
  150895. const struct TableEntry *p = &aEntry[iRes];
  150896. if( c<(p->iCode + p->nRange) && 0==(0x01 & p->flags & (p->iCode ^ c)) ){
  150897. ret = (c + (aiOff[p->flags>>1])) & 0x0000FFFF;
  150898. assert( ret>0 );
  150899. }
  150900. }
  150901. if( bRemoveDiacritic ) ret = remove_diacritic(ret);
  150902. }
  150903. else if( c>=66560 && c<66600 ){
  150904. ret = c + 40;
  150905. }
  150906. return ret;
  150907. }
  150908. #endif /* defined(SQLITE_ENABLE_FTS3) || defined(SQLITE_ENABLE_FTS4) */
  150909. #endif /* !defined(SQLITE_DISABLE_FTS3_UNICODE) */
  150910. /************** End of fts3_unicode2.c ***************************************/
  150911. /************** Begin file rtree.c *******************************************/
  150912. /*
  150913. ** 2001 September 15
  150914. **
  150915. ** The author disclaims copyright to this source code. In place of
  150916. ** a legal notice, here is a blessing:
  150917. **
  150918. ** May you do good and not evil.
  150919. ** May you find forgiveness for yourself and forgive others.
  150920. ** May you share freely, never taking more than you give.
  150921. **
  150922. *************************************************************************
  150923. ** This file contains code for implementations of the r-tree and r*-tree
  150924. ** algorithms packaged as an SQLite virtual table module.
  150925. */
  150926. /*
  150927. ** Database Format of R-Tree Tables
  150928. ** --------------------------------
  150929. **
  150930. ** The data structure for a single virtual r-tree table is stored in three
  150931. ** native SQLite tables declared as follows. In each case, the '%' character
  150932. ** in the table name is replaced with the user-supplied name of the r-tree
  150933. ** table.
  150934. **
  150935. ** CREATE TABLE %_node(nodeno INTEGER PRIMARY KEY, data BLOB)
  150936. ** CREATE TABLE %_parent(nodeno INTEGER PRIMARY KEY, parentnode INTEGER)
  150937. ** CREATE TABLE %_rowid(rowid INTEGER PRIMARY KEY, nodeno INTEGER)
  150938. **
  150939. ** The data for each node of the r-tree structure is stored in the %_node
  150940. ** table. For each node that is not the root node of the r-tree, there is
  150941. ** an entry in the %_parent table associating the node with its parent.
  150942. ** And for each row of data in the table, there is an entry in the %_rowid
  150943. ** table that maps from the entries rowid to the id of the node that it
  150944. ** is stored on.
  150945. **
  150946. ** The root node of an r-tree always exists, even if the r-tree table is
  150947. ** empty. The nodeno of the root node is always 1. All other nodes in the
  150948. ** table must be the same size as the root node. The content of each node
  150949. ** is formatted as follows:
  150950. **
  150951. ** 1. If the node is the root node (node 1), then the first 2 bytes
  150952. ** of the node contain the tree depth as a big-endian integer.
  150953. ** For non-root nodes, the first 2 bytes are left unused.
  150954. **
  150955. ** 2. The next 2 bytes contain the number of entries currently
  150956. ** stored in the node.
  150957. **
  150958. ** 3. The remainder of the node contains the node entries. Each entry
  150959. ** consists of a single 8-byte integer followed by an even number
  150960. ** of 4-byte coordinates. For leaf nodes the integer is the rowid
  150961. ** of a record. For internal nodes it is the node number of a
  150962. ** child page.
  150963. */
  150964. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_RTREE)
  150965. #ifndef SQLITE_CORE
  150966. /* #include "sqlite3ext.h" */
  150967. SQLITE_EXTENSION_INIT1
  150968. #else
  150969. /* #include "sqlite3.h" */
  150970. #endif
  150971. /* #include <string.h> */
  150972. /* #include <assert.h> */
  150973. /* #include <stdio.h> */
  150974. #ifndef SQLITE_AMALGAMATION
  150975. #include "sqlite3rtree.h"
  150976. typedef sqlite3_int64 i64;
  150977. typedef unsigned char u8;
  150978. typedef unsigned short u16;
  150979. typedef unsigned int u32;
  150980. #endif
  150981. /* The following macro is used to suppress compiler warnings.
  150982. */
  150983. #ifndef UNUSED_PARAMETER
  150984. # define UNUSED_PARAMETER(x) (void)(x)
  150985. #endif
  150986. typedef struct Rtree Rtree;
  150987. typedef struct RtreeCursor RtreeCursor;
  150988. typedef struct RtreeNode RtreeNode;
  150989. typedef struct RtreeCell RtreeCell;
  150990. typedef struct RtreeConstraint RtreeConstraint;
  150991. typedef struct RtreeMatchArg RtreeMatchArg;
  150992. typedef struct RtreeGeomCallback RtreeGeomCallback;
  150993. typedef union RtreeCoord RtreeCoord;
  150994. typedef struct RtreeSearchPoint RtreeSearchPoint;
  150995. /* The rtree may have between 1 and RTREE_MAX_DIMENSIONS dimensions. */
  150996. #define RTREE_MAX_DIMENSIONS 5
  150997. /* Size of hash table Rtree.aHash. This hash table is not expected to
  150998. ** ever contain very many entries, so a fixed number of buckets is
  150999. ** used.
  151000. */
  151001. #define HASHSIZE 97
  151002. /* The xBestIndex method of this virtual table requires an estimate of
  151003. ** the number of rows in the virtual table to calculate the costs of
  151004. ** various strategies. If possible, this estimate is loaded from the
  151005. ** sqlite_stat1 table (with RTREE_MIN_ROWEST as a hard-coded minimum).
  151006. ** Otherwise, if no sqlite_stat1 entry is available, use
  151007. ** RTREE_DEFAULT_ROWEST.
  151008. */
  151009. #define RTREE_DEFAULT_ROWEST 1048576
  151010. #define RTREE_MIN_ROWEST 100
  151011. /*
  151012. ** An rtree virtual-table object.
  151013. */
  151014. struct Rtree {
  151015. sqlite3_vtab base; /* Base class. Must be first */
  151016. sqlite3 *db; /* Host database connection */
  151017. int iNodeSize; /* Size in bytes of each node in the node table */
  151018. u8 nDim; /* Number of dimensions */
  151019. u8 eCoordType; /* RTREE_COORD_REAL32 or RTREE_COORD_INT32 */
  151020. u8 nBytesPerCell; /* Bytes consumed per cell */
  151021. int iDepth; /* Current depth of the r-tree structure */
  151022. char *zDb; /* Name of database containing r-tree table */
  151023. char *zName; /* Name of r-tree table */
  151024. int nBusy; /* Current number of users of this structure */
  151025. i64 nRowEst; /* Estimated number of rows in this table */
  151026. /* List of nodes removed during a CondenseTree operation. List is
  151027. ** linked together via the pointer normally used for hash chains -
  151028. ** RtreeNode.pNext. RtreeNode.iNode stores the depth of the sub-tree
  151029. ** headed by the node (leaf nodes have RtreeNode.iNode==0).
  151030. */
  151031. RtreeNode *pDeleted;
  151032. int iReinsertHeight; /* Height of sub-trees Reinsert() has run on */
  151033. /* Statements to read/write/delete a record from xxx_node */
  151034. sqlite3_stmt *pReadNode;
  151035. sqlite3_stmt *pWriteNode;
  151036. sqlite3_stmt *pDeleteNode;
  151037. /* Statements to read/write/delete a record from xxx_rowid */
  151038. sqlite3_stmt *pReadRowid;
  151039. sqlite3_stmt *pWriteRowid;
  151040. sqlite3_stmt *pDeleteRowid;
  151041. /* Statements to read/write/delete a record from xxx_parent */
  151042. sqlite3_stmt *pReadParent;
  151043. sqlite3_stmt *pWriteParent;
  151044. sqlite3_stmt *pDeleteParent;
  151045. RtreeNode *aHash[HASHSIZE]; /* Hash table of in-memory nodes. */
  151046. };
  151047. /* Possible values for Rtree.eCoordType: */
  151048. #define RTREE_COORD_REAL32 0
  151049. #define RTREE_COORD_INT32 1
  151050. /*
  151051. ** If SQLITE_RTREE_INT_ONLY is defined, then this virtual table will
  151052. ** only deal with integer coordinates. No floating point operations
  151053. ** will be done.
  151054. */
  151055. #ifdef SQLITE_RTREE_INT_ONLY
  151056. typedef sqlite3_int64 RtreeDValue; /* High accuracy coordinate */
  151057. typedef int RtreeValue; /* Low accuracy coordinate */
  151058. # define RTREE_ZERO 0
  151059. #else
  151060. typedef double RtreeDValue; /* High accuracy coordinate */
  151061. typedef float RtreeValue; /* Low accuracy coordinate */
  151062. # define RTREE_ZERO 0.0
  151063. #endif
  151064. /*
  151065. ** When doing a search of an r-tree, instances of the following structure
  151066. ** record intermediate results from the tree walk.
  151067. **
  151068. ** The id is always a node-id. For iLevel>=1 the id is the node-id of
  151069. ** the node that the RtreeSearchPoint represents. When iLevel==0, however,
  151070. ** the id is of the parent node and the cell that RtreeSearchPoint
  151071. ** represents is the iCell-th entry in the parent node.
  151072. */
  151073. struct RtreeSearchPoint {
  151074. RtreeDValue rScore; /* The score for this node. Smallest goes first. */
  151075. sqlite3_int64 id; /* Node ID */
  151076. u8 iLevel; /* 0=entries. 1=leaf node. 2+ for higher */
  151077. u8 eWithin; /* PARTLY_WITHIN or FULLY_WITHIN */
  151078. u8 iCell; /* Cell index within the node */
  151079. };
  151080. /*
  151081. ** The minimum number of cells allowed for a node is a third of the
  151082. ** maximum. In Gutman's notation:
  151083. **
  151084. ** m = M/3
  151085. **
  151086. ** If an R*-tree "Reinsert" operation is required, the same number of
  151087. ** cells are removed from the overfull node and reinserted into the tree.
  151088. */
  151089. #define RTREE_MINCELLS(p) ((((p)->iNodeSize-4)/(p)->nBytesPerCell)/3)
  151090. #define RTREE_REINSERT(p) RTREE_MINCELLS(p)
  151091. #define RTREE_MAXCELLS 51
  151092. /*
  151093. ** The smallest possible node-size is (512-64)==448 bytes. And the largest
  151094. ** supported cell size is 48 bytes (8 byte rowid + ten 4 byte coordinates).
  151095. ** Therefore all non-root nodes must contain at least 3 entries. Since
  151096. ** 2^40 is greater than 2^64, an r-tree structure always has a depth of
  151097. ** 40 or less.
  151098. */
  151099. #define RTREE_MAX_DEPTH 40
  151100. /*
  151101. ** Number of entries in the cursor RtreeNode cache. The first entry is
  151102. ** used to cache the RtreeNode for RtreeCursor.sPoint. The remaining
  151103. ** entries cache the RtreeNode for the first elements of the priority queue.
  151104. */
  151105. #define RTREE_CACHE_SZ 5
  151106. /*
  151107. ** An rtree cursor object.
  151108. */
  151109. struct RtreeCursor {
  151110. sqlite3_vtab_cursor base; /* Base class. Must be first */
  151111. u8 atEOF; /* True if at end of search */
  151112. u8 bPoint; /* True if sPoint is valid */
  151113. int iStrategy; /* Copy of idxNum search parameter */
  151114. int nConstraint; /* Number of entries in aConstraint */
  151115. RtreeConstraint *aConstraint; /* Search constraints. */
  151116. int nPointAlloc; /* Number of slots allocated for aPoint[] */
  151117. int nPoint; /* Number of slots used in aPoint[] */
  151118. int mxLevel; /* iLevel value for root of the tree */
  151119. RtreeSearchPoint *aPoint; /* Priority queue for search points */
  151120. RtreeSearchPoint sPoint; /* Cached next search point */
  151121. RtreeNode *aNode[RTREE_CACHE_SZ]; /* Rtree node cache */
  151122. u32 anQueue[RTREE_MAX_DEPTH+1]; /* Number of queued entries by iLevel */
  151123. };
  151124. /* Return the Rtree of a RtreeCursor */
  151125. #define RTREE_OF_CURSOR(X) ((Rtree*)((X)->base.pVtab))
  151126. /*
  151127. ** A coordinate can be either a floating point number or a integer. All
  151128. ** coordinates within a single R-Tree are always of the same time.
  151129. */
  151130. union RtreeCoord {
  151131. RtreeValue f; /* Floating point value */
  151132. int i; /* Integer value */
  151133. u32 u; /* Unsigned for byte-order conversions */
  151134. };
  151135. /*
  151136. ** The argument is an RtreeCoord. Return the value stored within the RtreeCoord
  151137. ** formatted as a RtreeDValue (double or int64). This macro assumes that local
  151138. ** variable pRtree points to the Rtree structure associated with the
  151139. ** RtreeCoord.
  151140. */
  151141. #ifdef SQLITE_RTREE_INT_ONLY
  151142. # define DCOORD(coord) ((RtreeDValue)coord.i)
  151143. #else
  151144. # define DCOORD(coord) ( \
  151145. (pRtree->eCoordType==RTREE_COORD_REAL32) ? \
  151146. ((double)coord.f) : \
  151147. ((double)coord.i) \
  151148. )
  151149. #endif
  151150. /*
  151151. ** A search constraint.
  151152. */
  151153. struct RtreeConstraint {
  151154. int iCoord; /* Index of constrained coordinate */
  151155. int op; /* Constraining operation */
  151156. union {
  151157. RtreeDValue rValue; /* Constraint value. */
  151158. int (*xGeom)(sqlite3_rtree_geometry*,int,RtreeDValue*,int*);
  151159. int (*xQueryFunc)(sqlite3_rtree_query_info*);
  151160. } u;
  151161. sqlite3_rtree_query_info *pInfo; /* xGeom and xQueryFunc argument */
  151162. };
  151163. /* Possible values for RtreeConstraint.op */
  151164. #define RTREE_EQ 0x41 /* A */
  151165. #define RTREE_LE 0x42 /* B */
  151166. #define RTREE_LT 0x43 /* C */
  151167. #define RTREE_GE 0x44 /* D */
  151168. #define RTREE_GT 0x45 /* E */
  151169. #define RTREE_MATCH 0x46 /* F: Old-style sqlite3_rtree_geometry_callback() */
  151170. #define RTREE_QUERY 0x47 /* G: New-style sqlite3_rtree_query_callback() */
  151171. /*
  151172. ** An rtree structure node.
  151173. */
  151174. struct RtreeNode {
  151175. RtreeNode *pParent; /* Parent node */
  151176. i64 iNode; /* The node number */
  151177. int nRef; /* Number of references to this node */
  151178. int isDirty; /* True if the node needs to be written to disk */
  151179. u8 *zData; /* Content of the node, as should be on disk */
  151180. RtreeNode *pNext; /* Next node in this hash collision chain */
  151181. };
  151182. /* Return the number of cells in a node */
  151183. #define NCELL(pNode) readInt16(&(pNode)->zData[2])
  151184. /*
  151185. ** A single cell from a node, deserialized
  151186. */
  151187. struct RtreeCell {
  151188. i64 iRowid; /* Node or entry ID */
  151189. RtreeCoord aCoord[RTREE_MAX_DIMENSIONS*2]; /* Bounding box coordinates */
  151190. };
  151191. /*
  151192. ** This object becomes the sqlite3_user_data() for the SQL functions
  151193. ** that are created by sqlite3_rtree_geometry_callback() and
  151194. ** sqlite3_rtree_query_callback() and which appear on the right of MATCH
  151195. ** operators in order to constrain a search.
  151196. **
  151197. ** xGeom and xQueryFunc are the callback functions. Exactly one of
  151198. ** xGeom and xQueryFunc fields is non-NULL, depending on whether the
  151199. ** SQL function was created using sqlite3_rtree_geometry_callback() or
  151200. ** sqlite3_rtree_query_callback().
  151201. **
  151202. ** This object is deleted automatically by the destructor mechanism in
  151203. ** sqlite3_create_function_v2().
  151204. */
  151205. struct RtreeGeomCallback {
  151206. int (*xGeom)(sqlite3_rtree_geometry*, int, RtreeDValue*, int*);
  151207. int (*xQueryFunc)(sqlite3_rtree_query_info*);
  151208. void (*xDestructor)(void*);
  151209. void *pContext;
  151210. };
  151211. /*
  151212. ** Value for the first field of every RtreeMatchArg object. The MATCH
  151213. ** operator tests that the first field of a blob operand matches this
  151214. ** value to avoid operating on invalid blobs (which could cause a segfault).
  151215. */
  151216. #define RTREE_GEOMETRY_MAGIC 0x891245AB
  151217. /*
  151218. ** An instance of this structure (in the form of a BLOB) is returned by
  151219. ** the SQL functions that sqlite3_rtree_geometry_callback() and
  151220. ** sqlite3_rtree_query_callback() create, and is read as the right-hand
  151221. ** operand to the MATCH operator of an R-Tree.
  151222. */
  151223. struct RtreeMatchArg {
  151224. u32 magic; /* Always RTREE_GEOMETRY_MAGIC */
  151225. RtreeGeomCallback cb; /* Info about the callback functions */
  151226. int nParam; /* Number of parameters to the SQL function */
  151227. sqlite3_value **apSqlParam; /* Original SQL parameter values */
  151228. RtreeDValue aParam[1]; /* Values for parameters to the SQL function */
  151229. };
  151230. #ifndef MAX
  151231. # define MAX(x,y) ((x) < (y) ? (y) : (x))
  151232. #endif
  151233. #ifndef MIN
  151234. # define MIN(x,y) ((x) > (y) ? (y) : (x))
  151235. #endif
  151236. /*
  151237. ** Functions to deserialize a 16 bit integer, 32 bit real number and
  151238. ** 64 bit integer. The deserialized value is returned.
  151239. */
  151240. static int readInt16(u8 *p){
  151241. return (p[0]<<8) + p[1];
  151242. }
  151243. static void readCoord(u8 *p, RtreeCoord *pCoord){
  151244. pCoord->u = (
  151245. (((u32)p[0]) << 24) +
  151246. (((u32)p[1]) << 16) +
  151247. (((u32)p[2]) << 8) +
  151248. (((u32)p[3]) << 0)
  151249. );
  151250. }
  151251. static i64 readInt64(u8 *p){
  151252. return (
  151253. (((i64)p[0]) << 56) +
  151254. (((i64)p[1]) << 48) +
  151255. (((i64)p[2]) << 40) +
  151256. (((i64)p[3]) << 32) +
  151257. (((i64)p[4]) << 24) +
  151258. (((i64)p[5]) << 16) +
  151259. (((i64)p[6]) << 8) +
  151260. (((i64)p[7]) << 0)
  151261. );
  151262. }
  151263. /*
  151264. ** Functions to serialize a 16 bit integer, 32 bit real number and
  151265. ** 64 bit integer. The value returned is the number of bytes written
  151266. ** to the argument buffer (always 2, 4 and 8 respectively).
  151267. */
  151268. static int writeInt16(u8 *p, int i){
  151269. p[0] = (i>> 8)&0xFF;
  151270. p[1] = (i>> 0)&0xFF;
  151271. return 2;
  151272. }
  151273. static int writeCoord(u8 *p, RtreeCoord *pCoord){
  151274. u32 i;
  151275. assert( sizeof(RtreeCoord)==4 );
  151276. assert( sizeof(u32)==4 );
  151277. i = pCoord->u;
  151278. p[0] = (i>>24)&0xFF;
  151279. p[1] = (i>>16)&0xFF;
  151280. p[2] = (i>> 8)&0xFF;
  151281. p[3] = (i>> 0)&0xFF;
  151282. return 4;
  151283. }
  151284. static int writeInt64(u8 *p, i64 i){
  151285. p[0] = (i>>56)&0xFF;
  151286. p[1] = (i>>48)&0xFF;
  151287. p[2] = (i>>40)&0xFF;
  151288. p[3] = (i>>32)&0xFF;
  151289. p[4] = (i>>24)&0xFF;
  151290. p[5] = (i>>16)&0xFF;
  151291. p[6] = (i>> 8)&0xFF;
  151292. p[7] = (i>> 0)&0xFF;
  151293. return 8;
  151294. }
  151295. /*
  151296. ** Increment the reference count of node p.
  151297. */
  151298. static void nodeReference(RtreeNode *p){
  151299. if( p ){
  151300. p->nRef++;
  151301. }
  151302. }
  151303. /*
  151304. ** Clear the content of node p (set all bytes to 0x00).
  151305. */
  151306. static void nodeZero(Rtree *pRtree, RtreeNode *p){
  151307. memset(&p->zData[2], 0, pRtree->iNodeSize-2);
  151308. p->isDirty = 1;
  151309. }
  151310. /*
  151311. ** Given a node number iNode, return the corresponding key to use
  151312. ** in the Rtree.aHash table.
  151313. */
  151314. static int nodeHash(i64 iNode){
  151315. return iNode % HASHSIZE;
  151316. }
  151317. /*
  151318. ** Search the node hash table for node iNode. If found, return a pointer
  151319. ** to it. Otherwise, return 0.
  151320. */
  151321. static RtreeNode *nodeHashLookup(Rtree *pRtree, i64 iNode){
  151322. RtreeNode *p;
  151323. for(p=pRtree->aHash[nodeHash(iNode)]; p && p->iNode!=iNode; p=p->pNext);
  151324. return p;
  151325. }
  151326. /*
  151327. ** Add node pNode to the node hash table.
  151328. */
  151329. static void nodeHashInsert(Rtree *pRtree, RtreeNode *pNode){
  151330. int iHash;
  151331. assert( pNode->pNext==0 );
  151332. iHash = nodeHash(pNode->iNode);
  151333. pNode->pNext = pRtree->aHash[iHash];
  151334. pRtree->aHash[iHash] = pNode;
  151335. }
  151336. /*
  151337. ** Remove node pNode from the node hash table.
  151338. */
  151339. static void nodeHashDelete(Rtree *pRtree, RtreeNode *pNode){
  151340. RtreeNode **pp;
  151341. if( pNode->iNode!=0 ){
  151342. pp = &pRtree->aHash[nodeHash(pNode->iNode)];
  151343. for( ; (*pp)!=pNode; pp = &(*pp)->pNext){ assert(*pp); }
  151344. *pp = pNode->pNext;
  151345. pNode->pNext = 0;
  151346. }
  151347. }
  151348. /*
  151349. ** Allocate and return new r-tree node. Initially, (RtreeNode.iNode==0),
  151350. ** indicating that node has not yet been assigned a node number. It is
  151351. ** assigned a node number when nodeWrite() is called to write the
  151352. ** node contents out to the database.
  151353. */
  151354. static RtreeNode *nodeNew(Rtree *pRtree, RtreeNode *pParent){
  151355. RtreeNode *pNode;
  151356. pNode = (RtreeNode *)sqlite3_malloc(sizeof(RtreeNode) + pRtree->iNodeSize);
  151357. if( pNode ){
  151358. memset(pNode, 0, sizeof(RtreeNode) + pRtree->iNodeSize);
  151359. pNode->zData = (u8 *)&pNode[1];
  151360. pNode->nRef = 1;
  151361. pNode->pParent = pParent;
  151362. pNode->isDirty = 1;
  151363. nodeReference(pParent);
  151364. }
  151365. return pNode;
  151366. }
  151367. /*
  151368. ** Obtain a reference to an r-tree node.
  151369. */
  151370. static int nodeAcquire(
  151371. Rtree *pRtree, /* R-tree structure */
  151372. i64 iNode, /* Node number to load */
  151373. RtreeNode *pParent, /* Either the parent node or NULL */
  151374. RtreeNode **ppNode /* OUT: Acquired node */
  151375. ){
  151376. int rc;
  151377. int rc2 = SQLITE_OK;
  151378. RtreeNode *pNode;
  151379. /* Check if the requested node is already in the hash table. If so,
  151380. ** increase its reference count and return it.
  151381. */
  151382. if( (pNode = nodeHashLookup(pRtree, iNode)) ){
  151383. assert( !pParent || !pNode->pParent || pNode->pParent==pParent );
  151384. if( pParent && !pNode->pParent ){
  151385. nodeReference(pParent);
  151386. pNode->pParent = pParent;
  151387. }
  151388. pNode->nRef++;
  151389. *ppNode = pNode;
  151390. return SQLITE_OK;
  151391. }
  151392. sqlite3_bind_int64(pRtree->pReadNode, 1, iNode);
  151393. rc = sqlite3_step(pRtree->pReadNode);
  151394. if( rc==SQLITE_ROW ){
  151395. const u8 *zBlob = sqlite3_column_blob(pRtree->pReadNode, 0);
  151396. if( pRtree->iNodeSize==sqlite3_column_bytes(pRtree->pReadNode, 0) ){
  151397. pNode = (RtreeNode *)sqlite3_malloc(sizeof(RtreeNode)+pRtree->iNodeSize);
  151398. if( !pNode ){
  151399. rc2 = SQLITE_NOMEM;
  151400. }else{
  151401. pNode->pParent = pParent;
  151402. pNode->zData = (u8 *)&pNode[1];
  151403. pNode->nRef = 1;
  151404. pNode->iNode = iNode;
  151405. pNode->isDirty = 0;
  151406. pNode->pNext = 0;
  151407. memcpy(pNode->zData, zBlob, pRtree->iNodeSize);
  151408. nodeReference(pParent);
  151409. }
  151410. }
  151411. }
  151412. rc = sqlite3_reset(pRtree->pReadNode);
  151413. if( rc==SQLITE_OK ) rc = rc2;
  151414. /* If the root node was just loaded, set pRtree->iDepth to the height
  151415. ** of the r-tree structure. A height of zero means all data is stored on
  151416. ** the root node. A height of one means the children of the root node
  151417. ** are the leaves, and so on. If the depth as specified on the root node
  151418. ** is greater than RTREE_MAX_DEPTH, the r-tree structure must be corrupt.
  151419. */
  151420. if( pNode && iNode==1 ){
  151421. pRtree->iDepth = readInt16(pNode->zData);
  151422. if( pRtree->iDepth>RTREE_MAX_DEPTH ){
  151423. rc = SQLITE_CORRUPT_VTAB;
  151424. }
  151425. }
  151426. /* If no error has occurred so far, check if the "number of entries"
  151427. ** field on the node is too large. If so, set the return code to
  151428. ** SQLITE_CORRUPT_VTAB.
  151429. */
  151430. if( pNode && rc==SQLITE_OK ){
  151431. if( NCELL(pNode)>((pRtree->iNodeSize-4)/pRtree->nBytesPerCell) ){
  151432. rc = SQLITE_CORRUPT_VTAB;
  151433. }
  151434. }
  151435. if( rc==SQLITE_OK ){
  151436. if( pNode!=0 ){
  151437. nodeHashInsert(pRtree, pNode);
  151438. }else{
  151439. rc = SQLITE_CORRUPT_VTAB;
  151440. }
  151441. *ppNode = pNode;
  151442. }else{
  151443. sqlite3_free(pNode);
  151444. *ppNode = 0;
  151445. }
  151446. return rc;
  151447. }
  151448. /*
  151449. ** Overwrite cell iCell of node pNode with the contents of pCell.
  151450. */
  151451. static void nodeOverwriteCell(
  151452. Rtree *pRtree, /* The overall R-Tree */
  151453. RtreeNode *pNode, /* The node into which the cell is to be written */
  151454. RtreeCell *pCell, /* The cell to write */
  151455. int iCell /* Index into pNode into which pCell is written */
  151456. ){
  151457. int ii;
  151458. u8 *p = &pNode->zData[4 + pRtree->nBytesPerCell*iCell];
  151459. p += writeInt64(p, pCell->iRowid);
  151460. for(ii=0; ii<(pRtree->nDim*2); ii++){
  151461. p += writeCoord(p, &pCell->aCoord[ii]);
  151462. }
  151463. pNode->isDirty = 1;
  151464. }
  151465. /*
  151466. ** Remove the cell with index iCell from node pNode.
  151467. */
  151468. static void nodeDeleteCell(Rtree *pRtree, RtreeNode *pNode, int iCell){
  151469. u8 *pDst = &pNode->zData[4 + pRtree->nBytesPerCell*iCell];
  151470. u8 *pSrc = &pDst[pRtree->nBytesPerCell];
  151471. int nByte = (NCELL(pNode) - iCell - 1) * pRtree->nBytesPerCell;
  151472. memmove(pDst, pSrc, nByte);
  151473. writeInt16(&pNode->zData[2], NCELL(pNode)-1);
  151474. pNode->isDirty = 1;
  151475. }
  151476. /*
  151477. ** Insert the contents of cell pCell into node pNode. If the insert
  151478. ** is successful, return SQLITE_OK.
  151479. **
  151480. ** If there is not enough free space in pNode, return SQLITE_FULL.
  151481. */
  151482. static int nodeInsertCell(
  151483. Rtree *pRtree, /* The overall R-Tree */
  151484. RtreeNode *pNode, /* Write new cell into this node */
  151485. RtreeCell *pCell /* The cell to be inserted */
  151486. ){
  151487. int nCell; /* Current number of cells in pNode */
  151488. int nMaxCell; /* Maximum number of cells for pNode */
  151489. nMaxCell = (pRtree->iNodeSize-4)/pRtree->nBytesPerCell;
  151490. nCell = NCELL(pNode);
  151491. assert( nCell<=nMaxCell );
  151492. if( nCell<nMaxCell ){
  151493. nodeOverwriteCell(pRtree, pNode, pCell, nCell);
  151494. writeInt16(&pNode->zData[2], nCell+1);
  151495. pNode->isDirty = 1;
  151496. }
  151497. return (nCell==nMaxCell);
  151498. }
  151499. /*
  151500. ** If the node is dirty, write it out to the database.
  151501. */
  151502. static int nodeWrite(Rtree *pRtree, RtreeNode *pNode){
  151503. int rc = SQLITE_OK;
  151504. if( pNode->isDirty ){
  151505. sqlite3_stmt *p = pRtree->pWriteNode;
  151506. if( pNode->iNode ){
  151507. sqlite3_bind_int64(p, 1, pNode->iNode);
  151508. }else{
  151509. sqlite3_bind_null(p, 1);
  151510. }
  151511. sqlite3_bind_blob(p, 2, pNode->zData, pRtree->iNodeSize, SQLITE_STATIC);
  151512. sqlite3_step(p);
  151513. pNode->isDirty = 0;
  151514. rc = sqlite3_reset(p);
  151515. if( pNode->iNode==0 && rc==SQLITE_OK ){
  151516. pNode->iNode = sqlite3_last_insert_rowid(pRtree->db);
  151517. nodeHashInsert(pRtree, pNode);
  151518. }
  151519. }
  151520. return rc;
  151521. }
  151522. /*
  151523. ** Release a reference to a node. If the node is dirty and the reference
  151524. ** count drops to zero, the node data is written to the database.
  151525. */
  151526. static int nodeRelease(Rtree *pRtree, RtreeNode *pNode){
  151527. int rc = SQLITE_OK;
  151528. if( pNode ){
  151529. assert( pNode->nRef>0 );
  151530. pNode->nRef--;
  151531. if( pNode->nRef==0 ){
  151532. if( pNode->iNode==1 ){
  151533. pRtree->iDepth = -1;
  151534. }
  151535. if( pNode->pParent ){
  151536. rc = nodeRelease(pRtree, pNode->pParent);
  151537. }
  151538. if( rc==SQLITE_OK ){
  151539. rc = nodeWrite(pRtree, pNode);
  151540. }
  151541. nodeHashDelete(pRtree, pNode);
  151542. sqlite3_free(pNode);
  151543. }
  151544. }
  151545. return rc;
  151546. }
  151547. /*
  151548. ** Return the 64-bit integer value associated with cell iCell of
  151549. ** node pNode. If pNode is a leaf node, this is a rowid. If it is
  151550. ** an internal node, then the 64-bit integer is a child page number.
  151551. */
  151552. static i64 nodeGetRowid(
  151553. Rtree *pRtree, /* The overall R-Tree */
  151554. RtreeNode *pNode, /* The node from which to extract the ID */
  151555. int iCell /* The cell index from which to extract the ID */
  151556. ){
  151557. assert( iCell<NCELL(pNode) );
  151558. return readInt64(&pNode->zData[4 + pRtree->nBytesPerCell*iCell]);
  151559. }
  151560. /*
  151561. ** Return coordinate iCoord from cell iCell in node pNode.
  151562. */
  151563. static void nodeGetCoord(
  151564. Rtree *pRtree, /* The overall R-Tree */
  151565. RtreeNode *pNode, /* The node from which to extract a coordinate */
  151566. int iCell, /* The index of the cell within the node */
  151567. int iCoord, /* Which coordinate to extract */
  151568. RtreeCoord *pCoord /* OUT: Space to write result to */
  151569. ){
  151570. readCoord(&pNode->zData[12 + pRtree->nBytesPerCell*iCell + 4*iCoord], pCoord);
  151571. }
  151572. /*
  151573. ** Deserialize cell iCell of node pNode. Populate the structure pointed
  151574. ** to by pCell with the results.
  151575. */
  151576. static void nodeGetCell(
  151577. Rtree *pRtree, /* The overall R-Tree */
  151578. RtreeNode *pNode, /* The node containing the cell to be read */
  151579. int iCell, /* Index of the cell within the node */
  151580. RtreeCell *pCell /* OUT: Write the cell contents here */
  151581. ){
  151582. u8 *pData;
  151583. RtreeCoord *pCoord;
  151584. int ii;
  151585. pCell->iRowid = nodeGetRowid(pRtree, pNode, iCell);
  151586. pData = pNode->zData + (12 + pRtree->nBytesPerCell*iCell);
  151587. pCoord = pCell->aCoord;
  151588. for(ii=0; ii<pRtree->nDim*2; ii++){
  151589. readCoord(&pData[ii*4], &pCoord[ii]);
  151590. }
  151591. }
  151592. /* Forward declaration for the function that does the work of
  151593. ** the virtual table module xCreate() and xConnect() methods.
  151594. */
  151595. static int rtreeInit(
  151596. sqlite3 *, void *, int, const char *const*, sqlite3_vtab **, char **, int
  151597. );
  151598. /*
  151599. ** Rtree virtual table module xCreate method.
  151600. */
  151601. static int rtreeCreate(
  151602. sqlite3 *db,
  151603. void *pAux,
  151604. int argc, const char *const*argv,
  151605. sqlite3_vtab **ppVtab,
  151606. char **pzErr
  151607. ){
  151608. return rtreeInit(db, pAux, argc, argv, ppVtab, pzErr, 1);
  151609. }
  151610. /*
  151611. ** Rtree virtual table module xConnect method.
  151612. */
  151613. static int rtreeConnect(
  151614. sqlite3 *db,
  151615. void *pAux,
  151616. int argc, const char *const*argv,
  151617. sqlite3_vtab **ppVtab,
  151618. char **pzErr
  151619. ){
  151620. return rtreeInit(db, pAux, argc, argv, ppVtab, pzErr, 0);
  151621. }
  151622. /*
  151623. ** Increment the r-tree reference count.
  151624. */
  151625. static void rtreeReference(Rtree *pRtree){
  151626. pRtree->nBusy++;
  151627. }
  151628. /*
  151629. ** Decrement the r-tree reference count. When the reference count reaches
  151630. ** zero the structure is deleted.
  151631. */
  151632. static void rtreeRelease(Rtree *pRtree){
  151633. pRtree->nBusy--;
  151634. if( pRtree->nBusy==0 ){
  151635. sqlite3_finalize(pRtree->pReadNode);
  151636. sqlite3_finalize(pRtree->pWriteNode);
  151637. sqlite3_finalize(pRtree->pDeleteNode);
  151638. sqlite3_finalize(pRtree->pReadRowid);
  151639. sqlite3_finalize(pRtree->pWriteRowid);
  151640. sqlite3_finalize(pRtree->pDeleteRowid);
  151641. sqlite3_finalize(pRtree->pReadParent);
  151642. sqlite3_finalize(pRtree->pWriteParent);
  151643. sqlite3_finalize(pRtree->pDeleteParent);
  151644. sqlite3_free(pRtree);
  151645. }
  151646. }
  151647. /*
  151648. ** Rtree virtual table module xDisconnect method.
  151649. */
  151650. static int rtreeDisconnect(sqlite3_vtab *pVtab){
  151651. rtreeRelease((Rtree *)pVtab);
  151652. return SQLITE_OK;
  151653. }
  151654. /*
  151655. ** Rtree virtual table module xDestroy method.
  151656. */
  151657. static int rtreeDestroy(sqlite3_vtab *pVtab){
  151658. Rtree *pRtree = (Rtree *)pVtab;
  151659. int rc;
  151660. char *zCreate = sqlite3_mprintf(
  151661. "DROP TABLE '%q'.'%q_node';"
  151662. "DROP TABLE '%q'.'%q_rowid';"
  151663. "DROP TABLE '%q'.'%q_parent';",
  151664. pRtree->zDb, pRtree->zName,
  151665. pRtree->zDb, pRtree->zName,
  151666. pRtree->zDb, pRtree->zName
  151667. );
  151668. if( !zCreate ){
  151669. rc = SQLITE_NOMEM;
  151670. }else{
  151671. rc = sqlite3_exec(pRtree->db, zCreate, 0, 0, 0);
  151672. sqlite3_free(zCreate);
  151673. }
  151674. if( rc==SQLITE_OK ){
  151675. rtreeRelease(pRtree);
  151676. }
  151677. return rc;
  151678. }
  151679. /*
  151680. ** Rtree virtual table module xOpen method.
  151681. */
  151682. static int rtreeOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
  151683. int rc = SQLITE_NOMEM;
  151684. RtreeCursor *pCsr;
  151685. pCsr = (RtreeCursor *)sqlite3_malloc(sizeof(RtreeCursor));
  151686. if( pCsr ){
  151687. memset(pCsr, 0, sizeof(RtreeCursor));
  151688. pCsr->base.pVtab = pVTab;
  151689. rc = SQLITE_OK;
  151690. }
  151691. *ppCursor = (sqlite3_vtab_cursor *)pCsr;
  151692. return rc;
  151693. }
  151694. /*
  151695. ** Free the RtreeCursor.aConstraint[] array and its contents.
  151696. */
  151697. static void freeCursorConstraints(RtreeCursor *pCsr){
  151698. if( pCsr->aConstraint ){
  151699. int i; /* Used to iterate through constraint array */
  151700. for(i=0; i<pCsr->nConstraint; i++){
  151701. sqlite3_rtree_query_info *pInfo = pCsr->aConstraint[i].pInfo;
  151702. if( pInfo ){
  151703. if( pInfo->xDelUser ) pInfo->xDelUser(pInfo->pUser);
  151704. sqlite3_free(pInfo);
  151705. }
  151706. }
  151707. sqlite3_free(pCsr->aConstraint);
  151708. pCsr->aConstraint = 0;
  151709. }
  151710. }
  151711. /*
  151712. ** Rtree virtual table module xClose method.
  151713. */
  151714. static int rtreeClose(sqlite3_vtab_cursor *cur){
  151715. Rtree *pRtree = (Rtree *)(cur->pVtab);
  151716. int ii;
  151717. RtreeCursor *pCsr = (RtreeCursor *)cur;
  151718. freeCursorConstraints(pCsr);
  151719. sqlite3_free(pCsr->aPoint);
  151720. for(ii=0; ii<RTREE_CACHE_SZ; ii++) nodeRelease(pRtree, pCsr->aNode[ii]);
  151721. sqlite3_free(pCsr);
  151722. return SQLITE_OK;
  151723. }
  151724. /*
  151725. ** Rtree virtual table module xEof method.
  151726. **
  151727. ** Return non-zero if the cursor does not currently point to a valid
  151728. ** record (i.e if the scan has finished), or zero otherwise.
  151729. */
  151730. static int rtreeEof(sqlite3_vtab_cursor *cur){
  151731. RtreeCursor *pCsr = (RtreeCursor *)cur;
  151732. return pCsr->atEOF;
  151733. }
  151734. /*
  151735. ** Convert raw bits from the on-disk RTree record into a coordinate value.
  151736. ** The on-disk format is big-endian and needs to be converted for little-
  151737. ** endian platforms. The on-disk record stores integer coordinates if
  151738. ** eInt is true and it stores 32-bit floating point records if eInt is
  151739. ** false. a[] is the four bytes of the on-disk record to be decoded.
  151740. ** Store the results in "r".
  151741. **
  151742. ** There are three versions of this macro, one each for little-endian and
  151743. ** big-endian processors and a third generic implementation. The endian-
  151744. ** specific implementations are much faster and are preferred if the
  151745. ** processor endianness is known at compile-time. The SQLITE_BYTEORDER
  151746. ** macro is part of sqliteInt.h and hence the endian-specific
  151747. ** implementation will only be used if this module is compiled as part
  151748. ** of the amalgamation.
  151749. */
  151750. #if defined(SQLITE_BYTEORDER) && SQLITE_BYTEORDER==1234
  151751. #define RTREE_DECODE_COORD(eInt, a, r) { \
  151752. RtreeCoord c; /* Coordinate decoded */ \
  151753. memcpy(&c.u,a,4); \
  151754. c.u = ((c.u>>24)&0xff)|((c.u>>8)&0xff00)| \
  151755. ((c.u&0xff)<<24)|((c.u&0xff00)<<8); \
  151756. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  151757. }
  151758. #elif defined(SQLITE_BYTEORDER) && SQLITE_BYTEORDER==4321
  151759. #define RTREE_DECODE_COORD(eInt, a, r) { \
  151760. RtreeCoord c; /* Coordinate decoded */ \
  151761. memcpy(&c.u,a,4); \
  151762. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  151763. }
  151764. #else
  151765. #define RTREE_DECODE_COORD(eInt, a, r) { \
  151766. RtreeCoord c; /* Coordinate decoded */ \
  151767. c.u = ((u32)a[0]<<24) + ((u32)a[1]<<16) \
  151768. +((u32)a[2]<<8) + a[3]; \
  151769. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  151770. }
  151771. #endif
  151772. /*
  151773. ** Check the RTree node or entry given by pCellData and p against the MATCH
  151774. ** constraint pConstraint.
  151775. */
  151776. static int rtreeCallbackConstraint(
  151777. RtreeConstraint *pConstraint, /* The constraint to test */
  151778. int eInt, /* True if RTree holding integer coordinates */
  151779. u8 *pCellData, /* Raw cell content */
  151780. RtreeSearchPoint *pSearch, /* Container of this cell */
  151781. sqlite3_rtree_dbl *prScore, /* OUT: score for the cell */
  151782. int *peWithin /* OUT: visibility of the cell */
  151783. ){
  151784. int i; /* Loop counter */
  151785. sqlite3_rtree_query_info *pInfo = pConstraint->pInfo; /* Callback info */
  151786. int nCoord = pInfo->nCoord; /* No. of coordinates */
  151787. int rc; /* Callback return code */
  151788. sqlite3_rtree_dbl aCoord[RTREE_MAX_DIMENSIONS*2]; /* Decoded coordinates */
  151789. assert( pConstraint->op==RTREE_MATCH || pConstraint->op==RTREE_QUERY );
  151790. assert( nCoord==2 || nCoord==4 || nCoord==6 || nCoord==8 || nCoord==10 );
  151791. if( pConstraint->op==RTREE_QUERY && pSearch->iLevel==1 ){
  151792. pInfo->iRowid = readInt64(pCellData);
  151793. }
  151794. pCellData += 8;
  151795. for(i=0; i<nCoord; i++, pCellData += 4){
  151796. RTREE_DECODE_COORD(eInt, pCellData, aCoord[i]);
  151797. }
  151798. if( pConstraint->op==RTREE_MATCH ){
  151799. rc = pConstraint->u.xGeom((sqlite3_rtree_geometry*)pInfo,
  151800. nCoord, aCoord, &i);
  151801. if( i==0 ) *peWithin = NOT_WITHIN;
  151802. *prScore = RTREE_ZERO;
  151803. }else{
  151804. pInfo->aCoord = aCoord;
  151805. pInfo->iLevel = pSearch->iLevel - 1;
  151806. pInfo->rScore = pInfo->rParentScore = pSearch->rScore;
  151807. pInfo->eWithin = pInfo->eParentWithin = pSearch->eWithin;
  151808. rc = pConstraint->u.xQueryFunc(pInfo);
  151809. if( pInfo->eWithin<*peWithin ) *peWithin = pInfo->eWithin;
  151810. if( pInfo->rScore<*prScore || *prScore<RTREE_ZERO ){
  151811. *prScore = pInfo->rScore;
  151812. }
  151813. }
  151814. return rc;
  151815. }
  151816. /*
  151817. ** Check the internal RTree node given by pCellData against constraint p.
  151818. ** If this constraint cannot be satisfied by any child within the node,
  151819. ** set *peWithin to NOT_WITHIN.
  151820. */
  151821. static void rtreeNonleafConstraint(
  151822. RtreeConstraint *p, /* The constraint to test */
  151823. int eInt, /* True if RTree holds integer coordinates */
  151824. u8 *pCellData, /* Raw cell content as appears on disk */
  151825. int *peWithin /* Adjust downward, as appropriate */
  151826. ){
  151827. sqlite3_rtree_dbl val; /* Coordinate value convert to a double */
  151828. /* p->iCoord might point to either a lower or upper bound coordinate
  151829. ** in a coordinate pair. But make pCellData point to the lower bound.
  151830. */
  151831. pCellData += 8 + 4*(p->iCoord&0xfe);
  151832. assert(p->op==RTREE_LE || p->op==RTREE_LT || p->op==RTREE_GE
  151833. || p->op==RTREE_GT || p->op==RTREE_EQ );
  151834. switch( p->op ){
  151835. case RTREE_LE:
  151836. case RTREE_LT:
  151837. case RTREE_EQ:
  151838. RTREE_DECODE_COORD(eInt, pCellData, val);
  151839. /* val now holds the lower bound of the coordinate pair */
  151840. if( p->u.rValue>=val ) return;
  151841. if( p->op!=RTREE_EQ ) break; /* RTREE_LE and RTREE_LT end here */
  151842. /* Fall through for the RTREE_EQ case */
  151843. default: /* RTREE_GT or RTREE_GE, or fallthrough of RTREE_EQ */
  151844. pCellData += 4;
  151845. RTREE_DECODE_COORD(eInt, pCellData, val);
  151846. /* val now holds the upper bound of the coordinate pair */
  151847. if( p->u.rValue<=val ) return;
  151848. }
  151849. *peWithin = NOT_WITHIN;
  151850. }
  151851. /*
  151852. ** Check the leaf RTree cell given by pCellData against constraint p.
  151853. ** If this constraint is not satisfied, set *peWithin to NOT_WITHIN.
  151854. ** If the constraint is satisfied, leave *peWithin unchanged.
  151855. **
  151856. ** The constraint is of the form: xN op $val
  151857. **
  151858. ** The op is given by p->op. The xN is p->iCoord-th coordinate in
  151859. ** pCellData. $val is given by p->u.rValue.
  151860. */
  151861. static void rtreeLeafConstraint(
  151862. RtreeConstraint *p, /* The constraint to test */
  151863. int eInt, /* True if RTree holds integer coordinates */
  151864. u8 *pCellData, /* Raw cell content as appears on disk */
  151865. int *peWithin /* Adjust downward, as appropriate */
  151866. ){
  151867. RtreeDValue xN; /* Coordinate value converted to a double */
  151868. assert(p->op==RTREE_LE || p->op==RTREE_LT || p->op==RTREE_GE
  151869. || p->op==RTREE_GT || p->op==RTREE_EQ );
  151870. pCellData += 8 + p->iCoord*4;
  151871. RTREE_DECODE_COORD(eInt, pCellData, xN);
  151872. switch( p->op ){
  151873. case RTREE_LE: if( xN <= p->u.rValue ) return; break;
  151874. case RTREE_LT: if( xN < p->u.rValue ) return; break;
  151875. case RTREE_GE: if( xN >= p->u.rValue ) return; break;
  151876. case RTREE_GT: if( xN > p->u.rValue ) return; break;
  151877. default: if( xN == p->u.rValue ) return; break;
  151878. }
  151879. *peWithin = NOT_WITHIN;
  151880. }
  151881. /*
  151882. ** One of the cells in node pNode is guaranteed to have a 64-bit
  151883. ** integer value equal to iRowid. Return the index of this cell.
  151884. */
  151885. static int nodeRowidIndex(
  151886. Rtree *pRtree,
  151887. RtreeNode *pNode,
  151888. i64 iRowid,
  151889. int *piIndex
  151890. ){
  151891. int ii;
  151892. int nCell = NCELL(pNode);
  151893. assert( nCell<200 );
  151894. for(ii=0; ii<nCell; ii++){
  151895. if( nodeGetRowid(pRtree, pNode, ii)==iRowid ){
  151896. *piIndex = ii;
  151897. return SQLITE_OK;
  151898. }
  151899. }
  151900. return SQLITE_CORRUPT_VTAB;
  151901. }
  151902. /*
  151903. ** Return the index of the cell containing a pointer to node pNode
  151904. ** in its parent. If pNode is the root node, return -1.
  151905. */
  151906. static int nodeParentIndex(Rtree *pRtree, RtreeNode *pNode, int *piIndex){
  151907. RtreeNode *pParent = pNode->pParent;
  151908. if( pParent ){
  151909. return nodeRowidIndex(pRtree, pParent, pNode->iNode, piIndex);
  151910. }
  151911. *piIndex = -1;
  151912. return SQLITE_OK;
  151913. }
  151914. /*
  151915. ** Compare two search points. Return negative, zero, or positive if the first
  151916. ** is less than, equal to, or greater than the second.
  151917. **
  151918. ** The rScore is the primary key. Smaller rScore values come first.
  151919. ** If the rScore is a tie, then use iLevel as the tie breaker with smaller
  151920. ** iLevel values coming first. In this way, if rScore is the same for all
  151921. ** SearchPoints, then iLevel becomes the deciding factor and the result
  151922. ** is a depth-first search, which is the desired default behavior.
  151923. */
  151924. static int rtreeSearchPointCompare(
  151925. const RtreeSearchPoint *pA,
  151926. const RtreeSearchPoint *pB
  151927. ){
  151928. if( pA->rScore<pB->rScore ) return -1;
  151929. if( pA->rScore>pB->rScore ) return +1;
  151930. if( pA->iLevel<pB->iLevel ) return -1;
  151931. if( pA->iLevel>pB->iLevel ) return +1;
  151932. return 0;
  151933. }
  151934. /*
  151935. ** Interchange to search points in a cursor.
  151936. */
  151937. static void rtreeSearchPointSwap(RtreeCursor *p, int i, int j){
  151938. RtreeSearchPoint t = p->aPoint[i];
  151939. assert( i<j );
  151940. p->aPoint[i] = p->aPoint[j];
  151941. p->aPoint[j] = t;
  151942. i++; j++;
  151943. if( i<RTREE_CACHE_SZ ){
  151944. if( j>=RTREE_CACHE_SZ ){
  151945. nodeRelease(RTREE_OF_CURSOR(p), p->aNode[i]);
  151946. p->aNode[i] = 0;
  151947. }else{
  151948. RtreeNode *pTemp = p->aNode[i];
  151949. p->aNode[i] = p->aNode[j];
  151950. p->aNode[j] = pTemp;
  151951. }
  151952. }
  151953. }
  151954. /*
  151955. ** Return the search point with the lowest current score.
  151956. */
  151957. static RtreeSearchPoint *rtreeSearchPointFirst(RtreeCursor *pCur){
  151958. return pCur->bPoint ? &pCur->sPoint : pCur->nPoint ? pCur->aPoint : 0;
  151959. }
  151960. /*
  151961. ** Get the RtreeNode for the search point with the lowest score.
  151962. */
  151963. static RtreeNode *rtreeNodeOfFirstSearchPoint(RtreeCursor *pCur, int *pRC){
  151964. sqlite3_int64 id;
  151965. int ii = 1 - pCur->bPoint;
  151966. assert( ii==0 || ii==1 );
  151967. assert( pCur->bPoint || pCur->nPoint );
  151968. if( pCur->aNode[ii]==0 ){
  151969. assert( pRC!=0 );
  151970. id = ii ? pCur->aPoint[0].id : pCur->sPoint.id;
  151971. *pRC = nodeAcquire(RTREE_OF_CURSOR(pCur), id, 0, &pCur->aNode[ii]);
  151972. }
  151973. return pCur->aNode[ii];
  151974. }
  151975. /*
  151976. ** Push a new element onto the priority queue
  151977. */
  151978. static RtreeSearchPoint *rtreeEnqueue(
  151979. RtreeCursor *pCur, /* The cursor */
  151980. RtreeDValue rScore, /* Score for the new search point */
  151981. u8 iLevel /* Level for the new search point */
  151982. ){
  151983. int i, j;
  151984. RtreeSearchPoint *pNew;
  151985. if( pCur->nPoint>=pCur->nPointAlloc ){
  151986. int nNew = pCur->nPointAlloc*2 + 8;
  151987. pNew = sqlite3_realloc(pCur->aPoint, nNew*sizeof(pCur->aPoint[0]));
  151988. if( pNew==0 ) return 0;
  151989. pCur->aPoint = pNew;
  151990. pCur->nPointAlloc = nNew;
  151991. }
  151992. i = pCur->nPoint++;
  151993. pNew = pCur->aPoint + i;
  151994. pNew->rScore = rScore;
  151995. pNew->iLevel = iLevel;
  151996. assert( iLevel<=RTREE_MAX_DEPTH );
  151997. while( i>0 ){
  151998. RtreeSearchPoint *pParent;
  151999. j = (i-1)/2;
  152000. pParent = pCur->aPoint + j;
  152001. if( rtreeSearchPointCompare(pNew, pParent)>=0 ) break;
  152002. rtreeSearchPointSwap(pCur, j, i);
  152003. i = j;
  152004. pNew = pParent;
  152005. }
  152006. return pNew;
  152007. }
  152008. /*
  152009. ** Allocate a new RtreeSearchPoint and return a pointer to it. Return
  152010. ** NULL if malloc fails.
  152011. */
  152012. static RtreeSearchPoint *rtreeSearchPointNew(
  152013. RtreeCursor *pCur, /* The cursor */
  152014. RtreeDValue rScore, /* Score for the new search point */
  152015. u8 iLevel /* Level for the new search point */
  152016. ){
  152017. RtreeSearchPoint *pNew, *pFirst;
  152018. pFirst = rtreeSearchPointFirst(pCur);
  152019. pCur->anQueue[iLevel]++;
  152020. if( pFirst==0
  152021. || pFirst->rScore>rScore
  152022. || (pFirst->rScore==rScore && pFirst->iLevel>iLevel)
  152023. ){
  152024. if( pCur->bPoint ){
  152025. int ii;
  152026. pNew = rtreeEnqueue(pCur, rScore, iLevel);
  152027. if( pNew==0 ) return 0;
  152028. ii = (int)(pNew - pCur->aPoint) + 1;
  152029. if( ii<RTREE_CACHE_SZ ){
  152030. assert( pCur->aNode[ii]==0 );
  152031. pCur->aNode[ii] = pCur->aNode[0];
  152032. }else{
  152033. nodeRelease(RTREE_OF_CURSOR(pCur), pCur->aNode[0]);
  152034. }
  152035. pCur->aNode[0] = 0;
  152036. *pNew = pCur->sPoint;
  152037. }
  152038. pCur->sPoint.rScore = rScore;
  152039. pCur->sPoint.iLevel = iLevel;
  152040. pCur->bPoint = 1;
  152041. return &pCur->sPoint;
  152042. }else{
  152043. return rtreeEnqueue(pCur, rScore, iLevel);
  152044. }
  152045. }
  152046. #if 0
  152047. /* Tracing routines for the RtreeSearchPoint queue */
  152048. static void tracePoint(RtreeSearchPoint *p, int idx, RtreeCursor *pCur){
  152049. if( idx<0 ){ printf(" s"); }else{ printf("%2d", idx); }
  152050. printf(" %d.%05lld.%02d %g %d",
  152051. p->iLevel, p->id, p->iCell, p->rScore, p->eWithin
  152052. );
  152053. idx++;
  152054. if( idx<RTREE_CACHE_SZ ){
  152055. printf(" %p\n", pCur->aNode[idx]);
  152056. }else{
  152057. printf("\n");
  152058. }
  152059. }
  152060. static void traceQueue(RtreeCursor *pCur, const char *zPrefix){
  152061. int ii;
  152062. printf("=== %9s ", zPrefix);
  152063. if( pCur->bPoint ){
  152064. tracePoint(&pCur->sPoint, -1, pCur);
  152065. }
  152066. for(ii=0; ii<pCur->nPoint; ii++){
  152067. if( ii>0 || pCur->bPoint ) printf(" ");
  152068. tracePoint(&pCur->aPoint[ii], ii, pCur);
  152069. }
  152070. }
  152071. # define RTREE_QUEUE_TRACE(A,B) traceQueue(A,B)
  152072. #else
  152073. # define RTREE_QUEUE_TRACE(A,B) /* no-op */
  152074. #endif
  152075. /* Remove the search point with the lowest current score.
  152076. */
  152077. static void rtreeSearchPointPop(RtreeCursor *p){
  152078. int i, j, k, n;
  152079. i = 1 - p->bPoint;
  152080. assert( i==0 || i==1 );
  152081. if( p->aNode[i] ){
  152082. nodeRelease(RTREE_OF_CURSOR(p), p->aNode[i]);
  152083. p->aNode[i] = 0;
  152084. }
  152085. if( p->bPoint ){
  152086. p->anQueue[p->sPoint.iLevel]--;
  152087. p->bPoint = 0;
  152088. }else if( p->nPoint ){
  152089. p->anQueue[p->aPoint[0].iLevel]--;
  152090. n = --p->nPoint;
  152091. p->aPoint[0] = p->aPoint[n];
  152092. if( n<RTREE_CACHE_SZ-1 ){
  152093. p->aNode[1] = p->aNode[n+1];
  152094. p->aNode[n+1] = 0;
  152095. }
  152096. i = 0;
  152097. while( (j = i*2+1)<n ){
  152098. k = j+1;
  152099. if( k<n && rtreeSearchPointCompare(&p->aPoint[k], &p->aPoint[j])<0 ){
  152100. if( rtreeSearchPointCompare(&p->aPoint[k], &p->aPoint[i])<0 ){
  152101. rtreeSearchPointSwap(p, i, k);
  152102. i = k;
  152103. }else{
  152104. break;
  152105. }
  152106. }else{
  152107. if( rtreeSearchPointCompare(&p->aPoint[j], &p->aPoint[i])<0 ){
  152108. rtreeSearchPointSwap(p, i, j);
  152109. i = j;
  152110. }else{
  152111. break;
  152112. }
  152113. }
  152114. }
  152115. }
  152116. }
  152117. /*
  152118. ** Continue the search on cursor pCur until the front of the queue
  152119. ** contains an entry suitable for returning as a result-set row,
  152120. ** or until the RtreeSearchPoint queue is empty, indicating that the
  152121. ** query has completed.
  152122. */
  152123. static int rtreeStepToLeaf(RtreeCursor *pCur){
  152124. RtreeSearchPoint *p;
  152125. Rtree *pRtree = RTREE_OF_CURSOR(pCur);
  152126. RtreeNode *pNode;
  152127. int eWithin;
  152128. int rc = SQLITE_OK;
  152129. int nCell;
  152130. int nConstraint = pCur->nConstraint;
  152131. int ii;
  152132. int eInt;
  152133. RtreeSearchPoint x;
  152134. eInt = pRtree->eCoordType==RTREE_COORD_INT32;
  152135. while( (p = rtreeSearchPointFirst(pCur))!=0 && p->iLevel>0 ){
  152136. pNode = rtreeNodeOfFirstSearchPoint(pCur, &rc);
  152137. if( rc ) return rc;
  152138. nCell = NCELL(pNode);
  152139. assert( nCell<200 );
  152140. while( p->iCell<nCell ){
  152141. sqlite3_rtree_dbl rScore = (sqlite3_rtree_dbl)-1;
  152142. u8 *pCellData = pNode->zData + (4+pRtree->nBytesPerCell*p->iCell);
  152143. eWithin = FULLY_WITHIN;
  152144. for(ii=0; ii<nConstraint; ii++){
  152145. RtreeConstraint *pConstraint = pCur->aConstraint + ii;
  152146. if( pConstraint->op>=RTREE_MATCH ){
  152147. rc = rtreeCallbackConstraint(pConstraint, eInt, pCellData, p,
  152148. &rScore, &eWithin);
  152149. if( rc ) return rc;
  152150. }else if( p->iLevel==1 ){
  152151. rtreeLeafConstraint(pConstraint, eInt, pCellData, &eWithin);
  152152. }else{
  152153. rtreeNonleafConstraint(pConstraint, eInt, pCellData, &eWithin);
  152154. }
  152155. if( eWithin==NOT_WITHIN ) break;
  152156. }
  152157. p->iCell++;
  152158. if( eWithin==NOT_WITHIN ) continue;
  152159. x.iLevel = p->iLevel - 1;
  152160. if( x.iLevel ){
  152161. x.id = readInt64(pCellData);
  152162. x.iCell = 0;
  152163. }else{
  152164. x.id = p->id;
  152165. x.iCell = p->iCell - 1;
  152166. }
  152167. if( p->iCell>=nCell ){
  152168. RTREE_QUEUE_TRACE(pCur, "POP-S:");
  152169. rtreeSearchPointPop(pCur);
  152170. }
  152171. if( rScore<RTREE_ZERO ) rScore = RTREE_ZERO;
  152172. p = rtreeSearchPointNew(pCur, rScore, x.iLevel);
  152173. if( p==0 ) return SQLITE_NOMEM;
  152174. p->eWithin = eWithin;
  152175. p->id = x.id;
  152176. p->iCell = x.iCell;
  152177. RTREE_QUEUE_TRACE(pCur, "PUSH-S:");
  152178. break;
  152179. }
  152180. if( p->iCell>=nCell ){
  152181. RTREE_QUEUE_TRACE(pCur, "POP-Se:");
  152182. rtreeSearchPointPop(pCur);
  152183. }
  152184. }
  152185. pCur->atEOF = p==0;
  152186. return SQLITE_OK;
  152187. }
  152188. /*
  152189. ** Rtree virtual table module xNext method.
  152190. */
  152191. static int rtreeNext(sqlite3_vtab_cursor *pVtabCursor){
  152192. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  152193. int rc = SQLITE_OK;
  152194. /* Move to the next entry that matches the configured constraints. */
  152195. RTREE_QUEUE_TRACE(pCsr, "POP-Nx:");
  152196. rtreeSearchPointPop(pCsr);
  152197. rc = rtreeStepToLeaf(pCsr);
  152198. return rc;
  152199. }
  152200. /*
  152201. ** Rtree virtual table module xRowid method.
  152202. */
  152203. static int rtreeRowid(sqlite3_vtab_cursor *pVtabCursor, sqlite_int64 *pRowid){
  152204. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  152205. RtreeSearchPoint *p = rtreeSearchPointFirst(pCsr);
  152206. int rc = SQLITE_OK;
  152207. RtreeNode *pNode = rtreeNodeOfFirstSearchPoint(pCsr, &rc);
  152208. if( rc==SQLITE_OK && p ){
  152209. *pRowid = nodeGetRowid(RTREE_OF_CURSOR(pCsr), pNode, p->iCell);
  152210. }
  152211. return rc;
  152212. }
  152213. /*
  152214. ** Rtree virtual table module xColumn method.
  152215. */
  152216. static int rtreeColumn(sqlite3_vtab_cursor *cur, sqlite3_context *ctx, int i){
  152217. Rtree *pRtree = (Rtree *)cur->pVtab;
  152218. RtreeCursor *pCsr = (RtreeCursor *)cur;
  152219. RtreeSearchPoint *p = rtreeSearchPointFirst(pCsr);
  152220. RtreeCoord c;
  152221. int rc = SQLITE_OK;
  152222. RtreeNode *pNode = rtreeNodeOfFirstSearchPoint(pCsr, &rc);
  152223. if( rc ) return rc;
  152224. if( p==0 ) return SQLITE_OK;
  152225. if( i==0 ){
  152226. sqlite3_result_int64(ctx, nodeGetRowid(pRtree, pNode, p->iCell));
  152227. }else{
  152228. if( rc ) return rc;
  152229. nodeGetCoord(pRtree, pNode, p->iCell, i-1, &c);
  152230. #ifndef SQLITE_RTREE_INT_ONLY
  152231. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  152232. sqlite3_result_double(ctx, c.f);
  152233. }else
  152234. #endif
  152235. {
  152236. assert( pRtree->eCoordType==RTREE_COORD_INT32 );
  152237. sqlite3_result_int(ctx, c.i);
  152238. }
  152239. }
  152240. return SQLITE_OK;
  152241. }
  152242. /*
  152243. ** Use nodeAcquire() to obtain the leaf node containing the record with
  152244. ** rowid iRowid. If successful, set *ppLeaf to point to the node and
  152245. ** return SQLITE_OK. If there is no such record in the table, set
  152246. ** *ppLeaf to 0 and return SQLITE_OK. If an error occurs, set *ppLeaf
  152247. ** to zero and return an SQLite error code.
  152248. */
  152249. static int findLeafNode(
  152250. Rtree *pRtree, /* RTree to search */
  152251. i64 iRowid, /* The rowid searching for */
  152252. RtreeNode **ppLeaf, /* Write the node here */
  152253. sqlite3_int64 *piNode /* Write the node-id here */
  152254. ){
  152255. int rc;
  152256. *ppLeaf = 0;
  152257. sqlite3_bind_int64(pRtree->pReadRowid, 1, iRowid);
  152258. if( sqlite3_step(pRtree->pReadRowid)==SQLITE_ROW ){
  152259. i64 iNode = sqlite3_column_int64(pRtree->pReadRowid, 0);
  152260. if( piNode ) *piNode = iNode;
  152261. rc = nodeAcquire(pRtree, iNode, 0, ppLeaf);
  152262. sqlite3_reset(pRtree->pReadRowid);
  152263. }else{
  152264. rc = sqlite3_reset(pRtree->pReadRowid);
  152265. }
  152266. return rc;
  152267. }
  152268. /*
  152269. ** This function is called to configure the RtreeConstraint object passed
  152270. ** as the second argument for a MATCH constraint. The value passed as the
  152271. ** first argument to this function is the right-hand operand to the MATCH
  152272. ** operator.
  152273. */
  152274. static int deserializeGeometry(sqlite3_value *pValue, RtreeConstraint *pCons){
  152275. RtreeMatchArg *pBlob; /* BLOB returned by geometry function */
  152276. sqlite3_rtree_query_info *pInfo; /* Callback information */
  152277. int nBlob; /* Size of the geometry function blob */
  152278. int nExpected; /* Expected size of the BLOB */
  152279. /* Check that value is actually a blob. */
  152280. if( sqlite3_value_type(pValue)!=SQLITE_BLOB ) return SQLITE_ERROR;
  152281. /* Check that the blob is roughly the right size. */
  152282. nBlob = sqlite3_value_bytes(pValue);
  152283. if( nBlob<(int)sizeof(RtreeMatchArg) ){
  152284. return SQLITE_ERROR;
  152285. }
  152286. pInfo = (sqlite3_rtree_query_info*)sqlite3_malloc( sizeof(*pInfo)+nBlob );
  152287. if( !pInfo ) return SQLITE_NOMEM;
  152288. memset(pInfo, 0, sizeof(*pInfo));
  152289. pBlob = (RtreeMatchArg*)&pInfo[1];
  152290. memcpy(pBlob, sqlite3_value_blob(pValue), nBlob);
  152291. nExpected = (int)(sizeof(RtreeMatchArg) +
  152292. pBlob->nParam*sizeof(sqlite3_value*) +
  152293. (pBlob->nParam-1)*sizeof(RtreeDValue));
  152294. if( pBlob->magic!=RTREE_GEOMETRY_MAGIC || nBlob!=nExpected ){
  152295. sqlite3_free(pInfo);
  152296. return SQLITE_ERROR;
  152297. }
  152298. pInfo->pContext = pBlob->cb.pContext;
  152299. pInfo->nParam = pBlob->nParam;
  152300. pInfo->aParam = pBlob->aParam;
  152301. pInfo->apSqlParam = pBlob->apSqlParam;
  152302. if( pBlob->cb.xGeom ){
  152303. pCons->u.xGeom = pBlob->cb.xGeom;
  152304. }else{
  152305. pCons->op = RTREE_QUERY;
  152306. pCons->u.xQueryFunc = pBlob->cb.xQueryFunc;
  152307. }
  152308. pCons->pInfo = pInfo;
  152309. return SQLITE_OK;
  152310. }
  152311. /*
  152312. ** Rtree virtual table module xFilter method.
  152313. */
  152314. static int rtreeFilter(
  152315. sqlite3_vtab_cursor *pVtabCursor,
  152316. int idxNum, const char *idxStr,
  152317. int argc, sqlite3_value **argv
  152318. ){
  152319. Rtree *pRtree = (Rtree *)pVtabCursor->pVtab;
  152320. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  152321. RtreeNode *pRoot = 0;
  152322. int ii;
  152323. int rc = SQLITE_OK;
  152324. int iCell = 0;
  152325. rtreeReference(pRtree);
  152326. /* Reset the cursor to the same state as rtreeOpen() leaves it in. */
  152327. freeCursorConstraints(pCsr);
  152328. sqlite3_free(pCsr->aPoint);
  152329. memset(pCsr, 0, sizeof(RtreeCursor));
  152330. pCsr->base.pVtab = (sqlite3_vtab*)pRtree;
  152331. pCsr->iStrategy = idxNum;
  152332. if( idxNum==1 ){
  152333. /* Special case - lookup by rowid. */
  152334. RtreeNode *pLeaf; /* Leaf on which the required cell resides */
  152335. RtreeSearchPoint *p; /* Search point for the leaf */
  152336. i64 iRowid = sqlite3_value_int64(argv[0]);
  152337. i64 iNode = 0;
  152338. rc = findLeafNode(pRtree, iRowid, &pLeaf, &iNode);
  152339. if( rc==SQLITE_OK && pLeaf!=0 ){
  152340. p = rtreeSearchPointNew(pCsr, RTREE_ZERO, 0);
  152341. assert( p!=0 ); /* Always returns pCsr->sPoint */
  152342. pCsr->aNode[0] = pLeaf;
  152343. p->id = iNode;
  152344. p->eWithin = PARTLY_WITHIN;
  152345. rc = nodeRowidIndex(pRtree, pLeaf, iRowid, &iCell);
  152346. p->iCell = iCell;
  152347. RTREE_QUEUE_TRACE(pCsr, "PUSH-F1:");
  152348. }else{
  152349. pCsr->atEOF = 1;
  152350. }
  152351. }else{
  152352. /* Normal case - r-tree scan. Set up the RtreeCursor.aConstraint array
  152353. ** with the configured constraints.
  152354. */
  152355. rc = nodeAcquire(pRtree, 1, 0, &pRoot);
  152356. if( rc==SQLITE_OK && argc>0 ){
  152357. pCsr->aConstraint = sqlite3_malloc(sizeof(RtreeConstraint)*argc);
  152358. pCsr->nConstraint = argc;
  152359. if( !pCsr->aConstraint ){
  152360. rc = SQLITE_NOMEM;
  152361. }else{
  152362. memset(pCsr->aConstraint, 0, sizeof(RtreeConstraint)*argc);
  152363. memset(pCsr->anQueue, 0, sizeof(u32)*(pRtree->iDepth + 1));
  152364. assert( (idxStr==0 && argc==0)
  152365. || (idxStr && (int)strlen(idxStr)==argc*2) );
  152366. for(ii=0; ii<argc; ii++){
  152367. RtreeConstraint *p = &pCsr->aConstraint[ii];
  152368. p->op = idxStr[ii*2];
  152369. p->iCoord = idxStr[ii*2+1]-'0';
  152370. if( p->op>=RTREE_MATCH ){
  152371. /* A MATCH operator. The right-hand-side must be a blob that
  152372. ** can be cast into an RtreeMatchArg object. One created using
  152373. ** an sqlite3_rtree_geometry_callback() SQL user function.
  152374. */
  152375. rc = deserializeGeometry(argv[ii], p);
  152376. if( rc!=SQLITE_OK ){
  152377. break;
  152378. }
  152379. p->pInfo->nCoord = pRtree->nDim*2;
  152380. p->pInfo->anQueue = pCsr->anQueue;
  152381. p->pInfo->mxLevel = pRtree->iDepth + 1;
  152382. }else{
  152383. #ifdef SQLITE_RTREE_INT_ONLY
  152384. p->u.rValue = sqlite3_value_int64(argv[ii]);
  152385. #else
  152386. p->u.rValue = sqlite3_value_double(argv[ii]);
  152387. #endif
  152388. }
  152389. }
  152390. }
  152391. }
  152392. if( rc==SQLITE_OK ){
  152393. RtreeSearchPoint *pNew;
  152394. pNew = rtreeSearchPointNew(pCsr, RTREE_ZERO, pRtree->iDepth+1);
  152395. if( pNew==0 ) return SQLITE_NOMEM;
  152396. pNew->id = 1;
  152397. pNew->iCell = 0;
  152398. pNew->eWithin = PARTLY_WITHIN;
  152399. assert( pCsr->bPoint==1 );
  152400. pCsr->aNode[0] = pRoot;
  152401. pRoot = 0;
  152402. RTREE_QUEUE_TRACE(pCsr, "PUSH-Fm:");
  152403. rc = rtreeStepToLeaf(pCsr);
  152404. }
  152405. }
  152406. nodeRelease(pRtree, pRoot);
  152407. rtreeRelease(pRtree);
  152408. return rc;
  152409. }
  152410. /*
  152411. ** Set the pIdxInfo->estimatedRows variable to nRow. Unless this
  152412. ** extension is currently being used by a version of SQLite too old to
  152413. ** support estimatedRows. In that case this function is a no-op.
  152414. */
  152415. static void setEstimatedRows(sqlite3_index_info *pIdxInfo, i64 nRow){
  152416. #if SQLITE_VERSION_NUMBER>=3008002
  152417. if( sqlite3_libversion_number()>=3008002 ){
  152418. pIdxInfo->estimatedRows = nRow;
  152419. }
  152420. #endif
  152421. }
  152422. /*
  152423. ** Rtree virtual table module xBestIndex method. There are three
  152424. ** table scan strategies to choose from (in order from most to
  152425. ** least desirable):
  152426. **
  152427. ** idxNum idxStr Strategy
  152428. ** ------------------------------------------------
  152429. ** 1 Unused Direct lookup by rowid.
  152430. ** 2 See below R-tree query or full-table scan.
  152431. ** ------------------------------------------------
  152432. **
  152433. ** If strategy 1 is used, then idxStr is not meaningful. If strategy
  152434. ** 2 is used, idxStr is formatted to contain 2 bytes for each
  152435. ** constraint used. The first two bytes of idxStr correspond to
  152436. ** the constraint in sqlite3_index_info.aConstraintUsage[] with
  152437. ** (argvIndex==1) etc.
  152438. **
  152439. ** The first of each pair of bytes in idxStr identifies the constraint
  152440. ** operator as follows:
  152441. **
  152442. ** Operator Byte Value
  152443. ** ----------------------
  152444. ** = 0x41 ('A')
  152445. ** <= 0x42 ('B')
  152446. ** < 0x43 ('C')
  152447. ** >= 0x44 ('D')
  152448. ** > 0x45 ('E')
  152449. ** MATCH 0x46 ('F')
  152450. ** ----------------------
  152451. **
  152452. ** The second of each pair of bytes identifies the coordinate column
  152453. ** to which the constraint applies. The leftmost coordinate column
  152454. ** is 'a', the second from the left 'b' etc.
  152455. */
  152456. static int rtreeBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  152457. Rtree *pRtree = (Rtree*)tab;
  152458. int rc = SQLITE_OK;
  152459. int ii;
  152460. int bMatch = 0; /* True if there exists a MATCH constraint */
  152461. i64 nRow; /* Estimated rows returned by this scan */
  152462. int iIdx = 0;
  152463. char zIdxStr[RTREE_MAX_DIMENSIONS*8+1];
  152464. memset(zIdxStr, 0, sizeof(zIdxStr));
  152465. /* Check if there exists a MATCH constraint - even an unusable one. If there
  152466. ** is, do not consider the lookup-by-rowid plan as using such a plan would
  152467. ** require the VDBE to evaluate the MATCH constraint, which is not currently
  152468. ** possible. */
  152469. for(ii=0; ii<pIdxInfo->nConstraint; ii++){
  152470. if( pIdxInfo->aConstraint[ii].op==SQLITE_INDEX_CONSTRAINT_MATCH ){
  152471. bMatch = 1;
  152472. }
  152473. }
  152474. assert( pIdxInfo->idxStr==0 );
  152475. for(ii=0; ii<pIdxInfo->nConstraint && iIdx<(int)(sizeof(zIdxStr)-1); ii++){
  152476. struct sqlite3_index_constraint *p = &pIdxInfo->aConstraint[ii];
  152477. if( bMatch==0 && p->usable
  152478. && p->iColumn==0 && p->op==SQLITE_INDEX_CONSTRAINT_EQ
  152479. ){
  152480. /* We have an equality constraint on the rowid. Use strategy 1. */
  152481. int jj;
  152482. for(jj=0; jj<ii; jj++){
  152483. pIdxInfo->aConstraintUsage[jj].argvIndex = 0;
  152484. pIdxInfo->aConstraintUsage[jj].omit = 0;
  152485. }
  152486. pIdxInfo->idxNum = 1;
  152487. pIdxInfo->aConstraintUsage[ii].argvIndex = 1;
  152488. pIdxInfo->aConstraintUsage[jj].omit = 1;
  152489. /* This strategy involves a two rowid lookups on an B-Tree structures
  152490. ** and then a linear search of an R-Tree node. This should be
  152491. ** considered almost as quick as a direct rowid lookup (for which
  152492. ** sqlite uses an internal cost of 0.0). It is expected to return
  152493. ** a single row.
  152494. */
  152495. pIdxInfo->estimatedCost = 30.0;
  152496. setEstimatedRows(pIdxInfo, 1);
  152497. return SQLITE_OK;
  152498. }
  152499. if( p->usable && (p->iColumn>0 || p->op==SQLITE_INDEX_CONSTRAINT_MATCH) ){
  152500. u8 op;
  152501. switch( p->op ){
  152502. case SQLITE_INDEX_CONSTRAINT_EQ: op = RTREE_EQ; break;
  152503. case SQLITE_INDEX_CONSTRAINT_GT: op = RTREE_GT; break;
  152504. case SQLITE_INDEX_CONSTRAINT_LE: op = RTREE_LE; break;
  152505. case SQLITE_INDEX_CONSTRAINT_LT: op = RTREE_LT; break;
  152506. case SQLITE_INDEX_CONSTRAINT_GE: op = RTREE_GE; break;
  152507. default:
  152508. assert( p->op==SQLITE_INDEX_CONSTRAINT_MATCH );
  152509. op = RTREE_MATCH;
  152510. break;
  152511. }
  152512. zIdxStr[iIdx++] = op;
  152513. zIdxStr[iIdx++] = p->iColumn - 1 + '0';
  152514. pIdxInfo->aConstraintUsage[ii].argvIndex = (iIdx/2);
  152515. pIdxInfo->aConstraintUsage[ii].omit = 1;
  152516. }
  152517. }
  152518. pIdxInfo->idxNum = 2;
  152519. pIdxInfo->needToFreeIdxStr = 1;
  152520. if( iIdx>0 && 0==(pIdxInfo->idxStr = sqlite3_mprintf("%s", zIdxStr)) ){
  152521. return SQLITE_NOMEM;
  152522. }
  152523. nRow = pRtree->nRowEst >> (iIdx/2);
  152524. pIdxInfo->estimatedCost = (double)6.0 * (double)nRow;
  152525. setEstimatedRows(pIdxInfo, nRow);
  152526. return rc;
  152527. }
  152528. /*
  152529. ** Return the N-dimensional volumn of the cell stored in *p.
  152530. */
  152531. static RtreeDValue cellArea(Rtree *pRtree, RtreeCell *p){
  152532. RtreeDValue area = (RtreeDValue)1;
  152533. int ii;
  152534. for(ii=0; ii<(pRtree->nDim*2); ii+=2){
  152535. area = (area * (DCOORD(p->aCoord[ii+1]) - DCOORD(p->aCoord[ii])));
  152536. }
  152537. return area;
  152538. }
  152539. /*
  152540. ** Return the margin length of cell p. The margin length is the sum
  152541. ** of the objects size in each dimension.
  152542. */
  152543. static RtreeDValue cellMargin(Rtree *pRtree, RtreeCell *p){
  152544. RtreeDValue margin = (RtreeDValue)0;
  152545. int ii;
  152546. for(ii=0; ii<(pRtree->nDim*2); ii+=2){
  152547. margin += (DCOORD(p->aCoord[ii+1]) - DCOORD(p->aCoord[ii]));
  152548. }
  152549. return margin;
  152550. }
  152551. /*
  152552. ** Store the union of cells p1 and p2 in p1.
  152553. */
  152554. static void cellUnion(Rtree *pRtree, RtreeCell *p1, RtreeCell *p2){
  152555. int ii;
  152556. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  152557. for(ii=0; ii<(pRtree->nDim*2); ii+=2){
  152558. p1->aCoord[ii].f = MIN(p1->aCoord[ii].f, p2->aCoord[ii].f);
  152559. p1->aCoord[ii+1].f = MAX(p1->aCoord[ii+1].f, p2->aCoord[ii+1].f);
  152560. }
  152561. }else{
  152562. for(ii=0; ii<(pRtree->nDim*2); ii+=2){
  152563. p1->aCoord[ii].i = MIN(p1->aCoord[ii].i, p2->aCoord[ii].i);
  152564. p1->aCoord[ii+1].i = MAX(p1->aCoord[ii+1].i, p2->aCoord[ii+1].i);
  152565. }
  152566. }
  152567. }
  152568. /*
  152569. ** Return true if the area covered by p2 is a subset of the area covered
  152570. ** by p1. False otherwise.
  152571. */
  152572. static int cellContains(Rtree *pRtree, RtreeCell *p1, RtreeCell *p2){
  152573. int ii;
  152574. int isInt = (pRtree->eCoordType==RTREE_COORD_INT32);
  152575. for(ii=0; ii<(pRtree->nDim*2); ii+=2){
  152576. RtreeCoord *a1 = &p1->aCoord[ii];
  152577. RtreeCoord *a2 = &p2->aCoord[ii];
  152578. if( (!isInt && (a2[0].f<a1[0].f || a2[1].f>a1[1].f))
  152579. || ( isInt && (a2[0].i<a1[0].i || a2[1].i>a1[1].i))
  152580. ){
  152581. return 0;
  152582. }
  152583. }
  152584. return 1;
  152585. }
  152586. /*
  152587. ** Return the amount cell p would grow by if it were unioned with pCell.
  152588. */
  152589. static RtreeDValue cellGrowth(Rtree *pRtree, RtreeCell *p, RtreeCell *pCell){
  152590. RtreeDValue area;
  152591. RtreeCell cell;
  152592. memcpy(&cell, p, sizeof(RtreeCell));
  152593. area = cellArea(pRtree, &cell);
  152594. cellUnion(pRtree, &cell, pCell);
  152595. return (cellArea(pRtree, &cell)-area);
  152596. }
  152597. static RtreeDValue cellOverlap(
  152598. Rtree *pRtree,
  152599. RtreeCell *p,
  152600. RtreeCell *aCell,
  152601. int nCell
  152602. ){
  152603. int ii;
  152604. RtreeDValue overlap = RTREE_ZERO;
  152605. for(ii=0; ii<nCell; ii++){
  152606. int jj;
  152607. RtreeDValue o = (RtreeDValue)1;
  152608. for(jj=0; jj<(pRtree->nDim*2); jj+=2){
  152609. RtreeDValue x1, x2;
  152610. x1 = MAX(DCOORD(p->aCoord[jj]), DCOORD(aCell[ii].aCoord[jj]));
  152611. x2 = MIN(DCOORD(p->aCoord[jj+1]), DCOORD(aCell[ii].aCoord[jj+1]));
  152612. if( x2<x1 ){
  152613. o = (RtreeDValue)0;
  152614. break;
  152615. }else{
  152616. o = o * (x2-x1);
  152617. }
  152618. }
  152619. overlap += o;
  152620. }
  152621. return overlap;
  152622. }
  152623. /*
  152624. ** This function implements the ChooseLeaf algorithm from Gutman[84].
  152625. ** ChooseSubTree in r*tree terminology.
  152626. */
  152627. static int ChooseLeaf(
  152628. Rtree *pRtree, /* Rtree table */
  152629. RtreeCell *pCell, /* Cell to insert into rtree */
  152630. int iHeight, /* Height of sub-tree rooted at pCell */
  152631. RtreeNode **ppLeaf /* OUT: Selected leaf page */
  152632. ){
  152633. int rc;
  152634. int ii;
  152635. RtreeNode *pNode;
  152636. rc = nodeAcquire(pRtree, 1, 0, &pNode);
  152637. for(ii=0; rc==SQLITE_OK && ii<(pRtree->iDepth-iHeight); ii++){
  152638. int iCell;
  152639. sqlite3_int64 iBest = 0;
  152640. RtreeDValue fMinGrowth = RTREE_ZERO;
  152641. RtreeDValue fMinArea = RTREE_ZERO;
  152642. int nCell = NCELL(pNode);
  152643. RtreeCell cell;
  152644. RtreeNode *pChild;
  152645. RtreeCell *aCell = 0;
  152646. /* Select the child node which will be enlarged the least if pCell
  152647. ** is inserted into it. Resolve ties by choosing the entry with
  152648. ** the smallest area.
  152649. */
  152650. for(iCell=0; iCell<nCell; iCell++){
  152651. int bBest = 0;
  152652. RtreeDValue growth;
  152653. RtreeDValue area;
  152654. nodeGetCell(pRtree, pNode, iCell, &cell);
  152655. growth = cellGrowth(pRtree, &cell, pCell);
  152656. area = cellArea(pRtree, &cell);
  152657. if( iCell==0||growth<fMinGrowth||(growth==fMinGrowth && area<fMinArea) ){
  152658. bBest = 1;
  152659. }
  152660. if( bBest ){
  152661. fMinGrowth = growth;
  152662. fMinArea = area;
  152663. iBest = cell.iRowid;
  152664. }
  152665. }
  152666. sqlite3_free(aCell);
  152667. rc = nodeAcquire(pRtree, iBest, pNode, &pChild);
  152668. nodeRelease(pRtree, pNode);
  152669. pNode = pChild;
  152670. }
  152671. *ppLeaf = pNode;
  152672. return rc;
  152673. }
  152674. /*
  152675. ** A cell with the same content as pCell has just been inserted into
  152676. ** the node pNode. This function updates the bounding box cells in
  152677. ** all ancestor elements.
  152678. */
  152679. static int AdjustTree(
  152680. Rtree *pRtree, /* Rtree table */
  152681. RtreeNode *pNode, /* Adjust ancestry of this node. */
  152682. RtreeCell *pCell /* This cell was just inserted */
  152683. ){
  152684. RtreeNode *p = pNode;
  152685. while( p->pParent ){
  152686. RtreeNode *pParent = p->pParent;
  152687. RtreeCell cell;
  152688. int iCell;
  152689. if( nodeParentIndex(pRtree, p, &iCell) ){
  152690. return SQLITE_CORRUPT_VTAB;
  152691. }
  152692. nodeGetCell(pRtree, pParent, iCell, &cell);
  152693. if( !cellContains(pRtree, &cell, pCell) ){
  152694. cellUnion(pRtree, &cell, pCell);
  152695. nodeOverwriteCell(pRtree, pParent, &cell, iCell);
  152696. }
  152697. p = pParent;
  152698. }
  152699. return SQLITE_OK;
  152700. }
  152701. /*
  152702. ** Write mapping (iRowid->iNode) to the <rtree>_rowid table.
  152703. */
  152704. static int rowidWrite(Rtree *pRtree, sqlite3_int64 iRowid, sqlite3_int64 iNode){
  152705. sqlite3_bind_int64(pRtree->pWriteRowid, 1, iRowid);
  152706. sqlite3_bind_int64(pRtree->pWriteRowid, 2, iNode);
  152707. sqlite3_step(pRtree->pWriteRowid);
  152708. return sqlite3_reset(pRtree->pWriteRowid);
  152709. }
  152710. /*
  152711. ** Write mapping (iNode->iPar) to the <rtree>_parent table.
  152712. */
  152713. static int parentWrite(Rtree *pRtree, sqlite3_int64 iNode, sqlite3_int64 iPar){
  152714. sqlite3_bind_int64(pRtree->pWriteParent, 1, iNode);
  152715. sqlite3_bind_int64(pRtree->pWriteParent, 2, iPar);
  152716. sqlite3_step(pRtree->pWriteParent);
  152717. return sqlite3_reset(pRtree->pWriteParent);
  152718. }
  152719. static int rtreeInsertCell(Rtree *, RtreeNode *, RtreeCell *, int);
  152720. /*
  152721. ** Arguments aIdx, aDistance and aSpare all point to arrays of size
  152722. ** nIdx. The aIdx array contains the set of integers from 0 to
  152723. ** (nIdx-1) in no particular order. This function sorts the values
  152724. ** in aIdx according to the indexed values in aDistance. For
  152725. ** example, assuming the inputs:
  152726. **
  152727. ** aIdx = { 0, 1, 2, 3 }
  152728. ** aDistance = { 5.0, 2.0, 7.0, 6.0 }
  152729. **
  152730. ** this function sets the aIdx array to contain:
  152731. **
  152732. ** aIdx = { 0, 1, 2, 3 }
  152733. **
  152734. ** The aSpare array is used as temporary working space by the
  152735. ** sorting algorithm.
  152736. */
  152737. static void SortByDistance(
  152738. int *aIdx,
  152739. int nIdx,
  152740. RtreeDValue *aDistance,
  152741. int *aSpare
  152742. ){
  152743. if( nIdx>1 ){
  152744. int iLeft = 0;
  152745. int iRight = 0;
  152746. int nLeft = nIdx/2;
  152747. int nRight = nIdx-nLeft;
  152748. int *aLeft = aIdx;
  152749. int *aRight = &aIdx[nLeft];
  152750. SortByDistance(aLeft, nLeft, aDistance, aSpare);
  152751. SortByDistance(aRight, nRight, aDistance, aSpare);
  152752. memcpy(aSpare, aLeft, sizeof(int)*nLeft);
  152753. aLeft = aSpare;
  152754. while( iLeft<nLeft || iRight<nRight ){
  152755. if( iLeft==nLeft ){
  152756. aIdx[iLeft+iRight] = aRight[iRight];
  152757. iRight++;
  152758. }else if( iRight==nRight ){
  152759. aIdx[iLeft+iRight] = aLeft[iLeft];
  152760. iLeft++;
  152761. }else{
  152762. RtreeDValue fLeft = aDistance[aLeft[iLeft]];
  152763. RtreeDValue fRight = aDistance[aRight[iRight]];
  152764. if( fLeft<fRight ){
  152765. aIdx[iLeft+iRight] = aLeft[iLeft];
  152766. iLeft++;
  152767. }else{
  152768. aIdx[iLeft+iRight] = aRight[iRight];
  152769. iRight++;
  152770. }
  152771. }
  152772. }
  152773. #if 0
  152774. /* Check that the sort worked */
  152775. {
  152776. int jj;
  152777. for(jj=1; jj<nIdx; jj++){
  152778. RtreeDValue left = aDistance[aIdx[jj-1]];
  152779. RtreeDValue right = aDistance[aIdx[jj]];
  152780. assert( left<=right );
  152781. }
  152782. }
  152783. #endif
  152784. }
  152785. }
  152786. /*
  152787. ** Arguments aIdx, aCell and aSpare all point to arrays of size
  152788. ** nIdx. The aIdx array contains the set of integers from 0 to
  152789. ** (nIdx-1) in no particular order. This function sorts the values
  152790. ** in aIdx according to dimension iDim of the cells in aCell. The
  152791. ** minimum value of dimension iDim is considered first, the
  152792. ** maximum used to break ties.
  152793. **
  152794. ** The aSpare array is used as temporary working space by the
  152795. ** sorting algorithm.
  152796. */
  152797. static void SortByDimension(
  152798. Rtree *pRtree,
  152799. int *aIdx,
  152800. int nIdx,
  152801. int iDim,
  152802. RtreeCell *aCell,
  152803. int *aSpare
  152804. ){
  152805. if( nIdx>1 ){
  152806. int iLeft = 0;
  152807. int iRight = 0;
  152808. int nLeft = nIdx/2;
  152809. int nRight = nIdx-nLeft;
  152810. int *aLeft = aIdx;
  152811. int *aRight = &aIdx[nLeft];
  152812. SortByDimension(pRtree, aLeft, nLeft, iDim, aCell, aSpare);
  152813. SortByDimension(pRtree, aRight, nRight, iDim, aCell, aSpare);
  152814. memcpy(aSpare, aLeft, sizeof(int)*nLeft);
  152815. aLeft = aSpare;
  152816. while( iLeft<nLeft || iRight<nRight ){
  152817. RtreeDValue xleft1 = DCOORD(aCell[aLeft[iLeft]].aCoord[iDim*2]);
  152818. RtreeDValue xleft2 = DCOORD(aCell[aLeft[iLeft]].aCoord[iDim*2+1]);
  152819. RtreeDValue xright1 = DCOORD(aCell[aRight[iRight]].aCoord[iDim*2]);
  152820. RtreeDValue xright2 = DCOORD(aCell[aRight[iRight]].aCoord[iDim*2+1]);
  152821. if( (iLeft!=nLeft) && ((iRight==nRight)
  152822. || (xleft1<xright1)
  152823. || (xleft1==xright1 && xleft2<xright2)
  152824. )){
  152825. aIdx[iLeft+iRight] = aLeft[iLeft];
  152826. iLeft++;
  152827. }else{
  152828. aIdx[iLeft+iRight] = aRight[iRight];
  152829. iRight++;
  152830. }
  152831. }
  152832. #if 0
  152833. /* Check that the sort worked */
  152834. {
  152835. int jj;
  152836. for(jj=1; jj<nIdx; jj++){
  152837. RtreeDValue xleft1 = aCell[aIdx[jj-1]].aCoord[iDim*2];
  152838. RtreeDValue xleft2 = aCell[aIdx[jj-1]].aCoord[iDim*2+1];
  152839. RtreeDValue xright1 = aCell[aIdx[jj]].aCoord[iDim*2];
  152840. RtreeDValue xright2 = aCell[aIdx[jj]].aCoord[iDim*2+1];
  152841. assert( xleft1<=xright1 && (xleft1<xright1 || xleft2<=xright2) );
  152842. }
  152843. }
  152844. #endif
  152845. }
  152846. }
  152847. /*
  152848. ** Implementation of the R*-tree variant of SplitNode from Beckman[1990].
  152849. */
  152850. static int splitNodeStartree(
  152851. Rtree *pRtree,
  152852. RtreeCell *aCell,
  152853. int nCell,
  152854. RtreeNode *pLeft,
  152855. RtreeNode *pRight,
  152856. RtreeCell *pBboxLeft,
  152857. RtreeCell *pBboxRight
  152858. ){
  152859. int **aaSorted;
  152860. int *aSpare;
  152861. int ii;
  152862. int iBestDim = 0;
  152863. int iBestSplit = 0;
  152864. RtreeDValue fBestMargin = RTREE_ZERO;
  152865. int nByte = (pRtree->nDim+1)*(sizeof(int*)+nCell*sizeof(int));
  152866. aaSorted = (int **)sqlite3_malloc(nByte);
  152867. if( !aaSorted ){
  152868. return SQLITE_NOMEM;
  152869. }
  152870. aSpare = &((int *)&aaSorted[pRtree->nDim])[pRtree->nDim*nCell];
  152871. memset(aaSorted, 0, nByte);
  152872. for(ii=0; ii<pRtree->nDim; ii++){
  152873. int jj;
  152874. aaSorted[ii] = &((int *)&aaSorted[pRtree->nDim])[ii*nCell];
  152875. for(jj=0; jj<nCell; jj++){
  152876. aaSorted[ii][jj] = jj;
  152877. }
  152878. SortByDimension(pRtree, aaSorted[ii], nCell, ii, aCell, aSpare);
  152879. }
  152880. for(ii=0; ii<pRtree->nDim; ii++){
  152881. RtreeDValue margin = RTREE_ZERO;
  152882. RtreeDValue fBestOverlap = RTREE_ZERO;
  152883. RtreeDValue fBestArea = RTREE_ZERO;
  152884. int iBestLeft = 0;
  152885. int nLeft;
  152886. for(
  152887. nLeft=RTREE_MINCELLS(pRtree);
  152888. nLeft<=(nCell-RTREE_MINCELLS(pRtree));
  152889. nLeft++
  152890. ){
  152891. RtreeCell left;
  152892. RtreeCell right;
  152893. int kk;
  152894. RtreeDValue overlap;
  152895. RtreeDValue area;
  152896. memcpy(&left, &aCell[aaSorted[ii][0]], sizeof(RtreeCell));
  152897. memcpy(&right, &aCell[aaSorted[ii][nCell-1]], sizeof(RtreeCell));
  152898. for(kk=1; kk<(nCell-1); kk++){
  152899. if( kk<nLeft ){
  152900. cellUnion(pRtree, &left, &aCell[aaSorted[ii][kk]]);
  152901. }else{
  152902. cellUnion(pRtree, &right, &aCell[aaSorted[ii][kk]]);
  152903. }
  152904. }
  152905. margin += cellMargin(pRtree, &left);
  152906. margin += cellMargin(pRtree, &right);
  152907. overlap = cellOverlap(pRtree, &left, &right, 1);
  152908. area = cellArea(pRtree, &left) + cellArea(pRtree, &right);
  152909. if( (nLeft==RTREE_MINCELLS(pRtree))
  152910. || (overlap<fBestOverlap)
  152911. || (overlap==fBestOverlap && area<fBestArea)
  152912. ){
  152913. iBestLeft = nLeft;
  152914. fBestOverlap = overlap;
  152915. fBestArea = area;
  152916. }
  152917. }
  152918. if( ii==0 || margin<fBestMargin ){
  152919. iBestDim = ii;
  152920. fBestMargin = margin;
  152921. iBestSplit = iBestLeft;
  152922. }
  152923. }
  152924. memcpy(pBboxLeft, &aCell[aaSorted[iBestDim][0]], sizeof(RtreeCell));
  152925. memcpy(pBboxRight, &aCell[aaSorted[iBestDim][iBestSplit]], sizeof(RtreeCell));
  152926. for(ii=0; ii<nCell; ii++){
  152927. RtreeNode *pTarget = (ii<iBestSplit)?pLeft:pRight;
  152928. RtreeCell *pBbox = (ii<iBestSplit)?pBboxLeft:pBboxRight;
  152929. RtreeCell *pCell = &aCell[aaSorted[iBestDim][ii]];
  152930. nodeInsertCell(pRtree, pTarget, pCell);
  152931. cellUnion(pRtree, pBbox, pCell);
  152932. }
  152933. sqlite3_free(aaSorted);
  152934. return SQLITE_OK;
  152935. }
  152936. static int updateMapping(
  152937. Rtree *pRtree,
  152938. i64 iRowid,
  152939. RtreeNode *pNode,
  152940. int iHeight
  152941. ){
  152942. int (*xSetMapping)(Rtree *, sqlite3_int64, sqlite3_int64);
  152943. xSetMapping = ((iHeight==0)?rowidWrite:parentWrite);
  152944. if( iHeight>0 ){
  152945. RtreeNode *pChild = nodeHashLookup(pRtree, iRowid);
  152946. if( pChild ){
  152947. nodeRelease(pRtree, pChild->pParent);
  152948. nodeReference(pNode);
  152949. pChild->pParent = pNode;
  152950. }
  152951. }
  152952. return xSetMapping(pRtree, iRowid, pNode->iNode);
  152953. }
  152954. static int SplitNode(
  152955. Rtree *pRtree,
  152956. RtreeNode *pNode,
  152957. RtreeCell *pCell,
  152958. int iHeight
  152959. ){
  152960. int i;
  152961. int newCellIsRight = 0;
  152962. int rc = SQLITE_OK;
  152963. int nCell = NCELL(pNode);
  152964. RtreeCell *aCell;
  152965. int *aiUsed;
  152966. RtreeNode *pLeft = 0;
  152967. RtreeNode *pRight = 0;
  152968. RtreeCell leftbbox;
  152969. RtreeCell rightbbox;
  152970. /* Allocate an array and populate it with a copy of pCell and
  152971. ** all cells from node pLeft. Then zero the original node.
  152972. */
  152973. aCell = sqlite3_malloc((sizeof(RtreeCell)+sizeof(int))*(nCell+1));
  152974. if( !aCell ){
  152975. rc = SQLITE_NOMEM;
  152976. goto splitnode_out;
  152977. }
  152978. aiUsed = (int *)&aCell[nCell+1];
  152979. memset(aiUsed, 0, sizeof(int)*(nCell+1));
  152980. for(i=0; i<nCell; i++){
  152981. nodeGetCell(pRtree, pNode, i, &aCell[i]);
  152982. }
  152983. nodeZero(pRtree, pNode);
  152984. memcpy(&aCell[nCell], pCell, sizeof(RtreeCell));
  152985. nCell++;
  152986. if( pNode->iNode==1 ){
  152987. pRight = nodeNew(pRtree, pNode);
  152988. pLeft = nodeNew(pRtree, pNode);
  152989. pRtree->iDepth++;
  152990. pNode->isDirty = 1;
  152991. writeInt16(pNode->zData, pRtree->iDepth);
  152992. }else{
  152993. pLeft = pNode;
  152994. pRight = nodeNew(pRtree, pLeft->pParent);
  152995. nodeReference(pLeft);
  152996. }
  152997. if( !pLeft || !pRight ){
  152998. rc = SQLITE_NOMEM;
  152999. goto splitnode_out;
  153000. }
  153001. memset(pLeft->zData, 0, pRtree->iNodeSize);
  153002. memset(pRight->zData, 0, pRtree->iNodeSize);
  153003. rc = splitNodeStartree(pRtree, aCell, nCell, pLeft, pRight,
  153004. &leftbbox, &rightbbox);
  153005. if( rc!=SQLITE_OK ){
  153006. goto splitnode_out;
  153007. }
  153008. /* Ensure both child nodes have node numbers assigned to them by calling
  153009. ** nodeWrite(). Node pRight always needs a node number, as it was created
  153010. ** by nodeNew() above. But node pLeft sometimes already has a node number.
  153011. ** In this case avoid the all to nodeWrite().
  153012. */
  153013. if( SQLITE_OK!=(rc = nodeWrite(pRtree, pRight))
  153014. || (0==pLeft->iNode && SQLITE_OK!=(rc = nodeWrite(pRtree, pLeft)))
  153015. ){
  153016. goto splitnode_out;
  153017. }
  153018. rightbbox.iRowid = pRight->iNode;
  153019. leftbbox.iRowid = pLeft->iNode;
  153020. if( pNode->iNode==1 ){
  153021. rc = rtreeInsertCell(pRtree, pLeft->pParent, &leftbbox, iHeight+1);
  153022. if( rc!=SQLITE_OK ){
  153023. goto splitnode_out;
  153024. }
  153025. }else{
  153026. RtreeNode *pParent = pLeft->pParent;
  153027. int iCell;
  153028. rc = nodeParentIndex(pRtree, pLeft, &iCell);
  153029. if( rc==SQLITE_OK ){
  153030. nodeOverwriteCell(pRtree, pParent, &leftbbox, iCell);
  153031. rc = AdjustTree(pRtree, pParent, &leftbbox);
  153032. }
  153033. if( rc!=SQLITE_OK ){
  153034. goto splitnode_out;
  153035. }
  153036. }
  153037. if( (rc = rtreeInsertCell(pRtree, pRight->pParent, &rightbbox, iHeight+1)) ){
  153038. goto splitnode_out;
  153039. }
  153040. for(i=0; i<NCELL(pRight); i++){
  153041. i64 iRowid = nodeGetRowid(pRtree, pRight, i);
  153042. rc = updateMapping(pRtree, iRowid, pRight, iHeight);
  153043. if( iRowid==pCell->iRowid ){
  153044. newCellIsRight = 1;
  153045. }
  153046. if( rc!=SQLITE_OK ){
  153047. goto splitnode_out;
  153048. }
  153049. }
  153050. if( pNode->iNode==1 ){
  153051. for(i=0; i<NCELL(pLeft); i++){
  153052. i64 iRowid = nodeGetRowid(pRtree, pLeft, i);
  153053. rc = updateMapping(pRtree, iRowid, pLeft, iHeight);
  153054. if( rc!=SQLITE_OK ){
  153055. goto splitnode_out;
  153056. }
  153057. }
  153058. }else if( newCellIsRight==0 ){
  153059. rc = updateMapping(pRtree, pCell->iRowid, pLeft, iHeight);
  153060. }
  153061. if( rc==SQLITE_OK ){
  153062. rc = nodeRelease(pRtree, pRight);
  153063. pRight = 0;
  153064. }
  153065. if( rc==SQLITE_OK ){
  153066. rc = nodeRelease(pRtree, pLeft);
  153067. pLeft = 0;
  153068. }
  153069. splitnode_out:
  153070. nodeRelease(pRtree, pRight);
  153071. nodeRelease(pRtree, pLeft);
  153072. sqlite3_free(aCell);
  153073. return rc;
  153074. }
  153075. /*
  153076. ** If node pLeaf is not the root of the r-tree and its pParent pointer is
  153077. ** still NULL, load all ancestor nodes of pLeaf into memory and populate
  153078. ** the pLeaf->pParent chain all the way up to the root node.
  153079. **
  153080. ** This operation is required when a row is deleted (or updated - an update
  153081. ** is implemented as a delete followed by an insert). SQLite provides the
  153082. ** rowid of the row to delete, which can be used to find the leaf on which
  153083. ** the entry resides (argument pLeaf). Once the leaf is located, this
  153084. ** function is called to determine its ancestry.
  153085. */
  153086. static int fixLeafParent(Rtree *pRtree, RtreeNode *pLeaf){
  153087. int rc = SQLITE_OK;
  153088. RtreeNode *pChild = pLeaf;
  153089. while( rc==SQLITE_OK && pChild->iNode!=1 && pChild->pParent==0 ){
  153090. int rc2 = SQLITE_OK; /* sqlite3_reset() return code */
  153091. sqlite3_bind_int64(pRtree->pReadParent, 1, pChild->iNode);
  153092. rc = sqlite3_step(pRtree->pReadParent);
  153093. if( rc==SQLITE_ROW ){
  153094. RtreeNode *pTest; /* Used to test for reference loops */
  153095. i64 iNode; /* Node number of parent node */
  153096. /* Before setting pChild->pParent, test that we are not creating a
  153097. ** loop of references (as we would if, say, pChild==pParent). We don't
  153098. ** want to do this as it leads to a memory leak when trying to delete
  153099. ** the referenced counted node structures.
  153100. */
  153101. iNode = sqlite3_column_int64(pRtree->pReadParent, 0);
  153102. for(pTest=pLeaf; pTest && pTest->iNode!=iNode; pTest=pTest->pParent);
  153103. if( !pTest ){
  153104. rc2 = nodeAcquire(pRtree, iNode, 0, &pChild->pParent);
  153105. }
  153106. }
  153107. rc = sqlite3_reset(pRtree->pReadParent);
  153108. if( rc==SQLITE_OK ) rc = rc2;
  153109. if( rc==SQLITE_OK && !pChild->pParent ) rc = SQLITE_CORRUPT_VTAB;
  153110. pChild = pChild->pParent;
  153111. }
  153112. return rc;
  153113. }
  153114. static int deleteCell(Rtree *, RtreeNode *, int, int);
  153115. static int removeNode(Rtree *pRtree, RtreeNode *pNode, int iHeight){
  153116. int rc;
  153117. int rc2;
  153118. RtreeNode *pParent = 0;
  153119. int iCell;
  153120. assert( pNode->nRef==1 );
  153121. /* Remove the entry in the parent cell. */
  153122. rc = nodeParentIndex(pRtree, pNode, &iCell);
  153123. if( rc==SQLITE_OK ){
  153124. pParent = pNode->pParent;
  153125. pNode->pParent = 0;
  153126. rc = deleteCell(pRtree, pParent, iCell, iHeight+1);
  153127. }
  153128. rc2 = nodeRelease(pRtree, pParent);
  153129. if( rc==SQLITE_OK ){
  153130. rc = rc2;
  153131. }
  153132. if( rc!=SQLITE_OK ){
  153133. return rc;
  153134. }
  153135. /* Remove the xxx_node entry. */
  153136. sqlite3_bind_int64(pRtree->pDeleteNode, 1, pNode->iNode);
  153137. sqlite3_step(pRtree->pDeleteNode);
  153138. if( SQLITE_OK!=(rc = sqlite3_reset(pRtree->pDeleteNode)) ){
  153139. return rc;
  153140. }
  153141. /* Remove the xxx_parent entry. */
  153142. sqlite3_bind_int64(pRtree->pDeleteParent, 1, pNode->iNode);
  153143. sqlite3_step(pRtree->pDeleteParent);
  153144. if( SQLITE_OK!=(rc = sqlite3_reset(pRtree->pDeleteParent)) ){
  153145. return rc;
  153146. }
  153147. /* Remove the node from the in-memory hash table and link it into
  153148. ** the Rtree.pDeleted list. Its contents will be re-inserted later on.
  153149. */
  153150. nodeHashDelete(pRtree, pNode);
  153151. pNode->iNode = iHeight;
  153152. pNode->pNext = pRtree->pDeleted;
  153153. pNode->nRef++;
  153154. pRtree->pDeleted = pNode;
  153155. return SQLITE_OK;
  153156. }
  153157. static int fixBoundingBox(Rtree *pRtree, RtreeNode *pNode){
  153158. RtreeNode *pParent = pNode->pParent;
  153159. int rc = SQLITE_OK;
  153160. if( pParent ){
  153161. int ii;
  153162. int nCell = NCELL(pNode);
  153163. RtreeCell box; /* Bounding box for pNode */
  153164. nodeGetCell(pRtree, pNode, 0, &box);
  153165. for(ii=1; ii<nCell; ii++){
  153166. RtreeCell cell;
  153167. nodeGetCell(pRtree, pNode, ii, &cell);
  153168. cellUnion(pRtree, &box, &cell);
  153169. }
  153170. box.iRowid = pNode->iNode;
  153171. rc = nodeParentIndex(pRtree, pNode, &ii);
  153172. if( rc==SQLITE_OK ){
  153173. nodeOverwriteCell(pRtree, pParent, &box, ii);
  153174. rc = fixBoundingBox(pRtree, pParent);
  153175. }
  153176. }
  153177. return rc;
  153178. }
  153179. /*
  153180. ** Delete the cell at index iCell of node pNode. After removing the
  153181. ** cell, adjust the r-tree data structure if required.
  153182. */
  153183. static int deleteCell(Rtree *pRtree, RtreeNode *pNode, int iCell, int iHeight){
  153184. RtreeNode *pParent;
  153185. int rc;
  153186. if( SQLITE_OK!=(rc = fixLeafParent(pRtree, pNode)) ){
  153187. return rc;
  153188. }
  153189. /* Remove the cell from the node. This call just moves bytes around
  153190. ** the in-memory node image, so it cannot fail.
  153191. */
  153192. nodeDeleteCell(pRtree, pNode, iCell);
  153193. /* If the node is not the tree root and now has less than the minimum
  153194. ** number of cells, remove it from the tree. Otherwise, update the
  153195. ** cell in the parent node so that it tightly contains the updated
  153196. ** node.
  153197. */
  153198. pParent = pNode->pParent;
  153199. assert( pParent || pNode->iNode==1 );
  153200. if( pParent ){
  153201. if( NCELL(pNode)<RTREE_MINCELLS(pRtree) ){
  153202. rc = removeNode(pRtree, pNode, iHeight);
  153203. }else{
  153204. rc = fixBoundingBox(pRtree, pNode);
  153205. }
  153206. }
  153207. return rc;
  153208. }
  153209. static int Reinsert(
  153210. Rtree *pRtree,
  153211. RtreeNode *pNode,
  153212. RtreeCell *pCell,
  153213. int iHeight
  153214. ){
  153215. int *aOrder;
  153216. int *aSpare;
  153217. RtreeCell *aCell;
  153218. RtreeDValue *aDistance;
  153219. int nCell;
  153220. RtreeDValue aCenterCoord[RTREE_MAX_DIMENSIONS];
  153221. int iDim;
  153222. int ii;
  153223. int rc = SQLITE_OK;
  153224. int n;
  153225. memset(aCenterCoord, 0, sizeof(RtreeDValue)*RTREE_MAX_DIMENSIONS);
  153226. nCell = NCELL(pNode)+1;
  153227. n = (nCell+1)&(~1);
  153228. /* Allocate the buffers used by this operation. The allocation is
  153229. ** relinquished before this function returns.
  153230. */
  153231. aCell = (RtreeCell *)sqlite3_malloc(n * (
  153232. sizeof(RtreeCell) + /* aCell array */
  153233. sizeof(int) + /* aOrder array */
  153234. sizeof(int) + /* aSpare array */
  153235. sizeof(RtreeDValue) /* aDistance array */
  153236. ));
  153237. if( !aCell ){
  153238. return SQLITE_NOMEM;
  153239. }
  153240. aOrder = (int *)&aCell[n];
  153241. aSpare = (int *)&aOrder[n];
  153242. aDistance = (RtreeDValue *)&aSpare[n];
  153243. for(ii=0; ii<nCell; ii++){
  153244. if( ii==(nCell-1) ){
  153245. memcpy(&aCell[ii], pCell, sizeof(RtreeCell));
  153246. }else{
  153247. nodeGetCell(pRtree, pNode, ii, &aCell[ii]);
  153248. }
  153249. aOrder[ii] = ii;
  153250. for(iDim=0; iDim<pRtree->nDim; iDim++){
  153251. aCenterCoord[iDim] += DCOORD(aCell[ii].aCoord[iDim*2]);
  153252. aCenterCoord[iDim] += DCOORD(aCell[ii].aCoord[iDim*2+1]);
  153253. }
  153254. }
  153255. for(iDim=0; iDim<pRtree->nDim; iDim++){
  153256. aCenterCoord[iDim] = (aCenterCoord[iDim]/(nCell*(RtreeDValue)2));
  153257. }
  153258. for(ii=0; ii<nCell; ii++){
  153259. aDistance[ii] = RTREE_ZERO;
  153260. for(iDim=0; iDim<pRtree->nDim; iDim++){
  153261. RtreeDValue coord = (DCOORD(aCell[ii].aCoord[iDim*2+1]) -
  153262. DCOORD(aCell[ii].aCoord[iDim*2]));
  153263. aDistance[ii] += (coord-aCenterCoord[iDim])*(coord-aCenterCoord[iDim]);
  153264. }
  153265. }
  153266. SortByDistance(aOrder, nCell, aDistance, aSpare);
  153267. nodeZero(pRtree, pNode);
  153268. for(ii=0; rc==SQLITE_OK && ii<(nCell-(RTREE_MINCELLS(pRtree)+1)); ii++){
  153269. RtreeCell *p = &aCell[aOrder[ii]];
  153270. nodeInsertCell(pRtree, pNode, p);
  153271. if( p->iRowid==pCell->iRowid ){
  153272. if( iHeight==0 ){
  153273. rc = rowidWrite(pRtree, p->iRowid, pNode->iNode);
  153274. }else{
  153275. rc = parentWrite(pRtree, p->iRowid, pNode->iNode);
  153276. }
  153277. }
  153278. }
  153279. if( rc==SQLITE_OK ){
  153280. rc = fixBoundingBox(pRtree, pNode);
  153281. }
  153282. for(; rc==SQLITE_OK && ii<nCell; ii++){
  153283. /* Find a node to store this cell in. pNode->iNode currently contains
  153284. ** the height of the sub-tree headed by the cell.
  153285. */
  153286. RtreeNode *pInsert;
  153287. RtreeCell *p = &aCell[aOrder[ii]];
  153288. rc = ChooseLeaf(pRtree, p, iHeight, &pInsert);
  153289. if( rc==SQLITE_OK ){
  153290. int rc2;
  153291. rc = rtreeInsertCell(pRtree, pInsert, p, iHeight);
  153292. rc2 = nodeRelease(pRtree, pInsert);
  153293. if( rc==SQLITE_OK ){
  153294. rc = rc2;
  153295. }
  153296. }
  153297. }
  153298. sqlite3_free(aCell);
  153299. return rc;
  153300. }
  153301. /*
  153302. ** Insert cell pCell into node pNode. Node pNode is the head of a
  153303. ** subtree iHeight high (leaf nodes have iHeight==0).
  153304. */
  153305. static int rtreeInsertCell(
  153306. Rtree *pRtree,
  153307. RtreeNode *pNode,
  153308. RtreeCell *pCell,
  153309. int iHeight
  153310. ){
  153311. int rc = SQLITE_OK;
  153312. if( iHeight>0 ){
  153313. RtreeNode *pChild = nodeHashLookup(pRtree, pCell->iRowid);
  153314. if( pChild ){
  153315. nodeRelease(pRtree, pChild->pParent);
  153316. nodeReference(pNode);
  153317. pChild->pParent = pNode;
  153318. }
  153319. }
  153320. if( nodeInsertCell(pRtree, pNode, pCell) ){
  153321. if( iHeight<=pRtree->iReinsertHeight || pNode->iNode==1){
  153322. rc = SplitNode(pRtree, pNode, pCell, iHeight);
  153323. }else{
  153324. pRtree->iReinsertHeight = iHeight;
  153325. rc = Reinsert(pRtree, pNode, pCell, iHeight);
  153326. }
  153327. }else{
  153328. rc = AdjustTree(pRtree, pNode, pCell);
  153329. if( rc==SQLITE_OK ){
  153330. if( iHeight==0 ){
  153331. rc = rowidWrite(pRtree, pCell->iRowid, pNode->iNode);
  153332. }else{
  153333. rc = parentWrite(pRtree, pCell->iRowid, pNode->iNode);
  153334. }
  153335. }
  153336. }
  153337. return rc;
  153338. }
  153339. static int reinsertNodeContent(Rtree *pRtree, RtreeNode *pNode){
  153340. int ii;
  153341. int rc = SQLITE_OK;
  153342. int nCell = NCELL(pNode);
  153343. for(ii=0; rc==SQLITE_OK && ii<nCell; ii++){
  153344. RtreeNode *pInsert;
  153345. RtreeCell cell;
  153346. nodeGetCell(pRtree, pNode, ii, &cell);
  153347. /* Find a node to store this cell in. pNode->iNode currently contains
  153348. ** the height of the sub-tree headed by the cell.
  153349. */
  153350. rc = ChooseLeaf(pRtree, &cell, (int)pNode->iNode, &pInsert);
  153351. if( rc==SQLITE_OK ){
  153352. int rc2;
  153353. rc = rtreeInsertCell(pRtree, pInsert, &cell, (int)pNode->iNode);
  153354. rc2 = nodeRelease(pRtree, pInsert);
  153355. if( rc==SQLITE_OK ){
  153356. rc = rc2;
  153357. }
  153358. }
  153359. }
  153360. return rc;
  153361. }
  153362. /*
  153363. ** Select a currently unused rowid for a new r-tree record.
  153364. */
  153365. static int newRowid(Rtree *pRtree, i64 *piRowid){
  153366. int rc;
  153367. sqlite3_bind_null(pRtree->pWriteRowid, 1);
  153368. sqlite3_bind_null(pRtree->pWriteRowid, 2);
  153369. sqlite3_step(pRtree->pWriteRowid);
  153370. rc = sqlite3_reset(pRtree->pWriteRowid);
  153371. *piRowid = sqlite3_last_insert_rowid(pRtree->db);
  153372. return rc;
  153373. }
  153374. /*
  153375. ** Remove the entry with rowid=iDelete from the r-tree structure.
  153376. */
  153377. static int rtreeDeleteRowid(Rtree *pRtree, sqlite3_int64 iDelete){
  153378. int rc; /* Return code */
  153379. RtreeNode *pLeaf = 0; /* Leaf node containing record iDelete */
  153380. int iCell; /* Index of iDelete cell in pLeaf */
  153381. RtreeNode *pRoot; /* Root node of rtree structure */
  153382. /* Obtain a reference to the root node to initialize Rtree.iDepth */
  153383. rc = nodeAcquire(pRtree, 1, 0, &pRoot);
  153384. /* Obtain a reference to the leaf node that contains the entry
  153385. ** about to be deleted.
  153386. */
  153387. if( rc==SQLITE_OK ){
  153388. rc = findLeafNode(pRtree, iDelete, &pLeaf, 0);
  153389. }
  153390. /* Delete the cell in question from the leaf node. */
  153391. if( rc==SQLITE_OK ){
  153392. int rc2;
  153393. rc = nodeRowidIndex(pRtree, pLeaf, iDelete, &iCell);
  153394. if( rc==SQLITE_OK ){
  153395. rc = deleteCell(pRtree, pLeaf, iCell, 0);
  153396. }
  153397. rc2 = nodeRelease(pRtree, pLeaf);
  153398. if( rc==SQLITE_OK ){
  153399. rc = rc2;
  153400. }
  153401. }
  153402. /* Delete the corresponding entry in the <rtree>_rowid table. */
  153403. if( rc==SQLITE_OK ){
  153404. sqlite3_bind_int64(pRtree->pDeleteRowid, 1, iDelete);
  153405. sqlite3_step(pRtree->pDeleteRowid);
  153406. rc = sqlite3_reset(pRtree->pDeleteRowid);
  153407. }
  153408. /* Check if the root node now has exactly one child. If so, remove
  153409. ** it, schedule the contents of the child for reinsertion and
  153410. ** reduce the tree height by one.
  153411. **
  153412. ** This is equivalent to copying the contents of the child into
  153413. ** the root node (the operation that Gutman's paper says to perform
  153414. ** in this scenario).
  153415. */
  153416. if( rc==SQLITE_OK && pRtree->iDepth>0 && NCELL(pRoot)==1 ){
  153417. int rc2;
  153418. RtreeNode *pChild;
  153419. i64 iChild = nodeGetRowid(pRtree, pRoot, 0);
  153420. rc = nodeAcquire(pRtree, iChild, pRoot, &pChild);
  153421. if( rc==SQLITE_OK ){
  153422. rc = removeNode(pRtree, pChild, pRtree->iDepth-1);
  153423. }
  153424. rc2 = nodeRelease(pRtree, pChild);
  153425. if( rc==SQLITE_OK ) rc = rc2;
  153426. if( rc==SQLITE_OK ){
  153427. pRtree->iDepth--;
  153428. writeInt16(pRoot->zData, pRtree->iDepth);
  153429. pRoot->isDirty = 1;
  153430. }
  153431. }
  153432. /* Re-insert the contents of any underfull nodes removed from the tree. */
  153433. for(pLeaf=pRtree->pDeleted; pLeaf; pLeaf=pRtree->pDeleted){
  153434. if( rc==SQLITE_OK ){
  153435. rc = reinsertNodeContent(pRtree, pLeaf);
  153436. }
  153437. pRtree->pDeleted = pLeaf->pNext;
  153438. sqlite3_free(pLeaf);
  153439. }
  153440. /* Release the reference to the root node. */
  153441. if( rc==SQLITE_OK ){
  153442. rc = nodeRelease(pRtree, pRoot);
  153443. }else{
  153444. nodeRelease(pRtree, pRoot);
  153445. }
  153446. return rc;
  153447. }
  153448. /*
  153449. ** Rounding constants for float->double conversion.
  153450. */
  153451. #define RNDTOWARDS (1.0 - 1.0/8388608.0) /* Round towards zero */
  153452. #define RNDAWAY (1.0 + 1.0/8388608.0) /* Round away from zero */
  153453. #if !defined(SQLITE_RTREE_INT_ONLY)
  153454. /*
  153455. ** Convert an sqlite3_value into an RtreeValue (presumably a float)
  153456. ** while taking care to round toward negative or positive, respectively.
  153457. */
  153458. static RtreeValue rtreeValueDown(sqlite3_value *v){
  153459. double d = sqlite3_value_double(v);
  153460. float f = (float)d;
  153461. if( f>d ){
  153462. f = (float)(d*(d<0 ? RNDAWAY : RNDTOWARDS));
  153463. }
  153464. return f;
  153465. }
  153466. static RtreeValue rtreeValueUp(sqlite3_value *v){
  153467. double d = sqlite3_value_double(v);
  153468. float f = (float)d;
  153469. if( f<d ){
  153470. f = (float)(d*(d<0 ? RNDTOWARDS : RNDAWAY));
  153471. }
  153472. return f;
  153473. }
  153474. #endif /* !defined(SQLITE_RTREE_INT_ONLY) */
  153475. /*
  153476. ** A constraint has failed while inserting a row into an rtree table.
  153477. ** Assuming no OOM error occurs, this function sets the error message
  153478. ** (at pRtree->base.zErrMsg) to an appropriate value and returns
  153479. ** SQLITE_CONSTRAINT.
  153480. **
  153481. ** Parameter iCol is the index of the leftmost column involved in the
  153482. ** constraint failure. If it is 0, then the constraint that failed is
  153483. ** the unique constraint on the id column. Otherwise, it is the rtree
  153484. ** (c1<=c2) constraint on columns iCol and iCol+1 that has failed.
  153485. **
  153486. ** If an OOM occurs, SQLITE_NOMEM is returned instead of SQLITE_CONSTRAINT.
  153487. */
  153488. static int rtreeConstraintError(Rtree *pRtree, int iCol){
  153489. sqlite3_stmt *pStmt = 0;
  153490. char *zSql;
  153491. int rc;
  153492. assert( iCol==0 || iCol%2 );
  153493. zSql = sqlite3_mprintf("SELECT * FROM %Q.%Q", pRtree->zDb, pRtree->zName);
  153494. if( zSql ){
  153495. rc = sqlite3_prepare_v2(pRtree->db, zSql, -1, &pStmt, 0);
  153496. }else{
  153497. rc = SQLITE_NOMEM;
  153498. }
  153499. sqlite3_free(zSql);
  153500. if( rc==SQLITE_OK ){
  153501. if( iCol==0 ){
  153502. const char *zCol = sqlite3_column_name(pStmt, 0);
  153503. pRtree->base.zErrMsg = sqlite3_mprintf(
  153504. "UNIQUE constraint failed: %s.%s", pRtree->zName, zCol
  153505. );
  153506. }else{
  153507. const char *zCol1 = sqlite3_column_name(pStmt, iCol);
  153508. const char *zCol2 = sqlite3_column_name(pStmt, iCol+1);
  153509. pRtree->base.zErrMsg = sqlite3_mprintf(
  153510. "rtree constraint failed: %s.(%s<=%s)", pRtree->zName, zCol1, zCol2
  153511. );
  153512. }
  153513. }
  153514. sqlite3_finalize(pStmt);
  153515. return (rc==SQLITE_OK ? SQLITE_CONSTRAINT : rc);
  153516. }
  153517. /*
  153518. ** The xUpdate method for rtree module virtual tables.
  153519. */
  153520. static int rtreeUpdate(
  153521. sqlite3_vtab *pVtab,
  153522. int nData,
  153523. sqlite3_value **azData,
  153524. sqlite_int64 *pRowid
  153525. ){
  153526. Rtree *pRtree = (Rtree *)pVtab;
  153527. int rc = SQLITE_OK;
  153528. RtreeCell cell; /* New cell to insert if nData>1 */
  153529. int bHaveRowid = 0; /* Set to 1 after new rowid is determined */
  153530. rtreeReference(pRtree);
  153531. assert(nData>=1);
  153532. cell.iRowid = 0; /* Used only to suppress a compiler warning */
  153533. /* Constraint handling. A write operation on an r-tree table may return
  153534. ** SQLITE_CONSTRAINT for two reasons:
  153535. **
  153536. ** 1. A duplicate rowid value, or
  153537. ** 2. The supplied data violates the "x2>=x1" constraint.
  153538. **
  153539. ** In the first case, if the conflict-handling mode is REPLACE, then
  153540. ** the conflicting row can be removed before proceeding. In the second
  153541. ** case, SQLITE_CONSTRAINT must be returned regardless of the
  153542. ** conflict-handling mode specified by the user.
  153543. */
  153544. if( nData>1 ){
  153545. int ii;
  153546. /* Populate the cell.aCoord[] array. The first coordinate is azData[3].
  153547. **
  153548. ** NB: nData can only be less than nDim*2+3 if the rtree is mis-declared
  153549. ** with "column" that are interpreted as table constraints.
  153550. ** Example: CREATE VIRTUAL TABLE bad USING rtree(x,y,CHECK(y>5));
  153551. ** This problem was discovered after years of use, so we silently ignore
  153552. ** these kinds of misdeclared tables to avoid breaking any legacy.
  153553. */
  153554. assert( nData<=(pRtree->nDim*2 + 3) );
  153555. #ifndef SQLITE_RTREE_INT_ONLY
  153556. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  153557. for(ii=0; ii<nData-4; ii+=2){
  153558. cell.aCoord[ii].f = rtreeValueDown(azData[ii+3]);
  153559. cell.aCoord[ii+1].f = rtreeValueUp(azData[ii+4]);
  153560. if( cell.aCoord[ii].f>cell.aCoord[ii+1].f ){
  153561. rc = rtreeConstraintError(pRtree, ii+1);
  153562. goto constraint;
  153563. }
  153564. }
  153565. }else
  153566. #endif
  153567. {
  153568. for(ii=0; ii<nData-4; ii+=2){
  153569. cell.aCoord[ii].i = sqlite3_value_int(azData[ii+3]);
  153570. cell.aCoord[ii+1].i = sqlite3_value_int(azData[ii+4]);
  153571. if( cell.aCoord[ii].i>cell.aCoord[ii+1].i ){
  153572. rc = rtreeConstraintError(pRtree, ii+1);
  153573. goto constraint;
  153574. }
  153575. }
  153576. }
  153577. /* If a rowid value was supplied, check if it is already present in
  153578. ** the table. If so, the constraint has failed. */
  153579. if( sqlite3_value_type(azData[2])!=SQLITE_NULL ){
  153580. cell.iRowid = sqlite3_value_int64(azData[2]);
  153581. if( sqlite3_value_type(azData[0])==SQLITE_NULL
  153582. || sqlite3_value_int64(azData[0])!=cell.iRowid
  153583. ){
  153584. int steprc;
  153585. sqlite3_bind_int64(pRtree->pReadRowid, 1, cell.iRowid);
  153586. steprc = sqlite3_step(pRtree->pReadRowid);
  153587. rc = sqlite3_reset(pRtree->pReadRowid);
  153588. if( SQLITE_ROW==steprc ){
  153589. if( sqlite3_vtab_on_conflict(pRtree->db)==SQLITE_REPLACE ){
  153590. rc = rtreeDeleteRowid(pRtree, cell.iRowid);
  153591. }else{
  153592. rc = rtreeConstraintError(pRtree, 0);
  153593. goto constraint;
  153594. }
  153595. }
  153596. }
  153597. bHaveRowid = 1;
  153598. }
  153599. }
  153600. /* If azData[0] is not an SQL NULL value, it is the rowid of a
  153601. ** record to delete from the r-tree table. The following block does
  153602. ** just that.
  153603. */
  153604. if( sqlite3_value_type(azData[0])!=SQLITE_NULL ){
  153605. rc = rtreeDeleteRowid(pRtree, sqlite3_value_int64(azData[0]));
  153606. }
  153607. /* If the azData[] array contains more than one element, elements
  153608. ** (azData[2]..azData[argc-1]) contain a new record to insert into
  153609. ** the r-tree structure.
  153610. */
  153611. if( rc==SQLITE_OK && nData>1 ){
  153612. /* Insert the new record into the r-tree */
  153613. RtreeNode *pLeaf = 0;
  153614. /* Figure out the rowid of the new row. */
  153615. if( bHaveRowid==0 ){
  153616. rc = newRowid(pRtree, &cell.iRowid);
  153617. }
  153618. *pRowid = cell.iRowid;
  153619. if( rc==SQLITE_OK ){
  153620. rc = ChooseLeaf(pRtree, &cell, 0, &pLeaf);
  153621. }
  153622. if( rc==SQLITE_OK ){
  153623. int rc2;
  153624. pRtree->iReinsertHeight = -1;
  153625. rc = rtreeInsertCell(pRtree, pLeaf, &cell, 0);
  153626. rc2 = nodeRelease(pRtree, pLeaf);
  153627. if( rc==SQLITE_OK ){
  153628. rc = rc2;
  153629. }
  153630. }
  153631. }
  153632. constraint:
  153633. rtreeRelease(pRtree);
  153634. return rc;
  153635. }
  153636. /*
  153637. ** The xRename method for rtree module virtual tables.
  153638. */
  153639. static int rtreeRename(sqlite3_vtab *pVtab, const char *zNewName){
  153640. Rtree *pRtree = (Rtree *)pVtab;
  153641. int rc = SQLITE_NOMEM;
  153642. char *zSql = sqlite3_mprintf(
  153643. "ALTER TABLE %Q.'%q_node' RENAME TO \"%w_node\";"
  153644. "ALTER TABLE %Q.'%q_parent' RENAME TO \"%w_parent\";"
  153645. "ALTER TABLE %Q.'%q_rowid' RENAME TO \"%w_rowid\";"
  153646. , pRtree->zDb, pRtree->zName, zNewName
  153647. , pRtree->zDb, pRtree->zName, zNewName
  153648. , pRtree->zDb, pRtree->zName, zNewName
  153649. );
  153650. if( zSql ){
  153651. rc = sqlite3_exec(pRtree->db, zSql, 0, 0, 0);
  153652. sqlite3_free(zSql);
  153653. }
  153654. return rc;
  153655. }
  153656. /*
  153657. ** This function populates the pRtree->nRowEst variable with an estimate
  153658. ** of the number of rows in the virtual table. If possible, this is based
  153659. ** on sqlite_stat1 data. Otherwise, use RTREE_DEFAULT_ROWEST.
  153660. */
  153661. static int rtreeQueryStat1(sqlite3 *db, Rtree *pRtree){
  153662. const char *zFmt = "SELECT stat FROM %Q.sqlite_stat1 WHERE tbl = '%q_rowid'";
  153663. char *zSql;
  153664. sqlite3_stmt *p;
  153665. int rc;
  153666. i64 nRow = 0;
  153667. rc = sqlite3_table_column_metadata(
  153668. db, pRtree->zDb, "sqlite_stat1",0,0,0,0,0,0
  153669. );
  153670. if( rc!=SQLITE_OK ){
  153671. pRtree->nRowEst = RTREE_DEFAULT_ROWEST;
  153672. return rc==SQLITE_ERROR ? SQLITE_OK : rc;
  153673. }
  153674. zSql = sqlite3_mprintf(zFmt, pRtree->zDb, pRtree->zName);
  153675. if( zSql==0 ){
  153676. rc = SQLITE_NOMEM;
  153677. }else{
  153678. rc = sqlite3_prepare_v2(db, zSql, -1, &p, 0);
  153679. if( rc==SQLITE_OK ){
  153680. if( sqlite3_step(p)==SQLITE_ROW ) nRow = sqlite3_column_int64(p, 0);
  153681. rc = sqlite3_finalize(p);
  153682. }else if( rc!=SQLITE_NOMEM ){
  153683. rc = SQLITE_OK;
  153684. }
  153685. if( rc==SQLITE_OK ){
  153686. if( nRow==0 ){
  153687. pRtree->nRowEst = RTREE_DEFAULT_ROWEST;
  153688. }else{
  153689. pRtree->nRowEst = MAX(nRow, RTREE_MIN_ROWEST);
  153690. }
  153691. }
  153692. sqlite3_free(zSql);
  153693. }
  153694. return rc;
  153695. }
  153696. static sqlite3_module rtreeModule = {
  153697. 0, /* iVersion */
  153698. rtreeCreate, /* xCreate - create a table */
  153699. rtreeConnect, /* xConnect - connect to an existing table */
  153700. rtreeBestIndex, /* xBestIndex - Determine search strategy */
  153701. rtreeDisconnect, /* xDisconnect - Disconnect from a table */
  153702. rtreeDestroy, /* xDestroy - Drop a table */
  153703. rtreeOpen, /* xOpen - open a cursor */
  153704. rtreeClose, /* xClose - close a cursor */
  153705. rtreeFilter, /* xFilter - configure scan constraints */
  153706. rtreeNext, /* xNext - advance a cursor */
  153707. rtreeEof, /* xEof */
  153708. rtreeColumn, /* xColumn - read data */
  153709. rtreeRowid, /* xRowid - read data */
  153710. rtreeUpdate, /* xUpdate - write data */
  153711. 0, /* xBegin - begin transaction */
  153712. 0, /* xSync - sync transaction */
  153713. 0, /* xCommit - commit transaction */
  153714. 0, /* xRollback - rollback transaction */
  153715. 0, /* xFindFunction - function overloading */
  153716. rtreeRename, /* xRename - rename the table */
  153717. 0, /* xSavepoint */
  153718. 0, /* xRelease */
  153719. 0 /* xRollbackTo */
  153720. };
  153721. static int rtreeSqlInit(
  153722. Rtree *pRtree,
  153723. sqlite3 *db,
  153724. const char *zDb,
  153725. const char *zPrefix,
  153726. int isCreate
  153727. ){
  153728. int rc = SQLITE_OK;
  153729. #define N_STATEMENT 9
  153730. static const char *azSql[N_STATEMENT] = {
  153731. /* Read and write the xxx_node table */
  153732. "SELECT data FROM '%q'.'%q_node' WHERE nodeno = :1",
  153733. "INSERT OR REPLACE INTO '%q'.'%q_node' VALUES(:1, :2)",
  153734. "DELETE FROM '%q'.'%q_node' WHERE nodeno = :1",
  153735. /* Read and write the xxx_rowid table */
  153736. "SELECT nodeno FROM '%q'.'%q_rowid' WHERE rowid = :1",
  153737. "INSERT OR REPLACE INTO '%q'.'%q_rowid' VALUES(:1, :2)",
  153738. "DELETE FROM '%q'.'%q_rowid' WHERE rowid = :1",
  153739. /* Read and write the xxx_parent table */
  153740. "SELECT parentnode FROM '%q'.'%q_parent' WHERE nodeno = :1",
  153741. "INSERT OR REPLACE INTO '%q'.'%q_parent' VALUES(:1, :2)",
  153742. "DELETE FROM '%q'.'%q_parent' WHERE nodeno = :1"
  153743. };
  153744. sqlite3_stmt **appStmt[N_STATEMENT];
  153745. int i;
  153746. pRtree->db = db;
  153747. if( isCreate ){
  153748. char *zCreate = sqlite3_mprintf(
  153749. "CREATE TABLE \"%w\".\"%w_node\"(nodeno INTEGER PRIMARY KEY, data BLOB);"
  153750. "CREATE TABLE \"%w\".\"%w_rowid\"(rowid INTEGER PRIMARY KEY, nodeno INTEGER);"
  153751. "CREATE TABLE \"%w\".\"%w_parent\"(nodeno INTEGER PRIMARY KEY,"
  153752. " parentnode INTEGER);"
  153753. "INSERT INTO '%q'.'%q_node' VALUES(1, zeroblob(%d))",
  153754. zDb, zPrefix, zDb, zPrefix, zDb, zPrefix, zDb, zPrefix, pRtree->iNodeSize
  153755. );
  153756. if( !zCreate ){
  153757. return SQLITE_NOMEM;
  153758. }
  153759. rc = sqlite3_exec(db, zCreate, 0, 0, 0);
  153760. sqlite3_free(zCreate);
  153761. if( rc!=SQLITE_OK ){
  153762. return rc;
  153763. }
  153764. }
  153765. appStmt[0] = &pRtree->pReadNode;
  153766. appStmt[1] = &pRtree->pWriteNode;
  153767. appStmt[2] = &pRtree->pDeleteNode;
  153768. appStmt[3] = &pRtree->pReadRowid;
  153769. appStmt[4] = &pRtree->pWriteRowid;
  153770. appStmt[5] = &pRtree->pDeleteRowid;
  153771. appStmt[6] = &pRtree->pReadParent;
  153772. appStmt[7] = &pRtree->pWriteParent;
  153773. appStmt[8] = &pRtree->pDeleteParent;
  153774. rc = rtreeQueryStat1(db, pRtree);
  153775. for(i=0; i<N_STATEMENT && rc==SQLITE_OK; i++){
  153776. char *zSql = sqlite3_mprintf(azSql[i], zDb, zPrefix);
  153777. if( zSql ){
  153778. rc = sqlite3_prepare_v2(db, zSql, -1, appStmt[i], 0);
  153779. }else{
  153780. rc = SQLITE_NOMEM;
  153781. }
  153782. sqlite3_free(zSql);
  153783. }
  153784. return rc;
  153785. }
  153786. /*
  153787. ** The second argument to this function contains the text of an SQL statement
  153788. ** that returns a single integer value. The statement is compiled and executed
  153789. ** using database connection db. If successful, the integer value returned
  153790. ** is written to *piVal and SQLITE_OK returned. Otherwise, an SQLite error
  153791. ** code is returned and the value of *piVal after returning is not defined.
  153792. */
  153793. static int getIntFromStmt(sqlite3 *db, const char *zSql, int *piVal){
  153794. int rc = SQLITE_NOMEM;
  153795. if( zSql ){
  153796. sqlite3_stmt *pStmt = 0;
  153797. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  153798. if( rc==SQLITE_OK ){
  153799. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  153800. *piVal = sqlite3_column_int(pStmt, 0);
  153801. }
  153802. rc = sqlite3_finalize(pStmt);
  153803. }
  153804. }
  153805. return rc;
  153806. }
  153807. /*
  153808. ** This function is called from within the xConnect() or xCreate() method to
  153809. ** determine the node-size used by the rtree table being created or connected
  153810. ** to. If successful, pRtree->iNodeSize is populated and SQLITE_OK returned.
  153811. ** Otherwise, an SQLite error code is returned.
  153812. **
  153813. ** If this function is being called as part of an xConnect(), then the rtree
  153814. ** table already exists. In this case the node-size is determined by inspecting
  153815. ** the root node of the tree.
  153816. **
  153817. ** Otherwise, for an xCreate(), use 64 bytes less than the database page-size.
  153818. ** This ensures that each node is stored on a single database page. If the
  153819. ** database page-size is so large that more than RTREE_MAXCELLS entries
  153820. ** would fit in a single node, use a smaller node-size.
  153821. */
  153822. static int getNodeSize(
  153823. sqlite3 *db, /* Database handle */
  153824. Rtree *pRtree, /* Rtree handle */
  153825. int isCreate, /* True for xCreate, false for xConnect */
  153826. char **pzErr /* OUT: Error message, if any */
  153827. ){
  153828. int rc;
  153829. char *zSql;
  153830. if( isCreate ){
  153831. int iPageSize = 0;
  153832. zSql = sqlite3_mprintf("PRAGMA %Q.page_size", pRtree->zDb);
  153833. rc = getIntFromStmt(db, zSql, &iPageSize);
  153834. if( rc==SQLITE_OK ){
  153835. pRtree->iNodeSize = iPageSize-64;
  153836. if( (4+pRtree->nBytesPerCell*RTREE_MAXCELLS)<pRtree->iNodeSize ){
  153837. pRtree->iNodeSize = 4+pRtree->nBytesPerCell*RTREE_MAXCELLS;
  153838. }
  153839. }else{
  153840. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  153841. }
  153842. }else{
  153843. zSql = sqlite3_mprintf(
  153844. "SELECT length(data) FROM '%q'.'%q_node' WHERE nodeno = 1",
  153845. pRtree->zDb, pRtree->zName
  153846. );
  153847. rc = getIntFromStmt(db, zSql, &pRtree->iNodeSize);
  153848. if( rc!=SQLITE_OK ){
  153849. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  153850. }
  153851. }
  153852. sqlite3_free(zSql);
  153853. return rc;
  153854. }
  153855. /*
  153856. ** This function is the implementation of both the xConnect and xCreate
  153857. ** methods of the r-tree virtual table.
  153858. **
  153859. ** argv[0] -> module name
  153860. ** argv[1] -> database name
  153861. ** argv[2] -> table name
  153862. ** argv[...] -> column names...
  153863. */
  153864. static int rtreeInit(
  153865. sqlite3 *db, /* Database connection */
  153866. void *pAux, /* One of the RTREE_COORD_* constants */
  153867. int argc, const char *const*argv, /* Parameters to CREATE TABLE statement */
  153868. sqlite3_vtab **ppVtab, /* OUT: New virtual table */
  153869. char **pzErr, /* OUT: Error message, if any */
  153870. int isCreate /* True for xCreate, false for xConnect */
  153871. ){
  153872. int rc = SQLITE_OK;
  153873. Rtree *pRtree;
  153874. int nDb; /* Length of string argv[1] */
  153875. int nName; /* Length of string argv[2] */
  153876. int eCoordType = (pAux ? RTREE_COORD_INT32 : RTREE_COORD_REAL32);
  153877. const char *aErrMsg[] = {
  153878. 0, /* 0 */
  153879. "Wrong number of columns for an rtree table", /* 1 */
  153880. "Too few columns for an rtree table", /* 2 */
  153881. "Too many columns for an rtree table" /* 3 */
  153882. };
  153883. int iErr = (argc<6) ? 2 : argc>(RTREE_MAX_DIMENSIONS*2+4) ? 3 : argc%2;
  153884. if( aErrMsg[iErr] ){
  153885. *pzErr = sqlite3_mprintf("%s", aErrMsg[iErr]);
  153886. return SQLITE_ERROR;
  153887. }
  153888. sqlite3_vtab_config(db, SQLITE_VTAB_CONSTRAINT_SUPPORT, 1);
  153889. /* Allocate the sqlite3_vtab structure */
  153890. nDb = (int)strlen(argv[1]);
  153891. nName = (int)strlen(argv[2]);
  153892. pRtree = (Rtree *)sqlite3_malloc(sizeof(Rtree)+nDb+nName+2);
  153893. if( !pRtree ){
  153894. return SQLITE_NOMEM;
  153895. }
  153896. memset(pRtree, 0, sizeof(Rtree)+nDb+nName+2);
  153897. pRtree->nBusy = 1;
  153898. pRtree->base.pModule = &rtreeModule;
  153899. pRtree->zDb = (char *)&pRtree[1];
  153900. pRtree->zName = &pRtree->zDb[nDb+1];
  153901. pRtree->nDim = (argc-4)/2;
  153902. pRtree->nBytesPerCell = 8 + pRtree->nDim*4*2;
  153903. pRtree->eCoordType = eCoordType;
  153904. memcpy(pRtree->zDb, argv[1], nDb);
  153905. memcpy(pRtree->zName, argv[2], nName);
  153906. /* Figure out the node size to use. */
  153907. rc = getNodeSize(db, pRtree, isCreate, pzErr);
  153908. /* Create/Connect to the underlying relational database schema. If
  153909. ** that is successful, call sqlite3_declare_vtab() to configure
  153910. ** the r-tree table schema.
  153911. */
  153912. if( rc==SQLITE_OK ){
  153913. if( (rc = rtreeSqlInit(pRtree, db, argv[1], argv[2], isCreate)) ){
  153914. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  153915. }else{
  153916. char *zSql = sqlite3_mprintf("CREATE TABLE x(%s", argv[3]);
  153917. char *zTmp;
  153918. int ii;
  153919. for(ii=4; zSql && ii<argc; ii++){
  153920. zTmp = zSql;
  153921. zSql = sqlite3_mprintf("%s, %s", zTmp, argv[ii]);
  153922. sqlite3_free(zTmp);
  153923. }
  153924. if( zSql ){
  153925. zTmp = zSql;
  153926. zSql = sqlite3_mprintf("%s);", zTmp);
  153927. sqlite3_free(zTmp);
  153928. }
  153929. if( !zSql ){
  153930. rc = SQLITE_NOMEM;
  153931. }else if( SQLITE_OK!=(rc = sqlite3_declare_vtab(db, zSql)) ){
  153932. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  153933. }
  153934. sqlite3_free(zSql);
  153935. }
  153936. }
  153937. if( rc==SQLITE_OK ){
  153938. *ppVtab = (sqlite3_vtab *)pRtree;
  153939. }else{
  153940. assert( *ppVtab==0 );
  153941. assert( pRtree->nBusy==1 );
  153942. rtreeRelease(pRtree);
  153943. }
  153944. return rc;
  153945. }
  153946. /*
  153947. ** Implementation of a scalar function that decodes r-tree nodes to
  153948. ** human readable strings. This can be used for debugging and analysis.
  153949. **
  153950. ** The scalar function takes two arguments: (1) the number of dimensions
  153951. ** to the rtree (between 1 and 5, inclusive) and (2) a blob of data containing
  153952. ** an r-tree node. For a two-dimensional r-tree structure called "rt", to
  153953. ** deserialize all nodes, a statement like:
  153954. **
  153955. ** SELECT rtreenode(2, data) FROM rt_node;
  153956. **
  153957. ** The human readable string takes the form of a Tcl list with one
  153958. ** entry for each cell in the r-tree node. Each entry is itself a
  153959. ** list, containing the 8-byte rowid/pageno followed by the
  153960. ** <num-dimension>*2 coordinates.
  153961. */
  153962. static void rtreenode(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
  153963. char *zText = 0;
  153964. RtreeNode node;
  153965. Rtree tree;
  153966. int ii;
  153967. UNUSED_PARAMETER(nArg);
  153968. memset(&node, 0, sizeof(RtreeNode));
  153969. memset(&tree, 0, sizeof(Rtree));
  153970. tree.nDim = sqlite3_value_int(apArg[0]);
  153971. tree.nBytesPerCell = 8 + 8 * tree.nDim;
  153972. node.zData = (u8 *)sqlite3_value_blob(apArg[1]);
  153973. for(ii=0; ii<NCELL(&node); ii++){
  153974. char zCell[512];
  153975. int nCell = 0;
  153976. RtreeCell cell;
  153977. int jj;
  153978. nodeGetCell(&tree, &node, ii, &cell);
  153979. sqlite3_snprintf(512-nCell,&zCell[nCell],"%lld", cell.iRowid);
  153980. nCell = (int)strlen(zCell);
  153981. for(jj=0; jj<tree.nDim*2; jj++){
  153982. #ifndef SQLITE_RTREE_INT_ONLY
  153983. sqlite3_snprintf(512-nCell,&zCell[nCell], " %g",
  153984. (double)cell.aCoord[jj].f);
  153985. #else
  153986. sqlite3_snprintf(512-nCell,&zCell[nCell], " %d",
  153987. cell.aCoord[jj].i);
  153988. #endif
  153989. nCell = (int)strlen(zCell);
  153990. }
  153991. if( zText ){
  153992. char *zTextNew = sqlite3_mprintf("%s {%s}", zText, zCell);
  153993. sqlite3_free(zText);
  153994. zText = zTextNew;
  153995. }else{
  153996. zText = sqlite3_mprintf("{%s}", zCell);
  153997. }
  153998. }
  153999. sqlite3_result_text(ctx, zText, -1, sqlite3_free);
  154000. }
  154001. /* This routine implements an SQL function that returns the "depth" parameter
  154002. ** from the front of a blob that is an r-tree node. For example:
  154003. **
  154004. ** SELECT rtreedepth(data) FROM rt_node WHERE nodeno=1;
  154005. **
  154006. ** The depth value is 0 for all nodes other than the root node, and the root
  154007. ** node always has nodeno=1, so the example above is the primary use for this
  154008. ** routine. This routine is intended for testing and analysis only.
  154009. */
  154010. static void rtreedepth(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
  154011. UNUSED_PARAMETER(nArg);
  154012. if( sqlite3_value_type(apArg[0])!=SQLITE_BLOB
  154013. || sqlite3_value_bytes(apArg[0])<2
  154014. ){
  154015. sqlite3_result_error(ctx, "Invalid argument to rtreedepth()", -1);
  154016. }else{
  154017. u8 *zBlob = (u8 *)sqlite3_value_blob(apArg[0]);
  154018. sqlite3_result_int(ctx, readInt16(zBlob));
  154019. }
  154020. }
  154021. /*
  154022. ** Register the r-tree module with database handle db. This creates the
  154023. ** virtual table module "rtree" and the debugging/analysis scalar
  154024. ** function "rtreenode".
  154025. */
  154026. SQLITE_PRIVATE int sqlite3RtreeInit(sqlite3 *db){
  154027. const int utf8 = SQLITE_UTF8;
  154028. int rc;
  154029. rc = sqlite3_create_function(db, "rtreenode", 2, utf8, 0, rtreenode, 0, 0);
  154030. if( rc==SQLITE_OK ){
  154031. rc = sqlite3_create_function(db, "rtreedepth", 1, utf8, 0,rtreedepth, 0, 0);
  154032. }
  154033. if( rc==SQLITE_OK ){
  154034. #ifdef SQLITE_RTREE_INT_ONLY
  154035. void *c = (void *)RTREE_COORD_INT32;
  154036. #else
  154037. void *c = (void *)RTREE_COORD_REAL32;
  154038. #endif
  154039. rc = sqlite3_create_module_v2(db, "rtree", &rtreeModule, c, 0);
  154040. }
  154041. if( rc==SQLITE_OK ){
  154042. void *c = (void *)RTREE_COORD_INT32;
  154043. rc = sqlite3_create_module_v2(db, "rtree_i32", &rtreeModule, c, 0);
  154044. }
  154045. return rc;
  154046. }
  154047. /*
  154048. ** This routine deletes the RtreeGeomCallback object that was attached
  154049. ** one of the SQL functions create by sqlite3_rtree_geometry_callback()
  154050. ** or sqlite3_rtree_query_callback(). In other words, this routine is the
  154051. ** destructor for an RtreeGeomCallback objecct. This routine is called when
  154052. ** the corresponding SQL function is deleted.
  154053. */
  154054. static void rtreeFreeCallback(void *p){
  154055. RtreeGeomCallback *pInfo = (RtreeGeomCallback*)p;
  154056. if( pInfo->xDestructor ) pInfo->xDestructor(pInfo->pContext);
  154057. sqlite3_free(p);
  154058. }
  154059. /*
  154060. ** This routine frees the BLOB that is returned by geomCallback().
  154061. */
  154062. static void rtreeMatchArgFree(void *pArg){
  154063. int i;
  154064. RtreeMatchArg *p = (RtreeMatchArg*)pArg;
  154065. for(i=0; i<p->nParam; i++){
  154066. sqlite3_value_free(p->apSqlParam[i]);
  154067. }
  154068. sqlite3_free(p);
  154069. }
  154070. /*
  154071. ** Each call to sqlite3_rtree_geometry_callback() or
  154072. ** sqlite3_rtree_query_callback() creates an ordinary SQLite
  154073. ** scalar function that is implemented by this routine.
  154074. **
  154075. ** All this function does is construct an RtreeMatchArg object that
  154076. ** contains the geometry-checking callback routines and a list of
  154077. ** parameters to this function, then return that RtreeMatchArg object
  154078. ** as a BLOB.
  154079. **
  154080. ** The R-Tree MATCH operator will read the returned BLOB, deserialize
  154081. ** the RtreeMatchArg object, and use the RtreeMatchArg object to figure
  154082. ** out which elements of the R-Tree should be returned by the query.
  154083. */
  154084. static void geomCallback(sqlite3_context *ctx, int nArg, sqlite3_value **aArg){
  154085. RtreeGeomCallback *pGeomCtx = (RtreeGeomCallback *)sqlite3_user_data(ctx);
  154086. RtreeMatchArg *pBlob;
  154087. int nBlob;
  154088. int memErr = 0;
  154089. nBlob = sizeof(RtreeMatchArg) + (nArg-1)*sizeof(RtreeDValue)
  154090. + nArg*sizeof(sqlite3_value*);
  154091. pBlob = (RtreeMatchArg *)sqlite3_malloc(nBlob);
  154092. if( !pBlob ){
  154093. sqlite3_result_error_nomem(ctx);
  154094. }else{
  154095. int i;
  154096. pBlob->magic = RTREE_GEOMETRY_MAGIC;
  154097. pBlob->cb = pGeomCtx[0];
  154098. pBlob->apSqlParam = (sqlite3_value**)&pBlob->aParam[nArg];
  154099. pBlob->nParam = nArg;
  154100. for(i=0; i<nArg; i++){
  154101. pBlob->apSqlParam[i] = sqlite3_value_dup(aArg[i]);
  154102. if( pBlob->apSqlParam[i]==0 ) memErr = 1;
  154103. #ifdef SQLITE_RTREE_INT_ONLY
  154104. pBlob->aParam[i] = sqlite3_value_int64(aArg[i]);
  154105. #else
  154106. pBlob->aParam[i] = sqlite3_value_double(aArg[i]);
  154107. #endif
  154108. }
  154109. if( memErr ){
  154110. sqlite3_result_error_nomem(ctx);
  154111. rtreeMatchArgFree(pBlob);
  154112. }else{
  154113. sqlite3_result_blob(ctx, pBlob, nBlob, rtreeMatchArgFree);
  154114. }
  154115. }
  154116. }
  154117. /*
  154118. ** Register a new geometry function for use with the r-tree MATCH operator.
  154119. */
  154120. SQLITE_API int sqlite3_rtree_geometry_callback(
  154121. sqlite3 *db, /* Register SQL function on this connection */
  154122. const char *zGeom, /* Name of the new SQL function */
  154123. int (*xGeom)(sqlite3_rtree_geometry*,int,RtreeDValue*,int*), /* Callback */
  154124. void *pContext /* Extra data associated with the callback */
  154125. ){
  154126. RtreeGeomCallback *pGeomCtx; /* Context object for new user-function */
  154127. /* Allocate and populate the context object. */
  154128. pGeomCtx = (RtreeGeomCallback *)sqlite3_malloc(sizeof(RtreeGeomCallback));
  154129. if( !pGeomCtx ) return SQLITE_NOMEM;
  154130. pGeomCtx->xGeom = xGeom;
  154131. pGeomCtx->xQueryFunc = 0;
  154132. pGeomCtx->xDestructor = 0;
  154133. pGeomCtx->pContext = pContext;
  154134. return sqlite3_create_function_v2(db, zGeom, -1, SQLITE_ANY,
  154135. (void *)pGeomCtx, geomCallback, 0, 0, rtreeFreeCallback
  154136. );
  154137. }
  154138. /*
  154139. ** Register a new 2nd-generation geometry function for use with the
  154140. ** r-tree MATCH operator.
  154141. */
  154142. SQLITE_API int sqlite3_rtree_query_callback(
  154143. sqlite3 *db, /* Register SQL function on this connection */
  154144. const char *zQueryFunc, /* Name of new SQL function */
  154145. int (*xQueryFunc)(sqlite3_rtree_query_info*), /* Callback */
  154146. void *pContext, /* Extra data passed into the callback */
  154147. void (*xDestructor)(void*) /* Destructor for the extra data */
  154148. ){
  154149. RtreeGeomCallback *pGeomCtx; /* Context object for new user-function */
  154150. /* Allocate and populate the context object. */
  154151. pGeomCtx = (RtreeGeomCallback *)sqlite3_malloc(sizeof(RtreeGeomCallback));
  154152. if( !pGeomCtx ) return SQLITE_NOMEM;
  154153. pGeomCtx->xGeom = 0;
  154154. pGeomCtx->xQueryFunc = xQueryFunc;
  154155. pGeomCtx->xDestructor = xDestructor;
  154156. pGeomCtx->pContext = pContext;
  154157. return sqlite3_create_function_v2(db, zQueryFunc, -1, SQLITE_ANY,
  154158. (void *)pGeomCtx, geomCallback, 0, 0, rtreeFreeCallback
  154159. );
  154160. }
  154161. #if !SQLITE_CORE
  154162. #ifdef _WIN32
  154163. __declspec(dllexport)
  154164. #endif
  154165. SQLITE_API int sqlite3_rtree_init(
  154166. sqlite3 *db,
  154167. char **pzErrMsg,
  154168. const sqlite3_api_routines *pApi
  154169. ){
  154170. SQLITE_EXTENSION_INIT2(pApi)
  154171. return sqlite3RtreeInit(db);
  154172. }
  154173. #endif
  154174. #endif
  154175. /************** End of rtree.c ***********************************************/
  154176. /************** Begin file icu.c *********************************************/
  154177. /*
  154178. ** 2007 May 6
  154179. **
  154180. ** The author disclaims copyright to this source code. In place of
  154181. ** a legal notice, here is a blessing:
  154182. **
  154183. ** May you do good and not evil.
  154184. ** May you find forgiveness for yourself and forgive others.
  154185. ** May you share freely, never taking more than you give.
  154186. **
  154187. *************************************************************************
  154188. ** $Id: icu.c,v 1.7 2007/12/13 21:54:11 drh Exp $
  154189. **
  154190. ** This file implements an integration between the ICU library
  154191. ** ("International Components for Unicode", an open-source library
  154192. ** for handling unicode data) and SQLite. The integration uses
  154193. ** ICU to provide the following to SQLite:
  154194. **
  154195. ** * An implementation of the SQL regexp() function (and hence REGEXP
  154196. ** operator) using the ICU uregex_XX() APIs.
  154197. **
  154198. ** * Implementations of the SQL scalar upper() and lower() functions
  154199. ** for case mapping.
  154200. **
  154201. ** * Integration of ICU and SQLite collation sequences.
  154202. **
  154203. ** * An implementation of the LIKE operator that uses ICU to
  154204. ** provide case-independent matching.
  154205. */
  154206. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_ICU)
  154207. /* Include ICU headers */
  154208. #include <unicode/utypes.h>
  154209. #include <unicode/uregex.h>
  154210. #include <unicode/ustring.h>
  154211. #include <unicode/ucol.h>
  154212. /* #include <assert.h> */
  154213. #ifndef SQLITE_CORE
  154214. /* #include "sqlite3ext.h" */
  154215. SQLITE_EXTENSION_INIT1
  154216. #else
  154217. /* #include "sqlite3.h" */
  154218. #endif
  154219. /*
  154220. ** Maximum length (in bytes) of the pattern in a LIKE or GLOB
  154221. ** operator.
  154222. */
  154223. #ifndef SQLITE_MAX_LIKE_PATTERN_LENGTH
  154224. # define SQLITE_MAX_LIKE_PATTERN_LENGTH 50000
  154225. #endif
  154226. /*
  154227. ** Version of sqlite3_free() that is always a function, never a macro.
  154228. */
  154229. static void xFree(void *p){
  154230. sqlite3_free(p);
  154231. }
  154232. /*
  154233. ** This lookup table is used to help decode the first byte of
  154234. ** a multi-byte UTF8 character. It is copied here from SQLite source
  154235. ** code file utf8.c.
  154236. */
  154237. static const unsigned char icuUtf8Trans1[] = {
  154238. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  154239. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  154240. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  154241. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  154242. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  154243. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  154244. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  154245. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  154246. };
  154247. #define SQLITE_ICU_READ_UTF8(zIn, c) \
  154248. c = *(zIn++); \
  154249. if( c>=0xc0 ){ \
  154250. c = icuUtf8Trans1[c-0xc0]; \
  154251. while( (*zIn & 0xc0)==0x80 ){ \
  154252. c = (c<<6) + (0x3f & *(zIn++)); \
  154253. } \
  154254. }
  154255. #define SQLITE_ICU_SKIP_UTF8(zIn) \
  154256. assert( *zIn ); \
  154257. if( *(zIn++)>=0xc0 ){ \
  154258. while( (*zIn & 0xc0)==0x80 ){zIn++;} \
  154259. }
  154260. /*
  154261. ** Compare two UTF-8 strings for equality where the first string is
  154262. ** a "LIKE" expression. Return true (1) if they are the same and
  154263. ** false (0) if they are different.
  154264. */
  154265. static int icuLikeCompare(
  154266. const uint8_t *zPattern, /* LIKE pattern */
  154267. const uint8_t *zString, /* The UTF-8 string to compare against */
  154268. const UChar32 uEsc /* The escape character */
  154269. ){
  154270. static const int MATCH_ONE = (UChar32)'_';
  154271. static const int MATCH_ALL = (UChar32)'%';
  154272. int prevEscape = 0; /* True if the previous character was uEsc */
  154273. while( 1 ){
  154274. /* Read (and consume) the next character from the input pattern. */
  154275. UChar32 uPattern;
  154276. SQLITE_ICU_READ_UTF8(zPattern, uPattern);
  154277. if( uPattern==0 ) break;
  154278. /* There are now 4 possibilities:
  154279. **
  154280. ** 1. uPattern is an unescaped match-all character "%",
  154281. ** 2. uPattern is an unescaped match-one character "_",
  154282. ** 3. uPattern is an unescaped escape character, or
  154283. ** 4. uPattern is to be handled as an ordinary character
  154284. */
  154285. if( !prevEscape && uPattern==MATCH_ALL ){
  154286. /* Case 1. */
  154287. uint8_t c;
  154288. /* Skip any MATCH_ALL or MATCH_ONE characters that follow a
  154289. ** MATCH_ALL. For each MATCH_ONE, skip one character in the
  154290. ** test string.
  154291. */
  154292. while( (c=*zPattern) == MATCH_ALL || c == MATCH_ONE ){
  154293. if( c==MATCH_ONE ){
  154294. if( *zString==0 ) return 0;
  154295. SQLITE_ICU_SKIP_UTF8(zString);
  154296. }
  154297. zPattern++;
  154298. }
  154299. if( *zPattern==0 ) return 1;
  154300. while( *zString ){
  154301. if( icuLikeCompare(zPattern, zString, uEsc) ){
  154302. return 1;
  154303. }
  154304. SQLITE_ICU_SKIP_UTF8(zString);
  154305. }
  154306. return 0;
  154307. }else if( !prevEscape && uPattern==MATCH_ONE ){
  154308. /* Case 2. */
  154309. if( *zString==0 ) return 0;
  154310. SQLITE_ICU_SKIP_UTF8(zString);
  154311. }else if( !prevEscape && uPattern==uEsc){
  154312. /* Case 3. */
  154313. prevEscape = 1;
  154314. }else{
  154315. /* Case 4. */
  154316. UChar32 uString;
  154317. SQLITE_ICU_READ_UTF8(zString, uString);
  154318. uString = u_foldCase(uString, U_FOLD_CASE_DEFAULT);
  154319. uPattern = u_foldCase(uPattern, U_FOLD_CASE_DEFAULT);
  154320. if( uString!=uPattern ){
  154321. return 0;
  154322. }
  154323. prevEscape = 0;
  154324. }
  154325. }
  154326. return *zString==0;
  154327. }
  154328. /*
  154329. ** Implementation of the like() SQL function. This function implements
  154330. ** the build-in LIKE operator. The first argument to the function is the
  154331. ** pattern and the second argument is the string. So, the SQL statements:
  154332. **
  154333. ** A LIKE B
  154334. **
  154335. ** is implemented as like(B, A). If there is an escape character E,
  154336. **
  154337. ** A LIKE B ESCAPE E
  154338. **
  154339. ** is mapped to like(B, A, E).
  154340. */
  154341. static void icuLikeFunc(
  154342. sqlite3_context *context,
  154343. int argc,
  154344. sqlite3_value **argv
  154345. ){
  154346. const unsigned char *zA = sqlite3_value_text(argv[0]);
  154347. const unsigned char *zB = sqlite3_value_text(argv[1]);
  154348. UChar32 uEsc = 0;
  154349. /* Limit the length of the LIKE or GLOB pattern to avoid problems
  154350. ** of deep recursion and N*N behavior in patternCompare().
  154351. */
  154352. if( sqlite3_value_bytes(argv[0])>SQLITE_MAX_LIKE_PATTERN_LENGTH ){
  154353. sqlite3_result_error(context, "LIKE or GLOB pattern too complex", -1);
  154354. return;
  154355. }
  154356. if( argc==3 ){
  154357. /* The escape character string must consist of a single UTF-8 character.
  154358. ** Otherwise, return an error.
  154359. */
  154360. int nE= sqlite3_value_bytes(argv[2]);
  154361. const unsigned char *zE = sqlite3_value_text(argv[2]);
  154362. int i = 0;
  154363. if( zE==0 ) return;
  154364. U8_NEXT(zE, i, nE, uEsc);
  154365. if( i!=nE){
  154366. sqlite3_result_error(context,
  154367. "ESCAPE expression must be a single character", -1);
  154368. return;
  154369. }
  154370. }
  154371. if( zA && zB ){
  154372. sqlite3_result_int(context, icuLikeCompare(zA, zB, uEsc));
  154373. }
  154374. }
  154375. /*
  154376. ** This function is called when an ICU function called from within
  154377. ** the implementation of an SQL scalar function returns an error.
  154378. **
  154379. ** The scalar function context passed as the first argument is
  154380. ** loaded with an error message based on the following two args.
  154381. */
  154382. static void icuFunctionError(
  154383. sqlite3_context *pCtx, /* SQLite scalar function context */
  154384. const char *zName, /* Name of ICU function that failed */
  154385. UErrorCode e /* Error code returned by ICU function */
  154386. ){
  154387. char zBuf[128];
  154388. sqlite3_snprintf(128, zBuf, "ICU error: %s(): %s", zName, u_errorName(e));
  154389. zBuf[127] = '\0';
  154390. sqlite3_result_error(pCtx, zBuf, -1);
  154391. }
  154392. /*
  154393. ** Function to delete compiled regexp objects. Registered as
  154394. ** a destructor function with sqlite3_set_auxdata().
  154395. */
  154396. static void icuRegexpDelete(void *p){
  154397. URegularExpression *pExpr = (URegularExpression *)p;
  154398. uregex_close(pExpr);
  154399. }
  154400. /*
  154401. ** Implementation of SQLite REGEXP operator. This scalar function takes
  154402. ** two arguments. The first is a regular expression pattern to compile
  154403. ** the second is a string to match against that pattern. If either
  154404. ** argument is an SQL NULL, then NULL Is returned. Otherwise, the result
  154405. ** is 1 if the string matches the pattern, or 0 otherwise.
  154406. **
  154407. ** SQLite maps the regexp() function to the regexp() operator such
  154408. ** that the following two are equivalent:
  154409. **
  154410. ** zString REGEXP zPattern
  154411. ** regexp(zPattern, zString)
  154412. **
  154413. ** Uses the following ICU regexp APIs:
  154414. **
  154415. ** uregex_open()
  154416. ** uregex_matches()
  154417. ** uregex_close()
  154418. */
  154419. static void icuRegexpFunc(sqlite3_context *p, int nArg, sqlite3_value **apArg){
  154420. UErrorCode status = U_ZERO_ERROR;
  154421. URegularExpression *pExpr;
  154422. UBool res;
  154423. const UChar *zString = sqlite3_value_text16(apArg[1]);
  154424. (void)nArg; /* Unused parameter */
  154425. /* If the left hand side of the regexp operator is NULL,
  154426. ** then the result is also NULL.
  154427. */
  154428. if( !zString ){
  154429. return;
  154430. }
  154431. pExpr = sqlite3_get_auxdata(p, 0);
  154432. if( !pExpr ){
  154433. const UChar *zPattern = sqlite3_value_text16(apArg[0]);
  154434. if( !zPattern ){
  154435. return;
  154436. }
  154437. pExpr = uregex_open(zPattern, -1, 0, 0, &status);
  154438. if( U_SUCCESS(status) ){
  154439. sqlite3_set_auxdata(p, 0, pExpr, icuRegexpDelete);
  154440. }else{
  154441. assert(!pExpr);
  154442. icuFunctionError(p, "uregex_open", status);
  154443. return;
  154444. }
  154445. }
  154446. /* Configure the text that the regular expression operates on. */
  154447. uregex_setText(pExpr, zString, -1, &status);
  154448. if( !U_SUCCESS(status) ){
  154449. icuFunctionError(p, "uregex_setText", status);
  154450. return;
  154451. }
  154452. /* Attempt the match */
  154453. res = uregex_matches(pExpr, 0, &status);
  154454. if( !U_SUCCESS(status) ){
  154455. icuFunctionError(p, "uregex_matches", status);
  154456. return;
  154457. }
  154458. /* Set the text that the regular expression operates on to a NULL
  154459. ** pointer. This is not really necessary, but it is tidier than
  154460. ** leaving the regular expression object configured with an invalid
  154461. ** pointer after this function returns.
  154462. */
  154463. uregex_setText(pExpr, 0, 0, &status);
  154464. /* Return 1 or 0. */
  154465. sqlite3_result_int(p, res ? 1 : 0);
  154466. }
  154467. /*
  154468. ** Implementations of scalar functions for case mapping - upper() and
  154469. ** lower(). Function upper() converts its input to upper-case (ABC).
  154470. ** Function lower() converts to lower-case (abc).
  154471. **
  154472. ** ICU provides two types of case mapping, "general" case mapping and
  154473. ** "language specific". Refer to ICU documentation for the differences
  154474. ** between the two.
  154475. **
  154476. ** To utilise "general" case mapping, the upper() or lower() scalar
  154477. ** functions are invoked with one argument:
  154478. **
  154479. ** upper('ABC') -> 'abc'
  154480. ** lower('abc') -> 'ABC'
  154481. **
  154482. ** To access ICU "language specific" case mapping, upper() or lower()
  154483. ** should be invoked with two arguments. The second argument is the name
  154484. ** of the locale to use. Passing an empty string ("") or SQL NULL value
  154485. ** as the second argument is the same as invoking the 1 argument version
  154486. ** of upper() or lower().
  154487. **
  154488. ** lower('I', 'en_us') -> 'i'
  154489. ** lower('I', 'tr_tr') -> '\u131' (small dotless i)
  154490. **
  154491. ** http://www.icu-project.org/userguide/posix.html#case_mappings
  154492. */
  154493. static void icuCaseFunc16(sqlite3_context *p, int nArg, sqlite3_value **apArg){
  154494. const UChar *zInput; /* Pointer to input string */
  154495. UChar *zOutput = 0; /* Pointer to output buffer */
  154496. int nInput; /* Size of utf-16 input string in bytes */
  154497. int nOut; /* Size of output buffer in bytes */
  154498. int cnt;
  154499. int bToUpper; /* True for toupper(), false for tolower() */
  154500. UErrorCode status;
  154501. const char *zLocale = 0;
  154502. assert(nArg==1 || nArg==2);
  154503. bToUpper = (sqlite3_user_data(p)!=0);
  154504. if( nArg==2 ){
  154505. zLocale = (const char *)sqlite3_value_text(apArg[1]);
  154506. }
  154507. zInput = sqlite3_value_text16(apArg[0]);
  154508. if( !zInput ){
  154509. return;
  154510. }
  154511. nOut = nInput = sqlite3_value_bytes16(apArg[0]);
  154512. if( nOut==0 ){
  154513. sqlite3_result_text16(p, "", 0, SQLITE_STATIC);
  154514. return;
  154515. }
  154516. for(cnt=0; cnt<2; cnt++){
  154517. UChar *zNew = sqlite3_realloc(zOutput, nOut);
  154518. if( zNew==0 ){
  154519. sqlite3_free(zOutput);
  154520. sqlite3_result_error_nomem(p);
  154521. return;
  154522. }
  154523. zOutput = zNew;
  154524. status = U_ZERO_ERROR;
  154525. if( bToUpper ){
  154526. nOut = 2*u_strToUpper(zOutput,nOut/2,zInput,nInput/2,zLocale,&status);
  154527. }else{
  154528. nOut = 2*u_strToLower(zOutput,nOut/2,zInput,nInput/2,zLocale,&status);
  154529. }
  154530. if( U_SUCCESS(status) ){
  154531. sqlite3_result_text16(p, zOutput, nOut, xFree);
  154532. }else if( status==U_BUFFER_OVERFLOW_ERROR ){
  154533. assert( cnt==0 );
  154534. continue;
  154535. }else{
  154536. icuFunctionError(p, bToUpper ? "u_strToUpper" : "u_strToLower", status);
  154537. }
  154538. return;
  154539. }
  154540. assert( 0 ); /* Unreachable */
  154541. }
  154542. /*
  154543. ** Collation sequence destructor function. The pCtx argument points to
  154544. ** a UCollator structure previously allocated using ucol_open().
  154545. */
  154546. static void icuCollationDel(void *pCtx){
  154547. UCollator *p = (UCollator *)pCtx;
  154548. ucol_close(p);
  154549. }
  154550. /*
  154551. ** Collation sequence comparison function. The pCtx argument points to
  154552. ** a UCollator structure previously allocated using ucol_open().
  154553. */
  154554. static int icuCollationColl(
  154555. void *pCtx,
  154556. int nLeft,
  154557. const void *zLeft,
  154558. int nRight,
  154559. const void *zRight
  154560. ){
  154561. UCollationResult res;
  154562. UCollator *p = (UCollator *)pCtx;
  154563. res = ucol_strcoll(p, (UChar *)zLeft, nLeft/2, (UChar *)zRight, nRight/2);
  154564. switch( res ){
  154565. case UCOL_LESS: return -1;
  154566. case UCOL_GREATER: return +1;
  154567. case UCOL_EQUAL: return 0;
  154568. }
  154569. assert(!"Unexpected return value from ucol_strcoll()");
  154570. return 0;
  154571. }
  154572. /*
  154573. ** Implementation of the scalar function icu_load_collation().
  154574. **
  154575. ** This scalar function is used to add ICU collation based collation
  154576. ** types to an SQLite database connection. It is intended to be called
  154577. ** as follows:
  154578. **
  154579. ** SELECT icu_load_collation(<locale>, <collation-name>);
  154580. **
  154581. ** Where <locale> is a string containing an ICU locale identifier (i.e.
  154582. ** "en_AU", "tr_TR" etc.) and <collation-name> is the name of the
  154583. ** collation sequence to create.
  154584. */
  154585. static void icuLoadCollation(
  154586. sqlite3_context *p,
  154587. int nArg,
  154588. sqlite3_value **apArg
  154589. ){
  154590. sqlite3 *db = (sqlite3 *)sqlite3_user_data(p);
  154591. UErrorCode status = U_ZERO_ERROR;
  154592. const char *zLocale; /* Locale identifier - (eg. "jp_JP") */
  154593. const char *zName; /* SQL Collation sequence name (eg. "japanese") */
  154594. UCollator *pUCollator; /* ICU library collation object */
  154595. int rc; /* Return code from sqlite3_create_collation_x() */
  154596. assert(nArg==2);
  154597. (void)nArg; /* Unused parameter */
  154598. zLocale = (const char *)sqlite3_value_text(apArg[0]);
  154599. zName = (const char *)sqlite3_value_text(apArg[1]);
  154600. if( !zLocale || !zName ){
  154601. return;
  154602. }
  154603. pUCollator = ucol_open(zLocale, &status);
  154604. if( !U_SUCCESS(status) ){
  154605. icuFunctionError(p, "ucol_open", status);
  154606. return;
  154607. }
  154608. assert(p);
  154609. rc = sqlite3_create_collation_v2(db, zName, SQLITE_UTF16, (void *)pUCollator,
  154610. icuCollationColl, icuCollationDel
  154611. );
  154612. if( rc!=SQLITE_OK ){
  154613. ucol_close(pUCollator);
  154614. sqlite3_result_error(p, "Error registering collation function", -1);
  154615. }
  154616. }
  154617. /*
  154618. ** Register the ICU extension functions with database db.
  154619. */
  154620. SQLITE_PRIVATE int sqlite3IcuInit(sqlite3 *db){
  154621. struct IcuScalar {
  154622. const char *zName; /* Function name */
  154623. int nArg; /* Number of arguments */
  154624. int enc; /* Optimal text encoding */
  154625. void *pContext; /* sqlite3_user_data() context */
  154626. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  154627. } scalars[] = {
  154628. {"regexp", 2, SQLITE_ANY, 0, icuRegexpFunc},
  154629. {"lower", 1, SQLITE_UTF16, 0, icuCaseFunc16},
  154630. {"lower", 2, SQLITE_UTF16, 0, icuCaseFunc16},
  154631. {"upper", 1, SQLITE_UTF16, (void*)1, icuCaseFunc16},
  154632. {"upper", 2, SQLITE_UTF16, (void*)1, icuCaseFunc16},
  154633. {"lower", 1, SQLITE_UTF8, 0, icuCaseFunc16},
  154634. {"lower", 2, SQLITE_UTF8, 0, icuCaseFunc16},
  154635. {"upper", 1, SQLITE_UTF8, (void*)1, icuCaseFunc16},
  154636. {"upper", 2, SQLITE_UTF8, (void*)1, icuCaseFunc16},
  154637. {"like", 2, SQLITE_UTF8, 0, icuLikeFunc},
  154638. {"like", 3, SQLITE_UTF8, 0, icuLikeFunc},
  154639. {"icu_load_collation", 2, SQLITE_UTF8, (void*)db, icuLoadCollation},
  154640. };
  154641. int rc = SQLITE_OK;
  154642. int i;
  154643. for(i=0; rc==SQLITE_OK && i<(int)(sizeof(scalars)/sizeof(scalars[0])); i++){
  154644. struct IcuScalar *p = &scalars[i];
  154645. rc = sqlite3_create_function(
  154646. db, p->zName, p->nArg, p->enc, p->pContext, p->xFunc, 0, 0
  154647. );
  154648. }
  154649. return rc;
  154650. }
  154651. #if !SQLITE_CORE
  154652. #ifdef _WIN32
  154653. __declspec(dllexport)
  154654. #endif
  154655. SQLITE_API int sqlite3_icu_init(
  154656. sqlite3 *db,
  154657. char **pzErrMsg,
  154658. const sqlite3_api_routines *pApi
  154659. ){
  154660. SQLITE_EXTENSION_INIT2(pApi)
  154661. return sqlite3IcuInit(db);
  154662. }
  154663. #endif
  154664. #endif
  154665. /************** End of icu.c *************************************************/
  154666. /************** Begin file fts3_icu.c ****************************************/
  154667. /*
  154668. ** 2007 June 22
  154669. **
  154670. ** The author disclaims copyright to this source code. In place of
  154671. ** a legal notice, here is a blessing:
  154672. **
  154673. ** May you do good and not evil.
  154674. ** May you find forgiveness for yourself and forgive others.
  154675. ** May you share freely, never taking more than you give.
  154676. **
  154677. *************************************************************************
  154678. ** This file implements a tokenizer for fts3 based on the ICU library.
  154679. */
  154680. /* #include "fts3Int.h" */
  154681. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  154682. #ifdef SQLITE_ENABLE_ICU
  154683. /* #include <assert.h> */
  154684. /* #include <string.h> */
  154685. /* #include "fts3_tokenizer.h" */
  154686. #include <unicode/ubrk.h>
  154687. /* #include <unicode/ucol.h> */
  154688. /* #include <unicode/ustring.h> */
  154689. #include <unicode/utf16.h>
  154690. typedef struct IcuTokenizer IcuTokenizer;
  154691. typedef struct IcuCursor IcuCursor;
  154692. struct IcuTokenizer {
  154693. sqlite3_tokenizer base;
  154694. char *zLocale;
  154695. };
  154696. struct IcuCursor {
  154697. sqlite3_tokenizer_cursor base;
  154698. UBreakIterator *pIter; /* ICU break-iterator object */
  154699. int nChar; /* Number of UChar elements in pInput */
  154700. UChar *aChar; /* Copy of input using utf-16 encoding */
  154701. int *aOffset; /* Offsets of each character in utf-8 input */
  154702. int nBuffer;
  154703. char *zBuffer;
  154704. int iToken;
  154705. };
  154706. /*
  154707. ** Create a new tokenizer instance.
  154708. */
  154709. static int icuCreate(
  154710. int argc, /* Number of entries in argv[] */
  154711. const char * const *argv, /* Tokenizer creation arguments */
  154712. sqlite3_tokenizer **ppTokenizer /* OUT: Created tokenizer */
  154713. ){
  154714. IcuTokenizer *p;
  154715. int n = 0;
  154716. if( argc>0 ){
  154717. n = strlen(argv[0])+1;
  154718. }
  154719. p = (IcuTokenizer *)sqlite3_malloc(sizeof(IcuTokenizer)+n);
  154720. if( !p ){
  154721. return SQLITE_NOMEM;
  154722. }
  154723. memset(p, 0, sizeof(IcuTokenizer));
  154724. if( n ){
  154725. p->zLocale = (char *)&p[1];
  154726. memcpy(p->zLocale, argv[0], n);
  154727. }
  154728. *ppTokenizer = (sqlite3_tokenizer *)p;
  154729. return SQLITE_OK;
  154730. }
  154731. /*
  154732. ** Destroy a tokenizer
  154733. */
  154734. static int icuDestroy(sqlite3_tokenizer *pTokenizer){
  154735. IcuTokenizer *p = (IcuTokenizer *)pTokenizer;
  154736. sqlite3_free(p);
  154737. return SQLITE_OK;
  154738. }
  154739. /*
  154740. ** Prepare to begin tokenizing a particular string. The input
  154741. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  154742. ** used to incrementally tokenize this string is returned in
  154743. ** *ppCursor.
  154744. */
  154745. static int icuOpen(
  154746. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  154747. const char *zInput, /* Input string */
  154748. int nInput, /* Length of zInput in bytes */
  154749. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  154750. ){
  154751. IcuTokenizer *p = (IcuTokenizer *)pTokenizer;
  154752. IcuCursor *pCsr;
  154753. const int32_t opt = U_FOLD_CASE_DEFAULT;
  154754. UErrorCode status = U_ZERO_ERROR;
  154755. int nChar;
  154756. UChar32 c;
  154757. int iInput = 0;
  154758. int iOut = 0;
  154759. *ppCursor = 0;
  154760. if( zInput==0 ){
  154761. nInput = 0;
  154762. zInput = "";
  154763. }else if( nInput<0 ){
  154764. nInput = strlen(zInput);
  154765. }
  154766. nChar = nInput+1;
  154767. pCsr = (IcuCursor *)sqlite3_malloc(
  154768. sizeof(IcuCursor) + /* IcuCursor */
  154769. ((nChar+3)&~3) * sizeof(UChar) + /* IcuCursor.aChar[] */
  154770. (nChar+1) * sizeof(int) /* IcuCursor.aOffset[] */
  154771. );
  154772. if( !pCsr ){
  154773. return SQLITE_NOMEM;
  154774. }
  154775. memset(pCsr, 0, sizeof(IcuCursor));
  154776. pCsr->aChar = (UChar *)&pCsr[1];
  154777. pCsr->aOffset = (int *)&pCsr->aChar[(nChar+3)&~3];
  154778. pCsr->aOffset[iOut] = iInput;
  154779. U8_NEXT(zInput, iInput, nInput, c);
  154780. while( c>0 ){
  154781. int isError = 0;
  154782. c = u_foldCase(c, opt);
  154783. U16_APPEND(pCsr->aChar, iOut, nChar, c, isError);
  154784. if( isError ){
  154785. sqlite3_free(pCsr);
  154786. return SQLITE_ERROR;
  154787. }
  154788. pCsr->aOffset[iOut] = iInput;
  154789. if( iInput<nInput ){
  154790. U8_NEXT(zInput, iInput, nInput, c);
  154791. }else{
  154792. c = 0;
  154793. }
  154794. }
  154795. pCsr->pIter = ubrk_open(UBRK_WORD, p->zLocale, pCsr->aChar, iOut, &status);
  154796. if( !U_SUCCESS(status) ){
  154797. sqlite3_free(pCsr);
  154798. return SQLITE_ERROR;
  154799. }
  154800. pCsr->nChar = iOut;
  154801. ubrk_first(pCsr->pIter);
  154802. *ppCursor = (sqlite3_tokenizer_cursor *)pCsr;
  154803. return SQLITE_OK;
  154804. }
  154805. /*
  154806. ** Close a tokenization cursor previously opened by a call to icuOpen().
  154807. */
  154808. static int icuClose(sqlite3_tokenizer_cursor *pCursor){
  154809. IcuCursor *pCsr = (IcuCursor *)pCursor;
  154810. ubrk_close(pCsr->pIter);
  154811. sqlite3_free(pCsr->zBuffer);
  154812. sqlite3_free(pCsr);
  154813. return SQLITE_OK;
  154814. }
  154815. /*
  154816. ** Extract the next token from a tokenization cursor.
  154817. */
  154818. static int icuNext(
  154819. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by simpleOpen */
  154820. const char **ppToken, /* OUT: *ppToken is the token text */
  154821. int *pnBytes, /* OUT: Number of bytes in token */
  154822. int *piStartOffset, /* OUT: Starting offset of token */
  154823. int *piEndOffset, /* OUT: Ending offset of token */
  154824. int *piPosition /* OUT: Position integer of token */
  154825. ){
  154826. IcuCursor *pCsr = (IcuCursor *)pCursor;
  154827. int iStart = 0;
  154828. int iEnd = 0;
  154829. int nByte = 0;
  154830. while( iStart==iEnd ){
  154831. UChar32 c;
  154832. iStart = ubrk_current(pCsr->pIter);
  154833. iEnd = ubrk_next(pCsr->pIter);
  154834. if( iEnd==UBRK_DONE ){
  154835. return SQLITE_DONE;
  154836. }
  154837. while( iStart<iEnd ){
  154838. int iWhite = iStart;
  154839. U16_NEXT(pCsr->aChar, iWhite, pCsr->nChar, c);
  154840. if( u_isspace(c) ){
  154841. iStart = iWhite;
  154842. }else{
  154843. break;
  154844. }
  154845. }
  154846. assert(iStart<=iEnd);
  154847. }
  154848. do {
  154849. UErrorCode status = U_ZERO_ERROR;
  154850. if( nByte ){
  154851. char *zNew = sqlite3_realloc(pCsr->zBuffer, nByte);
  154852. if( !zNew ){
  154853. return SQLITE_NOMEM;
  154854. }
  154855. pCsr->zBuffer = zNew;
  154856. pCsr->nBuffer = nByte;
  154857. }
  154858. u_strToUTF8(
  154859. pCsr->zBuffer, pCsr->nBuffer, &nByte, /* Output vars */
  154860. &pCsr->aChar[iStart], iEnd-iStart, /* Input vars */
  154861. &status /* Output success/failure */
  154862. );
  154863. } while( nByte>pCsr->nBuffer );
  154864. *ppToken = pCsr->zBuffer;
  154865. *pnBytes = nByte;
  154866. *piStartOffset = pCsr->aOffset[iStart];
  154867. *piEndOffset = pCsr->aOffset[iEnd];
  154868. *piPosition = pCsr->iToken++;
  154869. return SQLITE_OK;
  154870. }
  154871. /*
  154872. ** The set of routines that implement the simple tokenizer
  154873. */
  154874. static const sqlite3_tokenizer_module icuTokenizerModule = {
  154875. 0, /* iVersion */
  154876. icuCreate, /* xCreate */
  154877. icuDestroy, /* xCreate */
  154878. icuOpen, /* xOpen */
  154879. icuClose, /* xClose */
  154880. icuNext, /* xNext */
  154881. 0, /* xLanguageid */
  154882. };
  154883. /*
  154884. ** Set *ppModule to point at the implementation of the ICU tokenizer.
  154885. */
  154886. SQLITE_PRIVATE void sqlite3Fts3IcuTokenizerModule(
  154887. sqlite3_tokenizer_module const**ppModule
  154888. ){
  154889. *ppModule = &icuTokenizerModule;
  154890. }
  154891. #endif /* defined(SQLITE_ENABLE_ICU) */
  154892. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  154893. /************** End of fts3_icu.c ********************************************/
  154894. /************** Begin file sqlite3rbu.c **************************************/
  154895. /*
  154896. ** 2014 August 30
  154897. **
  154898. ** The author disclaims copyright to this source code. In place of
  154899. ** a legal notice, here is a blessing:
  154900. **
  154901. ** May you do good and not evil.
  154902. ** May you find forgiveness for yourself and forgive others.
  154903. ** May you share freely, never taking more than you give.
  154904. **
  154905. *************************************************************************
  154906. **
  154907. **
  154908. ** OVERVIEW
  154909. **
  154910. ** The RBU extension requires that the RBU update be packaged as an
  154911. ** SQLite database. The tables it expects to find are described in
  154912. ** sqlite3rbu.h. Essentially, for each table xyz in the target database
  154913. ** that the user wishes to write to, a corresponding data_xyz table is
  154914. ** created in the RBU database and populated with one row for each row to
  154915. ** update, insert or delete from the target table.
  154916. **
  154917. ** The update proceeds in three stages:
  154918. **
  154919. ** 1) The database is updated. The modified database pages are written
  154920. ** to a *-oal file. A *-oal file is just like a *-wal file, except
  154921. ** that it is named "<database>-oal" instead of "<database>-wal".
  154922. ** Because regular SQLite clients do not look for file named
  154923. ** "<database>-oal", they go on using the original database in
  154924. ** rollback mode while the *-oal file is being generated.
  154925. **
  154926. ** During this stage RBU does not update the database by writing
  154927. ** directly to the target tables. Instead it creates "imposter"
  154928. ** tables using the SQLITE_TESTCTRL_IMPOSTER interface that it uses
  154929. ** to update each b-tree individually. All updates required by each
  154930. ** b-tree are completed before moving on to the next, and all
  154931. ** updates are done in sorted key order.
  154932. **
  154933. ** 2) The "<database>-oal" file is moved to the equivalent "<database>-wal"
  154934. ** location using a call to rename(2). Before doing this the RBU
  154935. ** module takes an EXCLUSIVE lock on the database file, ensuring
  154936. ** that there are no other active readers.
  154937. **
  154938. ** Once the EXCLUSIVE lock is released, any other database readers
  154939. ** detect the new *-wal file and read the database in wal mode. At
  154940. ** this point they see the new version of the database - including
  154941. ** the updates made as part of the RBU update.
  154942. **
  154943. ** 3) The new *-wal file is checkpointed. This proceeds in the same way
  154944. ** as a regular database checkpoint, except that a single frame is
  154945. ** checkpointed each time sqlite3rbu_step() is called. If the RBU
  154946. ** handle is closed before the entire *-wal file is checkpointed,
  154947. ** the checkpoint progress is saved in the RBU database and the
  154948. ** checkpoint can be resumed by another RBU client at some point in
  154949. ** the future.
  154950. **
  154951. ** POTENTIAL PROBLEMS
  154952. **
  154953. ** The rename() call might not be portable. And RBU is not currently
  154954. ** syncing the directory after renaming the file.
  154955. **
  154956. ** When state is saved, any commit to the *-oal file and the commit to
  154957. ** the RBU update database are not atomic. So if the power fails at the
  154958. ** wrong moment they might get out of sync. As the main database will be
  154959. ** committed before the RBU update database this will likely either just
  154960. ** pass unnoticed, or result in SQLITE_CONSTRAINT errors (due to UNIQUE
  154961. ** constraint violations).
  154962. **
  154963. ** If some client does modify the target database mid RBU update, or some
  154964. ** other error occurs, the RBU extension will keep throwing errors. It's
  154965. ** not really clear how to get out of this state. The system could just
  154966. ** by delete the RBU update database and *-oal file and have the device
  154967. ** download the update again and start over.
  154968. **
  154969. ** At present, for an UPDATE, both the new.* and old.* records are
  154970. ** collected in the rbu_xyz table. And for both UPDATEs and DELETEs all
  154971. ** fields are collected. This means we're probably writing a lot more
  154972. ** data to disk when saving the state of an ongoing update to the RBU
  154973. ** update database than is strictly necessary.
  154974. **
  154975. */
  154976. /* #include <assert.h> */
  154977. /* #include <string.h> */
  154978. /* #include <stdio.h> */
  154979. /* #include "sqlite3.h" */
  154980. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_RBU)
  154981. /************** Include sqlite3rbu.h in the middle of sqlite3rbu.c ***********/
  154982. /************** Begin file sqlite3rbu.h **************************************/
  154983. /*
  154984. ** 2014 August 30
  154985. **
  154986. ** The author disclaims copyright to this source code. In place of
  154987. ** a legal notice, here is a blessing:
  154988. **
  154989. ** May you do good and not evil.
  154990. ** May you find forgiveness for yourself and forgive others.
  154991. ** May you share freely, never taking more than you give.
  154992. **
  154993. *************************************************************************
  154994. **
  154995. ** This file contains the public interface for the RBU extension.
  154996. */
  154997. /*
  154998. ** SUMMARY
  154999. **
  155000. ** Writing a transaction containing a large number of operations on
  155001. ** b-tree indexes that are collectively larger than the available cache
  155002. ** memory can be very inefficient.
  155003. **
  155004. ** The problem is that in order to update a b-tree, the leaf page (at least)
  155005. ** containing the entry being inserted or deleted must be modified. If the
  155006. ** working set of leaves is larger than the available cache memory, then a
  155007. ** single leaf that is modified more than once as part of the transaction
  155008. ** may be loaded from or written to the persistent media multiple times.
  155009. ** Additionally, because the index updates are likely to be applied in
  155010. ** random order, access to pages within the database is also likely to be in
  155011. ** random order, which is itself quite inefficient.
  155012. **
  155013. ** One way to improve the situation is to sort the operations on each index
  155014. ** by index key before applying them to the b-tree. This leads to an IO
  155015. ** pattern that resembles a single linear scan through the index b-tree,
  155016. ** and all but guarantees each modified leaf page is loaded and stored
  155017. ** exactly once. SQLite uses this trick to improve the performance of
  155018. ** CREATE INDEX commands. This extension allows it to be used to improve
  155019. ** the performance of large transactions on existing databases.
  155020. **
  155021. ** Additionally, this extension allows the work involved in writing the
  155022. ** large transaction to be broken down into sub-transactions performed
  155023. ** sequentially by separate processes. This is useful if the system cannot
  155024. ** guarantee that a single update process will run for long enough to apply
  155025. ** the entire update, for example because the update is being applied on a
  155026. ** mobile device that is frequently rebooted. Even after the writer process
  155027. ** has committed one or more sub-transactions, other database clients continue
  155028. ** to read from the original database snapshot. In other words, partially
  155029. ** applied transactions are not visible to other clients.
  155030. **
  155031. ** "RBU" stands for "Resumable Bulk Update". As in a large database update
  155032. ** transmitted via a wireless network to a mobile device. A transaction
  155033. ** applied using this extension is hence refered to as an "RBU update".
  155034. **
  155035. **
  155036. ** LIMITATIONS
  155037. **
  155038. ** An "RBU update" transaction is subject to the following limitations:
  155039. **
  155040. ** * The transaction must consist of INSERT, UPDATE and DELETE operations
  155041. ** only.
  155042. **
  155043. ** * INSERT statements may not use any default values.
  155044. **
  155045. ** * UPDATE and DELETE statements must identify their target rows by
  155046. ** non-NULL PRIMARY KEY values. Rows with NULL values stored in PRIMARY
  155047. ** KEY fields may not be updated or deleted. If the table being written
  155048. ** has no PRIMARY KEY, affected rows must be identified by rowid.
  155049. **
  155050. ** * UPDATE statements may not modify PRIMARY KEY columns.
  155051. **
  155052. ** * No triggers will be fired.
  155053. **
  155054. ** * No foreign key violations are detected or reported.
  155055. **
  155056. ** * CHECK constraints are not enforced.
  155057. **
  155058. ** * No constraint handling mode except for "OR ROLLBACK" is supported.
  155059. **
  155060. **
  155061. ** PREPARATION
  155062. **
  155063. ** An "RBU update" is stored as a separate SQLite database. A database
  155064. ** containing an RBU update is an "RBU database". For each table in the
  155065. ** target database to be updated, the RBU database should contain a table
  155066. ** named "data_<target name>" containing the same set of columns as the
  155067. ** target table, and one more - "rbu_control". The data_% table should
  155068. ** have no PRIMARY KEY or UNIQUE constraints, but each column should have
  155069. ** the same type as the corresponding column in the target database.
  155070. ** The "rbu_control" column should have no type at all. For example, if
  155071. ** the target database contains:
  155072. **
  155073. ** CREATE TABLE t1(a INTEGER PRIMARY KEY, b TEXT, c UNIQUE);
  155074. **
  155075. ** Then the RBU database should contain:
  155076. **
  155077. ** CREATE TABLE data_t1(a INTEGER, b TEXT, c, rbu_control);
  155078. **
  155079. ** The order of the columns in the data_% table does not matter.
  155080. **
  155081. ** Instead of a regular table, the RBU database may also contain virtual
  155082. ** tables or view named using the data_<target> naming scheme.
  155083. **
  155084. ** Instead of the plain data_<target> naming scheme, RBU database tables
  155085. ** may also be named data<integer>_<target>, where <integer> is any sequence
  155086. ** of zero or more numeric characters (0-9). This can be significant because
  155087. ** tables within the RBU database are always processed in order sorted by
  155088. ** name. By judicious selection of the <integer> portion of the names
  155089. ** of the RBU tables the user can therefore control the order in which they
  155090. ** are processed. This can be useful, for example, to ensure that "external
  155091. ** content" FTS4 tables are updated before their underlying content tables.
  155092. **
  155093. ** If the target database table is a virtual table or a table that has no
  155094. ** PRIMARY KEY declaration, the data_% table must also contain a column
  155095. ** named "rbu_rowid". This column is mapped to the tables implicit primary
  155096. ** key column - "rowid". Virtual tables for which the "rowid" column does
  155097. ** not function like a primary key value cannot be updated using RBU. For
  155098. ** example, if the target db contains either of the following:
  155099. **
  155100. ** CREATE VIRTUAL TABLE x1 USING fts3(a, b);
  155101. ** CREATE TABLE x1(a, b)
  155102. **
  155103. ** then the RBU database should contain:
  155104. **
  155105. ** CREATE TABLE data_x1(a, b, rbu_rowid, rbu_control);
  155106. **
  155107. ** All non-hidden columns (i.e. all columns matched by "SELECT *") of the
  155108. ** target table must be present in the input table. For virtual tables,
  155109. ** hidden columns are optional - they are updated by RBU if present in
  155110. ** the input table, or not otherwise. For example, to write to an fts4
  155111. ** table with a hidden languageid column such as:
  155112. **
  155113. ** CREATE VIRTUAL TABLE ft1 USING fts4(a, b, languageid='langid');
  155114. **
  155115. ** Either of the following input table schemas may be used:
  155116. **
  155117. ** CREATE TABLE data_ft1(a, b, langid, rbu_rowid, rbu_control);
  155118. ** CREATE TABLE data_ft1(a, b, rbu_rowid, rbu_control);
  155119. **
  155120. ** For each row to INSERT into the target database as part of the RBU
  155121. ** update, the corresponding data_% table should contain a single record
  155122. ** with the "rbu_control" column set to contain integer value 0. The
  155123. ** other columns should be set to the values that make up the new record
  155124. ** to insert.
  155125. **
  155126. ** If the target database table has an INTEGER PRIMARY KEY, it is not
  155127. ** possible to insert a NULL value into the IPK column. Attempting to
  155128. ** do so results in an SQLITE_MISMATCH error.
  155129. **
  155130. ** For each row to DELETE from the target database as part of the RBU
  155131. ** update, the corresponding data_% table should contain a single record
  155132. ** with the "rbu_control" column set to contain integer value 1. The
  155133. ** real primary key values of the row to delete should be stored in the
  155134. ** corresponding columns of the data_% table. The values stored in the
  155135. ** other columns are not used.
  155136. **
  155137. ** For each row to UPDATE from the target database as part of the RBU
  155138. ** update, the corresponding data_% table should contain a single record
  155139. ** with the "rbu_control" column set to contain a value of type text.
  155140. ** The real primary key values identifying the row to update should be
  155141. ** stored in the corresponding columns of the data_% table row, as should
  155142. ** the new values of all columns being update. The text value in the
  155143. ** "rbu_control" column must contain the same number of characters as
  155144. ** there are columns in the target database table, and must consist entirely
  155145. ** of 'x' and '.' characters (or in some special cases 'd' - see below). For
  155146. ** each column that is being updated, the corresponding character is set to
  155147. ** 'x'. For those that remain as they are, the corresponding character of the
  155148. ** rbu_control value should be set to '.'. For example, given the tables
  155149. ** above, the update statement:
  155150. **
  155151. ** UPDATE t1 SET c = 'usa' WHERE a = 4;
  155152. **
  155153. ** is represented by the data_t1 row created by:
  155154. **
  155155. ** INSERT INTO data_t1(a, b, c, rbu_control) VALUES(4, NULL, 'usa', '..x');
  155156. **
  155157. ** Instead of an 'x' character, characters of the rbu_control value specified
  155158. ** for UPDATEs may also be set to 'd'. In this case, instead of updating the
  155159. ** target table with the value stored in the corresponding data_% column, the
  155160. ** user-defined SQL function "rbu_delta()" is invoked and the result stored in
  155161. ** the target table column. rbu_delta() is invoked with two arguments - the
  155162. ** original value currently stored in the target table column and the
  155163. ** value specified in the data_xxx table.
  155164. **
  155165. ** For example, this row:
  155166. **
  155167. ** INSERT INTO data_t1(a, b, c, rbu_control) VALUES(4, NULL, 'usa', '..d');
  155168. **
  155169. ** is similar to an UPDATE statement such as:
  155170. **
  155171. ** UPDATE t1 SET c = rbu_delta(c, 'usa') WHERE a = 4;
  155172. **
  155173. ** Finally, if an 'f' character appears in place of a 'd' or 's' in an
  155174. ** ota_control string, the contents of the data_xxx table column is assumed
  155175. ** to be a "fossil delta" - a patch to be applied to a blob value in the
  155176. ** format used by the fossil source-code management system. In this case
  155177. ** the existing value within the target database table must be of type BLOB.
  155178. ** It is replaced by the result of applying the specified fossil delta to
  155179. ** itself.
  155180. **
  155181. ** If the target database table is a virtual table or a table with no PRIMARY
  155182. ** KEY, the rbu_control value should not include a character corresponding
  155183. ** to the rbu_rowid value. For example, this:
  155184. **
  155185. ** INSERT INTO data_ft1(a, b, rbu_rowid, rbu_control)
  155186. ** VALUES(NULL, 'usa', 12, '.x');
  155187. **
  155188. ** causes a result similar to:
  155189. **
  155190. ** UPDATE ft1 SET b = 'usa' WHERE rowid = 12;
  155191. **
  155192. ** The data_xxx tables themselves should have no PRIMARY KEY declarations.
  155193. ** However, RBU is more efficient if reading the rows in from each data_xxx
  155194. ** table in "rowid" order is roughly the same as reading them sorted by
  155195. ** the PRIMARY KEY of the corresponding target database table. In other
  155196. ** words, rows should be sorted using the destination table PRIMARY KEY
  155197. ** fields before they are inserted into the data_xxx tables.
  155198. **
  155199. ** USAGE
  155200. **
  155201. ** The API declared below allows an application to apply an RBU update
  155202. ** stored on disk to an existing target database. Essentially, the
  155203. ** application:
  155204. **
  155205. ** 1) Opens an RBU handle using the sqlite3rbu_open() function.
  155206. **
  155207. ** 2) Registers any required virtual table modules with the database
  155208. ** handle returned by sqlite3rbu_db(). Also, if required, register
  155209. ** the rbu_delta() implementation.
  155210. **
  155211. ** 3) Calls the sqlite3rbu_step() function one or more times on
  155212. ** the new handle. Each call to sqlite3rbu_step() performs a single
  155213. ** b-tree operation, so thousands of calls may be required to apply
  155214. ** a complete update.
  155215. **
  155216. ** 4) Calls sqlite3rbu_close() to close the RBU update handle. If
  155217. ** sqlite3rbu_step() has been called enough times to completely
  155218. ** apply the update to the target database, then the RBU database
  155219. ** is marked as fully applied. Otherwise, the state of the RBU
  155220. ** update application is saved in the RBU database for later
  155221. ** resumption.
  155222. **
  155223. ** See comments below for more detail on APIs.
  155224. **
  155225. ** If an update is only partially applied to the target database by the
  155226. ** time sqlite3rbu_close() is called, various state information is saved
  155227. ** within the RBU database. This allows subsequent processes to automatically
  155228. ** resume the RBU update from where it left off.
  155229. **
  155230. ** To remove all RBU extension state information, returning an RBU database
  155231. ** to its original contents, it is sufficient to drop all tables that begin
  155232. ** with the prefix "rbu_"
  155233. **
  155234. ** DATABASE LOCKING
  155235. **
  155236. ** An RBU update may not be applied to a database in WAL mode. Attempting
  155237. ** to do so is an error (SQLITE_ERROR).
  155238. **
  155239. ** While an RBU handle is open, a SHARED lock may be held on the target
  155240. ** database file. This means it is possible for other clients to read the
  155241. ** database, but not to write it.
  155242. **
  155243. ** If an RBU update is started and then suspended before it is completed,
  155244. ** then an external client writes to the database, then attempting to resume
  155245. ** the suspended RBU update is also an error (SQLITE_BUSY).
  155246. */
  155247. #ifndef _SQLITE3RBU_H
  155248. #define _SQLITE3RBU_H
  155249. /* #include "sqlite3.h" ** Required for error code definitions ** */
  155250. #if 0
  155251. extern "C" {
  155252. #endif
  155253. typedef struct sqlite3rbu sqlite3rbu;
  155254. /*
  155255. ** Open an RBU handle.
  155256. **
  155257. ** Argument zTarget is the path to the target database. Argument zRbu is
  155258. ** the path to the RBU database. Each call to this function must be matched
  155259. ** by a call to sqlite3rbu_close(). When opening the databases, RBU passes
  155260. ** the SQLITE_CONFIG_URI flag to sqlite3_open_v2(). So if either zTarget
  155261. ** or zRbu begin with "file:", it will be interpreted as an SQLite
  155262. ** database URI, not a regular file name.
  155263. **
  155264. ** If the zState argument is passed a NULL value, the RBU extension stores
  155265. ** the current state of the update (how many rows have been updated, which
  155266. ** indexes are yet to be updated etc.) within the RBU database itself. This
  155267. ** can be convenient, as it means that the RBU application does not need to
  155268. ** organize removing a separate state file after the update is concluded.
  155269. ** Or, if zState is non-NULL, it must be a path to a database file in which
  155270. ** the RBU extension can store the state of the update.
  155271. **
  155272. ** When resuming an RBU update, the zState argument must be passed the same
  155273. ** value as when the RBU update was started.
  155274. **
  155275. ** Once the RBU update is finished, the RBU extension does not
  155276. ** automatically remove any zState database file, even if it created it.
  155277. **
  155278. ** By default, RBU uses the default VFS to access the files on disk. To
  155279. ** use a VFS other than the default, an SQLite "file:" URI containing a
  155280. ** "vfs=..." option may be passed as the zTarget option.
  155281. **
  155282. ** IMPORTANT NOTE FOR ZIPVFS USERS: The RBU extension works with all of
  155283. ** SQLite's built-in VFSs, including the multiplexor VFS. However it does
  155284. ** not work out of the box with zipvfs. Refer to the comment describing
  155285. ** the zipvfs_create_vfs() API below for details on using RBU with zipvfs.
  155286. */
  155287. SQLITE_API sqlite3rbu *sqlite3rbu_open(
  155288. const char *zTarget,
  155289. const char *zRbu,
  155290. const char *zState
  155291. );
  155292. /*
  155293. ** Open an RBU handle to perform an RBU vacuum on database file zTarget.
  155294. ** An RBU vacuum is similar to SQLite's built-in VACUUM command, except
  155295. ** that it can be suspended and resumed like an RBU update.
  155296. **
  155297. ** The second argument to this function identifies a database in which
  155298. ** to store the state of the RBU vacuum operation if it is suspended. The
  155299. ** first time sqlite3rbu_vacuum() is called, to start an RBU vacuum
  155300. ** operation, the state database should either not exist or be empty
  155301. ** (contain no tables). If an RBU vacuum is suspended by calling
  155302. ** sqlite3rbu_close() on the RBU handle before sqlite3rbu_step() has
  155303. ** returned SQLITE_DONE, the vacuum state is stored in the state database.
  155304. ** The vacuum can be resumed by calling this function to open a new RBU
  155305. ** handle specifying the same target and state databases.
  155306. **
  155307. ** If the second argument passed to this function is NULL, then the
  155308. ** name of the state database is "<database>-vacuum", where <database>
  155309. ** is the name of the target database file. In this case, on UNIX, if the
  155310. ** state database is not already present in the file-system, it is created
  155311. ** with the same permissions as the target db is made.
  155312. **
  155313. ** This function does not delete the state database after an RBU vacuum
  155314. ** is completed, even if it created it. However, if the call to
  155315. ** sqlite3rbu_close() returns any value other than SQLITE_OK, the contents
  155316. ** of the state tables within the state database are zeroed. This way,
  155317. ** the next call to sqlite3rbu_vacuum() opens a handle that starts a
  155318. ** new RBU vacuum operation.
  155319. **
  155320. ** As with sqlite3rbu_open(), Zipvfs users should rever to the comment
  155321. ** describing the sqlite3rbu_create_vfs() API function below for
  155322. ** a description of the complications associated with using RBU with
  155323. ** zipvfs databases.
  155324. */
  155325. SQLITE_API sqlite3rbu *sqlite3rbu_vacuum(
  155326. const char *zTarget,
  155327. const char *zState
  155328. );
  155329. /*
  155330. ** Internally, each RBU connection uses a separate SQLite database
  155331. ** connection to access the target and rbu update databases. This
  155332. ** API allows the application direct access to these database handles.
  155333. **
  155334. ** The first argument passed to this function must be a valid, open, RBU
  155335. ** handle. The second argument should be passed zero to access the target
  155336. ** database handle, or non-zero to access the rbu update database handle.
  155337. ** Accessing the underlying database handles may be useful in the
  155338. ** following scenarios:
  155339. **
  155340. ** * If any target tables are virtual tables, it may be necessary to
  155341. ** call sqlite3_create_module() on the target database handle to
  155342. ** register the required virtual table implementations.
  155343. **
  155344. ** * If the data_xxx tables in the RBU source database are virtual
  155345. ** tables, the application may need to call sqlite3_create_module() on
  155346. ** the rbu update db handle to any required virtual table
  155347. ** implementations.
  155348. **
  155349. ** * If the application uses the "rbu_delta()" feature described above,
  155350. ** it must use sqlite3_create_function() or similar to register the
  155351. ** rbu_delta() implementation with the target database handle.
  155352. **
  155353. ** If an error has occurred, either while opening or stepping the RBU object,
  155354. ** this function may return NULL. The error code and message may be collected
  155355. ** when sqlite3rbu_close() is called.
  155356. **
  155357. ** Database handles returned by this function remain valid until the next
  155358. ** call to any sqlite3rbu_xxx() function other than sqlite3rbu_db().
  155359. */
  155360. SQLITE_API sqlite3 *sqlite3rbu_db(sqlite3rbu*, int bRbu);
  155361. /*
  155362. ** Do some work towards applying the RBU update to the target db.
  155363. **
  155364. ** Return SQLITE_DONE if the update has been completely applied, or
  155365. ** SQLITE_OK if no error occurs but there remains work to do to apply
  155366. ** the RBU update. If an error does occur, some other error code is
  155367. ** returned.
  155368. **
  155369. ** Once a call to sqlite3rbu_step() has returned a value other than
  155370. ** SQLITE_OK, all subsequent calls on the same RBU handle are no-ops
  155371. ** that immediately return the same value.
  155372. */
  155373. SQLITE_API int sqlite3rbu_step(sqlite3rbu *pRbu);
  155374. /*
  155375. ** Force RBU to save its state to disk.
  155376. **
  155377. ** If a power failure or application crash occurs during an update, following
  155378. ** system recovery RBU may resume the update from the point at which the state
  155379. ** was last saved. In other words, from the most recent successful call to
  155380. ** sqlite3rbu_close() or this function.
  155381. **
  155382. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  155383. */
  155384. SQLITE_API int sqlite3rbu_savestate(sqlite3rbu *pRbu);
  155385. /*
  155386. ** Close an RBU handle.
  155387. **
  155388. ** If the RBU update has been completely applied, mark the RBU database
  155389. ** as fully applied. Otherwise, assuming no error has occurred, save the
  155390. ** current state of the RBU update appliation to the RBU database.
  155391. **
  155392. ** If an error has already occurred as part of an sqlite3rbu_step()
  155393. ** or sqlite3rbu_open() call, or if one occurs within this function, an
  155394. ** SQLite error code is returned. Additionally, *pzErrmsg may be set to
  155395. ** point to a buffer containing a utf-8 formatted English language error
  155396. ** message. It is the responsibility of the caller to eventually free any
  155397. ** such buffer using sqlite3_free().
  155398. **
  155399. ** Otherwise, if no error occurs, this function returns SQLITE_OK if the
  155400. ** update has been partially applied, or SQLITE_DONE if it has been
  155401. ** completely applied.
  155402. */
  155403. SQLITE_API int sqlite3rbu_close(sqlite3rbu *pRbu, char **pzErrmsg);
  155404. /*
  155405. ** Return the total number of key-value operations (inserts, deletes or
  155406. ** updates) that have been performed on the target database since the
  155407. ** current RBU update was started.
  155408. */
  155409. SQLITE_API sqlite3_int64 sqlite3rbu_progress(sqlite3rbu *pRbu);
  155410. /*
  155411. ** Obtain permyriadage (permyriadage is to 10000 as percentage is to 100)
  155412. ** progress indications for the two stages of an RBU update. This API may
  155413. ** be useful for driving GUI progress indicators and similar.
  155414. **
  155415. ** An RBU update is divided into two stages:
  155416. **
  155417. ** * Stage 1, in which changes are accumulated in an oal/wal file, and
  155418. ** * Stage 2, in which the contents of the wal file are copied into the
  155419. ** main database.
  155420. **
  155421. ** The update is visible to non-RBU clients during stage 2. During stage 1
  155422. ** non-RBU reader clients may see the original database.
  155423. **
  155424. ** If this API is called during stage 2 of the update, output variable
  155425. ** (*pnOne) is set to 10000 to indicate that stage 1 has finished and (*pnTwo)
  155426. ** to a value between 0 and 10000 to indicate the permyriadage progress of
  155427. ** stage 2. A value of 5000 indicates that stage 2 is half finished,
  155428. ** 9000 indicates that it is 90% finished, and so on.
  155429. **
  155430. ** If this API is called during stage 1 of the update, output variable
  155431. ** (*pnTwo) is set to 0 to indicate that stage 2 has not yet started. The
  155432. ** value to which (*pnOne) is set depends on whether or not the RBU
  155433. ** database contains an "rbu_count" table. The rbu_count table, if it
  155434. ** exists, must contain the same columns as the following:
  155435. **
  155436. ** CREATE TABLE rbu_count(tbl TEXT PRIMARY KEY, cnt INTEGER) WITHOUT ROWID;
  155437. **
  155438. ** There must be one row in the table for each source (data_xxx) table within
  155439. ** the RBU database. The 'tbl' column should contain the name of the source
  155440. ** table. The 'cnt' column should contain the number of rows within the
  155441. ** source table.
  155442. **
  155443. ** If the rbu_count table is present and populated correctly and this
  155444. ** API is called during stage 1, the *pnOne output variable is set to the
  155445. ** permyriadage progress of the same stage. If the rbu_count table does
  155446. ** not exist, then (*pnOne) is set to -1 during stage 1. If the rbu_count
  155447. ** table exists but is not correctly populated, the value of the *pnOne
  155448. ** output variable during stage 1 is undefined.
  155449. */
  155450. SQLITE_API void sqlite3rbu_bp_progress(sqlite3rbu *pRbu, int *pnOne, int *pnTwo);
  155451. /*
  155452. ** Obtain an indication as to the current stage of an RBU update or vacuum.
  155453. ** This function always returns one of the SQLITE_RBU_STATE_XXX constants
  155454. ** defined in this file. Return values should be interpreted as follows:
  155455. **
  155456. ** SQLITE_RBU_STATE_OAL:
  155457. ** RBU is currently building a *-oal file. The next call to sqlite3rbu_step()
  155458. ** may either add further data to the *-oal file, or compute data that will
  155459. ** be added by a subsequent call.
  155460. **
  155461. ** SQLITE_RBU_STATE_MOVE:
  155462. ** RBU has finished building the *-oal file. The next call to sqlite3rbu_step()
  155463. ** will move the *-oal file to the equivalent *-wal path. If the current
  155464. ** operation is an RBU update, then the updated version of the database
  155465. ** file will become visible to ordinary SQLite clients following the next
  155466. ** call to sqlite3rbu_step().
  155467. **
  155468. ** SQLITE_RBU_STATE_CHECKPOINT:
  155469. ** RBU is currently performing an incremental checkpoint. The next call to
  155470. ** sqlite3rbu_step() will copy a page of data from the *-wal file into
  155471. ** the target database file.
  155472. **
  155473. ** SQLITE_RBU_STATE_DONE:
  155474. ** The RBU operation has finished. Any subsequent calls to sqlite3rbu_step()
  155475. ** will immediately return SQLITE_DONE.
  155476. **
  155477. ** SQLITE_RBU_STATE_ERROR:
  155478. ** An error has occurred. Any subsequent calls to sqlite3rbu_step() will
  155479. ** immediately return the SQLite error code associated with the error.
  155480. */
  155481. #define SQLITE_RBU_STATE_OAL 1
  155482. #define SQLITE_RBU_STATE_MOVE 2
  155483. #define SQLITE_RBU_STATE_CHECKPOINT 3
  155484. #define SQLITE_RBU_STATE_DONE 4
  155485. #define SQLITE_RBU_STATE_ERROR 5
  155486. SQLITE_API int sqlite3rbu_state(sqlite3rbu *pRbu);
  155487. /*
  155488. ** Create an RBU VFS named zName that accesses the underlying file-system
  155489. ** via existing VFS zParent. Or, if the zParent parameter is passed NULL,
  155490. ** then the new RBU VFS uses the default system VFS to access the file-system.
  155491. ** The new object is registered as a non-default VFS with SQLite before
  155492. ** returning.
  155493. **
  155494. ** Part of the RBU implementation uses a custom VFS object. Usually, this
  155495. ** object is created and deleted automatically by RBU.
  155496. **
  155497. ** The exception is for applications that also use zipvfs. In this case,
  155498. ** the custom VFS must be explicitly created by the user before the RBU
  155499. ** handle is opened. The RBU VFS should be installed so that the zipvfs
  155500. ** VFS uses the RBU VFS, which in turn uses any other VFS layers in use
  155501. ** (for example multiplexor) to access the file-system. For example,
  155502. ** to assemble an RBU enabled VFS stack that uses both zipvfs and
  155503. ** multiplexor (error checking omitted):
  155504. **
  155505. ** // Create a VFS named "multiplex" (not the default).
  155506. ** sqlite3_multiplex_initialize(0, 0);
  155507. **
  155508. ** // Create an rbu VFS named "rbu" that uses multiplexor. If the
  155509. ** // second argument were replaced with NULL, the "rbu" VFS would
  155510. ** // access the file-system via the system default VFS, bypassing the
  155511. ** // multiplexor.
  155512. ** sqlite3rbu_create_vfs("rbu", "multiplex");
  155513. **
  155514. ** // Create a zipvfs VFS named "zipvfs" that uses rbu.
  155515. ** zipvfs_create_vfs_v3("zipvfs", "rbu", 0, xCompressorAlgorithmDetector);
  155516. **
  155517. ** // Make zipvfs the default VFS.
  155518. ** sqlite3_vfs_register(sqlite3_vfs_find("zipvfs"), 1);
  155519. **
  155520. ** Because the default VFS created above includes a RBU functionality, it
  155521. ** may be used by RBU clients. Attempting to use RBU with a zipvfs VFS stack
  155522. ** that does not include the RBU layer results in an error.
  155523. **
  155524. ** The overhead of adding the "rbu" VFS to the system is negligible for
  155525. ** non-RBU users. There is no harm in an application accessing the
  155526. ** file-system via "rbu" all the time, even if it only uses RBU functionality
  155527. ** occasionally.
  155528. */
  155529. SQLITE_API int sqlite3rbu_create_vfs(const char *zName, const char *zParent);
  155530. /*
  155531. ** Deregister and destroy an RBU vfs created by an earlier call to
  155532. ** sqlite3rbu_create_vfs().
  155533. **
  155534. ** VFS objects are not reference counted. If a VFS object is destroyed
  155535. ** before all database handles that use it have been closed, the results
  155536. ** are undefined.
  155537. */
  155538. SQLITE_API void sqlite3rbu_destroy_vfs(const char *zName);
  155539. #if 0
  155540. } /* end of the 'extern "C"' block */
  155541. #endif
  155542. #endif /* _SQLITE3RBU_H */
  155543. /************** End of sqlite3rbu.h ******************************************/
  155544. /************** Continuing where we left off in sqlite3rbu.c *****************/
  155545. #if defined(_WIN32_WCE)
  155546. /* #include "windows.h" */
  155547. #endif
  155548. /* Maximum number of prepared UPDATE statements held by this module */
  155549. #define SQLITE_RBU_UPDATE_CACHESIZE 16
  155550. /*
  155551. ** Swap two objects of type TYPE.
  155552. */
  155553. #if !defined(SQLITE_AMALGAMATION)
  155554. # define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
  155555. #endif
  155556. /*
  155557. ** The rbu_state table is used to save the state of a partially applied
  155558. ** update so that it can be resumed later. The table consists of integer
  155559. ** keys mapped to values as follows:
  155560. **
  155561. ** RBU_STATE_STAGE:
  155562. ** May be set to integer values 1, 2, 4 or 5. As follows:
  155563. ** 1: the *-rbu file is currently under construction.
  155564. ** 2: the *-rbu file has been constructed, but not yet moved
  155565. ** to the *-wal path.
  155566. ** 4: the checkpoint is underway.
  155567. ** 5: the rbu update has been checkpointed.
  155568. **
  155569. ** RBU_STATE_TBL:
  155570. ** Only valid if STAGE==1. The target database name of the table
  155571. ** currently being written.
  155572. **
  155573. ** RBU_STATE_IDX:
  155574. ** Only valid if STAGE==1. The target database name of the index
  155575. ** currently being written, or NULL if the main table is currently being
  155576. ** updated.
  155577. **
  155578. ** RBU_STATE_ROW:
  155579. ** Only valid if STAGE==1. Number of rows already processed for the current
  155580. ** table/index.
  155581. **
  155582. ** RBU_STATE_PROGRESS:
  155583. ** Trbul number of sqlite3rbu_step() calls made so far as part of this
  155584. ** rbu update.
  155585. **
  155586. ** RBU_STATE_CKPT:
  155587. ** Valid if STAGE==4. The 64-bit checksum associated with the wal-index
  155588. ** header created by recovering the *-wal file. This is used to detect
  155589. ** cases when another client appends frames to the *-wal file in the
  155590. ** middle of an incremental checkpoint (an incremental checkpoint cannot
  155591. ** be continued if this happens).
  155592. **
  155593. ** RBU_STATE_COOKIE:
  155594. ** Valid if STAGE==1. The current change-counter cookie value in the
  155595. ** target db file.
  155596. **
  155597. ** RBU_STATE_OALSZ:
  155598. ** Valid if STAGE==1. The size in bytes of the *-oal file.
  155599. */
  155600. #define RBU_STATE_STAGE 1
  155601. #define RBU_STATE_TBL 2
  155602. #define RBU_STATE_IDX 3
  155603. #define RBU_STATE_ROW 4
  155604. #define RBU_STATE_PROGRESS 5
  155605. #define RBU_STATE_CKPT 6
  155606. #define RBU_STATE_COOKIE 7
  155607. #define RBU_STATE_OALSZ 8
  155608. #define RBU_STATE_PHASEONESTEP 9
  155609. #define RBU_STAGE_OAL 1
  155610. #define RBU_STAGE_MOVE 2
  155611. #define RBU_STAGE_CAPTURE 3
  155612. #define RBU_STAGE_CKPT 4
  155613. #define RBU_STAGE_DONE 5
  155614. #define RBU_CREATE_STATE \
  155615. "CREATE TABLE IF NOT EXISTS %s.rbu_state(k INTEGER PRIMARY KEY, v)"
  155616. typedef struct RbuFrame RbuFrame;
  155617. typedef struct RbuObjIter RbuObjIter;
  155618. typedef struct RbuState RbuState;
  155619. typedef struct rbu_vfs rbu_vfs;
  155620. typedef struct rbu_file rbu_file;
  155621. typedef struct RbuUpdateStmt RbuUpdateStmt;
  155622. #if !defined(SQLITE_AMALGAMATION)
  155623. typedef unsigned int u32;
  155624. typedef unsigned short u16;
  155625. typedef unsigned char u8;
  155626. typedef sqlite3_int64 i64;
  155627. #endif
  155628. /*
  155629. ** These values must match the values defined in wal.c for the equivalent
  155630. ** locks. These are not magic numbers as they are part of the SQLite file
  155631. ** format.
  155632. */
  155633. #define WAL_LOCK_WRITE 0
  155634. #define WAL_LOCK_CKPT 1
  155635. #define WAL_LOCK_READ0 3
  155636. #define SQLITE_FCNTL_RBUCNT 5149216
  155637. /*
  155638. ** A structure to store values read from the rbu_state table in memory.
  155639. */
  155640. struct RbuState {
  155641. int eStage;
  155642. char *zTbl;
  155643. char *zIdx;
  155644. i64 iWalCksum;
  155645. int nRow;
  155646. i64 nProgress;
  155647. u32 iCookie;
  155648. i64 iOalSz;
  155649. i64 nPhaseOneStep;
  155650. };
  155651. struct RbuUpdateStmt {
  155652. char *zMask; /* Copy of update mask used with pUpdate */
  155653. sqlite3_stmt *pUpdate; /* Last update statement (or NULL) */
  155654. RbuUpdateStmt *pNext;
  155655. };
  155656. /*
  155657. ** An iterator of this type is used to iterate through all objects in
  155658. ** the target database that require updating. For each such table, the
  155659. ** iterator visits, in order:
  155660. **
  155661. ** * the table itself,
  155662. ** * each index of the table (zero or more points to visit), and
  155663. ** * a special "cleanup table" state.
  155664. **
  155665. ** abIndexed:
  155666. ** If the table has no indexes on it, abIndexed is set to NULL. Otherwise,
  155667. ** it points to an array of flags nTblCol elements in size. The flag is
  155668. ** set for each column that is either a part of the PK or a part of an
  155669. ** index. Or clear otherwise.
  155670. **
  155671. */
  155672. struct RbuObjIter {
  155673. sqlite3_stmt *pTblIter; /* Iterate through tables */
  155674. sqlite3_stmt *pIdxIter; /* Index iterator */
  155675. int nTblCol; /* Size of azTblCol[] array */
  155676. char **azTblCol; /* Array of unquoted target column names */
  155677. char **azTblType; /* Array of target column types */
  155678. int *aiSrcOrder; /* src table col -> target table col */
  155679. u8 *abTblPk; /* Array of flags, set on target PK columns */
  155680. u8 *abNotNull; /* Array of flags, set on NOT NULL columns */
  155681. u8 *abIndexed; /* Array of flags, set on indexed & PK cols */
  155682. int eType; /* Table type - an RBU_PK_XXX value */
  155683. /* Output variables. zTbl==0 implies EOF. */
  155684. int bCleanup; /* True in "cleanup" state */
  155685. const char *zTbl; /* Name of target db table */
  155686. const char *zDataTbl; /* Name of rbu db table (or null) */
  155687. const char *zIdx; /* Name of target db index (or null) */
  155688. int iTnum; /* Root page of current object */
  155689. int iPkTnum; /* If eType==EXTERNAL, root of PK index */
  155690. int bUnique; /* Current index is unique */
  155691. int nIndex; /* Number of aux. indexes on table zTbl */
  155692. /* Statements created by rbuObjIterPrepareAll() */
  155693. int nCol; /* Number of columns in current object */
  155694. sqlite3_stmt *pSelect; /* Source data */
  155695. sqlite3_stmt *pInsert; /* Statement for INSERT operations */
  155696. sqlite3_stmt *pDelete; /* Statement for DELETE ops */
  155697. sqlite3_stmt *pTmpInsert; /* Insert into rbu_tmp_$zDataTbl */
  155698. /* Last UPDATE used (for PK b-tree updates only), or NULL. */
  155699. RbuUpdateStmt *pRbuUpdate;
  155700. };
  155701. /*
  155702. ** Values for RbuObjIter.eType
  155703. **
  155704. ** 0: Table does not exist (error)
  155705. ** 1: Table has an implicit rowid.
  155706. ** 2: Table has an explicit IPK column.
  155707. ** 3: Table has an external PK index.
  155708. ** 4: Table is WITHOUT ROWID.
  155709. ** 5: Table is a virtual table.
  155710. */
  155711. #define RBU_PK_NOTABLE 0
  155712. #define RBU_PK_NONE 1
  155713. #define RBU_PK_IPK 2
  155714. #define RBU_PK_EXTERNAL 3
  155715. #define RBU_PK_WITHOUT_ROWID 4
  155716. #define RBU_PK_VTAB 5
  155717. /*
  155718. ** Within the RBU_STAGE_OAL stage, each call to sqlite3rbu_step() performs
  155719. ** one of the following operations.
  155720. */
  155721. #define RBU_INSERT 1 /* Insert on a main table b-tree */
  155722. #define RBU_DELETE 2 /* Delete a row from a main table b-tree */
  155723. #define RBU_REPLACE 3 /* Delete and then insert a row */
  155724. #define RBU_IDX_DELETE 4 /* Delete a row from an aux. index b-tree */
  155725. #define RBU_IDX_INSERT 5 /* Insert on an aux. index b-tree */
  155726. #define RBU_UPDATE 6 /* Update a row in a main table b-tree */
  155727. /*
  155728. ** A single step of an incremental checkpoint - frame iWalFrame of the wal
  155729. ** file should be copied to page iDbPage of the database file.
  155730. */
  155731. struct RbuFrame {
  155732. u32 iDbPage;
  155733. u32 iWalFrame;
  155734. };
  155735. /*
  155736. ** RBU handle.
  155737. **
  155738. ** nPhaseOneStep:
  155739. ** If the RBU database contains an rbu_count table, this value is set to
  155740. ** a running estimate of the number of b-tree operations required to
  155741. ** finish populating the *-oal file. This allows the sqlite3_bp_progress()
  155742. ** API to calculate the permyriadage progress of populating the *-oal file
  155743. ** using the formula:
  155744. **
  155745. ** permyriadage = (10000 * nProgress) / nPhaseOneStep
  155746. **
  155747. ** nPhaseOneStep is initialized to the sum of:
  155748. **
  155749. ** nRow * (nIndex + 1)
  155750. **
  155751. ** for all source tables in the RBU database, where nRow is the number
  155752. ** of rows in the source table and nIndex the number of indexes on the
  155753. ** corresponding target database table.
  155754. **
  155755. ** This estimate is accurate if the RBU update consists entirely of
  155756. ** INSERT operations. However, it is inaccurate if:
  155757. **
  155758. ** * the RBU update contains any UPDATE operations. If the PK specified
  155759. ** for an UPDATE operation does not exist in the target table, then
  155760. ** no b-tree operations are required on index b-trees. Or if the
  155761. ** specified PK does exist, then (nIndex*2) such operations are
  155762. ** required (one delete and one insert on each index b-tree).
  155763. **
  155764. ** * the RBU update contains any DELETE operations for which the specified
  155765. ** PK does not exist. In this case no operations are required on index
  155766. ** b-trees.
  155767. **
  155768. ** * the RBU update contains REPLACE operations. These are similar to
  155769. ** UPDATE operations.
  155770. **
  155771. ** nPhaseOneStep is updated to account for the conditions above during the
  155772. ** first pass of each source table. The updated nPhaseOneStep value is
  155773. ** stored in the rbu_state table if the RBU update is suspended.
  155774. */
  155775. struct sqlite3rbu {
  155776. int eStage; /* Value of RBU_STATE_STAGE field */
  155777. sqlite3 *dbMain; /* target database handle */
  155778. sqlite3 *dbRbu; /* rbu database handle */
  155779. char *zTarget; /* Path to target db */
  155780. char *zRbu; /* Path to rbu db */
  155781. char *zState; /* Path to state db (or NULL if zRbu) */
  155782. char zStateDb[5]; /* Db name for state ("stat" or "main") */
  155783. int rc; /* Value returned by last rbu_step() call */
  155784. char *zErrmsg; /* Error message if rc!=SQLITE_OK */
  155785. int nStep; /* Rows processed for current object */
  155786. int nProgress; /* Rows processed for all objects */
  155787. RbuObjIter objiter; /* Iterator for skipping through tbl/idx */
  155788. const char *zVfsName; /* Name of automatically created rbu vfs */
  155789. rbu_file *pTargetFd; /* File handle open on target db */
  155790. i64 iOalSz;
  155791. i64 nPhaseOneStep;
  155792. /* The following state variables are used as part of the incremental
  155793. ** checkpoint stage (eStage==RBU_STAGE_CKPT). See comments surrounding
  155794. ** function rbuSetupCheckpoint() for details. */
  155795. u32 iMaxFrame; /* Largest iWalFrame value in aFrame[] */
  155796. u32 mLock;
  155797. int nFrame; /* Entries in aFrame[] array */
  155798. int nFrameAlloc; /* Allocated size of aFrame[] array */
  155799. RbuFrame *aFrame;
  155800. int pgsz;
  155801. u8 *aBuf;
  155802. i64 iWalCksum;
  155803. /* Used in RBU vacuum mode only */
  155804. int nRbu; /* Number of RBU VFS in the stack */
  155805. rbu_file *pRbuFd; /* Fd for main db of dbRbu */
  155806. };
  155807. /*
  155808. ** An rbu VFS is implemented using an instance of this structure.
  155809. */
  155810. struct rbu_vfs {
  155811. sqlite3_vfs base; /* rbu VFS shim methods */
  155812. sqlite3_vfs *pRealVfs; /* Underlying VFS */
  155813. sqlite3_mutex *mutex; /* Mutex to protect pMain */
  155814. rbu_file *pMain; /* Linked list of main db files */
  155815. };
  155816. /*
  155817. ** Each file opened by an rbu VFS is represented by an instance of
  155818. ** the following structure.
  155819. */
  155820. struct rbu_file {
  155821. sqlite3_file base; /* sqlite3_file methods */
  155822. sqlite3_file *pReal; /* Underlying file handle */
  155823. rbu_vfs *pRbuVfs; /* Pointer to the rbu_vfs object */
  155824. sqlite3rbu *pRbu; /* Pointer to rbu object (rbu target only) */
  155825. int openFlags; /* Flags this file was opened with */
  155826. u32 iCookie; /* Cookie value for main db files */
  155827. u8 iWriteVer; /* "write-version" value for main db files */
  155828. u8 bNolock; /* True to fail EXCLUSIVE locks */
  155829. int nShm; /* Number of entries in apShm[] array */
  155830. char **apShm; /* Array of mmap'd *-shm regions */
  155831. char *zDel; /* Delete this when closing file */
  155832. const char *zWal; /* Wal filename for this main db file */
  155833. rbu_file *pWalFd; /* Wal file descriptor for this main db */
  155834. rbu_file *pMainNext; /* Next MAIN_DB file */
  155835. };
  155836. /*
  155837. ** True for an RBU vacuum handle, or false otherwise.
  155838. */
  155839. #define rbuIsVacuum(p) ((p)->zTarget==0)
  155840. /*************************************************************************
  155841. ** The following three functions, found below:
  155842. **
  155843. ** rbuDeltaGetInt()
  155844. ** rbuDeltaChecksum()
  155845. ** rbuDeltaApply()
  155846. **
  155847. ** are lifted from the fossil source code (http://fossil-scm.org). They
  155848. ** are used to implement the scalar SQL function rbu_fossil_delta().
  155849. */
  155850. /*
  155851. ** Read bytes from *pz and convert them into a positive integer. When
  155852. ** finished, leave *pz pointing to the first character past the end of
  155853. ** the integer. The *pLen parameter holds the length of the string
  155854. ** in *pz and is decremented once for each character in the integer.
  155855. */
  155856. static unsigned int rbuDeltaGetInt(const char **pz, int *pLen){
  155857. static const signed char zValue[] = {
  155858. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  155859. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  155860. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  155861. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1, -1, -1, -1,
  155862. -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  155863. 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, 36,
  155864. -1, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51,
  155865. 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, -1, -1, -1, 63, -1,
  155866. };
  155867. unsigned int v = 0;
  155868. int c;
  155869. unsigned char *z = (unsigned char*)*pz;
  155870. unsigned char *zStart = z;
  155871. while( (c = zValue[0x7f&*(z++)])>=0 ){
  155872. v = (v<<6) + c;
  155873. }
  155874. z--;
  155875. *pLen -= z - zStart;
  155876. *pz = (char*)z;
  155877. return v;
  155878. }
  155879. /*
  155880. ** Compute a 32-bit checksum on the N-byte buffer. Return the result.
  155881. */
  155882. static unsigned int rbuDeltaChecksum(const char *zIn, size_t N){
  155883. const unsigned char *z = (const unsigned char *)zIn;
  155884. unsigned sum0 = 0;
  155885. unsigned sum1 = 0;
  155886. unsigned sum2 = 0;
  155887. unsigned sum3 = 0;
  155888. while(N >= 16){
  155889. sum0 += ((unsigned)z[0] + z[4] + z[8] + z[12]);
  155890. sum1 += ((unsigned)z[1] + z[5] + z[9] + z[13]);
  155891. sum2 += ((unsigned)z[2] + z[6] + z[10]+ z[14]);
  155892. sum3 += ((unsigned)z[3] + z[7] + z[11]+ z[15]);
  155893. z += 16;
  155894. N -= 16;
  155895. }
  155896. while(N >= 4){
  155897. sum0 += z[0];
  155898. sum1 += z[1];
  155899. sum2 += z[2];
  155900. sum3 += z[3];
  155901. z += 4;
  155902. N -= 4;
  155903. }
  155904. sum3 += (sum2 << 8) + (sum1 << 16) + (sum0 << 24);
  155905. switch(N){
  155906. case 3: sum3 += (z[2] << 8);
  155907. case 2: sum3 += (z[1] << 16);
  155908. case 1: sum3 += (z[0] << 24);
  155909. default: ;
  155910. }
  155911. return sum3;
  155912. }
  155913. /*
  155914. ** Apply a delta.
  155915. **
  155916. ** The output buffer should be big enough to hold the whole output
  155917. ** file and a NUL terminator at the end. The delta_output_size()
  155918. ** routine will determine this size for you.
  155919. **
  155920. ** The delta string should be null-terminated. But the delta string
  155921. ** may contain embedded NUL characters (if the input and output are
  155922. ** binary files) so we also have to pass in the length of the delta in
  155923. ** the lenDelta parameter.
  155924. **
  155925. ** This function returns the size of the output file in bytes (excluding
  155926. ** the final NUL terminator character). Except, if the delta string is
  155927. ** malformed or intended for use with a source file other than zSrc,
  155928. ** then this routine returns -1.
  155929. **
  155930. ** Refer to the delta_create() documentation above for a description
  155931. ** of the delta file format.
  155932. */
  155933. static int rbuDeltaApply(
  155934. const char *zSrc, /* The source or pattern file */
  155935. int lenSrc, /* Length of the source file */
  155936. const char *zDelta, /* Delta to apply to the pattern */
  155937. int lenDelta, /* Length of the delta */
  155938. char *zOut /* Write the output into this preallocated buffer */
  155939. ){
  155940. unsigned int limit;
  155941. unsigned int total = 0;
  155942. #ifndef FOSSIL_OMIT_DELTA_CKSUM_TEST
  155943. char *zOrigOut = zOut;
  155944. #endif
  155945. limit = rbuDeltaGetInt(&zDelta, &lenDelta);
  155946. if( *zDelta!='\n' ){
  155947. /* ERROR: size integer not terminated by "\n" */
  155948. return -1;
  155949. }
  155950. zDelta++; lenDelta--;
  155951. while( *zDelta && lenDelta>0 ){
  155952. unsigned int cnt, ofst;
  155953. cnt = rbuDeltaGetInt(&zDelta, &lenDelta);
  155954. switch( zDelta[0] ){
  155955. case '@': {
  155956. zDelta++; lenDelta--;
  155957. ofst = rbuDeltaGetInt(&zDelta, &lenDelta);
  155958. if( lenDelta>0 && zDelta[0]!=',' ){
  155959. /* ERROR: copy command not terminated by ',' */
  155960. return -1;
  155961. }
  155962. zDelta++; lenDelta--;
  155963. total += cnt;
  155964. if( total>limit ){
  155965. /* ERROR: copy exceeds output file size */
  155966. return -1;
  155967. }
  155968. if( (int)(ofst+cnt) > lenSrc ){
  155969. /* ERROR: copy extends past end of input */
  155970. return -1;
  155971. }
  155972. memcpy(zOut, &zSrc[ofst], cnt);
  155973. zOut += cnt;
  155974. break;
  155975. }
  155976. case ':': {
  155977. zDelta++; lenDelta--;
  155978. total += cnt;
  155979. if( total>limit ){
  155980. /* ERROR: insert command gives an output larger than predicted */
  155981. return -1;
  155982. }
  155983. if( (int)cnt>lenDelta ){
  155984. /* ERROR: insert count exceeds size of delta */
  155985. return -1;
  155986. }
  155987. memcpy(zOut, zDelta, cnt);
  155988. zOut += cnt;
  155989. zDelta += cnt;
  155990. lenDelta -= cnt;
  155991. break;
  155992. }
  155993. case ';': {
  155994. zDelta++; lenDelta--;
  155995. zOut[0] = 0;
  155996. #ifndef FOSSIL_OMIT_DELTA_CKSUM_TEST
  155997. if( cnt!=rbuDeltaChecksum(zOrigOut, total) ){
  155998. /* ERROR: bad checksum */
  155999. return -1;
  156000. }
  156001. #endif
  156002. if( total!=limit ){
  156003. /* ERROR: generated size does not match predicted size */
  156004. return -1;
  156005. }
  156006. return total;
  156007. }
  156008. default: {
  156009. /* ERROR: unknown delta operator */
  156010. return -1;
  156011. }
  156012. }
  156013. }
  156014. /* ERROR: unterminated delta */
  156015. return -1;
  156016. }
  156017. static int rbuDeltaOutputSize(const char *zDelta, int lenDelta){
  156018. int size;
  156019. size = rbuDeltaGetInt(&zDelta, &lenDelta);
  156020. if( *zDelta!='\n' ){
  156021. /* ERROR: size integer not terminated by "\n" */
  156022. return -1;
  156023. }
  156024. return size;
  156025. }
  156026. /*
  156027. ** End of code taken from fossil.
  156028. *************************************************************************/
  156029. /*
  156030. ** Implementation of SQL scalar function rbu_fossil_delta().
  156031. **
  156032. ** This function applies a fossil delta patch to a blob. Exactly two
  156033. ** arguments must be passed to this function. The first is the blob to
  156034. ** patch and the second the patch to apply. If no error occurs, this
  156035. ** function returns the patched blob.
  156036. */
  156037. static void rbuFossilDeltaFunc(
  156038. sqlite3_context *context,
  156039. int argc,
  156040. sqlite3_value **argv
  156041. ){
  156042. const char *aDelta;
  156043. int nDelta;
  156044. const char *aOrig;
  156045. int nOrig;
  156046. int nOut;
  156047. int nOut2;
  156048. char *aOut;
  156049. assert( argc==2 );
  156050. nOrig = sqlite3_value_bytes(argv[0]);
  156051. aOrig = (const char*)sqlite3_value_blob(argv[0]);
  156052. nDelta = sqlite3_value_bytes(argv[1]);
  156053. aDelta = (const char*)sqlite3_value_blob(argv[1]);
  156054. /* Figure out the size of the output */
  156055. nOut = rbuDeltaOutputSize(aDelta, nDelta);
  156056. if( nOut<0 ){
  156057. sqlite3_result_error(context, "corrupt fossil delta", -1);
  156058. return;
  156059. }
  156060. aOut = sqlite3_malloc(nOut+1);
  156061. if( aOut==0 ){
  156062. sqlite3_result_error_nomem(context);
  156063. }else{
  156064. nOut2 = rbuDeltaApply(aOrig, nOrig, aDelta, nDelta, aOut);
  156065. if( nOut2!=nOut ){
  156066. sqlite3_result_error(context, "corrupt fossil delta", -1);
  156067. }else{
  156068. sqlite3_result_blob(context, aOut, nOut, sqlite3_free);
  156069. }
  156070. }
  156071. }
  156072. /*
  156073. ** Prepare the SQL statement in buffer zSql against database handle db.
  156074. ** If successful, set *ppStmt to point to the new statement and return
  156075. ** SQLITE_OK.
  156076. **
  156077. ** Otherwise, if an error does occur, set *ppStmt to NULL and return
  156078. ** an SQLite error code. Additionally, set output variable *pzErrmsg to
  156079. ** point to a buffer containing an error message. It is the responsibility
  156080. ** of the caller to (eventually) free this buffer using sqlite3_free().
  156081. */
  156082. static int prepareAndCollectError(
  156083. sqlite3 *db,
  156084. sqlite3_stmt **ppStmt,
  156085. char **pzErrmsg,
  156086. const char *zSql
  156087. ){
  156088. int rc = sqlite3_prepare_v2(db, zSql, -1, ppStmt, 0);
  156089. if( rc!=SQLITE_OK ){
  156090. *pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  156091. *ppStmt = 0;
  156092. }
  156093. return rc;
  156094. }
  156095. /*
  156096. ** Reset the SQL statement passed as the first argument. Return a copy
  156097. ** of the value returned by sqlite3_reset().
  156098. **
  156099. ** If an error has occurred, then set *pzErrmsg to point to a buffer
  156100. ** containing an error message. It is the responsibility of the caller
  156101. ** to eventually free this buffer using sqlite3_free().
  156102. */
  156103. static int resetAndCollectError(sqlite3_stmt *pStmt, char **pzErrmsg){
  156104. int rc = sqlite3_reset(pStmt);
  156105. if( rc!=SQLITE_OK ){
  156106. *pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(sqlite3_db_handle(pStmt)));
  156107. }
  156108. return rc;
  156109. }
  156110. /*
  156111. ** Unless it is NULL, argument zSql points to a buffer allocated using
  156112. ** sqlite3_malloc containing an SQL statement. This function prepares the SQL
  156113. ** statement against database db and frees the buffer. If statement
  156114. ** compilation is successful, *ppStmt is set to point to the new statement
  156115. ** handle and SQLITE_OK is returned.
  156116. **
  156117. ** Otherwise, if an error occurs, *ppStmt is set to NULL and an error code
  156118. ** returned. In this case, *pzErrmsg may also be set to point to an error
  156119. ** message. It is the responsibility of the caller to free this error message
  156120. ** buffer using sqlite3_free().
  156121. **
  156122. ** If argument zSql is NULL, this function assumes that an OOM has occurred.
  156123. ** In this case SQLITE_NOMEM is returned and *ppStmt set to NULL.
  156124. */
  156125. static int prepareFreeAndCollectError(
  156126. sqlite3 *db,
  156127. sqlite3_stmt **ppStmt,
  156128. char **pzErrmsg,
  156129. char *zSql
  156130. ){
  156131. int rc;
  156132. assert( *pzErrmsg==0 );
  156133. if( zSql==0 ){
  156134. rc = SQLITE_NOMEM;
  156135. *ppStmt = 0;
  156136. }else{
  156137. rc = prepareAndCollectError(db, ppStmt, pzErrmsg, zSql);
  156138. sqlite3_free(zSql);
  156139. }
  156140. return rc;
  156141. }
  156142. /*
  156143. ** Free the RbuObjIter.azTblCol[] and RbuObjIter.abTblPk[] arrays allocated
  156144. ** by an earlier call to rbuObjIterCacheTableInfo().
  156145. */
  156146. static void rbuObjIterFreeCols(RbuObjIter *pIter){
  156147. int i;
  156148. for(i=0; i<pIter->nTblCol; i++){
  156149. sqlite3_free(pIter->azTblCol[i]);
  156150. sqlite3_free(pIter->azTblType[i]);
  156151. }
  156152. sqlite3_free(pIter->azTblCol);
  156153. pIter->azTblCol = 0;
  156154. pIter->azTblType = 0;
  156155. pIter->aiSrcOrder = 0;
  156156. pIter->abTblPk = 0;
  156157. pIter->abNotNull = 0;
  156158. pIter->nTblCol = 0;
  156159. pIter->eType = 0; /* Invalid value */
  156160. }
  156161. /*
  156162. ** Finalize all statements and free all allocations that are specific to
  156163. ** the current object (table/index pair).
  156164. */
  156165. static void rbuObjIterClearStatements(RbuObjIter *pIter){
  156166. RbuUpdateStmt *pUp;
  156167. sqlite3_finalize(pIter->pSelect);
  156168. sqlite3_finalize(pIter->pInsert);
  156169. sqlite3_finalize(pIter->pDelete);
  156170. sqlite3_finalize(pIter->pTmpInsert);
  156171. pUp = pIter->pRbuUpdate;
  156172. while( pUp ){
  156173. RbuUpdateStmt *pTmp = pUp->pNext;
  156174. sqlite3_finalize(pUp->pUpdate);
  156175. sqlite3_free(pUp);
  156176. pUp = pTmp;
  156177. }
  156178. pIter->pSelect = 0;
  156179. pIter->pInsert = 0;
  156180. pIter->pDelete = 0;
  156181. pIter->pRbuUpdate = 0;
  156182. pIter->pTmpInsert = 0;
  156183. pIter->nCol = 0;
  156184. }
  156185. /*
  156186. ** Clean up any resources allocated as part of the iterator object passed
  156187. ** as the only argument.
  156188. */
  156189. static void rbuObjIterFinalize(RbuObjIter *pIter){
  156190. rbuObjIterClearStatements(pIter);
  156191. sqlite3_finalize(pIter->pTblIter);
  156192. sqlite3_finalize(pIter->pIdxIter);
  156193. rbuObjIterFreeCols(pIter);
  156194. memset(pIter, 0, sizeof(RbuObjIter));
  156195. }
  156196. /*
  156197. ** Advance the iterator to the next position.
  156198. **
  156199. ** If no error occurs, SQLITE_OK is returned and the iterator is left
  156200. ** pointing to the next entry. Otherwise, an error code and message is
  156201. ** left in the RBU handle passed as the first argument. A copy of the
  156202. ** error code is returned.
  156203. */
  156204. static int rbuObjIterNext(sqlite3rbu *p, RbuObjIter *pIter){
  156205. int rc = p->rc;
  156206. if( rc==SQLITE_OK ){
  156207. /* Free any SQLite statements used while processing the previous object */
  156208. rbuObjIterClearStatements(pIter);
  156209. if( pIter->zIdx==0 ){
  156210. rc = sqlite3_exec(p->dbMain,
  156211. "DROP TRIGGER IF EXISTS temp.rbu_insert_tr;"
  156212. "DROP TRIGGER IF EXISTS temp.rbu_update1_tr;"
  156213. "DROP TRIGGER IF EXISTS temp.rbu_update2_tr;"
  156214. "DROP TRIGGER IF EXISTS temp.rbu_delete_tr;"
  156215. , 0, 0, &p->zErrmsg
  156216. );
  156217. }
  156218. if( rc==SQLITE_OK ){
  156219. if( pIter->bCleanup ){
  156220. rbuObjIterFreeCols(pIter);
  156221. pIter->bCleanup = 0;
  156222. rc = sqlite3_step(pIter->pTblIter);
  156223. if( rc!=SQLITE_ROW ){
  156224. rc = resetAndCollectError(pIter->pTblIter, &p->zErrmsg);
  156225. pIter->zTbl = 0;
  156226. }else{
  156227. pIter->zTbl = (const char*)sqlite3_column_text(pIter->pTblIter, 0);
  156228. pIter->zDataTbl = (const char*)sqlite3_column_text(pIter->pTblIter,1);
  156229. rc = (pIter->zDataTbl && pIter->zTbl) ? SQLITE_OK : SQLITE_NOMEM;
  156230. }
  156231. }else{
  156232. if( pIter->zIdx==0 ){
  156233. sqlite3_stmt *pIdx = pIter->pIdxIter;
  156234. rc = sqlite3_bind_text(pIdx, 1, pIter->zTbl, -1, SQLITE_STATIC);
  156235. }
  156236. if( rc==SQLITE_OK ){
  156237. rc = sqlite3_step(pIter->pIdxIter);
  156238. if( rc!=SQLITE_ROW ){
  156239. rc = resetAndCollectError(pIter->pIdxIter, &p->zErrmsg);
  156240. pIter->bCleanup = 1;
  156241. pIter->zIdx = 0;
  156242. }else{
  156243. pIter->zIdx = (const char*)sqlite3_column_text(pIter->pIdxIter, 0);
  156244. pIter->iTnum = sqlite3_column_int(pIter->pIdxIter, 1);
  156245. pIter->bUnique = sqlite3_column_int(pIter->pIdxIter, 2);
  156246. rc = pIter->zIdx ? SQLITE_OK : SQLITE_NOMEM;
  156247. }
  156248. }
  156249. }
  156250. }
  156251. }
  156252. if( rc!=SQLITE_OK ){
  156253. rbuObjIterFinalize(pIter);
  156254. p->rc = rc;
  156255. }
  156256. return rc;
  156257. }
  156258. /*
  156259. ** The implementation of the rbu_target_name() SQL function. This function
  156260. ** accepts one or two arguments. The first argument is the name of a table -
  156261. ** the name of a table in the RBU database. The second, if it is present, is 1
  156262. ** for a view or 0 for a table.
  156263. **
  156264. ** For a non-vacuum RBU handle, if the table name matches the pattern:
  156265. **
  156266. ** data[0-9]_<name>
  156267. **
  156268. ** where <name> is any sequence of 1 or more characters, <name> is returned.
  156269. ** Otherwise, if the only argument does not match the above pattern, an SQL
  156270. ** NULL is returned.
  156271. **
  156272. ** "data_t1" -> "t1"
  156273. ** "data0123_t2" -> "t2"
  156274. ** "dataAB_t3" -> NULL
  156275. **
  156276. ** For an rbu vacuum handle, a copy of the first argument is returned if
  156277. ** the second argument is either missing or 0 (not a view).
  156278. */
  156279. static void rbuTargetNameFunc(
  156280. sqlite3_context *pCtx,
  156281. int argc,
  156282. sqlite3_value **argv
  156283. ){
  156284. sqlite3rbu *p = sqlite3_user_data(pCtx);
  156285. const char *zIn;
  156286. assert( argc==1 || argc==2 );
  156287. zIn = (const char*)sqlite3_value_text(argv[0]);
  156288. if( zIn ){
  156289. if( rbuIsVacuum(p) ){
  156290. if( argc==1 || 0==sqlite3_value_int(argv[1]) ){
  156291. sqlite3_result_text(pCtx, zIn, -1, SQLITE_STATIC);
  156292. }
  156293. }else{
  156294. if( strlen(zIn)>4 && memcmp("data", zIn, 4)==0 ){
  156295. int i;
  156296. for(i=4; zIn[i]>='0' && zIn[i]<='9'; i++);
  156297. if( zIn[i]=='_' && zIn[i+1] ){
  156298. sqlite3_result_text(pCtx, &zIn[i+1], -1, SQLITE_STATIC);
  156299. }
  156300. }
  156301. }
  156302. }
  156303. }
  156304. /*
  156305. ** Initialize the iterator structure passed as the second argument.
  156306. **
  156307. ** If no error occurs, SQLITE_OK is returned and the iterator is left
  156308. ** pointing to the first entry. Otherwise, an error code and message is
  156309. ** left in the RBU handle passed as the first argument. A copy of the
  156310. ** error code is returned.
  156311. */
  156312. static int rbuObjIterFirst(sqlite3rbu *p, RbuObjIter *pIter){
  156313. int rc;
  156314. memset(pIter, 0, sizeof(RbuObjIter));
  156315. rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pTblIter, &p->zErrmsg,
  156316. sqlite3_mprintf(
  156317. "SELECT rbu_target_name(name, type='view') AS target, name "
  156318. "FROM sqlite_master "
  156319. "WHERE type IN ('table', 'view') AND target IS NOT NULL "
  156320. " %s "
  156321. "ORDER BY name"
  156322. , rbuIsVacuum(p) ? "AND rootpage!=0 AND rootpage IS NOT NULL" : ""));
  156323. if( rc==SQLITE_OK ){
  156324. rc = prepareAndCollectError(p->dbMain, &pIter->pIdxIter, &p->zErrmsg,
  156325. "SELECT name, rootpage, sql IS NULL OR substr(8, 6)=='UNIQUE' "
  156326. " FROM main.sqlite_master "
  156327. " WHERE type='index' AND tbl_name = ?"
  156328. );
  156329. }
  156330. pIter->bCleanup = 1;
  156331. p->rc = rc;
  156332. return rbuObjIterNext(p, pIter);
  156333. }
  156334. /*
  156335. ** This is a wrapper around "sqlite3_mprintf(zFmt, ...)". If an OOM occurs,
  156336. ** an error code is stored in the RBU handle passed as the first argument.
  156337. **
  156338. ** If an error has already occurred (p->rc is already set to something other
  156339. ** than SQLITE_OK), then this function returns NULL without modifying the
  156340. ** stored error code. In this case it still calls sqlite3_free() on any
  156341. ** printf() parameters associated with %z conversions.
  156342. */
  156343. static char *rbuMPrintf(sqlite3rbu *p, const char *zFmt, ...){
  156344. char *zSql = 0;
  156345. va_list ap;
  156346. va_start(ap, zFmt);
  156347. zSql = sqlite3_vmprintf(zFmt, ap);
  156348. if( p->rc==SQLITE_OK ){
  156349. if( zSql==0 ) p->rc = SQLITE_NOMEM;
  156350. }else{
  156351. sqlite3_free(zSql);
  156352. zSql = 0;
  156353. }
  156354. va_end(ap);
  156355. return zSql;
  156356. }
  156357. /*
  156358. ** Argument zFmt is a sqlite3_mprintf() style format string. The trailing
  156359. ** arguments are the usual subsitution values. This function performs
  156360. ** the printf() style substitutions and executes the result as an SQL
  156361. ** statement on the RBU handles database.
  156362. **
  156363. ** If an error occurs, an error code and error message is stored in the
  156364. ** RBU handle. If an error has already occurred when this function is
  156365. ** called, it is a no-op.
  156366. */
  156367. static int rbuMPrintfExec(sqlite3rbu *p, sqlite3 *db, const char *zFmt, ...){
  156368. va_list ap;
  156369. char *zSql;
  156370. va_start(ap, zFmt);
  156371. zSql = sqlite3_vmprintf(zFmt, ap);
  156372. if( p->rc==SQLITE_OK ){
  156373. if( zSql==0 ){
  156374. p->rc = SQLITE_NOMEM;
  156375. }else{
  156376. p->rc = sqlite3_exec(db, zSql, 0, 0, &p->zErrmsg);
  156377. }
  156378. }
  156379. sqlite3_free(zSql);
  156380. va_end(ap);
  156381. return p->rc;
  156382. }
  156383. /*
  156384. ** Attempt to allocate and return a pointer to a zeroed block of nByte
  156385. ** bytes.
  156386. **
  156387. ** If an error (i.e. an OOM condition) occurs, return NULL and leave an
  156388. ** error code in the rbu handle passed as the first argument. Or, if an
  156389. ** error has already occurred when this function is called, return NULL
  156390. ** immediately without attempting the allocation or modifying the stored
  156391. ** error code.
  156392. */
  156393. static void *rbuMalloc(sqlite3rbu *p, int nByte){
  156394. void *pRet = 0;
  156395. if( p->rc==SQLITE_OK ){
  156396. assert( nByte>0 );
  156397. pRet = sqlite3_malloc64(nByte);
  156398. if( pRet==0 ){
  156399. p->rc = SQLITE_NOMEM;
  156400. }else{
  156401. memset(pRet, 0, nByte);
  156402. }
  156403. }
  156404. return pRet;
  156405. }
  156406. /*
  156407. ** Allocate and zero the pIter->azTblCol[] and abTblPk[] arrays so that
  156408. ** there is room for at least nCol elements. If an OOM occurs, store an
  156409. ** error code in the RBU handle passed as the first argument.
  156410. */
  156411. static void rbuAllocateIterArrays(sqlite3rbu *p, RbuObjIter *pIter, int nCol){
  156412. int nByte = (2*sizeof(char*) + sizeof(int) + 3*sizeof(u8)) * nCol;
  156413. char **azNew;
  156414. azNew = (char**)rbuMalloc(p, nByte);
  156415. if( azNew ){
  156416. pIter->azTblCol = azNew;
  156417. pIter->azTblType = &azNew[nCol];
  156418. pIter->aiSrcOrder = (int*)&pIter->azTblType[nCol];
  156419. pIter->abTblPk = (u8*)&pIter->aiSrcOrder[nCol];
  156420. pIter->abNotNull = (u8*)&pIter->abTblPk[nCol];
  156421. pIter->abIndexed = (u8*)&pIter->abNotNull[nCol];
  156422. }
  156423. }
  156424. /*
  156425. ** The first argument must be a nul-terminated string. This function
  156426. ** returns a copy of the string in memory obtained from sqlite3_malloc().
  156427. ** It is the responsibility of the caller to eventually free this memory
  156428. ** using sqlite3_free().
  156429. **
  156430. ** If an OOM condition is encountered when attempting to allocate memory,
  156431. ** output variable (*pRc) is set to SQLITE_NOMEM before returning. Otherwise,
  156432. ** if the allocation succeeds, (*pRc) is left unchanged.
  156433. */
  156434. static char *rbuStrndup(const char *zStr, int *pRc){
  156435. char *zRet = 0;
  156436. assert( *pRc==SQLITE_OK );
  156437. if( zStr ){
  156438. size_t nCopy = strlen(zStr) + 1;
  156439. zRet = (char*)sqlite3_malloc64(nCopy);
  156440. if( zRet ){
  156441. memcpy(zRet, zStr, nCopy);
  156442. }else{
  156443. *pRc = SQLITE_NOMEM;
  156444. }
  156445. }
  156446. return zRet;
  156447. }
  156448. /*
  156449. ** Finalize the statement passed as the second argument.
  156450. **
  156451. ** If the sqlite3_finalize() call indicates that an error occurs, and the
  156452. ** rbu handle error code is not already set, set the error code and error
  156453. ** message accordingly.
  156454. */
  156455. static void rbuFinalize(sqlite3rbu *p, sqlite3_stmt *pStmt){
  156456. sqlite3 *db = sqlite3_db_handle(pStmt);
  156457. int rc = sqlite3_finalize(pStmt);
  156458. if( p->rc==SQLITE_OK && rc!=SQLITE_OK ){
  156459. p->rc = rc;
  156460. p->zErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  156461. }
  156462. }
  156463. /* Determine the type of a table.
  156464. **
  156465. ** peType is of type (int*), a pointer to an output parameter of type
  156466. ** (int). This call sets the output parameter as follows, depending
  156467. ** on the type of the table specified by parameters dbName and zTbl.
  156468. **
  156469. ** RBU_PK_NOTABLE: No such table.
  156470. ** RBU_PK_NONE: Table has an implicit rowid.
  156471. ** RBU_PK_IPK: Table has an explicit IPK column.
  156472. ** RBU_PK_EXTERNAL: Table has an external PK index.
  156473. ** RBU_PK_WITHOUT_ROWID: Table is WITHOUT ROWID.
  156474. ** RBU_PK_VTAB: Table is a virtual table.
  156475. **
  156476. ** Argument *piPk is also of type (int*), and also points to an output
  156477. ** parameter. Unless the table has an external primary key index
  156478. ** (i.e. unless *peType is set to 3), then *piPk is set to zero. Or,
  156479. ** if the table does have an external primary key index, then *piPk
  156480. ** is set to the root page number of the primary key index before
  156481. ** returning.
  156482. **
  156483. ** ALGORITHM:
  156484. **
  156485. ** if( no entry exists in sqlite_master ){
  156486. ** return RBU_PK_NOTABLE
  156487. ** }else if( sql for the entry starts with "CREATE VIRTUAL" ){
  156488. ** return RBU_PK_VTAB
  156489. ** }else if( "PRAGMA index_list()" for the table contains a "pk" index ){
  156490. ** if( the index that is the pk exists in sqlite_master ){
  156491. ** *piPK = rootpage of that index.
  156492. ** return RBU_PK_EXTERNAL
  156493. ** }else{
  156494. ** return RBU_PK_WITHOUT_ROWID
  156495. ** }
  156496. ** }else if( "PRAGMA table_info()" lists one or more "pk" columns ){
  156497. ** return RBU_PK_IPK
  156498. ** }else{
  156499. ** return RBU_PK_NONE
  156500. ** }
  156501. */
  156502. static void rbuTableType(
  156503. sqlite3rbu *p,
  156504. const char *zTab,
  156505. int *peType,
  156506. int *piTnum,
  156507. int *piPk
  156508. ){
  156509. /*
  156510. ** 0) SELECT count(*) FROM sqlite_master where name=%Q AND IsVirtual(%Q)
  156511. ** 1) PRAGMA index_list = ?
  156512. ** 2) SELECT count(*) FROM sqlite_master where name=%Q
  156513. ** 3) PRAGMA table_info = ?
  156514. */
  156515. sqlite3_stmt *aStmt[4] = {0, 0, 0, 0};
  156516. *peType = RBU_PK_NOTABLE;
  156517. *piPk = 0;
  156518. assert( p->rc==SQLITE_OK );
  156519. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[0], &p->zErrmsg,
  156520. sqlite3_mprintf(
  156521. "SELECT (sql LIKE 'create virtual%%'), rootpage"
  156522. " FROM sqlite_master"
  156523. " WHERE name=%Q", zTab
  156524. ));
  156525. if( p->rc!=SQLITE_OK || sqlite3_step(aStmt[0])!=SQLITE_ROW ){
  156526. /* Either an error, or no such table. */
  156527. goto rbuTableType_end;
  156528. }
  156529. if( sqlite3_column_int(aStmt[0], 0) ){
  156530. *peType = RBU_PK_VTAB; /* virtual table */
  156531. goto rbuTableType_end;
  156532. }
  156533. *piTnum = sqlite3_column_int(aStmt[0], 1);
  156534. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[1], &p->zErrmsg,
  156535. sqlite3_mprintf("PRAGMA index_list=%Q",zTab)
  156536. );
  156537. if( p->rc ) goto rbuTableType_end;
  156538. while( sqlite3_step(aStmt[1])==SQLITE_ROW ){
  156539. const u8 *zOrig = sqlite3_column_text(aStmt[1], 3);
  156540. const u8 *zIdx = sqlite3_column_text(aStmt[1], 1);
  156541. if( zOrig && zIdx && zOrig[0]=='p' ){
  156542. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[2], &p->zErrmsg,
  156543. sqlite3_mprintf(
  156544. "SELECT rootpage FROM sqlite_master WHERE name = %Q", zIdx
  156545. ));
  156546. if( p->rc==SQLITE_OK ){
  156547. if( sqlite3_step(aStmt[2])==SQLITE_ROW ){
  156548. *piPk = sqlite3_column_int(aStmt[2], 0);
  156549. *peType = RBU_PK_EXTERNAL;
  156550. }else{
  156551. *peType = RBU_PK_WITHOUT_ROWID;
  156552. }
  156553. }
  156554. goto rbuTableType_end;
  156555. }
  156556. }
  156557. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[3], &p->zErrmsg,
  156558. sqlite3_mprintf("PRAGMA table_info=%Q",zTab)
  156559. );
  156560. if( p->rc==SQLITE_OK ){
  156561. while( sqlite3_step(aStmt[3])==SQLITE_ROW ){
  156562. if( sqlite3_column_int(aStmt[3],5)>0 ){
  156563. *peType = RBU_PK_IPK; /* explicit IPK column */
  156564. goto rbuTableType_end;
  156565. }
  156566. }
  156567. *peType = RBU_PK_NONE;
  156568. }
  156569. rbuTableType_end: {
  156570. unsigned int i;
  156571. for(i=0; i<sizeof(aStmt)/sizeof(aStmt[0]); i++){
  156572. rbuFinalize(p, aStmt[i]);
  156573. }
  156574. }
  156575. }
  156576. /*
  156577. ** This is a helper function for rbuObjIterCacheTableInfo(). It populates
  156578. ** the pIter->abIndexed[] array.
  156579. */
  156580. static void rbuObjIterCacheIndexedCols(sqlite3rbu *p, RbuObjIter *pIter){
  156581. sqlite3_stmt *pList = 0;
  156582. int bIndex = 0;
  156583. if( p->rc==SQLITE_OK ){
  156584. memcpy(pIter->abIndexed, pIter->abTblPk, sizeof(u8)*pIter->nTblCol);
  156585. p->rc = prepareFreeAndCollectError(p->dbMain, &pList, &p->zErrmsg,
  156586. sqlite3_mprintf("PRAGMA main.index_list = %Q", pIter->zTbl)
  156587. );
  156588. }
  156589. pIter->nIndex = 0;
  156590. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pList) ){
  156591. const char *zIdx = (const char*)sqlite3_column_text(pList, 1);
  156592. sqlite3_stmt *pXInfo = 0;
  156593. if( zIdx==0 ) break;
  156594. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  156595. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  156596. );
  156597. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  156598. int iCid = sqlite3_column_int(pXInfo, 1);
  156599. if( iCid>=0 ) pIter->abIndexed[iCid] = 1;
  156600. }
  156601. rbuFinalize(p, pXInfo);
  156602. bIndex = 1;
  156603. pIter->nIndex++;
  156604. }
  156605. if( pIter->eType==RBU_PK_WITHOUT_ROWID ){
  156606. /* "PRAGMA index_list" includes the main PK b-tree */
  156607. pIter->nIndex--;
  156608. }
  156609. rbuFinalize(p, pList);
  156610. if( bIndex==0 ) pIter->abIndexed = 0;
  156611. }
  156612. /*
  156613. ** If they are not already populated, populate the pIter->azTblCol[],
  156614. ** pIter->abTblPk[], pIter->nTblCol and pIter->bRowid variables according to
  156615. ** the table (not index) that the iterator currently points to.
  156616. **
  156617. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. If
  156618. ** an error does occur, an error code and error message are also left in
  156619. ** the RBU handle.
  156620. */
  156621. static int rbuObjIterCacheTableInfo(sqlite3rbu *p, RbuObjIter *pIter){
  156622. if( pIter->azTblCol==0 ){
  156623. sqlite3_stmt *pStmt = 0;
  156624. int nCol = 0;
  156625. int i; /* for() loop iterator variable */
  156626. int bRbuRowid = 0; /* If input table has column "rbu_rowid" */
  156627. int iOrder = 0;
  156628. int iTnum = 0;
  156629. /* Figure out the type of table this step will deal with. */
  156630. assert( pIter->eType==0 );
  156631. rbuTableType(p, pIter->zTbl, &pIter->eType, &iTnum, &pIter->iPkTnum);
  156632. if( p->rc==SQLITE_OK && pIter->eType==RBU_PK_NOTABLE ){
  156633. p->rc = SQLITE_ERROR;
  156634. p->zErrmsg = sqlite3_mprintf("no such table: %s", pIter->zTbl);
  156635. }
  156636. if( p->rc ) return p->rc;
  156637. if( pIter->zIdx==0 ) pIter->iTnum = iTnum;
  156638. assert( pIter->eType==RBU_PK_NONE || pIter->eType==RBU_PK_IPK
  156639. || pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_WITHOUT_ROWID
  156640. || pIter->eType==RBU_PK_VTAB
  156641. );
  156642. /* Populate the azTblCol[] and nTblCol variables based on the columns
  156643. ** of the input table. Ignore any input table columns that begin with
  156644. ** "rbu_". */
  156645. p->rc = prepareFreeAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  156646. sqlite3_mprintf("SELECT * FROM '%q'", pIter->zDataTbl)
  156647. );
  156648. if( p->rc==SQLITE_OK ){
  156649. nCol = sqlite3_column_count(pStmt);
  156650. rbuAllocateIterArrays(p, pIter, nCol);
  156651. }
  156652. for(i=0; p->rc==SQLITE_OK && i<nCol; i++){
  156653. const char *zName = (const char*)sqlite3_column_name(pStmt, i);
  156654. if( sqlite3_strnicmp("rbu_", zName, 4) ){
  156655. char *zCopy = rbuStrndup(zName, &p->rc);
  156656. pIter->aiSrcOrder[pIter->nTblCol] = pIter->nTblCol;
  156657. pIter->azTblCol[pIter->nTblCol++] = zCopy;
  156658. }
  156659. else if( 0==sqlite3_stricmp("rbu_rowid", zName) ){
  156660. bRbuRowid = 1;
  156661. }
  156662. }
  156663. sqlite3_finalize(pStmt);
  156664. pStmt = 0;
  156665. if( p->rc==SQLITE_OK
  156666. && rbuIsVacuum(p)==0
  156667. && bRbuRowid!=(pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE)
  156668. ){
  156669. p->rc = SQLITE_ERROR;
  156670. p->zErrmsg = sqlite3_mprintf(
  156671. "table %q %s rbu_rowid column", pIter->zDataTbl,
  156672. (bRbuRowid ? "may not have" : "requires")
  156673. );
  156674. }
  156675. /* Check that all non-HIDDEN columns in the destination table are also
  156676. ** present in the input table. Populate the abTblPk[], azTblType[] and
  156677. ** aiTblOrder[] arrays at the same time. */
  156678. if( p->rc==SQLITE_OK ){
  156679. p->rc = prepareFreeAndCollectError(p->dbMain, &pStmt, &p->zErrmsg,
  156680. sqlite3_mprintf("PRAGMA table_info(%Q)", pIter->zTbl)
  156681. );
  156682. }
  156683. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  156684. const char *zName = (const char*)sqlite3_column_text(pStmt, 1);
  156685. if( zName==0 ) break; /* An OOM - finalize() below returns S_NOMEM */
  156686. for(i=iOrder; i<pIter->nTblCol; i++){
  156687. if( 0==strcmp(zName, pIter->azTblCol[i]) ) break;
  156688. }
  156689. if( i==pIter->nTblCol ){
  156690. p->rc = SQLITE_ERROR;
  156691. p->zErrmsg = sqlite3_mprintf("column missing from %q: %s",
  156692. pIter->zDataTbl, zName
  156693. );
  156694. }else{
  156695. int iPk = sqlite3_column_int(pStmt, 5);
  156696. int bNotNull = sqlite3_column_int(pStmt, 3);
  156697. const char *zType = (const char*)sqlite3_column_text(pStmt, 2);
  156698. if( i!=iOrder ){
  156699. SWAP(int, pIter->aiSrcOrder[i], pIter->aiSrcOrder[iOrder]);
  156700. SWAP(char*, pIter->azTblCol[i], pIter->azTblCol[iOrder]);
  156701. }
  156702. pIter->azTblType[iOrder] = rbuStrndup(zType, &p->rc);
  156703. pIter->abTblPk[iOrder] = (iPk!=0);
  156704. pIter->abNotNull[iOrder] = (u8)bNotNull || (iPk!=0);
  156705. iOrder++;
  156706. }
  156707. }
  156708. rbuFinalize(p, pStmt);
  156709. rbuObjIterCacheIndexedCols(p, pIter);
  156710. assert( pIter->eType!=RBU_PK_VTAB || pIter->abIndexed==0 );
  156711. assert( pIter->eType!=RBU_PK_VTAB || pIter->nIndex==0 );
  156712. }
  156713. return p->rc;
  156714. }
  156715. /*
  156716. ** This function constructs and returns a pointer to a nul-terminated
  156717. ** string containing some SQL clause or list based on one or more of the
  156718. ** column names currently stored in the pIter->azTblCol[] array.
  156719. */
  156720. static char *rbuObjIterGetCollist(
  156721. sqlite3rbu *p, /* RBU object */
  156722. RbuObjIter *pIter /* Object iterator for column names */
  156723. ){
  156724. char *zList = 0;
  156725. const char *zSep = "";
  156726. int i;
  156727. for(i=0; i<pIter->nTblCol; i++){
  156728. const char *z = pIter->azTblCol[i];
  156729. zList = rbuMPrintf(p, "%z%s\"%w\"", zList, zSep, z);
  156730. zSep = ", ";
  156731. }
  156732. return zList;
  156733. }
  156734. /*
  156735. ** This function is used to create a SELECT list (the list of SQL
  156736. ** expressions that follows a SELECT keyword) for a SELECT statement
  156737. ** used to read from an data_xxx or rbu_tmp_xxx table while updating the
  156738. ** index object currently indicated by the iterator object passed as the
  156739. ** second argument. A "PRAGMA index_xinfo = <idxname>" statement is used
  156740. ** to obtain the required information.
  156741. **
  156742. ** If the index is of the following form:
  156743. **
  156744. ** CREATE INDEX i1 ON t1(c, b COLLATE nocase);
  156745. **
  156746. ** and "t1" is a table with an explicit INTEGER PRIMARY KEY column
  156747. ** "ipk", the returned string is:
  156748. **
  156749. ** "`c` COLLATE 'BINARY', `b` COLLATE 'NOCASE', `ipk` COLLATE 'BINARY'"
  156750. **
  156751. ** As well as the returned string, three other malloc'd strings are
  156752. ** returned via output parameters. As follows:
  156753. **
  156754. ** pzImposterCols: ...
  156755. ** pzImposterPk: ...
  156756. ** pzWhere: ...
  156757. */
  156758. static char *rbuObjIterGetIndexCols(
  156759. sqlite3rbu *p, /* RBU object */
  156760. RbuObjIter *pIter, /* Object iterator for column names */
  156761. char **pzImposterCols, /* OUT: Columns for imposter table */
  156762. char **pzImposterPk, /* OUT: Imposter PK clause */
  156763. char **pzWhere, /* OUT: WHERE clause */
  156764. int *pnBind /* OUT: Trbul number of columns */
  156765. ){
  156766. int rc = p->rc; /* Error code */
  156767. int rc2; /* sqlite3_finalize() return code */
  156768. char *zRet = 0; /* String to return */
  156769. char *zImpCols = 0; /* String to return via *pzImposterCols */
  156770. char *zImpPK = 0; /* String to return via *pzImposterPK */
  156771. char *zWhere = 0; /* String to return via *pzWhere */
  156772. int nBind = 0; /* Value to return via *pnBind */
  156773. const char *zCom = ""; /* Set to ", " later on */
  156774. const char *zAnd = ""; /* Set to " AND " later on */
  156775. sqlite3_stmt *pXInfo = 0; /* PRAGMA index_xinfo = ? */
  156776. if( rc==SQLITE_OK ){
  156777. assert( p->zErrmsg==0 );
  156778. rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  156779. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", pIter->zIdx)
  156780. );
  156781. }
  156782. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  156783. int iCid = sqlite3_column_int(pXInfo, 1);
  156784. int bDesc = sqlite3_column_int(pXInfo, 3);
  156785. const char *zCollate = (const char*)sqlite3_column_text(pXInfo, 4);
  156786. const char *zCol;
  156787. const char *zType;
  156788. if( iCid<0 ){
  156789. /* An integer primary key. If the table has an explicit IPK, use
  156790. ** its name. Otherwise, use "rbu_rowid". */
  156791. if( pIter->eType==RBU_PK_IPK ){
  156792. int i;
  156793. for(i=0; pIter->abTblPk[i]==0; i++);
  156794. assert( i<pIter->nTblCol );
  156795. zCol = pIter->azTblCol[i];
  156796. }else if( rbuIsVacuum(p) ){
  156797. zCol = "_rowid_";
  156798. }else{
  156799. zCol = "rbu_rowid";
  156800. }
  156801. zType = "INTEGER";
  156802. }else{
  156803. zCol = pIter->azTblCol[iCid];
  156804. zType = pIter->azTblType[iCid];
  156805. }
  156806. zRet = sqlite3_mprintf("%z%s\"%w\" COLLATE %Q", zRet, zCom, zCol, zCollate);
  156807. if( pIter->bUnique==0 || sqlite3_column_int(pXInfo, 5) ){
  156808. const char *zOrder = (bDesc ? " DESC" : "");
  156809. zImpPK = sqlite3_mprintf("%z%s\"rbu_imp_%d%w\"%s",
  156810. zImpPK, zCom, nBind, zCol, zOrder
  156811. );
  156812. }
  156813. zImpCols = sqlite3_mprintf("%z%s\"rbu_imp_%d%w\" %s COLLATE %Q",
  156814. zImpCols, zCom, nBind, zCol, zType, zCollate
  156815. );
  156816. zWhere = sqlite3_mprintf(
  156817. "%z%s\"rbu_imp_%d%w\" IS ?", zWhere, zAnd, nBind, zCol
  156818. );
  156819. if( zRet==0 || zImpPK==0 || zImpCols==0 || zWhere==0 ) rc = SQLITE_NOMEM;
  156820. zCom = ", ";
  156821. zAnd = " AND ";
  156822. nBind++;
  156823. }
  156824. rc2 = sqlite3_finalize(pXInfo);
  156825. if( rc==SQLITE_OK ) rc = rc2;
  156826. if( rc!=SQLITE_OK ){
  156827. sqlite3_free(zRet);
  156828. sqlite3_free(zImpCols);
  156829. sqlite3_free(zImpPK);
  156830. sqlite3_free(zWhere);
  156831. zRet = 0;
  156832. zImpCols = 0;
  156833. zImpPK = 0;
  156834. zWhere = 0;
  156835. p->rc = rc;
  156836. }
  156837. *pzImposterCols = zImpCols;
  156838. *pzImposterPk = zImpPK;
  156839. *pzWhere = zWhere;
  156840. *pnBind = nBind;
  156841. return zRet;
  156842. }
  156843. /*
  156844. ** Assuming the current table columns are "a", "b" and "c", and the zObj
  156845. ** paramter is passed "old", return a string of the form:
  156846. **
  156847. ** "old.a, old.b, old.b"
  156848. **
  156849. ** With the column names escaped.
  156850. **
  156851. ** For tables with implicit rowids - RBU_PK_EXTERNAL and RBU_PK_NONE, append
  156852. ** the text ", old._rowid_" to the returned value.
  156853. */
  156854. static char *rbuObjIterGetOldlist(
  156855. sqlite3rbu *p,
  156856. RbuObjIter *pIter,
  156857. const char *zObj
  156858. ){
  156859. char *zList = 0;
  156860. if( p->rc==SQLITE_OK && pIter->abIndexed ){
  156861. const char *zS = "";
  156862. int i;
  156863. for(i=0; i<pIter->nTblCol; i++){
  156864. if( pIter->abIndexed[i] ){
  156865. const char *zCol = pIter->azTblCol[i];
  156866. zList = sqlite3_mprintf("%z%s%s.\"%w\"", zList, zS, zObj, zCol);
  156867. }else{
  156868. zList = sqlite3_mprintf("%z%sNULL", zList, zS);
  156869. }
  156870. zS = ", ";
  156871. if( zList==0 ){
  156872. p->rc = SQLITE_NOMEM;
  156873. break;
  156874. }
  156875. }
  156876. /* For a table with implicit rowids, append "old._rowid_" to the list. */
  156877. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  156878. zList = rbuMPrintf(p, "%z, %s._rowid_", zList, zObj);
  156879. }
  156880. }
  156881. return zList;
  156882. }
  156883. /*
  156884. ** Return an expression that can be used in a WHERE clause to match the
  156885. ** primary key of the current table. For example, if the table is:
  156886. **
  156887. ** CREATE TABLE t1(a, b, c, PRIMARY KEY(b, c));
  156888. **
  156889. ** Return the string:
  156890. **
  156891. ** "b = ?1 AND c = ?2"
  156892. */
  156893. static char *rbuObjIterGetWhere(
  156894. sqlite3rbu *p,
  156895. RbuObjIter *pIter
  156896. ){
  156897. char *zList = 0;
  156898. if( pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE ){
  156899. zList = rbuMPrintf(p, "_rowid_ = ?%d", pIter->nTblCol+1);
  156900. }else if( pIter->eType==RBU_PK_EXTERNAL ){
  156901. const char *zSep = "";
  156902. int i;
  156903. for(i=0; i<pIter->nTblCol; i++){
  156904. if( pIter->abTblPk[i] ){
  156905. zList = rbuMPrintf(p, "%z%sc%d=?%d", zList, zSep, i, i+1);
  156906. zSep = " AND ";
  156907. }
  156908. }
  156909. zList = rbuMPrintf(p,
  156910. "_rowid_ = (SELECT id FROM rbu_imposter2 WHERE %z)", zList
  156911. );
  156912. }else{
  156913. const char *zSep = "";
  156914. int i;
  156915. for(i=0; i<pIter->nTblCol; i++){
  156916. if( pIter->abTblPk[i] ){
  156917. const char *zCol = pIter->azTblCol[i];
  156918. zList = rbuMPrintf(p, "%z%s\"%w\"=?%d", zList, zSep, zCol, i+1);
  156919. zSep = " AND ";
  156920. }
  156921. }
  156922. }
  156923. return zList;
  156924. }
  156925. /*
  156926. ** The SELECT statement iterating through the keys for the current object
  156927. ** (p->objiter.pSelect) currently points to a valid row. However, there
  156928. ** is something wrong with the rbu_control value in the rbu_control value
  156929. ** stored in the (p->nCol+1)'th column. Set the error code and error message
  156930. ** of the RBU handle to something reflecting this.
  156931. */
  156932. static void rbuBadControlError(sqlite3rbu *p){
  156933. p->rc = SQLITE_ERROR;
  156934. p->zErrmsg = sqlite3_mprintf("invalid rbu_control value");
  156935. }
  156936. /*
  156937. ** Return a nul-terminated string containing the comma separated list of
  156938. ** assignments that should be included following the "SET" keyword of
  156939. ** an UPDATE statement used to update the table object that the iterator
  156940. ** passed as the second argument currently points to if the rbu_control
  156941. ** column of the data_xxx table entry is set to zMask.
  156942. **
  156943. ** The memory for the returned string is obtained from sqlite3_malloc().
  156944. ** It is the responsibility of the caller to eventually free it using
  156945. ** sqlite3_free().
  156946. **
  156947. ** If an OOM error is encountered when allocating space for the new
  156948. ** string, an error code is left in the rbu handle passed as the first
  156949. ** argument and NULL is returned. Or, if an error has already occurred
  156950. ** when this function is called, NULL is returned immediately, without
  156951. ** attempting the allocation or modifying the stored error code.
  156952. */
  156953. static char *rbuObjIterGetSetlist(
  156954. sqlite3rbu *p,
  156955. RbuObjIter *pIter,
  156956. const char *zMask
  156957. ){
  156958. char *zList = 0;
  156959. if( p->rc==SQLITE_OK ){
  156960. int i;
  156961. if( (int)strlen(zMask)!=pIter->nTblCol ){
  156962. rbuBadControlError(p);
  156963. }else{
  156964. const char *zSep = "";
  156965. for(i=0; i<pIter->nTblCol; i++){
  156966. char c = zMask[pIter->aiSrcOrder[i]];
  156967. if( c=='x' ){
  156968. zList = rbuMPrintf(p, "%z%s\"%w\"=?%d",
  156969. zList, zSep, pIter->azTblCol[i], i+1
  156970. );
  156971. zSep = ", ";
  156972. }
  156973. else if( c=='d' ){
  156974. zList = rbuMPrintf(p, "%z%s\"%w\"=rbu_delta(\"%w\", ?%d)",
  156975. zList, zSep, pIter->azTblCol[i], pIter->azTblCol[i], i+1
  156976. );
  156977. zSep = ", ";
  156978. }
  156979. else if( c=='f' ){
  156980. zList = rbuMPrintf(p, "%z%s\"%w\"=rbu_fossil_delta(\"%w\", ?%d)",
  156981. zList, zSep, pIter->azTblCol[i], pIter->azTblCol[i], i+1
  156982. );
  156983. zSep = ", ";
  156984. }
  156985. }
  156986. }
  156987. }
  156988. return zList;
  156989. }
  156990. /*
  156991. ** Return a nul-terminated string consisting of nByte comma separated
  156992. ** "?" expressions. For example, if nByte is 3, return a pointer to
  156993. ** a buffer containing the string "?,?,?".
  156994. **
  156995. ** The memory for the returned string is obtained from sqlite3_malloc().
  156996. ** It is the responsibility of the caller to eventually free it using
  156997. ** sqlite3_free().
  156998. **
  156999. ** If an OOM error is encountered when allocating space for the new
  157000. ** string, an error code is left in the rbu handle passed as the first
  157001. ** argument and NULL is returned. Or, if an error has already occurred
  157002. ** when this function is called, NULL is returned immediately, without
  157003. ** attempting the allocation or modifying the stored error code.
  157004. */
  157005. static char *rbuObjIterGetBindlist(sqlite3rbu *p, int nBind){
  157006. char *zRet = 0;
  157007. int nByte = nBind*2 + 1;
  157008. zRet = (char*)rbuMalloc(p, nByte);
  157009. if( zRet ){
  157010. int i;
  157011. for(i=0; i<nBind; i++){
  157012. zRet[i*2] = '?';
  157013. zRet[i*2+1] = (i+1==nBind) ? '\0' : ',';
  157014. }
  157015. }
  157016. return zRet;
  157017. }
  157018. /*
  157019. ** The iterator currently points to a table (not index) of type
  157020. ** RBU_PK_WITHOUT_ROWID. This function creates the PRIMARY KEY
  157021. ** declaration for the corresponding imposter table. For example,
  157022. ** if the iterator points to a table created as:
  157023. **
  157024. ** CREATE TABLE t1(a, b, c, PRIMARY KEY(b, a DESC)) WITHOUT ROWID
  157025. **
  157026. ** this function returns:
  157027. **
  157028. ** PRIMARY KEY("b", "a" DESC)
  157029. */
  157030. static char *rbuWithoutRowidPK(sqlite3rbu *p, RbuObjIter *pIter){
  157031. char *z = 0;
  157032. assert( pIter->zIdx==0 );
  157033. if( p->rc==SQLITE_OK ){
  157034. const char *zSep = "PRIMARY KEY(";
  157035. sqlite3_stmt *pXList = 0; /* PRAGMA index_list = (pIter->zTbl) */
  157036. sqlite3_stmt *pXInfo = 0; /* PRAGMA index_xinfo = <pk-index> */
  157037. p->rc = prepareFreeAndCollectError(p->dbMain, &pXList, &p->zErrmsg,
  157038. sqlite3_mprintf("PRAGMA main.index_list = %Q", pIter->zTbl)
  157039. );
  157040. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXList) ){
  157041. const char *zOrig = (const char*)sqlite3_column_text(pXList,3);
  157042. if( zOrig && strcmp(zOrig, "pk")==0 ){
  157043. const char *zIdx = (const char*)sqlite3_column_text(pXList,1);
  157044. if( zIdx ){
  157045. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  157046. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  157047. );
  157048. }
  157049. break;
  157050. }
  157051. }
  157052. rbuFinalize(p, pXList);
  157053. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  157054. if( sqlite3_column_int(pXInfo, 5) ){
  157055. /* int iCid = sqlite3_column_int(pXInfo, 0); */
  157056. const char *zCol = (const char*)sqlite3_column_text(pXInfo, 2);
  157057. const char *zDesc = sqlite3_column_int(pXInfo, 3) ? " DESC" : "";
  157058. z = rbuMPrintf(p, "%z%s\"%w\"%s", z, zSep, zCol, zDesc);
  157059. zSep = ", ";
  157060. }
  157061. }
  157062. z = rbuMPrintf(p, "%z)", z);
  157063. rbuFinalize(p, pXInfo);
  157064. }
  157065. return z;
  157066. }
  157067. /*
  157068. ** This function creates the second imposter table used when writing to
  157069. ** a table b-tree where the table has an external primary key. If the
  157070. ** iterator passed as the second argument does not currently point to
  157071. ** a table (not index) with an external primary key, this function is a
  157072. ** no-op.
  157073. **
  157074. ** Assuming the iterator does point to a table with an external PK, this
  157075. ** function creates a WITHOUT ROWID imposter table named "rbu_imposter2"
  157076. ** used to access that PK index. For example, if the target table is
  157077. ** declared as follows:
  157078. **
  157079. ** CREATE TABLE t1(a, b TEXT, c REAL, PRIMARY KEY(b, c));
  157080. **
  157081. ** then the imposter table schema is:
  157082. **
  157083. ** CREATE TABLE rbu_imposter2(c1 TEXT, c2 REAL, id INTEGER) WITHOUT ROWID;
  157084. **
  157085. */
  157086. static void rbuCreateImposterTable2(sqlite3rbu *p, RbuObjIter *pIter){
  157087. if( p->rc==SQLITE_OK && pIter->eType==RBU_PK_EXTERNAL ){
  157088. int tnum = pIter->iPkTnum; /* Root page of PK index */
  157089. sqlite3_stmt *pQuery = 0; /* SELECT name ... WHERE rootpage = $tnum */
  157090. const char *zIdx = 0; /* Name of PK index */
  157091. sqlite3_stmt *pXInfo = 0; /* PRAGMA main.index_xinfo = $zIdx */
  157092. const char *zComma = "";
  157093. char *zCols = 0; /* Used to build up list of table cols */
  157094. char *zPk = 0; /* Used to build up table PK declaration */
  157095. /* Figure out the name of the primary key index for the current table.
  157096. ** This is needed for the argument to "PRAGMA index_xinfo". Set
  157097. ** zIdx to point to a nul-terminated string containing this name. */
  157098. p->rc = prepareAndCollectError(p->dbMain, &pQuery, &p->zErrmsg,
  157099. "SELECT name FROM sqlite_master WHERE rootpage = ?"
  157100. );
  157101. if( p->rc==SQLITE_OK ){
  157102. sqlite3_bind_int(pQuery, 1, tnum);
  157103. if( SQLITE_ROW==sqlite3_step(pQuery) ){
  157104. zIdx = (const char*)sqlite3_column_text(pQuery, 0);
  157105. }
  157106. }
  157107. if( zIdx ){
  157108. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  157109. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  157110. );
  157111. }
  157112. rbuFinalize(p, pQuery);
  157113. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  157114. int bKey = sqlite3_column_int(pXInfo, 5);
  157115. if( bKey ){
  157116. int iCid = sqlite3_column_int(pXInfo, 1);
  157117. int bDesc = sqlite3_column_int(pXInfo, 3);
  157118. const char *zCollate = (const char*)sqlite3_column_text(pXInfo, 4);
  157119. zCols = rbuMPrintf(p, "%z%sc%d %s COLLATE %s", zCols, zComma,
  157120. iCid, pIter->azTblType[iCid], zCollate
  157121. );
  157122. zPk = rbuMPrintf(p, "%z%sc%d%s", zPk, zComma, iCid, bDesc?" DESC":"");
  157123. zComma = ", ";
  157124. }
  157125. }
  157126. zCols = rbuMPrintf(p, "%z, id INTEGER", zCols);
  157127. rbuFinalize(p, pXInfo);
  157128. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1, tnum);
  157129. rbuMPrintfExec(p, p->dbMain,
  157130. "CREATE TABLE rbu_imposter2(%z, PRIMARY KEY(%z)) WITHOUT ROWID",
  157131. zCols, zPk
  157132. );
  157133. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  157134. }
  157135. }
  157136. /*
  157137. ** If an error has already occurred when this function is called, it
  157138. ** immediately returns zero (without doing any work). Or, if an error
  157139. ** occurs during the execution of this function, it sets the error code
  157140. ** in the sqlite3rbu object indicated by the first argument and returns
  157141. ** zero.
  157142. **
  157143. ** The iterator passed as the second argument is guaranteed to point to
  157144. ** a table (not an index) when this function is called. This function
  157145. ** attempts to create any imposter table required to write to the main
  157146. ** table b-tree of the table before returning. Non-zero is returned if
  157147. ** an imposter table are created, or zero otherwise.
  157148. **
  157149. ** An imposter table is required in all cases except RBU_PK_VTAB. Only
  157150. ** virtual tables are written to directly. The imposter table has the
  157151. ** same schema as the actual target table (less any UNIQUE constraints).
  157152. ** More precisely, the "same schema" means the same columns, types,
  157153. ** collation sequences. For tables that do not have an external PRIMARY
  157154. ** KEY, it also means the same PRIMARY KEY declaration.
  157155. */
  157156. static void rbuCreateImposterTable(sqlite3rbu *p, RbuObjIter *pIter){
  157157. if( p->rc==SQLITE_OK && pIter->eType!=RBU_PK_VTAB ){
  157158. int tnum = pIter->iTnum;
  157159. const char *zComma = "";
  157160. char *zSql = 0;
  157161. int iCol;
  157162. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 1);
  157163. for(iCol=0; p->rc==SQLITE_OK && iCol<pIter->nTblCol; iCol++){
  157164. const char *zPk = "";
  157165. const char *zCol = pIter->azTblCol[iCol];
  157166. const char *zColl = 0;
  157167. p->rc = sqlite3_table_column_metadata(
  157168. p->dbMain, "main", pIter->zTbl, zCol, 0, &zColl, 0, 0, 0
  157169. );
  157170. if( pIter->eType==RBU_PK_IPK && pIter->abTblPk[iCol] ){
  157171. /* If the target table column is an "INTEGER PRIMARY KEY", add
  157172. ** "PRIMARY KEY" to the imposter table column declaration. */
  157173. zPk = "PRIMARY KEY ";
  157174. }
  157175. zSql = rbuMPrintf(p, "%z%s\"%w\" %s %sCOLLATE %s%s",
  157176. zSql, zComma, zCol, pIter->azTblType[iCol], zPk, zColl,
  157177. (pIter->abNotNull[iCol] ? " NOT NULL" : "")
  157178. );
  157179. zComma = ", ";
  157180. }
  157181. if( pIter->eType==RBU_PK_WITHOUT_ROWID ){
  157182. char *zPk = rbuWithoutRowidPK(p, pIter);
  157183. if( zPk ){
  157184. zSql = rbuMPrintf(p, "%z, %z", zSql, zPk);
  157185. }
  157186. }
  157187. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1, tnum);
  157188. rbuMPrintfExec(p, p->dbMain, "CREATE TABLE \"rbu_imp_%w\"(%z)%s",
  157189. pIter->zTbl, zSql,
  157190. (pIter->eType==RBU_PK_WITHOUT_ROWID ? " WITHOUT ROWID" : "")
  157191. );
  157192. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  157193. }
  157194. }
  157195. /*
  157196. ** Prepare a statement used to insert rows into the "rbu_tmp_xxx" table.
  157197. ** Specifically a statement of the form:
  157198. **
  157199. ** INSERT INTO rbu_tmp_xxx VALUES(?, ?, ? ...);
  157200. **
  157201. ** The number of bound variables is equal to the number of columns in
  157202. ** the target table, plus one (for the rbu_control column), plus one more
  157203. ** (for the rbu_rowid column) if the target table is an implicit IPK or
  157204. ** virtual table.
  157205. */
  157206. static void rbuObjIterPrepareTmpInsert(
  157207. sqlite3rbu *p,
  157208. RbuObjIter *pIter,
  157209. const char *zCollist,
  157210. const char *zRbuRowid
  157211. ){
  157212. int bRbuRowid = (pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE);
  157213. char *zBind = rbuObjIterGetBindlist(p, pIter->nTblCol + 1 + bRbuRowid);
  157214. if( zBind ){
  157215. assert( pIter->pTmpInsert==0 );
  157216. p->rc = prepareFreeAndCollectError(
  157217. p->dbRbu, &pIter->pTmpInsert, &p->zErrmsg, sqlite3_mprintf(
  157218. "INSERT INTO %s.'rbu_tmp_%q'(rbu_control,%s%s) VALUES(%z)",
  157219. p->zStateDb, pIter->zDataTbl, zCollist, zRbuRowid, zBind
  157220. ));
  157221. }
  157222. }
  157223. static void rbuTmpInsertFunc(
  157224. sqlite3_context *pCtx,
  157225. int nVal,
  157226. sqlite3_value **apVal
  157227. ){
  157228. sqlite3rbu *p = sqlite3_user_data(pCtx);
  157229. int rc = SQLITE_OK;
  157230. int i;
  157231. assert( sqlite3_value_int(apVal[0])!=0
  157232. || p->objiter.eType==RBU_PK_EXTERNAL
  157233. || p->objiter.eType==RBU_PK_NONE
  157234. );
  157235. if( sqlite3_value_int(apVal[0])!=0 ){
  157236. p->nPhaseOneStep += p->objiter.nIndex;
  157237. }
  157238. for(i=0; rc==SQLITE_OK && i<nVal; i++){
  157239. rc = sqlite3_bind_value(p->objiter.pTmpInsert, i+1, apVal[i]);
  157240. }
  157241. if( rc==SQLITE_OK ){
  157242. sqlite3_step(p->objiter.pTmpInsert);
  157243. rc = sqlite3_reset(p->objiter.pTmpInsert);
  157244. }
  157245. if( rc!=SQLITE_OK ){
  157246. sqlite3_result_error_code(pCtx, rc);
  157247. }
  157248. }
  157249. /*
  157250. ** Ensure that the SQLite statement handles required to update the
  157251. ** target database object currently indicated by the iterator passed
  157252. ** as the second argument are available.
  157253. */
  157254. static int rbuObjIterPrepareAll(
  157255. sqlite3rbu *p,
  157256. RbuObjIter *pIter,
  157257. int nOffset /* Add "LIMIT -1 OFFSET $nOffset" to SELECT */
  157258. ){
  157259. assert( pIter->bCleanup==0 );
  157260. if( pIter->pSelect==0 && rbuObjIterCacheTableInfo(p, pIter)==SQLITE_OK ){
  157261. const int tnum = pIter->iTnum;
  157262. char *zCollist = 0; /* List of indexed columns */
  157263. char **pz = &p->zErrmsg;
  157264. const char *zIdx = pIter->zIdx;
  157265. char *zLimit = 0;
  157266. if( nOffset ){
  157267. zLimit = sqlite3_mprintf(" LIMIT -1 OFFSET %d", nOffset);
  157268. if( !zLimit ) p->rc = SQLITE_NOMEM;
  157269. }
  157270. if( zIdx ){
  157271. const char *zTbl = pIter->zTbl;
  157272. char *zImposterCols = 0; /* Columns for imposter table */
  157273. char *zImposterPK = 0; /* Primary key declaration for imposter */
  157274. char *zWhere = 0; /* WHERE clause on PK columns */
  157275. char *zBind = 0;
  157276. int nBind = 0;
  157277. assert( pIter->eType!=RBU_PK_VTAB );
  157278. zCollist = rbuObjIterGetIndexCols(
  157279. p, pIter, &zImposterCols, &zImposterPK, &zWhere, &nBind
  157280. );
  157281. zBind = rbuObjIterGetBindlist(p, nBind);
  157282. /* Create the imposter table used to write to this index. */
  157283. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 1);
  157284. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1,tnum);
  157285. rbuMPrintfExec(p, p->dbMain,
  157286. "CREATE TABLE \"rbu_imp_%w\"( %s, PRIMARY KEY( %s ) ) WITHOUT ROWID",
  157287. zTbl, zImposterCols, zImposterPK
  157288. );
  157289. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  157290. /* Create the statement to insert index entries */
  157291. pIter->nCol = nBind;
  157292. if( p->rc==SQLITE_OK ){
  157293. p->rc = prepareFreeAndCollectError(
  157294. p->dbMain, &pIter->pInsert, &p->zErrmsg,
  157295. sqlite3_mprintf("INSERT INTO \"rbu_imp_%w\" VALUES(%s)", zTbl, zBind)
  157296. );
  157297. }
  157298. /* And to delete index entries */
  157299. if( rbuIsVacuum(p)==0 && p->rc==SQLITE_OK ){
  157300. p->rc = prepareFreeAndCollectError(
  157301. p->dbMain, &pIter->pDelete, &p->zErrmsg,
  157302. sqlite3_mprintf("DELETE FROM \"rbu_imp_%w\" WHERE %s", zTbl, zWhere)
  157303. );
  157304. }
  157305. /* Create the SELECT statement to read keys in sorted order */
  157306. if( p->rc==SQLITE_OK ){
  157307. char *zSql;
  157308. if( rbuIsVacuum(p) ){
  157309. zSql = sqlite3_mprintf(
  157310. "SELECT %s, 0 AS rbu_control FROM '%q' ORDER BY %s%s",
  157311. zCollist,
  157312. pIter->zDataTbl,
  157313. zCollist, zLimit
  157314. );
  157315. }else
  157316. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  157317. zSql = sqlite3_mprintf(
  157318. "SELECT %s, rbu_control FROM %s.'rbu_tmp_%q' ORDER BY %s%s",
  157319. zCollist, p->zStateDb, pIter->zDataTbl,
  157320. zCollist, zLimit
  157321. );
  157322. }else{
  157323. zSql = sqlite3_mprintf(
  157324. "SELECT %s, rbu_control FROM %s.'rbu_tmp_%q' "
  157325. "UNION ALL "
  157326. "SELECT %s, rbu_control FROM '%q' "
  157327. "WHERE typeof(rbu_control)='integer' AND rbu_control!=1 "
  157328. "ORDER BY %s%s",
  157329. zCollist, p->zStateDb, pIter->zDataTbl,
  157330. zCollist, pIter->zDataTbl,
  157331. zCollist, zLimit
  157332. );
  157333. }
  157334. p->rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pSelect, pz, zSql);
  157335. }
  157336. sqlite3_free(zImposterCols);
  157337. sqlite3_free(zImposterPK);
  157338. sqlite3_free(zWhere);
  157339. sqlite3_free(zBind);
  157340. }else{
  157341. int bRbuRowid = (pIter->eType==RBU_PK_VTAB)
  157342. ||(pIter->eType==RBU_PK_NONE)
  157343. ||(pIter->eType==RBU_PK_EXTERNAL && rbuIsVacuum(p));
  157344. const char *zTbl = pIter->zTbl; /* Table this step applies to */
  157345. const char *zWrite; /* Imposter table name */
  157346. char *zBindings = rbuObjIterGetBindlist(p, pIter->nTblCol + bRbuRowid);
  157347. char *zWhere = rbuObjIterGetWhere(p, pIter);
  157348. char *zOldlist = rbuObjIterGetOldlist(p, pIter, "old");
  157349. char *zNewlist = rbuObjIterGetOldlist(p, pIter, "new");
  157350. zCollist = rbuObjIterGetCollist(p, pIter);
  157351. pIter->nCol = pIter->nTblCol;
  157352. /* Create the imposter table or tables (if required). */
  157353. rbuCreateImposterTable(p, pIter);
  157354. rbuCreateImposterTable2(p, pIter);
  157355. zWrite = (pIter->eType==RBU_PK_VTAB ? "" : "rbu_imp_");
  157356. /* Create the INSERT statement to write to the target PK b-tree */
  157357. if( p->rc==SQLITE_OK ){
  157358. p->rc = prepareFreeAndCollectError(p->dbMain, &pIter->pInsert, pz,
  157359. sqlite3_mprintf(
  157360. "INSERT INTO \"%s%w\"(%s%s) VALUES(%s)",
  157361. zWrite, zTbl, zCollist, (bRbuRowid ? ", _rowid_" : ""), zBindings
  157362. )
  157363. );
  157364. }
  157365. /* Create the DELETE statement to write to the target PK b-tree.
  157366. ** Because it only performs INSERT operations, this is not required for
  157367. ** an rbu vacuum handle. */
  157368. if( rbuIsVacuum(p)==0 && p->rc==SQLITE_OK ){
  157369. p->rc = prepareFreeAndCollectError(p->dbMain, &pIter->pDelete, pz,
  157370. sqlite3_mprintf(
  157371. "DELETE FROM \"%s%w\" WHERE %s", zWrite, zTbl, zWhere
  157372. )
  157373. );
  157374. }
  157375. if( rbuIsVacuum(p)==0 && pIter->abIndexed ){
  157376. const char *zRbuRowid = "";
  157377. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  157378. zRbuRowid = ", rbu_rowid";
  157379. }
  157380. /* Create the rbu_tmp_xxx table and the triggers to populate it. */
  157381. rbuMPrintfExec(p, p->dbRbu,
  157382. "CREATE TABLE IF NOT EXISTS %s.'rbu_tmp_%q' AS "
  157383. "SELECT *%s FROM '%q' WHERE 0;"
  157384. , p->zStateDb, pIter->zDataTbl
  157385. , (pIter->eType==RBU_PK_EXTERNAL ? ", 0 AS rbu_rowid" : "")
  157386. , pIter->zDataTbl
  157387. );
  157388. rbuMPrintfExec(p, p->dbMain,
  157389. "CREATE TEMP TRIGGER rbu_delete_tr BEFORE DELETE ON \"%s%w\" "
  157390. "BEGIN "
  157391. " SELECT rbu_tmp_insert(3, %s);"
  157392. "END;"
  157393. "CREATE TEMP TRIGGER rbu_update1_tr BEFORE UPDATE ON \"%s%w\" "
  157394. "BEGIN "
  157395. " SELECT rbu_tmp_insert(3, %s);"
  157396. "END;"
  157397. "CREATE TEMP TRIGGER rbu_update2_tr AFTER UPDATE ON \"%s%w\" "
  157398. "BEGIN "
  157399. " SELECT rbu_tmp_insert(4, %s);"
  157400. "END;",
  157401. zWrite, zTbl, zOldlist,
  157402. zWrite, zTbl, zOldlist,
  157403. zWrite, zTbl, zNewlist
  157404. );
  157405. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  157406. rbuMPrintfExec(p, p->dbMain,
  157407. "CREATE TEMP TRIGGER rbu_insert_tr AFTER INSERT ON \"%s%w\" "
  157408. "BEGIN "
  157409. " SELECT rbu_tmp_insert(0, %s);"
  157410. "END;",
  157411. zWrite, zTbl, zNewlist
  157412. );
  157413. }
  157414. rbuObjIterPrepareTmpInsert(p, pIter, zCollist, zRbuRowid);
  157415. }
  157416. /* Create the SELECT statement to read keys from data_xxx */
  157417. if( p->rc==SQLITE_OK ){
  157418. const char *zRbuRowid = "";
  157419. if( bRbuRowid ){
  157420. zRbuRowid = rbuIsVacuum(p) ? ",_rowid_ " : ",rbu_rowid";
  157421. }
  157422. p->rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pSelect, pz,
  157423. sqlite3_mprintf(
  157424. "SELECT %s,%s rbu_control%s FROM '%q'%s",
  157425. zCollist,
  157426. (rbuIsVacuum(p) ? "0 AS " : ""),
  157427. zRbuRowid,
  157428. pIter->zDataTbl, zLimit
  157429. )
  157430. );
  157431. }
  157432. sqlite3_free(zWhere);
  157433. sqlite3_free(zOldlist);
  157434. sqlite3_free(zNewlist);
  157435. sqlite3_free(zBindings);
  157436. }
  157437. sqlite3_free(zCollist);
  157438. sqlite3_free(zLimit);
  157439. }
  157440. return p->rc;
  157441. }
  157442. /*
  157443. ** Set output variable *ppStmt to point to an UPDATE statement that may
  157444. ** be used to update the imposter table for the main table b-tree of the
  157445. ** table object that pIter currently points to, assuming that the
  157446. ** rbu_control column of the data_xyz table contains zMask.
  157447. **
  157448. ** If the zMask string does not specify any columns to update, then this
  157449. ** is not an error. Output variable *ppStmt is set to NULL in this case.
  157450. */
  157451. static int rbuGetUpdateStmt(
  157452. sqlite3rbu *p, /* RBU handle */
  157453. RbuObjIter *pIter, /* Object iterator */
  157454. const char *zMask, /* rbu_control value ('x.x.') */
  157455. sqlite3_stmt **ppStmt /* OUT: UPDATE statement handle */
  157456. ){
  157457. RbuUpdateStmt **pp;
  157458. RbuUpdateStmt *pUp = 0;
  157459. int nUp = 0;
  157460. /* In case an error occurs */
  157461. *ppStmt = 0;
  157462. /* Search for an existing statement. If one is found, shift it to the front
  157463. ** of the LRU queue and return immediately. Otherwise, leave nUp pointing
  157464. ** to the number of statements currently in the cache and pUp to the
  157465. ** last object in the list. */
  157466. for(pp=&pIter->pRbuUpdate; *pp; pp=&((*pp)->pNext)){
  157467. pUp = *pp;
  157468. if( strcmp(pUp->zMask, zMask)==0 ){
  157469. *pp = pUp->pNext;
  157470. pUp->pNext = pIter->pRbuUpdate;
  157471. pIter->pRbuUpdate = pUp;
  157472. *ppStmt = pUp->pUpdate;
  157473. return SQLITE_OK;
  157474. }
  157475. nUp++;
  157476. }
  157477. assert( pUp==0 || pUp->pNext==0 );
  157478. if( nUp>=SQLITE_RBU_UPDATE_CACHESIZE ){
  157479. for(pp=&pIter->pRbuUpdate; *pp!=pUp; pp=&((*pp)->pNext));
  157480. *pp = 0;
  157481. sqlite3_finalize(pUp->pUpdate);
  157482. pUp->pUpdate = 0;
  157483. }else{
  157484. pUp = (RbuUpdateStmt*)rbuMalloc(p, sizeof(RbuUpdateStmt)+pIter->nTblCol+1);
  157485. }
  157486. if( pUp ){
  157487. char *zWhere = rbuObjIterGetWhere(p, pIter);
  157488. char *zSet = rbuObjIterGetSetlist(p, pIter, zMask);
  157489. char *zUpdate = 0;
  157490. pUp->zMask = (char*)&pUp[1];
  157491. memcpy(pUp->zMask, zMask, pIter->nTblCol);
  157492. pUp->pNext = pIter->pRbuUpdate;
  157493. pIter->pRbuUpdate = pUp;
  157494. if( zSet ){
  157495. const char *zPrefix = "";
  157496. if( pIter->eType!=RBU_PK_VTAB ) zPrefix = "rbu_imp_";
  157497. zUpdate = sqlite3_mprintf("UPDATE \"%s%w\" SET %s WHERE %s",
  157498. zPrefix, pIter->zTbl, zSet, zWhere
  157499. );
  157500. p->rc = prepareFreeAndCollectError(
  157501. p->dbMain, &pUp->pUpdate, &p->zErrmsg, zUpdate
  157502. );
  157503. *ppStmt = pUp->pUpdate;
  157504. }
  157505. sqlite3_free(zWhere);
  157506. sqlite3_free(zSet);
  157507. }
  157508. return p->rc;
  157509. }
  157510. static sqlite3 *rbuOpenDbhandle(
  157511. sqlite3rbu *p,
  157512. const char *zName,
  157513. int bUseVfs
  157514. ){
  157515. sqlite3 *db = 0;
  157516. if( p->rc==SQLITE_OK ){
  157517. const int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_URI;
  157518. p->rc = sqlite3_open_v2(zName, &db, flags, bUseVfs ? p->zVfsName : 0);
  157519. if( p->rc ){
  157520. p->zErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  157521. sqlite3_close(db);
  157522. db = 0;
  157523. }
  157524. }
  157525. return db;
  157526. }
  157527. /*
  157528. ** Free an RbuState object allocated by rbuLoadState().
  157529. */
  157530. static void rbuFreeState(RbuState *p){
  157531. if( p ){
  157532. sqlite3_free(p->zTbl);
  157533. sqlite3_free(p->zIdx);
  157534. sqlite3_free(p);
  157535. }
  157536. }
  157537. /*
  157538. ** Allocate an RbuState object and load the contents of the rbu_state
  157539. ** table into it. Return a pointer to the new object. It is the
  157540. ** responsibility of the caller to eventually free the object using
  157541. ** sqlite3_free().
  157542. **
  157543. ** If an error occurs, leave an error code and message in the rbu handle
  157544. ** and return NULL.
  157545. */
  157546. static RbuState *rbuLoadState(sqlite3rbu *p){
  157547. RbuState *pRet = 0;
  157548. sqlite3_stmt *pStmt = 0;
  157549. int rc;
  157550. int rc2;
  157551. pRet = (RbuState*)rbuMalloc(p, sizeof(RbuState));
  157552. if( pRet==0 ) return 0;
  157553. rc = prepareFreeAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  157554. sqlite3_mprintf("SELECT k, v FROM %s.rbu_state", p->zStateDb)
  157555. );
  157556. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  157557. switch( sqlite3_column_int(pStmt, 0) ){
  157558. case RBU_STATE_STAGE:
  157559. pRet->eStage = sqlite3_column_int(pStmt, 1);
  157560. if( pRet->eStage!=RBU_STAGE_OAL
  157561. && pRet->eStage!=RBU_STAGE_MOVE
  157562. && pRet->eStage!=RBU_STAGE_CKPT
  157563. ){
  157564. p->rc = SQLITE_CORRUPT;
  157565. }
  157566. break;
  157567. case RBU_STATE_TBL:
  157568. pRet->zTbl = rbuStrndup((char*)sqlite3_column_text(pStmt, 1), &rc);
  157569. break;
  157570. case RBU_STATE_IDX:
  157571. pRet->zIdx = rbuStrndup((char*)sqlite3_column_text(pStmt, 1), &rc);
  157572. break;
  157573. case RBU_STATE_ROW:
  157574. pRet->nRow = sqlite3_column_int(pStmt, 1);
  157575. break;
  157576. case RBU_STATE_PROGRESS:
  157577. pRet->nProgress = sqlite3_column_int64(pStmt, 1);
  157578. break;
  157579. case RBU_STATE_CKPT:
  157580. pRet->iWalCksum = sqlite3_column_int64(pStmt, 1);
  157581. break;
  157582. case RBU_STATE_COOKIE:
  157583. pRet->iCookie = (u32)sqlite3_column_int64(pStmt, 1);
  157584. break;
  157585. case RBU_STATE_OALSZ:
  157586. pRet->iOalSz = (u32)sqlite3_column_int64(pStmt, 1);
  157587. break;
  157588. case RBU_STATE_PHASEONESTEP:
  157589. pRet->nPhaseOneStep = sqlite3_column_int64(pStmt, 1);
  157590. break;
  157591. default:
  157592. rc = SQLITE_CORRUPT;
  157593. break;
  157594. }
  157595. }
  157596. rc2 = sqlite3_finalize(pStmt);
  157597. if( rc==SQLITE_OK ) rc = rc2;
  157598. p->rc = rc;
  157599. return pRet;
  157600. }
  157601. /*
  157602. ** Open the database handle and attach the RBU database as "rbu". If an
  157603. ** error occurs, leave an error code and message in the RBU handle.
  157604. */
  157605. static void rbuOpenDatabase(sqlite3rbu *p){
  157606. assert( p->rc || (p->dbMain==0 && p->dbRbu==0) );
  157607. assert( p->rc || rbuIsVacuum(p) || p->zTarget!=0 );
  157608. /* Open the RBU database */
  157609. p->dbRbu = rbuOpenDbhandle(p, p->zRbu, 1);
  157610. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  157611. sqlite3_file_control(p->dbRbu, "main", SQLITE_FCNTL_RBUCNT, (void*)p);
  157612. if( p->zState==0 ){
  157613. const char *zFile = sqlite3_db_filename(p->dbRbu, "main");
  157614. p->zState = rbuMPrintf(p, "file://%s-vacuum?modeof=%s", zFile, zFile);
  157615. }
  157616. }
  157617. /* If using separate RBU and state databases, attach the state database to
  157618. ** the RBU db handle now. */
  157619. if( p->zState ){
  157620. rbuMPrintfExec(p, p->dbRbu, "ATTACH %Q AS stat", p->zState);
  157621. memcpy(p->zStateDb, "stat", 4);
  157622. }else{
  157623. memcpy(p->zStateDb, "main", 4);
  157624. }
  157625. #if 0
  157626. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  157627. p->rc = sqlite3_exec(p->dbRbu, "BEGIN", 0, 0, 0);
  157628. }
  157629. #endif
  157630. /* If it has not already been created, create the rbu_state table */
  157631. rbuMPrintfExec(p, p->dbRbu, RBU_CREATE_STATE, p->zStateDb);
  157632. #if 0
  157633. if( rbuIsVacuum(p) ){
  157634. if( p->rc==SQLITE_OK ){
  157635. int rc2;
  157636. int bOk = 0;
  157637. sqlite3_stmt *pCnt = 0;
  157638. p->rc = prepareAndCollectError(p->dbRbu, &pCnt, &p->zErrmsg,
  157639. "SELECT count(*) FROM stat.sqlite_master"
  157640. );
  157641. if( p->rc==SQLITE_OK
  157642. && sqlite3_step(pCnt)==SQLITE_ROW
  157643. && 1==sqlite3_column_int(pCnt, 0)
  157644. ){
  157645. bOk = 1;
  157646. }
  157647. rc2 = sqlite3_finalize(pCnt);
  157648. if( p->rc==SQLITE_OK ) p->rc = rc2;
  157649. if( p->rc==SQLITE_OK && bOk==0 ){
  157650. p->rc = SQLITE_ERROR;
  157651. p->zErrmsg = sqlite3_mprintf("invalid state database");
  157652. }
  157653. if( p->rc==SQLITE_OK ){
  157654. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, 0);
  157655. }
  157656. }
  157657. }
  157658. #endif
  157659. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  157660. int bOpen = 0;
  157661. int rc;
  157662. p->nRbu = 0;
  157663. p->pRbuFd = 0;
  157664. rc = sqlite3_file_control(p->dbRbu, "main", SQLITE_FCNTL_RBUCNT, (void*)p);
  157665. if( rc!=SQLITE_NOTFOUND ) p->rc = rc;
  157666. if( p->eStage>=RBU_STAGE_MOVE ){
  157667. bOpen = 1;
  157668. }else{
  157669. RbuState *pState = rbuLoadState(p);
  157670. if( pState ){
  157671. bOpen = (pState->eStage>RBU_STAGE_MOVE);
  157672. rbuFreeState(pState);
  157673. }
  157674. }
  157675. if( bOpen ) p->dbMain = rbuOpenDbhandle(p, p->zRbu, p->nRbu<=1);
  157676. }
  157677. p->eStage = 0;
  157678. if( p->rc==SQLITE_OK && p->dbMain==0 ){
  157679. if( !rbuIsVacuum(p) ){
  157680. p->dbMain = rbuOpenDbhandle(p, p->zTarget, 1);
  157681. }else if( p->pRbuFd->pWalFd ){
  157682. p->rc = SQLITE_ERROR;
  157683. p->zErrmsg = sqlite3_mprintf("cannot vacuum wal mode database");
  157684. }else{
  157685. char *zTarget;
  157686. char *zExtra = 0;
  157687. if( strlen(p->zRbu)>=5 && 0==memcmp("file:", p->zRbu, 5) ){
  157688. zExtra = &p->zRbu[5];
  157689. while( *zExtra ){
  157690. if( *zExtra++=='?' ) break;
  157691. }
  157692. if( *zExtra=='\0' ) zExtra = 0;
  157693. }
  157694. zTarget = sqlite3_mprintf("file:%s-vacuum?rbu_memory=1%s%s",
  157695. sqlite3_db_filename(p->dbRbu, "main"),
  157696. (zExtra==0 ? "" : "&"), (zExtra==0 ? "" : zExtra)
  157697. );
  157698. if( zTarget==0 ){
  157699. p->rc = SQLITE_NOMEM;
  157700. return;
  157701. }
  157702. p->dbMain = rbuOpenDbhandle(p, zTarget, p->nRbu<=1);
  157703. sqlite3_free(zTarget);
  157704. }
  157705. }
  157706. if( p->rc==SQLITE_OK ){
  157707. p->rc = sqlite3_create_function(p->dbMain,
  157708. "rbu_tmp_insert", -1, SQLITE_UTF8, (void*)p, rbuTmpInsertFunc, 0, 0
  157709. );
  157710. }
  157711. if( p->rc==SQLITE_OK ){
  157712. p->rc = sqlite3_create_function(p->dbMain,
  157713. "rbu_fossil_delta", 2, SQLITE_UTF8, 0, rbuFossilDeltaFunc, 0, 0
  157714. );
  157715. }
  157716. if( p->rc==SQLITE_OK ){
  157717. p->rc = sqlite3_create_function(p->dbRbu,
  157718. "rbu_target_name", -1, SQLITE_UTF8, (void*)p, rbuTargetNameFunc, 0, 0
  157719. );
  157720. }
  157721. if( p->rc==SQLITE_OK ){
  157722. p->rc = sqlite3_file_control(p->dbMain, "main", SQLITE_FCNTL_RBU, (void*)p);
  157723. }
  157724. rbuMPrintfExec(p, p->dbMain, "SELECT * FROM sqlite_master");
  157725. /* Mark the database file just opened as an RBU target database. If
  157726. ** this call returns SQLITE_NOTFOUND, then the RBU vfs is not in use.
  157727. ** This is an error. */
  157728. if( p->rc==SQLITE_OK ){
  157729. p->rc = sqlite3_file_control(p->dbMain, "main", SQLITE_FCNTL_RBU, (void*)p);
  157730. }
  157731. if( p->rc==SQLITE_NOTFOUND ){
  157732. p->rc = SQLITE_ERROR;
  157733. p->zErrmsg = sqlite3_mprintf("rbu vfs not found");
  157734. }
  157735. }
  157736. /*
  157737. ** This routine is a copy of the sqlite3FileSuffix3() routine from the core.
  157738. ** It is a no-op unless SQLITE_ENABLE_8_3_NAMES is defined.
  157739. **
  157740. ** If SQLITE_ENABLE_8_3_NAMES is set at compile-time and if the database
  157741. ** filename in zBaseFilename is a URI with the "8_3_names=1" parameter and
  157742. ** if filename in z[] has a suffix (a.k.a. "extension") that is longer than
  157743. ** three characters, then shorten the suffix on z[] to be the last three
  157744. ** characters of the original suffix.
  157745. **
  157746. ** If SQLITE_ENABLE_8_3_NAMES is set to 2 at compile-time, then always
  157747. ** do the suffix shortening regardless of URI parameter.
  157748. **
  157749. ** Examples:
  157750. **
  157751. ** test.db-journal => test.nal
  157752. ** test.db-wal => test.wal
  157753. ** test.db-shm => test.shm
  157754. ** test.db-mj7f3319fa => test.9fa
  157755. */
  157756. static void rbuFileSuffix3(const char *zBase, char *z){
  157757. #ifdef SQLITE_ENABLE_8_3_NAMES
  157758. #if SQLITE_ENABLE_8_3_NAMES<2
  157759. if( sqlite3_uri_boolean(zBase, "8_3_names", 0) )
  157760. #endif
  157761. {
  157762. int i, sz;
  157763. sz = (int)strlen(z)&0xffffff;
  157764. for(i=sz-1; i>0 && z[i]!='/' && z[i]!='.'; i--){}
  157765. if( z[i]=='.' && sz>i+4 ) memmove(&z[i+1], &z[sz-3], 4);
  157766. }
  157767. #endif
  157768. }
  157769. /*
  157770. ** Return the current wal-index header checksum for the target database
  157771. ** as a 64-bit integer.
  157772. **
  157773. ** The checksum is store in the first page of xShmMap memory as an 8-byte
  157774. ** blob starting at byte offset 40.
  157775. */
  157776. static i64 rbuShmChecksum(sqlite3rbu *p){
  157777. i64 iRet = 0;
  157778. if( p->rc==SQLITE_OK ){
  157779. sqlite3_file *pDb = p->pTargetFd->pReal;
  157780. u32 volatile *ptr;
  157781. p->rc = pDb->pMethods->xShmMap(pDb, 0, 32*1024, 0, (void volatile**)&ptr);
  157782. if( p->rc==SQLITE_OK ){
  157783. iRet = ((i64)ptr[10] << 32) + ptr[11];
  157784. }
  157785. }
  157786. return iRet;
  157787. }
  157788. /*
  157789. ** This function is called as part of initializing or reinitializing an
  157790. ** incremental checkpoint.
  157791. **
  157792. ** It populates the sqlite3rbu.aFrame[] array with the set of
  157793. ** (wal frame -> db page) copy operations required to checkpoint the
  157794. ** current wal file, and obtains the set of shm locks required to safely
  157795. ** perform the copy operations directly on the file-system.
  157796. **
  157797. ** If argument pState is not NULL, then the incremental checkpoint is
  157798. ** being resumed. In this case, if the checksum of the wal-index-header
  157799. ** following recovery is not the same as the checksum saved in the RbuState
  157800. ** object, then the rbu handle is set to DONE state. This occurs if some
  157801. ** other client appends a transaction to the wal file in the middle of
  157802. ** an incremental checkpoint.
  157803. */
  157804. static void rbuSetupCheckpoint(sqlite3rbu *p, RbuState *pState){
  157805. /* If pState is NULL, then the wal file may not have been opened and
  157806. ** recovered. Running a read-statement here to ensure that doing so
  157807. ** does not interfere with the "capture" process below. */
  157808. if( pState==0 ){
  157809. p->eStage = 0;
  157810. if( p->rc==SQLITE_OK ){
  157811. p->rc = sqlite3_exec(p->dbMain, "SELECT * FROM sqlite_master", 0, 0, 0);
  157812. }
  157813. }
  157814. /* Assuming no error has occurred, run a "restart" checkpoint with the
  157815. ** sqlite3rbu.eStage variable set to CAPTURE. This turns on the following
  157816. ** special behaviour in the rbu VFS:
  157817. **
  157818. ** * If the exclusive shm WRITER or READ0 lock cannot be obtained,
  157819. ** the checkpoint fails with SQLITE_BUSY (normally SQLite would
  157820. ** proceed with running a passive checkpoint instead of failing).
  157821. **
  157822. ** * Attempts to read from the *-wal file or write to the database file
  157823. ** do not perform any IO. Instead, the frame/page combinations that
  157824. ** would be read/written are recorded in the sqlite3rbu.aFrame[]
  157825. ** array.
  157826. **
  157827. ** * Calls to xShmLock(UNLOCK) to release the exclusive shm WRITER,
  157828. ** READ0 and CHECKPOINT locks taken as part of the checkpoint are
  157829. ** no-ops. These locks will not be released until the connection
  157830. ** is closed.
  157831. **
  157832. ** * Attempting to xSync() the database file causes an SQLITE_INTERNAL
  157833. ** error.
  157834. **
  157835. ** As a result, unless an error (i.e. OOM or SQLITE_BUSY) occurs, the
  157836. ** checkpoint below fails with SQLITE_INTERNAL, and leaves the aFrame[]
  157837. ** array populated with a set of (frame -> page) mappings. Because the
  157838. ** WRITER, CHECKPOINT and READ0 locks are still held, it is safe to copy
  157839. ** data from the wal file into the database file according to the
  157840. ** contents of aFrame[].
  157841. */
  157842. if( p->rc==SQLITE_OK ){
  157843. int rc2;
  157844. p->eStage = RBU_STAGE_CAPTURE;
  157845. rc2 = sqlite3_exec(p->dbMain, "PRAGMA main.wal_checkpoint=restart", 0, 0,0);
  157846. if( rc2!=SQLITE_INTERNAL ) p->rc = rc2;
  157847. }
  157848. if( p->rc==SQLITE_OK ){
  157849. p->eStage = RBU_STAGE_CKPT;
  157850. p->nStep = (pState ? pState->nRow : 0);
  157851. p->aBuf = rbuMalloc(p, p->pgsz);
  157852. p->iWalCksum = rbuShmChecksum(p);
  157853. }
  157854. if( p->rc==SQLITE_OK && pState && pState->iWalCksum!=p->iWalCksum ){
  157855. p->rc = SQLITE_DONE;
  157856. p->eStage = RBU_STAGE_DONE;
  157857. }
  157858. }
  157859. /*
  157860. ** Called when iAmt bytes are read from offset iOff of the wal file while
  157861. ** the rbu object is in capture mode. Record the frame number of the frame
  157862. ** being read in the aFrame[] array.
  157863. */
  157864. static int rbuCaptureWalRead(sqlite3rbu *pRbu, i64 iOff, int iAmt){
  157865. const u32 mReq = (1<<WAL_LOCK_WRITE)|(1<<WAL_LOCK_CKPT)|(1<<WAL_LOCK_READ0);
  157866. u32 iFrame;
  157867. if( pRbu->mLock!=mReq ){
  157868. pRbu->rc = SQLITE_BUSY;
  157869. return SQLITE_INTERNAL;
  157870. }
  157871. pRbu->pgsz = iAmt;
  157872. if( pRbu->nFrame==pRbu->nFrameAlloc ){
  157873. int nNew = (pRbu->nFrameAlloc ? pRbu->nFrameAlloc : 64) * 2;
  157874. RbuFrame *aNew;
  157875. aNew = (RbuFrame*)sqlite3_realloc64(pRbu->aFrame, nNew * sizeof(RbuFrame));
  157876. if( aNew==0 ) return SQLITE_NOMEM;
  157877. pRbu->aFrame = aNew;
  157878. pRbu->nFrameAlloc = nNew;
  157879. }
  157880. iFrame = (u32)((iOff-32) / (i64)(iAmt+24)) + 1;
  157881. if( pRbu->iMaxFrame<iFrame ) pRbu->iMaxFrame = iFrame;
  157882. pRbu->aFrame[pRbu->nFrame].iWalFrame = iFrame;
  157883. pRbu->aFrame[pRbu->nFrame].iDbPage = 0;
  157884. pRbu->nFrame++;
  157885. return SQLITE_OK;
  157886. }
  157887. /*
  157888. ** Called when a page of data is written to offset iOff of the database
  157889. ** file while the rbu handle is in capture mode. Record the page number
  157890. ** of the page being written in the aFrame[] array.
  157891. */
  157892. static int rbuCaptureDbWrite(sqlite3rbu *pRbu, i64 iOff){
  157893. pRbu->aFrame[pRbu->nFrame-1].iDbPage = (u32)(iOff / pRbu->pgsz) + 1;
  157894. return SQLITE_OK;
  157895. }
  157896. /*
  157897. ** This is called as part of an incremental checkpoint operation. Copy
  157898. ** a single frame of data from the wal file into the database file, as
  157899. ** indicated by the RbuFrame object.
  157900. */
  157901. static void rbuCheckpointFrame(sqlite3rbu *p, RbuFrame *pFrame){
  157902. sqlite3_file *pWal = p->pTargetFd->pWalFd->pReal;
  157903. sqlite3_file *pDb = p->pTargetFd->pReal;
  157904. i64 iOff;
  157905. assert( p->rc==SQLITE_OK );
  157906. iOff = (i64)(pFrame->iWalFrame-1) * (p->pgsz + 24) + 32 + 24;
  157907. p->rc = pWal->pMethods->xRead(pWal, p->aBuf, p->pgsz, iOff);
  157908. if( p->rc ) return;
  157909. iOff = (i64)(pFrame->iDbPage-1) * p->pgsz;
  157910. p->rc = pDb->pMethods->xWrite(pDb, p->aBuf, p->pgsz, iOff);
  157911. }
  157912. /*
  157913. ** Take an EXCLUSIVE lock on the database file.
  157914. */
  157915. static void rbuLockDatabase(sqlite3rbu *p){
  157916. sqlite3_file *pReal = p->pTargetFd->pReal;
  157917. assert( p->rc==SQLITE_OK );
  157918. p->rc = pReal->pMethods->xLock(pReal, SQLITE_LOCK_SHARED);
  157919. if( p->rc==SQLITE_OK ){
  157920. p->rc = pReal->pMethods->xLock(pReal, SQLITE_LOCK_EXCLUSIVE);
  157921. }
  157922. }
  157923. #if defined(_WIN32_WCE)
  157924. static LPWSTR rbuWinUtf8ToUnicode(const char *zFilename){
  157925. int nChar;
  157926. LPWSTR zWideFilename;
  157927. nChar = MultiByteToWideChar(CP_UTF8, 0, zFilename, -1, NULL, 0);
  157928. if( nChar==0 ){
  157929. return 0;
  157930. }
  157931. zWideFilename = sqlite3_malloc64( nChar*sizeof(zWideFilename[0]) );
  157932. if( zWideFilename==0 ){
  157933. return 0;
  157934. }
  157935. memset(zWideFilename, 0, nChar*sizeof(zWideFilename[0]));
  157936. nChar = MultiByteToWideChar(CP_UTF8, 0, zFilename, -1, zWideFilename,
  157937. nChar);
  157938. if( nChar==0 ){
  157939. sqlite3_free(zWideFilename);
  157940. zWideFilename = 0;
  157941. }
  157942. return zWideFilename;
  157943. }
  157944. #endif
  157945. /*
  157946. ** The RBU handle is currently in RBU_STAGE_OAL state, with a SHARED lock
  157947. ** on the database file. This proc moves the *-oal file to the *-wal path,
  157948. ** then reopens the database file (this time in vanilla, non-oal, WAL mode).
  157949. ** If an error occurs, leave an error code and error message in the rbu
  157950. ** handle.
  157951. */
  157952. static void rbuMoveOalFile(sqlite3rbu *p){
  157953. const char *zBase = sqlite3_db_filename(p->dbMain, "main");
  157954. const char *zMove = zBase;
  157955. char *zOal;
  157956. char *zWal;
  157957. if( rbuIsVacuum(p) ){
  157958. zMove = sqlite3_db_filename(p->dbRbu, "main");
  157959. }
  157960. zOal = sqlite3_mprintf("%s-oal", zMove);
  157961. zWal = sqlite3_mprintf("%s-wal", zMove);
  157962. assert( p->eStage==RBU_STAGE_MOVE );
  157963. assert( p->rc==SQLITE_OK && p->zErrmsg==0 );
  157964. if( zWal==0 || zOal==0 ){
  157965. p->rc = SQLITE_NOMEM;
  157966. }else{
  157967. /* Move the *-oal file to *-wal. At this point connection p->db is
  157968. ** holding a SHARED lock on the target database file (because it is
  157969. ** in WAL mode). So no other connection may be writing the db.
  157970. **
  157971. ** In order to ensure that there are no database readers, an EXCLUSIVE
  157972. ** lock is obtained here before the *-oal is moved to *-wal.
  157973. */
  157974. rbuLockDatabase(p);
  157975. if( p->rc==SQLITE_OK ){
  157976. rbuFileSuffix3(zBase, zWal);
  157977. rbuFileSuffix3(zBase, zOal);
  157978. /* Re-open the databases. */
  157979. rbuObjIterFinalize(&p->objiter);
  157980. sqlite3_close(p->dbRbu);
  157981. sqlite3_close(p->dbMain);
  157982. p->dbMain = 0;
  157983. p->dbRbu = 0;
  157984. #if defined(_WIN32_WCE)
  157985. {
  157986. LPWSTR zWideOal;
  157987. LPWSTR zWideWal;
  157988. zWideOal = rbuWinUtf8ToUnicode(zOal);
  157989. if( zWideOal ){
  157990. zWideWal = rbuWinUtf8ToUnicode(zWal);
  157991. if( zWideWal ){
  157992. if( MoveFileW(zWideOal, zWideWal) ){
  157993. p->rc = SQLITE_OK;
  157994. }else{
  157995. p->rc = SQLITE_IOERR;
  157996. }
  157997. sqlite3_free(zWideWal);
  157998. }else{
  157999. p->rc = SQLITE_IOERR_NOMEM;
  158000. }
  158001. sqlite3_free(zWideOal);
  158002. }else{
  158003. p->rc = SQLITE_IOERR_NOMEM;
  158004. }
  158005. }
  158006. #else
  158007. p->rc = rename(zOal, zWal) ? SQLITE_IOERR : SQLITE_OK;
  158008. #endif
  158009. if( p->rc==SQLITE_OK ){
  158010. rbuOpenDatabase(p);
  158011. rbuSetupCheckpoint(p, 0);
  158012. }
  158013. }
  158014. }
  158015. sqlite3_free(zWal);
  158016. sqlite3_free(zOal);
  158017. }
  158018. /*
  158019. ** The SELECT statement iterating through the keys for the current object
  158020. ** (p->objiter.pSelect) currently points to a valid row. This function
  158021. ** determines the type of operation requested by this row and returns
  158022. ** one of the following values to indicate the result:
  158023. **
  158024. ** * RBU_INSERT
  158025. ** * RBU_DELETE
  158026. ** * RBU_IDX_DELETE
  158027. ** * RBU_UPDATE
  158028. **
  158029. ** If RBU_UPDATE is returned, then output variable *pzMask is set to
  158030. ** point to the text value indicating the columns to update.
  158031. **
  158032. ** If the rbu_control field contains an invalid value, an error code and
  158033. ** message are left in the RBU handle and zero returned.
  158034. */
  158035. static int rbuStepType(sqlite3rbu *p, const char **pzMask){
  158036. int iCol = p->objiter.nCol; /* Index of rbu_control column */
  158037. int res = 0; /* Return value */
  158038. switch( sqlite3_column_type(p->objiter.pSelect, iCol) ){
  158039. case SQLITE_INTEGER: {
  158040. int iVal = sqlite3_column_int(p->objiter.pSelect, iCol);
  158041. switch( iVal ){
  158042. case 0: res = RBU_INSERT; break;
  158043. case 1: res = RBU_DELETE; break;
  158044. case 2: res = RBU_REPLACE; break;
  158045. case 3: res = RBU_IDX_DELETE; break;
  158046. case 4: res = RBU_IDX_INSERT; break;
  158047. }
  158048. break;
  158049. }
  158050. case SQLITE_TEXT: {
  158051. const unsigned char *z = sqlite3_column_text(p->objiter.pSelect, iCol);
  158052. if( z==0 ){
  158053. p->rc = SQLITE_NOMEM;
  158054. }else{
  158055. *pzMask = (const char*)z;
  158056. }
  158057. res = RBU_UPDATE;
  158058. break;
  158059. }
  158060. default:
  158061. break;
  158062. }
  158063. if( res==0 ){
  158064. rbuBadControlError(p);
  158065. }
  158066. return res;
  158067. }
  158068. #ifdef SQLITE_DEBUG
  158069. /*
  158070. ** Assert that column iCol of statement pStmt is named zName.
  158071. */
  158072. static void assertColumnName(sqlite3_stmt *pStmt, int iCol, const char *zName){
  158073. const char *zCol = sqlite3_column_name(pStmt, iCol);
  158074. assert( 0==sqlite3_stricmp(zName, zCol) );
  158075. }
  158076. #else
  158077. # define assertColumnName(x,y,z)
  158078. #endif
  158079. /*
  158080. ** Argument eType must be one of RBU_INSERT, RBU_DELETE, RBU_IDX_INSERT or
  158081. ** RBU_IDX_DELETE. This function performs the work of a single
  158082. ** sqlite3rbu_step() call for the type of operation specified by eType.
  158083. */
  158084. static void rbuStepOneOp(sqlite3rbu *p, int eType){
  158085. RbuObjIter *pIter = &p->objiter;
  158086. sqlite3_value *pVal;
  158087. sqlite3_stmt *pWriter;
  158088. int i;
  158089. assert( p->rc==SQLITE_OK );
  158090. assert( eType!=RBU_DELETE || pIter->zIdx==0 );
  158091. assert( eType==RBU_DELETE || eType==RBU_IDX_DELETE
  158092. || eType==RBU_INSERT || eType==RBU_IDX_INSERT
  158093. );
  158094. /* If this is a delete, decrement nPhaseOneStep by nIndex. If the DELETE
  158095. ** statement below does actually delete a row, nPhaseOneStep will be
  158096. ** incremented by the same amount when SQL function rbu_tmp_insert()
  158097. ** is invoked by the trigger. */
  158098. if( eType==RBU_DELETE ){
  158099. p->nPhaseOneStep -= p->objiter.nIndex;
  158100. }
  158101. if( eType==RBU_IDX_DELETE || eType==RBU_DELETE ){
  158102. pWriter = pIter->pDelete;
  158103. }else{
  158104. pWriter = pIter->pInsert;
  158105. }
  158106. for(i=0; i<pIter->nCol; i++){
  158107. /* If this is an INSERT into a table b-tree and the table has an
  158108. ** explicit INTEGER PRIMARY KEY, check that this is not an attempt
  158109. ** to write a NULL into the IPK column. That is not permitted. */
  158110. if( eType==RBU_INSERT
  158111. && pIter->zIdx==0 && pIter->eType==RBU_PK_IPK && pIter->abTblPk[i]
  158112. && sqlite3_column_type(pIter->pSelect, i)==SQLITE_NULL
  158113. ){
  158114. p->rc = SQLITE_MISMATCH;
  158115. p->zErrmsg = sqlite3_mprintf("datatype mismatch");
  158116. return;
  158117. }
  158118. if( eType==RBU_DELETE && pIter->abTblPk[i]==0 ){
  158119. continue;
  158120. }
  158121. pVal = sqlite3_column_value(pIter->pSelect, i);
  158122. p->rc = sqlite3_bind_value(pWriter, i+1, pVal);
  158123. if( p->rc ) return;
  158124. }
  158125. if( pIter->zIdx==0 ){
  158126. if( pIter->eType==RBU_PK_VTAB
  158127. || pIter->eType==RBU_PK_NONE
  158128. || (pIter->eType==RBU_PK_EXTERNAL && rbuIsVacuum(p))
  158129. ){
  158130. /* For a virtual table, or a table with no primary key, the
  158131. ** SELECT statement is:
  158132. **
  158133. ** SELECT <cols>, rbu_control, rbu_rowid FROM ....
  158134. **
  158135. ** Hence column_value(pIter->nCol+1).
  158136. */
  158137. assertColumnName(pIter->pSelect, pIter->nCol+1,
  158138. rbuIsVacuum(p) ? "rowid" : "rbu_rowid"
  158139. );
  158140. pVal = sqlite3_column_value(pIter->pSelect, pIter->nCol+1);
  158141. p->rc = sqlite3_bind_value(pWriter, pIter->nCol+1, pVal);
  158142. }
  158143. }
  158144. if( p->rc==SQLITE_OK ){
  158145. sqlite3_step(pWriter);
  158146. p->rc = resetAndCollectError(pWriter, &p->zErrmsg);
  158147. }
  158148. }
  158149. /*
  158150. ** This function does the work for an sqlite3rbu_step() call.
  158151. **
  158152. ** The object-iterator (p->objiter) currently points to a valid object,
  158153. ** and the input cursor (p->objiter.pSelect) currently points to a valid
  158154. ** input row. Perform whatever processing is required and return.
  158155. **
  158156. ** If no error occurs, SQLITE_OK is returned. Otherwise, an error code
  158157. ** and message is left in the RBU handle and a copy of the error code
  158158. ** returned.
  158159. */
  158160. static int rbuStep(sqlite3rbu *p){
  158161. RbuObjIter *pIter = &p->objiter;
  158162. const char *zMask = 0;
  158163. int eType = rbuStepType(p, &zMask);
  158164. if( eType ){
  158165. assert( eType==RBU_INSERT || eType==RBU_DELETE
  158166. || eType==RBU_REPLACE || eType==RBU_IDX_DELETE
  158167. || eType==RBU_IDX_INSERT || eType==RBU_UPDATE
  158168. );
  158169. assert( eType!=RBU_UPDATE || pIter->zIdx==0 );
  158170. if( pIter->zIdx==0 && (eType==RBU_IDX_DELETE || eType==RBU_IDX_INSERT) ){
  158171. rbuBadControlError(p);
  158172. }
  158173. else if( eType==RBU_REPLACE ){
  158174. if( pIter->zIdx==0 ){
  158175. p->nPhaseOneStep += p->objiter.nIndex;
  158176. rbuStepOneOp(p, RBU_DELETE);
  158177. }
  158178. if( p->rc==SQLITE_OK ) rbuStepOneOp(p, RBU_INSERT);
  158179. }
  158180. else if( eType!=RBU_UPDATE ){
  158181. rbuStepOneOp(p, eType);
  158182. }
  158183. else{
  158184. sqlite3_value *pVal;
  158185. sqlite3_stmt *pUpdate = 0;
  158186. assert( eType==RBU_UPDATE );
  158187. p->nPhaseOneStep -= p->objiter.nIndex;
  158188. rbuGetUpdateStmt(p, pIter, zMask, &pUpdate);
  158189. if( pUpdate ){
  158190. int i;
  158191. for(i=0; p->rc==SQLITE_OK && i<pIter->nCol; i++){
  158192. char c = zMask[pIter->aiSrcOrder[i]];
  158193. pVal = sqlite3_column_value(pIter->pSelect, i);
  158194. if( pIter->abTblPk[i] || c!='.' ){
  158195. p->rc = sqlite3_bind_value(pUpdate, i+1, pVal);
  158196. }
  158197. }
  158198. if( p->rc==SQLITE_OK
  158199. && (pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE)
  158200. ){
  158201. /* Bind the rbu_rowid value to column _rowid_ */
  158202. assertColumnName(pIter->pSelect, pIter->nCol+1, "rbu_rowid");
  158203. pVal = sqlite3_column_value(pIter->pSelect, pIter->nCol+1);
  158204. p->rc = sqlite3_bind_value(pUpdate, pIter->nCol+1, pVal);
  158205. }
  158206. if( p->rc==SQLITE_OK ){
  158207. sqlite3_step(pUpdate);
  158208. p->rc = resetAndCollectError(pUpdate, &p->zErrmsg);
  158209. }
  158210. }
  158211. }
  158212. }
  158213. return p->rc;
  158214. }
  158215. /*
  158216. ** Increment the schema cookie of the main database opened by p->dbMain.
  158217. **
  158218. ** Or, if this is an RBU vacuum, set the schema cookie of the main db
  158219. ** opened by p->dbMain to one more than the schema cookie of the main
  158220. ** db opened by p->dbRbu.
  158221. */
  158222. static void rbuIncrSchemaCookie(sqlite3rbu *p){
  158223. if( p->rc==SQLITE_OK ){
  158224. sqlite3 *dbread = (rbuIsVacuum(p) ? p->dbRbu : p->dbMain);
  158225. int iCookie = 1000000;
  158226. sqlite3_stmt *pStmt;
  158227. p->rc = prepareAndCollectError(dbread, &pStmt, &p->zErrmsg,
  158228. "PRAGMA schema_version"
  158229. );
  158230. if( p->rc==SQLITE_OK ){
  158231. /* Coverage: it may be that this sqlite3_step() cannot fail. There
  158232. ** is already a transaction open, so the prepared statement cannot
  158233. ** throw an SQLITE_SCHEMA exception. The only database page the
  158234. ** statement reads is page 1, which is guaranteed to be in the cache.
  158235. ** And no memory allocations are required. */
  158236. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  158237. iCookie = sqlite3_column_int(pStmt, 0);
  158238. }
  158239. rbuFinalize(p, pStmt);
  158240. }
  158241. if( p->rc==SQLITE_OK ){
  158242. rbuMPrintfExec(p, p->dbMain, "PRAGMA schema_version = %d", iCookie+1);
  158243. }
  158244. }
  158245. }
  158246. /*
  158247. ** Update the contents of the rbu_state table within the rbu database. The
  158248. ** value stored in the RBU_STATE_STAGE column is eStage. All other values
  158249. ** are determined by inspecting the rbu handle passed as the first argument.
  158250. */
  158251. static void rbuSaveState(sqlite3rbu *p, int eStage){
  158252. if( p->rc==SQLITE_OK || p->rc==SQLITE_DONE ){
  158253. sqlite3_stmt *pInsert = 0;
  158254. rbu_file *pFd = (rbuIsVacuum(p) ? p->pRbuFd : p->pTargetFd);
  158255. int rc;
  158256. assert( p->zErrmsg==0 );
  158257. rc = prepareFreeAndCollectError(p->dbRbu, &pInsert, &p->zErrmsg,
  158258. sqlite3_mprintf(
  158259. "INSERT OR REPLACE INTO %s.rbu_state(k, v) VALUES "
  158260. "(%d, %d), "
  158261. "(%d, %Q), "
  158262. "(%d, %Q), "
  158263. "(%d, %d), "
  158264. "(%d, %d), "
  158265. "(%d, %lld), "
  158266. "(%d, %lld), "
  158267. "(%d, %lld), "
  158268. "(%d, %lld) ",
  158269. p->zStateDb,
  158270. RBU_STATE_STAGE, eStage,
  158271. RBU_STATE_TBL, p->objiter.zTbl,
  158272. RBU_STATE_IDX, p->objiter.zIdx,
  158273. RBU_STATE_ROW, p->nStep,
  158274. RBU_STATE_PROGRESS, p->nProgress,
  158275. RBU_STATE_CKPT, p->iWalCksum,
  158276. RBU_STATE_COOKIE, (i64)pFd->iCookie,
  158277. RBU_STATE_OALSZ, p->iOalSz,
  158278. RBU_STATE_PHASEONESTEP, p->nPhaseOneStep
  158279. )
  158280. );
  158281. assert( pInsert==0 || rc==SQLITE_OK );
  158282. if( rc==SQLITE_OK ){
  158283. sqlite3_step(pInsert);
  158284. rc = sqlite3_finalize(pInsert);
  158285. }
  158286. if( rc!=SQLITE_OK ) p->rc = rc;
  158287. }
  158288. }
  158289. /*
  158290. ** The second argument passed to this function is the name of a PRAGMA
  158291. ** setting - "page_size", "auto_vacuum", "user_version" or "application_id".
  158292. ** This function executes the following on sqlite3rbu.dbRbu:
  158293. **
  158294. ** "PRAGMA main.$zPragma"
  158295. **
  158296. ** where $zPragma is the string passed as the second argument, then
  158297. ** on sqlite3rbu.dbMain:
  158298. **
  158299. ** "PRAGMA main.$zPragma = $val"
  158300. **
  158301. ** where $val is the value returned by the first PRAGMA invocation.
  158302. **
  158303. ** In short, it copies the value of the specified PRAGMA setting from
  158304. ** dbRbu to dbMain.
  158305. */
  158306. static void rbuCopyPragma(sqlite3rbu *p, const char *zPragma){
  158307. if( p->rc==SQLITE_OK ){
  158308. sqlite3_stmt *pPragma = 0;
  158309. p->rc = prepareFreeAndCollectError(p->dbRbu, &pPragma, &p->zErrmsg,
  158310. sqlite3_mprintf("PRAGMA main.%s", zPragma)
  158311. );
  158312. if( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pPragma) ){
  158313. p->rc = rbuMPrintfExec(p, p->dbMain, "PRAGMA main.%s = %d",
  158314. zPragma, sqlite3_column_int(pPragma, 0)
  158315. );
  158316. }
  158317. rbuFinalize(p, pPragma);
  158318. }
  158319. }
  158320. /*
  158321. ** The RBU handle passed as the only argument has just been opened and
  158322. ** the state database is empty. If this RBU handle was opened for an
  158323. ** RBU vacuum operation, create the schema in the target db.
  158324. */
  158325. static void rbuCreateTargetSchema(sqlite3rbu *p){
  158326. sqlite3_stmt *pSql = 0;
  158327. sqlite3_stmt *pInsert = 0;
  158328. assert( rbuIsVacuum(p) );
  158329. p->rc = sqlite3_exec(p->dbMain, "PRAGMA writable_schema=1", 0,0, &p->zErrmsg);
  158330. if( p->rc==SQLITE_OK ){
  158331. p->rc = prepareAndCollectError(p->dbRbu, &pSql, &p->zErrmsg,
  158332. "SELECT sql FROM sqlite_master WHERE sql!='' AND rootpage!=0"
  158333. " AND name!='sqlite_sequence' "
  158334. " ORDER BY type DESC"
  158335. );
  158336. }
  158337. while( p->rc==SQLITE_OK && sqlite3_step(pSql)==SQLITE_ROW ){
  158338. const char *zSql = (const char*)sqlite3_column_text(pSql, 0);
  158339. p->rc = sqlite3_exec(p->dbMain, zSql, 0, 0, &p->zErrmsg);
  158340. }
  158341. rbuFinalize(p, pSql);
  158342. if( p->rc!=SQLITE_OK ) return;
  158343. if( p->rc==SQLITE_OK ){
  158344. p->rc = prepareAndCollectError(p->dbRbu, &pSql, &p->zErrmsg,
  158345. "SELECT * FROM sqlite_master WHERE rootpage=0 OR rootpage IS NULL"
  158346. );
  158347. }
  158348. if( p->rc==SQLITE_OK ){
  158349. p->rc = prepareAndCollectError(p->dbMain, &pInsert, &p->zErrmsg,
  158350. "INSERT INTO sqlite_master VALUES(?,?,?,?,?)"
  158351. );
  158352. }
  158353. while( p->rc==SQLITE_OK && sqlite3_step(pSql)==SQLITE_ROW ){
  158354. int i;
  158355. for(i=0; i<5; i++){
  158356. sqlite3_bind_value(pInsert, i+1, sqlite3_column_value(pSql, i));
  158357. }
  158358. sqlite3_step(pInsert);
  158359. p->rc = sqlite3_reset(pInsert);
  158360. }
  158361. if( p->rc==SQLITE_OK ){
  158362. p->rc = sqlite3_exec(p->dbMain, "PRAGMA writable_schema=0",0,0,&p->zErrmsg);
  158363. }
  158364. rbuFinalize(p, pSql);
  158365. rbuFinalize(p, pInsert);
  158366. }
  158367. /*
  158368. ** Step the RBU object.
  158369. */
  158370. SQLITE_API int sqlite3rbu_step(sqlite3rbu *p){
  158371. if( p ){
  158372. switch( p->eStage ){
  158373. case RBU_STAGE_OAL: {
  158374. RbuObjIter *pIter = &p->objiter;
  158375. /* If this is an RBU vacuum operation and the state table was empty
  158376. ** when this handle was opened, create the target database schema. */
  158377. if( rbuIsVacuum(p) && p->nProgress==0 && p->rc==SQLITE_OK ){
  158378. rbuCreateTargetSchema(p);
  158379. rbuCopyPragma(p, "user_version");
  158380. rbuCopyPragma(p, "application_id");
  158381. }
  158382. while( p->rc==SQLITE_OK && pIter->zTbl ){
  158383. if( pIter->bCleanup ){
  158384. /* Clean up the rbu_tmp_xxx table for the previous table. It
  158385. ** cannot be dropped as there are currently active SQL statements.
  158386. ** But the contents can be deleted. */
  158387. if( rbuIsVacuum(p)==0 && pIter->abIndexed ){
  158388. rbuMPrintfExec(p, p->dbRbu,
  158389. "DELETE FROM %s.'rbu_tmp_%q'", p->zStateDb, pIter->zDataTbl
  158390. );
  158391. }
  158392. }else{
  158393. rbuObjIterPrepareAll(p, pIter, 0);
  158394. /* Advance to the next row to process. */
  158395. if( p->rc==SQLITE_OK ){
  158396. int rc = sqlite3_step(pIter->pSelect);
  158397. if( rc==SQLITE_ROW ){
  158398. p->nProgress++;
  158399. p->nStep++;
  158400. return rbuStep(p);
  158401. }
  158402. p->rc = sqlite3_reset(pIter->pSelect);
  158403. p->nStep = 0;
  158404. }
  158405. }
  158406. rbuObjIterNext(p, pIter);
  158407. }
  158408. if( p->rc==SQLITE_OK ){
  158409. assert( pIter->zTbl==0 );
  158410. rbuSaveState(p, RBU_STAGE_MOVE);
  158411. rbuIncrSchemaCookie(p);
  158412. if( p->rc==SQLITE_OK ){
  158413. p->rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, &p->zErrmsg);
  158414. }
  158415. if( p->rc==SQLITE_OK ){
  158416. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, &p->zErrmsg);
  158417. }
  158418. p->eStage = RBU_STAGE_MOVE;
  158419. }
  158420. break;
  158421. }
  158422. case RBU_STAGE_MOVE: {
  158423. if( p->rc==SQLITE_OK ){
  158424. rbuMoveOalFile(p);
  158425. p->nProgress++;
  158426. }
  158427. break;
  158428. }
  158429. case RBU_STAGE_CKPT: {
  158430. if( p->rc==SQLITE_OK ){
  158431. if( p->nStep>=p->nFrame ){
  158432. sqlite3_file *pDb = p->pTargetFd->pReal;
  158433. /* Sync the db file */
  158434. p->rc = pDb->pMethods->xSync(pDb, SQLITE_SYNC_NORMAL);
  158435. /* Update nBackfill */
  158436. if( p->rc==SQLITE_OK ){
  158437. void volatile *ptr;
  158438. p->rc = pDb->pMethods->xShmMap(pDb, 0, 32*1024, 0, &ptr);
  158439. if( p->rc==SQLITE_OK ){
  158440. ((u32 volatile*)ptr)[24] = p->iMaxFrame;
  158441. }
  158442. }
  158443. if( p->rc==SQLITE_OK ){
  158444. p->eStage = RBU_STAGE_DONE;
  158445. p->rc = SQLITE_DONE;
  158446. }
  158447. }else{
  158448. RbuFrame *pFrame = &p->aFrame[p->nStep];
  158449. rbuCheckpointFrame(p, pFrame);
  158450. p->nStep++;
  158451. }
  158452. p->nProgress++;
  158453. }
  158454. break;
  158455. }
  158456. default:
  158457. break;
  158458. }
  158459. return p->rc;
  158460. }else{
  158461. return SQLITE_NOMEM;
  158462. }
  158463. }
  158464. /*
  158465. ** Compare strings z1 and z2, returning 0 if they are identical, or non-zero
  158466. ** otherwise. Either or both argument may be NULL. Two NULL values are
  158467. ** considered equal, and NULL is considered distinct from all other values.
  158468. */
  158469. static int rbuStrCompare(const char *z1, const char *z2){
  158470. if( z1==0 && z2==0 ) return 0;
  158471. if( z1==0 || z2==0 ) return 1;
  158472. return (sqlite3_stricmp(z1, z2)!=0);
  158473. }
  158474. /*
  158475. ** This function is called as part of sqlite3rbu_open() when initializing
  158476. ** an rbu handle in OAL stage. If the rbu update has not started (i.e.
  158477. ** the rbu_state table was empty) it is a no-op. Otherwise, it arranges
  158478. ** things so that the next call to sqlite3rbu_step() continues on from
  158479. ** where the previous rbu handle left off.
  158480. **
  158481. ** If an error occurs, an error code and error message are left in the
  158482. ** rbu handle passed as the first argument.
  158483. */
  158484. static void rbuSetupOal(sqlite3rbu *p, RbuState *pState){
  158485. assert( p->rc==SQLITE_OK );
  158486. if( pState->zTbl ){
  158487. RbuObjIter *pIter = &p->objiter;
  158488. int rc = SQLITE_OK;
  158489. while( rc==SQLITE_OK && pIter->zTbl && (pIter->bCleanup
  158490. || rbuStrCompare(pIter->zIdx, pState->zIdx)
  158491. || rbuStrCompare(pIter->zTbl, pState->zTbl)
  158492. )){
  158493. rc = rbuObjIterNext(p, pIter);
  158494. }
  158495. if( rc==SQLITE_OK && !pIter->zTbl ){
  158496. rc = SQLITE_ERROR;
  158497. p->zErrmsg = sqlite3_mprintf("rbu_state mismatch error");
  158498. }
  158499. if( rc==SQLITE_OK ){
  158500. p->nStep = pState->nRow;
  158501. rc = rbuObjIterPrepareAll(p, &p->objiter, p->nStep);
  158502. }
  158503. p->rc = rc;
  158504. }
  158505. }
  158506. /*
  158507. ** If there is a "*-oal" file in the file-system corresponding to the
  158508. ** target database in the file-system, delete it. If an error occurs,
  158509. ** leave an error code and error message in the rbu handle.
  158510. */
  158511. static void rbuDeleteOalFile(sqlite3rbu *p){
  158512. char *zOal = rbuMPrintf(p, "%s-oal", p->zTarget);
  158513. if( zOal ){
  158514. sqlite3_vfs *pVfs = sqlite3_vfs_find(0);
  158515. assert( pVfs && p->rc==SQLITE_OK && p->zErrmsg==0 );
  158516. pVfs->xDelete(pVfs, zOal, 0);
  158517. sqlite3_free(zOal);
  158518. }
  158519. }
  158520. /*
  158521. ** Allocate a private rbu VFS for the rbu handle passed as the only
  158522. ** argument. This VFS will be used unless the call to sqlite3rbu_open()
  158523. ** specified a URI with a vfs=? option in place of a target database
  158524. ** file name.
  158525. */
  158526. static void rbuCreateVfs(sqlite3rbu *p){
  158527. int rnd;
  158528. char zRnd[64];
  158529. assert( p->rc==SQLITE_OK );
  158530. sqlite3_randomness(sizeof(int), (void*)&rnd);
  158531. sqlite3_snprintf(sizeof(zRnd), zRnd, "rbu_vfs_%d", rnd);
  158532. p->rc = sqlite3rbu_create_vfs(zRnd, 0);
  158533. if( p->rc==SQLITE_OK ){
  158534. sqlite3_vfs *pVfs = sqlite3_vfs_find(zRnd);
  158535. assert( pVfs );
  158536. p->zVfsName = pVfs->zName;
  158537. }
  158538. }
  158539. /*
  158540. ** Destroy the private VFS created for the rbu handle passed as the only
  158541. ** argument by an earlier call to rbuCreateVfs().
  158542. */
  158543. static void rbuDeleteVfs(sqlite3rbu *p){
  158544. if( p->zVfsName ){
  158545. sqlite3rbu_destroy_vfs(p->zVfsName);
  158546. p->zVfsName = 0;
  158547. }
  158548. }
  158549. /*
  158550. ** This user-defined SQL function is invoked with a single argument - the
  158551. ** name of a table expected to appear in the target database. It returns
  158552. ** the number of auxilliary indexes on the table.
  158553. */
  158554. static void rbuIndexCntFunc(
  158555. sqlite3_context *pCtx,
  158556. int nVal,
  158557. sqlite3_value **apVal
  158558. ){
  158559. sqlite3rbu *p = (sqlite3rbu*)sqlite3_user_data(pCtx);
  158560. sqlite3_stmt *pStmt = 0;
  158561. char *zErrmsg = 0;
  158562. int rc;
  158563. assert( nVal==1 );
  158564. rc = prepareFreeAndCollectError(p->dbMain, &pStmt, &zErrmsg,
  158565. sqlite3_mprintf("SELECT count(*) FROM sqlite_master "
  158566. "WHERE type='index' AND tbl_name = %Q", sqlite3_value_text(apVal[0]))
  158567. );
  158568. if( rc!=SQLITE_OK ){
  158569. sqlite3_result_error(pCtx, zErrmsg, -1);
  158570. }else{
  158571. int nIndex = 0;
  158572. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  158573. nIndex = sqlite3_column_int(pStmt, 0);
  158574. }
  158575. rc = sqlite3_finalize(pStmt);
  158576. if( rc==SQLITE_OK ){
  158577. sqlite3_result_int(pCtx, nIndex);
  158578. }else{
  158579. sqlite3_result_error(pCtx, sqlite3_errmsg(p->dbMain), -1);
  158580. }
  158581. }
  158582. sqlite3_free(zErrmsg);
  158583. }
  158584. /*
  158585. ** If the RBU database contains the rbu_count table, use it to initialize
  158586. ** the sqlite3rbu.nPhaseOneStep variable. The schema of the rbu_count table
  158587. ** is assumed to contain the same columns as:
  158588. **
  158589. ** CREATE TABLE rbu_count(tbl TEXT PRIMARY KEY, cnt INTEGER) WITHOUT ROWID;
  158590. **
  158591. ** There should be one row in the table for each data_xxx table in the
  158592. ** database. The 'tbl' column should contain the name of a data_xxx table,
  158593. ** and the cnt column the number of rows it contains.
  158594. **
  158595. ** sqlite3rbu.nPhaseOneStep is initialized to the sum of (1 + nIndex) * cnt
  158596. ** for all rows in the rbu_count table, where nIndex is the number of
  158597. ** indexes on the corresponding target database table.
  158598. */
  158599. static void rbuInitPhaseOneSteps(sqlite3rbu *p){
  158600. if( p->rc==SQLITE_OK ){
  158601. sqlite3_stmt *pStmt = 0;
  158602. int bExists = 0; /* True if rbu_count exists */
  158603. p->nPhaseOneStep = -1;
  158604. p->rc = sqlite3_create_function(p->dbRbu,
  158605. "rbu_index_cnt", 1, SQLITE_UTF8, (void*)p, rbuIndexCntFunc, 0, 0
  158606. );
  158607. /* Check for the rbu_count table. If it does not exist, or if an error
  158608. ** occurs, nPhaseOneStep will be left set to -1. */
  158609. if( p->rc==SQLITE_OK ){
  158610. p->rc = prepareAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  158611. "SELECT 1 FROM sqlite_master WHERE tbl_name = 'rbu_count'"
  158612. );
  158613. }
  158614. if( p->rc==SQLITE_OK ){
  158615. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  158616. bExists = 1;
  158617. }
  158618. p->rc = sqlite3_finalize(pStmt);
  158619. }
  158620. if( p->rc==SQLITE_OK && bExists ){
  158621. p->rc = prepareAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  158622. "SELECT sum(cnt * (1 + rbu_index_cnt(rbu_target_name(tbl))))"
  158623. "FROM rbu_count"
  158624. );
  158625. if( p->rc==SQLITE_OK ){
  158626. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  158627. p->nPhaseOneStep = sqlite3_column_int64(pStmt, 0);
  158628. }
  158629. p->rc = sqlite3_finalize(pStmt);
  158630. }
  158631. }
  158632. }
  158633. }
  158634. static sqlite3rbu *openRbuHandle(
  158635. const char *zTarget,
  158636. const char *zRbu,
  158637. const char *zState
  158638. ){
  158639. sqlite3rbu *p;
  158640. size_t nTarget = zTarget ? strlen(zTarget) : 0;
  158641. size_t nRbu = strlen(zRbu);
  158642. size_t nByte = sizeof(sqlite3rbu) + nTarget+1 + nRbu+1;
  158643. p = (sqlite3rbu*)sqlite3_malloc64(nByte);
  158644. if( p ){
  158645. RbuState *pState = 0;
  158646. /* Create the custom VFS. */
  158647. memset(p, 0, sizeof(sqlite3rbu));
  158648. rbuCreateVfs(p);
  158649. /* Open the target, RBU and state databases */
  158650. if( p->rc==SQLITE_OK ){
  158651. char *pCsr = (char*)&p[1];
  158652. if( zTarget ){
  158653. p->zTarget = pCsr;
  158654. memcpy(p->zTarget, zTarget, nTarget+1);
  158655. pCsr += nTarget+1;
  158656. }
  158657. p->zRbu = pCsr;
  158658. memcpy(p->zRbu, zRbu, nRbu+1);
  158659. pCsr += nRbu+1;
  158660. if( zState ){
  158661. p->zState = rbuMPrintf(p, "%s", zState);
  158662. }
  158663. rbuOpenDatabase(p);
  158664. }
  158665. if( p->rc==SQLITE_OK ){
  158666. pState = rbuLoadState(p);
  158667. assert( pState || p->rc!=SQLITE_OK );
  158668. if( p->rc==SQLITE_OK ){
  158669. if( pState->eStage==0 ){
  158670. rbuDeleteOalFile(p);
  158671. rbuInitPhaseOneSteps(p);
  158672. p->eStage = RBU_STAGE_OAL;
  158673. }else{
  158674. p->eStage = pState->eStage;
  158675. p->nPhaseOneStep = pState->nPhaseOneStep;
  158676. }
  158677. p->nProgress = pState->nProgress;
  158678. p->iOalSz = pState->iOalSz;
  158679. }
  158680. }
  158681. assert( p->rc!=SQLITE_OK || p->eStage!=0 );
  158682. if( p->rc==SQLITE_OK && p->pTargetFd->pWalFd ){
  158683. if( p->eStage==RBU_STAGE_OAL ){
  158684. p->rc = SQLITE_ERROR;
  158685. p->zErrmsg = sqlite3_mprintf("cannot update wal mode database");
  158686. }else if( p->eStage==RBU_STAGE_MOVE ){
  158687. p->eStage = RBU_STAGE_CKPT;
  158688. p->nStep = 0;
  158689. }
  158690. }
  158691. if( p->rc==SQLITE_OK
  158692. && (p->eStage==RBU_STAGE_OAL || p->eStage==RBU_STAGE_MOVE)
  158693. && pState->eStage!=0
  158694. ){
  158695. rbu_file *pFd = (rbuIsVacuum(p) ? p->pRbuFd : p->pTargetFd);
  158696. if( pFd->iCookie!=pState->iCookie ){
  158697. /* At this point (pTargetFd->iCookie) contains the value of the
  158698. ** change-counter cookie (the thing that gets incremented when a
  158699. ** transaction is committed in rollback mode) currently stored on
  158700. ** page 1 of the database file. */
  158701. p->rc = SQLITE_BUSY;
  158702. p->zErrmsg = sqlite3_mprintf("database modified during rbu %s",
  158703. (rbuIsVacuum(p) ? "vacuum" : "update")
  158704. );
  158705. }
  158706. }
  158707. if( p->rc==SQLITE_OK ){
  158708. if( p->eStage==RBU_STAGE_OAL ){
  158709. sqlite3 *db = p->dbMain;
  158710. p->rc = sqlite3_exec(p->dbRbu, "BEGIN", 0, 0, &p->zErrmsg);
  158711. /* Point the object iterator at the first object */
  158712. if( p->rc==SQLITE_OK ){
  158713. p->rc = rbuObjIterFirst(p, &p->objiter);
  158714. }
  158715. /* If the RBU database contains no data_xxx tables, declare the RBU
  158716. ** update finished. */
  158717. if( p->rc==SQLITE_OK && p->objiter.zTbl==0 ){
  158718. p->rc = SQLITE_DONE;
  158719. p->eStage = RBU_STAGE_DONE;
  158720. }else{
  158721. if( p->rc==SQLITE_OK && pState->eStage==0 && rbuIsVacuum(p) ){
  158722. rbuCopyPragma(p, "page_size");
  158723. rbuCopyPragma(p, "auto_vacuum");
  158724. }
  158725. /* Open transactions both databases. The *-oal file is opened or
  158726. ** created at this point. */
  158727. if( p->rc==SQLITE_OK ){
  158728. p->rc = sqlite3_exec(db, "BEGIN IMMEDIATE", 0, 0, &p->zErrmsg);
  158729. }
  158730. /* Check if the main database is a zipvfs db. If it is, set the upper
  158731. ** level pager to use "journal_mode=off". This prevents it from
  158732. ** generating a large journal using a temp file. */
  158733. if( p->rc==SQLITE_OK ){
  158734. int frc = sqlite3_file_control(db, "main", SQLITE_FCNTL_ZIPVFS, 0);
  158735. if( frc==SQLITE_OK ){
  158736. p->rc = sqlite3_exec(
  158737. db, "PRAGMA journal_mode=off",0,0,&p->zErrmsg);
  158738. }
  158739. }
  158740. if( p->rc==SQLITE_OK ){
  158741. rbuSetupOal(p, pState);
  158742. }
  158743. }
  158744. }else if( p->eStage==RBU_STAGE_MOVE ){
  158745. /* no-op */
  158746. }else if( p->eStage==RBU_STAGE_CKPT ){
  158747. rbuSetupCheckpoint(p, pState);
  158748. }else if( p->eStage==RBU_STAGE_DONE ){
  158749. p->rc = SQLITE_DONE;
  158750. }else{
  158751. p->rc = SQLITE_CORRUPT;
  158752. }
  158753. }
  158754. rbuFreeState(pState);
  158755. }
  158756. return p;
  158757. }
  158758. /*
  158759. ** Allocate and return an RBU handle with all fields zeroed except for the
  158760. ** error code, which is set to SQLITE_MISUSE.
  158761. */
  158762. static sqlite3rbu *rbuMisuseError(void){
  158763. sqlite3rbu *pRet;
  158764. pRet = sqlite3_malloc64(sizeof(sqlite3rbu));
  158765. if( pRet ){
  158766. memset(pRet, 0, sizeof(sqlite3rbu));
  158767. pRet->rc = SQLITE_MISUSE;
  158768. }
  158769. return pRet;
  158770. }
  158771. /*
  158772. ** Open and return a new RBU handle.
  158773. */
  158774. SQLITE_API sqlite3rbu *sqlite3rbu_open(
  158775. const char *zTarget,
  158776. const char *zRbu,
  158777. const char *zState
  158778. ){
  158779. if( zTarget==0 || zRbu==0 ){ return rbuMisuseError(); }
  158780. /* TODO: Check that zTarget and zRbu are non-NULL */
  158781. return openRbuHandle(zTarget, zRbu, zState);
  158782. }
  158783. /*
  158784. ** Open a handle to begin or resume an RBU VACUUM operation.
  158785. */
  158786. SQLITE_API sqlite3rbu *sqlite3rbu_vacuum(
  158787. const char *zTarget,
  158788. const char *zState
  158789. ){
  158790. if( zTarget==0 ){ return rbuMisuseError(); }
  158791. /* TODO: Check that both arguments are non-NULL */
  158792. return openRbuHandle(0, zTarget, zState);
  158793. }
  158794. /*
  158795. ** Return the database handle used by pRbu.
  158796. */
  158797. SQLITE_API sqlite3 *sqlite3rbu_db(sqlite3rbu *pRbu, int bRbu){
  158798. sqlite3 *db = 0;
  158799. if( pRbu ){
  158800. db = (bRbu ? pRbu->dbRbu : pRbu->dbMain);
  158801. }
  158802. return db;
  158803. }
  158804. /*
  158805. ** If the error code currently stored in the RBU handle is SQLITE_CONSTRAINT,
  158806. ** then edit any error message string so as to remove all occurrences of
  158807. ** the pattern "rbu_imp_[0-9]*".
  158808. */
  158809. static void rbuEditErrmsg(sqlite3rbu *p){
  158810. if( p->rc==SQLITE_CONSTRAINT && p->zErrmsg ){
  158811. unsigned int i;
  158812. size_t nErrmsg = strlen(p->zErrmsg);
  158813. for(i=0; i<(nErrmsg-8); i++){
  158814. if( memcmp(&p->zErrmsg[i], "rbu_imp_", 8)==0 ){
  158815. int nDel = 8;
  158816. while( p->zErrmsg[i+nDel]>='0' && p->zErrmsg[i+nDel]<='9' ) nDel++;
  158817. memmove(&p->zErrmsg[i], &p->zErrmsg[i+nDel], nErrmsg + 1 - i - nDel);
  158818. nErrmsg -= nDel;
  158819. }
  158820. }
  158821. }
  158822. }
  158823. /*
  158824. ** Close the RBU handle.
  158825. */
  158826. SQLITE_API int sqlite3rbu_close(sqlite3rbu *p, char **pzErrmsg){
  158827. int rc;
  158828. if( p ){
  158829. /* Commit the transaction to the *-oal file. */
  158830. if( p->rc==SQLITE_OK && p->eStage==RBU_STAGE_OAL ){
  158831. p->rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, &p->zErrmsg);
  158832. }
  158833. rbuSaveState(p, p->eStage);
  158834. if( p->rc==SQLITE_OK && p->eStage==RBU_STAGE_OAL ){
  158835. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, &p->zErrmsg);
  158836. }
  158837. /* Close any open statement handles. */
  158838. rbuObjIterFinalize(&p->objiter);
  158839. /* If this is an RBU vacuum handle and the vacuum has either finished
  158840. ** successfully or encountered an error, delete the contents of the
  158841. ** state table. This causes the next call to sqlite3rbu_vacuum()
  158842. ** specifying the current target and state databases to start a new
  158843. ** vacuum from scratch. */
  158844. if( rbuIsVacuum(p) && p->rc!=SQLITE_OK && p->dbRbu ){
  158845. int rc2 = sqlite3_exec(p->dbRbu, "DELETE FROM stat.rbu_state", 0, 0, 0);
  158846. if( p->rc==SQLITE_DONE && rc2!=SQLITE_OK ) p->rc = rc2;
  158847. }
  158848. /* Close the open database handle and VFS object. */
  158849. sqlite3_close(p->dbRbu);
  158850. sqlite3_close(p->dbMain);
  158851. rbuDeleteVfs(p);
  158852. sqlite3_free(p->aBuf);
  158853. sqlite3_free(p->aFrame);
  158854. rbuEditErrmsg(p);
  158855. rc = p->rc;
  158856. *pzErrmsg = p->zErrmsg;
  158857. sqlite3_free(p->zState);
  158858. sqlite3_free(p);
  158859. }else{
  158860. rc = SQLITE_NOMEM;
  158861. *pzErrmsg = 0;
  158862. }
  158863. return rc;
  158864. }
  158865. /*
  158866. ** Return the total number of key-value operations (inserts, deletes or
  158867. ** updates) that have been performed on the target database since the
  158868. ** current RBU update was started.
  158869. */
  158870. SQLITE_API sqlite3_int64 sqlite3rbu_progress(sqlite3rbu *pRbu){
  158871. return pRbu->nProgress;
  158872. }
  158873. /*
  158874. ** Return permyriadage progress indications for the two main stages of
  158875. ** an RBU update.
  158876. */
  158877. SQLITE_API void sqlite3rbu_bp_progress(sqlite3rbu *p, int *pnOne, int *pnTwo){
  158878. const int MAX_PROGRESS = 10000;
  158879. switch( p->eStage ){
  158880. case RBU_STAGE_OAL:
  158881. if( p->nPhaseOneStep>0 ){
  158882. *pnOne = (int)(MAX_PROGRESS * (i64)p->nProgress/(i64)p->nPhaseOneStep);
  158883. }else{
  158884. *pnOne = -1;
  158885. }
  158886. *pnTwo = 0;
  158887. break;
  158888. case RBU_STAGE_MOVE:
  158889. *pnOne = MAX_PROGRESS;
  158890. *pnTwo = 0;
  158891. break;
  158892. case RBU_STAGE_CKPT:
  158893. *pnOne = MAX_PROGRESS;
  158894. *pnTwo = (int)(MAX_PROGRESS * (i64)p->nStep / (i64)p->nFrame);
  158895. break;
  158896. case RBU_STAGE_DONE:
  158897. *pnOne = MAX_PROGRESS;
  158898. *pnTwo = MAX_PROGRESS;
  158899. break;
  158900. default:
  158901. assert( 0 );
  158902. }
  158903. }
  158904. /*
  158905. ** Return the current state of the RBU vacuum or update operation.
  158906. */
  158907. SQLITE_API int sqlite3rbu_state(sqlite3rbu *p){
  158908. int aRes[] = {
  158909. 0, SQLITE_RBU_STATE_OAL, SQLITE_RBU_STATE_MOVE,
  158910. 0, SQLITE_RBU_STATE_CHECKPOINT, SQLITE_RBU_STATE_DONE
  158911. };
  158912. assert( RBU_STAGE_OAL==1 );
  158913. assert( RBU_STAGE_MOVE==2 );
  158914. assert( RBU_STAGE_CKPT==4 );
  158915. assert( RBU_STAGE_DONE==5 );
  158916. assert( aRes[RBU_STAGE_OAL]==SQLITE_RBU_STATE_OAL );
  158917. assert( aRes[RBU_STAGE_MOVE]==SQLITE_RBU_STATE_MOVE );
  158918. assert( aRes[RBU_STAGE_CKPT]==SQLITE_RBU_STATE_CHECKPOINT );
  158919. assert( aRes[RBU_STAGE_DONE]==SQLITE_RBU_STATE_DONE );
  158920. if( p->rc!=SQLITE_OK && p->rc!=SQLITE_DONE ){
  158921. return SQLITE_RBU_STATE_ERROR;
  158922. }else{
  158923. assert( p->rc!=SQLITE_DONE || p->eStage==RBU_STAGE_DONE );
  158924. assert( p->eStage==RBU_STAGE_OAL
  158925. || p->eStage==RBU_STAGE_MOVE
  158926. || p->eStage==RBU_STAGE_CKPT
  158927. || p->eStage==RBU_STAGE_DONE
  158928. );
  158929. return aRes[p->eStage];
  158930. }
  158931. }
  158932. SQLITE_API int sqlite3rbu_savestate(sqlite3rbu *p){
  158933. int rc = p->rc;
  158934. if( rc==SQLITE_DONE ) return SQLITE_OK;
  158935. assert( p->eStage>=RBU_STAGE_OAL && p->eStage<=RBU_STAGE_DONE );
  158936. if( p->eStage==RBU_STAGE_OAL ){
  158937. assert( rc!=SQLITE_DONE );
  158938. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, 0);
  158939. }
  158940. p->rc = rc;
  158941. rbuSaveState(p, p->eStage);
  158942. rc = p->rc;
  158943. if( p->eStage==RBU_STAGE_OAL ){
  158944. assert( rc!=SQLITE_DONE );
  158945. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, 0);
  158946. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbRbu, "BEGIN IMMEDIATE", 0, 0, 0);
  158947. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbMain, "BEGIN IMMEDIATE", 0, 0,0);
  158948. }
  158949. p->rc = rc;
  158950. return rc;
  158951. }
  158952. /**************************************************************************
  158953. ** Beginning of RBU VFS shim methods. The VFS shim modifies the behaviour
  158954. ** of a standard VFS in the following ways:
  158955. **
  158956. ** 1. Whenever the first page of a main database file is read or
  158957. ** written, the value of the change-counter cookie is stored in
  158958. ** rbu_file.iCookie. Similarly, the value of the "write-version"
  158959. ** database header field is stored in rbu_file.iWriteVer. This ensures
  158960. ** that the values are always trustworthy within an open transaction.
  158961. **
  158962. ** 2. Whenever an SQLITE_OPEN_WAL file is opened, the (rbu_file.pWalFd)
  158963. ** member variable of the associated database file descriptor is set
  158964. ** to point to the new file. A mutex protected linked list of all main
  158965. ** db fds opened using a particular RBU VFS is maintained at
  158966. ** rbu_vfs.pMain to facilitate this.
  158967. **
  158968. ** 3. Using a new file-control "SQLITE_FCNTL_RBU", a main db rbu_file
  158969. ** object can be marked as the target database of an RBU update. This
  158970. ** turns on the following extra special behaviour:
  158971. **
  158972. ** 3a. If xAccess() is called to check if there exists a *-wal file
  158973. ** associated with an RBU target database currently in RBU_STAGE_OAL
  158974. ** stage (preparing the *-oal file), the following special handling
  158975. ** applies:
  158976. **
  158977. ** * if the *-wal file does exist, return SQLITE_CANTOPEN. An RBU
  158978. ** target database may not be in wal mode already.
  158979. **
  158980. ** * if the *-wal file does not exist, set the output parameter to
  158981. ** non-zero (to tell SQLite that it does exist) anyway.
  158982. **
  158983. ** Then, when xOpen() is called to open the *-wal file associated with
  158984. ** the RBU target in RBU_STAGE_OAL stage, instead of opening the *-wal
  158985. ** file, the rbu vfs opens the corresponding *-oal file instead.
  158986. **
  158987. ** 3b. The *-shm pages returned by xShmMap() for a target db file in
  158988. ** RBU_STAGE_OAL mode are actually stored in heap memory. This is to
  158989. ** avoid creating a *-shm file on disk. Additionally, xShmLock() calls
  158990. ** are no-ops on target database files in RBU_STAGE_OAL mode. This is
  158991. ** because assert() statements in some VFS implementations fail if
  158992. ** xShmLock() is called before xShmMap().
  158993. **
  158994. ** 3c. If an EXCLUSIVE lock is attempted on a target database file in any
  158995. ** mode except RBU_STAGE_DONE (all work completed and checkpointed), it
  158996. ** fails with an SQLITE_BUSY error. This is to stop RBU connections
  158997. ** from automatically checkpointing a *-wal (or *-oal) file from within
  158998. ** sqlite3_close().
  158999. **
  159000. ** 3d. In RBU_STAGE_CAPTURE mode, all xRead() calls on the wal file, and
  159001. ** all xWrite() calls on the target database file perform no IO.
  159002. ** Instead the frame and page numbers that would be read and written
  159003. ** are recorded. Additionally, successful attempts to obtain exclusive
  159004. ** xShmLock() WRITER, CHECKPOINTER and READ0 locks on the target
  159005. ** database file are recorded. xShmLock() calls to unlock the same
  159006. ** locks are no-ops (so that once obtained, these locks are never
  159007. ** relinquished). Finally, calls to xSync() on the target database
  159008. ** file fail with SQLITE_INTERNAL errors.
  159009. */
  159010. static void rbuUnlockShm(rbu_file *p){
  159011. if( p->pRbu ){
  159012. int (*xShmLock)(sqlite3_file*,int,int,int) = p->pReal->pMethods->xShmLock;
  159013. int i;
  159014. for(i=0; i<SQLITE_SHM_NLOCK;i++){
  159015. if( (1<<i) & p->pRbu->mLock ){
  159016. xShmLock(p->pReal, i, 1, SQLITE_SHM_UNLOCK|SQLITE_SHM_EXCLUSIVE);
  159017. }
  159018. }
  159019. p->pRbu->mLock = 0;
  159020. }
  159021. }
  159022. /*
  159023. ** Close an rbu file.
  159024. */
  159025. static int rbuVfsClose(sqlite3_file *pFile){
  159026. rbu_file *p = (rbu_file*)pFile;
  159027. int rc;
  159028. int i;
  159029. /* Free the contents of the apShm[] array. And the array itself. */
  159030. for(i=0; i<p->nShm; i++){
  159031. sqlite3_free(p->apShm[i]);
  159032. }
  159033. sqlite3_free(p->apShm);
  159034. p->apShm = 0;
  159035. sqlite3_free(p->zDel);
  159036. if( p->openFlags & SQLITE_OPEN_MAIN_DB ){
  159037. rbu_file **pp;
  159038. sqlite3_mutex_enter(p->pRbuVfs->mutex);
  159039. for(pp=&p->pRbuVfs->pMain; *pp!=p; pp=&((*pp)->pMainNext));
  159040. *pp = p->pMainNext;
  159041. sqlite3_mutex_leave(p->pRbuVfs->mutex);
  159042. rbuUnlockShm(p);
  159043. p->pReal->pMethods->xShmUnmap(p->pReal, 0);
  159044. }
  159045. /* Close the underlying file handle */
  159046. rc = p->pReal->pMethods->xClose(p->pReal);
  159047. return rc;
  159048. }
  159049. /*
  159050. ** Read and return an unsigned 32-bit big-endian integer from the buffer
  159051. ** passed as the only argument.
  159052. */
  159053. static u32 rbuGetU32(u8 *aBuf){
  159054. return ((u32)aBuf[0] << 24)
  159055. + ((u32)aBuf[1] << 16)
  159056. + ((u32)aBuf[2] << 8)
  159057. + ((u32)aBuf[3]);
  159058. }
  159059. /*
  159060. ** Write an unsigned 32-bit value in big-endian format to the supplied
  159061. ** buffer.
  159062. */
  159063. static void rbuPutU32(u8 *aBuf, u32 iVal){
  159064. aBuf[0] = (iVal >> 24) & 0xFF;
  159065. aBuf[1] = (iVal >> 16) & 0xFF;
  159066. aBuf[2] = (iVal >> 8) & 0xFF;
  159067. aBuf[3] = (iVal >> 0) & 0xFF;
  159068. }
  159069. static void rbuPutU16(u8 *aBuf, u16 iVal){
  159070. aBuf[0] = (iVal >> 8) & 0xFF;
  159071. aBuf[1] = (iVal >> 0) & 0xFF;
  159072. }
  159073. /*
  159074. ** Read data from an rbuVfs-file.
  159075. */
  159076. static int rbuVfsRead(
  159077. sqlite3_file *pFile,
  159078. void *zBuf,
  159079. int iAmt,
  159080. sqlite_int64 iOfst
  159081. ){
  159082. rbu_file *p = (rbu_file*)pFile;
  159083. sqlite3rbu *pRbu = p->pRbu;
  159084. int rc;
  159085. if( pRbu && pRbu->eStage==RBU_STAGE_CAPTURE ){
  159086. assert( p->openFlags & SQLITE_OPEN_WAL );
  159087. rc = rbuCaptureWalRead(p->pRbu, iOfst, iAmt);
  159088. }else{
  159089. if( pRbu && pRbu->eStage==RBU_STAGE_OAL
  159090. && (p->openFlags & SQLITE_OPEN_WAL)
  159091. && iOfst>=pRbu->iOalSz
  159092. ){
  159093. rc = SQLITE_OK;
  159094. memset(zBuf, 0, iAmt);
  159095. }else{
  159096. rc = p->pReal->pMethods->xRead(p->pReal, zBuf, iAmt, iOfst);
  159097. #if 1
  159098. /* If this is being called to read the first page of the target
  159099. ** database as part of an rbu vacuum operation, synthesize the
  159100. ** contents of the first page if it does not yet exist. Otherwise,
  159101. ** SQLite will not check for a *-wal file. */
  159102. if( pRbu && rbuIsVacuum(pRbu)
  159103. && rc==SQLITE_IOERR_SHORT_READ && iOfst==0
  159104. && (p->openFlags & SQLITE_OPEN_MAIN_DB)
  159105. && pRbu->rc==SQLITE_OK
  159106. ){
  159107. sqlite3_file *pFd = (sqlite3_file*)pRbu->pRbuFd;
  159108. rc = pFd->pMethods->xRead(pFd, zBuf, iAmt, iOfst);
  159109. if( rc==SQLITE_OK ){
  159110. u8 *aBuf = (u8*)zBuf;
  159111. u32 iRoot = rbuGetU32(&aBuf[52]) ? 1 : 0;
  159112. rbuPutU32(&aBuf[52], iRoot); /* largest root page number */
  159113. rbuPutU32(&aBuf[36], 0); /* number of free pages */
  159114. rbuPutU32(&aBuf[32], 0); /* first page on free list trunk */
  159115. rbuPutU32(&aBuf[28], 1); /* size of db file in pages */
  159116. rbuPutU32(&aBuf[24], pRbu->pRbuFd->iCookie+1); /* Change counter */
  159117. if( iAmt>100 ){
  159118. memset(&aBuf[100], 0, iAmt-100);
  159119. rbuPutU16(&aBuf[105], iAmt & 0xFFFF);
  159120. aBuf[100] = 0x0D;
  159121. }
  159122. }
  159123. }
  159124. #endif
  159125. }
  159126. if( rc==SQLITE_OK && iOfst==0 && (p->openFlags & SQLITE_OPEN_MAIN_DB) ){
  159127. /* These look like magic numbers. But they are stable, as they are part
  159128. ** of the definition of the SQLite file format, which may not change. */
  159129. u8 *pBuf = (u8*)zBuf;
  159130. p->iCookie = rbuGetU32(&pBuf[24]);
  159131. p->iWriteVer = pBuf[19];
  159132. }
  159133. }
  159134. return rc;
  159135. }
  159136. /*
  159137. ** Write data to an rbuVfs-file.
  159138. */
  159139. static int rbuVfsWrite(
  159140. sqlite3_file *pFile,
  159141. const void *zBuf,
  159142. int iAmt,
  159143. sqlite_int64 iOfst
  159144. ){
  159145. rbu_file *p = (rbu_file*)pFile;
  159146. sqlite3rbu *pRbu = p->pRbu;
  159147. int rc;
  159148. if( pRbu && pRbu->eStage==RBU_STAGE_CAPTURE ){
  159149. assert( p->openFlags & SQLITE_OPEN_MAIN_DB );
  159150. rc = rbuCaptureDbWrite(p->pRbu, iOfst);
  159151. }else{
  159152. if( pRbu && pRbu->eStage==RBU_STAGE_OAL
  159153. && (p->openFlags & SQLITE_OPEN_WAL)
  159154. && iOfst>=pRbu->iOalSz
  159155. ){
  159156. pRbu->iOalSz = iAmt + iOfst;
  159157. }
  159158. rc = p->pReal->pMethods->xWrite(p->pReal, zBuf, iAmt, iOfst);
  159159. if( rc==SQLITE_OK && iOfst==0 && (p->openFlags & SQLITE_OPEN_MAIN_DB) ){
  159160. /* These look like magic numbers. But they are stable, as they are part
  159161. ** of the definition of the SQLite file format, which may not change. */
  159162. u8 *pBuf = (u8*)zBuf;
  159163. p->iCookie = rbuGetU32(&pBuf[24]);
  159164. p->iWriteVer = pBuf[19];
  159165. }
  159166. }
  159167. return rc;
  159168. }
  159169. /*
  159170. ** Truncate an rbuVfs-file.
  159171. */
  159172. static int rbuVfsTruncate(sqlite3_file *pFile, sqlite_int64 size){
  159173. rbu_file *p = (rbu_file*)pFile;
  159174. return p->pReal->pMethods->xTruncate(p->pReal, size);
  159175. }
  159176. /*
  159177. ** Sync an rbuVfs-file.
  159178. */
  159179. static int rbuVfsSync(sqlite3_file *pFile, int flags){
  159180. rbu_file *p = (rbu_file *)pFile;
  159181. if( p->pRbu && p->pRbu->eStage==RBU_STAGE_CAPTURE ){
  159182. if( p->openFlags & SQLITE_OPEN_MAIN_DB ){
  159183. return SQLITE_INTERNAL;
  159184. }
  159185. return SQLITE_OK;
  159186. }
  159187. return p->pReal->pMethods->xSync(p->pReal, flags);
  159188. }
  159189. /*
  159190. ** Return the current file-size of an rbuVfs-file.
  159191. */
  159192. static int rbuVfsFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
  159193. rbu_file *p = (rbu_file *)pFile;
  159194. int rc;
  159195. rc = p->pReal->pMethods->xFileSize(p->pReal, pSize);
  159196. /* If this is an RBU vacuum operation and this is the target database,
  159197. ** pretend that it has at least one page. Otherwise, SQLite will not
  159198. ** check for the existance of a *-wal file. rbuVfsRead() contains
  159199. ** similar logic. */
  159200. if( rc==SQLITE_OK && *pSize==0
  159201. && p->pRbu && rbuIsVacuum(p->pRbu)
  159202. && (p->openFlags & SQLITE_OPEN_MAIN_DB)
  159203. ){
  159204. *pSize = 1024;
  159205. }
  159206. return rc;
  159207. }
  159208. /*
  159209. ** Lock an rbuVfs-file.
  159210. */
  159211. static int rbuVfsLock(sqlite3_file *pFile, int eLock){
  159212. rbu_file *p = (rbu_file*)pFile;
  159213. sqlite3rbu *pRbu = p->pRbu;
  159214. int rc = SQLITE_OK;
  159215. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  159216. if( eLock==SQLITE_LOCK_EXCLUSIVE
  159217. && (p->bNolock || (pRbu && pRbu->eStage!=RBU_STAGE_DONE))
  159218. ){
  159219. /* Do not allow EXCLUSIVE locks. Preventing SQLite from taking this
  159220. ** prevents it from checkpointing the database from sqlite3_close(). */
  159221. rc = SQLITE_BUSY;
  159222. }else{
  159223. rc = p->pReal->pMethods->xLock(p->pReal, eLock);
  159224. }
  159225. return rc;
  159226. }
  159227. /*
  159228. ** Unlock an rbuVfs-file.
  159229. */
  159230. static int rbuVfsUnlock(sqlite3_file *pFile, int eLock){
  159231. rbu_file *p = (rbu_file *)pFile;
  159232. return p->pReal->pMethods->xUnlock(p->pReal, eLock);
  159233. }
  159234. /*
  159235. ** Check if another file-handle holds a RESERVED lock on an rbuVfs-file.
  159236. */
  159237. static int rbuVfsCheckReservedLock(sqlite3_file *pFile, int *pResOut){
  159238. rbu_file *p = (rbu_file *)pFile;
  159239. return p->pReal->pMethods->xCheckReservedLock(p->pReal, pResOut);
  159240. }
  159241. /*
  159242. ** File control method. For custom operations on an rbuVfs-file.
  159243. */
  159244. static int rbuVfsFileControl(sqlite3_file *pFile, int op, void *pArg){
  159245. rbu_file *p = (rbu_file *)pFile;
  159246. int (*xControl)(sqlite3_file*,int,void*) = p->pReal->pMethods->xFileControl;
  159247. int rc;
  159248. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB)
  159249. || p->openFlags & (SQLITE_OPEN_TRANSIENT_DB|SQLITE_OPEN_TEMP_JOURNAL)
  159250. );
  159251. if( op==SQLITE_FCNTL_RBU ){
  159252. sqlite3rbu *pRbu = (sqlite3rbu*)pArg;
  159253. /* First try to find another RBU vfs lower down in the vfs stack. If
  159254. ** one is found, this vfs will operate in pass-through mode. The lower
  159255. ** level vfs will do the special RBU handling. */
  159256. rc = xControl(p->pReal, op, pArg);
  159257. if( rc==SQLITE_NOTFOUND ){
  159258. /* Now search for a zipvfs instance lower down in the VFS stack. If
  159259. ** one is found, this is an error. */
  159260. void *dummy = 0;
  159261. rc = xControl(p->pReal, SQLITE_FCNTL_ZIPVFS, &dummy);
  159262. if( rc==SQLITE_OK ){
  159263. rc = SQLITE_ERROR;
  159264. pRbu->zErrmsg = sqlite3_mprintf("rbu/zipvfs setup error");
  159265. }else if( rc==SQLITE_NOTFOUND ){
  159266. pRbu->pTargetFd = p;
  159267. p->pRbu = pRbu;
  159268. if( p->pWalFd ) p->pWalFd->pRbu = pRbu;
  159269. rc = SQLITE_OK;
  159270. }
  159271. }
  159272. return rc;
  159273. }
  159274. else if( op==SQLITE_FCNTL_RBUCNT ){
  159275. sqlite3rbu *pRbu = (sqlite3rbu*)pArg;
  159276. pRbu->nRbu++;
  159277. pRbu->pRbuFd = p;
  159278. p->bNolock = 1;
  159279. }
  159280. rc = xControl(p->pReal, op, pArg);
  159281. if( rc==SQLITE_OK && op==SQLITE_FCNTL_VFSNAME ){
  159282. rbu_vfs *pRbuVfs = p->pRbuVfs;
  159283. char *zIn = *(char**)pArg;
  159284. char *zOut = sqlite3_mprintf("rbu(%s)/%z", pRbuVfs->base.zName, zIn);
  159285. *(char**)pArg = zOut;
  159286. if( zOut==0 ) rc = SQLITE_NOMEM;
  159287. }
  159288. return rc;
  159289. }
  159290. /*
  159291. ** Return the sector-size in bytes for an rbuVfs-file.
  159292. */
  159293. static int rbuVfsSectorSize(sqlite3_file *pFile){
  159294. rbu_file *p = (rbu_file *)pFile;
  159295. return p->pReal->pMethods->xSectorSize(p->pReal);
  159296. }
  159297. /*
  159298. ** Return the device characteristic flags supported by an rbuVfs-file.
  159299. */
  159300. static int rbuVfsDeviceCharacteristics(sqlite3_file *pFile){
  159301. rbu_file *p = (rbu_file *)pFile;
  159302. return p->pReal->pMethods->xDeviceCharacteristics(p->pReal);
  159303. }
  159304. /*
  159305. ** Take or release a shared-memory lock.
  159306. */
  159307. static int rbuVfsShmLock(sqlite3_file *pFile, int ofst, int n, int flags){
  159308. rbu_file *p = (rbu_file*)pFile;
  159309. sqlite3rbu *pRbu = p->pRbu;
  159310. int rc = SQLITE_OK;
  159311. #ifdef SQLITE_AMALGAMATION
  159312. assert( WAL_CKPT_LOCK==1 );
  159313. #endif
  159314. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  159315. if( pRbu && (pRbu->eStage==RBU_STAGE_OAL || pRbu->eStage==RBU_STAGE_MOVE) ){
  159316. /* Magic number 1 is the WAL_CKPT_LOCK lock. Preventing SQLite from
  159317. ** taking this lock also prevents any checkpoints from occurring.
  159318. ** todo: really, it's not clear why this might occur, as
  159319. ** wal_autocheckpoint ought to be turned off. */
  159320. if( ofst==WAL_LOCK_CKPT && n==1 ) rc = SQLITE_BUSY;
  159321. }else{
  159322. int bCapture = 0;
  159323. if( n==1 && (flags & SQLITE_SHM_EXCLUSIVE)
  159324. && pRbu && pRbu->eStage==RBU_STAGE_CAPTURE
  159325. && (ofst==WAL_LOCK_WRITE || ofst==WAL_LOCK_CKPT || ofst==WAL_LOCK_READ0)
  159326. ){
  159327. bCapture = 1;
  159328. }
  159329. if( bCapture==0 || 0==(flags & SQLITE_SHM_UNLOCK) ){
  159330. rc = p->pReal->pMethods->xShmLock(p->pReal, ofst, n, flags);
  159331. if( bCapture && rc==SQLITE_OK ){
  159332. pRbu->mLock |= (1 << ofst);
  159333. }
  159334. }
  159335. }
  159336. return rc;
  159337. }
  159338. /*
  159339. ** Obtain a pointer to a mapping of a single 32KiB page of the *-shm file.
  159340. */
  159341. static int rbuVfsShmMap(
  159342. sqlite3_file *pFile,
  159343. int iRegion,
  159344. int szRegion,
  159345. int isWrite,
  159346. void volatile **pp
  159347. ){
  159348. rbu_file *p = (rbu_file*)pFile;
  159349. int rc = SQLITE_OK;
  159350. int eStage = (p->pRbu ? p->pRbu->eStage : 0);
  159351. /* If not in RBU_STAGE_OAL, allow this call to pass through. Or, if this
  159352. ** rbu is in the RBU_STAGE_OAL state, use heap memory for *-shm space
  159353. ** instead of a file on disk. */
  159354. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  159355. if( eStage==RBU_STAGE_OAL || eStage==RBU_STAGE_MOVE ){
  159356. if( iRegion<=p->nShm ){
  159357. int nByte = (iRegion+1) * sizeof(char*);
  159358. char **apNew = (char**)sqlite3_realloc64(p->apShm, nByte);
  159359. if( apNew==0 ){
  159360. rc = SQLITE_NOMEM;
  159361. }else{
  159362. memset(&apNew[p->nShm], 0, sizeof(char*) * (1 + iRegion - p->nShm));
  159363. p->apShm = apNew;
  159364. p->nShm = iRegion+1;
  159365. }
  159366. }
  159367. if( rc==SQLITE_OK && p->apShm[iRegion]==0 ){
  159368. char *pNew = (char*)sqlite3_malloc64(szRegion);
  159369. if( pNew==0 ){
  159370. rc = SQLITE_NOMEM;
  159371. }else{
  159372. memset(pNew, 0, szRegion);
  159373. p->apShm[iRegion] = pNew;
  159374. }
  159375. }
  159376. if( rc==SQLITE_OK ){
  159377. *pp = p->apShm[iRegion];
  159378. }else{
  159379. *pp = 0;
  159380. }
  159381. }else{
  159382. assert( p->apShm==0 );
  159383. rc = p->pReal->pMethods->xShmMap(p->pReal, iRegion, szRegion, isWrite, pp);
  159384. }
  159385. return rc;
  159386. }
  159387. /*
  159388. ** Memory barrier.
  159389. */
  159390. static void rbuVfsShmBarrier(sqlite3_file *pFile){
  159391. rbu_file *p = (rbu_file *)pFile;
  159392. p->pReal->pMethods->xShmBarrier(p->pReal);
  159393. }
  159394. /*
  159395. ** The xShmUnmap method.
  159396. */
  159397. static int rbuVfsShmUnmap(sqlite3_file *pFile, int delFlag){
  159398. rbu_file *p = (rbu_file*)pFile;
  159399. int rc = SQLITE_OK;
  159400. int eStage = (p->pRbu ? p->pRbu->eStage : 0);
  159401. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  159402. if( eStage==RBU_STAGE_OAL || eStage==RBU_STAGE_MOVE ){
  159403. /* no-op */
  159404. }else{
  159405. /* Release the checkpointer and writer locks */
  159406. rbuUnlockShm(p);
  159407. rc = p->pReal->pMethods->xShmUnmap(p->pReal, delFlag);
  159408. }
  159409. return rc;
  159410. }
  159411. /*
  159412. ** Given that zWal points to a buffer containing a wal file name passed to
  159413. ** either the xOpen() or xAccess() VFS method, return a pointer to the
  159414. ** file-handle opened by the same database connection on the corresponding
  159415. ** database file.
  159416. */
  159417. static rbu_file *rbuFindMaindb(rbu_vfs *pRbuVfs, const char *zWal){
  159418. rbu_file *pDb;
  159419. sqlite3_mutex_enter(pRbuVfs->mutex);
  159420. for(pDb=pRbuVfs->pMain; pDb && pDb->zWal!=zWal; pDb=pDb->pMainNext){}
  159421. sqlite3_mutex_leave(pRbuVfs->mutex);
  159422. return pDb;
  159423. }
  159424. /*
  159425. ** A main database named zName has just been opened. The following
  159426. ** function returns a pointer to a buffer owned by SQLite that contains
  159427. ** the name of the *-wal file this db connection will use. SQLite
  159428. ** happens to pass a pointer to this buffer when using xAccess()
  159429. ** or xOpen() to operate on the *-wal file.
  159430. */
  159431. static const char *rbuMainToWal(const char *zName, int flags){
  159432. int n = (int)strlen(zName);
  159433. const char *z = &zName[n];
  159434. if( flags & SQLITE_OPEN_URI ){
  159435. int odd = 0;
  159436. while( 1 ){
  159437. if( z[0]==0 ){
  159438. odd = 1 - odd;
  159439. if( odd && z[1]==0 ) break;
  159440. }
  159441. z++;
  159442. }
  159443. z += 2;
  159444. }else{
  159445. while( *z==0 ) z++;
  159446. }
  159447. z += (n + 8 + 1);
  159448. return z;
  159449. }
  159450. /*
  159451. ** Open an rbu file handle.
  159452. */
  159453. static int rbuVfsOpen(
  159454. sqlite3_vfs *pVfs,
  159455. const char *zName,
  159456. sqlite3_file *pFile,
  159457. int flags,
  159458. int *pOutFlags
  159459. ){
  159460. static sqlite3_io_methods rbuvfs_io_methods = {
  159461. 2, /* iVersion */
  159462. rbuVfsClose, /* xClose */
  159463. rbuVfsRead, /* xRead */
  159464. rbuVfsWrite, /* xWrite */
  159465. rbuVfsTruncate, /* xTruncate */
  159466. rbuVfsSync, /* xSync */
  159467. rbuVfsFileSize, /* xFileSize */
  159468. rbuVfsLock, /* xLock */
  159469. rbuVfsUnlock, /* xUnlock */
  159470. rbuVfsCheckReservedLock, /* xCheckReservedLock */
  159471. rbuVfsFileControl, /* xFileControl */
  159472. rbuVfsSectorSize, /* xSectorSize */
  159473. rbuVfsDeviceCharacteristics, /* xDeviceCharacteristics */
  159474. rbuVfsShmMap, /* xShmMap */
  159475. rbuVfsShmLock, /* xShmLock */
  159476. rbuVfsShmBarrier, /* xShmBarrier */
  159477. rbuVfsShmUnmap, /* xShmUnmap */
  159478. 0, 0 /* xFetch, xUnfetch */
  159479. };
  159480. rbu_vfs *pRbuVfs = (rbu_vfs*)pVfs;
  159481. sqlite3_vfs *pRealVfs = pRbuVfs->pRealVfs;
  159482. rbu_file *pFd = (rbu_file *)pFile;
  159483. int rc = SQLITE_OK;
  159484. const char *zOpen = zName;
  159485. int oflags = flags;
  159486. memset(pFd, 0, sizeof(rbu_file));
  159487. pFd->pReal = (sqlite3_file*)&pFd[1];
  159488. pFd->pRbuVfs = pRbuVfs;
  159489. pFd->openFlags = flags;
  159490. if( zName ){
  159491. if( flags & SQLITE_OPEN_MAIN_DB ){
  159492. /* A main database has just been opened. The following block sets
  159493. ** (pFd->zWal) to point to a buffer owned by SQLite that contains
  159494. ** the name of the *-wal file this db connection will use. SQLite
  159495. ** happens to pass a pointer to this buffer when using xAccess()
  159496. ** or xOpen() to operate on the *-wal file. */
  159497. pFd->zWal = rbuMainToWal(zName, flags);
  159498. }
  159499. else if( flags & SQLITE_OPEN_WAL ){
  159500. rbu_file *pDb = rbuFindMaindb(pRbuVfs, zName);
  159501. if( pDb ){
  159502. if( pDb->pRbu && pDb->pRbu->eStage==RBU_STAGE_OAL ){
  159503. /* This call is to open a *-wal file. Intead, open the *-oal. This
  159504. ** code ensures that the string passed to xOpen() is terminated by a
  159505. ** pair of '\0' bytes in case the VFS attempts to extract a URI
  159506. ** parameter from it. */
  159507. const char *zBase = zName;
  159508. size_t nCopy;
  159509. char *zCopy;
  159510. if( rbuIsVacuum(pDb->pRbu) ){
  159511. zBase = sqlite3_db_filename(pDb->pRbu->dbRbu, "main");
  159512. zBase = rbuMainToWal(zBase, SQLITE_OPEN_URI);
  159513. }
  159514. nCopy = strlen(zBase);
  159515. zCopy = sqlite3_malloc64(nCopy+2);
  159516. if( zCopy ){
  159517. memcpy(zCopy, zBase, nCopy);
  159518. zCopy[nCopy-3] = 'o';
  159519. zCopy[nCopy] = '\0';
  159520. zCopy[nCopy+1] = '\0';
  159521. zOpen = (const char*)(pFd->zDel = zCopy);
  159522. }else{
  159523. rc = SQLITE_NOMEM;
  159524. }
  159525. pFd->pRbu = pDb->pRbu;
  159526. }
  159527. pDb->pWalFd = pFd;
  159528. }
  159529. }
  159530. }
  159531. if( oflags & SQLITE_OPEN_MAIN_DB
  159532. && sqlite3_uri_boolean(zName, "rbu_memory", 0)
  159533. ){
  159534. assert( oflags & SQLITE_OPEN_MAIN_DB );
  159535. oflags = SQLITE_OPEN_TEMP_DB | SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  159536. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
  159537. zOpen = 0;
  159538. }
  159539. if( rc==SQLITE_OK ){
  159540. rc = pRealVfs->xOpen(pRealVfs, zOpen, pFd->pReal, oflags, pOutFlags);
  159541. }
  159542. if( pFd->pReal->pMethods ){
  159543. /* The xOpen() operation has succeeded. Set the sqlite3_file.pMethods
  159544. ** pointer and, if the file is a main database file, link it into the
  159545. ** mutex protected linked list of all such files. */
  159546. pFile->pMethods = &rbuvfs_io_methods;
  159547. if( flags & SQLITE_OPEN_MAIN_DB ){
  159548. sqlite3_mutex_enter(pRbuVfs->mutex);
  159549. pFd->pMainNext = pRbuVfs->pMain;
  159550. pRbuVfs->pMain = pFd;
  159551. sqlite3_mutex_leave(pRbuVfs->mutex);
  159552. }
  159553. }else{
  159554. sqlite3_free(pFd->zDel);
  159555. }
  159556. return rc;
  159557. }
  159558. /*
  159559. ** Delete the file located at zPath.
  159560. */
  159561. static int rbuVfsDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
  159562. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159563. return pRealVfs->xDelete(pRealVfs, zPath, dirSync);
  159564. }
  159565. /*
  159566. ** Test for access permissions. Return true if the requested permission
  159567. ** is available, or false otherwise.
  159568. */
  159569. static int rbuVfsAccess(
  159570. sqlite3_vfs *pVfs,
  159571. const char *zPath,
  159572. int flags,
  159573. int *pResOut
  159574. ){
  159575. rbu_vfs *pRbuVfs = (rbu_vfs*)pVfs;
  159576. sqlite3_vfs *pRealVfs = pRbuVfs->pRealVfs;
  159577. int rc;
  159578. rc = pRealVfs->xAccess(pRealVfs, zPath, flags, pResOut);
  159579. /* If this call is to check if a *-wal file associated with an RBU target
  159580. ** database connection exists, and the RBU update is in RBU_STAGE_OAL,
  159581. ** the following special handling is activated:
  159582. **
  159583. ** a) if the *-wal file does exist, return SQLITE_CANTOPEN. This
  159584. ** ensures that the RBU extension never tries to update a database
  159585. ** in wal mode, even if the first page of the database file has
  159586. ** been damaged.
  159587. **
  159588. ** b) if the *-wal file does not exist, claim that it does anyway,
  159589. ** causing SQLite to call xOpen() to open it. This call will also
  159590. ** be intercepted (see the rbuVfsOpen() function) and the *-oal
  159591. ** file opened instead.
  159592. */
  159593. if( rc==SQLITE_OK && flags==SQLITE_ACCESS_EXISTS ){
  159594. rbu_file *pDb = rbuFindMaindb(pRbuVfs, zPath);
  159595. if( pDb && pDb->pRbu && pDb->pRbu->eStage==RBU_STAGE_OAL ){
  159596. if( *pResOut ){
  159597. rc = SQLITE_CANTOPEN;
  159598. }else{
  159599. *pResOut = 1;
  159600. }
  159601. }
  159602. }
  159603. return rc;
  159604. }
  159605. /*
  159606. ** Populate buffer zOut with the full canonical pathname corresponding
  159607. ** to the pathname in zPath. zOut is guaranteed to point to a buffer
  159608. ** of at least (DEVSYM_MAX_PATHNAME+1) bytes.
  159609. */
  159610. static int rbuVfsFullPathname(
  159611. sqlite3_vfs *pVfs,
  159612. const char *zPath,
  159613. int nOut,
  159614. char *zOut
  159615. ){
  159616. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159617. return pRealVfs->xFullPathname(pRealVfs, zPath, nOut, zOut);
  159618. }
  159619. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  159620. /*
  159621. ** Open the dynamic library located at zPath and return a handle.
  159622. */
  159623. static void *rbuVfsDlOpen(sqlite3_vfs *pVfs, const char *zPath){
  159624. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159625. return pRealVfs->xDlOpen(pRealVfs, zPath);
  159626. }
  159627. /*
  159628. ** Populate the buffer zErrMsg (size nByte bytes) with a human readable
  159629. ** utf-8 string describing the most recent error encountered associated
  159630. ** with dynamic libraries.
  159631. */
  159632. static void rbuVfsDlError(sqlite3_vfs *pVfs, int nByte, char *zErrMsg){
  159633. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159634. pRealVfs->xDlError(pRealVfs, nByte, zErrMsg);
  159635. }
  159636. /*
  159637. ** Return a pointer to the symbol zSymbol in the dynamic library pHandle.
  159638. */
  159639. static void (*rbuVfsDlSym(
  159640. sqlite3_vfs *pVfs,
  159641. void *pArg,
  159642. const char *zSym
  159643. ))(void){
  159644. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159645. return pRealVfs->xDlSym(pRealVfs, pArg, zSym);
  159646. }
  159647. /*
  159648. ** Close the dynamic library handle pHandle.
  159649. */
  159650. static void rbuVfsDlClose(sqlite3_vfs *pVfs, void *pHandle){
  159651. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159652. pRealVfs->xDlClose(pRealVfs, pHandle);
  159653. }
  159654. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  159655. /*
  159656. ** Populate the buffer pointed to by zBufOut with nByte bytes of
  159657. ** random data.
  159658. */
  159659. static int rbuVfsRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  159660. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159661. return pRealVfs->xRandomness(pRealVfs, nByte, zBufOut);
  159662. }
  159663. /*
  159664. ** Sleep for nMicro microseconds. Return the number of microseconds
  159665. ** actually slept.
  159666. */
  159667. static int rbuVfsSleep(sqlite3_vfs *pVfs, int nMicro){
  159668. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159669. return pRealVfs->xSleep(pRealVfs, nMicro);
  159670. }
  159671. /*
  159672. ** Return the current time as a Julian Day number in *pTimeOut.
  159673. */
  159674. static int rbuVfsCurrentTime(sqlite3_vfs *pVfs, double *pTimeOut){
  159675. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  159676. return pRealVfs->xCurrentTime(pRealVfs, pTimeOut);
  159677. }
  159678. /*
  159679. ** No-op.
  159680. */
  159681. static int rbuVfsGetLastError(sqlite3_vfs *pVfs, int a, char *b){
  159682. return 0;
  159683. }
  159684. /*
  159685. ** Deregister and destroy an RBU vfs created by an earlier call to
  159686. ** sqlite3rbu_create_vfs().
  159687. */
  159688. SQLITE_API void sqlite3rbu_destroy_vfs(const char *zName){
  159689. sqlite3_vfs *pVfs = sqlite3_vfs_find(zName);
  159690. if( pVfs && pVfs->xOpen==rbuVfsOpen ){
  159691. sqlite3_mutex_free(((rbu_vfs*)pVfs)->mutex);
  159692. sqlite3_vfs_unregister(pVfs);
  159693. sqlite3_free(pVfs);
  159694. }
  159695. }
  159696. /*
  159697. ** Create an RBU VFS named zName that accesses the underlying file-system
  159698. ** via existing VFS zParent. The new object is registered as a non-default
  159699. ** VFS with SQLite before returning.
  159700. */
  159701. SQLITE_API int sqlite3rbu_create_vfs(const char *zName, const char *zParent){
  159702. /* Template for VFS */
  159703. static sqlite3_vfs vfs_template = {
  159704. 1, /* iVersion */
  159705. 0, /* szOsFile */
  159706. 0, /* mxPathname */
  159707. 0, /* pNext */
  159708. 0, /* zName */
  159709. 0, /* pAppData */
  159710. rbuVfsOpen, /* xOpen */
  159711. rbuVfsDelete, /* xDelete */
  159712. rbuVfsAccess, /* xAccess */
  159713. rbuVfsFullPathname, /* xFullPathname */
  159714. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  159715. rbuVfsDlOpen, /* xDlOpen */
  159716. rbuVfsDlError, /* xDlError */
  159717. rbuVfsDlSym, /* xDlSym */
  159718. rbuVfsDlClose, /* xDlClose */
  159719. #else
  159720. 0, 0, 0, 0,
  159721. #endif
  159722. rbuVfsRandomness, /* xRandomness */
  159723. rbuVfsSleep, /* xSleep */
  159724. rbuVfsCurrentTime, /* xCurrentTime */
  159725. rbuVfsGetLastError, /* xGetLastError */
  159726. 0, /* xCurrentTimeInt64 (version 2) */
  159727. 0, 0, 0 /* Unimplemented version 3 methods */
  159728. };
  159729. rbu_vfs *pNew = 0; /* Newly allocated VFS */
  159730. int rc = SQLITE_OK;
  159731. size_t nName;
  159732. size_t nByte;
  159733. nName = strlen(zName);
  159734. nByte = sizeof(rbu_vfs) + nName + 1;
  159735. pNew = (rbu_vfs*)sqlite3_malloc64(nByte);
  159736. if( pNew==0 ){
  159737. rc = SQLITE_NOMEM;
  159738. }else{
  159739. sqlite3_vfs *pParent; /* Parent VFS */
  159740. memset(pNew, 0, nByte);
  159741. pParent = sqlite3_vfs_find(zParent);
  159742. if( pParent==0 ){
  159743. rc = SQLITE_NOTFOUND;
  159744. }else{
  159745. char *zSpace;
  159746. memcpy(&pNew->base, &vfs_template, sizeof(sqlite3_vfs));
  159747. pNew->base.mxPathname = pParent->mxPathname;
  159748. pNew->base.szOsFile = sizeof(rbu_file) + pParent->szOsFile;
  159749. pNew->pRealVfs = pParent;
  159750. pNew->base.zName = (const char*)(zSpace = (char*)&pNew[1]);
  159751. memcpy(zSpace, zName, nName);
  159752. /* Allocate the mutex and register the new VFS (not as the default) */
  159753. pNew->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_RECURSIVE);
  159754. if( pNew->mutex==0 ){
  159755. rc = SQLITE_NOMEM;
  159756. }else{
  159757. rc = sqlite3_vfs_register(&pNew->base, 0);
  159758. }
  159759. }
  159760. if( rc!=SQLITE_OK ){
  159761. sqlite3_mutex_free(pNew->mutex);
  159762. sqlite3_free(pNew);
  159763. }
  159764. }
  159765. return rc;
  159766. }
  159767. /**************************************************************************/
  159768. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_RBU) */
  159769. /************** End of sqlite3rbu.c ******************************************/
  159770. /************** Begin file dbstat.c ******************************************/
  159771. /*
  159772. ** 2010 July 12
  159773. **
  159774. ** The author disclaims copyright to this source code. In place of
  159775. ** a legal notice, here is a blessing:
  159776. **
  159777. ** May you do good and not evil.
  159778. ** May you find forgiveness for yourself and forgive others.
  159779. ** May you share freely, never taking more than you give.
  159780. **
  159781. ******************************************************************************
  159782. **
  159783. ** This file contains an implementation of the "dbstat" virtual table.
  159784. **
  159785. ** The dbstat virtual table is used to extract low-level formatting
  159786. ** information from an SQLite database in order to implement the
  159787. ** "sqlite3_analyzer" utility. See the ../tool/spaceanal.tcl script
  159788. ** for an example implementation.
  159789. **
  159790. ** Additional information is available on the "dbstat.html" page of the
  159791. ** official SQLite documentation.
  159792. */
  159793. /* #include "sqliteInt.h" ** Requires access to internal data structures ** */
  159794. #if (defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)) \
  159795. && !defined(SQLITE_OMIT_VIRTUALTABLE)
  159796. /*
  159797. ** Page paths:
  159798. **
  159799. ** The value of the 'path' column describes the path taken from the
  159800. ** root-node of the b-tree structure to each page. The value of the
  159801. ** root-node path is '/'.
  159802. **
  159803. ** The value of the path for the left-most child page of the root of
  159804. ** a b-tree is '/000/'. (Btrees store content ordered from left to right
  159805. ** so the pages to the left have smaller keys than the pages to the right.)
  159806. ** The next to left-most child of the root page is
  159807. ** '/001', and so on, each sibling page identified by a 3-digit hex
  159808. ** value. The children of the 451st left-most sibling have paths such
  159809. ** as '/1c2/000/, '/1c2/001/' etc.
  159810. **
  159811. ** Overflow pages are specified by appending a '+' character and a
  159812. ** six-digit hexadecimal value to the path to the cell they are linked
  159813. ** from. For example, the three overflow pages in a chain linked from
  159814. ** the left-most cell of the 450th child of the root page are identified
  159815. ** by the paths:
  159816. **
  159817. ** '/1c2/000+000000' // First page in overflow chain
  159818. ** '/1c2/000+000001' // Second page in overflow chain
  159819. ** '/1c2/000+000002' // Third page in overflow chain
  159820. **
  159821. ** If the paths are sorted using the BINARY collation sequence, then
  159822. ** the overflow pages associated with a cell will appear earlier in the
  159823. ** sort-order than its child page:
  159824. **
  159825. ** '/1c2/000/' // Left-most child of 451st child of root
  159826. */
  159827. #define VTAB_SCHEMA \
  159828. "CREATE TABLE xx( " \
  159829. " name TEXT, /* Name of table or index */" \
  159830. " path TEXT, /* Path to page from root */" \
  159831. " pageno INTEGER, /* Page number */" \
  159832. " pagetype TEXT, /* 'internal', 'leaf' or 'overflow' */" \
  159833. " ncell INTEGER, /* Cells on page (0 for overflow) */" \
  159834. " payload INTEGER, /* Bytes of payload on this page */" \
  159835. " unused INTEGER, /* Bytes of unused space on this page */" \
  159836. " mx_payload INTEGER, /* Largest payload size of all cells */" \
  159837. " pgoffset INTEGER, /* Offset of page in file */" \
  159838. " pgsize INTEGER, /* Size of the page */" \
  159839. " schema TEXT HIDDEN /* Database schema being analyzed */" \
  159840. ");"
  159841. typedef struct StatTable StatTable;
  159842. typedef struct StatCursor StatCursor;
  159843. typedef struct StatPage StatPage;
  159844. typedef struct StatCell StatCell;
  159845. struct StatCell {
  159846. int nLocal; /* Bytes of local payload */
  159847. u32 iChildPg; /* Child node (or 0 if this is a leaf) */
  159848. int nOvfl; /* Entries in aOvfl[] */
  159849. u32 *aOvfl; /* Array of overflow page numbers */
  159850. int nLastOvfl; /* Bytes of payload on final overflow page */
  159851. int iOvfl; /* Iterates through aOvfl[] */
  159852. };
  159853. struct StatPage {
  159854. u32 iPgno;
  159855. DbPage *pPg;
  159856. int iCell;
  159857. char *zPath; /* Path to this page */
  159858. /* Variables populated by statDecodePage(): */
  159859. u8 flags; /* Copy of flags byte */
  159860. int nCell; /* Number of cells on page */
  159861. int nUnused; /* Number of unused bytes on page */
  159862. StatCell *aCell; /* Array of parsed cells */
  159863. u32 iRightChildPg; /* Right-child page number (or 0) */
  159864. int nMxPayload; /* Largest payload of any cell on this page */
  159865. };
  159866. struct StatCursor {
  159867. sqlite3_vtab_cursor base;
  159868. sqlite3_stmt *pStmt; /* Iterates through set of root pages */
  159869. int isEof; /* After pStmt has returned SQLITE_DONE */
  159870. int iDb; /* Schema used for this query */
  159871. StatPage aPage[32];
  159872. int iPage; /* Current entry in aPage[] */
  159873. /* Values to return. */
  159874. char *zName; /* Value of 'name' column */
  159875. char *zPath; /* Value of 'path' column */
  159876. u32 iPageno; /* Value of 'pageno' column */
  159877. char *zPagetype; /* Value of 'pagetype' column */
  159878. int nCell; /* Value of 'ncell' column */
  159879. int nPayload; /* Value of 'payload' column */
  159880. int nUnused; /* Value of 'unused' column */
  159881. int nMxPayload; /* Value of 'mx_payload' column */
  159882. i64 iOffset; /* Value of 'pgOffset' column */
  159883. int szPage; /* Value of 'pgSize' column */
  159884. };
  159885. struct StatTable {
  159886. sqlite3_vtab base;
  159887. sqlite3 *db;
  159888. int iDb; /* Index of database to analyze */
  159889. };
  159890. #ifndef get2byte
  159891. # define get2byte(x) ((x)[0]<<8 | (x)[1])
  159892. #endif
  159893. /*
  159894. ** Connect to or create a statvfs virtual table.
  159895. */
  159896. static int statConnect(
  159897. sqlite3 *db,
  159898. void *pAux,
  159899. int argc, const char *const*argv,
  159900. sqlite3_vtab **ppVtab,
  159901. char **pzErr
  159902. ){
  159903. StatTable *pTab = 0;
  159904. int rc = SQLITE_OK;
  159905. int iDb;
  159906. if( argc>=4 ){
  159907. Token nm;
  159908. sqlite3TokenInit(&nm, (char*)argv[3]);
  159909. iDb = sqlite3FindDb(db, &nm);
  159910. if( iDb<0 ){
  159911. *pzErr = sqlite3_mprintf("no such database: %s", argv[3]);
  159912. return SQLITE_ERROR;
  159913. }
  159914. }else{
  159915. iDb = 0;
  159916. }
  159917. rc = sqlite3_declare_vtab(db, VTAB_SCHEMA);
  159918. if( rc==SQLITE_OK ){
  159919. pTab = (StatTable *)sqlite3_malloc64(sizeof(StatTable));
  159920. if( pTab==0 ) rc = SQLITE_NOMEM_BKPT;
  159921. }
  159922. assert( rc==SQLITE_OK || pTab==0 );
  159923. if( rc==SQLITE_OK ){
  159924. memset(pTab, 0, sizeof(StatTable));
  159925. pTab->db = db;
  159926. pTab->iDb = iDb;
  159927. }
  159928. *ppVtab = (sqlite3_vtab*)pTab;
  159929. return rc;
  159930. }
  159931. /*
  159932. ** Disconnect from or destroy a statvfs virtual table.
  159933. */
  159934. static int statDisconnect(sqlite3_vtab *pVtab){
  159935. sqlite3_free(pVtab);
  159936. return SQLITE_OK;
  159937. }
  159938. /*
  159939. ** There is no "best-index". This virtual table always does a linear
  159940. ** scan. However, a schema=? constraint should cause this table to
  159941. ** operate on a different database schema, so check for it.
  159942. **
  159943. ** idxNum is normally 0, but will be 1 if a schema=? constraint exists.
  159944. */
  159945. static int statBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  159946. int i;
  159947. pIdxInfo->estimatedCost = 1.0e6; /* Initial cost estimate */
  159948. /* Look for a valid schema=? constraint. If found, change the idxNum to
  159949. ** 1 and request the value of that constraint be sent to xFilter. And
  159950. ** lower the cost estimate to encourage the constrained version to be
  159951. ** used.
  159952. */
  159953. for(i=0; i<pIdxInfo->nConstraint; i++){
  159954. if( pIdxInfo->aConstraint[i].usable==0 ) continue;
  159955. if( pIdxInfo->aConstraint[i].op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  159956. if( pIdxInfo->aConstraint[i].iColumn!=10 ) continue;
  159957. pIdxInfo->idxNum = 1;
  159958. pIdxInfo->estimatedCost = 1.0;
  159959. pIdxInfo->aConstraintUsage[i].argvIndex = 1;
  159960. pIdxInfo->aConstraintUsage[i].omit = 1;
  159961. break;
  159962. }
  159963. /* Records are always returned in ascending order of (name, path).
  159964. ** If this will satisfy the client, set the orderByConsumed flag so that
  159965. ** SQLite does not do an external sort.
  159966. */
  159967. if( ( pIdxInfo->nOrderBy==1
  159968. && pIdxInfo->aOrderBy[0].iColumn==0
  159969. && pIdxInfo->aOrderBy[0].desc==0
  159970. ) ||
  159971. ( pIdxInfo->nOrderBy==2
  159972. && pIdxInfo->aOrderBy[0].iColumn==0
  159973. && pIdxInfo->aOrderBy[0].desc==0
  159974. && pIdxInfo->aOrderBy[1].iColumn==1
  159975. && pIdxInfo->aOrderBy[1].desc==0
  159976. )
  159977. ){
  159978. pIdxInfo->orderByConsumed = 1;
  159979. }
  159980. return SQLITE_OK;
  159981. }
  159982. /*
  159983. ** Open a new statvfs cursor.
  159984. */
  159985. static int statOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
  159986. StatTable *pTab = (StatTable *)pVTab;
  159987. StatCursor *pCsr;
  159988. pCsr = (StatCursor *)sqlite3_malloc64(sizeof(StatCursor));
  159989. if( pCsr==0 ){
  159990. return SQLITE_NOMEM_BKPT;
  159991. }else{
  159992. memset(pCsr, 0, sizeof(StatCursor));
  159993. pCsr->base.pVtab = pVTab;
  159994. pCsr->iDb = pTab->iDb;
  159995. }
  159996. *ppCursor = (sqlite3_vtab_cursor *)pCsr;
  159997. return SQLITE_OK;
  159998. }
  159999. static void statClearPage(StatPage *p){
  160000. int i;
  160001. if( p->aCell ){
  160002. for(i=0; i<p->nCell; i++){
  160003. sqlite3_free(p->aCell[i].aOvfl);
  160004. }
  160005. sqlite3_free(p->aCell);
  160006. }
  160007. sqlite3PagerUnref(p->pPg);
  160008. sqlite3_free(p->zPath);
  160009. memset(p, 0, sizeof(StatPage));
  160010. }
  160011. static void statResetCsr(StatCursor *pCsr){
  160012. int i;
  160013. sqlite3_reset(pCsr->pStmt);
  160014. for(i=0; i<ArraySize(pCsr->aPage); i++){
  160015. statClearPage(&pCsr->aPage[i]);
  160016. }
  160017. pCsr->iPage = 0;
  160018. sqlite3_free(pCsr->zPath);
  160019. pCsr->zPath = 0;
  160020. pCsr->isEof = 0;
  160021. }
  160022. /*
  160023. ** Close a statvfs cursor.
  160024. */
  160025. static int statClose(sqlite3_vtab_cursor *pCursor){
  160026. StatCursor *pCsr = (StatCursor *)pCursor;
  160027. statResetCsr(pCsr);
  160028. sqlite3_finalize(pCsr->pStmt);
  160029. sqlite3_free(pCsr);
  160030. return SQLITE_OK;
  160031. }
  160032. static void getLocalPayload(
  160033. int nUsable, /* Usable bytes per page */
  160034. u8 flags, /* Page flags */
  160035. int nTotal, /* Total record (payload) size */
  160036. int *pnLocal /* OUT: Bytes stored locally */
  160037. ){
  160038. int nLocal;
  160039. int nMinLocal;
  160040. int nMaxLocal;
  160041. if( flags==0x0D ){ /* Table leaf node */
  160042. nMinLocal = (nUsable - 12) * 32 / 255 - 23;
  160043. nMaxLocal = nUsable - 35;
  160044. }else{ /* Index interior and leaf nodes */
  160045. nMinLocal = (nUsable - 12) * 32 / 255 - 23;
  160046. nMaxLocal = (nUsable - 12) * 64 / 255 - 23;
  160047. }
  160048. nLocal = nMinLocal + (nTotal - nMinLocal) % (nUsable - 4);
  160049. if( nLocal>nMaxLocal ) nLocal = nMinLocal;
  160050. *pnLocal = nLocal;
  160051. }
  160052. static int statDecodePage(Btree *pBt, StatPage *p){
  160053. int nUnused;
  160054. int iOff;
  160055. int nHdr;
  160056. int isLeaf;
  160057. int szPage;
  160058. u8 *aData = sqlite3PagerGetData(p->pPg);
  160059. u8 *aHdr = &aData[p->iPgno==1 ? 100 : 0];
  160060. p->flags = aHdr[0];
  160061. p->nCell = get2byte(&aHdr[3]);
  160062. p->nMxPayload = 0;
  160063. isLeaf = (p->flags==0x0A || p->flags==0x0D);
  160064. nHdr = 12 - isLeaf*4 + (p->iPgno==1)*100;
  160065. nUnused = get2byte(&aHdr[5]) - nHdr - 2*p->nCell;
  160066. nUnused += (int)aHdr[7];
  160067. iOff = get2byte(&aHdr[1]);
  160068. while( iOff ){
  160069. nUnused += get2byte(&aData[iOff+2]);
  160070. iOff = get2byte(&aData[iOff]);
  160071. }
  160072. p->nUnused = nUnused;
  160073. p->iRightChildPg = isLeaf ? 0 : sqlite3Get4byte(&aHdr[8]);
  160074. szPage = sqlite3BtreeGetPageSize(pBt);
  160075. if( p->nCell ){
  160076. int i; /* Used to iterate through cells */
  160077. int nUsable; /* Usable bytes per page */
  160078. sqlite3BtreeEnter(pBt);
  160079. nUsable = szPage - sqlite3BtreeGetReserveNoMutex(pBt);
  160080. sqlite3BtreeLeave(pBt);
  160081. p->aCell = sqlite3_malloc64((p->nCell+1) * sizeof(StatCell));
  160082. if( p->aCell==0 ) return SQLITE_NOMEM_BKPT;
  160083. memset(p->aCell, 0, (p->nCell+1) * sizeof(StatCell));
  160084. for(i=0; i<p->nCell; i++){
  160085. StatCell *pCell = &p->aCell[i];
  160086. iOff = get2byte(&aData[nHdr+i*2]);
  160087. if( !isLeaf ){
  160088. pCell->iChildPg = sqlite3Get4byte(&aData[iOff]);
  160089. iOff += 4;
  160090. }
  160091. if( p->flags==0x05 ){
  160092. /* A table interior node. nPayload==0. */
  160093. }else{
  160094. u32 nPayload; /* Bytes of payload total (local+overflow) */
  160095. int nLocal; /* Bytes of payload stored locally */
  160096. iOff += getVarint32(&aData[iOff], nPayload);
  160097. if( p->flags==0x0D ){
  160098. u64 dummy;
  160099. iOff += sqlite3GetVarint(&aData[iOff], &dummy);
  160100. }
  160101. if( nPayload>(u32)p->nMxPayload ) p->nMxPayload = nPayload;
  160102. getLocalPayload(nUsable, p->flags, nPayload, &nLocal);
  160103. pCell->nLocal = nLocal;
  160104. assert( nLocal>=0 );
  160105. assert( nPayload>=(u32)nLocal );
  160106. assert( nLocal<=(nUsable-35) );
  160107. if( nPayload>(u32)nLocal ){
  160108. int j;
  160109. int nOvfl = ((nPayload - nLocal) + nUsable-4 - 1) / (nUsable - 4);
  160110. pCell->nLastOvfl = (nPayload-nLocal) - (nOvfl-1) * (nUsable-4);
  160111. pCell->nOvfl = nOvfl;
  160112. pCell->aOvfl = sqlite3_malloc64(sizeof(u32)*nOvfl);
  160113. if( pCell->aOvfl==0 ) return SQLITE_NOMEM_BKPT;
  160114. pCell->aOvfl[0] = sqlite3Get4byte(&aData[iOff+nLocal]);
  160115. for(j=1; j<nOvfl; j++){
  160116. int rc;
  160117. u32 iPrev = pCell->aOvfl[j-1];
  160118. DbPage *pPg = 0;
  160119. rc = sqlite3PagerGet(sqlite3BtreePager(pBt), iPrev, &pPg, 0);
  160120. if( rc!=SQLITE_OK ){
  160121. assert( pPg==0 );
  160122. return rc;
  160123. }
  160124. pCell->aOvfl[j] = sqlite3Get4byte(sqlite3PagerGetData(pPg));
  160125. sqlite3PagerUnref(pPg);
  160126. }
  160127. }
  160128. }
  160129. }
  160130. }
  160131. return SQLITE_OK;
  160132. }
  160133. /*
  160134. ** Populate the pCsr->iOffset and pCsr->szPage member variables. Based on
  160135. ** the current value of pCsr->iPageno.
  160136. */
  160137. static void statSizeAndOffset(StatCursor *pCsr){
  160138. StatTable *pTab = (StatTable *)((sqlite3_vtab_cursor *)pCsr)->pVtab;
  160139. Btree *pBt = pTab->db->aDb[pTab->iDb].pBt;
  160140. Pager *pPager = sqlite3BtreePager(pBt);
  160141. sqlite3_file *fd;
  160142. sqlite3_int64 x[2];
  160143. /* The default page size and offset */
  160144. pCsr->szPage = sqlite3BtreeGetPageSize(pBt);
  160145. pCsr->iOffset = (i64)pCsr->szPage * (pCsr->iPageno - 1);
  160146. /* If connected to a ZIPVFS backend, override the page size and
  160147. ** offset with actual values obtained from ZIPVFS.
  160148. */
  160149. fd = sqlite3PagerFile(pPager);
  160150. x[0] = pCsr->iPageno;
  160151. if( fd->pMethods!=0 && sqlite3OsFileControl(fd, 230440, &x)==SQLITE_OK ){
  160152. pCsr->iOffset = x[0];
  160153. pCsr->szPage = (int)x[1];
  160154. }
  160155. }
  160156. /*
  160157. ** Move a statvfs cursor to the next entry in the file.
  160158. */
  160159. static int statNext(sqlite3_vtab_cursor *pCursor){
  160160. int rc;
  160161. int nPayload;
  160162. char *z;
  160163. StatCursor *pCsr = (StatCursor *)pCursor;
  160164. StatTable *pTab = (StatTable *)pCursor->pVtab;
  160165. Btree *pBt = pTab->db->aDb[pCsr->iDb].pBt;
  160166. Pager *pPager = sqlite3BtreePager(pBt);
  160167. sqlite3_free(pCsr->zPath);
  160168. pCsr->zPath = 0;
  160169. statNextRestart:
  160170. if( pCsr->aPage[0].pPg==0 ){
  160171. rc = sqlite3_step(pCsr->pStmt);
  160172. if( rc==SQLITE_ROW ){
  160173. int nPage;
  160174. u32 iRoot = (u32)sqlite3_column_int64(pCsr->pStmt, 1);
  160175. sqlite3PagerPagecount(pPager, &nPage);
  160176. if( nPage==0 ){
  160177. pCsr->isEof = 1;
  160178. return sqlite3_reset(pCsr->pStmt);
  160179. }
  160180. rc = sqlite3PagerGet(pPager, iRoot, &pCsr->aPage[0].pPg, 0);
  160181. pCsr->aPage[0].iPgno = iRoot;
  160182. pCsr->aPage[0].iCell = 0;
  160183. pCsr->aPage[0].zPath = z = sqlite3_mprintf("/");
  160184. pCsr->iPage = 0;
  160185. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  160186. }else{
  160187. pCsr->isEof = 1;
  160188. return sqlite3_reset(pCsr->pStmt);
  160189. }
  160190. }else{
  160191. /* Page p itself has already been visited. */
  160192. StatPage *p = &pCsr->aPage[pCsr->iPage];
  160193. while( p->iCell<p->nCell ){
  160194. StatCell *pCell = &p->aCell[p->iCell];
  160195. if( pCell->iOvfl<pCell->nOvfl ){
  160196. int nUsable;
  160197. sqlite3BtreeEnter(pBt);
  160198. nUsable = sqlite3BtreeGetPageSize(pBt) -
  160199. sqlite3BtreeGetReserveNoMutex(pBt);
  160200. sqlite3BtreeLeave(pBt);
  160201. pCsr->zName = (char *)sqlite3_column_text(pCsr->pStmt, 0);
  160202. pCsr->iPageno = pCell->aOvfl[pCell->iOvfl];
  160203. pCsr->zPagetype = "overflow";
  160204. pCsr->nCell = 0;
  160205. pCsr->nMxPayload = 0;
  160206. pCsr->zPath = z = sqlite3_mprintf(
  160207. "%s%.3x+%.6x", p->zPath, p->iCell, pCell->iOvfl
  160208. );
  160209. if( pCell->iOvfl<pCell->nOvfl-1 ){
  160210. pCsr->nUnused = 0;
  160211. pCsr->nPayload = nUsable - 4;
  160212. }else{
  160213. pCsr->nPayload = pCell->nLastOvfl;
  160214. pCsr->nUnused = nUsable - 4 - pCsr->nPayload;
  160215. }
  160216. pCell->iOvfl++;
  160217. statSizeAndOffset(pCsr);
  160218. return z==0 ? SQLITE_NOMEM_BKPT : SQLITE_OK;
  160219. }
  160220. if( p->iRightChildPg ) break;
  160221. p->iCell++;
  160222. }
  160223. if( !p->iRightChildPg || p->iCell>p->nCell ){
  160224. statClearPage(p);
  160225. if( pCsr->iPage==0 ) return statNext(pCursor);
  160226. pCsr->iPage--;
  160227. goto statNextRestart; /* Tail recursion */
  160228. }
  160229. pCsr->iPage++;
  160230. assert( p==&pCsr->aPage[pCsr->iPage-1] );
  160231. if( p->iCell==p->nCell ){
  160232. p[1].iPgno = p->iRightChildPg;
  160233. }else{
  160234. p[1].iPgno = p->aCell[p->iCell].iChildPg;
  160235. }
  160236. rc = sqlite3PagerGet(pPager, p[1].iPgno, &p[1].pPg, 0);
  160237. p[1].iCell = 0;
  160238. p[1].zPath = z = sqlite3_mprintf("%s%.3x/", p->zPath, p->iCell);
  160239. p->iCell++;
  160240. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  160241. }
  160242. /* Populate the StatCursor fields with the values to be returned
  160243. ** by the xColumn() and xRowid() methods.
  160244. */
  160245. if( rc==SQLITE_OK ){
  160246. int i;
  160247. StatPage *p = &pCsr->aPage[pCsr->iPage];
  160248. pCsr->zName = (char *)sqlite3_column_text(pCsr->pStmt, 0);
  160249. pCsr->iPageno = p->iPgno;
  160250. rc = statDecodePage(pBt, p);
  160251. if( rc==SQLITE_OK ){
  160252. statSizeAndOffset(pCsr);
  160253. switch( p->flags ){
  160254. case 0x05: /* table internal */
  160255. case 0x02: /* index internal */
  160256. pCsr->zPagetype = "internal";
  160257. break;
  160258. case 0x0D: /* table leaf */
  160259. case 0x0A: /* index leaf */
  160260. pCsr->zPagetype = "leaf";
  160261. break;
  160262. default:
  160263. pCsr->zPagetype = "corrupted";
  160264. break;
  160265. }
  160266. pCsr->nCell = p->nCell;
  160267. pCsr->nUnused = p->nUnused;
  160268. pCsr->nMxPayload = p->nMxPayload;
  160269. pCsr->zPath = z = sqlite3_mprintf("%s", p->zPath);
  160270. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  160271. nPayload = 0;
  160272. for(i=0; i<p->nCell; i++){
  160273. nPayload += p->aCell[i].nLocal;
  160274. }
  160275. pCsr->nPayload = nPayload;
  160276. }
  160277. }
  160278. return rc;
  160279. }
  160280. static int statEof(sqlite3_vtab_cursor *pCursor){
  160281. StatCursor *pCsr = (StatCursor *)pCursor;
  160282. return pCsr->isEof;
  160283. }
  160284. static int statFilter(
  160285. sqlite3_vtab_cursor *pCursor,
  160286. int idxNum, const char *idxStr,
  160287. int argc, sqlite3_value **argv
  160288. ){
  160289. StatCursor *pCsr = (StatCursor *)pCursor;
  160290. StatTable *pTab = (StatTable*)(pCursor->pVtab);
  160291. char *zSql;
  160292. int rc = SQLITE_OK;
  160293. char *zMaster;
  160294. if( idxNum==1 ){
  160295. const char *zDbase = (const char*)sqlite3_value_text(argv[0]);
  160296. pCsr->iDb = sqlite3FindDbName(pTab->db, zDbase);
  160297. if( pCsr->iDb<0 ){
  160298. sqlite3_free(pCursor->pVtab->zErrMsg);
  160299. pCursor->pVtab->zErrMsg = sqlite3_mprintf("no such schema: %s", zDbase);
  160300. return pCursor->pVtab->zErrMsg ? SQLITE_ERROR : SQLITE_NOMEM_BKPT;
  160301. }
  160302. }else{
  160303. pCsr->iDb = pTab->iDb;
  160304. }
  160305. statResetCsr(pCsr);
  160306. sqlite3_finalize(pCsr->pStmt);
  160307. pCsr->pStmt = 0;
  160308. zMaster = pCsr->iDb==1 ? "sqlite_temp_master" : "sqlite_master";
  160309. zSql = sqlite3_mprintf(
  160310. "SELECT 'sqlite_master' AS name, 1 AS rootpage, 'table' AS type"
  160311. " UNION ALL "
  160312. "SELECT name, rootpage, type"
  160313. " FROM \"%w\".%s WHERE rootpage!=0"
  160314. " ORDER BY name", pTab->db->aDb[pCsr->iDb].zDbSName, zMaster);
  160315. if( zSql==0 ){
  160316. return SQLITE_NOMEM_BKPT;
  160317. }else{
  160318. rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pCsr->pStmt, 0);
  160319. sqlite3_free(zSql);
  160320. }
  160321. if( rc==SQLITE_OK ){
  160322. rc = statNext(pCursor);
  160323. }
  160324. return rc;
  160325. }
  160326. static int statColumn(
  160327. sqlite3_vtab_cursor *pCursor,
  160328. sqlite3_context *ctx,
  160329. int i
  160330. ){
  160331. StatCursor *pCsr = (StatCursor *)pCursor;
  160332. switch( i ){
  160333. case 0: /* name */
  160334. sqlite3_result_text(ctx, pCsr->zName, -1, SQLITE_TRANSIENT);
  160335. break;
  160336. case 1: /* path */
  160337. sqlite3_result_text(ctx, pCsr->zPath, -1, SQLITE_TRANSIENT);
  160338. break;
  160339. case 2: /* pageno */
  160340. sqlite3_result_int64(ctx, pCsr->iPageno);
  160341. break;
  160342. case 3: /* pagetype */
  160343. sqlite3_result_text(ctx, pCsr->zPagetype, -1, SQLITE_STATIC);
  160344. break;
  160345. case 4: /* ncell */
  160346. sqlite3_result_int(ctx, pCsr->nCell);
  160347. break;
  160348. case 5: /* payload */
  160349. sqlite3_result_int(ctx, pCsr->nPayload);
  160350. break;
  160351. case 6: /* unused */
  160352. sqlite3_result_int(ctx, pCsr->nUnused);
  160353. break;
  160354. case 7: /* mx_payload */
  160355. sqlite3_result_int(ctx, pCsr->nMxPayload);
  160356. break;
  160357. case 8: /* pgoffset */
  160358. sqlite3_result_int64(ctx, pCsr->iOffset);
  160359. break;
  160360. case 9: /* pgsize */
  160361. sqlite3_result_int(ctx, pCsr->szPage);
  160362. break;
  160363. default: { /* schema */
  160364. sqlite3 *db = sqlite3_context_db_handle(ctx);
  160365. int iDb = pCsr->iDb;
  160366. sqlite3_result_text(ctx, db->aDb[iDb].zDbSName, -1, SQLITE_STATIC);
  160367. break;
  160368. }
  160369. }
  160370. return SQLITE_OK;
  160371. }
  160372. static int statRowid(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  160373. StatCursor *pCsr = (StatCursor *)pCursor;
  160374. *pRowid = pCsr->iPageno;
  160375. return SQLITE_OK;
  160376. }
  160377. /*
  160378. ** Invoke this routine to register the "dbstat" virtual table module
  160379. */
  160380. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3 *db){
  160381. static sqlite3_module dbstat_module = {
  160382. 0, /* iVersion */
  160383. statConnect, /* xCreate */
  160384. statConnect, /* xConnect */
  160385. statBestIndex, /* xBestIndex */
  160386. statDisconnect, /* xDisconnect */
  160387. statDisconnect, /* xDestroy */
  160388. statOpen, /* xOpen - open a cursor */
  160389. statClose, /* xClose - close a cursor */
  160390. statFilter, /* xFilter - configure scan constraints */
  160391. statNext, /* xNext - advance a cursor */
  160392. statEof, /* xEof - check for end of scan */
  160393. statColumn, /* xColumn - read data */
  160394. statRowid, /* xRowid - read data */
  160395. 0, /* xUpdate */
  160396. 0, /* xBegin */
  160397. 0, /* xSync */
  160398. 0, /* xCommit */
  160399. 0, /* xRollback */
  160400. 0, /* xFindMethod */
  160401. 0, /* xRename */
  160402. };
  160403. return sqlite3_create_module(db, "dbstat", &dbstat_module, 0);
  160404. }
  160405. #elif defined(SQLITE_ENABLE_DBSTAT_VTAB)
  160406. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3 *db){ return SQLITE_OK; }
  160407. #endif /* SQLITE_ENABLE_DBSTAT_VTAB */
  160408. /************** End of dbstat.c **********************************************/
  160409. /************** Begin file sqlite3session.c **********************************/
  160410. #if defined(SQLITE_ENABLE_SESSION) && defined(SQLITE_ENABLE_PREUPDATE_HOOK)
  160411. /* #include "sqlite3session.h" */
  160412. /* #include <assert.h> */
  160413. /* #include <string.h> */
  160414. #ifndef SQLITE_AMALGAMATION
  160415. /* # include "sqliteInt.h" */
  160416. /* # include "vdbeInt.h" */
  160417. #endif
  160418. typedef struct SessionTable SessionTable;
  160419. typedef struct SessionChange SessionChange;
  160420. typedef struct SessionBuffer SessionBuffer;
  160421. typedef struct SessionInput SessionInput;
  160422. /*
  160423. ** Minimum chunk size used by streaming versions of functions.
  160424. */
  160425. #ifndef SESSIONS_STRM_CHUNK_SIZE
  160426. # ifdef SQLITE_TEST
  160427. # define SESSIONS_STRM_CHUNK_SIZE 64
  160428. # else
  160429. # define SESSIONS_STRM_CHUNK_SIZE 1024
  160430. # endif
  160431. #endif
  160432. typedef struct SessionHook SessionHook;
  160433. struct SessionHook {
  160434. void *pCtx;
  160435. int (*xOld)(void*,int,sqlite3_value**);
  160436. int (*xNew)(void*,int,sqlite3_value**);
  160437. int (*xCount)(void*);
  160438. int (*xDepth)(void*);
  160439. };
  160440. /*
  160441. ** Session handle structure.
  160442. */
  160443. struct sqlite3_session {
  160444. sqlite3 *db; /* Database handle session is attached to */
  160445. char *zDb; /* Name of database session is attached to */
  160446. int bEnable; /* True if currently recording */
  160447. int bIndirect; /* True if all changes are indirect */
  160448. int bAutoAttach; /* True to auto-attach tables */
  160449. int rc; /* Non-zero if an error has occurred */
  160450. void *pFilterCtx; /* First argument to pass to xTableFilter */
  160451. int (*xTableFilter)(void *pCtx, const char *zTab);
  160452. sqlite3_session *pNext; /* Next session object on same db. */
  160453. SessionTable *pTable; /* List of attached tables */
  160454. SessionHook hook; /* APIs to grab new and old data with */
  160455. };
  160456. /*
  160457. ** Instances of this structure are used to build strings or binary records.
  160458. */
  160459. struct SessionBuffer {
  160460. u8 *aBuf; /* Pointer to changeset buffer */
  160461. int nBuf; /* Size of buffer aBuf */
  160462. int nAlloc; /* Size of allocation containing aBuf */
  160463. };
  160464. /*
  160465. ** An object of this type is used internally as an abstraction for
  160466. ** input data. Input data may be supplied either as a single large buffer
  160467. ** (e.g. sqlite3changeset_start()) or using a stream function (e.g.
  160468. ** sqlite3changeset_start_strm()).
  160469. */
  160470. struct SessionInput {
  160471. int bNoDiscard; /* If true, discard no data */
  160472. int iCurrent; /* Offset in aData[] of current change */
  160473. int iNext; /* Offset in aData[] of next change */
  160474. u8 *aData; /* Pointer to buffer containing changeset */
  160475. int nData; /* Number of bytes in aData */
  160476. SessionBuffer buf; /* Current read buffer */
  160477. int (*xInput)(void*, void*, int*); /* Input stream call (or NULL) */
  160478. void *pIn; /* First argument to xInput */
  160479. int bEof; /* Set to true after xInput finished */
  160480. };
  160481. /*
  160482. ** Structure for changeset iterators.
  160483. */
  160484. struct sqlite3_changeset_iter {
  160485. SessionInput in; /* Input buffer or stream */
  160486. SessionBuffer tblhdr; /* Buffer to hold apValue/zTab/abPK/ */
  160487. int bPatchset; /* True if this is a patchset */
  160488. int rc; /* Iterator error code */
  160489. sqlite3_stmt *pConflict; /* Points to conflicting row, if any */
  160490. char *zTab; /* Current table */
  160491. int nCol; /* Number of columns in zTab */
  160492. int op; /* Current operation */
  160493. int bIndirect; /* True if current change was indirect */
  160494. u8 *abPK; /* Primary key array */
  160495. sqlite3_value **apValue; /* old.* and new.* values */
  160496. };
  160497. /*
  160498. ** Each session object maintains a set of the following structures, one
  160499. ** for each table the session object is monitoring. The structures are
  160500. ** stored in a linked list starting at sqlite3_session.pTable.
  160501. **
  160502. ** The keys of the SessionTable.aChange[] hash table are all rows that have
  160503. ** been modified in any way since the session object was attached to the
  160504. ** table.
  160505. **
  160506. ** The data associated with each hash-table entry is a structure containing
  160507. ** a subset of the initial values that the modified row contained at the
  160508. ** start of the session. Or no initial values if the row was inserted.
  160509. */
  160510. struct SessionTable {
  160511. SessionTable *pNext;
  160512. char *zName; /* Local name of table */
  160513. int nCol; /* Number of columns in table zName */
  160514. const char **azCol; /* Column names */
  160515. u8 *abPK; /* Array of primary key flags */
  160516. int nEntry; /* Total number of entries in hash table */
  160517. int nChange; /* Size of apChange[] array */
  160518. SessionChange **apChange; /* Hash table buckets */
  160519. };
  160520. /*
  160521. ** RECORD FORMAT:
  160522. **
  160523. ** The following record format is similar to (but not compatible with) that
  160524. ** used in SQLite database files. This format is used as part of the
  160525. ** change-set binary format, and so must be architecture independent.
  160526. **
  160527. ** Unlike the SQLite database record format, each field is self-contained -
  160528. ** there is no separation of header and data. Each field begins with a
  160529. ** single byte describing its type, as follows:
  160530. **
  160531. ** 0x00: Undefined value.
  160532. ** 0x01: Integer value.
  160533. ** 0x02: Real value.
  160534. ** 0x03: Text value.
  160535. ** 0x04: Blob value.
  160536. ** 0x05: SQL NULL value.
  160537. **
  160538. ** Note that the above match the definitions of SQLITE_INTEGER, SQLITE_TEXT
  160539. ** and so on in sqlite3.h. For undefined and NULL values, the field consists
  160540. ** only of the single type byte. For other types of values, the type byte
  160541. ** is followed by:
  160542. **
  160543. ** Text values:
  160544. ** A varint containing the number of bytes in the value (encoded using
  160545. ** UTF-8). Followed by a buffer containing the UTF-8 representation
  160546. ** of the text value. There is no nul terminator.
  160547. **
  160548. ** Blob values:
  160549. ** A varint containing the number of bytes in the value, followed by
  160550. ** a buffer containing the value itself.
  160551. **
  160552. ** Integer values:
  160553. ** An 8-byte big-endian integer value.
  160554. **
  160555. ** Real values:
  160556. ** An 8-byte big-endian IEEE 754-2008 real value.
  160557. **
  160558. ** Varint values are encoded in the same way as varints in the SQLite
  160559. ** record format.
  160560. **
  160561. ** CHANGESET FORMAT:
  160562. **
  160563. ** A changeset is a collection of DELETE, UPDATE and INSERT operations on
  160564. ** one or more tables. Operations on a single table are grouped together,
  160565. ** but may occur in any order (i.e. deletes, updates and inserts are all
  160566. ** mixed together).
  160567. **
  160568. ** Each group of changes begins with a table header:
  160569. **
  160570. ** 1 byte: Constant 0x54 (capital 'T')
  160571. ** Varint: Number of columns in the table.
  160572. ** nCol bytes: 0x01 for PK columns, 0x00 otherwise.
  160573. ** N bytes: Unqualified table name (encoded using UTF-8). Nul-terminated.
  160574. **
  160575. ** Followed by one or more changes to the table.
  160576. **
  160577. ** 1 byte: Either SQLITE_INSERT (0x12), UPDATE (0x17) or DELETE (0x09).
  160578. ** 1 byte: The "indirect-change" flag.
  160579. ** old.* record: (delete and update only)
  160580. ** new.* record: (insert and update only)
  160581. **
  160582. ** The "old.*" and "new.*" records, if present, are N field records in the
  160583. ** format described above under "RECORD FORMAT", where N is the number of
  160584. ** columns in the table. The i'th field of each record is associated with
  160585. ** the i'th column of the table, counting from left to right in the order
  160586. ** in which columns were declared in the CREATE TABLE statement.
  160587. **
  160588. ** The new.* record that is part of each INSERT change contains the values
  160589. ** that make up the new row. Similarly, the old.* record that is part of each
  160590. ** DELETE change contains the values that made up the row that was deleted
  160591. ** from the database. In the changeset format, the records that are part
  160592. ** of INSERT or DELETE changes never contain any undefined (type byte 0x00)
  160593. ** fields.
  160594. **
  160595. ** Within the old.* record associated with an UPDATE change, all fields
  160596. ** associated with table columns that are not PRIMARY KEY columns and are
  160597. ** not modified by the UPDATE change are set to "undefined". Other fields
  160598. ** are set to the values that made up the row before the UPDATE that the
  160599. ** change records took place. Within the new.* record, fields associated
  160600. ** with table columns modified by the UPDATE change contain the new
  160601. ** values. Fields associated with table columns that are not modified
  160602. ** are set to "undefined".
  160603. **
  160604. ** PATCHSET FORMAT:
  160605. **
  160606. ** A patchset is also a collection of changes. It is similar to a changeset,
  160607. ** but leaves undefined those fields that are not useful if no conflict
  160608. ** resolution is required when applying the changeset.
  160609. **
  160610. ** Each group of changes begins with a table header:
  160611. **
  160612. ** 1 byte: Constant 0x50 (capital 'P')
  160613. ** Varint: Number of columns in the table.
  160614. ** nCol bytes: 0x01 for PK columns, 0x00 otherwise.
  160615. ** N bytes: Unqualified table name (encoded using UTF-8). Nul-terminated.
  160616. **
  160617. ** Followed by one or more changes to the table.
  160618. **
  160619. ** 1 byte: Either SQLITE_INSERT (0x12), UPDATE (0x17) or DELETE (0x09).
  160620. ** 1 byte: The "indirect-change" flag.
  160621. ** single record: (PK fields for DELETE, PK and modified fields for UPDATE,
  160622. ** full record for INSERT).
  160623. **
  160624. ** As in the changeset format, each field of the single record that is part
  160625. ** of a patchset change is associated with the correspondingly positioned
  160626. ** table column, counting from left to right within the CREATE TABLE
  160627. ** statement.
  160628. **
  160629. ** For a DELETE change, all fields within the record except those associated
  160630. ** with PRIMARY KEY columns are set to "undefined". The PRIMARY KEY fields
  160631. ** contain the values identifying the row to delete.
  160632. **
  160633. ** For an UPDATE change, all fields except those associated with PRIMARY KEY
  160634. ** columns and columns that are modified by the UPDATE are set to "undefined".
  160635. ** PRIMARY KEY fields contain the values identifying the table row to update,
  160636. ** and fields associated with modified columns contain the new column values.
  160637. **
  160638. ** The records associated with INSERT changes are in the same format as for
  160639. ** changesets. It is not possible for a record associated with an INSERT
  160640. ** change to contain a field set to "undefined".
  160641. */
  160642. /*
  160643. ** For each row modified during a session, there exists a single instance of
  160644. ** this structure stored in a SessionTable.aChange[] hash table.
  160645. */
  160646. struct SessionChange {
  160647. int op; /* One of UPDATE, DELETE, INSERT */
  160648. int bIndirect; /* True if this change is "indirect" */
  160649. int nRecord; /* Number of bytes in buffer aRecord[] */
  160650. u8 *aRecord; /* Buffer containing old.* record */
  160651. SessionChange *pNext; /* For hash-table collisions */
  160652. };
  160653. /*
  160654. ** Write a varint with value iVal into the buffer at aBuf. Return the
  160655. ** number of bytes written.
  160656. */
  160657. static int sessionVarintPut(u8 *aBuf, int iVal){
  160658. return putVarint32(aBuf, iVal);
  160659. }
  160660. /*
  160661. ** Return the number of bytes required to store value iVal as a varint.
  160662. */
  160663. static int sessionVarintLen(int iVal){
  160664. return sqlite3VarintLen(iVal);
  160665. }
  160666. /*
  160667. ** Read a varint value from aBuf[] into *piVal. Return the number of
  160668. ** bytes read.
  160669. */
  160670. static int sessionVarintGet(u8 *aBuf, int *piVal){
  160671. return getVarint32(aBuf, *piVal);
  160672. }
  160673. /* Load an unaligned and unsigned 32-bit integer */
  160674. #define SESSION_UINT32(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  160675. /*
  160676. ** Read a 64-bit big-endian integer value from buffer aRec[]. Return
  160677. ** the value read.
  160678. */
  160679. static sqlite3_int64 sessionGetI64(u8 *aRec){
  160680. u64 x = SESSION_UINT32(aRec);
  160681. u32 y = SESSION_UINT32(aRec+4);
  160682. x = (x<<32) + y;
  160683. return (sqlite3_int64)x;
  160684. }
  160685. /*
  160686. ** Write a 64-bit big-endian integer value to the buffer aBuf[].
  160687. */
  160688. static void sessionPutI64(u8 *aBuf, sqlite3_int64 i){
  160689. aBuf[0] = (i>>56) & 0xFF;
  160690. aBuf[1] = (i>>48) & 0xFF;
  160691. aBuf[2] = (i>>40) & 0xFF;
  160692. aBuf[3] = (i>>32) & 0xFF;
  160693. aBuf[4] = (i>>24) & 0xFF;
  160694. aBuf[5] = (i>>16) & 0xFF;
  160695. aBuf[6] = (i>> 8) & 0xFF;
  160696. aBuf[7] = (i>> 0) & 0xFF;
  160697. }
  160698. /*
  160699. ** This function is used to serialize the contents of value pValue (see
  160700. ** comment titled "RECORD FORMAT" above).
  160701. **
  160702. ** If it is non-NULL, the serialized form of the value is written to
  160703. ** buffer aBuf. *pnWrite is set to the number of bytes written before
  160704. ** returning. Or, if aBuf is NULL, the only thing this function does is
  160705. ** set *pnWrite.
  160706. **
  160707. ** If no error occurs, SQLITE_OK is returned. Or, if an OOM error occurs
  160708. ** within a call to sqlite3_value_text() (may fail if the db is utf-16))
  160709. ** SQLITE_NOMEM is returned.
  160710. */
  160711. static int sessionSerializeValue(
  160712. u8 *aBuf, /* If non-NULL, write serialized value here */
  160713. sqlite3_value *pValue, /* Value to serialize */
  160714. int *pnWrite /* IN/OUT: Increment by bytes written */
  160715. ){
  160716. int nByte; /* Size of serialized value in bytes */
  160717. if( pValue ){
  160718. int eType; /* Value type (SQLITE_NULL, TEXT etc.) */
  160719. eType = sqlite3_value_type(pValue);
  160720. if( aBuf ) aBuf[0] = eType;
  160721. switch( eType ){
  160722. case SQLITE_NULL:
  160723. nByte = 1;
  160724. break;
  160725. case SQLITE_INTEGER:
  160726. case SQLITE_FLOAT:
  160727. if( aBuf ){
  160728. /* TODO: SQLite does something special to deal with mixed-endian
  160729. ** floating point values (e.g. ARM7). This code probably should
  160730. ** too. */
  160731. u64 i;
  160732. if( eType==SQLITE_INTEGER ){
  160733. i = (u64)sqlite3_value_int64(pValue);
  160734. }else{
  160735. double r;
  160736. assert( sizeof(double)==8 && sizeof(u64)==8 );
  160737. r = sqlite3_value_double(pValue);
  160738. memcpy(&i, &r, 8);
  160739. }
  160740. sessionPutI64(&aBuf[1], i);
  160741. }
  160742. nByte = 9;
  160743. break;
  160744. default: {
  160745. u8 *z;
  160746. int n;
  160747. int nVarint;
  160748. assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
  160749. if( eType==SQLITE_TEXT ){
  160750. z = (u8 *)sqlite3_value_text(pValue);
  160751. }else{
  160752. z = (u8 *)sqlite3_value_blob(pValue);
  160753. }
  160754. n = sqlite3_value_bytes(pValue);
  160755. if( z==0 && (eType!=SQLITE_BLOB || n>0) ) return SQLITE_NOMEM;
  160756. nVarint = sessionVarintLen(n);
  160757. if( aBuf ){
  160758. sessionVarintPut(&aBuf[1], n);
  160759. memcpy(&aBuf[nVarint + 1], eType==SQLITE_TEXT ?
  160760. sqlite3_value_text(pValue) : sqlite3_value_blob(pValue), n
  160761. );
  160762. }
  160763. nByte = 1 + nVarint + n;
  160764. break;
  160765. }
  160766. }
  160767. }else{
  160768. nByte = 1;
  160769. if( aBuf ) aBuf[0] = '\0';
  160770. }
  160771. if( pnWrite ) *pnWrite += nByte;
  160772. return SQLITE_OK;
  160773. }
  160774. /*
  160775. ** This macro is used to calculate hash key values for data structures. In
  160776. ** order to use this macro, the entire data structure must be represented
  160777. ** as a series of unsigned integers. In order to calculate a hash-key value
  160778. ** for a data structure represented as three such integers, the macro may
  160779. ** then be used as follows:
  160780. **
  160781. ** int hash_key_value;
  160782. ** hash_key_value = HASH_APPEND(0, <value 1>);
  160783. ** hash_key_value = HASH_APPEND(hash_key_value, <value 2>);
  160784. ** hash_key_value = HASH_APPEND(hash_key_value, <value 3>);
  160785. **
  160786. ** In practice, the data structures this macro is used for are the primary
  160787. ** key values of modified rows.
  160788. */
  160789. #define HASH_APPEND(hash, add) ((hash) << 3) ^ (hash) ^ (unsigned int)(add)
  160790. /*
  160791. ** Append the hash of the 64-bit integer passed as the second argument to the
  160792. ** hash-key value passed as the first. Return the new hash-key value.
  160793. */
  160794. static unsigned int sessionHashAppendI64(unsigned int h, i64 i){
  160795. h = HASH_APPEND(h, i & 0xFFFFFFFF);
  160796. return HASH_APPEND(h, (i>>32)&0xFFFFFFFF);
  160797. }
  160798. /*
  160799. ** Append the hash of the blob passed via the second and third arguments to
  160800. ** the hash-key value passed as the first. Return the new hash-key value.
  160801. */
  160802. static unsigned int sessionHashAppendBlob(unsigned int h, int n, const u8 *z){
  160803. int i;
  160804. for(i=0; i<n; i++) h = HASH_APPEND(h, z[i]);
  160805. return h;
  160806. }
  160807. /*
  160808. ** Append the hash of the data type passed as the second argument to the
  160809. ** hash-key value passed as the first. Return the new hash-key value.
  160810. */
  160811. static unsigned int sessionHashAppendType(unsigned int h, int eType){
  160812. return HASH_APPEND(h, eType);
  160813. }
  160814. /*
  160815. ** This function may only be called from within a pre-update callback.
  160816. ** It calculates a hash based on the primary key values of the old.* or
  160817. ** new.* row currently available and, assuming no error occurs, writes it to
  160818. ** *piHash before returning. If the primary key contains one or more NULL
  160819. ** values, *pbNullPK is set to true before returning.
  160820. **
  160821. ** If an error occurs, an SQLite error code is returned and the final values
  160822. ** of *piHash asn *pbNullPK are undefined. Otherwise, SQLITE_OK is returned
  160823. ** and the output variables are set as described above.
  160824. */
  160825. static int sessionPreupdateHash(
  160826. sqlite3_session *pSession, /* Session object that owns pTab */
  160827. SessionTable *pTab, /* Session table handle */
  160828. int bNew, /* True to hash the new.* PK */
  160829. int *piHash, /* OUT: Hash value */
  160830. int *pbNullPK /* OUT: True if there are NULL values in PK */
  160831. ){
  160832. unsigned int h = 0; /* Hash value to return */
  160833. int i; /* Used to iterate through columns */
  160834. assert( *pbNullPK==0 );
  160835. assert( pTab->nCol==pSession->hook.xCount(pSession->hook.pCtx) );
  160836. for(i=0; i<pTab->nCol; i++){
  160837. if( pTab->abPK[i] ){
  160838. int rc;
  160839. int eType;
  160840. sqlite3_value *pVal;
  160841. if( bNew ){
  160842. rc = pSession->hook.xNew(pSession->hook.pCtx, i, &pVal);
  160843. }else{
  160844. rc = pSession->hook.xOld(pSession->hook.pCtx, i, &pVal);
  160845. }
  160846. if( rc!=SQLITE_OK ) return rc;
  160847. eType = sqlite3_value_type(pVal);
  160848. h = sessionHashAppendType(h, eType);
  160849. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  160850. i64 iVal;
  160851. if( eType==SQLITE_INTEGER ){
  160852. iVal = sqlite3_value_int64(pVal);
  160853. }else{
  160854. double rVal = sqlite3_value_double(pVal);
  160855. assert( sizeof(iVal)==8 && sizeof(rVal)==8 );
  160856. memcpy(&iVal, &rVal, 8);
  160857. }
  160858. h = sessionHashAppendI64(h, iVal);
  160859. }else if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  160860. const u8 *z;
  160861. int n;
  160862. if( eType==SQLITE_TEXT ){
  160863. z = (const u8 *)sqlite3_value_text(pVal);
  160864. }else{
  160865. z = (const u8 *)sqlite3_value_blob(pVal);
  160866. }
  160867. n = sqlite3_value_bytes(pVal);
  160868. if( !z && (eType!=SQLITE_BLOB || n>0) ) return SQLITE_NOMEM;
  160869. h = sessionHashAppendBlob(h, n, z);
  160870. }else{
  160871. assert( eType==SQLITE_NULL );
  160872. *pbNullPK = 1;
  160873. }
  160874. }
  160875. }
  160876. *piHash = (h % pTab->nChange);
  160877. return SQLITE_OK;
  160878. }
  160879. /*
  160880. ** The buffer that the argument points to contains a serialized SQL value.
  160881. ** Return the number of bytes of space occupied by the value (including
  160882. ** the type byte).
  160883. */
  160884. static int sessionSerialLen(u8 *a){
  160885. int e = *a;
  160886. int n;
  160887. if( e==0 ) return 1;
  160888. if( e==SQLITE_NULL ) return 1;
  160889. if( e==SQLITE_INTEGER || e==SQLITE_FLOAT ) return 9;
  160890. return sessionVarintGet(&a[1], &n) + 1 + n;
  160891. }
  160892. /*
  160893. ** Based on the primary key values stored in change aRecord, calculate a
  160894. ** hash key. Assume the has table has nBucket buckets. The hash keys
  160895. ** calculated by this function are compatible with those calculated by
  160896. ** sessionPreupdateHash().
  160897. **
  160898. ** The bPkOnly argument is non-zero if the record at aRecord[] is from
  160899. ** a patchset DELETE. In this case the non-PK fields are omitted entirely.
  160900. */
  160901. static unsigned int sessionChangeHash(
  160902. SessionTable *pTab, /* Table handle */
  160903. int bPkOnly, /* Record consists of PK fields only */
  160904. u8 *aRecord, /* Change record */
  160905. int nBucket /* Assume this many buckets in hash table */
  160906. ){
  160907. unsigned int h = 0; /* Value to return */
  160908. int i; /* Used to iterate through columns */
  160909. u8 *a = aRecord; /* Used to iterate through change record */
  160910. for(i=0; i<pTab->nCol; i++){
  160911. int eType = *a;
  160912. int isPK = pTab->abPK[i];
  160913. if( bPkOnly && isPK==0 ) continue;
  160914. /* It is not possible for eType to be SQLITE_NULL here. The session
  160915. ** module does not record changes for rows with NULL values stored in
  160916. ** primary key columns. */
  160917. assert( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT
  160918. || eType==SQLITE_TEXT || eType==SQLITE_BLOB
  160919. || eType==SQLITE_NULL || eType==0
  160920. );
  160921. assert( !isPK || (eType!=0 && eType!=SQLITE_NULL) );
  160922. if( isPK ){
  160923. a++;
  160924. h = sessionHashAppendType(h, eType);
  160925. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  160926. h = sessionHashAppendI64(h, sessionGetI64(a));
  160927. a += 8;
  160928. }else{
  160929. int n;
  160930. a += sessionVarintGet(a, &n);
  160931. h = sessionHashAppendBlob(h, n, a);
  160932. a += n;
  160933. }
  160934. }else{
  160935. a += sessionSerialLen(a);
  160936. }
  160937. }
  160938. return (h % nBucket);
  160939. }
  160940. /*
  160941. ** Arguments aLeft and aRight are pointers to change records for table pTab.
  160942. ** This function returns true if the two records apply to the same row (i.e.
  160943. ** have the same values stored in the primary key columns), or false
  160944. ** otherwise.
  160945. */
  160946. static int sessionChangeEqual(
  160947. SessionTable *pTab, /* Table used for PK definition */
  160948. int bLeftPkOnly, /* True if aLeft[] contains PK fields only */
  160949. u8 *aLeft, /* Change record */
  160950. int bRightPkOnly, /* True if aRight[] contains PK fields only */
  160951. u8 *aRight /* Change record */
  160952. ){
  160953. u8 *a1 = aLeft; /* Cursor to iterate through aLeft */
  160954. u8 *a2 = aRight; /* Cursor to iterate through aRight */
  160955. int iCol; /* Used to iterate through table columns */
  160956. for(iCol=0; iCol<pTab->nCol; iCol++){
  160957. if( pTab->abPK[iCol] ){
  160958. int n1 = sessionSerialLen(a1);
  160959. int n2 = sessionSerialLen(a2);
  160960. if( pTab->abPK[iCol] && (n1!=n2 || memcmp(a1, a2, n1)) ){
  160961. return 0;
  160962. }
  160963. a1 += n1;
  160964. a2 += n2;
  160965. }else{
  160966. if( bLeftPkOnly==0 ) a1 += sessionSerialLen(a1);
  160967. if( bRightPkOnly==0 ) a2 += sessionSerialLen(a2);
  160968. }
  160969. }
  160970. return 1;
  160971. }
  160972. /*
  160973. ** Arguments aLeft and aRight both point to buffers containing change
  160974. ** records with nCol columns. This function "merges" the two records into
  160975. ** a single records which is written to the buffer at *paOut. *paOut is
  160976. ** then set to point to one byte after the last byte written before
  160977. ** returning.
  160978. **
  160979. ** The merging of records is done as follows: For each column, if the
  160980. ** aRight record contains a value for the column, copy the value from
  160981. ** their. Otherwise, if aLeft contains a value, copy it. If neither
  160982. ** record contains a value for a given column, then neither does the
  160983. ** output record.
  160984. */
  160985. static void sessionMergeRecord(
  160986. u8 **paOut,
  160987. int nCol,
  160988. u8 *aLeft,
  160989. u8 *aRight
  160990. ){
  160991. u8 *a1 = aLeft; /* Cursor used to iterate through aLeft */
  160992. u8 *a2 = aRight; /* Cursor used to iterate through aRight */
  160993. u8 *aOut = *paOut; /* Output cursor */
  160994. int iCol; /* Used to iterate from 0 to nCol */
  160995. for(iCol=0; iCol<nCol; iCol++){
  160996. int n1 = sessionSerialLen(a1);
  160997. int n2 = sessionSerialLen(a2);
  160998. if( *a2 ){
  160999. memcpy(aOut, a2, n2);
  161000. aOut += n2;
  161001. }else{
  161002. memcpy(aOut, a1, n1);
  161003. aOut += n1;
  161004. }
  161005. a1 += n1;
  161006. a2 += n2;
  161007. }
  161008. *paOut = aOut;
  161009. }
  161010. /*
  161011. ** This is a helper function used by sessionMergeUpdate().
  161012. **
  161013. ** When this function is called, both *paOne and *paTwo point to a value
  161014. ** within a change record. Before it returns, both have been advanced so
  161015. ** as to point to the next value in the record.
  161016. **
  161017. ** If, when this function is called, *paTwo points to a valid value (i.e.
  161018. ** *paTwo[0] is not 0x00 - the "no value" placeholder), a copy of the *paTwo
  161019. ** pointer is returned and *pnVal is set to the number of bytes in the
  161020. ** serialized value. Otherwise, a copy of *paOne is returned and *pnVal
  161021. ** set to the number of bytes in the value at *paOne. If *paOne points
  161022. ** to the "no value" placeholder, *pnVal is set to 1. In other words:
  161023. **
  161024. ** if( *paTwo is valid ) return *paTwo;
  161025. ** return *paOne;
  161026. **
  161027. */
  161028. static u8 *sessionMergeValue(
  161029. u8 **paOne, /* IN/OUT: Left-hand buffer pointer */
  161030. u8 **paTwo, /* IN/OUT: Right-hand buffer pointer */
  161031. int *pnVal /* OUT: Bytes in returned value */
  161032. ){
  161033. u8 *a1 = *paOne;
  161034. u8 *a2 = *paTwo;
  161035. u8 *pRet = 0;
  161036. int n1;
  161037. assert( a1 );
  161038. if( a2 ){
  161039. int n2 = sessionSerialLen(a2);
  161040. if( *a2 ){
  161041. *pnVal = n2;
  161042. pRet = a2;
  161043. }
  161044. *paTwo = &a2[n2];
  161045. }
  161046. n1 = sessionSerialLen(a1);
  161047. if( pRet==0 ){
  161048. *pnVal = n1;
  161049. pRet = a1;
  161050. }
  161051. *paOne = &a1[n1];
  161052. return pRet;
  161053. }
  161054. /*
  161055. ** This function is used by changeset_concat() to merge two UPDATE changes
  161056. ** on the same row.
  161057. */
  161058. static int sessionMergeUpdate(
  161059. u8 **paOut, /* IN/OUT: Pointer to output buffer */
  161060. SessionTable *pTab, /* Table change pertains to */
  161061. int bPatchset, /* True if records are patchset records */
  161062. u8 *aOldRecord1, /* old.* record for first change */
  161063. u8 *aOldRecord2, /* old.* record for second change */
  161064. u8 *aNewRecord1, /* new.* record for first change */
  161065. u8 *aNewRecord2 /* new.* record for second change */
  161066. ){
  161067. u8 *aOld1 = aOldRecord1;
  161068. u8 *aOld2 = aOldRecord2;
  161069. u8 *aNew1 = aNewRecord1;
  161070. u8 *aNew2 = aNewRecord2;
  161071. u8 *aOut = *paOut;
  161072. int i;
  161073. if( bPatchset==0 ){
  161074. int bRequired = 0;
  161075. assert( aOldRecord1 && aNewRecord1 );
  161076. /* Write the old.* vector first. */
  161077. for(i=0; i<pTab->nCol; i++){
  161078. int nOld;
  161079. u8 *aOld;
  161080. int nNew;
  161081. u8 *aNew;
  161082. aOld = sessionMergeValue(&aOld1, &aOld2, &nOld);
  161083. aNew = sessionMergeValue(&aNew1, &aNew2, &nNew);
  161084. if( pTab->abPK[i] || nOld!=nNew || memcmp(aOld, aNew, nNew) ){
  161085. if( pTab->abPK[i]==0 ) bRequired = 1;
  161086. memcpy(aOut, aOld, nOld);
  161087. aOut += nOld;
  161088. }else{
  161089. *(aOut++) = '\0';
  161090. }
  161091. }
  161092. if( !bRequired ) return 0;
  161093. }
  161094. /* Write the new.* vector */
  161095. aOld1 = aOldRecord1;
  161096. aOld2 = aOldRecord2;
  161097. aNew1 = aNewRecord1;
  161098. aNew2 = aNewRecord2;
  161099. for(i=0; i<pTab->nCol; i++){
  161100. int nOld;
  161101. u8 *aOld;
  161102. int nNew;
  161103. u8 *aNew;
  161104. aOld = sessionMergeValue(&aOld1, &aOld2, &nOld);
  161105. aNew = sessionMergeValue(&aNew1, &aNew2, &nNew);
  161106. if( bPatchset==0
  161107. && (pTab->abPK[i] || (nOld==nNew && 0==memcmp(aOld, aNew, nNew)))
  161108. ){
  161109. *(aOut++) = '\0';
  161110. }else{
  161111. memcpy(aOut, aNew, nNew);
  161112. aOut += nNew;
  161113. }
  161114. }
  161115. *paOut = aOut;
  161116. return 1;
  161117. }
  161118. /*
  161119. ** This function is only called from within a pre-update-hook callback.
  161120. ** It determines if the current pre-update-hook change affects the same row
  161121. ** as the change stored in argument pChange. If so, it returns true. Otherwise
  161122. ** if the pre-update-hook does not affect the same row as pChange, it returns
  161123. ** false.
  161124. */
  161125. static int sessionPreupdateEqual(
  161126. sqlite3_session *pSession, /* Session object that owns SessionTable */
  161127. SessionTable *pTab, /* Table associated with change */
  161128. SessionChange *pChange, /* Change to compare to */
  161129. int op /* Current pre-update operation */
  161130. ){
  161131. int iCol; /* Used to iterate through columns */
  161132. u8 *a = pChange->aRecord; /* Cursor used to scan change record */
  161133. assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
  161134. for(iCol=0; iCol<pTab->nCol; iCol++){
  161135. if( !pTab->abPK[iCol] ){
  161136. a += sessionSerialLen(a);
  161137. }else{
  161138. sqlite3_value *pVal; /* Value returned by preupdate_new/old */
  161139. int rc; /* Error code from preupdate_new/old */
  161140. int eType = *a++; /* Type of value from change record */
  161141. /* The following calls to preupdate_new() and preupdate_old() can not
  161142. ** fail. This is because they cache their return values, and by the
  161143. ** time control flows to here they have already been called once from
  161144. ** within sessionPreupdateHash(). The first two asserts below verify
  161145. ** this (that the method has already been called). */
  161146. if( op==SQLITE_INSERT ){
  161147. /* assert( db->pPreUpdate->pNewUnpacked || db->pPreUpdate->aNew ); */
  161148. rc = pSession->hook.xNew(pSession->hook.pCtx, iCol, &pVal);
  161149. }else{
  161150. /* assert( db->pPreUpdate->pUnpacked ); */
  161151. rc = pSession->hook.xOld(pSession->hook.pCtx, iCol, &pVal);
  161152. }
  161153. assert( rc==SQLITE_OK );
  161154. if( sqlite3_value_type(pVal)!=eType ) return 0;
  161155. /* A SessionChange object never has a NULL value in a PK column */
  161156. assert( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT
  161157. || eType==SQLITE_BLOB || eType==SQLITE_TEXT
  161158. );
  161159. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  161160. i64 iVal = sessionGetI64(a);
  161161. a += 8;
  161162. if( eType==SQLITE_INTEGER ){
  161163. if( sqlite3_value_int64(pVal)!=iVal ) return 0;
  161164. }else{
  161165. double rVal;
  161166. assert( sizeof(iVal)==8 && sizeof(rVal)==8 );
  161167. memcpy(&rVal, &iVal, 8);
  161168. if( sqlite3_value_double(pVal)!=rVal ) return 0;
  161169. }
  161170. }else{
  161171. int n;
  161172. const u8 *z;
  161173. a += sessionVarintGet(a, &n);
  161174. if( sqlite3_value_bytes(pVal)!=n ) return 0;
  161175. if( eType==SQLITE_TEXT ){
  161176. z = sqlite3_value_text(pVal);
  161177. }else{
  161178. z = sqlite3_value_blob(pVal);
  161179. }
  161180. if( memcmp(a, z, n) ) return 0;
  161181. a += n;
  161182. break;
  161183. }
  161184. }
  161185. }
  161186. return 1;
  161187. }
  161188. /*
  161189. ** If required, grow the hash table used to store changes on table pTab
  161190. ** (part of the session pSession). If a fatal OOM error occurs, set the
  161191. ** session object to failed and return SQLITE_ERROR. Otherwise, return
  161192. ** SQLITE_OK.
  161193. **
  161194. ** It is possible that a non-fatal OOM error occurs in this function. In
  161195. ** that case the hash-table does not grow, but SQLITE_OK is returned anyway.
  161196. ** Growing the hash table in this case is a performance optimization only,
  161197. ** it is not required for correct operation.
  161198. */
  161199. static int sessionGrowHash(int bPatchset, SessionTable *pTab){
  161200. if( pTab->nChange==0 || pTab->nEntry>=(pTab->nChange/2) ){
  161201. int i;
  161202. SessionChange **apNew;
  161203. int nNew = (pTab->nChange ? pTab->nChange : 128) * 2;
  161204. apNew = (SessionChange **)sqlite3_malloc(sizeof(SessionChange *) * nNew);
  161205. if( apNew==0 ){
  161206. if( pTab->nChange==0 ){
  161207. return SQLITE_ERROR;
  161208. }
  161209. return SQLITE_OK;
  161210. }
  161211. memset(apNew, 0, sizeof(SessionChange *) * nNew);
  161212. for(i=0; i<pTab->nChange; i++){
  161213. SessionChange *p;
  161214. SessionChange *pNext;
  161215. for(p=pTab->apChange[i]; p; p=pNext){
  161216. int bPkOnly = (p->op==SQLITE_DELETE && bPatchset);
  161217. int iHash = sessionChangeHash(pTab, bPkOnly, p->aRecord, nNew);
  161218. pNext = p->pNext;
  161219. p->pNext = apNew[iHash];
  161220. apNew[iHash] = p;
  161221. }
  161222. }
  161223. sqlite3_free(pTab->apChange);
  161224. pTab->nChange = nNew;
  161225. pTab->apChange = apNew;
  161226. }
  161227. return SQLITE_OK;
  161228. }
  161229. /*
  161230. ** This function queries the database for the names of the columns of table
  161231. ** zThis, in schema zDb. It is expected that the table has nCol columns. If
  161232. ** not, SQLITE_SCHEMA is returned and none of the output variables are
  161233. ** populated.
  161234. **
  161235. ** Otherwise, if they are not NULL, variable *pnCol is set to the number
  161236. ** of columns in the database table and variable *pzTab is set to point to a
  161237. ** nul-terminated copy of the table name. *pazCol (if not NULL) is set to
  161238. ** point to an array of pointers to column names. And *pabPK (again, if not
  161239. ** NULL) is set to point to an array of booleans - true if the corresponding
  161240. ** column is part of the primary key.
  161241. **
  161242. ** For example, if the table is declared as:
  161243. **
  161244. ** CREATE TABLE tbl1(w, x, y, z, PRIMARY KEY(w, z));
  161245. **
  161246. ** Then the four output variables are populated as follows:
  161247. **
  161248. ** *pnCol = 4
  161249. ** *pzTab = "tbl1"
  161250. ** *pazCol = {"w", "x", "y", "z"}
  161251. ** *pabPK = {1, 0, 0, 1}
  161252. **
  161253. ** All returned buffers are part of the same single allocation, which must
  161254. ** be freed using sqlite3_free() by the caller. If pazCol was not NULL, then
  161255. ** pointer *pazCol should be freed to release all memory. Otherwise, pointer
  161256. ** *pabPK. It is illegal for both pazCol and pabPK to be NULL.
  161257. */
  161258. static int sessionTableInfo(
  161259. sqlite3 *db, /* Database connection */
  161260. const char *zDb, /* Name of attached database (e.g. "main") */
  161261. const char *zThis, /* Table name */
  161262. int *pnCol, /* OUT: number of columns */
  161263. const char **pzTab, /* OUT: Copy of zThis */
  161264. const char ***pazCol, /* OUT: Array of column names for table */
  161265. u8 **pabPK /* OUT: Array of booleans - true for PK col */
  161266. ){
  161267. char *zPragma;
  161268. sqlite3_stmt *pStmt;
  161269. int rc;
  161270. int nByte;
  161271. int nDbCol = 0;
  161272. int nThis;
  161273. int i;
  161274. u8 *pAlloc = 0;
  161275. char **azCol = 0;
  161276. u8 *abPK = 0;
  161277. assert( pazCol && pabPK );
  161278. nThis = sqlite3Strlen30(zThis);
  161279. zPragma = sqlite3_mprintf("PRAGMA '%q'.table_info('%q')", zDb, zThis);
  161280. if( !zPragma ) return SQLITE_NOMEM;
  161281. rc = sqlite3_prepare_v2(db, zPragma, -1, &pStmt, 0);
  161282. sqlite3_free(zPragma);
  161283. if( rc!=SQLITE_OK ) return rc;
  161284. nByte = nThis + 1;
  161285. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  161286. nByte += sqlite3_column_bytes(pStmt, 1);
  161287. nDbCol++;
  161288. }
  161289. rc = sqlite3_reset(pStmt);
  161290. if( rc==SQLITE_OK ){
  161291. nByte += nDbCol * (sizeof(const char *) + sizeof(u8) + 1);
  161292. pAlloc = sqlite3_malloc(nByte);
  161293. if( pAlloc==0 ){
  161294. rc = SQLITE_NOMEM;
  161295. }
  161296. }
  161297. if( rc==SQLITE_OK ){
  161298. azCol = (char **)pAlloc;
  161299. pAlloc = (u8 *)&azCol[nDbCol];
  161300. abPK = (u8 *)pAlloc;
  161301. pAlloc = &abPK[nDbCol];
  161302. if( pzTab ){
  161303. memcpy(pAlloc, zThis, nThis+1);
  161304. *pzTab = (char *)pAlloc;
  161305. pAlloc += nThis+1;
  161306. }
  161307. i = 0;
  161308. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  161309. int nName = sqlite3_column_bytes(pStmt, 1);
  161310. const unsigned char *zName = sqlite3_column_text(pStmt, 1);
  161311. if( zName==0 ) break;
  161312. memcpy(pAlloc, zName, nName+1);
  161313. azCol[i] = (char *)pAlloc;
  161314. pAlloc += nName+1;
  161315. abPK[i] = sqlite3_column_int(pStmt, 5);
  161316. i++;
  161317. }
  161318. rc = sqlite3_reset(pStmt);
  161319. }
  161320. /* If successful, populate the output variables. Otherwise, zero them and
  161321. ** free any allocation made. An error code will be returned in this case.
  161322. */
  161323. if( rc==SQLITE_OK ){
  161324. *pazCol = (const char **)azCol;
  161325. *pabPK = abPK;
  161326. *pnCol = nDbCol;
  161327. }else{
  161328. *pazCol = 0;
  161329. *pabPK = 0;
  161330. *pnCol = 0;
  161331. if( pzTab ) *pzTab = 0;
  161332. sqlite3_free(azCol);
  161333. }
  161334. sqlite3_finalize(pStmt);
  161335. return rc;
  161336. }
  161337. /*
  161338. ** This function is only called from within a pre-update handler for a
  161339. ** write to table pTab, part of session pSession. If this is the first
  161340. ** write to this table, initalize the SessionTable.nCol, azCol[] and
  161341. ** abPK[] arrays accordingly.
  161342. **
  161343. ** If an error occurs, an error code is stored in sqlite3_session.rc and
  161344. ** non-zero returned. Or, if no error occurs but the table has no primary
  161345. ** key, sqlite3_session.rc is left set to SQLITE_OK and non-zero returned to
  161346. ** indicate that updates on this table should be ignored. SessionTable.abPK
  161347. ** is set to NULL in this case.
  161348. */
  161349. static int sessionInitTable(sqlite3_session *pSession, SessionTable *pTab){
  161350. if( pTab->nCol==0 ){
  161351. u8 *abPK;
  161352. assert( pTab->azCol==0 || pTab->abPK==0 );
  161353. pSession->rc = sessionTableInfo(pSession->db, pSession->zDb,
  161354. pTab->zName, &pTab->nCol, 0, &pTab->azCol, &abPK
  161355. );
  161356. if( pSession->rc==SQLITE_OK ){
  161357. int i;
  161358. for(i=0; i<pTab->nCol; i++){
  161359. if( abPK[i] ){
  161360. pTab->abPK = abPK;
  161361. break;
  161362. }
  161363. }
  161364. }
  161365. }
  161366. return (pSession->rc || pTab->abPK==0);
  161367. }
  161368. /*
  161369. ** This function is only called from with a pre-update-hook reporting a
  161370. ** change on table pTab (attached to session pSession). The type of change
  161371. ** (UPDATE, INSERT, DELETE) is specified by the first argument.
  161372. **
  161373. ** Unless one is already present or an error occurs, an entry is added
  161374. ** to the changed-rows hash table associated with table pTab.
  161375. */
  161376. static void sessionPreupdateOneChange(
  161377. int op, /* One of SQLITE_UPDATE, INSERT, DELETE */
  161378. sqlite3_session *pSession, /* Session object pTab is attached to */
  161379. SessionTable *pTab /* Table that change applies to */
  161380. ){
  161381. int iHash;
  161382. int bNull = 0;
  161383. int rc = SQLITE_OK;
  161384. if( pSession->rc ) return;
  161385. /* Load table details if required */
  161386. if( sessionInitTable(pSession, pTab) ) return;
  161387. /* Check the number of columns in this xPreUpdate call matches the
  161388. ** number of columns in the table. */
  161389. if( pTab->nCol!=pSession->hook.xCount(pSession->hook.pCtx) ){
  161390. pSession->rc = SQLITE_SCHEMA;
  161391. return;
  161392. }
  161393. /* Grow the hash table if required */
  161394. if( sessionGrowHash(0, pTab) ){
  161395. pSession->rc = SQLITE_NOMEM;
  161396. return;
  161397. }
  161398. /* Calculate the hash-key for this change. If the primary key of the row
  161399. ** includes a NULL value, exit early. Such changes are ignored by the
  161400. ** session module. */
  161401. rc = sessionPreupdateHash(pSession, pTab, op==SQLITE_INSERT, &iHash, &bNull);
  161402. if( rc!=SQLITE_OK ) goto error_out;
  161403. if( bNull==0 ){
  161404. /* Search the hash table for an existing record for this row. */
  161405. SessionChange *pC;
  161406. for(pC=pTab->apChange[iHash]; pC; pC=pC->pNext){
  161407. if( sessionPreupdateEqual(pSession, pTab, pC, op) ) break;
  161408. }
  161409. if( pC==0 ){
  161410. /* Create a new change object containing all the old values (if
  161411. ** this is an SQLITE_UPDATE or SQLITE_DELETE), or just the PK
  161412. ** values (if this is an INSERT). */
  161413. SessionChange *pChange; /* New change object */
  161414. int nByte; /* Number of bytes to allocate */
  161415. int i; /* Used to iterate through columns */
  161416. assert( rc==SQLITE_OK );
  161417. pTab->nEntry++;
  161418. /* Figure out how large an allocation is required */
  161419. nByte = sizeof(SessionChange);
  161420. for(i=0; i<pTab->nCol; i++){
  161421. sqlite3_value *p = 0;
  161422. if( op!=SQLITE_INSERT ){
  161423. TESTONLY(int trc = ) pSession->hook.xOld(pSession->hook.pCtx, i, &p);
  161424. assert( trc==SQLITE_OK );
  161425. }else if( pTab->abPK[i] ){
  161426. TESTONLY(int trc = ) pSession->hook.xNew(pSession->hook.pCtx, i, &p);
  161427. assert( trc==SQLITE_OK );
  161428. }
  161429. /* This may fail if SQLite value p contains a utf-16 string that must
  161430. ** be converted to utf-8 and an OOM error occurs while doing so. */
  161431. rc = sessionSerializeValue(0, p, &nByte);
  161432. if( rc!=SQLITE_OK ) goto error_out;
  161433. }
  161434. /* Allocate the change object */
  161435. pChange = (SessionChange *)sqlite3_malloc(nByte);
  161436. if( !pChange ){
  161437. rc = SQLITE_NOMEM;
  161438. goto error_out;
  161439. }else{
  161440. memset(pChange, 0, sizeof(SessionChange));
  161441. pChange->aRecord = (u8 *)&pChange[1];
  161442. }
  161443. /* Populate the change object. None of the preupdate_old(),
  161444. ** preupdate_new() or SerializeValue() calls below may fail as all
  161445. ** required values and encodings have already been cached in memory.
  161446. ** It is not possible for an OOM to occur in this block. */
  161447. nByte = 0;
  161448. for(i=0; i<pTab->nCol; i++){
  161449. sqlite3_value *p = 0;
  161450. if( op!=SQLITE_INSERT ){
  161451. pSession->hook.xOld(pSession->hook.pCtx, i, &p);
  161452. }else if( pTab->abPK[i] ){
  161453. pSession->hook.xNew(pSession->hook.pCtx, i, &p);
  161454. }
  161455. sessionSerializeValue(&pChange->aRecord[nByte], p, &nByte);
  161456. }
  161457. /* Add the change to the hash-table */
  161458. if( pSession->bIndirect || pSession->hook.xDepth(pSession->hook.pCtx) ){
  161459. pChange->bIndirect = 1;
  161460. }
  161461. pChange->nRecord = nByte;
  161462. pChange->op = op;
  161463. pChange->pNext = pTab->apChange[iHash];
  161464. pTab->apChange[iHash] = pChange;
  161465. }else if( pC->bIndirect ){
  161466. /* If the existing change is considered "indirect", but this current
  161467. ** change is "direct", mark the change object as direct. */
  161468. if( pSession->hook.xDepth(pSession->hook.pCtx)==0
  161469. && pSession->bIndirect==0
  161470. ){
  161471. pC->bIndirect = 0;
  161472. }
  161473. }
  161474. }
  161475. /* If an error has occurred, mark the session object as failed. */
  161476. error_out:
  161477. if( rc!=SQLITE_OK ){
  161478. pSession->rc = rc;
  161479. }
  161480. }
  161481. static int sessionFindTable(
  161482. sqlite3_session *pSession,
  161483. const char *zName,
  161484. SessionTable **ppTab
  161485. ){
  161486. int rc = SQLITE_OK;
  161487. int nName = sqlite3Strlen30(zName);
  161488. SessionTable *pRet;
  161489. /* Search for an existing table */
  161490. for(pRet=pSession->pTable; pRet; pRet=pRet->pNext){
  161491. if( 0==sqlite3_strnicmp(pRet->zName, zName, nName+1) ) break;
  161492. }
  161493. if( pRet==0 && pSession->bAutoAttach ){
  161494. /* If there is a table-filter configured, invoke it. If it returns 0,
  161495. ** do not automatically add the new table. */
  161496. if( pSession->xTableFilter==0
  161497. || pSession->xTableFilter(pSession->pFilterCtx, zName)
  161498. ){
  161499. rc = sqlite3session_attach(pSession, zName);
  161500. if( rc==SQLITE_OK ){
  161501. for(pRet=pSession->pTable; pRet->pNext; pRet=pRet->pNext);
  161502. assert( 0==sqlite3_strnicmp(pRet->zName, zName, nName+1) );
  161503. }
  161504. }
  161505. }
  161506. assert( rc==SQLITE_OK || pRet==0 );
  161507. *ppTab = pRet;
  161508. return rc;
  161509. }
  161510. /*
  161511. ** The 'pre-update' hook registered by this module with SQLite databases.
  161512. */
  161513. static void xPreUpdate(
  161514. void *pCtx, /* Copy of third arg to preupdate_hook() */
  161515. sqlite3 *db, /* Database handle */
  161516. int op, /* SQLITE_UPDATE, DELETE or INSERT */
  161517. char const *zDb, /* Database name */
  161518. char const *zName, /* Table name */
  161519. sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
  161520. sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
  161521. ){
  161522. sqlite3_session *pSession;
  161523. int nDb = sqlite3Strlen30(zDb);
  161524. assert( sqlite3_mutex_held(db->mutex) );
  161525. for(pSession=(sqlite3_session *)pCtx; pSession; pSession=pSession->pNext){
  161526. SessionTable *pTab;
  161527. /* If this session is attached to a different database ("main", "temp"
  161528. ** etc.), or if it is not currently enabled, there is nothing to do. Skip
  161529. ** to the next session object attached to this database. */
  161530. if( pSession->bEnable==0 ) continue;
  161531. if( pSession->rc ) continue;
  161532. if( sqlite3_strnicmp(zDb, pSession->zDb, nDb+1) ) continue;
  161533. pSession->rc = sessionFindTable(pSession, zName, &pTab);
  161534. if( pTab ){
  161535. assert( pSession->rc==SQLITE_OK );
  161536. sessionPreupdateOneChange(op, pSession, pTab);
  161537. if( op==SQLITE_UPDATE ){
  161538. sessionPreupdateOneChange(SQLITE_INSERT, pSession, pTab);
  161539. }
  161540. }
  161541. }
  161542. }
  161543. /*
  161544. ** The pre-update hook implementations.
  161545. */
  161546. static int sessionPreupdateOld(void *pCtx, int iVal, sqlite3_value **ppVal){
  161547. return sqlite3_preupdate_old((sqlite3*)pCtx, iVal, ppVal);
  161548. }
  161549. static int sessionPreupdateNew(void *pCtx, int iVal, sqlite3_value **ppVal){
  161550. return sqlite3_preupdate_new((sqlite3*)pCtx, iVal, ppVal);
  161551. }
  161552. static int sessionPreupdateCount(void *pCtx){
  161553. return sqlite3_preupdate_count((sqlite3*)pCtx);
  161554. }
  161555. static int sessionPreupdateDepth(void *pCtx){
  161556. return sqlite3_preupdate_depth((sqlite3*)pCtx);
  161557. }
  161558. /*
  161559. ** Install the pre-update hooks on the session object passed as the only
  161560. ** argument.
  161561. */
  161562. static void sessionPreupdateHooks(
  161563. sqlite3_session *pSession
  161564. ){
  161565. pSession->hook.pCtx = (void*)pSession->db;
  161566. pSession->hook.xOld = sessionPreupdateOld;
  161567. pSession->hook.xNew = sessionPreupdateNew;
  161568. pSession->hook.xCount = sessionPreupdateCount;
  161569. pSession->hook.xDepth = sessionPreupdateDepth;
  161570. }
  161571. typedef struct SessionDiffCtx SessionDiffCtx;
  161572. struct SessionDiffCtx {
  161573. sqlite3_stmt *pStmt;
  161574. int nOldOff;
  161575. };
  161576. /*
  161577. ** The diff hook implementations.
  161578. */
  161579. static int sessionDiffOld(void *pCtx, int iVal, sqlite3_value **ppVal){
  161580. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  161581. *ppVal = sqlite3_column_value(p->pStmt, iVal+p->nOldOff);
  161582. return SQLITE_OK;
  161583. }
  161584. static int sessionDiffNew(void *pCtx, int iVal, sqlite3_value **ppVal){
  161585. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  161586. *ppVal = sqlite3_column_value(p->pStmt, iVal);
  161587. return SQLITE_OK;
  161588. }
  161589. static int sessionDiffCount(void *pCtx){
  161590. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  161591. return p->nOldOff ? p->nOldOff : sqlite3_column_count(p->pStmt);
  161592. }
  161593. static int sessionDiffDepth(void *pCtx){
  161594. return 0;
  161595. }
  161596. /*
  161597. ** Install the diff hooks on the session object passed as the only
  161598. ** argument.
  161599. */
  161600. static void sessionDiffHooks(
  161601. sqlite3_session *pSession,
  161602. SessionDiffCtx *pDiffCtx
  161603. ){
  161604. pSession->hook.pCtx = (void*)pDiffCtx;
  161605. pSession->hook.xOld = sessionDiffOld;
  161606. pSession->hook.xNew = sessionDiffNew;
  161607. pSession->hook.xCount = sessionDiffCount;
  161608. pSession->hook.xDepth = sessionDiffDepth;
  161609. }
  161610. static char *sessionExprComparePK(
  161611. int nCol,
  161612. const char *zDb1, const char *zDb2,
  161613. const char *zTab,
  161614. const char **azCol, u8 *abPK
  161615. ){
  161616. int i;
  161617. const char *zSep = "";
  161618. char *zRet = 0;
  161619. for(i=0; i<nCol; i++){
  161620. if( abPK[i] ){
  161621. zRet = sqlite3_mprintf("%z%s\"%w\".\"%w\".\"%w\"=\"%w\".\"%w\".\"%w\"",
  161622. zRet, zSep, zDb1, zTab, azCol[i], zDb2, zTab, azCol[i]
  161623. );
  161624. zSep = " AND ";
  161625. if( zRet==0 ) break;
  161626. }
  161627. }
  161628. return zRet;
  161629. }
  161630. static char *sessionExprCompareOther(
  161631. int nCol,
  161632. const char *zDb1, const char *zDb2,
  161633. const char *zTab,
  161634. const char **azCol, u8 *abPK
  161635. ){
  161636. int i;
  161637. const char *zSep = "";
  161638. char *zRet = 0;
  161639. int bHave = 0;
  161640. for(i=0; i<nCol; i++){
  161641. if( abPK[i]==0 ){
  161642. bHave = 1;
  161643. zRet = sqlite3_mprintf(
  161644. "%z%s\"%w\".\"%w\".\"%w\" IS NOT \"%w\".\"%w\".\"%w\"",
  161645. zRet, zSep, zDb1, zTab, azCol[i], zDb2, zTab, azCol[i]
  161646. );
  161647. zSep = " OR ";
  161648. if( zRet==0 ) break;
  161649. }
  161650. }
  161651. if( bHave==0 ){
  161652. assert( zRet==0 );
  161653. zRet = sqlite3_mprintf("0");
  161654. }
  161655. return zRet;
  161656. }
  161657. static char *sessionSelectFindNew(
  161658. int nCol,
  161659. const char *zDb1, /* Pick rows in this db only */
  161660. const char *zDb2, /* But not in this one */
  161661. const char *zTbl, /* Table name */
  161662. const char *zExpr
  161663. ){
  161664. char *zRet = sqlite3_mprintf(
  161665. "SELECT * FROM \"%w\".\"%w\" WHERE NOT EXISTS ("
  161666. " SELECT 1 FROM \"%w\".\"%w\" WHERE %s"
  161667. ")",
  161668. zDb1, zTbl, zDb2, zTbl, zExpr
  161669. );
  161670. return zRet;
  161671. }
  161672. static int sessionDiffFindNew(
  161673. int op,
  161674. sqlite3_session *pSession,
  161675. SessionTable *pTab,
  161676. const char *zDb1,
  161677. const char *zDb2,
  161678. char *zExpr
  161679. ){
  161680. int rc = SQLITE_OK;
  161681. char *zStmt = sessionSelectFindNew(pTab->nCol, zDb1, zDb2, pTab->zName,zExpr);
  161682. if( zStmt==0 ){
  161683. rc = SQLITE_NOMEM;
  161684. }else{
  161685. sqlite3_stmt *pStmt;
  161686. rc = sqlite3_prepare(pSession->db, zStmt, -1, &pStmt, 0);
  161687. if( rc==SQLITE_OK ){
  161688. SessionDiffCtx *pDiffCtx = (SessionDiffCtx*)pSession->hook.pCtx;
  161689. pDiffCtx->pStmt = pStmt;
  161690. pDiffCtx->nOldOff = 0;
  161691. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  161692. sessionPreupdateOneChange(op, pSession, pTab);
  161693. }
  161694. rc = sqlite3_finalize(pStmt);
  161695. }
  161696. sqlite3_free(zStmt);
  161697. }
  161698. return rc;
  161699. }
  161700. static int sessionDiffFindModified(
  161701. sqlite3_session *pSession,
  161702. SessionTable *pTab,
  161703. const char *zFrom,
  161704. const char *zExpr
  161705. ){
  161706. int rc = SQLITE_OK;
  161707. char *zExpr2 = sessionExprCompareOther(pTab->nCol,
  161708. pSession->zDb, zFrom, pTab->zName, pTab->azCol, pTab->abPK
  161709. );
  161710. if( zExpr2==0 ){
  161711. rc = SQLITE_NOMEM;
  161712. }else{
  161713. char *zStmt = sqlite3_mprintf(
  161714. "SELECT * FROM \"%w\".\"%w\", \"%w\".\"%w\" WHERE %s AND (%z)",
  161715. pSession->zDb, pTab->zName, zFrom, pTab->zName, zExpr, zExpr2
  161716. );
  161717. if( zStmt==0 ){
  161718. rc = SQLITE_NOMEM;
  161719. }else{
  161720. sqlite3_stmt *pStmt;
  161721. rc = sqlite3_prepare(pSession->db, zStmt, -1, &pStmt, 0);
  161722. if( rc==SQLITE_OK ){
  161723. SessionDiffCtx *pDiffCtx = (SessionDiffCtx*)pSession->hook.pCtx;
  161724. pDiffCtx->pStmt = pStmt;
  161725. pDiffCtx->nOldOff = pTab->nCol;
  161726. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  161727. sessionPreupdateOneChange(SQLITE_UPDATE, pSession, pTab);
  161728. }
  161729. rc = sqlite3_finalize(pStmt);
  161730. }
  161731. sqlite3_free(zStmt);
  161732. }
  161733. }
  161734. return rc;
  161735. }
  161736. SQLITE_API int sqlite3session_diff(
  161737. sqlite3_session *pSession,
  161738. const char *zFrom,
  161739. const char *zTbl,
  161740. char **pzErrMsg
  161741. ){
  161742. const char *zDb = pSession->zDb;
  161743. int rc = pSession->rc;
  161744. SessionDiffCtx d;
  161745. memset(&d, 0, sizeof(d));
  161746. sessionDiffHooks(pSession, &d);
  161747. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  161748. if( pzErrMsg ) *pzErrMsg = 0;
  161749. if( rc==SQLITE_OK ){
  161750. char *zExpr = 0;
  161751. sqlite3 *db = pSession->db;
  161752. SessionTable *pTo; /* Table zTbl */
  161753. /* Locate and if necessary initialize the target table object */
  161754. rc = sessionFindTable(pSession, zTbl, &pTo);
  161755. if( pTo==0 ) goto diff_out;
  161756. if( sessionInitTable(pSession, pTo) ){
  161757. rc = pSession->rc;
  161758. goto diff_out;
  161759. }
  161760. /* Check the table schemas match */
  161761. if( rc==SQLITE_OK ){
  161762. int bHasPk = 0;
  161763. int bMismatch = 0;
  161764. int nCol; /* Columns in zFrom.zTbl */
  161765. u8 *abPK;
  161766. const char **azCol = 0;
  161767. rc = sessionTableInfo(db, zFrom, zTbl, &nCol, 0, &azCol, &abPK);
  161768. if( rc==SQLITE_OK ){
  161769. if( pTo->nCol!=nCol ){
  161770. bMismatch = 1;
  161771. }else{
  161772. int i;
  161773. for(i=0; i<nCol; i++){
  161774. if( pTo->abPK[i]!=abPK[i] ) bMismatch = 1;
  161775. if( sqlite3_stricmp(azCol[i], pTo->azCol[i]) ) bMismatch = 1;
  161776. if( abPK[i] ) bHasPk = 1;
  161777. }
  161778. }
  161779. }
  161780. sqlite3_free((char*)azCol);
  161781. if( bMismatch ){
  161782. *pzErrMsg = sqlite3_mprintf("table schemas do not match");
  161783. rc = SQLITE_SCHEMA;
  161784. }
  161785. if( bHasPk==0 ){
  161786. /* Ignore tables with no primary keys */
  161787. goto diff_out;
  161788. }
  161789. }
  161790. if( rc==SQLITE_OK ){
  161791. zExpr = sessionExprComparePK(pTo->nCol,
  161792. zDb, zFrom, pTo->zName, pTo->azCol, pTo->abPK
  161793. );
  161794. }
  161795. /* Find new rows */
  161796. if( rc==SQLITE_OK ){
  161797. rc = sessionDiffFindNew(SQLITE_INSERT, pSession, pTo, zDb, zFrom, zExpr);
  161798. }
  161799. /* Find old rows */
  161800. if( rc==SQLITE_OK ){
  161801. rc = sessionDiffFindNew(SQLITE_DELETE, pSession, pTo, zFrom, zDb, zExpr);
  161802. }
  161803. /* Find modified rows */
  161804. if( rc==SQLITE_OK ){
  161805. rc = sessionDiffFindModified(pSession, pTo, zFrom, zExpr);
  161806. }
  161807. sqlite3_free(zExpr);
  161808. }
  161809. diff_out:
  161810. sessionPreupdateHooks(pSession);
  161811. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  161812. return rc;
  161813. }
  161814. /*
  161815. ** Create a session object. This session object will record changes to
  161816. ** database zDb attached to connection db.
  161817. */
  161818. SQLITE_API int sqlite3session_create(
  161819. sqlite3 *db, /* Database handle */
  161820. const char *zDb, /* Name of db (e.g. "main") */
  161821. sqlite3_session **ppSession /* OUT: New session object */
  161822. ){
  161823. sqlite3_session *pNew; /* Newly allocated session object */
  161824. sqlite3_session *pOld; /* Session object already attached to db */
  161825. int nDb = sqlite3Strlen30(zDb); /* Length of zDb in bytes */
  161826. /* Zero the output value in case an error occurs. */
  161827. *ppSession = 0;
  161828. /* Allocate and populate the new session object. */
  161829. pNew = (sqlite3_session *)sqlite3_malloc(sizeof(sqlite3_session) + nDb + 1);
  161830. if( !pNew ) return SQLITE_NOMEM;
  161831. memset(pNew, 0, sizeof(sqlite3_session));
  161832. pNew->db = db;
  161833. pNew->zDb = (char *)&pNew[1];
  161834. pNew->bEnable = 1;
  161835. memcpy(pNew->zDb, zDb, nDb+1);
  161836. sessionPreupdateHooks(pNew);
  161837. /* Add the new session object to the linked list of session objects
  161838. ** attached to database handle $db. Do this under the cover of the db
  161839. ** handle mutex. */
  161840. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  161841. pOld = (sqlite3_session*)sqlite3_preupdate_hook(db, xPreUpdate, (void*)pNew);
  161842. pNew->pNext = pOld;
  161843. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  161844. *ppSession = pNew;
  161845. return SQLITE_OK;
  161846. }
  161847. /*
  161848. ** Free the list of table objects passed as the first argument. The contents
  161849. ** of the changed-rows hash tables are also deleted.
  161850. */
  161851. static void sessionDeleteTable(SessionTable *pList){
  161852. SessionTable *pNext;
  161853. SessionTable *pTab;
  161854. for(pTab=pList; pTab; pTab=pNext){
  161855. int i;
  161856. pNext = pTab->pNext;
  161857. for(i=0; i<pTab->nChange; i++){
  161858. SessionChange *p;
  161859. SessionChange *pNextChange;
  161860. for(p=pTab->apChange[i]; p; p=pNextChange){
  161861. pNextChange = p->pNext;
  161862. sqlite3_free(p);
  161863. }
  161864. }
  161865. sqlite3_free((char*)pTab->azCol); /* cast works around VC++ bug */
  161866. sqlite3_free(pTab->apChange);
  161867. sqlite3_free(pTab);
  161868. }
  161869. }
  161870. /*
  161871. ** Delete a session object previously allocated using sqlite3session_create().
  161872. */
  161873. SQLITE_API void sqlite3session_delete(sqlite3_session *pSession){
  161874. sqlite3 *db = pSession->db;
  161875. sqlite3_session *pHead;
  161876. sqlite3_session **pp;
  161877. /* Unlink the session from the linked list of sessions attached to the
  161878. ** database handle. Hold the db mutex while doing so. */
  161879. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  161880. pHead = (sqlite3_session*)sqlite3_preupdate_hook(db, 0, 0);
  161881. for(pp=&pHead; ALWAYS((*pp)!=0); pp=&((*pp)->pNext)){
  161882. if( (*pp)==pSession ){
  161883. *pp = (*pp)->pNext;
  161884. if( pHead ) sqlite3_preupdate_hook(db, xPreUpdate, (void*)pHead);
  161885. break;
  161886. }
  161887. }
  161888. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  161889. /* Delete all attached table objects. And the contents of their
  161890. ** associated hash-tables. */
  161891. sessionDeleteTable(pSession->pTable);
  161892. /* Free the session object itself. */
  161893. sqlite3_free(pSession);
  161894. }
  161895. /*
  161896. ** Set a table filter on a Session Object.
  161897. */
  161898. SQLITE_API void sqlite3session_table_filter(
  161899. sqlite3_session *pSession,
  161900. int(*xFilter)(void*, const char*),
  161901. void *pCtx /* First argument passed to xFilter */
  161902. ){
  161903. pSession->bAutoAttach = 1;
  161904. pSession->pFilterCtx = pCtx;
  161905. pSession->xTableFilter = xFilter;
  161906. }
  161907. /*
  161908. ** Attach a table to a session. All subsequent changes made to the table
  161909. ** while the session object is enabled will be recorded.
  161910. **
  161911. ** Only tables that have a PRIMARY KEY defined may be attached. It does
  161912. ** not matter if the PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias)
  161913. ** or not.
  161914. */
  161915. SQLITE_API int sqlite3session_attach(
  161916. sqlite3_session *pSession, /* Session object */
  161917. const char *zName /* Table name */
  161918. ){
  161919. int rc = SQLITE_OK;
  161920. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  161921. if( !zName ){
  161922. pSession->bAutoAttach = 1;
  161923. }else{
  161924. SessionTable *pTab; /* New table object (if required) */
  161925. int nName; /* Number of bytes in string zName */
  161926. /* First search for an existing entry. If one is found, this call is
  161927. ** a no-op. Return early. */
  161928. nName = sqlite3Strlen30(zName);
  161929. for(pTab=pSession->pTable; pTab; pTab=pTab->pNext){
  161930. if( 0==sqlite3_strnicmp(pTab->zName, zName, nName+1) ) break;
  161931. }
  161932. if( !pTab ){
  161933. /* Allocate new SessionTable object. */
  161934. pTab = (SessionTable *)sqlite3_malloc(sizeof(SessionTable) + nName + 1);
  161935. if( !pTab ){
  161936. rc = SQLITE_NOMEM;
  161937. }else{
  161938. /* Populate the new SessionTable object and link it into the list.
  161939. ** The new object must be linked onto the end of the list, not
  161940. ** simply added to the start of it in order to ensure that tables
  161941. ** appear in the correct order when a changeset or patchset is
  161942. ** eventually generated. */
  161943. SessionTable **ppTab;
  161944. memset(pTab, 0, sizeof(SessionTable));
  161945. pTab->zName = (char *)&pTab[1];
  161946. memcpy(pTab->zName, zName, nName+1);
  161947. for(ppTab=&pSession->pTable; *ppTab; ppTab=&(*ppTab)->pNext);
  161948. *ppTab = pTab;
  161949. }
  161950. }
  161951. }
  161952. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  161953. return rc;
  161954. }
  161955. /*
  161956. ** Ensure that there is room in the buffer to append nByte bytes of data.
  161957. ** If not, use sqlite3_realloc() to grow the buffer so that there is.
  161958. **
  161959. ** If successful, return zero. Otherwise, if an OOM condition is encountered,
  161960. ** set *pRc to SQLITE_NOMEM and return non-zero.
  161961. */
  161962. static int sessionBufferGrow(SessionBuffer *p, int nByte, int *pRc){
  161963. if( *pRc==SQLITE_OK && p->nAlloc-p->nBuf<nByte ){
  161964. u8 *aNew;
  161965. int nNew = p->nAlloc ? p->nAlloc : 128;
  161966. do {
  161967. nNew = nNew*2;
  161968. }while( nNew<(p->nBuf+nByte) );
  161969. aNew = (u8 *)sqlite3_realloc(p->aBuf, nNew);
  161970. if( 0==aNew ){
  161971. *pRc = SQLITE_NOMEM;
  161972. }else{
  161973. p->aBuf = aNew;
  161974. p->nAlloc = nNew;
  161975. }
  161976. }
  161977. return (*pRc!=SQLITE_OK);
  161978. }
  161979. /*
  161980. ** Append the value passed as the second argument to the buffer passed
  161981. ** as the first.
  161982. **
  161983. ** This function is a no-op if *pRc is non-zero when it is called.
  161984. ** Otherwise, if an error occurs, *pRc is set to an SQLite error code
  161985. ** before returning.
  161986. */
  161987. static void sessionAppendValue(SessionBuffer *p, sqlite3_value *pVal, int *pRc){
  161988. int rc = *pRc;
  161989. if( rc==SQLITE_OK ){
  161990. int nByte = 0;
  161991. rc = sessionSerializeValue(0, pVal, &nByte);
  161992. sessionBufferGrow(p, nByte, &rc);
  161993. if( rc==SQLITE_OK ){
  161994. rc = sessionSerializeValue(&p->aBuf[p->nBuf], pVal, 0);
  161995. p->nBuf += nByte;
  161996. }else{
  161997. *pRc = rc;
  161998. }
  161999. }
  162000. }
  162001. /*
  162002. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162003. ** called. Otherwise, append a single byte to the buffer.
  162004. **
  162005. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162006. ** returning.
  162007. */
  162008. static void sessionAppendByte(SessionBuffer *p, u8 v, int *pRc){
  162009. if( 0==sessionBufferGrow(p, 1, pRc) ){
  162010. p->aBuf[p->nBuf++] = v;
  162011. }
  162012. }
  162013. /*
  162014. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162015. ** called. Otherwise, append a single varint to the buffer.
  162016. **
  162017. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162018. ** returning.
  162019. */
  162020. static void sessionAppendVarint(SessionBuffer *p, int v, int *pRc){
  162021. if( 0==sessionBufferGrow(p, 9, pRc) ){
  162022. p->nBuf += sessionVarintPut(&p->aBuf[p->nBuf], v);
  162023. }
  162024. }
  162025. /*
  162026. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162027. ** called. Otherwise, append a blob of data to the buffer.
  162028. **
  162029. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162030. ** returning.
  162031. */
  162032. static void sessionAppendBlob(
  162033. SessionBuffer *p,
  162034. const u8 *aBlob,
  162035. int nBlob,
  162036. int *pRc
  162037. ){
  162038. if( 0==sessionBufferGrow(p, nBlob, pRc) ){
  162039. memcpy(&p->aBuf[p->nBuf], aBlob, nBlob);
  162040. p->nBuf += nBlob;
  162041. }
  162042. }
  162043. /*
  162044. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162045. ** called. Otherwise, append a string to the buffer. All bytes in the string
  162046. ** up to (but not including) the nul-terminator are written to the buffer.
  162047. **
  162048. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162049. ** returning.
  162050. */
  162051. static void sessionAppendStr(
  162052. SessionBuffer *p,
  162053. const char *zStr,
  162054. int *pRc
  162055. ){
  162056. int nStr = sqlite3Strlen30(zStr);
  162057. if( 0==sessionBufferGrow(p, nStr, pRc) ){
  162058. memcpy(&p->aBuf[p->nBuf], zStr, nStr);
  162059. p->nBuf += nStr;
  162060. }
  162061. }
  162062. /*
  162063. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162064. ** called. Otherwise, append the string representation of integer iVal
  162065. ** to the buffer. No nul-terminator is written.
  162066. **
  162067. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162068. ** returning.
  162069. */
  162070. static void sessionAppendInteger(
  162071. SessionBuffer *p, /* Buffer to append to */
  162072. int iVal, /* Value to write the string rep. of */
  162073. int *pRc /* IN/OUT: Error code */
  162074. ){
  162075. char aBuf[24];
  162076. sqlite3_snprintf(sizeof(aBuf)-1, aBuf, "%d", iVal);
  162077. sessionAppendStr(p, aBuf, pRc);
  162078. }
  162079. /*
  162080. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162081. ** called. Otherwise, append the string zStr enclosed in quotes (") and
  162082. ** with any embedded quote characters escaped to the buffer. No
  162083. ** nul-terminator byte is written.
  162084. **
  162085. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  162086. ** returning.
  162087. */
  162088. static void sessionAppendIdent(
  162089. SessionBuffer *p, /* Buffer to a append to */
  162090. const char *zStr, /* String to quote, escape and append */
  162091. int *pRc /* IN/OUT: Error code */
  162092. ){
  162093. int nStr = sqlite3Strlen30(zStr)*2 + 2 + 1;
  162094. if( 0==sessionBufferGrow(p, nStr, pRc) ){
  162095. char *zOut = (char *)&p->aBuf[p->nBuf];
  162096. const char *zIn = zStr;
  162097. *zOut++ = '"';
  162098. while( *zIn ){
  162099. if( *zIn=='"' ) *zOut++ = '"';
  162100. *zOut++ = *(zIn++);
  162101. }
  162102. *zOut++ = '"';
  162103. p->nBuf = (int)((u8 *)zOut - p->aBuf);
  162104. }
  162105. }
  162106. /*
  162107. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  162108. ** called. Otherwse, it appends the serialized version of the value stored
  162109. ** in column iCol of the row that SQL statement pStmt currently points
  162110. ** to to the buffer.
  162111. */
  162112. static void sessionAppendCol(
  162113. SessionBuffer *p, /* Buffer to append to */
  162114. sqlite3_stmt *pStmt, /* Handle pointing to row containing value */
  162115. int iCol, /* Column to read value from */
  162116. int *pRc /* IN/OUT: Error code */
  162117. ){
  162118. if( *pRc==SQLITE_OK ){
  162119. int eType = sqlite3_column_type(pStmt, iCol);
  162120. sessionAppendByte(p, (u8)eType, pRc);
  162121. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  162122. sqlite3_int64 i;
  162123. u8 aBuf[8];
  162124. if( eType==SQLITE_INTEGER ){
  162125. i = sqlite3_column_int64(pStmt, iCol);
  162126. }else{
  162127. double r = sqlite3_column_double(pStmt, iCol);
  162128. memcpy(&i, &r, 8);
  162129. }
  162130. sessionPutI64(aBuf, i);
  162131. sessionAppendBlob(p, aBuf, 8, pRc);
  162132. }
  162133. if( eType==SQLITE_BLOB || eType==SQLITE_TEXT ){
  162134. u8 *z;
  162135. int nByte;
  162136. if( eType==SQLITE_BLOB ){
  162137. z = (u8 *)sqlite3_column_blob(pStmt, iCol);
  162138. }else{
  162139. z = (u8 *)sqlite3_column_text(pStmt, iCol);
  162140. }
  162141. nByte = sqlite3_column_bytes(pStmt, iCol);
  162142. if( z || (eType==SQLITE_BLOB && nByte==0) ){
  162143. sessionAppendVarint(p, nByte, pRc);
  162144. sessionAppendBlob(p, z, nByte, pRc);
  162145. }else{
  162146. *pRc = SQLITE_NOMEM;
  162147. }
  162148. }
  162149. }
  162150. }
  162151. /*
  162152. **
  162153. ** This function appends an update change to the buffer (see the comments
  162154. ** under "CHANGESET FORMAT" at the top of the file). An update change
  162155. ** consists of:
  162156. **
  162157. ** 1 byte: SQLITE_UPDATE (0x17)
  162158. ** n bytes: old.* record (see RECORD FORMAT)
  162159. ** m bytes: new.* record (see RECORD FORMAT)
  162160. **
  162161. ** The SessionChange object passed as the third argument contains the
  162162. ** values that were stored in the row when the session began (the old.*
  162163. ** values). The statement handle passed as the second argument points
  162164. ** at the current version of the row (the new.* values).
  162165. **
  162166. ** If all of the old.* values are equal to their corresponding new.* value
  162167. ** (i.e. nothing has changed), then no data at all is appended to the buffer.
  162168. **
  162169. ** Otherwise, the old.* record contains all primary key values and the
  162170. ** original values of any fields that have been modified. The new.* record
  162171. ** contains the new values of only those fields that have been modified.
  162172. */
  162173. static int sessionAppendUpdate(
  162174. SessionBuffer *pBuf, /* Buffer to append to */
  162175. int bPatchset, /* True for "patchset", 0 for "changeset" */
  162176. sqlite3_stmt *pStmt, /* Statement handle pointing at new row */
  162177. SessionChange *p, /* Object containing old values */
  162178. u8 *abPK /* Boolean array - true for PK columns */
  162179. ){
  162180. int rc = SQLITE_OK;
  162181. SessionBuffer buf2 = {0,0,0}; /* Buffer to accumulate new.* record in */
  162182. int bNoop = 1; /* Set to zero if any values are modified */
  162183. int nRewind = pBuf->nBuf; /* Set to zero if any values are modified */
  162184. int i; /* Used to iterate through columns */
  162185. u8 *pCsr = p->aRecord; /* Used to iterate through old.* values */
  162186. sessionAppendByte(pBuf, SQLITE_UPDATE, &rc);
  162187. sessionAppendByte(pBuf, p->bIndirect, &rc);
  162188. for(i=0; i<sqlite3_column_count(pStmt); i++){
  162189. int bChanged = 0;
  162190. int nAdvance;
  162191. int eType = *pCsr;
  162192. switch( eType ){
  162193. case SQLITE_NULL:
  162194. nAdvance = 1;
  162195. if( sqlite3_column_type(pStmt, i)!=SQLITE_NULL ){
  162196. bChanged = 1;
  162197. }
  162198. break;
  162199. case SQLITE_FLOAT:
  162200. case SQLITE_INTEGER: {
  162201. nAdvance = 9;
  162202. if( eType==sqlite3_column_type(pStmt, i) ){
  162203. sqlite3_int64 iVal = sessionGetI64(&pCsr[1]);
  162204. if( eType==SQLITE_INTEGER ){
  162205. if( iVal==sqlite3_column_int64(pStmt, i) ) break;
  162206. }else{
  162207. double dVal;
  162208. memcpy(&dVal, &iVal, 8);
  162209. if( dVal==sqlite3_column_double(pStmt, i) ) break;
  162210. }
  162211. }
  162212. bChanged = 1;
  162213. break;
  162214. }
  162215. default: {
  162216. int nByte;
  162217. int nHdr = 1 + sessionVarintGet(&pCsr[1], &nByte);
  162218. assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
  162219. nAdvance = nHdr + nByte;
  162220. if( eType==sqlite3_column_type(pStmt, i)
  162221. && nByte==sqlite3_column_bytes(pStmt, i)
  162222. && 0==memcmp(&pCsr[nHdr], sqlite3_column_blob(pStmt, i), nByte)
  162223. ){
  162224. break;
  162225. }
  162226. bChanged = 1;
  162227. }
  162228. }
  162229. /* If at least one field has been modified, this is not a no-op. */
  162230. if( bChanged ) bNoop = 0;
  162231. /* Add a field to the old.* record. This is omitted if this modules is
  162232. ** currently generating a patchset. */
  162233. if( bPatchset==0 ){
  162234. if( bChanged || abPK[i] ){
  162235. sessionAppendBlob(pBuf, pCsr, nAdvance, &rc);
  162236. }else{
  162237. sessionAppendByte(pBuf, 0, &rc);
  162238. }
  162239. }
  162240. /* Add a field to the new.* record. Or the only record if currently
  162241. ** generating a patchset. */
  162242. if( bChanged || (bPatchset && abPK[i]) ){
  162243. sessionAppendCol(&buf2, pStmt, i, &rc);
  162244. }else{
  162245. sessionAppendByte(&buf2, 0, &rc);
  162246. }
  162247. pCsr += nAdvance;
  162248. }
  162249. if( bNoop ){
  162250. pBuf->nBuf = nRewind;
  162251. }else{
  162252. sessionAppendBlob(pBuf, buf2.aBuf, buf2.nBuf, &rc);
  162253. }
  162254. sqlite3_free(buf2.aBuf);
  162255. return rc;
  162256. }
  162257. /*
  162258. ** Append a DELETE change to the buffer passed as the first argument. Use
  162259. ** the changeset format if argument bPatchset is zero, or the patchset
  162260. ** format otherwise.
  162261. */
  162262. static int sessionAppendDelete(
  162263. SessionBuffer *pBuf, /* Buffer to append to */
  162264. int bPatchset, /* True for "patchset", 0 for "changeset" */
  162265. SessionChange *p, /* Object containing old values */
  162266. int nCol, /* Number of columns in table */
  162267. u8 *abPK /* Boolean array - true for PK columns */
  162268. ){
  162269. int rc = SQLITE_OK;
  162270. sessionAppendByte(pBuf, SQLITE_DELETE, &rc);
  162271. sessionAppendByte(pBuf, p->bIndirect, &rc);
  162272. if( bPatchset==0 ){
  162273. sessionAppendBlob(pBuf, p->aRecord, p->nRecord, &rc);
  162274. }else{
  162275. int i;
  162276. u8 *a = p->aRecord;
  162277. for(i=0; i<nCol; i++){
  162278. u8 *pStart = a;
  162279. int eType = *a++;
  162280. switch( eType ){
  162281. case 0:
  162282. case SQLITE_NULL:
  162283. assert( abPK[i]==0 );
  162284. break;
  162285. case SQLITE_FLOAT:
  162286. case SQLITE_INTEGER:
  162287. a += 8;
  162288. break;
  162289. default: {
  162290. int n;
  162291. a += sessionVarintGet(a, &n);
  162292. a += n;
  162293. break;
  162294. }
  162295. }
  162296. if( abPK[i] ){
  162297. sessionAppendBlob(pBuf, pStart, (int)(a-pStart), &rc);
  162298. }
  162299. }
  162300. assert( (a - p->aRecord)==p->nRecord );
  162301. }
  162302. return rc;
  162303. }
  162304. /*
  162305. ** Formulate and prepare a SELECT statement to retrieve a row from table
  162306. ** zTab in database zDb based on its primary key. i.e.
  162307. **
  162308. ** SELECT * FROM zDb.zTab WHERE pk1 = ? AND pk2 = ? AND ...
  162309. */
  162310. static int sessionSelectStmt(
  162311. sqlite3 *db, /* Database handle */
  162312. const char *zDb, /* Database name */
  162313. const char *zTab, /* Table name */
  162314. int nCol, /* Number of columns in table */
  162315. const char **azCol, /* Names of table columns */
  162316. u8 *abPK, /* PRIMARY KEY array */
  162317. sqlite3_stmt **ppStmt /* OUT: Prepared SELECT statement */
  162318. ){
  162319. int rc = SQLITE_OK;
  162320. int i;
  162321. const char *zSep = "";
  162322. SessionBuffer buf = {0, 0, 0};
  162323. sessionAppendStr(&buf, "SELECT * FROM ", &rc);
  162324. sessionAppendIdent(&buf, zDb, &rc);
  162325. sessionAppendStr(&buf, ".", &rc);
  162326. sessionAppendIdent(&buf, zTab, &rc);
  162327. sessionAppendStr(&buf, " WHERE ", &rc);
  162328. for(i=0; i<nCol; i++){
  162329. if( abPK[i] ){
  162330. sessionAppendStr(&buf, zSep, &rc);
  162331. sessionAppendIdent(&buf, azCol[i], &rc);
  162332. sessionAppendStr(&buf, " = ?", &rc);
  162333. sessionAppendInteger(&buf, i+1, &rc);
  162334. zSep = " AND ";
  162335. }
  162336. }
  162337. if( rc==SQLITE_OK ){
  162338. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, ppStmt, 0);
  162339. }
  162340. sqlite3_free(buf.aBuf);
  162341. return rc;
  162342. }
  162343. /*
  162344. ** Bind the PRIMARY KEY values from the change passed in argument pChange
  162345. ** to the SELECT statement passed as the first argument. The SELECT statement
  162346. ** is as prepared by function sessionSelectStmt().
  162347. **
  162348. ** Return SQLITE_OK if all PK values are successfully bound, or an SQLite
  162349. ** error code (e.g. SQLITE_NOMEM) otherwise.
  162350. */
  162351. static int sessionSelectBind(
  162352. sqlite3_stmt *pSelect, /* SELECT from sessionSelectStmt() */
  162353. int nCol, /* Number of columns in table */
  162354. u8 *abPK, /* PRIMARY KEY array */
  162355. SessionChange *pChange /* Change structure */
  162356. ){
  162357. int i;
  162358. int rc = SQLITE_OK;
  162359. u8 *a = pChange->aRecord;
  162360. for(i=0; i<nCol && rc==SQLITE_OK; i++){
  162361. int eType = *a++;
  162362. switch( eType ){
  162363. case 0:
  162364. case SQLITE_NULL:
  162365. assert( abPK[i]==0 );
  162366. break;
  162367. case SQLITE_INTEGER: {
  162368. if( abPK[i] ){
  162369. i64 iVal = sessionGetI64(a);
  162370. rc = sqlite3_bind_int64(pSelect, i+1, iVal);
  162371. }
  162372. a += 8;
  162373. break;
  162374. }
  162375. case SQLITE_FLOAT: {
  162376. if( abPK[i] ){
  162377. double rVal;
  162378. i64 iVal = sessionGetI64(a);
  162379. memcpy(&rVal, &iVal, 8);
  162380. rc = sqlite3_bind_double(pSelect, i+1, rVal);
  162381. }
  162382. a += 8;
  162383. break;
  162384. }
  162385. case SQLITE_TEXT: {
  162386. int n;
  162387. a += sessionVarintGet(a, &n);
  162388. if( abPK[i] ){
  162389. rc = sqlite3_bind_text(pSelect, i+1, (char *)a, n, SQLITE_TRANSIENT);
  162390. }
  162391. a += n;
  162392. break;
  162393. }
  162394. default: {
  162395. int n;
  162396. assert( eType==SQLITE_BLOB );
  162397. a += sessionVarintGet(a, &n);
  162398. if( abPK[i] ){
  162399. rc = sqlite3_bind_blob(pSelect, i+1, a, n, SQLITE_TRANSIENT);
  162400. }
  162401. a += n;
  162402. break;
  162403. }
  162404. }
  162405. }
  162406. return rc;
  162407. }
  162408. /*
  162409. ** This function is a no-op if *pRc is set to other than SQLITE_OK when it
  162410. ** is called. Otherwise, append a serialized table header (part of the binary
  162411. ** changeset format) to buffer *pBuf. If an error occurs, set *pRc to an
  162412. ** SQLite error code before returning.
  162413. */
  162414. static void sessionAppendTableHdr(
  162415. SessionBuffer *pBuf, /* Append header to this buffer */
  162416. int bPatchset, /* Use the patchset format if true */
  162417. SessionTable *pTab, /* Table object to append header for */
  162418. int *pRc /* IN/OUT: Error code */
  162419. ){
  162420. /* Write a table header */
  162421. sessionAppendByte(pBuf, (bPatchset ? 'P' : 'T'), pRc);
  162422. sessionAppendVarint(pBuf, pTab->nCol, pRc);
  162423. sessionAppendBlob(pBuf, pTab->abPK, pTab->nCol, pRc);
  162424. sessionAppendBlob(pBuf, (u8 *)pTab->zName, (int)strlen(pTab->zName)+1, pRc);
  162425. }
  162426. /*
  162427. ** Generate either a changeset (if argument bPatchset is zero) or a patchset
  162428. ** (if it is non-zero) based on the current contents of the session object
  162429. ** passed as the first argument.
  162430. **
  162431. ** If no error occurs, SQLITE_OK is returned and the new changeset/patchset
  162432. ** stored in output variables *pnChangeset and *ppChangeset. Or, if an error
  162433. ** occurs, an SQLite error code is returned and both output variables set
  162434. ** to 0.
  162435. */
  162436. static int sessionGenerateChangeset(
  162437. sqlite3_session *pSession, /* Session object */
  162438. int bPatchset, /* True for patchset, false for changeset */
  162439. int (*xOutput)(void *pOut, const void *pData, int nData),
  162440. void *pOut, /* First argument for xOutput */
  162441. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  162442. void **ppChangeset /* OUT: Buffer containing changeset */
  162443. ){
  162444. sqlite3 *db = pSession->db; /* Source database handle */
  162445. SessionTable *pTab; /* Used to iterate through attached tables */
  162446. SessionBuffer buf = {0,0,0}; /* Buffer in which to accumlate changeset */
  162447. int rc; /* Return code */
  162448. assert( xOutput==0 || (pnChangeset==0 && ppChangeset==0 ) );
  162449. /* Zero the output variables in case an error occurs. If this session
  162450. ** object is already in the error state (sqlite3_session.rc != SQLITE_OK),
  162451. ** this call will be a no-op. */
  162452. if( xOutput==0 ){
  162453. *pnChangeset = 0;
  162454. *ppChangeset = 0;
  162455. }
  162456. if( pSession->rc ) return pSession->rc;
  162457. rc = sqlite3_exec(pSession->db, "SAVEPOINT changeset", 0, 0, 0);
  162458. if( rc!=SQLITE_OK ) return rc;
  162459. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  162460. for(pTab=pSession->pTable; rc==SQLITE_OK && pTab; pTab=pTab->pNext){
  162461. if( pTab->nEntry ){
  162462. const char *zName = pTab->zName;
  162463. int nCol; /* Number of columns in table */
  162464. u8 *abPK; /* Primary key array */
  162465. const char **azCol = 0; /* Table columns */
  162466. int i; /* Used to iterate through hash buckets */
  162467. sqlite3_stmt *pSel = 0; /* SELECT statement to query table pTab */
  162468. int nRewind = buf.nBuf; /* Initial size of write buffer */
  162469. int nNoop; /* Size of buffer after writing tbl header */
  162470. /* Check the table schema is still Ok. */
  162471. rc = sessionTableInfo(db, pSession->zDb, zName, &nCol, 0, &azCol, &abPK);
  162472. if( !rc && (pTab->nCol!=nCol || memcmp(abPK, pTab->abPK, nCol)) ){
  162473. rc = SQLITE_SCHEMA;
  162474. }
  162475. /* Write a table header */
  162476. sessionAppendTableHdr(&buf, bPatchset, pTab, &rc);
  162477. /* Build and compile a statement to execute: */
  162478. if( rc==SQLITE_OK ){
  162479. rc = sessionSelectStmt(
  162480. db, pSession->zDb, zName, nCol, azCol, abPK, &pSel);
  162481. }
  162482. nNoop = buf.nBuf;
  162483. for(i=0; i<pTab->nChange && rc==SQLITE_OK; i++){
  162484. SessionChange *p; /* Used to iterate through changes */
  162485. for(p=pTab->apChange[i]; rc==SQLITE_OK && p; p=p->pNext){
  162486. rc = sessionSelectBind(pSel, nCol, abPK, p);
  162487. if( rc!=SQLITE_OK ) continue;
  162488. if( sqlite3_step(pSel)==SQLITE_ROW ){
  162489. if( p->op==SQLITE_INSERT ){
  162490. int iCol;
  162491. sessionAppendByte(&buf, SQLITE_INSERT, &rc);
  162492. sessionAppendByte(&buf, p->bIndirect, &rc);
  162493. for(iCol=0; iCol<nCol; iCol++){
  162494. sessionAppendCol(&buf, pSel, iCol, &rc);
  162495. }
  162496. }else{
  162497. rc = sessionAppendUpdate(&buf, bPatchset, pSel, p, abPK);
  162498. }
  162499. }else if( p->op!=SQLITE_INSERT ){
  162500. rc = sessionAppendDelete(&buf, bPatchset, p, nCol, abPK);
  162501. }
  162502. if( rc==SQLITE_OK ){
  162503. rc = sqlite3_reset(pSel);
  162504. }
  162505. /* If the buffer is now larger than SESSIONS_STRM_CHUNK_SIZE, pass
  162506. ** its contents to the xOutput() callback. */
  162507. if( xOutput
  162508. && rc==SQLITE_OK
  162509. && buf.nBuf>nNoop
  162510. && buf.nBuf>SESSIONS_STRM_CHUNK_SIZE
  162511. ){
  162512. rc = xOutput(pOut, (void*)buf.aBuf, buf.nBuf);
  162513. nNoop = -1;
  162514. buf.nBuf = 0;
  162515. }
  162516. }
  162517. }
  162518. sqlite3_finalize(pSel);
  162519. if( buf.nBuf==nNoop ){
  162520. buf.nBuf = nRewind;
  162521. }
  162522. sqlite3_free((char*)azCol); /* cast works around VC++ bug */
  162523. }
  162524. }
  162525. if( rc==SQLITE_OK ){
  162526. if( xOutput==0 ){
  162527. *pnChangeset = buf.nBuf;
  162528. *ppChangeset = buf.aBuf;
  162529. buf.aBuf = 0;
  162530. }else if( buf.nBuf>0 ){
  162531. rc = xOutput(pOut, (void*)buf.aBuf, buf.nBuf);
  162532. }
  162533. }
  162534. sqlite3_free(buf.aBuf);
  162535. sqlite3_exec(db, "RELEASE changeset", 0, 0, 0);
  162536. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  162537. return rc;
  162538. }
  162539. /*
  162540. ** Obtain a changeset object containing all changes recorded by the
  162541. ** session object passed as the first argument.
  162542. **
  162543. ** It is the responsibility of the caller to eventually free the buffer
  162544. ** using sqlite3_free().
  162545. */
  162546. SQLITE_API int sqlite3session_changeset(
  162547. sqlite3_session *pSession, /* Session object */
  162548. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  162549. void **ppChangeset /* OUT: Buffer containing changeset */
  162550. ){
  162551. return sessionGenerateChangeset(pSession, 0, 0, 0, pnChangeset, ppChangeset);
  162552. }
  162553. /*
  162554. ** Streaming version of sqlite3session_changeset().
  162555. */
  162556. SQLITE_API int sqlite3session_changeset_strm(
  162557. sqlite3_session *pSession,
  162558. int (*xOutput)(void *pOut, const void *pData, int nData),
  162559. void *pOut
  162560. ){
  162561. return sessionGenerateChangeset(pSession, 0, xOutput, pOut, 0, 0);
  162562. }
  162563. /*
  162564. ** Streaming version of sqlite3session_patchset().
  162565. */
  162566. SQLITE_API int sqlite3session_patchset_strm(
  162567. sqlite3_session *pSession,
  162568. int (*xOutput)(void *pOut, const void *pData, int nData),
  162569. void *pOut
  162570. ){
  162571. return sessionGenerateChangeset(pSession, 1, xOutput, pOut, 0, 0);
  162572. }
  162573. /*
  162574. ** Obtain a patchset object containing all changes recorded by the
  162575. ** session object passed as the first argument.
  162576. **
  162577. ** It is the responsibility of the caller to eventually free the buffer
  162578. ** using sqlite3_free().
  162579. */
  162580. SQLITE_API int sqlite3session_patchset(
  162581. sqlite3_session *pSession, /* Session object */
  162582. int *pnPatchset, /* OUT: Size of buffer at *ppChangeset */
  162583. void **ppPatchset /* OUT: Buffer containing changeset */
  162584. ){
  162585. return sessionGenerateChangeset(pSession, 1, 0, 0, pnPatchset, ppPatchset);
  162586. }
  162587. /*
  162588. ** Enable or disable the session object passed as the first argument.
  162589. */
  162590. SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable){
  162591. int ret;
  162592. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  162593. if( bEnable>=0 ){
  162594. pSession->bEnable = bEnable;
  162595. }
  162596. ret = pSession->bEnable;
  162597. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  162598. return ret;
  162599. }
  162600. /*
  162601. ** Enable or disable the session object passed as the first argument.
  162602. */
  162603. SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect){
  162604. int ret;
  162605. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  162606. if( bIndirect>=0 ){
  162607. pSession->bIndirect = bIndirect;
  162608. }
  162609. ret = pSession->bIndirect;
  162610. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  162611. return ret;
  162612. }
  162613. /*
  162614. ** Return true if there have been no changes to monitored tables recorded
  162615. ** by the session object passed as the only argument.
  162616. */
  162617. SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession){
  162618. int ret = 0;
  162619. SessionTable *pTab;
  162620. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  162621. for(pTab=pSession->pTable; pTab && ret==0; pTab=pTab->pNext){
  162622. ret = (pTab->nEntry>0);
  162623. }
  162624. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  162625. return (ret==0);
  162626. }
  162627. /*
  162628. ** Do the work for either sqlite3changeset_start() or start_strm().
  162629. */
  162630. static int sessionChangesetStart(
  162631. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  162632. int (*xInput)(void *pIn, void *pData, int *pnData),
  162633. void *pIn,
  162634. int nChangeset, /* Size of buffer pChangeset in bytes */
  162635. void *pChangeset /* Pointer to buffer containing changeset */
  162636. ){
  162637. sqlite3_changeset_iter *pRet; /* Iterator to return */
  162638. int nByte; /* Number of bytes to allocate for iterator */
  162639. assert( xInput==0 || (pChangeset==0 && nChangeset==0) );
  162640. /* Zero the output variable in case an error occurs. */
  162641. *pp = 0;
  162642. /* Allocate and initialize the iterator structure. */
  162643. nByte = sizeof(sqlite3_changeset_iter);
  162644. pRet = (sqlite3_changeset_iter *)sqlite3_malloc(nByte);
  162645. if( !pRet ) return SQLITE_NOMEM;
  162646. memset(pRet, 0, sizeof(sqlite3_changeset_iter));
  162647. pRet->in.aData = (u8 *)pChangeset;
  162648. pRet->in.nData = nChangeset;
  162649. pRet->in.xInput = xInput;
  162650. pRet->in.pIn = pIn;
  162651. pRet->in.bEof = (xInput ? 0 : 1);
  162652. /* Populate the output variable and return success. */
  162653. *pp = pRet;
  162654. return SQLITE_OK;
  162655. }
  162656. /*
  162657. ** Create an iterator used to iterate through the contents of a changeset.
  162658. */
  162659. SQLITE_API int sqlite3changeset_start(
  162660. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  162661. int nChangeset, /* Size of buffer pChangeset in bytes */
  162662. void *pChangeset /* Pointer to buffer containing changeset */
  162663. ){
  162664. return sessionChangesetStart(pp, 0, 0, nChangeset, pChangeset);
  162665. }
  162666. /*
  162667. ** Streaming version of sqlite3changeset_start().
  162668. */
  162669. SQLITE_API int sqlite3changeset_start_strm(
  162670. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  162671. int (*xInput)(void *pIn, void *pData, int *pnData),
  162672. void *pIn
  162673. ){
  162674. return sessionChangesetStart(pp, xInput, pIn, 0, 0);
  162675. }
  162676. /*
  162677. ** If the SessionInput object passed as the only argument is a streaming
  162678. ** object and the buffer is full, discard some data to free up space.
  162679. */
  162680. static void sessionDiscardData(SessionInput *pIn){
  162681. if( pIn->bEof && pIn->xInput && pIn->iNext>=SESSIONS_STRM_CHUNK_SIZE ){
  162682. int nMove = pIn->buf.nBuf - pIn->iNext;
  162683. assert( nMove>=0 );
  162684. if( nMove>0 ){
  162685. memmove(pIn->buf.aBuf, &pIn->buf.aBuf[pIn->iNext], nMove);
  162686. }
  162687. pIn->buf.nBuf -= pIn->iNext;
  162688. pIn->iNext = 0;
  162689. pIn->nData = pIn->buf.nBuf;
  162690. }
  162691. }
  162692. /*
  162693. ** Ensure that there are at least nByte bytes available in the buffer. Or,
  162694. ** if there are not nByte bytes remaining in the input, that all available
  162695. ** data is in the buffer.
  162696. **
  162697. ** Return an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  162698. */
  162699. static int sessionInputBuffer(SessionInput *pIn, int nByte){
  162700. int rc = SQLITE_OK;
  162701. if( pIn->xInput ){
  162702. while( !pIn->bEof && (pIn->iNext+nByte)>=pIn->nData && rc==SQLITE_OK ){
  162703. int nNew = SESSIONS_STRM_CHUNK_SIZE;
  162704. if( pIn->bNoDiscard==0 ) sessionDiscardData(pIn);
  162705. if( SQLITE_OK==sessionBufferGrow(&pIn->buf, nNew, &rc) ){
  162706. rc = pIn->xInput(pIn->pIn, &pIn->buf.aBuf[pIn->buf.nBuf], &nNew);
  162707. if( nNew==0 ){
  162708. pIn->bEof = 1;
  162709. }else{
  162710. pIn->buf.nBuf += nNew;
  162711. }
  162712. }
  162713. pIn->aData = pIn->buf.aBuf;
  162714. pIn->nData = pIn->buf.nBuf;
  162715. }
  162716. }
  162717. return rc;
  162718. }
  162719. /*
  162720. ** When this function is called, *ppRec points to the start of a record
  162721. ** that contains nCol values. This function advances the pointer *ppRec
  162722. ** until it points to the byte immediately following that record.
  162723. */
  162724. static void sessionSkipRecord(
  162725. u8 **ppRec, /* IN/OUT: Record pointer */
  162726. int nCol /* Number of values in record */
  162727. ){
  162728. u8 *aRec = *ppRec;
  162729. int i;
  162730. for(i=0; i<nCol; i++){
  162731. int eType = *aRec++;
  162732. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  162733. int nByte;
  162734. aRec += sessionVarintGet((u8*)aRec, &nByte);
  162735. aRec += nByte;
  162736. }else if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  162737. aRec += 8;
  162738. }
  162739. }
  162740. *ppRec = aRec;
  162741. }
  162742. /*
  162743. ** This function sets the value of the sqlite3_value object passed as the
  162744. ** first argument to a copy of the string or blob held in the aData[]
  162745. ** buffer. SQLITE_OK is returned if successful, or SQLITE_NOMEM if an OOM
  162746. ** error occurs.
  162747. */
  162748. static int sessionValueSetStr(
  162749. sqlite3_value *pVal, /* Set the value of this object */
  162750. u8 *aData, /* Buffer containing string or blob data */
  162751. int nData, /* Size of buffer aData[] in bytes */
  162752. u8 enc /* String encoding (0 for blobs) */
  162753. ){
  162754. /* In theory this code could just pass SQLITE_TRANSIENT as the final
  162755. ** argument to sqlite3ValueSetStr() and have the copy created
  162756. ** automatically. But doing so makes it difficult to detect any OOM
  162757. ** error. Hence the code to create the copy externally. */
  162758. u8 *aCopy = sqlite3_malloc(nData+1);
  162759. if( aCopy==0 ) return SQLITE_NOMEM;
  162760. memcpy(aCopy, aData, nData);
  162761. sqlite3ValueSetStr(pVal, nData, (char*)aCopy, enc, sqlite3_free);
  162762. return SQLITE_OK;
  162763. }
  162764. /*
  162765. ** Deserialize a single record from a buffer in memory. See "RECORD FORMAT"
  162766. ** for details.
  162767. **
  162768. ** When this function is called, *paChange points to the start of the record
  162769. ** to deserialize. Assuming no error occurs, *paChange is set to point to
  162770. ** one byte after the end of the same record before this function returns.
  162771. ** If the argument abPK is NULL, then the record contains nCol values. Or,
  162772. ** if abPK is other than NULL, then the record contains only the PK fields
  162773. ** (in other words, it is a patchset DELETE record).
  162774. **
  162775. ** If successful, each element of the apOut[] array (allocated by the caller)
  162776. ** is set to point to an sqlite3_value object containing the value read
  162777. ** from the corresponding position in the record. If that value is not
  162778. ** included in the record (i.e. because the record is part of an UPDATE change
  162779. ** and the field was not modified), the corresponding element of apOut[] is
  162780. ** set to NULL.
  162781. **
  162782. ** It is the responsibility of the caller to free all sqlite_value structures
  162783. ** using sqlite3_free().
  162784. **
  162785. ** If an error occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
  162786. ** The apOut[] array may have been partially populated in this case.
  162787. */
  162788. static int sessionReadRecord(
  162789. SessionInput *pIn, /* Input data */
  162790. int nCol, /* Number of values in record */
  162791. u8 *abPK, /* Array of primary key flags, or NULL */
  162792. sqlite3_value **apOut /* Write values to this array */
  162793. ){
  162794. int i; /* Used to iterate through columns */
  162795. int rc = SQLITE_OK;
  162796. for(i=0; i<nCol && rc==SQLITE_OK; i++){
  162797. int eType = 0; /* Type of value (SQLITE_NULL, TEXT etc.) */
  162798. if( abPK && abPK[i]==0 ) continue;
  162799. rc = sessionInputBuffer(pIn, 9);
  162800. if( rc==SQLITE_OK ){
  162801. eType = pIn->aData[pIn->iNext++];
  162802. }
  162803. assert( apOut[i]==0 );
  162804. if( eType ){
  162805. apOut[i] = sqlite3ValueNew(0);
  162806. if( !apOut[i] ) rc = SQLITE_NOMEM;
  162807. }
  162808. if( rc==SQLITE_OK ){
  162809. u8 *aVal = &pIn->aData[pIn->iNext];
  162810. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  162811. int nByte;
  162812. pIn->iNext += sessionVarintGet(aVal, &nByte);
  162813. rc = sessionInputBuffer(pIn, nByte);
  162814. if( rc==SQLITE_OK ){
  162815. u8 enc = (eType==SQLITE_TEXT ? SQLITE_UTF8 : 0);
  162816. rc = sessionValueSetStr(apOut[i],&pIn->aData[pIn->iNext],nByte,enc);
  162817. }
  162818. pIn->iNext += nByte;
  162819. }
  162820. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  162821. sqlite3_int64 v = sessionGetI64(aVal);
  162822. if( eType==SQLITE_INTEGER ){
  162823. sqlite3VdbeMemSetInt64(apOut[i], v);
  162824. }else{
  162825. double d;
  162826. memcpy(&d, &v, 8);
  162827. sqlite3VdbeMemSetDouble(apOut[i], d);
  162828. }
  162829. pIn->iNext += 8;
  162830. }
  162831. }
  162832. }
  162833. return rc;
  162834. }
  162835. /*
  162836. ** The input pointer currently points to the second byte of a table-header.
  162837. ** Specifically, to the following:
  162838. **
  162839. ** + number of columns in table (varint)
  162840. ** + array of PK flags (1 byte per column),
  162841. ** + table name (nul terminated).
  162842. **
  162843. ** This function ensures that all of the above is present in the input
  162844. ** buffer (i.e. that it can be accessed without any calls to xInput()).
  162845. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  162846. ** The input pointer is not moved.
  162847. */
  162848. static int sessionChangesetBufferTblhdr(SessionInput *pIn, int *pnByte){
  162849. int rc = SQLITE_OK;
  162850. int nCol = 0;
  162851. int nRead = 0;
  162852. rc = sessionInputBuffer(pIn, 9);
  162853. if( rc==SQLITE_OK ){
  162854. nRead += sessionVarintGet(&pIn->aData[pIn->iNext + nRead], &nCol);
  162855. rc = sessionInputBuffer(pIn, nRead+nCol+100);
  162856. nRead += nCol;
  162857. }
  162858. while( rc==SQLITE_OK ){
  162859. while( (pIn->iNext + nRead)<pIn->nData && pIn->aData[pIn->iNext + nRead] ){
  162860. nRead++;
  162861. }
  162862. if( (pIn->iNext + nRead)<pIn->nData ) break;
  162863. rc = sessionInputBuffer(pIn, nRead + 100);
  162864. }
  162865. *pnByte = nRead+1;
  162866. return rc;
  162867. }
  162868. /*
  162869. ** The input pointer currently points to the first byte of the first field
  162870. ** of a record consisting of nCol columns. This function ensures the entire
  162871. ** record is buffered. It does not move the input pointer.
  162872. **
  162873. ** If successful, SQLITE_OK is returned and *pnByte is set to the size of
  162874. ** the record in bytes. Otherwise, an SQLite error code is returned. The
  162875. ** final value of *pnByte is undefined in this case.
  162876. */
  162877. static int sessionChangesetBufferRecord(
  162878. SessionInput *pIn, /* Input data */
  162879. int nCol, /* Number of columns in record */
  162880. int *pnByte /* OUT: Size of record in bytes */
  162881. ){
  162882. int rc = SQLITE_OK;
  162883. int nByte = 0;
  162884. int i;
  162885. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  162886. int eType;
  162887. rc = sessionInputBuffer(pIn, nByte + 10);
  162888. if( rc==SQLITE_OK ){
  162889. eType = pIn->aData[pIn->iNext + nByte++];
  162890. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  162891. int n;
  162892. nByte += sessionVarintGet(&pIn->aData[pIn->iNext+nByte], &n);
  162893. nByte += n;
  162894. rc = sessionInputBuffer(pIn, nByte);
  162895. }else if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  162896. nByte += 8;
  162897. }
  162898. }
  162899. }
  162900. *pnByte = nByte;
  162901. return rc;
  162902. }
  162903. /*
  162904. ** The input pointer currently points to the second byte of a table-header.
  162905. ** Specifically, to the following:
  162906. **
  162907. ** + number of columns in table (varint)
  162908. ** + array of PK flags (1 byte per column),
  162909. ** + table name (nul terminated).
  162910. **
  162911. ** This function decodes the table-header and populates the p->nCol,
  162912. ** p->zTab and p->abPK[] variables accordingly. The p->apValue[] array is
  162913. ** also allocated or resized according to the new value of p->nCol. The
  162914. ** input pointer is left pointing to the byte following the table header.
  162915. **
  162916. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code
  162917. ** is returned and the final values of the various fields enumerated above
  162918. ** are undefined.
  162919. */
  162920. static int sessionChangesetReadTblhdr(sqlite3_changeset_iter *p){
  162921. int rc;
  162922. int nCopy;
  162923. assert( p->rc==SQLITE_OK );
  162924. rc = sessionChangesetBufferTblhdr(&p->in, &nCopy);
  162925. if( rc==SQLITE_OK ){
  162926. int nByte;
  162927. int nVarint;
  162928. nVarint = sessionVarintGet(&p->in.aData[p->in.iNext], &p->nCol);
  162929. nCopy -= nVarint;
  162930. p->in.iNext += nVarint;
  162931. nByte = p->nCol * sizeof(sqlite3_value*) * 2 + nCopy;
  162932. p->tblhdr.nBuf = 0;
  162933. sessionBufferGrow(&p->tblhdr, nByte, &rc);
  162934. }
  162935. if( rc==SQLITE_OK ){
  162936. int iPK = sizeof(sqlite3_value*)*p->nCol*2;
  162937. memset(p->tblhdr.aBuf, 0, iPK);
  162938. memcpy(&p->tblhdr.aBuf[iPK], &p->in.aData[p->in.iNext], nCopy);
  162939. p->in.iNext += nCopy;
  162940. }
  162941. p->apValue = (sqlite3_value**)p->tblhdr.aBuf;
  162942. p->abPK = (u8*)&p->apValue[p->nCol*2];
  162943. p->zTab = (char*)&p->abPK[p->nCol];
  162944. return (p->rc = rc);
  162945. }
  162946. /*
  162947. ** Advance the changeset iterator to the next change.
  162948. **
  162949. ** If both paRec and pnRec are NULL, then this function works like the public
  162950. ** API sqlite3changeset_next(). If SQLITE_ROW is returned, then the
  162951. ** sqlite3changeset_new() and old() APIs may be used to query for values.
  162952. **
  162953. ** Otherwise, if paRec and pnRec are not NULL, then a pointer to the change
  162954. ** record is written to *paRec before returning and the number of bytes in
  162955. ** the record to *pnRec.
  162956. **
  162957. ** Either way, this function returns SQLITE_ROW if the iterator is
  162958. ** successfully advanced to the next change in the changeset, an SQLite
  162959. ** error code if an error occurs, or SQLITE_DONE if there are no further
  162960. ** changes in the changeset.
  162961. */
  162962. static int sessionChangesetNext(
  162963. sqlite3_changeset_iter *p, /* Changeset iterator */
  162964. u8 **paRec, /* If non-NULL, store record pointer here */
  162965. int *pnRec /* If non-NULL, store size of record here */
  162966. ){
  162967. int i;
  162968. u8 op;
  162969. assert( (paRec==0 && pnRec==0) || (paRec && pnRec) );
  162970. /* If the iterator is in the error-state, return immediately. */
  162971. if( p->rc!=SQLITE_OK ) return p->rc;
  162972. /* Free the current contents of p->apValue[], if any. */
  162973. if( p->apValue ){
  162974. for(i=0; i<p->nCol*2; i++){
  162975. sqlite3ValueFree(p->apValue[i]);
  162976. }
  162977. memset(p->apValue, 0, sizeof(sqlite3_value*)*p->nCol*2);
  162978. }
  162979. /* Make sure the buffer contains at least 10 bytes of input data, or all
  162980. ** remaining data if there are less than 10 bytes available. This is
  162981. ** sufficient either for the 'T' or 'P' byte and the varint that follows
  162982. ** it, or for the two single byte values otherwise. */
  162983. p->rc = sessionInputBuffer(&p->in, 2);
  162984. if( p->rc!=SQLITE_OK ) return p->rc;
  162985. /* If the iterator is already at the end of the changeset, return DONE. */
  162986. if( p->in.iNext>=p->in.nData ){
  162987. return SQLITE_DONE;
  162988. }
  162989. sessionDiscardData(&p->in);
  162990. p->in.iCurrent = p->in.iNext;
  162991. op = p->in.aData[p->in.iNext++];
  162992. if( op=='T' || op=='P' ){
  162993. p->bPatchset = (op=='P');
  162994. if( sessionChangesetReadTblhdr(p) ) return p->rc;
  162995. if( (p->rc = sessionInputBuffer(&p->in, 2)) ) return p->rc;
  162996. p->in.iCurrent = p->in.iNext;
  162997. op = p->in.aData[p->in.iNext++];
  162998. }
  162999. p->op = op;
  163000. p->bIndirect = p->in.aData[p->in.iNext++];
  163001. if( p->op!=SQLITE_UPDATE && p->op!=SQLITE_DELETE && p->op!=SQLITE_INSERT ){
  163002. return (p->rc = SQLITE_CORRUPT_BKPT);
  163003. }
  163004. if( paRec ){
  163005. int nVal; /* Number of values to buffer */
  163006. if( p->bPatchset==0 && op==SQLITE_UPDATE ){
  163007. nVal = p->nCol * 2;
  163008. }else if( p->bPatchset && op==SQLITE_DELETE ){
  163009. nVal = 0;
  163010. for(i=0; i<p->nCol; i++) if( p->abPK[i] ) nVal++;
  163011. }else{
  163012. nVal = p->nCol;
  163013. }
  163014. p->rc = sessionChangesetBufferRecord(&p->in, nVal, pnRec);
  163015. if( p->rc!=SQLITE_OK ) return p->rc;
  163016. *paRec = &p->in.aData[p->in.iNext];
  163017. p->in.iNext += *pnRec;
  163018. }else{
  163019. /* If this is an UPDATE or DELETE, read the old.* record. */
  163020. if( p->op!=SQLITE_INSERT && (p->bPatchset==0 || p->op==SQLITE_DELETE) ){
  163021. u8 *abPK = p->bPatchset ? p->abPK : 0;
  163022. p->rc = sessionReadRecord(&p->in, p->nCol, abPK, p->apValue);
  163023. if( p->rc!=SQLITE_OK ) return p->rc;
  163024. }
  163025. /* If this is an INSERT or UPDATE, read the new.* record. */
  163026. if( p->op!=SQLITE_DELETE ){
  163027. p->rc = sessionReadRecord(&p->in, p->nCol, 0, &p->apValue[p->nCol]);
  163028. if( p->rc!=SQLITE_OK ) return p->rc;
  163029. }
  163030. if( p->bPatchset && p->op==SQLITE_UPDATE ){
  163031. /* If this is an UPDATE that is part of a patchset, then all PK and
  163032. ** modified fields are present in the new.* record. The old.* record
  163033. ** is currently completely empty. This block shifts the PK fields from
  163034. ** new.* to old.*, to accommodate the code that reads these arrays. */
  163035. for(i=0; i<p->nCol; i++){
  163036. assert( p->apValue[i]==0 );
  163037. assert( p->abPK[i]==0 || p->apValue[i+p->nCol] );
  163038. if( p->abPK[i] ){
  163039. p->apValue[i] = p->apValue[i+p->nCol];
  163040. p->apValue[i+p->nCol] = 0;
  163041. }
  163042. }
  163043. }
  163044. }
  163045. return SQLITE_ROW;
  163046. }
  163047. /*
  163048. ** Advance an iterator created by sqlite3changeset_start() to the next
  163049. ** change in the changeset. This function may return SQLITE_ROW, SQLITE_DONE
  163050. ** or SQLITE_CORRUPT.
  163051. **
  163052. ** This function may not be called on iterators passed to a conflict handler
  163053. ** callback by changeset_apply().
  163054. */
  163055. SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *p){
  163056. return sessionChangesetNext(p, 0, 0);
  163057. }
  163058. /*
  163059. ** The following function extracts information on the current change
  163060. ** from a changeset iterator. It may only be called after changeset_next()
  163061. ** has returned SQLITE_ROW.
  163062. */
  163063. SQLITE_API int sqlite3changeset_op(
  163064. sqlite3_changeset_iter *pIter, /* Iterator handle */
  163065. const char **pzTab, /* OUT: Pointer to table name */
  163066. int *pnCol, /* OUT: Number of columns in table */
  163067. int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
  163068. int *pbIndirect /* OUT: True if change is indirect */
  163069. ){
  163070. *pOp = pIter->op;
  163071. *pnCol = pIter->nCol;
  163072. *pzTab = pIter->zTab;
  163073. if( pbIndirect ) *pbIndirect = pIter->bIndirect;
  163074. return SQLITE_OK;
  163075. }
  163076. /*
  163077. ** Return information regarding the PRIMARY KEY and number of columns in
  163078. ** the database table affected by the change that pIter currently points
  163079. ** to. This function may only be called after changeset_next() returns
  163080. ** SQLITE_ROW.
  163081. */
  163082. SQLITE_API int sqlite3changeset_pk(
  163083. sqlite3_changeset_iter *pIter, /* Iterator object */
  163084. unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
  163085. int *pnCol /* OUT: Number of entries in output array */
  163086. ){
  163087. *pabPK = pIter->abPK;
  163088. if( pnCol ) *pnCol = pIter->nCol;
  163089. return SQLITE_OK;
  163090. }
  163091. /*
  163092. ** This function may only be called while the iterator is pointing to an
  163093. ** SQLITE_UPDATE or SQLITE_DELETE change (see sqlite3changeset_op()).
  163094. ** Otherwise, SQLITE_MISUSE is returned.
  163095. **
  163096. ** It sets *ppValue to point to an sqlite3_value structure containing the
  163097. ** iVal'th value in the old.* record. Or, if that particular value is not
  163098. ** included in the record (because the change is an UPDATE and the field
  163099. ** was not modified and is not a PK column), set *ppValue to NULL.
  163100. **
  163101. ** If value iVal is out-of-range, SQLITE_RANGE is returned and *ppValue is
  163102. ** not modified. Otherwise, SQLITE_OK.
  163103. */
  163104. SQLITE_API int sqlite3changeset_old(
  163105. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163106. int iVal, /* Index of old.* value to retrieve */
  163107. sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
  163108. ){
  163109. if( pIter->op!=SQLITE_UPDATE && pIter->op!=SQLITE_DELETE ){
  163110. return SQLITE_MISUSE;
  163111. }
  163112. if( iVal<0 || iVal>=pIter->nCol ){
  163113. return SQLITE_RANGE;
  163114. }
  163115. *ppValue = pIter->apValue[iVal];
  163116. return SQLITE_OK;
  163117. }
  163118. /*
  163119. ** This function may only be called while the iterator is pointing to an
  163120. ** SQLITE_UPDATE or SQLITE_INSERT change (see sqlite3changeset_op()).
  163121. ** Otherwise, SQLITE_MISUSE is returned.
  163122. **
  163123. ** It sets *ppValue to point to an sqlite3_value structure containing the
  163124. ** iVal'th value in the new.* record. Or, if that particular value is not
  163125. ** included in the record (because the change is an UPDATE and the field
  163126. ** was not modified), set *ppValue to NULL.
  163127. **
  163128. ** If value iVal is out-of-range, SQLITE_RANGE is returned and *ppValue is
  163129. ** not modified. Otherwise, SQLITE_OK.
  163130. */
  163131. SQLITE_API int sqlite3changeset_new(
  163132. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163133. int iVal, /* Index of new.* value to retrieve */
  163134. sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
  163135. ){
  163136. if( pIter->op!=SQLITE_UPDATE && pIter->op!=SQLITE_INSERT ){
  163137. return SQLITE_MISUSE;
  163138. }
  163139. if( iVal<0 || iVal>=pIter->nCol ){
  163140. return SQLITE_RANGE;
  163141. }
  163142. *ppValue = pIter->apValue[pIter->nCol+iVal];
  163143. return SQLITE_OK;
  163144. }
  163145. /*
  163146. ** The following two macros are used internally. They are similar to the
  163147. ** sqlite3changeset_new() and sqlite3changeset_old() functions, except that
  163148. ** they omit all error checking and return a pointer to the requested value.
  163149. */
  163150. #define sessionChangesetNew(pIter, iVal) (pIter)->apValue[(pIter)->nCol+(iVal)]
  163151. #define sessionChangesetOld(pIter, iVal) (pIter)->apValue[(iVal)]
  163152. /*
  163153. ** This function may only be called with a changeset iterator that has been
  163154. ** passed to an SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT
  163155. ** conflict-handler function. Otherwise, SQLITE_MISUSE is returned.
  163156. **
  163157. ** If successful, *ppValue is set to point to an sqlite3_value structure
  163158. ** containing the iVal'th value of the conflicting record.
  163159. **
  163160. ** If value iVal is out-of-range or some other error occurs, an SQLite error
  163161. ** code is returned. Otherwise, SQLITE_OK.
  163162. */
  163163. SQLITE_API int sqlite3changeset_conflict(
  163164. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163165. int iVal, /* Index of conflict record value to fetch */
  163166. sqlite3_value **ppValue /* OUT: Value from conflicting row */
  163167. ){
  163168. if( !pIter->pConflict ){
  163169. return SQLITE_MISUSE;
  163170. }
  163171. if( iVal<0 || iVal>=sqlite3_column_count(pIter->pConflict) ){
  163172. return SQLITE_RANGE;
  163173. }
  163174. *ppValue = sqlite3_column_value(pIter->pConflict, iVal);
  163175. return SQLITE_OK;
  163176. }
  163177. /*
  163178. ** This function may only be called with an iterator passed to an
  163179. ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
  163180. ** it sets the output variable to the total number of known foreign key
  163181. ** violations in the destination database and returns SQLITE_OK.
  163182. **
  163183. ** In all other cases this function returns SQLITE_MISUSE.
  163184. */
  163185. SQLITE_API int sqlite3changeset_fk_conflicts(
  163186. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163187. int *pnOut /* OUT: Number of FK violations */
  163188. ){
  163189. if( pIter->pConflict || pIter->apValue ){
  163190. return SQLITE_MISUSE;
  163191. }
  163192. *pnOut = pIter->nCol;
  163193. return SQLITE_OK;
  163194. }
  163195. /*
  163196. ** Finalize an iterator allocated with sqlite3changeset_start().
  163197. **
  163198. ** This function may not be called on iterators passed to a conflict handler
  163199. ** callback by changeset_apply().
  163200. */
  163201. SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *p){
  163202. int rc = SQLITE_OK;
  163203. if( p ){
  163204. int i; /* Used to iterate through p->apValue[] */
  163205. rc = p->rc;
  163206. if( p->apValue ){
  163207. for(i=0; i<p->nCol*2; i++) sqlite3ValueFree(p->apValue[i]);
  163208. }
  163209. sqlite3_free(p->tblhdr.aBuf);
  163210. sqlite3_free(p->in.buf.aBuf);
  163211. sqlite3_free(p);
  163212. }
  163213. return rc;
  163214. }
  163215. static int sessionChangesetInvert(
  163216. SessionInput *pInput, /* Input changeset */
  163217. int (*xOutput)(void *pOut, const void *pData, int nData),
  163218. void *pOut,
  163219. int *pnInverted, /* OUT: Number of bytes in output changeset */
  163220. void **ppInverted /* OUT: Inverse of pChangeset */
  163221. ){
  163222. int rc = SQLITE_OK; /* Return value */
  163223. SessionBuffer sOut; /* Output buffer */
  163224. int nCol = 0; /* Number of cols in current table */
  163225. u8 *abPK = 0; /* PK array for current table */
  163226. sqlite3_value **apVal = 0; /* Space for values for UPDATE inversion */
  163227. SessionBuffer sPK = {0, 0, 0}; /* PK array for current table */
  163228. /* Initialize the output buffer */
  163229. memset(&sOut, 0, sizeof(SessionBuffer));
  163230. /* Zero the output variables in case an error occurs. */
  163231. if( ppInverted ){
  163232. *ppInverted = 0;
  163233. *pnInverted = 0;
  163234. }
  163235. while( 1 ){
  163236. u8 eType;
  163237. /* Test for EOF. */
  163238. if( (rc = sessionInputBuffer(pInput, 2)) ) goto finished_invert;
  163239. if( pInput->iNext>=pInput->nData ) break;
  163240. eType = pInput->aData[pInput->iNext];
  163241. switch( eType ){
  163242. case 'T': {
  163243. /* A 'table' record consists of:
  163244. **
  163245. ** * A constant 'T' character,
  163246. ** * Number of columns in said table (a varint),
  163247. ** * An array of nCol bytes (sPK),
  163248. ** * A nul-terminated table name.
  163249. */
  163250. int nByte;
  163251. int nVar;
  163252. pInput->iNext++;
  163253. if( (rc = sessionChangesetBufferTblhdr(pInput, &nByte)) ){
  163254. goto finished_invert;
  163255. }
  163256. nVar = sessionVarintGet(&pInput->aData[pInput->iNext], &nCol);
  163257. sPK.nBuf = 0;
  163258. sessionAppendBlob(&sPK, &pInput->aData[pInput->iNext+nVar], nCol, &rc);
  163259. sessionAppendByte(&sOut, eType, &rc);
  163260. sessionAppendBlob(&sOut, &pInput->aData[pInput->iNext], nByte, &rc);
  163261. if( rc ) goto finished_invert;
  163262. pInput->iNext += nByte;
  163263. sqlite3_free(apVal);
  163264. apVal = 0;
  163265. abPK = sPK.aBuf;
  163266. break;
  163267. }
  163268. case SQLITE_INSERT:
  163269. case SQLITE_DELETE: {
  163270. int nByte;
  163271. int bIndirect = pInput->aData[pInput->iNext+1];
  163272. int eType2 = (eType==SQLITE_DELETE ? SQLITE_INSERT : SQLITE_DELETE);
  163273. pInput->iNext += 2;
  163274. assert( rc==SQLITE_OK );
  163275. rc = sessionChangesetBufferRecord(pInput, nCol, &nByte);
  163276. sessionAppendByte(&sOut, eType2, &rc);
  163277. sessionAppendByte(&sOut, bIndirect, &rc);
  163278. sessionAppendBlob(&sOut, &pInput->aData[pInput->iNext], nByte, &rc);
  163279. pInput->iNext += nByte;
  163280. if( rc ) goto finished_invert;
  163281. break;
  163282. }
  163283. case SQLITE_UPDATE: {
  163284. int iCol;
  163285. if( 0==apVal ){
  163286. apVal = (sqlite3_value **)sqlite3_malloc(sizeof(apVal[0])*nCol*2);
  163287. if( 0==apVal ){
  163288. rc = SQLITE_NOMEM;
  163289. goto finished_invert;
  163290. }
  163291. memset(apVal, 0, sizeof(apVal[0])*nCol*2);
  163292. }
  163293. /* Write the header for the new UPDATE change. Same as the original. */
  163294. sessionAppendByte(&sOut, eType, &rc);
  163295. sessionAppendByte(&sOut, pInput->aData[pInput->iNext+1], &rc);
  163296. /* Read the old.* and new.* records for the update change. */
  163297. pInput->iNext += 2;
  163298. rc = sessionReadRecord(pInput, nCol, 0, &apVal[0]);
  163299. if( rc==SQLITE_OK ){
  163300. rc = sessionReadRecord(pInput, nCol, 0, &apVal[nCol]);
  163301. }
  163302. /* Write the new old.* record. Consists of the PK columns from the
  163303. ** original old.* record, and the other values from the original
  163304. ** new.* record. */
  163305. for(iCol=0; iCol<nCol; iCol++){
  163306. sqlite3_value *pVal = apVal[iCol + (abPK[iCol] ? 0 : nCol)];
  163307. sessionAppendValue(&sOut, pVal, &rc);
  163308. }
  163309. /* Write the new new.* record. Consists of a copy of all values
  163310. ** from the original old.* record, except for the PK columns, which
  163311. ** are set to "undefined". */
  163312. for(iCol=0; iCol<nCol; iCol++){
  163313. sqlite3_value *pVal = (abPK[iCol] ? 0 : apVal[iCol]);
  163314. sessionAppendValue(&sOut, pVal, &rc);
  163315. }
  163316. for(iCol=0; iCol<nCol*2; iCol++){
  163317. sqlite3ValueFree(apVal[iCol]);
  163318. }
  163319. memset(apVal, 0, sizeof(apVal[0])*nCol*2);
  163320. if( rc!=SQLITE_OK ){
  163321. goto finished_invert;
  163322. }
  163323. break;
  163324. }
  163325. default:
  163326. rc = SQLITE_CORRUPT_BKPT;
  163327. goto finished_invert;
  163328. }
  163329. assert( rc==SQLITE_OK );
  163330. if( xOutput && sOut.nBuf>=SESSIONS_STRM_CHUNK_SIZE ){
  163331. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  163332. sOut.nBuf = 0;
  163333. if( rc!=SQLITE_OK ) goto finished_invert;
  163334. }
  163335. }
  163336. assert( rc==SQLITE_OK );
  163337. if( pnInverted ){
  163338. *pnInverted = sOut.nBuf;
  163339. *ppInverted = sOut.aBuf;
  163340. sOut.aBuf = 0;
  163341. }else if( sOut.nBuf>0 ){
  163342. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  163343. }
  163344. finished_invert:
  163345. sqlite3_free(sOut.aBuf);
  163346. sqlite3_free(apVal);
  163347. sqlite3_free(sPK.aBuf);
  163348. return rc;
  163349. }
  163350. /*
  163351. ** Invert a changeset object.
  163352. */
  163353. SQLITE_API int sqlite3changeset_invert(
  163354. int nChangeset, /* Number of bytes in input */
  163355. const void *pChangeset, /* Input changeset */
  163356. int *pnInverted, /* OUT: Number of bytes in output changeset */
  163357. void **ppInverted /* OUT: Inverse of pChangeset */
  163358. ){
  163359. SessionInput sInput;
  163360. /* Set up the input stream */
  163361. memset(&sInput, 0, sizeof(SessionInput));
  163362. sInput.nData = nChangeset;
  163363. sInput.aData = (u8*)pChangeset;
  163364. return sessionChangesetInvert(&sInput, 0, 0, pnInverted, ppInverted);
  163365. }
  163366. /*
  163367. ** Streaming version of sqlite3changeset_invert().
  163368. */
  163369. SQLITE_API int sqlite3changeset_invert_strm(
  163370. int (*xInput)(void *pIn, void *pData, int *pnData),
  163371. void *pIn,
  163372. int (*xOutput)(void *pOut, const void *pData, int nData),
  163373. void *pOut
  163374. ){
  163375. SessionInput sInput;
  163376. int rc;
  163377. /* Set up the input stream */
  163378. memset(&sInput, 0, sizeof(SessionInput));
  163379. sInput.xInput = xInput;
  163380. sInput.pIn = pIn;
  163381. rc = sessionChangesetInvert(&sInput, xOutput, pOut, 0, 0);
  163382. sqlite3_free(sInput.buf.aBuf);
  163383. return rc;
  163384. }
  163385. typedef struct SessionApplyCtx SessionApplyCtx;
  163386. struct SessionApplyCtx {
  163387. sqlite3 *db;
  163388. sqlite3_stmt *pDelete; /* DELETE statement */
  163389. sqlite3_stmt *pUpdate; /* UPDATE statement */
  163390. sqlite3_stmt *pInsert; /* INSERT statement */
  163391. sqlite3_stmt *pSelect; /* SELECT statement */
  163392. int nCol; /* Size of azCol[] and abPK[] arrays */
  163393. const char **azCol; /* Array of column names */
  163394. u8 *abPK; /* Boolean array - true if column is in PK */
  163395. int bDeferConstraints; /* True to defer constraints */
  163396. SessionBuffer constraints; /* Deferred constraints are stored here */
  163397. };
  163398. /*
  163399. ** Formulate a statement to DELETE a row from database db. Assuming a table
  163400. ** structure like this:
  163401. **
  163402. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  163403. **
  163404. ** The DELETE statement looks like this:
  163405. **
  163406. ** DELETE FROM x WHERE a = :1 AND c = :3 AND (:5 OR b IS :2 AND d IS :4)
  163407. **
  163408. ** Variable :5 (nCol+1) is a boolean. It should be set to 0 if we require
  163409. ** matching b and d values, or 1 otherwise. The second case comes up if the
  163410. ** conflict handler is invoked with NOTFOUND and returns CHANGESET_REPLACE.
  163411. **
  163412. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pDelete is left
  163413. ** pointing to the prepared version of the SQL statement.
  163414. */
  163415. static int sessionDeleteRow(
  163416. sqlite3 *db, /* Database handle */
  163417. const char *zTab, /* Table name */
  163418. SessionApplyCtx *p /* Session changeset-apply context */
  163419. ){
  163420. int i;
  163421. const char *zSep = "";
  163422. int rc = SQLITE_OK;
  163423. SessionBuffer buf = {0, 0, 0};
  163424. int nPk = 0;
  163425. sessionAppendStr(&buf, "DELETE FROM ", &rc);
  163426. sessionAppendIdent(&buf, zTab, &rc);
  163427. sessionAppendStr(&buf, " WHERE ", &rc);
  163428. for(i=0; i<p->nCol; i++){
  163429. if( p->abPK[i] ){
  163430. nPk++;
  163431. sessionAppendStr(&buf, zSep, &rc);
  163432. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163433. sessionAppendStr(&buf, " = ?", &rc);
  163434. sessionAppendInteger(&buf, i+1, &rc);
  163435. zSep = " AND ";
  163436. }
  163437. }
  163438. if( nPk<p->nCol ){
  163439. sessionAppendStr(&buf, " AND (?", &rc);
  163440. sessionAppendInteger(&buf, p->nCol+1, &rc);
  163441. sessionAppendStr(&buf, " OR ", &rc);
  163442. zSep = "";
  163443. for(i=0; i<p->nCol; i++){
  163444. if( !p->abPK[i] ){
  163445. sessionAppendStr(&buf, zSep, &rc);
  163446. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163447. sessionAppendStr(&buf, " IS ?", &rc);
  163448. sessionAppendInteger(&buf, i+1, &rc);
  163449. zSep = "AND ";
  163450. }
  163451. }
  163452. sessionAppendStr(&buf, ")", &rc);
  163453. }
  163454. if( rc==SQLITE_OK ){
  163455. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pDelete, 0);
  163456. }
  163457. sqlite3_free(buf.aBuf);
  163458. return rc;
  163459. }
  163460. /*
  163461. ** Formulate and prepare a statement to UPDATE a row from database db.
  163462. ** Assuming a table structure like this:
  163463. **
  163464. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  163465. **
  163466. ** The UPDATE statement looks like this:
  163467. **
  163468. ** UPDATE x SET
  163469. ** a = CASE WHEN ?2 THEN ?3 ELSE a END,
  163470. ** b = CASE WHEN ?5 THEN ?6 ELSE b END,
  163471. ** c = CASE WHEN ?8 THEN ?9 ELSE c END,
  163472. ** d = CASE WHEN ?11 THEN ?12 ELSE d END
  163473. ** WHERE a = ?1 AND c = ?7 AND (?13 OR
  163474. ** (?5==0 OR b IS ?4) AND (?11==0 OR d IS ?10) AND
  163475. ** )
  163476. **
  163477. ** For each column in the table, there are three variables to bind:
  163478. **
  163479. ** ?(i*3+1) The old.* value of the column, if any.
  163480. ** ?(i*3+2) A boolean flag indicating that the value is being modified.
  163481. ** ?(i*3+3) The new.* value of the column, if any.
  163482. **
  163483. ** Also, a boolean flag that, if set to true, causes the statement to update
  163484. ** a row even if the non-PK values do not match. This is required if the
  163485. ** conflict-handler is invoked with CHANGESET_DATA and returns
  163486. ** CHANGESET_REPLACE. This is variable "?(nCol*3+1)".
  163487. **
  163488. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pUpdate is left
  163489. ** pointing to the prepared version of the SQL statement.
  163490. */
  163491. static int sessionUpdateRow(
  163492. sqlite3 *db, /* Database handle */
  163493. const char *zTab, /* Table name */
  163494. SessionApplyCtx *p /* Session changeset-apply context */
  163495. ){
  163496. int rc = SQLITE_OK;
  163497. int i;
  163498. const char *zSep = "";
  163499. SessionBuffer buf = {0, 0, 0};
  163500. /* Append "UPDATE tbl SET " */
  163501. sessionAppendStr(&buf, "UPDATE ", &rc);
  163502. sessionAppendIdent(&buf, zTab, &rc);
  163503. sessionAppendStr(&buf, " SET ", &rc);
  163504. /* Append the assignments */
  163505. for(i=0; i<p->nCol; i++){
  163506. sessionAppendStr(&buf, zSep, &rc);
  163507. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163508. sessionAppendStr(&buf, " = CASE WHEN ?", &rc);
  163509. sessionAppendInteger(&buf, i*3+2, &rc);
  163510. sessionAppendStr(&buf, " THEN ?", &rc);
  163511. sessionAppendInteger(&buf, i*3+3, &rc);
  163512. sessionAppendStr(&buf, " ELSE ", &rc);
  163513. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163514. sessionAppendStr(&buf, " END", &rc);
  163515. zSep = ", ";
  163516. }
  163517. /* Append the PK part of the WHERE clause */
  163518. sessionAppendStr(&buf, " WHERE ", &rc);
  163519. for(i=0; i<p->nCol; i++){
  163520. if( p->abPK[i] ){
  163521. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163522. sessionAppendStr(&buf, " = ?", &rc);
  163523. sessionAppendInteger(&buf, i*3+1, &rc);
  163524. sessionAppendStr(&buf, " AND ", &rc);
  163525. }
  163526. }
  163527. /* Append the non-PK part of the WHERE clause */
  163528. sessionAppendStr(&buf, " (?", &rc);
  163529. sessionAppendInteger(&buf, p->nCol*3+1, &rc);
  163530. sessionAppendStr(&buf, " OR 1", &rc);
  163531. for(i=0; i<p->nCol; i++){
  163532. if( !p->abPK[i] ){
  163533. sessionAppendStr(&buf, " AND (?", &rc);
  163534. sessionAppendInteger(&buf, i*3+2, &rc);
  163535. sessionAppendStr(&buf, "=0 OR ", &rc);
  163536. sessionAppendIdent(&buf, p->azCol[i], &rc);
  163537. sessionAppendStr(&buf, " IS ?", &rc);
  163538. sessionAppendInteger(&buf, i*3+1, &rc);
  163539. sessionAppendStr(&buf, ")", &rc);
  163540. }
  163541. }
  163542. sessionAppendStr(&buf, ")", &rc);
  163543. if( rc==SQLITE_OK ){
  163544. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pUpdate, 0);
  163545. }
  163546. sqlite3_free(buf.aBuf);
  163547. return rc;
  163548. }
  163549. /*
  163550. ** Formulate and prepare an SQL statement to query table zTab by primary
  163551. ** key. Assuming the following table structure:
  163552. **
  163553. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  163554. **
  163555. ** The SELECT statement looks like this:
  163556. **
  163557. ** SELECT * FROM x WHERE a = ?1 AND c = ?3
  163558. **
  163559. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pSelect is left
  163560. ** pointing to the prepared version of the SQL statement.
  163561. */
  163562. static int sessionSelectRow(
  163563. sqlite3 *db, /* Database handle */
  163564. const char *zTab, /* Table name */
  163565. SessionApplyCtx *p /* Session changeset-apply context */
  163566. ){
  163567. return sessionSelectStmt(
  163568. db, "main", zTab, p->nCol, p->azCol, p->abPK, &p->pSelect);
  163569. }
  163570. /*
  163571. ** Formulate and prepare an INSERT statement to add a record to table zTab.
  163572. ** For example:
  163573. **
  163574. ** INSERT INTO main."zTab" VALUES(?1, ?2, ?3 ...);
  163575. **
  163576. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pInsert is left
  163577. ** pointing to the prepared version of the SQL statement.
  163578. */
  163579. static int sessionInsertRow(
  163580. sqlite3 *db, /* Database handle */
  163581. const char *zTab, /* Table name */
  163582. SessionApplyCtx *p /* Session changeset-apply context */
  163583. ){
  163584. int rc = SQLITE_OK;
  163585. int i;
  163586. SessionBuffer buf = {0, 0, 0};
  163587. sessionAppendStr(&buf, "INSERT INTO main.", &rc);
  163588. sessionAppendIdent(&buf, zTab, &rc);
  163589. sessionAppendStr(&buf, " VALUES(?", &rc);
  163590. for(i=1; i<p->nCol; i++){
  163591. sessionAppendStr(&buf, ", ?", &rc);
  163592. }
  163593. sessionAppendStr(&buf, ")", &rc);
  163594. if( rc==SQLITE_OK ){
  163595. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pInsert, 0);
  163596. }
  163597. sqlite3_free(buf.aBuf);
  163598. return rc;
  163599. }
  163600. /*
  163601. ** A wrapper around sqlite3_bind_value() that detects an extra problem.
  163602. ** See comments in the body of this function for details.
  163603. */
  163604. static int sessionBindValue(
  163605. sqlite3_stmt *pStmt, /* Statement to bind value to */
  163606. int i, /* Parameter number to bind to */
  163607. sqlite3_value *pVal /* Value to bind */
  163608. ){
  163609. int eType = sqlite3_value_type(pVal);
  163610. /* COVERAGE: The (pVal->z==0) branch is never true using current versions
  163611. ** of SQLite. If a malloc fails in an sqlite3_value_xxx() function, either
  163612. ** the (pVal->z) variable remains as it was or the type of the value is
  163613. ** set to SQLITE_NULL. */
  163614. if( (eType==SQLITE_TEXT || eType==SQLITE_BLOB) && pVal->z==0 ){
  163615. /* This condition occurs when an earlier OOM in a call to
  163616. ** sqlite3_value_text() or sqlite3_value_blob() (perhaps from within
  163617. ** a conflict-handler) has zeroed the pVal->z pointer. Return NOMEM. */
  163618. return SQLITE_NOMEM;
  163619. }
  163620. return sqlite3_bind_value(pStmt, i, pVal);
  163621. }
  163622. /*
  163623. ** Iterator pIter must point to an SQLITE_INSERT entry. This function
  163624. ** transfers new.* values from the current iterator entry to statement
  163625. ** pStmt. The table being inserted into has nCol columns.
  163626. **
  163627. ** New.* value $i from the iterator is bound to variable ($i+1) of
  163628. ** statement pStmt. If parameter abPK is NULL, all values from 0 to (nCol-1)
  163629. ** are transfered to the statement. Otherwise, if abPK is not NULL, it points
  163630. ** to an array nCol elements in size. In this case only those values for
  163631. ** which abPK[$i] is true are read from the iterator and bound to the
  163632. ** statement.
  163633. **
  163634. ** An SQLite error code is returned if an error occurs. Otherwise, SQLITE_OK.
  163635. */
  163636. static int sessionBindRow(
  163637. sqlite3_changeset_iter *pIter, /* Iterator to read values from */
  163638. int(*xValue)(sqlite3_changeset_iter *, int, sqlite3_value **),
  163639. int nCol, /* Number of columns */
  163640. u8 *abPK, /* If not NULL, bind only if true */
  163641. sqlite3_stmt *pStmt /* Bind values to this statement */
  163642. ){
  163643. int i;
  163644. int rc = SQLITE_OK;
  163645. /* Neither sqlite3changeset_old or sqlite3changeset_new can fail if the
  163646. ** argument iterator points to a suitable entry. Make sure that xValue
  163647. ** is one of these to guarantee that it is safe to ignore the return
  163648. ** in the code below. */
  163649. assert( xValue==sqlite3changeset_old || xValue==sqlite3changeset_new );
  163650. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  163651. if( !abPK || abPK[i] ){
  163652. sqlite3_value *pVal;
  163653. (void)xValue(pIter, i, &pVal);
  163654. rc = sessionBindValue(pStmt, i+1, pVal);
  163655. }
  163656. }
  163657. return rc;
  163658. }
  163659. /*
  163660. ** SQL statement pSelect is as generated by the sessionSelectRow() function.
  163661. ** This function binds the primary key values from the change that changeset
  163662. ** iterator pIter points to to the SELECT and attempts to seek to the table
  163663. ** entry. If a row is found, the SELECT statement left pointing at the row
  163664. ** and SQLITE_ROW is returned. Otherwise, if no row is found and no error
  163665. ** has occured, the statement is reset and SQLITE_OK is returned. If an
  163666. ** error occurs, the statement is reset and an SQLite error code is returned.
  163667. **
  163668. ** If this function returns SQLITE_ROW, the caller must eventually reset()
  163669. ** statement pSelect. If any other value is returned, the statement does
  163670. ** not require a reset().
  163671. **
  163672. ** If the iterator currently points to an INSERT record, bind values from the
  163673. ** new.* record to the SELECT statement. Or, if it points to a DELETE or
  163674. ** UPDATE, bind values from the old.* record.
  163675. */
  163676. static int sessionSeekToRow(
  163677. sqlite3 *db, /* Database handle */
  163678. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163679. u8 *abPK, /* Primary key flags array */
  163680. sqlite3_stmt *pSelect /* SELECT statement from sessionSelectRow() */
  163681. ){
  163682. int rc; /* Return code */
  163683. int nCol; /* Number of columns in table */
  163684. int op; /* Changset operation (SQLITE_UPDATE etc.) */
  163685. const char *zDummy; /* Unused */
  163686. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  163687. rc = sessionBindRow(pIter,
  163688. op==SQLITE_INSERT ? sqlite3changeset_new : sqlite3changeset_old,
  163689. nCol, abPK, pSelect
  163690. );
  163691. if( rc==SQLITE_OK ){
  163692. rc = sqlite3_step(pSelect);
  163693. if( rc!=SQLITE_ROW ) rc = sqlite3_reset(pSelect);
  163694. }
  163695. return rc;
  163696. }
  163697. /*
  163698. ** Invoke the conflict handler for the change that the changeset iterator
  163699. ** currently points to.
  163700. **
  163701. ** Argument eType must be either CHANGESET_DATA or CHANGESET_CONFLICT.
  163702. ** If argument pbReplace is NULL, then the type of conflict handler invoked
  163703. ** depends solely on eType, as follows:
  163704. **
  163705. ** eType value Value passed to xConflict
  163706. ** -------------------------------------------------
  163707. ** CHANGESET_DATA CHANGESET_NOTFOUND
  163708. ** CHANGESET_CONFLICT CHANGESET_CONSTRAINT
  163709. **
  163710. ** Or, if pbReplace is not NULL, then an attempt is made to find an existing
  163711. ** record with the same primary key as the record about to be deleted, updated
  163712. ** or inserted. If such a record can be found, it is available to the conflict
  163713. ** handler as the "conflicting" record. In this case the type of conflict
  163714. ** handler invoked is as follows:
  163715. **
  163716. ** eType value PK Record found? Value passed to xConflict
  163717. ** ----------------------------------------------------------------
  163718. ** CHANGESET_DATA Yes CHANGESET_DATA
  163719. ** CHANGESET_DATA No CHANGESET_NOTFOUND
  163720. ** CHANGESET_CONFLICT Yes CHANGESET_CONFLICT
  163721. ** CHANGESET_CONFLICT No CHANGESET_CONSTRAINT
  163722. **
  163723. ** If pbReplace is not NULL, and a record with a matching PK is found, and
  163724. ** the conflict handler function returns SQLITE_CHANGESET_REPLACE, *pbReplace
  163725. ** is set to non-zero before returning SQLITE_OK.
  163726. **
  163727. ** If the conflict handler returns SQLITE_CHANGESET_ABORT, SQLITE_ABORT is
  163728. ** returned. Or, if the conflict handler returns an invalid value,
  163729. ** SQLITE_MISUSE. If the conflict handler returns SQLITE_CHANGESET_OMIT,
  163730. ** this function returns SQLITE_OK.
  163731. */
  163732. static int sessionConflictHandler(
  163733. int eType, /* Either CHANGESET_DATA or CONFLICT */
  163734. SessionApplyCtx *p, /* changeset_apply() context */
  163735. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163736. int(*xConflict)(void *, int, sqlite3_changeset_iter*),
  163737. void *pCtx, /* First argument for conflict handler */
  163738. int *pbReplace /* OUT: Set to true if PK row is found */
  163739. ){
  163740. int res = 0; /* Value returned by conflict handler */
  163741. int rc;
  163742. int nCol;
  163743. int op;
  163744. const char *zDummy;
  163745. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  163746. assert( eType==SQLITE_CHANGESET_CONFLICT || eType==SQLITE_CHANGESET_DATA );
  163747. assert( SQLITE_CHANGESET_CONFLICT+1==SQLITE_CHANGESET_CONSTRAINT );
  163748. assert( SQLITE_CHANGESET_DATA+1==SQLITE_CHANGESET_NOTFOUND );
  163749. /* Bind the new.* PRIMARY KEY values to the SELECT statement. */
  163750. if( pbReplace ){
  163751. rc = sessionSeekToRow(p->db, pIter, p->abPK, p->pSelect);
  163752. }else{
  163753. rc = SQLITE_OK;
  163754. }
  163755. if( rc==SQLITE_ROW ){
  163756. /* There exists another row with the new.* primary key. */
  163757. pIter->pConflict = p->pSelect;
  163758. res = xConflict(pCtx, eType, pIter);
  163759. pIter->pConflict = 0;
  163760. rc = sqlite3_reset(p->pSelect);
  163761. }else if( rc==SQLITE_OK ){
  163762. if( p->bDeferConstraints && eType==SQLITE_CHANGESET_CONFLICT ){
  163763. /* Instead of invoking the conflict handler, append the change blob
  163764. ** to the SessionApplyCtx.constraints buffer. */
  163765. u8 *aBlob = &pIter->in.aData[pIter->in.iCurrent];
  163766. int nBlob = pIter->in.iNext - pIter->in.iCurrent;
  163767. sessionAppendBlob(&p->constraints, aBlob, nBlob, &rc);
  163768. res = SQLITE_CHANGESET_OMIT;
  163769. }else{
  163770. /* No other row with the new.* primary key. */
  163771. res = xConflict(pCtx, eType+1, pIter);
  163772. if( res==SQLITE_CHANGESET_REPLACE ) rc = SQLITE_MISUSE;
  163773. }
  163774. }
  163775. if( rc==SQLITE_OK ){
  163776. switch( res ){
  163777. case SQLITE_CHANGESET_REPLACE:
  163778. assert( pbReplace );
  163779. *pbReplace = 1;
  163780. break;
  163781. case SQLITE_CHANGESET_OMIT:
  163782. break;
  163783. case SQLITE_CHANGESET_ABORT:
  163784. rc = SQLITE_ABORT;
  163785. break;
  163786. default:
  163787. rc = SQLITE_MISUSE;
  163788. break;
  163789. }
  163790. }
  163791. return rc;
  163792. }
  163793. /*
  163794. ** Attempt to apply the change that the iterator passed as the first argument
  163795. ** currently points to to the database. If a conflict is encountered, invoke
  163796. ** the conflict handler callback.
  163797. **
  163798. ** If argument pbRetry is NULL, then ignore any CHANGESET_DATA conflict. If
  163799. ** one is encountered, update or delete the row with the matching primary key
  163800. ** instead. Or, if pbRetry is not NULL and a CHANGESET_DATA conflict occurs,
  163801. ** invoke the conflict handler. If it returns CHANGESET_REPLACE, set *pbRetry
  163802. ** to true before returning. In this case the caller will invoke this function
  163803. ** again, this time with pbRetry set to NULL.
  163804. **
  163805. ** If argument pbReplace is NULL and a CHANGESET_CONFLICT conflict is
  163806. ** encountered invoke the conflict handler with CHANGESET_CONSTRAINT instead.
  163807. ** Or, if pbReplace is not NULL, invoke it with CHANGESET_CONFLICT. If such
  163808. ** an invocation returns SQLITE_CHANGESET_REPLACE, set *pbReplace to true
  163809. ** before retrying. In this case the caller attempts to remove the conflicting
  163810. ** row before invoking this function again, this time with pbReplace set
  163811. ** to NULL.
  163812. **
  163813. ** If any conflict handler returns SQLITE_CHANGESET_ABORT, this function
  163814. ** returns SQLITE_ABORT. Otherwise, if no error occurs, SQLITE_OK is
  163815. ** returned.
  163816. */
  163817. static int sessionApplyOneOp(
  163818. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  163819. SessionApplyCtx *p, /* changeset_apply() context */
  163820. int(*xConflict)(void *, int, sqlite3_changeset_iter *),
  163821. void *pCtx, /* First argument for the conflict handler */
  163822. int *pbReplace, /* OUT: True to remove PK row and retry */
  163823. int *pbRetry /* OUT: True to retry. */
  163824. ){
  163825. const char *zDummy;
  163826. int op;
  163827. int nCol;
  163828. int rc = SQLITE_OK;
  163829. assert( p->pDelete && p->pUpdate && p->pInsert && p->pSelect );
  163830. assert( p->azCol && p->abPK );
  163831. assert( !pbReplace || *pbReplace==0 );
  163832. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  163833. if( op==SQLITE_DELETE ){
  163834. /* Bind values to the DELETE statement. If conflict handling is required,
  163835. ** bind values for all columns and set bound variable (nCol+1) to true.
  163836. ** Or, if conflict handling is not required, bind just the PK column
  163837. ** values and, if it exists, set (nCol+1) to false. Conflict handling
  163838. ** is not required if:
  163839. **
  163840. ** * this is a patchset, or
  163841. ** * (pbRetry==0), or
  163842. ** * all columns of the table are PK columns (in this case there is
  163843. ** no (nCol+1) variable to bind to).
  163844. */
  163845. u8 *abPK = (pIter->bPatchset ? p->abPK : 0);
  163846. rc = sessionBindRow(pIter, sqlite3changeset_old, nCol, abPK, p->pDelete);
  163847. if( rc==SQLITE_OK && sqlite3_bind_parameter_count(p->pDelete)>nCol ){
  163848. rc = sqlite3_bind_int(p->pDelete, nCol+1, (pbRetry==0 || abPK));
  163849. }
  163850. if( rc!=SQLITE_OK ) return rc;
  163851. sqlite3_step(p->pDelete);
  163852. rc = sqlite3_reset(p->pDelete);
  163853. if( rc==SQLITE_OK && sqlite3_changes(p->db)==0 ){
  163854. rc = sessionConflictHandler(
  163855. SQLITE_CHANGESET_DATA, p, pIter, xConflict, pCtx, pbRetry
  163856. );
  163857. }else if( (rc&0xff)==SQLITE_CONSTRAINT ){
  163858. rc = sessionConflictHandler(
  163859. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, 0
  163860. );
  163861. }
  163862. }else if( op==SQLITE_UPDATE ){
  163863. int i;
  163864. /* Bind values to the UPDATE statement. */
  163865. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  163866. sqlite3_value *pOld = sessionChangesetOld(pIter, i);
  163867. sqlite3_value *pNew = sessionChangesetNew(pIter, i);
  163868. sqlite3_bind_int(p->pUpdate, i*3+2, !!pNew);
  163869. if( pOld ){
  163870. rc = sessionBindValue(p->pUpdate, i*3+1, pOld);
  163871. }
  163872. if( rc==SQLITE_OK && pNew ){
  163873. rc = sessionBindValue(p->pUpdate, i*3+3, pNew);
  163874. }
  163875. }
  163876. if( rc==SQLITE_OK ){
  163877. sqlite3_bind_int(p->pUpdate, nCol*3+1, pbRetry==0 || pIter->bPatchset);
  163878. }
  163879. if( rc!=SQLITE_OK ) return rc;
  163880. /* Attempt the UPDATE. In the case of a NOTFOUND or DATA conflict,
  163881. ** the result will be SQLITE_OK with 0 rows modified. */
  163882. sqlite3_step(p->pUpdate);
  163883. rc = sqlite3_reset(p->pUpdate);
  163884. if( rc==SQLITE_OK && sqlite3_changes(p->db)==0 ){
  163885. /* A NOTFOUND or DATA error. Search the table to see if it contains
  163886. ** a row with a matching primary key. If so, this is a DATA conflict.
  163887. ** Otherwise, if there is no primary key match, it is a NOTFOUND. */
  163888. rc = sessionConflictHandler(
  163889. SQLITE_CHANGESET_DATA, p, pIter, xConflict, pCtx, pbRetry
  163890. );
  163891. }else if( (rc&0xff)==SQLITE_CONSTRAINT ){
  163892. /* This is always a CONSTRAINT conflict. */
  163893. rc = sessionConflictHandler(
  163894. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, 0
  163895. );
  163896. }
  163897. }else{
  163898. assert( op==SQLITE_INSERT );
  163899. rc = sessionBindRow(pIter, sqlite3changeset_new, nCol, 0, p->pInsert);
  163900. if( rc!=SQLITE_OK ) return rc;
  163901. sqlite3_step(p->pInsert);
  163902. rc = sqlite3_reset(p->pInsert);
  163903. if( (rc&0xff)==SQLITE_CONSTRAINT ){
  163904. rc = sessionConflictHandler(
  163905. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, pbReplace
  163906. );
  163907. }
  163908. }
  163909. return rc;
  163910. }
  163911. /*
  163912. ** Attempt to apply the change that the iterator passed as the first argument
  163913. ** currently points to to the database. If a conflict is encountered, invoke
  163914. ** the conflict handler callback.
  163915. **
  163916. ** The difference between this function and sessionApplyOne() is that this
  163917. ** function handles the case where the conflict-handler is invoked and
  163918. ** returns SQLITE_CHANGESET_REPLACE - indicating that the change should be
  163919. ** retried in some manner.
  163920. */
  163921. static int sessionApplyOneWithRetry(
  163922. sqlite3 *db, /* Apply change to "main" db of this handle */
  163923. sqlite3_changeset_iter *pIter, /* Changeset iterator to read change from */
  163924. SessionApplyCtx *pApply, /* Apply context */
  163925. int(*xConflict)(void*, int, sqlite3_changeset_iter*),
  163926. void *pCtx /* First argument passed to xConflict */
  163927. ){
  163928. int bReplace = 0;
  163929. int bRetry = 0;
  163930. int rc;
  163931. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, &bReplace, &bRetry);
  163932. assert( rc==SQLITE_OK || (bRetry==0 && bReplace==0) );
  163933. /* If the bRetry flag is set, the change has not been applied due to an
  163934. ** SQLITE_CHANGESET_DATA problem (i.e. this is an UPDATE or DELETE and
  163935. ** a row with the correct PK is present in the db, but one or more other
  163936. ** fields do not contain the expected values) and the conflict handler
  163937. ** returned SQLITE_CHANGESET_REPLACE. In this case retry the operation,
  163938. ** but pass NULL as the final argument so that sessionApplyOneOp() ignores
  163939. ** the SQLITE_CHANGESET_DATA problem. */
  163940. if( bRetry ){
  163941. assert( pIter->op==SQLITE_UPDATE || pIter->op==SQLITE_DELETE );
  163942. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, 0, 0);
  163943. }
  163944. /* If the bReplace flag is set, the change is an INSERT that has not
  163945. ** been performed because the database already contains a row with the
  163946. ** specified primary key and the conflict handler returned
  163947. ** SQLITE_CHANGESET_REPLACE. In this case remove the conflicting row
  163948. ** before reattempting the INSERT. */
  163949. else if( bReplace ){
  163950. assert( pIter->op==SQLITE_INSERT );
  163951. rc = sqlite3_exec(db, "SAVEPOINT replace_op", 0, 0, 0);
  163952. if( rc==SQLITE_OK ){
  163953. rc = sessionBindRow(pIter,
  163954. sqlite3changeset_new, pApply->nCol, pApply->abPK, pApply->pDelete);
  163955. sqlite3_bind_int(pApply->pDelete, pApply->nCol+1, 1);
  163956. }
  163957. if( rc==SQLITE_OK ){
  163958. sqlite3_step(pApply->pDelete);
  163959. rc = sqlite3_reset(pApply->pDelete);
  163960. }
  163961. if( rc==SQLITE_OK ){
  163962. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, 0, 0);
  163963. }
  163964. if( rc==SQLITE_OK ){
  163965. rc = sqlite3_exec(db, "RELEASE replace_op", 0, 0, 0);
  163966. }
  163967. }
  163968. return rc;
  163969. }
  163970. /*
  163971. ** Retry the changes accumulated in the pApply->constraints buffer.
  163972. */
  163973. static int sessionRetryConstraints(
  163974. sqlite3 *db,
  163975. int bPatchset,
  163976. const char *zTab,
  163977. SessionApplyCtx *pApply,
  163978. int(*xConflict)(void*, int, sqlite3_changeset_iter*),
  163979. void *pCtx /* First argument passed to xConflict */
  163980. ){
  163981. int rc = SQLITE_OK;
  163982. while( pApply->constraints.nBuf ){
  163983. sqlite3_changeset_iter *pIter2 = 0;
  163984. SessionBuffer cons = pApply->constraints;
  163985. memset(&pApply->constraints, 0, sizeof(SessionBuffer));
  163986. rc = sessionChangesetStart(&pIter2, 0, 0, cons.nBuf, cons.aBuf);
  163987. if( rc==SQLITE_OK ){
  163988. int nByte = 2*pApply->nCol*sizeof(sqlite3_value*);
  163989. int rc2;
  163990. pIter2->bPatchset = bPatchset;
  163991. pIter2->zTab = (char*)zTab;
  163992. pIter2->nCol = pApply->nCol;
  163993. pIter2->abPK = pApply->abPK;
  163994. sessionBufferGrow(&pIter2->tblhdr, nByte, &rc);
  163995. pIter2->apValue = (sqlite3_value**)pIter2->tblhdr.aBuf;
  163996. if( rc==SQLITE_OK ) memset(pIter2->apValue, 0, nByte);
  163997. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3changeset_next(pIter2) ){
  163998. rc = sessionApplyOneWithRetry(db, pIter2, pApply, xConflict, pCtx);
  163999. }
  164000. rc2 = sqlite3changeset_finalize(pIter2);
  164001. if( rc==SQLITE_OK ) rc = rc2;
  164002. }
  164003. assert( pApply->bDeferConstraints || pApply->constraints.nBuf==0 );
  164004. sqlite3_free(cons.aBuf);
  164005. if( rc!=SQLITE_OK ) break;
  164006. if( pApply->constraints.nBuf>=cons.nBuf ){
  164007. /* No progress was made on the last round. */
  164008. pApply->bDeferConstraints = 0;
  164009. }
  164010. }
  164011. return rc;
  164012. }
  164013. /*
  164014. ** Argument pIter is a changeset iterator that has been initialized, but
  164015. ** not yet passed to sqlite3changeset_next(). This function applies the
  164016. ** changeset to the main database attached to handle "db". The supplied
  164017. ** conflict handler callback is invoked to resolve any conflicts encountered
  164018. ** while applying the change.
  164019. */
  164020. static int sessionChangesetApply(
  164021. sqlite3 *db, /* Apply change to "main" db of this handle */
  164022. sqlite3_changeset_iter *pIter, /* Changeset to apply */
  164023. int(*xFilter)(
  164024. void *pCtx, /* Copy of sixth arg to _apply() */
  164025. const char *zTab /* Table name */
  164026. ),
  164027. int(*xConflict)(
  164028. void *pCtx, /* Copy of fifth arg to _apply() */
  164029. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  164030. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  164031. ),
  164032. void *pCtx /* First argument passed to xConflict */
  164033. ){
  164034. int schemaMismatch = 0;
  164035. int rc; /* Return code */
  164036. const char *zTab = 0; /* Name of current table */
  164037. int nTab = 0; /* Result of sqlite3Strlen30(zTab) */
  164038. SessionApplyCtx sApply; /* changeset_apply() context object */
  164039. int bPatchset;
  164040. assert( xConflict!=0 );
  164041. pIter->in.bNoDiscard = 1;
  164042. memset(&sApply, 0, sizeof(sApply));
  164043. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  164044. rc = sqlite3_exec(db, "SAVEPOINT changeset_apply", 0, 0, 0);
  164045. if( rc==SQLITE_OK ){
  164046. rc = sqlite3_exec(db, "PRAGMA defer_foreign_keys = 1", 0, 0, 0);
  164047. }
  164048. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3changeset_next(pIter) ){
  164049. int nCol;
  164050. int op;
  164051. const char *zNew;
  164052. sqlite3changeset_op(pIter, &zNew, &nCol, &op, 0);
  164053. if( zTab==0 || sqlite3_strnicmp(zNew, zTab, nTab+1) ){
  164054. u8 *abPK;
  164055. rc = sessionRetryConstraints(
  164056. db, pIter->bPatchset, zTab, &sApply, xConflict, pCtx
  164057. );
  164058. if( rc!=SQLITE_OK ) break;
  164059. sqlite3_free((char*)sApply.azCol); /* cast works around VC++ bug */
  164060. sqlite3_finalize(sApply.pDelete);
  164061. sqlite3_finalize(sApply.pUpdate);
  164062. sqlite3_finalize(sApply.pInsert);
  164063. sqlite3_finalize(sApply.pSelect);
  164064. memset(&sApply, 0, sizeof(sApply));
  164065. sApply.db = db;
  164066. sApply.bDeferConstraints = 1;
  164067. /* If an xFilter() callback was specified, invoke it now. If the
  164068. ** xFilter callback returns zero, skip this table. If it returns
  164069. ** non-zero, proceed. */
  164070. schemaMismatch = (xFilter && (0==xFilter(pCtx, zNew)));
  164071. if( schemaMismatch ){
  164072. zTab = sqlite3_mprintf("%s", zNew);
  164073. if( zTab==0 ){
  164074. rc = SQLITE_NOMEM;
  164075. break;
  164076. }
  164077. nTab = (int)strlen(zTab);
  164078. sApply.azCol = (const char **)zTab;
  164079. }else{
  164080. sqlite3changeset_pk(pIter, &abPK, 0);
  164081. rc = sessionTableInfo(
  164082. db, "main", zNew, &sApply.nCol, &zTab, &sApply.azCol, &sApply.abPK
  164083. );
  164084. if( rc!=SQLITE_OK ) break;
  164085. if( sApply.nCol==0 ){
  164086. schemaMismatch = 1;
  164087. sqlite3_log(SQLITE_SCHEMA,
  164088. "sqlite3changeset_apply(): no such table: %s", zTab
  164089. );
  164090. }
  164091. else if( sApply.nCol!=nCol ){
  164092. schemaMismatch = 1;
  164093. sqlite3_log(SQLITE_SCHEMA,
  164094. "sqlite3changeset_apply(): table %s has %d columns, expected %d",
  164095. zTab, sApply.nCol, nCol
  164096. );
  164097. }
  164098. else if( memcmp(sApply.abPK, abPK, nCol)!=0 ){
  164099. schemaMismatch = 1;
  164100. sqlite3_log(SQLITE_SCHEMA, "sqlite3changeset_apply(): "
  164101. "primary key mismatch for table %s", zTab
  164102. );
  164103. }
  164104. else if(
  164105. (rc = sessionSelectRow(db, zTab, &sApply))
  164106. || (rc = sessionUpdateRow(db, zTab, &sApply))
  164107. || (rc = sessionDeleteRow(db, zTab, &sApply))
  164108. || (rc = sessionInsertRow(db, zTab, &sApply))
  164109. ){
  164110. break;
  164111. }
  164112. nTab = sqlite3Strlen30(zTab);
  164113. }
  164114. }
  164115. /* If there is a schema mismatch on the current table, proceed to the
  164116. ** next change. A log message has already been issued. */
  164117. if( schemaMismatch ) continue;
  164118. rc = sessionApplyOneWithRetry(db, pIter, &sApply, xConflict, pCtx);
  164119. }
  164120. bPatchset = pIter->bPatchset;
  164121. if( rc==SQLITE_OK ){
  164122. rc = sqlite3changeset_finalize(pIter);
  164123. }else{
  164124. sqlite3changeset_finalize(pIter);
  164125. }
  164126. if( rc==SQLITE_OK ){
  164127. rc = sessionRetryConstraints(db, bPatchset, zTab, &sApply, xConflict, pCtx);
  164128. }
  164129. if( rc==SQLITE_OK ){
  164130. int nFk, notUsed;
  164131. sqlite3_db_status(db, SQLITE_DBSTATUS_DEFERRED_FKS, &nFk, &notUsed, 0);
  164132. if( nFk!=0 ){
  164133. int res = SQLITE_CHANGESET_ABORT;
  164134. sqlite3_changeset_iter sIter;
  164135. memset(&sIter, 0, sizeof(sIter));
  164136. sIter.nCol = nFk;
  164137. res = xConflict(pCtx, SQLITE_CHANGESET_FOREIGN_KEY, &sIter);
  164138. if( res!=SQLITE_CHANGESET_OMIT ){
  164139. rc = SQLITE_CONSTRAINT;
  164140. }
  164141. }
  164142. }
  164143. sqlite3_exec(db, "PRAGMA defer_foreign_keys = 0", 0, 0, 0);
  164144. if( rc==SQLITE_OK ){
  164145. rc = sqlite3_exec(db, "RELEASE changeset_apply", 0, 0, 0);
  164146. }else{
  164147. sqlite3_exec(db, "ROLLBACK TO changeset_apply", 0, 0, 0);
  164148. sqlite3_exec(db, "RELEASE changeset_apply", 0, 0, 0);
  164149. }
  164150. sqlite3_finalize(sApply.pInsert);
  164151. sqlite3_finalize(sApply.pDelete);
  164152. sqlite3_finalize(sApply.pUpdate);
  164153. sqlite3_finalize(sApply.pSelect);
  164154. sqlite3_free((char*)sApply.azCol); /* cast works around VC++ bug */
  164155. sqlite3_free((char*)sApply.constraints.aBuf);
  164156. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  164157. return rc;
  164158. }
  164159. /*
  164160. ** Apply the changeset passed via pChangeset/nChangeset to the main database
  164161. ** attached to handle "db". Invoke the supplied conflict handler callback
  164162. ** to resolve any conflicts encountered while applying the change.
  164163. */
  164164. SQLITE_API int sqlite3changeset_apply(
  164165. sqlite3 *db, /* Apply change to "main" db of this handle */
  164166. int nChangeset, /* Size of changeset in bytes */
  164167. void *pChangeset, /* Changeset blob */
  164168. int(*xFilter)(
  164169. void *pCtx, /* Copy of sixth arg to _apply() */
  164170. const char *zTab /* Table name */
  164171. ),
  164172. int(*xConflict)(
  164173. void *pCtx, /* Copy of fifth arg to _apply() */
  164174. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  164175. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  164176. ),
  164177. void *pCtx /* First argument passed to xConflict */
  164178. ){
  164179. sqlite3_changeset_iter *pIter; /* Iterator to skip through changeset */
  164180. int rc = sqlite3changeset_start(&pIter, nChangeset, pChangeset);
  164181. if( rc==SQLITE_OK ){
  164182. rc = sessionChangesetApply(db, pIter, xFilter, xConflict, pCtx);
  164183. }
  164184. return rc;
  164185. }
  164186. /*
  164187. ** Apply the changeset passed via xInput/pIn to the main database
  164188. ** attached to handle "db". Invoke the supplied conflict handler callback
  164189. ** to resolve any conflicts encountered while applying the change.
  164190. */
  164191. SQLITE_API int sqlite3changeset_apply_strm(
  164192. sqlite3 *db, /* Apply change to "main" db of this handle */
  164193. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  164194. void *pIn, /* First arg for xInput */
  164195. int(*xFilter)(
  164196. void *pCtx, /* Copy of sixth arg to _apply() */
  164197. const char *zTab /* Table name */
  164198. ),
  164199. int(*xConflict)(
  164200. void *pCtx, /* Copy of sixth arg to _apply() */
  164201. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  164202. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  164203. ),
  164204. void *pCtx /* First argument passed to xConflict */
  164205. ){
  164206. sqlite3_changeset_iter *pIter; /* Iterator to skip through changeset */
  164207. int rc = sqlite3changeset_start_strm(&pIter, xInput, pIn);
  164208. if( rc==SQLITE_OK ){
  164209. rc = sessionChangesetApply(db, pIter, xFilter, xConflict, pCtx);
  164210. }
  164211. return rc;
  164212. }
  164213. /*
  164214. ** sqlite3_changegroup handle.
  164215. */
  164216. struct sqlite3_changegroup {
  164217. int rc; /* Error code */
  164218. int bPatch; /* True to accumulate patchsets */
  164219. SessionTable *pList; /* List of tables in current patch */
  164220. };
  164221. /*
  164222. ** This function is called to merge two changes to the same row together as
  164223. ** part of an sqlite3changeset_concat() operation. A new change object is
  164224. ** allocated and a pointer to it stored in *ppNew.
  164225. */
  164226. static int sessionChangeMerge(
  164227. SessionTable *pTab, /* Table structure */
  164228. int bPatchset, /* True for patchsets */
  164229. SessionChange *pExist, /* Existing change */
  164230. int op2, /* Second change operation */
  164231. int bIndirect, /* True if second change is indirect */
  164232. u8 *aRec, /* Second change record */
  164233. int nRec, /* Number of bytes in aRec */
  164234. SessionChange **ppNew /* OUT: Merged change */
  164235. ){
  164236. SessionChange *pNew = 0;
  164237. if( !pExist ){
  164238. pNew = (SessionChange *)sqlite3_malloc(sizeof(SessionChange) + nRec);
  164239. if( !pNew ){
  164240. return SQLITE_NOMEM;
  164241. }
  164242. memset(pNew, 0, sizeof(SessionChange));
  164243. pNew->op = op2;
  164244. pNew->bIndirect = bIndirect;
  164245. pNew->nRecord = nRec;
  164246. pNew->aRecord = (u8*)&pNew[1];
  164247. memcpy(pNew->aRecord, aRec, nRec);
  164248. }else{
  164249. int op1 = pExist->op;
  164250. /*
  164251. ** op1=INSERT, op2=INSERT -> Unsupported. Discard op2.
  164252. ** op1=INSERT, op2=UPDATE -> INSERT.
  164253. ** op1=INSERT, op2=DELETE -> (none)
  164254. **
  164255. ** op1=UPDATE, op2=INSERT -> Unsupported. Discard op2.
  164256. ** op1=UPDATE, op2=UPDATE -> UPDATE.
  164257. ** op1=UPDATE, op2=DELETE -> DELETE.
  164258. **
  164259. ** op1=DELETE, op2=INSERT -> UPDATE.
  164260. ** op1=DELETE, op2=UPDATE -> Unsupported. Discard op2.
  164261. ** op1=DELETE, op2=DELETE -> Unsupported. Discard op2.
  164262. */
  164263. if( (op1==SQLITE_INSERT && op2==SQLITE_INSERT)
  164264. || (op1==SQLITE_UPDATE && op2==SQLITE_INSERT)
  164265. || (op1==SQLITE_DELETE && op2==SQLITE_UPDATE)
  164266. || (op1==SQLITE_DELETE && op2==SQLITE_DELETE)
  164267. ){
  164268. pNew = pExist;
  164269. }else if( op1==SQLITE_INSERT && op2==SQLITE_DELETE ){
  164270. sqlite3_free(pExist);
  164271. assert( pNew==0 );
  164272. }else{
  164273. u8 *aExist = pExist->aRecord;
  164274. int nByte;
  164275. u8 *aCsr;
  164276. /* Allocate a new SessionChange object. Ensure that the aRecord[]
  164277. ** buffer of the new object is large enough to hold any record that
  164278. ** may be generated by combining the input records. */
  164279. nByte = sizeof(SessionChange) + pExist->nRecord + nRec;
  164280. pNew = (SessionChange *)sqlite3_malloc(nByte);
  164281. if( !pNew ){
  164282. sqlite3_free(pExist);
  164283. return SQLITE_NOMEM;
  164284. }
  164285. memset(pNew, 0, sizeof(SessionChange));
  164286. pNew->bIndirect = (bIndirect && pExist->bIndirect);
  164287. aCsr = pNew->aRecord = (u8 *)&pNew[1];
  164288. if( op1==SQLITE_INSERT ){ /* INSERT + UPDATE */
  164289. u8 *a1 = aRec;
  164290. assert( op2==SQLITE_UPDATE );
  164291. pNew->op = SQLITE_INSERT;
  164292. if( bPatchset==0 ) sessionSkipRecord(&a1, pTab->nCol);
  164293. sessionMergeRecord(&aCsr, pTab->nCol, aExist, a1);
  164294. }else if( op1==SQLITE_DELETE ){ /* DELETE + INSERT */
  164295. assert( op2==SQLITE_INSERT );
  164296. pNew->op = SQLITE_UPDATE;
  164297. if( bPatchset ){
  164298. memcpy(aCsr, aRec, nRec);
  164299. aCsr += nRec;
  164300. }else{
  164301. if( 0==sessionMergeUpdate(&aCsr, pTab, bPatchset, aExist, 0,aRec,0) ){
  164302. sqlite3_free(pNew);
  164303. pNew = 0;
  164304. }
  164305. }
  164306. }else if( op2==SQLITE_UPDATE ){ /* UPDATE + UPDATE */
  164307. u8 *a1 = aExist;
  164308. u8 *a2 = aRec;
  164309. assert( op1==SQLITE_UPDATE );
  164310. if( bPatchset==0 ){
  164311. sessionSkipRecord(&a1, pTab->nCol);
  164312. sessionSkipRecord(&a2, pTab->nCol);
  164313. }
  164314. pNew->op = SQLITE_UPDATE;
  164315. if( 0==sessionMergeUpdate(&aCsr, pTab, bPatchset, aRec, aExist,a1,a2) ){
  164316. sqlite3_free(pNew);
  164317. pNew = 0;
  164318. }
  164319. }else{ /* UPDATE + DELETE */
  164320. assert( op1==SQLITE_UPDATE && op2==SQLITE_DELETE );
  164321. pNew->op = SQLITE_DELETE;
  164322. if( bPatchset ){
  164323. memcpy(aCsr, aRec, nRec);
  164324. aCsr += nRec;
  164325. }else{
  164326. sessionMergeRecord(&aCsr, pTab->nCol, aRec, aExist);
  164327. }
  164328. }
  164329. if( pNew ){
  164330. pNew->nRecord = (int)(aCsr - pNew->aRecord);
  164331. }
  164332. sqlite3_free(pExist);
  164333. }
  164334. }
  164335. *ppNew = pNew;
  164336. return SQLITE_OK;
  164337. }
  164338. /*
  164339. ** Add all changes in the changeset traversed by the iterator passed as
  164340. ** the first argument to the changegroup hash tables.
  164341. */
  164342. static int sessionChangesetToHash(
  164343. sqlite3_changeset_iter *pIter, /* Iterator to read from */
  164344. sqlite3_changegroup *pGrp /* Changegroup object to add changeset to */
  164345. ){
  164346. u8 *aRec;
  164347. int nRec;
  164348. int rc = SQLITE_OK;
  164349. SessionTable *pTab = 0;
  164350. while( SQLITE_ROW==sessionChangesetNext(pIter, &aRec, &nRec) ){
  164351. const char *zNew;
  164352. int nCol;
  164353. int op;
  164354. int iHash;
  164355. int bIndirect;
  164356. SessionChange *pChange;
  164357. SessionChange *pExist = 0;
  164358. SessionChange **pp;
  164359. if( pGrp->pList==0 ){
  164360. pGrp->bPatch = pIter->bPatchset;
  164361. }else if( pIter->bPatchset!=pGrp->bPatch ){
  164362. rc = SQLITE_ERROR;
  164363. break;
  164364. }
  164365. sqlite3changeset_op(pIter, &zNew, &nCol, &op, &bIndirect);
  164366. if( !pTab || sqlite3_stricmp(zNew, pTab->zName) ){
  164367. /* Search the list for a matching table */
  164368. int nNew = (int)strlen(zNew);
  164369. u8 *abPK;
  164370. sqlite3changeset_pk(pIter, &abPK, 0);
  164371. for(pTab = pGrp->pList; pTab; pTab=pTab->pNext){
  164372. if( 0==sqlite3_strnicmp(pTab->zName, zNew, nNew+1) ) break;
  164373. }
  164374. if( !pTab ){
  164375. SessionTable **ppTab;
  164376. pTab = sqlite3_malloc(sizeof(SessionTable) + nCol + nNew+1);
  164377. if( !pTab ){
  164378. rc = SQLITE_NOMEM;
  164379. break;
  164380. }
  164381. memset(pTab, 0, sizeof(SessionTable));
  164382. pTab->nCol = nCol;
  164383. pTab->abPK = (u8*)&pTab[1];
  164384. memcpy(pTab->abPK, abPK, nCol);
  164385. pTab->zName = (char*)&pTab->abPK[nCol];
  164386. memcpy(pTab->zName, zNew, nNew+1);
  164387. /* The new object must be linked on to the end of the list, not
  164388. ** simply added to the start of it. This is to ensure that the
  164389. ** tables within the output of sqlite3changegroup_output() are in
  164390. ** the right order. */
  164391. for(ppTab=&pGrp->pList; *ppTab; ppTab=&(*ppTab)->pNext);
  164392. *ppTab = pTab;
  164393. }else if( pTab->nCol!=nCol || memcmp(pTab->abPK, abPK, nCol) ){
  164394. rc = SQLITE_SCHEMA;
  164395. break;
  164396. }
  164397. }
  164398. if( sessionGrowHash(pIter->bPatchset, pTab) ){
  164399. rc = SQLITE_NOMEM;
  164400. break;
  164401. }
  164402. iHash = sessionChangeHash(
  164403. pTab, (pIter->bPatchset && op==SQLITE_DELETE), aRec, pTab->nChange
  164404. );
  164405. /* Search for existing entry. If found, remove it from the hash table.
  164406. ** Code below may link it back in.
  164407. */
  164408. for(pp=&pTab->apChange[iHash]; *pp; pp=&(*pp)->pNext){
  164409. int bPkOnly1 = 0;
  164410. int bPkOnly2 = 0;
  164411. if( pIter->bPatchset ){
  164412. bPkOnly1 = (*pp)->op==SQLITE_DELETE;
  164413. bPkOnly2 = op==SQLITE_DELETE;
  164414. }
  164415. if( sessionChangeEqual(pTab, bPkOnly1, (*pp)->aRecord, bPkOnly2, aRec) ){
  164416. pExist = *pp;
  164417. *pp = (*pp)->pNext;
  164418. pTab->nEntry--;
  164419. break;
  164420. }
  164421. }
  164422. rc = sessionChangeMerge(pTab,
  164423. pIter->bPatchset, pExist, op, bIndirect, aRec, nRec, &pChange
  164424. );
  164425. if( rc ) break;
  164426. if( pChange ){
  164427. pChange->pNext = pTab->apChange[iHash];
  164428. pTab->apChange[iHash] = pChange;
  164429. pTab->nEntry++;
  164430. }
  164431. }
  164432. if( rc==SQLITE_OK ) rc = pIter->rc;
  164433. return rc;
  164434. }
  164435. /*
  164436. ** Serialize a changeset (or patchset) based on all changesets (or patchsets)
  164437. ** added to the changegroup object passed as the first argument.
  164438. **
  164439. ** If xOutput is not NULL, then the changeset/patchset is returned to the
  164440. ** user via one or more calls to xOutput, as with the other streaming
  164441. ** interfaces.
  164442. **
  164443. ** Or, if xOutput is NULL, then (*ppOut) is populated with a pointer to a
  164444. ** buffer containing the output changeset before this function returns. In
  164445. ** this case (*pnOut) is set to the size of the output buffer in bytes. It
  164446. ** is the responsibility of the caller to free the output buffer using
  164447. ** sqlite3_free() when it is no longer required.
  164448. **
  164449. ** If successful, SQLITE_OK is returned. Or, if an error occurs, an SQLite
  164450. ** error code. If an error occurs and xOutput is NULL, (*ppOut) and (*pnOut)
  164451. ** are both set to 0 before returning.
  164452. */
  164453. static int sessionChangegroupOutput(
  164454. sqlite3_changegroup *pGrp,
  164455. int (*xOutput)(void *pOut, const void *pData, int nData),
  164456. void *pOut,
  164457. int *pnOut,
  164458. void **ppOut
  164459. ){
  164460. int rc = SQLITE_OK;
  164461. SessionBuffer buf = {0, 0, 0};
  164462. SessionTable *pTab;
  164463. assert( xOutput==0 || (ppOut==0 && pnOut==0) );
  164464. /* Create the serialized output changeset based on the contents of the
  164465. ** hash tables attached to the SessionTable objects in list p->pList.
  164466. */
  164467. for(pTab=pGrp->pList; rc==SQLITE_OK && pTab; pTab=pTab->pNext){
  164468. int i;
  164469. if( pTab->nEntry==0 ) continue;
  164470. sessionAppendTableHdr(&buf, pGrp->bPatch, pTab, &rc);
  164471. for(i=0; i<pTab->nChange; i++){
  164472. SessionChange *p;
  164473. for(p=pTab->apChange[i]; p; p=p->pNext){
  164474. sessionAppendByte(&buf, p->op, &rc);
  164475. sessionAppendByte(&buf, p->bIndirect, &rc);
  164476. sessionAppendBlob(&buf, p->aRecord, p->nRecord, &rc);
  164477. }
  164478. }
  164479. if( rc==SQLITE_OK && xOutput && buf.nBuf>=SESSIONS_STRM_CHUNK_SIZE ){
  164480. rc = xOutput(pOut, buf.aBuf, buf.nBuf);
  164481. buf.nBuf = 0;
  164482. }
  164483. }
  164484. if( rc==SQLITE_OK ){
  164485. if( xOutput ){
  164486. if( buf.nBuf>0 ) rc = xOutput(pOut, buf.aBuf, buf.nBuf);
  164487. }else{
  164488. *ppOut = buf.aBuf;
  164489. *pnOut = buf.nBuf;
  164490. buf.aBuf = 0;
  164491. }
  164492. }
  164493. sqlite3_free(buf.aBuf);
  164494. return rc;
  164495. }
  164496. /*
  164497. ** Allocate a new, empty, sqlite3_changegroup.
  164498. */
  164499. SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp){
  164500. int rc = SQLITE_OK; /* Return code */
  164501. sqlite3_changegroup *p; /* New object */
  164502. p = (sqlite3_changegroup*)sqlite3_malloc(sizeof(sqlite3_changegroup));
  164503. if( p==0 ){
  164504. rc = SQLITE_NOMEM;
  164505. }else{
  164506. memset(p, 0, sizeof(sqlite3_changegroup));
  164507. }
  164508. *pp = p;
  164509. return rc;
  164510. }
  164511. /*
  164512. ** Add the changeset currently stored in buffer pData, size nData bytes,
  164513. ** to changeset-group p.
  164514. */
  164515. SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup *pGrp, int nData, void *pData){
  164516. sqlite3_changeset_iter *pIter; /* Iterator opened on pData/nData */
  164517. int rc; /* Return code */
  164518. rc = sqlite3changeset_start(&pIter, nData, pData);
  164519. if( rc==SQLITE_OK ){
  164520. rc = sessionChangesetToHash(pIter, pGrp);
  164521. }
  164522. sqlite3changeset_finalize(pIter);
  164523. return rc;
  164524. }
  164525. /*
  164526. ** Obtain a buffer containing a changeset representing the concatenation
  164527. ** of all changesets added to the group so far.
  164528. */
  164529. SQLITE_API int sqlite3changegroup_output(
  164530. sqlite3_changegroup *pGrp,
  164531. int *pnData,
  164532. void **ppData
  164533. ){
  164534. return sessionChangegroupOutput(pGrp, 0, 0, pnData, ppData);
  164535. }
  164536. /*
  164537. ** Streaming versions of changegroup_add().
  164538. */
  164539. SQLITE_API int sqlite3changegroup_add_strm(
  164540. sqlite3_changegroup *pGrp,
  164541. int (*xInput)(void *pIn, void *pData, int *pnData),
  164542. void *pIn
  164543. ){
  164544. sqlite3_changeset_iter *pIter; /* Iterator opened on pData/nData */
  164545. int rc; /* Return code */
  164546. rc = sqlite3changeset_start_strm(&pIter, xInput, pIn);
  164547. if( rc==SQLITE_OK ){
  164548. rc = sessionChangesetToHash(pIter, pGrp);
  164549. }
  164550. sqlite3changeset_finalize(pIter);
  164551. return rc;
  164552. }
  164553. /*
  164554. ** Streaming versions of changegroup_output().
  164555. */
  164556. SQLITE_API int sqlite3changegroup_output_strm(
  164557. sqlite3_changegroup *pGrp,
  164558. int (*xOutput)(void *pOut, const void *pData, int nData),
  164559. void *pOut
  164560. ){
  164561. return sessionChangegroupOutput(pGrp, xOutput, pOut, 0, 0);
  164562. }
  164563. /*
  164564. ** Delete a changegroup object.
  164565. */
  164566. SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup *pGrp){
  164567. if( pGrp ){
  164568. sessionDeleteTable(pGrp->pList);
  164569. sqlite3_free(pGrp);
  164570. }
  164571. }
  164572. /*
  164573. ** Combine two changesets together.
  164574. */
  164575. SQLITE_API int sqlite3changeset_concat(
  164576. int nLeft, /* Number of bytes in lhs input */
  164577. void *pLeft, /* Lhs input changeset */
  164578. int nRight /* Number of bytes in rhs input */,
  164579. void *pRight, /* Rhs input changeset */
  164580. int *pnOut, /* OUT: Number of bytes in output changeset */
  164581. void **ppOut /* OUT: changeset (left <concat> right) */
  164582. ){
  164583. sqlite3_changegroup *pGrp;
  164584. int rc;
  164585. rc = sqlite3changegroup_new(&pGrp);
  164586. if( rc==SQLITE_OK ){
  164587. rc = sqlite3changegroup_add(pGrp, nLeft, pLeft);
  164588. }
  164589. if( rc==SQLITE_OK ){
  164590. rc = sqlite3changegroup_add(pGrp, nRight, pRight);
  164591. }
  164592. if( rc==SQLITE_OK ){
  164593. rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
  164594. }
  164595. sqlite3changegroup_delete(pGrp);
  164596. return rc;
  164597. }
  164598. /*
  164599. ** Streaming version of sqlite3changeset_concat().
  164600. */
  164601. SQLITE_API int sqlite3changeset_concat_strm(
  164602. int (*xInputA)(void *pIn, void *pData, int *pnData),
  164603. void *pInA,
  164604. int (*xInputB)(void *pIn, void *pData, int *pnData),
  164605. void *pInB,
  164606. int (*xOutput)(void *pOut, const void *pData, int nData),
  164607. void *pOut
  164608. ){
  164609. sqlite3_changegroup *pGrp;
  164610. int rc;
  164611. rc = sqlite3changegroup_new(&pGrp);
  164612. if( rc==SQLITE_OK ){
  164613. rc = sqlite3changegroup_add_strm(pGrp, xInputA, pInA);
  164614. }
  164615. if( rc==SQLITE_OK ){
  164616. rc = sqlite3changegroup_add_strm(pGrp, xInputB, pInB);
  164617. }
  164618. if( rc==SQLITE_OK ){
  164619. rc = sqlite3changegroup_output_strm(pGrp, xOutput, pOut);
  164620. }
  164621. sqlite3changegroup_delete(pGrp);
  164622. return rc;
  164623. }
  164624. #endif /* SQLITE_ENABLE_SESSION && SQLITE_ENABLE_PREUPDATE_HOOK */
  164625. /************** End of sqlite3session.c **************************************/
  164626. /************** Begin file json1.c *******************************************/
  164627. /*
  164628. ** 2015-08-12
  164629. **
  164630. ** The author disclaims copyright to this source code. In place of
  164631. ** a legal notice, here is a blessing:
  164632. **
  164633. ** May you do good and not evil.
  164634. ** May you find forgiveness for yourself and forgive others.
  164635. ** May you share freely, never taking more than you give.
  164636. **
  164637. ******************************************************************************
  164638. **
  164639. ** This SQLite extension implements JSON functions. The interface is
  164640. ** modeled after MySQL JSON functions:
  164641. **
  164642. ** https://dev.mysql.com/doc/refman/5.7/en/json.html
  164643. **
  164644. ** For the time being, all JSON is stored as pure text. (We might add
  164645. ** a JSONB type in the future which stores a binary encoding of JSON in
  164646. ** a BLOB, but there is no support for JSONB in the current implementation.
  164647. ** This implementation parses JSON text at 250 MB/s, so it is hard to see
  164648. ** how JSONB might improve on that.)
  164649. */
  164650. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_JSON1)
  164651. #if !defined(_SQLITEINT_H_)
  164652. /* #include "sqlite3ext.h" */
  164653. #endif
  164654. SQLITE_EXTENSION_INIT1
  164655. /* #include <assert.h> */
  164656. /* #include <string.h> */
  164657. /* #include <stdlib.h> */
  164658. /* #include <stdarg.h> */
  164659. /* Mark a function parameter as unused, to suppress nuisance compiler
  164660. ** warnings. */
  164661. #ifndef UNUSED_PARAM
  164662. # define UNUSED_PARAM(X) (void)(X)
  164663. #endif
  164664. #ifndef LARGEST_INT64
  164665. # define LARGEST_INT64 (0xffffffff|(((sqlite3_int64)0x7fffffff)<<32))
  164666. # define SMALLEST_INT64 (((sqlite3_int64)-1) - LARGEST_INT64)
  164667. #endif
  164668. /*
  164669. ** Versions of isspace(), isalnum() and isdigit() to which it is safe
  164670. ** to pass signed char values.
  164671. */
  164672. #ifdef sqlite3Isdigit
  164673. /* Use the SQLite core versions if this routine is part of the
  164674. ** SQLite amalgamation */
  164675. # define safe_isdigit(x) sqlite3Isdigit(x)
  164676. # define safe_isalnum(x) sqlite3Isalnum(x)
  164677. #else
  164678. /* Use the standard library for separate compilation */
  164679. #include <ctype.h> /* amalgamator: keep */
  164680. # define safe_isdigit(x) isdigit((unsigned char)(x))
  164681. # define safe_isalnum(x) isalnum((unsigned char)(x))
  164682. #endif
  164683. /*
  164684. ** Growing our own isspace() routine this way is twice as fast as
  164685. ** the library isspace() function, resulting in a 7% overall performance
  164686. ** increase for the parser. (Ubuntu14.10 gcc 4.8.4 x64 with -Os).
  164687. */
  164688. static const char jsonIsSpace[] = {
  164689. 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0, 1, 0, 0,
  164690. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164691. 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164692. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164693. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164694. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164695. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164696. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164697. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164698. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164699. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164700. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164701. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164702. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164703. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164704. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  164705. };
  164706. #define safe_isspace(x) (jsonIsSpace[(unsigned char)x])
  164707. #ifndef SQLITE_AMALGAMATION
  164708. /* Unsigned integer types. These are already defined in the sqliteInt.h,
  164709. ** but the definitions need to be repeated for separate compilation. */
  164710. typedef sqlite3_uint64 u64;
  164711. typedef unsigned int u32;
  164712. typedef unsigned char u8;
  164713. #endif
  164714. /* Objects */
  164715. typedef struct JsonString JsonString;
  164716. typedef struct JsonNode JsonNode;
  164717. typedef struct JsonParse JsonParse;
  164718. /* An instance of this object represents a JSON string
  164719. ** under construction. Really, this is a generic string accumulator
  164720. ** that can be and is used to create strings other than JSON.
  164721. */
  164722. struct JsonString {
  164723. sqlite3_context *pCtx; /* Function context - put error messages here */
  164724. char *zBuf; /* Append JSON content here */
  164725. u64 nAlloc; /* Bytes of storage available in zBuf[] */
  164726. u64 nUsed; /* Bytes of zBuf[] currently used */
  164727. u8 bStatic; /* True if zBuf is static space */
  164728. u8 bErr; /* True if an error has been encountered */
  164729. char zSpace[100]; /* Initial static space */
  164730. };
  164731. /* JSON type values
  164732. */
  164733. #define JSON_NULL 0
  164734. #define JSON_TRUE 1
  164735. #define JSON_FALSE 2
  164736. #define JSON_INT 3
  164737. #define JSON_REAL 4
  164738. #define JSON_STRING 5
  164739. #define JSON_ARRAY 6
  164740. #define JSON_OBJECT 7
  164741. /* The "subtype" set for JSON values */
  164742. #define JSON_SUBTYPE 74 /* Ascii for "J" */
  164743. /*
  164744. ** Names of the various JSON types:
  164745. */
  164746. static const char * const jsonType[] = {
  164747. "null", "true", "false", "integer", "real", "text", "array", "object"
  164748. };
  164749. /* Bit values for the JsonNode.jnFlag field
  164750. */
  164751. #define JNODE_RAW 0x01 /* Content is raw, not JSON encoded */
  164752. #define JNODE_ESCAPE 0x02 /* Content is text with \ escapes */
  164753. #define JNODE_REMOVE 0x04 /* Do not output */
  164754. #define JNODE_REPLACE 0x08 /* Replace with JsonNode.iVal */
  164755. #define JNODE_APPEND 0x10 /* More ARRAY/OBJECT entries at u.iAppend */
  164756. #define JNODE_LABEL 0x20 /* Is a label of an object */
  164757. /* A single node of parsed JSON
  164758. */
  164759. struct JsonNode {
  164760. u8 eType; /* One of the JSON_ type values */
  164761. u8 jnFlags; /* JNODE flags */
  164762. u8 iVal; /* Replacement value when JNODE_REPLACE */
  164763. u32 n; /* Bytes of content, or number of sub-nodes */
  164764. union {
  164765. const char *zJContent; /* Content for INT, REAL, and STRING */
  164766. u32 iAppend; /* More terms for ARRAY and OBJECT */
  164767. u32 iKey; /* Key for ARRAY objects in json_tree() */
  164768. } u;
  164769. };
  164770. /* A completely parsed JSON string
  164771. */
  164772. struct JsonParse {
  164773. u32 nNode; /* Number of slots of aNode[] used */
  164774. u32 nAlloc; /* Number of slots of aNode[] allocated */
  164775. JsonNode *aNode; /* Array of nodes containing the parse */
  164776. const char *zJson; /* Original JSON string */
  164777. u32 *aUp; /* Index of parent of each node */
  164778. u8 oom; /* Set to true if out of memory */
  164779. u8 nErr; /* Number of errors seen */
  164780. };
  164781. /**************************************************************************
  164782. ** Utility routines for dealing with JsonString objects
  164783. **************************************************************************/
  164784. /* Set the JsonString object to an empty string
  164785. */
  164786. static void jsonZero(JsonString *p){
  164787. p->zBuf = p->zSpace;
  164788. p->nAlloc = sizeof(p->zSpace);
  164789. p->nUsed = 0;
  164790. p->bStatic = 1;
  164791. }
  164792. /* Initialize the JsonString object
  164793. */
  164794. static void jsonInit(JsonString *p, sqlite3_context *pCtx){
  164795. p->pCtx = pCtx;
  164796. p->bErr = 0;
  164797. jsonZero(p);
  164798. }
  164799. /* Free all allocated memory and reset the JsonString object back to its
  164800. ** initial state.
  164801. */
  164802. static void jsonReset(JsonString *p){
  164803. if( !p->bStatic ) sqlite3_free(p->zBuf);
  164804. jsonZero(p);
  164805. }
  164806. /* Report an out-of-memory (OOM) condition
  164807. */
  164808. static void jsonOom(JsonString *p){
  164809. p->bErr = 1;
  164810. sqlite3_result_error_nomem(p->pCtx);
  164811. jsonReset(p);
  164812. }
  164813. /* Enlarge pJson->zBuf so that it can hold at least N more bytes.
  164814. ** Return zero on success. Return non-zero on an OOM error
  164815. */
  164816. static int jsonGrow(JsonString *p, u32 N){
  164817. u64 nTotal = N<p->nAlloc ? p->nAlloc*2 : p->nAlloc+N+10;
  164818. char *zNew;
  164819. if( p->bStatic ){
  164820. if( p->bErr ) return 1;
  164821. zNew = sqlite3_malloc64(nTotal);
  164822. if( zNew==0 ){
  164823. jsonOom(p);
  164824. return SQLITE_NOMEM;
  164825. }
  164826. memcpy(zNew, p->zBuf, (size_t)p->nUsed);
  164827. p->zBuf = zNew;
  164828. p->bStatic = 0;
  164829. }else{
  164830. zNew = sqlite3_realloc64(p->zBuf, nTotal);
  164831. if( zNew==0 ){
  164832. jsonOom(p);
  164833. return SQLITE_NOMEM;
  164834. }
  164835. p->zBuf = zNew;
  164836. }
  164837. p->nAlloc = nTotal;
  164838. return SQLITE_OK;
  164839. }
  164840. /* Append N bytes from zIn onto the end of the JsonString string.
  164841. */
  164842. static void jsonAppendRaw(JsonString *p, const char *zIn, u32 N){
  164843. if( (N+p->nUsed >= p->nAlloc) && jsonGrow(p,N)!=0 ) return;
  164844. memcpy(p->zBuf+p->nUsed, zIn, N);
  164845. p->nUsed += N;
  164846. }
  164847. /* Append formatted text (not to exceed N bytes) to the JsonString.
  164848. */
  164849. static void jsonPrintf(int N, JsonString *p, const char *zFormat, ...){
  164850. va_list ap;
  164851. if( (p->nUsed + N >= p->nAlloc) && jsonGrow(p, N) ) return;
  164852. va_start(ap, zFormat);
  164853. sqlite3_vsnprintf(N, p->zBuf+p->nUsed, zFormat, ap);
  164854. va_end(ap);
  164855. p->nUsed += (int)strlen(p->zBuf+p->nUsed);
  164856. }
  164857. /* Append a single character
  164858. */
  164859. static void jsonAppendChar(JsonString *p, char c){
  164860. if( p->nUsed>=p->nAlloc && jsonGrow(p,1)!=0 ) return;
  164861. p->zBuf[p->nUsed++] = c;
  164862. }
  164863. /* Append a comma separator to the output buffer, if the previous
  164864. ** character is not '[' or '{'.
  164865. */
  164866. static void jsonAppendSeparator(JsonString *p){
  164867. char c;
  164868. if( p->nUsed==0 ) return;
  164869. c = p->zBuf[p->nUsed-1];
  164870. if( c!='[' && c!='{' ) jsonAppendChar(p, ',');
  164871. }
  164872. /* Append the N-byte string in zIn to the end of the JsonString string
  164873. ** under construction. Enclose the string in "..." and escape
  164874. ** any double-quotes or backslash characters contained within the
  164875. ** string.
  164876. */
  164877. static void jsonAppendString(JsonString *p, const char *zIn, u32 N){
  164878. u32 i;
  164879. if( (N+p->nUsed+2 >= p->nAlloc) && jsonGrow(p,N+2)!=0 ) return;
  164880. p->zBuf[p->nUsed++] = '"';
  164881. for(i=0; i<N; i++){
  164882. unsigned char c = ((unsigned const char*)zIn)[i];
  164883. if( c=='"' || c=='\\' ){
  164884. json_simple_escape:
  164885. if( (p->nUsed+N+3-i > p->nAlloc) && jsonGrow(p,N+3-i)!=0 ) return;
  164886. p->zBuf[p->nUsed++] = '\\';
  164887. }else if( c<=0x1f ){
  164888. static const char aSpecial[] = {
  164889. 0, 0, 0, 0, 0, 0, 0, 0, 'b', 't', 'n', 0, 'f', 'r', 0, 0,
  164890. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
  164891. };
  164892. assert( sizeof(aSpecial)==32 );
  164893. assert( aSpecial['\b']=='b' );
  164894. assert( aSpecial['\f']=='f' );
  164895. assert( aSpecial['\n']=='n' );
  164896. assert( aSpecial['\r']=='r' );
  164897. assert( aSpecial['\t']=='t' );
  164898. if( aSpecial[c] ){
  164899. c = aSpecial[c];
  164900. goto json_simple_escape;
  164901. }
  164902. if( (p->nUsed+N+7+i > p->nAlloc) && jsonGrow(p,N+7-i)!=0 ) return;
  164903. p->zBuf[p->nUsed++] = '\\';
  164904. p->zBuf[p->nUsed++] = 'u';
  164905. p->zBuf[p->nUsed++] = '0';
  164906. p->zBuf[p->nUsed++] = '0';
  164907. p->zBuf[p->nUsed++] = '0' + (c>>4);
  164908. c = "0123456789abcdef"[c&0xf];
  164909. }
  164910. p->zBuf[p->nUsed++] = c;
  164911. }
  164912. p->zBuf[p->nUsed++] = '"';
  164913. assert( p->nUsed<p->nAlloc );
  164914. }
  164915. /*
  164916. ** Append a function parameter value to the JSON string under
  164917. ** construction.
  164918. */
  164919. static void jsonAppendValue(
  164920. JsonString *p, /* Append to this JSON string */
  164921. sqlite3_value *pValue /* Value to append */
  164922. ){
  164923. switch( sqlite3_value_type(pValue) ){
  164924. case SQLITE_NULL: {
  164925. jsonAppendRaw(p, "null", 4);
  164926. break;
  164927. }
  164928. case SQLITE_INTEGER:
  164929. case SQLITE_FLOAT: {
  164930. const char *z = (const char*)sqlite3_value_text(pValue);
  164931. u32 n = (u32)sqlite3_value_bytes(pValue);
  164932. jsonAppendRaw(p, z, n);
  164933. break;
  164934. }
  164935. case SQLITE_TEXT: {
  164936. const char *z = (const char*)sqlite3_value_text(pValue);
  164937. u32 n = (u32)sqlite3_value_bytes(pValue);
  164938. if( sqlite3_value_subtype(pValue)==JSON_SUBTYPE ){
  164939. jsonAppendRaw(p, z, n);
  164940. }else{
  164941. jsonAppendString(p, z, n);
  164942. }
  164943. break;
  164944. }
  164945. default: {
  164946. if( p->bErr==0 ){
  164947. sqlite3_result_error(p->pCtx, "JSON cannot hold BLOB values", -1);
  164948. p->bErr = 2;
  164949. jsonReset(p);
  164950. }
  164951. break;
  164952. }
  164953. }
  164954. }
  164955. /* Make the JSON in p the result of the SQL function.
  164956. */
  164957. static void jsonResult(JsonString *p){
  164958. if( p->bErr==0 ){
  164959. sqlite3_result_text64(p->pCtx, p->zBuf, p->nUsed,
  164960. p->bStatic ? SQLITE_TRANSIENT : sqlite3_free,
  164961. SQLITE_UTF8);
  164962. jsonZero(p);
  164963. }
  164964. assert( p->bStatic );
  164965. }
  164966. /**************************************************************************
  164967. ** Utility routines for dealing with JsonNode and JsonParse objects
  164968. **************************************************************************/
  164969. /*
  164970. ** Return the number of consecutive JsonNode slots need to represent
  164971. ** the parsed JSON at pNode. The minimum answer is 1. For ARRAY and
  164972. ** OBJECT types, the number might be larger.
  164973. **
  164974. ** Appended elements are not counted. The value returned is the number
  164975. ** by which the JsonNode counter should increment in order to go to the
  164976. ** next peer value.
  164977. */
  164978. static u32 jsonNodeSize(JsonNode *pNode){
  164979. return pNode->eType>=JSON_ARRAY ? pNode->n+1 : 1;
  164980. }
  164981. /*
  164982. ** Reclaim all memory allocated by a JsonParse object. But do not
  164983. ** delete the JsonParse object itself.
  164984. */
  164985. static void jsonParseReset(JsonParse *pParse){
  164986. sqlite3_free(pParse->aNode);
  164987. pParse->aNode = 0;
  164988. pParse->nNode = 0;
  164989. pParse->nAlloc = 0;
  164990. sqlite3_free(pParse->aUp);
  164991. pParse->aUp = 0;
  164992. }
  164993. /*
  164994. ** Convert the JsonNode pNode into a pure JSON string and
  164995. ** append to pOut. Subsubstructure is also included. Return
  164996. ** the number of JsonNode objects that are encoded.
  164997. */
  164998. static void jsonRenderNode(
  164999. JsonNode *pNode, /* The node to render */
  165000. JsonString *pOut, /* Write JSON here */
  165001. sqlite3_value **aReplace /* Replacement values */
  165002. ){
  165003. switch( pNode->eType ){
  165004. default: {
  165005. assert( pNode->eType==JSON_NULL );
  165006. jsonAppendRaw(pOut, "null", 4);
  165007. break;
  165008. }
  165009. case JSON_TRUE: {
  165010. jsonAppendRaw(pOut, "true", 4);
  165011. break;
  165012. }
  165013. case JSON_FALSE: {
  165014. jsonAppendRaw(pOut, "false", 5);
  165015. break;
  165016. }
  165017. case JSON_STRING: {
  165018. if( pNode->jnFlags & JNODE_RAW ){
  165019. jsonAppendString(pOut, pNode->u.zJContent, pNode->n);
  165020. break;
  165021. }
  165022. /* Fall through into the next case */
  165023. }
  165024. case JSON_REAL:
  165025. case JSON_INT: {
  165026. jsonAppendRaw(pOut, pNode->u.zJContent, pNode->n);
  165027. break;
  165028. }
  165029. case JSON_ARRAY: {
  165030. u32 j = 1;
  165031. jsonAppendChar(pOut, '[');
  165032. for(;;){
  165033. while( j<=pNode->n ){
  165034. if( pNode[j].jnFlags & (JNODE_REMOVE|JNODE_REPLACE) ){
  165035. if( pNode[j].jnFlags & JNODE_REPLACE ){
  165036. jsonAppendSeparator(pOut);
  165037. jsonAppendValue(pOut, aReplace[pNode[j].iVal]);
  165038. }
  165039. }else{
  165040. jsonAppendSeparator(pOut);
  165041. jsonRenderNode(&pNode[j], pOut, aReplace);
  165042. }
  165043. j += jsonNodeSize(&pNode[j]);
  165044. }
  165045. if( (pNode->jnFlags & JNODE_APPEND)==0 ) break;
  165046. pNode = &pNode[pNode->u.iAppend];
  165047. j = 1;
  165048. }
  165049. jsonAppendChar(pOut, ']');
  165050. break;
  165051. }
  165052. case JSON_OBJECT: {
  165053. u32 j = 1;
  165054. jsonAppendChar(pOut, '{');
  165055. for(;;){
  165056. while( j<=pNode->n ){
  165057. if( (pNode[j+1].jnFlags & JNODE_REMOVE)==0 ){
  165058. jsonAppendSeparator(pOut);
  165059. jsonRenderNode(&pNode[j], pOut, aReplace);
  165060. jsonAppendChar(pOut, ':');
  165061. if( pNode[j+1].jnFlags & JNODE_REPLACE ){
  165062. jsonAppendValue(pOut, aReplace[pNode[j+1].iVal]);
  165063. }else{
  165064. jsonRenderNode(&pNode[j+1], pOut, aReplace);
  165065. }
  165066. }
  165067. j += 1 + jsonNodeSize(&pNode[j+1]);
  165068. }
  165069. if( (pNode->jnFlags & JNODE_APPEND)==0 ) break;
  165070. pNode = &pNode[pNode->u.iAppend];
  165071. j = 1;
  165072. }
  165073. jsonAppendChar(pOut, '}');
  165074. break;
  165075. }
  165076. }
  165077. }
  165078. /*
  165079. ** Return a JsonNode and all its descendents as a JSON string.
  165080. */
  165081. static void jsonReturnJson(
  165082. JsonNode *pNode, /* Node to return */
  165083. sqlite3_context *pCtx, /* Return value for this function */
  165084. sqlite3_value **aReplace /* Array of replacement values */
  165085. ){
  165086. JsonString s;
  165087. jsonInit(&s, pCtx);
  165088. jsonRenderNode(pNode, &s, aReplace);
  165089. jsonResult(&s);
  165090. sqlite3_result_subtype(pCtx, JSON_SUBTYPE);
  165091. }
  165092. /*
  165093. ** Make the JsonNode the return value of the function.
  165094. */
  165095. static void jsonReturn(
  165096. JsonNode *pNode, /* Node to return */
  165097. sqlite3_context *pCtx, /* Return value for this function */
  165098. sqlite3_value **aReplace /* Array of replacement values */
  165099. ){
  165100. switch( pNode->eType ){
  165101. default: {
  165102. assert( pNode->eType==JSON_NULL );
  165103. sqlite3_result_null(pCtx);
  165104. break;
  165105. }
  165106. case JSON_TRUE: {
  165107. sqlite3_result_int(pCtx, 1);
  165108. break;
  165109. }
  165110. case JSON_FALSE: {
  165111. sqlite3_result_int(pCtx, 0);
  165112. break;
  165113. }
  165114. case JSON_INT: {
  165115. sqlite3_int64 i = 0;
  165116. const char *z = pNode->u.zJContent;
  165117. if( z[0]=='-' ){ z++; }
  165118. while( z[0]>='0' && z[0]<='9' ){
  165119. unsigned v = *(z++) - '0';
  165120. if( i>=LARGEST_INT64/10 ){
  165121. if( i>LARGEST_INT64/10 ) goto int_as_real;
  165122. if( z[0]>='0' && z[0]<='9' ) goto int_as_real;
  165123. if( v==9 ) goto int_as_real;
  165124. if( v==8 ){
  165125. if( pNode->u.zJContent[0]=='-' ){
  165126. sqlite3_result_int64(pCtx, SMALLEST_INT64);
  165127. goto int_done;
  165128. }else{
  165129. goto int_as_real;
  165130. }
  165131. }
  165132. }
  165133. i = i*10 + v;
  165134. }
  165135. if( pNode->u.zJContent[0]=='-' ){ i = -i; }
  165136. sqlite3_result_int64(pCtx, i);
  165137. int_done:
  165138. break;
  165139. int_as_real: /* fall through to real */;
  165140. }
  165141. case JSON_REAL: {
  165142. double r;
  165143. #ifdef SQLITE_AMALGAMATION
  165144. const char *z = pNode->u.zJContent;
  165145. sqlite3AtoF(z, &r, sqlite3Strlen30(z), SQLITE_UTF8);
  165146. #else
  165147. r = strtod(pNode->u.zJContent, 0);
  165148. #endif
  165149. sqlite3_result_double(pCtx, r);
  165150. break;
  165151. }
  165152. case JSON_STRING: {
  165153. #if 0 /* Never happens because JNODE_RAW is only set by json_set(),
  165154. ** json_insert() and json_replace() and those routines do not
  165155. ** call jsonReturn() */
  165156. if( pNode->jnFlags & JNODE_RAW ){
  165157. sqlite3_result_text(pCtx, pNode->u.zJContent, pNode->n,
  165158. SQLITE_TRANSIENT);
  165159. }else
  165160. #endif
  165161. assert( (pNode->jnFlags & JNODE_RAW)==0 );
  165162. if( (pNode->jnFlags & JNODE_ESCAPE)==0 ){
  165163. /* JSON formatted without any backslash-escapes */
  165164. sqlite3_result_text(pCtx, pNode->u.zJContent+1, pNode->n-2,
  165165. SQLITE_TRANSIENT);
  165166. }else{
  165167. /* Translate JSON formatted string into raw text */
  165168. u32 i;
  165169. u32 n = pNode->n;
  165170. const char *z = pNode->u.zJContent;
  165171. char *zOut;
  165172. u32 j;
  165173. zOut = sqlite3_malloc( n+1 );
  165174. if( zOut==0 ){
  165175. sqlite3_result_error_nomem(pCtx);
  165176. break;
  165177. }
  165178. for(i=1, j=0; i<n-1; i++){
  165179. char c = z[i];
  165180. if( c!='\\' ){
  165181. zOut[j++] = c;
  165182. }else{
  165183. c = z[++i];
  165184. if( c=='u' ){
  165185. u32 v = 0, k;
  165186. for(k=0; k<4 && i<n-2; i++, k++){
  165187. c = z[i+1];
  165188. if( c>='0' && c<='9' ) v = v*16 + c - '0';
  165189. else if( c>='A' && c<='F' ) v = v*16 + c - 'A' + 10;
  165190. else if( c>='a' && c<='f' ) v = v*16 + c - 'a' + 10;
  165191. else break;
  165192. }
  165193. if( v==0 ) break;
  165194. if( v<=0x7f ){
  165195. zOut[j++] = (char)v;
  165196. }else if( v<=0x7ff ){
  165197. zOut[j++] = (char)(0xc0 | (v>>6));
  165198. zOut[j++] = 0x80 | (v&0x3f);
  165199. }else{
  165200. zOut[j++] = (char)(0xe0 | (v>>12));
  165201. zOut[j++] = 0x80 | ((v>>6)&0x3f);
  165202. zOut[j++] = 0x80 | (v&0x3f);
  165203. }
  165204. }else{
  165205. if( c=='b' ){
  165206. c = '\b';
  165207. }else if( c=='f' ){
  165208. c = '\f';
  165209. }else if( c=='n' ){
  165210. c = '\n';
  165211. }else if( c=='r' ){
  165212. c = '\r';
  165213. }else if( c=='t' ){
  165214. c = '\t';
  165215. }
  165216. zOut[j++] = c;
  165217. }
  165218. }
  165219. }
  165220. zOut[j] = 0;
  165221. sqlite3_result_text(pCtx, zOut, j, sqlite3_free);
  165222. }
  165223. break;
  165224. }
  165225. case JSON_ARRAY:
  165226. case JSON_OBJECT: {
  165227. jsonReturnJson(pNode, pCtx, aReplace);
  165228. break;
  165229. }
  165230. }
  165231. }
  165232. /* Forward reference */
  165233. static int jsonParseAddNode(JsonParse*,u32,u32,const char*);
  165234. /*
  165235. ** A macro to hint to the compiler that a function should not be
  165236. ** inlined.
  165237. */
  165238. #if defined(__GNUC__)
  165239. # define JSON_NOINLINE __attribute__((noinline))
  165240. #elif defined(_MSC_VER) && _MSC_VER>=1310
  165241. # define JSON_NOINLINE __declspec(noinline)
  165242. #else
  165243. # define JSON_NOINLINE
  165244. #endif
  165245. static JSON_NOINLINE int jsonParseAddNodeExpand(
  165246. JsonParse *pParse, /* Append the node to this object */
  165247. u32 eType, /* Node type */
  165248. u32 n, /* Content size or sub-node count */
  165249. const char *zContent /* Content */
  165250. ){
  165251. u32 nNew;
  165252. JsonNode *pNew;
  165253. assert( pParse->nNode>=pParse->nAlloc );
  165254. if( pParse->oom ) return -1;
  165255. nNew = pParse->nAlloc*2 + 10;
  165256. pNew = sqlite3_realloc(pParse->aNode, sizeof(JsonNode)*nNew);
  165257. if( pNew==0 ){
  165258. pParse->oom = 1;
  165259. return -1;
  165260. }
  165261. pParse->nAlloc = nNew;
  165262. pParse->aNode = pNew;
  165263. assert( pParse->nNode<pParse->nAlloc );
  165264. return jsonParseAddNode(pParse, eType, n, zContent);
  165265. }
  165266. /*
  165267. ** Create a new JsonNode instance based on the arguments and append that
  165268. ** instance to the JsonParse. Return the index in pParse->aNode[] of the
  165269. ** new node, or -1 if a memory allocation fails.
  165270. */
  165271. static int jsonParseAddNode(
  165272. JsonParse *pParse, /* Append the node to this object */
  165273. u32 eType, /* Node type */
  165274. u32 n, /* Content size or sub-node count */
  165275. const char *zContent /* Content */
  165276. ){
  165277. JsonNode *p;
  165278. if( pParse->nNode>=pParse->nAlloc ){
  165279. return jsonParseAddNodeExpand(pParse, eType, n, zContent);
  165280. }
  165281. p = &pParse->aNode[pParse->nNode];
  165282. p->eType = (u8)eType;
  165283. p->jnFlags = 0;
  165284. p->iVal = 0;
  165285. p->n = n;
  165286. p->u.zJContent = zContent;
  165287. return pParse->nNode++;
  165288. }
  165289. /*
  165290. ** Parse a single JSON value which begins at pParse->zJson[i]. Return the
  165291. ** index of the first character past the end of the value parsed.
  165292. **
  165293. ** Return negative for a syntax error. Special cases: return -2 if the
  165294. ** first non-whitespace character is '}' and return -3 if the first
  165295. ** non-whitespace character is ']'.
  165296. */
  165297. static int jsonParseValue(JsonParse *pParse, u32 i){
  165298. char c;
  165299. u32 j;
  165300. int iThis;
  165301. int x;
  165302. JsonNode *pNode;
  165303. while( safe_isspace(pParse->zJson[i]) ){ i++; }
  165304. if( (c = pParse->zJson[i])=='{' ){
  165305. /* Parse object */
  165306. iThis = jsonParseAddNode(pParse, JSON_OBJECT, 0, 0);
  165307. if( iThis<0 ) return -1;
  165308. for(j=i+1;;j++){
  165309. while( safe_isspace(pParse->zJson[j]) ){ j++; }
  165310. x = jsonParseValue(pParse, j);
  165311. if( x<0 ){
  165312. if( x==(-2) && pParse->nNode==(u32)iThis+1 ) return j+1;
  165313. return -1;
  165314. }
  165315. if( pParse->oom ) return -1;
  165316. pNode = &pParse->aNode[pParse->nNode-1];
  165317. if( pNode->eType!=JSON_STRING ) return -1;
  165318. pNode->jnFlags |= JNODE_LABEL;
  165319. j = x;
  165320. while( safe_isspace(pParse->zJson[j]) ){ j++; }
  165321. if( pParse->zJson[j]!=':' ) return -1;
  165322. j++;
  165323. x = jsonParseValue(pParse, j);
  165324. if( x<0 ) return -1;
  165325. j = x;
  165326. while( safe_isspace(pParse->zJson[j]) ){ j++; }
  165327. c = pParse->zJson[j];
  165328. if( c==',' ) continue;
  165329. if( c!='}' ) return -1;
  165330. break;
  165331. }
  165332. pParse->aNode[iThis].n = pParse->nNode - (u32)iThis - 1;
  165333. return j+1;
  165334. }else if( c=='[' ){
  165335. /* Parse array */
  165336. iThis = jsonParseAddNode(pParse, JSON_ARRAY, 0, 0);
  165337. if( iThis<0 ) return -1;
  165338. for(j=i+1;;j++){
  165339. while( safe_isspace(pParse->zJson[j]) ){ j++; }
  165340. x = jsonParseValue(pParse, j);
  165341. if( x<0 ){
  165342. if( x==(-3) && pParse->nNode==(u32)iThis+1 ) return j+1;
  165343. return -1;
  165344. }
  165345. j = x;
  165346. while( safe_isspace(pParse->zJson[j]) ){ j++; }
  165347. c = pParse->zJson[j];
  165348. if( c==',' ) continue;
  165349. if( c!=']' ) return -1;
  165350. break;
  165351. }
  165352. pParse->aNode[iThis].n = pParse->nNode - (u32)iThis - 1;
  165353. return j+1;
  165354. }else if( c=='"' ){
  165355. /* Parse string */
  165356. u8 jnFlags = 0;
  165357. j = i+1;
  165358. for(;;){
  165359. c = pParse->zJson[j];
  165360. if( c==0 ) return -1;
  165361. if( c=='\\' ){
  165362. c = pParse->zJson[++j];
  165363. if( c==0 ) return -1;
  165364. jnFlags = JNODE_ESCAPE;
  165365. }else if( c=='"' ){
  165366. break;
  165367. }
  165368. j++;
  165369. }
  165370. jsonParseAddNode(pParse, JSON_STRING, j+1-i, &pParse->zJson[i]);
  165371. if( !pParse->oom ) pParse->aNode[pParse->nNode-1].jnFlags = jnFlags;
  165372. return j+1;
  165373. }else if( c=='n'
  165374. && strncmp(pParse->zJson+i,"null",4)==0
  165375. && !safe_isalnum(pParse->zJson[i+4]) ){
  165376. jsonParseAddNode(pParse, JSON_NULL, 0, 0);
  165377. return i+4;
  165378. }else if( c=='t'
  165379. && strncmp(pParse->zJson+i,"true",4)==0
  165380. && !safe_isalnum(pParse->zJson[i+4]) ){
  165381. jsonParseAddNode(pParse, JSON_TRUE, 0, 0);
  165382. return i+4;
  165383. }else if( c=='f'
  165384. && strncmp(pParse->zJson+i,"false",5)==0
  165385. && !safe_isalnum(pParse->zJson[i+5]) ){
  165386. jsonParseAddNode(pParse, JSON_FALSE, 0, 0);
  165387. return i+5;
  165388. }else if( c=='-' || (c>='0' && c<='9') ){
  165389. /* Parse number */
  165390. u8 seenDP = 0;
  165391. u8 seenE = 0;
  165392. j = i+1;
  165393. for(;; j++){
  165394. c = pParse->zJson[j];
  165395. if( c>='0' && c<='9' ) continue;
  165396. if( c=='.' ){
  165397. if( pParse->zJson[j-1]=='-' ) return -1;
  165398. if( seenDP ) return -1;
  165399. seenDP = 1;
  165400. continue;
  165401. }
  165402. if( c=='e' || c=='E' ){
  165403. if( pParse->zJson[j-1]<'0' ) return -1;
  165404. if( seenE ) return -1;
  165405. seenDP = seenE = 1;
  165406. c = pParse->zJson[j+1];
  165407. if( c=='+' || c=='-' ){
  165408. j++;
  165409. c = pParse->zJson[j+1];
  165410. }
  165411. if( c<'0' || c>'9' ) return -1;
  165412. continue;
  165413. }
  165414. break;
  165415. }
  165416. if( pParse->zJson[j-1]<'0' ) return -1;
  165417. jsonParseAddNode(pParse, seenDP ? JSON_REAL : JSON_INT,
  165418. j - i, &pParse->zJson[i]);
  165419. return j;
  165420. }else if( c=='}' ){
  165421. return -2; /* End of {...} */
  165422. }else if( c==']' ){
  165423. return -3; /* End of [...] */
  165424. }else if( c==0 ){
  165425. return 0; /* End of file */
  165426. }else{
  165427. return -1; /* Syntax error */
  165428. }
  165429. }
  165430. /*
  165431. ** Parse a complete JSON string. Return 0 on success or non-zero if there
  165432. ** are any errors. If an error occurs, free all memory associated with
  165433. ** pParse.
  165434. **
  165435. ** pParse is uninitialized when this routine is called.
  165436. */
  165437. static int jsonParse(
  165438. JsonParse *pParse, /* Initialize and fill this JsonParse object */
  165439. sqlite3_context *pCtx, /* Report errors here */
  165440. const char *zJson /* Input JSON text to be parsed */
  165441. ){
  165442. int i;
  165443. memset(pParse, 0, sizeof(*pParse));
  165444. if( zJson==0 ) return 1;
  165445. pParse->zJson = zJson;
  165446. i = jsonParseValue(pParse, 0);
  165447. if( pParse->oom ) i = -1;
  165448. if( i>0 ){
  165449. while( safe_isspace(zJson[i]) ) i++;
  165450. if( zJson[i] ) i = -1;
  165451. }
  165452. if( i<=0 ){
  165453. if( pCtx!=0 ){
  165454. if( pParse->oom ){
  165455. sqlite3_result_error_nomem(pCtx);
  165456. }else{
  165457. sqlite3_result_error(pCtx, "malformed JSON", -1);
  165458. }
  165459. }
  165460. jsonParseReset(pParse);
  165461. return 1;
  165462. }
  165463. return 0;
  165464. }
  165465. /* Mark node i of pParse as being a child of iParent. Call recursively
  165466. ** to fill in all the descendants of node i.
  165467. */
  165468. static void jsonParseFillInParentage(JsonParse *pParse, u32 i, u32 iParent){
  165469. JsonNode *pNode = &pParse->aNode[i];
  165470. u32 j;
  165471. pParse->aUp[i] = iParent;
  165472. switch( pNode->eType ){
  165473. case JSON_ARRAY: {
  165474. for(j=1; j<=pNode->n; j += jsonNodeSize(pNode+j)){
  165475. jsonParseFillInParentage(pParse, i+j, i);
  165476. }
  165477. break;
  165478. }
  165479. case JSON_OBJECT: {
  165480. for(j=1; j<=pNode->n; j += jsonNodeSize(pNode+j+1)+1){
  165481. pParse->aUp[i+j] = i;
  165482. jsonParseFillInParentage(pParse, i+j+1, i);
  165483. }
  165484. break;
  165485. }
  165486. default: {
  165487. break;
  165488. }
  165489. }
  165490. }
  165491. /*
  165492. ** Compute the parentage of all nodes in a completed parse.
  165493. */
  165494. static int jsonParseFindParents(JsonParse *pParse){
  165495. u32 *aUp;
  165496. assert( pParse->aUp==0 );
  165497. aUp = pParse->aUp = sqlite3_malloc( sizeof(u32)*pParse->nNode );
  165498. if( aUp==0 ){
  165499. pParse->oom = 1;
  165500. return SQLITE_NOMEM;
  165501. }
  165502. jsonParseFillInParentage(pParse, 0, 0);
  165503. return SQLITE_OK;
  165504. }
  165505. /*
  165506. ** Compare the OBJECT label at pNode against zKey,nKey. Return true on
  165507. ** a match.
  165508. */
  165509. static int jsonLabelCompare(JsonNode *pNode, const char *zKey, u32 nKey){
  165510. if( pNode->jnFlags & JNODE_RAW ){
  165511. if( pNode->n!=nKey ) return 0;
  165512. return strncmp(pNode->u.zJContent, zKey, nKey)==0;
  165513. }else{
  165514. if( pNode->n!=nKey+2 ) return 0;
  165515. return strncmp(pNode->u.zJContent+1, zKey, nKey)==0;
  165516. }
  165517. }
  165518. /* forward declaration */
  165519. static JsonNode *jsonLookupAppend(JsonParse*,const char*,int*,const char**);
  165520. /*
  165521. ** Search along zPath to find the node specified. Return a pointer
  165522. ** to that node, or NULL if zPath is malformed or if there is no such
  165523. ** node.
  165524. **
  165525. ** If pApnd!=0, then try to append new nodes to complete zPath if it is
  165526. ** possible to do so and if no existing node corresponds to zPath. If
  165527. ** new nodes are appended *pApnd is set to 1.
  165528. */
  165529. static JsonNode *jsonLookupStep(
  165530. JsonParse *pParse, /* The JSON to search */
  165531. u32 iRoot, /* Begin the search at this node */
  165532. const char *zPath, /* The path to search */
  165533. int *pApnd, /* Append nodes to complete path if not NULL */
  165534. const char **pzErr /* Make *pzErr point to any syntax error in zPath */
  165535. ){
  165536. u32 i, j, nKey;
  165537. const char *zKey;
  165538. JsonNode *pRoot = &pParse->aNode[iRoot];
  165539. if( zPath[0]==0 ) return pRoot;
  165540. if( zPath[0]=='.' ){
  165541. if( pRoot->eType!=JSON_OBJECT ) return 0;
  165542. zPath++;
  165543. if( zPath[0]=='"' ){
  165544. zKey = zPath + 1;
  165545. for(i=1; zPath[i] && zPath[i]!='"'; i++){}
  165546. nKey = i-1;
  165547. if( zPath[i] ){
  165548. i++;
  165549. }else{
  165550. *pzErr = zPath;
  165551. return 0;
  165552. }
  165553. }else{
  165554. zKey = zPath;
  165555. for(i=0; zPath[i] && zPath[i]!='.' && zPath[i]!='['; i++){}
  165556. nKey = i;
  165557. }
  165558. if( nKey==0 ){
  165559. *pzErr = zPath;
  165560. return 0;
  165561. }
  165562. j = 1;
  165563. for(;;){
  165564. while( j<=pRoot->n ){
  165565. if( jsonLabelCompare(pRoot+j, zKey, nKey) ){
  165566. return jsonLookupStep(pParse, iRoot+j+1, &zPath[i], pApnd, pzErr);
  165567. }
  165568. j++;
  165569. j += jsonNodeSize(&pRoot[j]);
  165570. }
  165571. if( (pRoot->jnFlags & JNODE_APPEND)==0 ) break;
  165572. iRoot += pRoot->u.iAppend;
  165573. pRoot = &pParse->aNode[iRoot];
  165574. j = 1;
  165575. }
  165576. if( pApnd ){
  165577. u32 iStart, iLabel;
  165578. JsonNode *pNode;
  165579. iStart = jsonParseAddNode(pParse, JSON_OBJECT, 2, 0);
  165580. iLabel = jsonParseAddNode(pParse, JSON_STRING, i, zPath);
  165581. zPath += i;
  165582. pNode = jsonLookupAppend(pParse, zPath, pApnd, pzErr);
  165583. if( pParse->oom ) return 0;
  165584. if( pNode ){
  165585. pRoot = &pParse->aNode[iRoot];
  165586. pRoot->u.iAppend = iStart - iRoot;
  165587. pRoot->jnFlags |= JNODE_APPEND;
  165588. pParse->aNode[iLabel].jnFlags |= JNODE_RAW;
  165589. }
  165590. return pNode;
  165591. }
  165592. }else if( zPath[0]=='[' && safe_isdigit(zPath[1]) ){
  165593. if( pRoot->eType!=JSON_ARRAY ) return 0;
  165594. i = 0;
  165595. j = 1;
  165596. while( safe_isdigit(zPath[j]) ){
  165597. i = i*10 + zPath[j] - '0';
  165598. j++;
  165599. }
  165600. if( zPath[j]!=']' ){
  165601. *pzErr = zPath;
  165602. return 0;
  165603. }
  165604. zPath += j + 1;
  165605. j = 1;
  165606. for(;;){
  165607. while( j<=pRoot->n && (i>0 || (pRoot[j].jnFlags & JNODE_REMOVE)!=0) ){
  165608. if( (pRoot[j].jnFlags & JNODE_REMOVE)==0 ) i--;
  165609. j += jsonNodeSize(&pRoot[j]);
  165610. }
  165611. if( (pRoot->jnFlags & JNODE_APPEND)==0 ) break;
  165612. iRoot += pRoot->u.iAppend;
  165613. pRoot = &pParse->aNode[iRoot];
  165614. j = 1;
  165615. }
  165616. if( j<=pRoot->n ){
  165617. return jsonLookupStep(pParse, iRoot+j, zPath, pApnd, pzErr);
  165618. }
  165619. if( i==0 && pApnd ){
  165620. u32 iStart;
  165621. JsonNode *pNode;
  165622. iStart = jsonParseAddNode(pParse, JSON_ARRAY, 1, 0);
  165623. pNode = jsonLookupAppend(pParse, zPath, pApnd, pzErr);
  165624. if( pParse->oom ) return 0;
  165625. if( pNode ){
  165626. pRoot = &pParse->aNode[iRoot];
  165627. pRoot->u.iAppend = iStart - iRoot;
  165628. pRoot->jnFlags |= JNODE_APPEND;
  165629. }
  165630. return pNode;
  165631. }
  165632. }else{
  165633. *pzErr = zPath;
  165634. }
  165635. return 0;
  165636. }
  165637. /*
  165638. ** Append content to pParse that will complete zPath. Return a pointer
  165639. ** to the inserted node, or return NULL if the append fails.
  165640. */
  165641. static JsonNode *jsonLookupAppend(
  165642. JsonParse *pParse, /* Append content to the JSON parse */
  165643. const char *zPath, /* Description of content to append */
  165644. int *pApnd, /* Set this flag to 1 */
  165645. const char **pzErr /* Make this point to any syntax error */
  165646. ){
  165647. *pApnd = 1;
  165648. if( zPath[0]==0 ){
  165649. jsonParseAddNode(pParse, JSON_NULL, 0, 0);
  165650. return pParse->oom ? 0 : &pParse->aNode[pParse->nNode-1];
  165651. }
  165652. if( zPath[0]=='.' ){
  165653. jsonParseAddNode(pParse, JSON_OBJECT, 0, 0);
  165654. }else if( strncmp(zPath,"[0]",3)==0 ){
  165655. jsonParseAddNode(pParse, JSON_ARRAY, 0, 0);
  165656. }else{
  165657. return 0;
  165658. }
  165659. if( pParse->oom ) return 0;
  165660. return jsonLookupStep(pParse, pParse->nNode-1, zPath, pApnd, pzErr);
  165661. }
  165662. /*
  165663. ** Return the text of a syntax error message on a JSON path. Space is
  165664. ** obtained from sqlite3_malloc().
  165665. */
  165666. static char *jsonPathSyntaxError(const char *zErr){
  165667. return sqlite3_mprintf("JSON path error near '%q'", zErr);
  165668. }
  165669. /*
  165670. ** Do a node lookup using zPath. Return a pointer to the node on success.
  165671. ** Return NULL if not found or if there is an error.
  165672. **
  165673. ** On an error, write an error message into pCtx and increment the
  165674. ** pParse->nErr counter.
  165675. **
  165676. ** If pApnd!=NULL then try to append missing nodes and set *pApnd = 1 if
  165677. ** nodes are appended.
  165678. */
  165679. static JsonNode *jsonLookup(
  165680. JsonParse *pParse, /* The JSON to search */
  165681. const char *zPath, /* The path to search */
  165682. int *pApnd, /* Append nodes to complete path if not NULL */
  165683. sqlite3_context *pCtx /* Report errors here, if not NULL */
  165684. ){
  165685. const char *zErr = 0;
  165686. JsonNode *pNode = 0;
  165687. char *zMsg;
  165688. if( zPath==0 ) return 0;
  165689. if( zPath[0]!='$' ){
  165690. zErr = zPath;
  165691. goto lookup_err;
  165692. }
  165693. zPath++;
  165694. pNode = jsonLookupStep(pParse, 0, zPath, pApnd, &zErr);
  165695. if( zErr==0 ) return pNode;
  165696. lookup_err:
  165697. pParse->nErr++;
  165698. assert( zErr!=0 && pCtx!=0 );
  165699. zMsg = jsonPathSyntaxError(zErr);
  165700. if( zMsg ){
  165701. sqlite3_result_error(pCtx, zMsg, -1);
  165702. sqlite3_free(zMsg);
  165703. }else{
  165704. sqlite3_result_error_nomem(pCtx);
  165705. }
  165706. return 0;
  165707. }
  165708. /*
  165709. ** Report the wrong number of arguments for json_insert(), json_replace()
  165710. ** or json_set().
  165711. */
  165712. static void jsonWrongNumArgs(
  165713. sqlite3_context *pCtx,
  165714. const char *zFuncName
  165715. ){
  165716. char *zMsg = sqlite3_mprintf("json_%s() needs an odd number of arguments",
  165717. zFuncName);
  165718. sqlite3_result_error(pCtx, zMsg, -1);
  165719. sqlite3_free(zMsg);
  165720. }
  165721. /****************************************************************************
  165722. ** SQL functions used for testing and debugging
  165723. ****************************************************************************/
  165724. #ifdef SQLITE_DEBUG
  165725. /*
  165726. ** The json_parse(JSON) function returns a string which describes
  165727. ** a parse of the JSON provided. Or it returns NULL if JSON is not
  165728. ** well-formed.
  165729. */
  165730. static void jsonParseFunc(
  165731. sqlite3_context *ctx,
  165732. int argc,
  165733. sqlite3_value **argv
  165734. ){
  165735. JsonString s; /* Output string - not real JSON */
  165736. JsonParse x; /* The parse */
  165737. u32 i;
  165738. assert( argc==1 );
  165739. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  165740. jsonParseFindParents(&x);
  165741. jsonInit(&s, ctx);
  165742. for(i=0; i<x.nNode; i++){
  165743. const char *zType;
  165744. if( x.aNode[i].jnFlags & JNODE_LABEL ){
  165745. assert( x.aNode[i].eType==JSON_STRING );
  165746. zType = "label";
  165747. }else{
  165748. zType = jsonType[x.aNode[i].eType];
  165749. }
  165750. jsonPrintf(100, &s,"node %3u: %7s n=%-4d up=%-4d",
  165751. i, zType, x.aNode[i].n, x.aUp[i]);
  165752. if( x.aNode[i].u.zJContent!=0 ){
  165753. jsonAppendRaw(&s, " ", 1);
  165754. jsonAppendRaw(&s, x.aNode[i].u.zJContent, x.aNode[i].n);
  165755. }
  165756. jsonAppendRaw(&s, "\n", 1);
  165757. }
  165758. jsonParseReset(&x);
  165759. jsonResult(&s);
  165760. }
  165761. /*
  165762. ** The json_test1(JSON) function return true (1) if the input is JSON
  165763. ** text generated by another json function. It returns (0) if the input
  165764. ** is not known to be JSON.
  165765. */
  165766. static void jsonTest1Func(
  165767. sqlite3_context *ctx,
  165768. int argc,
  165769. sqlite3_value **argv
  165770. ){
  165771. UNUSED_PARAM(argc);
  165772. sqlite3_result_int(ctx, sqlite3_value_subtype(argv[0])==JSON_SUBTYPE);
  165773. }
  165774. #endif /* SQLITE_DEBUG */
  165775. /****************************************************************************
  165776. ** Scalar SQL function implementations
  165777. ****************************************************************************/
  165778. /*
  165779. ** Implementation of the json_QUOTE(VALUE) function. Return a JSON value
  165780. ** corresponding to the SQL value input. Mostly this means putting
  165781. ** double-quotes around strings and returning the unquoted string "null"
  165782. ** when given a NULL input.
  165783. */
  165784. static void jsonQuoteFunc(
  165785. sqlite3_context *ctx,
  165786. int argc,
  165787. sqlite3_value **argv
  165788. ){
  165789. JsonString jx;
  165790. UNUSED_PARAM(argc);
  165791. jsonInit(&jx, ctx);
  165792. jsonAppendValue(&jx, argv[0]);
  165793. jsonResult(&jx);
  165794. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  165795. }
  165796. /*
  165797. ** Implementation of the json_array(VALUE,...) function. Return a JSON
  165798. ** array that contains all values given in arguments. Or if any argument
  165799. ** is a BLOB, throw an error.
  165800. */
  165801. static void jsonArrayFunc(
  165802. sqlite3_context *ctx,
  165803. int argc,
  165804. sqlite3_value **argv
  165805. ){
  165806. int i;
  165807. JsonString jx;
  165808. jsonInit(&jx, ctx);
  165809. jsonAppendChar(&jx, '[');
  165810. for(i=0; i<argc; i++){
  165811. jsonAppendSeparator(&jx);
  165812. jsonAppendValue(&jx, argv[i]);
  165813. }
  165814. jsonAppendChar(&jx, ']');
  165815. jsonResult(&jx);
  165816. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  165817. }
  165818. /*
  165819. ** json_array_length(JSON)
  165820. ** json_array_length(JSON, PATH)
  165821. **
  165822. ** Return the number of elements in the top-level JSON array.
  165823. ** Return 0 if the input is not a well-formed JSON array.
  165824. */
  165825. static void jsonArrayLengthFunc(
  165826. sqlite3_context *ctx,
  165827. int argc,
  165828. sqlite3_value **argv
  165829. ){
  165830. JsonParse x; /* The parse */
  165831. sqlite3_int64 n = 0;
  165832. u32 i;
  165833. JsonNode *pNode;
  165834. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  165835. assert( x.nNode );
  165836. if( argc==2 ){
  165837. const char *zPath = (const char*)sqlite3_value_text(argv[1]);
  165838. pNode = jsonLookup(&x, zPath, 0, ctx);
  165839. }else{
  165840. pNode = x.aNode;
  165841. }
  165842. if( pNode==0 ){
  165843. x.nErr = 1;
  165844. }else if( pNode->eType==JSON_ARRAY ){
  165845. assert( (pNode->jnFlags & JNODE_APPEND)==0 );
  165846. for(i=1; i<=pNode->n; n++){
  165847. i += jsonNodeSize(&pNode[i]);
  165848. }
  165849. }
  165850. if( x.nErr==0 ) sqlite3_result_int64(ctx, n);
  165851. jsonParseReset(&x);
  165852. }
  165853. /*
  165854. ** json_extract(JSON, PATH, ...)
  165855. **
  165856. ** Return the element described by PATH. Return NULL if there is no
  165857. ** PATH element. If there are multiple PATHs, then return a JSON array
  165858. ** with the result from each path. Throw an error if the JSON or any PATH
  165859. ** is malformed.
  165860. */
  165861. static void jsonExtractFunc(
  165862. sqlite3_context *ctx,
  165863. int argc,
  165864. sqlite3_value **argv
  165865. ){
  165866. JsonParse x; /* The parse */
  165867. JsonNode *pNode;
  165868. const char *zPath;
  165869. JsonString jx;
  165870. int i;
  165871. if( argc<2 ) return;
  165872. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  165873. jsonInit(&jx, ctx);
  165874. jsonAppendChar(&jx, '[');
  165875. for(i=1; i<argc; i++){
  165876. zPath = (const char*)sqlite3_value_text(argv[i]);
  165877. pNode = jsonLookup(&x, zPath, 0, ctx);
  165878. if( x.nErr ) break;
  165879. if( argc>2 ){
  165880. jsonAppendSeparator(&jx);
  165881. if( pNode ){
  165882. jsonRenderNode(pNode, &jx, 0);
  165883. }else{
  165884. jsonAppendRaw(&jx, "null", 4);
  165885. }
  165886. }else if( pNode ){
  165887. jsonReturn(pNode, ctx, 0);
  165888. }
  165889. }
  165890. if( argc>2 && i==argc ){
  165891. jsonAppendChar(&jx, ']');
  165892. jsonResult(&jx);
  165893. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  165894. }
  165895. jsonReset(&jx);
  165896. jsonParseReset(&x);
  165897. }
  165898. /*
  165899. ** Implementation of the json_object(NAME,VALUE,...) function. Return a JSON
  165900. ** object that contains all name/value given in arguments. Or if any name
  165901. ** is not a string or if any value is a BLOB, throw an error.
  165902. */
  165903. static void jsonObjectFunc(
  165904. sqlite3_context *ctx,
  165905. int argc,
  165906. sqlite3_value **argv
  165907. ){
  165908. int i;
  165909. JsonString jx;
  165910. const char *z;
  165911. u32 n;
  165912. if( argc&1 ){
  165913. sqlite3_result_error(ctx, "json_object() requires an even number "
  165914. "of arguments", -1);
  165915. return;
  165916. }
  165917. jsonInit(&jx, ctx);
  165918. jsonAppendChar(&jx, '{');
  165919. for(i=0; i<argc; i+=2){
  165920. if( sqlite3_value_type(argv[i])!=SQLITE_TEXT ){
  165921. sqlite3_result_error(ctx, "json_object() labels must be TEXT", -1);
  165922. jsonReset(&jx);
  165923. return;
  165924. }
  165925. jsonAppendSeparator(&jx);
  165926. z = (const char*)sqlite3_value_text(argv[i]);
  165927. n = (u32)sqlite3_value_bytes(argv[i]);
  165928. jsonAppendString(&jx, z, n);
  165929. jsonAppendChar(&jx, ':');
  165930. jsonAppendValue(&jx, argv[i+1]);
  165931. }
  165932. jsonAppendChar(&jx, '}');
  165933. jsonResult(&jx);
  165934. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  165935. }
  165936. /*
  165937. ** json_remove(JSON, PATH, ...)
  165938. **
  165939. ** Remove the named elements from JSON and return the result. malformed
  165940. ** JSON or PATH arguments result in an error.
  165941. */
  165942. static void jsonRemoveFunc(
  165943. sqlite3_context *ctx,
  165944. int argc,
  165945. sqlite3_value **argv
  165946. ){
  165947. JsonParse x; /* The parse */
  165948. JsonNode *pNode;
  165949. const char *zPath;
  165950. u32 i;
  165951. if( argc<1 ) return;
  165952. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  165953. assert( x.nNode );
  165954. for(i=1; i<(u32)argc; i++){
  165955. zPath = (const char*)sqlite3_value_text(argv[i]);
  165956. if( zPath==0 ) goto remove_done;
  165957. pNode = jsonLookup(&x, zPath, 0, ctx);
  165958. if( x.nErr ) goto remove_done;
  165959. if( pNode ) pNode->jnFlags |= JNODE_REMOVE;
  165960. }
  165961. if( (x.aNode[0].jnFlags & JNODE_REMOVE)==0 ){
  165962. jsonReturnJson(x.aNode, ctx, 0);
  165963. }
  165964. remove_done:
  165965. jsonParseReset(&x);
  165966. }
  165967. /*
  165968. ** json_replace(JSON, PATH, VALUE, ...)
  165969. **
  165970. ** Replace the value at PATH with VALUE. If PATH does not already exist,
  165971. ** this routine is a no-op. If JSON or PATH is malformed, throw an error.
  165972. */
  165973. static void jsonReplaceFunc(
  165974. sqlite3_context *ctx,
  165975. int argc,
  165976. sqlite3_value **argv
  165977. ){
  165978. JsonParse x; /* The parse */
  165979. JsonNode *pNode;
  165980. const char *zPath;
  165981. u32 i;
  165982. if( argc<1 ) return;
  165983. if( (argc&1)==0 ) {
  165984. jsonWrongNumArgs(ctx, "replace");
  165985. return;
  165986. }
  165987. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  165988. assert( x.nNode );
  165989. for(i=1; i<(u32)argc; i+=2){
  165990. zPath = (const char*)sqlite3_value_text(argv[i]);
  165991. pNode = jsonLookup(&x, zPath, 0, ctx);
  165992. if( x.nErr ) goto replace_err;
  165993. if( pNode ){
  165994. pNode->jnFlags |= (u8)JNODE_REPLACE;
  165995. pNode->iVal = (u8)(i+1);
  165996. }
  165997. }
  165998. if( x.aNode[0].jnFlags & JNODE_REPLACE ){
  165999. sqlite3_result_value(ctx, argv[x.aNode[0].iVal]);
  166000. }else{
  166001. jsonReturnJson(x.aNode, ctx, argv);
  166002. }
  166003. replace_err:
  166004. jsonParseReset(&x);
  166005. }
  166006. /*
  166007. ** json_set(JSON, PATH, VALUE, ...)
  166008. **
  166009. ** Set the value at PATH to VALUE. Create the PATH if it does not already
  166010. ** exist. Overwrite existing values that do exist.
  166011. ** If JSON or PATH is malformed, throw an error.
  166012. **
  166013. ** json_insert(JSON, PATH, VALUE, ...)
  166014. **
  166015. ** Create PATH and initialize it to VALUE. If PATH already exists, this
  166016. ** routine is a no-op. If JSON or PATH is malformed, throw an error.
  166017. */
  166018. static void jsonSetFunc(
  166019. sqlite3_context *ctx,
  166020. int argc,
  166021. sqlite3_value **argv
  166022. ){
  166023. JsonParse x; /* The parse */
  166024. JsonNode *pNode;
  166025. const char *zPath;
  166026. u32 i;
  166027. int bApnd;
  166028. int bIsSet = *(int*)sqlite3_user_data(ctx);
  166029. if( argc<1 ) return;
  166030. if( (argc&1)==0 ) {
  166031. jsonWrongNumArgs(ctx, bIsSet ? "set" : "insert");
  166032. return;
  166033. }
  166034. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  166035. assert( x.nNode );
  166036. for(i=1; i<(u32)argc; i+=2){
  166037. zPath = (const char*)sqlite3_value_text(argv[i]);
  166038. bApnd = 0;
  166039. pNode = jsonLookup(&x, zPath, &bApnd, ctx);
  166040. if( x.oom ){
  166041. sqlite3_result_error_nomem(ctx);
  166042. goto jsonSetDone;
  166043. }else if( x.nErr ){
  166044. goto jsonSetDone;
  166045. }else if( pNode && (bApnd || bIsSet) ){
  166046. pNode->jnFlags |= (u8)JNODE_REPLACE;
  166047. pNode->iVal = (u8)(i+1);
  166048. }
  166049. }
  166050. if( x.aNode[0].jnFlags & JNODE_REPLACE ){
  166051. sqlite3_result_value(ctx, argv[x.aNode[0].iVal]);
  166052. }else{
  166053. jsonReturnJson(x.aNode, ctx, argv);
  166054. }
  166055. jsonSetDone:
  166056. jsonParseReset(&x);
  166057. }
  166058. /*
  166059. ** json_type(JSON)
  166060. ** json_type(JSON, PATH)
  166061. **
  166062. ** Return the top-level "type" of a JSON string. Throw an error if
  166063. ** either the JSON or PATH inputs are not well-formed.
  166064. */
  166065. static void jsonTypeFunc(
  166066. sqlite3_context *ctx,
  166067. int argc,
  166068. sqlite3_value **argv
  166069. ){
  166070. JsonParse x; /* The parse */
  166071. const char *zPath;
  166072. JsonNode *pNode;
  166073. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  166074. assert( x.nNode );
  166075. if( argc==2 ){
  166076. zPath = (const char*)sqlite3_value_text(argv[1]);
  166077. pNode = jsonLookup(&x, zPath, 0, ctx);
  166078. }else{
  166079. pNode = x.aNode;
  166080. }
  166081. if( pNode ){
  166082. sqlite3_result_text(ctx, jsonType[pNode->eType], -1, SQLITE_STATIC);
  166083. }
  166084. jsonParseReset(&x);
  166085. }
  166086. /*
  166087. ** json_valid(JSON)
  166088. **
  166089. ** Return 1 if JSON is a well-formed JSON string according to RFC-7159.
  166090. ** Return 0 otherwise.
  166091. */
  166092. static void jsonValidFunc(
  166093. sqlite3_context *ctx,
  166094. int argc,
  166095. sqlite3_value **argv
  166096. ){
  166097. JsonParse x; /* The parse */
  166098. int rc = 0;
  166099. UNUSED_PARAM(argc);
  166100. if( jsonParse(&x, 0, (const char*)sqlite3_value_text(argv[0]))==0 ){
  166101. rc = 1;
  166102. }
  166103. jsonParseReset(&x);
  166104. sqlite3_result_int(ctx, rc);
  166105. }
  166106. /****************************************************************************
  166107. ** Aggregate SQL function implementations
  166108. ****************************************************************************/
  166109. /*
  166110. ** json_group_array(VALUE)
  166111. **
  166112. ** Return a JSON array composed of all values in the aggregate.
  166113. */
  166114. static void jsonArrayStep(
  166115. sqlite3_context *ctx,
  166116. int argc,
  166117. sqlite3_value **argv
  166118. ){
  166119. JsonString *pStr;
  166120. UNUSED_PARAM(argc);
  166121. pStr = (JsonString*)sqlite3_aggregate_context(ctx, sizeof(*pStr));
  166122. if( pStr ){
  166123. if( pStr->zBuf==0 ){
  166124. jsonInit(pStr, ctx);
  166125. jsonAppendChar(pStr, '[');
  166126. }else{
  166127. jsonAppendChar(pStr, ',');
  166128. pStr->pCtx = ctx;
  166129. }
  166130. jsonAppendValue(pStr, argv[0]);
  166131. }
  166132. }
  166133. static void jsonArrayFinal(sqlite3_context *ctx){
  166134. JsonString *pStr;
  166135. pStr = (JsonString*)sqlite3_aggregate_context(ctx, 0);
  166136. if( pStr ){
  166137. pStr->pCtx = ctx;
  166138. jsonAppendChar(pStr, ']');
  166139. if( pStr->bErr ){
  166140. if( pStr->bErr==1 ) sqlite3_result_error_nomem(ctx);
  166141. assert( pStr->bStatic );
  166142. }else{
  166143. sqlite3_result_text(ctx, pStr->zBuf, pStr->nUsed,
  166144. pStr->bStatic ? SQLITE_TRANSIENT : sqlite3_free);
  166145. pStr->bStatic = 1;
  166146. }
  166147. }else{
  166148. sqlite3_result_text(ctx, "[]", 2, SQLITE_STATIC);
  166149. }
  166150. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  166151. }
  166152. /*
  166153. ** json_group_obj(NAME,VALUE)
  166154. **
  166155. ** Return a JSON object composed of all names and values in the aggregate.
  166156. */
  166157. static void jsonObjectStep(
  166158. sqlite3_context *ctx,
  166159. int argc,
  166160. sqlite3_value **argv
  166161. ){
  166162. JsonString *pStr;
  166163. const char *z;
  166164. u32 n;
  166165. UNUSED_PARAM(argc);
  166166. pStr = (JsonString*)sqlite3_aggregate_context(ctx, sizeof(*pStr));
  166167. if( pStr ){
  166168. if( pStr->zBuf==0 ){
  166169. jsonInit(pStr, ctx);
  166170. jsonAppendChar(pStr, '{');
  166171. }else{
  166172. jsonAppendChar(pStr, ',');
  166173. pStr->pCtx = ctx;
  166174. }
  166175. z = (const char*)sqlite3_value_text(argv[0]);
  166176. n = (u32)sqlite3_value_bytes(argv[0]);
  166177. jsonAppendString(pStr, z, n);
  166178. jsonAppendChar(pStr, ':');
  166179. jsonAppendValue(pStr, argv[1]);
  166180. }
  166181. }
  166182. static void jsonObjectFinal(sqlite3_context *ctx){
  166183. JsonString *pStr;
  166184. pStr = (JsonString*)sqlite3_aggregate_context(ctx, 0);
  166185. if( pStr ){
  166186. jsonAppendChar(pStr, '}');
  166187. if( pStr->bErr ){
  166188. if( pStr->bErr==0 ) sqlite3_result_error_nomem(ctx);
  166189. assert( pStr->bStatic );
  166190. }else{
  166191. sqlite3_result_text(ctx, pStr->zBuf, pStr->nUsed,
  166192. pStr->bStatic ? SQLITE_TRANSIENT : sqlite3_free);
  166193. pStr->bStatic = 1;
  166194. }
  166195. }else{
  166196. sqlite3_result_text(ctx, "{}", 2, SQLITE_STATIC);
  166197. }
  166198. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  166199. }
  166200. #ifndef SQLITE_OMIT_VIRTUALTABLE
  166201. /****************************************************************************
  166202. ** The json_each virtual table
  166203. ****************************************************************************/
  166204. typedef struct JsonEachCursor JsonEachCursor;
  166205. struct JsonEachCursor {
  166206. sqlite3_vtab_cursor base; /* Base class - must be first */
  166207. u32 iRowid; /* The rowid */
  166208. u32 iBegin; /* The first node of the scan */
  166209. u32 i; /* Index in sParse.aNode[] of current row */
  166210. u32 iEnd; /* EOF when i equals or exceeds this value */
  166211. u8 eType; /* Type of top-level element */
  166212. u8 bRecursive; /* True for json_tree(). False for json_each() */
  166213. char *zJson; /* Input JSON */
  166214. char *zRoot; /* Path by which to filter zJson */
  166215. JsonParse sParse; /* Parse of the input JSON */
  166216. };
  166217. /* Constructor for the json_each virtual table */
  166218. static int jsonEachConnect(
  166219. sqlite3 *db,
  166220. void *pAux,
  166221. int argc, const char *const*argv,
  166222. sqlite3_vtab **ppVtab,
  166223. char **pzErr
  166224. ){
  166225. sqlite3_vtab *pNew;
  166226. int rc;
  166227. /* Column numbers */
  166228. #define JEACH_KEY 0
  166229. #define JEACH_VALUE 1
  166230. #define JEACH_TYPE 2
  166231. #define JEACH_ATOM 3
  166232. #define JEACH_ID 4
  166233. #define JEACH_PARENT 5
  166234. #define JEACH_FULLKEY 6
  166235. #define JEACH_PATH 7
  166236. #define JEACH_JSON 8
  166237. #define JEACH_ROOT 9
  166238. UNUSED_PARAM(pzErr);
  166239. UNUSED_PARAM(argv);
  166240. UNUSED_PARAM(argc);
  166241. UNUSED_PARAM(pAux);
  166242. rc = sqlite3_declare_vtab(db,
  166243. "CREATE TABLE x(key,value,type,atom,id,parent,fullkey,path,"
  166244. "json HIDDEN,root HIDDEN)");
  166245. if( rc==SQLITE_OK ){
  166246. pNew = *ppVtab = sqlite3_malloc( sizeof(*pNew) );
  166247. if( pNew==0 ) return SQLITE_NOMEM;
  166248. memset(pNew, 0, sizeof(*pNew));
  166249. }
  166250. return rc;
  166251. }
  166252. /* destructor for json_each virtual table */
  166253. static int jsonEachDisconnect(sqlite3_vtab *pVtab){
  166254. sqlite3_free(pVtab);
  166255. return SQLITE_OK;
  166256. }
  166257. /* constructor for a JsonEachCursor object for json_each(). */
  166258. static int jsonEachOpenEach(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
  166259. JsonEachCursor *pCur;
  166260. UNUSED_PARAM(p);
  166261. pCur = sqlite3_malloc( sizeof(*pCur) );
  166262. if( pCur==0 ) return SQLITE_NOMEM;
  166263. memset(pCur, 0, sizeof(*pCur));
  166264. *ppCursor = &pCur->base;
  166265. return SQLITE_OK;
  166266. }
  166267. /* constructor for a JsonEachCursor object for json_tree(). */
  166268. static int jsonEachOpenTree(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
  166269. int rc = jsonEachOpenEach(p, ppCursor);
  166270. if( rc==SQLITE_OK ){
  166271. JsonEachCursor *pCur = (JsonEachCursor*)*ppCursor;
  166272. pCur->bRecursive = 1;
  166273. }
  166274. return rc;
  166275. }
  166276. /* Reset a JsonEachCursor back to its original state. Free any memory
  166277. ** held. */
  166278. static void jsonEachCursorReset(JsonEachCursor *p){
  166279. sqlite3_free(p->zJson);
  166280. sqlite3_free(p->zRoot);
  166281. jsonParseReset(&p->sParse);
  166282. p->iRowid = 0;
  166283. p->i = 0;
  166284. p->iEnd = 0;
  166285. p->eType = 0;
  166286. p->zJson = 0;
  166287. p->zRoot = 0;
  166288. }
  166289. /* Destructor for a jsonEachCursor object */
  166290. static int jsonEachClose(sqlite3_vtab_cursor *cur){
  166291. JsonEachCursor *p = (JsonEachCursor*)cur;
  166292. jsonEachCursorReset(p);
  166293. sqlite3_free(cur);
  166294. return SQLITE_OK;
  166295. }
  166296. /* Return TRUE if the jsonEachCursor object has been advanced off the end
  166297. ** of the JSON object */
  166298. static int jsonEachEof(sqlite3_vtab_cursor *cur){
  166299. JsonEachCursor *p = (JsonEachCursor*)cur;
  166300. return p->i >= p->iEnd;
  166301. }
  166302. /* Advance the cursor to the next element for json_tree() */
  166303. static int jsonEachNext(sqlite3_vtab_cursor *cur){
  166304. JsonEachCursor *p = (JsonEachCursor*)cur;
  166305. if( p->bRecursive ){
  166306. if( p->sParse.aNode[p->i].jnFlags & JNODE_LABEL ) p->i++;
  166307. p->i++;
  166308. p->iRowid++;
  166309. if( p->i<p->iEnd ){
  166310. u32 iUp = p->sParse.aUp[p->i];
  166311. JsonNode *pUp = &p->sParse.aNode[iUp];
  166312. p->eType = pUp->eType;
  166313. if( pUp->eType==JSON_ARRAY ){
  166314. if( iUp==p->i-1 ){
  166315. pUp->u.iKey = 0;
  166316. }else{
  166317. pUp->u.iKey++;
  166318. }
  166319. }
  166320. }
  166321. }else{
  166322. switch( p->eType ){
  166323. case JSON_ARRAY: {
  166324. p->i += jsonNodeSize(&p->sParse.aNode[p->i]);
  166325. p->iRowid++;
  166326. break;
  166327. }
  166328. case JSON_OBJECT: {
  166329. p->i += 1 + jsonNodeSize(&p->sParse.aNode[p->i+1]);
  166330. p->iRowid++;
  166331. break;
  166332. }
  166333. default: {
  166334. p->i = p->iEnd;
  166335. break;
  166336. }
  166337. }
  166338. }
  166339. return SQLITE_OK;
  166340. }
  166341. /* Append the name of the path for element i to pStr
  166342. */
  166343. static void jsonEachComputePath(
  166344. JsonEachCursor *p, /* The cursor */
  166345. JsonString *pStr, /* Write the path here */
  166346. u32 i /* Path to this element */
  166347. ){
  166348. JsonNode *pNode, *pUp;
  166349. u32 iUp;
  166350. if( i==0 ){
  166351. jsonAppendChar(pStr, '$');
  166352. return;
  166353. }
  166354. iUp = p->sParse.aUp[i];
  166355. jsonEachComputePath(p, pStr, iUp);
  166356. pNode = &p->sParse.aNode[i];
  166357. pUp = &p->sParse.aNode[iUp];
  166358. if( pUp->eType==JSON_ARRAY ){
  166359. jsonPrintf(30, pStr, "[%d]", pUp->u.iKey);
  166360. }else{
  166361. assert( pUp->eType==JSON_OBJECT );
  166362. if( (pNode->jnFlags & JNODE_LABEL)==0 ) pNode--;
  166363. assert( pNode->eType==JSON_STRING );
  166364. assert( pNode->jnFlags & JNODE_LABEL );
  166365. jsonPrintf(pNode->n+1, pStr, ".%.*s", pNode->n-2, pNode->u.zJContent+1);
  166366. }
  166367. }
  166368. /* Return the value of a column */
  166369. static int jsonEachColumn(
  166370. sqlite3_vtab_cursor *cur, /* The cursor */
  166371. sqlite3_context *ctx, /* First argument to sqlite3_result_...() */
  166372. int i /* Which column to return */
  166373. ){
  166374. JsonEachCursor *p = (JsonEachCursor*)cur;
  166375. JsonNode *pThis = &p->sParse.aNode[p->i];
  166376. switch( i ){
  166377. case JEACH_KEY: {
  166378. if( p->i==0 ) break;
  166379. if( p->eType==JSON_OBJECT ){
  166380. jsonReturn(pThis, ctx, 0);
  166381. }else if( p->eType==JSON_ARRAY ){
  166382. u32 iKey;
  166383. if( p->bRecursive ){
  166384. if( p->iRowid==0 ) break;
  166385. iKey = p->sParse.aNode[p->sParse.aUp[p->i]].u.iKey;
  166386. }else{
  166387. iKey = p->iRowid;
  166388. }
  166389. sqlite3_result_int64(ctx, (sqlite3_int64)iKey);
  166390. }
  166391. break;
  166392. }
  166393. case JEACH_VALUE: {
  166394. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  166395. jsonReturn(pThis, ctx, 0);
  166396. break;
  166397. }
  166398. case JEACH_TYPE: {
  166399. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  166400. sqlite3_result_text(ctx, jsonType[pThis->eType], -1, SQLITE_STATIC);
  166401. break;
  166402. }
  166403. case JEACH_ATOM: {
  166404. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  166405. if( pThis->eType>=JSON_ARRAY ) break;
  166406. jsonReturn(pThis, ctx, 0);
  166407. break;
  166408. }
  166409. case JEACH_ID: {
  166410. sqlite3_result_int64(ctx,
  166411. (sqlite3_int64)p->i + ((pThis->jnFlags & JNODE_LABEL)!=0));
  166412. break;
  166413. }
  166414. case JEACH_PARENT: {
  166415. if( p->i>p->iBegin && p->bRecursive ){
  166416. sqlite3_result_int64(ctx, (sqlite3_int64)p->sParse.aUp[p->i]);
  166417. }
  166418. break;
  166419. }
  166420. case JEACH_FULLKEY: {
  166421. JsonString x;
  166422. jsonInit(&x, ctx);
  166423. if( p->bRecursive ){
  166424. jsonEachComputePath(p, &x, p->i);
  166425. }else{
  166426. if( p->zRoot ){
  166427. jsonAppendRaw(&x, p->zRoot, (int)strlen(p->zRoot));
  166428. }else{
  166429. jsonAppendChar(&x, '$');
  166430. }
  166431. if( p->eType==JSON_ARRAY ){
  166432. jsonPrintf(30, &x, "[%d]", p->iRowid);
  166433. }else{
  166434. jsonPrintf(pThis->n, &x, ".%.*s", pThis->n-2, pThis->u.zJContent+1);
  166435. }
  166436. }
  166437. jsonResult(&x);
  166438. break;
  166439. }
  166440. case JEACH_PATH: {
  166441. if( p->bRecursive ){
  166442. JsonString x;
  166443. jsonInit(&x, ctx);
  166444. jsonEachComputePath(p, &x, p->sParse.aUp[p->i]);
  166445. jsonResult(&x);
  166446. break;
  166447. }
  166448. /* For json_each() path and root are the same so fall through
  166449. ** into the root case */
  166450. }
  166451. case JEACH_ROOT: {
  166452. const char *zRoot = p->zRoot;
  166453. if( zRoot==0 ) zRoot = "$";
  166454. sqlite3_result_text(ctx, zRoot, -1, SQLITE_STATIC);
  166455. break;
  166456. }
  166457. case JEACH_JSON: {
  166458. assert( i==JEACH_JSON );
  166459. sqlite3_result_text(ctx, p->sParse.zJson, -1, SQLITE_STATIC);
  166460. break;
  166461. }
  166462. }
  166463. return SQLITE_OK;
  166464. }
  166465. /* Return the current rowid value */
  166466. static int jsonEachRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){
  166467. JsonEachCursor *p = (JsonEachCursor*)cur;
  166468. *pRowid = p->iRowid;
  166469. return SQLITE_OK;
  166470. }
  166471. /* The query strategy is to look for an equality constraint on the json
  166472. ** column. Without such a constraint, the table cannot operate. idxNum is
  166473. ** 1 if the constraint is found, 3 if the constraint and zRoot are found,
  166474. ** and 0 otherwise.
  166475. */
  166476. static int jsonEachBestIndex(
  166477. sqlite3_vtab *tab,
  166478. sqlite3_index_info *pIdxInfo
  166479. ){
  166480. int i;
  166481. int jsonIdx = -1;
  166482. int rootIdx = -1;
  166483. const struct sqlite3_index_constraint *pConstraint;
  166484. UNUSED_PARAM(tab);
  166485. pConstraint = pIdxInfo->aConstraint;
  166486. for(i=0; i<pIdxInfo->nConstraint; i++, pConstraint++){
  166487. if( pConstraint->usable==0 ) continue;
  166488. if( pConstraint->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  166489. switch( pConstraint->iColumn ){
  166490. case JEACH_JSON: jsonIdx = i; break;
  166491. case JEACH_ROOT: rootIdx = i; break;
  166492. default: /* no-op */ break;
  166493. }
  166494. }
  166495. if( jsonIdx<0 ){
  166496. pIdxInfo->idxNum = 0;
  166497. pIdxInfo->estimatedCost = 1e99;
  166498. }else{
  166499. pIdxInfo->estimatedCost = 1.0;
  166500. pIdxInfo->aConstraintUsage[jsonIdx].argvIndex = 1;
  166501. pIdxInfo->aConstraintUsage[jsonIdx].omit = 1;
  166502. if( rootIdx<0 ){
  166503. pIdxInfo->idxNum = 1;
  166504. }else{
  166505. pIdxInfo->aConstraintUsage[rootIdx].argvIndex = 2;
  166506. pIdxInfo->aConstraintUsage[rootIdx].omit = 1;
  166507. pIdxInfo->idxNum = 3;
  166508. }
  166509. }
  166510. return SQLITE_OK;
  166511. }
  166512. /* Start a search on a new JSON string */
  166513. static int jsonEachFilter(
  166514. sqlite3_vtab_cursor *cur,
  166515. int idxNum, const char *idxStr,
  166516. int argc, sqlite3_value **argv
  166517. ){
  166518. JsonEachCursor *p = (JsonEachCursor*)cur;
  166519. const char *z;
  166520. const char *zRoot = 0;
  166521. sqlite3_int64 n;
  166522. UNUSED_PARAM(idxStr);
  166523. UNUSED_PARAM(argc);
  166524. jsonEachCursorReset(p);
  166525. if( idxNum==0 ) return SQLITE_OK;
  166526. z = (const char*)sqlite3_value_text(argv[0]);
  166527. if( z==0 ) return SQLITE_OK;
  166528. n = sqlite3_value_bytes(argv[0]);
  166529. p->zJson = sqlite3_malloc64( n+1 );
  166530. if( p->zJson==0 ) return SQLITE_NOMEM;
  166531. memcpy(p->zJson, z, (size_t)n+1);
  166532. if( jsonParse(&p->sParse, 0, p->zJson) ){
  166533. int rc = SQLITE_NOMEM;
  166534. if( p->sParse.oom==0 ){
  166535. sqlite3_free(cur->pVtab->zErrMsg);
  166536. cur->pVtab->zErrMsg = sqlite3_mprintf("malformed JSON");
  166537. if( cur->pVtab->zErrMsg ) rc = SQLITE_ERROR;
  166538. }
  166539. jsonEachCursorReset(p);
  166540. return rc;
  166541. }else if( p->bRecursive && jsonParseFindParents(&p->sParse) ){
  166542. jsonEachCursorReset(p);
  166543. return SQLITE_NOMEM;
  166544. }else{
  166545. JsonNode *pNode = 0;
  166546. if( idxNum==3 ){
  166547. const char *zErr = 0;
  166548. zRoot = (const char*)sqlite3_value_text(argv[1]);
  166549. if( zRoot==0 ) return SQLITE_OK;
  166550. n = sqlite3_value_bytes(argv[1]);
  166551. p->zRoot = sqlite3_malloc64( n+1 );
  166552. if( p->zRoot==0 ) return SQLITE_NOMEM;
  166553. memcpy(p->zRoot, zRoot, (size_t)n+1);
  166554. if( zRoot[0]!='$' ){
  166555. zErr = zRoot;
  166556. }else{
  166557. pNode = jsonLookupStep(&p->sParse, 0, p->zRoot+1, 0, &zErr);
  166558. }
  166559. if( zErr ){
  166560. sqlite3_free(cur->pVtab->zErrMsg);
  166561. cur->pVtab->zErrMsg = jsonPathSyntaxError(zErr);
  166562. jsonEachCursorReset(p);
  166563. return cur->pVtab->zErrMsg ? SQLITE_ERROR : SQLITE_NOMEM;
  166564. }else if( pNode==0 ){
  166565. return SQLITE_OK;
  166566. }
  166567. }else{
  166568. pNode = p->sParse.aNode;
  166569. }
  166570. p->iBegin = p->i = (int)(pNode - p->sParse.aNode);
  166571. p->eType = pNode->eType;
  166572. if( p->eType>=JSON_ARRAY ){
  166573. pNode->u.iKey = 0;
  166574. p->iEnd = p->i + pNode->n + 1;
  166575. if( p->bRecursive ){
  166576. p->eType = p->sParse.aNode[p->sParse.aUp[p->i]].eType;
  166577. if( p->i>0 && (p->sParse.aNode[p->i-1].jnFlags & JNODE_LABEL)!=0 ){
  166578. p->i--;
  166579. }
  166580. }else{
  166581. p->i++;
  166582. }
  166583. }else{
  166584. p->iEnd = p->i+1;
  166585. }
  166586. }
  166587. return SQLITE_OK;
  166588. }
  166589. /* The methods of the json_each virtual table */
  166590. static sqlite3_module jsonEachModule = {
  166591. 0, /* iVersion */
  166592. 0, /* xCreate */
  166593. jsonEachConnect, /* xConnect */
  166594. jsonEachBestIndex, /* xBestIndex */
  166595. jsonEachDisconnect, /* xDisconnect */
  166596. 0, /* xDestroy */
  166597. jsonEachOpenEach, /* xOpen - open a cursor */
  166598. jsonEachClose, /* xClose - close a cursor */
  166599. jsonEachFilter, /* xFilter - configure scan constraints */
  166600. jsonEachNext, /* xNext - advance a cursor */
  166601. jsonEachEof, /* xEof - check for end of scan */
  166602. jsonEachColumn, /* xColumn - read data */
  166603. jsonEachRowid, /* xRowid - read data */
  166604. 0, /* xUpdate */
  166605. 0, /* xBegin */
  166606. 0, /* xSync */
  166607. 0, /* xCommit */
  166608. 0, /* xRollback */
  166609. 0, /* xFindMethod */
  166610. 0, /* xRename */
  166611. 0, /* xSavepoint */
  166612. 0, /* xRelease */
  166613. 0 /* xRollbackTo */
  166614. };
  166615. /* The methods of the json_tree virtual table. */
  166616. static sqlite3_module jsonTreeModule = {
  166617. 0, /* iVersion */
  166618. 0, /* xCreate */
  166619. jsonEachConnect, /* xConnect */
  166620. jsonEachBestIndex, /* xBestIndex */
  166621. jsonEachDisconnect, /* xDisconnect */
  166622. 0, /* xDestroy */
  166623. jsonEachOpenTree, /* xOpen - open a cursor */
  166624. jsonEachClose, /* xClose - close a cursor */
  166625. jsonEachFilter, /* xFilter - configure scan constraints */
  166626. jsonEachNext, /* xNext - advance a cursor */
  166627. jsonEachEof, /* xEof - check for end of scan */
  166628. jsonEachColumn, /* xColumn - read data */
  166629. jsonEachRowid, /* xRowid - read data */
  166630. 0, /* xUpdate */
  166631. 0, /* xBegin */
  166632. 0, /* xSync */
  166633. 0, /* xCommit */
  166634. 0, /* xRollback */
  166635. 0, /* xFindMethod */
  166636. 0, /* xRename */
  166637. 0, /* xSavepoint */
  166638. 0, /* xRelease */
  166639. 0 /* xRollbackTo */
  166640. };
  166641. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  166642. /****************************************************************************
  166643. ** The following routines are the only publically visible identifiers in this
  166644. ** file. Call the following routines in order to register the various SQL
  166645. ** functions and the virtual table implemented by this file.
  166646. ****************************************************************************/
  166647. SQLITE_PRIVATE int sqlite3Json1Init(sqlite3 *db){
  166648. int rc = SQLITE_OK;
  166649. unsigned int i;
  166650. static const struct {
  166651. const char *zName;
  166652. int nArg;
  166653. int flag;
  166654. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  166655. } aFunc[] = {
  166656. { "json", 1, 0, jsonRemoveFunc },
  166657. { "json_array", -1, 0, jsonArrayFunc },
  166658. { "json_array_length", 1, 0, jsonArrayLengthFunc },
  166659. { "json_array_length", 2, 0, jsonArrayLengthFunc },
  166660. { "json_extract", -1, 0, jsonExtractFunc },
  166661. { "json_insert", -1, 0, jsonSetFunc },
  166662. { "json_object", -1, 0, jsonObjectFunc },
  166663. { "json_quote", 1, 0, jsonQuoteFunc },
  166664. { "json_remove", -1, 0, jsonRemoveFunc },
  166665. { "json_replace", -1, 0, jsonReplaceFunc },
  166666. { "json_set", -1, 1, jsonSetFunc },
  166667. { "json_type", 1, 0, jsonTypeFunc },
  166668. { "json_type", 2, 0, jsonTypeFunc },
  166669. { "json_valid", 1, 0, jsonValidFunc },
  166670. #if SQLITE_DEBUG
  166671. /* DEBUG and TESTING functions */
  166672. { "json_parse", 1, 0, jsonParseFunc },
  166673. { "json_test1", 1, 0, jsonTest1Func },
  166674. #endif
  166675. };
  166676. static const struct {
  166677. const char *zName;
  166678. int nArg;
  166679. void (*xStep)(sqlite3_context*,int,sqlite3_value**);
  166680. void (*xFinal)(sqlite3_context*);
  166681. } aAgg[] = {
  166682. { "json_group_array", 1, jsonArrayStep, jsonArrayFinal },
  166683. { "json_group_object", 2, jsonObjectStep, jsonObjectFinal },
  166684. };
  166685. #ifndef SQLITE_OMIT_VIRTUALTABLE
  166686. static const struct {
  166687. const char *zName;
  166688. sqlite3_module *pModule;
  166689. } aMod[] = {
  166690. { "json_each", &jsonEachModule },
  166691. { "json_tree", &jsonTreeModule },
  166692. };
  166693. #endif
  166694. for(i=0; i<sizeof(aFunc)/sizeof(aFunc[0]) && rc==SQLITE_OK; i++){
  166695. rc = sqlite3_create_function(db, aFunc[i].zName, aFunc[i].nArg,
  166696. SQLITE_UTF8 | SQLITE_DETERMINISTIC,
  166697. (void*)&aFunc[i].flag,
  166698. aFunc[i].xFunc, 0, 0);
  166699. }
  166700. for(i=0; i<sizeof(aAgg)/sizeof(aAgg[0]) && rc==SQLITE_OK; i++){
  166701. rc = sqlite3_create_function(db, aAgg[i].zName, aAgg[i].nArg,
  166702. SQLITE_UTF8 | SQLITE_DETERMINISTIC, 0,
  166703. 0, aAgg[i].xStep, aAgg[i].xFinal);
  166704. }
  166705. #ifndef SQLITE_OMIT_VIRTUALTABLE
  166706. for(i=0; i<sizeof(aMod)/sizeof(aMod[0]) && rc==SQLITE_OK; i++){
  166707. rc = sqlite3_create_module(db, aMod[i].zName, aMod[i].pModule, 0);
  166708. }
  166709. #endif
  166710. return rc;
  166711. }
  166712. #ifndef SQLITE_CORE
  166713. #ifdef _WIN32
  166714. __declspec(dllexport)
  166715. #endif
  166716. SQLITE_API int sqlite3_json_init(
  166717. sqlite3 *db,
  166718. char **pzErrMsg,
  166719. const sqlite3_api_routines *pApi
  166720. ){
  166721. SQLITE_EXTENSION_INIT2(pApi);
  166722. (void)pzErrMsg; /* Unused parameter */
  166723. return sqlite3Json1Init(db);
  166724. }
  166725. #endif
  166726. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_JSON1) */
  166727. /************** End of json1.c ***********************************************/
  166728. /************** Begin file fts5.c ********************************************/
  166729. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS5)
  166730. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  166731. # define NDEBUG 1
  166732. #endif
  166733. #if defined(NDEBUG) && defined(SQLITE_DEBUG)
  166734. # undef NDEBUG
  166735. #endif
  166736. /*
  166737. ** 2014 May 31
  166738. **
  166739. ** The author disclaims copyright to this source code. In place of
  166740. ** a legal notice, here is a blessing:
  166741. **
  166742. ** May you do good and not evil.
  166743. ** May you find forgiveness for yourself and forgive others.
  166744. ** May you share freely, never taking more than you give.
  166745. **
  166746. ******************************************************************************
  166747. **
  166748. ** Interfaces to extend FTS5. Using the interfaces defined in this file,
  166749. ** FTS5 may be extended with:
  166750. **
  166751. ** * custom tokenizers, and
  166752. ** * custom auxiliary functions.
  166753. */
  166754. #ifndef _FTS5_H
  166755. #define _FTS5_H
  166756. /* #include "sqlite3.h" */
  166757. #if 0
  166758. extern "C" {
  166759. #endif
  166760. /*************************************************************************
  166761. ** CUSTOM AUXILIARY FUNCTIONS
  166762. **
  166763. ** Virtual table implementations may overload SQL functions by implementing
  166764. ** the sqlite3_module.xFindFunction() method.
  166765. */
  166766. typedef struct Fts5ExtensionApi Fts5ExtensionApi;
  166767. typedef struct Fts5Context Fts5Context;
  166768. typedef struct Fts5PhraseIter Fts5PhraseIter;
  166769. typedef void (*fts5_extension_function)(
  166770. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  166771. Fts5Context *pFts, /* First arg to pass to pApi functions */
  166772. sqlite3_context *pCtx, /* Context for returning result/error */
  166773. int nVal, /* Number of values in apVal[] array */
  166774. sqlite3_value **apVal /* Array of trailing arguments */
  166775. );
  166776. struct Fts5PhraseIter {
  166777. const unsigned char *a;
  166778. const unsigned char *b;
  166779. };
  166780. /*
  166781. ** EXTENSION API FUNCTIONS
  166782. **
  166783. ** xUserData(pFts):
  166784. ** Return a copy of the context pointer the extension function was
  166785. ** registered with.
  166786. **
  166787. ** xColumnTotalSize(pFts, iCol, pnToken):
  166788. ** If parameter iCol is less than zero, set output variable *pnToken
  166789. ** to the total number of tokens in the FTS5 table. Or, if iCol is
  166790. ** non-negative but less than the number of columns in the table, return
  166791. ** the total number of tokens in column iCol, considering all rows in
  166792. ** the FTS5 table.
  166793. **
  166794. ** If parameter iCol is greater than or equal to the number of columns
  166795. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  166796. ** an OOM condition or IO error), an appropriate SQLite error code is
  166797. ** returned.
  166798. **
  166799. ** xColumnCount(pFts):
  166800. ** Return the number of columns in the table.
  166801. **
  166802. ** xColumnSize(pFts, iCol, pnToken):
  166803. ** If parameter iCol is less than zero, set output variable *pnToken
  166804. ** to the total number of tokens in the current row. Or, if iCol is
  166805. ** non-negative but less than the number of columns in the table, set
  166806. ** *pnToken to the number of tokens in column iCol of the current row.
  166807. **
  166808. ** If parameter iCol is greater than or equal to the number of columns
  166809. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  166810. ** an OOM condition or IO error), an appropriate SQLite error code is
  166811. ** returned.
  166812. **
  166813. ** This function may be quite inefficient if used with an FTS5 table
  166814. ** created with the "columnsize=0" option.
  166815. **
  166816. ** xColumnText:
  166817. ** This function attempts to retrieve the text of column iCol of the
  166818. ** current document. If successful, (*pz) is set to point to a buffer
  166819. ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
  166820. ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
  166821. ** if an error occurs, an SQLite error code is returned and the final values
  166822. ** of (*pz) and (*pn) are undefined.
  166823. **
  166824. ** xPhraseCount:
  166825. ** Returns the number of phrases in the current query expression.
  166826. **
  166827. ** xPhraseSize:
  166828. ** Returns the number of tokens in phrase iPhrase of the query. Phrases
  166829. ** are numbered starting from zero.
  166830. **
  166831. ** xInstCount:
  166832. ** Set *pnInst to the total number of occurrences of all phrases within
  166833. ** the query within the current row. Return SQLITE_OK if successful, or
  166834. ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
  166835. **
  166836. ** This API can be quite slow if used with an FTS5 table created with the
  166837. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  166838. ** with either "detail=none" or "detail=column" and "content=" option
  166839. ** (i.e. if it is a contentless table), then this API always returns 0.
  166840. **
  166841. ** xInst:
  166842. ** Query for the details of phrase match iIdx within the current row.
  166843. ** Phrase matches are numbered starting from zero, so the iIdx argument
  166844. ** should be greater than or equal to zero and smaller than the value
  166845. ** output by xInstCount().
  166846. **
  166847. ** Usually, output parameter *piPhrase is set to the phrase number, *piCol
  166848. ** to the column in which it occurs and *piOff the token offset of the
  166849. ** first token of the phrase. The exception is if the table was created
  166850. ** with the offsets=0 option specified. In this case *piOff is always
  166851. ** set to -1.
  166852. **
  166853. ** Returns SQLITE_OK if successful, or an error code (i.e. SQLITE_NOMEM)
  166854. ** if an error occurs.
  166855. **
  166856. ** This API can be quite slow if used with an FTS5 table created with the
  166857. ** "detail=none" or "detail=column" option.
  166858. **
  166859. ** xRowid:
  166860. ** Returns the rowid of the current row.
  166861. **
  166862. ** xTokenize:
  166863. ** Tokenize text using the tokenizer belonging to the FTS5 table.
  166864. **
  166865. ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
  166866. ** This API function is used to query the FTS table for phrase iPhrase
  166867. ** of the current query. Specifically, a query equivalent to:
  166868. **
  166869. ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
  166870. **
  166871. ** with $p set to a phrase equivalent to the phrase iPhrase of the
  166872. ** current query is executed. Any column filter that applies to
  166873. ** phrase iPhrase of the current query is included in $p. For each
  166874. ** row visited, the callback function passed as the fourth argument
  166875. ** is invoked. The context and API objects passed to the callback
  166876. ** function may be used to access the properties of each matched row.
  166877. ** Invoking Api.xUserData() returns a copy of the pointer passed as
  166878. ** the third argument to pUserData.
  166879. **
  166880. ** If the callback function returns any value other than SQLITE_OK, the
  166881. ** query is abandoned and the xQueryPhrase function returns immediately.
  166882. ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
  166883. ** Otherwise, the error code is propagated upwards.
  166884. **
  166885. ** If the query runs to completion without incident, SQLITE_OK is returned.
  166886. ** Or, if some error occurs before the query completes or is aborted by
  166887. ** the callback, an SQLite error code is returned.
  166888. **
  166889. **
  166890. ** xSetAuxdata(pFts5, pAux, xDelete)
  166891. **
  166892. ** Save the pointer passed as the second argument as the extension functions
  166893. ** "auxiliary data". The pointer may then be retrieved by the current or any
  166894. ** future invocation of the same fts5 extension function made as part of
  166895. ** of the same MATCH query using the xGetAuxdata() API.
  166896. **
  166897. ** Each extension function is allocated a single auxiliary data slot for
  166898. ** each FTS query (MATCH expression). If the extension function is invoked
  166899. ** more than once for a single FTS query, then all invocations share a
  166900. ** single auxiliary data context.
  166901. **
  166902. ** If there is already an auxiliary data pointer when this function is
  166903. ** invoked, then it is replaced by the new pointer. If an xDelete callback
  166904. ** was specified along with the original pointer, it is invoked at this
  166905. ** point.
  166906. **
  166907. ** The xDelete callback, if one is specified, is also invoked on the
  166908. ** auxiliary data pointer after the FTS5 query has finished.
  166909. **
  166910. ** If an error (e.g. an OOM condition) occurs within this function, an
  166911. ** the auxiliary data is set to NULL and an error code returned. If the
  166912. ** xDelete parameter was not NULL, it is invoked on the auxiliary data
  166913. ** pointer before returning.
  166914. **
  166915. **
  166916. ** xGetAuxdata(pFts5, bClear)
  166917. **
  166918. ** Returns the current auxiliary data pointer for the fts5 extension
  166919. ** function. See the xSetAuxdata() method for details.
  166920. **
  166921. ** If the bClear argument is non-zero, then the auxiliary data is cleared
  166922. ** (set to NULL) before this function returns. In this case the xDelete,
  166923. ** if any, is not invoked.
  166924. **
  166925. **
  166926. ** xRowCount(pFts5, pnRow)
  166927. **
  166928. ** This function is used to retrieve the total number of rows in the table.
  166929. ** In other words, the same value that would be returned by:
  166930. **
  166931. ** SELECT count(*) FROM ftstable;
  166932. **
  166933. ** xPhraseFirst()
  166934. ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
  166935. ** method, to iterate through all instances of a single query phrase within
  166936. ** the current row. This is the same information as is accessible via the
  166937. ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
  166938. ** to use, this API may be faster under some circumstances. To iterate
  166939. ** through instances of phrase iPhrase, use the following code:
  166940. **
  166941. ** Fts5PhraseIter iter;
  166942. ** int iCol, iOff;
  166943. ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
  166944. ** iCol>=0;
  166945. ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
  166946. ** ){
  166947. ** // An instance of phrase iPhrase at offset iOff of column iCol
  166948. ** }
  166949. **
  166950. ** The Fts5PhraseIter structure is defined above. Applications should not
  166951. ** modify this structure directly - it should only be used as shown above
  166952. ** with the xPhraseFirst() and xPhraseNext() API methods (and by
  166953. ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
  166954. **
  166955. ** This API can be quite slow if used with an FTS5 table created with the
  166956. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  166957. ** with either "detail=none" or "detail=column" and "content=" option
  166958. ** (i.e. if it is a contentless table), then this API always iterates
  166959. ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
  166960. **
  166961. ** xPhraseNext()
  166962. ** See xPhraseFirst above.
  166963. **
  166964. ** xPhraseFirstColumn()
  166965. ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
  166966. ** and xPhraseNext() APIs described above. The difference is that instead
  166967. ** of iterating through all instances of a phrase in the current row, these
  166968. ** APIs are used to iterate through the set of columns in the current row
  166969. ** that contain one or more instances of a specified phrase. For example:
  166970. **
  166971. ** Fts5PhraseIter iter;
  166972. ** int iCol;
  166973. ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
  166974. ** iCol>=0;
  166975. ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
  166976. ** ){
  166977. ** // Column iCol contains at least one instance of phrase iPhrase
  166978. ** }
  166979. **
  166980. ** This API can be quite slow if used with an FTS5 table created with the
  166981. ** "detail=none" option. If the FTS5 table is created with either
  166982. ** "detail=none" "content=" option (i.e. if it is a contentless table),
  166983. ** then this API always iterates through an empty set (all calls to
  166984. ** xPhraseFirstColumn() set iCol to -1).
  166985. **
  166986. ** The information accessed using this API and its companion
  166987. ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
  166988. ** (or xInst/xInstCount). The chief advantage of this API is that it is
  166989. ** significantly more efficient than those alternatives when used with
  166990. ** "detail=column" tables.
  166991. **
  166992. ** xPhraseNextColumn()
  166993. ** See xPhraseFirstColumn above.
  166994. */
  166995. struct Fts5ExtensionApi {
  166996. int iVersion; /* Currently always set to 3 */
  166997. void *(*xUserData)(Fts5Context*);
  166998. int (*xColumnCount)(Fts5Context*);
  166999. int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
  167000. int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
  167001. int (*xTokenize)(Fts5Context*,
  167002. const char *pText, int nText, /* Text to tokenize */
  167003. void *pCtx, /* Context passed to xToken() */
  167004. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  167005. );
  167006. int (*xPhraseCount)(Fts5Context*);
  167007. int (*xPhraseSize)(Fts5Context*, int iPhrase);
  167008. int (*xInstCount)(Fts5Context*, int *pnInst);
  167009. int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
  167010. sqlite3_int64 (*xRowid)(Fts5Context*);
  167011. int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
  167012. int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
  167013. int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
  167014. int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
  167015. );
  167016. int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
  167017. void *(*xGetAuxdata)(Fts5Context*, int bClear);
  167018. int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
  167019. void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
  167020. int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
  167021. void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
  167022. };
  167023. /*
  167024. ** CUSTOM AUXILIARY FUNCTIONS
  167025. *************************************************************************/
  167026. /*************************************************************************
  167027. ** CUSTOM TOKENIZERS
  167028. **
  167029. ** Applications may also register custom tokenizer types. A tokenizer
  167030. ** is registered by providing fts5 with a populated instance of the
  167031. ** following structure. All structure methods must be defined, setting
  167032. ** any member of the fts5_tokenizer struct to NULL leads to undefined
  167033. ** behaviour. The structure methods are expected to function as follows:
  167034. **
  167035. ** xCreate:
  167036. ** This function is used to allocate and initialize a tokenizer instance.
  167037. ** A tokenizer instance is required to actually tokenize text.
  167038. **
  167039. ** The first argument passed to this function is a copy of the (void*)
  167040. ** pointer provided by the application when the fts5_tokenizer object
  167041. ** was registered with FTS5 (the third argument to xCreateTokenizer()).
  167042. ** The second and third arguments are an array of nul-terminated strings
  167043. ** containing the tokenizer arguments, if any, specified following the
  167044. ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
  167045. ** to create the FTS5 table.
  167046. **
  167047. ** The final argument is an output variable. If successful, (*ppOut)
  167048. ** should be set to point to the new tokenizer handle and SQLITE_OK
  167049. ** returned. If an error occurs, some value other than SQLITE_OK should
  167050. ** be returned. In this case, fts5 assumes that the final value of *ppOut
  167051. ** is undefined.
  167052. **
  167053. ** xDelete:
  167054. ** This function is invoked to delete a tokenizer handle previously
  167055. ** allocated using xCreate(). Fts5 guarantees that this function will
  167056. ** be invoked exactly once for each successful call to xCreate().
  167057. **
  167058. ** xTokenize:
  167059. ** This function is expected to tokenize the nText byte string indicated
  167060. ** by argument pText. pText may or may not be nul-terminated. The first
  167061. ** argument passed to this function is a pointer to an Fts5Tokenizer object
  167062. ** returned by an earlier call to xCreate().
  167063. **
  167064. ** The second argument indicates the reason that FTS5 is requesting
  167065. ** tokenization of the supplied text. This is always one of the following
  167066. ** four values:
  167067. **
  167068. ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
  167069. ** or removed from the FTS table. The tokenizer is being invoked to
  167070. ** determine the set of tokens to add to (or delete from) the
  167071. ** FTS index.
  167072. **
  167073. ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
  167074. ** against the FTS index. The tokenizer is being called to tokenize
  167075. ** a bareword or quoted string specified as part of the query.
  167076. **
  167077. ** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
  167078. ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
  167079. ** followed by a "*" character, indicating that the last token
  167080. ** returned by the tokenizer will be treated as a token prefix.
  167081. **
  167082. ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
  167083. ** satisfy an fts5_api.xTokenize() request made by an auxiliary
  167084. ** function. Or an fts5_api.xColumnSize() request made by the same
  167085. ** on a columnsize=0 database.
  167086. ** </ul>
  167087. **
  167088. ** For each token in the input string, the supplied callback xToken() must
  167089. ** be invoked. The first argument to it should be a copy of the pointer
  167090. ** passed as the second argument to xTokenize(). The third and fourth
  167091. ** arguments are a pointer to a buffer containing the token text, and the
  167092. ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
  167093. ** of the first byte of and first byte immediately following the text from
  167094. ** which the token is derived within the input.
  167095. **
  167096. ** The second argument passed to the xToken() callback ("tflags") should
  167097. ** normally be set to 0. The exception is if the tokenizer supports
  167098. ** synonyms. In this case see the discussion below for details.
  167099. **
  167100. ** FTS5 assumes the xToken() callback is invoked for each token in the
  167101. ** order that they occur within the input text.
  167102. **
  167103. ** If an xToken() callback returns any value other than SQLITE_OK, then
  167104. ** the tokenization should be abandoned and the xTokenize() method should
  167105. ** immediately return a copy of the xToken() return value. Or, if the
  167106. ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
  167107. ** if an error occurs with the xTokenize() implementation itself, it
  167108. ** may abandon the tokenization and return any error code other than
  167109. ** SQLITE_OK or SQLITE_DONE.
  167110. **
  167111. ** SYNONYM SUPPORT
  167112. **
  167113. ** Custom tokenizers may also support synonyms. Consider a case in which a
  167114. ** user wishes to query for a phrase such as "first place". Using the
  167115. ** built-in tokenizers, the FTS5 query 'first + place' will match instances
  167116. ** of "first place" within the document set, but not alternative forms
  167117. ** such as "1st place". In some applications, it would be better to match
  167118. ** all instances of "first place" or "1st place" regardless of which form
  167119. ** the user specified in the MATCH query text.
  167120. **
  167121. ** There are several ways to approach this in FTS5:
  167122. **
  167123. ** <ol><li> By mapping all synonyms to a single token. In this case, the
  167124. ** In the above example, this means that the tokenizer returns the
  167125. ** same token for inputs "first" and "1st". Say that token is in
  167126. ** fact "first", so that when the user inserts the document "I won
  167127. ** 1st place" entries are added to the index for tokens "i", "won",
  167128. ** "first" and "place". If the user then queries for '1st + place',
  167129. ** the tokenizer substitutes "first" for "1st" and the query works
  167130. ** as expected.
  167131. **
  167132. ** <li> By adding multiple synonyms for a single term to the FTS index.
  167133. ** In this case, when tokenizing query text, the tokenizer may
  167134. ** provide multiple synonyms for a single term within the document.
  167135. ** FTS5 then queries the index for each synonym individually. For
  167136. ** example, faced with the query:
  167137. **
  167138. ** <codeblock>
  167139. ** ... MATCH 'first place'</codeblock>
  167140. **
  167141. ** the tokenizer offers both "1st" and "first" as synonyms for the
  167142. ** first token in the MATCH query and FTS5 effectively runs a query
  167143. ** similar to:
  167144. **
  167145. ** <codeblock>
  167146. ** ... MATCH '(first OR 1st) place'</codeblock>
  167147. **
  167148. ** except that, for the purposes of auxiliary functions, the query
  167149. ** still appears to contain just two phrases - "(first OR 1st)"
  167150. ** being treated as a single phrase.
  167151. **
  167152. ** <li> By adding multiple synonyms for a single term to the FTS index.
  167153. ** Using this method, when tokenizing document text, the tokenizer
  167154. ** provides multiple synonyms for each token. So that when a
  167155. ** document such as "I won first place" is tokenized, entries are
  167156. ** added to the FTS index for "i", "won", "first", "1st" and
  167157. ** "place".
  167158. **
  167159. ** This way, even if the tokenizer does not provide synonyms
  167160. ** when tokenizing query text (it should not - to do would be
  167161. ** inefficient), it doesn't matter if the user queries for
  167162. ** 'first + place' or '1st + place', as there are entires in the
  167163. ** FTS index corresponding to both forms of the first token.
  167164. ** </ol>
  167165. **
  167166. ** Whether it is parsing document or query text, any call to xToken that
  167167. ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
  167168. ** is considered to supply a synonym for the previous token. For example,
  167169. ** when parsing the document "I won first place", a tokenizer that supports
  167170. ** synonyms would call xToken() 5 times, as follows:
  167171. **
  167172. ** <codeblock>
  167173. ** xToken(pCtx, 0, "i", 1, 0, 1);
  167174. ** xToken(pCtx, 0, "won", 3, 2, 5);
  167175. ** xToken(pCtx, 0, "first", 5, 6, 11);
  167176. ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
  167177. ** xToken(pCtx, 0, "place", 5, 12, 17);
  167178. **</codeblock>
  167179. **
  167180. ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
  167181. ** xToken() is called. Multiple synonyms may be specified for a single token
  167182. ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
  167183. ** There is no limit to the number of synonyms that may be provided for a
  167184. ** single token.
  167185. **
  167186. ** In many cases, method (1) above is the best approach. It does not add
  167187. ** extra data to the FTS index or require FTS5 to query for multiple terms,
  167188. ** so it is efficient in terms of disk space and query speed. However, it
  167189. ** does not support prefix queries very well. If, as suggested above, the
  167190. ** token "first" is subsituted for "1st" by the tokenizer, then the query:
  167191. **
  167192. ** <codeblock>
  167193. ** ... MATCH '1s*'</codeblock>
  167194. **
  167195. ** will not match documents that contain the token "1st" (as the tokenizer
  167196. ** will probably not map "1s" to any prefix of "first").
  167197. **
  167198. ** For full prefix support, method (3) may be preferred. In this case,
  167199. ** because the index contains entries for both "first" and "1st", prefix
  167200. ** queries such as 'fi*' or '1s*' will match correctly. However, because
  167201. ** extra entries are added to the FTS index, this method uses more space
  167202. ** within the database.
  167203. **
  167204. ** Method (2) offers a midpoint between (1) and (3). Using this method,
  167205. ** a query such as '1s*' will match documents that contain the literal
  167206. ** token "1st", but not "first" (assuming the tokenizer is not able to
  167207. ** provide synonyms for prefixes). However, a non-prefix query like '1st'
  167208. ** will match against "1st" and "first". This method does not require
  167209. ** extra disk space, as no extra entries are added to the FTS index.
  167210. ** On the other hand, it may require more CPU cycles to run MATCH queries,
  167211. ** as separate queries of the FTS index are required for each synonym.
  167212. **
  167213. ** When using methods (2) or (3), it is important that the tokenizer only
  167214. ** provide synonyms when tokenizing document text (method (2)) or query
  167215. ** text (method (3)), not both. Doing so will not cause any errors, but is
  167216. ** inefficient.
  167217. */
  167218. typedef struct Fts5Tokenizer Fts5Tokenizer;
  167219. typedef struct fts5_tokenizer fts5_tokenizer;
  167220. struct fts5_tokenizer {
  167221. int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
  167222. void (*xDelete)(Fts5Tokenizer*);
  167223. int (*xTokenize)(Fts5Tokenizer*,
  167224. void *pCtx,
  167225. int flags, /* Mask of FTS5_TOKENIZE_* flags */
  167226. const char *pText, int nText,
  167227. int (*xToken)(
  167228. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  167229. int tflags, /* Mask of FTS5_TOKEN_* flags */
  167230. const char *pToken, /* Pointer to buffer containing token */
  167231. int nToken, /* Size of token in bytes */
  167232. int iStart, /* Byte offset of token within input text */
  167233. int iEnd /* Byte offset of end of token within input text */
  167234. )
  167235. );
  167236. };
  167237. /* Flags that may be passed as the third argument to xTokenize() */
  167238. #define FTS5_TOKENIZE_QUERY 0x0001
  167239. #define FTS5_TOKENIZE_PREFIX 0x0002
  167240. #define FTS5_TOKENIZE_DOCUMENT 0x0004
  167241. #define FTS5_TOKENIZE_AUX 0x0008
  167242. /* Flags that may be passed by the tokenizer implementation back to FTS5
  167243. ** as the third argument to the supplied xToken callback. */
  167244. #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
  167245. /*
  167246. ** END OF CUSTOM TOKENIZERS
  167247. *************************************************************************/
  167248. /*************************************************************************
  167249. ** FTS5 EXTENSION REGISTRATION API
  167250. */
  167251. typedef struct fts5_api fts5_api;
  167252. struct fts5_api {
  167253. int iVersion; /* Currently always set to 2 */
  167254. /* Create a new tokenizer */
  167255. int (*xCreateTokenizer)(
  167256. fts5_api *pApi,
  167257. const char *zName,
  167258. void *pContext,
  167259. fts5_tokenizer *pTokenizer,
  167260. void (*xDestroy)(void*)
  167261. );
  167262. /* Find an existing tokenizer */
  167263. int (*xFindTokenizer)(
  167264. fts5_api *pApi,
  167265. const char *zName,
  167266. void **ppContext,
  167267. fts5_tokenizer *pTokenizer
  167268. );
  167269. /* Create a new auxiliary function */
  167270. int (*xCreateFunction)(
  167271. fts5_api *pApi,
  167272. const char *zName,
  167273. void *pContext,
  167274. fts5_extension_function xFunction,
  167275. void (*xDestroy)(void*)
  167276. );
  167277. };
  167278. /*
  167279. ** END OF REGISTRATION API
  167280. *************************************************************************/
  167281. #if 0
  167282. } /* end of the 'extern "C"' block */
  167283. #endif
  167284. #endif /* _FTS5_H */
  167285. /*
  167286. ** 2014 May 31
  167287. **
  167288. ** The author disclaims copyright to this source code. In place of
  167289. ** a legal notice, here is a blessing:
  167290. **
  167291. ** May you do good and not evil.
  167292. ** May you find forgiveness for yourself and forgive others.
  167293. ** May you share freely, never taking more than you give.
  167294. **
  167295. ******************************************************************************
  167296. **
  167297. */
  167298. #ifndef _FTS5INT_H
  167299. #define _FTS5INT_H
  167300. /* #include "fts5.h" */
  167301. /* #include "sqlite3ext.h" */
  167302. SQLITE_EXTENSION_INIT1
  167303. /* #include <string.h> */
  167304. /* #include <assert.h> */
  167305. #ifndef SQLITE_AMALGAMATION
  167306. typedef unsigned char u8;
  167307. typedef unsigned int u32;
  167308. typedef unsigned short u16;
  167309. typedef short i16;
  167310. typedef sqlite3_int64 i64;
  167311. typedef sqlite3_uint64 u64;
  167312. #define ArraySize(x) ((int)(sizeof(x) / sizeof(x[0])))
  167313. #define testcase(x)
  167314. #define ALWAYS(x) 1
  167315. #define NEVER(x) 0
  167316. #define MIN(x,y) (((x) < (y)) ? (x) : (y))
  167317. #define MAX(x,y) (((x) > (y)) ? (x) : (y))
  167318. /*
  167319. ** Constants for the largest and smallest possible 64-bit signed integers.
  167320. */
  167321. # define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  167322. # define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
  167323. #endif
  167324. /* Truncate very long tokens to this many bytes. Hard limit is
  167325. ** (65536-1-1-4-9)==65521 bytes. The limiting factor is the 16-bit offset
  167326. ** field that occurs at the start of each leaf page (see fts5_index.c). */
  167327. #define FTS5_MAX_TOKEN_SIZE 32768
  167328. /*
  167329. ** Maximum number of prefix indexes on single FTS5 table. This must be
  167330. ** less than 32. If it is set to anything large than that, an #error
  167331. ** directive in fts5_index.c will cause the build to fail.
  167332. */
  167333. #define FTS5_MAX_PREFIX_INDEXES 31
  167334. #define FTS5_DEFAULT_NEARDIST 10
  167335. #define FTS5_DEFAULT_RANK "bm25"
  167336. /* Name of rank and rowid columns */
  167337. #define FTS5_RANK_NAME "rank"
  167338. #define FTS5_ROWID_NAME "rowid"
  167339. #ifdef SQLITE_DEBUG
  167340. # define FTS5_CORRUPT sqlite3Fts5Corrupt()
  167341. static int sqlite3Fts5Corrupt(void);
  167342. #else
  167343. # define FTS5_CORRUPT SQLITE_CORRUPT_VTAB
  167344. #endif
  167345. /*
  167346. ** The assert_nc() macro is similar to the assert() macro, except that it
  167347. ** is used for assert() conditions that are true only if it can be
  167348. ** guranteed that the database is not corrupt.
  167349. */
  167350. #ifdef SQLITE_DEBUG
  167351. SQLITE_API extern int sqlite3_fts5_may_be_corrupt;
  167352. # define assert_nc(x) assert(sqlite3_fts5_may_be_corrupt || (x))
  167353. #else
  167354. # define assert_nc(x) assert(x)
  167355. #endif
  167356. /* Mark a function parameter as unused, to suppress nuisance compiler
  167357. ** warnings. */
  167358. #ifndef UNUSED_PARAM
  167359. # define UNUSED_PARAM(X) (void)(X)
  167360. #endif
  167361. #ifndef UNUSED_PARAM2
  167362. # define UNUSED_PARAM2(X, Y) (void)(X), (void)(Y)
  167363. #endif
  167364. typedef struct Fts5Global Fts5Global;
  167365. typedef struct Fts5Colset Fts5Colset;
  167366. /* If a NEAR() clump or phrase may only match a specific set of columns,
  167367. ** then an object of the following type is used to record the set of columns.
  167368. ** Each entry in the aiCol[] array is a column that may be matched.
  167369. **
  167370. ** This object is used by fts5_expr.c and fts5_index.c.
  167371. */
  167372. struct Fts5Colset {
  167373. int nCol;
  167374. int aiCol[1];
  167375. };
  167376. /**************************************************************************
  167377. ** Interface to code in fts5_config.c. fts5_config.c contains contains code
  167378. ** to parse the arguments passed to the CREATE VIRTUAL TABLE statement.
  167379. */
  167380. typedef struct Fts5Config Fts5Config;
  167381. /*
  167382. ** An instance of the following structure encodes all information that can
  167383. ** be gleaned from the CREATE VIRTUAL TABLE statement.
  167384. **
  167385. ** And all information loaded from the %_config table.
  167386. **
  167387. ** nAutomerge:
  167388. ** The minimum number of segments that an auto-merge operation should
  167389. ** attempt to merge together. A value of 1 sets the object to use the
  167390. ** compile time default. Zero disables auto-merge altogether.
  167391. **
  167392. ** zContent:
  167393. **
  167394. ** zContentRowid:
  167395. ** The value of the content_rowid= option, if one was specified. Or
  167396. ** the string "rowid" otherwise. This text is not quoted - if it is
  167397. ** used as part of an SQL statement it needs to be quoted appropriately.
  167398. **
  167399. ** zContentExprlist:
  167400. **
  167401. ** pzErrmsg:
  167402. ** This exists in order to allow the fts5_index.c module to return a
  167403. ** decent error message if it encounters a file-format version it does
  167404. ** not understand.
  167405. **
  167406. ** bColumnsize:
  167407. ** True if the %_docsize table is created.
  167408. **
  167409. ** bPrefixIndex:
  167410. ** This is only used for debugging. If set to false, any prefix indexes
  167411. ** are ignored. This value is configured using:
  167412. **
  167413. ** INSERT INTO tbl(tbl, rank) VALUES('prefix-index', $bPrefixIndex);
  167414. **
  167415. */
  167416. struct Fts5Config {
  167417. sqlite3 *db; /* Database handle */
  167418. char *zDb; /* Database holding FTS index (e.g. "main") */
  167419. char *zName; /* Name of FTS index */
  167420. int nCol; /* Number of columns */
  167421. char **azCol; /* Column names */
  167422. u8 *abUnindexed; /* True for unindexed columns */
  167423. int nPrefix; /* Number of prefix indexes */
  167424. int *aPrefix; /* Sizes in bytes of nPrefix prefix indexes */
  167425. int eContent; /* An FTS5_CONTENT value */
  167426. char *zContent; /* content table */
  167427. char *zContentRowid; /* "content_rowid=" option value */
  167428. int bColumnsize; /* "columnsize=" option value (dflt==1) */
  167429. int eDetail; /* FTS5_DETAIL_XXX value */
  167430. char *zContentExprlist;
  167431. Fts5Tokenizer *pTok;
  167432. fts5_tokenizer *pTokApi;
  167433. /* Values loaded from the %_config table */
  167434. int iCookie; /* Incremented when %_config is modified */
  167435. int pgsz; /* Approximate page size used in %_data */
  167436. int nAutomerge; /* 'automerge' setting */
  167437. int nCrisisMerge; /* Maximum allowed segments per level */
  167438. int nUsermerge; /* 'usermerge' setting */
  167439. int nHashSize; /* Bytes of memory for in-memory hash */
  167440. char *zRank; /* Name of rank function */
  167441. char *zRankArgs; /* Arguments to rank function */
  167442. /* If non-NULL, points to sqlite3_vtab.base.zErrmsg. Often NULL. */
  167443. char **pzErrmsg;
  167444. #ifdef SQLITE_DEBUG
  167445. int bPrefixIndex; /* True to use prefix-indexes */
  167446. #endif
  167447. };
  167448. /* Current expected value of %_config table 'version' field */
  167449. #define FTS5_CURRENT_VERSION 4
  167450. #define FTS5_CONTENT_NORMAL 0
  167451. #define FTS5_CONTENT_NONE 1
  167452. #define FTS5_CONTENT_EXTERNAL 2
  167453. #define FTS5_DETAIL_FULL 0
  167454. #define FTS5_DETAIL_NONE 1
  167455. #define FTS5_DETAIL_COLUMNS 2
  167456. static int sqlite3Fts5ConfigParse(
  167457. Fts5Global*, sqlite3*, int, const char **, Fts5Config**, char**
  167458. );
  167459. static void sqlite3Fts5ConfigFree(Fts5Config*);
  167460. static int sqlite3Fts5ConfigDeclareVtab(Fts5Config *pConfig);
  167461. static int sqlite3Fts5Tokenize(
  167462. Fts5Config *pConfig, /* FTS5 Configuration object */
  167463. int flags, /* FTS5_TOKENIZE_* flags */
  167464. const char *pText, int nText, /* Text to tokenize */
  167465. void *pCtx, /* Context passed to xToken() */
  167466. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  167467. );
  167468. static void sqlite3Fts5Dequote(char *z);
  167469. /* Load the contents of the %_config table */
  167470. static int sqlite3Fts5ConfigLoad(Fts5Config*, int);
  167471. /* Set the value of a single config attribute */
  167472. static int sqlite3Fts5ConfigSetValue(Fts5Config*, const char*, sqlite3_value*, int*);
  167473. static int sqlite3Fts5ConfigParseRank(const char*, char**, char**);
  167474. /*
  167475. ** End of interface to code in fts5_config.c.
  167476. **************************************************************************/
  167477. /**************************************************************************
  167478. ** Interface to code in fts5_buffer.c.
  167479. */
  167480. /*
  167481. ** Buffer object for the incremental building of string data.
  167482. */
  167483. typedef struct Fts5Buffer Fts5Buffer;
  167484. struct Fts5Buffer {
  167485. u8 *p;
  167486. int n;
  167487. int nSpace;
  167488. };
  167489. static int sqlite3Fts5BufferSize(int*, Fts5Buffer*, u32);
  167490. static void sqlite3Fts5BufferAppendVarint(int*, Fts5Buffer*, i64);
  167491. static void sqlite3Fts5BufferAppendBlob(int*, Fts5Buffer*, u32, const u8*);
  167492. static void sqlite3Fts5BufferAppendString(int *, Fts5Buffer*, const char*);
  167493. static void sqlite3Fts5BufferFree(Fts5Buffer*);
  167494. static void sqlite3Fts5BufferZero(Fts5Buffer*);
  167495. static void sqlite3Fts5BufferSet(int*, Fts5Buffer*, int, const u8*);
  167496. static void sqlite3Fts5BufferAppendPrintf(int *, Fts5Buffer*, char *zFmt, ...);
  167497. static char *sqlite3Fts5Mprintf(int *pRc, const char *zFmt, ...);
  167498. #define fts5BufferZero(x) sqlite3Fts5BufferZero(x)
  167499. #define fts5BufferAppendVarint(a,b,c) sqlite3Fts5BufferAppendVarint(a,b,c)
  167500. #define fts5BufferFree(a) sqlite3Fts5BufferFree(a)
  167501. #define fts5BufferAppendBlob(a,b,c,d) sqlite3Fts5BufferAppendBlob(a,b,c,d)
  167502. #define fts5BufferSet(a,b,c,d) sqlite3Fts5BufferSet(a,b,c,d)
  167503. #define fts5BufferGrow(pRc,pBuf,nn) ( \
  167504. (u32)((pBuf)->n) + (u32)(nn) <= (u32)((pBuf)->nSpace) ? 0 : \
  167505. sqlite3Fts5BufferSize((pRc),(pBuf),(nn)+(pBuf)->n) \
  167506. )
  167507. /* Write and decode big-endian 32-bit integer values */
  167508. static void sqlite3Fts5Put32(u8*, int);
  167509. static int sqlite3Fts5Get32(const u8*);
  167510. #define FTS5_POS2COLUMN(iPos) (int)(iPos >> 32)
  167511. #define FTS5_POS2OFFSET(iPos) (int)(iPos & 0xFFFFFFFF)
  167512. typedef struct Fts5PoslistReader Fts5PoslistReader;
  167513. struct Fts5PoslistReader {
  167514. /* Variables used only by sqlite3Fts5PoslistIterXXX() functions. */
  167515. const u8 *a; /* Position list to iterate through */
  167516. int n; /* Size of buffer at a[] in bytes */
  167517. int i; /* Current offset in a[] */
  167518. u8 bFlag; /* For client use (any custom purpose) */
  167519. /* Output variables */
  167520. u8 bEof; /* Set to true at EOF */
  167521. i64 iPos; /* (iCol<<32) + iPos */
  167522. };
  167523. static int sqlite3Fts5PoslistReaderInit(
  167524. const u8 *a, int n, /* Poslist buffer to iterate through */
  167525. Fts5PoslistReader *pIter /* Iterator object to initialize */
  167526. );
  167527. static int sqlite3Fts5PoslistReaderNext(Fts5PoslistReader*);
  167528. typedef struct Fts5PoslistWriter Fts5PoslistWriter;
  167529. struct Fts5PoslistWriter {
  167530. i64 iPrev;
  167531. };
  167532. static int sqlite3Fts5PoslistWriterAppend(Fts5Buffer*, Fts5PoslistWriter*, i64);
  167533. static void sqlite3Fts5PoslistSafeAppend(Fts5Buffer*, i64*, i64);
  167534. static int sqlite3Fts5PoslistNext64(
  167535. const u8 *a, int n, /* Buffer containing poslist */
  167536. int *pi, /* IN/OUT: Offset within a[] */
  167537. i64 *piOff /* IN/OUT: Current offset */
  167538. );
  167539. /* Malloc utility */
  167540. static void *sqlite3Fts5MallocZero(int *pRc, int nByte);
  167541. static char *sqlite3Fts5Strndup(int *pRc, const char *pIn, int nIn);
  167542. /* Character set tests (like isspace(), isalpha() etc.) */
  167543. static int sqlite3Fts5IsBareword(char t);
  167544. /* Bucket of terms object used by the integrity-check in offsets=0 mode. */
  167545. typedef struct Fts5Termset Fts5Termset;
  167546. static int sqlite3Fts5TermsetNew(Fts5Termset**);
  167547. static int sqlite3Fts5TermsetAdd(Fts5Termset*, int, const char*, int, int *pbPresent);
  167548. static void sqlite3Fts5TermsetFree(Fts5Termset*);
  167549. /*
  167550. ** End of interface to code in fts5_buffer.c.
  167551. **************************************************************************/
  167552. /**************************************************************************
  167553. ** Interface to code in fts5_index.c. fts5_index.c contains contains code
  167554. ** to access the data stored in the %_data table.
  167555. */
  167556. typedef struct Fts5Index Fts5Index;
  167557. typedef struct Fts5IndexIter Fts5IndexIter;
  167558. struct Fts5IndexIter {
  167559. i64 iRowid;
  167560. const u8 *pData;
  167561. int nData;
  167562. u8 bEof;
  167563. };
  167564. #define sqlite3Fts5IterEof(x) ((x)->bEof)
  167565. /*
  167566. ** Values used as part of the flags argument passed to IndexQuery().
  167567. */
  167568. #define FTS5INDEX_QUERY_PREFIX 0x0001 /* Prefix query */
  167569. #define FTS5INDEX_QUERY_DESC 0x0002 /* Docs in descending rowid order */
  167570. #define FTS5INDEX_QUERY_TEST_NOIDX 0x0004 /* Do not use prefix index */
  167571. #define FTS5INDEX_QUERY_SCAN 0x0008 /* Scan query (fts5vocab) */
  167572. /* The following are used internally by the fts5_index.c module. They are
  167573. ** defined here only to make it easier to avoid clashes with the flags
  167574. ** above. */
  167575. #define FTS5INDEX_QUERY_SKIPEMPTY 0x0010
  167576. #define FTS5INDEX_QUERY_NOOUTPUT 0x0020
  167577. /*
  167578. ** Create/destroy an Fts5Index object.
  167579. */
  167580. static int sqlite3Fts5IndexOpen(Fts5Config *pConfig, int bCreate, Fts5Index**, char**);
  167581. static int sqlite3Fts5IndexClose(Fts5Index *p);
  167582. /*
  167583. ** Return a simple checksum value based on the arguments.
  167584. */
  167585. static u64 sqlite3Fts5IndexEntryCksum(
  167586. i64 iRowid,
  167587. int iCol,
  167588. int iPos,
  167589. int iIdx,
  167590. const char *pTerm,
  167591. int nTerm
  167592. );
  167593. /*
  167594. ** Argument p points to a buffer containing utf-8 text that is n bytes in
  167595. ** size. Return the number of bytes in the nChar character prefix of the
  167596. ** buffer, or 0 if there are less than nChar characters in total.
  167597. */
  167598. static int sqlite3Fts5IndexCharlenToBytelen(
  167599. const char *p,
  167600. int nByte,
  167601. int nChar
  167602. );
  167603. /*
  167604. ** Open a new iterator to iterate though all rowids that match the
  167605. ** specified token or token prefix.
  167606. */
  167607. static int sqlite3Fts5IndexQuery(
  167608. Fts5Index *p, /* FTS index to query */
  167609. const char *pToken, int nToken, /* Token (or prefix) to query for */
  167610. int flags, /* Mask of FTS5INDEX_QUERY_X flags */
  167611. Fts5Colset *pColset, /* Match these columns only */
  167612. Fts5IndexIter **ppIter /* OUT: New iterator object */
  167613. );
  167614. /*
  167615. ** The various operations on open token or token prefix iterators opened
  167616. ** using sqlite3Fts5IndexQuery().
  167617. */
  167618. static int sqlite3Fts5IterNext(Fts5IndexIter*);
  167619. static int sqlite3Fts5IterNextFrom(Fts5IndexIter*, i64 iMatch);
  167620. /*
  167621. ** Close an iterator opened by sqlite3Fts5IndexQuery().
  167622. */
  167623. static void sqlite3Fts5IterClose(Fts5IndexIter*);
  167624. /*
  167625. ** This interface is used by the fts5vocab module.
  167626. */
  167627. static const char *sqlite3Fts5IterTerm(Fts5IndexIter*, int*);
  167628. static int sqlite3Fts5IterNextScan(Fts5IndexIter*);
  167629. /*
  167630. ** Insert or remove data to or from the index. Each time a document is
  167631. ** added to or removed from the index, this function is called one or more
  167632. ** times.
  167633. **
  167634. ** For an insert, it must be called once for each token in the new document.
  167635. ** If the operation is a delete, it must be called (at least) once for each
  167636. ** unique token in the document with an iCol value less than zero. The iPos
  167637. ** argument is ignored for a delete.
  167638. */
  167639. static int sqlite3Fts5IndexWrite(
  167640. Fts5Index *p, /* Index to write to */
  167641. int iCol, /* Column token appears in (-ve -> delete) */
  167642. int iPos, /* Position of token within column */
  167643. const char *pToken, int nToken /* Token to add or remove to or from index */
  167644. );
  167645. /*
  167646. ** Indicate that subsequent calls to sqlite3Fts5IndexWrite() pertain to
  167647. ** document iDocid.
  167648. */
  167649. static int sqlite3Fts5IndexBeginWrite(
  167650. Fts5Index *p, /* Index to write to */
  167651. int bDelete, /* True if current operation is a delete */
  167652. i64 iDocid /* Docid to add or remove data from */
  167653. );
  167654. /*
  167655. ** Flush any data stored in the in-memory hash tables to the database.
  167656. ** If the bCommit flag is true, also close any open blob handles.
  167657. */
  167658. static int sqlite3Fts5IndexSync(Fts5Index *p, int bCommit);
  167659. /*
  167660. ** Discard any data stored in the in-memory hash tables. Do not write it
  167661. ** to the database. Additionally, assume that the contents of the %_data
  167662. ** table may have changed on disk. So any in-memory caches of %_data
  167663. ** records must be invalidated.
  167664. */
  167665. static int sqlite3Fts5IndexRollback(Fts5Index *p);
  167666. /*
  167667. ** Get or set the "averages" values.
  167668. */
  167669. static int sqlite3Fts5IndexGetAverages(Fts5Index *p, i64 *pnRow, i64 *anSize);
  167670. static int sqlite3Fts5IndexSetAverages(Fts5Index *p, const u8*, int);
  167671. /*
  167672. ** Functions called by the storage module as part of integrity-check.
  167673. */
  167674. static int sqlite3Fts5IndexIntegrityCheck(Fts5Index*, u64 cksum);
  167675. /*
  167676. ** Called during virtual module initialization to register UDF
  167677. ** fts5_decode() with SQLite
  167678. */
  167679. static int sqlite3Fts5IndexInit(sqlite3*);
  167680. static int sqlite3Fts5IndexSetCookie(Fts5Index*, int);
  167681. /*
  167682. ** Return the total number of entries read from the %_data table by
  167683. ** this connection since it was created.
  167684. */
  167685. static int sqlite3Fts5IndexReads(Fts5Index *p);
  167686. static int sqlite3Fts5IndexReinit(Fts5Index *p);
  167687. static int sqlite3Fts5IndexOptimize(Fts5Index *p);
  167688. static int sqlite3Fts5IndexMerge(Fts5Index *p, int nMerge);
  167689. static int sqlite3Fts5IndexReset(Fts5Index *p);
  167690. static int sqlite3Fts5IndexLoadConfig(Fts5Index *p);
  167691. /*
  167692. ** End of interface to code in fts5_index.c.
  167693. **************************************************************************/
  167694. /**************************************************************************
  167695. ** Interface to code in fts5_varint.c.
  167696. */
  167697. static int sqlite3Fts5GetVarint32(const unsigned char *p, u32 *v);
  167698. static int sqlite3Fts5GetVarintLen(u32 iVal);
  167699. static u8 sqlite3Fts5GetVarint(const unsigned char*, u64*);
  167700. static int sqlite3Fts5PutVarint(unsigned char *p, u64 v);
  167701. #define fts5GetVarint32(a,b) sqlite3Fts5GetVarint32(a,(u32*)&b)
  167702. #define fts5GetVarint sqlite3Fts5GetVarint
  167703. #define fts5FastGetVarint32(a, iOff, nVal) { \
  167704. nVal = (a)[iOff++]; \
  167705. if( nVal & 0x80 ){ \
  167706. iOff--; \
  167707. iOff += fts5GetVarint32(&(a)[iOff], nVal); \
  167708. } \
  167709. }
  167710. /*
  167711. ** End of interface to code in fts5_varint.c.
  167712. **************************************************************************/
  167713. /**************************************************************************
  167714. ** Interface to code in fts5.c.
  167715. */
  167716. static int sqlite3Fts5GetTokenizer(
  167717. Fts5Global*,
  167718. const char **azArg,
  167719. int nArg,
  167720. Fts5Tokenizer**,
  167721. fts5_tokenizer**,
  167722. char **pzErr
  167723. );
  167724. static Fts5Index *sqlite3Fts5IndexFromCsrid(Fts5Global*, i64, Fts5Config **);
  167725. /*
  167726. ** End of interface to code in fts5.c.
  167727. **************************************************************************/
  167728. /**************************************************************************
  167729. ** Interface to code in fts5_hash.c.
  167730. */
  167731. typedef struct Fts5Hash Fts5Hash;
  167732. /*
  167733. ** Create a hash table, free a hash table.
  167734. */
  167735. static int sqlite3Fts5HashNew(Fts5Config*, Fts5Hash**, int *pnSize);
  167736. static void sqlite3Fts5HashFree(Fts5Hash*);
  167737. static int sqlite3Fts5HashWrite(
  167738. Fts5Hash*,
  167739. i64 iRowid, /* Rowid for this entry */
  167740. int iCol, /* Column token appears in (-ve -> delete) */
  167741. int iPos, /* Position of token within column */
  167742. char bByte,
  167743. const char *pToken, int nToken /* Token to add or remove to or from index */
  167744. );
  167745. /*
  167746. ** Empty (but do not delete) a hash table.
  167747. */
  167748. static void sqlite3Fts5HashClear(Fts5Hash*);
  167749. static int sqlite3Fts5HashQuery(
  167750. Fts5Hash*, /* Hash table to query */
  167751. const char *pTerm, int nTerm, /* Query term */
  167752. const u8 **ppDoclist, /* OUT: Pointer to doclist for pTerm */
  167753. int *pnDoclist /* OUT: Size of doclist in bytes */
  167754. );
  167755. static int sqlite3Fts5HashScanInit(
  167756. Fts5Hash*, /* Hash table to query */
  167757. const char *pTerm, int nTerm /* Query prefix */
  167758. );
  167759. static void sqlite3Fts5HashScanNext(Fts5Hash*);
  167760. static int sqlite3Fts5HashScanEof(Fts5Hash*);
  167761. static void sqlite3Fts5HashScanEntry(Fts5Hash *,
  167762. const char **pzTerm, /* OUT: term (nul-terminated) */
  167763. const u8 **ppDoclist, /* OUT: pointer to doclist */
  167764. int *pnDoclist /* OUT: size of doclist in bytes */
  167765. );
  167766. /*
  167767. ** End of interface to code in fts5_hash.c.
  167768. **************************************************************************/
  167769. /**************************************************************************
  167770. ** Interface to code in fts5_storage.c. fts5_storage.c contains contains
  167771. ** code to access the data stored in the %_content and %_docsize tables.
  167772. */
  167773. #define FTS5_STMT_SCAN_ASC 0 /* SELECT rowid, * FROM ... ORDER BY 1 ASC */
  167774. #define FTS5_STMT_SCAN_DESC 1 /* SELECT rowid, * FROM ... ORDER BY 1 DESC */
  167775. #define FTS5_STMT_LOOKUP 2 /* SELECT rowid, * FROM ... WHERE rowid=? */
  167776. typedef struct Fts5Storage Fts5Storage;
  167777. static int sqlite3Fts5StorageOpen(Fts5Config*, Fts5Index*, int, Fts5Storage**, char**);
  167778. static int sqlite3Fts5StorageClose(Fts5Storage *p);
  167779. static int sqlite3Fts5StorageRename(Fts5Storage*, const char *zName);
  167780. static int sqlite3Fts5DropAll(Fts5Config*);
  167781. static int sqlite3Fts5CreateTable(Fts5Config*, const char*, const char*, int, char **);
  167782. static int sqlite3Fts5StorageDelete(Fts5Storage *p, i64, sqlite3_value**);
  167783. static int sqlite3Fts5StorageContentInsert(Fts5Storage *p, sqlite3_value**, i64*);
  167784. static int sqlite3Fts5StorageIndexInsert(Fts5Storage *p, sqlite3_value**, i64);
  167785. static int sqlite3Fts5StorageIntegrity(Fts5Storage *p);
  167786. static int sqlite3Fts5StorageStmt(Fts5Storage *p, int eStmt, sqlite3_stmt**, char**);
  167787. static void sqlite3Fts5StorageStmtRelease(Fts5Storage *p, int eStmt, sqlite3_stmt*);
  167788. static int sqlite3Fts5StorageDocsize(Fts5Storage *p, i64 iRowid, int *aCol);
  167789. static int sqlite3Fts5StorageSize(Fts5Storage *p, int iCol, i64 *pnAvg);
  167790. static int sqlite3Fts5StorageRowCount(Fts5Storage *p, i64 *pnRow);
  167791. static int sqlite3Fts5StorageSync(Fts5Storage *p, int bCommit);
  167792. static int sqlite3Fts5StorageRollback(Fts5Storage *p);
  167793. static int sqlite3Fts5StorageConfigValue(
  167794. Fts5Storage *p, const char*, sqlite3_value*, int
  167795. );
  167796. static int sqlite3Fts5StorageDeleteAll(Fts5Storage *p);
  167797. static int sqlite3Fts5StorageRebuild(Fts5Storage *p);
  167798. static int sqlite3Fts5StorageOptimize(Fts5Storage *p);
  167799. static int sqlite3Fts5StorageMerge(Fts5Storage *p, int nMerge);
  167800. static int sqlite3Fts5StorageReset(Fts5Storage *p);
  167801. /*
  167802. ** End of interface to code in fts5_storage.c.
  167803. **************************************************************************/
  167804. /**************************************************************************
  167805. ** Interface to code in fts5_expr.c.
  167806. */
  167807. typedef struct Fts5Expr Fts5Expr;
  167808. typedef struct Fts5ExprNode Fts5ExprNode;
  167809. typedef struct Fts5Parse Fts5Parse;
  167810. typedef struct Fts5Token Fts5Token;
  167811. typedef struct Fts5ExprPhrase Fts5ExprPhrase;
  167812. typedef struct Fts5ExprNearset Fts5ExprNearset;
  167813. struct Fts5Token {
  167814. const char *p; /* Token text (not NULL terminated) */
  167815. int n; /* Size of buffer p in bytes */
  167816. };
  167817. /* Parse a MATCH expression. */
  167818. static int sqlite3Fts5ExprNew(
  167819. Fts5Config *pConfig,
  167820. const char *zExpr,
  167821. Fts5Expr **ppNew,
  167822. char **pzErr
  167823. );
  167824. /*
  167825. ** for(rc = sqlite3Fts5ExprFirst(pExpr, pIdx, bDesc);
  167826. ** rc==SQLITE_OK && 0==sqlite3Fts5ExprEof(pExpr);
  167827. ** rc = sqlite3Fts5ExprNext(pExpr)
  167828. ** ){
  167829. ** // The document with rowid iRowid matches the expression!
  167830. ** i64 iRowid = sqlite3Fts5ExprRowid(pExpr);
  167831. ** }
  167832. */
  167833. static int sqlite3Fts5ExprFirst(Fts5Expr*, Fts5Index *pIdx, i64 iMin, int bDesc);
  167834. static int sqlite3Fts5ExprNext(Fts5Expr*, i64 iMax);
  167835. static int sqlite3Fts5ExprEof(Fts5Expr*);
  167836. static i64 sqlite3Fts5ExprRowid(Fts5Expr*);
  167837. static void sqlite3Fts5ExprFree(Fts5Expr*);
  167838. /* Called during startup to register a UDF with SQLite */
  167839. static int sqlite3Fts5ExprInit(Fts5Global*, sqlite3*);
  167840. static int sqlite3Fts5ExprPhraseCount(Fts5Expr*);
  167841. static int sqlite3Fts5ExprPhraseSize(Fts5Expr*, int iPhrase);
  167842. static int sqlite3Fts5ExprPoslist(Fts5Expr*, int, const u8 **);
  167843. typedef struct Fts5PoslistPopulator Fts5PoslistPopulator;
  167844. static Fts5PoslistPopulator *sqlite3Fts5ExprClearPoslists(Fts5Expr*, int);
  167845. static int sqlite3Fts5ExprPopulatePoslists(
  167846. Fts5Config*, Fts5Expr*, Fts5PoslistPopulator*, int, const char*, int
  167847. );
  167848. static void sqlite3Fts5ExprCheckPoslists(Fts5Expr*, i64);
  167849. static int sqlite3Fts5ExprClonePhrase(Fts5Expr*, int, Fts5Expr**);
  167850. static int sqlite3Fts5ExprPhraseCollist(Fts5Expr *, int, const u8 **, int *);
  167851. /*******************************************
  167852. ** The fts5_expr.c API above this point is used by the other hand-written
  167853. ** C code in this module. The interfaces below this point are called by
  167854. ** the parser code in fts5parse.y. */
  167855. static void sqlite3Fts5ParseError(Fts5Parse *pParse, const char *zFmt, ...);
  167856. static Fts5ExprNode *sqlite3Fts5ParseNode(
  167857. Fts5Parse *pParse,
  167858. int eType,
  167859. Fts5ExprNode *pLeft,
  167860. Fts5ExprNode *pRight,
  167861. Fts5ExprNearset *pNear
  167862. );
  167863. static Fts5ExprNode *sqlite3Fts5ParseImplicitAnd(
  167864. Fts5Parse *pParse,
  167865. Fts5ExprNode *pLeft,
  167866. Fts5ExprNode *pRight
  167867. );
  167868. static Fts5ExprPhrase *sqlite3Fts5ParseTerm(
  167869. Fts5Parse *pParse,
  167870. Fts5ExprPhrase *pPhrase,
  167871. Fts5Token *pToken,
  167872. int bPrefix
  167873. );
  167874. static Fts5ExprNearset *sqlite3Fts5ParseNearset(
  167875. Fts5Parse*,
  167876. Fts5ExprNearset*,
  167877. Fts5ExprPhrase*
  167878. );
  167879. static Fts5Colset *sqlite3Fts5ParseColset(
  167880. Fts5Parse*,
  167881. Fts5Colset*,
  167882. Fts5Token *
  167883. );
  167884. static void sqlite3Fts5ParsePhraseFree(Fts5ExprPhrase*);
  167885. static void sqlite3Fts5ParseNearsetFree(Fts5ExprNearset*);
  167886. static void sqlite3Fts5ParseNodeFree(Fts5ExprNode*);
  167887. static void sqlite3Fts5ParseSetDistance(Fts5Parse*, Fts5ExprNearset*, Fts5Token*);
  167888. static void sqlite3Fts5ParseSetColset(Fts5Parse*, Fts5ExprNearset*, Fts5Colset*);
  167889. static Fts5Colset *sqlite3Fts5ParseColsetInvert(Fts5Parse*, Fts5Colset*);
  167890. static void sqlite3Fts5ParseFinished(Fts5Parse *pParse, Fts5ExprNode *p);
  167891. static void sqlite3Fts5ParseNear(Fts5Parse *pParse, Fts5Token*);
  167892. /*
  167893. ** End of interface to code in fts5_expr.c.
  167894. **************************************************************************/
  167895. /**************************************************************************
  167896. ** Interface to code in fts5_aux.c.
  167897. */
  167898. static int sqlite3Fts5AuxInit(fts5_api*);
  167899. /*
  167900. ** End of interface to code in fts5_aux.c.
  167901. **************************************************************************/
  167902. /**************************************************************************
  167903. ** Interface to code in fts5_tokenizer.c.
  167904. */
  167905. static int sqlite3Fts5TokenizerInit(fts5_api*);
  167906. /*
  167907. ** End of interface to code in fts5_tokenizer.c.
  167908. **************************************************************************/
  167909. /**************************************************************************
  167910. ** Interface to code in fts5_vocab.c.
  167911. */
  167912. static int sqlite3Fts5VocabInit(Fts5Global*, sqlite3*);
  167913. /*
  167914. ** End of interface to code in fts5_vocab.c.
  167915. **************************************************************************/
  167916. /**************************************************************************
  167917. ** Interface to automatically generated code in fts5_unicode2.c.
  167918. */
  167919. static int sqlite3Fts5UnicodeIsalnum(int c);
  167920. static int sqlite3Fts5UnicodeIsdiacritic(int c);
  167921. static int sqlite3Fts5UnicodeFold(int c, int bRemoveDiacritic);
  167922. /*
  167923. ** End of interface to code in fts5_unicode2.c.
  167924. **************************************************************************/
  167925. #endif
  167926. #define FTS5_OR 1
  167927. #define FTS5_AND 2
  167928. #define FTS5_NOT 3
  167929. #define FTS5_TERM 4
  167930. #define FTS5_COLON 5
  167931. #define FTS5_LP 6
  167932. #define FTS5_RP 7
  167933. #define FTS5_MINUS 8
  167934. #define FTS5_LCP 9
  167935. #define FTS5_RCP 10
  167936. #define FTS5_STRING 11
  167937. #define FTS5_COMMA 12
  167938. #define FTS5_PLUS 13
  167939. #define FTS5_STAR 14
  167940. /*
  167941. ** 2000-05-29
  167942. **
  167943. ** The author disclaims copyright to this source code. In place of
  167944. ** a legal notice, here is a blessing:
  167945. **
  167946. ** May you do good and not evil.
  167947. ** May you find forgiveness for yourself and forgive others.
  167948. ** May you share freely, never taking more than you give.
  167949. **
  167950. *************************************************************************
  167951. ** Driver template for the LEMON parser generator.
  167952. **
  167953. ** The "lemon" program processes an LALR(1) input grammar file, then uses
  167954. ** this template to construct a parser. The "lemon" program inserts text
  167955. ** at each "%%" line. Also, any "P-a-r-s-e" identifer prefix (without the
  167956. ** interstitial "-" characters) contained in this template is changed into
  167957. ** the value of the %name directive from the grammar. Otherwise, the content
  167958. ** of this template is copied straight through into the generate parser
  167959. ** source file.
  167960. **
  167961. ** The following is the concatenation of all %include directives from the
  167962. ** input grammar file:
  167963. */
  167964. /* #include <stdio.h> */
  167965. /************ Begin %include sections from the grammar ************************/
  167966. /* #include "fts5Int.h" */
  167967. /* #include "fts5parse.h" */
  167968. /*
  167969. ** Disable all error recovery processing in the parser push-down
  167970. ** automaton.
  167971. */
  167972. #define fts5YYNOERRORRECOVERY 1
  167973. /*
  167974. ** Make fts5yytestcase() the same as testcase()
  167975. */
  167976. #define fts5yytestcase(X) testcase(X)
  167977. /*
  167978. ** Indicate that sqlite3ParserFree() will never be called with a null
  167979. ** pointer.
  167980. */
  167981. #define fts5YYPARSEFREENOTNULL 1
  167982. /*
  167983. ** Alternative datatype for the argument to the malloc() routine passed
  167984. ** into sqlite3ParserAlloc(). The default is size_t.
  167985. */
  167986. #define fts5YYMALLOCARGTYPE u64
  167987. /**************** End of %include directives **********************************/
  167988. /* These constants specify the various numeric values for terminal symbols
  167989. ** in a format understandable to "makeheaders". This section is blank unless
  167990. ** "lemon" is run with the "-m" command-line option.
  167991. ***************** Begin makeheaders token definitions *************************/
  167992. /**************** End makeheaders token definitions ***************************/
  167993. /* The next sections is a series of control #defines.
  167994. ** various aspects of the generated parser.
  167995. ** fts5YYCODETYPE is the data type used to store the integer codes
  167996. ** that represent terminal and non-terminal symbols.
  167997. ** "unsigned char" is used if there are fewer than
  167998. ** 256 symbols. Larger types otherwise.
  167999. ** fts5YYNOCODE is a number of type fts5YYCODETYPE that is not used for
  168000. ** any terminal or nonterminal symbol.
  168001. ** fts5YYFALLBACK If defined, this indicates that one or more tokens
  168002. ** (also known as: "terminal symbols") have fall-back
  168003. ** values which should be used if the original symbol
  168004. ** would not parse. This permits keywords to sometimes
  168005. ** be used as identifiers, for example.
  168006. ** fts5YYACTIONTYPE is the data type used for "action codes" - numbers
  168007. ** that indicate what to do in response to the next
  168008. ** token.
  168009. ** sqlite3Fts5ParserFTS5TOKENTYPE is the data type used for minor type for terminal
  168010. ** symbols. Background: A "minor type" is a semantic
  168011. ** value associated with a terminal or non-terminal
  168012. ** symbols. For example, for an "ID" terminal symbol,
  168013. ** the minor type might be the name of the identifier.
  168014. ** Each non-terminal can have a different minor type.
  168015. ** Terminal symbols all have the same minor type, though.
  168016. ** This macros defines the minor type for terminal
  168017. ** symbols.
  168018. ** fts5YYMINORTYPE is the data type used for all minor types.
  168019. ** This is typically a union of many types, one of
  168020. ** which is sqlite3Fts5ParserFTS5TOKENTYPE. The entry in the union
  168021. ** for terminal symbols is called "fts5yy0".
  168022. ** fts5YYSTACKDEPTH is the maximum depth of the parser's stack. If
  168023. ** zero the stack is dynamically sized using realloc()
  168024. ** sqlite3Fts5ParserARG_SDECL A static variable declaration for the %extra_argument
  168025. ** sqlite3Fts5ParserARG_PDECL A parameter declaration for the %extra_argument
  168026. ** sqlite3Fts5ParserARG_STORE Code to store %extra_argument into fts5yypParser
  168027. ** sqlite3Fts5ParserARG_FETCH Code to extract %extra_argument from fts5yypParser
  168028. ** fts5YYERRORSYMBOL is the code number of the error symbol. If not
  168029. ** defined, then do no error processing.
  168030. ** fts5YYNSTATE the combined number of states.
  168031. ** fts5YYNRULE the number of rules in the grammar
  168032. ** fts5YY_MAX_SHIFT Maximum value for shift actions
  168033. ** fts5YY_MIN_SHIFTREDUCE Minimum value for shift-reduce actions
  168034. ** fts5YY_MAX_SHIFTREDUCE Maximum value for shift-reduce actions
  168035. ** fts5YY_MIN_REDUCE Maximum value for reduce actions
  168036. ** fts5YY_ERROR_ACTION The fts5yy_action[] code for syntax error
  168037. ** fts5YY_ACCEPT_ACTION The fts5yy_action[] code for accept
  168038. ** fts5YY_NO_ACTION The fts5yy_action[] code for no-op
  168039. */
  168040. #ifndef INTERFACE
  168041. # define INTERFACE 1
  168042. #endif
  168043. /************* Begin control #defines *****************************************/
  168044. #define fts5YYCODETYPE unsigned char
  168045. #define fts5YYNOCODE 28
  168046. #define fts5YYACTIONTYPE unsigned char
  168047. #define sqlite3Fts5ParserFTS5TOKENTYPE Fts5Token
  168048. typedef union {
  168049. int fts5yyinit;
  168050. sqlite3Fts5ParserFTS5TOKENTYPE fts5yy0;
  168051. int fts5yy4;
  168052. Fts5Colset* fts5yy11;
  168053. Fts5ExprNode* fts5yy24;
  168054. Fts5ExprNearset* fts5yy46;
  168055. Fts5ExprPhrase* fts5yy53;
  168056. } fts5YYMINORTYPE;
  168057. #ifndef fts5YYSTACKDEPTH
  168058. #define fts5YYSTACKDEPTH 100
  168059. #endif
  168060. #define sqlite3Fts5ParserARG_SDECL Fts5Parse *pParse;
  168061. #define sqlite3Fts5ParserARG_PDECL ,Fts5Parse *pParse
  168062. #define sqlite3Fts5ParserARG_FETCH Fts5Parse *pParse = fts5yypParser->pParse
  168063. #define sqlite3Fts5ParserARG_STORE fts5yypParser->pParse = pParse
  168064. #define fts5YYNSTATE 29
  168065. #define fts5YYNRULE 26
  168066. #define fts5YY_MAX_SHIFT 28
  168067. #define fts5YY_MIN_SHIFTREDUCE 45
  168068. #define fts5YY_MAX_SHIFTREDUCE 70
  168069. #define fts5YY_MIN_REDUCE 71
  168070. #define fts5YY_MAX_REDUCE 96
  168071. #define fts5YY_ERROR_ACTION 97
  168072. #define fts5YY_ACCEPT_ACTION 98
  168073. #define fts5YY_NO_ACTION 99
  168074. /************* End control #defines *******************************************/
  168075. /* Define the fts5yytestcase() macro to be a no-op if is not already defined
  168076. ** otherwise.
  168077. **
  168078. ** Applications can choose to define fts5yytestcase() in the %include section
  168079. ** to a macro that can assist in verifying code coverage. For production
  168080. ** code the fts5yytestcase() macro should be turned off. But it is useful
  168081. ** for testing.
  168082. */
  168083. #ifndef fts5yytestcase
  168084. # define fts5yytestcase(X)
  168085. #endif
  168086. /* Next are the tables used to determine what action to take based on the
  168087. ** current state and lookahead token. These tables are used to implement
  168088. ** functions that take a state number and lookahead value and return an
  168089. ** action integer.
  168090. **
  168091. ** Suppose the action integer is N. Then the action is determined as
  168092. ** follows
  168093. **
  168094. ** 0 <= N <= fts5YY_MAX_SHIFT Shift N. That is, push the lookahead
  168095. ** token onto the stack and goto state N.
  168096. **
  168097. ** N between fts5YY_MIN_SHIFTREDUCE Shift to an arbitrary state then
  168098. ** and fts5YY_MAX_SHIFTREDUCE reduce by rule N-fts5YY_MIN_SHIFTREDUCE.
  168099. **
  168100. ** N between fts5YY_MIN_REDUCE Reduce by rule N-fts5YY_MIN_REDUCE
  168101. ** and fts5YY_MAX_REDUCE
  168102. **
  168103. ** N == fts5YY_ERROR_ACTION A syntax error has occurred.
  168104. **
  168105. ** N == fts5YY_ACCEPT_ACTION The parser accepts its input.
  168106. **
  168107. ** N == fts5YY_NO_ACTION No such action. Denotes unused
  168108. ** slots in the fts5yy_action[] table.
  168109. **
  168110. ** The action table is constructed as a single large table named fts5yy_action[].
  168111. ** Given state S and lookahead X, the action is computed as either:
  168112. **
  168113. ** (A) N = fts5yy_action[ fts5yy_shift_ofst[S] + X ]
  168114. ** (B) N = fts5yy_default[S]
  168115. **
  168116. ** The (A) formula is preferred. The B formula is used instead if:
  168117. ** (1) The fts5yy_shift_ofst[S]+X value is out of range, or
  168118. ** (2) fts5yy_lookahead[fts5yy_shift_ofst[S]+X] is not equal to X, or
  168119. ** (3) fts5yy_shift_ofst[S] equal fts5YY_SHIFT_USE_DFLT.
  168120. ** (Implementation note: fts5YY_SHIFT_USE_DFLT is chosen so that
  168121. ** fts5YY_SHIFT_USE_DFLT+X will be out of range for all possible lookaheads X.
  168122. ** Hence only tests (1) and (2) need to be evaluated.)
  168123. **
  168124. ** The formulas above are for computing the action when the lookahead is
  168125. ** a terminal symbol. If the lookahead is a non-terminal (as occurs after
  168126. ** a reduce action) then the fts5yy_reduce_ofst[] array is used in place of
  168127. ** the fts5yy_shift_ofst[] array and fts5YY_REDUCE_USE_DFLT is used in place of
  168128. ** fts5YY_SHIFT_USE_DFLT.
  168129. **
  168130. ** The following are the tables generated in this section:
  168131. **
  168132. ** fts5yy_action[] A single table containing all actions.
  168133. ** fts5yy_lookahead[] A table containing the lookahead for each entry in
  168134. ** fts5yy_action. Used to detect hash collisions.
  168135. ** fts5yy_shift_ofst[] For each state, the offset into fts5yy_action for
  168136. ** shifting terminals.
  168137. ** fts5yy_reduce_ofst[] For each state, the offset into fts5yy_action for
  168138. ** shifting non-terminals after a reduce.
  168139. ** fts5yy_default[] Default action for each state.
  168140. **
  168141. *********** Begin parsing tables **********************************************/
  168142. #define fts5YY_ACTTAB_COUNT (85)
  168143. static const fts5YYACTIONTYPE fts5yy_action[] = {
  168144. /* 0 */ 98, 16, 51, 5, 53, 27, 83, 7, 26, 15,
  168145. /* 10 */ 51, 5, 53, 27, 13, 69, 26, 48, 51, 5,
  168146. /* 20 */ 53, 27, 19, 11, 26, 9, 20, 51, 5, 53,
  168147. /* 30 */ 27, 13, 22, 26, 28, 51, 5, 53, 27, 68,
  168148. /* 40 */ 1, 26, 19, 11, 17, 9, 52, 10, 53, 27,
  168149. /* 50 */ 23, 24, 26, 54, 3, 4, 2, 26, 6, 21,
  168150. /* 60 */ 49, 71, 3, 4, 2, 7, 56, 59, 55, 59,
  168151. /* 70 */ 4, 2, 12, 69, 58, 60, 18, 67, 62, 69,
  168152. /* 80 */ 25, 66, 8, 14, 2,
  168153. };
  168154. static const fts5YYCODETYPE fts5yy_lookahead[] = {
  168155. /* 0 */ 16, 17, 18, 19, 20, 21, 5, 6, 24, 17,
  168156. /* 10 */ 18, 19, 20, 21, 11, 14, 24, 17, 18, 19,
  168157. /* 20 */ 20, 21, 8, 9, 24, 11, 17, 18, 19, 20,
  168158. /* 30 */ 21, 11, 12, 24, 17, 18, 19, 20, 21, 26,
  168159. /* 40 */ 6, 24, 8, 9, 22, 11, 18, 11, 20, 21,
  168160. /* 50 */ 24, 25, 24, 20, 1, 2, 3, 24, 23, 24,
  168161. /* 60 */ 7, 0, 1, 2, 3, 6, 10, 11, 10, 11,
  168162. /* 70 */ 2, 3, 9, 14, 11, 11, 22, 26, 7, 14,
  168163. /* 80 */ 13, 11, 5, 11, 3,
  168164. };
  168165. #define fts5YY_SHIFT_USE_DFLT (85)
  168166. #define fts5YY_SHIFT_COUNT (28)
  168167. #define fts5YY_SHIFT_MIN (0)
  168168. #define fts5YY_SHIFT_MAX (81)
  168169. static const unsigned char fts5yy_shift_ofst[] = {
  168170. /* 0 */ 34, 34, 34, 34, 34, 14, 20, 3, 36, 1,
  168171. /* 10 */ 59, 64, 64, 65, 65, 53, 61, 56, 58, 63,
  168172. /* 20 */ 68, 67, 70, 67, 71, 72, 67, 77, 81,
  168173. };
  168174. #define fts5YY_REDUCE_USE_DFLT (-17)
  168175. #define fts5YY_REDUCE_COUNT (14)
  168176. #define fts5YY_REDUCE_MIN (-16)
  168177. #define fts5YY_REDUCE_MAX (54)
  168178. static const signed char fts5yy_reduce_ofst[] = {
  168179. /* 0 */ -16, -8, 0, 9, 17, 28, 26, 35, 33, 13,
  168180. /* 10 */ 13, 22, 54, 13, 51,
  168181. };
  168182. static const fts5YYACTIONTYPE fts5yy_default[] = {
  168183. /* 0 */ 97, 97, 97, 97, 97, 76, 91, 97, 97, 96,
  168184. /* 10 */ 96, 97, 97, 96, 96, 97, 97, 97, 97, 97,
  168185. /* 20 */ 73, 89, 97, 90, 97, 97, 87, 97, 72,
  168186. };
  168187. /********** End of lemon-generated parsing tables *****************************/
  168188. /* The next table maps tokens (terminal symbols) into fallback tokens.
  168189. ** If a construct like the following:
  168190. **
  168191. ** %fallback ID X Y Z.
  168192. **
  168193. ** appears in the grammar, then ID becomes a fallback token for X, Y,
  168194. ** and Z. Whenever one of the tokens X, Y, or Z is input to the parser
  168195. ** but it does not parse, the type of the token is changed to ID and
  168196. ** the parse is retried before an error is thrown.
  168197. **
  168198. ** This feature can be used, for example, to cause some keywords in a language
  168199. ** to revert to identifiers if they keyword does not apply in the context where
  168200. ** it appears.
  168201. */
  168202. #ifdef fts5YYFALLBACK
  168203. static const fts5YYCODETYPE fts5yyFallback[] = {
  168204. };
  168205. #endif /* fts5YYFALLBACK */
  168206. /* The following structure represents a single element of the
  168207. ** parser's stack. Information stored includes:
  168208. **
  168209. ** + The state number for the parser at this level of the stack.
  168210. **
  168211. ** + The value of the token stored at this level of the stack.
  168212. ** (In other words, the "major" token.)
  168213. **
  168214. ** + The semantic value stored at this level of the stack. This is
  168215. ** the information used by the action routines in the grammar.
  168216. ** It is sometimes called the "minor" token.
  168217. **
  168218. ** After the "shift" half of a SHIFTREDUCE action, the stateno field
  168219. ** actually contains the reduce action for the second half of the
  168220. ** SHIFTREDUCE.
  168221. */
  168222. struct fts5yyStackEntry {
  168223. fts5YYACTIONTYPE stateno; /* The state-number, or reduce action in SHIFTREDUCE */
  168224. fts5YYCODETYPE major; /* The major token value. This is the code
  168225. ** number for the token at this stack level */
  168226. fts5YYMINORTYPE minor; /* The user-supplied minor token value. This
  168227. ** is the value of the token */
  168228. };
  168229. typedef struct fts5yyStackEntry fts5yyStackEntry;
  168230. /* The state of the parser is completely contained in an instance of
  168231. ** the following structure */
  168232. struct fts5yyParser {
  168233. fts5yyStackEntry *fts5yytos; /* Pointer to top element of the stack */
  168234. #ifdef fts5YYTRACKMAXSTACKDEPTH
  168235. int fts5yyhwm; /* High-water mark of the stack */
  168236. #endif
  168237. #ifndef fts5YYNOERRORRECOVERY
  168238. int fts5yyerrcnt; /* Shifts left before out of the error */
  168239. #endif
  168240. sqlite3Fts5ParserARG_SDECL /* A place to hold %extra_argument */
  168241. #if fts5YYSTACKDEPTH<=0
  168242. int fts5yystksz; /* Current side of the stack */
  168243. fts5yyStackEntry *fts5yystack; /* The parser's stack */
  168244. fts5yyStackEntry fts5yystk0; /* First stack entry */
  168245. #else
  168246. fts5yyStackEntry fts5yystack[fts5YYSTACKDEPTH]; /* The parser's stack */
  168247. #endif
  168248. };
  168249. typedef struct fts5yyParser fts5yyParser;
  168250. #ifndef NDEBUG
  168251. /* #include <stdio.h> */
  168252. static FILE *fts5yyTraceFILE = 0;
  168253. static char *fts5yyTracePrompt = 0;
  168254. #endif /* NDEBUG */
  168255. #ifndef NDEBUG
  168256. /*
  168257. ** Turn parser tracing on by giving a stream to which to write the trace
  168258. ** and a prompt to preface each trace message. Tracing is turned off
  168259. ** by making either argument NULL
  168260. **
  168261. ** Inputs:
  168262. ** <ul>
  168263. ** <li> A FILE* to which trace output should be written.
  168264. ** If NULL, then tracing is turned off.
  168265. ** <li> A prefix string written at the beginning of every
  168266. ** line of trace output. If NULL, then tracing is
  168267. ** turned off.
  168268. ** </ul>
  168269. **
  168270. ** Outputs:
  168271. ** None.
  168272. */
  168273. static void sqlite3Fts5ParserTrace(FILE *TraceFILE, char *zTracePrompt){
  168274. fts5yyTraceFILE = TraceFILE;
  168275. fts5yyTracePrompt = zTracePrompt;
  168276. if( fts5yyTraceFILE==0 ) fts5yyTracePrompt = 0;
  168277. else if( fts5yyTracePrompt==0 ) fts5yyTraceFILE = 0;
  168278. }
  168279. #endif /* NDEBUG */
  168280. #ifndef NDEBUG
  168281. /* For tracing shifts, the names of all terminals and nonterminals
  168282. ** are required. The following table supplies these names */
  168283. static const char *const fts5yyTokenName[] = {
  168284. "$", "OR", "AND", "NOT",
  168285. "TERM", "COLON", "LP", "RP",
  168286. "MINUS", "LCP", "RCP", "STRING",
  168287. "COMMA", "PLUS", "STAR", "error",
  168288. "input", "expr", "cnearset", "exprlist",
  168289. "nearset", "colset", "colsetlist", "nearphrases",
  168290. "phrase", "neardist_opt", "star_opt",
  168291. };
  168292. #endif /* NDEBUG */
  168293. #ifndef NDEBUG
  168294. /* For tracing reduce actions, the names of all rules are required.
  168295. */
  168296. static const char *const fts5yyRuleName[] = {
  168297. /* 0 */ "input ::= expr",
  168298. /* 1 */ "expr ::= expr AND expr",
  168299. /* 2 */ "expr ::= expr OR expr",
  168300. /* 3 */ "expr ::= expr NOT expr",
  168301. /* 4 */ "expr ::= LP expr RP",
  168302. /* 5 */ "expr ::= exprlist",
  168303. /* 6 */ "exprlist ::= cnearset",
  168304. /* 7 */ "exprlist ::= exprlist cnearset",
  168305. /* 8 */ "cnearset ::= nearset",
  168306. /* 9 */ "cnearset ::= colset COLON nearset",
  168307. /* 10 */ "colset ::= MINUS LCP colsetlist RCP",
  168308. /* 11 */ "colset ::= LCP colsetlist RCP",
  168309. /* 12 */ "colset ::= STRING",
  168310. /* 13 */ "colset ::= MINUS STRING",
  168311. /* 14 */ "colsetlist ::= colsetlist STRING",
  168312. /* 15 */ "colsetlist ::= STRING",
  168313. /* 16 */ "nearset ::= phrase",
  168314. /* 17 */ "nearset ::= STRING LP nearphrases neardist_opt RP",
  168315. /* 18 */ "nearphrases ::= phrase",
  168316. /* 19 */ "nearphrases ::= nearphrases phrase",
  168317. /* 20 */ "neardist_opt ::=",
  168318. /* 21 */ "neardist_opt ::= COMMA STRING",
  168319. /* 22 */ "phrase ::= phrase PLUS STRING star_opt",
  168320. /* 23 */ "phrase ::= STRING star_opt",
  168321. /* 24 */ "star_opt ::= STAR",
  168322. /* 25 */ "star_opt ::=",
  168323. };
  168324. #endif /* NDEBUG */
  168325. #if fts5YYSTACKDEPTH<=0
  168326. /*
  168327. ** Try to increase the size of the parser stack. Return the number
  168328. ** of errors. Return 0 on success.
  168329. */
  168330. static int fts5yyGrowStack(fts5yyParser *p){
  168331. int newSize;
  168332. int idx;
  168333. fts5yyStackEntry *pNew;
  168334. newSize = p->fts5yystksz*2 + 100;
  168335. idx = p->fts5yytos ? (int)(p->fts5yytos - p->fts5yystack) : 0;
  168336. if( p->fts5yystack==&p->fts5yystk0 ){
  168337. pNew = malloc(newSize*sizeof(pNew[0]));
  168338. if( pNew ) pNew[0] = p->fts5yystk0;
  168339. }else{
  168340. pNew = realloc(p->fts5yystack, newSize*sizeof(pNew[0]));
  168341. }
  168342. if( pNew ){
  168343. p->fts5yystack = pNew;
  168344. p->fts5yytos = &p->fts5yystack[idx];
  168345. #ifndef NDEBUG
  168346. if( fts5yyTraceFILE ){
  168347. fprintf(fts5yyTraceFILE,"%sStack grows from %d to %d entries.\n",
  168348. fts5yyTracePrompt, p->fts5yystksz, newSize);
  168349. }
  168350. #endif
  168351. p->fts5yystksz = newSize;
  168352. }
  168353. return pNew==0;
  168354. }
  168355. #endif
  168356. /* Datatype of the argument to the memory allocated passed as the
  168357. ** second argument to sqlite3Fts5ParserAlloc() below. This can be changed by
  168358. ** putting an appropriate #define in the %include section of the input
  168359. ** grammar.
  168360. */
  168361. #ifndef fts5YYMALLOCARGTYPE
  168362. # define fts5YYMALLOCARGTYPE size_t
  168363. #endif
  168364. /*
  168365. ** This function allocates a new parser.
  168366. ** The only argument is a pointer to a function which works like
  168367. ** malloc.
  168368. **
  168369. ** Inputs:
  168370. ** A pointer to the function used to allocate memory.
  168371. **
  168372. ** Outputs:
  168373. ** A pointer to a parser. This pointer is used in subsequent calls
  168374. ** to sqlite3Fts5Parser and sqlite3Fts5ParserFree.
  168375. */
  168376. static void *sqlite3Fts5ParserAlloc(void *(*mallocProc)(fts5YYMALLOCARGTYPE)){
  168377. fts5yyParser *pParser;
  168378. pParser = (fts5yyParser*)(*mallocProc)( (fts5YYMALLOCARGTYPE)sizeof(fts5yyParser) );
  168379. if( pParser ){
  168380. #ifdef fts5YYTRACKMAXSTACKDEPTH
  168381. pParser->fts5yyhwm = 0;
  168382. #endif
  168383. #if fts5YYSTACKDEPTH<=0
  168384. pParser->fts5yytos = NULL;
  168385. pParser->fts5yystack = NULL;
  168386. pParser->fts5yystksz = 0;
  168387. if( fts5yyGrowStack(pParser) ){
  168388. pParser->fts5yystack = &pParser->fts5yystk0;
  168389. pParser->fts5yystksz = 1;
  168390. }
  168391. #endif
  168392. #ifndef fts5YYNOERRORRECOVERY
  168393. pParser->fts5yyerrcnt = -1;
  168394. #endif
  168395. pParser->fts5yytos = pParser->fts5yystack;
  168396. pParser->fts5yystack[0].stateno = 0;
  168397. pParser->fts5yystack[0].major = 0;
  168398. }
  168399. return pParser;
  168400. }
  168401. /* The following function deletes the "minor type" or semantic value
  168402. ** associated with a symbol. The symbol can be either a terminal
  168403. ** or nonterminal. "fts5yymajor" is the symbol code, and "fts5yypminor" is
  168404. ** a pointer to the value to be deleted. The code used to do the
  168405. ** deletions is derived from the %destructor and/or %token_destructor
  168406. ** directives of the input grammar.
  168407. */
  168408. static void fts5yy_destructor(
  168409. fts5yyParser *fts5yypParser, /* The parser */
  168410. fts5YYCODETYPE fts5yymajor, /* Type code for object to destroy */
  168411. fts5YYMINORTYPE *fts5yypminor /* The object to be destroyed */
  168412. ){
  168413. sqlite3Fts5ParserARG_FETCH;
  168414. switch( fts5yymajor ){
  168415. /* Here is inserted the actions which take place when a
  168416. ** terminal or non-terminal is destroyed. This can happen
  168417. ** when the symbol is popped from the stack during a
  168418. ** reduce or during error processing or when a parser is
  168419. ** being destroyed before it is finished parsing.
  168420. **
  168421. ** Note: during a reduce, the only symbols destroyed are those
  168422. ** which appear on the RHS of the rule, but which are *not* used
  168423. ** inside the C code.
  168424. */
  168425. /********* Begin destructor definitions ***************************************/
  168426. case 16: /* input */
  168427. {
  168428. (void)pParse;
  168429. }
  168430. break;
  168431. case 17: /* expr */
  168432. case 18: /* cnearset */
  168433. case 19: /* exprlist */
  168434. {
  168435. sqlite3Fts5ParseNodeFree((fts5yypminor->fts5yy24));
  168436. }
  168437. break;
  168438. case 20: /* nearset */
  168439. case 23: /* nearphrases */
  168440. {
  168441. sqlite3Fts5ParseNearsetFree((fts5yypminor->fts5yy46));
  168442. }
  168443. break;
  168444. case 21: /* colset */
  168445. case 22: /* colsetlist */
  168446. {
  168447. sqlite3_free((fts5yypminor->fts5yy11));
  168448. }
  168449. break;
  168450. case 24: /* phrase */
  168451. {
  168452. sqlite3Fts5ParsePhraseFree((fts5yypminor->fts5yy53));
  168453. }
  168454. break;
  168455. /********* End destructor definitions *****************************************/
  168456. default: break; /* If no destructor action specified: do nothing */
  168457. }
  168458. }
  168459. /*
  168460. ** Pop the parser's stack once.
  168461. **
  168462. ** If there is a destructor routine associated with the token which
  168463. ** is popped from the stack, then call it.
  168464. */
  168465. static void fts5yy_pop_parser_stack(fts5yyParser *pParser){
  168466. fts5yyStackEntry *fts5yytos;
  168467. assert( pParser->fts5yytos!=0 );
  168468. assert( pParser->fts5yytos > pParser->fts5yystack );
  168469. fts5yytos = pParser->fts5yytos--;
  168470. #ifndef NDEBUG
  168471. if( fts5yyTraceFILE ){
  168472. fprintf(fts5yyTraceFILE,"%sPopping %s\n",
  168473. fts5yyTracePrompt,
  168474. fts5yyTokenName[fts5yytos->major]);
  168475. }
  168476. #endif
  168477. fts5yy_destructor(pParser, fts5yytos->major, &fts5yytos->minor);
  168478. }
  168479. /*
  168480. ** Deallocate and destroy a parser. Destructors are called for
  168481. ** all stack elements before shutting the parser down.
  168482. **
  168483. ** If the fts5YYPARSEFREENEVERNULL macro exists (for example because it
  168484. ** is defined in a %include section of the input grammar) then it is
  168485. ** assumed that the input pointer is never NULL.
  168486. */
  168487. static void sqlite3Fts5ParserFree(
  168488. void *p, /* The parser to be deleted */
  168489. void (*freeProc)(void*) /* Function used to reclaim memory */
  168490. ){
  168491. fts5yyParser *pParser = (fts5yyParser*)p;
  168492. #ifndef fts5YYPARSEFREENEVERNULL
  168493. if( pParser==0 ) return;
  168494. #endif
  168495. while( pParser->fts5yytos>pParser->fts5yystack ) fts5yy_pop_parser_stack(pParser);
  168496. #if fts5YYSTACKDEPTH<=0
  168497. if( pParser->fts5yystack!=&pParser->fts5yystk0 ) free(pParser->fts5yystack);
  168498. #endif
  168499. (*freeProc)((void*)pParser);
  168500. }
  168501. /*
  168502. ** Return the peak depth of the stack for a parser.
  168503. */
  168504. #ifdef fts5YYTRACKMAXSTACKDEPTH
  168505. static int sqlite3Fts5ParserStackPeak(void *p){
  168506. fts5yyParser *pParser = (fts5yyParser*)p;
  168507. return pParser->fts5yyhwm;
  168508. }
  168509. #endif
  168510. /*
  168511. ** Find the appropriate action for a parser given the terminal
  168512. ** look-ahead token iLookAhead.
  168513. */
  168514. static unsigned int fts5yy_find_shift_action(
  168515. fts5yyParser *pParser, /* The parser */
  168516. fts5YYCODETYPE iLookAhead /* The look-ahead token */
  168517. ){
  168518. int i;
  168519. int stateno = pParser->fts5yytos->stateno;
  168520. if( stateno>=fts5YY_MIN_REDUCE ) return stateno;
  168521. assert( stateno <= fts5YY_SHIFT_COUNT );
  168522. do{
  168523. i = fts5yy_shift_ofst[stateno];
  168524. assert( iLookAhead!=fts5YYNOCODE );
  168525. i += iLookAhead;
  168526. if( i<0 || i>=fts5YY_ACTTAB_COUNT || fts5yy_lookahead[i]!=iLookAhead ){
  168527. #ifdef fts5YYFALLBACK
  168528. fts5YYCODETYPE iFallback; /* Fallback token */
  168529. if( iLookAhead<sizeof(fts5yyFallback)/sizeof(fts5yyFallback[0])
  168530. && (iFallback = fts5yyFallback[iLookAhead])!=0 ){
  168531. #ifndef NDEBUG
  168532. if( fts5yyTraceFILE ){
  168533. fprintf(fts5yyTraceFILE, "%sFALLBACK %s => %s\n",
  168534. fts5yyTracePrompt, fts5yyTokenName[iLookAhead], fts5yyTokenName[iFallback]);
  168535. }
  168536. #endif
  168537. assert( fts5yyFallback[iFallback]==0 ); /* Fallback loop must terminate */
  168538. iLookAhead = iFallback;
  168539. continue;
  168540. }
  168541. #endif
  168542. #ifdef fts5YYWILDCARD
  168543. {
  168544. int j = i - iLookAhead + fts5YYWILDCARD;
  168545. if(
  168546. #if fts5YY_SHIFT_MIN+fts5YYWILDCARD<0
  168547. j>=0 &&
  168548. #endif
  168549. #if fts5YY_SHIFT_MAX+fts5YYWILDCARD>=fts5YY_ACTTAB_COUNT
  168550. j<fts5YY_ACTTAB_COUNT &&
  168551. #endif
  168552. fts5yy_lookahead[j]==fts5YYWILDCARD && iLookAhead>0
  168553. ){
  168554. #ifndef NDEBUG
  168555. if( fts5yyTraceFILE ){
  168556. fprintf(fts5yyTraceFILE, "%sWILDCARD %s => %s\n",
  168557. fts5yyTracePrompt, fts5yyTokenName[iLookAhead],
  168558. fts5yyTokenName[fts5YYWILDCARD]);
  168559. }
  168560. #endif /* NDEBUG */
  168561. return fts5yy_action[j];
  168562. }
  168563. }
  168564. #endif /* fts5YYWILDCARD */
  168565. return fts5yy_default[stateno];
  168566. }else{
  168567. return fts5yy_action[i];
  168568. }
  168569. }while(1);
  168570. }
  168571. /*
  168572. ** Find the appropriate action for a parser given the non-terminal
  168573. ** look-ahead token iLookAhead.
  168574. */
  168575. static int fts5yy_find_reduce_action(
  168576. int stateno, /* Current state number */
  168577. fts5YYCODETYPE iLookAhead /* The look-ahead token */
  168578. ){
  168579. int i;
  168580. #ifdef fts5YYERRORSYMBOL
  168581. if( stateno>fts5YY_REDUCE_COUNT ){
  168582. return fts5yy_default[stateno];
  168583. }
  168584. #else
  168585. assert( stateno<=fts5YY_REDUCE_COUNT );
  168586. #endif
  168587. i = fts5yy_reduce_ofst[stateno];
  168588. assert( i!=fts5YY_REDUCE_USE_DFLT );
  168589. assert( iLookAhead!=fts5YYNOCODE );
  168590. i += iLookAhead;
  168591. #ifdef fts5YYERRORSYMBOL
  168592. if( i<0 || i>=fts5YY_ACTTAB_COUNT || fts5yy_lookahead[i]!=iLookAhead ){
  168593. return fts5yy_default[stateno];
  168594. }
  168595. #else
  168596. assert( i>=0 && i<fts5YY_ACTTAB_COUNT );
  168597. assert( fts5yy_lookahead[i]==iLookAhead );
  168598. #endif
  168599. return fts5yy_action[i];
  168600. }
  168601. /*
  168602. ** The following routine is called if the stack overflows.
  168603. */
  168604. static void fts5yyStackOverflow(fts5yyParser *fts5yypParser){
  168605. sqlite3Fts5ParserARG_FETCH;
  168606. fts5yypParser->fts5yytos--;
  168607. #ifndef NDEBUG
  168608. if( fts5yyTraceFILE ){
  168609. fprintf(fts5yyTraceFILE,"%sStack Overflow!\n",fts5yyTracePrompt);
  168610. }
  168611. #endif
  168612. while( fts5yypParser->fts5yytos>fts5yypParser->fts5yystack ) fts5yy_pop_parser_stack(fts5yypParser);
  168613. /* Here code is inserted which will execute if the parser
  168614. ** stack every overflows */
  168615. /******** Begin %stack_overflow code ******************************************/
  168616. sqlite3Fts5ParseError(pParse, "fts5: parser stack overflow");
  168617. /******** End %stack_overflow code ********************************************/
  168618. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument var */
  168619. }
  168620. /*
  168621. ** Print tracing information for a SHIFT action
  168622. */
  168623. #ifndef NDEBUG
  168624. static void fts5yyTraceShift(fts5yyParser *fts5yypParser, int fts5yyNewState){
  168625. if( fts5yyTraceFILE ){
  168626. if( fts5yyNewState<fts5YYNSTATE ){
  168627. fprintf(fts5yyTraceFILE,"%sShift '%s', go to state %d\n",
  168628. fts5yyTracePrompt,fts5yyTokenName[fts5yypParser->fts5yytos->major],
  168629. fts5yyNewState);
  168630. }else{
  168631. fprintf(fts5yyTraceFILE,"%sShift '%s'\n",
  168632. fts5yyTracePrompt,fts5yyTokenName[fts5yypParser->fts5yytos->major]);
  168633. }
  168634. }
  168635. }
  168636. #else
  168637. # define fts5yyTraceShift(X,Y)
  168638. #endif
  168639. /*
  168640. ** Perform a shift action.
  168641. */
  168642. static void fts5yy_shift(
  168643. fts5yyParser *fts5yypParser, /* The parser to be shifted */
  168644. int fts5yyNewState, /* The new state to shift in */
  168645. int fts5yyMajor, /* The major token to shift in */
  168646. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyMinor /* The minor token to shift in */
  168647. ){
  168648. fts5yyStackEntry *fts5yytos;
  168649. fts5yypParser->fts5yytos++;
  168650. #ifdef fts5YYTRACKMAXSTACKDEPTH
  168651. if( (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack)>fts5yypParser->fts5yyhwm ){
  168652. fts5yypParser->fts5yyhwm++;
  168653. assert( fts5yypParser->fts5yyhwm == (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack) );
  168654. }
  168655. #endif
  168656. #if fts5YYSTACKDEPTH>0
  168657. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5YYSTACKDEPTH] ){
  168658. fts5yyStackOverflow(fts5yypParser);
  168659. return;
  168660. }
  168661. #else
  168662. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5yypParser->fts5yystksz] ){
  168663. if( fts5yyGrowStack(fts5yypParser) ){
  168664. fts5yyStackOverflow(fts5yypParser);
  168665. return;
  168666. }
  168667. }
  168668. #endif
  168669. if( fts5yyNewState > fts5YY_MAX_SHIFT ){
  168670. fts5yyNewState += fts5YY_MIN_REDUCE - fts5YY_MIN_SHIFTREDUCE;
  168671. }
  168672. fts5yytos = fts5yypParser->fts5yytos;
  168673. fts5yytos->stateno = (fts5YYACTIONTYPE)fts5yyNewState;
  168674. fts5yytos->major = (fts5YYCODETYPE)fts5yyMajor;
  168675. fts5yytos->minor.fts5yy0 = fts5yyMinor;
  168676. fts5yyTraceShift(fts5yypParser, fts5yyNewState);
  168677. }
  168678. /* The following table contains information about every rule that
  168679. ** is used during the reduce.
  168680. */
  168681. static const struct {
  168682. fts5YYCODETYPE lhs; /* Symbol on the left-hand side of the rule */
  168683. unsigned char nrhs; /* Number of right-hand side symbols in the rule */
  168684. } fts5yyRuleInfo[] = {
  168685. { 16, 1 },
  168686. { 17, 3 },
  168687. { 17, 3 },
  168688. { 17, 3 },
  168689. { 17, 3 },
  168690. { 17, 1 },
  168691. { 19, 1 },
  168692. { 19, 2 },
  168693. { 18, 1 },
  168694. { 18, 3 },
  168695. { 21, 4 },
  168696. { 21, 3 },
  168697. { 21, 1 },
  168698. { 21, 2 },
  168699. { 22, 2 },
  168700. { 22, 1 },
  168701. { 20, 1 },
  168702. { 20, 5 },
  168703. { 23, 1 },
  168704. { 23, 2 },
  168705. { 25, 0 },
  168706. { 25, 2 },
  168707. { 24, 4 },
  168708. { 24, 2 },
  168709. { 26, 1 },
  168710. { 26, 0 },
  168711. };
  168712. static void fts5yy_accept(fts5yyParser*); /* Forward Declaration */
  168713. /*
  168714. ** Perform a reduce action and the shift that must immediately
  168715. ** follow the reduce.
  168716. */
  168717. static void fts5yy_reduce(
  168718. fts5yyParser *fts5yypParser, /* The parser */
  168719. unsigned int fts5yyruleno /* Number of the rule by which to reduce */
  168720. ){
  168721. int fts5yygoto; /* The next state */
  168722. int fts5yyact; /* The next action */
  168723. fts5yyStackEntry *fts5yymsp; /* The top of the parser's stack */
  168724. int fts5yysize; /* Amount to pop the stack */
  168725. sqlite3Fts5ParserARG_FETCH;
  168726. fts5yymsp = fts5yypParser->fts5yytos;
  168727. #ifndef NDEBUG
  168728. if( fts5yyTraceFILE && fts5yyruleno<(int)(sizeof(fts5yyRuleName)/sizeof(fts5yyRuleName[0])) ){
  168729. fts5yysize = fts5yyRuleInfo[fts5yyruleno].nrhs;
  168730. fprintf(fts5yyTraceFILE, "%sReduce [%s], go to state %d.\n", fts5yyTracePrompt,
  168731. fts5yyRuleName[fts5yyruleno], fts5yymsp[-fts5yysize].stateno);
  168732. }
  168733. #endif /* NDEBUG */
  168734. /* Check that the stack is large enough to grow by a single entry
  168735. ** if the RHS of the rule is empty. This ensures that there is room
  168736. ** enough on the stack to push the LHS value */
  168737. if( fts5yyRuleInfo[fts5yyruleno].nrhs==0 ){
  168738. #ifdef fts5YYTRACKMAXSTACKDEPTH
  168739. if( (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack)>fts5yypParser->fts5yyhwm ){
  168740. fts5yypParser->fts5yyhwm++;
  168741. assert( fts5yypParser->fts5yyhwm == (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack));
  168742. }
  168743. #endif
  168744. #if fts5YYSTACKDEPTH>0
  168745. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5YYSTACKDEPTH-1] ){
  168746. fts5yyStackOverflow(fts5yypParser);
  168747. return;
  168748. }
  168749. #else
  168750. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5yypParser->fts5yystksz-1] ){
  168751. if( fts5yyGrowStack(fts5yypParser) ){
  168752. fts5yyStackOverflow(fts5yypParser);
  168753. return;
  168754. }
  168755. fts5yymsp = fts5yypParser->fts5yytos;
  168756. }
  168757. #endif
  168758. }
  168759. switch( fts5yyruleno ){
  168760. /* Beginning here are the reduction cases. A typical example
  168761. ** follows:
  168762. ** case 0:
  168763. ** #line <lineno> <grammarfile>
  168764. ** { ... } // User supplied code
  168765. ** #line <lineno> <thisfile>
  168766. ** break;
  168767. */
  168768. /********** Begin reduce actions **********************************************/
  168769. fts5YYMINORTYPE fts5yylhsminor;
  168770. case 0: /* input ::= expr */
  168771. { sqlite3Fts5ParseFinished(pParse, fts5yymsp[0].minor.fts5yy24); }
  168772. break;
  168773. case 1: /* expr ::= expr AND expr */
  168774. {
  168775. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseNode(pParse, FTS5_AND, fts5yymsp[-2].minor.fts5yy24, fts5yymsp[0].minor.fts5yy24, 0);
  168776. }
  168777. fts5yymsp[-2].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168778. break;
  168779. case 2: /* expr ::= expr OR expr */
  168780. {
  168781. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseNode(pParse, FTS5_OR, fts5yymsp[-2].minor.fts5yy24, fts5yymsp[0].minor.fts5yy24, 0);
  168782. }
  168783. fts5yymsp[-2].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168784. break;
  168785. case 3: /* expr ::= expr NOT expr */
  168786. {
  168787. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseNode(pParse, FTS5_NOT, fts5yymsp[-2].minor.fts5yy24, fts5yymsp[0].minor.fts5yy24, 0);
  168788. }
  168789. fts5yymsp[-2].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168790. break;
  168791. case 4: /* expr ::= LP expr RP */
  168792. {fts5yymsp[-2].minor.fts5yy24 = fts5yymsp[-1].minor.fts5yy24;}
  168793. break;
  168794. case 5: /* expr ::= exprlist */
  168795. case 6: /* exprlist ::= cnearset */ fts5yytestcase(fts5yyruleno==6);
  168796. {fts5yylhsminor.fts5yy24 = fts5yymsp[0].minor.fts5yy24;}
  168797. fts5yymsp[0].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168798. break;
  168799. case 7: /* exprlist ::= exprlist cnearset */
  168800. {
  168801. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseImplicitAnd(pParse, fts5yymsp[-1].minor.fts5yy24, fts5yymsp[0].minor.fts5yy24);
  168802. }
  168803. fts5yymsp[-1].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168804. break;
  168805. case 8: /* cnearset ::= nearset */
  168806. {
  168807. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseNode(pParse, FTS5_STRING, 0, 0, fts5yymsp[0].minor.fts5yy46);
  168808. }
  168809. fts5yymsp[0].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168810. break;
  168811. case 9: /* cnearset ::= colset COLON nearset */
  168812. {
  168813. sqlite3Fts5ParseSetColset(pParse, fts5yymsp[0].minor.fts5yy46, fts5yymsp[-2].minor.fts5yy11);
  168814. fts5yylhsminor.fts5yy24 = sqlite3Fts5ParseNode(pParse, FTS5_STRING, 0, 0, fts5yymsp[0].minor.fts5yy46);
  168815. }
  168816. fts5yymsp[-2].minor.fts5yy24 = fts5yylhsminor.fts5yy24;
  168817. break;
  168818. case 10: /* colset ::= MINUS LCP colsetlist RCP */
  168819. {
  168820. fts5yymsp[-3].minor.fts5yy11 = sqlite3Fts5ParseColsetInvert(pParse, fts5yymsp[-1].minor.fts5yy11);
  168821. }
  168822. break;
  168823. case 11: /* colset ::= LCP colsetlist RCP */
  168824. { fts5yymsp[-2].minor.fts5yy11 = fts5yymsp[-1].minor.fts5yy11; }
  168825. break;
  168826. case 12: /* colset ::= STRING */
  168827. {
  168828. fts5yylhsminor.fts5yy11 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  168829. }
  168830. fts5yymsp[0].minor.fts5yy11 = fts5yylhsminor.fts5yy11;
  168831. break;
  168832. case 13: /* colset ::= MINUS STRING */
  168833. {
  168834. fts5yymsp[-1].minor.fts5yy11 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  168835. fts5yymsp[-1].minor.fts5yy11 = sqlite3Fts5ParseColsetInvert(pParse, fts5yymsp[-1].minor.fts5yy11);
  168836. }
  168837. break;
  168838. case 14: /* colsetlist ::= colsetlist STRING */
  168839. {
  168840. fts5yylhsminor.fts5yy11 = sqlite3Fts5ParseColset(pParse, fts5yymsp[-1].minor.fts5yy11, &fts5yymsp[0].minor.fts5yy0); }
  168841. fts5yymsp[-1].minor.fts5yy11 = fts5yylhsminor.fts5yy11;
  168842. break;
  168843. case 15: /* colsetlist ::= STRING */
  168844. {
  168845. fts5yylhsminor.fts5yy11 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  168846. }
  168847. fts5yymsp[0].minor.fts5yy11 = fts5yylhsminor.fts5yy11;
  168848. break;
  168849. case 16: /* nearset ::= phrase */
  168850. { fts5yylhsminor.fts5yy46 = sqlite3Fts5ParseNearset(pParse, 0, fts5yymsp[0].minor.fts5yy53); }
  168851. fts5yymsp[0].minor.fts5yy46 = fts5yylhsminor.fts5yy46;
  168852. break;
  168853. case 17: /* nearset ::= STRING LP nearphrases neardist_opt RP */
  168854. {
  168855. sqlite3Fts5ParseNear(pParse, &fts5yymsp[-4].minor.fts5yy0);
  168856. sqlite3Fts5ParseSetDistance(pParse, fts5yymsp[-2].minor.fts5yy46, &fts5yymsp[-1].minor.fts5yy0);
  168857. fts5yylhsminor.fts5yy46 = fts5yymsp[-2].minor.fts5yy46;
  168858. }
  168859. fts5yymsp[-4].minor.fts5yy46 = fts5yylhsminor.fts5yy46;
  168860. break;
  168861. case 18: /* nearphrases ::= phrase */
  168862. {
  168863. fts5yylhsminor.fts5yy46 = sqlite3Fts5ParseNearset(pParse, 0, fts5yymsp[0].minor.fts5yy53);
  168864. }
  168865. fts5yymsp[0].minor.fts5yy46 = fts5yylhsminor.fts5yy46;
  168866. break;
  168867. case 19: /* nearphrases ::= nearphrases phrase */
  168868. {
  168869. fts5yylhsminor.fts5yy46 = sqlite3Fts5ParseNearset(pParse, fts5yymsp[-1].minor.fts5yy46, fts5yymsp[0].minor.fts5yy53);
  168870. }
  168871. fts5yymsp[-1].minor.fts5yy46 = fts5yylhsminor.fts5yy46;
  168872. break;
  168873. case 20: /* neardist_opt ::= */
  168874. { fts5yymsp[1].minor.fts5yy0.p = 0; fts5yymsp[1].minor.fts5yy0.n = 0; }
  168875. break;
  168876. case 21: /* neardist_opt ::= COMMA STRING */
  168877. { fts5yymsp[-1].minor.fts5yy0 = fts5yymsp[0].minor.fts5yy0; }
  168878. break;
  168879. case 22: /* phrase ::= phrase PLUS STRING star_opt */
  168880. {
  168881. fts5yylhsminor.fts5yy53 = sqlite3Fts5ParseTerm(pParse, fts5yymsp[-3].minor.fts5yy53, &fts5yymsp[-1].minor.fts5yy0, fts5yymsp[0].minor.fts5yy4);
  168882. }
  168883. fts5yymsp[-3].minor.fts5yy53 = fts5yylhsminor.fts5yy53;
  168884. break;
  168885. case 23: /* phrase ::= STRING star_opt */
  168886. {
  168887. fts5yylhsminor.fts5yy53 = sqlite3Fts5ParseTerm(pParse, 0, &fts5yymsp[-1].minor.fts5yy0, fts5yymsp[0].minor.fts5yy4);
  168888. }
  168889. fts5yymsp[-1].minor.fts5yy53 = fts5yylhsminor.fts5yy53;
  168890. break;
  168891. case 24: /* star_opt ::= STAR */
  168892. { fts5yymsp[0].minor.fts5yy4 = 1; }
  168893. break;
  168894. case 25: /* star_opt ::= */
  168895. { fts5yymsp[1].minor.fts5yy4 = 0; }
  168896. break;
  168897. default:
  168898. break;
  168899. /********** End reduce actions ************************************************/
  168900. };
  168901. assert( fts5yyruleno<sizeof(fts5yyRuleInfo)/sizeof(fts5yyRuleInfo[0]) );
  168902. fts5yygoto = fts5yyRuleInfo[fts5yyruleno].lhs;
  168903. fts5yysize = fts5yyRuleInfo[fts5yyruleno].nrhs;
  168904. fts5yyact = fts5yy_find_reduce_action(fts5yymsp[-fts5yysize].stateno,(fts5YYCODETYPE)fts5yygoto);
  168905. if( fts5yyact <= fts5YY_MAX_SHIFTREDUCE ){
  168906. if( fts5yyact>fts5YY_MAX_SHIFT ){
  168907. fts5yyact += fts5YY_MIN_REDUCE - fts5YY_MIN_SHIFTREDUCE;
  168908. }
  168909. fts5yymsp -= fts5yysize-1;
  168910. fts5yypParser->fts5yytos = fts5yymsp;
  168911. fts5yymsp->stateno = (fts5YYACTIONTYPE)fts5yyact;
  168912. fts5yymsp->major = (fts5YYCODETYPE)fts5yygoto;
  168913. fts5yyTraceShift(fts5yypParser, fts5yyact);
  168914. }else{
  168915. assert( fts5yyact == fts5YY_ACCEPT_ACTION );
  168916. fts5yypParser->fts5yytos -= fts5yysize;
  168917. fts5yy_accept(fts5yypParser);
  168918. }
  168919. }
  168920. /*
  168921. ** The following code executes when the parse fails
  168922. */
  168923. #ifndef fts5YYNOERRORRECOVERY
  168924. static void fts5yy_parse_failed(
  168925. fts5yyParser *fts5yypParser /* The parser */
  168926. ){
  168927. sqlite3Fts5ParserARG_FETCH;
  168928. #ifndef NDEBUG
  168929. if( fts5yyTraceFILE ){
  168930. fprintf(fts5yyTraceFILE,"%sFail!\n",fts5yyTracePrompt);
  168931. }
  168932. #endif
  168933. while( fts5yypParser->fts5yytos>fts5yypParser->fts5yystack ) fts5yy_pop_parser_stack(fts5yypParser);
  168934. /* Here code is inserted which will be executed whenever the
  168935. ** parser fails */
  168936. /************ Begin %parse_failure code ***************************************/
  168937. /************ End %parse_failure code *****************************************/
  168938. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  168939. }
  168940. #endif /* fts5YYNOERRORRECOVERY */
  168941. /*
  168942. ** The following code executes when a syntax error first occurs.
  168943. */
  168944. static void fts5yy_syntax_error(
  168945. fts5yyParser *fts5yypParser, /* The parser */
  168946. int fts5yymajor, /* The major type of the error token */
  168947. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyminor /* The minor type of the error token */
  168948. ){
  168949. sqlite3Fts5ParserARG_FETCH;
  168950. #define FTS5TOKEN fts5yyminor
  168951. /************ Begin %syntax_error code ****************************************/
  168952. UNUSED_PARAM(fts5yymajor); /* Silence a compiler warning */
  168953. sqlite3Fts5ParseError(
  168954. pParse, "fts5: syntax error near \"%.*s\"",FTS5TOKEN.n,FTS5TOKEN.p
  168955. );
  168956. /************ End %syntax_error code ******************************************/
  168957. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  168958. }
  168959. /*
  168960. ** The following is executed when the parser accepts
  168961. */
  168962. static void fts5yy_accept(
  168963. fts5yyParser *fts5yypParser /* The parser */
  168964. ){
  168965. sqlite3Fts5ParserARG_FETCH;
  168966. #ifndef NDEBUG
  168967. if( fts5yyTraceFILE ){
  168968. fprintf(fts5yyTraceFILE,"%sAccept!\n",fts5yyTracePrompt);
  168969. }
  168970. #endif
  168971. #ifndef fts5YYNOERRORRECOVERY
  168972. fts5yypParser->fts5yyerrcnt = -1;
  168973. #endif
  168974. assert( fts5yypParser->fts5yytos==fts5yypParser->fts5yystack );
  168975. /* Here code is inserted which will be executed whenever the
  168976. ** parser accepts */
  168977. /*********** Begin %parse_accept code *****************************************/
  168978. /*********** End %parse_accept code *******************************************/
  168979. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  168980. }
  168981. /* The main parser program.
  168982. ** The first argument is a pointer to a structure obtained from
  168983. ** "sqlite3Fts5ParserAlloc" which describes the current state of the parser.
  168984. ** The second argument is the major token number. The third is
  168985. ** the minor token. The fourth optional argument is whatever the
  168986. ** user wants (and specified in the grammar) and is available for
  168987. ** use by the action routines.
  168988. **
  168989. ** Inputs:
  168990. ** <ul>
  168991. ** <li> A pointer to the parser (an opaque structure.)
  168992. ** <li> The major token number.
  168993. ** <li> The minor token number.
  168994. ** <li> An option argument of a grammar-specified type.
  168995. ** </ul>
  168996. **
  168997. ** Outputs:
  168998. ** None.
  168999. */
  169000. static void sqlite3Fts5Parser(
  169001. void *fts5yyp, /* The parser */
  169002. int fts5yymajor, /* The major token code number */
  169003. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyminor /* The value for the token */
  169004. sqlite3Fts5ParserARG_PDECL /* Optional %extra_argument parameter */
  169005. ){
  169006. fts5YYMINORTYPE fts5yyminorunion;
  169007. unsigned int fts5yyact; /* The parser action. */
  169008. #if !defined(fts5YYERRORSYMBOL) && !defined(fts5YYNOERRORRECOVERY)
  169009. int fts5yyendofinput; /* True if we are at the end of input */
  169010. #endif
  169011. #ifdef fts5YYERRORSYMBOL
  169012. int fts5yyerrorhit = 0; /* True if fts5yymajor has invoked an error */
  169013. #endif
  169014. fts5yyParser *fts5yypParser; /* The parser */
  169015. fts5yypParser = (fts5yyParser*)fts5yyp;
  169016. assert( fts5yypParser->fts5yytos!=0 );
  169017. #if !defined(fts5YYERRORSYMBOL) && !defined(fts5YYNOERRORRECOVERY)
  169018. fts5yyendofinput = (fts5yymajor==0);
  169019. #endif
  169020. sqlite3Fts5ParserARG_STORE;
  169021. #ifndef NDEBUG
  169022. if( fts5yyTraceFILE ){
  169023. fprintf(fts5yyTraceFILE,"%sInput '%s'\n",fts5yyTracePrompt,fts5yyTokenName[fts5yymajor]);
  169024. }
  169025. #endif
  169026. do{
  169027. fts5yyact = fts5yy_find_shift_action(fts5yypParser,(fts5YYCODETYPE)fts5yymajor);
  169028. if( fts5yyact <= fts5YY_MAX_SHIFTREDUCE ){
  169029. fts5yy_shift(fts5yypParser,fts5yyact,fts5yymajor,fts5yyminor);
  169030. #ifndef fts5YYNOERRORRECOVERY
  169031. fts5yypParser->fts5yyerrcnt--;
  169032. #endif
  169033. fts5yymajor = fts5YYNOCODE;
  169034. }else if( fts5yyact <= fts5YY_MAX_REDUCE ){
  169035. fts5yy_reduce(fts5yypParser,fts5yyact-fts5YY_MIN_REDUCE);
  169036. }else{
  169037. assert( fts5yyact == fts5YY_ERROR_ACTION );
  169038. fts5yyminorunion.fts5yy0 = fts5yyminor;
  169039. #ifdef fts5YYERRORSYMBOL
  169040. int fts5yymx;
  169041. #endif
  169042. #ifndef NDEBUG
  169043. if( fts5yyTraceFILE ){
  169044. fprintf(fts5yyTraceFILE,"%sSyntax Error!\n",fts5yyTracePrompt);
  169045. }
  169046. #endif
  169047. #ifdef fts5YYERRORSYMBOL
  169048. /* A syntax error has occurred.
  169049. ** The response to an error depends upon whether or not the
  169050. ** grammar defines an error token "ERROR".
  169051. **
  169052. ** This is what we do if the grammar does define ERROR:
  169053. **
  169054. ** * Call the %syntax_error function.
  169055. **
  169056. ** * Begin popping the stack until we enter a state where
  169057. ** it is legal to shift the error symbol, then shift
  169058. ** the error symbol.
  169059. **
  169060. ** * Set the error count to three.
  169061. **
  169062. ** * Begin accepting and shifting new tokens. No new error
  169063. ** processing will occur until three tokens have been
  169064. ** shifted successfully.
  169065. **
  169066. */
  169067. if( fts5yypParser->fts5yyerrcnt<0 ){
  169068. fts5yy_syntax_error(fts5yypParser,fts5yymajor,fts5yyminor);
  169069. }
  169070. fts5yymx = fts5yypParser->fts5yytos->major;
  169071. if( fts5yymx==fts5YYERRORSYMBOL || fts5yyerrorhit ){
  169072. #ifndef NDEBUG
  169073. if( fts5yyTraceFILE ){
  169074. fprintf(fts5yyTraceFILE,"%sDiscard input token %s\n",
  169075. fts5yyTracePrompt,fts5yyTokenName[fts5yymajor]);
  169076. }
  169077. #endif
  169078. fts5yy_destructor(fts5yypParser, (fts5YYCODETYPE)fts5yymajor, &fts5yyminorunion);
  169079. fts5yymajor = fts5YYNOCODE;
  169080. }else{
  169081. while( fts5yypParser->fts5yytos >= fts5yypParser->fts5yystack
  169082. && fts5yymx != fts5YYERRORSYMBOL
  169083. && (fts5yyact = fts5yy_find_reduce_action(
  169084. fts5yypParser->fts5yytos->stateno,
  169085. fts5YYERRORSYMBOL)) >= fts5YY_MIN_REDUCE
  169086. ){
  169087. fts5yy_pop_parser_stack(fts5yypParser);
  169088. }
  169089. if( fts5yypParser->fts5yytos < fts5yypParser->fts5yystack || fts5yymajor==0 ){
  169090. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  169091. fts5yy_parse_failed(fts5yypParser);
  169092. #ifndef fts5YYNOERRORRECOVERY
  169093. fts5yypParser->fts5yyerrcnt = -1;
  169094. #endif
  169095. fts5yymajor = fts5YYNOCODE;
  169096. }else if( fts5yymx!=fts5YYERRORSYMBOL ){
  169097. fts5yy_shift(fts5yypParser,fts5yyact,fts5YYERRORSYMBOL,fts5yyminor);
  169098. }
  169099. }
  169100. fts5yypParser->fts5yyerrcnt = 3;
  169101. fts5yyerrorhit = 1;
  169102. #elif defined(fts5YYNOERRORRECOVERY)
  169103. /* If the fts5YYNOERRORRECOVERY macro is defined, then do not attempt to
  169104. ** do any kind of error recovery. Instead, simply invoke the syntax
  169105. ** error routine and continue going as if nothing had happened.
  169106. **
  169107. ** Applications can set this macro (for example inside %include) if
  169108. ** they intend to abandon the parse upon the first syntax error seen.
  169109. */
  169110. fts5yy_syntax_error(fts5yypParser,fts5yymajor, fts5yyminor);
  169111. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  169112. fts5yymajor = fts5YYNOCODE;
  169113. #else /* fts5YYERRORSYMBOL is not defined */
  169114. /* This is what we do if the grammar does not define ERROR:
  169115. **
  169116. ** * Report an error message, and throw away the input token.
  169117. **
  169118. ** * If the input token is $, then fail the parse.
  169119. **
  169120. ** As before, subsequent error messages are suppressed until
  169121. ** three input tokens have been successfully shifted.
  169122. */
  169123. if( fts5yypParser->fts5yyerrcnt<=0 ){
  169124. fts5yy_syntax_error(fts5yypParser,fts5yymajor, fts5yyminor);
  169125. }
  169126. fts5yypParser->fts5yyerrcnt = 3;
  169127. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  169128. if( fts5yyendofinput ){
  169129. fts5yy_parse_failed(fts5yypParser);
  169130. #ifndef fts5YYNOERRORRECOVERY
  169131. fts5yypParser->fts5yyerrcnt = -1;
  169132. #endif
  169133. }
  169134. fts5yymajor = fts5YYNOCODE;
  169135. #endif
  169136. }
  169137. }while( fts5yymajor!=fts5YYNOCODE && fts5yypParser->fts5yytos>fts5yypParser->fts5yystack );
  169138. #ifndef NDEBUG
  169139. if( fts5yyTraceFILE ){
  169140. fts5yyStackEntry *i;
  169141. char cDiv = '[';
  169142. fprintf(fts5yyTraceFILE,"%sReturn. Stack=",fts5yyTracePrompt);
  169143. for(i=&fts5yypParser->fts5yystack[1]; i<=fts5yypParser->fts5yytos; i++){
  169144. fprintf(fts5yyTraceFILE,"%c%s", cDiv, fts5yyTokenName[i->major]);
  169145. cDiv = ' ';
  169146. }
  169147. fprintf(fts5yyTraceFILE,"]\n");
  169148. }
  169149. #endif
  169150. return;
  169151. }
  169152. /*
  169153. ** 2014 May 31
  169154. **
  169155. ** The author disclaims copyright to this source code. In place of
  169156. ** a legal notice, here is a blessing:
  169157. **
  169158. ** May you do good and not evil.
  169159. ** May you find forgiveness for yourself and forgive others.
  169160. ** May you share freely, never taking more than you give.
  169161. **
  169162. ******************************************************************************
  169163. */
  169164. /* #include "fts5Int.h" */
  169165. #include <math.h> /* amalgamator: keep */
  169166. /*
  169167. ** Object used to iterate through all "coalesced phrase instances" in
  169168. ** a single column of the current row. If the phrase instances in the
  169169. ** column being considered do not overlap, this object simply iterates
  169170. ** through them. Or, if they do overlap (share one or more tokens in
  169171. ** common), each set of overlapping instances is treated as a single
  169172. ** match. See documentation for the highlight() auxiliary function for
  169173. ** details.
  169174. **
  169175. ** Usage is:
  169176. **
  169177. ** for(rc = fts5CInstIterNext(pApi, pFts, iCol, &iter);
  169178. ** (rc==SQLITE_OK && 0==fts5CInstIterEof(&iter);
  169179. ** rc = fts5CInstIterNext(&iter)
  169180. ** ){
  169181. ** printf("instance starts at %d, ends at %d\n", iter.iStart, iter.iEnd);
  169182. ** }
  169183. **
  169184. */
  169185. typedef struct CInstIter CInstIter;
  169186. struct CInstIter {
  169187. const Fts5ExtensionApi *pApi; /* API offered by current FTS version */
  169188. Fts5Context *pFts; /* First arg to pass to pApi functions */
  169189. int iCol; /* Column to search */
  169190. int iInst; /* Next phrase instance index */
  169191. int nInst; /* Total number of phrase instances */
  169192. /* Output variables */
  169193. int iStart; /* First token in coalesced phrase instance */
  169194. int iEnd; /* Last token in coalesced phrase instance */
  169195. };
  169196. /*
  169197. ** Advance the iterator to the next coalesced phrase instance. Return
  169198. ** an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  169199. */
  169200. static int fts5CInstIterNext(CInstIter *pIter){
  169201. int rc = SQLITE_OK;
  169202. pIter->iStart = -1;
  169203. pIter->iEnd = -1;
  169204. while( rc==SQLITE_OK && pIter->iInst<pIter->nInst ){
  169205. int ip; int ic; int io;
  169206. rc = pIter->pApi->xInst(pIter->pFts, pIter->iInst, &ip, &ic, &io);
  169207. if( rc==SQLITE_OK ){
  169208. if( ic==pIter->iCol ){
  169209. int iEnd = io - 1 + pIter->pApi->xPhraseSize(pIter->pFts, ip);
  169210. if( pIter->iStart<0 ){
  169211. pIter->iStart = io;
  169212. pIter->iEnd = iEnd;
  169213. }else if( io<=pIter->iEnd ){
  169214. if( iEnd>pIter->iEnd ) pIter->iEnd = iEnd;
  169215. }else{
  169216. break;
  169217. }
  169218. }
  169219. pIter->iInst++;
  169220. }
  169221. }
  169222. return rc;
  169223. }
  169224. /*
  169225. ** Initialize the iterator object indicated by the final parameter to
  169226. ** iterate through coalesced phrase instances in column iCol.
  169227. */
  169228. static int fts5CInstIterInit(
  169229. const Fts5ExtensionApi *pApi,
  169230. Fts5Context *pFts,
  169231. int iCol,
  169232. CInstIter *pIter
  169233. ){
  169234. int rc;
  169235. memset(pIter, 0, sizeof(CInstIter));
  169236. pIter->pApi = pApi;
  169237. pIter->pFts = pFts;
  169238. pIter->iCol = iCol;
  169239. rc = pApi->xInstCount(pFts, &pIter->nInst);
  169240. if( rc==SQLITE_OK ){
  169241. rc = fts5CInstIterNext(pIter);
  169242. }
  169243. return rc;
  169244. }
  169245. /*************************************************************************
  169246. ** Start of highlight() implementation.
  169247. */
  169248. typedef struct HighlightContext HighlightContext;
  169249. struct HighlightContext {
  169250. CInstIter iter; /* Coalesced Instance Iterator */
  169251. int iPos; /* Current token offset in zIn[] */
  169252. int iRangeStart; /* First token to include */
  169253. int iRangeEnd; /* If non-zero, last token to include */
  169254. const char *zOpen; /* Opening highlight */
  169255. const char *zClose; /* Closing highlight */
  169256. const char *zIn; /* Input text */
  169257. int nIn; /* Size of input text in bytes */
  169258. int iOff; /* Current offset within zIn[] */
  169259. char *zOut; /* Output value */
  169260. };
  169261. /*
  169262. ** Append text to the HighlightContext output string - p->zOut. Argument
  169263. ** z points to a buffer containing n bytes of text to append. If n is
  169264. ** negative, everything up until the first '\0' is appended to the output.
  169265. **
  169266. ** If *pRc is set to any value other than SQLITE_OK when this function is
  169267. ** called, it is a no-op. If an error (i.e. an OOM condition) is encountered,
  169268. ** *pRc is set to an error code before returning.
  169269. */
  169270. static void fts5HighlightAppend(
  169271. int *pRc,
  169272. HighlightContext *p,
  169273. const char *z, int n
  169274. ){
  169275. if( *pRc==SQLITE_OK ){
  169276. if( n<0 ) n = (int)strlen(z);
  169277. p->zOut = sqlite3_mprintf("%z%.*s", p->zOut, n, z);
  169278. if( p->zOut==0 ) *pRc = SQLITE_NOMEM;
  169279. }
  169280. }
  169281. /*
  169282. ** Tokenizer callback used by implementation of highlight() function.
  169283. */
  169284. static int fts5HighlightCb(
  169285. void *pContext, /* Pointer to HighlightContext object */
  169286. int tflags, /* Mask of FTS5_TOKEN_* flags */
  169287. const char *pToken, /* Buffer containing token */
  169288. int nToken, /* Size of token in bytes */
  169289. int iStartOff, /* Start offset of token */
  169290. int iEndOff /* End offset of token */
  169291. ){
  169292. HighlightContext *p = (HighlightContext*)pContext;
  169293. int rc = SQLITE_OK;
  169294. int iPos;
  169295. UNUSED_PARAM2(pToken, nToken);
  169296. if( tflags & FTS5_TOKEN_COLOCATED ) return SQLITE_OK;
  169297. iPos = p->iPos++;
  169298. if( p->iRangeEnd>0 ){
  169299. if( iPos<p->iRangeStart || iPos>p->iRangeEnd ) return SQLITE_OK;
  169300. if( p->iRangeStart && iPos==p->iRangeStart ) p->iOff = iStartOff;
  169301. }
  169302. if( iPos==p->iter.iStart ){
  169303. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iStartOff - p->iOff);
  169304. fts5HighlightAppend(&rc, p, p->zOpen, -1);
  169305. p->iOff = iStartOff;
  169306. }
  169307. if( iPos==p->iter.iEnd ){
  169308. if( p->iRangeEnd && p->iter.iStart<p->iRangeStart ){
  169309. fts5HighlightAppend(&rc, p, p->zOpen, -1);
  169310. }
  169311. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iEndOff - p->iOff);
  169312. fts5HighlightAppend(&rc, p, p->zClose, -1);
  169313. p->iOff = iEndOff;
  169314. if( rc==SQLITE_OK ){
  169315. rc = fts5CInstIterNext(&p->iter);
  169316. }
  169317. }
  169318. if( p->iRangeEnd>0 && iPos==p->iRangeEnd ){
  169319. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iEndOff - p->iOff);
  169320. p->iOff = iEndOff;
  169321. if( iPos>=p->iter.iStart && iPos<p->iter.iEnd ){
  169322. fts5HighlightAppend(&rc, p, p->zClose, -1);
  169323. }
  169324. }
  169325. return rc;
  169326. }
  169327. /*
  169328. ** Implementation of highlight() function.
  169329. */
  169330. static void fts5HighlightFunction(
  169331. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  169332. Fts5Context *pFts, /* First arg to pass to pApi functions */
  169333. sqlite3_context *pCtx, /* Context for returning result/error */
  169334. int nVal, /* Number of values in apVal[] array */
  169335. sqlite3_value **apVal /* Array of trailing arguments */
  169336. ){
  169337. HighlightContext ctx;
  169338. int rc;
  169339. int iCol;
  169340. if( nVal!=3 ){
  169341. const char *zErr = "wrong number of arguments to function highlight()";
  169342. sqlite3_result_error(pCtx, zErr, -1);
  169343. return;
  169344. }
  169345. iCol = sqlite3_value_int(apVal[0]);
  169346. memset(&ctx, 0, sizeof(HighlightContext));
  169347. ctx.zOpen = (const char*)sqlite3_value_text(apVal[1]);
  169348. ctx.zClose = (const char*)sqlite3_value_text(apVal[2]);
  169349. rc = pApi->xColumnText(pFts, iCol, &ctx.zIn, &ctx.nIn);
  169350. if( ctx.zIn ){
  169351. if( rc==SQLITE_OK ){
  169352. rc = fts5CInstIterInit(pApi, pFts, iCol, &ctx.iter);
  169353. }
  169354. if( rc==SQLITE_OK ){
  169355. rc = pApi->xTokenize(pFts, ctx.zIn, ctx.nIn, (void*)&ctx,fts5HighlightCb);
  169356. }
  169357. fts5HighlightAppend(&rc, &ctx, &ctx.zIn[ctx.iOff], ctx.nIn - ctx.iOff);
  169358. if( rc==SQLITE_OK ){
  169359. sqlite3_result_text(pCtx, (const char*)ctx.zOut, -1, SQLITE_TRANSIENT);
  169360. }
  169361. sqlite3_free(ctx.zOut);
  169362. }
  169363. if( rc!=SQLITE_OK ){
  169364. sqlite3_result_error_code(pCtx, rc);
  169365. }
  169366. }
  169367. /*
  169368. ** End of highlight() implementation.
  169369. **************************************************************************/
  169370. /*
  169371. ** Context object passed to the fts5SentenceFinderCb() function.
  169372. */
  169373. typedef struct Fts5SFinder Fts5SFinder;
  169374. struct Fts5SFinder {
  169375. int iPos; /* Current token position */
  169376. int nFirstAlloc; /* Allocated size of aFirst[] */
  169377. int nFirst; /* Number of entries in aFirst[] */
  169378. int *aFirst; /* Array of first token in each sentence */
  169379. const char *zDoc; /* Document being tokenized */
  169380. };
  169381. /*
  169382. ** Add an entry to the Fts5SFinder.aFirst[] array. Grow the array if
  169383. ** necessary. Return SQLITE_OK if successful, or SQLITE_NOMEM if an
  169384. ** error occurs.
  169385. */
  169386. static int fts5SentenceFinderAdd(Fts5SFinder *p, int iAdd){
  169387. if( p->nFirstAlloc==p->nFirst ){
  169388. int nNew = p->nFirstAlloc ? p->nFirstAlloc*2 : 64;
  169389. int *aNew;
  169390. aNew = (int*)sqlite3_realloc(p->aFirst, nNew*sizeof(int));
  169391. if( aNew==0 ) return SQLITE_NOMEM;
  169392. p->aFirst = aNew;
  169393. p->nFirstAlloc = nNew;
  169394. }
  169395. p->aFirst[p->nFirst++] = iAdd;
  169396. return SQLITE_OK;
  169397. }
  169398. /*
  169399. ** This function is an xTokenize() callback used by the auxiliary snippet()
  169400. ** function. Its job is to identify tokens that are the first in a sentence.
  169401. ** For each such token, an entry is added to the SFinder.aFirst[] array.
  169402. */
  169403. static int fts5SentenceFinderCb(
  169404. void *pContext, /* Pointer to HighlightContext object */
  169405. int tflags, /* Mask of FTS5_TOKEN_* flags */
  169406. const char *pToken, /* Buffer containing token */
  169407. int nToken, /* Size of token in bytes */
  169408. int iStartOff, /* Start offset of token */
  169409. int iEndOff /* End offset of token */
  169410. ){
  169411. int rc = SQLITE_OK;
  169412. UNUSED_PARAM2(pToken, nToken);
  169413. UNUSED_PARAM(iEndOff);
  169414. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ){
  169415. Fts5SFinder *p = (Fts5SFinder*)pContext;
  169416. if( p->iPos>0 ){
  169417. int i;
  169418. char c = 0;
  169419. for(i=iStartOff-1; i>=0; i--){
  169420. c = p->zDoc[i];
  169421. if( c!=' ' && c!='\t' && c!='\n' && c!='\r' ) break;
  169422. }
  169423. if( i!=iStartOff-1 && (c=='.' || c==':') ){
  169424. rc = fts5SentenceFinderAdd(p, p->iPos);
  169425. }
  169426. }else{
  169427. rc = fts5SentenceFinderAdd(p, 0);
  169428. }
  169429. p->iPos++;
  169430. }
  169431. return rc;
  169432. }
  169433. static int fts5SnippetScore(
  169434. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  169435. Fts5Context *pFts, /* First arg to pass to pApi functions */
  169436. int nDocsize, /* Size of column in tokens */
  169437. unsigned char *aSeen, /* Array with one element per query phrase */
  169438. int iCol, /* Column to score */
  169439. int iPos, /* Starting offset to score */
  169440. int nToken, /* Max tokens per snippet */
  169441. int *pnScore, /* OUT: Score */
  169442. int *piPos /* OUT: Adjusted offset */
  169443. ){
  169444. int rc;
  169445. int i;
  169446. int ip = 0;
  169447. int ic = 0;
  169448. int iOff = 0;
  169449. int iFirst = -1;
  169450. int nInst;
  169451. int nScore = 0;
  169452. int iLast = 0;
  169453. rc = pApi->xInstCount(pFts, &nInst);
  169454. for(i=0; i<nInst && rc==SQLITE_OK; i++){
  169455. rc = pApi->xInst(pFts, i, &ip, &ic, &iOff);
  169456. if( rc==SQLITE_OK && ic==iCol && iOff>=iPos && iOff<(iPos+nToken) ){
  169457. nScore += (aSeen[ip] ? 1 : 1000);
  169458. aSeen[ip] = 1;
  169459. if( iFirst<0 ) iFirst = iOff;
  169460. iLast = iOff + pApi->xPhraseSize(pFts, ip);
  169461. }
  169462. }
  169463. *pnScore = nScore;
  169464. if( piPos ){
  169465. int iAdj = iFirst - (nToken - (iLast-iFirst)) / 2;
  169466. if( (iAdj+nToken)>nDocsize ) iAdj = nDocsize - nToken;
  169467. if( iAdj<0 ) iAdj = 0;
  169468. *piPos = iAdj;
  169469. }
  169470. return rc;
  169471. }
  169472. /*
  169473. ** Implementation of snippet() function.
  169474. */
  169475. static void fts5SnippetFunction(
  169476. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  169477. Fts5Context *pFts, /* First arg to pass to pApi functions */
  169478. sqlite3_context *pCtx, /* Context for returning result/error */
  169479. int nVal, /* Number of values in apVal[] array */
  169480. sqlite3_value **apVal /* Array of trailing arguments */
  169481. ){
  169482. HighlightContext ctx;
  169483. int rc = SQLITE_OK; /* Return code */
  169484. int iCol; /* 1st argument to snippet() */
  169485. const char *zEllips; /* 4th argument to snippet() */
  169486. int nToken; /* 5th argument to snippet() */
  169487. int nInst = 0; /* Number of instance matches this row */
  169488. int i; /* Used to iterate through instances */
  169489. int nPhrase; /* Number of phrases in query */
  169490. unsigned char *aSeen; /* Array of "seen instance" flags */
  169491. int iBestCol; /* Column containing best snippet */
  169492. int iBestStart = 0; /* First token of best snippet */
  169493. int nBestScore = 0; /* Score of best snippet */
  169494. int nColSize = 0; /* Total size of iBestCol in tokens */
  169495. Fts5SFinder sFinder; /* Used to find the beginnings of sentences */
  169496. int nCol;
  169497. if( nVal!=5 ){
  169498. const char *zErr = "wrong number of arguments to function snippet()";
  169499. sqlite3_result_error(pCtx, zErr, -1);
  169500. return;
  169501. }
  169502. nCol = pApi->xColumnCount(pFts);
  169503. memset(&ctx, 0, sizeof(HighlightContext));
  169504. iCol = sqlite3_value_int(apVal[0]);
  169505. ctx.zOpen = (const char*)sqlite3_value_text(apVal[1]);
  169506. ctx.zClose = (const char*)sqlite3_value_text(apVal[2]);
  169507. zEllips = (const char*)sqlite3_value_text(apVal[3]);
  169508. nToken = sqlite3_value_int(apVal[4]);
  169509. iBestCol = (iCol>=0 ? iCol : 0);
  169510. nPhrase = pApi->xPhraseCount(pFts);
  169511. aSeen = sqlite3_malloc(nPhrase);
  169512. if( aSeen==0 ){
  169513. rc = SQLITE_NOMEM;
  169514. }
  169515. if( rc==SQLITE_OK ){
  169516. rc = pApi->xInstCount(pFts, &nInst);
  169517. }
  169518. memset(&sFinder, 0, sizeof(Fts5SFinder));
  169519. for(i=0; i<nCol; i++){
  169520. if( iCol<0 || iCol==i ){
  169521. int nDoc;
  169522. int nDocsize;
  169523. int ii;
  169524. sFinder.iPos = 0;
  169525. sFinder.nFirst = 0;
  169526. rc = pApi->xColumnText(pFts, i, &sFinder.zDoc, &nDoc);
  169527. if( rc!=SQLITE_OK ) break;
  169528. rc = pApi->xTokenize(pFts,
  169529. sFinder.zDoc, nDoc, (void*)&sFinder,fts5SentenceFinderCb
  169530. );
  169531. if( rc!=SQLITE_OK ) break;
  169532. rc = pApi->xColumnSize(pFts, i, &nDocsize);
  169533. if( rc!=SQLITE_OK ) break;
  169534. for(ii=0; rc==SQLITE_OK && ii<nInst; ii++){
  169535. int ip, ic, io;
  169536. int iAdj;
  169537. int nScore;
  169538. int jj;
  169539. rc = pApi->xInst(pFts, ii, &ip, &ic, &io);
  169540. if( ic!=i || rc!=SQLITE_OK ) continue;
  169541. memset(aSeen, 0, nPhrase);
  169542. rc = fts5SnippetScore(pApi, pFts, nDocsize, aSeen, i,
  169543. io, nToken, &nScore, &iAdj
  169544. );
  169545. if( rc==SQLITE_OK && nScore>nBestScore ){
  169546. nBestScore = nScore;
  169547. iBestCol = i;
  169548. iBestStart = iAdj;
  169549. nColSize = nDocsize;
  169550. }
  169551. if( rc==SQLITE_OK && sFinder.nFirst && nDocsize>nToken ){
  169552. for(jj=0; jj<(sFinder.nFirst-1); jj++){
  169553. if( sFinder.aFirst[jj+1]>io ) break;
  169554. }
  169555. if( sFinder.aFirst[jj]<io ){
  169556. memset(aSeen, 0, nPhrase);
  169557. rc = fts5SnippetScore(pApi, pFts, nDocsize, aSeen, i,
  169558. sFinder.aFirst[jj], nToken, &nScore, 0
  169559. );
  169560. nScore += (sFinder.aFirst[jj]==0 ? 120 : 100);
  169561. if( rc==SQLITE_OK && nScore>nBestScore ){
  169562. nBestScore = nScore;
  169563. iBestCol = i;
  169564. iBestStart = sFinder.aFirst[jj];
  169565. nColSize = nDocsize;
  169566. }
  169567. }
  169568. }
  169569. }
  169570. }
  169571. }
  169572. if( rc==SQLITE_OK ){
  169573. rc = pApi->xColumnText(pFts, iBestCol, &ctx.zIn, &ctx.nIn);
  169574. }
  169575. if( rc==SQLITE_OK && nColSize==0 ){
  169576. rc = pApi->xColumnSize(pFts, iBestCol, &nColSize);
  169577. }
  169578. if( ctx.zIn ){
  169579. if( rc==SQLITE_OK ){
  169580. rc = fts5CInstIterInit(pApi, pFts, iBestCol, &ctx.iter);
  169581. }
  169582. ctx.iRangeStart = iBestStart;
  169583. ctx.iRangeEnd = iBestStart + nToken - 1;
  169584. if( iBestStart>0 ){
  169585. fts5HighlightAppend(&rc, &ctx, zEllips, -1);
  169586. }
  169587. /* Advance iterator ctx.iter so that it points to the first coalesced
  169588. ** phrase instance at or following position iBestStart. */
  169589. while( ctx.iter.iStart>=0 && ctx.iter.iStart<iBestStart && rc==SQLITE_OK ){
  169590. rc = fts5CInstIterNext(&ctx.iter);
  169591. }
  169592. if( rc==SQLITE_OK ){
  169593. rc = pApi->xTokenize(pFts, ctx.zIn, ctx.nIn, (void*)&ctx,fts5HighlightCb);
  169594. }
  169595. if( ctx.iRangeEnd>=(nColSize-1) ){
  169596. fts5HighlightAppend(&rc, &ctx, &ctx.zIn[ctx.iOff], ctx.nIn - ctx.iOff);
  169597. }else{
  169598. fts5HighlightAppend(&rc, &ctx, zEllips, -1);
  169599. }
  169600. }
  169601. if( rc==SQLITE_OK ){
  169602. sqlite3_result_text(pCtx, (const char*)ctx.zOut, -1, SQLITE_TRANSIENT);
  169603. }else{
  169604. sqlite3_result_error_code(pCtx, rc);
  169605. }
  169606. sqlite3_free(ctx.zOut);
  169607. sqlite3_free(aSeen);
  169608. sqlite3_free(sFinder.aFirst);
  169609. }
  169610. /************************************************************************/
  169611. /*
  169612. ** The first time the bm25() function is called for a query, an instance
  169613. ** of the following structure is allocated and populated.
  169614. */
  169615. typedef struct Fts5Bm25Data Fts5Bm25Data;
  169616. struct Fts5Bm25Data {
  169617. int nPhrase; /* Number of phrases in query */
  169618. double avgdl; /* Average number of tokens in each row */
  169619. double *aIDF; /* IDF for each phrase */
  169620. double *aFreq; /* Array used to calculate phrase freq. */
  169621. };
  169622. /*
  169623. ** Callback used by fts5Bm25GetData() to count the number of rows in the
  169624. ** table matched by each individual phrase within the query.
  169625. */
  169626. static int fts5CountCb(
  169627. const Fts5ExtensionApi *pApi,
  169628. Fts5Context *pFts,
  169629. void *pUserData /* Pointer to sqlite3_int64 variable */
  169630. ){
  169631. sqlite3_int64 *pn = (sqlite3_int64*)pUserData;
  169632. UNUSED_PARAM2(pApi, pFts);
  169633. (*pn)++;
  169634. return SQLITE_OK;
  169635. }
  169636. /*
  169637. ** Set *ppData to point to the Fts5Bm25Data object for the current query.
  169638. ** If the object has not already been allocated, allocate and populate it
  169639. ** now.
  169640. */
  169641. static int fts5Bm25GetData(
  169642. const Fts5ExtensionApi *pApi,
  169643. Fts5Context *pFts,
  169644. Fts5Bm25Data **ppData /* OUT: bm25-data object for this query */
  169645. ){
  169646. int rc = SQLITE_OK; /* Return code */
  169647. Fts5Bm25Data *p; /* Object to return */
  169648. p = pApi->xGetAuxdata(pFts, 0);
  169649. if( p==0 ){
  169650. int nPhrase; /* Number of phrases in query */
  169651. sqlite3_int64 nRow = 0; /* Number of rows in table */
  169652. sqlite3_int64 nToken = 0; /* Number of tokens in table */
  169653. int nByte; /* Bytes of space to allocate */
  169654. int i;
  169655. /* Allocate the Fts5Bm25Data object */
  169656. nPhrase = pApi->xPhraseCount(pFts);
  169657. nByte = sizeof(Fts5Bm25Data) + nPhrase*2*sizeof(double);
  169658. p = (Fts5Bm25Data*)sqlite3_malloc(nByte);
  169659. if( p==0 ){
  169660. rc = SQLITE_NOMEM;
  169661. }else{
  169662. memset(p, 0, nByte);
  169663. p->nPhrase = nPhrase;
  169664. p->aIDF = (double*)&p[1];
  169665. p->aFreq = &p->aIDF[nPhrase];
  169666. }
  169667. /* Calculate the average document length for this FTS5 table */
  169668. if( rc==SQLITE_OK ) rc = pApi->xRowCount(pFts, &nRow);
  169669. if( rc==SQLITE_OK ) rc = pApi->xColumnTotalSize(pFts, -1, &nToken);
  169670. if( rc==SQLITE_OK ) p->avgdl = (double)nToken / (double)nRow;
  169671. /* Calculate an IDF for each phrase in the query */
  169672. for(i=0; rc==SQLITE_OK && i<nPhrase; i++){
  169673. sqlite3_int64 nHit = 0;
  169674. rc = pApi->xQueryPhrase(pFts, i, (void*)&nHit, fts5CountCb);
  169675. if( rc==SQLITE_OK ){
  169676. /* Calculate the IDF (Inverse Document Frequency) for phrase i.
  169677. ** This is done using the standard BM25 formula as found on wikipedia:
  169678. **
  169679. ** IDF = log( (N - nHit + 0.5) / (nHit + 0.5) )
  169680. **
  169681. ** where "N" is the total number of documents in the set and nHit
  169682. ** is the number that contain at least one instance of the phrase
  169683. ** under consideration.
  169684. **
  169685. ** The problem with this is that if (N < 2*nHit), the IDF is
  169686. ** negative. Which is undesirable. So the mimimum allowable IDF is
  169687. ** (1e-6) - roughly the same as a term that appears in just over
  169688. ** half of set of 5,000,000 documents. */
  169689. double idf = log( (nRow - nHit + 0.5) / (nHit + 0.5) );
  169690. if( idf<=0.0 ) idf = 1e-6;
  169691. p->aIDF[i] = idf;
  169692. }
  169693. }
  169694. if( rc!=SQLITE_OK ){
  169695. sqlite3_free(p);
  169696. }else{
  169697. rc = pApi->xSetAuxdata(pFts, p, sqlite3_free);
  169698. }
  169699. if( rc!=SQLITE_OK ) p = 0;
  169700. }
  169701. *ppData = p;
  169702. return rc;
  169703. }
  169704. /*
  169705. ** Implementation of bm25() function.
  169706. */
  169707. static void fts5Bm25Function(
  169708. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  169709. Fts5Context *pFts, /* First arg to pass to pApi functions */
  169710. sqlite3_context *pCtx, /* Context for returning result/error */
  169711. int nVal, /* Number of values in apVal[] array */
  169712. sqlite3_value **apVal /* Array of trailing arguments */
  169713. ){
  169714. const double k1 = 1.2; /* Constant "k1" from BM25 formula */
  169715. const double b = 0.75; /* Constant "b" from BM25 formula */
  169716. int rc = SQLITE_OK; /* Error code */
  169717. double score = 0.0; /* SQL function return value */
  169718. Fts5Bm25Data *pData; /* Values allocated/calculated once only */
  169719. int i; /* Iterator variable */
  169720. int nInst = 0; /* Value returned by xInstCount() */
  169721. double D = 0.0; /* Total number of tokens in row */
  169722. double *aFreq = 0; /* Array of phrase freq. for current row */
  169723. /* Calculate the phrase frequency (symbol "f(qi,D)" in the documentation)
  169724. ** for each phrase in the query for the current row. */
  169725. rc = fts5Bm25GetData(pApi, pFts, &pData);
  169726. if( rc==SQLITE_OK ){
  169727. aFreq = pData->aFreq;
  169728. memset(aFreq, 0, sizeof(double) * pData->nPhrase);
  169729. rc = pApi->xInstCount(pFts, &nInst);
  169730. }
  169731. for(i=0; rc==SQLITE_OK && i<nInst; i++){
  169732. int ip; int ic; int io;
  169733. rc = pApi->xInst(pFts, i, &ip, &ic, &io);
  169734. if( rc==SQLITE_OK ){
  169735. double w = (nVal > ic) ? sqlite3_value_double(apVal[ic]) : 1.0;
  169736. aFreq[ip] += w;
  169737. }
  169738. }
  169739. /* Figure out the total size of the current row in tokens. */
  169740. if( rc==SQLITE_OK ){
  169741. int nTok;
  169742. rc = pApi->xColumnSize(pFts, -1, &nTok);
  169743. D = (double)nTok;
  169744. }
  169745. /* Determine the BM25 score for the current row. */
  169746. for(i=0; rc==SQLITE_OK && i<pData->nPhrase; i++){
  169747. score += pData->aIDF[i] * (
  169748. ( aFreq[i] * (k1 + 1.0) ) /
  169749. ( aFreq[i] + k1 * (1 - b + b * D / pData->avgdl) )
  169750. );
  169751. }
  169752. /* If no error has occurred, return the calculated score. Otherwise,
  169753. ** throw an SQL exception. */
  169754. if( rc==SQLITE_OK ){
  169755. sqlite3_result_double(pCtx, -1.0 * score);
  169756. }else{
  169757. sqlite3_result_error_code(pCtx, rc);
  169758. }
  169759. }
  169760. static int sqlite3Fts5AuxInit(fts5_api *pApi){
  169761. struct Builtin {
  169762. const char *zFunc; /* Function name (nul-terminated) */
  169763. void *pUserData; /* User-data pointer */
  169764. fts5_extension_function xFunc;/* Callback function */
  169765. void (*xDestroy)(void*); /* Destructor function */
  169766. } aBuiltin [] = {
  169767. { "snippet", 0, fts5SnippetFunction, 0 },
  169768. { "highlight", 0, fts5HighlightFunction, 0 },
  169769. { "bm25", 0, fts5Bm25Function, 0 },
  169770. };
  169771. int rc = SQLITE_OK; /* Return code */
  169772. int i; /* To iterate through builtin functions */
  169773. for(i=0; rc==SQLITE_OK && i<ArraySize(aBuiltin); i++){
  169774. rc = pApi->xCreateFunction(pApi,
  169775. aBuiltin[i].zFunc,
  169776. aBuiltin[i].pUserData,
  169777. aBuiltin[i].xFunc,
  169778. aBuiltin[i].xDestroy
  169779. );
  169780. }
  169781. return rc;
  169782. }
  169783. /*
  169784. ** 2014 May 31
  169785. **
  169786. ** The author disclaims copyright to this source code. In place of
  169787. ** a legal notice, here is a blessing:
  169788. **
  169789. ** May you do good and not evil.
  169790. ** May you find forgiveness for yourself and forgive others.
  169791. ** May you share freely, never taking more than you give.
  169792. **
  169793. ******************************************************************************
  169794. */
  169795. /* #include "fts5Int.h" */
  169796. static int sqlite3Fts5BufferSize(int *pRc, Fts5Buffer *pBuf, u32 nByte){
  169797. if( (u32)pBuf->nSpace<nByte ){
  169798. u32 nNew = pBuf->nSpace ? pBuf->nSpace : 64;
  169799. u8 *pNew;
  169800. while( nNew<nByte ){
  169801. nNew = nNew * 2;
  169802. }
  169803. pNew = sqlite3_realloc(pBuf->p, nNew);
  169804. if( pNew==0 ){
  169805. *pRc = SQLITE_NOMEM;
  169806. return 1;
  169807. }else{
  169808. pBuf->nSpace = nNew;
  169809. pBuf->p = pNew;
  169810. }
  169811. }
  169812. return 0;
  169813. }
  169814. /*
  169815. ** Encode value iVal as an SQLite varint and append it to the buffer object
  169816. ** pBuf. If an OOM error occurs, set the error code in p.
  169817. */
  169818. static void sqlite3Fts5BufferAppendVarint(int *pRc, Fts5Buffer *pBuf, i64 iVal){
  169819. if( fts5BufferGrow(pRc, pBuf, 9) ) return;
  169820. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iVal);
  169821. }
  169822. static void sqlite3Fts5Put32(u8 *aBuf, int iVal){
  169823. aBuf[0] = (iVal>>24) & 0x00FF;
  169824. aBuf[1] = (iVal>>16) & 0x00FF;
  169825. aBuf[2] = (iVal>> 8) & 0x00FF;
  169826. aBuf[3] = (iVal>> 0) & 0x00FF;
  169827. }
  169828. static int sqlite3Fts5Get32(const u8 *aBuf){
  169829. return (aBuf[0] << 24) + (aBuf[1] << 16) + (aBuf[2] << 8) + aBuf[3];
  169830. }
  169831. /*
  169832. ** Append buffer nData/pData to buffer pBuf. If an OOM error occurs, set
  169833. ** the error code in p. If an error has already occurred when this function
  169834. ** is called, it is a no-op.
  169835. */
  169836. static void sqlite3Fts5BufferAppendBlob(
  169837. int *pRc,
  169838. Fts5Buffer *pBuf,
  169839. u32 nData,
  169840. const u8 *pData
  169841. ){
  169842. assert_nc( *pRc || nData>=0 );
  169843. if( fts5BufferGrow(pRc, pBuf, nData) ) return;
  169844. memcpy(&pBuf->p[pBuf->n], pData, nData);
  169845. pBuf->n += nData;
  169846. }
  169847. /*
  169848. ** Append the nul-terminated string zStr to the buffer pBuf. This function
  169849. ** ensures that the byte following the buffer data is set to 0x00, even
  169850. ** though this byte is not included in the pBuf->n count.
  169851. */
  169852. static void sqlite3Fts5BufferAppendString(
  169853. int *pRc,
  169854. Fts5Buffer *pBuf,
  169855. const char *zStr
  169856. ){
  169857. int nStr = (int)strlen(zStr);
  169858. sqlite3Fts5BufferAppendBlob(pRc, pBuf, nStr+1, (const u8*)zStr);
  169859. pBuf->n--;
  169860. }
  169861. /*
  169862. ** Argument zFmt is a printf() style format string. This function performs
  169863. ** the printf() style processing, then appends the results to buffer pBuf.
  169864. **
  169865. ** Like sqlite3Fts5BufferAppendString(), this function ensures that the byte
  169866. ** following the buffer data is set to 0x00, even though this byte is not
  169867. ** included in the pBuf->n count.
  169868. */
  169869. static void sqlite3Fts5BufferAppendPrintf(
  169870. int *pRc,
  169871. Fts5Buffer *pBuf,
  169872. char *zFmt, ...
  169873. ){
  169874. if( *pRc==SQLITE_OK ){
  169875. char *zTmp;
  169876. va_list ap;
  169877. va_start(ap, zFmt);
  169878. zTmp = sqlite3_vmprintf(zFmt, ap);
  169879. va_end(ap);
  169880. if( zTmp==0 ){
  169881. *pRc = SQLITE_NOMEM;
  169882. }else{
  169883. sqlite3Fts5BufferAppendString(pRc, pBuf, zTmp);
  169884. sqlite3_free(zTmp);
  169885. }
  169886. }
  169887. }
  169888. static char *sqlite3Fts5Mprintf(int *pRc, const char *zFmt, ...){
  169889. char *zRet = 0;
  169890. if( *pRc==SQLITE_OK ){
  169891. va_list ap;
  169892. va_start(ap, zFmt);
  169893. zRet = sqlite3_vmprintf(zFmt, ap);
  169894. va_end(ap);
  169895. if( zRet==0 ){
  169896. *pRc = SQLITE_NOMEM;
  169897. }
  169898. }
  169899. return zRet;
  169900. }
  169901. /*
  169902. ** Free any buffer allocated by pBuf. Zero the structure before returning.
  169903. */
  169904. static void sqlite3Fts5BufferFree(Fts5Buffer *pBuf){
  169905. sqlite3_free(pBuf->p);
  169906. memset(pBuf, 0, sizeof(Fts5Buffer));
  169907. }
  169908. /*
  169909. ** Zero the contents of the buffer object. But do not free the associated
  169910. ** memory allocation.
  169911. */
  169912. static void sqlite3Fts5BufferZero(Fts5Buffer *pBuf){
  169913. pBuf->n = 0;
  169914. }
  169915. /*
  169916. ** Set the buffer to contain nData/pData. If an OOM error occurs, leave an
  169917. ** the error code in p. If an error has already occurred when this function
  169918. ** is called, it is a no-op.
  169919. */
  169920. static void sqlite3Fts5BufferSet(
  169921. int *pRc,
  169922. Fts5Buffer *pBuf,
  169923. int nData,
  169924. const u8 *pData
  169925. ){
  169926. pBuf->n = 0;
  169927. sqlite3Fts5BufferAppendBlob(pRc, pBuf, nData, pData);
  169928. }
  169929. static int sqlite3Fts5PoslistNext64(
  169930. const u8 *a, int n, /* Buffer containing poslist */
  169931. int *pi, /* IN/OUT: Offset within a[] */
  169932. i64 *piOff /* IN/OUT: Current offset */
  169933. ){
  169934. int i = *pi;
  169935. if( i>=n ){
  169936. /* EOF */
  169937. *piOff = -1;
  169938. return 1;
  169939. }else{
  169940. i64 iOff = *piOff;
  169941. int iVal;
  169942. fts5FastGetVarint32(a, i, iVal);
  169943. if( iVal==1 ){
  169944. fts5FastGetVarint32(a, i, iVal);
  169945. iOff = ((i64)iVal) << 32;
  169946. fts5FastGetVarint32(a, i, iVal);
  169947. }
  169948. *piOff = iOff + (iVal-2);
  169949. *pi = i;
  169950. return 0;
  169951. }
  169952. }
  169953. /*
  169954. ** Advance the iterator object passed as the only argument. Return true
  169955. ** if the iterator reaches EOF, or false otherwise.
  169956. */
  169957. static int sqlite3Fts5PoslistReaderNext(Fts5PoslistReader *pIter){
  169958. if( sqlite3Fts5PoslistNext64(pIter->a, pIter->n, &pIter->i, &pIter->iPos) ){
  169959. pIter->bEof = 1;
  169960. }
  169961. return pIter->bEof;
  169962. }
  169963. static int sqlite3Fts5PoslistReaderInit(
  169964. const u8 *a, int n, /* Poslist buffer to iterate through */
  169965. Fts5PoslistReader *pIter /* Iterator object to initialize */
  169966. ){
  169967. memset(pIter, 0, sizeof(*pIter));
  169968. pIter->a = a;
  169969. pIter->n = n;
  169970. sqlite3Fts5PoslistReaderNext(pIter);
  169971. return pIter->bEof;
  169972. }
  169973. /*
  169974. ** Append position iPos to the position list being accumulated in buffer
  169975. ** pBuf, which must be already be large enough to hold the new data.
  169976. ** The previous position written to this list is *piPrev. *piPrev is set
  169977. ** to iPos before returning.
  169978. */
  169979. static void sqlite3Fts5PoslistSafeAppend(
  169980. Fts5Buffer *pBuf,
  169981. i64 *piPrev,
  169982. i64 iPos
  169983. ){
  169984. static const i64 colmask = ((i64)(0x7FFFFFFF)) << 32;
  169985. if( (iPos & colmask) != (*piPrev & colmask) ){
  169986. pBuf->p[pBuf->n++] = 1;
  169987. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], (iPos>>32));
  169988. *piPrev = (iPos & colmask);
  169989. }
  169990. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], (iPos-*piPrev)+2);
  169991. *piPrev = iPos;
  169992. }
  169993. static int sqlite3Fts5PoslistWriterAppend(
  169994. Fts5Buffer *pBuf,
  169995. Fts5PoslistWriter *pWriter,
  169996. i64 iPos
  169997. ){
  169998. int rc = 0; /* Initialized only to suppress erroneous warning from Clang */
  169999. if( fts5BufferGrow(&rc, pBuf, 5+5+5) ) return rc;
  170000. sqlite3Fts5PoslistSafeAppend(pBuf, &pWriter->iPrev, iPos);
  170001. return SQLITE_OK;
  170002. }
  170003. static void *sqlite3Fts5MallocZero(int *pRc, int nByte){
  170004. void *pRet = 0;
  170005. if( *pRc==SQLITE_OK ){
  170006. pRet = sqlite3_malloc(nByte);
  170007. if( pRet==0 && nByte>0 ){
  170008. *pRc = SQLITE_NOMEM;
  170009. }else{
  170010. memset(pRet, 0, nByte);
  170011. }
  170012. }
  170013. return pRet;
  170014. }
  170015. /*
  170016. ** Return a nul-terminated copy of the string indicated by pIn. If nIn
  170017. ** is non-negative, then it is the length of the string in bytes. Otherwise,
  170018. ** the length of the string is determined using strlen().
  170019. **
  170020. ** It is the responsibility of the caller to eventually free the returned
  170021. ** buffer using sqlite3_free(). If an OOM error occurs, NULL is returned.
  170022. */
  170023. static char *sqlite3Fts5Strndup(int *pRc, const char *pIn, int nIn){
  170024. char *zRet = 0;
  170025. if( *pRc==SQLITE_OK ){
  170026. if( nIn<0 ){
  170027. nIn = (int)strlen(pIn);
  170028. }
  170029. zRet = (char*)sqlite3_malloc(nIn+1);
  170030. if( zRet ){
  170031. memcpy(zRet, pIn, nIn);
  170032. zRet[nIn] = '\0';
  170033. }else{
  170034. *pRc = SQLITE_NOMEM;
  170035. }
  170036. }
  170037. return zRet;
  170038. }
  170039. /*
  170040. ** Return true if character 't' may be part of an FTS5 bareword, or false
  170041. ** otherwise. Characters that may be part of barewords:
  170042. **
  170043. ** * All non-ASCII characters,
  170044. ** * The 52 upper and lower case ASCII characters, and
  170045. ** * The 10 integer ASCII characters.
  170046. ** * The underscore character "_" (0x5F).
  170047. ** * The unicode "subsitute" character (0x1A).
  170048. */
  170049. static int sqlite3Fts5IsBareword(char t){
  170050. u8 aBareword[128] = {
  170051. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00 .. 0x0F */
  170052. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, /* 0x10 .. 0x1F */
  170053. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20 .. 0x2F */
  170054. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 0x30 .. 0x3F */
  170055. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x40 .. 0x4F */
  170056. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 0x50 .. 0x5F */
  170057. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x60 .. 0x6F */
  170058. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 /* 0x70 .. 0x7F */
  170059. };
  170060. return (t & 0x80) || aBareword[(int)t];
  170061. }
  170062. /*************************************************************************
  170063. */
  170064. typedef struct Fts5TermsetEntry Fts5TermsetEntry;
  170065. struct Fts5TermsetEntry {
  170066. char *pTerm;
  170067. int nTerm;
  170068. int iIdx; /* Index (main or aPrefix[] entry) */
  170069. Fts5TermsetEntry *pNext;
  170070. };
  170071. struct Fts5Termset {
  170072. Fts5TermsetEntry *apHash[512];
  170073. };
  170074. static int sqlite3Fts5TermsetNew(Fts5Termset **pp){
  170075. int rc = SQLITE_OK;
  170076. *pp = sqlite3Fts5MallocZero(&rc, sizeof(Fts5Termset));
  170077. return rc;
  170078. }
  170079. static int sqlite3Fts5TermsetAdd(
  170080. Fts5Termset *p,
  170081. int iIdx,
  170082. const char *pTerm, int nTerm,
  170083. int *pbPresent
  170084. ){
  170085. int rc = SQLITE_OK;
  170086. *pbPresent = 0;
  170087. if( p ){
  170088. int i;
  170089. u32 hash = 13;
  170090. Fts5TermsetEntry *pEntry;
  170091. /* Calculate a hash value for this term. This is the same hash checksum
  170092. ** used by the fts5_hash.c module. This is not important for correct
  170093. ** operation of the module, but is necessary to ensure that some tests
  170094. ** designed to produce hash table collisions really do work. */
  170095. for(i=nTerm-1; i>=0; i--){
  170096. hash = (hash << 3) ^ hash ^ pTerm[i];
  170097. }
  170098. hash = (hash << 3) ^ hash ^ iIdx;
  170099. hash = hash % ArraySize(p->apHash);
  170100. for(pEntry=p->apHash[hash]; pEntry; pEntry=pEntry->pNext){
  170101. if( pEntry->iIdx==iIdx
  170102. && pEntry->nTerm==nTerm
  170103. && memcmp(pEntry->pTerm, pTerm, nTerm)==0
  170104. ){
  170105. *pbPresent = 1;
  170106. break;
  170107. }
  170108. }
  170109. if( pEntry==0 ){
  170110. pEntry = sqlite3Fts5MallocZero(&rc, sizeof(Fts5TermsetEntry) + nTerm);
  170111. if( pEntry ){
  170112. pEntry->pTerm = (char*)&pEntry[1];
  170113. pEntry->nTerm = nTerm;
  170114. pEntry->iIdx = iIdx;
  170115. memcpy(pEntry->pTerm, pTerm, nTerm);
  170116. pEntry->pNext = p->apHash[hash];
  170117. p->apHash[hash] = pEntry;
  170118. }
  170119. }
  170120. }
  170121. return rc;
  170122. }
  170123. static void sqlite3Fts5TermsetFree(Fts5Termset *p){
  170124. if( p ){
  170125. u32 i;
  170126. for(i=0; i<ArraySize(p->apHash); i++){
  170127. Fts5TermsetEntry *pEntry = p->apHash[i];
  170128. while( pEntry ){
  170129. Fts5TermsetEntry *pDel = pEntry;
  170130. pEntry = pEntry->pNext;
  170131. sqlite3_free(pDel);
  170132. }
  170133. }
  170134. sqlite3_free(p);
  170135. }
  170136. }
  170137. /*
  170138. ** 2014 Jun 09
  170139. **
  170140. ** The author disclaims copyright to this source code. In place of
  170141. ** a legal notice, here is a blessing:
  170142. **
  170143. ** May you do good and not evil.
  170144. ** May you find forgiveness for yourself and forgive others.
  170145. ** May you share freely, never taking more than you give.
  170146. **
  170147. ******************************************************************************
  170148. **
  170149. ** This is an SQLite module implementing full-text search.
  170150. */
  170151. /* #include "fts5Int.h" */
  170152. #define FTS5_DEFAULT_PAGE_SIZE 4050
  170153. #define FTS5_DEFAULT_AUTOMERGE 4
  170154. #define FTS5_DEFAULT_USERMERGE 4
  170155. #define FTS5_DEFAULT_CRISISMERGE 16
  170156. #define FTS5_DEFAULT_HASHSIZE (1024*1024)
  170157. /* Maximum allowed page size */
  170158. #define FTS5_MAX_PAGE_SIZE (128*1024)
  170159. static int fts5_iswhitespace(char x){
  170160. return (x==' ');
  170161. }
  170162. static int fts5_isopenquote(char x){
  170163. return (x=='"' || x=='\'' || x=='[' || x=='`');
  170164. }
  170165. /*
  170166. ** Argument pIn points to a character that is part of a nul-terminated
  170167. ** string. Return a pointer to the first character following *pIn in
  170168. ** the string that is not a white-space character.
  170169. */
  170170. static const char *fts5ConfigSkipWhitespace(const char *pIn){
  170171. const char *p = pIn;
  170172. if( p ){
  170173. while( fts5_iswhitespace(*p) ){ p++; }
  170174. }
  170175. return p;
  170176. }
  170177. /*
  170178. ** Argument pIn points to a character that is part of a nul-terminated
  170179. ** string. Return a pointer to the first character following *pIn in
  170180. ** the string that is not a "bareword" character.
  170181. */
  170182. static const char *fts5ConfigSkipBareword(const char *pIn){
  170183. const char *p = pIn;
  170184. while ( sqlite3Fts5IsBareword(*p) ) p++;
  170185. if( p==pIn ) p = 0;
  170186. return p;
  170187. }
  170188. static int fts5_isdigit(char a){
  170189. return (a>='0' && a<='9');
  170190. }
  170191. static const char *fts5ConfigSkipLiteral(const char *pIn){
  170192. const char *p = pIn;
  170193. switch( *p ){
  170194. case 'n': case 'N':
  170195. if( sqlite3_strnicmp("null", p, 4)==0 ){
  170196. p = &p[4];
  170197. }else{
  170198. p = 0;
  170199. }
  170200. break;
  170201. case 'x': case 'X':
  170202. p++;
  170203. if( *p=='\'' ){
  170204. p++;
  170205. while( (*p>='a' && *p<='f')
  170206. || (*p>='A' && *p<='F')
  170207. || (*p>='0' && *p<='9')
  170208. ){
  170209. p++;
  170210. }
  170211. if( *p=='\'' && 0==((p-pIn)%2) ){
  170212. p++;
  170213. }else{
  170214. p = 0;
  170215. }
  170216. }else{
  170217. p = 0;
  170218. }
  170219. break;
  170220. case '\'':
  170221. p++;
  170222. while( p ){
  170223. if( *p=='\'' ){
  170224. p++;
  170225. if( *p!='\'' ) break;
  170226. }
  170227. p++;
  170228. if( *p==0 ) p = 0;
  170229. }
  170230. break;
  170231. default:
  170232. /* maybe a number */
  170233. if( *p=='+' || *p=='-' ) p++;
  170234. while( fts5_isdigit(*p) ) p++;
  170235. /* At this point, if the literal was an integer, the parse is
  170236. ** finished. Or, if it is a floating point value, it may continue
  170237. ** with either a decimal point or an 'E' character. */
  170238. if( *p=='.' && fts5_isdigit(p[1]) ){
  170239. p += 2;
  170240. while( fts5_isdigit(*p) ) p++;
  170241. }
  170242. if( p==pIn ) p = 0;
  170243. break;
  170244. }
  170245. return p;
  170246. }
  170247. /*
  170248. ** The first character of the string pointed to by argument z is guaranteed
  170249. ** to be an open-quote character (see function fts5_isopenquote()).
  170250. **
  170251. ** This function searches for the corresponding close-quote character within
  170252. ** the string and, if found, dequotes the string in place and adds a new
  170253. ** nul-terminator byte.
  170254. **
  170255. ** If the close-quote is found, the value returned is the byte offset of
  170256. ** the character immediately following it. Or, if the close-quote is not
  170257. ** found, -1 is returned. If -1 is returned, the buffer is left in an
  170258. ** undefined state.
  170259. */
  170260. static int fts5Dequote(char *z){
  170261. char q;
  170262. int iIn = 1;
  170263. int iOut = 0;
  170264. q = z[0];
  170265. /* Set stack variable q to the close-quote character */
  170266. assert( q=='[' || q=='\'' || q=='"' || q=='`' );
  170267. if( q=='[' ) q = ']';
  170268. while( ALWAYS(z[iIn]) ){
  170269. if( z[iIn]==q ){
  170270. if( z[iIn+1]!=q ){
  170271. /* Character iIn was the close quote. */
  170272. iIn++;
  170273. break;
  170274. }else{
  170275. /* Character iIn and iIn+1 form an escaped quote character. Skip
  170276. ** the input cursor past both and copy a single quote character
  170277. ** to the output buffer. */
  170278. iIn += 2;
  170279. z[iOut++] = q;
  170280. }
  170281. }else{
  170282. z[iOut++] = z[iIn++];
  170283. }
  170284. }
  170285. z[iOut] = '\0';
  170286. return iIn;
  170287. }
  170288. /*
  170289. ** Convert an SQL-style quoted string into a normal string by removing
  170290. ** the quote characters. The conversion is done in-place. If the
  170291. ** input does not begin with a quote character, then this routine
  170292. ** is a no-op.
  170293. **
  170294. ** Examples:
  170295. **
  170296. ** "abc" becomes abc
  170297. ** 'xyz' becomes xyz
  170298. ** [pqr] becomes pqr
  170299. ** `mno` becomes mno
  170300. */
  170301. static void sqlite3Fts5Dequote(char *z){
  170302. char quote; /* Quote character (if any ) */
  170303. assert( 0==fts5_iswhitespace(z[0]) );
  170304. quote = z[0];
  170305. if( quote=='[' || quote=='\'' || quote=='"' || quote=='`' ){
  170306. fts5Dequote(z);
  170307. }
  170308. }
  170309. struct Fts5Enum {
  170310. const char *zName;
  170311. int eVal;
  170312. };
  170313. typedef struct Fts5Enum Fts5Enum;
  170314. static int fts5ConfigSetEnum(
  170315. const Fts5Enum *aEnum,
  170316. const char *zEnum,
  170317. int *peVal
  170318. ){
  170319. int nEnum = (int)strlen(zEnum);
  170320. int i;
  170321. int iVal = -1;
  170322. for(i=0; aEnum[i].zName; i++){
  170323. if( sqlite3_strnicmp(aEnum[i].zName, zEnum, nEnum)==0 ){
  170324. if( iVal>=0 ) return SQLITE_ERROR;
  170325. iVal = aEnum[i].eVal;
  170326. }
  170327. }
  170328. *peVal = iVal;
  170329. return iVal<0 ? SQLITE_ERROR : SQLITE_OK;
  170330. }
  170331. /*
  170332. ** Parse a "special" CREATE VIRTUAL TABLE directive and update
  170333. ** configuration object pConfig as appropriate.
  170334. **
  170335. ** If successful, object pConfig is updated and SQLITE_OK returned. If
  170336. ** an error occurs, an SQLite error code is returned and an error message
  170337. ** may be left in *pzErr. It is the responsibility of the caller to
  170338. ** eventually free any such error message using sqlite3_free().
  170339. */
  170340. static int fts5ConfigParseSpecial(
  170341. Fts5Global *pGlobal,
  170342. Fts5Config *pConfig, /* Configuration object to update */
  170343. const char *zCmd, /* Special command to parse */
  170344. const char *zArg, /* Argument to parse */
  170345. char **pzErr /* OUT: Error message */
  170346. ){
  170347. int rc = SQLITE_OK;
  170348. int nCmd = (int)strlen(zCmd);
  170349. if( sqlite3_strnicmp("prefix", zCmd, nCmd)==0 ){
  170350. const int nByte = sizeof(int) * FTS5_MAX_PREFIX_INDEXES;
  170351. const char *p;
  170352. int bFirst = 1;
  170353. if( pConfig->aPrefix==0 ){
  170354. pConfig->aPrefix = sqlite3Fts5MallocZero(&rc, nByte);
  170355. if( rc ) return rc;
  170356. }
  170357. p = zArg;
  170358. while( 1 ){
  170359. int nPre = 0;
  170360. while( p[0]==' ' ) p++;
  170361. if( bFirst==0 && p[0]==',' ){
  170362. p++;
  170363. while( p[0]==' ' ) p++;
  170364. }else if( p[0]=='\0' ){
  170365. break;
  170366. }
  170367. if( p[0]<'0' || p[0]>'9' ){
  170368. *pzErr = sqlite3_mprintf("malformed prefix=... directive");
  170369. rc = SQLITE_ERROR;
  170370. break;
  170371. }
  170372. if( pConfig->nPrefix==FTS5_MAX_PREFIX_INDEXES ){
  170373. *pzErr = sqlite3_mprintf(
  170374. "too many prefix indexes (max %d)", FTS5_MAX_PREFIX_INDEXES
  170375. );
  170376. rc = SQLITE_ERROR;
  170377. break;
  170378. }
  170379. while( p[0]>='0' && p[0]<='9' && nPre<1000 ){
  170380. nPre = nPre*10 + (p[0] - '0');
  170381. p++;
  170382. }
  170383. if( nPre<=0 || nPre>=1000 ){
  170384. *pzErr = sqlite3_mprintf("prefix length out of range (max 999)");
  170385. rc = SQLITE_ERROR;
  170386. break;
  170387. }
  170388. pConfig->aPrefix[pConfig->nPrefix] = nPre;
  170389. pConfig->nPrefix++;
  170390. bFirst = 0;
  170391. }
  170392. assert( pConfig->nPrefix<=FTS5_MAX_PREFIX_INDEXES );
  170393. return rc;
  170394. }
  170395. if( sqlite3_strnicmp("tokenize", zCmd, nCmd)==0 ){
  170396. const char *p = (const char*)zArg;
  170397. int nArg = (int)strlen(zArg) + 1;
  170398. char **azArg = sqlite3Fts5MallocZero(&rc, sizeof(char*) * nArg);
  170399. char *pDel = sqlite3Fts5MallocZero(&rc, nArg * 2);
  170400. char *pSpace = pDel;
  170401. if( azArg && pSpace ){
  170402. if( pConfig->pTok ){
  170403. *pzErr = sqlite3_mprintf("multiple tokenize=... directives");
  170404. rc = SQLITE_ERROR;
  170405. }else{
  170406. for(nArg=0; p && *p; nArg++){
  170407. const char *p2 = fts5ConfigSkipWhitespace(p);
  170408. if( *p2=='\'' ){
  170409. p = fts5ConfigSkipLiteral(p2);
  170410. }else{
  170411. p = fts5ConfigSkipBareword(p2);
  170412. }
  170413. if( p ){
  170414. memcpy(pSpace, p2, p-p2);
  170415. azArg[nArg] = pSpace;
  170416. sqlite3Fts5Dequote(pSpace);
  170417. pSpace += (p - p2) + 1;
  170418. p = fts5ConfigSkipWhitespace(p);
  170419. }
  170420. }
  170421. if( p==0 ){
  170422. *pzErr = sqlite3_mprintf("parse error in tokenize directive");
  170423. rc = SQLITE_ERROR;
  170424. }else{
  170425. rc = sqlite3Fts5GetTokenizer(pGlobal,
  170426. (const char**)azArg, nArg, &pConfig->pTok, &pConfig->pTokApi,
  170427. pzErr
  170428. );
  170429. }
  170430. }
  170431. }
  170432. sqlite3_free(azArg);
  170433. sqlite3_free(pDel);
  170434. return rc;
  170435. }
  170436. if( sqlite3_strnicmp("content", zCmd, nCmd)==0 ){
  170437. if( pConfig->eContent!=FTS5_CONTENT_NORMAL ){
  170438. *pzErr = sqlite3_mprintf("multiple content=... directives");
  170439. rc = SQLITE_ERROR;
  170440. }else{
  170441. if( zArg[0] ){
  170442. pConfig->eContent = FTS5_CONTENT_EXTERNAL;
  170443. pConfig->zContent = sqlite3Fts5Mprintf(&rc, "%Q.%Q", pConfig->zDb,zArg);
  170444. }else{
  170445. pConfig->eContent = FTS5_CONTENT_NONE;
  170446. }
  170447. }
  170448. return rc;
  170449. }
  170450. if( sqlite3_strnicmp("content_rowid", zCmd, nCmd)==0 ){
  170451. if( pConfig->zContentRowid ){
  170452. *pzErr = sqlite3_mprintf("multiple content_rowid=... directives");
  170453. rc = SQLITE_ERROR;
  170454. }else{
  170455. pConfig->zContentRowid = sqlite3Fts5Strndup(&rc, zArg, -1);
  170456. }
  170457. return rc;
  170458. }
  170459. if( sqlite3_strnicmp("columnsize", zCmd, nCmd)==0 ){
  170460. if( (zArg[0]!='0' && zArg[0]!='1') || zArg[1]!='\0' ){
  170461. *pzErr = sqlite3_mprintf("malformed columnsize=... directive");
  170462. rc = SQLITE_ERROR;
  170463. }else{
  170464. pConfig->bColumnsize = (zArg[0]=='1');
  170465. }
  170466. return rc;
  170467. }
  170468. if( sqlite3_strnicmp("detail", zCmd, nCmd)==0 ){
  170469. const Fts5Enum aDetail[] = {
  170470. { "none", FTS5_DETAIL_NONE },
  170471. { "full", FTS5_DETAIL_FULL },
  170472. { "columns", FTS5_DETAIL_COLUMNS },
  170473. { 0, 0 }
  170474. };
  170475. if( (rc = fts5ConfigSetEnum(aDetail, zArg, &pConfig->eDetail)) ){
  170476. *pzErr = sqlite3_mprintf("malformed detail=... directive");
  170477. }
  170478. return rc;
  170479. }
  170480. *pzErr = sqlite3_mprintf("unrecognized option: \"%.*s\"", nCmd, zCmd);
  170481. return SQLITE_ERROR;
  170482. }
  170483. /*
  170484. ** Allocate an instance of the default tokenizer ("simple") at
  170485. ** Fts5Config.pTokenizer. Return SQLITE_OK if successful, or an SQLite error
  170486. ** code if an error occurs.
  170487. */
  170488. static int fts5ConfigDefaultTokenizer(Fts5Global *pGlobal, Fts5Config *pConfig){
  170489. assert( pConfig->pTok==0 && pConfig->pTokApi==0 );
  170490. return sqlite3Fts5GetTokenizer(
  170491. pGlobal, 0, 0, &pConfig->pTok, &pConfig->pTokApi, 0
  170492. );
  170493. }
  170494. /*
  170495. ** Gobble up the first bareword or quoted word from the input buffer zIn.
  170496. ** Return a pointer to the character immediately following the last in
  170497. ** the gobbled word if successful, or a NULL pointer otherwise (failed
  170498. ** to find close-quote character).
  170499. **
  170500. ** Before returning, set pzOut to point to a new buffer containing a
  170501. ** nul-terminated, dequoted copy of the gobbled word. If the word was
  170502. ** quoted, *pbQuoted is also set to 1 before returning.
  170503. **
  170504. ** If *pRc is other than SQLITE_OK when this function is called, it is
  170505. ** a no-op (NULL is returned). Otherwise, if an OOM occurs within this
  170506. ** function, *pRc is set to SQLITE_NOMEM before returning. *pRc is *not*
  170507. ** set if a parse error (failed to find close quote) occurs.
  170508. */
  170509. static const char *fts5ConfigGobbleWord(
  170510. int *pRc, /* IN/OUT: Error code */
  170511. const char *zIn, /* Buffer to gobble string/bareword from */
  170512. char **pzOut, /* OUT: malloc'd buffer containing str/bw */
  170513. int *pbQuoted /* OUT: Set to true if dequoting required */
  170514. ){
  170515. const char *zRet = 0;
  170516. int nIn = (int)strlen(zIn);
  170517. char *zOut = sqlite3_malloc(nIn+1);
  170518. assert( *pRc==SQLITE_OK );
  170519. *pbQuoted = 0;
  170520. *pzOut = 0;
  170521. if( zOut==0 ){
  170522. *pRc = SQLITE_NOMEM;
  170523. }else{
  170524. memcpy(zOut, zIn, nIn+1);
  170525. if( fts5_isopenquote(zOut[0]) ){
  170526. int ii = fts5Dequote(zOut);
  170527. zRet = &zIn[ii];
  170528. *pbQuoted = 1;
  170529. }else{
  170530. zRet = fts5ConfigSkipBareword(zIn);
  170531. if( zRet ){
  170532. zOut[zRet-zIn] = '\0';
  170533. }
  170534. }
  170535. }
  170536. if( zRet==0 ){
  170537. sqlite3_free(zOut);
  170538. }else{
  170539. *pzOut = zOut;
  170540. }
  170541. return zRet;
  170542. }
  170543. static int fts5ConfigParseColumn(
  170544. Fts5Config *p,
  170545. char *zCol,
  170546. char *zArg,
  170547. char **pzErr
  170548. ){
  170549. int rc = SQLITE_OK;
  170550. if( 0==sqlite3_stricmp(zCol, FTS5_RANK_NAME)
  170551. || 0==sqlite3_stricmp(zCol, FTS5_ROWID_NAME)
  170552. ){
  170553. *pzErr = sqlite3_mprintf("reserved fts5 column name: %s", zCol);
  170554. rc = SQLITE_ERROR;
  170555. }else if( zArg ){
  170556. if( 0==sqlite3_stricmp(zArg, "unindexed") ){
  170557. p->abUnindexed[p->nCol] = 1;
  170558. }else{
  170559. *pzErr = sqlite3_mprintf("unrecognized column option: %s", zArg);
  170560. rc = SQLITE_ERROR;
  170561. }
  170562. }
  170563. p->azCol[p->nCol++] = zCol;
  170564. return rc;
  170565. }
  170566. /*
  170567. ** Populate the Fts5Config.zContentExprlist string.
  170568. */
  170569. static int fts5ConfigMakeExprlist(Fts5Config *p){
  170570. int i;
  170571. int rc = SQLITE_OK;
  170572. Fts5Buffer buf = {0, 0, 0};
  170573. sqlite3Fts5BufferAppendPrintf(&rc, &buf, "T.%Q", p->zContentRowid);
  170574. if( p->eContent!=FTS5_CONTENT_NONE ){
  170575. for(i=0; i<p->nCol; i++){
  170576. if( p->eContent==FTS5_CONTENT_EXTERNAL ){
  170577. sqlite3Fts5BufferAppendPrintf(&rc, &buf, ", T.%Q", p->azCol[i]);
  170578. }else{
  170579. sqlite3Fts5BufferAppendPrintf(&rc, &buf, ", T.c%d", i);
  170580. }
  170581. }
  170582. }
  170583. assert( p->zContentExprlist==0 );
  170584. p->zContentExprlist = (char*)buf.p;
  170585. return rc;
  170586. }
  170587. /*
  170588. ** Arguments nArg/azArg contain the string arguments passed to the xCreate
  170589. ** or xConnect method of the virtual table. This function attempts to
  170590. ** allocate an instance of Fts5Config containing the results of parsing
  170591. ** those arguments.
  170592. **
  170593. ** If successful, SQLITE_OK is returned and *ppOut is set to point to the
  170594. ** new Fts5Config object. If an error occurs, an SQLite error code is
  170595. ** returned, *ppOut is set to NULL and an error message may be left in
  170596. ** *pzErr. It is the responsibility of the caller to eventually free any
  170597. ** such error message using sqlite3_free().
  170598. */
  170599. static int sqlite3Fts5ConfigParse(
  170600. Fts5Global *pGlobal,
  170601. sqlite3 *db,
  170602. int nArg, /* Number of arguments */
  170603. const char **azArg, /* Array of nArg CREATE VIRTUAL TABLE args */
  170604. Fts5Config **ppOut, /* OUT: Results of parse */
  170605. char **pzErr /* OUT: Error message */
  170606. ){
  170607. int rc = SQLITE_OK; /* Return code */
  170608. Fts5Config *pRet; /* New object to return */
  170609. int i;
  170610. int nByte;
  170611. *ppOut = pRet = (Fts5Config*)sqlite3_malloc(sizeof(Fts5Config));
  170612. if( pRet==0 ) return SQLITE_NOMEM;
  170613. memset(pRet, 0, sizeof(Fts5Config));
  170614. pRet->db = db;
  170615. pRet->iCookie = -1;
  170616. nByte = nArg * (sizeof(char*) + sizeof(u8));
  170617. pRet->azCol = (char**)sqlite3Fts5MallocZero(&rc, nByte);
  170618. pRet->abUnindexed = (u8*)&pRet->azCol[nArg];
  170619. pRet->zDb = sqlite3Fts5Strndup(&rc, azArg[1], -1);
  170620. pRet->zName = sqlite3Fts5Strndup(&rc, azArg[2], -1);
  170621. pRet->bColumnsize = 1;
  170622. pRet->eDetail = FTS5_DETAIL_FULL;
  170623. #ifdef SQLITE_DEBUG
  170624. pRet->bPrefixIndex = 1;
  170625. #endif
  170626. if( rc==SQLITE_OK && sqlite3_stricmp(pRet->zName, FTS5_RANK_NAME)==0 ){
  170627. *pzErr = sqlite3_mprintf("reserved fts5 table name: %s", pRet->zName);
  170628. rc = SQLITE_ERROR;
  170629. }
  170630. for(i=3; rc==SQLITE_OK && i<nArg; i++){
  170631. const char *zOrig = azArg[i];
  170632. const char *z;
  170633. char *zOne = 0;
  170634. char *zTwo = 0;
  170635. int bOption = 0;
  170636. int bMustBeCol = 0;
  170637. z = fts5ConfigGobbleWord(&rc, zOrig, &zOne, &bMustBeCol);
  170638. z = fts5ConfigSkipWhitespace(z);
  170639. if( z && *z=='=' ){
  170640. bOption = 1;
  170641. z++;
  170642. if( bMustBeCol ) z = 0;
  170643. }
  170644. z = fts5ConfigSkipWhitespace(z);
  170645. if( z && z[0] ){
  170646. int bDummy;
  170647. z = fts5ConfigGobbleWord(&rc, z, &zTwo, &bDummy);
  170648. if( z && z[0] ) z = 0;
  170649. }
  170650. if( rc==SQLITE_OK ){
  170651. if( z==0 ){
  170652. *pzErr = sqlite3_mprintf("parse error in \"%s\"", zOrig);
  170653. rc = SQLITE_ERROR;
  170654. }else{
  170655. if( bOption ){
  170656. rc = fts5ConfigParseSpecial(pGlobal, pRet, zOne, zTwo?zTwo:"", pzErr);
  170657. }else{
  170658. rc = fts5ConfigParseColumn(pRet, zOne, zTwo, pzErr);
  170659. zOne = 0;
  170660. }
  170661. }
  170662. }
  170663. sqlite3_free(zOne);
  170664. sqlite3_free(zTwo);
  170665. }
  170666. /* If a tokenizer= option was successfully parsed, the tokenizer has
  170667. ** already been allocated. Otherwise, allocate an instance of the default
  170668. ** tokenizer (unicode61) now. */
  170669. if( rc==SQLITE_OK && pRet->pTok==0 ){
  170670. rc = fts5ConfigDefaultTokenizer(pGlobal, pRet);
  170671. }
  170672. /* If no zContent option was specified, fill in the default values. */
  170673. if( rc==SQLITE_OK && pRet->zContent==0 ){
  170674. const char *zTail = 0;
  170675. assert( pRet->eContent==FTS5_CONTENT_NORMAL
  170676. || pRet->eContent==FTS5_CONTENT_NONE
  170677. );
  170678. if( pRet->eContent==FTS5_CONTENT_NORMAL ){
  170679. zTail = "content";
  170680. }else if( pRet->bColumnsize ){
  170681. zTail = "docsize";
  170682. }
  170683. if( zTail ){
  170684. pRet->zContent = sqlite3Fts5Mprintf(
  170685. &rc, "%Q.'%q_%s'", pRet->zDb, pRet->zName, zTail
  170686. );
  170687. }
  170688. }
  170689. if( rc==SQLITE_OK && pRet->zContentRowid==0 ){
  170690. pRet->zContentRowid = sqlite3Fts5Strndup(&rc, "rowid", -1);
  170691. }
  170692. /* Formulate the zContentExprlist text */
  170693. if( rc==SQLITE_OK ){
  170694. rc = fts5ConfigMakeExprlist(pRet);
  170695. }
  170696. if( rc!=SQLITE_OK ){
  170697. sqlite3Fts5ConfigFree(pRet);
  170698. *ppOut = 0;
  170699. }
  170700. return rc;
  170701. }
  170702. /*
  170703. ** Free the configuration object passed as the only argument.
  170704. */
  170705. static void sqlite3Fts5ConfigFree(Fts5Config *pConfig){
  170706. if( pConfig ){
  170707. int i;
  170708. if( pConfig->pTok ){
  170709. pConfig->pTokApi->xDelete(pConfig->pTok);
  170710. }
  170711. sqlite3_free(pConfig->zDb);
  170712. sqlite3_free(pConfig->zName);
  170713. for(i=0; i<pConfig->nCol; i++){
  170714. sqlite3_free(pConfig->azCol[i]);
  170715. }
  170716. sqlite3_free(pConfig->azCol);
  170717. sqlite3_free(pConfig->aPrefix);
  170718. sqlite3_free(pConfig->zRank);
  170719. sqlite3_free(pConfig->zRankArgs);
  170720. sqlite3_free(pConfig->zContent);
  170721. sqlite3_free(pConfig->zContentRowid);
  170722. sqlite3_free(pConfig->zContentExprlist);
  170723. sqlite3_free(pConfig);
  170724. }
  170725. }
  170726. /*
  170727. ** Call sqlite3_declare_vtab() based on the contents of the configuration
  170728. ** object passed as the only argument. Return SQLITE_OK if successful, or
  170729. ** an SQLite error code if an error occurs.
  170730. */
  170731. static int sqlite3Fts5ConfigDeclareVtab(Fts5Config *pConfig){
  170732. int i;
  170733. int rc = SQLITE_OK;
  170734. char *zSql;
  170735. zSql = sqlite3Fts5Mprintf(&rc, "CREATE TABLE x(");
  170736. for(i=0; zSql && i<pConfig->nCol; i++){
  170737. const char *zSep = (i==0?"":", ");
  170738. zSql = sqlite3Fts5Mprintf(&rc, "%z%s%Q", zSql, zSep, pConfig->azCol[i]);
  170739. }
  170740. zSql = sqlite3Fts5Mprintf(&rc, "%z, %Q HIDDEN, %s HIDDEN)",
  170741. zSql, pConfig->zName, FTS5_RANK_NAME
  170742. );
  170743. assert( zSql || rc==SQLITE_NOMEM );
  170744. if( zSql ){
  170745. rc = sqlite3_declare_vtab(pConfig->db, zSql);
  170746. sqlite3_free(zSql);
  170747. }
  170748. return rc;
  170749. }
  170750. /*
  170751. ** Tokenize the text passed via the second and third arguments.
  170752. **
  170753. ** The callback is invoked once for each token in the input text. The
  170754. ** arguments passed to it are, in order:
  170755. **
  170756. ** void *pCtx // Copy of 4th argument to sqlite3Fts5Tokenize()
  170757. ** const char *pToken // Pointer to buffer containing token
  170758. ** int nToken // Size of token in bytes
  170759. ** int iStart // Byte offset of start of token within input text
  170760. ** int iEnd // Byte offset of end of token within input text
  170761. ** int iPos // Position of token in input (first token is 0)
  170762. **
  170763. ** If the callback returns a non-zero value the tokenization is abandoned
  170764. ** and no further callbacks are issued.
  170765. **
  170766. ** This function returns SQLITE_OK if successful or an SQLite error code
  170767. ** if an error occurs. If the tokenization was abandoned early because
  170768. ** the callback returned SQLITE_DONE, this is not an error and this function
  170769. ** still returns SQLITE_OK. Or, if the tokenization was abandoned early
  170770. ** because the callback returned another non-zero value, it is assumed
  170771. ** to be an SQLite error code and returned to the caller.
  170772. */
  170773. static int sqlite3Fts5Tokenize(
  170774. Fts5Config *pConfig, /* FTS5 Configuration object */
  170775. int flags, /* FTS5_TOKENIZE_* flags */
  170776. const char *pText, int nText, /* Text to tokenize */
  170777. void *pCtx, /* Context passed to xToken() */
  170778. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  170779. ){
  170780. if( pText==0 ) return SQLITE_OK;
  170781. return pConfig->pTokApi->xTokenize(
  170782. pConfig->pTok, pCtx, flags, pText, nText, xToken
  170783. );
  170784. }
  170785. /*
  170786. ** Argument pIn points to the first character in what is expected to be
  170787. ** a comma-separated list of SQL literals followed by a ')' character.
  170788. ** If it actually is this, return a pointer to the ')'. Otherwise, return
  170789. ** NULL to indicate a parse error.
  170790. */
  170791. static const char *fts5ConfigSkipArgs(const char *pIn){
  170792. const char *p = pIn;
  170793. while( 1 ){
  170794. p = fts5ConfigSkipWhitespace(p);
  170795. p = fts5ConfigSkipLiteral(p);
  170796. p = fts5ConfigSkipWhitespace(p);
  170797. if( p==0 || *p==')' ) break;
  170798. if( *p!=',' ){
  170799. p = 0;
  170800. break;
  170801. }
  170802. p++;
  170803. }
  170804. return p;
  170805. }
  170806. /*
  170807. ** Parameter zIn contains a rank() function specification. The format of
  170808. ** this is:
  170809. **
  170810. ** + Bareword (function name)
  170811. ** + Open parenthesis - "("
  170812. ** + Zero or more SQL literals in a comma separated list
  170813. ** + Close parenthesis - ")"
  170814. */
  170815. static int sqlite3Fts5ConfigParseRank(
  170816. const char *zIn, /* Input string */
  170817. char **pzRank, /* OUT: Rank function name */
  170818. char **pzRankArgs /* OUT: Rank function arguments */
  170819. ){
  170820. const char *p = zIn;
  170821. const char *pRank;
  170822. char *zRank = 0;
  170823. char *zRankArgs = 0;
  170824. int rc = SQLITE_OK;
  170825. *pzRank = 0;
  170826. *pzRankArgs = 0;
  170827. if( p==0 ){
  170828. rc = SQLITE_ERROR;
  170829. }else{
  170830. p = fts5ConfigSkipWhitespace(p);
  170831. pRank = p;
  170832. p = fts5ConfigSkipBareword(p);
  170833. if( p ){
  170834. zRank = sqlite3Fts5MallocZero(&rc, 1 + p - pRank);
  170835. if( zRank ) memcpy(zRank, pRank, p-pRank);
  170836. }else{
  170837. rc = SQLITE_ERROR;
  170838. }
  170839. if( rc==SQLITE_OK ){
  170840. p = fts5ConfigSkipWhitespace(p);
  170841. if( *p!='(' ) rc = SQLITE_ERROR;
  170842. p++;
  170843. }
  170844. if( rc==SQLITE_OK ){
  170845. const char *pArgs;
  170846. p = fts5ConfigSkipWhitespace(p);
  170847. pArgs = p;
  170848. if( *p!=')' ){
  170849. p = fts5ConfigSkipArgs(p);
  170850. if( p==0 ){
  170851. rc = SQLITE_ERROR;
  170852. }else{
  170853. zRankArgs = sqlite3Fts5MallocZero(&rc, 1 + p - pArgs);
  170854. if( zRankArgs ) memcpy(zRankArgs, pArgs, p-pArgs);
  170855. }
  170856. }
  170857. }
  170858. }
  170859. if( rc!=SQLITE_OK ){
  170860. sqlite3_free(zRank);
  170861. assert( zRankArgs==0 );
  170862. }else{
  170863. *pzRank = zRank;
  170864. *pzRankArgs = zRankArgs;
  170865. }
  170866. return rc;
  170867. }
  170868. static int sqlite3Fts5ConfigSetValue(
  170869. Fts5Config *pConfig,
  170870. const char *zKey,
  170871. sqlite3_value *pVal,
  170872. int *pbBadkey
  170873. ){
  170874. int rc = SQLITE_OK;
  170875. if( 0==sqlite3_stricmp(zKey, "pgsz") ){
  170876. int pgsz = 0;
  170877. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  170878. pgsz = sqlite3_value_int(pVal);
  170879. }
  170880. if( pgsz<=0 || pgsz>FTS5_MAX_PAGE_SIZE ){
  170881. *pbBadkey = 1;
  170882. }else{
  170883. pConfig->pgsz = pgsz;
  170884. }
  170885. }
  170886. else if( 0==sqlite3_stricmp(zKey, "hashsize") ){
  170887. int nHashSize = -1;
  170888. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  170889. nHashSize = sqlite3_value_int(pVal);
  170890. }
  170891. if( nHashSize<=0 ){
  170892. *pbBadkey = 1;
  170893. }else{
  170894. pConfig->nHashSize = nHashSize;
  170895. }
  170896. }
  170897. else if( 0==sqlite3_stricmp(zKey, "automerge") ){
  170898. int nAutomerge = -1;
  170899. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  170900. nAutomerge = sqlite3_value_int(pVal);
  170901. }
  170902. if( nAutomerge<0 || nAutomerge>64 ){
  170903. *pbBadkey = 1;
  170904. }else{
  170905. if( nAutomerge==1 ) nAutomerge = FTS5_DEFAULT_AUTOMERGE;
  170906. pConfig->nAutomerge = nAutomerge;
  170907. }
  170908. }
  170909. else if( 0==sqlite3_stricmp(zKey, "usermerge") ){
  170910. int nUsermerge = -1;
  170911. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  170912. nUsermerge = sqlite3_value_int(pVal);
  170913. }
  170914. if( nUsermerge<2 || nUsermerge>16 ){
  170915. *pbBadkey = 1;
  170916. }else{
  170917. pConfig->nUsermerge = nUsermerge;
  170918. }
  170919. }
  170920. else if( 0==sqlite3_stricmp(zKey, "crisismerge") ){
  170921. int nCrisisMerge = -1;
  170922. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  170923. nCrisisMerge = sqlite3_value_int(pVal);
  170924. }
  170925. if( nCrisisMerge<0 ){
  170926. *pbBadkey = 1;
  170927. }else{
  170928. if( nCrisisMerge<=1 ) nCrisisMerge = FTS5_DEFAULT_CRISISMERGE;
  170929. pConfig->nCrisisMerge = nCrisisMerge;
  170930. }
  170931. }
  170932. else if( 0==sqlite3_stricmp(zKey, "rank") ){
  170933. const char *zIn = (const char*)sqlite3_value_text(pVal);
  170934. char *zRank;
  170935. char *zRankArgs;
  170936. rc = sqlite3Fts5ConfigParseRank(zIn, &zRank, &zRankArgs);
  170937. if( rc==SQLITE_OK ){
  170938. sqlite3_free(pConfig->zRank);
  170939. sqlite3_free(pConfig->zRankArgs);
  170940. pConfig->zRank = zRank;
  170941. pConfig->zRankArgs = zRankArgs;
  170942. }else if( rc==SQLITE_ERROR ){
  170943. rc = SQLITE_OK;
  170944. *pbBadkey = 1;
  170945. }
  170946. }else{
  170947. *pbBadkey = 1;
  170948. }
  170949. return rc;
  170950. }
  170951. /*
  170952. ** Load the contents of the %_config table into memory.
  170953. */
  170954. static int sqlite3Fts5ConfigLoad(Fts5Config *pConfig, int iCookie){
  170955. const char *zSelect = "SELECT k, v FROM %Q.'%q_config'";
  170956. char *zSql;
  170957. sqlite3_stmt *p = 0;
  170958. int rc = SQLITE_OK;
  170959. int iVersion = 0;
  170960. /* Set default values */
  170961. pConfig->pgsz = FTS5_DEFAULT_PAGE_SIZE;
  170962. pConfig->nAutomerge = FTS5_DEFAULT_AUTOMERGE;
  170963. pConfig->nUsermerge = FTS5_DEFAULT_USERMERGE;
  170964. pConfig->nCrisisMerge = FTS5_DEFAULT_CRISISMERGE;
  170965. pConfig->nHashSize = FTS5_DEFAULT_HASHSIZE;
  170966. zSql = sqlite3Fts5Mprintf(&rc, zSelect, pConfig->zDb, pConfig->zName);
  170967. if( zSql ){
  170968. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &p, 0);
  170969. sqlite3_free(zSql);
  170970. }
  170971. assert( rc==SQLITE_OK || p==0 );
  170972. if( rc==SQLITE_OK ){
  170973. while( SQLITE_ROW==sqlite3_step(p) ){
  170974. const char *zK = (const char*)sqlite3_column_text(p, 0);
  170975. sqlite3_value *pVal = sqlite3_column_value(p, 1);
  170976. if( 0==sqlite3_stricmp(zK, "version") ){
  170977. iVersion = sqlite3_value_int(pVal);
  170978. }else{
  170979. int bDummy = 0;
  170980. sqlite3Fts5ConfigSetValue(pConfig, zK, pVal, &bDummy);
  170981. }
  170982. }
  170983. rc = sqlite3_finalize(p);
  170984. }
  170985. if( rc==SQLITE_OK && iVersion!=FTS5_CURRENT_VERSION ){
  170986. rc = SQLITE_ERROR;
  170987. if( pConfig->pzErrmsg ){
  170988. assert( 0==*pConfig->pzErrmsg );
  170989. *pConfig->pzErrmsg = sqlite3_mprintf(
  170990. "invalid fts5 file format (found %d, expected %d) - run 'rebuild'",
  170991. iVersion, FTS5_CURRENT_VERSION
  170992. );
  170993. }
  170994. }
  170995. if( rc==SQLITE_OK ){
  170996. pConfig->iCookie = iCookie;
  170997. }
  170998. return rc;
  170999. }
  171000. /*
  171001. ** 2014 May 31
  171002. **
  171003. ** The author disclaims copyright to this source code. In place of
  171004. ** a legal notice, here is a blessing:
  171005. **
  171006. ** May you do good and not evil.
  171007. ** May you find forgiveness for yourself and forgive others.
  171008. ** May you share freely, never taking more than you give.
  171009. **
  171010. ******************************************************************************
  171011. **
  171012. */
  171013. /* #include "fts5Int.h" */
  171014. /* #include "fts5parse.h" */
  171015. /*
  171016. ** All token types in the generated fts5parse.h file are greater than 0.
  171017. */
  171018. #define FTS5_EOF 0
  171019. #define FTS5_LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  171020. typedef struct Fts5ExprTerm Fts5ExprTerm;
  171021. /*
  171022. ** Functions generated by lemon from fts5parse.y.
  171023. */
  171024. static void *sqlite3Fts5ParserAlloc(void *(*mallocProc)(u64));
  171025. static void sqlite3Fts5ParserFree(void*, void (*freeProc)(void*));
  171026. static void sqlite3Fts5Parser(void*, int, Fts5Token, Fts5Parse*);
  171027. #ifndef NDEBUG
  171028. /* #include <stdio.h> */
  171029. static void sqlite3Fts5ParserTrace(FILE*, char*);
  171030. #endif
  171031. struct Fts5Expr {
  171032. Fts5Index *pIndex;
  171033. Fts5Config *pConfig;
  171034. Fts5ExprNode *pRoot;
  171035. int bDesc; /* Iterate in descending rowid order */
  171036. int nPhrase; /* Number of phrases in expression */
  171037. Fts5ExprPhrase **apExprPhrase; /* Pointers to phrase objects */
  171038. };
  171039. /*
  171040. ** eType:
  171041. ** Expression node type. Always one of:
  171042. **
  171043. ** FTS5_AND (nChild, apChild valid)
  171044. ** FTS5_OR (nChild, apChild valid)
  171045. ** FTS5_NOT (nChild, apChild valid)
  171046. ** FTS5_STRING (pNear valid)
  171047. ** FTS5_TERM (pNear valid)
  171048. */
  171049. struct Fts5ExprNode {
  171050. int eType; /* Node type */
  171051. int bEof; /* True at EOF */
  171052. int bNomatch; /* True if entry is not a match */
  171053. /* Next method for this node. */
  171054. int (*xNext)(Fts5Expr*, Fts5ExprNode*, int, i64);
  171055. i64 iRowid; /* Current rowid */
  171056. Fts5ExprNearset *pNear; /* For FTS5_STRING - cluster of phrases */
  171057. /* Child nodes. For a NOT node, this array always contains 2 entries. For
  171058. ** AND or OR nodes, it contains 2 or more entries. */
  171059. int nChild; /* Number of child nodes */
  171060. Fts5ExprNode *apChild[1]; /* Array of child nodes */
  171061. };
  171062. #define Fts5NodeIsString(p) ((p)->eType==FTS5_TERM || (p)->eType==FTS5_STRING)
  171063. /*
  171064. ** Invoke the xNext method of an Fts5ExprNode object. This macro should be
  171065. ** used as if it has the same signature as the xNext() methods themselves.
  171066. */
  171067. #define fts5ExprNodeNext(a,b,c,d) (b)->xNext((a), (b), (c), (d))
  171068. /*
  171069. ** An instance of the following structure represents a single search term
  171070. ** or term prefix.
  171071. */
  171072. struct Fts5ExprTerm {
  171073. int bPrefix; /* True for a prefix term */
  171074. char *zTerm; /* nul-terminated term */
  171075. Fts5IndexIter *pIter; /* Iterator for this term */
  171076. Fts5ExprTerm *pSynonym; /* Pointer to first in list of synonyms */
  171077. };
  171078. /*
  171079. ** A phrase. One or more terms that must appear in a contiguous sequence
  171080. ** within a document for it to match.
  171081. */
  171082. struct Fts5ExprPhrase {
  171083. Fts5ExprNode *pNode; /* FTS5_STRING node this phrase is part of */
  171084. Fts5Buffer poslist; /* Current position list */
  171085. int nTerm; /* Number of entries in aTerm[] */
  171086. Fts5ExprTerm aTerm[1]; /* Terms that make up this phrase */
  171087. };
  171088. /*
  171089. ** One or more phrases that must appear within a certain token distance of
  171090. ** each other within each matching document.
  171091. */
  171092. struct Fts5ExprNearset {
  171093. int nNear; /* NEAR parameter */
  171094. Fts5Colset *pColset; /* Columns to search (NULL -> all columns) */
  171095. int nPhrase; /* Number of entries in aPhrase[] array */
  171096. Fts5ExprPhrase *apPhrase[1]; /* Array of phrase pointers */
  171097. };
  171098. /*
  171099. ** Parse context.
  171100. */
  171101. struct Fts5Parse {
  171102. Fts5Config *pConfig;
  171103. char *zErr;
  171104. int rc;
  171105. int nPhrase; /* Size of apPhrase array */
  171106. Fts5ExprPhrase **apPhrase; /* Array of all phrases */
  171107. Fts5ExprNode *pExpr; /* Result of a successful parse */
  171108. };
  171109. static void sqlite3Fts5ParseError(Fts5Parse *pParse, const char *zFmt, ...){
  171110. va_list ap;
  171111. va_start(ap, zFmt);
  171112. if( pParse->rc==SQLITE_OK ){
  171113. pParse->zErr = sqlite3_vmprintf(zFmt, ap);
  171114. pParse->rc = SQLITE_ERROR;
  171115. }
  171116. va_end(ap);
  171117. }
  171118. static int fts5ExprIsspace(char t){
  171119. return t==' ' || t=='\t' || t=='\n' || t=='\r';
  171120. }
  171121. /*
  171122. ** Read the first token from the nul-terminated string at *pz.
  171123. */
  171124. static int fts5ExprGetToken(
  171125. Fts5Parse *pParse,
  171126. const char **pz, /* IN/OUT: Pointer into buffer */
  171127. Fts5Token *pToken
  171128. ){
  171129. const char *z = *pz;
  171130. int tok;
  171131. /* Skip past any whitespace */
  171132. while( fts5ExprIsspace(*z) ) z++;
  171133. pToken->p = z;
  171134. pToken->n = 1;
  171135. switch( *z ){
  171136. case '(': tok = FTS5_LP; break;
  171137. case ')': tok = FTS5_RP; break;
  171138. case '{': tok = FTS5_LCP; break;
  171139. case '}': tok = FTS5_RCP; break;
  171140. case ':': tok = FTS5_COLON; break;
  171141. case ',': tok = FTS5_COMMA; break;
  171142. case '+': tok = FTS5_PLUS; break;
  171143. case '*': tok = FTS5_STAR; break;
  171144. case '-': tok = FTS5_MINUS; break;
  171145. case '\0': tok = FTS5_EOF; break;
  171146. case '"': {
  171147. const char *z2;
  171148. tok = FTS5_STRING;
  171149. for(z2=&z[1]; 1; z2++){
  171150. if( z2[0]=='"' ){
  171151. z2++;
  171152. if( z2[0]!='"' ) break;
  171153. }
  171154. if( z2[0]=='\0' ){
  171155. sqlite3Fts5ParseError(pParse, "unterminated string");
  171156. return FTS5_EOF;
  171157. }
  171158. }
  171159. pToken->n = (z2 - z);
  171160. break;
  171161. }
  171162. default: {
  171163. const char *z2;
  171164. if( sqlite3Fts5IsBareword(z[0])==0 ){
  171165. sqlite3Fts5ParseError(pParse, "fts5: syntax error near \"%.1s\"", z);
  171166. return FTS5_EOF;
  171167. }
  171168. tok = FTS5_STRING;
  171169. for(z2=&z[1]; sqlite3Fts5IsBareword(*z2); z2++);
  171170. pToken->n = (z2 - z);
  171171. if( pToken->n==2 && memcmp(pToken->p, "OR", 2)==0 ) tok = FTS5_OR;
  171172. if( pToken->n==3 && memcmp(pToken->p, "NOT", 3)==0 ) tok = FTS5_NOT;
  171173. if( pToken->n==3 && memcmp(pToken->p, "AND", 3)==0 ) tok = FTS5_AND;
  171174. break;
  171175. }
  171176. }
  171177. *pz = &pToken->p[pToken->n];
  171178. return tok;
  171179. }
  171180. static void *fts5ParseAlloc(u64 t){ return sqlite3_malloc((int)t); }
  171181. static void fts5ParseFree(void *p){ sqlite3_free(p); }
  171182. static int sqlite3Fts5ExprNew(
  171183. Fts5Config *pConfig, /* FTS5 Configuration */
  171184. const char *zExpr, /* Expression text */
  171185. Fts5Expr **ppNew,
  171186. char **pzErr
  171187. ){
  171188. Fts5Parse sParse;
  171189. Fts5Token token;
  171190. const char *z = zExpr;
  171191. int t; /* Next token type */
  171192. void *pEngine;
  171193. Fts5Expr *pNew;
  171194. *ppNew = 0;
  171195. *pzErr = 0;
  171196. memset(&sParse, 0, sizeof(sParse));
  171197. pEngine = sqlite3Fts5ParserAlloc(fts5ParseAlloc);
  171198. if( pEngine==0 ){ return SQLITE_NOMEM; }
  171199. sParse.pConfig = pConfig;
  171200. do {
  171201. t = fts5ExprGetToken(&sParse, &z, &token);
  171202. sqlite3Fts5Parser(pEngine, t, token, &sParse);
  171203. }while( sParse.rc==SQLITE_OK && t!=FTS5_EOF );
  171204. sqlite3Fts5ParserFree(pEngine, fts5ParseFree);
  171205. assert( sParse.rc!=SQLITE_OK || sParse.zErr==0 );
  171206. if( sParse.rc==SQLITE_OK ){
  171207. *ppNew = pNew = sqlite3_malloc(sizeof(Fts5Expr));
  171208. if( pNew==0 ){
  171209. sParse.rc = SQLITE_NOMEM;
  171210. sqlite3Fts5ParseNodeFree(sParse.pExpr);
  171211. }else{
  171212. if( !sParse.pExpr ){
  171213. const int nByte = sizeof(Fts5ExprNode);
  171214. pNew->pRoot = (Fts5ExprNode*)sqlite3Fts5MallocZero(&sParse.rc, nByte);
  171215. if( pNew->pRoot ){
  171216. pNew->pRoot->bEof = 1;
  171217. }
  171218. }else{
  171219. pNew->pRoot = sParse.pExpr;
  171220. }
  171221. pNew->pIndex = 0;
  171222. pNew->pConfig = pConfig;
  171223. pNew->apExprPhrase = sParse.apPhrase;
  171224. pNew->nPhrase = sParse.nPhrase;
  171225. sParse.apPhrase = 0;
  171226. }
  171227. }else{
  171228. sqlite3Fts5ParseNodeFree(sParse.pExpr);
  171229. }
  171230. sqlite3_free(sParse.apPhrase);
  171231. *pzErr = sParse.zErr;
  171232. return sParse.rc;
  171233. }
  171234. /*
  171235. ** Free the expression node object passed as the only argument.
  171236. */
  171237. static void sqlite3Fts5ParseNodeFree(Fts5ExprNode *p){
  171238. if( p ){
  171239. int i;
  171240. for(i=0; i<p->nChild; i++){
  171241. sqlite3Fts5ParseNodeFree(p->apChild[i]);
  171242. }
  171243. sqlite3Fts5ParseNearsetFree(p->pNear);
  171244. sqlite3_free(p);
  171245. }
  171246. }
  171247. /*
  171248. ** Free the expression object passed as the only argument.
  171249. */
  171250. static void sqlite3Fts5ExprFree(Fts5Expr *p){
  171251. if( p ){
  171252. sqlite3Fts5ParseNodeFree(p->pRoot);
  171253. sqlite3_free(p->apExprPhrase);
  171254. sqlite3_free(p);
  171255. }
  171256. }
  171257. /*
  171258. ** Argument pTerm must be a synonym iterator. Return the current rowid
  171259. ** that it points to.
  171260. */
  171261. static i64 fts5ExprSynonymRowid(Fts5ExprTerm *pTerm, int bDesc, int *pbEof){
  171262. i64 iRet = 0;
  171263. int bRetValid = 0;
  171264. Fts5ExprTerm *p;
  171265. assert( pTerm->pSynonym );
  171266. assert( bDesc==0 || bDesc==1 );
  171267. for(p=pTerm; p; p=p->pSynonym){
  171268. if( 0==sqlite3Fts5IterEof(p->pIter) ){
  171269. i64 iRowid = p->pIter->iRowid;
  171270. if( bRetValid==0 || (bDesc!=(iRowid<iRet)) ){
  171271. iRet = iRowid;
  171272. bRetValid = 1;
  171273. }
  171274. }
  171275. }
  171276. if( pbEof && bRetValid==0 ) *pbEof = 1;
  171277. return iRet;
  171278. }
  171279. /*
  171280. ** Argument pTerm must be a synonym iterator.
  171281. */
  171282. static int fts5ExprSynonymList(
  171283. Fts5ExprTerm *pTerm,
  171284. i64 iRowid,
  171285. Fts5Buffer *pBuf, /* Use this buffer for space if required */
  171286. u8 **pa, int *pn
  171287. ){
  171288. Fts5PoslistReader aStatic[4];
  171289. Fts5PoslistReader *aIter = aStatic;
  171290. int nIter = 0;
  171291. int nAlloc = 4;
  171292. int rc = SQLITE_OK;
  171293. Fts5ExprTerm *p;
  171294. assert( pTerm->pSynonym );
  171295. for(p=pTerm; p; p=p->pSynonym){
  171296. Fts5IndexIter *pIter = p->pIter;
  171297. if( sqlite3Fts5IterEof(pIter)==0 && pIter->iRowid==iRowid ){
  171298. if( pIter->nData==0 ) continue;
  171299. if( nIter==nAlloc ){
  171300. int nByte = sizeof(Fts5PoslistReader) * nAlloc * 2;
  171301. Fts5PoslistReader *aNew = (Fts5PoslistReader*)sqlite3_malloc(nByte);
  171302. if( aNew==0 ){
  171303. rc = SQLITE_NOMEM;
  171304. goto synonym_poslist_out;
  171305. }
  171306. memcpy(aNew, aIter, sizeof(Fts5PoslistReader) * nIter);
  171307. nAlloc = nAlloc*2;
  171308. if( aIter!=aStatic ) sqlite3_free(aIter);
  171309. aIter = aNew;
  171310. }
  171311. sqlite3Fts5PoslistReaderInit(pIter->pData, pIter->nData, &aIter[nIter]);
  171312. assert( aIter[nIter].bEof==0 );
  171313. nIter++;
  171314. }
  171315. }
  171316. if( nIter==1 ){
  171317. *pa = (u8*)aIter[0].a;
  171318. *pn = aIter[0].n;
  171319. }else{
  171320. Fts5PoslistWriter writer = {0};
  171321. i64 iPrev = -1;
  171322. fts5BufferZero(pBuf);
  171323. while( 1 ){
  171324. int i;
  171325. i64 iMin = FTS5_LARGEST_INT64;
  171326. for(i=0; i<nIter; i++){
  171327. if( aIter[i].bEof==0 ){
  171328. if( aIter[i].iPos==iPrev ){
  171329. if( sqlite3Fts5PoslistReaderNext(&aIter[i]) ) continue;
  171330. }
  171331. if( aIter[i].iPos<iMin ){
  171332. iMin = aIter[i].iPos;
  171333. }
  171334. }
  171335. }
  171336. if( iMin==FTS5_LARGEST_INT64 || rc!=SQLITE_OK ) break;
  171337. rc = sqlite3Fts5PoslistWriterAppend(pBuf, &writer, iMin);
  171338. iPrev = iMin;
  171339. }
  171340. if( rc==SQLITE_OK ){
  171341. *pa = pBuf->p;
  171342. *pn = pBuf->n;
  171343. }
  171344. }
  171345. synonym_poslist_out:
  171346. if( aIter!=aStatic ) sqlite3_free(aIter);
  171347. return rc;
  171348. }
  171349. /*
  171350. ** All individual term iterators in pPhrase are guaranteed to be valid and
  171351. ** pointing to the same rowid when this function is called. This function
  171352. ** checks if the current rowid really is a match, and if so populates
  171353. ** the pPhrase->poslist buffer accordingly. Output parameter *pbMatch
  171354. ** is set to true if this is really a match, or false otherwise.
  171355. **
  171356. ** SQLITE_OK is returned if an error occurs, or an SQLite error code
  171357. ** otherwise. It is not considered an error code if the current rowid is
  171358. ** not a match.
  171359. */
  171360. static int fts5ExprPhraseIsMatch(
  171361. Fts5ExprNode *pNode, /* Node pPhrase belongs to */
  171362. Fts5ExprPhrase *pPhrase, /* Phrase object to initialize */
  171363. int *pbMatch /* OUT: Set to true if really a match */
  171364. ){
  171365. Fts5PoslistWriter writer = {0};
  171366. Fts5PoslistReader aStatic[4];
  171367. Fts5PoslistReader *aIter = aStatic;
  171368. int i;
  171369. int rc = SQLITE_OK;
  171370. fts5BufferZero(&pPhrase->poslist);
  171371. /* If the aStatic[] array is not large enough, allocate a large array
  171372. ** using sqlite3_malloc(). This approach could be improved upon. */
  171373. if( pPhrase->nTerm>ArraySize(aStatic) ){
  171374. int nByte = sizeof(Fts5PoslistReader) * pPhrase->nTerm;
  171375. aIter = (Fts5PoslistReader*)sqlite3_malloc(nByte);
  171376. if( !aIter ) return SQLITE_NOMEM;
  171377. }
  171378. memset(aIter, 0, sizeof(Fts5PoslistReader) * pPhrase->nTerm);
  171379. /* Initialize a term iterator for each term in the phrase */
  171380. for(i=0; i<pPhrase->nTerm; i++){
  171381. Fts5ExprTerm *pTerm = &pPhrase->aTerm[i];
  171382. int n = 0;
  171383. int bFlag = 0;
  171384. u8 *a = 0;
  171385. if( pTerm->pSynonym ){
  171386. Fts5Buffer buf = {0, 0, 0};
  171387. rc = fts5ExprSynonymList(pTerm, pNode->iRowid, &buf, &a, &n);
  171388. if( rc ){
  171389. sqlite3_free(a);
  171390. goto ismatch_out;
  171391. }
  171392. if( a==buf.p ) bFlag = 1;
  171393. }else{
  171394. a = (u8*)pTerm->pIter->pData;
  171395. n = pTerm->pIter->nData;
  171396. }
  171397. sqlite3Fts5PoslistReaderInit(a, n, &aIter[i]);
  171398. aIter[i].bFlag = (u8)bFlag;
  171399. if( aIter[i].bEof ) goto ismatch_out;
  171400. }
  171401. while( 1 ){
  171402. int bMatch;
  171403. i64 iPos = aIter[0].iPos;
  171404. do {
  171405. bMatch = 1;
  171406. for(i=0; i<pPhrase->nTerm; i++){
  171407. Fts5PoslistReader *pPos = &aIter[i];
  171408. i64 iAdj = iPos + i;
  171409. if( pPos->iPos!=iAdj ){
  171410. bMatch = 0;
  171411. while( pPos->iPos<iAdj ){
  171412. if( sqlite3Fts5PoslistReaderNext(pPos) ) goto ismatch_out;
  171413. }
  171414. if( pPos->iPos>iAdj ) iPos = pPos->iPos-i;
  171415. }
  171416. }
  171417. }while( bMatch==0 );
  171418. /* Append position iPos to the output */
  171419. rc = sqlite3Fts5PoslistWriterAppend(&pPhrase->poslist, &writer, iPos);
  171420. if( rc!=SQLITE_OK ) goto ismatch_out;
  171421. for(i=0; i<pPhrase->nTerm; i++){
  171422. if( sqlite3Fts5PoslistReaderNext(&aIter[i]) ) goto ismatch_out;
  171423. }
  171424. }
  171425. ismatch_out:
  171426. *pbMatch = (pPhrase->poslist.n>0);
  171427. for(i=0; i<pPhrase->nTerm; i++){
  171428. if( aIter[i].bFlag ) sqlite3_free((u8*)aIter[i].a);
  171429. }
  171430. if( aIter!=aStatic ) sqlite3_free(aIter);
  171431. return rc;
  171432. }
  171433. typedef struct Fts5LookaheadReader Fts5LookaheadReader;
  171434. struct Fts5LookaheadReader {
  171435. const u8 *a; /* Buffer containing position list */
  171436. int n; /* Size of buffer a[] in bytes */
  171437. int i; /* Current offset in position list */
  171438. i64 iPos; /* Current position */
  171439. i64 iLookahead; /* Next position */
  171440. };
  171441. #define FTS5_LOOKAHEAD_EOF (((i64)1) << 62)
  171442. static int fts5LookaheadReaderNext(Fts5LookaheadReader *p){
  171443. p->iPos = p->iLookahead;
  171444. if( sqlite3Fts5PoslistNext64(p->a, p->n, &p->i, &p->iLookahead) ){
  171445. p->iLookahead = FTS5_LOOKAHEAD_EOF;
  171446. }
  171447. return (p->iPos==FTS5_LOOKAHEAD_EOF);
  171448. }
  171449. static int fts5LookaheadReaderInit(
  171450. const u8 *a, int n, /* Buffer to read position list from */
  171451. Fts5LookaheadReader *p /* Iterator object to initialize */
  171452. ){
  171453. memset(p, 0, sizeof(Fts5LookaheadReader));
  171454. p->a = a;
  171455. p->n = n;
  171456. fts5LookaheadReaderNext(p);
  171457. return fts5LookaheadReaderNext(p);
  171458. }
  171459. typedef struct Fts5NearTrimmer Fts5NearTrimmer;
  171460. struct Fts5NearTrimmer {
  171461. Fts5LookaheadReader reader; /* Input iterator */
  171462. Fts5PoslistWriter writer; /* Writer context */
  171463. Fts5Buffer *pOut; /* Output poslist */
  171464. };
  171465. /*
  171466. ** The near-set object passed as the first argument contains more than
  171467. ** one phrase. All phrases currently point to the same row. The
  171468. ** Fts5ExprPhrase.poslist buffers are populated accordingly. This function
  171469. ** tests if the current row contains instances of each phrase sufficiently
  171470. ** close together to meet the NEAR constraint. Non-zero is returned if it
  171471. ** does, or zero otherwise.
  171472. **
  171473. ** If in/out parameter (*pRc) is set to other than SQLITE_OK when this
  171474. ** function is called, it is a no-op. Or, if an error (e.g. SQLITE_NOMEM)
  171475. ** occurs within this function (*pRc) is set accordingly before returning.
  171476. ** The return value is undefined in both these cases.
  171477. **
  171478. ** If no error occurs and non-zero (a match) is returned, the position-list
  171479. ** of each phrase object is edited to contain only those entries that
  171480. ** meet the constraint before returning.
  171481. */
  171482. static int fts5ExprNearIsMatch(int *pRc, Fts5ExprNearset *pNear){
  171483. Fts5NearTrimmer aStatic[4];
  171484. Fts5NearTrimmer *a = aStatic;
  171485. Fts5ExprPhrase **apPhrase = pNear->apPhrase;
  171486. int i;
  171487. int rc = *pRc;
  171488. int bMatch;
  171489. assert( pNear->nPhrase>1 );
  171490. /* If the aStatic[] array is not large enough, allocate a large array
  171491. ** using sqlite3_malloc(). This approach could be improved upon. */
  171492. if( pNear->nPhrase>ArraySize(aStatic) ){
  171493. int nByte = sizeof(Fts5NearTrimmer) * pNear->nPhrase;
  171494. a = (Fts5NearTrimmer*)sqlite3Fts5MallocZero(&rc, nByte);
  171495. }else{
  171496. memset(aStatic, 0, sizeof(aStatic));
  171497. }
  171498. if( rc!=SQLITE_OK ){
  171499. *pRc = rc;
  171500. return 0;
  171501. }
  171502. /* Initialize a lookahead iterator for each phrase. After passing the
  171503. ** buffer and buffer size to the lookaside-reader init function, zero
  171504. ** the phrase poslist buffer. The new poslist for the phrase (containing
  171505. ** the same entries as the original with some entries removed on account
  171506. ** of the NEAR constraint) is written over the original even as it is
  171507. ** being read. This is safe as the entries for the new poslist are a
  171508. ** subset of the old, so it is not possible for data yet to be read to
  171509. ** be overwritten. */
  171510. for(i=0; i<pNear->nPhrase; i++){
  171511. Fts5Buffer *pPoslist = &apPhrase[i]->poslist;
  171512. fts5LookaheadReaderInit(pPoslist->p, pPoslist->n, &a[i].reader);
  171513. pPoslist->n = 0;
  171514. a[i].pOut = pPoslist;
  171515. }
  171516. while( 1 ){
  171517. int iAdv;
  171518. i64 iMin;
  171519. i64 iMax;
  171520. /* This block advances the phrase iterators until they point to a set of
  171521. ** entries that together comprise a match. */
  171522. iMax = a[0].reader.iPos;
  171523. do {
  171524. bMatch = 1;
  171525. for(i=0; i<pNear->nPhrase; i++){
  171526. Fts5LookaheadReader *pPos = &a[i].reader;
  171527. iMin = iMax - pNear->apPhrase[i]->nTerm - pNear->nNear;
  171528. if( pPos->iPos<iMin || pPos->iPos>iMax ){
  171529. bMatch = 0;
  171530. while( pPos->iPos<iMin ){
  171531. if( fts5LookaheadReaderNext(pPos) ) goto ismatch_out;
  171532. }
  171533. if( pPos->iPos>iMax ) iMax = pPos->iPos;
  171534. }
  171535. }
  171536. }while( bMatch==0 );
  171537. /* Add an entry to each output position list */
  171538. for(i=0; i<pNear->nPhrase; i++){
  171539. i64 iPos = a[i].reader.iPos;
  171540. Fts5PoslistWriter *pWriter = &a[i].writer;
  171541. if( a[i].pOut->n==0 || iPos!=pWriter->iPrev ){
  171542. sqlite3Fts5PoslistWriterAppend(a[i].pOut, pWriter, iPos);
  171543. }
  171544. }
  171545. iAdv = 0;
  171546. iMin = a[0].reader.iLookahead;
  171547. for(i=0; i<pNear->nPhrase; i++){
  171548. if( a[i].reader.iLookahead < iMin ){
  171549. iMin = a[i].reader.iLookahead;
  171550. iAdv = i;
  171551. }
  171552. }
  171553. if( fts5LookaheadReaderNext(&a[iAdv].reader) ) goto ismatch_out;
  171554. }
  171555. ismatch_out: {
  171556. int bRet = a[0].pOut->n>0;
  171557. *pRc = rc;
  171558. if( a!=aStatic ) sqlite3_free(a);
  171559. return bRet;
  171560. }
  171561. }
  171562. /*
  171563. ** Advance iterator pIter until it points to a value equal to or laster
  171564. ** than the initial value of *piLast. If this means the iterator points
  171565. ** to a value laster than *piLast, update *piLast to the new lastest value.
  171566. **
  171567. ** If the iterator reaches EOF, set *pbEof to true before returning. If
  171568. ** an error occurs, set *pRc to an error code. If either *pbEof or *pRc
  171569. ** are set, return a non-zero value. Otherwise, return zero.
  171570. */
  171571. static int fts5ExprAdvanceto(
  171572. Fts5IndexIter *pIter, /* Iterator to advance */
  171573. int bDesc, /* True if iterator is "rowid DESC" */
  171574. i64 *piLast, /* IN/OUT: Lastest rowid seen so far */
  171575. int *pRc, /* OUT: Error code */
  171576. int *pbEof /* OUT: Set to true if EOF */
  171577. ){
  171578. i64 iLast = *piLast;
  171579. i64 iRowid;
  171580. iRowid = pIter->iRowid;
  171581. if( (bDesc==0 && iLast>iRowid) || (bDesc && iLast<iRowid) ){
  171582. int rc = sqlite3Fts5IterNextFrom(pIter, iLast);
  171583. if( rc || sqlite3Fts5IterEof(pIter) ){
  171584. *pRc = rc;
  171585. *pbEof = 1;
  171586. return 1;
  171587. }
  171588. iRowid = pIter->iRowid;
  171589. assert( (bDesc==0 && iRowid>=iLast) || (bDesc==1 && iRowid<=iLast) );
  171590. }
  171591. *piLast = iRowid;
  171592. return 0;
  171593. }
  171594. static int fts5ExprSynonymAdvanceto(
  171595. Fts5ExprTerm *pTerm, /* Term iterator to advance */
  171596. int bDesc, /* True if iterator is "rowid DESC" */
  171597. i64 *piLast, /* IN/OUT: Lastest rowid seen so far */
  171598. int *pRc /* OUT: Error code */
  171599. ){
  171600. int rc = SQLITE_OK;
  171601. i64 iLast = *piLast;
  171602. Fts5ExprTerm *p;
  171603. int bEof = 0;
  171604. for(p=pTerm; rc==SQLITE_OK && p; p=p->pSynonym){
  171605. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  171606. i64 iRowid = p->pIter->iRowid;
  171607. if( (bDesc==0 && iLast>iRowid) || (bDesc && iLast<iRowid) ){
  171608. rc = sqlite3Fts5IterNextFrom(p->pIter, iLast);
  171609. }
  171610. }
  171611. }
  171612. if( rc!=SQLITE_OK ){
  171613. *pRc = rc;
  171614. bEof = 1;
  171615. }else{
  171616. *piLast = fts5ExprSynonymRowid(pTerm, bDesc, &bEof);
  171617. }
  171618. return bEof;
  171619. }
  171620. static int fts5ExprNearTest(
  171621. int *pRc,
  171622. Fts5Expr *pExpr, /* Expression that pNear is a part of */
  171623. Fts5ExprNode *pNode /* The "NEAR" node (FTS5_STRING) */
  171624. ){
  171625. Fts5ExprNearset *pNear = pNode->pNear;
  171626. int rc = *pRc;
  171627. if( pExpr->pConfig->eDetail!=FTS5_DETAIL_FULL ){
  171628. Fts5ExprTerm *pTerm;
  171629. Fts5ExprPhrase *pPhrase = pNear->apPhrase[0];
  171630. pPhrase->poslist.n = 0;
  171631. for(pTerm=&pPhrase->aTerm[0]; pTerm; pTerm=pTerm->pSynonym){
  171632. Fts5IndexIter *pIter = pTerm->pIter;
  171633. if( sqlite3Fts5IterEof(pIter)==0 ){
  171634. if( pIter->iRowid==pNode->iRowid && pIter->nData>0 ){
  171635. pPhrase->poslist.n = 1;
  171636. }
  171637. }
  171638. }
  171639. return pPhrase->poslist.n;
  171640. }else{
  171641. int i;
  171642. /* Check that each phrase in the nearset matches the current row.
  171643. ** Populate the pPhrase->poslist buffers at the same time. If any
  171644. ** phrase is not a match, break out of the loop early. */
  171645. for(i=0; rc==SQLITE_OK && i<pNear->nPhrase; i++){
  171646. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  171647. if( pPhrase->nTerm>1 || pPhrase->aTerm[0].pSynonym || pNear->pColset ){
  171648. int bMatch = 0;
  171649. rc = fts5ExprPhraseIsMatch(pNode, pPhrase, &bMatch);
  171650. if( bMatch==0 ) break;
  171651. }else{
  171652. Fts5IndexIter *pIter = pPhrase->aTerm[0].pIter;
  171653. fts5BufferSet(&rc, &pPhrase->poslist, pIter->nData, pIter->pData);
  171654. }
  171655. }
  171656. *pRc = rc;
  171657. if( i==pNear->nPhrase && (i==1 || fts5ExprNearIsMatch(pRc, pNear)) ){
  171658. return 1;
  171659. }
  171660. return 0;
  171661. }
  171662. }
  171663. /*
  171664. ** Initialize all term iterators in the pNear object. If any term is found
  171665. ** to match no documents at all, return immediately without initializing any
  171666. ** further iterators.
  171667. */
  171668. static int fts5ExprNearInitAll(
  171669. Fts5Expr *pExpr,
  171670. Fts5ExprNode *pNode
  171671. ){
  171672. Fts5ExprNearset *pNear = pNode->pNear;
  171673. int i, j;
  171674. int rc = SQLITE_OK;
  171675. int bEof = 1;
  171676. assert( pNode->bNomatch==0 );
  171677. for(i=0; rc==SQLITE_OK && i<pNear->nPhrase; i++){
  171678. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  171679. for(j=0; j<pPhrase->nTerm; j++){
  171680. Fts5ExprTerm *pTerm = &pPhrase->aTerm[j];
  171681. Fts5ExprTerm *p;
  171682. for(p=pTerm; p && rc==SQLITE_OK; p=p->pSynonym){
  171683. if( p->pIter ){
  171684. sqlite3Fts5IterClose(p->pIter);
  171685. p->pIter = 0;
  171686. }
  171687. rc = sqlite3Fts5IndexQuery(
  171688. pExpr->pIndex, p->zTerm, (int)strlen(p->zTerm),
  171689. (pTerm->bPrefix ? FTS5INDEX_QUERY_PREFIX : 0) |
  171690. (pExpr->bDesc ? FTS5INDEX_QUERY_DESC : 0),
  171691. pNear->pColset,
  171692. &p->pIter
  171693. );
  171694. assert( rc==SQLITE_OK || p->pIter==0 );
  171695. if( p->pIter && 0==sqlite3Fts5IterEof(p->pIter) ){
  171696. bEof = 0;
  171697. }
  171698. }
  171699. if( bEof ) break;
  171700. }
  171701. if( bEof ) break;
  171702. }
  171703. pNode->bEof = bEof;
  171704. return rc;
  171705. }
  171706. /*
  171707. ** If pExpr is an ASC iterator, this function returns a value with the
  171708. ** same sign as:
  171709. **
  171710. ** (iLhs - iRhs)
  171711. **
  171712. ** Otherwise, if this is a DESC iterator, the opposite is returned:
  171713. **
  171714. ** (iRhs - iLhs)
  171715. */
  171716. static int fts5RowidCmp(
  171717. Fts5Expr *pExpr,
  171718. i64 iLhs,
  171719. i64 iRhs
  171720. ){
  171721. assert( pExpr->bDesc==0 || pExpr->bDesc==1 );
  171722. if( pExpr->bDesc==0 ){
  171723. if( iLhs<iRhs ) return -1;
  171724. return (iLhs > iRhs);
  171725. }else{
  171726. if( iLhs>iRhs ) return -1;
  171727. return (iLhs < iRhs);
  171728. }
  171729. }
  171730. static void fts5ExprSetEof(Fts5ExprNode *pNode){
  171731. int i;
  171732. pNode->bEof = 1;
  171733. pNode->bNomatch = 0;
  171734. for(i=0; i<pNode->nChild; i++){
  171735. fts5ExprSetEof(pNode->apChild[i]);
  171736. }
  171737. }
  171738. static void fts5ExprNodeZeroPoslist(Fts5ExprNode *pNode){
  171739. if( pNode->eType==FTS5_STRING || pNode->eType==FTS5_TERM ){
  171740. Fts5ExprNearset *pNear = pNode->pNear;
  171741. int i;
  171742. for(i=0; i<pNear->nPhrase; i++){
  171743. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  171744. pPhrase->poslist.n = 0;
  171745. }
  171746. }else{
  171747. int i;
  171748. for(i=0; i<pNode->nChild; i++){
  171749. fts5ExprNodeZeroPoslist(pNode->apChild[i]);
  171750. }
  171751. }
  171752. }
  171753. /*
  171754. ** Compare the values currently indicated by the two nodes as follows:
  171755. **
  171756. ** res = (*p1) - (*p2)
  171757. **
  171758. ** Nodes that point to values that come later in the iteration order are
  171759. ** considered to be larger. Nodes at EOF are the largest of all.
  171760. **
  171761. ** This means that if the iteration order is ASC, then numerically larger
  171762. ** rowids are considered larger. Or if it is the default DESC, numerically
  171763. ** smaller rowids are larger.
  171764. */
  171765. static int fts5NodeCompare(
  171766. Fts5Expr *pExpr,
  171767. Fts5ExprNode *p1,
  171768. Fts5ExprNode *p2
  171769. ){
  171770. if( p2->bEof ) return -1;
  171771. if( p1->bEof ) return +1;
  171772. return fts5RowidCmp(pExpr, p1->iRowid, p2->iRowid);
  171773. }
  171774. /*
  171775. ** All individual term iterators in pNear are guaranteed to be valid when
  171776. ** this function is called. This function checks if all term iterators
  171777. ** point to the same rowid, and if not, advances them until they do.
  171778. ** If an EOF is reached before this happens, *pbEof is set to true before
  171779. ** returning.
  171780. **
  171781. ** SQLITE_OK is returned if an error occurs, or an SQLite error code
  171782. ** otherwise. It is not considered an error code if an iterator reaches
  171783. ** EOF.
  171784. */
  171785. static int fts5ExprNodeTest_STRING(
  171786. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  171787. Fts5ExprNode *pNode
  171788. ){
  171789. Fts5ExprNearset *pNear = pNode->pNear;
  171790. Fts5ExprPhrase *pLeft = pNear->apPhrase[0];
  171791. int rc = SQLITE_OK;
  171792. i64 iLast; /* Lastest rowid any iterator points to */
  171793. int i, j; /* Phrase and token index, respectively */
  171794. int bMatch; /* True if all terms are at the same rowid */
  171795. const int bDesc = pExpr->bDesc;
  171796. /* Check that this node should not be FTS5_TERM */
  171797. assert( pNear->nPhrase>1
  171798. || pNear->apPhrase[0]->nTerm>1
  171799. || pNear->apPhrase[0]->aTerm[0].pSynonym
  171800. );
  171801. /* Initialize iLast, the "lastest" rowid any iterator points to. If the
  171802. ** iterator skips through rowids in the default ascending order, this means
  171803. ** the maximum rowid. Or, if the iterator is "ORDER BY rowid DESC", then it
  171804. ** means the minimum rowid. */
  171805. if( pLeft->aTerm[0].pSynonym ){
  171806. iLast = fts5ExprSynonymRowid(&pLeft->aTerm[0], bDesc, 0);
  171807. }else{
  171808. iLast = pLeft->aTerm[0].pIter->iRowid;
  171809. }
  171810. do {
  171811. bMatch = 1;
  171812. for(i=0; i<pNear->nPhrase; i++){
  171813. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  171814. for(j=0; j<pPhrase->nTerm; j++){
  171815. Fts5ExprTerm *pTerm = &pPhrase->aTerm[j];
  171816. if( pTerm->pSynonym ){
  171817. i64 iRowid = fts5ExprSynonymRowid(pTerm, bDesc, 0);
  171818. if( iRowid==iLast ) continue;
  171819. bMatch = 0;
  171820. if( fts5ExprSynonymAdvanceto(pTerm, bDesc, &iLast, &rc) ){
  171821. pNode->bNomatch = 0;
  171822. pNode->bEof = 1;
  171823. return rc;
  171824. }
  171825. }else{
  171826. Fts5IndexIter *pIter = pPhrase->aTerm[j].pIter;
  171827. if( pIter->iRowid==iLast ) continue;
  171828. bMatch = 0;
  171829. if( fts5ExprAdvanceto(pIter, bDesc, &iLast, &rc, &pNode->bEof) ){
  171830. return rc;
  171831. }
  171832. }
  171833. }
  171834. }
  171835. }while( bMatch==0 );
  171836. pNode->iRowid = iLast;
  171837. pNode->bNomatch = ((0==fts5ExprNearTest(&rc, pExpr, pNode)) && rc==SQLITE_OK);
  171838. assert( pNode->bEof==0 || pNode->bNomatch==0 );
  171839. return rc;
  171840. }
  171841. /*
  171842. ** Advance the first term iterator in the first phrase of pNear. Set output
  171843. ** variable *pbEof to true if it reaches EOF or if an error occurs.
  171844. **
  171845. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  171846. ** occurs.
  171847. */
  171848. static int fts5ExprNodeNext_STRING(
  171849. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  171850. Fts5ExprNode *pNode, /* FTS5_STRING or FTS5_TERM node */
  171851. int bFromValid,
  171852. i64 iFrom
  171853. ){
  171854. Fts5ExprTerm *pTerm = &pNode->pNear->apPhrase[0]->aTerm[0];
  171855. int rc = SQLITE_OK;
  171856. pNode->bNomatch = 0;
  171857. if( pTerm->pSynonym ){
  171858. int bEof = 1;
  171859. Fts5ExprTerm *p;
  171860. /* Find the firstest rowid any synonym points to. */
  171861. i64 iRowid = fts5ExprSynonymRowid(pTerm, pExpr->bDesc, 0);
  171862. /* Advance each iterator that currently points to iRowid. Or, if iFrom
  171863. ** is valid - each iterator that points to a rowid before iFrom. */
  171864. for(p=pTerm; p; p=p->pSynonym){
  171865. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  171866. i64 ii = p->pIter->iRowid;
  171867. if( ii==iRowid
  171868. || (bFromValid && ii!=iFrom && (ii>iFrom)==pExpr->bDesc)
  171869. ){
  171870. if( bFromValid ){
  171871. rc = sqlite3Fts5IterNextFrom(p->pIter, iFrom);
  171872. }else{
  171873. rc = sqlite3Fts5IterNext(p->pIter);
  171874. }
  171875. if( rc!=SQLITE_OK ) break;
  171876. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  171877. bEof = 0;
  171878. }
  171879. }else{
  171880. bEof = 0;
  171881. }
  171882. }
  171883. }
  171884. /* Set the EOF flag if either all synonym iterators are at EOF or an
  171885. ** error has occurred. */
  171886. pNode->bEof = (rc || bEof);
  171887. }else{
  171888. Fts5IndexIter *pIter = pTerm->pIter;
  171889. assert( Fts5NodeIsString(pNode) );
  171890. if( bFromValid ){
  171891. rc = sqlite3Fts5IterNextFrom(pIter, iFrom);
  171892. }else{
  171893. rc = sqlite3Fts5IterNext(pIter);
  171894. }
  171895. pNode->bEof = (rc || sqlite3Fts5IterEof(pIter));
  171896. }
  171897. if( pNode->bEof==0 ){
  171898. assert( rc==SQLITE_OK );
  171899. rc = fts5ExprNodeTest_STRING(pExpr, pNode);
  171900. }
  171901. return rc;
  171902. }
  171903. static int fts5ExprNodeTest_TERM(
  171904. Fts5Expr *pExpr, /* Expression that pNear is a part of */
  171905. Fts5ExprNode *pNode /* The "NEAR" node (FTS5_TERM) */
  171906. ){
  171907. /* As this "NEAR" object is actually a single phrase that consists
  171908. ** of a single term only, grab pointers into the poslist managed by the
  171909. ** fts5_index.c iterator object. This is much faster than synthesizing
  171910. ** a new poslist the way we have to for more complicated phrase or NEAR
  171911. ** expressions. */
  171912. Fts5ExprPhrase *pPhrase = pNode->pNear->apPhrase[0];
  171913. Fts5IndexIter *pIter = pPhrase->aTerm[0].pIter;
  171914. assert( pNode->eType==FTS5_TERM );
  171915. assert( pNode->pNear->nPhrase==1 && pPhrase->nTerm==1 );
  171916. assert( pPhrase->aTerm[0].pSynonym==0 );
  171917. pPhrase->poslist.n = pIter->nData;
  171918. if( pExpr->pConfig->eDetail==FTS5_DETAIL_FULL ){
  171919. pPhrase->poslist.p = (u8*)pIter->pData;
  171920. }
  171921. pNode->iRowid = pIter->iRowid;
  171922. pNode->bNomatch = (pPhrase->poslist.n==0);
  171923. return SQLITE_OK;
  171924. }
  171925. /*
  171926. ** xNext() method for a node of type FTS5_TERM.
  171927. */
  171928. static int fts5ExprNodeNext_TERM(
  171929. Fts5Expr *pExpr,
  171930. Fts5ExprNode *pNode,
  171931. int bFromValid,
  171932. i64 iFrom
  171933. ){
  171934. int rc;
  171935. Fts5IndexIter *pIter = pNode->pNear->apPhrase[0]->aTerm[0].pIter;
  171936. assert( pNode->bEof==0 );
  171937. if( bFromValid ){
  171938. rc = sqlite3Fts5IterNextFrom(pIter, iFrom);
  171939. }else{
  171940. rc = sqlite3Fts5IterNext(pIter);
  171941. }
  171942. if( rc==SQLITE_OK && sqlite3Fts5IterEof(pIter)==0 ){
  171943. rc = fts5ExprNodeTest_TERM(pExpr, pNode);
  171944. }else{
  171945. pNode->bEof = 1;
  171946. pNode->bNomatch = 0;
  171947. }
  171948. return rc;
  171949. }
  171950. static void fts5ExprNodeTest_OR(
  171951. Fts5Expr *pExpr, /* Expression of which pNode is a part */
  171952. Fts5ExprNode *pNode /* Expression node to test */
  171953. ){
  171954. Fts5ExprNode *pNext = pNode->apChild[0];
  171955. int i;
  171956. for(i=1; i<pNode->nChild; i++){
  171957. Fts5ExprNode *pChild = pNode->apChild[i];
  171958. int cmp = fts5NodeCompare(pExpr, pNext, pChild);
  171959. if( cmp>0 || (cmp==0 && pChild->bNomatch==0) ){
  171960. pNext = pChild;
  171961. }
  171962. }
  171963. pNode->iRowid = pNext->iRowid;
  171964. pNode->bEof = pNext->bEof;
  171965. pNode->bNomatch = pNext->bNomatch;
  171966. }
  171967. static int fts5ExprNodeNext_OR(
  171968. Fts5Expr *pExpr,
  171969. Fts5ExprNode *pNode,
  171970. int bFromValid,
  171971. i64 iFrom
  171972. ){
  171973. int i;
  171974. i64 iLast = pNode->iRowid;
  171975. for(i=0; i<pNode->nChild; i++){
  171976. Fts5ExprNode *p1 = pNode->apChild[i];
  171977. assert( p1->bEof || fts5RowidCmp(pExpr, p1->iRowid, iLast)>=0 );
  171978. if( p1->bEof==0 ){
  171979. if( (p1->iRowid==iLast)
  171980. || (bFromValid && fts5RowidCmp(pExpr, p1->iRowid, iFrom)<0)
  171981. ){
  171982. int rc = fts5ExprNodeNext(pExpr, p1, bFromValid, iFrom);
  171983. if( rc!=SQLITE_OK ) return rc;
  171984. }
  171985. }
  171986. }
  171987. fts5ExprNodeTest_OR(pExpr, pNode);
  171988. return SQLITE_OK;
  171989. }
  171990. /*
  171991. ** Argument pNode is an FTS5_AND node.
  171992. */
  171993. static int fts5ExprNodeTest_AND(
  171994. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  171995. Fts5ExprNode *pAnd /* FTS5_AND node to advance */
  171996. ){
  171997. int iChild;
  171998. i64 iLast = pAnd->iRowid;
  171999. int rc = SQLITE_OK;
  172000. int bMatch;
  172001. assert( pAnd->bEof==0 );
  172002. do {
  172003. pAnd->bNomatch = 0;
  172004. bMatch = 1;
  172005. for(iChild=0; iChild<pAnd->nChild; iChild++){
  172006. Fts5ExprNode *pChild = pAnd->apChild[iChild];
  172007. int cmp = fts5RowidCmp(pExpr, iLast, pChild->iRowid);
  172008. if( cmp>0 ){
  172009. /* Advance pChild until it points to iLast or laster */
  172010. rc = fts5ExprNodeNext(pExpr, pChild, 1, iLast);
  172011. if( rc!=SQLITE_OK ) return rc;
  172012. }
  172013. /* If the child node is now at EOF, so is the parent AND node. Otherwise,
  172014. ** the child node is guaranteed to have advanced at least as far as
  172015. ** rowid iLast. So if it is not at exactly iLast, pChild->iRowid is the
  172016. ** new lastest rowid seen so far. */
  172017. assert( pChild->bEof || fts5RowidCmp(pExpr, iLast, pChild->iRowid)<=0 );
  172018. if( pChild->bEof ){
  172019. fts5ExprSetEof(pAnd);
  172020. bMatch = 1;
  172021. break;
  172022. }else if( iLast!=pChild->iRowid ){
  172023. bMatch = 0;
  172024. iLast = pChild->iRowid;
  172025. }
  172026. if( pChild->bNomatch ){
  172027. pAnd->bNomatch = 1;
  172028. }
  172029. }
  172030. }while( bMatch==0 );
  172031. if( pAnd->bNomatch && pAnd!=pExpr->pRoot ){
  172032. fts5ExprNodeZeroPoslist(pAnd);
  172033. }
  172034. pAnd->iRowid = iLast;
  172035. return SQLITE_OK;
  172036. }
  172037. static int fts5ExprNodeNext_AND(
  172038. Fts5Expr *pExpr,
  172039. Fts5ExprNode *pNode,
  172040. int bFromValid,
  172041. i64 iFrom
  172042. ){
  172043. int rc = fts5ExprNodeNext(pExpr, pNode->apChild[0], bFromValid, iFrom);
  172044. if( rc==SQLITE_OK ){
  172045. rc = fts5ExprNodeTest_AND(pExpr, pNode);
  172046. }
  172047. return rc;
  172048. }
  172049. static int fts5ExprNodeTest_NOT(
  172050. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  172051. Fts5ExprNode *pNode /* FTS5_NOT node to advance */
  172052. ){
  172053. int rc = SQLITE_OK;
  172054. Fts5ExprNode *p1 = pNode->apChild[0];
  172055. Fts5ExprNode *p2 = pNode->apChild[1];
  172056. assert( pNode->nChild==2 );
  172057. while( rc==SQLITE_OK && p1->bEof==0 ){
  172058. int cmp = fts5NodeCompare(pExpr, p1, p2);
  172059. if( cmp>0 ){
  172060. rc = fts5ExprNodeNext(pExpr, p2, 1, p1->iRowid);
  172061. cmp = fts5NodeCompare(pExpr, p1, p2);
  172062. }
  172063. assert( rc!=SQLITE_OK || cmp<=0 );
  172064. if( cmp || p2->bNomatch ) break;
  172065. rc = fts5ExprNodeNext(pExpr, p1, 0, 0);
  172066. }
  172067. pNode->bEof = p1->bEof;
  172068. pNode->bNomatch = p1->bNomatch;
  172069. pNode->iRowid = p1->iRowid;
  172070. if( p1->bEof ){
  172071. fts5ExprNodeZeroPoslist(p2);
  172072. }
  172073. return rc;
  172074. }
  172075. static int fts5ExprNodeNext_NOT(
  172076. Fts5Expr *pExpr,
  172077. Fts5ExprNode *pNode,
  172078. int bFromValid,
  172079. i64 iFrom
  172080. ){
  172081. int rc = fts5ExprNodeNext(pExpr, pNode->apChild[0], bFromValid, iFrom);
  172082. if( rc==SQLITE_OK ){
  172083. rc = fts5ExprNodeTest_NOT(pExpr, pNode);
  172084. }
  172085. return rc;
  172086. }
  172087. /*
  172088. ** If pNode currently points to a match, this function returns SQLITE_OK
  172089. ** without modifying it. Otherwise, pNode is advanced until it does point
  172090. ** to a match or EOF is reached.
  172091. */
  172092. static int fts5ExprNodeTest(
  172093. Fts5Expr *pExpr, /* Expression of which pNode is a part */
  172094. Fts5ExprNode *pNode /* Expression node to test */
  172095. ){
  172096. int rc = SQLITE_OK;
  172097. if( pNode->bEof==0 ){
  172098. switch( pNode->eType ){
  172099. case FTS5_STRING: {
  172100. rc = fts5ExprNodeTest_STRING(pExpr, pNode);
  172101. break;
  172102. }
  172103. case FTS5_TERM: {
  172104. rc = fts5ExprNodeTest_TERM(pExpr, pNode);
  172105. break;
  172106. }
  172107. case FTS5_AND: {
  172108. rc = fts5ExprNodeTest_AND(pExpr, pNode);
  172109. break;
  172110. }
  172111. case FTS5_OR: {
  172112. fts5ExprNodeTest_OR(pExpr, pNode);
  172113. break;
  172114. }
  172115. default: assert( pNode->eType==FTS5_NOT ); {
  172116. rc = fts5ExprNodeTest_NOT(pExpr, pNode);
  172117. break;
  172118. }
  172119. }
  172120. }
  172121. return rc;
  172122. }
  172123. /*
  172124. ** Set node pNode, which is part of expression pExpr, to point to the first
  172125. ** match. If there are no matches, set the Node.bEof flag to indicate EOF.
  172126. **
  172127. ** Return an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  172128. ** It is not an error if there are no matches.
  172129. */
  172130. static int fts5ExprNodeFirst(Fts5Expr *pExpr, Fts5ExprNode *pNode){
  172131. int rc = SQLITE_OK;
  172132. pNode->bEof = 0;
  172133. pNode->bNomatch = 0;
  172134. if( Fts5NodeIsString(pNode) ){
  172135. /* Initialize all term iterators in the NEAR object. */
  172136. rc = fts5ExprNearInitAll(pExpr, pNode);
  172137. }else if( pNode->xNext==0 ){
  172138. pNode->bEof = 1;
  172139. }else{
  172140. int i;
  172141. int nEof = 0;
  172142. for(i=0; i<pNode->nChild && rc==SQLITE_OK; i++){
  172143. Fts5ExprNode *pChild = pNode->apChild[i];
  172144. rc = fts5ExprNodeFirst(pExpr, pNode->apChild[i]);
  172145. assert( pChild->bEof==0 || pChild->bEof==1 );
  172146. nEof += pChild->bEof;
  172147. }
  172148. pNode->iRowid = pNode->apChild[0]->iRowid;
  172149. switch( pNode->eType ){
  172150. case FTS5_AND:
  172151. if( nEof>0 ) fts5ExprSetEof(pNode);
  172152. break;
  172153. case FTS5_OR:
  172154. if( pNode->nChild==nEof ) fts5ExprSetEof(pNode);
  172155. break;
  172156. default:
  172157. assert( pNode->eType==FTS5_NOT );
  172158. pNode->bEof = pNode->apChild[0]->bEof;
  172159. break;
  172160. }
  172161. }
  172162. if( rc==SQLITE_OK ){
  172163. rc = fts5ExprNodeTest(pExpr, pNode);
  172164. }
  172165. return rc;
  172166. }
  172167. /*
  172168. ** Begin iterating through the set of documents in index pIdx matched by
  172169. ** the MATCH expression passed as the first argument. If the "bDesc"
  172170. ** parameter is passed a non-zero value, iteration is in descending rowid
  172171. ** order. Or, if it is zero, in ascending order.
  172172. **
  172173. ** If iterating in ascending rowid order (bDesc==0), the first document
  172174. ** visited is that with the smallest rowid that is larger than or equal
  172175. ** to parameter iFirst. Or, if iterating in ascending order (bDesc==1),
  172176. ** then the first document visited must have a rowid smaller than or
  172177. ** equal to iFirst.
  172178. **
  172179. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. It
  172180. ** is not considered an error if the query does not match any documents.
  172181. */
  172182. static int sqlite3Fts5ExprFirst(Fts5Expr *p, Fts5Index *pIdx, i64 iFirst, int bDesc){
  172183. Fts5ExprNode *pRoot = p->pRoot;
  172184. int rc; /* Return code */
  172185. p->pIndex = pIdx;
  172186. p->bDesc = bDesc;
  172187. rc = fts5ExprNodeFirst(p, pRoot);
  172188. /* If not at EOF but the current rowid occurs earlier than iFirst in
  172189. ** the iteration order, move to document iFirst or later. */
  172190. if( pRoot->bEof==0 && fts5RowidCmp(p, pRoot->iRowid, iFirst)<0 ){
  172191. rc = fts5ExprNodeNext(p, pRoot, 1, iFirst);
  172192. }
  172193. /* If the iterator is not at a real match, skip forward until it is. */
  172194. while( pRoot->bNomatch ){
  172195. assert( pRoot->bEof==0 && rc==SQLITE_OK );
  172196. rc = fts5ExprNodeNext(p, pRoot, 0, 0);
  172197. }
  172198. return rc;
  172199. }
  172200. /*
  172201. ** Move to the next document
  172202. **
  172203. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. It
  172204. ** is not considered an error if the query does not match any documents.
  172205. */
  172206. static int sqlite3Fts5ExprNext(Fts5Expr *p, i64 iLast){
  172207. int rc;
  172208. Fts5ExprNode *pRoot = p->pRoot;
  172209. assert( pRoot->bEof==0 && pRoot->bNomatch==0 );
  172210. do {
  172211. rc = fts5ExprNodeNext(p, pRoot, 0, 0);
  172212. assert( pRoot->bNomatch==0 || (rc==SQLITE_OK && pRoot->bEof==0) );
  172213. }while( pRoot->bNomatch );
  172214. if( fts5RowidCmp(p, pRoot->iRowid, iLast)>0 ){
  172215. pRoot->bEof = 1;
  172216. }
  172217. return rc;
  172218. }
  172219. static int sqlite3Fts5ExprEof(Fts5Expr *p){
  172220. return p->pRoot->bEof;
  172221. }
  172222. static i64 sqlite3Fts5ExprRowid(Fts5Expr *p){
  172223. return p->pRoot->iRowid;
  172224. }
  172225. static int fts5ParseStringFromToken(Fts5Token *pToken, char **pz){
  172226. int rc = SQLITE_OK;
  172227. *pz = sqlite3Fts5Strndup(&rc, pToken->p, pToken->n);
  172228. return rc;
  172229. }
  172230. /*
  172231. ** Free the phrase object passed as the only argument.
  172232. */
  172233. static void fts5ExprPhraseFree(Fts5ExprPhrase *pPhrase){
  172234. if( pPhrase ){
  172235. int i;
  172236. for(i=0; i<pPhrase->nTerm; i++){
  172237. Fts5ExprTerm *pSyn;
  172238. Fts5ExprTerm *pNext;
  172239. Fts5ExprTerm *pTerm = &pPhrase->aTerm[i];
  172240. sqlite3_free(pTerm->zTerm);
  172241. sqlite3Fts5IterClose(pTerm->pIter);
  172242. for(pSyn=pTerm->pSynonym; pSyn; pSyn=pNext){
  172243. pNext = pSyn->pSynonym;
  172244. sqlite3Fts5IterClose(pSyn->pIter);
  172245. fts5BufferFree((Fts5Buffer*)&pSyn[1]);
  172246. sqlite3_free(pSyn);
  172247. }
  172248. }
  172249. if( pPhrase->poslist.nSpace>0 ) fts5BufferFree(&pPhrase->poslist);
  172250. sqlite3_free(pPhrase);
  172251. }
  172252. }
  172253. /*
  172254. ** If argument pNear is NULL, then a new Fts5ExprNearset object is allocated
  172255. ** and populated with pPhrase. Or, if pNear is not NULL, phrase pPhrase is
  172256. ** appended to it and the results returned.
  172257. **
  172258. ** If an OOM error occurs, both the pNear and pPhrase objects are freed and
  172259. ** NULL returned.
  172260. */
  172261. static Fts5ExprNearset *sqlite3Fts5ParseNearset(
  172262. Fts5Parse *pParse, /* Parse context */
  172263. Fts5ExprNearset *pNear, /* Existing nearset, or NULL */
  172264. Fts5ExprPhrase *pPhrase /* Recently parsed phrase */
  172265. ){
  172266. const int SZALLOC = 8;
  172267. Fts5ExprNearset *pRet = 0;
  172268. if( pParse->rc==SQLITE_OK ){
  172269. if( pPhrase==0 ){
  172270. return pNear;
  172271. }
  172272. if( pNear==0 ){
  172273. int nByte = sizeof(Fts5ExprNearset) + SZALLOC * sizeof(Fts5ExprPhrase*);
  172274. pRet = sqlite3_malloc(nByte);
  172275. if( pRet==0 ){
  172276. pParse->rc = SQLITE_NOMEM;
  172277. }else{
  172278. memset(pRet, 0, nByte);
  172279. }
  172280. }else if( (pNear->nPhrase % SZALLOC)==0 ){
  172281. int nNew = pNear->nPhrase + SZALLOC;
  172282. int nByte = sizeof(Fts5ExprNearset) + nNew * sizeof(Fts5ExprPhrase*);
  172283. pRet = (Fts5ExprNearset*)sqlite3_realloc(pNear, nByte);
  172284. if( pRet==0 ){
  172285. pParse->rc = SQLITE_NOMEM;
  172286. }
  172287. }else{
  172288. pRet = pNear;
  172289. }
  172290. }
  172291. if( pRet==0 ){
  172292. assert( pParse->rc!=SQLITE_OK );
  172293. sqlite3Fts5ParseNearsetFree(pNear);
  172294. sqlite3Fts5ParsePhraseFree(pPhrase);
  172295. }else{
  172296. if( pRet->nPhrase>0 ){
  172297. Fts5ExprPhrase *pLast = pRet->apPhrase[pRet->nPhrase-1];
  172298. assert( pLast==pParse->apPhrase[pParse->nPhrase-2] );
  172299. if( pPhrase->nTerm==0 ){
  172300. fts5ExprPhraseFree(pPhrase);
  172301. pRet->nPhrase--;
  172302. pParse->nPhrase--;
  172303. pPhrase = pLast;
  172304. }else if( pLast->nTerm==0 ){
  172305. fts5ExprPhraseFree(pLast);
  172306. pParse->apPhrase[pParse->nPhrase-2] = pPhrase;
  172307. pParse->nPhrase--;
  172308. pRet->nPhrase--;
  172309. }
  172310. }
  172311. pRet->apPhrase[pRet->nPhrase++] = pPhrase;
  172312. }
  172313. return pRet;
  172314. }
  172315. typedef struct TokenCtx TokenCtx;
  172316. struct TokenCtx {
  172317. Fts5ExprPhrase *pPhrase;
  172318. int rc;
  172319. };
  172320. /*
  172321. ** Callback for tokenizing terms used by ParseTerm().
  172322. */
  172323. static int fts5ParseTokenize(
  172324. void *pContext, /* Pointer to Fts5InsertCtx object */
  172325. int tflags, /* Mask of FTS5_TOKEN_* flags */
  172326. const char *pToken, /* Buffer containing token */
  172327. int nToken, /* Size of token in bytes */
  172328. int iUnused1, /* Start offset of token */
  172329. int iUnused2 /* End offset of token */
  172330. ){
  172331. int rc = SQLITE_OK;
  172332. const int SZALLOC = 8;
  172333. TokenCtx *pCtx = (TokenCtx*)pContext;
  172334. Fts5ExprPhrase *pPhrase = pCtx->pPhrase;
  172335. UNUSED_PARAM2(iUnused1, iUnused2);
  172336. /* If an error has already occurred, this is a no-op */
  172337. if( pCtx->rc!=SQLITE_OK ) return pCtx->rc;
  172338. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  172339. if( pPhrase && pPhrase->nTerm>0 && (tflags & FTS5_TOKEN_COLOCATED) ){
  172340. Fts5ExprTerm *pSyn;
  172341. int nByte = sizeof(Fts5ExprTerm) + sizeof(Fts5Buffer) + nToken+1;
  172342. pSyn = (Fts5ExprTerm*)sqlite3_malloc(nByte);
  172343. if( pSyn==0 ){
  172344. rc = SQLITE_NOMEM;
  172345. }else{
  172346. memset(pSyn, 0, nByte);
  172347. pSyn->zTerm = ((char*)pSyn) + sizeof(Fts5ExprTerm) + sizeof(Fts5Buffer);
  172348. memcpy(pSyn->zTerm, pToken, nToken);
  172349. pSyn->pSynonym = pPhrase->aTerm[pPhrase->nTerm-1].pSynonym;
  172350. pPhrase->aTerm[pPhrase->nTerm-1].pSynonym = pSyn;
  172351. }
  172352. }else{
  172353. Fts5ExprTerm *pTerm;
  172354. if( pPhrase==0 || (pPhrase->nTerm % SZALLOC)==0 ){
  172355. Fts5ExprPhrase *pNew;
  172356. int nNew = SZALLOC + (pPhrase ? pPhrase->nTerm : 0);
  172357. pNew = (Fts5ExprPhrase*)sqlite3_realloc(pPhrase,
  172358. sizeof(Fts5ExprPhrase) + sizeof(Fts5ExprTerm) * nNew
  172359. );
  172360. if( pNew==0 ){
  172361. rc = SQLITE_NOMEM;
  172362. }else{
  172363. if( pPhrase==0 ) memset(pNew, 0, sizeof(Fts5ExprPhrase));
  172364. pCtx->pPhrase = pPhrase = pNew;
  172365. pNew->nTerm = nNew - SZALLOC;
  172366. }
  172367. }
  172368. if( rc==SQLITE_OK ){
  172369. pTerm = &pPhrase->aTerm[pPhrase->nTerm++];
  172370. memset(pTerm, 0, sizeof(Fts5ExprTerm));
  172371. pTerm->zTerm = sqlite3Fts5Strndup(&rc, pToken, nToken);
  172372. }
  172373. }
  172374. pCtx->rc = rc;
  172375. return rc;
  172376. }
  172377. /*
  172378. ** Free the phrase object passed as the only argument.
  172379. */
  172380. static void sqlite3Fts5ParsePhraseFree(Fts5ExprPhrase *pPhrase){
  172381. fts5ExprPhraseFree(pPhrase);
  172382. }
  172383. /*
  172384. ** Free the phrase object passed as the second argument.
  172385. */
  172386. static void sqlite3Fts5ParseNearsetFree(Fts5ExprNearset *pNear){
  172387. if( pNear ){
  172388. int i;
  172389. for(i=0; i<pNear->nPhrase; i++){
  172390. fts5ExprPhraseFree(pNear->apPhrase[i]);
  172391. }
  172392. sqlite3_free(pNear->pColset);
  172393. sqlite3_free(pNear);
  172394. }
  172395. }
  172396. static void sqlite3Fts5ParseFinished(Fts5Parse *pParse, Fts5ExprNode *p){
  172397. assert( pParse->pExpr==0 );
  172398. pParse->pExpr = p;
  172399. }
  172400. /*
  172401. ** This function is called by the parser to process a string token. The
  172402. ** string may or may not be quoted. In any case it is tokenized and a
  172403. ** phrase object consisting of all tokens returned.
  172404. */
  172405. static Fts5ExprPhrase *sqlite3Fts5ParseTerm(
  172406. Fts5Parse *pParse, /* Parse context */
  172407. Fts5ExprPhrase *pAppend, /* Phrase to append to */
  172408. Fts5Token *pToken, /* String to tokenize */
  172409. int bPrefix /* True if there is a trailing "*" */
  172410. ){
  172411. Fts5Config *pConfig = pParse->pConfig;
  172412. TokenCtx sCtx; /* Context object passed to callback */
  172413. int rc; /* Tokenize return code */
  172414. char *z = 0;
  172415. memset(&sCtx, 0, sizeof(TokenCtx));
  172416. sCtx.pPhrase = pAppend;
  172417. rc = fts5ParseStringFromToken(pToken, &z);
  172418. if( rc==SQLITE_OK ){
  172419. int flags = FTS5_TOKENIZE_QUERY | (bPrefix ? FTS5_TOKENIZE_QUERY : 0);
  172420. int n;
  172421. sqlite3Fts5Dequote(z);
  172422. n = (int)strlen(z);
  172423. rc = sqlite3Fts5Tokenize(pConfig, flags, z, n, &sCtx, fts5ParseTokenize);
  172424. }
  172425. sqlite3_free(z);
  172426. if( rc || (rc = sCtx.rc) ){
  172427. pParse->rc = rc;
  172428. fts5ExprPhraseFree(sCtx.pPhrase);
  172429. sCtx.pPhrase = 0;
  172430. }else{
  172431. if( pAppend==0 ){
  172432. if( (pParse->nPhrase % 8)==0 ){
  172433. int nByte = sizeof(Fts5ExprPhrase*) * (pParse->nPhrase + 8);
  172434. Fts5ExprPhrase **apNew;
  172435. apNew = (Fts5ExprPhrase**)sqlite3_realloc(pParse->apPhrase, nByte);
  172436. if( apNew==0 ){
  172437. pParse->rc = SQLITE_NOMEM;
  172438. fts5ExprPhraseFree(sCtx.pPhrase);
  172439. return 0;
  172440. }
  172441. pParse->apPhrase = apNew;
  172442. }
  172443. pParse->nPhrase++;
  172444. }
  172445. if( sCtx.pPhrase==0 ){
  172446. /* This happens when parsing a token or quoted phrase that contains
  172447. ** no token characters at all. (e.g ... MATCH '""'). */
  172448. sCtx.pPhrase = sqlite3Fts5MallocZero(&pParse->rc, sizeof(Fts5ExprPhrase));
  172449. }else if( sCtx.pPhrase->nTerm ){
  172450. sCtx.pPhrase->aTerm[sCtx.pPhrase->nTerm-1].bPrefix = bPrefix;
  172451. }
  172452. pParse->apPhrase[pParse->nPhrase-1] = sCtx.pPhrase;
  172453. }
  172454. return sCtx.pPhrase;
  172455. }
  172456. /*
  172457. ** Create a new FTS5 expression by cloning phrase iPhrase of the
  172458. ** expression passed as the second argument.
  172459. */
  172460. static int sqlite3Fts5ExprClonePhrase(
  172461. Fts5Expr *pExpr,
  172462. int iPhrase,
  172463. Fts5Expr **ppNew
  172464. ){
  172465. int rc = SQLITE_OK; /* Return code */
  172466. Fts5ExprPhrase *pOrig; /* The phrase extracted from pExpr */
  172467. Fts5Expr *pNew = 0; /* Expression to return via *ppNew */
  172468. TokenCtx sCtx = {0,0}; /* Context object for fts5ParseTokenize */
  172469. pOrig = pExpr->apExprPhrase[iPhrase];
  172470. pNew = (Fts5Expr*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Expr));
  172471. if( rc==SQLITE_OK ){
  172472. pNew->apExprPhrase = (Fts5ExprPhrase**)sqlite3Fts5MallocZero(&rc,
  172473. sizeof(Fts5ExprPhrase*));
  172474. }
  172475. if( rc==SQLITE_OK ){
  172476. pNew->pRoot = (Fts5ExprNode*)sqlite3Fts5MallocZero(&rc,
  172477. sizeof(Fts5ExprNode));
  172478. }
  172479. if( rc==SQLITE_OK ){
  172480. pNew->pRoot->pNear = (Fts5ExprNearset*)sqlite3Fts5MallocZero(&rc,
  172481. sizeof(Fts5ExprNearset) + sizeof(Fts5ExprPhrase*));
  172482. }
  172483. if( rc==SQLITE_OK ){
  172484. Fts5Colset *pColsetOrig = pOrig->pNode->pNear->pColset;
  172485. if( pColsetOrig ){
  172486. int nByte = sizeof(Fts5Colset) + (pColsetOrig->nCol-1) * sizeof(int);
  172487. Fts5Colset *pColset = (Fts5Colset*)sqlite3Fts5MallocZero(&rc, nByte);
  172488. if( pColset ){
  172489. memcpy(pColset, pColsetOrig, nByte);
  172490. }
  172491. pNew->pRoot->pNear->pColset = pColset;
  172492. }
  172493. }
  172494. if( pOrig->nTerm ){
  172495. int i; /* Used to iterate through phrase terms */
  172496. for(i=0; rc==SQLITE_OK && i<pOrig->nTerm; i++){
  172497. int tflags = 0;
  172498. Fts5ExprTerm *p;
  172499. for(p=&pOrig->aTerm[i]; p && rc==SQLITE_OK; p=p->pSynonym){
  172500. const char *zTerm = p->zTerm;
  172501. rc = fts5ParseTokenize((void*)&sCtx, tflags, zTerm, (int)strlen(zTerm),
  172502. 0, 0);
  172503. tflags = FTS5_TOKEN_COLOCATED;
  172504. }
  172505. if( rc==SQLITE_OK ){
  172506. sCtx.pPhrase->aTerm[i].bPrefix = pOrig->aTerm[i].bPrefix;
  172507. }
  172508. }
  172509. }else{
  172510. /* This happens when parsing a token or quoted phrase that contains
  172511. ** no token characters at all. (e.g ... MATCH '""'). */
  172512. sCtx.pPhrase = sqlite3Fts5MallocZero(&rc, sizeof(Fts5ExprPhrase));
  172513. }
  172514. if( rc==SQLITE_OK ){
  172515. /* All the allocations succeeded. Put the expression object together. */
  172516. pNew->pIndex = pExpr->pIndex;
  172517. pNew->pConfig = pExpr->pConfig;
  172518. pNew->nPhrase = 1;
  172519. pNew->apExprPhrase[0] = sCtx.pPhrase;
  172520. pNew->pRoot->pNear->apPhrase[0] = sCtx.pPhrase;
  172521. pNew->pRoot->pNear->nPhrase = 1;
  172522. sCtx.pPhrase->pNode = pNew->pRoot;
  172523. if( pOrig->nTerm==1 && pOrig->aTerm[0].pSynonym==0 ){
  172524. pNew->pRoot->eType = FTS5_TERM;
  172525. pNew->pRoot->xNext = fts5ExprNodeNext_TERM;
  172526. }else{
  172527. pNew->pRoot->eType = FTS5_STRING;
  172528. pNew->pRoot->xNext = fts5ExprNodeNext_STRING;
  172529. }
  172530. }else{
  172531. sqlite3Fts5ExprFree(pNew);
  172532. fts5ExprPhraseFree(sCtx.pPhrase);
  172533. pNew = 0;
  172534. }
  172535. *ppNew = pNew;
  172536. return rc;
  172537. }
  172538. /*
  172539. ** Token pTok has appeared in a MATCH expression where the NEAR operator
  172540. ** is expected. If token pTok does not contain "NEAR", store an error
  172541. ** in the pParse object.
  172542. */
  172543. static void sqlite3Fts5ParseNear(Fts5Parse *pParse, Fts5Token *pTok){
  172544. if( pTok->n!=4 || memcmp("NEAR", pTok->p, 4) ){
  172545. sqlite3Fts5ParseError(
  172546. pParse, "fts5: syntax error near \"%.*s\"", pTok->n, pTok->p
  172547. );
  172548. }
  172549. }
  172550. static void sqlite3Fts5ParseSetDistance(
  172551. Fts5Parse *pParse,
  172552. Fts5ExprNearset *pNear,
  172553. Fts5Token *p
  172554. ){
  172555. if( pNear ){
  172556. int nNear = 0;
  172557. int i;
  172558. if( p->n ){
  172559. for(i=0; i<p->n; i++){
  172560. char c = (char)p->p[i];
  172561. if( c<'0' || c>'9' ){
  172562. sqlite3Fts5ParseError(
  172563. pParse, "expected integer, got \"%.*s\"", p->n, p->p
  172564. );
  172565. return;
  172566. }
  172567. nNear = nNear * 10 + (p->p[i] - '0');
  172568. }
  172569. }else{
  172570. nNear = FTS5_DEFAULT_NEARDIST;
  172571. }
  172572. pNear->nNear = nNear;
  172573. }
  172574. }
  172575. /*
  172576. ** The second argument passed to this function may be NULL, or it may be
  172577. ** an existing Fts5Colset object. This function returns a pointer to
  172578. ** a new colset object containing the contents of (p) with new value column
  172579. ** number iCol appended.
  172580. **
  172581. ** If an OOM error occurs, store an error code in pParse and return NULL.
  172582. ** The old colset object (if any) is not freed in this case.
  172583. */
  172584. static Fts5Colset *fts5ParseColset(
  172585. Fts5Parse *pParse, /* Store SQLITE_NOMEM here if required */
  172586. Fts5Colset *p, /* Existing colset object */
  172587. int iCol /* New column to add to colset object */
  172588. ){
  172589. int nCol = p ? p->nCol : 0; /* Num. columns already in colset object */
  172590. Fts5Colset *pNew; /* New colset object to return */
  172591. assert( pParse->rc==SQLITE_OK );
  172592. assert( iCol>=0 && iCol<pParse->pConfig->nCol );
  172593. pNew = sqlite3_realloc(p, sizeof(Fts5Colset) + sizeof(int)*nCol);
  172594. if( pNew==0 ){
  172595. pParse->rc = SQLITE_NOMEM;
  172596. }else{
  172597. int *aiCol = pNew->aiCol;
  172598. int i, j;
  172599. for(i=0; i<nCol; i++){
  172600. if( aiCol[i]==iCol ) return pNew;
  172601. if( aiCol[i]>iCol ) break;
  172602. }
  172603. for(j=nCol; j>i; j--){
  172604. aiCol[j] = aiCol[j-1];
  172605. }
  172606. aiCol[i] = iCol;
  172607. pNew->nCol = nCol+1;
  172608. #ifndef NDEBUG
  172609. /* Check that the array is in order and contains no duplicate entries. */
  172610. for(i=1; i<pNew->nCol; i++) assert( pNew->aiCol[i]>pNew->aiCol[i-1] );
  172611. #endif
  172612. }
  172613. return pNew;
  172614. }
  172615. /*
  172616. ** Allocate and return an Fts5Colset object specifying the inverse of
  172617. ** the colset passed as the second argument. Free the colset passed
  172618. ** as the second argument before returning.
  172619. */
  172620. static Fts5Colset *sqlite3Fts5ParseColsetInvert(Fts5Parse *pParse, Fts5Colset *p){
  172621. Fts5Colset *pRet;
  172622. int nCol = pParse->pConfig->nCol;
  172623. pRet = (Fts5Colset*)sqlite3Fts5MallocZero(&pParse->rc,
  172624. sizeof(Fts5Colset) + sizeof(int)*nCol
  172625. );
  172626. if( pRet ){
  172627. int i;
  172628. int iOld = 0;
  172629. for(i=0; i<nCol; i++){
  172630. if( iOld>=p->nCol || p->aiCol[iOld]!=i ){
  172631. pRet->aiCol[pRet->nCol++] = i;
  172632. }else{
  172633. iOld++;
  172634. }
  172635. }
  172636. }
  172637. sqlite3_free(p);
  172638. return pRet;
  172639. }
  172640. static Fts5Colset *sqlite3Fts5ParseColset(
  172641. Fts5Parse *pParse, /* Store SQLITE_NOMEM here if required */
  172642. Fts5Colset *pColset, /* Existing colset object */
  172643. Fts5Token *p
  172644. ){
  172645. Fts5Colset *pRet = 0;
  172646. int iCol;
  172647. char *z; /* Dequoted copy of token p */
  172648. z = sqlite3Fts5Strndup(&pParse->rc, p->p, p->n);
  172649. if( pParse->rc==SQLITE_OK ){
  172650. Fts5Config *pConfig = pParse->pConfig;
  172651. sqlite3Fts5Dequote(z);
  172652. for(iCol=0; iCol<pConfig->nCol; iCol++){
  172653. if( 0==sqlite3_stricmp(pConfig->azCol[iCol], z) ) break;
  172654. }
  172655. if( iCol==pConfig->nCol ){
  172656. sqlite3Fts5ParseError(pParse, "no such column: %s", z);
  172657. }else{
  172658. pRet = fts5ParseColset(pParse, pColset, iCol);
  172659. }
  172660. sqlite3_free(z);
  172661. }
  172662. if( pRet==0 ){
  172663. assert( pParse->rc!=SQLITE_OK );
  172664. sqlite3_free(pColset);
  172665. }
  172666. return pRet;
  172667. }
  172668. static void sqlite3Fts5ParseSetColset(
  172669. Fts5Parse *pParse,
  172670. Fts5ExprNearset *pNear,
  172671. Fts5Colset *pColset
  172672. ){
  172673. if( pParse->pConfig->eDetail==FTS5_DETAIL_NONE ){
  172674. pParse->rc = SQLITE_ERROR;
  172675. pParse->zErr = sqlite3_mprintf(
  172676. "fts5: column queries are not supported (detail=none)"
  172677. );
  172678. sqlite3_free(pColset);
  172679. return;
  172680. }
  172681. if( pNear ){
  172682. pNear->pColset = pColset;
  172683. }else{
  172684. sqlite3_free(pColset);
  172685. }
  172686. }
  172687. static void fts5ExprAssignXNext(Fts5ExprNode *pNode){
  172688. switch( pNode->eType ){
  172689. case FTS5_STRING: {
  172690. Fts5ExprNearset *pNear = pNode->pNear;
  172691. if( pNear->nPhrase==1 && pNear->apPhrase[0]->nTerm==1
  172692. && pNear->apPhrase[0]->aTerm[0].pSynonym==0
  172693. ){
  172694. pNode->eType = FTS5_TERM;
  172695. pNode->xNext = fts5ExprNodeNext_TERM;
  172696. }else{
  172697. pNode->xNext = fts5ExprNodeNext_STRING;
  172698. }
  172699. break;
  172700. };
  172701. case FTS5_OR: {
  172702. pNode->xNext = fts5ExprNodeNext_OR;
  172703. break;
  172704. };
  172705. case FTS5_AND: {
  172706. pNode->xNext = fts5ExprNodeNext_AND;
  172707. break;
  172708. };
  172709. default: assert( pNode->eType==FTS5_NOT ); {
  172710. pNode->xNext = fts5ExprNodeNext_NOT;
  172711. break;
  172712. };
  172713. }
  172714. }
  172715. static void fts5ExprAddChildren(Fts5ExprNode *p, Fts5ExprNode *pSub){
  172716. if( p->eType!=FTS5_NOT && pSub->eType==p->eType ){
  172717. int nByte = sizeof(Fts5ExprNode*) * pSub->nChild;
  172718. memcpy(&p->apChild[p->nChild], pSub->apChild, nByte);
  172719. p->nChild += pSub->nChild;
  172720. sqlite3_free(pSub);
  172721. }else{
  172722. p->apChild[p->nChild++] = pSub;
  172723. }
  172724. }
  172725. /*
  172726. ** Allocate and return a new expression object. If anything goes wrong (i.e.
  172727. ** OOM error), leave an error code in pParse and return NULL.
  172728. */
  172729. static Fts5ExprNode *sqlite3Fts5ParseNode(
  172730. Fts5Parse *pParse, /* Parse context */
  172731. int eType, /* FTS5_STRING, AND, OR or NOT */
  172732. Fts5ExprNode *pLeft, /* Left hand child expression */
  172733. Fts5ExprNode *pRight, /* Right hand child expression */
  172734. Fts5ExprNearset *pNear /* For STRING expressions, the near cluster */
  172735. ){
  172736. Fts5ExprNode *pRet = 0;
  172737. if( pParse->rc==SQLITE_OK ){
  172738. int nChild = 0; /* Number of children of returned node */
  172739. int nByte; /* Bytes of space to allocate for this node */
  172740. assert( (eType!=FTS5_STRING && !pNear)
  172741. || (eType==FTS5_STRING && !pLeft && !pRight)
  172742. );
  172743. if( eType==FTS5_STRING && pNear==0 ) return 0;
  172744. if( eType!=FTS5_STRING && pLeft==0 ) return pRight;
  172745. if( eType!=FTS5_STRING && pRight==0 ) return pLeft;
  172746. if( eType==FTS5_NOT ){
  172747. nChild = 2;
  172748. }else if( eType==FTS5_AND || eType==FTS5_OR ){
  172749. nChild = 2;
  172750. if( pLeft->eType==eType ) nChild += pLeft->nChild-1;
  172751. if( pRight->eType==eType ) nChild += pRight->nChild-1;
  172752. }
  172753. nByte = sizeof(Fts5ExprNode) + sizeof(Fts5ExprNode*)*(nChild-1);
  172754. pRet = (Fts5ExprNode*)sqlite3Fts5MallocZero(&pParse->rc, nByte);
  172755. if( pRet ){
  172756. pRet->eType = eType;
  172757. pRet->pNear = pNear;
  172758. fts5ExprAssignXNext(pRet);
  172759. if( eType==FTS5_STRING ){
  172760. int iPhrase;
  172761. for(iPhrase=0; iPhrase<pNear->nPhrase; iPhrase++){
  172762. pNear->apPhrase[iPhrase]->pNode = pRet;
  172763. if( pNear->apPhrase[iPhrase]->nTerm==0 ){
  172764. pRet->xNext = 0;
  172765. pRet->eType = FTS5_EOF;
  172766. }
  172767. }
  172768. if( pParse->pConfig->eDetail!=FTS5_DETAIL_FULL
  172769. && (pNear->nPhrase!=1 || pNear->apPhrase[0]->nTerm>1)
  172770. ){
  172771. assert( pParse->rc==SQLITE_OK );
  172772. pParse->rc = SQLITE_ERROR;
  172773. assert( pParse->zErr==0 );
  172774. pParse->zErr = sqlite3_mprintf(
  172775. "fts5: %s queries are not supported (detail!=full)",
  172776. pNear->nPhrase==1 ? "phrase": "NEAR"
  172777. );
  172778. sqlite3_free(pRet);
  172779. pRet = 0;
  172780. }
  172781. }else{
  172782. fts5ExprAddChildren(pRet, pLeft);
  172783. fts5ExprAddChildren(pRet, pRight);
  172784. }
  172785. }
  172786. }
  172787. if( pRet==0 ){
  172788. assert( pParse->rc!=SQLITE_OK );
  172789. sqlite3Fts5ParseNodeFree(pLeft);
  172790. sqlite3Fts5ParseNodeFree(pRight);
  172791. sqlite3Fts5ParseNearsetFree(pNear);
  172792. }
  172793. return pRet;
  172794. }
  172795. static Fts5ExprNode *sqlite3Fts5ParseImplicitAnd(
  172796. Fts5Parse *pParse, /* Parse context */
  172797. Fts5ExprNode *pLeft, /* Left hand child expression */
  172798. Fts5ExprNode *pRight /* Right hand child expression */
  172799. ){
  172800. Fts5ExprNode *pRet = 0;
  172801. Fts5ExprNode *pPrev;
  172802. if( pParse->rc ){
  172803. sqlite3Fts5ParseNodeFree(pLeft);
  172804. sqlite3Fts5ParseNodeFree(pRight);
  172805. }else{
  172806. assert( pLeft->eType==FTS5_STRING
  172807. || pLeft->eType==FTS5_TERM
  172808. || pLeft->eType==FTS5_EOF
  172809. || pLeft->eType==FTS5_AND
  172810. );
  172811. assert( pRight->eType==FTS5_STRING
  172812. || pRight->eType==FTS5_TERM
  172813. || pRight->eType==FTS5_EOF
  172814. );
  172815. if( pLeft->eType==FTS5_AND ){
  172816. pPrev = pLeft->apChild[pLeft->nChild-1];
  172817. }else{
  172818. pPrev = pLeft;
  172819. }
  172820. assert( pPrev->eType==FTS5_STRING
  172821. || pPrev->eType==FTS5_TERM
  172822. || pPrev->eType==FTS5_EOF
  172823. );
  172824. if( pRight->eType==FTS5_EOF ){
  172825. assert( pParse->apPhrase[pParse->nPhrase-1]==pRight->pNear->apPhrase[0] );
  172826. sqlite3Fts5ParseNodeFree(pRight);
  172827. pRet = pLeft;
  172828. pParse->nPhrase--;
  172829. }
  172830. else if( pPrev->eType==FTS5_EOF ){
  172831. Fts5ExprPhrase **ap;
  172832. if( pPrev==pLeft ){
  172833. pRet = pRight;
  172834. }else{
  172835. pLeft->apChild[pLeft->nChild-1] = pRight;
  172836. pRet = pLeft;
  172837. }
  172838. ap = &pParse->apPhrase[pParse->nPhrase-1-pRight->pNear->nPhrase];
  172839. assert( ap[0]==pPrev->pNear->apPhrase[0] );
  172840. memmove(ap, &ap[1], sizeof(Fts5ExprPhrase*)*pRight->pNear->nPhrase);
  172841. pParse->nPhrase--;
  172842. sqlite3Fts5ParseNodeFree(pPrev);
  172843. }
  172844. else{
  172845. pRet = sqlite3Fts5ParseNode(pParse, FTS5_AND, pLeft, pRight, 0);
  172846. }
  172847. }
  172848. return pRet;
  172849. }
  172850. static char *fts5ExprTermPrint(Fts5ExprTerm *pTerm){
  172851. int nByte = 0;
  172852. Fts5ExprTerm *p;
  172853. char *zQuoted;
  172854. /* Determine the maximum amount of space required. */
  172855. for(p=pTerm; p; p=p->pSynonym){
  172856. nByte += (int)strlen(pTerm->zTerm) * 2 + 3 + 2;
  172857. }
  172858. zQuoted = sqlite3_malloc(nByte);
  172859. if( zQuoted ){
  172860. int i = 0;
  172861. for(p=pTerm; p; p=p->pSynonym){
  172862. char *zIn = p->zTerm;
  172863. zQuoted[i++] = '"';
  172864. while( *zIn ){
  172865. if( *zIn=='"' ) zQuoted[i++] = '"';
  172866. zQuoted[i++] = *zIn++;
  172867. }
  172868. zQuoted[i++] = '"';
  172869. if( p->pSynonym ) zQuoted[i++] = '|';
  172870. }
  172871. if( pTerm->bPrefix ){
  172872. zQuoted[i++] = ' ';
  172873. zQuoted[i++] = '*';
  172874. }
  172875. zQuoted[i++] = '\0';
  172876. }
  172877. return zQuoted;
  172878. }
  172879. static char *fts5PrintfAppend(char *zApp, const char *zFmt, ...){
  172880. char *zNew;
  172881. va_list ap;
  172882. va_start(ap, zFmt);
  172883. zNew = sqlite3_vmprintf(zFmt, ap);
  172884. va_end(ap);
  172885. if( zApp && zNew ){
  172886. char *zNew2 = sqlite3_mprintf("%s%s", zApp, zNew);
  172887. sqlite3_free(zNew);
  172888. zNew = zNew2;
  172889. }
  172890. sqlite3_free(zApp);
  172891. return zNew;
  172892. }
  172893. /*
  172894. ** Compose a tcl-readable representation of expression pExpr. Return a
  172895. ** pointer to a buffer containing that representation. It is the
  172896. ** responsibility of the caller to at some point free the buffer using
  172897. ** sqlite3_free().
  172898. */
  172899. static char *fts5ExprPrintTcl(
  172900. Fts5Config *pConfig,
  172901. const char *zNearsetCmd,
  172902. Fts5ExprNode *pExpr
  172903. ){
  172904. char *zRet = 0;
  172905. if( pExpr->eType==FTS5_STRING || pExpr->eType==FTS5_TERM ){
  172906. Fts5ExprNearset *pNear = pExpr->pNear;
  172907. int i;
  172908. int iTerm;
  172909. zRet = fts5PrintfAppend(zRet, "%s ", zNearsetCmd);
  172910. if( zRet==0 ) return 0;
  172911. if( pNear->pColset ){
  172912. int *aiCol = pNear->pColset->aiCol;
  172913. int nCol = pNear->pColset->nCol;
  172914. if( nCol==1 ){
  172915. zRet = fts5PrintfAppend(zRet, "-col %d ", aiCol[0]);
  172916. }else{
  172917. zRet = fts5PrintfAppend(zRet, "-col {%d", aiCol[0]);
  172918. for(i=1; i<pNear->pColset->nCol; i++){
  172919. zRet = fts5PrintfAppend(zRet, " %d", aiCol[i]);
  172920. }
  172921. zRet = fts5PrintfAppend(zRet, "} ");
  172922. }
  172923. if( zRet==0 ) return 0;
  172924. }
  172925. if( pNear->nPhrase>1 ){
  172926. zRet = fts5PrintfAppend(zRet, "-near %d ", pNear->nNear);
  172927. if( zRet==0 ) return 0;
  172928. }
  172929. zRet = fts5PrintfAppend(zRet, "--");
  172930. if( zRet==0 ) return 0;
  172931. for(i=0; i<pNear->nPhrase; i++){
  172932. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  172933. zRet = fts5PrintfAppend(zRet, " {");
  172934. for(iTerm=0; zRet && iTerm<pPhrase->nTerm; iTerm++){
  172935. char *zTerm = pPhrase->aTerm[iTerm].zTerm;
  172936. zRet = fts5PrintfAppend(zRet, "%s%s", iTerm==0?"":" ", zTerm);
  172937. if( pPhrase->aTerm[iTerm].bPrefix ){
  172938. zRet = fts5PrintfAppend(zRet, "*");
  172939. }
  172940. }
  172941. if( zRet ) zRet = fts5PrintfAppend(zRet, "}");
  172942. if( zRet==0 ) return 0;
  172943. }
  172944. }else{
  172945. char const *zOp = 0;
  172946. int i;
  172947. switch( pExpr->eType ){
  172948. case FTS5_AND: zOp = "AND"; break;
  172949. case FTS5_NOT: zOp = "NOT"; break;
  172950. default:
  172951. assert( pExpr->eType==FTS5_OR );
  172952. zOp = "OR";
  172953. break;
  172954. }
  172955. zRet = sqlite3_mprintf("%s", zOp);
  172956. for(i=0; zRet && i<pExpr->nChild; i++){
  172957. char *z = fts5ExprPrintTcl(pConfig, zNearsetCmd, pExpr->apChild[i]);
  172958. if( !z ){
  172959. sqlite3_free(zRet);
  172960. zRet = 0;
  172961. }else{
  172962. zRet = fts5PrintfAppend(zRet, " [%z]", z);
  172963. }
  172964. }
  172965. }
  172966. return zRet;
  172967. }
  172968. static char *fts5ExprPrint(Fts5Config *pConfig, Fts5ExprNode *pExpr){
  172969. char *zRet = 0;
  172970. if( pExpr->eType==0 ){
  172971. return sqlite3_mprintf("\"\"");
  172972. }else
  172973. if( pExpr->eType==FTS5_STRING || pExpr->eType==FTS5_TERM ){
  172974. Fts5ExprNearset *pNear = pExpr->pNear;
  172975. int i;
  172976. int iTerm;
  172977. if( pNear->pColset ){
  172978. int iCol = pNear->pColset->aiCol[0];
  172979. zRet = fts5PrintfAppend(zRet, "%s : ", pConfig->azCol[iCol]);
  172980. if( zRet==0 ) return 0;
  172981. }
  172982. if( pNear->nPhrase>1 ){
  172983. zRet = fts5PrintfAppend(zRet, "NEAR(");
  172984. if( zRet==0 ) return 0;
  172985. }
  172986. for(i=0; i<pNear->nPhrase; i++){
  172987. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  172988. if( i!=0 ){
  172989. zRet = fts5PrintfAppend(zRet, " ");
  172990. if( zRet==0 ) return 0;
  172991. }
  172992. for(iTerm=0; iTerm<pPhrase->nTerm; iTerm++){
  172993. char *zTerm = fts5ExprTermPrint(&pPhrase->aTerm[iTerm]);
  172994. if( zTerm ){
  172995. zRet = fts5PrintfAppend(zRet, "%s%s", iTerm==0?"":" + ", zTerm);
  172996. sqlite3_free(zTerm);
  172997. }
  172998. if( zTerm==0 || zRet==0 ){
  172999. sqlite3_free(zRet);
  173000. return 0;
  173001. }
  173002. }
  173003. }
  173004. if( pNear->nPhrase>1 ){
  173005. zRet = fts5PrintfAppend(zRet, ", %d)", pNear->nNear);
  173006. if( zRet==0 ) return 0;
  173007. }
  173008. }else{
  173009. char const *zOp = 0;
  173010. int i;
  173011. switch( pExpr->eType ){
  173012. case FTS5_AND: zOp = " AND "; break;
  173013. case FTS5_NOT: zOp = " NOT "; break;
  173014. default:
  173015. assert( pExpr->eType==FTS5_OR );
  173016. zOp = " OR ";
  173017. break;
  173018. }
  173019. for(i=0; i<pExpr->nChild; i++){
  173020. char *z = fts5ExprPrint(pConfig, pExpr->apChild[i]);
  173021. if( z==0 ){
  173022. sqlite3_free(zRet);
  173023. zRet = 0;
  173024. }else{
  173025. int e = pExpr->apChild[i]->eType;
  173026. int b = (e!=FTS5_STRING && e!=FTS5_TERM && e!=FTS5_EOF);
  173027. zRet = fts5PrintfAppend(zRet, "%s%s%z%s",
  173028. (i==0 ? "" : zOp),
  173029. (b?"(":""), z, (b?")":"")
  173030. );
  173031. }
  173032. if( zRet==0 ) break;
  173033. }
  173034. }
  173035. return zRet;
  173036. }
  173037. /*
  173038. ** The implementation of user-defined scalar functions fts5_expr() (bTcl==0)
  173039. ** and fts5_expr_tcl() (bTcl!=0).
  173040. */
  173041. static void fts5ExprFunction(
  173042. sqlite3_context *pCtx, /* Function call context */
  173043. int nArg, /* Number of args */
  173044. sqlite3_value **apVal, /* Function arguments */
  173045. int bTcl
  173046. ){
  173047. Fts5Global *pGlobal = (Fts5Global*)sqlite3_user_data(pCtx);
  173048. sqlite3 *db = sqlite3_context_db_handle(pCtx);
  173049. const char *zExpr = 0;
  173050. char *zErr = 0;
  173051. Fts5Expr *pExpr = 0;
  173052. int rc;
  173053. int i;
  173054. const char **azConfig; /* Array of arguments for Fts5Config */
  173055. const char *zNearsetCmd = "nearset";
  173056. int nConfig; /* Size of azConfig[] */
  173057. Fts5Config *pConfig = 0;
  173058. int iArg = 1;
  173059. if( nArg<1 ){
  173060. zErr = sqlite3_mprintf("wrong number of arguments to function %s",
  173061. bTcl ? "fts5_expr_tcl" : "fts5_expr"
  173062. );
  173063. sqlite3_result_error(pCtx, zErr, -1);
  173064. sqlite3_free(zErr);
  173065. return;
  173066. }
  173067. if( bTcl && nArg>1 ){
  173068. zNearsetCmd = (const char*)sqlite3_value_text(apVal[1]);
  173069. iArg = 2;
  173070. }
  173071. nConfig = 3 + (nArg-iArg);
  173072. azConfig = (const char**)sqlite3_malloc(sizeof(char*) * nConfig);
  173073. if( azConfig==0 ){
  173074. sqlite3_result_error_nomem(pCtx);
  173075. return;
  173076. }
  173077. azConfig[0] = 0;
  173078. azConfig[1] = "main";
  173079. azConfig[2] = "tbl";
  173080. for(i=3; iArg<nArg; iArg++){
  173081. azConfig[i++] = (const char*)sqlite3_value_text(apVal[iArg]);
  173082. }
  173083. zExpr = (const char*)sqlite3_value_text(apVal[0]);
  173084. rc = sqlite3Fts5ConfigParse(pGlobal, db, nConfig, azConfig, &pConfig, &zErr);
  173085. if( rc==SQLITE_OK ){
  173086. rc = sqlite3Fts5ExprNew(pConfig, zExpr, &pExpr, &zErr);
  173087. }
  173088. if( rc==SQLITE_OK ){
  173089. char *zText;
  173090. if( pExpr->pRoot->xNext==0 ){
  173091. zText = sqlite3_mprintf("");
  173092. }else if( bTcl ){
  173093. zText = fts5ExprPrintTcl(pConfig, zNearsetCmd, pExpr->pRoot);
  173094. }else{
  173095. zText = fts5ExprPrint(pConfig, pExpr->pRoot);
  173096. }
  173097. if( zText==0 ){
  173098. rc = SQLITE_NOMEM;
  173099. }else{
  173100. sqlite3_result_text(pCtx, zText, -1, SQLITE_TRANSIENT);
  173101. sqlite3_free(zText);
  173102. }
  173103. }
  173104. if( rc!=SQLITE_OK ){
  173105. if( zErr ){
  173106. sqlite3_result_error(pCtx, zErr, -1);
  173107. sqlite3_free(zErr);
  173108. }else{
  173109. sqlite3_result_error_code(pCtx, rc);
  173110. }
  173111. }
  173112. sqlite3_free((void *)azConfig);
  173113. sqlite3Fts5ConfigFree(pConfig);
  173114. sqlite3Fts5ExprFree(pExpr);
  173115. }
  173116. static void fts5ExprFunctionHr(
  173117. sqlite3_context *pCtx, /* Function call context */
  173118. int nArg, /* Number of args */
  173119. sqlite3_value **apVal /* Function arguments */
  173120. ){
  173121. fts5ExprFunction(pCtx, nArg, apVal, 0);
  173122. }
  173123. static void fts5ExprFunctionTcl(
  173124. sqlite3_context *pCtx, /* Function call context */
  173125. int nArg, /* Number of args */
  173126. sqlite3_value **apVal /* Function arguments */
  173127. ){
  173128. fts5ExprFunction(pCtx, nArg, apVal, 1);
  173129. }
  173130. /*
  173131. ** The implementation of an SQLite user-defined-function that accepts a
  173132. ** single integer as an argument. If the integer is an alpha-numeric
  173133. ** unicode code point, 1 is returned. Otherwise 0.
  173134. */
  173135. static void fts5ExprIsAlnum(
  173136. sqlite3_context *pCtx, /* Function call context */
  173137. int nArg, /* Number of args */
  173138. sqlite3_value **apVal /* Function arguments */
  173139. ){
  173140. int iCode;
  173141. if( nArg!=1 ){
  173142. sqlite3_result_error(pCtx,
  173143. "wrong number of arguments to function fts5_isalnum", -1
  173144. );
  173145. return;
  173146. }
  173147. iCode = sqlite3_value_int(apVal[0]);
  173148. sqlite3_result_int(pCtx, sqlite3Fts5UnicodeIsalnum(iCode));
  173149. }
  173150. static void fts5ExprFold(
  173151. sqlite3_context *pCtx, /* Function call context */
  173152. int nArg, /* Number of args */
  173153. sqlite3_value **apVal /* Function arguments */
  173154. ){
  173155. if( nArg!=1 && nArg!=2 ){
  173156. sqlite3_result_error(pCtx,
  173157. "wrong number of arguments to function fts5_fold", -1
  173158. );
  173159. }else{
  173160. int iCode;
  173161. int bRemoveDiacritics = 0;
  173162. iCode = sqlite3_value_int(apVal[0]);
  173163. if( nArg==2 ) bRemoveDiacritics = sqlite3_value_int(apVal[1]);
  173164. sqlite3_result_int(pCtx, sqlite3Fts5UnicodeFold(iCode, bRemoveDiacritics));
  173165. }
  173166. }
  173167. /*
  173168. ** This is called during initialization to register the fts5_expr() scalar
  173169. ** UDF with the SQLite handle passed as the only argument.
  173170. */
  173171. static int sqlite3Fts5ExprInit(Fts5Global *pGlobal, sqlite3 *db){
  173172. struct Fts5ExprFunc {
  173173. const char *z;
  173174. void (*x)(sqlite3_context*,int,sqlite3_value**);
  173175. } aFunc[] = {
  173176. { "fts5_expr", fts5ExprFunctionHr },
  173177. { "fts5_expr_tcl", fts5ExprFunctionTcl },
  173178. { "fts5_isalnum", fts5ExprIsAlnum },
  173179. { "fts5_fold", fts5ExprFold },
  173180. };
  173181. int i;
  173182. int rc = SQLITE_OK;
  173183. void *pCtx = (void*)pGlobal;
  173184. for(i=0; rc==SQLITE_OK && i<ArraySize(aFunc); i++){
  173185. struct Fts5ExprFunc *p = &aFunc[i];
  173186. rc = sqlite3_create_function(db, p->z, -1, SQLITE_UTF8, pCtx, p->x, 0, 0);
  173187. }
  173188. /* Avoid a warning indicating that sqlite3Fts5ParserTrace() is unused */
  173189. #ifndef NDEBUG
  173190. (void)sqlite3Fts5ParserTrace;
  173191. #endif
  173192. return rc;
  173193. }
  173194. /*
  173195. ** Return the number of phrases in expression pExpr.
  173196. */
  173197. static int sqlite3Fts5ExprPhraseCount(Fts5Expr *pExpr){
  173198. return (pExpr ? pExpr->nPhrase : 0);
  173199. }
  173200. /*
  173201. ** Return the number of terms in the iPhrase'th phrase in pExpr.
  173202. */
  173203. static int sqlite3Fts5ExprPhraseSize(Fts5Expr *pExpr, int iPhrase){
  173204. if( iPhrase<0 || iPhrase>=pExpr->nPhrase ) return 0;
  173205. return pExpr->apExprPhrase[iPhrase]->nTerm;
  173206. }
  173207. /*
  173208. ** This function is used to access the current position list for phrase
  173209. ** iPhrase.
  173210. */
  173211. static int sqlite3Fts5ExprPoslist(Fts5Expr *pExpr, int iPhrase, const u8 **pa){
  173212. int nRet;
  173213. Fts5ExprPhrase *pPhrase = pExpr->apExprPhrase[iPhrase];
  173214. Fts5ExprNode *pNode = pPhrase->pNode;
  173215. if( pNode->bEof==0 && pNode->iRowid==pExpr->pRoot->iRowid ){
  173216. *pa = pPhrase->poslist.p;
  173217. nRet = pPhrase->poslist.n;
  173218. }else{
  173219. *pa = 0;
  173220. nRet = 0;
  173221. }
  173222. return nRet;
  173223. }
  173224. struct Fts5PoslistPopulator {
  173225. Fts5PoslistWriter writer;
  173226. int bOk; /* True if ok to populate */
  173227. int bMiss;
  173228. };
  173229. static Fts5PoslistPopulator *sqlite3Fts5ExprClearPoslists(Fts5Expr *pExpr, int bLive){
  173230. Fts5PoslistPopulator *pRet;
  173231. pRet = sqlite3_malloc(sizeof(Fts5PoslistPopulator)*pExpr->nPhrase);
  173232. if( pRet ){
  173233. int i;
  173234. memset(pRet, 0, sizeof(Fts5PoslistPopulator)*pExpr->nPhrase);
  173235. for(i=0; i<pExpr->nPhrase; i++){
  173236. Fts5Buffer *pBuf = &pExpr->apExprPhrase[i]->poslist;
  173237. Fts5ExprNode *pNode = pExpr->apExprPhrase[i]->pNode;
  173238. assert( pExpr->apExprPhrase[i]->nTerm==1 );
  173239. if( bLive &&
  173240. (pBuf->n==0 || pNode->iRowid!=pExpr->pRoot->iRowid || pNode->bEof)
  173241. ){
  173242. pRet[i].bMiss = 1;
  173243. }else{
  173244. pBuf->n = 0;
  173245. }
  173246. }
  173247. }
  173248. return pRet;
  173249. }
  173250. struct Fts5ExprCtx {
  173251. Fts5Expr *pExpr;
  173252. Fts5PoslistPopulator *aPopulator;
  173253. i64 iOff;
  173254. };
  173255. typedef struct Fts5ExprCtx Fts5ExprCtx;
  173256. /*
  173257. ** TODO: Make this more efficient!
  173258. */
  173259. static int fts5ExprColsetTest(Fts5Colset *pColset, int iCol){
  173260. int i;
  173261. for(i=0; i<pColset->nCol; i++){
  173262. if( pColset->aiCol[i]==iCol ) return 1;
  173263. }
  173264. return 0;
  173265. }
  173266. static int fts5ExprPopulatePoslistsCb(
  173267. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  173268. int tflags, /* Mask of FTS5_TOKEN_* flags */
  173269. const char *pToken, /* Pointer to buffer containing token */
  173270. int nToken, /* Size of token in bytes */
  173271. int iUnused1, /* Byte offset of token within input text */
  173272. int iUnused2 /* Byte offset of end of token within input text */
  173273. ){
  173274. Fts5ExprCtx *p = (Fts5ExprCtx*)pCtx;
  173275. Fts5Expr *pExpr = p->pExpr;
  173276. int i;
  173277. UNUSED_PARAM2(iUnused1, iUnused2);
  173278. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  173279. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ) p->iOff++;
  173280. for(i=0; i<pExpr->nPhrase; i++){
  173281. Fts5ExprTerm *pTerm;
  173282. if( p->aPopulator[i].bOk==0 ) continue;
  173283. for(pTerm=&pExpr->apExprPhrase[i]->aTerm[0]; pTerm; pTerm=pTerm->pSynonym){
  173284. int nTerm = (int)strlen(pTerm->zTerm);
  173285. if( (nTerm==nToken || (nTerm<nToken && pTerm->bPrefix))
  173286. && memcmp(pTerm->zTerm, pToken, nTerm)==0
  173287. ){
  173288. int rc = sqlite3Fts5PoslistWriterAppend(
  173289. &pExpr->apExprPhrase[i]->poslist, &p->aPopulator[i].writer, p->iOff
  173290. );
  173291. if( rc ) return rc;
  173292. break;
  173293. }
  173294. }
  173295. }
  173296. return SQLITE_OK;
  173297. }
  173298. static int sqlite3Fts5ExprPopulatePoslists(
  173299. Fts5Config *pConfig,
  173300. Fts5Expr *pExpr,
  173301. Fts5PoslistPopulator *aPopulator,
  173302. int iCol,
  173303. const char *z, int n
  173304. ){
  173305. int i;
  173306. Fts5ExprCtx sCtx;
  173307. sCtx.pExpr = pExpr;
  173308. sCtx.aPopulator = aPopulator;
  173309. sCtx.iOff = (((i64)iCol) << 32) - 1;
  173310. for(i=0; i<pExpr->nPhrase; i++){
  173311. Fts5ExprNode *pNode = pExpr->apExprPhrase[i]->pNode;
  173312. Fts5Colset *pColset = pNode->pNear->pColset;
  173313. if( (pColset && 0==fts5ExprColsetTest(pColset, iCol))
  173314. || aPopulator[i].bMiss
  173315. ){
  173316. aPopulator[i].bOk = 0;
  173317. }else{
  173318. aPopulator[i].bOk = 1;
  173319. }
  173320. }
  173321. return sqlite3Fts5Tokenize(pConfig,
  173322. FTS5_TOKENIZE_DOCUMENT, z, n, (void*)&sCtx, fts5ExprPopulatePoslistsCb
  173323. );
  173324. }
  173325. static void fts5ExprClearPoslists(Fts5ExprNode *pNode){
  173326. if( pNode->eType==FTS5_TERM || pNode->eType==FTS5_STRING ){
  173327. pNode->pNear->apPhrase[0]->poslist.n = 0;
  173328. }else{
  173329. int i;
  173330. for(i=0; i<pNode->nChild; i++){
  173331. fts5ExprClearPoslists(pNode->apChild[i]);
  173332. }
  173333. }
  173334. }
  173335. static int fts5ExprCheckPoslists(Fts5ExprNode *pNode, i64 iRowid){
  173336. pNode->iRowid = iRowid;
  173337. pNode->bEof = 0;
  173338. switch( pNode->eType ){
  173339. case FTS5_TERM:
  173340. case FTS5_STRING:
  173341. return (pNode->pNear->apPhrase[0]->poslist.n>0);
  173342. case FTS5_AND: {
  173343. int i;
  173344. for(i=0; i<pNode->nChild; i++){
  173345. if( fts5ExprCheckPoslists(pNode->apChild[i], iRowid)==0 ){
  173346. fts5ExprClearPoslists(pNode);
  173347. return 0;
  173348. }
  173349. }
  173350. break;
  173351. }
  173352. case FTS5_OR: {
  173353. int i;
  173354. int bRet = 0;
  173355. for(i=0; i<pNode->nChild; i++){
  173356. if( fts5ExprCheckPoslists(pNode->apChild[i], iRowid) ){
  173357. bRet = 1;
  173358. }
  173359. }
  173360. return bRet;
  173361. }
  173362. default: {
  173363. assert( pNode->eType==FTS5_NOT );
  173364. if( 0==fts5ExprCheckPoslists(pNode->apChild[0], iRowid)
  173365. || 0!=fts5ExprCheckPoslists(pNode->apChild[1], iRowid)
  173366. ){
  173367. fts5ExprClearPoslists(pNode);
  173368. return 0;
  173369. }
  173370. break;
  173371. }
  173372. }
  173373. return 1;
  173374. }
  173375. static void sqlite3Fts5ExprCheckPoslists(Fts5Expr *pExpr, i64 iRowid){
  173376. fts5ExprCheckPoslists(pExpr->pRoot, iRowid);
  173377. }
  173378. /*
  173379. ** This function is only called for detail=columns tables.
  173380. */
  173381. static int sqlite3Fts5ExprPhraseCollist(
  173382. Fts5Expr *pExpr,
  173383. int iPhrase,
  173384. const u8 **ppCollist,
  173385. int *pnCollist
  173386. ){
  173387. Fts5ExprPhrase *pPhrase = pExpr->apExprPhrase[iPhrase];
  173388. Fts5ExprNode *pNode = pPhrase->pNode;
  173389. int rc = SQLITE_OK;
  173390. assert( iPhrase>=0 && iPhrase<pExpr->nPhrase );
  173391. assert( pExpr->pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  173392. if( pNode->bEof==0
  173393. && pNode->iRowid==pExpr->pRoot->iRowid
  173394. && pPhrase->poslist.n>0
  173395. ){
  173396. Fts5ExprTerm *pTerm = &pPhrase->aTerm[0];
  173397. if( pTerm->pSynonym ){
  173398. Fts5Buffer *pBuf = (Fts5Buffer*)&pTerm->pSynonym[1];
  173399. rc = fts5ExprSynonymList(
  173400. pTerm, pNode->iRowid, pBuf, (u8**)ppCollist, pnCollist
  173401. );
  173402. }else{
  173403. *ppCollist = pPhrase->aTerm[0].pIter->pData;
  173404. *pnCollist = pPhrase->aTerm[0].pIter->nData;
  173405. }
  173406. }else{
  173407. *ppCollist = 0;
  173408. *pnCollist = 0;
  173409. }
  173410. return rc;
  173411. }
  173412. /*
  173413. ** 2014 August 11
  173414. **
  173415. ** The author disclaims copyright to this source code. In place of
  173416. ** a legal notice, here is a blessing:
  173417. **
  173418. ** May you do good and not evil.
  173419. ** May you find forgiveness for yourself and forgive others.
  173420. ** May you share freely, never taking more than you give.
  173421. **
  173422. ******************************************************************************
  173423. **
  173424. */
  173425. /* #include "fts5Int.h" */
  173426. typedef struct Fts5HashEntry Fts5HashEntry;
  173427. /*
  173428. ** This file contains the implementation of an in-memory hash table used
  173429. ** to accumuluate "term -> doclist" content before it is flused to a level-0
  173430. ** segment.
  173431. */
  173432. struct Fts5Hash {
  173433. int eDetail; /* Copy of Fts5Config.eDetail */
  173434. int *pnByte; /* Pointer to bytes counter */
  173435. int nEntry; /* Number of entries currently in hash */
  173436. int nSlot; /* Size of aSlot[] array */
  173437. Fts5HashEntry *pScan; /* Current ordered scan item */
  173438. Fts5HashEntry **aSlot; /* Array of hash slots */
  173439. };
  173440. /*
  173441. ** Each entry in the hash table is represented by an object of the
  173442. ** following type. Each object, its key (zKey[]) and its current data
  173443. ** are stored in a single memory allocation. The position list data
  173444. ** immediately follows the key data in memory.
  173445. **
  173446. ** The data that follows the key is in a similar, but not identical format
  173447. ** to the doclist data stored in the database. It is:
  173448. **
  173449. ** * Rowid, as a varint
  173450. ** * Position list, without 0x00 terminator.
  173451. ** * Size of previous position list and rowid, as a 4 byte
  173452. ** big-endian integer.
  173453. **
  173454. ** iRowidOff:
  173455. ** Offset of last rowid written to data area. Relative to first byte of
  173456. ** structure.
  173457. **
  173458. ** nData:
  173459. ** Bytes of data written since iRowidOff.
  173460. */
  173461. struct Fts5HashEntry {
  173462. Fts5HashEntry *pHashNext; /* Next hash entry with same hash-key */
  173463. Fts5HashEntry *pScanNext; /* Next entry in sorted order */
  173464. int nAlloc; /* Total size of allocation */
  173465. int iSzPoslist; /* Offset of space for 4-byte poslist size */
  173466. int nData; /* Total bytes of data (incl. structure) */
  173467. int nKey; /* Length of zKey[] in bytes */
  173468. u8 bDel; /* Set delete-flag @ iSzPoslist */
  173469. u8 bContent; /* Set content-flag (detail=none mode) */
  173470. i16 iCol; /* Column of last value written */
  173471. int iPos; /* Position of last value written */
  173472. i64 iRowid; /* Rowid of last value written */
  173473. char zKey[8]; /* Nul-terminated entry key */
  173474. };
  173475. /*
  173476. ** Size of Fts5HashEntry without the zKey[] array.
  173477. */
  173478. #define FTS5_HASHENTRYSIZE (sizeof(Fts5HashEntry)-8)
  173479. /*
  173480. ** Allocate a new hash table.
  173481. */
  173482. static int sqlite3Fts5HashNew(Fts5Config *pConfig, Fts5Hash **ppNew, int *pnByte){
  173483. int rc = SQLITE_OK;
  173484. Fts5Hash *pNew;
  173485. *ppNew = pNew = (Fts5Hash*)sqlite3_malloc(sizeof(Fts5Hash));
  173486. if( pNew==0 ){
  173487. rc = SQLITE_NOMEM;
  173488. }else{
  173489. int nByte;
  173490. memset(pNew, 0, sizeof(Fts5Hash));
  173491. pNew->pnByte = pnByte;
  173492. pNew->eDetail = pConfig->eDetail;
  173493. pNew->nSlot = 1024;
  173494. nByte = sizeof(Fts5HashEntry*) * pNew->nSlot;
  173495. pNew->aSlot = (Fts5HashEntry**)sqlite3_malloc(nByte);
  173496. if( pNew->aSlot==0 ){
  173497. sqlite3_free(pNew);
  173498. *ppNew = 0;
  173499. rc = SQLITE_NOMEM;
  173500. }else{
  173501. memset(pNew->aSlot, 0, nByte);
  173502. }
  173503. }
  173504. return rc;
  173505. }
  173506. /*
  173507. ** Free a hash table object.
  173508. */
  173509. static void sqlite3Fts5HashFree(Fts5Hash *pHash){
  173510. if( pHash ){
  173511. sqlite3Fts5HashClear(pHash);
  173512. sqlite3_free(pHash->aSlot);
  173513. sqlite3_free(pHash);
  173514. }
  173515. }
  173516. /*
  173517. ** Empty (but do not delete) a hash table.
  173518. */
  173519. static void sqlite3Fts5HashClear(Fts5Hash *pHash){
  173520. int i;
  173521. for(i=0; i<pHash->nSlot; i++){
  173522. Fts5HashEntry *pNext;
  173523. Fts5HashEntry *pSlot;
  173524. for(pSlot=pHash->aSlot[i]; pSlot; pSlot=pNext){
  173525. pNext = pSlot->pHashNext;
  173526. sqlite3_free(pSlot);
  173527. }
  173528. }
  173529. memset(pHash->aSlot, 0, pHash->nSlot * sizeof(Fts5HashEntry*));
  173530. pHash->nEntry = 0;
  173531. }
  173532. static unsigned int fts5HashKey(int nSlot, const u8 *p, int n){
  173533. int i;
  173534. unsigned int h = 13;
  173535. for(i=n-1; i>=0; i--){
  173536. h = (h << 3) ^ h ^ p[i];
  173537. }
  173538. return (h % nSlot);
  173539. }
  173540. static unsigned int fts5HashKey2(int nSlot, u8 b, const u8 *p, int n){
  173541. int i;
  173542. unsigned int h = 13;
  173543. for(i=n-1; i>=0; i--){
  173544. h = (h << 3) ^ h ^ p[i];
  173545. }
  173546. h = (h << 3) ^ h ^ b;
  173547. return (h % nSlot);
  173548. }
  173549. /*
  173550. ** Resize the hash table by doubling the number of slots.
  173551. */
  173552. static int fts5HashResize(Fts5Hash *pHash){
  173553. int nNew = pHash->nSlot*2;
  173554. int i;
  173555. Fts5HashEntry **apNew;
  173556. Fts5HashEntry **apOld = pHash->aSlot;
  173557. apNew = (Fts5HashEntry**)sqlite3_malloc(nNew*sizeof(Fts5HashEntry*));
  173558. if( !apNew ) return SQLITE_NOMEM;
  173559. memset(apNew, 0, nNew*sizeof(Fts5HashEntry*));
  173560. for(i=0; i<pHash->nSlot; i++){
  173561. while( apOld[i] ){
  173562. int iHash;
  173563. Fts5HashEntry *p = apOld[i];
  173564. apOld[i] = p->pHashNext;
  173565. iHash = fts5HashKey(nNew, (u8*)p->zKey, (int)strlen(p->zKey));
  173566. p->pHashNext = apNew[iHash];
  173567. apNew[iHash] = p;
  173568. }
  173569. }
  173570. sqlite3_free(apOld);
  173571. pHash->nSlot = nNew;
  173572. pHash->aSlot = apNew;
  173573. return SQLITE_OK;
  173574. }
  173575. static void fts5HashAddPoslistSize(Fts5Hash *pHash, Fts5HashEntry *p){
  173576. if( p->iSzPoslist ){
  173577. u8 *pPtr = (u8*)p;
  173578. if( pHash->eDetail==FTS5_DETAIL_NONE ){
  173579. assert( p->nData==p->iSzPoslist );
  173580. if( p->bDel ){
  173581. pPtr[p->nData++] = 0x00;
  173582. if( p->bContent ){
  173583. pPtr[p->nData++] = 0x00;
  173584. }
  173585. }
  173586. }else{
  173587. int nSz = (p->nData - p->iSzPoslist - 1); /* Size in bytes */
  173588. int nPos = nSz*2 + p->bDel; /* Value of nPos field */
  173589. assert( p->bDel==0 || p->bDel==1 );
  173590. if( nPos<=127 ){
  173591. pPtr[p->iSzPoslist] = (u8)nPos;
  173592. }else{
  173593. int nByte = sqlite3Fts5GetVarintLen((u32)nPos);
  173594. memmove(&pPtr[p->iSzPoslist + nByte], &pPtr[p->iSzPoslist + 1], nSz);
  173595. sqlite3Fts5PutVarint(&pPtr[p->iSzPoslist], nPos);
  173596. p->nData += (nByte-1);
  173597. }
  173598. }
  173599. p->iSzPoslist = 0;
  173600. p->bDel = 0;
  173601. p->bContent = 0;
  173602. }
  173603. }
  173604. /*
  173605. ** Add an entry to the in-memory hash table. The key is the concatenation
  173606. ** of bByte and (pToken/nToken). The value is (iRowid/iCol/iPos).
  173607. **
  173608. ** (bByte || pToken) -> (iRowid,iCol,iPos)
  173609. **
  173610. ** Or, if iCol is negative, then the value is a delete marker.
  173611. */
  173612. static int sqlite3Fts5HashWrite(
  173613. Fts5Hash *pHash,
  173614. i64 iRowid, /* Rowid for this entry */
  173615. int iCol, /* Column token appears in (-ve -> delete) */
  173616. int iPos, /* Position of token within column */
  173617. char bByte, /* First byte of token */
  173618. const char *pToken, int nToken /* Token to add or remove to or from index */
  173619. ){
  173620. unsigned int iHash;
  173621. Fts5HashEntry *p;
  173622. u8 *pPtr;
  173623. int nIncr = 0; /* Amount to increment (*pHash->pnByte) by */
  173624. int bNew; /* If non-delete entry should be written */
  173625. bNew = (pHash->eDetail==FTS5_DETAIL_FULL);
  173626. /* Attempt to locate an existing hash entry */
  173627. iHash = fts5HashKey2(pHash->nSlot, (u8)bByte, (const u8*)pToken, nToken);
  173628. for(p=pHash->aSlot[iHash]; p; p=p->pHashNext){
  173629. if( p->zKey[0]==bByte
  173630. && p->nKey==nToken
  173631. && memcmp(&p->zKey[1], pToken, nToken)==0
  173632. ){
  173633. break;
  173634. }
  173635. }
  173636. /* If an existing hash entry cannot be found, create a new one. */
  173637. if( p==0 ){
  173638. /* Figure out how much space to allocate */
  173639. int nByte = FTS5_HASHENTRYSIZE + (nToken+1) + 1 + 64;
  173640. if( nByte<128 ) nByte = 128;
  173641. /* Grow the Fts5Hash.aSlot[] array if necessary. */
  173642. if( (pHash->nEntry*2)>=pHash->nSlot ){
  173643. int rc = fts5HashResize(pHash);
  173644. if( rc!=SQLITE_OK ) return rc;
  173645. iHash = fts5HashKey2(pHash->nSlot, (u8)bByte, (const u8*)pToken, nToken);
  173646. }
  173647. /* Allocate new Fts5HashEntry and add it to the hash table. */
  173648. p = (Fts5HashEntry*)sqlite3_malloc(nByte);
  173649. if( !p ) return SQLITE_NOMEM;
  173650. memset(p, 0, FTS5_HASHENTRYSIZE);
  173651. p->nAlloc = nByte;
  173652. p->zKey[0] = bByte;
  173653. memcpy(&p->zKey[1], pToken, nToken);
  173654. assert( iHash==fts5HashKey(pHash->nSlot, (u8*)p->zKey, nToken+1) );
  173655. p->nKey = nToken;
  173656. p->zKey[nToken+1] = '\0';
  173657. p->nData = nToken+1 + 1 + FTS5_HASHENTRYSIZE;
  173658. p->pHashNext = pHash->aSlot[iHash];
  173659. pHash->aSlot[iHash] = p;
  173660. pHash->nEntry++;
  173661. /* Add the first rowid field to the hash-entry */
  173662. p->nData += sqlite3Fts5PutVarint(&((u8*)p)[p->nData], iRowid);
  173663. p->iRowid = iRowid;
  173664. p->iSzPoslist = p->nData;
  173665. if( pHash->eDetail!=FTS5_DETAIL_NONE ){
  173666. p->nData += 1;
  173667. p->iCol = (pHash->eDetail==FTS5_DETAIL_FULL ? 0 : -1);
  173668. }
  173669. nIncr += p->nData;
  173670. }else{
  173671. /* Appending to an existing hash-entry. Check that there is enough
  173672. ** space to append the largest possible new entry. Worst case scenario
  173673. ** is:
  173674. **
  173675. ** + 9 bytes for a new rowid,
  173676. ** + 4 byte reserved for the "poslist size" varint.
  173677. ** + 1 byte for a "new column" byte,
  173678. ** + 3 bytes for a new column number (16-bit max) as a varint,
  173679. ** + 5 bytes for the new position offset (32-bit max).
  173680. */
  173681. if( (p->nAlloc - p->nData) < (9 + 4 + 1 + 3 + 5) ){
  173682. int nNew = p->nAlloc * 2;
  173683. Fts5HashEntry *pNew;
  173684. Fts5HashEntry **pp;
  173685. pNew = (Fts5HashEntry*)sqlite3_realloc(p, nNew);
  173686. if( pNew==0 ) return SQLITE_NOMEM;
  173687. pNew->nAlloc = nNew;
  173688. for(pp=&pHash->aSlot[iHash]; *pp!=p; pp=&(*pp)->pHashNext);
  173689. *pp = pNew;
  173690. p = pNew;
  173691. }
  173692. nIncr -= p->nData;
  173693. }
  173694. assert( (p->nAlloc - p->nData) >= (9 + 4 + 1 + 3 + 5) );
  173695. pPtr = (u8*)p;
  173696. /* If this is a new rowid, append the 4-byte size field for the previous
  173697. ** entry, and the new rowid for this entry. */
  173698. if( iRowid!=p->iRowid ){
  173699. fts5HashAddPoslistSize(pHash, p);
  173700. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iRowid - p->iRowid);
  173701. p->iRowid = iRowid;
  173702. bNew = 1;
  173703. p->iSzPoslist = p->nData;
  173704. if( pHash->eDetail!=FTS5_DETAIL_NONE ){
  173705. p->nData += 1;
  173706. p->iCol = (pHash->eDetail==FTS5_DETAIL_FULL ? 0 : -1);
  173707. p->iPos = 0;
  173708. }
  173709. }
  173710. if( iCol>=0 ){
  173711. if( pHash->eDetail==FTS5_DETAIL_NONE ){
  173712. p->bContent = 1;
  173713. }else{
  173714. /* Append a new column value, if necessary */
  173715. assert( iCol>=p->iCol );
  173716. if( iCol!=p->iCol ){
  173717. if( pHash->eDetail==FTS5_DETAIL_FULL ){
  173718. pPtr[p->nData++] = 0x01;
  173719. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iCol);
  173720. p->iCol = (i16)iCol;
  173721. p->iPos = 0;
  173722. }else{
  173723. bNew = 1;
  173724. p->iCol = (i16)(iPos = iCol);
  173725. }
  173726. }
  173727. /* Append the new position offset, if necessary */
  173728. if( bNew ){
  173729. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iPos - p->iPos + 2);
  173730. p->iPos = iPos;
  173731. }
  173732. }
  173733. }else{
  173734. /* This is a delete. Set the delete flag. */
  173735. p->bDel = 1;
  173736. }
  173737. nIncr += p->nData;
  173738. *pHash->pnByte += nIncr;
  173739. return SQLITE_OK;
  173740. }
  173741. /*
  173742. ** Arguments pLeft and pRight point to linked-lists of hash-entry objects,
  173743. ** each sorted in key order. This function merges the two lists into a
  173744. ** single list and returns a pointer to its first element.
  173745. */
  173746. static Fts5HashEntry *fts5HashEntryMerge(
  173747. Fts5HashEntry *pLeft,
  173748. Fts5HashEntry *pRight
  173749. ){
  173750. Fts5HashEntry *p1 = pLeft;
  173751. Fts5HashEntry *p2 = pRight;
  173752. Fts5HashEntry *pRet = 0;
  173753. Fts5HashEntry **ppOut = &pRet;
  173754. while( p1 || p2 ){
  173755. if( p1==0 ){
  173756. *ppOut = p2;
  173757. p2 = 0;
  173758. }else if( p2==0 ){
  173759. *ppOut = p1;
  173760. p1 = 0;
  173761. }else{
  173762. int i = 0;
  173763. while( p1->zKey[i]==p2->zKey[i] ) i++;
  173764. if( ((u8)p1->zKey[i])>((u8)p2->zKey[i]) ){
  173765. /* p2 is smaller */
  173766. *ppOut = p2;
  173767. ppOut = &p2->pScanNext;
  173768. p2 = p2->pScanNext;
  173769. }else{
  173770. /* p1 is smaller */
  173771. *ppOut = p1;
  173772. ppOut = &p1->pScanNext;
  173773. p1 = p1->pScanNext;
  173774. }
  173775. *ppOut = 0;
  173776. }
  173777. }
  173778. return pRet;
  173779. }
  173780. /*
  173781. ** Extract all tokens from hash table iHash and link them into a list
  173782. ** in sorted order. The hash table is cleared before returning. It is
  173783. ** the responsibility of the caller to free the elements of the returned
  173784. ** list.
  173785. */
  173786. static int fts5HashEntrySort(
  173787. Fts5Hash *pHash,
  173788. const char *pTerm, int nTerm, /* Query prefix, if any */
  173789. Fts5HashEntry **ppSorted
  173790. ){
  173791. const int nMergeSlot = 32;
  173792. Fts5HashEntry **ap;
  173793. Fts5HashEntry *pList;
  173794. int iSlot;
  173795. int i;
  173796. *ppSorted = 0;
  173797. ap = sqlite3_malloc(sizeof(Fts5HashEntry*) * nMergeSlot);
  173798. if( !ap ) return SQLITE_NOMEM;
  173799. memset(ap, 0, sizeof(Fts5HashEntry*) * nMergeSlot);
  173800. for(iSlot=0; iSlot<pHash->nSlot; iSlot++){
  173801. Fts5HashEntry *pIter;
  173802. for(pIter=pHash->aSlot[iSlot]; pIter; pIter=pIter->pHashNext){
  173803. if( pTerm==0 || 0==memcmp(pIter->zKey, pTerm, nTerm) ){
  173804. Fts5HashEntry *pEntry = pIter;
  173805. pEntry->pScanNext = 0;
  173806. for(i=0; ap[i]; i++){
  173807. pEntry = fts5HashEntryMerge(pEntry, ap[i]);
  173808. ap[i] = 0;
  173809. }
  173810. ap[i] = pEntry;
  173811. }
  173812. }
  173813. }
  173814. pList = 0;
  173815. for(i=0; i<nMergeSlot; i++){
  173816. pList = fts5HashEntryMerge(pList, ap[i]);
  173817. }
  173818. pHash->nEntry = 0;
  173819. sqlite3_free(ap);
  173820. *ppSorted = pList;
  173821. return SQLITE_OK;
  173822. }
  173823. /*
  173824. ** Query the hash table for a doclist associated with term pTerm/nTerm.
  173825. */
  173826. static int sqlite3Fts5HashQuery(
  173827. Fts5Hash *pHash, /* Hash table to query */
  173828. const char *pTerm, int nTerm, /* Query term */
  173829. const u8 **ppDoclist, /* OUT: Pointer to doclist for pTerm */
  173830. int *pnDoclist /* OUT: Size of doclist in bytes */
  173831. ){
  173832. unsigned int iHash = fts5HashKey(pHash->nSlot, (const u8*)pTerm, nTerm);
  173833. Fts5HashEntry *p;
  173834. for(p=pHash->aSlot[iHash]; p; p=p->pHashNext){
  173835. if( memcmp(p->zKey, pTerm, nTerm)==0 && p->zKey[nTerm]==0 ) break;
  173836. }
  173837. if( p ){
  173838. fts5HashAddPoslistSize(pHash, p);
  173839. *ppDoclist = (const u8*)&p->zKey[nTerm+1];
  173840. *pnDoclist = p->nData - (FTS5_HASHENTRYSIZE + nTerm + 1);
  173841. }else{
  173842. *ppDoclist = 0;
  173843. *pnDoclist = 0;
  173844. }
  173845. return SQLITE_OK;
  173846. }
  173847. static int sqlite3Fts5HashScanInit(
  173848. Fts5Hash *p, /* Hash table to query */
  173849. const char *pTerm, int nTerm /* Query prefix */
  173850. ){
  173851. return fts5HashEntrySort(p, pTerm, nTerm, &p->pScan);
  173852. }
  173853. static void sqlite3Fts5HashScanNext(Fts5Hash *p){
  173854. assert( !sqlite3Fts5HashScanEof(p) );
  173855. p->pScan = p->pScan->pScanNext;
  173856. }
  173857. static int sqlite3Fts5HashScanEof(Fts5Hash *p){
  173858. return (p->pScan==0);
  173859. }
  173860. static void sqlite3Fts5HashScanEntry(
  173861. Fts5Hash *pHash,
  173862. const char **pzTerm, /* OUT: term (nul-terminated) */
  173863. const u8 **ppDoclist, /* OUT: pointer to doclist */
  173864. int *pnDoclist /* OUT: size of doclist in bytes */
  173865. ){
  173866. Fts5HashEntry *p;
  173867. if( (p = pHash->pScan) ){
  173868. int nTerm = (int)strlen(p->zKey);
  173869. fts5HashAddPoslistSize(pHash, p);
  173870. *pzTerm = p->zKey;
  173871. *ppDoclist = (const u8*)&p->zKey[nTerm+1];
  173872. *pnDoclist = p->nData - (FTS5_HASHENTRYSIZE + nTerm + 1);
  173873. }else{
  173874. *pzTerm = 0;
  173875. *ppDoclist = 0;
  173876. *pnDoclist = 0;
  173877. }
  173878. }
  173879. /*
  173880. ** 2014 May 31
  173881. **
  173882. ** The author disclaims copyright to this source code. In place of
  173883. ** a legal notice, here is a blessing:
  173884. **
  173885. ** May you do good and not evil.
  173886. ** May you find forgiveness for yourself and forgive others.
  173887. ** May you share freely, never taking more than you give.
  173888. **
  173889. ******************************************************************************
  173890. **
  173891. ** Low level access to the FTS index stored in the database file. The
  173892. ** routines in this file file implement all read and write access to the
  173893. ** %_data table. Other parts of the system access this functionality via
  173894. ** the interface defined in fts5Int.h.
  173895. */
  173896. /* #include "fts5Int.h" */
  173897. /*
  173898. ** Overview:
  173899. **
  173900. ** The %_data table contains all the FTS indexes for an FTS5 virtual table.
  173901. ** As well as the main term index, there may be up to 31 prefix indexes.
  173902. ** The format is similar to FTS3/4, except that:
  173903. **
  173904. ** * all segment b-tree leaf data is stored in fixed size page records
  173905. ** (e.g. 1000 bytes). A single doclist may span multiple pages. Care is
  173906. ** taken to ensure it is possible to iterate in either direction through
  173907. ** the entries in a doclist, or to seek to a specific entry within a
  173908. ** doclist, without loading it into memory.
  173909. **
  173910. ** * large doclists that span many pages have associated "doclist index"
  173911. ** records that contain a copy of the first rowid on each page spanned by
  173912. ** the doclist. This is used to speed up seek operations, and merges of
  173913. ** large doclists with very small doclists.
  173914. **
  173915. ** * extra fields in the "structure record" record the state of ongoing
  173916. ** incremental merge operations.
  173917. **
  173918. */
  173919. #define FTS5_OPT_WORK_UNIT 1000 /* Number of leaf pages per optimize step */
  173920. #define FTS5_WORK_UNIT 64 /* Number of leaf pages in unit of work */
  173921. #define FTS5_MIN_DLIDX_SIZE 4 /* Add dlidx if this many empty pages */
  173922. #define FTS5_MAIN_PREFIX '0'
  173923. #if FTS5_MAX_PREFIX_INDEXES > 31
  173924. # error "FTS5_MAX_PREFIX_INDEXES is too large"
  173925. #endif
  173926. /*
  173927. ** Details:
  173928. **
  173929. ** The %_data table managed by this module,
  173930. **
  173931. ** CREATE TABLE %_data(id INTEGER PRIMARY KEY, block BLOB);
  173932. **
  173933. ** , contains the following 5 types of records. See the comments surrounding
  173934. ** the FTS5_*_ROWID macros below for a description of how %_data rowids are
  173935. ** assigned to each fo them.
  173936. **
  173937. ** 1. Structure Records:
  173938. **
  173939. ** The set of segments that make up an index - the index structure - are
  173940. ** recorded in a single record within the %_data table. The record consists
  173941. ** of a single 32-bit configuration cookie value followed by a list of
  173942. ** SQLite varints. If the FTS table features more than one index (because
  173943. ** there are one or more prefix indexes), it is guaranteed that all share
  173944. ** the same cookie value.
  173945. **
  173946. ** Immediately following the configuration cookie, the record begins with
  173947. ** three varints:
  173948. **
  173949. ** + number of levels,
  173950. ** + total number of segments on all levels,
  173951. ** + value of write counter.
  173952. **
  173953. ** Then, for each level from 0 to nMax:
  173954. **
  173955. ** + number of input segments in ongoing merge.
  173956. ** + total number of segments in level.
  173957. ** + for each segment from oldest to newest:
  173958. ** + segment id (always > 0)
  173959. ** + first leaf page number (often 1, always greater than 0)
  173960. ** + final leaf page number
  173961. **
  173962. ** 2. The Averages Record:
  173963. **
  173964. ** A single record within the %_data table. The data is a list of varints.
  173965. ** The first value is the number of rows in the index. Then, for each column
  173966. ** from left to right, the total number of tokens in the column for all
  173967. ** rows of the table.
  173968. **
  173969. ** 3. Segment leaves:
  173970. **
  173971. ** TERM/DOCLIST FORMAT:
  173972. **
  173973. ** Most of each segment leaf is taken up by term/doclist data. The
  173974. ** general format of term/doclist, starting with the first term
  173975. ** on the leaf page, is:
  173976. **
  173977. ** varint : size of first term
  173978. ** blob: first term data
  173979. ** doclist: first doclist
  173980. ** zero-or-more {
  173981. ** varint: number of bytes in common with previous term
  173982. ** varint: number of bytes of new term data (nNew)
  173983. ** blob: nNew bytes of new term data
  173984. ** doclist: next doclist
  173985. ** }
  173986. **
  173987. ** doclist format:
  173988. **
  173989. ** varint: first rowid
  173990. ** poslist: first poslist
  173991. ** zero-or-more {
  173992. ** varint: rowid delta (always > 0)
  173993. ** poslist: next poslist
  173994. ** }
  173995. **
  173996. ** poslist format:
  173997. **
  173998. ** varint: size of poslist in bytes multiplied by 2, not including
  173999. ** this field. Plus 1 if this entry carries the "delete" flag.
  174000. ** collist: collist for column 0
  174001. ** zero-or-more {
  174002. ** 0x01 byte
  174003. ** varint: column number (I)
  174004. ** collist: collist for column I
  174005. ** }
  174006. **
  174007. ** collist format:
  174008. **
  174009. ** varint: first offset + 2
  174010. ** zero-or-more {
  174011. ** varint: offset delta + 2
  174012. ** }
  174013. **
  174014. ** PAGE FORMAT
  174015. **
  174016. ** Each leaf page begins with a 4-byte header containing 2 16-bit
  174017. ** unsigned integer fields in big-endian format. They are:
  174018. **
  174019. ** * The byte offset of the first rowid on the page, if it exists
  174020. ** and occurs before the first term (otherwise 0).
  174021. **
  174022. ** * The byte offset of the start of the page footer. If the page
  174023. ** footer is 0 bytes in size, then this field is the same as the
  174024. ** size of the leaf page in bytes.
  174025. **
  174026. ** The page footer consists of a single varint for each term located
  174027. ** on the page. Each varint is the byte offset of the current term
  174028. ** within the page, delta-compressed against the previous value. In
  174029. ** other words, the first varint in the footer is the byte offset of
  174030. ** the first term, the second is the byte offset of the second less that
  174031. ** of the first, and so on.
  174032. **
  174033. ** The term/doclist format described above is accurate if the entire
  174034. ** term/doclist data fits on a single leaf page. If this is not the case,
  174035. ** the format is changed in two ways:
  174036. **
  174037. ** + if the first rowid on a page occurs before the first term, it
  174038. ** is stored as a literal value:
  174039. **
  174040. ** varint: first rowid
  174041. **
  174042. ** + the first term on each page is stored in the same way as the
  174043. ** very first term of the segment:
  174044. **
  174045. ** varint : size of first term
  174046. ** blob: first term data
  174047. **
  174048. ** 5. Segment doclist indexes:
  174049. **
  174050. ** Doclist indexes are themselves b-trees, however they usually consist of
  174051. ** a single leaf record only. The format of each doclist index leaf page
  174052. ** is:
  174053. **
  174054. ** * Flags byte. Bits are:
  174055. ** 0x01: Clear if leaf is also the root page, otherwise set.
  174056. **
  174057. ** * Page number of fts index leaf page. As a varint.
  174058. **
  174059. ** * First rowid on page indicated by previous field. As a varint.
  174060. **
  174061. ** * A list of varints, one for each subsequent termless page. A
  174062. ** positive delta if the termless page contains at least one rowid,
  174063. ** or an 0x00 byte otherwise.
  174064. **
  174065. ** Internal doclist index nodes are:
  174066. **
  174067. ** * Flags byte. Bits are:
  174068. ** 0x01: Clear for root page, otherwise set.
  174069. **
  174070. ** * Page number of first child page. As a varint.
  174071. **
  174072. ** * Copy of first rowid on page indicated by previous field. As a varint.
  174073. **
  174074. ** * A list of delta-encoded varints - the first rowid on each subsequent
  174075. ** child page.
  174076. **
  174077. */
  174078. /*
  174079. ** Rowids for the averages and structure records in the %_data table.
  174080. */
  174081. #define FTS5_AVERAGES_ROWID 1 /* Rowid used for the averages record */
  174082. #define FTS5_STRUCTURE_ROWID 10 /* The structure record */
  174083. /*
  174084. ** Macros determining the rowids used by segment leaves and dlidx leaves
  174085. ** and nodes. All nodes and leaves are stored in the %_data table with large
  174086. ** positive rowids.
  174087. **
  174088. ** Each segment has a unique non-zero 16-bit id.
  174089. **
  174090. ** The rowid for each segment leaf is found by passing the segment id and
  174091. ** the leaf page number to the FTS5_SEGMENT_ROWID macro. Leaves are numbered
  174092. ** sequentially starting from 1.
  174093. */
  174094. #define FTS5_DATA_ID_B 16 /* Max seg id number 65535 */
  174095. #define FTS5_DATA_DLI_B 1 /* Doclist-index flag (1 bit) */
  174096. #define FTS5_DATA_HEIGHT_B 5 /* Max dlidx tree height of 32 */
  174097. #define FTS5_DATA_PAGE_B 31 /* Max page number of 2147483648 */
  174098. #define fts5_dri(segid, dlidx, height, pgno) ( \
  174099. ((i64)(segid) << (FTS5_DATA_PAGE_B+FTS5_DATA_HEIGHT_B+FTS5_DATA_DLI_B)) + \
  174100. ((i64)(dlidx) << (FTS5_DATA_PAGE_B + FTS5_DATA_HEIGHT_B)) + \
  174101. ((i64)(height) << (FTS5_DATA_PAGE_B)) + \
  174102. ((i64)(pgno)) \
  174103. )
  174104. #define FTS5_SEGMENT_ROWID(segid, pgno) fts5_dri(segid, 0, 0, pgno)
  174105. #define FTS5_DLIDX_ROWID(segid, height, pgno) fts5_dri(segid, 1, height, pgno)
  174106. /*
  174107. ** Maximum segments permitted in a single index
  174108. */
  174109. #define FTS5_MAX_SEGMENT 2000
  174110. #ifdef SQLITE_DEBUG
  174111. static int sqlite3Fts5Corrupt() { return SQLITE_CORRUPT_VTAB; }
  174112. #endif
  174113. /*
  174114. ** Each time a blob is read from the %_data table, it is padded with this
  174115. ** many zero bytes. This makes it easier to decode the various record formats
  174116. ** without overreading if the records are corrupt.
  174117. */
  174118. #define FTS5_DATA_ZERO_PADDING 8
  174119. #define FTS5_DATA_PADDING 20
  174120. typedef struct Fts5Data Fts5Data;
  174121. typedef struct Fts5DlidxIter Fts5DlidxIter;
  174122. typedef struct Fts5DlidxLvl Fts5DlidxLvl;
  174123. typedef struct Fts5DlidxWriter Fts5DlidxWriter;
  174124. typedef struct Fts5Iter Fts5Iter;
  174125. typedef struct Fts5PageWriter Fts5PageWriter;
  174126. typedef struct Fts5SegIter Fts5SegIter;
  174127. typedef struct Fts5DoclistIter Fts5DoclistIter;
  174128. typedef struct Fts5SegWriter Fts5SegWriter;
  174129. typedef struct Fts5Structure Fts5Structure;
  174130. typedef struct Fts5StructureLevel Fts5StructureLevel;
  174131. typedef struct Fts5StructureSegment Fts5StructureSegment;
  174132. struct Fts5Data {
  174133. u8 *p; /* Pointer to buffer containing record */
  174134. int nn; /* Size of record in bytes */
  174135. int szLeaf; /* Size of leaf without page-index */
  174136. };
  174137. /*
  174138. ** One object per %_data table.
  174139. */
  174140. struct Fts5Index {
  174141. Fts5Config *pConfig; /* Virtual table configuration */
  174142. char *zDataTbl; /* Name of %_data table */
  174143. int nWorkUnit; /* Leaf pages in a "unit" of work */
  174144. /*
  174145. ** Variables related to the accumulation of tokens and doclists within the
  174146. ** in-memory hash tables before they are flushed to disk.
  174147. */
  174148. Fts5Hash *pHash; /* Hash table for in-memory data */
  174149. int nPendingData; /* Current bytes of pending data */
  174150. i64 iWriteRowid; /* Rowid for current doc being written */
  174151. int bDelete; /* Current write is a delete */
  174152. /* Error state. */
  174153. int rc; /* Current error code */
  174154. /* State used by the fts5DataXXX() functions. */
  174155. sqlite3_blob *pReader; /* RO incr-blob open on %_data table */
  174156. sqlite3_stmt *pWriter; /* "INSERT ... %_data VALUES(?,?)" */
  174157. sqlite3_stmt *pDeleter; /* "DELETE FROM %_data ... id>=? AND id<=?" */
  174158. sqlite3_stmt *pIdxWriter; /* "INSERT ... %_idx VALUES(?,?,?,?)" */
  174159. sqlite3_stmt *pIdxDeleter; /* "DELETE FROM %_idx WHERE segid=? */
  174160. sqlite3_stmt *pIdxSelect;
  174161. int nRead; /* Total number of blocks read */
  174162. sqlite3_stmt *pDataVersion;
  174163. i64 iStructVersion; /* data_version when pStruct read */
  174164. Fts5Structure *pStruct; /* Current db structure (or NULL) */
  174165. };
  174166. struct Fts5DoclistIter {
  174167. u8 *aEof; /* Pointer to 1 byte past end of doclist */
  174168. /* Output variables. aPoslist==0 at EOF */
  174169. i64 iRowid;
  174170. u8 *aPoslist;
  174171. int nPoslist;
  174172. int nSize;
  174173. };
  174174. /*
  174175. ** The contents of the "structure" record for each index are represented
  174176. ** using an Fts5Structure record in memory. Which uses instances of the
  174177. ** other Fts5StructureXXX types as components.
  174178. */
  174179. struct Fts5StructureSegment {
  174180. int iSegid; /* Segment id */
  174181. int pgnoFirst; /* First leaf page number in segment */
  174182. int pgnoLast; /* Last leaf page number in segment */
  174183. };
  174184. struct Fts5StructureLevel {
  174185. int nMerge; /* Number of segments in incr-merge */
  174186. int nSeg; /* Total number of segments on level */
  174187. Fts5StructureSegment *aSeg; /* Array of segments. aSeg[0] is oldest. */
  174188. };
  174189. struct Fts5Structure {
  174190. int nRef; /* Object reference count */
  174191. u64 nWriteCounter; /* Total leaves written to level 0 */
  174192. int nSegment; /* Total segments in this structure */
  174193. int nLevel; /* Number of levels in this index */
  174194. Fts5StructureLevel aLevel[1]; /* Array of nLevel level objects */
  174195. };
  174196. /*
  174197. ** An object of type Fts5SegWriter is used to write to segments.
  174198. */
  174199. struct Fts5PageWriter {
  174200. int pgno; /* Page number for this page */
  174201. int iPrevPgidx; /* Previous value written into pgidx */
  174202. Fts5Buffer buf; /* Buffer containing leaf data */
  174203. Fts5Buffer pgidx; /* Buffer containing page-index */
  174204. Fts5Buffer term; /* Buffer containing previous term on page */
  174205. };
  174206. struct Fts5DlidxWriter {
  174207. int pgno; /* Page number for this page */
  174208. int bPrevValid; /* True if iPrev is valid */
  174209. i64 iPrev; /* Previous rowid value written to page */
  174210. Fts5Buffer buf; /* Buffer containing page data */
  174211. };
  174212. struct Fts5SegWriter {
  174213. int iSegid; /* Segid to write to */
  174214. Fts5PageWriter writer; /* PageWriter object */
  174215. i64 iPrevRowid; /* Previous rowid written to current leaf */
  174216. u8 bFirstRowidInDoclist; /* True if next rowid is first in doclist */
  174217. u8 bFirstRowidInPage; /* True if next rowid is first in page */
  174218. /* TODO1: Can use (writer.pgidx.n==0) instead of bFirstTermInPage */
  174219. u8 bFirstTermInPage; /* True if next term will be first in leaf */
  174220. int nLeafWritten; /* Number of leaf pages written */
  174221. int nEmpty; /* Number of contiguous term-less nodes */
  174222. int nDlidx; /* Allocated size of aDlidx[] array */
  174223. Fts5DlidxWriter *aDlidx; /* Array of Fts5DlidxWriter objects */
  174224. /* Values to insert into the %_idx table */
  174225. Fts5Buffer btterm; /* Next term to insert into %_idx table */
  174226. int iBtPage; /* Page number corresponding to btterm */
  174227. };
  174228. typedef struct Fts5CResult Fts5CResult;
  174229. struct Fts5CResult {
  174230. u16 iFirst; /* aSeg[] index of firstest iterator */
  174231. u8 bTermEq; /* True if the terms are equal */
  174232. };
  174233. /*
  174234. ** Object for iterating through a single segment, visiting each term/rowid
  174235. ** pair in the segment.
  174236. **
  174237. ** pSeg:
  174238. ** The segment to iterate through.
  174239. **
  174240. ** iLeafPgno:
  174241. ** Current leaf page number within segment.
  174242. **
  174243. ** iLeafOffset:
  174244. ** Byte offset within the current leaf that is the first byte of the
  174245. ** position list data (one byte passed the position-list size field).
  174246. ** rowid field of the current entry. Usually this is the size field of the
  174247. ** position list data. The exception is if the rowid for the current entry
  174248. ** is the last thing on the leaf page.
  174249. **
  174250. ** pLeaf:
  174251. ** Buffer containing current leaf page data. Set to NULL at EOF.
  174252. **
  174253. ** iTermLeafPgno, iTermLeafOffset:
  174254. ** Leaf page number containing the last term read from the segment. And
  174255. ** the offset immediately following the term data.
  174256. **
  174257. ** flags:
  174258. ** Mask of FTS5_SEGITER_XXX values. Interpreted as follows:
  174259. **
  174260. ** FTS5_SEGITER_ONETERM:
  174261. ** If set, set the iterator to point to EOF after the current doclist
  174262. ** has been exhausted. Do not proceed to the next term in the segment.
  174263. **
  174264. ** FTS5_SEGITER_REVERSE:
  174265. ** This flag is only ever set if FTS5_SEGITER_ONETERM is also set. If
  174266. ** it is set, iterate through rowid in descending order instead of the
  174267. ** default ascending order.
  174268. **
  174269. ** iRowidOffset/nRowidOffset/aRowidOffset:
  174270. ** These are used if the FTS5_SEGITER_REVERSE flag is set.
  174271. **
  174272. ** For each rowid on the page corresponding to the current term, the
  174273. ** corresponding aRowidOffset[] entry is set to the byte offset of the
  174274. ** start of the "position-list-size" field within the page.
  174275. **
  174276. ** iTermIdx:
  174277. ** Index of current term on iTermLeafPgno.
  174278. */
  174279. struct Fts5SegIter {
  174280. Fts5StructureSegment *pSeg; /* Segment to iterate through */
  174281. int flags; /* Mask of configuration flags */
  174282. int iLeafPgno; /* Current leaf page number */
  174283. Fts5Data *pLeaf; /* Current leaf data */
  174284. Fts5Data *pNextLeaf; /* Leaf page (iLeafPgno+1) */
  174285. int iLeafOffset; /* Byte offset within current leaf */
  174286. /* Next method */
  174287. void (*xNext)(Fts5Index*, Fts5SegIter*, int*);
  174288. /* The page and offset from which the current term was read. The offset
  174289. ** is the offset of the first rowid in the current doclist. */
  174290. int iTermLeafPgno;
  174291. int iTermLeafOffset;
  174292. int iPgidxOff; /* Next offset in pgidx */
  174293. int iEndofDoclist;
  174294. /* The following are only used if the FTS5_SEGITER_REVERSE flag is set. */
  174295. int iRowidOffset; /* Current entry in aRowidOffset[] */
  174296. int nRowidOffset; /* Allocated size of aRowidOffset[] array */
  174297. int *aRowidOffset; /* Array of offset to rowid fields */
  174298. Fts5DlidxIter *pDlidx; /* If there is a doclist-index */
  174299. /* Variables populated based on current entry. */
  174300. Fts5Buffer term; /* Current term */
  174301. i64 iRowid; /* Current rowid */
  174302. int nPos; /* Number of bytes in current position list */
  174303. u8 bDel; /* True if the delete flag is set */
  174304. };
  174305. /*
  174306. ** Argument is a pointer to an Fts5Data structure that contains a
  174307. ** leaf page.
  174308. */
  174309. #define ASSERT_SZLEAF_OK(x) assert( \
  174310. (x)->szLeaf==(x)->nn || (x)->szLeaf==fts5GetU16(&(x)->p[2]) \
  174311. )
  174312. #define FTS5_SEGITER_ONETERM 0x01
  174313. #define FTS5_SEGITER_REVERSE 0x02
  174314. /*
  174315. ** Argument is a pointer to an Fts5Data structure that contains a leaf
  174316. ** page. This macro evaluates to true if the leaf contains no terms, or
  174317. ** false if it contains at least one term.
  174318. */
  174319. #define fts5LeafIsTermless(x) ((x)->szLeaf >= (x)->nn)
  174320. #define fts5LeafTermOff(x, i) (fts5GetU16(&(x)->p[(x)->szLeaf + (i)*2]))
  174321. #define fts5LeafFirstRowidOff(x) (fts5GetU16((x)->p))
  174322. /*
  174323. ** Object for iterating through the merged results of one or more segments,
  174324. ** visiting each term/rowid pair in the merged data.
  174325. **
  174326. ** nSeg is always a power of two greater than or equal to the number of
  174327. ** segments that this object is merging data from. Both the aSeg[] and
  174328. ** aFirst[] arrays are sized at nSeg entries. The aSeg[] array is padded
  174329. ** with zeroed objects - these are handled as if they were iterators opened
  174330. ** on empty segments.
  174331. **
  174332. ** The results of comparing segments aSeg[N] and aSeg[N+1], where N is an
  174333. ** even number, is stored in aFirst[(nSeg+N)/2]. The "result" of the
  174334. ** comparison in this context is the index of the iterator that currently
  174335. ** points to the smaller term/rowid combination. Iterators at EOF are
  174336. ** considered to be greater than all other iterators.
  174337. **
  174338. ** aFirst[1] contains the index in aSeg[] of the iterator that points to
  174339. ** the smallest key overall. aFirst[0] is unused.
  174340. **
  174341. ** poslist:
  174342. ** Used by sqlite3Fts5IterPoslist() when the poslist needs to be buffered.
  174343. ** There is no way to tell if this is populated or not.
  174344. */
  174345. struct Fts5Iter {
  174346. Fts5IndexIter base; /* Base class containing output vars */
  174347. Fts5Index *pIndex; /* Index that owns this iterator */
  174348. Fts5Structure *pStruct; /* Database structure for this iterator */
  174349. Fts5Buffer poslist; /* Buffer containing current poslist */
  174350. Fts5Colset *pColset; /* Restrict matches to these columns */
  174351. /* Invoked to set output variables. */
  174352. void (*xSetOutputs)(Fts5Iter*, Fts5SegIter*);
  174353. int nSeg; /* Size of aSeg[] array */
  174354. int bRev; /* True to iterate in reverse order */
  174355. u8 bSkipEmpty; /* True to skip deleted entries */
  174356. i64 iSwitchRowid; /* Firstest rowid of other than aFirst[1] */
  174357. Fts5CResult *aFirst; /* Current merge state (see above) */
  174358. Fts5SegIter aSeg[1]; /* Array of segment iterators */
  174359. };
  174360. /*
  174361. ** An instance of the following type is used to iterate through the contents
  174362. ** of a doclist-index record.
  174363. **
  174364. ** pData:
  174365. ** Record containing the doclist-index data.
  174366. **
  174367. ** bEof:
  174368. ** Set to true once iterator has reached EOF.
  174369. **
  174370. ** iOff:
  174371. ** Set to the current offset within record pData.
  174372. */
  174373. struct Fts5DlidxLvl {
  174374. Fts5Data *pData; /* Data for current page of this level */
  174375. int iOff; /* Current offset into pData */
  174376. int bEof; /* At EOF already */
  174377. int iFirstOff; /* Used by reverse iterators */
  174378. /* Output variables */
  174379. int iLeafPgno; /* Page number of current leaf page */
  174380. i64 iRowid; /* First rowid on leaf iLeafPgno */
  174381. };
  174382. struct Fts5DlidxIter {
  174383. int nLvl;
  174384. int iSegid;
  174385. Fts5DlidxLvl aLvl[1];
  174386. };
  174387. static void fts5PutU16(u8 *aOut, u16 iVal){
  174388. aOut[0] = (iVal>>8);
  174389. aOut[1] = (iVal&0xFF);
  174390. }
  174391. static u16 fts5GetU16(const u8 *aIn){
  174392. return ((u16)aIn[0] << 8) + aIn[1];
  174393. }
  174394. /*
  174395. ** Allocate and return a buffer at least nByte bytes in size.
  174396. **
  174397. ** If an OOM error is encountered, return NULL and set the error code in
  174398. ** the Fts5Index handle passed as the first argument.
  174399. */
  174400. static void *fts5IdxMalloc(Fts5Index *p, int nByte){
  174401. return sqlite3Fts5MallocZero(&p->rc, nByte);
  174402. }
  174403. /*
  174404. ** Compare the contents of the pLeft buffer with the pRight/nRight blob.
  174405. **
  174406. ** Return -ve if pLeft is smaller than pRight, 0 if they are equal or
  174407. ** +ve if pRight is smaller than pLeft. In other words:
  174408. **
  174409. ** res = *pLeft - *pRight
  174410. */
  174411. #ifdef SQLITE_DEBUG
  174412. static int fts5BufferCompareBlob(
  174413. Fts5Buffer *pLeft, /* Left hand side of comparison */
  174414. const u8 *pRight, int nRight /* Right hand side of comparison */
  174415. ){
  174416. int nCmp = MIN(pLeft->n, nRight);
  174417. int res = memcmp(pLeft->p, pRight, nCmp);
  174418. return (res==0 ? (pLeft->n - nRight) : res);
  174419. }
  174420. #endif
  174421. /*
  174422. ** Compare the contents of the two buffers using memcmp(). If one buffer
  174423. ** is a prefix of the other, it is considered the lesser.
  174424. **
  174425. ** Return -ve if pLeft is smaller than pRight, 0 if they are equal or
  174426. ** +ve if pRight is smaller than pLeft. In other words:
  174427. **
  174428. ** res = *pLeft - *pRight
  174429. */
  174430. static int fts5BufferCompare(Fts5Buffer *pLeft, Fts5Buffer *pRight){
  174431. int nCmp = MIN(pLeft->n, pRight->n);
  174432. int res = memcmp(pLeft->p, pRight->p, nCmp);
  174433. return (res==0 ? (pLeft->n - pRight->n) : res);
  174434. }
  174435. static int fts5LeafFirstTermOff(Fts5Data *pLeaf){
  174436. int ret;
  174437. fts5GetVarint32(&pLeaf->p[pLeaf->szLeaf], ret);
  174438. return ret;
  174439. }
  174440. /*
  174441. ** Close the read-only blob handle, if it is open.
  174442. */
  174443. static void fts5CloseReader(Fts5Index *p){
  174444. if( p->pReader ){
  174445. sqlite3_blob *pReader = p->pReader;
  174446. p->pReader = 0;
  174447. sqlite3_blob_close(pReader);
  174448. }
  174449. }
  174450. /*
  174451. ** Retrieve a record from the %_data table.
  174452. **
  174453. ** If an error occurs, NULL is returned and an error left in the
  174454. ** Fts5Index object.
  174455. */
  174456. static Fts5Data *fts5DataRead(Fts5Index *p, i64 iRowid){
  174457. Fts5Data *pRet = 0;
  174458. if( p->rc==SQLITE_OK ){
  174459. int rc = SQLITE_OK;
  174460. if( p->pReader ){
  174461. /* This call may return SQLITE_ABORT if there has been a savepoint
  174462. ** rollback since it was last used. In this case a new blob handle
  174463. ** is required. */
  174464. sqlite3_blob *pBlob = p->pReader;
  174465. p->pReader = 0;
  174466. rc = sqlite3_blob_reopen(pBlob, iRowid);
  174467. assert( p->pReader==0 );
  174468. p->pReader = pBlob;
  174469. if( rc!=SQLITE_OK ){
  174470. fts5CloseReader(p);
  174471. }
  174472. if( rc==SQLITE_ABORT ) rc = SQLITE_OK;
  174473. }
  174474. /* If the blob handle is not open at this point, open it and seek
  174475. ** to the requested entry. */
  174476. if( p->pReader==0 && rc==SQLITE_OK ){
  174477. Fts5Config *pConfig = p->pConfig;
  174478. rc = sqlite3_blob_open(pConfig->db,
  174479. pConfig->zDb, p->zDataTbl, "block", iRowid, 0, &p->pReader
  174480. );
  174481. }
  174482. /* If either of the sqlite3_blob_open() or sqlite3_blob_reopen() calls
  174483. ** above returned SQLITE_ERROR, return SQLITE_CORRUPT_VTAB instead.
  174484. ** All the reasons those functions might return SQLITE_ERROR - missing
  174485. ** table, missing row, non-blob/text in block column - indicate
  174486. ** backing store corruption. */
  174487. if( rc==SQLITE_ERROR ) rc = FTS5_CORRUPT;
  174488. if( rc==SQLITE_OK ){
  174489. u8 *aOut = 0; /* Read blob data into this buffer */
  174490. int nByte = sqlite3_blob_bytes(p->pReader);
  174491. int nAlloc = sizeof(Fts5Data) + nByte + FTS5_DATA_PADDING;
  174492. pRet = (Fts5Data*)sqlite3_malloc(nAlloc);
  174493. if( pRet ){
  174494. pRet->nn = nByte;
  174495. aOut = pRet->p = (u8*)&pRet[1];
  174496. }else{
  174497. rc = SQLITE_NOMEM;
  174498. }
  174499. if( rc==SQLITE_OK ){
  174500. rc = sqlite3_blob_read(p->pReader, aOut, nByte, 0);
  174501. }
  174502. if( rc!=SQLITE_OK ){
  174503. sqlite3_free(pRet);
  174504. pRet = 0;
  174505. }else{
  174506. /* TODO1: Fix this */
  174507. pRet->szLeaf = fts5GetU16(&pRet->p[2]);
  174508. }
  174509. }
  174510. p->rc = rc;
  174511. p->nRead++;
  174512. }
  174513. assert( (pRet==0)==(p->rc!=SQLITE_OK) );
  174514. return pRet;
  174515. }
  174516. /*
  174517. ** Release a reference to data record returned by an earlier call to
  174518. ** fts5DataRead().
  174519. */
  174520. static void fts5DataRelease(Fts5Data *pData){
  174521. sqlite3_free(pData);
  174522. }
  174523. static Fts5Data *fts5LeafRead(Fts5Index *p, i64 iRowid){
  174524. Fts5Data *pRet = fts5DataRead(p, iRowid);
  174525. if( pRet ){
  174526. if( pRet->szLeaf>pRet->nn ){
  174527. p->rc = FTS5_CORRUPT;
  174528. fts5DataRelease(pRet);
  174529. pRet = 0;
  174530. }
  174531. }
  174532. return pRet;
  174533. }
  174534. static int fts5IndexPrepareStmt(
  174535. Fts5Index *p,
  174536. sqlite3_stmt **ppStmt,
  174537. char *zSql
  174538. ){
  174539. if( p->rc==SQLITE_OK ){
  174540. if( zSql ){
  174541. p->rc = sqlite3_prepare_v2(p->pConfig->db, zSql, -1, ppStmt, 0);
  174542. }else{
  174543. p->rc = SQLITE_NOMEM;
  174544. }
  174545. }
  174546. sqlite3_free(zSql);
  174547. return p->rc;
  174548. }
  174549. /*
  174550. ** INSERT OR REPLACE a record into the %_data table.
  174551. */
  174552. static void fts5DataWrite(Fts5Index *p, i64 iRowid, const u8 *pData, int nData){
  174553. if( p->rc!=SQLITE_OK ) return;
  174554. if( p->pWriter==0 ){
  174555. Fts5Config *pConfig = p->pConfig;
  174556. fts5IndexPrepareStmt(p, &p->pWriter, sqlite3_mprintf(
  174557. "REPLACE INTO '%q'.'%q_data'(id, block) VALUES(?,?)",
  174558. pConfig->zDb, pConfig->zName
  174559. ));
  174560. if( p->rc ) return;
  174561. }
  174562. sqlite3_bind_int64(p->pWriter, 1, iRowid);
  174563. sqlite3_bind_blob(p->pWriter, 2, pData, nData, SQLITE_STATIC);
  174564. sqlite3_step(p->pWriter);
  174565. p->rc = sqlite3_reset(p->pWriter);
  174566. }
  174567. /*
  174568. ** Execute the following SQL:
  174569. **
  174570. ** DELETE FROM %_data WHERE id BETWEEN $iFirst AND $iLast
  174571. */
  174572. static void fts5DataDelete(Fts5Index *p, i64 iFirst, i64 iLast){
  174573. if( p->rc!=SQLITE_OK ) return;
  174574. if( p->pDeleter==0 ){
  174575. int rc;
  174576. Fts5Config *pConfig = p->pConfig;
  174577. char *zSql = sqlite3_mprintf(
  174578. "DELETE FROM '%q'.'%q_data' WHERE id>=? AND id<=?",
  174579. pConfig->zDb, pConfig->zName
  174580. );
  174581. if( zSql==0 ){
  174582. rc = SQLITE_NOMEM;
  174583. }else{
  174584. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &p->pDeleter, 0);
  174585. sqlite3_free(zSql);
  174586. }
  174587. if( rc!=SQLITE_OK ){
  174588. p->rc = rc;
  174589. return;
  174590. }
  174591. }
  174592. sqlite3_bind_int64(p->pDeleter, 1, iFirst);
  174593. sqlite3_bind_int64(p->pDeleter, 2, iLast);
  174594. sqlite3_step(p->pDeleter);
  174595. p->rc = sqlite3_reset(p->pDeleter);
  174596. }
  174597. /*
  174598. ** Remove all records associated with segment iSegid.
  174599. */
  174600. static void fts5DataRemoveSegment(Fts5Index *p, int iSegid){
  174601. i64 iFirst = FTS5_SEGMENT_ROWID(iSegid, 0);
  174602. i64 iLast = FTS5_SEGMENT_ROWID(iSegid+1, 0)-1;
  174603. fts5DataDelete(p, iFirst, iLast);
  174604. if( p->pIdxDeleter==0 ){
  174605. Fts5Config *pConfig = p->pConfig;
  174606. fts5IndexPrepareStmt(p, &p->pIdxDeleter, sqlite3_mprintf(
  174607. "DELETE FROM '%q'.'%q_idx' WHERE segid=?",
  174608. pConfig->zDb, pConfig->zName
  174609. ));
  174610. }
  174611. if( p->rc==SQLITE_OK ){
  174612. sqlite3_bind_int(p->pIdxDeleter, 1, iSegid);
  174613. sqlite3_step(p->pIdxDeleter);
  174614. p->rc = sqlite3_reset(p->pIdxDeleter);
  174615. }
  174616. }
  174617. /*
  174618. ** Release a reference to an Fts5Structure object returned by an earlier
  174619. ** call to fts5StructureRead() or fts5StructureDecode().
  174620. */
  174621. static void fts5StructureRelease(Fts5Structure *pStruct){
  174622. if( pStruct && 0>=(--pStruct->nRef) ){
  174623. int i;
  174624. assert( pStruct->nRef==0 );
  174625. for(i=0; i<pStruct->nLevel; i++){
  174626. sqlite3_free(pStruct->aLevel[i].aSeg);
  174627. }
  174628. sqlite3_free(pStruct);
  174629. }
  174630. }
  174631. static void fts5StructureRef(Fts5Structure *pStruct){
  174632. pStruct->nRef++;
  174633. }
  174634. /*
  174635. ** Deserialize and return the structure record currently stored in serialized
  174636. ** form within buffer pData/nData.
  174637. **
  174638. ** The Fts5Structure.aLevel[] and each Fts5StructureLevel.aSeg[] array
  174639. ** are over-allocated by one slot. This allows the structure contents
  174640. ** to be more easily edited.
  174641. **
  174642. ** If an error occurs, *ppOut is set to NULL and an SQLite error code
  174643. ** returned. Otherwise, *ppOut is set to point to the new object and
  174644. ** SQLITE_OK returned.
  174645. */
  174646. static int fts5StructureDecode(
  174647. const u8 *pData, /* Buffer containing serialized structure */
  174648. int nData, /* Size of buffer pData in bytes */
  174649. int *piCookie, /* Configuration cookie value */
  174650. Fts5Structure **ppOut /* OUT: Deserialized object */
  174651. ){
  174652. int rc = SQLITE_OK;
  174653. int i = 0;
  174654. int iLvl;
  174655. int nLevel = 0;
  174656. int nSegment = 0;
  174657. int nByte; /* Bytes of space to allocate at pRet */
  174658. Fts5Structure *pRet = 0; /* Structure object to return */
  174659. /* Grab the cookie value */
  174660. if( piCookie ) *piCookie = sqlite3Fts5Get32(pData);
  174661. i = 4;
  174662. /* Read the total number of levels and segments from the start of the
  174663. ** structure record. */
  174664. i += fts5GetVarint32(&pData[i], nLevel);
  174665. i += fts5GetVarint32(&pData[i], nSegment);
  174666. nByte = (
  174667. sizeof(Fts5Structure) + /* Main structure */
  174668. sizeof(Fts5StructureLevel) * (nLevel-1) /* aLevel[] array */
  174669. );
  174670. pRet = (Fts5Structure*)sqlite3Fts5MallocZero(&rc, nByte);
  174671. if( pRet ){
  174672. pRet->nRef = 1;
  174673. pRet->nLevel = nLevel;
  174674. pRet->nSegment = nSegment;
  174675. i += sqlite3Fts5GetVarint(&pData[i], &pRet->nWriteCounter);
  174676. for(iLvl=0; rc==SQLITE_OK && iLvl<nLevel; iLvl++){
  174677. Fts5StructureLevel *pLvl = &pRet->aLevel[iLvl];
  174678. int nTotal = 0;
  174679. int iSeg;
  174680. if( i>=nData ){
  174681. rc = FTS5_CORRUPT;
  174682. }else{
  174683. i += fts5GetVarint32(&pData[i], pLvl->nMerge);
  174684. i += fts5GetVarint32(&pData[i], nTotal);
  174685. assert( nTotal>=pLvl->nMerge );
  174686. pLvl->aSeg = (Fts5StructureSegment*)sqlite3Fts5MallocZero(&rc,
  174687. nTotal * sizeof(Fts5StructureSegment)
  174688. );
  174689. }
  174690. if( rc==SQLITE_OK ){
  174691. pLvl->nSeg = nTotal;
  174692. for(iSeg=0; iSeg<nTotal; iSeg++){
  174693. if( i>=nData ){
  174694. rc = FTS5_CORRUPT;
  174695. break;
  174696. }
  174697. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].iSegid);
  174698. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].pgnoFirst);
  174699. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].pgnoLast);
  174700. }
  174701. }
  174702. }
  174703. if( rc!=SQLITE_OK ){
  174704. fts5StructureRelease(pRet);
  174705. pRet = 0;
  174706. }
  174707. }
  174708. *ppOut = pRet;
  174709. return rc;
  174710. }
  174711. /*
  174712. **
  174713. */
  174714. static void fts5StructureAddLevel(int *pRc, Fts5Structure **ppStruct){
  174715. if( *pRc==SQLITE_OK ){
  174716. Fts5Structure *pStruct = *ppStruct;
  174717. int nLevel = pStruct->nLevel;
  174718. int nByte = (
  174719. sizeof(Fts5Structure) + /* Main structure */
  174720. sizeof(Fts5StructureLevel) * (nLevel+1) /* aLevel[] array */
  174721. );
  174722. pStruct = sqlite3_realloc(pStruct, nByte);
  174723. if( pStruct ){
  174724. memset(&pStruct->aLevel[nLevel], 0, sizeof(Fts5StructureLevel));
  174725. pStruct->nLevel++;
  174726. *ppStruct = pStruct;
  174727. }else{
  174728. *pRc = SQLITE_NOMEM;
  174729. }
  174730. }
  174731. }
  174732. /*
  174733. ** Extend level iLvl so that there is room for at least nExtra more
  174734. ** segments.
  174735. */
  174736. static void fts5StructureExtendLevel(
  174737. int *pRc,
  174738. Fts5Structure *pStruct,
  174739. int iLvl,
  174740. int nExtra,
  174741. int bInsert
  174742. ){
  174743. if( *pRc==SQLITE_OK ){
  174744. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  174745. Fts5StructureSegment *aNew;
  174746. int nByte;
  174747. nByte = (pLvl->nSeg + nExtra) * sizeof(Fts5StructureSegment);
  174748. aNew = sqlite3_realloc(pLvl->aSeg, nByte);
  174749. if( aNew ){
  174750. if( bInsert==0 ){
  174751. memset(&aNew[pLvl->nSeg], 0, sizeof(Fts5StructureSegment) * nExtra);
  174752. }else{
  174753. int nMove = pLvl->nSeg * sizeof(Fts5StructureSegment);
  174754. memmove(&aNew[nExtra], aNew, nMove);
  174755. memset(aNew, 0, sizeof(Fts5StructureSegment) * nExtra);
  174756. }
  174757. pLvl->aSeg = aNew;
  174758. }else{
  174759. *pRc = SQLITE_NOMEM;
  174760. }
  174761. }
  174762. }
  174763. static Fts5Structure *fts5StructureReadUncached(Fts5Index *p){
  174764. Fts5Structure *pRet = 0;
  174765. Fts5Config *pConfig = p->pConfig;
  174766. int iCookie; /* Configuration cookie */
  174767. Fts5Data *pData;
  174768. pData = fts5DataRead(p, FTS5_STRUCTURE_ROWID);
  174769. if( p->rc==SQLITE_OK ){
  174770. /* TODO: Do we need this if the leaf-index is appended? Probably... */
  174771. memset(&pData->p[pData->nn], 0, FTS5_DATA_PADDING);
  174772. p->rc = fts5StructureDecode(pData->p, pData->nn, &iCookie, &pRet);
  174773. if( p->rc==SQLITE_OK && pConfig->iCookie!=iCookie ){
  174774. p->rc = sqlite3Fts5ConfigLoad(pConfig, iCookie);
  174775. }
  174776. fts5DataRelease(pData);
  174777. if( p->rc!=SQLITE_OK ){
  174778. fts5StructureRelease(pRet);
  174779. pRet = 0;
  174780. }
  174781. }
  174782. return pRet;
  174783. }
  174784. static i64 fts5IndexDataVersion(Fts5Index *p){
  174785. i64 iVersion = 0;
  174786. if( p->rc==SQLITE_OK ){
  174787. if( p->pDataVersion==0 ){
  174788. p->rc = fts5IndexPrepareStmt(p, &p->pDataVersion,
  174789. sqlite3_mprintf("PRAGMA %Q.data_version", p->pConfig->zDb)
  174790. );
  174791. if( p->rc ) return 0;
  174792. }
  174793. if( SQLITE_ROW==sqlite3_step(p->pDataVersion) ){
  174794. iVersion = sqlite3_column_int64(p->pDataVersion, 0);
  174795. }
  174796. p->rc = sqlite3_reset(p->pDataVersion);
  174797. }
  174798. return iVersion;
  174799. }
  174800. /*
  174801. ** Read, deserialize and return the structure record.
  174802. **
  174803. ** The Fts5Structure.aLevel[] and each Fts5StructureLevel.aSeg[] array
  174804. ** are over-allocated as described for function fts5StructureDecode()
  174805. ** above.
  174806. **
  174807. ** If an error occurs, NULL is returned and an error code left in the
  174808. ** Fts5Index handle. If an error has already occurred when this function
  174809. ** is called, it is a no-op.
  174810. */
  174811. static Fts5Structure *fts5StructureRead(Fts5Index *p){
  174812. if( p->pStruct==0 ){
  174813. p->iStructVersion = fts5IndexDataVersion(p);
  174814. if( p->rc==SQLITE_OK ){
  174815. p->pStruct = fts5StructureReadUncached(p);
  174816. }
  174817. }
  174818. #if 0
  174819. else{
  174820. Fts5Structure *pTest = fts5StructureReadUncached(p);
  174821. if( pTest ){
  174822. int i, j;
  174823. assert_nc( p->pStruct->nSegment==pTest->nSegment );
  174824. assert_nc( p->pStruct->nLevel==pTest->nLevel );
  174825. for(i=0; i<pTest->nLevel; i++){
  174826. assert_nc( p->pStruct->aLevel[i].nMerge==pTest->aLevel[i].nMerge );
  174827. assert_nc( p->pStruct->aLevel[i].nSeg==pTest->aLevel[i].nSeg );
  174828. for(j=0; j<pTest->aLevel[i].nSeg; j++){
  174829. Fts5StructureSegment *p1 = &pTest->aLevel[i].aSeg[j];
  174830. Fts5StructureSegment *p2 = &p->pStruct->aLevel[i].aSeg[j];
  174831. assert_nc( p1->iSegid==p2->iSegid );
  174832. assert_nc( p1->pgnoFirst==p2->pgnoFirst );
  174833. assert_nc( p1->pgnoLast==p2->pgnoLast );
  174834. }
  174835. }
  174836. fts5StructureRelease(pTest);
  174837. }
  174838. }
  174839. #endif
  174840. if( p->rc!=SQLITE_OK ) return 0;
  174841. assert( p->iStructVersion!=0 );
  174842. assert( p->pStruct!=0 );
  174843. fts5StructureRef(p->pStruct);
  174844. return p->pStruct;
  174845. }
  174846. static void fts5StructureInvalidate(Fts5Index *p){
  174847. if( p->pStruct ){
  174848. fts5StructureRelease(p->pStruct);
  174849. p->pStruct = 0;
  174850. }
  174851. }
  174852. /*
  174853. ** Return the total number of segments in index structure pStruct. This
  174854. ** function is only ever used as part of assert() conditions.
  174855. */
  174856. #ifdef SQLITE_DEBUG
  174857. static int fts5StructureCountSegments(Fts5Structure *pStruct){
  174858. int nSegment = 0; /* Total number of segments */
  174859. if( pStruct ){
  174860. int iLvl; /* Used to iterate through levels */
  174861. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  174862. nSegment += pStruct->aLevel[iLvl].nSeg;
  174863. }
  174864. }
  174865. return nSegment;
  174866. }
  174867. #endif
  174868. #define fts5BufferSafeAppendBlob(pBuf, pBlob, nBlob) { \
  174869. assert( (pBuf)->nSpace>=((pBuf)->n+nBlob) ); \
  174870. memcpy(&(pBuf)->p[(pBuf)->n], pBlob, nBlob); \
  174871. (pBuf)->n += nBlob; \
  174872. }
  174873. #define fts5BufferSafeAppendVarint(pBuf, iVal) { \
  174874. (pBuf)->n += sqlite3Fts5PutVarint(&(pBuf)->p[(pBuf)->n], (iVal)); \
  174875. assert( (pBuf)->nSpace>=(pBuf)->n ); \
  174876. }
  174877. /*
  174878. ** Serialize and store the "structure" record.
  174879. **
  174880. ** If an error occurs, leave an error code in the Fts5Index object. If an
  174881. ** error has already occurred, this function is a no-op.
  174882. */
  174883. static void fts5StructureWrite(Fts5Index *p, Fts5Structure *pStruct){
  174884. if( p->rc==SQLITE_OK ){
  174885. Fts5Buffer buf; /* Buffer to serialize record into */
  174886. int iLvl; /* Used to iterate through levels */
  174887. int iCookie; /* Cookie value to store */
  174888. assert( pStruct->nSegment==fts5StructureCountSegments(pStruct) );
  174889. memset(&buf, 0, sizeof(Fts5Buffer));
  174890. /* Append the current configuration cookie */
  174891. iCookie = p->pConfig->iCookie;
  174892. if( iCookie<0 ) iCookie = 0;
  174893. if( 0==sqlite3Fts5BufferSize(&p->rc, &buf, 4+9+9+9) ){
  174894. sqlite3Fts5Put32(buf.p, iCookie);
  174895. buf.n = 4;
  174896. fts5BufferSafeAppendVarint(&buf, pStruct->nLevel);
  174897. fts5BufferSafeAppendVarint(&buf, pStruct->nSegment);
  174898. fts5BufferSafeAppendVarint(&buf, (i64)pStruct->nWriteCounter);
  174899. }
  174900. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  174901. int iSeg; /* Used to iterate through segments */
  174902. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  174903. fts5BufferAppendVarint(&p->rc, &buf, pLvl->nMerge);
  174904. fts5BufferAppendVarint(&p->rc, &buf, pLvl->nSeg);
  174905. assert( pLvl->nMerge<=pLvl->nSeg );
  174906. for(iSeg=0; iSeg<pLvl->nSeg; iSeg++){
  174907. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].iSegid);
  174908. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].pgnoFirst);
  174909. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].pgnoLast);
  174910. }
  174911. }
  174912. fts5DataWrite(p, FTS5_STRUCTURE_ROWID, buf.p, buf.n);
  174913. fts5BufferFree(&buf);
  174914. }
  174915. }
  174916. #if 0
  174917. static void fts5DebugStructure(int*,Fts5Buffer*,Fts5Structure*);
  174918. static void fts5PrintStructure(const char *zCaption, Fts5Structure *pStruct){
  174919. int rc = SQLITE_OK;
  174920. Fts5Buffer buf;
  174921. memset(&buf, 0, sizeof(buf));
  174922. fts5DebugStructure(&rc, &buf, pStruct);
  174923. fprintf(stdout, "%s: %s\n", zCaption, buf.p);
  174924. fflush(stdout);
  174925. fts5BufferFree(&buf);
  174926. }
  174927. #else
  174928. # define fts5PrintStructure(x,y)
  174929. #endif
  174930. static int fts5SegmentSize(Fts5StructureSegment *pSeg){
  174931. return 1 + pSeg->pgnoLast - pSeg->pgnoFirst;
  174932. }
  174933. /*
  174934. ** Return a copy of index structure pStruct. Except, promote as many
  174935. ** segments as possible to level iPromote. If an OOM occurs, NULL is
  174936. ** returned.
  174937. */
  174938. static void fts5StructurePromoteTo(
  174939. Fts5Index *p,
  174940. int iPromote,
  174941. int szPromote,
  174942. Fts5Structure *pStruct
  174943. ){
  174944. int il, is;
  174945. Fts5StructureLevel *pOut = &pStruct->aLevel[iPromote];
  174946. if( pOut->nMerge==0 ){
  174947. for(il=iPromote+1; il<pStruct->nLevel; il++){
  174948. Fts5StructureLevel *pLvl = &pStruct->aLevel[il];
  174949. if( pLvl->nMerge ) return;
  174950. for(is=pLvl->nSeg-1; is>=0; is--){
  174951. int sz = fts5SegmentSize(&pLvl->aSeg[is]);
  174952. if( sz>szPromote ) return;
  174953. fts5StructureExtendLevel(&p->rc, pStruct, iPromote, 1, 1);
  174954. if( p->rc ) return;
  174955. memcpy(pOut->aSeg, &pLvl->aSeg[is], sizeof(Fts5StructureSegment));
  174956. pOut->nSeg++;
  174957. pLvl->nSeg--;
  174958. }
  174959. }
  174960. }
  174961. }
  174962. /*
  174963. ** A new segment has just been written to level iLvl of index structure
  174964. ** pStruct. This function determines if any segments should be promoted
  174965. ** as a result. Segments are promoted in two scenarios:
  174966. **
  174967. ** a) If the segment just written is smaller than one or more segments
  174968. ** within the previous populated level, it is promoted to the previous
  174969. ** populated level.
  174970. **
  174971. ** b) If the segment just written is larger than the newest segment on
  174972. ** the next populated level, then that segment, and any other adjacent
  174973. ** segments that are also smaller than the one just written, are
  174974. ** promoted.
  174975. **
  174976. ** If one or more segments are promoted, the structure object is updated
  174977. ** to reflect this.
  174978. */
  174979. static void fts5StructurePromote(
  174980. Fts5Index *p, /* FTS5 backend object */
  174981. int iLvl, /* Index level just updated */
  174982. Fts5Structure *pStruct /* Index structure */
  174983. ){
  174984. if( p->rc==SQLITE_OK ){
  174985. int iTst;
  174986. int iPromote = -1;
  174987. int szPromote = 0; /* Promote anything this size or smaller */
  174988. Fts5StructureSegment *pSeg; /* Segment just written */
  174989. int szSeg; /* Size of segment just written */
  174990. int nSeg = pStruct->aLevel[iLvl].nSeg;
  174991. if( nSeg==0 ) return;
  174992. pSeg = &pStruct->aLevel[iLvl].aSeg[pStruct->aLevel[iLvl].nSeg-1];
  174993. szSeg = (1 + pSeg->pgnoLast - pSeg->pgnoFirst);
  174994. /* Check for condition (a) */
  174995. for(iTst=iLvl-1; iTst>=0 && pStruct->aLevel[iTst].nSeg==0; iTst--);
  174996. if( iTst>=0 ){
  174997. int i;
  174998. int szMax = 0;
  174999. Fts5StructureLevel *pTst = &pStruct->aLevel[iTst];
  175000. assert( pTst->nMerge==0 );
  175001. for(i=0; i<pTst->nSeg; i++){
  175002. int sz = pTst->aSeg[i].pgnoLast - pTst->aSeg[i].pgnoFirst + 1;
  175003. if( sz>szMax ) szMax = sz;
  175004. }
  175005. if( szMax>=szSeg ){
  175006. /* Condition (a) is true. Promote the newest segment on level
  175007. ** iLvl to level iTst. */
  175008. iPromote = iTst;
  175009. szPromote = szMax;
  175010. }
  175011. }
  175012. /* If condition (a) is not met, assume (b) is true. StructurePromoteTo()
  175013. ** is a no-op if it is not. */
  175014. if( iPromote<0 ){
  175015. iPromote = iLvl;
  175016. szPromote = szSeg;
  175017. }
  175018. fts5StructurePromoteTo(p, iPromote, szPromote, pStruct);
  175019. }
  175020. }
  175021. /*
  175022. ** Advance the iterator passed as the only argument. If the end of the
  175023. ** doclist-index page is reached, return non-zero.
  175024. */
  175025. static int fts5DlidxLvlNext(Fts5DlidxLvl *pLvl){
  175026. Fts5Data *pData = pLvl->pData;
  175027. if( pLvl->iOff==0 ){
  175028. assert( pLvl->bEof==0 );
  175029. pLvl->iOff = 1;
  175030. pLvl->iOff += fts5GetVarint32(&pData->p[1], pLvl->iLeafPgno);
  175031. pLvl->iOff += fts5GetVarint(&pData->p[pLvl->iOff], (u64*)&pLvl->iRowid);
  175032. pLvl->iFirstOff = pLvl->iOff;
  175033. }else{
  175034. int iOff;
  175035. for(iOff=pLvl->iOff; iOff<pData->nn; iOff++){
  175036. if( pData->p[iOff] ) break;
  175037. }
  175038. if( iOff<pData->nn ){
  175039. i64 iVal;
  175040. pLvl->iLeafPgno += (iOff - pLvl->iOff) + 1;
  175041. iOff += fts5GetVarint(&pData->p[iOff], (u64*)&iVal);
  175042. pLvl->iRowid += iVal;
  175043. pLvl->iOff = iOff;
  175044. }else{
  175045. pLvl->bEof = 1;
  175046. }
  175047. }
  175048. return pLvl->bEof;
  175049. }
  175050. /*
  175051. ** Advance the iterator passed as the only argument.
  175052. */
  175053. static int fts5DlidxIterNextR(Fts5Index *p, Fts5DlidxIter *pIter, int iLvl){
  175054. Fts5DlidxLvl *pLvl = &pIter->aLvl[iLvl];
  175055. assert( iLvl<pIter->nLvl );
  175056. if( fts5DlidxLvlNext(pLvl) ){
  175057. if( (iLvl+1) < pIter->nLvl ){
  175058. fts5DlidxIterNextR(p, pIter, iLvl+1);
  175059. if( pLvl[1].bEof==0 ){
  175060. fts5DataRelease(pLvl->pData);
  175061. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  175062. pLvl->pData = fts5DataRead(p,
  175063. FTS5_DLIDX_ROWID(pIter->iSegid, iLvl, pLvl[1].iLeafPgno)
  175064. );
  175065. if( pLvl->pData ) fts5DlidxLvlNext(pLvl);
  175066. }
  175067. }
  175068. }
  175069. return pIter->aLvl[0].bEof;
  175070. }
  175071. static int fts5DlidxIterNext(Fts5Index *p, Fts5DlidxIter *pIter){
  175072. return fts5DlidxIterNextR(p, pIter, 0);
  175073. }
  175074. /*
  175075. ** The iterator passed as the first argument has the following fields set
  175076. ** as follows. This function sets up the rest of the iterator so that it
  175077. ** points to the first rowid in the doclist-index.
  175078. **
  175079. ** pData:
  175080. ** pointer to doclist-index record,
  175081. **
  175082. ** When this function is called pIter->iLeafPgno is the page number the
  175083. ** doclist is associated with (the one featuring the term).
  175084. */
  175085. static int fts5DlidxIterFirst(Fts5DlidxIter *pIter){
  175086. int i;
  175087. for(i=0; i<pIter->nLvl; i++){
  175088. fts5DlidxLvlNext(&pIter->aLvl[i]);
  175089. }
  175090. return pIter->aLvl[0].bEof;
  175091. }
  175092. static int fts5DlidxIterEof(Fts5Index *p, Fts5DlidxIter *pIter){
  175093. return p->rc!=SQLITE_OK || pIter->aLvl[0].bEof;
  175094. }
  175095. static void fts5DlidxIterLast(Fts5Index *p, Fts5DlidxIter *pIter){
  175096. int i;
  175097. /* Advance each level to the last entry on the last page */
  175098. for(i=pIter->nLvl-1; p->rc==SQLITE_OK && i>=0; i--){
  175099. Fts5DlidxLvl *pLvl = &pIter->aLvl[i];
  175100. while( fts5DlidxLvlNext(pLvl)==0 );
  175101. pLvl->bEof = 0;
  175102. if( i>0 ){
  175103. Fts5DlidxLvl *pChild = &pLvl[-1];
  175104. fts5DataRelease(pChild->pData);
  175105. memset(pChild, 0, sizeof(Fts5DlidxLvl));
  175106. pChild->pData = fts5DataRead(p,
  175107. FTS5_DLIDX_ROWID(pIter->iSegid, i-1, pLvl->iLeafPgno)
  175108. );
  175109. }
  175110. }
  175111. }
  175112. /*
  175113. ** Move the iterator passed as the only argument to the previous entry.
  175114. */
  175115. static int fts5DlidxLvlPrev(Fts5DlidxLvl *pLvl){
  175116. int iOff = pLvl->iOff;
  175117. assert( pLvl->bEof==0 );
  175118. if( iOff<=pLvl->iFirstOff ){
  175119. pLvl->bEof = 1;
  175120. }else{
  175121. u8 *a = pLvl->pData->p;
  175122. i64 iVal;
  175123. int iLimit;
  175124. int ii;
  175125. int nZero = 0;
  175126. /* Currently iOff points to the first byte of a varint. This block
  175127. ** decrements iOff until it points to the first byte of the previous
  175128. ** varint. Taking care not to read any memory locations that occur
  175129. ** before the buffer in memory. */
  175130. iLimit = (iOff>9 ? iOff-9 : 0);
  175131. for(iOff--; iOff>iLimit; iOff--){
  175132. if( (a[iOff-1] & 0x80)==0 ) break;
  175133. }
  175134. fts5GetVarint(&a[iOff], (u64*)&iVal);
  175135. pLvl->iRowid -= iVal;
  175136. pLvl->iLeafPgno--;
  175137. /* Skip backwards past any 0x00 varints. */
  175138. for(ii=iOff-1; ii>=pLvl->iFirstOff && a[ii]==0x00; ii--){
  175139. nZero++;
  175140. }
  175141. if( ii>=pLvl->iFirstOff && (a[ii] & 0x80) ){
  175142. /* The byte immediately before the last 0x00 byte has the 0x80 bit
  175143. ** set. So the last 0x00 is only a varint 0 if there are 8 more 0x80
  175144. ** bytes before a[ii]. */
  175145. int bZero = 0; /* True if last 0x00 counts */
  175146. if( (ii-8)>=pLvl->iFirstOff ){
  175147. int j;
  175148. for(j=1; j<=8 && (a[ii-j] & 0x80); j++);
  175149. bZero = (j>8);
  175150. }
  175151. if( bZero==0 ) nZero--;
  175152. }
  175153. pLvl->iLeafPgno -= nZero;
  175154. pLvl->iOff = iOff - nZero;
  175155. }
  175156. return pLvl->bEof;
  175157. }
  175158. static int fts5DlidxIterPrevR(Fts5Index *p, Fts5DlidxIter *pIter, int iLvl){
  175159. Fts5DlidxLvl *pLvl = &pIter->aLvl[iLvl];
  175160. assert( iLvl<pIter->nLvl );
  175161. if( fts5DlidxLvlPrev(pLvl) ){
  175162. if( (iLvl+1) < pIter->nLvl ){
  175163. fts5DlidxIterPrevR(p, pIter, iLvl+1);
  175164. if( pLvl[1].bEof==0 ){
  175165. fts5DataRelease(pLvl->pData);
  175166. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  175167. pLvl->pData = fts5DataRead(p,
  175168. FTS5_DLIDX_ROWID(pIter->iSegid, iLvl, pLvl[1].iLeafPgno)
  175169. );
  175170. if( pLvl->pData ){
  175171. while( fts5DlidxLvlNext(pLvl)==0 );
  175172. pLvl->bEof = 0;
  175173. }
  175174. }
  175175. }
  175176. }
  175177. return pIter->aLvl[0].bEof;
  175178. }
  175179. static int fts5DlidxIterPrev(Fts5Index *p, Fts5DlidxIter *pIter){
  175180. return fts5DlidxIterPrevR(p, pIter, 0);
  175181. }
  175182. /*
  175183. ** Free a doclist-index iterator object allocated by fts5DlidxIterInit().
  175184. */
  175185. static void fts5DlidxIterFree(Fts5DlidxIter *pIter){
  175186. if( pIter ){
  175187. int i;
  175188. for(i=0; i<pIter->nLvl; i++){
  175189. fts5DataRelease(pIter->aLvl[i].pData);
  175190. }
  175191. sqlite3_free(pIter);
  175192. }
  175193. }
  175194. static Fts5DlidxIter *fts5DlidxIterInit(
  175195. Fts5Index *p, /* Fts5 Backend to iterate within */
  175196. int bRev, /* True for ORDER BY ASC */
  175197. int iSegid, /* Segment id */
  175198. int iLeafPg /* Leaf page number to load dlidx for */
  175199. ){
  175200. Fts5DlidxIter *pIter = 0;
  175201. int i;
  175202. int bDone = 0;
  175203. for(i=0; p->rc==SQLITE_OK && bDone==0; i++){
  175204. int nByte = sizeof(Fts5DlidxIter) + i * sizeof(Fts5DlidxLvl);
  175205. Fts5DlidxIter *pNew;
  175206. pNew = (Fts5DlidxIter*)sqlite3_realloc(pIter, nByte);
  175207. if( pNew==0 ){
  175208. p->rc = SQLITE_NOMEM;
  175209. }else{
  175210. i64 iRowid = FTS5_DLIDX_ROWID(iSegid, i, iLeafPg);
  175211. Fts5DlidxLvl *pLvl = &pNew->aLvl[i];
  175212. pIter = pNew;
  175213. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  175214. pLvl->pData = fts5DataRead(p, iRowid);
  175215. if( pLvl->pData && (pLvl->pData->p[0] & 0x0001)==0 ){
  175216. bDone = 1;
  175217. }
  175218. pIter->nLvl = i+1;
  175219. }
  175220. }
  175221. if( p->rc==SQLITE_OK ){
  175222. pIter->iSegid = iSegid;
  175223. if( bRev==0 ){
  175224. fts5DlidxIterFirst(pIter);
  175225. }else{
  175226. fts5DlidxIterLast(p, pIter);
  175227. }
  175228. }
  175229. if( p->rc!=SQLITE_OK ){
  175230. fts5DlidxIterFree(pIter);
  175231. pIter = 0;
  175232. }
  175233. return pIter;
  175234. }
  175235. static i64 fts5DlidxIterRowid(Fts5DlidxIter *pIter){
  175236. return pIter->aLvl[0].iRowid;
  175237. }
  175238. static int fts5DlidxIterPgno(Fts5DlidxIter *pIter){
  175239. return pIter->aLvl[0].iLeafPgno;
  175240. }
  175241. /*
  175242. ** Load the next leaf page into the segment iterator.
  175243. */
  175244. static void fts5SegIterNextPage(
  175245. Fts5Index *p, /* FTS5 backend object */
  175246. Fts5SegIter *pIter /* Iterator to advance to next page */
  175247. ){
  175248. Fts5Data *pLeaf;
  175249. Fts5StructureSegment *pSeg = pIter->pSeg;
  175250. fts5DataRelease(pIter->pLeaf);
  175251. pIter->iLeafPgno++;
  175252. if( pIter->pNextLeaf ){
  175253. pIter->pLeaf = pIter->pNextLeaf;
  175254. pIter->pNextLeaf = 0;
  175255. }else if( pIter->iLeafPgno<=pSeg->pgnoLast ){
  175256. pIter->pLeaf = fts5LeafRead(p,
  175257. FTS5_SEGMENT_ROWID(pSeg->iSegid, pIter->iLeafPgno)
  175258. );
  175259. }else{
  175260. pIter->pLeaf = 0;
  175261. }
  175262. pLeaf = pIter->pLeaf;
  175263. if( pLeaf ){
  175264. pIter->iPgidxOff = pLeaf->szLeaf;
  175265. if( fts5LeafIsTermless(pLeaf) ){
  175266. pIter->iEndofDoclist = pLeaf->nn+1;
  175267. }else{
  175268. pIter->iPgidxOff += fts5GetVarint32(&pLeaf->p[pIter->iPgidxOff],
  175269. pIter->iEndofDoclist
  175270. );
  175271. }
  175272. }
  175273. }
  175274. /*
  175275. ** Argument p points to a buffer containing a varint to be interpreted as a
  175276. ** position list size field. Read the varint and return the number of bytes
  175277. ** read. Before returning, set *pnSz to the number of bytes in the position
  175278. ** list, and *pbDel to true if the delete flag is set, or false otherwise.
  175279. */
  175280. static int fts5GetPoslistSize(const u8 *p, int *pnSz, int *pbDel){
  175281. int nSz;
  175282. int n = 0;
  175283. fts5FastGetVarint32(p, n, nSz);
  175284. assert_nc( nSz>=0 );
  175285. *pnSz = nSz/2;
  175286. *pbDel = nSz & 0x0001;
  175287. return n;
  175288. }
  175289. /*
  175290. ** Fts5SegIter.iLeafOffset currently points to the first byte of a
  175291. ** position-list size field. Read the value of the field and store it
  175292. ** in the following variables:
  175293. **
  175294. ** Fts5SegIter.nPos
  175295. ** Fts5SegIter.bDel
  175296. **
  175297. ** Leave Fts5SegIter.iLeafOffset pointing to the first byte of the
  175298. ** position list content (if any).
  175299. */
  175300. static void fts5SegIterLoadNPos(Fts5Index *p, Fts5SegIter *pIter){
  175301. if( p->rc==SQLITE_OK ){
  175302. int iOff = pIter->iLeafOffset; /* Offset to read at */
  175303. ASSERT_SZLEAF_OK(pIter->pLeaf);
  175304. if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  175305. int iEod = MIN(pIter->iEndofDoclist, pIter->pLeaf->szLeaf);
  175306. pIter->bDel = 0;
  175307. pIter->nPos = 1;
  175308. if( iOff<iEod && pIter->pLeaf->p[iOff]==0 ){
  175309. pIter->bDel = 1;
  175310. iOff++;
  175311. if( iOff<iEod && pIter->pLeaf->p[iOff]==0 ){
  175312. pIter->nPos = 1;
  175313. iOff++;
  175314. }else{
  175315. pIter->nPos = 0;
  175316. }
  175317. }
  175318. }else{
  175319. int nSz;
  175320. fts5FastGetVarint32(pIter->pLeaf->p, iOff, nSz);
  175321. pIter->bDel = (nSz & 0x0001);
  175322. pIter->nPos = nSz>>1;
  175323. assert_nc( pIter->nPos>=0 );
  175324. }
  175325. pIter->iLeafOffset = iOff;
  175326. }
  175327. }
  175328. static void fts5SegIterLoadRowid(Fts5Index *p, Fts5SegIter *pIter){
  175329. u8 *a = pIter->pLeaf->p; /* Buffer to read data from */
  175330. int iOff = pIter->iLeafOffset;
  175331. ASSERT_SZLEAF_OK(pIter->pLeaf);
  175332. if( iOff>=pIter->pLeaf->szLeaf ){
  175333. fts5SegIterNextPage(p, pIter);
  175334. if( pIter->pLeaf==0 ){
  175335. if( p->rc==SQLITE_OK ) p->rc = FTS5_CORRUPT;
  175336. return;
  175337. }
  175338. iOff = 4;
  175339. a = pIter->pLeaf->p;
  175340. }
  175341. iOff += sqlite3Fts5GetVarint(&a[iOff], (u64*)&pIter->iRowid);
  175342. pIter->iLeafOffset = iOff;
  175343. }
  175344. /*
  175345. ** Fts5SegIter.iLeafOffset currently points to the first byte of the
  175346. ** "nSuffix" field of a term. Function parameter nKeep contains the value
  175347. ** of the "nPrefix" field (if there was one - it is passed 0 if this is
  175348. ** the first term in the segment).
  175349. **
  175350. ** This function populates:
  175351. **
  175352. ** Fts5SegIter.term
  175353. ** Fts5SegIter.rowid
  175354. **
  175355. ** accordingly and leaves (Fts5SegIter.iLeafOffset) set to the content of
  175356. ** the first position list. The position list belonging to document
  175357. ** (Fts5SegIter.iRowid).
  175358. */
  175359. static void fts5SegIterLoadTerm(Fts5Index *p, Fts5SegIter *pIter, int nKeep){
  175360. u8 *a = pIter->pLeaf->p; /* Buffer to read data from */
  175361. int iOff = pIter->iLeafOffset; /* Offset to read at */
  175362. int nNew; /* Bytes of new data */
  175363. iOff += fts5GetVarint32(&a[iOff], nNew);
  175364. if( iOff+nNew>pIter->pLeaf->nn ){
  175365. p->rc = FTS5_CORRUPT;
  175366. return;
  175367. }
  175368. pIter->term.n = nKeep;
  175369. fts5BufferAppendBlob(&p->rc, &pIter->term, nNew, &a[iOff]);
  175370. iOff += nNew;
  175371. pIter->iTermLeafOffset = iOff;
  175372. pIter->iTermLeafPgno = pIter->iLeafPgno;
  175373. pIter->iLeafOffset = iOff;
  175374. if( pIter->iPgidxOff>=pIter->pLeaf->nn ){
  175375. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  175376. }else{
  175377. int nExtra;
  175378. pIter->iPgidxOff += fts5GetVarint32(&a[pIter->iPgidxOff], nExtra);
  175379. pIter->iEndofDoclist += nExtra;
  175380. }
  175381. fts5SegIterLoadRowid(p, pIter);
  175382. }
  175383. static void fts5SegIterNext(Fts5Index*, Fts5SegIter*, int*);
  175384. static void fts5SegIterNext_Reverse(Fts5Index*, Fts5SegIter*, int*);
  175385. static void fts5SegIterNext_None(Fts5Index*, Fts5SegIter*, int*);
  175386. static void fts5SegIterSetNext(Fts5Index *p, Fts5SegIter *pIter){
  175387. if( pIter->flags & FTS5_SEGITER_REVERSE ){
  175388. pIter->xNext = fts5SegIterNext_Reverse;
  175389. }else if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  175390. pIter->xNext = fts5SegIterNext_None;
  175391. }else{
  175392. pIter->xNext = fts5SegIterNext;
  175393. }
  175394. }
  175395. /*
  175396. ** Initialize the iterator object pIter to iterate through the entries in
  175397. ** segment pSeg. The iterator is left pointing to the first entry when
  175398. ** this function returns.
  175399. **
  175400. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  175401. ** an error has already occurred when this function is called, it is a no-op.
  175402. */
  175403. static void fts5SegIterInit(
  175404. Fts5Index *p, /* FTS index object */
  175405. Fts5StructureSegment *pSeg, /* Description of segment */
  175406. Fts5SegIter *pIter /* Object to populate */
  175407. ){
  175408. if( pSeg->pgnoFirst==0 ){
  175409. /* This happens if the segment is being used as an input to an incremental
  175410. ** merge and all data has already been "trimmed". See function
  175411. ** fts5TrimSegments() for details. In this case leave the iterator empty.
  175412. ** The caller will see the (pIter->pLeaf==0) and assume the iterator is
  175413. ** at EOF already. */
  175414. assert( pIter->pLeaf==0 );
  175415. return;
  175416. }
  175417. if( p->rc==SQLITE_OK ){
  175418. memset(pIter, 0, sizeof(*pIter));
  175419. fts5SegIterSetNext(p, pIter);
  175420. pIter->pSeg = pSeg;
  175421. pIter->iLeafPgno = pSeg->pgnoFirst-1;
  175422. fts5SegIterNextPage(p, pIter);
  175423. }
  175424. if( p->rc==SQLITE_OK ){
  175425. pIter->iLeafOffset = 4;
  175426. assert_nc( pIter->pLeaf->nn>4 );
  175427. assert( fts5LeafFirstTermOff(pIter->pLeaf)==4 );
  175428. pIter->iPgidxOff = pIter->pLeaf->szLeaf+1;
  175429. fts5SegIterLoadTerm(p, pIter, 0);
  175430. fts5SegIterLoadNPos(p, pIter);
  175431. }
  175432. }
  175433. /*
  175434. ** This function is only ever called on iterators created by calls to
  175435. ** Fts5IndexQuery() with the FTS5INDEX_QUERY_DESC flag set.
  175436. **
  175437. ** The iterator is in an unusual state when this function is called: the
  175438. ** Fts5SegIter.iLeafOffset variable is set to the offset of the start of
  175439. ** the position-list size field for the first relevant rowid on the page.
  175440. ** Fts5SegIter.rowid is set, but nPos and bDel are not.
  175441. **
  175442. ** This function advances the iterator so that it points to the last
  175443. ** relevant rowid on the page and, if necessary, initializes the
  175444. ** aRowidOffset[] and iRowidOffset variables. At this point the iterator
  175445. ** is in its regular state - Fts5SegIter.iLeafOffset points to the first
  175446. ** byte of the position list content associated with said rowid.
  175447. */
  175448. static void fts5SegIterReverseInitPage(Fts5Index *p, Fts5SegIter *pIter){
  175449. int eDetail = p->pConfig->eDetail;
  175450. int n = pIter->pLeaf->szLeaf;
  175451. int i = pIter->iLeafOffset;
  175452. u8 *a = pIter->pLeaf->p;
  175453. int iRowidOffset = 0;
  175454. if( n>pIter->iEndofDoclist ){
  175455. n = pIter->iEndofDoclist;
  175456. }
  175457. ASSERT_SZLEAF_OK(pIter->pLeaf);
  175458. while( 1 ){
  175459. i64 iDelta = 0;
  175460. if( eDetail==FTS5_DETAIL_NONE ){
  175461. /* todo */
  175462. if( i<n && a[i]==0 ){
  175463. i++;
  175464. if( i<n && a[i]==0 ) i++;
  175465. }
  175466. }else{
  175467. int nPos;
  175468. int bDummy;
  175469. i += fts5GetPoslistSize(&a[i], &nPos, &bDummy);
  175470. i += nPos;
  175471. }
  175472. if( i>=n ) break;
  175473. i += fts5GetVarint(&a[i], (u64*)&iDelta);
  175474. pIter->iRowid += iDelta;
  175475. /* If necessary, grow the pIter->aRowidOffset[] array. */
  175476. if( iRowidOffset>=pIter->nRowidOffset ){
  175477. int nNew = pIter->nRowidOffset + 8;
  175478. int *aNew = (int*)sqlite3_realloc(pIter->aRowidOffset, nNew*sizeof(int));
  175479. if( aNew==0 ){
  175480. p->rc = SQLITE_NOMEM;
  175481. break;
  175482. }
  175483. pIter->aRowidOffset = aNew;
  175484. pIter->nRowidOffset = nNew;
  175485. }
  175486. pIter->aRowidOffset[iRowidOffset++] = pIter->iLeafOffset;
  175487. pIter->iLeafOffset = i;
  175488. }
  175489. pIter->iRowidOffset = iRowidOffset;
  175490. fts5SegIterLoadNPos(p, pIter);
  175491. }
  175492. /*
  175493. **
  175494. */
  175495. static void fts5SegIterReverseNewPage(Fts5Index *p, Fts5SegIter *pIter){
  175496. assert( pIter->flags & FTS5_SEGITER_REVERSE );
  175497. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  175498. fts5DataRelease(pIter->pLeaf);
  175499. pIter->pLeaf = 0;
  175500. while( p->rc==SQLITE_OK && pIter->iLeafPgno>pIter->iTermLeafPgno ){
  175501. Fts5Data *pNew;
  175502. pIter->iLeafPgno--;
  175503. pNew = fts5DataRead(p, FTS5_SEGMENT_ROWID(
  175504. pIter->pSeg->iSegid, pIter->iLeafPgno
  175505. ));
  175506. if( pNew ){
  175507. /* iTermLeafOffset may be equal to szLeaf if the term is the last
  175508. ** thing on the page - i.e. the first rowid is on the following page.
  175509. ** In this case leave pIter->pLeaf==0, this iterator is at EOF. */
  175510. if( pIter->iLeafPgno==pIter->iTermLeafPgno ){
  175511. assert( pIter->pLeaf==0 );
  175512. if( pIter->iTermLeafOffset<pNew->szLeaf ){
  175513. pIter->pLeaf = pNew;
  175514. pIter->iLeafOffset = pIter->iTermLeafOffset;
  175515. }
  175516. }else{
  175517. int iRowidOff;
  175518. iRowidOff = fts5LeafFirstRowidOff(pNew);
  175519. if( iRowidOff ){
  175520. pIter->pLeaf = pNew;
  175521. pIter->iLeafOffset = iRowidOff;
  175522. }
  175523. }
  175524. if( pIter->pLeaf ){
  175525. u8 *a = &pIter->pLeaf->p[pIter->iLeafOffset];
  175526. pIter->iLeafOffset += fts5GetVarint(a, (u64*)&pIter->iRowid);
  175527. break;
  175528. }else{
  175529. fts5DataRelease(pNew);
  175530. }
  175531. }
  175532. }
  175533. if( pIter->pLeaf ){
  175534. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  175535. fts5SegIterReverseInitPage(p, pIter);
  175536. }
  175537. }
  175538. /*
  175539. ** Return true if the iterator passed as the second argument currently
  175540. ** points to a delete marker. A delete marker is an entry with a 0 byte
  175541. ** position-list.
  175542. */
  175543. static int fts5MultiIterIsEmpty(Fts5Index *p, Fts5Iter *pIter){
  175544. Fts5SegIter *pSeg = &pIter->aSeg[pIter->aFirst[1].iFirst];
  175545. return (p->rc==SQLITE_OK && pSeg->pLeaf && pSeg->nPos==0);
  175546. }
  175547. /*
  175548. ** Advance iterator pIter to the next entry.
  175549. **
  175550. ** This version of fts5SegIterNext() is only used by reverse iterators.
  175551. */
  175552. static void fts5SegIterNext_Reverse(
  175553. Fts5Index *p, /* FTS5 backend object */
  175554. Fts5SegIter *pIter, /* Iterator to advance */
  175555. int *pbUnused /* Unused */
  175556. ){
  175557. assert( pIter->flags & FTS5_SEGITER_REVERSE );
  175558. assert( pIter->pNextLeaf==0 );
  175559. UNUSED_PARAM(pbUnused);
  175560. if( pIter->iRowidOffset>0 ){
  175561. u8 *a = pIter->pLeaf->p;
  175562. int iOff;
  175563. i64 iDelta;
  175564. pIter->iRowidOffset--;
  175565. pIter->iLeafOffset = pIter->aRowidOffset[pIter->iRowidOffset];
  175566. fts5SegIterLoadNPos(p, pIter);
  175567. iOff = pIter->iLeafOffset;
  175568. if( p->pConfig->eDetail!=FTS5_DETAIL_NONE ){
  175569. iOff += pIter->nPos;
  175570. }
  175571. fts5GetVarint(&a[iOff], (u64*)&iDelta);
  175572. pIter->iRowid -= iDelta;
  175573. }else{
  175574. fts5SegIterReverseNewPage(p, pIter);
  175575. }
  175576. }
  175577. /*
  175578. ** Advance iterator pIter to the next entry.
  175579. **
  175580. ** This version of fts5SegIterNext() is only used if detail=none and the
  175581. ** iterator is not a reverse direction iterator.
  175582. */
  175583. static void fts5SegIterNext_None(
  175584. Fts5Index *p, /* FTS5 backend object */
  175585. Fts5SegIter *pIter, /* Iterator to advance */
  175586. int *pbNewTerm /* OUT: Set for new term */
  175587. ){
  175588. int iOff;
  175589. assert( p->rc==SQLITE_OK );
  175590. assert( (pIter->flags & FTS5_SEGITER_REVERSE)==0 );
  175591. assert( p->pConfig->eDetail==FTS5_DETAIL_NONE );
  175592. ASSERT_SZLEAF_OK(pIter->pLeaf);
  175593. iOff = pIter->iLeafOffset;
  175594. /* Next entry is on the next page */
  175595. if( pIter->pSeg && iOff>=pIter->pLeaf->szLeaf ){
  175596. fts5SegIterNextPage(p, pIter);
  175597. if( p->rc || pIter->pLeaf==0 ) return;
  175598. pIter->iRowid = 0;
  175599. iOff = 4;
  175600. }
  175601. if( iOff<pIter->iEndofDoclist ){
  175602. /* Next entry is on the current page */
  175603. i64 iDelta;
  175604. iOff += sqlite3Fts5GetVarint(&pIter->pLeaf->p[iOff], (u64*)&iDelta);
  175605. pIter->iLeafOffset = iOff;
  175606. pIter->iRowid += iDelta;
  175607. }else if( (pIter->flags & FTS5_SEGITER_ONETERM)==0 ){
  175608. if( pIter->pSeg ){
  175609. int nKeep = 0;
  175610. if( iOff!=fts5LeafFirstTermOff(pIter->pLeaf) ){
  175611. iOff += fts5GetVarint32(&pIter->pLeaf->p[iOff], nKeep);
  175612. }
  175613. pIter->iLeafOffset = iOff;
  175614. fts5SegIterLoadTerm(p, pIter, nKeep);
  175615. }else{
  175616. const u8 *pList = 0;
  175617. const char *zTerm = 0;
  175618. int nList;
  175619. sqlite3Fts5HashScanNext(p->pHash);
  175620. sqlite3Fts5HashScanEntry(p->pHash, &zTerm, &pList, &nList);
  175621. if( pList==0 ) goto next_none_eof;
  175622. pIter->pLeaf->p = (u8*)pList;
  175623. pIter->pLeaf->nn = nList;
  175624. pIter->pLeaf->szLeaf = nList;
  175625. pIter->iEndofDoclist = nList;
  175626. sqlite3Fts5BufferSet(&p->rc,&pIter->term, (int)strlen(zTerm), (u8*)zTerm);
  175627. pIter->iLeafOffset = fts5GetVarint(pList, (u64*)&pIter->iRowid);
  175628. }
  175629. if( pbNewTerm ) *pbNewTerm = 1;
  175630. }else{
  175631. goto next_none_eof;
  175632. }
  175633. fts5SegIterLoadNPos(p, pIter);
  175634. return;
  175635. next_none_eof:
  175636. fts5DataRelease(pIter->pLeaf);
  175637. pIter->pLeaf = 0;
  175638. }
  175639. /*
  175640. ** Advance iterator pIter to the next entry.
  175641. **
  175642. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. It
  175643. ** is not considered an error if the iterator reaches EOF. If an error has
  175644. ** already occurred when this function is called, it is a no-op.
  175645. */
  175646. static void fts5SegIterNext(
  175647. Fts5Index *p, /* FTS5 backend object */
  175648. Fts5SegIter *pIter, /* Iterator to advance */
  175649. int *pbNewTerm /* OUT: Set for new term */
  175650. ){
  175651. Fts5Data *pLeaf = pIter->pLeaf;
  175652. int iOff;
  175653. int bNewTerm = 0;
  175654. int nKeep = 0;
  175655. u8 *a;
  175656. int n;
  175657. assert( pbNewTerm==0 || *pbNewTerm==0 );
  175658. assert( p->pConfig->eDetail!=FTS5_DETAIL_NONE );
  175659. /* Search for the end of the position list within the current page. */
  175660. a = pLeaf->p;
  175661. n = pLeaf->szLeaf;
  175662. ASSERT_SZLEAF_OK(pLeaf);
  175663. iOff = pIter->iLeafOffset + pIter->nPos;
  175664. if( iOff<n ){
  175665. /* The next entry is on the current page. */
  175666. assert_nc( iOff<=pIter->iEndofDoclist );
  175667. if( iOff>=pIter->iEndofDoclist ){
  175668. bNewTerm = 1;
  175669. if( iOff!=fts5LeafFirstTermOff(pLeaf) ){
  175670. iOff += fts5GetVarint32(&a[iOff], nKeep);
  175671. }
  175672. }else{
  175673. u64 iDelta;
  175674. iOff += sqlite3Fts5GetVarint(&a[iOff], &iDelta);
  175675. pIter->iRowid += iDelta;
  175676. assert_nc( iDelta>0 );
  175677. }
  175678. pIter->iLeafOffset = iOff;
  175679. }else if( pIter->pSeg==0 ){
  175680. const u8 *pList = 0;
  175681. const char *zTerm = 0;
  175682. int nList = 0;
  175683. assert( (pIter->flags & FTS5_SEGITER_ONETERM) || pbNewTerm );
  175684. if( 0==(pIter->flags & FTS5_SEGITER_ONETERM) ){
  175685. sqlite3Fts5HashScanNext(p->pHash);
  175686. sqlite3Fts5HashScanEntry(p->pHash, &zTerm, &pList, &nList);
  175687. }
  175688. if( pList==0 ){
  175689. fts5DataRelease(pIter->pLeaf);
  175690. pIter->pLeaf = 0;
  175691. }else{
  175692. pIter->pLeaf->p = (u8*)pList;
  175693. pIter->pLeaf->nn = nList;
  175694. pIter->pLeaf->szLeaf = nList;
  175695. pIter->iEndofDoclist = nList+1;
  175696. sqlite3Fts5BufferSet(&p->rc, &pIter->term, (int)strlen(zTerm),
  175697. (u8*)zTerm);
  175698. pIter->iLeafOffset = fts5GetVarint(pList, (u64*)&pIter->iRowid);
  175699. *pbNewTerm = 1;
  175700. }
  175701. }else{
  175702. iOff = 0;
  175703. /* Next entry is not on the current page */
  175704. while( iOff==0 ){
  175705. fts5SegIterNextPage(p, pIter);
  175706. pLeaf = pIter->pLeaf;
  175707. if( pLeaf==0 ) break;
  175708. ASSERT_SZLEAF_OK(pLeaf);
  175709. if( (iOff = fts5LeafFirstRowidOff(pLeaf)) && iOff<pLeaf->szLeaf ){
  175710. iOff += sqlite3Fts5GetVarint(&pLeaf->p[iOff], (u64*)&pIter->iRowid);
  175711. pIter->iLeafOffset = iOff;
  175712. if( pLeaf->nn>pLeaf->szLeaf ){
  175713. pIter->iPgidxOff = pLeaf->szLeaf + fts5GetVarint32(
  175714. &pLeaf->p[pLeaf->szLeaf], pIter->iEndofDoclist
  175715. );
  175716. }
  175717. }
  175718. else if( pLeaf->nn>pLeaf->szLeaf ){
  175719. pIter->iPgidxOff = pLeaf->szLeaf + fts5GetVarint32(
  175720. &pLeaf->p[pLeaf->szLeaf], iOff
  175721. );
  175722. pIter->iLeafOffset = iOff;
  175723. pIter->iEndofDoclist = iOff;
  175724. bNewTerm = 1;
  175725. }
  175726. assert_nc( iOff<pLeaf->szLeaf );
  175727. if( iOff>pLeaf->szLeaf ){
  175728. p->rc = FTS5_CORRUPT;
  175729. return;
  175730. }
  175731. }
  175732. }
  175733. /* Check if the iterator is now at EOF. If so, return early. */
  175734. if( pIter->pLeaf ){
  175735. if( bNewTerm ){
  175736. if( pIter->flags & FTS5_SEGITER_ONETERM ){
  175737. fts5DataRelease(pIter->pLeaf);
  175738. pIter->pLeaf = 0;
  175739. }else{
  175740. fts5SegIterLoadTerm(p, pIter, nKeep);
  175741. fts5SegIterLoadNPos(p, pIter);
  175742. if( pbNewTerm ) *pbNewTerm = 1;
  175743. }
  175744. }else{
  175745. /* The following could be done by calling fts5SegIterLoadNPos(). But
  175746. ** this block is particularly performance critical, so equivalent
  175747. ** code is inlined.
  175748. **
  175749. ** Later: Switched back to fts5SegIterLoadNPos() because it supports
  175750. ** detail=none mode. Not ideal.
  175751. */
  175752. int nSz;
  175753. assert( p->rc==SQLITE_OK );
  175754. fts5FastGetVarint32(pIter->pLeaf->p, pIter->iLeafOffset, nSz);
  175755. pIter->bDel = (nSz & 0x0001);
  175756. pIter->nPos = nSz>>1;
  175757. assert_nc( pIter->nPos>=0 );
  175758. }
  175759. }
  175760. }
  175761. #define SWAPVAL(T, a, b) { T tmp; tmp=a; a=b; b=tmp; }
  175762. #define fts5IndexSkipVarint(a, iOff) { \
  175763. int iEnd = iOff+9; \
  175764. while( (a[iOff++] & 0x80) && iOff<iEnd ); \
  175765. }
  175766. /*
  175767. ** Iterator pIter currently points to the first rowid in a doclist. This
  175768. ** function sets the iterator up so that iterates in reverse order through
  175769. ** the doclist.
  175770. */
  175771. static void fts5SegIterReverse(Fts5Index *p, Fts5SegIter *pIter){
  175772. Fts5DlidxIter *pDlidx = pIter->pDlidx;
  175773. Fts5Data *pLast = 0;
  175774. int pgnoLast = 0;
  175775. if( pDlidx ){
  175776. int iSegid = pIter->pSeg->iSegid;
  175777. pgnoLast = fts5DlidxIterPgno(pDlidx);
  175778. pLast = fts5DataRead(p, FTS5_SEGMENT_ROWID(iSegid, pgnoLast));
  175779. }else{
  175780. Fts5Data *pLeaf = pIter->pLeaf; /* Current leaf data */
  175781. /* Currently, Fts5SegIter.iLeafOffset points to the first byte of
  175782. ** position-list content for the current rowid. Back it up so that it
  175783. ** points to the start of the position-list size field. */
  175784. int iPoslist;
  175785. if( pIter->iTermLeafPgno==pIter->iLeafPgno ){
  175786. iPoslist = pIter->iTermLeafOffset;
  175787. }else{
  175788. iPoslist = 4;
  175789. }
  175790. fts5IndexSkipVarint(pLeaf->p, iPoslist);
  175791. pIter->iLeafOffset = iPoslist;
  175792. /* If this condition is true then the largest rowid for the current
  175793. ** term may not be stored on the current page. So search forward to
  175794. ** see where said rowid really is. */
  175795. if( pIter->iEndofDoclist>=pLeaf->szLeaf ){
  175796. int pgno;
  175797. Fts5StructureSegment *pSeg = pIter->pSeg;
  175798. /* The last rowid in the doclist may not be on the current page. Search
  175799. ** forward to find the page containing the last rowid. */
  175800. for(pgno=pIter->iLeafPgno+1; !p->rc && pgno<=pSeg->pgnoLast; pgno++){
  175801. i64 iAbs = FTS5_SEGMENT_ROWID(pSeg->iSegid, pgno);
  175802. Fts5Data *pNew = fts5DataRead(p, iAbs);
  175803. if( pNew ){
  175804. int iRowid, bTermless;
  175805. iRowid = fts5LeafFirstRowidOff(pNew);
  175806. bTermless = fts5LeafIsTermless(pNew);
  175807. if( iRowid ){
  175808. SWAPVAL(Fts5Data*, pNew, pLast);
  175809. pgnoLast = pgno;
  175810. }
  175811. fts5DataRelease(pNew);
  175812. if( bTermless==0 ) break;
  175813. }
  175814. }
  175815. }
  175816. }
  175817. /* If pLast is NULL at this point, then the last rowid for this doclist
  175818. ** lies on the page currently indicated by the iterator. In this case
  175819. ** pIter->iLeafOffset is already set to point to the position-list size
  175820. ** field associated with the first relevant rowid on the page.
  175821. **
  175822. ** Or, if pLast is non-NULL, then it is the page that contains the last
  175823. ** rowid. In this case configure the iterator so that it points to the
  175824. ** first rowid on this page.
  175825. */
  175826. if( pLast ){
  175827. int iOff;
  175828. fts5DataRelease(pIter->pLeaf);
  175829. pIter->pLeaf = pLast;
  175830. pIter->iLeafPgno = pgnoLast;
  175831. iOff = fts5LeafFirstRowidOff(pLast);
  175832. iOff += fts5GetVarint(&pLast->p[iOff], (u64*)&pIter->iRowid);
  175833. pIter->iLeafOffset = iOff;
  175834. if( fts5LeafIsTermless(pLast) ){
  175835. pIter->iEndofDoclist = pLast->nn+1;
  175836. }else{
  175837. pIter->iEndofDoclist = fts5LeafFirstTermOff(pLast);
  175838. }
  175839. }
  175840. fts5SegIterReverseInitPage(p, pIter);
  175841. }
  175842. /*
  175843. ** Iterator pIter currently points to the first rowid of a doclist.
  175844. ** There is a doclist-index associated with the final term on the current
  175845. ** page. If the current term is the last term on the page, load the
  175846. ** doclist-index from disk and initialize an iterator at (pIter->pDlidx).
  175847. */
  175848. static void fts5SegIterLoadDlidx(Fts5Index *p, Fts5SegIter *pIter){
  175849. int iSeg = pIter->pSeg->iSegid;
  175850. int bRev = (pIter->flags & FTS5_SEGITER_REVERSE);
  175851. Fts5Data *pLeaf = pIter->pLeaf; /* Current leaf data */
  175852. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  175853. assert( pIter->pDlidx==0 );
  175854. /* Check if the current doclist ends on this page. If it does, return
  175855. ** early without loading the doclist-index (as it belongs to a different
  175856. ** term. */
  175857. if( pIter->iTermLeafPgno==pIter->iLeafPgno
  175858. && pIter->iEndofDoclist<pLeaf->szLeaf
  175859. ){
  175860. return;
  175861. }
  175862. pIter->pDlidx = fts5DlidxIterInit(p, bRev, iSeg, pIter->iTermLeafPgno);
  175863. }
  175864. /*
  175865. ** The iterator object passed as the second argument currently contains
  175866. ** no valid values except for the Fts5SegIter.pLeaf member variable. This
  175867. ** function searches the leaf page for a term matching (pTerm/nTerm).
  175868. **
  175869. ** If the specified term is found on the page, then the iterator is left
  175870. ** pointing to it. If argument bGe is zero and the term is not found,
  175871. ** the iterator is left pointing at EOF.
  175872. **
  175873. ** If bGe is non-zero and the specified term is not found, then the
  175874. ** iterator is left pointing to the smallest term in the segment that
  175875. ** is larger than the specified term, even if this term is not on the
  175876. ** current page.
  175877. */
  175878. static void fts5LeafSeek(
  175879. Fts5Index *p, /* Leave any error code here */
  175880. int bGe, /* True for a >= search */
  175881. Fts5SegIter *pIter, /* Iterator to seek */
  175882. const u8 *pTerm, int nTerm /* Term to search for */
  175883. ){
  175884. int iOff;
  175885. const u8 *a = pIter->pLeaf->p;
  175886. int szLeaf = pIter->pLeaf->szLeaf;
  175887. int n = pIter->pLeaf->nn;
  175888. int nMatch = 0;
  175889. int nKeep = 0;
  175890. int nNew = 0;
  175891. int iTermOff;
  175892. int iPgidx; /* Current offset in pgidx */
  175893. int bEndOfPage = 0;
  175894. assert( p->rc==SQLITE_OK );
  175895. iPgidx = szLeaf;
  175896. iPgidx += fts5GetVarint32(&a[iPgidx], iTermOff);
  175897. iOff = iTermOff;
  175898. if( iOff>n ){
  175899. p->rc = FTS5_CORRUPT;
  175900. return;
  175901. }
  175902. while( 1 ){
  175903. /* Figure out how many new bytes are in this term */
  175904. fts5FastGetVarint32(a, iOff, nNew);
  175905. if( nKeep<nMatch ){
  175906. goto search_failed;
  175907. }
  175908. assert( nKeep>=nMatch );
  175909. if( nKeep==nMatch ){
  175910. int nCmp;
  175911. int i;
  175912. nCmp = MIN(nNew, nTerm-nMatch);
  175913. for(i=0; i<nCmp; i++){
  175914. if( a[iOff+i]!=pTerm[nMatch+i] ) break;
  175915. }
  175916. nMatch += i;
  175917. if( nTerm==nMatch ){
  175918. if( i==nNew ){
  175919. goto search_success;
  175920. }else{
  175921. goto search_failed;
  175922. }
  175923. }else if( i<nNew && a[iOff+i]>pTerm[nMatch] ){
  175924. goto search_failed;
  175925. }
  175926. }
  175927. if( iPgidx>=n ){
  175928. bEndOfPage = 1;
  175929. break;
  175930. }
  175931. iPgidx += fts5GetVarint32(&a[iPgidx], nKeep);
  175932. iTermOff += nKeep;
  175933. iOff = iTermOff;
  175934. if( iOff>=n ){
  175935. p->rc = FTS5_CORRUPT;
  175936. return;
  175937. }
  175938. /* Read the nKeep field of the next term. */
  175939. fts5FastGetVarint32(a, iOff, nKeep);
  175940. }
  175941. search_failed:
  175942. if( bGe==0 ){
  175943. fts5DataRelease(pIter->pLeaf);
  175944. pIter->pLeaf = 0;
  175945. return;
  175946. }else if( bEndOfPage ){
  175947. do {
  175948. fts5SegIterNextPage(p, pIter);
  175949. if( pIter->pLeaf==0 ) return;
  175950. a = pIter->pLeaf->p;
  175951. if( fts5LeafIsTermless(pIter->pLeaf)==0 ){
  175952. iPgidx = pIter->pLeaf->szLeaf;
  175953. iPgidx += fts5GetVarint32(&pIter->pLeaf->p[iPgidx], iOff);
  175954. if( iOff<4 || iOff>=pIter->pLeaf->szLeaf ){
  175955. p->rc = FTS5_CORRUPT;
  175956. }else{
  175957. nKeep = 0;
  175958. iTermOff = iOff;
  175959. n = pIter->pLeaf->nn;
  175960. iOff += fts5GetVarint32(&a[iOff], nNew);
  175961. break;
  175962. }
  175963. }
  175964. }while( 1 );
  175965. }
  175966. search_success:
  175967. pIter->iLeafOffset = iOff + nNew;
  175968. pIter->iTermLeafOffset = pIter->iLeafOffset;
  175969. pIter->iTermLeafPgno = pIter->iLeafPgno;
  175970. fts5BufferSet(&p->rc, &pIter->term, nKeep, pTerm);
  175971. fts5BufferAppendBlob(&p->rc, &pIter->term, nNew, &a[iOff]);
  175972. if( iPgidx>=n ){
  175973. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  175974. }else{
  175975. int nExtra;
  175976. iPgidx += fts5GetVarint32(&a[iPgidx], nExtra);
  175977. pIter->iEndofDoclist = iTermOff + nExtra;
  175978. }
  175979. pIter->iPgidxOff = iPgidx;
  175980. fts5SegIterLoadRowid(p, pIter);
  175981. fts5SegIterLoadNPos(p, pIter);
  175982. }
  175983. static sqlite3_stmt *fts5IdxSelectStmt(Fts5Index *p){
  175984. if( p->pIdxSelect==0 ){
  175985. Fts5Config *pConfig = p->pConfig;
  175986. fts5IndexPrepareStmt(p, &p->pIdxSelect, sqlite3_mprintf(
  175987. "SELECT pgno FROM '%q'.'%q_idx' WHERE "
  175988. "segid=? AND term<=? ORDER BY term DESC LIMIT 1",
  175989. pConfig->zDb, pConfig->zName
  175990. ));
  175991. }
  175992. return p->pIdxSelect;
  175993. }
  175994. /*
  175995. ** Initialize the object pIter to point to term pTerm/nTerm within segment
  175996. ** pSeg. If there is no such term in the index, the iterator is set to EOF.
  175997. **
  175998. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  175999. ** an error has already occurred when this function is called, it is a no-op.
  176000. */
  176001. static void fts5SegIterSeekInit(
  176002. Fts5Index *p, /* FTS5 backend */
  176003. const u8 *pTerm, int nTerm, /* Term to seek to */
  176004. int flags, /* Mask of FTS5INDEX_XXX flags */
  176005. Fts5StructureSegment *pSeg, /* Description of segment */
  176006. Fts5SegIter *pIter /* Object to populate */
  176007. ){
  176008. int iPg = 1;
  176009. int bGe = (flags & FTS5INDEX_QUERY_SCAN);
  176010. int bDlidx = 0; /* True if there is a doclist-index */
  176011. sqlite3_stmt *pIdxSelect = 0;
  176012. assert( bGe==0 || (flags & FTS5INDEX_QUERY_DESC)==0 );
  176013. assert( pTerm && nTerm );
  176014. memset(pIter, 0, sizeof(*pIter));
  176015. pIter->pSeg = pSeg;
  176016. /* This block sets stack variable iPg to the leaf page number that may
  176017. ** contain term (pTerm/nTerm), if it is present in the segment. */
  176018. pIdxSelect = fts5IdxSelectStmt(p);
  176019. if( p->rc ) return;
  176020. sqlite3_bind_int(pIdxSelect, 1, pSeg->iSegid);
  176021. sqlite3_bind_blob(pIdxSelect, 2, pTerm, nTerm, SQLITE_STATIC);
  176022. if( SQLITE_ROW==sqlite3_step(pIdxSelect) ){
  176023. i64 val = sqlite3_column_int(pIdxSelect, 0);
  176024. iPg = (int)(val>>1);
  176025. bDlidx = (val & 0x0001);
  176026. }
  176027. p->rc = sqlite3_reset(pIdxSelect);
  176028. if( iPg<pSeg->pgnoFirst ){
  176029. iPg = pSeg->pgnoFirst;
  176030. bDlidx = 0;
  176031. }
  176032. pIter->iLeafPgno = iPg - 1;
  176033. fts5SegIterNextPage(p, pIter);
  176034. if( pIter->pLeaf ){
  176035. fts5LeafSeek(p, bGe, pIter, pTerm, nTerm);
  176036. }
  176037. if( p->rc==SQLITE_OK && bGe==0 ){
  176038. pIter->flags |= FTS5_SEGITER_ONETERM;
  176039. if( pIter->pLeaf ){
  176040. if( flags & FTS5INDEX_QUERY_DESC ){
  176041. pIter->flags |= FTS5_SEGITER_REVERSE;
  176042. }
  176043. if( bDlidx ){
  176044. fts5SegIterLoadDlidx(p, pIter);
  176045. }
  176046. if( flags & FTS5INDEX_QUERY_DESC ){
  176047. fts5SegIterReverse(p, pIter);
  176048. }
  176049. }
  176050. }
  176051. fts5SegIterSetNext(p, pIter);
  176052. /* Either:
  176053. **
  176054. ** 1) an error has occurred, or
  176055. ** 2) the iterator points to EOF, or
  176056. ** 3) the iterator points to an entry with term (pTerm/nTerm), or
  176057. ** 4) the FTS5INDEX_QUERY_SCAN flag was set and the iterator points
  176058. ** to an entry with a term greater than or equal to (pTerm/nTerm).
  176059. */
  176060. assert( p->rc!=SQLITE_OK /* 1 */
  176061. || pIter->pLeaf==0 /* 2 */
  176062. || fts5BufferCompareBlob(&pIter->term, pTerm, nTerm)==0 /* 3 */
  176063. || (bGe && fts5BufferCompareBlob(&pIter->term, pTerm, nTerm)>0) /* 4 */
  176064. );
  176065. }
  176066. /*
  176067. ** Initialize the object pIter to point to term pTerm/nTerm within the
  176068. ** in-memory hash table. If there is no such term in the hash-table, the
  176069. ** iterator is set to EOF.
  176070. **
  176071. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  176072. ** an error has already occurred when this function is called, it is a no-op.
  176073. */
  176074. static void fts5SegIterHashInit(
  176075. Fts5Index *p, /* FTS5 backend */
  176076. const u8 *pTerm, int nTerm, /* Term to seek to */
  176077. int flags, /* Mask of FTS5INDEX_XXX flags */
  176078. Fts5SegIter *pIter /* Object to populate */
  176079. ){
  176080. const u8 *pList = 0;
  176081. int nList = 0;
  176082. const u8 *z = 0;
  176083. int n = 0;
  176084. assert( p->pHash );
  176085. assert( p->rc==SQLITE_OK );
  176086. if( pTerm==0 || (flags & FTS5INDEX_QUERY_SCAN) ){
  176087. p->rc = sqlite3Fts5HashScanInit(p->pHash, (const char*)pTerm, nTerm);
  176088. sqlite3Fts5HashScanEntry(p->pHash, (const char**)&z, &pList, &nList);
  176089. n = (z ? (int)strlen((const char*)z) : 0);
  176090. }else{
  176091. pIter->flags |= FTS5_SEGITER_ONETERM;
  176092. sqlite3Fts5HashQuery(p->pHash, (const char*)pTerm, nTerm, &pList, &nList);
  176093. z = pTerm;
  176094. n = nTerm;
  176095. }
  176096. if( pList ){
  176097. Fts5Data *pLeaf;
  176098. sqlite3Fts5BufferSet(&p->rc, &pIter->term, n, z);
  176099. pLeaf = fts5IdxMalloc(p, sizeof(Fts5Data));
  176100. if( pLeaf==0 ) return;
  176101. pLeaf->p = (u8*)pList;
  176102. pLeaf->nn = pLeaf->szLeaf = nList;
  176103. pIter->pLeaf = pLeaf;
  176104. pIter->iLeafOffset = fts5GetVarint(pLeaf->p, (u64*)&pIter->iRowid);
  176105. pIter->iEndofDoclist = pLeaf->nn;
  176106. if( flags & FTS5INDEX_QUERY_DESC ){
  176107. pIter->flags |= FTS5_SEGITER_REVERSE;
  176108. fts5SegIterReverseInitPage(p, pIter);
  176109. }else{
  176110. fts5SegIterLoadNPos(p, pIter);
  176111. }
  176112. }
  176113. fts5SegIterSetNext(p, pIter);
  176114. }
  176115. /*
  176116. ** Zero the iterator passed as the only argument.
  176117. */
  176118. static void fts5SegIterClear(Fts5SegIter *pIter){
  176119. fts5BufferFree(&pIter->term);
  176120. fts5DataRelease(pIter->pLeaf);
  176121. fts5DataRelease(pIter->pNextLeaf);
  176122. fts5DlidxIterFree(pIter->pDlidx);
  176123. sqlite3_free(pIter->aRowidOffset);
  176124. memset(pIter, 0, sizeof(Fts5SegIter));
  176125. }
  176126. #ifdef SQLITE_DEBUG
  176127. /*
  176128. ** This function is used as part of the big assert() procedure implemented by
  176129. ** fts5AssertMultiIterSetup(). It ensures that the result currently stored
  176130. ** in *pRes is the correct result of comparing the current positions of the
  176131. ** two iterators.
  176132. */
  176133. static void fts5AssertComparisonResult(
  176134. Fts5Iter *pIter,
  176135. Fts5SegIter *p1,
  176136. Fts5SegIter *p2,
  176137. Fts5CResult *pRes
  176138. ){
  176139. int i1 = p1 - pIter->aSeg;
  176140. int i2 = p2 - pIter->aSeg;
  176141. if( p1->pLeaf || p2->pLeaf ){
  176142. if( p1->pLeaf==0 ){
  176143. assert( pRes->iFirst==i2 );
  176144. }else if( p2->pLeaf==0 ){
  176145. assert( pRes->iFirst==i1 );
  176146. }else{
  176147. int nMin = MIN(p1->term.n, p2->term.n);
  176148. int res = memcmp(p1->term.p, p2->term.p, nMin);
  176149. if( res==0 ) res = p1->term.n - p2->term.n;
  176150. if( res==0 ){
  176151. assert( pRes->bTermEq==1 );
  176152. assert( p1->iRowid!=p2->iRowid );
  176153. res = ((p1->iRowid > p2->iRowid)==pIter->bRev) ? -1 : 1;
  176154. }else{
  176155. assert( pRes->bTermEq==0 );
  176156. }
  176157. if( res<0 ){
  176158. assert( pRes->iFirst==i1 );
  176159. }else{
  176160. assert( pRes->iFirst==i2 );
  176161. }
  176162. }
  176163. }
  176164. }
  176165. /*
  176166. ** This function is a no-op unless SQLITE_DEBUG is defined when this module
  176167. ** is compiled. In that case, this function is essentially an assert()
  176168. ** statement used to verify that the contents of the pIter->aFirst[] array
  176169. ** are correct.
  176170. */
  176171. static void fts5AssertMultiIterSetup(Fts5Index *p, Fts5Iter *pIter){
  176172. if( p->rc==SQLITE_OK ){
  176173. Fts5SegIter *pFirst = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  176174. int i;
  176175. assert( (pFirst->pLeaf==0)==pIter->base.bEof );
  176176. /* Check that pIter->iSwitchRowid is set correctly. */
  176177. for(i=0; i<pIter->nSeg; i++){
  176178. Fts5SegIter *p1 = &pIter->aSeg[i];
  176179. assert( p1==pFirst
  176180. || p1->pLeaf==0
  176181. || fts5BufferCompare(&pFirst->term, &p1->term)
  176182. || p1->iRowid==pIter->iSwitchRowid
  176183. || (p1->iRowid<pIter->iSwitchRowid)==pIter->bRev
  176184. );
  176185. }
  176186. for(i=0; i<pIter->nSeg; i+=2){
  176187. Fts5SegIter *p1 = &pIter->aSeg[i];
  176188. Fts5SegIter *p2 = &pIter->aSeg[i+1];
  176189. Fts5CResult *pRes = &pIter->aFirst[(pIter->nSeg + i) / 2];
  176190. fts5AssertComparisonResult(pIter, p1, p2, pRes);
  176191. }
  176192. for(i=1; i<(pIter->nSeg / 2); i+=2){
  176193. Fts5SegIter *p1 = &pIter->aSeg[ pIter->aFirst[i*2].iFirst ];
  176194. Fts5SegIter *p2 = &pIter->aSeg[ pIter->aFirst[i*2+1].iFirst ];
  176195. Fts5CResult *pRes = &pIter->aFirst[i];
  176196. fts5AssertComparisonResult(pIter, p1, p2, pRes);
  176197. }
  176198. }
  176199. }
  176200. #else
  176201. # define fts5AssertMultiIterSetup(x,y)
  176202. #endif
  176203. /*
  176204. ** Do the comparison necessary to populate pIter->aFirst[iOut].
  176205. **
  176206. ** If the returned value is non-zero, then it is the index of an entry
  176207. ** in the pIter->aSeg[] array that is (a) not at EOF, and (b) pointing
  176208. ** to a key that is a duplicate of another, higher priority,
  176209. ** segment-iterator in the pSeg->aSeg[] array.
  176210. */
  176211. static int fts5MultiIterDoCompare(Fts5Iter *pIter, int iOut){
  176212. int i1; /* Index of left-hand Fts5SegIter */
  176213. int i2; /* Index of right-hand Fts5SegIter */
  176214. int iRes;
  176215. Fts5SegIter *p1; /* Left-hand Fts5SegIter */
  176216. Fts5SegIter *p2; /* Right-hand Fts5SegIter */
  176217. Fts5CResult *pRes = &pIter->aFirst[iOut];
  176218. assert( iOut<pIter->nSeg && iOut>0 );
  176219. assert( pIter->bRev==0 || pIter->bRev==1 );
  176220. if( iOut>=(pIter->nSeg/2) ){
  176221. i1 = (iOut - pIter->nSeg/2) * 2;
  176222. i2 = i1 + 1;
  176223. }else{
  176224. i1 = pIter->aFirst[iOut*2].iFirst;
  176225. i2 = pIter->aFirst[iOut*2+1].iFirst;
  176226. }
  176227. p1 = &pIter->aSeg[i1];
  176228. p2 = &pIter->aSeg[i2];
  176229. pRes->bTermEq = 0;
  176230. if( p1->pLeaf==0 ){ /* If p1 is at EOF */
  176231. iRes = i2;
  176232. }else if( p2->pLeaf==0 ){ /* If p2 is at EOF */
  176233. iRes = i1;
  176234. }else{
  176235. int res = fts5BufferCompare(&p1->term, &p2->term);
  176236. if( res==0 ){
  176237. assert( i2>i1 );
  176238. assert( i2!=0 );
  176239. pRes->bTermEq = 1;
  176240. if( p1->iRowid==p2->iRowid ){
  176241. p1->bDel = p2->bDel;
  176242. return i2;
  176243. }
  176244. res = ((p1->iRowid > p2->iRowid)==pIter->bRev) ? -1 : +1;
  176245. }
  176246. assert( res!=0 );
  176247. if( res<0 ){
  176248. iRes = i1;
  176249. }else{
  176250. iRes = i2;
  176251. }
  176252. }
  176253. pRes->iFirst = (u16)iRes;
  176254. return 0;
  176255. }
  176256. /*
  176257. ** Move the seg-iter so that it points to the first rowid on page iLeafPgno.
  176258. ** It is an error if leaf iLeafPgno does not exist or contains no rowids.
  176259. */
  176260. static void fts5SegIterGotoPage(
  176261. Fts5Index *p, /* FTS5 backend object */
  176262. Fts5SegIter *pIter, /* Iterator to advance */
  176263. int iLeafPgno
  176264. ){
  176265. assert( iLeafPgno>pIter->iLeafPgno );
  176266. if( iLeafPgno>pIter->pSeg->pgnoLast ){
  176267. p->rc = FTS5_CORRUPT;
  176268. }else{
  176269. fts5DataRelease(pIter->pNextLeaf);
  176270. pIter->pNextLeaf = 0;
  176271. pIter->iLeafPgno = iLeafPgno-1;
  176272. fts5SegIterNextPage(p, pIter);
  176273. assert( p->rc!=SQLITE_OK || pIter->iLeafPgno==iLeafPgno );
  176274. if( p->rc==SQLITE_OK ){
  176275. int iOff;
  176276. u8 *a = pIter->pLeaf->p;
  176277. int n = pIter->pLeaf->szLeaf;
  176278. iOff = fts5LeafFirstRowidOff(pIter->pLeaf);
  176279. if( iOff<4 || iOff>=n ){
  176280. p->rc = FTS5_CORRUPT;
  176281. }else{
  176282. iOff += fts5GetVarint(&a[iOff], (u64*)&pIter->iRowid);
  176283. pIter->iLeafOffset = iOff;
  176284. fts5SegIterLoadNPos(p, pIter);
  176285. }
  176286. }
  176287. }
  176288. }
  176289. /*
  176290. ** Advance the iterator passed as the second argument until it is at or
  176291. ** past rowid iFrom. Regardless of the value of iFrom, the iterator is
  176292. ** always advanced at least once.
  176293. */
  176294. static void fts5SegIterNextFrom(
  176295. Fts5Index *p, /* FTS5 backend object */
  176296. Fts5SegIter *pIter, /* Iterator to advance */
  176297. i64 iMatch /* Advance iterator at least this far */
  176298. ){
  176299. int bRev = (pIter->flags & FTS5_SEGITER_REVERSE);
  176300. Fts5DlidxIter *pDlidx = pIter->pDlidx;
  176301. int iLeafPgno = pIter->iLeafPgno;
  176302. int bMove = 1;
  176303. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  176304. assert( pIter->pDlidx );
  176305. assert( pIter->pLeaf );
  176306. if( bRev==0 ){
  176307. while( !fts5DlidxIterEof(p, pDlidx) && iMatch>fts5DlidxIterRowid(pDlidx) ){
  176308. iLeafPgno = fts5DlidxIterPgno(pDlidx);
  176309. fts5DlidxIterNext(p, pDlidx);
  176310. }
  176311. assert_nc( iLeafPgno>=pIter->iLeafPgno || p->rc );
  176312. if( iLeafPgno>pIter->iLeafPgno ){
  176313. fts5SegIterGotoPage(p, pIter, iLeafPgno);
  176314. bMove = 0;
  176315. }
  176316. }else{
  176317. assert( pIter->pNextLeaf==0 );
  176318. assert( iMatch<pIter->iRowid );
  176319. while( !fts5DlidxIterEof(p, pDlidx) && iMatch<fts5DlidxIterRowid(pDlidx) ){
  176320. fts5DlidxIterPrev(p, pDlidx);
  176321. }
  176322. iLeafPgno = fts5DlidxIterPgno(pDlidx);
  176323. assert( fts5DlidxIterEof(p, pDlidx) || iLeafPgno<=pIter->iLeafPgno );
  176324. if( iLeafPgno<pIter->iLeafPgno ){
  176325. pIter->iLeafPgno = iLeafPgno+1;
  176326. fts5SegIterReverseNewPage(p, pIter);
  176327. bMove = 0;
  176328. }
  176329. }
  176330. do{
  176331. if( bMove && p->rc==SQLITE_OK ) pIter->xNext(p, pIter, 0);
  176332. if( pIter->pLeaf==0 ) break;
  176333. if( bRev==0 && pIter->iRowid>=iMatch ) break;
  176334. if( bRev!=0 && pIter->iRowid<=iMatch ) break;
  176335. bMove = 1;
  176336. }while( p->rc==SQLITE_OK );
  176337. }
  176338. /*
  176339. ** Free the iterator object passed as the second argument.
  176340. */
  176341. static void fts5MultiIterFree(Fts5Iter *pIter){
  176342. if( pIter ){
  176343. int i;
  176344. for(i=0; i<pIter->nSeg; i++){
  176345. fts5SegIterClear(&pIter->aSeg[i]);
  176346. }
  176347. fts5StructureRelease(pIter->pStruct);
  176348. fts5BufferFree(&pIter->poslist);
  176349. sqlite3_free(pIter);
  176350. }
  176351. }
  176352. static void fts5MultiIterAdvanced(
  176353. Fts5Index *p, /* FTS5 backend to iterate within */
  176354. Fts5Iter *pIter, /* Iterator to update aFirst[] array for */
  176355. int iChanged, /* Index of sub-iterator just advanced */
  176356. int iMinset /* Minimum entry in aFirst[] to set */
  176357. ){
  176358. int i;
  176359. for(i=(pIter->nSeg+iChanged)/2; i>=iMinset && p->rc==SQLITE_OK; i=i/2){
  176360. int iEq;
  176361. if( (iEq = fts5MultiIterDoCompare(pIter, i)) ){
  176362. Fts5SegIter *pSeg = &pIter->aSeg[iEq];
  176363. assert( p->rc==SQLITE_OK );
  176364. pSeg->xNext(p, pSeg, 0);
  176365. i = pIter->nSeg + iEq;
  176366. }
  176367. }
  176368. }
  176369. /*
  176370. ** Sub-iterator iChanged of iterator pIter has just been advanced. It still
  176371. ** points to the same term though - just a different rowid. This function
  176372. ** attempts to update the contents of the pIter->aFirst[] accordingly.
  176373. ** If it does so successfully, 0 is returned. Otherwise 1.
  176374. **
  176375. ** If non-zero is returned, the caller should call fts5MultiIterAdvanced()
  176376. ** on the iterator instead. That function does the same as this one, except
  176377. ** that it deals with more complicated cases as well.
  176378. */
  176379. static int fts5MultiIterAdvanceRowid(
  176380. Fts5Iter *pIter, /* Iterator to update aFirst[] array for */
  176381. int iChanged, /* Index of sub-iterator just advanced */
  176382. Fts5SegIter **ppFirst
  176383. ){
  176384. Fts5SegIter *pNew = &pIter->aSeg[iChanged];
  176385. if( pNew->iRowid==pIter->iSwitchRowid
  176386. || (pNew->iRowid<pIter->iSwitchRowid)==pIter->bRev
  176387. ){
  176388. int i;
  176389. Fts5SegIter *pOther = &pIter->aSeg[iChanged ^ 0x0001];
  176390. pIter->iSwitchRowid = pIter->bRev ? SMALLEST_INT64 : LARGEST_INT64;
  176391. for(i=(pIter->nSeg+iChanged)/2; 1; i=i/2){
  176392. Fts5CResult *pRes = &pIter->aFirst[i];
  176393. assert( pNew->pLeaf );
  176394. assert( pRes->bTermEq==0 || pOther->pLeaf );
  176395. if( pRes->bTermEq ){
  176396. if( pNew->iRowid==pOther->iRowid ){
  176397. return 1;
  176398. }else if( (pOther->iRowid>pNew->iRowid)==pIter->bRev ){
  176399. pIter->iSwitchRowid = pOther->iRowid;
  176400. pNew = pOther;
  176401. }else if( (pOther->iRowid>pIter->iSwitchRowid)==pIter->bRev ){
  176402. pIter->iSwitchRowid = pOther->iRowid;
  176403. }
  176404. }
  176405. pRes->iFirst = (u16)(pNew - pIter->aSeg);
  176406. if( i==1 ) break;
  176407. pOther = &pIter->aSeg[ pIter->aFirst[i ^ 0x0001].iFirst ];
  176408. }
  176409. }
  176410. *ppFirst = pNew;
  176411. return 0;
  176412. }
  176413. /*
  176414. ** Set the pIter->bEof variable based on the state of the sub-iterators.
  176415. */
  176416. static void fts5MultiIterSetEof(Fts5Iter *pIter){
  176417. Fts5SegIter *pSeg = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  176418. pIter->base.bEof = pSeg->pLeaf==0;
  176419. pIter->iSwitchRowid = pSeg->iRowid;
  176420. }
  176421. /*
  176422. ** Move the iterator to the next entry.
  176423. **
  176424. ** If an error occurs, an error code is left in Fts5Index.rc. It is not
  176425. ** considered an error if the iterator reaches EOF, or if it is already at
  176426. ** EOF when this function is called.
  176427. */
  176428. static void fts5MultiIterNext(
  176429. Fts5Index *p,
  176430. Fts5Iter *pIter,
  176431. int bFrom, /* True if argument iFrom is valid */
  176432. i64 iFrom /* Advance at least as far as this */
  176433. ){
  176434. int bUseFrom = bFrom;
  176435. while( p->rc==SQLITE_OK ){
  176436. int iFirst = pIter->aFirst[1].iFirst;
  176437. int bNewTerm = 0;
  176438. Fts5SegIter *pSeg = &pIter->aSeg[iFirst];
  176439. assert( p->rc==SQLITE_OK );
  176440. if( bUseFrom && pSeg->pDlidx ){
  176441. fts5SegIterNextFrom(p, pSeg, iFrom);
  176442. }else{
  176443. pSeg->xNext(p, pSeg, &bNewTerm);
  176444. }
  176445. if( pSeg->pLeaf==0 || bNewTerm
  176446. || fts5MultiIterAdvanceRowid(pIter, iFirst, &pSeg)
  176447. ){
  176448. fts5MultiIterAdvanced(p, pIter, iFirst, 1);
  176449. fts5MultiIterSetEof(pIter);
  176450. pSeg = &pIter->aSeg[pIter->aFirst[1].iFirst];
  176451. if( pSeg->pLeaf==0 ) return;
  176452. }
  176453. fts5AssertMultiIterSetup(p, pIter);
  176454. assert( pSeg==&pIter->aSeg[pIter->aFirst[1].iFirst] && pSeg->pLeaf );
  176455. if( pIter->bSkipEmpty==0 || pSeg->nPos ){
  176456. pIter->xSetOutputs(pIter, pSeg);
  176457. return;
  176458. }
  176459. bUseFrom = 0;
  176460. }
  176461. }
  176462. static void fts5MultiIterNext2(
  176463. Fts5Index *p,
  176464. Fts5Iter *pIter,
  176465. int *pbNewTerm /* OUT: True if *might* be new term */
  176466. ){
  176467. assert( pIter->bSkipEmpty );
  176468. if( p->rc==SQLITE_OK ){
  176469. do {
  176470. int iFirst = pIter->aFirst[1].iFirst;
  176471. Fts5SegIter *pSeg = &pIter->aSeg[iFirst];
  176472. int bNewTerm = 0;
  176473. assert( p->rc==SQLITE_OK );
  176474. pSeg->xNext(p, pSeg, &bNewTerm);
  176475. if( pSeg->pLeaf==0 || bNewTerm
  176476. || fts5MultiIterAdvanceRowid(pIter, iFirst, &pSeg)
  176477. ){
  176478. fts5MultiIterAdvanced(p, pIter, iFirst, 1);
  176479. fts5MultiIterSetEof(pIter);
  176480. *pbNewTerm = 1;
  176481. }else{
  176482. *pbNewTerm = 0;
  176483. }
  176484. fts5AssertMultiIterSetup(p, pIter);
  176485. }while( fts5MultiIterIsEmpty(p, pIter) );
  176486. }
  176487. }
  176488. static void fts5IterSetOutputs_Noop(Fts5Iter *pUnused1, Fts5SegIter *pUnused2){
  176489. UNUSED_PARAM2(pUnused1, pUnused2);
  176490. }
  176491. static Fts5Iter *fts5MultiIterAlloc(
  176492. Fts5Index *p, /* FTS5 backend to iterate within */
  176493. int nSeg
  176494. ){
  176495. Fts5Iter *pNew;
  176496. int nSlot; /* Power of two >= nSeg */
  176497. for(nSlot=2; nSlot<nSeg; nSlot=nSlot*2);
  176498. pNew = fts5IdxMalloc(p,
  176499. sizeof(Fts5Iter) + /* pNew */
  176500. sizeof(Fts5SegIter) * (nSlot-1) + /* pNew->aSeg[] */
  176501. sizeof(Fts5CResult) * nSlot /* pNew->aFirst[] */
  176502. );
  176503. if( pNew ){
  176504. pNew->nSeg = nSlot;
  176505. pNew->aFirst = (Fts5CResult*)&pNew->aSeg[nSlot];
  176506. pNew->pIndex = p;
  176507. pNew->xSetOutputs = fts5IterSetOutputs_Noop;
  176508. }
  176509. return pNew;
  176510. }
  176511. static void fts5PoslistCallback(
  176512. Fts5Index *pUnused,
  176513. void *pContext,
  176514. const u8 *pChunk, int nChunk
  176515. ){
  176516. UNUSED_PARAM(pUnused);
  176517. assert_nc( nChunk>=0 );
  176518. if( nChunk>0 ){
  176519. fts5BufferSafeAppendBlob((Fts5Buffer*)pContext, pChunk, nChunk);
  176520. }
  176521. }
  176522. typedef struct PoslistCallbackCtx PoslistCallbackCtx;
  176523. struct PoslistCallbackCtx {
  176524. Fts5Buffer *pBuf; /* Append to this buffer */
  176525. Fts5Colset *pColset; /* Restrict matches to this column */
  176526. int eState; /* See above */
  176527. };
  176528. typedef struct PoslistOffsetsCtx PoslistOffsetsCtx;
  176529. struct PoslistOffsetsCtx {
  176530. Fts5Buffer *pBuf; /* Append to this buffer */
  176531. Fts5Colset *pColset; /* Restrict matches to this column */
  176532. int iRead;
  176533. int iWrite;
  176534. };
  176535. /*
  176536. ** TODO: Make this more efficient!
  176537. */
  176538. static int fts5IndexColsetTest(Fts5Colset *pColset, int iCol){
  176539. int i;
  176540. for(i=0; i<pColset->nCol; i++){
  176541. if( pColset->aiCol[i]==iCol ) return 1;
  176542. }
  176543. return 0;
  176544. }
  176545. static void fts5PoslistOffsetsCallback(
  176546. Fts5Index *pUnused,
  176547. void *pContext,
  176548. const u8 *pChunk, int nChunk
  176549. ){
  176550. PoslistOffsetsCtx *pCtx = (PoslistOffsetsCtx*)pContext;
  176551. UNUSED_PARAM(pUnused);
  176552. assert_nc( nChunk>=0 );
  176553. if( nChunk>0 ){
  176554. int i = 0;
  176555. while( i<nChunk ){
  176556. int iVal;
  176557. i += fts5GetVarint32(&pChunk[i], iVal);
  176558. iVal += pCtx->iRead - 2;
  176559. pCtx->iRead = iVal;
  176560. if( fts5IndexColsetTest(pCtx->pColset, iVal) ){
  176561. fts5BufferSafeAppendVarint(pCtx->pBuf, iVal + 2 - pCtx->iWrite);
  176562. pCtx->iWrite = iVal;
  176563. }
  176564. }
  176565. }
  176566. }
  176567. static void fts5PoslistFilterCallback(
  176568. Fts5Index *pUnused,
  176569. void *pContext,
  176570. const u8 *pChunk, int nChunk
  176571. ){
  176572. PoslistCallbackCtx *pCtx = (PoslistCallbackCtx*)pContext;
  176573. UNUSED_PARAM(pUnused);
  176574. assert_nc( nChunk>=0 );
  176575. if( nChunk>0 ){
  176576. /* Search through to find the first varint with value 1. This is the
  176577. ** start of the next columns hits. */
  176578. int i = 0;
  176579. int iStart = 0;
  176580. if( pCtx->eState==2 ){
  176581. int iCol;
  176582. fts5FastGetVarint32(pChunk, i, iCol);
  176583. if( fts5IndexColsetTest(pCtx->pColset, iCol) ){
  176584. pCtx->eState = 1;
  176585. fts5BufferSafeAppendVarint(pCtx->pBuf, 1);
  176586. }else{
  176587. pCtx->eState = 0;
  176588. }
  176589. }
  176590. do {
  176591. while( i<nChunk && pChunk[i]!=0x01 ){
  176592. while( pChunk[i] & 0x80 ) i++;
  176593. i++;
  176594. }
  176595. if( pCtx->eState ){
  176596. fts5BufferSafeAppendBlob(pCtx->pBuf, &pChunk[iStart], i-iStart);
  176597. }
  176598. if( i<nChunk ){
  176599. int iCol;
  176600. iStart = i;
  176601. i++;
  176602. if( i>=nChunk ){
  176603. pCtx->eState = 2;
  176604. }else{
  176605. fts5FastGetVarint32(pChunk, i, iCol);
  176606. pCtx->eState = fts5IndexColsetTest(pCtx->pColset, iCol);
  176607. if( pCtx->eState ){
  176608. fts5BufferSafeAppendBlob(pCtx->pBuf, &pChunk[iStart], i-iStart);
  176609. iStart = i;
  176610. }
  176611. }
  176612. }
  176613. }while( i<nChunk );
  176614. }
  176615. }
  176616. static void fts5ChunkIterate(
  176617. Fts5Index *p, /* Index object */
  176618. Fts5SegIter *pSeg, /* Poslist of this iterator */
  176619. void *pCtx, /* Context pointer for xChunk callback */
  176620. void (*xChunk)(Fts5Index*, void*, const u8*, int)
  176621. ){
  176622. int nRem = pSeg->nPos; /* Number of bytes still to come */
  176623. Fts5Data *pData = 0;
  176624. u8 *pChunk = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  176625. int nChunk = MIN(nRem, pSeg->pLeaf->szLeaf - pSeg->iLeafOffset);
  176626. int pgno = pSeg->iLeafPgno;
  176627. int pgnoSave = 0;
  176628. /* This function does notmwork with detail=none databases. */
  176629. assert( p->pConfig->eDetail!=FTS5_DETAIL_NONE );
  176630. if( (pSeg->flags & FTS5_SEGITER_REVERSE)==0 ){
  176631. pgnoSave = pgno+1;
  176632. }
  176633. while( 1 ){
  176634. xChunk(p, pCtx, pChunk, nChunk);
  176635. nRem -= nChunk;
  176636. fts5DataRelease(pData);
  176637. if( nRem<=0 ){
  176638. break;
  176639. }else{
  176640. pgno++;
  176641. pData = fts5DataRead(p, FTS5_SEGMENT_ROWID(pSeg->pSeg->iSegid, pgno));
  176642. if( pData==0 ) break;
  176643. pChunk = &pData->p[4];
  176644. nChunk = MIN(nRem, pData->szLeaf - 4);
  176645. if( pgno==pgnoSave ){
  176646. assert( pSeg->pNextLeaf==0 );
  176647. pSeg->pNextLeaf = pData;
  176648. pData = 0;
  176649. }
  176650. }
  176651. }
  176652. }
  176653. /*
  176654. ** Iterator pIter currently points to a valid entry (not EOF). This
  176655. ** function appends the position list data for the current entry to
  176656. ** buffer pBuf. It does not make a copy of the position-list size
  176657. ** field.
  176658. */
  176659. static void fts5SegiterPoslist(
  176660. Fts5Index *p,
  176661. Fts5SegIter *pSeg,
  176662. Fts5Colset *pColset,
  176663. Fts5Buffer *pBuf
  176664. ){
  176665. if( 0==fts5BufferGrow(&p->rc, pBuf, pSeg->nPos) ){
  176666. if( pColset==0 ){
  176667. fts5ChunkIterate(p, pSeg, (void*)pBuf, fts5PoslistCallback);
  176668. }else{
  176669. if( p->pConfig->eDetail==FTS5_DETAIL_FULL ){
  176670. PoslistCallbackCtx sCtx;
  176671. sCtx.pBuf = pBuf;
  176672. sCtx.pColset = pColset;
  176673. sCtx.eState = fts5IndexColsetTest(pColset, 0);
  176674. assert( sCtx.eState==0 || sCtx.eState==1 );
  176675. fts5ChunkIterate(p, pSeg, (void*)&sCtx, fts5PoslistFilterCallback);
  176676. }else{
  176677. PoslistOffsetsCtx sCtx;
  176678. memset(&sCtx, 0, sizeof(sCtx));
  176679. sCtx.pBuf = pBuf;
  176680. sCtx.pColset = pColset;
  176681. fts5ChunkIterate(p, pSeg, (void*)&sCtx, fts5PoslistOffsetsCallback);
  176682. }
  176683. }
  176684. }
  176685. }
  176686. /*
  176687. ** IN/OUT parameter (*pa) points to a position list n bytes in size. If
  176688. ** the position list contains entries for column iCol, then (*pa) is set
  176689. ** to point to the sub-position-list for that column and the number of
  176690. ** bytes in it returned. Or, if the argument position list does not
  176691. ** contain any entries for column iCol, return 0.
  176692. */
  176693. static int fts5IndexExtractCol(
  176694. const u8 **pa, /* IN/OUT: Pointer to poslist */
  176695. int n, /* IN: Size of poslist in bytes */
  176696. int iCol /* Column to extract from poslist */
  176697. ){
  176698. int iCurrent = 0; /* Anything before the first 0x01 is col 0 */
  176699. const u8 *p = *pa;
  176700. const u8 *pEnd = &p[n]; /* One byte past end of position list */
  176701. while( iCol>iCurrent ){
  176702. /* Advance pointer p until it points to pEnd or an 0x01 byte that is
  176703. ** not part of a varint. Note that it is not possible for a negative
  176704. ** or extremely large varint to occur within an uncorrupted position
  176705. ** list. So the last byte of each varint may be assumed to have a clear
  176706. ** 0x80 bit. */
  176707. while( *p!=0x01 ){
  176708. while( *p++ & 0x80 );
  176709. if( p>=pEnd ) return 0;
  176710. }
  176711. *pa = p++;
  176712. iCurrent = *p++;
  176713. if( iCurrent & 0x80 ){
  176714. p--;
  176715. p += fts5GetVarint32(p, iCurrent);
  176716. }
  176717. }
  176718. if( iCol!=iCurrent ) return 0;
  176719. /* Advance pointer p until it points to pEnd or an 0x01 byte that is
  176720. ** not part of a varint */
  176721. while( p<pEnd && *p!=0x01 ){
  176722. while( *p++ & 0x80 );
  176723. }
  176724. return p - (*pa);
  176725. }
  176726. static int fts5IndexExtractColset (
  176727. Fts5Colset *pColset, /* Colset to filter on */
  176728. const u8 *pPos, int nPos, /* Position list */
  176729. Fts5Buffer *pBuf /* Output buffer */
  176730. ){
  176731. int rc = SQLITE_OK;
  176732. int i;
  176733. fts5BufferZero(pBuf);
  176734. for(i=0; i<pColset->nCol; i++){
  176735. const u8 *pSub = pPos;
  176736. int nSub = fts5IndexExtractCol(&pSub, nPos, pColset->aiCol[i]);
  176737. if( nSub ){
  176738. fts5BufferAppendBlob(&rc, pBuf, nSub, pSub);
  176739. }
  176740. }
  176741. return rc;
  176742. }
  176743. /*
  176744. ** xSetOutputs callback used by detail=none tables.
  176745. */
  176746. static void fts5IterSetOutputs_None(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176747. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_NONE );
  176748. pIter->base.iRowid = pSeg->iRowid;
  176749. pIter->base.nData = pSeg->nPos;
  176750. }
  176751. /*
  176752. ** xSetOutputs callback used by detail=full and detail=col tables when no
  176753. ** column filters are specified.
  176754. */
  176755. static void fts5IterSetOutputs_Nocolset(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176756. pIter->base.iRowid = pSeg->iRowid;
  176757. pIter->base.nData = pSeg->nPos;
  176758. assert( pIter->pIndex->pConfig->eDetail!=FTS5_DETAIL_NONE );
  176759. assert( pIter->pColset==0 );
  176760. if( pSeg->iLeafOffset+pSeg->nPos<=pSeg->pLeaf->szLeaf ){
  176761. /* All data is stored on the current page. Populate the output
  176762. ** variables to point into the body of the page object. */
  176763. pIter->base.pData = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  176764. }else{
  176765. /* The data is distributed over two or more pages. Copy it into the
  176766. ** Fts5Iter.poslist buffer and then set the output pointer to point
  176767. ** to this buffer. */
  176768. fts5BufferZero(&pIter->poslist);
  176769. fts5SegiterPoslist(pIter->pIndex, pSeg, 0, &pIter->poslist);
  176770. pIter->base.pData = pIter->poslist.p;
  176771. }
  176772. }
  176773. /*
  176774. ** xSetOutputs callback used when the Fts5Colset object has nCol==0 (match
  176775. ** against no columns at all).
  176776. */
  176777. static void fts5IterSetOutputs_ZeroColset(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176778. UNUSED_PARAM(pSeg);
  176779. pIter->base.nData = 0;
  176780. }
  176781. /*
  176782. ** xSetOutputs callback used by detail=col when there is a column filter
  176783. ** and there are 100 or more columns. Also called as a fallback from
  176784. ** fts5IterSetOutputs_Col100 if the column-list spans more than one page.
  176785. */
  176786. static void fts5IterSetOutputs_Col(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176787. fts5BufferZero(&pIter->poslist);
  176788. fts5SegiterPoslist(pIter->pIndex, pSeg, pIter->pColset, &pIter->poslist);
  176789. pIter->base.iRowid = pSeg->iRowid;
  176790. pIter->base.pData = pIter->poslist.p;
  176791. pIter->base.nData = pIter->poslist.n;
  176792. }
  176793. /*
  176794. ** xSetOutputs callback used when:
  176795. **
  176796. ** * detail=col,
  176797. ** * there is a column filter, and
  176798. ** * the table contains 100 or fewer columns.
  176799. **
  176800. ** The last point is to ensure all column numbers are stored as
  176801. ** single-byte varints.
  176802. */
  176803. static void fts5IterSetOutputs_Col100(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176804. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  176805. assert( pIter->pColset );
  176806. if( pSeg->iLeafOffset+pSeg->nPos>pSeg->pLeaf->szLeaf ){
  176807. fts5IterSetOutputs_Col(pIter, pSeg);
  176808. }else{
  176809. u8 *a = (u8*)&pSeg->pLeaf->p[pSeg->iLeafOffset];
  176810. u8 *pEnd = (u8*)&a[pSeg->nPos];
  176811. int iPrev = 0;
  176812. int *aiCol = pIter->pColset->aiCol;
  176813. int *aiColEnd = &aiCol[pIter->pColset->nCol];
  176814. u8 *aOut = pIter->poslist.p;
  176815. int iPrevOut = 0;
  176816. pIter->base.iRowid = pSeg->iRowid;
  176817. while( a<pEnd ){
  176818. iPrev += (int)a++[0] - 2;
  176819. while( *aiCol<iPrev ){
  176820. aiCol++;
  176821. if( aiCol==aiColEnd ) goto setoutputs_col_out;
  176822. }
  176823. if( *aiCol==iPrev ){
  176824. *aOut++ = (u8)((iPrev - iPrevOut) + 2);
  176825. iPrevOut = iPrev;
  176826. }
  176827. }
  176828. setoutputs_col_out:
  176829. pIter->base.pData = pIter->poslist.p;
  176830. pIter->base.nData = aOut - pIter->poslist.p;
  176831. }
  176832. }
  176833. /*
  176834. ** xSetOutputs callback used by detail=full when there is a column filter.
  176835. */
  176836. static void fts5IterSetOutputs_Full(Fts5Iter *pIter, Fts5SegIter *pSeg){
  176837. Fts5Colset *pColset = pIter->pColset;
  176838. pIter->base.iRowid = pSeg->iRowid;
  176839. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_FULL );
  176840. assert( pColset );
  176841. if( pSeg->iLeafOffset+pSeg->nPos<=pSeg->pLeaf->szLeaf ){
  176842. /* All data is stored on the current page. Populate the output
  176843. ** variables to point into the body of the page object. */
  176844. const u8 *a = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  176845. if( pColset->nCol==1 ){
  176846. pIter->base.nData = fts5IndexExtractCol(&a, pSeg->nPos,pColset->aiCol[0]);
  176847. pIter->base.pData = a;
  176848. }else{
  176849. fts5BufferZero(&pIter->poslist);
  176850. fts5IndexExtractColset(pColset, a, pSeg->nPos, &pIter->poslist);
  176851. pIter->base.pData = pIter->poslist.p;
  176852. pIter->base.nData = pIter->poslist.n;
  176853. }
  176854. }else{
  176855. /* The data is distributed over two or more pages. Copy it into the
  176856. ** Fts5Iter.poslist buffer and then set the output pointer to point
  176857. ** to this buffer. */
  176858. fts5BufferZero(&pIter->poslist);
  176859. fts5SegiterPoslist(pIter->pIndex, pSeg, pColset, &pIter->poslist);
  176860. pIter->base.pData = pIter->poslist.p;
  176861. pIter->base.nData = pIter->poslist.n;
  176862. }
  176863. }
  176864. static void fts5IterSetOutputCb(int *pRc, Fts5Iter *pIter){
  176865. if( *pRc==SQLITE_OK ){
  176866. Fts5Config *pConfig = pIter->pIndex->pConfig;
  176867. if( pConfig->eDetail==FTS5_DETAIL_NONE ){
  176868. pIter->xSetOutputs = fts5IterSetOutputs_None;
  176869. }
  176870. else if( pIter->pColset==0 ){
  176871. pIter->xSetOutputs = fts5IterSetOutputs_Nocolset;
  176872. }
  176873. else if( pIter->pColset->nCol==0 ){
  176874. pIter->xSetOutputs = fts5IterSetOutputs_ZeroColset;
  176875. }
  176876. else if( pConfig->eDetail==FTS5_DETAIL_FULL ){
  176877. pIter->xSetOutputs = fts5IterSetOutputs_Full;
  176878. }
  176879. else{
  176880. assert( pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  176881. if( pConfig->nCol<=100 ){
  176882. pIter->xSetOutputs = fts5IterSetOutputs_Col100;
  176883. sqlite3Fts5BufferSize(pRc, &pIter->poslist, pConfig->nCol);
  176884. }else{
  176885. pIter->xSetOutputs = fts5IterSetOutputs_Col;
  176886. }
  176887. }
  176888. }
  176889. }
  176890. /*
  176891. ** Allocate a new Fts5Iter object.
  176892. **
  176893. ** The new object will be used to iterate through data in structure pStruct.
  176894. ** If iLevel is -ve, then all data in all segments is merged. Or, if iLevel
  176895. ** is zero or greater, data from the first nSegment segments on level iLevel
  176896. ** is merged.
  176897. **
  176898. ** The iterator initially points to the first term/rowid entry in the
  176899. ** iterated data.
  176900. */
  176901. static void fts5MultiIterNew(
  176902. Fts5Index *p, /* FTS5 backend to iterate within */
  176903. Fts5Structure *pStruct, /* Structure of specific index */
  176904. int flags, /* FTS5INDEX_QUERY_XXX flags */
  176905. Fts5Colset *pColset, /* Colset to filter on (or NULL) */
  176906. const u8 *pTerm, int nTerm, /* Term to seek to (or NULL/0) */
  176907. int iLevel, /* Level to iterate (-1 for all) */
  176908. int nSegment, /* Number of segments to merge (iLevel>=0) */
  176909. Fts5Iter **ppOut /* New object */
  176910. ){
  176911. int nSeg = 0; /* Number of segment-iters in use */
  176912. int iIter = 0; /* */
  176913. int iSeg; /* Used to iterate through segments */
  176914. Fts5StructureLevel *pLvl;
  176915. Fts5Iter *pNew;
  176916. assert( (pTerm==0 && nTerm==0) || iLevel<0 );
  176917. /* Allocate space for the new multi-seg-iterator. */
  176918. if( p->rc==SQLITE_OK ){
  176919. if( iLevel<0 ){
  176920. assert( pStruct->nSegment==fts5StructureCountSegments(pStruct) );
  176921. nSeg = pStruct->nSegment;
  176922. nSeg += (p->pHash ? 1 : 0);
  176923. }else{
  176924. nSeg = MIN(pStruct->aLevel[iLevel].nSeg, nSegment);
  176925. }
  176926. }
  176927. *ppOut = pNew = fts5MultiIterAlloc(p, nSeg);
  176928. if( pNew==0 ) return;
  176929. pNew->bRev = (0!=(flags & FTS5INDEX_QUERY_DESC));
  176930. pNew->bSkipEmpty = (0!=(flags & FTS5INDEX_QUERY_SKIPEMPTY));
  176931. pNew->pStruct = pStruct;
  176932. pNew->pColset = pColset;
  176933. fts5StructureRef(pStruct);
  176934. if( (flags & FTS5INDEX_QUERY_NOOUTPUT)==0 ){
  176935. fts5IterSetOutputCb(&p->rc, pNew);
  176936. }
  176937. /* Initialize each of the component segment iterators. */
  176938. if( p->rc==SQLITE_OK ){
  176939. if( iLevel<0 ){
  176940. Fts5StructureLevel *pEnd = &pStruct->aLevel[pStruct->nLevel];
  176941. if( p->pHash ){
  176942. /* Add a segment iterator for the current contents of the hash table. */
  176943. Fts5SegIter *pIter = &pNew->aSeg[iIter++];
  176944. fts5SegIterHashInit(p, pTerm, nTerm, flags, pIter);
  176945. }
  176946. for(pLvl=&pStruct->aLevel[0]; pLvl<pEnd; pLvl++){
  176947. for(iSeg=pLvl->nSeg-1; iSeg>=0; iSeg--){
  176948. Fts5StructureSegment *pSeg = &pLvl->aSeg[iSeg];
  176949. Fts5SegIter *pIter = &pNew->aSeg[iIter++];
  176950. if( pTerm==0 ){
  176951. fts5SegIterInit(p, pSeg, pIter);
  176952. }else{
  176953. fts5SegIterSeekInit(p, pTerm, nTerm, flags, pSeg, pIter);
  176954. }
  176955. }
  176956. }
  176957. }else{
  176958. pLvl = &pStruct->aLevel[iLevel];
  176959. for(iSeg=nSeg-1; iSeg>=0; iSeg--){
  176960. fts5SegIterInit(p, &pLvl->aSeg[iSeg], &pNew->aSeg[iIter++]);
  176961. }
  176962. }
  176963. assert( iIter==nSeg );
  176964. }
  176965. /* If the above was successful, each component iterators now points
  176966. ** to the first entry in its segment. In this case initialize the
  176967. ** aFirst[] array. Or, if an error has occurred, free the iterator
  176968. ** object and set the output variable to NULL. */
  176969. if( p->rc==SQLITE_OK ){
  176970. for(iIter=pNew->nSeg-1; iIter>0; iIter--){
  176971. int iEq;
  176972. if( (iEq = fts5MultiIterDoCompare(pNew, iIter)) ){
  176973. Fts5SegIter *pSeg = &pNew->aSeg[iEq];
  176974. if( p->rc==SQLITE_OK ) pSeg->xNext(p, pSeg, 0);
  176975. fts5MultiIterAdvanced(p, pNew, iEq, iIter);
  176976. }
  176977. }
  176978. fts5MultiIterSetEof(pNew);
  176979. fts5AssertMultiIterSetup(p, pNew);
  176980. if( pNew->bSkipEmpty && fts5MultiIterIsEmpty(p, pNew) ){
  176981. fts5MultiIterNext(p, pNew, 0, 0);
  176982. }else if( pNew->base.bEof==0 ){
  176983. Fts5SegIter *pSeg = &pNew->aSeg[pNew->aFirst[1].iFirst];
  176984. pNew->xSetOutputs(pNew, pSeg);
  176985. }
  176986. }else{
  176987. fts5MultiIterFree(pNew);
  176988. *ppOut = 0;
  176989. }
  176990. }
  176991. /*
  176992. ** Create an Fts5Iter that iterates through the doclist provided
  176993. ** as the second argument.
  176994. */
  176995. static void fts5MultiIterNew2(
  176996. Fts5Index *p, /* FTS5 backend to iterate within */
  176997. Fts5Data *pData, /* Doclist to iterate through */
  176998. int bDesc, /* True for descending rowid order */
  176999. Fts5Iter **ppOut /* New object */
  177000. ){
  177001. Fts5Iter *pNew;
  177002. pNew = fts5MultiIterAlloc(p, 2);
  177003. if( pNew ){
  177004. Fts5SegIter *pIter = &pNew->aSeg[1];
  177005. pIter->flags = FTS5_SEGITER_ONETERM;
  177006. if( pData->szLeaf>0 ){
  177007. pIter->pLeaf = pData;
  177008. pIter->iLeafOffset = fts5GetVarint(pData->p, (u64*)&pIter->iRowid);
  177009. pIter->iEndofDoclist = pData->nn;
  177010. pNew->aFirst[1].iFirst = 1;
  177011. if( bDesc ){
  177012. pNew->bRev = 1;
  177013. pIter->flags |= FTS5_SEGITER_REVERSE;
  177014. fts5SegIterReverseInitPage(p, pIter);
  177015. }else{
  177016. fts5SegIterLoadNPos(p, pIter);
  177017. }
  177018. pData = 0;
  177019. }else{
  177020. pNew->base.bEof = 1;
  177021. }
  177022. fts5SegIterSetNext(p, pIter);
  177023. *ppOut = pNew;
  177024. }
  177025. fts5DataRelease(pData);
  177026. }
  177027. /*
  177028. ** Return true if the iterator is at EOF or if an error has occurred.
  177029. ** False otherwise.
  177030. */
  177031. static int fts5MultiIterEof(Fts5Index *p, Fts5Iter *pIter){
  177032. assert( p->rc
  177033. || (pIter->aSeg[ pIter->aFirst[1].iFirst ].pLeaf==0)==pIter->base.bEof
  177034. );
  177035. return (p->rc || pIter->base.bEof);
  177036. }
  177037. /*
  177038. ** Return the rowid of the entry that the iterator currently points
  177039. ** to. If the iterator points to EOF when this function is called the
  177040. ** results are undefined.
  177041. */
  177042. static i64 fts5MultiIterRowid(Fts5Iter *pIter){
  177043. assert( pIter->aSeg[ pIter->aFirst[1].iFirst ].pLeaf );
  177044. return pIter->aSeg[ pIter->aFirst[1].iFirst ].iRowid;
  177045. }
  177046. /*
  177047. ** Move the iterator to the next entry at or following iMatch.
  177048. */
  177049. static void fts5MultiIterNextFrom(
  177050. Fts5Index *p,
  177051. Fts5Iter *pIter,
  177052. i64 iMatch
  177053. ){
  177054. while( 1 ){
  177055. i64 iRowid;
  177056. fts5MultiIterNext(p, pIter, 1, iMatch);
  177057. if( fts5MultiIterEof(p, pIter) ) break;
  177058. iRowid = fts5MultiIterRowid(pIter);
  177059. if( pIter->bRev==0 && iRowid>=iMatch ) break;
  177060. if( pIter->bRev!=0 && iRowid<=iMatch ) break;
  177061. }
  177062. }
  177063. /*
  177064. ** Return a pointer to a buffer containing the term associated with the
  177065. ** entry that the iterator currently points to.
  177066. */
  177067. static const u8 *fts5MultiIterTerm(Fts5Iter *pIter, int *pn){
  177068. Fts5SegIter *p = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  177069. *pn = p->term.n;
  177070. return p->term.p;
  177071. }
  177072. /*
  177073. ** Allocate a new segment-id for the structure pStruct. The new segment
  177074. ** id must be between 1 and 65335 inclusive, and must not be used by
  177075. ** any currently existing segment. If a free segment id cannot be found,
  177076. ** SQLITE_FULL is returned.
  177077. **
  177078. ** If an error has already occurred, this function is a no-op. 0 is
  177079. ** returned in this case.
  177080. */
  177081. static int fts5AllocateSegid(Fts5Index *p, Fts5Structure *pStruct){
  177082. int iSegid = 0;
  177083. if( p->rc==SQLITE_OK ){
  177084. if( pStruct->nSegment>=FTS5_MAX_SEGMENT ){
  177085. p->rc = SQLITE_FULL;
  177086. }else{
  177087. /* FTS5_MAX_SEGMENT is currently defined as 2000. So the following
  177088. ** array is 63 elements, or 252 bytes, in size. */
  177089. u32 aUsed[(FTS5_MAX_SEGMENT+31) / 32];
  177090. int iLvl, iSeg;
  177091. int i;
  177092. u32 mask;
  177093. memset(aUsed, 0, sizeof(aUsed));
  177094. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  177095. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  177096. int iId = pStruct->aLevel[iLvl].aSeg[iSeg].iSegid;
  177097. if( iId<=FTS5_MAX_SEGMENT ){
  177098. aUsed[(iId-1) / 32] |= 1 << ((iId-1) % 32);
  177099. }
  177100. }
  177101. }
  177102. for(i=0; aUsed[i]==0xFFFFFFFF; i++);
  177103. mask = aUsed[i];
  177104. for(iSegid=0; mask & (1 << iSegid); iSegid++);
  177105. iSegid += 1 + i*32;
  177106. #ifdef SQLITE_DEBUG
  177107. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  177108. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  177109. assert( iSegid!=pStruct->aLevel[iLvl].aSeg[iSeg].iSegid );
  177110. }
  177111. }
  177112. assert( iSegid>0 && iSegid<=FTS5_MAX_SEGMENT );
  177113. {
  177114. sqlite3_stmt *pIdxSelect = fts5IdxSelectStmt(p);
  177115. if( p->rc==SQLITE_OK ){
  177116. u8 aBlob[2] = {0xff, 0xff};
  177117. sqlite3_bind_int(pIdxSelect, 1, iSegid);
  177118. sqlite3_bind_blob(pIdxSelect, 2, aBlob, 2, SQLITE_STATIC);
  177119. assert( sqlite3_step(pIdxSelect)!=SQLITE_ROW );
  177120. p->rc = sqlite3_reset(pIdxSelect);
  177121. }
  177122. }
  177123. #endif
  177124. }
  177125. }
  177126. return iSegid;
  177127. }
  177128. /*
  177129. ** Discard all data currently cached in the hash-tables.
  177130. */
  177131. static void fts5IndexDiscardData(Fts5Index *p){
  177132. assert( p->pHash || p->nPendingData==0 );
  177133. if( p->pHash ){
  177134. sqlite3Fts5HashClear(p->pHash);
  177135. p->nPendingData = 0;
  177136. }
  177137. }
  177138. /*
  177139. ** Return the size of the prefix, in bytes, that buffer
  177140. ** (pNew/<length-unknown>) shares with buffer (pOld/nOld).
  177141. **
  177142. ** Buffer (pNew/<length-unknown>) is guaranteed to be greater
  177143. ** than buffer (pOld/nOld).
  177144. */
  177145. static int fts5PrefixCompress(int nOld, const u8 *pOld, const u8 *pNew){
  177146. int i;
  177147. for(i=0; i<nOld; i++){
  177148. if( pOld[i]!=pNew[i] ) break;
  177149. }
  177150. return i;
  177151. }
  177152. static void fts5WriteDlidxClear(
  177153. Fts5Index *p,
  177154. Fts5SegWriter *pWriter,
  177155. int bFlush /* If true, write dlidx to disk */
  177156. ){
  177157. int i;
  177158. assert( bFlush==0 || (pWriter->nDlidx>0 && pWriter->aDlidx[0].buf.n>0) );
  177159. for(i=0; i<pWriter->nDlidx; i++){
  177160. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[i];
  177161. if( pDlidx->buf.n==0 ) break;
  177162. if( bFlush ){
  177163. assert( pDlidx->pgno!=0 );
  177164. fts5DataWrite(p,
  177165. FTS5_DLIDX_ROWID(pWriter->iSegid, i, pDlidx->pgno),
  177166. pDlidx->buf.p, pDlidx->buf.n
  177167. );
  177168. }
  177169. sqlite3Fts5BufferZero(&pDlidx->buf);
  177170. pDlidx->bPrevValid = 0;
  177171. }
  177172. }
  177173. /*
  177174. ** Grow the pWriter->aDlidx[] array to at least nLvl elements in size.
  177175. ** Any new array elements are zeroed before returning.
  177176. */
  177177. static int fts5WriteDlidxGrow(
  177178. Fts5Index *p,
  177179. Fts5SegWriter *pWriter,
  177180. int nLvl
  177181. ){
  177182. if( p->rc==SQLITE_OK && nLvl>=pWriter->nDlidx ){
  177183. Fts5DlidxWriter *aDlidx = (Fts5DlidxWriter*)sqlite3_realloc(
  177184. pWriter->aDlidx, sizeof(Fts5DlidxWriter) * nLvl
  177185. );
  177186. if( aDlidx==0 ){
  177187. p->rc = SQLITE_NOMEM;
  177188. }else{
  177189. int nByte = sizeof(Fts5DlidxWriter) * (nLvl - pWriter->nDlidx);
  177190. memset(&aDlidx[pWriter->nDlidx], 0, nByte);
  177191. pWriter->aDlidx = aDlidx;
  177192. pWriter->nDlidx = nLvl;
  177193. }
  177194. }
  177195. return p->rc;
  177196. }
  177197. /*
  177198. ** If the current doclist-index accumulating in pWriter->aDlidx[] is large
  177199. ** enough, flush it to disk and return 1. Otherwise discard it and return
  177200. ** zero.
  177201. */
  177202. static int fts5WriteFlushDlidx(Fts5Index *p, Fts5SegWriter *pWriter){
  177203. int bFlag = 0;
  177204. /* If there were FTS5_MIN_DLIDX_SIZE or more empty leaf pages written
  177205. ** to the database, also write the doclist-index to disk. */
  177206. if( pWriter->aDlidx[0].buf.n>0 && pWriter->nEmpty>=FTS5_MIN_DLIDX_SIZE ){
  177207. bFlag = 1;
  177208. }
  177209. fts5WriteDlidxClear(p, pWriter, bFlag);
  177210. pWriter->nEmpty = 0;
  177211. return bFlag;
  177212. }
  177213. /*
  177214. ** This function is called whenever processing of the doclist for the
  177215. ** last term on leaf page (pWriter->iBtPage) is completed.
  177216. **
  177217. ** The doclist-index for that term is currently stored in-memory within the
  177218. ** Fts5SegWriter.aDlidx[] array. If it is large enough, this function
  177219. ** writes it out to disk. Or, if it is too small to bother with, discards
  177220. ** it.
  177221. **
  177222. ** Fts5SegWriter.btterm currently contains the first term on page iBtPage.
  177223. */
  177224. static void fts5WriteFlushBtree(Fts5Index *p, Fts5SegWriter *pWriter){
  177225. int bFlag;
  177226. assert( pWriter->iBtPage || pWriter->nEmpty==0 );
  177227. if( pWriter->iBtPage==0 ) return;
  177228. bFlag = fts5WriteFlushDlidx(p, pWriter);
  177229. if( p->rc==SQLITE_OK ){
  177230. const char *z = (pWriter->btterm.n>0?(const char*)pWriter->btterm.p:"");
  177231. /* The following was already done in fts5WriteInit(): */
  177232. /* sqlite3_bind_int(p->pIdxWriter, 1, pWriter->iSegid); */
  177233. sqlite3_bind_blob(p->pIdxWriter, 2, z, pWriter->btterm.n, SQLITE_STATIC);
  177234. sqlite3_bind_int64(p->pIdxWriter, 3, bFlag + ((i64)pWriter->iBtPage<<1));
  177235. sqlite3_step(p->pIdxWriter);
  177236. p->rc = sqlite3_reset(p->pIdxWriter);
  177237. }
  177238. pWriter->iBtPage = 0;
  177239. }
  177240. /*
  177241. ** This is called once for each leaf page except the first that contains
  177242. ** at least one term. Argument (nTerm/pTerm) is the split-key - a term that
  177243. ** is larger than all terms written to earlier leaves, and equal to or
  177244. ** smaller than the first term on the new leaf.
  177245. **
  177246. ** If an error occurs, an error code is left in Fts5Index.rc. If an error
  177247. ** has already occurred when this function is called, it is a no-op.
  177248. */
  177249. static void fts5WriteBtreeTerm(
  177250. Fts5Index *p, /* FTS5 backend object */
  177251. Fts5SegWriter *pWriter, /* Writer object */
  177252. int nTerm, const u8 *pTerm /* First term on new page */
  177253. ){
  177254. fts5WriteFlushBtree(p, pWriter);
  177255. fts5BufferSet(&p->rc, &pWriter->btterm, nTerm, pTerm);
  177256. pWriter->iBtPage = pWriter->writer.pgno;
  177257. }
  177258. /*
  177259. ** This function is called when flushing a leaf page that contains no
  177260. ** terms at all to disk.
  177261. */
  177262. static void fts5WriteBtreeNoTerm(
  177263. Fts5Index *p, /* FTS5 backend object */
  177264. Fts5SegWriter *pWriter /* Writer object */
  177265. ){
  177266. /* If there were no rowids on the leaf page either and the doclist-index
  177267. ** has already been started, append an 0x00 byte to it. */
  177268. if( pWriter->bFirstRowidInPage && pWriter->aDlidx[0].buf.n>0 ){
  177269. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[0];
  177270. assert( pDlidx->bPrevValid );
  177271. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, 0);
  177272. }
  177273. /* Increment the "number of sequential leaves without a term" counter. */
  177274. pWriter->nEmpty++;
  177275. }
  177276. static i64 fts5DlidxExtractFirstRowid(Fts5Buffer *pBuf){
  177277. i64 iRowid;
  177278. int iOff;
  177279. iOff = 1 + fts5GetVarint(&pBuf->p[1], (u64*)&iRowid);
  177280. fts5GetVarint(&pBuf->p[iOff], (u64*)&iRowid);
  177281. return iRowid;
  177282. }
  177283. /*
  177284. ** Rowid iRowid has just been appended to the current leaf page. It is the
  177285. ** first on the page. This function appends an appropriate entry to the current
  177286. ** doclist-index.
  177287. */
  177288. static void fts5WriteDlidxAppend(
  177289. Fts5Index *p,
  177290. Fts5SegWriter *pWriter,
  177291. i64 iRowid
  177292. ){
  177293. int i;
  177294. int bDone = 0;
  177295. for(i=0; p->rc==SQLITE_OK && bDone==0; i++){
  177296. i64 iVal;
  177297. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[i];
  177298. if( pDlidx->buf.n>=p->pConfig->pgsz ){
  177299. /* The current doclist-index page is full. Write it to disk and push
  177300. ** a copy of iRowid (which will become the first rowid on the next
  177301. ** doclist-index leaf page) up into the next level of the b-tree
  177302. ** hierarchy. If the node being flushed is currently the root node,
  177303. ** also push its first rowid upwards. */
  177304. pDlidx->buf.p[0] = 0x01; /* Not the root node */
  177305. fts5DataWrite(p,
  177306. FTS5_DLIDX_ROWID(pWriter->iSegid, i, pDlidx->pgno),
  177307. pDlidx->buf.p, pDlidx->buf.n
  177308. );
  177309. fts5WriteDlidxGrow(p, pWriter, i+2);
  177310. pDlidx = &pWriter->aDlidx[i];
  177311. if( p->rc==SQLITE_OK && pDlidx[1].buf.n==0 ){
  177312. i64 iFirst = fts5DlidxExtractFirstRowid(&pDlidx->buf);
  177313. /* This was the root node. Push its first rowid up to the new root. */
  177314. pDlidx[1].pgno = pDlidx->pgno;
  177315. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, 0);
  177316. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, pDlidx->pgno);
  177317. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, iFirst);
  177318. pDlidx[1].bPrevValid = 1;
  177319. pDlidx[1].iPrev = iFirst;
  177320. }
  177321. sqlite3Fts5BufferZero(&pDlidx->buf);
  177322. pDlidx->bPrevValid = 0;
  177323. pDlidx->pgno++;
  177324. }else{
  177325. bDone = 1;
  177326. }
  177327. if( pDlidx->bPrevValid ){
  177328. iVal = iRowid - pDlidx->iPrev;
  177329. }else{
  177330. i64 iPgno = (i==0 ? pWriter->writer.pgno : pDlidx[-1].pgno);
  177331. assert( pDlidx->buf.n==0 );
  177332. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, !bDone);
  177333. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, iPgno);
  177334. iVal = iRowid;
  177335. }
  177336. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, iVal);
  177337. pDlidx->bPrevValid = 1;
  177338. pDlidx->iPrev = iRowid;
  177339. }
  177340. }
  177341. static void fts5WriteFlushLeaf(Fts5Index *p, Fts5SegWriter *pWriter){
  177342. static const u8 zero[] = { 0x00, 0x00, 0x00, 0x00 };
  177343. Fts5PageWriter *pPage = &pWriter->writer;
  177344. i64 iRowid;
  177345. static int nCall = 0;
  177346. nCall++;
  177347. assert( (pPage->pgidx.n==0)==(pWriter->bFirstTermInPage) );
  177348. /* Set the szLeaf header field. */
  177349. assert( 0==fts5GetU16(&pPage->buf.p[2]) );
  177350. fts5PutU16(&pPage->buf.p[2], (u16)pPage->buf.n);
  177351. if( pWriter->bFirstTermInPage ){
  177352. /* No term was written to this page. */
  177353. assert( pPage->pgidx.n==0 );
  177354. fts5WriteBtreeNoTerm(p, pWriter);
  177355. }else{
  177356. /* Append the pgidx to the page buffer. Set the szLeaf header field. */
  177357. fts5BufferAppendBlob(&p->rc, &pPage->buf, pPage->pgidx.n, pPage->pgidx.p);
  177358. }
  177359. /* Write the page out to disk */
  177360. iRowid = FTS5_SEGMENT_ROWID(pWriter->iSegid, pPage->pgno);
  177361. fts5DataWrite(p, iRowid, pPage->buf.p, pPage->buf.n);
  177362. /* Initialize the next page. */
  177363. fts5BufferZero(&pPage->buf);
  177364. fts5BufferZero(&pPage->pgidx);
  177365. fts5BufferAppendBlob(&p->rc, &pPage->buf, 4, zero);
  177366. pPage->iPrevPgidx = 0;
  177367. pPage->pgno++;
  177368. /* Increase the leaves written counter */
  177369. pWriter->nLeafWritten++;
  177370. /* The new leaf holds no terms or rowids */
  177371. pWriter->bFirstTermInPage = 1;
  177372. pWriter->bFirstRowidInPage = 1;
  177373. }
  177374. /*
  177375. ** Append term pTerm/nTerm to the segment being written by the writer passed
  177376. ** as the second argument.
  177377. **
  177378. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  177379. ** already occurred, this function is a no-op.
  177380. */
  177381. static void fts5WriteAppendTerm(
  177382. Fts5Index *p,
  177383. Fts5SegWriter *pWriter,
  177384. int nTerm, const u8 *pTerm
  177385. ){
  177386. int nPrefix; /* Bytes of prefix compression for term */
  177387. Fts5PageWriter *pPage = &pWriter->writer;
  177388. Fts5Buffer *pPgidx = &pWriter->writer.pgidx;
  177389. assert( p->rc==SQLITE_OK );
  177390. assert( pPage->buf.n>=4 );
  177391. assert( pPage->buf.n>4 || pWriter->bFirstTermInPage );
  177392. /* If the current leaf page is full, flush it to disk. */
  177393. if( (pPage->buf.n + pPgidx->n + nTerm + 2)>=p->pConfig->pgsz ){
  177394. if( pPage->buf.n>4 ){
  177395. fts5WriteFlushLeaf(p, pWriter);
  177396. }
  177397. fts5BufferGrow(&p->rc, &pPage->buf, nTerm+FTS5_DATA_PADDING);
  177398. }
  177399. /* TODO1: Updating pgidx here. */
  177400. pPgidx->n += sqlite3Fts5PutVarint(
  177401. &pPgidx->p[pPgidx->n], pPage->buf.n - pPage->iPrevPgidx
  177402. );
  177403. pPage->iPrevPgidx = pPage->buf.n;
  177404. #if 0
  177405. fts5PutU16(&pPgidx->p[pPgidx->n], pPage->buf.n);
  177406. pPgidx->n += 2;
  177407. #endif
  177408. if( pWriter->bFirstTermInPage ){
  177409. nPrefix = 0;
  177410. if( pPage->pgno!=1 ){
  177411. /* This is the first term on a leaf that is not the leftmost leaf in
  177412. ** the segment b-tree. In this case it is necessary to add a term to
  177413. ** the b-tree hierarchy that is (a) larger than the largest term
  177414. ** already written to the segment and (b) smaller than or equal to
  177415. ** this term. In other words, a prefix of (pTerm/nTerm) that is one
  177416. ** byte longer than the longest prefix (pTerm/nTerm) shares with the
  177417. ** previous term.
  177418. **
  177419. ** Usually, the previous term is available in pPage->term. The exception
  177420. ** is if this is the first term written in an incremental-merge step.
  177421. ** In this case the previous term is not available, so just write a
  177422. ** copy of (pTerm/nTerm) into the parent node. This is slightly
  177423. ** inefficient, but still correct. */
  177424. int n = nTerm;
  177425. if( pPage->term.n ){
  177426. n = 1 + fts5PrefixCompress(pPage->term.n, pPage->term.p, pTerm);
  177427. }
  177428. fts5WriteBtreeTerm(p, pWriter, n, pTerm);
  177429. pPage = &pWriter->writer;
  177430. }
  177431. }else{
  177432. nPrefix = fts5PrefixCompress(pPage->term.n, pPage->term.p, pTerm);
  177433. fts5BufferAppendVarint(&p->rc, &pPage->buf, nPrefix);
  177434. }
  177435. /* Append the number of bytes of new data, then the term data itself
  177436. ** to the page. */
  177437. fts5BufferAppendVarint(&p->rc, &pPage->buf, nTerm - nPrefix);
  177438. fts5BufferAppendBlob(&p->rc, &pPage->buf, nTerm - nPrefix, &pTerm[nPrefix]);
  177439. /* Update the Fts5PageWriter.term field. */
  177440. fts5BufferSet(&p->rc, &pPage->term, nTerm, pTerm);
  177441. pWriter->bFirstTermInPage = 0;
  177442. pWriter->bFirstRowidInPage = 0;
  177443. pWriter->bFirstRowidInDoclist = 1;
  177444. assert( p->rc || (pWriter->nDlidx>0 && pWriter->aDlidx[0].buf.n==0) );
  177445. pWriter->aDlidx[0].pgno = pPage->pgno;
  177446. }
  177447. /*
  177448. ** Append a rowid and position-list size field to the writers output.
  177449. */
  177450. static void fts5WriteAppendRowid(
  177451. Fts5Index *p,
  177452. Fts5SegWriter *pWriter,
  177453. i64 iRowid
  177454. ){
  177455. if( p->rc==SQLITE_OK ){
  177456. Fts5PageWriter *pPage = &pWriter->writer;
  177457. if( (pPage->buf.n + pPage->pgidx.n)>=p->pConfig->pgsz ){
  177458. fts5WriteFlushLeaf(p, pWriter);
  177459. }
  177460. /* If this is to be the first rowid written to the page, set the
  177461. ** rowid-pointer in the page-header. Also append a value to the dlidx
  177462. ** buffer, in case a doclist-index is required. */
  177463. if( pWriter->bFirstRowidInPage ){
  177464. fts5PutU16(pPage->buf.p, (u16)pPage->buf.n);
  177465. fts5WriteDlidxAppend(p, pWriter, iRowid);
  177466. }
  177467. /* Write the rowid. */
  177468. if( pWriter->bFirstRowidInDoclist || pWriter->bFirstRowidInPage ){
  177469. fts5BufferAppendVarint(&p->rc, &pPage->buf, iRowid);
  177470. }else{
  177471. assert( p->rc || iRowid>pWriter->iPrevRowid );
  177472. fts5BufferAppendVarint(&p->rc, &pPage->buf, iRowid - pWriter->iPrevRowid);
  177473. }
  177474. pWriter->iPrevRowid = iRowid;
  177475. pWriter->bFirstRowidInDoclist = 0;
  177476. pWriter->bFirstRowidInPage = 0;
  177477. }
  177478. }
  177479. static void fts5WriteAppendPoslistData(
  177480. Fts5Index *p,
  177481. Fts5SegWriter *pWriter,
  177482. const u8 *aData,
  177483. int nData
  177484. ){
  177485. Fts5PageWriter *pPage = &pWriter->writer;
  177486. const u8 *a = aData;
  177487. int n = nData;
  177488. assert( p->pConfig->pgsz>0 );
  177489. while( p->rc==SQLITE_OK
  177490. && (pPage->buf.n + pPage->pgidx.n + n)>=p->pConfig->pgsz
  177491. ){
  177492. int nReq = p->pConfig->pgsz - pPage->buf.n - pPage->pgidx.n;
  177493. int nCopy = 0;
  177494. while( nCopy<nReq ){
  177495. i64 dummy;
  177496. nCopy += fts5GetVarint(&a[nCopy], (u64*)&dummy);
  177497. }
  177498. fts5BufferAppendBlob(&p->rc, &pPage->buf, nCopy, a);
  177499. a += nCopy;
  177500. n -= nCopy;
  177501. fts5WriteFlushLeaf(p, pWriter);
  177502. }
  177503. if( n>0 ){
  177504. fts5BufferAppendBlob(&p->rc, &pPage->buf, n, a);
  177505. }
  177506. }
  177507. /*
  177508. ** Flush any data cached by the writer object to the database. Free any
  177509. ** allocations associated with the writer.
  177510. */
  177511. static void fts5WriteFinish(
  177512. Fts5Index *p,
  177513. Fts5SegWriter *pWriter, /* Writer object */
  177514. int *pnLeaf /* OUT: Number of leaf pages in b-tree */
  177515. ){
  177516. int i;
  177517. Fts5PageWriter *pLeaf = &pWriter->writer;
  177518. if( p->rc==SQLITE_OK ){
  177519. assert( pLeaf->pgno>=1 );
  177520. if( pLeaf->buf.n>4 ){
  177521. fts5WriteFlushLeaf(p, pWriter);
  177522. }
  177523. *pnLeaf = pLeaf->pgno-1;
  177524. if( pLeaf->pgno>1 ){
  177525. fts5WriteFlushBtree(p, pWriter);
  177526. }
  177527. }
  177528. fts5BufferFree(&pLeaf->term);
  177529. fts5BufferFree(&pLeaf->buf);
  177530. fts5BufferFree(&pLeaf->pgidx);
  177531. fts5BufferFree(&pWriter->btterm);
  177532. for(i=0; i<pWriter->nDlidx; i++){
  177533. sqlite3Fts5BufferFree(&pWriter->aDlidx[i].buf);
  177534. }
  177535. sqlite3_free(pWriter->aDlidx);
  177536. }
  177537. static void fts5WriteInit(
  177538. Fts5Index *p,
  177539. Fts5SegWriter *pWriter,
  177540. int iSegid
  177541. ){
  177542. const int nBuffer = p->pConfig->pgsz + FTS5_DATA_PADDING;
  177543. memset(pWriter, 0, sizeof(Fts5SegWriter));
  177544. pWriter->iSegid = iSegid;
  177545. fts5WriteDlidxGrow(p, pWriter, 1);
  177546. pWriter->writer.pgno = 1;
  177547. pWriter->bFirstTermInPage = 1;
  177548. pWriter->iBtPage = 1;
  177549. assert( pWriter->writer.buf.n==0 );
  177550. assert( pWriter->writer.pgidx.n==0 );
  177551. /* Grow the two buffers to pgsz + padding bytes in size. */
  177552. sqlite3Fts5BufferSize(&p->rc, &pWriter->writer.pgidx, nBuffer);
  177553. sqlite3Fts5BufferSize(&p->rc, &pWriter->writer.buf, nBuffer);
  177554. if( p->pIdxWriter==0 ){
  177555. Fts5Config *pConfig = p->pConfig;
  177556. fts5IndexPrepareStmt(p, &p->pIdxWriter, sqlite3_mprintf(
  177557. "INSERT INTO '%q'.'%q_idx'(segid,term,pgno) VALUES(?,?,?)",
  177558. pConfig->zDb, pConfig->zName
  177559. ));
  177560. }
  177561. if( p->rc==SQLITE_OK ){
  177562. /* Initialize the 4-byte leaf-page header to 0x00. */
  177563. memset(pWriter->writer.buf.p, 0, 4);
  177564. pWriter->writer.buf.n = 4;
  177565. /* Bind the current output segment id to the index-writer. This is an
  177566. ** optimization over binding the same value over and over as rows are
  177567. ** inserted into %_idx by the current writer. */
  177568. sqlite3_bind_int(p->pIdxWriter, 1, pWriter->iSegid);
  177569. }
  177570. }
  177571. /*
  177572. ** Iterator pIter was used to iterate through the input segments of on an
  177573. ** incremental merge operation. This function is called if the incremental
  177574. ** merge step has finished but the input has not been completely exhausted.
  177575. */
  177576. static void fts5TrimSegments(Fts5Index *p, Fts5Iter *pIter){
  177577. int i;
  177578. Fts5Buffer buf;
  177579. memset(&buf, 0, sizeof(Fts5Buffer));
  177580. for(i=0; i<pIter->nSeg; i++){
  177581. Fts5SegIter *pSeg = &pIter->aSeg[i];
  177582. if( pSeg->pSeg==0 ){
  177583. /* no-op */
  177584. }else if( pSeg->pLeaf==0 ){
  177585. /* All keys from this input segment have been transfered to the output.
  177586. ** Set both the first and last page-numbers to 0 to indicate that the
  177587. ** segment is now empty. */
  177588. pSeg->pSeg->pgnoLast = 0;
  177589. pSeg->pSeg->pgnoFirst = 0;
  177590. }else{
  177591. int iOff = pSeg->iTermLeafOffset; /* Offset on new first leaf page */
  177592. i64 iLeafRowid;
  177593. Fts5Data *pData;
  177594. int iId = pSeg->pSeg->iSegid;
  177595. u8 aHdr[4] = {0x00, 0x00, 0x00, 0x00};
  177596. iLeafRowid = FTS5_SEGMENT_ROWID(iId, pSeg->iTermLeafPgno);
  177597. pData = fts5DataRead(p, iLeafRowid);
  177598. if( pData ){
  177599. fts5BufferZero(&buf);
  177600. fts5BufferGrow(&p->rc, &buf, pData->nn);
  177601. fts5BufferAppendBlob(&p->rc, &buf, sizeof(aHdr), aHdr);
  177602. fts5BufferAppendVarint(&p->rc, &buf, pSeg->term.n);
  177603. fts5BufferAppendBlob(&p->rc, &buf, pSeg->term.n, pSeg->term.p);
  177604. fts5BufferAppendBlob(&p->rc, &buf, pData->szLeaf-iOff, &pData->p[iOff]);
  177605. if( p->rc==SQLITE_OK ){
  177606. /* Set the szLeaf field */
  177607. fts5PutU16(&buf.p[2], (u16)buf.n);
  177608. }
  177609. /* Set up the new page-index array */
  177610. fts5BufferAppendVarint(&p->rc, &buf, 4);
  177611. if( pSeg->iLeafPgno==pSeg->iTermLeafPgno
  177612. && pSeg->iEndofDoclist<pData->szLeaf
  177613. ){
  177614. int nDiff = pData->szLeaf - pSeg->iEndofDoclist;
  177615. fts5BufferAppendVarint(&p->rc, &buf, buf.n - 1 - nDiff - 4);
  177616. fts5BufferAppendBlob(&p->rc, &buf,
  177617. pData->nn - pSeg->iPgidxOff, &pData->p[pSeg->iPgidxOff]
  177618. );
  177619. }
  177620. fts5DataRelease(pData);
  177621. pSeg->pSeg->pgnoFirst = pSeg->iTermLeafPgno;
  177622. fts5DataDelete(p, FTS5_SEGMENT_ROWID(iId, 1), iLeafRowid);
  177623. fts5DataWrite(p, iLeafRowid, buf.p, buf.n);
  177624. }
  177625. }
  177626. }
  177627. fts5BufferFree(&buf);
  177628. }
  177629. static void fts5MergeChunkCallback(
  177630. Fts5Index *p,
  177631. void *pCtx,
  177632. const u8 *pChunk, int nChunk
  177633. ){
  177634. Fts5SegWriter *pWriter = (Fts5SegWriter*)pCtx;
  177635. fts5WriteAppendPoslistData(p, pWriter, pChunk, nChunk);
  177636. }
  177637. /*
  177638. **
  177639. */
  177640. static void fts5IndexMergeLevel(
  177641. Fts5Index *p, /* FTS5 backend object */
  177642. Fts5Structure **ppStruct, /* IN/OUT: Stucture of index */
  177643. int iLvl, /* Level to read input from */
  177644. int *pnRem /* Write up to this many output leaves */
  177645. ){
  177646. Fts5Structure *pStruct = *ppStruct;
  177647. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  177648. Fts5StructureLevel *pLvlOut;
  177649. Fts5Iter *pIter = 0; /* Iterator to read input data */
  177650. int nRem = pnRem ? *pnRem : 0; /* Output leaf pages left to write */
  177651. int nInput; /* Number of input segments */
  177652. Fts5SegWriter writer; /* Writer object */
  177653. Fts5StructureSegment *pSeg; /* Output segment */
  177654. Fts5Buffer term;
  177655. int bOldest; /* True if the output segment is the oldest */
  177656. int eDetail = p->pConfig->eDetail;
  177657. const int flags = FTS5INDEX_QUERY_NOOUTPUT;
  177658. assert( iLvl<pStruct->nLevel );
  177659. assert( pLvl->nMerge<=pLvl->nSeg );
  177660. memset(&writer, 0, sizeof(Fts5SegWriter));
  177661. memset(&term, 0, sizeof(Fts5Buffer));
  177662. if( pLvl->nMerge ){
  177663. pLvlOut = &pStruct->aLevel[iLvl+1];
  177664. assert( pLvlOut->nSeg>0 );
  177665. nInput = pLvl->nMerge;
  177666. pSeg = &pLvlOut->aSeg[pLvlOut->nSeg-1];
  177667. fts5WriteInit(p, &writer, pSeg->iSegid);
  177668. writer.writer.pgno = pSeg->pgnoLast+1;
  177669. writer.iBtPage = 0;
  177670. }else{
  177671. int iSegid = fts5AllocateSegid(p, pStruct);
  177672. /* Extend the Fts5Structure object as required to ensure the output
  177673. ** segment exists. */
  177674. if( iLvl==pStruct->nLevel-1 ){
  177675. fts5StructureAddLevel(&p->rc, ppStruct);
  177676. pStruct = *ppStruct;
  177677. }
  177678. fts5StructureExtendLevel(&p->rc, pStruct, iLvl+1, 1, 0);
  177679. if( p->rc ) return;
  177680. pLvl = &pStruct->aLevel[iLvl];
  177681. pLvlOut = &pStruct->aLevel[iLvl+1];
  177682. fts5WriteInit(p, &writer, iSegid);
  177683. /* Add the new segment to the output level */
  177684. pSeg = &pLvlOut->aSeg[pLvlOut->nSeg];
  177685. pLvlOut->nSeg++;
  177686. pSeg->pgnoFirst = 1;
  177687. pSeg->iSegid = iSegid;
  177688. pStruct->nSegment++;
  177689. /* Read input from all segments in the input level */
  177690. nInput = pLvl->nSeg;
  177691. }
  177692. bOldest = (pLvlOut->nSeg==1 && pStruct->nLevel==iLvl+2);
  177693. assert( iLvl>=0 );
  177694. for(fts5MultiIterNew(p, pStruct, flags, 0, 0, 0, iLvl, nInput, &pIter);
  177695. fts5MultiIterEof(p, pIter)==0;
  177696. fts5MultiIterNext(p, pIter, 0, 0)
  177697. ){
  177698. Fts5SegIter *pSegIter = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  177699. int nPos; /* position-list size field value */
  177700. int nTerm;
  177701. const u8 *pTerm;
  177702. /* Check for key annihilation. */
  177703. if( pSegIter->nPos==0 && (bOldest || pSegIter->bDel==0) ) continue;
  177704. pTerm = fts5MultiIterTerm(pIter, &nTerm);
  177705. if( nTerm!=term.n || memcmp(pTerm, term.p, nTerm) ){
  177706. if( pnRem && writer.nLeafWritten>nRem ){
  177707. break;
  177708. }
  177709. /* This is a new term. Append a term to the output segment. */
  177710. fts5WriteAppendTerm(p, &writer, nTerm, pTerm);
  177711. fts5BufferSet(&p->rc, &term, nTerm, pTerm);
  177712. }
  177713. /* Append the rowid to the output */
  177714. /* WRITEPOSLISTSIZE */
  177715. fts5WriteAppendRowid(p, &writer, fts5MultiIterRowid(pIter));
  177716. if( eDetail==FTS5_DETAIL_NONE ){
  177717. if( pSegIter->bDel ){
  177718. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, 0);
  177719. if( pSegIter->nPos>0 ){
  177720. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, 0);
  177721. }
  177722. }
  177723. }else{
  177724. /* Append the position-list data to the output */
  177725. nPos = pSegIter->nPos*2 + pSegIter->bDel;
  177726. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, nPos);
  177727. fts5ChunkIterate(p, pSegIter, (void*)&writer, fts5MergeChunkCallback);
  177728. }
  177729. }
  177730. /* Flush the last leaf page to disk. Set the output segment b-tree height
  177731. ** and last leaf page number at the same time. */
  177732. fts5WriteFinish(p, &writer, &pSeg->pgnoLast);
  177733. if( fts5MultiIterEof(p, pIter) ){
  177734. int i;
  177735. /* Remove the redundant segments from the %_data table */
  177736. for(i=0; i<nInput; i++){
  177737. fts5DataRemoveSegment(p, pLvl->aSeg[i].iSegid);
  177738. }
  177739. /* Remove the redundant segments from the input level */
  177740. if( pLvl->nSeg!=nInput ){
  177741. int nMove = (pLvl->nSeg - nInput) * sizeof(Fts5StructureSegment);
  177742. memmove(pLvl->aSeg, &pLvl->aSeg[nInput], nMove);
  177743. }
  177744. pStruct->nSegment -= nInput;
  177745. pLvl->nSeg -= nInput;
  177746. pLvl->nMerge = 0;
  177747. if( pSeg->pgnoLast==0 ){
  177748. pLvlOut->nSeg--;
  177749. pStruct->nSegment--;
  177750. }
  177751. }else{
  177752. assert( pSeg->pgnoLast>0 );
  177753. fts5TrimSegments(p, pIter);
  177754. pLvl->nMerge = nInput;
  177755. }
  177756. fts5MultiIterFree(pIter);
  177757. fts5BufferFree(&term);
  177758. if( pnRem ) *pnRem -= writer.nLeafWritten;
  177759. }
  177760. /*
  177761. ** Do up to nPg pages of automerge work on the index.
  177762. **
  177763. ** Return true if any changes were actually made, or false otherwise.
  177764. */
  177765. static int fts5IndexMerge(
  177766. Fts5Index *p, /* FTS5 backend object */
  177767. Fts5Structure **ppStruct, /* IN/OUT: Current structure of index */
  177768. int nPg, /* Pages of work to do */
  177769. int nMin /* Minimum number of segments to merge */
  177770. ){
  177771. int nRem = nPg;
  177772. int bRet = 0;
  177773. Fts5Structure *pStruct = *ppStruct;
  177774. while( nRem>0 && p->rc==SQLITE_OK ){
  177775. int iLvl; /* To iterate through levels */
  177776. int iBestLvl = 0; /* Level offering the most input segments */
  177777. int nBest = 0; /* Number of input segments on best level */
  177778. /* Set iBestLvl to the level to read input segments from. */
  177779. assert( pStruct->nLevel>0 );
  177780. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  177781. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  177782. if( pLvl->nMerge ){
  177783. if( pLvl->nMerge>nBest ){
  177784. iBestLvl = iLvl;
  177785. nBest = pLvl->nMerge;
  177786. }
  177787. break;
  177788. }
  177789. if( pLvl->nSeg>nBest ){
  177790. nBest = pLvl->nSeg;
  177791. iBestLvl = iLvl;
  177792. }
  177793. }
  177794. /* If nBest is still 0, then the index must be empty. */
  177795. #ifdef SQLITE_DEBUG
  177796. for(iLvl=0; nBest==0 && iLvl<pStruct->nLevel; iLvl++){
  177797. assert( pStruct->aLevel[iLvl].nSeg==0 );
  177798. }
  177799. #endif
  177800. if( nBest<nMin && pStruct->aLevel[iBestLvl].nMerge==0 ){
  177801. break;
  177802. }
  177803. bRet = 1;
  177804. fts5IndexMergeLevel(p, &pStruct, iBestLvl, &nRem);
  177805. if( p->rc==SQLITE_OK && pStruct->aLevel[iBestLvl].nMerge==0 ){
  177806. fts5StructurePromote(p, iBestLvl+1, pStruct);
  177807. }
  177808. }
  177809. *ppStruct = pStruct;
  177810. return bRet;
  177811. }
  177812. /*
  177813. ** A total of nLeaf leaf pages of data has just been flushed to a level-0
  177814. ** segment. This function updates the write-counter accordingly and, if
  177815. ** necessary, performs incremental merge work.
  177816. **
  177817. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  177818. ** already occurred, this function is a no-op.
  177819. */
  177820. static void fts5IndexAutomerge(
  177821. Fts5Index *p, /* FTS5 backend object */
  177822. Fts5Structure **ppStruct, /* IN/OUT: Current structure of index */
  177823. int nLeaf /* Number of output leaves just written */
  177824. ){
  177825. if( p->rc==SQLITE_OK && p->pConfig->nAutomerge>0 ){
  177826. Fts5Structure *pStruct = *ppStruct;
  177827. u64 nWrite; /* Initial value of write-counter */
  177828. int nWork; /* Number of work-quanta to perform */
  177829. int nRem; /* Number of leaf pages left to write */
  177830. /* Update the write-counter. While doing so, set nWork. */
  177831. nWrite = pStruct->nWriteCounter;
  177832. nWork = (int)(((nWrite + nLeaf) / p->nWorkUnit) - (nWrite / p->nWorkUnit));
  177833. pStruct->nWriteCounter += nLeaf;
  177834. nRem = (int)(p->nWorkUnit * nWork * pStruct->nLevel);
  177835. fts5IndexMerge(p, ppStruct, nRem, p->pConfig->nAutomerge);
  177836. }
  177837. }
  177838. static void fts5IndexCrisismerge(
  177839. Fts5Index *p, /* FTS5 backend object */
  177840. Fts5Structure **ppStruct /* IN/OUT: Current structure of index */
  177841. ){
  177842. const int nCrisis = p->pConfig->nCrisisMerge;
  177843. Fts5Structure *pStruct = *ppStruct;
  177844. int iLvl = 0;
  177845. assert( p->rc!=SQLITE_OK || pStruct->nLevel>0 );
  177846. while( p->rc==SQLITE_OK && pStruct->aLevel[iLvl].nSeg>=nCrisis ){
  177847. fts5IndexMergeLevel(p, &pStruct, iLvl, 0);
  177848. assert( p->rc!=SQLITE_OK || pStruct->nLevel>(iLvl+1) );
  177849. fts5StructurePromote(p, iLvl+1, pStruct);
  177850. iLvl++;
  177851. }
  177852. *ppStruct = pStruct;
  177853. }
  177854. static int fts5IndexReturn(Fts5Index *p){
  177855. int rc = p->rc;
  177856. p->rc = SQLITE_OK;
  177857. return rc;
  177858. }
  177859. typedef struct Fts5FlushCtx Fts5FlushCtx;
  177860. struct Fts5FlushCtx {
  177861. Fts5Index *pIdx;
  177862. Fts5SegWriter writer;
  177863. };
  177864. /*
  177865. ** Buffer aBuf[] contains a list of varints, all small enough to fit
  177866. ** in a 32-bit integer. Return the size of the largest prefix of this
  177867. ** list nMax bytes or less in size.
  177868. */
  177869. static int fts5PoslistPrefix(const u8 *aBuf, int nMax){
  177870. int ret;
  177871. u32 dummy;
  177872. ret = fts5GetVarint32(aBuf, dummy);
  177873. if( ret<nMax ){
  177874. while( 1 ){
  177875. int i = fts5GetVarint32(&aBuf[ret], dummy);
  177876. if( (ret + i) > nMax ) break;
  177877. ret += i;
  177878. }
  177879. }
  177880. return ret;
  177881. }
  177882. /*
  177883. ** Flush the contents of in-memory hash table iHash to a new level-0
  177884. ** segment on disk. Also update the corresponding structure record.
  177885. **
  177886. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  177887. ** already occurred, this function is a no-op.
  177888. */
  177889. static void fts5FlushOneHash(Fts5Index *p){
  177890. Fts5Hash *pHash = p->pHash;
  177891. Fts5Structure *pStruct;
  177892. int iSegid;
  177893. int pgnoLast = 0; /* Last leaf page number in segment */
  177894. /* Obtain a reference to the index structure and allocate a new segment-id
  177895. ** for the new level-0 segment. */
  177896. pStruct = fts5StructureRead(p);
  177897. iSegid = fts5AllocateSegid(p, pStruct);
  177898. fts5StructureInvalidate(p);
  177899. if( iSegid ){
  177900. const int pgsz = p->pConfig->pgsz;
  177901. int eDetail = p->pConfig->eDetail;
  177902. Fts5StructureSegment *pSeg; /* New segment within pStruct */
  177903. Fts5Buffer *pBuf; /* Buffer in which to assemble leaf page */
  177904. Fts5Buffer *pPgidx; /* Buffer in which to assemble pgidx */
  177905. Fts5SegWriter writer;
  177906. fts5WriteInit(p, &writer, iSegid);
  177907. pBuf = &writer.writer.buf;
  177908. pPgidx = &writer.writer.pgidx;
  177909. /* fts5WriteInit() should have initialized the buffers to (most likely)
  177910. ** the maximum space required. */
  177911. assert( p->rc || pBuf->nSpace>=(pgsz + FTS5_DATA_PADDING) );
  177912. assert( p->rc || pPgidx->nSpace>=(pgsz + FTS5_DATA_PADDING) );
  177913. /* Begin scanning through hash table entries. This loop runs once for each
  177914. ** term/doclist currently stored within the hash table. */
  177915. if( p->rc==SQLITE_OK ){
  177916. p->rc = sqlite3Fts5HashScanInit(pHash, 0, 0);
  177917. }
  177918. while( p->rc==SQLITE_OK && 0==sqlite3Fts5HashScanEof(pHash) ){
  177919. const char *zTerm; /* Buffer containing term */
  177920. const u8 *pDoclist; /* Pointer to doclist for this term */
  177921. int nDoclist; /* Size of doclist in bytes */
  177922. /* Write the term for this entry to disk. */
  177923. sqlite3Fts5HashScanEntry(pHash, &zTerm, &pDoclist, &nDoclist);
  177924. fts5WriteAppendTerm(p, &writer, (int)strlen(zTerm), (const u8*)zTerm);
  177925. assert( writer.bFirstRowidInPage==0 );
  177926. if( pgsz>=(pBuf->n + pPgidx->n + nDoclist + 1) ){
  177927. /* The entire doclist will fit on the current leaf. */
  177928. fts5BufferSafeAppendBlob(pBuf, pDoclist, nDoclist);
  177929. }else{
  177930. i64 iRowid = 0;
  177931. i64 iDelta = 0;
  177932. int iOff = 0;
  177933. /* The entire doclist will not fit on this leaf. The following
  177934. ** loop iterates through the poslists that make up the current
  177935. ** doclist. */
  177936. while( p->rc==SQLITE_OK && iOff<nDoclist ){
  177937. iOff += fts5GetVarint(&pDoclist[iOff], (u64*)&iDelta);
  177938. iRowid += iDelta;
  177939. if( writer.bFirstRowidInPage ){
  177940. fts5PutU16(&pBuf->p[0], (u16)pBuf->n); /* first rowid on page */
  177941. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iRowid);
  177942. writer.bFirstRowidInPage = 0;
  177943. fts5WriteDlidxAppend(p, &writer, iRowid);
  177944. }else{
  177945. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iDelta);
  177946. }
  177947. assert( pBuf->n<=pBuf->nSpace );
  177948. if( eDetail==FTS5_DETAIL_NONE ){
  177949. if( iOff<nDoclist && pDoclist[iOff]==0 ){
  177950. pBuf->p[pBuf->n++] = 0;
  177951. iOff++;
  177952. if( iOff<nDoclist && pDoclist[iOff]==0 ){
  177953. pBuf->p[pBuf->n++] = 0;
  177954. iOff++;
  177955. }
  177956. }
  177957. if( (pBuf->n + pPgidx->n)>=pgsz ){
  177958. fts5WriteFlushLeaf(p, &writer);
  177959. }
  177960. }else{
  177961. int bDummy;
  177962. int nPos;
  177963. int nCopy = fts5GetPoslistSize(&pDoclist[iOff], &nPos, &bDummy);
  177964. nCopy += nPos;
  177965. if( (pBuf->n + pPgidx->n + nCopy) <= pgsz ){
  177966. /* The entire poslist will fit on the current leaf. So copy
  177967. ** it in one go. */
  177968. fts5BufferSafeAppendBlob(pBuf, &pDoclist[iOff], nCopy);
  177969. }else{
  177970. /* The entire poslist will not fit on this leaf. So it needs
  177971. ** to be broken into sections. The only qualification being
  177972. ** that each varint must be stored contiguously. */
  177973. const u8 *pPoslist = &pDoclist[iOff];
  177974. int iPos = 0;
  177975. while( p->rc==SQLITE_OK ){
  177976. int nSpace = pgsz - pBuf->n - pPgidx->n;
  177977. int n = 0;
  177978. if( (nCopy - iPos)<=nSpace ){
  177979. n = nCopy - iPos;
  177980. }else{
  177981. n = fts5PoslistPrefix(&pPoslist[iPos], nSpace);
  177982. }
  177983. assert( n>0 );
  177984. fts5BufferSafeAppendBlob(pBuf, &pPoslist[iPos], n);
  177985. iPos += n;
  177986. if( (pBuf->n + pPgidx->n)>=pgsz ){
  177987. fts5WriteFlushLeaf(p, &writer);
  177988. }
  177989. if( iPos>=nCopy ) break;
  177990. }
  177991. }
  177992. iOff += nCopy;
  177993. }
  177994. }
  177995. }
  177996. /* TODO2: Doclist terminator written here. */
  177997. /* pBuf->p[pBuf->n++] = '\0'; */
  177998. assert( pBuf->n<=pBuf->nSpace );
  177999. sqlite3Fts5HashScanNext(pHash);
  178000. }
  178001. sqlite3Fts5HashClear(pHash);
  178002. fts5WriteFinish(p, &writer, &pgnoLast);
  178003. /* Update the Fts5Structure. It is written back to the database by the
  178004. ** fts5StructureRelease() call below. */
  178005. if( pStruct->nLevel==0 ){
  178006. fts5StructureAddLevel(&p->rc, &pStruct);
  178007. }
  178008. fts5StructureExtendLevel(&p->rc, pStruct, 0, 1, 0);
  178009. if( p->rc==SQLITE_OK ){
  178010. pSeg = &pStruct->aLevel[0].aSeg[ pStruct->aLevel[0].nSeg++ ];
  178011. pSeg->iSegid = iSegid;
  178012. pSeg->pgnoFirst = 1;
  178013. pSeg->pgnoLast = pgnoLast;
  178014. pStruct->nSegment++;
  178015. }
  178016. fts5StructurePromote(p, 0, pStruct);
  178017. }
  178018. fts5IndexAutomerge(p, &pStruct, pgnoLast);
  178019. fts5IndexCrisismerge(p, &pStruct);
  178020. fts5StructureWrite(p, pStruct);
  178021. fts5StructureRelease(pStruct);
  178022. }
  178023. /*
  178024. ** Flush any data stored in the in-memory hash tables to the database.
  178025. */
  178026. static void fts5IndexFlush(Fts5Index *p){
  178027. /* Unless it is empty, flush the hash table to disk */
  178028. if( p->nPendingData ){
  178029. assert( p->pHash );
  178030. p->nPendingData = 0;
  178031. fts5FlushOneHash(p);
  178032. }
  178033. }
  178034. static Fts5Structure *fts5IndexOptimizeStruct(
  178035. Fts5Index *p,
  178036. Fts5Structure *pStruct
  178037. ){
  178038. Fts5Structure *pNew = 0;
  178039. int nByte = sizeof(Fts5Structure);
  178040. int nSeg = pStruct->nSegment;
  178041. int i;
  178042. /* Figure out if this structure requires optimization. A structure does
  178043. ** not require optimization if either:
  178044. **
  178045. ** + it consists of fewer than two segments, or
  178046. ** + all segments are on the same level, or
  178047. ** + all segments except one are currently inputs to a merge operation.
  178048. **
  178049. ** In the first case, return NULL. In the second, increment the ref-count
  178050. ** on *pStruct and return a copy of the pointer to it.
  178051. */
  178052. if( nSeg<2 ) return 0;
  178053. for(i=0; i<pStruct->nLevel; i++){
  178054. int nThis = pStruct->aLevel[i].nSeg;
  178055. if( nThis==nSeg || (nThis==nSeg-1 && pStruct->aLevel[i].nMerge==nThis) ){
  178056. fts5StructureRef(pStruct);
  178057. return pStruct;
  178058. }
  178059. assert( pStruct->aLevel[i].nMerge<=nThis );
  178060. }
  178061. nByte += (pStruct->nLevel+1) * sizeof(Fts5StructureLevel);
  178062. pNew = (Fts5Structure*)sqlite3Fts5MallocZero(&p->rc, nByte);
  178063. if( pNew ){
  178064. Fts5StructureLevel *pLvl;
  178065. nByte = nSeg * sizeof(Fts5StructureSegment);
  178066. pNew->nLevel = pStruct->nLevel+1;
  178067. pNew->nRef = 1;
  178068. pNew->nWriteCounter = pStruct->nWriteCounter;
  178069. pLvl = &pNew->aLevel[pStruct->nLevel];
  178070. pLvl->aSeg = (Fts5StructureSegment*)sqlite3Fts5MallocZero(&p->rc, nByte);
  178071. if( pLvl->aSeg ){
  178072. int iLvl, iSeg;
  178073. int iSegOut = 0;
  178074. /* Iterate through all segments, from oldest to newest. Add them to
  178075. ** the new Fts5Level object so that pLvl->aSeg[0] is the oldest
  178076. ** segment in the data structure. */
  178077. for(iLvl=pStruct->nLevel-1; iLvl>=0; iLvl--){
  178078. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  178079. pLvl->aSeg[iSegOut] = pStruct->aLevel[iLvl].aSeg[iSeg];
  178080. iSegOut++;
  178081. }
  178082. }
  178083. pNew->nSegment = pLvl->nSeg = nSeg;
  178084. }else{
  178085. sqlite3_free(pNew);
  178086. pNew = 0;
  178087. }
  178088. }
  178089. return pNew;
  178090. }
  178091. static int sqlite3Fts5IndexOptimize(Fts5Index *p){
  178092. Fts5Structure *pStruct;
  178093. Fts5Structure *pNew = 0;
  178094. assert( p->rc==SQLITE_OK );
  178095. fts5IndexFlush(p);
  178096. pStruct = fts5StructureRead(p);
  178097. fts5StructureInvalidate(p);
  178098. if( pStruct ){
  178099. pNew = fts5IndexOptimizeStruct(p, pStruct);
  178100. }
  178101. fts5StructureRelease(pStruct);
  178102. assert( pNew==0 || pNew->nSegment>0 );
  178103. if( pNew ){
  178104. int iLvl;
  178105. for(iLvl=0; pNew->aLevel[iLvl].nSeg==0; iLvl++){}
  178106. while( p->rc==SQLITE_OK && pNew->aLevel[iLvl].nSeg>0 ){
  178107. int nRem = FTS5_OPT_WORK_UNIT;
  178108. fts5IndexMergeLevel(p, &pNew, iLvl, &nRem);
  178109. }
  178110. fts5StructureWrite(p, pNew);
  178111. fts5StructureRelease(pNew);
  178112. }
  178113. return fts5IndexReturn(p);
  178114. }
  178115. /*
  178116. ** This is called to implement the special "VALUES('merge', $nMerge)"
  178117. ** INSERT command.
  178118. */
  178119. static int sqlite3Fts5IndexMerge(Fts5Index *p, int nMerge){
  178120. Fts5Structure *pStruct = fts5StructureRead(p);
  178121. if( pStruct ){
  178122. int nMin = p->pConfig->nUsermerge;
  178123. fts5StructureInvalidate(p);
  178124. if( nMerge<0 ){
  178125. Fts5Structure *pNew = fts5IndexOptimizeStruct(p, pStruct);
  178126. fts5StructureRelease(pStruct);
  178127. pStruct = pNew;
  178128. nMin = 2;
  178129. nMerge = nMerge*-1;
  178130. }
  178131. if( pStruct && pStruct->nLevel ){
  178132. if( fts5IndexMerge(p, &pStruct, nMerge, nMin) ){
  178133. fts5StructureWrite(p, pStruct);
  178134. }
  178135. }
  178136. fts5StructureRelease(pStruct);
  178137. }
  178138. return fts5IndexReturn(p);
  178139. }
  178140. static void fts5AppendRowid(
  178141. Fts5Index *p,
  178142. i64 iDelta,
  178143. Fts5Iter *pUnused,
  178144. Fts5Buffer *pBuf
  178145. ){
  178146. UNUSED_PARAM(pUnused);
  178147. fts5BufferAppendVarint(&p->rc, pBuf, iDelta);
  178148. }
  178149. static void fts5AppendPoslist(
  178150. Fts5Index *p,
  178151. i64 iDelta,
  178152. Fts5Iter *pMulti,
  178153. Fts5Buffer *pBuf
  178154. ){
  178155. int nData = pMulti->base.nData;
  178156. assert( nData>0 );
  178157. if( p->rc==SQLITE_OK && 0==fts5BufferGrow(&p->rc, pBuf, nData+9+9) ){
  178158. fts5BufferSafeAppendVarint(pBuf, iDelta);
  178159. fts5BufferSafeAppendVarint(pBuf, nData*2);
  178160. fts5BufferSafeAppendBlob(pBuf, pMulti->base.pData, nData);
  178161. }
  178162. }
  178163. static void fts5DoclistIterNext(Fts5DoclistIter *pIter){
  178164. u8 *p = pIter->aPoslist + pIter->nSize + pIter->nPoslist;
  178165. assert( pIter->aPoslist );
  178166. if( p>=pIter->aEof ){
  178167. pIter->aPoslist = 0;
  178168. }else{
  178169. i64 iDelta;
  178170. p += fts5GetVarint(p, (u64*)&iDelta);
  178171. pIter->iRowid += iDelta;
  178172. /* Read position list size */
  178173. if( p[0] & 0x80 ){
  178174. int nPos;
  178175. pIter->nSize = fts5GetVarint32(p, nPos);
  178176. pIter->nPoslist = (nPos>>1);
  178177. }else{
  178178. pIter->nPoslist = ((int)(p[0])) >> 1;
  178179. pIter->nSize = 1;
  178180. }
  178181. pIter->aPoslist = p;
  178182. }
  178183. }
  178184. static void fts5DoclistIterInit(
  178185. Fts5Buffer *pBuf,
  178186. Fts5DoclistIter *pIter
  178187. ){
  178188. memset(pIter, 0, sizeof(*pIter));
  178189. pIter->aPoslist = pBuf->p;
  178190. pIter->aEof = &pBuf->p[pBuf->n];
  178191. fts5DoclistIterNext(pIter);
  178192. }
  178193. #if 0
  178194. /*
  178195. ** Append a doclist to buffer pBuf.
  178196. **
  178197. ** This function assumes that space within the buffer has already been
  178198. ** allocated.
  178199. */
  178200. static void fts5MergeAppendDocid(
  178201. Fts5Buffer *pBuf, /* Buffer to write to */
  178202. i64 *piLastRowid, /* IN/OUT: Previous rowid written (if any) */
  178203. i64 iRowid /* Rowid to append */
  178204. ){
  178205. assert( pBuf->n!=0 || (*piLastRowid)==0 );
  178206. fts5BufferSafeAppendVarint(pBuf, iRowid - *piLastRowid);
  178207. *piLastRowid = iRowid;
  178208. }
  178209. #endif
  178210. #define fts5MergeAppendDocid(pBuf, iLastRowid, iRowid) { \
  178211. assert( (pBuf)->n!=0 || (iLastRowid)==0 ); \
  178212. fts5BufferSafeAppendVarint((pBuf), (iRowid) - (iLastRowid)); \
  178213. (iLastRowid) = (iRowid); \
  178214. }
  178215. /*
  178216. ** Swap the contents of buffer *p1 with that of *p2.
  178217. */
  178218. static void fts5BufferSwap(Fts5Buffer *p1, Fts5Buffer *p2){
  178219. Fts5Buffer tmp = *p1;
  178220. *p1 = *p2;
  178221. *p2 = tmp;
  178222. }
  178223. static void fts5NextRowid(Fts5Buffer *pBuf, int *piOff, i64 *piRowid){
  178224. int i = *piOff;
  178225. if( i>=pBuf->n ){
  178226. *piOff = -1;
  178227. }else{
  178228. u64 iVal;
  178229. *piOff = i + sqlite3Fts5GetVarint(&pBuf->p[i], &iVal);
  178230. *piRowid += iVal;
  178231. }
  178232. }
  178233. /*
  178234. ** This is the equivalent of fts5MergePrefixLists() for detail=none mode.
  178235. ** In this case the buffers consist of a delta-encoded list of rowids only.
  178236. */
  178237. static void fts5MergeRowidLists(
  178238. Fts5Index *p, /* FTS5 backend object */
  178239. Fts5Buffer *p1, /* First list to merge */
  178240. Fts5Buffer *p2 /* Second list to merge */
  178241. ){
  178242. int i1 = 0;
  178243. int i2 = 0;
  178244. i64 iRowid1 = 0;
  178245. i64 iRowid2 = 0;
  178246. i64 iOut = 0;
  178247. Fts5Buffer out;
  178248. memset(&out, 0, sizeof(out));
  178249. sqlite3Fts5BufferSize(&p->rc, &out, p1->n + p2->n);
  178250. if( p->rc ) return;
  178251. fts5NextRowid(p1, &i1, &iRowid1);
  178252. fts5NextRowid(p2, &i2, &iRowid2);
  178253. while( i1>=0 || i2>=0 ){
  178254. if( i1>=0 && (i2<0 || iRowid1<iRowid2) ){
  178255. assert( iOut==0 || iRowid1>iOut );
  178256. fts5BufferSafeAppendVarint(&out, iRowid1 - iOut);
  178257. iOut = iRowid1;
  178258. fts5NextRowid(p1, &i1, &iRowid1);
  178259. }else{
  178260. assert( iOut==0 || iRowid2>iOut );
  178261. fts5BufferSafeAppendVarint(&out, iRowid2 - iOut);
  178262. iOut = iRowid2;
  178263. if( i1>=0 && iRowid1==iRowid2 ){
  178264. fts5NextRowid(p1, &i1, &iRowid1);
  178265. }
  178266. fts5NextRowid(p2, &i2, &iRowid2);
  178267. }
  178268. }
  178269. fts5BufferSwap(&out, p1);
  178270. fts5BufferFree(&out);
  178271. }
  178272. /*
  178273. ** Buffers p1 and p2 contain doclists. This function merges the content
  178274. ** of the two doclists together and sets buffer p1 to the result before
  178275. ** returning.
  178276. **
  178277. ** If an error occurs, an error code is left in p->rc. If an error has
  178278. ** already occurred, this function is a no-op.
  178279. */
  178280. static void fts5MergePrefixLists(
  178281. Fts5Index *p, /* FTS5 backend object */
  178282. Fts5Buffer *p1, /* First list to merge */
  178283. Fts5Buffer *p2 /* Second list to merge */
  178284. ){
  178285. if( p2->n ){
  178286. i64 iLastRowid = 0;
  178287. Fts5DoclistIter i1;
  178288. Fts5DoclistIter i2;
  178289. Fts5Buffer out = {0, 0, 0};
  178290. Fts5Buffer tmp = {0, 0, 0};
  178291. if( sqlite3Fts5BufferSize(&p->rc, &out, p1->n + p2->n) ) return;
  178292. fts5DoclistIterInit(p1, &i1);
  178293. fts5DoclistIterInit(p2, &i2);
  178294. while( 1 ){
  178295. if( i1.iRowid<i2.iRowid ){
  178296. /* Copy entry from i1 */
  178297. fts5MergeAppendDocid(&out, iLastRowid, i1.iRowid);
  178298. fts5BufferSafeAppendBlob(&out, i1.aPoslist, i1.nPoslist+i1.nSize);
  178299. fts5DoclistIterNext(&i1);
  178300. if( i1.aPoslist==0 ) break;
  178301. }
  178302. else if( i2.iRowid!=i1.iRowid ){
  178303. /* Copy entry from i2 */
  178304. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  178305. fts5BufferSafeAppendBlob(&out, i2.aPoslist, i2.nPoslist+i2.nSize);
  178306. fts5DoclistIterNext(&i2);
  178307. if( i2.aPoslist==0 ) break;
  178308. }
  178309. else{
  178310. /* Merge the two position lists. */
  178311. i64 iPos1 = 0;
  178312. i64 iPos2 = 0;
  178313. int iOff1 = 0;
  178314. int iOff2 = 0;
  178315. u8 *a1 = &i1.aPoslist[i1.nSize];
  178316. u8 *a2 = &i2.aPoslist[i2.nSize];
  178317. i64 iPrev = 0;
  178318. Fts5PoslistWriter writer;
  178319. memset(&writer, 0, sizeof(writer));
  178320. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  178321. fts5BufferZero(&tmp);
  178322. sqlite3Fts5BufferSize(&p->rc, &tmp, i1.nPoslist + i2.nPoslist);
  178323. if( p->rc ) break;
  178324. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  178325. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  178326. assert( iPos1>=0 && iPos2>=0 );
  178327. if( iPos1<iPos2 ){
  178328. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  178329. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  178330. }else{
  178331. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  178332. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  178333. }
  178334. if( iPos1>=0 && iPos2>=0 ){
  178335. while( 1 ){
  178336. if( iPos1<iPos2 ){
  178337. if( iPos1!=iPrev ){
  178338. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  178339. }
  178340. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  178341. if( iPos1<0 ) break;
  178342. }else{
  178343. assert( iPos2!=iPrev );
  178344. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  178345. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  178346. if( iPos2<0 ) break;
  178347. }
  178348. }
  178349. }
  178350. if( iPos1>=0 ){
  178351. if( iPos1!=iPrev ){
  178352. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  178353. }
  178354. fts5BufferSafeAppendBlob(&tmp, &a1[iOff1], i1.nPoslist-iOff1);
  178355. }else{
  178356. assert( iPos2>=0 && iPos2!=iPrev );
  178357. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  178358. fts5BufferSafeAppendBlob(&tmp, &a2[iOff2], i2.nPoslist-iOff2);
  178359. }
  178360. /* WRITEPOSLISTSIZE */
  178361. fts5BufferSafeAppendVarint(&out, tmp.n * 2);
  178362. fts5BufferSafeAppendBlob(&out, tmp.p, tmp.n);
  178363. fts5DoclistIterNext(&i1);
  178364. fts5DoclistIterNext(&i2);
  178365. if( i1.aPoslist==0 || i2.aPoslist==0 ) break;
  178366. }
  178367. }
  178368. if( i1.aPoslist ){
  178369. fts5MergeAppendDocid(&out, iLastRowid, i1.iRowid);
  178370. fts5BufferSafeAppendBlob(&out, i1.aPoslist, i1.aEof - i1.aPoslist);
  178371. }
  178372. else if( i2.aPoslist ){
  178373. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  178374. fts5BufferSafeAppendBlob(&out, i2.aPoslist, i2.aEof - i2.aPoslist);
  178375. }
  178376. fts5BufferSet(&p->rc, p1, out.n, out.p);
  178377. fts5BufferFree(&tmp);
  178378. fts5BufferFree(&out);
  178379. }
  178380. }
  178381. static void fts5SetupPrefixIter(
  178382. Fts5Index *p, /* Index to read from */
  178383. int bDesc, /* True for "ORDER BY rowid DESC" */
  178384. const u8 *pToken, /* Buffer containing prefix to match */
  178385. int nToken, /* Size of buffer pToken in bytes */
  178386. Fts5Colset *pColset, /* Restrict matches to these columns */
  178387. Fts5Iter **ppIter /* OUT: New iterator */
  178388. ){
  178389. Fts5Structure *pStruct;
  178390. Fts5Buffer *aBuf;
  178391. const int nBuf = 32;
  178392. void (*xMerge)(Fts5Index*, Fts5Buffer*, Fts5Buffer*);
  178393. void (*xAppend)(Fts5Index*, i64, Fts5Iter*, Fts5Buffer*);
  178394. if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  178395. xMerge = fts5MergeRowidLists;
  178396. xAppend = fts5AppendRowid;
  178397. }else{
  178398. xMerge = fts5MergePrefixLists;
  178399. xAppend = fts5AppendPoslist;
  178400. }
  178401. aBuf = (Fts5Buffer*)fts5IdxMalloc(p, sizeof(Fts5Buffer)*nBuf);
  178402. pStruct = fts5StructureRead(p);
  178403. if( aBuf && pStruct ){
  178404. const int flags = FTS5INDEX_QUERY_SCAN
  178405. | FTS5INDEX_QUERY_SKIPEMPTY
  178406. | FTS5INDEX_QUERY_NOOUTPUT;
  178407. int i;
  178408. i64 iLastRowid = 0;
  178409. Fts5Iter *p1 = 0; /* Iterator used to gather data from index */
  178410. Fts5Data *pData;
  178411. Fts5Buffer doclist;
  178412. int bNewTerm = 1;
  178413. memset(&doclist, 0, sizeof(doclist));
  178414. fts5MultiIterNew(p, pStruct, flags, pColset, pToken, nToken, -1, 0, &p1);
  178415. fts5IterSetOutputCb(&p->rc, p1);
  178416. for( /* no-op */ ;
  178417. fts5MultiIterEof(p, p1)==0;
  178418. fts5MultiIterNext2(p, p1, &bNewTerm)
  178419. ){
  178420. Fts5SegIter *pSeg = &p1->aSeg[ p1->aFirst[1].iFirst ];
  178421. int nTerm = pSeg->term.n;
  178422. const u8 *pTerm = pSeg->term.p;
  178423. p1->xSetOutputs(p1, pSeg);
  178424. assert_nc( memcmp(pToken, pTerm, MIN(nToken, nTerm))<=0 );
  178425. if( bNewTerm ){
  178426. if( nTerm<nToken || memcmp(pToken, pTerm, nToken) ) break;
  178427. }
  178428. if( p1->base.nData==0 ) continue;
  178429. if( p1->base.iRowid<=iLastRowid && doclist.n>0 ){
  178430. for(i=0; p->rc==SQLITE_OK && doclist.n; i++){
  178431. assert( i<nBuf );
  178432. if( aBuf[i].n==0 ){
  178433. fts5BufferSwap(&doclist, &aBuf[i]);
  178434. fts5BufferZero(&doclist);
  178435. }else{
  178436. xMerge(p, &doclist, &aBuf[i]);
  178437. fts5BufferZero(&aBuf[i]);
  178438. }
  178439. }
  178440. iLastRowid = 0;
  178441. }
  178442. xAppend(p, p1->base.iRowid-iLastRowid, p1, &doclist);
  178443. iLastRowid = p1->base.iRowid;
  178444. }
  178445. for(i=0; i<nBuf; i++){
  178446. if( p->rc==SQLITE_OK ){
  178447. xMerge(p, &doclist, &aBuf[i]);
  178448. }
  178449. fts5BufferFree(&aBuf[i]);
  178450. }
  178451. fts5MultiIterFree(p1);
  178452. pData = fts5IdxMalloc(p, sizeof(Fts5Data) + doclist.n);
  178453. if( pData ){
  178454. pData->p = (u8*)&pData[1];
  178455. pData->nn = pData->szLeaf = doclist.n;
  178456. memcpy(pData->p, doclist.p, doclist.n);
  178457. fts5MultiIterNew2(p, pData, bDesc, ppIter);
  178458. }
  178459. fts5BufferFree(&doclist);
  178460. }
  178461. fts5StructureRelease(pStruct);
  178462. sqlite3_free(aBuf);
  178463. }
  178464. /*
  178465. ** Indicate that all subsequent calls to sqlite3Fts5IndexWrite() pertain
  178466. ** to the document with rowid iRowid.
  178467. */
  178468. static int sqlite3Fts5IndexBeginWrite(Fts5Index *p, int bDelete, i64 iRowid){
  178469. assert( p->rc==SQLITE_OK );
  178470. /* Allocate the hash table if it has not already been allocated */
  178471. if( p->pHash==0 ){
  178472. p->rc = sqlite3Fts5HashNew(p->pConfig, &p->pHash, &p->nPendingData);
  178473. }
  178474. /* Flush the hash table to disk if required */
  178475. if( iRowid<p->iWriteRowid
  178476. || (iRowid==p->iWriteRowid && p->bDelete==0)
  178477. || (p->nPendingData > p->pConfig->nHashSize)
  178478. ){
  178479. fts5IndexFlush(p);
  178480. }
  178481. p->iWriteRowid = iRowid;
  178482. p->bDelete = bDelete;
  178483. return fts5IndexReturn(p);
  178484. }
  178485. /*
  178486. ** Commit data to disk.
  178487. */
  178488. static int sqlite3Fts5IndexSync(Fts5Index *p, int bCommit){
  178489. assert( p->rc==SQLITE_OK );
  178490. fts5IndexFlush(p);
  178491. if( bCommit ) fts5CloseReader(p);
  178492. return fts5IndexReturn(p);
  178493. }
  178494. /*
  178495. ** Discard any data stored in the in-memory hash tables. Do not write it
  178496. ** to the database. Additionally, assume that the contents of the %_data
  178497. ** table may have changed on disk. So any in-memory caches of %_data
  178498. ** records must be invalidated.
  178499. */
  178500. static int sqlite3Fts5IndexRollback(Fts5Index *p){
  178501. fts5CloseReader(p);
  178502. fts5IndexDiscardData(p);
  178503. fts5StructureInvalidate(p);
  178504. /* assert( p->rc==SQLITE_OK ); */
  178505. return SQLITE_OK;
  178506. }
  178507. /*
  178508. ** The %_data table is completely empty when this function is called. This
  178509. ** function populates it with the initial structure objects for each index,
  178510. ** and the initial version of the "averages" record (a zero-byte blob).
  178511. */
  178512. static int sqlite3Fts5IndexReinit(Fts5Index *p){
  178513. Fts5Structure s;
  178514. fts5StructureInvalidate(p);
  178515. memset(&s, 0, sizeof(Fts5Structure));
  178516. fts5DataWrite(p, FTS5_AVERAGES_ROWID, (const u8*)"", 0);
  178517. fts5StructureWrite(p, &s);
  178518. return fts5IndexReturn(p);
  178519. }
  178520. /*
  178521. ** Open a new Fts5Index handle. If the bCreate argument is true, create
  178522. ** and initialize the underlying %_data table.
  178523. **
  178524. ** If successful, set *pp to point to the new object and return SQLITE_OK.
  178525. ** Otherwise, set *pp to NULL and return an SQLite error code.
  178526. */
  178527. static int sqlite3Fts5IndexOpen(
  178528. Fts5Config *pConfig,
  178529. int bCreate,
  178530. Fts5Index **pp,
  178531. char **pzErr
  178532. ){
  178533. int rc = SQLITE_OK;
  178534. Fts5Index *p; /* New object */
  178535. *pp = p = (Fts5Index*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Index));
  178536. if( rc==SQLITE_OK ){
  178537. p->pConfig = pConfig;
  178538. p->nWorkUnit = FTS5_WORK_UNIT;
  178539. p->zDataTbl = sqlite3Fts5Mprintf(&rc, "%s_data", pConfig->zName);
  178540. if( p->zDataTbl && bCreate ){
  178541. rc = sqlite3Fts5CreateTable(
  178542. pConfig, "data", "id INTEGER PRIMARY KEY, block BLOB", 0, pzErr
  178543. );
  178544. if( rc==SQLITE_OK ){
  178545. rc = sqlite3Fts5CreateTable(pConfig, "idx",
  178546. "segid, term, pgno, PRIMARY KEY(segid, term)",
  178547. 1, pzErr
  178548. );
  178549. }
  178550. if( rc==SQLITE_OK ){
  178551. rc = sqlite3Fts5IndexReinit(p);
  178552. }
  178553. }
  178554. }
  178555. assert( rc!=SQLITE_OK || p->rc==SQLITE_OK );
  178556. if( rc ){
  178557. sqlite3Fts5IndexClose(p);
  178558. *pp = 0;
  178559. }
  178560. return rc;
  178561. }
  178562. /*
  178563. ** Close a handle opened by an earlier call to sqlite3Fts5IndexOpen().
  178564. */
  178565. static int sqlite3Fts5IndexClose(Fts5Index *p){
  178566. int rc = SQLITE_OK;
  178567. if( p ){
  178568. assert( p->pReader==0 );
  178569. fts5StructureInvalidate(p);
  178570. sqlite3_finalize(p->pWriter);
  178571. sqlite3_finalize(p->pDeleter);
  178572. sqlite3_finalize(p->pIdxWriter);
  178573. sqlite3_finalize(p->pIdxDeleter);
  178574. sqlite3_finalize(p->pIdxSelect);
  178575. sqlite3_finalize(p->pDataVersion);
  178576. sqlite3Fts5HashFree(p->pHash);
  178577. sqlite3_free(p->zDataTbl);
  178578. sqlite3_free(p);
  178579. }
  178580. return rc;
  178581. }
  178582. /*
  178583. ** Argument p points to a buffer containing utf-8 text that is n bytes in
  178584. ** size. Return the number of bytes in the nChar character prefix of the
  178585. ** buffer, or 0 if there are less than nChar characters in total.
  178586. */
  178587. static int sqlite3Fts5IndexCharlenToBytelen(
  178588. const char *p,
  178589. int nByte,
  178590. int nChar
  178591. ){
  178592. int n = 0;
  178593. int i;
  178594. for(i=0; i<nChar; i++){
  178595. if( n>=nByte ) return 0; /* Input contains fewer than nChar chars */
  178596. if( (unsigned char)p[n++]>=0xc0 ){
  178597. while( (p[n] & 0xc0)==0x80 ) n++;
  178598. }
  178599. }
  178600. return n;
  178601. }
  178602. /*
  178603. ** pIn is a UTF-8 encoded string, nIn bytes in size. Return the number of
  178604. ** unicode characters in the string.
  178605. */
  178606. static int fts5IndexCharlen(const char *pIn, int nIn){
  178607. int nChar = 0;
  178608. int i = 0;
  178609. while( i<nIn ){
  178610. if( (unsigned char)pIn[i++]>=0xc0 ){
  178611. while( i<nIn && (pIn[i] & 0xc0)==0x80 ) i++;
  178612. }
  178613. nChar++;
  178614. }
  178615. return nChar;
  178616. }
  178617. /*
  178618. ** Insert or remove data to or from the index. Each time a document is
  178619. ** added to or removed from the index, this function is called one or more
  178620. ** times.
  178621. **
  178622. ** For an insert, it must be called once for each token in the new document.
  178623. ** If the operation is a delete, it must be called (at least) once for each
  178624. ** unique token in the document with an iCol value less than zero. The iPos
  178625. ** argument is ignored for a delete.
  178626. */
  178627. static int sqlite3Fts5IndexWrite(
  178628. Fts5Index *p, /* Index to write to */
  178629. int iCol, /* Column token appears in (-ve -> delete) */
  178630. int iPos, /* Position of token within column */
  178631. const char *pToken, int nToken /* Token to add or remove to or from index */
  178632. ){
  178633. int i; /* Used to iterate through indexes */
  178634. int rc = SQLITE_OK; /* Return code */
  178635. Fts5Config *pConfig = p->pConfig;
  178636. assert( p->rc==SQLITE_OK );
  178637. assert( (iCol<0)==p->bDelete );
  178638. /* Add the entry to the main terms index. */
  178639. rc = sqlite3Fts5HashWrite(
  178640. p->pHash, p->iWriteRowid, iCol, iPos, FTS5_MAIN_PREFIX, pToken, nToken
  178641. );
  178642. for(i=0; i<pConfig->nPrefix && rc==SQLITE_OK; i++){
  178643. const int nChar = pConfig->aPrefix[i];
  178644. int nByte = sqlite3Fts5IndexCharlenToBytelen(pToken, nToken, nChar);
  178645. if( nByte ){
  178646. rc = sqlite3Fts5HashWrite(p->pHash,
  178647. p->iWriteRowid, iCol, iPos, (char)(FTS5_MAIN_PREFIX+i+1), pToken,
  178648. nByte
  178649. );
  178650. }
  178651. }
  178652. return rc;
  178653. }
  178654. /*
  178655. ** Open a new iterator to iterate though all rowid that match the
  178656. ** specified token or token prefix.
  178657. */
  178658. static int sqlite3Fts5IndexQuery(
  178659. Fts5Index *p, /* FTS index to query */
  178660. const char *pToken, int nToken, /* Token (or prefix) to query for */
  178661. int flags, /* Mask of FTS5INDEX_QUERY_X flags */
  178662. Fts5Colset *pColset, /* Match these columns only */
  178663. Fts5IndexIter **ppIter /* OUT: New iterator object */
  178664. ){
  178665. Fts5Config *pConfig = p->pConfig;
  178666. Fts5Iter *pRet = 0;
  178667. Fts5Buffer buf = {0, 0, 0};
  178668. /* If the QUERY_SCAN flag is set, all other flags must be clear. */
  178669. assert( (flags & FTS5INDEX_QUERY_SCAN)==0 || flags==FTS5INDEX_QUERY_SCAN );
  178670. if( sqlite3Fts5BufferSize(&p->rc, &buf, nToken+1)==0 ){
  178671. int iIdx = 0; /* Index to search */
  178672. memcpy(&buf.p[1], pToken, nToken);
  178673. /* Figure out which index to search and set iIdx accordingly. If this
  178674. ** is a prefix query for which there is no prefix index, set iIdx to
  178675. ** greater than pConfig->nPrefix to indicate that the query will be
  178676. ** satisfied by scanning multiple terms in the main index.
  178677. **
  178678. ** If the QUERY_TEST_NOIDX flag was specified, then this must be a
  178679. ** prefix-query. Instead of using a prefix-index (if one exists),
  178680. ** evaluate the prefix query using the main FTS index. This is used
  178681. ** for internal sanity checking by the integrity-check in debug
  178682. ** mode only. */
  178683. #ifdef SQLITE_DEBUG
  178684. if( pConfig->bPrefixIndex==0 || (flags & FTS5INDEX_QUERY_TEST_NOIDX) ){
  178685. assert( flags & FTS5INDEX_QUERY_PREFIX );
  178686. iIdx = 1+pConfig->nPrefix;
  178687. }else
  178688. #endif
  178689. if( flags & FTS5INDEX_QUERY_PREFIX ){
  178690. int nChar = fts5IndexCharlen(pToken, nToken);
  178691. for(iIdx=1; iIdx<=pConfig->nPrefix; iIdx++){
  178692. if( pConfig->aPrefix[iIdx-1]==nChar ) break;
  178693. }
  178694. }
  178695. if( iIdx<=pConfig->nPrefix ){
  178696. /* Straight index lookup */
  178697. Fts5Structure *pStruct = fts5StructureRead(p);
  178698. buf.p[0] = (u8)(FTS5_MAIN_PREFIX + iIdx);
  178699. if( pStruct ){
  178700. fts5MultiIterNew(p, pStruct, flags | FTS5INDEX_QUERY_SKIPEMPTY,
  178701. pColset, buf.p, nToken+1, -1, 0, &pRet
  178702. );
  178703. fts5StructureRelease(pStruct);
  178704. }
  178705. }else{
  178706. /* Scan multiple terms in the main index */
  178707. int bDesc = (flags & FTS5INDEX_QUERY_DESC)!=0;
  178708. buf.p[0] = FTS5_MAIN_PREFIX;
  178709. fts5SetupPrefixIter(p, bDesc, buf.p, nToken+1, pColset, &pRet);
  178710. assert( p->rc!=SQLITE_OK || pRet->pColset==0 );
  178711. fts5IterSetOutputCb(&p->rc, pRet);
  178712. if( p->rc==SQLITE_OK ){
  178713. Fts5SegIter *pSeg = &pRet->aSeg[pRet->aFirst[1].iFirst];
  178714. if( pSeg->pLeaf ) pRet->xSetOutputs(pRet, pSeg);
  178715. }
  178716. }
  178717. if( p->rc ){
  178718. sqlite3Fts5IterClose(&pRet->base);
  178719. pRet = 0;
  178720. fts5CloseReader(p);
  178721. }
  178722. *ppIter = &pRet->base;
  178723. sqlite3Fts5BufferFree(&buf);
  178724. }
  178725. return fts5IndexReturn(p);
  178726. }
  178727. /*
  178728. ** Return true if the iterator passed as the only argument is at EOF.
  178729. */
  178730. /*
  178731. ** Move to the next matching rowid.
  178732. */
  178733. static int sqlite3Fts5IterNext(Fts5IndexIter *pIndexIter){
  178734. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  178735. assert( pIter->pIndex->rc==SQLITE_OK );
  178736. fts5MultiIterNext(pIter->pIndex, pIter, 0, 0);
  178737. return fts5IndexReturn(pIter->pIndex);
  178738. }
  178739. /*
  178740. ** Move to the next matching term/rowid. Used by the fts5vocab module.
  178741. */
  178742. static int sqlite3Fts5IterNextScan(Fts5IndexIter *pIndexIter){
  178743. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  178744. Fts5Index *p = pIter->pIndex;
  178745. assert( pIter->pIndex->rc==SQLITE_OK );
  178746. fts5MultiIterNext(p, pIter, 0, 0);
  178747. if( p->rc==SQLITE_OK ){
  178748. Fts5SegIter *pSeg = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  178749. if( pSeg->pLeaf && pSeg->term.p[0]!=FTS5_MAIN_PREFIX ){
  178750. fts5DataRelease(pSeg->pLeaf);
  178751. pSeg->pLeaf = 0;
  178752. pIter->base.bEof = 1;
  178753. }
  178754. }
  178755. return fts5IndexReturn(pIter->pIndex);
  178756. }
  178757. /*
  178758. ** Move to the next matching rowid that occurs at or after iMatch. The
  178759. ** definition of "at or after" depends on whether this iterator iterates
  178760. ** in ascending or descending rowid order.
  178761. */
  178762. static int sqlite3Fts5IterNextFrom(Fts5IndexIter *pIndexIter, i64 iMatch){
  178763. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  178764. fts5MultiIterNextFrom(pIter->pIndex, pIter, iMatch);
  178765. return fts5IndexReturn(pIter->pIndex);
  178766. }
  178767. /*
  178768. ** Return the current term.
  178769. */
  178770. static const char *sqlite3Fts5IterTerm(Fts5IndexIter *pIndexIter, int *pn){
  178771. int n;
  178772. const char *z = (const char*)fts5MultiIterTerm((Fts5Iter*)pIndexIter, &n);
  178773. *pn = n-1;
  178774. return &z[1];
  178775. }
  178776. /*
  178777. ** Close an iterator opened by an earlier call to sqlite3Fts5IndexQuery().
  178778. */
  178779. static void sqlite3Fts5IterClose(Fts5IndexIter *pIndexIter){
  178780. if( pIndexIter ){
  178781. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  178782. Fts5Index *pIndex = pIter->pIndex;
  178783. fts5MultiIterFree(pIter);
  178784. fts5CloseReader(pIndex);
  178785. }
  178786. }
  178787. /*
  178788. ** Read and decode the "averages" record from the database.
  178789. **
  178790. ** Parameter anSize must point to an array of size nCol, where nCol is
  178791. ** the number of user defined columns in the FTS table.
  178792. */
  178793. static int sqlite3Fts5IndexGetAverages(Fts5Index *p, i64 *pnRow, i64 *anSize){
  178794. int nCol = p->pConfig->nCol;
  178795. Fts5Data *pData;
  178796. *pnRow = 0;
  178797. memset(anSize, 0, sizeof(i64) * nCol);
  178798. pData = fts5DataRead(p, FTS5_AVERAGES_ROWID);
  178799. if( p->rc==SQLITE_OK && pData->nn ){
  178800. int i = 0;
  178801. int iCol;
  178802. i += fts5GetVarint(&pData->p[i], (u64*)pnRow);
  178803. for(iCol=0; i<pData->nn && iCol<nCol; iCol++){
  178804. i += fts5GetVarint(&pData->p[i], (u64*)&anSize[iCol]);
  178805. }
  178806. }
  178807. fts5DataRelease(pData);
  178808. return fts5IndexReturn(p);
  178809. }
  178810. /*
  178811. ** Replace the current "averages" record with the contents of the buffer
  178812. ** supplied as the second argument.
  178813. */
  178814. static int sqlite3Fts5IndexSetAverages(Fts5Index *p, const u8 *pData, int nData){
  178815. assert( p->rc==SQLITE_OK );
  178816. fts5DataWrite(p, FTS5_AVERAGES_ROWID, pData, nData);
  178817. return fts5IndexReturn(p);
  178818. }
  178819. /*
  178820. ** Return the total number of blocks this module has read from the %_data
  178821. ** table since it was created.
  178822. */
  178823. static int sqlite3Fts5IndexReads(Fts5Index *p){
  178824. return p->nRead;
  178825. }
  178826. /*
  178827. ** Set the 32-bit cookie value stored at the start of all structure
  178828. ** records to the value passed as the second argument.
  178829. **
  178830. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  178831. ** occurs.
  178832. */
  178833. static int sqlite3Fts5IndexSetCookie(Fts5Index *p, int iNew){
  178834. int rc; /* Return code */
  178835. Fts5Config *pConfig = p->pConfig; /* Configuration object */
  178836. u8 aCookie[4]; /* Binary representation of iNew */
  178837. sqlite3_blob *pBlob = 0;
  178838. assert( p->rc==SQLITE_OK );
  178839. sqlite3Fts5Put32(aCookie, iNew);
  178840. rc = sqlite3_blob_open(pConfig->db, pConfig->zDb, p->zDataTbl,
  178841. "block", FTS5_STRUCTURE_ROWID, 1, &pBlob
  178842. );
  178843. if( rc==SQLITE_OK ){
  178844. sqlite3_blob_write(pBlob, aCookie, 4, 0);
  178845. rc = sqlite3_blob_close(pBlob);
  178846. }
  178847. return rc;
  178848. }
  178849. static int sqlite3Fts5IndexLoadConfig(Fts5Index *p){
  178850. Fts5Structure *pStruct;
  178851. pStruct = fts5StructureRead(p);
  178852. fts5StructureRelease(pStruct);
  178853. return fts5IndexReturn(p);
  178854. }
  178855. /*************************************************************************
  178856. **************************************************************************
  178857. ** Below this point is the implementation of the integrity-check
  178858. ** functionality.
  178859. */
  178860. /*
  178861. ** Return a simple checksum value based on the arguments.
  178862. */
  178863. static u64 sqlite3Fts5IndexEntryCksum(
  178864. i64 iRowid,
  178865. int iCol,
  178866. int iPos,
  178867. int iIdx,
  178868. const char *pTerm,
  178869. int nTerm
  178870. ){
  178871. int i;
  178872. u64 ret = iRowid;
  178873. ret += (ret<<3) + iCol;
  178874. ret += (ret<<3) + iPos;
  178875. if( iIdx>=0 ) ret += (ret<<3) + (FTS5_MAIN_PREFIX + iIdx);
  178876. for(i=0; i<nTerm; i++) ret += (ret<<3) + pTerm[i];
  178877. return ret;
  178878. }
  178879. #ifdef SQLITE_DEBUG
  178880. /*
  178881. ** This function is purely an internal test. It does not contribute to
  178882. ** FTS functionality, or even the integrity-check, in any way.
  178883. **
  178884. ** Instead, it tests that the same set of pgno/rowid combinations are
  178885. ** visited regardless of whether the doclist-index identified by parameters
  178886. ** iSegid/iLeaf is iterated in forwards or reverse order.
  178887. */
  178888. static void fts5TestDlidxReverse(
  178889. Fts5Index *p,
  178890. int iSegid, /* Segment id to load from */
  178891. int iLeaf /* Load doclist-index for this leaf */
  178892. ){
  178893. Fts5DlidxIter *pDlidx = 0;
  178894. u64 cksum1 = 13;
  178895. u64 cksum2 = 13;
  178896. for(pDlidx=fts5DlidxIterInit(p, 0, iSegid, iLeaf);
  178897. fts5DlidxIterEof(p, pDlidx)==0;
  178898. fts5DlidxIterNext(p, pDlidx)
  178899. ){
  178900. i64 iRowid = fts5DlidxIterRowid(pDlidx);
  178901. int pgno = fts5DlidxIterPgno(pDlidx);
  178902. assert( pgno>iLeaf );
  178903. cksum1 += iRowid + ((i64)pgno<<32);
  178904. }
  178905. fts5DlidxIterFree(pDlidx);
  178906. pDlidx = 0;
  178907. for(pDlidx=fts5DlidxIterInit(p, 1, iSegid, iLeaf);
  178908. fts5DlidxIterEof(p, pDlidx)==0;
  178909. fts5DlidxIterPrev(p, pDlidx)
  178910. ){
  178911. i64 iRowid = fts5DlidxIterRowid(pDlidx);
  178912. int pgno = fts5DlidxIterPgno(pDlidx);
  178913. assert( fts5DlidxIterPgno(pDlidx)>iLeaf );
  178914. cksum2 += iRowid + ((i64)pgno<<32);
  178915. }
  178916. fts5DlidxIterFree(pDlidx);
  178917. pDlidx = 0;
  178918. if( p->rc==SQLITE_OK && cksum1!=cksum2 ) p->rc = FTS5_CORRUPT;
  178919. }
  178920. static int fts5QueryCksum(
  178921. Fts5Index *p, /* Fts5 index object */
  178922. int iIdx,
  178923. const char *z, /* Index key to query for */
  178924. int n, /* Size of index key in bytes */
  178925. int flags, /* Flags for Fts5IndexQuery */
  178926. u64 *pCksum /* IN/OUT: Checksum value */
  178927. ){
  178928. int eDetail = p->pConfig->eDetail;
  178929. u64 cksum = *pCksum;
  178930. Fts5IndexIter *pIter = 0;
  178931. int rc = sqlite3Fts5IndexQuery(p, z, n, flags, 0, &pIter);
  178932. while( rc==SQLITE_OK && 0==sqlite3Fts5IterEof(pIter) ){
  178933. i64 rowid = pIter->iRowid;
  178934. if( eDetail==FTS5_DETAIL_NONE ){
  178935. cksum ^= sqlite3Fts5IndexEntryCksum(rowid, 0, 0, iIdx, z, n);
  178936. }else{
  178937. Fts5PoslistReader sReader;
  178938. for(sqlite3Fts5PoslistReaderInit(pIter->pData, pIter->nData, &sReader);
  178939. sReader.bEof==0;
  178940. sqlite3Fts5PoslistReaderNext(&sReader)
  178941. ){
  178942. int iCol = FTS5_POS2COLUMN(sReader.iPos);
  178943. int iOff = FTS5_POS2OFFSET(sReader.iPos);
  178944. cksum ^= sqlite3Fts5IndexEntryCksum(rowid, iCol, iOff, iIdx, z, n);
  178945. }
  178946. }
  178947. if( rc==SQLITE_OK ){
  178948. rc = sqlite3Fts5IterNext(pIter);
  178949. }
  178950. }
  178951. sqlite3Fts5IterClose(pIter);
  178952. *pCksum = cksum;
  178953. return rc;
  178954. }
  178955. /*
  178956. ** This function is also purely an internal test. It does not contribute to
  178957. ** FTS functionality, or even the integrity-check, in any way.
  178958. */
  178959. static void fts5TestTerm(
  178960. Fts5Index *p,
  178961. Fts5Buffer *pPrev, /* Previous term */
  178962. const char *z, int n, /* Possibly new term to test */
  178963. u64 expected,
  178964. u64 *pCksum
  178965. ){
  178966. int rc = p->rc;
  178967. if( pPrev->n==0 ){
  178968. fts5BufferSet(&rc, pPrev, n, (const u8*)z);
  178969. }else
  178970. if( rc==SQLITE_OK && (pPrev->n!=n || memcmp(pPrev->p, z, n)) ){
  178971. u64 cksum3 = *pCksum;
  178972. const char *zTerm = (const char*)&pPrev->p[1]; /* term sans prefix-byte */
  178973. int nTerm = pPrev->n-1; /* Size of zTerm in bytes */
  178974. int iIdx = (pPrev->p[0] - FTS5_MAIN_PREFIX);
  178975. int flags = (iIdx==0 ? 0 : FTS5INDEX_QUERY_PREFIX);
  178976. u64 ck1 = 0;
  178977. u64 ck2 = 0;
  178978. /* Check that the results returned for ASC and DESC queries are
  178979. ** the same. If not, call this corruption. */
  178980. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, flags, &ck1);
  178981. if( rc==SQLITE_OK ){
  178982. int f = flags|FTS5INDEX_QUERY_DESC;
  178983. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  178984. }
  178985. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  178986. /* If this is a prefix query, check that the results returned if the
  178987. ** the index is disabled are the same. In both ASC and DESC order.
  178988. **
  178989. ** This check may only be performed if the hash table is empty. This
  178990. ** is because the hash table only supports a single scan query at
  178991. ** a time, and the multi-iter loop from which this function is called
  178992. ** is already performing such a scan. */
  178993. if( p->nPendingData==0 ){
  178994. if( iIdx>0 && rc==SQLITE_OK ){
  178995. int f = flags|FTS5INDEX_QUERY_TEST_NOIDX;
  178996. ck2 = 0;
  178997. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  178998. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  178999. }
  179000. if( iIdx>0 && rc==SQLITE_OK ){
  179001. int f = flags|FTS5INDEX_QUERY_TEST_NOIDX|FTS5INDEX_QUERY_DESC;
  179002. ck2 = 0;
  179003. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  179004. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  179005. }
  179006. }
  179007. cksum3 ^= ck1;
  179008. fts5BufferSet(&rc, pPrev, n, (const u8*)z);
  179009. if( rc==SQLITE_OK && cksum3!=expected ){
  179010. rc = FTS5_CORRUPT;
  179011. }
  179012. *pCksum = cksum3;
  179013. }
  179014. p->rc = rc;
  179015. }
  179016. #else
  179017. # define fts5TestDlidxReverse(x,y,z)
  179018. # define fts5TestTerm(u,v,w,x,y,z)
  179019. #endif
  179020. /*
  179021. ** Check that:
  179022. **
  179023. ** 1) All leaves of pSeg between iFirst and iLast (inclusive) exist and
  179024. ** contain zero terms.
  179025. ** 2) All leaves of pSeg between iNoRowid and iLast (inclusive) exist and
  179026. ** contain zero rowids.
  179027. */
  179028. static void fts5IndexIntegrityCheckEmpty(
  179029. Fts5Index *p,
  179030. Fts5StructureSegment *pSeg, /* Segment to check internal consistency */
  179031. int iFirst,
  179032. int iNoRowid,
  179033. int iLast
  179034. ){
  179035. int i;
  179036. /* Now check that the iter.nEmpty leaves following the current leaf
  179037. ** (a) exist and (b) contain no terms. */
  179038. for(i=iFirst; p->rc==SQLITE_OK && i<=iLast; i++){
  179039. Fts5Data *pLeaf = fts5DataRead(p, FTS5_SEGMENT_ROWID(pSeg->iSegid, i));
  179040. if( pLeaf ){
  179041. if( !fts5LeafIsTermless(pLeaf) ) p->rc = FTS5_CORRUPT;
  179042. if( i>=iNoRowid && 0!=fts5LeafFirstRowidOff(pLeaf) ) p->rc = FTS5_CORRUPT;
  179043. }
  179044. fts5DataRelease(pLeaf);
  179045. }
  179046. }
  179047. static void fts5IntegrityCheckPgidx(Fts5Index *p, Fts5Data *pLeaf){
  179048. int iTermOff = 0;
  179049. int ii;
  179050. Fts5Buffer buf1 = {0,0,0};
  179051. Fts5Buffer buf2 = {0,0,0};
  179052. ii = pLeaf->szLeaf;
  179053. while( ii<pLeaf->nn && p->rc==SQLITE_OK ){
  179054. int res;
  179055. int iOff;
  179056. int nIncr;
  179057. ii += fts5GetVarint32(&pLeaf->p[ii], nIncr);
  179058. iTermOff += nIncr;
  179059. iOff = iTermOff;
  179060. if( iOff>=pLeaf->szLeaf ){
  179061. p->rc = FTS5_CORRUPT;
  179062. }else if( iTermOff==nIncr ){
  179063. int nByte;
  179064. iOff += fts5GetVarint32(&pLeaf->p[iOff], nByte);
  179065. if( (iOff+nByte)>pLeaf->szLeaf ){
  179066. p->rc = FTS5_CORRUPT;
  179067. }else{
  179068. fts5BufferSet(&p->rc, &buf1, nByte, &pLeaf->p[iOff]);
  179069. }
  179070. }else{
  179071. int nKeep, nByte;
  179072. iOff += fts5GetVarint32(&pLeaf->p[iOff], nKeep);
  179073. iOff += fts5GetVarint32(&pLeaf->p[iOff], nByte);
  179074. if( nKeep>buf1.n || (iOff+nByte)>pLeaf->szLeaf ){
  179075. p->rc = FTS5_CORRUPT;
  179076. }else{
  179077. buf1.n = nKeep;
  179078. fts5BufferAppendBlob(&p->rc, &buf1, nByte, &pLeaf->p[iOff]);
  179079. }
  179080. if( p->rc==SQLITE_OK ){
  179081. res = fts5BufferCompare(&buf1, &buf2);
  179082. if( res<=0 ) p->rc = FTS5_CORRUPT;
  179083. }
  179084. }
  179085. fts5BufferSet(&p->rc, &buf2, buf1.n, buf1.p);
  179086. }
  179087. fts5BufferFree(&buf1);
  179088. fts5BufferFree(&buf2);
  179089. }
  179090. static void fts5IndexIntegrityCheckSegment(
  179091. Fts5Index *p, /* FTS5 backend object */
  179092. Fts5StructureSegment *pSeg /* Segment to check internal consistency */
  179093. ){
  179094. Fts5Config *pConfig = p->pConfig;
  179095. sqlite3_stmt *pStmt = 0;
  179096. int rc2;
  179097. int iIdxPrevLeaf = pSeg->pgnoFirst-1;
  179098. int iDlidxPrevLeaf = pSeg->pgnoLast;
  179099. if( pSeg->pgnoFirst==0 ) return;
  179100. fts5IndexPrepareStmt(p, &pStmt, sqlite3_mprintf(
  179101. "SELECT segid, term, (pgno>>1), (pgno&1) FROM %Q.'%q_idx' WHERE segid=%d",
  179102. pConfig->zDb, pConfig->zName, pSeg->iSegid
  179103. ));
  179104. /* Iterate through the b-tree hierarchy. */
  179105. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  179106. i64 iRow; /* Rowid for this leaf */
  179107. Fts5Data *pLeaf; /* Data for this leaf */
  179108. int nIdxTerm = sqlite3_column_bytes(pStmt, 1);
  179109. const char *zIdxTerm = (const char*)sqlite3_column_text(pStmt, 1);
  179110. int iIdxLeaf = sqlite3_column_int(pStmt, 2);
  179111. int bIdxDlidx = sqlite3_column_int(pStmt, 3);
  179112. /* If the leaf in question has already been trimmed from the segment,
  179113. ** ignore this b-tree entry. Otherwise, load it into memory. */
  179114. if( iIdxLeaf<pSeg->pgnoFirst ) continue;
  179115. iRow = FTS5_SEGMENT_ROWID(pSeg->iSegid, iIdxLeaf);
  179116. pLeaf = fts5DataRead(p, iRow);
  179117. if( pLeaf==0 ) break;
  179118. /* Check that the leaf contains at least one term, and that it is equal
  179119. ** to or larger than the split-key in zIdxTerm. Also check that if there
  179120. ** is also a rowid pointer within the leaf page header, it points to a
  179121. ** location before the term. */
  179122. if( pLeaf->nn<=pLeaf->szLeaf ){
  179123. p->rc = FTS5_CORRUPT;
  179124. }else{
  179125. int iOff; /* Offset of first term on leaf */
  179126. int iRowidOff; /* Offset of first rowid on leaf */
  179127. int nTerm; /* Size of term on leaf in bytes */
  179128. int res; /* Comparison of term and split-key */
  179129. iOff = fts5LeafFirstTermOff(pLeaf);
  179130. iRowidOff = fts5LeafFirstRowidOff(pLeaf);
  179131. if( iRowidOff>=iOff ){
  179132. p->rc = FTS5_CORRUPT;
  179133. }else{
  179134. iOff += fts5GetVarint32(&pLeaf->p[iOff], nTerm);
  179135. res = memcmp(&pLeaf->p[iOff], zIdxTerm, MIN(nTerm, nIdxTerm));
  179136. if( res==0 ) res = nTerm - nIdxTerm;
  179137. if( res<0 ) p->rc = FTS5_CORRUPT;
  179138. }
  179139. fts5IntegrityCheckPgidx(p, pLeaf);
  179140. }
  179141. fts5DataRelease(pLeaf);
  179142. if( p->rc ) break;
  179143. /* Now check that the iter.nEmpty leaves following the current leaf
  179144. ** (a) exist and (b) contain no terms. */
  179145. fts5IndexIntegrityCheckEmpty(
  179146. p, pSeg, iIdxPrevLeaf+1, iDlidxPrevLeaf+1, iIdxLeaf-1
  179147. );
  179148. if( p->rc ) break;
  179149. /* If there is a doclist-index, check that it looks right. */
  179150. if( bIdxDlidx ){
  179151. Fts5DlidxIter *pDlidx = 0; /* For iterating through doclist index */
  179152. int iPrevLeaf = iIdxLeaf;
  179153. int iSegid = pSeg->iSegid;
  179154. int iPg = 0;
  179155. i64 iKey;
  179156. for(pDlidx=fts5DlidxIterInit(p, 0, iSegid, iIdxLeaf);
  179157. fts5DlidxIterEof(p, pDlidx)==0;
  179158. fts5DlidxIterNext(p, pDlidx)
  179159. ){
  179160. /* Check any rowid-less pages that occur before the current leaf. */
  179161. for(iPg=iPrevLeaf+1; iPg<fts5DlidxIterPgno(pDlidx); iPg++){
  179162. iKey = FTS5_SEGMENT_ROWID(iSegid, iPg);
  179163. pLeaf = fts5DataRead(p, iKey);
  179164. if( pLeaf ){
  179165. if( fts5LeafFirstRowidOff(pLeaf)!=0 ) p->rc = FTS5_CORRUPT;
  179166. fts5DataRelease(pLeaf);
  179167. }
  179168. }
  179169. iPrevLeaf = fts5DlidxIterPgno(pDlidx);
  179170. /* Check that the leaf page indicated by the iterator really does
  179171. ** contain the rowid suggested by the same. */
  179172. iKey = FTS5_SEGMENT_ROWID(iSegid, iPrevLeaf);
  179173. pLeaf = fts5DataRead(p, iKey);
  179174. if( pLeaf ){
  179175. i64 iRowid;
  179176. int iRowidOff = fts5LeafFirstRowidOff(pLeaf);
  179177. ASSERT_SZLEAF_OK(pLeaf);
  179178. if( iRowidOff>=pLeaf->szLeaf ){
  179179. p->rc = FTS5_CORRUPT;
  179180. }else{
  179181. fts5GetVarint(&pLeaf->p[iRowidOff], (u64*)&iRowid);
  179182. if( iRowid!=fts5DlidxIterRowid(pDlidx) ) p->rc = FTS5_CORRUPT;
  179183. }
  179184. fts5DataRelease(pLeaf);
  179185. }
  179186. }
  179187. iDlidxPrevLeaf = iPg;
  179188. fts5DlidxIterFree(pDlidx);
  179189. fts5TestDlidxReverse(p, iSegid, iIdxLeaf);
  179190. }else{
  179191. iDlidxPrevLeaf = pSeg->pgnoLast;
  179192. /* TODO: Check there is no doclist index */
  179193. }
  179194. iIdxPrevLeaf = iIdxLeaf;
  179195. }
  179196. rc2 = sqlite3_finalize(pStmt);
  179197. if( p->rc==SQLITE_OK ) p->rc = rc2;
  179198. /* Page iter.iLeaf must now be the rightmost leaf-page in the segment */
  179199. #if 0
  179200. if( p->rc==SQLITE_OK && iter.iLeaf!=pSeg->pgnoLast ){
  179201. p->rc = FTS5_CORRUPT;
  179202. }
  179203. #endif
  179204. }
  179205. /*
  179206. ** Run internal checks to ensure that the FTS index (a) is internally
  179207. ** consistent and (b) contains entries for which the XOR of the checksums
  179208. ** as calculated by sqlite3Fts5IndexEntryCksum() is cksum.
  179209. **
  179210. ** Return SQLITE_CORRUPT if any of the internal checks fail, or if the
  179211. ** checksum does not match. Return SQLITE_OK if all checks pass without
  179212. ** error, or some other SQLite error code if another error (e.g. OOM)
  179213. ** occurs.
  179214. */
  179215. static int sqlite3Fts5IndexIntegrityCheck(Fts5Index *p, u64 cksum){
  179216. int eDetail = p->pConfig->eDetail;
  179217. u64 cksum2 = 0; /* Checksum based on contents of indexes */
  179218. Fts5Buffer poslist = {0,0,0}; /* Buffer used to hold a poslist */
  179219. Fts5Iter *pIter; /* Used to iterate through entire index */
  179220. Fts5Structure *pStruct; /* Index structure */
  179221. #ifdef SQLITE_DEBUG
  179222. /* Used by extra internal tests only run if NDEBUG is not defined */
  179223. u64 cksum3 = 0; /* Checksum based on contents of indexes */
  179224. Fts5Buffer term = {0,0,0}; /* Buffer used to hold most recent term */
  179225. #endif
  179226. const int flags = FTS5INDEX_QUERY_NOOUTPUT;
  179227. /* Load the FTS index structure */
  179228. pStruct = fts5StructureRead(p);
  179229. /* Check that the internal nodes of each segment match the leaves */
  179230. if( pStruct ){
  179231. int iLvl, iSeg;
  179232. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  179233. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  179234. Fts5StructureSegment *pSeg = &pStruct->aLevel[iLvl].aSeg[iSeg];
  179235. fts5IndexIntegrityCheckSegment(p, pSeg);
  179236. }
  179237. }
  179238. }
  179239. /* The cksum argument passed to this function is a checksum calculated
  179240. ** based on all expected entries in the FTS index (including prefix index
  179241. ** entries). This block checks that a checksum calculated based on the
  179242. ** actual contents of FTS index is identical.
  179243. **
  179244. ** Two versions of the same checksum are calculated. The first (stack
  179245. ** variable cksum2) based on entries extracted from the full-text index
  179246. ** while doing a linear scan of each individual index in turn.
  179247. **
  179248. ** As each term visited by the linear scans, a separate query for the
  179249. ** same term is performed. cksum3 is calculated based on the entries
  179250. ** extracted by these queries.
  179251. */
  179252. for(fts5MultiIterNew(p, pStruct, flags, 0, 0, 0, -1, 0, &pIter);
  179253. fts5MultiIterEof(p, pIter)==0;
  179254. fts5MultiIterNext(p, pIter, 0, 0)
  179255. ){
  179256. int n; /* Size of term in bytes */
  179257. i64 iPos = 0; /* Position read from poslist */
  179258. int iOff = 0; /* Offset within poslist */
  179259. i64 iRowid = fts5MultiIterRowid(pIter);
  179260. char *z = (char*)fts5MultiIterTerm(pIter, &n);
  179261. /* If this is a new term, query for it. Update cksum3 with the results. */
  179262. fts5TestTerm(p, &term, z, n, cksum2, &cksum3);
  179263. if( eDetail==FTS5_DETAIL_NONE ){
  179264. if( 0==fts5MultiIterIsEmpty(p, pIter) ){
  179265. cksum2 ^= sqlite3Fts5IndexEntryCksum(iRowid, 0, 0, -1, z, n);
  179266. }
  179267. }else{
  179268. poslist.n = 0;
  179269. fts5SegiterPoslist(p, &pIter->aSeg[pIter->aFirst[1].iFirst], 0, &poslist);
  179270. while( 0==sqlite3Fts5PoslistNext64(poslist.p, poslist.n, &iOff, &iPos) ){
  179271. int iCol = FTS5_POS2COLUMN(iPos);
  179272. int iTokOff = FTS5_POS2OFFSET(iPos);
  179273. cksum2 ^= sqlite3Fts5IndexEntryCksum(iRowid, iCol, iTokOff, -1, z, n);
  179274. }
  179275. }
  179276. }
  179277. fts5TestTerm(p, &term, 0, 0, cksum2, &cksum3);
  179278. fts5MultiIterFree(pIter);
  179279. if( p->rc==SQLITE_OK && cksum!=cksum2 ) p->rc = FTS5_CORRUPT;
  179280. fts5StructureRelease(pStruct);
  179281. #ifdef SQLITE_DEBUG
  179282. fts5BufferFree(&term);
  179283. #endif
  179284. fts5BufferFree(&poslist);
  179285. return fts5IndexReturn(p);
  179286. }
  179287. /*************************************************************************
  179288. **************************************************************************
  179289. ** Below this point is the implementation of the fts5_decode() scalar
  179290. ** function only.
  179291. */
  179292. /*
  179293. ** Decode a segment-data rowid from the %_data table. This function is
  179294. ** the opposite of macro FTS5_SEGMENT_ROWID().
  179295. */
  179296. static void fts5DecodeRowid(
  179297. i64 iRowid, /* Rowid from %_data table */
  179298. int *piSegid, /* OUT: Segment id */
  179299. int *pbDlidx, /* OUT: Dlidx flag */
  179300. int *piHeight, /* OUT: Height */
  179301. int *piPgno /* OUT: Page number */
  179302. ){
  179303. *piPgno = (int)(iRowid & (((i64)1 << FTS5_DATA_PAGE_B) - 1));
  179304. iRowid >>= FTS5_DATA_PAGE_B;
  179305. *piHeight = (int)(iRowid & (((i64)1 << FTS5_DATA_HEIGHT_B) - 1));
  179306. iRowid >>= FTS5_DATA_HEIGHT_B;
  179307. *pbDlidx = (int)(iRowid & 0x0001);
  179308. iRowid >>= FTS5_DATA_DLI_B;
  179309. *piSegid = (int)(iRowid & (((i64)1 << FTS5_DATA_ID_B) - 1));
  179310. }
  179311. static void fts5DebugRowid(int *pRc, Fts5Buffer *pBuf, i64 iKey){
  179312. int iSegid, iHeight, iPgno, bDlidx; /* Rowid compenents */
  179313. fts5DecodeRowid(iKey, &iSegid, &bDlidx, &iHeight, &iPgno);
  179314. if( iSegid==0 ){
  179315. if( iKey==FTS5_AVERAGES_ROWID ){
  179316. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{averages} ");
  179317. }else{
  179318. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{structure}");
  179319. }
  179320. }
  179321. else{
  179322. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{%ssegid=%d h=%d pgno=%d}",
  179323. bDlidx ? "dlidx " : "", iSegid, iHeight, iPgno
  179324. );
  179325. }
  179326. }
  179327. static void fts5DebugStructure(
  179328. int *pRc, /* IN/OUT: error code */
  179329. Fts5Buffer *pBuf,
  179330. Fts5Structure *p
  179331. ){
  179332. int iLvl, iSeg; /* Iterate through levels, segments */
  179333. for(iLvl=0; iLvl<p->nLevel; iLvl++){
  179334. Fts5StructureLevel *pLvl = &p->aLevel[iLvl];
  179335. sqlite3Fts5BufferAppendPrintf(pRc, pBuf,
  179336. " {lvl=%d nMerge=%d nSeg=%d", iLvl, pLvl->nMerge, pLvl->nSeg
  179337. );
  179338. for(iSeg=0; iSeg<pLvl->nSeg; iSeg++){
  179339. Fts5StructureSegment *pSeg = &pLvl->aSeg[iSeg];
  179340. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " {id=%d leaves=%d..%d}",
  179341. pSeg->iSegid, pSeg->pgnoFirst, pSeg->pgnoLast
  179342. );
  179343. }
  179344. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "}");
  179345. }
  179346. }
  179347. /*
  179348. ** This is part of the fts5_decode() debugging aid.
  179349. **
  179350. ** Arguments pBlob/nBlob contain a serialized Fts5Structure object. This
  179351. ** function appends a human-readable representation of the same object
  179352. ** to the buffer passed as the second argument.
  179353. */
  179354. static void fts5DecodeStructure(
  179355. int *pRc, /* IN/OUT: error code */
  179356. Fts5Buffer *pBuf,
  179357. const u8 *pBlob, int nBlob
  179358. ){
  179359. int rc; /* Return code */
  179360. Fts5Structure *p = 0; /* Decoded structure object */
  179361. rc = fts5StructureDecode(pBlob, nBlob, 0, &p);
  179362. if( rc!=SQLITE_OK ){
  179363. *pRc = rc;
  179364. return;
  179365. }
  179366. fts5DebugStructure(pRc, pBuf, p);
  179367. fts5StructureRelease(p);
  179368. }
  179369. /*
  179370. ** This is part of the fts5_decode() debugging aid.
  179371. **
  179372. ** Arguments pBlob/nBlob contain an "averages" record. This function
  179373. ** appends a human-readable representation of record to the buffer passed
  179374. ** as the second argument.
  179375. */
  179376. static void fts5DecodeAverages(
  179377. int *pRc, /* IN/OUT: error code */
  179378. Fts5Buffer *pBuf,
  179379. const u8 *pBlob, int nBlob
  179380. ){
  179381. int i = 0;
  179382. const char *zSpace = "";
  179383. while( i<nBlob ){
  179384. u64 iVal;
  179385. i += sqlite3Fts5GetVarint(&pBlob[i], &iVal);
  179386. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "%s%d", zSpace, (int)iVal);
  179387. zSpace = " ";
  179388. }
  179389. }
  179390. /*
  179391. ** Buffer (a/n) is assumed to contain a list of serialized varints. Read
  179392. ** each varint and append its string representation to buffer pBuf. Return
  179393. ** after either the input buffer is exhausted or a 0 value is read.
  179394. **
  179395. ** The return value is the number of bytes read from the input buffer.
  179396. */
  179397. static int fts5DecodePoslist(int *pRc, Fts5Buffer *pBuf, const u8 *a, int n){
  179398. int iOff = 0;
  179399. while( iOff<n ){
  179400. int iVal;
  179401. iOff += fts5GetVarint32(&a[iOff], iVal);
  179402. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " %d", iVal);
  179403. }
  179404. return iOff;
  179405. }
  179406. /*
  179407. ** The start of buffer (a/n) contains the start of a doclist. The doclist
  179408. ** may or may not finish within the buffer. This function appends a text
  179409. ** representation of the part of the doclist that is present to buffer
  179410. ** pBuf.
  179411. **
  179412. ** The return value is the number of bytes read from the input buffer.
  179413. */
  179414. static int fts5DecodeDoclist(int *pRc, Fts5Buffer *pBuf, const u8 *a, int n){
  179415. i64 iDocid = 0;
  179416. int iOff = 0;
  179417. if( n>0 ){
  179418. iOff = sqlite3Fts5GetVarint(a, (u64*)&iDocid);
  179419. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " id=%lld", iDocid);
  179420. }
  179421. while( iOff<n ){
  179422. int nPos;
  179423. int bDel;
  179424. iOff += fts5GetPoslistSize(&a[iOff], &nPos, &bDel);
  179425. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " nPos=%d%s", nPos, bDel?"*":"");
  179426. iOff += fts5DecodePoslist(pRc, pBuf, &a[iOff], MIN(n-iOff, nPos));
  179427. if( iOff<n ){
  179428. i64 iDelta;
  179429. iOff += sqlite3Fts5GetVarint(&a[iOff], (u64*)&iDelta);
  179430. iDocid += iDelta;
  179431. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " id=%lld", iDocid);
  179432. }
  179433. }
  179434. return iOff;
  179435. }
  179436. /*
  179437. ** This function is part of the fts5_decode() debugging function. It is
  179438. ** only ever used with detail=none tables.
  179439. **
  179440. ** Buffer (pData/nData) contains a doclist in the format used by detail=none
  179441. ** tables. This function appends a human-readable version of that list to
  179442. ** buffer pBuf.
  179443. **
  179444. ** If *pRc is other than SQLITE_OK when this function is called, it is a
  179445. ** no-op. If an OOM or other error occurs within this function, *pRc is
  179446. ** set to an SQLite error code before returning. The final state of buffer
  179447. ** pBuf is undefined in this case.
  179448. */
  179449. static void fts5DecodeRowidList(
  179450. int *pRc, /* IN/OUT: Error code */
  179451. Fts5Buffer *pBuf, /* Buffer to append text to */
  179452. const u8 *pData, int nData /* Data to decode list-of-rowids from */
  179453. ){
  179454. int i = 0;
  179455. i64 iRowid = 0;
  179456. while( i<nData ){
  179457. const char *zApp = "";
  179458. u64 iVal;
  179459. i += sqlite3Fts5GetVarint(&pData[i], &iVal);
  179460. iRowid += iVal;
  179461. if( i<nData && pData[i]==0x00 ){
  179462. i++;
  179463. if( i<nData && pData[i]==0x00 ){
  179464. i++;
  179465. zApp = "+";
  179466. }else{
  179467. zApp = "*";
  179468. }
  179469. }
  179470. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " %lld%s", iRowid, zApp);
  179471. }
  179472. }
  179473. /*
  179474. ** The implementation of user-defined scalar function fts5_decode().
  179475. */
  179476. static void fts5DecodeFunction(
  179477. sqlite3_context *pCtx, /* Function call context */
  179478. int nArg, /* Number of args (always 2) */
  179479. sqlite3_value **apVal /* Function arguments */
  179480. ){
  179481. i64 iRowid; /* Rowid for record being decoded */
  179482. int iSegid,iHeight,iPgno,bDlidx;/* Rowid components */
  179483. const u8 *aBlob; int n; /* Record to decode */
  179484. u8 *a = 0;
  179485. Fts5Buffer s; /* Build up text to return here */
  179486. int rc = SQLITE_OK; /* Return code */
  179487. int nSpace = 0;
  179488. int eDetailNone = (sqlite3_user_data(pCtx)!=0);
  179489. assert( nArg==2 );
  179490. UNUSED_PARAM(nArg);
  179491. memset(&s, 0, sizeof(Fts5Buffer));
  179492. iRowid = sqlite3_value_int64(apVal[0]);
  179493. /* Make a copy of the second argument (a blob) in aBlob[]. The aBlob[]
  179494. ** copy is followed by FTS5_DATA_ZERO_PADDING 0x00 bytes, which prevents
  179495. ** buffer overreads even if the record is corrupt. */
  179496. n = sqlite3_value_bytes(apVal[1]);
  179497. aBlob = sqlite3_value_blob(apVal[1]);
  179498. nSpace = n + FTS5_DATA_ZERO_PADDING;
  179499. a = (u8*)sqlite3Fts5MallocZero(&rc, nSpace);
  179500. if( a==0 ) goto decode_out;
  179501. memcpy(a, aBlob, n);
  179502. fts5DecodeRowid(iRowid, &iSegid, &bDlidx, &iHeight, &iPgno);
  179503. fts5DebugRowid(&rc, &s, iRowid);
  179504. if( bDlidx ){
  179505. Fts5Data dlidx;
  179506. Fts5DlidxLvl lvl;
  179507. dlidx.p = a;
  179508. dlidx.nn = n;
  179509. memset(&lvl, 0, sizeof(Fts5DlidxLvl));
  179510. lvl.pData = &dlidx;
  179511. lvl.iLeafPgno = iPgno;
  179512. for(fts5DlidxLvlNext(&lvl); lvl.bEof==0; fts5DlidxLvlNext(&lvl)){
  179513. sqlite3Fts5BufferAppendPrintf(&rc, &s,
  179514. " %d(%lld)", lvl.iLeafPgno, lvl.iRowid
  179515. );
  179516. }
  179517. }else if( iSegid==0 ){
  179518. if( iRowid==FTS5_AVERAGES_ROWID ){
  179519. fts5DecodeAverages(&rc, &s, a, n);
  179520. }else{
  179521. fts5DecodeStructure(&rc, &s, a, n);
  179522. }
  179523. }else if( eDetailNone ){
  179524. Fts5Buffer term; /* Current term read from page */
  179525. int szLeaf;
  179526. int iPgidxOff = szLeaf = fts5GetU16(&a[2]);
  179527. int iTermOff;
  179528. int nKeep = 0;
  179529. int iOff;
  179530. memset(&term, 0, sizeof(Fts5Buffer));
  179531. /* Decode any entries that occur before the first term. */
  179532. if( szLeaf<n ){
  179533. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], iTermOff);
  179534. }else{
  179535. iTermOff = szLeaf;
  179536. }
  179537. fts5DecodeRowidList(&rc, &s, &a[4], iTermOff-4);
  179538. iOff = iTermOff;
  179539. while( iOff<szLeaf ){
  179540. int nAppend;
  179541. /* Read the term data for the next term*/
  179542. iOff += fts5GetVarint32(&a[iOff], nAppend);
  179543. term.n = nKeep;
  179544. fts5BufferAppendBlob(&rc, &term, nAppend, &a[iOff]);
  179545. sqlite3Fts5BufferAppendPrintf(
  179546. &rc, &s, " term=%.*s", term.n, (const char*)term.p
  179547. );
  179548. iOff += nAppend;
  179549. /* Figure out where the doclist for this term ends */
  179550. if( iPgidxOff<n ){
  179551. int nIncr;
  179552. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], nIncr);
  179553. iTermOff += nIncr;
  179554. }else{
  179555. iTermOff = szLeaf;
  179556. }
  179557. fts5DecodeRowidList(&rc, &s, &a[iOff], iTermOff-iOff);
  179558. iOff = iTermOff;
  179559. if( iOff<szLeaf ){
  179560. iOff += fts5GetVarint32(&a[iOff], nKeep);
  179561. }
  179562. }
  179563. fts5BufferFree(&term);
  179564. }else{
  179565. Fts5Buffer term; /* Current term read from page */
  179566. int szLeaf; /* Offset of pgidx in a[] */
  179567. int iPgidxOff;
  179568. int iPgidxPrev = 0; /* Previous value read from pgidx */
  179569. int iTermOff = 0;
  179570. int iRowidOff = 0;
  179571. int iOff;
  179572. int nDoclist;
  179573. memset(&term, 0, sizeof(Fts5Buffer));
  179574. if( n<4 ){
  179575. sqlite3Fts5BufferSet(&rc, &s, 7, (const u8*)"corrupt");
  179576. goto decode_out;
  179577. }else{
  179578. iRowidOff = fts5GetU16(&a[0]);
  179579. iPgidxOff = szLeaf = fts5GetU16(&a[2]);
  179580. if( iPgidxOff<n ){
  179581. fts5GetVarint32(&a[iPgidxOff], iTermOff);
  179582. }
  179583. }
  179584. /* Decode the position list tail at the start of the page */
  179585. if( iRowidOff!=0 ){
  179586. iOff = iRowidOff;
  179587. }else if( iTermOff!=0 ){
  179588. iOff = iTermOff;
  179589. }else{
  179590. iOff = szLeaf;
  179591. }
  179592. fts5DecodePoslist(&rc, &s, &a[4], iOff-4);
  179593. /* Decode any more doclist data that appears on the page before the
  179594. ** first term. */
  179595. nDoclist = (iTermOff ? iTermOff : szLeaf) - iOff;
  179596. fts5DecodeDoclist(&rc, &s, &a[iOff], nDoclist);
  179597. while( iPgidxOff<n ){
  179598. int bFirst = (iPgidxOff==szLeaf); /* True for first term on page */
  179599. int nByte; /* Bytes of data */
  179600. int iEnd;
  179601. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], nByte);
  179602. iPgidxPrev += nByte;
  179603. iOff = iPgidxPrev;
  179604. if( iPgidxOff<n ){
  179605. fts5GetVarint32(&a[iPgidxOff], nByte);
  179606. iEnd = iPgidxPrev + nByte;
  179607. }else{
  179608. iEnd = szLeaf;
  179609. }
  179610. if( bFirst==0 ){
  179611. iOff += fts5GetVarint32(&a[iOff], nByte);
  179612. term.n = nByte;
  179613. }
  179614. iOff += fts5GetVarint32(&a[iOff], nByte);
  179615. fts5BufferAppendBlob(&rc, &term, nByte, &a[iOff]);
  179616. iOff += nByte;
  179617. sqlite3Fts5BufferAppendPrintf(
  179618. &rc, &s, " term=%.*s", term.n, (const char*)term.p
  179619. );
  179620. iOff += fts5DecodeDoclist(&rc, &s, &a[iOff], iEnd-iOff);
  179621. }
  179622. fts5BufferFree(&term);
  179623. }
  179624. decode_out:
  179625. sqlite3_free(a);
  179626. if( rc==SQLITE_OK ){
  179627. sqlite3_result_text(pCtx, (const char*)s.p, s.n, SQLITE_TRANSIENT);
  179628. }else{
  179629. sqlite3_result_error_code(pCtx, rc);
  179630. }
  179631. fts5BufferFree(&s);
  179632. }
  179633. /*
  179634. ** The implementation of user-defined scalar function fts5_rowid().
  179635. */
  179636. static void fts5RowidFunction(
  179637. sqlite3_context *pCtx, /* Function call context */
  179638. int nArg, /* Number of args (always 2) */
  179639. sqlite3_value **apVal /* Function arguments */
  179640. ){
  179641. const char *zArg;
  179642. if( nArg==0 ){
  179643. sqlite3_result_error(pCtx, "should be: fts5_rowid(subject, ....)", -1);
  179644. }else{
  179645. zArg = (const char*)sqlite3_value_text(apVal[0]);
  179646. if( 0==sqlite3_stricmp(zArg, "segment") ){
  179647. i64 iRowid;
  179648. int segid, pgno;
  179649. if( nArg!=3 ){
  179650. sqlite3_result_error(pCtx,
  179651. "should be: fts5_rowid('segment', segid, pgno))", -1
  179652. );
  179653. }else{
  179654. segid = sqlite3_value_int(apVal[1]);
  179655. pgno = sqlite3_value_int(apVal[2]);
  179656. iRowid = FTS5_SEGMENT_ROWID(segid, pgno);
  179657. sqlite3_result_int64(pCtx, iRowid);
  179658. }
  179659. }else{
  179660. sqlite3_result_error(pCtx,
  179661. "first arg to fts5_rowid() must be 'segment'" , -1
  179662. );
  179663. }
  179664. }
  179665. }
  179666. /*
  179667. ** This is called as part of registering the FTS5 module with database
  179668. ** connection db. It registers several user-defined scalar functions useful
  179669. ** with FTS5.
  179670. **
  179671. ** If successful, SQLITE_OK is returned. If an error occurs, some other
  179672. ** SQLite error code is returned instead.
  179673. */
  179674. static int sqlite3Fts5IndexInit(sqlite3 *db){
  179675. int rc = sqlite3_create_function(
  179676. db, "fts5_decode", 2, SQLITE_UTF8, 0, fts5DecodeFunction, 0, 0
  179677. );
  179678. if( rc==SQLITE_OK ){
  179679. rc = sqlite3_create_function(
  179680. db, "fts5_decode_none", 2,
  179681. SQLITE_UTF8, (void*)db, fts5DecodeFunction, 0, 0
  179682. );
  179683. }
  179684. if( rc==SQLITE_OK ){
  179685. rc = sqlite3_create_function(
  179686. db, "fts5_rowid", -1, SQLITE_UTF8, 0, fts5RowidFunction, 0, 0
  179687. );
  179688. }
  179689. return rc;
  179690. }
  179691. static int sqlite3Fts5IndexReset(Fts5Index *p){
  179692. assert( p->pStruct==0 || p->iStructVersion!=0 );
  179693. if( fts5IndexDataVersion(p)!=p->iStructVersion ){
  179694. fts5StructureInvalidate(p);
  179695. }
  179696. return fts5IndexReturn(p);
  179697. }
  179698. /*
  179699. ** 2014 Jun 09
  179700. **
  179701. ** The author disclaims copyright to this source code. In place of
  179702. ** a legal notice, here is a blessing:
  179703. **
  179704. ** May you do good and not evil.
  179705. ** May you find forgiveness for yourself and forgive others.
  179706. ** May you share freely, never taking more than you give.
  179707. **
  179708. ******************************************************************************
  179709. **
  179710. ** This is an SQLite module implementing full-text search.
  179711. */
  179712. /* #include "fts5Int.h" */
  179713. /*
  179714. ** This variable is set to false when running tests for which the on disk
  179715. ** structures should not be corrupt. Otherwise, true. If it is false, extra
  179716. ** assert() conditions in the fts5 code are activated - conditions that are
  179717. ** only true if it is guaranteed that the fts5 database is not corrupt.
  179718. */
  179719. SQLITE_API int sqlite3_fts5_may_be_corrupt = 1;
  179720. typedef struct Fts5Auxdata Fts5Auxdata;
  179721. typedef struct Fts5Auxiliary Fts5Auxiliary;
  179722. typedef struct Fts5Cursor Fts5Cursor;
  179723. typedef struct Fts5Sorter Fts5Sorter;
  179724. typedef struct Fts5Table Fts5Table;
  179725. typedef struct Fts5TokenizerModule Fts5TokenizerModule;
  179726. /*
  179727. ** NOTES ON TRANSACTIONS:
  179728. **
  179729. ** SQLite invokes the following virtual table methods as transactions are
  179730. ** opened and closed by the user:
  179731. **
  179732. ** xBegin(): Start of a new transaction.
  179733. ** xSync(): Initial part of two-phase commit.
  179734. ** xCommit(): Final part of two-phase commit.
  179735. ** xRollback(): Rollback the transaction.
  179736. **
  179737. ** Anything that is required as part of a commit that may fail is performed
  179738. ** in the xSync() callback. Current versions of SQLite ignore any errors
  179739. ** returned by xCommit().
  179740. **
  179741. ** And as sub-transactions are opened/closed:
  179742. **
  179743. ** xSavepoint(int S): Open savepoint S.
  179744. ** xRelease(int S): Commit and close savepoint S.
  179745. ** xRollbackTo(int S): Rollback to start of savepoint S.
  179746. **
  179747. ** During a write-transaction the fts5_index.c module may cache some data
  179748. ** in-memory. It is flushed to disk whenever xSync(), xRelease() or
  179749. ** xSavepoint() is called. And discarded whenever xRollback() or xRollbackTo()
  179750. ** is called.
  179751. **
  179752. ** Additionally, if SQLITE_DEBUG is defined, an instance of the following
  179753. ** structure is used to record the current transaction state. This information
  179754. ** is not required, but it is used in the assert() statements executed by
  179755. ** function fts5CheckTransactionState() (see below).
  179756. */
  179757. struct Fts5TransactionState {
  179758. int eState; /* 0==closed, 1==open, 2==synced */
  179759. int iSavepoint; /* Number of open savepoints (0 -> none) */
  179760. };
  179761. /*
  179762. ** A single object of this type is allocated when the FTS5 module is
  179763. ** registered with a database handle. It is used to store pointers to
  179764. ** all registered FTS5 extensions - tokenizers and auxiliary functions.
  179765. */
  179766. struct Fts5Global {
  179767. fts5_api api; /* User visible part of object (see fts5.h) */
  179768. sqlite3 *db; /* Associated database connection */
  179769. i64 iNextId; /* Used to allocate unique cursor ids */
  179770. Fts5Auxiliary *pAux; /* First in list of all aux. functions */
  179771. Fts5TokenizerModule *pTok; /* First in list of all tokenizer modules */
  179772. Fts5TokenizerModule *pDfltTok; /* Default tokenizer module */
  179773. Fts5Cursor *pCsr; /* First in list of all open cursors */
  179774. };
  179775. /*
  179776. ** Each auxiliary function registered with the FTS5 module is represented
  179777. ** by an object of the following type. All such objects are stored as part
  179778. ** of the Fts5Global.pAux list.
  179779. */
  179780. struct Fts5Auxiliary {
  179781. Fts5Global *pGlobal; /* Global context for this function */
  179782. char *zFunc; /* Function name (nul-terminated) */
  179783. void *pUserData; /* User-data pointer */
  179784. fts5_extension_function xFunc; /* Callback function */
  179785. void (*xDestroy)(void*); /* Destructor function */
  179786. Fts5Auxiliary *pNext; /* Next registered auxiliary function */
  179787. };
  179788. /*
  179789. ** Each tokenizer module registered with the FTS5 module is represented
  179790. ** by an object of the following type. All such objects are stored as part
  179791. ** of the Fts5Global.pTok list.
  179792. */
  179793. struct Fts5TokenizerModule {
  179794. char *zName; /* Name of tokenizer */
  179795. void *pUserData; /* User pointer passed to xCreate() */
  179796. fts5_tokenizer x; /* Tokenizer functions */
  179797. void (*xDestroy)(void*); /* Destructor function */
  179798. Fts5TokenizerModule *pNext; /* Next registered tokenizer module */
  179799. };
  179800. /*
  179801. ** Virtual-table object.
  179802. */
  179803. struct Fts5Table {
  179804. sqlite3_vtab base; /* Base class used by SQLite core */
  179805. Fts5Config *pConfig; /* Virtual table configuration */
  179806. Fts5Index *pIndex; /* Full-text index */
  179807. Fts5Storage *pStorage; /* Document store */
  179808. Fts5Global *pGlobal; /* Global (connection wide) data */
  179809. Fts5Cursor *pSortCsr; /* Sort data from this cursor */
  179810. #ifdef SQLITE_DEBUG
  179811. struct Fts5TransactionState ts;
  179812. #endif
  179813. };
  179814. struct Fts5MatchPhrase {
  179815. Fts5Buffer *pPoslist; /* Pointer to current poslist */
  179816. int nTerm; /* Size of phrase in terms */
  179817. };
  179818. /*
  179819. ** pStmt:
  179820. ** SELECT rowid, <fts> FROM <fts> ORDER BY +rank;
  179821. **
  179822. ** aIdx[]:
  179823. ** There is one entry in the aIdx[] array for each phrase in the query,
  179824. ** the value of which is the offset within aPoslist[] following the last
  179825. ** byte of the position list for the corresponding phrase.
  179826. */
  179827. struct Fts5Sorter {
  179828. sqlite3_stmt *pStmt;
  179829. i64 iRowid; /* Current rowid */
  179830. const u8 *aPoslist; /* Position lists for current row */
  179831. int nIdx; /* Number of entries in aIdx[] */
  179832. int aIdx[1]; /* Offsets into aPoslist for current row */
  179833. };
  179834. /*
  179835. ** Virtual-table cursor object.
  179836. **
  179837. ** iSpecial:
  179838. ** If this is a 'special' query (refer to function fts5SpecialMatch()),
  179839. ** then this variable contains the result of the query.
  179840. **
  179841. ** iFirstRowid, iLastRowid:
  179842. ** These variables are only used for FTS5_PLAN_MATCH cursors. Assuming the
  179843. ** cursor iterates in ascending order of rowids, iFirstRowid is the lower
  179844. ** limit of rowids to return, and iLastRowid the upper. In other words, the
  179845. ** WHERE clause in the user's query might have been:
  179846. **
  179847. ** <tbl> MATCH <expr> AND rowid BETWEEN $iFirstRowid AND $iLastRowid
  179848. **
  179849. ** If the cursor iterates in descending order of rowid, iFirstRowid
  179850. ** is the upper limit (i.e. the "first" rowid visited) and iLastRowid
  179851. ** the lower.
  179852. */
  179853. struct Fts5Cursor {
  179854. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  179855. Fts5Cursor *pNext; /* Next cursor in Fts5Cursor.pCsr list */
  179856. int *aColumnSize; /* Values for xColumnSize() */
  179857. i64 iCsrId; /* Cursor id */
  179858. /* Zero from this point onwards on cursor reset */
  179859. int ePlan; /* FTS5_PLAN_XXX value */
  179860. int bDesc; /* True for "ORDER BY rowid DESC" queries */
  179861. i64 iFirstRowid; /* Return no rowids earlier than this */
  179862. i64 iLastRowid; /* Return no rowids later than this */
  179863. sqlite3_stmt *pStmt; /* Statement used to read %_content */
  179864. Fts5Expr *pExpr; /* Expression for MATCH queries */
  179865. Fts5Sorter *pSorter; /* Sorter for "ORDER BY rank" queries */
  179866. int csrflags; /* Mask of cursor flags (see below) */
  179867. i64 iSpecial; /* Result of special query */
  179868. /* "rank" function. Populated on demand from vtab.xColumn(). */
  179869. char *zRank; /* Custom rank function */
  179870. char *zRankArgs; /* Custom rank function args */
  179871. Fts5Auxiliary *pRank; /* Rank callback (or NULL) */
  179872. int nRankArg; /* Number of trailing arguments for rank() */
  179873. sqlite3_value **apRankArg; /* Array of trailing arguments */
  179874. sqlite3_stmt *pRankArgStmt; /* Origin of objects in apRankArg[] */
  179875. /* Auxiliary data storage */
  179876. Fts5Auxiliary *pAux; /* Currently executing extension function */
  179877. Fts5Auxdata *pAuxdata; /* First in linked list of saved aux-data */
  179878. /* Cache used by auxiliary functions xInst() and xInstCount() */
  179879. Fts5PoslistReader *aInstIter; /* One for each phrase */
  179880. int nInstAlloc; /* Size of aInst[] array (entries / 3) */
  179881. int nInstCount; /* Number of phrase instances */
  179882. int *aInst; /* 3 integers per phrase instance */
  179883. };
  179884. /*
  179885. ** Bits that make up the "idxNum" parameter passed indirectly by
  179886. ** xBestIndex() to xFilter().
  179887. */
  179888. #define FTS5_BI_MATCH 0x0001 /* <tbl> MATCH ? */
  179889. #define FTS5_BI_RANK 0x0002 /* rank MATCH ? */
  179890. #define FTS5_BI_ROWID_EQ 0x0004 /* rowid == ? */
  179891. #define FTS5_BI_ROWID_LE 0x0008 /* rowid <= ? */
  179892. #define FTS5_BI_ROWID_GE 0x0010 /* rowid >= ? */
  179893. #define FTS5_BI_ORDER_RANK 0x0020
  179894. #define FTS5_BI_ORDER_ROWID 0x0040
  179895. #define FTS5_BI_ORDER_DESC 0x0080
  179896. /*
  179897. ** Values for Fts5Cursor.csrflags
  179898. */
  179899. #define FTS5CSR_EOF 0x01
  179900. #define FTS5CSR_REQUIRE_CONTENT 0x02
  179901. #define FTS5CSR_REQUIRE_DOCSIZE 0x04
  179902. #define FTS5CSR_REQUIRE_INST 0x08
  179903. #define FTS5CSR_FREE_ZRANK 0x10
  179904. #define FTS5CSR_REQUIRE_RESEEK 0x20
  179905. #define FTS5CSR_REQUIRE_POSLIST 0x40
  179906. #define BitFlagAllTest(x,y) (((x) & (y))==(y))
  179907. #define BitFlagTest(x,y) (((x) & (y))!=0)
  179908. /*
  179909. ** Macros to Set(), Clear() and Test() cursor flags.
  179910. */
  179911. #define CsrFlagSet(pCsr, flag) ((pCsr)->csrflags |= (flag))
  179912. #define CsrFlagClear(pCsr, flag) ((pCsr)->csrflags &= ~(flag))
  179913. #define CsrFlagTest(pCsr, flag) ((pCsr)->csrflags & (flag))
  179914. struct Fts5Auxdata {
  179915. Fts5Auxiliary *pAux; /* Extension to which this belongs */
  179916. void *pPtr; /* Pointer value */
  179917. void(*xDelete)(void*); /* Destructor */
  179918. Fts5Auxdata *pNext; /* Next object in linked list */
  179919. };
  179920. #ifdef SQLITE_DEBUG
  179921. #define FTS5_BEGIN 1
  179922. #define FTS5_SYNC 2
  179923. #define FTS5_COMMIT 3
  179924. #define FTS5_ROLLBACK 4
  179925. #define FTS5_SAVEPOINT 5
  179926. #define FTS5_RELEASE 6
  179927. #define FTS5_ROLLBACKTO 7
  179928. static void fts5CheckTransactionState(Fts5Table *p, int op, int iSavepoint){
  179929. switch( op ){
  179930. case FTS5_BEGIN:
  179931. assert( p->ts.eState==0 );
  179932. p->ts.eState = 1;
  179933. p->ts.iSavepoint = -1;
  179934. break;
  179935. case FTS5_SYNC:
  179936. assert( p->ts.eState==1 );
  179937. p->ts.eState = 2;
  179938. break;
  179939. case FTS5_COMMIT:
  179940. assert( p->ts.eState==2 );
  179941. p->ts.eState = 0;
  179942. break;
  179943. case FTS5_ROLLBACK:
  179944. assert( p->ts.eState==1 || p->ts.eState==2 || p->ts.eState==0 );
  179945. p->ts.eState = 0;
  179946. break;
  179947. case FTS5_SAVEPOINT:
  179948. assert( p->ts.eState==1 );
  179949. assert( iSavepoint>=0 );
  179950. assert( iSavepoint>p->ts.iSavepoint );
  179951. p->ts.iSavepoint = iSavepoint;
  179952. break;
  179953. case FTS5_RELEASE:
  179954. assert( p->ts.eState==1 );
  179955. assert( iSavepoint>=0 );
  179956. assert( iSavepoint<=p->ts.iSavepoint );
  179957. p->ts.iSavepoint = iSavepoint-1;
  179958. break;
  179959. case FTS5_ROLLBACKTO:
  179960. assert( p->ts.eState==1 );
  179961. assert( iSavepoint>=0 );
  179962. assert( iSavepoint<=p->ts.iSavepoint );
  179963. p->ts.iSavepoint = iSavepoint;
  179964. break;
  179965. }
  179966. }
  179967. #else
  179968. # define fts5CheckTransactionState(x,y,z)
  179969. #endif
  179970. /*
  179971. ** Return true if pTab is a contentless table.
  179972. */
  179973. static int fts5IsContentless(Fts5Table *pTab){
  179974. return pTab->pConfig->eContent==FTS5_CONTENT_NONE;
  179975. }
  179976. /*
  179977. ** Delete a virtual table handle allocated by fts5InitVtab().
  179978. */
  179979. static void fts5FreeVtab(Fts5Table *pTab){
  179980. if( pTab ){
  179981. sqlite3Fts5IndexClose(pTab->pIndex);
  179982. sqlite3Fts5StorageClose(pTab->pStorage);
  179983. sqlite3Fts5ConfigFree(pTab->pConfig);
  179984. sqlite3_free(pTab);
  179985. }
  179986. }
  179987. /*
  179988. ** The xDisconnect() virtual table method.
  179989. */
  179990. static int fts5DisconnectMethod(sqlite3_vtab *pVtab){
  179991. fts5FreeVtab((Fts5Table*)pVtab);
  179992. return SQLITE_OK;
  179993. }
  179994. /*
  179995. ** The xDestroy() virtual table method.
  179996. */
  179997. static int fts5DestroyMethod(sqlite3_vtab *pVtab){
  179998. Fts5Table *pTab = (Fts5Table*)pVtab;
  179999. int rc = sqlite3Fts5DropAll(pTab->pConfig);
  180000. if( rc==SQLITE_OK ){
  180001. fts5FreeVtab((Fts5Table*)pVtab);
  180002. }
  180003. return rc;
  180004. }
  180005. /*
  180006. ** This function is the implementation of both the xConnect and xCreate
  180007. ** methods of the FTS3 virtual table.
  180008. **
  180009. ** The argv[] array contains the following:
  180010. **
  180011. ** argv[0] -> module name ("fts5")
  180012. ** argv[1] -> database name
  180013. ** argv[2] -> table name
  180014. ** argv[...] -> "column name" and other module argument fields.
  180015. */
  180016. static int fts5InitVtab(
  180017. int bCreate, /* True for xCreate, false for xConnect */
  180018. sqlite3 *db, /* The SQLite database connection */
  180019. void *pAux, /* Hash table containing tokenizers */
  180020. int argc, /* Number of elements in argv array */
  180021. const char * const *argv, /* xCreate/xConnect argument array */
  180022. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  180023. char **pzErr /* Write any error message here */
  180024. ){
  180025. Fts5Global *pGlobal = (Fts5Global*)pAux;
  180026. const char **azConfig = (const char**)argv;
  180027. int rc = SQLITE_OK; /* Return code */
  180028. Fts5Config *pConfig = 0; /* Results of parsing argc/argv */
  180029. Fts5Table *pTab = 0; /* New virtual table object */
  180030. /* Allocate the new vtab object and parse the configuration */
  180031. pTab = (Fts5Table*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Table));
  180032. if( rc==SQLITE_OK ){
  180033. rc = sqlite3Fts5ConfigParse(pGlobal, db, argc, azConfig, &pConfig, pzErr);
  180034. assert( (rc==SQLITE_OK && *pzErr==0) || pConfig==0 );
  180035. }
  180036. if( rc==SQLITE_OK ){
  180037. pTab->pConfig = pConfig;
  180038. pTab->pGlobal = pGlobal;
  180039. }
  180040. /* Open the index sub-system */
  180041. if( rc==SQLITE_OK ){
  180042. rc = sqlite3Fts5IndexOpen(pConfig, bCreate, &pTab->pIndex, pzErr);
  180043. }
  180044. /* Open the storage sub-system */
  180045. if( rc==SQLITE_OK ){
  180046. rc = sqlite3Fts5StorageOpen(
  180047. pConfig, pTab->pIndex, bCreate, &pTab->pStorage, pzErr
  180048. );
  180049. }
  180050. /* Call sqlite3_declare_vtab() */
  180051. if( rc==SQLITE_OK ){
  180052. rc = sqlite3Fts5ConfigDeclareVtab(pConfig);
  180053. }
  180054. /* Load the initial configuration */
  180055. if( rc==SQLITE_OK ){
  180056. assert( pConfig->pzErrmsg==0 );
  180057. pConfig->pzErrmsg = pzErr;
  180058. rc = sqlite3Fts5IndexLoadConfig(pTab->pIndex);
  180059. sqlite3Fts5IndexRollback(pTab->pIndex);
  180060. pConfig->pzErrmsg = 0;
  180061. }
  180062. if( rc!=SQLITE_OK ){
  180063. fts5FreeVtab(pTab);
  180064. pTab = 0;
  180065. }else if( bCreate ){
  180066. fts5CheckTransactionState(pTab, FTS5_BEGIN, 0);
  180067. }
  180068. *ppVTab = (sqlite3_vtab*)pTab;
  180069. return rc;
  180070. }
  180071. /*
  180072. ** The xConnect() and xCreate() methods for the virtual table. All the
  180073. ** work is done in function fts5InitVtab().
  180074. */
  180075. static int fts5ConnectMethod(
  180076. sqlite3 *db, /* Database connection */
  180077. void *pAux, /* Pointer to tokenizer hash table */
  180078. int argc, /* Number of elements in argv array */
  180079. const char * const *argv, /* xCreate/xConnect argument array */
  180080. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  180081. char **pzErr /* OUT: sqlite3_malloc'd error message */
  180082. ){
  180083. return fts5InitVtab(0, db, pAux, argc, argv, ppVtab, pzErr);
  180084. }
  180085. static int fts5CreateMethod(
  180086. sqlite3 *db, /* Database connection */
  180087. void *pAux, /* Pointer to tokenizer hash table */
  180088. int argc, /* Number of elements in argv array */
  180089. const char * const *argv, /* xCreate/xConnect argument array */
  180090. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  180091. char **pzErr /* OUT: sqlite3_malloc'd error message */
  180092. ){
  180093. return fts5InitVtab(1, db, pAux, argc, argv, ppVtab, pzErr);
  180094. }
  180095. /*
  180096. ** The different query plans.
  180097. */
  180098. #define FTS5_PLAN_MATCH 1 /* (<tbl> MATCH ?) */
  180099. #define FTS5_PLAN_SOURCE 2 /* A source cursor for SORTED_MATCH */
  180100. #define FTS5_PLAN_SPECIAL 3 /* An internal query */
  180101. #define FTS5_PLAN_SORTED_MATCH 4 /* (<tbl> MATCH ? ORDER BY rank) */
  180102. #define FTS5_PLAN_SCAN 5 /* No usable constraint */
  180103. #define FTS5_PLAN_ROWID 6 /* (rowid = ?) */
  180104. /*
  180105. ** Set the SQLITE_INDEX_SCAN_UNIQUE flag in pIdxInfo->flags. Unless this
  180106. ** extension is currently being used by a version of SQLite too old to
  180107. ** support index-info flags. In that case this function is a no-op.
  180108. */
  180109. static void fts5SetUniqueFlag(sqlite3_index_info *pIdxInfo){
  180110. #if SQLITE_VERSION_NUMBER>=3008012
  180111. #ifndef SQLITE_CORE
  180112. if( sqlite3_libversion_number()>=3008012 )
  180113. #endif
  180114. {
  180115. pIdxInfo->idxFlags |= SQLITE_INDEX_SCAN_UNIQUE;
  180116. }
  180117. #endif
  180118. }
  180119. /*
  180120. ** Implementation of the xBestIndex method for FTS5 tables. Within the
  180121. ** WHERE constraint, it searches for the following:
  180122. **
  180123. ** 1. A MATCH constraint against the special column.
  180124. ** 2. A MATCH constraint against the "rank" column.
  180125. ** 3. An == constraint against the rowid column.
  180126. ** 4. A < or <= constraint against the rowid column.
  180127. ** 5. A > or >= constraint against the rowid column.
  180128. **
  180129. ** Within the ORDER BY, either:
  180130. **
  180131. ** 5. ORDER BY rank [ASC|DESC]
  180132. ** 6. ORDER BY rowid [ASC|DESC]
  180133. **
  180134. ** Costs are assigned as follows:
  180135. **
  180136. ** a) If an unusable MATCH operator is present in the WHERE clause, the
  180137. ** cost is unconditionally set to 1e50 (a really big number).
  180138. **
  180139. ** a) If a MATCH operator is present, the cost depends on the other
  180140. ** constraints also present. As follows:
  180141. **
  180142. ** * No other constraints: cost=1000.0
  180143. ** * One rowid range constraint: cost=750.0
  180144. ** * Both rowid range constraints: cost=500.0
  180145. ** * An == rowid constraint: cost=100.0
  180146. **
  180147. ** b) Otherwise, if there is no MATCH:
  180148. **
  180149. ** * No other constraints: cost=1000000.0
  180150. ** * One rowid range constraint: cost=750000.0
  180151. ** * Both rowid range constraints: cost=250000.0
  180152. ** * An == rowid constraint: cost=10.0
  180153. **
  180154. ** Costs are not modified by the ORDER BY clause.
  180155. */
  180156. static int fts5BestIndexMethod(sqlite3_vtab *pVTab, sqlite3_index_info *pInfo){
  180157. Fts5Table *pTab = (Fts5Table*)pVTab;
  180158. Fts5Config *pConfig = pTab->pConfig;
  180159. int idxFlags = 0; /* Parameter passed through to xFilter() */
  180160. int bHasMatch;
  180161. int iNext;
  180162. int i;
  180163. struct Constraint {
  180164. int op; /* Mask against sqlite3_index_constraint.op */
  180165. int fts5op; /* FTS5 mask for idxFlags */
  180166. int iCol; /* 0==rowid, 1==tbl, 2==rank */
  180167. int omit; /* True to omit this if found */
  180168. int iConsIndex; /* Index in pInfo->aConstraint[] */
  180169. } aConstraint[] = {
  180170. {SQLITE_INDEX_CONSTRAINT_MATCH|SQLITE_INDEX_CONSTRAINT_EQ,
  180171. FTS5_BI_MATCH, 1, 1, -1},
  180172. {SQLITE_INDEX_CONSTRAINT_MATCH|SQLITE_INDEX_CONSTRAINT_EQ,
  180173. FTS5_BI_RANK, 2, 1, -1},
  180174. {SQLITE_INDEX_CONSTRAINT_EQ, FTS5_BI_ROWID_EQ, 0, 0, -1},
  180175. {SQLITE_INDEX_CONSTRAINT_LT|SQLITE_INDEX_CONSTRAINT_LE,
  180176. FTS5_BI_ROWID_LE, 0, 0, -1},
  180177. {SQLITE_INDEX_CONSTRAINT_GT|SQLITE_INDEX_CONSTRAINT_GE,
  180178. FTS5_BI_ROWID_GE, 0, 0, -1},
  180179. };
  180180. int aColMap[3];
  180181. aColMap[0] = -1;
  180182. aColMap[1] = pConfig->nCol;
  180183. aColMap[2] = pConfig->nCol+1;
  180184. /* Set idxFlags flags for all WHERE clause terms that will be used. */
  180185. for(i=0; i<pInfo->nConstraint; i++){
  180186. struct sqlite3_index_constraint *p = &pInfo->aConstraint[i];
  180187. int j;
  180188. for(j=0; j<ArraySize(aConstraint); j++){
  180189. struct Constraint *pC = &aConstraint[j];
  180190. if( p->iColumn==aColMap[pC->iCol] && p->op & pC->op ){
  180191. if( p->usable ){
  180192. pC->iConsIndex = i;
  180193. idxFlags |= pC->fts5op;
  180194. }else if( j==0 ){
  180195. /* As there exists an unusable MATCH constraint this is an
  180196. ** unusable plan. Set a prohibitively high cost. */
  180197. pInfo->estimatedCost = 1e50;
  180198. return SQLITE_OK;
  180199. }
  180200. }
  180201. }
  180202. }
  180203. /* Set idxFlags flags for the ORDER BY clause */
  180204. if( pInfo->nOrderBy==1 ){
  180205. int iSort = pInfo->aOrderBy[0].iColumn;
  180206. if( iSort==(pConfig->nCol+1) && BitFlagTest(idxFlags, FTS5_BI_MATCH) ){
  180207. idxFlags |= FTS5_BI_ORDER_RANK;
  180208. }else if( iSort==-1 ){
  180209. idxFlags |= FTS5_BI_ORDER_ROWID;
  180210. }
  180211. if( BitFlagTest(idxFlags, FTS5_BI_ORDER_RANK|FTS5_BI_ORDER_ROWID) ){
  180212. pInfo->orderByConsumed = 1;
  180213. if( pInfo->aOrderBy[0].desc ){
  180214. idxFlags |= FTS5_BI_ORDER_DESC;
  180215. }
  180216. }
  180217. }
  180218. /* Calculate the estimated cost based on the flags set in idxFlags. */
  180219. bHasMatch = BitFlagTest(idxFlags, FTS5_BI_MATCH);
  180220. if( BitFlagTest(idxFlags, FTS5_BI_ROWID_EQ) ){
  180221. pInfo->estimatedCost = bHasMatch ? 100.0 : 10.0;
  180222. if( bHasMatch==0 ) fts5SetUniqueFlag(pInfo);
  180223. }else if( BitFlagAllTest(idxFlags, FTS5_BI_ROWID_LE|FTS5_BI_ROWID_GE) ){
  180224. pInfo->estimatedCost = bHasMatch ? 500.0 : 250000.0;
  180225. }else if( BitFlagTest(idxFlags, FTS5_BI_ROWID_LE|FTS5_BI_ROWID_GE) ){
  180226. pInfo->estimatedCost = bHasMatch ? 750.0 : 750000.0;
  180227. }else{
  180228. pInfo->estimatedCost = bHasMatch ? 1000.0 : 1000000.0;
  180229. }
  180230. /* Assign argvIndex values to each constraint in use. */
  180231. iNext = 1;
  180232. for(i=0; i<ArraySize(aConstraint); i++){
  180233. struct Constraint *pC = &aConstraint[i];
  180234. if( pC->iConsIndex>=0 ){
  180235. pInfo->aConstraintUsage[pC->iConsIndex].argvIndex = iNext++;
  180236. pInfo->aConstraintUsage[pC->iConsIndex].omit = (unsigned char)pC->omit;
  180237. }
  180238. }
  180239. pInfo->idxNum = idxFlags;
  180240. return SQLITE_OK;
  180241. }
  180242. static int fts5NewTransaction(Fts5Table *pTab){
  180243. Fts5Cursor *pCsr;
  180244. for(pCsr=pTab->pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  180245. if( pCsr->base.pVtab==(sqlite3_vtab*)pTab ) return SQLITE_OK;
  180246. }
  180247. return sqlite3Fts5StorageReset(pTab->pStorage);
  180248. }
  180249. /*
  180250. ** Implementation of xOpen method.
  180251. */
  180252. static int fts5OpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  180253. Fts5Table *pTab = (Fts5Table*)pVTab;
  180254. Fts5Config *pConfig = pTab->pConfig;
  180255. Fts5Cursor *pCsr = 0; /* New cursor object */
  180256. int nByte; /* Bytes of space to allocate */
  180257. int rc; /* Return code */
  180258. rc = fts5NewTransaction(pTab);
  180259. if( rc==SQLITE_OK ){
  180260. nByte = sizeof(Fts5Cursor) + pConfig->nCol * sizeof(int);
  180261. pCsr = (Fts5Cursor*)sqlite3_malloc(nByte);
  180262. if( pCsr ){
  180263. Fts5Global *pGlobal = pTab->pGlobal;
  180264. memset(pCsr, 0, nByte);
  180265. pCsr->aColumnSize = (int*)&pCsr[1];
  180266. pCsr->pNext = pGlobal->pCsr;
  180267. pGlobal->pCsr = pCsr;
  180268. pCsr->iCsrId = ++pGlobal->iNextId;
  180269. }else{
  180270. rc = SQLITE_NOMEM;
  180271. }
  180272. }
  180273. *ppCsr = (sqlite3_vtab_cursor*)pCsr;
  180274. return rc;
  180275. }
  180276. static int fts5StmtType(Fts5Cursor *pCsr){
  180277. if( pCsr->ePlan==FTS5_PLAN_SCAN ){
  180278. return (pCsr->bDesc) ? FTS5_STMT_SCAN_DESC : FTS5_STMT_SCAN_ASC;
  180279. }
  180280. return FTS5_STMT_LOOKUP;
  180281. }
  180282. /*
  180283. ** This function is called after the cursor passed as the only argument
  180284. ** is moved to point at a different row. It clears all cached data
  180285. ** specific to the previous row stored by the cursor object.
  180286. */
  180287. static void fts5CsrNewrow(Fts5Cursor *pCsr){
  180288. CsrFlagSet(pCsr,
  180289. FTS5CSR_REQUIRE_CONTENT
  180290. | FTS5CSR_REQUIRE_DOCSIZE
  180291. | FTS5CSR_REQUIRE_INST
  180292. | FTS5CSR_REQUIRE_POSLIST
  180293. );
  180294. }
  180295. static void fts5FreeCursorComponents(Fts5Cursor *pCsr){
  180296. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  180297. Fts5Auxdata *pData;
  180298. Fts5Auxdata *pNext;
  180299. sqlite3_free(pCsr->aInstIter);
  180300. sqlite3_free(pCsr->aInst);
  180301. if( pCsr->pStmt ){
  180302. int eStmt = fts5StmtType(pCsr);
  180303. sqlite3Fts5StorageStmtRelease(pTab->pStorage, eStmt, pCsr->pStmt);
  180304. }
  180305. if( pCsr->pSorter ){
  180306. Fts5Sorter *pSorter = pCsr->pSorter;
  180307. sqlite3_finalize(pSorter->pStmt);
  180308. sqlite3_free(pSorter);
  180309. }
  180310. if( pCsr->ePlan!=FTS5_PLAN_SOURCE ){
  180311. sqlite3Fts5ExprFree(pCsr->pExpr);
  180312. }
  180313. for(pData=pCsr->pAuxdata; pData; pData=pNext){
  180314. pNext = pData->pNext;
  180315. if( pData->xDelete ) pData->xDelete(pData->pPtr);
  180316. sqlite3_free(pData);
  180317. }
  180318. sqlite3_finalize(pCsr->pRankArgStmt);
  180319. sqlite3_free(pCsr->apRankArg);
  180320. if( CsrFlagTest(pCsr, FTS5CSR_FREE_ZRANK) ){
  180321. sqlite3_free(pCsr->zRank);
  180322. sqlite3_free(pCsr->zRankArgs);
  180323. }
  180324. memset(&pCsr->ePlan, 0, sizeof(Fts5Cursor) - ((u8*)&pCsr->ePlan - (u8*)pCsr));
  180325. }
  180326. /*
  180327. ** Close the cursor. For additional information see the documentation
  180328. ** on the xClose method of the virtual table interface.
  180329. */
  180330. static int fts5CloseMethod(sqlite3_vtab_cursor *pCursor){
  180331. if( pCursor ){
  180332. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  180333. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  180334. Fts5Cursor **pp;
  180335. fts5FreeCursorComponents(pCsr);
  180336. /* Remove the cursor from the Fts5Global.pCsr list */
  180337. for(pp=&pTab->pGlobal->pCsr; (*pp)!=pCsr; pp=&(*pp)->pNext);
  180338. *pp = pCsr->pNext;
  180339. sqlite3_free(pCsr);
  180340. }
  180341. return SQLITE_OK;
  180342. }
  180343. static int fts5SorterNext(Fts5Cursor *pCsr){
  180344. Fts5Sorter *pSorter = pCsr->pSorter;
  180345. int rc;
  180346. rc = sqlite3_step(pSorter->pStmt);
  180347. if( rc==SQLITE_DONE ){
  180348. rc = SQLITE_OK;
  180349. CsrFlagSet(pCsr, FTS5CSR_EOF);
  180350. }else if( rc==SQLITE_ROW ){
  180351. const u8 *a;
  180352. const u8 *aBlob;
  180353. int nBlob;
  180354. int i;
  180355. int iOff = 0;
  180356. rc = SQLITE_OK;
  180357. pSorter->iRowid = sqlite3_column_int64(pSorter->pStmt, 0);
  180358. nBlob = sqlite3_column_bytes(pSorter->pStmt, 1);
  180359. aBlob = a = sqlite3_column_blob(pSorter->pStmt, 1);
  180360. /* nBlob==0 in detail=none mode. */
  180361. if( nBlob>0 ){
  180362. for(i=0; i<(pSorter->nIdx-1); i++){
  180363. int iVal;
  180364. a += fts5GetVarint32(a, iVal);
  180365. iOff += iVal;
  180366. pSorter->aIdx[i] = iOff;
  180367. }
  180368. pSorter->aIdx[i] = &aBlob[nBlob] - a;
  180369. pSorter->aPoslist = a;
  180370. }
  180371. fts5CsrNewrow(pCsr);
  180372. }
  180373. return rc;
  180374. }
  180375. /*
  180376. ** Set the FTS5CSR_REQUIRE_RESEEK flag on all FTS5_PLAN_MATCH cursors
  180377. ** open on table pTab.
  180378. */
  180379. static void fts5TripCursors(Fts5Table *pTab){
  180380. Fts5Cursor *pCsr;
  180381. for(pCsr=pTab->pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  180382. if( pCsr->ePlan==FTS5_PLAN_MATCH
  180383. && pCsr->base.pVtab==(sqlite3_vtab*)pTab
  180384. ){
  180385. CsrFlagSet(pCsr, FTS5CSR_REQUIRE_RESEEK);
  180386. }
  180387. }
  180388. }
  180389. /*
  180390. ** If the REQUIRE_RESEEK flag is set on the cursor passed as the first
  180391. ** argument, close and reopen all Fts5IndexIter iterators that the cursor
  180392. ** is using. Then attempt to move the cursor to a rowid equal to or laster
  180393. ** (in the cursors sort order - ASC or DESC) than the current rowid.
  180394. **
  180395. ** If the new rowid is not equal to the old, set output parameter *pbSkip
  180396. ** to 1 before returning. Otherwise, leave it unchanged.
  180397. **
  180398. ** Return SQLITE_OK if successful or if no reseek was required, or an
  180399. ** error code if an error occurred.
  180400. */
  180401. static int fts5CursorReseek(Fts5Cursor *pCsr, int *pbSkip){
  180402. int rc = SQLITE_OK;
  180403. assert( *pbSkip==0 );
  180404. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_RESEEK) ){
  180405. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  180406. int bDesc = pCsr->bDesc;
  180407. i64 iRowid = sqlite3Fts5ExprRowid(pCsr->pExpr);
  180408. rc = sqlite3Fts5ExprFirst(pCsr->pExpr, pTab->pIndex, iRowid, bDesc);
  180409. if( rc==SQLITE_OK && iRowid!=sqlite3Fts5ExprRowid(pCsr->pExpr) ){
  180410. *pbSkip = 1;
  180411. }
  180412. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_RESEEK);
  180413. fts5CsrNewrow(pCsr);
  180414. if( sqlite3Fts5ExprEof(pCsr->pExpr) ){
  180415. CsrFlagSet(pCsr, FTS5CSR_EOF);
  180416. *pbSkip = 1;
  180417. }
  180418. }
  180419. return rc;
  180420. }
  180421. /*
  180422. ** Advance the cursor to the next row in the table that matches the
  180423. ** search criteria.
  180424. **
  180425. ** Return SQLITE_OK if nothing goes wrong. SQLITE_OK is returned
  180426. ** even if we reach end-of-file. The fts5EofMethod() will be called
  180427. ** subsequently to determine whether or not an EOF was hit.
  180428. */
  180429. static int fts5NextMethod(sqlite3_vtab_cursor *pCursor){
  180430. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  180431. int rc;
  180432. assert( (pCsr->ePlan<3)==
  180433. (pCsr->ePlan==FTS5_PLAN_MATCH || pCsr->ePlan==FTS5_PLAN_SOURCE)
  180434. );
  180435. assert( !CsrFlagTest(pCsr, FTS5CSR_EOF) );
  180436. if( pCsr->ePlan<3 ){
  180437. int bSkip = 0;
  180438. if( (rc = fts5CursorReseek(pCsr, &bSkip)) || bSkip ) return rc;
  180439. rc = sqlite3Fts5ExprNext(pCsr->pExpr, pCsr->iLastRowid);
  180440. CsrFlagSet(pCsr, sqlite3Fts5ExprEof(pCsr->pExpr));
  180441. fts5CsrNewrow(pCsr);
  180442. }else{
  180443. switch( pCsr->ePlan ){
  180444. case FTS5_PLAN_SPECIAL: {
  180445. CsrFlagSet(pCsr, FTS5CSR_EOF);
  180446. rc = SQLITE_OK;
  180447. break;
  180448. }
  180449. case FTS5_PLAN_SORTED_MATCH: {
  180450. rc = fts5SorterNext(pCsr);
  180451. break;
  180452. }
  180453. default:
  180454. rc = sqlite3_step(pCsr->pStmt);
  180455. if( rc!=SQLITE_ROW ){
  180456. CsrFlagSet(pCsr, FTS5CSR_EOF);
  180457. rc = sqlite3_reset(pCsr->pStmt);
  180458. }else{
  180459. rc = SQLITE_OK;
  180460. }
  180461. break;
  180462. }
  180463. }
  180464. return rc;
  180465. }
  180466. static int fts5PrepareStatement(
  180467. sqlite3_stmt **ppStmt,
  180468. Fts5Config *pConfig,
  180469. const char *zFmt,
  180470. ...
  180471. ){
  180472. sqlite3_stmt *pRet = 0;
  180473. int rc;
  180474. char *zSql;
  180475. va_list ap;
  180476. va_start(ap, zFmt);
  180477. zSql = sqlite3_vmprintf(zFmt, ap);
  180478. if( zSql==0 ){
  180479. rc = SQLITE_NOMEM;
  180480. }else{
  180481. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &pRet, 0);
  180482. if( rc!=SQLITE_OK ){
  180483. *pConfig->pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(pConfig->db));
  180484. }
  180485. sqlite3_free(zSql);
  180486. }
  180487. va_end(ap);
  180488. *ppStmt = pRet;
  180489. return rc;
  180490. }
  180491. static int fts5CursorFirstSorted(Fts5Table *pTab, Fts5Cursor *pCsr, int bDesc){
  180492. Fts5Config *pConfig = pTab->pConfig;
  180493. Fts5Sorter *pSorter;
  180494. int nPhrase;
  180495. int nByte;
  180496. int rc;
  180497. const char *zRank = pCsr->zRank;
  180498. const char *zRankArgs = pCsr->zRankArgs;
  180499. nPhrase = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  180500. nByte = sizeof(Fts5Sorter) + sizeof(int) * (nPhrase-1);
  180501. pSorter = (Fts5Sorter*)sqlite3_malloc(nByte);
  180502. if( pSorter==0 ) return SQLITE_NOMEM;
  180503. memset(pSorter, 0, nByte);
  180504. pSorter->nIdx = nPhrase;
  180505. /* TODO: It would be better to have some system for reusing statement
  180506. ** handles here, rather than preparing a new one for each query. But that
  180507. ** is not possible as SQLite reference counts the virtual table objects.
  180508. ** And since the statement required here reads from this very virtual
  180509. ** table, saving it creates a circular reference.
  180510. **
  180511. ** If SQLite a built-in statement cache, this wouldn't be a problem. */
  180512. rc = fts5PrepareStatement(&pSorter->pStmt, pConfig,
  180513. "SELECT rowid, rank FROM %Q.%Q ORDER BY %s(%s%s%s) %s",
  180514. pConfig->zDb, pConfig->zName, zRank, pConfig->zName,
  180515. (zRankArgs ? ", " : ""),
  180516. (zRankArgs ? zRankArgs : ""),
  180517. bDesc ? "DESC" : "ASC"
  180518. );
  180519. pCsr->pSorter = pSorter;
  180520. if( rc==SQLITE_OK ){
  180521. assert( pTab->pSortCsr==0 );
  180522. pTab->pSortCsr = pCsr;
  180523. rc = fts5SorterNext(pCsr);
  180524. pTab->pSortCsr = 0;
  180525. }
  180526. if( rc!=SQLITE_OK ){
  180527. sqlite3_finalize(pSorter->pStmt);
  180528. sqlite3_free(pSorter);
  180529. pCsr->pSorter = 0;
  180530. }
  180531. return rc;
  180532. }
  180533. static int fts5CursorFirst(Fts5Table *pTab, Fts5Cursor *pCsr, int bDesc){
  180534. int rc;
  180535. Fts5Expr *pExpr = pCsr->pExpr;
  180536. rc = sqlite3Fts5ExprFirst(pExpr, pTab->pIndex, pCsr->iFirstRowid, bDesc);
  180537. if( sqlite3Fts5ExprEof(pExpr) ){
  180538. CsrFlagSet(pCsr, FTS5CSR_EOF);
  180539. }
  180540. fts5CsrNewrow(pCsr);
  180541. return rc;
  180542. }
  180543. /*
  180544. ** Process a "special" query. A special query is identified as one with a
  180545. ** MATCH expression that begins with a '*' character. The remainder of
  180546. ** the text passed to the MATCH operator are used as the special query
  180547. ** parameters.
  180548. */
  180549. static int fts5SpecialMatch(
  180550. Fts5Table *pTab,
  180551. Fts5Cursor *pCsr,
  180552. const char *zQuery
  180553. ){
  180554. int rc = SQLITE_OK; /* Return code */
  180555. const char *z = zQuery; /* Special query text */
  180556. int n; /* Number of bytes in text at z */
  180557. while( z[0]==' ' ) z++;
  180558. for(n=0; z[n] && z[n]!=' '; n++);
  180559. assert( pTab->base.zErrMsg==0 );
  180560. pCsr->ePlan = FTS5_PLAN_SPECIAL;
  180561. if( 0==sqlite3_strnicmp("reads", z, n) ){
  180562. pCsr->iSpecial = sqlite3Fts5IndexReads(pTab->pIndex);
  180563. }
  180564. else if( 0==sqlite3_strnicmp("id", z, n) ){
  180565. pCsr->iSpecial = pCsr->iCsrId;
  180566. }
  180567. else{
  180568. /* An unrecognized directive. Return an error message. */
  180569. pTab->base.zErrMsg = sqlite3_mprintf("unknown special query: %.*s", n, z);
  180570. rc = SQLITE_ERROR;
  180571. }
  180572. return rc;
  180573. }
  180574. /*
  180575. ** Search for an auxiliary function named zName that can be used with table
  180576. ** pTab. If one is found, return a pointer to the corresponding Fts5Auxiliary
  180577. ** structure. Otherwise, if no such function exists, return NULL.
  180578. */
  180579. static Fts5Auxiliary *fts5FindAuxiliary(Fts5Table *pTab, const char *zName){
  180580. Fts5Auxiliary *pAux;
  180581. for(pAux=pTab->pGlobal->pAux; pAux; pAux=pAux->pNext){
  180582. if( sqlite3_stricmp(zName, pAux->zFunc)==0 ) return pAux;
  180583. }
  180584. /* No function of the specified name was found. Return 0. */
  180585. return 0;
  180586. }
  180587. static int fts5FindRankFunction(Fts5Cursor *pCsr){
  180588. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  180589. Fts5Config *pConfig = pTab->pConfig;
  180590. int rc = SQLITE_OK;
  180591. Fts5Auxiliary *pAux = 0;
  180592. const char *zRank = pCsr->zRank;
  180593. const char *zRankArgs = pCsr->zRankArgs;
  180594. if( zRankArgs ){
  180595. char *zSql = sqlite3Fts5Mprintf(&rc, "SELECT %s", zRankArgs);
  180596. if( zSql ){
  180597. sqlite3_stmt *pStmt = 0;
  180598. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &pStmt, 0);
  180599. sqlite3_free(zSql);
  180600. assert( rc==SQLITE_OK || pCsr->pRankArgStmt==0 );
  180601. if( rc==SQLITE_OK ){
  180602. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  180603. int nByte;
  180604. pCsr->nRankArg = sqlite3_column_count(pStmt);
  180605. nByte = sizeof(sqlite3_value*)*pCsr->nRankArg;
  180606. pCsr->apRankArg = (sqlite3_value**)sqlite3Fts5MallocZero(&rc, nByte);
  180607. if( rc==SQLITE_OK ){
  180608. int i;
  180609. for(i=0; i<pCsr->nRankArg; i++){
  180610. pCsr->apRankArg[i] = sqlite3_column_value(pStmt, i);
  180611. }
  180612. }
  180613. pCsr->pRankArgStmt = pStmt;
  180614. }else{
  180615. rc = sqlite3_finalize(pStmt);
  180616. assert( rc!=SQLITE_OK );
  180617. }
  180618. }
  180619. }
  180620. }
  180621. if( rc==SQLITE_OK ){
  180622. pAux = fts5FindAuxiliary(pTab, zRank);
  180623. if( pAux==0 ){
  180624. assert( pTab->base.zErrMsg==0 );
  180625. pTab->base.zErrMsg = sqlite3_mprintf("no such function: %s", zRank);
  180626. rc = SQLITE_ERROR;
  180627. }
  180628. }
  180629. pCsr->pRank = pAux;
  180630. return rc;
  180631. }
  180632. static int fts5CursorParseRank(
  180633. Fts5Config *pConfig,
  180634. Fts5Cursor *pCsr,
  180635. sqlite3_value *pRank
  180636. ){
  180637. int rc = SQLITE_OK;
  180638. if( pRank ){
  180639. const char *z = (const char*)sqlite3_value_text(pRank);
  180640. char *zRank = 0;
  180641. char *zRankArgs = 0;
  180642. if( z==0 ){
  180643. if( sqlite3_value_type(pRank)==SQLITE_NULL ) rc = SQLITE_ERROR;
  180644. }else{
  180645. rc = sqlite3Fts5ConfigParseRank(z, &zRank, &zRankArgs);
  180646. }
  180647. if( rc==SQLITE_OK ){
  180648. pCsr->zRank = zRank;
  180649. pCsr->zRankArgs = zRankArgs;
  180650. CsrFlagSet(pCsr, FTS5CSR_FREE_ZRANK);
  180651. }else if( rc==SQLITE_ERROR ){
  180652. pCsr->base.pVtab->zErrMsg = sqlite3_mprintf(
  180653. "parse error in rank function: %s", z
  180654. );
  180655. }
  180656. }else{
  180657. if( pConfig->zRank ){
  180658. pCsr->zRank = (char*)pConfig->zRank;
  180659. pCsr->zRankArgs = (char*)pConfig->zRankArgs;
  180660. }else{
  180661. pCsr->zRank = (char*)FTS5_DEFAULT_RANK;
  180662. pCsr->zRankArgs = 0;
  180663. }
  180664. }
  180665. return rc;
  180666. }
  180667. static i64 fts5GetRowidLimit(sqlite3_value *pVal, i64 iDefault){
  180668. if( pVal ){
  180669. int eType = sqlite3_value_numeric_type(pVal);
  180670. if( eType==SQLITE_INTEGER ){
  180671. return sqlite3_value_int64(pVal);
  180672. }
  180673. }
  180674. return iDefault;
  180675. }
  180676. /*
  180677. ** This is the xFilter interface for the virtual table. See
  180678. ** the virtual table xFilter method documentation for additional
  180679. ** information.
  180680. **
  180681. ** There are three possible query strategies:
  180682. **
  180683. ** 1. Full-text search using a MATCH operator.
  180684. ** 2. A by-rowid lookup.
  180685. ** 3. A full-table scan.
  180686. */
  180687. static int fts5FilterMethod(
  180688. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  180689. int idxNum, /* Strategy index */
  180690. const char *zUnused, /* Unused */
  180691. int nVal, /* Number of elements in apVal */
  180692. sqlite3_value **apVal /* Arguments for the indexing scheme */
  180693. ){
  180694. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  180695. Fts5Config *pConfig = pTab->pConfig;
  180696. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  180697. int rc = SQLITE_OK; /* Error code */
  180698. int iVal = 0; /* Counter for apVal[] */
  180699. int bDesc; /* True if ORDER BY [rank|rowid] DESC */
  180700. int bOrderByRank; /* True if ORDER BY rank */
  180701. sqlite3_value *pMatch = 0; /* <tbl> MATCH ? expression (or NULL) */
  180702. sqlite3_value *pRank = 0; /* rank MATCH ? expression (or NULL) */
  180703. sqlite3_value *pRowidEq = 0; /* rowid = ? expression (or NULL) */
  180704. sqlite3_value *pRowidLe = 0; /* rowid <= ? expression (or NULL) */
  180705. sqlite3_value *pRowidGe = 0; /* rowid >= ? expression (or NULL) */
  180706. char **pzErrmsg = pConfig->pzErrmsg;
  180707. UNUSED_PARAM(zUnused);
  180708. UNUSED_PARAM(nVal);
  180709. if( pCsr->ePlan ){
  180710. fts5FreeCursorComponents(pCsr);
  180711. memset(&pCsr->ePlan, 0, sizeof(Fts5Cursor) - ((u8*)&pCsr->ePlan-(u8*)pCsr));
  180712. }
  180713. assert( pCsr->pStmt==0 );
  180714. assert( pCsr->pExpr==0 );
  180715. assert( pCsr->csrflags==0 );
  180716. assert( pCsr->pRank==0 );
  180717. assert( pCsr->zRank==0 );
  180718. assert( pCsr->zRankArgs==0 );
  180719. assert( pzErrmsg==0 || pzErrmsg==&pTab->base.zErrMsg );
  180720. pConfig->pzErrmsg = &pTab->base.zErrMsg;
  180721. /* Decode the arguments passed through to this function.
  180722. **
  180723. ** Note: The following set of if(...) statements must be in the same
  180724. ** order as the corresponding entries in the struct at the top of
  180725. ** fts5BestIndexMethod(). */
  180726. if( BitFlagTest(idxNum, FTS5_BI_MATCH) ) pMatch = apVal[iVal++];
  180727. if( BitFlagTest(idxNum, FTS5_BI_RANK) ) pRank = apVal[iVal++];
  180728. if( BitFlagTest(idxNum, FTS5_BI_ROWID_EQ) ) pRowidEq = apVal[iVal++];
  180729. if( BitFlagTest(idxNum, FTS5_BI_ROWID_LE) ) pRowidLe = apVal[iVal++];
  180730. if( BitFlagTest(idxNum, FTS5_BI_ROWID_GE) ) pRowidGe = apVal[iVal++];
  180731. assert( iVal==nVal );
  180732. bOrderByRank = ((idxNum & FTS5_BI_ORDER_RANK) ? 1 : 0);
  180733. pCsr->bDesc = bDesc = ((idxNum & FTS5_BI_ORDER_DESC) ? 1 : 0);
  180734. /* Set the cursor upper and lower rowid limits. Only some strategies
  180735. ** actually use them. This is ok, as the xBestIndex() method leaves the
  180736. ** sqlite3_index_constraint.omit flag clear for range constraints
  180737. ** on the rowid field. */
  180738. if( pRowidEq ){
  180739. pRowidLe = pRowidGe = pRowidEq;
  180740. }
  180741. if( bDesc ){
  180742. pCsr->iFirstRowid = fts5GetRowidLimit(pRowidLe, LARGEST_INT64);
  180743. pCsr->iLastRowid = fts5GetRowidLimit(pRowidGe, SMALLEST_INT64);
  180744. }else{
  180745. pCsr->iLastRowid = fts5GetRowidLimit(pRowidLe, LARGEST_INT64);
  180746. pCsr->iFirstRowid = fts5GetRowidLimit(pRowidGe, SMALLEST_INT64);
  180747. }
  180748. if( pTab->pSortCsr ){
  180749. /* If pSortCsr is non-NULL, then this call is being made as part of
  180750. ** processing for a "... MATCH <expr> ORDER BY rank" query (ePlan is
  180751. ** set to FTS5_PLAN_SORTED_MATCH). pSortCsr is the cursor that will
  180752. ** return results to the user for this query. The current cursor
  180753. ** (pCursor) is used to execute the query issued by function
  180754. ** fts5CursorFirstSorted() above. */
  180755. assert( pRowidEq==0 && pRowidLe==0 && pRowidGe==0 && pRank==0 );
  180756. assert( nVal==0 && pMatch==0 && bOrderByRank==0 && bDesc==0 );
  180757. assert( pCsr->iLastRowid==LARGEST_INT64 );
  180758. assert( pCsr->iFirstRowid==SMALLEST_INT64 );
  180759. pCsr->ePlan = FTS5_PLAN_SOURCE;
  180760. pCsr->pExpr = pTab->pSortCsr->pExpr;
  180761. rc = fts5CursorFirst(pTab, pCsr, bDesc);
  180762. }else if( pMatch ){
  180763. const char *zExpr = (const char*)sqlite3_value_text(apVal[0]);
  180764. if( zExpr==0 ) zExpr = "";
  180765. rc = fts5CursorParseRank(pConfig, pCsr, pRank);
  180766. if( rc==SQLITE_OK ){
  180767. if( zExpr[0]=='*' ){
  180768. /* The user has issued a query of the form "MATCH '*...'". This
  180769. ** indicates that the MATCH expression is not a full text query,
  180770. ** but a request for an internal parameter. */
  180771. rc = fts5SpecialMatch(pTab, pCsr, &zExpr[1]);
  180772. }else{
  180773. char **pzErr = &pTab->base.zErrMsg;
  180774. rc = sqlite3Fts5ExprNew(pConfig, zExpr, &pCsr->pExpr, pzErr);
  180775. if( rc==SQLITE_OK ){
  180776. if( bOrderByRank ){
  180777. pCsr->ePlan = FTS5_PLAN_SORTED_MATCH;
  180778. rc = fts5CursorFirstSorted(pTab, pCsr, bDesc);
  180779. }else{
  180780. pCsr->ePlan = FTS5_PLAN_MATCH;
  180781. rc = fts5CursorFirst(pTab, pCsr, bDesc);
  180782. }
  180783. }
  180784. }
  180785. }
  180786. }else if( pConfig->zContent==0 ){
  180787. *pConfig->pzErrmsg = sqlite3_mprintf(
  180788. "%s: table does not support scanning", pConfig->zName
  180789. );
  180790. rc = SQLITE_ERROR;
  180791. }else{
  180792. /* This is either a full-table scan (ePlan==FTS5_PLAN_SCAN) or a lookup
  180793. ** by rowid (ePlan==FTS5_PLAN_ROWID). */
  180794. pCsr->ePlan = (pRowidEq ? FTS5_PLAN_ROWID : FTS5_PLAN_SCAN);
  180795. rc = sqlite3Fts5StorageStmt(
  180796. pTab->pStorage, fts5StmtType(pCsr), &pCsr->pStmt, &pTab->base.zErrMsg
  180797. );
  180798. if( rc==SQLITE_OK ){
  180799. if( pCsr->ePlan==FTS5_PLAN_ROWID ){
  180800. sqlite3_bind_value(pCsr->pStmt, 1, apVal[0]);
  180801. }else{
  180802. sqlite3_bind_int64(pCsr->pStmt, 1, pCsr->iFirstRowid);
  180803. sqlite3_bind_int64(pCsr->pStmt, 2, pCsr->iLastRowid);
  180804. }
  180805. rc = fts5NextMethod(pCursor);
  180806. }
  180807. }
  180808. pConfig->pzErrmsg = pzErrmsg;
  180809. return rc;
  180810. }
  180811. /*
  180812. ** This is the xEof method of the virtual table. SQLite calls this
  180813. ** routine to find out if it has reached the end of a result set.
  180814. */
  180815. static int fts5EofMethod(sqlite3_vtab_cursor *pCursor){
  180816. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  180817. return (CsrFlagTest(pCsr, FTS5CSR_EOF) ? 1 : 0);
  180818. }
  180819. /*
  180820. ** Return the rowid that the cursor currently points to.
  180821. */
  180822. static i64 fts5CursorRowid(Fts5Cursor *pCsr){
  180823. assert( pCsr->ePlan==FTS5_PLAN_MATCH
  180824. || pCsr->ePlan==FTS5_PLAN_SORTED_MATCH
  180825. || pCsr->ePlan==FTS5_PLAN_SOURCE
  180826. );
  180827. if( pCsr->pSorter ){
  180828. return pCsr->pSorter->iRowid;
  180829. }else{
  180830. return sqlite3Fts5ExprRowid(pCsr->pExpr);
  180831. }
  180832. }
  180833. /*
  180834. ** This is the xRowid method. The SQLite core calls this routine to
  180835. ** retrieve the rowid for the current row of the result set. fts5
  180836. ** exposes %_content.rowid as the rowid for the virtual table. The
  180837. ** rowid should be written to *pRowid.
  180838. */
  180839. static int fts5RowidMethod(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  180840. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  180841. int ePlan = pCsr->ePlan;
  180842. assert( CsrFlagTest(pCsr, FTS5CSR_EOF)==0 );
  180843. switch( ePlan ){
  180844. case FTS5_PLAN_SPECIAL:
  180845. *pRowid = 0;
  180846. break;
  180847. case FTS5_PLAN_SOURCE:
  180848. case FTS5_PLAN_MATCH:
  180849. case FTS5_PLAN_SORTED_MATCH:
  180850. *pRowid = fts5CursorRowid(pCsr);
  180851. break;
  180852. default:
  180853. *pRowid = sqlite3_column_int64(pCsr->pStmt, 0);
  180854. break;
  180855. }
  180856. return SQLITE_OK;
  180857. }
  180858. /*
  180859. ** If the cursor requires seeking (bSeekRequired flag is set), seek it.
  180860. ** Return SQLITE_OK if no error occurs, or an SQLite error code otherwise.
  180861. **
  180862. ** If argument bErrormsg is true and an error occurs, an error message may
  180863. ** be left in sqlite3_vtab.zErrMsg.
  180864. */
  180865. static int fts5SeekCursor(Fts5Cursor *pCsr, int bErrormsg){
  180866. int rc = SQLITE_OK;
  180867. /* If the cursor does not yet have a statement handle, obtain one now. */
  180868. if( pCsr->pStmt==0 ){
  180869. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  180870. int eStmt = fts5StmtType(pCsr);
  180871. rc = sqlite3Fts5StorageStmt(
  180872. pTab->pStorage, eStmt, &pCsr->pStmt, (bErrormsg?&pTab->base.zErrMsg:0)
  180873. );
  180874. assert( rc!=SQLITE_OK || pTab->base.zErrMsg==0 );
  180875. assert( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_CONTENT) );
  180876. }
  180877. if( rc==SQLITE_OK && CsrFlagTest(pCsr, FTS5CSR_REQUIRE_CONTENT) ){
  180878. assert( pCsr->pExpr );
  180879. sqlite3_reset(pCsr->pStmt);
  180880. sqlite3_bind_int64(pCsr->pStmt, 1, fts5CursorRowid(pCsr));
  180881. rc = sqlite3_step(pCsr->pStmt);
  180882. if( rc==SQLITE_ROW ){
  180883. rc = SQLITE_OK;
  180884. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_CONTENT);
  180885. }else{
  180886. rc = sqlite3_reset(pCsr->pStmt);
  180887. if( rc==SQLITE_OK ){
  180888. rc = FTS5_CORRUPT;
  180889. }
  180890. }
  180891. }
  180892. return rc;
  180893. }
  180894. static void fts5SetVtabError(Fts5Table *p, const char *zFormat, ...){
  180895. va_list ap; /* ... printf arguments */
  180896. va_start(ap, zFormat);
  180897. assert( p->base.zErrMsg==0 );
  180898. p->base.zErrMsg = sqlite3_vmprintf(zFormat, ap);
  180899. va_end(ap);
  180900. }
  180901. /*
  180902. ** This function is called to handle an FTS INSERT command. In other words,
  180903. ** an INSERT statement of the form:
  180904. **
  180905. ** INSERT INTO fts(fts) VALUES($pCmd)
  180906. ** INSERT INTO fts(fts, rank) VALUES($pCmd, $pVal)
  180907. **
  180908. ** Argument pVal is the value assigned to column "fts" by the INSERT
  180909. ** statement. This function returns SQLITE_OK if successful, or an SQLite
  180910. ** error code if an error occurs.
  180911. **
  180912. ** The commands implemented by this function are documented in the "Special
  180913. ** INSERT Directives" section of the documentation. It should be updated if
  180914. ** more commands are added to this function.
  180915. */
  180916. static int fts5SpecialInsert(
  180917. Fts5Table *pTab, /* Fts5 table object */
  180918. const char *zCmd, /* Text inserted into table-name column */
  180919. sqlite3_value *pVal /* Value inserted into rank column */
  180920. ){
  180921. Fts5Config *pConfig = pTab->pConfig;
  180922. int rc = SQLITE_OK;
  180923. int bError = 0;
  180924. if( 0==sqlite3_stricmp("delete-all", zCmd) ){
  180925. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  180926. fts5SetVtabError(pTab,
  180927. "'delete-all' may only be used with a "
  180928. "contentless or external content fts5 table"
  180929. );
  180930. rc = SQLITE_ERROR;
  180931. }else{
  180932. rc = sqlite3Fts5StorageDeleteAll(pTab->pStorage);
  180933. }
  180934. }else if( 0==sqlite3_stricmp("rebuild", zCmd) ){
  180935. if( pConfig->eContent==FTS5_CONTENT_NONE ){
  180936. fts5SetVtabError(pTab,
  180937. "'rebuild' may not be used with a contentless fts5 table"
  180938. );
  180939. rc = SQLITE_ERROR;
  180940. }else{
  180941. rc = sqlite3Fts5StorageRebuild(pTab->pStorage);
  180942. }
  180943. }else if( 0==sqlite3_stricmp("optimize", zCmd) ){
  180944. rc = sqlite3Fts5StorageOptimize(pTab->pStorage);
  180945. }else if( 0==sqlite3_stricmp("merge", zCmd) ){
  180946. int nMerge = sqlite3_value_int(pVal);
  180947. rc = sqlite3Fts5StorageMerge(pTab->pStorage, nMerge);
  180948. }else if( 0==sqlite3_stricmp("integrity-check", zCmd) ){
  180949. rc = sqlite3Fts5StorageIntegrity(pTab->pStorage);
  180950. #ifdef SQLITE_DEBUG
  180951. }else if( 0==sqlite3_stricmp("prefix-index", zCmd) ){
  180952. pConfig->bPrefixIndex = sqlite3_value_int(pVal);
  180953. #endif
  180954. }else{
  180955. rc = sqlite3Fts5IndexLoadConfig(pTab->pIndex);
  180956. if( rc==SQLITE_OK ){
  180957. rc = sqlite3Fts5ConfigSetValue(pTab->pConfig, zCmd, pVal, &bError);
  180958. }
  180959. if( rc==SQLITE_OK ){
  180960. if( bError ){
  180961. rc = SQLITE_ERROR;
  180962. }else{
  180963. rc = sqlite3Fts5StorageConfigValue(pTab->pStorage, zCmd, pVal, 0);
  180964. }
  180965. }
  180966. }
  180967. return rc;
  180968. }
  180969. static int fts5SpecialDelete(
  180970. Fts5Table *pTab,
  180971. sqlite3_value **apVal
  180972. ){
  180973. int rc = SQLITE_OK;
  180974. int eType1 = sqlite3_value_type(apVal[1]);
  180975. if( eType1==SQLITE_INTEGER ){
  180976. sqlite3_int64 iDel = sqlite3_value_int64(apVal[1]);
  180977. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iDel, &apVal[2]);
  180978. }
  180979. return rc;
  180980. }
  180981. static void fts5StorageInsert(
  180982. int *pRc,
  180983. Fts5Table *pTab,
  180984. sqlite3_value **apVal,
  180985. i64 *piRowid
  180986. ){
  180987. int rc = *pRc;
  180988. if( rc==SQLITE_OK ){
  180989. rc = sqlite3Fts5StorageContentInsert(pTab->pStorage, apVal, piRowid);
  180990. }
  180991. if( rc==SQLITE_OK ){
  180992. rc = sqlite3Fts5StorageIndexInsert(pTab->pStorage, apVal, *piRowid);
  180993. }
  180994. *pRc = rc;
  180995. }
  180996. /*
  180997. ** This function is the implementation of the xUpdate callback used by
  180998. ** FTS3 virtual tables. It is invoked by SQLite each time a row is to be
  180999. ** inserted, updated or deleted.
  181000. **
  181001. ** A delete specifies a single argument - the rowid of the row to remove.
  181002. **
  181003. ** Update and insert operations pass:
  181004. **
  181005. ** 1. The "old" rowid, or NULL.
  181006. ** 2. The "new" rowid.
  181007. ** 3. Values for each of the nCol matchable columns.
  181008. ** 4. Values for the two hidden columns (<tablename> and "rank").
  181009. */
  181010. static int fts5UpdateMethod(
  181011. sqlite3_vtab *pVtab, /* Virtual table handle */
  181012. int nArg, /* Size of argument array */
  181013. sqlite3_value **apVal, /* Array of arguments */
  181014. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  181015. ){
  181016. Fts5Table *pTab = (Fts5Table*)pVtab;
  181017. Fts5Config *pConfig = pTab->pConfig;
  181018. int eType0; /* value_type() of apVal[0] */
  181019. int rc = SQLITE_OK; /* Return code */
  181020. /* A transaction must be open when this is called. */
  181021. assert( pTab->ts.eState==1 );
  181022. assert( pVtab->zErrMsg==0 );
  181023. assert( nArg==1 || nArg==(2+pConfig->nCol+2) );
  181024. assert( nArg==1
  181025. || sqlite3_value_type(apVal[1])==SQLITE_INTEGER
  181026. || sqlite3_value_type(apVal[1])==SQLITE_NULL
  181027. );
  181028. assert( pTab->pConfig->pzErrmsg==0 );
  181029. pTab->pConfig->pzErrmsg = &pTab->base.zErrMsg;
  181030. /* Put any active cursors into REQUIRE_SEEK state. */
  181031. fts5TripCursors(pTab);
  181032. eType0 = sqlite3_value_type(apVal[0]);
  181033. if( eType0==SQLITE_NULL
  181034. && sqlite3_value_type(apVal[2+pConfig->nCol])!=SQLITE_NULL
  181035. ){
  181036. /* A "special" INSERT op. These are handled separately. */
  181037. const char *z = (const char*)sqlite3_value_text(apVal[2+pConfig->nCol]);
  181038. if( pConfig->eContent!=FTS5_CONTENT_NORMAL
  181039. && 0==sqlite3_stricmp("delete", z)
  181040. ){
  181041. rc = fts5SpecialDelete(pTab, apVal);
  181042. }else{
  181043. rc = fts5SpecialInsert(pTab, z, apVal[2 + pConfig->nCol + 1]);
  181044. }
  181045. }else{
  181046. /* A regular INSERT, UPDATE or DELETE statement. The trick here is that
  181047. ** any conflict on the rowid value must be detected before any
  181048. ** modifications are made to the database file. There are 4 cases:
  181049. **
  181050. ** 1) DELETE
  181051. ** 2) UPDATE (rowid not modified)
  181052. ** 3) UPDATE (rowid modified)
  181053. ** 4) INSERT
  181054. **
  181055. ** Cases 3 and 4 may violate the rowid constraint.
  181056. */
  181057. int eConflict = SQLITE_ABORT;
  181058. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  181059. eConflict = sqlite3_vtab_on_conflict(pConfig->db);
  181060. }
  181061. assert( eType0==SQLITE_INTEGER || eType0==SQLITE_NULL );
  181062. assert( nArg!=1 || eType0==SQLITE_INTEGER );
  181063. /* Filter out attempts to run UPDATE or DELETE on contentless tables.
  181064. ** This is not suported. */
  181065. if( eType0==SQLITE_INTEGER && fts5IsContentless(pTab) ){
  181066. pTab->base.zErrMsg = sqlite3_mprintf(
  181067. "cannot %s contentless fts5 table: %s",
  181068. (nArg>1 ? "UPDATE" : "DELETE from"), pConfig->zName
  181069. );
  181070. rc = SQLITE_ERROR;
  181071. }
  181072. /* DELETE */
  181073. else if( nArg==1 ){
  181074. i64 iDel = sqlite3_value_int64(apVal[0]); /* Rowid to delete */
  181075. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iDel, 0);
  181076. }
  181077. /* INSERT */
  181078. else if( eType0!=SQLITE_INTEGER ){
  181079. /* If this is a REPLACE, first remove the current entry (if any) */
  181080. if( eConflict==SQLITE_REPLACE
  181081. && sqlite3_value_type(apVal[1])==SQLITE_INTEGER
  181082. ){
  181083. i64 iNew = sqlite3_value_int64(apVal[1]); /* Rowid to delete */
  181084. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iNew, 0);
  181085. }
  181086. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  181087. }
  181088. /* UPDATE */
  181089. else{
  181090. i64 iOld = sqlite3_value_int64(apVal[0]); /* Old rowid */
  181091. i64 iNew = sqlite3_value_int64(apVal[1]); /* New rowid */
  181092. if( iOld!=iNew ){
  181093. if( eConflict==SQLITE_REPLACE ){
  181094. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  181095. if( rc==SQLITE_OK ){
  181096. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iNew, 0);
  181097. }
  181098. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  181099. }else{
  181100. rc = sqlite3Fts5StorageContentInsert(pTab->pStorage, apVal, pRowid);
  181101. if( rc==SQLITE_OK ){
  181102. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  181103. }
  181104. if( rc==SQLITE_OK ){
  181105. rc = sqlite3Fts5StorageIndexInsert(pTab->pStorage, apVal, *pRowid);
  181106. }
  181107. }
  181108. }else{
  181109. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  181110. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  181111. }
  181112. }
  181113. }
  181114. pTab->pConfig->pzErrmsg = 0;
  181115. return rc;
  181116. }
  181117. /*
  181118. ** Implementation of xSync() method.
  181119. */
  181120. static int fts5SyncMethod(sqlite3_vtab *pVtab){
  181121. int rc;
  181122. Fts5Table *pTab = (Fts5Table*)pVtab;
  181123. fts5CheckTransactionState(pTab, FTS5_SYNC, 0);
  181124. pTab->pConfig->pzErrmsg = &pTab->base.zErrMsg;
  181125. fts5TripCursors(pTab);
  181126. rc = sqlite3Fts5StorageSync(pTab->pStorage, 1);
  181127. pTab->pConfig->pzErrmsg = 0;
  181128. return rc;
  181129. }
  181130. /*
  181131. ** Implementation of xBegin() method.
  181132. */
  181133. static int fts5BeginMethod(sqlite3_vtab *pVtab){
  181134. fts5CheckTransactionState((Fts5Table*)pVtab, FTS5_BEGIN, 0);
  181135. fts5NewTransaction((Fts5Table*)pVtab);
  181136. return SQLITE_OK;
  181137. }
  181138. /*
  181139. ** Implementation of xCommit() method. This is a no-op. The contents of
  181140. ** the pending-terms hash-table have already been flushed into the database
  181141. ** by fts5SyncMethod().
  181142. */
  181143. static int fts5CommitMethod(sqlite3_vtab *pVtab){
  181144. UNUSED_PARAM(pVtab); /* Call below is a no-op for NDEBUG builds */
  181145. fts5CheckTransactionState((Fts5Table*)pVtab, FTS5_COMMIT, 0);
  181146. return SQLITE_OK;
  181147. }
  181148. /*
  181149. ** Implementation of xRollback(). Discard the contents of the pending-terms
  181150. ** hash-table. Any changes made to the database are reverted by SQLite.
  181151. */
  181152. static int fts5RollbackMethod(sqlite3_vtab *pVtab){
  181153. int rc;
  181154. Fts5Table *pTab = (Fts5Table*)pVtab;
  181155. fts5CheckTransactionState(pTab, FTS5_ROLLBACK, 0);
  181156. rc = sqlite3Fts5StorageRollback(pTab->pStorage);
  181157. return rc;
  181158. }
  181159. static int fts5CsrPoslist(Fts5Cursor*, int, const u8**, int*);
  181160. static void *fts5ApiUserData(Fts5Context *pCtx){
  181161. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181162. return pCsr->pAux->pUserData;
  181163. }
  181164. static int fts5ApiColumnCount(Fts5Context *pCtx){
  181165. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181166. return ((Fts5Table*)(pCsr->base.pVtab))->pConfig->nCol;
  181167. }
  181168. static int fts5ApiColumnTotalSize(
  181169. Fts5Context *pCtx,
  181170. int iCol,
  181171. sqlite3_int64 *pnToken
  181172. ){
  181173. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181174. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  181175. return sqlite3Fts5StorageSize(pTab->pStorage, iCol, pnToken);
  181176. }
  181177. static int fts5ApiRowCount(Fts5Context *pCtx, i64 *pnRow){
  181178. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181179. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  181180. return sqlite3Fts5StorageRowCount(pTab->pStorage, pnRow);
  181181. }
  181182. static int fts5ApiTokenize(
  181183. Fts5Context *pCtx,
  181184. const char *pText, int nText,
  181185. void *pUserData,
  181186. int (*xToken)(void*, int, const char*, int, int, int)
  181187. ){
  181188. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181189. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  181190. return sqlite3Fts5Tokenize(
  181191. pTab->pConfig, FTS5_TOKENIZE_AUX, pText, nText, pUserData, xToken
  181192. );
  181193. }
  181194. static int fts5ApiPhraseCount(Fts5Context *pCtx){
  181195. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181196. return sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  181197. }
  181198. static int fts5ApiPhraseSize(Fts5Context *pCtx, int iPhrase){
  181199. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181200. return sqlite3Fts5ExprPhraseSize(pCsr->pExpr, iPhrase);
  181201. }
  181202. static int fts5ApiColumnText(
  181203. Fts5Context *pCtx,
  181204. int iCol,
  181205. const char **pz,
  181206. int *pn
  181207. ){
  181208. int rc = SQLITE_OK;
  181209. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181210. if( fts5IsContentless((Fts5Table*)(pCsr->base.pVtab)) ){
  181211. *pz = 0;
  181212. *pn = 0;
  181213. }else{
  181214. rc = fts5SeekCursor(pCsr, 0);
  181215. if( rc==SQLITE_OK ){
  181216. *pz = (const char*)sqlite3_column_text(pCsr->pStmt, iCol+1);
  181217. *pn = sqlite3_column_bytes(pCsr->pStmt, iCol+1);
  181218. }
  181219. }
  181220. return rc;
  181221. }
  181222. static int fts5CsrPoslist(
  181223. Fts5Cursor *pCsr,
  181224. int iPhrase,
  181225. const u8 **pa,
  181226. int *pn
  181227. ){
  181228. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  181229. int rc = SQLITE_OK;
  181230. int bLive = (pCsr->pSorter==0);
  181231. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_POSLIST) ){
  181232. if( pConfig->eDetail!=FTS5_DETAIL_FULL ){
  181233. Fts5PoslistPopulator *aPopulator;
  181234. int i;
  181235. aPopulator = sqlite3Fts5ExprClearPoslists(pCsr->pExpr, bLive);
  181236. if( aPopulator==0 ) rc = SQLITE_NOMEM;
  181237. for(i=0; i<pConfig->nCol && rc==SQLITE_OK; i++){
  181238. int n; const char *z;
  181239. rc = fts5ApiColumnText((Fts5Context*)pCsr, i, &z, &n);
  181240. if( rc==SQLITE_OK ){
  181241. rc = sqlite3Fts5ExprPopulatePoslists(
  181242. pConfig, pCsr->pExpr, aPopulator, i, z, n
  181243. );
  181244. }
  181245. }
  181246. sqlite3_free(aPopulator);
  181247. if( pCsr->pSorter ){
  181248. sqlite3Fts5ExprCheckPoslists(pCsr->pExpr, pCsr->pSorter->iRowid);
  181249. }
  181250. }
  181251. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_POSLIST);
  181252. }
  181253. if( pCsr->pSorter && pConfig->eDetail==FTS5_DETAIL_FULL ){
  181254. Fts5Sorter *pSorter = pCsr->pSorter;
  181255. int i1 = (iPhrase==0 ? 0 : pSorter->aIdx[iPhrase-1]);
  181256. *pn = pSorter->aIdx[iPhrase] - i1;
  181257. *pa = &pSorter->aPoslist[i1];
  181258. }else{
  181259. *pn = sqlite3Fts5ExprPoslist(pCsr->pExpr, iPhrase, pa);
  181260. }
  181261. return rc;
  181262. }
  181263. /*
  181264. ** Ensure that the Fts5Cursor.nInstCount and aInst[] variables are populated
  181265. ** correctly for the current view. Return SQLITE_OK if successful, or an
  181266. ** SQLite error code otherwise.
  181267. */
  181268. static int fts5CacheInstArray(Fts5Cursor *pCsr){
  181269. int rc = SQLITE_OK;
  181270. Fts5PoslistReader *aIter; /* One iterator for each phrase */
  181271. int nIter; /* Number of iterators/phrases */
  181272. nIter = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  181273. if( pCsr->aInstIter==0 ){
  181274. int nByte = sizeof(Fts5PoslistReader) * nIter;
  181275. pCsr->aInstIter = (Fts5PoslistReader*)sqlite3Fts5MallocZero(&rc, nByte);
  181276. }
  181277. aIter = pCsr->aInstIter;
  181278. if( aIter ){
  181279. int nInst = 0; /* Number instances seen so far */
  181280. int i;
  181281. /* Initialize all iterators */
  181282. for(i=0; i<nIter && rc==SQLITE_OK; i++){
  181283. const u8 *a;
  181284. int n;
  181285. rc = fts5CsrPoslist(pCsr, i, &a, &n);
  181286. if( rc==SQLITE_OK ){
  181287. sqlite3Fts5PoslistReaderInit(a, n, &aIter[i]);
  181288. }
  181289. }
  181290. if( rc==SQLITE_OK ){
  181291. while( 1 ){
  181292. int *aInst;
  181293. int iBest = -1;
  181294. for(i=0; i<nIter; i++){
  181295. if( (aIter[i].bEof==0)
  181296. && (iBest<0 || aIter[i].iPos<aIter[iBest].iPos)
  181297. ){
  181298. iBest = i;
  181299. }
  181300. }
  181301. if( iBest<0 ) break;
  181302. nInst++;
  181303. if( nInst>=pCsr->nInstAlloc ){
  181304. pCsr->nInstAlloc = pCsr->nInstAlloc ? pCsr->nInstAlloc*2 : 32;
  181305. aInst = (int*)sqlite3_realloc(
  181306. pCsr->aInst, pCsr->nInstAlloc*sizeof(int)*3
  181307. );
  181308. if( aInst ){
  181309. pCsr->aInst = aInst;
  181310. }else{
  181311. rc = SQLITE_NOMEM;
  181312. break;
  181313. }
  181314. }
  181315. aInst = &pCsr->aInst[3 * (nInst-1)];
  181316. aInst[0] = iBest;
  181317. aInst[1] = FTS5_POS2COLUMN(aIter[iBest].iPos);
  181318. aInst[2] = FTS5_POS2OFFSET(aIter[iBest].iPos);
  181319. sqlite3Fts5PoslistReaderNext(&aIter[iBest]);
  181320. }
  181321. }
  181322. pCsr->nInstCount = nInst;
  181323. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_INST);
  181324. }
  181325. return rc;
  181326. }
  181327. static int fts5ApiInstCount(Fts5Context *pCtx, int *pnInst){
  181328. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181329. int rc = SQLITE_OK;
  181330. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_INST)==0
  181331. || SQLITE_OK==(rc = fts5CacheInstArray(pCsr)) ){
  181332. *pnInst = pCsr->nInstCount;
  181333. }
  181334. return rc;
  181335. }
  181336. static int fts5ApiInst(
  181337. Fts5Context *pCtx,
  181338. int iIdx,
  181339. int *piPhrase,
  181340. int *piCol,
  181341. int *piOff
  181342. ){
  181343. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181344. int rc = SQLITE_OK;
  181345. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_INST)==0
  181346. || SQLITE_OK==(rc = fts5CacheInstArray(pCsr))
  181347. ){
  181348. if( iIdx<0 || iIdx>=pCsr->nInstCount ){
  181349. rc = SQLITE_RANGE;
  181350. #if 0
  181351. }else if( fts5IsOffsetless((Fts5Table*)pCsr->base.pVtab) ){
  181352. *piPhrase = pCsr->aInst[iIdx*3];
  181353. *piCol = pCsr->aInst[iIdx*3 + 2];
  181354. *piOff = -1;
  181355. #endif
  181356. }else{
  181357. *piPhrase = pCsr->aInst[iIdx*3];
  181358. *piCol = pCsr->aInst[iIdx*3 + 1];
  181359. *piOff = pCsr->aInst[iIdx*3 + 2];
  181360. }
  181361. }
  181362. return rc;
  181363. }
  181364. static sqlite3_int64 fts5ApiRowid(Fts5Context *pCtx){
  181365. return fts5CursorRowid((Fts5Cursor*)pCtx);
  181366. }
  181367. static int fts5ColumnSizeCb(
  181368. void *pContext, /* Pointer to int */
  181369. int tflags,
  181370. const char *pUnused, /* Buffer containing token */
  181371. int nUnused, /* Size of token in bytes */
  181372. int iUnused1, /* Start offset of token */
  181373. int iUnused2 /* End offset of token */
  181374. ){
  181375. int *pCnt = (int*)pContext;
  181376. UNUSED_PARAM2(pUnused, nUnused);
  181377. UNUSED_PARAM2(iUnused1, iUnused2);
  181378. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ){
  181379. (*pCnt)++;
  181380. }
  181381. return SQLITE_OK;
  181382. }
  181383. static int fts5ApiColumnSize(Fts5Context *pCtx, int iCol, int *pnToken){
  181384. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181385. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  181386. Fts5Config *pConfig = pTab->pConfig;
  181387. int rc = SQLITE_OK;
  181388. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_DOCSIZE) ){
  181389. if( pConfig->bColumnsize ){
  181390. i64 iRowid = fts5CursorRowid(pCsr);
  181391. rc = sqlite3Fts5StorageDocsize(pTab->pStorage, iRowid, pCsr->aColumnSize);
  181392. }else if( pConfig->zContent==0 ){
  181393. int i;
  181394. for(i=0; i<pConfig->nCol; i++){
  181395. if( pConfig->abUnindexed[i]==0 ){
  181396. pCsr->aColumnSize[i] = -1;
  181397. }
  181398. }
  181399. }else{
  181400. int i;
  181401. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  181402. if( pConfig->abUnindexed[i]==0 ){
  181403. const char *z; int n;
  181404. void *p = (void*)(&pCsr->aColumnSize[i]);
  181405. pCsr->aColumnSize[i] = 0;
  181406. rc = fts5ApiColumnText(pCtx, i, &z, &n);
  181407. if( rc==SQLITE_OK ){
  181408. rc = sqlite3Fts5Tokenize(
  181409. pConfig, FTS5_TOKENIZE_AUX, z, n, p, fts5ColumnSizeCb
  181410. );
  181411. }
  181412. }
  181413. }
  181414. }
  181415. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_DOCSIZE);
  181416. }
  181417. if( iCol<0 ){
  181418. int i;
  181419. *pnToken = 0;
  181420. for(i=0; i<pConfig->nCol; i++){
  181421. *pnToken += pCsr->aColumnSize[i];
  181422. }
  181423. }else if( iCol<pConfig->nCol ){
  181424. *pnToken = pCsr->aColumnSize[iCol];
  181425. }else{
  181426. *pnToken = 0;
  181427. rc = SQLITE_RANGE;
  181428. }
  181429. return rc;
  181430. }
  181431. /*
  181432. ** Implementation of the xSetAuxdata() method.
  181433. */
  181434. static int fts5ApiSetAuxdata(
  181435. Fts5Context *pCtx, /* Fts5 context */
  181436. void *pPtr, /* Pointer to save as auxdata */
  181437. void(*xDelete)(void*) /* Destructor for pPtr (or NULL) */
  181438. ){
  181439. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181440. Fts5Auxdata *pData;
  181441. /* Search through the cursors list of Fts5Auxdata objects for one that
  181442. ** corresponds to the currently executing auxiliary function. */
  181443. for(pData=pCsr->pAuxdata; pData; pData=pData->pNext){
  181444. if( pData->pAux==pCsr->pAux ) break;
  181445. }
  181446. if( pData ){
  181447. if( pData->xDelete ){
  181448. pData->xDelete(pData->pPtr);
  181449. }
  181450. }else{
  181451. int rc = SQLITE_OK;
  181452. pData = (Fts5Auxdata*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Auxdata));
  181453. if( pData==0 ){
  181454. if( xDelete ) xDelete(pPtr);
  181455. return rc;
  181456. }
  181457. pData->pAux = pCsr->pAux;
  181458. pData->pNext = pCsr->pAuxdata;
  181459. pCsr->pAuxdata = pData;
  181460. }
  181461. pData->xDelete = xDelete;
  181462. pData->pPtr = pPtr;
  181463. return SQLITE_OK;
  181464. }
  181465. static void *fts5ApiGetAuxdata(Fts5Context *pCtx, int bClear){
  181466. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181467. Fts5Auxdata *pData;
  181468. void *pRet = 0;
  181469. for(pData=pCsr->pAuxdata; pData; pData=pData->pNext){
  181470. if( pData->pAux==pCsr->pAux ) break;
  181471. }
  181472. if( pData ){
  181473. pRet = pData->pPtr;
  181474. if( bClear ){
  181475. pData->pPtr = 0;
  181476. pData->xDelete = 0;
  181477. }
  181478. }
  181479. return pRet;
  181480. }
  181481. static void fts5ApiPhraseNext(
  181482. Fts5Context *pUnused,
  181483. Fts5PhraseIter *pIter,
  181484. int *piCol, int *piOff
  181485. ){
  181486. UNUSED_PARAM(pUnused);
  181487. if( pIter->a>=pIter->b ){
  181488. *piCol = -1;
  181489. *piOff = -1;
  181490. }else{
  181491. int iVal;
  181492. pIter->a += fts5GetVarint32(pIter->a, iVal);
  181493. if( iVal==1 ){
  181494. pIter->a += fts5GetVarint32(pIter->a, iVal);
  181495. *piCol = iVal;
  181496. *piOff = 0;
  181497. pIter->a += fts5GetVarint32(pIter->a, iVal);
  181498. }
  181499. *piOff += (iVal-2);
  181500. }
  181501. }
  181502. static int fts5ApiPhraseFirst(
  181503. Fts5Context *pCtx,
  181504. int iPhrase,
  181505. Fts5PhraseIter *pIter,
  181506. int *piCol, int *piOff
  181507. ){
  181508. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181509. int n;
  181510. int rc = fts5CsrPoslist(pCsr, iPhrase, &pIter->a, &n);
  181511. if( rc==SQLITE_OK ){
  181512. pIter->b = &pIter->a[n];
  181513. *piCol = 0;
  181514. *piOff = 0;
  181515. fts5ApiPhraseNext(pCtx, pIter, piCol, piOff);
  181516. }
  181517. return rc;
  181518. }
  181519. static void fts5ApiPhraseNextColumn(
  181520. Fts5Context *pCtx,
  181521. Fts5PhraseIter *pIter,
  181522. int *piCol
  181523. ){
  181524. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181525. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  181526. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  181527. if( pIter->a>=pIter->b ){
  181528. *piCol = -1;
  181529. }else{
  181530. int iIncr;
  181531. pIter->a += fts5GetVarint32(&pIter->a[0], iIncr);
  181532. *piCol += (iIncr-2);
  181533. }
  181534. }else{
  181535. while( 1 ){
  181536. int dummy;
  181537. if( pIter->a>=pIter->b ){
  181538. *piCol = -1;
  181539. return;
  181540. }
  181541. if( pIter->a[0]==0x01 ) break;
  181542. pIter->a += fts5GetVarint32(pIter->a, dummy);
  181543. }
  181544. pIter->a += 1 + fts5GetVarint32(&pIter->a[1], *piCol);
  181545. }
  181546. }
  181547. static int fts5ApiPhraseFirstColumn(
  181548. Fts5Context *pCtx,
  181549. int iPhrase,
  181550. Fts5PhraseIter *pIter,
  181551. int *piCol
  181552. ){
  181553. int rc = SQLITE_OK;
  181554. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181555. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  181556. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  181557. Fts5Sorter *pSorter = pCsr->pSorter;
  181558. int n;
  181559. if( pSorter ){
  181560. int i1 = (iPhrase==0 ? 0 : pSorter->aIdx[iPhrase-1]);
  181561. n = pSorter->aIdx[iPhrase] - i1;
  181562. pIter->a = &pSorter->aPoslist[i1];
  181563. }else{
  181564. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, iPhrase, &pIter->a, &n);
  181565. }
  181566. if( rc==SQLITE_OK ){
  181567. pIter->b = &pIter->a[n];
  181568. *piCol = 0;
  181569. fts5ApiPhraseNextColumn(pCtx, pIter, piCol);
  181570. }
  181571. }else{
  181572. int n;
  181573. rc = fts5CsrPoslist(pCsr, iPhrase, &pIter->a, &n);
  181574. if( rc==SQLITE_OK ){
  181575. pIter->b = &pIter->a[n];
  181576. if( n<=0 ){
  181577. *piCol = -1;
  181578. }else if( pIter->a[0]==0x01 ){
  181579. pIter->a += 1 + fts5GetVarint32(&pIter->a[1], *piCol);
  181580. }else{
  181581. *piCol = 0;
  181582. }
  181583. }
  181584. }
  181585. return rc;
  181586. }
  181587. static int fts5ApiQueryPhrase(Fts5Context*, int, void*,
  181588. int(*)(const Fts5ExtensionApi*, Fts5Context*, void*)
  181589. );
  181590. static const Fts5ExtensionApi sFts5Api = {
  181591. 2, /* iVersion */
  181592. fts5ApiUserData,
  181593. fts5ApiColumnCount,
  181594. fts5ApiRowCount,
  181595. fts5ApiColumnTotalSize,
  181596. fts5ApiTokenize,
  181597. fts5ApiPhraseCount,
  181598. fts5ApiPhraseSize,
  181599. fts5ApiInstCount,
  181600. fts5ApiInst,
  181601. fts5ApiRowid,
  181602. fts5ApiColumnText,
  181603. fts5ApiColumnSize,
  181604. fts5ApiQueryPhrase,
  181605. fts5ApiSetAuxdata,
  181606. fts5ApiGetAuxdata,
  181607. fts5ApiPhraseFirst,
  181608. fts5ApiPhraseNext,
  181609. fts5ApiPhraseFirstColumn,
  181610. fts5ApiPhraseNextColumn,
  181611. };
  181612. /*
  181613. ** Implementation of API function xQueryPhrase().
  181614. */
  181615. static int fts5ApiQueryPhrase(
  181616. Fts5Context *pCtx,
  181617. int iPhrase,
  181618. void *pUserData,
  181619. int(*xCallback)(const Fts5ExtensionApi*, Fts5Context*, void*)
  181620. ){
  181621. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  181622. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  181623. int rc;
  181624. Fts5Cursor *pNew = 0;
  181625. rc = fts5OpenMethod(pCsr->base.pVtab, (sqlite3_vtab_cursor**)&pNew);
  181626. if( rc==SQLITE_OK ){
  181627. pNew->ePlan = FTS5_PLAN_MATCH;
  181628. pNew->iFirstRowid = SMALLEST_INT64;
  181629. pNew->iLastRowid = LARGEST_INT64;
  181630. pNew->base.pVtab = (sqlite3_vtab*)pTab;
  181631. rc = sqlite3Fts5ExprClonePhrase(pCsr->pExpr, iPhrase, &pNew->pExpr);
  181632. }
  181633. if( rc==SQLITE_OK ){
  181634. for(rc = fts5CursorFirst(pTab, pNew, 0);
  181635. rc==SQLITE_OK && CsrFlagTest(pNew, FTS5CSR_EOF)==0;
  181636. rc = fts5NextMethod((sqlite3_vtab_cursor*)pNew)
  181637. ){
  181638. rc = xCallback(&sFts5Api, (Fts5Context*)pNew, pUserData);
  181639. if( rc!=SQLITE_OK ){
  181640. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  181641. break;
  181642. }
  181643. }
  181644. }
  181645. fts5CloseMethod((sqlite3_vtab_cursor*)pNew);
  181646. return rc;
  181647. }
  181648. static void fts5ApiInvoke(
  181649. Fts5Auxiliary *pAux,
  181650. Fts5Cursor *pCsr,
  181651. sqlite3_context *context,
  181652. int argc,
  181653. sqlite3_value **argv
  181654. ){
  181655. assert( pCsr->pAux==0 );
  181656. pCsr->pAux = pAux;
  181657. pAux->xFunc(&sFts5Api, (Fts5Context*)pCsr, context, argc, argv);
  181658. pCsr->pAux = 0;
  181659. }
  181660. static Fts5Cursor *fts5CursorFromCsrid(Fts5Global *pGlobal, i64 iCsrId){
  181661. Fts5Cursor *pCsr;
  181662. for(pCsr=pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  181663. if( pCsr->iCsrId==iCsrId ) break;
  181664. }
  181665. return pCsr;
  181666. }
  181667. static void fts5ApiCallback(
  181668. sqlite3_context *context,
  181669. int argc,
  181670. sqlite3_value **argv
  181671. ){
  181672. Fts5Auxiliary *pAux;
  181673. Fts5Cursor *pCsr;
  181674. i64 iCsrId;
  181675. assert( argc>=1 );
  181676. pAux = (Fts5Auxiliary*)sqlite3_user_data(context);
  181677. iCsrId = sqlite3_value_int64(argv[0]);
  181678. pCsr = fts5CursorFromCsrid(pAux->pGlobal, iCsrId);
  181679. if( pCsr==0 ){
  181680. char *zErr = sqlite3_mprintf("no such cursor: %lld", iCsrId);
  181681. sqlite3_result_error(context, zErr, -1);
  181682. sqlite3_free(zErr);
  181683. }else{
  181684. fts5ApiInvoke(pAux, pCsr, context, argc-1, &argv[1]);
  181685. }
  181686. }
  181687. /*
  181688. ** Given cursor id iId, return a pointer to the corresponding Fts5Index
  181689. ** object. Or NULL If the cursor id does not exist.
  181690. **
  181691. ** If successful, set *ppConfig to point to the associated config object
  181692. ** before returning.
  181693. */
  181694. static Fts5Index *sqlite3Fts5IndexFromCsrid(
  181695. Fts5Global *pGlobal, /* FTS5 global context for db handle */
  181696. i64 iCsrId, /* Id of cursor to find */
  181697. Fts5Config **ppConfig /* OUT: Configuration object */
  181698. ){
  181699. Fts5Cursor *pCsr;
  181700. Fts5Table *pTab;
  181701. pCsr = fts5CursorFromCsrid(pGlobal, iCsrId);
  181702. pTab = (Fts5Table*)pCsr->base.pVtab;
  181703. *ppConfig = pTab->pConfig;
  181704. return pTab->pIndex;
  181705. }
  181706. /*
  181707. ** Return a "position-list blob" corresponding to the current position of
  181708. ** cursor pCsr via sqlite3_result_blob(). A position-list blob contains
  181709. ** the current position-list for each phrase in the query associated with
  181710. ** cursor pCsr.
  181711. **
  181712. ** A position-list blob begins with (nPhrase-1) varints, where nPhrase is
  181713. ** the number of phrases in the query. Following the varints are the
  181714. ** concatenated position lists for each phrase, in order.
  181715. **
  181716. ** The first varint (if it exists) contains the size of the position list
  181717. ** for phrase 0. The second (same disclaimer) contains the size of position
  181718. ** list 1. And so on. There is no size field for the final position list,
  181719. ** as it can be derived from the total size of the blob.
  181720. */
  181721. static int fts5PoslistBlob(sqlite3_context *pCtx, Fts5Cursor *pCsr){
  181722. int i;
  181723. int rc = SQLITE_OK;
  181724. int nPhrase = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  181725. Fts5Buffer val;
  181726. memset(&val, 0, sizeof(Fts5Buffer));
  181727. switch( ((Fts5Table*)(pCsr->base.pVtab))->pConfig->eDetail ){
  181728. case FTS5_DETAIL_FULL:
  181729. /* Append the varints */
  181730. for(i=0; i<(nPhrase-1); i++){
  181731. const u8 *dummy;
  181732. int nByte = sqlite3Fts5ExprPoslist(pCsr->pExpr, i, &dummy);
  181733. sqlite3Fts5BufferAppendVarint(&rc, &val, nByte);
  181734. }
  181735. /* Append the position lists */
  181736. for(i=0; i<nPhrase; i++){
  181737. const u8 *pPoslist;
  181738. int nPoslist;
  181739. nPoslist = sqlite3Fts5ExprPoslist(pCsr->pExpr, i, &pPoslist);
  181740. sqlite3Fts5BufferAppendBlob(&rc, &val, nPoslist, pPoslist);
  181741. }
  181742. break;
  181743. case FTS5_DETAIL_COLUMNS:
  181744. /* Append the varints */
  181745. for(i=0; rc==SQLITE_OK && i<(nPhrase-1); i++){
  181746. const u8 *dummy;
  181747. int nByte;
  181748. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, i, &dummy, &nByte);
  181749. sqlite3Fts5BufferAppendVarint(&rc, &val, nByte);
  181750. }
  181751. /* Append the position lists */
  181752. for(i=0; rc==SQLITE_OK && i<nPhrase; i++){
  181753. const u8 *pPoslist;
  181754. int nPoslist;
  181755. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, i, &pPoslist, &nPoslist);
  181756. sqlite3Fts5BufferAppendBlob(&rc, &val, nPoslist, pPoslist);
  181757. }
  181758. break;
  181759. default:
  181760. break;
  181761. }
  181762. sqlite3_result_blob(pCtx, val.p, val.n, sqlite3_free);
  181763. return rc;
  181764. }
  181765. /*
  181766. ** This is the xColumn method, called by SQLite to request a value from
  181767. ** the row that the supplied cursor currently points to.
  181768. */
  181769. static int fts5ColumnMethod(
  181770. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  181771. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  181772. int iCol /* Index of column to read value from */
  181773. ){
  181774. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  181775. Fts5Config *pConfig = pTab->pConfig;
  181776. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  181777. int rc = SQLITE_OK;
  181778. assert( CsrFlagTest(pCsr, FTS5CSR_EOF)==0 );
  181779. if( pCsr->ePlan==FTS5_PLAN_SPECIAL ){
  181780. if( iCol==pConfig->nCol ){
  181781. sqlite3_result_int64(pCtx, pCsr->iSpecial);
  181782. }
  181783. }else
  181784. if( iCol==pConfig->nCol ){
  181785. /* User is requesting the value of the special column with the same name
  181786. ** as the table. Return the cursor integer id number. This value is only
  181787. ** useful in that it may be passed as the first argument to an FTS5
  181788. ** auxiliary function. */
  181789. sqlite3_result_int64(pCtx, pCsr->iCsrId);
  181790. }else if( iCol==pConfig->nCol+1 ){
  181791. /* The value of the "rank" column. */
  181792. if( pCsr->ePlan==FTS5_PLAN_SOURCE ){
  181793. fts5PoslistBlob(pCtx, pCsr);
  181794. }else if(
  181795. pCsr->ePlan==FTS5_PLAN_MATCH
  181796. || pCsr->ePlan==FTS5_PLAN_SORTED_MATCH
  181797. ){
  181798. if( pCsr->pRank || SQLITE_OK==(rc = fts5FindRankFunction(pCsr)) ){
  181799. fts5ApiInvoke(pCsr->pRank, pCsr, pCtx, pCsr->nRankArg, pCsr->apRankArg);
  181800. }
  181801. }
  181802. }else if( !fts5IsContentless(pTab) ){
  181803. rc = fts5SeekCursor(pCsr, 1);
  181804. if( rc==SQLITE_OK ){
  181805. sqlite3_result_value(pCtx, sqlite3_column_value(pCsr->pStmt, iCol+1));
  181806. }
  181807. }
  181808. return rc;
  181809. }
  181810. /*
  181811. ** This routine implements the xFindFunction method for the FTS3
  181812. ** virtual table.
  181813. */
  181814. static int fts5FindFunctionMethod(
  181815. sqlite3_vtab *pVtab, /* Virtual table handle */
  181816. int nUnused, /* Number of SQL function arguments */
  181817. const char *zName, /* Name of SQL function */
  181818. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), /* OUT: Result */
  181819. void **ppArg /* OUT: User data for *pxFunc */
  181820. ){
  181821. Fts5Table *pTab = (Fts5Table*)pVtab;
  181822. Fts5Auxiliary *pAux;
  181823. UNUSED_PARAM(nUnused);
  181824. pAux = fts5FindAuxiliary(pTab, zName);
  181825. if( pAux ){
  181826. *pxFunc = fts5ApiCallback;
  181827. *ppArg = (void*)pAux;
  181828. return 1;
  181829. }
  181830. /* No function of the specified name was found. Return 0. */
  181831. return 0;
  181832. }
  181833. /*
  181834. ** Implementation of FTS5 xRename method. Rename an fts5 table.
  181835. */
  181836. static int fts5RenameMethod(
  181837. sqlite3_vtab *pVtab, /* Virtual table handle */
  181838. const char *zName /* New name of table */
  181839. ){
  181840. Fts5Table *pTab = (Fts5Table*)pVtab;
  181841. return sqlite3Fts5StorageRename(pTab->pStorage, zName);
  181842. }
  181843. /*
  181844. ** The xSavepoint() method.
  181845. **
  181846. ** Flush the contents of the pending-terms table to disk.
  181847. */
  181848. static int fts5SavepointMethod(sqlite3_vtab *pVtab, int iSavepoint){
  181849. Fts5Table *pTab = (Fts5Table*)pVtab;
  181850. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  181851. fts5CheckTransactionState(pTab, FTS5_SAVEPOINT, iSavepoint);
  181852. fts5TripCursors(pTab);
  181853. return sqlite3Fts5StorageSync(pTab->pStorage, 0);
  181854. }
  181855. /*
  181856. ** The xRelease() method.
  181857. **
  181858. ** This is a no-op.
  181859. */
  181860. static int fts5ReleaseMethod(sqlite3_vtab *pVtab, int iSavepoint){
  181861. Fts5Table *pTab = (Fts5Table*)pVtab;
  181862. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  181863. fts5CheckTransactionState(pTab, FTS5_RELEASE, iSavepoint);
  181864. fts5TripCursors(pTab);
  181865. return sqlite3Fts5StorageSync(pTab->pStorage, 0);
  181866. }
  181867. /*
  181868. ** The xRollbackTo() method.
  181869. **
  181870. ** Discard the contents of the pending terms table.
  181871. */
  181872. static int fts5RollbackToMethod(sqlite3_vtab *pVtab, int iSavepoint){
  181873. Fts5Table *pTab = (Fts5Table*)pVtab;
  181874. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  181875. fts5CheckTransactionState(pTab, FTS5_ROLLBACKTO, iSavepoint);
  181876. fts5TripCursors(pTab);
  181877. return sqlite3Fts5StorageRollback(pTab->pStorage);
  181878. }
  181879. /*
  181880. ** Register a new auxiliary function with global context pGlobal.
  181881. */
  181882. static int fts5CreateAux(
  181883. fts5_api *pApi, /* Global context (one per db handle) */
  181884. const char *zName, /* Name of new function */
  181885. void *pUserData, /* User data for aux. function */
  181886. fts5_extension_function xFunc, /* Aux. function implementation */
  181887. void(*xDestroy)(void*) /* Destructor for pUserData */
  181888. ){
  181889. Fts5Global *pGlobal = (Fts5Global*)pApi;
  181890. int rc = sqlite3_overload_function(pGlobal->db, zName, -1);
  181891. if( rc==SQLITE_OK ){
  181892. Fts5Auxiliary *pAux;
  181893. int nName; /* Size of zName in bytes, including \0 */
  181894. int nByte; /* Bytes of space to allocate */
  181895. nName = (int)strlen(zName) + 1;
  181896. nByte = sizeof(Fts5Auxiliary) + nName;
  181897. pAux = (Fts5Auxiliary*)sqlite3_malloc(nByte);
  181898. if( pAux ){
  181899. memset(pAux, 0, nByte);
  181900. pAux->zFunc = (char*)&pAux[1];
  181901. memcpy(pAux->zFunc, zName, nName);
  181902. pAux->pGlobal = pGlobal;
  181903. pAux->pUserData = pUserData;
  181904. pAux->xFunc = xFunc;
  181905. pAux->xDestroy = xDestroy;
  181906. pAux->pNext = pGlobal->pAux;
  181907. pGlobal->pAux = pAux;
  181908. }else{
  181909. rc = SQLITE_NOMEM;
  181910. }
  181911. }
  181912. return rc;
  181913. }
  181914. /*
  181915. ** Register a new tokenizer. This is the implementation of the
  181916. ** fts5_api.xCreateTokenizer() method.
  181917. */
  181918. static int fts5CreateTokenizer(
  181919. fts5_api *pApi, /* Global context (one per db handle) */
  181920. const char *zName, /* Name of new function */
  181921. void *pUserData, /* User data for aux. function */
  181922. fts5_tokenizer *pTokenizer, /* Tokenizer implementation */
  181923. void(*xDestroy)(void*) /* Destructor for pUserData */
  181924. ){
  181925. Fts5Global *pGlobal = (Fts5Global*)pApi;
  181926. Fts5TokenizerModule *pNew;
  181927. int nName; /* Size of zName and its \0 terminator */
  181928. int nByte; /* Bytes of space to allocate */
  181929. int rc = SQLITE_OK;
  181930. nName = (int)strlen(zName) + 1;
  181931. nByte = sizeof(Fts5TokenizerModule) + nName;
  181932. pNew = (Fts5TokenizerModule*)sqlite3_malloc(nByte);
  181933. if( pNew ){
  181934. memset(pNew, 0, nByte);
  181935. pNew->zName = (char*)&pNew[1];
  181936. memcpy(pNew->zName, zName, nName);
  181937. pNew->pUserData = pUserData;
  181938. pNew->x = *pTokenizer;
  181939. pNew->xDestroy = xDestroy;
  181940. pNew->pNext = pGlobal->pTok;
  181941. pGlobal->pTok = pNew;
  181942. if( pNew->pNext==0 ){
  181943. pGlobal->pDfltTok = pNew;
  181944. }
  181945. }else{
  181946. rc = SQLITE_NOMEM;
  181947. }
  181948. return rc;
  181949. }
  181950. static Fts5TokenizerModule *fts5LocateTokenizer(
  181951. Fts5Global *pGlobal,
  181952. const char *zName
  181953. ){
  181954. Fts5TokenizerModule *pMod = 0;
  181955. if( zName==0 ){
  181956. pMod = pGlobal->pDfltTok;
  181957. }else{
  181958. for(pMod=pGlobal->pTok; pMod; pMod=pMod->pNext){
  181959. if( sqlite3_stricmp(zName, pMod->zName)==0 ) break;
  181960. }
  181961. }
  181962. return pMod;
  181963. }
  181964. /*
  181965. ** Find a tokenizer. This is the implementation of the
  181966. ** fts5_api.xFindTokenizer() method.
  181967. */
  181968. static int fts5FindTokenizer(
  181969. fts5_api *pApi, /* Global context (one per db handle) */
  181970. const char *zName, /* Name of new function */
  181971. void **ppUserData,
  181972. fts5_tokenizer *pTokenizer /* Populate this object */
  181973. ){
  181974. int rc = SQLITE_OK;
  181975. Fts5TokenizerModule *pMod;
  181976. pMod = fts5LocateTokenizer((Fts5Global*)pApi, zName);
  181977. if( pMod ){
  181978. *pTokenizer = pMod->x;
  181979. *ppUserData = pMod->pUserData;
  181980. }else{
  181981. memset(pTokenizer, 0, sizeof(fts5_tokenizer));
  181982. rc = SQLITE_ERROR;
  181983. }
  181984. return rc;
  181985. }
  181986. static int sqlite3Fts5GetTokenizer(
  181987. Fts5Global *pGlobal,
  181988. const char **azArg,
  181989. int nArg,
  181990. Fts5Tokenizer **ppTok,
  181991. fts5_tokenizer **ppTokApi,
  181992. char **pzErr
  181993. ){
  181994. Fts5TokenizerModule *pMod;
  181995. int rc = SQLITE_OK;
  181996. pMod = fts5LocateTokenizer(pGlobal, nArg==0 ? 0 : azArg[0]);
  181997. if( pMod==0 ){
  181998. assert( nArg>0 );
  181999. rc = SQLITE_ERROR;
  182000. *pzErr = sqlite3_mprintf("no such tokenizer: %s", azArg[0]);
  182001. }else{
  182002. rc = pMod->x.xCreate(pMod->pUserData, &azArg[1], (nArg?nArg-1:0), ppTok);
  182003. *ppTokApi = &pMod->x;
  182004. if( rc!=SQLITE_OK && pzErr ){
  182005. *pzErr = sqlite3_mprintf("error in tokenizer constructor");
  182006. }
  182007. }
  182008. if( rc!=SQLITE_OK ){
  182009. *ppTokApi = 0;
  182010. *ppTok = 0;
  182011. }
  182012. return rc;
  182013. }
  182014. static void fts5ModuleDestroy(void *pCtx){
  182015. Fts5TokenizerModule *pTok, *pNextTok;
  182016. Fts5Auxiliary *pAux, *pNextAux;
  182017. Fts5Global *pGlobal = (Fts5Global*)pCtx;
  182018. for(pAux=pGlobal->pAux; pAux; pAux=pNextAux){
  182019. pNextAux = pAux->pNext;
  182020. if( pAux->xDestroy ) pAux->xDestroy(pAux->pUserData);
  182021. sqlite3_free(pAux);
  182022. }
  182023. for(pTok=pGlobal->pTok; pTok; pTok=pNextTok){
  182024. pNextTok = pTok->pNext;
  182025. if( pTok->xDestroy ) pTok->xDestroy(pTok->pUserData);
  182026. sqlite3_free(pTok);
  182027. }
  182028. sqlite3_free(pGlobal);
  182029. }
  182030. static void fts5Fts5Func(
  182031. sqlite3_context *pCtx, /* Function call context */
  182032. int nArg, /* Number of args */
  182033. sqlite3_value **apUnused /* Function arguments */
  182034. ){
  182035. Fts5Global *pGlobal = (Fts5Global*)sqlite3_user_data(pCtx);
  182036. char buf[8];
  182037. UNUSED_PARAM2(nArg, apUnused);
  182038. assert( nArg==0 );
  182039. assert( sizeof(buf)>=sizeof(pGlobal) );
  182040. memcpy(buf, (void*)&pGlobal, sizeof(pGlobal));
  182041. sqlite3_result_blob(pCtx, buf, sizeof(pGlobal), SQLITE_TRANSIENT);
  182042. }
  182043. /*
  182044. ** Implementation of fts5_source_id() function.
  182045. */
  182046. static void fts5SourceIdFunc(
  182047. sqlite3_context *pCtx, /* Function call context */
  182048. int nArg, /* Number of args */
  182049. sqlite3_value **apUnused /* Function arguments */
  182050. ){
  182051. assert( nArg==0 );
  182052. UNUSED_PARAM2(nArg, apUnused);
  182053. sqlite3_result_text(pCtx, "fts5: 2016-11-04 12:08:49 1136863c76576110e710dd5d69ab6bf347c65e36", -1, SQLITE_TRANSIENT);
  182054. }
  182055. static int fts5Init(sqlite3 *db){
  182056. static const sqlite3_module fts5Mod = {
  182057. /* iVersion */ 2,
  182058. /* xCreate */ fts5CreateMethod,
  182059. /* xConnect */ fts5ConnectMethod,
  182060. /* xBestIndex */ fts5BestIndexMethod,
  182061. /* xDisconnect */ fts5DisconnectMethod,
  182062. /* xDestroy */ fts5DestroyMethod,
  182063. /* xOpen */ fts5OpenMethod,
  182064. /* xClose */ fts5CloseMethod,
  182065. /* xFilter */ fts5FilterMethod,
  182066. /* xNext */ fts5NextMethod,
  182067. /* xEof */ fts5EofMethod,
  182068. /* xColumn */ fts5ColumnMethod,
  182069. /* xRowid */ fts5RowidMethod,
  182070. /* xUpdate */ fts5UpdateMethod,
  182071. /* xBegin */ fts5BeginMethod,
  182072. /* xSync */ fts5SyncMethod,
  182073. /* xCommit */ fts5CommitMethod,
  182074. /* xRollback */ fts5RollbackMethod,
  182075. /* xFindFunction */ fts5FindFunctionMethod,
  182076. /* xRename */ fts5RenameMethod,
  182077. /* xSavepoint */ fts5SavepointMethod,
  182078. /* xRelease */ fts5ReleaseMethod,
  182079. /* xRollbackTo */ fts5RollbackToMethod,
  182080. };
  182081. int rc;
  182082. Fts5Global *pGlobal = 0;
  182083. pGlobal = (Fts5Global*)sqlite3_malloc(sizeof(Fts5Global));
  182084. if( pGlobal==0 ){
  182085. rc = SQLITE_NOMEM;
  182086. }else{
  182087. void *p = (void*)pGlobal;
  182088. memset(pGlobal, 0, sizeof(Fts5Global));
  182089. pGlobal->db = db;
  182090. pGlobal->api.iVersion = 2;
  182091. pGlobal->api.xCreateFunction = fts5CreateAux;
  182092. pGlobal->api.xCreateTokenizer = fts5CreateTokenizer;
  182093. pGlobal->api.xFindTokenizer = fts5FindTokenizer;
  182094. rc = sqlite3_create_module_v2(db, "fts5", &fts5Mod, p, fts5ModuleDestroy);
  182095. if( rc==SQLITE_OK ) rc = sqlite3Fts5IndexInit(db);
  182096. if( rc==SQLITE_OK ) rc = sqlite3Fts5ExprInit(pGlobal, db);
  182097. if( rc==SQLITE_OK ) rc = sqlite3Fts5AuxInit(&pGlobal->api);
  182098. if( rc==SQLITE_OK ) rc = sqlite3Fts5TokenizerInit(&pGlobal->api);
  182099. if( rc==SQLITE_OK ) rc = sqlite3Fts5VocabInit(pGlobal, db);
  182100. if( rc==SQLITE_OK ){
  182101. rc = sqlite3_create_function(
  182102. db, "fts5", 0, SQLITE_UTF8, p, fts5Fts5Func, 0, 0
  182103. );
  182104. }
  182105. if( rc==SQLITE_OK ){
  182106. rc = sqlite3_create_function(
  182107. db, "fts5_source_id", 0, SQLITE_UTF8, p, fts5SourceIdFunc, 0, 0
  182108. );
  182109. }
  182110. }
  182111. /* If SQLITE_FTS5_ENABLE_TEST_MI is defined, assume that the file
  182112. ** fts5_test_mi.c is compiled and linked into the executable. And call
  182113. ** its entry point to enable the matchinfo() demo. */
  182114. #ifdef SQLITE_FTS5_ENABLE_TEST_MI
  182115. if( rc==SQLITE_OK ){
  182116. extern int sqlite3Fts5TestRegisterMatchinfo(sqlite3*);
  182117. rc = sqlite3Fts5TestRegisterMatchinfo(db);
  182118. }
  182119. #endif
  182120. return rc;
  182121. }
  182122. /*
  182123. ** The following functions are used to register the module with SQLite. If
  182124. ** this module is being built as part of the SQLite core (SQLITE_CORE is
  182125. ** defined), then sqlite3_open() will call sqlite3Fts5Init() directly.
  182126. **
  182127. ** Or, if this module is being built as a loadable extension,
  182128. ** sqlite3Fts5Init() is omitted and the two standard entry points
  182129. ** sqlite3_fts_init() and sqlite3_fts5_init() defined instead.
  182130. */
  182131. #ifndef SQLITE_CORE
  182132. #ifdef _WIN32
  182133. __declspec(dllexport)
  182134. #endif
  182135. SQLITE_API int sqlite3_fts_init(
  182136. sqlite3 *db,
  182137. char **pzErrMsg,
  182138. const sqlite3_api_routines *pApi
  182139. ){
  182140. SQLITE_EXTENSION_INIT2(pApi);
  182141. (void)pzErrMsg; /* Unused parameter */
  182142. return fts5Init(db);
  182143. }
  182144. #ifdef _WIN32
  182145. __declspec(dllexport)
  182146. #endif
  182147. SQLITE_API int sqlite3_fts5_init(
  182148. sqlite3 *db,
  182149. char **pzErrMsg,
  182150. const sqlite3_api_routines *pApi
  182151. ){
  182152. SQLITE_EXTENSION_INIT2(pApi);
  182153. (void)pzErrMsg; /* Unused parameter */
  182154. return fts5Init(db);
  182155. }
  182156. #else
  182157. SQLITE_PRIVATE int sqlite3Fts5Init(sqlite3 *db){
  182158. return fts5Init(db);
  182159. }
  182160. #endif
  182161. /*
  182162. ** 2014 May 31
  182163. **
  182164. ** The author disclaims copyright to this source code. In place of
  182165. ** a legal notice, here is a blessing:
  182166. **
  182167. ** May you do good and not evil.
  182168. ** May you find forgiveness for yourself and forgive others.
  182169. ** May you share freely, never taking more than you give.
  182170. **
  182171. ******************************************************************************
  182172. **
  182173. */
  182174. /* #include "fts5Int.h" */
  182175. struct Fts5Storage {
  182176. Fts5Config *pConfig;
  182177. Fts5Index *pIndex;
  182178. int bTotalsValid; /* True if nTotalRow/aTotalSize[] are valid */
  182179. i64 nTotalRow; /* Total number of rows in FTS table */
  182180. i64 *aTotalSize; /* Total sizes of each column */
  182181. sqlite3_stmt *aStmt[11];
  182182. };
  182183. #if FTS5_STMT_SCAN_ASC!=0
  182184. # error "FTS5_STMT_SCAN_ASC mismatch"
  182185. #endif
  182186. #if FTS5_STMT_SCAN_DESC!=1
  182187. # error "FTS5_STMT_SCAN_DESC mismatch"
  182188. #endif
  182189. #if FTS5_STMT_LOOKUP!=2
  182190. # error "FTS5_STMT_LOOKUP mismatch"
  182191. #endif
  182192. #define FTS5_STMT_INSERT_CONTENT 3
  182193. #define FTS5_STMT_REPLACE_CONTENT 4
  182194. #define FTS5_STMT_DELETE_CONTENT 5
  182195. #define FTS5_STMT_REPLACE_DOCSIZE 6
  182196. #define FTS5_STMT_DELETE_DOCSIZE 7
  182197. #define FTS5_STMT_LOOKUP_DOCSIZE 8
  182198. #define FTS5_STMT_REPLACE_CONFIG 9
  182199. #define FTS5_STMT_SCAN 10
  182200. /*
  182201. ** Prepare the two insert statements - Fts5Storage.pInsertContent and
  182202. ** Fts5Storage.pInsertDocsize - if they have not already been prepared.
  182203. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  182204. ** occurs.
  182205. */
  182206. static int fts5StorageGetStmt(
  182207. Fts5Storage *p, /* Storage handle */
  182208. int eStmt, /* FTS5_STMT_XXX constant */
  182209. sqlite3_stmt **ppStmt, /* OUT: Prepared statement handle */
  182210. char **pzErrMsg /* OUT: Error message (if any) */
  182211. ){
  182212. int rc = SQLITE_OK;
  182213. /* If there is no %_docsize table, there should be no requests for
  182214. ** statements to operate on it. */
  182215. assert( p->pConfig->bColumnsize || (
  182216. eStmt!=FTS5_STMT_REPLACE_DOCSIZE
  182217. && eStmt!=FTS5_STMT_DELETE_DOCSIZE
  182218. && eStmt!=FTS5_STMT_LOOKUP_DOCSIZE
  182219. ));
  182220. assert( eStmt>=0 && eStmt<ArraySize(p->aStmt) );
  182221. if( p->aStmt[eStmt]==0 ){
  182222. const char *azStmt[] = {
  182223. "SELECT %s FROM %s T WHERE T.%Q >= ? AND T.%Q <= ? ORDER BY T.%Q ASC",
  182224. "SELECT %s FROM %s T WHERE T.%Q <= ? AND T.%Q >= ? ORDER BY T.%Q DESC",
  182225. "SELECT %s FROM %s T WHERE T.%Q=?", /* LOOKUP */
  182226. "INSERT INTO %Q.'%q_content' VALUES(%s)", /* INSERT_CONTENT */
  182227. "REPLACE INTO %Q.'%q_content' VALUES(%s)", /* REPLACE_CONTENT */
  182228. "DELETE FROM %Q.'%q_content' WHERE id=?", /* DELETE_CONTENT */
  182229. "REPLACE INTO %Q.'%q_docsize' VALUES(?,?)", /* REPLACE_DOCSIZE */
  182230. "DELETE FROM %Q.'%q_docsize' WHERE id=?", /* DELETE_DOCSIZE */
  182231. "SELECT sz FROM %Q.'%q_docsize' WHERE id=?", /* LOOKUP_DOCSIZE */
  182232. "REPLACE INTO %Q.'%q_config' VALUES(?,?)", /* REPLACE_CONFIG */
  182233. "SELECT %s FROM %s AS T", /* SCAN */
  182234. };
  182235. Fts5Config *pC = p->pConfig;
  182236. char *zSql = 0;
  182237. switch( eStmt ){
  182238. case FTS5_STMT_SCAN:
  182239. zSql = sqlite3_mprintf(azStmt[eStmt],
  182240. pC->zContentExprlist, pC->zContent
  182241. );
  182242. break;
  182243. case FTS5_STMT_SCAN_ASC:
  182244. case FTS5_STMT_SCAN_DESC:
  182245. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zContentExprlist,
  182246. pC->zContent, pC->zContentRowid, pC->zContentRowid,
  182247. pC->zContentRowid
  182248. );
  182249. break;
  182250. case FTS5_STMT_LOOKUP:
  182251. zSql = sqlite3_mprintf(azStmt[eStmt],
  182252. pC->zContentExprlist, pC->zContent, pC->zContentRowid
  182253. );
  182254. break;
  182255. case FTS5_STMT_INSERT_CONTENT:
  182256. case FTS5_STMT_REPLACE_CONTENT: {
  182257. int nCol = pC->nCol + 1;
  182258. char *zBind;
  182259. int i;
  182260. zBind = sqlite3_malloc(1 + nCol*2);
  182261. if( zBind ){
  182262. for(i=0; i<nCol; i++){
  182263. zBind[i*2] = '?';
  182264. zBind[i*2 + 1] = ',';
  182265. }
  182266. zBind[i*2-1] = '\0';
  182267. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zDb, pC->zName, zBind);
  182268. sqlite3_free(zBind);
  182269. }
  182270. break;
  182271. }
  182272. default:
  182273. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zDb, pC->zName);
  182274. break;
  182275. }
  182276. if( zSql==0 ){
  182277. rc = SQLITE_NOMEM;
  182278. }else{
  182279. rc = sqlite3_prepare_v2(pC->db, zSql, -1, &p->aStmt[eStmt], 0);
  182280. sqlite3_free(zSql);
  182281. if( rc!=SQLITE_OK && pzErrMsg ){
  182282. *pzErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(pC->db));
  182283. }
  182284. }
  182285. }
  182286. *ppStmt = p->aStmt[eStmt];
  182287. sqlite3_reset(*ppStmt);
  182288. return rc;
  182289. }
  182290. static int fts5ExecPrintf(
  182291. sqlite3 *db,
  182292. char **pzErr,
  182293. const char *zFormat,
  182294. ...
  182295. ){
  182296. int rc;
  182297. va_list ap; /* ... printf arguments */
  182298. char *zSql;
  182299. va_start(ap, zFormat);
  182300. zSql = sqlite3_vmprintf(zFormat, ap);
  182301. if( zSql==0 ){
  182302. rc = SQLITE_NOMEM;
  182303. }else{
  182304. rc = sqlite3_exec(db, zSql, 0, 0, pzErr);
  182305. sqlite3_free(zSql);
  182306. }
  182307. va_end(ap);
  182308. return rc;
  182309. }
  182310. /*
  182311. ** Drop all shadow tables. Return SQLITE_OK if successful or an SQLite error
  182312. ** code otherwise.
  182313. */
  182314. static int sqlite3Fts5DropAll(Fts5Config *pConfig){
  182315. int rc = fts5ExecPrintf(pConfig->db, 0,
  182316. "DROP TABLE IF EXISTS %Q.'%q_data';"
  182317. "DROP TABLE IF EXISTS %Q.'%q_idx';"
  182318. "DROP TABLE IF EXISTS %Q.'%q_config';",
  182319. pConfig->zDb, pConfig->zName,
  182320. pConfig->zDb, pConfig->zName,
  182321. pConfig->zDb, pConfig->zName
  182322. );
  182323. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  182324. rc = fts5ExecPrintf(pConfig->db, 0,
  182325. "DROP TABLE IF EXISTS %Q.'%q_docsize';",
  182326. pConfig->zDb, pConfig->zName
  182327. );
  182328. }
  182329. if( rc==SQLITE_OK && pConfig->eContent==FTS5_CONTENT_NORMAL ){
  182330. rc = fts5ExecPrintf(pConfig->db, 0,
  182331. "DROP TABLE IF EXISTS %Q.'%q_content';",
  182332. pConfig->zDb, pConfig->zName
  182333. );
  182334. }
  182335. return rc;
  182336. }
  182337. static void fts5StorageRenameOne(
  182338. Fts5Config *pConfig, /* Current FTS5 configuration */
  182339. int *pRc, /* IN/OUT: Error code */
  182340. const char *zTail, /* Tail of table name e.g. "data", "config" */
  182341. const char *zName /* New name of FTS5 table */
  182342. ){
  182343. if( *pRc==SQLITE_OK ){
  182344. *pRc = fts5ExecPrintf(pConfig->db, 0,
  182345. "ALTER TABLE %Q.'%q_%s' RENAME TO '%q_%s';",
  182346. pConfig->zDb, pConfig->zName, zTail, zName, zTail
  182347. );
  182348. }
  182349. }
  182350. static int sqlite3Fts5StorageRename(Fts5Storage *pStorage, const char *zName){
  182351. Fts5Config *pConfig = pStorage->pConfig;
  182352. int rc = sqlite3Fts5StorageSync(pStorage, 1);
  182353. fts5StorageRenameOne(pConfig, &rc, "data", zName);
  182354. fts5StorageRenameOne(pConfig, &rc, "idx", zName);
  182355. fts5StorageRenameOne(pConfig, &rc, "config", zName);
  182356. if( pConfig->bColumnsize ){
  182357. fts5StorageRenameOne(pConfig, &rc, "docsize", zName);
  182358. }
  182359. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  182360. fts5StorageRenameOne(pConfig, &rc, "content", zName);
  182361. }
  182362. return rc;
  182363. }
  182364. /*
  182365. ** Create the shadow table named zPost, with definition zDefn. Return
  182366. ** SQLITE_OK if successful, or an SQLite error code otherwise.
  182367. */
  182368. static int sqlite3Fts5CreateTable(
  182369. Fts5Config *pConfig, /* FTS5 configuration */
  182370. const char *zPost, /* Shadow table to create (e.g. "content") */
  182371. const char *zDefn, /* Columns etc. for shadow table */
  182372. int bWithout, /* True for without rowid */
  182373. char **pzErr /* OUT: Error message */
  182374. ){
  182375. int rc;
  182376. char *zErr = 0;
  182377. rc = fts5ExecPrintf(pConfig->db, &zErr, "CREATE TABLE %Q.'%q_%q'(%s)%s",
  182378. pConfig->zDb, pConfig->zName, zPost, zDefn,
  182379. #ifndef SQLITE_FTS5_NO_WITHOUT_ROWID
  182380. bWithout?" WITHOUT ROWID":
  182381. #endif
  182382. ""
  182383. );
  182384. if( zErr ){
  182385. *pzErr = sqlite3_mprintf(
  182386. "fts5: error creating shadow table %q_%s: %s",
  182387. pConfig->zName, zPost, zErr
  182388. );
  182389. sqlite3_free(zErr);
  182390. }
  182391. return rc;
  182392. }
  182393. /*
  182394. ** Open a new Fts5Index handle. If the bCreate argument is true, create
  182395. ** and initialize the underlying tables
  182396. **
  182397. ** If successful, set *pp to point to the new object and return SQLITE_OK.
  182398. ** Otherwise, set *pp to NULL and return an SQLite error code.
  182399. */
  182400. static int sqlite3Fts5StorageOpen(
  182401. Fts5Config *pConfig,
  182402. Fts5Index *pIndex,
  182403. int bCreate,
  182404. Fts5Storage **pp,
  182405. char **pzErr /* OUT: Error message */
  182406. ){
  182407. int rc = SQLITE_OK;
  182408. Fts5Storage *p; /* New object */
  182409. int nByte; /* Bytes of space to allocate */
  182410. nByte = sizeof(Fts5Storage) /* Fts5Storage object */
  182411. + pConfig->nCol * sizeof(i64); /* Fts5Storage.aTotalSize[] */
  182412. *pp = p = (Fts5Storage*)sqlite3_malloc(nByte);
  182413. if( !p ) return SQLITE_NOMEM;
  182414. memset(p, 0, nByte);
  182415. p->aTotalSize = (i64*)&p[1];
  182416. p->pConfig = pConfig;
  182417. p->pIndex = pIndex;
  182418. if( bCreate ){
  182419. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  182420. int nDefn = 32 + pConfig->nCol*10;
  182421. char *zDefn = sqlite3_malloc(32 + pConfig->nCol * 10);
  182422. if( zDefn==0 ){
  182423. rc = SQLITE_NOMEM;
  182424. }else{
  182425. int i;
  182426. int iOff;
  182427. sqlite3_snprintf(nDefn, zDefn, "id INTEGER PRIMARY KEY");
  182428. iOff = (int)strlen(zDefn);
  182429. for(i=0; i<pConfig->nCol; i++){
  182430. sqlite3_snprintf(nDefn-iOff, &zDefn[iOff], ", c%d", i);
  182431. iOff += (int)strlen(&zDefn[iOff]);
  182432. }
  182433. rc = sqlite3Fts5CreateTable(pConfig, "content", zDefn, 0, pzErr);
  182434. }
  182435. sqlite3_free(zDefn);
  182436. }
  182437. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  182438. rc = sqlite3Fts5CreateTable(
  182439. pConfig, "docsize", "id INTEGER PRIMARY KEY, sz BLOB", 0, pzErr
  182440. );
  182441. }
  182442. if( rc==SQLITE_OK ){
  182443. rc = sqlite3Fts5CreateTable(
  182444. pConfig, "config", "k PRIMARY KEY, v", 1, pzErr
  182445. );
  182446. }
  182447. if( rc==SQLITE_OK ){
  182448. rc = sqlite3Fts5StorageConfigValue(p, "version", 0, FTS5_CURRENT_VERSION);
  182449. }
  182450. }
  182451. if( rc ){
  182452. sqlite3Fts5StorageClose(p);
  182453. *pp = 0;
  182454. }
  182455. return rc;
  182456. }
  182457. /*
  182458. ** Close a handle opened by an earlier call to sqlite3Fts5StorageOpen().
  182459. */
  182460. static int sqlite3Fts5StorageClose(Fts5Storage *p){
  182461. int rc = SQLITE_OK;
  182462. if( p ){
  182463. int i;
  182464. /* Finalize all SQL statements */
  182465. for(i=0; i<ArraySize(p->aStmt); i++){
  182466. sqlite3_finalize(p->aStmt[i]);
  182467. }
  182468. sqlite3_free(p);
  182469. }
  182470. return rc;
  182471. }
  182472. typedef struct Fts5InsertCtx Fts5InsertCtx;
  182473. struct Fts5InsertCtx {
  182474. Fts5Storage *pStorage;
  182475. int iCol;
  182476. int szCol; /* Size of column value in tokens */
  182477. };
  182478. /*
  182479. ** Tokenization callback used when inserting tokens into the FTS index.
  182480. */
  182481. static int fts5StorageInsertCallback(
  182482. void *pContext, /* Pointer to Fts5InsertCtx object */
  182483. int tflags,
  182484. const char *pToken, /* Buffer containing token */
  182485. int nToken, /* Size of token in bytes */
  182486. int iUnused1, /* Start offset of token */
  182487. int iUnused2 /* End offset of token */
  182488. ){
  182489. Fts5InsertCtx *pCtx = (Fts5InsertCtx*)pContext;
  182490. Fts5Index *pIdx = pCtx->pStorage->pIndex;
  182491. UNUSED_PARAM2(iUnused1, iUnused2);
  182492. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  182493. if( (tflags & FTS5_TOKEN_COLOCATED)==0 || pCtx->szCol==0 ){
  182494. pCtx->szCol++;
  182495. }
  182496. return sqlite3Fts5IndexWrite(pIdx, pCtx->iCol, pCtx->szCol-1, pToken, nToken);
  182497. }
  182498. /*
  182499. ** If a row with rowid iDel is present in the %_content table, add the
  182500. ** delete-markers to the FTS index necessary to delete it. Do not actually
  182501. ** remove the %_content row at this time though.
  182502. */
  182503. static int fts5StorageDeleteFromIndex(
  182504. Fts5Storage *p,
  182505. i64 iDel,
  182506. sqlite3_value **apVal
  182507. ){
  182508. Fts5Config *pConfig = p->pConfig;
  182509. sqlite3_stmt *pSeek = 0; /* SELECT to read row iDel from %_data */
  182510. int rc; /* Return code */
  182511. int rc2; /* sqlite3_reset() return code */
  182512. int iCol;
  182513. Fts5InsertCtx ctx;
  182514. if( apVal==0 ){
  182515. rc = fts5StorageGetStmt(p, FTS5_STMT_LOOKUP, &pSeek, 0);
  182516. if( rc!=SQLITE_OK ) return rc;
  182517. sqlite3_bind_int64(pSeek, 1, iDel);
  182518. if( sqlite3_step(pSeek)!=SQLITE_ROW ){
  182519. return sqlite3_reset(pSeek);
  182520. }
  182521. }
  182522. ctx.pStorage = p;
  182523. ctx.iCol = -1;
  182524. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 1, iDel);
  182525. for(iCol=1; rc==SQLITE_OK && iCol<=pConfig->nCol; iCol++){
  182526. if( pConfig->abUnindexed[iCol-1]==0 ){
  182527. const char *zText;
  182528. int nText;
  182529. if( pSeek ){
  182530. zText = (const char*)sqlite3_column_text(pSeek, iCol);
  182531. nText = sqlite3_column_bytes(pSeek, iCol);
  182532. }else{
  182533. zText = (const char*)sqlite3_value_text(apVal[iCol-1]);
  182534. nText = sqlite3_value_bytes(apVal[iCol-1]);
  182535. }
  182536. ctx.szCol = 0;
  182537. rc = sqlite3Fts5Tokenize(pConfig, FTS5_TOKENIZE_DOCUMENT,
  182538. zText, nText, (void*)&ctx, fts5StorageInsertCallback
  182539. );
  182540. p->aTotalSize[iCol-1] -= (i64)ctx.szCol;
  182541. }
  182542. }
  182543. p->nTotalRow--;
  182544. rc2 = sqlite3_reset(pSeek);
  182545. if( rc==SQLITE_OK ) rc = rc2;
  182546. return rc;
  182547. }
  182548. /*
  182549. ** Insert a record into the %_docsize table. Specifically, do:
  182550. **
  182551. ** INSERT OR REPLACE INTO %_docsize(id, sz) VALUES(iRowid, pBuf);
  182552. **
  182553. ** If there is no %_docsize table (as happens if the columnsize=0 option
  182554. ** is specified when the FTS5 table is created), this function is a no-op.
  182555. */
  182556. static int fts5StorageInsertDocsize(
  182557. Fts5Storage *p, /* Storage module to write to */
  182558. i64 iRowid, /* id value */
  182559. Fts5Buffer *pBuf /* sz value */
  182560. ){
  182561. int rc = SQLITE_OK;
  182562. if( p->pConfig->bColumnsize ){
  182563. sqlite3_stmt *pReplace = 0;
  182564. rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_DOCSIZE, &pReplace, 0);
  182565. if( rc==SQLITE_OK ){
  182566. sqlite3_bind_int64(pReplace, 1, iRowid);
  182567. sqlite3_bind_blob(pReplace, 2, pBuf->p, pBuf->n, SQLITE_STATIC);
  182568. sqlite3_step(pReplace);
  182569. rc = sqlite3_reset(pReplace);
  182570. }
  182571. }
  182572. return rc;
  182573. }
  182574. /*
  182575. ** Load the contents of the "averages" record from disk into the
  182576. ** p->nTotalRow and p->aTotalSize[] variables. If successful, and if
  182577. ** argument bCache is true, set the p->bTotalsValid flag to indicate
  182578. ** that the contents of aTotalSize[] and nTotalRow are valid until
  182579. ** further notice.
  182580. **
  182581. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  182582. ** occurs.
  182583. */
  182584. static int fts5StorageLoadTotals(Fts5Storage *p, int bCache){
  182585. int rc = SQLITE_OK;
  182586. if( p->bTotalsValid==0 ){
  182587. rc = sqlite3Fts5IndexGetAverages(p->pIndex, &p->nTotalRow, p->aTotalSize);
  182588. p->bTotalsValid = bCache;
  182589. }
  182590. return rc;
  182591. }
  182592. /*
  182593. ** Store the current contents of the p->nTotalRow and p->aTotalSize[]
  182594. ** variables in the "averages" record on disk.
  182595. **
  182596. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  182597. ** occurs.
  182598. */
  182599. static int fts5StorageSaveTotals(Fts5Storage *p){
  182600. int nCol = p->pConfig->nCol;
  182601. int i;
  182602. Fts5Buffer buf;
  182603. int rc = SQLITE_OK;
  182604. memset(&buf, 0, sizeof(buf));
  182605. sqlite3Fts5BufferAppendVarint(&rc, &buf, p->nTotalRow);
  182606. for(i=0; i<nCol; i++){
  182607. sqlite3Fts5BufferAppendVarint(&rc, &buf, p->aTotalSize[i]);
  182608. }
  182609. if( rc==SQLITE_OK ){
  182610. rc = sqlite3Fts5IndexSetAverages(p->pIndex, buf.p, buf.n);
  182611. }
  182612. sqlite3_free(buf.p);
  182613. return rc;
  182614. }
  182615. /*
  182616. ** Remove a row from the FTS table.
  182617. */
  182618. static int sqlite3Fts5StorageDelete(Fts5Storage *p, i64 iDel, sqlite3_value **apVal){
  182619. Fts5Config *pConfig = p->pConfig;
  182620. int rc;
  182621. sqlite3_stmt *pDel = 0;
  182622. assert( pConfig->eContent!=FTS5_CONTENT_NORMAL || apVal==0 );
  182623. rc = fts5StorageLoadTotals(p, 1);
  182624. /* Delete the index records */
  182625. if( rc==SQLITE_OK ){
  182626. rc = fts5StorageDeleteFromIndex(p, iDel, apVal);
  182627. }
  182628. /* Delete the %_docsize record */
  182629. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  182630. rc = fts5StorageGetStmt(p, FTS5_STMT_DELETE_DOCSIZE, &pDel, 0);
  182631. if( rc==SQLITE_OK ){
  182632. sqlite3_bind_int64(pDel, 1, iDel);
  182633. sqlite3_step(pDel);
  182634. rc = sqlite3_reset(pDel);
  182635. }
  182636. }
  182637. /* Delete the %_content record */
  182638. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  182639. if( rc==SQLITE_OK ){
  182640. rc = fts5StorageGetStmt(p, FTS5_STMT_DELETE_CONTENT, &pDel, 0);
  182641. }
  182642. if( rc==SQLITE_OK ){
  182643. sqlite3_bind_int64(pDel, 1, iDel);
  182644. sqlite3_step(pDel);
  182645. rc = sqlite3_reset(pDel);
  182646. }
  182647. }
  182648. /* Write the averages record */
  182649. if( rc==SQLITE_OK ){
  182650. rc = fts5StorageSaveTotals(p);
  182651. }
  182652. return rc;
  182653. }
  182654. /*
  182655. ** Delete all entries in the FTS5 index.
  182656. */
  182657. static int sqlite3Fts5StorageDeleteAll(Fts5Storage *p){
  182658. Fts5Config *pConfig = p->pConfig;
  182659. int rc;
  182660. /* Delete the contents of the %_data and %_docsize tables. */
  182661. rc = fts5ExecPrintf(pConfig->db, 0,
  182662. "DELETE FROM %Q.'%q_data';"
  182663. "DELETE FROM %Q.'%q_idx';",
  182664. pConfig->zDb, pConfig->zName,
  182665. pConfig->zDb, pConfig->zName
  182666. );
  182667. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  182668. rc = fts5ExecPrintf(pConfig->db, 0,
  182669. "DELETE FROM %Q.'%q_docsize';",
  182670. pConfig->zDb, pConfig->zName
  182671. );
  182672. }
  182673. /* Reinitialize the %_data table. This call creates the initial structure
  182674. ** and averages records. */
  182675. if( rc==SQLITE_OK ){
  182676. rc = sqlite3Fts5IndexReinit(p->pIndex);
  182677. }
  182678. if( rc==SQLITE_OK ){
  182679. rc = sqlite3Fts5StorageConfigValue(p, "version", 0, FTS5_CURRENT_VERSION);
  182680. }
  182681. return rc;
  182682. }
  182683. static int sqlite3Fts5StorageRebuild(Fts5Storage *p){
  182684. Fts5Buffer buf = {0,0,0};
  182685. Fts5Config *pConfig = p->pConfig;
  182686. sqlite3_stmt *pScan = 0;
  182687. Fts5InsertCtx ctx;
  182688. int rc;
  182689. memset(&ctx, 0, sizeof(Fts5InsertCtx));
  182690. ctx.pStorage = p;
  182691. rc = sqlite3Fts5StorageDeleteAll(p);
  182692. if( rc==SQLITE_OK ){
  182693. rc = fts5StorageLoadTotals(p, 1);
  182694. }
  182695. if( rc==SQLITE_OK ){
  182696. rc = fts5StorageGetStmt(p, FTS5_STMT_SCAN, &pScan, 0);
  182697. }
  182698. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pScan) ){
  182699. i64 iRowid = sqlite3_column_int64(pScan, 0);
  182700. sqlite3Fts5BufferZero(&buf);
  182701. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 0, iRowid);
  182702. for(ctx.iCol=0; rc==SQLITE_OK && ctx.iCol<pConfig->nCol; ctx.iCol++){
  182703. ctx.szCol = 0;
  182704. if( pConfig->abUnindexed[ctx.iCol]==0 ){
  182705. rc = sqlite3Fts5Tokenize(pConfig,
  182706. FTS5_TOKENIZE_DOCUMENT,
  182707. (const char*)sqlite3_column_text(pScan, ctx.iCol+1),
  182708. sqlite3_column_bytes(pScan, ctx.iCol+1),
  182709. (void*)&ctx,
  182710. fts5StorageInsertCallback
  182711. );
  182712. }
  182713. sqlite3Fts5BufferAppendVarint(&rc, &buf, ctx.szCol);
  182714. p->aTotalSize[ctx.iCol] += (i64)ctx.szCol;
  182715. }
  182716. p->nTotalRow++;
  182717. if( rc==SQLITE_OK ){
  182718. rc = fts5StorageInsertDocsize(p, iRowid, &buf);
  182719. }
  182720. }
  182721. sqlite3_free(buf.p);
  182722. /* Write the averages record */
  182723. if( rc==SQLITE_OK ){
  182724. rc = fts5StorageSaveTotals(p);
  182725. }
  182726. return rc;
  182727. }
  182728. static int sqlite3Fts5StorageOptimize(Fts5Storage *p){
  182729. return sqlite3Fts5IndexOptimize(p->pIndex);
  182730. }
  182731. static int sqlite3Fts5StorageMerge(Fts5Storage *p, int nMerge){
  182732. return sqlite3Fts5IndexMerge(p->pIndex, nMerge);
  182733. }
  182734. static int sqlite3Fts5StorageReset(Fts5Storage *p){
  182735. return sqlite3Fts5IndexReset(p->pIndex);
  182736. }
  182737. /*
  182738. ** Allocate a new rowid. This is used for "external content" tables when
  182739. ** a NULL value is inserted into the rowid column. The new rowid is allocated
  182740. ** by inserting a dummy row into the %_docsize table. The dummy will be
  182741. ** overwritten later.
  182742. **
  182743. ** If the %_docsize table does not exist, SQLITE_MISMATCH is returned. In
  182744. ** this case the user is required to provide a rowid explicitly.
  182745. */
  182746. static int fts5StorageNewRowid(Fts5Storage *p, i64 *piRowid){
  182747. int rc = SQLITE_MISMATCH;
  182748. if( p->pConfig->bColumnsize ){
  182749. sqlite3_stmt *pReplace = 0;
  182750. rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_DOCSIZE, &pReplace, 0);
  182751. if( rc==SQLITE_OK ){
  182752. sqlite3_bind_null(pReplace, 1);
  182753. sqlite3_bind_null(pReplace, 2);
  182754. sqlite3_step(pReplace);
  182755. rc = sqlite3_reset(pReplace);
  182756. }
  182757. if( rc==SQLITE_OK ){
  182758. *piRowid = sqlite3_last_insert_rowid(p->pConfig->db);
  182759. }
  182760. }
  182761. return rc;
  182762. }
  182763. /*
  182764. ** Insert a new row into the FTS content table.
  182765. */
  182766. static int sqlite3Fts5StorageContentInsert(
  182767. Fts5Storage *p,
  182768. sqlite3_value **apVal,
  182769. i64 *piRowid
  182770. ){
  182771. Fts5Config *pConfig = p->pConfig;
  182772. int rc = SQLITE_OK;
  182773. /* Insert the new row into the %_content table. */
  182774. if( pConfig->eContent!=FTS5_CONTENT_NORMAL ){
  182775. if( sqlite3_value_type(apVal[1])==SQLITE_INTEGER ){
  182776. *piRowid = sqlite3_value_int64(apVal[1]);
  182777. }else{
  182778. rc = fts5StorageNewRowid(p, piRowid);
  182779. }
  182780. }else{
  182781. sqlite3_stmt *pInsert = 0; /* Statement to write %_content table */
  182782. int i; /* Counter variable */
  182783. rc = fts5StorageGetStmt(p, FTS5_STMT_INSERT_CONTENT, &pInsert, 0);
  182784. for(i=1; rc==SQLITE_OK && i<=pConfig->nCol+1; i++){
  182785. rc = sqlite3_bind_value(pInsert, i, apVal[i]);
  182786. }
  182787. if( rc==SQLITE_OK ){
  182788. sqlite3_step(pInsert);
  182789. rc = sqlite3_reset(pInsert);
  182790. }
  182791. *piRowid = sqlite3_last_insert_rowid(pConfig->db);
  182792. }
  182793. return rc;
  182794. }
  182795. /*
  182796. ** Insert new entries into the FTS index and %_docsize table.
  182797. */
  182798. static int sqlite3Fts5StorageIndexInsert(
  182799. Fts5Storage *p,
  182800. sqlite3_value **apVal,
  182801. i64 iRowid
  182802. ){
  182803. Fts5Config *pConfig = p->pConfig;
  182804. int rc = SQLITE_OK; /* Return code */
  182805. Fts5InsertCtx ctx; /* Tokenization callback context object */
  182806. Fts5Buffer buf; /* Buffer used to build up %_docsize blob */
  182807. memset(&buf, 0, sizeof(Fts5Buffer));
  182808. ctx.pStorage = p;
  182809. rc = fts5StorageLoadTotals(p, 1);
  182810. if( rc==SQLITE_OK ){
  182811. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 0, iRowid);
  182812. }
  182813. for(ctx.iCol=0; rc==SQLITE_OK && ctx.iCol<pConfig->nCol; ctx.iCol++){
  182814. ctx.szCol = 0;
  182815. if( pConfig->abUnindexed[ctx.iCol]==0 ){
  182816. rc = sqlite3Fts5Tokenize(pConfig,
  182817. FTS5_TOKENIZE_DOCUMENT,
  182818. (const char*)sqlite3_value_text(apVal[ctx.iCol+2]),
  182819. sqlite3_value_bytes(apVal[ctx.iCol+2]),
  182820. (void*)&ctx,
  182821. fts5StorageInsertCallback
  182822. );
  182823. }
  182824. sqlite3Fts5BufferAppendVarint(&rc, &buf, ctx.szCol);
  182825. p->aTotalSize[ctx.iCol] += (i64)ctx.szCol;
  182826. }
  182827. p->nTotalRow++;
  182828. /* Write the %_docsize record */
  182829. if( rc==SQLITE_OK ){
  182830. rc = fts5StorageInsertDocsize(p, iRowid, &buf);
  182831. }
  182832. sqlite3_free(buf.p);
  182833. /* Write the averages record */
  182834. if( rc==SQLITE_OK ){
  182835. rc = fts5StorageSaveTotals(p);
  182836. }
  182837. return rc;
  182838. }
  182839. static int fts5StorageCount(Fts5Storage *p, const char *zSuffix, i64 *pnRow){
  182840. Fts5Config *pConfig = p->pConfig;
  182841. char *zSql;
  182842. int rc;
  182843. zSql = sqlite3_mprintf("SELECT count(*) FROM %Q.'%q_%s'",
  182844. pConfig->zDb, pConfig->zName, zSuffix
  182845. );
  182846. if( zSql==0 ){
  182847. rc = SQLITE_NOMEM;
  182848. }else{
  182849. sqlite3_stmt *pCnt = 0;
  182850. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &pCnt, 0);
  182851. if( rc==SQLITE_OK ){
  182852. if( SQLITE_ROW==sqlite3_step(pCnt) ){
  182853. *pnRow = sqlite3_column_int64(pCnt, 0);
  182854. }
  182855. rc = sqlite3_finalize(pCnt);
  182856. }
  182857. }
  182858. sqlite3_free(zSql);
  182859. return rc;
  182860. }
  182861. /*
  182862. ** Context object used by sqlite3Fts5StorageIntegrity().
  182863. */
  182864. typedef struct Fts5IntegrityCtx Fts5IntegrityCtx;
  182865. struct Fts5IntegrityCtx {
  182866. i64 iRowid;
  182867. int iCol;
  182868. int szCol;
  182869. u64 cksum;
  182870. Fts5Termset *pTermset;
  182871. Fts5Config *pConfig;
  182872. };
  182873. /*
  182874. ** Tokenization callback used by integrity check.
  182875. */
  182876. static int fts5StorageIntegrityCallback(
  182877. void *pContext, /* Pointer to Fts5IntegrityCtx object */
  182878. int tflags,
  182879. const char *pToken, /* Buffer containing token */
  182880. int nToken, /* Size of token in bytes */
  182881. int iUnused1, /* Start offset of token */
  182882. int iUnused2 /* End offset of token */
  182883. ){
  182884. Fts5IntegrityCtx *pCtx = (Fts5IntegrityCtx*)pContext;
  182885. Fts5Termset *pTermset = pCtx->pTermset;
  182886. int bPresent;
  182887. int ii;
  182888. int rc = SQLITE_OK;
  182889. int iPos;
  182890. int iCol;
  182891. UNUSED_PARAM2(iUnused1, iUnused2);
  182892. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  182893. if( (tflags & FTS5_TOKEN_COLOCATED)==0 || pCtx->szCol==0 ){
  182894. pCtx->szCol++;
  182895. }
  182896. switch( pCtx->pConfig->eDetail ){
  182897. case FTS5_DETAIL_FULL:
  182898. iPos = pCtx->szCol-1;
  182899. iCol = pCtx->iCol;
  182900. break;
  182901. case FTS5_DETAIL_COLUMNS:
  182902. iPos = pCtx->iCol;
  182903. iCol = 0;
  182904. break;
  182905. default:
  182906. assert( pCtx->pConfig->eDetail==FTS5_DETAIL_NONE );
  182907. iPos = 0;
  182908. iCol = 0;
  182909. break;
  182910. }
  182911. rc = sqlite3Fts5TermsetAdd(pTermset, 0, pToken, nToken, &bPresent);
  182912. if( rc==SQLITE_OK && bPresent==0 ){
  182913. pCtx->cksum ^= sqlite3Fts5IndexEntryCksum(
  182914. pCtx->iRowid, iCol, iPos, 0, pToken, nToken
  182915. );
  182916. }
  182917. for(ii=0; rc==SQLITE_OK && ii<pCtx->pConfig->nPrefix; ii++){
  182918. const int nChar = pCtx->pConfig->aPrefix[ii];
  182919. int nByte = sqlite3Fts5IndexCharlenToBytelen(pToken, nToken, nChar);
  182920. if( nByte ){
  182921. rc = sqlite3Fts5TermsetAdd(pTermset, ii+1, pToken, nByte, &bPresent);
  182922. if( bPresent==0 ){
  182923. pCtx->cksum ^= sqlite3Fts5IndexEntryCksum(
  182924. pCtx->iRowid, iCol, iPos, ii+1, pToken, nByte
  182925. );
  182926. }
  182927. }
  182928. }
  182929. return rc;
  182930. }
  182931. /*
  182932. ** Check that the contents of the FTS index match that of the %_content
  182933. ** table. Return SQLITE_OK if they do, or SQLITE_CORRUPT if not. Return
  182934. ** some other SQLite error code if an error occurs while attempting to
  182935. ** determine this.
  182936. */
  182937. static int sqlite3Fts5StorageIntegrity(Fts5Storage *p){
  182938. Fts5Config *pConfig = p->pConfig;
  182939. int rc; /* Return code */
  182940. int *aColSize; /* Array of size pConfig->nCol */
  182941. i64 *aTotalSize; /* Array of size pConfig->nCol */
  182942. Fts5IntegrityCtx ctx;
  182943. sqlite3_stmt *pScan;
  182944. memset(&ctx, 0, sizeof(Fts5IntegrityCtx));
  182945. ctx.pConfig = p->pConfig;
  182946. aTotalSize = (i64*)sqlite3_malloc(pConfig->nCol * (sizeof(int)+sizeof(i64)));
  182947. if( !aTotalSize ) return SQLITE_NOMEM;
  182948. aColSize = (int*)&aTotalSize[pConfig->nCol];
  182949. memset(aTotalSize, 0, sizeof(i64) * pConfig->nCol);
  182950. /* Generate the expected index checksum based on the contents of the
  182951. ** %_content table. This block stores the checksum in ctx.cksum. */
  182952. rc = fts5StorageGetStmt(p, FTS5_STMT_SCAN, &pScan, 0);
  182953. if( rc==SQLITE_OK ){
  182954. int rc2;
  182955. while( SQLITE_ROW==sqlite3_step(pScan) ){
  182956. int i;
  182957. ctx.iRowid = sqlite3_column_int64(pScan, 0);
  182958. ctx.szCol = 0;
  182959. if( pConfig->bColumnsize ){
  182960. rc = sqlite3Fts5StorageDocsize(p, ctx.iRowid, aColSize);
  182961. }
  182962. if( rc==SQLITE_OK && pConfig->eDetail==FTS5_DETAIL_NONE ){
  182963. rc = sqlite3Fts5TermsetNew(&ctx.pTermset);
  182964. }
  182965. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  182966. if( pConfig->abUnindexed[i] ) continue;
  182967. ctx.iCol = i;
  182968. ctx.szCol = 0;
  182969. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  182970. rc = sqlite3Fts5TermsetNew(&ctx.pTermset);
  182971. }
  182972. if( rc==SQLITE_OK ){
  182973. rc = sqlite3Fts5Tokenize(pConfig,
  182974. FTS5_TOKENIZE_DOCUMENT,
  182975. (const char*)sqlite3_column_text(pScan, i+1),
  182976. sqlite3_column_bytes(pScan, i+1),
  182977. (void*)&ctx,
  182978. fts5StorageIntegrityCallback
  182979. );
  182980. }
  182981. if( rc==SQLITE_OK && pConfig->bColumnsize && ctx.szCol!=aColSize[i] ){
  182982. rc = FTS5_CORRUPT;
  182983. }
  182984. aTotalSize[i] += ctx.szCol;
  182985. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  182986. sqlite3Fts5TermsetFree(ctx.pTermset);
  182987. ctx.pTermset = 0;
  182988. }
  182989. }
  182990. sqlite3Fts5TermsetFree(ctx.pTermset);
  182991. ctx.pTermset = 0;
  182992. if( rc!=SQLITE_OK ) break;
  182993. }
  182994. rc2 = sqlite3_reset(pScan);
  182995. if( rc==SQLITE_OK ) rc = rc2;
  182996. }
  182997. /* Test that the "totals" (sometimes called "averages") record looks Ok */
  182998. if( rc==SQLITE_OK ){
  182999. int i;
  183000. rc = fts5StorageLoadTotals(p, 0);
  183001. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  183002. if( p->aTotalSize[i]!=aTotalSize[i] ) rc = FTS5_CORRUPT;
  183003. }
  183004. }
  183005. /* Check that the %_docsize and %_content tables contain the expected
  183006. ** number of rows. */
  183007. if( rc==SQLITE_OK && pConfig->eContent==FTS5_CONTENT_NORMAL ){
  183008. i64 nRow = 0;
  183009. rc = fts5StorageCount(p, "content", &nRow);
  183010. if( rc==SQLITE_OK && nRow!=p->nTotalRow ) rc = FTS5_CORRUPT;
  183011. }
  183012. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  183013. i64 nRow = 0;
  183014. rc = fts5StorageCount(p, "docsize", &nRow);
  183015. if( rc==SQLITE_OK && nRow!=p->nTotalRow ) rc = FTS5_CORRUPT;
  183016. }
  183017. /* Pass the expected checksum down to the FTS index module. It will
  183018. ** verify, amongst other things, that it matches the checksum generated by
  183019. ** inspecting the index itself. */
  183020. if( rc==SQLITE_OK ){
  183021. rc = sqlite3Fts5IndexIntegrityCheck(p->pIndex, ctx.cksum);
  183022. }
  183023. sqlite3_free(aTotalSize);
  183024. return rc;
  183025. }
  183026. /*
  183027. ** Obtain an SQLite statement handle that may be used to read data from the
  183028. ** %_content table.
  183029. */
  183030. static int sqlite3Fts5StorageStmt(
  183031. Fts5Storage *p,
  183032. int eStmt,
  183033. sqlite3_stmt **pp,
  183034. char **pzErrMsg
  183035. ){
  183036. int rc;
  183037. assert( eStmt==FTS5_STMT_SCAN_ASC
  183038. || eStmt==FTS5_STMT_SCAN_DESC
  183039. || eStmt==FTS5_STMT_LOOKUP
  183040. );
  183041. rc = fts5StorageGetStmt(p, eStmt, pp, pzErrMsg);
  183042. if( rc==SQLITE_OK ){
  183043. assert( p->aStmt[eStmt]==*pp );
  183044. p->aStmt[eStmt] = 0;
  183045. }
  183046. return rc;
  183047. }
  183048. /*
  183049. ** Release an SQLite statement handle obtained via an earlier call to
  183050. ** sqlite3Fts5StorageStmt(). The eStmt parameter passed to this function
  183051. ** must match that passed to the sqlite3Fts5StorageStmt() call.
  183052. */
  183053. static void sqlite3Fts5StorageStmtRelease(
  183054. Fts5Storage *p,
  183055. int eStmt,
  183056. sqlite3_stmt *pStmt
  183057. ){
  183058. assert( eStmt==FTS5_STMT_SCAN_ASC
  183059. || eStmt==FTS5_STMT_SCAN_DESC
  183060. || eStmt==FTS5_STMT_LOOKUP
  183061. );
  183062. if( p->aStmt[eStmt]==0 ){
  183063. sqlite3_reset(pStmt);
  183064. p->aStmt[eStmt] = pStmt;
  183065. }else{
  183066. sqlite3_finalize(pStmt);
  183067. }
  183068. }
  183069. static int fts5StorageDecodeSizeArray(
  183070. int *aCol, int nCol, /* Array to populate */
  183071. const u8 *aBlob, int nBlob /* Record to read varints from */
  183072. ){
  183073. int i;
  183074. int iOff = 0;
  183075. for(i=0; i<nCol; i++){
  183076. if( iOff>=nBlob ) return 1;
  183077. iOff += fts5GetVarint32(&aBlob[iOff], aCol[i]);
  183078. }
  183079. return (iOff!=nBlob);
  183080. }
  183081. /*
  183082. ** Argument aCol points to an array of integers containing one entry for
  183083. ** each table column. This function reads the %_docsize record for the
  183084. ** specified rowid and populates aCol[] with the results.
  183085. **
  183086. ** An SQLite error code is returned if an error occurs, or SQLITE_OK
  183087. ** otherwise.
  183088. */
  183089. static int sqlite3Fts5StorageDocsize(Fts5Storage *p, i64 iRowid, int *aCol){
  183090. int nCol = p->pConfig->nCol; /* Number of user columns in table */
  183091. sqlite3_stmt *pLookup = 0; /* Statement to query %_docsize */
  183092. int rc; /* Return Code */
  183093. assert( p->pConfig->bColumnsize );
  183094. rc = fts5StorageGetStmt(p, FTS5_STMT_LOOKUP_DOCSIZE, &pLookup, 0);
  183095. if( rc==SQLITE_OK ){
  183096. int bCorrupt = 1;
  183097. sqlite3_bind_int64(pLookup, 1, iRowid);
  183098. if( SQLITE_ROW==sqlite3_step(pLookup) ){
  183099. const u8 *aBlob = sqlite3_column_blob(pLookup, 0);
  183100. int nBlob = sqlite3_column_bytes(pLookup, 0);
  183101. if( 0==fts5StorageDecodeSizeArray(aCol, nCol, aBlob, nBlob) ){
  183102. bCorrupt = 0;
  183103. }
  183104. }
  183105. rc = sqlite3_reset(pLookup);
  183106. if( bCorrupt && rc==SQLITE_OK ){
  183107. rc = FTS5_CORRUPT;
  183108. }
  183109. }
  183110. return rc;
  183111. }
  183112. static int sqlite3Fts5StorageSize(Fts5Storage *p, int iCol, i64 *pnToken){
  183113. int rc = fts5StorageLoadTotals(p, 0);
  183114. if( rc==SQLITE_OK ){
  183115. *pnToken = 0;
  183116. if( iCol<0 ){
  183117. int i;
  183118. for(i=0; i<p->pConfig->nCol; i++){
  183119. *pnToken += p->aTotalSize[i];
  183120. }
  183121. }else if( iCol<p->pConfig->nCol ){
  183122. *pnToken = p->aTotalSize[iCol];
  183123. }else{
  183124. rc = SQLITE_RANGE;
  183125. }
  183126. }
  183127. return rc;
  183128. }
  183129. static int sqlite3Fts5StorageRowCount(Fts5Storage *p, i64 *pnRow){
  183130. int rc = fts5StorageLoadTotals(p, 0);
  183131. if( rc==SQLITE_OK ){
  183132. *pnRow = p->nTotalRow;
  183133. }
  183134. return rc;
  183135. }
  183136. /*
  183137. ** Flush any data currently held in-memory to disk.
  183138. */
  183139. static int sqlite3Fts5StorageSync(Fts5Storage *p, int bCommit){
  183140. if( bCommit && p->bTotalsValid ){
  183141. int rc = fts5StorageSaveTotals(p);
  183142. p->bTotalsValid = 0;
  183143. if( rc!=SQLITE_OK ) return rc;
  183144. }
  183145. return sqlite3Fts5IndexSync(p->pIndex, bCommit);
  183146. }
  183147. static int sqlite3Fts5StorageRollback(Fts5Storage *p){
  183148. p->bTotalsValid = 0;
  183149. return sqlite3Fts5IndexRollback(p->pIndex);
  183150. }
  183151. static int sqlite3Fts5StorageConfigValue(
  183152. Fts5Storage *p,
  183153. const char *z,
  183154. sqlite3_value *pVal,
  183155. int iVal
  183156. ){
  183157. sqlite3_stmt *pReplace = 0;
  183158. int rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_CONFIG, &pReplace, 0);
  183159. if( rc==SQLITE_OK ){
  183160. sqlite3_bind_text(pReplace, 1, z, -1, SQLITE_STATIC);
  183161. if( pVal ){
  183162. sqlite3_bind_value(pReplace, 2, pVal);
  183163. }else{
  183164. sqlite3_bind_int(pReplace, 2, iVal);
  183165. }
  183166. sqlite3_step(pReplace);
  183167. rc = sqlite3_reset(pReplace);
  183168. }
  183169. if( rc==SQLITE_OK && pVal ){
  183170. int iNew = p->pConfig->iCookie + 1;
  183171. rc = sqlite3Fts5IndexSetCookie(p->pIndex, iNew);
  183172. if( rc==SQLITE_OK ){
  183173. p->pConfig->iCookie = iNew;
  183174. }
  183175. }
  183176. return rc;
  183177. }
  183178. /*
  183179. ** 2014 May 31
  183180. **
  183181. ** The author disclaims copyright to this source code. In place of
  183182. ** a legal notice, here is a blessing:
  183183. **
  183184. ** May you do good and not evil.
  183185. ** May you find forgiveness for yourself and forgive others.
  183186. ** May you share freely, never taking more than you give.
  183187. **
  183188. ******************************************************************************
  183189. */
  183190. /* #include "fts5Int.h" */
  183191. /**************************************************************************
  183192. ** Start of ascii tokenizer implementation.
  183193. */
  183194. /*
  183195. ** For tokenizers with no "unicode" modifier, the set of token characters
  183196. ** is the same as the set of ASCII range alphanumeric characters.
  183197. */
  183198. static unsigned char aAsciiTokenChar[128] = {
  183199. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00..0x0F */
  183200. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x10..0x1F */
  183201. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20..0x2F */
  183202. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 0x30..0x3F */
  183203. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x40..0x4F */
  183204. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 0x50..0x5F */
  183205. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x60..0x6F */
  183206. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 0x70..0x7F */
  183207. };
  183208. typedef struct AsciiTokenizer AsciiTokenizer;
  183209. struct AsciiTokenizer {
  183210. unsigned char aTokenChar[128];
  183211. };
  183212. static void fts5AsciiAddExceptions(
  183213. AsciiTokenizer *p,
  183214. const char *zArg,
  183215. int bTokenChars
  183216. ){
  183217. int i;
  183218. for(i=0; zArg[i]; i++){
  183219. if( (zArg[i] & 0x80)==0 ){
  183220. p->aTokenChar[(int)zArg[i]] = (unsigned char)bTokenChars;
  183221. }
  183222. }
  183223. }
  183224. /*
  183225. ** Delete a "ascii" tokenizer.
  183226. */
  183227. static void fts5AsciiDelete(Fts5Tokenizer *p){
  183228. sqlite3_free(p);
  183229. }
  183230. /*
  183231. ** Create an "ascii" tokenizer.
  183232. */
  183233. static int fts5AsciiCreate(
  183234. void *pUnused,
  183235. const char **azArg, int nArg,
  183236. Fts5Tokenizer **ppOut
  183237. ){
  183238. int rc = SQLITE_OK;
  183239. AsciiTokenizer *p = 0;
  183240. UNUSED_PARAM(pUnused);
  183241. if( nArg%2 ){
  183242. rc = SQLITE_ERROR;
  183243. }else{
  183244. p = sqlite3_malloc(sizeof(AsciiTokenizer));
  183245. if( p==0 ){
  183246. rc = SQLITE_NOMEM;
  183247. }else{
  183248. int i;
  183249. memset(p, 0, sizeof(AsciiTokenizer));
  183250. memcpy(p->aTokenChar, aAsciiTokenChar, sizeof(aAsciiTokenChar));
  183251. for(i=0; rc==SQLITE_OK && i<nArg; i+=2){
  183252. const char *zArg = azArg[i+1];
  183253. if( 0==sqlite3_stricmp(azArg[i], "tokenchars") ){
  183254. fts5AsciiAddExceptions(p, zArg, 1);
  183255. }else
  183256. if( 0==sqlite3_stricmp(azArg[i], "separators") ){
  183257. fts5AsciiAddExceptions(p, zArg, 0);
  183258. }else{
  183259. rc = SQLITE_ERROR;
  183260. }
  183261. }
  183262. if( rc!=SQLITE_OK ){
  183263. fts5AsciiDelete((Fts5Tokenizer*)p);
  183264. p = 0;
  183265. }
  183266. }
  183267. }
  183268. *ppOut = (Fts5Tokenizer*)p;
  183269. return rc;
  183270. }
  183271. static void asciiFold(char *aOut, const char *aIn, int nByte){
  183272. int i;
  183273. for(i=0; i<nByte; i++){
  183274. char c = aIn[i];
  183275. if( c>='A' && c<='Z' ) c += 32;
  183276. aOut[i] = c;
  183277. }
  183278. }
  183279. /*
  183280. ** Tokenize some text using the ascii tokenizer.
  183281. */
  183282. static int fts5AsciiTokenize(
  183283. Fts5Tokenizer *pTokenizer,
  183284. void *pCtx,
  183285. int iUnused,
  183286. const char *pText, int nText,
  183287. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  183288. ){
  183289. AsciiTokenizer *p = (AsciiTokenizer*)pTokenizer;
  183290. int rc = SQLITE_OK;
  183291. int ie;
  183292. int is = 0;
  183293. char aFold[64];
  183294. int nFold = sizeof(aFold);
  183295. char *pFold = aFold;
  183296. unsigned char *a = p->aTokenChar;
  183297. UNUSED_PARAM(iUnused);
  183298. while( is<nText && rc==SQLITE_OK ){
  183299. int nByte;
  183300. /* Skip any leading divider characters. */
  183301. while( is<nText && ((pText[is]&0x80)==0 && a[(int)pText[is]]==0) ){
  183302. is++;
  183303. }
  183304. if( is==nText ) break;
  183305. /* Count the token characters */
  183306. ie = is+1;
  183307. while( ie<nText && ((pText[ie]&0x80) || a[(int)pText[ie]] ) ){
  183308. ie++;
  183309. }
  183310. /* Fold to lower case */
  183311. nByte = ie-is;
  183312. if( nByte>nFold ){
  183313. if( pFold!=aFold ) sqlite3_free(pFold);
  183314. pFold = sqlite3_malloc(nByte*2);
  183315. if( pFold==0 ){
  183316. rc = SQLITE_NOMEM;
  183317. break;
  183318. }
  183319. nFold = nByte*2;
  183320. }
  183321. asciiFold(pFold, &pText[is], nByte);
  183322. /* Invoke the token callback */
  183323. rc = xToken(pCtx, 0, pFold, nByte, is, ie);
  183324. is = ie+1;
  183325. }
  183326. if( pFold!=aFold ) sqlite3_free(pFold);
  183327. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  183328. return rc;
  183329. }
  183330. /**************************************************************************
  183331. ** Start of unicode61 tokenizer implementation.
  183332. */
  183333. /*
  183334. ** The following two macros - READ_UTF8 and WRITE_UTF8 - have been copied
  183335. ** from the sqlite3 source file utf.c. If this file is compiled as part
  183336. ** of the amalgamation, they are not required.
  183337. */
  183338. #ifndef SQLITE_AMALGAMATION
  183339. static const unsigned char sqlite3Utf8Trans1[] = {
  183340. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  183341. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  183342. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  183343. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  183344. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  183345. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  183346. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  183347. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  183348. };
  183349. #define READ_UTF8(zIn, zTerm, c) \
  183350. c = *(zIn++); \
  183351. if( c>=0xc0 ){ \
  183352. c = sqlite3Utf8Trans1[c-0xc0]; \
  183353. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  183354. c = (c<<6) + (0x3f & *(zIn++)); \
  183355. } \
  183356. if( c<0x80 \
  183357. || (c&0xFFFFF800)==0xD800 \
  183358. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  183359. }
  183360. #define WRITE_UTF8(zOut, c) { \
  183361. if( c<0x00080 ){ \
  183362. *zOut++ = (unsigned char)(c&0xFF); \
  183363. } \
  183364. else if( c<0x00800 ){ \
  183365. *zOut++ = 0xC0 + (unsigned char)((c>>6)&0x1F); \
  183366. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  183367. } \
  183368. else if( c<0x10000 ){ \
  183369. *zOut++ = 0xE0 + (unsigned char)((c>>12)&0x0F); \
  183370. *zOut++ = 0x80 + (unsigned char)((c>>6) & 0x3F); \
  183371. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  183372. }else{ \
  183373. *zOut++ = 0xF0 + (unsigned char)((c>>18) & 0x07); \
  183374. *zOut++ = 0x80 + (unsigned char)((c>>12) & 0x3F); \
  183375. *zOut++ = 0x80 + (unsigned char)((c>>6) & 0x3F); \
  183376. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  183377. } \
  183378. }
  183379. #endif /* ifndef SQLITE_AMALGAMATION */
  183380. typedef struct Unicode61Tokenizer Unicode61Tokenizer;
  183381. struct Unicode61Tokenizer {
  183382. unsigned char aTokenChar[128]; /* ASCII range token characters */
  183383. char *aFold; /* Buffer to fold text into */
  183384. int nFold; /* Size of aFold[] in bytes */
  183385. int bRemoveDiacritic; /* True if remove_diacritics=1 is set */
  183386. int nException;
  183387. int *aiException;
  183388. };
  183389. static int fts5UnicodeAddExceptions(
  183390. Unicode61Tokenizer *p, /* Tokenizer object */
  183391. const char *z, /* Characters to treat as exceptions */
  183392. int bTokenChars /* 1 for 'tokenchars', 0 for 'separators' */
  183393. ){
  183394. int rc = SQLITE_OK;
  183395. int n = (int)strlen(z);
  183396. int *aNew;
  183397. if( n>0 ){
  183398. aNew = (int*)sqlite3_realloc(p->aiException, (n+p->nException)*sizeof(int));
  183399. if( aNew ){
  183400. int nNew = p->nException;
  183401. const unsigned char *zCsr = (const unsigned char*)z;
  183402. const unsigned char *zTerm = (const unsigned char*)&z[n];
  183403. while( zCsr<zTerm ){
  183404. int iCode;
  183405. int bToken;
  183406. READ_UTF8(zCsr, zTerm, iCode);
  183407. if( iCode<128 ){
  183408. p->aTokenChar[iCode] = (unsigned char)bTokenChars;
  183409. }else{
  183410. bToken = sqlite3Fts5UnicodeIsalnum(iCode);
  183411. assert( (bToken==0 || bToken==1) );
  183412. assert( (bTokenChars==0 || bTokenChars==1) );
  183413. if( bToken!=bTokenChars && sqlite3Fts5UnicodeIsdiacritic(iCode)==0 ){
  183414. int i;
  183415. for(i=0; i<nNew; i++){
  183416. if( aNew[i]>iCode ) break;
  183417. }
  183418. memmove(&aNew[i+1], &aNew[i], (nNew-i)*sizeof(int));
  183419. aNew[i] = iCode;
  183420. nNew++;
  183421. }
  183422. }
  183423. }
  183424. p->aiException = aNew;
  183425. p->nException = nNew;
  183426. }else{
  183427. rc = SQLITE_NOMEM;
  183428. }
  183429. }
  183430. return rc;
  183431. }
  183432. /*
  183433. ** Return true if the p->aiException[] array contains the value iCode.
  183434. */
  183435. static int fts5UnicodeIsException(Unicode61Tokenizer *p, int iCode){
  183436. if( p->nException>0 ){
  183437. int *a = p->aiException;
  183438. int iLo = 0;
  183439. int iHi = p->nException-1;
  183440. while( iHi>=iLo ){
  183441. int iTest = (iHi + iLo) / 2;
  183442. if( iCode==a[iTest] ){
  183443. return 1;
  183444. }else if( iCode>a[iTest] ){
  183445. iLo = iTest+1;
  183446. }else{
  183447. iHi = iTest-1;
  183448. }
  183449. }
  183450. }
  183451. return 0;
  183452. }
  183453. /*
  183454. ** Delete a "unicode61" tokenizer.
  183455. */
  183456. static void fts5UnicodeDelete(Fts5Tokenizer *pTok){
  183457. if( pTok ){
  183458. Unicode61Tokenizer *p = (Unicode61Tokenizer*)pTok;
  183459. sqlite3_free(p->aiException);
  183460. sqlite3_free(p->aFold);
  183461. sqlite3_free(p);
  183462. }
  183463. return;
  183464. }
  183465. /*
  183466. ** Create a "unicode61" tokenizer.
  183467. */
  183468. static int fts5UnicodeCreate(
  183469. void *pUnused,
  183470. const char **azArg, int nArg,
  183471. Fts5Tokenizer **ppOut
  183472. ){
  183473. int rc = SQLITE_OK; /* Return code */
  183474. Unicode61Tokenizer *p = 0; /* New tokenizer object */
  183475. UNUSED_PARAM(pUnused);
  183476. if( nArg%2 ){
  183477. rc = SQLITE_ERROR;
  183478. }else{
  183479. p = (Unicode61Tokenizer*)sqlite3_malloc(sizeof(Unicode61Tokenizer));
  183480. if( p ){
  183481. int i;
  183482. memset(p, 0, sizeof(Unicode61Tokenizer));
  183483. memcpy(p->aTokenChar, aAsciiTokenChar, sizeof(aAsciiTokenChar));
  183484. p->bRemoveDiacritic = 1;
  183485. p->nFold = 64;
  183486. p->aFold = sqlite3_malloc(p->nFold * sizeof(char));
  183487. if( p->aFold==0 ){
  183488. rc = SQLITE_NOMEM;
  183489. }
  183490. for(i=0; rc==SQLITE_OK && i<nArg; i+=2){
  183491. const char *zArg = azArg[i+1];
  183492. if( 0==sqlite3_stricmp(azArg[i], "remove_diacritics") ){
  183493. if( (zArg[0]!='0' && zArg[0]!='1') || zArg[1] ){
  183494. rc = SQLITE_ERROR;
  183495. }
  183496. p->bRemoveDiacritic = (zArg[0]=='1');
  183497. }else
  183498. if( 0==sqlite3_stricmp(azArg[i], "tokenchars") ){
  183499. rc = fts5UnicodeAddExceptions(p, zArg, 1);
  183500. }else
  183501. if( 0==sqlite3_stricmp(azArg[i], "separators") ){
  183502. rc = fts5UnicodeAddExceptions(p, zArg, 0);
  183503. }else{
  183504. rc = SQLITE_ERROR;
  183505. }
  183506. }
  183507. }else{
  183508. rc = SQLITE_NOMEM;
  183509. }
  183510. if( rc!=SQLITE_OK ){
  183511. fts5UnicodeDelete((Fts5Tokenizer*)p);
  183512. p = 0;
  183513. }
  183514. *ppOut = (Fts5Tokenizer*)p;
  183515. }
  183516. return rc;
  183517. }
  183518. /*
  183519. ** Return true if, for the purposes of tokenizing with the tokenizer
  183520. ** passed as the first argument, codepoint iCode is considered a token
  183521. ** character (not a separator).
  183522. */
  183523. static int fts5UnicodeIsAlnum(Unicode61Tokenizer *p, int iCode){
  183524. assert( (sqlite3Fts5UnicodeIsalnum(iCode) & 0xFFFFFFFE)==0 );
  183525. return sqlite3Fts5UnicodeIsalnum(iCode) ^ fts5UnicodeIsException(p, iCode);
  183526. }
  183527. static int fts5UnicodeTokenize(
  183528. Fts5Tokenizer *pTokenizer,
  183529. void *pCtx,
  183530. int iUnused,
  183531. const char *pText, int nText,
  183532. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  183533. ){
  183534. Unicode61Tokenizer *p = (Unicode61Tokenizer*)pTokenizer;
  183535. int rc = SQLITE_OK;
  183536. unsigned char *a = p->aTokenChar;
  183537. unsigned char *zTerm = (unsigned char*)&pText[nText];
  183538. unsigned char *zCsr = (unsigned char *)pText;
  183539. /* Output buffer */
  183540. char *aFold = p->aFold;
  183541. int nFold = p->nFold;
  183542. const char *pEnd = &aFold[nFold-6];
  183543. UNUSED_PARAM(iUnused);
  183544. /* Each iteration of this loop gobbles up a contiguous run of separators,
  183545. ** then the next token. */
  183546. while( rc==SQLITE_OK ){
  183547. int iCode; /* non-ASCII codepoint read from input */
  183548. char *zOut = aFold;
  183549. int is;
  183550. int ie;
  183551. /* Skip any separator characters. */
  183552. while( 1 ){
  183553. if( zCsr>=zTerm ) goto tokenize_done;
  183554. if( *zCsr & 0x80 ) {
  183555. /* A character outside of the ascii range. Skip past it if it is
  183556. ** a separator character. Or break out of the loop if it is not. */
  183557. is = zCsr - (unsigned char*)pText;
  183558. READ_UTF8(zCsr, zTerm, iCode);
  183559. if( fts5UnicodeIsAlnum(p, iCode) ){
  183560. goto non_ascii_tokenchar;
  183561. }
  183562. }else{
  183563. if( a[*zCsr] ){
  183564. is = zCsr - (unsigned char*)pText;
  183565. goto ascii_tokenchar;
  183566. }
  183567. zCsr++;
  183568. }
  183569. }
  183570. /* Run through the tokenchars. Fold them into the output buffer along
  183571. ** the way. */
  183572. while( zCsr<zTerm ){
  183573. /* Grow the output buffer so that there is sufficient space to fit the
  183574. ** largest possible utf-8 character. */
  183575. if( zOut>pEnd ){
  183576. aFold = sqlite3_malloc(nFold*2);
  183577. if( aFold==0 ){
  183578. rc = SQLITE_NOMEM;
  183579. goto tokenize_done;
  183580. }
  183581. zOut = &aFold[zOut - p->aFold];
  183582. memcpy(aFold, p->aFold, nFold);
  183583. sqlite3_free(p->aFold);
  183584. p->aFold = aFold;
  183585. p->nFold = nFold = nFold*2;
  183586. pEnd = &aFold[nFold-6];
  183587. }
  183588. if( *zCsr & 0x80 ){
  183589. /* An non-ascii-range character. Fold it into the output buffer if
  183590. ** it is a token character, or break out of the loop if it is not. */
  183591. READ_UTF8(zCsr, zTerm, iCode);
  183592. if( fts5UnicodeIsAlnum(p,iCode)||sqlite3Fts5UnicodeIsdiacritic(iCode) ){
  183593. non_ascii_tokenchar:
  183594. iCode = sqlite3Fts5UnicodeFold(iCode, p->bRemoveDiacritic);
  183595. if( iCode ) WRITE_UTF8(zOut, iCode);
  183596. }else{
  183597. break;
  183598. }
  183599. }else if( a[*zCsr]==0 ){
  183600. /* An ascii-range separator character. End of token. */
  183601. break;
  183602. }else{
  183603. ascii_tokenchar:
  183604. if( *zCsr>='A' && *zCsr<='Z' ){
  183605. *zOut++ = *zCsr + 32;
  183606. }else{
  183607. *zOut++ = *zCsr;
  183608. }
  183609. zCsr++;
  183610. }
  183611. ie = zCsr - (unsigned char*)pText;
  183612. }
  183613. /* Invoke the token callback */
  183614. rc = xToken(pCtx, 0, aFold, zOut-aFold, is, ie);
  183615. }
  183616. tokenize_done:
  183617. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  183618. return rc;
  183619. }
  183620. /**************************************************************************
  183621. ** Start of porter stemmer implementation.
  183622. */
  183623. /* Any tokens larger than this (in bytes) are passed through without
  183624. ** stemming. */
  183625. #define FTS5_PORTER_MAX_TOKEN 64
  183626. typedef struct PorterTokenizer PorterTokenizer;
  183627. struct PorterTokenizer {
  183628. fts5_tokenizer tokenizer; /* Parent tokenizer module */
  183629. Fts5Tokenizer *pTokenizer; /* Parent tokenizer instance */
  183630. char aBuf[FTS5_PORTER_MAX_TOKEN + 64];
  183631. };
  183632. /*
  183633. ** Delete a "porter" tokenizer.
  183634. */
  183635. static void fts5PorterDelete(Fts5Tokenizer *pTok){
  183636. if( pTok ){
  183637. PorterTokenizer *p = (PorterTokenizer*)pTok;
  183638. if( p->pTokenizer ){
  183639. p->tokenizer.xDelete(p->pTokenizer);
  183640. }
  183641. sqlite3_free(p);
  183642. }
  183643. }
  183644. /*
  183645. ** Create a "porter" tokenizer.
  183646. */
  183647. static int fts5PorterCreate(
  183648. void *pCtx,
  183649. const char **azArg, int nArg,
  183650. Fts5Tokenizer **ppOut
  183651. ){
  183652. fts5_api *pApi = (fts5_api*)pCtx;
  183653. int rc = SQLITE_OK;
  183654. PorterTokenizer *pRet;
  183655. void *pUserdata = 0;
  183656. const char *zBase = "unicode61";
  183657. if( nArg>0 ){
  183658. zBase = azArg[0];
  183659. }
  183660. pRet = (PorterTokenizer*)sqlite3_malloc(sizeof(PorterTokenizer));
  183661. if( pRet ){
  183662. memset(pRet, 0, sizeof(PorterTokenizer));
  183663. rc = pApi->xFindTokenizer(pApi, zBase, &pUserdata, &pRet->tokenizer);
  183664. }else{
  183665. rc = SQLITE_NOMEM;
  183666. }
  183667. if( rc==SQLITE_OK ){
  183668. int nArg2 = (nArg>0 ? nArg-1 : 0);
  183669. const char **azArg2 = (nArg2 ? &azArg[1] : 0);
  183670. rc = pRet->tokenizer.xCreate(pUserdata, azArg2, nArg2, &pRet->pTokenizer);
  183671. }
  183672. if( rc!=SQLITE_OK ){
  183673. fts5PorterDelete((Fts5Tokenizer*)pRet);
  183674. pRet = 0;
  183675. }
  183676. *ppOut = (Fts5Tokenizer*)pRet;
  183677. return rc;
  183678. }
  183679. typedef struct PorterContext PorterContext;
  183680. struct PorterContext {
  183681. void *pCtx;
  183682. int (*xToken)(void*, int, const char*, int, int, int);
  183683. char *aBuf;
  183684. };
  183685. typedef struct PorterRule PorterRule;
  183686. struct PorterRule {
  183687. const char *zSuffix;
  183688. int nSuffix;
  183689. int (*xCond)(char *zStem, int nStem);
  183690. const char *zOutput;
  183691. int nOutput;
  183692. };
  183693. #if 0
  183694. static int fts5PorterApply(char *aBuf, int *pnBuf, PorterRule *aRule){
  183695. int ret = -1;
  183696. int nBuf = *pnBuf;
  183697. PorterRule *p;
  183698. for(p=aRule; p->zSuffix; p++){
  183699. assert( strlen(p->zSuffix)==p->nSuffix );
  183700. assert( strlen(p->zOutput)==p->nOutput );
  183701. if( nBuf<p->nSuffix ) continue;
  183702. if( 0==memcmp(&aBuf[nBuf - p->nSuffix], p->zSuffix, p->nSuffix) ) break;
  183703. }
  183704. if( p->zSuffix ){
  183705. int nStem = nBuf - p->nSuffix;
  183706. if( p->xCond==0 || p->xCond(aBuf, nStem) ){
  183707. memcpy(&aBuf[nStem], p->zOutput, p->nOutput);
  183708. *pnBuf = nStem + p->nOutput;
  183709. ret = p - aRule;
  183710. }
  183711. }
  183712. return ret;
  183713. }
  183714. #endif
  183715. static int fts5PorterIsVowel(char c, int bYIsVowel){
  183716. return (
  183717. c=='a' || c=='e' || c=='i' || c=='o' || c=='u' || (bYIsVowel && c=='y')
  183718. );
  183719. }
  183720. static int fts5PorterGobbleVC(char *zStem, int nStem, int bPrevCons){
  183721. int i;
  183722. int bCons = bPrevCons;
  183723. /* Scan for a vowel */
  183724. for(i=0; i<nStem; i++){
  183725. if( 0==(bCons = !fts5PorterIsVowel(zStem[i], bCons)) ) break;
  183726. }
  183727. /* Scan for a consonent */
  183728. for(i++; i<nStem; i++){
  183729. if( (bCons = !fts5PorterIsVowel(zStem[i], bCons)) ) return i+1;
  183730. }
  183731. return 0;
  183732. }
  183733. /* porter rule condition: (m > 0) */
  183734. static int fts5Porter_MGt0(char *zStem, int nStem){
  183735. return !!fts5PorterGobbleVC(zStem, nStem, 0);
  183736. }
  183737. /* porter rule condition: (m > 1) */
  183738. static int fts5Porter_MGt1(char *zStem, int nStem){
  183739. int n;
  183740. n = fts5PorterGobbleVC(zStem, nStem, 0);
  183741. if( n && fts5PorterGobbleVC(&zStem[n], nStem-n, 1) ){
  183742. return 1;
  183743. }
  183744. return 0;
  183745. }
  183746. /* porter rule condition: (m = 1) */
  183747. static int fts5Porter_MEq1(char *zStem, int nStem){
  183748. int n;
  183749. n = fts5PorterGobbleVC(zStem, nStem, 0);
  183750. if( n && 0==fts5PorterGobbleVC(&zStem[n], nStem-n, 1) ){
  183751. return 1;
  183752. }
  183753. return 0;
  183754. }
  183755. /* porter rule condition: (*o) */
  183756. static int fts5Porter_Ostar(char *zStem, int nStem){
  183757. if( zStem[nStem-1]=='w' || zStem[nStem-1]=='x' || zStem[nStem-1]=='y' ){
  183758. return 0;
  183759. }else{
  183760. int i;
  183761. int mask = 0;
  183762. int bCons = 0;
  183763. for(i=0; i<nStem; i++){
  183764. bCons = !fts5PorterIsVowel(zStem[i], bCons);
  183765. assert( bCons==0 || bCons==1 );
  183766. mask = (mask << 1) + bCons;
  183767. }
  183768. return ((mask & 0x0007)==0x0005);
  183769. }
  183770. }
  183771. /* porter rule condition: (m > 1 and (*S or *T)) */
  183772. static int fts5Porter_MGt1_and_S_or_T(char *zStem, int nStem){
  183773. assert( nStem>0 );
  183774. return (zStem[nStem-1]=='s' || zStem[nStem-1]=='t')
  183775. && fts5Porter_MGt1(zStem, nStem);
  183776. }
  183777. /* porter rule condition: (*v*) */
  183778. static int fts5Porter_Vowel(char *zStem, int nStem){
  183779. int i;
  183780. for(i=0; i<nStem; i++){
  183781. if( fts5PorterIsVowel(zStem[i], i>0) ){
  183782. return 1;
  183783. }
  183784. }
  183785. return 0;
  183786. }
  183787. /**************************************************************************
  183788. ***************************************************************************
  183789. ** GENERATED CODE STARTS HERE (mkportersteps.tcl)
  183790. */
  183791. static int fts5PorterStep4(char *aBuf, int *pnBuf){
  183792. int ret = 0;
  183793. int nBuf = *pnBuf;
  183794. switch( aBuf[nBuf-2] ){
  183795. case 'a':
  183796. if( nBuf>2 && 0==memcmp("al", &aBuf[nBuf-2], 2) ){
  183797. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  183798. *pnBuf = nBuf - 2;
  183799. }
  183800. }
  183801. break;
  183802. case 'c':
  183803. if( nBuf>4 && 0==memcmp("ance", &aBuf[nBuf-4], 4) ){
  183804. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  183805. *pnBuf = nBuf - 4;
  183806. }
  183807. }else if( nBuf>4 && 0==memcmp("ence", &aBuf[nBuf-4], 4) ){
  183808. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  183809. *pnBuf = nBuf - 4;
  183810. }
  183811. }
  183812. break;
  183813. case 'e':
  183814. if( nBuf>2 && 0==memcmp("er", &aBuf[nBuf-2], 2) ){
  183815. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  183816. *pnBuf = nBuf - 2;
  183817. }
  183818. }
  183819. break;
  183820. case 'i':
  183821. if( nBuf>2 && 0==memcmp("ic", &aBuf[nBuf-2], 2) ){
  183822. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  183823. *pnBuf = nBuf - 2;
  183824. }
  183825. }
  183826. break;
  183827. case 'l':
  183828. if( nBuf>4 && 0==memcmp("able", &aBuf[nBuf-4], 4) ){
  183829. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  183830. *pnBuf = nBuf - 4;
  183831. }
  183832. }else if( nBuf>4 && 0==memcmp("ible", &aBuf[nBuf-4], 4) ){
  183833. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  183834. *pnBuf = nBuf - 4;
  183835. }
  183836. }
  183837. break;
  183838. case 'n':
  183839. if( nBuf>3 && 0==memcmp("ant", &aBuf[nBuf-3], 3) ){
  183840. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183841. *pnBuf = nBuf - 3;
  183842. }
  183843. }else if( nBuf>5 && 0==memcmp("ement", &aBuf[nBuf-5], 5) ){
  183844. if( fts5Porter_MGt1(aBuf, nBuf-5) ){
  183845. *pnBuf = nBuf - 5;
  183846. }
  183847. }else if( nBuf>4 && 0==memcmp("ment", &aBuf[nBuf-4], 4) ){
  183848. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  183849. *pnBuf = nBuf - 4;
  183850. }
  183851. }else if( nBuf>3 && 0==memcmp("ent", &aBuf[nBuf-3], 3) ){
  183852. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183853. *pnBuf = nBuf - 3;
  183854. }
  183855. }
  183856. break;
  183857. case 'o':
  183858. if( nBuf>3 && 0==memcmp("ion", &aBuf[nBuf-3], 3) ){
  183859. if( fts5Porter_MGt1_and_S_or_T(aBuf, nBuf-3) ){
  183860. *pnBuf = nBuf - 3;
  183861. }
  183862. }else if( nBuf>2 && 0==memcmp("ou", &aBuf[nBuf-2], 2) ){
  183863. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  183864. *pnBuf = nBuf - 2;
  183865. }
  183866. }
  183867. break;
  183868. case 's':
  183869. if( nBuf>3 && 0==memcmp("ism", &aBuf[nBuf-3], 3) ){
  183870. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183871. *pnBuf = nBuf - 3;
  183872. }
  183873. }
  183874. break;
  183875. case 't':
  183876. if( nBuf>3 && 0==memcmp("ate", &aBuf[nBuf-3], 3) ){
  183877. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183878. *pnBuf = nBuf - 3;
  183879. }
  183880. }else if( nBuf>3 && 0==memcmp("iti", &aBuf[nBuf-3], 3) ){
  183881. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183882. *pnBuf = nBuf - 3;
  183883. }
  183884. }
  183885. break;
  183886. case 'u':
  183887. if( nBuf>3 && 0==memcmp("ous", &aBuf[nBuf-3], 3) ){
  183888. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183889. *pnBuf = nBuf - 3;
  183890. }
  183891. }
  183892. break;
  183893. case 'v':
  183894. if( nBuf>3 && 0==memcmp("ive", &aBuf[nBuf-3], 3) ){
  183895. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183896. *pnBuf = nBuf - 3;
  183897. }
  183898. }
  183899. break;
  183900. case 'z':
  183901. if( nBuf>3 && 0==memcmp("ize", &aBuf[nBuf-3], 3) ){
  183902. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  183903. *pnBuf = nBuf - 3;
  183904. }
  183905. }
  183906. break;
  183907. }
  183908. return ret;
  183909. }
  183910. static int fts5PorterStep1B2(char *aBuf, int *pnBuf){
  183911. int ret = 0;
  183912. int nBuf = *pnBuf;
  183913. switch( aBuf[nBuf-2] ){
  183914. case 'a':
  183915. if( nBuf>2 && 0==memcmp("at", &aBuf[nBuf-2], 2) ){
  183916. memcpy(&aBuf[nBuf-2], "ate", 3);
  183917. *pnBuf = nBuf - 2 + 3;
  183918. ret = 1;
  183919. }
  183920. break;
  183921. case 'b':
  183922. if( nBuf>2 && 0==memcmp("bl", &aBuf[nBuf-2], 2) ){
  183923. memcpy(&aBuf[nBuf-2], "ble", 3);
  183924. *pnBuf = nBuf - 2 + 3;
  183925. ret = 1;
  183926. }
  183927. break;
  183928. case 'i':
  183929. if( nBuf>2 && 0==memcmp("iz", &aBuf[nBuf-2], 2) ){
  183930. memcpy(&aBuf[nBuf-2], "ize", 3);
  183931. *pnBuf = nBuf - 2 + 3;
  183932. ret = 1;
  183933. }
  183934. break;
  183935. }
  183936. return ret;
  183937. }
  183938. static int fts5PorterStep2(char *aBuf, int *pnBuf){
  183939. int ret = 0;
  183940. int nBuf = *pnBuf;
  183941. switch( aBuf[nBuf-2] ){
  183942. case 'a':
  183943. if( nBuf>7 && 0==memcmp("ational", &aBuf[nBuf-7], 7) ){
  183944. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  183945. memcpy(&aBuf[nBuf-7], "ate", 3);
  183946. *pnBuf = nBuf - 7 + 3;
  183947. }
  183948. }else if( nBuf>6 && 0==memcmp("tional", &aBuf[nBuf-6], 6) ){
  183949. if( fts5Porter_MGt0(aBuf, nBuf-6) ){
  183950. memcpy(&aBuf[nBuf-6], "tion", 4);
  183951. *pnBuf = nBuf - 6 + 4;
  183952. }
  183953. }
  183954. break;
  183955. case 'c':
  183956. if( nBuf>4 && 0==memcmp("enci", &aBuf[nBuf-4], 4) ){
  183957. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  183958. memcpy(&aBuf[nBuf-4], "ence", 4);
  183959. *pnBuf = nBuf - 4 + 4;
  183960. }
  183961. }else if( nBuf>4 && 0==memcmp("anci", &aBuf[nBuf-4], 4) ){
  183962. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  183963. memcpy(&aBuf[nBuf-4], "ance", 4);
  183964. *pnBuf = nBuf - 4 + 4;
  183965. }
  183966. }
  183967. break;
  183968. case 'e':
  183969. if( nBuf>4 && 0==memcmp("izer", &aBuf[nBuf-4], 4) ){
  183970. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  183971. memcpy(&aBuf[nBuf-4], "ize", 3);
  183972. *pnBuf = nBuf - 4 + 3;
  183973. }
  183974. }
  183975. break;
  183976. case 'g':
  183977. if( nBuf>4 && 0==memcmp("logi", &aBuf[nBuf-4], 4) ){
  183978. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  183979. memcpy(&aBuf[nBuf-4], "log", 3);
  183980. *pnBuf = nBuf - 4 + 3;
  183981. }
  183982. }
  183983. break;
  183984. case 'l':
  183985. if( nBuf>3 && 0==memcmp("bli", &aBuf[nBuf-3], 3) ){
  183986. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  183987. memcpy(&aBuf[nBuf-3], "ble", 3);
  183988. *pnBuf = nBuf - 3 + 3;
  183989. }
  183990. }else if( nBuf>4 && 0==memcmp("alli", &aBuf[nBuf-4], 4) ){
  183991. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  183992. memcpy(&aBuf[nBuf-4], "al", 2);
  183993. *pnBuf = nBuf - 4 + 2;
  183994. }
  183995. }else if( nBuf>5 && 0==memcmp("entli", &aBuf[nBuf-5], 5) ){
  183996. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  183997. memcpy(&aBuf[nBuf-5], "ent", 3);
  183998. *pnBuf = nBuf - 5 + 3;
  183999. }
  184000. }else if( nBuf>3 && 0==memcmp("eli", &aBuf[nBuf-3], 3) ){
  184001. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  184002. memcpy(&aBuf[nBuf-3], "e", 1);
  184003. *pnBuf = nBuf - 3 + 1;
  184004. }
  184005. }else if( nBuf>5 && 0==memcmp("ousli", &aBuf[nBuf-5], 5) ){
  184006. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184007. memcpy(&aBuf[nBuf-5], "ous", 3);
  184008. *pnBuf = nBuf - 5 + 3;
  184009. }
  184010. }
  184011. break;
  184012. case 'o':
  184013. if( nBuf>7 && 0==memcmp("ization", &aBuf[nBuf-7], 7) ){
  184014. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  184015. memcpy(&aBuf[nBuf-7], "ize", 3);
  184016. *pnBuf = nBuf - 7 + 3;
  184017. }
  184018. }else if( nBuf>5 && 0==memcmp("ation", &aBuf[nBuf-5], 5) ){
  184019. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184020. memcpy(&aBuf[nBuf-5], "ate", 3);
  184021. *pnBuf = nBuf - 5 + 3;
  184022. }
  184023. }else if( nBuf>4 && 0==memcmp("ator", &aBuf[nBuf-4], 4) ){
  184024. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  184025. memcpy(&aBuf[nBuf-4], "ate", 3);
  184026. *pnBuf = nBuf - 4 + 3;
  184027. }
  184028. }
  184029. break;
  184030. case 's':
  184031. if( nBuf>5 && 0==memcmp("alism", &aBuf[nBuf-5], 5) ){
  184032. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184033. memcpy(&aBuf[nBuf-5], "al", 2);
  184034. *pnBuf = nBuf - 5 + 2;
  184035. }
  184036. }else if( nBuf>7 && 0==memcmp("iveness", &aBuf[nBuf-7], 7) ){
  184037. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  184038. memcpy(&aBuf[nBuf-7], "ive", 3);
  184039. *pnBuf = nBuf - 7 + 3;
  184040. }
  184041. }else if( nBuf>7 && 0==memcmp("fulness", &aBuf[nBuf-7], 7) ){
  184042. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  184043. memcpy(&aBuf[nBuf-7], "ful", 3);
  184044. *pnBuf = nBuf - 7 + 3;
  184045. }
  184046. }else if( nBuf>7 && 0==memcmp("ousness", &aBuf[nBuf-7], 7) ){
  184047. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  184048. memcpy(&aBuf[nBuf-7], "ous", 3);
  184049. *pnBuf = nBuf - 7 + 3;
  184050. }
  184051. }
  184052. break;
  184053. case 't':
  184054. if( nBuf>5 && 0==memcmp("aliti", &aBuf[nBuf-5], 5) ){
  184055. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184056. memcpy(&aBuf[nBuf-5], "al", 2);
  184057. *pnBuf = nBuf - 5 + 2;
  184058. }
  184059. }else if( nBuf>5 && 0==memcmp("iviti", &aBuf[nBuf-5], 5) ){
  184060. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184061. memcpy(&aBuf[nBuf-5], "ive", 3);
  184062. *pnBuf = nBuf - 5 + 3;
  184063. }
  184064. }else if( nBuf>6 && 0==memcmp("biliti", &aBuf[nBuf-6], 6) ){
  184065. if( fts5Porter_MGt0(aBuf, nBuf-6) ){
  184066. memcpy(&aBuf[nBuf-6], "ble", 3);
  184067. *pnBuf = nBuf - 6 + 3;
  184068. }
  184069. }
  184070. break;
  184071. }
  184072. return ret;
  184073. }
  184074. static int fts5PorterStep3(char *aBuf, int *pnBuf){
  184075. int ret = 0;
  184076. int nBuf = *pnBuf;
  184077. switch( aBuf[nBuf-2] ){
  184078. case 'a':
  184079. if( nBuf>4 && 0==memcmp("ical", &aBuf[nBuf-4], 4) ){
  184080. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  184081. memcpy(&aBuf[nBuf-4], "ic", 2);
  184082. *pnBuf = nBuf - 4 + 2;
  184083. }
  184084. }
  184085. break;
  184086. case 's':
  184087. if( nBuf>4 && 0==memcmp("ness", &aBuf[nBuf-4], 4) ){
  184088. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  184089. *pnBuf = nBuf - 4;
  184090. }
  184091. }
  184092. break;
  184093. case 't':
  184094. if( nBuf>5 && 0==memcmp("icate", &aBuf[nBuf-5], 5) ){
  184095. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184096. memcpy(&aBuf[nBuf-5], "ic", 2);
  184097. *pnBuf = nBuf - 5 + 2;
  184098. }
  184099. }else if( nBuf>5 && 0==memcmp("iciti", &aBuf[nBuf-5], 5) ){
  184100. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184101. memcpy(&aBuf[nBuf-5], "ic", 2);
  184102. *pnBuf = nBuf - 5 + 2;
  184103. }
  184104. }
  184105. break;
  184106. case 'u':
  184107. if( nBuf>3 && 0==memcmp("ful", &aBuf[nBuf-3], 3) ){
  184108. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  184109. *pnBuf = nBuf - 3;
  184110. }
  184111. }
  184112. break;
  184113. case 'v':
  184114. if( nBuf>5 && 0==memcmp("ative", &aBuf[nBuf-5], 5) ){
  184115. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184116. *pnBuf = nBuf - 5;
  184117. }
  184118. }
  184119. break;
  184120. case 'z':
  184121. if( nBuf>5 && 0==memcmp("alize", &aBuf[nBuf-5], 5) ){
  184122. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  184123. memcpy(&aBuf[nBuf-5], "al", 2);
  184124. *pnBuf = nBuf - 5 + 2;
  184125. }
  184126. }
  184127. break;
  184128. }
  184129. return ret;
  184130. }
  184131. static int fts5PorterStep1B(char *aBuf, int *pnBuf){
  184132. int ret = 0;
  184133. int nBuf = *pnBuf;
  184134. switch( aBuf[nBuf-2] ){
  184135. case 'e':
  184136. if( nBuf>3 && 0==memcmp("eed", &aBuf[nBuf-3], 3) ){
  184137. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  184138. memcpy(&aBuf[nBuf-3], "ee", 2);
  184139. *pnBuf = nBuf - 3 + 2;
  184140. }
  184141. }else if( nBuf>2 && 0==memcmp("ed", &aBuf[nBuf-2], 2) ){
  184142. if( fts5Porter_Vowel(aBuf, nBuf-2) ){
  184143. *pnBuf = nBuf - 2;
  184144. ret = 1;
  184145. }
  184146. }
  184147. break;
  184148. case 'n':
  184149. if( nBuf>3 && 0==memcmp("ing", &aBuf[nBuf-3], 3) ){
  184150. if( fts5Porter_Vowel(aBuf, nBuf-3) ){
  184151. *pnBuf = nBuf - 3;
  184152. ret = 1;
  184153. }
  184154. }
  184155. break;
  184156. }
  184157. return ret;
  184158. }
  184159. /*
  184160. ** GENERATED CODE ENDS HERE (mkportersteps.tcl)
  184161. ***************************************************************************
  184162. **************************************************************************/
  184163. static void fts5PorterStep1A(char *aBuf, int *pnBuf){
  184164. int nBuf = *pnBuf;
  184165. if( aBuf[nBuf-1]=='s' ){
  184166. if( aBuf[nBuf-2]=='e' ){
  184167. if( (nBuf>4 && aBuf[nBuf-4]=='s' && aBuf[nBuf-3]=='s')
  184168. || (nBuf>3 && aBuf[nBuf-3]=='i' )
  184169. ){
  184170. *pnBuf = nBuf-2;
  184171. }else{
  184172. *pnBuf = nBuf-1;
  184173. }
  184174. }
  184175. else if( aBuf[nBuf-2]!='s' ){
  184176. *pnBuf = nBuf-1;
  184177. }
  184178. }
  184179. }
  184180. static int fts5PorterCb(
  184181. void *pCtx,
  184182. int tflags,
  184183. const char *pToken,
  184184. int nToken,
  184185. int iStart,
  184186. int iEnd
  184187. ){
  184188. PorterContext *p = (PorterContext*)pCtx;
  184189. char *aBuf;
  184190. int nBuf;
  184191. if( nToken>FTS5_PORTER_MAX_TOKEN || nToken<3 ) goto pass_through;
  184192. aBuf = p->aBuf;
  184193. nBuf = nToken;
  184194. memcpy(aBuf, pToken, nBuf);
  184195. /* Step 1. */
  184196. fts5PorterStep1A(aBuf, &nBuf);
  184197. if( fts5PorterStep1B(aBuf, &nBuf) ){
  184198. if( fts5PorterStep1B2(aBuf, &nBuf)==0 ){
  184199. char c = aBuf[nBuf-1];
  184200. if( fts5PorterIsVowel(c, 0)==0
  184201. && c!='l' && c!='s' && c!='z' && c==aBuf[nBuf-2]
  184202. ){
  184203. nBuf--;
  184204. }else if( fts5Porter_MEq1(aBuf, nBuf) && fts5Porter_Ostar(aBuf, nBuf) ){
  184205. aBuf[nBuf++] = 'e';
  184206. }
  184207. }
  184208. }
  184209. /* Step 1C. */
  184210. if( aBuf[nBuf-1]=='y' && fts5Porter_Vowel(aBuf, nBuf-1) ){
  184211. aBuf[nBuf-1] = 'i';
  184212. }
  184213. /* Steps 2 through 4. */
  184214. fts5PorterStep2(aBuf, &nBuf);
  184215. fts5PorterStep3(aBuf, &nBuf);
  184216. fts5PorterStep4(aBuf, &nBuf);
  184217. /* Step 5a. */
  184218. assert( nBuf>0 );
  184219. if( aBuf[nBuf-1]=='e' ){
  184220. if( fts5Porter_MGt1(aBuf, nBuf-1)
  184221. || (fts5Porter_MEq1(aBuf, nBuf-1) && !fts5Porter_Ostar(aBuf, nBuf-1))
  184222. ){
  184223. nBuf--;
  184224. }
  184225. }
  184226. /* Step 5b. */
  184227. if( nBuf>1 && aBuf[nBuf-1]=='l'
  184228. && aBuf[nBuf-2]=='l' && fts5Porter_MGt1(aBuf, nBuf-1)
  184229. ){
  184230. nBuf--;
  184231. }
  184232. return p->xToken(p->pCtx, tflags, aBuf, nBuf, iStart, iEnd);
  184233. pass_through:
  184234. return p->xToken(p->pCtx, tflags, pToken, nToken, iStart, iEnd);
  184235. }
  184236. /*
  184237. ** Tokenize using the porter tokenizer.
  184238. */
  184239. static int fts5PorterTokenize(
  184240. Fts5Tokenizer *pTokenizer,
  184241. void *pCtx,
  184242. int flags,
  184243. const char *pText, int nText,
  184244. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  184245. ){
  184246. PorterTokenizer *p = (PorterTokenizer*)pTokenizer;
  184247. PorterContext sCtx;
  184248. sCtx.xToken = xToken;
  184249. sCtx.pCtx = pCtx;
  184250. sCtx.aBuf = p->aBuf;
  184251. return p->tokenizer.xTokenize(
  184252. p->pTokenizer, (void*)&sCtx, flags, pText, nText, fts5PorterCb
  184253. );
  184254. }
  184255. /*
  184256. ** Register all built-in tokenizers with FTS5.
  184257. */
  184258. static int sqlite3Fts5TokenizerInit(fts5_api *pApi){
  184259. struct BuiltinTokenizer {
  184260. const char *zName;
  184261. fts5_tokenizer x;
  184262. } aBuiltin[] = {
  184263. { "unicode61", {fts5UnicodeCreate, fts5UnicodeDelete, fts5UnicodeTokenize}},
  184264. { "ascii", {fts5AsciiCreate, fts5AsciiDelete, fts5AsciiTokenize }},
  184265. { "porter", {fts5PorterCreate, fts5PorterDelete, fts5PorterTokenize }},
  184266. };
  184267. int rc = SQLITE_OK; /* Return code */
  184268. int i; /* To iterate through builtin functions */
  184269. for(i=0; rc==SQLITE_OK && i<ArraySize(aBuiltin); i++){
  184270. rc = pApi->xCreateTokenizer(pApi,
  184271. aBuiltin[i].zName,
  184272. (void*)pApi,
  184273. &aBuiltin[i].x,
  184274. 0
  184275. );
  184276. }
  184277. return rc;
  184278. }
  184279. /*
  184280. ** 2012 May 25
  184281. **
  184282. ** The author disclaims copyright to this source code. In place of
  184283. ** a legal notice, here is a blessing:
  184284. **
  184285. ** May you do good and not evil.
  184286. ** May you find forgiveness for yourself and forgive others.
  184287. ** May you share freely, never taking more than you give.
  184288. **
  184289. ******************************************************************************
  184290. */
  184291. /*
  184292. ** DO NOT EDIT THIS MACHINE GENERATED FILE.
  184293. */
  184294. /* #include <assert.h> */
  184295. /*
  184296. ** Return true if the argument corresponds to a unicode codepoint
  184297. ** classified as either a letter or a number. Otherwise false.
  184298. **
  184299. ** The results are undefined if the value passed to this function
  184300. ** is less than zero.
  184301. */
  184302. static int sqlite3Fts5UnicodeIsalnum(int c){
  184303. /* Each unsigned integer in the following array corresponds to a contiguous
  184304. ** range of unicode codepoints that are not either letters or numbers (i.e.
  184305. ** codepoints for which this function should return 0).
  184306. **
  184307. ** The most significant 22 bits in each 32-bit value contain the first
  184308. ** codepoint in the range. The least significant 10 bits are used to store
  184309. ** the size of the range (always at least 1). In other words, the value
  184310. ** ((C<<22) + N) represents a range of N codepoints starting with codepoint
  184311. ** C. It is not possible to represent a range larger than 1023 codepoints
  184312. ** using this format.
  184313. */
  184314. static const unsigned int aEntry[] = {
  184315. 0x00000030, 0x0000E807, 0x00016C06, 0x0001EC2F, 0x0002AC07,
  184316. 0x0002D001, 0x0002D803, 0x0002EC01, 0x0002FC01, 0x00035C01,
  184317. 0x0003DC01, 0x000B0804, 0x000B480E, 0x000B9407, 0x000BB401,
  184318. 0x000BBC81, 0x000DD401, 0x000DF801, 0x000E1002, 0x000E1C01,
  184319. 0x000FD801, 0x00120808, 0x00156806, 0x00162402, 0x00163C01,
  184320. 0x00164437, 0x0017CC02, 0x00180005, 0x00181816, 0x00187802,
  184321. 0x00192C15, 0x0019A804, 0x0019C001, 0x001B5001, 0x001B580F,
  184322. 0x001B9C07, 0x001BF402, 0x001C000E, 0x001C3C01, 0x001C4401,
  184323. 0x001CC01B, 0x001E980B, 0x001FAC09, 0x001FD804, 0x00205804,
  184324. 0x00206C09, 0x00209403, 0x0020A405, 0x0020C00F, 0x00216403,
  184325. 0x00217801, 0x0023901B, 0x00240004, 0x0024E803, 0x0024F812,
  184326. 0x00254407, 0x00258804, 0x0025C001, 0x00260403, 0x0026F001,
  184327. 0x0026F807, 0x00271C02, 0x00272C03, 0x00275C01, 0x00278802,
  184328. 0x0027C802, 0x0027E802, 0x00280403, 0x0028F001, 0x0028F805,
  184329. 0x00291C02, 0x00292C03, 0x00294401, 0x0029C002, 0x0029D401,
  184330. 0x002A0403, 0x002AF001, 0x002AF808, 0x002B1C03, 0x002B2C03,
  184331. 0x002B8802, 0x002BC002, 0x002C0403, 0x002CF001, 0x002CF807,
  184332. 0x002D1C02, 0x002D2C03, 0x002D5802, 0x002D8802, 0x002DC001,
  184333. 0x002E0801, 0x002EF805, 0x002F1803, 0x002F2804, 0x002F5C01,
  184334. 0x002FCC08, 0x00300403, 0x0030F807, 0x00311803, 0x00312804,
  184335. 0x00315402, 0x00318802, 0x0031FC01, 0x00320802, 0x0032F001,
  184336. 0x0032F807, 0x00331803, 0x00332804, 0x00335402, 0x00338802,
  184337. 0x00340802, 0x0034F807, 0x00351803, 0x00352804, 0x00355C01,
  184338. 0x00358802, 0x0035E401, 0x00360802, 0x00372801, 0x00373C06,
  184339. 0x00375801, 0x00376008, 0x0037C803, 0x0038C401, 0x0038D007,
  184340. 0x0038FC01, 0x00391C09, 0x00396802, 0x003AC401, 0x003AD006,
  184341. 0x003AEC02, 0x003B2006, 0x003C041F, 0x003CD00C, 0x003DC417,
  184342. 0x003E340B, 0x003E6424, 0x003EF80F, 0x003F380D, 0x0040AC14,
  184343. 0x00412806, 0x00415804, 0x00417803, 0x00418803, 0x00419C07,
  184344. 0x0041C404, 0x0042080C, 0x00423C01, 0x00426806, 0x0043EC01,
  184345. 0x004D740C, 0x004E400A, 0x00500001, 0x0059B402, 0x005A0001,
  184346. 0x005A6C02, 0x005BAC03, 0x005C4803, 0x005CC805, 0x005D4802,
  184347. 0x005DC802, 0x005ED023, 0x005F6004, 0x005F7401, 0x0060000F,
  184348. 0x0062A401, 0x0064800C, 0x0064C00C, 0x00650001, 0x00651002,
  184349. 0x0066C011, 0x00672002, 0x00677822, 0x00685C05, 0x00687802,
  184350. 0x0069540A, 0x0069801D, 0x0069FC01, 0x006A8007, 0x006AA006,
  184351. 0x006C0005, 0x006CD011, 0x006D6823, 0x006E0003, 0x006E840D,
  184352. 0x006F980E, 0x006FF004, 0x00709014, 0x0070EC05, 0x0071F802,
  184353. 0x00730008, 0x00734019, 0x0073B401, 0x0073C803, 0x00770027,
  184354. 0x0077F004, 0x007EF401, 0x007EFC03, 0x007F3403, 0x007F7403,
  184355. 0x007FB403, 0x007FF402, 0x00800065, 0x0081A806, 0x0081E805,
  184356. 0x00822805, 0x0082801A, 0x00834021, 0x00840002, 0x00840C04,
  184357. 0x00842002, 0x00845001, 0x00845803, 0x00847806, 0x00849401,
  184358. 0x00849C01, 0x0084A401, 0x0084B801, 0x0084E802, 0x00850005,
  184359. 0x00852804, 0x00853C01, 0x00864264, 0x00900027, 0x0091000B,
  184360. 0x0092704E, 0x00940200, 0x009C0475, 0x009E53B9, 0x00AD400A,
  184361. 0x00B39406, 0x00B3BC03, 0x00B3E404, 0x00B3F802, 0x00B5C001,
  184362. 0x00B5FC01, 0x00B7804F, 0x00B8C00C, 0x00BA001A, 0x00BA6C59,
  184363. 0x00BC00D6, 0x00BFC00C, 0x00C00005, 0x00C02019, 0x00C0A807,
  184364. 0x00C0D802, 0x00C0F403, 0x00C26404, 0x00C28001, 0x00C3EC01,
  184365. 0x00C64002, 0x00C6580A, 0x00C70024, 0x00C8001F, 0x00C8A81E,
  184366. 0x00C94001, 0x00C98020, 0x00CA2827, 0x00CB003F, 0x00CC0100,
  184367. 0x01370040, 0x02924037, 0x0293F802, 0x02983403, 0x0299BC10,
  184368. 0x029A7C01, 0x029BC008, 0x029C0017, 0x029C8002, 0x029E2402,
  184369. 0x02A00801, 0x02A01801, 0x02A02C01, 0x02A08C09, 0x02A0D804,
  184370. 0x02A1D004, 0x02A20002, 0x02A2D011, 0x02A33802, 0x02A38012,
  184371. 0x02A3E003, 0x02A4980A, 0x02A51C0D, 0x02A57C01, 0x02A60004,
  184372. 0x02A6CC1B, 0x02A77802, 0x02A8A40E, 0x02A90C01, 0x02A93002,
  184373. 0x02A97004, 0x02A9DC03, 0x02A9EC01, 0x02AAC001, 0x02AAC803,
  184374. 0x02AADC02, 0x02AAF802, 0x02AB0401, 0x02AB7802, 0x02ABAC07,
  184375. 0x02ABD402, 0x02AF8C0B, 0x03600001, 0x036DFC02, 0x036FFC02,
  184376. 0x037FFC01, 0x03EC7801, 0x03ECA401, 0x03EEC810, 0x03F4F802,
  184377. 0x03F7F002, 0x03F8001A, 0x03F88007, 0x03F8C023, 0x03F95013,
  184378. 0x03F9A004, 0x03FBFC01, 0x03FC040F, 0x03FC6807, 0x03FCEC06,
  184379. 0x03FD6C0B, 0x03FF8007, 0x03FFA007, 0x03FFE405, 0x04040003,
  184380. 0x0404DC09, 0x0405E411, 0x0406400C, 0x0407402E, 0x040E7C01,
  184381. 0x040F4001, 0x04215C01, 0x04247C01, 0x0424FC01, 0x04280403,
  184382. 0x04281402, 0x04283004, 0x0428E003, 0x0428FC01, 0x04294009,
  184383. 0x0429FC01, 0x042CE407, 0x04400003, 0x0440E016, 0x04420003,
  184384. 0x0442C012, 0x04440003, 0x04449C0E, 0x04450004, 0x04460003,
  184385. 0x0446CC0E, 0x04471404, 0x045AAC0D, 0x0491C004, 0x05BD442E,
  184386. 0x05BE3C04, 0x074000F6, 0x07440027, 0x0744A4B5, 0x07480046,
  184387. 0x074C0057, 0x075B0401, 0x075B6C01, 0x075BEC01, 0x075C5401,
  184388. 0x075CD401, 0x075D3C01, 0x075DBC01, 0x075E2401, 0x075EA401,
  184389. 0x075F0C01, 0x07BBC002, 0x07C0002C, 0x07C0C064, 0x07C2800F,
  184390. 0x07C2C40E, 0x07C3040F, 0x07C3440F, 0x07C4401F, 0x07C4C03C,
  184391. 0x07C5C02B, 0x07C7981D, 0x07C8402B, 0x07C90009, 0x07C94002,
  184392. 0x07CC0021, 0x07CCC006, 0x07CCDC46, 0x07CE0014, 0x07CE8025,
  184393. 0x07CF1805, 0x07CF8011, 0x07D0003F, 0x07D10001, 0x07D108B6,
  184394. 0x07D3E404, 0x07D4003E, 0x07D50004, 0x07D54018, 0x07D7EC46,
  184395. 0x07D9140B, 0x07DA0046, 0x07DC0074, 0x38000401, 0x38008060,
  184396. 0x380400F0,
  184397. };
  184398. static const unsigned int aAscii[4] = {
  184399. 0xFFFFFFFF, 0xFC00FFFF, 0xF8000001, 0xF8000001,
  184400. };
  184401. if( (unsigned int)c<128 ){
  184402. return ( (aAscii[c >> 5] & (1 << (c & 0x001F)))==0 );
  184403. }else if( (unsigned int)c<(1<<22) ){
  184404. unsigned int key = (((unsigned int)c)<<10) | 0x000003FF;
  184405. int iRes = 0;
  184406. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  184407. int iLo = 0;
  184408. while( iHi>=iLo ){
  184409. int iTest = (iHi + iLo) / 2;
  184410. if( key >= aEntry[iTest] ){
  184411. iRes = iTest;
  184412. iLo = iTest+1;
  184413. }else{
  184414. iHi = iTest-1;
  184415. }
  184416. }
  184417. assert( aEntry[0]<key );
  184418. assert( key>=aEntry[iRes] );
  184419. return (((unsigned int)c) >= ((aEntry[iRes]>>10) + (aEntry[iRes]&0x3FF)));
  184420. }
  184421. return 1;
  184422. }
  184423. /*
  184424. ** If the argument is a codepoint corresponding to a lowercase letter
  184425. ** in the ASCII range with a diacritic added, return the codepoint
  184426. ** of the ASCII letter only. For example, if passed 235 - "LATIN
  184427. ** SMALL LETTER E WITH DIAERESIS" - return 65 ("LATIN SMALL LETTER
  184428. ** E"). The resuls of passing a codepoint that corresponds to an
  184429. ** uppercase letter are undefined.
  184430. */
  184431. static int fts5_remove_diacritic(int c){
  184432. unsigned short aDia[] = {
  184433. 0, 1797, 1848, 1859, 1891, 1928, 1940, 1995,
  184434. 2024, 2040, 2060, 2110, 2168, 2206, 2264, 2286,
  184435. 2344, 2383, 2472, 2488, 2516, 2596, 2668, 2732,
  184436. 2782, 2842, 2894, 2954, 2984, 3000, 3028, 3336,
  184437. 3456, 3696, 3712, 3728, 3744, 3896, 3912, 3928,
  184438. 3968, 4008, 4040, 4106, 4138, 4170, 4202, 4234,
  184439. 4266, 4296, 4312, 4344, 4408, 4424, 4472, 4504,
  184440. 6148, 6198, 6264, 6280, 6360, 6429, 6505, 6529,
  184441. 61448, 61468, 61534, 61592, 61642, 61688, 61704, 61726,
  184442. 61784, 61800, 61836, 61880, 61914, 61948, 61998, 62122,
  184443. 62154, 62200, 62218, 62302, 62364, 62442, 62478, 62536,
  184444. 62554, 62584, 62604, 62640, 62648, 62656, 62664, 62730,
  184445. 62924, 63050, 63082, 63274, 63390,
  184446. };
  184447. char aChar[] = {
  184448. '\0', 'a', 'c', 'e', 'i', 'n', 'o', 'u', 'y', 'y', 'a', 'c',
  184449. 'd', 'e', 'e', 'g', 'h', 'i', 'j', 'k', 'l', 'n', 'o', 'r',
  184450. 's', 't', 'u', 'u', 'w', 'y', 'z', 'o', 'u', 'a', 'i', 'o',
  184451. 'u', 'g', 'k', 'o', 'j', 'g', 'n', 'a', 'e', 'i', 'o', 'r',
  184452. 'u', 's', 't', 'h', 'a', 'e', 'o', 'y', '\0', '\0', '\0', '\0',
  184453. '\0', '\0', '\0', '\0', 'a', 'b', 'd', 'd', 'e', 'f', 'g', 'h',
  184454. 'h', 'i', 'k', 'l', 'l', 'm', 'n', 'p', 'r', 'r', 's', 't',
  184455. 'u', 'v', 'w', 'w', 'x', 'y', 'z', 'h', 't', 'w', 'y', 'a',
  184456. 'e', 'i', 'o', 'u', 'y',
  184457. };
  184458. unsigned int key = (((unsigned int)c)<<3) | 0x00000007;
  184459. int iRes = 0;
  184460. int iHi = sizeof(aDia)/sizeof(aDia[0]) - 1;
  184461. int iLo = 0;
  184462. while( iHi>=iLo ){
  184463. int iTest = (iHi + iLo) / 2;
  184464. if( key >= aDia[iTest] ){
  184465. iRes = iTest;
  184466. iLo = iTest+1;
  184467. }else{
  184468. iHi = iTest-1;
  184469. }
  184470. }
  184471. assert( key>=aDia[iRes] );
  184472. return ((c > (aDia[iRes]>>3) + (aDia[iRes]&0x07)) ? c : (int)aChar[iRes]);
  184473. }
  184474. /*
  184475. ** Return true if the argument interpreted as a unicode codepoint
  184476. ** is a diacritical modifier character.
  184477. */
  184478. static int sqlite3Fts5UnicodeIsdiacritic(int c){
  184479. unsigned int mask0 = 0x08029FDF;
  184480. unsigned int mask1 = 0x000361F8;
  184481. if( c<768 || c>817 ) return 0;
  184482. return (c < 768+32) ?
  184483. (mask0 & (1 << (c-768))) :
  184484. (mask1 & (1 << (c-768-32)));
  184485. }
  184486. /*
  184487. ** Interpret the argument as a unicode codepoint. If the codepoint
  184488. ** is an upper case character that has a lower case equivalent,
  184489. ** return the codepoint corresponding to the lower case version.
  184490. ** Otherwise, return a copy of the argument.
  184491. **
  184492. ** The results are undefined if the value passed to this function
  184493. ** is less than zero.
  184494. */
  184495. static int sqlite3Fts5UnicodeFold(int c, int bRemoveDiacritic){
  184496. /* Each entry in the following array defines a rule for folding a range
  184497. ** of codepoints to lower case. The rule applies to a range of nRange
  184498. ** codepoints starting at codepoint iCode.
  184499. **
  184500. ** If the least significant bit in flags is clear, then the rule applies
  184501. ** to all nRange codepoints (i.e. all nRange codepoints are upper case and
  184502. ** need to be folded). Or, if it is set, then the rule only applies to
  184503. ** every second codepoint in the range, starting with codepoint C.
  184504. **
  184505. ** The 7 most significant bits in flags are an index into the aiOff[]
  184506. ** array. If a specific codepoint C does require folding, then its lower
  184507. ** case equivalent is ((C + aiOff[flags>>1]) & 0xFFFF).
  184508. **
  184509. ** The contents of this array are generated by parsing the CaseFolding.txt
  184510. ** file distributed as part of the "Unicode Character Database". See
  184511. ** http://www.unicode.org for details.
  184512. */
  184513. static const struct TableEntry {
  184514. unsigned short iCode;
  184515. unsigned char flags;
  184516. unsigned char nRange;
  184517. } aEntry[] = {
  184518. {65, 14, 26}, {181, 64, 1}, {192, 14, 23},
  184519. {216, 14, 7}, {256, 1, 48}, {306, 1, 6},
  184520. {313, 1, 16}, {330, 1, 46}, {376, 116, 1},
  184521. {377, 1, 6}, {383, 104, 1}, {385, 50, 1},
  184522. {386, 1, 4}, {390, 44, 1}, {391, 0, 1},
  184523. {393, 42, 2}, {395, 0, 1}, {398, 32, 1},
  184524. {399, 38, 1}, {400, 40, 1}, {401, 0, 1},
  184525. {403, 42, 1}, {404, 46, 1}, {406, 52, 1},
  184526. {407, 48, 1}, {408, 0, 1}, {412, 52, 1},
  184527. {413, 54, 1}, {415, 56, 1}, {416, 1, 6},
  184528. {422, 60, 1}, {423, 0, 1}, {425, 60, 1},
  184529. {428, 0, 1}, {430, 60, 1}, {431, 0, 1},
  184530. {433, 58, 2}, {435, 1, 4}, {439, 62, 1},
  184531. {440, 0, 1}, {444, 0, 1}, {452, 2, 1},
  184532. {453, 0, 1}, {455, 2, 1}, {456, 0, 1},
  184533. {458, 2, 1}, {459, 1, 18}, {478, 1, 18},
  184534. {497, 2, 1}, {498, 1, 4}, {502, 122, 1},
  184535. {503, 134, 1}, {504, 1, 40}, {544, 110, 1},
  184536. {546, 1, 18}, {570, 70, 1}, {571, 0, 1},
  184537. {573, 108, 1}, {574, 68, 1}, {577, 0, 1},
  184538. {579, 106, 1}, {580, 28, 1}, {581, 30, 1},
  184539. {582, 1, 10}, {837, 36, 1}, {880, 1, 4},
  184540. {886, 0, 1}, {902, 18, 1}, {904, 16, 3},
  184541. {908, 26, 1}, {910, 24, 2}, {913, 14, 17},
  184542. {931, 14, 9}, {962, 0, 1}, {975, 4, 1},
  184543. {976, 140, 1}, {977, 142, 1}, {981, 146, 1},
  184544. {982, 144, 1}, {984, 1, 24}, {1008, 136, 1},
  184545. {1009, 138, 1}, {1012, 130, 1}, {1013, 128, 1},
  184546. {1015, 0, 1}, {1017, 152, 1}, {1018, 0, 1},
  184547. {1021, 110, 3}, {1024, 34, 16}, {1040, 14, 32},
  184548. {1120, 1, 34}, {1162, 1, 54}, {1216, 6, 1},
  184549. {1217, 1, 14}, {1232, 1, 88}, {1329, 22, 38},
  184550. {4256, 66, 38}, {4295, 66, 1}, {4301, 66, 1},
  184551. {7680, 1, 150}, {7835, 132, 1}, {7838, 96, 1},
  184552. {7840, 1, 96}, {7944, 150, 8}, {7960, 150, 6},
  184553. {7976, 150, 8}, {7992, 150, 8}, {8008, 150, 6},
  184554. {8025, 151, 8}, {8040, 150, 8}, {8072, 150, 8},
  184555. {8088, 150, 8}, {8104, 150, 8}, {8120, 150, 2},
  184556. {8122, 126, 2}, {8124, 148, 1}, {8126, 100, 1},
  184557. {8136, 124, 4}, {8140, 148, 1}, {8152, 150, 2},
  184558. {8154, 120, 2}, {8168, 150, 2}, {8170, 118, 2},
  184559. {8172, 152, 1}, {8184, 112, 2}, {8186, 114, 2},
  184560. {8188, 148, 1}, {8486, 98, 1}, {8490, 92, 1},
  184561. {8491, 94, 1}, {8498, 12, 1}, {8544, 8, 16},
  184562. {8579, 0, 1}, {9398, 10, 26}, {11264, 22, 47},
  184563. {11360, 0, 1}, {11362, 88, 1}, {11363, 102, 1},
  184564. {11364, 90, 1}, {11367, 1, 6}, {11373, 84, 1},
  184565. {11374, 86, 1}, {11375, 80, 1}, {11376, 82, 1},
  184566. {11378, 0, 1}, {11381, 0, 1}, {11390, 78, 2},
  184567. {11392, 1, 100}, {11499, 1, 4}, {11506, 0, 1},
  184568. {42560, 1, 46}, {42624, 1, 24}, {42786, 1, 14},
  184569. {42802, 1, 62}, {42873, 1, 4}, {42877, 76, 1},
  184570. {42878, 1, 10}, {42891, 0, 1}, {42893, 74, 1},
  184571. {42896, 1, 4}, {42912, 1, 10}, {42922, 72, 1},
  184572. {65313, 14, 26},
  184573. };
  184574. static const unsigned short aiOff[] = {
  184575. 1, 2, 8, 15, 16, 26, 28, 32,
  184576. 37, 38, 40, 48, 63, 64, 69, 71,
  184577. 79, 80, 116, 202, 203, 205, 206, 207,
  184578. 209, 210, 211, 213, 214, 217, 218, 219,
  184579. 775, 7264, 10792, 10795, 23228, 23256, 30204, 54721,
  184580. 54753, 54754, 54756, 54787, 54793, 54809, 57153, 57274,
  184581. 57921, 58019, 58363, 61722, 65268, 65341, 65373, 65406,
  184582. 65408, 65410, 65415, 65424, 65436, 65439, 65450, 65462,
  184583. 65472, 65476, 65478, 65480, 65482, 65488, 65506, 65511,
  184584. 65514, 65521, 65527, 65528, 65529,
  184585. };
  184586. int ret = c;
  184587. assert( sizeof(unsigned short)==2 && sizeof(unsigned char)==1 );
  184588. if( c<128 ){
  184589. if( c>='A' && c<='Z' ) ret = c + ('a' - 'A');
  184590. }else if( c<65536 ){
  184591. const struct TableEntry *p;
  184592. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  184593. int iLo = 0;
  184594. int iRes = -1;
  184595. assert( c>aEntry[0].iCode );
  184596. while( iHi>=iLo ){
  184597. int iTest = (iHi + iLo) / 2;
  184598. int cmp = (c - aEntry[iTest].iCode);
  184599. if( cmp>=0 ){
  184600. iRes = iTest;
  184601. iLo = iTest+1;
  184602. }else{
  184603. iHi = iTest-1;
  184604. }
  184605. }
  184606. assert( iRes>=0 && c>=aEntry[iRes].iCode );
  184607. p = &aEntry[iRes];
  184608. if( c<(p->iCode + p->nRange) && 0==(0x01 & p->flags & (p->iCode ^ c)) ){
  184609. ret = (c + (aiOff[p->flags>>1])) & 0x0000FFFF;
  184610. assert( ret>0 );
  184611. }
  184612. if( bRemoveDiacritic ) ret = fts5_remove_diacritic(ret);
  184613. }
  184614. else if( c>=66560 && c<66600 ){
  184615. ret = c + 40;
  184616. }
  184617. return ret;
  184618. }
  184619. /*
  184620. ** 2015 May 30
  184621. **
  184622. ** The author disclaims copyright to this source code. In place of
  184623. ** a legal notice, here is a blessing:
  184624. **
  184625. ** May you do good and not evil.
  184626. ** May you find forgiveness for yourself and forgive others.
  184627. ** May you share freely, never taking more than you give.
  184628. **
  184629. ******************************************************************************
  184630. **
  184631. ** Routines for varint serialization and deserialization.
  184632. */
  184633. /* #include "fts5Int.h" */
  184634. /*
  184635. ** This is a copy of the sqlite3GetVarint32() routine from the SQLite core.
  184636. ** Except, this version does handle the single byte case that the core
  184637. ** version depends on being handled before its function is called.
  184638. */
  184639. static int sqlite3Fts5GetVarint32(const unsigned char *p, u32 *v){
  184640. u32 a,b;
  184641. /* The 1-byte case. Overwhelmingly the most common. */
  184642. a = *p;
  184643. /* a: p0 (unmasked) */
  184644. if (!(a&0x80))
  184645. {
  184646. /* Values between 0 and 127 */
  184647. *v = a;
  184648. return 1;
  184649. }
  184650. /* The 2-byte case */
  184651. p++;
  184652. b = *p;
  184653. /* b: p1 (unmasked) */
  184654. if (!(b&0x80))
  184655. {
  184656. /* Values between 128 and 16383 */
  184657. a &= 0x7f;
  184658. a = a<<7;
  184659. *v = a | b;
  184660. return 2;
  184661. }
  184662. /* The 3-byte case */
  184663. p++;
  184664. a = a<<14;
  184665. a |= *p;
  184666. /* a: p0<<14 | p2 (unmasked) */
  184667. if (!(a&0x80))
  184668. {
  184669. /* Values between 16384 and 2097151 */
  184670. a &= (0x7f<<14)|(0x7f);
  184671. b &= 0x7f;
  184672. b = b<<7;
  184673. *v = a | b;
  184674. return 3;
  184675. }
  184676. /* A 32-bit varint is used to store size information in btrees.
  184677. ** Objects are rarely larger than 2MiB limit of a 3-byte varint.
  184678. ** A 3-byte varint is sufficient, for example, to record the size
  184679. ** of a 1048569-byte BLOB or string.
  184680. **
  184681. ** We only unroll the first 1-, 2-, and 3- byte cases. The very
  184682. ** rare larger cases can be handled by the slower 64-bit varint
  184683. ** routine.
  184684. */
  184685. {
  184686. u64 v64;
  184687. u8 n;
  184688. p -= 2;
  184689. n = sqlite3Fts5GetVarint(p, &v64);
  184690. *v = (u32)v64;
  184691. assert( n>3 && n<=9 );
  184692. return n;
  184693. }
  184694. }
  184695. /*
  184696. ** Bitmasks used by sqlite3GetVarint(). These precomputed constants
  184697. ** are defined here rather than simply putting the constant expressions
  184698. ** inline in order to work around bugs in the RVT compiler.
  184699. **
  184700. ** SLOT_2_0 A mask for (0x7f<<14) | 0x7f
  184701. **
  184702. ** SLOT_4_2_0 A mask for (0x7f<<28) | SLOT_2_0
  184703. */
  184704. #define SLOT_2_0 0x001fc07f
  184705. #define SLOT_4_2_0 0xf01fc07f
  184706. /*
  184707. ** Read a 64-bit variable-length integer from memory starting at p[0].
  184708. ** Return the number of bytes read. The value is stored in *v.
  184709. */
  184710. static u8 sqlite3Fts5GetVarint(const unsigned char *p, u64 *v){
  184711. u32 a,b,s;
  184712. a = *p;
  184713. /* a: p0 (unmasked) */
  184714. if (!(a&0x80))
  184715. {
  184716. *v = a;
  184717. return 1;
  184718. }
  184719. p++;
  184720. b = *p;
  184721. /* b: p1 (unmasked) */
  184722. if (!(b&0x80))
  184723. {
  184724. a &= 0x7f;
  184725. a = a<<7;
  184726. a |= b;
  184727. *v = a;
  184728. return 2;
  184729. }
  184730. /* Verify that constants are precomputed correctly */
  184731. assert( SLOT_2_0 == ((0x7f<<14) | (0x7f)) );
  184732. assert( SLOT_4_2_0 == ((0xfU<<28) | (0x7f<<14) | (0x7f)) );
  184733. p++;
  184734. a = a<<14;
  184735. a |= *p;
  184736. /* a: p0<<14 | p2 (unmasked) */
  184737. if (!(a&0x80))
  184738. {
  184739. a &= SLOT_2_0;
  184740. b &= 0x7f;
  184741. b = b<<7;
  184742. a |= b;
  184743. *v = a;
  184744. return 3;
  184745. }
  184746. /* CSE1 from below */
  184747. a &= SLOT_2_0;
  184748. p++;
  184749. b = b<<14;
  184750. b |= *p;
  184751. /* b: p1<<14 | p3 (unmasked) */
  184752. if (!(b&0x80))
  184753. {
  184754. b &= SLOT_2_0;
  184755. /* moved CSE1 up */
  184756. /* a &= (0x7f<<14)|(0x7f); */
  184757. a = a<<7;
  184758. a |= b;
  184759. *v = a;
  184760. return 4;
  184761. }
  184762. /* a: p0<<14 | p2 (masked) */
  184763. /* b: p1<<14 | p3 (unmasked) */
  184764. /* 1:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  184765. /* moved CSE1 up */
  184766. /* a &= (0x7f<<14)|(0x7f); */
  184767. b &= SLOT_2_0;
  184768. s = a;
  184769. /* s: p0<<14 | p2 (masked) */
  184770. p++;
  184771. a = a<<14;
  184772. a |= *p;
  184773. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  184774. if (!(a&0x80))
  184775. {
  184776. /* we can skip these cause they were (effectively) done above in calc'ing s */
  184777. /* a &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  184778. /* b &= (0x7f<<14)|(0x7f); */
  184779. b = b<<7;
  184780. a |= b;
  184781. s = s>>18;
  184782. *v = ((u64)s)<<32 | a;
  184783. return 5;
  184784. }
  184785. /* 2:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  184786. s = s<<7;
  184787. s |= b;
  184788. /* s: p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  184789. p++;
  184790. b = b<<14;
  184791. b |= *p;
  184792. /* b: p1<<28 | p3<<14 | p5 (unmasked) */
  184793. if (!(b&0x80))
  184794. {
  184795. /* we can skip this cause it was (effectively) done above in calc'ing s */
  184796. /* b &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  184797. a &= SLOT_2_0;
  184798. a = a<<7;
  184799. a |= b;
  184800. s = s>>18;
  184801. *v = ((u64)s)<<32 | a;
  184802. return 6;
  184803. }
  184804. p++;
  184805. a = a<<14;
  184806. a |= *p;
  184807. /* a: p2<<28 | p4<<14 | p6 (unmasked) */
  184808. if (!(a&0x80))
  184809. {
  184810. a &= SLOT_4_2_0;
  184811. b &= SLOT_2_0;
  184812. b = b<<7;
  184813. a |= b;
  184814. s = s>>11;
  184815. *v = ((u64)s)<<32 | a;
  184816. return 7;
  184817. }
  184818. /* CSE2 from below */
  184819. a &= SLOT_2_0;
  184820. p++;
  184821. b = b<<14;
  184822. b |= *p;
  184823. /* b: p3<<28 | p5<<14 | p7 (unmasked) */
  184824. if (!(b&0x80))
  184825. {
  184826. b &= SLOT_4_2_0;
  184827. /* moved CSE2 up */
  184828. /* a &= (0x7f<<14)|(0x7f); */
  184829. a = a<<7;
  184830. a |= b;
  184831. s = s>>4;
  184832. *v = ((u64)s)<<32 | a;
  184833. return 8;
  184834. }
  184835. p++;
  184836. a = a<<15;
  184837. a |= *p;
  184838. /* a: p4<<29 | p6<<15 | p8 (unmasked) */
  184839. /* moved CSE2 up */
  184840. /* a &= (0x7f<<29)|(0x7f<<15)|(0xff); */
  184841. b &= SLOT_2_0;
  184842. b = b<<8;
  184843. a |= b;
  184844. s = s<<4;
  184845. b = p[-4];
  184846. b &= 0x7f;
  184847. b = b>>3;
  184848. s |= b;
  184849. *v = ((u64)s)<<32 | a;
  184850. return 9;
  184851. }
  184852. /*
  184853. ** The variable-length integer encoding is as follows:
  184854. **
  184855. ** KEY:
  184856. ** A = 0xxxxxxx 7 bits of data and one flag bit
  184857. ** B = 1xxxxxxx 7 bits of data and one flag bit
  184858. ** C = xxxxxxxx 8 bits of data
  184859. **
  184860. ** 7 bits - A
  184861. ** 14 bits - BA
  184862. ** 21 bits - BBA
  184863. ** 28 bits - BBBA
  184864. ** 35 bits - BBBBA
  184865. ** 42 bits - BBBBBA
  184866. ** 49 bits - BBBBBBA
  184867. ** 56 bits - BBBBBBBA
  184868. ** 64 bits - BBBBBBBBC
  184869. */
  184870. #ifdef SQLITE_NOINLINE
  184871. # define FTS5_NOINLINE SQLITE_NOINLINE
  184872. #else
  184873. # define FTS5_NOINLINE
  184874. #endif
  184875. /*
  184876. ** Write a 64-bit variable-length integer to memory starting at p[0].
  184877. ** The length of data write will be between 1 and 9 bytes. The number
  184878. ** of bytes written is returned.
  184879. **
  184880. ** A variable-length integer consists of the lower 7 bits of each byte
  184881. ** for all bytes that have the 8th bit set and one byte with the 8th
  184882. ** bit clear. Except, if we get to the 9th byte, it stores the full
  184883. ** 8 bits and is the last byte.
  184884. */
  184885. static int FTS5_NOINLINE fts5PutVarint64(unsigned char *p, u64 v){
  184886. int i, j, n;
  184887. u8 buf[10];
  184888. if( v & (((u64)0xff000000)<<32) ){
  184889. p[8] = (u8)v;
  184890. v >>= 8;
  184891. for(i=7; i>=0; i--){
  184892. p[i] = (u8)((v & 0x7f) | 0x80);
  184893. v >>= 7;
  184894. }
  184895. return 9;
  184896. }
  184897. n = 0;
  184898. do{
  184899. buf[n++] = (u8)((v & 0x7f) | 0x80);
  184900. v >>= 7;
  184901. }while( v!=0 );
  184902. buf[0] &= 0x7f;
  184903. assert( n<=9 );
  184904. for(i=0, j=n-1; j>=0; j--, i++){
  184905. p[i] = buf[j];
  184906. }
  184907. return n;
  184908. }
  184909. static int sqlite3Fts5PutVarint(unsigned char *p, u64 v){
  184910. if( v<=0x7f ){
  184911. p[0] = v&0x7f;
  184912. return 1;
  184913. }
  184914. if( v<=0x3fff ){
  184915. p[0] = ((v>>7)&0x7f)|0x80;
  184916. p[1] = v&0x7f;
  184917. return 2;
  184918. }
  184919. return fts5PutVarint64(p,v);
  184920. }
  184921. static int sqlite3Fts5GetVarintLen(u32 iVal){
  184922. #if 0
  184923. if( iVal<(1 << 7 ) ) return 1;
  184924. #endif
  184925. assert( iVal>=(1 << 7) );
  184926. if( iVal<(1 << 14) ) return 2;
  184927. if( iVal<(1 << 21) ) return 3;
  184928. if( iVal<(1 << 28) ) return 4;
  184929. return 5;
  184930. }
  184931. /*
  184932. ** 2015 May 08
  184933. **
  184934. ** The author disclaims copyright to this source code. In place of
  184935. ** a legal notice, here is a blessing:
  184936. **
  184937. ** May you do good and not evil.
  184938. ** May you find forgiveness for yourself and forgive others.
  184939. ** May you share freely, never taking more than you give.
  184940. **
  184941. ******************************************************************************
  184942. **
  184943. ** This is an SQLite virtual table module implementing direct access to an
  184944. ** existing FTS5 index. The module may create several different types of
  184945. ** tables:
  184946. **
  184947. ** col:
  184948. ** CREATE TABLE vocab(term, col, doc, cnt, PRIMARY KEY(term, col));
  184949. **
  184950. ** One row for each term/column combination. The value of $doc is set to
  184951. ** the number of fts5 rows that contain at least one instance of term
  184952. ** $term within column $col. Field $cnt is set to the total number of
  184953. ** instances of term $term in column $col (in any row of the fts5 table).
  184954. **
  184955. ** row:
  184956. ** CREATE TABLE vocab(term, doc, cnt, PRIMARY KEY(term));
  184957. **
  184958. ** One row for each term in the database. The value of $doc is set to
  184959. ** the number of fts5 rows that contain at least one instance of term
  184960. ** $term. Field $cnt is set to the total number of instances of term
  184961. ** $term in the database.
  184962. */
  184963. /* #include "fts5Int.h" */
  184964. typedef struct Fts5VocabTable Fts5VocabTable;
  184965. typedef struct Fts5VocabCursor Fts5VocabCursor;
  184966. struct Fts5VocabTable {
  184967. sqlite3_vtab base;
  184968. char *zFts5Tbl; /* Name of fts5 table */
  184969. char *zFts5Db; /* Db containing fts5 table */
  184970. sqlite3 *db; /* Database handle */
  184971. Fts5Global *pGlobal; /* FTS5 global object for this database */
  184972. int eType; /* FTS5_VOCAB_COL or ROW */
  184973. };
  184974. struct Fts5VocabCursor {
  184975. sqlite3_vtab_cursor base;
  184976. sqlite3_stmt *pStmt; /* Statement holding lock on pIndex */
  184977. Fts5Index *pIndex; /* Associated FTS5 index */
  184978. int bEof; /* True if this cursor is at EOF */
  184979. Fts5IndexIter *pIter; /* Term/rowid iterator object */
  184980. int nLeTerm; /* Size of zLeTerm in bytes */
  184981. char *zLeTerm; /* (term <= $zLeTerm) paramater, or NULL */
  184982. /* These are used by 'col' tables only */
  184983. Fts5Config *pConfig; /* Fts5 table configuration */
  184984. int iCol;
  184985. i64 *aCnt;
  184986. i64 *aDoc;
  184987. /* Output values used by 'row' and 'col' tables */
  184988. i64 rowid; /* This table's current rowid value */
  184989. Fts5Buffer term; /* Current value of 'term' column */
  184990. };
  184991. #define FTS5_VOCAB_COL 0
  184992. #define FTS5_VOCAB_ROW 1
  184993. #define FTS5_VOCAB_COL_SCHEMA "term, col, doc, cnt"
  184994. #define FTS5_VOCAB_ROW_SCHEMA "term, doc, cnt"
  184995. /*
  184996. ** Bits for the mask used as the idxNum value by xBestIndex/xFilter.
  184997. */
  184998. #define FTS5_VOCAB_TERM_EQ 0x01
  184999. #define FTS5_VOCAB_TERM_GE 0x02
  185000. #define FTS5_VOCAB_TERM_LE 0x04
  185001. /*
  185002. ** Translate a string containing an fts5vocab table type to an
  185003. ** FTS5_VOCAB_XXX constant. If successful, set *peType to the output
  185004. ** value and return SQLITE_OK. Otherwise, set *pzErr to an error message
  185005. ** and return SQLITE_ERROR.
  185006. */
  185007. static int fts5VocabTableType(const char *zType, char **pzErr, int *peType){
  185008. int rc = SQLITE_OK;
  185009. char *zCopy = sqlite3Fts5Strndup(&rc, zType, -1);
  185010. if( rc==SQLITE_OK ){
  185011. sqlite3Fts5Dequote(zCopy);
  185012. if( sqlite3_stricmp(zCopy, "col")==0 ){
  185013. *peType = FTS5_VOCAB_COL;
  185014. }else
  185015. if( sqlite3_stricmp(zCopy, "row")==0 ){
  185016. *peType = FTS5_VOCAB_ROW;
  185017. }else
  185018. {
  185019. *pzErr = sqlite3_mprintf("fts5vocab: unknown table type: %Q", zCopy);
  185020. rc = SQLITE_ERROR;
  185021. }
  185022. sqlite3_free(zCopy);
  185023. }
  185024. return rc;
  185025. }
  185026. /*
  185027. ** The xDisconnect() virtual table method.
  185028. */
  185029. static int fts5VocabDisconnectMethod(sqlite3_vtab *pVtab){
  185030. Fts5VocabTable *pTab = (Fts5VocabTable*)pVtab;
  185031. sqlite3_free(pTab);
  185032. return SQLITE_OK;
  185033. }
  185034. /*
  185035. ** The xDestroy() virtual table method.
  185036. */
  185037. static int fts5VocabDestroyMethod(sqlite3_vtab *pVtab){
  185038. Fts5VocabTable *pTab = (Fts5VocabTable*)pVtab;
  185039. sqlite3_free(pTab);
  185040. return SQLITE_OK;
  185041. }
  185042. /*
  185043. ** This function is the implementation of both the xConnect and xCreate
  185044. ** methods of the FTS3 virtual table.
  185045. **
  185046. ** The argv[] array contains the following:
  185047. **
  185048. ** argv[0] -> module name ("fts5vocab")
  185049. ** argv[1] -> database name
  185050. ** argv[2] -> table name
  185051. **
  185052. ** then:
  185053. **
  185054. ** argv[3] -> name of fts5 table
  185055. ** argv[4] -> type of fts5vocab table
  185056. **
  185057. ** or, for tables in the TEMP schema only.
  185058. **
  185059. ** argv[3] -> name of fts5 tables database
  185060. ** argv[4] -> name of fts5 table
  185061. ** argv[5] -> type of fts5vocab table
  185062. */
  185063. static int fts5VocabInitVtab(
  185064. sqlite3 *db, /* The SQLite database connection */
  185065. void *pAux, /* Pointer to Fts5Global object */
  185066. int argc, /* Number of elements in argv array */
  185067. const char * const *argv, /* xCreate/xConnect argument array */
  185068. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  185069. char **pzErr /* Write any error message here */
  185070. ){
  185071. const char *azSchema[] = {
  185072. "CREATE TABlE vocab(" FTS5_VOCAB_COL_SCHEMA ")",
  185073. "CREATE TABlE vocab(" FTS5_VOCAB_ROW_SCHEMA ")"
  185074. };
  185075. Fts5VocabTable *pRet = 0;
  185076. int rc = SQLITE_OK; /* Return code */
  185077. int bDb;
  185078. bDb = (argc==6 && strlen(argv[1])==4 && memcmp("temp", argv[1], 4)==0);
  185079. if( argc!=5 && bDb==0 ){
  185080. *pzErr = sqlite3_mprintf("wrong number of vtable arguments");
  185081. rc = SQLITE_ERROR;
  185082. }else{
  185083. int nByte; /* Bytes of space to allocate */
  185084. const char *zDb = bDb ? argv[3] : argv[1];
  185085. const char *zTab = bDb ? argv[4] : argv[3];
  185086. const char *zType = bDb ? argv[5] : argv[4];
  185087. int nDb = (int)strlen(zDb)+1;
  185088. int nTab = (int)strlen(zTab)+1;
  185089. int eType = 0;
  185090. rc = fts5VocabTableType(zType, pzErr, &eType);
  185091. if( rc==SQLITE_OK ){
  185092. assert( eType>=0 && eType<ArraySize(azSchema) );
  185093. rc = sqlite3_declare_vtab(db, azSchema[eType]);
  185094. }
  185095. nByte = sizeof(Fts5VocabTable) + nDb + nTab;
  185096. pRet = sqlite3Fts5MallocZero(&rc, nByte);
  185097. if( pRet ){
  185098. pRet->pGlobal = (Fts5Global*)pAux;
  185099. pRet->eType = eType;
  185100. pRet->db = db;
  185101. pRet->zFts5Tbl = (char*)&pRet[1];
  185102. pRet->zFts5Db = &pRet->zFts5Tbl[nTab];
  185103. memcpy(pRet->zFts5Tbl, zTab, nTab);
  185104. memcpy(pRet->zFts5Db, zDb, nDb);
  185105. sqlite3Fts5Dequote(pRet->zFts5Tbl);
  185106. sqlite3Fts5Dequote(pRet->zFts5Db);
  185107. }
  185108. }
  185109. *ppVTab = (sqlite3_vtab*)pRet;
  185110. return rc;
  185111. }
  185112. /*
  185113. ** The xConnect() and xCreate() methods for the virtual table. All the
  185114. ** work is done in function fts5VocabInitVtab().
  185115. */
  185116. static int fts5VocabConnectMethod(
  185117. sqlite3 *db, /* Database connection */
  185118. void *pAux, /* Pointer to tokenizer hash table */
  185119. int argc, /* Number of elements in argv array */
  185120. const char * const *argv, /* xCreate/xConnect argument array */
  185121. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  185122. char **pzErr /* OUT: sqlite3_malloc'd error message */
  185123. ){
  185124. return fts5VocabInitVtab(db, pAux, argc, argv, ppVtab, pzErr);
  185125. }
  185126. static int fts5VocabCreateMethod(
  185127. sqlite3 *db, /* Database connection */
  185128. void *pAux, /* Pointer to tokenizer hash table */
  185129. int argc, /* Number of elements in argv array */
  185130. const char * const *argv, /* xCreate/xConnect argument array */
  185131. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  185132. char **pzErr /* OUT: sqlite3_malloc'd error message */
  185133. ){
  185134. return fts5VocabInitVtab(db, pAux, argc, argv, ppVtab, pzErr);
  185135. }
  185136. /*
  185137. ** Implementation of the xBestIndex method.
  185138. */
  185139. static int fts5VocabBestIndexMethod(
  185140. sqlite3_vtab *pUnused,
  185141. sqlite3_index_info *pInfo
  185142. ){
  185143. int i;
  185144. int iTermEq = -1;
  185145. int iTermGe = -1;
  185146. int iTermLe = -1;
  185147. int idxNum = 0;
  185148. int nArg = 0;
  185149. UNUSED_PARAM(pUnused);
  185150. for(i=0; i<pInfo->nConstraint; i++){
  185151. struct sqlite3_index_constraint *p = &pInfo->aConstraint[i];
  185152. if( p->usable==0 ) continue;
  185153. if( p->iColumn==0 ){ /* term column */
  185154. if( p->op==SQLITE_INDEX_CONSTRAINT_EQ ) iTermEq = i;
  185155. if( p->op==SQLITE_INDEX_CONSTRAINT_LE ) iTermLe = i;
  185156. if( p->op==SQLITE_INDEX_CONSTRAINT_LT ) iTermLe = i;
  185157. if( p->op==SQLITE_INDEX_CONSTRAINT_GE ) iTermGe = i;
  185158. if( p->op==SQLITE_INDEX_CONSTRAINT_GT ) iTermGe = i;
  185159. }
  185160. }
  185161. if( iTermEq>=0 ){
  185162. idxNum |= FTS5_VOCAB_TERM_EQ;
  185163. pInfo->aConstraintUsage[iTermEq].argvIndex = ++nArg;
  185164. pInfo->estimatedCost = 100;
  185165. }else{
  185166. pInfo->estimatedCost = 1000000;
  185167. if( iTermGe>=0 ){
  185168. idxNum |= FTS5_VOCAB_TERM_GE;
  185169. pInfo->aConstraintUsage[iTermGe].argvIndex = ++nArg;
  185170. pInfo->estimatedCost = pInfo->estimatedCost / 2;
  185171. }
  185172. if( iTermLe>=0 ){
  185173. idxNum |= FTS5_VOCAB_TERM_LE;
  185174. pInfo->aConstraintUsage[iTermLe].argvIndex = ++nArg;
  185175. pInfo->estimatedCost = pInfo->estimatedCost / 2;
  185176. }
  185177. }
  185178. /* This virtual table always delivers results in ascending order of
  185179. ** the "term" column (column 0). So if the user has requested this
  185180. ** specifically - "ORDER BY term" or "ORDER BY term ASC" - set the
  185181. ** sqlite3_index_info.orderByConsumed flag to tell the core the results
  185182. ** are already in sorted order. */
  185183. if( pInfo->nOrderBy==1
  185184. && pInfo->aOrderBy[0].iColumn==0
  185185. && pInfo->aOrderBy[0].desc==0
  185186. ){
  185187. pInfo->orderByConsumed = 1;
  185188. }
  185189. pInfo->idxNum = idxNum;
  185190. return SQLITE_OK;
  185191. }
  185192. /*
  185193. ** Implementation of xOpen method.
  185194. */
  185195. static int fts5VocabOpenMethod(
  185196. sqlite3_vtab *pVTab,
  185197. sqlite3_vtab_cursor **ppCsr
  185198. ){
  185199. Fts5VocabTable *pTab = (Fts5VocabTable*)pVTab;
  185200. Fts5Index *pIndex = 0;
  185201. Fts5Config *pConfig = 0;
  185202. Fts5VocabCursor *pCsr = 0;
  185203. int rc = SQLITE_OK;
  185204. sqlite3_stmt *pStmt = 0;
  185205. char *zSql = 0;
  185206. zSql = sqlite3Fts5Mprintf(&rc,
  185207. "SELECT t.%Q FROM %Q.%Q AS t WHERE t.%Q MATCH '*id'",
  185208. pTab->zFts5Tbl, pTab->zFts5Db, pTab->zFts5Tbl, pTab->zFts5Tbl
  185209. );
  185210. if( zSql ){
  185211. rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pStmt, 0);
  185212. }
  185213. sqlite3_free(zSql);
  185214. assert( rc==SQLITE_OK || pStmt==0 );
  185215. if( rc==SQLITE_ERROR ) rc = SQLITE_OK;
  185216. if( pStmt && sqlite3_step(pStmt)==SQLITE_ROW ){
  185217. i64 iId = sqlite3_column_int64(pStmt, 0);
  185218. pIndex = sqlite3Fts5IndexFromCsrid(pTab->pGlobal, iId, &pConfig);
  185219. }
  185220. if( rc==SQLITE_OK && pIndex==0 ){
  185221. rc = sqlite3_finalize(pStmt);
  185222. pStmt = 0;
  185223. if( rc==SQLITE_OK ){
  185224. pVTab->zErrMsg = sqlite3_mprintf(
  185225. "no such fts5 table: %s.%s", pTab->zFts5Db, pTab->zFts5Tbl
  185226. );
  185227. rc = SQLITE_ERROR;
  185228. }
  185229. }
  185230. if( rc==SQLITE_OK ){
  185231. int nByte = pConfig->nCol * sizeof(i64) * 2 + sizeof(Fts5VocabCursor);
  185232. pCsr = (Fts5VocabCursor*)sqlite3Fts5MallocZero(&rc, nByte);
  185233. }
  185234. if( pCsr ){
  185235. pCsr->pIndex = pIndex;
  185236. pCsr->pStmt = pStmt;
  185237. pCsr->pConfig = pConfig;
  185238. pCsr->aCnt = (i64*)&pCsr[1];
  185239. pCsr->aDoc = &pCsr->aCnt[pConfig->nCol];
  185240. }else{
  185241. sqlite3_finalize(pStmt);
  185242. }
  185243. *ppCsr = (sqlite3_vtab_cursor*)pCsr;
  185244. return rc;
  185245. }
  185246. static void fts5VocabResetCursor(Fts5VocabCursor *pCsr){
  185247. pCsr->rowid = 0;
  185248. sqlite3Fts5IterClose(pCsr->pIter);
  185249. pCsr->pIter = 0;
  185250. sqlite3_free(pCsr->zLeTerm);
  185251. pCsr->nLeTerm = -1;
  185252. pCsr->zLeTerm = 0;
  185253. }
  185254. /*
  185255. ** Close the cursor. For additional information see the documentation
  185256. ** on the xClose method of the virtual table interface.
  185257. */
  185258. static int fts5VocabCloseMethod(sqlite3_vtab_cursor *pCursor){
  185259. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185260. fts5VocabResetCursor(pCsr);
  185261. sqlite3Fts5BufferFree(&pCsr->term);
  185262. sqlite3_finalize(pCsr->pStmt);
  185263. sqlite3_free(pCsr);
  185264. return SQLITE_OK;
  185265. }
  185266. /*
  185267. ** Advance the cursor to the next row in the table.
  185268. */
  185269. static int fts5VocabNextMethod(sqlite3_vtab_cursor *pCursor){
  185270. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185271. Fts5VocabTable *pTab = (Fts5VocabTable*)pCursor->pVtab;
  185272. int rc = SQLITE_OK;
  185273. int nCol = pCsr->pConfig->nCol;
  185274. pCsr->rowid++;
  185275. if( pTab->eType==FTS5_VOCAB_COL ){
  185276. for(pCsr->iCol++; pCsr->iCol<nCol; pCsr->iCol++){
  185277. if( pCsr->aDoc[pCsr->iCol] ) break;
  185278. }
  185279. }
  185280. if( pTab->eType==FTS5_VOCAB_ROW || pCsr->iCol>=nCol ){
  185281. if( sqlite3Fts5IterEof(pCsr->pIter) ){
  185282. pCsr->bEof = 1;
  185283. }else{
  185284. const char *zTerm;
  185285. int nTerm;
  185286. zTerm = sqlite3Fts5IterTerm(pCsr->pIter, &nTerm);
  185287. if( pCsr->nLeTerm>=0 ){
  185288. int nCmp = MIN(nTerm, pCsr->nLeTerm);
  185289. int bCmp = memcmp(pCsr->zLeTerm, zTerm, nCmp);
  185290. if( bCmp<0 || (bCmp==0 && pCsr->nLeTerm<nTerm) ){
  185291. pCsr->bEof = 1;
  185292. return SQLITE_OK;
  185293. }
  185294. }
  185295. sqlite3Fts5BufferSet(&rc, &pCsr->term, nTerm, (const u8*)zTerm);
  185296. memset(pCsr->aCnt, 0, nCol * sizeof(i64));
  185297. memset(pCsr->aDoc, 0, nCol * sizeof(i64));
  185298. pCsr->iCol = 0;
  185299. assert( pTab->eType==FTS5_VOCAB_COL || pTab->eType==FTS5_VOCAB_ROW );
  185300. while( rc==SQLITE_OK ){
  185301. const u8 *pPos; int nPos; /* Position list */
  185302. i64 iPos = 0; /* 64-bit position read from poslist */
  185303. int iOff = 0; /* Current offset within position list */
  185304. pPos = pCsr->pIter->pData;
  185305. nPos = pCsr->pIter->nData;
  185306. switch( pCsr->pConfig->eDetail ){
  185307. case FTS5_DETAIL_FULL:
  185308. pPos = pCsr->pIter->pData;
  185309. nPos = pCsr->pIter->nData;
  185310. if( pTab->eType==FTS5_VOCAB_ROW ){
  185311. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff, &iPos) ){
  185312. pCsr->aCnt[0]++;
  185313. }
  185314. pCsr->aDoc[0]++;
  185315. }else{
  185316. int iCol = -1;
  185317. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff, &iPos) ){
  185318. int ii = FTS5_POS2COLUMN(iPos);
  185319. pCsr->aCnt[ii]++;
  185320. if( iCol!=ii ){
  185321. if( ii>=nCol ){
  185322. rc = FTS5_CORRUPT;
  185323. break;
  185324. }
  185325. pCsr->aDoc[ii]++;
  185326. iCol = ii;
  185327. }
  185328. }
  185329. }
  185330. break;
  185331. case FTS5_DETAIL_COLUMNS:
  185332. if( pTab->eType==FTS5_VOCAB_ROW ){
  185333. pCsr->aDoc[0]++;
  185334. }else{
  185335. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff,&iPos) ){
  185336. assert_nc( iPos>=0 && iPos<nCol );
  185337. if( iPos>=nCol ){
  185338. rc = FTS5_CORRUPT;
  185339. break;
  185340. }
  185341. pCsr->aDoc[iPos]++;
  185342. }
  185343. }
  185344. break;
  185345. default:
  185346. assert( pCsr->pConfig->eDetail==FTS5_DETAIL_NONE );
  185347. pCsr->aDoc[0]++;
  185348. break;
  185349. }
  185350. if( rc==SQLITE_OK ){
  185351. rc = sqlite3Fts5IterNextScan(pCsr->pIter);
  185352. }
  185353. if( rc==SQLITE_OK ){
  185354. zTerm = sqlite3Fts5IterTerm(pCsr->pIter, &nTerm);
  185355. if( nTerm!=pCsr->term.n || memcmp(zTerm, pCsr->term.p, nTerm) ){
  185356. break;
  185357. }
  185358. if( sqlite3Fts5IterEof(pCsr->pIter) ) break;
  185359. }
  185360. }
  185361. }
  185362. }
  185363. if( rc==SQLITE_OK && pCsr->bEof==0 && pTab->eType==FTS5_VOCAB_COL ){
  185364. while( pCsr->aDoc[pCsr->iCol]==0 ) pCsr->iCol++;
  185365. assert( pCsr->iCol<pCsr->pConfig->nCol );
  185366. }
  185367. return rc;
  185368. }
  185369. /*
  185370. ** This is the xFilter implementation for the virtual table.
  185371. */
  185372. static int fts5VocabFilterMethod(
  185373. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  185374. int idxNum, /* Strategy index */
  185375. const char *zUnused, /* Unused */
  185376. int nUnused, /* Number of elements in apVal */
  185377. sqlite3_value **apVal /* Arguments for the indexing scheme */
  185378. ){
  185379. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185380. int rc = SQLITE_OK;
  185381. int iVal = 0;
  185382. int f = FTS5INDEX_QUERY_SCAN;
  185383. const char *zTerm = 0;
  185384. int nTerm = 0;
  185385. sqlite3_value *pEq = 0;
  185386. sqlite3_value *pGe = 0;
  185387. sqlite3_value *pLe = 0;
  185388. UNUSED_PARAM2(zUnused, nUnused);
  185389. fts5VocabResetCursor(pCsr);
  185390. if( idxNum & FTS5_VOCAB_TERM_EQ ) pEq = apVal[iVal++];
  185391. if( idxNum & FTS5_VOCAB_TERM_GE ) pGe = apVal[iVal++];
  185392. if( idxNum & FTS5_VOCAB_TERM_LE ) pLe = apVal[iVal++];
  185393. if( pEq ){
  185394. zTerm = (const char *)sqlite3_value_text(pEq);
  185395. nTerm = sqlite3_value_bytes(pEq);
  185396. f = 0;
  185397. }else{
  185398. if( pGe ){
  185399. zTerm = (const char *)sqlite3_value_text(pGe);
  185400. nTerm = sqlite3_value_bytes(pGe);
  185401. }
  185402. if( pLe ){
  185403. const char *zCopy = (const char *)sqlite3_value_text(pLe);
  185404. pCsr->nLeTerm = sqlite3_value_bytes(pLe);
  185405. pCsr->zLeTerm = sqlite3_malloc(pCsr->nLeTerm+1);
  185406. if( pCsr->zLeTerm==0 ){
  185407. rc = SQLITE_NOMEM;
  185408. }else{
  185409. memcpy(pCsr->zLeTerm, zCopy, pCsr->nLeTerm+1);
  185410. }
  185411. }
  185412. }
  185413. if( rc==SQLITE_OK ){
  185414. rc = sqlite3Fts5IndexQuery(pCsr->pIndex, zTerm, nTerm, f, 0, &pCsr->pIter);
  185415. }
  185416. if( rc==SQLITE_OK ){
  185417. rc = fts5VocabNextMethod(pCursor);
  185418. }
  185419. return rc;
  185420. }
  185421. /*
  185422. ** This is the xEof method of the virtual table. SQLite calls this
  185423. ** routine to find out if it has reached the end of a result set.
  185424. */
  185425. static int fts5VocabEofMethod(sqlite3_vtab_cursor *pCursor){
  185426. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185427. return pCsr->bEof;
  185428. }
  185429. static int fts5VocabColumnMethod(
  185430. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  185431. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  185432. int iCol /* Index of column to read value from */
  185433. ){
  185434. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185435. int eDetail = pCsr->pConfig->eDetail;
  185436. int eType = ((Fts5VocabTable*)(pCursor->pVtab))->eType;
  185437. i64 iVal = 0;
  185438. if( iCol==0 ){
  185439. sqlite3_result_text(
  185440. pCtx, (const char*)pCsr->term.p, pCsr->term.n, SQLITE_TRANSIENT
  185441. );
  185442. }else if( eType==FTS5_VOCAB_COL ){
  185443. assert( iCol==1 || iCol==2 || iCol==3 );
  185444. if( iCol==1 ){
  185445. if( eDetail!=FTS5_DETAIL_NONE ){
  185446. const char *z = pCsr->pConfig->azCol[pCsr->iCol];
  185447. sqlite3_result_text(pCtx, z, -1, SQLITE_STATIC);
  185448. }
  185449. }else if( iCol==2 ){
  185450. iVal = pCsr->aDoc[pCsr->iCol];
  185451. }else{
  185452. iVal = pCsr->aCnt[pCsr->iCol];
  185453. }
  185454. }else{
  185455. assert( iCol==1 || iCol==2 );
  185456. if( iCol==1 ){
  185457. iVal = pCsr->aDoc[0];
  185458. }else{
  185459. iVal = pCsr->aCnt[0];
  185460. }
  185461. }
  185462. if( iVal>0 ) sqlite3_result_int64(pCtx, iVal);
  185463. return SQLITE_OK;
  185464. }
  185465. /*
  185466. ** This is the xRowid method. The SQLite core calls this routine to
  185467. ** retrieve the rowid for the current row of the result set. The
  185468. ** rowid should be written to *pRowid.
  185469. */
  185470. static int fts5VocabRowidMethod(
  185471. sqlite3_vtab_cursor *pCursor,
  185472. sqlite_int64 *pRowid
  185473. ){
  185474. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  185475. *pRowid = pCsr->rowid;
  185476. return SQLITE_OK;
  185477. }
  185478. static int sqlite3Fts5VocabInit(Fts5Global *pGlobal, sqlite3 *db){
  185479. static const sqlite3_module fts5Vocab = {
  185480. /* iVersion */ 2,
  185481. /* xCreate */ fts5VocabCreateMethod,
  185482. /* xConnect */ fts5VocabConnectMethod,
  185483. /* xBestIndex */ fts5VocabBestIndexMethod,
  185484. /* xDisconnect */ fts5VocabDisconnectMethod,
  185485. /* xDestroy */ fts5VocabDestroyMethod,
  185486. /* xOpen */ fts5VocabOpenMethod,
  185487. /* xClose */ fts5VocabCloseMethod,
  185488. /* xFilter */ fts5VocabFilterMethod,
  185489. /* xNext */ fts5VocabNextMethod,
  185490. /* xEof */ fts5VocabEofMethod,
  185491. /* xColumn */ fts5VocabColumnMethod,
  185492. /* xRowid */ fts5VocabRowidMethod,
  185493. /* xUpdate */ 0,
  185494. /* xBegin */ 0,
  185495. /* xSync */ 0,
  185496. /* xCommit */ 0,
  185497. /* xRollback */ 0,
  185498. /* xFindFunction */ 0,
  185499. /* xRename */ 0,
  185500. /* xSavepoint */ 0,
  185501. /* xRelease */ 0,
  185502. /* xRollbackTo */ 0,
  185503. };
  185504. void *p = (void*)pGlobal;
  185505. return sqlite3_create_module_v2(db, "fts5vocab", &fts5Vocab, p, 0);
  185506. }
  185507. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS5) */
  185508. /************** End of fts5.c ************************************************/
  185509. #else // USE_LIBSQLITE3
  185510. // If users really want to link against the system sqlite3 we
  185511. // need to make this file a noop.
  185512. #endif